include/linux/sunrpc/xdr.h

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