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>
40 #define NLMDBG_FACILITY NLMDBG_SVC
41 #define LOCKD_BUFSIZE (1024 + NLMSVC_XDRSIZE)
42 #define ALLOWED_SIGS (sigmask(SIGKILL))
44 static struct svc_program nlmsvc_program;
46 struct nlmsvc_binding * nlmsvc_ops;
47 EXPORT_SYMBOL_GPL(nlmsvc_ops);
49 static DEFINE_MUTEX(nlmsvc_mutex);
50 static unsigned int nlmsvc_users;
51 static struct task_struct *nlmsvc_task;
52 static struct svc_rqst *nlmsvc_rqst;
53 unsigned long nlmsvc_timeout;
58 * These can be set at insmod time (useful for NFS as root filesystem),
59 * and also changed through the sysctl interface. -- Jamie Lokier, Aug 2003
61 static unsigned long nlm_grace_period;
62 static unsigned long nlm_timeout = LOCKD_DFLT_TIMEO;
63 static int nlm_udpport, nlm_tcpport;
65 /* RLIM_NOFILE defaults to 1024. That seems like a reasonable default here. */
66 static unsigned int nlm_max_connections = 1024;
69 * Constants needed for the sysctl interface.
71 static const unsigned long nlm_grace_period_min = 0;
72 static const unsigned long nlm_grace_period_max = 240;
73 static const unsigned long nlm_timeout_min = 3;
74 static const unsigned long nlm_timeout_max = 20;
75 static const int nlm_port_min = 0, nlm_port_max = 65535;
78 static struct ctl_table_header * nlm_sysctl_table;
81 static unsigned long get_lockd_grace_period(void)
83 /* Note: nlm_timeout should always be nonzero */
85 return roundup(nlm_grace_period, nlm_timeout) * HZ;
87 return nlm_timeout * 5 * HZ;
90 static void grace_ender(struct work_struct *grace)
92 struct delayed_work *dwork = container_of(grace, struct delayed_work,
94 struct lockd_net *ln = container_of(dwork, struct lockd_net,
97 locks_end_grace(&ln->lockd_manager);
100 static void set_grace_period(struct net *net)
102 unsigned long grace_period = get_lockd_grace_period();
103 struct lockd_net *ln = net_generic(net, lockd_net_id);
105 locks_start_grace(net, &ln->lockd_manager);
106 cancel_delayed_work_sync(&ln->grace_period_end);
107 schedule_delayed_work(&ln->grace_period_end, grace_period);
110 static void restart_grace(void)
113 struct net *net = &init_net;
114 struct lockd_net *ln = net_generic(net, lockd_net_id);
116 cancel_delayed_work_sync(&ln->grace_period_end);
117 locks_end_grace(&ln->lockd_manager);
118 nlmsvc_invalidate_all();
119 set_grace_period(net);
124 * This is the lockd kernel thread
130 struct svc_rqst *rqstp = vrqstp;
132 /* try_to_freeze() is called from svc_recv() */
135 /* Allow SIGKILL to tell lockd to drop all of its locks */
136 allow_signal(SIGKILL);
138 dprintk("NFS locking service started (ver " LOCKD_VERSION ").\n");
141 nlm_timeout = LOCKD_DFLT_TIMEO;
142 nlmsvc_timeout = nlm_timeout * HZ;
145 * The main request loop. We don't terminate until the last
146 * NFS mount or NFS daemon has gone away.
148 while (!kthread_should_stop()) {
149 long timeout = MAX_SCHEDULE_TIMEOUT;
150 RPC_IFDEBUG(char buf[RPC_MAX_ADDRBUFLEN]);
152 /* update sv_maxconn if it has changed */
153 rqstp->rq_server->sv_maxconn = nlm_max_connections;
156 flush_signals(current);
161 timeout = nlmsvc_retry_blocked();
164 * Find a socket with data available and call its
167 err = svc_recv(rqstp, timeout);
168 if (err == -EAGAIN || err == -EINTR)
170 dprintk("lockd: request from %s\n",
171 svc_print_addr(rqstp, buf, sizeof(buf)));
175 flush_signals(current);
177 nlmsvc_invalidate_all();
178 nlm_shutdown_hosts();
182 static int create_lockd_listener(struct svc_serv *serv, const char *name,
183 struct net *net, const int family,
184 const unsigned short port)
186 struct svc_xprt *xprt;
188 xprt = svc_find_xprt(serv, name, net, family, 0);
190 return svc_create_xprt(serv, name, net, family, port,
196 static int create_lockd_family(struct svc_serv *serv, struct net *net,
201 err = create_lockd_listener(serv, "udp", net, family, nlm_udpport);
205 return create_lockd_listener(serv, "tcp", net, family, nlm_tcpport);
209 * Ensure there are active UDP and TCP listeners for lockd.
211 * Even if we have only TCP NFS mounts and/or TCP NFSDs, some
212 * local services (such as rpc.statd) still require UDP, and
213 * some NFS servers do not yet support NLM over TCP.
215 * Returns zero if all listeners are available; otherwise a
216 * negative errno value is returned.
218 static int make_socks(struct svc_serv *serv, struct net *net)
223 err = create_lockd_family(serv, net, PF_INET);
227 err = create_lockd_family(serv, net, PF_INET6);
228 if (err < 0 && err != -EAFNOSUPPORT)
237 "lockd_up: makesock failed, error=%d\n", err);
241 static int lockd_up_net(struct svc_serv *serv, struct net *net)
243 struct lockd_net *ln = net_generic(net, lockd_net_id);
246 if (ln->nlmsvc_users++)
249 error = svc_bind(serv, net);
253 error = make_socks(serv, net);
256 set_grace_period(net);
257 dprintk("lockd_up_net: per-net data created; net=%p\n", net);
261 svc_rpcb_cleanup(serv, 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_start_svc(struct svc_serv *serv)
294 * Create the kernel thread and wait for it to start.
296 nlmsvc_rqst = svc_prepare_thread(serv, &serv->sv_pools[0], NUMA_NO_NODE);
297 if (IS_ERR(nlmsvc_rqst)) {
298 error = PTR_ERR(nlmsvc_rqst);
300 "lockd_up: svc_rqst allocation failed, error=%d\n",
305 svc_sock_update_bufs(serv);
306 serv->sv_maxconn = nlm_max_connections;
308 nlmsvc_task = kthread_run(lockd, nlmsvc_rqst, serv->sv_name);
309 if (IS_ERR(nlmsvc_task)) {
310 error = PTR_ERR(nlmsvc_task);
312 "lockd_up: kthread_run failed, error=%d\n", error);
315 dprintk("lockd_up: service started\n");
319 svc_exit_thread(nlmsvc_rqst);
326 static struct svc_serv *lockd_create_svc(void)
328 struct svc_serv *serv;
331 * Check whether we're already up and running.
335 * Note: increase service usage, because later in case of error
336 * svc_destroy() will be called.
338 svc_get(nlmsvc_rqst->rq_server);
339 return nlmsvc_rqst->rq_server;
343 * Sanity check: if there's no pid,
344 * we should be the first user ...
348 "lockd_up: no pid, %d users??\n", nlmsvc_users);
350 serv = svc_create(&nlmsvc_program, LOCKD_BUFSIZE, NULL);
352 printk(KERN_WARNING "lockd_up: create service failed\n");
353 return ERR_PTR(-ENOMEM);
355 dprintk("lockd_up: service created\n");
360 * Bring up the lockd process if it's not already up.
362 int lockd_up(struct net *net)
364 struct svc_serv *serv;
367 mutex_lock(&nlmsvc_mutex);
369 serv = lockd_create_svc();
371 error = PTR_ERR(serv);
375 error = lockd_up_net(serv, net);
379 error = lockd_start_svc(serv);
385 * Note: svc_serv structures have an initial use count of 1,
386 * so we exit through here on both success and failure.
391 mutex_unlock(&nlmsvc_mutex);
395 lockd_down_net(serv, net);
398 EXPORT_SYMBOL_GPL(lockd_up);
401 * Decrement the user count and bring down lockd if we're the last.
404 lockd_down(struct net *net)
406 mutex_lock(&nlmsvc_mutex);
407 lockd_down_net(nlmsvc_rqst->rq_server, net);
412 printk(KERN_ERR "lockd_down: no users! task=%p\n",
418 printk(KERN_ERR "lockd_down: no lockd running.\n");
421 kthread_stop(nlmsvc_task);
422 dprintk("lockd_down: service stopped\n");
423 svc_exit_thread(nlmsvc_rqst);
424 dprintk("lockd_down: service destroyed\n");
428 mutex_unlock(&nlmsvc_mutex);
430 EXPORT_SYMBOL_GPL(lockd_down);
435 * Sysctl parameters (same as module parameters, different interface).
438 static ctl_table nlm_sysctls[] = {
440 .procname = "nlm_grace_period",
441 .data = &nlm_grace_period,
442 .maxlen = sizeof(unsigned long),
444 .proc_handler = proc_doulongvec_minmax,
445 .extra1 = (unsigned long *) &nlm_grace_period_min,
446 .extra2 = (unsigned long *) &nlm_grace_period_max,
449 .procname = "nlm_timeout",
450 .data = &nlm_timeout,
451 .maxlen = sizeof(unsigned long),
453 .proc_handler = proc_doulongvec_minmax,
454 .extra1 = (unsigned long *) &nlm_timeout_min,
455 .extra2 = (unsigned long *) &nlm_timeout_max,
458 .procname = "nlm_udpport",
459 .data = &nlm_udpport,
460 .maxlen = sizeof(int),
462 .proc_handler = proc_dointvec_minmax,
463 .extra1 = (int *) &nlm_port_min,
464 .extra2 = (int *) &nlm_port_max,
467 .procname = "nlm_tcpport",
468 .data = &nlm_tcpport,
469 .maxlen = sizeof(int),
471 .proc_handler = proc_dointvec_minmax,
472 .extra1 = (int *) &nlm_port_min,
473 .extra2 = (int *) &nlm_port_max,
476 .procname = "nsm_use_hostnames",
477 .data = &nsm_use_hostnames,
478 .maxlen = sizeof(int),
480 .proc_handler = proc_dointvec,
483 .procname = "nsm_local_state",
484 .data = &nsm_local_state,
485 .maxlen = sizeof(int),
487 .proc_handler = proc_dointvec,
492 static ctl_table nlm_sysctl_dir[] = {
496 .child = nlm_sysctls,
501 static ctl_table nlm_sysctl_root[] = {
505 .child = nlm_sysctl_dir,
510 #endif /* CONFIG_SYSCTL */
513 * Module (and sysfs) parameters.
516 #define param_set_min_max(name, type, which_strtol, min, max) \
517 static int param_set_##name(const char *val, struct kernel_param *kp) \
520 __typeof__(type) num = which_strtol(val, &endp, 0); \
521 if (endp == val || *endp || num < (min) || num > (max)) \
523 *((type *) kp->arg) = num; \
527 static inline int is_callback(u32 proc)
529 return proc == NLMPROC_GRANTED
530 || proc == NLMPROC_GRANTED_MSG
531 || proc == NLMPROC_TEST_RES
532 || proc == NLMPROC_LOCK_RES
533 || proc == NLMPROC_CANCEL_RES
534 || proc == NLMPROC_UNLOCK_RES
535 || proc == NLMPROC_NSM_NOTIFY;
539 static int lockd_authenticate(struct svc_rqst *rqstp)
541 rqstp->rq_client = NULL;
542 switch (rqstp->rq_authop->flavour) {
545 if (rqstp->rq_proc == 0)
547 if (is_callback(rqstp->rq_proc)) {
548 /* Leave it to individual procedures to
549 * call nlmsvc_lookup_host(rqstp)
553 return svc_set_client(rqstp);
559 param_set_min_max(port, int, simple_strtol, 0, 65535)
560 param_set_min_max(grace_period, unsigned long, simple_strtoul,
561 nlm_grace_period_min, nlm_grace_period_max)
562 param_set_min_max(timeout, unsigned long, simple_strtoul,
563 nlm_timeout_min, nlm_timeout_max)
565 MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
566 MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION ".");
567 MODULE_LICENSE("GPL");
569 module_param_call(nlm_grace_period, param_set_grace_period, param_get_ulong,
570 &nlm_grace_period, 0644);
571 module_param_call(nlm_timeout, param_set_timeout, param_get_ulong,
573 module_param_call(nlm_udpport, param_set_port, param_get_int,
575 module_param_call(nlm_tcpport, param_set_port, param_get_int,
577 module_param(nsm_use_hostnames, bool, 0644);
578 module_param(nlm_max_connections, uint, 0644);
580 static int lockd_init_net(struct net *net)
582 struct lockd_net *ln = net_generic(net, lockd_net_id);
584 INIT_DELAYED_WORK(&ln->grace_period_end, grace_ender);
585 INIT_LIST_HEAD(&ln->grace_list);
586 spin_lock_init(&ln->nsm_clnt_lock);
590 static void lockd_exit_net(struct net *net)
594 static struct pernet_operations lockd_net_ops = {
595 .init = lockd_init_net,
596 .exit = lockd_exit_net,
598 .size = sizeof(struct lockd_net),
603 * Initialising and terminating the module.
606 static int __init init_nlm(void)
612 nlm_sysctl_table = register_sysctl_table(nlm_sysctl_root);
613 if (nlm_sysctl_table == NULL)
616 err = register_pernet_subsys(&lockd_net_ops);
623 unregister_sysctl_table(nlm_sysctl_table);
629 static void __exit exit_nlm(void)
631 /* FIXME: delete all NLM clients */
632 nlm_shutdown_hosts();
633 unregister_pernet_subsys(&lockd_net_ops);
635 unregister_sysctl_table(nlm_sysctl_table);
639 module_init(init_nlm);
640 module_exit(exit_nlm);
643 * Define NLM program and procedures
645 static struct svc_version nlmsvc_version1 = {
648 .vs_proc = nlmsvc_procedures,
649 .vs_xdrsize = NLMSVC_XDRSIZE,
651 static struct svc_version nlmsvc_version3 = {
654 .vs_proc = nlmsvc_procedures,
655 .vs_xdrsize = NLMSVC_XDRSIZE,
657 #ifdef CONFIG_LOCKD_V4
658 static struct svc_version nlmsvc_version4 = {
661 .vs_proc = nlmsvc_procedures4,
662 .vs_xdrsize = NLMSVC_XDRSIZE,
665 static struct svc_version * nlmsvc_version[] = {
666 [1] = &nlmsvc_version1,
667 [3] = &nlmsvc_version3,
668 #ifdef CONFIG_LOCKD_V4
669 [4] = &nlmsvc_version4,
673 static struct svc_stat nlmsvc_stats;
675 #define NLM_NRVERS ARRAY_SIZE(nlmsvc_version)
676 static struct svc_program nlmsvc_program = {
677 .pg_prog = NLM_PROGRAM, /* program number */
678 .pg_nvers = NLM_NRVERS, /* number of entries in nlmsvc_version */
679 .pg_vers = nlmsvc_version, /* version table */
680 .pg_name = "lockd", /* service name */
681 .pg_class = "nfsd", /* share authentication with nfsd */
682 .pg_stats = &nlmsvc_stats, /* stats table */
683 .pg_authenticate = &lockd_authenticate /* export authentication */