404dd7276804272a69a8637cb667b1deaf07ea54
[people/andreif/gpxe.git] / src / net / udp.c
1 #include <stdint.h>
2 #include <stdlib.h>
3 #include <string.h>
4 #include <assert.h>
5 #include <byteswap.h>
6 #include <errno.h>
7 #include <gpxe/tcpip.h>
8 #include <gpxe/iobuf.h>
9 #include <gpxe/xfer.h>
10 #include <gpxe/open.h>
11 #include <gpxe/uri.h>
12 #include <gpxe/udp.h>
13
14 /** @file
15  *
16  * UDP protocol
17  */
18
19 /**
20  * A UDP connection
21  *
22  */
23 struct udp_connection {
24         /** Reference counter */
25         struct refcnt refcnt;
26         /** List of UDP connections */
27         struct list_head list;
28
29         /** Data transfer interface */
30         struct xfer_interface xfer;
31
32         /** Remote socket address */
33         struct sockaddr_tcpip peer;
34         /** Local port on which the connection receives packets */
35         unsigned int local_port;
36 };
37
38 /**
39  * List of registered UDP connections
40  */
41 static LIST_HEAD ( udp_conns );
42
43 /* Forward declatations */
44 static struct xfer_interface_operations udp_xfer_operations;
45 struct tcpip_protocol udp_protocol;
46
47 /**
48  * Bind UDP connection to local port
49  *
50  * @v udp               UDP connection
51  * @v port              Local port, in network byte order, or zero
52  * @ret rc              Return status code
53  *
54  * Opens the UDP connection and binds to a local port.  If no local
55  * port is specified, the first available port will be used.
56  */
57 static int udp_bind ( struct udp_connection *udp, unsigned int port ) {
58         struct udp_connection *existing;
59         static uint16_t try_port = 1024;
60
61         /* If no port specified, find the first available port */
62         if ( ! port ) {
63                 for ( ; try_port ; try_port++ ) {
64                         if ( try_port < 1024 )
65                                 continue;
66                         if ( udp_bind ( udp, htons ( try_port ) ) == 0 )
67                                 return 0;
68                 }
69                 return -EADDRINUSE;
70         }
71
72         /* Attempt bind to local port */
73         list_for_each_entry ( existing, &udp_conns, list ) {
74                 if ( existing->local_port == port ) {
75                         DBGC ( udp, "UDP %p could not bind: port %d in use\n",
76                                udp, ntohs ( port ) );
77                         return -EADDRINUSE;
78                 }
79         }
80         udp->local_port = port;
81
82         /* Add to UDP connection list */
83         DBGC ( udp, "UDP %p bound to port %d\n", udp, ntohs ( port ) );
84
85         return 0;
86 }
87
88 /**
89  * Open a UDP connection
90  *
91  * @v xfer              Data transfer interface
92  * @v peer              Peer socket address
93  * @v local             Local socket address, or NULL
94  * @v promisc           Socket is promiscuous
95  * @ret rc              Return status code
96  */
97 static int udp_open_common ( struct xfer_interface *xfer,
98                              struct sockaddr *peer, struct sockaddr *local,
99                              int promisc ) {
100         struct sockaddr_tcpip *st_peer = ( struct sockaddr_tcpip * ) peer;
101         struct sockaddr_tcpip *st_local = ( struct sockaddr_tcpip * ) local;
102         struct udp_connection *udp;
103         unsigned int bind_port;
104         int rc;
105
106         /* Allocate and initialise structure */
107         udp = malloc ( sizeof ( *udp ) );
108         if ( ! udp )
109                 return -ENOMEM;
110         DBGC ( udp, "UDP %p allocated\n", udp );
111         memset ( udp, 0, sizeof ( *udp ) );
112         xfer_init ( &udp->xfer, &udp_xfer_operations, &udp->refcnt );
113         memcpy ( &udp->peer, st_peer, sizeof ( udp->peer ) );
114
115         /* Bind to local port */
116         if ( ! promisc ) {
117                 bind_port = ( st_local ? st_local->st_port : 0 );
118                 if ( ( rc = udp_bind ( udp, bind_port ) ) != 0 )
119                         goto err;
120         }
121
122         /* Attach parent interface, transfer reference to connection
123          * list and return
124          */
125         xfer_plug_plug ( &udp->xfer, xfer );
126         list_add ( &udp->list, &udp_conns );
127         return 0;
128
129  err:
130         ref_put ( &udp->refcnt );
131         return rc;
132 }
133
134 /**
135  * Open a UDP connection
136  *
137  * @v xfer              Data transfer interface
138  * @v peer              Peer socket address
139  * @v local             Local socket address, or NULL
140  * @ret rc              Return status code
141  */
142 int udp_open ( struct xfer_interface *xfer, struct sockaddr *peer,
143                struct sockaddr *local ) {
144         return udp_open_common ( xfer, peer, local, 0 );
145 }
146
147 /**
148  * Open a promiscuous UDP connection
149  *
150  * @v xfer              Data transfer interface
151  * @ret rc              Return status code
152  *
153  * Promiscuous UDP connections are required in order to support the
154  * PXE API.
155  */
156 int udp_open_promisc ( struct xfer_interface *xfer ) {
157         return udp_open_common ( xfer, NULL, NULL, 1 );
158 }
159
160 /**
161  * Close a UDP connection
162  *
163  * @v udp               UDP connection
164  * @v rc                Reason for close
165  */
166 static void udp_close ( struct udp_connection *udp, int rc ) {
167
168         /* Close data transfer interface */
169         xfer_nullify ( &udp->xfer );
170         xfer_close ( &udp->xfer, rc );
171
172         /* Remove from list of connections and drop list's reference */
173         list_del ( &udp->list );
174         ref_put ( &udp->refcnt );
175
176         DBGC ( udp, "UDP %p closed\n", udp );
177 }
178
179 /**
180  * Transmit data via a UDP connection to a specified address
181  *
182  * @v udp               UDP connection
183  * @v iobuf             I/O buffer
184  * @v src_port          Source port, or 0 to use default
185  * @v dest              Destination address, or NULL to use default
186  * @ret rc              Return status code
187  */
188 static int udp_tx ( struct udp_connection *udp, struct io_buffer *iobuf,
189                     unsigned int src_port, struct sockaddr_tcpip *dest ) {
190         struct udp_header *udphdr;
191         struct net_device *netdev = NULL;
192         size_t len;
193         int rc;
194
195 #warning "netdev?"
196
197         /* Check we can accommodate the header */
198         if ( ( rc = iob_ensure_headroom ( iobuf, UDP_MAX_HLEN ) ) != 0 ) {
199                 free_iob ( iobuf );
200                 return rc;
201         }
202
203         /* Fill in default values if not explicitly provided */
204         if ( ! src_port )
205                 src_port = udp->local_port;
206         if ( ! dest )
207                 dest = &udp->peer;
208
209         /* Add the UDP header */
210         udphdr = iob_push ( iobuf, sizeof ( *udphdr ) );
211         len = iob_len ( iobuf );
212         udphdr->dest = dest->st_port;
213         udphdr->src = src_port;
214         udphdr->len = htons ( len );
215         udphdr->chksum = 0;
216         udphdr->chksum = tcpip_chksum ( udphdr, len );
217
218         /* Dump debugging information */
219         DBGC ( udp, "UDP %p TX %d->%d len %zd\n", udp,
220                ntohs ( udphdr->src ), ntohs ( udphdr->dest ),
221                ntohs ( udphdr->len ) );
222
223         /* Send it to the next layer for processing */
224         if ( ( rc = tcpip_tx ( iobuf, &udp_protocol, dest, netdev,
225                                &udphdr->chksum ) ) != 0 ) {
226                 DBGC ( udp, "UDP %p could not transmit packet: %s\n",
227                        udp, strerror ( rc ) );
228                 return rc;
229         }
230
231         return 0;
232 }
233
234 /**
235  * Identify UDP connection by local port number
236  *
237  * @v local_port        Local port (in network-endian order)
238  * @ret udp             UDP connection, or NULL
239  */
240 static struct udp_connection * udp_demux ( unsigned int local_port ) {
241         struct udp_connection *udp;
242
243         list_for_each_entry ( udp, &udp_conns, list ) {
244                 if ( ( udp->local_port == local_port ) ||
245                      ( udp->local_port == 0 ) ) {
246                         return udp;
247                 }
248         }
249         return NULL;
250 }
251
252 /**
253  * Process a received packet
254  *
255  * @v iobuf             I/O buffer
256  * @v st_src            Partially-filled source address
257  * @v st_dest           Partially-filled destination address
258  * @v pshdr_csum        Pseudo-header checksum
259  * @ret rc              Return status code
260  */
261 static int udp_rx ( struct io_buffer *iobuf, struct sockaddr_tcpip *st_src,
262                     struct sockaddr_tcpip *st_dest, uint16_t pshdr_csum ) {
263         struct udp_header *udphdr = iobuf->data;
264         struct udp_connection *udp;
265         struct xfer_metadata meta;
266         size_t ulen;
267         unsigned int csum;
268         int rc = 0;
269
270         /* Sanity check packet */
271         if ( iob_len ( iobuf ) < sizeof ( *udphdr ) ) {
272                 DBG ( "UDP packet too short at %d bytes (min %d bytes)\n",
273                       iob_len ( iobuf ), sizeof ( *udphdr ) );
274                 
275                 rc = -EINVAL;
276                 goto done;
277         }
278         ulen = ntohs ( udphdr->len );
279         if ( ulen < sizeof ( *udphdr ) ) {
280                 DBG ( "UDP length too short at %d bytes "
281                       "(header is %d bytes)\n", ulen, sizeof ( *udphdr ) );
282                 rc = -EINVAL;
283                 goto done;
284         }
285         if ( ulen > iob_len ( iobuf ) ) {
286                 DBG ( "UDP length too long at %d bytes (packet is %d bytes)\n",
287                       ulen, iob_len ( iobuf ) );
288                 rc = -EINVAL;
289                 goto done;
290         }
291         if ( udphdr->chksum ) {
292                 csum = tcpip_continue_chksum ( pshdr_csum, iobuf->data, ulen );
293                 if ( csum != 0 ) {
294                         DBG ( "UDP checksum incorrect (is %04x including "
295                               "checksum field, should be 0000)\n", csum );
296                         rc = -EINVAL;
297                         goto done;
298                 }
299         }
300
301         /* Parse parameters from header and strip header */
302         st_src->st_port = udphdr->src;
303         st_dest->st_port = udphdr->dest;
304         udp = udp_demux ( udphdr->dest );
305         iob_unput ( iobuf, ( iob_len ( iobuf ) - ulen ) );
306         iob_pull ( iobuf, sizeof ( *udphdr ) );
307
308         /* Dump debugging information */
309         DBGC ( udp, "UDP %p RX %d<-%d len %zd\n", udp,
310                ntohs ( udphdr->dest ), ntohs ( udphdr->src ), ulen );
311
312         /* Ignore if no matching connection found */
313         if ( ! udp ) {
314                 DBG ( "No UDP connection listening on port %d\n",
315                       ntohs ( udphdr->dest ) );
316                 rc = -ENOTCONN;
317                 goto done;
318         }
319
320         /* Pass data to application */
321         memset ( &meta, 0, sizeof ( meta ) );
322         meta.src = ( struct sockaddr * ) st_src;
323         meta.dest = ( struct sockaddr * ) st_dest;
324         rc = xfer_deliver_iob_meta ( &udp->xfer, iobuf, &meta );
325         iobuf = NULL;
326
327  done:
328         free_iob ( iobuf );
329         return rc;
330 }
331
332 struct tcpip_protocol udp_protocol __tcpip_protocol = {
333         .name = "UDP",
334         .rx = udp_rx,
335         .tcpip_proto = IP_UDP,
336 };
337
338 /***************************************************************************
339  *
340  * Data transfer interface
341  *
342  ***************************************************************************
343  */
344
345 /**
346  * Close interface
347  *
348  * @v xfer              Data transfer interface
349  * @v rc                Reason for close
350  */
351 static void udp_xfer_close ( struct xfer_interface *xfer, int rc ) {
352         struct udp_connection *udp =
353                 container_of ( xfer, struct udp_connection, xfer );
354
355         /* Close connection */
356         udp_close ( udp, rc );
357 }
358
359 /**
360  * Allocate I/O buffer for UDP
361  *
362  * @v xfer              Data transfer interface
363  * @v len               Payload size
364  * @ret iobuf           I/O buffer, or NULL
365  */
366 static struct io_buffer * udp_alloc_iob ( struct xfer_interface *xfer,
367                                           size_t len ) {
368         struct udp_connection *udp =
369                 container_of ( xfer, struct udp_connection, xfer );     
370         struct io_buffer *iobuf;
371
372         iobuf = alloc_iob ( UDP_MAX_HLEN + len );
373         if ( ! iobuf ) {
374                 DBGC ( udp, "UDP %p cannot allocate buffer of length %d\n",
375                        udp, len );
376                 return NULL;
377         }
378         iob_reserve ( iobuf, UDP_MAX_HLEN );
379         return iobuf;
380 }
381
382 /**
383  * Deliver datagram as I/O buffer
384  *
385  * @v xfer              Data transfer interface
386  * @v iobuf             Datagram I/O buffer
387  * @v meta              Data transfer metadata, or NULL
388  * @ret rc              Return status code
389  */
390 static int udp_xfer_deliver_iob ( struct xfer_interface *xfer,
391                                   struct io_buffer *iobuf,
392                                   struct xfer_metadata *meta ) {
393         struct udp_connection *udp =
394                 container_of ( xfer, struct udp_connection, xfer );
395         struct sockaddr_tcpip *src;
396         struct sockaddr_tcpip *dest = NULL;
397         unsigned int src_port = 0;
398
399         /* Apply xfer metadata */
400         if ( meta ) {
401                 src = ( struct sockaddr_tcpip * ) meta->src;
402                 if ( src )
403                         src_port = src->st_port;
404                 dest = ( struct sockaddr_tcpip * ) meta->dest;
405         }
406
407         /* Transmit data, if possible */
408         udp_tx ( udp, iobuf, src_port, dest );
409
410         return 0;
411 }
412
413 /** UDP data transfer interface operations */
414 static struct xfer_interface_operations udp_xfer_operations = {
415         .close          = udp_xfer_close,
416         .vredirect      = ignore_xfer_vredirect,
417         .request        = ignore_xfer_request,
418         .seek           = ignore_xfer_seek,
419         .alloc_iob      = udp_alloc_iob,
420         .deliver_iob    = udp_xfer_deliver_iob,
421         .deliver_raw    = xfer_deliver_as_iob,
422 };
423
424 /***************************************************************************
425  *
426  * Openers
427  *
428  ***************************************************************************
429  */
430
431 /** UDP socket opener */
432 struct socket_opener udp_socket_opener __socket_opener = {
433         .semantics      = SOCK_DGRAM,
434         .family         = AF_INET,
435         .open           = udp_open,
436 };
437
438 /**
439  * Open UDP URI
440  *
441  * @v xfer              Data transfer interface
442  * @v uri               URI
443  * @ret rc              Return status code
444  */
445 static int udp_open_uri ( struct xfer_interface *xfer, struct uri *uri ) {
446         struct sockaddr_tcpip peer;
447
448         /* Sanity check */
449         if ( ! uri->host )
450                 return -EINVAL;
451
452         memset ( &peer, 0, sizeof ( peer ) );
453         peer.st_port = htons ( uri_port ( uri, 0 ) );
454         return xfer_open_named_socket ( xfer, SOCK_DGRAM,
455                                         ( struct sockaddr * ) &peer,
456                                         uri->host, NULL );
457 }
458
459 /** UDP URI opener */
460 struct uri_opener udp_uri_opener __uri_opener = {
461         .scheme         = "udp",
462         .open           = udp_open_uri,
463 };