sunrpc/xdr_ref.c

   1 /*
   2  * xdr_reference.c, Generic XDR routines implementation.
   3  *
   4  * Copyright (c) 2010, Oracle America, 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 the "Oracle America, 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 "pointers".  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 <wchar.h>
  43 #include <libio/iolibio.h>
  44
  45 #define LASTUNSIGNED    ((u_int)0-1)
  46
  47 /*
  48  * XDR an indirect pointer
  49  * xdr_reference is for recursively translating a structure that is
  50  * referenced by a pointer inside the structure that is currently being
  51  * translated.  pp references a pointer to storage. If *pp is null
  52  * the  necessary storage is allocated.
  53  * size is the size of the referneced structure.
  54  * proc is the routine to handle the referenced structure.
  55  */
  56 bool_t
  57 xdr_reference (xdrs, pp, size, proc)
  58      XDR *xdrs;
  59      caddr_t *pp;               /* the pointer to work on */
  60      u_int size;                /* size of the object pointed to */
  61      xdrproc_t proc;            /* xdr routine to handle the object */
  62 {
  63   caddr_t loc = *pp;
  64   bool_t stat;
  65
  66   if (loc == NULL)
  67     switch (xdrs->x_op)
  68       {
  69       case XDR_FREE:
  70         return TRUE;
  71
  72       case XDR_DECODE:
  73         *pp = loc = (caddr_t) calloc (1, size);
  74         if (loc == NULL)
  75           {
  76             (void) __fxprintf (NULL, "%s: %s", __func__, _("out of memory\n"));
  77             return FALSE;
  78           }
  79         break;
  80       default:
  81         break;
  82       }
  83
  84   stat = (*proc) (xdrs, loc, LASTUNSIGNED);
  85
  86   if (xdrs->x_op == XDR_FREE)
  87     {
  88       mem_free (loc, size);
  89       *pp = NULL;
  90     }
  91   return stat;
  92 }
  93 libc_hidden_nolink (xdr_reference, GLIBC_2_0)
  94
  95
  96 /*
  97  * xdr_pointer():
  98  *
  99  * XDR a pointer to a possibly recursive data structure. This
 100  * differs with xdr_reference in that it can serialize/deserialize
 101  * trees correctly.
 102  *
 103  *  What's sent is actually a union:
 104  *
 105  *  union object_pointer switch (boolean b) {
 106  *  case TRUE: object_data data;
 107  *  case FALSE: void nothing;
 108  *  }
 109  *
 110  * > objpp: Pointer to the pointer to the object.
 111  * > obj_size: size of the object.
 112  * > xdr_obj: routine to XDR an object.
 113  *
 114  */
 115 bool_t
 116 xdr_pointer (xdrs, objpp, obj_size, xdr_obj)
 117      XDR *xdrs;
 118      char **objpp;
 119      u_int obj_size;
 120      xdrproc_t xdr_obj;
 121 {
 122
 123   bool_t more_data;
 124
 125   more_data = (*objpp != NULL);
 126   if (!xdr_bool (xdrs, &more_data))
 127     {
 128       return FALSE;
 129     }
 130   if (!more_data)
 131     {
 132       *objpp = NULL;
 133       return TRUE;
 134     }
 135   return xdr_reference (xdrs, objpp, obj_size, xdr_obj);
 136 }
 137 #ifdef EXPORT_RPC_SYMBOLS
 138 libc_hidden_def (xdr_pointer)
 139 #else
 140 libc_hidden_nolink (xdr_pointer, GLIBC_2_0)
 141 #endif