123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827 |
- /* $NetBSD: xdr.c,v 1.22 2000/07/06 03:10:35 christos Exp $ */
- /*
- * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
- * unrestricted use provided that this legend is included on all tape
- * media and as a part of the software program in whole or part. Users
- * may copy or modify Sun RPC without charge, but are not authorized
- * to license or distribute it to anyone else except as part of a product or
- * program developed by the user.
- *
- * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
- * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
- * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
- *
- * Sun RPC is provided with no support and without any obligation on the
- * part of Sun Microsystems, Inc. to assist in its use, correction,
- * modification or enhancement.
- *
- * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
- * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
- * OR ANY PART THEREOF.
- *
- * In no event will Sun Microsystems, Inc. be liable for any lost revenue
- * or profits or other special, indirect and consequential damages, even if
- * Sun has been advised of the possibility of such damages.
- *
- * Sun Microsystems, Inc.
- * 2550 Garcia Avenue
- * Mountain View, California 94043
- */
- #include <sys/cdefs.h>
- /*
- * xdr.c, Generic XDR routines implementation.
- *
- * Copyright (C) 1986, Sun Microsystems, Inc.
- *
- * 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.
- */
- #include <sys/param.h>
- #include <sys/systm.h>
- #include <sys/kernel.h>
- #include <sys/malloc.h>
- #include <sys/module.h>
- #include <rpc/rpc.h>
- #include <rpc/rpc_com.h>
- #include <rpc/types.h>
- #include <rpc/xdr.h>
- typedef quad_t longlong_t; /* ANSI long long type */
- typedef u_quad_t u_longlong_t; /* ANSI unsigned long long type */
- /*
- * constants specific to the xdr "protocol"
- */
- #define XDR_FALSE ((long) 0)
- #define XDR_TRUE ((long) 1)
- MALLOC_DEFINE(M_RPC, "rpc", "Remote Procedure Call");
- /*
- * for unit alignment
- */
- static const char xdr_zero[BYTES_PER_XDR_UNIT] = { 0, 0, 0, 0 };
- /*
- * Free a data structure using XDR
- * Not a filter, but a convenient utility nonetheless
- */
- void
- xdr_free(xdrproc_t proc, void *objp)
- {
- XDR x;
- x.x_op = XDR_FREE;
- (*proc)(&x, objp);
- }
- /*
- * XDR nothing
- */
- bool_t
- xdr_void(void)
- {
- return (TRUE);
- }
- /*
- * XDR integers
- */
- bool_t
- xdr_int(XDR *xdrs, int *ip)
- {
- long l;
- switch (xdrs->x_op) {
- case XDR_ENCODE:
- l = (long) *ip;
- return (XDR_PUTLONG(xdrs, &l));
- case XDR_DECODE:
- if (!XDR_GETLONG(xdrs, &l)) {
- return (FALSE);
- }
- *ip = (int) l;
- return (TRUE);
- case XDR_FREE:
- return (TRUE);
- }
- /* NOTREACHED */
- return (FALSE);
- }
- /*
- * XDR unsigned integers
- */
- bool_t
- xdr_u_int(XDR *xdrs, u_int *up)
- {
- u_long l;
- switch (xdrs->x_op) {
- case XDR_ENCODE:
- l = (u_long) *up;
- return (XDR_PUTLONG(xdrs, (long *)&l));
- case XDR_DECODE:
- if (!XDR_GETLONG(xdrs, (long *)&l)) {
- return (FALSE);
- }
- *up = (u_int) l;
- return (TRUE);
- case XDR_FREE:
- return (TRUE);
- }
- /* NOTREACHED */
- return (FALSE);
- }
- /*
- * XDR long integers
- * same as xdr_u_long - open coded to save a proc call!
- */
- bool_t
- xdr_long(XDR *xdrs, long *lp)
- {
- switch (xdrs->x_op) {
- case XDR_ENCODE:
- return (XDR_PUTLONG(xdrs, lp));
- case XDR_DECODE:
- return (XDR_GETLONG(xdrs, lp));
- case XDR_FREE:
- return (TRUE);
- }
- /* NOTREACHED */
- return (FALSE);
- }
- /*
- * XDR unsigned long integers
- * same as xdr_long - open coded to save a proc call!
- */
- bool_t
- xdr_u_long(XDR *xdrs, u_long *ulp)
- {
- switch (xdrs->x_op) {
- case XDR_ENCODE:
- return (XDR_PUTLONG(xdrs, (long *)ulp));
- case XDR_DECODE:
- return (XDR_GETLONG(xdrs, (long *)ulp));
- case XDR_FREE:
- return (TRUE);
- }
- /* NOTREACHED */
- return (FALSE);
- }
- /*
- * XDR 32-bit integers
- * same as xdr_uint32_t - open coded to save a proc call!
- */
- bool_t
- xdr_int32_t(XDR *xdrs, int32_t *int32_p)
- {
- long l;
- switch (xdrs->x_op) {
- case XDR_ENCODE:
- l = (long) *int32_p;
- return (XDR_PUTLONG(xdrs, &l));
- case XDR_DECODE:
- if (!XDR_GETLONG(xdrs, &l)) {
- return (FALSE);
- }
- *int32_p = (int32_t) l;
- return (TRUE);
- case XDR_FREE:
- return (TRUE);
- }
- /* NOTREACHED */
- return (FALSE);
- }
- /*
- * XDR unsigned 32-bit integers
- * same as xdr_int32_t - open coded to save a proc call!
- */
- bool_t
- xdr_uint32_t(XDR *xdrs, uint32_t *uint32_p)
- {
- u_long l;
- switch (xdrs->x_op) {
- case XDR_ENCODE:
- l = (u_long) *uint32_p;
- return (XDR_PUTLONG(xdrs, (long *)&l));
- case XDR_DECODE:
- if (!XDR_GETLONG(xdrs, (long *)&l)) {
- return (FALSE);
- }
- *uint32_p = (uint32_t) l;
- return (TRUE);
- case XDR_FREE:
- return (TRUE);
- }
- /* NOTREACHED */
- return (FALSE);
- }
- /*
- * XDR short integers
- */
- bool_t
- xdr_short(XDR *xdrs, short *sp)
- {
- long l;
- switch (xdrs->x_op) {
- case XDR_ENCODE:
- l = (long) *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);
- }
- /* NOTREACHED */
- return (FALSE);
- }
- /*
- * XDR unsigned short integers
- */
- bool_t
- xdr_u_short(XDR *xdrs, u_short *usp)
- {
- u_long l;
- switch (xdrs->x_op) {
- case XDR_ENCODE:
- l = (u_long) *usp;
- return (XDR_PUTLONG(xdrs, (long *)&l));
- case XDR_DECODE:
- if (!XDR_GETLONG(xdrs, (long *)&l)) {
- return (FALSE);
- }
- *usp = (u_short) l;
- return (TRUE);
- case XDR_FREE:
- return (TRUE);
- }
- /* NOTREACHED */
- return (FALSE);
- }
- /*
- * XDR 16-bit integers
- */
- bool_t
- xdr_int16_t(XDR *xdrs, int16_t *int16_p)
- {
- long l;
- switch (xdrs->x_op) {
- case XDR_ENCODE:
- l = (long) *int16_p;
- return (XDR_PUTLONG(xdrs, &l));
- case XDR_DECODE:
- if (!XDR_GETLONG(xdrs, &l)) {
- return (FALSE);
- }
- *int16_p = (int16_t) l;
- return (TRUE);
- case XDR_FREE:
- return (TRUE);
- }
- /* NOTREACHED */
- return (FALSE);
- }
- /*
- * XDR unsigned 16-bit integers
- */
- bool_t
- xdr_uint16_t(XDR *xdrs, uint16_t *uint16_p)
- {
- u_long l;
- switch (xdrs->x_op) {
- case XDR_ENCODE:
- l = (u_long) *uint16_p;
- return (XDR_PUTLONG(xdrs, (long *)&l));
- case XDR_DECODE:
- if (!XDR_GETLONG(xdrs, (long *)&l)) {
- return (FALSE);
- }
- *uint16_p = (uint16_t) l;
- return (TRUE);
- case XDR_FREE:
- return (TRUE);
- }
- /* NOTREACHED */
- return (FALSE);
- }
- /*
- * XDR a char
- */
- bool_t
- xdr_char(XDR *xdrs, char *cp)
- {
- u_int i;
- i = *((unsigned char *)cp);
- if (!xdr_u_int(xdrs, &i)) {
- return (FALSE);
- }
- *((unsigned char *)cp) = i;
- return (TRUE);
- }
- /*
- * XDR an unsigned char
- */
- bool_t
- xdr_u_char(XDR *xdrs, u_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(XDR *xdrs, bool_t *bp)
- {
- long 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);
- }
- /* NOTREACHED */
- return (FALSE);
- }
- /*
- * XDR enumerations
- */
- bool_t
- xdr_enum(XDR *xdrs, enum_t *ep)
- {
- enum sizecheck { SIZEVAL }; /* used to find the size of an enum */
- /*
- * enums are treated as ints
- */
- /* LINTED */ if (sizeof (enum sizecheck) == sizeof (long)) {
- return (xdr_long(xdrs, (long *)(void *)ep));
- } else /* LINTED */ if (sizeof (enum sizecheck) == sizeof (int)) {
- return (xdr_int(xdrs, (int *)(void *)ep));
- } else /* LINTED */ if (sizeof (enum sizecheck) == sizeof (short)) {
- return (xdr_short(xdrs, (short *)(void *)ep));
- } else {
- return (FALSE);
- }
- }
- /*
- * 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(XDR *xdrs, caddr_t cp, u_int cnt)
- {
- 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)(void *)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(XDR *xdrs, char **cpp, u_int *sizep, u_int maxsize)
- {
- char *sp = *cpp; /* sp is the actual string pointer */
- u_int nodesize;
- bool_t ret, allocated = FALSE;
- /*
- * 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 = mem_alloc(nodesize);
- allocated = TRUE;
- }
- if (sp == NULL) {
- printf("xdr_bytes: out of memory");
- return (FALSE);
- }
- /* FALLTHROUGH */
- case XDR_ENCODE:
- ret = xdr_opaque(xdrs, sp, nodesize);
- if ((xdrs->x_op == XDR_DECODE) && (ret == FALSE)) {
- if (allocated == TRUE) {
- mem_free(sp, nodesize);
- *cpp = NULL;
- }
- }
- return (ret);
- case XDR_FREE:
- if (sp != NULL) {
- mem_free(sp, nodesize);
- *cpp = NULL;
- }
- return (TRUE);
- }
- /* NOTREACHED */
- return (FALSE);
- }
- /*
- * Implemented here due to commonality of the object.
- */
- bool_t
- xdr_netobj(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(XDR *xdrs,
- enum_t *dscmp, /* enum to decide which arm to work on */
- char *unp, /* the union itself */
- const struct xdr_discrim *choices, /* [value, xdr proc] for each arm */
- xdrproc_t dfault) /* default xdr routine */
- {
- 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));
- }
- /*
- * no match - execute the default xdr routine if there is one
- */
- return ((dfault == NULL_xdrproc_t) ? FALSE :
- (*dfault)(xdrs, unp));
- }
- /*
- * 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(XDR *xdrs, char **cpp, u_int maxsize)
- {
- char *sp = *cpp; /* sp is the actual string pointer */
- u_int size;
- u_int nodesize;
- bool_t ret, allocated = FALSE;
- /*
- * 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 */
- }
- /* FALLTHROUGH */
- case XDR_ENCODE:
- size = strlen(sp);
- break;
- case XDR_DECODE:
- 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 = mem_alloc(nodesize);
- allocated = TRUE;
- }
- if (sp == NULL) {
- printf("xdr_string: out of memory");
- return (FALSE);
- }
- sp[size] = 0;
- /* FALLTHROUGH */
- case XDR_ENCODE:
- ret = xdr_opaque(xdrs, sp, size);
- if ((xdrs->x_op == XDR_DECODE) && (ret == FALSE)) {
- if (allocated == TRUE) {
- mem_free(sp, nodesize);
- *cpp = NULL;
- }
- }
- return (ret);
- case XDR_FREE:
- mem_free(sp, nodesize);
- *cpp = NULL;
- return (TRUE);
- }
- /* NOTREACHED */
- return (FALSE);
- }
- /*
- * Wrapper for xdr_string that can be called directly from
- * routines like clnt_call
- */
- bool_t
- xdr_wrapstring(XDR *xdrs, char **cpp)
- {
- return xdr_string(xdrs, cpp, RPC_MAXDATASIZE);
- }
- /*
- * NOTE: xdr_hyper(), xdr_u_hyper(), xdr_longlong_t(), and xdr_u_longlong_t()
- * are in the "non-portable" section because they require that a `long long'
- * be a 64-bit type.
- *
- * --thorpej@netbsd.org, November 30, 1999
- */
- /*
- * XDR 64-bit integers
- */
- bool_t
- xdr_int64_t(XDR *xdrs, int64_t *llp)
- {
- u_long ul[2];
- switch (xdrs->x_op) {
- case XDR_ENCODE:
- ul[0] = (u_long)((uint64_t)*llp >> 32) & 0xffffffff;
- ul[1] = (u_long)((uint64_t)*llp) & 0xffffffff;
- if (XDR_PUTLONG(xdrs, (long *)&ul[0]) == FALSE)
- return (FALSE);
- return (XDR_PUTLONG(xdrs, (long *)&ul[1]));
- case XDR_DECODE:
- if (XDR_GETLONG(xdrs, (long *)&ul[0]) == FALSE)
- return (FALSE);
- if (XDR_GETLONG(xdrs, (long *)&ul[1]) == FALSE)
- return (FALSE);
- *llp = (int64_t)
- (((uint64_t)ul[0] << 32) | ((uint64_t)ul[1]));
- return (TRUE);
- case XDR_FREE:
- return (TRUE);
- }
- /* NOTREACHED */
- return (FALSE);
- }
- /*
- * XDR unsigned 64-bit integers
- */
- bool_t
- xdr_uint64_t(XDR *xdrs, uint64_t *ullp)
- {
- u_long ul[2];
- switch (xdrs->x_op) {
- case XDR_ENCODE:
- ul[0] = (u_long)(*ullp >> 32) & 0xffffffff;
- ul[1] = (u_long)(*ullp) & 0xffffffff;
- if (XDR_PUTLONG(xdrs, (long *)&ul[0]) == FALSE)
- return (FALSE);
- return (XDR_PUTLONG(xdrs, (long *)&ul[1]));
- case XDR_DECODE:
- if (XDR_GETLONG(xdrs, (long *)&ul[0]) == FALSE)
- return (FALSE);
- if (XDR_GETLONG(xdrs, (long *)&ul[1]) == FALSE)
- return (FALSE);
- *ullp = (uint64_t)
- (((uint64_t)ul[0] << 32) | ((uint64_t)ul[1]));
- return (TRUE);
- case XDR_FREE:
- return (TRUE);
- }
- /* NOTREACHED */
- return (FALSE);
- }
- /*
- * XDR hypers
- */
- bool_t
- xdr_hyper(XDR *xdrs, longlong_t *llp)
- {
- /*
- * Don't bother open-coding this; it's a fair amount of code. Just
- * call xdr_int64_t().
- */
- return (xdr_int64_t(xdrs, (int64_t *)llp));
- }
- /*
- * XDR unsigned hypers
- */
- bool_t
- xdr_u_hyper(XDR *xdrs, u_longlong_t *ullp)
- {
- /*
- * Don't bother open-coding this; it's a fair amount of code. Just
- * call xdr_uint64_t().
- */
- return (xdr_uint64_t(xdrs, (uint64_t *)ullp));
- }
- /*
- * XDR longlong_t's
- */
- bool_t
- xdr_longlong_t(XDR *xdrs, longlong_t *llp)
- {
- /*
- * Don't bother open-coding this; it's a fair amount of code. Just
- * call xdr_int64_t().
- */
- return (xdr_int64_t(xdrs, (int64_t *)llp));
- }
- /*
- * XDR u_longlong_t's
- */
- bool_t
- xdr_u_longlong_t(XDR *xdrs, u_longlong_t *ullp)
- {
- /*
- * Don't bother open-coding this; it's a fair amount of code. Just
- * call xdr_uint64_t().
- */
- return (xdr_uint64_t(xdrs, (uint64_t *)ullp));
- }
- /*
- * Kernel module glue
- */
- static int
- xdr_modevent(module_t mod, int type, void *data)
- {
- return (0);
- }
- static moduledata_t xdr_mod = {
- "xdr",
- xdr_modevent,
- NULL,
- };
- DECLARE_MODULE(xdr, xdr_mod, SI_SUB_VFS, SI_ORDER_ANY);
- MODULE_VERSION(xdr, 1);
|