[deliverable/linux.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>

/*
 * 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, u32 *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 contiguous pages */
	unsigned int	page_base,	/* Start of page data */
			page_len;	/* Length of page data */

	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_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
 */
u32 *	xdr_encode_opaque_fixed(u32 *p, const void *ptr, unsigned int len);
u32 *	xdr_encode_opaque(u32 *p, const void *ptr, unsigned int len);
u32 *	xdr_encode_string(u32 *p, const char *s);
u32 *	xdr_decode_string(u32 *p, char **sp, int *lenp, int maxlen);
u32 *	xdr_decode_string_inplace(u32 *p, char **sp, int *lenp, int maxlen);
u32 *	xdr_encode_netobj(u32 *p, const struct xdr_netobj *);
u32 *	xdr_decode_netobj(u32 *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 u32 *xdr_encode_array(u32 *p, const void *s, unsigned int len)
{
	return xdr_encode_opaque(p, s, len);
}

/*
 * Decode 64bit quantities (NFSv3 support)
 */
static inline u32 *
xdr_encode_hyper(u32 *p, __u64 val)
{
	*p++ = htonl(val >> 32);
	*p++ = htonl(val & 0xFFFFFFFF);
	return p;
}

static inline u32 *
xdr_decode_hyper(u32 *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, u32 *p)
{
	return iov->iov_len = ((u8 *) p - (u8 *) iov->iov_base);
}

/*
 * Maximum number of iov's we use.
 */
#define MAX_IOVEC	(12)

/*
 * 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 *, int, int);
extern int xdr_buf_read_netobj(struct xdr_buf *, struct xdr_netobj *, int);
extern int read_bytes_from_xdr_buf(struct xdr_buf *, int, void *, int);
extern int write_bytes_to_xdr_buf(struct xdr_buf *, int, void *, int);

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

typedef size_t (*skb_read_actor_t)(skb_reader_t *desc, void *to, size_t len);

extern ssize_t xdr_partial_copy_from_skb(struct xdr_buf *, unsigned int,
		skb_reader_t *, skb_read_actor_t);

struct socket;
struct sockaddr;
extern int xdr_sendpages(struct socket *, struct sockaddr *, int,
		struct xdr_buf *, unsigned int, int);

extern int xdr_encode_word(struct xdr_buf *, int, u32);
extern int xdr_decode_word(struct xdr_buf *, 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 {
	uint32_t *p;		/* start of available buffer */
	struct xdr_buf *buf;	/* XDR buffer to read/write */

	uint32_t *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, uint32_t *p);
extern uint32_t *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, uint32_t *p);
extern uint32_t *xdr_inline_decode(struct xdr_stream *xdr, size_t nbytes);
extern void xdr_read_pages(struct xdr_stream *xdr, unsigned int len);

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