* sunrpc/Versions: Add new xdr functions to GLIBC_2.1.1
[kopensolaris-gnu/glibc.git] / sunrpc / rpc / xdr.h
1 /* @(#)xdr.h    2.2 88/07/29 4.0 RPCSRC */
2 /*
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.
9  *
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.
13  *
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.
17  *
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.
21  *
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.
25  *
26  * Sun Microsystems, Inc.
27  * 2550 Garcia Avenue
28  * Mountain View, California  94043
29  */
30 /*      @(#)xdr.h 1.19 87/04/22 SMI      */
31
32 /*
33  * xdr.h, External Data Representation Serialization Routines.
34  *
35  * Copyright (C) 1984, Sun Microsystems, Inc.
36  */
37
38 #ifndef _RPC_XDR_H
39 #define _RPC_XDR_H 1
40
41 #include <features.h>
42 #include <sys/types.h>
43 #include <rpc/types.h>
44
45 /* We need FILE.  */
46 #include <stdio.h>
47
48 __BEGIN_DECLS
49
50 /*
51  * XDR provides a conventional way for converting between C data
52  * types and an external bit-string representation.  Library supplied
53  * routines provide for the conversion on built-in C data types.  These
54  * routines and utility routines defined here are used to help implement
55  * a type encode/decode routine for each user-defined type.
56  *
57  * Each data type provides a single procedure which takes two arguments:
58  *
59  *      bool_t
60  *      xdrproc(xdrs, argresp)
61  *              XDR *xdrs;
62  *              <type> *argresp;
63  *
64  * xdrs is an instance of a XDR handle, to which or from which the data
65  * type is to be converted.  argresp is a pointer to the structure to be
66  * converted.  The XDR handle contains an operation field which indicates
67  * which of the operations (ENCODE, DECODE * or FREE) is to be performed.
68  *
69  * XDR_DECODE may allocate space if the pointer argresp is null.  This
70  * data can be freed with the XDR_FREE operation.
71  *
72  * We write only one procedure per data type to make it easy
73  * to keep the encode and decode procedures for a data type consistent.
74  * In many cases the same code performs all operations on a user defined type,
75  * because all the hard work is done in the component type routines.
76  * decode as a series of calls on the nested data types.
77  */
78
79 /*
80  * Xdr operations.  XDR_ENCODE causes the type to be encoded into the
81  * stream.  XDR_DECODE causes the type to be extracted from the stream.
82  * XDR_FREE can be used to release the space allocated by an XDR_DECODE
83  * request.
84  */
85 enum xdr_op {
86   XDR_ENCODE = 0,
87   XDR_DECODE = 1,
88   XDR_FREE = 2
89 };
90
91 /*
92  * This is the number of bytes per unit of external data.
93  */
94 #define BYTES_PER_XDR_UNIT      (4)
95 /*
96  * This only works if the above is a power of 2.  But it's defined to be
97  * 4 by the appropriate RFCs.  So it will work.  And it's normally quicker
98  * than the old routine.
99  */
100 #if 1
101 #define RNDUP(x)  (((x) + BYTES_PER_XDR_UNIT - 1) & ~(BYTES_PER_XDR_UNIT - 1))
102 #else /* this is the old routine */
103 #define RNDUP(x)  ((((x) + BYTES_PER_XDR_UNIT - 1) / BYTES_PER_XDR_UNIT) \
104                     * BYTES_PER_XDR_UNIT)
105 #endif
106
107 /*
108  * The XDR handle.
109  * Contains operation which is being applied to the stream,
110  * an operations vector for the particular implementation (e.g. see xdr_mem.c),
111  * and two private fields for the use of the particular implementation.
112  */
113 typedef struct XDR XDR;
114 struct XDR
115   {
116     enum xdr_op x_op;           /* operation; fast additional param */
117     struct xdr_ops
118       {
119         bool_t (*x_getlong) __PMT ((XDR *__xdrs, long *__lp));
120         /* get a long from underlying stream */
121         bool_t (*x_putlong) __PMT ((XDR *__xdrs, __const long *__lp));
122         /* put a long to " */
123         bool_t (*x_getbytes) __PMT ((XDR *__xdrs, caddr_t __addr,
124                                      u_int __len));
125         /* get some bytes from " */
126         bool_t (*x_putbytes) __PMT ((XDR *__xdrs, __const char *__addr,
127                                      u_int __len));
128         /* put some bytes to " */
129         u_int (*x_getpostn) __PMT ((__const XDR *__xdrs));
130         /* returns bytes off from beginning */
131         bool_t (*x_setpostn) __PMT ((XDR *__xdrs, u_int pos));
132         /* lets you reposition the stream */
133         long *(*x_inline) __PMT ((XDR *__xdrs, int len));
134         /* buf quick ptr to buffered data */
135         void (*x_destroy) __PMT ((XDR *__xdrs));
136         /* free privates of this xdr_stream */
137         bool_t (*x_getint32) __PMT ((XDR *__xdrs, int32_t *__ip));
138         /* get a int from underlying stream */
139         bool_t (*x_putint32) __PMT ((XDR *__xdrs, __const int32_t *__ip));
140         /* put a int to " */
141       }
142      *x_ops;
143     caddr_t x_public;           /* users' data */
144     caddr_t x_private;          /* pointer to private data */
145     caddr_t x_base;             /* private used for position info */
146     int x_handy;                /* extra private word */
147   };
148
149 /*
150  * A xdrproc_t exists for each data type which is to be encoded or decoded.
151  *
152  * The second argument to the xdrproc_t is a pointer to an opaque pointer.
153  * The opaque pointer generally points to a structure of the data type
154  * to be decoded.  If this pointer is 0, then the type routines should
155  * allocate dynamic storage of the appropriate size and return it.
156  * bool_t       (*xdrproc_t)(XDR *, caddr_t *);
157  */
158 typedef bool_t (*xdrproc_t) __PMT ((XDR *, void *,...));
159
160
161 /*
162  * Operations defined on a XDR handle
163  *
164  * XDR          *xdrs;
165  * long         *longp;
166  * caddr_t       addr;
167  * u_int         len;
168  * u_int         pos;
169  */
170 #define XDR_GETINT32(xdrs, int32p)                      \
171         (*(xdrs)->x_ops->x_getint32)(xdrs, int32p)
172 #define xdr_getint32(xdrs, int32p)                      \
173         (*(xdrs)->x_ops->x_getint32)(xdrs, int32p)
174
175 #define XDR_PUTINT32(xdrs, int32p)                      \
176         (*(xdrs)->x_ops->x_putint32)(xdrs, int32p)
177 #define xdr_putint32(xdrs, int32p)                      \
178         (*(xdrs)->x_ops->x_putint32)(xdrs, int32p)
179
180 #define XDR_GETLONG(xdrs, longp)                        \
181         (*(xdrs)->x_ops->x_getlong)(xdrs, longp)
182 #define xdr_getlong(xdrs, longp)                        \
183         (*(xdrs)->x_ops->x_getlong)(xdrs, longp)
184
185 #define XDR_PUTLONG(xdrs, longp)                        \
186         (*(xdrs)->x_ops->x_putlong)(xdrs, longp)
187 #define xdr_putlong(xdrs, longp)                        \
188         (*(xdrs)->x_ops->x_putlong)(xdrs, longp)
189
190 #define XDR_GETBYTES(xdrs, addr, len)                   \
191         (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
192 #define xdr_getbytes(xdrs, addr, len)                   \
193         (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
194
195 #define XDR_PUTBYTES(xdrs, addr, len)                   \
196         (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
197 #define xdr_putbytes(xdrs, addr, len)                   \
198         (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
199
200 #define XDR_GETPOS(xdrs)                                \
201         (*(xdrs)->x_ops->x_getpostn)(xdrs)
202 #define xdr_getpos(xdrs)                                \
203         (*(xdrs)->x_ops->x_getpostn)(xdrs)
204
205 #define XDR_SETPOS(xdrs, pos)                           \
206         (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
207 #define xdr_setpos(xdrs, pos)                           \
208         (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
209
210 #define XDR_INLINE(xdrs, len)                           \
211         (*(xdrs)->x_ops->x_inline)(xdrs, len)
212 #define xdr_inline(xdrs, len)                           \
213         (*(xdrs)->x_ops->x_inline)(xdrs, len)
214
215 #define XDR_DESTROY(xdrs)                                       \
216         do {                                                    \
217                 if ((xdrs)->x_ops->x_destroy)                   \
218                         (*(xdrs)->x_ops->x_destroy)(xdrs);      \
219         } while (0)
220 #define xdr_destroy(xdrs)                                       \
221         do {                                                    \
222                 if ((xdrs)->x_ops->x_destroy)                   \
223                         (*(xdrs)->x_ops->x_destroy)(xdrs);      \
224         } while (0)
225
226 /*
227  * Support struct for discriminated unions.
228  * You create an array of xdrdiscrim structures, terminated with
229  * a entry with a null procedure pointer.  The xdr_union routine gets
230  * the discriminant value and then searches the array of structures
231  * for a matching value.  If a match is found the associated xdr routine
232  * is called to handle that part of the union.  If there is
233  * no match, then a default routine may be called.
234  * If there is no match and no default routine it is an error.
235  */
236 #define NULL_xdrproc_t ((xdrproc_t)0)
237 struct xdr_discrim
238 {
239   int value;
240   xdrproc_t proc;
241 };
242
243 /*
244  * Inline routines for fast encode/decode of primitive data types.
245  * Caveat emptor: these use single memory cycles to get the
246  * data from the underlying buffer, and will fail to operate
247  * properly if the data is not aligned.  The standard way to use these
248  * is to say:
249  *      if ((buf = XDR_INLINE(xdrs, count)) == NULL)
250  *              return (FALSE);
251  *      <<< macro calls >>>
252  * where ``count'' is the number of bytes of data occupied
253  * by the primitive data types.
254  *
255  * N.B. and frozen for all time: each data type here uses 4 bytes
256  * of external representation.
257  */
258
259 #define IXDR_GET_INT32(buf)           ((int32_t)ntohl((uint32_t)*(buf)++))
260 #define IXDR_PUT_INT32(buf, v)        (*(buf)++ = (int32_t)htonl((uint32_t)(v)))
261 #define IXDR_GET_U_INT32(buf)         ((uint32_t)IXDR_GET_INT32(buf))
262 #define IXDR_PUT_U_INT32(buf, v)      IXDR_PUT_INT32(buf, (int32_t)(v))
263
264 /* WARNING: The IXDR_*_LONG defines are removed by Sun for new platforms
265  * and shouldn't be used any longer. Code which use this defines or longs
266  * in the RPC code will not work on 64bit Solaris platforms !
267  */
268 #define IXDR_GET_LONG(buf) \
269         ((long)ntohl((u_long)*__extension__((u_int32_t*)(buf))++))
270 #define IXDR_PUT_LONG(buf, v) \
271         (*__extension__((u_int32_t*)(buf))++ = (long)htonl((u_long)(v)))
272 #define IXDR_GET_U_LONG(buf)          ((u_long)IXDR_GET_LONG(buf))
273 #define IXDR_PUT_U_LONG(buf, v)       IXDR_PUT_LONG(buf, (long)(v))
274
275
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_SHORT(buf)           ((short)IXDR_GET_LONG(buf))
279 #define IXDR_GET_U_SHORT(buf)         ((u_short)IXDR_GET_LONG(buf))
280
281 #define IXDR_PUT_BOOL(buf, v)         IXDR_PUT_LONG(buf, (long)(v))
282 #define IXDR_PUT_ENUM(buf, v)         IXDR_PUT_LONG(buf, (long)(v))
283 #define IXDR_PUT_SHORT(buf, v)        IXDR_PUT_LONG(buf, (long)(v))
284 #define IXDR_PUT_U_SHORT(buf, v)      IXDR_PUT_LONG(buf, (long)(v))
285
286 /*
287  * These are the "generic" xdr routines.
288  * None of these can have const applied because it's not possible to
289  * know whether the call is a read or a write to the passed parameter
290  * also, the XDR structure is always updated by some of these calls.
291  */
292 extern bool_t xdr_void __P ((void));
293 extern bool_t xdr_short __P ((XDR *__xdrs, short *__sp));
294 extern bool_t xdr_u_short __P ((XDR *__xdrs, u_short *__usp));
295 extern bool_t xdr_int __P ((XDR *__xdrs, int *__ip));
296 extern bool_t xdr_u_int __P ((XDR *__xdrs, u_int *__up));
297 extern bool_t xdr_long __P ((XDR *__xdrs, long *__lp));
298 extern bool_t xdr_u_long __P ((XDR *__xdrs, u_long *__ulp));
299 extern bool_t xdr_hyper __P ((XDR *__xdrs, quad_t *__llp));
300 extern bool_t xdr_u_hyper __P ((XDR *__xdrs, u_quad_t *__ullp));
301 extern bool_t xdr_longlong_t __P ((XDR *__xdrs, quad_t *__llp));
302 extern bool_t xdr_u_longlong_t __P ((XDR *__xdrs, u_quad_t *__ullp));
303 extern bool_t xdr_int8_t __P ((XDR *__xdrs, int8_t *__ip));
304 extern bool_t xdr_uint8_t __P ((XDR *__xdrs, uint8_t *__up));
305 extern bool_t xdr_int16_t __P ((XDR *__xdrs, int16_t *__ip));
306 extern bool_t xdr_uint16_t __P ((XDR *__xdrs, uint16_t *__up));
307 extern bool_t xdr_int32_t __P ((XDR *__xdrs, int32_t *__ip));
308 extern bool_t xdr_uint32_t __P ((XDR *__xdrs, uint32_t *__up));
309 extern bool_t xdr_int64_t __P ((XDR *__xdrs, int64_t *__ip));
310 extern bool_t xdr_uint64_t __P ((XDR *__xdrs, uint64_t *__up));
311 extern bool_t xdr_bool __P ((XDR *__xdrs, bool_t *__bp));
312 extern bool_t xdr_enum __P ((XDR *__xdrs, enum_t *__ep));
313 extern bool_t xdr_array __P ((XDR * _xdrs, caddr_t *__addrp, u_int *__sizep,
314                               u_int __maxsize, u_int __elsize,
315                               xdrproc_t __elproc));
316 extern bool_t xdr_bytes __P ((XDR *__xdrs, char **__cpp, u_int *__sizep,
317                               u_int __maxsize));
318 extern bool_t xdr_opaque __P ((XDR *__xdrs, caddr_t __cp, u_int __cnt));
319 extern bool_t xdr_string __P ((XDR *__xdrs, char **__cpp, u_int __maxsize));
320 extern bool_t xdr_union __P ((XDR *__xdrs, enum_t *__dscmp, char *__unp,
321                               __const struct xdr_discrim *__choices,
322                               xdrproc_t dfault));
323 extern bool_t xdr_char __P ((XDR *__xdrs, char *__cp));
324 extern bool_t xdr_u_char __P ((XDR *__xdrs, u_char *__cp));
325 extern bool_t xdr_vector __P ((XDR *__xdrs, char *__basep, u_int __nelem,
326                                u_int __elemsize, xdrproc_t __xdr_elem));
327 extern bool_t xdr_float __P ((XDR *__xdrs, float *__fp));
328 extern bool_t xdr_double __P ((XDR *__xdrs, double *__dp));
329 extern bool_t xdr_reference __P ((XDR *__xdrs, caddr_t *__xpp, u_int __size,
330                                   xdrproc_t __proc));
331 extern bool_t xdr_pointer __P ((XDR *__xdrs, char **__objpp,
332                                 u_int __obj_size, xdrproc_t __xdr_obj));
333 extern bool_t xdr_wrapstring __P ((XDR *__xdrs, char **__cpp));
334 extern u_long xdr_sizeof __P ((xdrproc_t, void *));
335
336 /*
337  * Common opaque bytes objects used by many rpc protocols;
338  * declared here due to commonality.
339  */
340 #define MAX_NETOBJ_SZ 1024
341 struct netobj
342 {
343   u_int n_len;
344   char *n_bytes;
345 };
346 typedef struct netobj netobj;
347 extern bool_t xdr_netobj __P ((XDR *__xdrs, struct netobj *__np));
348
349 /*
350  * These are the public routines for the various implementations of
351  * xdr streams.
352  */
353
354 /* XDR using memory buffers */
355 extern void xdrmem_create __P ((XDR *__xdrs, __const caddr_t __addr,
356                                 u_int __size, enum xdr_op __xop));
357
358 /* XDR using stdio library */
359 extern void xdrstdio_create __P ((XDR *__xdrs, FILE *__file,
360                                   enum xdr_op __xop));
361
362 /* XDR pseudo records for tcp */
363 extern void xdrrec_create __P ((XDR *__xdrs, u_int __sendsize,
364                                 u_int __recvsize, caddr_t __tcp_handle,
365                                 int (*__readit) (char *, char *, int),
366                                 int (*__writeit) (char *, char *, int)));
367
368 /* make end of xdr record */
369 extern bool_t xdrrec_endofrecord __P ((XDR *__xdrs, bool_t __sendnow));
370
371 /* move to beginning of next record */
372 extern bool_t xdrrec_skiprecord __P ((XDR *__xdrs));
373
374 /* true if no more input */
375 extern bool_t xdrrec_eof __P ((XDR *__xdrs));
376
377 /* free memory buffers for xdr */
378 extern void xdr_free __P ((xdrproc_t __proc, char *__objp));
379
380 __END_DECLS
381
382 #endif /* rpc/xdr.h */