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