da16452fdaecca8b4301c108e39ffaf3d79c9d9a
[people/xl0/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 %p transmitting %p+%d ident %d protocol %d header-csum %x\n",
111                 &ipv4_protocol, iphdr, ntohs ( iphdr->len ), ntohs ( iphdr->ident ),
112                 iphdr->protocol, ntohs ( iphdr->chksum ) );
113         DBG ( "src %s, dest %s\n", inet_ntoa ( iphdr->src ), inet_ntoa ( iphdr->dest ) );
114 }
115
116 /**
117  * Fragment reassembly counter timeout
118  *
119  * @v timer     Retry timer
120  * @v over      If asserted, the timer is greater than @c MAX_TIMEOUT 
121  */
122 static void ipv4_frag_expired ( struct retry_timer *timer __unused,
123                                 int over ) {
124         if ( over ) {
125                 DBG ( "Fragment reassembly timeout" );
126                 /* Free the fragment buffer */
127         }
128 }
129
130 /**
131  * Free fragment buffer
132  *
133  * @v fragbug   Fragment buffer
134  */
135 static void free_fragbuf ( struct frag_buffer *fragbuf ) {
136         if ( fragbuf ) {
137                 free_dma ( fragbuf, sizeof ( *fragbuf ) );
138         }
139 }
140
141 /**
142  * Fragment reassembler
143  *
144  * @v pkb               Packet buffer, fragment of the datagram
145  * @ret frag_pkb        Reassembled packet, or NULL
146  */
147 static struct pk_buff * ipv4_reassemble ( struct pk_buff * pkb ) {
148         struct iphdr *iphdr = pkb->data;
149         struct frag_buffer *fragbuf;
150         
151         /**
152          * Check if the fragment belongs to any fragment series
153          */
154         list_for_each_entry ( fragbuf, &frag_buffers, list ) {
155                 if ( fragbuf->ident == iphdr->ident &&
156                      fragbuf->src.s_addr == iphdr->src.s_addr ) {
157                         /**
158                          * Check if the packet is the expected fragment
159                          * 
160                          * The offset of the new packet must be equal to the
161                          * length of the data accumulated so far (the length of
162                          * the reassembled packet buffer
163                          */
164                         if ( pkb_len ( fragbuf->frag_pkb ) == 
165                               ( iphdr->frags & IP_MASK_OFFSET ) ) {
166                                 /**
167                                  * Append the contents of the fragment to the
168                                  * reassembled packet buffer
169                                  */
170                                 pkb_pull ( pkb, sizeof ( *iphdr ) );
171                                 memcpy ( pkb_put ( fragbuf->frag_pkb,
172                                                         pkb_len ( pkb ) ),
173                                          pkb->data, pkb_len ( pkb ) );
174                                 free_pkb ( pkb );
175
176                                 /** Check if the fragment series is over */
177                                 if ( !iphdr->frags & IP_MASK_MOREFRAGS ) {
178                                         pkb = fragbuf->frag_pkb;
179                                         free_fragbuf ( fragbuf );
180                                         return pkb;
181                                 }
182
183                         } else {
184                                 /* Discard the fragment series */
185                                 free_fragbuf ( fragbuf );
186                                 free_pkb ( pkb );
187                         }
188                         return NULL;
189                 }
190         }
191         
192         /** Check if the fragment is the first in the fragment series */
193         if ( iphdr->frags & IP_MASK_MOREFRAGS &&
194                         ( ( iphdr->frags & IP_MASK_OFFSET ) == 0 ) ) {
195         
196                 /** Create a new fragment buffer */
197                 fragbuf = ( struct frag_buffer* ) malloc ( sizeof( *fragbuf ) );
198                 fragbuf->ident = iphdr->ident;
199                 fragbuf->src = iphdr->src;
200
201                 /* Set up the reassembly packet buffer */
202                 fragbuf->frag_pkb = alloc_pkb ( IP_FRAG_PKB_SIZE );
203                 pkb_pull ( pkb, sizeof ( *iphdr ) );
204                 memcpy ( pkb_put ( fragbuf->frag_pkb, pkb_len ( pkb ) ),
205                          pkb->data, pkb_len ( pkb ) );
206                 free_pkb ( pkb );
207
208                 /* Set the reassembly timer */
209                 fragbuf->frag_timer.timeout = IP_FRAG_TIMEOUT;
210                 fragbuf->frag_timer.expired = ipv4_frag_expired;
211                 start_timer ( &fragbuf->frag_timer );
212
213                 /* Add the fragment buffer to the list of fragment buffers */
214                 list_add ( &fragbuf->list, &frag_buffers );
215         }
216         
217         return NULL;
218 }
219
220
221 /**
222  * Complete the transport-layer checksum
223  *
224  * @v pkb       Packet buffer
225  * @v tcpip     Transport-layer protocol
226  *
227  * This function calculates the tcpip 
228  */
229 static void ipv4_tx_csum ( struct pk_buff *pkb,
230                            struct tcpip_protocol *tcpip ) {
231         struct iphdr *iphdr = pkb->data;
232         struct ipv4_pseudo_header pshdr;
233         uint16_t *csum = ( ( ( void * ) iphdr ) + sizeof ( *iphdr )
234                            + tcpip->csum_offset );
235
236         /* Calculate pseudo header */
237         pshdr.src = iphdr->src;
238         pshdr.dest = iphdr->dest;
239         pshdr.zero_padding = 0x00;
240         pshdr.protocol = iphdr->protocol;
241         /* This is only valid when IPv4 does not have options */
242         pshdr.len = htons ( pkb_len ( pkb ) - sizeof ( *iphdr ) );
243
244         /* Update the checksum value */
245         *csum = tcpip_continue_chksum ( *csum, &pshdr, sizeof ( pshdr ) );
246 }
247
248 /**
249  * Calculate the transport-layer checksum while processing packets
250  */
251 static uint16_t ipv4_rx_csum ( struct pk_buff *pkb __unused,
252                                uint8_t trans_proto __unused ) {
253         /** 
254          * This function needs to be implemented. Until then, it will return
255          * 0xffffffff every time
256          */
257         return 0xffff;
258 }
259
260 /**
261  * Transmit IP packet
262  *
263  * @v pkb               Packet buffer
264  * @v tcpip             Transport-layer protocol
265  * @v st_dest           Destination network-layer address
266  * @ret rc              Status
267  *
268  * This function expects a transport-layer segment and prepends the IP header
269  */
270 static int ipv4_tx ( struct pk_buff *pkb,
271                      struct tcpip_protocol *tcpip_protocol,
272                      struct sockaddr_tcpip *st_dest ) {
273         struct iphdr *iphdr = pkb_push ( pkb, sizeof ( *iphdr ) );
274         struct sockaddr_in *sin_dest = ( ( struct sockaddr_in * ) st_dest );
275         struct ipv4_miniroute *miniroute;
276         struct net_device *netdev = NULL;
277         struct in_addr next_hop;
278         uint8_t ll_dest_buf[MAX_LL_ADDR_LEN];
279         const uint8_t *ll_dest = ll_dest_buf;
280         int rc;
281
282         /* Fill up the IP header, except source address */
283         iphdr->verhdrlen = ( IP_VER << 4 ) | ( sizeof ( *iphdr ) / 4 );
284         iphdr->service = IP_TOS;
285         iphdr->len = htons ( pkb_len ( pkb ) ); 
286         iphdr->ident = htons ( next_ident++ );
287         iphdr->frags = 0;
288         iphdr->ttl = IP_TTL;
289         iphdr->protocol = tcpip_protocol->tcpip_proto;
290
291         /* Copy destination address */
292         iphdr->dest = sin_dest->sin_addr;
293
294         /**
295          * All fields in the IP header filled in except the source network
296          * address (which requires routing) and the header checksum (which
297          * requires the source network address). As the pseudo header requires
298          * the source address as well and the transport-layer checksum is
299          * updated after routing.
300          */
301
302         /* Use routing table to identify next hop and transmitting netdev */
303         next_hop = iphdr->dest;
304         list_for_each_entry ( miniroute, &miniroutes, list ) {
305                 int local, has_gw;
306
307                 local = ( ( ( iphdr->dest.s_addr ^ miniroute->address.s_addr )
308                             & miniroute->netmask.s_addr ) == 0 );
309                 has_gw = ( miniroute->gateway.s_addr != INADDR_NONE );
310                 if ( local || has_gw ) {
311                         netdev = miniroute->netdev;
312                         iphdr->src = miniroute->address;
313                         if ( ! local )
314                                 next_hop = miniroute->gateway;
315                         break;
316                 }
317         }
318         /* Abort if no network device identified */
319         if ( ! netdev ) {
320                 DBG ( "No route to %s\n", inet_ntoa ( iphdr->dest ) );
321                 rc = -EHOSTUNREACH;
322                 goto err;
323         }
324
325         /* Calculate the transport layer checksum */
326         if ( tcpip_protocol->csum_offset > 0 ) {
327                 ipv4_tx_csum ( pkb, tcpip_protocol );
328         }
329
330         /* Calculate header checksum, in network byte order */
331         iphdr->chksum = 0;
332         iphdr->chksum = tcpip_chksum ( iphdr, sizeof ( *iphdr ) );
333
334         /* Print IP4 header for debugging */
335         ipv4_dump ( iphdr );
336
337         /* Determine link-layer destination address */
338         if ( next_hop.s_addr == INADDR_BROADCAST ) {
339                 /* Broadcast address */
340                 ll_dest = netdev->ll_protocol->ll_broadcast;
341         } else if ( IN_MULTICAST ( next_hop.s_addr ) ) {
342                 /* Special case: IPv4 multicast over Ethernet.  This
343                  * code may need to be generalised once we find out
344                  * what happens for other link layers.
345                  */
346                 uint8_t *next_hop_bytes = ( uint8_t * ) &next_hop;
347                 ll_dest_buf[0] = 0x01;
348                 ll_dest_buf[0] = 0x00;
349                 ll_dest_buf[0] = 0x5e;
350                 ll_dest_buf[3] = next_hop_bytes[1] & 0x7f;
351                 ll_dest_buf[4] = next_hop_bytes[2];
352                 ll_dest_buf[5] = next_hop_bytes[3];
353         } else {
354                 /* Unicast address: resolve via ARP */
355                 if ( ( rc = arp_resolve ( netdev, &ipv4_protocol, &next_hop,
356                                           &iphdr->src, ll_dest_buf ) ) != 0 ) {
357                         DBG ( "No ARP entry for %s\n",
358                               inet_ntoa ( iphdr->dest ) );
359                         goto err;
360                 }
361         }
362
363         /* Hand off to link layer */
364         return net_tx ( pkb, netdev, &ipv4_protocol, ll_dest );
365
366  err:
367         free_pkb ( pkb );
368         return rc;
369 }
370
371 /**
372  * Process incoming packets
373  *
374  * @v pkb       Packet buffer
375  * @v netdev    Network device
376  * @v ll_source Link-layer destination source
377  *
378  * This function expects an IP4 network datagram. It processes the headers 
379  * and sends it to the transport layer.
380  */
381 static int ipv4_rx ( struct pk_buff *pkb, struct net_device *netdev __unused,
382                      const void *ll_source __unused ) {
383         struct iphdr *iphdr = pkb->data;
384         union {
385                 struct sockaddr_in sin;
386                 struct sockaddr_tcpip st;
387         } src, dest;
388         uint16_t chksum;
389
390         /* Sanity check */
391         if ( pkb_len ( pkb ) < sizeof ( *iphdr ) ) {
392                 DBG ( "IP datagram too short (%d bytes)\n", pkb_len ( pkb ) );
393                 goto err;
394         }
395
396         /* Print IP4 header for debugging */
397         ipv4_dump ( iphdr );
398
399         /* Validate version and header length */
400         if ( iphdr->verhdrlen != 0x45 ) {
401                 DBG ( "Bad version and header length %x\n", iphdr->verhdrlen );
402                 goto err;
403         }
404
405         /* Validate length of IP packet */
406         if ( ntohs ( iphdr->len ) > pkb_len ( pkb ) ) {
407                 DBG ( "Inconsistent packet length %d\n",
408                       ntohs ( iphdr->len ) );
409                 goto err;
410         }
411
412         /* Verify the checksum */
413         if ( ( chksum = ipv4_rx_csum ( pkb, iphdr->protocol ) ) != 0xffff ) {
414                 DBG ( "Bad checksum %x\n", chksum );
415         }
416         /* Fragment reassembly */
417         if ( iphdr->frags & IP_MASK_MOREFRAGS || 
418                 ( !iphdr->frags & IP_MASK_MOREFRAGS &&
419                         iphdr->frags & IP_MASK_OFFSET != 0 ) ) {
420                 /* Pass the fragment to the reassembler ipv4_ressable() which
421                  * either returns a fully reassembled packet buffer or NULL.
422                  */
423                 pkb = ipv4_reassemble ( pkb );
424                 if ( !pkb ) {
425                         return 0;
426                 }
427         }
428
429         /* To reduce code size, the following functions are not implemented:
430          * 1. Check the destination address
431          * 2. Check the TTL field
432          * 3. Check the service field
433          */
434
435         /* Construct socket addresses */
436         memset ( &src, 0, sizeof ( src ) );
437         src.sin.sin_family = AF_INET;
438         src.sin.sin_addr = iphdr->src;
439         memset ( &dest, 0, sizeof ( dest ) );
440         dest.sin.sin_family = AF_INET;
441         dest.sin.sin_addr = iphdr->dest;
442
443         /* Strip header */
444         pkb_pull ( pkb, sizeof ( *iphdr ) );
445         pkb_unput ( pkb, pkb_len ( pkb ) - htons ( iphdr->len ) );
446
447         /* Send it to the transport layer */
448         return tcpip_rx ( pkb, iphdr->protocol, &src.st, &dest.st );
449
450  err:
451         free_pkb ( pkb );
452         return -EINVAL;
453 }
454
455 /** 
456  * Check existence of IPv4 address for ARP
457  *
458  * @v netdev            Network device
459  * @v net_addr          Network-layer address
460  * @ret rc              Return status code
461  */
462 static int ipv4_arp_check ( struct net_device *netdev, const void *net_addr ) {
463         const struct in_addr *address = net_addr;
464         struct ipv4_miniroute *miniroute;
465
466         list_for_each_entry ( miniroute, &miniroutes, list ) {
467                 if ( ( miniroute->netdev == netdev ) &&
468                      ( miniroute->address.s_addr == address->s_addr ) ) {
469                         /* Found matching address */
470                         return 0;
471                 }
472         }
473         return -ENOENT;
474 }
475
476 /**
477  * Convert IPv4 address to dotted-quad notation
478  *
479  * @v in        IP address
480  * @ret string  IP address in dotted-quad notation
481  */
482 char * inet_ntoa ( struct in_addr in ) {
483         static char buf[16]; /* "xxx.xxx.xxx.xxx" */
484         uint8_t *bytes = ( uint8_t * ) &in;
485         
486         sprintf ( buf, "%d.%d.%d.%d", bytes[0], bytes[1], bytes[2], bytes[3] );
487         return buf;
488 }
489
490 /**
491  * Transcribe IP address
492  *
493  * @v net_addr  IP address
494  * @ret string  IP address in dotted-quad notation
495  *
496  */
497 static const char * ipv4_ntoa ( const void *net_addr ) {
498         return inet_ntoa ( * ( ( struct in_addr * ) net_addr ) );
499 }
500
501 /** IPv4 protocol */
502 struct net_protocol ipv4_protocol = {
503         .name = "IP",
504         .net_proto = htons ( ETH_P_IP ),
505         .net_addr_len = sizeof ( struct in_addr ),
506         .rx = ipv4_rx,
507         .ntoa = ipv4_ntoa,
508 };
509
510 NET_PROTOCOL ( ipv4_protocol );
511
512 /** IPv4 TCPIP net protocol */
513 struct tcpip_net_protocol ipv4_tcpip_protocol = {
514         .name = "IPv4",
515         .sa_family = AF_INET,
516         .tx = ipv4_tx,
517 };
518
519 TCPIP_NET_PROTOCOL ( ipv4_tcpip_protocol );
520
521 /** IPv4 ARP protocol */
522 struct arp_net_protocol ipv4_arp_protocol __arp_net_protocol = {
523         .net_protocol = &ipv4_protocol,
524         .check = ipv4_arp_check,
525 };