Home | History | Annotate | Line # | Download | only in rpc
      1 /*	$NetBSD: xdr_stdio.c,v 1.20 2025/12/16 12:39:02 nia Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 2010, Oracle America, Inc.
      5  *
      6  * Redistribution and use in source and binary forms, with or without
      7  * modification, are permitted provided that the following conditions are
      8  * met:
      9  *
     10  *     * Redistributions of source code must retain the above copyright
     11  *       notice, this list of conditions and the following disclaimer.
     12  *     * Redistributions in binary form must reproduce the above
     13  *       copyright notice, this list of conditions and the following
     14  *       disclaimer in the documentation and/or other materials
     15  *       provided with the distribution.
     16  *     * Neither the name of the "Oracle America, 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
     21  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     22  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
     23  *   FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
     24  *   COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
     25  *   INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     26  *   DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
     27  *   GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     28  *   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
     29  *   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
     30  *   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     32  */
     33 
     34 #include <sys/cdefs.h>
     35 #if defined(LIBC_SCCS) && !defined(lint)
     36 #if 0
     37 static char *sccsid = "@(#)xdr_stdio.c 1.16 87/08/11 Copyr 1984 Sun Micro";
     38 static char *sccsid = "@(#)xdr_stdio.c	2.1 88/07/29 4.0 RPCSRC";
     39 #else
     40 __RCSID("$NetBSD: xdr_stdio.c,v 1.20 2025/12/16 12:39:02 nia Exp $");
     41 #endif
     42 #endif
     43 
     44 /*
     45  * xdr_stdio.c, XDR implementation on standard i/o file.
     46  *
     47  * Copyright (C) 1984, Sun Microsystems, Inc.
     48  *
     49  * This set of routines implements a XDR on a stdio stream.
     50  * XDR_ENCODE serializes onto the stream, XDR_DECODE de-serializes
     51  * from the stream.
     52  */
     53 
     54 #include "namespace.h"
     55 
     56 #include <sys/endian.h>
     57 #include <stdio.h>
     58 
     59 #include <rpc/types.h>
     60 #include <rpc/xdr.h>
     61 
     62 #ifdef __weak_alias
     63 __weak_alias(xdrstdio_create,_xdrstdio_create)
     64 #endif
     65 
     66 static void xdrstdio_destroy(XDR *);
     67 static bool_t xdrstdio_getlong(XDR *, long *);
     68 static bool_t xdrstdio_putlong(XDR *, const long *);
     69 static bool_t xdrstdio_getbytes(XDR *, char *, u_int);
     70 static bool_t xdrstdio_putbytes(XDR *, const char *, u_int);
     71 static u_int xdrstdio_getpos(XDR *);
     72 static bool_t xdrstdio_setpos(XDR *, u_int);
     73 static int32_t *xdrstdio_inline(XDR *, u_int);
     74 
     75 /*
     76  * Ops vector for stdio type XDR
     77  */
     78 static const struct xdr_ops	xdrstdio_ops = {
     79 	xdrstdio_getlong,	/* deseraialize a long int */
     80 	xdrstdio_putlong,	/* seraialize a long int */
     81 	xdrstdio_getbytes,	/* deserialize counted bytes */
     82 	xdrstdio_putbytes,	/* serialize counted bytes */
     83 	xdrstdio_getpos,	/* get offset in the stream */
     84 	xdrstdio_setpos,	/* set offset in the stream */
     85 	xdrstdio_inline,	/* prime stream for inline macros */
     86 	xdrstdio_destroy,	/* destroy stream */
     87 	NULL,			/* xdrstdio_control */
     88 };
     89 
     90 /*
     91  * Initialize a stdio xdr stream.
     92  * Sets the xdr stream handle xdrs for use on the stream file.
     93  * Operation flag is set to op.
     94  */
     95 void
     96 xdrstdio_create(XDR *xdrs, FILE *file, enum xdr_op op)
     97 {
     98 
     99 	xdrs->x_op = op;
    100 	xdrs->x_ops = &xdrstdio_ops;
    101 	xdrs->x_private = file;
    102 	xdrs->x_handy = 0;
    103 	xdrs->x_base = 0;
    104 }
    105 
    106 /*
    107  * Destroy a stdio xdr stream.
    108  * Cleans up the xdr stream handle xdrs previously set up by xdrstdio_create.
    109  */
    110 static void
    111 xdrstdio_destroy(XDR *xdrs)
    112 {
    113 	(void)fflush((FILE *)xdrs->x_private);
    114 		/* XXX: should we close the file ?? */
    115 }
    116 
    117 static bool_t
    118 xdrstdio_getlong(XDR *xdrs, long *lp)
    119 {
    120 	u_int32_t temp;
    121 
    122 	if (fread(&temp, sizeof(int32_t), 1, (FILE *)xdrs->x_private) != 1)
    123 		return (FALSE);
    124 	*lp = (long)ntohl(temp);
    125 	return (TRUE);
    126 }
    127 
    128 static bool_t
    129 xdrstdio_putlong(XDR *xdrs, const long *lp)
    130 {
    131 	int32_t mycopy = htonl((u_int32_t)*lp);
    132 
    133 	if (fwrite(&mycopy, sizeof(int32_t), 1, (FILE *)xdrs->x_private) != 1)
    134 		return (FALSE);
    135 	return (TRUE);
    136 }
    137 
    138 static bool_t
    139 xdrstdio_getbytes(XDR *xdrs, char *addr, u_int len)
    140 {
    141 
    142 	if ((len != 0) && (fread(addr, (size_t)len, 1, (FILE *)xdrs->x_private) != 1))
    143 		return (FALSE);
    144 	return (TRUE);
    145 }
    146 
    147 static bool_t
    148 xdrstdio_putbytes(XDR *xdrs, const char *addr, u_int len)
    149 {
    150 
    151 	if ((len != 0) && (fwrite(addr, (size_t)len, 1,
    152 	    (FILE *)xdrs->x_private) != 1))
    153 		return (FALSE);
    154 	return (TRUE);
    155 }
    156 
    157 static u_int
    158 xdrstdio_getpos(XDR *xdrs)
    159 {
    160 
    161 	return ((u_int) ftell((FILE *)xdrs->x_private));
    162 }
    163 
    164 static bool_t
    165 xdrstdio_setpos(XDR *xdrs, u_int pos)
    166 {
    167 
    168 	return ((fseek((FILE *)xdrs->x_private, (long)pos, 0) < 0) ?
    169 		FALSE : TRUE);
    170 }
    171 
    172 /* ARGSUSED */
    173 static int32_t *
    174 xdrstdio_inline(XDR *xdrs, u_int len)
    175 {
    176 
    177 	/*
    178 	 * Must do some work to implement this: must insure
    179 	 * enough data in the underlying stdio buffer,
    180 	 * that the buffer is aligned so that we can indirect through a
    181 	 * long *, and stuff this pointer in xdrs->x_buf.  Doing
    182 	 * a fread or fwrite to a scratch buffer would defeat
    183 	 * most of the gains to be had here and require storage
    184 	 * management on this buffer, so we don't do this.
    185 	 */
    186 	return (NULL);
    187 }
    188