The R Project SVN R

/*********************************************************************
 * RPC for the Windows NT Operating System
 * 1993 by Martin F. Gergeleit
 * Users may use, copy or modify RPC for the Windows NT Operating 
 * System according to the Oracle copyright below.
 *
 * RPC for the Windows NT Operating System COMES WITH ABSOLUTELY NO 
 * WARRANTY, NOR WILL I BE LIABLE FOR ANY DAMAGES INCURRED FROM THE 
 * USE OF. USE ENTIRELY AT YOUR OWN RISK!!!
 *********************************************************************/

/* @(#)xdr.c    2.1 88/07/29 4.0 RPCSRC */
/*
 * xdr.c, Generic XDR routines implementation.
 *
 * Copyright (c) 2010, Oracle America, Inc.
 *
 * 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 the "Oracle America, 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
 *   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.
 *
 * These are the "generic" xdr routines used to serialize and de-serialize
 * most common data items.  See xdr.h for more info on the interface to
 * xdr.
 */
#if !defined(lint) && defined(SCCSIDS)
static char sccsid[] = "@(#)xdr.c 1.35 87/08/12";
#endif

#include <stdlib.h>
#include <stdio.h>
#include <string.h> /* strlen */
#include <stdint.h>

#include <rpc/types.h>
#include <rpc/xdr.h>

/* R-specific */
void REprintf(char*, ...);
#define fprintf(a, b) REprintf(b)

#ifdef UNUSED
/*
 * constants specific to the xdr "protocol"
 */
#define XDR_FALSE   ((int32_t) 0)
#define XDR_TRUE    ((int32_t) 1)
#define LASTUNSIGNED    ((u_int) 0-1)
#endif

/*
 * for unit alignment
 */
static char xdr_zero[BYTES_PER_XDR_UNIT] = { 0, 0, 0, 0 };

#ifdef UNUSED
/*
 * Free a data structure using XDR
 * Not a filter, but a convenient utility nonetheless
 */
void
xdr_free(proc, objp)
    xdrproc_t proc;
    char *objp;
{
    XDR x;

    x.x_op = XDR_FREE;
    (*proc)(&x, objp);
}
#endif

#ifdef UNUSED
/*
 * XDR nothing
 */
bool_t
xdr_void(/* xdrs, addr */)
    /* XDR *xdrs; */
    /* caddr_t addr; */
{

    return (TRUE);
}
#endif

/*
 * XDR integers: always 32-bit in R
 */
bool_t
xdr_int(
    XDR *xdrs,
    int *ip)
{
//    return (xdr_long(xdrs, (int32_t *)ip));

    if (xdrs->x_op == XDR_DECODE)
        return (XDR_GETLONG(xdrs, (int32_t *)ip));
    if (xdrs->x_op == XDR_ENCODE)
        return (XDR_PUTLONG(xdrs, (int32_t *)ip));
    if (xdrs->x_op == XDR_FREE)
        return (TRUE);
    return (FALSE);
}

/*
 * XDR unsigned integers: always 32-bit in R
 */
bool_t
xdr_u_int(
    XDR *xdrs,
    u_int *up)
{
//    return (xdr_u_long(xdrs, (uint32_t *)up));

    if (xdrs->x_op == XDR_DECODE)
        return (XDR_GETLONG(xdrs, (int32_t *)up));
    if (xdrs->x_op == XDR_ENCODE)
        return (XDR_PUTLONG(xdrs, (int32_t *)up));
    if (xdrs->x_op == XDR_FREE)
        return (TRUE);
    return (FALSE);

}

#ifdef UNUSED
/*
 * XDR long integers
 * same as xdr_u_long - open coded to save a proc call!
 */
bool_t
xdr_long(xdrs, lp)
    register XDR *xdrs;
    int32_t *lp;
{

    if (xdrs->x_op == XDR_ENCODE)
        return (XDR_PUTLONG(xdrs, lp));

    if (xdrs->x_op == XDR_DECODE)
        return (XDR_GETLONG(xdrs, lp));

    if (xdrs->x_op == XDR_FREE)
        return (TRUE);

    return (FALSE);
}

/*
 * XDR unsigned long integers
 * same as xdr_long - open coded to save a proc call!
 */
bool_t
xdr_u_long(xdrs, ulp)
    register XDR *xdrs;
    uint32_t *ulp;
{

    if (xdrs->x_op == XDR_DECODE)
        return (XDR_GETLONG(xdrs, (int32_t *)ulp));
    if (xdrs->x_op == XDR_ENCODE)
        return (XDR_PUTLONG(xdrs, (int32_t *)ulp));
    if (xdrs->x_op == XDR_FREE)
        return (TRUE);
    return (FALSE);
}

/*
 * XDR short integers
 */
bool_t
xdr_short(xdrs, sp)
    register XDR *xdrs;
    short *sp;
{
    int32_t l;

    switch (xdrs->x_op) {

    case XDR_ENCODE:
        l = (int32_t) *sp;
        return (XDR_PUTLONG(xdrs, &l));

    case XDR_DECODE:
        if (!XDR_GETLONG(xdrs, &l)) {
            return (FALSE);
        }
        *sp = (short) l;
        return (TRUE);

    case XDR_FREE:
        return (TRUE);
    }
    return (FALSE);
}

/*
 * XDR unsigned short integers
 */
bool_t
xdr_u_short(xdrs, usp)
    register XDR *xdrs;
    u_short *usp;
{
    uint32_t l;

    switch (xdrs->x_op) {

    case XDR_ENCODE:
        l = (uint32_t) *usp;
        return (XDR_PUTLONG(xdrs, &l));

    case XDR_DECODE:
        if (!XDR_GETLONG(xdrs, &l)) {
            return (FALSE);
        }
        *usp = (u_short) l;
        return (TRUE);

    case XDR_FREE:
        return (TRUE);
    }
    return (FALSE);
}

/*
 * XDR a char
 */
bool_t
xdr_char(xdrs, cp)
    XDR *xdrs;
    char *cp;
{
    int i;

    i = (*cp);
    if (!xdr_int(xdrs, &i)) {
        return (FALSE);
    }
    *cp = i;
    return (TRUE);
}

/*
 * XDR an unsigned char
 */
bool_t
xdr_u_char(xdrs, cp)
    XDR *xdrs;
    char *cp;
{
    u_int u;

    u = (*cp);
    if (!xdr_u_int(xdrs, &u)) {
        return (FALSE);
    }
    *cp = u;
    return (TRUE);
}

/*
 * XDR booleans
 */
bool_t
xdr_bool(xdrs, bp)
    register XDR *xdrs;
    bool_t *bp;
{
    int32_t lb;

    switch (xdrs->x_op) {

    case XDR_ENCODE:
        lb = *bp ? XDR_TRUE : XDR_FALSE;
        return (XDR_PUTLONG(xdrs, &lb));

    case XDR_DECODE:
        if (!XDR_GETLONG(xdrs, &lb)) {
            return (FALSE);
        }
        *bp = (lb == XDR_FALSE) ? FALSE : TRUE;
        return (TRUE);

    case XDR_FREE:
        return (TRUE);
    }
    return (FALSE);
}

/*
 * XDR enumerations
 */
bool_t
xdr_enum(xdrs, ep)
    XDR *xdrs;
    enum_t *ep;
{
#ifndef lint
    enum sizecheck { SIZEVAL }; /* used to find the size of an enum */

    /*
     * enums are treated as ints
     */
    if (sizeof (enum sizecheck) == sizeof (int32_t)) {
        return (xdr_long(xdrs, (int32_t *)ep));
    } else if (sizeof (enum sizecheck) == sizeof (short)) {
        return (xdr_short(xdrs, (short *)ep));
    } else {
        return (FALSE);
    }
#else
    (void) (xdr_short(xdrs, (short *)ep));
    return (xdr_long(xdrs, (int32_t *)ep));
#endif
}
#endif

/*
 * XDR opaque data
 * Allows the specification of a fixed size sequence of opaque bytes.
 * cp points to the opaque object and cnt gives the byte length.
 */
bool_t
xdr_opaque(
    register XDR *xdrs,
    caddr_t cp,
    register u_int cnt)
{
    register u_int rndup;
    static int crud[BYTES_PER_XDR_UNIT];

    /*
     * if no data we are done
     */
    if (cnt == 0)
        return (TRUE);

    /*
     * round byte count to full xdr units
     */
    rndup = cnt % BYTES_PER_XDR_UNIT;
    if (rndup > 0)
        rndup = BYTES_PER_XDR_UNIT - rndup;

    if (xdrs->x_op == XDR_DECODE) {
        if (!XDR_GETBYTES(xdrs, cp, cnt)) {
            return (FALSE);
        }
        if (rndup == 0)
            return (TRUE);
        return (XDR_GETBYTES(xdrs, (caddr_t)crud, rndup));
    }

    if (xdrs->x_op == XDR_ENCODE) {
        if (!XDR_PUTBYTES(xdrs, cp, cnt)) {
            return (FALSE);
        }
        if (rndup == 0)
            return (TRUE);
        return (XDR_PUTBYTES(xdrs, xdr_zero, rndup));
    }

    if (xdrs->x_op == XDR_FREE) {
        return (TRUE);
    }

    return (FALSE);
}

/*
 * XDR counted bytes
 * *cpp is a pointer to the bytes, *sizep is the count.
 * If *cpp is NULL maxsize bytes are allocated
 */
bool_t
xdr_bytes(
    register XDR *xdrs,
    char **cpp,
    register u_int *sizep,
    u_int maxsize)
{
    register char *sp = *cpp;  /* sp is the actual string pointer */
    register u_int nodesize;

    /*
     * first deal with the length since xdr bytes are counted
     */
    if (! xdr_u_int(xdrs, sizep)) {
        return (FALSE);
    }
    nodesize = *sizep;
    if ((nodesize > maxsize) && (xdrs->x_op != XDR_FREE)) {
        return (FALSE);
    }

    /*
     * now deal with the actual bytes
     */
    switch (xdrs->x_op) {

    case XDR_DECODE:
        if (nodesize == 0) {
            return (TRUE);
        }
        if (sp == NULL) {
            *cpp = sp = (char *)mem_alloc(nodesize);
        }
        if (sp == NULL) {
            (void) fprintf(stderr, "xdr_bytes: out of memory\n");
            return (FALSE);
        }
        /* fall into ... */

    case XDR_ENCODE:
        return (xdr_opaque(xdrs, sp, nodesize));

    case XDR_FREE:
        if (sp != NULL) {
            mem_free(sp, nodesize);
            *cpp = NULL;
        }
        return (TRUE);
    }
    return (FALSE);
}

#ifdef UNUSED
/*
 * Implemented here due to commonality of the object.
 */
bool_t
xdr_netobj(xdrs, np)
    XDR *xdrs;
    struct netobj *np;
{

    return (xdr_bytes(xdrs, &np->n_bytes, &np->n_len, MAX_NETOBJ_SZ));
}

/*
 * XDR a descriminated union
 * Support routine for discriminated unions.
 * You create an array of xdrdiscrim structures, terminated with
 * an entry with a null procedure pointer.  The routine gets
 * the discriminant value and then searches the array of xdrdiscrims
 * looking for that value.  It calls the procedure given in the xdrdiscrim
 * to handle the discriminant.  If there is no specific routine a default
 * routine may be called.
 * If there is no specific or default routine an error is returned.
 */
bool_t
xdr_union(xdrs, dscmp, unp, choices, dfault)
    register XDR *xdrs;
    enum_t *dscmp;      /* enum to decide which arm to work on */
    char *unp;      /* the union itself */
    struct xdr_discrim *choices;    /* [value, xdr proc] for each arm */
    xdrproc_t dfault;   /* default xdr routine */
{
    register enum_t dscm;

    /*
     * we deal with the discriminator;  it's an enum
     */
    if (! xdr_enum(xdrs, dscmp)) {
        return (FALSE);
    }
    dscm = *dscmp;

    /*
     * search choices for a value that matches the discriminator.
     * if we find one, execute the xdr routine for that value.
     */
    for (; choices->proc != NULL_xdrproc_t; choices++) {
        if (choices->value == dscm)
            return ((*(choices->proc))(xdrs, unp, LASTUNSIGNED));
    }

    /*
     * no match - execute the default xdr routine if there is one
     */
    return ((dfault == NULL_xdrproc_t) ? FALSE :
        (*dfault)(xdrs, unp, LASTUNSIGNED));
}
#endif

/*
 * Non-portable xdr primitives.
 * Care should be taken when moving these routines to new architectures.
 */


/*
 * XDR null terminated ASCII strings
 * xdr_string deals with "C strings" - arrays of bytes that are
 * terminated by a NULL character.  The parameter cpp references a
 * pointer to storage; If the pointer is null, then the necessary
 * storage is allocated.  The last parameter is the max allowed length
 * of the string as specified by a protocol.
 */
bool_t
xdr_string(
    register XDR *xdrs,
    char **cpp,
    u_int maxsize)
{
    register char *sp = *cpp;  /* sp is the actual string pointer */
    u_int size;
    u_int nodesize;

    /*
     * first deal with the length since xdr strings are counted-strings
     */
    switch (xdrs->x_op) {
    case XDR_FREE:
        if (sp == NULL) {
            return(TRUE);   /* already free */
        }
        /* fall through... */
    case XDR_ENCODE:
        size = strlen(sp);
        break;
    case XDR_DECODE:
            /* size not used: just keep compilers happy */
            break;
    }
    if (! xdr_u_int(xdrs, &size)) {
        return (FALSE);
    }
    if (size > maxsize) {
        return (FALSE);
    }
    nodesize = size + 1;

    /*
     * now deal with the actual bytes
     */
    switch (xdrs->x_op) {

    case XDR_DECODE:
        if (nodesize == 0) {
            return (TRUE);
        }
        if (sp == NULL)
            *cpp = sp = (char *)mem_alloc(nodesize);
        if (sp == NULL) {
            (void) fprintf(stderr, "xdr_string: out of memory\n");
            return (FALSE);
        }
        sp[size] = 0;
        /* fall into ... */

    case XDR_ENCODE:
        return (xdr_opaque(xdrs, sp, size));

    case XDR_FREE:
        mem_free(sp, nodesize);
        *cpp = NULL;
        return (TRUE);
    }
    return (FALSE);
}

#ifdef UNUSED
/*
 * Wrapper for xdr_string that can be called directly from
 * routines like clnt_call
 */
bool_t
xdr_wrapstring(xdrs, cpp)
    XDR *xdrs;
    char **cpp;
{
    if (xdr_string(xdrs, cpp, LASTUNSIGNED)) {
        return (TRUE);
    }
    return (FALSE);
}
#endif