[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/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>

#include "netns.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;

int lockd_net_id;

/*
 * 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,
				 struct net *net, const int family,
				 const unsigned short port)
{
	struct svc_xprt *xprt;

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

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

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

	return create_lockd_listener(serv, "tcp", net, 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, struct net *net)
{
	static int warned;
	int err;

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

	err = create_lockd_family(serv, net, 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;
}

static int lockd_up_net(struct net *net)
{
	struct lockd_net *ln = net_generic(net, lockd_net_id);
	struct svc_serv *serv = nlmsvc_rqst->rq_server;
	int error;

	if (ln->nlmsvc_users)
		return 0;

	error = svc_rpcb_setup(serv, net);
	if (error)
		goto err_rpcb;

	error = make_socks(serv, net);
	if (error < 0)
		goto err_socks;
	return 0;

err_socks:
	svc_rpcb_cleanup(serv, net);
err_rpcb:
	return error;
}

static void lockd_down_net(struct net *net)
{
	struct lockd_net *ln = net_generic(net, lockd_net_id);
	struct svc_serv *serv = nlmsvc_rqst->rq_server;

	if (ln->nlmsvc_users) {
		if (--ln->nlmsvc_users == 0) {
			nlm_shutdown_hosts_net(net);
			svc_shutdown_net(serv, net);
		}
	} else {
		printk(KERN_ERR "lockd_down_net: no users! task=%p, net=%p\n",
				nlmsvc_task, net);
		BUG();
	}
}

/*
 * Bring up the lockd process if it's not already up.
 */
int lockd_up(void)
{
	struct svc_serv *serv;
	int		error = 0;
	struct net *net = current->nsproxy->net_ns;

	mutex_lock(&nlmsvc_mutex);
	/*
	 * Check whether we're already up and running.
	 */
	if (nlmsvc_rqst) {
		error = lockd_up_net(net);
		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, net);
	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) {
		struct lockd_net *ln = net_generic(net, lockd_net_id);

		ln->nlmsvc_users++;
		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) {
			lockd_down_net(current->nsproxy->net_ns);
			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;						\
	*((type *) 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);

static int lockd_init_net(struct net *net)
{
	return 0;
}

static void lockd_exit_net(struct net *net)
{
}

static struct pernet_operations lockd_net_ops = {
	.init = lockd_init_net,
	.exit = lockd_exit_net,
	.id = &lockd_net_id,
	.size = sizeof(struct lockd_net),
};


/*
 * Initialising and terminating the module.
 */

static int __init init_nlm(void)
{
	int err;

#ifdef CONFIG_SYSCTL
	err = -ENOMEM;
	nlm_sysctl_table = register_sysctl_table(nlm_sysctl_root);
	if (nlm_sysctl_table == NULL)
		goto err_sysctl;
#endif
	err = register_pernet_subsys(&lockd_net_ops);
	if (err)
		goto err_pernet;
	return 0;

err_pernet:
#ifdef CONFIG_SYSCTL
	unregister_sysctl_table(nlm_sysctl_table);
#endif
err_sysctl:
	return err;
}

static void __exit exit_nlm(void)
{
	/* FIXME: delete all NLM clients */
	nlm_shutdown_hosts();
	unregister_pernet_subsys(&lockd_net_ops);
#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>
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
a9c5d73a SK	38	#include "netns.h"
a9c5d73a SK	39
1da177e4 LT	40	#define NLMDBG_FACILITY NLMDBG_SVC
	41	#define LOCKD_BUFSIZE (1024 + NLMSVC_XDRSIZE)
	42	#define ALLOWED_SIGS (sigmask(SIGKILL))
	43
	44	static struct svc_program nlmsvc_program;
	45
	46	struct nlmsvc_binding * nlmsvc_ops;
2de59872	47	EXPORT_SYMBOL_GPL(nlmsvc_ops);
1da177e4	48
353ab6e9	49	static DEFINE_MUTEX(nlmsvc_mutex);
1da177e4	50	static unsigned int nlmsvc_users;
d751a7cd	51	static struct task_struct *nlmsvc_task;
abd1ec4e	52	static struct svc_rqst *nlmsvc_rqst;
1da177e4 LT	53	unsigned long nlmsvc_timeout;
1da177e4 LT	54
a9c5d73a SK	55	int lockd_net_id;
a9c5d73a SK	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;
	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	}
1da177e4 LT	108
89996df4 BF	109	static void restart_grace(void)
	110	{
	111	if (nlmsvc_ops) {
	112	cancel_delayed_work_sync(&grace_period_end);
	113	locks_end_grace(&lockd_manager);
	114	nlmsvc_invalidate_all();
	115	set_grace_period();
	116	}
	117	}
	118
1da177e4 LT	119	/*
	120	* This is the lockd kernel thread
	121	*/
d751a7cd JL	122	static int
d751a7cd JL	123	lockd(void *vrqstp)
1da177e4	124	{
f97c650d	125	int err = 0, preverr = 0;
d751a7cd	126	struct svc_rqst *rqstp = vrqstp;
1da177e4	127
d751a7cd	128	/* try_to_freeze() is called from svc_recv() */
83144186	129	set_freezable();
1da177e4	130
d751a7cd	131	/* Allow SIGKILL to tell lockd to drop all of its locks */
1da177e4 LT	132	allow_signal(SIGKILL);
1da177e4 LT	133
1da177e4 LT	134	dprintk("NFS locking service started (ver " LOCKD_VERSION ").\n");
	135
	136	if (!nlm_timeout)
	137	nlm_timeout = LOCKD_DFLT_TIMEO;
	138	nlmsvc_timeout = nlm_timeout * HZ;
	139
c8ab5f2a	140	set_grace_period();
1da177e4 LT	141
	142	/*
	143	* The main request loop. We don't terminate until the last
d751a7cd	144	* NFS mount or NFS daemon has gone away.
1da177e4	145	*/
d751a7cd	146	while (!kthread_should_stop()) {
1da177e4	147	long timeout = MAX_SCHEDULE_TIMEOUT;
5216a8e7	148	RPC_IFDEBUG(char buf[RPC_MAX_ADDRBUFLEN]);
1da177e4	149
c72a476b JL	150	/* update sv_maxconn if it has changed */
	151	rqstp->rq_server->sv_maxconn = nlm_max_connections;
	152
1da177e4 LT	153	if (signalled()) {
1da177e4 LT	154	flush_signals(current);
89996df4	155	restart_grace();
d751a7cd	156	continue;
1da177e4 LT	157	}
1da177e4 LT	158
8fafa900 BF	159	timeout = nlmsvc_retry_blocked();
8fafa900 BF	160
1da177e4 LT	161	/*
	162	* Find a socket with data available and call its
	163	* recvfrom routine.
	164	*/
6fb2b47f	165	err = svc_recv(rqstp, timeout);
f97c650d JL	166	if (err == -EAGAIN \|\| err == -EINTR) {
f97c650d JL	167	preverr = err;
1da177e4	168	continue;
f97c650d	169	}
1da177e4	170	if (err < 0) {
f97c650d JL	171	if (err != preverr) {
	172	printk(KERN_WARNING "%s: unexpected error "
	173	"from svc_recv (%d)\n", __func__, err);
	174	preverr = err;
	175	}
	176	schedule_timeout_interruptible(HZ);
	177	continue;
1da177e4	178	}
f97c650d	179	preverr = err;
1da177e4	180
ad06e4bd CL	181	dprintk("lockd: request from %s\n",
ad06e4bd CL	182	svc_print_addr(rqstp, buf, sizeof(buf)));
1da177e4	183
6fb2b47f	184	svc_process(rqstp);
1da177e4	185	}
2bd61579	186	flush_signals(current);
c8ab5f2a	187	cancel_delayed_work_sync(&grace_period_end);
2c5e7615	188	locks_end_grace(&lockd_manager);
d751a7cd JL	189	if (nlmsvc_ops)
	190	nlmsvc_invalidate_all();
	191	nlm_shutdown_hosts();
d751a7cd	192	return 0;
1da177e4 LT	193	}
1da177e4 LT	194
eb16e907	195	static int create_lockd_listener(struct svc_serv serv, const char name,
c228fa20 SK	196	struct net *net, const int family,
c228fa20 SK	197	const unsigned short port)
d3fe5ea7 CL	198	{
	199	struct svc_xprt *xprt;
	200
c228fa20	201	xprt = svc_find_xprt(serv, name, net, family, 0);
d3fe5ea7	202	if (xprt == NULL)
c228fa20	203	return svc_create_xprt(serv, name, net, family, port,
eb16e907	204	SVC_SOCK_DEFAULTS);
d3fe5ea7 CL	205	svc_xprt_put(xprt);
	206	return 0;
	207	}
	208
c228fa20 SK	209	static int create_lockd_family(struct svc_serv serv, struct net net,
c228fa20 SK	210	const int family)
eb16e907 CL	211	{
	212	int err;
	213
c228fa20	214	err = create_lockd_listener(serv, "udp", net, family, nlm_udpport);
eb16e907 CL	215	if (err < 0)
	216	return err;
	217
c228fa20	218	return create_lockd_listener(serv, "tcp", net, family, nlm_tcpport);
eb16e907 CL	219	}
eb16e907 CL	220
482fb94e	221	/*
8c3916f4 CL	222	* Ensure there are active UDP and TCP listeners for lockd.
	223	*
	224	* Even if we have only TCP NFS mounts and/or TCP NFSDs, some
	225	* local services (such as rpc.statd) still require UDP, and
	226	* some NFS servers do not yet support NLM over TCP.
	227	*
	228	* Returns zero if all listeners are available; otherwise a
	229	* negative errno value is returned.
482fb94e	230	*/
c228fa20	231	static int make_socks(struct svc_serv serv, struct net net)
24e36663	232	{
482fb94e	233	static int warned;
0dba7c2a	234	int err;
482fb94e	235
c228fa20	236	err = create_lockd_family(serv, net, PF_INET);
0dba7c2a CL	237	if (err < 0)
	238	goto out_err;
	239
c228fa20	240	err = create_lockd_family(serv, net, PF_INET6);
eb16e907	241	if (err < 0 && err != -EAFNOSUPPORT)
0dba7c2a CL	242	goto out_err;
	243
	244	warned = 0;
	245	return 0;
	246
	247	out_err:
	248	if (warned++ == 0)
7dcf91ec	249	printk(KERN_WARNING
0dba7c2a	250	"lockd_up: makesock failed, error=%d\n", err);
24e36663 N	251	return err;
	252	}
	253
bb2224df SK	254	static int lockd_up_net(struct net *net)
	255	{
	256	struct lockd_net *ln = net_generic(net, lockd_net_id);
	257	struct svc_serv *serv = nlmsvc_rqst->rq_server;
	258	int error;
	259
	260	if (ln->nlmsvc_users)
	261	return 0;
	262
	263	error = svc_rpcb_setup(serv, net);
	264	if (error)
	265	goto err_rpcb;
	266
	267	error = make_socks(serv, net);
	268	if (error < 0)
	269	goto err_socks;
	270	return 0;
	271
	272	err_socks:
	273	svc_rpcb_cleanup(serv, net);
	274	err_rpcb:
	275	return error;
	276	}
	277
	278	static void lockd_down_net(struct net *net)
	279	{
	280	struct lockd_net *ln = net_generic(net, lockd_net_id);
	281	struct svc_serv *serv = nlmsvc_rqst->rq_server;
	282
	283	if (ln->nlmsvc_users) {
3b64739f SK	284	if (--ln->nlmsvc_users == 0) {
3b64739f SK	285	nlm_shutdown_hosts_net(net);
bb2224df	286	svc_shutdown_net(serv, net);
3b64739f	287	}
bb2224df SK	288	} else {
	289	printk(KERN_ERR "lockd_down_net: no users! task=%p, net=%p\n",
	290	nlmsvc_task, net);
	291	BUG();
	292	}
	293	}
	294
1da177e4 LT	295	/*
	296	* Bring up the lockd process if it's not already up.
	297	*/
26a41409	298	int lockd_up(void)
1da177e4	299	{
d751a7cd	300	struct svc_serv *serv;
d751a7cd	301	int error = 0;
c228fa20	302	struct net *net = current->nsproxy->net_ns;
1da177e4	303
353ab6e9	304	mutex_lock(&nlmsvc_mutex);
1da177e4 LT	305	/*
	306	* Check whether we're already up and running.
	307	*/
bb2224df SK	308	if (nlmsvc_rqst) {
bb2224df SK	309	error = lockd_up_net(net);
1da177e4	310	goto out;
bb2224df	311	}
1da177e4 LT	312
	313	/*
	314	* Sanity check: if there's no pid,
	315	* we should be the first user ...
	316	*/
4a3ae42d	317	if (nlmsvc_users)
1da177e4 LT	318	printk(KERN_WARNING
	319	"lockd_up: no pid, %d users??\n", nlmsvc_users);
	320
	321	error = -ENOMEM;
49a9072f	322	serv = svc_create(&nlmsvc_program, LOCKD_BUFSIZE, NULL);
1da177e4 LT	323	if (!serv) {
	324	printk(KERN_WARNING "lockd_up: create service failed\n");
	325	goto out;
	326	}
	327
c228fa20	328	error = make_socks(serv, net);
8c3916f4	329	if (error < 0)
1da177e4	330	goto destroy_and_out;
1da177e4 LT	331
	332	/*
	333	* Create the kernel thread and wait for it to start.
	334	*/
11fd165c	335	nlmsvc_rqst = svc_prepare_thread(serv, &serv->sv_pools[0], NUMA_NO_NODE);
abd1ec4e JL	336	if (IS_ERR(nlmsvc_rqst)) {
	337	error = PTR_ERR(nlmsvc_rqst);
	338	nlmsvc_rqst = NULL;
d751a7cd JL	339	printk(KERN_WARNING
	340	"lockd_up: svc_rqst allocation failed, error=%d\n",
	341	error);
	342	goto destroy_and_out;
	343	}
	344
	345	svc_sock_update_bufs(serv);
c72a476b	346	serv->sv_maxconn = nlm_max_connections;
d751a7cd	347
abd1ec4e	348	nlmsvc_task = kthread_run(lockd, nlmsvc_rqst, serv->sv_name);
d751a7cd JL	349	if (IS_ERR(nlmsvc_task)) {
d751a7cd JL	350	error = PTR_ERR(nlmsvc_task);
abd1ec4e	351	svc_exit_thread(nlmsvc_rqst);
d751a7cd	352	nlmsvc_task = NULL;
abd1ec4e	353	nlmsvc_rqst = NULL;
1da177e4	354	printk(KERN_WARNING
d751a7cd	355	"lockd_up: kthread_run failed, error=%d\n", error);
1da177e4 LT	356	goto destroy_and_out;
1da177e4 LT	357	}
1da177e4 LT	358
	359	/*
	360	* Note: svc_serv structures have an initial use count of 1,
	361	* so we exit through here on both success and failure.
	362	*/
	363	destroy_and_out:
	364	svc_destroy(serv);
	365	out:
a9c5d73a SK	366	if (!error) {
	367	struct lockd_net *ln = net_generic(net, lockd_net_id);
	368
	369	ln->nlmsvc_users++;
4a3ae42d	370	nlmsvc_users++;
a9c5d73a	371	}
353ab6e9	372	mutex_unlock(&nlmsvc_mutex);
1da177e4 LT	373	return error;
1da177e4 LT	374	}
2de59872	375	EXPORT_SYMBOL_GPL(lockd_up);
1da177e4 LT	376
	377	/*
	378	* Decrement the user count and bring down lockd if we're the last.
	379	*/
	380	void
	381	lockd_down(void)
	382	{
353ab6e9	383	mutex_lock(&nlmsvc_mutex);
1da177e4	384	if (nlmsvc_users) {
bb2224df SK	385	if (--nlmsvc_users) {
bb2224df SK	386	lockd_down_net(current->nsproxy->net_ns);
1da177e4	387	goto out;
bb2224df	388	}
d751a7cd JL	389	} else {
	390	printk(KERN_ERR "lockd_down: no users! task=%p\n",
	391	nlmsvc_task);
	392	BUG();
1da177e4	393	}
1da177e4	394
d751a7cd JL	395	if (!nlmsvc_task) {
	396	printk(KERN_ERR "lockd_down: no lockd running.\n");
	397	BUG();
1da177e4	398	}
d751a7cd	399	kthread_stop(nlmsvc_task);
abd1ec4e JL	400	svc_exit_thread(nlmsvc_rqst);
	401	nlmsvc_task = NULL;
	402	nlmsvc_rqst = NULL;
1da177e4	403	out:
353ab6e9	404	mutex_unlock(&nlmsvc_mutex);
1da177e4	405	}
2de59872	406	EXPORT_SYMBOL_GPL(lockd_down);
1da177e4	407
90d5b180 CL	408	#ifdef CONFIG_SYSCTL
90d5b180 CL	409
1da177e4 LT	410	/*
	411	* Sysctl parameters (same as module parameters, different interface).
	412	*/
	413
1da177e4 LT	414	static ctl_table nlm_sysctls[] = {
1da177e4 LT	415	{
1da177e4 LT	416	.procname = "nlm_grace_period",
1da177e4 LT	417	.data = &nlm_grace_period,
7ee91ec1	418	.maxlen = sizeof(unsigned long),
1da177e4	419	.mode = 0644,
6d456111	420	.proc_handler = proc_doulongvec_minmax,
1da177e4 LT	421	.extra1 = (unsigned long *) &nlm_grace_period_min,
	422	.extra2 = (unsigned long *) &nlm_grace_period_max,
	423	},
	424	{
1da177e4 LT	425	.procname = "nlm_timeout",
1da177e4 LT	426	.data = &nlm_timeout,
7ee91ec1	427	.maxlen = sizeof(unsigned long),
1da177e4	428	.mode = 0644,
6d456111	429	.proc_handler = proc_doulongvec_minmax,
1da177e4 LT	430	.extra1 = (unsigned long *) &nlm_timeout_min,
	431	.extra2 = (unsigned long *) &nlm_timeout_max,
	432	},
	433	{
1da177e4 LT	434	.procname = "nlm_udpport",
	435	.data = &nlm_udpport,
	436	.maxlen = sizeof(int),
	437	.mode = 0644,
6d456111	438	.proc_handler = proc_dointvec_minmax,
1da177e4 LT	439	.extra1 = (int *) &nlm_port_min,
	440	.extra2 = (int *) &nlm_port_max,
	441	},
	442	{
1da177e4 LT	443	.procname = "nlm_tcpport",
	444	.data = &nlm_tcpport,
	445	.maxlen = sizeof(int),
	446	.mode = 0644,
6d456111	447	.proc_handler = proc_dointvec_minmax,
1da177e4 LT	448	.extra1 = (int *) &nlm_port_min,
	449	.extra2 = (int *) &nlm_port_max,
	450	},
abd1f500	451	{
abd1f500 OK	452	.procname = "nsm_use_hostnames",
	453	.data = &nsm_use_hostnames,
	454	.maxlen = sizeof(int),
	455	.mode = 0644,
6d456111	456	.proc_handler = proc_dointvec,
abd1f500	457	},
460f5cac	458	{
460f5cac OK	459	.procname = "nsm_local_state",
	460	.data = &nsm_local_state,
	461	.maxlen = sizeof(int),
	462	.mode = 0644,
6d456111	463	.proc_handler = proc_dointvec,
460f5cac	464	},
ab09203e	465	{ }
1da177e4 LT	466	};
	467
	468	static ctl_table nlm_sysctl_dir[] = {
	469	{
1da177e4 LT	470	.procname = "nfs",
	471	.mode = 0555,
	472	.child = nlm_sysctls,
	473	},
ab09203e	474	{ }
1da177e4 LT	475	};
	476
	477	static ctl_table nlm_sysctl_root[] = {
	478	{
1da177e4 LT	479	.procname = "fs",
	480	.mode = 0555,
	481	.child = nlm_sysctl_dir,
	482	},
ab09203e	483	{ }
1da177e4 LT	484	};
1da177e4 LT	485
90d5b180 CL	486	#endif /* CONFIG_SYSCTL */
90d5b180 CL	487
1da177e4	488	/*
405ae7d3	489	* Module (and sysfs) parameters.
1da177e4 LT	490	*/
	491
	492	#define param_set_min_max(name, type, which_strtol, min, max) \
	493	static int param_set_##name(const char val, struct kernel_param kp) \
	494	{ \
	495	char *endp; \
	496	__typeof__(type) num = which_strtol(val, &endp, 0); \
	497	if (endp == val \|\| *endp \|\| num < (min) \|\| num > (max)) \
	498	return -EINVAL; \
de5b8e8e	499	((type ) kp->arg) = num; \
1da177e4 LT	500	return 0; \
	501	}
	502
	503	static inline int is_callback(u32 proc)
	504	{
	505	return proc == NLMPROC_GRANTED
	506	\|\| proc == NLMPROC_GRANTED_MSG
	507	\|\| proc == NLMPROC_TEST_RES
	508	\|\| proc == NLMPROC_LOCK_RES
	509	\|\| proc == NLMPROC_CANCEL_RES
	510	\|\| proc == NLMPROC_UNLOCK_RES
	511	\|\| proc == NLMPROC_NSM_NOTIFY;
	512	}
	513
	514
	515	static int lockd_authenticate(struct svc_rqst *rqstp)
	516	{
	517	rqstp->rq_client = NULL;
	518	switch (rqstp->rq_authop->flavour) {
	519	case RPC_AUTH_NULL:
	520	case RPC_AUTH_UNIX:
	521	if (rqstp->rq_proc == 0)
	522	return SVC_OK;
	523	if (is_callback(rqstp->rq_proc)) {
	524	/* Leave it to individual procedures to
	525	* call nlmsvc_lookup_host(rqstp)
	526	*/
	527	return SVC_OK;
	528	}
	529	return svc_set_client(rqstp);
	530	}
	531	return SVC_DENIED;
	532	}
	533
	534
	535	param_set_min_max(port, int, simple_strtol, 0, 65535)
	536	param_set_min_max(grace_period, unsigned long, simple_strtoul,
	537	nlm_grace_period_min, nlm_grace_period_max)
	538	param_set_min_max(timeout, unsigned long, simple_strtoul,
	539	nlm_timeout_min, nlm_timeout_max)
	540
	541	MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
	542	MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION ".");
	543	MODULE_LICENSE("GPL");
	544
	545	module_param_call(nlm_grace_period, param_set_grace_period, param_get_ulong,
	546	&nlm_grace_period, 0644);
	547	module_param_call(nlm_timeout, param_set_timeout, param_get_ulong,
	548	&nlm_timeout, 0644);
	549	module_param_call(nlm_udpport, param_set_port, param_get_int,
	550	&nlm_udpport, 0644);
	551	module_param_call(nlm_tcpport, param_set_port, param_get_int,
	552	&nlm_tcpport, 0644);
abd1f500	553	module_param(nsm_use_hostnames, bool, 0644);
c72a476b	554	module_param(nlm_max_connections, uint, 0644);
1da177e4	555
a9c5d73a SK	556	static int lockd_init_net(struct net *net)
	557	{
	558	return 0;
	559	}
	560
	561	static void lockd_exit_net(struct net *net)
	562	{
	563	}
	564
	565	static struct pernet_operations lockd_net_ops = {
	566	.init = lockd_init_net,
	567	.exit = lockd_exit_net,
	568	.id = &lockd_net_id,
	569	.size = sizeof(struct lockd_net),
	570	};
	571
	572
1da177e4 LT	573	/*
	574	* Initialising and terminating the module.
	575	*/
	576
	577	static int __init init_nlm(void)
	578	{
a9c5d73a SK	579	int err;
a9c5d73a SK	580
90d5b180	581	#ifdef CONFIG_SYSCTL
a9c5d73a	582	err = -ENOMEM;
0b4d4147	583	nlm_sysctl_table = register_sysctl_table(nlm_sysctl_root);
a9c5d73a SK	584	if (nlm_sysctl_table == NULL)
	585	goto err_sysctl;
	586	#endif
	587	err = register_pernet_subsys(&lockd_net_ops);
	588	if (err)
	589	goto err_pernet;
90d5b180	590	return 0;
a9c5d73a SK	591
	592	err_pernet:
	593	#ifdef CONFIG_SYSCTL
	594	unregister_sysctl_table(nlm_sysctl_table);
90d5b180	595	#endif
a9c5d73a SK	596	err_sysctl:
a9c5d73a SK	597	return err;
1da177e4 LT	598	}
	599
	600	static void __exit exit_nlm(void)
	601	{
	602	/* FIXME: delete all NLM clients */
	603	nlm_shutdown_hosts();
a9c5d73a	604	unregister_pernet_subsys(&lockd_net_ops);
90d5b180	605	#ifdef CONFIG_SYSCTL
1da177e4	606	unregister_sysctl_table(nlm_sysctl_table);
90d5b180	607	#endif
1da177e4 LT	608	}
	609
	610	module_init(init_nlm);
	611	module_exit(exit_nlm);
	612
	613	/*
	614	* Define NLM program and procedures
	615	*/
	616	static struct svc_version nlmsvc_version1 = {
	617	.vs_vers = 1,
	618	.vs_nproc = 17,
	619	.vs_proc = nlmsvc_procedures,
	620	.vs_xdrsize = NLMSVC_XDRSIZE,
	621	};
	622	static struct svc_version nlmsvc_version3 = {
	623	.vs_vers = 3,
	624	.vs_nproc = 24,
	625	.vs_proc = nlmsvc_procedures,
	626	.vs_xdrsize = NLMSVC_XDRSIZE,
	627	};
	628	#ifdef CONFIG_LOCKD_V4
	629	static struct svc_version nlmsvc_version4 = {
	630	.vs_vers = 4,
	631	.vs_nproc = 24,
	632	.vs_proc = nlmsvc_procedures4,
	633	.vs_xdrsize = NLMSVC_XDRSIZE,
	634	};
	635	#endif
	636	static struct svc_version * nlmsvc_version[] = {
	637	[1] = &nlmsvc_version1,
	638	[3] = &nlmsvc_version3,
	639	#ifdef CONFIG_LOCKD_V4
	640	[4] = &nlmsvc_version4,
	641	#endif
	642	};
	643
	644	static struct svc_stat nlmsvc_stats;
	645
e8c96f8c	646	#define NLM_NRVERS ARRAY_SIZE(nlmsvc_version)
1da177e4 LT	647	static struct svc_program nlmsvc_program = {
	648	.pg_prog = NLM_PROGRAM, /* program number */
	649	.pg_nvers = NLM_NRVERS, /* number of entries in nlmsvc_version */
	650	.pg_vers = nlmsvc_version, /* version table */
	651	.pg_name = "lockd", /* service name */
	652	.pg_class = "nfsd", /* share authentication with nfsd */
	653	.pg_stats = &nlmsvc_stats, /* stats table */
	654	.pg_authenticate = &lockd_authenticate /* export authentication */
	655	};