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)
103 xdr_int(XDR *xdrs, int *ip)
107 switch (xdrs->x_op) {
110 return (XDR_PUTLONG(xdrs, &l));
113 if (!XDR_GETLONG(xdrs, &l)) {
127 * XDR unsigned integers
130 xdr_u_int(XDR *xdrs, u_int *up)
134 switch (xdrs->x_op) {
137 return (XDR_PUTLONG(xdrs, (long *)&l));
140 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));
192 * XDR 32-bit integers
193 * same as xdr_uint32_t - open coded to save a proc call!
196 xdr_int32_t(XDR *xdrs, int32_t *int32_p)
200 switch (xdrs->x_op) {
203 return (XDR_PUTLONG(xdrs, &l));
206 if (!XDR_GETLONG(xdrs, &l)) {
209 *int32_p = (int32_t) l;
220 * XDR unsigned 32-bit integers
221 * same as xdr_int32_t - open coded to save a proc call!
224 xdr_uint32_t(XDR *xdrs, uint32_t *uint32_p)
228 switch (xdrs->x_op) {
230 l = (u_long) *uint32_p;
231 return (XDR_PUTLONG(xdrs, (long *)&l));
234 if (!XDR_GETLONG(xdrs, (long *)&l)) {
237 *uint32_p = (uint32_t) l;
251 xdr_short(XDR *xdrs, short *sp)
255 switch (xdrs->x_op) {
258 return (XDR_PUTLONG(xdrs, &l));
261 if (!XDR_GETLONG(xdrs, &l)) {
275 * XDR unsigned short integers
278 xdr_u_short(XDR *xdrs, u_short *usp)
282 switch (xdrs->x_op) {
285 return (XDR_PUTLONG(xdrs, (long *)&l));
288 if (!XDR_GETLONG(xdrs, (long *)&l)) {
302 * XDR 16-bit integers
305 xdr_int16_t(XDR *xdrs, int16_t *int16_p)
309 switch (xdrs->x_op) {
312 return (XDR_PUTLONG(xdrs, &l));
315 if (!XDR_GETLONG(xdrs, &l)) {
318 *int16_p = (int16_t) l;
329 * XDR unsigned 16-bit integers
332 xdr_uint16_t(XDR *xdrs, uint16_t *uint16_p)
336 switch (xdrs->x_op) {
338 l = (u_long) *uint16_p;
339 return (XDR_PUTLONG(xdrs, (long *)&l));
342 if (!XDR_GETLONG(xdrs, (long *)&l)) {
345 *uint16_p = (uint16_t) l;
359 xdr_char(XDR *xdrs, char *cp)
364 if (!xdr_int(xdrs, &i)) {
372 * XDR an unsigned char
375 xdr_u_char(XDR *xdrs, u_char *cp)
380 if (!xdr_u_int(xdrs, &u)) {
391 xdr_bool(XDR *xdrs, bool_t *bp)
395 switch (xdrs->x_op) {
397 lb = *bp ? XDR_TRUE : XDR_FALSE;
398 return (XDR_PUTLONG(xdrs, &lb));
401 if (!XDR_GETLONG(xdrs, &lb)) {
404 *bp = (lb == XDR_FALSE) ? FALSE : TRUE;
418 xdr_enum(XDR *xdrs, enum_t *ep)
420 enum sizecheck { SIZEVAL }; /* used to find the size of an enum */
423 * enums are treated as ints
425 /* LINTED */ if (sizeof (enum sizecheck) == sizeof (long)) {
426 return (xdr_long(xdrs, (long *)(void *)ep));
427 } else /* LINTED */ if (sizeof (enum sizecheck) == sizeof (int)) {
428 return (xdr_int(xdrs, (int *)(void *)ep));
429 } else /* LINTED */ if (sizeof (enum sizecheck) == sizeof (short)) {
430 return (xdr_short(xdrs, (short *)(void *)ep));
438 * Allows the specification of a fixed size sequence of opaque bytes.
439 * cp points to the opaque object and cnt gives the byte length.
442 xdr_opaque(XDR *xdrs, caddr_t cp, u_int cnt)
445 static int crud[BYTES_PER_XDR_UNIT];
448 * if no data we are done
454 * round byte count to full xdr units
456 rndup = cnt % BYTES_PER_XDR_UNIT;
458 rndup = BYTES_PER_XDR_UNIT - rndup;
460 if (xdrs->x_op == XDR_DECODE) {
461 if (!XDR_GETBYTES(xdrs, cp, cnt)) {
466 return (XDR_GETBYTES(xdrs, (caddr_t)(void *)crud, rndup));
469 if (xdrs->x_op == XDR_ENCODE) {
470 if (!XDR_PUTBYTES(xdrs, cp, cnt)) {
475 return (XDR_PUTBYTES(xdrs, xdr_zero, rndup));
478 if (xdrs->x_op == XDR_FREE) {
487 * *cpp is a pointer to the bytes, *sizep is the count.
488 * If *cpp is NULL maxsize bytes are allocated
491 xdr_bytes(XDR *xdrs, char **cpp, u_int *sizep, u_int maxsize)
493 char *sp = *cpp; /* sp is the actual string pointer */
495 bool_t ret, allocated = FALSE;
498 * first deal with the length since xdr bytes are counted
500 if (! xdr_u_int(xdrs, sizep)) {
504 if ((nodesize > maxsize) && (xdrs->x_op != XDR_FREE)) {
509 * now deal with the actual bytes
511 switch (xdrs->x_op) {
517 *cpp = sp = mem_alloc(nodesize);
521 printf("xdr_bytes: out of memory");
527 ret = xdr_opaque(xdrs, sp, nodesize);
528 if ((xdrs->x_op == XDR_DECODE) && (ret == FALSE)) {
529 if (allocated == TRUE) {
530 mem_free(sp, nodesize);
538 mem_free(sp, nodesize);
548 * Implemented here due to commonality of the object.
551 xdr_netobj(XDR *xdrs, struct netobj *np)
554 return (xdr_bytes(xdrs, &np->n_bytes, &np->n_len, MAX_NETOBJ_SZ));
558 * XDR a descriminated union
559 * Support routine for discriminated unions.
560 * You create an array of xdrdiscrim structures, terminated with
561 * an entry with a null procedure pointer. The routine gets
562 * the discriminant value and then searches the array of xdrdiscrims
563 * looking for that value. It calls the procedure given in the xdrdiscrim
564 * to handle the discriminant. If there is no specific routine a default
565 * routine may be called.
566 * If there is no specific or default routine an error is returned.
570 enum_t *dscmp, /* enum to decide which arm to work on */
571 char *unp, /* the union itself */
572 const struct xdr_discrim *choices, /* [value, xdr proc] for each arm */
573 xdrproc_t dfault) /* default xdr routine */
578 * we deal with the discriminator; it's an enum
580 if (! xdr_enum(xdrs, dscmp)) {
586 * search choices for a value that matches the discriminator.
587 * if we find one, execute the xdr routine for that value.
589 for (; choices->proc != NULL_xdrproc_t; choices++) {
590 if (choices->value == dscm)
591 return ((*(choices->proc))(xdrs, unp));
595 * no match - execute the default xdr routine if there is one
597 return ((dfault == NULL_xdrproc_t) ? FALSE :
598 (*dfault)(xdrs, unp));
602 * Non-portable xdr primitives.
603 * Care should be taken when moving these routines to new architectures.
607 * XDR null terminated ASCII strings
608 * xdr_string deals with "C strings" - arrays of bytes that are
609 * terminated by a NULL character. The parameter cpp references a
610 * pointer to storage; If the pointer is null, then the necessary
611 * storage is allocated. The last parameter is the max allowed length
612 * of the string as specified by a protocol.
615 xdr_string(XDR *xdrs, char **cpp, u_int maxsize)
617 char *sp = *cpp; /* sp is the actual string pointer */
620 bool_t ret, allocated = FALSE;
623 * first deal with the length since xdr strings are counted-strings
625 switch (xdrs->x_op) {
628 return(TRUE); /* already free */
637 if (! xdr_u_int(xdrs, &size)) {
640 if (size > maxsize) {
646 * now deal with the actual bytes
648 switch (xdrs->x_op) {
654 *cpp = sp = mem_alloc(nodesize);
658 printf("xdr_string: out of memory");
665 ret = xdr_opaque(xdrs, sp, size);
666 if ((xdrs->x_op == XDR_DECODE) && (ret == FALSE)) {
667 if (allocated == TRUE) {
668 mem_free(sp, nodesize);
675 mem_free(sp, nodesize);
684 * Wrapper for xdr_string that can be called directly from
685 * routines like clnt_call
688 xdr_wrapstring(XDR *xdrs, char **cpp)
690 return xdr_string(xdrs, cpp, RPC_MAXDATASIZE);
694 * NOTE: xdr_hyper(), xdr_u_hyper(), xdr_longlong_t(), and xdr_u_longlong_t()
695 * are in the "non-portable" section because they require that a `long long'
698 * --thorpej@netbsd.org, November 30, 1999
702 * XDR 64-bit integers
705 xdr_int64_t(XDR *xdrs, int64_t *llp)
709 switch (xdrs->x_op) {
711 ul[0] = (u_long)((uint64_t)*llp >> 32) & 0xffffffff;
712 ul[1] = (u_long)((uint64_t)*llp) & 0xffffffff;
713 if (XDR_PUTLONG(xdrs, (long *)&ul[0]) == FALSE)
715 return (XDR_PUTLONG(xdrs, (long *)&ul[1]));
717 if (XDR_GETLONG(xdrs, (long *)&ul[0]) == FALSE)
719 if (XDR_GETLONG(xdrs, (long *)&ul[1]) == FALSE)
722 (((uint64_t)ul[0] << 32) | ((uint64_t)ul[1]));
732 * XDR unsigned 64-bit integers
735 xdr_uint64_t(XDR *xdrs, uint64_t *ullp)
739 switch (xdrs->x_op) {
741 ul[0] = (u_long)(*ullp >> 32) & 0xffffffff;
742 ul[1] = (u_long)(*ullp) & 0xffffffff;
743 if (XDR_PUTLONG(xdrs, (long *)&ul[0]) == FALSE)
745 return (XDR_PUTLONG(xdrs, (long *)&ul[1]));
747 if (XDR_GETLONG(xdrs, (long *)&ul[0]) == FALSE)
749 if (XDR_GETLONG(xdrs, (long *)&ul[1]) == FALSE)
752 (((uint64_t)ul[0] << 32) | ((uint64_t)ul[1]));
765 xdr_hyper(XDR *xdrs, longlong_t *llp)
769 * Don't bother open-coding this; it's a fair amount of code. Just
770 * call xdr_int64_t().
772 return (xdr_int64_t(xdrs, (int64_t *)llp));
776 * XDR unsigned hypers
779 xdr_u_hyper(XDR *xdrs, u_longlong_t *ullp)
783 * Don't bother open-coding this; it's a fair amount of code. Just
784 * call xdr_uint64_t().
786 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));
807 xdr_u_longlong_t(XDR *xdrs, u_longlong_t *ullp)
811 * Don't bother open-coding this; it's a fair amount of code. Just
812 * call xdr_uint64_t().
814 return (xdr_uint64_t(xdrs, (uint64_t *)ullp));
821 xdr_modevent(module_t mod, int type, void *data)
826 static moduledata_t xdr_mod = {
831 DECLARE_MODULE(xdr, xdr_mod, SI_SUB_VFS, SI_ORDER_ANY);
832 MODULE_VERSION(xdr, 1);