src/xdr_reference.c

   1 /*
   2  * Copyright (c) 2009, Sun Microsystems, Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  * - Redistributions of source code must retain the above copyright notice,
   8  *   this list of conditions and the following disclaimer.
   9  * - Redistributions in binary form must reproduce the above copyright notice,
  10  *   this list of conditions and the following disclaimer in the documentation
  11  *   and/or other materials provided with the distribution.
  12  * - Neither the name of Sun Microsystems, Inc. nor the names of its
  13  *   contributors may be used to endorse or promote products derived
  14  *   from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26  * POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 #include <sys/cdefs.h>
  30 #include <sys/cdefs.h>
  31
  32 /*
  33  * xdr_reference.c, Generic XDR routines impelmentation.
  34  *
  35  * Copyright (C) 1987, Sun Microsystems, Inc.
  36  *
  37  * These are the "non-trivial" xdr primitives used to serialize and de-serialize
  38  * "pointers".  See xdr.h for more info on the interface to xdr.
  39  */
  40
  41 #include "namespace.h"
  42 #include <err.h>
  43 #include <stdio.h>
  44 #include <stdlib.h>
  45 #include <string.h>
  46
  47 #include <rpc/types.h>
  48 #include <rpc/xdr.h>
  49
  50 #if defined(__FreeBSD__) || defined(__NetBSD__)
  51 #include <libc_private.h>
  52 #endif
  53
  54 /*
  55  * XDR an indirect pointer
  56  * xdr_reference is for recursively translating a structure that is
  57  * referenced by a pointer inside the structure that is currently being
  58  * translated.  pp references a pointer to storage. If *pp is null
  59  * the  necessary storage is allocated.
  60  * size is the sizeof the referneced structure.
  61  * proc is the routine to handle the referenced structure.
  62  */
  63 bool_t
  64 xdr_reference(xdrs, pp, size, proc)
  65         XDR *xdrs;
  66         caddr_t *pp;            /* the pointer to work on */
  67         u_int size;             /* size of the object pointed to */
  68         xdrproc_t proc;         /* xdr routine to handle the object */
  69 {
  70         caddr_t loc = *pp;
  71         bool_t stat;
  72
  73         if (loc == NULL)
  74                 switch (xdrs->x_op) {
  75                 case XDR_FREE:
  76                         return (TRUE);
  77
  78                 case XDR_DECODE:
  79                         *pp = loc = (caddr_t) mem_alloc(size);
  80                         if (loc == NULL) {
  81                                 warnx("xdr_reference: out of memory");
  82                                 return (FALSE);
  83                         }
  84                         memset(loc, 0, size);
  85                         break;
  86
  87                 case XDR_ENCODE:
  88                         break;
  89                 }
  90
  91         stat = (*proc)(xdrs, loc);
  92
  93         if (xdrs->x_op == XDR_FREE) {
  94                 mem_free(loc, size);
  95                 *pp = NULL;
  96         }
  97         return (stat);
  98 }
  99
 100
 101 /*
 102  * xdr_pointer():
 103  *
 104  * XDR a pointer to a possibly recursive data structure. This
 105  * differs with xdr_reference in that it can serialize/deserialiaze
 106  * trees correctly.
 107  *
 108  *  What's sent is actually a union:
 109  *
 110  *  union object_pointer switch (boolean b) {
 111  *  case TRUE: object_data data;
 112  *  case FALSE: void nothing;
 113  *  }
 114  *
 115  * > objpp: Pointer to the pointer to the object.
 116  * > obj_size: size of the object.
 117  * > xdr_obj: routine to XDR an object.
 118  *
 119  */
 120 bool_t
 121 xdr_pointer(xdrs,objpp,obj_size,xdr_obj)
 122         XDR *xdrs;
 123         char **objpp;
 124         u_int obj_size;
 125         xdrproc_t xdr_obj;
 126 {
 127
 128         bool_t more_data;
 129
 130         more_data = (*objpp != NULL);
 131         if (! xdr_bool(xdrs,&more_data)) {
 132                 return (FALSE);
 133         }
 134         if (! more_data) {
 135                 *objpp = NULL;
 136                 return (TRUE);
 137         }
 138         return (xdr_reference(xdrs,objpp,obj_size,xdr_obj));
 139 }