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/ethernet/mac_address.h>
46 #include <vnet/ip/ip6_packet.h>
47 #include <vnet/ip/ip46_address.h>
48 #include <vnet/ip/ip6_hop_by_hop_packet.h>
49 #include <vnet/ip/lookup.h>
51 #include <vppinfra/bihash_24_8.h>
52 #include <vppinfra/bihash_40_8.h>
53 #include <vppinfra/bihash_template.h>
54 #include <vnet/util/radix.h>
55 #include <vnet/util/throttle.h>
58 * Default size of the ip6 fib hash table
60 #define IP6_FIB_DEFAULT_HASH_NUM_BUCKETS (64 * 1024)
61 #define IP6_FIB_DEFAULT_HASH_MEMORY_SIZE (32<<20)
66 u32 dst_address_length;
72 /* required for pool_get_aligned. */
73 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
75 /* Table ID (hash key) for this FIB. */
78 /* Index into FIB vector. */
82 typedef struct ip6_mfib_t
84 /* required for pool_get_aligned. */
85 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
87 /* Table ID (hash key) for this FIB. */
90 /* Index into FIB vector. */
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;
109 typedef void (ip6_table_bind_function_t)
110 (struct ip6_main_t * im,
111 uword opaque, u32 sw_if_index, u32 new_fib_index, u32 old_fib_index);
115 ip6_table_bind_function_t *function;
116 uword function_opaque;
117 } ip6_table_bind_callback_t;
120 * Enumeration of the FIB table instance types
122 typedef enum ip6_fib_table_instance_type_t_
125 * This table stores the routes that are used to forward traffic.
126 * The key is the prefix, the result the adjacency to forward on.
128 IP6_FIB_TABLE_FWDING,
130 * The table that stores ALL routes learned by the DP.
131 * Some of these routes may not be ready to install in forwarding
133 * The key in this table is the prefix, the result is the fib_entry_t
135 IP6_FIB_TABLE_NON_FWDING,
136 } ip6_fib_table_instance_type_t;
138 #define IP6_FIB_NUM_TABLES (IP6_FIB_TABLE_NON_FWDING+1)
141 * A representation of a single IP6 table
143 typedef struct ip6_fib_table_instance_t_
146 clib_bihash_24_8_t ip6_hash;
148 /* bitmap / refcounts / vector of mask widths to search */
149 uword *non_empty_dst_address_length_bitmap;
150 u8 *prefix_lengths_in_search_order;
151 i32 dst_address_length_refcounts[129];
152 } ip6_fib_table_instance_t;
155 * A representation of a single IP6 mfib table
157 typedef struct ip6_mfib_table_instance_t_
160 clib_bihash_40_8_t ip6_mhash;
162 /* bitmap / refcounts / vector of mask widths to search */
163 uword *non_empty_dst_address_length_bitmap;
164 u16 *prefix_lengths_in_search_order;
165 i32 dst_address_length_refcounts[257];
166 } ip6_mfib_table_instance_t;
168 typedef struct ip6_main_t
171 * The two FIB tables; fwding and non-fwding
173 ip6_fib_table_instance_t ip6_table[IP6_FIB_NUM_TABLES];
176 * the single MFIB table
178 ip6_mfib_table_instance_t ip6_mtable;
180 ip_lookup_main_t lookup_main;
183 struct fib_table_t_ *fibs;
185 /* Pool of V6 FIBs. */
188 /** Vector of MFIBs. */
189 struct mfib_table_t_ *mfibs;
191 /* Network byte orders subnet mask for each prefix length */
192 ip6_address_t fib_masks[129];
194 /* Table index indexed by software interface. */
195 u32 *fib_index_by_sw_if_index;
197 /** Table index indexed by software interface. */
198 u32 *mfib_index_by_sw_if_index;
200 /* IP6 enabled count by software interface */
201 u8 *ip_enabled_by_sw_if_index;
203 /* Hash table mapping table id to fib index.
204 ID space is not necessarily dense; index space is dense. */
205 uword *fib_index_by_table_id;
207 /** Hash table mapping table id to multicast fib index.
208 ID space is not necessarily dense; index space is dense. */
209 uword *mfib_index_by_table_id;
211 /* Hash table mapping interface rewrite adjacency index by sw if index. */
212 uword *interface_route_adj_index_by_sw_if_index;
214 /* Functions to call when interface address changes. */
215 ip6_add_del_interface_address_callback_t
216 * add_del_interface_address_callbacks;
218 /** Functions to call when interface to table biding changes. */
219 ip6_table_bind_callback_t *table_bind_callbacks;
221 /* ip6 lookup table config parameters */
222 u32 lookup_table_nbuckets;
223 uword lookup_table_size;
225 /* Seed for Jenkins hash used to compute ip6 flow hash. */
230 /* TTL to use for host generated packets. */
236 /* HBH processing enabled? */
240 throttle_t nd_throttle;
243 #define ND_THROTTLE_BITS 512
245 /* Global ip6 main structure. */
246 extern ip6_main_t ip6_main;
248 /* Global ip6 input node. Errors get attached to ip6 input node. */
249 extern vlib_node_registration_t ip6_input_node;
250 extern vlib_node_registration_t ip6_rewrite_node;
251 extern vlib_node_registration_t ip6_rewrite_mcast_node;
252 extern vlib_node_registration_t ip6_rewrite_local_node;
253 extern vlib_node_registration_t ip6_discover_neighbor_node;
254 extern vlib_node_registration_t ip6_glean_node;
255 extern vlib_node_registration_t ip6_midchain_node;
256 extern vlib_node_registration_t ip6_punt_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 /* Find interface address which matches destination. */
305 always_inline ip6_address_t *
306 ip6_interface_address_matching_destination (ip6_main_t * im,
307 const ip6_address_t * dst,
309 ip_interface_address_t **
312 ip_lookup_main_t *lm = &im->lookup_main;
313 ip_interface_address_t *ia;
314 ip6_address_t *result = 0;
317 foreach_ip_interface_address (lm, ia, sw_if_index,
318 1 /* honor unnumbered */,
320 ip6_address_t * a = ip_interface_address_get_address (lm, ia);
321 if (ip6_destination_matches_route (im, dst, a, ia->address_length))
329 *result_ia = result ? ia : 0;
333 clib_error_t *ip6_add_del_interface_address (vlib_main_t * vm,
335 ip6_address_t * address,
336 u32 address_length, u32 is_del);
337 void ip6_sw_interface_enable_disable (u32 sw_if_index, u32 is_enable);
340 * @brie get first IPv6 interface address
342 ip6_address_t *ip6_interface_first_address (ip6_main_t * im, u32 sw_if_index);
344 int ip6_address_compare (ip6_address_t * a1, ip6_address_t * a2);
347 ip6_udp_register_listener (vlib_main_t * vm,
348 u16 dst_port, u32 next_node_index);
350 u16 ip6_tcp_udp_icmp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0,
354 void ip6_register_protocol (u32 protocol, u32 node_index);
355 void ip6_unregister_protocol (u32 protocol);
356 void ip6_local_hop_by_hop_register_protocol (u32 protocol, u32 node_index);
358 serialize_function_t serialize_vnet_ip6_main, unserialize_vnet_ip6_main;
360 int vnet_set_ip6_flow_hash (u32 table_id,
361 flow_hash_config_t flow_hash_config);
363 u8 *format_ip6_forward_next_trace (u8 * s, va_list * args);
365 u32 ip6_tcp_udp_icmp_validate_checksum (vlib_main_t * vm, vlib_buffer_t * p0);
367 void ip6_punt_policer_add_del (u8 is_add, u32 policer_index);
368 void ip6_punt_redirect_add (u32 rx_sw_if_index,
369 u32 tx_sw_if_index, ip46_address_t * nh);
370 void ip6_punt_redirect_add_paths (u32 rx_sw_if_index,
371 fib_route_path_t * paths);
372 void ip6_punt_redirect_del (u32 rx_sw_if_index);
374 int vnet_set_ip6_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
376 extern vlib_node_registration_t ip6_lookup_node;
378 /* Compute flow hash. We'll use it to select which Sponge to use for this
379 flow. And other things. */
381 ip6_compute_flow_hash (const ip6_header_t * ip,
382 flow_hash_config_t flow_hash_config)
387 uword is_tcp_udp = 0;
388 u8 protocol = ip->protocol;
391 ((ip->protocol == IP_PROTOCOL_TCP)
392 || (ip->protocol == IP_PROTOCOL_UDP)))
395 tcp = (void *) (ip + 1);
397 else if (ip->protocol == IP_PROTOCOL_IP6_HOP_BY_HOP_OPTIONS)
399 ip6_hop_by_hop_header_t *hbh = (ip6_hop_by_hop_header_t *) (ip + 1);
400 if ((hbh->protocol == IP_PROTOCOL_TCP) ||
401 (hbh->protocol == IP_PROTOCOL_UDP))
404 tcp = (tcp_header_t *) ((u8 *) hbh + ((hbh->length + 1) << 3));
406 protocol = hbh->protocol;
409 t1 = (ip->src_address.as_u64[0] ^ ip->src_address.as_u64[1]);
410 t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR) ? t1 : 0;
412 t2 = (ip->dst_address.as_u64[0] ^ ip->dst_address.as_u64[1]);
413 t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR) ? t2 : 0;
415 a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
416 b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
418 t1 = is_tcp_udp ? tcp->src : 0;
419 t2 = is_tcp_udp ? tcp->dst : 0;
421 t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
422 t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
424 if (flow_hash_config & IP_FLOW_HASH_SYMMETRIC)
440 b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? protocol : 0;
441 c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
442 ((t1 << 16) | t2) : ((t2 << 16) | t1);
444 hash_mix64 (a, b, c);
450 * This function is to search for the header specified by the protocol number
452 * This is used to locate a specific IPv6 extension header
453 * or to find transport layer header.
454 * 1. If the find_hdr_type < 0 then it finds and returns the protocol number and
455 * offset stored in *offset of the transport or ESP header in the chain if
457 * 2. If a header with find_hdr_type > 0 protocol number is found then the
458 * offset is stored in *offset and protocol number of the header is
460 * 3. If find_hdr_type is not found or packet is malformed or
461 * it is a non-first fragment -1 is returned.
464 ip6_locate_header (vlib_buffer_t * p0,
465 ip6_header_t * ip0, int find_hdr_type, u32 * offset)
467 u8 next_proto = ip0->protocol;
474 next_header = ip6_next_header (ip0);
475 cur_offset = sizeof (ip6_header_t);
478 done = (next_proto == find_hdr_type);
481 (u8 *) vlib_buffer_get_current (p0) + p0->current_length))
483 //A malicious packet could set an extension header with a too big size
488 if ((!ip6_ext_hdr (next_proto)) || next_proto == IP_PROTOCOL_IP6_NONXT)
490 if (find_hdr_type < 0)
494 if (next_proto == IP_PROTOCOL_IPV6_FRAGMENTATION)
496 ip6_frag_hdr_t *frag_hdr = (ip6_frag_hdr_t *) next_header;
497 u16 frag_off = ip6_frag_hdr_offset (frag_hdr);
498 /* Non first fragment return -1 */
501 exthdr_len = sizeof (ip6_frag_hdr_t);
502 temp_nxthdr = next_header + exthdr_len;
504 else if (next_proto == IP_PROTOCOL_IPSEC_AH)
507 ip6_ext_authhdr_len (((ip6_ext_header_t *) next_header));
508 temp_nxthdr = next_header + exthdr_len;
513 ip6_ext_header_len (((ip6_ext_header_t *) next_header));
514 temp_nxthdr = next_header + exthdr_len;
516 next_proto = ((ip6_ext_header_t *) next_header)->next_hdr;
517 next_header = temp_nxthdr;
518 cur_offset += exthdr_len;
521 *offset = cur_offset;
525 u8 *format_ip6_hop_by_hop_ext_hdr (u8 * s, va_list * args);
527 * Hop-by-Hop handling
531 /* Array of function pointers to HBH option handling routines */
532 int (*options[256]) (vlib_buffer_t * b, ip6_header_t * ip,
533 ip6_hop_by_hop_option_t * opt);
534 u8 *(*trace[256]) (u8 * s, ip6_hop_by_hop_option_t * opt);
536 } ip6_hop_by_hop_main_t;
538 extern ip6_hop_by_hop_main_t ip6_hop_by_hop_main;
540 int ip6_hbh_register_option (u8 option,
541 int options (vlib_buffer_t * b,
543 ip6_hop_by_hop_option_t * opt),
545 ip6_hop_by_hop_option_t * opt));
546 int ip6_hbh_unregister_option (u8 option);
547 void ip6_hbh_set_next_override (uword next);
550 * Push IPv6 header to buffer
552 * @param vm - vlib_main
553 * @param b - buffer to write the header to
554 * @param src - source IP
555 * @param dst - destination IP
556 * @param prot - payload proto
557 * @param flow_label - flow label
559 * @return - pointer to start of IP header
562 vlib_buffer_push_ip6_custom (vlib_main_t * vm, vlib_buffer_t * b,
563 ip6_address_t * src, ip6_address_t * dst,
564 int proto, u32 flow_label)
570 ip6h = vlib_buffer_push_uninit (b, sizeof (ip6_header_t));
571 ASSERT (flow_label < 1 << 20);
572 ip6h->ip_version_traffic_class_and_flow_label =
573 clib_host_to_net_u32 ((0x6 << 28) | flow_label);
575 /* calculate ip6 payload length */
576 payload_length = vlib_buffer_length_in_chain (vm, b);
577 payload_length -= sizeof (*ip6h);
579 ip6h->payload_length = clib_host_to_net_u16 (payload_length);
581 ip6h->hop_limit = 0xff;
582 ip6h->protocol = proto;
583 clib_memcpy_fast (ip6h->src_address.as_u8, src->as_u8,
584 sizeof (ip6h->src_address));
585 clib_memcpy_fast (ip6h->dst_address.as_u8, dst->as_u8,
586 sizeof (ip6h->src_address));
587 vnet_buffer (b)->l3_hdr_offset = (u8 *) ip6h - b->data;
588 b->flags |= VNET_BUFFER_F_IS_IP6 | VNET_BUFFER_F_L3_HDR_OFFSET_VALID;
594 * Push IPv6 header to buffer
596 * @param vm - vlib_main
597 * @param b - buffer to write the header to
598 * @param src - source IP
599 * @param dst - destination IP
600 * @param prot - payload proto
602 * @return - pointer to start of IP header
605 vlib_buffer_push_ip6 (vlib_main_t * vm, vlib_buffer_t * b,
606 ip6_address_t * src, ip6_address_t * dst, int proto)
608 return vlib_buffer_push_ip6_custom (vm, b, src, dst, proto,
609 0 /* flow label */ );
614 vlib_buffer_get_ip6_fib_index (vlib_buffer_t * b)
616 u32 fib_index, sw_if_index;
617 sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_RX];
618 fib_index = vnet_buffer (b)->sw_if_index[VLIB_TX];
619 return (fib_index == (u32) ~ 0) ?
620 vec_elt (ip6_main.fib_index_by_sw_if_index, sw_if_index) : fib_index;
622 #endif /* included_ip_ip6_h */
625 * fd.io coding-style-patch-verification: ON
628 * eval: (c-set-style "gnu")