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