032b1f2358f08f03c84df28803f9b5425e0e8d30
[people/balajirrao/gpxe.git] / src / interface / pxe / pxe_udp.c
1 /** @file
2  *
3  * PXE UDP API
4  *
5  */
6
7 #include <string.h>
8 #include <byteswap.h>
9 #include <gpxe/xfer.h>
10 #include <gpxe/udp.h>
11 #include <gpxe/uaccess.h>
12 #include <gpxe/process.h>
13 #include <pxe.h>
14
15 /*
16  * Copyright (C) 2004 Michael Brown <mbrown@fensystems.co.uk>.
17  *
18  * This program is free software; you can redistribute it and/or
19  * modify it under the terms of the GNU General Public License as
20  * published by the Free Software Foundation; either version 2 of the
21  * License, or any later version.
22  *
23  * This program is distributed in the hope that it will be useful, but
24  * WITHOUT ANY WARRANTY; without even the implied warranty of
25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
26  * General Public License for more details.
27  *
28  * You should have received a copy of the GNU General Public License
29  * along with this program; if not, write to the Free Software
30  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
31  */
32
33 /** A PXE UDP connection */
34 struct pxe_udp_connection {
35         /** Data transfer interface to UDP stack */
36         struct xfer_interface xfer;
37         /** Local address */
38         struct sockaddr_in local;
39         /** Current PXENV_UDP_READ parameter block */
40         struct s_PXENV_UDP_READ *pxenv_udp_read;
41 };
42
43 /**
44  * Receive PXE UDP data
45  *
46  * @v xfer                      Data transfer interface
47  * @v iobuf                     I/O buffer
48  * @v meta                      Data transfer metadata
49  * @ret rc                      Return status code
50  *
51  * Receives a packet as part of the current pxenv_udp_read()
52  * operation.
53  */
54 static int pxe_udp_deliver_iob ( struct xfer_interface *xfer,
55                                  struct io_buffer *iobuf,
56                                  struct xfer_metadata *meta ) {
57         struct pxe_udp_connection *pxe_udp = 
58                 container_of ( xfer, struct pxe_udp_connection, xfer );
59         struct s_PXENV_UDP_READ *pxenv_udp_read = pxe_udp->pxenv_udp_read;
60         struct sockaddr_in *sin_src;
61         struct sockaddr_in *sin_dest;
62         userptr_t buffer;
63         size_t len;
64         int rc = 0;
65
66         if ( ! pxenv_udp_read ) {
67                 DBG ( "PXE discarded UDP packet\n" );
68                 rc = -ENOBUFS;
69                 goto done;
70         }
71
72         /* Copy packet to buffer and record length */
73         buffer = real_to_user ( pxenv_udp_read->buffer.segment,
74                                 pxenv_udp_read->buffer.offset );
75         len = iob_len ( iobuf );
76         if ( len > pxenv_udp_read->buffer_size )
77                 len = pxenv_udp_read->buffer_size;
78         copy_to_user ( buffer, 0, iobuf->data, len );
79         pxenv_udp_read->buffer_size = len;
80
81         /* Fill in source/dest information */
82         assert ( meta );
83         sin_src = ( struct sockaddr_in * ) meta->src;
84         assert ( sin_src );
85         assert ( sin_src->sin_family == AF_INET );
86         pxenv_udp_read->src_ip = sin_src->sin_addr.s_addr;
87         pxenv_udp_read->s_port = sin_src->sin_port;
88         sin_dest = ( struct sockaddr_in * ) meta->dest;
89         assert ( sin_dest );
90         assert ( sin_dest->sin_family == AF_INET );
91         pxenv_udp_read->dest_ip = sin_dest->sin_addr.s_addr;
92         pxenv_udp_read->d_port = sin_dest->sin_port;
93
94         /* Mark as received */
95         pxe_udp->pxenv_udp_read = NULL;
96
97  done:
98         free_iob ( iobuf );
99         return rc;
100 }
101
102 /** PXE UDP data transfer interface operations */
103 static struct xfer_interface_operations pxe_udp_xfer_operations = {
104         .close          = ignore_xfer_close,
105         .vredirect      = ignore_xfer_vredirect,
106         .window         = unlimited_xfer_window,
107         .alloc_iob      = default_xfer_alloc_iob,
108         .deliver_iob    = pxe_udp_deliver_iob,
109         .deliver_raw    = xfer_deliver_as_iob,
110 };
111
112 /** The PXE UDP connection */
113 static struct pxe_udp_connection pxe_udp = {
114         .xfer = XFER_INIT ( &pxe_udp_xfer_operations ),
115         .local = {
116                 .sin_family = AF_INET,
117         },
118 };
119
120 /**
121  * UDP OPEN
122  *
123  * @v pxenv_udp_open                    Pointer to a struct s_PXENV_UDP_OPEN
124  * @v s_PXENV_UDP_OPEN::src_ip          IP address of this station, or 0.0.0.0
125  * @ret #PXENV_EXIT_SUCCESS             Always
126  * @ret s_PXENV_UDP_OPEN::Status        PXE status code
127  * @err #PXENV_STATUS_UDP_OPEN          UDP connection already open
128  * @err #PXENV_STATUS_OUT_OF_RESOURCES  Could not open connection
129  *
130  * Prepares the PXE stack for communication using pxenv_udp_write()
131  * and pxenv_udp_read().
132  *
133  * The IP address supplied in s_PXENV_UDP_OPEN::src_ip will be
134  * recorded and used as the local station's IP address for all further
135  * communication, including communication by means other than
136  * pxenv_udp_write() and pxenv_udp_read().  (If
137  * s_PXENV_UDP_OPEN::src_ip is 0.0.0.0, the local station's IP address
138  * will remain unchanged.)
139  *
140  * You can only have one open UDP connection at a time.  This is not a
141  * meaningful restriction, since pxenv_udp_write() and
142  * pxenv_udp_read() allow you to specify arbitrary local and remote
143  * ports and an arbitrary remote address for each packet.  According
144  * to the PXE specifiation, you cannot have a UDP connection open at
145  * the same time as a TFTP connection; this restriction does not apply
146  * to Etherboot.
147  *
148  * On x86, you must set the s_PXE::StatusCallout field to a nonzero
149  * value before calling this function in protected mode.  You cannot
150  * call this function with a 32-bit stack segment.  (See the relevant
151  * @ref pxe_x86_pmode16 "implementation note" for more details.)
152  *
153  * @note The PXE specification does not make it clear whether the IP
154  * address supplied in s_PXENV_UDP_OPEN::src_ip should be used only
155  * for this UDP connection, or retained for all future communication.
156  * The latter seems more consistent with typical PXE stack behaviour.
157  *
158  * @note Etherboot currently ignores the s_PXENV_UDP_OPEN::src_ip
159  * parameter.
160  *
161  */
162 PXENV_EXIT_t pxenv_udp_open ( struct s_PXENV_UDP_OPEN *pxenv_udp_open ) {
163         int rc;
164
165         DBG ( "PXENV_UDP_OPEN" );
166
167         /* Record source IP address */
168         pxe_udp.local.sin_addr.s_addr = pxenv_udp_open->src_ip;
169
170         /* Open promiscuous UDP connection */
171         xfer_close ( &pxe_udp.xfer, 0 );
172         if ( ( rc = udp_open_promisc ( &pxe_udp.xfer ) ) != 0 ) {
173                 pxenv_udp_open->Status = PXENV_STATUS ( rc );
174                 return PXENV_EXIT_FAILURE;
175         }
176
177         pxenv_udp_open->Status = PXENV_STATUS_SUCCESS;
178         return PXENV_EXIT_SUCCESS;
179 }
180
181 /**
182  * UDP CLOSE
183  *
184  * @v pxenv_udp_close                   Pointer to a struct s_PXENV_UDP_CLOSE
185  * @ret #PXENV_EXIT_SUCCESS             Always
186  * @ret s_PXENV_UDP_CLOSE::Status       PXE status code
187  * @err None                            -
188  *
189  * Closes a UDP connection opened with pxenv_udp_open().
190  *
191  * You can only have one open UDP connection at a time.  You cannot
192  * have a UDP connection open at the same time as a TFTP connection.
193  * You cannot use pxenv_udp_close() to close a TFTP connection; use
194  * pxenv_tftp_close() instead.
195  *
196  * On x86, you must set the s_PXE::StatusCallout field to a nonzero
197  * value before calling this function in protected mode.  You cannot
198  * call this function with a 32-bit stack segment.  (See the relevant
199  * @ref pxe_x86_pmode16 "implementation note" for more details.)
200  *
201  */
202 PXENV_EXIT_t pxenv_udp_close ( struct s_PXENV_UDP_CLOSE *pxenv_udp_close ) {
203         DBG ( "PXENV_UDP_CLOSE" );
204
205         /* Close UDP connection */
206         xfer_close ( &pxe_udp.xfer, 0 );
207
208         pxenv_udp_close->Status = PXENV_STATUS_SUCCESS;
209         return PXENV_EXIT_SUCCESS;
210 }
211
212 /**
213  * UDP WRITE
214  *
215  * @v pxenv_udp_write                   Pointer to a struct s_PXENV_UDP_WRITE
216  * @v s_PXENV_UDP_WRITE::ip             Destination IP address
217  * @v s_PXENV_UDP_WRITE::gw             Relay agent IP address, or 0.0.0.0
218  * @v s_PXENV_UDP_WRITE::src_port       Source UDP port, or 0
219  * @v s_PXENV_UDP_WRITE::dst_port       Destination UDP port
220  * @v s_PXENV_UDP_WRITE::buffer_size    Length of the UDP payload
221  * @v s_PXENV_UDP_WRITE::buffer         Address of the UDP payload
222  * @ret #PXENV_EXIT_SUCCESS             Packet was transmitted successfully
223  * @ret #PXENV_EXIT_FAILURE             Packet could not be transmitted
224  * @ret s_PXENV_UDP_WRITE::Status       PXE status code
225  * @err #PXENV_STATUS_UDP_CLOSED        UDP connection is not open
226  * @err #PXENV_STATUS_UNDI_TRANSMIT_ERROR Could not transmit packet
227  *
228  * Transmits a single UDP packet.  A valid IP and UDP header will be
229  * prepended to the payload in s_PXENV_UDP_WRITE::buffer; the buffer
230  * should not contain precomputed IP and UDP headers, nor should it
231  * contain space allocated for these headers.  The first byte of the
232  * buffer will be transmitted as the first byte following the UDP
233  * header.
234  *
235  * If s_PXENV_UDP_WRITE::gw is 0.0.0.0, normal IP routing will take
236  * place.  See the relevant @ref pxe_routing "implementation note" for
237  * more details.
238  *
239  * If s_PXENV_UDP_WRITE::src_port is 0, port 2069 will be used.
240  *
241  * You must have opened a UDP connection with pxenv_udp_open() before
242  * calling pxenv_udp_write().
243  *
244  * On x86, you must set the s_PXE::StatusCallout field to a nonzero
245  * value before calling this function in protected mode.  You cannot
246  * call this function with a 32-bit stack segment.  (See the relevant
247  * @ref pxe_x86_pmode16 "implementation note" for more details.)
248  *
249  * @note Etherboot currently ignores the s_PXENV_UDP_WRITE::gw
250  * parameter.
251  *
252  */
253 PXENV_EXIT_t pxenv_udp_write ( struct s_PXENV_UDP_WRITE *pxenv_udp_write ) {
254         struct sockaddr_in dest;
255         struct xfer_metadata meta = {
256                 .src = ( struct sockaddr * ) &pxe_udp.local,
257                 .dest = ( struct sockaddr * ) &dest,
258                 .netdev = pxe_netdev,
259         };
260         size_t len;
261         struct io_buffer *iobuf;
262         userptr_t buffer;
263         int rc;
264
265         DBG ( "PXENV_UDP_WRITE" );
266
267         /* Construct destination socket address */
268         memset ( &dest, 0, sizeof ( dest ) );
269         dest.sin_family = AF_INET;
270         dest.sin_addr.s_addr = pxenv_udp_write->ip;
271         dest.sin_port = pxenv_udp_write->dst_port;
272
273         /* Set local (source) port.  PXE spec says source port is 2069
274          * if not specified.  Really, this ought to be set at UDP open
275          * time but hey, we didn't design this API.
276          */
277         pxe_udp.local.sin_port = pxenv_udp_write->src_port;
278         if ( ! pxe_udp.local.sin_port )
279                 pxe_udp.local.sin_port = htons ( 2069 );
280
281         /* FIXME: we ignore the gateway specified, since we're
282          * confident of being able to do our own routing.  We should
283          * probably allow for multiple gateways.
284          */
285
286         /* Allocate and fill data buffer */
287         len = pxenv_udp_write->buffer_size;
288         iobuf = xfer_alloc_iob ( &pxe_udp.xfer, len );
289         if ( ! iobuf ) {
290                 pxenv_udp_write->Status = PXENV_STATUS_OUT_OF_RESOURCES;
291                 return PXENV_EXIT_FAILURE;
292         }
293         buffer = real_to_user ( pxenv_udp_write->buffer.segment,
294                                 pxenv_udp_write->buffer.offset );
295         copy_from_user ( iob_put ( iobuf, len ), buffer, 0, len );
296
297         DBG ( " %04x:%04x+%x %d->%s:%d", pxenv_udp_write->buffer.segment,
298               pxenv_udp_write->buffer.offset, pxenv_udp_write->buffer_size,
299               ntohs ( pxenv_udp_write->src_port ),
300               inet_ntoa ( dest.sin_addr ),
301               ntohs ( pxenv_udp_write->dst_port ) );
302         
303         /* Transmit packet */
304         if ( ( rc = xfer_deliver_iob_meta ( &pxe_udp.xfer, iobuf,
305                                             &meta ) ) != 0 ) {
306                 pxenv_udp_write->Status = PXENV_STATUS ( rc );
307                 return PXENV_EXIT_FAILURE;
308         }
309
310         pxenv_udp_write->Status = PXENV_STATUS_SUCCESS;
311         return PXENV_EXIT_SUCCESS;
312 }
313
314 /**
315  * UDP READ
316  *
317  * @v pxenv_udp_read                    Pointer to a struct s_PXENV_UDP_READ
318  * @v s_PXENV_UDP_READ::dest_ip         Destination IP address, or 0.0.0.0
319  * @v s_PXENV_UDP_READ::d_port          Destination UDP port, or 0
320  * @v s_PXENV_UDP_READ::buffer_size     Size of the UDP payload buffer
321  * @v s_PXENV_UDP_READ::buffer          Address of the UDP payload buffer
322  * @ret #PXENV_EXIT_SUCCESS             A packet has been received
323  * @ret #PXENV_EXIT_FAILURE             No packet has been received
324  * @ret s_PXENV_UDP_READ::Status        PXE status code
325  * @ret s_PXENV_UDP_READ::src_ip        Source IP address
326  * @ret s_PXENV_UDP_READ::dest_ip       Destination IP address
327  * @ret s_PXENV_UDP_READ::s_port        Source UDP port
328  * @ret s_PXENV_UDP_READ::d_port        Destination UDP port
329  * @ret s_PXENV_UDP_READ::buffer_size   Length of UDP payload
330  * @err #PXENV_STATUS_UDP_CLOSED        UDP connection is not open
331  * @err #PXENV_STATUS_FAILURE           No packet was ready to read
332  *
333  * Receive a single UDP packet.  This is a non-blocking call; if no
334  * packet is ready to read, the call will return instantly with
335  * s_PXENV_UDP_READ::Status==PXENV_STATUS_FAILURE.
336  *
337  * If s_PXENV_UDP_READ::dest_ip is 0.0.0.0, UDP packets addressed to
338  * any IP address will be accepted and may be returned to the caller.
339  *
340  * If s_PXENV_UDP_READ::d_port is 0, UDP packets addressed to any UDP
341  * port will be accepted and may be returned to the caller.
342  *
343  * You must have opened a UDP connection with pxenv_udp_open() before
344  * calling pxenv_udp_read().
345  *
346  * On x86, you must set the s_PXE::StatusCallout field to a nonzero
347  * value before calling this function in protected mode.  You cannot
348  * call this function with a 32-bit stack segment.  (See the relevant
349  * @ref pxe_x86_pmode16 "implementation note" for more details.)
350  *
351  * @note The PXE specification (version 2.1) does not state that we
352  * should fill in s_PXENV_UDP_READ::dest_ip and
353  * s_PXENV_UDP_READ::d_port, but Microsoft Windows' NTLDR program
354  * expects us to do so, and will fail if we don't.
355  *
356  */
357 PXENV_EXIT_t pxenv_udp_read ( struct s_PXENV_UDP_READ *pxenv_udp_read ) {
358         struct in_addr dest_ip = { .s_addr = pxenv_udp_read->dest_ip };
359         uint16_t d_port = pxenv_udp_read->d_port;
360
361         DBG ( "PXENV_UDP_READ" );
362
363         /* Try receiving a packet */
364         pxe_udp.pxenv_udp_read = pxenv_udp_read;
365         step();
366         if ( pxe_udp.pxenv_udp_read ) {
367                 /* No packet received */
368                 pxe_udp.pxenv_udp_read = NULL;
369                 goto no_packet;
370         }
371
372         /* Filter on destination address and/or port */
373         if ( dest_ip.s_addr && ( dest_ip.s_addr != pxenv_udp_read->dest_ip ) )
374                 goto no_packet;
375         if ( d_port && ( d_port != pxenv_udp_read->d_port ) )
376                 goto no_packet;
377
378         DBG ( " %04x:%04x+%x %s:", pxenv_udp_read->buffer.segment,
379               pxenv_udp_read->buffer.offset, pxenv_udp_read->buffer_size,
380               inet_ntoa ( *( ( struct in_addr * ) &pxenv_udp_read->src_ip ) ));
381         DBG ( "%d<-%s:%d",  ntohs ( pxenv_udp_read->s_port ),
382               inet_ntoa ( *( ( struct in_addr * ) &pxenv_udp_read->dest_ip ) ),
383               ntohs ( pxenv_udp_read->d_port ) );
384
385         pxenv_udp_read->Status = PXENV_STATUS_SUCCESS;
386         return PXENV_EXIT_SUCCESS;
387
388  no_packet:
389         pxenv_udp_read->Status = PXENV_STATUS_FAILURE;
390         return PXENV_EXIT_FAILURE;
391 }