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
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>
50 #include <vppinfra/bihash_24_8.h>
51 #include <vppinfra/bihash_template.h>
52 #include <vnet/util/radix.h>
55 * Default size of the ip6 fib hash table
57 #define IP6_FIB_DEFAULT_HASH_NUM_BUCKETS (64 * 1024)
58 #define IP6_FIB_DEFAULT_HASH_MEMORY_SIZE (32<<20)
63 u32 dst_address_length;
69 /* Table ID (hash key) for this FIB. */
72 /* Index into FIB vector. */
75 /* flow hash configuration */
76 flow_hash_config_t flow_hash_config;
79 typedef struct ip6_mfib_t
81 /* Table ID (hash key) for this FIB. */
84 /* Index into FIB vector. */
88 * Pointer to the top of a radix tree.
89 * This cannot be realloc'd, hence it cannot be inlined with this table
91 struct radix_node_head *rhead;
96 typedef void (ip6_add_del_interface_address_function_t)
97 (struct ip6_main_t * im,
100 ip6_address_t * address,
101 u32 address_length, u32 if_address_index, u32 is_del);
105 ip6_add_del_interface_address_function_t *function;
106 uword function_opaque;
107 } ip6_add_del_interface_address_callback_t;
110 * Enumeration of the FIB table instance types
112 typedef enum ip6_fib_table_instance_type_t_
115 * This table stores the routes that are used to forward traffic.
116 * The key is the prefix, the result the adjacnecy to forward on.
118 IP6_FIB_TABLE_FWDING,
120 * The table that stores ALL routes learned by the DP.
121 * Some of these routes may not be ready to install in forwarding
123 * The key in this table is the prefix, the result is the fib_entry_t
125 IP6_FIB_TABLE_NON_FWDING,
126 } ip6_fib_table_instance_type_t;
128 #define IP6_FIB_NUM_TABLES (IP6_FIB_TABLE_NON_FWDING+1)
131 * A represenation of a single IP6 table
133 typedef struct ip6_fib_table_instance_t_
136 BVT (clib_bihash) ip6_hash;
138 /* bitmap / refcounts / vector of mask widths to search */
139 uword *non_empty_dst_address_length_bitmap;
140 u8 *prefix_lengths_in_search_order;
141 i32 dst_address_length_refcounts[129];
142 } ip6_fib_table_instance_t;
144 typedef struct ip6_main_t
147 * The two FIB tables; fwding and non-fwding
149 ip6_fib_table_instance_t ip6_table[IP6_FIB_NUM_TABLES];
151 ip_lookup_main_t lookup_main;
154 struct fib_table_t_ *fibs;
156 /** Vector of MFIBs. */
157 struct mfib_table_t_ *mfibs;
159 /* Network byte orders subnet mask for each prefix length */
160 ip6_address_t fib_masks[129];
162 /* Table index indexed by software interface. */
163 u32 *fib_index_by_sw_if_index;
165 /** Table index indexed by software interface. */
166 u32 *mfib_index_by_sw_if_index;
168 /* IP6 enabled count by software interface */
169 u8 *ip_enabled_by_sw_if_index;
171 /* Hash table mapping table id to fib index.
172 ID space is not necessarily dense; index space is dense. */
173 uword *fib_index_by_table_id;
175 /** Hash table mapping table id to multicast fib index.
176 ID space is not necessarily dense; index space is dense. */
177 uword *mfib_index_by_table_id;
179 /* Hash table mapping interface rewrite adjacency index by sw if index. */
180 uword *interface_route_adj_index_by_sw_if_index;
182 /* Functions to call when interface address changes. */
183 ip6_add_del_interface_address_callback_t
184 * add_del_interface_address_callbacks;
186 /* Template used to generate IP6 neighbor solicitation packets. */
187 vlib_packet_template_t discover_neighbor_packet_template;
189 /* ip6 lookup table config parameters */
190 u32 lookup_table_nbuckets;
191 uword lookup_table_size;
193 /* Seed for Jenkins hash used to compute ip6 flow hash. */
198 /* TTL to use for host generated packets. */
204 /* HBH processing enabled? */
208 /* Global ip6 main structure. */
209 extern ip6_main_t ip6_main;
211 /* Global ip6 input node. Errors get attached to ip6 input node. */
212 extern vlib_node_registration_t ip6_input_node;
213 extern vlib_node_registration_t ip6_rewrite_node;
214 extern vlib_node_registration_t ip6_rewrite_mcast_node;
215 extern vlib_node_registration_t ip6_rewrite_local_node;
216 extern vlib_node_registration_t ip6_discover_neighbor_node;
217 extern vlib_node_registration_t ip6_glean_node;
218 extern vlib_node_registration_t ip6_midchain_node;
220 extern vlib_node_registration_t ip6_icmp_neighbor_discovery_event_node;
222 /* ipv6 neighbor discovery - timer/event types */
226 } ip6_icmp_neighbor_discovery_event_type_t;
236 } ip6_icmp_neighbor_discovery_event_data_t;
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)
244 for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
246 if ((key->as_uword[i] ^ dest->as_uword[i]) & im->
247 fib_masks[dest_length].as_uword[i])
254 ip6_destination_matches_interface (ip6_main_t * im,
256 ip_interface_address_t * ia)
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);
262 /* As above but allows for unaligned destinations (e.g. works right from IP header of packet). */
264 ip6_unaligned_destination_matches_route (ip6_main_t * im,
266 ip6_address_t * dest,
270 for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
272 if ((clib_mem_unaligned (&key->as_uword[i], uword) ^ dest->as_uword[i])
273 & im->fib_masks[dest_length].as_uword[i])
280 ip6_src_address_for_packet (ip_lookup_main_t * lm,
281 u32 sw_if_index, ip6_address_t * src)
283 u32 if_add_index = lm->if_address_pool_index_by_sw_if_index[sw_if_index];
284 if (PREDICT_TRUE (if_add_index != ~0))
286 ip_interface_address_t *if_add =
287 pool_elt_at_index (lm->if_address_pool, if_add_index);
288 ip6_address_t *if_ip = ip_interface_address_get_address (lm, if_add);
300 /* Find interface address which matches destination. */
301 always_inline ip6_address_t *
302 ip6_interface_address_matching_destination (ip6_main_t * im,
305 ip_interface_address_t **
308 ip_lookup_main_t *lm = &im->lookup_main;
309 ip_interface_address_t *ia;
310 ip6_address_t *result = 0;
313 foreach_ip_interface_address (lm, ia, sw_if_index,
314 1 /* honor unnumbered */,
316 ip6_address_t * a = ip_interface_address_get_address (lm, ia);
317 if (ip6_destination_matches_route (im, dst, a, ia->address_length))
325 *result_ia = result ? ia : 0;
329 clib_error_t *ip6_add_del_interface_address (vlib_main_t * vm,
331 ip6_address_t * address,
332 u32 address_length, u32 is_del);
333 void ip6_sw_interface_enable_disable (u32 sw_if_index, u32 is_enable);
335 int ip6_address_compare (ip6_address_t * a1, ip6_address_t * a2);
337 clib_error_t *ip6_probe_neighbor (vlib_main_t * vm, ip6_address_t * dst,
340 clib_error_t *ip6_set_neighbor_limit (u32 neighbor_limit);
343 ip6_udp_register_listener (vlib_main_t * vm,
344 u16 dst_port, u32 next_node_index);
346 u16 ip6_tcp_udp_icmp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0,
350 void ip6_register_protocol (u32 protocol, u32 node_index);
352 serialize_function_t serialize_vnet_ip6_main, unserialize_vnet_ip6_main;
354 void ip6_ethernet_update_adjacency (vnet_main_t * vnm,
355 u32 sw_if_index, u32 ai);
358 vnet_set_ip6_ethernet_neighbor (vlib_main_t * vm,
361 u8 * link_layer_address,
362 uword n_bytes_link_layer_address,
365 vnet_unset_ip6_ethernet_neighbor (vlib_main_t * vm,
368 u8 * link_layer_address,
369 uword n_bytes_link_layer_address);
372 ip6_link_local_address_from_ethernet_mac_address (ip6_address_t * ip,
376 ip6_ethernet_mac_address_from_link_local_address (u8 * mac,
379 int vnet_set_ip6_flow_hash (u32 table_id,
380 flow_hash_config_t flow_hash_config);
383 ip6_neighbor_ra_config (vlib_main_t * vm, u32 sw_if_index,
384 u8 suppress, u8 managed, u8 other,
385 u8 ll_option, u8 send_unicast, u8 cease,
386 u8 use_lifetime, u32 lifetime,
387 u32 initial_count, u32 initial_interval,
388 u32 max_interval, u32 min_interval, u8 is_no);
391 ip6_neighbor_ra_prefix (vlib_main_t * vm, u32 sw_if_index,
392 ip6_address_t * prefix_addr, u8 prefix_len,
393 u8 use_default, u32 val_lifetime, u32 pref_lifetime,
394 u8 no_advertise, u8 off_link, u8 no_autoconfig,
395 u8 no_onlink, u8 is_no);
398 clib_error_t *enable_ip6_interface (vlib_main_t * vm, u32 sw_if_index);
400 clib_error_t *disable_ip6_interface (vlib_main_t * vm, u32 sw_if_index);
402 int ip6_interface_enabled (vlib_main_t * vm, u32 sw_if_index);
404 clib_error_t *set_ip6_link_local_address (vlib_main_t * vm,
406 ip6_address_t * address);
408 void vnet_register_ip6_neighbor_resolution_event (vnet_main_t * vnm,
414 int vnet_add_del_ip6_nd_change_event (vnet_main_t * vnm,
420 uword data, int is_add);
422 int vnet_ip6_nd_term (vlib_main_t * vm,
423 vlib_node_runtime_t * node,
425 ethernet_header_t * eth,
427 u32 sw_if_index, u16 bd_index, u8 shg);
429 u8 *format_ip6_forward_next_trace (u8 * s, va_list * args);
431 u32 ip6_tcp_udp_icmp_validate_checksum (vlib_main_t * vm, vlib_buffer_t * p0);
433 int vnet_set_ip6_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
435 extern vlib_node_registration_t ip6_lookup_node;
437 /* Compute flow hash. We'll use it to select which Sponge to use for this
438 flow. And other things. */
440 ip6_compute_flow_hash (const ip6_header_t * ip,
441 flow_hash_config_t flow_hash_config)
443 tcp_header_t *tcp = (void *) (ip + 1);
446 uword is_tcp_udp = (ip->protocol == IP_PROTOCOL_TCP
447 || ip->protocol == IP_PROTOCOL_UDP);
449 t1 = (ip->src_address.as_u64[0] ^ ip->src_address.as_u64[1]);
450 t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR) ? t1 : 0;
452 t2 = (ip->dst_address.as_u64[0] ^ ip->dst_address.as_u64[1]);
453 t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR) ? t2 : 0;
455 a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
456 b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
457 b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? ip->protocol : 0;
459 t1 = is_tcp_udp ? tcp->ports.src : 0;
460 t2 = is_tcp_udp ? tcp->ports.dst : 0;
462 t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
463 t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
465 c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
466 ((t1 << 16) | t2) : ((t2 << 16) | t1);
468 hash_mix64 (a, b, c);
473 * Hop-by-Hop handling
477 /* Array of function pointers to HBH option handling routines */
478 int (*options[256]) (vlib_buffer_t * b, ip6_header_t * ip,
479 ip6_hop_by_hop_option_t * opt);
480 u8 *(*trace[256]) (u8 * s, ip6_hop_by_hop_option_t * opt);
482 } ip6_hop_by_hop_main_t;
484 extern ip6_hop_by_hop_main_t ip6_hop_by_hop_main;
486 int ip6_hbh_register_option (u8 option,
487 int options (vlib_buffer_t * b,
489 ip6_hop_by_hop_option_t * opt),
491 ip6_hop_by_hop_option_t * opt));
492 int ip6_hbh_unregister_option (u8 option);
493 void ip6_hbh_set_next_override (uword next);
495 #endif /* included_ip_ip6_h */
498 * fd.io coding-style-patch-verification: ON
501 * eval: (c-set-style "gnu")