lib/libc/xdr/xdr_array.c

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