85f896bf22eed5cd576ba756b4fdb512dade3172
[gpxe.git] / src / net / ipv6.c
1 #include <errno.h>
2 #include <stdint.h>
3 #include <string.h>
4 #include <stdlib.h>
5 #include <stdio.h>
6 #include <byteswap.h>
7 #include <gpxe/in.h>
8 #include <gpxe/ip6.h>
9 #include <gpxe/ndp.h>
10 #include <gpxe/list.h>
11 #include <gpxe/icmp6.h>
12 #include <gpxe/tcpip.h>
13 #include <gpxe/socket.h>
14 #include <gpxe/iobuf.h>
15 #include <gpxe/netdevice.h>
16 #include <gpxe/if_ether.h>
17
18 struct net_protocol ipv6_protocol;
19
20 char * inet6_ntoa ( struct in6_addr in6 );
21
22 /* Unspecified IP6 address */
23 static struct in6_addr ip6_none = {
24         .in6_u.u6_addr32 = { 0,0,0,0 }
25 };
26
27 /** An IPv6 routing table entry */
28 struct ipv6_miniroute {
29         /* List of miniroutes */
30         struct list_head list;
31
32         /* Network device */
33         struct net_device *netdev;
34
35         /* Destination prefix */
36         struct in6_addr prefix;
37         /* Prefix length */
38         int prefix_len;
39         /* IPv6 address of interface */
40         struct in6_addr address;
41         /* Gateway address */
42         struct in6_addr gateway;
43 };
44
45 /** List of IPv6 miniroutes */
46 static LIST_HEAD ( miniroutes );
47
48 /**
49  * Add IPv6 minirouting table entry
50  *
51  * @v netdev            Network device
52  * @v prefix            Destination prefix (in bits)
53  * @v address           Address of the interface
54  * @v gateway           Gateway address (or ::0 for no gateway)
55  * @ret miniroute       Routing table entry, or NULL
56  */
57 static struct ipv6_miniroute * __malloc
58 add_ipv6_miniroute ( struct net_device *netdev, struct in6_addr prefix,
59                      int prefix_len, struct in6_addr address,
60                      struct in6_addr gateway ) {
61         struct ipv6_miniroute *miniroute;
62         
63         DBG("ipv6 add: %s/%d ", inet6_ntoa(address), prefix_len);
64         DBG("gw %s\n", inet6_ntoa(gateway));
65
66         miniroute = malloc ( sizeof ( *miniroute ) );
67         if ( miniroute ) {
68                 /* Record routing information */
69                 miniroute->netdev = netdev_get ( netdev );
70                 miniroute->prefix = prefix;
71                 miniroute->prefix_len = prefix_len;
72                 miniroute->address = address;
73                 miniroute->gateway = gateway;
74
75                 /* Add miniroute to list of miniroutes */
76                 if ( !IP6_EQUAL ( gateway, ip6_none ) ) {
77                         list_add_tail ( &miniroute->list, &miniroutes );
78                 } else {
79                         list_add ( &miniroute->list, &miniroutes );
80                 }
81         }
82
83         return miniroute;
84 }
85
86 /**
87  * Delete IPv6 minirouting table entry
88  *
89  * @v miniroute         Routing table entry
90  */
91 static void del_ipv6_miniroute ( struct ipv6_miniroute *miniroute ) {
92         
93         DBG ( "ipv6 del: %s/%d\n", inet6_ntoa(miniroute->address),
94                                    miniroute->prefix_len );
95         
96         netdev_put ( miniroute->netdev );
97         list_del ( &miniroute->list );
98         free ( miniroute );
99 }
100
101 /**
102  * Add IPv6 interface
103  *
104  * @v netdev    Network device
105  * @v prefix    Destination prefix
106  * @v address   Address of the interface
107  * @v gateway   Gateway address (or ::0 for no gateway)
108  */
109 int add_ipv6_address ( struct net_device *netdev, struct in6_addr prefix,
110                        int prefix_len, struct in6_addr address,
111                        struct in6_addr gateway ) {
112         struct ipv6_miniroute *miniroute;
113
114         /* Clear any existing address for this net device */
115         /* del_ipv6_address ( netdev ); */
116
117         /* Add new miniroute */
118         miniroute = add_ipv6_miniroute ( netdev, prefix, prefix_len, address,
119                                          gateway );
120         if ( ! miniroute )
121                 return -ENOMEM;
122
123         return 0;
124 }
125
126 /**
127  * Remove IPv6 interface
128  *
129  * @v netdev    Network device
130  */
131 void del_ipv6_address ( struct net_device *netdev ) {
132         struct ipv6_miniroute *miniroute;
133
134         list_for_each_entry ( miniroute, &miniroutes, list ) {
135                 if ( miniroute->netdev == netdev ) {
136                         del_ipv6_miniroute ( miniroute );
137                         break;
138                 }
139         }
140 }
141
142 /**
143  * Calculate TCPIP checksum
144  *
145  * @v iobuf     I/O buffer
146  * @v tcpip     TCP/IP protocol
147  *
148  * This function constructs the pseudo header and completes the checksum in the
149  * upper layer header.
150  */
151 static uint16_t ipv6_tx_csum ( struct io_buffer *iobuf, uint16_t csum ) {
152         struct ip6_header *ip6hdr = iobuf->data;
153         struct ipv6_pseudo_header pshdr;
154
155         /* Calculate pseudo header */
156         memset ( &pshdr, 0, sizeof ( pshdr ) );
157         pshdr.src = ip6hdr->src;
158         pshdr.dest = ip6hdr->dest;
159         pshdr.len = htons ( iob_len ( iobuf ) - sizeof ( *ip6hdr ) );
160         pshdr.nxt_hdr = ip6hdr->nxt_hdr;
161
162         /* Update checksum value */
163         return tcpip_continue_chksum ( csum, &pshdr, sizeof ( pshdr ) );
164 }
165
166 /**
167  * Dump IP6 header for debugging
168  *
169  * ip6hdr       IPv6 header
170  */
171 void ipv6_dump ( struct ip6_header *ip6hdr ) {
172         /* Because inet6_ntoa returns a static char[16], each call needs to be
173          * separate. */
174         DBG ( "IP6 %p src %s ", ip6hdr, inet6_ntoa( ip6hdr->src ) );
175         DBG ( "dest %s nxt_hdr %d len %d\n", inet6_ntoa ( ip6hdr->dest ),
176                   ip6hdr->nxt_hdr, ntohs ( ip6hdr->payload_len ) );
177 }
178
179 /**
180  * Transmit IP6 packet
181  *
182  * iobuf                I/O buffer
183  * tcpip        TCP/IP protocol
184  * st_dest      Destination socket address
185  *
186  * This function prepends the IPv6 headers to the payload an transmits it.
187  */
188 static int ipv6_tx ( struct io_buffer *iobuf,
189                      struct tcpip_protocol *tcpip,
190                      struct sockaddr_tcpip *st_src __unused,
191                      struct sockaddr_tcpip *st_dest,
192                      struct net_device *netdev,
193                      uint16_t *trans_csum ) {
194         struct sockaddr_in6 *dest = ( struct sockaddr_in6* ) st_dest;
195         struct in6_addr next_hop;
196         struct ipv6_miniroute *miniroute;
197         uint8_t ll_dest_buf[MAX_LL_ADDR_LEN], ip1, ip2;
198         const uint8_t *ll_dest = ll_dest_buf;
199         int rc, multicast, linklocal, bits, offset;
200         
201         /* Check for multicast transmission. */
202         multicast = dest->sin6_addr.in6_u.u6_addr8[0] == 0xFF;
203
204         /* Construct the IPv6 packet */
205         struct ip6_header *ip6hdr = iob_push ( iobuf, sizeof ( *ip6hdr ) );
206         memset ( ip6hdr, 0, sizeof ( *ip6hdr) );
207         ip6hdr->ver_traffic_class_flow_label = htonl ( 0x60000000 );//IP6_VERSION;
208         ip6hdr->payload_len = htons ( iob_len ( iobuf ) - sizeof ( *ip6hdr ) );
209         ip6hdr->nxt_hdr = tcpip->tcpip_proto;
210         ip6hdr->hop_limit = IP6_HOP_LIMIT; // 255
211         
212         /* Determine the next hop address and interface. */
213         next_hop = dest->sin6_addr;
214         list_for_each_entry ( miniroute, &miniroutes, list ) {
215                 /* Link-local route? */
216                 linklocal = (miniroute->address.in6_u.u6_addr16[0] & htons(0xFE80)) == htons(0xFE80);
217
218                 /* Handle link-local for multicast. */
219                 if ( multicast )
220                 {
221                         /* Link-local scope? */
222                         if ( next_hop.in6_u.u6_addr8[0] & 0x2 ) {
223                                 if ( linklocal ) {
224                                         netdev = miniroute->netdev;
225                                         ip6hdr->src = miniroute->address;
226                                         
227                                         DBG ( "ipv6: link-local multicast, sending as %s\n", inet6_ntoa ( ip6hdr->src ) );
228                                         break;
229                                 } else {
230                                         /* Should be link-local address. */
231                                         continue;
232                                 }
233                         } else {
234                                 DBG ( "ipv6: non-link-local multicast\n" );
235                                 
236                                 /* Can we route on this interface?
237                                    (assume non-link-local means routable) */
238                                 if ( ! linklocal ) {
239                                         netdev = miniroute->netdev;
240                                         ip6hdr->src = miniroute->address;
241                                         break;
242                                 }
243                         }
244                 }
245                 
246                 /* Check for a prefix match on the route. */
247                 if ( ! memcmp ( &next_hop, &miniroute->prefix, miniroute->prefix_len / 8 ) ) {
248                         rc = 0;
249                         
250                         /* Handle extra bits in the prefix. */
251                         if ( ( miniroute->prefix_len % 2 ) ||
252                              ( miniroute->prefix_len < 8 ) ) {
253                                 DBG ( "ipv6: prefix is not aligned to a byte.\n" );
254                         
255                                 /* Compare the remaining bits. */
256                                 offset = miniroute->prefix_len / 8;
257                                 bits = miniroute->prefix_len % 8;
258                                 
259                                 ip1 = next_hop.in6_u.u6_addr8[offset];
260                                 ip2 = miniroute->prefix.in6_u.u6_addr8[offset];
261                                 if ( ! ( ( ip1 & (0xFF >> (8 - bits)) ) &
262                                      ( ip2 ) ) ) {
263                                         rc = 1;
264                                 }
265                         }
266                 } else {
267                         rc = 1;
268                 }
269                 
270                 /* Matched? */
271                 if( rc == 0 ) {
272                         DBG ( "ipv6: route found for %s.\n", inet6_ntoa ( next_hop ) );
273                         
274                         netdev = miniroute->netdev;
275                         ip6hdr->src = miniroute->address;
276                         if ( ! ( IS_UNSPECIFIED ( miniroute->gateway ) ) ) {
277                                 DBG ( "    (via %s)\n", inet6_ntoa ( miniroute->gateway ) );
278                                 next_hop = miniroute->gateway;
279                         }
280                         break;
281                 }
282         }
283         /* No network interface identified */
284         if ( !netdev ) {
285                 DBG ( "No route to host %s\n", inet6_ntoa ( ip6hdr->dest ) );
286                 rc = -ENETUNREACH;
287                 goto err;
288         }
289         
290         /* Add the next hop to the packet. */
291         ip6hdr->dest = next_hop;
292
293         /* Complete the transport layer checksum */
294         if ( trans_csum )
295                 *trans_csum = ipv6_tx_csum ( iobuf, *trans_csum );
296
297         /* Print IPv6 header */
298         /* ipv6_dump ( ip6hdr ); */
299
300         /* Resolve link layer address */
301         if ( next_hop.in6_u.u6_addr8[0] == 0xFF ) {
302                 ll_dest_buf[0] = 0x33;
303                 ll_dest_buf[1] = 0x33;
304                 ll_dest_buf[2] = next_hop.in6_u.u6_addr8[12];
305                 ll_dest_buf[3] = next_hop.in6_u.u6_addr8[13];
306                 ll_dest_buf[4] = next_hop.in6_u.u6_addr8[14];
307                 ll_dest_buf[5] = next_hop.in6_u.u6_addr8[15];
308         } else {
309                 /* Unicast address needs to be resolved by NDP */
310                 if ( ( rc = ndp_resolve ( netdev, &next_hop, &ip6hdr->src,
311                                           ll_dest_buf ) ) != 0 ) {
312                         DBG ( "No entry for %s\n", inet6_ntoa ( next_hop ) );
313                         goto err;
314                 }
315         }
316
317         /* Transmit packet */
318         return net_tx ( iobuf, netdev, &ipv6_protocol, ll_dest );
319
320   err:
321         free_iob ( iobuf );
322         return rc;
323 }
324
325 /**
326  * Process next IP6 header
327  *
328  * @v iobuf     I/O buffer
329  * @v nxt_hdr   Next header number
330  * @v src       Source socket address
331  * @v dest      Destination socket address
332  * @v netdev    Net device the packet arrived on
333  * @v phcsm Partial checksum over the IPv6 psuedo-header.
334  *
335  * Refer http://www.iana.org/assignments/ipv6-parameters for the numbers
336  */
337 static int ipv6_process_nxt_hdr ( struct io_buffer *iobuf, uint8_t nxt_hdr,
338                 struct sockaddr_tcpip *src, struct sockaddr_tcpip *dest,
339                 struct net_device *netdev, uint16_t phcsm ) {
340         switch ( nxt_hdr ) {
341         case IP6_HOPBYHOP:
342         case IP6_ROUTING:
343         case IP6_FRAGMENT:
344         case IP6_AUTHENTICATION:
345         case IP6_DEST_OPTS:
346         case IP6_ESP:
347                 DBG ( "Function not implemented for header %d\n", nxt_hdr );
348                 return -ENOSYS;
349         case IP6_ICMP6:
350                 return icmp6_rx ( iobuf, src, dest, netdev, phcsm );
351         case IP6_NO_HEADER:
352                 DBG ( "No next header\n" );
353                 return 0;
354         }
355         /* Next header is not a IPv6 extension header */
356         return tcpip_rx ( iobuf, nxt_hdr, src, dest, phcsm );
357 }
358
359 /**
360  * Process incoming IP6 packets
361  *
362  * @v iobuf             I/O buffer
363  * @v netdev            Network device
364  * @v ll_source         Link-layer source address
365  *
366  * This function processes a IPv6 packet
367  */
368 static int ipv6_rx ( struct io_buffer *iobuf,
369                      __unused struct net_device *netdev,
370                      __unused const void *ll_source ) {
371
372         struct ip6_header *ip6hdr = iobuf->data;
373         union {
374                 struct sockaddr_in6 sin6;
375                 struct sockaddr_tcpip st;
376         } src, dest;
377         uint16_t phcsm = 0;
378
379         /* Sanity check */
380         if ( iob_len ( iobuf ) < sizeof ( *ip6hdr ) ) {
381                 DBG ( "Packet too short (%zd bytes)\n", iob_len ( iobuf ) );
382                 goto drop;
383         }
384
385         /* Print IP6 header for debugging */
386         /* ipv6_dump ( ip6hdr ); */
387
388         /* Check header version */
389         if ( ( ntohl( ip6hdr->ver_traffic_class_flow_label ) & 0xf0000000 ) != 0x60000000 ) {
390                 DBG ( "Invalid protocol version\n" );
391                 goto drop;
392         }
393
394         /* Check the payload length */
395         if ( ntohs ( ip6hdr->payload_len ) > iob_len ( iobuf ) ) {
396                 DBG ( "Inconsistent packet length (%d bytes)\n",
397                         ip6hdr->payload_len );
398                 goto drop;
399         }
400
401         /* Ignore the traffic class and flow control values */
402
403         /* Construct socket address */
404         memset ( &src, 0, sizeof ( src ) );
405         src.sin6.sin_family = AF_INET6;
406         src.sin6.sin6_addr = ip6hdr->src;
407         memset ( &dest, 0, sizeof ( dest ) );
408         dest.sin6.sin_family = AF_INET6;
409         dest.sin6.sin6_addr = ip6hdr->dest;
410
411         /* Calculate the psuedo-header checksum before the IP6 header is
412          * stripped away. */
413         phcsm = ipv6_tx_csum ( iobuf, 0 );
414
415         /* Strip header */
416         iob_unput ( iobuf, iob_len ( iobuf ) - ntohs ( ip6hdr->payload_len ) -
417                                                         sizeof ( *ip6hdr ) );
418         iob_pull ( iobuf, sizeof ( *ip6hdr ) );
419
420         /* Send it to the transport layer */
421         return ipv6_process_nxt_hdr ( iobuf, ip6hdr->nxt_hdr, &src.st, &dest.st,
422                                       netdev, phcsm );
423
424   drop:
425         DBG ( "IP6 packet dropped\n" );
426         free_iob ( iobuf );
427         return -1;
428 }
429
430 /**
431  * Convert an IPv6 address to a string.
432  *
433  * @v in6   Address to convert to string.
434  *
435  * Converts an IPv6 address to a string, and applies zero-compression as needed
436  * to condense the address for easier reading/typing.
437  */
438 char * inet6_ntoa ( struct in6_addr in6 ) {
439         static char buf[40];
440         uint16_t *bytes = ( uint16_t* ) &in6;
441         size_t i = 0, longest = 0, tmp = 0, long_idx = ~0;
442         
443         /* ::0 */
444         if ( IP6_EQUAL ( in6, ip6_none ) ) {
445                 tmp = sprintf ( buf, "::0" );
446                 buf[tmp] = 0;
447                 return buf;
448         }
449
450         /* Determine the longest string of zeroes for zero-compression. */
451         for ( ; i < 8; i++ ) {
452                 if ( !bytes[i] )
453                         tmp++;
454                 else if(tmp > longest) {
455                         longest = tmp;
456                         long_idx = i - longest;
457                         
458                         tmp = 0;
459                 }
460         }
461         
462         /* Check for last word being zero. This will cause long_idx to be zero,
463          * which confuses the actual buffer fill code. */
464         if(tmp && (tmp > longest)) {
465                 longest = tmp;
466                 long_idx = 8 - longest;
467         }
468
469         /* Inject into the buffer. */
470         tmp = 0;
471         for ( i = 0; i < 8; i++ ) {
472                 /* Should we skip over a string of zeroes? */
473                 if ( i == long_idx ) {
474                         i += longest;
475                         tmp += sprintf( buf + tmp, ":" );
476
477                         /* Handle end-of-string. */
478                         if(i > 7)
479                                 break;
480                 }
481
482                 /* Insert this component of the address. */
483                 tmp += sprintf(buf + tmp, "%x", ntohs(bytes[i]));
484
485                 /* Add the next colon, if needed. */
486                 if ( i < 7 )
487                         tmp += sprintf( buf + tmp, ":" );
488         }
489
490         buf[tmp] = 0;
491
492         return buf;
493 }
494
495 /**
496  * Convert a string to an IPv6 address.
497  *
498  * @v in6   String to convert to an address.
499  */
500 int inet6_aton ( const char *cp, struct in6_addr *inp ) {
501         char convbuf[40];
502         char *tmp = convbuf, *next = convbuf;
503         size_t i = 0;
504         
505         strcpy ( convbuf, cp );
506         
507         DBG ( "ipv6 converting %s to an in6_addr\n", cp );
508         
509         /* Handle the first part of the address (or all of it if no zero-compression. */
510         while ( ( next = strchr ( next, ':' ) ) ) {
511                 /* Cater for zero-compression. */
512                 if ( *tmp == ':' )
513                         break;
514                 
515                 /* Convert to integer. */
516                 inp->s6_addr16[i++] = htons( strtoul ( tmp, 0, 16 ) );
517                 
518                 *next++ = 0;
519                 tmp = next;
520         }
521         
522         /* Handle zero-compression now (go backwards). */
523         i = 7;
524         if ( *tmp == ':' ) {
525                 next = strrchr ( next, ':' );
526                 do
527                 {
528                         tmp = next + 1;
529                         *next-- = 0;
530                 
531                         /* Convert to integer. */
532                         inp->s6_addr16[i--] = htons( strtoul ( tmp, 0, 16 ) );
533                 } while ( ( next = strrchr ( next, ':' ) ) );
534         }
535         
536         return 1;
537 }
538
539 static const char * ipv6_ntoa ( const void *net_addr ) {
540         return inet6_ntoa ( * ( ( struct in6_addr * ) net_addr ) );
541 }
542
543 /** IPv6 protocol */
544 struct net_protocol ipv6_protocol __net_protocol = {
545         .name = "IPV6",
546         .net_proto = htons ( ETH_P_IPV6 ),
547         .net_addr_len = sizeof ( struct in6_addr ),
548         .rx = ipv6_rx,
549         .ntoa = ipv6_ntoa,
550 };
551
552 /** IPv6 TCPIP net protocol */
553 struct tcpip_net_protocol ipv6_tcpip_protocol __tcpip_net_protocol = {
554         .name = "IPv6",
555         .sa_family = AF_INET6,
556         .tx = ipv6_tx,
557 };