[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 ([email protected])
 *
 * Copyright (C) 1995, 1996 Olaf Kirch <[email protected]>
 */

#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/smp.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/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;

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

static void restart_grace(void)
{
	if (nlmsvc_ops) {
		cancel_delayed_work_sync(&grace_period_end);
		locks_end_grace(&lockd_manager);
		nlmsvc_invalidate_all();
		set_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");

	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);
			restart_grace();
			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();
	return 0;
}

static int create_lockd_listener(struct svc_serv *serv, const char *name,
				 const int family, const unsigned short port)
{
	struct svc_xprt *xprt;

	xprt = svc_find_xprt(serv, name, family, 0);
	if (xprt == NULL)
		return svc_create_xprt(serv, name, &init_net, family, port,
						SVC_SOCK_DEFAULTS);
	svc_xprt_put(xprt);
	return 0;
}

static int create_lockd_family(struct svc_serv *serv, const int family)
{
	int err;

	err = create_lockd_listener(serv, "udp", family, nlm_udpport);
	if (err < 0)
		return err;

	return create_lockd_listener(serv, "tcp", family, nlm_tcpport);
}

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

	err = create_lockd_family(serv, PF_INET);
	if (err < 0)
		goto out_err;

	err = create_lockd_family(serv, PF_INET6);
	if (err < 0 && err != -EAFNOSUPPORT)
		goto out_err;

	warned = 0;
	return 0;

out_err:
	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, 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], NUMA_NO_NODE);
	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[] = {
	{
		.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,
	},
	{
		.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,
	},
	{
		.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,
	},
	{
		.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,
	},
	{
		.procname	= "nsm_use_hostnames",
		.data		= &nsm_use_hostnames,
		.maxlen		= sizeof(int),
		.mode		= 0644,
		.proc_handler	= proc_dointvec,
	},
	{
		.procname	= "nsm_local_state",
		.data		= &nsm_local_state,
		.maxlen		= sizeof(int),
		.mode		= 0644,
		.proc_handler	= proc_dointvec,
	},
	{ }
};

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

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

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