1 /* @(#)xdr.h 2.2 88/07/29 4.0 RPCSRC */
3 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
4 * unrestricted use provided that this legend is included on all tape
5 * media and as a part of the software program in whole or part. Users
6 * may copy or modify Sun RPC without charge, but are not authorized
7 * to license or distribute it to anyone else except as part of a product or
8 * program developed by the user.
10 * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
11 * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
12 * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
14 * Sun RPC is provided with no support and without any obligation on the
15 * part of Sun Microsystems, Inc. to assist in its use, correction,
16 * modification or enhancement.
18 * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
19 * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
20 * OR ANY PART THEREOF.
22 * In no event will Sun Microsystems, Inc. be liable for any lost revenue
23 * or profits or other special, indirect and consequential damages, even if
24 * Sun has been advised of the possibility of such damages.
26 * Sun Microsystems, Inc.
28 * Mountain View, California 94043
30 /* @(#)xdr.h 1.19 87/04/22 SMI */
33 * xdr.h, External Data Representation Serialization Routines.
35 * Copyright (C) 1984, Sun Microsystems, Inc.
38 #ifndef __XDR_HEADER__
40 #define __XDR_HEADER__
49 * XDR provides a conventional way for converting between C data
50 * types and an external bit-string representation. Library supplied
51 * routines provide for the conversion on built-in C data types. These
52 * routines and utility routines defined here are used to help implement
53 * a type encode/decode routine for each user-defined type.
55 * Each data type provides a single procedure which takes two arguments:
58 * xdrproc(xdrs, argresp)
62 * xdrs is an instance of a XDR handle, to which or from which the data
63 * type is to be converted. argresp is a pointer to the structure to be
64 * converted. The XDR handle contains an operation field which indicates
65 * which of the operations (ENCODE, DECODE * or FREE) is to be performed.
67 * XDR_DECODE may allocate space if the pointer argresp is null. This
68 * data can be freed with the XDR_FREE operation.
70 * We write only one procedure per data type to make it easy
71 * to keep the encode and decode procedures for a data type consistent.
72 * In many cases the same code performs all operations on a user defined type,
73 * because all the hard work is done in the component type routines.
74 * decode as a series of calls on the nested data types.
78 * Xdr operations. XDR_ENCODE causes the type to be encoded into the
79 * stream. XDR_DECODE causes the type to be extracted from the stream.
80 * XDR_FREE can be used to release the space allocated by an XDR_DECODE
91 * This is the number of bytes per unit of external data.
93 #define BYTES_PER_XDR_UNIT (4)
94 #define RNDUP(x) ((((x) + BYTES_PER_XDR_UNIT - 1) / BYTES_PER_XDR_UNIT) \
99 * Contains operation which is being applied to the stream,
100 * an operations vector for the particular implementation (e.g. see xdr_mem.c),
101 * and two private fields for the use of the particular implementation.
103 typedef struct XDR XDR
;
106 enum xdr_op x_op
; /* operation; fast additional param */
109 bool_t (*x_getlong
) __P ((XDR
* __xdrs
, long *__lp
));
110 /* get a long from underlying stream */
111 bool_t (*x_putlong
) __P ((XDR
* __xdrs
, long *__lp
));
112 /* put a long to " */
113 bool_t (*x_getbytes
) __P ((XDR
* __xdrs
, caddr_t __addr
, u_int __len
));
114 /* get some bytes from " */
115 bool_t (*x_putbytes
) __P ((XDR
* __xdrs
, __const caddr_t __addr
,
117 /* put some bytes to " */
118 u_int (*x_getpostn
) __P ((XDR
* __xdrs
));
119 /* returns bytes off from beginning */
120 bool_t (*x_setpostn
) __P ((XDR
* __xdrs
, u_int pos
));
121 /* lets you reposition the stream */
122 long *(*x_inline
) __P ((XDR
* __xdrs
, int len
));
123 /* buf quick ptr to buffered data */
124 void (*x_destroy
) __P ((XDR
* __xdrs
));
125 /* free privates of this xdr_stream */
128 caddr_t x_public
; /* users' data */
129 caddr_t x_private
; /* pointer to private data */
130 caddr_t x_base
; /* private used for position info */
131 int x_handy
; /* extra private word */
135 * A xdrproc_t exists for each data type which is to be encoded or decoded.
137 * The second argument to the xdrproc_t is a pointer to an opaque pointer.
138 * The opaque pointer generally points to a structure of the data type
139 * to be decoded. If this pointer is 0, then the type routines should
140 * allocate dynamic storage of the appropriate size and return it.
141 * bool_t (*xdrproc_t)(XDR *, caddr_t *);
144 bool_t (*xdrproc_t
) __P ((XDR
*, void *,...));
147 * Operations defined on a XDR handle
155 #define XDR_GETLONG(xdrs, longp) \
156 (*(xdrs)->x_ops->x_getlong)(xdrs, longp)
157 #define xdr_getlong(xdrs, longp) \
158 (*(xdrs)->x_ops->x_getlong)(xdrs, longp)
160 #define XDR_PUTLONG(xdrs, longp) \
161 (*(xdrs)->x_ops->x_putlong)(xdrs, longp)
162 #define xdr_putlong(xdrs, longp) \
163 (*(xdrs)->x_ops->x_putlong)(xdrs, longp)
165 #define XDR_GETBYTES(xdrs, addr, len) \
166 (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
167 #define xdr_getbytes(xdrs, addr, len) \
168 (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
170 #define XDR_PUTBYTES(xdrs, addr, len) \
171 (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
172 #define xdr_putbytes(xdrs, addr, len) \
173 (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
175 #define XDR_GETPOS(xdrs) \
176 (*(xdrs)->x_ops->x_getpostn)(xdrs)
177 #define xdr_getpos(xdrs) \
178 (*(xdrs)->x_ops->x_getpostn)(xdrs)
180 #define XDR_SETPOS(xdrs, pos) \
181 (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
182 #define xdr_setpos(xdrs, pos) \
183 (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
185 #define XDR_INLINE(xdrs, len) \
186 (*(xdrs)->x_ops->x_inline)(xdrs, len)
187 #define xdr_inline(xdrs, len) \
188 (*(xdrs)->x_ops->x_inline)(xdrs, len)
190 #define XDR_DESTROY(xdrs) \
191 if ((xdrs)->x_ops->x_destroy) \
192 (*(xdrs)->x_ops->x_destroy)(xdrs)
193 #define xdr_destroy(xdrs) \
194 if ((xdrs)->x_ops->x_destroy) \
195 (*(xdrs)->x_ops->x_destroy)(xdrs)
198 * Support struct for discriminated unions.
199 * You create an array of xdrdiscrim structures, terminated with
200 * a entry with a null procedure pointer. The xdr_union routine gets
201 * the discriminant value and then searches the array of structures
202 * for a matching value. If a match is found the associated xdr routine
203 * is called to handle that part of the union. If there is
204 * no match, then a default routine may be called.
205 * If there is no match and no default routine it is an error.
207 #define NULL_xdrproc_t ((xdrproc_t)0)
215 * Inline routines for fast encode/decode of primitive data types.
216 * Caveat emptor: these use single memory cycles to get the
217 * data from the underlying buffer, and will fail to operate
218 * properly if the data is not aligned. The standard way to use these
220 * if ((buf = XDR_INLINE(xdrs, count)) == NULL)
222 * <<< macro calls >>>
223 * where ``count'' is the number of bytes of data occupied
224 * by the primitive data types.
226 * N.B. and frozen for all time: each data type here uses 4 bytes
227 * of external representation.
229 #define IXDR_GET_LONG(buf) ((long)ntohl((u_long)*((u_int32_t*)buf)++))
230 #define IXDR_PUT_LONG(buf, v) (*((u_int32_t*)(buf))++ = (long)htonl((u_long)v))
232 #define IXDR_GET_BOOL(buf) ((bool_t)IXDR_GET_LONG(buf))
233 #define IXDR_GET_ENUM(buf, t) ((t)IXDR_GET_LONG(buf))
234 #define IXDR_GET_U_LONG(buf) ((u_long)IXDR_GET_LONG(buf))
235 #define IXDR_GET_SHORT(buf) ((short)IXDR_GET_LONG(buf))
236 #define IXDR_GET_U_SHORT(buf) ((u_short)IXDR_GET_LONG(buf))
238 #define IXDR_PUT_BOOL(buf, v) IXDR_PUT_LONG((buf), ((long)(v)))
239 #define IXDR_PUT_ENUM(buf, v) IXDR_PUT_LONG((buf), ((long)(v)))
240 #define IXDR_PUT_U_LONG(buf, v) IXDR_PUT_LONG((buf), ((long)(v)))
241 #define IXDR_PUT_SHORT(buf, v) IXDR_PUT_LONG((buf), ((long)(v)))
242 #define IXDR_PUT_U_SHORT(buf, v) IXDR_PUT_LONG((buf), ((long)(v)))
245 * These are the "generic" xdr routines.
247 extern bool_t xdr_void
__P ((void));
248 extern bool_t xdr_int
__P ((XDR
* __xdrs
, int *__ip
));
249 extern bool_t xdr_u_int
__P ((XDR
* __xdrs
, u_int
* __up
));
250 extern bool_t xdr_long
__P ((XDR
* __xdrs
, long *__lp
));
251 extern bool_t xdr_u_long
__P ((XDR
* __xdrs
, u_long
* __ulp
));
252 extern bool_t xdr_short
__P ((XDR
* __xdrs
, short *__sp
));
253 extern bool_t xdr_u_short
__P ((XDR
* __xdrs
, u_short
* __usp
));
254 extern bool_t xdr_bool
__P ((XDR
* __xdrs
, bool_t
* __bp
));
255 extern bool_t xdr_enum
__P ((XDR
* __xdrs
, enum_t
* __ep
));
256 extern bool_t xdr_array
__P ((XDR
* _xdrs
, caddr_t
* __addrp
, u_int
* __sizep
,
257 u_int __maxsize
, u_int __elsize
,
258 xdrproc_t __elproc
));
259 extern bool_t xdr_bytes
__P ((XDR
* __xdrs
, char **__cpp
, u_int
* __sizep
,
261 extern bool_t xdr_opaque
__P ((XDR
* __xdrs
, caddr_t __cp
, u_int __cnt
));
262 extern bool_t xdr_string
__P ((XDR
* __xdrs
, char **__cpp
, u_int __maxsize
));
263 extern bool_t xdr_union
__P ((XDR
* __xdrs
, enum_t
* __dscmp
, char *__unp
,
264 __const
struct xdr_discrim
* __choices
,
266 extern bool_t xdr_char
__P ((XDR
* __xdrs
, char *__cp
));
267 extern bool_t xdr_u_char
__P ((XDR
* __xdrs
, u_char
* __cp
));
268 extern bool_t xdr_vector
__P ((XDR
* __xdrs
, char *__basep
, u_int __nelem
,
269 u_int __elemsize
, xdrproc_t __xdr_elem
));
270 extern bool_t xdr_float
__P ((XDR
* __xdrs
, float *__fp
));
271 extern bool_t xdr_double
__P ((XDR
* __xdrs
, double *__dp
));
272 extern bool_t xdr_reference
__P ((XDR
* __xdrs
, caddr_t
* __pp
, u_int __size
,
274 extern bool_t xdr_pointer
__P ((XDR
* __xdrs
, char **__objpp
,
275 u_int __obj_size
, xdrproc_t __xdr_obj
));
276 extern bool_t xdr_wrapstring
__P ((XDR
* __xdrs
, char **__cpp
));
279 * Common opaque bytes objects used by many rpc protocols;
280 * declared here due to commonality.
282 #define MAX_NETOBJ_SZ 1024
288 typedef struct netobj netobj
;
289 extern bool_t xdr_netobj
__P ((XDR
* __xdrs
, struct netobj
* __np
));
292 * These are the public routines for the various implementations of
296 /* XDR using memory buffers */
297 extern void xdrmem_create
__P ((XDR
* __xdrs
, caddr_t __addr
, u_int __size
,
300 /* XDR using stdio library */
301 extern void xdrstdio_create
__P ((XDR
* __xdrs
, FILE * __file
,
304 /* XDR pseudo records for tcp */
305 extern void xdrrec_create
__P ((XDR
* __xdrs
, u_int __sendsize
,
306 u_int __recvsize
, caddr_t __tcp_handle
,
307 int (*__readit
) (char *, char *, int),
308 int (*__writeit
) (char *, char *, int)));
310 /* make end of xdr record */
311 extern bool_t xdrrec_endofrecord
__P ((XDR
* __xdrs
, bool_t __sendnow
));
313 /* move to beginning of next record */
314 extern bool_t xdrrec_skiprecord
__P ((XDR
* __xdrs
));
316 /* true if no more input */
317 extern bool_t xdrrec_eof
__P ((XDR
* __xdrs
));
319 /* free memory buffers for xdr */
320 extern void xdr_free
__P ((xdrproc_t __proc
, char *__objp
));
324 #endif /* !__XDR_HEADER__ */