[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_GPL(nlmsvc_ops);

static DEFINE_MUTEX(nlmsvc_mutex);
static unsigned int		nlmsvc_users;
static struct task_struct	*nlmsvc_task;
static struct svc_rqst		*nlmsvc_rqst;
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;

/* RLIM_NOFILE defaults to 1024. That seems like a reasonable default here. */
static unsigned int		nlm_max_connections = 1024;

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

static struct lock_manager lockd_manager = {
};

static void grace_ender(struct work_struct *not_used)
{
	locks_end_grace(&lockd_manager);
}

static DECLARE_DELAYED_WORK(grace_period_end, grace_ender);

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

	locks_start_grace(&lockd_manager);
	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]);

		/* update sv_maxconn if it has changed */
		rqstp->rq_server->sv_maxconn = nlm_max_connections;

		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);
	locks_end_grace(&lockd_manager);
	if (nlmsvc_ops)
		nlmsvc_invalidate_all();
	nlm_shutdown_hosts();
	unlock_kernel();
	return 0;
}

/*
 * Ensure there are active UDP and TCP listeners for lockd.
 *
 * Even if we have only TCP NFS mounts and/or TCP NFSDs, some
 * local services (such as rpc.statd) still require UDP, and
 * some NFS servers do not yet support NLM over TCP.
 *
 * Returns zero if all listeners are available; otherwise a
 * negative errno value is returned.
 */
static int make_socks(struct svc_serv *serv)
{
	static int warned;
	struct svc_xprt *xprt;
	int err = 0;

	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) {
		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(void)
{
	struct svc_serv *serv;
	int		error = 0;

	mutex_lock(&nlmsvc_mutex);
	/*
	 * Check whether we're already up and running.
	 */
	if (nlmsvc_rqst)
		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;
	}

	error = make_socks(serv);
	if (error < 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);
	serv->sv_maxconn = nlm_max_connections;

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