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 #include <linux/uio.h>
  15 #include <asm/byteorder.h>
  16 #include <asm/unaligned.h>
  17 #include <linux/scatterlist.h>
  18
  19 struct bio_vec;
  20 struct rpc_rqst;
  21
  22 /*
  23  * Buffer adjustment
  24  */
  25 #define XDR_QUADLEN(l)          (((l) + 3) >> 2)
  26
  27 /*
  28  * Generic opaque `network object.' At the kernel level, this type
  29  * is used only by lockd.
  30  */
  31 #define XDR_MAX_NETOBJ          1024
  32 struct xdr_netobj {
  33         unsigned int            len;
  34         u8 *                    data;
  35 };
  36
  37 /*
  38  * Basic structure for transmission/reception of a client XDR message.
  39  * Features a header (for a linear buffer containing RPC headers
  40  * and the data payload for short messages), and then an array of
  41  * pages.
  42  * The tail iovec allows you to append data after the page array. Its
  43  * main interest is for appending padding to the pages in order to
  44  * satisfy the int_32-alignment requirements in RFC1832.
  45  *
  46  * For the future, we might want to string several of these together
  47  * in a list if anybody wants to make use of NFSv4 COMPOUND
  48  * operations and/or has a need for scatter/gather involving pages.
  49  */
  50 struct xdr_buf {
  51         struct kvec     head[1],        /* RPC header + non-page data */
  52                         tail[1];        /* Appended after page data */
  53
  54         struct bio_vec  *bvec;
  55         struct page **  pages;          /* Array of pages */
  56         unsigned int    page_base,      /* Start of page data */
  57                         page_len,       /* Length of page data */
  58                         flags;          /* Flags for data disposition */
  59 #define XDRBUF_READ             0x01            /* target of file read */
  60 #define XDRBUF_WRITE            0x02            /* source of file write */
  61 #define XDRBUF_SPARSE_PAGES     0x04            /* Page array is sparse */
  62
  63         unsigned int    buflen,         /* Total length of storage buffer */
  64                         len;            /* Length of XDR encoded message */
  65 };
  66
  67 static inline void
  68 xdr_buf_init(struct xdr_buf *buf, void *start, size_t len)
  69 {
  70         buf->head[0].iov_base = start;
  71         buf->head[0].iov_len = len;
  72         buf->tail[0].iov_len = 0;
  73         buf->pages = NULL;
  74         buf->page_len = 0;
  75         buf->flags = 0;
  76         buf->len = 0;
  77         buf->buflen = len;
  78 }
  79
  80 /*
  81  * pre-xdr'ed macros.
  82  */
  83
  84 #define xdr_zero        cpu_to_be32(0)
  85 #define xdr_one         cpu_to_be32(1)
  86 #define xdr_two         cpu_to_be32(2)
  87
  88 #define rpc_auth_null   cpu_to_be32(RPC_AUTH_NULL)
  89 #define rpc_auth_unix   cpu_to_be32(RPC_AUTH_UNIX)
  90 #define rpc_auth_short  cpu_to_be32(RPC_AUTH_SHORT)
  91 #define rpc_auth_gss    cpu_to_be32(RPC_AUTH_GSS)
  92
  93 #define rpc_call        cpu_to_be32(RPC_CALL)
  94 #define rpc_reply       cpu_to_be32(RPC_REPLY)
  95
  96 #define rpc_msg_accepted        cpu_to_be32(RPC_MSG_ACCEPTED)
  97
  98 #define rpc_success             cpu_to_be32(RPC_SUCCESS)
  99 #define rpc_prog_unavail        cpu_to_be32(RPC_PROG_UNAVAIL)
 100 #define rpc_prog_mismatch       cpu_to_be32(RPC_PROG_MISMATCH)
 101 #define rpc_proc_unavail        cpu_to_be32(RPC_PROC_UNAVAIL)
 102 #define rpc_garbage_args        cpu_to_be32(RPC_GARBAGE_ARGS)
 103 #define rpc_system_err          cpu_to_be32(RPC_SYSTEM_ERR)
 104 #define rpc_drop_reply          cpu_to_be32(RPC_DROP_REPLY)
 105
 106 #define rpc_mismatch            cpu_to_be32(RPC_MISMATCH)
 107 #define rpc_auth_error          cpu_to_be32(RPC_AUTH_ERROR)
 108
 109 #define rpc_auth_ok             cpu_to_be32(RPC_AUTH_OK)
 110 #define rpc_autherr_badcred     cpu_to_be32(RPC_AUTH_BADCRED)
 111 #define rpc_autherr_rejectedcred cpu_to_be32(RPC_AUTH_REJECTEDCRED)
 112 #define rpc_autherr_badverf     cpu_to_be32(RPC_AUTH_BADVERF)
 113 #define rpc_autherr_rejectedverf cpu_to_be32(RPC_AUTH_REJECTEDVERF)
 114 #define rpc_autherr_tooweak     cpu_to_be32(RPC_AUTH_TOOWEAK)
 115 #define rpcsec_gsserr_credproblem       cpu_to_be32(RPCSEC_GSS_CREDPROBLEM)
 116 #define rpcsec_gsserr_ctxproblem        cpu_to_be32(RPCSEC_GSS_CTXPROBLEM)
 117
 118 /*
 119  * Miscellaneous XDR helper functions
 120  */
 121 __be32 *xdr_encode_opaque_fixed(__be32 *p, const void *ptr, unsigned int len);
 122 __be32 *xdr_encode_opaque(__be32 *p, const void *ptr, unsigned int len);
 123 __be32 *xdr_encode_string(__be32 *p, const char *s);
 124 __be32 *xdr_decode_string_inplace(__be32 *p, char **sp, unsigned int *lenp,
 125                         unsigned int maxlen);
 126 __be32 *xdr_encode_netobj(__be32 *p, const struct xdr_netobj *);
 127 __be32 *xdr_decode_netobj(__be32 *p, struct xdr_netobj *);
 128
 129 void    xdr_inline_pages(struct xdr_buf *, unsigned int,
 130                          struct page **, unsigned int, unsigned int);
 131 void    xdr_terminate_string(struct xdr_buf *, const u32);
 132 size_t  xdr_buf_pagecount(struct xdr_buf *buf);
 133 int     xdr_alloc_bvec(struct xdr_buf *buf, gfp_t gfp);
 134 void    xdr_free_bvec(struct xdr_buf *buf);
 135
 136 static inline __be32 *xdr_encode_array(__be32 *p, const void *s, unsigned int len)
 137 {
 138         return xdr_encode_opaque(p, s, len);
 139 }
 140
 141 /*
 142  * Decode 64bit quantities (NFSv3 support)
 143  */
 144 static inline __be32 *
 145 xdr_encode_hyper(__be32 *p, __u64 val)
 146 {
 147         put_unaligned_be64(val, p);
 148         return p + 2;
 149 }
 150
 151 static inline __be32 *
 152 xdr_decode_hyper(__be32 *p, __u64 *valp)
 153 {
 154         *valp = get_unaligned_be64(p);
 155         return p + 2;
 156 }
 157
 158 static inline __be32 *
 159 xdr_decode_opaque_fixed(__be32 *p, void *ptr, unsigned int len)
 160 {
 161         memcpy(ptr, p, len);
 162         return p + XDR_QUADLEN(len);
 163 }
 164
 165 static inline void xdr_netobj_dup(struct xdr_netobj *dst,
 166                                   struct xdr_netobj *src, gfp_t gfp_mask)
 167 {
 168         dst->data = kmemdup(src->data, src->len, gfp_mask);
 169         dst->len = src->len;
 170 }
 171
 172 /*
 173  * Adjust kvec to reflect end of xdr'ed data (RPC client XDR)
 174  */
 175 static inline int
 176 xdr_adjust_iovec(struct kvec *iov, __be32 *p)
 177 {
 178         return iov->iov_len = ((u8 *) p - (u8 *) iov->iov_base);
 179 }
 180
 181 /*
 182  * XDR buffer helper functions
 183  */
 184 extern void xdr_shift_buf(struct xdr_buf *, size_t);
 185 extern void xdr_buf_from_iov(struct kvec *, struct xdr_buf *);
 186 extern int xdr_buf_subsegment(const struct xdr_buf *buf, struct xdr_buf *subbuf,
 187                               unsigned int base, unsigned int len);
 188 extern void xdr_buf_trim(struct xdr_buf *, unsigned int);
 189 extern int read_bytes_from_xdr_buf(struct xdr_buf *, unsigned int, void *, unsigned int);
 190 extern int write_bytes_to_xdr_buf(struct xdr_buf *, unsigned int, void *, unsigned int);
 191
 192 extern int xdr_encode_word(struct xdr_buf *, unsigned int, u32);
 193 extern int xdr_decode_word(struct xdr_buf *, unsigned int, u32 *);
 194
 195 struct xdr_array2_desc;
 196 typedef int (*xdr_xcode_elem_t)(struct xdr_array2_desc *desc, void *elem);
 197 struct xdr_array2_desc {
 198         unsigned int elem_size;
 199         unsigned int array_len;
 200         unsigned int array_maxlen;
 201         xdr_xcode_elem_t xcode;
 202 };
 203
 204 extern int xdr_decode_array2(struct xdr_buf *buf, unsigned int base,
 205                              struct xdr_array2_desc *desc);
 206 extern int xdr_encode_array2(struct xdr_buf *buf, unsigned int base,
 207                              struct xdr_array2_desc *desc);
 208 extern void _copy_from_pages(char *p, struct page **pages, size_t pgbase,
 209                              size_t len);
 210
 211 /*
 212  * Provide some simple tools for XDR buffer overflow-checking etc.
 213  */
 214 struct xdr_stream {
 215         __be32 *p;              /* start of available buffer */
 216         struct xdr_buf *buf;    /* XDR buffer to read/write */
 217
 218         __be32 *end;            /* end of available buffer space */
 219         struct kvec *iov;       /* pointer to the current kvec */
 220         struct kvec scratch;    /* Scratch buffer */
 221         struct page **page_ptr; /* pointer to the current page */
 222         unsigned int nwords;    /* Remaining decode buffer length */
 223
 224         struct rpc_rqst *rqst;  /* For debugging */
 225 };
 226
 227 /*
 228  * These are the xdr_stream style generic XDR encode and decode functions.
 229  */
 230 typedef void    (*kxdreproc_t)(struct rpc_rqst *rqstp, struct xdr_stream *xdr,
 231                 const void *obj);
 232 typedef int     (*kxdrdproc_t)(struct rpc_rqst *rqstp, struct xdr_stream *xdr,
 233                 void *obj);
 234
 235 extern void xdr_init_encode(struct xdr_stream *xdr, struct xdr_buf *buf,
 236                             __be32 *p, struct rpc_rqst *rqst);
 237 extern __be32 *xdr_reserve_space(struct xdr_stream *xdr, size_t nbytes);
 238 extern int xdr_reserve_space_vec(struct xdr_stream *xdr, struct kvec *vec,
 239                 size_t nbytes);
 240 extern void xdr_commit_encode(struct xdr_stream *xdr);
 241 extern void xdr_truncate_encode(struct xdr_stream *xdr, size_t len);
 242 extern int xdr_restrict_buflen(struct xdr_stream *xdr, int newbuflen);
 243 extern void xdr_write_pages(struct xdr_stream *xdr, struct page **pages,
 244                 unsigned int base, unsigned int len);
 245 extern unsigned int xdr_stream_pos(const struct xdr_stream *xdr);
 246 extern unsigned int xdr_page_pos(const struct xdr_stream *xdr);
 247 extern void xdr_init_decode(struct xdr_stream *xdr, struct xdr_buf *buf,
 248                             __be32 *p, struct rpc_rqst *rqst);
 249 extern void xdr_init_decode_pages(struct xdr_stream *xdr, struct xdr_buf *buf,
 250                 struct page **pages, unsigned int len);
 251 extern __be32 *xdr_inline_decode(struct xdr_stream *xdr, size_t nbytes);
 252 extern unsigned int xdr_read_pages(struct xdr_stream *xdr, unsigned int len);
 253 extern void xdr_enter_page(struct xdr_stream *xdr, unsigned int len);
 254 extern int xdr_process_buf(struct xdr_buf *buf, unsigned int offset, unsigned int len, int (*actor)(struct scatterlist *, void *), void *data);
 255 extern uint64_t xdr_align_data(struct xdr_stream *, uint64_t, uint32_t);
 256 extern uint64_t xdr_expand_hole(struct xdr_stream *, uint64_t, uint64_t);
 257 extern bool xdr_stream_subsegment(struct xdr_stream *xdr, struct xdr_buf *subbuf,
 258                                   unsigned int len);
 259
 260 /**
 261  * xdr_set_scratch_buffer - Attach a scratch buffer for decoding data.
 262  * @xdr: pointer to xdr_stream struct
 263  * @buf: pointer to an empty buffer
 264  * @buflen: size of 'buf'
 265  *
 266  * The scratch buffer is used when decoding from an array of pages.
 267  * If an xdr_inline_decode() call spans across page boundaries, then
 268  * we copy the data into the scratch buffer in order to allow linear
 269  * access.
 270  */
 271 static inline void
 272 xdr_set_scratch_buffer(struct xdr_stream *xdr, void *buf, size_t buflen)
 273 {
 274         xdr->scratch.iov_base = buf;
 275         xdr->scratch.iov_len = buflen;
 276 }
 277
 278 /**
 279  * xdr_set_scratch_page - Attach a scratch buffer for decoding data
 280  * @xdr: pointer to xdr_stream struct
 281  * @page: an anonymous page
 282  *
 283  * See xdr_set_scratch_buffer().
 284  */
 285 static inline void
 286 xdr_set_scratch_page(struct xdr_stream *xdr, struct page *page)
 287 {
 288         xdr_set_scratch_buffer(xdr, page_address(page), PAGE_SIZE);
 289 }
 290
 291 /**
 292  * xdr_reset_scratch_buffer - Clear scratch buffer information
 293  * @xdr: pointer to xdr_stream struct
 294  *
 295  * See xdr_set_scratch_buffer().
 296  */
 297 static inline void
 298 xdr_reset_scratch_buffer(struct xdr_stream *xdr)
 299 {
 300         xdr_set_scratch_buffer(xdr, NULL, 0);
 301 }
 302
 303 /**
 304  * xdr_stream_remaining - Return the number of bytes remaining in the stream
 305  * @xdr: pointer to struct xdr_stream
 306  *
 307  * Return value:
 308  *   Number of bytes remaining in @xdr before xdr->end
 309  */
 310 static inline size_t
 311 xdr_stream_remaining(const struct xdr_stream *xdr)
 312 {
 313         return xdr->nwords << 2;
 314 }
 315
 316 ssize_t xdr_stream_decode_opaque(struct xdr_stream *xdr, void *ptr,
 317                 size_t size);
 318 ssize_t xdr_stream_decode_opaque_dup(struct xdr_stream *xdr, void **ptr,
 319                 size_t maxlen, gfp_t gfp_flags);
 320 ssize_t xdr_stream_decode_string(struct xdr_stream *xdr, char *str,
 321                 size_t size);
 322 ssize_t xdr_stream_decode_string_dup(struct xdr_stream *xdr, char **str,
 323                 size_t maxlen, gfp_t gfp_flags);
 324 /**
 325  * xdr_align_size - Calculate padded size of an object
 326  * @n: Size of an object being XDR encoded (in bytes)
 327  *
 328  * Return value:
 329  *   Size (in bytes) of the object including xdr padding
 330  */
 331 static inline size_t
 332 xdr_align_size(size_t n)
 333 {
 334         const size_t mask = sizeof(__u32) - 1;
 335
 336         return (n + mask) & ~mask;
 337 }
 338
 339 /**
 340  * xdr_pad_size - Calculate size of an object's pad
 341  * @n: Size of an object being XDR encoded (in bytes)
 342  *
 343  * This implementation avoids the need for conditional
 344  * branches or modulo division.
 345  *
 346  * Return value:
 347  *   Size (in bytes) of the needed XDR pad
 348  */
 349 static inline size_t xdr_pad_size(size_t n)
 350 {
 351         return xdr_align_size(n) - n;
 352 }
 353
 354 /**
 355  * xdr_stream_encode_item_present - Encode a "present" list item
 356  * @xdr: pointer to xdr_stream
 357  *
 358  * Return values:
 359  *   On success, returns length in bytes of XDR buffer consumed
 360  *   %-EMSGSIZE on XDR buffer overflow
 361  */
 362 static inline ssize_t xdr_stream_encode_item_present(struct xdr_stream *xdr)
 363 {
 364         const size_t len = sizeof(__be32);
 365         __be32 *p = xdr_reserve_space(xdr, len);
 366
 367         if (unlikely(!p))
 368                 return -EMSGSIZE;
 369         *p = xdr_one;
 370         return len;
 371 }
 372
 373 /**
 374  * xdr_stream_encode_item_absent - Encode a "not present" list item
 375  * @xdr: pointer to xdr_stream
 376  *
 377  * Return values:
 378  *   On success, returns length in bytes of XDR buffer consumed
 379  *   %-EMSGSIZE on XDR buffer overflow
 380  */
 381 static inline int xdr_stream_encode_item_absent(struct xdr_stream *xdr)
 382 {
 383         const size_t len = sizeof(__be32);
 384         __be32 *p = xdr_reserve_space(xdr, len);
 385
 386         if (unlikely(!p))
 387                 return -EMSGSIZE;
 388         *p = xdr_zero;
 389         return len;
 390 }
 391
 392 /**
 393  * xdr_stream_encode_u32 - Encode a 32-bit integer
 394  * @xdr: pointer to xdr_stream
 395  * @n: integer to encode
 396  *
 397  * Return values:
 398  *   On success, returns length in bytes of XDR buffer consumed
 399  *   %-EMSGSIZE on XDR buffer overflow
 400  */
 401 static inline ssize_t
 402 xdr_stream_encode_u32(struct xdr_stream *xdr, __u32 n)
 403 {
 404         const size_t len = sizeof(n);
 405         __be32 *p = xdr_reserve_space(xdr, len);
 406
 407         if (unlikely(!p))
 408                 return -EMSGSIZE;
 409         *p = cpu_to_be32(n);
 410         return len;
 411 }
 412
 413 /**
 414  * xdr_stream_encode_u64 - Encode a 64-bit integer
 415  * @xdr: pointer to xdr_stream
 416  * @n: 64-bit integer to encode
 417  *
 418  * Return values:
 419  *   On success, returns length in bytes of XDR buffer consumed
 420  *   %-EMSGSIZE on XDR buffer overflow
 421  */
 422 static inline ssize_t
 423 xdr_stream_encode_u64(struct xdr_stream *xdr, __u64 n)
 424 {
 425         const size_t len = sizeof(n);
 426         __be32 *p = xdr_reserve_space(xdr, len);
 427
 428         if (unlikely(!p))
 429                 return -EMSGSIZE;
 430         xdr_encode_hyper(p, n);
 431         return len;
 432 }
 433
 434 /**
 435  * xdr_stream_encode_opaque_inline - Encode opaque xdr data
 436  * @xdr: pointer to xdr_stream
 437  * @ptr: pointer to void pointer
 438  * @len: size of object
 439  *
 440  * Return values:
 441  *   On success, returns length in bytes of XDR buffer consumed
 442  *   %-EMSGSIZE on XDR buffer overflow
 443  */
 444 static inline ssize_t
 445 xdr_stream_encode_opaque_inline(struct xdr_stream *xdr, void **ptr, size_t len)
 446 {
 447         size_t count = sizeof(__u32) + xdr_align_size(len);
 448         __be32 *p = xdr_reserve_space(xdr, count);
 449
 450         if (unlikely(!p)) {
 451                 *ptr = NULL;
 452                 return -EMSGSIZE;
 453         }
 454         xdr_encode_opaque(p, NULL, len);
 455         *ptr = ++p;
 456         return count;
 457 }
 458
 459 /**
 460  * xdr_stream_encode_opaque_fixed - Encode fixed length opaque xdr data
 461  * @xdr: pointer to xdr_stream
 462  * @ptr: pointer to opaque data object
 463  * @len: size of object pointed to by @ptr
 464  *
 465  * Return values:
 466  *   On success, returns length in bytes of XDR buffer consumed
 467  *   %-EMSGSIZE on XDR buffer overflow
 468  */
 469 static inline ssize_t
 470 xdr_stream_encode_opaque_fixed(struct xdr_stream *xdr, const void *ptr, size_t len)
 471 {
 472         __be32 *p = xdr_reserve_space(xdr, len);
 473
 474         if (unlikely(!p))
 475                 return -EMSGSIZE;
 476         xdr_encode_opaque_fixed(p, ptr, len);
 477         return xdr_align_size(len);
 478 }
 479
 480 /**
 481  * xdr_stream_encode_opaque - Encode variable length opaque xdr data
 482  * @xdr: pointer to xdr_stream
 483  * @ptr: pointer to opaque data object
 484  * @len: size of object pointed to by @ptr
 485  *
 486  * Return values:
 487  *   On success, returns length in bytes of XDR buffer consumed
 488  *   %-EMSGSIZE on XDR buffer overflow
 489  */
 490 static inline ssize_t
 491 xdr_stream_encode_opaque(struct xdr_stream *xdr, const void *ptr, size_t len)
 492 {
 493         size_t count = sizeof(__u32) + xdr_align_size(len);
 494         __be32 *p = xdr_reserve_space(xdr, count);
 495
 496         if (unlikely(!p))
 497                 return -EMSGSIZE;
 498         xdr_encode_opaque(p, ptr, len);
 499         return count;
 500 }
 501
 502 /**
 503  * xdr_stream_encode_uint32_array - Encode variable length array of integers
 504  * @xdr: pointer to xdr_stream
 505  * @array: array of integers
 506  * @array_size: number of elements in @array
 507  *
 508  * Return values:
 509  *   On success, returns length in bytes of XDR buffer consumed
 510  *   %-EMSGSIZE on XDR buffer overflow
 511  */
 512 static inline ssize_t
 513 xdr_stream_encode_uint32_array(struct xdr_stream *xdr,
 514                 const __u32 *array, size_t array_size)
 515 {
 516         ssize_t ret = (array_size+1) * sizeof(__u32);
 517         __be32 *p = xdr_reserve_space(xdr, ret);
 518
 519         if (unlikely(!p))
 520                 return -EMSGSIZE;
 521         *p++ = cpu_to_be32(array_size);
 522         for (; array_size > 0; p++, array++, array_size--)
 523                 *p = cpu_to_be32p(array);
 524         return ret;
 525 }
 526
 527 /**
 528  * xdr_item_is_absent - symbolically handle XDR discriminators
 529  * @p: pointer to undecoded discriminator
 530  *
 531  * Return values:
 532  *   %true if the following XDR item is absent
 533  *   %false if the following XDR item is present
 534  */
 535 static inline bool xdr_item_is_absent(const __be32 *p)
 536 {
 537         return *p == xdr_zero;
 538 }
 539
 540 /**
 541  * xdr_item_is_present - symbolically handle XDR discriminators
 542  * @p: pointer to undecoded discriminator
 543  *
 544  * Return values:
 545  *   %true if the following XDR item is present
 546  *   %false if the following XDR item is absent
 547  */
 548 static inline bool xdr_item_is_present(const __be32 *p)
 549 {
 550         return *p != xdr_zero;
 551 }
 552
 553 /**
 554  * xdr_stream_decode_bool - Decode a boolean
 555  * @xdr: pointer to xdr_stream
 556  * @ptr: pointer to a u32 in which to store the result
 557  *
 558  * Return values:
 559  *   %0 on success
 560  *   %-EBADMSG on XDR buffer overflow
 561  */
 562 static inline ssize_t
 563 xdr_stream_decode_bool(struct xdr_stream *xdr, __u32 *ptr)
 564 {
 565         const size_t count = sizeof(*ptr);
 566         __be32 *p = xdr_inline_decode(xdr, count);
 567
 568         if (unlikely(!p))
 569                 return -EBADMSG;
 570         *ptr = (*p != xdr_zero);
 571         return 0;
 572 }
 573
 574 /**
 575  * xdr_stream_decode_u32 - Decode a 32-bit integer
 576  * @xdr: pointer to xdr_stream
 577  * @ptr: location to store integer
 578  *
 579  * Return values:
 580  *   %0 on success
 581  *   %-EBADMSG on XDR buffer overflow
 582  */
 583 static inline ssize_t
 584 xdr_stream_decode_u32(struct xdr_stream *xdr, __u32 *ptr)
 585 {
 586         const size_t count = sizeof(*ptr);
 587         __be32 *p = xdr_inline_decode(xdr, count);
 588
 589         if (unlikely(!p))
 590                 return -EBADMSG;
 591         *ptr = be32_to_cpup(p);
 592         return 0;
 593 }
 594
 595 /**
 596  * xdr_stream_decode_u64 - Decode a 64-bit integer
 597  * @xdr: pointer to xdr_stream
 598  * @ptr: location to store 64-bit integer
 599  *
 600  * Return values:
 601  *   %0 on success
 602  *   %-EBADMSG on XDR buffer overflow
 603  */
 604 static inline ssize_t
 605 xdr_stream_decode_u64(struct xdr_stream *xdr, __u64 *ptr)
 606 {
 607         const size_t count = sizeof(*ptr);
 608         __be32 *p = xdr_inline_decode(xdr, count);
 609
 610         if (unlikely(!p))
 611                 return -EBADMSG;
 612         xdr_decode_hyper(p, ptr);
 613         return 0;
 614 }
 615
 616 /**
 617  * xdr_stream_decode_opaque_fixed - Decode fixed length opaque xdr data
 618  * @xdr: pointer to xdr_stream
 619  * @ptr: location to store data
 620  * @len: size of buffer pointed to by @ptr
 621  *
 622  * Return values:
 623  *   On success, returns size of object stored in @ptr
 624  *   %-EBADMSG on XDR buffer overflow
 625  */
 626 static inline ssize_t
 627 xdr_stream_decode_opaque_fixed(struct xdr_stream *xdr, void *ptr, size_t len)
 628 {
 629         __be32 *p = xdr_inline_decode(xdr, len);
 630
 631         if (unlikely(!p))
 632                 return -EBADMSG;
 633         xdr_decode_opaque_fixed(p, ptr, len);
 634         return len;
 635 }
 636
 637 /**
 638  * xdr_stream_decode_opaque_inline - Decode variable length opaque xdr data
 639  * @xdr: pointer to xdr_stream
 640  * @ptr: location to store pointer to opaque data
 641  * @maxlen: maximum acceptable object size
 642  *
 643  * Note: the pointer stored in @ptr cannot be assumed valid after the XDR
 644  * buffer has been destroyed, or even after calling xdr_inline_decode()
 645  * on @xdr. It is therefore expected that the object it points to should
 646  * be processed immediately.
 647  *
 648  * Return values:
 649  *   On success, returns size of object stored in *@ptr
 650  *   %-EBADMSG on XDR buffer overflow
 651  *   %-EMSGSIZE if the size of the object would exceed @maxlen
 652  */
 653 static inline ssize_t
 654 xdr_stream_decode_opaque_inline(struct xdr_stream *xdr, void **ptr, size_t maxlen)
 655 {
 656         __be32 *p;
 657         __u32 len;
 658
 659         *ptr = NULL;
 660         if (unlikely(xdr_stream_decode_u32(xdr, &len) < 0))
 661                 return -EBADMSG;
 662         if (len != 0) {
 663                 p = xdr_inline_decode(xdr, len);
 664                 if (unlikely(!p))
 665                         return -EBADMSG;
 666                 if (unlikely(len > maxlen))
 667                         return -EMSGSIZE;
 668                 *ptr = p;
 669         }
 670         return len;
 671 }
 672
 673 /**
 674  * xdr_stream_decode_uint32_array - Decode variable length array of integers
 675  * @xdr: pointer to xdr_stream
 676  * @array: location to store the integer array or NULL
 677  * @array_size: number of elements to store
 678  *
 679  * Return values:
 680  *   On success, returns number of elements stored in @array
 681  *   %-EBADMSG on XDR buffer overflow
 682  *   %-EMSGSIZE if the size of the array exceeds @array_size
 683  */
 684 static inline ssize_t
 685 xdr_stream_decode_uint32_array(struct xdr_stream *xdr,
 686                 __u32 *array, size_t array_size)
 687 {
 688         __be32 *p;
 689         __u32 len;
 690         ssize_t retval;
 691
 692         if (unlikely(xdr_stream_decode_u32(xdr, &len) < 0))
 693                 return -EBADMSG;
 694         p = xdr_inline_decode(xdr, len * sizeof(*p));
 695         if (unlikely(!p))
 696                 return -EBADMSG;
 697         if (array == NULL)
 698                 return len;
 699         if (len <= array_size) {
 700                 if (len < array_size)
 701                         memset(array+len, 0, (array_size-len)*sizeof(*array));
 702                 array_size = len;
 703                 retval = len;
 704         } else
 705                 retval = -EMSGSIZE;
 706         for (; array_size > 0; p++, array++, array_size--)
 707                 *array = be32_to_cpup(p);
 708         return retval;
 709 }
 710
 711 #endif /* _SUNRPC_XDR_H_ */