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 struct lock_manager lockd_manager = {
93 static void grace_ender(struct work_struct *not_used)
95 locks_end_grace(&lockd_manager);
98 static DECLARE_DELAYED_WORK(grace_period_end, grace_ender);
100 static void set_grace_period(void)
102 unsigned long grace_period = get_lockd_grace_period();
104 locks_start_grace(&lockd_manager);
105 cancel_delayed_work_sync(&grace_period_end);
106 schedule_delayed_work(&grace_period_end, grace_period);
109 static void restart_grace(void)
112 cancel_delayed_work_sync(&grace_period_end);
113 locks_end_grace(&lockd_manager);
114 nlmsvc_invalidate_all();
120 * This is the lockd kernel thread
125 int err = 0, preverr = 0;
126 struct svc_rqst *rqstp = vrqstp;
128 /* try_to_freeze() is called from svc_recv() */
131 /* Allow SIGKILL to tell lockd to drop all of its locks */
132 allow_signal(SIGKILL);
134 dprintk("NFS locking service started (ver " LOCKD_VERSION ").\n");
137 nlm_timeout = LOCKD_DFLT_TIMEO;
138 nlmsvc_timeout = nlm_timeout * HZ;
143 * The main request loop. We don't terminate until the last
144 * NFS mount or NFS daemon has gone away.
146 while (!kthread_should_stop()) {
147 long timeout = MAX_SCHEDULE_TIMEOUT;
148 RPC_IFDEBUG(char buf[RPC_MAX_ADDRBUFLEN]);
150 /* update sv_maxconn if it has changed */
151 rqstp->rq_server->sv_maxconn = nlm_max_connections;
154 flush_signals(current);
159 timeout = nlmsvc_retry_blocked();
162 * Find a socket with data available and call its
165 err = svc_recv(rqstp, timeout);
166 if (err == -EAGAIN || err == -EINTR) {
171 if (err != preverr) {
172 printk(KERN_WARNING "%s: unexpected error "
173 "from svc_recv (%d)\n", __func__, err);
176 schedule_timeout_interruptible(HZ);
181 dprintk("lockd: request from %s\n",
182 svc_print_addr(rqstp, buf, sizeof(buf)));
186 flush_signals(current);
187 cancel_delayed_work_sync(&grace_period_end);
188 locks_end_grace(&lockd_manager);
190 nlmsvc_invalidate_all();
191 nlm_shutdown_hosts();
195 static int create_lockd_listener(struct svc_serv *serv, const char *name,
196 struct net *net, const int family,
197 const unsigned short port)
199 struct svc_xprt *xprt;
201 xprt = svc_find_xprt(serv, name, net, family, 0);
203 return svc_create_xprt(serv, name, net, family, port,
209 static int create_lockd_family(struct svc_serv *serv, struct net *net,
214 err = create_lockd_listener(serv, "udp", net, family, nlm_udpport);
218 return create_lockd_listener(serv, "tcp", net, family, nlm_tcpport);
222 * Ensure there are active UDP and TCP listeners for lockd.
224 * Even if we have only TCP NFS mounts and/or TCP NFSDs, some
225 * local services (such as rpc.statd) still require UDP, and
226 * some NFS servers do not yet support NLM over TCP.
228 * Returns zero if all listeners are available; otherwise a
229 * negative errno value is returned.
231 static int make_socks(struct svc_serv *serv, struct net *net)
236 err = create_lockd_family(serv, net, PF_INET);
240 err = create_lockd_family(serv, net, PF_INET6);
241 if (err < 0 && err != -EAFNOSUPPORT)
250 "lockd_up: makesock failed, error=%d\n", err);
254 static int lockd_up_net(struct net *net)
256 struct lockd_net *ln = net_generic(net, lockd_net_id);
257 struct svc_serv *serv = nlmsvc_rqst->rq_server;
260 if (ln->nlmsvc_users)
263 error = svc_rpcb_setup(serv, net);
267 error = make_socks(serv, net);
273 svc_rpcb_cleanup(serv, net);
278 static void lockd_down_net(struct net *net)
280 struct lockd_net *ln = net_generic(net, lockd_net_id);
281 struct svc_serv *serv = nlmsvc_rqst->rq_server;
283 if (ln->nlmsvc_users) {
284 if (--ln->nlmsvc_users == 0) {
285 nlm_shutdown_hosts_net(net);
286 svc_shutdown_net(serv, net);
289 printk(KERN_ERR "lockd_down_net: no users! task=%p, net=%p\n",
296 * Bring up the lockd process if it's not already up.
298 int lockd_up(struct net *net)
300 struct svc_serv *serv;
303 mutex_lock(&nlmsvc_mutex);
305 * Check whether we're already up and running.
308 error = lockd_up_net(net);
313 * Sanity check: if there's no pid,
314 * we should be the first user ...
318 "lockd_up: no pid, %d users??\n", nlmsvc_users);
321 serv = svc_create(&nlmsvc_program, LOCKD_BUFSIZE, NULL);
323 printk(KERN_WARNING "lockd_up: create service failed\n");
327 error = make_socks(serv, net);
329 goto destroy_and_out;
332 * Create the kernel thread and wait for it to start.
334 nlmsvc_rqst = svc_prepare_thread(serv, &serv->sv_pools[0], NUMA_NO_NODE);
335 if (IS_ERR(nlmsvc_rqst)) {
336 error = PTR_ERR(nlmsvc_rqst);
339 "lockd_up: svc_rqst allocation failed, error=%d\n",
341 goto destroy_and_out;
344 svc_sock_update_bufs(serv);
345 serv->sv_maxconn = nlm_max_connections;
347 nlmsvc_task = kthread_run(lockd, nlmsvc_rqst, serv->sv_name);
348 if (IS_ERR(nlmsvc_task)) {
349 error = PTR_ERR(nlmsvc_task);
350 svc_exit_thread(nlmsvc_rqst);
354 "lockd_up: kthread_run failed, error=%d\n", error);
355 goto destroy_and_out;
359 * Note: svc_serv structures have an initial use count of 1,
360 * so we exit through here on both success and failure.
366 struct lockd_net *ln = net_generic(net, lockd_net_id);
371 mutex_unlock(&nlmsvc_mutex);
374 EXPORT_SYMBOL_GPL(lockd_up);
377 * Decrement the user count and bring down lockd if we're the last.
380 lockd_down(struct net *net)
382 mutex_lock(&nlmsvc_mutex);
384 if (--nlmsvc_users) {
389 printk(KERN_ERR "lockd_down: no users! task=%p\n",
395 printk(KERN_ERR "lockd_down: no lockd running.\n");
398 kthread_stop(nlmsvc_task);
399 svc_exit_thread(nlmsvc_rqst);
403 mutex_unlock(&nlmsvc_mutex);
405 EXPORT_SYMBOL_GPL(lockd_down);
410 * Sysctl parameters (same as module parameters, different interface).
413 static ctl_table nlm_sysctls[] = {
415 .procname = "nlm_grace_period",
416 .data = &nlm_grace_period,
417 .maxlen = sizeof(unsigned long),
419 .proc_handler = proc_doulongvec_minmax,
420 .extra1 = (unsigned long *) &nlm_grace_period_min,
421 .extra2 = (unsigned long *) &nlm_grace_period_max,
424 .procname = "nlm_timeout",
425 .data = &nlm_timeout,
426 .maxlen = sizeof(unsigned long),
428 .proc_handler = proc_doulongvec_minmax,
429 .extra1 = (unsigned long *) &nlm_timeout_min,
430 .extra2 = (unsigned long *) &nlm_timeout_max,
433 .procname = "nlm_udpport",
434 .data = &nlm_udpport,
435 .maxlen = sizeof(int),
437 .proc_handler = proc_dointvec_minmax,
438 .extra1 = (int *) &nlm_port_min,
439 .extra2 = (int *) &nlm_port_max,
442 .procname = "nlm_tcpport",
443 .data = &nlm_tcpport,
444 .maxlen = sizeof(int),
446 .proc_handler = proc_dointvec_minmax,
447 .extra1 = (int *) &nlm_port_min,
448 .extra2 = (int *) &nlm_port_max,
451 .procname = "nsm_use_hostnames",
452 .data = &nsm_use_hostnames,
453 .maxlen = sizeof(int),
455 .proc_handler = proc_dointvec,
458 .procname = "nsm_local_state",
459 .data = &nsm_local_state,
460 .maxlen = sizeof(int),
462 .proc_handler = proc_dointvec,
467 static ctl_table nlm_sysctl_dir[] = {
471 .child = nlm_sysctls,
476 static ctl_table nlm_sysctl_root[] = {
480 .child = nlm_sysctl_dir,
485 #endif /* CONFIG_SYSCTL */
488 * Module (and sysfs) parameters.
491 #define param_set_min_max(name, type, which_strtol, min, max) \
492 static int param_set_##name(const char *val, struct kernel_param *kp) \
495 __typeof__(type) num = which_strtol(val, &endp, 0); \
496 if (endp == val || *endp || num < (min) || num > (max)) \
498 *((type *) kp->arg) = num; \
502 static inline int is_callback(u32 proc)
504 return proc == NLMPROC_GRANTED
505 || proc == NLMPROC_GRANTED_MSG
506 || proc == NLMPROC_TEST_RES
507 || proc == NLMPROC_LOCK_RES
508 || proc == NLMPROC_CANCEL_RES
509 || proc == NLMPROC_UNLOCK_RES
510 || proc == NLMPROC_NSM_NOTIFY;
514 static int lockd_authenticate(struct svc_rqst *rqstp)
516 rqstp->rq_client = NULL;
517 switch (rqstp->rq_authop->flavour) {
520 if (rqstp->rq_proc == 0)
522 if (is_callback(rqstp->rq_proc)) {
523 /* Leave it to individual procedures to
524 * call nlmsvc_lookup_host(rqstp)
528 return svc_set_client(rqstp);
534 param_set_min_max(port, int, simple_strtol, 0, 65535)
535 param_set_min_max(grace_period, unsigned long, simple_strtoul,
536 nlm_grace_period_min, nlm_grace_period_max)
537 param_set_min_max(timeout, unsigned long, simple_strtoul,
538 nlm_timeout_min, nlm_timeout_max)
540 MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
541 MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION ".");
542 MODULE_LICENSE("GPL");
544 module_param_call(nlm_grace_period, param_set_grace_period, param_get_ulong,
545 &nlm_grace_period, 0644);
546 module_param_call(nlm_timeout, param_set_timeout, param_get_ulong,
548 module_param_call(nlm_udpport, param_set_port, param_get_int,
550 module_param_call(nlm_tcpport, param_set_port, param_get_int,
552 module_param(nsm_use_hostnames, bool, 0644);
553 module_param(nlm_max_connections, uint, 0644);
555 static int lockd_init_net(struct net *net)
560 static void lockd_exit_net(struct net *net)
564 static struct pernet_operations lockd_net_ops = {
565 .init = lockd_init_net,
566 .exit = lockd_exit_net,
568 .size = sizeof(struct lockd_net),
573 * Initialising and terminating the module.
576 static int __init init_nlm(void)
582 nlm_sysctl_table = register_sysctl_table(nlm_sysctl_root);
583 if (nlm_sysctl_table == NULL)
586 err = register_pernet_subsys(&lockd_net_ops);
593 unregister_sysctl_table(nlm_sysctl_table);
599 static void __exit exit_nlm(void)
601 /* FIXME: delete all NLM clients */
602 nlm_shutdown_hosts();
603 unregister_pernet_subsys(&lockd_net_ops);
605 unregister_sysctl_table(nlm_sysctl_table);
609 module_init(init_nlm);
610 module_exit(exit_nlm);
613 * Define NLM program and procedures
615 static struct svc_version nlmsvc_version1 = {
618 .vs_proc = nlmsvc_procedures,
619 .vs_xdrsize = NLMSVC_XDRSIZE,
621 static struct svc_version nlmsvc_version3 = {
624 .vs_proc = nlmsvc_procedures,
625 .vs_xdrsize = NLMSVC_XDRSIZE,
627 #ifdef CONFIG_LOCKD_V4
628 static struct svc_version nlmsvc_version4 = {
631 .vs_proc = nlmsvc_procedures4,
632 .vs_xdrsize = NLMSVC_XDRSIZE,
635 static struct svc_version * nlmsvc_version[] = {
636 [1] = &nlmsvc_version1,
637 [3] = &nlmsvc_version3,
638 #ifdef CONFIG_LOCKD_V4
639 [4] = &nlmsvc_version4,
643 static struct svc_stat nlmsvc_stats;
645 #define NLM_NRVERS ARRAY_SIZE(nlmsvc_version)
646 static struct svc_program nlmsvc_program = {
647 .pg_prog = NLM_PROGRAM, /* program number */
648 .pg_nvers = NLM_NRVERS, /* number of entries in nlmsvc_version */
649 .pg_vers = nlmsvc_version, /* version table */
650 .pg_name = "lockd", /* service name */
651 .pg_class = "nfsd", /* share authentication with nfsd */
652 .pg_stats = &nlmsvc_stats, /* stats table */
653 .pg_authenticate = &lockd_authenticate /* export authentication */