xref: /freebsd/lib/libc/xdr/xdr_array.c (revision 3cbb4cc200f8a0ad7ed08233425ea54524a21f1c)
1 /*	$NetBSD: xdr_array.c,v 1.12 2000/01/22 22:19:18 mycroft Exp $	*/
2 
3 /*-
4  * SPDX-License-Identifier: BSD-3-Clause
5  *
6  * Copyright (c) 2010, Oracle America, Inc.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are
10  * met:
11  *
12  *     * Redistributions of source code must retain the above copyright
13  *       notice, this list of conditions and the following disclaimer.
14  *     * Redistributions in binary form must reproduce the above
15  *       copyright notice, this list of conditions and the following
16  *       disclaimer in the documentation and/or other materials
17  *       provided with the distribution.
18  *     * Neither the name of the "Oracle America, Inc." nor the names of its
19  *       contributors may be used to endorse or promote products derived
20  *       from this software without specific prior written permission.
21  *
22  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25  *   FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26  *   COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
27  *   INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  *   DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29  *   GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30  *   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
31  *   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32  *   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34  */
35 
36 #if defined(LIBC_SCCS) && !defined(lint)
37 static char *sccsid2 = "@(#)xdr_array.c 1.10 87/08/11 Copyr 1984 Sun Micro";
38 static char *sccsid = "@(#)xdr_array.c	2.1 88/07/29 4.0 RPCSRC";
39 #endif
40 #include <sys/cdefs.h>
41 __FBSDID("$FreeBSD$");
42 
43 /*
44  * xdr_array.c, Generic XDR routines implementation.
45  *
46  * These are the "non-trivial" xdr primitives used to serialize and de-serialize
47  * arrays.  See xdr.h for more info on the interface to xdr.
48  */
49 
50 #include "namespace.h"
51 #include <err.h>
52 #include <limits.h>
53 #include <stdio.h>
54 #include <stdlib.h>
55 #include <string.h>
56 
57 #include <rpc/types.h>
58 #include <rpc/xdr.h>
59 #include "un-namespace.h"
60 
61 /*
62  * XDR an array of arbitrary elements
63  * *addrp is a pointer to the array, *sizep is the number of elements.
64  * If addrp is NULL (*sizep * elsize) bytes are allocated.
65  * elsize is the size (in bytes) of each element, and elproc is the
66  * xdr procedure to call to handle each element of the array.
67  */
68 bool_t
69 xdr_array(XDR *xdrs, caddr_t *addrp, u_int *sizep, u_int maxsize, u_int elsize, xdrproc_t elproc)
70 /*
71  *	XDR *xdrs;
72  *	caddr_t *addrp;		// array pointer
73  *	u_int *sizep;		// number of elements
74  *	u_int maxsize;		// max numberof elements
75  *	u_int elsize;		// size in bytes of each element
76  *	xdrproc_t elproc;	// xdr routine to handle each element
77  */
78 {
79 	u_int i;
80 	caddr_t target = *addrp;
81 	u_int c;  /* the actual element count */
82 	bool_t stat = TRUE;
83 	u_int nodesize;
84 
85 	/* like strings, arrays are really counted arrays */
86 	if (!xdr_u_int(xdrs, sizep)) {
87 		return (FALSE);
88 	}
89 	c = *sizep;
90 	if ((c > maxsize || UINT_MAX/elsize < c) &&
91 	    (xdrs->x_op != XDR_FREE)) {
92 		return (FALSE);
93 	}
94 	nodesize = c * elsize;
95 
96 	/*
97 	 * if we are deserializing, we may need to allocate an array.
98 	 * We also save time by checking for a null array if we are freeing.
99 	 */
100 	if (target == NULL)
101 		switch (xdrs->x_op) {
102 		case XDR_DECODE:
103 			if (c == 0)
104 				return (TRUE);
105 			*addrp = target = mem_alloc(nodesize);
106 			if (target == NULL) {
107 				warnx("xdr_array: out of memory");
108 				return (FALSE);
109 			}
110 			memset(target, 0, nodesize);
111 			break;
112 
113 		case XDR_FREE:
114 			return (TRUE);
115 
116 		case XDR_ENCODE:
117 			break;
118 	}
119 
120 	/*
121 	 * now we xdr each element of array
122 	 */
123 	for (i = 0; (i < c) && stat; i++) {
124 		stat = (*elproc)(xdrs, target);
125 		target += elsize;
126 	}
127 
128 	/*
129 	 * the array may need freeing
130 	 */
131 	if (xdrs->x_op == XDR_FREE) {
132 		mem_free(*addrp, nodesize);
133 		*addrp = NULL;
134 	}
135 	return (stat);
136 }
137 
138 /*
139  * xdr_vector():
140  *
141  * XDR a fixed length array. Unlike variable-length arrays,
142  * the storage of fixed length arrays is static and unfreeable.
143  * > basep: base of the array
144  * > size: size of the array
145  * > elemsize: size of each element
146  * > xdr_elem: routine to XDR each element
147  */
148 bool_t
149 xdr_vector(XDR *xdrs, char *basep, u_int nelem, u_int elemsize, xdrproc_t xdr_elem)
150 {
151 	u_int i;
152 	char *elptr;
153 
154 	elptr = basep;
155 	for (i = 0; i < nelem; i++) {
156 		if (!(*xdr_elem)(xdrs, elptr)) {
157 			return(FALSE);
158 		}
159 		elptr += elemsize;
160 	}
161 	return(TRUE);
162 }
163