rpc.subproj/xdr_array.c

   1 /*
   2  * Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Portions Copyright (c) 1999 Apple Computer, Inc.  All Rights
   7  * Reserved.  This file contains Original Code and/or Modifications of
   8  * Original Code as defined in and that are subject to the Apple Public
   9  * Source License Version 1.1 (the "License").  You may not use this file
  10  * except in compliance with the License.  Please obtain a copy of the
  11  * License at http://www.apple.com/publicsource and read it before using
  12  * this file.
  13  *
  14  * The Original Code and all software distributed under the License are
  15  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  16  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  17  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE OR NON- INFRINGEMENT.  Please see the
  19  * License for the specific language governing rights and limitations
  20  * under the License.
  21  *
  22  * @APPLE_LICENSE_HEADER_END@
  23  */
  24
  25 /*      $NetBSD: xdr_array.c,v 1.12 2000/01/22 22:19:18 mycroft Exp $   */
  26
  27 /*
  28  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
  29  * unrestricted use provided that this legend is included on all tape
  30  * media and as a part of the software program in whole or part.  Users
  31  * may copy or modify Sun RPC without charge, but are not authorized
  32  * to license or distribute it to anyone else except as part of a product or
  33  * program developed by the user.
  34  *
  35  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
  36  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
  37  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
  38  *
  39  * Sun RPC is provided with no support and without any obligation on the
  40  * part of Sun Microsystems, Inc. to assist in its use, correction,
  41  * modification or enhancement.
  42  *
  43  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
  44  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
  45  * OR ANY PART THEREOF.
  46  *
  47  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
  48  * or profits or other special, indirect and consequential damages, even if
  49  * Sun has been advised of the possibility of such damages.
  50  *
  51  * Sun Microsystems, Inc.
  52  * 2550 Garcia Avenue
  53  * Mountain View, California  94043
  54  */
  55
  56 #if defined(LIBC_SCCS) && !defined(lint)
  57 static char *sccsid = "@(#)xdr_array.c 1.10 87/08/11 Copyr 1984 Sun Micro";
  58 static char *sccsid = "@(#)xdr_array.c  2.1 88/07/29 4.0 RPCSRC";
  59 #endif
  60 #include <sys/cdefs.h>
  61
  62 /*
  63  * xdr_array.c, Generic XDR routines impelmentation.
  64  *
  65  * Copyright (C) 1984, Sun Microsystems, Inc.
  66  *
  67  * These are the "non-trivial" xdr primitives used to serialize and de-serialize
  68  * arrays.  See xdr.h for more info on the interface to xdr.
  69  */
  70
  71 #include <err.h>
  72 #include <limits.h>
  73 #include <stdio.h>
  74 #include <stdlib.h>
  75 #include <string.h>
  76
  77 #include <rpc/types.h>
  78 #include <rpc/xdr.h>
  79
  80 /*
  81  * XDR an array of arbitrary elements
  82  * *addrp is a pointer to the array, *sizep is the number of elements.
  83  * If addrp is NULL (*sizep * elsize) bytes are allocated.
  84  * elsize is the size (in bytes) of each element, and elproc is the
  85  * xdr procedure to call to handle each element of the array.
  86  */
  87 bool_t
  88 xdr_array(xdrs, addrp, sizep, maxsize, elsize, elproc)
  89         XDR *xdrs;
  90         caddr_t *addrp;         /* array pointer */
  91         u_int *sizep;           /* number of elements */
  92         u_int maxsize;          /* max numberof elements */
  93         u_int elsize;           /* size in bytes of each element */
  94         xdrproc_t elproc;       /* xdr routine to handle each element */
  95 {
  96         u_int i;
  97         caddr_t target = *addrp;
  98         u_int c;  /* the actual element count */
  99         bool_t stat = TRUE;
 100         u_int nodesize;
 101
 102         /* like strings, arrays are really counted arrays */
 103         if (!xdr_u_int(xdrs, sizep)) {
 104                 return (FALSE);
 105         }
 106         c = *sizep;
 107         if ((c > maxsize || UINT_MAX/elsize < c) &&
 108             (xdrs->x_op != XDR_FREE)) {
 109                 return (FALSE);
 110         }
 111         nodesize = c * elsize;
 112
 113         /*
 114          * if we are deserializing, we may need to allocate an array.
 115          * We also save time by checking for a null array if we are freeing.
 116          */
 117         if (target == NULL)
 118                 switch (xdrs->x_op) {
 119                 case XDR_DECODE:
 120                         if (c == 0)
 121                                 return (TRUE);
 122                         *addrp = target = mem_alloc(nodesize);
 123                         if (target == NULL) {
 124                                 warnx("xdr_array: out of memory");
 125                                 return (FALSE);
 126                         }
 127                         memset(target, 0, nodesize);
 128                         break;
 129
 130                 case XDR_FREE:
 131                         return (TRUE);
 132
 133                 case XDR_ENCODE:
 134                         break;
 135         }
 136
 137         /*
 138          * now we xdr each element of array
 139          */
 140         for (i = 0; (i < c) && stat; i++) {
 141                 stat = (*elproc)(xdrs, target, 0);
 142                 target += elsize;
 143         }
 144
 145         /*
 146          * the array may need freeing
 147          */
 148         if (xdrs->x_op == XDR_FREE) {
 149                 mem_free(*addrp, nodesize);
 150                 *addrp = NULL;
 151         }
 152         return (stat);
 153 }
 154
 155 /*
 156  * xdr_vector():
 157  *
 158  * XDR a fixed length array. Unlike variable-length arrays,
 159  * the storage of fixed length arrays is static and unfreeable.
 160  * > basep: base of the array
 161  * > size: size of the array
 162  * > elemsize: size of each element
 163  * > xdr_elem: routine to XDR each element
 164  */
 165 bool_t
 166 xdr_vector(xdrs, basep, nelem, elemsize, xdr_elem)
 167         XDR *xdrs;
 168         char *basep;
 169         u_int nelem;
 170         u_int elemsize;
 171         xdrproc_t xdr_elem;
 172 {
 173         u_int i;
 174         char *elptr;
 175
 176         elptr = basep;
 177         for (i = 0; i < nelem; i++) {
 178                 if (!(*xdr_elem)(xdrs, elptr, 0)) {
 179                         return(FALSE);
 180                 }
 181                 elptr += elemsize;
 182         }
 183         return(TRUE);
 184 }