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.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 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
;
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
= container_of(grace
, struct delayed_work
,
99 struct lockd_net
*ln
= container_of(dwork
, struct lockd_net
,
102 locks_end_grace(&ln
->lockd_manager
);
105 static void set_grace_period(struct net
*net
)
107 unsigned long grace_period
= get_lockd_grace_period();
108 struct lockd_net
*ln
= net_generic(net
, lockd_net_id
);
110 locks_start_grace(net
, &ln
->lockd_manager
);
111 cancel_delayed_work_sync(&ln
->grace_period_end
);
112 schedule_delayed_work(&ln
->grace_period_end
, grace_period
);
115 static void restart_grace(void)
118 struct net
*net
= &init_net
;
119 struct lockd_net
*ln
= net_generic(net
, lockd_net_id
);
121 cancel_delayed_work_sync(&ln
->grace_period_end
);
122 locks_end_grace(&ln
->lockd_manager
);
123 nlmsvc_invalidate_all();
124 set_grace_period(net
);
129 * This is the lockd kernel thread
135 struct svc_rqst
*rqstp
= vrqstp
;
137 /* try_to_freeze() is called from svc_recv() */
140 /* Allow SIGKILL to tell lockd to drop all of its locks */
141 allow_signal(SIGKILL
);
143 dprintk("NFS locking service started (ver " LOCKD_VERSION
").\n");
146 * The main request loop. We don't terminate until the last
147 * NFS mount or NFS daemon has gone away.
149 while (!kthread_should_stop()) {
150 long timeout
= MAX_SCHEDULE_TIMEOUT
;
151 RPC_IFDEBUG(char buf
[RPC_MAX_ADDRBUFLEN
]);
153 /* update sv_maxconn if it has changed */
154 rqstp
->rq_server
->sv_maxconn
= nlm_max_connections
;
157 flush_signals(current
);
162 timeout
= nlmsvc_retry_blocked();
165 * Find a socket with data available and call its
168 err
= svc_recv(rqstp
, timeout
);
169 if (err
== -EAGAIN
|| err
== -EINTR
)
171 dprintk("lockd: request from %s\n",
172 svc_print_addr(rqstp
, buf
, sizeof(buf
)));
176 flush_signals(current
);
178 nlmsvc_invalidate_all();
179 nlm_shutdown_hosts();
183 static int create_lockd_listener(struct svc_serv
*serv
, const char *name
,
184 struct net
*net
, const int family
,
185 const unsigned short port
)
187 struct svc_xprt
*xprt
;
189 xprt
= svc_find_xprt(serv
, name
, net
, family
, 0);
191 return svc_create_xprt(serv
, name
, net
, family
, port
,
197 static int create_lockd_family(struct svc_serv
*serv
, struct net
*net
,
202 err
= create_lockd_listener(serv
, "udp", net
, family
, nlm_udpport
);
206 return create_lockd_listener(serv
, "tcp", net
, family
, nlm_tcpport
);
210 * Ensure there are active UDP and TCP listeners for lockd.
212 * Even if we have only TCP NFS mounts and/or TCP NFSDs, some
213 * local services (such as rpc.statd) still require UDP, and
214 * some NFS servers do not yet support NLM over TCP.
216 * Returns zero if all listeners are available; otherwise a
217 * negative errno value is returned.
219 static int make_socks(struct svc_serv
*serv
, struct net
*net
)
224 err
= create_lockd_family(serv
, net
, PF_INET
);
228 err
= create_lockd_family(serv
, net
, PF_INET6
);
229 if (err
< 0 && err
!= -EAFNOSUPPORT
)
238 "lockd_up: makesock failed, error=%d\n", err
);
239 svc_shutdown_net(serv
, net
);
243 static int lockd_up_net(struct svc_serv
*serv
, struct net
*net
)
245 struct lockd_net
*ln
= net_generic(net
, lockd_net_id
);
248 if (ln
->nlmsvc_users
++)
251 error
= svc_bind(serv
, net
);
255 error
= make_socks(serv
, net
);
258 set_grace_period(net
);
259 dprintk("lockd_up_net: per-net data created; net=%p\n", net
);
267 static void lockd_down_net(struct svc_serv
*serv
, struct net
*net
)
269 struct lockd_net
*ln
= net_generic(net
, lockd_net_id
);
271 if (ln
->nlmsvc_users
) {
272 if (--ln
->nlmsvc_users
== 0) {
273 nlm_shutdown_hosts_net(net
);
274 cancel_delayed_work_sync(&ln
->grace_period_end
);
275 locks_end_grace(&ln
->lockd_manager
);
276 svc_shutdown_net(serv
, net
);
277 dprintk("lockd_down_net: per-net data destroyed; net=%p\n", net
);
280 printk(KERN_ERR
"lockd_down_net: no users! task=%p, net=%p\n",
286 static int lockd_inetaddr_event(struct notifier_block
*this,
287 unsigned long event
, void *ptr
)
289 struct in_ifaddr
*ifa
= (struct in_ifaddr
*)ptr
;
290 struct sockaddr_in sin
;
292 if (event
!= NETDEV_DOWN
)
296 dprintk("lockd_inetaddr_event: removed %pI4\n",
298 sin
.sin_family
= AF_INET
;
299 sin
.sin_addr
.s_addr
= ifa
->ifa_local
;
300 svc_age_temp_xprts_now(nlmsvc_rqst
->rq_server
,
301 (struct sockaddr
*)&sin
);
308 static struct notifier_block lockd_inetaddr_notifier
= {
309 .notifier_call
= lockd_inetaddr_event
,
312 #if IS_ENABLED(CONFIG_IPV6)
313 static int lockd_inet6addr_event(struct notifier_block
*this,
314 unsigned long event
, void *ptr
)
316 struct inet6_ifaddr
*ifa
= (struct inet6_ifaddr
*)ptr
;
317 struct sockaddr_in6 sin6
;
319 if (event
!= NETDEV_DOWN
)
323 dprintk("lockd_inet6addr_event: removed %pI6\n", &ifa
->addr
);
324 sin6
.sin6_family
= AF_INET6
;
325 sin6
.sin6_addr
= ifa
->addr
;
326 svc_age_temp_xprts_now(nlmsvc_rqst
->rq_server
,
327 (struct sockaddr
*)&sin6
);
334 static struct notifier_block lockd_inet6addr_notifier
= {
335 .notifier_call
= lockd_inet6addr_event
,
339 static void lockd_svc_exit_thread(void)
341 unregister_inetaddr_notifier(&lockd_inetaddr_notifier
);
342 #if IS_ENABLED(CONFIG_IPV6)
343 unregister_inet6addr_notifier(&lockd_inet6addr_notifier
);
345 svc_exit_thread(nlmsvc_rqst
);
348 static int lockd_start_svc(struct svc_serv
*serv
)
356 * Create the kernel thread and wait for it to start.
358 nlmsvc_rqst
= svc_prepare_thread(serv
, &serv
->sv_pools
[0], NUMA_NO_NODE
);
359 if (IS_ERR(nlmsvc_rqst
)) {
360 error
= PTR_ERR(nlmsvc_rqst
);
362 "lockd_up: svc_rqst allocation failed, error=%d\n",
367 svc_sock_update_bufs(serv
);
368 serv
->sv_maxconn
= nlm_max_connections
;
370 nlmsvc_task
= kthread_create(lockd
, nlmsvc_rqst
, "%s", serv
->sv_name
);
371 if (IS_ERR(nlmsvc_task
)) {
372 error
= PTR_ERR(nlmsvc_task
);
374 "lockd_up: kthread_run failed, error=%d\n", error
);
377 nlmsvc_rqst
->rq_task
= nlmsvc_task
;
378 wake_up_process(nlmsvc_task
);
380 dprintk("lockd_up: service started\n");
384 lockd_svc_exit_thread();
391 static struct svc_serv_ops lockd_sv_ops
= {
392 .svo_shutdown
= svc_rpcb_cleanup
,
393 .svo_enqueue_xprt
= svc_xprt_do_enqueue
,
396 static struct svc_serv
*lockd_create_svc(void)
398 struct svc_serv
*serv
;
401 * Check whether we're already up and running.
405 * Note: increase service usage, because later in case of error
406 * svc_destroy() will be called.
408 svc_get(nlmsvc_rqst
->rq_server
);
409 return nlmsvc_rqst
->rq_server
;
413 * Sanity check: if there's no pid,
414 * we should be the first user ...
418 "lockd_up: no pid, %d users??\n", nlmsvc_users
);
421 nlm_timeout
= LOCKD_DFLT_TIMEO
;
422 nlmsvc_timeout
= nlm_timeout
* HZ
;
424 serv
= svc_create(&nlmsvc_program
, LOCKD_BUFSIZE
, &lockd_sv_ops
);
426 printk(KERN_WARNING
"lockd_up: create service failed\n");
427 return ERR_PTR(-ENOMEM
);
429 register_inetaddr_notifier(&lockd_inetaddr_notifier
);
430 #if IS_ENABLED(CONFIG_IPV6)
431 register_inet6addr_notifier(&lockd_inet6addr_notifier
);
433 dprintk("lockd_up: service created\n");
438 * Bring up the lockd process if it's not already up.
440 int lockd_up(struct net
*net
)
442 struct svc_serv
*serv
;
445 mutex_lock(&nlmsvc_mutex
);
447 serv
= lockd_create_svc();
449 error
= PTR_ERR(serv
);
453 error
= lockd_up_net(serv
, net
);
457 error
= lockd_start_svc(serv
);
463 * Note: svc_serv structures have an initial use count of 1,
464 * so we exit through here on both success and failure.
469 mutex_unlock(&nlmsvc_mutex
);
473 lockd_down_net(serv
, net
);
476 EXPORT_SYMBOL_GPL(lockd_up
);
479 * Decrement the user count and bring down lockd if we're the last.
482 lockd_down(struct net
*net
)
484 mutex_lock(&nlmsvc_mutex
);
485 lockd_down_net(nlmsvc_rqst
->rq_server
, net
);
490 printk(KERN_ERR
"lockd_down: no users! task=%p\n",
496 printk(KERN_ERR
"lockd_down: no lockd running.\n");
499 kthread_stop(nlmsvc_task
);
500 dprintk("lockd_down: service stopped\n");
501 lockd_svc_exit_thread();
502 dprintk("lockd_down: service destroyed\n");
506 mutex_unlock(&nlmsvc_mutex
);
508 EXPORT_SYMBOL_GPL(lockd_down
);
513 * Sysctl parameters (same as module parameters, different interface).
516 static struct ctl_table nlm_sysctls
[] = {
518 .procname
= "nlm_grace_period",
519 .data
= &nlm_grace_period
,
520 .maxlen
= sizeof(unsigned long),
522 .proc_handler
= proc_doulongvec_minmax
,
523 .extra1
= (unsigned long *) &nlm_grace_period_min
,
524 .extra2
= (unsigned long *) &nlm_grace_period_max
,
527 .procname
= "nlm_timeout",
528 .data
= &nlm_timeout
,
529 .maxlen
= sizeof(unsigned long),
531 .proc_handler
= proc_doulongvec_minmax
,
532 .extra1
= (unsigned long *) &nlm_timeout_min
,
533 .extra2
= (unsigned long *) &nlm_timeout_max
,
536 .procname
= "nlm_udpport",
537 .data
= &nlm_udpport
,
538 .maxlen
= sizeof(int),
540 .proc_handler
= proc_dointvec_minmax
,
541 .extra1
= (int *) &nlm_port_min
,
542 .extra2
= (int *) &nlm_port_max
,
545 .procname
= "nlm_tcpport",
546 .data
= &nlm_tcpport
,
547 .maxlen
= sizeof(int),
549 .proc_handler
= proc_dointvec_minmax
,
550 .extra1
= (int *) &nlm_port_min
,
551 .extra2
= (int *) &nlm_port_max
,
554 .procname
= "nsm_use_hostnames",
555 .data
= &nsm_use_hostnames
,
556 .maxlen
= sizeof(int),
558 .proc_handler
= proc_dointvec
,
561 .procname
= "nsm_local_state",
562 .data
= &nsm_local_state
,
563 .maxlen
= sizeof(int),
565 .proc_handler
= proc_dointvec
,
570 static struct ctl_table nlm_sysctl_dir
[] = {
574 .child
= nlm_sysctls
,
579 static struct ctl_table nlm_sysctl_root
[] = {
583 .child
= nlm_sysctl_dir
,
588 #endif /* CONFIG_SYSCTL */
591 * Module (and sysfs) parameters.
594 #define param_set_min_max(name, type, which_strtol, min, max) \
595 static int param_set_##name(const char *val, struct kernel_param *kp) \
598 __typeof__(type) num = which_strtol(val, &endp, 0); \
599 if (endp == val || *endp || num < (min) || num > (max)) \
601 *((type *) kp->arg) = num; \
605 static inline int is_callback(u32 proc
)
607 return proc
== NLMPROC_GRANTED
608 || proc
== NLMPROC_GRANTED_MSG
609 || proc
== NLMPROC_TEST_RES
610 || proc
== NLMPROC_LOCK_RES
611 || proc
== NLMPROC_CANCEL_RES
612 || proc
== NLMPROC_UNLOCK_RES
613 || proc
== NLMPROC_NSM_NOTIFY
;
617 static int lockd_authenticate(struct svc_rqst
*rqstp
)
619 rqstp
->rq_client
= NULL
;
620 switch (rqstp
->rq_authop
->flavour
) {
623 if (rqstp
->rq_proc
== 0)
625 if (is_callback(rqstp
->rq_proc
)) {
626 /* Leave it to individual procedures to
627 * call nlmsvc_lookup_host(rqstp)
631 return svc_set_client(rqstp
);
637 param_set_min_max(port
, int, simple_strtol
, 0, 65535)
638 param_set_min_max(grace_period
, unsigned long, simple_strtoul
,
639 nlm_grace_period_min
, nlm_grace_period_max
)
640 param_set_min_max(timeout
, unsigned long, simple_strtoul
,
641 nlm_timeout_min
, nlm_timeout_max
)
643 MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
644 MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION
".");
645 MODULE_LICENSE("GPL");
647 module_param_call(nlm_grace_period
, param_set_grace_period
, param_get_ulong
,
648 &nlm_grace_period
, 0644);
649 module_param_call(nlm_timeout
, param_set_timeout
, param_get_ulong
,
651 module_param_call(nlm_udpport
, param_set_port
, param_get_int
,
653 module_param_call(nlm_tcpport
, param_set_port
, param_get_int
,
655 module_param(nsm_use_hostnames
, bool, 0644);
656 module_param(nlm_max_connections
, uint
, 0644);
658 static int lockd_init_net(struct net
*net
)
660 struct lockd_net
*ln
= net_generic(net
, lockd_net_id
);
662 INIT_DELAYED_WORK(&ln
->grace_period_end
, grace_ender
);
663 INIT_LIST_HEAD(&ln
->lockd_manager
.list
);
664 ln
->lockd_manager
.block_opens
= false;
665 INIT_LIST_HEAD(&ln
->nsm_handles
);
669 static void lockd_exit_net(struct net
*net
)
673 static struct pernet_operations lockd_net_ops
= {
674 .init
= lockd_init_net
,
675 .exit
= lockd_exit_net
,
677 .size
= sizeof(struct lockd_net
),
682 * Initialising and terminating the module.
685 static int __init
init_nlm(void)
691 nlm_sysctl_table
= register_sysctl_table(nlm_sysctl_root
);
692 if (nlm_sysctl_table
== NULL
)
695 err
= register_pernet_subsys(&lockd_net_ops
);
699 err
= lockd_create_procfs();
706 unregister_pernet_subsys(&lockd_net_ops
);
709 unregister_sysctl_table(nlm_sysctl_table
);
715 static void __exit
exit_nlm(void)
717 /* FIXME: delete all NLM clients */
718 nlm_shutdown_hosts();
719 lockd_remove_procfs();
720 unregister_pernet_subsys(&lockd_net_ops
);
722 unregister_sysctl_table(nlm_sysctl_table
);
726 module_init(init_nlm
);
727 module_exit(exit_nlm
);
730 * Define NLM program and procedures
732 static struct svc_version nlmsvc_version1
= {
735 .vs_proc
= nlmsvc_procedures
,
736 .vs_xdrsize
= NLMSVC_XDRSIZE
,
738 static struct svc_version nlmsvc_version3
= {
741 .vs_proc
= nlmsvc_procedures
,
742 .vs_xdrsize
= NLMSVC_XDRSIZE
,
744 #ifdef CONFIG_LOCKD_V4
745 static struct svc_version nlmsvc_version4
= {
748 .vs_proc
= nlmsvc_procedures4
,
749 .vs_xdrsize
= NLMSVC_XDRSIZE
,
752 static struct svc_version
* nlmsvc_version
[] = {
753 [1] = &nlmsvc_version1
,
754 [3] = &nlmsvc_version3
,
755 #ifdef CONFIG_LOCKD_V4
756 [4] = &nlmsvc_version4
,
760 static struct svc_stat nlmsvc_stats
;
762 #define NLM_NRVERS ARRAY_SIZE(nlmsvc_version)
763 static struct svc_program nlmsvc_program
= {
764 .pg_prog
= NLM_PROGRAM
, /* program number */
765 .pg_nvers
= NLM_NRVERS
, /* number of entries in nlmsvc_version */
766 .pg_vers
= nlmsvc_version
, /* version table */
767 .pg_name
= "lockd", /* service name */
768 .pg_class
= "nfsd", /* share authentication with nfsd */
769 .pg_stats
= &nlmsvc_stats
, /* stats table */
770 .pg_authenticate
= &lockd_authenticate
/* export authentication */