Move .Pp outside of .Bl
[dragonfly.git] / lib / libc / xdr / xdr_stdio.c
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  * @(#)xdr_stdio.c 1.16 87/08/11 Copyr 1984 Sun Micro
30  * @(#)xdr_stdio.c      2.1 88/07/29 4.0 RPCSRC
31  * $FreeBSD: src/lib/libc/xdr/xdr_stdio.c,v 1.7 1999/08/28 00:02:56 peter Exp $
32  * $DragonFly: src/lib/libc/xdr/xdr_stdio.c,v 1.4 2005/12/05 00:47:57 swildner Exp $
33  */
34
35 /*
36  * xdr_stdio.c, XDR implementation on standard i/o file.
37  *
38  * Copyright (C) 1984, Sun Microsystems, Inc.
39  *
40  * This set of routines implements a XDR on a stdio stream.
41  * XDR_ENCODE serializes onto the stream, XDR_DECODE de-serializes
42  * from the stream.
43  */
44
45 #include <arpa/inet.h>
46 #include <rpc/types.h>
47 #include <stdio.h>
48 #include <rpc/xdr.h>
49
50 static bool_t   xdrstdio_getlong(XDR *, long *);
51 static bool_t   xdrstdio_putlong(XDR *, long *);
52 static bool_t   xdrstdio_getbytes(XDR *, caddr_t, u_int);
53 static bool_t   xdrstdio_putbytes(XDR *, caddr_t, u_int);
54 static u_int    xdrstdio_getpos(XDR *);
55 static bool_t   xdrstdio_setpos(XDR *, u_int);
56 static int32_t *xdrstdio_inline(XDR *, u_int);
57 static void     xdrstdio_destroy(XDR *);
58
59 /*
60  * Ops vector for stdio type XDR
61  */
62 static struct xdr_ops   xdrstdio_ops = {
63         xdrstdio_getlong,       /* deseraialize a long int */
64         xdrstdio_putlong,       /* seraialize a long int */
65         xdrstdio_getbytes,      /* deserialize counted bytes */
66         xdrstdio_putbytes,      /* serialize counted bytes */
67         xdrstdio_getpos,        /* get offset in the stream */
68         xdrstdio_setpos,        /* set offset in the stream */
69         xdrstdio_inline,        /* prime stream for inline macros */
70         xdrstdio_destroy        /* destroy stream */
71 };
72
73 /*
74  * Initialize a stdio xdr stream.
75  * Sets the xdr stream handle xdrs for use on the stream file.
76  * Operation flag is set to op.
77  */
78 void
79 xdrstdio_create(XDR *xdrs, FILE *file, enum xdr_op op)
80 {
81
82         xdrs->x_op = op;
83         xdrs->x_ops = &xdrstdio_ops;
84         xdrs->x_private = (caddr_t)file;
85         xdrs->x_handy = 0;
86         xdrs->x_base = 0;
87 }
88
89 /*
90  * Destroy a stdio xdr stream.
91  * Cleans up the xdr stream handle xdrs previously set up by xdrstdio_create.
92  */
93 static void
94 xdrstdio_destroy(XDR *xdrs)
95 {
96         fflush((FILE *)xdrs->x_private);
97         /* xx should we close the file ?? */
98 }
99
100 static bool_t
101 xdrstdio_getlong(XDR *xdrs, long *lp)
102 {
103
104         if (fread((caddr_t)lp, sizeof(int32_t), 1,
105                 (FILE *)xdrs->x_private) != 1)
106                 return (FALSE);
107         *lp = (long)ntohl((int32_t)*lp);
108         return (TRUE);
109 }
110
111 static bool_t
112 xdrstdio_putlong(XDR *xdrs, long *lp)
113 {
114
115         long mycopy = (long)htonl((int32_t)*lp);
116
117         if (fwrite((caddr_t)&mycopy, sizeof(int32_t), 1,
118                 (FILE *)xdrs->x_private) != 1)
119                 return (FALSE);
120         return (TRUE);
121 }
122
123 static bool_t
124 xdrstdio_getbytes(XDR *xdrs, caddr_t addr, u_int len)
125 {
126
127         if ((len != 0) && (fread(addr, (int)len, 1, (FILE *)xdrs->x_private) != 1))
128                 return (FALSE);
129         return (TRUE);
130 }
131
132 static bool_t
133 xdrstdio_putbytes(XDR *xdrs, caddr_t addr, u_int len)
134 {
135
136         if ((len != 0) && (fwrite(addr, (int)len, 1, (FILE *)xdrs->x_private) != 1))
137                 return (FALSE);
138         return (TRUE);
139 }
140
141 static u_int
142 xdrstdio_getpos(XDR *xdrs)
143 {
144         return ((u_int) ftell((FILE *)xdrs->x_private));
145 }
146
147 static bool_t
148 xdrstdio_setpos(XDR *xdrs, u_int pos)
149 {
150
151         return ((fseek((FILE *)xdrs->x_private, (long)pos, 0) < 0) ?
152                 FALSE : TRUE);
153 }
154
155 static int32_t *
156 xdrstdio_inline(XDR *xdrs __unused, u_int len __unused)
157 {
158
159         /*
160          * Must do some work to implement this: must insure
161          * enough data in the underlying stdio buffer,
162          * that the buffer is aligned so that we can indirect through a
163          * long *, and stuff this pointer in xdrs->x_buf.  Doing
164          * a fread or fwrite to a scratch buffer would defeat
165          * most of the gains to be had here and require storage
166          * management on this buffer, so we don't do this.
167          */
168         return (NULL);
169 }