blob: 498ab93a81e4d6afb8233e0925671556571c20b2 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Chuck Lever9605a062010-05-07 13:33:30 -04002 * XDR standard data types and function declarations
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de>
Chuck Lever9605a062010-05-07 13:33:30 -04005 *
6 * Based on:
7 * RFC 4506 "XDR: External Data Representation Standard", May 2006
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 */
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>
Benny Halevy97363c62009-09-23 14:36:38 -040017#include <asm/unaligned.h>
Olga Kornievskaia37a4e6c2006-12-04 20:22:33 -050018#include <linux/scatterlist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019
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
30struct xdr_netobj {
31 unsigned int len;
32 u8 * data;
33};
34
35/*
36 * This is the generic XDR function. rqstp is either a rpc_rqst (client
37 * side) or svc_rqst pointer (server side).
38 * Encode functions always assume there's enough room in the buffer.
39 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -070040typedef int (*kxdrproc_t)(void *rqstp, __be32 *data, void *obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
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 */
55struct xdr_buf {
56 struct kvec head[1], /* RPC header + non-page data */
57 tail[1]; /* Appended after page data */
58
59 struct page ** pages; /* Array of contiguous pages */
60 unsigned int page_base, /* Start of page data */
\"Talpey, Thomas\4f22ccc2007-09-10 13:44:58 -040061 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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
66 unsigned int buflen, /* Total length of storage buffer */
67 len; /* Length of XDR encoded message */
Linus Torvalds1da177e2005-04-16 15:20:36 -070068};
69
70/*
71 * pre-xdr'ed macros.
72 */
73
Harvey Harrison77f18f52009-02-11 17:16:58 -080074#define xdr_zero cpu_to_be32(0)
75#define xdr_one cpu_to_be32(1)
76#define xdr_two cpu_to_be32(2)
Linus Torvalds1da177e2005-04-16 15:20:36 -070077
Harvey Harrison77f18f52009-02-11 17:16:58 -080078#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)
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
Harvey Harrison77f18f52009-02-11 17:16:58 -080086#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)
Linus Torvalds1da177e2005-04-16 15:20:36 -070095
96/*
97 * Miscellaneous XDR helper functions
98 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -070099__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);
Chuck Levere5cff482007-11-01 16:56:47 -0400102__be32 *xdr_decode_string_inplace(__be32 *p, char **sp, unsigned int *lenp,
103 unsigned int maxlen);
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700104__be32 *xdr_encode_netobj(__be32 *p, const struct xdr_netobj *);
105__be32 *xdr_decode_netobj(__be32 *p, struct xdr_netobj *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
107void xdr_encode_pages(struct xdr_buf *, struct page **, unsigned int,
108 unsigned int);
109void xdr_inline_pages(struct xdr_buf *, unsigned int,
110 struct page **, unsigned int, unsigned int);
Chuck Leverb4687da2010-09-21 16:55:48 -0400111void xdr_terminate_string(struct xdr_buf *, const u32);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700113static inline __be32 *xdr_encode_array(__be32 *p, const void *s, unsigned int len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114{
115 return xdr_encode_opaque(p, s, len);
116}
117
118/*
119 * Decode 64bit quantities (NFSv3 support)
120 */
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700121static inline __be32 *
122xdr_encode_hyper(__be32 *p, __u64 val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123{
Benny Halevy97363c62009-09-23 14:36:38 -0400124 put_unaligned_be64(val, p);
Benny Halevy9f162d22009-08-14 17:18:44 +0300125 return p + 2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126}
127
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700128static inline __be32 *
129xdr_decode_hyper(__be32 *p, __u64 *valp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130{
Benny Halevy97363c62009-09-23 14:36:38 -0400131 *valp = get_unaligned_be64(p);
Benny Halevy98866b52009-08-14 17:18:49 +0300132 return p + 2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133}
134
Benny Halevy35b61e62010-10-20 00:17:54 -0400135static inline __be32 *
136xdr_decode_opaque_fixed(__be32 *p, void *ptr, unsigned int len)
137{
138 memcpy(ptr, p, len);
139 return p + XDR_QUADLEN(len);
140}
141
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142/*
143 * Adjust kvec to reflect end of xdr'ed data (RPC client XDR)
144 */
145static inline int
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700146xdr_adjust_iovec(struct kvec *iov, __be32 *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147{
148 return iov->iov_len = ((u8 *) p - (u8 *) iov->iov_base);
149}
150
151/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 * XDR buffer helper functions
153 */
154extern void xdr_shift_buf(struct xdr_buf *, size_t);
155extern void xdr_buf_from_iov(struct kvec *, struct xdr_buf *);
Trond Myklebust1e789572006-08-31 15:09:19 -0400156extern int xdr_buf_subsegment(struct xdr_buf *, struct xdr_buf *, unsigned int, unsigned int);
157extern int xdr_buf_read_netobj(struct xdr_buf *, struct xdr_netobj *, unsigned int);
158extern int read_bytes_from_xdr_buf(struct xdr_buf *, unsigned int, void *, unsigned int);
159extern int write_bytes_to_xdr_buf(struct xdr_buf *, unsigned int, void *, unsigned int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
161/*
162 * Helper structure for copying from an sk_buff.
163 */
Chuck Leverdd456472006-12-05 16:35:44 -0500164struct xdr_skb_reader {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 struct sk_buff *skb;
166 unsigned int offset;
167 size_t count;
Al Viro44bb9362006-11-14 21:36:14 -0800168 __wsum csum;
Chuck Leverdd456472006-12-05 16:35:44 -0500169};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
Chuck Leverdd456472006-12-05 16:35:44 -0500171typedef size_t (*xdr_skb_read_actor)(struct xdr_skb_reader *desc, void *to, size_t len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172
Chuck Leverdd456472006-12-05 16:35:44 -0500173size_t xdr_skb_read_bits(struct xdr_skb_reader *desc, void *to, size_t len);
Chuck Lever094bb202005-08-11 16:25:20 -0400174extern int csum_partial_copy_to_xdr(struct xdr_buf *, struct sk_buff *);
Trond Myklebust7e06b532005-06-22 17:16:24 +0000175extern ssize_t xdr_partial_copy_from_skb(struct xdr_buf *, unsigned int,
Chuck Leverdd456472006-12-05 16:35:44 -0500176 struct xdr_skb_reader *, xdr_skb_read_actor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177
Trond Myklebust1e789572006-08-31 15:09:19 -0400178extern int xdr_encode_word(struct xdr_buf *, unsigned int, u32);
179extern int xdr_decode_word(struct xdr_buf *, unsigned int, u32 *);
Andreas Gruenbacherbd8100e2005-06-22 17:16:24 +0000180
181struct xdr_array2_desc;
182typedef int (*xdr_xcode_elem_t)(struct xdr_array2_desc *desc, void *elem);
183struct xdr_array2_desc {
184 unsigned int elem_size;
185 unsigned int array_len;
Trond Myklebust58fcb8d2005-08-10 18:15:12 -0400186 unsigned int array_maxlen;
Andreas Gruenbacherbd8100e2005-06-22 17:16:24 +0000187 xdr_xcode_elem_t xcode;
188};
189
190extern int xdr_decode_array2(struct xdr_buf *buf, unsigned int base,
Chuck Lever9605a062010-05-07 13:33:30 -0400191 struct xdr_array2_desc *desc);
Andreas Gruenbacherbd8100e2005-06-22 17:16:24 +0000192extern int xdr_encode_array2(struct xdr_buf *buf, unsigned int base,
193 struct xdr_array2_desc *desc);
194
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195/*
196 * Provide some simple tools for XDR buffer overflow-checking etc.
197 */
198struct xdr_stream {
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700199 __be32 *p; /* start of available buffer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 struct xdr_buf *buf; /* XDR buffer to read/write */
201
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700202 __be32 *end; /* end of available buffer space */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 struct kvec *iov; /* pointer to the current kvec */
204};
205
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700206extern void xdr_init_encode(struct xdr_stream *xdr, struct xdr_buf *buf, __be32 *p);
207extern __be32 *xdr_reserve_space(struct xdr_stream *xdr, size_t nbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208extern void xdr_write_pages(struct xdr_stream *xdr, struct page **pages,
209 unsigned int base, unsigned int len);
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700210extern void xdr_init_decode(struct xdr_stream *xdr, struct xdr_buf *buf, __be32 *p);
Trond Myklebustba8e4522010-10-19 19:58:49 -0400211extern __be32 *xdr_inline_peek(struct xdr_stream *xdr, size_t nbytes);
Alexey Dobriyand8ed0292006-09-26 22:29:38 -0700212extern __be32 *xdr_inline_decode(struct xdr_stream *xdr, size_t nbytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213extern void xdr_read_pages(struct xdr_stream *xdr, unsigned int len);
Trond Myklebust8b23ea72006-06-09 09:34:21 -0400214extern void xdr_enter_page(struct xdr_stream *xdr, unsigned int len);
Olga Kornievskaia37a4e6c2006-12-04 20:22:33 -0500215extern int xdr_process_buf(struct xdr_buf *buf, unsigned int offset, unsigned int len, int (*actor)(struct scatterlist *, void *), void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
217#endif /* __KERNEL__ */
218
219#endif /* _SUNRPC_XDR_H_ */