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