4 * Copyright (c) 2015 Cisco and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 #include <vnet/fib/fib_table.h>
19 #include <vnet/fib/ip6_fib.h>
20 #include <vnet/adj/adj.h>
21 #include <vnet/map/map_dpo.h>
27 crc_u32 (u32 data, u32 value)
29 __asm__ volatile ("crc32l %[data], %[value];":[value] "+r" (value):[data]
34 #include <vppinfra/xxhash.h>
37 crc_u32 (u32 data, u32 value)
39 u64 tmp = ((u64) data << 32) | (u64) value;
40 return (u32) clib_xxhash (tmp);
46 * This code supports the following MAP modes:
48 * Algorithmic Shared IPv4 address (ea_bits_len > 0):
49 * ea_bits_len + ip4_prefix > 32
50 * psid_length > 0, ip6_prefix < 64, ip4_prefix <= 32
51 * Algorithmic Full IPv4 address (ea_bits_len > 0):
52 * ea_bits_len + ip4_prefix = 32
53 * psid_length = 0, ip6_prefix < 64, ip4_prefix <= 32
54 * Algorithmic IPv4 prefix (ea_bits_len > 0):
55 * ea_bits_len + ip4_prefix < 32
56 * psid_length = 0, ip6_prefix < 64, ip4_prefix <= 32
58 * Independent Shared IPv4 address (ea_bits_len = 0):
61 * Rule IPv6 address = 128, Rule PSID Set
62 * Independent Full IPv4 address (ea_bits_len = 0):
64 * psid_length = 0, ip6_prefix = 128
65 * Independent IPv4 prefix (ea_bits_len = 0):
67 * psid_length = 0, ip6_prefix = 128
72 * This code supports MAP-T:
74 * With DMR prefix length equal to 96.
80 ip4_get_port (ip4_header_t * ip, map_dir_e dir, u16 buffer_len)
82 //TODO: use buffer length
83 if (ip->ip_version_and_header_length != 0x45 ||
84 ip4_get_fragment_offset (ip))
87 if (PREDICT_TRUE ((ip->protocol == IP_PROTOCOL_TCP) ||
88 (ip->protocol == IP_PROTOCOL_UDP)))
90 udp_header_t *udp = (void *) (ip + 1);
91 return (dir == MAP_SENDER) ? udp->src_port : udp->dst_port;
93 else if (ip->protocol == IP_PROTOCOL_ICMP)
95 icmp46_header_t *icmp = (void *) (ip + 1);
96 if (icmp->type == ICMP4_echo_request || icmp->type == ICMP4_echo_reply)
98 return *((u16 *) (icmp + 1));
100 else if (clib_net_to_host_u16 (ip->length) >= 64)
102 ip = (ip4_header_t *) (icmp + 2);
103 if (PREDICT_TRUE ((ip->protocol == IP_PROTOCOL_TCP) ||
104 (ip->protocol == IP_PROTOCOL_UDP)))
106 udp_header_t *udp = (void *) (ip + 1);
107 return (dir == MAP_SENDER) ? udp->dst_port : udp->src_port;
109 else if (ip->protocol == IP_PROTOCOL_ICMP)
111 icmp46_header_t *icmp = (void *) (ip + 1);
112 if (icmp->type == ICMP4_echo_request ||
113 icmp->type == ICMP4_echo_reply)
115 return *((u16 *) (icmp + 1));
124 ip6_get_port (ip6_header_t * ip6, map_dir_e dir, u16 buffer_len)
131 if (ip6_parse (ip6, buffer_len, &l4_protocol, &l4_offset, &frag_offset))
134 //TODO: Use buffer length
137 ip6_frag_hdr_offset (((ip6_frag_hdr_t *)
138 u8_ptr_add (ip6, frag_offset))))
139 return -1; //Can't deal with non-first fragment for now
141 l4 = u8_ptr_add (ip6, l4_offset);
142 if (l4_protocol == IP_PROTOCOL_TCP || l4_protocol == IP_PROTOCOL_UDP)
145 MAP_SENDER) ? ((udp_header_t *) (l4))->src_port : ((udp_header_t
149 else if (l4_protocol == IP_PROTOCOL_ICMP6)
151 icmp46_header_t *icmp = (icmp46_header_t *) (l4);
152 if (icmp->type == ICMP6_echo_request)
154 return (dir == MAP_SENDER) ? ((u16 *) (icmp))[2] : -1;
156 else if (icmp->type == ICMP6_echo_reply)
158 return (dir == MAP_SENDER) ? -1 : ((u16 *) (icmp))[2];
166 map_create_domain (ip4_address_t * ip4_prefix,
168 ip6_address_t * ip6_prefix,
170 ip6_address_t * ip6_src,
174 u8 psid_length, u32 * map_domain_index, u16 mtu, u8 flags)
176 u8 suffix_len, suffix_shift;
177 map_main_t *mm = &map_main;
178 dpo_id_t dpo_v4 = DPO_INVALID;
179 dpo_id_t dpo_v6 = DPO_INVALID;
182 /* Sanity check on the src prefix length */
183 if (flags & MAP_DOMAIN_TRANSLATION)
185 if (ip6_src_len != 96)
187 clib_warning ("MAP-T only supports ip6_src_len = 96 for now.");
193 if (ip6_src_len != 128)
196 ("MAP-E requires a BR address, not a prefix (ip6_src_len should "
202 /* How many, and which bits to grab from the IPv4 DA */
203 if (ip4_prefix_len + ea_bits_len < 32)
205 flags |= MAP_DOMAIN_PREFIX;
206 suffix_shift = 32 - ip4_prefix_len - ea_bits_len;
207 suffix_len = ea_bits_len;
212 suffix_len = 32 - ip4_prefix_len;
215 /* EA bits must be within the first 64 bits */
216 if (ea_bits_len > 0 && ((ip6_prefix_len + ea_bits_len) > 64 ||
217 ip6_prefix_len + suffix_len + psid_length > 64))
220 ("Embedded Address bits must be within the first 64 bits of "
225 /* Get domain index */
226 pool_get_aligned (mm->domains, d, CLIB_CACHE_LINE_BYTES);
227 memset (d, 0, sizeof (*d));
228 *map_domain_index = d - mm->domains;
230 /* Init domain struct */
231 d->ip4_prefix.as_u32 = ip4_prefix->as_u32;
232 d->ip4_prefix_len = ip4_prefix_len;
233 d->ip6_prefix = *ip6_prefix;
234 d->ip6_prefix_len = ip6_prefix_len;
235 d->ip6_src = *ip6_src;
236 d->ip6_src_len = ip6_src_len;
237 d->ea_bits_len = ea_bits_len;
238 d->psid_offset = psid_offset;
239 d->psid_length = psid_length;
242 d->suffix_shift = suffix_shift;
243 d->suffix_mask = (1 << suffix_len) - 1;
245 d->psid_shift = 16 - psid_length - psid_offset;
246 d->psid_mask = (1 << d->psid_length) - 1;
247 d->ea_shift = 64 - ip6_prefix_len - suffix_len - d->psid_length;
249 /* MAP data-plane object */
250 if (d->flags & MAP_DOMAIN_TRANSLATION)
251 map_t_dpo_create (DPO_PROTO_IP4, *map_domain_index, &dpo_v4);
253 map_dpo_create (DPO_PROTO_IP4, *map_domain_index, &dpo_v4);
255 /* Create ip4 route */
257 .fp_proto = FIB_PROTOCOL_IP4,
258 .fp_len = d->ip4_prefix_len,
260 .ip4 = d->ip4_prefix,
264 fib_table_entry_special_dpo_add (0, &pfx,
266 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo_v4);
270 * construct a DPO to use the v6 domain
272 if (d->flags & MAP_DOMAIN_TRANSLATION)
273 map_t_dpo_create (DPO_PROTO_IP6, *map_domain_index, &dpo_v6);
275 map_dpo_create (DPO_PROTO_IP6, *map_domain_index, &dpo_v6);
278 * Multiple MAP domains may share same source IPv6 TEP. Which is just dandy.
279 * We are not tracking the sharing. So a v4 lookup to find the correct
280 * domain post decap/trnaslate is always done
282 * Create ip6 route. This is a reference counted add. If the prefix
283 * already exists and is MAP sourced, it is now MAP source n+1 times
284 * and will need to be removed n+1 times.
286 fib_prefix_t pfx6 = {
287 .fp_proto = FIB_PROTOCOL_IP6,
288 .fp_len = d->ip6_src_len,
289 .fp_addr.ip6 = d->ip6_src,
292 fib_table_entry_special_dpo_add (0, &pfx6,
294 FIB_ENTRY_FLAG_EXCLUSIVE, &dpo_v6);
297 /* Validate packet/byte counters */
298 map_domain_counter_lock (mm);
300 for (i = 0; i < vec_len (mm->simple_domain_counters); i++)
302 vlib_validate_simple_counter (&mm->simple_domain_counters[i],
304 vlib_zero_simple_counter (&mm->simple_domain_counters[i],
307 for (i = 0; i < vec_len (mm->domain_counters); i++)
309 vlib_validate_combined_counter (&mm->domain_counters[i],
311 vlib_zero_combined_counter (&mm->domain_counters[i], *map_domain_index);
313 map_domain_counter_unlock (mm);
322 map_delete_domain (u32 map_domain_index)
324 map_main_t *mm = &map_main;
327 if (pool_is_free_index (mm->domains, map_domain_index))
329 clib_warning ("MAP domain delete: domain does not exist: %d",
334 d = pool_elt_at_index (mm->domains, map_domain_index);
337 .fp_proto = FIB_PROTOCOL_IP4,
338 .fp_len = d->ip4_prefix_len,
340 .ip4 = d->ip4_prefix,
344 fib_table_entry_special_remove (0, &pfx, FIB_SOURCE_MAP);
346 fib_prefix_t pfx6 = {
347 .fp_proto = FIB_PROTOCOL_IP6,
348 .fp_len = d->ip6_src_len,
354 fib_table_entry_special_remove (0, &pfx6, FIB_SOURCE_MAP);
358 clib_mem_free (d->rules);
360 pool_put (mm->domains, d);
366 map_add_del_psid (u32 map_domain_index, u16 psid, ip6_address_t * tep,
370 map_main_t *mm = &map_main;
372 if (pool_is_free_index (mm->domains, map_domain_index))
374 clib_warning ("MAP rule: domain does not exist: %d", map_domain_index);
377 d = pool_elt_at_index (mm->domains, map_domain_index);
379 /* Rules are only used in 1:1 independent case */
380 if (d->ea_bits_len > 0)
385 u32 l = (0x1 << d->psid_length) * sizeof (ip6_address_t);
386 d->rules = clib_mem_alloc_aligned (l, CLIB_CACHE_LINE_BYTES);
389 memset (d->rules, 0, l);
392 if (psid >= (0x1 << d->psid_length))
394 clib_warning ("MAP rule: PSID outside bounds: %d [%d]", psid,
395 0x1 << d->psid_length);
401 d->rules[psid] = *tep;
405 memset (&d->rules[psid], 0, sizeof (ip6_address_t));
410 #ifdef MAP_SKIP_IP6_LOOKUP
412 * Pre-resolvd per-protocol global next-hops
414 map_main_pre_resolved_t pre_resolved[FIB_PROTOCOL_MAX];
417 map_pre_resolve_init (map_main_pre_resolved_t * pr)
419 pr->fei = FIB_NODE_INDEX_INVALID;
420 fib_node_init (&pr->node, FIB_NODE_TYPE_MAP_E);
424 format_map_pre_resolve (u8 * s, va_list ap)
426 map_main_pre_resolved_t *pr = va_arg (ap, map_main_pre_resolved_t *);
428 if (FIB_NODE_INDEX_INVALID != pr->fei)
432 fib_entry_get_prefix (pr->fei, &pfx);
434 return (format (s, "%U (%u)",
435 format_ip46_address, &pfx.fp_addr, IP46_TYPE_ANY,
436 pr->dpo.dpoi_index));
440 return (format (s, "un-set"));
446 * Function definition to inform the FIB node that its last lock has gone.
449 map_last_lock_gone (fib_node_t * node)
452 * The MAP is a root of the graph. As such
453 * it never has children and thus is never locked.
458 static map_main_pre_resolved_t *
459 map_from_fib_node (fib_node_t * node)
462 ASSERT (FIB_NODE_TYPE_MAP_E == node->fn_type);
464 return ((map_main_pre_resolved_t *)
466 STRUCT_OFFSET_OF (map_main_pre_resolved_t, node)));
470 map_stack (map_main_pre_resolved_t * pr)
474 dpo = fib_entry_contribute_ip_forwarding (pr->fei);
476 dpo_copy (&pr->dpo, dpo);
480 * Function definition to backwalk a FIB node
482 static fib_node_back_walk_rc_t
483 map_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
485 map_stack (map_from_fib_node (node));
487 return (FIB_NODE_BACK_WALK_CONTINUE);
491 * Function definition to get a FIB node from its index
494 map_fib_node_get (fib_node_index_t index)
496 return (&pre_resolved[index].node);
500 * Virtual function table registered by MPLS GRE tunnels
501 * for participation in the FIB object graph.
503 const static fib_node_vft_t map_vft = {
504 .fnv_get = map_fib_node_get,
505 .fnv_last_lock = map_last_lock_gone,
506 .fnv_back_walk = map_back_walk,
510 map_fib_resolve (map_main_pre_resolved_t * pr,
511 fib_protocol_t proto, u8 len, const ip46_address_t * addr)
519 pr->fei = fib_table_entry_special_add (0, // default fib
524 pr->sibling = fib_entry_child_add (pr->fei, FIB_NODE_TYPE_MAP_E, proto);
529 map_fib_unresolve (map_main_pre_resolved_t * pr,
530 fib_protocol_t proto, u8 len, const ip46_address_t * addr)
538 fib_entry_child_remove (pr->fei, pr->sibling);
540 fib_table_entry_special_remove (0, // default fib
541 &pfx, FIB_SOURCE_RR);
542 dpo_reset (&pr->dpo);
544 pr->fei = FIB_NODE_INDEX_INVALID;
545 pr->sibling = FIB_NODE_INDEX_INVALID;
549 map_pre_resolve (ip4_address_t * ip4, ip6_address_t * ip6, int is_del)
551 if (ip6 && (ip6->as_u64[0] != 0 || ip6->as_u64[1] != 0))
553 ip46_address_t addr = {
557 map_fib_unresolve (&pre_resolved[FIB_PROTOCOL_IP6],
558 FIB_PROTOCOL_IP6, 128, &addr);
560 map_fib_resolve (&pre_resolved[FIB_PROTOCOL_IP6],
561 FIB_PROTOCOL_IP6, 128, &addr);
563 if (ip4 && (ip4->as_u32 != 0))
565 ip46_address_t addr = {
569 map_fib_unresolve (&pre_resolved[FIB_PROTOCOL_IP4],
570 FIB_PROTOCOL_IP4, 32, &addr);
572 map_fib_resolve (&pre_resolved[FIB_PROTOCOL_IP4],
573 FIB_PROTOCOL_IP4, 32, &addr);
578 static clib_error_t *
579 map_security_check_command_fn (vlib_main_t * vm,
580 unformat_input_t * input,
581 vlib_cli_command_t * cmd)
583 unformat_input_t _line_input, *line_input = &_line_input;
584 map_main_t *mm = &map_main;
585 clib_error_t *error = NULL;
587 /* Get a line of input. */
588 if (!unformat_user (input, unformat_line_input, line_input))
591 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
593 if (unformat (line_input, "off"))
594 mm->sec_check = false;
595 else if (unformat (line_input, "on"))
596 mm->sec_check = true;
599 error = clib_error_return (0, "unknown input `%U'",
600 format_unformat_error, line_input);
606 unformat_free (line_input);
611 static clib_error_t *
612 map_security_check_frag_command_fn (vlib_main_t * vm,
613 unformat_input_t * input,
614 vlib_cli_command_t * cmd)
616 unformat_input_t _line_input, *line_input = &_line_input;
617 map_main_t *mm = &map_main;
618 clib_error_t *error = NULL;
620 /* Get a line of input. */
621 if (!unformat_user (input, unformat_line_input, line_input))
624 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
626 if (unformat (line_input, "off"))
627 mm->sec_check_frag = false;
628 else if (unformat (line_input, "on"))
629 mm->sec_check_frag = true;
632 error = clib_error_return (0, "unknown input `%U'",
633 format_unformat_error, line_input);
639 unformat_free (line_input);
644 static clib_error_t *
645 map_add_domain_command_fn (vlib_main_t * vm,
646 unformat_input_t * input, vlib_cli_command_t * cmd)
648 unformat_input_t _line_input, *line_input = &_line_input;
649 ip4_address_t ip4_prefix;
650 ip6_address_t ip6_prefix;
651 ip6_address_t ip6_src;
652 u32 ip6_prefix_len = 0, ip4_prefix_len = 0, map_domain_index, ip6_src_len;
654 /* Optional arguments */
655 u32 ea_bits_len = 0, psid_offset = 0, psid_length = 0;
659 clib_error_t *error = NULL;
661 /* Get a line of input. */
662 if (!unformat_user (input, unformat_line_input, line_input))
665 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
668 (line_input, "ip4-pfx %U/%d", unformat_ip4_address, &ip4_prefix,
673 (line_input, "ip6-pfx %U/%d", unformat_ip6_address, &ip6_prefix,
678 (line_input, "ip6-src %U/%d", unformat_ip6_address, &ip6_src,
683 (line_input, "ip6-src %U", unformat_ip6_address, &ip6_src))
685 else if (unformat (line_input, "ea-bits-len %d", &ea_bits_len))
687 else if (unformat (line_input, "psid-offset %d", &psid_offset))
689 else if (unformat (line_input, "psid-len %d", &psid_length))
691 else if (unformat (line_input, "mtu %d", &mtu))
693 else if (unformat (line_input, "map-t"))
694 flags |= MAP_DOMAIN_TRANSLATION;
697 error = clib_error_return (0, "unknown input `%U'",
698 format_unformat_error, line_input);
705 error = clib_error_return (0, "mandatory argument(s) missing");
709 map_create_domain (&ip4_prefix, ip4_prefix_len,
710 &ip6_prefix, ip6_prefix_len, &ip6_src, ip6_src_len,
711 ea_bits_len, psid_offset, psid_length, &map_domain_index,
715 unformat_free (line_input);
720 static clib_error_t *
721 map_del_domain_command_fn (vlib_main_t * vm,
722 unformat_input_t * input, vlib_cli_command_t * cmd)
724 unformat_input_t _line_input, *line_input = &_line_input;
726 u32 map_domain_index;
727 clib_error_t *error = NULL;
729 /* Get a line of input. */
730 if (!unformat_user (input, unformat_line_input, line_input))
733 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
735 if (unformat (line_input, "index %d", &map_domain_index))
739 error = clib_error_return (0, "unknown input `%U'",
740 format_unformat_error, line_input);
747 error = clib_error_return (0, "mandatory argument(s) missing");
751 map_delete_domain (map_domain_index);
754 unformat_free (line_input);
759 static clib_error_t *
760 map_add_rule_command_fn (vlib_main_t * vm,
761 unformat_input_t * input, vlib_cli_command_t * cmd)
763 unformat_input_t _line_input, *line_input = &_line_input;
766 u32 psid = 0, map_domain_index;
767 clib_error_t *error = NULL;
769 /* Get a line of input. */
770 if (!unformat_user (input, unformat_line_input, line_input))
773 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
775 if (unformat (line_input, "index %d", &map_domain_index))
777 else if (unformat (line_input, "psid %d", &psid))
780 if (unformat (line_input, "ip6-dst %U", unformat_ip6_address, &tep))
784 error = clib_error_return (0, "unknown input `%U'",
785 format_unformat_error, line_input);
792 error = clib_error_return (0, "mandatory argument(s) missing");
796 if (map_add_del_psid (map_domain_index, psid, &tep, 1) != 0)
798 error = clib_error_return (0, "Failing to add Mapping Rule");
803 unformat_free (line_input);
808 #if MAP_SKIP_IP6_LOOKUP
809 static clib_error_t *
810 map_pre_resolve_command_fn (vlib_main_t * vm,
811 unformat_input_t * input,
812 vlib_cli_command_t * cmd)
814 unformat_input_t _line_input, *line_input = &_line_input;
815 ip4_address_t ip4nh, *p_v4 = NULL;
816 ip6_address_t ip6nh, *p_v6 = NULL;
817 clib_error_t *error = NULL;
820 memset (&ip4nh, 0, sizeof (ip4nh));
821 memset (&ip6nh, 0, sizeof (ip6nh));
823 /* Get a line of input. */
824 if (!unformat_user (input, unformat_line_input, line_input))
827 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
829 if (unformat (line_input, "ip4-nh %U", unformat_ip4_address, &ip4nh))
832 if (unformat (line_input, "ip6-nh %U", unformat_ip6_address, &ip6nh))
834 else if (unformat (line_input, "del"))
838 error = clib_error_return (0, "unknown input `%U'",
839 format_unformat_error, line_input);
844 map_pre_resolve (p_v4, p_v6, is_del);
847 unformat_free (line_input);
853 static clib_error_t *
854 map_icmp_relay_source_address_command_fn (vlib_main_t * vm,
855 unformat_input_t * input,
856 vlib_cli_command_t * cmd)
858 unformat_input_t _line_input, *line_input = &_line_input;
859 ip4_address_t icmp_src_address;
860 map_main_t *mm = &map_main;
861 clib_error_t *error = NULL;
863 mm->icmp4_src_address.as_u32 = 0;
865 /* Get a line of input. */
866 if (!unformat_user (input, unformat_line_input, line_input))
869 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
872 (line_input, "%U", unformat_ip4_address, &icmp_src_address))
873 mm->icmp4_src_address = icmp_src_address;
876 error = clib_error_return (0, "unknown input `%U'",
877 format_unformat_error, line_input);
883 unformat_free (line_input);
888 static clib_error_t *
889 map_icmp_unreachables_command_fn (vlib_main_t * vm,
890 unformat_input_t * input,
891 vlib_cli_command_t * cmd)
893 unformat_input_t _line_input, *line_input = &_line_input;
894 map_main_t *mm = &map_main;
896 clib_error_t *error = NULL;
898 /* Get a line of input. */
899 if (!unformat_user (input, unformat_line_input, line_input))
902 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
905 if (unformat (line_input, "on"))
906 mm->icmp6_enabled = true;
907 else if (unformat (line_input, "off"))
908 mm->icmp6_enabled = false;
911 error = clib_error_return (0, "unknown input `%U'",
912 format_unformat_error, line_input);
919 error = clib_error_return (0, "mandatory argument(s) missing");
922 unformat_free (line_input);
927 static clib_error_t *
928 map_fragment_command_fn (vlib_main_t * vm,
929 unformat_input_t * input, vlib_cli_command_t * cmd)
931 unformat_input_t _line_input, *line_input = &_line_input;
932 map_main_t *mm = &map_main;
933 clib_error_t *error = NULL;
935 /* Get a line of input. */
936 if (!unformat_user (input, unformat_line_input, line_input))
939 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
941 if (unformat (line_input, "inner"))
942 mm->frag_inner = true;
943 else if (unformat (line_input, "outer"))
944 mm->frag_inner = false;
947 error = clib_error_return (0, "unknown input `%U'",
948 format_unformat_error, line_input);
954 unformat_free (line_input);
959 static clib_error_t *
960 map_fragment_df_command_fn (vlib_main_t * vm,
961 unformat_input_t * input,
962 vlib_cli_command_t * cmd)
964 unformat_input_t _line_input, *line_input = &_line_input;
965 map_main_t *mm = &map_main;
966 clib_error_t *error = NULL;
968 /* Get a line of input. */
969 if (!unformat_user (input, unformat_line_input, line_input))
972 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
974 if (unformat (line_input, "on"))
975 mm->frag_ignore_df = true;
976 else if (unformat (line_input, "off"))
977 mm->frag_ignore_df = false;
980 error = clib_error_return (0, "unknown input `%U'",
981 format_unformat_error, line_input);
987 unformat_free (line_input);
992 static clib_error_t *
993 map_traffic_class_command_fn (vlib_main_t * vm,
994 unformat_input_t * input,
995 vlib_cli_command_t * cmd)
997 unformat_input_t _line_input, *line_input = &_line_input;
998 map_main_t *mm = &map_main;
1000 clib_error_t *error = NULL;
1002 mm->tc_copy = false;
1004 /* Get a line of input. */
1005 if (!unformat_user (input, unformat_line_input, line_input))
1008 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1010 if (unformat (line_input, "copy"))
1012 else if (unformat (line_input, "%x", &tc))
1016 error = clib_error_return (0, "unknown input `%U'",
1017 format_unformat_error, line_input);
1023 unformat_free (line_input);
1029 format_map_domain (u8 * s, va_list * args)
1031 map_domain_t *d = va_arg (*args, map_domain_t *);
1032 bool counters = va_arg (*args, int);
1033 map_main_t *mm = &map_main;
1034 ip6_address_t ip6_prefix;
1037 memset (&ip6_prefix, 0, sizeof (ip6_prefix));
1039 ip6_prefix = d->ip6_prefix;
1042 "[%d] ip4-pfx %U/%d ip6-pfx %U/%d ip6-src %U/%d ea_bits_len %d psid-offset %d psid-len %d mtu %d %s",
1044 format_ip4_address, &d->ip4_prefix, d->ip4_prefix_len,
1045 format_ip6_address, &ip6_prefix, d->ip6_prefix_len,
1046 format_ip6_address, &d->ip6_src, d->ip6_src_len,
1047 d->ea_bits_len, d->psid_offset, d->psid_length, d->mtu,
1048 (d->flags & MAP_DOMAIN_TRANSLATION) ? "map-t" : "");
1052 map_domain_counter_lock (mm);
1054 vlib_get_combined_counter (&mm->domain_counters[MAP_DOMAIN_COUNTER_TX],
1055 d - mm->domains, &v);
1056 s = format (s, " TX: %lld/%lld", v.packets, v.bytes);
1057 vlib_get_combined_counter (&mm->domain_counters[MAP_DOMAIN_COUNTER_RX],
1058 d - mm->domains, &v);
1059 s = format (s, " RX: %lld/%lld", v.packets, v.bytes);
1060 map_domain_counter_unlock (mm);
1062 s = format (s, "\n");
1068 for (i = 0; i < (0x1 << d->psid_length); i++)
1071 if (dst.as_u64[0] == 0 && dst.as_u64[1] == 0)
1074 " rule psid: %d ip6-dst %U\n", i, format_ip6_address,
1082 format_map_ip4_reass (u8 * s, va_list * args)
1084 map_main_t *mm = &map_main;
1085 map_ip4_reass_t *r = va_arg (*args, map_ip4_reass_t *);
1086 map_ip4_reass_key_t *k = &r->key;
1087 f64 now = vlib_time_now (mm->vlib_main);
1088 f64 lifetime = (((f64) mm->ip4_reass_conf_lifetime_ms) / 1000);
1089 f64 dt = (r->ts + lifetime > now) ? (r->ts + lifetime - now) : -1;
1091 "ip4-reass src=%U dst=%U protocol=%d identifier=%d port=%d lifetime=%.3lf\n",
1092 format_ip4_address, &k->src.as_u8, format_ip4_address,
1093 &k->dst.as_u8, k->protocol,
1094 clib_net_to_host_u16 (k->fragment_id),
1095 (r->port >= 0) ? clib_net_to_host_u16 (r->port) : -1, dt);
1100 format_map_ip6_reass (u8 * s, va_list * args)
1102 map_main_t *mm = &map_main;
1103 map_ip6_reass_t *r = va_arg (*args, map_ip6_reass_t *);
1104 map_ip6_reass_key_t *k = &r->key;
1105 f64 now = vlib_time_now (mm->vlib_main);
1106 f64 lifetime = (((f64) mm->ip6_reass_conf_lifetime_ms) / 1000);
1107 f64 dt = (r->ts + lifetime > now) ? (r->ts + lifetime - now) : -1;
1109 "ip6-reass src=%U dst=%U protocol=%d identifier=%d lifetime=%.3lf\n",
1110 format_ip6_address, &k->src.as_u8, format_ip6_address,
1111 &k->dst.as_u8, k->protocol,
1112 clib_net_to_host_u32 (k->fragment_id), dt);
1116 static clib_error_t *
1117 show_map_domain_command_fn (vlib_main_t * vm, unformat_input_t * input,
1118 vlib_cli_command_t * cmd)
1120 unformat_input_t _line_input, *line_input = &_line_input;
1121 map_main_t *mm = &map_main;
1123 bool counters = false;
1124 u32 map_domain_index = ~0;
1125 clib_error_t *error = NULL;
1127 /* Get a line of input. */
1128 if (!unformat_user (input, unformat_line_input, line_input))
1131 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1133 if (unformat (line_input, "counters"))
1135 else if (unformat (line_input, "index %d", &map_domain_index))
1139 error = clib_error_return (0, "unknown input `%U'",
1140 format_unformat_error, line_input);
1145 if (pool_elts (mm->domains) == 0)
1146 vlib_cli_output (vm, "No MAP domains are configured...");
1148 if (map_domain_index == ~0)
1151 pool_foreach(d, mm->domains, ({vlib_cli_output(vm, "%U", format_map_domain, d, counters);}));
1156 if (pool_is_free_index (mm->domains, map_domain_index))
1158 error = clib_error_return (0, "MAP domain does not exists %d",
1163 d = pool_elt_at_index (mm->domains, map_domain_index);
1164 vlib_cli_output (vm, "%U", format_map_domain, d, counters);
1168 unformat_free (line_input);
1173 static clib_error_t *
1174 show_map_fragments_command_fn (vlib_main_t * vm, unformat_input_t * input,
1175 vlib_cli_command_t * cmd)
1177 map_main_t *mm = &map_main;
1178 map_ip4_reass_t *f4;
1179 map_ip6_reass_t *f6;
1182 pool_foreach(f4, mm->ip4_reass_pool, ({vlib_cli_output (vm, "%U", format_map_ip4_reass, f4);}));
1185 pool_foreach(f6, mm->ip6_reass_pool, ({vlib_cli_output (vm, "%U", format_map_ip6_reass, f6);}));
1191 map_error_counter_get (u32 node_index, map_error_t map_error)
1193 vlib_main_t *vm = vlib_get_main ();
1194 vlib_node_runtime_t *error_node = vlib_node_get_runtime (vm, node_index);
1195 vlib_error_main_t *em = &vm->error_main;
1196 vlib_error_t e = error_node->errors[map_error];
1197 vlib_node_t *n = vlib_get_node (vm, node_index);
1200 ci = vlib_error_get_code (e);
1201 ASSERT (ci < n->n_errors);
1202 ci += n->error_heap_index;
1204 return (em->counters[ci]);
1207 static clib_error_t *
1208 show_map_stats_command_fn (vlib_main_t * vm, unformat_input_t * input,
1209 vlib_cli_command_t * cmd)
1211 map_main_t *mm = &map_main;
1213 int domains = 0, rules = 0, domaincount = 0, rulecount = 0;
1214 if (pool_elts (mm->domains) == 0)
1215 vlib_cli_output (vm, "No MAP domains are configured...");
1218 pool_foreach(d, mm->domains, ({
1220 rulecount+= 0x1 << d->psid_length;
1221 rules += sizeof(ip6_address_t) * 0x1 << d->psid_length;
1223 domains += sizeof(*d);
1228 vlib_cli_output (vm, "MAP domains structure: %d\n", sizeof (map_domain_t));
1229 vlib_cli_output (vm, "MAP domains: %d (%d bytes)\n", domaincount, domains);
1230 vlib_cli_output (vm, "MAP rules: %d (%d bytes)\n", rulecount, rules);
1231 vlib_cli_output (vm, "Total: %d bytes)\n", rules + domains);
1233 #if MAP_SKIP_IP6_LOOKUP
1234 vlib_cli_output (vm,
1235 "MAP pre-resolve: IP6 next-hop: %U, IP4 next-hop: %U\n",
1236 format_map_pre_resolve, &pre_resolved[FIB_PROTOCOL_IP6],
1237 format_map_pre_resolve, &pre_resolved[FIB_PROTOCOL_IP4]);
1242 vlib_cli_output (vm, "MAP traffic-class: copy");
1244 vlib_cli_output (vm, "MAP traffic-class: %x", mm->tc);
1246 vlib_cli_output (vm,
1247 "MAP IPv6 inbound security check: %s, fragmented packet security check: %s",
1248 mm->sec_check ? "enabled" : "disabled",
1249 mm->sec_check_frag ? "enabled" : "disabled");
1251 vlib_cli_output (vm, "ICMP-relay IPv4 source address: %U\n",
1252 format_ip4_address, &mm->icmp4_src_address);
1253 vlib_cli_output (vm, "ICMP6 unreachables sent for unmatched packets: %s\n",
1254 mm->icmp6_enabled ? "enabled" : "disabled");
1255 vlib_cli_output (vm, "Inner fragmentation: %s\n",
1256 mm->frag_inner ? "enabled" : "disabled");
1257 vlib_cli_output (vm, "Fragment packets regardless of DF flag: %s\n",
1258 mm->frag_ignore_df ? "enabled" : "disabled");
1263 vlib_combined_counter_main_t *cm = mm->domain_counters;
1264 u64 total_pkts[MAP_N_DOMAIN_COUNTER];
1265 u64 total_bytes[MAP_N_DOMAIN_COUNTER];
1269 memset (total_pkts, 0, sizeof (total_pkts));
1270 memset (total_bytes, 0, sizeof (total_bytes));
1272 map_domain_counter_lock (mm);
1273 vec_foreach (cm, mm->domain_counters)
1275 which = cm - mm->domain_counters;
1277 for (i = 0; i < vlib_combined_counter_n_counters (cm); i++)
1279 vlib_get_combined_counter (cm, i, &v);
1280 total_pkts[which] += v.packets;
1281 total_bytes[which] += v.bytes;
1284 map_domain_counter_unlock (mm);
1286 vlib_cli_output (vm, "Encapsulated packets: %lld bytes: %lld\n",
1287 total_pkts[MAP_DOMAIN_COUNTER_TX],
1288 total_bytes[MAP_DOMAIN_COUNTER_TX]);
1289 vlib_cli_output (vm, "Decapsulated packets: %lld bytes: %lld\n",
1290 total_pkts[MAP_DOMAIN_COUNTER_RX],
1291 total_bytes[MAP_DOMAIN_COUNTER_RX]);
1293 vlib_cli_output (vm, "ICMP relayed packets: %d\n",
1294 vlib_get_simple_counter (&mm->icmp_relayed, 0));
1299 static clib_error_t *
1300 map_params_reass_command_fn (vlib_main_t * vm, unformat_input_t * input,
1301 vlib_cli_command_t * cmd)
1303 unformat_input_t _line_input, *line_input = &_line_input;
1305 f64 ht_ratio = (MAP_IP4_REASS_CONF_HT_RATIO_MAX + 1);
1307 u64 buffers = ~(0ull);
1308 u8 ip4 = 0, ip6 = 0;
1310 if (!unformat_user (input, unformat_line_input, line_input))
1313 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1315 if (unformat (line_input, "lifetime %u", &lifetime))
1317 else if (unformat (line_input, "ht-ratio %lf", &ht_ratio))
1319 else if (unformat (line_input, "pool-size %u", &pool_size))
1321 else if (unformat (line_input, "buffers %llu", &buffers))
1323 else if (unformat (line_input, "ip4"))
1325 else if (unformat (line_input, "ip6"))
1329 unformat_free (line_input);
1330 return clib_error_return (0, "invalid input");
1333 unformat_free (line_input);
1336 return clib_error_return (0, "must specify ip4 and/or ip6");
1340 if (pool_size != ~0 && pool_size > MAP_IP4_REASS_CONF_POOL_SIZE_MAX)
1341 return clib_error_return (0, "invalid ip4-reass pool-size ( > %d)",
1342 MAP_IP4_REASS_CONF_POOL_SIZE_MAX);
1343 if (ht_ratio != (MAP_IP4_REASS_CONF_HT_RATIO_MAX + 1)
1344 && ht_ratio > MAP_IP4_REASS_CONF_HT_RATIO_MAX)
1345 return clib_error_return (0, "invalid ip4-reass ht-ratio ( > %d)",
1346 MAP_IP4_REASS_CONF_HT_RATIO_MAX);
1347 if (lifetime != ~0 && lifetime > MAP_IP4_REASS_CONF_LIFETIME_MAX)
1348 return clib_error_return (0, "invalid ip4-reass lifetime ( > %d)",
1349 MAP_IP4_REASS_CONF_LIFETIME_MAX);
1350 if (buffers != ~(0ull) && buffers > MAP_IP4_REASS_CONF_BUFFERS_MAX)
1351 return clib_error_return (0, "invalid ip4-reass buffers ( > %ld)",
1352 MAP_IP4_REASS_CONF_BUFFERS_MAX);
1357 if (pool_size != ~0 && pool_size > MAP_IP6_REASS_CONF_POOL_SIZE_MAX)
1358 return clib_error_return (0, "invalid ip6-reass pool-size ( > %d)",
1359 MAP_IP6_REASS_CONF_POOL_SIZE_MAX);
1360 if (ht_ratio != (MAP_IP4_REASS_CONF_HT_RATIO_MAX + 1)
1361 && ht_ratio > MAP_IP6_REASS_CONF_HT_RATIO_MAX)
1362 return clib_error_return (0, "invalid ip6-reass ht-log2len ( > %d)",
1363 MAP_IP6_REASS_CONF_HT_RATIO_MAX);
1364 if (lifetime != ~0 && lifetime > MAP_IP6_REASS_CONF_LIFETIME_MAX)
1365 return clib_error_return (0, "invalid ip6-reass lifetime ( > %d)",
1366 MAP_IP6_REASS_CONF_LIFETIME_MAX);
1367 if (buffers != ~(0ull) && buffers > MAP_IP6_REASS_CONF_BUFFERS_MAX)
1368 return clib_error_return (0, "invalid ip6-reass buffers ( > %ld)",
1369 MAP_IP6_REASS_CONF_BUFFERS_MAX);
1374 u32 reass = 0, packets = 0;
1375 if (pool_size != ~0)
1377 if (map_ip4_reass_conf_pool_size (pool_size, &reass, &packets))
1379 vlib_cli_output (vm, "Could not set ip4-reass pool-size");
1383 vlib_cli_output (vm,
1384 "Setting ip4-reass pool-size (destroyed-reassembly=%u , dropped-fragments=%u)",
1388 if (ht_ratio != (MAP_IP4_REASS_CONF_HT_RATIO_MAX + 1))
1390 if (map_ip4_reass_conf_ht_ratio (ht_ratio, &reass, &packets))
1392 vlib_cli_output (vm, "Could not set ip4-reass ht-log2len");
1396 vlib_cli_output (vm,
1397 "Setting ip4-reass ht-log2len (destroyed-reassembly=%u , dropped-fragments=%u)",
1403 if (map_ip4_reass_conf_lifetime (lifetime))
1404 vlib_cli_output (vm, "Could not set ip4-reass lifetime");
1406 vlib_cli_output (vm, "Setting ip4-reass lifetime");
1408 if (buffers != ~(0ull))
1410 if (map_ip4_reass_conf_buffers (buffers))
1411 vlib_cli_output (vm, "Could not set ip4-reass buffers");
1413 vlib_cli_output (vm, "Setting ip4-reass buffers");
1416 if (map_main.ip4_reass_conf_buffers >
1417 map_main.ip4_reass_conf_pool_size *
1418 MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY)
1420 vlib_cli_output (vm,
1421 "Note: 'ip4-reass buffers' > pool-size * max-fragments-per-reassembly.");
1427 u32 reass = 0, packets = 0;
1428 if (pool_size != ~0)
1430 if (map_ip6_reass_conf_pool_size (pool_size, &reass, &packets))
1432 vlib_cli_output (vm, "Could not set ip6-reass pool-size");
1436 vlib_cli_output (vm,
1437 "Setting ip6-reass pool-size (destroyed-reassembly=%u , dropped-fragments=%u)",
1441 if (ht_ratio != (MAP_IP4_REASS_CONF_HT_RATIO_MAX + 1))
1443 if (map_ip6_reass_conf_ht_ratio (ht_ratio, &reass, &packets))
1445 vlib_cli_output (vm, "Could not set ip6-reass ht-log2len");
1449 vlib_cli_output (vm,
1450 "Setting ip6-reass ht-log2len (destroyed-reassembly=%u , dropped-fragments=%u)",
1456 if (map_ip6_reass_conf_lifetime (lifetime))
1457 vlib_cli_output (vm, "Could not set ip6-reass lifetime");
1459 vlib_cli_output (vm, "Setting ip6-reass lifetime");
1461 if (buffers != ~(0ull))
1463 if (map_ip6_reass_conf_buffers (buffers))
1464 vlib_cli_output (vm, "Could not set ip6-reass buffers");
1466 vlib_cli_output (vm, "Setting ip6-reass buffers");
1469 if (map_main.ip6_reass_conf_buffers >
1470 map_main.ip6_reass_conf_pool_size *
1471 MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY)
1473 vlib_cli_output (vm,
1474 "Note: 'ip6-reass buffers' > pool-size * max-fragments-per-reassembly.");
1483 * packet trace format function
1486 format_map_trace (u8 * s, va_list * args)
1488 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
1489 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
1490 map_trace_t *t = va_arg (*args, map_trace_t *);
1491 u32 map_domain_index = t->map_domain_index;
1495 format (s, "MAP domain index: %d L4 port: %u", map_domain_index,
1496 clib_net_to_host_u16 (port));
1501 static_always_inline map_ip4_reass_t *
1502 map_ip4_reass_lookup (map_ip4_reass_key_t * k, u32 bucket, f64 now)
1504 map_main_t *mm = &map_main;
1505 u32 ri = mm->ip4_reass_hash_table[bucket];
1506 while (ri != MAP_REASS_INDEX_NONE)
1508 map_ip4_reass_t *r = pool_elt_at_index (mm->ip4_reass_pool, ri);
1509 if (r->key.as_u64[0] == k->as_u64[0] &&
1510 r->key.as_u64[1] == k->as_u64[1] &&
1511 now < r->ts + (((f64) mm->ip4_reass_conf_lifetime_ms) / 1000))
1515 ri = r->bucket_next;
1520 #define map_ip4_reass_pool_index(r) (r - map_main.ip4_reass_pool)
1523 map_ip4_reass_free (map_ip4_reass_t * r, u32 ** pi_to_drop)
1525 map_main_t *mm = &map_main;
1526 map_ip4_reass_get_fragments (r, pi_to_drop);
1528 // Unlink in hash bucket
1529 map_ip4_reass_t *r2 = NULL;
1530 u32 r2i = mm->ip4_reass_hash_table[r->bucket];
1531 while (r2i != map_ip4_reass_pool_index (r))
1533 ASSERT (r2i != MAP_REASS_INDEX_NONE);
1534 r2 = pool_elt_at_index (mm->ip4_reass_pool, r2i);
1535 r2i = r2->bucket_next;
1539 r2->bucket_next = r->bucket_next;
1543 mm->ip4_reass_hash_table[r->bucket] = r->bucket_next;
1547 if (r->fifo_next == map_ip4_reass_pool_index (r))
1549 mm->ip4_reass_fifo_last = MAP_REASS_INDEX_NONE;
1553 if (mm->ip4_reass_fifo_last == map_ip4_reass_pool_index (r))
1554 mm->ip4_reass_fifo_last = r->fifo_prev;
1555 pool_elt_at_index (mm->ip4_reass_pool, r->fifo_prev)->fifo_next =
1557 pool_elt_at_index (mm->ip4_reass_pool, r->fifo_next)->fifo_prev =
1561 pool_put (mm->ip4_reass_pool, r);
1562 mm->ip4_reass_allocated--;
1566 map_ip4_reass_get (u32 src, u32 dst, u16 fragment_id,
1567 u8 protocol, u32 ** pi_to_drop)
1570 map_main_t *mm = &map_main;
1571 map_ip4_reass_key_t k = {.src.data_u32 = src,
1572 .dst.data_u32 = dst,
1573 .fragment_id = fragment_id,
1574 .protocol = protocol
1578 h = crc_u32 (k.as_u32[0], h);
1579 h = crc_u32 (k.as_u32[1], h);
1580 h = crc_u32 (k.as_u32[2], h);
1581 h = crc_u32 (k.as_u32[3], h);
1582 h = h >> (32 - mm->ip4_reass_ht_log2len);
1584 f64 now = vlib_time_now (mm->vlib_main);
1586 //Cache garbage collection
1587 while (mm->ip4_reass_fifo_last != MAP_REASS_INDEX_NONE)
1589 map_ip4_reass_t *last =
1590 pool_elt_at_index (mm->ip4_reass_pool, mm->ip4_reass_fifo_last);
1591 if (last->ts + (((f64) mm->ip4_reass_conf_lifetime_ms) / 1000) < now)
1592 map_ip4_reass_free (last, pi_to_drop);
1597 if ((r = map_ip4_reass_lookup (&k, h, now)))
1600 if (mm->ip4_reass_allocated >= mm->ip4_reass_conf_pool_size)
1603 pool_get (mm->ip4_reass_pool, r);
1604 mm->ip4_reass_allocated++;
1606 for (i = 0; i < MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
1607 r->fragments[i] = ~0;
1609 u32 ri = map_ip4_reass_pool_index (r);
1611 //Link in new bucket
1613 r->bucket_next = mm->ip4_reass_hash_table[h];
1614 mm->ip4_reass_hash_table[h] = ri;
1617 if (mm->ip4_reass_fifo_last != MAP_REASS_INDEX_NONE)
1620 pool_elt_at_index (mm->ip4_reass_pool,
1621 mm->ip4_reass_fifo_last)->fifo_next;
1622 r->fifo_prev = mm->ip4_reass_fifo_last;
1623 pool_elt_at_index (mm->ip4_reass_pool, r->fifo_prev)->fifo_next = ri;
1624 pool_elt_at_index (mm->ip4_reass_pool, r->fifo_next)->fifo_prev = ri;
1628 r->fifo_next = r->fifo_prev = ri;
1629 mm->ip4_reass_fifo_last = ri;
1636 #ifdef MAP_IP4_REASS_COUNT_BYTES
1637 r->expected_total = 0xffff;
1645 map_ip4_reass_add_fragment (map_ip4_reass_t * r, u32 pi)
1647 if (map_main.ip4_reass_buffered_counter >= map_main.ip4_reass_conf_buffers)
1651 for (i = 0; i < MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
1652 if (r->fragments[i] == ~0)
1654 r->fragments[i] = pi;
1655 map_main.ip4_reass_buffered_counter++;
1661 static_always_inline map_ip6_reass_t *
1662 map_ip6_reass_lookup (map_ip6_reass_key_t * k, u32 bucket, f64 now)
1664 map_main_t *mm = &map_main;
1665 u32 ri = mm->ip6_reass_hash_table[bucket];
1666 while (ri != MAP_REASS_INDEX_NONE)
1668 map_ip6_reass_t *r = pool_elt_at_index (mm->ip6_reass_pool, ri);
1669 if (now < r->ts + (((f64) mm->ip6_reass_conf_lifetime_ms) / 1000) &&
1670 r->key.as_u64[0] == k->as_u64[0] &&
1671 r->key.as_u64[1] == k->as_u64[1] &&
1672 r->key.as_u64[2] == k->as_u64[2] &&
1673 r->key.as_u64[3] == k->as_u64[3] &&
1674 r->key.as_u64[4] == k->as_u64[4])
1676 ri = r->bucket_next;
1681 #define map_ip6_reass_pool_index(r) (r - map_main.ip6_reass_pool)
1684 map_ip6_reass_free (map_ip6_reass_t * r, u32 ** pi_to_drop)
1686 map_main_t *mm = &map_main;
1688 for (i = 0; i < MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
1689 if (r->fragments[i].pi != ~0)
1691 vec_add1 (*pi_to_drop, r->fragments[i].pi);
1692 r->fragments[i].pi = ~0;
1693 map_main.ip6_reass_buffered_counter--;
1696 // Unlink in hash bucket
1697 map_ip6_reass_t *r2 = NULL;
1698 u32 r2i = mm->ip6_reass_hash_table[r->bucket];
1699 while (r2i != map_ip6_reass_pool_index (r))
1701 ASSERT (r2i != MAP_REASS_INDEX_NONE);
1702 r2 = pool_elt_at_index (mm->ip6_reass_pool, r2i);
1703 r2i = r2->bucket_next;
1707 r2->bucket_next = r->bucket_next;
1711 mm->ip6_reass_hash_table[r->bucket] = r->bucket_next;
1715 if (r->fifo_next == map_ip6_reass_pool_index (r))
1717 //Single element in the list, list is now empty
1718 mm->ip6_reass_fifo_last = MAP_REASS_INDEX_NONE;
1722 if (mm->ip6_reass_fifo_last == map_ip6_reass_pool_index (r)) //First element
1723 mm->ip6_reass_fifo_last = r->fifo_prev;
1724 pool_elt_at_index (mm->ip6_reass_pool, r->fifo_prev)->fifo_next =
1726 pool_elt_at_index (mm->ip6_reass_pool, r->fifo_next)->fifo_prev =
1730 // Free from pool if necessary
1731 pool_put (mm->ip6_reass_pool, r);
1732 mm->ip6_reass_allocated--;
1736 map_ip6_reass_get (ip6_address_t * src, ip6_address_t * dst, u32 fragment_id,
1737 u8 protocol, u32 ** pi_to_drop)
1740 map_main_t *mm = &map_main;
1741 map_ip6_reass_key_t k = {
1744 .fragment_id = fragment_id,
1745 .protocol = protocol
1750 for (i = 0; i < 10; i++)
1751 h = crc_u32 (k.as_u32[i], h);
1752 h = h >> (32 - mm->ip6_reass_ht_log2len);
1754 f64 now = vlib_time_now (mm->vlib_main);
1756 //Cache garbage collection
1757 while (mm->ip6_reass_fifo_last != MAP_REASS_INDEX_NONE)
1759 map_ip6_reass_t *last =
1760 pool_elt_at_index (mm->ip6_reass_pool, mm->ip6_reass_fifo_last);
1761 if (last->ts + (((f64) mm->ip6_reass_conf_lifetime_ms) / 1000) < now)
1762 map_ip6_reass_free (last, pi_to_drop);
1767 if ((r = map_ip6_reass_lookup (&k, h, now)))
1770 if (mm->ip6_reass_allocated >= mm->ip6_reass_conf_pool_size)
1773 pool_get (mm->ip6_reass_pool, r);
1774 mm->ip6_reass_allocated++;
1775 for (i = 0; i < MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
1777 r->fragments[i].pi = ~0;
1778 r->fragments[i].next_data_len = 0;
1779 r->fragments[i].next_data_offset = 0;
1782 u32 ri = map_ip6_reass_pool_index (r);
1784 //Link in new bucket
1786 r->bucket_next = mm->ip6_reass_hash_table[h];
1787 mm->ip6_reass_hash_table[h] = ri;
1790 if (mm->ip6_reass_fifo_last != MAP_REASS_INDEX_NONE)
1793 pool_elt_at_index (mm->ip6_reass_pool,
1794 mm->ip6_reass_fifo_last)->fifo_next;
1795 r->fifo_prev = mm->ip6_reass_fifo_last;
1796 pool_elt_at_index (mm->ip6_reass_pool, r->fifo_prev)->fifo_next = ri;
1797 pool_elt_at_index (mm->ip6_reass_pool, r->fifo_next)->fifo_prev = ri;
1801 r->fifo_next = r->fifo_prev = ri;
1802 mm->ip6_reass_fifo_last = ri;
1808 r->ip4_header.ip_version_and_header_length = 0;
1809 #ifdef MAP_IP6_REASS_COUNT_BYTES
1810 r->expected_total = 0xffff;
1817 map_ip6_reass_add_fragment (map_ip6_reass_t * r, u32 pi,
1818 u16 data_offset, u16 next_data_offset,
1819 u8 * data_start, u16 data_len)
1821 map_ip6_fragment_t *f = NULL, *prev_f = NULL;
1822 u16 copied_len = (data_len > 20) ? 20 : data_len;
1824 if (map_main.ip6_reass_buffered_counter >= map_main.ip6_reass_conf_buffers)
1827 //Lookup for fragments for the current buffer
1828 //and the one before that
1830 for (i = 0; i < MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
1832 if (data_offset && r->fragments[i].next_data_offset == data_offset)
1834 prev_f = &r->fragments[i]; // This is buffer for previous packet
1836 else if (r->fragments[i].next_data_offset == next_data_offset)
1838 f = &r->fragments[i]; // This is a buffer for the current packet
1840 else if (r->fragments[i].next_data_offset == 0)
1843 f = &r->fragments[i];
1844 else if (prev_f == NULL)
1845 prev_f = &r->fragments[i];
1849 if (!f || f->pi != ~0)
1857 clib_memcpy (prev_f->next_data, data_start, copied_len);
1858 prev_f->next_data_len = copied_len;
1859 prev_f->next_data_offset = data_offset;
1863 if (((ip4_header_t *) data_start)->ip_version_and_header_length != 0x45)
1866 if (r->ip4_header.ip_version_and_header_length == 0)
1867 clib_memcpy (&r->ip4_header, data_start, sizeof (ip4_header_t));
1872 f->next_data_offset = next_data_offset;
1874 map_main.ip6_reass_buffered_counter++;
1880 map_ip4_reass_reinit (u32 * trashed_reass, u32 * dropped_packets)
1882 map_main_t *mm = &map_main;
1885 if (dropped_packets)
1886 *dropped_packets = mm->ip4_reass_buffered_counter;
1888 *trashed_reass = mm->ip4_reass_allocated;
1889 if (mm->ip4_reass_fifo_last != MAP_REASS_INDEX_NONE)
1891 u16 ri = mm->ip4_reass_fifo_last;
1894 map_ip4_reass_t *r = pool_elt_at_index (mm->ip4_reass_pool, ri);
1895 for (i = 0; i < MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
1896 if (r->fragments[i] != ~0)
1897 map_ip4_drop_pi (r->fragments[i]);
1900 pool_put (mm->ip4_reass_pool, r);
1902 while (ri != mm->ip4_reass_fifo_last);
1905 vec_free (mm->ip4_reass_hash_table);
1906 vec_resize (mm->ip4_reass_hash_table, 1 << mm->ip4_reass_ht_log2len);
1907 for (i = 0; i < (1 << mm->ip4_reass_ht_log2len); i++)
1908 mm->ip4_reass_hash_table[i] = MAP_REASS_INDEX_NONE;
1909 pool_free (mm->ip4_reass_pool);
1910 pool_alloc (mm->ip4_reass_pool, mm->ip4_reass_conf_pool_size);
1912 mm->ip4_reass_allocated = 0;
1913 mm->ip4_reass_fifo_last = MAP_REASS_INDEX_NONE;
1914 mm->ip4_reass_buffered_counter = 0;
1918 map_get_ht_log2len (f32 ht_ratio, u16 pool_size)
1920 u32 desired_size = (u32) (pool_size * ht_ratio);
1922 for (i = 1; i < 31; i++)
1923 if ((1 << i) >= desired_size)
1929 map_ip4_reass_conf_ht_ratio (f32 ht_ratio, u32 * trashed_reass,
1930 u32 * dropped_packets)
1932 map_main_t *mm = &map_main;
1933 if (ht_ratio > MAP_IP4_REASS_CONF_HT_RATIO_MAX)
1936 map_ip4_reass_lock ();
1937 mm->ip4_reass_conf_ht_ratio = ht_ratio;
1938 mm->ip4_reass_ht_log2len =
1939 map_get_ht_log2len (ht_ratio, mm->ip4_reass_conf_pool_size);
1940 map_ip4_reass_reinit (trashed_reass, dropped_packets);
1941 map_ip4_reass_unlock ();
1946 map_ip4_reass_conf_pool_size (u16 pool_size, u32 * trashed_reass,
1947 u32 * dropped_packets)
1949 map_main_t *mm = &map_main;
1950 if (pool_size > MAP_IP4_REASS_CONF_POOL_SIZE_MAX)
1953 map_ip4_reass_lock ();
1954 mm->ip4_reass_conf_pool_size = pool_size;
1955 map_ip4_reass_reinit (trashed_reass, dropped_packets);
1956 map_ip4_reass_unlock ();
1961 map_ip4_reass_conf_lifetime (u16 lifetime_ms)
1963 map_main.ip4_reass_conf_lifetime_ms = lifetime_ms;
1968 map_ip4_reass_conf_buffers (u32 buffers)
1970 map_main.ip4_reass_conf_buffers = buffers;
1975 map_ip6_reass_reinit (u32 * trashed_reass, u32 * dropped_packets)
1977 map_main_t *mm = &map_main;
1978 if (dropped_packets)
1979 *dropped_packets = mm->ip6_reass_buffered_counter;
1981 *trashed_reass = mm->ip6_reass_allocated;
1983 if (mm->ip6_reass_fifo_last != MAP_REASS_INDEX_NONE)
1985 u16 ri = mm->ip6_reass_fifo_last;
1988 map_ip6_reass_t *r = pool_elt_at_index (mm->ip6_reass_pool, ri);
1989 for (i = 0; i < MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
1990 if (r->fragments[i].pi != ~0)
1991 map_ip6_drop_pi (r->fragments[i].pi);
1994 pool_put (mm->ip6_reass_pool, r);
1996 while (ri != mm->ip6_reass_fifo_last);
1997 mm->ip6_reass_fifo_last = MAP_REASS_INDEX_NONE;
2000 vec_free (mm->ip6_reass_hash_table);
2001 vec_resize (mm->ip6_reass_hash_table, 1 << mm->ip6_reass_ht_log2len);
2002 for (i = 0; i < (1 << mm->ip6_reass_ht_log2len); i++)
2003 mm->ip6_reass_hash_table[i] = MAP_REASS_INDEX_NONE;
2004 pool_free (mm->ip6_reass_pool);
2005 pool_alloc (mm->ip6_reass_pool, mm->ip4_reass_conf_pool_size);
2007 mm->ip6_reass_allocated = 0;
2008 mm->ip6_reass_buffered_counter = 0;
2012 map_ip6_reass_conf_ht_ratio (f32 ht_ratio, u32 * trashed_reass,
2013 u32 * dropped_packets)
2015 map_main_t *mm = &map_main;
2016 if (ht_ratio > MAP_IP6_REASS_CONF_HT_RATIO_MAX)
2019 map_ip6_reass_lock ();
2020 mm->ip6_reass_conf_ht_ratio = ht_ratio;
2021 mm->ip6_reass_ht_log2len =
2022 map_get_ht_log2len (ht_ratio, mm->ip6_reass_conf_pool_size);
2023 map_ip6_reass_reinit (trashed_reass, dropped_packets);
2024 map_ip6_reass_unlock ();
2029 map_ip6_reass_conf_pool_size (u16 pool_size, u32 * trashed_reass,
2030 u32 * dropped_packets)
2032 map_main_t *mm = &map_main;
2033 if (pool_size > MAP_IP6_REASS_CONF_POOL_SIZE_MAX)
2036 map_ip6_reass_lock ();
2037 mm->ip6_reass_conf_pool_size = pool_size;
2038 map_ip6_reass_reinit (trashed_reass, dropped_packets);
2039 map_ip6_reass_unlock ();
2044 map_ip6_reass_conf_lifetime (u16 lifetime_ms)
2046 map_main.ip6_reass_conf_lifetime_ms = lifetime_ms;
2051 map_ip6_reass_conf_buffers (u32 buffers)
2053 map_main.ip6_reass_conf_buffers = buffers;
2060 * Configure MAP reassembly behaviour
2063 * @cliexstart{map params reassembly}
2066 VLIB_CLI_COMMAND(map_ip4_reass_lifetime_command, static) = {
2067 .path = "map params reassembly",
2068 .short_help = "map params reassembly [ip4 | ip6] [lifetime <lifetime-ms>] "
2069 "[pool-size <pool-size>] [buffers <buffers>] "
2070 "[ht-ratio <ht-ratio>]",
2071 .function = map_params_reass_command_fn,
2075 * Set or copy the IP TOS/Traffic Class field
2078 * @cliexstart{map params traffic-class}
2080 * This command is used to set the traffic-class field in translated
2081 * or encapsulated packets. If copy is specifed (the default) then the
2082 * traffic-class/TOS field is copied from the original packet to the
2083 * translated / encapsulating header.
2086 VLIB_CLI_COMMAND(map_traffic_class_command, static) = {
2087 .path = "map params traffic-class",
2088 .short_help = "map params traffic-class {0x0-0xff | copy}",
2089 .function = map_traffic_class_command_fn,
2093 * Bypass IP4/IP6 lookup
2096 * @cliexstart{map params pre-resolve}
2098 * Bypass a second FIB lookup of the translated or encapsulated
2099 * packet, and forward the packet directly to the specified
2100 * next-hop. This optimization trades forwarding flexibility for
2104 VLIB_CLI_COMMAND(map_pre_resolve_command, static) = {
2105 .path = "map params pre-resolve",
2106 .short_help = " map params pre-resolve {ip4-nh <address>} "
2107 "| {ip6-nh <address>}",
2108 .function = map_pre_resolve_command_fn,
2112 * Enable or disable the MAP-E inbound security check
2115 * @cliexstart{map params security-check}
2117 * By default, a decapsulated packet's IPv4 source address will be
2118 * verified against the outer header's IPv6 source address. Disabling
2119 * this feature will allow IPv4 source address spoofing.
2122 VLIB_CLI_COMMAND(map_security_check_command, static) = {
2123 .path = "map params security-check",
2124 .short_help = "map params security-check on|off",
2125 .function = map_security_check_command_fn,
2129 * Specifiy the IPv4 source address used for relayed ICMP error messages
2132 * @cliexstart{map params icmp source-address}
2134 * This command specifies which IPv4 source address (must be local to
2135 * the system), that is used for relayed received IPv6 ICMP error
2139 VLIB_CLI_COMMAND(map_icmp_relay_source_address_command, static) = {
2140 .path = "map params icmp source-address",
2141 .short_help = "map params icmp source-address <ip4-address>",
2142 .function = map_icmp_relay_source_address_command_fn,
2146 * Send IPv6 ICMP unreachables
2149 * @cliexstart{map params icmp6 unreachables}
2151 * Send IPv6 ICMP unreachable messages back if security check fails or
2152 * no MAP domain exists.
2155 VLIB_CLI_COMMAND(map_icmp_unreachables_command, static) = {
2156 .path = "map params icmp6 unreachables",
2157 .short_help = "map params icmp6 unreachables {on|off}",
2158 .function = map_icmp_unreachables_command_fn,
2162 * Configure MAP fragmentation behaviour
2165 * @cliexstart{map params fragment}
2168 VLIB_CLI_COMMAND(map_fragment_command, static) = {
2169 .path = "map params fragment",
2170 .short_help = "map params fragment inner|outer",
2171 .function = map_fragment_command_fn,
2175 * Ignore the IPv4 Don't fragment bit
2178 * @cliexstart{map params fragment ignore-df}
2180 * Allows fragmentation of the IPv4 packet even if the DF bit is
2181 * set. The choice between inner or outer fragmentation of tunnel
2182 * packets is complicated. The benefit of inner fragmentation is that
2183 * the ultimate endpoint must reassemble, instead of the tunnel
2187 VLIB_CLI_COMMAND(map_fragment_df_command, static) = {
2188 .path = "map params fragment ignore-df",
2189 .short_help = "map params fragment ignore-df on|off",
2190 .function = map_fragment_df_command_fn,
2194 * Specifiy if the inbound security check should be done on fragments
2197 * @cliexstart{map params security-check fragments}
2199 * Typically the inbound on-decapsulation security check is only done
2200 * on the first packet. The packet that contains the L4
2201 * information. While a security check on every fragment is possible,
2202 * it has a cost. State must be created on the first fragment.
2205 VLIB_CLI_COMMAND(map_security_check_frag_command, static) = {
2206 .path = "map params security-check fragments",
2207 .short_help = "map params security-check fragments on|off",
2208 .function = map_security_check_frag_command_fn,
2215 * @cliexstart{map add domain}
2218 VLIB_CLI_COMMAND(map_add_domain_command, static) = {
2219 .path = "map add domain",
2220 .short_help = "map add domain ip4-pfx <ip4-pfx> ip6-pfx <ip6-pfx> "
2221 "ip6-src <ip6-pfx> ea-bits-len <n> psid-offset <n> psid-len <n> "
2222 "[map-t] [mtu <mtu>]",
2223 .function = map_add_domain_command_fn,
2227 * Add MAP rule to a domain
2230 * @cliexstart{map add rule}
2233 VLIB_CLI_COMMAND(map_add_rule_command, static) = {
2234 .path = "map add rule",
2235 .short_help = "map add rule index <domain> psid <psid> ip6-dst <ip6-addr>",
2236 .function = map_add_rule_command_fn,
2243 * @cliexstart{map del domain}
2246 VLIB_CLI_COMMAND(map_del_command, static) = {
2247 .path = "map del domain",
2248 .short_help = "map del domain index <domain>",
2249 .function = map_del_domain_command_fn,
2256 * @cliexstart{show map domain}
2259 VLIB_CLI_COMMAND(show_map_domain_command, static) = {
2260 .path = "show map domain",
2261 .short_help = "show map domain index <n> [counters]",
2262 .function = show_map_domain_command_fn,
2266 * Show MAP statistics
2269 * @cliexstart{show map stats}
2272 VLIB_CLI_COMMAND(show_map_stats_command, static) = {
2273 .path = "show map stats",
2274 .short_help = "show map stats",
2275 .function = show_map_stats_command_fn,
2279 * Show MAP fragmentation information
2282 * @cliexstart{show map fragments}
2285 VLIB_CLI_COMMAND(show_map_fragments_command, static) = {
2286 .path = "show map fragments",
2287 .short_help = "show map fragments",
2288 .function = show_map_fragments_command_fn,
2296 map_init (vlib_main_t * vm)
2298 map_main_t *mm = &map_main;
2299 mm->vnet_main = vnet_get_main ();
2302 #ifdef MAP_SKIP_IP6_LOOKUP
2303 fib_protocol_t proto;
2305 FOR_EACH_FIB_PROTOCOL (proto)
2307 map_pre_resolve_init (&pre_resolved[proto]);
2315 /* Inbound security check */
2316 mm->sec_check = true;
2317 mm->sec_check_frag = false;
2319 /* ICMP6 Type 1, Code 5 for security check failure */
2320 mm->icmp6_enabled = false;
2322 /* Inner or outer fragmentation */
2323 mm->frag_inner = false;
2324 mm->frag_ignore_df = false;
2326 vec_validate (mm->domain_counters, MAP_N_DOMAIN_COUNTER - 1);
2327 mm->domain_counters[MAP_DOMAIN_COUNTER_RX].name = "rx";
2328 mm->domain_counters[MAP_DOMAIN_COUNTER_TX].name = "tx";
2330 vlib_validate_simple_counter (&mm->icmp_relayed, 0);
2331 vlib_zero_simple_counter (&mm->icmp_relayed, 0);
2333 /* IP4 virtual reassembly */
2334 mm->ip4_reass_hash_table = 0;
2335 mm->ip4_reass_pool = 0;
2336 mm->ip4_reass_lock =
2337 clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES, CLIB_CACHE_LINE_BYTES);
2338 mm->ip4_reass_conf_ht_ratio = MAP_IP4_REASS_HT_RATIO_DEFAULT;
2339 mm->ip4_reass_conf_lifetime_ms = MAP_IP4_REASS_LIFETIME_DEFAULT;
2340 mm->ip4_reass_conf_pool_size = MAP_IP4_REASS_POOL_SIZE_DEFAULT;
2341 mm->ip4_reass_conf_buffers = MAP_IP4_REASS_BUFFERS_DEFAULT;
2342 mm->ip4_reass_ht_log2len =
2343 map_get_ht_log2len (mm->ip4_reass_conf_ht_ratio,
2344 mm->ip4_reass_conf_pool_size);
2345 mm->ip4_reass_fifo_last = MAP_REASS_INDEX_NONE;
2346 map_ip4_reass_reinit (NULL, NULL);
2348 /* IP6 virtual reassembly */
2349 mm->ip6_reass_hash_table = 0;
2350 mm->ip6_reass_pool = 0;
2351 mm->ip6_reass_lock =
2352 clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES, CLIB_CACHE_LINE_BYTES);
2353 mm->ip6_reass_conf_ht_ratio = MAP_IP6_REASS_HT_RATIO_DEFAULT;
2354 mm->ip6_reass_conf_lifetime_ms = MAP_IP6_REASS_LIFETIME_DEFAULT;
2355 mm->ip6_reass_conf_pool_size = MAP_IP6_REASS_POOL_SIZE_DEFAULT;
2356 mm->ip6_reass_conf_buffers = MAP_IP6_REASS_BUFFERS_DEFAULT;
2357 mm->ip6_reass_ht_log2len =
2358 map_get_ht_log2len (mm->ip6_reass_conf_ht_ratio,
2359 mm->ip6_reass_conf_pool_size);
2360 mm->ip6_reass_fifo_last = MAP_REASS_INDEX_NONE;
2361 map_ip6_reass_reinit (NULL, NULL);
2363 #ifdef MAP_SKIP_IP6_LOOKUP
2364 fib_node_register_type (FIB_NODE_TYPE_MAP_E, &map_vft);
2366 map_dpo_module_init ();
2371 VLIB_INIT_FUNCTION (map_init);
2374 * fd.io coding-style-patch-verification: ON
2377 * eval: (c-set-style "gnu")