1 /* $NetBSD: xdr.h,v 1.19 2000/07/17 05:00:45 matt Exp $ */
4 * SPDX-License-Identifier: BSD-3-Clause
6 * Copyright (c) 2009, Sun Microsystems, Inc.
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.
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.
32 * from: @(#)xdr.h 1.19 87/04/22 SMI
33 * from: @(#)xdr.h 2.2 88/07/29 4.0 RPCSRC
38 * xdr.h, External Data Representation Serialization Routines.
40 * Copyright (C) 1984, Sun Microsystems, Inc.
45 #include <sys/cdefs.h>
48 * XDR provides a conventional way for converting between C data
49 * types and an external bit-string representation. Library supplied
50 * routines provide for the conversion on built-in C data types. These
51 * routines and utility routines defined here are used to help implement
52 * a type encode/decode routine for each user-defined type.
54 * Each data type provides a single procedure which takes two arguments:
57 * xdrproc(xdrs, argresp)
61 * xdrs is an instance of a XDR handle, to which or from which the data
62 * type is to be converted. argresp is a pointer to the structure to be
63 * converted. The XDR handle contains an operation field which indicates
64 * which of the operations (ENCODE, DECODE * or FREE) is to be performed.
66 * XDR_DECODE may allocate space if the pointer argresp is null. This
67 * data can be freed with the XDR_FREE operation.
69 * We write only one procedure per data type to make it easy
70 * to keep the encode and decode procedures for a data type consistent.
71 * In many cases the same code performs all operations on a user defined type,
72 * because all the hard work is done in the component type routines.
73 * decode as a series of calls on the nested data types.
77 * Xdr operations. XDR_ENCODE causes the type to be encoded into the
78 * stream. XDR_DECODE causes the type to be extracted from the stream.
79 * XDR_FREE can be used to release the space allocated by an XDR_DECODE
89 * This is the number of bytes per unit of external data.
91 #define BYTES_PER_XDR_UNIT (4)
92 #define RNDUP(x) ((((x) + BYTES_PER_XDR_UNIT - 1) / BYTES_PER_XDR_UNIT) \
97 * Contains operation which is being applied to the stream,
98 * an operations vector for the particular implementation (e.g. see xdr_mem.c),
99 * and two private fields for the use of the particular implementation.
102 enum xdr_op x_op; /* operation; fast additional param */
103 const struct xdr_ops {
104 /* get a long from underlying stream */
105 bool_t (*x_getlong)(struct XDR *, long *);
106 /* put a long to " */
107 bool_t (*x_putlong)(struct XDR *, const long *);
108 /* get some bytes from " */
109 bool_t (*x_getbytes)(struct XDR *, char *, u_int);
110 /* put some bytes to " */
111 bool_t (*x_putbytes)(struct XDR *, const char *, u_int);
112 /* returns bytes off from beginning */
113 u_int (*x_getpostn)(struct XDR *);
114 /* lets you reposition the stream */
115 bool_t (*x_setpostn)(struct XDR *, u_int);
116 /* buf quick ptr to buffered data */
117 int32_t *(*x_inline)(struct XDR *, u_int);
118 /* free privates of this xdr_stream */
119 void (*x_destroy)(struct XDR *);
120 bool_t (*x_control)(struct XDR *, int, void *);
122 char * x_public; /* users' data */
123 void * x_private; /* pointer to private data */
124 char * x_base; /* private used for position info */
125 u_int x_handy; /* extra private word */
129 * A xdrproc_t exists for each data type which is to be encoded or decoded.
131 * The second argument to the xdrproc_t is a pointer to an opaque pointer.
132 * The opaque pointer generally points to a structure of the data type
133 * to be decoded. If this pointer is 0, then the type routines should
134 * allocate dynamic storage of the appropriate size and return it.
137 typedef bool_t (*xdrproc_t)(XDR *, void *, ...);
140 * XXX can't actually prototype it, because some take three args!!!
142 typedef bool_t (*xdrproc_t)(XDR *, ...);
146 * Operations defined on a XDR handle
154 #define XDR_GETLONG(xdrs, longp) \
155 (*(xdrs)->x_ops->x_getlong)(xdrs, longp)
156 #define xdr_getlong(xdrs, longp) \
157 (*(xdrs)->x_ops->x_getlong)(xdrs, longp)
159 #define XDR_PUTLONG(xdrs, longp) \
160 (*(xdrs)->x_ops->x_putlong)(xdrs, longp)
161 #define xdr_putlong(xdrs, longp) \
162 (*(xdrs)->x_ops->x_putlong)(xdrs, longp)
165 xdr_getint32(XDR *xdrs, int32_t *ip)
169 if (!xdr_getlong(xdrs, &l))
176 xdr_putint32(XDR *xdrs, int32_t *ip)
181 return xdr_putlong(xdrs, &l);
184 #define XDR_GETINT32(xdrs, int32p) xdr_getint32(xdrs, int32p)
185 #define XDR_PUTINT32(xdrs, int32p) xdr_putint32(xdrs, int32p)
187 #define XDR_GETBYTES(xdrs, addr, len) \
188 (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
189 #define xdr_getbytes(xdrs, addr, len) \
190 (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
192 #define XDR_PUTBYTES(xdrs, addr, len) \
193 (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
194 #define xdr_putbytes(xdrs, addr, len) \
195 (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
197 #define XDR_GETPOS(xdrs) \
198 (*(xdrs)->x_ops->x_getpostn)(xdrs)
199 #define xdr_getpos(xdrs) \
200 (*(xdrs)->x_ops->x_getpostn)(xdrs)
202 #define XDR_SETPOS(xdrs, pos) \
203 (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
204 #define xdr_setpos(xdrs, pos) \
205 (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
207 #define XDR_INLINE(xdrs, len) \
208 (*(xdrs)->x_ops->x_inline)(xdrs, len)
209 #define xdr_inline(xdrs, len) \
210 (*(xdrs)->x_ops->x_inline)(xdrs, len)
212 #define XDR_DESTROY(xdrs) \
213 if ((xdrs)->x_ops->x_destroy) \
214 (*(xdrs)->x_ops->x_destroy)(xdrs)
215 #define xdr_destroy(xdrs) \
216 if ((xdrs)->x_ops->x_destroy) \
217 (*(xdrs)->x_ops->x_destroy)(xdrs)
219 #define XDR_CONTROL(xdrs, req, op) \
220 (((xdrs)->x_ops->x_control == NULL) ? (FALSE) : \
221 (*(xdrs)->x_ops->x_control)(xdrs, req, op))
222 #define xdr_control(xdrs, req, op) XDR_CONTROL(xdrs, req, op)
225 * Solaris strips the '_t' from these types -- not sure why.
226 * But, let's be compatible.
228 #define xdr_rpcvers(xdrs, versp) xdr_uint32_t(xdrs, versp)
229 #define xdr_rpcprog(xdrs, progp) xdr_uint32_t(xdrs, progp)
230 #define xdr_rpcproc(xdrs, procp) xdr_uint32_t(xdrs, procp)
231 #define xdr_rpcprot(xdrs, protp) xdr_uint32_t(xdrs, protp)
232 #define xdr_rpcport(xdrs, portp) xdr_uint32_t(xdrs, portp)
235 * Support struct for discriminated unions.
236 * You create an array of xdrdiscrim structures, terminated with
237 * an entry with a null procedure pointer. The xdr_union routine gets
238 * the discriminant value and then searches the array of structures
239 * for a matching value. If a match is found the associated xdr routine
240 * is called to handle that part of the union. If there is
241 * no match, then a default routine may be called.
242 * If there is no match and no default routine it is an error.
244 #define NULL_xdrproc_t ((xdrproc_t)0)
251 * In-line routines for fast encode/decode of primitive data types.
252 * Caveat emptor: these use single memory cycles to get the
253 * data from the underlying buffer, and will fail to operate
254 * properly if the data is not aligned. The standard way to use these
256 * if ((buf = XDR_INLINE(xdrs, count)) == NULL)
258 * <<< macro calls >>>
259 * where ``count'' is the number of bytes of data occupied
260 * by the primitive data types.
262 * N.B. and frozen for all time: each data type here uses 4 bytes
263 * of external representation.
265 #define IXDR_GET_INT32(buf) ((int32_t)__ntohl((uint32_t)*(buf)++))
266 #define IXDR_PUT_INT32(buf, v) (*(buf)++ =(int32_t)__htonl((uint32_t)v))
267 #define IXDR_GET_U_INT32(buf) ((uint32_t)IXDR_GET_INT32(buf))
268 #define IXDR_PUT_U_INT32(buf, v) IXDR_PUT_INT32((buf), ((int32_t)(v)))
270 #define IXDR_GET_UINT32(buf) ((uint32_t)IXDR_GET_INT32(buf))
271 #define IXDR_PUT_UINT32(buf, v) IXDR_PUT_INT32((buf), ((int32_t)(v)))
273 #define IXDR_GET_LONG(buf) ((long)__ntohl((uint32_t)*(buf)++))
274 #define IXDR_PUT_LONG(buf, v) (*(buf)++ =(int32_t)__htonl((uint32_t)v))
276 #define IXDR_GET_BOOL(buf) ((bool_t)IXDR_GET_LONG(buf))
277 #define IXDR_GET_ENUM(buf, t) ((t)IXDR_GET_LONG(buf))
278 #define IXDR_GET_U_LONG(buf) ((u_long)IXDR_GET_LONG(buf))
279 #define IXDR_GET_SHORT(buf) ((short)IXDR_GET_LONG(buf))
280 #define IXDR_GET_U_SHORT(buf) ((u_short)IXDR_GET_LONG(buf))
282 #define IXDR_PUT_BOOL(buf, v) IXDR_PUT_LONG((buf), (v))
283 #define IXDR_PUT_ENUM(buf, v) IXDR_PUT_LONG((buf), (v))
284 #define IXDR_PUT_U_LONG(buf, v) IXDR_PUT_LONG((buf), (v))
285 #define IXDR_PUT_SHORT(buf, v) IXDR_PUT_LONG((buf), (v))
286 #define IXDR_PUT_U_SHORT(buf, v) IXDR_PUT_LONG((buf), (v))
289 * These are the "generic" xdr routines.
292 extern bool_t xdr_void(void);
293 extern bool_t xdr_int(XDR *, int *);
294 extern bool_t xdr_u_int(XDR *, u_int *);
295 extern bool_t xdr_long(XDR *, long *);
296 extern bool_t xdr_u_long(XDR *, u_long *);
297 extern bool_t xdr_short(XDR *, short *);
298 extern bool_t xdr_u_short(XDR *, u_short *);
299 extern bool_t xdr_int16_t(XDR *, int16_t *);
300 extern bool_t xdr_uint16_t(XDR *, uint16_t *);
301 extern bool_t xdr_int32_t(XDR *, int32_t *);
302 extern bool_t xdr_uint32_t(XDR *, uint32_t *);
303 extern bool_t xdr_int64_t(XDR *, int64_t *);
304 extern bool_t xdr_uint64_t(XDR *, uint64_t *);
305 extern bool_t xdr_bool(XDR *, bool_t *);
306 extern bool_t xdr_enum(XDR *, enum_t *);
307 extern bool_t xdr_array(XDR *, char **, u_int *, u_int, u_int, xdrproc_t);
308 extern bool_t xdr_bytes(XDR *, char **, u_int *, u_int);
309 extern bool_t xdr_opaque(XDR *, char *, u_int);
310 extern bool_t xdr_string(XDR *, char **, u_int);
311 extern bool_t xdr_union(XDR *, enum_t *, char *, const struct xdr_discrim *, xdrproc_t);
312 extern bool_t xdr_char(XDR *, char *);
313 extern bool_t xdr_u_char(XDR *, u_char *);
314 extern bool_t xdr_vector(XDR *, char *, u_int, u_int, xdrproc_t);
315 extern bool_t xdr_float(XDR *, float *);
316 extern bool_t xdr_double(XDR *, double *);
317 extern bool_t xdr_quadruple(XDR *, long double *);
318 extern bool_t xdr_reference(XDR *, char **, u_int, xdrproc_t);
319 extern bool_t xdr_pointer(XDR *, char **, u_int, xdrproc_t);
320 extern bool_t xdr_wrapstring(XDR *, char **);
321 extern void xdr_free(xdrproc_t, void *);
322 extern bool_t xdr_hyper(XDR *, quad_t *);
323 extern bool_t xdr_u_hyper(XDR *, u_quad_t *);
324 extern bool_t xdr_longlong_t(XDR *, quad_t *);
325 extern bool_t xdr_u_longlong_t(XDR *, u_quad_t *);
326 extern unsigned long xdr_sizeof(xdrproc_t func, void *data);
330 * Common opaque bytes objects used by many rpc protocols;
331 * declared here due to commonality.
333 #define MAX_NETOBJ_SZ 1024
338 typedef struct netobj netobj;
339 extern bool_t xdr_netobj(XDR *, struct netobj *);
342 * These are XDR control operators
345 #define XDR_GET_BYTES_AVAIL 1
347 #define XDR_SKIPBYTES 3
349 struct xdr_bytesrec {
350 bool_t xc_is_last_record;
354 typedef struct xdr_bytesrec xdr_bytesrec;
358 * These are the public routines for the various implementations of
362 /* XDR using memory buffers */
363 extern void xdrmem_create(XDR *, char *, u_int, enum xdr_op);
365 /* XDR using mbufs */
367 extern void xdrmbuf_create(XDR *, struct mbuf *, enum xdr_op);
368 extern void xdrmbuf_append(XDR *, struct mbuf *);
369 extern struct mbuf * xdrmbuf_getall(XDR *);
371 /* XDR pseudo records for tcp */
372 extern void xdrrec_create(XDR *, u_int, u_int, void *,
373 int (*)(void *, void *, int),
374 int (*)(void *, void *, int));
376 /* make end of xdr record */
377 extern bool_t xdrrec_endofrecord(XDR *, int);
379 /* move to beginning of next record */
380 extern bool_t xdrrec_skiprecord(XDR *);
382 /* true if no more input */
383 extern bool_t xdrrec_eof(XDR *);
384 extern u_int xdrrec_readbytes(XDR *, caddr_t, u_int);
387 #endif /* !_KRPC_XDR_H */