SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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/in.h>
  15 #include <linux/fs.h>
  16 #include <linux/kref.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 hlist_node       h_hash;         /* doubly linked list */
  41         struct sockaddr_storage h_addr;         /* peer address */
  42         size_t                  h_addrlen;
  43         struct sockaddr_storage h_srcaddr;      /* our address (optional) */
  44         struct rpc_clnt *       h_rpcclnt;      /* RPC client to talk to peer */
  45         char *                  h_name;         /* remote hostname */
  46         u32                     h_version;      /* interface version */
  47         unsigned short          h_proto;        /* transport proto */
  48         unsigned short          h_reclaiming : 1,
  49                                 h_server     : 1, /* server side, not client side */
  50                                 h_inuse      : 1;
  51         wait_queue_head_t       h_gracewait;    /* wait while reclaiming */
  52         struct rw_semaphore     h_rwsem;        /* Reboot recovery lock */
  53         u32                     h_state;        /* pseudo-state counter */
  54         u32                     h_nsmstate;     /* true remote NSM state */
  55         u32                     h_pidcount;     /* Pseudopids */
  56         atomic_t                h_count;        /* reference count */
  57         struct mutex            h_mutex;        /* mutex for pmap binding */
  58         unsigned long           h_nextrebind;   /* next portmap call */
  59         unsigned long           h_expires;      /* eligible for GC */
  60         struct list_head        h_lockowners;   /* Lockowners for the client */
  61         spinlock_t              h_lock;
  62         struct list_head        h_granted;      /* Locks in GRANTED state */
  63         struct list_head        h_reclaim;      /* Locks in RECLAIM state */
  64         struct nsm_handle *     h_nsmhandle;    /* NSM status handle */
  65
  66         char                    h_addrbuf[48],  /* address eyecatchers */
  67                                 h_srcaddrbuf[48];
  68 };
  69
  70 struct nsm_handle {
  71         struct list_head        sm_link;
  72         atomic_t                sm_count;
  73         char *                  sm_name;
  74         struct sockaddr_storage sm_addr;
  75         size_t                  sm_addrlen;
  76         unsigned int            sm_monitored : 1,
  77                                 sm_sticky : 1;  /* don't unmonitor */
  78         char                    sm_addrbuf[48]; /* address eyecatcher */
  79 };
  80
  81 /*
  82  * Rigorous type checking on sockaddr type conversions
  83  */
  84 static inline struct sockaddr_in *nlm_addr_in(const struct nlm_host *host)
  85 {
  86         return (struct sockaddr_in *)&host->h_addr;
  87 }
  88
  89 static inline struct sockaddr *nlm_addr(const struct nlm_host *host)
  90 {
  91         return (struct sockaddr *)&host->h_addr;
  92 }
  93
  94 static inline struct sockaddr_in *nlm_srcaddr_in(const struct nlm_host *host)
  95 {
  96         return (struct sockaddr_in *)&host->h_srcaddr;
  97 }
  98
  99 static inline struct sockaddr *nlm_srcaddr(const struct nlm_host *host)
 100 {
 101         return (struct sockaddr *)&host->h_srcaddr;
 102 }
 103
 104 static inline struct sockaddr_in *nsm_addr_in(const struct nsm_handle *handle)
 105 {
 106         return (struct sockaddr_in *)&handle->sm_addr;
 107 }
 108
 109 static inline struct sockaddr *nsm_addr(const struct nsm_handle *handle)
 110 {
 111         return (struct sockaddr *)&handle->sm_addr;
 112 }
 113
 114 /*
 115  * Map an fl_owner_t into a unique 32-bit "pid"
 116  */
 117 struct nlm_lockowner {
 118         struct list_head list;
 119         atomic_t count;
 120
 121         struct nlm_host *host;
 122         fl_owner_t owner;
 123         uint32_t pid;
 124 };
 125
 126 struct nlm_wait;
 127
 128 /*
 129  * Memory chunk for NLM client RPC request.
 130  */
 131 #define NLMCLNT_OHSIZE          ((__NEW_UTS_LEN) + 10u)
 132 struct nlm_rqst {
 133         atomic_t                a_count;
 134         unsigned int            a_flags;        /* initial RPC task flags */
 135         struct nlm_host *       a_host;         /* host handle */
 136         struct nlm_args         a_args;         /* arguments */
 137         struct nlm_res          a_res;          /* result */
 138         struct nlm_block *      a_block;
 139         unsigned int            a_retries;      /* Retry count */
 140         u8                      a_owner[NLMCLNT_OHSIZE];
 141 };
 142
 143 /*
 144  * This struct describes a file held open by lockd on behalf of
 145  * an NFS client.
 146  */
 147 struct nlm_file {
 148         struct hlist_node       f_list;         /* linked list */
 149         struct nfs_fh           f_handle;       /* NFS file handle */
 150         struct file *           f_file;         /* VFS file pointer */
 151         struct nlm_share *      f_shares;       /* DOS shares */
 152         struct list_head        f_blocks;       /* blocked locks */
 153         unsigned int            f_locks;        /* guesstimate # of locks */
 154         unsigned int            f_count;        /* reference count */
 155         struct mutex            f_mutex;        /* avoid concurrent access */
 156 };
 157
 158 /*
 159  * This is a server block (i.e. a lock requested by some client which
 160  * couldn't be granted because of a conflicting lock).
 161  */
 162 #define NLM_NEVER               (~(unsigned long) 0)
 163 /* timeout on non-blocking call: */
 164 #define NLM_TIMEOUT             (7 * HZ)
 165
 166 struct nlm_block {
 167         struct kref             b_count;        /* Reference count */
 168         struct list_head        b_list;         /* linked list of all blocks */
 169         struct list_head        b_flist;        /* linked list (per file) */
 170         struct nlm_rqst *       b_call;         /* RPC args & callback info */
 171         struct svc_serv *       b_daemon;       /* NLM service */
 172         struct nlm_host *       b_host;         /* host handle for RPC clnt */
 173         unsigned long           b_when;         /* next re-xmit */
 174         unsigned int            b_id;           /* block id */
 175         unsigned char           b_granted;      /* VFS granted lock */
 176         struct nlm_file *       b_file;         /* file in question */
 177         struct cache_req *      b_cache_req;    /* deferred request handling */
 178         struct file_lock *      b_fl;           /* set for GETLK */
 179         struct cache_deferred_req * b_deferred_req;
 180         unsigned int            b_flags;        /* block flags */
 181 #define B_QUEUED                1       /* lock queued */
 182 #define B_GOT_CALLBACK          2       /* got lock or conflicting lock */
 183 #define B_TIMED_OUT             4       /* filesystem too slow to respond */
 184 };
 185
 186 /*
 187  * Global variables
 188  */
 189 extern struct rpc_program       nlm_program;
 190 extern struct svc_procedure     nlmsvc_procedures[];
 191 #ifdef CONFIG_LOCKD_V4
 192 extern struct svc_procedure     nlmsvc_procedures4[];
 193 #endif
 194 extern int                      nlmsvc_grace_period;
 195 extern unsigned long            nlmsvc_timeout;
 196 extern int                      nsm_use_hostnames;
 197
 198 /*
 199  * Lockd client functions
 200  */
 201 struct nlm_rqst * nlm_alloc_call(struct nlm_host *host);
 202 void              nlm_release_call(struct nlm_rqst *);
 203 int               nlm_async_call(struct nlm_rqst *, u32, const struct rpc_call_ops *);
 204 int               nlm_async_reply(struct nlm_rqst *, u32, const struct rpc_call_ops *);
 205 struct nlm_wait * nlmclnt_prepare_block(struct nlm_host *host, struct file_lock *fl);
 206 void              nlmclnt_finish_block(struct nlm_wait *block);
 207 int               nlmclnt_block(struct nlm_wait *block, struct nlm_rqst *req, long timeout);
 208 __be32            nlmclnt_grant(const struct sockaddr_in *addr, const struct nlm_lock *);
 209 void              nlmclnt_recovery(struct nlm_host *);
 210 int               nlmclnt_reclaim(struct nlm_host *, struct file_lock *);
 211 void              nlmclnt_next_cookie(struct nlm_cookie *);
 212
 213 /*
 214  * Host cache
 215  */
 216 struct nlm_host  *nlmclnt_lookup_host(const struct sockaddr_in *sin,
 217                                         int proto, u32 version,
 218                                         const char *hostname,
 219                                         unsigned int hostname_len);
 220 struct nlm_host  *nlmsvc_lookup_host(struct svc_rqst *, const char *,
 221                                         unsigned int);
 222 struct rpc_clnt * nlm_bind_host(struct nlm_host *);
 223 void              nlm_rebind_host(struct nlm_host *);
 224 struct nlm_host * nlm_get_host(struct nlm_host *);
 225 void              nlm_release_host(struct nlm_host *);
 226 void              nlm_shutdown_hosts(void);
 227 extern void       nlm_host_rebooted(const struct sockaddr_in *, const char *,
 228                                         unsigned int, u32);
 229 void              nsm_release(struct nsm_handle *);
 230
 231
 232 /*
 233  * This is used in garbage collection and resource reclaim
 234  * A return value != 0 means destroy the lock/block/share
 235  */
 236 typedef int       (*nlm_host_match_fn_t)(void *cur, struct nlm_host *ref);
 237
 238 /*
 239  * Server-side lock handling
 240  */
 241 __be32            nlmsvc_lock(struct svc_rqst *, struct nlm_file *,
 242                               struct nlm_host *, struct nlm_lock *, int,
 243                               struct nlm_cookie *);
 244 __be32            nlmsvc_unlock(struct nlm_file *, struct nlm_lock *);
 245 __be32            nlmsvc_testlock(struct svc_rqst *, struct nlm_file *,
 246                         struct nlm_host *, struct nlm_lock *,
 247                         struct nlm_lock *, struct nlm_cookie *);
 248 __be32            nlmsvc_cancel_blocked(struct nlm_file *, struct nlm_lock *);
 249 unsigned long     nlmsvc_retry_blocked(void);
 250 void              nlmsvc_traverse_blocks(struct nlm_host *, struct nlm_file *,
 251                                         nlm_host_match_fn_t match);
 252 void              nlmsvc_grant_reply(struct nlm_cookie *, __be32);
 253
 254 /*
 255  * File handling for the server personality
 256  */
 257 __be32            nlm_lookup_file(struct svc_rqst *, struct nlm_file **,
 258                                         struct nfs_fh *);
 259 void              nlm_release_file(struct nlm_file *);
 260 void              nlmsvc_mark_resources(void);
 261 void              nlmsvc_free_host_resources(struct nlm_host *);
 262 void              nlmsvc_invalidate_all(void);
 263
 264 /*
 265  * Cluster failover support
 266  */
 267 int           nlmsvc_unlock_all_by_sb(struct super_block *sb);
 268 int           nlmsvc_unlock_all_by_ip(struct sockaddr *server_addr);
 269
 270 static inline struct inode *nlmsvc_file_inode(struct nlm_file *file)
 271 {
 272         return file->f_file->f_path.dentry->d_inode;
 273 }
 274
 275 /*
 276  * Compare two host addresses (needs modifying for ipv6)
 277  */
 278 static inline int nlm_cmp_addr(const struct sockaddr_in *sin1,
 279                                const struct sockaddr_in *sin2)
 280 {
 281         return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
 282 }
 283
 284 /*
 285  * Compare two NLM locks.
 286  * When the second lock is of type F_UNLCK, this acts like a wildcard.
 287  */
 288 static inline int nlm_compare_locks(const struct file_lock *fl1,
 289                                     const struct file_lock *fl2)
 290 {
 291         return  fl1->fl_pid   == fl2->fl_pid
 292              && fl1->fl_owner == fl2->fl_owner
 293              && fl1->fl_start == fl2->fl_start
 294              && fl1->fl_end   == fl2->fl_end
 295              &&(fl1->fl_type  == fl2->fl_type || fl2->fl_type == F_UNLCK);
 296 }
 297
 298 extern struct lock_manager_operations nlmsvc_lock_operations;
 299
 300 #endif /* __KERNEL__ */
 301
 302 #endif /* LINUX_LOCKD_LOCKD_H */