1 /* $NetBSD: xdr.c,v 1.22 2000/07/06 03:10:35 christos Exp $ */
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.
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.
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.
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.
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.
27 * Sun Microsystems, Inc.
29 * Mountain View, California 94043
32 #if defined(LIBC_SCCS) && !defined(lint)
33 static char *sccsid2 = "@(#)xdr.c 1.35 87/08/12";
34 static char *sccsid = "@(#)xdr.c 2.1 88/07/29 4.0 RPCSRC";
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
40 * xdr.c, Generic XDR routines implementation.
42 * Copyright (C) 1986, Sun Microsystems, Inc.
44 * These are the "generic" xdr routines used to serialize and de-serialize
45 * most common data items. See xdr.h for more info on the interface to
49 #include <sys/param.h>
50 #include <sys/systm.h>
51 #include <sys/kernel.h>
52 #include <sys/malloc.h>
53 #include <sys/module.h>
56 #include <rpc/rpc_com.h>
57 #include <rpc/types.h>
60 typedef quad_t longlong_t; /* ANSI long long type */
61 typedef u_quad_t u_longlong_t; /* ANSI unsigned long long type */
64 * constants specific to the xdr "protocol"
66 #define XDR_FALSE ((long) 0)
67 #define XDR_TRUE ((long) 1)
69 MALLOC_DEFINE(M_RPC, "rpc", "Remote Procedure Call");
74 static const char xdr_zero[BYTES_PER_XDR_UNIT] = { 0, 0, 0, 0 };
77 * Free a data structure using XDR
78 * Not a filter, but a convenient utility nonetheless
81 xdr_free(xdrproc_t proc, void *objp)
104 xdr_int(XDR *xdrs, int *ip)
108 switch (xdrs->x_op) {
112 return (XDR_PUTLONG(xdrs, &l));
115 if (!XDR_GETLONG(xdrs, &l)) {
129 * XDR unsigned integers
132 xdr_u_int(XDR *xdrs, u_int *up)
136 switch (xdrs->x_op) {
140 return (XDR_PUTLONG(xdrs, (long *)&l));
143 if (!XDR_GETLONG(xdrs, (long *)&l)) {
159 * same as xdr_u_long - open coded to save a proc call!
162 xdr_long(XDR *xdrs, long *lp)
164 switch (xdrs->x_op) {
166 return (XDR_PUTLONG(xdrs, lp));
168 return (XDR_GETLONG(xdrs, lp));
177 * XDR unsigned long integers
178 * same as xdr_long - open coded to save a proc call!
181 xdr_u_long(XDR *xdrs, u_long *ulp)
183 switch (xdrs->x_op) {
185 return (XDR_PUTLONG(xdrs, (long *)ulp));
187 return (XDR_GETLONG(xdrs, (long *)ulp));
197 * XDR 32-bit integers
198 * same as xdr_uint32_t - open coded to save a proc call!
201 xdr_int32_t(XDR *xdrs, int32_t *int32_p)
205 switch (xdrs->x_op) {
209 return (XDR_PUTLONG(xdrs, &l));
212 if (!XDR_GETLONG(xdrs, &l)) {
215 *int32_p = (int32_t) l;
226 * XDR unsigned 32-bit integers
227 * same as xdr_int32_t - open coded to save a proc call!
230 xdr_uint32_t(XDR *xdrs, uint32_t *uint32_p)
234 switch (xdrs->x_op) {
237 l = (u_long) *uint32_p;
238 return (XDR_PUTLONG(xdrs, (long *)&l));
241 if (!XDR_GETLONG(xdrs, (long *)&l)) {
244 *uint32_p = (uint32_t) l;
259 xdr_short(XDR *xdrs, short *sp)
263 switch (xdrs->x_op) {
267 return (XDR_PUTLONG(xdrs, &l));
270 if (!XDR_GETLONG(xdrs, &l)) {
284 * XDR unsigned short integers
287 xdr_u_short(XDR *xdrs, u_short *usp)
291 switch (xdrs->x_op) {
295 return (XDR_PUTLONG(xdrs, (long *)&l));
298 if (!XDR_GETLONG(xdrs, (long *)&l)) {
313 * XDR 16-bit integers
316 xdr_int16_t(XDR *xdrs, int16_t *int16_p)
320 switch (xdrs->x_op) {
324 return (XDR_PUTLONG(xdrs, &l));
327 if (!XDR_GETLONG(xdrs, &l)) {
330 *int16_p = (int16_t) l;
341 * XDR unsigned 16-bit integers
344 xdr_uint16_t(XDR *xdrs, uint16_t *uint16_p)
348 switch (xdrs->x_op) {
351 l = (u_long) *uint16_p;
352 return (XDR_PUTLONG(xdrs, (long *)&l));
355 if (!XDR_GETLONG(xdrs, (long *)&l)) {
358 *uint16_p = (uint16_t) l;
373 xdr_char(XDR *xdrs, char *cp)
378 if (!xdr_int(xdrs, &i)) {
386 * XDR an unsigned char
389 xdr_u_char(XDR *xdrs, u_char *cp)
394 if (!xdr_u_int(xdrs, &u)) {
405 xdr_bool(XDR *xdrs, bool_t *bp)
409 switch (xdrs->x_op) {
412 lb = *bp ? XDR_TRUE : XDR_FALSE;
413 return (XDR_PUTLONG(xdrs, &lb));
416 if (!XDR_GETLONG(xdrs, &lb)) {
419 *bp = (lb == XDR_FALSE) ? FALSE : TRUE;
433 xdr_enum(XDR *xdrs, enum_t *ep)
435 enum sizecheck { SIZEVAL }; /* used to find the size of an enum */
438 * enums are treated as ints
440 /* LINTED */ if (sizeof (enum sizecheck) == sizeof (long)) {
441 return (xdr_long(xdrs, (long *)(void *)ep));
442 } else /* LINTED */ if (sizeof (enum sizecheck) == sizeof (int)) {
443 return (xdr_int(xdrs, (int *)(void *)ep));
444 } else /* LINTED */ if (sizeof (enum sizecheck) == sizeof (short)) {
445 return (xdr_short(xdrs, (short *)(void *)ep));
453 * Allows the specification of a fixed size sequence of opaque bytes.
454 * cp points to the opaque object and cnt gives the byte length.
457 xdr_opaque(XDR *xdrs, caddr_t cp, u_int cnt)
460 static int crud[BYTES_PER_XDR_UNIT];
463 * if no data we are done
469 * round byte count to full xdr units
471 rndup = cnt % BYTES_PER_XDR_UNIT;
473 rndup = BYTES_PER_XDR_UNIT - rndup;
475 if (xdrs->x_op == XDR_DECODE) {
476 if (!XDR_GETBYTES(xdrs, cp, cnt)) {
481 return (XDR_GETBYTES(xdrs, (caddr_t)(void *)crud, rndup));
484 if (xdrs->x_op == XDR_ENCODE) {
485 if (!XDR_PUTBYTES(xdrs, cp, cnt)) {
490 return (XDR_PUTBYTES(xdrs, xdr_zero, rndup));
493 if (xdrs->x_op == XDR_FREE) {
502 * *cpp is a pointer to the bytes, *sizep is the count.
503 * If *cpp is NULL maxsize bytes are allocated
506 xdr_bytes(XDR *xdrs, char **cpp, u_int *sizep, u_int maxsize)
508 char *sp = *cpp; /* sp is the actual string pointer */
510 bool_t ret, allocated = FALSE;
513 * first deal with the length since xdr bytes are counted
515 if (! xdr_u_int(xdrs, sizep)) {
519 if ((nodesize > maxsize) && (xdrs->x_op != XDR_FREE)) {
524 * now deal with the actual bytes
526 switch (xdrs->x_op) {
533 *cpp = sp = mem_alloc(nodesize);
537 printf("xdr_bytes: out of memory");
543 ret = xdr_opaque(xdrs, sp, nodesize);
544 if ((xdrs->x_op == XDR_DECODE) && (ret == FALSE)) {
545 if (allocated == TRUE) {
546 mem_free(sp, nodesize);
554 mem_free(sp, nodesize);
564 * Implemented here due to commonality of the object.
567 xdr_netobj(XDR *xdrs, struct netobj *np)
570 return (xdr_bytes(xdrs, &np->n_bytes, &np->n_len, MAX_NETOBJ_SZ));
574 * XDR a descriminated union
575 * Support routine for discriminated unions.
576 * You create an array of xdrdiscrim structures, terminated with
577 * an entry with a null procedure pointer. The routine gets
578 * the discriminant value and then searches the array of xdrdiscrims
579 * looking for that value. It calls the procedure given in the xdrdiscrim
580 * to handle the discriminant. If there is no specific routine a default
581 * routine may be called.
582 * If there is no specific or default routine an error is returned.
586 enum_t *dscmp, /* enum to decide which arm to work on */
587 char *unp, /* the union itself */
588 const struct xdr_discrim *choices, /* [value, xdr proc] for each arm */
589 xdrproc_t dfault) /* default xdr routine */
594 * we deal with the discriminator; it's an enum
596 if (! xdr_enum(xdrs, dscmp)) {
602 * search choices for a value that matches the discriminator.
603 * if we find one, execute the xdr routine for that value.
605 for (; choices->proc != NULL_xdrproc_t; choices++) {
606 if (choices->value == dscm)
607 return ((*(choices->proc))(xdrs, unp));
611 * no match - execute the default xdr routine if there is one
613 return ((dfault == NULL_xdrproc_t) ? FALSE :
614 (*dfault)(xdrs, unp));
619 * Non-portable xdr primitives.
620 * Care should be taken when moving these routines to new architectures.
625 * XDR null terminated ASCII strings
626 * xdr_string deals with "C strings" - arrays of bytes that are
627 * terminated by a NULL character. The parameter cpp references a
628 * pointer to storage; If the pointer is null, then the necessary
629 * storage is allocated. The last parameter is the max allowed length
630 * of the string as specified by a protocol.
633 xdr_string(XDR *xdrs, char **cpp, u_int maxsize)
635 char *sp = *cpp; /* sp is the actual string pointer */
638 bool_t ret, allocated = FALSE;
641 * first deal with the length since xdr strings are counted-strings
643 switch (xdrs->x_op) {
646 return(TRUE); /* already free */
655 if (! xdr_u_int(xdrs, &size)) {
658 if (size > maxsize) {
664 * now deal with the actual bytes
666 switch (xdrs->x_op) {
673 *cpp = sp = mem_alloc(nodesize);
677 printf("xdr_string: out of memory");
684 ret = xdr_opaque(xdrs, sp, size);
685 if ((xdrs->x_op == XDR_DECODE) && (ret == FALSE)) {
686 if (allocated == TRUE) {
687 mem_free(sp, nodesize);
694 mem_free(sp, nodesize);
703 * Wrapper for xdr_string that can be called directly from
704 * routines like clnt_call
707 xdr_wrapstring(XDR *xdrs, char **cpp)
709 return xdr_string(xdrs, cpp, RPC_MAXDATASIZE);
713 * NOTE: xdr_hyper(), xdr_u_hyper(), xdr_longlong_t(), and xdr_u_longlong_t()
714 * are in the "non-portable" section because they require that a `long long'
717 * --thorpej@netbsd.org, November 30, 1999
721 * XDR 64-bit integers
724 xdr_int64_t(XDR *xdrs, int64_t *llp)
728 switch (xdrs->x_op) {
730 ul[0] = (u_long)((uint64_t)*llp >> 32) & 0xffffffff;
731 ul[1] = (u_long)((uint64_t)*llp) & 0xffffffff;
732 if (XDR_PUTLONG(xdrs, (long *)&ul[0]) == FALSE)
734 return (XDR_PUTLONG(xdrs, (long *)&ul[1]));
736 if (XDR_GETLONG(xdrs, (long *)&ul[0]) == FALSE)
738 if (XDR_GETLONG(xdrs, (long *)&ul[1]) == FALSE)
741 (((uint64_t)ul[0] << 32) | ((uint64_t)ul[1]));
752 * XDR unsigned 64-bit integers
755 xdr_uint64_t(XDR *xdrs, uint64_t *ullp)
759 switch (xdrs->x_op) {
761 ul[0] = (u_long)(*ullp >> 32) & 0xffffffff;
762 ul[1] = (u_long)(*ullp) & 0xffffffff;
763 if (XDR_PUTLONG(xdrs, (long *)&ul[0]) == FALSE)
765 return (XDR_PUTLONG(xdrs, (long *)&ul[1]));
767 if (XDR_GETLONG(xdrs, (long *)&ul[0]) == FALSE)
769 if (XDR_GETLONG(xdrs, (long *)&ul[1]) == FALSE)
772 (((uint64_t)ul[0] << 32) | ((uint64_t)ul[1]));
786 xdr_hyper(XDR *xdrs, longlong_t *llp)
790 * Don't bother open-coding this; it's a fair amount of code. Just
791 * call xdr_int64_t().
793 return (xdr_int64_t(xdrs, (int64_t *)llp));
798 * XDR unsigned hypers
801 xdr_u_hyper(XDR *xdrs, u_longlong_t *ullp)
805 * Don't bother open-coding this; it's a fair amount of code. Just
806 * call xdr_uint64_t().
808 return (xdr_uint64_t(xdrs, (uint64_t *)ullp));
816 xdr_longlong_t(XDR *xdrs, longlong_t *llp)
820 * Don't bother open-coding this; it's a fair amount of code. Just
821 * call xdr_int64_t().
823 return (xdr_int64_t(xdrs, (int64_t *)llp));
831 xdr_u_longlong_t(XDR *xdrs, u_longlong_t *ullp)
835 * Don't bother open-coding this; it's a fair amount of code. Just
836 * call xdr_uint64_t().
838 return (xdr_uint64_t(xdrs, (uint64_t *)ullp));
845 xdr_modevent(module_t mod, int type, void *data)
850 static moduledata_t xdr_mod = {
855 DECLARE_MODULE(xdr, xdr_mod, SI_SUB_VFS, SI_ORDER_ANY);
856 MODULE_VERSION(xdr, 1);