[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 void grace_ender(struct work_struct *not_used)
{
	nlmsvc_grace_period = 0;
}

static DECLARE_DELAYED_WORK(grace_period_end, grace_ender);

static void set_grace_period(void)
{
	unsigned long grace_period = get_nfs_grace_period() + jiffies;

	nlmsvc_grace_period = 1;
	cancel_delayed_work_sync(&grace_period_end);
	schedule_delayed_work(&grace_period_end, grace_period);
}

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

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

	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();
				set_grace_period();
			}
			continue;
		}

		timeout = nlmsvc_retry_blocked();

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