1 /* @(#)xdr.c 2.1 88/07/29 4.0 RPCSRC */
3 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
4 * unrestricted use provided that this legend is included on all tape
5 * media and as a part of the software program in whole or part. Users
6 * may copy or modify Sun RPC without charge, but are not authorized
7 * to license or distribute it to anyone else except as part of a product or
8 * program developed by the user.
10 * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
11 * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
12 * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
14 * Sun RPC is provided with no support and without any obligation on the
15 * part of Sun Microsystems, Inc. to assist in its use, correction,
16 * modification or enhancement.
18 * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
19 * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
20 * OR ANY PART THEREOF.
22 * In no event will Sun Microsystems, Inc. be liable for any lost revenue
23 * or profits or other special, indirect and consequential damages, even if
24 * Sun has been advised of the possibility of such damages.
26 * Sun Microsystems, Inc.
28 * Mountain View, California 94043
30 #if !defined(lint) && defined(SCCSIDS)
31 static char sccsid[] = "@(#)xdr.c 1.35 87/08/12";
35 * xdr.c, Generic XDR routines implementation.
37 * Copyright (C) 1986, Sun Microsystems, Inc.
39 * These are the "generic" xdr routines used to serialize and de-serialize
40 * most common data items. See xdr.h for more info on the interface to
48 #include <rpc/types.h>
52 * constants specific to the xdr "protocol"
54 #define XDR_FALSE ((long) 0)
55 #define XDR_TRUE ((long) 1)
56 #define LASTUNSIGNED ((u_int) 0-1)
61 static char xdr_zero[BYTES_PER_XDR_UNIT] = { 0, 0, 0, 0 };
64 * Free a data structure using XDR
65 * Not a filter, but a convenient utility nonetheless
82 xdr_void(/* xdrs, addr */)
99 (void) (xdr_short(xdrs, (short *)ip));
100 return (xdr_long(xdrs, (long *)ip));
102 if (sizeof (int) == sizeof (long)) {
103 return (xdr_long(xdrs, (long *)ip));
105 return (xdr_short(xdrs, (short *)ip));
111 * XDR unsigned integers
120 (void) (xdr_short(xdrs, (short *)up));
121 return (xdr_u_long(xdrs, (u_long *)up));
123 if (sizeof (u_int) == sizeof (u_long)) {
124 return (xdr_u_long(xdrs, (u_long *)up));
126 return (xdr_short(xdrs, (short *)up));
133 * same as xdr_u_long - open coded to save a proc call!
141 if (xdrs->x_op == XDR_ENCODE)
142 return (XDR_PUTLONG(xdrs, lp));
144 if (xdrs->x_op == XDR_DECODE)
145 return (XDR_GETLONG(xdrs, lp));
147 if (xdrs->x_op == XDR_FREE)
154 * XDR unsigned long integers
155 * same as xdr_long - open coded to save a proc call!
158 xdr_u_long(xdrs, ulp)
163 if (xdrs->x_op == XDR_DECODE)
164 return (XDR_GETLONG(xdrs, (long *)ulp));
165 if (xdrs->x_op == XDR_ENCODE)
166 return (XDR_PUTLONG(xdrs, (long *)ulp));
167 if (xdrs->x_op == XDR_FREE)
182 switch (xdrs->x_op) {
186 return (XDR_PUTLONG(xdrs, &l));
189 if (!XDR_GETLONG(xdrs, &l)) {
202 * XDR unsigned short integers
205 xdr_u_short(xdrs, usp)
211 switch (xdrs->x_op) {
215 return (XDR_PUTLONG(xdrs, &l));
218 if (!XDR_GETLONG(xdrs, &l)) {
242 if (!xdr_int(xdrs, &i)) {
250 * XDR an unsigned char
260 if (!xdr_u_int(xdrs, &u)) {
277 switch (xdrs->x_op) {
280 lb = *bp ? XDR_TRUE : XDR_FALSE;
281 return (XDR_PUTLONG(xdrs, &lb));
284 if (!XDR_GETLONG(xdrs, &lb)) {
287 *bp = (lb == XDR_FALSE) ? FALSE : TRUE;
305 enum sizecheck { SIZEVAL }; /* used to find the size of an enum */
308 * enums are treated as ints
310 if (sizeof (enum sizecheck) == sizeof (long)) {
311 return (xdr_long(xdrs, (long *)ep));
312 } else if (sizeof (enum sizecheck) == sizeof (short)) {
313 return (xdr_short(xdrs, (short *)ep));
318 (void) (xdr_short(xdrs, (short *)ep));
319 return (xdr_long(xdrs, (long *)ep));
325 * Allows the specification of a fixed size sequence of opaque bytes.
326 * cp points to the opaque object and cnt gives the byte length.
329 xdr_opaque(xdrs, cp, cnt)
334 register u_int rndup;
335 static char crud[BYTES_PER_XDR_UNIT];
338 * if no data we are done
344 * round byte count to full xdr units
346 rndup = cnt % BYTES_PER_XDR_UNIT;
348 rndup = BYTES_PER_XDR_UNIT - rndup;
350 if (xdrs->x_op == XDR_DECODE) {
351 if (!XDR_GETBYTES(xdrs, cp, cnt)) {
356 return (XDR_GETBYTES(xdrs, crud, rndup));
359 if (xdrs->x_op == XDR_ENCODE) {
360 if (!XDR_PUTBYTES(xdrs, cp, cnt)) {
365 return (XDR_PUTBYTES(xdrs, xdr_zero, rndup));
368 if (xdrs->x_op == XDR_FREE) {
377 * *cpp is a pointer to the bytes, *sizep is the count.
378 * If *cpp is NULL maxsize bytes are allocated
381 xdr_bytes(xdrs, cpp, sizep, maxsize)
384 register u_int *sizep;
387 register char *sp = *cpp; /* sp is the actual string pointer */
388 register u_int nodesize;
391 * first deal with the length since xdr bytes are counted
393 if (! xdr_u_int(xdrs, sizep)) {
397 if ((nodesize > maxsize) && (xdrs->x_op != XDR_FREE)) {
402 * now deal with the actual bytes
404 switch (xdrs->x_op) {
411 *cpp = sp = (char *)mem_alloc(nodesize);
414 (void) fprintf(stderr, "xdr_bytes: out of memory\n");
420 return (xdr_opaque(xdrs, sp, nodesize));
424 mem_free(sp, nodesize);
433 * Implemented here due to commonality of the object.
441 return (xdr_bytes(xdrs, &np->n_bytes, &np->n_len, MAX_NETOBJ_SZ));
445 * XDR a descriminated union
446 * Support routine for discriminated unions.
447 * You create an array of xdrdiscrim structures, terminated with
448 * an entry with a null procedure pointer. The routine gets
449 * the discriminant value and then searches the array of xdrdiscrims
450 * looking for that value. It calls the procedure given in the xdrdiscrim
451 * to handle the discriminant. If there is no specific routine a default
452 * routine may be called.
453 * If there is no specific or default routine an error is returned.
456 xdr_union(xdrs, dscmp, unp, choices, dfault)
458 enum_t *dscmp; /* enum to decide which arm to work on */
459 char *unp; /* the union itself */
460 struct xdr_discrim *choices; /* [value, xdr proc] for each arm */
461 xdrproc_t dfault; /* default xdr routine */
463 register enum_t dscm;
466 * we deal with the discriminator; it's an enum
468 if (! xdr_enum(xdrs, dscmp)) {
474 * search choices for a value that matches the discriminator.
475 * if we find one, execute the xdr routine for that value.
477 for (; choices->proc != NULL_xdrproc_t; choices++) {
478 if (choices->value == dscm)
479 return ((*(choices->proc))(xdrs, unp, LASTUNSIGNED));
483 * no match - execute the default xdr routine if there is one
485 return ((dfault == NULL_xdrproc_t) ? FALSE :
486 (*dfault)(xdrs, unp, LASTUNSIGNED));
491 * Non-portable xdr primitives.
492 * Care should be taken when moving these routines to new architectures.
497 * XDR null terminated ASCII strings
498 * xdr_string deals with "C strings" - arrays of bytes that are
499 * terminated by a NULL character. The parameter cpp references a
500 * pointer to storage; If the pointer is null, then the necessary
501 * storage is allocated. The last parameter is the max allowed length
502 * of the string as specified by a protocol.
505 xdr_string(xdrs, cpp, maxsize)
510 register char *sp = *cpp; /* sp is the actual string pointer */
515 * first deal with the length since xdr strings are counted-strings
517 switch (xdrs->x_op) {
518 case XDR_DECODE: break; /* keep gcc happy */
521 return(TRUE); /* already free */
523 /* fall through... */
528 if (! xdr_u_int(xdrs, &size)) {
531 if (size > maxsize) {
537 * now deal with the actual bytes
539 switch (xdrs->x_op) {
546 *cpp = sp = (char *)mem_alloc(nodesize);
548 (void) fprintf(stderr, "xdr_string: out of memory\n");
555 return (xdr_opaque(xdrs, sp, size));
558 mem_free(sp, nodesize);
566 * Wrapper for xdr_string that can be called directly from
567 * routines like clnt_call
570 xdr_wrapstring(xdrs, cpp)
574 if (xdr_string(xdrs, cpp, LASTUNSIGNED)) {