This source file includes following definitions.
- nlm_addr_in
- nlm_addr
- nlm_srcaddr_in
- nlm_srcaddr
- nlmsvc_file_inode
- __nlm_privileged_request4
- __nlm_privileged_request6
- __nlm_privileged_request6
- nlm_privileged_requester
- nlm_compare_locks
1
2
3
4
5
6
7
8
9
10 #ifndef LINUX_LOCKD_LOCKD_H
11 #define LINUX_LOCKD_LOCKD_H
12
13 #ifdef __KERNEL__
14
15 #include <linux/in.h>
16 #include <linux/in6.h>
17 #include <net/ipv6.h>
18 #include <linux/fs.h>
19 #include <linux/kref.h>
20 #include <linux/refcount.h>
21 #include <linux/utsname.h>
22 #include <linux/lockd/bind.h>
23 #include <linux/lockd/xdr.h>
24 #ifdef CONFIG_LOCKD_V4
25 #include <linux/lockd/xdr4.h>
26 #endif
27 #include <linux/lockd/debug.h>
28 #include <linux/sunrpc/svc.h>
29
30
31
32
33 #define LOCKD_VERSION "0.5"
34
35
36
37
38 #define LOCKD_DFLT_TIMEO 10
39
40
41
42
43 struct nlm_host {
44 struct hlist_node h_hash;
45 struct sockaddr_storage h_addr;
46 size_t h_addrlen;
47 struct sockaddr_storage h_srcaddr;
48 size_t h_srcaddrlen;
49 struct rpc_clnt *h_rpcclnt;
50 char *h_name;
51 u32 h_version;
52 unsigned short h_proto;
53 unsigned short h_reclaiming : 1,
54 h_server : 1,
55 h_noresvport : 1,
56 h_inuse : 1;
57 wait_queue_head_t h_gracewait;
58 struct rw_semaphore h_rwsem;
59 u32 h_state;
60 u32 h_nsmstate;
61 u32 h_pidcount;
62 refcount_t h_count;
63 struct mutex h_mutex;
64 unsigned long h_nextrebind;
65 unsigned long h_expires;
66 struct list_head h_lockowners;
67 spinlock_t h_lock;
68 struct list_head h_granted;
69 struct list_head h_reclaim;
70 struct nsm_handle *h_nsmhandle;
71 char *h_addrbuf;
72 struct net *net;
73 const struct cred *h_cred;
74 char nodename[UNX_MAXNODENAME + 1];
75 const struct nlmclnt_operations *h_nlmclnt_ops;
76 };
77
78
79
80
81
82
83
84 #define NSM_ADDRBUF ((8 * 4 + 7) + (1 + 10) + 1)
85
86 struct nsm_handle {
87 struct list_head sm_link;
88 refcount_t sm_count;
89 char *sm_mon_name;
90 char *sm_name;
91 struct sockaddr_storage sm_addr;
92 size_t sm_addrlen;
93 unsigned int sm_monitored : 1,
94 sm_sticky : 1;
95 struct nsm_private sm_priv;
96 char sm_addrbuf[NSM_ADDRBUF];
97 };
98
99
100
101
102 static inline struct sockaddr_in *nlm_addr_in(const struct nlm_host *host)
103 {
104 return (struct sockaddr_in *)&host->h_addr;
105 }
106
107 static inline struct sockaddr *nlm_addr(const struct nlm_host *host)
108 {
109 return (struct sockaddr *)&host->h_addr;
110 }
111
112 static inline struct sockaddr_in *nlm_srcaddr_in(const struct nlm_host *host)
113 {
114 return (struct sockaddr_in *)&host->h_srcaddr;
115 }
116
117 static inline struct sockaddr *nlm_srcaddr(const struct nlm_host *host)
118 {
119 return (struct sockaddr *)&host->h_srcaddr;
120 }
121
122
123
124
125 struct nlm_lockowner {
126 struct list_head list;
127 refcount_t count;
128
129 struct nlm_host *host;
130 fl_owner_t owner;
131 uint32_t pid;
132 };
133
134 struct nlm_wait;
135
136
137
138
139 #define NLMCLNT_OHSIZE ((__NEW_UTS_LEN) + 10u)
140 struct nlm_rqst {
141 refcount_t a_count;
142 unsigned int a_flags;
143 struct nlm_host * a_host;
144 struct nlm_args a_args;
145 struct nlm_res a_res;
146 struct nlm_block * a_block;
147 unsigned int a_retries;
148 u8 a_owner[NLMCLNT_OHSIZE];
149 void * a_callback_data;
150 };
151
152
153
154
155
156 struct nlm_file {
157 struct hlist_node f_list;
158 struct nfs_fh f_handle;
159 struct file * f_file;
160 struct nlm_share * f_shares;
161 struct list_head f_blocks;
162 unsigned int f_locks;
163 unsigned int f_count;
164 struct mutex f_mutex;
165 };
166
167
168
169
170
171 #define NLM_NEVER (~(unsigned long) 0)
172
173 #define NLM_TIMEOUT (7 * HZ)
174
175 struct nlm_block {
176 struct kref b_count;
177 struct list_head b_list;
178 struct list_head b_flist;
179 struct nlm_rqst * b_call;
180 struct svc_serv * b_daemon;
181 struct nlm_host * b_host;
182 unsigned long b_when;
183 unsigned int b_id;
184 unsigned char b_granted;
185 struct nlm_file * b_file;
186 struct cache_req * b_cache_req;
187 struct cache_deferred_req * b_deferred_req;
188 unsigned int b_flags;
189 #define B_QUEUED 1
190 #define B_GOT_CALLBACK 2
191 #define B_TIMED_OUT 4
192 };
193
194
195
196
197 extern const struct rpc_program nlm_program;
198 extern const struct svc_procedure nlmsvc_procedures[];
199 #ifdef CONFIG_LOCKD_V4
200 extern const struct svc_procedure nlmsvc_procedures4[];
201 #endif
202 extern int nlmsvc_grace_period;
203 extern unsigned long nlmsvc_timeout;
204 extern bool nsm_use_hostnames;
205 extern u32 nsm_local_state;
206
207
208
209
210 struct nlm_rqst * nlm_alloc_call(struct nlm_host *host);
211 int nlm_async_call(struct nlm_rqst *, u32, const struct rpc_call_ops *);
212 int nlm_async_reply(struct nlm_rqst *, u32, const struct rpc_call_ops *);
213 void nlmclnt_release_call(struct nlm_rqst *);
214 struct nlm_wait * nlmclnt_prepare_block(struct nlm_host *host, struct file_lock *fl);
215 void nlmclnt_finish_block(struct nlm_wait *block);
216 int nlmclnt_block(struct nlm_wait *block, struct nlm_rqst *req, long timeout);
217 __be32 nlmclnt_grant(const struct sockaddr *addr,
218 const struct nlm_lock *lock);
219 void nlmclnt_recovery(struct nlm_host *);
220 int nlmclnt_reclaim(struct nlm_host *, struct file_lock *,
221 struct nlm_rqst *);
222 void nlmclnt_next_cookie(struct nlm_cookie *);
223
224
225
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 net *net,
234 const struct cred *cred);
235 void nlmclnt_release_host(struct nlm_host *);
236 struct nlm_host *nlmsvc_lookup_host(const struct svc_rqst *rqstp,
237 const char *hostname,
238 const size_t hostname_len);
239 void nlmsvc_release_host(struct nlm_host *);
240 struct rpc_clnt * nlm_bind_host(struct nlm_host *);
241 void nlm_rebind_host(struct nlm_host *);
242 struct nlm_host * nlm_get_host(struct nlm_host *);
243 void nlm_shutdown_hosts(void);
244 void nlm_shutdown_hosts_net(struct net *net);
245 void nlm_host_rebooted(const struct net *net,
246 const struct nlm_reboot *);
247
248
249
250
251 int nsm_monitor(const struct nlm_host *host);
252 void nsm_unmonitor(const struct nlm_host *host);
253
254 struct nsm_handle *nsm_get_handle(const struct net *net,
255 const struct sockaddr *sap,
256 const size_t salen,
257 const char *hostname,
258 const size_t hostname_len);
259 struct nsm_handle *nsm_reboot_lookup(const struct net *net,
260 const struct nlm_reboot *info);
261 void nsm_release(struct nsm_handle *nsm);
262
263
264
265
266
267 typedef int (*nlm_host_match_fn_t)(void *cur, struct nlm_host *ref);
268
269
270
271
272 __be32 nlmsvc_lock(struct svc_rqst *, struct nlm_file *,
273 struct nlm_host *, struct nlm_lock *, int,
274 struct nlm_cookie *, int);
275 __be32 nlmsvc_unlock(struct net *net, struct nlm_file *, struct nlm_lock *);
276 __be32 nlmsvc_testlock(struct svc_rqst *, struct nlm_file *,
277 struct nlm_host *, struct nlm_lock *,
278 struct nlm_lock *, struct nlm_cookie *);
279 __be32 nlmsvc_cancel_blocked(struct net *net, struct nlm_file *, struct nlm_lock *);
280 unsigned long nlmsvc_retry_blocked(void);
281 void nlmsvc_traverse_blocks(struct nlm_host *, struct nlm_file *,
282 nlm_host_match_fn_t match);
283 void nlmsvc_grant_reply(struct nlm_cookie *, __be32);
284 void nlmsvc_release_call(struct nlm_rqst *);
285 void nlmsvc_locks_init_private(struct file_lock *, struct nlm_host *, pid_t);
286
287
288
289
290 __be32 nlm_lookup_file(struct svc_rqst *, struct nlm_file **,
291 struct nfs_fh *);
292 void nlm_release_file(struct nlm_file *);
293 void nlmsvc_release_lockowner(struct nlm_lock *);
294 void nlmsvc_mark_resources(struct net *);
295 void nlmsvc_free_host_resources(struct nlm_host *);
296 void nlmsvc_invalidate_all(void);
297
298
299
300
301 int nlmsvc_unlock_all_by_sb(struct super_block *sb);
302 int nlmsvc_unlock_all_by_ip(struct sockaddr *server_addr);
303
304 static inline struct inode *nlmsvc_file_inode(struct nlm_file *file)
305 {
306 return locks_inode(file->f_file);
307 }
308
309 static inline int __nlm_privileged_request4(const struct sockaddr *sap)
310 {
311 const struct sockaddr_in *sin = (struct sockaddr_in *)sap;
312
313 if (ntohs(sin->sin_port) > 1023)
314 return 0;
315
316 return ipv4_is_loopback(sin->sin_addr.s_addr);
317 }
318
319 #if IS_ENABLED(CONFIG_IPV6)
320 static inline int __nlm_privileged_request6(const struct sockaddr *sap)
321 {
322 const struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap;
323
324 if (ntohs(sin6->sin6_port) > 1023)
325 return 0;
326
327 if (ipv6_addr_type(&sin6->sin6_addr) & IPV6_ADDR_MAPPED)
328 return ipv4_is_loopback(sin6->sin6_addr.s6_addr32[3]);
329
330 return ipv6_addr_type(&sin6->sin6_addr) & IPV6_ADDR_LOOPBACK;
331 }
332 #else
333 static inline int __nlm_privileged_request6(const struct sockaddr *sap)
334 {
335 return 0;
336 }
337 #endif
338
339
340
341
342
343
344
345 static inline int nlm_privileged_requester(const struct svc_rqst *rqstp)
346 {
347 const struct sockaddr *sap = svc_addr(rqstp);
348
349 switch (sap->sa_family) {
350 case AF_INET:
351 return __nlm_privileged_request4(sap);
352 case AF_INET6:
353 return __nlm_privileged_request6(sap);
354 default:
355 return 0;
356 }
357 }
358
359
360
361
362
363 static inline int nlm_compare_locks(const struct file_lock *fl1,
364 const struct file_lock *fl2)
365 {
366 return locks_inode(fl1->fl_file) == locks_inode(fl2->fl_file)
367 && fl1->fl_pid == fl2->fl_pid
368 && fl1->fl_owner == fl2->fl_owner
369 && fl1->fl_start == fl2->fl_start
370 && fl1->fl_end == fl2->fl_end
371 &&(fl1->fl_type == fl2->fl_type || fl2->fl_type == F_UNLCK);
372 }
373
374 extern const struct lock_manager_operations nlmsvc_lock_operations;
375
376 #endif
377
378 #endif