lockd: add a /proc/fs/lockd/nlm_end_grace file
[cascardo/linux.git] / fs / lockd / svc.c
1 /*
2  * linux/fs/lockd/svc.c
3  *
4  * This is the central lockd service.
5  *
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?
9  *
10  * Authors:     Olaf Kirch (okir@monad.swb.de)
11  *
12  * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
13  */
14
15 #include <linux/module.h>
16 #include <linux/init.h>
17 #include <linux/sysctl.h>
18 #include <linux/moduleparam.h>
19
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
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>
34 #include <net/ip.h>
35 #include <linux/lockd/lockd.h>
36 #include <linux/nfs.h>
37
38 #include "netns.h"
39 #include "procfs.h"
40
41 #define NLMDBG_FACILITY         NLMDBG_SVC
42 #define LOCKD_BUFSIZE           (1024 + NLMSVC_XDRSIZE)
43 #define ALLOWED_SIGS            (sigmask(SIGKILL))
44
45 static struct svc_program       nlmsvc_program;
46
47 struct nlmsvc_binding *         nlmsvc_ops;
48 EXPORT_SYMBOL_GPL(nlmsvc_ops);
49
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;
55
56 int lockd_net_id;
57
58 /*
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
61  */
62 static unsigned long            nlm_grace_period;
63 static unsigned long            nlm_timeout = LOCKD_DFLT_TIMEO;
64 static int                      nlm_udpport, nlm_tcpport;
65
66 /* RLIM_NOFILE defaults to 1024. That seems like a reasonable default here. */
67 static unsigned int             nlm_max_connections = 1024;
68
69 /*
70  * Constants needed for the sysctl interface.
71  */
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;
77
78 #ifdef CONFIG_SYSCTL
79 static struct ctl_table_header * nlm_sysctl_table;
80 #endif
81
82 static unsigned long get_lockd_grace_period(void)
83 {
84         /* Note: nlm_timeout should always be nonzero */
85         if (nlm_grace_period)
86                 return roundup(nlm_grace_period, nlm_timeout) * HZ;
87         else
88                 return nlm_timeout * 5 * HZ;
89 }
90
91 static void grace_ender(struct work_struct *grace)
92 {
93         struct delayed_work *dwork = container_of(grace, struct delayed_work,
94                                                   work);
95         struct lockd_net *ln = container_of(dwork, struct lockd_net,
96                                             grace_period_end);
97
98         locks_end_grace(&ln->lockd_manager);
99 }
100
101 static void set_grace_period(struct net *net)
102 {
103         unsigned long grace_period = get_lockd_grace_period();
104         struct lockd_net *ln = net_generic(net, lockd_net_id);
105
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);
109 }
110
111 static void restart_grace(void)
112 {
113         if (nlmsvc_ops) {
114                 struct net *net = &init_net;
115                 struct lockd_net *ln = net_generic(net, lockd_net_id);
116
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);
121         }
122 }
123
124 /*
125  * This is the lockd kernel thread
126  */
127 static int
128 lockd(void *vrqstp)
129 {
130         int             err = 0;
131         struct svc_rqst *rqstp = vrqstp;
132
133         /* try_to_freeze() is called from svc_recv() */
134         set_freezable();
135
136         /* Allow SIGKILL to tell lockd to drop all of its locks */
137         allow_signal(SIGKILL);
138
139         dprintk("NFS locking service started (ver " LOCKD_VERSION ").\n");
140
141         if (!nlm_timeout)
142                 nlm_timeout = LOCKD_DFLT_TIMEO;
143         nlmsvc_timeout = nlm_timeout * HZ;
144
145         /*
146          * The main request loop. We don't terminate until the last
147          * NFS mount or NFS daemon has gone away.
148          */
149         while (!kthread_should_stop()) {
150                 long timeout = MAX_SCHEDULE_TIMEOUT;
151                 RPC_IFDEBUG(char buf[RPC_MAX_ADDRBUFLEN]);
152
153                 /* update sv_maxconn if it has changed */
154                 rqstp->rq_server->sv_maxconn = nlm_max_connections;
155
156                 if (signalled()) {
157                         flush_signals(current);
158                         restart_grace();
159                         continue;
160                 }
161
162                 timeout = nlmsvc_retry_blocked();
163
164                 /*
165                  * Find a socket with data available and call its
166                  * recvfrom routine.
167                  */
168                 err = svc_recv(rqstp, timeout);
169                 if (err == -EAGAIN || err == -EINTR)
170                         continue;
171                 dprintk("lockd: request from %s\n",
172                                 svc_print_addr(rqstp, buf, sizeof(buf)));
173
174                 svc_process(rqstp);
175         }
176         flush_signals(current);
177         if (nlmsvc_ops)
178                 nlmsvc_invalidate_all();
179         nlm_shutdown_hosts();
180         return 0;
181 }
182
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)
186 {
187         struct svc_xprt *xprt;
188
189         xprt = svc_find_xprt(serv, name, net, family, 0);
190         if (xprt == NULL)
191                 return svc_create_xprt(serv, name, net, family, port,
192                                                 SVC_SOCK_DEFAULTS);
193         svc_xprt_put(xprt);
194         return 0;
195 }
196
197 static int create_lockd_family(struct svc_serv *serv, struct net *net,
198                                const int family)
199 {
200         int err;
201
202         err = create_lockd_listener(serv, "udp", net, family, nlm_udpport);
203         if (err < 0)
204                 return err;
205
206         return create_lockd_listener(serv, "tcp", net, family, nlm_tcpport);
207 }
208
209 /*
210  * Ensure there are active UDP and TCP listeners for lockd.
211  *
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.
215  *
216  * Returns zero if all listeners are available; otherwise a
217  * negative errno value is returned.
218  */
219 static int make_socks(struct svc_serv *serv, struct net *net)
220 {
221         static int warned;
222         int err;
223
224         err = create_lockd_family(serv, net, PF_INET);
225         if (err < 0)
226                 goto out_err;
227
228         err = create_lockd_family(serv, net, PF_INET6);
229         if (err < 0 && err != -EAFNOSUPPORT)
230                 goto out_err;
231
232         warned = 0;
233         return 0;
234
235 out_err:
236         if (warned++ == 0)
237                 printk(KERN_WARNING
238                         "lockd_up: makesock failed, error=%d\n", err);
239         svc_shutdown_net(serv, net);
240         return err;
241 }
242
243 static int lockd_up_net(struct svc_serv *serv, struct net *net)
244 {
245         struct lockd_net *ln = net_generic(net, lockd_net_id);
246         int error;
247
248         if (ln->nlmsvc_users++)
249                 return 0;
250
251         error = svc_bind(serv, net);
252         if (error)
253                 goto err_bind;
254
255         error = make_socks(serv, net);
256         if (error < 0)
257                 goto err_socks;
258         set_grace_period(net);
259         dprintk("lockd_up_net: per-net data created; net=%p\n", net);
260         return 0;
261
262 err_socks:
263         svc_rpcb_cleanup(serv, net);
264 err_bind:
265         ln->nlmsvc_users--;
266         return error;
267 }
268
269 static void lockd_down_net(struct svc_serv *serv, struct net *net)
270 {
271         struct lockd_net *ln = net_generic(net, lockd_net_id);
272
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);
280                 }
281         } else {
282                 printk(KERN_ERR "lockd_down_net: no users! task=%p, net=%p\n",
283                                 nlmsvc_task, net);
284                 BUG();
285         }
286 }
287
288 static int lockd_start_svc(struct svc_serv *serv)
289 {
290         int error;
291
292         if (nlmsvc_rqst)
293                 return 0;
294
295         /*
296          * Create the kernel thread and wait for it to start.
297          */
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);
301                 printk(KERN_WARNING
302                         "lockd_up: svc_rqst allocation failed, error=%d\n",
303                         error);
304                 goto out_rqst;
305         }
306
307         svc_sock_update_bufs(serv);
308         serv->sv_maxconn = nlm_max_connections;
309
310         nlmsvc_task = kthread_create(lockd, nlmsvc_rqst, "%s", serv->sv_name);
311         if (IS_ERR(nlmsvc_task)) {
312                 error = PTR_ERR(nlmsvc_task);
313                 printk(KERN_WARNING
314                         "lockd_up: kthread_run failed, error=%d\n", error);
315                 goto out_task;
316         }
317         nlmsvc_rqst->rq_task = nlmsvc_task;
318         wake_up_process(nlmsvc_task);
319
320         dprintk("lockd_up: service started\n");
321         return 0;
322
323 out_task:
324         svc_exit_thread(nlmsvc_rqst);
325         nlmsvc_task = NULL;
326 out_rqst:
327         nlmsvc_rqst = NULL;
328         return error;
329 }
330
331 static struct svc_serv *lockd_create_svc(void)
332 {
333         struct svc_serv *serv;
334
335         /*
336          * Check whether we're already up and running.
337          */
338         if (nlmsvc_rqst) {
339                 /*
340                  * Note: increase service usage, because later in case of error
341                  * svc_destroy() will be called.
342                  */
343                 svc_get(nlmsvc_rqst->rq_server);
344                 return nlmsvc_rqst->rq_server;
345         }
346
347         /*
348          * Sanity check: if there's no pid,
349          * we should be the first user ...
350          */
351         if (nlmsvc_users)
352                 printk(KERN_WARNING
353                         "lockd_up: no pid, %d users??\n", nlmsvc_users);
354
355         serv = svc_create(&nlmsvc_program, LOCKD_BUFSIZE, NULL);
356         if (!serv) {
357                 printk(KERN_WARNING "lockd_up: create service failed\n");
358                 return ERR_PTR(-ENOMEM);
359         }
360         dprintk("lockd_up: service created\n");
361         return serv;
362 }
363
364 /*
365  * Bring up the lockd process if it's not already up.
366  */
367 int lockd_up(struct net *net)
368 {
369         struct svc_serv *serv;
370         int error;
371
372         mutex_lock(&nlmsvc_mutex);
373
374         serv = lockd_create_svc();
375         if (IS_ERR(serv)) {
376                 error = PTR_ERR(serv);
377                 goto err_create;
378         }
379
380         error = lockd_up_net(serv, net);
381         if (error < 0)
382                 goto err_net;
383
384         error = lockd_start_svc(serv);
385         if (error < 0)
386                 goto err_start;
387
388         nlmsvc_users++;
389         /*
390          * Note: svc_serv structures have an initial use count of 1,
391          * so we exit through here on both success and failure.
392          */
393 err_net:
394         svc_destroy(serv);
395 err_create:
396         mutex_unlock(&nlmsvc_mutex);
397         return error;
398
399 err_start:
400         lockd_down_net(serv, net);
401         goto err_net;
402 }
403 EXPORT_SYMBOL_GPL(lockd_up);
404
405 /*
406  * Decrement the user count and bring down lockd if we're the last.
407  */
408 void
409 lockd_down(struct net *net)
410 {
411         mutex_lock(&nlmsvc_mutex);
412         lockd_down_net(nlmsvc_rqst->rq_server, net);
413         if (nlmsvc_users) {
414                 if (--nlmsvc_users)
415                         goto out;
416         } else {
417                 printk(KERN_ERR "lockd_down: no users! task=%p\n",
418                         nlmsvc_task);
419                 BUG();
420         }
421
422         if (!nlmsvc_task) {
423                 printk(KERN_ERR "lockd_down: no lockd running.\n");
424                 BUG();
425         }
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");
430         nlmsvc_task = NULL;
431         nlmsvc_rqst = NULL;
432 out:
433         mutex_unlock(&nlmsvc_mutex);
434 }
435 EXPORT_SYMBOL_GPL(lockd_down);
436
437 #ifdef CONFIG_SYSCTL
438
439 /*
440  * Sysctl parameters (same as module parameters, different interface).
441  */
442
443 static struct ctl_table nlm_sysctls[] = {
444         {
445                 .procname       = "nlm_grace_period",
446                 .data           = &nlm_grace_period,
447                 .maxlen         = sizeof(unsigned long),
448                 .mode           = 0644,
449                 .proc_handler   = proc_doulongvec_minmax,
450                 .extra1         = (unsigned long *) &nlm_grace_period_min,
451                 .extra2         = (unsigned long *) &nlm_grace_period_max,
452         },
453         {
454                 .procname       = "nlm_timeout",
455                 .data           = &nlm_timeout,
456                 .maxlen         = sizeof(unsigned long),
457                 .mode           = 0644,
458                 .proc_handler   = proc_doulongvec_minmax,
459                 .extra1         = (unsigned long *) &nlm_timeout_min,
460                 .extra2         = (unsigned long *) &nlm_timeout_max,
461         },
462         {
463                 .procname       = "nlm_udpport",
464                 .data           = &nlm_udpport,
465                 .maxlen         = sizeof(int),
466                 .mode           = 0644,
467                 .proc_handler   = proc_dointvec_minmax,
468                 .extra1         = (int *) &nlm_port_min,
469                 .extra2         = (int *) &nlm_port_max,
470         },
471         {
472                 .procname       = "nlm_tcpport",
473                 .data           = &nlm_tcpport,
474                 .maxlen         = sizeof(int),
475                 .mode           = 0644,
476                 .proc_handler   = proc_dointvec_minmax,
477                 .extra1         = (int *) &nlm_port_min,
478                 .extra2         = (int *) &nlm_port_max,
479         },
480         {
481                 .procname       = "nsm_use_hostnames",
482                 .data           = &nsm_use_hostnames,
483                 .maxlen         = sizeof(int),
484                 .mode           = 0644,
485                 .proc_handler   = proc_dointvec,
486         },
487         {
488                 .procname       = "nsm_local_state",
489                 .data           = &nsm_local_state,
490                 .maxlen         = sizeof(int),
491                 .mode           = 0644,
492                 .proc_handler   = proc_dointvec,
493         },
494         { }
495 };
496
497 static struct ctl_table nlm_sysctl_dir[] = {
498         {
499                 .procname       = "nfs",
500                 .mode           = 0555,
501                 .child          = nlm_sysctls,
502         },
503         { }
504 };
505
506 static struct ctl_table nlm_sysctl_root[] = {
507         {
508                 .procname       = "fs",
509                 .mode           = 0555,
510                 .child          = nlm_sysctl_dir,
511         },
512         { }
513 };
514
515 #endif  /* CONFIG_SYSCTL */
516
517 /*
518  * Module (and sysfs) parameters.
519  */
520
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)   \
523 {                                                                       \
524         char *endp;                                                     \
525         __typeof__(type) num = which_strtol(val, &endp, 0);             \
526         if (endp == val || *endp || num < (min) || num > (max))         \
527                 return -EINVAL;                                         \
528         *((type *) kp->arg) = num;                                      \
529         return 0;                                                       \
530 }
531
532 static inline int is_callback(u32 proc)
533 {
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;
541 }
542
543
544 static int lockd_authenticate(struct svc_rqst *rqstp)
545 {
546         rqstp->rq_client = NULL;
547         switch (rqstp->rq_authop->flavour) {
548                 case RPC_AUTH_NULL:
549                 case RPC_AUTH_UNIX:
550                         if (rqstp->rq_proc == 0)
551                                 return SVC_OK;
552                         if (is_callback(rqstp->rq_proc)) {
553                                 /* Leave it to individual procedures to
554                                  * call nlmsvc_lookup_host(rqstp)
555                                  */
556                                 return SVC_OK;
557                         }
558                         return svc_set_client(rqstp);
559         }
560         return SVC_DENIED;
561 }
562
563
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)
569
570 MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
571 MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION ".");
572 MODULE_LICENSE("GPL");
573
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,
577                   &nlm_timeout, 0644);
578 module_param_call(nlm_udpport, param_set_port, param_get_int,
579                   &nlm_udpport, 0644);
580 module_param_call(nlm_tcpport, param_set_port, param_get_int,
581                   &nlm_tcpport, 0644);
582 module_param(nsm_use_hostnames, bool, 0644);
583 module_param(nlm_max_connections, uint, 0644);
584
585 static int lockd_init_net(struct net *net)
586 {
587         struct lockd_net *ln = net_generic(net, lockd_net_id);
588
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);
592         return 0;
593 }
594
595 static void lockd_exit_net(struct net *net)
596 {
597 }
598
599 static struct pernet_operations lockd_net_ops = {
600         .init = lockd_init_net,
601         .exit = lockd_exit_net,
602         .id = &lockd_net_id,
603         .size = sizeof(struct lockd_net),
604 };
605
606
607 /*
608  * Initialising and terminating the module.
609  */
610
611 static int __init init_nlm(void)
612 {
613         int err;
614
615 #ifdef CONFIG_SYSCTL
616         err = -ENOMEM;
617         nlm_sysctl_table = register_sysctl_table(nlm_sysctl_root);
618         if (nlm_sysctl_table == NULL)
619                 goto err_sysctl;
620 #endif
621         err = register_pernet_subsys(&lockd_net_ops);
622         if (err)
623                 goto err_pernet;
624
625         err = lockd_create_procfs();
626         if (err)
627                 goto err_procfs;
628
629         return 0;
630
631 err_procfs:
632         unregister_pernet_subsys(&lockd_net_ops);
633 err_pernet:
634 #ifdef CONFIG_SYSCTL
635         unregister_sysctl_table(nlm_sysctl_table);
636 err_sysctl:
637 #endif
638         return err;
639 }
640
641 static void __exit exit_nlm(void)
642 {
643         /* FIXME: delete all NLM clients */
644         nlm_shutdown_hosts();
645         lockd_remove_procfs();
646         unregister_pernet_subsys(&lockd_net_ops);
647 #ifdef CONFIG_SYSCTL
648         unregister_sysctl_table(nlm_sysctl_table);
649 #endif
650 }
651
652 module_init(init_nlm);
653 module_exit(exit_nlm);
654
655 /*
656  * Define NLM program and procedures
657  */
658 static struct svc_version       nlmsvc_version1 = {
659                 .vs_vers        = 1,
660                 .vs_nproc       = 17,
661                 .vs_proc        = nlmsvc_procedures,
662                 .vs_xdrsize     = NLMSVC_XDRSIZE,
663 };
664 static struct svc_version       nlmsvc_version3 = {
665                 .vs_vers        = 3,
666                 .vs_nproc       = 24,
667                 .vs_proc        = nlmsvc_procedures,
668                 .vs_xdrsize     = NLMSVC_XDRSIZE,
669 };
670 #ifdef CONFIG_LOCKD_V4
671 static struct svc_version       nlmsvc_version4 = {
672                 .vs_vers        = 4,
673                 .vs_nproc       = 24,
674                 .vs_proc        = nlmsvc_procedures4,
675                 .vs_xdrsize     = NLMSVC_XDRSIZE,
676 };
677 #endif
678 static struct svc_version *     nlmsvc_version[] = {
679         [1] = &nlmsvc_version1,
680         [3] = &nlmsvc_version3,
681 #ifdef CONFIG_LOCKD_V4
682         [4] = &nlmsvc_version4,
683 #endif
684 };
685
686 static struct svc_stat          nlmsvc_stats;
687
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 */
697 };