Commit | Line | Data |
---|---|---|
1da177e4 LT |
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 | ||
1da177e4 | 14 | #include <linux/in.h> |
781b61a6 CL |
15 | #include <linux/in6.h> |
16 | #include <net/ipv6.h> | |
1da177e4 | 17 | #include <linux/fs.h> |
6849c0ca | 18 | #include <linux/kref.h> |
1da177e4 LT |
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 { | |
0cea3276 | 42 | struct hlist_node h_hash; /* doubly linked list */ |
b4ed58fd CL |
43 | struct sockaddr_storage h_addr; /* peer address */ |
44 | size_t h_addrlen; | |
90151e6e | 45 | struct sockaddr_storage h_srcaddr; /* our address (optional) */ |
7538ce1e CL |
46 | struct rpc_clnt *h_rpcclnt; /* RPC client to talk to peer */ |
47 | char *h_name; /* remote hostname */ | |
1da177e4 LT |
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 */ | |
0cb2659b | 52 | h_noresvport : 1, |
350fce8d | 53 | h_inuse : 1; |
1da177e4 | 54 | wait_queue_head_t h_gracewait; /* wait while reclaiming */ |
28df955a | 55 | struct rw_semaphore h_rwsem; /* Reboot recovery lock */ |
1da177e4 LT |
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 */ | |
50467914 | 60 | struct mutex h_mutex; /* mutex for pmap binding */ |
1da177e4 LT |
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; | |
26bcbf96 CH |
65 | struct list_head h_granted; /* Locks in GRANTED state */ |
66 | struct list_head h_reclaim; /* Locks in RECLAIM state */ | |
7538ce1e | 67 | struct nsm_handle *h_nsmhandle; /* NSM status handle */ |
1df40b60 | 68 | char *h_addrbuf; /* address eyecatcher */ |
8dead0db OK |
69 | }; |
70 | ||
bc995801 CL |
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 | ||
8dead0db OK |
79 | struct nsm_handle { |
80 | struct list_head sm_link; | |
81 | atomic_t sm_count; | |
29ed1407 | 82 | char *sm_mon_name; |
f47534f7 | 83 | char *sm_name; |
7e9d7746 CL |
84 | struct sockaddr_storage sm_addr; |
85 | size_t sm_addrlen; | |
8dead0db OK |
86 | unsigned int sm_monitored : 1, |
87 | sm_sticky : 1; /* don't unmonitor */ | |
7e44d3be | 88 | struct nsm_private sm_priv; |
bc995801 | 89 | char sm_addrbuf[NSM_ADDRBUF]; |
1da177e4 LT |
90 | }; |
91 | ||
b4ed58fd CL |
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 | ||
90151e6e CL |
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 | ||
7e9d7746 CL |
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 | ||
1da177e4 LT |
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 | ||
ecdbf769 TM |
137 | struct nlm_wait; |
138 | ||
1da177e4 LT |
139 | /* |
140 | * Memory chunk for NLM client RPC request. | |
141 | */ | |
511d2e88 | 142 | #define NLMCLNT_OHSIZE ((__NEW_UTS_LEN) + 10u) |
1da177e4 | 143 | struct nlm_rqst { |
5e7f37a7 | 144 | atomic_t a_count; |
1da177e4 LT |
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 */ | |
92737230 | 149 | struct nlm_block * a_block; |
aaaa9942 | 150 | unsigned int a_retries; /* Retry count */ |
92737230 | 151 | u8 a_owner[NLMCLNT_OHSIZE]; |
1da177e4 LT |
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 { | |
07ba8063 | 159 | struct hlist_node f_list; /* linked list */ |
1da177e4 LT |
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 */ | |
68a2d76c | 163 | struct list_head f_blocks; /* blocked locks */ |
1da177e4 LT |
164 | unsigned int f_locks; /* guesstimate # of locks */ |
165 | unsigned int f_count; /* reference count */ | |
89e63ef6 | 166 | struct mutex f_mutex; /* avoid concurrent access */ |
1da177e4 LT |
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) | |
2b36f412 ME |
174 | /* timeout on non-blocking call: */ |
175 | #define NLM_TIMEOUT (7 * HZ) | |
176 | ||
1da177e4 | 177 | struct nlm_block { |
6849c0ca | 178 | struct kref b_count; /* Reference count */ |
68a2d76c OK |
179 | struct list_head b_list; /* linked list of all blocks */ |
180 | struct list_head b_flist; /* linked list (per file) */ | |
92737230 | 181 | struct nlm_rqst * b_call; /* RPC args & callback info */ |
1da177e4 LT |
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 */ | |
1da177e4 | 186 | unsigned char b_granted; /* VFS granted lock */ |
1da177e4 | 187 | struct nlm_file * b_file; /* file in question */ |
2b36f412 ME |
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 */ | |
1da177e4 LT |
195 | }; |
196 | ||
1da177e4 LT |
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; | |
abd1f500 | 207 | extern int nsm_use_hostnames; |
1da177e4 LT |
208 | |
209 | /* | |
210 | * Lockd client functions | |
211 | */ | |
92737230 TM |
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 *); | |
d4716624 | 215 | int nlm_async_reply(struct nlm_rqst *, u32, const struct rpc_call_ops *); |
3a649b88 TM |
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); | |
dcff09f1 CL |
219 | __be32 nlmclnt_grant(const struct sockaddr *addr, |
220 | const struct nlm_lock *lock); | |
5c8dd29c | 221 | void nlmclnt_recovery(struct nlm_host *); |
1da177e4 | 222 | int nlmclnt_reclaim(struct nlm_host *, struct file_lock *); |
031d869d | 223 | void nlmclnt_next_cookie(struct nlm_cookie *); |
1da177e4 LT |
224 | |
225 | /* | |
226 | * Host cache | |
227 | */ | |
d7d20440 CL |
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, | |
0cb2659b CL |
232 | const char *hostname, |
233 | int noresvport); | |
6bfbe8af CL |
234 | struct nlm_host *nlmsvc_lookup_host(const struct svc_rqst *rqstp, |
235 | const char *hostname, | |
236 | const size_t hostname_len); | |
1da177e4 LT |
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); | |
7fefc9cb | 242 | void nlm_host_rebooted(const struct nlm_reboot *); |
1da177e4 | 243 | |
1e49323c CL |
244 | /* |
245 | * Host monitoring | |
246 | */ | |
247 | int nsm_monitor(const struct nlm_host *host); | |
356c3eb4 | 248 | void nsm_unmonitor(const struct nlm_host *host); |
1da177e4 | 249 | |
67c6d107 CL |
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 | ||
f2af793d OK |
256 | /* |
257 | * This is used in garbage collection and resource reclaim | |
258 | * A return value != 0 means destroy the lock/block/share | |
259 | */ | |
4373ea84 | 260 | typedef int (*nlm_host_match_fn_t)(void *cur, struct nlm_host *ref); |
f2af793d | 261 | |
1da177e4 LT |
262 | /* |
263 | * Server-side lock handling | |
264 | */ | |
52921e02 | 265 | __be32 nlmsvc_lock(struct svc_rqst *, struct nlm_file *, |
6cde4de8 | 266 | struct nlm_host *, struct nlm_lock *, int, |
b2b50289 | 267 | struct nlm_cookie *, int); |
52921e02 | 268 | __be32 nlmsvc_unlock(struct nlm_file *, struct nlm_lock *); |
85f3f1b3 | 269 | __be32 nlmsvc_testlock(struct svc_rqst *, struct nlm_file *, |
8f920d5e JL |
270 | struct nlm_host *, struct nlm_lock *, |
271 | struct nlm_lock *, struct nlm_cookie *); | |
52921e02 | 272 | __be32 nlmsvc_cancel_blocked(struct nlm_file *, struct nlm_lock *); |
1da177e4 | 273 | unsigned long nlmsvc_retry_blocked(void); |
f3ee439f | 274 | void nlmsvc_traverse_blocks(struct nlm_host *, struct nlm_file *, |
f2af793d | 275 | nlm_host_match_fn_t match); |
e8c5c045 | 276 | void nlmsvc_grant_reply(struct nlm_cookie *, __be32); |
1da177e4 LT |
277 | |
278 | /* | |
279 | * File handling for the server personality | |
280 | */ | |
52921e02 | 281 | __be32 nlm_lookup_file(struct svc_rqst *, struct nlm_file **, |
1da177e4 LT |
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 | ||
4373ea84 WC |
288 | /* |
289 | * Cluster failover support | |
290 | */ | |
17efa372 | 291 | int nlmsvc_unlock_all_by_sb(struct super_block *sb); |
367c8c7b | 292 | int nlmsvc_unlock_all_by_ip(struct sockaddr *server_addr); |
4373ea84 | 293 | |
f34ec991 | 294 | static inline struct inode *nlmsvc_file_inode(struct nlm_file *file) |
1da177e4 | 295 | { |
225a719f | 296 | return file->f_file->f_path.dentry->d_inode; |
1da177e4 LT |
297 | } |
298 | ||
b85e4676 CL |
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 | ||
781b61a6 CL |
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 | ||
1da177e4 | 356 | /* |
781b61a6 CL |
357 | * Compare two host addresses |
358 | * | |
359 | * Return TRUE if the addresses are the same; otherwise FALSE. | |
1da177e4 | 360 | */ |
781b61a6 CL |
361 | static inline int nlm_cmp_addr(const struct sockaddr *sap1, |
362 | const struct sockaddr *sap2) | |
1da177e4 | 363 | { |
781b61a6 CL |
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; | |
1da177e4 LT |
373 | } |
374 | ||
375 | /* | |
376 | * Compare two NLM locks. | |
377 | * When the second lock is of type F_UNLCK, this acts like a wildcard. | |
378 | */ | |
f34ec991 CL |
379 | static inline int nlm_compare_locks(const struct file_lock *fl1, |
380 | const struct file_lock *fl2) | |
1da177e4 LT |
381 | { |
382 | return fl1->fl_pid == fl2->fl_pid | |
3134cbec | 383 | && fl1->fl_owner == fl2->fl_owner |
1da177e4 LT |
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 */ |