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_template.h>
51 #include <vnet/util/radix.h>
54 * Default size of the ip6 fib hash table
56 #define IP6_FIB_DEFAULT_HASH_NUM_BUCKETS (64 * 1024)
57 #define IP6_FIB_DEFAULT_HASH_MEMORY_SIZE (32<<20)
62 u32 dst_address_length;
68 /* required for pool_get_aligned. */
69 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
71 /* Table ID (hash key) for this FIB. */
74 /* Index into FIB vector. */
78 typedef struct ip6_mfib_t
80 /* Table ID (hash key) for this FIB. */
83 /* Index into FIB vector. */
87 * Pointer to the top of a radix tree.
88 * This cannot be realloc'd, hence it cannot be inlined with this table
90 struct radix_node_head *rhead;
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 BVT (clib_bihash) 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;
153 typedef struct ip6_main_t
156 * The two FIB tables; fwding and non-fwding
158 ip6_fib_table_instance_t ip6_table[IP6_FIB_NUM_TABLES];
160 ip_lookup_main_t lookup_main;
163 struct fib_table_t_ *fibs;
165 /* Pool of V6 FIBs. */
168 /** Vector of MFIBs. */
169 struct mfib_table_t_ *mfibs;
171 /* Network byte orders subnet mask for each prefix length */
172 ip6_address_t fib_masks[129];
174 /* Table index indexed by software interface. */
175 u32 *fib_index_by_sw_if_index;
177 /** Table index indexed by software interface. */
178 u32 *mfib_index_by_sw_if_index;
180 /* IP6 enabled count by software interface */
181 u8 *ip_enabled_by_sw_if_index;
183 /* Hash table mapping table id to fib index.
184 ID space is not necessarily dense; index space is dense. */
185 uword *fib_index_by_table_id;
187 /** Hash table mapping table id to multicast fib index.
188 ID space is not necessarily dense; index space is dense. */
189 uword *mfib_index_by_table_id;
191 /* Hash table mapping interface rewrite adjacency index by sw if index. */
192 uword *interface_route_adj_index_by_sw_if_index;
194 /* Functions to call when interface address changes. */
195 ip6_add_del_interface_address_callback_t
196 * add_del_interface_address_callbacks;
198 /** Functions to call when interface to table biding changes. */
199 ip6_table_bind_callback_t *table_bind_callbacks;
201 /* Template used to generate IP6 neighbor solicitation packets. */
202 vlib_packet_template_t discover_neighbor_packet_template;
204 /* ip6 lookup table config parameters */
205 u32 lookup_table_nbuckets;
206 uword lookup_table_size;
208 /* Seed for Jenkins hash used to compute ip6 flow hash. */
213 /* TTL to use for host generated packets. */
219 /* HBH processing enabled? */
223 uword **nd_throttle_bitmaps;
224 u64 *nd_throttle_seeds;
225 f64 *nd_throttle_last_seed_change_time;
229 #define ND_THROTTLE_BITS 512
231 /* Global ip6 main structure. */
232 extern ip6_main_t ip6_main;
234 /* Global ip6 input node. Errors get attached to ip6 input node. */
235 extern vlib_node_registration_t ip6_input_node;
236 extern vlib_node_registration_t ip6_rewrite_node;
237 extern vlib_node_registration_t ip6_rewrite_mcast_node;
238 extern vlib_node_registration_t ip6_rewrite_local_node;
239 extern vlib_node_registration_t ip6_discover_neighbor_node;
240 extern vlib_node_registration_t ip6_glean_node;
241 extern vlib_node_registration_t ip6_midchain_node;
243 extern void ip6_forward_next_trace (vlib_main_t * vm,
244 vlib_node_runtime_t * node,
245 vlib_frame_t * frame,
246 vlib_rx_or_tx_t which_adj_index);
249 ip6_destination_matches_route (const ip6_main_t * im,
250 const ip6_address_t * key,
251 const ip6_address_t * dest, uword dest_length)
254 for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
256 if ((key->as_uword[i] ^ dest->as_uword[i]) & im->
257 fib_masks[dest_length].as_uword[i])
264 ip6_destination_matches_interface (ip6_main_t * im,
266 ip_interface_address_t * ia)
268 ip6_address_t *a = ip_interface_address_get_address (&im->lookup_main, ia);
269 return ip6_destination_matches_route (im, key, a, ia->address_length);
272 /* As above but allows for unaligned destinations (e.g. works right from IP header of packet). */
274 ip6_unaligned_destination_matches_route (ip6_main_t * im,
276 ip6_address_t * dest,
280 for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
282 if ((clib_mem_unaligned (&key->as_uword[i], uword) ^ dest->as_uword[i])
283 & im->fib_masks[dest_length].as_uword[i])
289 extern int ip6_get_ll_address (u32 sw_if_index, ip6_address_t * addr);
292 ip6_src_address_for_packet (ip_lookup_main_t * lm,
294 const ip6_address_t * dst, ip6_address_t * src)
296 if (ip6_address_is_link_local_unicast (dst))
298 return ip6_get_ll_address (sw_if_index, src);
303 lm->if_address_pool_index_by_sw_if_index[sw_if_index];
304 if (PREDICT_TRUE (if_add_index != ~0))
306 ip_interface_address_t *if_add =
307 pool_elt_at_index (lm->if_address_pool, if_add_index);
308 ip6_address_t *if_ip =
309 ip_interface_address_get_address (lm, if_add);
321 /* Find interface address which matches destination. */
322 always_inline ip6_address_t *
323 ip6_interface_address_matching_destination (ip6_main_t * im,
326 ip_interface_address_t **
329 ip_lookup_main_t *lm = &im->lookup_main;
330 ip_interface_address_t *ia;
331 ip6_address_t *result = 0;
334 foreach_ip_interface_address (lm, ia, sw_if_index,
335 1 /* honor unnumbered */,
337 ip6_address_t * a = ip_interface_address_get_address (lm, ia);
338 if (ip6_destination_matches_route (im, dst, a, ia->address_length))
346 *result_ia = result ? ia : 0;
350 clib_error_t *ip6_add_del_interface_address (vlib_main_t * vm,
352 ip6_address_t * address,
353 u32 address_length, u32 is_del);
354 void ip6_sw_interface_enable_disable (u32 sw_if_index, u32 is_enable);
357 * @brie get first IPv6 interface address
359 ip6_address_t *ip6_interface_first_address (ip6_main_t * im, u32 sw_if_index);
361 int ip6_address_compare (ip6_address_t * a1, ip6_address_t * a2);
363 clib_error_t *ip6_probe_neighbor (vlib_main_t * vm, ip6_address_t * dst,
364 u32 sw_if_index, u8 refresh);
367 ip6_udp_register_listener (vlib_main_t * vm,
368 u16 dst_port, u32 next_node_index);
370 u16 ip6_tcp_udp_icmp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0,
374 void ip6_register_protocol (u32 protocol, u32 node_index);
376 serialize_function_t serialize_vnet_ip6_main, unserialize_vnet_ip6_main;
378 void ip6_ethernet_update_adjacency (vnet_main_t * vnm,
379 u32 sw_if_index, u32 ai);
383 ip6_link_local_address_from_ethernet_mac_address (ip6_address_t * ip,
387 ip6_ethernet_mac_address_from_link_local_address (u8 * mac,
390 int vnet_set_ip6_flow_hash (u32 table_id,
391 flow_hash_config_t flow_hash_config);
393 clib_error_t *enable_ip6_interface (vlib_main_t * vm, u32 sw_if_index);
395 clib_error_t *disable_ip6_interface (vlib_main_t * vm, u32 sw_if_index);
397 int ip6_interface_enabled (vlib_main_t * vm, u32 sw_if_index);
399 clib_error_t *set_ip6_link_local_address (vlib_main_t * vm,
401 ip6_address_t * address);
403 int vnet_add_del_ip6_nd_change_event (vnet_main_t * vnm,
409 uword data, int is_add);
411 int vnet_ip6_nd_term (vlib_main_t * vm,
412 vlib_node_runtime_t * node,
414 ethernet_header_t * eth,
415 ip6_header_t * ip, u32 sw_if_index, u16 bd_index);
417 void send_ip6_na (vlib_main_t * vm, u32 sw_if_index);
418 void send_ip6_na_w_addr (vlib_main_t * vm,
419 const ip6_address_t * addr, u32 sw_if_index);
421 u8 *format_ip6_forward_next_trace (u8 * s, va_list * args);
423 u32 ip6_tcp_udp_icmp_validate_checksum (vlib_main_t * vm, vlib_buffer_t * p0);
425 void ip6_punt_policer_add_del (u8 is_add, u32 policer_index);
426 void ip6_punt_redirect_add (u32 rx_sw_if_index,
427 u32 tx_sw_if_index, ip46_address_t * nh);
428 void ip6_punt_redirect_del (u32 rx_sw_if_index);
430 int vnet_set_ip6_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
432 extern vlib_node_registration_t ip6_lookup_node;
434 /* Compute flow hash. We'll use it to select which Sponge to use for this
435 flow. And other things. */
437 ip6_compute_flow_hash (const ip6_header_t * ip,
438 flow_hash_config_t flow_hash_config)
443 uword is_tcp_udp = 0;
444 u8 protocol = ip->protocol;
447 ((ip->protocol == IP_PROTOCOL_TCP)
448 || (ip->protocol == IP_PROTOCOL_UDP)))
451 tcp = (void *) (ip + 1);
453 else if (ip->protocol == IP_PROTOCOL_IP6_HOP_BY_HOP_OPTIONS)
455 ip6_hop_by_hop_header_t *hbh = (ip6_hop_by_hop_header_t *) (ip + 1);
456 if ((hbh->protocol == IP_PROTOCOL_TCP) ||
457 (hbh->protocol == IP_PROTOCOL_UDP))
460 tcp = (tcp_header_t *) ((u8 *) hbh + ((hbh->length + 1) << 3));
462 protocol = hbh->protocol;
465 t1 = (ip->src_address.as_u64[0] ^ ip->src_address.as_u64[1]);
466 t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR) ? t1 : 0;
468 t2 = (ip->dst_address.as_u64[0] ^ ip->dst_address.as_u64[1]);
469 t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR) ? t2 : 0;
471 a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
472 b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
473 b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? protocol : 0;
475 t1 = is_tcp_udp ? tcp->src : 0;
476 t2 = is_tcp_udp ? tcp->dst : 0;
478 t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
479 t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
481 c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
482 ((t1 << 16) | t2) : ((t2 << 16) | t1);
484 hash_mix64 (a, b, c);
490 * This function is to search for the header specified by the protocol number
492 * This is used to locate a specific IPv6 extension header
493 * or to find transport layer header.
494 * 1. If the find_hdr_type < 0 then it finds and returns the protocol number and
495 * offset stored in *offset of the transport or ESP header in the chain if
497 * 2. If a header with find_hdr_type > 0 protocol number is found then the
498 * offset is stored in *offset and protocol number of the header is
500 * 3. If find_hdr_type is not found or packet is malformed or
501 * it is a non-first fragment -1 is returned.
504 ip6_locate_header (vlib_buffer_t * p0,
505 ip6_header_t * ip0, int find_hdr_type, u32 * offset)
507 u8 next_proto = ip0->protocol;
514 next_header = ip6_next_header (ip0);
515 cur_offset = sizeof (ip6_header_t);
518 done = (next_proto == find_hdr_type);
521 (u8 *) vlib_buffer_get_current (p0) + p0->current_length))
523 //A malicious packet could set an extension header with a too big size
528 if ((!ip6_ext_hdr (next_proto)) || next_proto == IP_PROTOCOL_IP6_NONXT)
530 if (find_hdr_type < 0)
534 if (next_proto == IP_PROTOCOL_IPV6_FRAGMENTATION)
536 ip6_frag_hdr_t *frag_hdr = (ip6_frag_hdr_t *) next_header;
537 u16 frag_off = ip6_frag_hdr_offset (frag_hdr);
538 /* Non first fragment return -1 */
541 exthdr_len = sizeof (ip6_frag_hdr_t);
542 temp_nxthdr = next_header + exthdr_len;
544 else if (next_proto == IP_PROTOCOL_IPSEC_AH)
547 ip6_ext_authhdr_len (((ip6_ext_header_t *) next_header));
548 temp_nxthdr = next_header + exthdr_len;
553 ip6_ext_header_len (((ip6_ext_header_t *) next_header));
554 temp_nxthdr = next_header + exthdr_len;
556 next_proto = ((ip6_ext_header_t *) next_header)->next_hdr;
557 next_header = temp_nxthdr;
558 cur_offset += exthdr_len;
561 *offset = cur_offset;
565 u8 *format_ip6_hop_by_hop_ext_hdr (u8 * s, va_list * args);
567 * Hop-by-Hop handling
571 /* Array of function pointers to HBH option handling routines */
572 int (*options[256]) (vlib_buffer_t * b, ip6_header_t * ip,
573 ip6_hop_by_hop_option_t * opt);
574 u8 *(*trace[256]) (u8 * s, ip6_hop_by_hop_option_t * opt);
576 } ip6_hop_by_hop_main_t;
578 extern ip6_hop_by_hop_main_t ip6_hop_by_hop_main;
580 int ip6_hbh_register_option (u8 option,
581 int options (vlib_buffer_t * b,
583 ip6_hop_by_hop_option_t * opt),
585 ip6_hop_by_hop_option_t * opt));
586 int ip6_hbh_unregister_option (u8 option);
587 void ip6_hbh_set_next_override (uword next);
590 * Push IPv6 header to buffer
592 * @param vm - vlib_main
593 * @param b - buffer to write the header to
594 * @param src - source IP
595 * @param dst - destination IP
596 * @param prot - payload proto
598 * @return - pointer to start of IP header
601 vlib_buffer_push_ip6 (vlib_main_t * vm, vlib_buffer_t * b,
602 ip6_address_t * src, ip6_address_t * dst, int proto)
608 ip6h = vlib_buffer_push_uninit (b, sizeof (ip6_header_t));
610 ip6h->ip_version_traffic_class_and_flow_label =
611 clib_host_to_net_u32 (0x6 << 28);
613 /* calculate ip6 payload length */
614 payload_length = vlib_buffer_length_in_chain (vm, b);
615 payload_length -= sizeof (*ip6h);
617 ip6h->payload_length = clib_host_to_net_u16 (payload_length);
619 ip6h->hop_limit = 0xff;
620 ip6h->protocol = proto;
621 clib_memcpy (ip6h->src_address.as_u8, src->as_u8,
622 sizeof (ip6h->src_address));
623 clib_memcpy (ip6h->dst_address.as_u8, dst->as_u8,
624 sizeof (ip6h->src_address));
625 b->flags |= VNET_BUFFER_F_IS_IP6;
630 #endif /* included_ip_ip6_h */
633 * fd.io coding-style-patch-verification: ON
636 * eval: (c-set-style "gnu")