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