[linux-2.6-block.git] / fs / lockd / svc.c

/*
 * linux/fs/lockd/svc.c
 *
 * This is the central lockd service.
 *
 * FIXME: Separate the lockd NFS server functionality from the lockd NFS
 * 	  client functionality. Oh why didn't Sun create two separate
 *	  services in the first place?
 *
 * Authors:	Olaf Kirch (okir@monad.swb.de)
 *
 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
 */

#include <linux/module.h>
#include <linux/init.h>
#include <linux/sysctl.h>
#include <linux/moduleparam.h>

#include <linux/sched.h>
#include <linux/errno.h>
#include <linux/in.h>
#include <linux/uio.h>
#include <linux/slab.h>
#include <linux/smp.h>
#include <linux/smp_lock.h>
#include <linux/mutex.h>

#include <linux/sunrpc/types.h>
#include <linux/sunrpc/stats.h>
#include <linux/sunrpc/clnt.h>
#include <linux/sunrpc/svc.h>
#include <linux/sunrpc/svcsock.h>
#include <net/ip.h>
#include <linux/lockd/lockd.h>
#include <linux/nfs.h>

#define NLMDBG_FACILITY		NLMDBG_SVC
#define LOCKD_BUFSIZE		(1024 + NLMSVC_XDRSIZE)
#define ALLOWED_SIGS		(sigmask(SIGKILL))

static struct svc_program	nlmsvc_program;

struct nlmsvc_binding *		nlmsvc_ops;
EXPORT_SYMBOL(nlmsvc_ops);

static DEFINE_MUTEX(nlmsvc_mutex);
static unsigned int		nlmsvc_users;
static pid_t			nlmsvc_pid;
static struct svc_serv		*nlmsvc_serv;
int				nlmsvc_grace_period;
unsigned long			nlmsvc_timeout;

static DECLARE_COMPLETION(lockd_start_done);
static DECLARE_WAIT_QUEUE_HEAD(lockd_exit);

/*
 * These can be set at insmod time (useful for NFS as root filesystem),
 * and also changed through the sysctl interface.  -- Jamie Lokier, Aug 2003
 */
static unsigned long		nlm_grace_period;
static unsigned long		nlm_timeout = LOCKD_DFLT_TIMEO;
static int			nlm_udpport, nlm_tcpport;

/*
 * Constants needed for the sysctl interface.
 */
static const unsigned long	nlm_grace_period_min = 0;
static const unsigned long	nlm_grace_period_max = 240;
static const unsigned long	nlm_timeout_min = 3;
static const unsigned long	nlm_timeout_max = 20;
static const int		nlm_port_min = 0, nlm_port_max = 65535;

static struct ctl_table_header * nlm_sysctl_table;

static unsigned long set_grace_period(void)
{
	unsigned long grace_period;

	/* Note: nlm_timeout should always be nonzero */
	if (nlm_grace_period)
		grace_period = ((nlm_grace_period + nlm_timeout - 1)
				/ nlm_timeout) * nlm_timeout * HZ;
	else
		grace_period = nlm_timeout * 5 * HZ;
	nlmsvc_grace_period = 1;
	return grace_period + jiffies;
}

static inline void clear_grace_period(void)
{
	nlmsvc_grace_period = 0;
}

/*
 * This is the lockd kernel thread
 */
static void
lockd(struct svc_rqst *rqstp)
{
	int		err = 0;
	unsigned long grace_period_expire;

	/* Lock module and set up kernel thread */
	/* lockd_up is waiting for us to startup, so will
	 * be holding a reference to this module, so it
	 * is safe to just claim another reference
	 */
	__module_get(THIS_MODULE);
	lock_kernel();

	/*
	 * Let our maker know we're running.
	 */
	nlmsvc_pid = current->pid;
	nlmsvc_serv = rqstp->rq_server;
	complete(&lockd_start_done);

	daemonize("lockd");

	/* Process request with signals blocked, but allow SIGKILL.  */
	allow_signal(SIGKILL);

	/* kick rpciod */
	rpciod_up();

	dprintk("NFS locking service started (ver " LOCKD_VERSION ").\n");

	if (!nlm_timeout)
		nlm_timeout = LOCKD_DFLT_TIMEO;
	nlmsvc_timeout = nlm_timeout * HZ;

	grace_period_expire = set_grace_period();

	/*
	 * The main request loop. We don't terminate until the last
	 * NFS mount or NFS daemon has gone away, and we've been sent a
	 * signal, or else another process has taken over our job.
	 */
	while ((nlmsvc_users || !signalled()) && nlmsvc_pid == current->pid) {
		long timeout = MAX_SCHEDULE_TIMEOUT;

		if (signalled()) {
			flush_signals(current);
			if (nlmsvc_ops) {
				nlmsvc_invalidate_all();
				grace_period_expire = set_grace_period();
			}
		}

		/*
		 * Retry any blocked locks that have been notified by
		 * the VFS. Don't do this during grace period.
		 * (Theoretically, there shouldn't even be blocked locks
		 * during grace period).
		 */
		if (!nlmsvc_grace_period) {
			timeout = nlmsvc_retry_blocked();
		} else if (time_before(grace_period_expire, jiffies))
			clear_grace_period();

		/*
		 * Find a socket with data available and call its
		 * recvfrom routine.
		 */
		err = svc_recv(rqstp, timeout);
		if (err == -EAGAIN || err == -EINTR)
			continue;
		if (err < 0) {
			printk(KERN_WARNING
			       "lockd: terminating on error %d\n",
			       -err);
			break;
		}

		dprintk("lockd: request from %08x\n",
			(unsigned)ntohl(rqstp->rq_addr.sin_addr.s_addr));

		svc_process(rqstp);

	}

	flush_signals(current);

	/*
	 * Check whether there's a new lockd process before
	 * shutting down the hosts and clearing the slot.
	 */
	if (!nlmsvc_pid || current->pid == nlmsvc_pid) {
		if (nlmsvc_ops)
			nlmsvc_invalidate_all();
		nlm_shutdown_hosts();
		nlmsvc_pid = 0;
		nlmsvc_serv = NULL;
	} else
		printk(KERN_DEBUG
			"lockd: new process, skipping host shutdown\n");
	wake_up(&lockd_exit);

	/* Exit the RPC thread */
	svc_exit_thread(rqstp);

	/* release rpciod */
	rpciod_down();

	/* Release module */
	unlock_kernel();
	module_put_and_exit(0);
}


static int find_socket(struct svc_serv *serv, int proto)
{
	struct svc_sock *svsk;
	int found = 0;
	list_for_each_entry(svsk, &serv->sv_permsocks, sk_list)
		if (svsk->sk_sk->sk_protocol == proto) {
			found = 1;
			break;
		}
	return found;
}

static int make_socks(struct svc_serv *serv, int proto)
{
	/* Make any sockets that are needed but not present.
	 * If nlm_udpport or nlm_tcpport were set as module
	 * options, make those sockets unconditionally
	 */
	static int		warned;
	int err = 0;
	if (proto == IPPROTO_UDP || nlm_udpport)
		if (!find_socket(serv, IPPROTO_UDP))
			err = svc_makesock(serv, IPPROTO_UDP, nlm_udpport);
	if (err == 0 && (proto == IPPROTO_TCP || nlm_tcpport))
		if (!find_socket(serv, IPPROTO_TCP))
			err= svc_makesock(serv, IPPROTO_TCP, nlm_tcpport);
	if (!err)
		warned = 0;
	else if (warned++ == 0)
		printk(KERN_WARNING
		       "lockd_up: makesock failed, error=%d\n", err);
	return err;
}

/*
 * Bring up the lockd process if it's not already up.
 */
int
lockd_up(int proto) /* Maybe add a 'family' option when IPv6 is supported ?? */
{
	struct svc_serv *	serv;
	int			error = 0;

	mutex_lock(&nlmsvc_mutex);
	/*
	 * Unconditionally increment the user count ... this is
	 * the number of clients who _want_ a lockd process.
	 */
	nlmsvc_users++; 
	/*
	 * Check whether we're already up and running.
	 */
	if (nlmsvc_pid) {
		error = make_socks(nlmsvc_serv, proto);
		goto out;
	}

	/*
	 * Sanity check: if there's no pid,
	 * we should be the first user ...
	 */
	if (nlmsvc_users > 1)
		printk(KERN_WARNING
			"lockd_up: no pid, %d users??\n", nlmsvc_users);

	error = -ENOMEM;
	serv = svc_create(&nlmsvc_program, LOCKD_BUFSIZE, NULL);
	if (!serv) {
		printk(KERN_WARNING "lockd_up: create service failed\n");
		goto out;
	}

	if ((error = make_socks(serv, proto)) < 0)
		goto destroy_and_out;

	/*
	 * Create the kernel thread and wait for it to start.
	 */
	error = svc_create_thread(lockd, serv);
	if (error) {
		printk(KERN_WARNING
			"lockd_up: create thread failed, error=%d\n", error);
		goto destroy_and_out;
	}
	wait_for_completion(&lockd_start_done);

	/*
	 * Note: svc_serv structures have an initial use count of 1,
	 * so we exit through here on both success and failure.
	 */
destroy_and_out:
	svc_destroy(serv);
out:
	mutex_unlock(&nlmsvc_mutex);
	return error;
}
EXPORT_SYMBOL(lockd_up);

/*
 * Decrement the user count and bring down lockd if we're the last.
 */
void
lockd_down(void)
{
	static int warned;

	mutex_lock(&nlmsvc_mutex);
	if (nlmsvc_users) {
		if (--nlmsvc_users)
			goto out;
	} else
		printk(KERN_WARNING "lockd_down: no users! pid=%d\n", nlmsvc_pid);

	if (!nlmsvc_pid) {
		if (warned++ == 0)
			printk(KERN_WARNING "lockd_down: no lockd running.\n"); 
		goto out;
	}
	warned = 0;

	kill_proc(nlmsvc_pid, SIGKILL, 1);
	/*
	 * Wait for the lockd process to exit, but since we're holding
	 * the lockd semaphore, we can't wait around forever ...
	 */
	clear_thread_flag(TIF_SIGPENDING);
	interruptible_sleep_on_timeout(&lockd_exit, HZ);
	if (nlmsvc_pid) {
		printk(KERN_WARNING 
			"lockd_down: lockd failed to exit, clearing pid\n");
		nlmsvc_pid = 0;
	}
	spin_lock_irq(&current->sighand->siglock);
	recalc_sigpending();
	spin_unlock_irq(&current->sighand->siglock);
out:
	mutex_unlock(&nlmsvc_mutex);
}
EXPORT_SYMBOL(lockd_down);

/*
 * Sysctl parameters (same as module parameters, different interface).
 */

/* Something that isn't CTL_ANY, CTL_NONE or a value that may clash. */
#define CTL_UNNUMBERED		-2

static ctl_table nlm_sysctls[] = {
	{
		.ctl_name	= CTL_UNNUMBERED,
		.procname	= "nlm_grace_period",
		.data		= &nlm_grace_period,
		.maxlen		= sizeof(unsigned long),
		.mode		= 0644,
		.proc_handler	= &proc_doulongvec_minmax,
		.extra1		= (unsigned long *) &nlm_grace_period_min,
		.extra2		= (unsigned long *) &nlm_grace_period_max,
	},
	{
		.ctl_name	= CTL_UNNUMBERED,
		.procname	= "nlm_timeout",
		.data		= &nlm_timeout,
		.maxlen		= sizeof(unsigned long),
		.mode		= 0644,
		.proc_handler	= &proc_doulongvec_minmax,
		.extra1		= (unsigned long *) &nlm_timeout_min,
		.extra2		= (unsigned long *) &nlm_timeout_max,
	},
	{
		.ctl_name	= CTL_UNNUMBERED,
		.procname	= "nlm_udpport",
		.data		= &nlm_udpport,
		.maxlen		= sizeof(int),
		.mode		= 0644,
		.proc_handler	= &proc_dointvec_minmax,
		.extra1		= (int *) &nlm_port_min,
		.extra2		= (int *) &nlm_port_max,
	},
	{
		.ctl_name	= CTL_UNNUMBERED,
		.procname	= "nlm_tcpport",
		.data		= &nlm_tcpport,
		.maxlen		= sizeof(int),
		.mode		= 0644,
		.proc_handler	= &proc_dointvec_minmax,
		.extra1		= (int *) &nlm_port_min,
		.extra2		= (int *) &nlm_port_max,
	},
	{ .ctl_name = 0 }
};

static ctl_table nlm_sysctl_dir[] = {
	{
		.ctl_name	= CTL_UNNUMBERED,
		.procname	= "nfs",
		.mode		= 0555,
		.child		= nlm_sysctls,
	},
	{ .ctl_name = 0 }
};

static ctl_table nlm_sysctl_root[] = {
	{
		.ctl_name	= CTL_FS,
		.procname	= "fs",
		.mode		= 0555,
		.child		= nlm_sysctl_dir,
	},
	{ .ctl_name = 0 }
};

/*
 * Module (and driverfs) parameters.
 */

#define param_set_min_max(name, type, which_strtol, min, max)		\
static int param_set_##name(const char *val, struct kernel_param *kp)	\
{									\
	char *endp;							\
	__typeof__(type) num = which_strtol(val, &endp, 0);		\
	if (endp == val || *endp || num < (min) || num > (max))		\
		return -EINVAL;						\
	*((int *) kp->arg) = num;					\
	return 0;							\
}

static inline int is_callback(u32 proc)
{
	return proc == NLMPROC_GRANTED
		|| proc == NLMPROC_GRANTED_MSG
		|| proc == NLMPROC_TEST_RES
		|| proc == NLMPROC_LOCK_RES
		|| proc == NLMPROC_CANCEL_RES
		|| proc == NLMPROC_UNLOCK_RES
		|| proc == NLMPROC_NSM_NOTIFY;
}


static int lockd_authenticate(struct svc_rqst *rqstp)
{
	rqstp->rq_client = NULL;
	switch (rqstp->rq_authop->flavour) {
		case RPC_AUTH_NULL:
		case RPC_AUTH_UNIX:
			if (rqstp->rq_proc == 0)
				return SVC_OK;
			if (is_callback(rqstp->rq_proc)) {
				/* Leave it to individual procedures to
				 * call nlmsvc_lookup_host(rqstp)
				 */
				return SVC_OK;
			}
			return svc_set_client(rqstp);
	}
	return SVC_DENIED;
}


param_set_min_max(port, int, simple_strtol, 0, 65535)
param_set_min_max(grace_period, unsigned long, simple_strtoul,
		  nlm_grace_period_min, nlm_grace_period_max)
param_set_min_max(timeout, unsigned long, simple_strtoul,
		  nlm_timeout_min, nlm_timeout_max)

MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION ".");
MODULE_LICENSE("GPL");

module_param_call(nlm_grace_period, param_set_grace_period, param_get_ulong,
		  &nlm_grace_period, 0644);
module_param_call(nlm_timeout, param_set_timeout, param_get_ulong,
		  &nlm_timeout, 0644);
module_param_call(nlm_udpport, param_set_port, param_get_int,
		  &nlm_udpport, 0644);
module_param_call(nlm_tcpport, param_set_port, param_get_int,
		  &nlm_tcpport, 0644);

/*
 * Initialising and terminating the module.
 */

static int __init init_nlm(void)
{
	nlm_sysctl_table = register_sysctl_table(nlm_sysctl_root, 0);
	return nlm_sysctl_table ? 0 : -ENOMEM;
}

static void __exit exit_nlm(void)
{
	/* FIXME: delete all NLM clients */
	nlm_shutdown_hosts();
	unregister_sysctl_table(nlm_sysctl_table);
}

module_init(init_nlm);
module_exit(exit_nlm);

/*
 * Define NLM program and procedures
 */
static struct svc_version	nlmsvc_version1 = {
		.vs_vers	= 1,
		.vs_nproc	= 17,
		.vs_proc	= nlmsvc_procedures,
		.vs_xdrsize	= NLMSVC_XDRSIZE,
};
static struct svc_version	nlmsvc_version3 = {
		.vs_vers	= 3,
		.vs_nproc	= 24,
		.vs_proc	= nlmsvc_procedures,
		.vs_xdrsize	= NLMSVC_XDRSIZE,
};
#ifdef CONFIG_LOCKD_V4
static struct svc_version	nlmsvc_version4 = {
		.vs_vers	= 4,
		.vs_nproc	= 24,
		.vs_proc	= nlmsvc_procedures4,
		.vs_xdrsize	= NLMSVC_XDRSIZE,
};
#endif
static struct svc_version *	nlmsvc_version[] = {
	[1] = &nlmsvc_version1,
	[3] = &nlmsvc_version3,
#ifdef CONFIG_LOCKD_V4
	[4] = &nlmsvc_version4,
#endif
};

static struct svc_stat		nlmsvc_stats;

#define NLM_NRVERS	ARRAY_SIZE(nlmsvc_version)
static struct svc_program	nlmsvc_program = {
	.pg_prog		= NLM_PROGRAM,		/* program number */
	.pg_nvers		= NLM_NRVERS,		/* number of entries in nlmsvc_version */
	.pg_vers		= nlmsvc_version,	/* version table */
	.pg_name		= "lockd",		/* service name */
	.pg_class		= "nfsd",		/* share authentication with nfsd */
	.pg_stats		= &nlmsvc_stats,	/* stats table */
	.pg_authenticate = &lockd_authenticate	/* export authentication */
};
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/fs/lockd/svc.c
	3	*
	4	* This is the central lockd service.
	5	*
	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?
	9	*
	10	* Authors: Olaf Kirch (okir@monad.swb.de)
	11	*
	12	* Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
	13	*/
	14
1da177e4 LT	15	#include <linux/module.h>
	16	#include <linux/init.h>
	17	#include <linux/sysctl.h>
	18	#include <linux/moduleparam.h>
	19
	20	#include <linux/sched.h>
	21	#include <linux/errno.h>
	22	#include <linux/in.h>
	23	#include <linux/uio.h>
	24	#include <linux/slab.h>
	25	#include <linux/smp.h>
	26	#include <linux/smp_lock.h>
353ab6e9	27	#include <linux/mutex.h>
1da177e4 LT	28
	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>
24e36663	34	#include <net/ip.h>
1da177e4 LT	35	#include <linux/lockd/lockd.h>
	36	#include <linux/nfs.h>
	37
	38	#define NLMDBG_FACILITY NLMDBG_SVC
	39	#define LOCKD_BUFSIZE (1024 + NLMSVC_XDRSIZE)
	40	#define ALLOWED_SIGS (sigmask(SIGKILL))
	41
	42	static struct svc_program nlmsvc_program;
	43
	44	struct nlmsvc_binding * nlmsvc_ops;
	45	EXPORT_SYMBOL(nlmsvc_ops);
	46
353ab6e9	47	static DEFINE_MUTEX(nlmsvc_mutex);
1da177e4 LT	48	static unsigned int nlmsvc_users;
1da177e4 LT	49	static pid_t nlmsvc_pid;
24e36663	50	static struct svc_serv *nlmsvc_serv;
1da177e4 LT	51	int nlmsvc_grace_period;
	52	unsigned long nlmsvc_timeout;
	53
353ab6e9	54	static DECLARE_COMPLETION(lockd_start_done);
1da177e4 LT	55	static DECLARE_WAIT_QUEUE_HEAD(lockd_exit);
	56
	57	/*
	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
	60	*/
	61	static unsigned long nlm_grace_period;
	62	static unsigned long nlm_timeout = LOCKD_DFLT_TIMEO;
	63	static int nlm_udpport, nlm_tcpport;
	64
	65	/*
	66	* Constants needed for the sysctl interface.
	67	*/
	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;
	73
	74	static struct ctl_table_header * nlm_sysctl_table;
	75
	76	static unsigned long set_grace_period(void)
	77	{
	78	unsigned long grace_period;
	79
	80	/* Note: nlm_timeout should always be nonzero */
	81	if (nlm_grace_period)
	82	grace_period = ((nlm_grace_period + nlm_timeout - 1)
	83	/ nlm_timeout) * nlm_timeout * HZ;
	84	else
	85	grace_period = nlm_timeout * 5 * HZ;
	86	nlmsvc_grace_period = 1;
	87	return grace_period + jiffies;
	88	}
	89
	90	static inline void clear_grace_period(void)
	91	{
	92	nlmsvc_grace_period = 0;
	93	}
	94
	95	/*
	96	* This is the lockd kernel thread
	97	*/
	98	static void
	99	lockd(struct svc_rqst *rqstp)
	100	{
1da177e4 LT	101	int err = 0;
	102	unsigned long grace_period_expire;
	103
	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
	108	*/
	109	__module_get(THIS_MODULE);
	110	lock_kernel();
	111
	112	/*
	113	* Let our maker know we're running.
	114	*/
	115	nlmsvc_pid = current->pid;
6fb2b47f	116	nlmsvc_serv = rqstp->rq_server;
353ab6e9	117	complete(&lockd_start_done);
1da177e4 LT	118
	119	daemonize("lockd");
	120
	121	/* Process request with signals blocked, but allow SIGKILL. */
	122	allow_signal(SIGKILL);
	123
	124	/* kick rpciod */
	125	rpciod_up();
	126
	127	dprintk("NFS locking service started (ver " LOCKD_VERSION ").\n");
	128
	129	if (!nlm_timeout)
	130	nlm_timeout = LOCKD_DFLT_TIMEO;
	131	nlmsvc_timeout = nlm_timeout * HZ;
	132
	133	grace_period_expire = set_grace_period();
	134
	135	/*
	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.
	139	*/
	140	while ((nlmsvc_users \|\| !signalled()) && nlmsvc_pid == current->pid) {
	141	long timeout = MAX_SCHEDULE_TIMEOUT;
	142
	143	if (signalled()) {
	144	flush_signals(current);
	145	if (nlmsvc_ops) {
	146	nlmsvc_invalidate_all();
	147	grace_period_expire = set_grace_period();
	148	}
	149	}
	150
	151	/*
	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).
	156	*/
	157	if (!nlmsvc_grace_period) {
	158	timeout = nlmsvc_retry_blocked();
	159	} else if (time_before(grace_period_expire, jiffies))
	160	clear_grace_period();
	161
	162	/*
	163	* Find a socket with data available and call its
	164	* recvfrom routine.
	165	*/
6fb2b47f	166	err = svc_recv(rqstp, timeout);
1da177e4 LT	167	if (err == -EAGAIN \|\| err == -EINTR)
	168	continue;
	169	if (err < 0) {
	170	printk(KERN_WARNING
	171	"lockd: terminating on error %d\n",
	172	-err);
	173	break;
	174	}
	175
	176	dprintk("lockd: request from %08x\n",
	177	(unsigned)ntohl(rqstp->rq_addr.sin_addr.s_addr));
	178
6fb2b47f	179	svc_process(rqstp);
1da177e4 LT	180
	181	}
	182
2bd61579 TM	183	flush_signals(current);
2bd61579 TM	184
1da177e4 LT	185	/*
	186	* Check whether there's a new lockd process before
	187	* shutting down the hosts and clearing the slot.
	188	*/
	189	if (!nlmsvc_pid \|\| current->pid == nlmsvc_pid) {
	190	if (nlmsvc_ops)
	191	nlmsvc_invalidate_all();
	192	nlm_shutdown_hosts();
	193	nlmsvc_pid = 0;
24e36663	194	nlmsvc_serv = NULL;
1da177e4 LT	195	} else
	196	printk(KERN_DEBUG
	197	"lockd: new process, skipping host shutdown\n");
	198	wake_up(&lockd_exit);
46be925f	199
1da177e4 LT	200	/* Exit the RPC thread */
	201	svc_exit_thread(rqstp);
	202
	203	/* release rpciod */
	204	rpciod_down();
	205
	206	/* Release module */
	207	unlock_kernel();
	208	module_put_and_exit(0);
	209	}
	210
24e36663 N	211
	212	static int find_socket(struct svc_serv *serv, int proto)
	213	{
	214	struct svc_sock *svsk;
	215	int found = 0;
	216	list_for_each_entry(svsk, &serv->sv_permsocks, sk_list)
	217	if (svsk->sk_sk->sk_protocol == proto) {
	218	found = 1;
	219	break;
	220	}
	221	return found;
	222	}
	223
	224	static int make_socks(struct svc_serv *serv, int proto)
	225	{
	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
	229	*/
7dcf91ec	230	static int warned;
24e36663 N	231	int err = 0;
	232	if (proto == IPPROTO_UDP \|\| nlm_udpport)
	233	if (!find_socket(serv, IPPROTO_UDP))
	234	err = svc_makesock(serv, IPPROTO_UDP, nlm_udpport);
7dcf91ec	235	if (err == 0 && (proto == IPPROTO_TCP \|\| nlm_tcpport))
24e36663 N	236	if (!find_socket(serv, IPPROTO_TCP))
24e36663 N	237	err= svc_makesock(serv, IPPROTO_TCP, nlm_tcpport);
7dcf91ec N	238	if (!err)
	239	warned = 0;
	240	else if (warned++ == 0)
	241	printk(KERN_WARNING
	242	"lockd_up: makesock failed, error=%d\n", err);
24e36663 N	243	return err;
	244	}
	245
1da177e4 LT	246	/*
	247	* Bring up the lockd process if it's not already up.
	248	*/
	249	int
24e36663	250	lockd_up(int proto) /* Maybe add a 'family' option when IPv6 is supported ?? */
1da177e4	251	{
1da177e4 LT	252	struct svc_serv * serv;
	253	int error = 0;
	254
353ab6e9	255	mutex_lock(&nlmsvc_mutex);
1da177e4 LT	256	/*
	257	* Unconditionally increment the user count ... this is
	258	* the number of clients who _want_ a lockd process.
	259	*/
	260	nlmsvc_users++;
	261	/*
	262	* Check whether we're already up and running.
	263	*/
24e36663 N	264	if (nlmsvc_pid) {
24e36663 N	265	error = make_socks(nlmsvc_serv, proto);
1da177e4	266	goto out;
24e36663	267	}
1da177e4 LT	268
	269	/*
	270	* Sanity check: if there's no pid,
	271	* we should be the first user ...
	272	*/
	273	if (nlmsvc_users > 1)
	274	printk(KERN_WARNING
	275	"lockd_up: no pid, %d users??\n", nlmsvc_users);
	276
	277	error = -ENOMEM;
bc591ccf	278	serv = svc_create(&nlmsvc_program, LOCKD_BUFSIZE, NULL);
1da177e4 LT	279	if (!serv) {
	280	printk(KERN_WARNING "lockd_up: create service failed\n");
	281	goto out;
	282	}
	283
7dcf91ec	284	if ((error = make_socks(serv, proto)) < 0)
1da177e4	285	goto destroy_and_out;
1da177e4 LT	286
	287	/*
	288	* Create the kernel thread and wait for it to start.
	289	*/
	290	error = svc_create_thread(lockd, serv);
	291	if (error) {
	292	printk(KERN_WARNING
	293	"lockd_up: create thread failed, error=%d\n", error);
	294	goto destroy_and_out;
	295	}
353ab6e9	296	wait_for_completion(&lockd_start_done);
1da177e4 LT	297
	298	/*
	299	* Note: svc_serv structures have an initial use count of 1,
	300	* so we exit through here on both success and failure.
	301	*/
	302	destroy_and_out:
	303	svc_destroy(serv);
	304	out:
353ab6e9	305	mutex_unlock(&nlmsvc_mutex);
1da177e4 LT	306	return error;
	307	}
	308	EXPORT_SYMBOL(lockd_up);
	309
	310	/*
	311	* Decrement the user count and bring down lockd if we're the last.
	312	*/
	313	void
	314	lockd_down(void)
	315	{
	316	static int warned;
	317
353ab6e9	318	mutex_lock(&nlmsvc_mutex);
1da177e4 LT	319	if (nlmsvc_users) {
	320	if (--nlmsvc_users)
	321	goto out;
	322	} else
	323	printk(KERN_WARNING "lockd_down: no users! pid=%d\n", nlmsvc_pid);
	324
	325	if (!nlmsvc_pid) {
	326	if (warned++ == 0)
	327	printk(KERN_WARNING "lockd_down: no lockd running.\n");
	328	goto out;
	329	}
	330	warned = 0;
	331
	332	kill_proc(nlmsvc_pid, SIGKILL, 1);
	333	/*
	334	* Wait for the lockd process to exit, but since we're holding
	335	* the lockd semaphore, we can't wait around forever ...
	336	*/
	337	clear_thread_flag(TIF_SIGPENDING);
	338	interruptible_sleep_on_timeout(&lockd_exit, HZ);
	339	if (nlmsvc_pid) {
	340	printk(KERN_WARNING
	341	"lockd_down: lockd failed to exit, clearing pid\n");
	342	nlmsvc_pid = 0;
	343	}
	344	spin_lock_irq(&current->sighand->siglock);
	345	recalc_sigpending();
	346	spin_unlock_irq(&current->sighand->siglock);
	347	out:
353ab6e9	348	mutex_unlock(&nlmsvc_mutex);
1da177e4 LT	349	}
	350	EXPORT_SYMBOL(lockd_down);
	351
	352	/*
	353	* Sysctl parameters (same as module parameters, different interface).
	354	*/
	355
	356	/* Something that isn't CTL_ANY, CTL_NONE or a value that may clash. */
	357	#define CTL_UNNUMBERED -2
	358
	359	static ctl_table nlm_sysctls[] = {
	360	{
	361	.ctl_name = CTL_UNNUMBERED,
	362	.procname = "nlm_grace_period",
	363	.data = &nlm_grace_period,
7ee91ec1	364	.maxlen = sizeof(unsigned long),
1da177e4 LT	365	.mode = 0644,
	366	.proc_handler = &proc_doulongvec_minmax,
	367	.extra1 = (unsigned long *) &nlm_grace_period_min,
	368	.extra2 = (unsigned long *) &nlm_grace_period_max,
	369	},
	370	{
	371	.ctl_name = CTL_UNNUMBERED,
	372	.procname = "nlm_timeout",
	373	.data = &nlm_timeout,
7ee91ec1	374	.maxlen = sizeof(unsigned long),
1da177e4 LT	375	.mode = 0644,
	376	.proc_handler = &proc_doulongvec_minmax,
	377	.extra1 = (unsigned long *) &nlm_timeout_min,
	378	.extra2 = (unsigned long *) &nlm_timeout_max,
	379	},
	380	{
	381	.ctl_name = CTL_UNNUMBERED,
	382	.procname = "nlm_udpport",
	383	.data = &nlm_udpport,
	384	.maxlen = sizeof(int),
	385	.mode = 0644,
	386	.proc_handler = &proc_dointvec_minmax,
	387	.extra1 = (int *) &nlm_port_min,
	388	.extra2 = (int *) &nlm_port_max,
	389	},
	390	{
	391	.ctl_name = CTL_UNNUMBERED,
	392	.procname = "nlm_tcpport",
	393	.data = &nlm_tcpport,
	394	.maxlen = sizeof(int),
	395	.mode = 0644,
	396	.proc_handler = &proc_dointvec_minmax,
	397	.extra1 = (int *) &nlm_port_min,
	398	.extra2 = (int *) &nlm_port_max,
	399	},
	400	{ .ctl_name = 0 }
	401	};
	402
	403	static ctl_table nlm_sysctl_dir[] = {
	404	{
	405	.ctl_name = CTL_UNNUMBERED,
	406	.procname = "nfs",
	407	.mode = 0555,
	408	.child = nlm_sysctls,
	409	},
	410	{ .ctl_name = 0 }
	411	};
	412
	413	static ctl_table nlm_sysctl_root[] = {
	414	{
	415	.ctl_name = CTL_FS,
	416	.procname = "fs",
	417	.mode = 0555,
	418	.child = nlm_sysctl_dir,
	419	},
	420	{ .ctl_name = 0 }
	421	};
	422
	423	/*
	424	* Module (and driverfs) parameters.
	425	*/
	426
	427	#define param_set_min_max(name, type, which_strtol, min, max) \
	428	static int param_set_##name(const char val, struct kernel_param kp) \
	429	{ \
	430	char *endp; \
	431	__typeof__(type) num = which_strtol(val, &endp, 0); \
	432	if (endp == val \|\| *endp \|\| num < (min) \|\| num > (max)) \
	433	return -EINVAL; \
	434	((int ) kp->arg) = num; \
	435	return 0; \
	436	}
	437
	438	static inline int is_callback(u32 proc)
439	{
440	return proc == NLMPROC_GRANTED
441	\|\| proc == NLMPROC_GRANTED_MSG
442	\|\| proc == NLMPROC_TEST_RES
443	\|\| proc == NLMPROC_LOCK_RES
444	\|\| proc == NLMPROC_CANCEL_RES
445	\|\| proc == NLMPROC_UNLOCK_RES
446	\|\| proc == NLMPROC_NSM_NOTIFY;
447	}
448
449
450	static int lockd_authenticate(struct svc_rqst *rqstp)
451	{
452	rqstp->rq_client = NULL;
453	switch (rqstp->rq_authop->flavour) {
454	case RPC_AUTH_NULL:
455	case RPC_AUTH_UNIX:
456	if (rqstp->rq_proc == 0)
457	return SVC_OK;
458	if (is_callback(rqstp->rq_proc)) {
459	/* Leave it to individual procedures to
460	* call nlmsvc_lookup_host(rqstp)
461	*/
462	return SVC_OK;
463	}
464	return svc_set_client(rqstp);
465	}
466	return SVC_DENIED;
467	}
468
469
470	param_set_min_max(port, int, simple_strtol, 0, 65535)
471	param_set_min_max(grace_period, unsigned long, simple_strtoul,
472	nlm_grace_period_min, nlm_grace_period_max)
473	param_set_min_max(timeout, unsigned long, simple_strtoul,
474	nlm_timeout_min, nlm_timeout_max)
475
476	MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
477	MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION ".");
478	MODULE_LICENSE("GPL");
479
480	module_param_call(nlm_grace_period, param_set_grace_period, param_get_ulong,
481	&nlm_grace_period, 0644);
482	module_param_call(nlm_timeout, param_set_timeout, param_get_ulong,
483	&nlm_timeout, 0644);
484	module_param_call(nlm_udpport, param_set_port, param_get_int,
485	&nlm_udpport, 0644);
486	module_param_call(nlm_tcpport, param_set_port, param_get_int,
487	&nlm_tcpport, 0644);
488
489	/*
490	* Initialising and terminating the module.
491	*/
492
493	static int __init init_nlm(void)
494	{
495	nlm_sysctl_table = register_sysctl_table(nlm_sysctl_root, 0);
496	return nlm_sysctl_table ? 0 : -ENOMEM;
497	}
498
499	static void __exit exit_nlm(void)
500	{
501	/* FIXME: delete all NLM clients */
502	nlm_shutdown_hosts();
503	unregister_sysctl_table(nlm_sysctl_table);
504	}
505
506	module_init(init_nlm);
507	module_exit(exit_nlm);
508
509	/*
510	* Define NLM program and procedures
511	*/
512	static struct svc_version nlmsvc_version1 = {
513	.vs_vers = 1,
514	.vs_nproc = 17,
515	.vs_proc = nlmsvc_procedures,
516	.vs_xdrsize = NLMSVC_XDRSIZE,
517	};
518	static struct svc_version nlmsvc_version3 = {
519	.vs_vers = 3,
520	.vs_nproc = 24,
521	.vs_proc = nlmsvc_procedures,
522	.vs_xdrsize = NLMSVC_XDRSIZE,
523	};
524	#ifdef CONFIG_LOCKD_V4
525	static struct svc_version nlmsvc_version4 = {
526	.vs_vers = 4,
527	.vs_nproc = 24,
528	.vs_proc = nlmsvc_procedures4,
529	.vs_xdrsize = NLMSVC_XDRSIZE,
530	};
531	#endif
532	static struct svc_version * nlmsvc_version[] = {
533	[1] = &nlmsvc_version1,
534	[3] = &nlmsvc_version3,
535	#ifdef CONFIG_LOCKD_V4
536	[4] = &nlmsvc_version4,
537	#endif
538	};
539
540	static struct svc_stat nlmsvc_stats;
541
e8c96f8c	542	#define NLM_NRVERS ARRAY_SIZE(nlmsvc_version)
1da177e4 LT	543	static struct svc_program nlmsvc_program = {
	544	.pg_prog = NLM_PROGRAM, /* program number */
	545	.pg_nvers = NLM_NRVERS, /* number of entries in nlmsvc_version */
	546	.pg_vers = nlmsvc_version, /* version table */
	547	.pg_name = "lockd", /* service name */
	548	.pg_class = "nfsd", /* share authentication with nfsd */
	549	.pg_stats = &nlmsvc_stats, /* stats table */
	550	.pg_authenticate = &lockd_authenticate /* export authentication */
	551	};