[deliverable/linux.git] / include / linux / sunrpc / xdr.h

/*
 * XDR standard data types and function declarations
 *
 * Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de>
 *
 * Based on:
 *   RFC 4506 "XDR: External Data Representation Standard", May 2006
 */

#ifndef _SUNRPC_XDR_H_
#define _SUNRPC_XDR_H_

#ifdef __KERNEL__

#include <linux/uio.h>
#include <asm/byteorder.h>
#include <asm/unaligned.h>
#include <linux/scatterlist.h>

/*
 * Buffer adjustment
 */
#define XDR_QUADLEN(l)		(((l) + 3) >> 2)

/*
 * Generic opaque `network object.' At the kernel level, this type
 * is used only by lockd.
 */
#define XDR_MAX_NETOBJ		1024
struct xdr_netobj {
	unsigned int		len;
	u8 *			data;
};

/*
 * This is the legacy generic XDR function. rqstp is either a rpc_rqst
 * (client side) or svc_rqst pointer (server side).
 * Encode functions always assume there's enough room in the buffer.
 */
typedef int	(*kxdrproc_t)(void *rqstp, __be32 *data, void *obj);

/*
 * Basic structure for transmission/reception of a client XDR message.
 * Features a header (for a linear buffer containing RPC headers
 * and the data payload for short messages), and then an array of
 * pages.
 * The tail iovec allows you to append data after the page array. Its
 * main interest is for appending padding to the pages in order to
 * satisfy the int_32-alignment requirements in RFC1832.
 *
 * For the future, we might want to string several of these together
 * in a list if anybody wants to make use of NFSv4 COMPOUND
 * operations and/or has a need for scatter/gather involving pages.
 */
struct xdr_buf {
	struct kvec	head[1],	/* RPC header + non-page data */
			tail[1];	/* Appended after page data */

	struct page **	pages;		/* Array of pages */
	unsigned int	page_base,	/* Start of page data */
			page_len,	/* Length of page data */
			flags;		/* Flags for data disposition */
#define XDRBUF_READ		0x01		/* target of file read */
#define XDRBUF_WRITE		0x02		/* source of file write */

	unsigned int	buflen,		/* Total length of storage buffer */
			len;		/* Length of XDR encoded message */
};

/*
 * pre-xdr'ed macros.
 */

#define	xdr_zero	cpu_to_be32(0)
#define	xdr_one		cpu_to_be32(1)
#define	xdr_two		cpu_to_be32(2)

#define	rpc_success		cpu_to_be32(RPC_SUCCESS)
#define	rpc_prog_unavail	cpu_to_be32(RPC_PROG_UNAVAIL)
#define	rpc_prog_mismatch	cpu_to_be32(RPC_PROG_MISMATCH)
#define	rpc_proc_unavail	cpu_to_be32(RPC_PROC_UNAVAIL)
#define	rpc_garbage_args	cpu_to_be32(RPC_GARBAGE_ARGS)
#define	rpc_system_err		cpu_to_be32(RPC_SYSTEM_ERR)
#define	rpc_drop_reply		cpu_to_be32(RPC_DROP_REPLY)

#define	rpc_auth_ok		cpu_to_be32(RPC_AUTH_OK)
#define	rpc_autherr_badcred	cpu_to_be32(RPC_AUTH_BADCRED)
#define	rpc_autherr_rejectedcred cpu_to_be32(RPC_AUTH_REJECTEDCRED)
#define	rpc_autherr_badverf	cpu_to_be32(RPC_AUTH_BADVERF)
#define	rpc_autherr_rejectedverf cpu_to_be32(RPC_AUTH_REJECTEDVERF)
#define	rpc_autherr_tooweak	cpu_to_be32(RPC_AUTH_TOOWEAK)
#define	rpcsec_gsserr_credproblem	cpu_to_be32(RPCSEC_GSS_CREDPROBLEM)
#define	rpcsec_gsserr_ctxproblem	cpu_to_be32(RPCSEC_GSS_CTXPROBLEM)
#define	rpc_autherr_oldseqnum	cpu_to_be32(101)

/*
 * Miscellaneous XDR helper functions
 */
__be32 *xdr_encode_opaque_fixed(__be32 *p, const void *ptr, unsigned int len);
__be32 *xdr_encode_opaque(__be32 *p, const void *ptr, unsigned int len);
__be32 *xdr_encode_string(__be32 *p, const char *s);
__be32 *xdr_decode_string_inplace(__be32 *p, char **sp, unsigned int *lenp,
			unsigned int maxlen);
__be32 *xdr_encode_netobj(__be32 *p, const struct xdr_netobj *);
__be32 *xdr_decode_netobj(__be32 *p, struct xdr_netobj *);

void	xdr_inline_pages(struct xdr_buf *, unsigned int,
			 struct page **, unsigned int, unsigned int);
void	xdr_terminate_string(struct xdr_buf *, const u32);

static inline __be32 *xdr_encode_array(__be32 *p, const void *s, unsigned int len)
{
	return xdr_encode_opaque(p, s, len);
}

/*
 * Decode 64bit quantities (NFSv3 support)
 */
static inline __be32 *
xdr_encode_hyper(__be32 *p, __u64 val)
{
	put_unaligned_be64(val, p);
	return p + 2;
}

static inline __be32 *
xdr_decode_hyper(__be32 *p, __u64 *valp)
{
	*valp = get_unaligned_be64(p);
	return p + 2;
}

static inline __be32 *
xdr_decode_opaque_fixed(__be32 *p, void *ptr, unsigned int len)
{
	memcpy(ptr, p, len);
	return p + XDR_QUADLEN(len);
}

/*
 * Adjust kvec to reflect end of xdr'ed data (RPC client XDR)
 */
static inline int
xdr_adjust_iovec(struct kvec *iov, __be32 *p)
{
	return iov->iov_len = ((u8 *) p - (u8 *) iov->iov_base);
}

/*
 * XDR buffer helper functions
 */
extern void xdr_shift_buf(struct xdr_buf *, size_t);
extern void xdr_buf_from_iov(struct kvec *, struct xdr_buf *);
extern int xdr_buf_subsegment(struct xdr_buf *, struct xdr_buf *, unsigned int, unsigned int);
extern void xdr_buf_trim(struct xdr_buf *, unsigned int);
extern int xdr_buf_read_netobj(struct xdr_buf *, struct xdr_netobj *, unsigned int);
extern int read_bytes_from_xdr_buf(struct xdr_buf *, unsigned int, void *, unsigned int);
extern int write_bytes_to_xdr_buf(struct xdr_buf *, unsigned int, void *, unsigned int);

/*
 * Helper structure for copying from an sk_buff.
 */
struct xdr_skb_reader {
	struct sk_buff	*skb;
	unsigned int	offset;
	size_t		count;
	__wsum		csum;
};

typedef size_t (*xdr_skb_read_actor)(struct xdr_skb_reader *desc, void *to, size_t len);

size_t xdr_skb_read_bits(struct xdr_skb_reader *desc, void *to, size_t len);
extern int csum_partial_copy_to_xdr(struct xdr_buf *, struct sk_buff *);
extern ssize_t xdr_partial_copy_from_skb(struct xdr_buf *, unsigned int,
		struct xdr_skb_reader *, xdr_skb_read_actor);

extern int xdr_encode_word(struct xdr_buf *, unsigned int, u32);
extern int xdr_decode_word(struct xdr_buf *, unsigned int, u32 *);

struct xdr_array2_desc;
typedef int (*xdr_xcode_elem_t)(struct xdr_array2_desc *desc, void *elem);
struct xdr_array2_desc {
	unsigned int elem_size;
	unsigned int array_len;
	unsigned int array_maxlen;
	xdr_xcode_elem_t xcode;
};

extern int xdr_decode_array2(struct xdr_buf *buf, unsigned int base,
			     struct xdr_array2_desc *desc);
extern int xdr_encode_array2(struct xdr_buf *buf, unsigned int base,
			     struct xdr_array2_desc *desc);
extern void _copy_from_pages(char *p, struct page **pages, size_t pgbase,
			     size_t len);

/*
 * Provide some simple tools for XDR buffer overflow-checking etc.
 */
struct xdr_stream {
	__be32 *p;		/* start of available buffer */
	struct xdr_buf *buf;	/* XDR buffer to read/write */

	__be32 *end;		/* end of available buffer space */
	struct kvec *iov;	/* pointer to the current kvec */
	struct kvec scratch;	/* Scratch buffer */
	struct page **page_ptr;	/* pointer to the current page */
	unsigned int nwords;	/* Remaining decode buffer length */
};

/*
 * These are the xdr_stream style generic XDR encode and decode functions.
 */
typedef void	(*kxdreproc_t)(void *rqstp, struct xdr_stream *xdr, void *obj);
typedef int	(*kxdrdproc_t)(void *rqstp, struct xdr_stream *xdr, void *obj);

extern void xdr_init_encode(struct xdr_stream *xdr, struct xdr_buf *buf, __be32 *p);
extern __be32 *xdr_reserve_space(struct xdr_stream *xdr, size_t nbytes);
extern void xdr_commit_encode(struct xdr_stream *xdr);
extern void xdr_truncate_encode(struct xdr_stream *xdr, size_t len);
extern int xdr_restrict_buflen(struct xdr_stream *xdr, int newbuflen);
extern void xdr_write_pages(struct xdr_stream *xdr, struct page **pages,
		unsigned int base, unsigned int len);
extern unsigned int xdr_stream_pos(const struct xdr_stream *xdr);
extern void xdr_init_decode(struct xdr_stream *xdr, struct xdr_buf *buf, __be32 *p);
extern void xdr_init_decode_pages(struct xdr_stream *xdr, struct xdr_buf *buf,
		struct page **pages, unsigned int len);
extern void xdr_set_scratch_buffer(struct xdr_stream *xdr, void *buf, size_t buflen);
extern __be32 *xdr_inline_decode(struct xdr_stream *xdr, size_t nbytes);
extern unsigned int xdr_read_pages(struct xdr_stream *xdr, unsigned int len);
extern void xdr_enter_page(struct xdr_stream *xdr, unsigned int len);
extern int xdr_process_buf(struct xdr_buf *buf, unsigned int offset, unsigned int len, int (*actor)(struct scatterlist *, void *), void *data);

#endif /* __KERNEL__ */

#endif /* _SUNRPC_XDR_H_ */
Commit	Line	Data
1da177e4	1	/*
9605a069	2	* XDR standard data types and function declarations
1da177e4 LT	3	*
1da177e4 LT	4	* Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de>
9605a069 CL	5	*
	6	* Based on:
	7	* RFC 4506 "XDR: External Data Representation Standard", May 2006
1da177e4 LT	8	*/
	9
	10	#ifndef _SUNRPC_XDR_H_
	11	#define _SUNRPC_XDR_H_
	12
	13	#ifdef __KERNEL__
	14
	15	#include <linux/uio.h>
	16	#include <asm/byteorder.h>
97363c6a	17	#include <asm/unaligned.h>
37a4e6cb	18	#include <linux/scatterlist.h>
1da177e4 LT	19
	20	/*
	21	* Buffer adjustment
	22	*/
	23	#define XDR_QUADLEN(l) (((l) + 3) >> 2)
	24
	25	/*
	26	* Generic opaque `network object.' At the kernel level, this type
	27	* is used only by lockd.
	28	*/
	29	#define XDR_MAX_NETOBJ 1024
	30	struct xdr_netobj {
	31	unsigned int len;
	32	u8 * data;
	33	};
	34
	35	/*
9f06c719 CL	36	* This is the legacy generic XDR function. rqstp is either a rpc_rqst
9f06c719 CL	37	* (client side) or svc_rqst pointer (server side).
1da177e4 LT	38	* Encode functions always assume there's enough room in the buffer.
1da177e4 LT	39	*/
d8ed029d	40	typedef int (kxdrproc_t)(void rqstp, __be32 data, void obj);
1da177e4 LT	41
	42	/*
	43	* Basic structure for transmission/reception of a client XDR message.
	44	* Features a header (for a linear buffer containing RPC headers
	45	* and the data payload for short messages), and then an array of
	46	* pages.
	47	* The tail iovec allows you to append data after the page array. Its
	48	* main interest is for appending padding to the pages in order to
	49	* satisfy the int_32-alignment requirements in RFC1832.
	50	*
	51	* For the future, we might want to string several of these together
	52	* in a list if anybody wants to make use of NFSv4 COMPOUND
	53	* operations and/or has a need for scatter/gather involving pages.
	54	*/
	55	struct xdr_buf {
	56	struct kvec head[1], /* RPC header + non-page data */
	57	tail[1]; /* Appended after page data */
	58
de0b65ca	59	struct page ** pages; /* Array of pages */
1da177e4	60	unsigned int page_base, /* Start of page data */
4f22ccc3 TT	61	page_len, /* Length of page data */
	62	flags; /* Flags for data disposition */
	63	#define XDRBUF_READ 0x01 /* target of file read */
	64	#define XDRBUF_WRITE 0x02 /* source of file write */
1da177e4 LT	65
	66	unsigned int buflen, /* Total length of storage buffer */
	67	len; /* Length of XDR encoded message */
1da177e4 LT	68	};
	69
	70	/*
	71	* pre-xdr'ed macros.
	72	*/
	73
77f18f5e HH	74	#define xdr_zero cpu_to_be32(0)
	75	#define xdr_one cpu_to_be32(1)
	76	#define xdr_two cpu_to_be32(2)
	77
	78	#define rpc_success cpu_to_be32(RPC_SUCCESS)
	79	#define rpc_prog_unavail cpu_to_be32(RPC_PROG_UNAVAIL)
	80	#define rpc_prog_mismatch cpu_to_be32(RPC_PROG_MISMATCH)
	81	#define rpc_proc_unavail cpu_to_be32(RPC_PROC_UNAVAIL)
	82	#define rpc_garbage_args cpu_to_be32(RPC_GARBAGE_ARGS)
	83	#define rpc_system_err cpu_to_be32(RPC_SYSTEM_ERR)
	84	#define rpc_drop_reply cpu_to_be32(RPC_DROP_REPLY)
	85
	86	#define rpc_auth_ok cpu_to_be32(RPC_AUTH_OK)
	87	#define rpc_autherr_badcred cpu_to_be32(RPC_AUTH_BADCRED)
	88	#define rpc_autherr_rejectedcred cpu_to_be32(RPC_AUTH_REJECTEDCRED)
	89	#define rpc_autherr_badverf cpu_to_be32(RPC_AUTH_BADVERF)
	90	#define rpc_autherr_rejectedverf cpu_to_be32(RPC_AUTH_REJECTEDVERF)
	91	#define rpc_autherr_tooweak cpu_to_be32(RPC_AUTH_TOOWEAK)
	92	#define rpcsec_gsserr_credproblem cpu_to_be32(RPCSEC_GSS_CREDPROBLEM)
	93	#define rpcsec_gsserr_ctxproblem cpu_to_be32(RPCSEC_GSS_CTXPROBLEM)
	94	#define rpc_autherr_oldseqnum cpu_to_be32(101)
1da177e4 LT	95
	96	/*
	97	* Miscellaneous XDR helper functions
	98	*/
d8ed029d AD	99	__be32 xdr_encode_opaque_fixed(__be32 p, const void *ptr, unsigned int len);
	100	__be32 xdr_encode_opaque(__be32 p, const void *ptr, unsigned int len);
	101	__be32 xdr_encode_string(__be32 p, const char *s);
e5cff482 CL	102	__be32 xdr_decode_string_inplace(__be32 p, char *sp, unsigned int lenp,
e5cff482 CL	103	unsigned int maxlen);
d8ed029d AD	104	__be32 xdr_encode_netobj(__be32 p, const struct xdr_netobj *);
d8ed029d AD	105	__be32 xdr_decode_netobj(__be32 p, struct xdr_netobj *);
1da177e4	106
1da177e4 LT	107	void xdr_inline_pages(struct xdr_buf *, unsigned int,
1da177e4 LT	108	struct page **, unsigned int, unsigned int);
b4687da7	109	void xdr_terminate_string(struct xdr_buf *, const u32);
1da177e4	110
d8ed029d	111	static inline __be32 xdr_encode_array(__be32 p, const void *s, unsigned int len)
1da177e4 LT	112	{
	113	return xdr_encode_opaque(p, s, len);
	114	}
	115
	116	/*
	117	* Decode 64bit quantities (NFSv3 support)
	118	*/
d8ed029d AD	119	static inline __be32 *
d8ed029d AD	120	xdr_encode_hyper(__be32 *p, __u64 val)
1da177e4	121	{
97363c6a	122	put_unaligned_be64(val, p);
9f162d2a	123	return p + 2;
1da177e4 LT	124	}
1da177e4 LT	125
d8ed029d AD	126	static inline __be32 *
d8ed029d AD	127	xdr_decode_hyper(__be32 p, __u64 valp)
1da177e4	128	{
97363c6a	129	*valp = get_unaligned_be64(p);
98866b5a	130	return p + 2;
1da177e4 LT	131	}
1da177e4 LT	132
35b61e63 BH	133	static inline __be32 *
	134	xdr_decode_opaque_fixed(__be32 p, void ptr, unsigned int len)
	135	{
	136	memcpy(ptr, p, len);
	137	return p + XDR_QUADLEN(len);
	138	}
	139
1da177e4 LT	140	/*
	141	* Adjust kvec to reflect end of xdr'ed data (RPC client XDR)
	142	*/
	143	static inline int
d8ed029d	144	xdr_adjust_iovec(struct kvec iov, __be32 p)
1da177e4 LT	145	{
	146	return iov->iov_len = ((u8 ) p - (u8 ) iov->iov_base);
	147	}
	148
1da177e4 LT	149	/*
	150	* XDR buffer helper functions
	151	*/
	152	extern void xdr_shift_buf(struct xdr_buf *, size_t);
	153	extern void xdr_buf_from_iov(struct kvec , struct xdr_buf );
1e78957e	154	extern int xdr_buf_subsegment(struct xdr_buf , struct xdr_buf , unsigned int, unsigned int);
4c190e2f	155	extern void xdr_buf_trim(struct xdr_buf *, unsigned int);
1e78957e TM	156	extern int xdr_buf_read_netobj(struct xdr_buf , struct xdr_netobj , unsigned int);
	157	extern int read_bytes_from_xdr_buf(struct xdr_buf , unsigned int, void , unsigned int);
	158	extern int write_bytes_to_xdr_buf(struct xdr_buf , unsigned int, void , unsigned int);
1da177e4 LT	159
	160	/*
	161	* Helper structure for copying from an sk_buff.
	162	*/
dd456471	163	struct xdr_skb_reader {
1da177e4 LT	164	struct sk_buff *skb;
	165	unsigned int offset;
	166	size_t count;
44bb9363	167	__wsum csum;
dd456471	168	};
1da177e4	169
dd456471	170	typedef size_t (xdr_skb_read_actor)(struct xdr_skb_reader desc, void *to, size_t len);
1da177e4	171
dd456471	172	size_t xdr_skb_read_bits(struct xdr_skb_reader desc, void to, size_t len);
094bb20b	173	extern int csum_partial_copy_to_xdr(struct xdr_buf , struct sk_buff );
7e06b53d	174	extern ssize_t xdr_partial_copy_from_skb(struct xdr_buf *, unsigned int,
dd456471	175	struct xdr_skb_reader *, xdr_skb_read_actor);
1da177e4	176
1e78957e TM	177	extern int xdr_encode_word(struct xdr_buf *, unsigned int, u32);
1e78957e TM	178	extern int xdr_decode_word(struct xdr_buf , unsigned int, u32 );
bd8100e7 AG	179
	180	struct xdr_array2_desc;
	181	typedef int (xdr_xcode_elem_t)(struct xdr_array2_desc desc, void *elem);
	182	struct xdr_array2_desc {
	183	unsigned int elem_size;
	184	unsigned int array_len;
58fcb8df	185	unsigned int array_maxlen;
bd8100e7 AG	186	xdr_xcode_elem_t xcode;
	187	};
	188
	189	extern int xdr_decode_array2(struct xdr_buf *buf, unsigned int base,
9605a069	190	struct xdr_array2_desc *desc);
bd8100e7 AG	191	extern int xdr_encode_array2(struct xdr_buf *buf, unsigned int base,
bd8100e7 AG	192	struct xdr_array2_desc *desc);
bf118a34 AA	193	extern void _copy_from_pages(char p, struct page *pages, size_t pgbase,
bf118a34 AA	194	size_t len);
bd8100e7	195
1da177e4 LT	196	/*
	197	* Provide some simple tools for XDR buffer overflow-checking etc.
	198	*/
	199	struct xdr_stream {
d8ed029d	200	__be32 p; / start of available buffer */
1da177e4 LT	201	struct xdr_buf buf; / XDR buffer to read/write */
1da177e4 LT	202
d8ed029d	203	__be32 end; / end of available buffer space */
1da177e4	204	struct kvec iov; / pointer to the current kvec */
6650239a TM	205	struct kvec scratch; /* Scratch buffer */
6650239a TM	206	struct page *page_ptr; / pointer to the current page */
bfeea1dc	207	unsigned int nwords; /* Remaining decode buffer length */
1da177e4 LT	208	};
1da177e4 LT	209
9f06c719	210	/*
bf269551	211	* These are the xdr_stream style generic XDR encode and decode functions.
9f06c719 CL	212	*/
9f06c719 CL	213	typedef void (kxdreproc_t)(void rqstp, struct xdr_stream xdr, void obj);
bf269551	214	typedef int (kxdrdproc_t)(void rqstp, struct xdr_stream xdr, void obj);
9f06c719	215
d8ed029d AD	216	extern void xdr_init_encode(struct xdr_stream xdr, struct xdr_buf buf, __be32 *p);
d8ed029d AD	217	extern __be32 xdr_reserve_space(struct xdr_stream xdr, size_t nbytes);
2825a7f9	218	extern void xdr_commit_encode(struct xdr_stream *xdr);
3e19ce76	219	extern void xdr_truncate_encode(struct xdr_stream *xdr, size_t len);
db3f58a9	220	extern int xdr_restrict_buflen(struct xdr_stream *xdr, int newbuflen);
1da177e4 LT	221	extern void xdr_write_pages(struct xdr_stream xdr, struct page *pages,
1da177e4 LT	222	unsigned int base, unsigned int len);
4517d526	223	extern unsigned int xdr_stream_pos(const struct xdr_stream *xdr);
d8ed029d	224	extern void xdr_init_decode(struct xdr_stream xdr, struct xdr_buf buf, __be32 *p);
f7da7a12 BH	225	extern void xdr_init_decode_pages(struct xdr_stream xdr, struct xdr_buf buf,
f7da7a12 BH	226	struct page **pages, unsigned int len);
6650239a	227	extern void xdr_set_scratch_buffer(struct xdr_stream xdr, void buf, size_t buflen);
d8ed029d	228	extern __be32 xdr_inline_decode(struct xdr_stream xdr, size_t nbytes);
c337d365	229	extern unsigned int xdr_read_pages(struct xdr_stream *xdr, unsigned int len);
8b23ea7b	230	extern void xdr_enter_page(struct xdr_stream *xdr, unsigned int len);
37a4e6cb	231	extern int xdr_process_buf(struct xdr_buf buf, unsigned int offset, unsigned int len, int (actor)(struct scatterlist , void ), void *data);
1da177e4 LT	232
	233	#endif /* __KERNEL__ */
	234
	235	#endif /* _SUNRPC_XDR_H_ */