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/*	$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 <sys/cdefs.h>
57#if defined(LIBC_SCCS) && !defined(lint)
58static char *sccsid = "@(#)xdr_reference.c 1.11 87/08/11 SMI";
59static char *sccsid = "@(#)xdr_reference.c	2.1 88/07/29 4.0 RPCSRC";
60static char *rcsid = "$FreeBSD: src/lib/libc/xdr/xdr_reference.c,v 1.11 2002/03/22 21:53:26 obrien Exp $";
61#endif
62#include <sys/cdefs.h>
63
64/*
65 * xdr_reference.c, Generic XDR routines impelmentation.
66 *
67 * Copyright (C) 1987, Sun Microsystems, Inc.
68 *
69 * These are the "non-trivial" xdr primitives used to serialize and de-serialize
70 * "pointers".  See xdr.h for more info on the interface to xdr.
71 */
72
73#include <err.h>
74#include <stdio.h>
75#include <stdlib.h>
76#include <string.h>
77
78#include <rpc/types.h>
79#include <rpc/xdr.h>
80
81/*
82 * XDR an indirect pointer
83 * xdr_reference is for recursively translating a structure that is
84 * referenced by a pointer inside the structure that is currently being
85 * translated.  pp references a pointer to storage. If *pp is null
86 * the  necessary storage is allocated.
87 * size is the sizeof the referneced structure.
88 * proc is the routine to handle the referenced structure.
89 */
90bool_t
91xdr_reference(xdrs, pp, size, proc)
92	XDR *xdrs;
93	caddr_t *pp;		/* the pointer to work on */
94	u_int size;		/* size of the object pointed to */
95	xdrproc_t proc;		/* xdr routine to handle the object */
96{
97	caddr_t loc = *pp;
98	bool_t stat;
99
100	if (loc == NULL)
101		switch (xdrs->x_op) {
102		case XDR_FREE:
103			return (TRUE);
104
105		case XDR_DECODE:
106			*pp = loc = (caddr_t) mem_alloc(size);
107			if (loc == NULL) {
108				warnx("xdr_reference: out of memory");
109				return (FALSE);
110			}
111			memset(loc, 0, size);
112			break;
113
114		case XDR_ENCODE:
115			break;
116		}
117
118	stat = (*proc)(xdrs, loc, 0);
119
120	if (xdrs->x_op == XDR_FREE) {
121		mem_free(loc, size);
122		*pp = NULL;
123	}
124	return (stat);
125}
126
127
128/*
129 * xdr_pointer():
130 *
131 * XDR a pointer to a possibly recursive data structure. This
132 * differs with xdr_reference in that it can serialize/deserialiaze
133 * trees correctly.
134 *
135 *  What's sent is actually a union:
136 *
137 *  union object_pointer switch (boolean b) {
138 *  case TRUE: object_data data;
139 *  case FALSE: void nothing;
140 *  }
141 *
142 * > objpp: Pointer to the pointer to the object.
143 * > obj_size: size of the object.
144 * > xdr_obj: routine to XDR an object.
145 *
146 */
147bool_t
148xdr_pointer(xdrs,objpp,obj_size,xdr_obj)
149	XDR *xdrs;
150	char **objpp;
151	u_int obj_size;
152	xdrproc_t xdr_obj;
153{
154
155	bool_t more_data;
156
157	more_data = (*objpp != NULL);
158	if (! xdr_bool(xdrs,&more_data)) {
159		return (FALSE);
160	}
161	if (! more_data) {
162		*objpp = NULL;
163		return (TRUE);
164	}
165	return (xdr_reference(xdrs,objpp,obj_size,xdr_obj));
166}
167