1 /*
2  * Copyright (c) 2009, Sun Microsystems, Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  * - Redistributions of source code must retain the above copyright notice,
8  *   this list of conditions and the following disclaimer.
9  * - Redistributions in binary form must reproduce the above copyright notice,
10  *   this list of conditions and the following disclaimer in the documentation
11  *   and/or other materials provided with the distribution.
12  * - Neither the name of Sun Microsystems, Inc. nor the names of its
13  *   contributors may be used to endorse or promote products derived
14  *   from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28 
29 /*
30  * xdr_reference.c, Generic XDR routines impelmentation.
31  *
32  * Copyright (C) 1987, Sun Microsystems, Inc.
33  *
34  * These are the "non-trivial" xdr primitives used to serialize and de-serialize
35  * "pointers".  See xdr.h for more info on the interface to xdr.
36  */
37 
38 #define _DEFAULT_SOURCE
39 #include <stdlib.h>
40 #include <string.h>
41 #include <errno.h>
42 
43 #include <rpc/types.h>
44 #include <rpc/xdr.h>
45 
46 #include "xdr_private.h"
47 
48 #define LASTUNSIGNED    ((u_int)0-1)
49 
50 /*
51  * XDR an indirect pointer
52  * xdr_reference is for recursively translating a structure that is
53  * referenced by a pointer inside the structure that is currently being
54  * translated.  pp references a pointer to storage. If *pp is null
55  * the  necessary storage is allocated.
56  * size is the sizeof the referneced structure.
57  * proc is the routine to handle the referenced structure.
58  */
59 bool_t
xdr_reference(XDR * xdrs,caddr_t * pp,u_int size,xdrproc_t proc)60 xdr_reference (XDR * xdrs,
61 	caddr_t * pp,
62 	u_int size,
63 	xdrproc_t proc)
64 {
65   caddr_t loc = *pp;
66   bool_t stat;
67 
68   if (loc == NULL)
69     switch (xdrs->x_op)
70       {
71       case XDR_FREE:
72         return TRUE;
73 
74       case XDR_DECODE:
75         *pp = loc = (caddr_t) mem_alloc (size);
76         if (loc == NULL)
77           {
78             xdr_warnx ("xdr_reference: out of memory");
79             errno = ENOMEM;
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, LASTUNSIGNED);
90 
91   if (xdrs->x_op == XDR_FREE)
92     {
93       mem_free (loc, size);
94       *pp = NULL;
95     }
96   return stat;
97 }
98 
99 
100 /*
101  * xdr_pointer():
102  *
103  * XDR a pointer to a possibly recursive data structure. This
104  * differs with xdr_reference in that it can serialize/deserialiaze
105  * trees correctly.
106  *
107  *  What's sent is actually a union:
108  *
109  *  union object_pointer switch (boolean b) {
110  *  case TRUE: object_data data;
111  *  case FALSE: void nothing;
112  *  }
113  *
114  * > objpp: Pointer to the pointer to the object.
115  * > obj_size: size of the object.
116  * > xdr_obj: routine to XDR an object.
117  *
118  */
119 bool_t
xdr_pointer(XDR * xdrs,char ** objpp,u_int obj_size,xdrproc_t xdr_obj)120 xdr_pointer (XDR * xdrs,
121 	char **objpp,
122 	u_int obj_size,
123 	xdrproc_t xdr_obj)
124 {
125   bool_t more_data;
126 
127   more_data = (*objpp != NULL);
128   if (!xdr_bool (xdrs, &more_data))
129     {
130       return FALSE;
131     }
132   if (!more_data)
133     {
134       *objpp = NULL;
135       return TRUE;
136     }
137   return (xdr_reference (xdrs, objpp, obj_size, xdr_obj));
138 }
139