4190ef739210cb98033561a46331e0508849e295
[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 void ipv4_frag_expired ( struct retry_timer *timer __unused , int over ) {
132         if ( over ) {
133                 DBG ( "Fragment reassembly timeout" );
134                 /* Free the fragment buffer */
135         }
136 }
137
138 /**
139  * Free fragment buffer
140  *
141  * @v fragbug   Fragment buffer
142  */
143 void free_fragbuf ( struct frag_buffer *fragbuf ) {
144         if ( fragbuf ) {
145                 free_dma ( fragbuf, sizeof ( *fragbuf ) );
146         }
147 }
148
149 /**
150  * Fragment reassembler
151  *
152  * @v pkb               Packet buffer, fragment of the datagram
153  * @ret frag_pkb        Reassembled packet, or NULL
154  */
155 struct pk_buff * ipv4_reassemble ( struct pk_buff * pkb ) {
156         struct iphdr *iphdr = pkb->data;
157         struct frag_buffer *fragbuf;
158         
159         /**
160          * Check if the fragment belongs to any fragment series
161          */
162         list_for_each_entry ( fragbuf, &frag_buffers, list ) {
163                 if ( fragbuf->ident == iphdr->ident &&
164                      fragbuf->src.s_addr == iphdr->src.s_addr ) {
165                         /**
166                          * Check if the packet is the expected fragment
167                          * 
168                          * The offset of the new packet must be equal to the
169                          * length of the data accumulated so far (the length of
170                          * the reassembled packet buffer
171                          */
172                         if ( pkb_len ( fragbuf->frag_pkb ) == 
173                               ( iphdr->frags & IP_MASK_OFFSET ) ) {
174                                 /**
175                                  * Append the contents of the fragment to the
176                                  * reassembled packet buffer
177                                  */
178                                 pkb_pull ( pkb, sizeof ( *iphdr ) );
179                                 memcpy ( pkb_put ( fragbuf->frag_pkb,
180                                                         pkb_len ( pkb ) ),
181                                          pkb->data, pkb_len ( pkb ) );
182                                 free_pkb ( pkb );
183
184                                 /** Check if the fragment series is over */
185                                 if ( !iphdr->frags & IP_MASK_MOREFRAGS ) {
186                                         pkb = fragbuf->frag_pkb;
187                                         free_fragbuf ( fragbuf );
188                                         return pkb;
189                                 }
190
191                         } else {
192                                 /* Discard the fragment series */
193                                 free_fragbuf ( fragbuf );
194                                 free_pkb ( pkb );
195                         }
196                         return NULL;
197                 }
198         }
199         
200         /** Check if the fragment is the first in the fragment series */
201         if ( iphdr->frags & IP_MASK_MOREFRAGS &&
202                         ( ( iphdr->frags & IP_MASK_OFFSET ) == 0 ) ) {
203         
204                 /** Create a new fragment buffer */
205                 fragbuf = ( struct frag_buffer* ) malloc ( sizeof( *fragbuf ) );
206                 fragbuf->ident = iphdr->ident;
207                 fragbuf->src = iphdr->src;
208
209                 /* Set up the reassembly packet buffer */
210                 fragbuf->frag_pkb = alloc_pkb ( IP_FRAG_PKB_SIZE );
211                 pkb_pull ( pkb, sizeof ( *iphdr ) );
212                 memcpy ( pkb_put ( fragbuf->frag_pkb, pkb_len ( pkb ) ),
213                          pkb->data, pkb_len ( pkb ) );
214                 free_pkb ( pkb );
215
216                 /* Set the reassembly timer */
217                 fragbuf->frag_timer.timeout = IP_FRAG_TIMEOUT;
218                 fragbuf->frag_timer.expired = ipv4_frag_expired;
219                 start_timer ( &fragbuf->frag_timer );
220
221                 /* Add the fragment buffer to the list of fragment buffers */
222                 list_add ( &fragbuf->list, &frag_buffers );
223         }
224         
225         return NULL;
226 }
227
228
229 /**
230  * Complete the transport-layer checksum
231  *
232  * @v pkb       Packet buffer
233  * @v tcpip     Transport-layer protocol
234  *
235  * This function calculates the tcpip 
236  */
237 void ipv4_tx_csum ( struct pk_buff *pkb, struct tcpip_protocol *tcpip ) {
238
239         struct iphdr *iphdr = pkb->data;
240         struct ipv4_pseudo_header pshdr;
241         uint16_t *csum = ( ( ( void * ) iphdr ) + sizeof ( *iphdr )
242                            + tcpip->csum_offset );
243
244         /* Calculate pseudo header */
245         pshdr.src = iphdr->src;
246         pshdr.dest = iphdr->dest;
247         pshdr.zero_padding = 0x00;
248         pshdr.protocol = iphdr->protocol;
249         pshdr.len = htons ( pkb_len ( pkb ) - sizeof ( *iphdr ) );
250
251         /* Update the checksum value */
252         *csum = tcpip_continue_chksum ( *csum, &pshdr, sizeof ( pshdr ) );
253 }
254
255 /**
256  * Calculate the transport-layer checksum while processing packets
257  */
258 uint16_t ipv4_rx_csum ( struct pk_buff *pkb __unused,
259                         uint8_t trans_proto __unused ) {
260         /** 
261          * This function needs to be implemented. Until then, it will return
262          * 0xffffffff every time
263          */
264         return 0xffff;
265 }
266
267 /**
268  * Transmit packet constructed by uIP
269  *
270  * @v pkb               Packet buffer
271  * @ret rc              Return status code
272  *
273  */
274 int ipv4_uip_tx ( struct pk_buff *pkb ) {
275         struct iphdr *iphdr = pkb->data;
276         struct ipv4_miniroute *miniroute;
277         struct net_device *netdev = NULL;
278         struct in_addr next_hop;
279         struct in_addr source;
280         uint8_t ll_dest_buf[MAX_LL_ADDR_LEN];
281         const uint8_t *ll_dest = ll_dest_buf;
282         int rc;
283
284         /* Use routing table to identify next hop and transmitting netdev */
285         next_hop = iphdr->dest;
286         list_for_each_entry ( miniroute, &miniroutes, list ) {
287                 if ( ( ( ( iphdr->dest.s_addr ^ miniroute->address.s_addr ) &
288                          miniroute->netmask.s_addr ) == 0 ) ||
289                      ( miniroute->gateway.s_addr != INADDR_NONE ) ) {
290                         netdev = miniroute->netdev;
291                         source = miniroute->address;
292                         if ( miniroute->gateway.s_addr != INADDR_NONE )
293                                 next_hop = miniroute->gateway;
294                         break;
295                 }
296         }
297
298         /* Abort if no network device identified */
299         if ( ! netdev ) {
300                 DBG ( "No route to %s\n", inet_ntoa ( iphdr->dest ) );
301                 rc = -EHOSTUNREACH;
302                 goto err;
303         }
304
305         /* Determine link-layer destination address */
306         if ( next_hop.s_addr == INADDR_BROADCAST ) {
307                 /* Broadcast address */
308                 ll_dest = netdev->ll_protocol->ll_broadcast;
309         } else if ( IN_MULTICAST ( next_hop.s_addr ) ) {
310                 /* Special case: IPv4 multicast over Ethernet.  This
311                  * code may need to be generalised once we find out
312                  * what happens for other link layers.
313                  */
314                 uint8_t *next_hop_bytes = ( uint8_t * ) &next_hop;
315                 ll_dest_buf[0] = 0x01;
316                 ll_dest_buf[0] = 0x00;
317                 ll_dest_buf[0] = 0x5e;
318                 ll_dest_buf[3] = next_hop_bytes[1] & 0x7f;
319                 ll_dest_buf[4] = next_hop_bytes[2];
320                 ll_dest_buf[5] = next_hop_bytes[3];
321         } else {
322                 /* Unicast address: resolve via ARP */
323                 if ( ( rc = arp_resolve ( netdev, &ipv4_protocol, &next_hop,
324                                           &source, ll_dest_buf ) ) != 0 ) {
325                         DBG ( "No ARP entry for %s\n",
326                               inet_ntoa ( iphdr->dest ) );
327                         goto err;
328                 }
329         }
330         
331         /* Hand off to link layer */
332         return net_tx ( pkb, netdev, &ipv4_protocol, ll_dest );
333
334  err:
335         free_pkb ( pkb );
336         return rc;
337 }
338
339 /**
340  * Transmit IP packet (without uIP)
341  *
342  * @v pkb               Packet buffer
343  * @v tcpip             Transport-layer protocol
344  * @v dest              Destination network-layer address
345  * @ret rc              Status
346  *
347  * This function expects a transport-layer segment and prepends the IP header
348  */
349 int ipv4_tx ( struct pk_buff *pkb, struct tcpip_protocol *tcpip,
350               struct in_addr *dest ) {
351         struct iphdr *iphdr = pkb_push ( pkb, sizeof ( *iphdr ) );
352         struct ipv4_miniroute *miniroute;
353         struct net_device *netdev = NULL;
354         struct in_addr next_hop;
355         uint8_t ll_dest_buf[MAX_LL_ADDR_LEN];
356         const uint8_t *ll_dest = ll_dest_buf;
357         int rc;
358
359         /* Fill up the IP header, except source address */
360         iphdr->verhdrlen = ( IP_VER << 4 ) | ( sizeof ( *iphdr ) / 4 );
361         iphdr->service = IP_TOS;
362         iphdr->len = htons ( pkb_len ( pkb ) ); 
363         iphdr->ident = htons ( next_ident++ );
364         iphdr->frags = 0;
365         iphdr->ttl = IP_TTL;
366         iphdr->protocol = tcpip->trans_proto;
367
368         /* Copy destination address */
369         iphdr->dest = *dest;
370
371         /**
372          * All fields in the IP header filled in except the source network
373          * address (which requires routing) and the header checksum (which
374          * requires the source network address). As the pseudo header requires
375          * the source address as well and the transport-layer checksum is
376          * updated after routing.
377          *
378          * Continue processing as in ipv4_uip_tx()
379          */
380
381         /* Use routing table to identify next hop and transmitting netdev */
382         next_hop = iphdr->dest;
383         list_for_each_entry ( miniroute, &miniroutes, list ) {
384                 if ( ( ( ( iphdr->dest.s_addr ^ miniroute->address.s_addr ) &
385                          miniroute->netmask.s_addr ) == 0 ) ||
386                      ( miniroute->gateway.s_addr != INADDR_NONE ) ) {
387                         netdev = miniroute->netdev;
388                         iphdr->src = miniroute->address;
389                         if ( miniroute->gateway.s_addr != INADDR_NONE )
390                                 next_hop = miniroute->gateway;
391                         break;
392                 }
393         }
394         /* Abort if no network device identified */
395         if ( ! netdev ) {
396                 DBG ( "No route to %s\n", inet_ntoa ( iphdr->dest ) );
397                 rc = -EHOSTUNREACH;
398                 goto err;
399         }
400
401         /* Calculate the transport layer checksum */
402         if ( tcpip->csum_offset > 0 ) {
403                 ipv4_tx_csum ( pkb, tcpip );
404         }
405
406         /* Calculate header checksum, in network byte order */
407         iphdr->chksum = 0;
408         iphdr->chksum = tcpip_chksum ( iphdr, sizeof ( *iphdr ) );
409
410         /* Print IP4 header for debugging */
411         ipv4_dump ( iphdr );
412
413         /* Determine link-layer destination address */
414         if ( next_hop.s_addr == INADDR_BROADCAST ) {
415                 /* Broadcast address */
416                 ll_dest = netdev->ll_protocol->ll_broadcast;
417         } else if ( IN_MULTICAST ( next_hop.s_addr ) ) {
418                 /* Special case: IPv4 multicast over Ethernet.  This
419                  * code may need to be generalised once we find out
420                  * what happens for other link layers.
421                  */
422                 uint8_t *next_hop_bytes = ( uint8_t * ) &next_hop;
423                 ll_dest_buf[0] = 0x01;
424                 ll_dest_buf[0] = 0x00;
425                 ll_dest_buf[0] = 0x5e;
426                 ll_dest_buf[3] = next_hop_bytes[1] & 0x7f;
427                 ll_dest_buf[4] = next_hop_bytes[2];
428                 ll_dest_buf[5] = next_hop_bytes[3];
429         } else {
430                 /* Unicast address: resolve via ARP */
431                 if ( ( rc = arp_resolve ( netdev, &ipv4_protocol, &next_hop,
432                                           &iphdr->src, ll_dest_buf ) ) != 0 ) {
433                         DBG ( "No ARP entry for %s\n",
434                               inet_ntoa ( iphdr->dest ) );
435                         goto err;
436                 }
437         }
438
439         /* Hand off to link layer */
440         return net_tx ( pkb, netdev, &ipv4_protocol, ll_dest );
441
442  err:
443         free_pkb ( pkb );
444         return rc;
445 }
446
447 /**
448  * Process incoming IP packets
449  *
450  * @v pkb               Packet buffer
451  * @v netdev            Network device
452  * @v ll_source         Link-layer source address
453  * @ret rc              Return status code
454  *
455  * This handles IP packets by handing them off to the uIP protocol
456  * stack.
457  */
458 static int ipv4_uip_rx ( struct pk_buff *pkb,
459                          struct net_device *netdev __unused,
460                          const void *ll_source __unused ) {
461
462         /* Transfer to uIP buffer.  Horrendously space-inefficient,
463          * but will do as a proof-of-concept for now.
464          */
465         uip_len = pkb_len ( pkb );
466         memcpy ( uip_buf, pkb->data, uip_len );
467         free_pkb ( pkb );
468
469         /* Hand to uIP for processing */
470         uip_input ();
471         if ( uip_len > 0 ) {
472                 pkb = alloc_pkb ( MAX_LL_HEADER_LEN + uip_len );
473                 if ( ! pkb )
474                         return -ENOMEM;
475                 pkb_reserve ( pkb, MAX_LL_HEADER_LEN );
476                 memcpy ( pkb_put ( pkb, uip_len ), uip_buf, uip_len );
477                 ipv4_uip_tx ( pkb );
478         }
479         return 0;
480 }
481
482 /**
483  * Process incoming packets (without uIP)
484  *
485  * @v pkb       Packet buffer
486  * @v netdev    Network device
487  * @v ll_source Link-layer destination source
488  *
489  * This function expects an IP4 network datagram. It processes the headers 
490  * and sends it to the transport layer.
491  */
492 void ipv4_rx ( struct pk_buff *pkb, struct net_device *netdev __unused,
493                         const void *ll_source __unused ) {
494         struct iphdr *iphdr = pkb->data;
495         struct in_addr *src = &iphdr->src;
496         struct in_addr *dest = &iphdr->dest;
497         uint16_t chksum;
498
499         /* Sanity check */
500         if ( pkb_len ( pkb ) < sizeof ( *iphdr ) ) {
501                 DBG ( "IP datagram too short (%d bytes)\n",
502                         pkb_len ( pkb ) );
503                 return;
504         }
505
506         /* Print IP4 header for debugging */
507         ipv4_dump ( iphdr );
508
509         /* Validate version and header length */
510         if ( iphdr->verhdrlen != 0x45 ) {
511                 DBG ( "Bad version and header length %x\n", iphdr->verhdrlen );
512                 return;
513         }
514
515         /* Validate length of IP packet */
516         if ( ntohs ( iphdr->len ) != pkb_len ( pkb ) ) {
517                 DBG ( "Inconsistent packet length %d\n",
518                                         ntohs ( iphdr->len ) );
519                 return;
520         }
521
522         /* Verify the checksum */
523         if ( ( chksum = ipv4_rx_csum ( pkb, iphdr->protocol ) ) != 0xffff ) {
524                 DBG ( "Bad checksum %x\n", chksum );
525         }
526         /* Fragment reassembly */
527         if ( iphdr->frags & IP_MASK_MOREFRAGS || 
528                 ( !iphdr->frags & IP_MASK_MOREFRAGS &&
529                         iphdr->frags & IP_MASK_OFFSET != 0 ) ) {
530                 /* Pass the fragment to the reassembler ipv4_ressable() which
531                  * either returns a fully reassembled packet buffer or NULL.
532                  */
533                 pkb = ipv4_reassemble ( pkb );
534                 if ( !pkb ) {
535                         return;
536                 }
537         }
538
539         /* To reduce code size, the following functions are not implemented:
540          * 1. Check the destination address
541          * 2. Check the TTL field
542          * 3. Check the service field
543          */
544
545         /* Strip header */
546         pkb_pull ( pkb, sizeof ( *iphdr ) );
547
548         /* Send it to the transport layer */
549         tcpip_rx ( pkb, iphdr->protocol, src, dest );
550 }
551
552 /** 
553  * Check existence of IPv4 address for ARP
554  *
555  * @v netdev            Network device
556  * @v net_addr          Network-layer address
557  * @ret rc              Return status code
558  */
559 static int ipv4_arp_check ( struct net_device *netdev, const void *net_addr ) {
560         const struct in_addr *address = net_addr;
561         struct ipv4_miniroute *miniroute;
562
563         list_for_each_entry ( miniroute, &miniroutes, list ) {
564                 if ( ( miniroute->netdev == netdev ) &&
565                      ( miniroute->address.s_addr == address->s_addr ) ) {
566                         /* Found matching address */
567                         return 0;
568                 }
569         }
570         return -ENOENT;
571 }
572
573 /**
574  * Convert IPv4 address to dotted-quad notation
575  *
576  * @v in        IP address
577  * @ret string  IP address in dotted-quad notation
578  */
579 char * inet_ntoa ( struct in_addr in ) {
580         static char buf[16]; /* "xxx.xxx.xxx.xxx" */
581         uint8_t *bytes = ( uint8_t * ) &in;
582         
583         sprintf ( buf, "%d.%d.%d.%d", bytes[0], bytes[1], bytes[2], bytes[3] );
584         return buf;
585 }
586
587 /**
588  * Transcribe IP address
589  *
590  * @v net_addr  IP address
591  * @ret string  IP address in dotted-quad notation
592  *
593  */
594 static const char * ipv4_ntoa ( const void *net_addr ) {
595         return inet_ntoa ( * ( ( struct in_addr * ) net_addr ) );
596 }
597
598 /** IPv4 protocol */
599 struct net_protocol ipv4_protocol = {
600         .name = "IP",
601         .net_proto = htons ( ETH_P_IP ),
602         .net_addr_len = sizeof ( struct in_addr ),
603 #if USE_UIP
604         .rx = ipv4_uip_rx,
605 #else
606         .rx = ipv4_rx,
607 #endif
608         .ntoa = ipv4_ntoa,
609 };
610
611 NET_PROTOCOL ( ipv4_protocol );
612
613 /** IPv4 TCPIP net protocol */
614 struct tcpip_net_protocol ipv4_tcpip_protocol = {
615         .net_protocol = &ipv4_protocol,
616         .tx_csum = ipv4_tx_csum,
617 };
618
619 TCPIP_NET_PROTOCOL ( ipv4_tcpip_protocol );
620
621 /** IPv4 ARP protocol */
622 struct arp_net_protocol ipv4_arp_protocol = {
623         .net_protocol = &ipv4_protocol,
624         .check = ipv4_arp_check,
625 };
626
627 ARP_NET_PROTOCOL ( ipv4_arp_protocol );