1 /* $NetBSD: xdr_reference.c,v 1.13 2000/01/22 22:19:18 mycroft 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 #if defined(LIBC_SCCS) && !defined(lint)
33 static char *sccsid2 = "@(#)xdr_reference.c 1.11 87/08/11 SMI";
34 static char *sccsid = "@(#)xdr_reference.c 2.1 88/07/29 4.0 RPCSRC";
35 #endif
36 #include <sys/cdefs.h>
37 /*
38 * xdr_reference.c, Generic XDR routines implementation.
39 *
40 * Copyright (C) 1987, Sun Microsystems, Inc.
41 *
42 * These are the "non-trivial" xdr primitives used to serialize and de-serialize
43 * "pointers". See xdr.h for more info on the interface to xdr.
44 */
45
46 #include <sys/param.h>
47 #include <sys/systm.h>
48 #include <sys/malloc.h>
49
50 #include <rpc/types.h>
51 #include <rpc/xdr.h>
52
53 /*
54 * XDR an indirect pointer
55 * xdr_reference is for recursively translating a structure that is
56 * referenced by a pointer inside the structure that is currently being
57 * translated. pp references a pointer to storage. If *pp is null
58 * the necessary storage is allocated.
59 * size is the sizeof the referneced structure.
60 * proc is the routine to handle the referenced structure.
61 */
62 bool_t
xdr_reference(XDR * xdrs,caddr_t * pp,u_int size,xdrproc_t proc)63 xdr_reference(XDR *xdrs,
64 caddr_t *pp, /* the pointer to work on */
65 u_int size, /* size of the object pointed to */
66 xdrproc_t proc) /* xdr routine to handle the object */
67 {
68 caddr_t loc = *pp;
69 bool_t stat;
70
71 if (loc == NULL)
72 switch (xdrs->x_op) {
73 case XDR_FREE:
74 return (TRUE);
75
76 case XDR_DECODE:
77 *pp = loc = (caddr_t) mem_alloc(size);
78 if (loc == NULL) {
79 printf("xdr_reference: out of memory");
80 return (FALSE);
81 }
82 memset(loc, 0, size);
83 break;
84
85 case XDR_ENCODE:
86 break;
87 }
88
89 stat = (*proc)(xdrs, loc);
90
91 if (xdrs->x_op == XDR_FREE) {
92 mem_free(loc, size);
93 *pp = NULL;
94 }
95 return (stat);
96 }
97
98 /*
99 * xdr_pointer():
100 *
101 * XDR a pointer to a possibly recursive data structure. This
102 * differs with xdr_reference in that it can serialize/deserialiaze
103 * trees correctly.
104 *
105 * What's sent is actually a union:
106 *
107 * union object_pointer switch (boolean b) {
108 * case TRUE: object_data data;
109 * case FALSE: void nothing;
110 * }
111 *
112 * > objpp: Pointer to the pointer to the object.
113 * > obj_size: size of the object.
114 * > xdr_obj: routine to XDR an object.
115 *
116 */
117 bool_t
xdr_pointer(XDR * xdrs,char ** objpp,u_int obj_size,xdrproc_t xdr_obj)118 xdr_pointer(XDR *xdrs, char **objpp, u_int obj_size, xdrproc_t xdr_obj)
119 {
120
121 bool_t more_data;
122
123 more_data = (*objpp != NULL);
124 if (! xdr_bool(xdrs,&more_data)) {
125 return (FALSE);
126 }
127 if (! more_data) {
128 *objpp = NULL;
129 return (TRUE);
130 }
131 return (xdr_reference(xdrs,objpp,obj_size,xdr_obj));
132 }
133