xref: /onnv-gate/usr/src/uts/common/rpc/xdr_refer.c (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate /*	Copyright (c) 1983, 1984, 1985, 1986, 1987, 1988, 1989 AT&T	*/
28*0Sstevel@tonic-gate /*	  All Rights Reserved  	*/
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate /*
31*0Sstevel@tonic-gate  * Portions of this source code were derived from Berkeley 4.3 BSD
32*0Sstevel@tonic-gate  * under license from the Regents of the University of California.
33*0Sstevel@tonic-gate  */
34*0Sstevel@tonic-gate 
35*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
36*0Sstevel@tonic-gate 
37*0Sstevel@tonic-gate /*
38*0Sstevel@tonic-gate  * #if !defined(lint) && defined(SCCSIDS)
39*0Sstevel@tonic-gate  * static char sccsid[] = "@(#)xdr_refer.c 1.21 89/02/28 SMI";
40*0Sstevel@tonic-gate  * #endif
41*0Sstevel@tonic-gate  */
42*0Sstevel@tonic-gate 
43*0Sstevel@tonic-gate /*
44*0Sstevel@tonic-gate  * xdr_refer.c, Generic XDR routines impelmentation.
45*0Sstevel@tonic-gate  *
46*0Sstevel@tonic-gate  * These are the "non-trivial" xdr primitives used to serialize and de-serialize
47*0Sstevel@tonic-gate  * "pointers".  See xdr.h for more info on the interface to xdr.
48*0Sstevel@tonic-gate  */
49*0Sstevel@tonic-gate 
50*0Sstevel@tonic-gate #include <sys/param.h>
51*0Sstevel@tonic-gate #include <sys/systm.h>
52*0Sstevel@tonic-gate 
53*0Sstevel@tonic-gate #include <rpc/types.h>
54*0Sstevel@tonic-gate #include <rpc/xdr.h>
55*0Sstevel@tonic-gate 
56*0Sstevel@tonic-gate #define	LASTUNSIGNED	((uint_t)0-1)
57*0Sstevel@tonic-gate 
58*0Sstevel@tonic-gate /*
59*0Sstevel@tonic-gate  * XDR an indirect pointer
60*0Sstevel@tonic-gate  * xdr_reference is for recursively translating a structure that is
61*0Sstevel@tonic-gate  * referenced by a pointer inside the structure that is currently being
62*0Sstevel@tonic-gate  * translated.  pp references a pointer to storage. If *pp is null
63*0Sstevel@tonic-gate  * the  necessary storage is allocated.
64*0Sstevel@tonic-gate  * size is the sizeof the referneced structure.
65*0Sstevel@tonic-gate  * proc is the routine to handle the referenced structure.
66*0Sstevel@tonic-gate  */
67*0Sstevel@tonic-gate bool_t
xdr_reference(XDR * xdrs,caddr_t * pp,uint_t size,const xdrproc_t proc)68*0Sstevel@tonic-gate xdr_reference(XDR *xdrs, caddr_t *pp, uint_t size, const xdrproc_t proc)
69*0Sstevel@tonic-gate {
70*0Sstevel@tonic-gate 	caddr_t loc = *pp;
71*0Sstevel@tonic-gate 	bool_t stat;
72*0Sstevel@tonic-gate 
73*0Sstevel@tonic-gate 	if (loc == NULL) {
74*0Sstevel@tonic-gate 		switch (xdrs->x_op) {
75*0Sstevel@tonic-gate 		case XDR_FREE:
76*0Sstevel@tonic-gate 			return (TRUE);
77*0Sstevel@tonic-gate 
78*0Sstevel@tonic-gate 		case XDR_DECODE:
79*0Sstevel@tonic-gate 			*pp = loc = (caddr_t)mem_alloc(size);
80*0Sstevel@tonic-gate 			bzero(loc, size);
81*0Sstevel@tonic-gate 			break;
82*0Sstevel@tonic-gate 
83*0Sstevel@tonic-gate 		case XDR_ENCODE:
84*0Sstevel@tonic-gate 			break;
85*0Sstevel@tonic-gate 		}
86*0Sstevel@tonic-gate 	}
87*0Sstevel@tonic-gate 
88*0Sstevel@tonic-gate 	stat = (*proc)(xdrs, loc, LASTUNSIGNED);
89*0Sstevel@tonic-gate 
90*0Sstevel@tonic-gate 	if (xdrs->x_op == XDR_FREE) {
91*0Sstevel@tonic-gate 		mem_free(loc, size);
92*0Sstevel@tonic-gate 		*pp = NULL;
93*0Sstevel@tonic-gate 	}
94*0Sstevel@tonic-gate 	return (stat);
95*0Sstevel@tonic-gate }
96*0Sstevel@tonic-gate 
97*0Sstevel@tonic-gate /*
98*0Sstevel@tonic-gate  * xdr_pointer():
99*0Sstevel@tonic-gate  *
100*0Sstevel@tonic-gate  * XDR a pointer to a possibly recursive data structure. This
101*0Sstevel@tonic-gate  * differs with xdr_reference in that it can serialize/deserialiaze
102*0Sstevel@tonic-gate  * trees correctly.
103*0Sstevel@tonic-gate  *
104*0Sstevel@tonic-gate  *  What's sent is actually a union:
105*0Sstevel@tonic-gate  *
106*0Sstevel@tonic-gate  *  union object_pointer switch (boolean b) {
107*0Sstevel@tonic-gate  *  case TRUE: object_data data;
108*0Sstevel@tonic-gate  *  case FALSE: void nothing;
109*0Sstevel@tonic-gate  *  }
110*0Sstevel@tonic-gate  *
111*0Sstevel@tonic-gate  * > objpp: Pointer to the pointer to the object.
112*0Sstevel@tonic-gate  * > obj_size: size of the object.
113*0Sstevel@tonic-gate  * > xdr_obj: routine to XDR an object.
114*0Sstevel@tonic-gate  *
115*0Sstevel@tonic-gate  */
116*0Sstevel@tonic-gate bool_t
xdr_pointer(XDR * xdrs,char ** objpp,uint_t obj_size,const xdrproc_t xdr_obj)117*0Sstevel@tonic-gate xdr_pointer(XDR *xdrs, char **objpp, uint_t obj_size, const xdrproc_t xdr_obj)
118*0Sstevel@tonic-gate {
119*0Sstevel@tonic-gate 	bool_t more_data;
120*0Sstevel@tonic-gate 
121*0Sstevel@tonic-gate 	more_data = (*objpp != NULL);
122*0Sstevel@tonic-gate 	if (!xdr_bool(xdrs, &more_data))
123*0Sstevel@tonic-gate 		return (FALSE);
124*0Sstevel@tonic-gate 	if (!more_data) {
125*0Sstevel@tonic-gate 		*objpp = NULL;
126*0Sstevel@tonic-gate 		return (TRUE);
127*0Sstevel@tonic-gate 	}
128*0Sstevel@tonic-gate 	return (xdr_reference(xdrs, objpp, obj_size, xdr_obj));
129*0Sstevel@tonic-gate }
130