2 * XDR standard data types and function declarations
4 * Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de>
7 * RFC 4506 "XDR: External Data Representation Standard", May 2006
10 #ifndef _SUNRPC_XDR_H_
11 #define _SUNRPC_XDR_H_
15 #include <linux/uio.h>
16 #include <asm/byteorder.h>
17 #include <asm/unaligned.h>
18 #include <linux/scatterlist.h>
25 #define XDR_QUADLEN(l) (((l) + 3) >> 2)
28 * Generic opaque `network object.' At the kernel level, this type
29 * is used only by lockd.
31 #define XDR_MAX_NETOBJ 1024
38 * This is the legacy generic XDR function. rqstp is either a rpc_rqst
39 * (client side) or svc_rqst pointer (server side).
40 * Encode functions always assume there's enough room in the buffer.
42 typedef int (*kxdrproc_t
)(void *rqstp
, __be32
*data
, void *obj
);
45 * Basic structure for transmission/reception of a client XDR message.
46 * Features a header (for a linear buffer containing RPC headers
47 * and the data payload for short messages), and then an array of
49 * The tail iovec allows you to append data after the page array. Its
50 * main interest is for appending padding to the pages in order to
51 * satisfy the int_32-alignment requirements in RFC1832.
53 * For the future, we might want to string several of these together
54 * in a list if anybody wants to make use of NFSv4 COMPOUND
55 * operations and/or has a need for scatter/gather involving pages.
58 struct kvec head
[1], /* RPC header + non-page data */
59 tail
[1]; /* Appended after page data */
61 struct page
** pages
; /* Array of pages */
62 unsigned int page_base
, /* Start of page data */
63 page_len
, /* Length of page data */
64 flags
; /* Flags for data disposition */
65 #define XDRBUF_READ 0x01 /* target of file read */
66 #define XDRBUF_WRITE 0x02 /* source of file write */
68 unsigned int buflen
, /* Total length of storage buffer */
69 len
; /* Length of XDR encoded message */
73 xdr_buf_init(struct xdr_buf
*buf
, void *start
, size_t len
)
75 buf
->head
[0].iov_base
= start
;
76 buf
->head
[0].iov_len
= len
;
77 buf
->tail
[0].iov_len
= 0;
88 #define xdr_zero cpu_to_be32(0)
89 #define xdr_one cpu_to_be32(1)
90 #define xdr_two cpu_to_be32(2)
92 #define rpc_success cpu_to_be32(RPC_SUCCESS)
93 #define rpc_prog_unavail cpu_to_be32(RPC_PROG_UNAVAIL)
94 #define rpc_prog_mismatch cpu_to_be32(RPC_PROG_MISMATCH)
95 #define rpc_proc_unavail cpu_to_be32(RPC_PROC_UNAVAIL)
96 #define rpc_garbage_args cpu_to_be32(RPC_GARBAGE_ARGS)
97 #define rpc_system_err cpu_to_be32(RPC_SYSTEM_ERR)
98 #define rpc_drop_reply cpu_to_be32(RPC_DROP_REPLY)
100 #define rpc_auth_ok cpu_to_be32(RPC_AUTH_OK)
101 #define rpc_autherr_badcred cpu_to_be32(RPC_AUTH_BADCRED)
102 #define rpc_autherr_rejectedcred cpu_to_be32(RPC_AUTH_REJECTEDCRED)
103 #define rpc_autherr_badverf cpu_to_be32(RPC_AUTH_BADVERF)
104 #define rpc_autherr_rejectedverf cpu_to_be32(RPC_AUTH_REJECTEDVERF)
105 #define rpc_autherr_tooweak cpu_to_be32(RPC_AUTH_TOOWEAK)
106 #define rpcsec_gsserr_credproblem cpu_to_be32(RPCSEC_GSS_CREDPROBLEM)
107 #define rpcsec_gsserr_ctxproblem cpu_to_be32(RPCSEC_GSS_CTXPROBLEM)
108 #define rpc_autherr_oldseqnum cpu_to_be32(101)
111 * Miscellaneous XDR helper functions
113 __be32
*xdr_encode_opaque_fixed(__be32
*p
, const void *ptr
, unsigned int len
);
114 __be32
*xdr_encode_opaque(__be32
*p
, const void *ptr
, unsigned int len
);
115 __be32
*xdr_encode_string(__be32
*p
, const char *s
);
116 __be32
*xdr_decode_string_inplace(__be32
*p
, char **sp
, unsigned int *lenp
,
117 unsigned int maxlen
);
118 __be32
*xdr_encode_netobj(__be32
*p
, const struct xdr_netobj
*);
119 __be32
*xdr_decode_netobj(__be32
*p
, struct xdr_netobj
*);
121 void xdr_inline_pages(struct xdr_buf
*, unsigned int,
122 struct page
**, unsigned int, unsigned int);
123 void xdr_terminate_string(struct xdr_buf
*, const u32
);
125 static inline __be32
*xdr_encode_array(__be32
*p
, const void *s
, unsigned int len
)
127 return xdr_encode_opaque(p
, s
, len
);
131 * Decode 64bit quantities (NFSv3 support)
133 static inline __be32
*
134 xdr_encode_hyper(__be32
*p
, __u64 val
)
136 put_unaligned_be64(val
, p
);
140 static inline __be32
*
141 xdr_decode_hyper(__be32
*p
, __u64
*valp
)
143 *valp
= get_unaligned_be64(p
);
147 static inline __be32
*
148 xdr_decode_opaque_fixed(__be32
*p
, void *ptr
, unsigned int len
)
151 return p
+ XDR_QUADLEN(len
);
155 * Adjust kvec to reflect end of xdr'ed data (RPC client XDR)
158 xdr_adjust_iovec(struct kvec
*iov
, __be32
*p
)
160 return iov
->iov_len
= ((u8
*) p
- (u8
*) iov
->iov_base
);
164 * XDR buffer helper functions
166 extern void xdr_shift_buf(struct xdr_buf
*, size_t);
167 extern void xdr_buf_from_iov(struct kvec
*, struct xdr_buf
*);
168 extern int xdr_buf_subsegment(struct xdr_buf
*, struct xdr_buf
*, unsigned int, unsigned int);
169 extern void xdr_buf_trim(struct xdr_buf
*, unsigned int);
170 extern int xdr_buf_read_netobj(struct xdr_buf
*, struct xdr_netobj
*, unsigned int);
171 extern int read_bytes_from_xdr_buf(struct xdr_buf
*, unsigned int, void *, unsigned int);
172 extern int write_bytes_to_xdr_buf(struct xdr_buf
*, unsigned int, void *, unsigned int);
175 * Helper structure for copying from an sk_buff.
177 struct xdr_skb_reader
{
184 typedef size_t (*xdr_skb_read_actor
)(struct xdr_skb_reader
*desc
, void *to
, size_t len
);
186 size_t xdr_skb_read_bits(struct xdr_skb_reader
*desc
, void *to
, size_t len
);
187 extern int csum_partial_copy_to_xdr(struct xdr_buf
*, struct sk_buff
*);
188 extern ssize_t
xdr_partial_copy_from_skb(struct xdr_buf
*, unsigned int,
189 struct xdr_skb_reader
*, xdr_skb_read_actor
);
191 extern int xdr_encode_word(struct xdr_buf
*, unsigned int, u32
);
192 extern int xdr_decode_word(struct xdr_buf
*, unsigned int, u32
*);
194 struct xdr_array2_desc
;
195 typedef int (*xdr_xcode_elem_t
)(struct xdr_array2_desc
*desc
, void *elem
);
196 struct xdr_array2_desc
{
197 unsigned int elem_size
;
198 unsigned int array_len
;
199 unsigned int array_maxlen
;
200 xdr_xcode_elem_t xcode
;
203 extern int xdr_decode_array2(struct xdr_buf
*buf
, unsigned int base
,
204 struct xdr_array2_desc
*desc
);
205 extern int xdr_encode_array2(struct xdr_buf
*buf
, unsigned int base
,
206 struct xdr_array2_desc
*desc
);
207 extern void _copy_from_pages(char *p
, struct page
**pages
, size_t pgbase
,
211 * Provide some simple tools for XDR buffer overflow-checking etc.
214 __be32
*p
; /* start of available buffer */
215 struct xdr_buf
*buf
; /* XDR buffer to read/write */
217 __be32
*end
; /* end of available buffer space */
218 struct kvec
*iov
; /* pointer to the current kvec */
219 struct kvec scratch
; /* Scratch buffer */
220 struct page
**page_ptr
; /* pointer to the current page */
221 unsigned int nwords
; /* Remaining decode buffer length */
225 * These are the xdr_stream style generic XDR encode and decode functions.
227 typedef void (*kxdreproc_t
)(struct rpc_rqst
*rqstp
, struct xdr_stream
*xdr
,
229 typedef int (*kxdrdproc_t
)(void *rqstp
, struct xdr_stream
*xdr
, void *obj
);
231 extern void xdr_init_encode(struct xdr_stream
*xdr
, struct xdr_buf
*buf
, __be32
*p
);
232 extern __be32
*xdr_reserve_space(struct xdr_stream
*xdr
, size_t nbytes
);
233 extern void xdr_commit_encode(struct xdr_stream
*xdr
);
234 extern void xdr_truncate_encode(struct xdr_stream
*xdr
, size_t len
);
235 extern int xdr_restrict_buflen(struct xdr_stream
*xdr
, int newbuflen
);
236 extern void xdr_write_pages(struct xdr_stream
*xdr
, struct page
**pages
,
237 unsigned int base
, unsigned int len
);
238 extern unsigned int xdr_stream_pos(const struct xdr_stream
*xdr
);
239 extern void xdr_init_decode(struct xdr_stream
*xdr
, struct xdr_buf
*buf
, __be32
*p
);
240 extern void xdr_init_decode_pages(struct xdr_stream
*xdr
, struct xdr_buf
*buf
,
241 struct page
**pages
, unsigned int len
);
242 extern void xdr_set_scratch_buffer(struct xdr_stream
*xdr
, void *buf
, size_t buflen
);
243 extern __be32
*xdr_inline_decode(struct xdr_stream
*xdr
, size_t nbytes
);
244 extern unsigned int xdr_read_pages(struct xdr_stream
*xdr
, unsigned int len
);
245 extern void xdr_enter_page(struct xdr_stream
*xdr
, unsigned int len
);
246 extern int xdr_process_buf(struct xdr_buf
*buf
, unsigned int offset
, unsigned int len
, int (*actor
)(struct scatterlist
*, void *), void *data
);
248 ssize_t
xdr_stream_decode_string_dup(struct xdr_stream
*xdr
, char **str
,
249 size_t maxlen
, gfp_t gfp_flags
);
251 * xdr_align_size - Calculate padded size of an object
252 * @n: Size of an object being XDR encoded (in bytes)
255 * Size (in bytes) of the object including xdr padding
258 xdr_align_size(size_t n
)
260 const size_t mask
= sizeof(__u32
) - 1;
262 return (n
+ mask
) & ~mask
;
266 * xdr_stream_encode_u32 - Encode a 32-bit integer
267 * @xdr: pointer to xdr_stream
268 * @n: integer to encode
271 * On success, returns length in bytes of XDR buffer consumed
272 * %-EMSGSIZE on XDR buffer overflow
274 static inline ssize_t
275 xdr_stream_encode_u32(struct xdr_stream
*xdr
, __u32 n
)
277 const size_t len
= sizeof(n
);
278 __be32
*p
= xdr_reserve_space(xdr
, len
);
287 * xdr_stream_encode_u64 - Encode a 64-bit integer
288 * @xdr: pointer to xdr_stream
289 * @n: 64-bit integer to encode
292 * On success, returns length in bytes of XDR buffer consumed
293 * %-EMSGSIZE on XDR buffer overflow
295 static inline ssize_t
296 xdr_stream_encode_u64(struct xdr_stream
*xdr
, __u64 n
)
298 const size_t len
= sizeof(n
);
299 __be32
*p
= xdr_reserve_space(xdr
, len
);
303 xdr_encode_hyper(p
, n
);
308 * xdr_stream_encode_opaque_fixed - Encode fixed length opaque xdr data
309 * @xdr: pointer to xdr_stream
310 * @ptr: pointer to opaque data object
311 * @len: size of object pointed to by @ptr
314 * On success, returns length in bytes of XDR buffer consumed
315 * %-EMSGSIZE on XDR buffer overflow
317 static inline ssize_t
318 xdr_stream_encode_opaque_fixed(struct xdr_stream
*xdr
, const void *ptr
, size_t len
)
320 __be32
*p
= xdr_reserve_space(xdr
, len
);
324 xdr_encode_opaque_fixed(p
, ptr
, len
);
325 return xdr_align_size(len
);
329 * xdr_stream_encode_opaque - Encode variable length opaque xdr data
330 * @xdr: pointer to xdr_stream
331 * @ptr: pointer to opaque data object
332 * @len: size of object pointed to by @ptr
335 * On success, returns length in bytes of XDR buffer consumed
336 * %-EMSGSIZE on XDR buffer overflow
338 static inline ssize_t
339 xdr_stream_encode_opaque(struct xdr_stream
*xdr
, const void *ptr
, size_t len
)
341 size_t count
= sizeof(__u32
) + xdr_align_size(len
);
342 __be32
*p
= xdr_reserve_space(xdr
, count
);
346 xdr_encode_opaque(p
, ptr
, len
);
351 * xdr_stream_decode_u32 - Decode a 32-bit integer
352 * @xdr: pointer to xdr_stream
353 * @ptr: location to store integer
357 * %-EBADMSG on XDR buffer overflow
359 static inline ssize_t
360 xdr_stream_decode_u32(struct xdr_stream
*xdr
, __u32
*ptr
)
362 const size_t count
= sizeof(*ptr
);
363 __be32
*p
= xdr_inline_decode(xdr
, count
);
367 *ptr
= be32_to_cpup(p
);
372 * xdr_stream_decode_opaque_fixed - Decode fixed length opaque xdr data
373 * @xdr: pointer to xdr_stream
374 * @ptr: location to store data
375 * @len: size of buffer pointed to by @ptr
378 * On success, returns size of object stored in @ptr
379 * %-EBADMSG on XDR buffer overflow
381 static inline ssize_t
382 xdr_stream_decode_opaque_fixed(struct xdr_stream
*xdr
, void *ptr
, size_t len
)
384 __be32
*p
= xdr_inline_decode(xdr
, len
);
388 xdr_decode_opaque_fixed(p
, ptr
, len
);
393 * xdr_stream_decode_opaque_inline - Decode variable length opaque xdr data
394 * @xdr: pointer to xdr_stream
395 * @ptr: location to store pointer to opaque data
396 * @maxlen: maximum acceptable object size
398 * Note: the pointer stored in @ptr cannot be assumed valid after the XDR
399 * buffer has been destroyed, or even after calling xdr_inline_decode()
400 * on @xdr. It is therefore expected that the object it points to should
401 * be processed immediately.
404 * On success, returns size of object stored in *@ptr
405 * %-EBADMSG on XDR buffer overflow
406 * %-EMSGSIZE if the size of the object would exceed @maxlen
408 static inline ssize_t
409 xdr_stream_decode_opaque_inline(struct xdr_stream
*xdr
, void **ptr
, size_t maxlen
)
415 if (unlikely(xdr_stream_decode_u32(xdr
, &len
) < 0))
418 p
= xdr_inline_decode(xdr
, len
);
421 if (unlikely(len
> maxlen
))
427 #endif /* __KERNEL__ */
429 #endif /* _SUNRPC_XDR_H_ */