include/rpc/xdr.h

   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 <features.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) __P ((XDR *__xdrs, long *__lp));
 118         /* get a long from underlying stream */
 119         bool_t (*x_putlong) __P ((XDR *__xdrs, __const long *__lp));
 120         /* put a long to " */
 121         bool_t (*x_getbytes) __P ((XDR *__xdrs, caddr_t __addr,
 122                                      u_int __len));
 123         /* get some bytes from " */
 124         bool_t (*x_putbytes) __P ((XDR *__xdrs, __const char *__addr,
 125                                      u_int __len));
 126         /* put some bytes to " */
 127         u_int (*x_getpostn) __P ((__const XDR *__xdrs));
 128         /* returns bytes off from beginning */
 129         bool_t (*x_setpostn) __P ((XDR *__xdrs, u_int pos));
 130         /* lets you reposition the stream */
 131         int32_t *(*x_inline) __P ((XDR *__xdrs, int len));
 132         /* buf quick ptr to buffered data */
 133         void (*x_destroy) __P ((XDR *__xdrs));
 134         /* free privates of this xdr_stream */
 135         bool_t (*x_getint32) __P ((XDR *__xdrs, int32_t *__ip));
 136         /* get a int from underlying stream */
 137         bool_t (*x_putint32) __P ((XDR *__xdrs, __const int32_t *__ip));
 138         /* put a int to " */
 139       }
 140      *x_ops;
 141     caddr_t x_public;           /* users' data */
 142     caddr_t x_private;          /* pointer to private data */
 143     caddr_t x_base;             /* private used for position info */
 144     int x_handy;                /* extra private word */
 145   };
 146
 147 /*
 148  * A xdrproc_t exists for each data type which is to be encoded or decoded.
 149  *
 150  * The second argument to the xdrproc_t is a pointer to an opaque pointer.
 151  * The opaque pointer generally points to a structure of the data type
 152  * to be decoded.  If this pointer is 0, then the type routines should
 153  * allocate dynamic storage of the appropriate size and return it.
 154  * bool_t       (*xdrproc_t)(XDR *, caddr_t *);
 155  */
 156 typedef bool_t (*xdrproc_t) __P ((XDR *, void *,...));
 157
 158
 159 /*
 160  * Operations defined on a XDR handle
 161  *
 162  * XDR          *xdrs;
 163  * int32_t      *int32p;
 164  * long         *longp;
 165  * caddr_t       addr;
 166  * u_int         len;
 167  * u_int         pos;
 168  */
 169 #define XDR_GETINT32(xdrs, int32p)                      \
 170         (*(xdrs)->x_ops->x_getint32)(xdrs, int32p)
 171 #define xdr_getint32(xdrs, int32p)                      \
 172         (*(xdrs)->x_ops->x_getint32)(xdrs, int32p)
 173
 174 #define XDR_PUTINT32(xdrs, int32p)                      \
 175         (*(xdrs)->x_ops->x_putint32)(xdrs, int32p)
 176 #define xdr_putint32(xdrs, int32p)                      \
 177         (*(xdrs)->x_ops->x_putint32)(xdrs, int32p)
 178
 179 #define XDR_GETLONG(xdrs, longp)                        \
 180         (*(xdrs)->x_ops->x_getlong)(xdrs, longp)
 181 #define xdr_getlong(xdrs, longp)                        \
 182         (*(xdrs)->x_ops->x_getlong)(xdrs, longp)
 183
 184 #define XDR_PUTLONG(xdrs, longp)                        \
 185         (*(xdrs)->x_ops->x_putlong)(xdrs, longp)
 186 #define xdr_putlong(xdrs, longp)                        \
 187         (*(xdrs)->x_ops->x_putlong)(xdrs, longp)
 188
 189 #define XDR_GETBYTES(xdrs, addr, len)                   \
 190         (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
 191 #define xdr_getbytes(xdrs, addr, len)                   \
 192         (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
 193
 194 #define XDR_PUTBYTES(xdrs, addr, len)                   \
 195         (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
 196 #define xdr_putbytes(xdrs, addr, len)                   \
 197         (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
 198
 199 #define XDR_GETPOS(xdrs)                                \
 200         (*(xdrs)->x_ops->x_getpostn)(xdrs)
 201 #define xdr_getpos(xdrs)                                \
 202         (*(xdrs)->x_ops->x_getpostn)(xdrs)
 203
 204 #define XDR_SETPOS(xdrs, pos)                           \
 205         (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
 206 #define xdr_setpos(xdrs, pos)                           \
 207         (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
 208
 209 #define XDR_INLINE(xdrs, len)                           \
 210         (*(xdrs)->x_ops->x_inline)(xdrs, len)
 211 #define xdr_inline(xdrs, len)                           \
 212         (*(xdrs)->x_ops->x_inline)(xdrs, len)
 213
 214 #define XDR_DESTROY(xdrs)                                       \
 215         do {                                                    \
 216                 if ((xdrs)->x_ops->x_destroy)                   \
 217                         (*(xdrs)->x_ops->x_destroy)(xdrs);      \
 218         } while (0)
 219 #define xdr_destroy(xdrs)                                       \
 220         do {                                                    \
 221                 if ((xdrs)->x_ops->x_destroy)                   \
 222                         (*(xdrs)->x_ops->x_destroy)(xdrs);      \
 223         } while (0)
 224
 225 /*
 226  * Support struct for discriminated unions.
 227  * You create an array of xdrdiscrim structures, terminated with
 228  * a entry with a null procedure pointer.  The xdr_union routine gets
 229  * the discriminant value and then searches the array of structures
 230  * for a matching value.  If a match is found the associated xdr routine
 231  * is called to handle that part of the union.  If there is
 232  * no match, then a default routine may be called.
 233  * If there is no match and no default routine it is an error.
 234  */
 235 #define NULL_xdrproc_t ((xdrproc_t)0)
 236 struct xdr_discrim
 237 {
 238   int value;
 239   xdrproc_t proc;
 240 };
 241
 242 /*
 243  * Inline routines for fast encode/decode of primitive data types.
 244  * Caveat emptor: these use single memory cycles to get the
 245  * data from the underlying buffer, and will fail to operate
 246  * properly if the data is not aligned.  The standard way to use these
 247  * is to say:
 248  *      if ((buf = XDR_INLINE(xdrs, count)) == NULL)
 249  *              return (FALSE);
 250  *      <<< macro calls >>>
 251  * where ``count'' is the number of bytes of data occupied
 252  * by the primitive data types.
 253  *
 254  * N.B. and frozen for all time: each data type here uses 4 bytes
 255  * of external representation.
 256  */
 257
 258 #define IXDR_GET_INT32(buf)           ((int32_t)ntohl((uint32_t)*(buf)++))
 259 #define IXDR_PUT_INT32(buf, v)        (*(buf)++ = (int32_t)htonl((uint32_t)(v)))
 260 #define IXDR_GET_U_INT32(buf)         ((uint32_t)IXDR_GET_INT32(buf))
 261 #define IXDR_PUT_U_INT32(buf, v)      IXDR_PUT_INT32(buf, (int32_t)(v))
 262
 263 /* WARNING: The IXDR_*_LONG defines are removed by Sun for new platforms
 264  * and shouldn't be used any longer. Code which use this defines or longs
 265  * in the RPC code will not work on 64bit Solaris platforms !
 266  */
 267 #define IXDR_GET_LONG(buf) \
 268         ((long)ntohl((u_long)*__extension__((u_int32_t*)(buf))++))
 269 #define IXDR_PUT_LONG(buf, v) \
 270         (*__extension__((u_int32_t*)(buf))++ = (long)htonl((u_long)(v)))
 271 #define IXDR_GET_U_LONG(buf)          ((u_long)IXDR_GET_LONG(buf))
 272 #define IXDR_PUT_U_LONG(buf, v)       IXDR_PUT_LONG(buf, (long)(v))
 273
 274
 275 #define IXDR_GET_BOOL(buf)            ((bool_t)IXDR_GET_LONG(buf))
 276 #define IXDR_GET_ENUM(buf, t)         ((t)IXDR_GET_LONG(buf))
 277 #define IXDR_GET_SHORT(buf)           ((short)IXDR_GET_LONG(buf))
 278 #define IXDR_GET_U_SHORT(buf)         ((u_short)IXDR_GET_LONG(buf))
 279
 280 #define IXDR_PUT_BOOL(buf, v)         IXDR_PUT_LONG(buf, (long)(v))
 281 #define IXDR_PUT_ENUM(buf, v)         IXDR_PUT_LONG(buf, (long)(v))
 282 #define IXDR_PUT_SHORT(buf, v)        IXDR_PUT_LONG(buf, (long)(v))
 283 #define IXDR_PUT_U_SHORT(buf, v)      IXDR_PUT_LONG(buf, (long)(v))
 284
 285 /*
 286  * These are the "generic" xdr routines.
 287  * None of these can have const applied because it's not possible to
 288  * know whether the call is a read or a write to the passed parameter
 289  * also, the XDR structure is always updated by some of these calls.
 290  */
 291 extern bool_t xdr_void __P ((void));
 292 extern bool_t xdr_short __P ((XDR *__xdrs, short *__sp));
 293 extern bool_t xdr_u_short __P ((XDR *__xdrs, u_short *__usp));
 294 extern bool_t xdr_int __P ((XDR *__xdrs, int *__ip));
 295 extern bool_t xdr_u_int __P ((XDR *__xdrs, u_int *__up));
 296 extern bool_t xdr_long __P ((XDR *__xdrs, long *__lp));
 297 extern bool_t xdr_u_long __P ((XDR *__xdrs, u_long *__ulp));
 298 extern bool_t xdr_hyper __P ((XDR *__xdrs, quad_t *__llp));
 299 extern bool_t xdr_u_hyper __P ((XDR *__xdrs, u_quad_t *__ullp));
 300 extern bool_t xdr_longlong_t __P ((XDR *__xdrs, quad_t *__llp));
 301 extern bool_t xdr_u_longlong_t __P ((XDR *__xdrs, u_quad_t *__ullp));
 302 extern bool_t xdr_int8_t __P ((XDR *__xdrs, int8_t *__ip));
 303 extern bool_t xdr_uint8_t __P ((XDR *__xdrs, uint8_t *__up));
 304 extern bool_t xdr_int16_t __P ((XDR *__xdrs, int16_t *__ip));
 305 extern bool_t xdr_uint16_t __P ((XDR *__xdrs, uint16_t *__up));
 306 extern bool_t xdr_int32_t __P ((XDR *__xdrs, int32_t *__ip));
 307 extern bool_t xdr_uint32_t __P ((XDR *__xdrs, uint32_t *__up));
 308 extern bool_t xdr_int64_t __P ((XDR *__xdrs, int64_t *__ip));
 309 extern bool_t xdr_uint64_t __P ((XDR *__xdrs, uint64_t *__up));
 310 extern bool_t xdr_bool __P ((XDR *__xdrs, bool_t *__bp));
 311 extern bool_t xdr_enum __P ((XDR *__xdrs, enum_t *__ep));
 312 extern bool_t xdr_array __P ((XDR * _xdrs, caddr_t *__addrp, u_int *__sizep,
 313                               u_int __maxsize, u_int __elsize,
 314                               xdrproc_t __elproc));
 315 extern bool_t xdr_bytes __P ((XDR *__xdrs, char **__cpp, u_int *__sizep,
 316                               u_int __maxsize));
 317 extern bool_t xdr_opaque __P ((XDR *__xdrs, caddr_t __cp, u_int __cnt));
 318 extern bool_t xdr_string __P ((XDR *__xdrs, char **__cpp, u_int __maxsize));
 319 extern bool_t xdr_union __P ((XDR *__xdrs, enum_t *__dscmp, char *__unp,
 320                               __const struct xdr_discrim *__choices,
 321                               xdrproc_t dfault));
 322 extern bool_t xdr_char __P ((XDR *__xdrs, char *__cp));
 323 extern bool_t xdr_u_char __P ((XDR *__xdrs, u_char *__cp));
 324 extern bool_t xdr_vector __P ((XDR *__xdrs, char *__basep, u_int __nelem,
 325                                u_int __elemsize, xdrproc_t __xdr_elem));
 326 extern bool_t xdr_float __P ((XDR *__xdrs, float *__fp));
 327 extern bool_t xdr_double __P ((XDR *__xdrs, double *__dp));
 328 extern bool_t xdr_reference __P ((XDR *__xdrs, caddr_t *__xpp, u_int __size,
 329                                   xdrproc_t __proc));
 330 extern bool_t xdr_pointer __P ((XDR *__xdrs, char **__objpp,
 331                                 u_int __obj_size, xdrproc_t __xdr_obj));
 332 extern bool_t xdr_wrapstring __P ((XDR *__xdrs, char **__cpp));
 333 extern u_long xdr_sizeof __P ((xdrproc_t, void *));
 334
 335 /*
 336  * Common opaque bytes objects used by many rpc protocols;
 337  * declared here due to commonality.
 338  */
 339 #define MAX_NETOBJ_SZ 1024
 340 struct netobj
 341 {
 342   u_int n_len;
 343   char *n_bytes;
 344 };
 345 typedef struct netobj netobj;
 346 extern bool_t xdr_netobj __P ((XDR *__xdrs, struct netobj *__np));
 347
 348 /*
 349  * These are the public routines for the various implementations of
 350  * xdr streams.
 351  */
 352
 353 /* XDR using memory buffers */
 354 extern void xdrmem_create __P ((XDR *__xdrs, __const caddr_t __addr,
 355                                 u_int __size, enum xdr_op __xop));
 356
 357 /* XDR using stdio library */
 358 extern void xdrstdio_create __P ((XDR *__xdrs, FILE *__file,
 359                                   enum xdr_op __xop));
 360
 361 /* XDR pseudo records for tcp */
 362 extern void xdrrec_create __P ((XDR *__xdrs, u_int __sendsize,
 363                                 u_int __recvsize, caddr_t __tcp_handle,
 364                                 int (*__readit) (char *, char *, int),
 365                                 int (*__writeit) (char *, char *, int)));
 366
 367 /* make end of xdr record */
 368 extern bool_t xdrrec_endofrecord __P ((XDR *__xdrs, bool_t __sendnow));
 369
 370 /* move to beginning of next record */
 371 extern bool_t xdrrec_skiprecord __P ((XDR *__xdrs));
 372
 373 /* true if no more input */
 374 extern bool_t xdrrec_eof __P ((XDR *__xdrs));
 375
 376 /* free memory buffers for xdr */
 377 extern void xdr_free __P ((xdrproc_t __proc, char *__objp));
 378
 379 __END_DECLS
 380
 381 #endif /* rpc/xdr.h */