0fca99a4cbf529476890c4ecae8f8a2703fbf90a
[gpxe.git] / src / net / udp.c
1 #include <stdint.h>
2 #include <string.h>
3 #include <assert.h>
4 #include <byteswap.h>
5 #include <latch.h>
6 #include <errno.h>
7 #include <gpxe/in.h>
8 #include <gpxe/ip.h>
9 #include <gpxe/ip6.h>
10 #include <gpxe/udp.h>
11 #include <gpxe/init.h>
12 #include <gpxe/pkbuff.h>
13 #include <gpxe/netdevice.h>
14 #include <gpxe/tcpip_if.h>
15
16 /** @file
17  *
18  * UDP protocol
19  */
20
21 /**
22  * List of registered UDP connections
23  */
24 static LIST_HEAD ( udp_conns );
25
26 /**
27  * Some utility functions
28  */
29 static inline void copy_sockaddr ( struct sockaddr *source, struct sockaddr *dest ) {
30         memcpy ( dest, source, sizeof ( *dest ) );
31 }
32
33 static inline uint16_t * dest_port ( struct sockaddr *sock ) {
34         switch ( sock->sa_family ) {
35         case AF_INET:
36                 return &sock->sin.sin_port;
37         case AF_INET6:
38                 return &sock->sin6.sin6_port;
39         }
40         return NULL;
41 }
42
43 /**
44  * Dump the UDP header
45  *
46  * @v udphdr    UDP header
47  */
48 void udp_dump ( struct udp_header *udphdr ) {
49
50         /* Print UDP header for debugging */
51         DBG ( "UDP header at %#x + %d\n", udphdr, sizeof ( *udphdr ) );
52         DBG ( "\tSource Port = %d\n", ntohs ( udphdr->source_port ) );
53         DBG ( "\tDestination Port = %d\n", ntohs ( udphdr->dest_port ) );
54         DBG ( "\tLength = %d\n", ntohs ( udphdr->len ) );
55         DBG ( "\tChecksum = %x\n", ntohs ( udphdr->chksum ) );
56         DBG ( "\tChecksum located at %#x\n", &udphdr->chksum );
57 }
58
59 /**
60  * Open a UDP connection
61  *
62  * @v conn      UDP connection
63  * @v peer      Destination socket address
64  *
65  * This function stores the socket address within the connection
66  */
67 void udp_connect ( struct udp_connection *conn, struct sockaddr *peer ) {
68         copy_sockaddr ( peer, &conn->sin );
69
70         /* Not sure if this should add the connection to udp_conns; If it does,
71          * uncomment the following code
72          */
73 //      list_add ( &conn->list, &udp_conns );
74 }
75
76 /**
77  * Initialize a UDP connection
78  *
79  * @v conn      UDP connection
80  * @v udp_op    UDP operations
81  */
82 void udp_init ( struct udp_connection *conn, struct udp_operations *udp_op ) {
83         conn->local_port = 0;
84         conn->tx_pkb = NULL;
85         if ( udp_op != NULL ) {
86                 conn->udp_op = udp_op;
87         }
88 }
89
90 /**
91  * Allocate space to the UDP buffer
92  *
93  * @v conn      UDP connection
94  * @v len       Length to allocate
95  * @ret rc      Status
96  *
97  * Allocate "len" amount of space in the transmit buffer
98  */
99 int udp_buf_alloc ( struct udp_connection *conn, size_t len ) {
100         if ( conn->tx_pkb != NULL ) {
101                 free_pkb ( conn->tx_pkb );
102                 conn->tx_pkb = NULL;
103         }
104         conn->tx_pkb = alloc_pkb ( len < UDP_MIN_TXPKB ? UDP_MIN_TXPKB : len );
105         return !conn ? -ENOMEM : 0;
106 }
107
108 /**
109  * User request to send data via a UDP connection
110  *
111  * @v conn      UDP connection
112  *
113  * This function allocates buffer space and invokes the function's senddata()
114  * callback. The callback may use the buffer space
115  */
116 int udp_senddata ( struct udp_connection *conn ) {
117         conn->tx_pkb = pkb_alloc ( UDP_MAX_TXPKB );
118         if ( conn->tx_pkb == NULL ) {
119                 DBG ( "Error allocating packet buffer of length %d\n",
120                                                         UDP_MAX_TXPKB );
121                 return -ENOMEM;
122         }
123         conn->udp_op->senddata ( conn, conn->tx_pkb, pkb_len ( conn->tx_pkb ) );
124         return 0;
125 }
126                 
127
128 /**
129  * Transmit data via a UDP connection
130  *
131  * @v conn      UDP connection
132  * @v data      Data to send
133  * @v len       Length of data
134  *
135  * This function fills up the UDP headers and sends the data. Discover the
136  * network protocol through the sa_family field in the destination socket
137  * address.
138  */
139 int udp_send ( struct udp_connection *conn, const void *data, size_t len ) {
140         struct udp_header *udphdr;              /* UDP header */
141         struct sockaddr *sock = &conn->sin;     /* Destination sockaddr */
142         uint16_t *dest;
143         int rc;
144
145         /* Copy data into packet buffer, if necessary */
146         if ( data != conn->tx_pkb->data ) {
147                 /* Allocate space for data and lower layer headers */
148                 if ( ( rc = udp_buf_alloc ( conn, len + UDP_MAX_HLEN ) ) != 0 ) {
149                         DBG ( "Error allocating buffer" );
150                         return rc;
151                 }
152
153                 /* Reserve space for the headers and copy contents */
154                 pkb_reserve ( conn->tx_pkb, UDP_MAX_HLEN );
155                 memmove ( pkb_put ( conn->tx_pkb, len ), data, len );
156         }
157
158         /*
159          * Add the UDP header
160          *
161          * Covert all 16- and 32- bit integers into network btye order before
162          * sending it over the network
163          */
164         udphdr = pkb_push ( conn->tx_pkb, sizeof ( *udphdr ) );
165         if ( (dest = dest_port ( sock ) ) == NULL ) {
166                 DBG ( "Network family %d not supported\n", sock->sa_family );
167                 return -EAFNOSUPPORT;
168         }
169         udphdr->dest_port = *dest;
170         udphdr->source_port = conn->local_port;
171         udphdr->len = htons ( pkb_len ( conn->tx_pkb ) );
172         udphdr->chksum = htons ( calc_chksum ( udphdr, sizeof ( *udphdr ) ) );
173
174         udp_dump ( udphdr );
175
176         /* Send it to the next layer for processing */
177         return trans_tx ( conn->tx_pkb, &udp_protocol, sock );
178 }
179
180 /**
181  * Send data to a specified address
182  *
183  * @v conn      UDP connection
184  * @v peer      Destination address
185  * @v data      Data to send
186  * @v len       Length of data
187  */
188 int udp_sendto ( struct udp_connection *conn, struct sockaddr *peer,
189                  const void *data, size_t len ) {
190         struct sockaddr tempsock;
191         copy_sockaddr ( &conn->sin, &tempsock );
192         copy_sockaddr ( peer, &conn->sin );
193         int rc = udp_send ( conn, data, len );
194         copy_sockaddr ( &tempsock, &conn->sin );
195         return rc;
196 }
197
198 /**
199  * Close a UDP connection
200  *
201  * @v conn      UDP connection
202  */
203 void udp_close ( struct udp_connection *conn ) {
204         list_del ( &conn->list );
205 }
206
207 /**
208  * Open a local port
209  *
210  * @v conn              UDP connection
211  * @v local_port        Local port on which to open connection
212  *
213  * This does not support the 0 port option correctly yet
214  */
215 int udp_open ( struct udp_connection *conn, uint16_t local_port ) {
216         struct udp_connection *connr;
217         uint16_t min_port = 0xffff;
218
219         /* Iterate through udp_conns to see if local_port is available */
220         list_for_each_entry ( connr, &udp_conns, list ) {
221                 if ( connr->local_port == local_port ) {
222                         return -EISCONN;
223                 }
224                 if ( min_port > connr->local_port ) {
225                         min_port = connr->local_port;
226                 }
227         }
228         /* This code is buggy. I will update it soon :) */
229         conn->local_port = local_port == 0 ? min_port > 1024 ? 1024 :
230                                                 min_port + 1 : local_port;
231
232         /* Add the connection to the list of listening connections */
233         list_add ( &conn->list, &udp_conns );
234         return 0;
235 }
236
237 /**
238  * Process a received packet
239  *
240  * @v pkb              Packet buffer
241  * @v src_net_addr      Source network address
242  * @v dest_net_addr     Destination network address
243  */
244 void udp_rx ( struct pk_buff *pkb, struct in_addr *src_net_addr __unused,
245                         struct in_addr *dest_net_addr __unused ) {
246         struct udp_header *udphdr = pkb->data;
247         struct udp_connection *conn;
248         uint16_t ulen;
249         uint16_t chksum;
250
251         udp_dump ( udphdr );
252
253         /* Validate the packet and the UDP length */
254         if ( pkb_len ( pkb ) < sizeof ( *udphdr ) ) {
255                 DBG ( "UDP packet too short (%d bytes)\n",
256                       pkb_len ( pkb ) );
257                 return;
258         }
259
260         ulen = ntohs ( udphdr->len );
261         if ( ulen != pkb_len ( pkb ) ) {
262                 DBG ( "Inconsistent UDP packet length (%d bytes)\n",
263                       pkb_len ( pkb ) );
264                 return;
265         }
266
267         /* Verify the checksum */
268         chksum = calc_chksum ( pkb->data, pkb_len ( pkb ) );
269         if ( chksum != 0xffff ) {
270                 DBG ( "Bad checksum %d\n", chksum );
271                 return;
272         }
273
274         /* Todo: Check if it is a broadcast or multicast address */
275
276         /* Demux the connection */
277         list_for_each_entry ( conn, &udp_conns, list ) {
278                 if ( conn->local_port == ntohs ( udphdr->dest_port ) ) {
279                         goto conn;
280                 }
281         }
282         return;
283
284         conn:
285         /** Strip off the UDP header */
286         pkb_pull ( pkb, sizeof ( *udphdr ) );
287
288         /** Allocate max possible buffer space to the tx buffer */
289         conn->tx_pkb = alloc_pkb ( UDP_MAX_TXPKB );
290         pkb_reserve ( conn->tx_pkb, UDP_MAX_HLEN );
291
292         /** Call the application's callback */
293         conn->udp_op->newdata ( conn, pkb->data, ulen - sizeof ( *udphdr ) );
294 }
295
296 struct tcpip_protocol udp_protocol  = {
297         .name = "UDP",
298         .rx = udp_rx,
299         .trans_proto = IP_UDP,
300         .csum_offset = 6,
301 };
302
303 TCPIP_PROTOCOL ( udp_protocol );