892 lines · 22.6 KB · C
RawDownload
// SPDX-License-Identifier: GPL-2.0-only/* * linux/fs/lockd/clntproc.c * * RPC procedures for the client side NLM implementation * * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de> */ #include <linux/module.h>#include <linux/slab.h>#include <linux/types.h>#include <linux/errno.h>#include <linux/fs.h>#include <linux/filelock.h>#include <linux/nfs_fs.h>#include <linux/utsname.h>#include <linux/freezer.h>#include <linux/sunrpc/clnt.h>#include <linux/sunrpc/svc.h> #include "lockd.h"#include "trace.h" #define NLMDBG_FACILITY		NLMDBG_CLIENT#define NLMCLNT_GRACE_WAIT	(5*HZ)#define NLMCLNT_POLL_TIMEOUT	(30*HZ)#define NLMCLNT_MAX_RETRIES	3 static int	nlmclnt_test(struct nlm_rqst *, struct file_lock *);static int	nlmclnt_lock(struct nlm_rqst *, struct file_lock *);static int	nlmclnt_unlock(struct nlm_rqst *, struct file_lock *);static int	nlm_stat_to_errno(__be32 stat);static void	nlmclnt_locks_init_private(struct file_lock *fl, struct nlm_host *host);static int	nlmclnt_cancel(struct nlm_host *, int , struct file_lock *); static const struct rpc_call_ops nlmclnt_unlock_ops;static const struct rpc_call_ops nlmclnt_cancel_ops; /* * Cookie counter for NLM requests */static atomic_t	nlm_cookie = ATOMIC_INIT(0x1234); void nlmclnt_next_cookie(struct lockd_cookie *c){	u32	cookie = atomic_inc_return(&nlm_cookie); 	memcpy(c->data, &cookie, 4);	c->len=4;} static struct nlm_lockowner *nlmclnt_get_lockowner(struct nlm_lockowner *lockowner){	refcount_inc(&lockowner->count);	return lockowner;} static void nlmclnt_put_lockowner(struct nlm_lockowner *lockowner){	if (!refcount_dec_and_lock(&lockowner->count, &lockowner->host->h_lock))		return;	list_del(&lockowner->list);	spin_unlock(&lockowner->host->h_lock);	nlmclnt_release_host(lockowner->host);	kfree(lockowner);} static inline int nlm_pidbusy(struct nlm_host *host, uint32_t pid){	struct nlm_lockowner *lockowner;	list_for_each_entry(lockowner, &host->h_lockowners, list) {		if (lockowner->pid == pid)			return -EBUSY;	}	return 0;} static inline uint32_t __nlm_alloc_pid(struct nlm_host *host){	uint32_t res;	do {		res = host->h_pidcount++;	} while (nlm_pidbusy(host, res) < 0);	return res;} static struct nlm_lockowner *__nlmclnt_find_lockowner(struct nlm_host *host, fl_owner_t owner){	struct nlm_lockowner *lockowner;	list_for_each_entry(lockowner, &host->h_lockowners, list) {		if (lockowner->owner != owner)			continue;		return nlmclnt_get_lockowner(lockowner);	}	return NULL;} static struct nlm_lockowner *nlmclnt_find_lockowner(struct nlm_host *host, fl_owner_t owner){	struct nlm_lockowner *res, *new = NULL; 	spin_lock(&host->h_lock);	res = __nlmclnt_find_lockowner(host, owner);	if (res == NULL) {		spin_unlock(&host->h_lock);		new = kmalloc_obj(*new);		spin_lock(&host->h_lock);		res = __nlmclnt_find_lockowner(host, owner);		if (res == NULL && new != NULL) {			res = new;			refcount_set(&new->count, 1);			new->owner = owner;			new->pid = __nlm_alloc_pid(host);			new->host = nlm_get_host(host);			list_add(&new->list, &host->h_lockowners);			new = NULL;		}	}	spin_unlock(&host->h_lock);	kfree(new);	return res;} /* * Initialize arguments for TEST/LOCK/UNLOCK/CANCEL calls */static void nlmclnt_setlockargs(struct nlm_rqst *req, struct file_lock *fl){	struct lockd_args *argp = &req->a_args;	struct lockd_lock *lock = &argp->lock;	char *nodename = req->a_host->h_rpcclnt->cl_nodename; 	nlmclnt_next_cookie(&argp->cookie);	memcpy(&lock->fh, NFS_FH(file_inode(fl->c.flc_file)),	       sizeof(struct nfs_fh));	lock->caller  = nodename;	lock->oh.data = req->a_owner;	lock->oh.len  = snprintf(req->a_owner, sizeof(req->a_owner), "%u@%s",				(unsigned int)fl->fl_u.nfs_fl.owner->pid,				nodename);	lock->svid = fl->fl_u.nfs_fl.owner->pid;	lock->fl.fl_start = fl->fl_start;	lock->fl.fl_end = fl->fl_end;	lock->fl.c.flc_type = fl->c.flc_type;} static void nlmclnt_release_lockargs(struct nlm_rqst *req){	WARN_ON_ONCE(req->a_args.lock.fl.fl_ops != NULL);} /** * nlmclnt_proc - Perform a single client-side lock request * @host: address of a valid nlm_host context representing the NLM server * @cmd: fcntl-style file lock operation to perform * @fl: address of arguments for the lock operation * @data: address of data to be sent to callback operations * */int nlmclnt_proc(struct nlm_host *host, int cmd, struct file_lock *fl, void *data){	struct nlm_rqst		*call;	int			status;	const struct nlmclnt_operations *nlmclnt_ops = host->h_nlmclnt_ops; 	call = nlm_alloc_call(host);	if (call == NULL)		return -ENOMEM; 	if (nlmclnt_ops && nlmclnt_ops->nlmclnt_alloc_call)		nlmclnt_ops->nlmclnt_alloc_call(data); 	nlmclnt_locks_init_private(fl, host);	if (!fl->fl_u.nfs_fl.owner) {		/* lockowner allocation has failed */		nlmclnt_release_call(call);		return -ENOMEM;	}	/* Set up the argument struct */	nlmclnt_setlockargs(call, fl);	call->a_callback_data = data; 	if (IS_SETLK(cmd) || IS_SETLKW(cmd)) {		if (fl->c.flc_type != F_UNLCK) {			call->a_args.block = IS_SETLKW(cmd) ? 1 : 0;			status = nlmclnt_lock(call, fl);		} else			status = nlmclnt_unlock(call, fl);	} else if (IS_GETLK(cmd))		status = nlmclnt_test(call, fl);	else		status = -EINVAL;	fl->fl_ops->fl_release_private(fl);	fl->fl_ops = NULL; 	dprintk("lockd: clnt proc returns %d\n", status);	return status;}EXPORT_SYMBOL_GPL(nlmclnt_proc); /* * Allocate an NLM RPC call struct */struct nlm_rqst *nlm_alloc_call(struct nlm_host *host){	struct nlm_rqst	*call; 	for(;;) {		call = kzalloc_obj(*call);		if (call != NULL) {			refcount_set(&call->a_count, 1);			locks_init_lock(&call->a_args.lock.fl);			locks_init_lock(&call->a_res.lock.fl);			call->a_host = nlm_get_host(host);			return call;		}		if (signalled())			break;		printk("nlm_alloc_call: failed, waiting for memory\n");		schedule_timeout_interruptible(5*HZ);	}	return NULL;} void nlmclnt_release_call(struct nlm_rqst *call){	const struct nlmclnt_operations *nlmclnt_ops = call->a_host->h_nlmclnt_ops; 	if (!refcount_dec_and_test(&call->a_count))		return;	if (nlmclnt_ops && nlmclnt_ops->nlmclnt_release_call)		nlmclnt_ops->nlmclnt_release_call(call->a_callback_data);	nlmclnt_release_host(call->a_host);	nlmclnt_release_lockargs(call);	kfree(call);} static void nlmclnt_rpc_release(void *data){	nlmclnt_release_call(data);} static int nlm_wait_on_grace(wait_queue_head_t *queue){	DEFINE_WAIT(wait);	int status = -EINTR; 	prepare_to_wait(queue, &wait, TASK_INTERRUPTIBLE);	if (!signalled ()) {		schedule_timeout(NLMCLNT_GRACE_WAIT);		try_to_freeze();		if (!signalled ())			status = 0;	}	finish_wait(queue, &wait);	return status;} /* * Generic NLM call */static intnlmclnt_call(const struct cred *cred, struct nlm_rqst *req, u32 proc){	struct nlm_host	*host = req->a_host;	struct rpc_clnt	*clnt;	struct lockd_args *argp = &req->a_args;	struct lockd_res *resp = &req->a_res;	struct rpc_message msg = {		.rpc_argp	= argp,		.rpc_resp	= resp,		.rpc_cred	= cred,	};	int		status; 	dprintk("lockd: call procedure %d on %s\n",			(int)proc, host->h_name); 	do {		if (host->h_reclaiming && !argp->reclaim)			goto in_grace_period; 		/* If we have no RPC client yet, create one. */		if ((clnt = nlm_bind_host(host)) == NULL)			return -ENOLCK;		msg.rpc_proc = &clnt->cl_procinfo[proc]; 		/* Perform the RPC call. If an error occurs, try again */		if ((status = rpc_call_sync(clnt, &msg, 0)) < 0) {			dprintk("lockd: rpc_call returned error %d\n", -status);			switch (status) {			case -EPROTONOSUPPORT:				status = -EINVAL;				break;			case -ECONNREFUSED:			case -ETIMEDOUT:			case -ENOTCONN:				nlm_rebind_host(host);				status = -EAGAIN;				break;			case -ERESTARTSYS:				return signalled () ? -EINTR : status;			default:				break;			}			break;		} else		if (resp->status == nlm_lck_denied_grace_period) {			dprintk("lockd: server in grace period\n");			if (argp->reclaim) {				printk(KERN_WARNING				     "lockd: spurious grace period reject?!\n");				return -ENOLCK;			}		} else {			if (!argp->reclaim) {				/* We appear to be out of the grace period */				wake_up_all(&host->h_gracewait);			}			dprintk("lockd: server returns status %d\n",				ntohl(resp->status));			return 0;	/* Okay, call complete */		} in_grace_period:		/*		 * The server has rebooted and appears to be in the grace		 * period during which locks are only allowed to be		 * reclaimed.		 * We can only back off and try again later.		 */		status = nlm_wait_on_grace(&host->h_gracewait);	} while (status == 0); 	return status;} /* * Generic NLM call, async version. */static struct rpc_task *__nlm_async_call(struct nlm_rqst *req, u32 proc, struct rpc_message *msg, const struct rpc_call_ops *tk_ops){	struct nlm_host	*host = req->a_host;	struct rpc_clnt	*clnt;	struct rpc_task_setup task_setup_data = {		.rpc_message = msg,		.callback_ops = tk_ops,		.callback_data = req,		.flags = RPC_TASK_ASYNC,	}; 	dprintk("lockd: call procedure %d on %s (async)\n",			(int)proc, host->h_name); 	/* If we have no RPC client yet, create one. */	clnt = nlm_bind_host(host);	if (clnt == NULL)		goto out_err;	msg->rpc_proc = &clnt->cl_procinfo[proc];	task_setup_data.rpc_client = clnt;         /* bootstrap and kick off the async RPC call */	return rpc_run_task(&task_setup_data);out_err:	tk_ops->rpc_release(req);	return ERR_PTR(-ENOLCK);} static int nlm_do_async_call(struct nlm_rqst *req, u32 proc, struct rpc_message *msg, const struct rpc_call_ops *tk_ops){	struct rpc_task *task; 	task = __nlm_async_call(req, proc, msg, tk_ops);	if (IS_ERR(task))		return PTR_ERR(task);	rpc_put_task(task);	return 0;} /* * NLM asynchronous call. */int nlm_async_call(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops){	struct rpc_message msg = {		.rpc_argp	= &req->a_args,		.rpc_resp	= &req->a_res,	};	return nlm_do_async_call(req, proc, &msg, tk_ops);} int nlm_async_reply(struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops){	struct rpc_message msg = {		.rpc_argp	= &req->a_res,	};	return nlm_do_async_call(req, proc, &msg, tk_ops);} /* * NLM client asynchronous call. * * Note that although the calls are asynchronous, and are therefore *      guaranteed to complete, we still always attempt to wait for *      completion in order to be able to correctly track the lock *      state. */static int nlmclnt_async_call(const struct cred *cred, struct nlm_rqst *req, u32 proc, const struct rpc_call_ops *tk_ops){	struct rpc_message msg = {		.rpc_argp	= &req->a_args,		.rpc_resp	= &req->a_res,		.rpc_cred	= cred,	};	struct rpc_task *task;	int err; 	task = __nlm_async_call(req, proc, &msg, tk_ops);	if (IS_ERR(task))		return PTR_ERR(task);	err = rpc_wait_for_completion_task(task);	rpc_put_task(task);	return err;} /* * TEST for the presence of a conflicting lock */static intnlmclnt_test(struct nlm_rqst *req, struct file_lock *fl){	int	status; 	status = nlmclnt_call(nfs_file_cred(fl->c.flc_file), req,			      NLMPROC_TEST);	if (status < 0)		goto out; 	switch (req->a_res.status) {		case nlm_granted:			fl->c.flc_type = F_UNLCK;			break;		case nlm_lck_denied:			/*			 * Report the conflicting lock back to the application.			 */			fl->fl_start = req->a_res.lock.fl.fl_start;			fl->fl_end = req->a_res.lock.fl.fl_end;			fl->c.flc_type = req->a_res.lock.fl.c.flc_type;			fl->c.flc_pid = -req->a_res.lock.fl.c.flc_pid;			break;		default:			status = nlm_stat_to_errno(req->a_res.status);	}out:	trace_nlmclnt_test(&req->a_args.lock,			   (const struct sockaddr *)&req->a_host->h_addr,			   req->a_host->h_addrlen, req->a_res.status);	nlmclnt_release_call(req);	return status;} static void nlmclnt_locks_copy_lock(struct file_lock *new, struct file_lock *fl){	spin_lock(&fl->fl_u.nfs_fl.owner->host->h_lock);	new->fl_u.nfs_fl.state = fl->fl_u.nfs_fl.state;	new->fl_u.nfs_fl.owner = nlmclnt_get_lockowner(fl->fl_u.nfs_fl.owner);	list_add_tail(&new->fl_u.nfs_fl.list, &fl->fl_u.nfs_fl.owner->host->h_granted);	spin_unlock(&fl->fl_u.nfs_fl.owner->host->h_lock);} static void nlmclnt_locks_release_private(struct file_lock *fl){	spin_lock(&fl->fl_u.nfs_fl.owner->host->h_lock);	list_del(&fl->fl_u.nfs_fl.list);	spin_unlock(&fl->fl_u.nfs_fl.owner->host->h_lock);	nlmclnt_put_lockowner(fl->fl_u.nfs_fl.owner);} static const struct file_lock_operations nlmclnt_lock_ops = {	.fl_copy_lock = nlmclnt_locks_copy_lock,	.fl_release_private = nlmclnt_locks_release_private,}; static void nlmclnt_locks_init_private(struct file_lock *fl, struct nlm_host *host){	fl->fl_u.nfs_fl.state = 0;	fl->fl_ops = NULL;	fl->fl_u.nfs_fl.owner = nlmclnt_find_lockowner(host,						       fl->c.flc_owner);	INIT_LIST_HEAD(&fl->fl_u.nfs_fl.list);	if (!fl->fl_u.nfs_fl.owner)		return;	fl->fl_ops = &nlmclnt_lock_ops;} static int do_vfs_lock(struct file_lock *fl){

Lines 1–500 of 892.