xdr.h 6.9 KB

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