sunrpc/xdr_array.c

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