Add seek()
[people/holger/gpxe.git] / src / core / xfer.c
1 /*
2  * Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <string.h>
20 #include <errno.h>
21 #include <gpxe/xfer.h>
22
23 /** @file
24  *
25  * Data transfer interfaces
26  *
27  */
28
29 /**
30  * Close data transfer interface
31  *
32  * @v xfer              Data transfer interface
33  * @v rc                Reason for close
34  */
35 void close ( struct xfer_interface *xfer, int rc ) {
36         struct xfer_interface *dest = xfer_dest ( xfer );
37
38         dest->op->close ( dest, rc );
39         xfer_unplug ( xfer );
40 }
41
42 /**
43  * Seek to position
44  *
45  * @v xfer              Data transfer interface
46  * @v pos               New position
47  * @ret rc              Return status code
48  */
49 int seek ( struct xfer_interface *xfer, size_t pos ) {
50         struct xfer_interface *dest = xfer_dest ( xfer );
51
52         return dest->op->seek ( dest, pos );
53 }
54
55 /**
56  * Send redirection event
57  *
58  * @v xfer              Data transfer interface
59  * @v type              New location type
60  * @v args              Remaining arguments depend upon location type
61  * @ret rc              Return status code
62  */
63 int vredirect ( struct xfer_interface *xfer, int type, va_list args ) {
64         struct xfer_interface *dest = xfer_dest ( xfer );
65
66         return dest->op->vredirect ( dest, type, args );
67 }
68
69 /**
70  * Send redirection event
71  *
72  * @v xfer              Data transfer interface
73  * @v type              New location type
74  * @v ...               Remaining arguments depend upon location type
75  * @ret rc              Return status code
76  */
77 int redirect ( struct xfer_interface *xfer, int type, ... ) {
78         va_list args;
79         int rc;
80
81         va_start ( args, type );
82         rc = vredirect ( xfer, type, args );
83         va_end ( args );
84         return rc;
85 }
86
87 /**
88  * Deliver datagram
89  *
90  * @v xfer              Data transfer interface
91  * @v iobuf             Datagram I/O buffer
92  * @ret rc              Return status code
93  */
94 int deliver ( struct xfer_interface *xfer, struct io_buffer *iobuf ) {
95         struct xfer_interface *dest = xfer_dest ( xfer );
96
97         return dest->op->deliver ( dest, iobuf );
98 }
99
100 /**
101  * Deliver datagram as raw data
102  *
103  * @v xfer              Data transfer interface
104  * @v iobuf             Datagram I/O buffer
105  * @ret rc              Return status code
106  */
107 int deliver_raw ( struct xfer_interface *xfer, const void *data, size_t len ) {
108         struct xfer_interface *dest = xfer_dest ( xfer );
109
110         return dest->op->deliver_raw ( dest, data, len );
111 }
112
113 /****************************************************************************
114  *
115  * Helper methods
116  *
117  * These functions are designed to be used as methods in the
118  * xfer_interface_operations table.
119  *
120  */
121
122 /**
123  * Ignore close()
124  *
125  * @v xfer              Data transfer interface
126  * @v rc                Reason for close
127  */
128 void ignore_close ( struct xfer_interface *xfer __unused, int rc __unused ) {
129         /* Nothing to do */
130 }
131
132 /**
133  * Ignore vredirect()
134  *
135  * @v xfer              Data transfer interface
136  * @v type              New location type
137  * @v args              Remaining arguments depend upon location type
138  * @ret rc              Return status code
139  */
140 int ignore_vredirect ( struct xfer_interface *xfer __unused,
141                        int type __unused, va_list args __unused ) {
142         return 0;
143 }
144
145 /**
146  * Ignore seek()
147  *
148  * @v xfer              Data transfer interface
149  * @v pos               New position
150  * @ret rc              Return status code
151  */
152 int ignore_seek ( struct xfer_interface *xfer __unused, size_t pos __unused ) {
153         return 0;
154 }
155
156 /**
157  * Deliver datagram as raw data
158  *
159  * @v xfer              Data transfer interface
160  * @v iobuf             Datagram I/O buffer
161  * @ret rc              Return status code
162  *
163  * This function is intended to be used as the deliver() method for
164  * data transfer interfaces that prefer to handle raw data.
165  */
166 int deliver_as_raw ( struct xfer_interface *xfer,
167                      struct io_buffer *iobuf ) {
168         int rc;
169
170         rc = xfer->op->deliver_raw ( xfer, iobuf->data, iob_len ( iobuf ) );
171         free_iob ( iobuf );
172         return rc;
173 }
174
175 /**
176  * Deliver datagram as I/O buffer
177  *
178  * @v xfer              Data transfer interface
179  * @v data              Data buffer
180  * @v len               Length of data buffer
181  * @ret rc              Return status code
182  *
183  * This function is intended to be used as the deliver_raw() method
184  * for data transfer interfaces that prefer to handle I/O buffers.
185  */
186 int deliver_as_iobuf ( struct xfer_interface *xfer,
187                        const void *data, size_t len ) {
188         struct io_buffer *iobuf;
189
190         iobuf = alloc_iob ( len );
191         if ( ! iobuf )
192                 return -ENOMEM;
193
194         memcpy ( iob_put ( iobuf, len ), data, len );
195         return xfer->op->deliver ( xfer, iobuf );
196 }
197
198 /**
199  * Ignore datagram as raw data
200  *
201  * @v xfer              Data transfer interface
202  * @v data              Data buffer
203  * @v len               Length of data buffer
204  * @ret rc              Return status code
205  */
206 int ignore_deliver_raw ( struct xfer_interface *xfer,
207                          const void *data __unused, size_t len ) {
208         DBGC ( xfer, "XFER %p %zd bytes delivered %s\n", xfer, len,
209                ( ( xfer == &null_xfer ) ?
210                  "before connection" : "after termination" ) );
211         return 0;
212 }
213
214 /** Null data transfer interface operations */
215 struct xfer_interface_operations null_xfer_ops = {
216         .close          = ignore_close,
217         .vredirect      = ignore_vredirect,
218         .seek           = ignore_seek,
219         .deliver        = deliver_as_raw,
220         .deliver_raw    = ignore_deliver_raw,
221 };
222
223 /**
224  * Null data transfer interface
225  *
226  * This is the interface to which data transfer interfaces are
227  * connected when unplugged.  It will never generate messages, and
228  * will silently absorb all received messages.
229  */
230 struct xfer_interface null_xfer = {
231         .intf = {
232                 .dest = &null_xfer.intf,
233                 .refcnt = null_refcnt,
234         },
235         .op = &null_xfer_ops,
236 };