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 const 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
68 xdr_free (xdrproc_t proc
, char *objp
)
89 xdr_int (XDR
*xdrs
, int *ip
)
92 #if INT_MAX < LONG_MAX
99 return XDR_PUTLONG (xdrs
, &l
);
102 if (!XDR_GETLONG (xdrs
, &l
))
111 #elif INT_MAX == LONG_MAX
112 return xdr_long (xdrs
, (long *) ip
);
113 #elif INT_MAX == SHRT_MAX
114 return xdr_short (xdrs
, (short *) ip
);
116 #error unexpected integer sizes in_xdr_int()
121 * XDR unsigned integers
124 xdr_u_int (XDR
*xdrs
, u_int
*up
)
126 #if UINT_MAX < ULONG_MAX
133 return XDR_PUTLONG (xdrs
, &l
);
136 if (!XDR_GETLONG (xdrs
, &l
))
145 #elif UINT_MAX == ULONG_MAX
146 return xdr_u_long (xdrs
, (u_long
*) up
);
147 #elif UINT_MAX == USHRT_MAX
148 return xdr_short (xdrs
, (short *) up
);
150 #error unexpected integer sizes in_xdr_u_int()
158 xdr_int32_t (XDR
*xdrs
, int32_t *lp
)
161 if (xdrs
->x_op
== XDR_ENCODE
)
162 return XDR_PUTINT32 (xdrs
, lp
);
164 if (xdrs
->x_op
== XDR_DECODE
)
165 return XDR_GETINT32 (xdrs
, lp
);
167 if (xdrs
->x_op
== XDR_FREE
)
174 * XDR 32bit unsigned integers
177 xdr_uint32_t (XDR
*xdrs
, uint32_t *ulp
)
182 return XDR_GETINT32 (xdrs
, (uint32_t *) ulp
);
185 return XDR_PUTINT32 (xdrs
, (uint32_t *) ulp
);
195 * same as xdr_u_long - open coded to save a proc call!
198 xdr_long (XDR
*xdrs
, long *lp
)
201 if (xdrs
->x_op
== XDR_ENCODE
)
202 return XDR_PUTLONG (xdrs
, lp
);
204 if (xdrs
->x_op
== XDR_DECODE
)
205 return XDR_GETLONG (xdrs
, lp
);
207 if (xdrs
->x_op
== XDR_FREE
)
214 * XDR unsigned long integers
215 * same as xdr_long - open coded to save a proc call!
218 xdr_u_long (XDR
*xdrs
, u_long
*ulp
)
223 return XDR_GETLONG (xdrs
, (long *) ulp
);
226 return XDR_PUTLONG (xdrs
, (long *) ulp
);
248 return XDR_PUTLONG (xdrs
, &l
);
251 if (!XDR_GETLONG (xdrs
, &l
))
265 * XDR unsigned short integers
268 xdr_u_short (xdrs
, usp
)
278 return XDR_PUTLONG (xdrs
, &l
);
281 if (!XDR_GETLONG (xdrs
, &l
))
306 if (!xdr_int (xdrs
, &i
))
315 * XDR an unsigned char
318 xdr_u_char (xdrs
, cp
)
325 if (!xdr_u_int (xdrs
, &u
))
346 lb
= *bp
? XDR_TRUE
: XDR_FALSE
;
347 return XDR_PUTLONG (xdrs
, &lb
);
350 if (!XDR_GETLONG (xdrs
, &lb
))
354 *bp
= (lb
== XDR_FALSE
) ? FALSE
: TRUE
;
374 }; /* used to find the size of an enum */
377 * enums are treated as ints
379 if (sizeof (enum sizecheck
) == 4)
381 #if INT_MAX < LONG_MAX
388 return XDR_PUTLONG (xdrs
, &l
);
391 if (!XDR_GETLONG (xdrs
, &l
))
402 return xdr_long (xdrs
, (long *) ep
);
405 else if (sizeof (enum sizecheck
) == sizeof (short))
407 return xdr_short (xdrs
, (short *) ep
);
417 * Allows the specification of a fixed size sequence of opaque bytes.
418 * cp points to the opaque object and cnt gives the byte length.
421 xdr_opaque (xdrs
, cp
, cnt
)
427 static char crud
[BYTES_PER_XDR_UNIT
];
430 * if no data we are done
436 * round byte count to full xdr units
438 rndup
= cnt
% BYTES_PER_XDR_UNIT
;
440 rndup
= BYTES_PER_XDR_UNIT
- rndup
;
445 if (!XDR_GETBYTES (xdrs
, cp
, cnt
))
451 return XDR_GETBYTES (xdrs
, (caddr_t
)crud
, rndup
);
454 if (!XDR_PUTBYTES (xdrs
, cp
, cnt
))
460 return XDR_PUTBYTES (xdrs
, xdr_zero
, rndup
);
470 * *cpp is a pointer to the bytes, *sizep is the count.
471 * If *cpp is NULL maxsize bytes are allocated
474 xdr_bytes (xdrs
, cpp
, sizep
, maxsize
)
480 char *sp
= *cpp
; /* sp is the actual string pointer */
484 * first deal with the length since xdr bytes are counted
486 if (!xdr_u_int (xdrs
, sizep
))
491 if ((nodesize
> maxsize
) && (xdrs
->x_op
!= XDR_FREE
))
497 * now deal with the actual bytes
508 *cpp
= sp
= (char *) mem_alloc (nodesize
);
512 (void) fprintf (stderr
, "xdr_bytes: out of memory\n");
518 return xdr_opaque (xdrs
, sp
, nodesize
);
523 mem_free (sp
, nodesize
);
532 * Implemented here due to commonality of the object.
535 xdr_netobj (xdrs
, np
)
540 return xdr_bytes (xdrs
, &np
->n_bytes
, &np
->n_len
, MAX_NETOBJ_SZ
);
544 * XDR a discriminated union
545 * Support routine for discriminated unions.
546 * You create an array of xdrdiscrim structures, terminated with
547 * an entry with a null procedure pointer. The routine gets
548 * the discriminant value and then searches the array of xdrdiscrims
549 * looking for that value. It calls the procedure given in the xdrdiscrim
550 * to handle the discriminant. If there is no specific routine a default
551 * routine may be called.
552 * If there is no specific or default routine an error is returned.
555 xdr_union (xdrs
, dscmp
, unp
, choices
, dfault
)
557 enum_t
*dscmp
; /* enum to decide which arm to work on */
558 char *unp
; /* the union itself */
559 const struct xdr_discrim
*choices
; /* [value, xdr proc] for each arm */
560 xdrproc_t dfault
; /* default xdr routine */
565 * we deal with the discriminator; it's an enum
567 if (!xdr_enum (xdrs
, dscmp
))
574 * search choices for a value that matches the discriminator.
575 * if we find one, execute the xdr routine for that value.
577 for (; choices
->proc
!= NULL_xdrproc_t
; choices
++)
579 if (choices
->value
== dscm
)
580 return (*(choices
->proc
)) (xdrs
, unp
, LASTUNSIGNED
);
584 * no match - execute the default xdr routine if there is one
586 return ((dfault
== NULL_xdrproc_t
) ? FALSE
:
587 (*dfault
) (xdrs
, unp
, LASTUNSIGNED
));
592 * Non-portable xdr primitives.
593 * Care should be taken when moving these routines to new architectures.
598 * XDR null terminated ASCII strings
599 * xdr_string deals with "C strings" - arrays of bytes that are
600 * terminated by a NULL character. The parameter cpp references a
601 * pointer to storage; If the pointer is null, then the necessary
602 * storage is allocated. The last parameter is the max allowed length
603 * of the string as specified by a protocol.
606 xdr_string (xdrs
, cpp
, maxsize
)
611 char *sp
= *cpp
; /* sp is the actual string pointer */
616 * first deal with the length since xdr strings are counted-strings
623 return TRUE
; /* already free */
625 /* fall through... */
634 if (!xdr_u_int (xdrs
, &size
))
645 * now deal with the actual bytes
655 *cpp
= sp
= (char *) mem_alloc (nodesize
);
658 (void) fprintf (stderr
, "xdr_string: out of memory\n");
665 return xdr_opaque (xdrs
, sp
, size
);
668 mem_free (sp
, nodesize
);
676 * Wrapper for xdr_string that can be called directly from
677 * routines like clnt_call
680 xdr_wrapstring (xdrs
, cpp
)
684 if (xdr_string (xdrs
, cpp
, LASTUNSIGNED
))