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>
54 #include <rpc/types.h>
57 typedef quad_t longlong_t; /* ANSI long long type */
58 typedef u_quad_t u_longlong_t; /* ANSI unsigned long long type */
61 * constants specific to the xdr "protocol"
63 #define XDR_FALSE ((long) 0)
64 #define XDR_TRUE ((long) 1)
65 #define LASTUNSIGNED ((u_int) 0-1)
70 static const char xdr_zero[BYTES_PER_XDR_UNIT] = { 0, 0, 0, 0 };
73 * Free a data structure using XDR
74 * Not a filter, but a convenient utility nonetheless
77 xdr_free(xdrproc_t proc, void *objp)
100 xdr_int(XDR *xdrs, int *ip)
104 switch (xdrs->x_op) {
108 return (XDR_PUTLONG(xdrs, &l));
111 if (!XDR_GETLONG(xdrs, &l)) {
125 * XDR unsigned integers
128 xdr_u_int(XDR *xdrs, u_int *up)
132 switch (xdrs->x_op) {
136 return (XDR_PUTLONG(xdrs, (long *)&l));
139 if (!XDR_GETLONG(xdrs, (long *)&l)) {
155 * same as xdr_u_long - open coded to save a proc call!
158 xdr_long(XDR *xdrs, long *lp)
160 switch (xdrs->x_op) {
162 return (XDR_PUTLONG(xdrs, lp));
164 return (XDR_GETLONG(xdrs, lp));
173 * XDR unsigned long integers
174 * same as xdr_long - open coded to save a proc call!
177 xdr_u_long(XDR *xdrs, u_long *ulp)
179 switch (xdrs->x_op) {
181 return (XDR_PUTLONG(xdrs, (long *)ulp));
183 return (XDR_GETLONG(xdrs, (long *)ulp));
193 * XDR 32-bit integers
194 * same as xdr_uint32_t - open coded to save a proc call!
197 xdr_int32_t(XDR *xdrs, int32_t *int32_p)
201 switch (xdrs->x_op) {
205 return (XDR_PUTLONG(xdrs, &l));
208 if (!XDR_GETLONG(xdrs, &l)) {
211 *int32_p = (int32_t) l;
222 * XDR unsigned 32-bit integers
223 * same as xdr_int32_t - open coded to save a proc call!
226 xdr_uint32_t(XDR *xdrs, uint32_t *uint32_p)
230 switch (xdrs->x_op) {
233 l = (u_long) *uint32_p;
234 return (XDR_PUTLONG(xdrs, (long *)&l));
237 if (!XDR_GETLONG(xdrs, (long *)&l)) {
240 *uint32_p = (uint32_t) l;
255 xdr_short(XDR *xdrs, short *sp)
259 switch (xdrs->x_op) {
263 return (XDR_PUTLONG(xdrs, &l));
266 if (!XDR_GETLONG(xdrs, &l)) {
280 * XDR unsigned short integers
283 xdr_u_short(XDR *xdrs, u_short *usp)
287 switch (xdrs->x_op) {
291 return (XDR_PUTLONG(xdrs, (long *)&l));
294 if (!XDR_GETLONG(xdrs, (long *)&l)) {
309 * XDR 16-bit integers
312 xdr_int16_t(XDR *xdrs, int16_t *int16_p)
316 switch (xdrs->x_op) {
320 return (XDR_PUTLONG(xdrs, &l));
323 if (!XDR_GETLONG(xdrs, &l)) {
326 *int16_p = (int16_t) l;
337 * XDR unsigned 16-bit integers
340 xdr_uint16_t(XDR *xdrs, uint16_t *uint16_p)
344 switch (xdrs->x_op) {
347 l = (u_long) *uint16_p;
348 return (XDR_PUTLONG(xdrs, (long *)&l));
351 if (!XDR_GETLONG(xdrs, (long *)&l)) {
354 *uint16_p = (uint16_t) l;
369 xdr_char(XDR *xdrs, char *cp)
374 if (!xdr_int(xdrs, &i)) {
382 * XDR an unsigned char
385 xdr_u_char(XDR *xdrs, u_char *cp)
390 if (!xdr_u_int(xdrs, &u)) {
401 xdr_bool(XDR *xdrs, bool_t *bp)
405 switch (xdrs->x_op) {
408 lb = *bp ? XDR_TRUE : XDR_FALSE;
409 return (XDR_PUTLONG(xdrs, &lb));
412 if (!XDR_GETLONG(xdrs, &lb)) {
415 *bp = (lb == XDR_FALSE) ? FALSE : TRUE;
429 xdr_enum(XDR *xdrs, enum_t *ep)
431 enum sizecheck { SIZEVAL }; /* used to find the size of an enum */
434 * enums are treated as ints
436 /* LINTED */ if (sizeof (enum sizecheck) == sizeof (long)) {
437 return (xdr_long(xdrs, (long *)(void *)ep));
438 } else /* LINTED */ if (sizeof (enum sizecheck) == sizeof (int)) {
439 return (xdr_int(xdrs, (int *)(void *)ep));
440 } else /* LINTED */ if (sizeof (enum sizecheck) == sizeof (short)) {
441 return (xdr_short(xdrs, (short *)(void *)ep));
449 * Allows the specification of a fixed size sequence of opaque bytes.
450 * cp points to the opaque object and cnt gives the byte length.
453 xdr_opaque(XDR *xdrs, caddr_t cp, u_int cnt)
456 static int crud[BYTES_PER_XDR_UNIT];
459 * if no data we are done
465 * round byte count to full xdr units
467 rndup = cnt % BYTES_PER_XDR_UNIT;
469 rndup = BYTES_PER_XDR_UNIT - rndup;
471 if (xdrs->x_op == XDR_DECODE) {
472 if (!XDR_GETBYTES(xdrs, cp, cnt)) {
477 return (XDR_GETBYTES(xdrs, (caddr_t)(void *)crud, rndup));
480 if (xdrs->x_op == XDR_ENCODE) {
481 if (!XDR_PUTBYTES(xdrs, cp, cnt)) {
486 return (XDR_PUTBYTES(xdrs, xdr_zero, rndup));
489 if (xdrs->x_op == XDR_FREE) {
498 * *cpp is a pointer to the bytes, *sizep is the count.
499 * If *cpp is NULL maxsize bytes are allocated
502 xdr_bytes(XDR *xdrs, char **cpp, u_int *sizep, u_int maxsize)
504 char *sp = *cpp; /* sp is the actual string pointer */
508 * first deal with the length since xdr bytes are counted
510 if (! xdr_u_int(xdrs, sizep)) {
514 if ((nodesize > maxsize) && (xdrs->x_op != XDR_FREE)) {
519 * now deal with the actual bytes
521 switch (xdrs->x_op) {
528 *cpp = sp = mem_alloc(nodesize);
531 printf("xdr_bytes: out of memory");
537 return (xdr_opaque(xdrs, sp, nodesize));
541 mem_free(sp, nodesize);
551 * Implemented here due to commonality of the object.
554 xdr_netobj(XDR *xdrs, struct netobj *np)
557 return (xdr_bytes(xdrs, &np->n_bytes, &np->n_len, MAX_NETOBJ_SZ));
561 * XDR a descriminated union
562 * Support routine for discriminated unions.
563 * You create an array of xdrdiscrim structures, terminated with
564 * an entry with a null procedure pointer. The routine gets
565 * the discriminant value and then searches the array of xdrdiscrims
566 * looking for that value. It calls the procedure given in the xdrdiscrim
567 * to handle the discriminant. If there is no specific routine a default
568 * routine may be called.
569 * If there is no specific or default routine an error is returned.
573 enum_t *dscmp, /* enum to decide which arm to work on */
574 char *unp, /* the union itself */
575 const struct xdr_discrim *choices, /* [value, xdr proc] for each arm */
576 xdrproc_t dfault) /* default xdr routine */
581 * we deal with the discriminator; it's an enum
583 if (! xdr_enum(xdrs, dscmp)) {
589 * search choices for a value that matches the discriminator.
590 * if we find one, execute the xdr routine for that value.
592 for (; choices->proc != NULL_xdrproc_t; choices++) {
593 if (choices->value == dscm)
594 return ((*(choices->proc))(xdrs, unp));
598 * no match - execute the default xdr routine if there is one
600 return ((dfault == NULL_xdrproc_t) ? FALSE :
601 (*dfault)(xdrs, unp));
606 * Non-portable xdr primitives.
607 * Care should be taken when moving these routines to new architectures.
612 * XDR null terminated ASCII strings
613 * xdr_string deals with "C strings" - arrays of bytes that are
614 * terminated by a NULL character. The parameter cpp references a
615 * pointer to storage; If the pointer is null, then the necessary
616 * storage is allocated. The last parameter is the max allowed length
617 * of the string as specified by a protocol.
620 xdr_string(XDR *xdrs, char **cpp, u_int maxsize)
622 char *sp = *cpp; /* sp is the actual string pointer */
627 * first deal with the length since xdr strings are counted-strings
629 switch (xdrs->x_op) {
632 return(TRUE); /* already free */
641 if (! xdr_u_int(xdrs, &size)) {
644 if (size > maxsize) {
650 * now deal with the actual bytes
652 switch (xdrs->x_op) {
659 *cpp = sp = mem_alloc(nodesize);
661 printf("xdr_string: out of memory");
668 return (xdr_opaque(xdrs, sp, size));
671 mem_free(sp, nodesize);
680 * Wrapper for xdr_string that can be called directly from
681 * routines like clnt_call
684 xdr_wrapstring(XDR *xdrs, char **cpp)
686 return xdr_string(xdrs, cpp, LASTUNSIGNED);
690 * NOTE: xdr_hyper(), xdr_u_hyper(), xdr_longlong_t(), and xdr_u_longlong_t()
691 * are in the "non-portable" section because they require that a `long long'
694 * --thorpej@netbsd.org, November 30, 1999
698 * XDR 64-bit integers
701 xdr_int64_t(XDR *xdrs, int64_t *llp)
705 switch (xdrs->x_op) {
707 ul[0] = (u_long)((uint64_t)*llp >> 32) & 0xffffffff;
708 ul[1] = (u_long)((uint64_t)*llp) & 0xffffffff;
709 if (XDR_PUTLONG(xdrs, (long *)&ul[0]) == FALSE)
711 return (XDR_PUTLONG(xdrs, (long *)&ul[1]));
713 if (XDR_GETLONG(xdrs, (long *)&ul[0]) == FALSE)
715 if (XDR_GETLONG(xdrs, (long *)&ul[1]) == FALSE)
718 (((uint64_t)ul[0] << 32) | ((uint64_t)ul[1]));
729 * XDR unsigned 64-bit integers
732 xdr_uint64_t(XDR *xdrs, uint64_t *ullp)
736 switch (xdrs->x_op) {
738 ul[0] = (u_long)(*ullp >> 32) & 0xffffffff;
739 ul[1] = (u_long)(*ullp) & 0xffffffff;
740 if (XDR_PUTLONG(xdrs, (long *)&ul[0]) == FALSE)
742 return (XDR_PUTLONG(xdrs, (long *)&ul[1]));
744 if (XDR_GETLONG(xdrs, (long *)&ul[0]) == FALSE)
746 if (XDR_GETLONG(xdrs, (long *)&ul[1]) == FALSE)
749 (((uint64_t)ul[0] << 32) | ((uint64_t)ul[1]));
763 xdr_hyper(XDR *xdrs, longlong_t *llp)
767 * Don't bother open-coding this; it's a fair amount of code. Just
768 * call xdr_int64_t().
770 return (xdr_int64_t(xdrs, (int64_t *)llp));
775 * XDR unsigned hypers
778 xdr_u_hyper(XDR *xdrs, u_longlong_t *ullp)
782 * Don't bother open-coding this; it's a fair amount of code. Just
783 * call xdr_uint64_t().
785 return (xdr_uint64_t(xdrs, (uint64_t *)ullp));
793 xdr_longlong_t(XDR *xdrs, longlong_t *llp)
797 * Don't bother open-coding this; it's a fair amount of code. Just
798 * call xdr_int64_t().
800 return (xdr_int64_t(xdrs, (int64_t *)llp));
808 xdr_u_longlong_t(XDR *xdrs, u_longlong_t *ullp)
812 * Don't bother open-coding this; it's a fair amount of code. Just
813 * call xdr_uint64_t().
815 return (xdr_uint64_t(xdrs, (uint64_t *)ullp));