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/ip/ip6_packet.h>
46 #include <vnet/ip/ip6_hop_by_hop_packet.h>
47 #include <vnet/ip/lookup.h>
49 #include <vppinfra/bihash_24_8.h>
50 #include <vppinfra/bihash_40_8.h>
51 #include <vppinfra/bihash_template.h>
52 #include <vnet/util/radix.h>
53 #include <vnet/util/throttle.h>
56 * Default size of the ip6 fib hash table
58 #define IP6_FIB_DEFAULT_HASH_NUM_BUCKETS (64 * 1024)
59 #define IP6_FIB_DEFAULT_HASH_MEMORY_SIZE (32<<20)
64 u32 dst_address_length;
70 /* required for pool_get_aligned. */
71 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
73 /* Table ID (hash key) for this FIB. */
76 /* Index into FIB vector. */
80 typedef struct ip6_mfib_t
82 /* required for pool_get_aligned. */
83 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
85 /* Table ID (hash key) for this FIB. */
88 /* Index into FIB vector. */
94 typedef void (ip6_add_del_interface_address_function_t)
95 (struct ip6_main_t * im,
98 ip6_address_t * address,
99 u32 address_length, u32 if_address_index, u32 is_del);
103 ip6_add_del_interface_address_function_t *function;
104 uword function_opaque;
105 } ip6_add_del_interface_address_callback_t;
107 typedef void (ip6_table_bind_function_t)
108 (struct ip6_main_t * im,
109 uword opaque, u32 sw_if_index, u32 new_fib_index, u32 old_fib_index);
113 ip6_table_bind_function_t *function;
114 uword function_opaque;
115 } ip6_table_bind_callback_t;
118 * Enumeration of the FIB table instance types
120 typedef enum ip6_fib_table_instance_type_t_
123 * This table stores the routes that are used to forward traffic.
124 * The key is the prefix, the result the adjacnecy to forward on.
126 IP6_FIB_TABLE_FWDING,
128 * The table that stores ALL routes learned by the DP.
129 * Some of these routes may not be ready to install in forwarding
131 * The key in this table is the prefix, the result is the fib_entry_t
133 IP6_FIB_TABLE_NON_FWDING,
134 } ip6_fib_table_instance_type_t;
136 #define IP6_FIB_NUM_TABLES (IP6_FIB_TABLE_NON_FWDING+1)
139 * A represenation of a single IP6 table
141 typedef struct ip6_fib_table_instance_t_
144 clib_bihash_24_8_t ip6_hash;
146 /* bitmap / refcounts / vector of mask widths to search */
147 uword *non_empty_dst_address_length_bitmap;
148 u8 *prefix_lengths_in_search_order;
149 i32 dst_address_length_refcounts[129];
150 } ip6_fib_table_instance_t;
153 * A represenation of a single IP6 mfib table
155 typedef struct ip6_mfib_table_instance_t_
158 clib_bihash_40_8_t ip6_mhash;
160 /* bitmap / refcounts / vector of mask widths to search */
161 uword *non_empty_dst_address_length_bitmap;
162 u16 *prefix_lengths_in_search_order;
163 i32 dst_address_length_refcounts[257];
164 } ip6_mfib_table_instance_t;
166 typedef struct ip6_main_t
169 * The two FIB tables; fwding and non-fwding
171 ip6_fib_table_instance_t ip6_table[IP6_FIB_NUM_TABLES];
174 * the single MFIB table
176 ip6_mfib_table_instance_t ip6_mtable;
178 ip_lookup_main_t lookup_main;
181 struct fib_table_t_ *fibs;
183 /* Pool of V6 FIBs. */
186 /** Vector of MFIBs. */
187 struct mfib_table_t_ *mfibs;
189 /* Network byte orders subnet mask for each prefix length */
190 ip6_address_t fib_masks[129];
192 /* Table index indexed by software interface. */
193 u32 *fib_index_by_sw_if_index;
195 /** Table index indexed by software interface. */
196 u32 *mfib_index_by_sw_if_index;
198 /* IP6 enabled count by software interface */
199 u8 *ip_enabled_by_sw_if_index;
201 /* Hash table mapping table id to fib index.
202 ID space is not necessarily dense; index space is dense. */
203 uword *fib_index_by_table_id;
205 /** Hash table mapping table id to multicast fib index.
206 ID space is not necessarily dense; index space is dense. */
207 uword *mfib_index_by_table_id;
209 /* Hash table mapping interface rewrite adjacency index by sw if index. */
210 uword *interface_route_adj_index_by_sw_if_index;
212 /* Functions to call when interface address changes. */
213 ip6_add_del_interface_address_callback_t
214 * add_del_interface_address_callbacks;
216 /** Functions to call when interface to table biding changes. */
217 ip6_table_bind_callback_t *table_bind_callbacks;
219 /* Template used to generate IP6 neighbor solicitation packets. */
220 vlib_packet_template_t discover_neighbor_packet_template;
222 /* ip6 lookup table config parameters */
223 u32 lookup_table_nbuckets;
224 uword lookup_table_size;
226 /* Seed for Jenkins hash used to compute ip6 flow hash. */
231 /* TTL to use for host generated packets. */
237 /* HBH processing enabled? */
241 throttle_t nd_throttle;
244 #define ND_THROTTLE_BITS 512
246 /* Global ip6 main structure. */
247 extern ip6_main_t ip6_main;
249 /* Global ip6 input node. Errors get attached to ip6 input node. */
250 extern vlib_node_registration_t ip6_input_node;
251 extern vlib_node_registration_t ip6_rewrite_node;
252 extern vlib_node_registration_t ip6_rewrite_mcast_node;
253 extern vlib_node_registration_t ip6_rewrite_local_node;
254 extern vlib_node_registration_t ip6_discover_neighbor_node;
255 extern vlib_node_registration_t ip6_glean_node;
256 extern vlib_node_registration_t ip6_midchain_node;
258 extern void ip6_forward_next_trace (vlib_main_t * vm,
259 vlib_node_runtime_t * node,
260 vlib_frame_t * frame,
261 vlib_rx_or_tx_t which_adj_index);
264 ip6_destination_matches_route (const ip6_main_t * im,
265 const ip6_address_t * key,
266 const ip6_address_t * dest, uword dest_length)
269 for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
271 if ((key->as_uword[i] ^ dest->as_uword[i]) & im->
272 fib_masks[dest_length].as_uword[i])
279 ip6_destination_matches_interface (ip6_main_t * im,
281 ip_interface_address_t * ia)
283 ip6_address_t *a = ip_interface_address_get_address (&im->lookup_main, ia);
284 return ip6_destination_matches_route (im, key, a, ia->address_length);
287 /* As above but allows for unaligned destinations (e.g. works right from IP header of packet). */
289 ip6_unaligned_destination_matches_route (ip6_main_t * im,
291 ip6_address_t * dest,
295 for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
297 if ((clib_mem_unaligned (&key->as_uword[i], uword) ^ dest->as_uword[i])
298 & im->fib_masks[dest_length].as_uword[i])
304 extern int ip6_get_ll_address (u32 sw_if_index, ip6_address_t * addr);
307 ip6_src_address_for_packet (ip_lookup_main_t * lm,
309 const ip6_address_t * dst, ip6_address_t * src)
311 if (ip6_address_is_link_local_unicast (dst))
313 return ip6_get_ll_address (sw_if_index, src);
318 lm->if_address_pool_index_by_sw_if_index[sw_if_index];
319 if (PREDICT_TRUE (if_add_index != ~0))
321 ip_interface_address_t *if_add =
322 pool_elt_at_index (lm->if_address_pool, if_add_index);
323 ip6_address_t *if_ip =
324 ip_interface_address_get_address (lm, if_add);
336 /* Find interface address which matches destination. */
337 always_inline ip6_address_t *
338 ip6_interface_address_matching_destination (ip6_main_t * im,
341 ip_interface_address_t **
344 ip_lookup_main_t *lm = &im->lookup_main;
345 ip_interface_address_t *ia;
346 ip6_address_t *result = 0;
349 foreach_ip_interface_address (lm, ia, sw_if_index,
350 1 /* honor unnumbered */,
352 ip6_address_t * a = ip_interface_address_get_address (lm, ia);
353 if (ip6_destination_matches_route (im, dst, a, ia->address_length))
361 *result_ia = result ? ia : 0;
365 clib_error_t *ip6_add_del_interface_address (vlib_main_t * vm,
367 ip6_address_t * address,
368 u32 address_length, u32 is_del);
369 void ip6_sw_interface_enable_disable (u32 sw_if_index, u32 is_enable);
372 * @brie get first IPv6 interface address
374 ip6_address_t *ip6_interface_first_address (ip6_main_t * im, u32 sw_if_index);
376 int ip6_address_compare (ip6_address_t * a1, ip6_address_t * a2);
378 clib_error_t *ip6_probe_neighbor (vlib_main_t * vm, ip6_address_t * dst,
379 u32 sw_if_index, u8 refresh);
382 ip6_udp_register_listener (vlib_main_t * vm,
383 u16 dst_port, u32 next_node_index);
385 u16 ip6_tcp_udp_icmp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0,
389 void ip6_register_protocol (u32 protocol, u32 node_index);
391 serialize_function_t serialize_vnet_ip6_main, unserialize_vnet_ip6_main;
393 void ip6_ethernet_update_adjacency (vnet_main_t * vnm,
394 u32 sw_if_index, u32 ai);
398 ip6_link_local_address_from_ethernet_mac_address (ip6_address_t * ip,
402 ip6_ethernet_mac_address_from_link_local_address (u8 * mac,
405 int vnet_set_ip6_flow_hash (u32 table_id,
406 flow_hash_config_t flow_hash_config);
408 clib_error_t *enable_ip6_interface (vlib_main_t * vm, u32 sw_if_index);
410 clib_error_t *disable_ip6_interface (vlib_main_t * vm, u32 sw_if_index);
412 int ip6_interface_enabled (vlib_main_t * vm, u32 sw_if_index);
414 clib_error_t *set_ip6_link_local_address (vlib_main_t * vm,
416 ip6_address_t * address);
418 int vnet_add_del_ip6_nd_change_event (vnet_main_t * vnm,
424 uword data, int is_add);
426 int vnet_ip6_nd_term (vlib_main_t * vm,
427 vlib_node_runtime_t * node,
429 ethernet_header_t * eth,
430 ip6_header_t * ip, u32 sw_if_index, u16 bd_index);
432 void send_ip6_na (vlib_main_t * vm, u32 sw_if_index);
433 void send_ip6_na_w_addr (vlib_main_t * vm,
434 const ip6_address_t * addr, u32 sw_if_index);
436 u8 *format_ip6_forward_next_trace (u8 * s, va_list * args);
438 u32 ip6_tcp_udp_icmp_validate_checksum (vlib_main_t * vm, vlib_buffer_t * p0);
440 void ip6_punt_policer_add_del (u8 is_add, u32 policer_index);
441 void ip6_punt_redirect_add (u32 rx_sw_if_index,
442 u32 tx_sw_if_index, ip46_address_t * nh);
443 void ip6_punt_redirect_del (u32 rx_sw_if_index);
445 int vnet_set_ip6_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
447 extern vlib_node_registration_t ip6_lookup_node;
449 /* Compute flow hash. We'll use it to select which Sponge to use for this
450 flow. And other things. */
452 ip6_compute_flow_hash (const ip6_header_t * ip,
453 flow_hash_config_t flow_hash_config)
458 uword is_tcp_udp = 0;
459 u8 protocol = ip->protocol;
462 ((ip->protocol == IP_PROTOCOL_TCP)
463 || (ip->protocol == IP_PROTOCOL_UDP)))
466 tcp = (void *) (ip + 1);
468 else if (ip->protocol == IP_PROTOCOL_IP6_HOP_BY_HOP_OPTIONS)
470 ip6_hop_by_hop_header_t *hbh = (ip6_hop_by_hop_header_t *) (ip + 1);
471 if ((hbh->protocol == IP_PROTOCOL_TCP) ||
472 (hbh->protocol == IP_PROTOCOL_UDP))
475 tcp = (tcp_header_t *) ((u8 *) hbh + ((hbh->length + 1) << 3));
477 protocol = hbh->protocol;
480 t1 = (ip->src_address.as_u64[0] ^ ip->src_address.as_u64[1]);
481 t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR) ? t1 : 0;
483 t2 = (ip->dst_address.as_u64[0] ^ ip->dst_address.as_u64[1]);
484 t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR) ? t2 : 0;
486 a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
487 b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
489 t1 = is_tcp_udp ? tcp->src : 0;
490 t2 = is_tcp_udp ? tcp->dst : 0;
492 t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
493 t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
495 if (flow_hash_config & IP_FLOW_HASH_SYMMETRIC)
511 b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? protocol : 0;
512 c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
513 ((t1 << 16) | t2) : ((t2 << 16) | t1);
515 hash_mix64 (a, b, c);
521 * This function is to search for the header specified by the protocol number
523 * This is used to locate a specific IPv6 extension header
524 * or to find transport layer header.
525 * 1. If the find_hdr_type < 0 then it finds and returns the protocol number and
526 * offset stored in *offset of the transport or ESP header in the chain if
528 * 2. If a header with find_hdr_type > 0 protocol number is found then the
529 * offset is stored in *offset and protocol number of the header is
531 * 3. If find_hdr_type is not found or packet is malformed or
532 * it is a non-first fragment -1 is returned.
535 ip6_locate_header (vlib_buffer_t * p0,
536 ip6_header_t * ip0, int find_hdr_type, u32 * offset)
538 u8 next_proto = ip0->protocol;
545 next_header = ip6_next_header (ip0);
546 cur_offset = sizeof (ip6_header_t);
549 done = (next_proto == find_hdr_type);
552 (u8 *) vlib_buffer_get_current (p0) + p0->current_length))
554 //A malicious packet could set an extension header with a too big size
559 if ((!ip6_ext_hdr (next_proto)) || next_proto == IP_PROTOCOL_IP6_NONXT)
561 if (find_hdr_type < 0)
565 if (next_proto == IP_PROTOCOL_IPV6_FRAGMENTATION)
567 ip6_frag_hdr_t *frag_hdr = (ip6_frag_hdr_t *) next_header;
568 u16 frag_off = ip6_frag_hdr_offset (frag_hdr);
569 /* Non first fragment return -1 */
572 exthdr_len = sizeof (ip6_frag_hdr_t);
573 temp_nxthdr = next_header + exthdr_len;
575 else if (next_proto == IP_PROTOCOL_IPSEC_AH)
578 ip6_ext_authhdr_len (((ip6_ext_header_t *) next_header));
579 temp_nxthdr = next_header + exthdr_len;
584 ip6_ext_header_len (((ip6_ext_header_t *) next_header));
585 temp_nxthdr = next_header + exthdr_len;
587 next_proto = ((ip6_ext_header_t *) next_header)->next_hdr;
588 next_header = temp_nxthdr;
589 cur_offset += exthdr_len;
592 *offset = cur_offset;
596 u8 *format_ip6_hop_by_hop_ext_hdr (u8 * s, va_list * args);
598 * Hop-by-Hop handling
602 /* Array of function pointers to HBH option handling routines */
603 int (*options[256]) (vlib_buffer_t * b, ip6_header_t * ip,
604 ip6_hop_by_hop_option_t * opt);
605 u8 *(*trace[256]) (u8 * s, ip6_hop_by_hop_option_t * opt);
607 } ip6_hop_by_hop_main_t;
609 extern ip6_hop_by_hop_main_t ip6_hop_by_hop_main;
611 int ip6_hbh_register_option (u8 option,
612 int options (vlib_buffer_t * b,
614 ip6_hop_by_hop_option_t * opt),
616 ip6_hop_by_hop_option_t * opt));
617 int ip6_hbh_unregister_option (u8 option);
618 void ip6_hbh_set_next_override (uword next);
621 * Push IPv6 header to buffer
623 * @param vm - vlib_main
624 * @param b - buffer to write the header to
625 * @param src - source IP
626 * @param dst - destination IP
627 * @param prot - payload proto
629 * @return - pointer to start of IP header
632 vlib_buffer_push_ip6 (vlib_main_t * vm, vlib_buffer_t * b,
633 ip6_address_t * src, ip6_address_t * dst, int proto)
639 ip6h = vlib_buffer_push_uninit (b, sizeof (ip6_header_t));
641 ip6h->ip_version_traffic_class_and_flow_label =
642 clib_host_to_net_u32 (0x6 << 28);
644 /* calculate ip6 payload length */
645 payload_length = vlib_buffer_length_in_chain (vm, b);
646 payload_length -= sizeof (*ip6h);
648 ip6h->payload_length = clib_host_to_net_u16 (payload_length);
650 ip6h->hop_limit = 0xff;
651 ip6h->protocol = proto;
652 clib_memcpy_fast (ip6h->src_address.as_u8, src->as_u8,
653 sizeof (ip6h->src_address));
654 clib_memcpy_fast (ip6h->dst_address.as_u8, dst->as_u8,
655 sizeof (ip6h->src_address));
656 b->flags |= VNET_BUFFER_F_IS_IP6;
661 #endif /* included_ip_ip6_h */
664 * fd.io coding-style-patch-verification: ON
667 * eval: (c-set-style "gnu")