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>
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>
35 #include <linux/lockd/lockd.h>
36 #include <linux/nfs.h>
41 #define NLMDBG_FACILITY NLMDBG_SVC
42 #define LOCKD_BUFSIZE (1024 + NLMSVC_XDRSIZE)
43 #define ALLOWED_SIGS (sigmask(SIGKILL))
45 static struct svc_program nlmsvc_program;
47 struct nlmsvc_binding * nlmsvc_ops;
48 EXPORT_SYMBOL_GPL(nlmsvc_ops);
50 static DEFINE_MUTEX(nlmsvc_mutex);
51 static unsigned int nlmsvc_users;
52 static struct task_struct *nlmsvc_task;
53 static struct svc_rqst *nlmsvc_rqst;
54 unsigned long nlmsvc_timeout;
59 * These can be set at insmod time (useful for NFS as root filesystem),
60 * and also changed through the sysctl interface. -- Jamie Lokier, Aug 2003
62 static unsigned long nlm_grace_period;
63 static unsigned long nlm_timeout = LOCKD_DFLT_TIMEO;
64 static int nlm_udpport, nlm_tcpport;
66 /* RLIM_NOFILE defaults to 1024. That seems like a reasonable default here. */
67 static unsigned int nlm_max_connections = 1024;
70 * Constants needed for the sysctl interface.
72 static const unsigned long nlm_grace_period_min = 0;
73 static const unsigned long nlm_grace_period_max = 240;
74 static const unsigned long nlm_timeout_min = 3;
75 static const unsigned long nlm_timeout_max = 20;
76 static const int nlm_port_min = 0, nlm_port_max = 65535;
79 static struct ctl_table_header * nlm_sysctl_table;
82 static unsigned long get_lockd_grace_period(void)
84 /* Note: nlm_timeout should always be nonzero */
86 return roundup(nlm_grace_period, nlm_timeout) * HZ;
88 return nlm_timeout * 5 * HZ;
91 static void grace_ender(struct work_struct *grace)
93 struct delayed_work *dwork = container_of(grace, struct delayed_work,
95 struct lockd_net *ln = container_of(dwork, struct lockd_net,
98 locks_end_grace(&ln->lockd_manager);
101 static void set_grace_period(struct net *net)
103 unsigned long grace_period = get_lockd_grace_period();
104 struct lockd_net *ln = net_generic(net, lockd_net_id);
106 locks_start_grace(net, &ln->lockd_manager);
107 cancel_delayed_work_sync(&ln->grace_period_end);
108 schedule_delayed_work(&ln->grace_period_end, grace_period);
111 static void restart_grace(void)
114 struct net *net = &init_net;
115 struct lockd_net *ln = net_generic(net, lockd_net_id);
117 cancel_delayed_work_sync(&ln->grace_period_end);
118 locks_end_grace(&ln->lockd_manager);
119 nlmsvc_invalidate_all();
120 set_grace_period(net);
125 * This is the lockd kernel thread
131 struct svc_rqst *rqstp = vrqstp;
133 /* try_to_freeze() is called from svc_recv() */
136 /* Allow SIGKILL to tell lockd to drop all of its locks */
137 allow_signal(SIGKILL);
139 dprintk("NFS locking service started (ver " LOCKD_VERSION ").\n");
142 nlm_timeout = LOCKD_DFLT_TIMEO;
143 nlmsvc_timeout = nlm_timeout * HZ;
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);
263 svc_rpcb_cleanup(serv, net);
269 static void lockd_down_net(struct svc_serv *serv, struct net *net)
271 struct lockd_net *ln = net_generic(net, lockd_net_id);
273 if (ln->nlmsvc_users) {
274 if (--ln->nlmsvc_users == 0) {
275 nlm_shutdown_hosts_net(net);
276 cancel_delayed_work_sync(&ln->grace_period_end);
277 locks_end_grace(&ln->lockd_manager);
278 svc_shutdown_net(serv, net);
279 dprintk("lockd_down_net: per-net data destroyed; net=%p\n", net);
282 printk(KERN_ERR "lockd_down_net: no users! task=%p, net=%p\n",
288 static int lockd_start_svc(struct svc_serv *serv)
296 * Create the kernel thread and wait for it to start.
298 nlmsvc_rqst = svc_prepare_thread(serv, &serv->sv_pools[0], NUMA_NO_NODE);
299 if (IS_ERR(nlmsvc_rqst)) {
300 error = PTR_ERR(nlmsvc_rqst);
302 "lockd_up: svc_rqst allocation failed, error=%d\n",
307 svc_sock_update_bufs(serv);
308 serv->sv_maxconn = nlm_max_connections;
310 nlmsvc_task = kthread_create(lockd, nlmsvc_rqst, "%s", serv->sv_name);
311 if (IS_ERR(nlmsvc_task)) {
312 error = PTR_ERR(nlmsvc_task);
314 "lockd_up: kthread_run failed, error=%d\n", error);
317 nlmsvc_rqst->rq_task = nlmsvc_task;
318 wake_up_process(nlmsvc_task);
320 dprintk("lockd_up: service started\n");
324 svc_exit_thread(nlmsvc_rqst);
331 static struct svc_serv *lockd_create_svc(void)
333 struct svc_serv *serv;
336 * Check whether we're already up and running.
340 * Note: increase service usage, because later in case of error
341 * svc_destroy() will be called.
343 svc_get(nlmsvc_rqst->rq_server);
344 return nlmsvc_rqst->rq_server;
348 * Sanity check: if there's no pid,
349 * we should be the first user ...
353 "lockd_up: no pid, %d users??\n", nlmsvc_users);
355 serv = svc_create(&nlmsvc_program, LOCKD_BUFSIZE, NULL);
357 printk(KERN_WARNING "lockd_up: create service failed\n");
358 return ERR_PTR(-ENOMEM);
360 dprintk("lockd_up: service created\n");
365 * Bring up the lockd process if it's not already up.
367 int lockd_up(struct net *net)
369 struct svc_serv *serv;
372 mutex_lock(&nlmsvc_mutex);
374 serv = lockd_create_svc();
376 error = PTR_ERR(serv);
380 error = lockd_up_net(serv, net);
384 error = lockd_start_svc(serv);
390 * Note: svc_serv structures have an initial use count of 1,
391 * so we exit through here on both success and failure.
396 mutex_unlock(&nlmsvc_mutex);
400 lockd_down_net(serv, net);
403 EXPORT_SYMBOL_GPL(lockd_up);
406 * Decrement the user count and bring down lockd if we're the last.
409 lockd_down(struct net *net)
411 mutex_lock(&nlmsvc_mutex);
412 lockd_down_net(nlmsvc_rqst->rq_server, net);
417 printk(KERN_ERR "lockd_down: no users! task=%p\n",
423 printk(KERN_ERR "lockd_down: no lockd running.\n");
426 kthread_stop(nlmsvc_task);
427 dprintk("lockd_down: service stopped\n");
428 svc_exit_thread(nlmsvc_rqst);
429 dprintk("lockd_down: service destroyed\n");
433 mutex_unlock(&nlmsvc_mutex);
435 EXPORT_SYMBOL_GPL(lockd_down);
440 * Sysctl parameters (same as module parameters, different interface).
443 static struct ctl_table nlm_sysctls[] = {
445 .procname = "nlm_grace_period",
446 .data = &nlm_grace_period,
447 .maxlen = sizeof(unsigned long),
449 .proc_handler = proc_doulongvec_minmax,
450 .extra1 = (unsigned long *) &nlm_grace_period_min,
451 .extra2 = (unsigned long *) &nlm_grace_period_max,
454 .procname = "nlm_timeout",
455 .data = &nlm_timeout,
456 .maxlen = sizeof(unsigned long),
458 .proc_handler = proc_doulongvec_minmax,
459 .extra1 = (unsigned long *) &nlm_timeout_min,
460 .extra2 = (unsigned long *) &nlm_timeout_max,
463 .procname = "nlm_udpport",
464 .data = &nlm_udpport,
465 .maxlen = sizeof(int),
467 .proc_handler = proc_dointvec_minmax,
468 .extra1 = (int *) &nlm_port_min,
469 .extra2 = (int *) &nlm_port_max,
472 .procname = "nlm_tcpport",
473 .data = &nlm_tcpport,
474 .maxlen = sizeof(int),
476 .proc_handler = proc_dointvec_minmax,
477 .extra1 = (int *) &nlm_port_min,
478 .extra2 = (int *) &nlm_port_max,
481 .procname = "nsm_use_hostnames",
482 .data = &nsm_use_hostnames,
483 .maxlen = sizeof(int),
485 .proc_handler = proc_dointvec,
488 .procname = "nsm_local_state",
489 .data = &nsm_local_state,
490 .maxlen = sizeof(int),
492 .proc_handler = proc_dointvec,
497 static struct ctl_table nlm_sysctl_dir[] = {
501 .child = nlm_sysctls,
506 static struct ctl_table nlm_sysctl_root[] = {
510 .child = nlm_sysctl_dir,
515 #endif /* CONFIG_SYSCTL */
518 * Module (and sysfs) parameters.
521 #define param_set_min_max(name, type, which_strtol, min, max) \
522 static int param_set_##name(const char *val, struct kernel_param *kp) \
525 __typeof__(type) num = which_strtol(val, &endp, 0); \
526 if (endp == val || *endp || num < (min) || num > (max)) \
528 *((type *) kp->arg) = num; \
532 static inline int is_callback(u32 proc)
534 return proc == NLMPROC_GRANTED
535 || proc == NLMPROC_GRANTED_MSG
536 || proc == NLMPROC_TEST_RES
537 || proc == NLMPROC_LOCK_RES
538 || proc == NLMPROC_CANCEL_RES
539 || proc == NLMPROC_UNLOCK_RES
540 || proc == NLMPROC_NSM_NOTIFY;
544 static int lockd_authenticate(struct svc_rqst *rqstp)
546 rqstp->rq_client = NULL;
547 switch (rqstp->rq_authop->flavour) {
550 if (rqstp->rq_proc == 0)
552 if (is_callback(rqstp->rq_proc)) {
553 /* Leave it to individual procedures to
554 * call nlmsvc_lookup_host(rqstp)
558 return svc_set_client(rqstp);
564 param_set_min_max(port, int, simple_strtol, 0, 65535)
565 param_set_min_max(grace_period, unsigned long, simple_strtoul,
566 nlm_grace_period_min, nlm_grace_period_max)
567 param_set_min_max(timeout, unsigned long, simple_strtoul,
568 nlm_timeout_min, nlm_timeout_max)
570 MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
571 MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION ".");
572 MODULE_LICENSE("GPL");
574 module_param_call(nlm_grace_period, param_set_grace_period, param_get_ulong,
575 &nlm_grace_period, 0644);
576 module_param_call(nlm_timeout, param_set_timeout, param_get_ulong,
578 module_param_call(nlm_udpport, param_set_port, param_get_int,
580 module_param_call(nlm_tcpport, param_set_port, param_get_int,
582 module_param(nsm_use_hostnames, bool, 0644);
583 module_param(nlm_max_connections, uint, 0644);
585 static int lockd_init_net(struct net *net)
587 struct lockd_net *ln = net_generic(net, lockd_net_id);
589 INIT_DELAYED_WORK(&ln->grace_period_end, grace_ender);
590 INIT_LIST_HEAD(&ln->lockd_manager.list);
591 spin_lock_init(&ln->nsm_clnt_lock);
595 static void lockd_exit_net(struct net *net)
599 static struct pernet_operations lockd_net_ops = {
600 .init = lockd_init_net,
601 .exit = lockd_exit_net,
603 .size = sizeof(struct lockd_net),
608 * Initialising and terminating the module.
611 static int __init init_nlm(void)
617 nlm_sysctl_table = register_sysctl_table(nlm_sysctl_root);
618 if (nlm_sysctl_table == NULL)
621 err = register_pernet_subsys(&lockd_net_ops);
625 err = lockd_create_procfs();
632 unregister_pernet_subsys(&lockd_net_ops);
635 unregister_sysctl_table(nlm_sysctl_table);
641 static void __exit exit_nlm(void)
643 /* FIXME: delete all NLM clients */
644 nlm_shutdown_hosts();
645 lockd_remove_procfs();
646 unregister_pernet_subsys(&lockd_net_ops);
648 unregister_sysctl_table(nlm_sysctl_table);
652 module_init(init_nlm);
653 module_exit(exit_nlm);
656 * Define NLM program and procedures
658 static struct svc_version nlmsvc_version1 = {
661 .vs_proc = nlmsvc_procedures,
662 .vs_xdrsize = NLMSVC_XDRSIZE,
664 static struct svc_version nlmsvc_version3 = {
667 .vs_proc = nlmsvc_procedures,
668 .vs_xdrsize = NLMSVC_XDRSIZE,
670 #ifdef CONFIG_LOCKD_V4
671 static struct svc_version nlmsvc_version4 = {
674 .vs_proc = nlmsvc_procedures4,
675 .vs_xdrsize = NLMSVC_XDRSIZE,
678 static struct svc_version * nlmsvc_version[] = {
679 [1] = &nlmsvc_version1,
680 [3] = &nlmsvc_version3,
681 #ifdef CONFIG_LOCKD_V4
682 [4] = &nlmsvc_version4,
686 static struct svc_stat nlmsvc_stats;
688 #define NLM_NRVERS ARRAY_SIZE(nlmsvc_version)
689 static struct svc_program nlmsvc_program = {
690 .pg_prog = NLM_PROGRAM, /* program number */
691 .pg_nvers = NLM_NRVERS, /* number of entries in nlmsvc_version */
692 .pg_vers = nlmsvc_version, /* version table */
693 .pg_name = "lockd", /* service name */
694 .pg_class = "nfsd", /* share authentication with nfsd */
695 .pg_stats = &nlmsvc_stats, /* stats table */
696 .pg_authenticate = &lockd_authenticate /* export authentication */