[deliverable/linux.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_rqst		*nlmsvc_rqst;
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;

#ifdef CONFIG_SYSCTL
static struct ctl_table_header * nlm_sysctl_table;
#endif

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, preverr = 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) {
			preverr = err;
			continue;
		}
		if (err < 0) {
			if (err != preverr) {
				printk(KERN_WARNING "%s: unexpected error "
					"from svc_recv (%d)\n", __func__, err);
				preverr = err;
			}
			schedule_timeout_interruptible(HZ);
			continue;
		}
		preverr = err;

		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();
	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;
	int		error = 0;

	mutex_lock(&nlmsvc_mutex);
	/*
	 * Check whether we're already up and running.
	 */
	if (nlmsvc_rqst) {
		if (proto)
			error = make_socks(nlmsvc_rqst->rq_server, 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.
	 */
	nlmsvc_rqst = svc_prepare_thread(serv, &serv->sv_pools[0]);
	if (IS_ERR(nlmsvc_rqst)) {
		error = PTR_ERR(nlmsvc_rqst);
		nlmsvc_rqst = NULL;
		printk(KERN_WARNING
			"lockd_up: svc_rqst allocation failed, error=%d\n",
			error);
		goto destroy_and_out;
	}

	svc_sock_update_bufs(serv);

	nlmsvc_task = kthread_run(lockd, nlmsvc_rqst, serv->sv_name);
	if (IS_ERR(nlmsvc_task)) {
		error = PTR_ERR(nlmsvc_task);
		svc_exit_thread(nlmsvc_rqst);
		nlmsvc_task = NULL;
		nlmsvc_rqst = NULL;
		printk(KERN_WARNING
			"lockd_up: kthread_run failed, error=%d\n", error);
		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);
	svc_exit_thread(nlmsvc_rqst);
	nlmsvc_task = NULL;
	nlmsvc_rqst = NULL;
out:
	mutex_unlock(&nlmsvc_mutex);
}
EXPORT_SYMBOL(lockd_down);

#ifdef CONFIG_SYSCTL

/*
 * 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 }
};

#endif	/* CONFIG_SYSCTL */

/*
 * 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)
{
#ifdef CONFIG_SYSCTL
	nlm_sysctl_table = register_sysctl_table(nlm_sysctl_root);
	return nlm_sysctl_table ? 0 : -ENOMEM;
#else
	return 0;
#endif
}

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

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