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