1*3223e492Schristos /* $NetBSD: xdr.h,v 1.2 2019/06/16 16:01:44 christos Exp $ */
247857fd4Shannken
347857fd4Shannken /*
447857fd4Shannken * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
547857fd4Shannken * unrestricted use provided that this legend is included on all tape
647857fd4Shannken * media and as a part of the software program in whole or part. Users
747857fd4Shannken * may copy or modify Sun RPC without charge, but are not authorized
847857fd4Shannken * to license or distribute it to anyone else except as part of a product or
947857fd4Shannken * program developed by the user.
1047857fd4Shannken *
1147857fd4Shannken * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
1247857fd4Shannken * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
1347857fd4Shannken * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
1447857fd4Shannken *
1547857fd4Shannken * Sun RPC is provided with no support and without any obligation on the
1647857fd4Shannken * part of Sun Microsystems, Inc. to assist in its use, correction,
1747857fd4Shannken * modification or enhancement.
1847857fd4Shannken *
1947857fd4Shannken * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
2047857fd4Shannken * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
2147857fd4Shannken * OR ANY PART THEREOF.
2247857fd4Shannken *
2347857fd4Shannken * In no event will Sun Microsystems, Inc. be liable for any lost revenue
2447857fd4Shannken * or profits or other special, indirect and consequential damages, even if
2547857fd4Shannken * Sun has been advised of the possibility of such damages.
2647857fd4Shannken *
2747857fd4Shannken * Sun Microsystems, Inc.
2847857fd4Shannken * 2550 Garcia Avenue
2947857fd4Shannken * Mountain View, California 94043
3047857fd4Shannken *
3147857fd4Shannken * from: @(#)xdr.h 1.19 87/04/22 SMI
3247857fd4Shannken * @(#)xdr.h 2.2 88/07/29 4.0 RPCSRC
3347857fd4Shannken */
3447857fd4Shannken
3547857fd4Shannken /*
3647857fd4Shannken * xdr.h, External Data Representation Serialization Routines.
3747857fd4Shannken *
3847857fd4Shannken * Copyright (C) 1984, Sun Microsystems, Inc.
3947857fd4Shannken */
4047857fd4Shannken
4147857fd4Shannken #ifndef _RPC_XDR_H_
4247857fd4Shannken #define _RPC_XDR_H_
4347857fd4Shannken #include <sys/cdefs.h>
4447857fd4Shannken
4547857fd4Shannken /*
4647857fd4Shannken * XDR provides a conventional way for converting between C data
4747857fd4Shannken * types and an external bit-string representation. Library supplied
4847857fd4Shannken * routines provide for the conversion on built-in C data types. These
4947857fd4Shannken * routines and utility routines defined here are used to help implement
5047857fd4Shannken * a type encode/decode routine for each user-defined type.
5147857fd4Shannken *
5247857fd4Shannken * Each data type provides a single procedure which takes two arguments:
5347857fd4Shannken *
5447857fd4Shannken * bool_t
5547857fd4Shannken * xdrproc(xdrs, argresp)
5647857fd4Shannken * XDR *xdrs;
5747857fd4Shannken * <type> *argresp;
5847857fd4Shannken *
5947857fd4Shannken * xdrs is an instance of a XDR handle, to which or from which the data
6047857fd4Shannken * type is to be converted. argresp is a pointer to the structure to be
6147857fd4Shannken * converted. The XDR handle contains an operation field which indicates
6247857fd4Shannken * which of the operations (ENCODE, DECODE * or FREE) is to be performed.
6347857fd4Shannken *
6447857fd4Shannken * XDR_DECODE may allocate space if the pointer argresp is null. This
6547857fd4Shannken * data can be freed with the XDR_FREE operation.
6647857fd4Shannken *
6747857fd4Shannken * We write only one procedure per data type to make it easy
6847857fd4Shannken * to keep the encode and decode procedures for a data type consistent.
6947857fd4Shannken * In many cases the same code performs all operations on a user defined type,
7047857fd4Shannken * because all the hard work is done in the component type routines.
7147857fd4Shannken * decode as a series of calls on the nested data types.
7247857fd4Shannken */
7347857fd4Shannken
7447857fd4Shannken /*
7547857fd4Shannken * Xdr operations. XDR_ENCODE causes the type to be encoded into the
7647857fd4Shannken * stream. XDR_DECODE causes the type to be extracted from the stream.
7747857fd4Shannken * XDR_FREE can be used to release the space allocated by an XDR_DECODE
7847857fd4Shannken * request.
7947857fd4Shannken */
8047857fd4Shannken enum xdr_op {
8147857fd4Shannken XDR_ENCODE=0,
8247857fd4Shannken XDR_DECODE=1,
8347857fd4Shannken XDR_FREE=2
8447857fd4Shannken };
8547857fd4Shannken
8647857fd4Shannken /*
8747857fd4Shannken * This is the number of bytes per unit of external data.
8847857fd4Shannken */
8947857fd4Shannken #define BYTES_PER_XDR_UNIT (4)
9047857fd4Shannken #define RNDUP(x) ((((x) + BYTES_PER_XDR_UNIT - 1) / BYTES_PER_XDR_UNIT) \
9147857fd4Shannken * BYTES_PER_XDR_UNIT)
9247857fd4Shannken
9347857fd4Shannken /*
9447857fd4Shannken * The XDR handle.
9547857fd4Shannken * Contains operation which is being applied to the stream,
9647857fd4Shannken * an operations vector for the paticular implementation (e.g. see xdr_mem.c),
9747857fd4Shannken * and two private fields for the use of the particular impelementation.
9847857fd4Shannken */
9947857fd4Shannken typedef struct __rpc_xdr {
10047857fd4Shannken enum xdr_op x_op; /* operation; fast additional param */
10147857fd4Shannken const struct xdr_ops {
10247857fd4Shannken /* get a long from underlying stream */
10347857fd4Shannken bool_t (*x_getlong)(struct __rpc_xdr *, long *);
10447857fd4Shannken /* put a long to " */
10547857fd4Shannken bool_t (*x_putlong)(struct __rpc_xdr *, const long *);
10647857fd4Shannken /* get some bytes from " */
10747857fd4Shannken bool_t (*x_getbytes)(struct __rpc_xdr *, char *, unsigned int);
10847857fd4Shannken /* put some bytes to " */
10947857fd4Shannken bool_t (*x_putbytes)(struct __rpc_xdr *, const char *,
11047857fd4Shannken unsigned int);
11147857fd4Shannken /* returns bytes off from beginning */
11247857fd4Shannken unsigned (*x_getpostn)(struct __rpc_xdr *);
11347857fd4Shannken /* lets you reposition the stream */
11447857fd4Shannken bool_t (*x_setpostn)(struct __rpc_xdr *, unsigned int);
11547857fd4Shannken /* buf quick ptr to buffered data */
11647857fd4Shannken int32_t *(*x_inline)(struct __rpc_xdr *, unsigned int);
11747857fd4Shannken /* free privates of this xdr_stream */
11847857fd4Shannken void (*x_destroy)(struct __rpc_xdr *);
11947857fd4Shannken bool_t (*x_control)(struct __rpc_xdr *, int, void *);
12047857fd4Shannken } *x_ops;
12147857fd4Shannken char * x_public; /* users' data */
12247857fd4Shannken void * x_private; /* pointer to private data */
12347857fd4Shannken char * x_base; /* private used for position info */
12447857fd4Shannken unsigned int x_handy; /* extra private word */
12547857fd4Shannken } XDR;
12647857fd4Shannken
12747857fd4Shannken /*
12847857fd4Shannken * A xdrproc_t exists for each data type which is to be encoded or decoded.
12947857fd4Shannken *
13047857fd4Shannken * The second argument to the xdrproc_t is a pointer to an opaque pointer.
13147857fd4Shannken * The opaque pointer generally points to a structure of the data type
13247857fd4Shannken * to be decoded. If this pointer is 0, then the type routines should
13347857fd4Shannken * allocate dynamic storage of the appropriate size and return it.
13447857fd4Shannken */
13547857fd4Shannken typedef bool_t (*xdrproc_t)(XDR *, const void *);
13647857fd4Shannken
13747857fd4Shannken /*
13847857fd4Shannken * Operations defined on a XDR handle
13947857fd4Shannken *
14047857fd4Shannken * XDR *xdrs;
14147857fd4Shannken * long *longp;
14247857fd4Shannken * char * addr;
14347857fd4Shannken * unsigned len;
14447857fd4Shannken * unsigned pos;
14547857fd4Shannken */
14647857fd4Shannken #define XDR_GETLONG(xdrs, longp) \
14747857fd4Shannken (*(xdrs)->x_ops->x_getlong)(xdrs, longp)
14847857fd4Shannken #define xdr_getlong(xdrs, longp) \
14947857fd4Shannken (*(xdrs)->x_ops->x_getlong)(xdrs, longp)
15047857fd4Shannken
15147857fd4Shannken #define XDR_PUTLONG(xdrs, longp) \
15247857fd4Shannken (*(xdrs)->x_ops->x_putlong)(xdrs, longp)
15347857fd4Shannken #define xdr_putlong(xdrs, longp) \
15447857fd4Shannken (*(xdrs)->x_ops->x_putlong)(xdrs, longp)
15547857fd4Shannken
15647857fd4Shannken static __inline int
xdr_getint32(XDR * xdrs,int32_t * ip)15747857fd4Shannken xdr_getint32(XDR *xdrs, int32_t *ip)
15847857fd4Shannken {
15947857fd4Shannken long l;
16047857fd4Shannken
16147857fd4Shannken if (!xdr_getlong(xdrs, &l))
16247857fd4Shannken return 0;
16347857fd4Shannken *ip = (int32_t)l;
16447857fd4Shannken return 1;
16547857fd4Shannken }
16647857fd4Shannken
16747857fd4Shannken static __inline int
xdr_putint32(XDR * xdrs,int32_t * ip)16847857fd4Shannken xdr_putint32(XDR *xdrs, int32_t *ip)
16947857fd4Shannken {
17047857fd4Shannken long l;
17147857fd4Shannken
17247857fd4Shannken l = (long)*ip;
17347857fd4Shannken return xdr_putlong(xdrs, &l);
17447857fd4Shannken }
17547857fd4Shannken
17647857fd4Shannken #define XDR_GETINT32(xdrs, int32p) xdr_getint32(xdrs, int32p)
17747857fd4Shannken #define XDR_PUTINT32(xdrs, int32p) xdr_putint32(xdrs, int32p)
17847857fd4Shannken
17947857fd4Shannken #define XDR_GETBYTES(xdrs, addr, len) \
18047857fd4Shannken (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
18147857fd4Shannken #define xdr_getbytes(xdrs, addr, len) \
18247857fd4Shannken (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
18347857fd4Shannken
18447857fd4Shannken #define XDR_PUTBYTES(xdrs, addr, len) \
18547857fd4Shannken (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
18647857fd4Shannken #define xdr_putbytes(xdrs, addr, len) \
18747857fd4Shannken (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
18847857fd4Shannken
18947857fd4Shannken #define XDR_GETPOS(xdrs) \
19047857fd4Shannken (*(xdrs)->x_ops->x_getpostn)(xdrs)
19147857fd4Shannken #define xdr_getpos(xdrs) \
19247857fd4Shannken (*(xdrs)->x_ops->x_getpostn)(xdrs)
19347857fd4Shannken
19447857fd4Shannken #define XDR_SETPOS(xdrs, pos) \
19547857fd4Shannken (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
19647857fd4Shannken #define xdr_setpos(xdrs, pos) \
19747857fd4Shannken (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
19847857fd4Shannken
19947857fd4Shannken #define XDR_INLINE(xdrs, len) \
20047857fd4Shannken (*(xdrs)->x_ops->x_inline)(xdrs, len)
20147857fd4Shannken #define xdr_inline(xdrs, len) \
20247857fd4Shannken (*(xdrs)->x_ops->x_inline)(xdrs, len)
20347857fd4Shannken
20447857fd4Shannken #define XDR_DESTROY(xdrs) \
20547857fd4Shannken if ((xdrs)->x_ops->x_destroy) \
20647857fd4Shannken (*(xdrs)->x_ops->x_destroy)(xdrs)
20747857fd4Shannken #define xdr_destroy(xdrs) \
20847857fd4Shannken if ((xdrs)->x_ops->x_destroy) \
20947857fd4Shannken (*(xdrs)->x_ops->x_destroy)(xdrs)
21047857fd4Shannken
21147857fd4Shannken #define XDR_CONTROL(xdrs, req, op) \
21247857fd4Shannken (((xdrs)->x_ops->x_control == NULL) ? (FALSE) : \
21347857fd4Shannken (*(xdrs)->x_ops->x_control)(xdrs, req, op))
21447857fd4Shannken #define xdr_control(xdrs, req, op) XDR_CONTROL(xdrs, req, op)
21547857fd4Shannken
21647857fd4Shannken #define xdr_rpcvers(xdrs, versp) xdr_u_int32_t(xdrs, versp)
21747857fd4Shannken #define xdr_rpcprog(xdrs, progp) xdr_u_int32_t(xdrs, progp)
21847857fd4Shannken #define xdr_rpcproc(xdrs, procp) xdr_u_int32_t(xdrs, procp)
21947857fd4Shannken #define xdr_rpcprot(xdrs, protp) xdr_u_int32_t(xdrs, protp)
22047857fd4Shannken #define xdr_rpcport(xdrs, portp) xdr_u_int32_t(xdrs, portp)
22147857fd4Shannken
22247857fd4Shannken /*
22347857fd4Shannken * Support struct for discriminated unions.
22447857fd4Shannken * You create an array of xdrdiscrim structures, terminated with
22547857fd4Shannken * a entry with a null procedure pointer. The xdr_union routine gets
22647857fd4Shannken * the discriminant value and then searches the array of structures
22747857fd4Shannken * for a matching value. If a match is found the associated xdr routine
22847857fd4Shannken * is called to handle that part of the union. If there is
22947857fd4Shannken * no match, then a default routine may be called.
23047857fd4Shannken * If there is no match and no default routine it is an error.
23147857fd4Shannken */
23247857fd4Shannken #define NULL_xdrproc_t ((xdrproc_t)0)
23347857fd4Shannken struct xdr_discrim {
23447857fd4Shannken int value;
23547857fd4Shannken xdrproc_t proc;
23647857fd4Shannken };
23747857fd4Shannken
23847857fd4Shannken /*
23947857fd4Shannken * In-line routines for fast encode/decode of primitive data types.
24047857fd4Shannken * Caveat emptor: these use single memory cycles to get the
24147857fd4Shannken * data from the underlying buffer, and will fail to operate
24247857fd4Shannken * properly if the data is not aligned. The standard way to use these
24347857fd4Shannken * is to say:
24447857fd4Shannken * if ((buf = XDR_INLINE(xdrs, count)) == NULL)
24547857fd4Shannken * return (0);
24647857fd4Shannken * <<< macro calls >>>
24747857fd4Shannken * where ``count'' is the number of bytes of data occupied
24847857fd4Shannken * by the primitive data types.
24947857fd4Shannken *
25047857fd4Shannken * N.B. and frozen for all time: each data type here uses 4 bytes
25147857fd4Shannken * of external representation.
25247857fd4Shannken */
25347857fd4Shannken #define IXDR_GET_INT32(buf) ((int32_t)ntohl((uint32_t)*(buf)++))
25447857fd4Shannken #define IXDR_PUT_INT32(buf, v) (*(buf)++ =(int32_t)htonl((uint32_t)v))
25547857fd4Shannken #define IXDR_GET_U_INT32(buf) ((uint32_t)IXDR_GET_INT32(buf))
25647857fd4Shannken #define IXDR_PUT_U_INT32(buf, v) IXDR_PUT_INT32((buf), ((int32_t)(v)))
25747857fd4Shannken
25847857fd4Shannken #define IXDR_GET_LONG(buf) ((long)ntohl((uint32_t)*(buf)++))
25947857fd4Shannken #define IXDR_PUT_LONG(buf, v) (*(buf)++ =(int32_t)htonl((uint32_t)v))
26047857fd4Shannken
26147857fd4Shannken #define IXDR_GET_BOOL(buf) ((bool_t)IXDR_GET_LONG(buf))
26247857fd4Shannken #define IXDR_GET_ENUM(buf, t) ((t)IXDR_GET_LONG(buf))
26347857fd4Shannken #define IXDR_GET_U_LONG(buf) ((unsigned long)IXDR_GET_LONG(buf))
26447857fd4Shannken #define IXDR_GET_SHORT(buf) ((short)IXDR_GET_LONG(buf))
26547857fd4Shannken #define IXDR_GET_U_SHORT(buf) ((unsigned short)IXDR_GET_LONG(buf))
26647857fd4Shannken
26747857fd4Shannken #define IXDR_PUT_BOOL(buf, v) IXDR_PUT_LONG((buf), (v))
26847857fd4Shannken #define IXDR_PUT_ENUM(buf, v) IXDR_PUT_LONG((buf), (v))
26947857fd4Shannken #define IXDR_PUT_U_LONG(buf, v) IXDR_PUT_LONG((buf), (v))
27047857fd4Shannken #define IXDR_PUT_SHORT(buf, v) IXDR_PUT_LONG((buf), (v))
27147857fd4Shannken #define IXDR_PUT_U_SHORT(buf, v) IXDR_PUT_LONG((buf), (v))
27247857fd4Shannken
27347857fd4Shannken /*
27447857fd4Shannken * These are the "generic" xdr routines.
27547857fd4Shannken */
27647857fd4Shannken __BEGIN_DECLS
27747857fd4Shannken extern bool_t xdr_void(void);
27847857fd4Shannken extern bool_t xdr_int(XDR *, int *);
27947857fd4Shannken extern bool_t xdr_u_int(XDR *, unsigned int *);
28047857fd4Shannken extern bool_t xdr_long(XDR *, long *);
28147857fd4Shannken extern bool_t xdr_u_long(XDR *, unsigned long *);
28247857fd4Shannken extern bool_t xdr_short(XDR *, short *);
28347857fd4Shannken extern bool_t xdr_u_short(XDR *, unsigned short *);
28447857fd4Shannken extern bool_t xdr_int16_t(XDR *, int16_t *);
28547857fd4Shannken extern bool_t xdr_u_int16_t(XDR *, uint16_t *);
28647857fd4Shannken extern bool_t xdr_int32_t(XDR *, int32_t *);
28747857fd4Shannken extern bool_t xdr_u_int32_t(XDR *, uint32_t *);
28847857fd4Shannken extern bool_t xdr_int64_t(XDR *, int64_t *);
28947857fd4Shannken extern bool_t xdr_u_int64_t(XDR *, uint64_t *);
29047857fd4Shannken extern bool_t xdr_bool(XDR *, bool_t *);
29147857fd4Shannken extern bool_t xdr_enum(XDR *, enum_t *);
29247857fd4Shannken extern bool_t xdr_array(XDR *, char **, unsigned int *, unsigned int,
29347857fd4Shannken unsigned int, xdrproc_t);
29447857fd4Shannken extern bool_t xdr_bytes(XDR *, char **, unsigned int *, unsigned int);
29547857fd4Shannken extern bool_t xdr_opaque(XDR *, char *, unsigned int);
29647857fd4Shannken extern bool_t xdr_string(XDR *, char **, unsigned int);
29747857fd4Shannken extern bool_t xdr_union(XDR *, enum_t *, char *, const struct xdr_discrim *, xdrproc_t);
29847857fd4Shannken extern bool_t xdr_char(XDR *, char *);
29947857fd4Shannken extern bool_t xdr_u_char(XDR *, unsigned char *);
30047857fd4Shannken extern bool_t xdr_vector(XDR *, char *, unsigned int, unsigned int,
30147857fd4Shannken xdrproc_t);
30247857fd4Shannken extern bool_t xdr_float(XDR *, float *);
30347857fd4Shannken extern bool_t xdr_double(XDR *, double *);
30447857fd4Shannken extern bool_t xdr_quadruple(XDR *, long double *);
30547857fd4Shannken extern bool_t xdr_reference(XDR *, char **, unsigned int, xdrproc_t);
30647857fd4Shannken extern bool_t xdr_pointer(XDR *, char **, unsigned int, xdrproc_t);
30747857fd4Shannken extern bool_t xdr_wrapstring(XDR *, char **);
30847857fd4Shannken extern void xdr_free(xdrproc_t, char *);
30947857fd4Shannken extern bool_t xdr_hyper(XDR *, longlong_t *);
31047857fd4Shannken extern bool_t xdr_u_hyper(XDR *, u_longlong_t *);
31147857fd4Shannken extern bool_t xdr_longlong_t(XDR *, longlong_t *);
31247857fd4Shannken extern bool_t xdr_u_longlong_t(XDR *, u_longlong_t *);
31347857fd4Shannken extern unsigned long xdr_sizeof(xdrproc_t, void *);
31447857fd4Shannken __END_DECLS
31547857fd4Shannken
31647857fd4Shannken /*
31747857fd4Shannken * Common opaque bytes objects used by many rpc protocols;
31847857fd4Shannken * declared here due to commonality.
31947857fd4Shannken */
32047857fd4Shannken #define MAX_NETOBJ_SZ 1024
32147857fd4Shannken struct netobj {
32247857fd4Shannken unsigned int n_len;
32347857fd4Shannken char *n_bytes;
32447857fd4Shannken };
32547857fd4Shannken typedef struct netobj netobj;
32647857fd4Shannken extern bool_t xdr_netobj(XDR *, struct netobj *);
32747857fd4Shannken
32847857fd4Shannken /*
32947857fd4Shannken * These are XDR control operators
33047857fd4Shannken */
33147857fd4Shannken
33247857fd4Shannken #define XDR_GET_BYTES_AVAIL 1
33347857fd4Shannken
33447857fd4Shannken struct xdr_bytesrec {
33547857fd4Shannken bool_t xc_is_last_record;
33647857fd4Shannken size_t xc_num_avail;
33747857fd4Shannken };
33847857fd4Shannken
33947857fd4Shannken typedef struct xdr_bytesrec xdr_bytesrec;
34047857fd4Shannken
34147857fd4Shannken /*
34247857fd4Shannken * These are the public routines for the various implementations of
34347857fd4Shannken * xdr streams.
34447857fd4Shannken */
34547857fd4Shannken __BEGIN_DECLS
34647857fd4Shannken /* XDR using memory buffers */
34747857fd4Shannken extern void xdrmem_create(XDR *, char *, unsigned int, enum xdr_op);
34847857fd4Shannken
34947857fd4Shannken /* XDR using stdio library */
35047857fd4Shannken #ifdef _STDIO_H_
35147857fd4Shannken extern void xdrstdio_create(XDR *, FILE *, enum xdr_op);
35247857fd4Shannken #endif
35347857fd4Shannken
35447857fd4Shannken /* XDR pseudo records for tcp */
35547857fd4Shannken extern void xdrrec_create(XDR *, unsigned int, unsigned int, char *,
35647857fd4Shannken int (*)(char *, char *, int),
35747857fd4Shannken int (*)(char *, char *, int));
35847857fd4Shannken
35947857fd4Shannken /* make end of xdr record */
36047857fd4Shannken extern bool_t xdrrec_endofrecord(XDR *, int);
36147857fd4Shannken
36247857fd4Shannken /* move to beginning of next record */
36347857fd4Shannken extern bool_t xdrrec_skiprecord(XDR *);
36447857fd4Shannken
36547857fd4Shannken /* true if no more input */
36647857fd4Shannken extern bool_t xdrrec_eof(XDR *);
367*3223e492Schristos extern unsigned xdrrec_readbytes(XDR *, char *, unsigned int);
36847857fd4Shannken __END_DECLS
36947857fd4Shannken
37047857fd4Shannken #endif /* !_RPC_XDR_H_ */
371