Linux 4.8-rc8
[linux/fpc-iii.git] / fs / lockd / svc.c
blobfc4084ef4736d47a410e27052497cd00829204c2
1 /*
2 * linux/fs/lockd/svc.c
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>
22 #include <linux/in.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>
36 #include <net/ip.h>
37 #include <net/addrconf.h>
38 #include <net/ipv6.h>
39 #include <linux/lockd/lockd.h>
40 #include <linux/nfs.h>
42 #include "netns.h"
43 #include "procfs.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 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;
82 #ifdef CONFIG_SYSCTL
83 static struct ctl_table_header * nlm_sysctl_table;
84 #endif
86 static unsigned long get_lockd_grace_period(void)
88 /* Note: nlm_timeout should always be nonzero */
89 if (nlm_grace_period)
90 return roundup(nlm_grace_period, nlm_timeout) * HZ;
91 else
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,
99 grace_period_end);
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)
116 if (nlmsvc_ops) {
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
130 static int
131 lockd(void *vrqstp)
133 int err = 0;
134 struct svc_rqst *rqstp = vrqstp;
136 /* try_to_freeze() is called from svc_recv() */
137 set_freezable();
139 /* Allow SIGKILL to tell lockd to drop all of its locks */
140 allow_signal(SIGKILL);
142 dprintk("NFS locking service started (ver " LOCKD_VERSION ").\n");
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;
155 if (signalled()) {
156 flush_signals(current);
157 restart_grace();
158 continue;
161 timeout = nlmsvc_retry_blocked();
164 * Find a socket with data available and call its
165 * recvfrom routine.
167 err = svc_recv(rqstp, timeout);
168 if (err == -EAGAIN || err == -EINTR)
169 continue;
170 dprintk("lockd: request from %s\n",
171 svc_print_addr(rqstp, buf, sizeof(buf)));
173 svc_process(rqstp);
175 flush_signals(current);
176 if (nlmsvc_ops)
177 nlmsvc_invalidate_all();
178 nlm_shutdown_hosts();
179 return 0;
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);
189 if (xprt == NULL)
190 return svc_create_xprt(serv, name, net, family, port,
191 SVC_SOCK_DEFAULTS);
192 svc_xprt_put(xprt);
193 return 0;
196 static int create_lockd_family(struct svc_serv *serv, struct net *net,
197 const int family)
199 int err;
201 err = create_lockd_listener(serv, "udp", net, family, nlm_udpport);
202 if (err < 0)
203 return err;
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)
220 static int warned;
221 int err;
223 err = create_lockd_family(serv, net, PF_INET);
224 if (err < 0)
225 goto out_err;
227 err = create_lockd_family(serv, net, PF_INET6);
228 if (err < 0 && err != -EAFNOSUPPORT)
229 goto out_err;
231 warned = 0;
232 return 0;
234 out_err:
235 if (warned++ == 0)
236 printk(KERN_WARNING
237 "lockd_up: makesock failed, error=%d\n", err);
238 svc_shutdown_net(serv, net);
239 return err;
242 static int lockd_up_net(struct svc_serv *serv, struct net *net)
244 struct lockd_net *ln = net_generic(net, lockd_net_id);
245 int error;
247 if (ln->nlmsvc_users++)
248 return 0;
250 error = svc_bind(serv, net);
251 if (error)
252 goto err_bind;
254 error = make_socks(serv, net);
255 if (error < 0)
256 goto err_bind;
257 set_grace_period(net);
258 dprintk("lockd_up_net: per-net data created; net=%p\n", net);
259 return 0;
261 err_bind:
262 ln->nlmsvc_users--;
263 return error;
266 static void lockd_down_net(struct svc_serv *serv, struct net *net)
268 struct lockd_net *ln = net_generic(net, lockd_net_id);
270 if (ln->nlmsvc_users) {
271 if (--ln->nlmsvc_users == 0) {
272 nlm_shutdown_hosts_net(net);
273 cancel_delayed_work_sync(&ln->grace_period_end);
274 locks_end_grace(&ln->lockd_manager);
275 svc_shutdown_net(serv, net);
276 dprintk("lockd_down_net: per-net data destroyed; net=%p\n", net);
278 } else {
279 printk(KERN_ERR "lockd_down_net: no users! task=%p, net=%p\n",
280 nlmsvc_task, net);
281 BUG();
285 static int lockd_inetaddr_event(struct notifier_block *this,
286 unsigned long event, void *ptr)
288 struct in_ifaddr *ifa = (struct in_ifaddr *)ptr;
289 struct sockaddr_in sin;
291 if (event != NETDEV_DOWN)
292 goto out;
294 if (nlmsvc_rqst) {
295 dprintk("lockd_inetaddr_event: removed %pI4\n",
296 &ifa->ifa_local);
297 sin.sin_family = AF_INET;
298 sin.sin_addr.s_addr = ifa->ifa_local;
299 svc_age_temp_xprts_now(nlmsvc_rqst->rq_server,
300 (struct sockaddr *)&sin);
303 out:
304 return NOTIFY_DONE;
307 static struct notifier_block lockd_inetaddr_notifier = {
308 .notifier_call = lockd_inetaddr_event,
311 #if IS_ENABLED(CONFIG_IPV6)
312 static int lockd_inet6addr_event(struct notifier_block *this,
313 unsigned long event, void *ptr)
315 struct inet6_ifaddr *ifa = (struct inet6_ifaddr *)ptr;
316 struct sockaddr_in6 sin6;
318 if (event != NETDEV_DOWN)
319 goto out;
321 if (nlmsvc_rqst) {
322 dprintk("lockd_inet6addr_event: removed %pI6\n", &ifa->addr);
323 sin6.sin6_family = AF_INET6;
324 sin6.sin6_addr = ifa->addr;
325 svc_age_temp_xprts_now(nlmsvc_rqst->rq_server,
326 (struct sockaddr *)&sin6);
329 out:
330 return NOTIFY_DONE;
333 static struct notifier_block lockd_inet6addr_notifier = {
334 .notifier_call = lockd_inet6addr_event,
336 #endif
338 static void lockd_unregister_notifiers(void)
340 unregister_inetaddr_notifier(&lockd_inetaddr_notifier);
341 #if IS_ENABLED(CONFIG_IPV6)
342 unregister_inet6addr_notifier(&lockd_inet6addr_notifier);
343 #endif
346 static void lockd_svc_exit_thread(void)
348 lockd_unregister_notifiers();
349 svc_exit_thread(nlmsvc_rqst);
352 static int lockd_start_svc(struct svc_serv *serv)
354 int error;
356 if (nlmsvc_rqst)
357 return 0;
360 * Create the kernel thread and wait for it to start.
362 nlmsvc_rqst = svc_prepare_thread(serv, &serv->sv_pools[0], NUMA_NO_NODE);
363 if (IS_ERR(nlmsvc_rqst)) {
364 error = PTR_ERR(nlmsvc_rqst);
365 printk(KERN_WARNING
366 "lockd_up: svc_rqst allocation failed, error=%d\n",
367 error);
368 goto out_rqst;
371 svc_sock_update_bufs(serv);
372 serv->sv_maxconn = nlm_max_connections;
374 nlmsvc_task = kthread_create(lockd, nlmsvc_rqst, "%s", serv->sv_name);
375 if (IS_ERR(nlmsvc_task)) {
376 error = PTR_ERR(nlmsvc_task);
377 printk(KERN_WARNING
378 "lockd_up: kthread_run failed, error=%d\n", error);
379 goto out_task;
381 nlmsvc_rqst->rq_task = nlmsvc_task;
382 wake_up_process(nlmsvc_task);
384 dprintk("lockd_up: service started\n");
385 return 0;
387 out_task:
388 lockd_svc_exit_thread();
389 nlmsvc_task = NULL;
390 out_rqst:
391 nlmsvc_rqst = NULL;
392 return error;
395 static struct svc_serv_ops lockd_sv_ops = {
396 .svo_shutdown = svc_rpcb_cleanup,
397 .svo_enqueue_xprt = svc_xprt_do_enqueue,
400 static struct svc_serv *lockd_create_svc(void)
402 struct svc_serv *serv;
405 * Check whether we're already up and running.
407 if (nlmsvc_rqst) {
409 * Note: increase service usage, because later in case of error
410 * svc_destroy() will be called.
412 svc_get(nlmsvc_rqst->rq_server);
413 return nlmsvc_rqst->rq_server;
417 * Sanity check: if there's no pid,
418 * we should be the first user ...
420 if (nlmsvc_users)
421 printk(KERN_WARNING
422 "lockd_up: no pid, %d users??\n", nlmsvc_users);
424 if (!nlm_timeout)
425 nlm_timeout = LOCKD_DFLT_TIMEO;
426 nlmsvc_timeout = nlm_timeout * HZ;
428 serv = svc_create(&nlmsvc_program, LOCKD_BUFSIZE, &lockd_sv_ops);
429 if (!serv) {
430 printk(KERN_WARNING "lockd_up: create service failed\n");
431 return ERR_PTR(-ENOMEM);
433 register_inetaddr_notifier(&lockd_inetaddr_notifier);
434 #if IS_ENABLED(CONFIG_IPV6)
435 register_inet6addr_notifier(&lockd_inet6addr_notifier);
436 #endif
437 dprintk("lockd_up: service created\n");
438 return serv;
442 * Bring up the lockd process if it's not already up.
444 int lockd_up(struct net *net)
446 struct svc_serv *serv;
447 int error;
449 mutex_lock(&nlmsvc_mutex);
451 serv = lockd_create_svc();
452 if (IS_ERR(serv)) {
453 error = PTR_ERR(serv);
454 goto err_create;
457 error = lockd_up_net(serv, net);
458 if (error < 0)
459 goto err_net;
461 error = lockd_start_svc(serv);
462 if (error < 0)
463 goto err_start;
465 nlmsvc_users++;
467 * Note: svc_serv structures have an initial use count of 1,
468 * so we exit through here on both success and failure.
470 err_put:
471 svc_destroy(serv);
472 err_create:
473 mutex_unlock(&nlmsvc_mutex);
474 return error;
476 err_start:
477 lockd_down_net(serv, net);
478 err_net:
479 lockd_unregister_notifiers();
480 goto err_put;
482 EXPORT_SYMBOL_GPL(lockd_up);
485 * Decrement the user count and bring down lockd if we're the last.
487 void
488 lockd_down(struct net *net)
490 mutex_lock(&nlmsvc_mutex);
491 lockd_down_net(nlmsvc_rqst->rq_server, net);
492 if (nlmsvc_users) {
493 if (--nlmsvc_users)
494 goto out;
495 } else {
496 printk(KERN_ERR "lockd_down: no users! task=%p\n",
497 nlmsvc_task);
498 BUG();
501 if (!nlmsvc_task) {
502 printk(KERN_ERR "lockd_down: no lockd running.\n");
503 BUG();
505 kthread_stop(nlmsvc_task);
506 dprintk("lockd_down: service stopped\n");
507 lockd_svc_exit_thread();
508 dprintk("lockd_down: service destroyed\n");
509 nlmsvc_task = NULL;
510 nlmsvc_rqst = NULL;
511 out:
512 mutex_unlock(&nlmsvc_mutex);
514 EXPORT_SYMBOL_GPL(lockd_down);
516 #ifdef CONFIG_SYSCTL
519 * Sysctl parameters (same as module parameters, different interface).
522 static struct ctl_table nlm_sysctls[] = {
524 .procname = "nlm_grace_period",
525 .data = &nlm_grace_period,
526 .maxlen = sizeof(unsigned long),
527 .mode = 0644,
528 .proc_handler = proc_doulongvec_minmax,
529 .extra1 = (unsigned long *) &nlm_grace_period_min,
530 .extra2 = (unsigned long *) &nlm_grace_period_max,
533 .procname = "nlm_timeout",
534 .data = &nlm_timeout,
535 .maxlen = sizeof(unsigned long),
536 .mode = 0644,
537 .proc_handler = proc_doulongvec_minmax,
538 .extra1 = (unsigned long *) &nlm_timeout_min,
539 .extra2 = (unsigned long *) &nlm_timeout_max,
542 .procname = "nlm_udpport",
543 .data = &nlm_udpport,
544 .maxlen = sizeof(int),
545 .mode = 0644,
546 .proc_handler = proc_dointvec_minmax,
547 .extra1 = (int *) &nlm_port_min,
548 .extra2 = (int *) &nlm_port_max,
551 .procname = "nlm_tcpport",
552 .data = &nlm_tcpport,
553 .maxlen = sizeof(int),
554 .mode = 0644,
555 .proc_handler = proc_dointvec_minmax,
556 .extra1 = (int *) &nlm_port_min,
557 .extra2 = (int *) &nlm_port_max,
560 .procname = "nsm_use_hostnames",
561 .data = &nsm_use_hostnames,
562 .maxlen = sizeof(int),
563 .mode = 0644,
564 .proc_handler = proc_dointvec,
567 .procname = "nsm_local_state",
568 .data = &nsm_local_state,
569 .maxlen = sizeof(int),
570 .mode = 0644,
571 .proc_handler = proc_dointvec,
576 static struct ctl_table nlm_sysctl_dir[] = {
578 .procname = "nfs",
579 .mode = 0555,
580 .child = nlm_sysctls,
585 static struct ctl_table nlm_sysctl_root[] = {
587 .procname = "fs",
588 .mode = 0555,
589 .child = nlm_sysctl_dir,
594 #endif /* CONFIG_SYSCTL */
597 * Module (and sysfs) parameters.
600 #define param_set_min_max(name, type, which_strtol, min, max) \
601 static int param_set_##name(const char *val, struct kernel_param *kp) \
603 char *endp; \
604 __typeof__(type) num = which_strtol(val, &endp, 0); \
605 if (endp == val || *endp || num < (min) || num > (max)) \
606 return -EINVAL; \
607 *((type *) kp->arg) = num; \
608 return 0; \
611 static inline int is_callback(u32 proc)
613 return proc == NLMPROC_GRANTED
614 || proc == NLMPROC_GRANTED_MSG
615 || proc == NLMPROC_TEST_RES
616 || proc == NLMPROC_LOCK_RES
617 || proc == NLMPROC_CANCEL_RES
618 || proc == NLMPROC_UNLOCK_RES
619 || proc == NLMPROC_NSM_NOTIFY;
623 static int lockd_authenticate(struct svc_rqst *rqstp)
625 rqstp->rq_client = NULL;
626 switch (rqstp->rq_authop->flavour) {
627 case RPC_AUTH_NULL:
628 case RPC_AUTH_UNIX:
629 if (rqstp->rq_proc == 0)
630 return SVC_OK;
631 if (is_callback(rqstp->rq_proc)) {
632 /* Leave it to individual procedures to
633 * call nlmsvc_lookup_host(rqstp)
635 return SVC_OK;
637 return svc_set_client(rqstp);
639 return SVC_DENIED;
643 param_set_min_max(port, int, simple_strtol, 0, 65535)
644 param_set_min_max(grace_period, unsigned long, simple_strtoul,
645 nlm_grace_period_min, nlm_grace_period_max)
646 param_set_min_max(timeout, unsigned long, simple_strtoul,
647 nlm_timeout_min, nlm_timeout_max)
649 MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
650 MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION ".");
651 MODULE_LICENSE("GPL");
653 module_param_call(nlm_grace_period, param_set_grace_period, param_get_ulong,
654 &nlm_grace_period, 0644);
655 module_param_call(nlm_timeout, param_set_timeout, param_get_ulong,
656 &nlm_timeout, 0644);
657 module_param_call(nlm_udpport, param_set_port, param_get_int,
658 &nlm_udpport, 0644);
659 module_param_call(nlm_tcpport, param_set_port, param_get_int,
660 &nlm_tcpport, 0644);
661 module_param(nsm_use_hostnames, bool, 0644);
662 module_param(nlm_max_connections, uint, 0644);
664 static int lockd_init_net(struct net *net)
666 struct lockd_net *ln = net_generic(net, lockd_net_id);
668 INIT_DELAYED_WORK(&ln->grace_period_end, grace_ender);
669 INIT_LIST_HEAD(&ln->lockd_manager.list);
670 ln->lockd_manager.block_opens = false;
671 INIT_LIST_HEAD(&ln->nsm_handles);
672 return 0;
675 static void lockd_exit_net(struct net *net)
679 static struct pernet_operations lockd_net_ops = {
680 .init = lockd_init_net,
681 .exit = lockd_exit_net,
682 .id = &lockd_net_id,
683 .size = sizeof(struct lockd_net),
688 * Initialising and terminating the module.
691 static int __init init_nlm(void)
693 int err;
695 #ifdef CONFIG_SYSCTL
696 err = -ENOMEM;
697 nlm_sysctl_table = register_sysctl_table(nlm_sysctl_root);
698 if (nlm_sysctl_table == NULL)
699 goto err_sysctl;
700 #endif
701 err = register_pernet_subsys(&lockd_net_ops);
702 if (err)
703 goto err_pernet;
705 err = lockd_create_procfs();
706 if (err)
707 goto err_procfs;
709 return 0;
711 err_procfs:
712 unregister_pernet_subsys(&lockd_net_ops);
713 err_pernet:
714 #ifdef CONFIG_SYSCTL
715 unregister_sysctl_table(nlm_sysctl_table);
716 err_sysctl:
717 #endif
718 return err;
721 static void __exit exit_nlm(void)
723 /* FIXME: delete all NLM clients */
724 nlm_shutdown_hosts();
725 lockd_remove_procfs();
726 unregister_pernet_subsys(&lockd_net_ops);
727 #ifdef CONFIG_SYSCTL
728 unregister_sysctl_table(nlm_sysctl_table);
729 #endif
732 module_init(init_nlm);
733 module_exit(exit_nlm);
736 * Define NLM program and procedures
738 static struct svc_version nlmsvc_version1 = {
739 .vs_vers = 1,
740 .vs_nproc = 17,
741 .vs_proc = nlmsvc_procedures,
742 .vs_xdrsize = NLMSVC_XDRSIZE,
744 static struct svc_version nlmsvc_version3 = {
745 .vs_vers = 3,
746 .vs_nproc = 24,
747 .vs_proc = nlmsvc_procedures,
748 .vs_xdrsize = NLMSVC_XDRSIZE,
750 #ifdef CONFIG_LOCKD_V4
751 static struct svc_version nlmsvc_version4 = {
752 .vs_vers = 4,
753 .vs_nproc = 24,
754 .vs_proc = nlmsvc_procedures4,
755 .vs_xdrsize = NLMSVC_XDRSIZE,
757 #endif
758 static struct svc_version * nlmsvc_version[] = {
759 [1] = &nlmsvc_version1,
760 [3] = &nlmsvc_version3,
761 #ifdef CONFIG_LOCKD_V4
762 [4] = &nlmsvc_version4,
763 #endif
766 static struct svc_stat nlmsvc_stats;
768 #define NLM_NRVERS ARRAY_SIZE(nlmsvc_version)
769 static struct svc_program nlmsvc_program = {
770 .pg_prog = NLM_PROGRAM, /* program number */
771 .pg_nvers = NLM_NRVERS, /* number of entries in nlmsvc_version */
772 .pg_vers = nlmsvc_version, /* version table */
773 .pg_name = "lockd", /* service name */
774 .pg_class = "nfsd", /* share authentication with nfsd */
775 .pg_stats = &nlmsvc_stats, /* stats table */
776 .pg_authenticate = &lockd_authenticate /* export authentication */