[444] | 1 | /* $NetBSD: xdr.h,v 1.19 2000/07/17 05:00:45 matt Exp $ */ |
---|
| 2 | |
---|
| 3 | /* |
---|
| 4 | * Sun RPC is a product of Sun Microsystems, Inc. and is provided for |
---|
| 5 | * unrestricted use provided that this legend is included on all tape |
---|
| 6 | * media and as a part of the software program in whole or part. Users |
---|
| 7 | * may copy or modify Sun RPC without charge, but are not authorized |
---|
| 8 | * to license or distribute it to anyone else except as part of a product or |
---|
| 9 | * program developed by the user. |
---|
| 10 | * |
---|
| 11 | * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE |
---|
| 12 | * WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
---|
| 13 | * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE. |
---|
| 14 | * |
---|
| 15 | * Sun RPC is provided with no support and without any obligation on the |
---|
| 16 | * part of Sun Microsystems, Inc. to assist in its use, correction, |
---|
| 17 | * modification or enhancement. |
---|
| 18 | * |
---|
| 19 | * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE |
---|
| 20 | * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC |
---|
| 21 | * OR ANY PART THEREOF. |
---|
| 22 | * |
---|
| 23 | * In no event will Sun Microsystems, Inc. be liable for any lost revenue |
---|
| 24 | * or profits or other special, indirect and consequential damages, even if |
---|
| 25 | * Sun has been advised of the possibility of such damages. |
---|
| 26 | * |
---|
| 27 | * Sun Microsystems, Inc. |
---|
| 28 | * 2550 Garcia Avenue |
---|
| 29 | * Mountain View, California 94043 |
---|
| 30 | * |
---|
| 31 | * from: @(#)xdr.h 1.19 87/04/22 SMI |
---|
| 32 | * from: @(#)xdr.h 2.2 88/07/29 4.0 RPCSRC |
---|
| 33 | * $FreeBSD: src/include/rpc/xdr.h,v 1.21 2002/04/28 15:18:45 des Exp $ |
---|
| 34 | */ |
---|
| 35 | |
---|
| 36 | /* |
---|
| 37 | * xdr.h, External Data Representation Serialization Routines. |
---|
| 38 | * |
---|
| 39 | * Copyright (C) 1984, Sun Microsystems, Inc. |
---|
| 40 | */ |
---|
| 41 | |
---|
| 42 | #ifndef _RPC_XDR_H |
---|
| 43 | #define _RPC_XDR_H |
---|
| 44 | #include <sys/cdefs.h> |
---|
| 45 | |
---|
| 46 | /* |
---|
| 47 | * XDR provides a conventional way for converting between C data |
---|
| 48 | * types and an external bit-string representation. Library supplied |
---|
| 49 | * routines provide for the conversion on built-in C data types. These |
---|
| 50 | * routines and utility routines defined here are used to help implement |
---|
| 51 | * a type encode/decode routine for each user-defined type. |
---|
| 52 | * |
---|
| 53 | * Each data type provides a single procedure which takes two arguments: |
---|
| 54 | * |
---|
| 55 | * bool_t |
---|
| 56 | * xdrproc(xdrs, argresp) |
---|
| 57 | * XDR *xdrs; |
---|
| 58 | * <type> *argresp; |
---|
| 59 | * |
---|
| 60 | * xdrs is an instance of a XDR handle, to which or from which the data |
---|
| 61 | * type is to be converted. argresp is a pointer to the structure to be |
---|
| 62 | * converted. The XDR handle contains an operation field which indicates |
---|
| 63 | * which of the operations (ENCODE, DECODE * or FREE) is to be performed. |
---|
| 64 | * |
---|
| 65 | * XDR_DECODE may allocate space if the pointer argresp is null. This |
---|
| 66 | * data can be freed with the XDR_FREE operation. |
---|
| 67 | * |
---|
| 68 | * We write only one procedure per data type to make it easy |
---|
| 69 | * to keep the encode and decode procedures for a data type consistent. |
---|
| 70 | * In many cases the same code performs all operations on a user defined type, |
---|
| 71 | * because all the hard work is done in the component type routines. |
---|
| 72 | * decode as a series of calls on the nested data types. |
---|
| 73 | */ |
---|
| 74 | |
---|
| 75 | /* |
---|
| 76 | * Xdr operations. XDR_ENCODE causes the type to be encoded into the |
---|
| 77 | * stream. XDR_DECODE causes the type to be extracted from the stream. |
---|
| 78 | * XDR_FREE can be used to release the space allocated by an XDR_DECODE |
---|
| 79 | * request. |
---|
| 80 | */ |
---|
| 81 | enum xdr_op { |
---|
| 82 | XDR_ENCODE=0, |
---|
| 83 | XDR_DECODE=1, |
---|
| 84 | XDR_FREE=2 |
---|
| 85 | }; |
---|
| 86 | |
---|
| 87 | /* |
---|
| 88 | * This is the number of bytes per unit of external data. |
---|
| 89 | */ |
---|
| 90 | #define BYTES_PER_XDR_UNIT (4) |
---|
| 91 | #define RNDUP(x) ((((x) + BYTES_PER_XDR_UNIT - 1) / BYTES_PER_XDR_UNIT) \ |
---|
| 92 | * BYTES_PER_XDR_UNIT) |
---|
| 93 | |
---|
| 94 | /* |
---|
| 95 | * The XDR handle. |
---|
| 96 | * Contains operation which is being applied to the stream, |
---|
| 97 | * an operations vector for the particular implementation (e.g. see xdr_mem.c), |
---|
| 98 | * and two private fields for the use of the particular implementation. |
---|
| 99 | */ |
---|
| 100 | typedef struct __rpc_xdr { |
---|
| 101 | enum xdr_op x_op; /* operation; fast additional param */ |
---|
| 102 | const struct xdr_ops { |
---|
| 103 | /* get a long from underlying stream */ |
---|
| 104 | bool_t (*x_getlong)(struct __rpc_xdr *, long *); |
---|
| 105 | /* put a long to " */ |
---|
| 106 | bool_t (*x_putlong)(struct __rpc_xdr *, const long *); |
---|
| 107 | /* get some bytes from " */ |
---|
| 108 | bool_t (*x_getbytes)(struct __rpc_xdr *, char *, u_int); |
---|
| 109 | /* put some bytes to " */ |
---|
| 110 | bool_t (*x_putbytes)(struct __rpc_xdr *, const char *, u_int); |
---|
| 111 | /* returns bytes off from beginning */ |
---|
| 112 | u_int (*x_getpostn)(struct __rpc_xdr *); |
---|
| 113 | /* lets you reposition the stream */ |
---|
| 114 | bool_t (*x_setpostn)(struct __rpc_xdr *, u_int); |
---|
| 115 | /* buf quick ptr to buffered data */ |
---|
| 116 | int32_t *(*x_inline)(struct __rpc_xdr *, u_int); |
---|
| 117 | /* free privates of this xdr_stream */ |
---|
| 118 | void (*x_destroy)(struct __rpc_xdr *); |
---|
| 119 | bool_t (*x_control)(struct __rpc_xdr *, int, void *); |
---|
| 120 | } *x_ops; |
---|
| 121 | char * x_public; /* users' data */ |
---|
| 122 | void * x_private; /* pointer to private data */ |
---|
| 123 | char * x_base; /* private used for position info */ |
---|
| 124 | int x_handy; /* extra private word */ |
---|
| 125 | } XDR; |
---|
| 126 | |
---|
| 127 | /* |
---|
| 128 | * A xdrproc_t exists for each data type which is to be encoded or decoded. |
---|
| 129 | * |
---|
| 130 | * The second argument to the xdrproc_t is a pointer to an opaque pointer. |
---|
| 131 | * The opaque pointer generally points to a structure of the data type |
---|
| 132 | * to be decoded. If this pointer is 0, then the type routines should |
---|
| 133 | * allocate dynamic storage of the appropriate size and return it. |
---|
| 134 | */ |
---|
| 135 | #ifdef _KERNEL |
---|
| 136 | typedef bool_t (*xdrproc_t)(XDR *, void *, u_int); |
---|
| 137 | #else |
---|
| 138 | /* |
---|
| 139 | * XXX can't actually prototype it, because some take three args!!! |
---|
| 140 | */ |
---|
| 141 | typedef bool_t (*xdrproc_t)(XDR *, ...); |
---|
| 142 | #endif |
---|
| 143 | |
---|
| 144 | /* |
---|
| 145 | * Operations defined on a XDR handle |
---|
| 146 | * |
---|
| 147 | * XDR *xdrs; |
---|
| 148 | * long *longp; |
---|
| 149 | * char * addr; |
---|
| 150 | * u_int len; |
---|
| 151 | * u_int pos; |
---|
| 152 | */ |
---|
| 153 | #define XDR_GETLONG(xdrs, longp) \ |
---|
| 154 | (*(xdrs)->x_ops->x_getlong)(xdrs, longp) |
---|
| 155 | #define xdr_getlong(xdrs, longp) \ |
---|
| 156 | (*(xdrs)->x_ops->x_getlong)(xdrs, longp) |
---|
| 157 | |
---|
| 158 | #define XDR_PUTLONG(xdrs, longp) \ |
---|
| 159 | (*(xdrs)->x_ops->x_putlong)(xdrs, longp) |
---|
| 160 | #define xdr_putlong(xdrs, longp) \ |
---|
| 161 | (*(xdrs)->x_ops->x_putlong)(xdrs, longp) |
---|
| 162 | |
---|
| 163 | static __inline int |
---|
| 164 | xdr_getint32(XDR *xdrs, int32_t *ip) |
---|
| 165 | { |
---|
| 166 | long l; |
---|
| 167 | |
---|
| 168 | if (!xdr_getlong(xdrs, &l)) |
---|
| 169 | return (FALSE); |
---|
| 170 | *ip = (int32_t)l; |
---|
| 171 | return (TRUE); |
---|
| 172 | } |
---|
| 173 | |
---|
| 174 | static __inline int |
---|
| 175 | xdr_putint32(XDR *xdrs, int32_t *ip) |
---|
| 176 | { |
---|
| 177 | long l; |
---|
| 178 | |
---|
| 179 | l = (long)*ip; |
---|
| 180 | return xdr_putlong(xdrs, &l); |
---|
| 181 | } |
---|
| 182 | |
---|
| 183 | #define XDR_GETINT32(xdrs, int32p) xdr_getint32(xdrs, int32p) |
---|
| 184 | #define XDR_PUTINT32(xdrs, int32p) xdr_putint32(xdrs, int32p) |
---|
| 185 | |
---|
| 186 | #define XDR_GETBYTES(xdrs, addr, len) \ |
---|
| 187 | (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len) |
---|
| 188 | #define xdr_getbytes(xdrs, addr, len) \ |
---|
| 189 | (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len) |
---|
| 190 | |
---|
| 191 | #define XDR_PUTBYTES(xdrs, addr, len) \ |
---|
| 192 | (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len) |
---|
| 193 | #define xdr_putbytes(xdrs, addr, len) \ |
---|
| 194 | (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len) |
---|
| 195 | |
---|
| 196 | #define XDR_GETPOS(xdrs) \ |
---|
| 197 | (*(xdrs)->x_ops->x_getpostn)(xdrs) |
---|
| 198 | #define xdr_getpos(xdrs) \ |
---|
| 199 | (*(xdrs)->x_ops->x_getpostn)(xdrs) |
---|
| 200 | |
---|
| 201 | #define XDR_SETPOS(xdrs, pos) \ |
---|
| 202 | (*(xdrs)->x_ops->x_setpostn)(xdrs, pos) |
---|
| 203 | #define xdr_setpos(xdrs, pos) \ |
---|
| 204 | (*(xdrs)->x_ops->x_setpostn)(xdrs, pos) |
---|
| 205 | |
---|
| 206 | #define XDR_INLINE(xdrs, len) \ |
---|
| 207 | (*(xdrs)->x_ops->x_inline)(xdrs, len) |
---|
| 208 | #define xdr_inline(xdrs, len) \ |
---|
| 209 | (*(xdrs)->x_ops->x_inline)(xdrs, len) |
---|
| 210 | |
---|
| 211 | #define XDR_DESTROY(xdrs) \ |
---|
| 212 | if ((xdrs)->x_ops->x_destroy) \ |
---|
| 213 | (*(xdrs)->x_ops->x_destroy)(xdrs) |
---|
| 214 | #define xdr_destroy(xdrs) \ |
---|
| 215 | if ((xdrs)->x_ops->x_destroy) \ |
---|
| 216 | (*(xdrs)->x_ops->x_destroy)(xdrs) |
---|
| 217 | |
---|
| 218 | #define XDR_CONTROL(xdrs, req, op) \ |
---|
| 219 | if ((xdrs)->x_ops->x_control) \ |
---|
| 220 | (*(xdrs)->x_ops->x_control)(xdrs, req, op) |
---|
| 221 | #define xdr_control(xdrs, req, op) XDR_CONTROL(xdrs, req, op) |
---|
| 222 | |
---|
| 223 | /* |
---|
| 224 | * Solaris strips the '_t' from these types -- not sure why. |
---|
| 225 | * But, let's be compatible. |
---|
| 226 | */ |
---|
| 227 | #define xdr_rpcvers(xdrs, versp) xdr_u_int32(xdrs, versp) |
---|
| 228 | #define xdr_rpcprog(xdrs, progp) xdr_u_int32(xdrs, progp) |
---|
| 229 | #define xdr_rpcproc(xdrs, procp) xdr_u_int32(xdrs, procp) |
---|
| 230 | #define xdr_rpcprot(xdrs, protp) xdr_u_int32(xdrs, protp) |
---|
| 231 | #define xdr_rpcport(xdrs, portp) xdr_u_int32(xdrs, portp) |
---|
| 232 | |
---|
| 233 | /* |
---|
| 234 | * Support struct for discriminated unions. |
---|
| 235 | * You create an array of xdrdiscrim structures, terminated with |
---|
| 236 | * a entry with a null procedure pointer. The xdr_union routine gets |
---|
| 237 | * the discriminant value and then searches the array of structures |
---|
| 238 | * for a matching value. If a match is found the associated xdr routine |
---|
| 239 | * is called to handle that part of the union. If there is |
---|
| 240 | * no match, then a default routine may be called. |
---|
| 241 | * If there is no match and no default routine it is an error. |
---|
| 242 | */ |
---|
| 243 | #define NULL_xdrproc_t ((xdrproc_t)0) |
---|
| 244 | struct xdr_discrim { |
---|
| 245 | int value; |
---|
| 246 | xdrproc_t proc; |
---|
| 247 | }; |
---|
| 248 | |
---|
| 249 | /* |
---|
| 250 | * In-line routines for fast encode/decode of primitive data types. |
---|
| 251 | * Caveat emptor: these use single memory cycles to get the |
---|
| 252 | * data from the underlying buffer, and will fail to operate |
---|
| 253 | * properly if the data is not aligned. The standard way to use these |
---|
| 254 | * is to say: |
---|
| 255 | * if ((buf = XDR_INLINE(xdrs, count)) == NULL) |
---|
| 256 | * return (FALSE); |
---|
| 257 | * <<< macro calls >>> |
---|
| 258 | * where ``count'' is the number of bytes of data occupied |
---|
| 259 | * by the primitive data types. |
---|
| 260 | * |
---|
| 261 | * N.B. and frozen for all time: each data type here uses 4 bytes |
---|
| 262 | * of external representation. |
---|
| 263 | */ |
---|
| 264 | #define IXDR_GET_INT32(buf) ((int32_t)__ntohl((u_int32_t)*(buf)++)) |
---|
| 265 | #define IXDR_PUT_INT32(buf, v) (*(buf)++ =(int32_t)__htonl((u_int32_t)v)) |
---|
| 266 | #define IXDR_GET_U_INT32(buf) ((u_int32_t)IXDR_GET_INT32(buf)) |
---|
| 267 | #define IXDR_PUT_U_INT32(buf, v) IXDR_PUT_INT32((buf), ((int32_t)(v))) |
---|
| 268 | |
---|
| 269 | #define IXDR_GET_LONG(buf) ((long)__ntohl((u_int32_t)*(buf)++)) |
---|
| 270 | #define IXDR_PUT_LONG(buf, v) (*(buf)++ =(int32_t)__htonl((u_int32_t)v)) |
---|
| 271 | |
---|
| 272 | #define IXDR_GET_BOOL(buf) ((bool_t)IXDR_GET_LONG(buf)) |
---|
| 273 | #define IXDR_GET_ENUM(buf, t) ((t)IXDR_GET_LONG(buf)) |
---|
| 274 | #define IXDR_GET_U_LONG(buf) ((u_long)IXDR_GET_LONG(buf)) |
---|
| 275 | #define IXDR_GET_SHORT(buf) ((short)IXDR_GET_LONG(buf)) |
---|
| 276 | #define IXDR_GET_U_SHORT(buf) ((u_short)IXDR_GET_LONG(buf)) |
---|
| 277 | |
---|
| 278 | #define IXDR_PUT_BOOL(buf, v) IXDR_PUT_LONG((buf), (v)) |
---|
| 279 | #define IXDR_PUT_ENUM(buf, v) IXDR_PUT_LONG((buf), (v)) |
---|
| 280 | #define IXDR_PUT_U_LONG(buf, v) IXDR_PUT_LONG((buf), (v)) |
---|
| 281 | #define IXDR_PUT_SHORT(buf, v) IXDR_PUT_LONG((buf), (v)) |
---|
| 282 | #define IXDR_PUT_U_SHORT(buf, v) IXDR_PUT_LONG((buf), (v)) |
---|
| 283 | |
---|
| 284 | /* |
---|
| 285 | * These are the "generic" xdr routines. |
---|
| 286 | */ |
---|
| 287 | __BEGIN_DECLS |
---|
| 288 | extern bool_t xdr_void(void); |
---|
| 289 | extern bool_t xdr_int(XDR *, int *); |
---|
| 290 | extern bool_t xdr_u_int(XDR *, u_int *); |
---|
| 291 | extern bool_t xdr_long(XDR *, long *); |
---|
| 292 | extern bool_t xdr_u_long(XDR *, u_long *); |
---|
| 293 | extern bool_t xdr_short(XDR *, short *); |
---|
| 294 | extern bool_t xdr_u_short(XDR *, u_short *); |
---|
| 295 | extern bool_t xdr_int16_t(XDR *, int16_t *); |
---|
| 296 | extern bool_t xdr_u_int16_t(XDR *, u_int16_t *); |
---|
| 297 | extern bool_t xdr_int32_t(XDR *, int32_t *); |
---|
| 298 | extern bool_t xdr_u_int32_t(XDR *, u_int32_t *); |
---|
| 299 | extern bool_t xdr_int64_t(XDR *, int64_t *); |
---|
| 300 | extern bool_t xdr_u_int64_t(XDR *, u_int64_t *); |
---|
| 301 | extern bool_t xdr_bool(XDR *, bool_t *); |
---|
| 302 | extern bool_t xdr_enum(XDR *, enum_t *); |
---|
| 303 | extern bool_t xdr_array(XDR *, char **, u_int *, u_int, u_int, xdrproc_t); |
---|
| 304 | extern bool_t xdr_bytes(XDR *, char **, u_int *, u_int); |
---|
| 305 | extern bool_t xdr_opaque(XDR *, char *, u_int); |
---|
| 306 | extern bool_t xdr_string(XDR *, char **, u_int); |
---|
| 307 | extern bool_t xdr_union(XDR *, enum_t *, char *, const struct xdr_discrim *, xdrproc_t); |
---|
| 308 | extern bool_t xdr_char(XDR *, char *); |
---|
| 309 | extern bool_t xdr_u_char(XDR *, u_char *); |
---|
| 310 | extern bool_t xdr_vector(XDR *, char *, u_int, u_int, xdrproc_t); |
---|
| 311 | extern bool_t xdr_float(XDR *, float *); |
---|
| 312 | extern bool_t xdr_double(XDR *, double *); |
---|
| 313 | extern bool_t xdr_quadruple(XDR *, long double *); |
---|
| 314 | extern bool_t xdr_reference(XDR *, char **, u_int, xdrproc_t); |
---|
| 315 | extern bool_t xdr_pointer(XDR *, char **, u_int, xdrproc_t); |
---|
| 316 | extern bool_t xdr_wrapstring(XDR *, char **); |
---|
| 317 | extern void xdr_free(xdrproc_t, void *); |
---|
| 318 | extern bool_t xdr_hyper(XDR *, long long *); |
---|
| 319 | extern bool_t xdr_u_hyper(XDR *, unsigned long long *); |
---|
| 320 | extern bool_t xdr_longlong_t(XDR *, long long *); |
---|
| 321 | extern bool_t xdr_u_longlong_t(XDR *, unsigned long long *); |
---|
| 322 | __END_DECLS |
---|
| 323 | |
---|
| 324 | /* |
---|
| 325 | * Common opaque bytes objects used by many rpc protocols; |
---|
| 326 | * declared here due to commonality. |
---|
| 327 | */ |
---|
| 328 | #define MAX_NETOBJ_SZ 1024 |
---|
| 329 | struct netobj { |
---|
| 330 | u_int n_len; |
---|
| 331 | char *n_bytes; |
---|
| 332 | }; |
---|
| 333 | typedef struct netobj netobj; |
---|
| 334 | extern bool_t xdr_netobj(XDR *, struct netobj *); |
---|
| 335 | |
---|
| 336 | /* |
---|
| 337 | * These are the public routines for the various implementations of |
---|
| 338 | * xdr streams. |
---|
| 339 | */ |
---|
| 340 | __BEGIN_DECLS |
---|
| 341 | /* XDR using memory buffers */ |
---|
| 342 | extern void xdrmem_create(XDR *, char *, u_int, enum xdr_op); |
---|
| 343 | |
---|
| 344 | /* XDR using stdio library */ |
---|
| 345 | #ifdef _STDIO_H_ |
---|
| 346 | extern void xdrstdio_create(XDR *, FILE *, enum xdr_op); |
---|
| 347 | #endif |
---|
| 348 | |
---|
| 349 | /* XDR pseudo records for tcp */ |
---|
| 350 | extern void xdrrec_create(XDR *, u_int, u_int, void *, |
---|
| 351 | int (*)(void *, void *, int), |
---|
| 352 | int (*)(void *, void *, int)); |
---|
| 353 | |
---|
| 354 | /* make end of xdr record */ |
---|
| 355 | extern bool_t xdrrec_endofrecord(XDR *, int); |
---|
| 356 | |
---|
| 357 | /* move to beginning of next record */ |
---|
| 358 | extern bool_t xdrrec_skiprecord(XDR *); |
---|
| 359 | |
---|
| 360 | /* true if no more input */ |
---|
| 361 | extern bool_t xdrrec_eof(XDR *); |
---|
| 362 | extern u_int xdrrec_readbytes(XDR *, caddr_t, u_int); |
---|
| 363 | __END_DECLS |
---|
| 364 | |
---|
| 365 | #endif /* !_RPC_XDR_H */ |
---|