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