]>
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) */ |
8e35f8e7 | 46 | size_t h_srcaddrlen; |
7538ce1e CL |
47 | struct rpc_clnt *h_rpcclnt; /* RPC client to talk to peer */ |
48 | char *h_name; /* remote hostname */ | |
1da177e4 LT |
49 | u32 h_version; /* interface version */ |
50 | unsigned short h_proto; /* transport proto */ | |
51 | unsigned short h_reclaiming : 1, | |
52 | h_server : 1, /* server side, not client side */ | |
0cb2659b | 53 | h_noresvport : 1, |
350fce8d | 54 | h_inuse : 1; |
1da177e4 | 55 | wait_queue_head_t h_gracewait; /* wait while reclaiming */ |
28df955a | 56 | struct rw_semaphore h_rwsem; /* Reboot recovery lock */ |
1da177e4 LT |
57 | u32 h_state; /* pseudo-state counter */ |
58 | u32 h_nsmstate; /* true remote NSM state */ | |
59 | u32 h_pidcount; /* Pseudopids */ | |
60 | atomic_t h_count; /* reference count */ | |
50467914 | 61 | struct mutex h_mutex; /* mutex for pmap binding */ |
1da177e4 LT |
62 | unsigned long h_nextrebind; /* next portmap call */ |
63 | unsigned long h_expires; /* eligible for GC */ | |
64 | struct list_head h_lockowners; /* Lockowners for the client */ | |
65 | spinlock_t h_lock; | |
26bcbf96 CH |
66 | struct list_head h_granted; /* Locks in GRANTED state */ |
67 | struct list_head h_reclaim; /* Locks in RECLAIM state */ | |
7538ce1e | 68 | struct nsm_handle *h_nsmhandle; /* NSM status handle */ |
1df40b60 | 69 | char *h_addrbuf; /* address eyecatcher */ |
66697bfd | 70 | struct net *net; /* host net */ |
8dead0db OK |
71 | }; |
72 | ||
bc995801 CL |
73 | /* |
74 | * The largest string sm_addrbuf should hold is a full-size IPv6 address | |
75 | * (no "::" anywhere) with a scope ID. The buffer size is computed to | |
76 | * hold eight groups of colon-separated four-hex-digit numbers, a | |
77 | * percent sign, a scope id (at most 32 bits, in decimal), and NUL. | |
78 | */ | |
79 | #define NSM_ADDRBUF ((8 * 4 + 7) + (1 + 10) + 1) | |
80 | ||
8dead0db OK |
81 | struct nsm_handle { |
82 | struct list_head sm_link; | |
83 | atomic_t sm_count; | |
29ed1407 | 84 | char *sm_mon_name; |
f47534f7 | 85 | char *sm_name; |
7e9d7746 CL |
86 | struct sockaddr_storage sm_addr; |
87 | size_t sm_addrlen; | |
8dead0db OK |
88 | unsigned int sm_monitored : 1, |
89 | sm_sticky : 1; /* don't unmonitor */ | |
7e44d3be | 90 | struct nsm_private sm_priv; |
bc995801 | 91 | char sm_addrbuf[NSM_ADDRBUF]; |
1da177e4 LT |
92 | }; |
93 | ||
b4ed58fd CL |
94 | /* |
95 | * Rigorous type checking on sockaddr type conversions | |
96 | */ | |
97 | static inline struct sockaddr_in *nlm_addr_in(const struct nlm_host *host) | |
98 | { | |
99 | return (struct sockaddr_in *)&host->h_addr; | |
100 | } | |
101 | ||
102 | static inline struct sockaddr *nlm_addr(const struct nlm_host *host) | |
103 | { | |
104 | return (struct sockaddr *)&host->h_addr; | |
105 | } | |
106 | ||
90151e6e CL |
107 | static inline struct sockaddr_in *nlm_srcaddr_in(const struct nlm_host *host) |
108 | { | |
109 | return (struct sockaddr_in *)&host->h_srcaddr; | |
110 | } | |
111 | ||
112 | static inline struct sockaddr *nlm_srcaddr(const struct nlm_host *host) | |
113 | { | |
114 | return (struct sockaddr *)&host->h_srcaddr; | |
115 | } | |
116 | ||
1da177e4 LT |
117 | /* |
118 | * Map an fl_owner_t into a unique 32-bit "pid" | |
119 | */ | |
120 | struct nlm_lockowner { | |
121 | struct list_head list; | |
122 | atomic_t count; | |
123 | ||
124 | struct nlm_host *host; | |
125 | fl_owner_t owner; | |
126 | uint32_t pid; | |
127 | }; | |
128 | ||
ecdbf769 TM |
129 | struct nlm_wait; |
130 | ||
1da177e4 LT |
131 | /* |
132 | * Memory chunk for NLM client RPC request. | |
133 | */ | |
511d2e88 | 134 | #define NLMCLNT_OHSIZE ((__NEW_UTS_LEN) + 10u) |
1da177e4 | 135 | struct nlm_rqst { |
5e7f37a7 | 136 | atomic_t a_count; |
1da177e4 LT |
137 | unsigned int a_flags; /* initial RPC task flags */ |
138 | struct nlm_host * a_host; /* host handle */ | |
139 | struct nlm_args a_args; /* arguments */ | |
140 | struct nlm_res a_res; /* result */ | |
92737230 | 141 | struct nlm_block * a_block; |
aaaa9942 | 142 | unsigned int a_retries; /* Retry count */ |
92737230 | 143 | u8 a_owner[NLMCLNT_OHSIZE]; |
1da177e4 LT |
144 | }; |
145 | ||
146 | /* | |
147 | * This struct describes a file held open by lockd on behalf of | |
148 | * an NFS client. | |
149 | */ | |
150 | struct nlm_file { | |
07ba8063 | 151 | struct hlist_node f_list; /* linked list */ |
1da177e4 LT |
152 | struct nfs_fh f_handle; /* NFS file handle */ |
153 | struct file * f_file; /* VFS file pointer */ | |
154 | struct nlm_share * f_shares; /* DOS shares */ | |
68a2d76c | 155 | struct list_head f_blocks; /* blocked locks */ |
1da177e4 LT |
156 | unsigned int f_locks; /* guesstimate # of locks */ |
157 | unsigned int f_count; /* reference count */ | |
89e63ef6 | 158 | struct mutex f_mutex; /* avoid concurrent access */ |
1da177e4 LT |
159 | }; |
160 | ||
161 | /* | |
162 | * This is a server block (i.e. a lock requested by some client which | |
163 | * couldn't be granted because of a conflicting lock). | |
164 | */ | |
165 | #define NLM_NEVER (~(unsigned long) 0) | |
2b36f412 ME |
166 | /* timeout on non-blocking call: */ |
167 | #define NLM_TIMEOUT (7 * HZ) | |
168 | ||
1da177e4 | 169 | struct nlm_block { |
6849c0ca | 170 | struct kref b_count; /* Reference count */ |
68a2d76c OK |
171 | struct list_head b_list; /* linked list of all blocks */ |
172 | struct list_head b_flist; /* linked list (per file) */ | |
92737230 | 173 | struct nlm_rqst * b_call; /* RPC args & callback info */ |
1da177e4 LT |
174 | struct svc_serv * b_daemon; /* NLM service */ |
175 | struct nlm_host * b_host; /* host handle for RPC clnt */ | |
176 | unsigned long b_when; /* next re-xmit */ | |
177 | unsigned int b_id; /* block id */ | |
1da177e4 | 178 | unsigned char b_granted; /* VFS granted lock */ |
1da177e4 | 179 | struct nlm_file * b_file; /* file in question */ |
2b36f412 ME |
180 | struct cache_req * b_cache_req; /* deferred request handling */ |
181 | struct file_lock * b_fl; /* set for GETLK */ | |
182 | struct cache_deferred_req * b_deferred_req; | |
183 | unsigned int b_flags; /* block flags */ | |
184 | #define B_QUEUED 1 /* lock queued */ | |
185 | #define B_GOT_CALLBACK 2 /* got lock or conflicting lock */ | |
186 | #define B_TIMED_OUT 4 /* filesystem too slow to respond */ | |
1da177e4 LT |
187 | }; |
188 | ||
1da177e4 LT |
189 | /* |
190 | * Global variables | |
191 | */ | |
a613fa16 | 192 | extern const struct rpc_program nlm_program; |
1da177e4 LT |
193 | extern struct svc_procedure nlmsvc_procedures[]; |
194 | #ifdef CONFIG_LOCKD_V4 | |
195 | extern struct svc_procedure nlmsvc_procedures4[]; | |
196 | #endif | |
197 | extern int nlmsvc_grace_period; | |
198 | extern unsigned long nlmsvc_timeout; | |
90ab5ee9 | 199 | extern bool nsm_use_hostnames; |
6c9dc425 | 200 | extern u32 nsm_local_state; |
1da177e4 LT |
201 | |
202 | /* | |
203 | * Lockd client functions | |
204 | */ | |
92737230 | 205 | struct nlm_rqst * nlm_alloc_call(struct nlm_host *host); |
92737230 | 206 | int nlm_async_call(struct nlm_rqst *, u32, const struct rpc_call_ops *); |
d4716624 | 207 | int nlm_async_reply(struct nlm_rqst *, u32, const struct rpc_call_ops *); |
7db836d4 | 208 | void nlmclnt_release_call(struct nlm_rqst *); |
3a649b88 TM |
209 | struct nlm_wait * nlmclnt_prepare_block(struct nlm_host *host, struct file_lock *fl); |
210 | void nlmclnt_finish_block(struct nlm_wait *block); | |
211 | int nlmclnt_block(struct nlm_wait *block, struct nlm_rqst *req, long timeout); | |
dcff09f1 CL |
212 | __be32 nlmclnt_grant(const struct sockaddr *addr, |
213 | const struct nlm_lock *lock); | |
5c8dd29c | 214 | void nlmclnt_recovery(struct nlm_host *); |
1da177e4 | 215 | int nlmclnt_reclaim(struct nlm_host *, struct file_lock *); |
031d869d | 216 | void nlmclnt_next_cookie(struct nlm_cookie *); |
1da177e4 LT |
217 | |
218 | /* | |
219 | * Host cache | |
220 | */ | |
d7d20440 CL |
221 | struct nlm_host *nlmclnt_lookup_host(const struct sockaddr *sap, |
222 | const size_t salen, | |
223 | const unsigned short protocol, | |
224 | const u32 version, | |
0cb2659b | 225 | const char *hostname, |
66697bfd SK |
226 | int noresvport, |
227 | struct net *net); | |
8ea6ecc8 | 228 | void nlmclnt_release_host(struct nlm_host *); |
6bfbe8af CL |
229 | struct nlm_host *nlmsvc_lookup_host(const struct svc_rqst *rqstp, |
230 | const char *hostname, | |
231 | const size_t hostname_len); | |
67216b94 | 232 | void nlmsvc_release_host(struct nlm_host *); |
1da177e4 LT |
233 | struct rpc_clnt * nlm_bind_host(struct nlm_host *); |
234 | void nlm_rebind_host(struct nlm_host *); | |
235 | struct nlm_host * nlm_get_host(struct nlm_host *); | |
1da177e4 | 236 | void nlm_shutdown_hosts(void); |
7fefc9cb | 237 | void nlm_host_rebooted(const struct nlm_reboot *); |
1da177e4 | 238 | |
1e49323c CL |
239 | /* |
240 | * Host monitoring | |
241 | */ | |
242 | int nsm_monitor(const struct nlm_host *host); | |
356c3eb4 | 243 | void nsm_unmonitor(const struct nlm_host *host); |
1da177e4 | 244 | |
92fd91b9 CL |
245 | struct nsm_handle *nsm_get_handle(const struct sockaddr *sap, |
246 | const size_t salen, | |
67c6d107 | 247 | const char *hostname, |
92fd91b9 | 248 | const size_t hostname_len); |
3420a8c4 | 249 | struct nsm_handle *nsm_reboot_lookup(const struct nlm_reboot *info); |
67c6d107 CL |
250 | void nsm_release(struct nsm_handle *nsm); |
251 | ||
f2af793d OK |
252 | /* |
253 | * This is used in garbage collection and resource reclaim | |
254 | * A return value != 0 means destroy the lock/block/share | |
255 | */ | |
4373ea84 | 256 | typedef int (*nlm_host_match_fn_t)(void *cur, struct nlm_host *ref); |
f2af793d | 257 | |
1da177e4 LT |
258 | /* |
259 | * Server-side lock handling | |
260 | */ | |
52921e02 | 261 | __be32 nlmsvc_lock(struct svc_rqst *, struct nlm_file *, |
6cde4de8 | 262 | struct nlm_host *, struct nlm_lock *, int, |
b2b50289 | 263 | struct nlm_cookie *, int); |
52921e02 | 264 | __be32 nlmsvc_unlock(struct nlm_file *, struct nlm_lock *); |
85f3f1b3 | 265 | __be32 nlmsvc_testlock(struct svc_rqst *, struct nlm_file *, |
8f920d5e JL |
266 | struct nlm_host *, struct nlm_lock *, |
267 | struct nlm_lock *, struct nlm_cookie *); | |
52921e02 | 268 | __be32 nlmsvc_cancel_blocked(struct nlm_file *, struct nlm_lock *); |
1da177e4 | 269 | unsigned long nlmsvc_retry_blocked(void); |
f3ee439f | 270 | void nlmsvc_traverse_blocks(struct nlm_host *, struct nlm_file *, |
f2af793d | 271 | nlm_host_match_fn_t match); |
e8c5c045 | 272 | void nlmsvc_grant_reply(struct nlm_cookie *, __be32); |
7db836d4 | 273 | void nlmsvc_release_call(struct nlm_rqst *); |
1da177e4 LT |
274 | |
275 | /* | |
276 | * File handling for the server personality | |
277 | */ | |
52921e02 | 278 | __be32 nlm_lookup_file(struct svc_rqst *, struct nlm_file **, |
1da177e4 LT |
279 | struct nfs_fh *); |
280 | void nlm_release_file(struct nlm_file *); | |
281 | void nlmsvc_mark_resources(void); | |
282 | void nlmsvc_free_host_resources(struct nlm_host *); | |
283 | void nlmsvc_invalidate_all(void); | |
284 | ||
4373ea84 WC |
285 | /* |
286 | * Cluster failover support | |
287 | */ | |
17efa372 | 288 | int nlmsvc_unlock_all_by_sb(struct super_block *sb); |
367c8c7b | 289 | int nlmsvc_unlock_all_by_ip(struct sockaddr *server_addr); |
4373ea84 | 290 | |
f34ec991 | 291 | static inline struct inode *nlmsvc_file_inode(struct nlm_file *file) |
1da177e4 | 292 | { |
225a719f | 293 | return file->f_file->f_path.dentry->d_inode; |
1da177e4 LT |
294 | } |
295 | ||
b85e4676 CL |
296 | static inline int __nlm_privileged_request4(const struct sockaddr *sap) |
297 | { | |
298 | const struct sockaddr_in *sin = (struct sockaddr_in *)sap; | |
57ef6925 CL |
299 | |
300 | if (ntohs(sin->sin_port) > 1023) | |
301 | return 0; | |
302 | ||
303 | return ipv4_is_loopback(sin->sin_addr.s_addr); | |
b85e4676 CL |
304 | } |
305 | ||
dfd56b8b | 306 | #if IS_ENABLED(CONFIG_IPV6) |
b85e4676 CL |
307 | static inline int __nlm_privileged_request6(const struct sockaddr *sap) |
308 | { | |
309 | const struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap; | |
d1208f70 CL |
310 | |
311 | if (ntohs(sin6->sin6_port) > 1023) | |
312 | return 0; | |
313 | ||
314 | if (ipv6_addr_type(&sin6->sin6_addr) & IPV6_ADDR_MAPPED) | |
315 | return ipv4_is_loopback(sin6->sin6_addr.s6_addr32[3]); | |
316 | ||
317 | return ipv6_addr_type(&sin6->sin6_addr) & IPV6_ADDR_LOOPBACK; | |
b85e4676 | 318 | } |
dfd56b8b | 319 | #else /* IS_ENABLED(CONFIG_IPV6) */ |
b85e4676 CL |
320 | static inline int __nlm_privileged_request6(const struct sockaddr *sap) |
321 | { | |
322 | return 0; | |
323 | } | |
dfd56b8b | 324 | #endif /* IS_ENABLED(CONFIG_IPV6) */ |
b85e4676 CL |
325 | |
326 | /* | |
327 | * Ensure incoming requests are from local privileged callers. | |
328 | * | |
329 | * Return TRUE if sender is local and is connecting via a privileged port; | |
330 | * otherwise return FALSE. | |
331 | */ | |
332 | static inline int nlm_privileged_requester(const struct svc_rqst *rqstp) | |
333 | { | |
334 | const struct sockaddr *sap = svc_addr(rqstp); | |
335 | ||
336 | switch (sap->sa_family) { | |
337 | case AF_INET: | |
338 | return __nlm_privileged_request4(sap); | |
339 | case AF_INET6: | |
340 | return __nlm_privileged_request6(sap); | |
341 | default: | |
342 | return 0; | |
343 | } | |
344 | } | |
345 | ||
1da177e4 LT |
346 | /* |
347 | * Compare two NLM locks. | |
348 | * When the second lock is of type F_UNLCK, this acts like a wildcard. | |
349 | */ | |
f34ec991 CL |
350 | static inline int nlm_compare_locks(const struct file_lock *fl1, |
351 | const struct file_lock *fl2) | |
1da177e4 LT |
352 | { |
353 | return fl1->fl_pid == fl2->fl_pid | |
3134cbec | 354 | && fl1->fl_owner == fl2->fl_owner |
1da177e4 LT |
355 | && fl1->fl_start == fl2->fl_start |
356 | && fl1->fl_end == fl2->fl_end | |
357 | &&(fl1->fl_type == fl2->fl_type || fl2->fl_type == F_UNLCK); | |
358 | } | |
359 | ||
7b021967 | 360 | extern const struct lock_manager_operations nlmsvc_lock_operations; |
1da177e4 LT |
361 | |
362 | #endif /* __KERNEL__ */ | |
363 | ||
364 | #endif /* LINUX_LOCKD_LOCKD_H */ |