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>
28 #include <linux/freezer.h>
30 #include <linux/sunrpc/types.h>
31 #include <linux/sunrpc/stats.h>
32 #include <linux/sunrpc/clnt.h>
33 #include <linux/sunrpc/svc.h>
34 #include <linux/sunrpc/svcsock.h>
36 #include <linux/lockd/lockd.h>
37 #include <linux/lockd/sm_inter.h>
38 #include <linux/nfs.h>
40 #define NLMDBG_FACILITY NLMDBG_SVC
41 #define LOCKD_BUFSIZE (1024 + NLMSVC_XDRSIZE)
42 #define ALLOWED_SIGS (sigmask(SIGKILL))
44 static struct svc_program nlmsvc_program
;
46 struct nlmsvc_binding
* nlmsvc_ops
;
47 EXPORT_SYMBOL(nlmsvc_ops
);
49 static DEFINE_MUTEX(nlmsvc_mutex
);
50 static unsigned int nlmsvc_users
;
51 static pid_t nlmsvc_pid
;
52 static struct svc_serv
*nlmsvc_serv
;
53 int nlmsvc_grace_period
;
54 unsigned long nlmsvc_timeout
;
56 static DECLARE_COMPLETION(lockd_start_done
);
57 static DECLARE_WAIT_QUEUE_HEAD(lockd_exit
);
60 * These can be set at insmod time (useful for NFS as root filesystem),
61 * and also changed through the sysctl interface. -- Jamie Lokier, Aug 2003
63 static unsigned long nlm_grace_period
;
64 static unsigned long nlm_timeout
= LOCKD_DFLT_TIMEO
;
65 static int nlm_udpport
, nlm_tcpport
;
66 int nsm_use_hostnames
= 0;
69 * Constants needed for the sysctl interface.
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;
77 static struct ctl_table_header
* nlm_sysctl_table
;
79 static unsigned long set_grace_period(void)
81 unsigned long grace_period
;
83 /* Note: nlm_timeout should always be nonzero */
85 grace_period
= ((nlm_grace_period
+ nlm_timeout
- 1)
86 / nlm_timeout
) * nlm_timeout
* HZ
;
88 grace_period
= nlm_timeout
* 5 * HZ
;
89 nlmsvc_grace_period
= 1;
90 return grace_period
+ jiffies
;
93 static inline void clear_grace_period(void)
95 nlmsvc_grace_period
= 0;
99 * This is the lockd kernel thread
102 lockd(struct svc_rqst
*rqstp
)
105 unsigned long grace_period_expire
;
107 /* Lock module and set up kernel thread */
108 /* lockd_up is waiting for us to startup, so will
109 * be holding a reference to this module, so it
110 * is safe to just claim another reference
112 __module_get(THIS_MODULE
);
116 * Let our maker know we're running.
118 nlmsvc_pid
= current
->pid
;
119 nlmsvc_serv
= rqstp
->rq_server
;
120 complete(&lockd_start_done
);
125 /* Process request with signals blocked, but allow SIGKILL. */
126 allow_signal(SIGKILL
);
128 dprintk("NFS locking service started (ver " LOCKD_VERSION
").\n");
131 nlm_timeout
= LOCKD_DFLT_TIMEO
;
132 nlmsvc_timeout
= nlm_timeout
* HZ
;
134 grace_period_expire
= set_grace_period();
137 * The main request loop. We don't terminate until the last
138 * NFS mount or NFS daemon has gone away, and we've been sent a
139 * signal, or else another process has taken over our job.
141 while ((nlmsvc_users
|| !signalled()) && nlmsvc_pid
== current
->pid
) {
142 long timeout
= MAX_SCHEDULE_TIMEOUT
;
143 char buf
[RPC_MAX_ADDRBUFLEN
];
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 %s\n",
179 svc_print_addr(rqstp
, buf
, sizeof(buf
)));
184 flush_signals(current
);
187 * Check whether there's a new lockd process before
188 * shutting down the hosts and clearing the slot.
190 if (!nlmsvc_pid
|| current
->pid
== nlmsvc_pid
) {
192 nlmsvc_invalidate_all();
193 nlm_shutdown_hosts();
198 "lockd: new process, skipping host shutdown\n");
199 wake_up(&lockd_exit
);
201 /* Exit the RPC thread */
202 svc_exit_thread(rqstp
);
206 module_put_and_exit(0);
210 static int find_socket(struct svc_serv
*serv
, int proto
)
212 struct svc_sock
*svsk
;
214 list_for_each_entry(svsk
, &serv
->sv_permsocks
, sk_list
)
215 if (svsk
->sk_sk
->sk_protocol
== proto
) {
223 * Make any sockets that are needed but not present.
224 * If nlm_udpport or nlm_tcpport were set as module
225 * options, make those sockets unconditionally
227 static int make_socks(struct svc_serv
*serv
, int proto
)
232 if (proto
== IPPROTO_UDP
|| nlm_udpport
)
233 if (!find_socket(serv
, IPPROTO_UDP
))
234 err
= svc_makesock(serv
, IPPROTO_UDP
, nlm_udpport
,
236 if (err
>= 0 && (proto
== IPPROTO_TCP
|| nlm_tcpport
))
237 if (!find_socket(serv
, IPPROTO_TCP
))
238 err
= svc_makesock(serv
, IPPROTO_TCP
, nlm_tcpport
,
244 } else if (warned
++ == 0)
246 "lockd_up: makesock failed, error=%d\n", err
);
251 * Bring up the lockd process if it's not already up.
254 lockd_up(int proto
) /* Maybe add a 'family' option when IPv6 is supported ?? */
256 struct svc_serv
* serv
;
259 mutex_lock(&nlmsvc_mutex
);
261 * Check whether we're already up and running.
265 error
= make_socks(nlmsvc_serv
, proto
);
270 * Sanity check: if there's no pid,
271 * we should be the first user ...
275 "lockd_up: no pid, %d users??\n", nlmsvc_users
);
278 serv
= svc_create(&nlmsvc_program
, LOCKD_BUFSIZE
, NULL
);
280 printk(KERN_WARNING
"lockd_up: create service failed\n");
284 if ((error
= make_socks(serv
, proto
)) < 0)
285 goto destroy_and_out
;
288 * Create the kernel thread and wait for it to start.
290 error
= svc_create_thread(lockd
, serv
);
293 "lockd_up: create thread failed, error=%d\n", error
);
294 goto destroy_and_out
;
296 wait_for_completion(&lockd_start_done
);
299 * Note: svc_serv structures have an initial use count of 1,
300 * so we exit through here on both success and failure.
307 mutex_unlock(&nlmsvc_mutex
);
310 EXPORT_SYMBOL(lockd_up
);
313 * Decrement the user count and bring down lockd if we're the last.
320 mutex_lock(&nlmsvc_mutex
);
325 printk(KERN_WARNING
"lockd_down: no users! pid=%d\n", nlmsvc_pid
);
329 printk(KERN_WARNING
"lockd_down: no lockd running.\n");
334 kill_proc(nlmsvc_pid
, SIGKILL
, 1);
336 * Wait for the lockd process to exit, but since we're holding
337 * the lockd semaphore, we can't wait around forever ...
339 clear_thread_flag(TIF_SIGPENDING
);
340 interruptible_sleep_on_timeout(&lockd_exit
, HZ
);
343 "lockd_down: lockd failed to exit, clearing pid\n");
346 spin_lock_irq(¤t
->sighand
->siglock
);
348 spin_unlock_irq(¤t
->sighand
->siglock
);
350 mutex_unlock(&nlmsvc_mutex
);
352 EXPORT_SYMBOL(lockd_down
);
355 * Sysctl parameters (same as module parameters, different interface).
358 static ctl_table nlm_sysctls
[] = {
360 .ctl_name
= CTL_UNNUMBERED
,
361 .procname
= "nlm_grace_period",
362 .data
= &nlm_grace_period
,
363 .maxlen
= sizeof(unsigned long),
365 .proc_handler
= &proc_doulongvec_minmax
,
366 .extra1
= (unsigned long *) &nlm_grace_period_min
,
367 .extra2
= (unsigned long *) &nlm_grace_period_max
,
370 .ctl_name
= CTL_UNNUMBERED
,
371 .procname
= "nlm_timeout",
372 .data
= &nlm_timeout
,
373 .maxlen
= sizeof(unsigned long),
375 .proc_handler
= &proc_doulongvec_minmax
,
376 .extra1
= (unsigned long *) &nlm_timeout_min
,
377 .extra2
= (unsigned long *) &nlm_timeout_max
,
380 .ctl_name
= CTL_UNNUMBERED
,
381 .procname
= "nlm_udpport",
382 .data
= &nlm_udpport
,
383 .maxlen
= sizeof(int),
385 .proc_handler
= &proc_dointvec_minmax
,
386 .extra1
= (int *) &nlm_port_min
,
387 .extra2
= (int *) &nlm_port_max
,
390 .ctl_name
= CTL_UNNUMBERED
,
391 .procname
= "nlm_tcpport",
392 .data
= &nlm_tcpport
,
393 .maxlen
= sizeof(int),
395 .proc_handler
= &proc_dointvec_minmax
,
396 .extra1
= (int *) &nlm_port_min
,
397 .extra2
= (int *) &nlm_port_max
,
400 .ctl_name
= CTL_UNNUMBERED
,
401 .procname
= "nsm_use_hostnames",
402 .data
= &nsm_use_hostnames
,
403 .maxlen
= sizeof(int),
405 .proc_handler
= &proc_dointvec
,
408 .ctl_name
= CTL_UNNUMBERED
,
409 .procname
= "nsm_local_state",
410 .data
= &nsm_local_state
,
411 .maxlen
= sizeof(int),
413 .proc_handler
= &proc_dointvec
,
418 static ctl_table nlm_sysctl_dir
[] = {
420 .ctl_name
= CTL_UNNUMBERED
,
423 .child
= nlm_sysctls
,
428 static ctl_table nlm_sysctl_root
[] = {
433 .child
= nlm_sysctl_dir
,
439 * Module (and sysfs) parameters.
442 #define param_set_min_max(name, type, which_strtol, min, max) \
443 static int param_set_##name(const char *val, struct kernel_param *kp) \
446 __typeof__(type) num = which_strtol(val, &endp, 0); \
447 if (endp == val || *endp || num < (min) || num > (max)) \
449 *((int *) kp->arg) = num; \
453 static inline int is_callback(u32 proc
)
455 return proc
== NLMPROC_GRANTED
456 || proc
== NLMPROC_GRANTED_MSG
457 || proc
== NLMPROC_TEST_RES
458 || proc
== NLMPROC_LOCK_RES
459 || proc
== NLMPROC_CANCEL_RES
460 || proc
== NLMPROC_UNLOCK_RES
461 || proc
== NLMPROC_NSM_NOTIFY
;
465 static int lockd_authenticate(struct svc_rqst
*rqstp
)
467 rqstp
->rq_client
= NULL
;
468 switch (rqstp
->rq_authop
->flavour
) {
471 if (rqstp
->rq_proc
== 0)
473 if (is_callback(rqstp
->rq_proc
)) {
474 /* Leave it to individual procedures to
475 * call nlmsvc_lookup_host(rqstp)
479 return svc_set_client(rqstp
);
485 param_set_min_max(port
, int, simple_strtol
, 0, 65535)
486 param_set_min_max(grace_period
, unsigned long, simple_strtoul
,
487 nlm_grace_period_min
, nlm_grace_period_max
)
488 param_set_min_max(timeout
, unsigned long, simple_strtoul
,
489 nlm_timeout_min
, nlm_timeout_max
)
491 MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
492 MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION
".");
493 MODULE_LICENSE("GPL");
495 module_param_call(nlm_grace_period
, param_set_grace_period
, param_get_ulong
,
496 &nlm_grace_period
, 0644);
497 module_param_call(nlm_timeout
, param_set_timeout
, param_get_ulong
,
499 module_param_call(nlm_udpport
, param_set_port
, param_get_int
,
501 module_param_call(nlm_tcpport
, param_set_port
, param_get_int
,
503 module_param(nsm_use_hostnames
, bool, 0644);
506 * Initialising and terminating the module.
509 static int __init
init_nlm(void)
511 nlm_sysctl_table
= register_sysctl_table(nlm_sysctl_root
);
512 return nlm_sysctl_table
? 0 : -ENOMEM
;
515 static void __exit
exit_nlm(void)
517 /* FIXME: delete all NLM clients */
518 nlm_shutdown_hosts();
519 unregister_sysctl_table(nlm_sysctl_table
);
522 module_init(init_nlm
);
523 module_exit(exit_nlm
);
526 * Define NLM program and procedures
528 static struct svc_version nlmsvc_version1
= {
531 .vs_proc
= nlmsvc_procedures
,
532 .vs_xdrsize
= NLMSVC_XDRSIZE
,
534 static struct svc_version nlmsvc_version3
= {
537 .vs_proc
= nlmsvc_procedures
,
538 .vs_xdrsize
= NLMSVC_XDRSIZE
,
540 #ifdef CONFIG_LOCKD_V4
541 static struct svc_version nlmsvc_version4
= {
544 .vs_proc
= nlmsvc_procedures4
,
545 .vs_xdrsize
= NLMSVC_XDRSIZE
,
548 static struct svc_version
* nlmsvc_version
[] = {
549 [1] = &nlmsvc_version1
,
550 [3] = &nlmsvc_version3
,
551 #ifdef CONFIG_LOCKD_V4
552 [4] = &nlmsvc_version4
,
556 static struct svc_stat nlmsvc_stats
;
558 #define NLM_NRVERS ARRAY_SIZE(nlmsvc_version)
559 static struct svc_program nlmsvc_program
= {
560 .pg_prog
= NLM_PROGRAM
, /* program number */
561 .pg_nvers
= NLM_NRVERS
, /* number of entries in nlmsvc_version */
562 .pg_vers
= nlmsvc_version
, /* version table */
563 .pg_name
= "lockd", /* service name */
564 .pg_class
= "nfsd", /* share authentication with nfsd */
565 .pg_stats
= &nlmsvc_stats
, /* stats table */
566 .pg_authenticate
= &lockd_authenticate
/* export authentication */