Added features that will be required for PXE UDP support.
[gpxe.git] / src / net / ipv4.c
1 #include <string.h>
2 #include <stdint.h>
3 #include <errno.h>
4 #include <byteswap.h>
5 #include <malloc.h>
6 #include <vsprintf.h>
7 #include <gpxe/list.h>
8 #include <gpxe/in.h>
9 #include <gpxe/arp.h>
10 #include <gpxe/if_ether.h>
11 #include <gpxe/pkbuff.h>
12 #include <gpxe/netdevice.h>
13 #include "uip/uip.h"
14 #include <gpxe/ip.h>
15 #include <gpxe/tcpip.h>
16
17 /** @file
18  *
19  * IPv4 protocol
20  *
21  * The gPXE IP stack is currently implemented on top of the uIP
22  * protocol stack.  This file provides wrappers around uIP so that
23  * higher-level protocol implementations do not need to talk directly
24  * to uIP (which has a somewhat baroque API).
25  *
26  */
27
28 /* Unique IP datagram identification number */
29 static uint16_t next_ident = 0;
30
31 struct net_protocol ipv4_protocol;
32
33 /** An IPv4 address/routing table entry */
34 struct ipv4_miniroute {
35         /** List of miniroutes */
36         struct list_head list;
37         /** Network device */
38         struct net_device *netdev;
39         /** IPv4 address */
40         struct in_addr address;
41         /** Subnet mask */
42         struct in_addr netmask;
43         /** Gateway address */
44         struct in_addr gateway;
45 };
46
47 /** List of IPv4 miniroutes */
48 static LIST_HEAD ( miniroutes );
49
50 /** List of fragment reassembly buffers */
51 static LIST_HEAD ( frag_buffers );
52
53 /**
54  * Add IPv4 interface
55  *
56  * @v netdev    Network device
57  * @v address   IPv4 address
58  * @v netmask   Subnet mask
59  * @v gateway   Gateway address (or @c INADDR_NONE for no gateway)
60  * @ret rc      Return status code
61  *
62  */
63 int add_ipv4_address ( struct net_device *netdev, struct in_addr address,
64                        struct in_addr netmask, struct in_addr gateway ) {
65         struct ipv4_miniroute *miniroute;
66
67         /* Allocate and populate miniroute structure */
68         miniroute = malloc ( sizeof ( *miniroute ) );
69         if ( ! miniroute )
70                 return -ENOMEM;
71         miniroute->netdev = netdev;
72         miniroute->address = address;
73         miniroute->netmask = netmask;
74         miniroute->gateway = gateway;
75         
76         /* Add to end of list if we have a gateway, otherwise to start
77          * of list.
78          */
79         if ( gateway.s_addr != INADDR_NONE ) {
80                 list_add_tail ( &miniroute->list, &miniroutes );
81         } else {
82                 list_add ( &miniroute->list, &miniroutes );
83         }
84         return 0;
85 }
86
87 /**
88  * Remove IPv4 interface
89  *
90  * @v netdev    Network device
91  */
92 void del_ipv4_address ( struct net_device *netdev ) {
93         struct ipv4_miniroute *miniroute;
94
95         list_for_each_entry ( miniroute, &miniroutes, list ) {
96                 if ( miniroute->netdev == netdev ) {
97                         list_del ( &miniroute->list );
98                         break;
99                 }
100         }
101 }
102
103 /**
104  * Dump IPv4 packet header
105  *
106  * @v iphdr     IPv4 header
107  */
108 static void ipv4_dump ( struct iphdr *iphdr __unused ) {
109
110         DBG ( "IP4 header at %p+%#zx\n", iphdr, sizeof ( *iphdr ) );
111         DBG ( "\tVersion = %d\n", ( iphdr->verhdrlen & IP_MASK_VER ) / 16 );
112         DBG ( "\tHeader length = %d\n", iphdr->verhdrlen & IP_MASK_HLEN );
113         DBG ( "\tService = %d\n", iphdr->service );
114         DBG ( "\tTotal length = %d\n", ntohs ( iphdr->len ) );
115         DBG ( "\tIdent = %d\n", ntohs ( iphdr->ident ) );
116         DBG ( "\tFrags/Offset = %d\n", ntohs ( iphdr->frags ) );
117         DBG ( "\tIP TTL = %d\n", iphdr->ttl );
118         DBG ( "\tProtocol = %d\n", iphdr->protocol );
119         DBG ( "\tHeader Checksum (at %p) = %x\n", &iphdr->chksum, 
120                                 ntohs ( iphdr->chksum ) );
121         DBG ( "\tSource = %s\n", inet_ntoa ( iphdr->src ) );
122         DBG ( "\tDestination = %s\n", inet_ntoa ( iphdr->dest ) );
123 }
124
125 /**
126  * Fragment reassembly counter timeout
127  *
128  * @v timer     Retry timer
129  * @v over      If asserted, the timer is greater than @c MAX_TIMEOUT 
130  */
131 static void ipv4_frag_expired ( struct retry_timer *timer __unused,
132                                 int over ) {
133         if ( over ) {
134                 DBG ( "Fragment reassembly timeout" );
135                 /* Free the fragment buffer */
136         }
137 }
138
139 /**
140  * Free fragment buffer
141  *
142  * @v fragbug   Fragment buffer
143  */
144 static void free_fragbuf ( struct frag_buffer *fragbuf ) {
145         if ( fragbuf ) {
146                 free_dma ( fragbuf, sizeof ( *fragbuf ) );
147         }
148 }
149
150 /**
151  * Fragment reassembler
152  *
153  * @v pkb               Packet buffer, fragment of the datagram
154  * @ret frag_pkb        Reassembled packet, or NULL
155  */
156 static struct pk_buff * ipv4_reassemble ( struct pk_buff * pkb ) {
157         struct iphdr *iphdr = pkb->data;
158         struct frag_buffer *fragbuf;
159         
160         /**
161          * Check if the fragment belongs to any fragment series
162          */
163         list_for_each_entry ( fragbuf, &frag_buffers, list ) {
164                 if ( fragbuf->ident == iphdr->ident &&
165                      fragbuf->src.s_addr == iphdr->src.s_addr ) {
166                         /**
167                          * Check if the packet is the expected fragment
168                          * 
169                          * The offset of the new packet must be equal to the
170                          * length of the data accumulated so far (the length of
171                          * the reassembled packet buffer
172                          */
173                         if ( pkb_len ( fragbuf->frag_pkb ) == 
174                               ( iphdr->frags & IP_MASK_OFFSET ) ) {
175                                 /**
176                                  * Append the contents of the fragment to the
177                                  * reassembled packet buffer
178                                  */
179                                 pkb_pull ( pkb, sizeof ( *iphdr ) );
180                                 memcpy ( pkb_put ( fragbuf->frag_pkb,
181                                                         pkb_len ( pkb ) ),
182                                          pkb->data, pkb_len ( pkb ) );
183                                 free_pkb ( pkb );
184
185                                 /** Check if the fragment series is over */
186                                 if ( !iphdr->frags & IP_MASK_MOREFRAGS ) {
187                                         pkb = fragbuf->frag_pkb;
188                                         free_fragbuf ( fragbuf );
189                                         return pkb;
190                                 }
191
192                         } else {
193                                 /* Discard the fragment series */
194                                 free_fragbuf ( fragbuf );
195                                 free_pkb ( pkb );
196                         }
197                         return NULL;
198                 }
199         }
200         
201         /** Check if the fragment is the first in the fragment series */
202         if ( iphdr->frags & IP_MASK_MOREFRAGS &&
203                         ( ( iphdr->frags & IP_MASK_OFFSET ) == 0 ) ) {
204         
205                 /** Create a new fragment buffer */
206                 fragbuf = ( struct frag_buffer* ) malloc ( sizeof( *fragbuf ) );
207                 fragbuf->ident = iphdr->ident;
208                 fragbuf->src = iphdr->src;
209
210                 /* Set up the reassembly packet buffer */
211                 fragbuf->frag_pkb = alloc_pkb ( IP_FRAG_PKB_SIZE );
212                 pkb_pull ( pkb, sizeof ( *iphdr ) );
213                 memcpy ( pkb_put ( fragbuf->frag_pkb, pkb_len ( pkb ) ),
214                          pkb->data, pkb_len ( pkb ) );
215                 free_pkb ( pkb );
216
217                 /* Set the reassembly timer */
218                 fragbuf->frag_timer.timeout = IP_FRAG_TIMEOUT;
219                 fragbuf->frag_timer.expired = ipv4_frag_expired;
220                 start_timer ( &fragbuf->frag_timer );
221
222                 /* Add the fragment buffer to the list of fragment buffers */
223                 list_add ( &fragbuf->list, &frag_buffers );
224         }
225         
226         return NULL;
227 }
228
229
230 /**
231  * Complete the transport-layer checksum
232  *
233  * @v pkb       Packet buffer
234  * @v tcpip     Transport-layer protocol
235  *
236  * This function calculates the tcpip 
237  */
238 static void ipv4_tx_csum ( struct pk_buff *pkb,
239                            struct tcpip_protocol *tcpip ) {
240         struct iphdr *iphdr = pkb->data;
241         struct ipv4_pseudo_header pshdr;
242         uint16_t *csum = ( ( ( void * ) iphdr ) + sizeof ( *iphdr )
243                            + tcpip->csum_offset );
244
245         /* Calculate pseudo header */
246         pshdr.src = iphdr->src;
247         pshdr.dest = iphdr->dest;
248         pshdr.zero_padding = 0x00;
249         pshdr.protocol = iphdr->protocol;
250         pshdr.len = htons ( pkb_len ( pkb ) - sizeof ( *iphdr ) );
251
252         /* Update the checksum value */
253         *csum = tcpip_continue_chksum ( *csum, &pshdr, sizeof ( pshdr ) );
254 }
255
256 /**
257  * Calculate the transport-layer checksum while processing packets
258  */
259 static uint16_t ipv4_rx_csum ( struct pk_buff *pkb __unused,
260                                uint8_t trans_proto __unused ) {
261         /** 
262          * This function needs to be implemented. Until then, it will return
263          * 0xffffffff every time
264          */
265         return 0xffff;
266 }
267
268 /**
269  * Transmit IP packet
270  *
271  * @v pkb               Packet buffer
272  * @v tcpip             Transport-layer protocol
273  * @v st_dest           Destination network-layer address
274  * @ret rc              Status
275  *
276  * This function expects a transport-layer segment and prepends the IP header
277  */
278 static int ipv4_tx ( struct pk_buff *pkb,
279                      struct tcpip_protocol *tcpip_protocol,
280                      struct sockaddr_tcpip *st_dest ) {
281         struct iphdr *iphdr = pkb_push ( pkb, sizeof ( *iphdr ) );
282         struct sockaddr_in *sin_dest = ( ( struct sockaddr_in * ) st_dest );
283         struct ipv4_miniroute *miniroute;
284         struct net_device *netdev = NULL;
285         struct in_addr next_hop;
286         uint8_t ll_dest_buf[MAX_LL_ADDR_LEN];
287         const uint8_t *ll_dest = ll_dest_buf;
288         int rc;
289
290         /* Fill up the IP header, except source address */
291         iphdr->verhdrlen = ( IP_VER << 4 ) | ( sizeof ( *iphdr ) / 4 );
292         iphdr->service = IP_TOS;
293         iphdr->len = htons ( pkb_len ( pkb ) ); 
294         iphdr->ident = htons ( next_ident++ );
295         iphdr->frags = 0;
296         iphdr->ttl = IP_TTL;
297         iphdr->protocol = tcpip_protocol->tcpip_proto;
298
299         /* Copy destination address */
300         iphdr->dest = sin_dest->sin_addr;
301
302         /**
303          * All fields in the IP header filled in except the source network
304          * address (which requires routing) and the header checksum (which
305          * requires the source network address). As the pseudo header requires
306          * the source address as well and the transport-layer checksum is
307          * updated after routing.
308          */
309
310         /* Use routing table to identify next hop and transmitting netdev */
311         next_hop = iphdr->dest;
312         list_for_each_entry ( miniroute, &miniroutes, list ) {
313                 if ( ( ( ( iphdr->dest.s_addr ^ miniroute->address.s_addr ) &
314                          miniroute->netmask.s_addr ) == 0 ) ||
315                      ( miniroute->gateway.s_addr != INADDR_NONE ) ) {
316                         netdev = miniroute->netdev;
317                         iphdr->src = miniroute->address;
318                         if ( miniroute->gateway.s_addr != INADDR_NONE )
319                                 next_hop = miniroute->gateway;
320                         break;
321                 }
322         }
323         /* Abort if no network device identified */
324         if ( ! netdev ) {
325                 DBG ( "No route to %s\n", inet_ntoa ( iphdr->dest ) );
326                 rc = -EHOSTUNREACH;
327                 goto err;
328         }
329
330         /* Calculate the transport layer checksum */
331         if ( tcpip_protocol->csum_offset > 0 ) {
332                 ipv4_tx_csum ( pkb, tcpip_protocol );
333         }
334
335         /* Calculate header checksum, in network byte order */
336         iphdr->chksum = 0;
337         iphdr->chksum = tcpip_chksum ( iphdr, sizeof ( *iphdr ) );
338
339         /* Print IP4 header for debugging */
340         ipv4_dump ( iphdr );
341
342         /* Determine link-layer destination address */
343         if ( next_hop.s_addr == INADDR_BROADCAST ) {
344                 /* Broadcast address */
345                 ll_dest = netdev->ll_protocol->ll_broadcast;
346         } else if ( IN_MULTICAST ( next_hop.s_addr ) ) {
347                 /* Special case: IPv4 multicast over Ethernet.  This
348                  * code may need to be generalised once we find out
349                  * what happens for other link layers.
350                  */
351                 uint8_t *next_hop_bytes = ( uint8_t * ) &next_hop;
352                 ll_dest_buf[0] = 0x01;
353                 ll_dest_buf[0] = 0x00;
354                 ll_dest_buf[0] = 0x5e;
355                 ll_dest_buf[3] = next_hop_bytes[1] & 0x7f;
356                 ll_dest_buf[4] = next_hop_bytes[2];
357                 ll_dest_buf[5] = next_hop_bytes[3];
358         } else {
359                 /* Unicast address: resolve via ARP */
360                 if ( ( rc = arp_resolve ( netdev, &ipv4_protocol, &next_hop,
361                                           &iphdr->src, ll_dest_buf ) ) != 0 ) {
362                         DBG ( "No ARP entry for %s\n",
363                               inet_ntoa ( iphdr->dest ) );
364                         goto err;
365                 }
366         }
367
368         /* Hand off to link layer */
369         return net_tx ( pkb, netdev, &ipv4_protocol, ll_dest );
370
371  err:
372         free_pkb ( pkb );
373         return rc;
374 }
375
376 /**
377  * Process incoming packets
378  *
379  * @v pkb       Packet buffer
380  * @v netdev    Network device
381  * @v ll_source Link-layer destination source
382  *
383  * This function expects an IP4 network datagram. It processes the headers 
384  * and sends it to the transport layer.
385  */
386 static int ipv4_rx ( struct pk_buff *pkb, struct net_device *netdev __unused,
387                      const void *ll_source __unused ) {
388         struct iphdr *iphdr = pkb->data;
389         union {
390                 struct sockaddr_in sin;
391                 struct sockaddr_tcpip st;
392         } src, dest;
393         uint16_t chksum;
394
395         /* Sanity check */
396         if ( pkb_len ( pkb ) < sizeof ( *iphdr ) ) {
397                 DBG ( "IP datagram too short (%d bytes)\n",
398                         pkb_len ( pkb ) );
399                 return -EINVAL;
400         }
401
402         /* Print IP4 header for debugging */
403         ipv4_dump ( iphdr );
404
405         /* Validate version and header length */
406         if ( iphdr->verhdrlen != 0x45 ) {
407                 DBG ( "Bad version and header length %x\n", iphdr->verhdrlen );
408                 return -EINVAL;
409         }
410
411         /* Validate length of IP packet */
412         if ( ntohs ( iphdr->len ) > pkb_len ( pkb ) ) {
413                 DBG ( "Inconsistent packet length %d\n",
414                       ntohs ( iphdr->len ) );
415                 return -EINVAL;
416         }
417
418         /* Verify the checksum */
419         if ( ( chksum = ipv4_rx_csum ( pkb, iphdr->protocol ) ) != 0xffff ) {
420                 DBG ( "Bad checksum %x\n", chksum );
421         }
422         /* Fragment reassembly */
423         if ( iphdr->frags & IP_MASK_MOREFRAGS || 
424                 ( !iphdr->frags & IP_MASK_MOREFRAGS &&
425                         iphdr->frags & IP_MASK_OFFSET != 0 ) ) {
426                 /* Pass the fragment to the reassembler ipv4_ressable() which
427                  * either returns a fully reassembled packet buffer or NULL.
428                  */
429                 pkb = ipv4_reassemble ( pkb );
430                 if ( !pkb ) {
431                         return 0;
432                 }
433         }
434
435         /* To reduce code size, the following functions are not implemented:
436          * 1. Check the destination address
437          * 2. Check the TTL field
438          * 3. Check the service field
439          */
440
441         /* Construct socket addresses */
442         memset ( &src, 0, sizeof ( src ) );
443         src.sin.sin_family = AF_INET;
444         src.sin.sin_addr = iphdr->src;
445         memset ( &dest, 0, sizeof ( dest ) );
446         dest.sin.sin_family = AF_INET;
447         dest.sin.sin_addr = iphdr->dest;
448
449         /* Strip header */
450         pkb_pull ( pkb, sizeof ( *iphdr ) );
451
452         /* Send it to the transport layer */
453         return tcpip_rx ( pkb, iphdr->protocol, &src.st, &dest.st );
454 }
455
456 /** 
457  * Check existence of IPv4 address for ARP
458  *
459  * @v netdev            Network device
460  * @v net_addr          Network-layer address
461  * @ret rc              Return status code
462  */
463 static int ipv4_arp_check ( struct net_device *netdev, const void *net_addr ) {
464         const struct in_addr *address = net_addr;
465         struct ipv4_miniroute *miniroute;
466
467         list_for_each_entry ( miniroute, &miniroutes, list ) {
468                 if ( ( miniroute->netdev == netdev ) &&
469                      ( miniroute->address.s_addr == address->s_addr ) ) {
470                         /* Found matching address */
471                         return 0;
472                 }
473         }
474         return -ENOENT;
475 }
476
477 /**
478  * Convert IPv4 address to dotted-quad notation
479  *
480  * @v in        IP address
481  * @ret string  IP address in dotted-quad notation
482  */
483 char * inet_ntoa ( struct in_addr in ) {
484         static char buf[16]; /* "xxx.xxx.xxx.xxx" */
485         uint8_t *bytes = ( uint8_t * ) &in;
486         
487         sprintf ( buf, "%d.%d.%d.%d", bytes[0], bytes[1], bytes[2], bytes[3] );
488         return buf;
489 }
490
491 /**
492  * Transcribe IP address
493  *
494  * @v net_addr  IP address
495  * @ret string  IP address in dotted-quad notation
496  *
497  */
498 static const char * ipv4_ntoa ( const void *net_addr ) {
499         return inet_ntoa ( * ( ( struct in_addr * ) net_addr ) );
500 }
501
502 /** IPv4 protocol */
503 struct net_protocol ipv4_protocol = {
504         .name = "IP",
505         .net_proto = htons ( ETH_P_IP ),
506         .net_addr_len = sizeof ( struct in_addr ),
507         .rx = ipv4_rx,
508         .ntoa = ipv4_ntoa,
509 };
510
511 NET_PROTOCOL ( ipv4_protocol );
512
513 /** IPv4 TCPIP net protocol */
514 struct tcpip_net_protocol ipv4_tcpip_protocol = {
515         .name = "IPv4",
516         .sa_family = AF_INET,
517         .tx = ipv4_tx,
518 };
519
520 TCPIP_NET_PROTOCOL ( ipv4_tcpip_protocol );
521
522 /** IPv4 ARP protocol */
523 struct arp_net_protocol ipv4_arp_protocol = {
524         .net_protocol = &ipv4_protocol,
525         .check = ipv4_arp_check,
526 };
527
528 ARP_NET_PROTOCOL ( ipv4_arp_protocol );