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/lockd/sm_inter.h>
37 #include <linux/nfs.h>
39 #define NLMDBG_FACILITY NLMDBG_SVC
40 #define LOCKD_BUFSIZE (1024 + NLMSVC_XDRSIZE)
41 #define ALLOWED_SIGS (sigmask(SIGKILL))
43 static struct svc_program nlmsvc_program
;
45 struct nlmsvc_binding
* nlmsvc_ops
;
46 EXPORT_SYMBOL(nlmsvc_ops
);
48 static DEFINE_MUTEX(nlmsvc_mutex
);
49 static unsigned int nlmsvc_users
;
50 static pid_t nlmsvc_pid
;
51 static struct svc_serv
*nlmsvc_serv
;
52 int nlmsvc_grace_period
;
53 unsigned long nlmsvc_timeout
;
55 static DECLARE_COMPLETION(lockd_start_done
);
56 static DECLARE_WAIT_QUEUE_HEAD(lockd_exit
);
59 * These can be set at insmod time (useful for NFS as root filesystem),
60 * and also changed through the sysctl interface. -- Jamie Lokier, Aug 2003
62 static unsigned long nlm_grace_period
;
63 static unsigned long nlm_timeout
= LOCKD_DFLT_TIMEO
;
64 static int nlm_udpport
, nlm_tcpport
;
65 int nsm_use_hostnames
= 0;
68 * Constants needed for the sysctl interface.
70 static const unsigned long nlm_grace_period_min
= 0;
71 static const unsigned long nlm_grace_period_max
= 240;
72 static const unsigned long nlm_timeout_min
= 3;
73 static const unsigned long nlm_timeout_max
= 20;
74 static const int nlm_port_min
= 0, nlm_port_max
= 65535;
76 static struct ctl_table_header
* nlm_sysctl_table
;
78 static unsigned long set_grace_period(void)
80 unsigned long grace_period
;
82 /* Note: nlm_timeout should always be nonzero */
84 grace_period
= ((nlm_grace_period
+ nlm_timeout
- 1)
85 / nlm_timeout
) * nlm_timeout
* HZ
;
87 grace_period
= nlm_timeout
* 5 * HZ
;
88 nlmsvc_grace_period
= 1;
89 return grace_period
+ jiffies
;
92 static inline void clear_grace_period(void)
94 nlmsvc_grace_period
= 0;
98 * This is the lockd kernel thread
101 lockd(struct svc_rqst
*rqstp
)
104 unsigned long grace_period_expire
;
106 /* Lock module and set up kernel thread */
107 /* lockd_up is waiting for us to startup, so will
108 * be holding a reference to this module, so it
109 * is safe to just claim another reference
111 __module_get(THIS_MODULE
);
115 * Let our maker know we're running.
117 nlmsvc_pid
= current
->pid
;
118 nlmsvc_serv
= rqstp
->rq_server
;
119 complete(&lockd_start_done
);
123 /* Process request with signals blocked, but allow SIGKILL. */
124 allow_signal(SIGKILL
);
129 dprintk("NFS locking service started (ver " LOCKD_VERSION
").\n");
132 nlm_timeout
= LOCKD_DFLT_TIMEO
;
133 nlmsvc_timeout
= nlm_timeout
* HZ
;
135 grace_period_expire
= set_grace_period();
138 * The main request loop. We don't terminate until the last
139 * NFS mount or NFS daemon has gone away, and we've been sent a
140 * signal, or else another process has taken over our job.
142 while ((nlmsvc_users
|| !signalled()) && nlmsvc_pid
== current
->pid
) {
143 long timeout
= MAX_SCHEDULE_TIMEOUT
;
146 flush_signals(current
);
148 nlmsvc_invalidate_all();
149 grace_period_expire
= set_grace_period();
154 * Retry any blocked locks that have been notified by
155 * the VFS. Don't do this during grace period.
156 * (Theoretically, there shouldn't even be blocked locks
157 * during grace period).
159 if (!nlmsvc_grace_period
) {
160 timeout
= nlmsvc_retry_blocked();
161 } else if (time_before(grace_period_expire
, jiffies
))
162 clear_grace_period();
165 * Find a socket with data available and call its
168 err
= svc_recv(rqstp
, timeout
);
169 if (err
== -EAGAIN
|| err
== -EINTR
)
173 "lockd: terminating on error %d\n",
178 dprintk("lockd: request from %08x\n",
179 (unsigned)ntohl(rqstp
->rq_addr
.sin_addr
.s_addr
));
185 flush_signals(current
);
188 * Check whether there's a new lockd process before
189 * shutting down the hosts and clearing the slot.
191 if (!nlmsvc_pid
|| current
->pid
== nlmsvc_pid
) {
193 nlmsvc_invalidate_all();
194 nlm_shutdown_hosts();
199 "lockd: new process, skipping host shutdown\n");
200 wake_up(&lockd_exit
);
202 /* Exit the RPC thread */
203 svc_exit_thread(rqstp
);
210 module_put_and_exit(0);
214 static int find_socket(struct svc_serv
*serv
, int proto
)
216 struct svc_sock
*svsk
;
218 list_for_each_entry(svsk
, &serv
->sv_permsocks
, sk_list
)
219 if (svsk
->sk_sk
->sk_protocol
== proto
) {
226 static int make_socks(struct svc_serv
*serv
, int proto
)
228 /* Make any sockets that are needed but not present.
229 * If nlm_udpport or nlm_tcpport were set as module
230 * options, make those sockets unconditionally
234 if (proto
== IPPROTO_UDP
|| nlm_udpport
)
235 if (!find_socket(serv
, IPPROTO_UDP
))
236 err
= svc_makesock(serv
, IPPROTO_UDP
, nlm_udpport
);
237 if (err
== 0 && (proto
== IPPROTO_TCP
|| nlm_tcpport
))
238 if (!find_socket(serv
, IPPROTO_TCP
))
239 err
= svc_makesock(serv
, IPPROTO_TCP
, nlm_tcpport
);
242 else if (warned
++ == 0)
244 "lockd_up: makesock failed, error=%d\n", err
);
249 * Bring up the lockd process if it's not already up.
252 lockd_up(int proto
) /* Maybe add a 'family' option when IPv6 is supported ?? */
254 struct svc_serv
* serv
;
257 mutex_lock(&nlmsvc_mutex
);
259 * Check whether we're already up and running.
263 error
= make_socks(nlmsvc_serv
, proto
);
268 * Sanity check: if there's no pid,
269 * we should be the first user ...
273 "lockd_up: no pid, %d users??\n", nlmsvc_users
);
276 serv
= svc_create(&nlmsvc_program
, LOCKD_BUFSIZE
, NULL
);
278 printk(KERN_WARNING
"lockd_up: create service failed\n");
282 if ((error
= make_socks(serv
, proto
)) < 0)
283 goto destroy_and_out
;
286 * Create the kernel thread and wait for it to start.
288 error
= svc_create_thread(lockd
, serv
);
291 "lockd_up: create thread failed, error=%d\n", error
);
292 goto destroy_and_out
;
294 wait_for_completion(&lockd_start_done
);
297 * Note: svc_serv structures have an initial use count of 1,
298 * so we exit through here on both success and failure.
305 mutex_unlock(&nlmsvc_mutex
);
308 EXPORT_SYMBOL(lockd_up
);
311 * Decrement the user count and bring down lockd if we're the last.
318 mutex_lock(&nlmsvc_mutex
);
323 printk(KERN_WARNING
"lockd_down: no users! pid=%d\n", nlmsvc_pid
);
327 printk(KERN_WARNING
"lockd_down: no lockd running.\n");
332 kill_proc(nlmsvc_pid
, SIGKILL
, 1);
334 * Wait for the lockd process to exit, but since we're holding
335 * the lockd semaphore, we can't wait around forever ...
337 clear_thread_flag(TIF_SIGPENDING
);
338 interruptible_sleep_on_timeout(&lockd_exit
, HZ
);
341 "lockd_down: lockd failed to exit, clearing pid\n");
344 spin_lock_irq(¤t
->sighand
->siglock
);
346 spin_unlock_irq(¤t
->sighand
->siglock
);
348 mutex_unlock(&nlmsvc_mutex
);
350 EXPORT_SYMBOL(lockd_down
);
353 * Sysctl parameters (same as module parameters, different interface).
356 static ctl_table nlm_sysctls
[] = {
358 .ctl_name
= CTL_UNNUMBERED
,
359 .procname
= "nlm_grace_period",
360 .data
= &nlm_grace_period
,
361 .maxlen
= sizeof(unsigned long),
363 .proc_handler
= &proc_doulongvec_minmax
,
364 .extra1
= (unsigned long *) &nlm_grace_period_min
,
365 .extra2
= (unsigned long *) &nlm_grace_period_max
,
368 .ctl_name
= CTL_UNNUMBERED
,
369 .procname
= "nlm_timeout",
370 .data
= &nlm_timeout
,
371 .maxlen
= sizeof(unsigned long),
373 .proc_handler
= &proc_doulongvec_minmax
,
374 .extra1
= (unsigned long *) &nlm_timeout_min
,
375 .extra2
= (unsigned long *) &nlm_timeout_max
,
378 .ctl_name
= CTL_UNNUMBERED
,
379 .procname
= "nlm_udpport",
380 .data
= &nlm_udpport
,
381 .maxlen
= sizeof(int),
383 .proc_handler
= &proc_dointvec_minmax
,
384 .extra1
= (int *) &nlm_port_min
,
385 .extra2
= (int *) &nlm_port_max
,
388 .ctl_name
= CTL_UNNUMBERED
,
389 .procname
= "nlm_tcpport",
390 .data
= &nlm_tcpport
,
391 .maxlen
= sizeof(int),
393 .proc_handler
= &proc_dointvec_minmax
,
394 .extra1
= (int *) &nlm_port_min
,
395 .extra2
= (int *) &nlm_port_max
,
398 .ctl_name
= CTL_UNNUMBERED
,
399 .procname
= "nsm_use_hostnames",
400 .data
= &nsm_use_hostnames
,
401 .maxlen
= sizeof(int),
403 .proc_handler
= &proc_dointvec
,
406 .ctl_name
= CTL_UNNUMBERED
,
407 .procname
= "nsm_local_state",
408 .data
= &nsm_local_state
,
409 .maxlen
= sizeof(int),
411 .proc_handler
= &proc_dointvec
,
416 static ctl_table nlm_sysctl_dir
[] = {
418 .ctl_name
= CTL_UNNUMBERED
,
421 .child
= nlm_sysctls
,
426 static ctl_table nlm_sysctl_root
[] = {
431 .child
= nlm_sysctl_dir
,
437 * Module (and driverfs) parameters.
440 #define param_set_min_max(name, type, which_strtol, min, max) \
441 static int param_set_##name(const char *val, struct kernel_param *kp) \
444 __typeof__(type) num = which_strtol(val, &endp, 0); \
445 if (endp == val || *endp || num < (min) || num > (max)) \
447 *((int *) kp->arg) = num; \
451 static inline int is_callback(u32 proc
)
453 return proc
== NLMPROC_GRANTED
454 || proc
== NLMPROC_GRANTED_MSG
455 || proc
== NLMPROC_TEST_RES
456 || proc
== NLMPROC_LOCK_RES
457 || proc
== NLMPROC_CANCEL_RES
458 || proc
== NLMPROC_UNLOCK_RES
459 || proc
== NLMPROC_NSM_NOTIFY
;
463 static int lockd_authenticate(struct svc_rqst
*rqstp
)
465 rqstp
->rq_client
= NULL
;
466 switch (rqstp
->rq_authop
->flavour
) {
469 if (rqstp
->rq_proc
== 0)
471 if (is_callback(rqstp
->rq_proc
)) {
472 /* Leave it to individual procedures to
473 * call nlmsvc_lookup_host(rqstp)
477 return svc_set_client(rqstp
);
483 param_set_min_max(port
, int, simple_strtol
, 0, 65535)
484 param_set_min_max(grace_period
, unsigned long, simple_strtoul
,
485 nlm_grace_period_min
, nlm_grace_period_max
)
486 param_set_min_max(timeout
, unsigned long, simple_strtoul
,
487 nlm_timeout_min
, nlm_timeout_max
)
489 MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
490 MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION
".");
491 MODULE_LICENSE("GPL");
493 module_param_call(nlm_grace_period
, param_set_grace_period
, param_get_ulong
,
494 &nlm_grace_period
, 0644);
495 module_param_call(nlm_timeout
, param_set_timeout
, param_get_ulong
,
497 module_param_call(nlm_udpport
, param_set_port
, param_get_int
,
499 module_param_call(nlm_tcpport
, param_set_port
, param_get_int
,
501 module_param(nsm_use_hostnames
, bool, 0644);
504 * Initialising and terminating the module.
507 static int __init
init_nlm(void)
509 nlm_sysctl_table
= register_sysctl_table(nlm_sysctl_root
, 0);
510 return nlm_sysctl_table
? 0 : -ENOMEM
;
513 static void __exit
exit_nlm(void)
515 /* FIXME: delete all NLM clients */
516 nlm_shutdown_hosts();
517 unregister_sysctl_table(nlm_sysctl_table
);
520 module_init(init_nlm
);
521 module_exit(exit_nlm
);
524 * Define NLM program and procedures
526 static struct svc_version nlmsvc_version1
= {
529 .vs_proc
= nlmsvc_procedures
,
530 .vs_xdrsize
= NLMSVC_XDRSIZE
,
532 static struct svc_version nlmsvc_version3
= {
535 .vs_proc
= nlmsvc_procedures
,
536 .vs_xdrsize
= NLMSVC_XDRSIZE
,
538 #ifdef CONFIG_LOCKD_V4
539 static struct svc_version nlmsvc_version4
= {
542 .vs_proc
= nlmsvc_procedures4
,
543 .vs_xdrsize
= NLMSVC_XDRSIZE
,
546 static struct svc_version
* nlmsvc_version
[] = {
547 [1] = &nlmsvc_version1
,
548 [3] = &nlmsvc_version3
,
549 #ifdef CONFIG_LOCKD_V4
550 [4] = &nlmsvc_version4
,
554 static struct svc_stat nlmsvc_stats
;
556 #define NLM_NRVERS ARRAY_SIZE(nlmsvc_version)
557 static struct svc_program nlmsvc_program
= {
558 .pg_prog
= NLM_PROGRAM
, /* program number */
559 .pg_nvers
= NLM_NRVERS
, /* number of entries in nlmsvc_version */
560 .pg_vers
= nlmsvc_version
, /* version table */
561 .pg_name
= "lockd", /* service name */
562 .pg_class
= "nfsd", /* share authentication with nfsd */
563 .pg_stats
= &nlmsvc_stats
, /* stats table */
564 .pg_authenticate
= &lockd_authenticate
/* export authentication */