[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/kthread.h>
#include <linux/freezer.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/lockd/sm_inter.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 struct task_struct	*nlmsvc_task;
static struct svc_serv		*nlmsvc_serv;
int				nlmsvc_grace_period;
unsigned long			nlmsvc_timeout;

/*
 * 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;
int				nsm_use_hostnames = 0;

/*
 * 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 get_lockd_grace_period(void)
{
	/* Note: nlm_timeout should always be nonzero */
	if (nlm_grace_period)
		return roundup(nlm_grace_period, nlm_timeout) * HZ;
	else
		return nlm_timeout * 5 * HZ;
}

unsigned long get_nfs_grace_period(void)
{
	unsigned long lockdgrace = get_lockd_grace_period();
	unsigned long nfsdgrace = 0;

	if (nlmsvc_ops)
		nfsdgrace = nlmsvc_ops->get_grace_period();

	return max(lockdgrace, nfsdgrace);
}
EXPORT_SYMBOL(get_nfs_grace_period);

static unsigned long set_grace_period(void)
{
	nlmsvc_grace_period = 1;
	return get_nfs_grace_period() + jiffies;
}

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

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

	/* try_to_freeze() is called from svc_recv() */
	set_freezable();

	/* Allow SIGKILL to tell lockd to drop all of its locks */
	allow_signal(SIGKILL);

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

	/*
	 * FIXME: it would be nice if lockd didn't spend its entire life
	 * running under the BKL. At the very least, it would be good to
	 * have someone clarify what it's intended to protect here. I've
	 * seen some handwavy posts about posix locking needing to be
	 * done under the BKL, but it's far from clear.
	 */
	lock_kernel();

	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.
	 */
	while (!kthread_should_stop()) {
		long timeout = MAX_SCHEDULE_TIMEOUT;
		RPC_IFDEBUG(char buf[RPC_MAX_ADDRBUFLEN]);

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

		/*
		 * 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 %s\n",
				svc_print_addr(rqstp, buf, sizeof(buf)));

		svc_process(rqstp);
	}

	flush_signals(current);
	if (nlmsvc_ops)
		nlmsvc_invalidate_all();
	nlm_shutdown_hosts();

	unlock_kernel();

	nlmsvc_task = NULL;
	nlmsvc_serv = NULL;

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

	return 0;
}

/*
 * 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 make_socks(struct svc_serv *serv, int proto)
{
	static int warned;
	struct svc_xprt *xprt;
	int err = 0;

	if (proto == IPPROTO_UDP || nlm_udpport) {
		xprt = svc_find_xprt(serv, "udp", 0, 0);
		if (!xprt)
			err = svc_create_xprt(serv, "udp", nlm_udpport,
					      SVC_SOCK_DEFAULTS);
		else
			svc_xprt_put(xprt);
	}
	if (err >= 0 && (proto == IPPROTO_TCP || nlm_tcpport)) {
		xprt = svc_find_xprt(serv, "tcp", 0, 0);
		if (!xprt)
			err = svc_create_xprt(serv, "tcp", nlm_tcpport,
					      SVC_SOCK_DEFAULTS);
		else
			svc_xprt_put(xprt);
	}
	if (err >= 0) {
		warned = 0;
		err = 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;
	struct svc_rqst *rqstp;
	int		error = 0;

	mutex_lock(&nlmsvc_mutex);
	/*
	 * Check whether we're already up and running.
	 */
	if (nlmsvc_serv) {
		if (proto)
			error = make_socks(nlmsvc_serv, proto);
		goto out;
	}

	/*
	 * Sanity check: if there's no pid,
	 * we should be the first user ...
	 */
	if (nlmsvc_users)
		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.
	 */
	rqstp = svc_prepare_thread(serv, &serv->sv_pools[0]);
	if (IS_ERR(rqstp)) {
		error = PTR_ERR(rqstp);
		printk(KERN_WARNING
			"lockd_up: svc_rqst allocation failed, error=%d\n",
			error);
		goto destroy_and_out;
	}

	svc_sock_update_bufs(serv);
	nlmsvc_serv = rqstp->rq_server;

	nlmsvc_task = kthread_run(lockd, rqstp, serv->sv_name);
	if (IS_ERR(nlmsvc_task)) {
		error = PTR_ERR(nlmsvc_task);
		nlmsvc_task = NULL;
		nlmsvc_serv = NULL;
		printk(KERN_WARNING
			"lockd_up: kthread_run failed, error=%d\n", error);
		svc_exit_thread(rqstp);
		goto destroy_and_out;
	}

	/*
	 * 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:
	if (!error)
		nlmsvc_users++;
	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)
{
	mutex_lock(&nlmsvc_mutex);
	if (nlmsvc_users) {
		if (--nlmsvc_users)
			goto out;
	} else {
		printk(KERN_ERR "lockd_down: no users! task=%p\n",
			nlmsvc_task);
		BUG();
	}

	if (!nlmsvc_task) {
		printk(KERN_ERR "lockd_down: no lockd running.\n");
		BUG();
	}
	kthread_stop(nlmsvc_task);
out:
	mutex_unlock(&nlmsvc_mutex);
}
EXPORT_SYMBOL(lockd_down);

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

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	= CTL_UNNUMBERED,
		.procname	= "nsm_use_hostnames",
		.data		= &nsm_use_hostnames,
		.maxlen		= sizeof(int),
		.mode		= 0644,
		.proc_handler	= &proc_dointvec,
	},
	{
		.ctl_name	= CTL_UNNUMBERED,
		.procname	= "nsm_local_state",
		.data		= &nsm_local_state,
		.maxlen		= sizeof(int),
		.mode		= 0644,
		.proc_handler	= &proc_dointvec,
	},
	{ .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 sysfs) 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);
module_param(nsm_use_hostnames, bool, 0644);

/*
 * Initialising and terminating the module.
 */

static int __init init_nlm(void)
{
	nlm_sysctl_table = register_sysctl_table(nlm_sysctl_root);
	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>
d751a7cd	28	#include <linux/kthread.h>
83144186	29	#include <linux/freezer.h>
1da177e4 LT	30
	31	#include <linux/sunrpc/types.h>
	32	#include <linux/sunrpc/stats.h>
	33	#include <linux/sunrpc/clnt.h>
	34	#include <linux/sunrpc/svc.h>
	35	#include <linux/sunrpc/svcsock.h>
24e36663	36	#include <net/ip.h>
1da177e4	37	#include <linux/lockd/lockd.h>
460f5cac	38	#include <linux/lockd/sm_inter.h>
1da177e4 LT	39	#include <linux/nfs.h>
	40
	41	#define NLMDBG_FACILITY NLMDBG_SVC
	42	#define LOCKD_BUFSIZE (1024 + NLMSVC_XDRSIZE)
	43	#define ALLOWED_SIGS (sigmask(SIGKILL))
	44
	45	static struct svc_program nlmsvc_program;
	46
	47	struct nlmsvc_binding * nlmsvc_ops;
	48	EXPORT_SYMBOL(nlmsvc_ops);
	49
353ab6e9	50	static DEFINE_MUTEX(nlmsvc_mutex);
1da177e4	51	static unsigned int nlmsvc_users;
d751a7cd	52	static struct task_struct *nlmsvc_task;
24e36663	53	static struct svc_serv *nlmsvc_serv;
1da177e4 LT	54	int nlmsvc_grace_period;
	55	unsigned long nlmsvc_timeout;
	56
1da177e4 LT	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;
abd1f500	64	int nsm_use_hostnames = 0;
1da177e4 LT	65
	66	/*
	67	* Constants needed for the sysctl interface.
	68	*/
	69	static const unsigned long nlm_grace_period_min = 0;
	70	static const unsigned long nlm_grace_period_max = 240;
	71	static const unsigned long nlm_timeout_min = 3;
	72	static const unsigned long nlm_timeout_max = 20;
	73	static const int nlm_port_min = 0, nlm_port_max = 65535;
	74
	75	static struct ctl_table_header * nlm_sysctl_table;
	76
9a8db97e	77	static unsigned long get_lockd_grace_period(void)
1da177e4	78	{
1da177e4 LT	79	/* Note: nlm_timeout should always be nonzero */
1da177e4 LT	80	if (nlm_grace_period)
9a8db97e	81	return roundup(nlm_grace_period, nlm_timeout) * HZ;
1da177e4	82	else
9a8db97e ME	83	return nlm_timeout * 5 * HZ;
	84	}
	85
	86	unsigned long get_nfs_grace_period(void)
	87	{
	88	unsigned long lockdgrace = get_lockd_grace_period();
	89	unsigned long nfsdgrace = 0;
	90
	91	if (nlmsvc_ops)
	92	nfsdgrace = nlmsvc_ops->get_grace_period();
	93
	94	return max(lockdgrace, nfsdgrace);
	95	}
	96	EXPORT_SYMBOL(get_nfs_grace_period);
	97
	98	static unsigned long set_grace_period(void)
	99	{
1da177e4	100	nlmsvc_grace_period = 1;
9a8db97e	101	return get_nfs_grace_period() + jiffies;
1da177e4 LT	102	}
	103
	104	static inline void clear_grace_period(void)
	105	{
	106	nlmsvc_grace_period = 0;
	107	}
	108
	109	/*
	110	* This is the lockd kernel thread
	111	*/
d751a7cd JL	112	static int
d751a7cd JL	113	lockd(void *vrqstp)
1da177e4	114	{
1da177e4	115	int err = 0;
d751a7cd	116	struct svc_rqst *rqstp = vrqstp;
1da177e4 LT	117	unsigned long grace_period_expire;
1da177e4 LT	118
d751a7cd	119	/* try_to_freeze() is called from svc_recv() */
83144186	120	set_freezable();
1da177e4	121
d751a7cd	122	/* Allow SIGKILL to tell lockd to drop all of its locks */
1da177e4 LT	123	allow_signal(SIGKILL);
1da177e4 LT	124
1da177e4 LT	125	dprintk("NFS locking service started (ver " LOCKD_VERSION ").\n");
1da177e4 LT	126
d751a7cd JL	127	/*
	128	* FIXME: it would be nice if lockd didn't spend its entire life
	129	* running under the BKL. At the very least, it would be good to
	130	* have someone clarify what it's intended to protect here. I've
	131	* seen some handwavy posts about posix locking needing to be
	132	* done under the BKL, but it's far from clear.
	133	*/
	134	lock_kernel();
	135
1da177e4 LT	136	if (!nlm_timeout)
	137	nlm_timeout = LOCKD_DFLT_TIMEO;
	138	nlmsvc_timeout = nlm_timeout * HZ;
	139
	140	grace_period_expire = set_grace_period();
	141
	142	/*
	143	* The main request loop. We don't terminate until the last
d751a7cd	144	* NFS mount or NFS daemon has gone away.
1da177e4	145	*/
d751a7cd	146	while (!kthread_should_stop()) {
1da177e4	147	long timeout = MAX_SCHEDULE_TIMEOUT;
5216a8e7	148	RPC_IFDEBUG(char buf[RPC_MAX_ADDRBUFLEN]);
1da177e4 LT	149
	150	if (signalled()) {
	151	flush_signals(current);
	152	if (nlmsvc_ops) {
	153	nlmsvc_invalidate_all();
	154	grace_period_expire = set_grace_period();
	155	}
d751a7cd	156	continue;
1da177e4 LT	157	}
	158
	159	/*
	160	* Retry any blocked locks that have been notified by
	161	* the VFS. Don't do this during grace period.
	162	* (Theoretically, there shouldn't even be blocked locks
	163	* during grace period).
	164	*/
	165	if (!nlmsvc_grace_period) {
	166	timeout = nlmsvc_retry_blocked();
	167	} else if (time_before(grace_period_expire, jiffies))
	168	clear_grace_period();
	169
	170	/*
	171	* Find a socket with data available and call its
	172	* recvfrom routine.
	173	*/
6fb2b47f	174	err = svc_recv(rqstp, timeout);
1da177e4 LT	175	if (err == -EAGAIN \|\| err == -EINTR)
	176	continue;
	177	if (err < 0) {
	178	printk(KERN_WARNING
	179	"lockd: terminating on error %d\n",
	180	-err);
	181	break;
	182	}
	183
ad06e4bd CL	184	dprintk("lockd: request from %s\n",
ad06e4bd CL	185	svc_print_addr(rqstp, buf, sizeof(buf)));
1da177e4	186
6fb2b47f	187	svc_process(rqstp);
1da177e4 LT	188	}
1da177e4 LT	189
2bd61579	190	flush_signals(current);
d751a7cd JL	191	if (nlmsvc_ops)
	192	nlmsvc_invalidate_all();
	193	nlm_shutdown_hosts();
2bd61579	194
d751a7cd JL	195	unlock_kernel();
	196
	197	nlmsvc_task = NULL;
	198	nlmsvc_serv = NULL;
46be925f	199
1da177e4 LT	200	/* Exit the RPC thread */
	201	svc_exit_thread(rqstp);
	202
d751a7cd	203	return 0;
1da177e4 LT	204	}
1da177e4 LT	205
482fb94e CL	206	/*
	207	* Make any sockets that are needed but not present.
	208	* If nlm_udpport or nlm_tcpport were set as module
	209	* options, make those sockets unconditionally
	210	*/
24e36663 N	211	static int make_socks(struct svc_serv *serv, int proto)
24e36663 N	212	{
482fb94e	213	static int warned;
a217813f	214	struct svc_xprt *xprt;
24e36663	215	int err = 0;
482fb94e	216
a217813f TT	217	if (proto == IPPROTO_UDP \|\| nlm_udpport) {
	218	xprt = svc_find_xprt(serv, "udp", 0, 0);
	219	if (!xprt)
d7c9f1ed TT	220	err = svc_create_xprt(serv, "udp", nlm_udpport,
d7c9f1ed TT	221	SVC_SOCK_DEFAULTS);
a217813f TT	222	else
	223	svc_xprt_put(xprt);
	224	}
	225	if (err >= 0 && (proto == IPPROTO_TCP \|\| nlm_tcpport)) {
	226	xprt = svc_find_xprt(serv, "tcp", 0, 0);
	227	if (!xprt)
d7c9f1ed TT	228	err = svc_create_xprt(serv, "tcp", nlm_tcpport,
d7c9f1ed TT	229	SVC_SOCK_DEFAULTS);
a217813f TT	230	else
	231	svc_xprt_put(xprt);
	232	}
482fb94e	233	if (err >= 0) {
7dcf91ec	234	warned = 0;
482fb94e CL	235	err = 0;
482fb94e CL	236	} else if (warned++ == 0)
7dcf91ec N	237	printk(KERN_WARNING
7dcf91ec N	238	"lockd_up: makesock failed, error=%d\n", err);
24e36663 N	239	return err;
	240	}
	241
1da177e4 LT	242	/*
	243	* Bring up the lockd process if it's not already up.
	244	*/
	245	int
24e36663	246	lockd_up(int proto) /* Maybe add a 'family' option when IPv6 is supported ?? */
1da177e4	247	{
d751a7cd JL	248	struct svc_serv *serv;
	249	struct svc_rqst *rqstp;
	250	int error = 0;
1da177e4	251
353ab6e9	252	mutex_lock(&nlmsvc_mutex);
1da177e4 LT	253	/*
	254	* Check whether we're already up and running.
	255	*/
d751a7cd	256	if (nlmsvc_serv) {
4a3ae42d N	257	if (proto)
4a3ae42d N	258	error = make_socks(nlmsvc_serv, proto);
1da177e4	259	goto out;
24e36663	260	}
1da177e4 LT	261
	262	/*
	263	* Sanity check: if there's no pid,
	264	* we should be the first user ...
	265	*/
4a3ae42d	266	if (nlmsvc_users)
1da177e4 LT	267	printk(KERN_WARNING
	268	"lockd_up: no pid, %d users??\n", nlmsvc_users);
	269
	270	error = -ENOMEM;
bc591ccf	271	serv = svc_create(&nlmsvc_program, LOCKD_BUFSIZE, NULL);
1da177e4 LT	272	if (!serv) {
	273	printk(KERN_WARNING "lockd_up: create service failed\n");
	274	goto out;
	275	}
	276
7dcf91ec	277	if ((error = make_socks(serv, proto)) < 0)
1da177e4	278	goto destroy_and_out;
1da177e4 LT	279
	280	/*
	281	* Create the kernel thread and wait for it to start.
	282	*/
d751a7cd JL	283	rqstp = svc_prepare_thread(serv, &serv->sv_pools[0]);
	284	if (IS_ERR(rqstp)) {
	285	error = PTR_ERR(rqstp);
	286	printk(KERN_WARNING
	287	"lockd_up: svc_rqst allocation failed, error=%d\n",
	288	error);
	289	goto destroy_and_out;
	290	}
	291
	292	svc_sock_update_bufs(serv);
	293	nlmsvc_serv = rqstp->rq_server;
	294
	295	nlmsvc_task = kthread_run(lockd, rqstp, serv->sv_name);
	296	if (IS_ERR(nlmsvc_task)) {
	297	error = PTR_ERR(nlmsvc_task);
	298	nlmsvc_task = NULL;
	299	nlmsvc_serv = NULL;
1da177e4	300	printk(KERN_WARNING
d751a7cd JL	301	"lockd_up: kthread_run failed, error=%d\n", error);
d751a7cd JL	302	svc_exit_thread(rqstp);
1da177e4 LT	303	goto destroy_and_out;
1da177e4 LT	304	}
1da177e4 LT	305
	306	/*
	307	* Note: svc_serv structures have an initial use count of 1,
	308	* so we exit through here on both success and failure.
	309	*/
	310	destroy_and_out:
	311	svc_destroy(serv);
	312	out:
4a3ae42d N	313	if (!error)
4a3ae42d N	314	nlmsvc_users++;
353ab6e9	315	mutex_unlock(&nlmsvc_mutex);
1da177e4 LT	316	return error;
	317	}
	318	EXPORT_SYMBOL(lockd_up);
	319
	320	/*
	321	* Decrement the user count and bring down lockd if we're the last.
	322	*/
	323	void
	324	lockd_down(void)
	325	{
353ab6e9	326	mutex_lock(&nlmsvc_mutex);
1da177e4 LT	327	if (nlmsvc_users) {
	328	if (--nlmsvc_users)
	329	goto out;
d751a7cd JL	330	} else {
	331	printk(KERN_ERR "lockd_down: no users! task=%p\n",
	332	nlmsvc_task);
	333	BUG();
1da177e4	334	}
1da177e4	335
d751a7cd JL	336	if (!nlmsvc_task) {
	337	printk(KERN_ERR "lockd_down: no lockd running.\n");
	338	BUG();
1da177e4	339	}
d751a7cd	340	kthread_stop(nlmsvc_task);
1da177e4	341	out:
353ab6e9	342	mutex_unlock(&nlmsvc_mutex);
1da177e4 LT	343	}
	344	EXPORT_SYMBOL(lockd_down);
	345
	346	/*
	347	* Sysctl parameters (same as module parameters, different interface).
	348	*/
	349
1da177e4 LT	350	static ctl_table nlm_sysctls[] = {
	351	{
	352	.ctl_name = CTL_UNNUMBERED,
	353	.procname = "nlm_grace_period",
	354	.data = &nlm_grace_period,
7ee91ec1	355	.maxlen = sizeof(unsigned long),
1da177e4 LT	356	.mode = 0644,
	357	.proc_handler = &proc_doulongvec_minmax,
	358	.extra1 = (unsigned long *) &nlm_grace_period_min,
	359	.extra2 = (unsigned long *) &nlm_grace_period_max,
	360	},
	361	{
	362	.ctl_name = CTL_UNNUMBERED,
	363	.procname = "nlm_timeout",
	364	.data = &nlm_timeout,
7ee91ec1	365	.maxlen = sizeof(unsigned long),
1da177e4 LT	366	.mode = 0644,
	367	.proc_handler = &proc_doulongvec_minmax,
	368	.extra1 = (unsigned long *) &nlm_timeout_min,
	369	.extra2 = (unsigned long *) &nlm_timeout_max,
	370	},
	371	{
	372	.ctl_name = CTL_UNNUMBERED,
	373	.procname = "nlm_udpport",
	374	.data = &nlm_udpport,
	375	.maxlen = sizeof(int),
	376	.mode = 0644,
	377	.proc_handler = &proc_dointvec_minmax,
	378	.extra1 = (int *) &nlm_port_min,
	379	.extra2 = (int *) &nlm_port_max,
	380	},
	381	{
	382	.ctl_name = CTL_UNNUMBERED,
	383	.procname = "nlm_tcpport",
	384	.data = &nlm_tcpport,
	385	.maxlen = sizeof(int),
	386	.mode = 0644,
	387	.proc_handler = &proc_dointvec_minmax,
	388	.extra1 = (int *) &nlm_port_min,
	389	.extra2 = (int *) &nlm_port_max,
	390	},
abd1f500 OK	391	{
	392	.ctl_name = CTL_UNNUMBERED,
	393	.procname = "nsm_use_hostnames",
	394	.data = &nsm_use_hostnames,
	395	.maxlen = sizeof(int),
	396	.mode = 0644,
	397	.proc_handler = &proc_dointvec,
	398	},
460f5cac OK	399	{
	400	.ctl_name = CTL_UNNUMBERED,
	401	.procname = "nsm_local_state",
	402	.data = &nsm_local_state,
	403	.maxlen = sizeof(int),
	404	.mode = 0644,
	405	.proc_handler = &proc_dointvec,
	406	},
1da177e4 LT	407	{ .ctl_name = 0 }
	408	};
	409
	410	static ctl_table nlm_sysctl_dir[] = {
	411	{
	412	.ctl_name = CTL_UNNUMBERED,
	413	.procname = "nfs",
	414	.mode = 0555,
	415	.child = nlm_sysctls,
	416	},
	417	{ .ctl_name = 0 }
	418	};
	419
	420	static ctl_table nlm_sysctl_root[] = {
	421	{
	422	.ctl_name = CTL_FS,
	423	.procname = "fs",
	424	.mode = 0555,
	425	.child = nlm_sysctl_dir,
	426	},
	427	{ .ctl_name = 0 }
	428	};
	429
	430	/*
405ae7d3	431	* Module (and sysfs) parameters.
1da177e4 LT	432	*/
	433
	434	#define param_set_min_max(name, type, which_strtol, min, max) \
	435	static int param_set_##name(const char val, struct kernel_param kp) \
	436	{ \
	437	char *endp; \
	438	__typeof__(type) num = which_strtol(val, &endp, 0); \
	439	if (endp == val \|\| *endp \|\| num < (min) \|\| num > (max)) \
	440	return -EINVAL; \
	441	((int ) kp->arg) = num; \
	442	return 0; \
	443	}
	444
	445	static inline int is_callback(u32 proc)
	446	{
	447	return proc == NLMPROC_GRANTED
	448	\|\| proc == NLMPROC_GRANTED_MSG
	449	\|\| proc == NLMPROC_TEST_RES
	450	\|\| proc == NLMPROC_LOCK_RES
	451	\|\| proc == NLMPROC_CANCEL_RES
	452	\|\| proc == NLMPROC_UNLOCK_RES
	453	\|\| proc == NLMPROC_NSM_NOTIFY;
	454	}
	455
	456
	457	static int lockd_authenticate(struct svc_rqst *rqstp)
	458	{
	459	rqstp->rq_client = NULL;
	460	switch (rqstp->rq_authop->flavour) {
	461	case RPC_AUTH_NULL:
	462	case RPC_AUTH_UNIX:
	463	if (rqstp->rq_proc == 0)
	464	return SVC_OK;
	465	if (is_callback(rqstp->rq_proc)) {
	466	/* Leave it to individual procedures to
	467	* call nlmsvc_lookup_host(rqstp)
	468	*/
	469	return SVC_OK;
	470	}
	471	return svc_set_client(rqstp);
	472	}
	473	return SVC_DENIED;
	474	}
	475
	476
	477	param_set_min_max(port, int, simple_strtol, 0, 65535)
	478	param_set_min_max(grace_period, unsigned long, simple_strtoul,
	479	nlm_grace_period_min, nlm_grace_period_max)
	480	param_set_min_max(timeout, unsigned long, simple_strtoul,
	481	nlm_timeout_min, nlm_timeout_max)
	482
	483	MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
	484	MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION ".");
	485	MODULE_LICENSE("GPL");
	486
	487	module_param_call(nlm_grace_period, param_set_grace_period, param_get_ulong,
	488	&nlm_grace_period, 0644);
	489	module_param_call(nlm_timeout, param_set_timeout, param_get_ulong,
	490	&nlm_timeout, 0644);
	491	module_param_call(nlm_udpport, param_set_port, param_get_int,
	492	&nlm_udpport, 0644);
	493	module_param_call(nlm_tcpport, param_set_port, param_get_int,
	494	&nlm_tcpport, 0644);
abd1f500	495	module_param(nsm_use_hostnames, bool, 0644);
1da177e4 LT	496
	497	/*
	498	* Initialising and terminating the module.
	499	*/
	500
	501	static int __init init_nlm(void)
	502	{
0b4d4147	503	nlm_sysctl_table = register_sysctl_table(nlm_sysctl_root);
1da177e4 LT	504	return nlm_sysctl_table ? 0 : -ENOMEM;
	505	}
	506
	507	static void __exit exit_nlm(void)
	508	{
	509	/* FIXME: delete all NLM clients */
	510	nlm_shutdown_hosts();
	511	unregister_sysctl_table(nlm_sysctl_table);
	512	}
	513
	514	module_init(init_nlm);
	515	module_exit(exit_nlm);
	516
	517	/*
	518	* Define NLM program and procedures
	519	*/
	520	static struct svc_version nlmsvc_version1 = {
	521	.vs_vers = 1,
	522	.vs_nproc = 17,
	523	.vs_proc = nlmsvc_procedures,
	524	.vs_xdrsize = NLMSVC_XDRSIZE,
	525	};
	526	static struct svc_version nlmsvc_version3 = {
	527	.vs_vers = 3,
	528	.vs_nproc = 24,
	529	.vs_proc = nlmsvc_procedures,
	530	.vs_xdrsize = NLMSVC_XDRSIZE,
	531	};
	532	#ifdef CONFIG_LOCKD_V4
	533	static struct svc_version nlmsvc_version4 = {
	534	.vs_vers = 4,
	535	.vs_nproc = 24,
	536	.vs_proc = nlmsvc_procedures4,
	537	.vs_xdrsize = NLMSVC_XDRSIZE,
	538	};
	539	#endif
	540	static struct svc_version * nlmsvc_version[] = {
	541	[1] = &nlmsvc_version1,
	542	[3] = &nlmsvc_version3,
	543	#ifdef CONFIG_LOCKD_V4
	544	[4] = &nlmsvc_version4,
	545	#endif
	546	};
	547
	548	static struct svc_stat nlmsvc_stats;
	549
e8c96f8c	550	#define NLM_NRVERS ARRAY_SIZE(nlmsvc_version)
1da177e4 LT	551	static struct svc_program nlmsvc_program = {
	552	.pg_prog = NLM_PROGRAM, /* program number */
	553	.pg_nvers = NLM_NRVERS, /* number of entries in nlmsvc_version */
	554	.pg_vers = nlmsvc_version, /* version table */
	555	.pg_name = "lockd", /* service name */
	556	.pg_class = "nfsd", /* share authentication with nfsd */
	557	.pg_stats = &nlmsvc_stats, /* stats table */
	558	.pg_authenticate = &lockd_authenticate /* export authentication */
	559	};