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/smp.h>
25 #include <linux/mutex.h>
26 #include <linux/kthread.h>
27 #include <linux/freezer.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_GPL(nlmsvc_ops
);
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
;
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
57 static unsigned long nlm_grace_period
;
58 static unsigned long nlm_timeout
= LOCKD_DFLT_TIMEO
;
59 static int nlm_udpport
, nlm_tcpport
;
61 /* RLIM_NOFILE defaults to 1024. That seems like a reasonable default here. */
62 static unsigned int nlm_max_connections
= 1024;
65 * Constants needed for the sysctl interface.
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;
74 static struct ctl_table_header
* nlm_sysctl_table
;
77 static unsigned long get_lockd_grace_period(void)
79 /* Note: nlm_timeout should always be nonzero */
81 return roundup(nlm_grace_period
, nlm_timeout
) * HZ
;
83 return nlm_timeout
* 5 * HZ
;
86 static struct lock_manager lockd_manager
= {
89 static void grace_ender(struct work_struct
*not_used
)
91 locks_end_grace(&lockd_manager
);
94 static DECLARE_DELAYED_WORK(grace_period_end
, grace_ender
);
96 static void set_grace_period(void)
98 unsigned long grace_period
= get_lockd_grace_period();
100 locks_start_grace(&lockd_manager
);
101 cancel_delayed_work_sync(&grace_period_end
);
102 schedule_delayed_work(&grace_period_end
, grace_period
);
105 static void restart_grace(void)
108 cancel_delayed_work_sync(&grace_period_end
);
109 locks_end_grace(&lockd_manager
);
110 nlmsvc_invalidate_all();
116 * This is the lockd kernel thread
121 int err
= 0, preverr
= 0;
122 struct svc_rqst
*rqstp
= vrqstp
;
124 /* try_to_freeze() is called from svc_recv() */
127 /* Allow SIGKILL to tell lockd to drop all of its locks */
128 allow_signal(SIGKILL
);
130 dprintk("NFS locking service started (ver " LOCKD_VERSION
").\n");
133 nlm_timeout
= LOCKD_DFLT_TIMEO
;
134 nlmsvc_timeout
= nlm_timeout
* HZ
;
139 * The main request loop. We don't terminate until the last
140 * NFS mount or NFS daemon has gone away.
142 while (!kthread_should_stop()) {
143 long timeout
= MAX_SCHEDULE_TIMEOUT
;
144 RPC_IFDEBUG(char buf
[RPC_MAX_ADDRBUFLEN
]);
146 /* update sv_maxconn if it has changed */
147 rqstp
->rq_server
->sv_maxconn
= nlm_max_connections
;
150 flush_signals(current
);
155 timeout
= nlmsvc_retry_blocked();
158 * Find a socket with data available and call its
161 err
= svc_recv(rqstp
, timeout
);
162 if (err
== -EAGAIN
|| err
== -EINTR
) {
167 if (err
!= preverr
) {
168 printk(KERN_WARNING
"%s: unexpected error "
169 "from svc_recv (%d)\n", __func__
, err
);
172 schedule_timeout_interruptible(HZ
);
177 dprintk("lockd: request from %s\n",
178 svc_print_addr(rqstp
, buf
, sizeof(buf
)));
182 flush_signals(current
);
183 cancel_delayed_work_sync(&grace_period_end
);
184 locks_end_grace(&lockd_manager
);
186 nlmsvc_invalidate_all();
187 nlm_shutdown_hosts();
191 static int create_lockd_listener(struct svc_serv
*serv
, const char *name
,
192 const int family
, const unsigned short port
)
194 struct svc_xprt
*xprt
;
196 xprt
= svc_find_xprt(serv
, name
, family
, 0);
198 return svc_create_xprt(serv
, name
, &init_net
, family
, port
,
204 static int create_lockd_family(struct svc_serv
*serv
, const int family
)
208 err
= create_lockd_listener(serv
, "udp", family
, nlm_udpport
);
212 return create_lockd_listener(serv
, "tcp", family
, nlm_tcpport
);
216 * Ensure there are active UDP and TCP listeners for lockd.
218 * Even if we have only TCP NFS mounts and/or TCP NFSDs, some
219 * local services (such as rpc.statd) still require UDP, and
220 * some NFS servers do not yet support NLM over TCP.
222 * Returns zero if all listeners are available; otherwise a
223 * negative errno value is returned.
225 static int make_socks(struct svc_serv
*serv
)
230 err
= create_lockd_family(serv
, PF_INET
);
234 err
= create_lockd_family(serv
, PF_INET6
);
235 if (err
< 0 && err
!= -EAFNOSUPPORT
)
244 "lockd_up: makesock failed, error=%d\n", err
);
249 * Bring up the lockd process if it's not already up.
253 struct svc_serv
*serv
;
256 mutex_lock(&nlmsvc_mutex
);
258 * Check whether we're already up and running.
264 * Sanity check: if there's no pid,
265 * we should be the first user ...
269 "lockd_up: no pid, %d users??\n", nlmsvc_users
);
272 serv
= svc_create(&nlmsvc_program
, LOCKD_BUFSIZE
, NULL
);
274 printk(KERN_WARNING
"lockd_up: create service failed\n");
278 error
= make_socks(serv
);
280 goto destroy_and_out
;
283 * Create the kernel thread and wait for it to start.
285 nlmsvc_rqst
= svc_prepare_thread(serv
, &serv
->sv_pools
[0], NUMA_NO_NODE
);
286 if (IS_ERR(nlmsvc_rqst
)) {
287 error
= PTR_ERR(nlmsvc_rqst
);
290 "lockd_up: svc_rqst allocation failed, error=%d\n",
292 goto destroy_and_out
;
295 svc_sock_update_bufs(serv
);
296 serv
->sv_maxconn
= nlm_max_connections
;
298 nlmsvc_task
= kthread_run(lockd
, nlmsvc_rqst
, serv
->sv_name
);
299 if (IS_ERR(nlmsvc_task
)) {
300 error
= PTR_ERR(nlmsvc_task
);
301 svc_exit_thread(nlmsvc_rqst
);
305 "lockd_up: kthread_run failed, error=%d\n", error
);
306 goto destroy_and_out
;
310 * Note: svc_serv structures have an initial use count of 1,
311 * so we exit through here on both success and failure.
318 mutex_unlock(&nlmsvc_mutex
);
321 EXPORT_SYMBOL_GPL(lockd_up
);
324 * Decrement the user count and bring down lockd if we're the last.
329 mutex_lock(&nlmsvc_mutex
);
334 printk(KERN_ERR
"lockd_down: no users! task=%p\n",
340 printk(KERN_ERR
"lockd_down: no lockd running.\n");
343 kthread_stop(nlmsvc_task
);
344 svc_exit_thread(nlmsvc_rqst
);
348 mutex_unlock(&nlmsvc_mutex
);
350 EXPORT_SYMBOL_GPL(lockd_down
);
355 * Sysctl parameters (same as module parameters, different interface).
358 static ctl_table nlm_sysctls
[] = {
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 .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 .procname
= "nlm_udpport",
379 .data
= &nlm_udpport
,
380 .maxlen
= sizeof(int),
382 .proc_handler
= proc_dointvec_minmax
,
383 .extra1
= (int *) &nlm_port_min
,
384 .extra2
= (int *) &nlm_port_max
,
387 .procname
= "nlm_tcpport",
388 .data
= &nlm_tcpport
,
389 .maxlen
= sizeof(int),
391 .proc_handler
= proc_dointvec_minmax
,
392 .extra1
= (int *) &nlm_port_min
,
393 .extra2
= (int *) &nlm_port_max
,
396 .procname
= "nsm_use_hostnames",
397 .data
= &nsm_use_hostnames
,
398 .maxlen
= sizeof(int),
400 .proc_handler
= proc_dointvec
,
403 .procname
= "nsm_local_state",
404 .data
= &nsm_local_state
,
405 .maxlen
= sizeof(int),
407 .proc_handler
= proc_dointvec
,
412 static ctl_table nlm_sysctl_dir
[] = {
416 .child
= nlm_sysctls
,
421 static ctl_table nlm_sysctl_root
[] = {
425 .child
= nlm_sysctl_dir
,
430 #endif /* CONFIG_SYSCTL */
433 * Module (and sysfs) parameters.
436 #define param_set_min_max(name, type, which_strtol, min, max) \
437 static int param_set_##name(const char *val, struct kernel_param *kp) \
440 __typeof__(type) num = which_strtol(val, &endp, 0); \
441 if (endp == val || *endp || num < (min) || num > (max)) \
443 *((type *) kp->arg) = num; \
447 static inline int is_callback(u32 proc
)
449 return proc
== NLMPROC_GRANTED
450 || proc
== NLMPROC_GRANTED_MSG
451 || proc
== NLMPROC_TEST_RES
452 || proc
== NLMPROC_LOCK_RES
453 || proc
== NLMPROC_CANCEL_RES
454 || proc
== NLMPROC_UNLOCK_RES
455 || proc
== NLMPROC_NSM_NOTIFY
;
459 static int lockd_authenticate(struct svc_rqst
*rqstp
)
461 rqstp
->rq_client
= NULL
;
462 switch (rqstp
->rq_authop
->flavour
) {
465 if (rqstp
->rq_proc
== 0)
467 if (is_callback(rqstp
->rq_proc
)) {
468 /* Leave it to individual procedures to
469 * call nlmsvc_lookup_host(rqstp)
473 return svc_set_client(rqstp
);
479 param_set_min_max(port
, int, simple_strtol
, 0, 65535)
480 param_set_min_max(grace_period
, unsigned long, simple_strtoul
,
481 nlm_grace_period_min
, nlm_grace_period_max
)
482 param_set_min_max(timeout
, unsigned long, simple_strtoul
,
483 nlm_timeout_min
, nlm_timeout_max
)
485 MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
486 MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION
".");
487 MODULE_LICENSE("GPL");
489 module_param_call(nlm_grace_period
, param_set_grace_period
, param_get_ulong
,
490 &nlm_grace_period
, 0644);
491 module_param_call(nlm_timeout
, param_set_timeout
, param_get_ulong
,
493 module_param_call(nlm_udpport
, param_set_port
, param_get_int
,
495 module_param_call(nlm_tcpport
, param_set_port
, param_get_int
,
497 module_param(nsm_use_hostnames
, bool, 0644);
498 module_param(nlm_max_connections
, uint
, 0644);
501 * Initialising and terminating the module.
504 static int __init
init_nlm(void)
507 nlm_sysctl_table
= register_sysctl_table(nlm_sysctl_root
);
508 return nlm_sysctl_table
? 0 : -ENOMEM
;
514 static void __exit
exit_nlm(void)
516 /* FIXME: delete all NLM clients */
517 nlm_shutdown_hosts();
519 unregister_sysctl_table(nlm_sysctl_table
);
523 module_init(init_nlm
);
524 module_exit(exit_nlm
);
527 * Define NLM program and procedures
529 static struct svc_version nlmsvc_version1
= {
532 .vs_proc
= nlmsvc_procedures
,
533 .vs_xdrsize
= NLMSVC_XDRSIZE
,
535 static struct svc_version nlmsvc_version3
= {
538 .vs_proc
= nlmsvc_procedures
,
539 .vs_xdrsize
= NLMSVC_XDRSIZE
,
541 #ifdef CONFIG_LOCKD_V4
542 static struct svc_version nlmsvc_version4
= {
545 .vs_proc
= nlmsvc_procedures4
,
546 .vs_xdrsize
= NLMSVC_XDRSIZE
,
549 static struct svc_version
* nlmsvc_version
[] = {
550 [1] = &nlmsvc_version1
,
551 [3] = &nlmsvc_version3
,
552 #ifdef CONFIG_LOCKD_V4
553 [4] = &nlmsvc_version4
,
557 static struct svc_stat nlmsvc_stats
;
559 #define NLM_NRVERS ARRAY_SIZE(nlmsvc_version)
560 static struct svc_program nlmsvc_program
= {
561 .pg_prog
= NLM_PROGRAM
, /* program number */
562 .pg_nvers
= NLM_NRVERS
, /* number of entries in nlmsvc_version */
563 .pg_vers
= nlmsvc_version
, /* version table */
564 .pg_name
= "lockd", /* service name */
565 .pg_class
= "nfsd", /* share authentication with nfsd */
566 .pg_stats
= &nlmsvc_stats
, /* stats table */
567 .pg_authenticate
= &lockd_authenticate
/* export authentication */