6b0873220d79e807290481346811ce7904d4bd5d
[openafs.git] / src / rx / xdr.h
1 /*
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.
8  * 
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.
12  * 
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.
16  * 
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.
20  * 
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.
24  * 
25  * Sun Microsystems, Inc.
26  * 2550 Garcia Avenue
27  * Mountain View, California  94043
28  */
29
30 /* This file has the contents of Sun's orginal types.h file added. */
31
32 /*      @(#)types.h 1.1 86/02/03 SMI      */
33
34 /*
35  * Rpc additions to <sys/types.h>
36  */
37
38 #ifndef __XDR_INCLUDE__
39 #define __XDR_INCLUDE__
40 #include <afs/param.h>
41 #ifdef AFS_NT40_ENV
42 #ifndef _MFC_VER
43 #include <winsock2.h>
44 #endif /* _MFC_VER */
45 #endif
46 #ifndef bool_t
47 #define bool_t  int
48 #define enum_t  int
49 #endif
50 #ifndef FALSE
51 #define FALSE   0
52 #endif /* !FALSE */
53 #ifndef TRUE
54 #define TRUE    1
55 #endif /* !TRUE */
56 #define __dontcare__    -1
57
58 #ifndef mem_alloc
59 #define mem_alloc(bsize)        malloc(bsize)
60 #endif
61
62 #ifndef mem_free
63 #define mem_free(ptr, bsize)    free(ptr)
64 #endif
65
66 #if defined(AFS_AMD64_LINUX24_ENV) || defined(AFS_DARWIN_ENV) || (defined(KERNEL) && !defined(UKERNEL))
67 #define xdr_void afs_xdr_void
68 #define xdr_int afs_xdr_int
69 #define xdr_u_int afs_xdr_u_int
70 #define xdr_short afs_xdr_short
71 #define xdr_u_short afs_xdr_u_short
72 #define xdr_long afs_xdr_long
73 #define xdr_u_long afs_xdr_u_long
74 #define xdr_char afs_xdr_char
75 #define xdr_u_char afs_xdr_u_char
76 #define xdr_bool afs_xdr_bool
77 #define xdr_enum afs_xdr_enum
78 #define xdr_array afs_xdr_array
79 #define xdr_arrayN afs_xdr_arrayN
80 #define xdr_bytes afs_xdr_bytes
81 #define xdr_opaque afs_xdr_opaque
82 #define xdr_string afs_xdr_string
83 #define xdr_union afs_xdr_union
84 #define xdr_float afs_xdr_float
85 #define xdr_double afs_xdr_double
86 #define xdr_reference afs_xdr_reference
87 #define xdr_wrapstring afs_xdr_wrapstring
88 #define xdr_vector afs_xdr_vector
89 #define xdr_int64 afs_xdr_int64
90 #define xdr_uint64 afs_xdr_uint64
91 #define xdr_pointer afs_xdr_pointer
92 #endif
93
94 #ifdef  KERNEL
95 #define osi_alloc               afs_osi_Alloc
96 #define osi_free                afs_osi_Free
97
98 /* keep here for now, 64 bit issues */
99 #ifndef AFS_OBSD44_ENV
100 extern void *afs_osi_Alloc(size_t x);
101 #ifndef afs_osi_Alloc_NoSleep
102 extern void *afs_osi_Alloc_NoSleep(size_t x);
103 #endif
104 extern void afs_osi_Free(void *x, size_t asize);
105 #endif
106
107 #endif
108 #ifndef major                   /* ouch! */
109 #include <sys/types.h>
110 #endif
111
112 /*      @(#)xdr.h 1.1 86/02/03 SMI      */
113
114 /*
115  * xdr.h, External Data Representation Serialization Routines.
116  *
117  * Copyright (C) 1984, Sun Microsystems, Inc.
118  */
119
120 /*
121  * XDR provides a conventional way for converting between C data
122  * types and an external bit-string representation.  Library supplied
123  * routines provide for the conversion on built-in C data types.  These
124  * routines and utility routines defined here are used to help implement
125  * a type encode/decode routine for each user-defined type.
126  *
127  * Each data type provides a single procedure which takes two arguments:
128  *
129  *      bool_t
130  *      xdrproc(xdrs, argresp)
131  *              XDR *xdrs;
132  *              <type> *argresp;
133  *
134  * xdrs is an instance of a XDR handle, to which or from which the data
135  * type is to be converted.  argresp is a pointer to the structure to be
136  * converted.  The XDR handle contains an operation field which indicates
137  * which of the operations (ENCODE, DECODE * or FREE) is to be performed.
138  *
139  * XDR_DECODE may allocate space if the pointer argresp is null.  This
140  * data can be freed with the XDR_FREE operation.
141  *
142  * We write only one procedure per data type to make it easy
143  * to keep the encode and decode procedures for a data type consistent.
144  * In many cases the same code performs all operations on a user defined type,
145  * because all the hard work is done in the component type routines.
146  * decode as a series of calls on the nested data types.
147  */
148
149 /*
150  * Xdr operations.  XDR_ENCODE causes the type to be encoded into the
151  * stream.  XDR_DECODE causes the type to be extracted from the stream.
152  * XDR_FREE can be used to release the space allocated by an XDR_DECODE
153  * request.
154  */
155 enum xdr_op {
156     XDR_ENCODE = 0,
157     XDR_DECODE = 1,
158     XDR_FREE = 2
159 };
160
161 /*
162  * This is the number of bytes per unit of external data.
163  */
164 #define BYTES_PER_XDR_UNIT      (4)
165
166 /*
167  * A xdrproc_t exists for each data type which is to be encoded or decoded.
168  *
169  * The second argument to the xdrproc_t is a pointer to an opaque pointer.
170  * The opaque pointer generally points to a structure of the data type
171  * to be decoded.  If this pointer is 0, then the type routines should
172  * allocate dynamic storage of the appropriate size and return it.
173  * bool_t       (*xdrproc_t)(XDR *, caddr_t *);
174  */
175 #if 0
176 typedef bool_t(*xdrproc_t) ();
177 #else
178 #ifdef AFS_I386_LINUX26_ENV
179 typedef bool_t(*xdrproc_t) (void *, caddr_t *, u_int);
180 #else
181 typedef bool_t(*xdrproc_t) (void *, ...);
182 #endif
183 #endif
184
185
186 /*
187  * The XDR handle.
188  * Contains operation which is being applied to the stream,
189  * an operations vector for the paticular implementation (e.g. see xdr_mem.c),
190  * and two private fields for the use of the particular impelementation.
191  */
192 typedef struct {
193     enum xdr_op x_op;           /* operation; fast additional param */
194     struct xdr_ops {
195 #if defined(KERNEL) && ((defined(AFS_SGI61_ENV) && (_MIPS_SZLONG != _MIPS_SZINT)) || defined(AFS_HPUX_64BIT_ENV))
196 /* NOTE: SGI 6.1 adds two routines to the xdr_ops if the size of a long is
197  * 64 bits. I've only done this for the kernel, since other changes may
198  * be necessary if we make a 64 bit user version of AFS.
199  */
200         bool_t(*x_getint64) (void *xdrs, afs_int64 * lp);       /* get 32 bits into a long */
201         bool_t(*x_putint64) (void *xdrs, afs_int64 * lp);       /* send 32 bits of a long */
202 #endif                          /* defined(KERNEL) && ((defined(AFS_SGI61_ENV) && (_MIPS_SZLONG != _MIPS_SZINT)) || defined(AFS_HPUX_64BIT_ENV)) */
203 #if !(defined(KERNEL) && defined(AFS_SUN57_ENV))
204         bool_t(*x_getint32) (void *xdrs, afs_int32 * lp);       /* get an afs_int32 from underlying stream */
205         bool_t(*x_putint32) (void *xdrs, afs_int32 * lp);       /* put an afs_int32 to " */
206 #endif
207         bool_t(*x_getbytes) (void *xdrs, caddr_t addr, u_int len);      /* get some bytes from " */
208         bool_t(*x_putbytes) (void *xdrs, caddr_t addr, u_int len);      /* put some bytes to " */
209         u_int(*x_getpostn) (void *xdrs);        /* returns bytes off from beginning */
210         bool_t(*x_setpostn) (void *xdrs, u_int pos);    /* lets you reposition the stream */
211         afs_int32 *(*x_inline) (void *xdrs, u_int len); /* buf quick ptr to buffered data */
212         void (*x_destroy) (void *xdrs); /* free privates of this xdr_stream */
213 #if defined(KERNEL) && defined(AFS_SUN57_ENV)
214           bool_t(*x_control) (void *xdrs);
215           bool_t(*x_getint32) (void *xdrs, afs_int32 * lp);
216           bool_t(*x_putint32) (void *xdrs, afs_int32 * lp);
217 #endif
218     } *x_ops;
219     caddr_t x_public;           /* users' data */
220     caddr_t x_private;          /* pointer to private data */
221     caddr_t x_base;             /* private used for position info */
222     int x_handy;                /* extra private word */
223 } XDR;
224
225 /*
226  * Operations defined on a XDR handle
227  *
228  * XDR          *xdrs;
229  * afs_int32            *int32p;
230  * caddr_t       addr;
231  * u_int         len;
232  * u_int         pos;
233  */
234 #if defined(AFS_SGI61_ENV) && defined(KERNEL) && (_MIPS_SZLONG != _MIPS_SZINT) || defined(AFS_HPUX_64BIT_ENV)
235 #define XDR_GETINT64(xdrs, int64p)                      \
236         (*(xdrs)->x_ops->x_getint64)(xdrs, int64p)
237 #define xdr_getint64(xdrs, int64p)                      \
238         (*(xdrs)->x_ops->x_getint64)(xdrs, int64p)
239
240 #define XDR_PUTINT64(xdrs, int64p)                      \
241         (*(xdrs)->x_ops->x_putint64)(xdrs, int64p)
242 #define xdr_putint64(xdrs, int64p)                      \
243         (*(xdrs)->x_ops->x_putint64)(xdrs, int64p)
244 #endif /* defined(KERNEL) && ((defined(AFS_SGI61_ENV) && (_MIPS_SZLONG != _MIPS_SZINT)) || defined(AFS_HPUX_64BIT_ENV)) */
245
246 #define XDR_GETINT32(xdrs, int32p)                      \
247         (*(xdrs)->x_ops->x_getint32)(xdrs, int32p)
248 #define xdr_getint32(xdrs, int32p)                      \
249         (*(xdrs)->x_ops->x_getint32)(xdrs, int32p)
250
251 #define XDR_PUTINT32(xdrs, int32p)                      \
252         (*(xdrs)->x_ops->x_putint32)(xdrs, int32p)
253 #define xdr_putint32(xdrs, int32p)                      \
254         (*(xdrs)->x_ops->x_putint32)(xdrs, int32p)
255
256 #define XDR_GETBYTES(xdrs, addr, len)                   \
257         (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
258 #define xdr_getbytes(xdrs, addr, len)                   \
259         (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
260
261 #define XDR_PUTBYTES(xdrs, addr, len)                   \
262         (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
263 #define xdr_putbytes(xdrs, addr, len)                   \
264         (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
265
266 #define XDR_GETPOS(xdrs)                                \
267         (*(xdrs)->x_ops->x_getpostn)(xdrs)
268 #define xdr_getpos(xdrs)                                \
269         (*(xdrs)->x_ops->x_getpostn)(xdrs)
270
271 #define XDR_SETPOS(xdrs, pos)                           \
272         (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
273 #define xdr_setpos(xdrs, pos)                           \
274         (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
275
276 #define XDR_INLINE(xdrs, len)                           \
277         (*(xdrs)->x_ops->x_inline)(xdrs, len)
278 #define xdr_inline(xdrs, len)                           \
279         (*(xdrs)->x_ops->x_inline)(xdrs, len)
280
281 #define XDR_DESTROY(xdrs)                               \
282         if ((xdrs)->x_ops->x_destroy)                   \
283                 (*(xdrs)->x_ops->x_destroy)(xdrs)
284 #define xdr_destroy(xdrs)                               \
285         if ((xdrs)->x_ops->x_destroy)                   \
286                 (*(xdrs)->x_ops->x_destroy)(xdrs)
287
288 /*
289  * Support struct for discriminated unions.
290  * You create an array of xdrdiscrim structures, terminated with
291  * a entry with a null procedure pointer.  The xdr_union routine gets
292  * the discriminant value and then searches the array of structures
293  * for a matching value.  If a match is found the associated xdr routine
294  * is called to handle that part of the union.  If there is
295  * no match, then a default routine may be called.
296  * If there is no match and no default routine it is an error.
297  */
298 #define NULL_xdrproc_t ((xdrproc_t)0)
299 struct xdr_discrim {
300     int value;
301     xdrproc_t proc;
302 };
303
304 /*
305  * In-line routines for fast encode/decode of primitve data types.
306  * Caveat emptor: these use single memory cycles to get the
307  * data from the underlying buffer, and will fail to operate
308  * properly if the data is not aligned.  The standard way to use these
309  * is to say:
310  *      if ((buf = XDR_INLINE(xdrs, count)) == NULL)
311  *              return (FALSE);
312  *      <<< macro calls >>>
313  * where ``count'' is the number of bytes of data occupied
314  * by the primitive data types.
315  *
316  * N.B. and frozen for all time: each data type here uses 4 bytes
317  * of external representation.
318  */
319 #define IXDR_GET_INT32(buf)             ntohl(*buf++)
320 #define IXDR_PUT_INT32(buf, v)          (*buf++ = htonl(v))
321
322 #define IXDR_GET_BOOL(buf)              ((bool_t)IXDR_GET_INT32(buf))
323 #define IXDR_GET_ENUM(buf, t)           ((t)IXDR_GET_INT32(buf))
324 #define IXDR_GET_U_INT32(buf)           ((afs_uint32)IXDR_GET_INT32(buf))
325 #define IXDR_GET_SHORT(buf)             ((short)IXDR_GET_INT32(buf))
326 #define IXDR_GET_U_SHORT(buf)           ((u_short)IXDR_GET_INT32(buf))
327
328 #define IXDR_PUT_BOOL(buf, v)           IXDR_PUT_INT32((buf), ((afs_int32)(v)))
329 #define IXDR_PUT_ENUM(buf, v)           IXDR_PUT_INT32((buf), ((afs_int32)(v)))
330 #define IXDR_PUT_U_INT32(buf, v)        IXDR_PUT_INT32((buf), ((afs_int32)(v)))
331 #define IXDR_PUT_SHORT(buf, v)          IXDR_PUT_INT32((buf), ((afs_int32)(v)))
332 #define IXDR_PUT_U_SHORT(buf, v)        IXDR_PUT_INT32((buf), ((afs_int32)(v)))
333
334 #include "xdr_prototypes.h"
335 #endif /* __XDR_INCLUDE__ */