2 * linux/include/linux/lockd/lockd.h
4 * General-purpose lockd include file.
6 * Copyright (C) 1996 Olaf Kirch <okir@monad.swb.de>
9 #ifndef LINUX_LOCKD_LOCKD_H
10 #define LINUX_LOCKD_LOCKD_H
15 #include <linux/in6.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>
26 #include <linux/lockd/debug.h>
31 #define LOCKD_VERSION "0.5"
34 * Default timeout for RPC calls (seconds)
36 #define LOCKD_DFLT_TIMEO 10
39 * Lockd host handle (used both by the client and server personality).
42 struct hlist_node h_hash; /* doubly linked list */
43 struct sockaddr_storage h_addr; /* peer address */
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 */
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 */
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 */
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.
77 #define NSM_ADDRBUF ((8 * 4 + 7) + (1 + 10) + 1)
80 struct list_head sm_link;
84 struct sockaddr_storage sm_addr;
86 unsigned int sm_monitored : 1,
87 sm_sticky : 1; /* don't unmonitor */
88 char sm_addrbuf[NSM_ADDRBUF];
92 * Rigorous type checking on sockaddr type conversions
94 static inline struct sockaddr_in *nlm_addr_in(const struct nlm_host *host)
96 return (struct sockaddr_in *)&host->h_addr;
99 static inline struct sockaddr *nlm_addr(const struct nlm_host *host)
101 return (struct sockaddr *)&host->h_addr;
104 static inline struct sockaddr_in *nlm_srcaddr_in(const struct nlm_host *host)
106 return (struct sockaddr_in *)&host->h_srcaddr;
109 static inline struct sockaddr *nlm_srcaddr(const struct nlm_host *host)
111 return (struct sockaddr *)&host->h_srcaddr;
114 static inline struct sockaddr_in *nsm_addr_in(const struct nsm_handle *handle)
116 return (struct sockaddr_in *)&handle->sm_addr;
119 static inline struct sockaddr *nsm_addr(const struct nsm_handle *handle)
121 return (struct sockaddr *)&handle->sm_addr;
125 * Map an fl_owner_t into a unique 32-bit "pid"
127 struct nlm_lockowner {
128 struct list_head list;
131 struct nlm_host *host;
139 * Memory chunk for NLM client RPC request.
141 #define NLMCLNT_OHSIZE ((__NEW_UTS_LEN) + 10u)
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];
154 * This struct describes a file held open by lockd on behalf of
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 */
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).
172 #define NLM_NEVER (~(unsigned long) 0)
173 /* timeout on non-blocking call: */
174 #define NLM_TIMEOUT (7 * HZ)
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 */
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[];
204 extern int nlmsvc_grace_period;
205 extern unsigned long nlmsvc_timeout;
206 extern int nsm_use_hostnames;
209 * Lockd client functions
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 *);
227 struct nlm_host *nlmclnt_lookup_host(const struct sockaddr *sap,
229 const unsigned short protocol,
231 const char *hostname,
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 *,
243 void nsm_release(struct nsm_handle *);
248 int nsm_monitor(const struct nlm_host *host);
251 * This is used in garbage collection and resource reclaim
252 * A return value != 0 means destroy the lock/block/share
254 typedef int (*nlm_host_match_fn_t)(void *cur, struct nlm_host *ref);
257 * Server-side lock handling
259 __be32 nlmsvc_lock(struct svc_rqst *, struct nlm_file *,
260 struct nlm_host *, struct nlm_lock *, int,
261 struct nlm_cookie *, int);
262 __be32 nlmsvc_unlock(struct nlm_file *, struct nlm_lock *);
263 __be32 nlmsvc_testlock(struct svc_rqst *, struct nlm_file *,
264 struct nlm_host *, struct nlm_lock *,
265 struct nlm_lock *, struct nlm_cookie *);
266 __be32 nlmsvc_cancel_blocked(struct nlm_file *, struct nlm_lock *);
267 unsigned long nlmsvc_retry_blocked(void);
268 void nlmsvc_traverse_blocks(struct nlm_host *, struct nlm_file *,
269 nlm_host_match_fn_t match);
270 void nlmsvc_grant_reply(struct nlm_cookie *, __be32);
273 * File handling for the server personality
275 __be32 nlm_lookup_file(struct svc_rqst *, struct nlm_file **,
277 void nlm_release_file(struct nlm_file *);
278 void nlmsvc_mark_resources(void);
279 void nlmsvc_free_host_resources(struct nlm_host *);
280 void nlmsvc_invalidate_all(void);
283 * Cluster failover support
285 int nlmsvc_unlock_all_by_sb(struct super_block *sb);
286 int nlmsvc_unlock_all_by_ip(struct sockaddr *server_addr);
288 static inline struct inode *nlmsvc_file_inode(struct nlm_file *file)
290 return file->f_file->f_path.dentry->d_inode;
293 static inline int __nlm_privileged_request4(const struct sockaddr *sap)
295 const struct sockaddr_in *sin = (struct sockaddr_in *)sap;
296 return (sin->sin_addr.s_addr == htonl(INADDR_LOOPBACK)) &&
297 (ntohs(sin->sin_port) < 1024);
300 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
301 static inline int __nlm_privileged_request6(const struct sockaddr *sap)
303 const struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap;
304 return (ipv6_addr_type(&sin6->sin6_addr) & IPV6_ADDR_LOOPBACK) &&
305 (ntohs(sin6->sin6_port) < 1024);
307 #else /* defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE) */
308 static inline int __nlm_privileged_request6(const struct sockaddr *sap)
312 #endif /* defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE) */
315 * Ensure incoming requests are from local privileged callers.
317 * Return TRUE if sender is local and is connecting via a privileged port;
318 * otherwise return FALSE.
320 static inline int nlm_privileged_requester(const struct svc_rqst *rqstp)
322 const struct sockaddr *sap = svc_addr(rqstp);
324 switch (sap->sa_family) {
326 return __nlm_privileged_request4(sap);
328 return __nlm_privileged_request6(sap);
334 static inline int __nlm_cmp_addr4(const struct sockaddr *sap1,
335 const struct sockaddr *sap2)
337 const struct sockaddr_in *sin1 = (const struct sockaddr_in *)sap1;
338 const struct sockaddr_in *sin2 = (const struct sockaddr_in *)sap2;
339 return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
342 static inline int __nlm_cmp_addr6(const struct sockaddr *sap1,
343 const struct sockaddr *sap2)
345 const struct sockaddr_in6 *sin1 = (const struct sockaddr_in6 *)sap1;
346 const struct sockaddr_in6 *sin2 = (const struct sockaddr_in6 *)sap2;
347 return ipv6_addr_equal(&sin1->sin6_addr, &sin2->sin6_addr);
351 * Compare two host addresses
353 * Return TRUE if the addresses are the same; otherwise FALSE.
355 static inline int nlm_cmp_addr(const struct sockaddr *sap1,
356 const struct sockaddr *sap2)
358 if (sap1->sa_family == sap2->sa_family) {
359 switch (sap1->sa_family) {
361 return __nlm_cmp_addr4(sap1, sap2);
363 return __nlm_cmp_addr6(sap1, sap2);
370 * Compare two NLM locks.
371 * When the second lock is of type F_UNLCK, this acts like a wildcard.
373 static inline int nlm_compare_locks(const struct file_lock *fl1,
374 const struct file_lock *fl2)
376 return fl1->fl_pid == fl2->fl_pid
377 && fl1->fl_owner == fl2->fl_owner
378 && fl1->fl_start == fl2->fl_start
379 && fl1->fl_end == fl2->fl_end
380 &&(fl1->fl_type == fl2->fl_type || fl2->fl_type == F_UNLCK);
383 extern struct lock_manager_operations nlmsvc_lock_operations;
385 #endif /* __KERNEL__ */
387 #endif /* LINUX_LOCKD_LOCKD_H */