[mirror_ubuntu-artful-kernel.git] / fs / lockd / clnt4xdr.c

/*
 * linux/fs/lockd/clnt4xdr.c
 *
 * XDR functions to encode/decode NLM version 4 RPC arguments and results.
 *
 * NLM client-side only.
 *
 * Copyright (C) 2010, Oracle.  All rights reserved.
 */

#include <linux/types.h>
#include <linux/sunrpc/xdr.h>
#include <linux/sunrpc/clnt.h>
#include <linux/sunrpc/stats.h>
#include <linux/lockd/lockd.h>

#include <uapi/linux/nfs3.h>

#define NLMDBG_FACILITY		NLMDBG_XDR

#if (NLMCLNT_OHSIZE > XDR_MAX_NETOBJ)
#  error "NLM host name cannot be larger than XDR_MAX_NETOBJ!"
#endif

#if (NLMCLNT_OHSIZE > NLM_MAXSTRLEN)
#  error "NLM host name cannot be larger than NLM's maximum string length!"
#endif

/*
 * Declare the space requirements for NLM arguments and replies as
 * number of 32bit-words
 */
#define NLM4_void_sz		(0)
#define NLM4_cookie_sz		(1+(NLM_MAXCOOKIELEN>>2))
#define NLM4_caller_sz		(1+(NLMCLNT_OHSIZE>>2))
#define NLM4_owner_sz		(1+(NLMCLNT_OHSIZE>>2))
#define NLM4_fhandle_sz		(1+(NFS3_FHSIZE>>2))
#define NLM4_lock_sz		(5+NLM4_caller_sz+NLM4_owner_sz+NLM4_fhandle_sz)
#define NLM4_holder_sz		(6+NLM4_owner_sz)

#define NLM4_testargs_sz	(NLM4_cookie_sz+1+NLM4_lock_sz)
#define NLM4_lockargs_sz	(NLM4_cookie_sz+4+NLM4_lock_sz)
#define NLM4_cancargs_sz	(NLM4_cookie_sz+2+NLM4_lock_sz)
#define NLM4_unlockargs_sz	(NLM4_cookie_sz+NLM4_lock_sz)

#define NLM4_testres_sz		(NLM4_cookie_sz+1+NLM4_holder_sz)
#define NLM4_res_sz		(NLM4_cookie_sz+1)
#define NLM4_norep_sz		(0)


static s64 loff_t_to_s64(loff_t offset)
{
	s64 res;

	if (offset >= NLM4_OFFSET_MAX)
		res = NLM4_OFFSET_MAX;
	else if (offset <= -NLM4_OFFSET_MAX)
		res = -NLM4_OFFSET_MAX;
	else
		res = offset;
	return res;
}

static void nlm4_compute_offsets(const struct nlm_lock *lock,
				 u64 *l_offset, u64 *l_len)
{
	const struct file_lock *fl = &lock->fl;

	*l_offset = loff_t_to_s64(fl->fl_start);
	if (fl->fl_end == OFFSET_MAX)
		*l_len = 0;
	else
		*l_len = loff_t_to_s64(fl->fl_end - fl->fl_start + 1);
}

/*
 * Handle decode buffer overflows out-of-line.
 */
static void print_overflow_msg(const char *func, const struct xdr_stream *xdr)
{
	dprintk("lockd: %s prematurely hit the end of our receive buffer. "
		"Remaining buffer length is %tu words.\n",
		func, xdr->end - xdr->p);
}


/*
 * Encode/decode NLMv4 basic data types
 *
 * Basic NLMv4 data types are defined in Appendix II, section 6.1.4
 * of RFC 1813: "NFS Version 3 Protocol Specification" and in Chapter
 * 10 of X/Open's "Protocols for Interworking: XNFS, Version 3W".
 *
 * Not all basic data types have their own encoding and decoding
 * functions.  For run-time efficiency, some data types are encoded
 * or decoded inline.
 */

static void encode_bool(struct xdr_stream *xdr, const int value)
{
	__be32 *p;

	p = xdr_reserve_space(xdr, 4);
	*p = value ? xdr_one : xdr_zero;
}

static void encode_int32(struct xdr_stream *xdr, const s32 value)
{
	__be32 *p;

	p = xdr_reserve_space(xdr, 4);
	*p = cpu_to_be32(value);
}

/*
 *	typedef opaque netobj<MAXNETOBJ_SZ>
 */
static void encode_netobj(struct xdr_stream *xdr,
			  const u8 *data, const unsigned int length)
{
	__be32 *p;

	p = xdr_reserve_space(xdr, 4 + length);
	xdr_encode_opaque(p, data, length);
}

static int decode_netobj(struct xdr_stream *xdr,
			 struct xdr_netobj *obj)
{
	u32 length;
	__be32 *p;

	p = xdr_inline_decode(xdr, 4);
	if (unlikely(p == NULL))
		goto out_overflow;
	length = be32_to_cpup(p++);
	if (unlikely(length > XDR_MAX_NETOBJ))
		goto out_size;
	obj->len = length;
	obj->data = (u8 *)p;
	return 0;
out_size:
	dprintk("NFS: returned netobj was too long: %u\n", length);
	return -EIO;
out_overflow:
	print_overflow_msg(__func__, xdr);
	return -EIO;
}

/*
 *	netobj cookie;
 */
static void encode_cookie(struct xdr_stream *xdr,
			  const struct nlm_cookie *cookie)
{
	encode_netobj(xdr, (u8 *)&cookie->data, cookie->len);
}

static int decode_cookie(struct xdr_stream *xdr,
			     struct nlm_cookie *cookie)
{
	u32 length;
	__be32 *p;

	p = xdr_inline_decode(xdr, 4);
	if (unlikely(p == NULL))
		goto out_overflow;
	length = be32_to_cpup(p++);
	/* apparently HPUX can return empty cookies */
	if (length == 0)
		goto out_hpux;
	if (length > NLM_MAXCOOKIELEN)
		goto out_size;
	p = xdr_inline_decode(xdr, length);
	if (unlikely(p == NULL))
		goto out_overflow;
	cookie->len = length;
	memcpy(cookie->data, p, length);
	return 0;
out_hpux:
	cookie->len = 4;
	memset(cookie->data, 0, 4);
	return 0;
out_size:
	dprintk("NFS: returned cookie was too long: %u\n", length);
	return -EIO;
out_overflow:
	print_overflow_msg(__func__, xdr);
	return -EIO;
}

/*
 *	netobj fh;
 */
static void encode_fh(struct xdr_stream *xdr, const struct nfs_fh *fh)
{
	encode_netobj(xdr, (u8 *)&fh->data, fh->size);
}

/*
 *	enum nlm4_stats {
 *		NLM4_GRANTED = 0,
 *		NLM4_DENIED = 1,
 *		NLM4_DENIED_NOLOCKS = 2,
 *		NLM4_BLOCKED = 3,
 *		NLM4_DENIED_GRACE_PERIOD = 4,
 *		NLM4_DEADLCK = 5,
 *		NLM4_ROFS = 6,
 *		NLM4_STALE_FH = 7,
 *		NLM4_FBIG = 8,
 *		NLM4_FAILED = 9
 *	};
 *
 *	struct nlm4_stat {
 *		nlm4_stats stat;
 *	};
 *
 * NB: we don't swap bytes for the NLM status values.  The upper
 * layers deal directly with the status value in network byte
 * order.
 */
static void encode_nlm4_stat(struct xdr_stream *xdr,
			     const __be32 stat)
{
	__be32 *p;

	BUG_ON(be32_to_cpu(stat) > NLM_FAILED);
	p = xdr_reserve_space(xdr, 4);
	*p = stat;
}

static int decode_nlm4_stat(struct xdr_stream *xdr, __be32 *stat)
{
	__be32 *p;

	p = xdr_inline_decode(xdr, 4);
	if (unlikely(p == NULL))
		goto out_overflow;
	if (unlikely(ntohl(*p) > ntohl(nlm4_failed)))
		goto out_bad_xdr;
	*stat = *p;
	return 0;
out_bad_xdr:
	dprintk("%s: server returned invalid nlm4_stats value: %u\n",
			__func__, be32_to_cpup(p));
	return -EIO;
out_overflow:
	print_overflow_msg(__func__, xdr);
	return -EIO;
}

/*
 *	struct nlm4_holder {
 *		bool	exclusive;
 *		int32	svid;
 *		netobj	oh;
 *		uint64	l_offset;
 *		uint64	l_len;
 *	};
 */
static void encode_nlm4_holder(struct xdr_stream *xdr,
			       const struct nlm_res *result)
{
	const struct nlm_lock *lock = &result->lock;
	u64 l_offset, l_len;
	__be32 *p;

	encode_bool(xdr, lock->fl.fl_type == F_RDLCK);
	encode_int32(xdr, lock->svid);
	encode_netobj(xdr, lock->oh.data, lock->oh.len);

	p = xdr_reserve_space(xdr, 4 + 4);
	nlm4_compute_offsets(lock, &l_offset, &l_len);
	p = xdr_encode_hyper(p, l_offset);
	xdr_encode_hyper(p, l_len);
}

static int decode_nlm4_holder(struct xdr_stream *xdr, struct nlm_res *result)
{
	struct nlm_lock *lock = &result->lock;
	struct file_lock *fl = &lock->fl;
	u64 l_offset, l_len;
	u32 exclusive;
	int error;
	__be32 *p;
	s32 end;

	memset(lock, 0, sizeof(*lock));
	locks_init_lock(fl);

	p = xdr_inline_decode(xdr, 4 + 4);
	if (unlikely(p == NULL))
		goto out_overflow;
	exclusive = be32_to_cpup(p++);
	lock->svid = be32_to_cpup(p);
	fl->fl_pid = (pid_t)lock->svid;

	error = decode_netobj(xdr, &lock->oh);
	if (unlikely(error))
		goto out;

	p = xdr_inline_decode(xdr, 8 + 8);
	if (unlikely(p == NULL))
		goto out_overflow;

	fl->fl_flags = FL_POSIX;
	fl->fl_type  = exclusive != 0 ? F_WRLCK : F_RDLCK;
	p = xdr_decode_hyper(p, &l_offset);
	xdr_decode_hyper(p, &l_len);
	end = l_offset + l_len - 1;

	fl->fl_start = (loff_t)l_offset;
	if (l_len == 0 || end < 0)
		fl->fl_end = OFFSET_MAX;
	else
		fl->fl_end = (loff_t)end;
	error = 0;
out:
	return error;
out_overflow:
	print_overflow_msg(__func__, xdr);
	return -EIO;
}

/*
 *	string caller_name<LM_MAXSTRLEN>;
 */
static void encode_caller_name(struct xdr_stream *xdr, const char *name)
{
	/* NB: client-side does not set lock->len */
	u32 length = strlen(name);
	__be32 *p;

	p = xdr_reserve_space(xdr, 4 + length);
	xdr_encode_opaque(p, name, length);
}

/*
 *	struct nlm4_lock {
 *		string	caller_name<LM_MAXSTRLEN>;
 *		netobj	fh;
 *		netobj	oh;
 *		int32	svid;
 *		uint64	l_offset;
 *		uint64	l_len;
 *	};
 */
static void encode_nlm4_lock(struct xdr_stream *xdr,
			     const struct nlm_lock *lock)
{
	u64 l_offset, l_len;
	__be32 *p;

	encode_caller_name(xdr, lock->caller);
	encode_fh(xdr, &lock->fh);
	encode_netobj(xdr, lock->oh.data, lock->oh.len);

	p = xdr_reserve_space(xdr, 4 + 8 + 8);
	*p++ = cpu_to_be32(lock->svid);

	nlm4_compute_offsets(lock, &l_offset, &l_len);
	p = xdr_encode_hyper(p, l_offset);
	xdr_encode_hyper(p, l_len);
}


/*
 * NLMv4 XDR encode functions
 *
 * NLMv4 argument types are defined in Appendix II of RFC 1813:
 * "NFS Version 3 Protocol Specification" and Chapter 10 of X/Open's
 * "Protocols for Interworking: XNFS, Version 3W".
 */

/*
 *	struct nlm4_testargs {
 *		netobj cookie;
 *		bool exclusive;
 *		struct nlm4_lock alock;
 *	};
 */
static void nlm4_xdr_enc_testargs(struct rpc_rqst *req,
				  struct xdr_stream *xdr,
				  const void *data)
{
	const struct nlm_args *args = data;
	const struct nlm_lock *lock = &args->lock;

	encode_cookie(xdr, &args->cookie);
	encode_bool(xdr, lock->fl.fl_type == F_WRLCK);
	encode_nlm4_lock(xdr, lock);
}

/*
 *	struct nlm4_lockargs {
 *		netobj cookie;
 *		bool block;
 *		bool exclusive;
 *		struct nlm4_lock alock;
 *		bool reclaim;
 *		int state;
 *	};
 */
static void nlm4_xdr_enc_lockargs(struct rpc_rqst *req,
				  struct xdr_stream *xdr,
				  const void *data)
{
	const struct nlm_args *args = data;
	const struct nlm_lock *lock = &args->lock;

	encode_cookie(xdr, &args->cookie);
	encode_bool(xdr, args->block);
	encode_bool(xdr, lock->fl.fl_type == F_WRLCK);
	encode_nlm4_lock(xdr, lock);
	encode_bool(xdr, args->reclaim);
	encode_int32(xdr, args->state);
}

/*
 *	struct nlm4_cancargs {
 *		netobj cookie;
 *		bool block;
 *		bool exclusive;
 *		struct nlm4_lock alock;
 *	};
 */
static void nlm4_xdr_enc_cancargs(struct rpc_rqst *req,
				  struct xdr_stream *xdr,
				  const void *data)
{
	const struct nlm_args *args = data;
	const struct nlm_lock *lock = &args->lock;

	encode_cookie(xdr, &args->cookie);
	encode_bool(xdr, args->block);
	encode_bool(xdr, lock->fl.fl_type == F_WRLCK);
	encode_nlm4_lock(xdr, lock);
}

/*
 *	struct nlm4_unlockargs {
 *		netobj cookie;
 *		struct nlm4_lock alock;
 *	};
 */
static void nlm4_xdr_enc_unlockargs(struct rpc_rqst *req,
				    struct xdr_stream *xdr,
				    const void *data)
{
	const struct nlm_args *args = data;
	const struct nlm_lock *lock = &args->lock;

	encode_cookie(xdr, &args->cookie);
	encode_nlm4_lock(xdr, lock);
}

/*
 *	struct nlm4_res {
 *		netobj cookie;
 *		nlm4_stat stat;
 *	};
 */
static void nlm4_xdr_enc_res(struct rpc_rqst *req,
			     struct xdr_stream *xdr,
			     const void *data)
{
	const struct nlm_res *result = data;

	encode_cookie(xdr, &result->cookie);
	encode_nlm4_stat(xdr, result->status);
}

/*
 *	union nlm4_testrply switch (nlm4_stats stat) {
 *	case NLM4_DENIED:
 *		struct nlm4_holder holder;
 *	default:
 *		void;
 *	};
 *
 *	struct nlm4_testres {
 *		netobj cookie;
 *		nlm4_testrply test_stat;
 *	};
 */
static void nlm4_xdr_enc_testres(struct rpc_rqst *req,
				 struct xdr_stream *xdr,
				 const void *data)
{
	const struct nlm_res *result = data;

	encode_cookie(xdr, &result->cookie);
	encode_nlm4_stat(xdr, result->status);
	if (result->status == nlm_lck_denied)
		encode_nlm4_holder(xdr, result);
}


/*
 * NLMv4 XDR decode functions
 *
 * NLMv4 argument types are defined in Appendix II of RFC 1813:
 * "NFS Version 3 Protocol Specification" and Chapter 10 of X/Open's
 * "Protocols for Interworking: XNFS, Version 3W".
 */

/*
 *	union nlm4_testrply switch (nlm4_stats stat) {
 *	case NLM4_DENIED:
 *		struct nlm4_holder holder;
 *	default:
 *		void;
 *	};
 *
 *	struct nlm4_testres {
 *		netobj cookie;
 *		nlm4_testrply test_stat;
 *	};
 */
static int decode_nlm4_testrply(struct xdr_stream *xdr,
				struct nlm_res *result)
{
	int error;

	error = decode_nlm4_stat(xdr, &result->status);
	if (unlikely(error))
		goto out;
	if (result->status == nlm_lck_denied)
		error = decode_nlm4_holder(xdr, result);
out:
	return error;
}

static int nlm4_xdr_dec_testres(struct rpc_rqst *req,
				struct xdr_stream *xdr,
				void *data)
{
	struct nlm_res *result = data;
	int error;

	error = decode_cookie(xdr, &result->cookie);
	if (unlikely(error))
		goto out;
	error = decode_nlm4_testrply(xdr, result);
out:
	return error;
}

/*
 *	struct nlm4_res {
 *		netobj cookie;
 *		nlm4_stat stat;
 *	};
 */
static int nlm4_xdr_dec_res(struct rpc_rqst *req,
			    struct xdr_stream *xdr,
			    void *data)
{
	struct nlm_res *result = data;
	int error;

	error = decode_cookie(xdr, &result->cookie);
	if (unlikely(error))
		goto out;
	error = decode_nlm4_stat(xdr, &result->status);
out:
	return error;
}


/*
 * For NLM, a void procedure really returns nothing
 */
#define nlm4_xdr_dec_norep	NULL

#define PROC(proc, argtype, restype)					\
[NLMPROC_##proc] = {							\
	.p_proc      = NLMPROC_##proc,					\
	.p_encode    = nlm4_xdr_enc_##argtype,				\
	.p_decode    = nlm4_xdr_dec_##restype,				\
	.p_arglen    = NLM4_##argtype##_sz,				\
	.p_replen    = NLM4_##restype##_sz,				\
	.p_statidx   = NLMPROC_##proc,					\
	.p_name      = #proc,						\
	}

static const struct rpc_procinfo nlm4_procedures[] = {
	PROC(TEST,		testargs,	testres),
	PROC(LOCK,		lockargs,	res),
	PROC(CANCEL,		cancargs,	res),
	PROC(UNLOCK,		unlockargs,	res),
	PROC(GRANTED,		testargs,	res),
	PROC(TEST_MSG,		testargs,	norep),
	PROC(LOCK_MSG,		lockargs,	norep),
	PROC(CANCEL_MSG,	cancargs,	norep),
	PROC(UNLOCK_MSG,	unlockargs,	norep),
	PROC(GRANTED_MSG,	testargs,	norep),
	PROC(TEST_RES,		testres,	norep),
	PROC(LOCK_RES,		res,		norep),
	PROC(CANCEL_RES,	res,		norep),
	PROC(UNLOCK_RES,	res,		norep),
	PROC(GRANTED_RES,	res,		norep),
};

static unsigned int nlm_version4_counts[ARRAY_SIZE(nlm4_procedures)];
const struct rpc_version nlm_version4 = {
	.number		= 4,
	.nrprocs	= ARRAY_SIZE(nlm4_procedures),
	.procs		= nlm4_procedures,
	.counts		= nlm_version4_counts,
};
Commit	Line	Data
3460f29a CL	1	/*
	2	* linux/fs/lockd/clnt4xdr.c
	3	*
	4	* XDR functions to encode/decode NLM version 4 RPC arguments and results.
	5	*
	6	* NLM client-side only.
	7	*
	8	* Copyright (C) 2010, Oracle. All rights reserved.
	9	*/
	10
	11	#include <linux/types.h>
	12	#include <linux/sunrpc/xdr.h>
	13	#include <linux/sunrpc/clnt.h>
	14	#include <linux/sunrpc/stats.h>
	15	#include <linux/lockd/lockd.h>
	16
9c69de4c CH	17	#include <uapi/linux/nfs3.h>
9c69de4c CH	18
3460f29a CL	19	#define NLMDBG_FACILITY NLMDBG_XDR
	20
	21	#if (NLMCLNT_OHSIZE > XDR_MAX_NETOBJ)
	22	# error "NLM host name cannot be larger than XDR_MAX_NETOBJ!"
	23	#endif
	24
	25	#if (NLMCLNT_OHSIZE > NLM_MAXSTRLEN)
	26	# error "NLM host name cannot be larger than NLM's maximum string length!"
	27	#endif
	28
	29	/*
	30	* Declare the space requirements for NLM arguments and replies as
	31	* number of 32bit-words
	32	*/
	33	#define NLM4_void_sz (0)
	34	#define NLM4_cookie_sz (1+(NLM_MAXCOOKIELEN>>2))
	35	#define NLM4_caller_sz (1+(NLMCLNT_OHSIZE>>2))
	36	#define NLM4_owner_sz (1+(NLMCLNT_OHSIZE>>2))
	37	#define NLM4_fhandle_sz (1+(NFS3_FHSIZE>>2))
	38	#define NLM4_lock_sz (5+NLM4_caller_sz+NLM4_owner_sz+NLM4_fhandle_sz)
	39	#define NLM4_holder_sz (6+NLM4_owner_sz)
	40
	41	#define NLM4_testargs_sz (NLM4_cookie_sz+1+NLM4_lock_sz)
	42	#define NLM4_lockargs_sz (NLM4_cookie_sz+4+NLM4_lock_sz)
	43	#define NLM4_cancargs_sz (NLM4_cookie_sz+2+NLM4_lock_sz)
	44	#define NLM4_unlockargs_sz (NLM4_cookie_sz+NLM4_lock_sz)
	45
	46	#define NLM4_testres_sz (NLM4_cookie_sz+1+NLM4_holder_sz)
	47	#define NLM4_res_sz (NLM4_cookie_sz+1)
	48	#define NLM4_norep_sz (0)
	49
	50
	51	static s64 loff_t_to_s64(loff_t offset)
	52	{
	53	s64 res;
	54
	55	if (offset >= NLM4_OFFSET_MAX)
	56	res = NLM4_OFFSET_MAX;
	57	else if (offset <= -NLM4_OFFSET_MAX)
	58	res = -NLM4_OFFSET_MAX;
	59	else
	60	res = offset;
	61	return res;
	62	}
	63
	64	static void nlm4_compute_offsets(const struct nlm_lock *lock,
	65	u64 l_offset, u64 l_len)
	66	{
	67	const struct file_lock *fl = &lock->fl;
	68
3460f29a CL	69	*l_offset = loff_t_to_s64(fl->fl_start);
	70	if (fl->fl_end == OFFSET_MAX)
	71	*l_len = 0;
	72	else
	73	*l_len = loff_t_to_s64(fl->fl_end - fl->fl_start + 1);
	74	}
	75
	76	/*
	77	* Handle decode buffer overflows out-of-line.
	78	*/
	79	static void print_overflow_msg(const char func, const struct xdr_stream xdr)
	80	{
	81	dprintk("lockd: %s prematurely hit the end of our receive buffer. "
	82	"Remaining buffer length is %tu words.\n",
	83	func, xdr->end - xdr->p);
	84	}
	85
	86
	87	/*
	88	* Encode/decode NLMv4 basic data types
	89	*
	90	* Basic NLMv4 data types are defined in Appendix II, section 6.1.4
	91	* of RFC 1813: "NFS Version 3 Protocol Specification" and in Chapter
	92	* 10 of X/Open's "Protocols for Interworking: XNFS, Version 3W".
	93	*
	94	* Not all basic data types have their own encoding and decoding
	95	* functions. For run-time efficiency, some data types are encoded
	96	* or decoded inline.
	97	*/
	98
	99	static void encode_bool(struct xdr_stream *xdr, const int value)
	100	{
	101	__be32 *p;
	102
	103	p = xdr_reserve_space(xdr, 4);
	104	*p = value ? xdr_one : xdr_zero;
	105	}
	106
	107	static void encode_int32(struct xdr_stream *xdr, const s32 value)
	108	{
	109	__be32 *p;
	110
	111	p = xdr_reserve_space(xdr, 4);
	112	*p = cpu_to_be32(value);
	113	}
	114
	115	/*
	116	* typedef opaque netobj<MAXNETOBJ_SZ>
	117	*/
	118	static void encode_netobj(struct xdr_stream *xdr,
	119	const u8 *data, const unsigned int length)
	120	{
	121	__be32 *p;
	122
3460f29a CL	123	p = xdr_reserve_space(xdr, 4 + length);
	124	xdr_encode_opaque(p, data, length);
	125	}
	126
	127	static int decode_netobj(struct xdr_stream *xdr,
	128	struct xdr_netobj *obj)
	129	{
	130	u32 length;
	131	__be32 *p;
	132
	133	p = xdr_inline_decode(xdr, 4);
	134	if (unlikely(p == NULL))
	135	goto out_overflow;
	136	length = be32_to_cpup(p++);
	137	if (unlikely(length > XDR_MAX_NETOBJ))
	138	goto out_size;
	139	obj->len = length;
	140	obj->data = (u8 *)p;
	141	return 0;
	142	out_size:
	143	dprintk("NFS: returned netobj was too long: %u\n", length);
	144	return -EIO;
	145	out_overflow:
	146	print_overflow_msg(__func__, xdr);
	147	return -EIO;
	148	}
	149
	150	/*
	151	* netobj cookie;
	152	*/
	153	static void encode_cookie(struct xdr_stream *xdr,
	154	const struct nlm_cookie *cookie)
	155	{
3460f29a CL	156	encode_netobj(xdr, (u8 *)&cookie->data, cookie->len);
	157	}
	158
	159	static int decode_cookie(struct xdr_stream *xdr,
	160	struct nlm_cookie *cookie)
	161	{
	162	u32 length;
	163	__be32 *p;
	164
	165	p = xdr_inline_decode(xdr, 4);
	166	if (unlikely(p == NULL))
	167	goto out_overflow;
	168	length = be32_to_cpup(p++);
	169	/* apparently HPUX can return empty cookies */
	170	if (length == 0)
	171	goto out_hpux;
	172	if (length > NLM_MAXCOOKIELEN)
	173	goto out_size;
	174	p = xdr_inline_decode(xdr, length);
	175	if (unlikely(p == NULL))
	176	goto out_overflow;
	177	cookie->len = length;
	178	memcpy(cookie->data, p, length);
	179	return 0;
	180	out_hpux:
	181	cookie->len = 4;
	182	memset(cookie->data, 0, 4);
	183	return 0;
	184	out_size:
	185	dprintk("NFS: returned cookie was too long: %u\n", length);
	186	return -EIO;
	187	out_overflow:
	188	print_overflow_msg(__func__, xdr);
	189	return -EIO;
	190	}
	191
	192	/*
	193	* netobj fh;
	194	*/
	195	static void encode_fh(struct xdr_stream xdr, const struct nfs_fh fh)
	196	{
3460f29a CL	197	encode_netobj(xdr, (u8 *)&fh->data, fh->size);
	198	}
	199
	200	/*
	201	* enum nlm4_stats {
	202	* NLM4_GRANTED = 0,
	203	* NLM4_DENIED = 1,
	204	* NLM4_DENIED_NOLOCKS = 2,
	205	* NLM4_BLOCKED = 3,
	206	* NLM4_DENIED_GRACE_PERIOD = 4,
	207	* NLM4_DEADLCK = 5,
	208	* NLM4_ROFS = 6,
	209	* NLM4_STALE_FH = 7,
	210	* NLM4_FBIG = 8,
	211	* NLM4_FAILED = 9
	212	* };
	213	*
	214	* struct nlm4_stat {
	215	* nlm4_stats stat;
	216	* };
	217	*
	218	* NB: we don't swap bytes for the NLM status values. The upper
	219	* layers deal directly with the status value in network byte
	220	* order.
	221	*/
	222	static void encode_nlm4_stat(struct xdr_stream *xdr,
	223	const __be32 stat)
	224	{
	225	__be32 *p;
	226
	227	BUG_ON(be32_to_cpu(stat) > NLM_FAILED);
	228	p = xdr_reserve_space(xdr, 4);
	229	*p = stat;
	230	}
	231
	232	static int decode_nlm4_stat(struct xdr_stream xdr, __be32 stat)
	233	{
	234	__be32 *p;
	235
	236	p = xdr_inline_decode(xdr, 4);
	237	if (unlikely(p == NULL))
	238	goto out_overflow;
e847469b	239	if (unlikely(ntohl(*p) > ntohl(nlm4_failed)))
3460f29a CL	240	goto out_bad_xdr;
	241	stat = p;
	242	return 0;
	243	out_bad_xdr:
	244	dprintk("%s: server returned invalid nlm4_stats value: %u\n",
	245	__func__, be32_to_cpup(p));
	246	return -EIO;
	247	out_overflow:
	248	print_overflow_msg(__func__, xdr);
	249	return -EIO;
	250	}
	251
	252	/*
	253	* struct nlm4_holder {
	254	* bool exclusive;
	255	* int32 svid;
	256	* netobj oh;
	257	* uint64 l_offset;
	258	* uint64 l_len;
	259	* };
	260	*/
	261	static void encode_nlm4_holder(struct xdr_stream *xdr,
	262	const struct nlm_res *result)
	263	{
	264	const struct nlm_lock *lock = &result->lock;
	265	u64 l_offset, l_len;
	266	__be32 *p;
	267
	268	encode_bool(xdr, lock->fl.fl_type == F_RDLCK);
	269	encode_int32(xdr, lock->svid);
	270	encode_netobj(xdr, lock->oh.data, lock->oh.len);
	271
	272	p = xdr_reserve_space(xdr, 4 + 4);
	273	nlm4_compute_offsets(lock, &l_offset, &l_len);
	274	p = xdr_encode_hyper(p, l_offset);
	275	xdr_encode_hyper(p, l_len);
	276	}
	277
	278	static int decode_nlm4_holder(struct xdr_stream xdr, struct nlm_res result)
	279	{
	280	struct nlm_lock *lock = &result->lock;
	281	struct file_lock *fl = &lock->fl;
	282	u64 l_offset, l_len;
	283	u32 exclusive;
	284	int error;
	285	__be32 *p;
	286	s32 end;
	287
	288	memset(lock, 0, sizeof(*lock));
	289	locks_init_lock(fl);
	290
	291	p = xdr_inline_decode(xdr, 4 + 4);
	292	if (unlikely(p == NULL))
	293	goto out_overflow;
	294	exclusive = be32_to_cpup(p++);
	295	lock->svid = be32_to_cpup(p);
	296	fl->fl_pid = (pid_t)lock->svid;
	297
	298	error = decode_netobj(xdr, &lock->oh);
	299	if (unlikely(error))
	300	goto out;
	301
	302	p = xdr_inline_decode(xdr, 8 + 8);
	303	if (unlikely(p == NULL))
304	goto out_overflow;
305
306	fl->fl_flags = FL_POSIX;
307	fl->fl_type = exclusive != 0 ? F_WRLCK : F_RDLCK;
308	p = xdr_decode_hyper(p, &l_offset);
309	xdr_decode_hyper(p, &l_len);
310	end = l_offset + l_len - 1;
311
312	fl->fl_start = (loff_t)l_offset;
313	if (l_len == 0 \|\| end < 0)
314	fl->fl_end = OFFSET_MAX;
315	else
316	fl->fl_end = (loff_t)end;
317	error = 0;
318	out:
319	return error;
320	out_overflow:
321	print_overflow_msg(__func__, xdr);
322	return -EIO;
323	}
324
325	/*
326	* string caller_name<LM_MAXSTRLEN>;
327	*/
328	static void encode_caller_name(struct xdr_stream xdr, const char name)
329	{
330	/* NB: client-side does not set lock->len */
331	u32 length = strlen(name);
332	__be32 *p;
333
3460f29a CL	334	p = xdr_reserve_space(xdr, 4 + length);
	335	xdr_encode_opaque(p, name, length);
	336	}
	337
	338	/*
	339	* struct nlm4_lock {
	340	* string caller_name<LM_MAXSTRLEN>;
	341	* netobj fh;
	342	* netobj oh;
	343	* int32 svid;
	344	* uint64 l_offset;
	345	* uint64 l_len;
	346	* };
	347	*/
	348	static void encode_nlm4_lock(struct xdr_stream *xdr,
	349	const struct nlm_lock *lock)
	350	{
	351	u64 l_offset, l_len;
	352	__be32 *p;
	353
	354	encode_caller_name(xdr, lock->caller);
	355	encode_fh(xdr, &lock->fh);
	356	encode_netobj(xdr, lock->oh.data, lock->oh.len);
	357
	358	p = xdr_reserve_space(xdr, 4 + 8 + 8);
	359	*p++ = cpu_to_be32(lock->svid);
	360
	361	nlm4_compute_offsets(lock, &l_offset, &l_len);
	362	p = xdr_encode_hyper(p, l_offset);
	363	xdr_encode_hyper(p, l_len);
	364	}
	365
	366
	367	/*
	368	* NLMv4 XDR encode functions
	369	*
	370	* NLMv4 argument types are defined in Appendix II of RFC 1813:
	371	* "NFS Version 3 Protocol Specification" and Chapter 10 of X/Open's
	372	* "Protocols for Interworking: XNFS, Version 3W".
	373	*/
	374
	375	/*
	376	* struct nlm4_testargs {
	377	* netobj cookie;
	378	* bool exclusive;
	379	* struct nlm4_lock alock;
	380	* };
	381	*/
9f06c719 CL	382	static void nlm4_xdr_enc_testargs(struct rpc_rqst *req,
9f06c719 CL	383	struct xdr_stream *xdr,
bf96391e	384	const void *data)
3460f29a	385	{
bf96391e	386	const struct nlm_args *args = data;
3460f29a	387	const struct nlm_lock *lock = &args->lock;
3460f29a	388
9f06c719 CL	389	encode_cookie(xdr, &args->cookie);
	390	encode_bool(xdr, lock->fl.fl_type == F_WRLCK);
	391	encode_nlm4_lock(xdr, lock);
3460f29a CL	392	}
	393
	394	/*
	395	* struct nlm4_lockargs {
	396	* netobj cookie;
	397	* bool block;
	398	* bool exclusive;
	399	* struct nlm4_lock alock;
	400	* bool reclaim;
	401	* int state;
	402	* };
	403	*/
9f06c719 CL	404	static void nlm4_xdr_enc_lockargs(struct rpc_rqst *req,
9f06c719 CL	405	struct xdr_stream *xdr,
bf96391e	406	const void *data)
3460f29a	407	{
bf96391e	408	const struct nlm_args *args = data;
3460f29a	409	const struct nlm_lock *lock = &args->lock;
3460f29a	410
9f06c719 CL	411	encode_cookie(xdr, &args->cookie);
	412	encode_bool(xdr, args->block);
	413	encode_bool(xdr, lock->fl.fl_type == F_WRLCK);
	414	encode_nlm4_lock(xdr, lock);
	415	encode_bool(xdr, args->reclaim);
	416	encode_int32(xdr, args->state);
3460f29a CL	417	}
	418
	419	/*
	420	* struct nlm4_cancargs {
	421	* netobj cookie;
	422	* bool block;
	423	* bool exclusive;
	424	* struct nlm4_lock alock;
	425	* };
	426	*/
9f06c719 CL	427	static void nlm4_xdr_enc_cancargs(struct rpc_rqst *req,
9f06c719 CL	428	struct xdr_stream *xdr,
bf96391e	429	const void *data)
3460f29a	430	{
bf96391e	431	const struct nlm_args *args = data;
3460f29a	432	const struct nlm_lock *lock = &args->lock;
3460f29a	433
9f06c719 CL	434	encode_cookie(xdr, &args->cookie);
	435	encode_bool(xdr, args->block);
	436	encode_bool(xdr, lock->fl.fl_type == F_WRLCK);
	437	encode_nlm4_lock(xdr, lock);
3460f29a CL	438	}
	439
	440	/*
	441	* struct nlm4_unlockargs {
	442	* netobj cookie;
	443	* struct nlm4_lock alock;
	444	* };
	445	*/
9f06c719 CL	446	static void nlm4_xdr_enc_unlockargs(struct rpc_rqst *req,
9f06c719 CL	447	struct xdr_stream *xdr,
bf96391e	448	const void *data)
3460f29a	449	{
bf96391e	450	const struct nlm_args *args = data;
3460f29a	451	const struct nlm_lock *lock = &args->lock;
3460f29a	452
9f06c719 CL	453	encode_cookie(xdr, &args->cookie);
9f06c719 CL	454	encode_nlm4_lock(xdr, lock);
3460f29a CL	455	}
	456
	457	/*
	458	* struct nlm4_res {
	459	* netobj cookie;
	460	* nlm4_stat stat;
	461	* };
	462	*/
9f06c719 CL	463	static void nlm4_xdr_enc_res(struct rpc_rqst *req,
9f06c719 CL	464	struct xdr_stream *xdr,
bf96391e	465	const void *data)
3460f29a	466	{
bf96391e CH	467	const struct nlm_res *result = data;
bf96391e CH	468
9f06c719 CL	469	encode_cookie(xdr, &result->cookie);
9f06c719 CL	470	encode_nlm4_stat(xdr, result->status);
3460f29a CL	471	}
	472
	473	/*
	474	* union nlm4_testrply switch (nlm4_stats stat) {
	475	* case NLM4_DENIED:
	476	* struct nlm4_holder holder;
	477	* default:
	478	* void;
	479	* };
	480	*
	481	* struct nlm4_testres {
	482	* netobj cookie;
	483	* nlm4_testrply test_stat;
	484	* };
	485	*/
9f06c719 CL	486	static void nlm4_xdr_enc_testres(struct rpc_rqst *req,
9f06c719 CL	487	struct xdr_stream *xdr,
bf96391e	488	const void *data)
3460f29a	489	{
bf96391e CH	490	const struct nlm_res *result = data;
bf96391e CH	491
9f06c719 CL	492	encode_cookie(xdr, &result->cookie);
9f06c719 CL	493	encode_nlm4_stat(xdr, result->status);
3460f29a	494	if (result->status == nlm_lck_denied)
9f06c719	495	encode_nlm4_holder(xdr, result);
3460f29a CL	496	}
	497
	498
	499	/*
	500	* NLMv4 XDR decode functions
	501	*
	502	* NLMv4 argument types are defined in Appendix II of RFC 1813:
	503	* "NFS Version 3 Protocol Specification" and Chapter 10 of X/Open's
	504	* "Protocols for Interworking: XNFS, Version 3W".
	505	*/
	506
	507	/*
	508	* union nlm4_testrply switch (nlm4_stats stat) {
	509	* case NLM4_DENIED:
	510	* struct nlm4_holder holder;
	511	* default:
	512	* void;
	513	* };
	514	*
	515	* struct nlm4_testres {
	516	* netobj cookie;
	517	* nlm4_testrply test_stat;
	518	* };
	519	*/
	520	static int decode_nlm4_testrply(struct xdr_stream *xdr,
	521	struct nlm_res *result)
	522	{
	523	int error;
	524
	525	error = decode_nlm4_stat(xdr, &result->status);
	526	if (unlikely(error))
	527	goto out;
	528	if (result->status == nlm_lck_denied)
	529	error = decode_nlm4_holder(xdr, result);
	530	out:
	531	return error;
	532	}
	533
bf269551 CL	534	static int nlm4_xdr_dec_testres(struct rpc_rqst *req,
bf269551 CL	535	struct xdr_stream *xdr,
1fa23391	536	void *data)
3460f29a	537	{
1fa23391	538	struct nlm_res *result = data;
3460f29a CL	539	int error;
3460f29a CL	540
bf269551	541	error = decode_cookie(xdr, &result->cookie);
3460f29a CL	542	if (unlikely(error))
3460f29a CL	543	goto out;
bf269551	544	error = decode_nlm4_testrply(xdr, result);
3460f29a CL	545	out:
	546	return error;
	547	}
	548
	549	/*
	550	* struct nlm4_res {
	551	* netobj cookie;
	552	* nlm4_stat stat;
	553	* };
	554	*/
bf269551 CL	555	static int nlm4_xdr_dec_res(struct rpc_rqst *req,
bf269551 CL	556	struct xdr_stream *xdr,
1fa23391	557	void *data)
3460f29a	558	{
1fa23391	559	struct nlm_res *result = data;
3460f29a CL	560	int error;
3460f29a CL	561
bf269551	562	error = decode_cookie(xdr, &result->cookie);
3460f29a CL	563	if (unlikely(error))
3460f29a CL	564	goto out;
bf269551	565	error = decode_nlm4_stat(xdr, &result->status);
3460f29a CL	566	out:
	567	return error;
	568	}
	569
	570
	571	/*
	572	* For NLM, a void procedure really returns nothing
	573	*/
	574	#define nlm4_xdr_dec_norep NULL
	575
	576	#define PROC(proc, argtype, restype) \
	577	[NLMPROC_##proc] = { \
	578	.p_proc = NLMPROC_##proc, \
bf96391e	579	.p_encode = nlm4_xdr_enc_##argtype, \
1fa23391	580	.p_decode = nlm4_xdr_dec_##restype, \
3460f29a CL	581	.p_arglen = NLM4_##argtype##_sz, \
	582	.p_replen = NLM4_##restype##_sz, \
	583	.p_statidx = NLMPROC_##proc, \
	584	.p_name = #proc, \
	585	}
	586
499b4988	587	static const struct rpc_procinfo nlm4_procedures[] = {
3460f29a CL	588	PROC(TEST, testargs, testres),
	589	PROC(LOCK, lockargs, res),
	590	PROC(CANCEL, cancargs, res),
	591	PROC(UNLOCK, unlockargs, res),
	592	PROC(GRANTED, testargs, res),
	593	PROC(TEST_MSG, testargs, norep),
	594	PROC(LOCK_MSG, lockargs, norep),
	595	PROC(CANCEL_MSG, cancargs, norep),
	596	PROC(UNLOCK_MSG, unlockargs, norep),
	597	PROC(GRANTED_MSG, testargs, norep),
	598	PROC(TEST_RES, testres, norep),
	599	PROC(LOCK_RES, res, norep),
	600	PROC(CANCEL_RES, res, norep),
	601	PROC(UNLOCK_RES, res, norep),
	602	PROC(GRANTED_RES, res, norep),
	603	};
	604
1c5876dd	605	static unsigned int nlm_version4_counts[ARRAY_SIZE(nlm4_procedures)];
a613fa16	606	const struct rpc_version nlm_version4 = {
3460f29a CL	607	.number = 4,
	608	.nrprocs = ARRAY_SIZE(nlm4_procedures),
	609	.procs = nlm4_procedures,
1c5876dd	610	.counts = nlm_version4_counts,
3460f29a	611	};