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