rpc.subproj/xdr_reference.c

   1 /*
   2  * Copyright (c) 1999-2018 Apple 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 /*      $NetBSD: xdr_reference.c,v 1.13 2000/01/22 22:19:18 mycroft Exp $ */
  26
  27 /*
  28  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
  29  * unrestricted use provided that this legend is included on all tape
  30  * media and as a part of the software program in whole or part.  Users
  31  * may copy or modify Sun RPC without charge, but are not authorized
  32  * to license or distribute it to anyone else except as part of a product or
  33  * program developed by the user.
  34  *
  35  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
  36  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
  37  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
  38  *
  39  * Sun RPC is provided with no support and without any obligation on the
  40  * part of Sun Microsystems, Inc. to assist in its use, correction,
  41  * modification or enhancement.
  42  *
  43  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
  44  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
  45  * OR ANY PART THEREOF.
  46  *
  47  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
  48  * or profits or other special, indirect and consequential damages, even if
  49  * Sun has been advised of the possibility of such damages.
  50  *
  51  * Sun Microsystems, Inc.
  52  * 2550 Garcia Avenue
  53  * Mountain View, California  94043
  54  */
  55
  56 #include "libinfo_common.h"
  57
  58 #include <sys/cdefs.h>
  59 #if defined(LIBC_SCCS) && !defined(lint)
  60 static char *sccsid = "@(#)xdr_reference.c 1.11 87/08/11 SMI";
  61 static char *sccsid = "@(#)xdr_reference.c      2.1 88/07/29 4.0 RPCSRC";
  62 static char *rcsid = "$FreeBSD: src/lib/libc/xdr/xdr_reference.c,v 1.11 2002/03/22 21:53:26 obrien Exp $";
  63 #endif
  64 #include <sys/cdefs.h>
  65
  66 /*
  67  * xdr_reference.c, Generic XDR routines impelmentation.
  68  *
  69  * Copyright (C) 1987, Sun Microsystems, Inc.
  70  *
  71  * These are the "non-trivial" xdr primitives used to serialize and de-serialize
  72  * "pointers".  See xdr.h for more info on the interface to xdr.
  73  */
  74
  75 #include <err.h>
  76 #include <stdio.h>
  77 #include <stdlib.h>
  78 #include <string.h>
  79
  80 #include <rpc/types.h>
  81 #include <rpc/xdr.h>
  82
  83 /*
  84  * XDR an indirect pointer
  85  * xdr_reference is for recursively translating a structure that is
  86  * referenced by a pointer inside the structure that is currently being
  87  * translated.  pp references a pointer to storage. If *pp is null
  88  * the  necessary storage is allocated.
  89  * size is the sizeof the referneced structure.
  90  * proc is the routine to handle the referenced structure.
  91  */
  92 LIBINFO_EXPORT
  93 bool_t
  94 xdr_reference(xdrs, pp, size, proc)
  95         XDR *xdrs;
  96         caddr_t *pp;            /* the pointer to work on */
  97         u_int size;             /* size of the object pointed to */
  98         xdrproc_t proc;         /* xdr routine to handle the object */
  99 {
 100         caddr_t loc = *pp;
 101         bool_t stat;
 102
 103         if (loc == NULL)
 104                 switch (xdrs->x_op) {
 105                 case XDR_FREE:
 106                         return (TRUE);
 107
 108                 case XDR_DECODE:
 109                         *pp = loc = (caddr_t) mem_alloc(size);
 110                         if (loc == NULL) {
 111                                 warnx("xdr_reference: out of memory");
 112                                 return (FALSE);
 113                         }
 114                         memset(loc, 0, size);
 115                         break;
 116
 117                 case XDR_ENCODE:
 118                         break;
 119                 }
 120
 121         stat = (*proc)(xdrs, loc, 0);
 122
 123         if (xdrs->x_op == XDR_FREE) {
 124                 mem_free(loc, size);
 125                 *pp = NULL;
 126         }
 127         return (stat);
 128 }
 129
 130
 131 /*
 132  * xdr_pointer():
 133  *
 134  * XDR a pointer to a possibly recursive data structure. This
 135  * differs with xdr_reference in that it can serialize/deserialiaze
 136  * trees correctly.
 137  *
 138  *  What's sent is actually a union:
 139  *
 140  *  union object_pointer switch (boolean b) {
 141  *  case TRUE: object_data data;
 142  *  case FALSE: void nothing;
 143  *  }
 144  *
 145  * > objpp: Pointer to the pointer to the object.
 146  * > obj_size: size of the object.
 147  * > xdr_obj: routine to XDR an object.
 148  *
 149  */
 150 LIBINFO_EXPORT
 151 bool_t
 152 xdr_pointer(xdrs,objpp,obj_size,xdr_obj)
 153         XDR *xdrs;
 154         char **objpp;
 155         u_int obj_size;
 156         xdrproc_t xdr_obj;
 157 {
 158
 159         bool_t more_data;
 160
 161         more_data = (*objpp != NULL);
 162         if (! xdr_bool(xdrs,&more_data)) {
 163                 return (FALSE);
 164         }
 165         if (! more_data) {
 166                 *objpp = NULL;
 167                 return (TRUE);
 168         }
 169         return (xdr_reference(xdrs,objpp,obj_size,xdr_obj));
 170 }