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 /*
  70  * pre-xdr'ed macros.
  71  */
  72
  73 #define xdr_zero        cpu_to_be32(0)
  74 #define xdr_one         cpu_to_be32(1)
  75 #define xdr_two         cpu_to_be32(2)
  76
  77 #define rpc_success             cpu_to_be32(RPC_SUCCESS)
  78 #define rpc_prog_unavail        cpu_to_be32(RPC_PROG_UNAVAIL)
  79 #define rpc_prog_mismatch       cpu_to_be32(RPC_PROG_MISMATCH)
  80 #define rpc_proc_unavail        cpu_to_be32(RPC_PROC_UNAVAIL)
  81 #define rpc_garbage_args        cpu_to_be32(RPC_GARBAGE_ARGS)
  82 #define rpc_system_err          cpu_to_be32(RPC_SYSTEM_ERR)
  83 #define rpc_drop_reply          cpu_to_be32(RPC_DROP_REPLY)
  84
  85 #define rpc_auth_ok             cpu_to_be32(RPC_AUTH_OK)
  86 #define rpc_autherr_badcred     cpu_to_be32(RPC_AUTH_BADCRED)
  87 #define rpc_autherr_rejectedcred cpu_to_be32(RPC_AUTH_REJECTEDCRED)
  88 #define rpc_autherr_badverf     cpu_to_be32(RPC_AUTH_BADVERF)
  89 #define rpc_autherr_rejectedverf cpu_to_be32(RPC_AUTH_REJECTEDVERF)
  90 #define rpc_autherr_tooweak     cpu_to_be32(RPC_AUTH_TOOWEAK)
  91 #define rpcsec_gsserr_credproblem       cpu_to_be32(RPCSEC_GSS_CREDPROBLEM)
  92 #define rpcsec_gsserr_ctxproblem        cpu_to_be32(RPCSEC_GSS_CTXPROBLEM)
  93 #define rpc_autherr_oldseqnum   cpu_to_be32(101)
  94
  95 /*
  96  * Miscellaneous XDR helper functions
  97  */
  98 __be32 *xdr_encode_opaque_fixed(__be32 *p, const void *ptr, unsigned int len);
  99 __be32 *xdr_encode_opaque(__be32 *p, const void *ptr, unsigned int len);
 100 __be32 *xdr_encode_string(__be32 *p, const char *s);
 101 __be32 *xdr_decode_string_inplace(__be32 *p, char **sp, unsigned int *lenp,
 102                         unsigned int maxlen);
 103 __be32 *xdr_encode_netobj(__be32 *p, const struct xdr_netobj *);
 104 __be32 *xdr_decode_netobj(__be32 *p, struct xdr_netobj *);
 105
 106 void    xdr_inline_pages(struct xdr_buf *, unsigned int,
 107                          struct page **, unsigned int, unsigned int);
 108 void    xdr_terminate_string(struct xdr_buf *, const u32);
 109
 110 static inline __be32 *xdr_encode_array(__be32 *p, const void *s, unsigned int len)
 111 {
 112         return xdr_encode_opaque(p, s, len);
 113 }
 114
 115 /*
 116  * Decode 64bit quantities (NFSv3 support)
 117  */
 118 static inline __be32 *
 119 xdr_encode_hyper(__be32 *p, __u64 val)
 120 {
 121         put_unaligned_be64(val, p);
 122         return p + 2;
 123 }
 124
 125 static inline __be32 *
 126 xdr_decode_hyper(__be32 *p, __u64 *valp)
 127 {
 128         *valp = get_unaligned_be64(p);
 129         return p + 2;
 130 }
 131
 132 static inline __be32 *
 133 xdr_decode_opaque_fixed(__be32 *p, void *ptr, unsigned int len)
 134 {
 135         memcpy(ptr, p, len);
 136         return p + XDR_QUADLEN(len);
 137 }
 138
 139 /*
 140  * Adjust kvec to reflect end of xdr'ed data (RPC client XDR)
 141  */
 142 static inline int
 143 xdr_adjust_iovec(struct kvec *iov, __be32 *p)
 144 {
 145         return iov->iov_len = ((u8 *) p - (u8 *) iov->iov_base);
 146 }
 147
 148 /*
 149  * XDR buffer helper functions
 150  */
 151 extern void xdr_shift_buf(struct xdr_buf *, size_t);
 152 extern void xdr_buf_from_iov(struct kvec *, struct xdr_buf *);
 153 extern int xdr_buf_subsegment(struct xdr_buf *, struct xdr_buf *, unsigned int, unsigned int);
 154 extern void xdr_buf_trim(struct xdr_buf *, unsigned int);
 155 extern int xdr_buf_read_netobj(struct xdr_buf *, struct xdr_netobj *, unsigned int);
 156 extern int read_bytes_from_xdr_buf(struct xdr_buf *, unsigned int, void *, unsigned int);
 157 extern int write_bytes_to_xdr_buf(struct xdr_buf *, unsigned int, void *, unsigned int);
 158
 159 /*
 160  * Helper structure for copying from an sk_buff.
 161  */
 162 struct xdr_skb_reader {
 163         struct sk_buff  *skb;
 164         unsigned int    offset;
 165         size_t          count;
 166         __wsum          csum;
 167 };
 168
 169 typedef size_t (*xdr_skb_read_actor)(struct xdr_skb_reader *desc, void *to, size_t len);
 170
 171 size_t xdr_skb_read_bits(struct xdr_skb_reader *desc, void *to, size_t len);
 172 extern int csum_partial_copy_to_xdr(struct xdr_buf *, struct sk_buff *);
 173 extern ssize_t xdr_partial_copy_from_skb(struct xdr_buf *, unsigned int,
 174                 struct xdr_skb_reader *, xdr_skb_read_actor);
 175
 176 extern int xdr_encode_word(struct xdr_buf *, unsigned int, u32);
 177 extern int xdr_decode_word(struct xdr_buf *, unsigned int, u32 *);
 178
 179 struct xdr_array2_desc;
 180 typedef int (*xdr_xcode_elem_t)(struct xdr_array2_desc *desc, void *elem);
 181 struct xdr_array2_desc {
 182         unsigned int elem_size;
 183         unsigned int array_len;
 184         unsigned int array_maxlen;
 185         xdr_xcode_elem_t xcode;
 186 };
 187
 188 extern int xdr_decode_array2(struct xdr_buf *buf, unsigned int base,
 189                              struct xdr_array2_desc *desc);
 190 extern int xdr_encode_array2(struct xdr_buf *buf, unsigned int base,
 191                              struct xdr_array2_desc *desc);
 192 extern void _copy_from_pages(char *p, struct page **pages, size_t pgbase,
 193                              size_t len);
 194
 195 /*
 196  * Provide some simple tools for XDR buffer overflow-checking etc.
 197  */
 198 struct xdr_stream {
 199         __be32 *p;              /* start of available buffer */
 200         struct xdr_buf *buf;    /* XDR buffer to read/write */
 201
 202         __be32 *end;            /* end of available buffer space */
 203         struct kvec *iov;       /* pointer to the current kvec */
 204         struct kvec scratch;    /* Scratch buffer */
 205         struct page **page_ptr; /* pointer to the current page */
 206         unsigned int nwords;    /* Remaining decode buffer length */
 207 };
 208
 209 /*
 210  * These are the xdr_stream style generic XDR encode and decode functions.
 211  */
 212 typedef void    (*kxdreproc_t)(void *rqstp, struct xdr_stream *xdr, void *obj);
 213 typedef int     (*kxdrdproc_t)(void *rqstp, struct xdr_stream *xdr, void *obj);
 214
 215 extern void xdr_init_encode(struct xdr_stream *xdr, struct xdr_buf *buf, __be32 *p);
 216 extern __be32 *xdr_reserve_space(struct xdr_stream *xdr, size_t nbytes);
 217 extern void xdr_commit_encode(struct xdr_stream *xdr);
 218 extern void xdr_truncate_encode(struct xdr_stream *xdr, size_t len);
 219 extern int xdr_restrict_buflen(struct xdr_stream *xdr, int newbuflen);
 220 extern void xdr_write_pages(struct xdr_stream *xdr, struct page **pages,
 221                 unsigned int base, unsigned int len);
 222 extern unsigned int xdr_stream_pos(const struct xdr_stream *xdr);
 223 extern void xdr_init_decode(struct xdr_stream *xdr, struct xdr_buf *buf, __be32 *p);
 224 extern void xdr_init_decode_pages(struct xdr_stream *xdr, struct xdr_buf *buf,
 225                 struct page **pages, unsigned int len);
 226 extern void xdr_set_scratch_buffer(struct xdr_stream *xdr, void *buf, size_t buflen);
 227 extern __be32 *xdr_inline_decode(struct xdr_stream *xdr, size_t nbytes);
 228 extern unsigned int xdr_read_pages(struct xdr_stream *xdr, unsigned int len);
 229 extern void xdr_enter_page(struct xdr_stream *xdr, unsigned int len);
 230 extern int xdr_process_buf(struct xdr_buf *buf, unsigned int offset, unsigned int len, int (*actor)(struct scatterlist *, void *), void *data);
 231
 232 #endif /* __KERNEL__ */
 233
 234 #endif /* _SUNRPC_XDR_H_ */