tirpc/rpc/xdr.h

/*	$NetBSD: xdr.h,v 1.19 2000/07/17 05:00:45 matt Exp $	*/

/*
 * Copyright (c) 2009, Sun Microsystems, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * - Neither the name of Sun Microsystems, Inc. nor the names of its
 *   contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 *	from: @(#)xdr.h 1.19 87/04/22 SMI
 *	from: @(#)xdr.h	2.2 88/07/29 4.0 RPCSRC
 * $FreeBSD: src/include/rpc/xdr.h,v 1.23 2003/03/07 13:19:40 nectar Exp $
 */

/*
 * xdr.h, External Data Representation Serialization Routines.
 *
 * Copyright (C) 1984, Sun Microsystems, Inc.
 */

#ifndef _TIRPC_XDR_H
#define _TIRPC_XDR_H

#include <sys/cdefs.h>
#include <misc/stdio.h>
#include <stdbool.h>
#if !defined(_WIN32)
#include <netinet/in.h>
#endif
#include <rpc/types.h>

/*
 * XDR provides a conventional way for converting between C data
 * types and an external bit-string representation.  Library supplied
 * routines provide for the conversion on built-in C data types.  These
 * routines and utility routines defined here are used to help implement
 * a type encode/decode routine for each user-defined type.
 *
 * Each data type provides a single procedure which takes two arguments:
 *
 *	bool
 *	xdrproc(xdrs, argresp)
 *		XDR *xdrs;
 *		<type> *argresp;
 *
 * xdrs is an instance of a XDR handle, to which or from which the data
 * type is to be converted.  argresp is a pointer to the structure to be
 * converted.  The XDR handle contains an operation field which indicates
 * which of the operations (ENCODE, DECODE * or FREE) is to be performed.
 *
 * XDR_DECODE may allocate space if the pointer argresp is null.  This
 * data can be freed with the XDR_FREE operation.
 *
 * We write only one procedure per data type to make it easy
 * to keep the encode and decode procedures for a data type consistent.
 * In many cases the same code performs all operations on a user defined type,
 * because all the hard work is done in the component type routines.
 * decode as a series of calls on the nested data types.
 */

/*
 * Xdr operations.  XDR_ENCODE causes the type to be encoded into the
 * stream.  XDR_DECODE causes the type to be extracted from the stream.
 * XDR_FREE can be used to release the space allocated by an XDR_DECODE
 * request.
 */
enum xdr_op {
    XDR_ENCODE=0,
    XDR_DECODE=1,
    XDR_FREE=2
};

/*
 * This is the number of bytes per unit of external data.
 */
#define BYTES_PER_XDR_UNIT (4)
/* Taken verbatim from a system xdr.h, which carries a BSD-style
 * license (Matt) */
/*
 * This only works if the above is a power of 2.  But it's defined to be
 * 4 by the appropriate RFCs.  So it will work.  And it's normally quicker
 * than the old routine.
 */
#if 1
#define RNDUP(x)  (((x) + BYTES_PER_XDR_UNIT - 1) & ~(BYTES_PER_XDR_UNIT - 1))
#else /* this is the old routine */
#define RNDUP(x)  ((((x) + BYTES_PER_XDR_UNIT - 1) / BYTES_PER_XDR_UNIT) \
                   * BYTES_PER_XDR_UNIT)
#endif

#define XBS_FLAG_NONE   0x0000
#define XBS_FLAG_GIFT   0x0001

/* XDR buffer descriptors. */
typedef struct rpc_buffer {
    void *xb_base;
    int   xb_len;
    u_int xb_flags;
    void *xb_p1; /* XDR private data */
    void *xb_u1; /* User data */
} xdr_buffer;

typedef struct rpc_buffers {
    xdr_buffer *xbs_buf; /* array of buffers */
    int         xbs_cnt; /* count of buffers */
    size_t      xbs_offset; /* not used (yet) */
    size_t      xbs_resid; /* residual bytes */
    u_int       xbs_flags;
    void       *xbs_p1;
    void       *xbs_u1;
} xdr_uio;

/* Op flags */
#define XDR_PUTBUFS_FLAG_NONE   0x0000
#define XDR_PUTBUFS_FLAG_BRELE  0x0001

/*
 * The XDR handle.
 * Contains operation which is being applied to the stream,
 * an operations vector for the particular implementation (e.g. see xdr_mem.c),
 * and two private fields for the use of the particular implementation.
 */
typedef struct rpc_xdr {
    enum xdr_op x_op;  /* operation; fast additional param */
    const struct xdr_ops {
        /* get a long from underlying stream */
        bool (*x_getlong)(struct rpc_xdr *, long *);
        /* put a long to " */
        bool (*x_putlong)(struct rpc_xdr *, const long *);
        /* get some bytes from " */
        bool (*x_getbytes)(struct rpc_xdr *, char *, u_int);
        /* put some bytes to " */
        bool (*x_putbytes)(struct rpc_xdr *, const char *, u_int);
        /* returns bytes off from beginning */
        u_int (*x_getpostn)(struct rpc_xdr *);
        /* lets you reposition the stream */
        bool (*x_setpostn)(struct rpc_xdr *, u_int);
        /* buf quick ptr to buffered data */
        int32_t *(*x_inline)(struct rpc_xdr *, u_int);
        /* free private resources of this xdr_stream */
        void (*x_destroy)(struct rpc_xdr *);
        bool (*x_control)(struct rpc_xdr *, int, void *);
        /* new vector and refcounted interfaces */
        bool (*x_getbufs)(struct rpc_xdr *, xdr_uio *, u_int, u_int);
        bool (*x_putbufs)(struct rpc_xdr *, xdr_uio *, u_int);
    } *x_ops;
    void *x_public; /* users' data */
    void *x_private; /* pointer to private data */
    void *x_lib[2]; /* RPC library private */
    void *x_base;  /* private used for position info */
    u_int x_handy; /* extra private word */
} XDR;

/*
 * A xdrproc_t exists for each data type which is to be encoded or decoded.
 *
 * The second argument to the xdrproc_t is a pointer to an opaque pointer.
 * The opaque pointer generally points to a structure of the data type
 * to be decoded.  If this pointer is 0, then the type routines should
 * allocate dynamic storage of the appropriate size and return it.
 */
#ifdef _KERNEL
typedef bool (*xdrproc_t)(XDR *, void *, u_int);
#else
/*
 * XXX can't actually prototype it, because some take three args!!!
 */
typedef bool (*xdrproc_t)(XDR *, ...);
#endif

/*
 * Operations defined on a XDR handle
 *
 * XDR  *xdrs;
 * long  *longp;
 * char *  addr;
 * u_int  len;
 * u_int  pos;
 */
#define XDR_GETLONG(xdrs, longp)   \
    (*(xdrs)->x_ops->x_getlong)(xdrs, longp)
#define xdr_getlong(xdrs, longp)   \
    (*(xdrs)->x_ops->x_getlong)(xdrs, longp)

#define XDR_PUTLONG(xdrs, longp)   \
    (*(xdrs)->x_ops->x_putlong)(xdrs, longp)
#define xdr_putlong(xdrs, longp)   \
    (*(xdrs)->x_ops->x_putlong)(xdrs, longp)

static __inline int
xdr_getint32(XDR *xdrs, int32_t *ip)
{
    long l;

    if (!xdr_getlong(xdrs, &l))
        return (FALSE);
    *ip = (int32_t)l;
    return (TRUE);
}

static __inline int
xdr_putint32(XDR *xdrs, int32_t *ip)
{
    long l;

    l = (long)*ip;
    return xdr_putlong(xdrs, &l);
}

#define XDR_GETINT32(xdrs, int32p) xdr_getint32(xdrs, int32p)
#define XDR_PUTINT32(xdrs, int32p) xdr_putint32(xdrs, int32p)

#define XDR_GETBYTES(xdrs, addr, len)   \
    (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
#define xdr_getbytes(xdrs, addr, len)   \
    (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)

#define XDR_PUTBYTES(xdrs, addr, len)   \
    (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
#define xdr_putbytes(xdrs, addr, len)   \
    (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)

#define XDR_GETBUFS(xdrs, uio, len, flags) \
    (*(xdrs)->x_ops->x_getbufs)(xdrs, uio, len, flags)
#define xdr_getbufs(xdrs, uio, len, flags) \
    (*(xdrs)->x_ops->x_getbufs)(xdrs, uio, len, flags)

#define XDR_PUTBUFS(xdrs, uio, len, flags) \
    (*(xdrs)->x_ops->x_putbufs)(xdrs, uio, len, flags)
#define xdr_putbufs(xdrs, uio, len, flags) \
    (*(xdrs)->x_ops->x_putbufs)(xdrs, uio, len, flags)

#define XDR_GETPOS(xdrs)                        \
    (*(xdrs)->x_ops->x_getpostn)(xdrs)
#define xdr_getpos(xdrs)                        \
    (*(xdrs)->x_ops->x_getpostn)(xdrs)

#define XDR_SETPOS(xdrs, pos)                   \
    (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
#define xdr_setpos(xdrs, pos)                   \
    (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)

#define XDR_INLINE(xdrs, len)                   \
    (*(xdrs)->x_ops->x_inline)(xdrs, len)
#define xdr_inline(xdrs, len)                   \
    (*(xdrs)->x_ops->x_inline)(xdrs, len)

#define XDR_DESTROY(xdrs)    \
    if ((xdrs)->x_ops->x_destroy)    \
        (*(xdrs)->x_ops->x_destroy)(xdrs)
#define xdr_destroy(xdrs)    \
    if ((xdrs)->x_ops->x_destroy)    \
        (*(xdrs)->x_ops->x_destroy)(xdrs)

#define XDR_CONTROL(xdrs, req, op)   \
    if ((xdrs)->x_ops->x_control)                               \
        (*(xdrs)->x_ops->x_control)(xdrs, req, op)
#define xdr_control(xdrs, req, op) XDR_CONTROL(xdrs, req, op)

/*
 * Solaris strips the '_t' from these types -- not sure why.
 * But, let's be compatible.
 */
#define xdr_rpcvers(xdrs, versp) xdr_u_int32(xdrs, versp)
#define xdr_rpcprog(xdrs, progp) xdr_u_int32(xdrs, progp)
#define xdr_rpcproc(xdrs, procp) xdr_u_int32(xdrs, procp)
#define xdr_rpcprot(xdrs, protp) xdr_u_int32(xdrs, protp)
#define xdr_rpcport(xdrs, portp) xdr_u_int32(xdrs, portp)

/*
 * Support struct for discriminated unions.
 * You create an array of xdrdiscrim structures, terminated with
 * an entry with a null procedure pointer.  The xdr_union routine gets
 * the discriminant value and then searches the array of structures
 * for a matching value.  If a match is found the associated xdr routine
 * is called to handle that part of the union.  If there is
 * no match, then a default routine may be called.
 * If there is no match and no default routine it is an error.
 */
#define NULL_xdrproc_t ((xdrproc_t)0)
struct xdr_discrim {
    int value;
    xdrproc_t proc;
};

/*
 * In-line routines for fast encode/decode of primitive data types.
 * Caveat emptor: these use single memory cycles to get the
 * data from the underlying buffer, and will fail to operate
 * properly if the data is not aligned.  The standard way to use these
 * is to say:
 * if ((buf = XDR_INLINE(xdrs, count)) == NULL)
 *  return (FALSE);
 * <<< macro calls >>>
 * where ``count'' is the number of bytes of data occupied
 * by the primitive data types.
 *
 * N.B. and frozen for all time: each data type here uses 4 bytes
 * of external representation.
 */
#define IXDR_GET_INT32(buf)  ((int32_t)ntohl((u_int32_t)*(buf)++))
#define IXDR_PUT_INT32(buf, v)  (*(buf)++ =(int32_t)htonl((u_int32_t)v))
#define IXDR_GET_U_INT32(buf)  ((u_int32_t)IXDR_GET_INT32(buf))
#define IXDR_PUT_U_INT32(buf, v) IXDR_PUT_INT32((buf), ((int32_t)(v)))

#define IXDR_GET_LONG(buf)  ((long)ntohl((u_int32_t)*(buf)++))
#define IXDR_PUT_LONG(buf, v)  (*(buf)++ =(int32_t)htonl((u_int32_t)v))

#define IXDR_GET_BOOL(buf)  ((bool)IXDR_GET_LONG(buf))
#define IXDR_GET_ENUM(buf, t)  ((t)IXDR_GET_LONG(buf))
#define IXDR_GET_U_LONG(buf)  ((u_long)IXDR_GET_LONG(buf))
#define IXDR_GET_SHORT(buf)  ((short)IXDR_GET_LONG(buf))
#define IXDR_GET_U_SHORT(buf)  ((u_short)IXDR_GET_LONG(buf))

#define IXDR_PUT_BOOL(buf, v)  IXDR_PUT_LONG((buf), (v))
#define IXDR_PUT_ENUM(buf, v)  IXDR_PUT_LONG((buf), (v))
#define IXDR_PUT_U_LONG(buf, v)  IXDR_PUT_LONG((buf), (v))
#define IXDR_PUT_SHORT(buf, v)  IXDR_PUT_LONG((buf), (v))
#define IXDR_PUT_U_SHORT(buf, v) IXDR_PUT_LONG((buf), (v))


/*
 * These are the "generic" xdr routines.
 */
__BEGIN_DECLS
extern bool xdr_void(void);
extern bool xdr_int(XDR *, int *);
extern bool xdr_u_int(XDR *, u_int *);
extern bool xdr_long(XDR *, long *);
extern bool xdr_u_long(XDR *, u_long *);
extern bool xdr_short(XDR *, short *);
extern bool xdr_u_short(XDR *, u_short *);
extern bool xdr_int16_t(XDR *, int16_t *);
extern bool xdr_u_int16_t(XDR *, u_int16_t *);
extern bool xdr_int32_t(XDR *, int32_t *);
extern bool xdr_u_int32_t(XDR *, u_int32_t *);
extern bool xdr_uint32_t(XDR *, u_int32_t *);
extern bool xdr_int64_t(XDR *, int64_t *);
extern bool xdr_u_int64_t(XDR *, u_int64_t *);
extern bool xdr_uint64_t(XDR *, u_int64_t *);
extern bool xdr_bool(XDR *, bool_t *);
extern bool xdr_enum(XDR *, enum_t *);
extern bool xdr_array(XDR *, char **, u_int *, u_int, u_int, xdrproc_t);
extern bool xdr_bytes(XDR *, char **, u_int *, u_int);
extern bool xdr_opaque(XDR *, char *, u_int);
extern bool xdr_string(XDR *, char **, u_int);
extern bool xdr_union(XDR *, enum_t *, char *, const struct xdr_discrim *,
                        xdrproc_t);
extern bool xdr_char(XDR *, char *);
extern bool xdr_u_char(XDR *, u_char *);
extern bool xdr_vector(XDR *, char *, u_int, u_int, xdrproc_t);
extern bool xdr_float(XDR *, float *);
extern bool xdr_double(XDR *, double *);
extern bool xdr_quadruple(XDR *, long double *);
extern bool xdr_reference(XDR *, char **, u_int, xdrproc_t);
extern bool xdr_pointer(XDR *, char **, u_int, xdrproc_t);
extern bool xdr_wrapstring(XDR *, char **);
extern void xdr_free(xdrproc_t, void *);
extern bool xdr_hyper(XDR *, quad_t *);
extern bool xdr_u_hyper(XDR *, u_quad_t *);
extern bool xdr_longlong_t(XDR *, quad_t *);
extern bool xdr_u_longlong_t(XDR *, u_quad_t *);

#define xdr_quad_t  xdr_int64_t
#define xdr_uquad_t xdr_uint64_t

__END_DECLS

/*
 * Common opaque bytes objects used by many rpc protocols;
 * declared here due to commonality.
 */
#define MAX_NETOBJ_SZ 1024
struct netobj {
    u_int n_len;
    char *n_bytes;
};
typedef struct netobj netobj;
extern bool   xdr_netobj(XDR *, struct netobj *);

/*
 * These are the public routines for the various implementations of
 * xdr streams.
 */
__BEGIN_DECLS
/* XDR using memory buffers */
extern void xdrmem_create(XDR *, char *, u_int, enum xdr_op);

/* XDR using stdio library */
extern void xdrstdio_create(XDR *, FILE *, enum xdr_op);

/* XDR pseudo records for tcp */
extern void xdrrec_create(XDR *, u_int, u_int, void *,
                          int (*)(XDR *xdrs, void *, void *, int),
                          int (*)(XDR *xdrs, void *, void *, int));

/* make end of xdr record */
extern bool xdrrec_endofrecord(XDR *, bool);

/* move to beginning of next record */
extern bool xdrrec_skiprecord(XDR *);

/* true if no more input */
extern bool xdrrec_eof(XDR *);

__END_DECLS

#endif /* !_TIRPC_XDR_H */