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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 * ip/ip6.h: ip6 main include file
18 * Copyright (c) 2008 Eliot Dresselhaus
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:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
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.
40 #ifndef included_ip_ip6_h
41 #define included_ip_ip6_h
43 #include <vlib/buffer.h>
44 #include <vnet/ethernet/packet.h>
45 #include <vnet/ethernet/mac_address.h>
46 #include <vnet/ip/ip6_packet.h>
47 #include <vnet/ip/ip6_hop_by_hop_packet.h>
48 #include <vnet/ip/lookup.h>
50 #include <vppinfra/bihash_24_8.h>
51 #include <vppinfra/bihash_40_8.h>
52 #include <vppinfra/bihash_template.h>
53 #include <vnet/util/radix.h>
54 #include <vnet/util/throttle.h>
57 * Default size of the ip6 fib hash table
59 #define IP6_FIB_DEFAULT_HASH_NUM_BUCKETS (64 * 1024)
60 #define IP6_FIB_DEFAULT_HASH_MEMORY_SIZE (32<<20)
65 u32 dst_address_length;
71 /* required for pool_get_aligned. */
72 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
74 /* Table ID (hash key) for this FIB. */
77 /* Index into FIB vector. */
81 typedef struct ip6_mfib_t
83 /* required for pool_get_aligned. */
84 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
86 /* Table ID (hash key) for this FIB. */
89 /* Index into FIB vector. */
95 typedef void (ip6_add_del_interface_address_function_t)
96 (struct ip6_main_t * im,
99 ip6_address_t * address,
100 u32 address_length, u32 if_address_index, u32 is_del);
104 ip6_add_del_interface_address_function_t *function;
105 uword function_opaque;
106 } ip6_add_del_interface_address_callback_t;
108 typedef void (ip6_table_bind_function_t)
109 (struct ip6_main_t * im,
110 uword opaque, u32 sw_if_index, u32 new_fib_index, u32 old_fib_index);
114 ip6_table_bind_function_t *function;
115 uword function_opaque;
116 } ip6_table_bind_callback_t;
119 * Enumeration of the FIB table instance types
121 typedef enum ip6_fib_table_instance_type_t_
124 * This table stores the routes that are used to forward traffic.
125 * The key is the prefix, the result the adjacnecy to forward on.
127 IP6_FIB_TABLE_FWDING,
129 * The table that stores ALL routes learned by the DP.
130 * Some of these routes may not be ready to install in forwarding
132 * The key in this table is the prefix, the result is the fib_entry_t
134 IP6_FIB_TABLE_NON_FWDING,
135 } ip6_fib_table_instance_type_t;
137 #define IP6_FIB_NUM_TABLES (IP6_FIB_TABLE_NON_FWDING+1)
140 * A represenation of a single IP6 table
142 typedef struct ip6_fib_table_instance_t_
145 clib_bihash_24_8_t ip6_hash;
147 /* bitmap / refcounts / vector of mask widths to search */
148 uword *non_empty_dst_address_length_bitmap;
149 u8 *prefix_lengths_in_search_order;
150 i32 dst_address_length_refcounts[129];
151 } ip6_fib_table_instance_t;
154 * A represenation of a single IP6 mfib table
156 typedef struct ip6_mfib_table_instance_t_
159 clib_bihash_40_8_t ip6_mhash;
161 /* bitmap / refcounts / vector of mask widths to search */
162 uword *non_empty_dst_address_length_bitmap;
163 u16 *prefix_lengths_in_search_order;
164 i32 dst_address_length_refcounts[257];
165 } ip6_mfib_table_instance_t;
167 typedef struct ip6_main_t
170 * The two FIB tables; fwding and non-fwding
172 ip6_fib_table_instance_t ip6_table[IP6_FIB_NUM_TABLES];
175 * the single MFIB table
177 ip6_mfib_table_instance_t ip6_mtable;
179 ip_lookup_main_t lookup_main;
182 struct fib_table_t_ *fibs;
184 /* Pool of V6 FIBs. */
187 /** Vector of MFIBs. */
188 struct mfib_table_t_ *mfibs;
190 /* Network byte orders subnet mask for each prefix length */
191 ip6_address_t fib_masks[129];
193 /* Table index indexed by software interface. */
194 u32 *fib_index_by_sw_if_index;
196 /** Table index indexed by software interface. */
197 u32 *mfib_index_by_sw_if_index;
199 /* IP6 enabled count by software interface */
200 u8 *ip_enabled_by_sw_if_index;
202 /* Hash table mapping table id to fib index.
203 ID space is not necessarily dense; index space is dense. */
204 uword *fib_index_by_table_id;
206 /** Hash table mapping table id to multicast fib index.
207 ID space is not necessarily dense; index space is dense. */
208 uword *mfib_index_by_table_id;
210 /* Hash table mapping interface rewrite adjacency index by sw if index. */
211 uword *interface_route_adj_index_by_sw_if_index;
213 /* Functions to call when interface address changes. */
214 ip6_add_del_interface_address_callback_t
215 * add_del_interface_address_callbacks;
217 /** Functions to call when interface to table biding changes. */
218 ip6_table_bind_callback_t *table_bind_callbacks;
220 /* Template used to generate IP6 neighbor solicitation packets. */
221 vlib_packet_template_t discover_neighbor_packet_template;
223 /* ip6 lookup table config parameters */
224 u32 lookup_table_nbuckets;
225 uword lookup_table_size;
227 /* Seed for Jenkins hash used to compute ip6 flow hash. */
232 /* TTL to use for host generated packets. */
238 /* HBH processing enabled? */
242 throttle_t nd_throttle;
245 #define ND_THROTTLE_BITS 512
247 /* Global ip6 main structure. */
248 extern ip6_main_t ip6_main;
250 /* Global ip6 input node. Errors get attached to ip6 input node. */
251 extern vlib_node_registration_t ip6_input_node;
252 extern vlib_node_registration_t ip6_rewrite_node;
253 extern vlib_node_registration_t ip6_rewrite_mcast_node;
254 extern vlib_node_registration_t ip6_rewrite_local_node;
255 extern vlib_node_registration_t ip6_discover_neighbor_node;
256 extern vlib_node_registration_t ip6_glean_node;
257 extern vlib_node_registration_t ip6_midchain_node;
259 extern void ip6_forward_next_trace (vlib_main_t * vm,
260 vlib_node_runtime_t * node,
261 vlib_frame_t * frame,
262 vlib_rx_or_tx_t which_adj_index);
265 ip6_destination_matches_route (const ip6_main_t * im,
266 const ip6_address_t * key,
267 const ip6_address_t * dest, uword dest_length)
270 for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
272 if ((key->as_uword[i] ^ dest->as_uword[i]) & im->
273 fib_masks[dest_length].as_uword[i])
280 ip6_destination_matches_interface (ip6_main_t * im,
282 ip_interface_address_t * ia)
284 ip6_address_t *a = ip_interface_address_get_address (&im->lookup_main, ia);
285 return ip6_destination_matches_route (im, key, a, ia->address_length);
288 /* As above but allows for unaligned destinations (e.g. works right from IP header of packet). */
290 ip6_unaligned_destination_matches_route (ip6_main_t * im,
292 ip6_address_t * dest,
296 for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
298 if ((clib_mem_unaligned (&key->as_uword[i], uword) ^ dest->as_uword[i])
299 & im->fib_masks[dest_length].as_uword[i])
305 extern int ip6_get_ll_address (u32 sw_if_index, ip6_address_t * addr);
308 ip6_src_address_for_packet (ip_lookup_main_t * lm,
310 const ip6_address_t * dst, ip6_address_t * src)
312 if (ip6_address_is_link_local_unicast (dst))
314 return ip6_get_ll_address (sw_if_index, src);
319 lm->if_address_pool_index_by_sw_if_index[sw_if_index];
320 if (PREDICT_TRUE (if_add_index != ~0))
322 ip_interface_address_t *if_add =
323 pool_elt_at_index (lm->if_address_pool, if_add_index);
324 ip6_address_t *if_ip =
325 ip_interface_address_get_address (lm, if_add);
337 /* Find interface address which matches destination. */
338 always_inline ip6_address_t *
339 ip6_interface_address_matching_destination (ip6_main_t * im,
342 ip_interface_address_t **
345 ip_lookup_main_t *lm = &im->lookup_main;
346 ip_interface_address_t *ia;
347 ip6_address_t *result = 0;
350 foreach_ip_interface_address (lm, ia, sw_if_index,
351 1 /* honor unnumbered */,
353 ip6_address_t * a = ip_interface_address_get_address (lm, ia);
354 if (ip6_destination_matches_route (im, dst, a, ia->address_length))
362 *result_ia = result ? ia : 0;
366 clib_error_t *ip6_add_del_interface_address (vlib_main_t * vm,
368 ip6_address_t * address,
369 u32 address_length, u32 is_del);
370 void ip6_sw_interface_enable_disable (u32 sw_if_index, u32 is_enable);
373 * @brie get first IPv6 interface address
375 ip6_address_t *ip6_interface_first_address (ip6_main_t * im, u32 sw_if_index);
377 int ip6_address_compare (ip6_address_t * a1, ip6_address_t * a2);
379 clib_error_t *ip6_probe_neighbor (vlib_main_t * vm, ip6_address_t * dst,
380 u32 sw_if_index, u8 refresh);
383 ip6_udp_register_listener (vlib_main_t * vm,
384 u16 dst_port, u32 next_node_index);
386 u16 ip6_tcp_udp_icmp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0,
390 void ip6_register_protocol (u32 protocol, u32 node_index);
392 serialize_function_t serialize_vnet_ip6_main, unserialize_vnet_ip6_main;
394 void ip6_ethernet_update_adjacency (vnet_main_t * vnm,
395 u32 sw_if_index, u32 ai);
398 ip6_link_local_address_from_ethernet_mac_address (ip6_address_t * ip,
401 ip->as_u64[0] = clib_host_to_net_u64 (0xFE80000000000000ULL);
402 /* Invert the "u" bit */
403 ip->as_u8[8] = mac[0] ^ (1 << 1);
404 ip->as_u8[9] = mac[1];
405 ip->as_u8[10] = mac[2];
406 ip->as_u8[11] = 0xFF;
407 ip->as_u8[12] = 0xFE;
408 ip->as_u8[13] = mac[3];
409 ip->as_u8[14] = mac[4];
410 ip->as_u8[15] = mac[5];
414 ip6_ethernet_mac_address_from_link_local_address (u8 * mac,
417 /* Invert the previously inverted "u" bit */
418 mac[0] = ip->as_u8[8] ^ (1 << 1);
419 mac[1] = ip->as_u8[9];
420 mac[2] = ip->as_u8[10];
421 mac[3] = ip->as_u8[13];
422 mac[4] = ip->as_u8[14];
423 mac[5] = ip->as_u8[15];
426 int vnet_set_ip6_flow_hash (u32 table_id,
427 flow_hash_config_t flow_hash_config);
429 clib_error_t *enable_ip6_interface (vlib_main_t * vm, u32 sw_if_index);
431 clib_error_t *disable_ip6_interface (vlib_main_t * vm, u32 sw_if_index);
433 int ip6_interface_enabled (vlib_main_t * vm, u32 sw_if_index);
435 clib_error_t *set_ip6_link_local_address (vlib_main_t * vm,
437 ip6_address_t * address);
439 typedef int (*ip6_nd_change_event_cb_t) (u32 pool_index,
440 const mac_address_t * new_mac,
442 const ip6_address_t * address);
444 int vnet_add_del_ip6_nd_change_event (vnet_main_t * vnm,
445 ip6_nd_change_event_cb_t data_callback,
450 uword data, int is_add);
452 int vnet_ip6_nd_term (vlib_main_t * vm,
453 vlib_node_runtime_t * node,
455 ethernet_header_t * eth,
456 ip6_header_t * ip, u32 sw_if_index, u16 bd_index);
458 void send_ip6_na (vlib_main_t * vm, u32 sw_if_index);
459 void send_ip6_na_w_addr (vlib_main_t * vm,
460 const ip6_address_t * addr, u32 sw_if_index);
462 u8 *format_ip6_forward_next_trace (u8 * s, va_list * args);
464 u32 ip6_tcp_udp_icmp_validate_checksum (vlib_main_t * vm, vlib_buffer_t * p0);
466 void ip6_punt_policer_add_del (u8 is_add, u32 policer_index);
467 void ip6_punt_redirect_add (u32 rx_sw_if_index,
468 u32 tx_sw_if_index, ip46_address_t * nh);
469 void ip6_punt_redirect_del (u32 rx_sw_if_index);
471 int vnet_set_ip6_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
473 extern vlib_node_registration_t ip6_lookup_node;
475 /* Compute flow hash. We'll use it to select which Sponge to use for this
476 flow. And other things. */
478 ip6_compute_flow_hash (const ip6_header_t * ip,
479 flow_hash_config_t flow_hash_config)
484 uword is_tcp_udp = 0;
485 u8 protocol = ip->protocol;
488 ((ip->protocol == IP_PROTOCOL_TCP)
489 || (ip->protocol == IP_PROTOCOL_UDP)))
492 tcp = (void *) (ip + 1);
494 else if (ip->protocol == IP_PROTOCOL_IP6_HOP_BY_HOP_OPTIONS)
496 ip6_hop_by_hop_header_t *hbh = (ip6_hop_by_hop_header_t *) (ip + 1);
497 if ((hbh->protocol == IP_PROTOCOL_TCP) ||
498 (hbh->protocol == IP_PROTOCOL_UDP))
501 tcp = (tcp_header_t *) ((u8 *) hbh + ((hbh->length + 1) << 3));
503 protocol = hbh->protocol;
506 t1 = (ip->src_address.as_u64[0] ^ ip->src_address.as_u64[1]);
507 t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR) ? t1 : 0;
509 t2 = (ip->dst_address.as_u64[0] ^ ip->dst_address.as_u64[1]);
510 t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR) ? t2 : 0;
512 a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
513 b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
515 t1 = is_tcp_udp ? tcp->src : 0;
516 t2 = is_tcp_udp ? tcp->dst : 0;
518 t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
519 t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
521 if (flow_hash_config & IP_FLOW_HASH_SYMMETRIC)
537 b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? protocol : 0;
538 c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
539 ((t1 << 16) | t2) : ((t2 << 16) | t1);
541 hash_mix64 (a, b, c);
547 * This function is to search for the header specified by the protocol number
549 * This is used to locate a specific IPv6 extension header
550 * or to find transport layer header.
551 * 1. If the find_hdr_type < 0 then it finds and returns the protocol number and
552 * offset stored in *offset of the transport or ESP header in the chain if
554 * 2. If a header with find_hdr_type > 0 protocol number is found then the
555 * offset is stored in *offset and protocol number of the header is
557 * 3. If find_hdr_type is not found or packet is malformed or
558 * it is a non-first fragment -1 is returned.
561 ip6_locate_header (vlib_buffer_t * p0,
562 ip6_header_t * ip0, int find_hdr_type, u32 * offset)
564 u8 next_proto = ip0->protocol;
571 next_header = ip6_next_header (ip0);
572 cur_offset = sizeof (ip6_header_t);
575 done = (next_proto == find_hdr_type);
578 (u8 *) vlib_buffer_get_current (p0) + p0->current_length))
580 //A malicious packet could set an extension header with a too big size
585 if ((!ip6_ext_hdr (next_proto)) || next_proto == IP_PROTOCOL_IP6_NONXT)
587 if (find_hdr_type < 0)
591 if (next_proto == IP_PROTOCOL_IPV6_FRAGMENTATION)
593 ip6_frag_hdr_t *frag_hdr = (ip6_frag_hdr_t *) next_header;
594 u16 frag_off = ip6_frag_hdr_offset (frag_hdr);
595 /* Non first fragment return -1 */
598 exthdr_len = sizeof (ip6_frag_hdr_t);
599 temp_nxthdr = next_header + exthdr_len;
601 else if (next_proto == IP_PROTOCOL_IPSEC_AH)
604 ip6_ext_authhdr_len (((ip6_ext_header_t *) next_header));
605 temp_nxthdr = next_header + exthdr_len;
610 ip6_ext_header_len (((ip6_ext_header_t *) next_header));
611 temp_nxthdr = next_header + exthdr_len;
613 next_proto = ((ip6_ext_header_t *) next_header)->next_hdr;
614 next_header = temp_nxthdr;
615 cur_offset += exthdr_len;
618 *offset = cur_offset;
622 u8 *format_ip6_hop_by_hop_ext_hdr (u8 * s, va_list * args);
624 * Hop-by-Hop handling
628 /* Array of function pointers to HBH option handling routines */
629 int (*options[256]) (vlib_buffer_t * b, ip6_header_t * ip,
630 ip6_hop_by_hop_option_t * opt);
631 u8 *(*trace[256]) (u8 * s, ip6_hop_by_hop_option_t * opt);
633 } ip6_hop_by_hop_main_t;
635 extern ip6_hop_by_hop_main_t ip6_hop_by_hop_main;
637 int ip6_hbh_register_option (u8 option,
638 int options (vlib_buffer_t * b,
640 ip6_hop_by_hop_option_t * opt),
642 ip6_hop_by_hop_option_t * opt));
643 int ip6_hbh_unregister_option (u8 option);
644 void ip6_hbh_set_next_override (uword next);
647 * Push IPv6 header to buffer
649 * @param vm - vlib_main
650 * @param b - buffer to write the header to
651 * @param src - source IP
652 * @param dst - destination IP
653 * @param prot - payload proto
655 * @return - pointer to start of IP header
658 vlib_buffer_push_ip6 (vlib_main_t * vm, vlib_buffer_t * b,
659 ip6_address_t * src, ip6_address_t * dst, int proto)
665 ip6h = vlib_buffer_push_uninit (b, sizeof (ip6_header_t));
667 ip6h->ip_version_traffic_class_and_flow_label =
668 clib_host_to_net_u32 (0x6 << 28);
670 /* calculate ip6 payload length */
671 payload_length = vlib_buffer_length_in_chain (vm, b);
672 payload_length -= sizeof (*ip6h);
674 ip6h->payload_length = clib_host_to_net_u16 (payload_length);
676 ip6h->hop_limit = 0xff;
677 ip6h->protocol = proto;
678 clib_memcpy_fast (ip6h->src_address.as_u8, src->as_u8,
679 sizeof (ip6h->src_address));
680 clib_memcpy_fast (ip6h->dst_address.as_u8, dst->as_u8,
681 sizeof (ip6h->src_address));
682 b->flags |= VNET_BUFFER_F_IS_IP6;
687 #endif /* included_ip_ip6_h */
690 * fd.io coding-style-patch-verification: ON
693 * eval: (c-set-style "gnu")