1/*
2 * xdr_reference.c, Generic XDR routines implementation.
3 *
4 * Copyright (c) 2010, Oracle America, Inc.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met:
9 *
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above
13 * copyright notice, this list of conditions and the following
14 * disclaimer in the documentation and/or other materials
15 * provided with the distribution.
16 * * Neither the name of the "Oracle America, Inc." nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
25 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
27 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 *
33 * These are the "non-trivial" xdr primitives used to serialize and
34 * de-serialize "pointers". See xdr.h for more info on the interface to xdr.
35 */
36
37#include <stdio.h>
38#include <string.h>
39#include <rpc/types.h>
40#include <rpc/xdr.h>
41#include <libintl.h>
42#include <wchar.h>
43#include <libio/iolibio.h>
44
45#define LASTUNSIGNED ((u_int)0-1)
46
47/*
48 * XDR an indirect pointer
49 * xdr_reference is for recursively translating a structure that is
50 * referenced by a pointer inside the structure that is currently being
51 * translated. pp references a pointer to storage. If *pp is null
52 * the necessary storage is allocated.
53 * size is the size of the referneced structure.
54 * proc is the routine to handle the referenced structure.
55 */
56bool_t
57xdr_reference (XDR *xdrs,
58 /* the pointer to work on */
59 caddr_t *pp,
60 /* size of the object pointed to */
61 u_int size,
62 /* xdr routine to handle the object */
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) calloc (1, size);
76 if (loc == NULL)
77 {
78 (void) __fxprintf (NULL, "%s: %s", __func__, _("out of memory\n"));
79 return FALSE;
80 }
81 break;
82 default:
83 break;
84 }
85
86 stat = (*proc) (xdrs, loc, LASTUNSIGNED);
87
88 if (xdrs->x_op == XDR_FREE)
89 {
90 mem_free (loc, size);
91 *pp = NULL;
92 }
93 return stat;
94}
95libc_hidden_nolink_sunrpc (xdr_reference, GLIBC_2_0)
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/deserialize
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 */
117bool_t
118xdr_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 {
126 return FALSE;
127 }
128 if (!more_data)
129 {
130 *objpp = NULL;
131 return TRUE;
132 }
133 return xdr_reference (xdrs, objpp, obj_size, xdr_obj);
134}
135#ifdef EXPORT_RPC_SYMBOLS
136libc_hidden_def (xdr_pointer)
137#else
138libc_hidden_nolink_sunrpc (xdr_pointer, GLIBC_2_0)
139#endif
140