xref: /dragonfly/lib/libc/xdr/xdr_array.c (revision c03f08f3)
1 /*
2  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
3  * unrestricted use provided that this legend is included on all tape
4  * media and as a part of the software program in whole or part.  Users
5  * may copy or modify Sun RPC without charge, but are not authorized
6  * to license or distribute it to anyone else except as part of a product or
7  * program developed by the user.
8  *
9  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
10  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
11  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
12  *
13  * Sun RPC is provided with no support and without any obligation on the
14  * part of Sun Microsystems, Inc. to assist in its use, correction,
15  * modification or enhancement.
16  *
17  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
18  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
19  * OR ANY PART THEREOF.
20  *
21  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
22  * or profits or other special, indirect and consequential damages, even if
23  * Sun has been advised of the possibility of such damages.
24  *
25  * Sun Microsystems, Inc.
26  * 2550 Garcia Avenue
27  * Mountain View, California  94043
28  *
29  * @(#)xdr_array.c 1.10 87/08/11 Copyr 1984 Sun Micro
30  * @(#)xdr_array.c	2.1 88/07/29 4.0 RPCSRC
31  * $FreeBSD: src/lib/libc/xdr/xdr_array.c,v 1.8.2.3 2002/08/01 12:23:20 nectar Exp $
32  * $DragonFly: src/lib/libc/xdr/xdr_array.c,v 1.4 2005/12/05 00:47:57 swildner Exp $
33  */
34 
35 /*
36  * xdr_array.c, Generic XDR routines impelmentation.
37  *
38  * Copyright (C) 1984, Sun Microsystems, Inc.
39  *
40  * These are the "non-trivial" xdr primitives used to serialize and de-serialize
41  * arrays.  See xdr.h for more info on the interface to xdr.
42  */
43 
44 #include <limits.h>
45 #include <stdio.h>
46 #include <stdlib.h>
47 #include <string.h>
48 #include <rpc/types.h>
49 #include <rpc/xdr.h>
50 
51 #define LASTUNSIGNED ((u_int) 0-1)
52 
53 /*
54  * XDR an array of arbitrary elements
55  * *addrp is a pointer to the array, *sizep is the number of elements.
56  * If addrp is NULL (*sizep * elsize) bytes are allocated.
57  * elsize is the size (in bytes) of each element, and elproc is the
58  * xdr procedure to call to handle each element of the array.
59  *
60  * Parameters:
61  *     addrp:	array pointer
62  *     sizep:	number of elements
63  *     maxsize: max number of elements
64  *     elsize:  size in bytes of each element
65  *     elproc:	xdr routine to handle each element
66  */
67 bool_t
68 xdr_array(XDR *xdrs, caddr_t *addrp, u_int *sizep, u_int maxsize, u_int elsize,
69 	  xdrproc_t elproc)
70 {
71 	u_int i;
72 	caddr_t target = *addrp;
73 	u_int c;  /* the actual element count */
74 	bool_t stat = TRUE;
75 	u_int nodesize;
76 
77 	/* like strings, arrays are really counted arrays */
78 	if (!xdr_u_int(xdrs, sizep)) {
79 		return (FALSE);
80 	}
81 	c = *sizep;
82 	if ((c > maxsize || UINT_MAX/elsize < c) &&
83 	    (xdrs->x_op != XDR_FREE)) {
84 		return (FALSE);
85 	}
86 	nodesize = c * elsize;
87 
88 	/*
89 	 * if we are deserializing, we may need to allocate an array.
90 	 * We also save time by checking for a null array if we are freeing.
91 	 */
92 	if (target == NULL)
93 		switch (xdrs->x_op) {
94 		case XDR_DECODE:
95 			if (c == 0)
96 				return (TRUE);
97 			*addrp = target = mem_alloc(nodesize);
98 			if (target == NULL) {
99 				fprintf(stderr,
100 					"xdr_array: out of memory\n");
101 				return (FALSE);
102 			}
103 			memset(target, 0, nodesize);
104 			break;
105 
106 		case XDR_FREE:
107 			return (TRUE);
108 		case XDR_ENCODE:
109 			break;
110 	}
111 
112 	/*
113 	 * now we xdr each element of array
114 	 */
115 	for (i = 0; (i < c) && stat; i++) {
116 		stat = (*elproc)(xdrs, target, LASTUNSIGNED);
117 		target += elsize;
118 	}
119 
120 	/*
121 	 * the array may need freeing
122 	 */
123 	if (xdrs->x_op == XDR_FREE) {
124 		mem_free(*addrp, nodesize);
125 		*addrp = NULL;
126 	}
127 	return (stat);
128 }
129 
130 /*
131  * xdr_vector():
132  *
133  * XDR a fixed length array. Unlike variable-length arrays,
134  * the storage of fixed length arrays is static and unfreeable.
135  * > basep: base of the array
136  * > size: size of the array
137  * > elemsize: size of each element
138  * > xdr_elem: routine to XDR each element
139  */
140 bool_t
141 xdr_vector(XDR *xdrs, char *basep, u_int nelem, u_int elemsize,
142 	   xdrproc_t xdr_elem)
143 {
144 	u_int i;
145 	char *elptr;
146 
147 	elptr = basep;
148 	for (i = 0; i < nelem; i++) {
149 		if (!(*xdr_elem)(xdrs, elptr, LASTUNSIGNED)) {
150 			return(FALSE);
151 		}
152 		elptr += elemsize;
153 	}
154 	return(TRUE);
155 }
156 
157