xdr.h
上传用户:szlgq88
上传日期:2009-04-28
资源大小:48287k
文件大小:14k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

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