sys/xdr/xdr_array.c

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