1 /* $NetBSD: xdr.h,v 1.19 2000/07/17 05:00:45 matt Exp $ */
2
3 /*-
4 * SPDX-License-Identifier: BSD-3-Clause
5 *
6 * Copyright (c) 2009, Sun Microsystems, Inc.
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are met:
11 * - Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the following disclaimer.
13 * - Redistributions in binary form must reproduce the above copyright notice,
14 * this list of conditions and the following disclaimer in the documentation
15 * and/or other materials provided with the distribution.
16 * - Neither the name of Sun Microsystems, 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 "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 /*
34 * xdr.h, External Data Representation Serialization Routines.
35 *
36 * Copyright (C) 1984, Sun Microsystems, Inc.
37 */
38
39 #ifndef _KRPC_XDR_H
40 #define _KRPC_XDR_H
41 #include <sys/cdefs.h>
42
43 /*
44 * XDR provides a conventional way for converting between C data
45 * types and an external bit-string representation. Library supplied
46 * routines provide for the conversion on built-in C data types. These
47 * routines and utility routines defined here are used to help implement
48 * a type encode/decode routine for each user-defined type.
49 *
50 * Each data type provides a single procedure which takes two arguments:
51 *
52 * bool_t
53 * xdrproc(xdrs, argresp)
54 * XDR *xdrs;
55 * <type> *argresp;
56 *
57 * xdrs is an instance of a XDR handle, to which or from which the data
58 * type is to be converted. argresp is a pointer to the structure to be
59 * converted. The XDR handle contains an operation field which indicates
60 * which of the operations (ENCODE, DECODE * or FREE) is to be performed.
61 *
62 * XDR_DECODE may allocate space if the pointer argresp is null. This
63 * data can be freed with the XDR_FREE operation.
64 *
65 * We write only one procedure per data type to make it easy
66 * to keep the encode and decode procedures for a data type consistent.
67 * In many cases the same code performs all operations on a user defined type,
68 * because all the hard work is done in the component type routines.
69 * decode as a series of calls on the nested data types.
70 */
71
72 /*
73 * Xdr operations. XDR_ENCODE causes the type to be encoded into the
74 * stream. XDR_DECODE causes the type to be extracted from the stream.
75 * XDR_FREE can be used to release the space allocated by an XDR_DECODE
76 * request.
77 */
78 enum xdr_op {
79 XDR_ENCODE=0,
80 XDR_DECODE=1,
81 XDR_FREE=2
82 };
83
84 /*
85 * This is the number of bytes per unit of external data.
86 */
87 #define BYTES_PER_XDR_UNIT (4)
88 #define RNDUP(x) ((((x) + BYTES_PER_XDR_UNIT - 1) / BYTES_PER_XDR_UNIT) \
89 * BYTES_PER_XDR_UNIT)
90
91 /*
92 * The XDR handle.
93 * Contains operation which is being applied to the stream,
94 * an operations vector for the particular implementation (e.g. see xdr_mem.c),
95 * and two private fields for the use of the particular implementation.
96 */
97 typedef struct XDR {
98 enum xdr_op x_op; /* operation; fast additional param */
99 const struct xdr_ops {
100 /* get a long from underlying stream */
101 bool_t (*x_getlong)(struct XDR *, long *);
102 /* put a long to " */
103 bool_t (*x_putlong)(struct XDR *, const long *);
104 /* get some bytes from " */
105 bool_t (*x_getbytes)(struct XDR *, char *, u_int);
106 /* put some bytes to " */
107 bool_t (*x_putbytes)(struct XDR *, const char *, u_int);
108 /* returns bytes off from beginning */
109 u_int (*x_getpostn)(struct XDR *);
110 /* lets you reposition the stream */
111 bool_t (*x_setpostn)(struct XDR *, u_int);
112 /* buf quick ptr to buffered data */
113 int32_t *(*x_inline)(struct XDR *, u_int);
114 /* free privates of this xdr_stream */
115 void (*x_destroy)(struct XDR *);
116 bool_t (*x_control)(struct XDR *, int, void *);
117 } *x_ops;
118 char * x_public; /* users' data */
119 void * x_private; /* pointer to private data */
120 char * x_base; /* private used for position info */
121 u_int x_handy; /* extra private word */
122 } XDR;
123
124 /*
125 * A xdrproc_t exists for each data type which is to be encoded or decoded.
126 *
127 * The second argument to the xdrproc_t is a pointer to an opaque pointer.
128 * The opaque pointer generally points to a structure of the data type
129 * to be decoded. If this pointer is 0, then the type routines should
130 * allocate dynamic storage of the appropriate size and return it.
131 */
132 #ifdef _KERNEL
133 typedef bool_t (*xdrproc_t)(XDR *, void *, ...);
134 #else
135 /*
136 * XXX can't actually prototype it, because some take three args!!!
137 */
138 typedef bool_t (*xdrproc_t)(XDR *, ...);
139 #endif
140
141 /*
142 * Operations defined on a XDR handle
143 *
144 * XDR *xdrs;
145 * long *longp;
146 * char * addr;
147 * u_int len;
148 * u_int pos;
149 */
150 #define XDR_GETLONG(xdrs, longp) \
151 (*(xdrs)->x_ops->x_getlong)(xdrs, longp)
152 #define xdr_getlong(xdrs, longp) \
153 (*(xdrs)->x_ops->x_getlong)(xdrs, longp)
154
155 #define XDR_PUTLONG(xdrs, longp) \
156 (*(xdrs)->x_ops->x_putlong)(xdrs, longp)
157 #define xdr_putlong(xdrs, longp) \
158 (*(xdrs)->x_ops->x_putlong)(xdrs, longp)
159
160 static __inline int
xdr_getint32(XDR * xdrs,int32_t * ip)161 xdr_getint32(XDR *xdrs, int32_t *ip)
162 {
163 long l;
164
165 if (!xdr_getlong(xdrs, &l))
166 return (FALSE);
167 *ip = (int32_t)l;
168 return (TRUE);
169 }
170
171 static __inline int
xdr_putint32(XDR * xdrs,int32_t * ip)172 xdr_putint32(XDR *xdrs, int32_t *ip)
173 {
174 long l;
175
176 l = (long)*ip;
177 return xdr_putlong(xdrs, &l);
178 }
179
180 #define XDR_GETINT32(xdrs, int32p) xdr_getint32(xdrs, int32p)
181 #define XDR_PUTINT32(xdrs, int32p) xdr_putint32(xdrs, int32p)
182
183 #define XDR_GETBYTES(xdrs, addr, len) \
184 (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
185 #define xdr_getbytes(xdrs, addr, len) \
186 (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
187
188 #define XDR_PUTBYTES(xdrs, addr, len) \
189 (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
190 #define xdr_putbytes(xdrs, addr, len) \
191 (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
192
193 #define XDR_GETPOS(xdrs) \
194 (*(xdrs)->x_ops->x_getpostn)(xdrs)
195 #define xdr_getpos(xdrs) \
196 (*(xdrs)->x_ops->x_getpostn)(xdrs)
197
198 #define XDR_SETPOS(xdrs, pos) \
199 (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
200 #define xdr_setpos(xdrs, pos) \
201 (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
202
203 #define XDR_INLINE(xdrs, len) \
204 (*(xdrs)->x_ops->x_inline)(xdrs, len)
205 #define xdr_inline(xdrs, len) \
206 (*(xdrs)->x_ops->x_inline)(xdrs, len)
207
208 #define XDR_DESTROY(xdrs) \
209 if ((xdrs)->x_ops->x_destroy) \
210 (*(xdrs)->x_ops->x_destroy)(xdrs)
211 #define xdr_destroy(xdrs) \
212 if ((xdrs)->x_ops->x_destroy) \
213 (*(xdrs)->x_ops->x_destroy)(xdrs)
214
215 #define XDR_CONTROL(xdrs, req, op) \
216 (((xdrs)->x_ops->x_control == NULL) ? (FALSE) : \
217 (*(xdrs)->x_ops->x_control)(xdrs, req, op))
218 #define xdr_control(xdrs, req, op) XDR_CONTROL(xdrs, req, op)
219
220 /*
221 * Solaris strips the '_t' from these types -- not sure why.
222 * But, let's be compatible.
223 */
224 #define xdr_rpcvers(xdrs, versp) xdr_uint32_t(xdrs, versp)
225 #define xdr_rpcprog(xdrs, progp) xdr_uint32_t(xdrs, progp)
226 #define xdr_rpcproc(xdrs, procp) xdr_uint32_t(xdrs, procp)
227 #define xdr_rpcprot(xdrs, protp) xdr_uint32_t(xdrs, protp)
228 #define xdr_rpcport(xdrs, portp) xdr_uint32_t(xdrs, portp)
229
230 /*
231 * Support struct for discriminated unions.
232 * You create an array of xdrdiscrim structures, terminated with
233 * an entry with a null procedure pointer. The xdr_union routine gets
234 * the discriminant value and then searches the array of structures
235 * for a matching value. If a match is found the associated xdr routine
236 * is called to handle that part of the union. If there is
237 * no match, then a default routine may be called.
238 * If there is no match and no default routine it is an error.
239 */
240 #define NULL_xdrproc_t ((xdrproc_t)0)
241 struct xdr_discrim {
242 int value;
243 xdrproc_t proc;
244 };
245
246 /*
247 * In-line routines for fast encode/decode of primitive data types.
248 * Caveat emptor: these use single memory cycles to get the
249 * data from the underlying buffer, and will fail to operate
250 * properly if the data is not aligned. The standard way to use these
251 * is to say:
252 * if ((buf = XDR_INLINE(xdrs, count)) == NULL)
253 * return (FALSE);
254 * <<< macro calls >>>
255 * where ``count'' is the number of bytes of data occupied
256 * by the primitive data types.
257 *
258 * N.B. and frozen for all time: each data type here uses 4 bytes
259 * of external representation.
260 */
261 #define IXDR_GET_INT32(buf) ((int32_t)__ntohl((uint32_t)*(buf)++))
262 #define IXDR_PUT_INT32(buf, v) (*(buf)++ =(int32_t)__htonl((uint32_t)v))
263 #define IXDR_GET_U_INT32(buf) ((uint32_t)IXDR_GET_INT32(buf))
264 #define IXDR_PUT_U_INT32(buf, v) IXDR_PUT_INT32((buf), ((int32_t)(v)))
265
266 #define IXDR_GET_UINT32(buf) ((uint32_t)IXDR_GET_INT32(buf))
267 #define IXDR_PUT_UINT32(buf, v) IXDR_PUT_INT32((buf), ((int32_t)(v)))
268
269 #define IXDR_GET_LONG(buf) ((long)__ntohl((uint32_t)*(buf)++))
270 #define IXDR_PUT_LONG(buf, v) (*(buf)++ =(int32_t)__htonl((uint32_t)v))
271
272 #define IXDR_GET_BOOL(buf) ((bool_t)IXDR_GET_LONG(buf))
273 #define IXDR_GET_ENUM(buf, t) ((t)IXDR_GET_LONG(buf))
274 #define IXDR_GET_U_LONG(buf) ((u_long)IXDR_GET_LONG(buf))
275 #define IXDR_GET_SHORT(buf) ((short)IXDR_GET_LONG(buf))
276 #define IXDR_GET_U_SHORT(buf) ((u_short)IXDR_GET_LONG(buf))
277
278 #define IXDR_PUT_BOOL(buf, v) IXDR_PUT_LONG((buf), (v))
279 #define IXDR_PUT_ENUM(buf, v) IXDR_PUT_LONG((buf), (v))
280 #define IXDR_PUT_U_LONG(buf, v) IXDR_PUT_LONG((buf), (v))
281 #define IXDR_PUT_SHORT(buf, v) IXDR_PUT_LONG((buf), (v))
282 #define IXDR_PUT_U_SHORT(buf, v) IXDR_PUT_LONG((buf), (v))
283
284 /*
285 * These are the "generic" xdr routines.
286 */
287 __BEGIN_DECLS
288 extern bool_t xdr_void(XDR *, void *);
289 extern bool_t xdr_int(XDR *, int *);
290 extern bool_t xdr_u_int(XDR *, u_int *);
291 extern bool_t xdr_long(XDR *, long *);
292 extern bool_t xdr_u_long(XDR *, u_long *);
293 extern bool_t xdr_short(XDR *, short *);
294 extern bool_t xdr_u_short(XDR *, u_short *);
295 extern bool_t xdr_int16_t(XDR *, int16_t *);
296 extern bool_t xdr_uint16_t(XDR *, uint16_t *);
297 extern bool_t xdr_int32_t(XDR *, int32_t *);
298 extern bool_t xdr_uint32_t(XDR *, uint32_t *);
299 extern bool_t xdr_int64_t(XDR *, int64_t *);
300 extern bool_t xdr_uint64_t(XDR *, uint64_t *);
301 extern bool_t xdr_bool(XDR *, bool_t *);
302 extern bool_t xdr_enum(XDR *, enum_t *);
303 extern bool_t xdr_array(XDR *, char **, u_int *, u_int, u_int, xdrproc_t);
304 extern bool_t xdr_bytes(XDR *, char **, u_int *, u_int);
305 extern bool_t xdr_opaque(XDR *, char *, u_int);
306 extern bool_t xdr_string(XDR *, char **, u_int);
307 extern bool_t xdr_union(XDR *, enum_t *, char *, const struct xdr_discrim *, xdrproc_t);
308 extern bool_t xdr_char(XDR *, char *);
309 extern bool_t xdr_u_char(XDR *, u_char *);
310 extern bool_t xdr_vector(XDR *, char *, u_int, u_int, xdrproc_t);
311 extern bool_t xdr_float(XDR *, float *);
312 extern bool_t xdr_double(XDR *, double *);
313 extern bool_t xdr_quadruple(XDR *, long double *);
314 extern bool_t xdr_reference(XDR *, char **, u_int, xdrproc_t);
315 extern bool_t xdr_pointer(XDR *, char **, u_int, xdrproc_t);
316 extern bool_t xdr_wrapstring(XDR *, char **);
317 extern void xdr_free(xdrproc_t, void *);
318 extern bool_t xdr_hyper(XDR *, quad_t *);
319 extern bool_t xdr_u_hyper(XDR *, u_quad_t *);
320 extern bool_t xdr_longlong_t(XDR *, quad_t *);
321 extern bool_t xdr_u_longlong_t(XDR *, u_quad_t *);
322 extern unsigned long xdr_sizeof(xdrproc_t func, void *data);
323 __END_DECLS
324
325 /*
326 * Common opaque bytes objects used by many rpc protocols;
327 * declared here due to commonality.
328 */
329 #define MAX_NETOBJ_SZ 1024
330 struct netobj {
331 u_int n_len;
332 char *n_bytes;
333 };
334 typedef struct netobj netobj;
335 extern bool_t xdr_netobj(XDR *, struct netobj *);
336
337 /*
338 * These are XDR control operators
339 */
340
341 #define XDR_GET_BYTES_AVAIL 1
342 #define XDR_PEEK 2
343 #define XDR_SKIPBYTES 3
344
345 struct xdr_bytesrec {
346 bool_t xc_is_last_record;
347 size_t xc_num_avail;
348 };
349
350 typedef struct xdr_bytesrec xdr_bytesrec;
351
352
353 /*
354 * These are the public routines for the various implementations of
355 * xdr streams.
356 */
357 __BEGIN_DECLS
358 /* XDR using memory buffers */
359 extern void xdrmem_create(XDR *, char *, u_int, enum xdr_op);
360
361 /* XDR using mbufs */
362 struct mbuf;
363 extern void xdrmbuf_create(XDR *, struct mbuf *, enum xdr_op);
364 extern void xdrmbuf_append(XDR *, struct mbuf *);
365 extern struct mbuf * xdrmbuf_getall(XDR *);
366
367 /* XDR pseudo records for tcp */
368 extern void xdrrec_create(XDR *, u_int, u_int, void *,
369 int (*)(void *, void *, int),
370 int (*)(void *, void *, int));
371
372 /* make end of xdr record */
373 extern bool_t xdrrec_endofrecord(XDR *, int);
374
375 /* move to beginning of next record */
376 extern bool_t xdrrec_skiprecord(XDR *);
377
378 /* true if no more input */
379 extern bool_t xdrrec_eof(XDR *);
380 extern u_int xdrrec_readbytes(XDR *, caddr_t, u_int);
381 __END_DECLS
382
383 #endif /* !_KRPC_XDR_H */
384