include/linux/lockd/lockd.h

   1 /*
   2  * linux/include/linux/lockd/lockd.h
   3  *
   4  * General-purpose lockd include file.
   5  *
   6  * Copyright (C) 1996 Olaf Kirch <okir@monad.swb.de>
   7  */
   8
   9 #ifndef LINUX_LOCKD_LOCKD_H
  10 #define LINUX_LOCKD_LOCKD_H
  11
  12 #ifdef __KERNEL__
  13
  14 #include <linux/config.h>
  15 #include <linux/in.h>
  16 #include <linux/fs.h>
  17 #include <linux/utsname.h>
  18 #include <linux/nfsd/nfsfh.h>
  19 #include <linux/lockd/bind.h>
  20 #include <linux/lockd/xdr.h>
  21 #ifdef CONFIG_LOCKD_V4
  22 #include <linux/lockd/xdr4.h>
  23 #endif
  24 #include <linux/lockd/debug.h>
  25
  26 /*
  27  * Version string
  28  */
  29 #define LOCKD_VERSION           "0.5"
  30
  31 /*
  32  * Default timeout for RPC calls (seconds)
  33  */
  34 #define LOCKD_DFLT_TIMEO        10
  35
  36 /*
  37  * Lockd host handle (used both by the client and server personality).
  38  */
  39 struct nlm_host {
  40         struct nlm_host *       h_next;         /* linked list (hash table) */
  41         struct sockaddr_in      h_addr;         /* peer address */
  42         struct rpc_clnt *       h_rpcclnt;      /* RPC client to talk to peer */
  43         char                    h_name[20];     /* remote hostname */
  44         u32                     h_version;      /* interface version */
  45         rpc_authflavor_t        h_authflavor;   /* RPC authentication type */
  46         unsigned short          h_proto;        /* transport proto */
  47         unsigned short          h_reclaiming : 1,
  48                                 h_server     : 1, /* server side, not client side */
  49                                 h_inuse      : 1,
  50                                 h_rebooted   : 1;
  51         wait_queue_head_t       h_gracewait;    /* wait while reclaiming */
  52         u32                     h_state;        /* pseudo-state counter */
  53         u32                     h_nsmstate;     /* true remote NSM state */
  54         atomic_t                h_count;        /* reference count */
  55         struct semaphore        h_sema;         /* mutex for pmap binding */
  56         unsigned long           h_nextrebind;   /* next portmap call */
  57         unsigned long           h_expires;      /* eligible for GC */
  58         struct nsm_handle *     h_nsmhandle;    /* for kernel statd */
  59 };
  60
  61 struct nsm_handle {
  62         atomic_t                sm_count;
  63         struct sockaddr_in      sm_addr;
  64         unsigned int            sm_monitored : 1,
  65                                 sm_sticky : 1;  /* don't unmonitor */
  66 };
  67
  68 /*
  69  * Memory chunk for NLM client RPC request.
  70  */
  71 #define NLMCLNT_OHSIZE          (sizeof(system_utsname.nodename)+10)
  72 struct nlm_rqst {
  73         unsigned int            a_flags;        /* initial RPC task flags */
  74         struct nlm_host *       a_host;         /* host handle */
  75         struct nlm_args         a_args;         /* arguments */
  76         struct nlm_res          a_res;          /* result */
  77         char                    a_owner[NLMCLNT_OHSIZE];
  78 };
  79
  80 /*
  81  * This struct describes a file held open by lockd on behalf of
  82  * an NFS client.
  83  */
  84 struct nlm_file {
  85         struct nlm_file *       f_next;         /* linked list */
  86         struct nfs_fh           f_handle;       /* NFS file handle */
  87         struct file             f_file;         /* VFS file pointer */
  88         struct nlm_share *      f_shares;       /* DOS shares */
  89         struct nlm_block *      f_blocks;       /* blocked locks */
  90         unsigned int            f_locks;        /* guesstimate # of locks */
  91         unsigned int            f_count;        /* reference count */
  92         struct semaphore        f_sema;         /* avoid concurrent access */
  93         int                     f_hash;         /* hash of f_handle */
  94 };
  95
  96 /*
  97  * This is a server block (i.e. a lock requested by some client which
  98  * couldn't be granted because of a conflicting lock).
  99  */
 100 #define NLM_NEVER               (~(unsigned long) 0)
 101 struct nlm_block {
 102         struct nlm_block *      b_next;         /* linked list (all blocks) */
 103         struct nlm_block *      b_fnext;        /* linked list (per file) */
 104         struct nlm_rqst         b_call;         /* RPC args & callback info */
 105         struct svc_serv *       b_daemon;       /* NLM service */
 106         struct nlm_host *       b_host;         /* host handle for RPC clnt */
 107         unsigned long           b_when;         /* next re-xmit */
 108         unsigned int            b_id;           /* block id */
 109         unsigned char           b_queued;       /* re-queued */
 110         unsigned char           b_granted;      /* VFS granted lock */
 111         unsigned char           b_incall;       /* doing callback */
 112         unsigned char           b_done;         /* callback complete */
 113         struct nlm_file *       b_file;         /* file in question */
 114 };
 115
 116 /*
 117  * Valid actions for nlmsvc_traverse_files
 118  */
 119 #define NLM_ACT_CHECK           0               /* check for locks */
 120 #define NLM_ACT_MARK            1               /* mark & sweep */
 121 #define NLM_ACT_UNLOCK          2               /* release all locks */
 122
 123 /*
 124  * Global variables
 125  */
 126 extern struct rpc_program       nlm_program;
 127 extern struct svc_procedure     nlmsvc_procedures[];
 128 #ifdef CONFIG_LOCKD_V4
 129 extern struct svc_procedure     nlmsvc_procedures4[];
 130 #endif
 131 #ifdef CONFIG_STATD
 132 extern struct svc_procedure     nsmsvc_procedures[];
 133 #endif
 134 extern int                      nlmsvc_grace_period;
 135 extern unsigned long            nlmsvc_timeout;
 136
 137 /*
 138  * Lockd client functions
 139  */
 140 struct nlm_rqst * nlmclnt_alloc_call(void);
 141 int               nlmclnt_call(struct nlm_rqst *, u32);
 142 int               nlmclnt_async_call(struct nlm_rqst *, u32, rpc_action);
 143 int               nlmclnt_block(struct nlm_host *, struct file_lock *, u32 *);
 144 int               nlmclnt_cancel(struct nlm_host *, struct file_lock *);
 145 u32               nlmclnt_grant(struct nlm_lock *);
 146 void              nlmclnt_recovery(struct nlm_host *, u32);
 147 int               nlmclnt_reclaim(struct nlm_host *, struct file_lock *);
 148 int               nlmclnt_setgrantargs(struct nlm_rqst *, struct nlm_lock *);
 149 void              nlmclnt_freegrantargs(struct nlm_rqst *);
 150
 151 /*
 152  * Host cache
 153  */
 154 struct nlm_host * nlmclnt_lookup_host(struct sockaddr_in *, int, int);
 155 struct nlm_host * nlmsvc_lookup_host(struct svc_rqst *);
 156 struct nlm_host * nlm_lookup_host(int server, struct sockaddr_in *, int, int);
 157 struct rpc_clnt * nlm_bind_host(struct nlm_host *);
 158 void              nlm_rebind_host(struct nlm_host *);
 159 struct nlm_host * nlm_get_host(struct nlm_host *);
 160 void              nlm_release_host(struct nlm_host *);
 161 void              nlm_shutdown_hosts(void);
 162 extern struct nlm_host *nlm_find_client(void);
 163 extern void       nlm_host_rebooted(struct sockaddr_in *, u32);
 164
 165
 166 /*
 167  * Server-side lock handling
 168  */
 169 int               nlmsvc_async_call(struct nlm_rqst *, u32, rpc_action);
 170 u32               nlmsvc_lock(struct svc_rqst *, struct nlm_file *,
 171                                         struct nlm_lock *, int, struct nlm_cookie *);
 172 u32               nlmsvc_unlock(struct nlm_file *, struct nlm_lock *);
 173 u32               nlmsvc_testlock(struct nlm_file *, struct nlm_lock *,
 174                                         struct nlm_lock *);
 175 u32               nlmsvc_cancel_blocked(struct nlm_file *, struct nlm_lock *);
 176 unsigned long     nlmsvc_retry_blocked(void);
 177 int               nlmsvc_traverse_blocks(struct nlm_host *, struct nlm_file *,
 178                                         int action);
 179 void      nlmsvc_grant_reply(struct svc_rqst *, struct nlm_cookie *, u32);
 180
 181 /*
 182  * File handling for the server personality
 183  */
 184 u32               nlm_lookup_file(struct svc_rqst *, struct nlm_file **,
 185                                         struct nfs_fh *);
 186 void              nlm_release_file(struct nlm_file *);
 187 void              nlmsvc_mark_resources(void);
 188 void              nlmsvc_free_host_resources(struct nlm_host *);
 189 void              nlmsvc_invalidate_all(void);
 190
 191 static __inline__ struct inode *
 192 nlmsvc_file_inode(struct nlm_file *file)
 193 {
 194         return file->f_file.f_dentry->d_inode;
 195 }
 196
 197 /*
 198  * Compare two host addresses (needs modifying for ipv6)
 199  */
 200 static __inline__ int
 201 nlm_cmp_addr(struct sockaddr_in *sin1, struct sockaddr_in *sin2)
 202 {
 203         return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
 204 }
 205
 206 /*
 207  * Compare two NLM locks.
 208  * When the second lock is of type F_UNLCK, this acts like a wildcard.
 209  */
 210 static __inline__ int
 211 nlm_compare_locks(struct file_lock *fl1, struct file_lock *fl2)
 212 {
 213         return  fl1->fl_pid   == fl2->fl_pid
 214              && fl1->fl_start == fl2->fl_start
 215              && fl1->fl_end   == fl2->fl_end
 216              &&(fl1->fl_type  == fl2->fl_type || fl2->fl_type == F_UNLCK);
 217 }
 218
 219 #endif /* __KERNEL__ */
 220
 221 #endif /* LINUX_LOCKD_LOCKD_H */