4 * This is the central lockd service.
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?
10 * Authors: Olaf Kirch (okir@monad.swb.de)
12 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
15 #include <linux/module.h>
16 #include <linux/init.h>
17 #include <linux/sysctl.h>
18 #include <linux/moduleparam.h>
20 #include <linux/sched.h>
21 #include <linux/errno.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>
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>
35 #include <linux/lockd/lockd.h>
36 #include <linux/nfs.h>
38 #define NLMDBG_FACILITY NLMDBG_SVC
39 #define LOCKD_BUFSIZE (1024 + NLMSVC_XDRSIZE)
40 #define ALLOWED_SIGS (sigmask(SIGKILL))
42 static struct svc_program nlmsvc_program
;
44 struct nlmsvc_binding
* nlmsvc_ops
;
45 EXPORT_SYMBOL(nlmsvc_ops
);
47 static DEFINE_MUTEX(nlmsvc_mutex
);
48 static unsigned int nlmsvc_users
;
49 static pid_t nlmsvc_pid
;
50 static struct svc_serv
*nlmsvc_serv
;
51 int nlmsvc_grace_period
;
52 unsigned long nlmsvc_timeout
;
54 static DECLARE_COMPLETION(lockd_start_done
);
55 static DECLARE_WAIT_QUEUE_HEAD(lockd_exit
);
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
61 static unsigned long nlm_grace_period
;
62 static unsigned long nlm_timeout
= LOCKD_DFLT_TIMEO
;
63 static int nlm_udpport
, nlm_tcpport
;
66 * Constants needed for the sysctl interface.
68 static const unsigned long nlm_grace_period_min
= 0;
69 static const unsigned long nlm_grace_period_max
= 240;
70 static const unsigned long nlm_timeout_min
= 3;
71 static const unsigned long nlm_timeout_max
= 20;
72 static const int nlm_port_min
= 0, nlm_port_max
= 65535;
74 static struct ctl_table_header
* nlm_sysctl_table
;
76 static unsigned long set_grace_period(void)
78 unsigned long grace_period
;
80 /* Note: nlm_timeout should always be nonzero */
82 grace_period
= ((nlm_grace_period
+ nlm_timeout
- 1)
83 / nlm_timeout
) * nlm_timeout
* HZ
;
85 grace_period
= nlm_timeout
* 5 * HZ
;
86 nlmsvc_grace_period
= 1;
87 return grace_period
+ jiffies
;
90 static inline void clear_grace_period(void)
92 nlmsvc_grace_period
= 0;
96 * This is the lockd kernel thread
99 lockd(struct svc_rqst
*rqstp
)
102 unsigned long grace_period_expire
;
104 /* Lock module and set up kernel thread */
105 /* lockd_up is waiting for us to startup, so will
106 * be holding a reference to this module, so it
107 * is safe to just claim another reference
109 __module_get(THIS_MODULE
);
113 * Let our maker know we're running.
115 nlmsvc_pid
= current
->pid
;
116 nlmsvc_serv
= rqstp
->rq_server
;
117 complete(&lockd_start_done
);
121 /* Process request with signals blocked, but allow SIGKILL. */
122 allow_signal(SIGKILL
);
127 dprintk("NFS locking service started (ver " LOCKD_VERSION
").\n");
130 nlm_timeout
= LOCKD_DFLT_TIMEO
;
131 nlmsvc_timeout
= nlm_timeout
* HZ
;
133 grace_period_expire
= set_grace_period();
136 * The main request loop. We don't terminate until the last
137 * NFS mount or NFS daemon has gone away, and we've been sent a
138 * signal, or else another process has taken over our job.
140 while ((nlmsvc_users
|| !signalled()) && nlmsvc_pid
== current
->pid
) {
141 long timeout
= MAX_SCHEDULE_TIMEOUT
;
144 flush_signals(current
);
146 nlmsvc_invalidate_all();
147 grace_period_expire
= set_grace_period();
152 * Retry any blocked locks that have been notified by
153 * the VFS. Don't do this during grace period.
154 * (Theoretically, there shouldn't even be blocked locks
155 * during grace period).
157 if (!nlmsvc_grace_period
) {
158 timeout
= nlmsvc_retry_blocked();
159 } else if (time_before(grace_period_expire
, jiffies
))
160 clear_grace_period();
163 * Find a socket with data available and call its
166 err
= svc_recv(rqstp
, timeout
);
167 if (err
== -EAGAIN
|| err
== -EINTR
)
171 "lockd: terminating on error %d\n",
176 dprintk("lockd: request from %08x\n",
177 (unsigned)ntohl(rqstp
->rq_addr
.sin_addr
.s_addr
));
183 flush_signals(current
);
186 * Check whether there's a new lockd process before
187 * shutting down the hosts and clearing the slot.
189 if (!nlmsvc_pid
|| current
->pid
== nlmsvc_pid
) {
191 nlmsvc_invalidate_all();
192 nlm_shutdown_hosts();
197 "lockd: new process, skipping host shutdown\n");
198 wake_up(&lockd_exit
);
200 /* Exit the RPC thread */
201 svc_exit_thread(rqstp
);
208 module_put_and_exit(0);
212 static int find_socket(struct svc_serv
*serv
, int proto
)
214 struct svc_sock
*svsk
;
216 list_for_each_entry(svsk
, &serv
->sv_permsocks
, sk_list
)
217 if (svsk
->sk_sk
->sk_protocol
== proto
) {
224 static int make_socks(struct svc_serv
*serv
, int proto
)
226 /* Make any sockets that are needed but not present.
227 * If nlm_udpport or nlm_tcpport were set as module
228 * options, make those sockets unconditionally
232 if (proto
== IPPROTO_UDP
|| nlm_udpport
)
233 if (!find_socket(serv
, IPPROTO_UDP
))
234 err
= svc_makesock(serv
, IPPROTO_UDP
, nlm_udpport
);
235 if (err
== 0 && (proto
== IPPROTO_TCP
|| nlm_tcpport
))
236 if (!find_socket(serv
, IPPROTO_TCP
))
237 err
= svc_makesock(serv
, IPPROTO_TCP
, nlm_tcpport
);
240 else if (warned
++ == 0)
242 "lockd_up: makesock failed, error=%d\n", err
);
247 * Bring up the lockd process if it's not already up.
250 lockd_up(int proto
) /* Maybe add a 'family' option when IPv6 is supported ?? */
252 struct svc_serv
* serv
;
255 mutex_lock(&nlmsvc_mutex
);
257 * Check whether we're already up and running.
261 error
= make_socks(nlmsvc_serv
, proto
);
266 * Sanity check: if there's no pid,
267 * we should be the first user ...
271 "lockd_up: no pid, %d users??\n", nlmsvc_users
);
274 serv
= svc_create(&nlmsvc_program
, LOCKD_BUFSIZE
, NULL
);
276 printk(KERN_WARNING
"lockd_up: create service failed\n");
280 if ((error
= make_socks(serv
, proto
)) < 0)
281 goto destroy_and_out
;
284 * Create the kernel thread and wait for it to start.
286 error
= svc_create_thread(lockd
, serv
);
289 "lockd_up: create thread failed, error=%d\n", error
);
290 goto destroy_and_out
;
292 wait_for_completion(&lockd_start_done
);
295 * Note: svc_serv structures have an initial use count of 1,
296 * so we exit through here on both success and failure.
303 mutex_unlock(&nlmsvc_mutex
);
306 EXPORT_SYMBOL(lockd_up
);
309 * Decrement the user count and bring down lockd if we're the last.
316 mutex_lock(&nlmsvc_mutex
);
321 printk(KERN_WARNING
"lockd_down: no users! pid=%d\n", nlmsvc_pid
);
325 printk(KERN_WARNING
"lockd_down: no lockd running.\n");
330 kill_proc(nlmsvc_pid
, SIGKILL
, 1);
332 * Wait for the lockd process to exit, but since we're holding
333 * the lockd semaphore, we can't wait around forever ...
335 clear_thread_flag(TIF_SIGPENDING
);
336 interruptible_sleep_on_timeout(&lockd_exit
, HZ
);
339 "lockd_down: lockd failed to exit, clearing pid\n");
342 spin_lock_irq(¤t
->sighand
->siglock
);
344 spin_unlock_irq(¤t
->sighand
->siglock
);
346 mutex_unlock(&nlmsvc_mutex
);
348 EXPORT_SYMBOL(lockd_down
);
351 * Sysctl parameters (same as module parameters, different interface).
354 /* Something that isn't CTL_ANY, CTL_NONE or a value that may clash. */
355 #define CTL_UNNUMBERED -2
357 static ctl_table nlm_sysctls
[] = {
359 .ctl_name
= CTL_UNNUMBERED
,
360 .procname
= "nlm_grace_period",
361 .data
= &nlm_grace_period
,
362 .maxlen
= sizeof(unsigned long),
364 .proc_handler
= &proc_doulongvec_minmax
,
365 .extra1
= (unsigned long *) &nlm_grace_period_min
,
366 .extra2
= (unsigned long *) &nlm_grace_period_max
,
369 .ctl_name
= CTL_UNNUMBERED
,
370 .procname
= "nlm_timeout",
371 .data
= &nlm_timeout
,
372 .maxlen
= sizeof(unsigned long),
374 .proc_handler
= &proc_doulongvec_minmax
,
375 .extra1
= (unsigned long *) &nlm_timeout_min
,
376 .extra2
= (unsigned long *) &nlm_timeout_max
,
379 .ctl_name
= CTL_UNNUMBERED
,
380 .procname
= "nlm_udpport",
381 .data
= &nlm_udpport
,
382 .maxlen
= sizeof(int),
384 .proc_handler
= &proc_dointvec_minmax
,
385 .extra1
= (int *) &nlm_port_min
,
386 .extra2
= (int *) &nlm_port_max
,
389 .ctl_name
= CTL_UNNUMBERED
,
390 .procname
= "nlm_tcpport",
391 .data
= &nlm_tcpport
,
392 .maxlen
= sizeof(int),
394 .proc_handler
= &proc_dointvec_minmax
,
395 .extra1
= (int *) &nlm_port_min
,
396 .extra2
= (int *) &nlm_port_max
,
401 static ctl_table nlm_sysctl_dir
[] = {
403 .ctl_name
= CTL_UNNUMBERED
,
406 .child
= nlm_sysctls
,
411 static ctl_table nlm_sysctl_root
[] = {
416 .child
= nlm_sysctl_dir
,
422 * Module (and driverfs) parameters.
425 #define param_set_min_max(name, type, which_strtol, min, max) \
426 static int param_set_##name(const char *val, struct kernel_param *kp) \
429 __typeof__(type) num = which_strtol(val, &endp, 0); \
430 if (endp == val || *endp || num < (min) || num > (max)) \
432 *((int *) kp->arg) = num; \
436 static inline int is_callback(u32 proc
)
438 return proc
== NLMPROC_GRANTED
439 || proc
== NLMPROC_GRANTED_MSG
440 || proc
== NLMPROC_TEST_RES
441 || proc
== NLMPROC_LOCK_RES
442 || proc
== NLMPROC_CANCEL_RES
443 || proc
== NLMPROC_UNLOCK_RES
444 || proc
== NLMPROC_NSM_NOTIFY
;
448 static int lockd_authenticate(struct svc_rqst
*rqstp
)
450 rqstp
->rq_client
= NULL
;
451 switch (rqstp
->rq_authop
->flavour
) {
454 if (rqstp
->rq_proc
== 0)
456 if (is_callback(rqstp
->rq_proc
)) {
457 /* Leave it to individual procedures to
458 * call nlmsvc_lookup_host(rqstp)
462 return svc_set_client(rqstp
);
468 param_set_min_max(port
, int, simple_strtol
, 0, 65535)
469 param_set_min_max(grace_period
, unsigned long, simple_strtoul
,
470 nlm_grace_period_min
, nlm_grace_period_max
)
471 param_set_min_max(timeout
, unsigned long, simple_strtoul
,
472 nlm_timeout_min
, nlm_timeout_max
)
474 MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
475 MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION
".");
476 MODULE_LICENSE("GPL");
478 module_param_call(nlm_grace_period
, param_set_grace_period
, param_get_ulong
,
479 &nlm_grace_period
, 0644);
480 module_param_call(nlm_timeout
, param_set_timeout
, param_get_ulong
,
482 module_param_call(nlm_udpport
, param_set_port
, param_get_int
,
484 module_param_call(nlm_tcpport
, param_set_port
, param_get_int
,
488 * Initialising and terminating the module.
491 static int __init
init_nlm(void)
493 nlm_sysctl_table
= register_sysctl_table(nlm_sysctl_root
, 0);
494 return nlm_sysctl_table
? 0 : -ENOMEM
;
497 static void __exit
exit_nlm(void)
499 /* FIXME: delete all NLM clients */
500 nlm_shutdown_hosts();
501 unregister_sysctl_table(nlm_sysctl_table
);
504 module_init(init_nlm
);
505 module_exit(exit_nlm
);
508 * Define NLM program and procedures
510 static struct svc_version nlmsvc_version1
= {
513 .vs_proc
= nlmsvc_procedures
,
514 .vs_xdrsize
= NLMSVC_XDRSIZE
,
516 static struct svc_version nlmsvc_version3
= {
519 .vs_proc
= nlmsvc_procedures
,
520 .vs_xdrsize
= NLMSVC_XDRSIZE
,
522 #ifdef CONFIG_LOCKD_V4
523 static struct svc_version nlmsvc_version4
= {
526 .vs_proc
= nlmsvc_procedures4
,
527 .vs_xdrsize
= NLMSVC_XDRSIZE
,
530 static struct svc_version
* nlmsvc_version
[] = {
531 [1] = &nlmsvc_version1
,
532 [3] = &nlmsvc_version3
,
533 #ifdef CONFIG_LOCKD_V4
534 [4] = &nlmsvc_version4
,
538 static struct svc_stat nlmsvc_stats
;
540 #define NLM_NRVERS ARRAY_SIZE(nlmsvc_version)
541 static struct svc_program nlmsvc_program
= {
542 .pg_prog
= NLM_PROGRAM
, /* program number */
543 .pg_nvers
= NLM_NRVERS
, /* number of entries in nlmsvc_version */
544 .pg_vers
= nlmsvc_version
, /* version table */
545 .pg_name
= "lockd", /* service name */
546 .pg_class
= "nfsd", /* share authentication with nfsd */
547 .pg_stats
= &nlmsvc_stats
, /* stats table */
548 .pg_authenticate
= &lockd_authenticate
/* export authentication */