sunrpc/xdr_ref.c

   1 /* @(#)xdr_reference.c  2.1 88/07/29 4.0 RPCSRC */
   2 /*
   3  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
   4  * unrestricted use provided that this legend is included on all tape
   5  * media and as a part of the software program in whole or part.  Users
   6  * may copy or modify Sun RPC without charge, but are not authorized
   7  * to license or distribute it to anyone else except as part of a product or
   8  * program developed by the user.
   9  *
  10  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
  11  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
  12  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
  13  *
  14  * Sun RPC is provided with no support and without any obligation on the
  15  * part of Sun Microsystems, Inc. to assist in its use, correction,
  16  * modification or enhancement.
  17  *
  18  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
  19  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
  20  * OR ANY PART THEREOF.
  21  *
  22  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
  23  * or profits or other special, indirect and consequential damages, even if
  24  * Sun has been advised of the possibility of such damages.
  25  *
  26  * Sun Microsystems, Inc.
  27  * 2550 Garcia Avenue
  28  * Mountain View, California  94043
  29  */
  30 #if !defined(lint) && defined(SCCSIDS)
  31 static char sccsid[] = "@(#)xdr_reference.c 1.11 87/08/11 SMI";
  32 #endif
  33
  34 /*
  35  * xdr_reference.c, Generic XDR routines implementation.
  36  *
  37  * Copyright (C) 1987, Sun Microsystems, Inc.
  38  *
  39  * These are the "non-trivial" xdr primitives used to serialize and de-serialize
  40  * "pointers".  See xdr.h for more info on the interface to xdr.
  41  */
  42
  43 #include <stdio.h>
  44 #include <string.h>
  45 #include <rpc/types.h>
  46 #include <rpc/xdr.h>
  47 #include <libintl.h>
  48
  49 #ifdef USE_IN_LIBIO
  50 # include <libio/iolibio.h>
  51 # define fputs(s, f) _IO_fputs (s, f)
  52 #endif
  53
  54 #define LASTUNSIGNED    ((u_int)0-1)
  55
  56 /*
  57  * XDR an indirect pointer
  58  * xdr_reference is for recursively translating a structure that is
  59  * referenced by a pointer inside the structure that is currently being
  60  * translated.  pp references a pointer to storage. If *pp is null
  61  * the  necessary storage is allocated.
  62  * size is the size of the referneced structure.
  63  * proc is the routine to handle the referenced structure.
  64  */
  65 bool_t
  66 xdr_reference (xdrs, pp, size, proc)
  67      XDR *xdrs;
  68      caddr_t *pp;               /* the pointer to work on */
  69      u_int size;                /* size of the object pointed to */
  70      xdrproc_t proc;            /* xdr routine to handle the object */
  71 {
  72   caddr_t loc = *pp;
  73   bool_t stat;
  74
  75   if (loc == NULL)
  76     switch (xdrs->x_op)
  77       {
  78       case XDR_FREE:
  79         return TRUE;
  80
  81       case XDR_DECODE:
  82         *pp = loc = (caddr_t) mem_alloc (size);
  83         if (loc == NULL)
  84           {
  85             (void) fputs (_("xdr_reference: out of memory\n"), stderr);
  86             return FALSE;
  87           }
  88         __bzero (loc, (int) size);
  89         break;
  90       default:
  91         break;
  92       }
  93
  94   stat = (*proc) (xdrs, loc, LASTUNSIGNED);
  95
  96   if (xdrs->x_op == XDR_FREE)
  97     {
  98       mem_free (loc, size);
  99       *pp = NULL;
 100     }
 101   return stat;
 102 }
 103
 104
 105 /*
 106  * xdr_pointer():
 107  *
 108  * XDR a pointer to a possibly recursive data structure. This
 109  * differs with xdr_reference in that it can serialize/deserialize
 110  * trees correctly.
 111  *
 112  *  What's sent is actually a union:
 113  *
 114  *  union object_pointer switch (boolean b) {
 115  *  case TRUE: object_data data;
 116  *  case FALSE: void nothing;
 117  *  }
 118  *
 119  * > objpp: Pointer to the pointer to the object.
 120  * > obj_size: size of the object.
 121  * > xdr_obj: routine to XDR an object.
 122  *
 123  */
 124 bool_t
 125 xdr_pointer (xdrs, objpp, obj_size, xdr_obj)
 126      XDR *xdrs;
 127      char **objpp;
 128      u_int obj_size;
 129      xdrproc_t xdr_obj;
 130 {
 131
 132   bool_t more_data;
 133
 134   more_data = (*objpp != NULL);
 135   if (!xdr_bool (xdrs, &more_data))
 136     {
 137       return FALSE;
 138     }
 139   if (!more_data)
 140     {
 141       *objpp = NULL;
 142       return TRUE;
 143     }
 144   return xdr_reference (xdrs, objpp, obj_size, xdr_obj);
 145 }