[deliverable/linux.git] / fs / lockd / svc.c

/*
 * linux/fs/lockd/svc.c
 *
 * This is the central lockd service.
 *
 * FIXME: Separate the lockd NFS server functionality from the lockd NFS
 * 	  client functionality. Oh why didn't Sun create two separate
 *	  services in the first place?
 *
 * Authors:	Olaf Kirch (okir@monad.swb.de)
 *
 * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
 */

#include <linux/module.h>
#include <linux/init.h>
#include <linux/sysctl.h>
#include <linux/moduleparam.h>

#include <linux/sched.h>
#include <linux/errno.h>
#include <linux/in.h>
#include <linux/uio.h>
#include <linux/slab.h>
#include <linux/smp.h>
#include <linux/smp_lock.h>
#include <linux/mutex.h>
#include <linux/freezer.h>

#include <linux/sunrpc/types.h>
#include <linux/sunrpc/stats.h>
#include <linux/sunrpc/clnt.h>
#include <linux/sunrpc/svc.h>
#include <linux/sunrpc/svcsock.h>
#include <net/ip.h>
#include <linux/lockd/lockd.h>
#include <linux/lockd/sm_inter.h>
#include <linux/nfs.h>

#define NLMDBG_FACILITY		NLMDBG_SVC
#define LOCKD_BUFSIZE		(1024 + NLMSVC_XDRSIZE)
#define ALLOWED_SIGS		(sigmask(SIGKILL))

static struct svc_program	nlmsvc_program;

struct nlmsvc_binding *		nlmsvc_ops;
EXPORT_SYMBOL(nlmsvc_ops);

static DEFINE_MUTEX(nlmsvc_mutex);
static unsigned int		nlmsvc_users;
static pid_t			nlmsvc_pid;
static struct svc_serv		*nlmsvc_serv;
int				nlmsvc_grace_period;
unsigned long			nlmsvc_timeout;

static DECLARE_COMPLETION(lockd_start_done);
static DECLARE_WAIT_QUEUE_HEAD(lockd_exit);

/*
 * These can be set at insmod time (useful for NFS as root filesystem),
 * and also changed through the sysctl interface.  -- Jamie Lokier, Aug 2003
 */
static unsigned long		nlm_grace_period;
static unsigned long		nlm_timeout = LOCKD_DFLT_TIMEO;
static int			nlm_udpport, nlm_tcpport;
int				nsm_use_hostnames = 0;

/*
 * Constants needed for the sysctl interface.
 */
static const unsigned long	nlm_grace_period_min = 0;
static const unsigned long	nlm_grace_period_max = 240;
static const unsigned long	nlm_timeout_min = 3;
static const unsigned long	nlm_timeout_max = 20;
static const int		nlm_port_min = 0, nlm_port_max = 65535;

static struct ctl_table_header * nlm_sysctl_table;

static unsigned long get_lockd_grace_period(void)
{
	/* Note: nlm_timeout should always be nonzero */
	if (nlm_grace_period)
		return roundup(nlm_grace_period, nlm_timeout) * HZ;
	else
		return nlm_timeout * 5 * HZ;
}

unsigned long get_nfs_grace_period(void)
{
	unsigned long lockdgrace = get_lockd_grace_period();
	unsigned long nfsdgrace = 0;

	if (nlmsvc_ops)
		nfsdgrace = nlmsvc_ops->get_grace_period();

	return max(lockdgrace, nfsdgrace);
}
EXPORT_SYMBOL(get_nfs_grace_period);

static unsigned long set_grace_period(void)
{
	nlmsvc_grace_period = 1;
	return get_nfs_grace_period() + jiffies;
}

static inline void clear_grace_period(void)
{
	nlmsvc_grace_period = 0;
}

/*
 * This is the lockd kernel thread
 */
static void
lockd(struct svc_rqst *rqstp)
{
	int		err = 0;
	unsigned long grace_period_expire;

	/* Lock module and set up kernel thread */
	/* lockd_up is waiting for us to startup, so will
	 * be holding a reference to this module, so it
	 * is safe to just claim another reference
	 */
	__module_get(THIS_MODULE);
	lock_kernel();

	/*
	 * Let our maker know we're running.
	 */
	nlmsvc_pid = current->pid;
	nlmsvc_serv = rqstp->rq_server;
	complete(&lockd_start_done);

	daemonize("lockd");
	set_freezable();

	/* Process request with signals blocked, but allow SIGKILL.  */
	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;

	grace_period_expire = set_grace_period();

	/*
	 * The main request loop. We don't terminate until the last
	 * NFS mount or NFS daemon has gone away, and we've been sent a
	 * signal, or else another process has taken over our job.
	 */
	while ((nlmsvc_users || !signalled()) && nlmsvc_pid == current->pid) {
		long timeout = MAX_SCHEDULE_TIMEOUT;
		char buf[RPC_MAX_ADDRBUFLEN];

		if (signalled()) {
			flush_signals(current);
			if (nlmsvc_ops) {
				nlmsvc_invalidate_all();
				grace_period_expire = set_grace_period();
			}
		}

		/*
		 * Retry any blocked locks that have been notified by
		 * the VFS. Don't do this during grace period.
		 * (Theoretically, there shouldn't even be blocked locks
		 * during grace period).
		 */
		if (!nlmsvc_grace_period) {
			timeout = nlmsvc_retry_blocked();
		} else if (time_before(grace_period_expire, jiffies))
			clear_grace_period();

		/*
		 * Find a socket with data available and call its
		 * recvfrom routine.
		 */
		err = svc_recv(rqstp, timeout);
		if (err == -EAGAIN || err == -EINTR)
			continue;
		if (err < 0) {
			printk(KERN_WARNING
			       "lockd: terminating on error %d\n",
			       -err);
			break;
		}

		dprintk("lockd: request from %s\n",
				svc_print_addr(rqstp, buf, sizeof(buf)));

		svc_process(rqstp);
	}

	flush_signals(current);

	/*
	 * Check whether there's a new lockd process before
	 * shutting down the hosts and clearing the slot.
	 */
	if (!nlmsvc_pid || current->pid == nlmsvc_pid) {
		if (nlmsvc_ops)
			nlmsvc_invalidate_all();
		nlm_shutdown_hosts();
		nlmsvc_pid = 0;
		nlmsvc_serv = NULL;
	} else
		printk(KERN_DEBUG
			"lockd: new process, skipping host shutdown\n");
	wake_up(&lockd_exit);

	/* Exit the RPC thread */
	svc_exit_thread(rqstp);

	/* Release module */
	unlock_kernel();
	module_put_and_exit(0);
}

/*
 * Make any sockets that are needed but not present.
 * If nlm_udpport or nlm_tcpport were set as module
 * options, make those sockets unconditionally
 */
static int make_socks(struct svc_serv *serv, int proto)
{
	static int warned;
	int err = 0;

	if (proto == IPPROTO_UDP || nlm_udpport)
		if (!svc_find_xprt(serv, "udp", 0, 0))
			err = svc_create_xprt(serv, "udp", nlm_udpport,
					      SVC_SOCK_DEFAULTS);
	if (err >= 0 && (proto == IPPROTO_TCP || nlm_tcpport))
		if (!svc_find_xprt(serv, "tcp", 0, 0))
			err = svc_create_xprt(serv, "tcp", nlm_tcpport,
					      SVC_SOCK_DEFAULTS);

	if (err >= 0) {
		warned = 0;
		err = 0;
	} else if (warned++ == 0)
		printk(KERN_WARNING
		       "lockd_up: makesock failed, error=%d\n", err);
	return err;
}

/*
 * Bring up the lockd process if it's not already up.
 */
int
lockd_up(int proto) /* Maybe add a 'family' option when IPv6 is supported ?? */
{
	struct svc_serv *	serv;
	int			error = 0;

	mutex_lock(&nlmsvc_mutex);
	/*
	 * Check whether we're already up and running.
	 */
	if (nlmsvc_pid) {
		if (proto)
			error = make_socks(nlmsvc_serv, proto);
		goto out;
	}

	/*
	 * Sanity check: if there's no pid,
	 * we should be the first user ...
	 */
	if (nlmsvc_users)
		printk(KERN_WARNING
			"lockd_up: no pid, %d users??\n", nlmsvc_users);

	error = -ENOMEM;
	serv = svc_create(&nlmsvc_program, LOCKD_BUFSIZE, NULL);
	if (!serv) {
		printk(KERN_WARNING "lockd_up: create service failed\n");
		goto out;
	}

	if ((error = make_socks(serv, proto)) < 0)
		goto destroy_and_out;

	/*
	 * Create the kernel thread and wait for it to start.
	 */
	error = svc_create_thread(lockd, serv);
	if (error) {
		printk(KERN_WARNING
			"lockd_up: create thread failed, error=%d\n", error);
		goto destroy_and_out;
	}
	wait_for_completion(&lockd_start_done);

	/*
	 * Note: svc_serv structures have an initial use count of 1,
	 * so we exit through here on both success and failure.
	 */
destroy_and_out:
	svc_destroy(serv);
out:
	if (!error)
		nlmsvc_users++;
	mutex_unlock(&nlmsvc_mutex);
	return error;
}
EXPORT_SYMBOL(lockd_up);

/*
 * Decrement the user count and bring down lockd if we're the last.
 */
void
lockd_down(void)
{
	static int warned;

	mutex_lock(&nlmsvc_mutex);
	if (nlmsvc_users) {
		if (--nlmsvc_users)
			goto out;
	} else
		printk(KERN_WARNING "lockd_down: no users! pid=%d\n", nlmsvc_pid);

	if (!nlmsvc_pid) {
		if (warned++ == 0)
			printk(KERN_WARNING "lockd_down: no lockd running.\n"); 
		goto out;
	}
	warned = 0;

	kill_proc(nlmsvc_pid, SIGKILL, 1);
	/*
	 * Wait for the lockd process to exit, but since we're holding
	 * the lockd semaphore, we can't wait around forever ...
	 */
	clear_thread_flag(TIF_SIGPENDING);
	interruptible_sleep_on_timeout(&lockd_exit, HZ);
	if (nlmsvc_pid) {
		printk(KERN_WARNING 
			"lockd_down: lockd failed to exit, clearing pid\n");
		nlmsvc_pid = 0;
	}
	spin_lock_irq(&current->sighand->siglock);
	recalc_sigpending();
	spin_unlock_irq(&current->sighand->siglock);
out:
	mutex_unlock(&nlmsvc_mutex);
}
EXPORT_SYMBOL(lockd_down);

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

/*
 * Module (and sysfs) parameters.
 */

#define param_set_min_max(name, type, which_strtol, min, max)		\
static int param_set_##name(const char *val, struct kernel_param *kp)	\
{									\
	char *endp;							\
	__typeof__(type) num = which_strtol(val, &endp, 0);		\
	if (endp == val || *endp || num < (min) || num > (max))		\
		return -EINVAL;						\
	*((int *) kp->arg) = num;					\
	return 0;							\
}

static inline int is_callback(u32 proc)
{
	return proc == NLMPROC_GRANTED
		|| proc == NLMPROC_GRANTED_MSG
		|| proc == NLMPROC_TEST_RES
		|| proc == NLMPROC_LOCK_RES
		|| proc == NLMPROC_CANCEL_RES
		|| proc == NLMPROC_UNLOCK_RES
		|| proc == NLMPROC_NSM_NOTIFY;
}


static int lockd_authenticate(struct svc_rqst *rqstp)
{
	rqstp->rq_client = NULL;
	switch (rqstp->rq_authop->flavour) {
		case RPC_AUTH_NULL:
		case RPC_AUTH_UNIX:
			if (rqstp->rq_proc == 0)
				return SVC_OK;
			if (is_callback(rqstp->rq_proc)) {
				/* Leave it to individual procedures to
				 * call nlmsvc_lookup_host(rqstp)
				 */
				return SVC_OK;
			}
			return svc_set_client(rqstp);
	}
	return SVC_DENIED;
}


param_set_min_max(port, int, simple_strtol, 0, 65535)
param_set_min_max(grace_period, unsigned long, simple_strtoul,
		  nlm_grace_period_min, nlm_grace_period_max)
param_set_min_max(timeout, unsigned long, simple_strtoul,
		  nlm_timeout_min, nlm_timeout_max)

MODULE_AUTHOR("Olaf Kirch <okir@monad.swb.de>");
MODULE_DESCRIPTION("NFS file locking service version " LOCKD_VERSION ".");
MODULE_LICENSE("GPL");

module_param_call(nlm_grace_period, param_set_grace_period, param_get_ulong,
		  &nlm_grace_period, 0644);
module_param_call(nlm_timeout, param_set_timeout, param_get_ulong,
		  &nlm_timeout, 0644);
module_param_call(nlm_udpport, param_set_port, param_get_int,
		  &nlm_udpport, 0644);
module_param_call(nlm_tcpport, param_set_port, param_get_int,
		  &nlm_tcpport, 0644);
module_param(nsm_use_hostnames, bool, 0644);

/*
 * Initialising and terminating the module.
 */

static int __init init_nlm(void)
{
	nlm_sysctl_table = register_sysctl_table(nlm_sysctl_root);
	return nlm_sysctl_table ? 0 : -ENOMEM;
}

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

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