2 * Copyright (c) 2015 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>
49 #include <vnet/ip/ip_feature_registration.h>
51 #include <vppinfra/bihash_24_8.h>
52 #include <vppinfra/bihash_template.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)
62 u32 dst_address_length;
67 /* Table ID (hash key) for this FIB. */
70 /* Index into FIB vector. */
73 /* flow hash configuration */
79 typedef void (ip6_add_del_route_function_t)
80 (struct ip6_main_t * im,
84 ip6_address_t * address,
90 ip6_add_del_route_function_t * function;
92 uword function_opaque;
93 } ip6_add_del_route_callback_t;
95 typedef void (ip6_add_del_interface_address_function_t)
96 (struct ip6_main_t * im,
99 ip6_address_t * address,
101 u32 if_address_index,
105 ip6_add_del_interface_address_function_t * function;
106 uword function_opaque;
107 } ip6_add_del_interface_address_callback_t;
109 typedef struct ip6_main_t {
110 BVT(clib_bihash) ip6_lookup_table;
112 ip_lookup_main_t lookup_main;
114 /* bitmap / refcounts / vector of mask widths to search */
115 uword * non_empty_dst_address_length_bitmap;
116 u8 * prefix_lengths_in_search_order;
117 i32 dst_address_length_refcounts[129];
119 /* Vector of FIBs. */
122 ip6_address_t fib_masks[129];
124 /* Table index indexed by software interface. */
125 u32 * fib_index_by_sw_if_index;
127 /* Hash table mapping table id to fib index.
128 ID space is not necessarily dense; index space is dense. */
129 uword * fib_index_by_table_id;
131 /* Vector of functions to call when routes are added/deleted. */
132 ip6_add_del_route_callback_t * add_del_route_callbacks;
134 /* Hash table mapping interface rewrite adjacency index by sw if index. */
135 uword * interface_route_adj_index_by_sw_if_index;
137 /* Functions to call when interface address changes. */
138 ip6_add_del_interface_address_callback_t * add_del_interface_address_callbacks;
140 /* Template used to generate IP6 neighbor solicitation packets. */
141 vlib_packet_template_t discover_neighbor_packet_template;
143 /* ip6 lookup table config parameters */
144 u32 lookup_table_nbuckets;
145 uword lookup_table_size;
147 /* feature path configuration lists */
148 vnet_ip_feature_registration_t * next_uc_feature;
149 vnet_ip_feature_registration_t * next_mc_feature;
150 vnet_ip_feature_registration_t * next_tx_feature;
152 /* Built-in unicast feature path indices, see ip_feature_init_cast(...) */
153 u32 ip6_unicast_rx_feature_check_access;
154 u32 ip6_unicast_rx_feature_policer_classify;
155 u32 ip6_unicast_rx_feature_ipsec;
156 u32 ip6_unicast_rx_feature_l2tp_decap;
157 u32 ip6_unicast_rx_feature_vpath;
158 u32 ip6_unicast_rx_feature_lookup;
160 /* Built-in multicast feature path indices */
161 u32 ip6_multicast_rx_feature_vpath;
162 u32 ip6_multicast_rx_feature_lookup;
164 /* Built-in tx feature path index */
165 u32 ip6_tx_feature_interface_output;
167 /* Save results for show command */
168 char ** feature_nodes[VNET_N_IP_FEAT];
170 /* Seed for Jenkins hash used to compute ip6 flow hash. */
174 /* TTL to use for host generated packets. */
180 /* HBH processing enabled? */
184 /* Global ip6 main structure. */
185 extern ip6_main_t ip6_main;
187 #define VNET_IP6_UNICAST_FEATURE_INIT(x,...) \
188 __VA_ARGS__ vnet_ip_feature_registration_t uc_##x; \
189 static void __vnet_add_feature_registration_uc_##x (void) \
190 __attribute__((__constructor__)) ; \
191 static void __vnet_add_feature_registration_uc_##x (void) \
193 ip6_main_t * im = &ip6_main; \
194 uc_##x.next = im->next_uc_feature; \
195 im->next_uc_feature = &uc_##x; \
197 __VA_ARGS__ vnet_ip_feature_registration_t uc_##x
199 #define VNET_IP6_MULTICAST_FEATURE_INIT(x,...) \
200 __VA_ARGS__ vnet_ip_feature_registration_t mc_##x; \
201 static void __vnet_add_feature_registration_mc_##x (void) \
202 __attribute__((__constructor__)) ; \
203 static void __vnet_add_feature_registration_mc_##x (void) \
205 ip6_main_t * im = &ip6_main; \
206 mc_##x.next = im->next_mc_feature; \
207 im->next_mc_feature = &mc_##x; \
209 __VA_ARGS__ vnet_ip_feature_registration_t mc_##x
211 #define VNET_IP6_TX_FEATURE_INIT(x,...) \
212 __VA_ARGS__ vnet_ip_feature_registration_t tx_##x; \
213 static void __vnet_add_feature_registration_tx_##x (void) \
214 __attribute__((__constructor__)) ; \
215 static void __vnet_add_feature_registration_tx_##x (void) \
217 ip6_main_t * im = &ip6_main; \
218 tx_##x.next = im->next_tx_feature; \
219 im->next_tx_feature = &tx_##x; \
221 __VA_ARGS__ vnet_ip_feature_registration_t tx_##x
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_local_node;
228 extern vlib_node_registration_t ip6_discover_neighbor_node;
230 extern vlib_node_registration_t ip6_icmp_neighbor_discovery_event_node;
232 /* ipv6 neighbor discovery - timer/event types */
235 } ip6_icmp_neighbor_discovery_event_type_t;
243 } ip6_icmp_neighbor_discovery_event_data_t;
245 u32 ip6_fib_lookup (ip6_main_t * im, u32 sw_if_index, ip6_address_t * dst);
246 u32 ip6_fib_lookup_with_table (ip6_main_t * im, u32 fib_index,
247 ip6_address_t * dst);
250 * \brief Get or create an IPv6 fib.
252 * Get or create an IPv6 fib with the provided fib ID or index.
253 * The fib ID is a possibly-sparse user-defined value while
254 * the fib index defines the position of the fib in the fib vector.
258 * \param table_index_or_id
259 * The table index if \c IP6_ROUTE_FLAG_FIB_INDEX bit is set in \p flags.
260 * Otherwise, when set to \c ~0, an arbitrary and unused fib ID is picked
261 * and can be retrieved with \c ret->table_id.
262 * Otherwise, it is the fib ID to be used to retrieve or create the desired fib.
264 * Indicates whether \p table_index_or_id is the fib index or ID.
265 * When the bit \c IP6_ROUTE_FLAG_FIB_INDEX is set, \p table_index_or_id
266 * is considered as the fib index, and the fib ID otherwise.
267 * \return A pointer to the retrieved or created fib.
269 * \remark When getting a fib with the fib index, the fib MUST already exist.
271 ip6_fib_t * find_ip6_fib_by_table_index_or_id (ip6_main_t * im,
272 u32 table_index_or_id,
276 ip6_destination_matches_route (ip6_main_t * im,
278 ip6_address_t * dest,
282 for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
284 if ((key->as_uword[i] ^ dest->as_uword[i]) & im->fib_masks[dest_length].as_uword[i])
291 ip6_destination_matches_interface (ip6_main_t * im,
293 ip_interface_address_t * ia)
295 ip6_address_t * a = ip_interface_address_get_address (&im->lookup_main, ia);
296 return ip6_destination_matches_route (im, key, a, ia->address_length);
299 /* As above but allows for unaligned destinations (e.g. works right from IP header of packet). */
301 ip6_unaligned_destination_matches_route (ip6_main_t * im,
303 ip6_address_t * dest,
307 for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
309 if ((clib_mem_unaligned (&key->as_uword[i], uword) ^ dest->as_uword[i]) & im->fib_masks[dest_length].as_uword[i])
316 ip6_src_address_for_packet (ip6_main_t * im, vlib_buffer_t * p, ip6_address_t * src, u32 sw_if_index)
318 ip_lookup_main_t * lm = &im->lookup_main;
319 ip_interface_address_t * ia = ip_interface_address_for_packet (lm, p, sw_if_index);
322 ip6_address_t * a = ip_interface_address_get_address (lm, ia);
328 ip6_src_lookup_for_packet (ip6_main_t * im, vlib_buffer_t * b, ip6_header_t * i)
330 if (vnet_buffer (b)->ip.adj_index[VLIB_RX] == ~0)
331 vnet_buffer (b)->ip.adj_index[VLIB_RX]
332 = ip6_fib_lookup (im, vnet_buffer (b)->sw_if_index[VLIB_RX],
334 return vnet_buffer (b)->ip.adj_index[VLIB_RX];
337 /* Find interface address which matches destination. */
338 always_inline ip6_address_t *
339 ip6_interface_address_matching_destination (ip6_main_t * im, ip6_address_t * dst, u32 sw_if_index,
340 ip_interface_address_t ** result_ia)
342 ip_lookup_main_t * lm = &im->lookup_main;
343 ip_interface_address_t * ia;
344 ip6_address_t * result = 0;
346 foreach_ip_interface_address (lm, ia, sw_if_index,
347 1 /* honor unnumbered */,
349 ip6_address_t * a = ip_interface_address_get_address (lm, ia);
350 if (ip6_destination_matches_route (im, dst, a, ia->address_length))
357 *result_ia = result ? ia : 0;
362 ip6_add_del_interface_address (vlib_main_t * vm, u32 sw_if_index,
363 ip6_address_t * address, u32 address_length,
366 int ip6_address_compare (ip6_address_t * a1, ip6_address_t * a2);
368 /* Add/del a route to the FIB. */
370 #define IP6_ROUTE_FLAG_ADD (0 << 0)
371 #define IP6_ROUTE_FLAG_DEL (1 << 0)
372 #define IP6_ROUTE_FLAG_TABLE_ID (0 << 1)
373 #define IP6_ROUTE_FLAG_FIB_INDEX (1 << 1)
374 #define IP6_ROUTE_FLAG_KEEP_OLD_ADJACENCY (1 << 2)
375 #define IP6_ROUTE_FLAG_NO_REDISTRIBUTE (1 << 3)
376 #define IP6_ROUTE_FLAG_NOT_LAST_IN_GROUP (1 << 4)
377 /* Dynamic route created via neighbor discovery. */
378 #define IP6_ROUTE_FLAG_NEIGHBOR (1 << 5)
381 /* IP6_ROUTE_FLAG_* */
384 /* Either index of fib or table_id to hash and get fib.
385 IP6_ROUTE_FLAG_FIB_INDEX specifies index; otherwise table_id is assumed. */
386 u32 table_index_or_table_id;
388 /* Destination address (prefix) and length. */
389 ip6_address_t dst_address;
390 u32 dst_address_length;
392 /* Adjacency to use for this destination. */
395 /* If specified adjacencies to add and then
396 use for this destination. add_adj/n_add_adj
397 are override adj_index if specified. */
398 ip_adjacency_t * add_adj;
400 } ip6_add_del_route_args_t;
402 void ip6_add_del_route (ip6_main_t * im, ip6_add_del_route_args_t * args);
404 void ip6_add_del_route_next_hop (ip6_main_t * im,
406 ip6_address_t * dst_address,
407 u32 dst_address_length,
408 ip6_address_t * next_hop,
409 u32 next_hop_sw_if_index,
410 u32 next_hop_weight, u32 adj_index,
411 u32 explicit_fib_index);
414 ip6_route_get_next_hop_adj (ip6_main_t * im,
416 ip6_address_t *next_hop,
417 u32 next_hop_sw_if_index,
418 u32 explicit_fib_index);
421 ip6_get_route (ip6_main_t * im,
422 u32 fib_index_or_table_id,
424 ip6_address_t * address,
428 ip6_foreach_matching_route (ip6_main_t * im,
429 u32 table_index_or_table_id,
431 ip6_address_t * address,
433 ip6_address_t ** results,
434 u8 ** result_length);
436 void ip6_delete_matching_routes (ip6_main_t * im,
437 u32 table_index_or_table_id,
439 ip6_address_t * address,
442 void ip6_maybe_remap_adjacencies (ip6_main_t * im,
443 u32 table_index_or_table_id,
446 void ip6_adjacency_set_interface_route (vnet_main_t * vnm,
447 ip_adjacency_t * adj,
449 u32 if_address_index);
452 vnet_ip6_neighbor_glean_add(u32 fib_index, void * next_hop_arg);
455 ip6_probe_neighbor (vlib_main_t * vm, ip6_address_t * dst, u32 sw_if_index);
458 ip6_set_neighbor_limit (u32 neighbor_limit);
461 ip6_udp_register_listener (vlib_main_t * vm,
463 u32 next_node_index);
465 u16 ip6_tcp_udp_icmp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0, ip6_header_t * ip0, int *bogus_lengthp);
467 void ip6_register_protocol (u32 protocol, u32 node_index);
469 serialize_function_t serialize_vnet_ip6_main, unserialize_vnet_ip6_main;
472 vnet_set_ip6_ethernet_neighbor (vlib_main_t * vm,
475 u8 * link_layer_address,
476 uword n_bytes_link_layer_address,
479 vnet_unset_ip6_ethernet_neighbor (vlib_main_t * vm,
482 u8 * link_layer_address,
483 uword n_bytes_link_layer_address);
485 vnet_ip6_fib_init (ip6_main_t * im, u32 fib_index);
488 ip6_link_local_address_from_ethernet_mac_address (ip6_address_t *ip,
492 ip6_ethernet_mac_address_from_link_local_address (u8 *mac,
495 int vnet_set_ip6_flow_hash (u32 table_id, u32 flow_hash_config);
498 ip6_neighbor_ra_config(vlib_main_t * vm, u32 sw_if_index,
499 u8 suppress, u8 managed, u8 other,
500 u8 ll_option, u8 send_unicast, u8 cease,
501 u8 use_lifetime, u32 lifetime,
502 u32 initial_count, u32 initial_interval,
503 u32 max_interval, u32 min_interval,
507 ip6_neighbor_ra_prefix(vlib_main_t * vm, u32 sw_if_index,
508 ip6_address_t *prefix_addr, u8 prefix_len,
509 u8 use_default, u32 val_lifetime, u32 pref_lifetime,
510 u8 no_advertise, u8 off_link, u8 no_autoconfig, u8 no_onlink,
515 enable_ip6_interface(vlib_main_t * vm,
519 disable_ip6_interface(vlib_main_t * vm,
523 ip6_interface_enabled(vlib_main_t * vm,
527 set_ip6_link_local_address(vlib_main_t * vm,
529 ip6_address_t *address,
532 void vnet_register_ip6_neighbor_resolution_event(vnet_main_t * vnm,
538 int vnet_add_del_ip6_nd_change_event (vnet_main_t * vnm,
539 void * data_callback,
547 int vnet_ip6_nd_term (vlib_main_t * vm,
548 vlib_node_runtime_t * node,
550 ethernet_header_t * eth,
556 int vnet_set_ip6_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
558 extern vlib_node_registration_t ip6_lookup_node;
560 /* Compute flow hash. We'll use it to select which Sponge to use for this
561 flow. And other things. */
563 ip6_compute_flow_hash (ip6_header_t * ip, u32 flow_hash_config)
565 tcp_header_t * tcp = (void *) (ip + 1);
568 uword is_tcp_udp = (ip->protocol == IP_PROTOCOL_TCP
569 || ip->protocol == IP_PROTOCOL_UDP);
571 t1 = (ip->src_address.as_u64[0] ^ ip->src_address.as_u64[1]);
572 t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR) ? t1 : 0;
574 t2 = (ip->dst_address.as_u64[0] ^ ip->dst_address.as_u64[1]);
575 t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR) ? t2 : 0;
577 a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
578 b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
579 b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? ip->protocol : 0;
581 t1 = is_tcp_udp ? tcp->ports.src : 0;
582 t2 = is_tcp_udp ? tcp->ports.dst : 0;
584 t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
585 t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
587 c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
588 ((t1<<16) | t2) : ((t2<<16) | t1);
590 hash_mix64 (a, b, c);
595 * Hop-by-Hop handling
598 /* Array of function pointers to HBH option handling routines */
599 int (*options[256])(vlib_buffer_t *b, ip6_header_t *ip, ip6_hop_by_hop_option_t *opt);
600 u8 *(*trace[256])(u8 *s, ip6_hop_by_hop_option_t *opt);
602 } ip6_hop_by_hop_main_t;
604 extern ip6_hop_by_hop_main_t ip6_hop_by_hop_main;
606 int ip6_hbh_register_option (u8 option,
607 int options(vlib_buffer_t *b, ip6_header_t *ip, ip6_hop_by_hop_option_t *opt),
608 u8 *trace(u8 *s, ip6_hop_by_hop_option_t *opt));
609 int ip6_hbh_unregister_option (u8 option);
610 void ip6_hbh_set_next_override (uword next);
612 /* Flag used by IOAM code. Classifier sets it pop-hop-by-hop checks it */
615 #endif /* included_ip_ip6_h */