xref: /freebsd/lib/libc/xdr/xdr_stdio.c (revision d0b2dbfa)
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 /*
42  * xdr_stdio.c, XDR implementation on standard i/o file.
43  *
44  * This set of routines implements a XDR on a stdio stream.
45  * XDR_ENCODE serializes onto the stream, XDR_DECODE de-serializes
46  * from the stream.
47  */
48 
49 #include "namespace.h"
50 #include <stdio.h>
51 
52 #include <arpa/inet.h>
53 #include <rpc/types.h>
54 #include <rpc/xdr.h>
55 #include "un-namespace.h"
56 
57 static void xdrstdio_destroy(XDR *);
58 static bool_t xdrstdio_getlong(XDR *, long *);
59 static bool_t xdrstdio_putlong(XDR *, const long *);
60 static bool_t xdrstdio_getbytes(XDR *, char *, u_int);
61 static bool_t xdrstdio_putbytes(XDR *, const char *, u_int);
62 static u_int xdrstdio_getpos(XDR *);
63 static bool_t xdrstdio_setpos(XDR *, u_int);
64 static int32_t *xdrstdio_inline(XDR *, u_int);
65 
66 /*
67  * Ops vector for stdio type XDR
68  */
69 static const struct xdr_ops	xdrstdio_ops = {
70 	xdrstdio_getlong,	/* deseraialize a long int */
71 	xdrstdio_putlong,	/* seraialize a long int */
72 	xdrstdio_getbytes,	/* deserialize counted bytes */
73 	xdrstdio_putbytes,	/* serialize counted bytes */
74 	xdrstdio_getpos,	/* get offset in the stream */
75 	xdrstdio_setpos,	/* set offset in the stream */
76 	xdrstdio_inline,	/* prime stream for inline macros */
77 	xdrstdio_destroy	/* destroy stream */
78 };
79 
80 /*
81  * Initialize a stdio xdr stream.
82  * Sets the xdr stream handle xdrs for use on the stream file.
83  * Operation flag is set to op.
84  */
85 void
86 xdrstdio_create(XDR *xdrs, FILE *file, enum xdr_op op)
87 {
88 
89 	xdrs->x_op = op;
90 	xdrs->x_ops = &xdrstdio_ops;
91 	xdrs->x_private = file;
92 	xdrs->x_handy = 0;
93 	xdrs->x_base = 0;
94 }
95 
96 /*
97  * Destroy a stdio xdr stream.
98  * Cleans up the xdr stream handle xdrs previously set up by xdrstdio_create.
99  */
100 static void
101 xdrstdio_destroy(XDR *xdrs)
102 {
103 	(void)fflush((FILE *)xdrs->x_private);
104 		/* XXX: should we close the file ?? */
105 }
106 
107 static bool_t
108 xdrstdio_getlong(XDR *xdrs, long *lp)
109 {
110 	u_int32_t temp;
111 
112 	if (fread(&temp, sizeof(int32_t), 1, (FILE *)xdrs->x_private) != 1)
113 		return (FALSE);
114 	*lp = (long)ntohl(temp);
115 	return (TRUE);
116 }
117 
118 static bool_t
119 xdrstdio_putlong(XDR *xdrs, const long *lp)
120 {
121 	int32_t mycopy = htonl((u_int32_t)*lp);
122 
123 	if (fwrite(&mycopy, sizeof(int32_t), 1, (FILE *)xdrs->x_private) != 1)
124 		return (FALSE);
125 	return (TRUE);
126 }
127 
128 static bool_t
129 xdrstdio_getbytes(XDR *xdrs, char *addr, u_int len)
130 {
131 
132 	if ((len != 0) && (fread(addr, (size_t)len, 1, (FILE *)xdrs->x_private) != 1))
133 		return (FALSE);
134 	return (TRUE);
135 }
136 
137 static bool_t
138 xdrstdio_putbytes(XDR *xdrs, const char *addr, u_int len)
139 {
140 
141 	if ((len != 0) && (fwrite(addr, (size_t)len, 1,
142 	    (FILE *)xdrs->x_private) != 1))
143 		return (FALSE);
144 	return (TRUE);
145 }
146 
147 static u_int
148 xdrstdio_getpos(XDR *xdrs)
149 {
150 
151 	return ((u_int) ftell((FILE *)xdrs->x_private));
152 }
153 
154 static bool_t
155 xdrstdio_setpos(XDR *xdrs, u_int pos)
156 {
157 
158 	return ((fseek((FILE *)xdrs->x_private, (long)pos, 0) < 0) ?
159 		FALSE : TRUE);
160 }
161 
162 /* ARGSUSED */
163 static int32_t *
164 xdrstdio_inline(XDR *xdrs, u_int len)
165 {
166 
167 	/*
168 	 * Must do some work to implement this: must insure
169 	 * enough data in the underlying stdio buffer,
170 	 * that the buffer is aligned so that we can indirect through a
171 	 * long *, and stuff this pointer in xdrs->x_buf.  Doing
172 	 * a fread or fwrite to a scratch buffer would defeat
173 	 * most of the gains to be had here and require storage
174 	 * management on this buffer, so we don't do this.
175 	 */
176 	return (NULL);
177 }
178