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