[ipv6] Fix inet6_aton and remove some unnecessary debugging
[people/pcmattman/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                                         break;
227                                 } else {
228                                         /* Should be link-local address. */
229                                         continue;
230                                 }
231                         } else {
232                                 /* Can we route on this interface?
233                                    (assume non-link-local means routable) */
234                                 if ( ! linklocal ) {
235                                         netdev = miniroute->netdev;
236                                         ip6hdr->src = miniroute->address;
237                                         break;
238                                 }
239                         }
240                 }
241                 
242                 /* Check for a prefix match on the route. */
243                 if ( ! memcmp ( &next_hop, &miniroute->prefix, miniroute->prefix_len / 8 ) ) {
244                         rc = 0;
245                         
246                         /* Handle extra bits in the prefix. */
247                         if ( ( miniroute->prefix_len % 2 ) ||
248                              ( miniroute->prefix_len < 8 ) ) {
249                                 DBG ( "ipv6: prefix is not aligned to a byte.\n" );
250                         
251                                 /* Compare the remaining bits. */
252                                 offset = miniroute->prefix_len / 8;
253                                 bits = miniroute->prefix_len % 8;
254                                 
255                                 ip1 = next_hop.in6_u.u6_addr8[offset];
256                                 ip2 = miniroute->prefix.in6_u.u6_addr8[offset];
257                                 if ( ! ( ( ip1 & (0xFF >> (8 - bits)) ) &
258                                      ( ip2 ) ) ) {
259                                         rc = 1;
260                                 }
261                         }
262                 } else {
263                         rc = 1;
264                 }
265                 
266                 /* Matched? */
267                 if( rc == 0 ) {
268                         netdev = miniroute->netdev;
269                         ip6hdr->src = miniroute->address;
270                         if ( ! ( IS_UNSPECIFIED ( miniroute->gateway ) ) ) {
271                                 DBG ( "    (via %s)\n", inet6_ntoa ( miniroute->gateway ) );
272                                 next_hop = miniroute->gateway;
273                         }
274                         break;
275                 }
276         }
277         /* No network interface identified */
278         if ( !netdev ) {
279                 DBG ( "No route to host %s\n", inet6_ntoa ( ip6hdr->dest ) );
280                 rc = -ENETUNREACH;
281                 goto err;
282         }
283         
284         /* Add the next hop to the packet. */
285         ip6hdr->dest = next_hop;
286
287         /* Complete the transport layer checksum */
288         if ( trans_csum )
289                 *trans_csum = ipv6_tx_csum ( iobuf, *trans_csum );
290
291         /* Print IPv6 header */
292         /* ipv6_dump ( ip6hdr ); */
293
294         /* Resolve link layer address */
295         if ( next_hop.in6_u.u6_addr8[0] == 0xFF ) {
296                 ll_dest_buf[0] = 0x33;
297                 ll_dest_buf[1] = 0x33;
298                 ll_dest_buf[2] = next_hop.in6_u.u6_addr8[12];
299                 ll_dest_buf[3] = next_hop.in6_u.u6_addr8[13];
300                 ll_dest_buf[4] = next_hop.in6_u.u6_addr8[14];
301                 ll_dest_buf[5] = next_hop.in6_u.u6_addr8[15];
302         } else {
303                 /* Unicast address needs to be resolved by NDP */
304                 if ( ( rc = ndp_resolve ( netdev, &next_hop, &ip6hdr->src,
305                                           ll_dest_buf ) ) != 0 ) {
306                         DBG ( "No entry for %s\n", inet6_ntoa ( next_hop ) );
307                         goto err;
308                 }
309         }
310
311         /* Transmit packet */
312         return net_tx ( iobuf, netdev, &ipv6_protocol, ll_dest );
313
314   err:
315         free_iob ( iobuf );
316         return rc;
317 }
318
319 /**
320  * Process next IP6 header
321  *
322  * @v iobuf     I/O buffer
323  * @v nxt_hdr   Next header number
324  * @v src       Source socket address
325  * @v dest      Destination socket address
326  * @v netdev    Net device the packet arrived on
327  * @v phcsm Partial checksum over the IPv6 psuedo-header.
328  *
329  * Refer http://www.iana.org/assignments/ipv6-parameters for the numbers
330  */
331 static int ipv6_process_nxt_hdr ( struct io_buffer *iobuf, uint8_t nxt_hdr,
332                 struct sockaddr_tcpip *src, struct sockaddr_tcpip *dest,
333                 struct net_device *netdev, uint16_t phcsm ) {
334         switch ( nxt_hdr ) {
335         case IP6_HOPBYHOP:
336         case IP6_ROUTING:
337         case IP6_FRAGMENT:
338         case IP6_AUTHENTICATION:
339         case IP6_DEST_OPTS:
340         case IP6_ESP:
341                 DBG ( "Function not implemented for header %d\n", nxt_hdr );
342                 return -ENOSYS;
343         case IP6_ICMP6:
344                 return icmp6_rx ( iobuf, src, dest, netdev, phcsm );
345         case IP6_NO_HEADER:
346                 DBG ( "No next header\n" );
347                 return 0;
348         }
349         /* Next header is not a IPv6 extension header */
350         return tcpip_rx ( iobuf, nxt_hdr, src, dest, phcsm );
351 }
352
353 /**
354  * Process incoming IP6 packets
355  *
356  * @v iobuf             I/O buffer
357  * @v netdev            Network device
358  * @v ll_source         Link-layer source address
359  *
360  * This function processes a IPv6 packet
361  */
362 static int ipv6_rx ( struct io_buffer *iobuf,
363                      __unused struct net_device *netdev,
364                      __unused const void *ll_source ) {
365
366         struct ip6_header *ip6hdr = iobuf->data;
367         union {
368                 struct sockaddr_in6 sin6;
369                 struct sockaddr_tcpip st;
370         } src, dest;
371         uint16_t phcsm = 0;
372
373         /* Sanity check */
374         if ( iob_len ( iobuf ) < sizeof ( *ip6hdr ) ) {
375                 DBG ( "Packet too short (%zd bytes)\n", iob_len ( iobuf ) );
376                 goto drop;
377         }
378
379         /* Print IP6 header for debugging */
380         /* ipv6_dump ( ip6hdr ); */
381
382         /* Check header version */
383         if ( ( ntohl( ip6hdr->ver_traffic_class_flow_label ) & 0xf0000000 ) != 0x60000000 ) {
384                 DBG ( "Invalid protocol version\n" );
385                 goto drop;
386         }
387
388         /* Check the payload length */
389         if ( ntohs ( ip6hdr->payload_len ) > iob_len ( iobuf ) ) {
390                 DBG ( "Inconsistent packet length (%d bytes)\n",
391                         ip6hdr->payload_len );
392                 goto drop;
393         }
394
395         /* Ignore the traffic class and flow control values */
396
397         /* Construct socket address */
398         memset ( &src, 0, sizeof ( src ) );
399         src.sin6.sin_family = AF_INET6;
400         src.sin6.sin6_addr = ip6hdr->src;
401         memset ( &dest, 0, sizeof ( dest ) );
402         dest.sin6.sin_family = AF_INET6;
403         dest.sin6.sin6_addr = ip6hdr->dest;
404
405         /* Calculate the psuedo-header checksum before the IP6 header is
406          * stripped away. */
407         phcsm = ipv6_tx_csum ( iobuf, 0 );
408
409         /* Strip header */
410         iob_unput ( iobuf, iob_len ( iobuf ) - ntohs ( ip6hdr->payload_len ) -
411                                                         sizeof ( *ip6hdr ) );
412         iob_pull ( iobuf, sizeof ( *ip6hdr ) );
413
414         /* Send it to the transport layer */
415         return ipv6_process_nxt_hdr ( iobuf, ip6hdr->nxt_hdr, &src.st, &dest.st,
416                                       netdev, phcsm );
417
418   drop:
419         DBG ( "IP6 packet dropped\n" );
420         free_iob ( iobuf );
421         return -1;
422 }
423
424 /**
425  * Convert an IPv6 address to a string.
426  *
427  * @v in6   Address to convert to string.
428  *
429  * Converts an IPv6 address to a string, and applies zero-compression as needed
430  * to condense the address for easier reading/typing.
431  */
432 char * inet6_ntoa ( struct in6_addr in6 ) {
433         static char buf[40];
434         uint16_t *bytes = ( uint16_t* ) &in6;
435         size_t i = 0, longest = 0, tmp = 0, long_idx = ~0;
436         
437         /* ::0 */
438         if ( IP6_EQUAL ( in6, ip6_none ) ) {
439                 tmp = sprintf ( buf, "::0" );
440                 buf[tmp] = 0;
441                 return buf;
442         }
443
444         /* Determine the longest string of zeroes for zero-compression. */
445         for ( ; i < 8; i++ ) {
446                 if ( !bytes[i] )
447                         tmp++;
448                 else if(tmp > longest) {
449                         longest = tmp;
450                         long_idx = i - longest;
451                         
452                         tmp = 0;
453                 }
454         }
455         
456         /* Check for last word being zero. This will cause long_idx to be zero,
457          * which confuses the actual buffer fill code. */
458         if(tmp && (tmp > longest)) {
459                 longest = tmp;
460                 long_idx = 8 - longest;
461         }
462
463         /* Inject into the buffer. */
464         tmp = 0;
465         for ( i = 0; i < 8; i++ ) {
466                 /* Should we skip over a string of zeroes? */
467                 if ( i == long_idx ) {
468                         i += longest;
469                         tmp += sprintf( buf + tmp, ":" );
470
471                         /* Handle end-of-string. */
472                         if(i > 7)
473                                 break;
474                 }
475
476                 /* Insert this component of the address. */
477                 tmp += sprintf(buf + tmp, "%x", ntohs(bytes[i]));
478
479                 /* Add the next colon, if needed. */
480                 if ( i < 7 )
481                         tmp += sprintf( buf + tmp, ":" );
482         }
483
484         buf[tmp] = 0;
485
486         return buf;
487 }
488
489 /**
490  * Convert a string to an IPv6 address.
491  *
492  * @v in6   String to convert to an address.
493  */
494 int inet6_aton ( const char *cp, struct in6_addr *inp ) {
495         char convbuf[40];
496         char *tmp = convbuf, *next = convbuf;
497         size_t i = 0;
498         
499         strcpy ( convbuf, cp );
500         
501         DBG ( "ipv6 converting %s to an in6_addr\n", cp );
502         
503         /* Handle the first part of the address (or all of it if no zero-compression. */
504         while ( ( next = strchr ( next, ':' ) ) ) {
505                 /* Cater for zero-compression. */
506                 if ( *tmp == ':' )
507                         break;
508                 
509                 /* Convert to integer. */
510                 inp->s6_addr16[i++] = htons( strtoul ( tmp, 0, 16 ) );
511                 
512                 *next++ = 0;
513                 tmp = next;
514         }
515         
516         /* Handle the case where no zero-compression is needed, but every word
517          * was filled in the address. */
518         if ( ( i == 7 ) && ( *tmp != ':' ) ) {
519                 inp->s6_addr16[i++] = htons( strtoul ( tmp, 0, 16 ) );
520         }
521         else
522         {
523                 /* Handle zero-compression now (go backwards). */
524                 i = 7;
525                 if ( i && ( *tmp == ':' ) ) {
526                         next = strrchr ( next, ':' );
527                         do
528                         {
529                                 tmp = next + 1;
530                                 *next-- = 0;
531         
532                                 /* Convert to integer. */
533                                 inp->s6_addr16[i--] = htons( strtoul ( tmp, 0, 16 ) );
534                         } while ( ( next = strrchr ( next, ':' ) ) );
535                 }
536         }
537         
538         return 1;
539 }
540
541 static const char * ipv6_ntoa ( const void *net_addr ) {
542         return inet6_ntoa ( * ( ( struct in6_addr * ) net_addr ) );
543 }
544
545 static int ipv6_check ( struct net_device *netdev, const void *net_addr ) {
546         const struct in6_addr *address = net_addr;
547         struct ipv6_miniroute *miniroute;
548
549         list_for_each_entry ( miniroute, &miniroutes, list ) {
550                 if ( ( miniroute->netdev == netdev ) &&
551                      ( ! memcmp ( &miniroute->address, address, 16 ) ) ) {
552                         /* Found matching address */
553                         return 0;
554                 }
555         }
556         return -ENOENT;
557 }
558
559 /** IPv6 protocol */
560 struct net_protocol ipv6_protocol __net_protocol = {
561         .name = "IPV6",
562         .net_proto = htons ( ETH_P_IPV6 ),
563         .net_addr_len = sizeof ( struct in6_addr ),
564         .rx = ipv6_rx,
565         .ntoa = ipv6_ntoa,
566 };
567
568 /** IPv6 TCPIP net protocol */
569 struct tcpip_net_protocol ipv6_tcpip_protocol __tcpip_net_protocol = {
570         .name = "IPv6",
571         .sa_family = AF_INET6,
572         .tx = ipv6_tx,
573 };
574
575 /** IPv6 ICMPv6 protocol, for NDP */
576 struct icmp6_net_protocol ipv6_icmp6_protocol __icmp6_net_protocol = {
577         .net_protocol = &ipv6_protocol,
578         .check = ipv6_check,
579 };
580