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