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
49 #include <rpc/types.h>
57 * constants specific to the xdr "protocol"
59 #define XDR_FALSE ((long) 0)
60 #define XDR_TRUE ((long) 1)
61 #define LASTUNSIGNED ((u_int) 0-1)
66 static const char xdr_zero
[BYTES_PER_XDR_UNIT
] = {0, 0, 0, 0};
69 * Free a data structure using XDR
70 * Not a filter, but a convenient utility nonetheless
73 xdr_free (xdrproc_t proc
, char *objp
)
94 xdr_int (XDR
*xdrs
, int *ip
)
97 #if INT_MAX < LONG_MAX
104 return XDR_PUTLONG (xdrs
, &l
);
107 if (!XDR_GETLONG (xdrs
, &l
))
116 #elif INT_MAX == LONG_MAX
117 return xdr_long (xdrs
, (long *) ip
);
118 #elif INT_MAX == SHRT_MAX
119 return xdr_short (xdrs
, (short *) ip
);
121 #error unexpected integer sizes in_xdr_int()
126 * XDR unsigned integers
129 xdr_u_int (XDR
*xdrs
, u_int
*up
)
131 #if UINT_MAX < ULONG_MAX
138 return XDR_PUTLONG (xdrs
, &l
);
141 if (!XDR_GETLONG (xdrs
, &l
))
150 #elif UINT_MAX == ULONG_MAX
151 return xdr_u_long (xdrs
, (u_long
*) up
);
152 #elif UINT_MAX == USHRT_MAX
153 return xdr_short (xdrs
, (short *) up
);
155 #error unexpected integer sizes in_xdr_u_int()
161 * The definition of xdr_long() is kept for backward
162 * compatibility. Instead xdr_int() should be used.
165 xdr_long (XDR
*xdrs
, long *lp
)
168 if (xdrs
->x_op
== XDR_ENCODE
169 && (sizeof (int32_t) == sizeof (long)
170 || (int32_t) *lp
== *lp
))
171 return XDR_PUTLONG (xdrs
, lp
);
173 if (xdrs
->x_op
== XDR_DECODE
)
174 return XDR_GETLONG (xdrs
, lp
);
176 if (xdrs
->x_op
== XDR_FREE
)
183 * XDR unsigned long integers
184 * The definition of xdr_u_long() is kept for backward
185 * compatibility. Instead xdr_u_int() should be used.
188 xdr_u_long (XDR
*xdrs
, u_long
*ulp
)
196 if (XDR_GETLONG (xdrs
, &tmp
) == FALSE
)
199 *ulp
= (uint32_t) tmp
;
204 if (sizeof (uint32_t) != sizeof (u_long
)
205 && (uint32_t) *ulp
!= *ulp
)
208 return XDR_PUTLONG (xdrs
, (long *) ulp
);
218 * same as xdr_u_hyper - open coded to save a proc call!
221 xdr_hyper (XDR
*xdrs
, quad_t
*llp
)
224 unsigned long int t2
;
226 if (xdrs
->x_op
== XDR_ENCODE
)
228 t1
= (long) ((*llp
) >> 32);
230 return (XDR_PUTLONG(xdrs
, &t1
) && XDR_PUTLONG(xdrs
, &t2
));
233 if (xdrs
->x_op
== XDR_DECODE
)
235 if (!XDR_GETLONG(xdrs
, &t1
) || !XDR_GETLONG(xdrs
, &t2
))
237 *llp
= ((quad_t
) t1
) << 32;
242 if (xdrs
->x_op
== XDR_FREE
)
251 * same as xdr_hyper - open coded to save a proc call!
254 xdr_u_hyper (XDR
*xdrs
, u_quad_t
*ullp
)
259 if (xdrs
->x_op
== XDR_ENCODE
)
261 t1
= (unsigned long) ((*ullp
) >> 32);
262 t2
= (unsigned long) (*ullp
);
263 return (XDR_PUTLONG(xdrs
, &t1
) && XDR_PUTLONG(xdrs
, &t2
));
266 if (xdrs
->x_op
== XDR_DECODE
)
268 if (!XDR_GETLONG(xdrs
, &t1
) || !XDR_GETLONG(xdrs
, &t2
))
270 *ullp
= ((u_quad_t
) t1
) << 32;
275 if (xdrs
->x_op
== XDR_FREE
)
282 xdr_longlong_t (XDR
*xdrs
, quad_t
*llp
)
284 return xdr_hyper (xdrs
, llp
);
288 xdr_u_longlong_t (XDR
*xdrs
, u_quad_t
*ullp
)
290 return xdr_u_hyper (xdrs
, ullp
);
297 xdr_short (XDR
*xdrs
, short *sp
)
305 return XDR_PUTLONG (xdrs
, &l
);
308 if (!XDR_GETLONG (xdrs
, &l
))
322 * XDR unsigned short integers
325 xdr_u_short (XDR
*xdrs
, u_short
*usp
)
333 return XDR_PUTLONG (xdrs
, &l
);
336 if (!XDR_GETLONG (xdrs
, &l
))
354 xdr_char (XDR
*xdrs
, char *cp
)
359 if (!xdr_int (xdrs
, &i
))
368 * XDR an unsigned char
371 xdr_u_char (XDR
*xdrs
, u_char
*cp
)
376 if (!xdr_u_int (xdrs
, &u
))
388 xdr_bool (XDR
*xdrs
, bool_t
*bp
)
395 lb
= *bp
? XDR_TRUE
: XDR_FALSE
;
396 return XDR_PUTLONG (xdrs
, &lb
);
399 if (!XDR_GETLONG (xdrs
, &lb
))
403 *bp
= (lb
== XDR_FALSE
) ? FALSE
: TRUE
;
416 xdr_enum (XDR
*xdrs
, enum_t
*ep
)
421 }; /* used to find the size of an enum */
424 * enums are treated as ints
426 if (sizeof (enum sizecheck
) == 4)
428 #if INT_MAX < LONG_MAX
435 return XDR_PUTLONG (xdrs
, &l
);
438 if (!XDR_GETLONG (xdrs
, &l
))
449 return xdr_long (xdrs
, (long *) ep
);
452 else if (sizeof (enum sizecheck
) == sizeof (short))
454 return xdr_short (xdrs
, (short *) ep
);
464 * Allows the specification of a fixed size sequence of opaque bytes.
465 * cp points to the opaque object and cnt gives the byte length.
468 xdr_opaque (XDR
*xdrs
, caddr_t cp
, u_int cnt
)
471 static char crud
[BYTES_PER_XDR_UNIT
];
474 * if no data we are done
480 * round byte count to full xdr units
482 rndup
= cnt
% BYTES_PER_XDR_UNIT
;
484 rndup
= BYTES_PER_XDR_UNIT
- rndup
;
489 if (!XDR_GETBYTES (xdrs
, cp
, cnt
))
495 return XDR_GETBYTES (xdrs
, (caddr_t
)crud
, rndup
);
498 if (!XDR_PUTBYTES (xdrs
, cp
, cnt
))
504 return XDR_PUTBYTES (xdrs
, xdr_zero
, rndup
);
514 * *cpp is a pointer to the bytes, *sizep is the count.
515 * If *cpp is NULL maxsize bytes are allocated
518 xdr_bytes (xdrs
, cpp
, sizep
, maxsize
)
524 char *sp
= *cpp
; /* sp is the actual string pointer */
528 * first deal with the length since xdr bytes are counted
530 if (!xdr_u_int (xdrs
, sizep
))
535 if ((nodesize
> maxsize
) && (xdrs
->x_op
!= XDR_FREE
))
541 * now deal with the actual bytes
552 *cpp
= sp
= (char *) mem_alloc (nodesize
);
557 if (_IO_fwide (stderr
, 0) > 0)
558 (void) __fwprintf (stderr
, L
"%s", _("xdr_bytes: out of memory\n"));
561 (void) fputs (_("xdr_bytes: out of memory\n"), stderr
);
567 return xdr_opaque (xdrs
, sp
, nodesize
);
572 mem_free (sp
, nodesize
);
581 * Implemented here due to commonality of the object.
584 xdr_netobj (xdrs
, np
)
589 return xdr_bytes (xdrs
, &np
->n_bytes
, &np
->n_len
, MAX_NETOBJ_SZ
);
593 * XDR a discriminated union
594 * Support routine for discriminated unions.
595 * You create an array of xdrdiscrim structures, terminated with
596 * an entry with a null procedure pointer. The routine gets
597 * the discriminant value and then searches the array of xdrdiscrims
598 * looking for that value. It calls the procedure given in the xdrdiscrim
599 * to handle the discriminant. If there is no specific routine a default
600 * routine may be called.
601 * If there is no specific or default routine an error is returned.
604 xdr_union (xdrs
, dscmp
, unp
, choices
, dfault
)
606 enum_t
*dscmp
; /* enum to decide which arm to work on */
607 char *unp
; /* the union itself */
608 const struct xdr_discrim
*choices
; /* [value, xdr proc] for each arm */
609 xdrproc_t dfault
; /* default xdr routine */
614 * we deal with the discriminator; it's an enum
616 if (!xdr_enum (xdrs
, dscmp
))
623 * search choices for a value that matches the discriminator.
624 * if we find one, execute the xdr routine for that value.
626 for (; choices
->proc
!= NULL_xdrproc_t
; choices
++)
628 if (choices
->value
== dscm
)
629 return (*(choices
->proc
)) (xdrs
, unp
, LASTUNSIGNED
);
633 * no match - execute the default xdr routine if there is one
635 return ((dfault
== NULL_xdrproc_t
) ? FALSE
:
636 (*dfault
) (xdrs
, unp
, LASTUNSIGNED
));
641 * Non-portable xdr primitives.
642 * Care should be taken when moving these routines to new architectures.
647 * XDR null terminated ASCII strings
648 * xdr_string deals with "C strings" - arrays of bytes that are
649 * terminated by a NULL character. The parameter cpp references a
650 * pointer to storage; If the pointer is null, then the necessary
651 * storage is allocated. The last parameter is the max allowed length
652 * of the string as specified by a protocol.
655 xdr_string (xdrs
, cpp
, maxsize
)
660 char *sp
= *cpp
; /* sp is the actual string pointer */
665 * first deal with the length since xdr strings are counted-strings
672 return TRUE
; /* already free */
674 /* fall through... */
683 if (!xdr_u_int (xdrs
, &size
))
694 * now deal with the actual bytes
704 *cpp
= sp
= (char *) mem_alloc (nodesize
);
708 if (_IO_fwide (stderr
, 0) > 0)
709 (void) __fwprintf (stderr
, L
"%s",
710 _("xdr_string: out of memory\n"));
713 (void) fputs (_("xdr_string: out of memory\n"), stderr
);
720 return xdr_opaque (xdrs
, sp
, size
);
723 mem_free (sp
, nodesize
);
731 * Wrapper for xdr_string that can be called directly from
732 * routines like clnt_call
735 xdr_wrapstring (xdrs
, cpp
)
739 if (xdr_string (xdrs
, cpp
, LASTUNSIGNED
))