Simplify ipv4_tx() by not having a separate "source" variable now that
[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/interface.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 /**
51  * Add IPv4 interface
52  *
53  * @v netdev    Network device
54  * @v address   IPv4 address
55  * @v netmask   Subnet mask
56  * @v gateway   Gateway address (or @c INADDR_NONE for no gateway)
57  * @ret rc      Return status code
58  *
59  */
60 int add_ipv4_address ( struct net_device *netdev, struct in_addr address,
61                        struct in_addr netmask, struct in_addr gateway ) {
62         struct ipv4_miniroute *miniroute;
63
64         /* Allocate and populate miniroute structure */
65         miniroute = malloc ( sizeof ( *miniroute ) );
66         if ( ! miniroute )
67                 return -ENOMEM;
68         miniroute->netdev = netdev;
69         miniroute->address = address;
70         miniroute->netmask = netmask;
71         miniroute->gateway = gateway;
72         
73         /* Add to end of list if we have a gateway, otherwise to start
74          * of list.
75          */
76         if ( gateway.s_addr != INADDR_NONE ) {
77                 list_add_tail ( &miniroute->list, &miniroutes );
78         } else {
79                 list_add ( &miniroute->list, &miniroutes );
80         }
81         return 0;
82 }
83
84 /**
85  * Remove IPv4 interface
86  *
87  * @v netdev    Network device
88  */
89 void del_ipv4_address ( struct net_device *netdev ) {
90         struct ipv4_miniroute *miniroute;
91
92         list_for_each_entry ( miniroute, &miniroutes, list ) {
93                 if ( miniroute->netdev == netdev ) {
94                         list_del ( &miniroute->list );
95                         break;
96                 }
97         }
98 }
99
100 /**
101  * Dump IPv4 packet header
102  *
103  * @v iphdr     IPv4 header
104  */
105 static void ipv4_dump ( struct iphdr *iphdr __unused ) {
106         DBG ( "IP4 header at %p+%zx\n", iphdr, sizeof ( *iphdr ) );
107         DBG ( "\tVersion = %d\n", ( iphdr->verhdrlen & IP_MASK_VER ) / 16 );
108         DBG ( "\tHeader length = %d\n", iphdr->verhdrlen & IP_MASK_HLEN );
109         DBG ( "\tService = %d\n", iphdr->service );
110         DBG ( "\tTotal length = %d\n", iphdr->len );
111         DBG ( "\tIdent = %d\n", iphdr->ident );
112         DBG ( "\tFrags/Offset = %d\n", iphdr->frags );
113         DBG ( "\tIP TTL = %d\n", iphdr->ttl );
114         DBG ( "\tProtocol = %d\n", iphdr->protocol );
115         DBG ( "\tHeader Checksum (at %p) = %x\n", &iphdr->chksum,
116               iphdr->chksum );
117         DBG ( "\tSource = %s\n", inet_ntoa ( iphdr->src ) );
118         DBG ( "\tDestination = %s\n", inet_ntoa ( iphdr->dest ) );
119 }
120
121 /**
122  * Complete the transport-layer checksum
123  *
124  * Refer to the note made in net/interface.c about this function
125  */
126 void ipv4_tx_csum ( struct pk_buff *pkb, uint8_t trans_proto ) {
127
128         struct iphdr *iphdr = pkb->data;
129         void *pshdr = malloc ( IP_PSHLEN );
130         void *csum_offset = iphdr + IP_HLEN + ( trans_proto == IP_UDP ? 6 : 16 );
131         int offset = 0;
132
133         /* Calculate pseudo header */
134         memcpy ( pshdr, &iphdr->src, sizeof ( in_addr ) );
135         offset += sizeof ( in_addr );
136         memcpy ( pshdr + offset, &iphdr->dest, sizeof ( in_addr ) );
137         offset += sizeof ( in_addr );
138         *( ( uint8_t* ) ( pshdr + offset++ ) ) = 0x00;
139         *( ( uint8_t* ) ( pshdr + offset++ ) ) = iphdr->protocol;
140         *( ( uint16_t* ) ( pshdr + offset ) ) = pkb_len ( pkb ) - IP_HLEN;
141
142         /* Update the checksum value */
143         *( ( uint16_t* ) csum_offset ) = *( ( uint16_t* ) csum_offset ) + calc_chksum ( pshdr, IP_PSHLEN );
144 }
145
146 /**
147  * Calculate the transport-layer checksum while processing packets
148  */
149 uint16_t ipv4_rx_csum ( struct pk_buff *pkb __unused, uint8_t trans_proto __unused ) {
150         /** This function needs to be implemented. Until then, it will return 0xffffffff every time */
151         return 0xffff;
152 }
153
154 /**
155  * Transmit packet constructed by uIP
156  *
157  * @v pkb               Packet buffer
158  * @ret rc              Return status code
159  *
160  */
161 int ipv4_uip_tx ( struct pk_buff *pkb ) {
162         struct iphdr *iphdr = pkb->data;
163         struct ipv4_miniroute *miniroute;
164         struct net_device *netdev = NULL;
165         struct in_addr next_hop;
166         struct in_addr source;
167         uint8_t ll_dest_buf[MAX_LL_ADDR_LEN];
168         const uint8_t *ll_dest = ll_dest_buf;
169         int rc;
170
171         /* Use routing table to identify next hop and transmitting netdev */
172         next_hop = iphdr->dest;
173         list_for_each_entry ( miniroute, &miniroutes, list ) {
174                 if ( ( ( ( iphdr->dest.s_addr ^ miniroute->address.s_addr ) &
175                          miniroute->netmask.s_addr ) == 0 ) ||
176                      ( miniroute->gateway.s_addr != INADDR_NONE ) ) {
177                         netdev = miniroute->netdev;
178                         source = miniroute->address;
179                         if ( miniroute->gateway.s_addr != INADDR_NONE )
180                                 next_hop = miniroute->gateway;
181                         break;
182                 }
183         }
184
185         /* Abort if no network device identified */
186         if ( ! netdev ) {
187                 DBG ( "No route to %s\n", inet_ntoa ( iphdr->dest ) );
188                 rc = -EHOSTUNREACH;
189                 goto err;
190         }
191
192         /* Determine link-layer destination address */
193         if ( next_hop.s_addr == INADDR_BROADCAST ) {
194                 /* Broadcast address */
195                 ll_dest = netdev->ll_protocol->ll_broadcast;
196         } else if ( IN_MULTICAST ( next_hop.s_addr ) ) {
197                 /* Special case: IPv4 multicast over Ethernet.  This
198                  * code may need to be generalised once we find out
199                  * what happens for other link layers.
200                  */
201                 uint8_t *next_hop_bytes = ( uint8_t * ) &next_hop;
202                 ll_dest_buf[0] = 0x01;
203                 ll_dest_buf[0] = 0x00;
204                 ll_dest_buf[0] = 0x5e;
205                 ll_dest_buf[3] = next_hop_bytes[1] & 0x7f;
206                 ll_dest_buf[4] = next_hop_bytes[2];
207                 ll_dest_buf[5] = next_hop_bytes[3];
208         } else {
209                 /* Unicast address: resolve via ARP */
210                 if ( ( rc = arp_resolve ( netdev, &ipv4_protocol, &next_hop,
211                                           &source, ll_dest_buf ) ) != 0 ) {
212                         DBG ( "No ARP entry for %s\n",
213                               inet_ntoa ( iphdr->dest ) );
214                         goto err;
215                 }
216         }
217         
218         /* Hand off to link layer */
219         return net_tx ( pkb, netdev, &ipv4_protocol, ll_dest );
220
221  err:
222         free_pkb ( pkb );
223         return rc;
224 }
225
226 /**
227  * Transmit IP packet (without uIP)
228  *
229  * @v pkb               Packet buffer
230  * @v trans_proto       Transport-layer protocol number
231  * @v dest              Destination network-layer address
232  * @ret rc              Status
233  *
234  * This function expects a transport-layer segment and prepends the IP header
235  */
236 int ipv4_tx ( struct pk_buff *pkb, uint16_t trans_proto, struct in_addr *dest ) {
237         struct iphdr *iphdr = pkb_push ( pkb, IP_HLEN );
238         struct ipv4_miniroute *miniroute;
239         struct net_device *netdev = NULL;
240         struct in_addr next_hop;
241         uint8_t ll_dest_buf[MAX_LL_ADDR_LEN];
242         const uint8_t *ll_dest = ll_dest_buf;
243         int rc;
244
245         /* Fill up the IP header, except source address */
246         iphdr->verhdrlen = ( IP_VER << 4 ) | ( IP_HLEN / 4 );   /* Version = 4, Header length = 5 */
247         iphdr->service = IP_TOS;                                /* Service = 0, is not implemented */
248         iphdr->len = htons ( pkb_len ( pkb ) );                 /* Total packet length, in network byte order */
249         iphdr->ident = next_ident++;                            /* Identification number */
250         iphdr->frags = 0;                                       /* Fragmentation is not implemented at the host */
251         iphdr->ttl = IP_TTL;                                    /* Time to live */
252         iphdr->protocol = trans_proto;                          /* Transport-layer protocol - IP_XXX */
253
254         /* Calculate header checksum, in network byte order */
255         iphdr->chksum = 0;
256         iphdr->chksum = htons ( calc_chksum ( iphdr, IP_HLEN ) );
257         /* Copy destination address */
258         memcpy ( &iphdr->dest, dest, sizeof ( struct in_addr ) );
259
260         /**
261          * All fields in the IP header filled in except the source network address (which requires routing). As
262          * the pseudo header requires the source address as well and updating the transport-layer checksum is
263          * done after routing.
264          *
265          * Continue processing as in ipv4_uip_tx()
266          */
267
268         /* Use routing table to identify next hop and transmitting netdev */
269         next_hop = iphdr->dest;
270         list_for_each_entry ( miniroute, &miniroutes, list ) {
271                 if ( ( ( ( iphdr->dest.s_addr ^ miniroute->address.s_addr ) &
272                          miniroute->netmask.s_addr ) == 0 ) ||
273                      ( miniroute->gateway.s_addr != INADDR_NONE ) ) {
274                         netdev = miniroute->netdev;
275                         iphdr->src = miniroute->address;
276                         if ( miniroute->gateway.s_addr != INADDR_NONE )
277                                 next_hop = miniroute->gateway;
278                         break;
279                 }
280         }
281         /* Abort if no network device identified */
282         if ( ! netdev ) {
283                 DBG ( "No route to %s\n", inet_ntoa ( iphdr->dest ) );
284                 rc = -EHOSTUNREACH;
285                 goto err;
286         }
287
288         /* Calculate the transport layer checksum */
289         ipv4_tx_csum ( pkb, trans_proto );
290
291         /* Print IP4 header for debugging */
292         ipv4_dump ( iphdr );
293
294         /* Determine link-layer destination address */
295         if ( next_hop.s_addr == INADDR_BROADCAST ) {
296                 /* Broadcast address */
297                 ll_dest = netdev->ll_protocol->ll_broadcast;
298         } else if ( IN_MULTICAST ( next_hop.s_addr ) ) {
299                 /* Special case: IPv4 multicast over Ethernet.  This
300                  * code may need to be generalised once we find out
301                  * what happens for other link layers.
302                  */
303                 uint8_t *next_hop_bytes = ( uint8_t * ) &next_hop;
304                 ll_dest_buf[0] = 0x01;
305                 ll_dest_buf[0] = 0x00;
306                 ll_dest_buf[0] = 0x5e;
307                 ll_dest_buf[3] = next_hop_bytes[1] & 0x7f;
308                 ll_dest_buf[4] = next_hop_bytes[2];
309                 ll_dest_buf[5] = next_hop_bytes[3];
310         } else {
311                 /* Unicast address: resolve via ARP */
312                 if ( ( rc = arp_resolve ( netdev, &ipv4_protocol, &next_hop,
313                                           &iphdr->src, ll_dest_buf ) ) != 0 ) {
314                         DBG ( "No ARP entry for %s\n",
315                               inet_ntoa ( iphdr->dest ) );
316                         goto err;
317                 }
318         }
319
320         /* Hand off to link layer */
321         return net_tx ( pkb, netdev, &ipv4_protocol, ll_dest );
322
323  err:
324         free_pkb ( pkb );
325         return rc;
326 }
327
328 /**
329  * Process incoming IP packets
330  *
331  * @v pkb               Packet buffer
332  * @v netdev            Network device
333  * @v ll_source         Link-layer source address
334  * @ret rc              Return status code
335  *
336  * This handles IP packets by handing them off to the uIP protocol
337  * stack.
338  */
339 static int ipv4_uip_rx ( struct pk_buff *pkb,
340                          struct net_device *netdev __unused,
341                          const void *ll_source __unused ) {
342
343         /* Transfer to uIP buffer.  Horrendously space-inefficient,
344          * but will do as a proof-of-concept for now.
345          */
346         uip_len = pkb_len ( pkb );
347         memcpy ( uip_buf, pkb->data, uip_len );
348         free_pkb ( pkb );
349
350         /* Hand to uIP for processing */
351         uip_input ();
352         if ( uip_len > 0 ) {
353                 pkb = alloc_pkb ( MAX_LL_HEADER_LEN + uip_len );
354                 if ( ! pkb )
355                         return -ENOMEM;
356                 pkb_reserve ( pkb, MAX_LL_HEADER_LEN );
357                 memcpy ( pkb_put ( pkb, uip_len ), uip_buf, uip_len );
358                 ipv4_uip_tx ( pkb );
359         }
360         return 0;
361 }
362
363 /**
364  * Process incoming packets (without uIP)
365  *
366  * @v pkb       Packet buffer
367  * @v netdev    Network device
368  * @v ll_source Link-layer destination source
369  *
370  * This function expects an IP4 network datagram. It will process the headers and send it to the transport layer
371  */
372 void ipv4_rx ( struct pk_buff *pkb, struct net_device *netdev __unused,
373                         const void *ll_source __unused ) {
374         struct iphdr *iphdr = pkb->data;
375         struct in_addr *src = &iphdr->src;
376         struct in_addr *dest = &iphdr->dest;
377         uint16_t chksum;
378
379         /* Print IP4 header for debugging */
380         ipv4_dump ( iphdr );
381
382         /* Process headers */
383         if ( iphdr->verhdrlen != 0x45 ) {
384                 DBG ( "Bad version and header length %x\n", iphdr->verhdrlen );
385                 return;
386         }
387
388         if ( iphdr->len != pkb_len ( pkb ) ) {
389                 DBG ( "Bad total length %d\n", iphdr->len );
390                 return;
391         }
392
393         if ( ( chksum = ipv4_rx_csum ( pkb, iphdr->protocol ) ) != 0xffff ) {
394                 DBG ( "Bad checksum %x\n", chksum );
395         }
396
397         /* Todo: Compute and verify the header checksum */
398
399         /* To reduce code size, the following functions are not implemented:
400          * 1. Check the destination address
401          * 2. Check the TTL field
402          * 3. Check the service field
403          */
404
405         /* Strip header */
406         pkb_pull ( pkb, IP_HLEN );
407
408         /* Send it to the transport layer */
409         trans_rx ( pkb, iphdr->protocol, src, dest );
410 }
411
412 /** 
413  * Check existence of IPv4 address for ARP
414  *
415  * @v netdev            Network device
416  * @v net_addr          Network-layer address
417  * @ret rc              Return status code
418  */
419 static int ipv4_arp_check ( struct net_device *netdev, const void *net_addr ) {
420         const struct in_addr *address = net_addr;
421         struct ipv4_miniroute *miniroute;
422
423         list_for_each_entry ( miniroute, &miniroutes, list ) {
424                 if ( ( miniroute->netdev == netdev ) &&
425                      ( miniroute->address.s_addr == address->s_addr ) ) {
426                         /* Found matching address */
427                         return 0;
428                 }
429         }
430         return -ENOENT;
431 }
432
433 /**
434  * Convert IPv4 address to dotted-quad notation
435  *
436  * @v in        IP address
437  * @ret string  IP address in dotted-quad notation
438  */
439 char * inet_ntoa ( struct in_addr in ) {
440         static char buf[16]; /* "xxx.xxx.xxx.xxx" */
441         uint8_t *bytes = ( uint8_t * ) &in;
442         
443         sprintf ( buf, "%d.%d.%d.%d", bytes[0], bytes[1], bytes[2], bytes[3] );
444         return buf;
445 }
446
447 /**
448  * Transcribe IP address
449  *
450  * @v net_addr  IP address
451  * @ret string  IP address in dotted-quad notation
452  *
453  */
454 static const char * ipv4_ntoa ( const void *net_addr ) {
455         return inet_ntoa ( * ( ( struct in_addr * ) net_addr ) );
456 }
457
458 /** IPv4 protocol */
459 struct net_protocol ipv4_protocol = {
460         .name = "IP",
461         .net_proto = htons ( ETH_P_IP ),
462         .net_addr_len = sizeof ( struct in_addr ),
463 #if USE_UIP
464         .rx = ipv4_uip_rx,
465 #else
466         .rx = ipv4_rx,
467 #endif
468         .ntoa = ipv4_ntoa,
469 };
470
471 NET_PROTOCOL ( ipv4_protocol );
472
473 /** IPv4 ARP protocol */
474 struct arp_net_protocol ipv4_arp_protocol = {
475         .net_protocol = &ipv4_protocol,
476         .check = ipv4_arp_check,
477 };
478
479 ARP_NET_PROTOCOL ( ipv4_arp_protocol );