xdr.h 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205
  1. /*
  2. * include/linux/sunrpc/xdr.h
  3. *
  4. * Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de>
  5. */
  6. #ifndef _SUNRPC_XDR_H_
  7. #define _SUNRPC_XDR_H_
  8. #ifdef __KERNEL__
  9. #include <linux/uio.h>
  10. #include <asm/byteorder.h>
  11. #include <linux/scatterlist.h>
  12. /*
  13. * Buffer adjustment
  14. */
  15. #define XDR_QUADLEN(l) (((l) + 3) >> 2)
  16. /*
  17. * Generic opaque `network object.' At the kernel level, this type
  18. * is used only by lockd.
  19. */
  20. #define XDR_MAX_NETOBJ 1024
  21. struct xdr_netobj {
  22. unsigned int len;
  23. u8 * data;
  24. };
  25. /*
  26. * This is the generic XDR function. rqstp is either a rpc_rqst (client
  27. * side) or svc_rqst pointer (server side).
  28. * Encode functions always assume there's enough room in the buffer.
  29. */
  30. typedef int (*kxdrproc_t)(void *rqstp, __be32 *data, void *obj);
  31. /*
  32. * Basic structure for transmission/reception of a client XDR message.
  33. * Features a header (for a linear buffer containing RPC headers
  34. * and the data payload for short messages), and then an array of
  35. * pages.
  36. * The tail iovec allows you to append data after the page array. Its
  37. * main interest is for appending padding to the pages in order to
  38. * satisfy the int_32-alignment requirements in RFC1832.
  39. *
  40. * For the future, we might want to string several of these together
  41. * in a list if anybody wants to make use of NFSv4 COMPOUND
  42. * operations and/or has a need for scatter/gather involving pages.
  43. */
  44. struct xdr_buf {
  45. struct kvec head[1], /* RPC header + non-page data */
  46. tail[1]; /* Appended after page data */
  47. struct page ** pages; /* Array of contiguous pages */
  48. unsigned int page_base, /* Start of page data */
  49. page_len; /* Length of page data */
  50. unsigned int buflen, /* Total length of storage buffer */
  51. len; /* Length of XDR encoded message */
  52. };
  53. /*
  54. * pre-xdr'ed macros.
  55. */
  56. #define xdr_zero __constant_htonl(0)
  57. #define xdr_one __constant_htonl(1)
  58. #define xdr_two __constant_htonl(2)
  59. #define rpc_success __constant_htonl(RPC_SUCCESS)
  60. #define rpc_prog_unavail __constant_htonl(RPC_PROG_UNAVAIL)
  61. #define rpc_prog_mismatch __constant_htonl(RPC_PROG_MISMATCH)
  62. #define rpc_proc_unavail __constant_htonl(RPC_PROC_UNAVAIL)
  63. #define rpc_garbage_args __constant_htonl(RPC_GARBAGE_ARGS)
  64. #define rpc_system_err __constant_htonl(RPC_SYSTEM_ERR)
  65. #define rpc_drop_reply __constant_htonl(RPC_DROP_REPLY)
  66. #define rpc_auth_ok __constant_htonl(RPC_AUTH_OK)
  67. #define rpc_autherr_badcred __constant_htonl(RPC_AUTH_BADCRED)
  68. #define rpc_autherr_rejectedcred __constant_htonl(RPC_AUTH_REJECTEDCRED)
  69. #define rpc_autherr_badverf __constant_htonl(RPC_AUTH_BADVERF)
  70. #define rpc_autherr_rejectedverf __constant_htonl(RPC_AUTH_REJECTEDVERF)
  71. #define rpc_autherr_tooweak __constant_htonl(RPC_AUTH_TOOWEAK)
  72. #define rpcsec_gsserr_credproblem __constant_htonl(RPCSEC_GSS_CREDPROBLEM)
  73. #define rpcsec_gsserr_ctxproblem __constant_htonl(RPCSEC_GSS_CTXPROBLEM)
  74. #define rpc_autherr_oldseqnum __constant_htonl(101)
  75. /*
  76. * Miscellaneous XDR helper functions
  77. */
  78. __be32 *xdr_encode_opaque_fixed(__be32 *p, const void *ptr, unsigned int len);
  79. __be32 *xdr_encode_opaque(__be32 *p, const void *ptr, unsigned int len);
  80. __be32 *xdr_encode_string(__be32 *p, const char *s);
  81. __be32 *xdr_decode_string_inplace(__be32 *p, char **sp, int *lenp, int maxlen);
  82. __be32 *xdr_encode_netobj(__be32 *p, const struct xdr_netobj *);
  83. __be32 *xdr_decode_netobj(__be32 *p, struct xdr_netobj *);
  84. void xdr_encode_pages(struct xdr_buf *, struct page **, unsigned int,
  85. unsigned int);
  86. void xdr_inline_pages(struct xdr_buf *, unsigned int,
  87. struct page **, unsigned int, unsigned int);
  88. static inline __be32 *xdr_encode_array(__be32 *p, const void *s, unsigned int len)
  89. {
  90. return xdr_encode_opaque(p, s, len);
  91. }
  92. /*
  93. * Decode 64bit quantities (NFSv3 support)
  94. */
  95. static inline __be32 *
  96. xdr_encode_hyper(__be32 *p, __u64 val)
  97. {
  98. *p++ = htonl(val >> 32);
  99. *p++ = htonl(val & 0xFFFFFFFF);
  100. return p;
  101. }
  102. static inline __be32 *
  103. xdr_decode_hyper(__be32 *p, __u64 *valp)
  104. {
  105. *valp = ((__u64) ntohl(*p++)) << 32;
  106. *valp |= ntohl(*p++);
  107. return p;
  108. }
  109. /*
  110. * Adjust kvec to reflect end of xdr'ed data (RPC client XDR)
  111. */
  112. static inline int
  113. xdr_adjust_iovec(struct kvec *iov, __be32 *p)
  114. {
  115. return iov->iov_len = ((u8 *) p - (u8 *) iov->iov_base);
  116. }
  117. /*
  118. * XDR buffer helper functions
  119. */
  120. extern void xdr_shift_buf(struct xdr_buf *, size_t);
  121. extern void xdr_buf_from_iov(struct kvec *, struct xdr_buf *);
  122. extern int xdr_buf_subsegment(struct xdr_buf *, struct xdr_buf *, unsigned int, unsigned int);
  123. extern int xdr_buf_read_netobj(struct xdr_buf *, struct xdr_netobj *, unsigned int);
  124. extern int read_bytes_from_xdr_buf(struct xdr_buf *, unsigned int, void *, unsigned int);
  125. extern int write_bytes_to_xdr_buf(struct xdr_buf *, unsigned int, void *, unsigned int);
  126. /*
  127. * Helper structure for copying from an sk_buff.
  128. */
  129. struct xdr_skb_reader {
  130. struct sk_buff *skb;
  131. unsigned int offset;
  132. size_t count;
  133. __wsum csum;
  134. };
  135. typedef size_t (*xdr_skb_read_actor)(struct xdr_skb_reader *desc, void *to, size_t len);
  136. size_t xdr_skb_read_bits(struct xdr_skb_reader *desc, void *to, size_t len);
  137. extern int csum_partial_copy_to_xdr(struct xdr_buf *, struct sk_buff *);
  138. extern ssize_t xdr_partial_copy_from_skb(struct xdr_buf *, unsigned int,
  139. struct xdr_skb_reader *, xdr_skb_read_actor);
  140. extern int xdr_encode_word(struct xdr_buf *, unsigned int, u32);
  141. extern int xdr_decode_word(struct xdr_buf *, unsigned int, u32 *);
  142. struct xdr_array2_desc;
  143. typedef int (*xdr_xcode_elem_t)(struct xdr_array2_desc *desc, void *elem);
  144. struct xdr_array2_desc {
  145. unsigned int elem_size;
  146. unsigned int array_len;
  147. unsigned int array_maxlen;
  148. xdr_xcode_elem_t xcode;
  149. };
  150. extern int xdr_decode_array2(struct xdr_buf *buf, unsigned int base,
  151. struct xdr_array2_desc *desc);
  152. extern int xdr_encode_array2(struct xdr_buf *buf, unsigned int base,
  153. struct xdr_array2_desc *desc);
  154. /*
  155. * Provide some simple tools for XDR buffer overflow-checking etc.
  156. */
  157. struct xdr_stream {
  158. __be32 *p; /* start of available buffer */
  159. struct xdr_buf *buf; /* XDR buffer to read/write */
  160. __be32 *end; /* end of available buffer space */
  161. struct kvec *iov; /* pointer to the current kvec */
  162. };
  163. extern void xdr_init_encode(struct xdr_stream *xdr, struct xdr_buf *buf, __be32 *p);
  164. extern __be32 *xdr_reserve_space(struct xdr_stream *xdr, size_t nbytes);
  165. extern void xdr_write_pages(struct xdr_stream *xdr, struct page **pages,
  166. unsigned int base, unsigned int len);
  167. extern void xdr_init_decode(struct xdr_stream *xdr, struct xdr_buf *buf, __be32 *p);
  168. extern __be32 *xdr_inline_decode(struct xdr_stream *xdr, size_t nbytes);
  169. extern void xdr_read_pages(struct xdr_stream *xdr, unsigned int len);
  170. extern void xdr_enter_page(struct xdr_stream *xdr, unsigned int len);
  171. extern int xdr_process_buf(struct xdr_buf *buf, unsigned int offset, unsigned int len, int (*actor)(struct scatterlist *, void *), void *data);
  172. #endif /* __KERNEL__ */
  173. #endif /* _SUNRPC_XDR_H_ */