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/in6.h>
  16 #include <net/ipv6.h>
  17 #include <linux/fs.h>
  18 #include <linux/kref.h>
  19 #include <linux/utsname.h>
  20 #include <linux/nfsd/nfsfh.h>
  21 #include <linux/lockd/bind.h>
  22 #include <linux/lockd/xdr.h>
  23 #ifdef CONFIG_LOCKD_V4
  24 #include <linux/lockd/xdr4.h>
  25 #endif
  26 #include <linux/lockd/debug.h>
  27
  28 /*
  29  * Version string
  30  */
  31 #define LOCKD_VERSION           "0.5"
  32
  33 /*
  34  * Default timeout for RPC calls (seconds)
  35  */
  36 #define LOCKD_DFLT_TIMEO        10
  37
  38 /*
  39  * Lockd host handle (used both by the client and server personality).
  40  */
  41 struct nlm_host {
  42         struct hlist_node       h_hash;         /* doubly linked list */
  43         struct sockaddr_storage h_addr;         /* peer address */
  44         size_t                  h_addrlen;
  45         struct sockaddr_storage h_srcaddr;      /* our address (optional) */
  46         struct rpc_clnt         *h_rpcclnt;     /* RPC client to talk to peer */
  47         char                    *h_name;                /* remote hostname */
  48         u32                     h_version;      /* interface version */
  49         unsigned short          h_proto;        /* transport proto */
  50         unsigned short          h_reclaiming : 1,
  51                                 h_server     : 1, /* server side, not client side */
  52                                 h_noresvport : 1,
  53                                 h_inuse      : 1;
  54         wait_queue_head_t       h_gracewait;    /* wait while reclaiming */
  55         struct rw_semaphore     h_rwsem;        /* Reboot recovery lock */
  56         u32                     h_state;        /* pseudo-state counter */
  57         u32                     h_nsmstate;     /* true remote NSM state */
  58         u32                     h_pidcount;     /* Pseudopids */
  59         atomic_t                h_count;        /* reference count */
  60         struct mutex            h_mutex;        /* mutex for pmap binding */
  61         unsigned long           h_nextrebind;   /* next portmap call */
  62         unsigned long           h_expires;      /* eligible for GC */
  63         struct list_head        h_lockowners;   /* Lockowners for the client */
  64         spinlock_t              h_lock;
  65         struct list_head        h_granted;      /* Locks in GRANTED state */
  66         struct list_head        h_reclaim;      /* Locks in RECLAIM state */
  67         struct nsm_handle       *h_nsmhandle;   /* NSM status handle */
  68         char                    *h_addrbuf;     /* address eyecatcher */
  69 };
  70
  71 /*
  72  * The largest string sm_addrbuf should hold is a full-size IPv6 address
  73  * (no "::" anywhere) with a scope ID.  The buffer size is computed to
  74  * hold eight groups of colon-separated four-hex-digit numbers, a
  75  * percent sign, a scope id (at most 32 bits, in decimal), and NUL.
  76  */
  77 #define NSM_ADDRBUF             ((8 * 4 + 7) + (1 + 10) + 1)
  78
  79 struct nsm_handle {
  80         struct list_head        sm_link;
  81         atomic_t                sm_count;
  82         char                    *sm_mon_name;
  83         char                    *sm_name;
  84         struct sockaddr_storage sm_addr;
  85         size_t                  sm_addrlen;
  86         unsigned int            sm_monitored : 1,
  87                                 sm_sticky : 1;  /* don't unmonitor */
  88         char                    sm_addrbuf[NSM_ADDRBUF];
  89 };
  90
  91 /*
  92  * Rigorous type checking on sockaddr type conversions
  93  */
  94 static inline struct sockaddr_in *nlm_addr_in(const struct nlm_host *host)
  95 {
  96         return (struct sockaddr_in *)&host->h_addr;
  97 }
  98
  99 static inline struct sockaddr *nlm_addr(const struct nlm_host *host)
 100 {
 101         return (struct sockaddr *)&host->h_addr;
 102 }
 103
 104 static inline struct sockaddr_in *nlm_srcaddr_in(const struct nlm_host *host)
 105 {
 106         return (struct sockaddr_in *)&host->h_srcaddr;
 107 }
 108
 109 static inline struct sockaddr *nlm_srcaddr(const struct nlm_host *host)
 110 {
 111         return (struct sockaddr *)&host->h_srcaddr;
 112 }
 113
 114 static inline struct sockaddr_in *nsm_addr_in(const struct nsm_handle *handle)
 115 {
 116         return (struct sockaddr_in *)&handle->sm_addr;
 117 }
 118
 119 static inline struct sockaddr *nsm_addr(const struct nsm_handle *handle)
 120 {
 121         return (struct sockaddr *)&handle->sm_addr;
 122 }
 123
 124 /*
 125  * Map an fl_owner_t into a unique 32-bit "pid"
 126  */
 127 struct nlm_lockowner {
 128         struct list_head list;
 129         atomic_t count;
 130
 131         struct nlm_host *host;
 132         fl_owner_t owner;
 133         uint32_t pid;
 134 };
 135
 136 struct nlm_wait;
 137
 138 /*
 139  * Memory chunk for NLM client RPC request.
 140  */
 141 #define NLMCLNT_OHSIZE          ((__NEW_UTS_LEN) + 10u)
 142 struct nlm_rqst {
 143         atomic_t                a_count;
 144         unsigned int            a_flags;        /* initial RPC task flags */
 145         struct nlm_host *       a_host;         /* host handle */
 146         struct nlm_args         a_args;         /* arguments */
 147         struct nlm_res          a_res;          /* result */
 148         struct nlm_block *      a_block;
 149         unsigned int            a_retries;      /* Retry count */
 150         u8                      a_owner[NLMCLNT_OHSIZE];
 151 };
 152
 153 /*
 154  * This struct describes a file held open by lockd on behalf of
 155  * an NFS client.
 156  */
 157 struct nlm_file {
 158         struct hlist_node       f_list;         /* linked list */
 159         struct nfs_fh           f_handle;       /* NFS file handle */
 160         struct file *           f_file;         /* VFS file pointer */
 161         struct nlm_share *      f_shares;       /* DOS shares */
 162         struct list_head        f_blocks;       /* blocked locks */
 163         unsigned int            f_locks;        /* guesstimate # of locks */
 164         unsigned int            f_count;        /* reference count */
 165         struct mutex            f_mutex;        /* avoid concurrent access */
 166 };
 167
 168 /*
 169  * This is a server block (i.e. a lock requested by some client which
 170  * couldn't be granted because of a conflicting lock).
 171  */
 172 #define NLM_NEVER               (~(unsigned long) 0)
 173 /* timeout on non-blocking call: */
 174 #define NLM_TIMEOUT             (7 * HZ)
 175
 176 struct nlm_block {
 177         struct kref             b_count;        /* Reference count */
 178         struct list_head        b_list;         /* linked list of all blocks */
 179         struct list_head        b_flist;        /* linked list (per file) */
 180         struct nlm_rqst *       b_call;         /* RPC args & callback info */
 181         struct svc_serv *       b_daemon;       /* NLM service */
 182         struct nlm_host *       b_host;         /* host handle for RPC clnt */
 183         unsigned long           b_when;         /* next re-xmit */
 184         unsigned int            b_id;           /* block id */
 185         unsigned char           b_granted;      /* VFS granted lock */
 186         struct nlm_file *       b_file;         /* file in question */
 187         struct cache_req *      b_cache_req;    /* deferred request handling */
 188         struct file_lock *      b_fl;           /* set for GETLK */
 189         struct cache_deferred_req * b_deferred_req;
 190         unsigned int            b_flags;        /* block flags */
 191 #define B_QUEUED                1       /* lock queued */
 192 #define B_GOT_CALLBACK          2       /* got lock or conflicting lock */
 193 #define B_TIMED_OUT             4       /* filesystem too slow to respond */
 194 };
 195
 196 /*
 197  * Global variables
 198  */
 199 extern struct rpc_program       nlm_program;
 200 extern struct svc_procedure     nlmsvc_procedures[];
 201 #ifdef CONFIG_LOCKD_V4
 202 extern struct svc_procedure     nlmsvc_procedures4[];
 203 #endif
 204 extern int                      nlmsvc_grace_period;
 205 extern unsigned long            nlmsvc_timeout;
 206 extern int                      nsm_use_hostnames;
 207
 208 /*
 209  * Lockd client functions
 210  */
 211 struct nlm_rqst * nlm_alloc_call(struct nlm_host *host);
 212 void              nlm_release_call(struct nlm_rqst *);
 213 int               nlm_async_call(struct nlm_rqst *, u32, const struct rpc_call_ops *);
 214 int               nlm_async_reply(struct nlm_rqst *, u32, const struct rpc_call_ops *);
 215 struct nlm_wait * nlmclnt_prepare_block(struct nlm_host *host, struct file_lock *fl);
 216 void              nlmclnt_finish_block(struct nlm_wait *block);
 217 int               nlmclnt_block(struct nlm_wait *block, struct nlm_rqst *req, long timeout);
 218 __be32            nlmclnt_grant(const struct sockaddr *addr,
 219                                 const struct nlm_lock *lock);
 220 void              nlmclnt_recovery(struct nlm_host *);
 221 int               nlmclnt_reclaim(struct nlm_host *, struct file_lock *);
 222 void              nlmclnt_next_cookie(struct nlm_cookie *);
 223
 224 /*
 225  * Host cache
 226  */
 227 struct nlm_host  *nlmclnt_lookup_host(const struct sockaddr *sap,
 228                                         const size_t salen,
 229                                         const unsigned short protocol,
 230                                         const u32 version,
 231                                         const char *hostname,
 232                                         int noresvport);
 233 struct nlm_host  *nlmsvc_lookup_host(const struct svc_rqst *rqstp,
 234                                         const char *hostname,
 235                                         const size_t hostname_len);
 236 struct rpc_clnt * nlm_bind_host(struct nlm_host *);
 237 void              nlm_rebind_host(struct nlm_host *);
 238 struct nlm_host * nlm_get_host(struct nlm_host *);
 239 void              nlm_release_host(struct nlm_host *);
 240 void              nlm_shutdown_hosts(void);
 241 extern void       nlm_host_rebooted(const struct sockaddr_in *, const char *,
 242                                         unsigned int, u32);
 243
 244 /*
 245  * Host monitoring
 246  */
 247 int               nsm_monitor(const struct nlm_host *host);
 248 void              nsm_unmonitor(const struct nlm_host *host);
 249
 250 struct nsm_handle *nsm_find(const struct sockaddr *sap, const size_t salen,
 251                                         const char *hostname,
 252                                         const size_t hostname_len,
 253                                         const int create);
 254 void              nsm_release(struct nsm_handle *nsm);
 255
 256 /*
 257  * This is used in garbage collection and resource reclaim
 258  * A return value != 0 means destroy the lock/block/share
 259  */
 260 typedef int       (*nlm_host_match_fn_t)(void *cur, struct nlm_host *ref);
 261
 262 /*
 263  * Server-side lock handling
 264  */
 265 __be32            nlmsvc_lock(struct svc_rqst *, struct nlm_file *,
 266                               struct nlm_host *, struct nlm_lock *, int,
 267                               struct nlm_cookie *, int);
 268 __be32            nlmsvc_unlock(struct nlm_file *, struct nlm_lock *);
 269 __be32            nlmsvc_testlock(struct svc_rqst *, struct nlm_file *,
 270                         struct nlm_host *, struct nlm_lock *,
 271                         struct nlm_lock *, struct nlm_cookie *);
 272 __be32            nlmsvc_cancel_blocked(struct nlm_file *, struct nlm_lock *);
 273 unsigned long     nlmsvc_retry_blocked(void);
 274 void              nlmsvc_traverse_blocks(struct nlm_host *, struct nlm_file *,
 275                                         nlm_host_match_fn_t match);
 276 void              nlmsvc_grant_reply(struct nlm_cookie *, __be32);
 277
 278 /*
 279  * File handling for the server personality
 280  */
 281 __be32            nlm_lookup_file(struct svc_rqst *, struct nlm_file **,
 282                                         struct nfs_fh *);
 283 void              nlm_release_file(struct nlm_file *);
 284 void              nlmsvc_mark_resources(void);
 285 void              nlmsvc_free_host_resources(struct nlm_host *);
 286 void              nlmsvc_invalidate_all(void);
 287
 288 /*
 289  * Cluster failover support
 290  */
 291 int           nlmsvc_unlock_all_by_sb(struct super_block *sb);
 292 int           nlmsvc_unlock_all_by_ip(struct sockaddr *server_addr);
 293
 294 static inline struct inode *nlmsvc_file_inode(struct nlm_file *file)
 295 {
 296         return file->f_file->f_path.dentry->d_inode;
 297 }
 298
 299 static inline int __nlm_privileged_request4(const struct sockaddr *sap)
 300 {
 301         const struct sockaddr_in *sin = (struct sockaddr_in *)sap;
 302         return (sin->sin_addr.s_addr == htonl(INADDR_LOOPBACK)) &&
 303                         (ntohs(sin->sin_port) < 1024);
 304 }
 305
 306 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
 307 static inline int __nlm_privileged_request6(const struct sockaddr *sap)
 308 {
 309         const struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap;
 310         return (ipv6_addr_type(&sin6->sin6_addr) & IPV6_ADDR_LOOPBACK) &&
 311                         (ntohs(sin6->sin6_port) < 1024);
 312 }
 313 #else   /* defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE) */
 314 static inline int __nlm_privileged_request6(const struct sockaddr *sap)
 315 {
 316         return 0;
 317 }
 318 #endif  /* defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE) */
 319
 320 /*
 321  * Ensure incoming requests are from local privileged callers.
 322  *
 323  * Return TRUE if sender is local and is connecting via a privileged port;
 324  * otherwise return FALSE.
 325  */
 326 static inline int nlm_privileged_requester(const struct svc_rqst *rqstp)
 327 {
 328         const struct sockaddr *sap = svc_addr(rqstp);
 329
 330         switch (sap->sa_family) {
 331         case AF_INET:
 332                 return __nlm_privileged_request4(sap);
 333         case AF_INET6:
 334                 return __nlm_privileged_request6(sap);
 335         default:
 336                 return 0;
 337         }
 338 }
 339
 340 static inline int __nlm_cmp_addr4(const struct sockaddr *sap1,
 341                                   const struct sockaddr *sap2)
 342 {
 343         const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sap1;
 344         const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sap2;
 345         return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
 346 }
 347
 348 static inline int __nlm_cmp_addr6(const struct sockaddr *sap1,
 349                                   const struct sockaddr *sap2)
 350 {
 351         const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sap1;
 352         const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sap2;
 353         return ipv6_addr_equal(&sin1->sin6_addr, &sin2->sin6_addr);
 354 }
 355
 356 /*
 357  * Compare two host addresses
 358  *
 359  * Return TRUE if the addresses are the same; otherwise FALSE.
 360  */
 361 static inline int nlm_cmp_addr(const struct sockaddr *sap1,
 362                                const struct sockaddr *sap2)
 363 {
 364         if (sap1->sa_family == sap2->sa_family) {
 365                 switch (sap1->sa_family) {
 366                 case AF_INET:
 367                         return __nlm_cmp_addr4(sap1, sap2);
 368                 case AF_INET6:
 369                         return __nlm_cmp_addr6(sap1, sap2);
 370                 }
 371         }
 372         return 0;
 373 }
 374
 375 /*
 376  * Compare two NLM locks.
 377  * When the second lock is of type F_UNLCK, this acts like a wildcard.
 378  */
 379 static inline int nlm_compare_locks(const struct file_lock *fl1,
 380                                     const struct file_lock *fl2)
 381 {
 382         return  fl1->fl_pid   == fl2->fl_pid
 383              && fl1->fl_owner == fl2->fl_owner
 384              && fl1->fl_start == fl2->fl_start
 385              && fl1->fl_end   == fl2->fl_end
 386              &&(fl1->fl_type  == fl2->fl_type || fl2->fl_type == F_UNLCK);
 387 }
 388
 389 extern struct lock_manager_operations nlmsvc_lock_operations;
 390
 391 #endif /* __KERNEL__ */
 392
 393 #endif /* LINUX_LOCKD_LOCKD_H */