2 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
3 * unrestricted use provided that this legend is included on all tape
4 * media and as a part of the software program in whole or part. Users
5 * may copy or modify Sun RPC without charge, but are not authorized
6 * to license or distribute it to anyone else except as part of a product or
7 * program developed by the user.
9 * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
10 * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
11 * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
13 * Sun RPC is provided with no support and without any obligation on the
14 * part of Sun Microsystems, Inc. to assist in its use, correction,
15 * modification or enhancement.
17 * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
18 * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
19 * OR ANY PART THEREOF.
21 * In no event will Sun Microsystems, Inc. be liable for any lost revenue
22 * or profits or other special, indirect and consequential damages, even if
23 * Sun has been advised of the possibility of such damages.
25 * Sun Microsystems, Inc.
27 * Mountain View, California 94043
30 /* This file has the contents of Sun's orginal types.h file added. */
32 /* @(#)types.h 1.1 86/02/03 SMI */
35 * Rpc additions to <sys/types.h>
38 #ifndef __XDR_INCLUDE__
39 #define __XDR_INCLUDE__
40 #include <afs/param.h>
56 #define __dontcare__ -1
59 #define mem_alloc(bsize) malloc(bsize)
63 #define mem_free(ptr, bsize) free(ptr)
66 #if defined(AFS_AMD64_LINUX24_ENV) || defined(AFS_DARWIN_ENV)
67 #define xdr_alloc afs_xdr_alloc
68 #define xdr_free afs_xdr_free
69 #define xdr_void afs_xdr_void
70 #define xdr_int afs_xdr_int
71 #define xdr_u_int afs_xdr_u_int
72 #define xdr_short afs_xdr_short
73 #define xdr_u_short afs_xdr_u_short
74 #define xdr_long afs_xdr_long
75 #define xdr_u_long afs_xdr_u_long
76 #define xdr_char afs_xdr_char
77 #define xdr_u_char afs_xdr_u_char
78 #define xdr_bool afs_xdr_bool
79 #define xdr_enum afs_xdr_enum
80 #define xdr_array afs_xdr_array
81 #define xdr_arrayN afs_xdr_arrayN
82 #define xdr_bytes afs_xdr_bytes
83 #define xdr_opaque afs_xdr_opaque
84 #define xdr_string afs_xdr_string
85 #define xdr_union afs_xdr_union
86 #define xdr_float afs_xdr_float
87 #define xdr_double afs_xdr_double
88 #define xdr_reference afs_xdr_reference
89 #define xdr_wrapstring afs_xdr_wrapstring
90 #define xdr_vector afs_xdr_vector
91 #define xdr_int64 afs_xdr_int64
92 #define xdr_uint64 afs_xdr_uint64
93 #define xdr_pointer afs_xdr_pointer
94 #define xdrmem_create afs_xdrmem_create
98 #define osi_alloc afs_osi_Alloc
99 #define osi_free afs_osi_Free
101 /* keep here for now, 64 bit issues */
102 #ifndef AFS_OBSD44_ENV
103 extern void *afs_osi_Alloc(size_t x);
104 #ifndef afs_osi_Alloc_NoSleep
105 extern void *afs_osi_Alloc_NoSleep(size_t x);
107 extern void afs_osi_Free(void *x, size_t asize);
111 #ifndef major /* ouch! */
112 #include <sys/types.h>
115 /* @(#)xdr.h 1.1 86/02/03 SMI */
118 * xdr.h, External Data Representation Serialization Routines.
120 * Copyright (C) 1984, Sun Microsystems, Inc.
124 * XDR provides a conventional way for converting between C data
125 * types and an external bit-string representation. Library supplied
126 * routines provide for the conversion on built-in C data types. These
127 * routines and utility routines defined here are used to help implement
128 * a type encode/decode routine for each user-defined type.
130 * Each data type provides a single procedure which takes two arguments:
133 * xdrproc(xdrs, argresp)
137 * xdrs is an instance of a XDR handle, to which or from which the data
138 * type is to be converted. argresp is a pointer to the structure to be
139 * converted. The XDR handle contains an operation field which indicates
140 * which of the operations (ENCODE, DECODE * or FREE) is to be performed.
142 * XDR_DECODE may allocate space if the pointer argresp is null. This
143 * data can be freed with the XDR_FREE operation.
145 * We write only one procedure per data type to make it easy
146 * to keep the encode and decode procedures for a data type consistent.
147 * In many cases the same code performs all operations on a user defined type,
148 * because all the hard work is done in the component type routines.
149 * decode as a series of calls on the nested data types.
153 * Xdr operations. XDR_ENCODE causes the type to be encoded into the
154 * stream. XDR_DECODE causes the type to be extracted from the stream.
155 * XDR_FREE can be used to release the space allocated by an XDR_DECODE
165 * This is the number of bytes per unit of external data.
167 #define BYTES_PER_XDR_UNIT (4)
170 * A xdrproc_t exists for each data type which is to be encoded or decoded.
172 * The second argument to the xdrproc_t is a pointer to an opaque pointer.
173 * The opaque pointer generally points to a structure of the data type
174 * to be decoded. If this pointer is 0, then the type routines should
175 * allocate dynamic storage of the appropriate size and return it.
176 * bool_t (*xdrproc_t)(XDR *, caddr_t *);
179 /* We need a different prototype for i386 Linux kernel code, because it
180 * uses a register (rather than stack) based calling convention. The
181 * normal va_args prototype results in the arguments being placed on the
182 * stack, where they aren't accessible to the 'real' function.
184 #if defined(AFS_I386_LINUX26_ENV) && defined(KERNEL) && !defined(UKERNEL)
185 typedef bool_t(*xdrproc_t) (void *, caddr_t, u_int);
187 typedef bool_t(*xdrproc_t) (void *, ...);
192 * Contains operation which is being applied to the stream,
193 * an operations vector for the paticular implementation (e.g. see xdr_mem.c),
194 * and two private fields for the use of the particular impelementation.
197 #if defined(KERNEL) && ((defined(AFS_SGI61_ENV) && (_MIPS_SZLONG != _MIPS_SZINT)) || defined(AFS_HPUX_64BIT_ENV))
198 /* NOTE: SGI 6.1 adds two routines to the xdr_ops if the size of a long is
199 * 64 bits. I've only done this for the kernel, since other changes may
200 * be necessary if we make a 64 bit user version of AFS.
202 #define AFS_XDR_64BITOPS 1
205 typedef struct __afs_xdr {
206 enum xdr_op x_op; /* operation; fast additional param */
208 #ifdef AFS_XDR_64BITOPS
209 bool_t(*x_getint64) (struct __afs_xdr *xdrs, afs_int64 * lp); /* get 32 bits into a long */
210 bool_t(*x_putint64) (struct __afs_xdr *xdrs, afs_int64 * lp); /* send 32 bits of a long */
212 #if !(defined(KERNEL) && defined(AFS_SUN57_ENV))
213 bool_t(*x_getint32) (struct __afs_xdr *xdrs, afs_int32 * lp); /* get an afs_int32 from underlying stream */
214 bool_t(*x_putint32) (struct __afs_xdr *xdrs, afs_int32 * lp); /* put an afs_int32 to " */
216 bool_t(*x_getbytes) (struct __afs_xdr *xdrs, caddr_t addr, u_int len); /* get some bytes from " */
217 bool_t(*x_putbytes) (struct __afs_xdr *xdrs, caddr_t addr, u_int len); /* put some bytes to " */
218 u_int(*x_getpostn) (struct __afs_xdr *xdrs); /* returns bytes off from beginning */
219 bool_t(*x_setpostn) (struct __afs_xdr *xdrs, u_int pos); /* lets you reposition the stream */
220 afs_int32 *(*x_inline) (struct __afs_xdr *xdrs, u_int len); /* buf quick ptr to buffered data */
221 void (*x_destroy) (struct __afs_xdr *xdrs); /* free privates of this xdr_stream */
222 #if defined(KERNEL) && defined(AFS_SUN57_ENV)
223 bool_t(*x_control) (struct __afs_xdr *xdrs);
224 bool_t(*x_getint32) (struct __afs_xdr *xdrs, afs_int32 * lp);
225 bool_t(*x_putint32) (struct __afs_xdr *xdrs, afs_int32 * lp);
228 caddr_t x_public; /* users' data */
229 caddr_t x_private; /* pointer to private data */
230 caddr_t x_base; /* private used for position info */
231 int x_handy; /* extra private word */
235 * Operations defined on a XDR handle
243 #ifdef AFS_XDR_64BITOPS
244 #define XDR_GETINT64(xdrs, int64p) \
245 (*(xdrs)->x_ops->x_getint64)(xdrs, int64p)
246 #define xdr_getint64(xdrs, int64p) \
247 (*(xdrs)->x_ops->x_getint64)(xdrs, int64p)
249 #define XDR_PUTINT64(xdrs, int64p) \
250 (*(xdrs)->x_ops->x_putint64)(xdrs, int64p)
251 #define xdr_putint64(xdrs, int64p) \
252 (*(xdrs)->x_ops->x_putint64)(xdrs, int64p)
253 #endif /* AFS_XDR_64BITOPS */
255 #define XDR_GETINT32(xdrs, int32p) \
256 (*(xdrs)->x_ops->x_getint32)(xdrs, int32p)
257 #define xdr_getint32(xdrs, int32p) \
258 (*(xdrs)->x_ops->x_getint32)(xdrs, int32p)
260 #define XDR_PUTINT32(xdrs, int32p) \
261 (*(xdrs)->x_ops->x_putint32)(xdrs, int32p)
262 #define xdr_putint32(xdrs, int32p) \
263 (*(xdrs)->x_ops->x_putint32)(xdrs, int32p)
265 #define XDR_GETBYTES(xdrs, addr, len) \
266 (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
267 #define xdr_getbytes(xdrs, addr, len) \
268 (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
270 #define XDR_PUTBYTES(xdrs, addr, len) \
271 (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
272 #define xdr_putbytes(xdrs, addr, len) \
273 (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
275 #define XDR_GETPOS(xdrs) \
276 (*(xdrs)->x_ops->x_getpostn)(xdrs)
277 #define xdr_getpos(xdrs) \
278 (*(xdrs)->x_ops->x_getpostn)(xdrs)
280 #define XDR_SETPOS(xdrs, pos) \
281 (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
282 #define xdr_setpos(xdrs, pos) \
283 (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
285 #define XDR_INLINE(xdrs, len) \
286 (*(xdrs)->x_ops->x_inline)(xdrs, len)
287 #define xdr_inline(xdrs, len) \
288 (*(xdrs)->x_ops->x_inline)(xdrs, len)
290 #define XDR_DESTROY(xdrs) \
291 if ((xdrs)->x_ops->x_destroy) \
292 (*(xdrs)->x_ops->x_destroy)(xdrs)
293 #define xdr_destroy(xdrs) \
294 if ((xdrs)->x_ops->x_destroy) \
295 (*(xdrs)->x_ops->x_destroy)(xdrs)
298 * Support struct for discriminated unions.
299 * You create an array of xdrdiscrim structures, terminated with
300 * a entry with a null procedure pointer. The xdr_union routine gets
301 * the discriminant value and then searches the array of structures
302 * for a matching value. If a match is found the associated xdr routine
303 * is called to handle that part of the union. If there is
304 * no match, then a default routine may be called.
305 * If there is no match and no default routine it is an error.
307 #define NULL_xdrproc_t ((xdrproc_t)0)
314 * In-line routines for fast encode/decode of primitve data types.
315 * Caveat emptor: these use single memory cycles to get the
316 * data from the underlying buffer, and will fail to operate
317 * properly if the data is not aligned. The standard way to use these
319 * if ((buf = XDR_INLINE(xdrs, count)) == NULL)
321 * <<< macro calls >>>
322 * where ``count'' is the number of bytes of data occupied
323 * by the primitive data types.
325 * N.B. and frozen for all time: each data type here uses 4 bytes
326 * of external representation.
328 #define IXDR_GET_INT32(buf) ntohl(*buf++)
329 #define IXDR_PUT_INT32(buf, v) (*buf++ = htonl(v))
331 #define IXDR_GET_BOOL(buf) ((bool_t)IXDR_GET_INT32(buf))
332 #define IXDR_GET_ENUM(buf, t) ((t)IXDR_GET_INT32(buf))
333 #define IXDR_GET_U_INT32(buf) ((afs_uint32)IXDR_GET_INT32(buf))
334 #define IXDR_GET_SHORT(buf) ((short)IXDR_GET_INT32(buf))
335 #define IXDR_GET_U_SHORT(buf) ((u_short)IXDR_GET_INT32(buf))
337 #define IXDR_PUT_BOOL(buf, v) IXDR_PUT_INT32((buf), ((afs_int32)(v)))
338 #define IXDR_PUT_ENUM(buf, v) IXDR_PUT_INT32((buf), ((afs_int32)(v)))
339 #define IXDR_PUT_U_INT32(buf, v) IXDR_PUT_INT32((buf), ((afs_int32)(v)))
340 #define IXDR_PUT_SHORT(buf, v) IXDR_PUT_INT32((buf), ((afs_int32)(v)))
341 #define IXDR_PUT_U_SHORT(buf, v) IXDR_PUT_INT32((buf), ((afs_int32)(v)))
343 #include "xdr_prototypes.h"
344 #endif /* __XDR_INCLUDE__ */