[net-next-2.6.git] / include / linux / sunrpc / xdr.h

/*
 * include/linux/sunrpc/xdr.h
 *
 * Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de>
 */

#ifndef _SUNRPC_XDR_H_
#define _SUNRPC_XDR_H_

#ifdef __KERNEL__

#include <linux/uio.h>
#include <asm/byteorder.h>
#include <linux/scatterlist.h>
#include <linux/smp_lock.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 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);

/*
 * We're still requiring the BKL in the xdr code until it's been
 * more carefully audited, at which point this wrapper will become
 * unnecessary.
 */
static inline int rpc_call_xdrproc(kxdrproc_t xdrproc, void *rqstp, __be32 *data, void *obj)
{
	int ret;

	lock_kernel();
	ret = xdrproc(rqstp, data, obj);
	unlock_kernel();
	return ret;
}

/*
 * 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 contiguous 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	__constant_htonl(0)
#define	xdr_one		__constant_htonl(1)
#define	xdr_two		__constant_htonl(2)

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

#define	rpc_auth_ok		__constant_htonl(RPC_AUTH_OK)
#define	rpc_autherr_badcred	__constant_htonl(RPC_AUTH_BADCRED)
#define	rpc_autherr_rejectedcred __constant_htonl(RPC_AUTH_REJECTEDCRED)
#define	rpc_autherr_badverf	__constant_htonl(RPC_AUTH_BADVERF)
#define	rpc_autherr_rejectedverf __constant_htonl(RPC_AUTH_REJECTEDVERF)
#define	rpc_autherr_tooweak	__constant_htonl(RPC_AUTH_TOOWEAK)
#define	rpcsec_gsserr_credproblem	__constant_htonl(RPCSEC_GSS_CREDPROBLEM)
#define	rpcsec_gsserr_ctxproblem	__constant_htonl(RPCSEC_GSS_CTXPROBLEM)
#define	rpc_autherr_oldseqnum	__constant_htonl(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, int *lenp, int maxlen);
__be32 *xdr_encode_netobj(__be32 *p, const struct xdr_netobj *);
__be32 *xdr_decode_netobj(__be32 *p, struct xdr_netobj *);

void	xdr_encode_pages(struct xdr_buf *, struct page **, unsigned int,
			 unsigned int);
void	xdr_inline_pages(struct xdr_buf *, unsigned int,
			 struct page **, unsigned int, unsigned int);

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)
{
	*p++ = htonl(val >> 32);
	*p++ = htonl(val & 0xFFFFFFFF);
	return p;
}

static inline __be32 *
xdr_decode_hyper(__be32 *p, __u64 *valp)
{
	*valp  = ((__u64) ntohl(*p++)) << 32;
	*valp |= ntohl(*p++);
	return p;
}

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

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

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