NSM: Generate NSMPROC_MON's "priv" argument when nsm_handle is created
[linux-2.6.git] / 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         struct nsm_private      sm_priv;
89         char                    sm_addrbuf[NSM_ADDRBUF];
90 };
91
92 /*
93  * Rigorous type checking on sockaddr type conversions
94  */
95 static inline struct sockaddr_in *nlm_addr_in(const struct nlm_host *host)
96 {
97         return (struct sockaddr_in *)&host->h_addr;
98 }
99
100 static inline struct sockaddr *nlm_addr(const struct nlm_host *host)
101 {
102         return (struct sockaddr *)&host->h_addr;
103 }
104
105 static inline struct sockaddr_in *nlm_srcaddr_in(const struct nlm_host *host)
106 {
107         return (struct sockaddr_in *)&host->h_srcaddr;
108 }
109
110 static inline struct sockaddr *nlm_srcaddr(const struct nlm_host *host)
111 {
112         return (struct sockaddr *)&host->h_srcaddr;
113 }
114
115 static inline struct sockaddr_in *nsm_addr_in(const struct nsm_handle *handle)
116 {
117         return (struct sockaddr_in *)&handle->sm_addr;
118 }
119
120 static inline struct sockaddr *nsm_addr(const struct nsm_handle *handle)
121 {
122         return (struct sockaddr *)&handle->sm_addr;
123 }
124
125 /*
126  * Map an fl_owner_t into a unique 32-bit "pid"
127  */
128 struct nlm_lockowner {
129         struct list_head list;
130         atomic_t count;
131
132         struct nlm_host *host;
133         fl_owner_t owner;
134         uint32_t pid;
135 };
136
137 struct nlm_wait;
138
139 /*
140  * Memory chunk for NLM client RPC request.
141  */
142 #define NLMCLNT_OHSIZE          ((__NEW_UTS_LEN) + 10u)
143 struct nlm_rqst {
144         atomic_t                a_count;
145         unsigned int            a_flags;        /* initial RPC task flags */
146         struct nlm_host *       a_host;         /* host handle */
147         struct nlm_args         a_args;         /* arguments */
148         struct nlm_res          a_res;          /* result */
149         struct nlm_block *      a_block;
150         unsigned int            a_retries;      /* Retry count */
151         u8                      a_owner[NLMCLNT_OHSIZE];
152 };
153
154 /*
155  * This struct describes a file held open by lockd on behalf of
156  * an NFS client.
157  */
158 struct nlm_file {
159         struct hlist_node       f_list;         /* linked list */
160         struct nfs_fh           f_handle;       /* NFS file handle */
161         struct file *           f_file;         /* VFS file pointer */
162         struct nlm_share *      f_shares;       /* DOS shares */
163         struct list_head        f_blocks;       /* blocked locks */
164         unsigned int            f_locks;        /* guesstimate # of locks */
165         unsigned int            f_count;        /* reference count */
166         struct mutex            f_mutex;        /* avoid concurrent access */
167 };
168
169 /*
170  * This is a server block (i.e. a lock requested by some client which
171  * couldn't be granted because of a conflicting lock).
172  */
173 #define NLM_NEVER               (~(unsigned long) 0)
174 /* timeout on non-blocking call: */
175 #define NLM_TIMEOUT             (7 * HZ)
176
177 struct nlm_block {
178         struct kref             b_count;        /* Reference count */
179         struct list_head        b_list;         /* linked list of all blocks */
180         struct list_head        b_flist;        /* linked list (per file) */
181         struct nlm_rqst *       b_call;         /* RPC args & callback info */
182         struct svc_serv *       b_daemon;       /* NLM service */
183         struct nlm_host *       b_host;         /* host handle for RPC clnt */
184         unsigned long           b_when;         /* next re-xmit */
185         unsigned int            b_id;           /* block id */
186         unsigned char           b_granted;      /* VFS granted lock */
187         struct nlm_file *       b_file;         /* file in question */
188         struct cache_req *      b_cache_req;    /* deferred request handling */
189         struct file_lock *      b_fl;           /* set for GETLK */
190         struct cache_deferred_req * b_deferred_req;
191         unsigned int            b_flags;        /* block flags */
192 #define B_QUEUED                1       /* lock queued */
193 #define B_GOT_CALLBACK          2       /* got lock or conflicting lock */
194 #define B_TIMED_OUT             4       /* filesystem too slow to respond */
195 };
196
197 /*
198  * Global variables
199  */
200 extern struct rpc_program       nlm_program;
201 extern struct svc_procedure     nlmsvc_procedures[];
202 #ifdef CONFIG_LOCKD_V4
203 extern struct svc_procedure     nlmsvc_procedures4[];
204 #endif
205 extern int                      nlmsvc_grace_period;
206 extern unsigned long            nlmsvc_timeout;
207 extern int                      nsm_use_hostnames;
208
209 /*
210  * Lockd client functions
211  */
212 struct nlm_rqst * nlm_alloc_call(struct nlm_host *host);
213 void              nlm_release_call(struct nlm_rqst *);
214 int               nlm_async_call(struct nlm_rqst *, u32, const struct rpc_call_ops *);
215 int               nlm_async_reply(struct nlm_rqst *, u32, const struct rpc_call_ops *);
216 struct nlm_wait * nlmclnt_prepare_block(struct nlm_host *host, struct file_lock *fl);
217 void              nlmclnt_finish_block(struct nlm_wait *block);
218 int               nlmclnt_block(struct nlm_wait *block, struct nlm_rqst *req, long timeout);
219 __be32            nlmclnt_grant(const struct sockaddr *addr,
220                                 const struct nlm_lock *lock);
221 void              nlmclnt_recovery(struct nlm_host *);
222 int               nlmclnt_reclaim(struct nlm_host *, struct file_lock *);
223 void              nlmclnt_next_cookie(struct nlm_cookie *);
224
225 /*
226  * Host cache
227  */
228 struct nlm_host  *nlmclnt_lookup_host(const struct sockaddr *sap,
229                                         const size_t salen,
230                                         const unsigned short protocol,
231                                         const u32 version,
232                                         const char *hostname,
233                                         int noresvport);
234 struct nlm_host  *nlmsvc_lookup_host(const struct svc_rqst *rqstp,
235                                         const char *hostname,
236                                         const size_t hostname_len);
237 struct rpc_clnt * nlm_bind_host(struct nlm_host *);
238 void              nlm_rebind_host(struct nlm_host *);
239 struct nlm_host * nlm_get_host(struct nlm_host *);
240 void              nlm_release_host(struct nlm_host *);
241 void              nlm_shutdown_hosts(void);
242 extern void       nlm_host_rebooted(const struct sockaddr_in *, const char *,
243                                         unsigned int, u32);
244
245 /*
246  * Host monitoring
247  */
248 int               nsm_monitor(const struct nlm_host *host);
249 void              nsm_unmonitor(const struct nlm_host *host);
250
251 struct nsm_handle *nsm_find(const struct sockaddr *sap, const size_t salen,
252                                         const char *hostname,
253                                         const size_t hostname_len,
254                                         const int create);
255 void              nsm_release(struct nsm_handle *nsm);
256
257 /*
258  * This is used in garbage collection and resource reclaim
259  * A return value != 0 means destroy the lock/block/share
260  */
261 typedef int       (*nlm_host_match_fn_t)(void *cur, struct nlm_host *ref);
262
263 /*
264  * Server-side lock handling
265  */
266 __be32            nlmsvc_lock(struct svc_rqst *, struct nlm_file *,
267                               struct nlm_host *, struct nlm_lock *, int,
268                               struct nlm_cookie *, int);
269 __be32            nlmsvc_unlock(struct nlm_file *, struct nlm_lock *);
270 __be32            nlmsvc_testlock(struct svc_rqst *, struct nlm_file *,
271                         struct nlm_host *, struct nlm_lock *,
272                         struct nlm_lock *, struct nlm_cookie *);
273 __be32            nlmsvc_cancel_blocked(struct nlm_file *, struct nlm_lock *);
274 unsigned long     nlmsvc_retry_blocked(void);
275 void              nlmsvc_traverse_blocks(struct nlm_host *, struct nlm_file *,
276                                         nlm_host_match_fn_t match);
277 void              nlmsvc_grant_reply(struct nlm_cookie *, __be32);
278
279 /*
280  * File handling for the server personality
281  */
282 __be32            nlm_lookup_file(struct svc_rqst *, struct nlm_file **,
283                                         struct nfs_fh *);
284 void              nlm_release_file(struct nlm_file *);
285 void              nlmsvc_mark_resources(void);
286 void              nlmsvc_free_host_resources(struct nlm_host *);
287 void              nlmsvc_invalidate_all(void);
288
289 /*
290  * Cluster failover support
291  */
292 int           nlmsvc_unlock_all_by_sb(struct super_block *sb);
293 int           nlmsvc_unlock_all_by_ip(struct sockaddr *server_addr);
294
295 static inline struct inode *nlmsvc_file_inode(struct nlm_file *file)
296 {
297         return file->f_file->f_path.dentry->d_inode;
298 }
299
300 static inline int __nlm_privileged_request4(const struct sockaddr *sap)
301 {
302         const struct sockaddr_in *sin = (struct sockaddr_in *)sap;
303         return (sin->sin_addr.s_addr == htonl(INADDR_LOOPBACK)) &&
304                         (ntohs(sin->sin_port) < 1024);
305 }
306
307 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
308 static inline int __nlm_privileged_request6(const struct sockaddr *sap)
309 {
310         const struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap;
311         return (ipv6_addr_type(&sin6->sin6_addr) & IPV6_ADDR_LOOPBACK) &&
312                         (ntohs(sin6->sin6_port) < 1024);
313 }
314 #else   /* defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE) */
315 static inline int __nlm_privileged_request6(const struct sockaddr *sap)
316 {
317         return 0;
318 }
319 #endif  /* defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE) */
320
321 /*
322  * Ensure incoming requests are from local privileged callers.
323  *
324  * Return TRUE if sender is local and is connecting via a privileged port;
325  * otherwise return FALSE.
326  */
327 static inline int nlm_privileged_requester(const struct svc_rqst *rqstp)
328 {
329         const struct sockaddr *sap = svc_addr(rqstp);
330
331         switch (sap->sa_family) {
332         case AF_INET:
333                 return __nlm_privileged_request4(sap);
334         case AF_INET6:
335                 return __nlm_privileged_request6(sap);
336         default:
337                 return 0;
338         }
339 }
340
341 static inline int __nlm_cmp_addr4(const struct sockaddr *sap1,
342                                   const struct sockaddr *sap2)
343 {
344         const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sap1;
345         const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sap2;
346         return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
347 }
348
349 static inline int __nlm_cmp_addr6(const struct sockaddr *sap1,
350                                   const struct sockaddr *sap2)
351 {
352         const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sap1;
353         const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sap2;
354         return ipv6_addr_equal(&sin1->sin6_addr, &sin2->sin6_addr);
355 }
356
357 /*
358  * Compare two host addresses
359  *
360  * Return TRUE if the addresses are the same; otherwise FALSE.
361  */
362 static inline int nlm_cmp_addr(const struct sockaddr *sap1,
363                                const struct sockaddr *sap2)
364 {
365         if (sap1->sa_family == sap2->sa_family) {
366                 switch (sap1->sa_family) {
367                 case AF_INET:
368                         return __nlm_cmp_addr4(sap1, sap2);
369                 case AF_INET6:
370                         return __nlm_cmp_addr6(sap1, sap2);
371                 }
372         }
373         return 0;
374 }
375
376 /*
377  * Compare two NLM locks.
378  * When the second lock is of type F_UNLCK, this acts like a wildcard.
379  */
380 static inline int nlm_compare_locks(const struct file_lock *fl1,
381                                     const struct file_lock *fl2)
382 {
383         return  fl1->fl_pid   == fl2->fl_pid
384              && fl1->fl_owner == fl2->fl_owner
385              && fl1->fl_start == fl2->fl_start
386              && fl1->fl_end   == fl2->fl_end
387              &&(fl1->fl_type  == fl2->fl_type || fl2->fl_type == F_UNLCK);
388 }
389
390 extern struct lock_manager_operations nlmsvc_lock_operations;
391
392 #endif /* __KERNEL__ */
393
394 #endif /* LINUX_LOCKD_LOCKD_H */