libc/inet/rpc/xdr_reference.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 0
  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
  48 #define LASTUNSIGNED    ((u_int)0-1)
  49
  50 /*
  51  * XDR an indirect pointer
  52  * xdr_reference is for recursively translating a structure that is
  53  * referenced by a pointer inside the structure that is currently being
  54  * translated.  pp references a pointer to storage. If *pp is null
  55  * the  necessary storage is allocated.
  56  * size is the size of the referneced structure.
  57  * proc is the routine to handle the referenced structure.
  58  */
  59 bool_t
  60 xdr_reference (XDR *xdrs, caddr_t *pp, u_int size, xdrproc_t proc)
  61 {
  62   caddr_t loc = *pp;
  63   bool_t stat;
  64
  65   if (loc == NULL)
  66     switch (xdrs->x_op)
  67       {
  68       case XDR_FREE:
  69         return TRUE;
  70
  71       case XDR_DECODE:
  72         *pp = loc = (caddr_t) mem_alloc (size);
  73         if (loc == NULL)
  74           {
  75             (void) fputs ("xdr_reference: out of memory\n", stderr);
  76             return FALSE;
  77           }
  78         memset (loc, 0, (int) size);
  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_def(xdr_reference)
  94
  95 /*
  96  * xdr_pointer():
  97  *
  98  * XDR a pointer to a possibly recursive data structure. This
  99  * differs with xdr_reference in that it can serialize/deserialize
 100  * trees correctly.
 101  *
 102  *  What's sent is actually a union:
 103  *
 104  *  union object_pointer switch (boolean b) {
 105  *  case TRUE: object_data data;
 106  *  case FALSE: void nothing;
 107  *  }
 108  *
 109  * > objpp: Pointer to the pointer to the object.
 110  * > obj_size: size of the object.
 111  * > xdr_obj: routine to XDR an object.
 112  *
 113  */
 114 bool_t
 115 xdr_pointer (XDR *xdrs, char **objpp, u_int obj_size, xdrproc_t xdr_obj)
 116 {
 117
 118   bool_t more_data;
 119
 120   more_data = (*objpp != NULL);
 121   if (!xdr_bool (xdrs, &more_data))
 122     {
 123       return FALSE;
 124     }
 125   if (!more_data)
 126     {
 127       *objpp = NULL;
 128       return TRUE;
 129     }
 130   return xdr_reference (xdrs, objpp, obj_size, xdr_obj);
 131 }