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 <vnet/ip/ip6_packet.h>
45 #include <vnet/ip/ip6_hop_by_hop_packet.h>
46 #include <vnet/ip/lookup.h>
47 #include <vnet/ip/ip_feature_registration.h>
49 #include <vppinfra/bihash_24_8.h>
50 #include <vppinfra/bihash_template.h>
53 * Default size of the ip6 fib hash table
55 #define IP6_FIB_DEFAULT_HASH_NUM_BUCKETS (64 * 1024)
56 #define IP6_FIB_DEFAULT_HASH_MEMORY_SIZE (32<<20)
60 u32 dst_address_length;
65 /* Table ID (hash key) for this FIB. */
68 /* Index into FIB vector. */
71 /* flow hash configuration */
77 typedef void (ip6_add_del_route_function_t)
78 (struct ip6_main_t * im,
82 ip6_address_t * address,
88 ip6_add_del_route_function_t * function;
90 uword function_opaque;
91 } ip6_add_del_route_callback_t;
93 typedef void (ip6_add_del_interface_address_function_t)
94 (struct ip6_main_t * im,
97 ip6_address_t * address,
103 ip6_add_del_interface_address_function_t * function;
104 uword function_opaque;
105 } ip6_add_del_interface_address_callback_t;
107 typedef struct ip6_main_t {
108 BVT(clib_bihash) ip6_lookup_table;
110 ip_lookup_main_t lookup_main;
112 /* bitmap / refcounts / vector of mask widths to search */
113 uword * non_empty_dst_address_length_bitmap;
114 u8 * prefix_lengths_in_search_order;
115 i32 dst_address_length_refcounts[129];
117 /* Vector of FIBs. */
120 ip6_address_t fib_masks[129];
122 /* Table index indexed by software interface. */
123 u32 * fib_index_by_sw_if_index;
125 /* Hash table mapping table id to fib index.
126 ID space is not necessarily dense; index space is dense. */
127 uword * fib_index_by_table_id;
129 /* Vector of functions to call when routes are added/deleted. */
130 ip6_add_del_route_callback_t * add_del_route_callbacks;
132 /* Hash table mapping interface rewrite adjacency index by sw if index. */
133 uword * interface_route_adj_index_by_sw_if_index;
135 /* Functions to call when interface address changes. */
136 ip6_add_del_interface_address_callback_t * add_del_interface_address_callbacks;
138 /* Template used to generate IP6 neighbor solicitation packets. */
139 vlib_packet_template_t discover_neighbor_packet_template;
141 /* ip6 lookup table config parameters */
142 u32 lookup_table_nbuckets;
143 uword lookup_table_size;
145 /* feature path configuration lists */
146 vnet_ip_feature_registration_t * next_uc_feature;
147 vnet_ip_feature_registration_t * next_mc_feature;
149 /* Built-in unicast feature path indices, see ip_feature_init_cast(...) */
150 u32 ip6_unicast_rx_feature_check_access;
151 u32 ip6_unicast_rx_feature_ipsec;
152 u32 ip6_unicast_rx_feature_l2tp_decap;
153 u32 ip6_unicast_rx_feature_vpath;
154 u32 ip6_unicast_rx_feature_lookup;
156 /* Built-in multicast feature path indices */
157 u32 ip6_multicast_rx_feature_vpath;
158 u32 ip6_multicast_rx_feature_lookup;
160 /* Seed for Jenkins hash used to compute ip6 flow hash. */
164 /* TTL to use for host generated packets. */
170 /* HBH processing enabled? */
174 /* Global ip6 main structure. */
175 extern ip6_main_t ip6_main;
177 #define VNET_IP6_UNICAST_FEATURE_INIT(x,...) \
178 __VA_ARGS__ vnet_ip_feature_registration_t uc_##x; \
179 static void __vnet_add_feature_registration_uc_##x (void) \
180 __attribute__((__constructor__)) ; \
181 static void __vnet_add_feature_registration_uc_##x (void) \
183 ip6_main_t * im = &ip6_main; \
184 uc_##x.next = im->next_uc_feature; \
185 im->next_uc_feature = &uc_##x; \
187 __VA_ARGS__ vnet_ip_feature_registration_t uc_##x
189 #define VNET_IP6_MULTICAST_FEATURE_INIT(x,...) \
190 __VA_ARGS__ vnet_ip_feature_registration_t mc_##x; \
191 static void __vnet_add_feature_registration_mc_##x (void) \
192 __attribute__((__constructor__)) ; \
193 static void __vnet_add_feature_registration_mc_##x (void) \
195 ip6_main_t * im = &ip6_main; \
196 mc_##x.next = im->next_mc_feature; \
197 im->next_mc_feature = &mc_##x; \
199 __VA_ARGS__ vnet_ip_feature_registration_t mc_##x
201 /* Global ip6 input node. Errors get attached to ip6 input node. */
202 extern vlib_node_registration_t ip6_input_node;
203 extern vlib_node_registration_t ip6_rewrite_node;
204 extern vlib_node_registration_t ip6_rewrite_local_node;
205 extern vlib_node_registration_t ip6_discover_neighbor_node;
207 extern vlib_node_registration_t ip6_icmp_neighbor_discovery_event_node;
209 /* ipv6 neighbor discovery - timer/event types */
212 } ip6_icmp_neighbor_discovery_event_type_t;
220 } ip6_icmp_neighbor_discovery_event_data_t;
222 u32 ip6_fib_lookup (ip6_main_t * im, u32 sw_if_index, ip6_address_t * dst);
223 u32 ip6_fib_lookup_with_table (ip6_main_t * im, u32 fib_index,
224 ip6_address_t * dst);
227 * \brief Get or create an IPv6 fib.
229 * Get or create an IPv6 fib with the provided fib ID or index.
230 * The fib ID is a possibly-sparse user-defined value while
231 * the fib index defines the position of the fib in the fib vector.
235 * \param table_index_or_id
236 * The table index if \c IP6_ROUTE_FLAG_FIB_INDEX bit is set in \p flags.
237 * Otherwise, when set to \c ~0, an arbitrary and unused fib ID is picked
238 * and can be retrieved with \c ret->table_id.
239 * Otherwise, it is the fib ID to be used to retrieve or create the desired fib.
241 * Indicates whether \p table_index_or_id is the fib index or ID.
242 * When the bit \c IP6_ROUTE_FLAG_FIB_INDEX is set, \p table_index_or_id
243 * is considered as the fib index, and the fib ID otherwise.
244 * \return A pointer to the retrieved or created fib.
246 * \remark When getting a fib with the fib index, the fib MUST already exist.
248 ip6_fib_t * find_ip6_fib_by_table_index_or_id (ip6_main_t * im,
249 u32 table_index_or_id,
253 ip6_destination_matches_route (ip6_main_t * im,
255 ip6_address_t * dest,
259 for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
261 if ((key->as_uword[i] ^ dest->as_uword[i]) & im->fib_masks[dest_length].as_uword[i])
268 ip6_destination_matches_interface (ip6_main_t * im,
270 ip_interface_address_t * ia)
272 ip6_address_t * a = ip_interface_address_get_address (&im->lookup_main, ia);
273 return ip6_destination_matches_route (im, key, a, ia->address_length);
276 /* As above but allows for unaligned destinations (e.g. works right from IP header of packet). */
278 ip6_unaligned_destination_matches_route (ip6_main_t * im,
280 ip6_address_t * dest,
284 for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
286 if ((clib_mem_unaligned (&key->as_uword[i], uword) ^ dest->as_uword[i]) & im->fib_masks[dest_length].as_uword[i])
293 ip6_src_address_for_packet (ip6_main_t * im, vlib_buffer_t * p, ip6_address_t * src, u32 sw_if_index)
295 ip_lookup_main_t * lm = &im->lookup_main;
296 ip_interface_address_t * ia = ip_interface_address_for_packet (lm, p, sw_if_index);
297 ip6_address_t * a = ip_interface_address_get_address (lm, ia);
302 ip6_src_lookup_for_packet (ip6_main_t * im, vlib_buffer_t * b, ip6_header_t * i)
304 if (vnet_buffer (b)->ip.adj_index[VLIB_RX] == ~0)
305 vnet_buffer (b)->ip.adj_index[VLIB_RX]
306 = ip6_fib_lookup (im, vnet_buffer (b)->sw_if_index[VLIB_RX],
308 return vnet_buffer (b)->ip.adj_index[VLIB_RX];
311 /* Find interface address which matches destination. */
312 always_inline ip6_address_t *
313 ip6_interface_address_matching_destination (ip6_main_t * im, ip6_address_t * dst, u32 sw_if_index,
314 ip_interface_address_t ** result_ia)
316 ip_lookup_main_t * lm = &im->lookup_main;
317 ip_interface_address_t * ia;
318 ip6_address_t * result = 0;
320 foreach_ip_interface_address (lm, ia, sw_if_index,
321 1 /* honor unnumbered */,
323 ip6_address_t * a = ip_interface_address_get_address (lm, ia);
324 if (ip6_destination_matches_route (im, dst, a, ia->address_length))
331 *result_ia = result ? ia : 0;
336 ip6_add_del_interface_address (vlib_main_t * vm, u32 sw_if_index,
337 ip6_address_t * address, u32 address_length,
340 int ip6_address_compare (ip6_address_t * a1, ip6_address_t * a2);
342 /* Add/del a route to the FIB. */
344 #define IP6_ROUTE_FLAG_ADD (0 << 0)
345 #define IP6_ROUTE_FLAG_DEL (1 << 0)
346 #define IP6_ROUTE_FLAG_TABLE_ID (0 << 1)
347 #define IP6_ROUTE_FLAG_FIB_INDEX (1 << 1)
348 #define IP6_ROUTE_FLAG_KEEP_OLD_ADJACENCY (1 << 2)
349 #define IP6_ROUTE_FLAG_NO_REDISTRIBUTE (1 << 3)
350 #define IP6_ROUTE_FLAG_NOT_LAST_IN_GROUP (1 << 4)
351 /* Dynamic route created via neighbor discovery. */
352 #define IP6_ROUTE_FLAG_NEIGHBOR (1 << 5)
355 /* IP6_ROUTE_FLAG_* */
358 /* Either index of fib or table_id to hash and get fib.
359 IP6_ROUTE_FLAG_FIB_INDEX specifies index; otherwise table_id is assumed. */
360 u32 table_index_or_table_id;
362 /* Destination address (prefix) and length. */
363 ip6_address_t dst_address;
364 u32 dst_address_length;
366 /* Adjacency to use for this destination. */
369 /* If specified adjacencies to add and then
370 use for this destination. add_adj/n_add_adj
371 are override adj_index if specified. */
372 ip_adjacency_t * add_adj;
374 } ip6_add_del_route_args_t;
376 void ip6_add_del_route (ip6_main_t * im, ip6_add_del_route_args_t * args);
378 void ip6_add_del_route_next_hop (ip6_main_t * im,
380 ip6_address_t * dst_address,
381 u32 dst_address_length,
382 ip6_address_t * next_hop,
383 u32 next_hop_sw_if_index,
384 u32 next_hop_weight, u32 adj_index,
385 u32 explicit_fib_index);
387 ip6_get_route (ip6_main_t * im,
388 u32 fib_index_or_table_id,
390 ip6_address_t * address,
394 ip6_foreach_matching_route (ip6_main_t * im,
395 u32 table_index_or_table_id,
397 ip6_address_t * address,
399 ip6_address_t ** results,
400 u8 ** result_length);
402 void ip6_delete_matching_routes (ip6_main_t * im,
403 u32 table_index_or_table_id,
405 ip6_address_t * address,
408 void ip6_maybe_remap_adjacencies (ip6_main_t * im,
409 u32 table_index_or_table_id,
412 void ip6_adjacency_set_interface_route (vnet_main_t * vnm,
413 ip_adjacency_t * adj,
415 u32 if_address_index);
418 vnet_ip6_neighbor_glean_add(u32 fib_index, void * next_hop_arg);
421 ip6_probe_neighbor (vlib_main_t * vm, ip6_address_t * dst, u32 sw_if_index);
424 ip6_set_neighbor_limit (u32 neighbor_limit);
427 ip6_udp_register_listener (vlib_main_t * vm,
429 u32 next_node_index);
431 u16 ip6_tcp_udp_icmp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0, ip6_header_t * ip0, int *bogus_lengthp);
433 void ip6_register_protocol (u32 protocol, u32 node_index);
435 serialize_function_t serialize_vnet_ip6_main, unserialize_vnet_ip6_main;
438 vnet_set_ip6_ethernet_neighbor (vlib_main_t * vm,
441 u8 * link_layer_address,
442 uword n_bytes_link_layer_address,
445 vnet_unset_ip6_ethernet_neighbor (vlib_main_t * vm,
448 u8 * link_layer_address,
449 uword n_bytes_link_layer_address);
451 vnet_ip6_fib_init (ip6_main_t * im, u32 fib_index);
454 ip6_link_local_address_from_ethernet_mac_address (ip6_address_t *ip,
458 ip6_ethernet_mac_address_from_link_local_address (u8 *mac,
461 int vnet_set_ip6_flow_hash (u32 table_id, u32 flow_hash_config);
464 ip6_neighbor_ra_config(vlib_main_t * vm, u32 sw_if_index,
465 u8 surpress, u8 managed, u8 other,
466 u8 ll_option, u8 send_unicast, u8 cease,
467 u8 use_lifetime, u32 lifetime,
468 u32 initial_count, u32 initial_interval,
469 u32 max_interval, u32 min_interval,
473 ip6_neighbor_ra_prefix(vlib_main_t * vm, u32 sw_if_index,
474 ip6_address_t *prefix_addr, u8 prefix_len,
475 u8 use_default, u32 val_lifetime, u32 pref_lifetime,
476 u8 no_advertise, u8 off_link, u8 no_autoconfig, u8 no_onlink,
481 enable_ip6_interface(vlib_main_t * vm,
485 disable_ip6_interface(vlib_main_t * vm,
489 ip6_interface_enabled(vlib_main_t * vm,
493 set_ip6_link_local_address(vlib_main_t * vm,
495 ip6_address_t *address,
498 void vnet_register_ip6_neighbor_resolution_event(vnet_main_t * vnm,
504 int vnet_set_ip6_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
506 extern vlib_node_registration_t ip6_lookup_node;
508 /* Compute flow hash. We'll use it to select which Sponge to use for this
509 flow. And other things. */
511 ip6_compute_flow_hash (ip6_header_t * ip, u32 flow_hash_config)
513 tcp_header_t * tcp = (void *) (ip + 1);
516 uword is_tcp_udp = (ip->protocol == IP_PROTOCOL_TCP
517 || ip->protocol == IP_PROTOCOL_UDP);
519 t1 = (ip->src_address.as_u64[0] ^ ip->src_address.as_u64[1]);
520 t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR) ? t1 : 0;
522 t2 = (ip->dst_address.as_u64[0] ^ ip->dst_address.as_u64[1]);
523 t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR) ? t2 : 0;
525 a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
526 b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
527 b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? ip->protocol : 0;
529 t1 = is_tcp_udp ? tcp->ports.src : 0;
530 t2 = is_tcp_udp ? tcp->ports.dst : 0;
532 t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
533 t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
535 c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
536 ((t1<<16) | t2) : ((t2<<16) | t1);
538 hash_mix64 (a, b, c);
543 * Hop-by-Hop handling
546 /* Array of function pointers to HBH option handling routines */
547 int (*options[256])(vlib_buffer_t *b, ip6_header_t *ip, ip6_hop_by_hop_option_t *opt);
548 u8 *(*trace[256])(u8 *s, ip6_hop_by_hop_option_t *opt);
549 } ip6_hop_by_hop_main_t;
551 extern ip6_hop_by_hop_main_t ip6_hop_by_hop_main;
553 int ip6_hbh_register_option (u8 option,
554 int options(vlib_buffer_t *b, ip6_header_t *ip, ip6_hop_by_hop_option_t *opt),
555 u8 *trace(u8 *s, ip6_hop_by_hop_option_t *opt));
556 int ip6_hbh_unregister_option (u8 option);
558 /* Flag used by IOAM code. Classifier sets it pop-hop-by-hop checks it */
561 #endif /* included_ip_ip6_h */