include/rpc/xdr.h

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