1 // SPDX-License-Identifier: GPL-2.0-only
5 * This is the central lockd service.
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?
16 #include <linux/module.h>
17 #include <linux/init.h>
18 #include <linux/sysctl.h>
19 #include <linux/moduleparam.h>
21 #include <linux/sched/signal.h>
22 #include <linux/errno.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>
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>
37 #include <net/addrconf.h>
39 #include <linux/lockd/lockd.h>
40 #include <linux/nfs.h>
45 #define NLMDBG_FACILITY NLMDBG_SVC
46 #define LOCKD_BUFSIZE (1024 + NLMSVC_XDRSIZE)
48 static struct svc_program nlmsvc_program;
50 const struct nlmsvc_binding *nlmsvc_ops;
51 EXPORT_SYMBOL_GPL(nlmsvc_ops);
53 static DEFINE_MUTEX(nlmsvc_mutex);
54 static unsigned int nlmsvc_users;
55 static struct svc_serv *nlmsvc_serv;
56 unsigned long nlmsvc_timeout;
58 static void nlmsvc_request_retry(struct timer_list *tl)
60 svc_wake_up(nlmsvc_serv);
62 DEFINE_TIMER(nlmsvc_retry, nlmsvc_request_retry);
64 unsigned int lockd_net_id;
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
70 static unsigned long nlm_grace_period;
71 static unsigned long nlm_timeout = LOCKD_DFLT_TIMEO;
72 static int nlm_udpport, nlm_tcpport;
74 /* RLIM_NOFILE defaults to 1024. That seems like a reasonable default here. */
75 static unsigned int nlm_max_connections = 1024;
78 * Constants needed for the sysctl interface.
80 static const unsigned long nlm_grace_period_min = 0;
81 static const unsigned long nlm_grace_period_max = 240;
82 static const unsigned long nlm_timeout_min = 3;
83 static const unsigned long nlm_timeout_max = 20;
86 static const int nlm_port_min = 0, nlm_port_max = 65535;
87 static struct ctl_table_header * nlm_sysctl_table;
90 static unsigned long get_lockd_grace_period(void)
92 /* Note: nlm_timeout should always be nonzero */
94 return roundup(nlm_grace_period, nlm_timeout) * HZ;
96 return nlm_timeout * 5 * HZ;
99 static void grace_ender(struct work_struct *grace)
101 struct delayed_work *dwork = to_delayed_work(grace);
102 struct lockd_net *ln = container_of(dwork, struct lockd_net,
105 locks_end_grace(&ln->lockd_manager);
108 static void set_grace_period(struct net *net)
110 unsigned long grace_period = get_lockd_grace_period();
111 struct lockd_net *ln = net_generic(net, lockd_net_id);
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);
119 * This is the lockd kernel thread
124 struct svc_rqst *rqstp = vrqstp;
125 struct net *net = &init_net;
126 struct lockd_net *ln = net_generic(net, lockd_net_id);
128 /* try_to_freeze() is called from svc_recv() */
131 dprintk("NFS locking service started (ver " LOCKD_VERSION ").\n");
134 * The main request loop. We don't terminate until the last
135 * NFS mount or NFS daemon has gone away.
137 while (!svc_thread_should_stop(rqstp)) {
138 /* update sv_maxconn if it has changed */
139 rqstp->rq_server->sv_maxconn = nlm_max_connections;
141 nlmsvc_retry_blocked(rqstp);
145 nlmsvc_invalidate_all();
146 nlm_shutdown_hosts();
147 cancel_delayed_work_sync(&ln->grace_period_end);
148 locks_end_grace(&ln->lockd_manager);
150 dprintk("lockd_down: service stopped\n");
152 svc_exit_thread(rqstp);
156 static 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)
161 struct svc_xprt *xprt;
163 xprt = svc_find_xprt(serv, name, net, family, 0);
165 return svc_xprt_create(serv, name, net, family, port,
166 SVC_SOCK_DEFAULTS, cred);
171 static int create_lockd_family(struct svc_serv *serv, struct net *net,
172 const int family, const struct cred *cred)
176 err = create_lockd_listener(serv, "udp", net, family, nlm_udpport,
181 return create_lockd_listener(serv, "tcp", net, family, nlm_tcpport,
186 * Ensure there are active UDP and TCP listeners for lockd.
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.
192 * Returns zero if all listeners are available; otherwise a
193 * negative errno value is returned.
195 static int make_socks(struct svc_serv *serv, struct net *net,
196 const struct cred *cred)
201 err = create_lockd_family(serv, net, PF_INET, cred);
205 err = create_lockd_family(serv, net, PF_INET6, cred);
206 if (err < 0 && err != -EAFNOSUPPORT)
215 "lockd_up: makesock failed, error=%d\n", err);
216 svc_xprt_destroy_all(serv, net);
217 svc_rpcb_cleanup(serv, net);
221 static int lockd_up_net(struct svc_serv *serv, struct net *net,
222 const struct cred *cred)
224 struct lockd_net *ln = net_generic(net, lockd_net_id);
227 if (ln->nlmsvc_users++)
230 error = svc_bind(serv, net);
234 error = make_socks(serv, net, cred);
237 set_grace_period(net);
238 dprintk("%s: per-net data created; net=%x\n", __func__, net->ns.inum);
246 static void lockd_down_net(struct svc_serv *serv, struct net *net)
248 struct lockd_net *ln = net_generic(net, lockd_net_id);
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);
259 pr_err("%s: no users! net=%x\n",
260 __func__, net->ns.inum);
265 static int lockd_inetaddr_event(struct notifier_block *this,
266 unsigned long event, void *ptr)
268 struct in_ifaddr *ifa = (struct in_ifaddr *)ptr;
269 struct sockaddr_in sin;
271 if (event != NETDEV_DOWN)
275 dprintk("lockd_inetaddr_event: removed %pI4\n",
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);
286 static struct notifier_block lockd_inetaddr_notifier = {
287 .notifier_call = lockd_inetaddr_event,
290 #if IS_ENABLED(CONFIG_IPV6)
291 static int lockd_inet6addr_event(struct notifier_block *this,
292 unsigned long event, void *ptr)
294 struct inet6_ifaddr *ifa = (struct inet6_ifaddr *)ptr;
295 struct sockaddr_in6 sin6;
297 if (event != NETDEV_DOWN)
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);
313 static struct notifier_block lockd_inet6addr_notifier = {
314 .notifier_call = lockd_inet6addr_event,
318 static int lockd_get(void)
320 struct svc_serv *serv;
329 * Sanity check: if there's no pid,
330 * we should be the first user ...
334 "lockd_up: no pid, %d users??\n", nlmsvc_users);
337 nlm_timeout = LOCKD_DFLT_TIMEO;
338 nlmsvc_timeout = nlm_timeout * HZ;
340 serv = svc_create(&nlmsvc_program, LOCKD_BUFSIZE, lockd);
342 printk(KERN_WARNING "lockd_up: create service failed\n");
346 serv->sv_maxconn = nlm_max_connections;
347 error = svc_set_num_threads(serv, NULL, 1);
354 register_inetaddr_notifier(&lockd_inetaddr_notifier);
355 #if IS_ENABLED(CONFIG_IPV6)
356 register_inet6addr_notifier(&lockd_inet6addr_notifier);
358 dprintk("lockd_up: service created\n");
363 static void lockd_put(void)
365 if (WARN(nlmsvc_users <= 0, "lockd_down: no users!\n"))
370 unregister_inetaddr_notifier(&lockd_inetaddr_notifier);
371 #if IS_ENABLED(CONFIG_IPV6)
372 unregister_inet6addr_notifier(&lockd_inet6addr_notifier);
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");
382 * Bring up the lockd process if it's not already up.
384 int lockd_up(struct net *net, const struct cred *cred)
388 mutex_lock(&nlmsvc_mutex);
394 error = lockd_up_net(nlmsvc_serv, net, cred);
401 mutex_unlock(&nlmsvc_mutex);
404 EXPORT_SYMBOL_GPL(lockd_up);
407 * Decrement the user count and bring down lockd if we're the last.
410 lockd_down(struct net *net)
412 mutex_lock(&nlmsvc_mutex);
413 lockd_down_net(nlmsvc_serv, net);
415 mutex_unlock(&nlmsvc_mutex);
417 EXPORT_SYMBOL_GPL(lockd_down);
422 * Sysctl parameters (same as module parameters, different interface).
425 static struct ctl_table nlm_sysctls[] = {
427 .procname = "nlm_grace_period",
428 .data = &nlm_grace_period,
429 .maxlen = sizeof(unsigned long),
431 .proc_handler = proc_doulongvec_minmax,
432 .extra1 = (unsigned long *) &nlm_grace_period_min,
433 .extra2 = (unsigned long *) &nlm_grace_period_max,
436 .procname = "nlm_timeout",
437 .data = &nlm_timeout,
438 .maxlen = sizeof(unsigned long),
440 .proc_handler = proc_doulongvec_minmax,
441 .extra1 = (unsigned long *) &nlm_timeout_min,
442 .extra2 = (unsigned long *) &nlm_timeout_max,
445 .procname = "nlm_udpport",
446 .data = &nlm_udpport,
447 .maxlen = sizeof(int),
449 .proc_handler = proc_dointvec_minmax,
450 .extra1 = (int *) &nlm_port_min,
451 .extra2 = (int *) &nlm_port_max,
454 .procname = "nlm_tcpport",
455 .data = &nlm_tcpport,
456 .maxlen = sizeof(int),
458 .proc_handler = proc_dointvec_minmax,
459 .extra1 = (int *) &nlm_port_min,
460 .extra2 = (int *) &nlm_port_max,
463 .procname = "nsm_use_hostnames",
464 .data = &nsm_use_hostnames,
465 .maxlen = sizeof(bool),
467 .proc_handler = proc_dobool,
470 .procname = "nsm_local_state",
471 .data = &nsm_local_state,
472 .maxlen = sizeof(int),
474 .proc_handler = proc_dointvec,
478 #endif /* CONFIG_SYSCTL */
481 * Module (and sysfs) parameters.
484 #define param_set_min_max(name, type, which_strtol, min, max) \
485 static int param_set_##name(const char *val, const struct kernel_param *kp) \
488 __typeof__(type) num = which_strtol(val, &endp, 0); \
489 if (endp == val || *endp || num < (min) || num > (max)) \
491 *((type *) kp->arg) = num; \
495 static inline int is_callback(u32 proc)
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;
507 static enum svc_auth_status lockd_authenticate(struct svc_rqst *rqstp)
509 rqstp->rq_client = NULL;
510 switch (rqstp->rq_authop->flavour) {
513 rqstp->rq_auth_stat = rpc_auth_ok;
514 if (rqstp->rq_proc == 0)
516 if (is_callback(rqstp->rq_proc)) {
517 /* Leave it to individual procedures to
518 * call nlmsvc_lookup_host(rqstp)
522 return svc_set_client(rqstp);
524 rqstp->rq_auth_stat = rpc_autherr_badcred;
529 param_set_min_max(port, int, simple_strtol, 0, 65535)
530 param_set_min_max(grace_period, unsigned long, simple_strtoul,
531 nlm_grace_period_min, nlm_grace_period_max)
532 param_set_min_max(timeout, unsigned long, simple_strtoul,
533 nlm_timeout_min, nlm_timeout_max)
536 MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION ".");
537 MODULE_LICENSE("GPL");
539 module_param_call(nlm_grace_period, param_set_grace_period, param_get_ulong,
540 &nlm_grace_period, 0644);
541 module_param_call(nlm_timeout, param_set_timeout, param_get_ulong,
543 module_param_call(nlm_udpport, param_set_port, param_get_int,
545 module_param_call(nlm_tcpport, param_set_port, param_get_int,
547 module_param(nsm_use_hostnames, bool, 0644);
548 module_param(nlm_max_connections, uint, 0644);
550 static int lockd_init_net(struct net *net)
552 struct lockd_net *ln = net_generic(net, lockd_net_id);
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);
561 static void lockd_exit_net(struct net *net)
563 struct lockd_net *ln = net_generic(net, lockd_net_id);
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__);
576 static struct pernet_operations lockd_net_ops = {
577 .init = lockd_init_net,
578 .exit = lockd_exit_net,
580 .size = sizeof(struct lockd_net),
585 * Initialising and terminating the module.
588 static int __init init_nlm(void)
594 nlm_sysctl_table = register_sysctl("fs/nfs", nlm_sysctls);
595 if (nlm_sysctl_table == NULL)
598 err = register_pernet_subsys(&lockd_net_ops);
602 err = lockd_create_procfs();
609 unregister_pernet_subsys(&lockd_net_ops);
612 unregister_sysctl_table(nlm_sysctl_table);
618 static void __exit exit_nlm(void)
620 /* FIXME: delete all NLM clients */
621 nlm_shutdown_hosts();
622 lockd_remove_procfs();
623 unregister_pernet_subsys(&lockd_net_ops);
625 unregister_sysctl_table(nlm_sysctl_table);
629 module_init(init_nlm);
630 module_exit(exit_nlm);
633 * nlmsvc_dispatch - Process an NLM Request
634 * @rqstp: incoming request
637 * %0: Processing complete; do not send a Reply
638 * %1: Processing complete; send Reply in rqstp->rq_res
640 static int nlmsvc_dispatch(struct svc_rqst *rqstp)
642 const struct svc_procedure *procp = rqstp->rq_procinfo;
643 __be32 *statp = rqstp->rq_accept_statp;
645 if (!procp->pc_decode(rqstp, &rqstp->rq_arg_stream))
648 *statp = procp->pc_func(rqstp);
649 if (*statp == rpc_drop_reply)
651 if (*statp != rpc_success)
654 if (!procp->pc_encode(rqstp, &rqstp->rq_res_stream))
660 *statp = rpc_garbage_args;
664 *statp = rpc_system_err;
669 * Define NLM program and procedures
671 static DEFINE_PER_CPU_ALIGNED(unsigned long, nlmsvc_version1_count[17]);
672 static const struct svc_version nlmsvc_version1 = {
675 .vs_proc = nlmsvc_procedures,
676 .vs_count = nlmsvc_version1_count,
677 .vs_dispatch = nlmsvc_dispatch,
678 .vs_xdrsize = NLMSVC_XDRSIZE,
681 static DEFINE_PER_CPU_ALIGNED(unsigned long,
682 nlmsvc_version3_count[ARRAY_SIZE(nlmsvc_procedures)]);
683 static const struct svc_version nlmsvc_version3 = {
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,
692 #ifdef CONFIG_LOCKD_V4
693 static DEFINE_PER_CPU_ALIGNED(unsigned long,
694 nlmsvc_version4_count[ARRAY_SIZE(nlmsvc_procedures4)]);
695 static const struct svc_version nlmsvc_version4 = {
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,
705 static const struct svc_version *nlmsvc_version[] = {
706 [1] = &nlmsvc_version1,
707 [3] = &nlmsvc_version3,
708 #ifdef CONFIG_LOCKD_V4
709 [4] = &nlmsvc_version4,
713 #define NLM_NRVERS ARRAY_SIZE(nlmsvc_version)
714 static 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,