xref: /freebsd/lib/libc/xdr/xdr_array.c (revision 1ca63a8219b88b752b064d19bd3428c61dbcf1f9)
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 /*
41  * xdr_array.c, Generic XDR routines implementation.
42  *
43  * These are the "non-trivial" xdr primitives used to serialize and de-serialize
44  * arrays.  See xdr.h for more info on the interface to xdr.
45  */
46 
47 #include "namespace.h"
48 #include <err.h>
49 #include <limits.h>
50 #include <stdio.h>
51 #include <stdlib.h>
52 #include <string.h>
53 
54 #include <rpc/types.h>
55 #include <rpc/xdr.h>
56 #include "un-namespace.h"
57 
58 /*
59  * XDR an array of arbitrary elements
60  * *addrp is a pointer to the array, *sizep is the number of elements.
61  * If addrp is NULL (*sizep * elsize) bytes are allocated.
62  * elsize is the size (in bytes) of each element, and elproc is the
63  * xdr procedure to call to handle each element of the array.
64  */
65 bool_t
66 xdr_array(XDR *xdrs, caddr_t *addrp, u_int *sizep, u_int maxsize, u_int elsize, xdrproc_t elproc)
67 /*
68  *	XDR *xdrs;
69  *	caddr_t *addrp;		// array pointer
70  *	u_int *sizep;		// number of elements
71  *	u_int maxsize;		// max numberof elements
72  *	u_int elsize;		// size in bytes of each element
73  *	xdrproc_t elproc;	// xdr routine to handle each element
74  */
75 {
76 	u_int i;
77 	caddr_t target = *addrp;
78 	u_int c;  /* the actual element count */
79 	bool_t stat = TRUE;
80 	u_int nodesize;
81 
82 	/* like strings, arrays are really counted arrays */
83 	if (!xdr_u_int(xdrs, sizep)) {
84 		return (FALSE);
85 	}
86 	c = *sizep;
87 	if ((c > maxsize || UINT_MAX/elsize < c) &&
88 	    (xdrs->x_op != XDR_FREE)) {
89 		return (FALSE);
90 	}
91 	nodesize = c * elsize;
92 
93 	/*
94 	 * if we are deserializing, we may need to allocate an array.
95 	 * We also save time by checking for a null array if we are freeing.
96 	 */
97 	if (target == NULL)
98 		switch (xdrs->x_op) {
99 		case XDR_DECODE:
100 			if (c == 0)
101 				return (TRUE);
102 			*addrp = target = mem_alloc(nodesize);
103 			if (target == NULL) {
104 				warnx("xdr_array: out of memory");
105 				return (FALSE);
106 			}
107 			memset(target, 0, nodesize);
108 			break;
109 
110 		case XDR_FREE:
111 			return (TRUE);
112 
113 		case XDR_ENCODE:
114 			break;
115 	}
116 
117 	/*
118 	 * now we xdr each element of array
119 	 */
120 	for (i = 0; (i < c) && stat; i++) {
121 		stat = (*elproc)(xdrs, target);
122 		target += elsize;
123 	}
124 
125 	/*
126 	 * the array may need freeing
127 	 */
128 	if (xdrs->x_op == XDR_FREE) {
129 		mem_free(*addrp, nodesize);
130 		*addrp = NULL;
131 	}
132 	return (stat);
133 }
134 
135 /*
136  * xdr_vector():
137  *
138  * XDR a fixed length array. Unlike variable-length arrays,
139  * the storage of fixed length arrays is static and unfreeable.
140  * > basep: base of the array
141  * > size: size of the array
142  * > elemsize: size of each element
143  * > xdr_elem: routine to XDR each element
144  */
145 bool_t
146 xdr_vector(XDR *xdrs, char *basep, u_int nelem, u_int elemsize, xdrproc_t xdr_elem)
147 {
148 	u_int i;
149 	char *elptr;
150 
151 	elptr = basep;
152 	for (i = 0; i < nelem; i++) {
153 		if (!(*xdr_elem)(xdrs, elptr)) {
154 			return(FALSE);
155 		}
156 		elptr += elemsize;
157 	}
158 	return(TRUE);
159 }
160