rpc.subproj/xdr_reference.c

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