1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  *
22*0Sstevel@tonic-gate  * Copyright 2002 Sun Microsystems, Inc.  All rights reserved.
23*0Sstevel@tonic-gate  * Use is subject to license terms.
24*0Sstevel@tonic-gate  */
25*0Sstevel@tonic-gate /* Copyright (c) 1983, 1984, 1985, 1986, 1987, 1988, 1989 AT&T */
26*0Sstevel@tonic-gate /* All Rights Reserved */
27*0Sstevel@tonic-gate /*
28*0Sstevel@tonic-gate  * Portions of this source code were derived from Berkeley
29*0Sstevel@tonic-gate  * 4.3 BSD under license from the Regents of the University of
30*0Sstevel@tonic-gate  * California.
31*0Sstevel@tonic-gate  */
32*0Sstevel@tonic-gate 
33*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
34*0Sstevel@tonic-gate 
35*0Sstevel@tonic-gate /*
36*0Sstevel@tonic-gate  * xdr_array.c, Generic XDR routines impelmentation.
37*0Sstevel@tonic-gate  *
38*0Sstevel@tonic-gate  * These are the "non-trivial" xdr primitives used to serialize and de-serialize
39*0Sstevel@tonic-gate  * arrays.  See xdr.h for more info on the interface to xdr.
40*0Sstevel@tonic-gate  */
41*0Sstevel@tonic-gate 
42*0Sstevel@tonic-gate #include <sys/types.h>
43*0Sstevel@tonic-gate #include <rpc/trace.h>
44*0Sstevel@tonic-gate #include <syslog.h>
45*0Sstevel@tonic-gate #include <stdio.h>
46*0Sstevel@tonic-gate #include <stdlib.h>
47*0Sstevel@tonic-gate 
48*0Sstevel@tonic-gate #include <rpc/types.h>
49*0Sstevel@tonic-gate #include <rpc/xdr.h>
50*0Sstevel@tonic-gate #include <memory.h>
51*0Sstevel@tonic-gate 
52*0Sstevel@tonic-gate #define	LASTUNSIGNED	((uint_t)0-1)
53*0Sstevel@tonic-gate 
54*0Sstevel@tonic-gate char mem_err_msg_arr[] = "xdr_array: out of memory";
55*0Sstevel@tonic-gate /*
56*0Sstevel@tonic-gate  * XDR an array of arbitrary elements
57*0Sstevel@tonic-gate  * *addrp is a pointer to the array, *sizep is the number of elements.
58*0Sstevel@tonic-gate  * If *addrp is NULL (*sizep * elsize) bytes are allocated.
59*0Sstevel@tonic-gate  * elsize is the size (in bytes) of each element, and elproc is the
60*0Sstevel@tonic-gate  * xdr procedure to call to handle each element of the array.
61*0Sstevel@tonic-gate  */
62*0Sstevel@tonic-gate bool_t
63*0Sstevel@tonic-gate xdr_array(XDR *xdrs, caddr_t *addrp, uint_t *sizep, uint_t maxsize,
64*0Sstevel@tonic-gate 	uint_t elsize, xdrproc_t elproc)
65*0Sstevel@tonic-gate {
66*0Sstevel@tonic-gate 	register uint_t i;
67*0Sstevel@tonic-gate 	register caddr_t target = *addrp;
68*0Sstevel@tonic-gate 	register uint_t c;  /* the actual element count */
69*0Sstevel@tonic-gate 	register bool_t stat = TRUE;
70*0Sstevel@tonic-gate 	register uint_t nodesize;
71*0Sstevel@tonic-gate 
72*0Sstevel@tonic-gate 	trace3(TR_xdr_array, 0, maxsize, elsize);
73*0Sstevel@tonic-gate 	/* like strings, arrays are really counted arrays */
74*0Sstevel@tonic-gate 	if (! xdr_u_int(xdrs, sizep)) {
75*0Sstevel@tonic-gate 		trace1(TR_xdr_array, 1);
76*0Sstevel@tonic-gate 		return (FALSE);
77*0Sstevel@tonic-gate 	}
78*0Sstevel@tonic-gate 	c = *sizep;
79*0Sstevel@tonic-gate 	if ((c > maxsize || LASTUNSIGNED / elsize < c) &&
80*0Sstevel@tonic-gate 	    xdrs->x_op != XDR_FREE) {
81*0Sstevel@tonic-gate 		trace1(TR_xdr_array, 1);
82*0Sstevel@tonic-gate 		return (FALSE);
83*0Sstevel@tonic-gate 	}
84*0Sstevel@tonic-gate 	nodesize = c * elsize;
85*0Sstevel@tonic-gate 
86*0Sstevel@tonic-gate 	/*
87*0Sstevel@tonic-gate 	 * if we are deserializing, we may need to allocate an array.
88*0Sstevel@tonic-gate 	 * We also save time by checking for a null array if we are freeing.
89*0Sstevel@tonic-gate 	 */
90*0Sstevel@tonic-gate 	if (target == NULL)
91*0Sstevel@tonic-gate 		switch (xdrs->x_op) {
92*0Sstevel@tonic-gate 		case XDR_DECODE:
93*0Sstevel@tonic-gate 			if (c == 0) {
94*0Sstevel@tonic-gate 				trace1(TR_xdr_array, 1);
95*0Sstevel@tonic-gate 				return (TRUE);
96*0Sstevel@tonic-gate 			}
97*0Sstevel@tonic-gate 			*addrp = target = (caddr_t)mem_alloc(nodesize);
98*0Sstevel@tonic-gate 			if (target == NULL) {
99*0Sstevel@tonic-gate 				(void) syslog(LOG_ERR, mem_err_msg_arr);
100*0Sstevel@tonic-gate 				trace1(TR_xdr_array, 1);
101*0Sstevel@tonic-gate 				return (FALSE);
102*0Sstevel@tonic-gate 			}
103*0Sstevel@tonic-gate 			(void) memset(target, 0, nodesize);
104*0Sstevel@tonic-gate 			break;
105*0Sstevel@tonic-gate 
106*0Sstevel@tonic-gate 		case XDR_FREE:
107*0Sstevel@tonic-gate 			trace1(TR_xdr_array, 1);
108*0Sstevel@tonic-gate 			return (TRUE);
109*0Sstevel@tonic-gate 	}
110*0Sstevel@tonic-gate 
111*0Sstevel@tonic-gate 	/*
112*0Sstevel@tonic-gate 	 * now we xdr each element of array
113*0Sstevel@tonic-gate 	 */
114*0Sstevel@tonic-gate 	for (i = 0; (i < c) && stat; i++) {
115*0Sstevel@tonic-gate 		stat = (*elproc)(xdrs, target);
116*0Sstevel@tonic-gate 		target += elsize;
117*0Sstevel@tonic-gate 	}
118*0Sstevel@tonic-gate 
119*0Sstevel@tonic-gate 	/*
120*0Sstevel@tonic-gate 	 * the array may need freeing
121*0Sstevel@tonic-gate 	 */
122*0Sstevel@tonic-gate 	if (xdrs->x_op == XDR_FREE) {
123*0Sstevel@tonic-gate 		mem_free(*addrp, nodesize);
124*0Sstevel@tonic-gate 		*addrp = NULL;
125*0Sstevel@tonic-gate 	}
126*0Sstevel@tonic-gate 	trace1(TR_xdr_array, 1);
127*0Sstevel@tonic-gate 	return (stat);
128*0Sstevel@tonic-gate }
129*0Sstevel@tonic-gate 
130*0Sstevel@tonic-gate /*
131*0Sstevel@tonic-gate  * xdr_vector():
132*0Sstevel@tonic-gate  *
133*0Sstevel@tonic-gate  * XDR a fixed length array. Unlike variable-length arrays,
134*0Sstevel@tonic-gate  * the storage of fixed length arrays is static and unfreeable.
135*0Sstevel@tonic-gate  * > basep: base of the array
136*0Sstevel@tonic-gate  * > size: size of the array
137*0Sstevel@tonic-gate  * > elemsize: size of each element
138*0Sstevel@tonic-gate  * > xdr_elem: routine to XDR each element
139*0Sstevel@tonic-gate  */
140*0Sstevel@tonic-gate bool_t
141*0Sstevel@tonic-gate xdr_vector(XDR *xdrs, char *basep, uint_t nelem,
142*0Sstevel@tonic-gate 	uint_t elemsize, xdrproc_t xdr_elem)
143*0Sstevel@tonic-gate {
144*0Sstevel@tonic-gate 	register uint_t i;
145*0Sstevel@tonic-gate 	register char *elptr;
146*0Sstevel@tonic-gate 
147*0Sstevel@tonic-gate 	trace3(TR_xdr_vector, 0, nelem, elemsize);
148*0Sstevel@tonic-gate 	elptr = basep;
149*0Sstevel@tonic-gate 	for (i = 0; i < nelem; i++) {
150*0Sstevel@tonic-gate 		if (! (*xdr_elem)(xdrs, elptr, LASTUNSIGNED)) {
151*0Sstevel@tonic-gate 			trace1(TR_xdr_vector, 1);
152*0Sstevel@tonic-gate 			return (FALSE);
153*0Sstevel@tonic-gate 		}
154*0Sstevel@tonic-gate 		elptr += elemsize;
155*0Sstevel@tonic-gate 	}
156*0Sstevel@tonic-gate 	trace1(TR_xdr_vector, 1);
157*0Sstevel@tonic-gate 	return (TRUE);
158*0Sstevel@tonic-gate }
159