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