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?
11 * Authors: Olaf Kirch (okir@monad.swb.de)
13 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
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/kthread.h>
28 #include <linux/freezer.h>
29 #include <linux/inetdevice.h>
31 #include <linux/sunrpc/types.h>
32 #include <linux/sunrpc/stats.h>
33 #include <linux/sunrpc/clnt.h>
34 #include <linux/sunrpc/svc.h>
35 #include <linux/sunrpc/svcsock.h>
36 #include <linux/sunrpc/svc_xprt.h>
38 #include <net/addrconf.h>
40 #include <linux/lockd/lockd.h>
41 #include <linux/nfs.h>
46 #define NLMDBG_FACILITY NLMDBG_SVC
47 #define LOCKD_BUFSIZE (1024 + NLMSVC_XDRSIZE)
48 #define ALLOWED_SIGS (sigmask(SIGKILL))
50 static struct svc_program nlmsvc_program;
52 const struct nlmsvc_binding *nlmsvc_ops;
53 EXPORT_SYMBOL_GPL(nlmsvc_ops);
55 static DEFINE_MUTEX(nlmsvc_mutex);
56 static unsigned int nlmsvc_users;
57 static struct svc_serv *nlmsvc_serv;
58 unsigned long nlmsvc_timeout;
60 unsigned int lockd_net_id;
63 * These can be set at insmod time (useful for NFS as root filesystem),
64 * and also changed through the sysctl interface. -- Jamie Lokier, Aug 2003
66 static unsigned long nlm_grace_period;
67 static unsigned long nlm_timeout = LOCKD_DFLT_TIMEO;
68 static int nlm_udpport, nlm_tcpport;
70 /* RLIM_NOFILE defaults to 1024. That seems like a reasonable default here. */
71 static unsigned int nlm_max_connections = 1024;
74 * Constants needed for the sysctl interface.
76 static const unsigned long nlm_grace_period_min = 0;
77 static const unsigned long nlm_grace_period_max = 240;
78 static const unsigned long nlm_timeout_min = 3;
79 static const unsigned long nlm_timeout_max = 20;
80 static const int nlm_port_min = 0, nlm_port_max = 65535;
83 static struct ctl_table_header * nlm_sysctl_table;
86 static unsigned long get_lockd_grace_period(void)
88 /* Note: nlm_timeout should always be nonzero */
90 return roundup(nlm_grace_period, nlm_timeout) * HZ;
92 return nlm_timeout * 5 * HZ;
95 static void grace_ender(struct work_struct *grace)
97 struct delayed_work *dwork = to_delayed_work(grace);
98 struct lockd_net *ln = container_of(dwork, struct lockd_net,
101 locks_end_grace(&ln->lockd_manager);
104 static void set_grace_period(struct net *net)
106 unsigned long grace_period = get_lockd_grace_period();
107 struct lockd_net *ln = net_generic(net, lockd_net_id);
109 locks_start_grace(net, &ln->lockd_manager);
110 cancel_delayed_work_sync(&ln->grace_period_end);
111 schedule_delayed_work(&ln->grace_period_end, grace_period);
114 static void restart_grace(void)
117 struct net *net = &init_net;
118 struct lockd_net *ln = net_generic(net, lockd_net_id);
120 cancel_delayed_work_sync(&ln->grace_period_end);
121 locks_end_grace(&ln->lockd_manager);
122 nlmsvc_invalidate_all();
123 set_grace_period(net);
128 * This is the lockd kernel thread
134 struct svc_rqst *rqstp = vrqstp;
135 struct net *net = &init_net;
136 struct lockd_net *ln = net_generic(net, lockd_net_id);
138 /* try_to_freeze() is called from svc_recv() */
141 /* Allow SIGKILL to tell lockd to drop all of its locks */
142 allow_signal(SIGKILL);
144 dprintk("NFS locking service started (ver " LOCKD_VERSION ").\n");
147 * The main request loop. We don't terminate until the last
148 * NFS mount or NFS daemon has gone away.
150 while (!kthread_should_stop()) {
151 long timeout = MAX_SCHEDULE_TIMEOUT;
152 RPC_IFDEBUG(char buf[RPC_MAX_ADDRBUFLEN]);
154 /* update sv_maxconn if it has changed */
155 rqstp->rq_server->sv_maxconn = nlm_max_connections;
158 flush_signals(current);
163 timeout = nlmsvc_retry_blocked();
166 * Find a socket with data available and call its
169 err = svc_recv(rqstp, timeout);
170 if (err == -EAGAIN || err == -EINTR)
172 dprintk("lockd: request from %s\n",
173 svc_print_addr(rqstp, buf, sizeof(buf)));
177 flush_signals(current);
179 nlmsvc_invalidate_all();
180 nlm_shutdown_hosts();
181 cancel_delayed_work_sync(&ln->grace_period_end);
182 locks_end_grace(&ln->lockd_manager);
184 dprintk("lockd_down: service stopped\n");
186 svc_exit_thread(rqstp);
188 module_put_and_kthread_exit(0);
191 static int create_lockd_listener(struct svc_serv *serv, const char *name,
192 struct net *net, const int family,
193 const unsigned short port,
194 const struct cred *cred)
196 struct svc_xprt *xprt;
198 xprt = svc_find_xprt(serv, name, net, family, 0);
200 return svc_xprt_create(serv, name, net, family, port,
201 SVC_SOCK_DEFAULTS, cred);
206 static int create_lockd_family(struct svc_serv *serv, struct net *net,
207 const int family, const struct cred *cred)
211 err = create_lockd_listener(serv, "udp", net, family, nlm_udpport,
216 return create_lockd_listener(serv, "tcp", net, family, nlm_tcpport,
221 * Ensure there are active UDP and TCP listeners for lockd.
223 * Even if we have only TCP NFS mounts and/or TCP NFSDs, some
224 * local services (such as rpc.statd) still require UDP, and
225 * some NFS servers do not yet support NLM over TCP.
227 * Returns zero if all listeners are available; otherwise a
228 * negative errno value is returned.
230 static int make_socks(struct svc_serv *serv, struct net *net,
231 const struct cred *cred)
236 err = create_lockd_family(serv, net, PF_INET, cred);
240 err = create_lockd_family(serv, net, PF_INET6, cred);
241 if (err < 0 && err != -EAFNOSUPPORT)
250 "lockd_up: makesock failed, error=%d\n", err);
251 svc_shutdown_net(serv, net);
252 svc_rpcb_cleanup(serv, net);
256 static int lockd_up_net(struct svc_serv *serv, struct net *net,
257 const struct cred *cred)
259 struct lockd_net *ln = net_generic(net, lockd_net_id);
262 if (ln->nlmsvc_users++)
265 error = svc_bind(serv, net);
269 error = make_socks(serv, net, cred);
272 set_grace_period(net);
273 dprintk("%s: per-net data created; net=%x\n", __func__, net->ns.inum);
281 static void lockd_down_net(struct svc_serv *serv, struct net *net)
283 struct lockd_net *ln = net_generic(net, lockd_net_id);
285 if (ln->nlmsvc_users) {
286 if (--ln->nlmsvc_users == 0) {
287 nlm_shutdown_hosts_net(net);
288 cancel_delayed_work_sync(&ln->grace_period_end);
289 locks_end_grace(&ln->lockd_manager);
290 svc_shutdown_net(serv, net);
291 svc_rpcb_cleanup(serv, net);
294 pr_err("%s: no users! net=%x\n",
295 __func__, net->ns.inum);
300 static int lockd_inetaddr_event(struct notifier_block *this,
301 unsigned long event, void *ptr)
303 struct in_ifaddr *ifa = (struct in_ifaddr *)ptr;
304 struct sockaddr_in sin;
306 if (event != NETDEV_DOWN)
310 dprintk("lockd_inetaddr_event: removed %pI4\n",
312 sin.sin_family = AF_INET;
313 sin.sin_addr.s_addr = ifa->ifa_local;
314 svc_age_temp_xprts_now(nlmsvc_serv, (struct sockaddr *)&sin);
321 static struct notifier_block lockd_inetaddr_notifier = {
322 .notifier_call = lockd_inetaddr_event,
325 #if IS_ENABLED(CONFIG_IPV6)
326 static int lockd_inet6addr_event(struct notifier_block *this,
327 unsigned long event, void *ptr)
329 struct inet6_ifaddr *ifa = (struct inet6_ifaddr *)ptr;
330 struct sockaddr_in6 sin6;
332 if (event != NETDEV_DOWN)
336 dprintk("lockd_inet6addr_event: removed %pI6\n", &ifa->addr);
337 sin6.sin6_family = AF_INET6;
338 sin6.sin6_addr = ifa->addr;
339 if (ipv6_addr_type(&sin6.sin6_addr) & IPV6_ADDR_LINKLOCAL)
340 sin6.sin6_scope_id = ifa->idev->dev->ifindex;
341 svc_age_temp_xprts_now(nlmsvc_serv, (struct sockaddr *)&sin6);
348 static struct notifier_block lockd_inet6addr_notifier = {
349 .notifier_call = lockd_inet6addr_event,
353 static const struct svc_serv_ops lockd_sv_ops = {
354 .svo_function = lockd,
355 .svo_module = THIS_MODULE,
358 static int lockd_get(void)
360 struct svc_serv *serv;
364 svc_get(nlmsvc_serv);
370 * Sanity check: if there's no pid,
371 * we should be the first user ...
375 "lockd_up: no pid, %d users??\n", nlmsvc_users);
378 nlm_timeout = LOCKD_DFLT_TIMEO;
379 nlmsvc_timeout = nlm_timeout * HZ;
381 serv = svc_create(&nlmsvc_program, LOCKD_BUFSIZE, &lockd_sv_ops);
383 printk(KERN_WARNING "lockd_up: create service failed\n");
387 serv->sv_maxconn = nlm_max_connections;
388 error = svc_set_num_threads(serv, NULL, 1);
389 /* The thread now holds the only reference */
395 register_inetaddr_notifier(&lockd_inetaddr_notifier);
396 #if IS_ENABLED(CONFIG_IPV6)
397 register_inet6addr_notifier(&lockd_inet6addr_notifier);
399 dprintk("lockd_up: service created\n");
404 static void lockd_put(void)
406 if (WARN(nlmsvc_users <= 0, "lockd_down: no users!\n"))
411 unregister_inetaddr_notifier(&lockd_inetaddr_notifier);
412 #if IS_ENABLED(CONFIG_IPV6)
413 unregister_inet6addr_notifier(&lockd_inet6addr_notifier);
416 svc_set_num_threads(nlmsvc_serv, NULL, 0);
418 dprintk("lockd_down: service destroyed\n");
422 * Bring up the lockd process if it's not already up.
424 int lockd_up(struct net *net, const struct cred *cred)
428 mutex_lock(&nlmsvc_mutex);
434 error = lockd_up_net(nlmsvc_serv, net, cred);
441 mutex_unlock(&nlmsvc_mutex);
444 EXPORT_SYMBOL_GPL(lockd_up);
447 * Decrement the user count and bring down lockd if we're the last.
450 lockd_down(struct net *net)
452 mutex_lock(&nlmsvc_mutex);
453 lockd_down_net(nlmsvc_serv, net);
455 mutex_unlock(&nlmsvc_mutex);
457 EXPORT_SYMBOL_GPL(lockd_down);
462 * Sysctl parameters (same as module parameters, different interface).
465 static struct ctl_table nlm_sysctls[] = {
467 .procname = "nlm_grace_period",
468 .data = &nlm_grace_period,
469 .maxlen = sizeof(unsigned long),
471 .proc_handler = proc_doulongvec_minmax,
472 .extra1 = (unsigned long *) &nlm_grace_period_min,
473 .extra2 = (unsigned long *) &nlm_grace_period_max,
476 .procname = "nlm_timeout",
477 .data = &nlm_timeout,
478 .maxlen = sizeof(unsigned long),
480 .proc_handler = proc_doulongvec_minmax,
481 .extra1 = (unsigned long *) &nlm_timeout_min,
482 .extra2 = (unsigned long *) &nlm_timeout_max,
485 .procname = "nlm_udpport",
486 .data = &nlm_udpport,
487 .maxlen = sizeof(int),
489 .proc_handler = proc_dointvec_minmax,
490 .extra1 = (int *) &nlm_port_min,
491 .extra2 = (int *) &nlm_port_max,
494 .procname = "nlm_tcpport",
495 .data = &nlm_tcpport,
496 .maxlen = sizeof(int),
498 .proc_handler = proc_dointvec_minmax,
499 .extra1 = (int *) &nlm_port_min,
500 .extra2 = (int *) &nlm_port_max,
503 .procname = "nsm_use_hostnames",
504 .data = &nsm_use_hostnames,
505 .maxlen = sizeof(int),
507 .proc_handler = proc_dobool,
510 .procname = "nsm_local_state",
511 .data = &nsm_local_state,
512 .maxlen = sizeof(int),
514 .proc_handler = proc_dointvec,
519 static struct ctl_table nlm_sysctl_dir[] = {
523 .child = nlm_sysctls,
528 static struct ctl_table nlm_sysctl_root[] = {
532 .child = nlm_sysctl_dir,
537 #endif /* CONFIG_SYSCTL */
540 * Module (and sysfs) parameters.
543 #define param_set_min_max(name, type, which_strtol, min, max) \
544 static int param_set_##name(const char *val, const struct kernel_param *kp) \
547 __typeof__(type) num = which_strtol(val, &endp, 0); \
548 if (endp == val || *endp || num < (min) || num > (max)) \
550 *((type *) kp->arg) = num; \
554 static inline int is_callback(u32 proc)
556 return proc == NLMPROC_GRANTED
557 || proc == NLMPROC_GRANTED_MSG
558 || proc == NLMPROC_TEST_RES
559 || proc == NLMPROC_LOCK_RES
560 || proc == NLMPROC_CANCEL_RES
561 || proc == NLMPROC_UNLOCK_RES
562 || proc == NLMPROC_NSM_NOTIFY;
566 static int lockd_authenticate(struct svc_rqst *rqstp)
568 rqstp->rq_client = NULL;
569 switch (rqstp->rq_authop->flavour) {
572 rqstp->rq_auth_stat = rpc_auth_ok;
573 if (rqstp->rq_proc == 0)
575 if (is_callback(rqstp->rq_proc)) {
576 /* Leave it to individual procedures to
577 * call nlmsvc_lookup_host(rqstp)
581 return svc_set_client(rqstp);
583 rqstp->rq_auth_stat = rpc_autherr_badcred;
588 param_set_min_max(port, int, simple_strtol, 0, 65535)
589 param_set_min_max(grace_period, unsigned long, simple_strtoul,
590 nlm_grace_period_min, nlm_grace_period_max)
591 param_set_min_max(timeout, unsigned long, simple_strtoul,
592 nlm_timeout_min, nlm_timeout_max)
594 MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
595 MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION ".");
596 MODULE_LICENSE("GPL");
598 module_param_call(nlm_grace_period, param_set_grace_period, param_get_ulong,
599 &nlm_grace_period, 0644);
600 module_param_call(nlm_timeout, param_set_timeout, param_get_ulong,
602 module_param_call(nlm_udpport, param_set_port, param_get_int,
604 module_param_call(nlm_tcpport, param_set_port, param_get_int,
606 module_param(nsm_use_hostnames, bool, 0644);
607 module_param(nlm_max_connections, uint, 0644);
609 static int lockd_init_net(struct net *net)
611 struct lockd_net *ln = net_generic(net, lockd_net_id);
613 INIT_DELAYED_WORK(&ln->grace_period_end, grace_ender);
614 INIT_LIST_HEAD(&ln->lockd_manager.list);
615 ln->lockd_manager.block_opens = false;
616 INIT_LIST_HEAD(&ln->nsm_handles);
620 static void lockd_exit_net(struct net *net)
622 struct lockd_net *ln = net_generic(net, lockd_net_id);
624 WARN_ONCE(!list_empty(&ln->lockd_manager.list),
625 "net %x %s: lockd_manager.list is not empty\n",
626 net->ns.inum, __func__);
627 WARN_ONCE(!list_empty(&ln->nsm_handles),
628 "net %x %s: nsm_handles list is not empty\n",
629 net->ns.inum, __func__);
630 WARN_ONCE(delayed_work_pending(&ln->grace_period_end),
631 "net %x %s: grace_period_end was not cancelled\n",
632 net->ns.inum, __func__);
635 static struct pernet_operations lockd_net_ops = {
636 .init = lockd_init_net,
637 .exit = lockd_exit_net,
639 .size = sizeof(struct lockd_net),
644 * Initialising and terminating the module.
647 static int __init init_nlm(void)
653 nlm_sysctl_table = register_sysctl_table(nlm_sysctl_root);
654 if (nlm_sysctl_table == NULL)
657 err = register_pernet_subsys(&lockd_net_ops);
661 err = lockd_create_procfs();
668 unregister_pernet_subsys(&lockd_net_ops);
671 unregister_sysctl_table(nlm_sysctl_table);
677 static void __exit exit_nlm(void)
679 /* FIXME: delete all NLM clients */
680 nlm_shutdown_hosts();
681 lockd_remove_procfs();
682 unregister_pernet_subsys(&lockd_net_ops);
684 unregister_sysctl_table(nlm_sysctl_table);
688 module_init(init_nlm);
689 module_exit(exit_nlm);
692 * nlmsvc_dispatch - Process an NLM Request
693 * @rqstp: incoming request
694 * @statp: pointer to location of accept_stat field in RPC Reply buffer
697 * %0: Processing complete; do not send a Reply
698 * %1: Processing complete; send Reply in rqstp->rq_res
700 static int nlmsvc_dispatch(struct svc_rqst *rqstp, __be32 *statp)
702 const struct svc_procedure *procp = rqstp->rq_procinfo;
704 svcxdr_init_decode(rqstp);
705 if (!procp->pc_decode(rqstp, &rqstp->rq_arg_stream))
708 *statp = procp->pc_func(rqstp);
709 if (*statp == rpc_drop_reply)
711 if (*statp != rpc_success)
714 svcxdr_init_encode(rqstp);
715 if (!procp->pc_encode(rqstp, &rqstp->rq_res_stream))
721 *statp = rpc_garbage_args;
725 *statp = rpc_system_err;
730 * Define NLM program and procedures
732 static unsigned int nlmsvc_version1_count[17];
733 static const struct svc_version nlmsvc_version1 = {
736 .vs_proc = nlmsvc_procedures,
737 .vs_count = nlmsvc_version1_count,
738 .vs_dispatch = nlmsvc_dispatch,
739 .vs_xdrsize = NLMSVC_XDRSIZE,
741 static unsigned int nlmsvc_version3_count[24];
742 static const struct svc_version nlmsvc_version3 = {
745 .vs_proc = nlmsvc_procedures,
746 .vs_count = nlmsvc_version3_count,
747 .vs_dispatch = nlmsvc_dispatch,
748 .vs_xdrsize = NLMSVC_XDRSIZE,
750 #ifdef CONFIG_LOCKD_V4
751 static unsigned int nlmsvc_version4_count[24];
752 static const struct svc_version nlmsvc_version4 = {
755 .vs_proc = nlmsvc_procedures4,
756 .vs_count = nlmsvc_version4_count,
757 .vs_dispatch = nlmsvc_dispatch,
758 .vs_xdrsize = NLMSVC_XDRSIZE,
761 static const struct svc_version *nlmsvc_version[] = {
762 [1] = &nlmsvc_version1,
763 [3] = &nlmsvc_version3,
764 #ifdef CONFIG_LOCKD_V4
765 [4] = &nlmsvc_version4,
769 static struct svc_stat nlmsvc_stats;
771 #define NLM_NRVERS ARRAY_SIZE(nlmsvc_version)
772 static struct svc_program nlmsvc_program = {
773 .pg_prog = NLM_PROGRAM, /* program number */
774 .pg_nvers = NLM_NRVERS, /* number of entries in nlmsvc_version */
775 .pg_vers = nlmsvc_version, /* version table */
776 .pg_name = "lockd", /* service name */
777 .pg_class = "nfsd", /* share authentication with nfsd */
778 .pg_stats = &nlmsvc_stats, /* stats table */
779 .pg_authenticate = &lockd_authenticate, /* export authentication */
780 .pg_init_request = svc_generic_init_request,
781 .pg_rpcbind_set = svc_generic_rpcbind_set,