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