IP6 link-local table
[vpp.git] / src / vnet / ip / ip6.h
1 /*
2  * Copyright (c) 2016 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 /*
16  * ip/ip6.h: ip6 main include file
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
20  * Permission is hereby granted, free of charge, to any person obtaining
21  * a copy of this software and associated documentation files (the
22  * "Software"), to deal in the Software without restriction, including
23  * without limitation the rights to use, copy, modify, merge, publish,
24  * distribute, sublicense, and/or sell copies of the Software, and to
25  * permit persons to whom the Software is furnished to do so, subject to
26  * the following conditions:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38  */
39
40 #ifndef included_ip_ip6_h
41 #define included_ip_ip6_h
42
43 #include <vlib/mc.h>
44 #include <vlib/buffer.h>
45 #include <vnet/ethernet/packet.h>
46 #include <vnet/ip/ip6_packet.h>
47 #include <vnet/ip/ip6_hop_by_hop_packet.h>
48 #include <vnet/ip/lookup.h>
49 #include <stdbool.h>
50 #include <vppinfra/bihash_24_8.h>
51 #include <vppinfra/bihash_template.h>
52 #include <vnet/util/radix.h>
53
54 /*
55  * Default size of the ip6 fib hash table
56  */
57 #define IP6_FIB_DEFAULT_HASH_NUM_BUCKETS (64 * 1024)
58 #define IP6_FIB_DEFAULT_HASH_MEMORY_SIZE (32<<20)
59
60 typedef struct
61 {
62   ip6_address_t addr;
63   u32 dst_address_length;
64   u32 vrf_index;
65 } ip6_fib_key_t;
66
67 typedef struct
68 {
69   /* Table ID (hash key) for this FIB. */
70   u32 table_id;
71
72   /* Index into FIB vector. */
73   u32 index;
74 } ip6_fib_t;
75
76 typedef struct ip6_mfib_t
77 {
78   /* Table ID (hash key) for this FIB. */
79   u32 table_id;
80
81   /* Index into FIB vector. */
82   u32 index;
83
84   /*
85    *  Pointer to the top of a radix tree.
86    * This cannot be realloc'd, hence it cannot be inlined with this table
87    */
88   struct radix_node_head *rhead;
89 } ip6_mfib_t;
90
91 struct ip6_main_t;
92
93 typedef void (ip6_add_del_interface_address_function_t)
94   (struct ip6_main_t * im,
95    uword opaque,
96    u32 sw_if_index,
97    ip6_address_t * address,
98    u32 address_length, u32 if_address_index, u32 is_del);
99
100 typedef struct
101 {
102   ip6_add_del_interface_address_function_t *function;
103   uword function_opaque;
104 } ip6_add_del_interface_address_callback_t;
105
106 typedef void (ip6_table_bind_function_t)
107   (struct ip6_main_t * im,
108    uword opaque, u32 sw_if_index, u32 new_fib_index, u32 old_fib_index);
109
110 typedef struct
111 {
112   ip6_table_bind_function_t *function;
113   uword function_opaque;
114 } ip6_table_bind_callback_t;
115
116 /**
117  * Enumeration of the FIB table instance types
118  */
119 typedef enum ip6_fib_table_instance_type_t_
120 {
121     /**
122      * This table stores the routes that are used to forward traffic.
123      * The key is the prefix, the result the adjacnecy to forward on.
124      */
125   IP6_FIB_TABLE_FWDING,
126     /**
127      * The table that stores ALL routes learned by the DP.
128      * Some of these routes may not be ready to install in forwarding
129      * at a given time.
130      * The key in this table is the prefix, the result is the fib_entry_t
131      */
132   IP6_FIB_TABLE_NON_FWDING,
133 } ip6_fib_table_instance_type_t;
134
135 #define IP6_FIB_NUM_TABLES (IP6_FIB_TABLE_NON_FWDING+1)
136
137 /**
138  * A represenation of a single IP6 table
139  */
140 typedef struct ip6_fib_table_instance_t_
141 {
142   /* The hash table */
143   BVT (clib_bihash) ip6_hash;
144
145   /* bitmap / refcounts / vector of mask widths to search */
146   uword *non_empty_dst_address_length_bitmap;
147   u8 *prefix_lengths_in_search_order;
148   i32 dst_address_length_refcounts[129];
149 } ip6_fib_table_instance_t;
150
151 typedef struct ip6_main_t
152 {
153   /**
154    * The two FIB tables; fwding and non-fwding
155    */
156   ip6_fib_table_instance_t ip6_table[IP6_FIB_NUM_TABLES];
157
158   ip_lookup_main_t lookup_main;
159
160   /* Pool of FIBs. */
161   struct fib_table_t_ *fibs;
162
163   /* Pool of V6 FIBs. */
164   ip6_fib_t *v6_fibs;
165
166   /** Vector of MFIBs. */
167   struct mfib_table_t_ *mfibs;
168
169   /* Network byte orders subnet mask for each prefix length */
170   ip6_address_t fib_masks[129];
171
172   /* Table index indexed by software interface. */
173   u32 *fib_index_by_sw_if_index;
174
175   /** Table index indexed by software interface. */
176   u32 *mfib_index_by_sw_if_index;
177
178   /* IP6 enabled count by software interface */
179   u8 *ip_enabled_by_sw_if_index;
180
181   /* Hash table mapping table id to fib index.
182      ID space is not necessarily dense; index space is dense. */
183   uword *fib_index_by_table_id;
184
185   /** Hash table mapping table id to multicast fib index.
186      ID space is not necessarily dense; index space is dense. */
187   uword *mfib_index_by_table_id;
188
189   /* Hash table mapping interface rewrite adjacency index by sw if index. */
190   uword *interface_route_adj_index_by_sw_if_index;
191
192   /* Functions to call when interface address changes. */
193     ip6_add_del_interface_address_callback_t
194     * add_del_interface_address_callbacks;
195
196   /** Functions to call when interface to table biding changes. */
197   ip6_table_bind_callback_t *table_bind_callbacks;
198
199   /* Template used to generate IP6 neighbor solicitation packets. */
200   vlib_packet_template_t discover_neighbor_packet_template;
201
202   /* ip6 lookup table config parameters */
203   u32 lookup_table_nbuckets;
204   uword lookup_table_size;
205
206   /* Seed for Jenkins hash used to compute ip6 flow hash. */
207   u32 flow_hash_seed;
208
209   struct
210   {
211     /* TTL to use for host generated packets. */
212     u8 ttl;
213
214     u8 pad[3];
215   } host_config;
216
217   /* HBH processing enabled? */
218   u8 hbh_enabled;
219 } ip6_main_t;
220
221 /* Global ip6 main structure. */
222 extern ip6_main_t ip6_main;
223
224 /* Global ip6 input node.  Errors get attached to ip6 input node. */
225 extern vlib_node_registration_t ip6_input_node;
226 extern vlib_node_registration_t ip6_rewrite_node;
227 extern vlib_node_registration_t ip6_rewrite_mcast_node;
228 extern vlib_node_registration_t ip6_rewrite_local_node;
229 extern vlib_node_registration_t ip6_discover_neighbor_node;
230 extern vlib_node_registration_t ip6_glean_node;
231 extern vlib_node_registration_t ip6_midchain_node;
232
233 extern void ip6_forward_next_trace (vlib_main_t * vm,
234                                     vlib_node_runtime_t * node,
235                                     vlib_frame_t * frame,
236                                     vlib_rx_or_tx_t which_adj_index);
237
238 always_inline uword
239 ip6_destination_matches_route (const ip6_main_t * im,
240                                const ip6_address_t * key,
241                                const ip6_address_t * dest, uword dest_length)
242 {
243   int i;
244   for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
245     {
246       if ((key->as_uword[i] ^ dest->as_uword[i]) & im->
247           fib_masks[dest_length].as_uword[i])
248         return 0;
249     }
250   return 1;
251 }
252
253 always_inline uword
254 ip6_destination_matches_interface (ip6_main_t * im,
255                                    ip6_address_t * key,
256                                    ip_interface_address_t * ia)
257 {
258   ip6_address_t *a = ip_interface_address_get_address (&im->lookup_main, ia);
259   return ip6_destination_matches_route (im, key, a, ia->address_length);
260 }
261
262 /* As above but allows for unaligned destinations (e.g. works right from IP header of packet). */
263 always_inline uword
264 ip6_unaligned_destination_matches_route (ip6_main_t * im,
265                                          ip6_address_t * key,
266                                          ip6_address_t * dest,
267                                          uword dest_length)
268 {
269   int i;
270   for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
271     {
272       if ((clib_mem_unaligned (&key->as_uword[i], uword) ^ dest->as_uword[i])
273           & im->fib_masks[dest_length].as_uword[i])
274         return 0;
275     }
276   return 1;
277 }
278
279 extern int ip6_get_ll_address (u32 sw_if_index, ip6_address_t * addr);
280
281 always_inline int
282 ip6_src_address_for_packet (ip_lookup_main_t * lm,
283                             u32 sw_if_index,
284                             const ip6_address_t * dst, ip6_address_t * src)
285 {
286   if (ip6_address_is_link_local_unicast (dst))
287     {
288       return ip6_get_ll_address (sw_if_index, src);
289     }
290   else
291     {
292       u32 if_add_index =
293         lm->if_address_pool_index_by_sw_if_index[sw_if_index];
294       if (PREDICT_TRUE (if_add_index != ~0))
295         {
296           ip_interface_address_t *if_add =
297             pool_elt_at_index (lm->if_address_pool, if_add_index);
298           ip6_address_t *if_ip =
299             ip_interface_address_get_address (lm, if_add);
300           *src = *if_ip;
301           return (!0);
302         }
303     }
304
305   src->as_u64[0] = 0;
306   src->as_u64[1] = 0;
307
308   return (0);
309 }
310
311 /* Find interface address which matches destination. */
312 always_inline ip6_address_t *
313 ip6_interface_address_matching_destination (ip6_main_t * im,
314                                             ip6_address_t * dst,
315                                             u32 sw_if_index,
316                                             ip_interface_address_t **
317                                             result_ia)
318 {
319   ip_lookup_main_t *lm = &im->lookup_main;
320   ip_interface_address_t *ia;
321   ip6_address_t *result = 0;
322
323   /* *INDENT-OFF* */
324   foreach_ip_interface_address (lm, ia, sw_if_index,
325                                 1 /* honor unnumbered */,
326   ({
327     ip6_address_t * a = ip_interface_address_get_address (lm, ia);
328     if (ip6_destination_matches_route (im, dst, a, ia->address_length))
329       {
330         result = a;
331         break;
332       }
333   }));
334   /* *INDENT-ON* */
335   if (result_ia)
336     *result_ia = result ? ia : 0;
337   return result;
338 }
339
340 clib_error_t *ip6_add_del_interface_address (vlib_main_t * vm,
341                                              u32 sw_if_index,
342                                              ip6_address_t * address,
343                                              u32 address_length, u32 is_del);
344 void ip6_sw_interface_enable_disable (u32 sw_if_index, u32 is_enable);
345
346 /**
347  * @brie get first IPv6 interface address
348  */
349 ip6_address_t *ip6_interface_first_address (ip6_main_t * im, u32 sw_if_index);
350
351 int ip6_address_compare (ip6_address_t * a1, ip6_address_t * a2);
352
353 clib_error_t *ip6_probe_neighbor (vlib_main_t * vm, ip6_address_t * dst,
354                                   u32 sw_if_index);
355
356 uword
357 ip6_udp_register_listener (vlib_main_t * vm,
358                            u16 dst_port, u32 next_node_index);
359
360 u16 ip6_tcp_udp_icmp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0,
361                                        ip6_header_t * ip0,
362                                        int *bogus_lengthp);
363
364 void ip6_register_protocol (u32 protocol, u32 node_index);
365
366 serialize_function_t serialize_vnet_ip6_main, unserialize_vnet_ip6_main;
367
368 void ip6_ethernet_update_adjacency (vnet_main_t * vnm,
369                                     u32 sw_if_index, u32 ai);
370
371
372 void
373 ip6_link_local_address_from_ethernet_mac_address (ip6_address_t * ip,
374                                                   u8 * mac);
375
376 void
377 ip6_ethernet_mac_address_from_link_local_address (u8 * mac,
378                                                   ip6_address_t * ip);
379
380 int vnet_set_ip6_flow_hash (u32 table_id,
381                             flow_hash_config_t flow_hash_config);
382
383 clib_error_t *enable_ip6_interface (vlib_main_t * vm, u32 sw_if_index);
384
385 clib_error_t *disable_ip6_interface (vlib_main_t * vm, u32 sw_if_index);
386
387 int ip6_interface_enabled (vlib_main_t * vm, u32 sw_if_index);
388
389 clib_error_t *set_ip6_link_local_address (vlib_main_t * vm,
390                                           u32 sw_if_index,
391                                           ip6_address_t * address);
392
393 int vnet_add_del_ip6_nd_change_event (vnet_main_t * vnm,
394                                       void *data_callback,
395                                       u32 pid,
396                                       void *address_arg,
397                                       uword node_index,
398                                       uword type_opaque,
399                                       uword data, int is_add);
400
401 int vnet_ip6_nd_term (vlib_main_t * vm,
402                       vlib_node_runtime_t * node,
403                       vlib_buffer_t * p0,
404                       ethernet_header_t * eth,
405                       ip6_header_t * ip, u32 sw_if_index, u16 bd_index);
406
407 void send_ip6_na (vlib_main_t * vm, vnet_hw_interface_t * hi);
408
409 u8 *format_ip6_forward_next_trace (u8 * s, va_list * args);
410
411 u32 ip6_tcp_udp_icmp_validate_checksum (vlib_main_t * vm, vlib_buffer_t * p0);
412
413 void ip6_punt_policer_add_del (u8 is_add, u32 policer_index);
414 void ip6_punt_redirect_add (u32 rx_sw_if_index,
415                             u32 tx_sw_if_index, ip46_address_t * nh);
416 void ip6_punt_redirect_del (u32 rx_sw_if_index);
417
418 int vnet_set_ip6_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
419                                  u32 table_index);
420 extern vlib_node_registration_t ip6_lookup_node;
421
422 /* Compute flow hash.  We'll use it to select which Sponge to use for this
423    flow.  And other things. */
424 always_inline u32
425 ip6_compute_flow_hash (const ip6_header_t * ip,
426                        flow_hash_config_t flow_hash_config)
427 {
428   tcp_header_t *tcp;
429   u64 a, b, c;
430   u64 t1, t2;
431   uword is_tcp_udp = 0;
432   u8 protocol = ip->protocol;
433
434   if (PREDICT_TRUE
435       ((ip->protocol == IP_PROTOCOL_TCP)
436        || (ip->protocol == IP_PROTOCOL_UDP)))
437     {
438       is_tcp_udp = 1;
439       tcp = (void *) (ip + 1);
440     }
441   else if (ip->protocol == IP_PROTOCOL_IP6_HOP_BY_HOP_OPTIONS)
442     {
443       ip6_hop_by_hop_header_t *hbh = (ip6_hop_by_hop_header_t *) (ip + 1);
444       if ((hbh->protocol == IP_PROTOCOL_TCP) ||
445           (hbh->protocol == IP_PROTOCOL_UDP))
446         {
447           is_tcp_udp = 1;
448           tcp = (tcp_header_t *) ((u8 *) hbh + ((hbh->length + 1) << 3));
449         }
450       protocol = hbh->protocol;
451     }
452
453   t1 = (ip->src_address.as_u64[0] ^ ip->src_address.as_u64[1]);
454   t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR) ? t1 : 0;
455
456   t2 = (ip->dst_address.as_u64[0] ^ ip->dst_address.as_u64[1]);
457   t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR) ? t2 : 0;
458
459   a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
460   b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
461   b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? protocol : 0;
462
463   t1 = is_tcp_udp ? tcp->src : 0;
464   t2 = is_tcp_udp ? tcp->dst : 0;
465
466   t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
467   t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
468
469   c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
470     ((t1 << 16) | t2) : ((t2 << 16) | t1);
471
472   hash_mix64 (a, b, c);
473   return (u32) c;
474 }
475
476 /* ip6_locate_header
477  *
478  * This function is to search for the header specified by the protocol number
479  * in find_hdr_type.
480  * This is used to locate a specific IPv6 extension header
481  * or to find transport layer header.
482  *   1. If the find_hdr_type < 0 then it finds and returns the protocol number and
483  *   offset stored in *offset of the transport or ESP header in the chain if
484  *   found.
485  *   2. If a header with find_hdr_type > 0 protocol number is found then the
486  *      offset is stored in *offset and protocol number of the header is
487  *      returned.
488  *   3. If find_hdr_type is not found or packet is malformed or
489  *      it is a non-first fragment -1 is returned.
490  */
491 always_inline int
492 ip6_locate_header (vlib_buffer_t * p0,
493                    ip6_header_t * ip0, int find_hdr_type, u32 * offset)
494 {
495   u8 next_proto = ip0->protocol;
496   u8 *next_header;
497   u8 done = 0;
498   u32 cur_offset;
499   u8 *temp_nxthdr = 0;
500   u32 exthdr_len = 0;
501
502   next_header = ip6_next_header (ip0);
503   cur_offset = sizeof (ip6_header_t);
504   while (1)
505     {
506       done = (next_proto == find_hdr_type);
507       if (PREDICT_FALSE
508           (next_header >=
509            (u8 *) vlib_buffer_get_current (p0) + p0->current_length))
510         {
511           //A malicious packet could set an extension header with a too big size
512           return (-1);
513         }
514       if (done)
515         break;
516       if ((!ip6_ext_hdr (next_proto)) || next_proto == IP_PROTOCOL_IP6_NONXT)
517         {
518           if (find_hdr_type < 0)
519             break;
520           return -1;
521         }
522       if (next_proto == IP_PROTOCOL_IPV6_FRAGMENTATION)
523         {
524           ip6_frag_hdr_t *frag_hdr = (ip6_frag_hdr_t *) next_header;
525           u16 frag_off = ip6_frag_hdr_offset (frag_hdr);
526           /* Non first fragment return -1 */
527           if (frag_off)
528             return (-1);
529           exthdr_len = sizeof (ip6_frag_hdr_t);
530           temp_nxthdr = next_header + exthdr_len;
531         }
532       else if (next_proto == IP_PROTOCOL_IPSEC_AH)
533         {
534           exthdr_len =
535             ip6_ext_authhdr_len (((ip6_ext_header_t *) next_header));
536           temp_nxthdr = next_header + exthdr_len;
537         }
538       else
539         {
540           exthdr_len =
541             ip6_ext_header_len (((ip6_ext_header_t *) next_header));
542           temp_nxthdr = next_header + exthdr_len;
543         }
544       next_proto = ((ip6_ext_header_t *) next_header)->next_hdr;
545       next_header = temp_nxthdr;
546       cur_offset += exthdr_len;
547     }
548
549   *offset = cur_offset;
550   return (next_proto);
551 }
552
553 u8 *format_ip6_hop_by_hop_ext_hdr (u8 * s, va_list * args);
554 /*
555  * Hop-by-Hop handling
556  */
557 typedef struct
558 {
559   /* Array of function pointers to HBH option handling routines */
560   int (*options[256]) (vlib_buffer_t * b, ip6_header_t * ip,
561                        ip6_hop_by_hop_option_t * opt);
562   u8 *(*trace[256]) (u8 * s, ip6_hop_by_hop_option_t * opt);
563   uword next_override;
564 } ip6_hop_by_hop_main_t;
565
566 extern ip6_hop_by_hop_main_t ip6_hop_by_hop_main;
567
568 int ip6_hbh_register_option (u8 option,
569                              int options (vlib_buffer_t * b,
570                                           ip6_header_t * ip,
571                                           ip6_hop_by_hop_option_t * opt),
572                              u8 * trace (u8 * s,
573                                          ip6_hop_by_hop_option_t * opt));
574 int ip6_hbh_unregister_option (u8 option);
575 void ip6_hbh_set_next_override (uword next);
576
577 /**
578  * Push IPv6 header to buffer
579  *
580  * @param vm - vlib_main
581  * @param b - buffer to write the header to
582  * @param src - source IP
583  * @param dst - destination IP
584  * @param prot - payload proto
585  *
586  * @return - pointer to start of IP header
587  */
588 always_inline void *
589 vlib_buffer_push_ip6 (vlib_main_t * vm, vlib_buffer_t * b,
590                       ip6_address_t * src, ip6_address_t * dst, int proto)
591 {
592   ip6_header_t *ip6h;
593   u16 payload_length;
594
595   /* make some room */
596   ip6h = vlib_buffer_push_uninit (b, sizeof (ip6_header_t));
597
598   ip6h->ip_version_traffic_class_and_flow_label =
599     clib_host_to_net_u32 (0x6 << 28);
600
601   /* calculate ip6 payload length */
602   payload_length = vlib_buffer_length_in_chain (vm, b);
603   payload_length -= sizeof (*ip6h);
604
605   ip6h->payload_length = clib_host_to_net_u16 (payload_length);
606
607   ip6h->hop_limit = 0xff;
608   ip6h->protocol = proto;
609   clib_memcpy (ip6h->src_address.as_u8, src->as_u8,
610                sizeof (ip6h->src_address));
611   clib_memcpy (ip6h->dst_address.as_u8, dst->as_u8,
612                sizeof (ip6h->src_address));
613   b->flags |= VNET_BUFFER_F_IS_IP6;
614
615   return ip6h;
616 }
617
618 #endif /* included_ip_ip6_h */
619
620 /*
621  * fd.io coding-style-patch-verification: ON
622  *
623  * Local Variables:
624  * eval: (c-set-style "gnu")
625  * End:
626  */