xdr.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385
  1. /*
  2. * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
  3. * unrestricted use provided that this legend is included on all tape
  4. * media and as a part of the software program in whole or part. Users
  5. * may copy or modify Sun RPC without charge, but are not authorized
  6. * to license or distribute it to anyone else except as part of a product or
  7. * program developed by the user.
  8. *
  9. * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
  10. * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
  11. * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
  12. *
  13. * Sun RPC is provided with no support and without any obligation on the
  14. * part of Sun Microsystems, Inc. to assist in its use, correction,
  15. * modification or enhancement.
  16. *
  17. * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
  18. * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
  19. * OR ANY PART THEREOF.
  20. *
  21. * In no event will Sun Microsystems, Inc. be liable for any lost revenue
  22. * or profits or other special, indirect and consequential damages, even if
  23. * Sun has been advised of the possibility of such damages.
  24. *
  25. * Sun Microsystems, Inc.
  26. * 2550 Garcia Avenue
  27. * Mountain View, California 94043
  28. */
  29. /*
  30. * xdr.h, External Data Representation Serialization Routines.
  31. *
  32. * Copyright (C) 1984, Sun Microsystems, Inc.
  33. */
  34. #ifndef _RPC_XDR_H
  35. #define _RPC_XDR_H 1
  36. #ifdef _LIBC
  37. /* Some adjustments to make the libc source from glibc
  38. * compile more easily with uClibc... */
  39. # ifndef __FORCE_GLIBC
  40. # define __FORCE_GLIBC
  41. # endif
  42. # define _(X) X
  43. #endif
  44. #include <features.h>
  45. #include <sys/types.h>
  46. #include <rpc/types.h>
  47. /* We need FILE. */
  48. #include <stdio.h>
  49. __BEGIN_DECLS
  50. /*
  51. * XDR provides a conventional way for converting between C data
  52. * types and an external bit-string representation. Library supplied
  53. * routines provide for the conversion on built-in C data types. These
  54. * routines and utility routines defined here are used to help implement
  55. * a type encode/decode routine for each user-defined type.
  56. *
  57. * Each data type provides a single procedure which takes two arguments:
  58. *
  59. * bool_t
  60. * xdrproc(xdrs, argresp)
  61. * XDR *xdrs;
  62. * <type> *argresp;
  63. *
  64. * xdrs is an instance of a XDR handle, to which or from which the data
  65. * type is to be converted. argresp is a pointer to the structure to be
  66. * converted. The XDR handle contains an operation field which indicates
  67. * which of the operations (ENCODE, DECODE * or FREE) is to be performed.
  68. *
  69. * XDR_DECODE may allocate space if the pointer argresp is null. This
  70. * data can be freed with the XDR_FREE operation.
  71. *
  72. * We write only one procedure per data type to make it easy
  73. * to keep the encode and decode procedures for a data type consistent.
  74. * In many cases the same code performs all operations on a user defined type,
  75. * because all the hard work is done in the component type routines.
  76. * decode as a series of calls on the nested data types.
  77. */
  78. /*
  79. * Xdr operations. XDR_ENCODE causes the type to be encoded into the
  80. * stream. XDR_DECODE causes the type to be extracted from the stream.
  81. * XDR_FREE can be used to release the space allocated by an XDR_DECODE
  82. * request.
  83. */
  84. enum xdr_op {
  85. XDR_ENCODE = 0,
  86. XDR_DECODE = 1,
  87. XDR_FREE = 2
  88. };
  89. /*
  90. * This is the number of bytes per unit of external data.
  91. */
  92. #define BYTES_PER_XDR_UNIT (4)
  93. /*
  94. * This only works if the above is a power of 2. But it's defined to be
  95. * 4 by the appropriate RFCs. So it will work. And it's normally quicker
  96. * than the old routine.
  97. */
  98. #if 1
  99. #define RNDUP(x) (((x) + BYTES_PER_XDR_UNIT - 1) & ~(BYTES_PER_XDR_UNIT - 1))
  100. #else /* this is the old routine */
  101. #define RNDUP(x) ((((x) + BYTES_PER_XDR_UNIT - 1) / BYTES_PER_XDR_UNIT) \
  102. * BYTES_PER_XDR_UNIT)
  103. #endif
  104. /*
  105. * The XDR handle.
  106. * Contains operation which is being applied to the stream,
  107. * an operations vector for the particular implementation (e.g. see xdr_mem.c),
  108. * and two private fields for the use of the particular implementation.
  109. */
  110. typedef struct XDR XDR;
  111. struct XDR
  112. {
  113. enum xdr_op x_op; /* operation; fast additional param */
  114. struct xdr_ops
  115. {
  116. bool_t (*x_getlong) (XDR *__xdrs, long *__lp);
  117. /* get a long from underlying stream */
  118. bool_t (*x_putlong) (XDR *__xdrs, __const long *__lp);
  119. /* put a long to " */
  120. bool_t (*x_getbytes) (XDR *__xdrs, caddr_t __addr, u_int __len);
  121. /* get some bytes from " */
  122. bool_t (*x_putbytes) (XDR *__xdrs, __const char *__addr, u_int __len);
  123. /* put some bytes to " */
  124. u_int (*x_getpostn) (__const XDR *__xdrs);
  125. /* returns bytes off from beginning */
  126. bool_t (*x_setpostn) (XDR *__xdrs, u_int __pos);
  127. /* lets you reposition the stream */
  128. int32_t *(*x_inline) (XDR *__xdrs, u_int __len);
  129. /* buf quick ptr to buffered data */
  130. void (*x_destroy) (XDR *__xdrs);
  131. /* free privates of this xdr_stream */
  132. bool_t (*x_getint32) (XDR *__xdrs, int32_t *__ip);
  133. /* get a int from underlying stream */
  134. bool_t (*x_putint32) (XDR *__xdrs, __const int32_t *__ip);
  135. /* put a int to " */
  136. }
  137. *x_ops;
  138. caddr_t x_public; /* users' data */
  139. caddr_t x_private; /* pointer to private data */
  140. caddr_t x_base; /* private used for position info */
  141. u_int x_handy; /* extra private word */
  142. };
  143. /*
  144. * A xdrproc_t exists for each data type which is to be encoded or decoded.
  145. *
  146. * The second argument to the xdrproc_t is a pointer to an opaque pointer.
  147. * The opaque pointer generally points to a structure of the data type
  148. * to be decoded. If this pointer is 0, then the type routines should
  149. * allocate dynamic storage of the appropriate size and return it.
  150. * bool_t (*xdrproc_t)(XDR *, caddr_t *);
  151. */
  152. typedef bool_t (*xdrproc_t) (XDR *, void *,...);
  153. /*
  154. * Operations defined on a XDR handle
  155. *
  156. * XDR *xdrs;
  157. * int32_t *int32p;
  158. * long *longp;
  159. * caddr_t addr;
  160. * u_int len;
  161. * u_int pos;
  162. */
  163. #define XDR_GETINT32(xdrs, int32p) \
  164. (*(xdrs)->x_ops->x_getint32)(xdrs, int32p)
  165. #define xdr_getint32(xdrs, int32p) \
  166. (*(xdrs)->x_ops->x_getint32)(xdrs, int32p)
  167. #define XDR_PUTINT32(xdrs, int32p) \
  168. (*(xdrs)->x_ops->x_putint32)(xdrs, int32p)
  169. #define xdr_putint32(xdrs, int32p) \
  170. (*(xdrs)->x_ops->x_putint32)(xdrs, int32p)
  171. #define XDR_GETLONG(xdrs, longp) \
  172. (*(xdrs)->x_ops->x_getlong)(xdrs, longp)
  173. #define xdr_getlong(xdrs, longp) \
  174. (*(xdrs)->x_ops->x_getlong)(xdrs, longp)
  175. #define XDR_PUTLONG(xdrs, longp) \
  176. (*(xdrs)->x_ops->x_putlong)(xdrs, longp)
  177. #define xdr_putlong(xdrs, longp) \
  178. (*(xdrs)->x_ops->x_putlong)(xdrs, longp)
  179. #define XDR_GETBYTES(xdrs, addr, len) \
  180. (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
  181. #define xdr_getbytes(xdrs, addr, len) \
  182. (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
  183. #define XDR_PUTBYTES(xdrs, addr, len) \
  184. (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
  185. #define xdr_putbytes(xdrs, addr, len) \
  186. (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
  187. #define XDR_GETPOS(xdrs) \
  188. (*(xdrs)->x_ops->x_getpostn)(xdrs)
  189. #define xdr_getpos(xdrs) \
  190. (*(xdrs)->x_ops->x_getpostn)(xdrs)
  191. #define XDR_SETPOS(xdrs, pos) \
  192. (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
  193. #define xdr_setpos(xdrs, pos) \
  194. (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
  195. #define XDR_INLINE(xdrs, len) \
  196. (*(xdrs)->x_ops->x_inline)(xdrs, len)
  197. #define xdr_inline(xdrs, len) \
  198. (*(xdrs)->x_ops->x_inline)(xdrs, len)
  199. #define XDR_DESTROY(xdrs) \
  200. do { \
  201. if ((xdrs)->x_ops->x_destroy) \
  202. (*(xdrs)->x_ops->x_destroy)(xdrs); \
  203. } while (0)
  204. #define xdr_destroy(xdrs) \
  205. do { \
  206. if ((xdrs)->x_ops->x_destroy) \
  207. (*(xdrs)->x_ops->x_destroy)(xdrs); \
  208. } while (0)
  209. /*
  210. * Support struct for discriminated unions.
  211. * You create an array of xdrdiscrim structures, terminated with
  212. * a entry with a null procedure pointer. The xdr_union routine gets
  213. * the discriminant value and then searches the array of structures
  214. * for a matching value. If a match is found the associated xdr routine
  215. * is called to handle that part of the union. If there is
  216. * no match, then a default routine may be called.
  217. * If there is no match and no default routine it is an error.
  218. */
  219. #define NULL_xdrproc_t ((xdrproc_t)0)
  220. struct xdr_discrim
  221. {
  222. int value;
  223. xdrproc_t proc;
  224. };
  225. /*
  226. * Inline routines for fast encode/decode of primitive data types.
  227. * Caveat emptor: these use single memory cycles to get the
  228. * data from the underlying buffer, and will fail to operate
  229. * properly if the data is not aligned. The standard way to use these
  230. * is to say:
  231. * if ((buf = XDR_INLINE(xdrs, count)) == NULL)
  232. * return (FALSE);
  233. * <<< macro calls >>>
  234. * where ``count'' is the number of bytes of data occupied
  235. * by the primitive data types.
  236. *
  237. * N.B. and frozen for all time: each data type here uses 4 bytes
  238. * of external representation.
  239. */
  240. #define IXDR_GET_INT32(buf) ((int32_t)ntohl((uint32_t)*(buf)++))
  241. #define IXDR_PUT_INT32(buf, v) (*(buf)++ = (int32_t)htonl((uint32_t)(v)))
  242. #define IXDR_GET_U_INT32(buf) ((uint32_t)IXDR_GET_INT32(buf))
  243. #define IXDR_PUT_U_INT32(buf, v) IXDR_PUT_INT32(buf, (int32_t)(v))
  244. /* WARNING: The IXDR_*_LONG defines are removed by Sun for new platforms
  245. * and shouldn't be used any longer. Code which use this defines or longs
  246. * in the RPC code will not work on 64bit Solaris platforms !
  247. */
  248. #define IXDR_GET_LONG(buf) ((long)IXDR_GET_U_INT32(buf))
  249. #define IXDR_PUT_LONG(buf, v) ((long)IXDR_PUT_INT32(buf, (long)(v)))
  250. #define IXDR_GET_U_LONG(buf) ((u_long)IXDR_GET_LONG(buf))
  251. #define IXDR_PUT_U_LONG(buf, v) IXDR_PUT_LONG(buf, (long)(v))
  252. #define IXDR_GET_BOOL(buf) ((bool_t)IXDR_GET_LONG(buf))
  253. #define IXDR_GET_ENUM(buf, t) ((t)IXDR_GET_LONG(buf))
  254. #define IXDR_GET_SHORT(buf) ((short)IXDR_GET_LONG(buf))
  255. #define IXDR_GET_U_SHORT(buf) ((u_short)IXDR_GET_LONG(buf))
  256. #define IXDR_PUT_BOOL(buf, v) IXDR_PUT_LONG(buf, (long)(v))
  257. #define IXDR_PUT_ENUM(buf, v) IXDR_PUT_LONG(buf, (long)(v))
  258. #define IXDR_PUT_SHORT(buf, v) IXDR_PUT_LONG(buf, (long)(v))
  259. #define IXDR_PUT_U_SHORT(buf, v) IXDR_PUT_LONG(buf, (long)(v))
  260. /*
  261. * These are the "generic" xdr routines.
  262. * None of these can have const applied because it's not possible to
  263. * know whether the call is a read or a write to the passed parameter
  264. * also, the XDR structure is always updated by some of these calls.
  265. */
  266. extern bool_t xdr_void (void) __THROW;
  267. extern bool_t xdr_short (XDR *__xdrs, short *__sp) __THROW;
  268. extern bool_t xdr_u_short (XDR *__xdrs, u_short *__usp) __THROW;
  269. extern bool_t xdr_int (XDR *__xdrs, int *__ip) __THROW;
  270. extern bool_t xdr_u_int (XDR *__xdrs, u_int *__up) __THROW;
  271. extern bool_t xdr_long (XDR *__xdrs, long *__lp) __THROW;
  272. extern bool_t xdr_u_long (XDR *__xdrs, u_long *__ulp) __THROW;
  273. extern bool_t xdr_hyper (XDR *__xdrs, quad_t *__llp) __THROW;
  274. extern bool_t xdr_u_hyper (XDR *__xdrs, u_quad_t *__ullp) __THROW;
  275. extern bool_t xdr_longlong_t (XDR *__xdrs, quad_t *__llp) __THROW;
  276. extern bool_t xdr_u_longlong_t (XDR *__xdrs, u_quad_t *__ullp) __THROW;
  277. extern bool_t xdr_int8_t (XDR *__xdrs, int8_t *__ip) __THROW;
  278. extern bool_t xdr_uint8_t (XDR *__xdrs, uint8_t *__up) __THROW;
  279. extern bool_t xdr_int16_t (XDR *__xdrs, int16_t *__ip) __THROW;
  280. extern bool_t xdr_uint16_t (XDR *__xdrs, uint16_t *__up) __THROW;
  281. extern bool_t xdr_int32_t (XDR *__xdrs, int32_t *__ip) __THROW;
  282. extern bool_t xdr_uint32_t (XDR *__xdrs, uint32_t *__up) __THROW;
  283. extern bool_t xdr_int64_t (XDR *__xdrs, int64_t *__ip) __THROW;
  284. extern bool_t xdr_uint64_t (XDR *__xdrs, uint64_t *__up) __THROW;
  285. extern bool_t xdr_bool (XDR *__xdrs, bool_t *__bp) __THROW;
  286. extern bool_t xdr_enum (XDR *__xdrs, enum_t *__ep) __THROW;
  287. extern bool_t xdr_array (XDR * _xdrs, caddr_t *__addrp, u_int *__sizep,
  288. u_int __maxsize, u_int __elsize, xdrproc_t __elproc)
  289. __THROW;
  290. extern bool_t xdr_bytes (XDR *__xdrs, char **__cpp, u_int *__sizep,
  291. u_int __maxsize) __THROW;
  292. extern bool_t xdr_opaque (XDR *__xdrs, caddr_t __cp, u_int __cnt) __THROW;
  293. extern bool_t xdr_string (XDR *__xdrs, char **__cpp, u_int __maxsize) __THROW;
  294. extern bool_t xdr_union (XDR *__xdrs, enum_t *__dscmp, char *__unp,
  295. __const struct xdr_discrim *__choices,
  296. xdrproc_t dfault) __THROW;
  297. extern bool_t xdr_char (XDR *__xdrs, char *__cp) __THROW;
  298. extern bool_t xdr_u_char (XDR *__xdrs, u_char *__cp) __THROW;
  299. extern bool_t xdr_vector (XDR *__xdrs, char *__basep, u_int __nelem,
  300. u_int __elemsize, xdrproc_t __xdr_elem) __THROW;
  301. extern bool_t xdr_float (XDR *__xdrs, float *__fp) __THROW;
  302. extern bool_t xdr_double (XDR *__xdrs, double *__dp) __THROW;
  303. extern bool_t xdr_reference (XDR *__xdrs, caddr_t *__xpp, u_int __size,
  304. xdrproc_t __proc) __THROW;
  305. extern bool_t xdr_pointer (XDR *__xdrs, char **__objpp,
  306. u_int __obj_size, xdrproc_t __xdr_obj) __THROW;
  307. extern bool_t xdr_wrapstring (XDR *__xdrs, char **__cpp) __THROW;
  308. extern u_long xdr_sizeof (xdrproc_t, void *) __THROW;
  309. /*
  310. * Common opaque bytes objects used by many rpc protocols;
  311. * declared here due to commonality.
  312. */
  313. #define MAX_NETOBJ_SZ 1024
  314. struct netobj
  315. {
  316. u_int n_len;
  317. char *n_bytes;
  318. };
  319. typedef struct netobj netobj;
  320. extern bool_t xdr_netobj (XDR *__xdrs, struct netobj *__np) __THROW;
  321. /*
  322. * These are the public routines for the various implementations of
  323. * xdr streams.
  324. */
  325. /* XDR using memory buffers */
  326. extern void xdrmem_create (XDR *__xdrs, __const caddr_t __addr,
  327. u_int __size, enum xdr_op __xop) __THROW;
  328. /* XDR using stdio library */
  329. extern void xdrstdio_create (XDR *__xdrs, FILE *__file, enum xdr_op __xop)
  330. __THROW;
  331. /* XDR pseudo records for tcp */
  332. extern void xdrrec_create (XDR *__xdrs, u_int __sendsize,
  333. u_int __recvsize, caddr_t __tcp_handle,
  334. int (*__readit) (char *, char *, int),
  335. int (*__writeit) (char *, char *, int)) __THROW;
  336. /* make end of xdr record */
  337. extern bool_t xdrrec_endofrecord (XDR *__xdrs, bool_t __sendnow) __THROW;
  338. /* move to beginning of next record */
  339. extern bool_t xdrrec_skiprecord (XDR *__xdrs) __THROW;
  340. /* true if no more input */
  341. extern bool_t xdrrec_eof (XDR *__xdrs) __THROW;
  342. /* free memory buffers for xdr */
  343. extern void xdr_free (xdrproc_t __proc, char *__objp) __THROW;
  344. __END_DECLS
  345. #endif /* rpc/xdr.h */