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