include/linux/sunrpc/xdr.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * XDR standard data types and function declarations
   4  *
   5  * Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de>
   6  *
   7  * Based on:
   8  *   RFC 4506 "XDR: External Data Representation Standard", May 2006
   9  */
  10
  11 #ifndef _SUNRPC_XDR_H_
  12 #define _SUNRPC_XDR_H_
  13
  14 #ifdef __KERNEL__
  15
  16 #include <linux/uio.h>
  17 #include <asm/byteorder.h>
  18 #include <asm/unaligned.h>
  19 #include <linux/scatterlist.h>
  20
  21 struct bio_vec;
  22 struct rpc_rqst;
  23
  24 /*
  25  * Buffer adjustment
  26  */
  27 #define XDR_QUADLEN(l)          (((l) + 3) >> 2)
  28
  29 /*
  30  * Generic opaque `network object.' At the kernel level, this type
  31  * is used only by lockd.
  32  */
  33 #define XDR_MAX_NETOBJ          1024
  34 struct xdr_netobj {
  35         unsigned int            len;
  36         u8 *                    data;
  37 };
  38
  39 /*
  40  * Basic structure for transmission/reception of a client XDR message.
  41  * Features a header (for a linear buffer containing RPC headers
  42  * and the data payload for short messages), and then an array of
  43  * pages.
  44  * The tail iovec allows you to append data after the page array. Its
  45  * main interest is for appending padding to the pages in order to
  46  * satisfy the int_32-alignment requirements in RFC1832.
  47  *
  48  * For the future, we might want to string several of these together
  49  * in a list if anybody wants to make use of NFSv4 COMPOUND
  50  * operations and/or has a need for scatter/gather involving pages.
  51  */
  52 struct xdr_buf {
  53         struct kvec     head[1],        /* RPC header + non-page data */
  54                         tail[1];        /* Appended after page data */
  55
  56         struct bio_vec  *bvec;
  57         struct page **  pages;          /* Array of pages */
  58         unsigned int    page_base,      /* Start of page data */
  59                         page_len,       /* Length of page data */
  60                         flags;          /* Flags for data disposition */
  61 #define XDRBUF_READ             0x01            /* target of file read */
  62 #define XDRBUF_WRITE            0x02            /* source of file write */
  63 #define XDRBUF_SPARSE_PAGES     0x04            /* Page array is sparse */
  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->pages = NULL;
  76         buf->page_len = 0;
  77         buf->flags = 0;
  78         buf->len = 0;
  79         buf->buflen = len;
  80 }
  81
  82 /*
  83  * pre-xdr'ed macros.
  84  */
  85
  86 #define xdr_zero        cpu_to_be32(0)
  87 #define xdr_one         cpu_to_be32(1)
  88 #define xdr_two         cpu_to_be32(2)
  89
  90 #define rpc_auth_null   cpu_to_be32(RPC_AUTH_NULL)
  91 #define rpc_auth_unix   cpu_to_be32(RPC_AUTH_UNIX)
  92 #define rpc_auth_short  cpu_to_be32(RPC_AUTH_SHORT)
  93 #define rpc_auth_gss    cpu_to_be32(RPC_AUTH_GSS)
  94
  95 #define rpc_call        cpu_to_be32(RPC_CALL)
  96 #define rpc_reply       cpu_to_be32(RPC_REPLY)
  97
  98 #define rpc_msg_accepted        cpu_to_be32(RPC_MSG_ACCEPTED)
  99
 100 #define rpc_success             cpu_to_be32(RPC_SUCCESS)
 101 #define rpc_prog_unavail        cpu_to_be32(RPC_PROG_UNAVAIL)
 102 #define rpc_prog_mismatch       cpu_to_be32(RPC_PROG_MISMATCH)
 103 #define rpc_proc_unavail        cpu_to_be32(RPC_PROC_UNAVAIL)
 104 #define rpc_garbage_args        cpu_to_be32(RPC_GARBAGE_ARGS)
 105 #define rpc_system_err          cpu_to_be32(RPC_SYSTEM_ERR)
 106 #define rpc_drop_reply          cpu_to_be32(RPC_DROP_REPLY)
 107
 108 #define rpc_mismatch            cpu_to_be32(RPC_MISMATCH)
 109 #define rpc_auth_error          cpu_to_be32(RPC_AUTH_ERROR)
 110
 111 #define rpc_auth_ok             cpu_to_be32(RPC_AUTH_OK)
 112 #define rpc_autherr_badcred     cpu_to_be32(RPC_AUTH_BADCRED)
 113 #define rpc_autherr_rejectedcred cpu_to_be32(RPC_AUTH_REJECTEDCRED)
 114 #define rpc_autherr_badverf     cpu_to_be32(RPC_AUTH_BADVERF)
 115 #define rpc_autherr_rejectedverf cpu_to_be32(RPC_AUTH_REJECTEDVERF)
 116 #define rpc_autherr_tooweak     cpu_to_be32(RPC_AUTH_TOOWEAK)
 117 #define rpcsec_gsserr_credproblem       cpu_to_be32(RPCSEC_GSS_CREDPROBLEM)
 118 #define rpcsec_gsserr_ctxproblem        cpu_to_be32(RPCSEC_GSS_CTXPROBLEM)
 119
 120 /*
 121  * Miscellaneous XDR helper functions
 122  */
 123 __be32 *xdr_encode_opaque_fixed(__be32 *p, const void *ptr, unsigned int len);
 124 __be32 *xdr_encode_opaque(__be32 *p, const void *ptr, unsigned int len);
 125 __be32 *xdr_encode_string(__be32 *p, const char *s);
 126 __be32 *xdr_decode_string_inplace(__be32 *p, char **sp, unsigned int *lenp,
 127                         unsigned int maxlen);
 128 __be32 *xdr_encode_netobj(__be32 *p, const struct xdr_netobj *);
 129 __be32 *xdr_decode_netobj(__be32 *p, struct xdr_netobj *);
 130
 131 void    xdr_inline_pages(struct xdr_buf *, unsigned int,
 132                          struct page **, unsigned int, unsigned int);
 133 void    xdr_terminate_string(struct xdr_buf *, const u32);
 134 size_t  xdr_buf_pagecount(struct xdr_buf *buf);
 135 int     xdr_alloc_bvec(struct xdr_buf *buf, gfp_t gfp);
 136 void    xdr_free_bvec(struct xdr_buf *buf);
 137
 138 static inline __be32 *xdr_encode_array(__be32 *p, const void *s, unsigned int len)
 139 {
 140         return xdr_encode_opaque(p, s, len);
 141 }
 142
 143 /*
 144  * Decode 64bit quantities (NFSv3 support)
 145  */
 146 static inline __be32 *
 147 xdr_encode_hyper(__be32 *p, __u64 val)
 148 {
 149         put_unaligned_be64(val, p);
 150         return p + 2;
 151 }
 152
 153 static inline __be32 *
 154 xdr_decode_hyper(__be32 *p, __u64 *valp)
 155 {
 156         *valp = get_unaligned_be64(p);
 157         return p + 2;
 158 }
 159
 160 static inline __be32 *
 161 xdr_decode_opaque_fixed(__be32 *p, void *ptr, unsigned int len)
 162 {
 163         memcpy(ptr, p, len);
 164         return p + XDR_QUADLEN(len);
 165 }
 166
 167 /*
 168  * Adjust kvec to reflect end of xdr'ed data (RPC client XDR)
 169  */
 170 static inline int
 171 xdr_adjust_iovec(struct kvec *iov, __be32 *p)
 172 {
 173         return iov->iov_len = ((u8 *) p - (u8 *) iov->iov_base);
 174 }
 175
 176 /*
 177  * XDR buffer helper functions
 178  */
 179 extern void xdr_shift_buf(struct xdr_buf *, size_t);
 180 extern void xdr_buf_from_iov(struct kvec *, struct xdr_buf *);
 181 extern int xdr_buf_subsegment(struct xdr_buf *, struct xdr_buf *, unsigned int, unsigned int);
 182 extern void xdr_buf_trim(struct xdr_buf *, unsigned int);
 183 extern int xdr_buf_read_netobj(struct xdr_buf *, struct xdr_netobj *, unsigned int);
 184 extern int read_bytes_from_xdr_buf(struct xdr_buf *, unsigned int, void *, unsigned int);
 185 extern int write_bytes_to_xdr_buf(struct xdr_buf *, unsigned int, void *, unsigned int);
 186
 187 /*
 188  * Helper structure for copying from an sk_buff.
 189  */
 190 struct xdr_skb_reader {
 191         struct sk_buff  *skb;
 192         unsigned int    offset;
 193         size_t          count;
 194         __wsum          csum;
 195 };
 196
 197 typedef size_t (*xdr_skb_read_actor)(struct xdr_skb_reader *desc, void *to, size_t len);
 198
 199 extern int csum_partial_copy_to_xdr(struct xdr_buf *, struct sk_buff *);
 200
 201 extern int xdr_encode_word(struct xdr_buf *, unsigned int, u32);
 202 extern int xdr_decode_word(struct xdr_buf *, unsigned int, u32 *);
 203
 204 struct xdr_array2_desc;
 205 typedef int (*xdr_xcode_elem_t)(struct xdr_array2_desc *desc, void *elem);
 206 struct xdr_array2_desc {
 207         unsigned int elem_size;
 208         unsigned int array_len;
 209         unsigned int array_maxlen;
 210         xdr_xcode_elem_t xcode;
 211 };
 212
 213 extern int xdr_decode_array2(struct xdr_buf *buf, unsigned int base,
 214                              struct xdr_array2_desc *desc);
 215 extern int xdr_encode_array2(struct xdr_buf *buf, unsigned int base,
 216                              struct xdr_array2_desc *desc);
 217 extern void _copy_from_pages(char *p, struct page **pages, size_t pgbase,
 218                              size_t len);
 219
 220 /*
 221  * Provide some simple tools for XDR buffer overflow-checking etc.
 222  */
 223 struct xdr_stream {
 224         __be32 *p;              /* start of available buffer */
 225         struct xdr_buf *buf;    /* XDR buffer to read/write */
 226
 227         __be32 *end;            /* end of available buffer space */
 228         struct kvec *iov;       /* pointer to the current kvec */
 229         struct kvec scratch;    /* Scratch buffer */
 230         struct page **page_ptr; /* pointer to the current page */
 231         unsigned int nwords;    /* Remaining decode buffer length */
 232
 233         struct rpc_rqst *rqst;  /* For debugging */
 234 };
 235
 236 /*
 237  * These are the xdr_stream style generic XDR encode and decode functions.
 238  */
 239 typedef void    (*kxdreproc_t)(struct rpc_rqst *rqstp, struct xdr_stream *xdr,
 240                 const void *obj);
 241 typedef int     (*kxdrdproc_t)(struct rpc_rqst *rqstp, struct xdr_stream *xdr,
 242                 void *obj);
 243
 244 extern void xdr_init_encode(struct xdr_stream *xdr, struct xdr_buf *buf,
 245                             __be32 *p, struct rpc_rqst *rqst);
 246 extern __be32 *xdr_reserve_space(struct xdr_stream *xdr, size_t nbytes);
 247 extern void xdr_commit_encode(struct xdr_stream *xdr);
 248 extern void xdr_truncate_encode(struct xdr_stream *xdr, size_t len);
 249 extern int xdr_restrict_buflen(struct xdr_stream *xdr, int newbuflen);
 250 extern void xdr_write_pages(struct xdr_stream *xdr, struct page **pages,
 251                 unsigned int base, unsigned int len);
 252 extern unsigned int xdr_stream_pos(const struct xdr_stream *xdr);
 253 extern void xdr_init_decode(struct xdr_stream *xdr, struct xdr_buf *buf,
 254                             __be32 *p, struct rpc_rqst *rqst);
 255 extern void xdr_init_decode_pages(struct xdr_stream *xdr, struct xdr_buf *buf,
 256                 struct page **pages, unsigned int len);
 257 extern void xdr_set_scratch_buffer(struct xdr_stream *xdr, void *buf, size_t buflen);
 258 extern __be32 *xdr_inline_decode(struct xdr_stream *xdr, size_t nbytes);
 259 extern unsigned int xdr_read_pages(struct xdr_stream *xdr, unsigned int len);
 260 extern void xdr_enter_page(struct xdr_stream *xdr, unsigned int len);
 261 extern int xdr_process_buf(struct xdr_buf *buf, unsigned int offset, unsigned int len, int (*actor)(struct scatterlist *, void *), void *data);
 262
 263 /**
 264  * xdr_stream_remaining - Return the number of bytes remaining in the stream
 265  * @xdr: pointer to struct xdr_stream
 266  *
 267  * Return value:
 268  *   Number of bytes remaining in @xdr before xdr->end
 269  */
 270 static inline size_t
 271 xdr_stream_remaining(const struct xdr_stream *xdr)
 272 {
 273         return xdr->nwords << 2;
 274 }
 275
 276 ssize_t xdr_stream_decode_opaque(struct xdr_stream *xdr, void *ptr,
 277                 size_t size);
 278 ssize_t xdr_stream_decode_opaque_dup(struct xdr_stream *xdr, void **ptr,
 279                 size_t maxlen, gfp_t gfp_flags);
 280 ssize_t xdr_stream_decode_string(struct xdr_stream *xdr, char *str,
 281                 size_t size);
 282 ssize_t xdr_stream_decode_string_dup(struct xdr_stream *xdr, char **str,
 283                 size_t maxlen, gfp_t gfp_flags);
 284 /**
 285  * xdr_align_size - Calculate padded size of an object
 286  * @n: Size of an object being XDR encoded (in bytes)
 287  *
 288  * Return value:
 289  *   Size (in bytes) of the object including xdr padding
 290  */
 291 static inline size_t
 292 xdr_align_size(size_t n)
 293 {
 294         const size_t mask = sizeof(__u32) - 1;
 295
 296         return (n + mask) & ~mask;
 297 }
 298
 299 /**
 300  * xdr_stream_encode_u32 - Encode a 32-bit integer
 301  * @xdr: pointer to xdr_stream
 302  * @n: integer to encode
 303  *
 304  * Return values:
 305  *   On success, returns length in bytes of XDR buffer consumed
 306  *   %-EMSGSIZE on XDR buffer overflow
 307  */
 308 static inline ssize_t
 309 xdr_stream_encode_u32(struct xdr_stream *xdr, __u32 n)
 310 {
 311         const size_t len = sizeof(n);
 312         __be32 *p = xdr_reserve_space(xdr, len);
 313
 314         if (unlikely(!p))
 315                 return -EMSGSIZE;
 316         *p = cpu_to_be32(n);
 317         return len;
 318 }
 319
 320 /**
 321  * xdr_stream_encode_u64 - Encode a 64-bit integer
 322  * @xdr: pointer to xdr_stream
 323  * @n: 64-bit integer to encode
 324  *
 325  * Return values:
 326  *   On success, returns length in bytes of XDR buffer consumed
 327  *   %-EMSGSIZE on XDR buffer overflow
 328  */
 329 static inline ssize_t
 330 xdr_stream_encode_u64(struct xdr_stream *xdr, __u64 n)
 331 {
 332         const size_t len = sizeof(n);
 333         __be32 *p = xdr_reserve_space(xdr, len);
 334
 335         if (unlikely(!p))
 336                 return -EMSGSIZE;
 337         xdr_encode_hyper(p, n);
 338         return len;
 339 }
 340
 341 /**
 342  * xdr_stream_encode_opaque_inline - Encode opaque xdr data
 343  * @xdr: pointer to xdr_stream
 344  * @ptr: pointer to void pointer
 345  * @len: size of object
 346  *
 347  * Return values:
 348  *   On success, returns length in bytes of XDR buffer consumed
 349  *   %-EMSGSIZE on XDR buffer overflow
 350  */
 351 static inline ssize_t
 352 xdr_stream_encode_opaque_inline(struct xdr_stream *xdr, void **ptr, size_t len)
 353 {
 354         size_t count = sizeof(__u32) + xdr_align_size(len);
 355         __be32 *p = xdr_reserve_space(xdr, count);
 356
 357         if (unlikely(!p)) {
 358                 *ptr = NULL;
 359                 return -EMSGSIZE;
 360         }
 361         xdr_encode_opaque(p, NULL, len);
 362         *ptr = ++p;
 363         return count;
 364 }
 365
 366 /**
 367  * xdr_stream_encode_opaque_fixed - Encode fixed length opaque xdr data
 368  * @xdr: pointer to xdr_stream
 369  * @ptr: pointer to opaque data object
 370  * @len: size of object pointed to by @ptr
 371  *
 372  * Return values:
 373  *   On success, returns length in bytes of XDR buffer consumed
 374  *   %-EMSGSIZE on XDR buffer overflow
 375  */
 376 static inline ssize_t
 377 xdr_stream_encode_opaque_fixed(struct xdr_stream *xdr, const void *ptr, size_t len)
 378 {
 379         __be32 *p = xdr_reserve_space(xdr, len);
 380
 381         if (unlikely(!p))
 382                 return -EMSGSIZE;
 383         xdr_encode_opaque_fixed(p, ptr, len);
 384         return xdr_align_size(len);
 385 }
 386
 387 /**
 388  * xdr_stream_encode_opaque - Encode variable length opaque xdr data
 389  * @xdr: pointer to xdr_stream
 390  * @ptr: pointer to opaque data object
 391  * @len: size of object pointed to by @ptr
 392  *
 393  * Return values:
 394  *   On success, returns length in bytes of XDR buffer consumed
 395  *   %-EMSGSIZE on XDR buffer overflow
 396  */
 397 static inline ssize_t
 398 xdr_stream_encode_opaque(struct xdr_stream *xdr, const void *ptr, size_t len)
 399 {
 400         size_t count = sizeof(__u32) + xdr_align_size(len);
 401         __be32 *p = xdr_reserve_space(xdr, count);
 402
 403         if (unlikely(!p))
 404                 return -EMSGSIZE;
 405         xdr_encode_opaque(p, ptr, len);
 406         return count;
 407 }
 408
 409 /**
 410  * xdr_stream_encode_uint32_array - Encode variable length array of integers
 411  * @xdr: pointer to xdr_stream
 412  * @array: array of integers
 413  * @array_size: number of elements in @array
 414  *
 415  * Return values:
 416  *   On success, returns length in bytes of XDR buffer consumed
 417  *   %-EMSGSIZE on XDR buffer overflow
 418  */
 419 static inline ssize_t
 420 xdr_stream_encode_uint32_array(struct xdr_stream *xdr,
 421                 const __u32 *array, size_t array_size)
 422 {
 423         ssize_t ret = (array_size+1) * sizeof(__u32);
 424         __be32 *p = xdr_reserve_space(xdr, ret);
 425
 426         if (unlikely(!p))
 427                 return -EMSGSIZE;
 428         *p++ = cpu_to_be32(array_size);
 429         for (; array_size > 0; p++, array++, array_size--)
 430                 *p = cpu_to_be32p(array);
 431         return ret;
 432 }
 433
 434 /**
 435  * xdr_stream_decode_u32 - Decode a 32-bit integer
 436  * @xdr: pointer to xdr_stream
 437  * @ptr: location to store integer
 438  *
 439  * Return values:
 440  *   %0 on success
 441  *   %-EBADMSG on XDR buffer overflow
 442  */
 443 static inline ssize_t
 444 xdr_stream_decode_u32(struct xdr_stream *xdr, __u32 *ptr)
 445 {
 446         const size_t count = sizeof(*ptr);
 447         __be32 *p = xdr_inline_decode(xdr, count);
 448
 449         if (unlikely(!p))
 450                 return -EBADMSG;
 451         *ptr = be32_to_cpup(p);
 452         return 0;
 453 }
 454
 455 /**
 456  * xdr_stream_decode_opaque_fixed - Decode fixed length opaque xdr data
 457  * @xdr: pointer to xdr_stream
 458  * @ptr: location to store data
 459  * @len: size of buffer pointed to by @ptr
 460  *
 461  * Return values:
 462  *   On success, returns size of object stored in @ptr
 463  *   %-EBADMSG on XDR buffer overflow
 464  */
 465 static inline ssize_t
 466 xdr_stream_decode_opaque_fixed(struct xdr_stream *xdr, void *ptr, size_t len)
 467 {
 468         __be32 *p = xdr_inline_decode(xdr, len);
 469
 470         if (unlikely(!p))
 471                 return -EBADMSG;
 472         xdr_decode_opaque_fixed(p, ptr, len);
 473         return len;
 474 }
 475
 476 /**
 477  * xdr_stream_decode_opaque_inline - Decode variable length opaque xdr data
 478  * @xdr: pointer to xdr_stream
 479  * @ptr: location to store pointer to opaque data
 480  * @maxlen: maximum acceptable object size
 481  *
 482  * Note: the pointer stored in @ptr cannot be assumed valid after the XDR
 483  * buffer has been destroyed, or even after calling xdr_inline_decode()
 484  * on @xdr. It is therefore expected that the object it points to should
 485  * be processed immediately.
 486  *
 487  * Return values:
 488  *   On success, returns size of object stored in *@ptr
 489  *   %-EBADMSG on XDR buffer overflow
 490  *   %-EMSGSIZE if the size of the object would exceed @maxlen
 491  */
 492 static inline ssize_t
 493 xdr_stream_decode_opaque_inline(struct xdr_stream *xdr, void **ptr, size_t maxlen)
 494 {
 495         __be32 *p;
 496         __u32 len;
 497
 498         *ptr = NULL;
 499         if (unlikely(xdr_stream_decode_u32(xdr, &len) < 0))
 500                 return -EBADMSG;
 501         if (len != 0) {
 502                 p = xdr_inline_decode(xdr, len);
 503                 if (unlikely(!p))
 504                         return -EBADMSG;
 505                 if (unlikely(len > maxlen))
 506                         return -EMSGSIZE;
 507                 *ptr = p;
 508         }
 509         return len;
 510 }
 511
 512 /**
 513  * xdr_stream_decode_uint32_array - Decode variable length array of integers
 514  * @xdr: pointer to xdr_stream
 515  * @array: location to store the integer array or NULL
 516  * @array_size: number of elements to store
 517  *
 518  * Return values:
 519  *   On success, returns number of elements stored in @array
 520  *   %-EBADMSG on XDR buffer overflow
 521  *   %-EMSGSIZE if the size of the array exceeds @array_size
 522  */
 523 static inline ssize_t
 524 xdr_stream_decode_uint32_array(struct xdr_stream *xdr,
 525                 __u32 *array, size_t array_size)
 526 {
 527         __be32 *p;
 528         __u32 len;
 529         ssize_t retval;
 530
 531         if (unlikely(xdr_stream_decode_u32(xdr, &len) < 0))
 532                 return -EBADMSG;
 533         p = xdr_inline_decode(xdr, len * sizeof(*p));
 534         if (unlikely(!p))
 535                 return -EBADMSG;
 536         if (array == NULL)
 537                 return len;
 538         if (len <= array_size) {
 539                 if (len < array_size)
 540                         memset(array+len, 0, (array_size-len)*sizeof(*array));
 541                 array_size = len;
 542                 retval = len;
 543         } else
 544                 retval = -EMSGSIZE;
 545         for (; array_size > 0; p++, array++, array_size--)
 546                 *array = be32_to_cpup(p);
 547         return retval;
 548 }
 549 #endif /* __KERNEL__ */
 550
 551 #endif /* _SUNRPC_XDR_H_ */