rpc.subproj/xdr_reference.c

   1 /*
   2  * Copyright (c) 1999 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Portions Copyright (c) 1999 Apple Computer, Inc.  All Rights
   7  * Reserved.  This file contains Original Code and/or Modifications of
   8  * Original Code as defined in and that are subject to the Apple Public
   9  * Source License Version 1.1 (the "License").  You may not use this file
  10  * except in compliance with the License.  Please obtain a copy of the
  11  * License at http://www.apple.com/publicsource and read it before using
  12  * this file.
  13  *
  14  * The Original Code and all software distributed under the License are
  15  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  16  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  17  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE OR NON- INFRINGEMENT.  Please see the
  19  * License for the specific language governing rights and limitations
  20  * under the License.
  21  *
  22  * @APPLE_LICENSE_HEADER_END@
  23  */
  24 /*
  25  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
  26  * unrestricted use provided that this legend is included on all tape
  27  * media and as a part of the software program in whole or part.  Users
  28  * may copy or modify Sun RPC without charge, but are not authorized
  29  * to license or distribute it to anyone else except as part of a product or
  30  * program developed by the user.
  31  *
  32  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
  33  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
  34  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
  35  *
  36  * Sun RPC is provided with no support and without any obligation on the
  37  * part of Sun Microsystems, Inc. to assist in its use, correction,
  38  * modification or enhancement.
  39  *
  40  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
  41  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
  42  * OR ANY PART THEREOF.
  43  *
  44  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
  45  * or profits or other special, indirect and consequential damages, even if
  46  * Sun has been advised of the possibility of such damages.
  47  *
  48  * Sun Microsystems, Inc.
  49  * 2550 Garcia Avenue
  50  * Mountain View, California  94043
  51  */
  52
  53 #if defined(LIBC_SCCS) && !defined(lint)
  54 /*static char *sccsid = "from: @(#)xdr_reference.c 1.11 87/08/11 SMI";*/
  55 /*static char *sccsid = "from: @(#)xdr_reference.c      2.1 88/07/29 4.0 RPCSRC";*/
  56 static char *rcsid = "$Id: xdr_reference.c,v 1.3 2002/02/19 20:36:26 epeyton Exp $";
  57 #endif
  58
  59 /*
  60  * xdr_reference.c, Generic XDR routines impelmentation.
  61  *
  62  * Copyright (C) 1987, Sun Microsystems, Inc.
  63  *
  64  * These are the "non-trivial" xdr primitives used to serialize and de-serialize
  65  * "pointers".  See xdr.h for more info on the interface to xdr.
  66  */
  67
  68 #include <stdio.h>
  69 #include <stdlib.h>
  70 #include <string.h>
  71 #include <rpc/types.h>
  72 #include <rpc/xdr.h>
  73
  74 #define LASTUNSIGNED    ((u_int)0-1)
  75
  76 /*
  77  * XDR an indirect pointer
  78  * xdr_reference is for recursively translating a structure that is
  79  * referenced by a pointer inside the structure that is currently being
  80  * translated.  pp references a pointer to storage. If *pp is null
  81  * the  necessary storage is allocated.
  82  * size is the sizeof the referneced structure.
  83  * proc is the routine to handle the referenced structure.
  84  */
  85 bool_t
  86 xdr_reference(xdrs, pp, size, proc)
  87         register XDR *xdrs;
  88         caddr_t *pp;            /* the pointer to work on */
  89         u_int size;             /* size of the object pointed to */
  90         xdrproc_t proc;         /* xdr routine to handle the object */
  91 {
  92         register caddr_t loc = *pp;
  93         register bool_t stat;
  94
  95         if (loc == NULL)
  96                 switch (xdrs->x_op) {
  97                 case XDR_FREE:
  98                         return (TRUE);
  99
 100                 case XDR_DECODE:
 101                         *pp = loc = (caddr_t) mem_alloc(size);
 102                         if (loc == NULL) {
 103                                 (void) fprintf(stderr,
 104                                     "xdr_reference: out of memory\n");
 105                                 return (FALSE);
 106                         }
 107                         bzero(loc, (int)size);
 108                         break;
 109         }
 110
 111         stat = (*proc)(xdrs, loc, LASTUNSIGNED);
 112
 113         if (xdrs->x_op == XDR_FREE) {
 114                 mem_free(loc, size);
 115                 *pp = NULL;
 116         }
 117         return (stat);
 118 }
 119
 120
 121 /*
 122  * xdr_pointer():
 123  *
 124  * XDR a pointer to a possibly recursive data structure. This
 125  * differs with xdr_reference in that it can serialize/deserialiaze
 126  * trees correctly.
 127  *
 128  *  What's sent is actually a union:
 129  *
 130  *  union object_pointer switch (boolean b) {
 131  *  case TRUE: object_data data;
 132  *  case FALSE: void nothing;
 133  *  }
 134  *
 135  * > objpp: Pointer to the pointer to the object.
 136  * > obj_size: size of the object.
 137  * > xdr_obj: routine to XDR an object.
 138  *
 139  */
 140 bool_t
 141 xdr_pointer(xdrs,objpp,obj_size,xdr_obj)
 142         register XDR *xdrs;
 143         char **objpp;
 144         u_int obj_size;
 145         xdrproc_t xdr_obj;
 146 {
 147
 148         bool_t more_data;
 149
 150         more_data = (*objpp != NULL);
 151         if (! xdr_bool(xdrs,&more_data)) {
 152                 return (FALSE);
 153         }
 154         if (! more_data) {
 155                 *objpp = NULL;
 156                 return (TRUE);
 157         }
 158         return (xdr_reference(xdrs,objpp,obj_size,xdr_obj));
 159 }