The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/rpc/xdr.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

    1 /*      $NetBSD: xdr.h,v 1.19 2000/07/17 05:00:45 matt Exp $    */
    2 
    3 /*-
    4  * SPDX-License-Identifier: BSD-3-Clause
    5  *
    6  * Copyright (c) 2009, Sun Microsystems, Inc.
    7  * All rights reserved.
    8  *
    9  * Redistribution and use in source and binary forms, with or without 
   10  * modification, are permitted provided that the following conditions are met:
   11  * - Redistributions of source code must retain the above copyright notice, 
   12  *   this list of conditions and the following disclaimer.
   13  * - Redistributions in binary form must reproduce the above copyright notice, 
   14  *   this list of conditions and the following disclaimer in the documentation 
   15  *   and/or other materials provided with the distribution.
   16  * - Neither the name of Sun Microsystems, Inc. nor the names of its 
   17  *   contributors may be used to endorse or promote products derived 
   18  *   from this software without specific prior written permission.
   19  * 
   20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
   21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
   22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
   23  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 
   24  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
   25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
   26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
   27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
   28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
   29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
   30  * POSSIBILITY OF SUCH DAMAGE.
   31  *
   32  *      from: @(#)xdr.h 1.19 87/04/22 SMI
   33  *      from: @(#)xdr.h 2.2 88/07/29 4.0 RPCSRC
   34  * $FreeBSD: releng/12.0/sys/rpc/xdr.h 326023 2017-11-20 19:43:44Z pfg $
   35  */
   36 
   37 /*
   38  * xdr.h, External Data Representation Serialization Routines.
   39  *
   40  * Copyright (C) 1984, Sun Microsystems, Inc.
   41  */
   42 
   43 #ifndef _KRPC_XDR_H
   44 #define _KRPC_XDR_H
   45 #include <sys/cdefs.h>
   46 
   47 /*
   48  * XDR provides a conventional way for converting between C data
   49  * types and an external bit-string representation.  Library supplied
   50  * routines provide for the conversion on built-in C data types.  These
   51  * routines and utility routines defined here are used to help implement
   52  * a type encode/decode routine for each user-defined type.
   53  *
   54  * Each data type provides a single procedure which takes two arguments:
   55  *
   56  *      bool_t
   57  *      xdrproc(xdrs, argresp)
   58  *              XDR *xdrs;
   59  *              <type> *argresp;
   60  *
   61  * xdrs is an instance of a XDR handle, to which or from which the data
   62  * type is to be converted.  argresp is a pointer to the structure to be
   63  * converted.  The XDR handle contains an operation field which indicates
   64  * which of the operations (ENCODE, DECODE * or FREE) is to be performed.
   65  *
   66  * XDR_DECODE may allocate space if the pointer argresp is null.  This
   67  * data can be freed with the XDR_FREE operation.
   68  *
   69  * We write only one procedure per data type to make it easy
   70  * to keep the encode and decode procedures for a data type consistent.
   71  * In many cases the same code performs all operations on a user defined type,
   72  * because all the hard work is done in the component type routines.
   73  * decode as a series of calls on the nested data types.
   74  */
   75 
   76 /*
   77  * Xdr operations.  XDR_ENCODE causes the type to be encoded into the
   78  * stream.  XDR_DECODE causes the type to be extracted from the stream.
   79  * XDR_FREE can be used to release the space allocated by an XDR_DECODE
   80  * request.
   81  */
   82 enum xdr_op {
   83         XDR_ENCODE=0,
   84         XDR_DECODE=1,
   85         XDR_FREE=2
   86 };
   87 
   88 /*
   89  * This is the number of bytes per unit of external data.
   90  */
   91 #define BYTES_PER_XDR_UNIT      (4)
   92 #define RNDUP(x)  ((((x) + BYTES_PER_XDR_UNIT - 1) / BYTES_PER_XDR_UNIT) \
   93                     * BYTES_PER_XDR_UNIT)
   94 
   95 /*
   96  * The XDR handle.
   97  * Contains operation which is being applied to the stream,
   98  * an operations vector for the particular implementation (e.g. see xdr_mem.c),
   99  * and two private fields for the use of the particular implementation.
  100  */
  101 typedef struct XDR {
  102         enum xdr_op     x_op;           /* operation; fast additional param */
  103         const struct xdr_ops {
  104                 /* get a long from underlying stream */
  105                 bool_t  (*x_getlong)(struct XDR *, long *);
  106                 /* put a long to " */
  107                 bool_t  (*x_putlong)(struct XDR *, const long *);
  108                 /* get some bytes from " */
  109                 bool_t  (*x_getbytes)(struct XDR *, char *, u_int);
  110                 /* put some bytes to " */
  111                 bool_t  (*x_putbytes)(struct XDR *, const char *, u_int);
  112                 /* returns bytes off from beginning */
  113                 u_int   (*x_getpostn)(struct XDR *);
  114                 /* lets you reposition the stream */
  115                 bool_t  (*x_setpostn)(struct XDR *, u_int);
  116                 /* buf quick ptr to buffered data */
  117                 int32_t *(*x_inline)(struct XDR *, u_int);
  118                 /* free privates of this xdr_stream */
  119                 void    (*x_destroy)(struct XDR *);
  120                 bool_t  (*x_control)(struct XDR *, int, void *);
  121         } *x_ops;
  122         char *          x_public;       /* users' data */
  123         void *          x_private;      /* pointer to private data */
  124         char *          x_base;         /* private used for position info */
  125         u_int           x_handy;        /* extra private word */
  126 } XDR;
  127 
  128 /*
  129  * A xdrproc_t exists for each data type which is to be encoded or decoded.
  130  *
  131  * The second argument to the xdrproc_t is a pointer to an opaque pointer.
  132  * The opaque pointer generally points to a structure of the data type
  133  * to be decoded.  If this pointer is 0, then the type routines should
  134  * allocate dynamic storage of the appropriate size and return it.
  135  */
  136 #ifdef _KERNEL
  137 typedef bool_t (*xdrproc_t)(XDR *, void *, ...);
  138 #else
  139 /*
  140  * XXX can't actually prototype it, because some take three args!!!
  141  */
  142 typedef bool_t (*xdrproc_t)(XDR *, ...);
  143 #endif
  144 
  145 /*
  146  * Operations defined on a XDR handle
  147  *
  148  * XDR          *xdrs;
  149  * long         *longp;
  150  * char *        addr;
  151  * u_int         len;
  152  * u_int         pos;
  153  */
  154 #define XDR_GETLONG(xdrs, longp)                        \
  155         (*(xdrs)->x_ops->x_getlong)(xdrs, longp)
  156 #define xdr_getlong(xdrs, longp)                        \
  157         (*(xdrs)->x_ops->x_getlong)(xdrs, longp)
  158 
  159 #define XDR_PUTLONG(xdrs, longp)                        \
  160         (*(xdrs)->x_ops->x_putlong)(xdrs, longp)
  161 #define xdr_putlong(xdrs, longp)                        \
  162         (*(xdrs)->x_ops->x_putlong)(xdrs, longp)
  163 
  164 static __inline int
  165 xdr_getint32(XDR *xdrs, int32_t *ip)
  166 {
  167         long l;
  168 
  169         if (!xdr_getlong(xdrs, &l))
  170                 return (FALSE);
  171         *ip = (int32_t)l;
  172         return (TRUE);
  173 }
  174 
  175 static __inline int
  176 xdr_putint32(XDR *xdrs, int32_t *ip)
  177 {
  178         long l;
  179 
  180         l = (long)*ip;
  181         return xdr_putlong(xdrs, &l);
  182 }
  183 
  184 #define XDR_GETINT32(xdrs, int32p)      xdr_getint32(xdrs, int32p)
  185 #define XDR_PUTINT32(xdrs, int32p)      xdr_putint32(xdrs, int32p)
  186 
  187 #define XDR_GETBYTES(xdrs, addr, len)                   \
  188         (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
  189 #define xdr_getbytes(xdrs, addr, len)                   \
  190         (*(xdrs)->x_ops->x_getbytes)(xdrs, addr, len)
  191 
  192 #define XDR_PUTBYTES(xdrs, addr, len)                   \
  193         (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
  194 #define xdr_putbytes(xdrs, addr, len)                   \
  195         (*(xdrs)->x_ops->x_putbytes)(xdrs, addr, len)
  196 
  197 #define XDR_GETPOS(xdrs)                                \
  198         (*(xdrs)->x_ops->x_getpostn)(xdrs)
  199 #define xdr_getpos(xdrs)                                \
  200         (*(xdrs)->x_ops->x_getpostn)(xdrs)
  201 
  202 #define XDR_SETPOS(xdrs, pos)                           \
  203         (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
  204 #define xdr_setpos(xdrs, pos)                           \
  205         (*(xdrs)->x_ops->x_setpostn)(xdrs, pos)
  206 
  207 #define XDR_INLINE(xdrs, len)                           \
  208         (*(xdrs)->x_ops->x_inline)(xdrs, len)
  209 #define xdr_inline(xdrs, len)                           \
  210         (*(xdrs)->x_ops->x_inline)(xdrs, len)
  211 
  212 #define XDR_DESTROY(xdrs)                               \
  213         if ((xdrs)->x_ops->x_destroy)                   \
  214                 (*(xdrs)->x_ops->x_destroy)(xdrs)
  215 #define xdr_destroy(xdrs)                               \
  216         if ((xdrs)->x_ops->x_destroy)                   \
  217                 (*(xdrs)->x_ops->x_destroy)(xdrs)
  218 
  219 #define XDR_CONTROL(xdrs, req, op)                      \
  220         (((xdrs)->x_ops->x_control == NULL) ? (FALSE) : \
  221                 (*(xdrs)->x_ops->x_control)(xdrs, req, op))
  222 #define xdr_control(xdrs, req, op) XDR_CONTROL(xdrs, req, op)
  223 
  224 /*
  225  * Solaris strips the '_t' from these types -- not sure why.
  226  * But, let's be compatible.
  227  */
  228 #define xdr_rpcvers(xdrs, versp) xdr_uint32_t(xdrs, versp)
  229 #define xdr_rpcprog(xdrs, progp) xdr_uint32_t(xdrs, progp)
  230 #define xdr_rpcproc(xdrs, procp) xdr_uint32_t(xdrs, procp)
  231 #define xdr_rpcprot(xdrs, protp) xdr_uint32_t(xdrs, protp)
  232 #define xdr_rpcport(xdrs, portp) xdr_uint32_t(xdrs, portp)
  233 
  234 /*
  235  * Support struct for discriminated unions.
  236  * You create an array of xdrdiscrim structures, terminated with
  237  * an entry with a null procedure pointer.  The xdr_union routine gets
  238  * the discriminant value and then searches the array of structures
  239  * for a matching value.  If a match is found the associated xdr routine
  240  * is called to handle that part of the union.  If there is
  241  * no match, then a default routine may be called.
  242  * If there is no match and no default routine it is an error.
  243  */
  244 #define NULL_xdrproc_t ((xdrproc_t)0)
  245 struct xdr_discrim {
  246         int     value;
  247         xdrproc_t proc;
  248 };
  249 
  250 /*
  251  * In-line routines for fast encode/decode of primitive data types.
  252  * Caveat emptor: these use single memory cycles to get the
  253  * data from the underlying buffer, and will fail to operate
  254  * properly if the data is not aligned.  The standard way to use these
  255  * is to say:
  256  *      if ((buf = XDR_INLINE(xdrs, count)) == NULL)
  257  *              return (FALSE);
  258  *      <<< macro calls >>>
  259  * where ``count'' is the number of bytes of data occupied
  260  * by the primitive data types.
  261  *
  262  * N.B. and frozen for all time: each data type here uses 4 bytes
  263  * of external representation.
  264  */
  265 #define IXDR_GET_INT32(buf)             ((int32_t)__ntohl((uint32_t)*(buf)++))
  266 #define IXDR_PUT_INT32(buf, v)          (*(buf)++ =(int32_t)__htonl((uint32_t)v))
  267 #define IXDR_GET_U_INT32(buf)           ((uint32_t)IXDR_GET_INT32(buf))
  268 #define IXDR_PUT_U_INT32(buf, v)        IXDR_PUT_INT32((buf), ((int32_t)(v)))
  269 
  270 #define IXDR_GET_UINT32(buf)            ((uint32_t)IXDR_GET_INT32(buf))
  271 #define IXDR_PUT_UINT32(buf, v)         IXDR_PUT_INT32((buf), ((int32_t)(v)))
  272 
  273 #define IXDR_GET_LONG(buf)              ((long)__ntohl((uint32_t)*(buf)++))
  274 #define IXDR_PUT_LONG(buf, v)           (*(buf)++ =(int32_t)__htonl((uint32_t)v))
  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_U_LONG(buf)            ((u_long)IXDR_GET_LONG(buf))
  279 #define IXDR_GET_SHORT(buf)             ((short)IXDR_GET_LONG(buf))
  280 #define IXDR_GET_U_SHORT(buf)           ((u_short)IXDR_GET_LONG(buf))
  281 
  282 #define IXDR_PUT_BOOL(buf, v)           IXDR_PUT_LONG((buf), (v))
  283 #define IXDR_PUT_ENUM(buf, v)           IXDR_PUT_LONG((buf), (v))
  284 #define IXDR_PUT_U_LONG(buf, v)         IXDR_PUT_LONG((buf), (v))
  285 #define IXDR_PUT_SHORT(buf, v)          IXDR_PUT_LONG((buf), (v))
  286 #define IXDR_PUT_U_SHORT(buf, v)        IXDR_PUT_LONG((buf), (v))
  287 
  288 /*
  289  * These are the "generic" xdr routines.
  290  */
  291 __BEGIN_DECLS
  292 extern bool_t   xdr_void(void);
  293 extern bool_t   xdr_int(XDR *, int *);
  294 extern bool_t   xdr_u_int(XDR *, u_int *);
  295 extern bool_t   xdr_long(XDR *, long *);
  296 extern bool_t   xdr_u_long(XDR *, u_long *);
  297 extern bool_t   xdr_short(XDR *, short *);
  298 extern bool_t   xdr_u_short(XDR *, u_short *);
  299 extern bool_t   xdr_int16_t(XDR *, int16_t *);
  300 extern bool_t   xdr_uint16_t(XDR *, uint16_t *);
  301 extern bool_t   xdr_int32_t(XDR *, int32_t *);
  302 extern bool_t   xdr_uint32_t(XDR *, uint32_t *);
  303 extern bool_t   xdr_int64_t(XDR *, int64_t *);
  304 extern bool_t   xdr_uint64_t(XDR *, uint64_t *);
  305 extern bool_t   xdr_bool(XDR *, bool_t *);
  306 extern bool_t   xdr_enum(XDR *, enum_t *);
  307 extern bool_t   xdr_array(XDR *, char **, u_int *, u_int, u_int, xdrproc_t);
  308 extern bool_t   xdr_bytes(XDR *, char **, u_int *, u_int);
  309 extern bool_t   xdr_opaque(XDR *, char *, u_int);
  310 extern bool_t   xdr_string(XDR *, char **, u_int);
  311 extern bool_t   xdr_union(XDR *, enum_t *, char *, const struct xdr_discrim *, xdrproc_t);
  312 extern bool_t   xdr_char(XDR *, char *);
  313 extern bool_t   xdr_u_char(XDR *, u_char *);
  314 extern bool_t   xdr_vector(XDR *, char *, u_int, u_int, xdrproc_t);
  315 extern bool_t   xdr_float(XDR *, float *);
  316 extern bool_t   xdr_double(XDR *, double *);
  317 extern bool_t   xdr_quadruple(XDR *, long double *);
  318 extern bool_t   xdr_reference(XDR *, char **, u_int, xdrproc_t);
  319 extern bool_t   xdr_pointer(XDR *, char **, u_int, xdrproc_t);
  320 extern bool_t   xdr_wrapstring(XDR *, char **);
  321 extern void     xdr_free(xdrproc_t, void *);
  322 extern bool_t   xdr_hyper(XDR *, quad_t *);
  323 extern bool_t   xdr_u_hyper(XDR *, u_quad_t *);
  324 extern bool_t   xdr_longlong_t(XDR *, quad_t *);
  325 extern bool_t   xdr_u_longlong_t(XDR *, u_quad_t *);
  326 extern unsigned long xdr_sizeof(xdrproc_t func, void *data);
  327 __END_DECLS
  328 
  329 /*
  330  * Common opaque bytes objects used by many rpc protocols;
  331  * declared here due to commonality.
  332  */
  333 #define MAX_NETOBJ_SZ 1024
  334 struct netobj {
  335         u_int   n_len;
  336         char    *n_bytes;
  337 };
  338 typedef struct netobj netobj;
  339 extern bool_t   xdr_netobj(XDR *, struct netobj *);
  340 
  341 /*
  342  * These are XDR control operators
  343  */
  344 
  345 #define XDR_GET_BYTES_AVAIL     1
  346 #define XDR_PEEK                2
  347 #define XDR_SKIPBYTES           3
  348 
  349 struct xdr_bytesrec {
  350         bool_t xc_is_last_record;
  351         size_t xc_num_avail;
  352 };
  353 
  354 typedef struct xdr_bytesrec xdr_bytesrec;
  355 
  356 
  357 /*
  358  * These are the public routines for the various implementations of
  359  * xdr streams.
  360  */
  361 __BEGIN_DECLS
  362 /* XDR using memory buffers */
  363 extern void   xdrmem_create(XDR *, char *, u_int, enum xdr_op);
  364 
  365 /* XDR using mbufs */
  366 struct mbuf;
  367 extern void   xdrmbuf_create(XDR *, struct mbuf *, enum xdr_op);
  368 extern void   xdrmbuf_append(XDR *, struct mbuf *);
  369 extern struct mbuf * xdrmbuf_getall(XDR *);
  370 
  371 /* XDR pseudo records for tcp */
  372 extern void   xdrrec_create(XDR *, u_int, u_int, void *,
  373                             int (*)(void *, void *, int),
  374                             int (*)(void *, void *, int));
  375 
  376 /* make end of xdr record */
  377 extern bool_t xdrrec_endofrecord(XDR *, int);
  378 
  379 /* move to beginning of next record */
  380 extern bool_t xdrrec_skiprecord(XDR *);
  381 
  382 /* true if no more input */
  383 extern bool_t xdrrec_eof(XDR *);
  384 extern u_int xdrrec_readbytes(XDR *, caddr_t, u_int);
  385 __END_DECLS
  386 
  387 #endif /* !_KRPC_XDR_H */

Cache object: fa1c8ada0afc262aefcd897f2f4b5a63


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.