Loading...
1/*
2 * linux/fs/lockd/svc.c
3 *
4 * This is the central lockd service.
5 *
6 * FIXME: Separate the lockd NFS server functionality from the lockd NFS
7 * client functionality. Oh why didn't Sun create two separate
8 * services in the first place?
9 *
10 * Authors: Olaf Kirch (okir@monad.swb.de)
11 *
12 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
13 */
14
15#include <linux/module.h>
16#include <linux/init.h>
17#include <linux/sysctl.h>
18#include <linux/moduleparam.h>
19
20#include <linux/sched.h>
21#include <linux/errno.h>
22#include <linux/in.h>
23#include <linux/uio.h>
24#include <linux/smp.h>
25#include <linux/mutex.h>
26#include <linux/kthread.h>
27#include <linux/freezer.h>
28
29#include <linux/sunrpc/types.h>
30#include <linux/sunrpc/stats.h>
31#include <linux/sunrpc/clnt.h>
32#include <linux/sunrpc/svc.h>
33#include <linux/sunrpc/svcsock.h>
34#include <net/ip.h>
35#include <linux/lockd/lockd.h>
36#include <linux/nfs.h>
37
38#define NLMDBG_FACILITY NLMDBG_SVC
39#define LOCKD_BUFSIZE (1024 + NLMSVC_XDRSIZE)
40#define ALLOWED_SIGS (sigmask(SIGKILL))
41
42static struct svc_program nlmsvc_program;
43
44struct nlmsvc_binding * nlmsvc_ops;
45EXPORT_SYMBOL_GPL(nlmsvc_ops);
46
47static DEFINE_MUTEX(nlmsvc_mutex);
48static unsigned int nlmsvc_users;
49static struct task_struct *nlmsvc_task;
50static struct svc_rqst *nlmsvc_rqst;
51unsigned long nlmsvc_timeout;
52
53/*
54 * These can be set at insmod time (useful for NFS as root filesystem),
55 * and also changed through the sysctl interface. -- Jamie Lokier, Aug 2003
56 */
57static unsigned long nlm_grace_period;
58static unsigned long nlm_timeout = LOCKD_DFLT_TIMEO;
59static int nlm_udpport, nlm_tcpport;
60
61/* RLIM_NOFILE defaults to 1024. That seems like a reasonable default here. */
62static unsigned int nlm_max_connections = 1024;
63
64/*
65 * Constants needed for the sysctl interface.
66 */
67static const unsigned long nlm_grace_period_min = 0;
68static const unsigned long nlm_grace_period_max = 240;
69static const unsigned long nlm_timeout_min = 3;
70static const unsigned long nlm_timeout_max = 20;
71static const int nlm_port_min = 0, nlm_port_max = 65535;
72
73#ifdef CONFIG_SYSCTL
74static struct ctl_table_header * nlm_sysctl_table;
75#endif
76
77static unsigned long get_lockd_grace_period(void)
78{
79 /* Note: nlm_timeout should always be nonzero */
80 if (nlm_grace_period)
81 return roundup(nlm_grace_period, nlm_timeout) * HZ;
82 else
83 return nlm_timeout * 5 * HZ;
84}
85
86static struct lock_manager lockd_manager = {
87};
88
89static void grace_ender(struct work_struct *not_used)
90{
91 locks_end_grace(&lockd_manager);
92}
93
94static DECLARE_DELAYED_WORK(grace_period_end, grace_ender);
95
96static void set_grace_period(void)
97{
98 unsigned long grace_period = get_lockd_grace_period();
99
100 locks_start_grace(&lockd_manager);
101 cancel_delayed_work_sync(&grace_period_end);
102 schedule_delayed_work(&grace_period_end, grace_period);
103}
104
105static void restart_grace(void)
106{
107 if (nlmsvc_ops) {
108 cancel_delayed_work_sync(&grace_period_end);
109 locks_end_grace(&lockd_manager);
110 nlmsvc_invalidate_all();
111 set_grace_period();
112 }
113}
114
115/*
116 * This is the lockd kernel thread
117 */
118static int
119lockd(void *vrqstp)
120{
121 int err = 0, preverr = 0;
122 struct svc_rqst *rqstp = vrqstp;
123
124 /* try_to_freeze() is called from svc_recv() */
125 set_freezable();
126
127 /* Allow SIGKILL to tell lockd to drop all of its locks */
128 allow_signal(SIGKILL);
129
130 dprintk("NFS locking service started (ver " LOCKD_VERSION ").\n");
131
132 if (!nlm_timeout)
133 nlm_timeout = LOCKD_DFLT_TIMEO;
134 nlmsvc_timeout = nlm_timeout * HZ;
135
136 set_grace_period();
137
138 /*
139 * The main request loop. We don't terminate until the last
140 * NFS mount or NFS daemon has gone away.
141 */
142 while (!kthread_should_stop()) {
143 long timeout = MAX_SCHEDULE_TIMEOUT;
144 RPC_IFDEBUG(char buf[RPC_MAX_ADDRBUFLEN]);
145
146 /* update sv_maxconn if it has changed */
147 rqstp->rq_server->sv_maxconn = nlm_max_connections;
148
149 if (signalled()) {
150 flush_signals(current);
151 restart_grace();
152 continue;
153 }
154
155 timeout = nlmsvc_retry_blocked();
156
157 /*
158 * Find a socket with data available and call its
159 * recvfrom routine.
160 */
161 err = svc_recv(rqstp, timeout);
162 if (err == -EAGAIN || err == -EINTR) {
163 preverr = err;
164 continue;
165 }
166 if (err < 0) {
167 if (err != preverr) {
168 printk(KERN_WARNING "%s: unexpected error "
169 "from svc_recv (%d)\n", __func__, err);
170 preverr = err;
171 }
172 schedule_timeout_interruptible(HZ);
173 continue;
174 }
175 preverr = err;
176
177 dprintk("lockd: request from %s\n",
178 svc_print_addr(rqstp, buf, sizeof(buf)));
179
180 svc_process(rqstp);
181 }
182 flush_signals(current);
183 cancel_delayed_work_sync(&grace_period_end);
184 locks_end_grace(&lockd_manager);
185 if (nlmsvc_ops)
186 nlmsvc_invalidate_all();
187 nlm_shutdown_hosts();
188 return 0;
189}
190
191static int create_lockd_listener(struct svc_serv *serv, const char *name,
192 const int family, const unsigned short port)
193{
194 struct svc_xprt *xprt;
195
196 xprt = svc_find_xprt(serv, name, family, 0);
197 if (xprt == NULL)
198 return svc_create_xprt(serv, name, &init_net, family, port,
199 SVC_SOCK_DEFAULTS);
200 svc_xprt_put(xprt);
201 return 0;
202}
203
204static int create_lockd_family(struct svc_serv *serv, const int family)
205{
206 int err;
207
208 err = create_lockd_listener(serv, "udp", family, nlm_udpport);
209 if (err < 0)
210 return err;
211
212 return create_lockd_listener(serv, "tcp", family, nlm_tcpport);
213}
214
215/*
216 * Ensure there are active UDP and TCP listeners for lockd.
217 *
218 * Even if we have only TCP NFS mounts and/or TCP NFSDs, some
219 * local services (such as rpc.statd) still require UDP, and
220 * some NFS servers do not yet support NLM over TCP.
221 *
222 * Returns zero if all listeners are available; otherwise a
223 * negative errno value is returned.
224 */
225static int make_socks(struct svc_serv *serv)
226{
227 static int warned;
228 int err;
229
230 err = create_lockd_family(serv, PF_INET);
231 if (err < 0)
232 goto out_err;
233
234 err = create_lockd_family(serv, PF_INET6);
235 if (err < 0 && err != -EAFNOSUPPORT)
236 goto out_err;
237
238 warned = 0;
239 return 0;
240
241out_err:
242 if (warned++ == 0)
243 printk(KERN_WARNING
244 "lockd_up: makesock failed, error=%d\n", err);
245 return err;
246}
247
248/*
249 * Bring up the lockd process if it's not already up.
250 */
251int lockd_up(void)
252{
253 struct svc_serv *serv;
254 int error = 0;
255
256 mutex_lock(&nlmsvc_mutex);
257 /*
258 * Check whether we're already up and running.
259 */
260 if (nlmsvc_rqst)
261 goto out;
262
263 /*
264 * Sanity check: if there's no pid,
265 * we should be the first user ...
266 */
267 if (nlmsvc_users)
268 printk(KERN_WARNING
269 "lockd_up: no pid, %d users??\n", nlmsvc_users);
270
271 error = -ENOMEM;
272 serv = svc_create(&nlmsvc_program, LOCKD_BUFSIZE, NULL);
273 if (!serv) {
274 printk(KERN_WARNING "lockd_up: create service failed\n");
275 goto out;
276 }
277
278 error = make_socks(serv);
279 if (error < 0)
280 goto destroy_and_out;
281
282 /*
283 * Create the kernel thread and wait for it to start.
284 */
285 nlmsvc_rqst = svc_prepare_thread(serv, &serv->sv_pools[0]);
286 if (IS_ERR(nlmsvc_rqst)) {
287 error = PTR_ERR(nlmsvc_rqst);
288 nlmsvc_rqst = NULL;
289 printk(KERN_WARNING
290 "lockd_up: svc_rqst allocation failed, error=%d\n",
291 error);
292 goto destroy_and_out;
293 }
294
295 svc_sock_update_bufs(serv);
296 serv->sv_maxconn = nlm_max_connections;
297
298 nlmsvc_task = kthread_run(lockd, nlmsvc_rqst, serv->sv_name);
299 if (IS_ERR(nlmsvc_task)) {
300 error = PTR_ERR(nlmsvc_task);
301 svc_exit_thread(nlmsvc_rqst);
302 nlmsvc_task = NULL;
303 nlmsvc_rqst = NULL;
304 printk(KERN_WARNING
305 "lockd_up: kthread_run failed, error=%d\n", error);
306 goto destroy_and_out;
307 }
308
309 /*
310 * Note: svc_serv structures have an initial use count of 1,
311 * so we exit through here on both success and failure.
312 */
313destroy_and_out:
314 svc_destroy(serv);
315out:
316 if (!error)
317 nlmsvc_users++;
318 mutex_unlock(&nlmsvc_mutex);
319 return error;
320}
321EXPORT_SYMBOL_GPL(lockd_up);
322
323/*
324 * Decrement the user count and bring down lockd if we're the last.
325 */
326void
327lockd_down(void)
328{
329 mutex_lock(&nlmsvc_mutex);
330 if (nlmsvc_users) {
331 if (--nlmsvc_users)
332 goto out;
333 } else {
334 printk(KERN_ERR "lockd_down: no users! task=%p\n",
335 nlmsvc_task);
336 BUG();
337 }
338
339 if (!nlmsvc_task) {
340 printk(KERN_ERR "lockd_down: no lockd running.\n");
341 BUG();
342 }
343 kthread_stop(nlmsvc_task);
344 svc_exit_thread(nlmsvc_rqst);
345 nlmsvc_task = NULL;
346 nlmsvc_rqst = NULL;
347out:
348 mutex_unlock(&nlmsvc_mutex);
349}
350EXPORT_SYMBOL_GPL(lockd_down);
351
352#ifdef CONFIG_SYSCTL
353
354/*
355 * Sysctl parameters (same as module parameters, different interface).
356 */
357
358static ctl_table nlm_sysctls[] = {
359 {
360 .procname = "nlm_grace_period",
361 .data = &nlm_grace_period,
362 .maxlen = sizeof(unsigned long),
363 .mode = 0644,
364 .proc_handler = proc_doulongvec_minmax,
365 .extra1 = (unsigned long *) &nlm_grace_period_min,
366 .extra2 = (unsigned long *) &nlm_grace_period_max,
367 },
368 {
369 .procname = "nlm_timeout",
370 .data = &nlm_timeout,
371 .maxlen = sizeof(unsigned long),
372 .mode = 0644,
373 .proc_handler = proc_doulongvec_minmax,
374 .extra1 = (unsigned long *) &nlm_timeout_min,
375 .extra2 = (unsigned long *) &nlm_timeout_max,
376 },
377 {
378 .procname = "nlm_udpport",
379 .data = &nlm_udpport,
380 .maxlen = sizeof(int),
381 .mode = 0644,
382 .proc_handler = proc_dointvec_minmax,
383 .extra1 = (int *) &nlm_port_min,
384 .extra2 = (int *) &nlm_port_max,
385 },
386 {
387 .procname = "nlm_tcpport",
388 .data = &nlm_tcpport,
389 .maxlen = sizeof(int),
390 .mode = 0644,
391 .proc_handler = proc_dointvec_minmax,
392 .extra1 = (int *) &nlm_port_min,
393 .extra2 = (int *) &nlm_port_max,
394 },
395 {
396 .procname = "nsm_use_hostnames",
397 .data = &nsm_use_hostnames,
398 .maxlen = sizeof(int),
399 .mode = 0644,
400 .proc_handler = proc_dointvec,
401 },
402 {
403 .procname = "nsm_local_state",
404 .data = &nsm_local_state,
405 .maxlen = sizeof(int),
406 .mode = 0644,
407 .proc_handler = proc_dointvec,
408 },
409 { }
410};
411
412static ctl_table nlm_sysctl_dir[] = {
413 {
414 .procname = "nfs",
415 .mode = 0555,
416 .child = nlm_sysctls,
417 },
418 { }
419};
420
421static ctl_table nlm_sysctl_root[] = {
422 {
423 .procname = "fs",
424 .mode = 0555,
425 .child = nlm_sysctl_dir,
426 },
427 { }
428};
429
430#endif /* CONFIG_SYSCTL */
431
432/*
433 * Module (and sysfs) parameters.
434 */
435
436#define param_set_min_max(name, type, which_strtol, min, max) \
437static int param_set_##name(const char *val, struct kernel_param *kp) \
438{ \
439 char *endp; \
440 __typeof__(type) num = which_strtol(val, &endp, 0); \
441 if (endp == val || *endp || num < (min) || num > (max)) \
442 return -EINVAL; \
443 *((int *) kp->arg) = num; \
444 return 0; \
445}
446
447static inline int is_callback(u32 proc)
448{
449 return proc == NLMPROC_GRANTED
450 || proc == NLMPROC_GRANTED_MSG
451 || proc == NLMPROC_TEST_RES
452 || proc == NLMPROC_LOCK_RES
453 || proc == NLMPROC_CANCEL_RES
454 || proc == NLMPROC_UNLOCK_RES
455 || proc == NLMPROC_NSM_NOTIFY;
456}
457
458
459static int lockd_authenticate(struct svc_rqst *rqstp)
460{
461 rqstp->rq_client = NULL;
462 switch (rqstp->rq_authop->flavour) {
463 case RPC_AUTH_NULL:
464 case RPC_AUTH_UNIX:
465 if (rqstp->rq_proc == 0)
466 return SVC_OK;
467 if (is_callback(rqstp->rq_proc)) {
468 /* Leave it to individual procedures to
469 * call nlmsvc_lookup_host(rqstp)
470 */
471 return SVC_OK;
472 }
473 return svc_set_client(rqstp);
474 }
475 return SVC_DENIED;
476}
477
478
479param_set_min_max(port, int, simple_strtol, 0, 65535)
480param_set_min_max(grace_period, unsigned long, simple_strtoul,
481 nlm_grace_period_min, nlm_grace_period_max)
482param_set_min_max(timeout, unsigned long, simple_strtoul,
483 nlm_timeout_min, nlm_timeout_max)
484
485MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
486MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION ".");
487MODULE_LICENSE("GPL");
488
489module_param_call(nlm_grace_period, param_set_grace_period, param_get_ulong,
490 &nlm_grace_period, 0644);
491module_param_call(nlm_timeout, param_set_timeout, param_get_ulong,
492 &nlm_timeout, 0644);
493module_param_call(nlm_udpport, param_set_port, param_get_int,
494 &nlm_udpport, 0644);
495module_param_call(nlm_tcpport, param_set_port, param_get_int,
496 &nlm_tcpport, 0644);
497module_param(nsm_use_hostnames, bool, 0644);
498module_param(nlm_max_connections, uint, 0644);
499
500/*
501 * Initialising and terminating the module.
502 */
503
504static int __init init_nlm(void)
505{
506#ifdef CONFIG_SYSCTL
507 nlm_sysctl_table = register_sysctl_table(nlm_sysctl_root);
508 return nlm_sysctl_table ? 0 : -ENOMEM;
509#else
510 return 0;
511#endif
512}
513
514static void __exit exit_nlm(void)
515{
516 /* FIXME: delete all NLM clients */
517 nlm_shutdown_hosts();
518#ifdef CONFIG_SYSCTL
519 unregister_sysctl_table(nlm_sysctl_table);
520#endif
521}
522
523module_init(init_nlm);
524module_exit(exit_nlm);
525
526/*
527 * Define NLM program and procedures
528 */
529static struct svc_version nlmsvc_version1 = {
530 .vs_vers = 1,
531 .vs_nproc = 17,
532 .vs_proc = nlmsvc_procedures,
533 .vs_xdrsize = NLMSVC_XDRSIZE,
534};
535static struct svc_version nlmsvc_version3 = {
536 .vs_vers = 3,
537 .vs_nproc = 24,
538 .vs_proc = nlmsvc_procedures,
539 .vs_xdrsize = NLMSVC_XDRSIZE,
540};
541#ifdef CONFIG_LOCKD_V4
542static struct svc_version nlmsvc_version4 = {
543 .vs_vers = 4,
544 .vs_nproc = 24,
545 .vs_proc = nlmsvc_procedures4,
546 .vs_xdrsize = NLMSVC_XDRSIZE,
547};
548#endif
549static struct svc_version * nlmsvc_version[] = {
550 [1] = &nlmsvc_version1,
551 [3] = &nlmsvc_version3,
552#ifdef CONFIG_LOCKD_V4
553 [4] = &nlmsvc_version4,
554#endif
555};
556
557static struct svc_stat nlmsvc_stats;
558
559#define NLM_NRVERS ARRAY_SIZE(nlmsvc_version)
560static struct svc_program nlmsvc_program = {
561 .pg_prog = NLM_PROGRAM, /* program number */
562 .pg_nvers = NLM_NRVERS, /* number of entries in nlmsvc_version */
563 .pg_vers = nlmsvc_version, /* version table */
564 .pg_name = "lockd", /* service name */
565 .pg_class = "nfsd", /* share authentication with nfsd */
566 .pg_stats = &nlmsvc_stats, /* stats table */
567 .pg_authenticate = &lockd_authenticate /* export authentication */
568};
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * linux/fs/lockd/svc.c
4 *
5 * This is the central lockd service.
6 *
7 * FIXME: Separate the lockd NFS server functionality from the lockd NFS
8 * client functionality. Oh why didn't Sun create two separate
9 * services in the first place?
10 *
11 * Authors: Olaf Kirch (okir@monad.swb.de)
12 *
13 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
14 */
15
16#include <linux/module.h>
17#include <linux/init.h>
18#include <linux/sysctl.h>
19#include <linux/moduleparam.h>
20
21#include <linux/sched/signal.h>
22#include <linux/errno.h>
23#include <linux/in.h>
24#include <linux/uio.h>
25#include <linux/smp.h>
26#include <linux/mutex.h>
27#include <linux/freezer.h>
28#include <linux/inetdevice.h>
29
30#include <linux/sunrpc/types.h>
31#include <linux/sunrpc/stats.h>
32#include <linux/sunrpc/clnt.h>
33#include <linux/sunrpc/svc.h>
34#include <linux/sunrpc/svcsock.h>
35#include <linux/sunrpc/svc_xprt.h>
36#include <net/ip.h>
37#include <net/addrconf.h>
38#include <net/ipv6.h>
39#include <linux/lockd/lockd.h>
40#include <linux/nfs.h>
41
42#include "netns.h"
43#include "procfs.h"
44
45#define NLMDBG_FACILITY NLMDBG_SVC
46#define LOCKD_BUFSIZE (1024 + NLMSVC_XDRSIZE)
47
48static struct svc_program nlmsvc_program;
49
50const struct nlmsvc_binding *nlmsvc_ops;
51EXPORT_SYMBOL_GPL(nlmsvc_ops);
52
53static DEFINE_MUTEX(nlmsvc_mutex);
54static unsigned int nlmsvc_users;
55static struct svc_serv *nlmsvc_serv;
56unsigned long nlmsvc_timeout;
57
58static void nlmsvc_request_retry(struct timer_list *tl)
59{
60 svc_wake_up(nlmsvc_serv);
61}
62DEFINE_TIMER(nlmsvc_retry, nlmsvc_request_retry);
63
64unsigned int lockd_net_id;
65
66/*
67 * These can be set at insmod time (useful for NFS as root filesystem),
68 * and also changed through the sysctl interface. -- Jamie Lokier, Aug 2003
69 */
70static unsigned long nlm_grace_period;
71static unsigned long nlm_timeout = LOCKD_DFLT_TIMEO;
72static int nlm_udpport, nlm_tcpport;
73
74/* RLIM_NOFILE defaults to 1024. That seems like a reasonable default here. */
75static unsigned int nlm_max_connections = 1024;
76
77/*
78 * Constants needed for the sysctl interface.
79 */
80static const unsigned long nlm_grace_period_min = 0;
81static const unsigned long nlm_grace_period_max = 240;
82static const unsigned long nlm_timeout_min = 3;
83static const unsigned long nlm_timeout_max = 20;
84
85#ifdef CONFIG_SYSCTL
86static const int nlm_port_min = 0, nlm_port_max = 65535;
87static struct ctl_table_header * nlm_sysctl_table;
88#endif
89
90static unsigned long get_lockd_grace_period(void)
91{
92 /* Note: nlm_timeout should always be nonzero */
93 if (nlm_grace_period)
94 return roundup(nlm_grace_period, nlm_timeout) * HZ;
95 else
96 return nlm_timeout * 5 * HZ;
97}
98
99static void grace_ender(struct work_struct *grace)
100{
101 struct delayed_work *dwork = to_delayed_work(grace);
102 struct lockd_net *ln = container_of(dwork, struct lockd_net,
103 grace_period_end);
104
105 locks_end_grace(&ln->lockd_manager);
106}
107
108static void set_grace_period(struct net *net)
109{
110 unsigned long grace_period = get_lockd_grace_period();
111 struct lockd_net *ln = net_generic(net, lockd_net_id);
112
113 locks_start_grace(net, &ln->lockd_manager);
114 cancel_delayed_work_sync(&ln->grace_period_end);
115 schedule_delayed_work(&ln->grace_period_end, grace_period);
116}
117
118/*
119 * This is the lockd kernel thread
120 */
121static int
122lockd(void *vrqstp)
123{
124 struct svc_rqst *rqstp = vrqstp;
125 struct net *net = &init_net;
126 struct lockd_net *ln = net_generic(net, lockd_net_id);
127
128 /* try_to_freeze() is called from svc_recv() */
129 set_freezable();
130
131 dprintk("NFS locking service started (ver " LOCKD_VERSION ").\n");
132
133 /*
134 * The main request loop. We don't terminate until the last
135 * NFS mount or NFS daemon has gone away.
136 */
137 while (!svc_thread_should_stop(rqstp)) {
138 /* update sv_maxconn if it has changed */
139 rqstp->rq_server->sv_maxconn = nlm_max_connections;
140
141 nlmsvc_retry_blocked(rqstp);
142 svc_recv(rqstp);
143 }
144 if (nlmsvc_ops)
145 nlmsvc_invalidate_all();
146 nlm_shutdown_hosts();
147 cancel_delayed_work_sync(&ln->grace_period_end);
148 locks_end_grace(&ln->lockd_manager);
149
150 dprintk("lockd_down: service stopped\n");
151
152 svc_exit_thread(rqstp);
153 return 0;
154}
155
156static int create_lockd_listener(struct svc_serv *serv, const char *name,
157 struct net *net, const int family,
158 const unsigned short port,
159 const struct cred *cred)
160{
161 struct svc_xprt *xprt;
162
163 xprt = svc_find_xprt(serv, name, net, family, 0);
164 if (xprt == NULL)
165 return svc_xprt_create(serv, name, net, family, port,
166 SVC_SOCK_DEFAULTS, cred);
167 svc_xprt_put(xprt);
168 return 0;
169}
170
171static int create_lockd_family(struct svc_serv *serv, struct net *net,
172 const int family, const struct cred *cred)
173{
174 int err;
175
176 err = create_lockd_listener(serv, "udp", net, family, nlm_udpport,
177 cred);
178 if (err < 0)
179 return err;
180
181 return create_lockd_listener(serv, "tcp", net, family, nlm_tcpport,
182 cred);
183}
184
185/*
186 * Ensure there are active UDP and TCP listeners for lockd.
187 *
188 * Even if we have only TCP NFS mounts and/or TCP NFSDs, some
189 * local services (such as rpc.statd) still require UDP, and
190 * some NFS servers do not yet support NLM over TCP.
191 *
192 * Returns zero if all listeners are available; otherwise a
193 * negative errno value is returned.
194 */
195static int make_socks(struct svc_serv *serv, struct net *net,
196 const struct cred *cred)
197{
198 static int warned;
199 int err;
200
201 err = create_lockd_family(serv, net, PF_INET, cred);
202 if (err < 0)
203 goto out_err;
204
205 err = create_lockd_family(serv, net, PF_INET6, cred);
206 if (err < 0 && err != -EAFNOSUPPORT)
207 goto out_err;
208
209 warned = 0;
210 return 0;
211
212out_err:
213 if (warned++ == 0)
214 printk(KERN_WARNING
215 "lockd_up: makesock failed, error=%d\n", err);
216 svc_xprt_destroy_all(serv, net);
217 svc_rpcb_cleanup(serv, net);
218 return err;
219}
220
221static int lockd_up_net(struct svc_serv *serv, struct net *net,
222 const struct cred *cred)
223{
224 struct lockd_net *ln = net_generic(net, lockd_net_id);
225 int error;
226
227 if (ln->nlmsvc_users++)
228 return 0;
229
230 error = svc_bind(serv, net);
231 if (error)
232 goto err_bind;
233
234 error = make_socks(serv, net, cred);
235 if (error < 0)
236 goto err_bind;
237 set_grace_period(net);
238 dprintk("%s: per-net data created; net=%x\n", __func__, net->ns.inum);
239 return 0;
240
241err_bind:
242 ln->nlmsvc_users--;
243 return error;
244}
245
246static void lockd_down_net(struct svc_serv *serv, struct net *net)
247{
248 struct lockd_net *ln = net_generic(net, lockd_net_id);
249
250 if (ln->nlmsvc_users) {
251 if (--ln->nlmsvc_users == 0) {
252 nlm_shutdown_hosts_net(net);
253 cancel_delayed_work_sync(&ln->grace_period_end);
254 locks_end_grace(&ln->lockd_manager);
255 svc_xprt_destroy_all(serv, net);
256 svc_rpcb_cleanup(serv, net);
257 }
258 } else {
259 pr_err("%s: no users! net=%x\n",
260 __func__, net->ns.inum);
261 BUG();
262 }
263}
264
265static int lockd_inetaddr_event(struct notifier_block *this,
266 unsigned long event, void *ptr)
267{
268 struct in_ifaddr *ifa = (struct in_ifaddr *)ptr;
269 struct sockaddr_in sin;
270
271 if (event != NETDEV_DOWN)
272 goto out;
273
274 if (nlmsvc_serv) {
275 dprintk("lockd_inetaddr_event: removed %pI4\n",
276 &ifa->ifa_local);
277 sin.sin_family = AF_INET;
278 sin.sin_addr.s_addr = ifa->ifa_local;
279 svc_age_temp_xprts_now(nlmsvc_serv, (struct sockaddr *)&sin);
280 }
281
282out:
283 return NOTIFY_DONE;
284}
285
286static struct notifier_block lockd_inetaddr_notifier = {
287 .notifier_call = lockd_inetaddr_event,
288};
289
290#if IS_ENABLED(CONFIG_IPV6)
291static int lockd_inet6addr_event(struct notifier_block *this,
292 unsigned long event, void *ptr)
293{
294 struct inet6_ifaddr *ifa = (struct inet6_ifaddr *)ptr;
295 struct sockaddr_in6 sin6;
296
297 if (event != NETDEV_DOWN)
298 goto out;
299
300 if (nlmsvc_serv) {
301 dprintk("lockd_inet6addr_event: removed %pI6\n", &ifa->addr);
302 sin6.sin6_family = AF_INET6;
303 sin6.sin6_addr = ifa->addr;
304 if (ipv6_addr_type(&sin6.sin6_addr) & IPV6_ADDR_LINKLOCAL)
305 sin6.sin6_scope_id = ifa->idev->dev->ifindex;
306 svc_age_temp_xprts_now(nlmsvc_serv, (struct sockaddr *)&sin6);
307 }
308
309out:
310 return NOTIFY_DONE;
311}
312
313static struct notifier_block lockd_inet6addr_notifier = {
314 .notifier_call = lockd_inet6addr_event,
315};
316#endif
317
318static int lockd_get(void)
319{
320 struct svc_serv *serv;
321 int error;
322
323 if (nlmsvc_serv) {
324 nlmsvc_users++;
325 return 0;
326 }
327
328 /*
329 * Sanity check: if there's no pid,
330 * we should be the first user ...
331 */
332 if (nlmsvc_users)
333 printk(KERN_WARNING
334 "lockd_up: no pid, %d users??\n", nlmsvc_users);
335
336 if (!nlm_timeout)
337 nlm_timeout = LOCKD_DFLT_TIMEO;
338 nlmsvc_timeout = nlm_timeout * HZ;
339
340 serv = svc_create(&nlmsvc_program, LOCKD_BUFSIZE, lockd);
341 if (!serv) {
342 printk(KERN_WARNING "lockd_up: create service failed\n");
343 return -ENOMEM;
344 }
345
346 serv->sv_maxconn = nlm_max_connections;
347 error = svc_set_num_threads(serv, NULL, 1);
348 if (error < 0) {
349 svc_destroy(&serv);
350 return error;
351 }
352
353 nlmsvc_serv = serv;
354 register_inetaddr_notifier(&lockd_inetaddr_notifier);
355#if IS_ENABLED(CONFIG_IPV6)
356 register_inet6addr_notifier(&lockd_inet6addr_notifier);
357#endif
358 dprintk("lockd_up: service created\n");
359 nlmsvc_users++;
360 return 0;
361}
362
363static void lockd_put(void)
364{
365 if (WARN(nlmsvc_users <= 0, "lockd_down: no users!\n"))
366 return;
367 if (--nlmsvc_users)
368 return;
369
370 unregister_inetaddr_notifier(&lockd_inetaddr_notifier);
371#if IS_ENABLED(CONFIG_IPV6)
372 unregister_inet6addr_notifier(&lockd_inet6addr_notifier);
373#endif
374
375 svc_set_num_threads(nlmsvc_serv, NULL, 0);
376 timer_delete_sync(&nlmsvc_retry);
377 svc_destroy(&nlmsvc_serv);
378 dprintk("lockd_down: service destroyed\n");
379}
380
381/*
382 * Bring up the lockd process if it's not already up.
383 */
384int lockd_up(struct net *net, const struct cred *cred)
385{
386 int error;
387
388 mutex_lock(&nlmsvc_mutex);
389
390 error = lockd_get();
391 if (error)
392 goto err;
393
394 error = lockd_up_net(nlmsvc_serv, net, cred);
395 if (error < 0) {
396 lockd_put();
397 goto err;
398 }
399
400err:
401 mutex_unlock(&nlmsvc_mutex);
402 return error;
403}
404EXPORT_SYMBOL_GPL(lockd_up);
405
406/*
407 * Decrement the user count and bring down lockd if we're the last.
408 */
409void
410lockd_down(struct net *net)
411{
412 mutex_lock(&nlmsvc_mutex);
413 lockd_down_net(nlmsvc_serv, net);
414 lockd_put();
415 mutex_unlock(&nlmsvc_mutex);
416}
417EXPORT_SYMBOL_GPL(lockd_down);
418
419#ifdef CONFIG_SYSCTL
420
421/*
422 * Sysctl parameters (same as module parameters, different interface).
423 */
424
425static struct ctl_table nlm_sysctls[] = {
426 {
427 .procname = "nlm_grace_period",
428 .data = &nlm_grace_period,
429 .maxlen = sizeof(unsigned long),
430 .mode = 0644,
431 .proc_handler = proc_doulongvec_minmax,
432 .extra1 = (unsigned long *) &nlm_grace_period_min,
433 .extra2 = (unsigned long *) &nlm_grace_period_max,
434 },
435 {
436 .procname = "nlm_timeout",
437 .data = &nlm_timeout,
438 .maxlen = sizeof(unsigned long),
439 .mode = 0644,
440 .proc_handler = proc_doulongvec_minmax,
441 .extra1 = (unsigned long *) &nlm_timeout_min,
442 .extra2 = (unsigned long *) &nlm_timeout_max,
443 },
444 {
445 .procname = "nlm_udpport",
446 .data = &nlm_udpport,
447 .maxlen = sizeof(int),
448 .mode = 0644,
449 .proc_handler = proc_dointvec_minmax,
450 .extra1 = (int *) &nlm_port_min,
451 .extra2 = (int *) &nlm_port_max,
452 },
453 {
454 .procname = "nlm_tcpport",
455 .data = &nlm_tcpport,
456 .maxlen = sizeof(int),
457 .mode = 0644,
458 .proc_handler = proc_dointvec_minmax,
459 .extra1 = (int *) &nlm_port_min,
460 .extra2 = (int *) &nlm_port_max,
461 },
462 {
463 .procname = "nsm_use_hostnames",
464 .data = &nsm_use_hostnames,
465 .maxlen = sizeof(bool),
466 .mode = 0644,
467 .proc_handler = proc_dobool,
468 },
469 {
470 .procname = "nsm_local_state",
471 .data = &nsm_local_state,
472 .maxlen = sizeof(int),
473 .mode = 0644,
474 .proc_handler = proc_dointvec,
475 },
476};
477
478#endif /* CONFIG_SYSCTL */
479
480/*
481 * Module (and sysfs) parameters.
482 */
483
484#define param_set_min_max(name, type, which_strtol, min, max) \
485static int param_set_##name(const char *val, const struct kernel_param *kp) \
486{ \
487 char *endp; \
488 __typeof__(type) num = which_strtol(val, &endp, 0); \
489 if (endp == val || *endp || num < (min) || num > (max)) \
490 return -EINVAL; \
491 *((type *) kp->arg) = num; \
492 return 0; \
493}
494
495static inline int is_callback(u32 proc)
496{
497 return proc == NLMPROC_GRANTED
498 || proc == NLMPROC_GRANTED_MSG
499 || proc == NLMPROC_TEST_RES
500 || proc == NLMPROC_LOCK_RES
501 || proc == NLMPROC_CANCEL_RES
502 || proc == NLMPROC_UNLOCK_RES
503 || proc == NLMPROC_NSM_NOTIFY;
504}
505
506
507static enum svc_auth_status lockd_authenticate(struct svc_rqst *rqstp)
508{
509 rqstp->rq_client = NULL;
510 switch (rqstp->rq_authop->flavour) {
511 case RPC_AUTH_NULL:
512 case RPC_AUTH_UNIX:
513 rqstp->rq_auth_stat = rpc_auth_ok;
514 if (rqstp->rq_proc == 0)
515 return SVC_OK;
516 if (is_callback(rqstp->rq_proc)) {
517 /* Leave it to individual procedures to
518 * call nlmsvc_lookup_host(rqstp)
519 */
520 return SVC_OK;
521 }
522 return svc_set_client(rqstp);
523 }
524 rqstp->rq_auth_stat = rpc_autherr_badcred;
525 return SVC_DENIED;
526}
527
528
529param_set_min_max(port, int, simple_strtol, 0, 65535)
530param_set_min_max(grace_period, unsigned long, simple_strtoul,
531 nlm_grace_period_min, nlm_grace_period_max)
532param_set_min_max(timeout, unsigned long, simple_strtoul,
533 nlm_timeout_min, nlm_timeout_max)
534
535MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
536MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION ".");
537MODULE_LICENSE("GPL");
538
539module_param_call(nlm_grace_period, param_set_grace_period, param_get_ulong,
540 &nlm_grace_period, 0644);
541module_param_call(nlm_timeout, param_set_timeout, param_get_ulong,
542 &nlm_timeout, 0644);
543module_param_call(nlm_udpport, param_set_port, param_get_int,
544 &nlm_udpport, 0644);
545module_param_call(nlm_tcpport, param_set_port, param_get_int,
546 &nlm_tcpport, 0644);
547module_param(nsm_use_hostnames, bool, 0644);
548module_param(nlm_max_connections, uint, 0644);
549
550static int lockd_init_net(struct net *net)
551{
552 struct lockd_net *ln = net_generic(net, lockd_net_id);
553
554 INIT_DELAYED_WORK(&ln->grace_period_end, grace_ender);
555 INIT_LIST_HEAD(&ln->lockd_manager.list);
556 ln->lockd_manager.block_opens = false;
557 INIT_LIST_HEAD(&ln->nsm_handles);
558 return 0;
559}
560
561static void lockd_exit_net(struct net *net)
562{
563 struct lockd_net *ln = net_generic(net, lockd_net_id);
564
565 WARN_ONCE(!list_empty(&ln->lockd_manager.list),
566 "net %x %s: lockd_manager.list is not empty\n",
567 net->ns.inum, __func__);
568 WARN_ONCE(!list_empty(&ln->nsm_handles),
569 "net %x %s: nsm_handles list is not empty\n",
570 net->ns.inum, __func__);
571 WARN_ONCE(delayed_work_pending(&ln->grace_period_end),
572 "net %x %s: grace_period_end was not cancelled\n",
573 net->ns.inum, __func__);
574}
575
576static struct pernet_operations lockd_net_ops = {
577 .init = lockd_init_net,
578 .exit = lockd_exit_net,
579 .id = &lockd_net_id,
580 .size = sizeof(struct lockd_net),
581};
582
583
584/*
585 * Initialising and terminating the module.
586 */
587
588static int __init init_nlm(void)
589{
590 int err;
591
592#ifdef CONFIG_SYSCTL
593 err = -ENOMEM;
594 nlm_sysctl_table = register_sysctl("fs/nfs", nlm_sysctls);
595 if (nlm_sysctl_table == NULL)
596 goto err_sysctl;
597#endif
598 err = register_pernet_subsys(&lockd_net_ops);
599 if (err)
600 goto err_pernet;
601
602 err = lockd_create_procfs();
603 if (err)
604 goto err_procfs;
605
606 return 0;
607
608err_procfs:
609 unregister_pernet_subsys(&lockd_net_ops);
610err_pernet:
611#ifdef CONFIG_SYSCTL
612 unregister_sysctl_table(nlm_sysctl_table);
613err_sysctl:
614#endif
615 return err;
616}
617
618static void __exit exit_nlm(void)
619{
620 /* FIXME: delete all NLM clients */
621 nlm_shutdown_hosts();
622 lockd_remove_procfs();
623 unregister_pernet_subsys(&lockd_net_ops);
624#ifdef CONFIG_SYSCTL
625 unregister_sysctl_table(nlm_sysctl_table);
626#endif
627}
628
629module_init(init_nlm);
630module_exit(exit_nlm);
631
632/**
633 * nlmsvc_dispatch - Process an NLM Request
634 * @rqstp: incoming request
635 *
636 * Return values:
637 * %0: Processing complete; do not send a Reply
638 * %1: Processing complete; send Reply in rqstp->rq_res
639 */
640static int nlmsvc_dispatch(struct svc_rqst *rqstp)
641{
642 const struct svc_procedure *procp = rqstp->rq_procinfo;
643 __be32 *statp = rqstp->rq_accept_statp;
644
645 if (!procp->pc_decode(rqstp, &rqstp->rq_arg_stream))
646 goto out_decode_err;
647
648 *statp = procp->pc_func(rqstp);
649 if (*statp == rpc_drop_reply)
650 return 0;
651 if (*statp != rpc_success)
652 return 1;
653
654 if (!procp->pc_encode(rqstp, &rqstp->rq_res_stream))
655 goto out_encode_err;
656
657 return 1;
658
659out_decode_err:
660 *statp = rpc_garbage_args;
661 return 1;
662
663out_encode_err:
664 *statp = rpc_system_err;
665 return 1;
666}
667
668/*
669 * Define NLM program and procedures
670 */
671static DEFINE_PER_CPU_ALIGNED(unsigned long, nlmsvc_version1_count[17]);
672static const struct svc_version nlmsvc_version1 = {
673 .vs_vers = 1,
674 .vs_nproc = 17,
675 .vs_proc = nlmsvc_procedures,
676 .vs_count = nlmsvc_version1_count,
677 .vs_dispatch = nlmsvc_dispatch,
678 .vs_xdrsize = NLMSVC_XDRSIZE,
679};
680
681static DEFINE_PER_CPU_ALIGNED(unsigned long,
682 nlmsvc_version3_count[ARRAY_SIZE(nlmsvc_procedures)]);
683static const struct svc_version nlmsvc_version3 = {
684 .vs_vers = 3,
685 .vs_nproc = ARRAY_SIZE(nlmsvc_procedures),
686 .vs_proc = nlmsvc_procedures,
687 .vs_count = nlmsvc_version3_count,
688 .vs_dispatch = nlmsvc_dispatch,
689 .vs_xdrsize = NLMSVC_XDRSIZE,
690};
691
692#ifdef CONFIG_LOCKD_V4
693static DEFINE_PER_CPU_ALIGNED(unsigned long,
694 nlmsvc_version4_count[ARRAY_SIZE(nlmsvc_procedures4)]);
695static const struct svc_version nlmsvc_version4 = {
696 .vs_vers = 4,
697 .vs_nproc = ARRAY_SIZE(nlmsvc_procedures4),
698 .vs_proc = nlmsvc_procedures4,
699 .vs_count = nlmsvc_version4_count,
700 .vs_dispatch = nlmsvc_dispatch,
701 .vs_xdrsize = NLMSVC_XDRSIZE,
702};
703#endif
704
705static const struct svc_version *nlmsvc_version[] = {
706 [1] = &nlmsvc_version1,
707 [3] = &nlmsvc_version3,
708#ifdef CONFIG_LOCKD_V4
709 [4] = &nlmsvc_version4,
710#endif
711};
712
713#define NLM_NRVERS ARRAY_SIZE(nlmsvc_version)
714static struct svc_program nlmsvc_program = {
715 .pg_prog = NLM_PROGRAM, /* program number */
716 .pg_nvers = NLM_NRVERS, /* number of entries in nlmsvc_version */
717 .pg_vers = nlmsvc_version, /* version table */
718 .pg_name = "lockd", /* service name */
719 .pg_class = "nfsd", /* share authentication with nfsd */
720 .pg_authenticate = &lockd_authenticate, /* export authentication */
721 .pg_init_request = svc_generic_init_request,
722 .pg_rpcbind_set = svc_generic_rpcbind_set,
723};