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>
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_GPL(nlmsvc_ops
);
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
;
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
;
65 /* RLIM_NOFILE defaults to 1024. That seems like a reasonable default here. */
66 static unsigned int nlm_max_connections
= 1024;
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;
78 static struct ctl_table_header
* nlm_sysctl_table
;
81 static unsigned long get_lockd_grace_period(void)
83 /* Note: nlm_timeout should always be nonzero */
85 return roundup(nlm_grace_period
, nlm_timeout
) * HZ
;
87 return nlm_timeout
* 5 * HZ
;
90 static struct lock_manager lockd_manager
= {
93 static void grace_ender(struct work_struct
*not_used
)
95 locks_end_grace(&lockd_manager
);
98 static DECLARE_DELAYED_WORK(grace_period_end
, grace_ender
);
100 static void set_grace_period(void)
102 unsigned long grace_period
= get_lockd_grace_period();
104 locks_start_grace(&lockd_manager
);
105 cancel_delayed_work_sync(&grace_period_end
);
106 schedule_delayed_work(&grace_period_end
, grace_period
);
109 static void restart_grace(void)
112 cancel_delayed_work_sync(&grace_period_end
);
113 locks_end_grace(&lockd_manager
);
114 nlmsvc_invalidate_all();
120 * This is the lockd kernel thread
125 int err
= 0, preverr
= 0;
126 struct svc_rqst
*rqstp
= vrqstp
;
128 /* try_to_freeze() is called from svc_recv() */
131 /* Allow SIGKILL to tell lockd to drop all of its locks */
132 allow_signal(SIGKILL
);
134 dprintk("NFS locking service started (ver " LOCKD_VERSION
").\n");
137 nlm_timeout
= LOCKD_DFLT_TIMEO
;
138 nlmsvc_timeout
= nlm_timeout
* HZ
;
143 * The main request loop. We don't terminate until the last
144 * NFS mount or NFS daemon has gone away.
146 while (!kthread_should_stop()) {
147 long timeout
= MAX_SCHEDULE_TIMEOUT
;
148 RPC_IFDEBUG(char buf
[RPC_MAX_ADDRBUFLEN
]);
150 /* update sv_maxconn if it has changed */
151 rqstp
->rq_server
->sv_maxconn
= nlm_max_connections
;
154 flush_signals(current
);
159 timeout
= nlmsvc_retry_blocked();
162 * Find a socket with data available and call its
165 err
= svc_recv(rqstp
, timeout
);
166 if (err
== -EAGAIN
|| err
== -EINTR
) {
171 if (err
!= preverr
) {
172 printk(KERN_WARNING
"%s: unexpected error "
173 "from svc_recv (%d)\n", __func__
, err
);
176 schedule_timeout_interruptible(HZ
);
181 dprintk("lockd: request from %s\n",
182 svc_print_addr(rqstp
, buf
, sizeof(buf
)));
186 flush_signals(current
);
187 cancel_delayed_work_sync(&grace_period_end
);
188 locks_end_grace(&lockd_manager
);
190 nlmsvc_invalidate_all();
191 nlm_shutdown_hosts();
195 static int create_lockd_listener(struct svc_serv
*serv
, const char *name
,
196 struct net
*net
, const int family
,
197 const unsigned short port
)
199 struct svc_xprt
*xprt
;
201 xprt
= svc_find_xprt(serv
, name
, net
, family
, 0);
203 return svc_create_xprt(serv
, name
, net
, family
, port
,
209 static int create_lockd_family(struct svc_serv
*serv
, struct net
*net
,
214 err
= create_lockd_listener(serv
, "udp", net
, family
, nlm_udpport
);
218 return create_lockd_listener(serv
, "tcp", net
, family
, nlm_tcpport
);
222 * Ensure there are active UDP and TCP listeners for lockd.
224 * Even if we have only TCP NFS mounts and/or TCP NFSDs, some
225 * local services (such as rpc.statd) still require UDP, and
226 * some NFS servers do not yet support NLM over TCP.
228 * Returns zero if all listeners are available; otherwise a
229 * negative errno value is returned.
231 static int make_socks(struct svc_serv
*serv
, struct net
*net
)
236 err
= create_lockd_family(serv
, net
, PF_INET
);
240 err
= create_lockd_family(serv
, net
, PF_INET6
);
241 if (err
< 0 && err
!= -EAFNOSUPPORT
)
250 "lockd_up: makesock failed, error=%d\n", err
);
254 static int lockd_up_net(struct svc_serv
*serv
, struct net
*net
)
256 struct lockd_net
*ln
= net_generic(net
, lockd_net_id
);
259 if (ln
->nlmsvc_users
++)
262 error
= svc_bind(serv
, net
);
266 error
= make_socks(serv
, net
);
272 svc_rpcb_cleanup(serv
, net
);
278 static void lockd_down_net(struct svc_serv
*serv
, struct net
*net
)
280 struct lockd_net
*ln
= net_generic(net
, lockd_net_id
);
282 if (ln
->nlmsvc_users
) {
283 if (--ln
->nlmsvc_users
== 0) {
284 nlm_shutdown_hosts_net(net
);
285 svc_shutdown_net(serv
, net
);
288 printk(KERN_ERR
"lockd_down_net: no users! task=%p, net=%p\n",
294 static struct svc_serv
*lockd_create_svc(void)
296 struct svc_serv
*serv
;
299 * Check whether we're already up and running.
303 * Note: increase service usage, because later in case of error
304 * svc_destroy() will be called.
306 svc_get(nlmsvc_rqst
->rq_server
);
307 return nlmsvc_rqst
->rq_server
;
311 * Sanity check: if there's no pid,
312 * we should be the first user ...
316 "lockd_up: no pid, %d users??\n", nlmsvc_users
);
318 serv
= svc_create(&nlmsvc_program
, LOCKD_BUFSIZE
, NULL
);
320 printk(KERN_WARNING
"lockd_up: create service failed\n");
321 return ERR_PTR(-ENOMEM
);
327 * Bring up the lockd process if it's not already up.
329 int lockd_up(struct net
*net
)
331 struct svc_serv
*serv
;
334 mutex_lock(&nlmsvc_mutex
);
336 serv
= lockd_create_svc();
338 error
= PTR_ERR(serv
);
342 error
= lockd_up_net(serv
, net
);
347 * Create the kernel thread and wait for it to start.
349 nlmsvc_rqst
= svc_prepare_thread(serv
, &serv
->sv_pools
[0], NUMA_NO_NODE
);
350 if (IS_ERR(nlmsvc_rqst
)) {
351 error
= PTR_ERR(nlmsvc_rqst
);
354 "lockd_up: svc_rqst allocation failed, error=%d\n",
359 svc_sock_update_bufs(serv
);
360 serv
->sv_maxconn
= nlm_max_connections
;
362 nlmsvc_task
= kthread_run(lockd
, nlmsvc_rqst
, serv
->sv_name
);
363 if (IS_ERR(nlmsvc_task
)) {
364 error
= PTR_ERR(nlmsvc_task
);
365 svc_exit_thread(nlmsvc_rqst
);
369 "lockd_up: kthread_run failed, error=%d\n", error
);
375 * Note: svc_serv structures have an initial use count of 1,
376 * so we exit through here on both success and failure.
381 mutex_unlock(&nlmsvc_mutex
);
385 lockd_down_net(serv
, net
);
388 EXPORT_SYMBOL_GPL(lockd_up
);
391 * Decrement the user count and bring down lockd if we're the last.
394 lockd_down(struct net
*net
)
396 mutex_lock(&nlmsvc_mutex
);
397 lockd_down_net(nlmsvc_rqst
->rq_server
, net
);
402 printk(KERN_ERR
"lockd_down: no users! task=%p\n",
408 printk(KERN_ERR
"lockd_down: no lockd running.\n");
411 kthread_stop(nlmsvc_task
);
412 svc_exit_thread(nlmsvc_rqst
);
416 mutex_unlock(&nlmsvc_mutex
);
418 EXPORT_SYMBOL_GPL(lockd_down
);
423 * Sysctl parameters (same as module parameters, different interface).
426 static ctl_table nlm_sysctls
[] = {
428 .procname
= "nlm_grace_period",
429 .data
= &nlm_grace_period
,
430 .maxlen
= sizeof(unsigned long),
432 .proc_handler
= proc_doulongvec_minmax
,
433 .extra1
= (unsigned long *) &nlm_grace_period_min
,
434 .extra2
= (unsigned long *) &nlm_grace_period_max
,
437 .procname
= "nlm_timeout",
438 .data
= &nlm_timeout
,
439 .maxlen
= sizeof(unsigned long),
441 .proc_handler
= proc_doulongvec_minmax
,
442 .extra1
= (unsigned long *) &nlm_timeout_min
,
443 .extra2
= (unsigned long *) &nlm_timeout_max
,
446 .procname
= "nlm_udpport",
447 .data
= &nlm_udpport
,
448 .maxlen
= sizeof(int),
450 .proc_handler
= proc_dointvec_minmax
,
451 .extra1
= (int *) &nlm_port_min
,
452 .extra2
= (int *) &nlm_port_max
,
455 .procname
= "nlm_tcpport",
456 .data
= &nlm_tcpport
,
457 .maxlen
= sizeof(int),
459 .proc_handler
= proc_dointvec_minmax
,
460 .extra1
= (int *) &nlm_port_min
,
461 .extra2
= (int *) &nlm_port_max
,
464 .procname
= "nsm_use_hostnames",
465 .data
= &nsm_use_hostnames
,
466 .maxlen
= sizeof(int),
468 .proc_handler
= proc_dointvec
,
471 .procname
= "nsm_local_state",
472 .data
= &nsm_local_state
,
473 .maxlen
= sizeof(int),
475 .proc_handler
= proc_dointvec
,
480 static ctl_table nlm_sysctl_dir
[] = {
484 .child
= nlm_sysctls
,
489 static ctl_table nlm_sysctl_root
[] = {
493 .child
= nlm_sysctl_dir
,
498 #endif /* CONFIG_SYSCTL */
501 * Module (and sysfs) parameters.
504 #define param_set_min_max(name, type, which_strtol, min, max) \
505 static int param_set_##name(const char *val, struct kernel_param *kp) \
508 __typeof__(type) num = which_strtol(val, &endp, 0); \
509 if (endp == val || *endp || num < (min) || num > (max)) \
511 *((type *) kp->arg) = num; \
515 static inline int is_callback(u32 proc
)
517 return proc
== NLMPROC_GRANTED
518 || proc
== NLMPROC_GRANTED_MSG
519 || proc
== NLMPROC_TEST_RES
520 || proc
== NLMPROC_LOCK_RES
521 || proc
== NLMPROC_CANCEL_RES
522 || proc
== NLMPROC_UNLOCK_RES
523 || proc
== NLMPROC_NSM_NOTIFY
;
527 static int lockd_authenticate(struct svc_rqst
*rqstp
)
529 rqstp
->rq_client
= NULL
;
530 switch (rqstp
->rq_authop
->flavour
) {
533 if (rqstp
->rq_proc
== 0)
535 if (is_callback(rqstp
->rq_proc
)) {
536 /* Leave it to individual procedures to
537 * call nlmsvc_lookup_host(rqstp)
541 return svc_set_client(rqstp
);
547 param_set_min_max(port
, int, simple_strtol
, 0, 65535)
548 param_set_min_max(grace_period
, unsigned long, simple_strtoul
,
549 nlm_grace_period_min
, nlm_grace_period_max
)
550 param_set_min_max(timeout
, unsigned long, simple_strtoul
,
551 nlm_timeout_min
, nlm_timeout_max
)
553 MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
554 MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION
".");
555 MODULE_LICENSE("GPL");
557 module_param_call(nlm_grace_period
, param_set_grace_period
, param_get_ulong
,
558 &nlm_grace_period
, 0644);
559 module_param_call(nlm_timeout
, param_set_timeout
, param_get_ulong
,
561 module_param_call(nlm_udpport
, param_set_port
, param_get_int
,
563 module_param_call(nlm_tcpport
, param_set_port
, param_get_int
,
565 module_param(nsm_use_hostnames
, bool, 0644);
566 module_param(nlm_max_connections
, uint
, 0644);
568 static int lockd_init_net(struct net
*net
)
573 static void lockd_exit_net(struct net
*net
)
577 static struct pernet_operations lockd_net_ops
= {
578 .init
= lockd_init_net
,
579 .exit
= lockd_exit_net
,
581 .size
= sizeof(struct lockd_net
),
586 * Initialising and terminating the module.
589 static int __init
init_nlm(void)
595 nlm_sysctl_table
= register_sysctl_table(nlm_sysctl_root
);
596 if (nlm_sysctl_table
== NULL
)
599 err
= register_pernet_subsys(&lockd_net_ops
);
606 unregister_sysctl_table(nlm_sysctl_table
);
612 static void __exit
exit_nlm(void)
614 /* FIXME: delete all NLM clients */
615 nlm_shutdown_hosts();
616 unregister_pernet_subsys(&lockd_net_ops
);
618 unregister_sysctl_table(nlm_sysctl_table
);
622 module_init(init_nlm
);
623 module_exit(exit_nlm
);
626 * Define NLM program and procedures
628 static struct svc_version nlmsvc_version1
= {
631 .vs_proc
= nlmsvc_procedures
,
632 .vs_xdrsize
= NLMSVC_XDRSIZE
,
634 static struct svc_version nlmsvc_version3
= {
637 .vs_proc
= nlmsvc_procedures
,
638 .vs_xdrsize
= NLMSVC_XDRSIZE
,
640 #ifdef CONFIG_LOCKD_V4
641 static struct svc_version nlmsvc_version4
= {
644 .vs_proc
= nlmsvc_procedures4
,
645 .vs_xdrsize
= NLMSVC_XDRSIZE
,
648 static struct svc_version
* nlmsvc_version
[] = {
649 [1] = &nlmsvc_version1
,
650 [3] = &nlmsvc_version3
,
651 #ifdef CONFIG_LOCKD_V4
652 [4] = &nlmsvc_version4
,
656 static struct svc_stat nlmsvc_stats
;
658 #define NLM_NRVERS ARRAY_SIZE(nlmsvc_version)
659 static struct svc_program nlmsvc_program
= {
660 .pg_prog
= NLM_PROGRAM
, /* program number */
661 .pg_nvers
= NLM_NRVERS
, /* number of entries in nlmsvc_version */
662 .pg_vers
= nlmsvc_version
, /* version table */
663 .pg_name
= "lockd", /* service name */
664 .pg_class
= "nfsd", /* share authentication with nfsd */
665 .pg_stats
= &nlmsvc_stats
, /* stats table */
666 .pg_authenticate
= &lockd_authenticate
/* export authentication */