4 * This is the central lockd service.
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?
10 * Authors: Olaf Kirch (okir@monad.swb.de)
12 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
15 #include <linux/module.h>
16 #include <linux/init.h>
17 #include <linux/sysctl.h>
18 #include <linux/moduleparam.h>
20 #include <linux/sched/signal.h>
21 #include <linux/errno.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 #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)
47 #define ALLOWED_SIGS (sigmask(SIGKILL))
49 static struct svc_program nlmsvc_program
;
51 const struct nlmsvc_binding
*nlmsvc_ops
;
52 EXPORT_SYMBOL_GPL(nlmsvc_ops
);
54 static DEFINE_MUTEX(nlmsvc_mutex
);
55 static unsigned int nlmsvc_users
;
56 static struct task_struct
*nlmsvc_task
;
57 static struct svc_rqst
*nlmsvc_rqst
;
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
);
186 static int create_lockd_listener(struct svc_serv
*serv
, const char *name
,
187 struct net
*net
, const int family
,
188 const unsigned short port
)
190 struct svc_xprt
*xprt
;
192 xprt
= svc_find_xprt(serv
, name
, net
, family
, 0);
194 return svc_create_xprt(serv
, name
, net
, family
, port
,
200 static int create_lockd_family(struct svc_serv
*serv
, struct net
*net
,
205 err
= create_lockd_listener(serv
, "udp", net
, family
, nlm_udpport
);
209 return create_lockd_listener(serv
, "tcp", net
, family
, nlm_tcpport
);
213 * Ensure there are active UDP and TCP listeners for lockd.
215 * Even if we have only TCP NFS mounts and/or TCP NFSDs, some
216 * local services (such as rpc.statd) still require UDP, and
217 * some NFS servers do not yet support NLM over TCP.
219 * Returns zero if all listeners are available; otherwise a
220 * negative errno value is returned.
222 static int make_socks(struct svc_serv
*serv
, struct net
*net
)
227 err
= create_lockd_family(serv
, net
, PF_INET
);
231 err
= create_lockd_family(serv
, net
, PF_INET6
);
232 if (err
< 0 && err
!= -EAFNOSUPPORT
)
241 "lockd_up: makesock failed, error=%d\n", err
);
242 svc_shutdown_net(serv
, net
);
246 static int lockd_up_net(struct svc_serv
*serv
, struct net
*net
)
248 struct lockd_net
*ln
= net_generic(net
, lockd_net_id
);
251 if (ln
->nlmsvc_users
++)
254 error
= svc_bind(serv
, net
);
258 error
= make_socks(serv
, net
);
261 set_grace_period(net
);
262 dprintk("lockd_up_net: per-net data created; net=%p\n", net
);
270 static void lockd_down_net(struct svc_serv
*serv
, struct net
*net
)
272 struct lockd_net
*ln
= net_generic(net
, lockd_net_id
);
274 if (ln
->nlmsvc_users
) {
275 if (--ln
->nlmsvc_users
== 0) {
276 nlm_shutdown_hosts_net(net
);
277 svc_shutdown_net(serv
, net
);
278 dprintk("lockd_down_net: per-net data destroyed; net=%p\n", net
);
281 printk(KERN_ERR
"lockd_down_net: no users! task=%p, net=%p\n",
287 static int lockd_inetaddr_event(struct notifier_block
*this,
288 unsigned long event
, void *ptr
)
290 struct in_ifaddr
*ifa
= (struct in_ifaddr
*)ptr
;
291 struct sockaddr_in sin
;
293 if (event
!= NETDEV_DOWN
)
297 dprintk("lockd_inetaddr_event: removed %pI4\n",
299 sin
.sin_family
= AF_INET
;
300 sin
.sin_addr
.s_addr
= ifa
->ifa_local
;
301 svc_age_temp_xprts_now(nlmsvc_rqst
->rq_server
,
302 (struct sockaddr
*)&sin
);
309 static struct notifier_block lockd_inetaddr_notifier
= {
310 .notifier_call
= lockd_inetaddr_event
,
313 #if IS_ENABLED(CONFIG_IPV6)
314 static int lockd_inet6addr_event(struct notifier_block
*this,
315 unsigned long event
, void *ptr
)
317 struct inet6_ifaddr
*ifa
= (struct inet6_ifaddr
*)ptr
;
318 struct sockaddr_in6 sin6
;
320 if (event
!= NETDEV_DOWN
)
324 dprintk("lockd_inet6addr_event: removed %pI6\n", &ifa
->addr
);
325 sin6
.sin6_family
= AF_INET6
;
326 sin6
.sin6_addr
= ifa
->addr
;
327 if (ipv6_addr_type(&sin6
.sin6_addr
) & IPV6_ADDR_LINKLOCAL
)
328 sin6
.sin6_scope_id
= ifa
->idev
->dev
->ifindex
;
329 svc_age_temp_xprts_now(nlmsvc_rqst
->rq_server
,
330 (struct sockaddr
*)&sin6
);
337 static struct notifier_block lockd_inet6addr_notifier
= {
338 .notifier_call
= lockd_inet6addr_event
,
342 static void lockd_unregister_notifiers(void)
344 unregister_inetaddr_notifier(&lockd_inetaddr_notifier
);
345 #if IS_ENABLED(CONFIG_IPV6)
346 unregister_inet6addr_notifier(&lockd_inet6addr_notifier
);
350 static void lockd_svc_exit_thread(void)
352 lockd_unregister_notifiers();
353 svc_exit_thread(nlmsvc_rqst
);
356 static int lockd_start_svc(struct svc_serv
*serv
)
364 * Create the kernel thread and wait for it to start.
366 nlmsvc_rqst
= svc_prepare_thread(serv
, &serv
->sv_pools
[0], NUMA_NO_NODE
);
367 if (IS_ERR(nlmsvc_rqst
)) {
368 error
= PTR_ERR(nlmsvc_rqst
);
370 "lockd_up: svc_rqst allocation failed, error=%d\n",
375 svc_sock_update_bufs(serv
);
376 serv
->sv_maxconn
= nlm_max_connections
;
378 nlmsvc_task
= kthread_create(lockd
, nlmsvc_rqst
, "%s", serv
->sv_name
);
379 if (IS_ERR(nlmsvc_task
)) {
380 error
= PTR_ERR(nlmsvc_task
);
382 "lockd_up: kthread_run failed, error=%d\n", error
);
385 nlmsvc_rqst
->rq_task
= nlmsvc_task
;
386 wake_up_process(nlmsvc_task
);
388 dprintk("lockd_up: service started\n");
392 lockd_svc_exit_thread();
399 static const struct svc_serv_ops lockd_sv_ops
= {
400 .svo_shutdown
= svc_rpcb_cleanup
,
401 .svo_enqueue_xprt
= svc_xprt_do_enqueue
,
404 static struct svc_serv
*lockd_create_svc(void)
406 struct svc_serv
*serv
;
409 * Check whether we're already up and running.
413 * Note: increase service usage, because later in case of error
414 * svc_destroy() will be called.
416 svc_get(nlmsvc_rqst
->rq_server
);
417 return nlmsvc_rqst
->rq_server
;
421 * Sanity check: if there's no pid,
422 * we should be the first user ...
426 "lockd_up: no pid, %d users??\n", nlmsvc_users
);
429 nlm_timeout
= LOCKD_DFLT_TIMEO
;
430 nlmsvc_timeout
= nlm_timeout
* HZ
;
432 serv
= svc_create(&nlmsvc_program
, LOCKD_BUFSIZE
, &lockd_sv_ops
);
434 printk(KERN_WARNING
"lockd_up: create service failed\n");
435 return ERR_PTR(-ENOMEM
);
437 register_inetaddr_notifier(&lockd_inetaddr_notifier
);
438 #if IS_ENABLED(CONFIG_IPV6)
439 register_inet6addr_notifier(&lockd_inet6addr_notifier
);
441 dprintk("lockd_up: service created\n");
446 * Bring up the lockd process if it's not already up.
448 int lockd_up(struct net
*net
)
450 struct svc_serv
*serv
;
453 mutex_lock(&nlmsvc_mutex
);
455 serv
= lockd_create_svc();
457 error
= PTR_ERR(serv
);
461 error
= lockd_up_net(serv
, net
);
465 error
= lockd_start_svc(serv
);
471 * Note: svc_serv structures have an initial use count of 1,
472 * so we exit through here on both success and failure.
477 mutex_unlock(&nlmsvc_mutex
);
481 lockd_down_net(serv
, net
);
483 lockd_unregister_notifiers();
486 EXPORT_SYMBOL_GPL(lockd_up
);
489 * Decrement the user count and bring down lockd if we're the last.
492 lockd_down(struct net
*net
)
494 mutex_lock(&nlmsvc_mutex
);
495 lockd_down_net(nlmsvc_rqst
->rq_server
, net
);
500 printk(KERN_ERR
"lockd_down: no users! task=%p\n",
506 printk(KERN_ERR
"lockd_down: no lockd running.\n");
509 kthread_stop(nlmsvc_task
);
510 dprintk("lockd_down: service stopped\n");
511 lockd_svc_exit_thread();
512 dprintk("lockd_down: service destroyed\n");
516 mutex_unlock(&nlmsvc_mutex
);
518 EXPORT_SYMBOL_GPL(lockd_down
);
523 * Sysctl parameters (same as module parameters, different interface).
526 static struct ctl_table nlm_sysctls
[] = {
528 .procname
= "nlm_grace_period",
529 .data
= &nlm_grace_period
,
530 .maxlen
= sizeof(unsigned long),
532 .proc_handler
= proc_doulongvec_minmax
,
533 .extra1
= (unsigned long *) &nlm_grace_period_min
,
534 .extra2
= (unsigned long *) &nlm_grace_period_max
,
537 .procname
= "nlm_timeout",
538 .data
= &nlm_timeout
,
539 .maxlen
= sizeof(unsigned long),
541 .proc_handler
= proc_doulongvec_minmax
,
542 .extra1
= (unsigned long *) &nlm_timeout_min
,
543 .extra2
= (unsigned long *) &nlm_timeout_max
,
546 .procname
= "nlm_udpport",
547 .data
= &nlm_udpport
,
548 .maxlen
= sizeof(int),
550 .proc_handler
= proc_dointvec_minmax
,
551 .extra1
= (int *) &nlm_port_min
,
552 .extra2
= (int *) &nlm_port_max
,
555 .procname
= "nlm_tcpport",
556 .data
= &nlm_tcpport
,
557 .maxlen
= sizeof(int),
559 .proc_handler
= proc_dointvec_minmax
,
560 .extra1
= (int *) &nlm_port_min
,
561 .extra2
= (int *) &nlm_port_max
,
564 .procname
= "nsm_use_hostnames",
565 .data
= &nsm_use_hostnames
,
566 .maxlen
= sizeof(int),
568 .proc_handler
= proc_dointvec
,
571 .procname
= "nsm_local_state",
572 .data
= &nsm_local_state
,
573 .maxlen
= sizeof(int),
575 .proc_handler
= proc_dointvec
,
580 static struct ctl_table nlm_sysctl_dir
[] = {
584 .child
= nlm_sysctls
,
589 static struct ctl_table nlm_sysctl_root
[] = {
593 .child
= nlm_sysctl_dir
,
598 #endif /* CONFIG_SYSCTL */
601 * Module (and sysfs) parameters.
604 #define param_set_min_max(name, type, which_strtol, min, max) \
605 static int param_set_##name(const char *val, struct kernel_param *kp) \
608 __typeof__(type) num = which_strtol(val, &endp, 0); \
609 if (endp == val || *endp || num < (min) || num > (max)) \
611 *((type *) kp->arg) = num; \
615 static inline int is_callback(u32 proc
)
617 return proc
== NLMPROC_GRANTED
618 || proc
== NLMPROC_GRANTED_MSG
619 || proc
== NLMPROC_TEST_RES
620 || proc
== NLMPROC_LOCK_RES
621 || proc
== NLMPROC_CANCEL_RES
622 || proc
== NLMPROC_UNLOCK_RES
623 || proc
== NLMPROC_NSM_NOTIFY
;
627 static int lockd_authenticate(struct svc_rqst
*rqstp
)
629 rqstp
->rq_client
= NULL
;
630 switch (rqstp
->rq_authop
->flavour
) {
633 if (rqstp
->rq_proc
== 0)
635 if (is_callback(rqstp
->rq_proc
)) {
636 /* Leave it to individual procedures to
637 * call nlmsvc_lookup_host(rqstp)
641 return svc_set_client(rqstp
);
647 param_set_min_max(port
, int, simple_strtol
, 0, 65535)
648 param_set_min_max(grace_period
, unsigned long, simple_strtoul
,
649 nlm_grace_period_min
, nlm_grace_period_max
)
650 param_set_min_max(timeout
, unsigned long, simple_strtoul
,
651 nlm_timeout_min
, nlm_timeout_max
)
653 MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
654 MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION
".");
655 MODULE_LICENSE("GPL");
657 module_param_call(nlm_grace_period
, param_set_grace_period
, param_get_ulong
,
658 &nlm_grace_period
, 0644);
659 module_param_call(nlm_timeout
, param_set_timeout
, param_get_ulong
,
661 module_param_call(nlm_udpport
, param_set_port
, param_get_int
,
663 module_param_call(nlm_tcpport
, param_set_port
, param_get_int
,
665 module_param(nsm_use_hostnames
, bool, 0644);
666 module_param(nlm_max_connections
, uint
, 0644);
668 static int lockd_init_net(struct net
*net
)
670 struct lockd_net
*ln
= net_generic(net
, lockd_net_id
);
672 INIT_DELAYED_WORK(&ln
->grace_period_end
, grace_ender
);
673 INIT_LIST_HEAD(&ln
->lockd_manager
.list
);
674 ln
->lockd_manager
.block_opens
= false;
675 INIT_LIST_HEAD(&ln
->nsm_handles
);
679 static void lockd_exit_net(struct net
*net
)
683 static struct pernet_operations lockd_net_ops
= {
684 .init
= lockd_init_net
,
685 .exit
= lockd_exit_net
,
687 .size
= sizeof(struct lockd_net
),
692 * Initialising and terminating the module.
695 static int __init
init_nlm(void)
701 nlm_sysctl_table
= register_sysctl_table(nlm_sysctl_root
);
702 if (nlm_sysctl_table
== NULL
)
705 err
= register_pernet_subsys(&lockd_net_ops
);
709 err
= lockd_create_procfs();
716 unregister_pernet_subsys(&lockd_net_ops
);
719 unregister_sysctl_table(nlm_sysctl_table
);
725 static void __exit
exit_nlm(void)
727 /* FIXME: delete all NLM clients */
728 nlm_shutdown_hosts();
729 lockd_remove_procfs();
730 unregister_pernet_subsys(&lockd_net_ops
);
732 unregister_sysctl_table(nlm_sysctl_table
);
736 module_init(init_nlm
);
737 module_exit(exit_nlm
);
740 * Define NLM program and procedures
742 static unsigned int nlmsvc_version1_count
[17];
743 static const struct svc_version nlmsvc_version1
= {
746 .vs_proc
= nlmsvc_procedures
,
747 .vs_count
= nlmsvc_version1_count
,
748 .vs_xdrsize
= NLMSVC_XDRSIZE
,
750 static unsigned int nlmsvc_version3_count
[24];
751 static const struct svc_version nlmsvc_version3
= {
754 .vs_proc
= nlmsvc_procedures
,
755 .vs_count
= nlmsvc_version3_count
,
756 .vs_xdrsize
= NLMSVC_XDRSIZE
,
758 #ifdef CONFIG_LOCKD_V4
759 static unsigned int nlmsvc_version4_count
[24];
760 static const struct svc_version nlmsvc_version4
= {
763 .vs_proc
= nlmsvc_procedures4
,
764 .vs_count
= nlmsvc_version4_count
,
765 .vs_xdrsize
= NLMSVC_XDRSIZE
,
768 static const struct svc_version
*nlmsvc_version
[] = {
769 [1] = &nlmsvc_version1
,
770 [3] = &nlmsvc_version3
,
771 #ifdef CONFIG_LOCKD_V4
772 [4] = &nlmsvc_version4
,
776 static struct svc_stat nlmsvc_stats
;
778 #define NLM_NRVERS ARRAY_SIZE(nlmsvc_version)
779 static struct svc_program nlmsvc_program
= {
780 .pg_prog
= NLM_PROGRAM
, /* program number */
781 .pg_nvers
= NLM_NRVERS
, /* number of entries in nlmsvc_version */
782 .pg_vers
= nlmsvc_version
, /* version table */
783 .pg_name
= "lockd", /* service name */
784 .pg_class
= "nfsd", /* share authentication with nfsd */
785 .pg_stats
= &nlmsvc_stats
, /* stats table */
786 .pg_authenticate
= &lockd_authenticate
/* export authentication */