include/gssrpc/xdr.h

0001 /* @(#)xdr.h    2.2 88/07/29 4.0 RPCSRC */
0002 /*
0003  * Copyright (c) 2010, Oracle America, Inc.
0004  *
0005  * All rights reserved.
0006  *
0007  * Redistribution and use in source and binary forms, with or without
0008  * modification, are permitted provided that the following conditions are met:
0009  *
0010  *     * Redistributions of source code must retain the above copyright
0011  *       notice, this list of conditions and the following disclaimer.
0012  *
0013  *     * Redistributions in binary form must reproduce the above copyright
0014  *       notice, this list of conditions and the following disclaimer in
0015  *       the documentation and/or other materials provided with the
0016  *       distribution.
0017  *
0018  *     * Neither the name of the "Oracle America, Inc." nor the names of
0019  *       its contributors may be used to endorse or promote products
0020  *       derived from this software without specific prior written permission.
0021  *
0022  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
0023  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
0024  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
0025  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0026  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0027  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
0028  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
0029  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
0030  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
0031  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
0032  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0033  */
0034 /*      @(#)xdr.h 1.19 87/04/22 SMI      */
0035
0036 /*
0037  * xdr.h, External Data Representation Serialization Routines.
0038  */
0039
0040 #ifndef GSSRPC_XDR_H
0041 #define GSSRPC_XDR_H
0042
0043 #include <stdio.h>      /* for FILE */
0044
0045 GSSRPC__BEGIN_DECLS
0046 /*
0047  * XDR provides a conventional way for converting between C data
0048  * types and an external bit-string representation.  Library supplied
0049  * routines provide for the conversion on built-in C data types.  These
0050  * routines and utility routines defined here are used to help implement
0051  * a type encode/decode routine for each user-defined type.
0052  *
0053  * Each data type provides a single procedure which takes two arguments:
0054  *
0055  *  bool_t
0056  *  xdrproc(xdrs, argresp)
0057  *      XDR *xdrs;
0058  *      <type> *argresp;
0059  *
0060  * xdrs is an instance of a XDR handle, to which or from which the data
0061  * type is to be converted.  argresp is a pointer to the structure to be
0062  * converted.  The XDR handle contains an operation field which indicates
0063  * which of the operations (ENCODE, DECODE * or FREE) is to be performed.
0064  *
0065  * XDR_DECODE may allocate space if the pointer argresp is null.  This
0066  * data can be freed with the XDR_FREE operation.
0067  *
0068  * We write only one procedure per data type to make it easy
0069  * to keep the encode and decode procedures for a data type consistent.
0070  * In many cases the same code performs all operations on a user defined type,
0071  * because all the hard work is done in the component type routines.
0072  * decode as a series of calls on the nested data types.
0073  */
0074
0075 /*
0076  * Xdr operations.  XDR_ENCODE causes the type to be encoded into the
0077  * stream.  XDR_DECODE causes the type to be extracted from the stream.
0078  * XDR_FREE can be used to release the space allocated by an XDR_DECODE
0079  * request.
0080  */
0081 enum xdr_op {
0082     XDR_ENCODE=0,
0083     XDR_DECODE=1,
0084     XDR_FREE=2
0085 };
0086
0087 /*
0088  * This is the number of bytes per unit of external data.
0089  */
0090 #define BYTES_PER_XDR_UNIT  (4)
0091 #define RNDUP(x)  ((((x) + BYTES_PER_XDR_UNIT - 1) / BYTES_PER_XDR_UNIT) \
0092             * BYTES_PER_XDR_UNIT)
0093
0094 /*
0095  * A xdrproc_t exists for each data type which is to be encoded or decoded.
0096  *
0097  * The second argument to the xdrproc_t is a pointer to an opaque pointer.
0098  * The opaque pointer generally points to a structure of the data type
0099  * to be decoded.  If this pointer is 0, then the type routines should
0100  * allocate dynamic storage of the appropriate size and return it.
0101  * bool_t   (*xdrproc_t)(XDR *, caddr_t *);
0102  *
0103  * XXX can't actually prototype it, because some take three args!!!
0104  */
0105
0106 /*
0107  * The XDR handle.
0108  * Contains operation which is being applied to the stream,
0109  * an operations vector for the particular implementation (e.g. see xdr_mem.c),
0110  * and two private fields for the use of the particular impelementation.
0111  */
0112 typedef struct XDR {
0113     enum xdr_op x_op;       /* operation; fast additional param */
0114     struct xdr_ops {
0115         /* get a long from underlying stream */
0116         bool_t  (*x_getlong)(struct XDR *, long *);
0117
0118         /* put a long to underlying stream */
0119         bool_t  (*x_putlong)(struct XDR *, long *);
0120
0121         /* get some bytes from underlying stream */
0122         bool_t  (*x_getbytes)(struct XDR *, caddr_t, u_int);
0123
0124         /* put some bytes to underlying stream */
0125         bool_t  (*x_putbytes)(struct XDR *, caddr_t, u_int);
0126
0127         /* returns bytes off from beginning */
0128         u_int   (*x_getpostn)(struct XDR *);
0129
0130         /* lets you reposition the stream */
0131         bool_t  (*x_setpostn)(struct XDR *, u_int);
0132
0133         /* buf quick ptr to buffered data */
0134         rpc_inline_t *(*x_inline)(struct XDR *, int);
0135
0136         /* free privates of this xdr_stream */
0137         void    (*x_destroy)(struct XDR *);
0138     } *x_ops;
0139     caddr_t     x_public;   /* users' data */
0140     void *      x_private;  /* pointer to private data */
0141     caddr_t     x_base;     /* private used for position info */
0142     int     x_handy;    /* extra private word */
0143 } XDR;
0144
0145 typedef bool_t (*xdrproc_t)(XDR *, void *);
0146
0147 /*
0148  * Operations defined on a XDR handle
0149  *
0150  * XDR      *xdrs;
0151  * int32_t  *longp;
0152  * caddr_t   addr;
0153  * u_int     len;
0154  * u_int     pos;
0155  */
0156 #define XDR_GETLONG(xdrs, longp)            \
0157     (*(xdrs)->x_ops->x_getlong)(xdrs, longp)
0158 #define xdr_getlong(xdrs, longp)            \
0159     (*(xdrs)->x_ops->x_getlong)(xdrs, longp)
0160
0161 #define XDR_PUTLONG(xdrs, longp)            \
0162     (*(xdrs)->x_ops->x_putlong)(xdrs, longp)
0163 #define xdr_putlong(xdrs, longp)            \
0164     (*(xdrs)->x_ops->x_putlong)(xdrs, longp)
0165
0166 #define XDR_GETBYTES(xdrs, addr, len)           \
0167     (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
0168 #define xdr_getbytes(xdrs, addr, len)           \
0169     (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
0170
0171 #define XDR_PUTBYTES(xdrs, addr, len)           \
0172     (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
0173 #define xdr_putbytes(xdrs, addr, len)           \
0174     (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
0175
0176 #define XDR_GETPOS(xdrs)                \
0177     (*(xdrs)->x_ops->x_getpostn)(xdrs)
0178 #define xdr_getpos(xdrs)                \
0179     (*(xdrs)->x_ops->x_getpostn)(xdrs)
0180
0181 #define XDR_SETPOS(xdrs, pos)               \
0182     (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
0183 #define xdr_setpos(xdrs, pos)               \
0184     (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
0185
0186 #define XDR_INLINE(xdrs, len)               \
0187     (*(xdrs)->x_ops->x_inline)(xdrs, len)
0188 #define xdr_inline(xdrs, len)               \
0189     (*(xdrs)->x_ops->x_inline)(xdrs, len)
0190
0191 #define XDR_DESTROY(xdrs)               \
0192     if ((xdrs)->x_ops->x_destroy)           \
0193         (*(xdrs)->x_ops->x_destroy)(xdrs)
0194 #define xdr_destroy(xdrs)               \
0195     if ((xdrs)->x_ops->x_destroy)           \
0196         (*(xdrs)->x_ops->x_destroy)(xdrs)
0197
0198 /*
0199  * Support struct for discriminated unions.
0200  * You create an array of xdrdiscrim structures, terminated with
0201  * a entry with a null procedure pointer.  The xdr_union routine gets
0202  * the discriminant value and then searches the array of structures
0203  * for a matching value.  If a match is found the associated xdr routine
0204  * is called to handle that part of the union.  If there is
0205  * no match, then a default routine may be called.
0206  * If there is no match and no default routine it is an error.
0207  */
0208 #define NULL_xdrproc_t ((xdrproc_t)0)
0209 struct xdr_discrim {
0210     int value;
0211     xdrproc_t proc;
0212 };
0213
0214 /*
0215  * In-line routines for fast encode/decode of primitive data types.
0216  * Caveat emptor: these use single memory cycles to get the
0217  * data from the underlying buffer, and will fail to operate
0218  * properly if the data is not aligned.  The standard way to use these
0219  * is to say:
0220  *  if ((buf = XDR_INLINE(xdrs, count)) == NULL)
0221  *      return (FALSE);
0222  *  <<< macro calls >>>
0223  * where ``count'' is the number of bytes of data occupied
0224  * by the primitive data types.
0225  *
0226  * N.B. and frozen for all time: each data type here uses 4 bytes
0227  * of external representation.
0228  */
0229 #define IXDR_GET_INT32(buf)     ((int32_t)IXDR_GET_U_INT32(buf))
0230 #define IXDR_PUT_INT32(buf, v)      IXDR_PUT_U_INT32((buf),((uint32_t)(v)))
0231 #define IXDR_GET_U_INT32(buf)       (ntohl((uint32_t)*(buf)++))
0232 #define IXDR_PUT_U_INT32(buf, v)    (*(buf)++ = (int32_t)htonl((v)))
0233
0234 #define IXDR_GET_LONG(buf)      ((long)IXDR_GET_INT32(buf))
0235 #define IXDR_PUT_LONG(buf, v)       IXDR_PUT_U_INT32((buf),((uint32_t)(v)))
0236
0237 #define IXDR_GET_BOOL(buf)      ((bool_t)IXDR_GET_LONG(buf))
0238 #define IXDR_GET_ENUM(buf, t)       ((t)IXDR_GET_INT32(buf))
0239 #define IXDR_GET_U_LONG(buf)        ((u_long)IXDR_GET_U_INT32(buf))
0240 #define IXDR_GET_SHORT(buf)     ((short)IXDR_GET_INT32(buf))
0241 #define IXDR_GET_U_SHORT(buf)       ((u_short)IXDR_GET_U_INT32(buf))
0242
0243 #define IXDR_PUT_BOOL(buf, v)       IXDR_PUT_INT32((buf),((int32_t)(v)))
0244 #define IXDR_PUT_ENUM(buf, v)       IXDR_PUT_INT32((buf),((int32_t)(v)))
0245 #define IXDR_PUT_U_LONG(buf, v)     IXDR_PUT_U_INT32((buf),((uint32_t)(v)))
0246 #define IXDR_PUT_SHORT(buf, v)      IXDR_PUT_INT32((buf),((int32_t)(v)))
0247 #define IXDR_PUT_U_SHORT(buf, v)    IXDR_PUT_U_INT32((buf),((uint32_t)(v)))
0248
0249 /*
0250  * These are the "generic" xdr routines.
0251  */
0252 extern bool_t   xdr_void(XDR *, void *);
0253 extern bool_t   xdr_int(XDR *, int *);
0254 extern bool_t   xdr_u_int(XDR *, u_int *);
0255 extern bool_t   xdr_long(XDR *, long *);
0256 extern bool_t   xdr_u_long(XDR *, u_long *);
0257 extern bool_t   xdr_short(XDR *, short *);
0258 extern bool_t   xdr_u_short(XDR *, u_short *);
0259 extern bool_t   xdr_bool(XDR *, bool_t *);
0260 extern bool_t   xdr_enum(XDR *, enum_t *);
0261 extern bool_t   xdr_array(XDR *, caddr_t *, u_int *,
0262             u_int, u_int, xdrproc_t);
0263 extern bool_t   xdr_bytes(XDR *, char **, u_int *, u_int);
0264 extern bool_t   xdr_opaque(XDR *, caddr_t, u_int);
0265 extern bool_t   xdr_string(XDR *, char **, u_int);
0266 extern bool_t   xdr_union(XDR *, enum_t *, char *, struct xdr_discrim *,
0267             xdrproc_t);
0268 extern bool_t   xdr_char(XDR *, char *);
0269 extern bool_t   xdr_u_char(XDR *, u_char *);
0270 extern bool_t   xdr_vector(XDR *, char *, u_int, u_int, xdrproc_t);
0271 extern bool_t   xdr_float(XDR *, float *);
0272 extern bool_t   xdr_double(XDR *, double *);
0273 extern bool_t   xdr_reference(XDR *, caddr_t *, u_int, xdrproc_t);
0274 extern bool_t   xdr_pointer(XDR *, char **, u_int, xdrproc_t);
0275 extern bool_t   xdr_wrapstring(XDR *, char **);
0276
0277 extern unsigned long xdr_sizeof(xdrproc_t, void *);
0278
0279 #define xdr_rpcprog xdr_u_int32
0280 #define xdr_rpcvers xdr_u_int32
0281 #define xdr_rpcprot xdr_u_int32
0282 #define xdr_rpcproc xdr_u_int32
0283 #define xdr_rpcport xdr_u_int32
0284
0285 /*
0286  * Common opaque bytes objects used by many rpc protocols;
0287  * declared here due to commonality.
0288  */
0289 #define MAX_NETOBJ_SZ 2048
0290 struct netobj {
0291     u_int   n_len;
0292     char    *n_bytes;
0293 };
0294 typedef struct netobj netobj;
0295
0296 extern bool_t   xdr_netobj(XDR *, struct netobj *);
0297
0298 extern bool_t   xdr_int32(XDR *, int32_t *);
0299 extern bool_t   xdr_u_int32(XDR *, uint32_t *);
0300
0301 /*
0302  * These are the public routines for the various implementations of
0303  * xdr streams.
0304  */
0305
0306 /* XDR allocating memory buffer */
0307 extern void xdralloc_create(XDR *, enum xdr_op);
0308
0309 /* destroy xdralloc, save buf */
0310 extern void xdralloc_release(XDR *);
0311
0312 /* get buffer from xdralloc */
0313 extern caddr_t  xdralloc_getdata(XDR *);
0314
0315 /* XDR using memory buffers */
0316 extern void xdrmem_create(XDR *, caddr_t, u_int, enum xdr_op);
0317
0318 /* XDR using stdio library */
0319 extern void xdrstdio_create(XDR *, FILE *, enum xdr_op);
0320
0321 /* XDR pseudo records for tcp */
0322 extern void xdrrec_create(XDR *xdrs, u_int, u_int, caddr_t,
0323             int (*) (caddr_t, caddr_t, int),
0324             int (*) (caddr_t, caddr_t, int));
0325
0326 /* make end of xdr record */
0327 extern bool_t   xdrrec_endofrecord(XDR *, bool_t);
0328
0329 /* move to beginning of next record */
0330 extern bool_t   xdrrec_skiprecord (XDR *xdrs);
0331
0332 /* true if no more input */
0333 extern bool_t   xdrrec_eof (XDR *xdrs);
0334
0335 /* free memory buffers for xdr */
0336 extern void xdr_free (xdrproc_t, void *);
0337 GSSRPC__END_DECLS
0338
0339 #endif /* !defined(GSSRPC_XDR_H) */