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