94a71524b86ffff9b9d201a866f2a1713d642aab
[people/xl0/gpxe.git] / src / net / udp.c
1 #include <stdint.h>
2 #include <string.h>
3 #include <assert.h>
4 #include <byteswap.h>
5 #include <errno.h>
6 #include <gpxe/tcpip.h>
7 #include <gpxe/pkbuff.h>
8 #include <gpxe/netdevice.h>
9 #include <gpxe/udp.h>
10
11 /** @file
12  *
13  * UDP protocol
14  */
15
16 struct tcpip_protocol udp_protocol;
17
18 /**
19  * List of registered UDP connections
20  */
21 static LIST_HEAD ( udp_conns );
22
23 /**
24  * Bind UDP connection to local port
25  *
26  * @v conn              UDP connection
27  * @v local_port        Local port, in network byte order
28  * @ret rc              Return status code
29  */
30 int udp_bind ( struct udp_connection *conn, uint16_t local_port ) {
31         struct udp_connection *existing;
32
33         list_for_each_entry ( existing, &udp_conns, list ) {
34                 if ( existing->local_port == local_port )
35                         return -EADDRINUSE;
36         }
37         conn->local_port = local_port;
38         return 0;
39 }
40
41 /**
42  * Open a local port
43  *
44  * @v conn              UDP connection
45  * @v local_port        Local port, in network byte order, or zero
46  * @ret rc              Return status code
47  *
48  * Opens the UDP connection and binds to a local port.  If no local
49  * port is specified, the first available port will be used.
50  */
51 int udp_open ( struct udp_connection *conn, uint16_t local_port ) {
52         static uint16_t try_port = 1024;
53         int rc;
54
55         /* If no port specified, find the first available port */
56         if ( ! local_port ) {
57                 for ( ; try_port ; try_port++ ) {
58                         if ( try_port < 1024 )
59                                 continue;
60                         if ( udp_open ( conn, htons ( try_port ) ) == 0 )
61                                 return 0;
62                 }
63                 return -EADDRINUSE;
64         }
65
66         /* Attempt bind to local port */
67         if ( ( rc = udp_bind ( conn, local_port ) ) != 0 )
68                 return rc;
69
70         /* Add to UDP connection list */
71         list_add ( &conn->list, &udp_conns );
72         DBG ( "UDP opened %p on port %d\n", conn, ntohs ( local_port ) );
73
74         return 0;
75 }
76
77 /**
78  * Close a UDP connection
79  *
80  * @v conn              UDP connection
81  */
82 void udp_close ( struct udp_connection *conn ) {
83         list_del ( &conn->list );
84         DBG ( "UDP closed %p\n", conn );
85 }
86
87 /**
88  * User request to send data via a UDP connection
89  *
90  * @v conn              UDP connection
91  *
92  * This function allocates buffer space and invokes the function's senddata()
93  * callback. The callback may use the buffer space
94  */
95 int udp_senddata ( struct udp_connection *conn ) {
96         conn->tx_pkb = alloc_pkb ( UDP_MAX_TXPKB );
97         if ( conn->tx_pkb == NULL ) {
98                 DBG ( "UDP %p cannot allocate packet buffer of length %d\n",
99                       conn, UDP_MAX_TXPKB );
100                 return -ENOMEM;
101         }
102         pkb_reserve ( conn->tx_pkb, UDP_MAX_HLEN );
103         return conn->udp_op->senddata ( conn, conn->tx_pkb->data, 
104                                         pkb_available ( conn->tx_pkb ) );
105 }
106                 
107 /**
108  * Transmit data via a UDP connection to a specified address
109  *
110  * @v conn              UDP connection
111  * @v peer              Destination address
112  * @v data              Data to send
113  * @v len               Length of data
114  * @ret rc              Return status code
115  *
116  * This function fills up the UDP headers and sends the data.  It may
117  * be called only from within the context of an application's
118  * senddata() method; if the application wishes to send data it must
119  * call udp_senddata() and wait for its senddata() method to be
120  * called.
121  */
122 int udp_sendto ( struct udp_connection *conn, struct sockaddr_tcpip *peer,
123                  const void *data, size_t len ) {
124         struct udp_header *udphdr;
125
126         /* Avoid overflowing TX buffer */
127         if ( len > pkb_available ( conn->tx_pkb ) )
128                 len = pkb_available ( conn->tx_pkb );
129
130         /* Copy payload */
131         memmove ( pkb_put ( conn->tx_pkb, len ), data, len );
132
133         /*
134          * Add the UDP header
135          *
136          * Covert all 16- and 32- bit integers into network btye order before
137          * sending it over the network
138          */
139         udphdr = pkb_push ( conn->tx_pkb, sizeof ( *udphdr ) );
140         udphdr->dest_port = peer->st_port;
141         udphdr->source_port = conn->local_port;
142         udphdr->len = htons ( pkb_len ( conn->tx_pkb ) );
143         udphdr->chksum = 0;
144         udphdr->chksum = tcpip_chksum ( udphdr, sizeof ( *udphdr ) + len );
145
146         /* Dump debugging information */
147         DBG ( "UDP %p transmitting %p+%#zx len %#x src %d dest %d "
148               "chksum %#04x\n", conn, conn->tx_pkb->data,
149               pkb_len ( conn->tx_pkb ), ntohs ( udphdr->len ),
150               ntohs ( udphdr->source_port ), ntohs ( udphdr->dest_port ),
151               ntohs ( udphdr->chksum ) );
152
153         /* Send it to the next layer for processing */
154         return tcpip_tx ( conn->tx_pkb, &udp_protocol, peer );
155 }
156
157 /**
158  * Transmit data via a UDP connection
159  *
160  * @v conn              UDP connection
161  * @v data              Data to send
162  * @v len               Length of data
163  * @ret rc              Return status code
164  *
165  * This function fills up the UDP headers and sends the data.  It may
166  * be called only from within the context of an application's
167  * senddata() method; if the application wishes to send data it must
168  * call udp_senddata() and wait for its senddata() method to be
169  * called.
170  */
171 int udp_send ( struct udp_connection *conn, const void *data, size_t len ) {
172         return udp_sendto ( conn, &conn->peer, data, len );
173 }
174
175 /**
176  * Process a received packet
177  *
178  * @v pkb               Packet buffer
179  * @v st_src            Partially-filled source address
180  * @v st_dest           Partially-filled destination address
181  * @ret rc              Return status code
182  */
183 static int udp_rx ( struct pk_buff *pkb, struct sockaddr_tcpip *st_src,
184                     struct sockaddr_tcpip *st_dest ) {
185         struct udp_header *udphdr = pkb->data;
186         struct udp_connection *conn;
187         unsigned int ulen;
188         uint16_t chksum;
189
190         /* Sanity check */
191         if ( pkb_len ( pkb ) < sizeof ( *udphdr ) ) {
192                 DBG ( "UDP received underlength packet %p+%#zx\n",
193                       pkb->data, pkb_len ( pkb ) );
194                 return -EINVAL;
195         }
196
197         /* Dump debugging information */
198         DBG ( "UDP received %p+%#zx len %#x src %d dest %d chksum %#04x\n",
199               pkb->data, pkb_len ( pkb ), ntohs ( udphdr->len ),
200               ntohs ( udphdr->source_port ), ntohs ( udphdr->dest_port ),
201               ntohs ( udphdr->chksum ) );
202
203         /* Check length and trim any excess */
204         ulen = ntohs ( udphdr->len );
205         if ( ulen > pkb_len ( pkb ) ) {
206                 DBG ( "UDP received truncated packet %p+%#zx\n",
207                       pkb->data, pkb_len ( pkb ) );
208                 return -EINVAL;
209         }
210         pkb_unput ( pkb, ( pkb_len ( pkb ) - ulen ) );
211
212         /* Verify the checksum */
213 #warning "Don't we need to take the pseudo-header into account here?"
214 #if 0
215         chksum = tcpip_chksum ( pkb->data, pkb_len ( pkb ) );
216         if ( chksum != 0xffff ) {
217                 DBG ( "Bad checksum %#x\n", chksum );
218                 return -EINVAL;
219         }
220 #endif
221
222         /* Complete the socket addresses */
223         st_src->st_port = udphdr->source_port;
224         st_dest->st_port = udphdr->dest_port;
225
226         /* Demux the connection */
227         list_for_each_entry ( conn, &udp_conns, list ) {
228                 if ( conn->local_port &&
229                      ( conn->local_port != udphdr->dest_port ) ) {
230                         /* Bound to local port and local port doesn't match */
231                         continue;
232                 }
233                 
234                 /* Strip off the UDP header */
235                 pkb_pull ( pkb, sizeof ( *udphdr ) );
236
237                 DBG ( "UDP delivering to %p\n", conn );
238                 
239                 /* Call the application's callback */
240                 return conn->udp_op->newdata ( conn, pkb->data, pkb_len( pkb ),
241                                                st_src, st_dest );
242         }
243
244         DBG ( "No UDP connection listening on port %d\n",
245               ntohs ( udphdr->dest_port ) );
246         return 0;
247 }
248
249 struct tcpip_protocol udp_protocol  = {
250         .name = "UDP",
251         .rx = udp_rx,
252         .tcpip_proto = IP_UDP,
253         .csum_offset = 6,
254 };
255
256 TCPIP_PROTOCOL ( udp_protocol );