Subversion Repositories Kolibri OS

Rev

Go to most recent revision | Blame | Last modification | View Log | Download | RSS feed

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