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