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
521 FIB_SOURCE_RR, FIB_ENTRY_FLAG_NONE);
522 pr->sibling = fib_entry_child_add (pr->fei, FIB_NODE_TYPE_MAP_E, proto);
527 map_fib_unresolve (map_main_pre_resolved_t * pr,
528 fib_protocol_t proto, u8 len, const ip46_address_t * addr)
536 fib_entry_child_remove (pr->fei, pr->sibling);
538 fib_table_entry_special_remove (0, // default fib
539 &pfx, FIB_SOURCE_RR);
540 dpo_reset (&pr->dpo);
542 pr->fei = FIB_NODE_INDEX_INVALID;
543 pr->sibling = FIB_NODE_INDEX_INVALID;
547 map_pre_resolve (ip4_address_t * ip4, ip6_address_t * ip6, int is_del)
549 if (ip6 && (ip6->as_u64[0] != 0 || ip6->as_u64[1] != 0))
551 ip46_address_t addr = {
555 map_fib_unresolve (&pre_resolved[FIB_PROTOCOL_IP6],
556 FIB_PROTOCOL_IP6, 128, &addr);
558 map_fib_resolve (&pre_resolved[FIB_PROTOCOL_IP6],
559 FIB_PROTOCOL_IP6, 128, &addr);
561 if (ip4 && (ip4->as_u32 != 0))
563 ip46_address_t addr = {
567 map_fib_unresolve (&pre_resolved[FIB_PROTOCOL_IP4],
568 FIB_PROTOCOL_IP4, 32, &addr);
570 map_fib_resolve (&pre_resolved[FIB_PROTOCOL_IP4],
571 FIB_PROTOCOL_IP4, 32, &addr);
576 static clib_error_t *
577 map_security_check_command_fn (vlib_main_t * vm,
578 unformat_input_t * input,
579 vlib_cli_command_t * cmd)
581 unformat_input_t _line_input, *line_input = &_line_input;
582 map_main_t *mm = &map_main;
583 clib_error_t *error = NULL;
585 /* Get a line of input. */
586 if (!unformat_user (input, unformat_line_input, line_input))
589 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
591 if (unformat (line_input, "off"))
592 mm->sec_check = false;
593 else if (unformat (line_input, "on"))
594 mm->sec_check = true;
597 error = clib_error_return (0, "unknown input `%U'",
598 format_unformat_error, line_input);
604 unformat_free (line_input);
609 static clib_error_t *
610 map_security_check_frag_command_fn (vlib_main_t * vm,
611 unformat_input_t * input,
612 vlib_cli_command_t * cmd)
614 unformat_input_t _line_input, *line_input = &_line_input;
615 map_main_t *mm = &map_main;
616 clib_error_t *error = NULL;
618 /* Get a line of input. */
619 if (!unformat_user (input, unformat_line_input, line_input))
622 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
624 if (unformat (line_input, "off"))
625 mm->sec_check_frag = false;
626 else if (unformat (line_input, "on"))
627 mm->sec_check_frag = true;
630 error = clib_error_return (0, "unknown input `%U'",
631 format_unformat_error, line_input);
637 unformat_free (line_input);
642 static clib_error_t *
643 map_add_domain_command_fn (vlib_main_t * vm,
644 unformat_input_t * input, vlib_cli_command_t * cmd)
646 unformat_input_t _line_input, *line_input = &_line_input;
647 ip4_address_t ip4_prefix;
648 ip6_address_t ip6_prefix;
649 ip6_address_t ip6_src;
650 u32 ip6_prefix_len = 0, ip4_prefix_len = 0, map_domain_index, ip6_src_len;
652 /* Optional arguments */
653 u32 ea_bits_len = 0, psid_offset = 0, psid_length = 0;
657 clib_error_t *error = NULL;
659 /* Get a line of input. */
660 if (!unformat_user (input, unformat_line_input, line_input))
663 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
666 (line_input, "ip4-pfx %U/%d", unformat_ip4_address, &ip4_prefix,
671 (line_input, "ip6-pfx %U/%d", unformat_ip6_address, &ip6_prefix,
676 (line_input, "ip6-src %U/%d", unformat_ip6_address, &ip6_src,
681 (line_input, "ip6-src %U", unformat_ip6_address, &ip6_src))
683 else if (unformat (line_input, "ea-bits-len %d", &ea_bits_len))
685 else if (unformat (line_input, "psid-offset %d", &psid_offset))
687 else if (unformat (line_input, "psid-len %d", &psid_length))
689 else if (unformat (line_input, "mtu %d", &mtu))
691 else if (unformat (line_input, "map-t"))
692 flags |= MAP_DOMAIN_TRANSLATION;
695 error = clib_error_return (0, "unknown input `%U'",
696 format_unformat_error, line_input);
703 error = clib_error_return (0, "mandatory argument(s) missing");
707 map_create_domain (&ip4_prefix, ip4_prefix_len,
708 &ip6_prefix, ip6_prefix_len, &ip6_src, ip6_src_len,
709 ea_bits_len, psid_offset, psid_length, &map_domain_index,
713 unformat_free (line_input);
718 static clib_error_t *
719 map_del_domain_command_fn (vlib_main_t * vm,
720 unformat_input_t * input, vlib_cli_command_t * cmd)
722 unformat_input_t _line_input, *line_input = &_line_input;
724 u32 map_domain_index;
725 clib_error_t *error = NULL;
727 /* Get a line of input. */
728 if (!unformat_user (input, unformat_line_input, line_input))
731 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
733 if (unformat (line_input, "index %d", &map_domain_index))
737 error = clib_error_return (0, "unknown input `%U'",
738 format_unformat_error, line_input);
745 error = clib_error_return (0, "mandatory argument(s) missing");
749 map_delete_domain (map_domain_index);
752 unformat_free (line_input);
757 static clib_error_t *
758 map_add_rule_command_fn (vlib_main_t * vm,
759 unformat_input_t * input, vlib_cli_command_t * cmd)
761 unformat_input_t _line_input, *line_input = &_line_input;
764 u32 psid = 0, map_domain_index;
765 clib_error_t *error = NULL;
767 /* Get a line of input. */
768 if (!unformat_user (input, unformat_line_input, line_input))
771 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
773 if (unformat (line_input, "index %d", &map_domain_index))
775 else if (unformat (line_input, "psid %d", &psid))
778 if (unformat (line_input, "ip6-dst %U", unformat_ip6_address, &tep))
782 error = clib_error_return (0, "unknown input `%U'",
783 format_unformat_error, line_input);
790 error = clib_error_return (0, "mandatory argument(s) missing");
794 if (map_add_del_psid (map_domain_index, psid, &tep, 1) != 0)
796 error = clib_error_return (0, "Failing to add Mapping Rule");
801 unformat_free (line_input);
806 #if MAP_SKIP_IP6_LOOKUP
807 static clib_error_t *
808 map_pre_resolve_command_fn (vlib_main_t * vm,
809 unformat_input_t * input,
810 vlib_cli_command_t * cmd)
812 unformat_input_t _line_input, *line_input = &_line_input;
813 ip4_address_t ip4nh, *p_v4 = NULL;
814 ip6_address_t ip6nh, *p_v6 = NULL;
815 clib_error_t *error = NULL;
818 memset (&ip4nh, 0, sizeof (ip4nh));
819 memset (&ip6nh, 0, sizeof (ip6nh));
821 /* Get a line of input. */
822 if (!unformat_user (input, unformat_line_input, line_input))
825 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
827 if (unformat (line_input, "ip4-nh %U", unformat_ip4_address, &ip4nh))
830 if (unformat (line_input, "ip6-nh %U", unformat_ip6_address, &ip6nh))
832 else if (unformat (line_input, "del"))
836 error = clib_error_return (0, "unknown input `%U'",
837 format_unformat_error, line_input);
842 map_pre_resolve (p_v4, p_v6, is_del);
845 unformat_free (line_input);
851 static clib_error_t *
852 map_icmp_relay_source_address_command_fn (vlib_main_t * vm,
853 unformat_input_t * input,
854 vlib_cli_command_t * cmd)
856 unformat_input_t _line_input, *line_input = &_line_input;
857 ip4_address_t icmp_src_address;
858 map_main_t *mm = &map_main;
859 clib_error_t *error = NULL;
861 mm->icmp4_src_address.as_u32 = 0;
863 /* Get a line of input. */
864 if (!unformat_user (input, unformat_line_input, line_input))
867 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
870 (line_input, "%U", unformat_ip4_address, &icmp_src_address))
871 mm->icmp4_src_address = icmp_src_address;
874 error = clib_error_return (0, "unknown input `%U'",
875 format_unformat_error, line_input);
881 unformat_free (line_input);
886 static clib_error_t *
887 map_icmp_unreachables_command_fn (vlib_main_t * vm,
888 unformat_input_t * input,
889 vlib_cli_command_t * cmd)
891 unformat_input_t _line_input, *line_input = &_line_input;
892 map_main_t *mm = &map_main;
894 clib_error_t *error = NULL;
896 /* Get a line of input. */
897 if (!unformat_user (input, unformat_line_input, line_input))
900 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
903 if (unformat (line_input, "on"))
904 mm->icmp6_enabled = true;
905 else if (unformat (line_input, "off"))
906 mm->icmp6_enabled = false;
909 error = clib_error_return (0, "unknown input `%U'",
910 format_unformat_error, line_input);
917 error = clib_error_return (0, "mandatory argument(s) missing");
920 unformat_free (line_input);
925 static clib_error_t *
926 map_fragment_command_fn (vlib_main_t * vm,
927 unformat_input_t * input, vlib_cli_command_t * cmd)
929 unformat_input_t _line_input, *line_input = &_line_input;
930 map_main_t *mm = &map_main;
931 clib_error_t *error = NULL;
933 /* Get a line of input. */
934 if (!unformat_user (input, unformat_line_input, line_input))
937 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
939 if (unformat (line_input, "inner"))
940 mm->frag_inner = true;
941 else if (unformat (line_input, "outer"))
942 mm->frag_inner = false;
945 error = clib_error_return (0, "unknown input `%U'",
946 format_unformat_error, line_input);
952 unformat_free (line_input);
957 static clib_error_t *
958 map_fragment_df_command_fn (vlib_main_t * vm,
959 unformat_input_t * input,
960 vlib_cli_command_t * cmd)
962 unformat_input_t _line_input, *line_input = &_line_input;
963 map_main_t *mm = &map_main;
964 clib_error_t *error = NULL;
966 /* Get a line of input. */
967 if (!unformat_user (input, unformat_line_input, line_input))
970 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
972 if (unformat (line_input, "on"))
973 mm->frag_ignore_df = true;
974 else if (unformat (line_input, "off"))
975 mm->frag_ignore_df = false;
978 error = clib_error_return (0, "unknown input `%U'",
979 format_unformat_error, line_input);
985 unformat_free (line_input);
990 static clib_error_t *
991 map_traffic_class_command_fn (vlib_main_t * vm,
992 unformat_input_t * input,
993 vlib_cli_command_t * cmd)
995 unformat_input_t _line_input, *line_input = &_line_input;
996 map_main_t *mm = &map_main;
998 clib_error_t *error = NULL;
1000 mm->tc_copy = false;
1002 /* Get a line of input. */
1003 if (!unformat_user (input, unformat_line_input, line_input))
1006 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1008 if (unformat (line_input, "copy"))
1010 else if (unformat (line_input, "%x", &tc))
1014 error = clib_error_return (0, "unknown input `%U'",
1015 format_unformat_error, line_input);
1021 unformat_free (line_input);
1027 format_map_domain (u8 * s, va_list * args)
1029 map_domain_t *d = va_arg (*args, map_domain_t *);
1030 bool counters = va_arg (*args, int);
1031 map_main_t *mm = &map_main;
1032 ip6_address_t ip6_prefix;
1035 memset (&ip6_prefix, 0, sizeof (ip6_prefix));
1037 ip6_prefix = d->ip6_prefix;
1040 "[%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",
1042 format_ip4_address, &d->ip4_prefix, d->ip4_prefix_len,
1043 format_ip6_address, &ip6_prefix, d->ip6_prefix_len,
1044 format_ip6_address, &d->ip6_src, d->ip6_src_len,
1045 d->ea_bits_len, d->psid_offset, d->psid_length, d->mtu,
1046 (d->flags & MAP_DOMAIN_TRANSLATION) ? "map-t" : "");
1050 map_domain_counter_lock (mm);
1052 vlib_get_combined_counter (&mm->domain_counters[MAP_DOMAIN_COUNTER_TX],
1053 d - mm->domains, &v);
1054 s = format (s, " TX: %lld/%lld", v.packets, v.bytes);
1055 vlib_get_combined_counter (&mm->domain_counters[MAP_DOMAIN_COUNTER_RX],
1056 d - mm->domains, &v);
1057 s = format (s, " RX: %lld/%lld", v.packets, v.bytes);
1058 map_domain_counter_unlock (mm);
1060 s = format (s, "\n");
1066 for (i = 0; i < (0x1 << d->psid_length); i++)
1069 if (dst.as_u64[0] == 0 && dst.as_u64[1] == 0)
1072 " rule psid: %d ip6-dst %U\n", i, format_ip6_address,
1080 format_map_ip4_reass (u8 * s, va_list * args)
1082 map_main_t *mm = &map_main;
1083 map_ip4_reass_t *r = va_arg (*args, map_ip4_reass_t *);
1084 map_ip4_reass_key_t *k = &r->key;
1085 f64 now = vlib_time_now (mm->vlib_main);
1086 f64 lifetime = (((f64) mm->ip4_reass_conf_lifetime_ms) / 1000);
1087 f64 dt = (r->ts + lifetime > now) ? (r->ts + lifetime - now) : -1;
1089 "ip4-reass src=%U dst=%U protocol=%d identifier=%d port=%d lifetime=%.3lf\n",
1090 format_ip4_address, &k->src.as_u8, format_ip4_address,
1091 &k->dst.as_u8, k->protocol,
1092 clib_net_to_host_u16 (k->fragment_id),
1093 (r->port >= 0) ? clib_net_to_host_u16 (r->port) : -1, dt);
1098 format_map_ip6_reass (u8 * s, va_list * args)
1100 map_main_t *mm = &map_main;
1101 map_ip6_reass_t *r = va_arg (*args, map_ip6_reass_t *);
1102 map_ip6_reass_key_t *k = &r->key;
1103 f64 now = vlib_time_now (mm->vlib_main);
1104 f64 lifetime = (((f64) mm->ip6_reass_conf_lifetime_ms) / 1000);
1105 f64 dt = (r->ts + lifetime > now) ? (r->ts + lifetime - now) : -1;
1107 "ip6-reass src=%U dst=%U protocol=%d identifier=%d lifetime=%.3lf\n",
1108 format_ip6_address, &k->src.as_u8, format_ip6_address,
1109 &k->dst.as_u8, k->protocol,
1110 clib_net_to_host_u32 (k->fragment_id), dt);
1114 static clib_error_t *
1115 show_map_domain_command_fn (vlib_main_t * vm, unformat_input_t * input,
1116 vlib_cli_command_t * cmd)
1118 unformat_input_t _line_input, *line_input = &_line_input;
1119 map_main_t *mm = &map_main;
1121 bool counters = false;
1122 u32 map_domain_index = ~0;
1123 clib_error_t *error = NULL;
1125 /* Get a line of input. */
1126 if (!unformat_user (input, unformat_line_input, line_input))
1129 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1131 if (unformat (line_input, "counters"))
1133 else if (unformat (line_input, "index %d", &map_domain_index))
1137 error = clib_error_return (0, "unknown input `%U'",
1138 format_unformat_error, line_input);
1143 if (pool_elts (mm->domains) == 0)
1144 vlib_cli_output (vm, "No MAP domains are configured...");
1146 if (map_domain_index == ~0)
1149 pool_foreach(d, mm->domains, ({vlib_cli_output(vm, "%U", format_map_domain, d, counters);}));
1154 if (pool_is_free_index (mm->domains, map_domain_index))
1156 error = clib_error_return (0, "MAP domain does not exists %d",
1161 d = pool_elt_at_index (mm->domains, map_domain_index);
1162 vlib_cli_output (vm, "%U", format_map_domain, d, counters);
1166 unformat_free (line_input);
1171 static clib_error_t *
1172 show_map_fragments_command_fn (vlib_main_t * vm, unformat_input_t * input,
1173 vlib_cli_command_t * cmd)
1175 map_main_t *mm = &map_main;
1176 map_ip4_reass_t *f4;
1177 map_ip6_reass_t *f6;
1180 pool_foreach(f4, mm->ip4_reass_pool, ({vlib_cli_output (vm, "%U", format_map_ip4_reass, f4);}));
1183 pool_foreach(f6, mm->ip6_reass_pool, ({vlib_cli_output (vm, "%U", format_map_ip6_reass, f6);}));
1189 map_error_counter_get (u32 node_index, map_error_t map_error)
1191 vlib_main_t *vm = vlib_get_main ();
1192 vlib_node_runtime_t *error_node = vlib_node_get_runtime (vm, node_index);
1193 vlib_error_main_t *em = &vm->error_main;
1194 vlib_error_t e = error_node->errors[map_error];
1195 vlib_node_t *n = vlib_get_node (vm, node_index);
1198 ci = vlib_error_get_code (e);
1199 ASSERT (ci < n->n_errors);
1200 ci += n->error_heap_index;
1202 return (em->counters[ci]);
1205 static clib_error_t *
1206 show_map_stats_command_fn (vlib_main_t * vm, unformat_input_t * input,
1207 vlib_cli_command_t * cmd)
1209 map_main_t *mm = &map_main;
1211 int domains = 0, rules = 0, domaincount = 0, rulecount = 0;
1212 if (pool_elts (mm->domains) == 0)
1213 vlib_cli_output (vm, "No MAP domains are configured...");
1216 pool_foreach(d, mm->domains, ({
1218 rulecount+= 0x1 << d->psid_length;
1219 rules += sizeof(ip6_address_t) * 0x1 << d->psid_length;
1221 domains += sizeof(*d);
1226 vlib_cli_output (vm, "MAP domains structure: %d\n", sizeof (map_domain_t));
1227 vlib_cli_output (vm, "MAP domains: %d (%d bytes)\n", domaincount, domains);
1228 vlib_cli_output (vm, "MAP rules: %d (%d bytes)\n", rulecount, rules);
1229 vlib_cli_output (vm, "Total: %d bytes)\n", rules + domains);
1231 #if MAP_SKIP_IP6_LOOKUP
1232 vlib_cli_output (vm,
1233 "MAP pre-resolve: IP6 next-hop: %U, IP4 next-hop: %U\n",
1234 format_map_pre_resolve, &pre_resolved[FIB_PROTOCOL_IP6],
1235 format_map_pre_resolve, &pre_resolved[FIB_PROTOCOL_IP4]);
1240 vlib_cli_output (vm, "MAP traffic-class: copy");
1242 vlib_cli_output (vm, "MAP traffic-class: %x", mm->tc);
1244 vlib_cli_output (vm,
1245 "MAP IPv6 inbound security check: %s, fragmented packet security check: %s",
1246 mm->sec_check ? "enabled" : "disabled",
1247 mm->sec_check_frag ? "enabled" : "disabled");
1249 vlib_cli_output (vm, "ICMP-relay IPv4 source address: %U\n",
1250 format_ip4_address, &mm->icmp4_src_address);
1251 vlib_cli_output (vm, "ICMP6 unreachables sent for unmatched packets: %s\n",
1252 mm->icmp6_enabled ? "enabled" : "disabled");
1253 vlib_cli_output (vm, "Inner fragmentation: %s\n",
1254 mm->frag_inner ? "enabled" : "disabled");
1255 vlib_cli_output (vm, "Fragment packets regardless of DF flag: %s\n",
1256 mm->frag_ignore_df ? "enabled" : "disabled");
1261 vlib_combined_counter_main_t *cm = mm->domain_counters;
1262 u64 total_pkts[MAP_N_DOMAIN_COUNTER];
1263 u64 total_bytes[MAP_N_DOMAIN_COUNTER];
1267 memset (total_pkts, 0, sizeof (total_pkts));
1268 memset (total_bytes, 0, sizeof (total_bytes));
1270 map_domain_counter_lock (mm);
1271 vec_foreach (cm, mm->domain_counters)
1273 which = cm - mm->domain_counters;
1275 for (i = 0; i < vlib_combined_counter_n_counters (cm); i++)
1277 vlib_get_combined_counter (cm, i, &v);
1278 total_pkts[which] += v.packets;
1279 total_bytes[which] += v.bytes;
1282 map_domain_counter_unlock (mm);
1284 vlib_cli_output (vm, "Encapsulated packets: %lld bytes: %lld\n",
1285 total_pkts[MAP_DOMAIN_COUNTER_TX],
1286 total_bytes[MAP_DOMAIN_COUNTER_TX]);
1287 vlib_cli_output (vm, "Decapsulated packets: %lld bytes: %lld\n",
1288 total_pkts[MAP_DOMAIN_COUNTER_RX],
1289 total_bytes[MAP_DOMAIN_COUNTER_RX]);
1291 vlib_cli_output (vm, "ICMP relayed packets: %d\n",
1292 vlib_get_simple_counter (&mm->icmp_relayed, 0));
1297 static clib_error_t *
1298 map_params_reass_command_fn (vlib_main_t * vm, unformat_input_t * input,
1299 vlib_cli_command_t * cmd)
1301 unformat_input_t _line_input, *line_input = &_line_input;
1303 f64 ht_ratio = (MAP_IP4_REASS_CONF_HT_RATIO_MAX + 1);
1305 u64 buffers = ~(0ull);
1306 u8 ip4 = 0, ip6 = 0;
1308 if (!unformat_user (input, unformat_line_input, line_input))
1311 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1313 if (unformat (line_input, "lifetime %u", &lifetime))
1315 else if (unformat (line_input, "ht-ratio %lf", &ht_ratio))
1317 else if (unformat (line_input, "pool-size %u", &pool_size))
1319 else if (unformat (line_input, "buffers %llu", &buffers))
1321 else if (unformat (line_input, "ip4"))
1323 else if (unformat (line_input, "ip6"))
1327 unformat_free (line_input);
1328 return clib_error_return (0, "invalid input");
1331 unformat_free (line_input);
1334 return clib_error_return (0, "must specify ip4 and/or ip6");
1338 if (pool_size != ~0 && pool_size > MAP_IP4_REASS_CONF_POOL_SIZE_MAX)
1339 return clib_error_return (0, "invalid ip4-reass pool-size ( > %d)",
1340 MAP_IP4_REASS_CONF_POOL_SIZE_MAX);
1341 if (ht_ratio != (MAP_IP4_REASS_CONF_HT_RATIO_MAX + 1)
1342 && ht_ratio > MAP_IP4_REASS_CONF_HT_RATIO_MAX)
1343 return clib_error_return (0, "invalid ip4-reass ht-ratio ( > %d)",
1344 MAP_IP4_REASS_CONF_HT_RATIO_MAX);
1345 if (lifetime != ~0 && lifetime > MAP_IP4_REASS_CONF_LIFETIME_MAX)
1346 return clib_error_return (0, "invalid ip4-reass lifetime ( > %d)",
1347 MAP_IP4_REASS_CONF_LIFETIME_MAX);
1348 if (buffers != ~(0ull) && buffers > MAP_IP4_REASS_CONF_BUFFERS_MAX)
1349 return clib_error_return (0, "invalid ip4-reass buffers ( > %ld)",
1350 MAP_IP4_REASS_CONF_BUFFERS_MAX);
1355 if (pool_size != ~0 && pool_size > MAP_IP6_REASS_CONF_POOL_SIZE_MAX)
1356 return clib_error_return (0, "invalid ip6-reass pool-size ( > %d)",
1357 MAP_IP6_REASS_CONF_POOL_SIZE_MAX);
1358 if (ht_ratio != (MAP_IP4_REASS_CONF_HT_RATIO_MAX + 1)
1359 && ht_ratio > MAP_IP6_REASS_CONF_HT_RATIO_MAX)
1360 return clib_error_return (0, "invalid ip6-reass ht-log2len ( > %d)",
1361 MAP_IP6_REASS_CONF_HT_RATIO_MAX);
1362 if (lifetime != ~0 && lifetime > MAP_IP6_REASS_CONF_LIFETIME_MAX)
1363 return clib_error_return (0, "invalid ip6-reass lifetime ( > %d)",
1364 MAP_IP6_REASS_CONF_LIFETIME_MAX);
1365 if (buffers != ~(0ull) && buffers > MAP_IP6_REASS_CONF_BUFFERS_MAX)
1366 return clib_error_return (0, "invalid ip6-reass buffers ( > %ld)",
1367 MAP_IP6_REASS_CONF_BUFFERS_MAX);
1372 u32 reass = 0, packets = 0;
1373 if (pool_size != ~0)
1375 if (map_ip4_reass_conf_pool_size (pool_size, &reass, &packets))
1377 vlib_cli_output (vm, "Could not set ip4-reass pool-size");
1381 vlib_cli_output (vm,
1382 "Setting ip4-reass pool-size (destroyed-reassembly=%u , dropped-fragments=%u)",
1386 if (ht_ratio != (MAP_IP4_REASS_CONF_HT_RATIO_MAX + 1))
1388 if (map_ip4_reass_conf_ht_ratio (ht_ratio, &reass, &packets))
1390 vlib_cli_output (vm, "Could not set ip4-reass ht-log2len");
1394 vlib_cli_output (vm,
1395 "Setting ip4-reass ht-log2len (destroyed-reassembly=%u , dropped-fragments=%u)",
1401 if (map_ip4_reass_conf_lifetime (lifetime))
1402 vlib_cli_output (vm, "Could not set ip4-reass lifetime");
1404 vlib_cli_output (vm, "Setting ip4-reass lifetime");
1406 if (buffers != ~(0ull))
1408 if (map_ip4_reass_conf_buffers (buffers))
1409 vlib_cli_output (vm, "Could not set ip4-reass buffers");
1411 vlib_cli_output (vm, "Setting ip4-reass buffers");
1414 if (map_main.ip4_reass_conf_buffers >
1415 map_main.ip4_reass_conf_pool_size *
1416 MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY)
1418 vlib_cli_output (vm,
1419 "Note: 'ip4-reass buffers' > pool-size * max-fragments-per-reassembly.");
1425 u32 reass = 0, packets = 0;
1426 if (pool_size != ~0)
1428 if (map_ip6_reass_conf_pool_size (pool_size, &reass, &packets))
1430 vlib_cli_output (vm, "Could not set ip6-reass pool-size");
1434 vlib_cli_output (vm,
1435 "Setting ip6-reass pool-size (destroyed-reassembly=%u , dropped-fragments=%u)",
1439 if (ht_ratio != (MAP_IP4_REASS_CONF_HT_RATIO_MAX + 1))
1441 if (map_ip6_reass_conf_ht_ratio (ht_ratio, &reass, &packets))
1443 vlib_cli_output (vm, "Could not set ip6-reass ht-log2len");
1447 vlib_cli_output (vm,
1448 "Setting ip6-reass ht-log2len (destroyed-reassembly=%u , dropped-fragments=%u)",
1454 if (map_ip6_reass_conf_lifetime (lifetime))
1455 vlib_cli_output (vm, "Could not set ip6-reass lifetime");
1457 vlib_cli_output (vm, "Setting ip6-reass lifetime");
1459 if (buffers != ~(0ull))
1461 if (map_ip6_reass_conf_buffers (buffers))
1462 vlib_cli_output (vm, "Could not set ip6-reass buffers");
1464 vlib_cli_output (vm, "Setting ip6-reass buffers");
1467 if (map_main.ip6_reass_conf_buffers >
1468 map_main.ip6_reass_conf_pool_size *
1469 MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY)
1471 vlib_cli_output (vm,
1472 "Note: 'ip6-reass buffers' > pool-size * max-fragments-per-reassembly.");
1481 * packet trace format function
1484 format_map_trace (u8 * s, va_list * args)
1486 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
1487 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
1488 map_trace_t *t = va_arg (*args, map_trace_t *);
1489 u32 map_domain_index = t->map_domain_index;
1493 format (s, "MAP domain index: %d L4 port: %u", map_domain_index,
1494 clib_net_to_host_u16 (port));
1499 static_always_inline map_ip4_reass_t *
1500 map_ip4_reass_lookup (map_ip4_reass_key_t * k, u32 bucket, f64 now)
1502 map_main_t *mm = &map_main;
1503 u32 ri = mm->ip4_reass_hash_table[bucket];
1504 while (ri != MAP_REASS_INDEX_NONE)
1506 map_ip4_reass_t *r = pool_elt_at_index (mm->ip4_reass_pool, ri);
1507 if (r->key.as_u64[0] == k->as_u64[0] &&
1508 r->key.as_u64[1] == k->as_u64[1] &&
1509 now < r->ts + (((f64) mm->ip4_reass_conf_lifetime_ms) / 1000))
1513 ri = r->bucket_next;
1518 #define map_ip4_reass_pool_index(r) (r - map_main.ip4_reass_pool)
1521 map_ip4_reass_free (map_ip4_reass_t * r, u32 ** pi_to_drop)
1523 map_main_t *mm = &map_main;
1524 map_ip4_reass_get_fragments (r, pi_to_drop);
1526 // Unlink in hash bucket
1527 map_ip4_reass_t *r2 = NULL;
1528 u32 r2i = mm->ip4_reass_hash_table[r->bucket];
1529 while (r2i != map_ip4_reass_pool_index (r))
1531 ASSERT (r2i != MAP_REASS_INDEX_NONE);
1532 r2 = pool_elt_at_index (mm->ip4_reass_pool, r2i);
1533 r2i = r2->bucket_next;
1537 r2->bucket_next = r->bucket_next;
1541 mm->ip4_reass_hash_table[r->bucket] = r->bucket_next;
1545 if (r->fifo_next == map_ip4_reass_pool_index (r))
1547 mm->ip4_reass_fifo_last = MAP_REASS_INDEX_NONE;
1551 if (mm->ip4_reass_fifo_last == map_ip4_reass_pool_index (r))
1552 mm->ip4_reass_fifo_last = r->fifo_prev;
1553 pool_elt_at_index (mm->ip4_reass_pool, r->fifo_prev)->fifo_next =
1555 pool_elt_at_index (mm->ip4_reass_pool, r->fifo_next)->fifo_prev =
1559 pool_put (mm->ip4_reass_pool, r);
1560 mm->ip4_reass_allocated--;
1564 map_ip4_reass_get (u32 src, u32 dst, u16 fragment_id,
1565 u8 protocol, u32 ** pi_to_drop)
1568 map_main_t *mm = &map_main;
1569 map_ip4_reass_key_t k = {.src.data_u32 = src,
1570 .dst.data_u32 = dst,
1571 .fragment_id = fragment_id,
1572 .protocol = protocol
1576 h = crc_u32 (k.as_u32[0], h);
1577 h = crc_u32 (k.as_u32[1], h);
1578 h = crc_u32 (k.as_u32[2], h);
1579 h = crc_u32 (k.as_u32[3], h);
1580 h = h >> (32 - mm->ip4_reass_ht_log2len);
1582 f64 now = vlib_time_now (mm->vlib_main);
1584 //Cache garbage collection
1585 while (mm->ip4_reass_fifo_last != MAP_REASS_INDEX_NONE)
1587 map_ip4_reass_t *last =
1588 pool_elt_at_index (mm->ip4_reass_pool, mm->ip4_reass_fifo_last);
1589 if (last->ts + (((f64) mm->ip4_reass_conf_lifetime_ms) / 1000) < now)
1590 map_ip4_reass_free (last, pi_to_drop);
1595 if ((r = map_ip4_reass_lookup (&k, h, now)))
1598 if (mm->ip4_reass_allocated >= mm->ip4_reass_conf_pool_size)
1601 pool_get (mm->ip4_reass_pool, r);
1602 mm->ip4_reass_allocated++;
1604 for (i = 0; i < MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
1605 r->fragments[i] = ~0;
1607 u32 ri = map_ip4_reass_pool_index (r);
1609 //Link in new bucket
1611 r->bucket_next = mm->ip4_reass_hash_table[h];
1612 mm->ip4_reass_hash_table[h] = ri;
1615 if (mm->ip4_reass_fifo_last != MAP_REASS_INDEX_NONE)
1618 pool_elt_at_index (mm->ip4_reass_pool,
1619 mm->ip4_reass_fifo_last)->fifo_next;
1620 r->fifo_prev = mm->ip4_reass_fifo_last;
1621 pool_elt_at_index (mm->ip4_reass_pool, r->fifo_prev)->fifo_next = ri;
1622 pool_elt_at_index (mm->ip4_reass_pool, r->fifo_next)->fifo_prev = ri;
1626 r->fifo_next = r->fifo_prev = ri;
1627 mm->ip4_reass_fifo_last = ri;
1634 #ifdef MAP_IP4_REASS_COUNT_BYTES
1635 r->expected_total = 0xffff;
1643 map_ip4_reass_add_fragment (map_ip4_reass_t * r, u32 pi)
1645 if (map_main.ip4_reass_buffered_counter >= map_main.ip4_reass_conf_buffers)
1649 for (i = 0; i < MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
1650 if (r->fragments[i] == ~0)
1652 r->fragments[i] = pi;
1653 map_main.ip4_reass_buffered_counter++;
1659 static_always_inline map_ip6_reass_t *
1660 map_ip6_reass_lookup (map_ip6_reass_key_t * k, u32 bucket, f64 now)
1662 map_main_t *mm = &map_main;
1663 u32 ri = mm->ip6_reass_hash_table[bucket];
1664 while (ri != MAP_REASS_INDEX_NONE)
1666 map_ip6_reass_t *r = pool_elt_at_index (mm->ip6_reass_pool, ri);
1667 if (now < r->ts + (((f64) mm->ip6_reass_conf_lifetime_ms) / 1000) &&
1668 r->key.as_u64[0] == k->as_u64[0] &&
1669 r->key.as_u64[1] == k->as_u64[1] &&
1670 r->key.as_u64[2] == k->as_u64[2] &&
1671 r->key.as_u64[3] == k->as_u64[3] &&
1672 r->key.as_u64[4] == k->as_u64[4])
1674 ri = r->bucket_next;
1679 #define map_ip6_reass_pool_index(r) (r - map_main.ip6_reass_pool)
1682 map_ip6_reass_free (map_ip6_reass_t * r, u32 ** pi_to_drop)
1684 map_main_t *mm = &map_main;
1686 for (i = 0; i < MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
1687 if (r->fragments[i].pi != ~0)
1689 vec_add1 (*pi_to_drop, r->fragments[i].pi);
1690 r->fragments[i].pi = ~0;
1691 map_main.ip6_reass_buffered_counter--;
1694 // Unlink in hash bucket
1695 map_ip6_reass_t *r2 = NULL;
1696 u32 r2i = mm->ip6_reass_hash_table[r->bucket];
1697 while (r2i != map_ip6_reass_pool_index (r))
1699 ASSERT (r2i != MAP_REASS_INDEX_NONE);
1700 r2 = pool_elt_at_index (mm->ip6_reass_pool, r2i);
1701 r2i = r2->bucket_next;
1705 r2->bucket_next = r->bucket_next;
1709 mm->ip6_reass_hash_table[r->bucket] = r->bucket_next;
1713 if (r->fifo_next == map_ip6_reass_pool_index (r))
1715 //Single element in the list, list is now empty
1716 mm->ip6_reass_fifo_last = MAP_REASS_INDEX_NONE;
1720 if (mm->ip6_reass_fifo_last == map_ip6_reass_pool_index (r)) //First element
1721 mm->ip6_reass_fifo_last = r->fifo_prev;
1722 pool_elt_at_index (mm->ip6_reass_pool, r->fifo_prev)->fifo_next =
1724 pool_elt_at_index (mm->ip6_reass_pool, r->fifo_next)->fifo_prev =
1728 // Free from pool if necessary
1729 pool_put (mm->ip6_reass_pool, r);
1730 mm->ip6_reass_allocated--;
1734 map_ip6_reass_get (ip6_address_t * src, ip6_address_t * dst, u32 fragment_id,
1735 u8 protocol, u32 ** pi_to_drop)
1738 map_main_t *mm = &map_main;
1739 map_ip6_reass_key_t k = {
1742 .fragment_id = fragment_id,
1743 .protocol = protocol
1748 for (i = 0; i < 10; i++)
1749 h = crc_u32 (k.as_u32[i], h);
1750 h = h >> (32 - mm->ip6_reass_ht_log2len);
1752 f64 now = vlib_time_now (mm->vlib_main);
1754 //Cache garbage collection
1755 while (mm->ip6_reass_fifo_last != MAP_REASS_INDEX_NONE)
1757 map_ip6_reass_t *last =
1758 pool_elt_at_index (mm->ip6_reass_pool, mm->ip6_reass_fifo_last);
1759 if (last->ts + (((f64) mm->ip6_reass_conf_lifetime_ms) / 1000) < now)
1760 map_ip6_reass_free (last, pi_to_drop);
1765 if ((r = map_ip6_reass_lookup (&k, h, now)))
1768 if (mm->ip6_reass_allocated >= mm->ip6_reass_conf_pool_size)
1771 pool_get (mm->ip6_reass_pool, r);
1772 mm->ip6_reass_allocated++;
1773 for (i = 0; i < MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
1775 r->fragments[i].pi = ~0;
1776 r->fragments[i].next_data_len = 0;
1777 r->fragments[i].next_data_offset = 0;
1780 u32 ri = map_ip6_reass_pool_index (r);
1782 //Link in new bucket
1784 r->bucket_next = mm->ip6_reass_hash_table[h];
1785 mm->ip6_reass_hash_table[h] = ri;
1788 if (mm->ip6_reass_fifo_last != MAP_REASS_INDEX_NONE)
1791 pool_elt_at_index (mm->ip6_reass_pool,
1792 mm->ip6_reass_fifo_last)->fifo_next;
1793 r->fifo_prev = mm->ip6_reass_fifo_last;
1794 pool_elt_at_index (mm->ip6_reass_pool, r->fifo_prev)->fifo_next = ri;
1795 pool_elt_at_index (mm->ip6_reass_pool, r->fifo_next)->fifo_prev = ri;
1799 r->fifo_next = r->fifo_prev = ri;
1800 mm->ip6_reass_fifo_last = ri;
1806 r->ip4_header.ip_version_and_header_length = 0;
1807 #ifdef MAP_IP6_REASS_COUNT_BYTES
1808 r->expected_total = 0xffff;
1815 map_ip6_reass_add_fragment (map_ip6_reass_t * r, u32 pi,
1816 u16 data_offset, u16 next_data_offset,
1817 u8 * data_start, u16 data_len)
1819 map_ip6_fragment_t *f = NULL, *prev_f = NULL;
1820 u16 copied_len = (data_len > 20) ? 20 : data_len;
1822 if (map_main.ip6_reass_buffered_counter >= map_main.ip6_reass_conf_buffers)
1825 //Lookup for fragments for the current buffer
1826 //and the one before that
1828 for (i = 0; i < MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
1830 if (data_offset && r->fragments[i].next_data_offset == data_offset)
1832 prev_f = &r->fragments[i]; // This is buffer for previous packet
1834 else if (r->fragments[i].next_data_offset == next_data_offset)
1836 f = &r->fragments[i]; // This is a buffer for the current packet
1838 else if (r->fragments[i].next_data_offset == 0)
1841 f = &r->fragments[i];
1842 else if (prev_f == NULL)
1843 prev_f = &r->fragments[i];
1847 if (!f || f->pi != ~0)
1855 clib_memcpy (prev_f->next_data, data_start, copied_len);
1856 prev_f->next_data_len = copied_len;
1857 prev_f->next_data_offset = data_offset;
1861 if (((ip4_header_t *) data_start)->ip_version_and_header_length != 0x45)
1864 if (r->ip4_header.ip_version_and_header_length == 0)
1865 clib_memcpy (&r->ip4_header, data_start, sizeof (ip4_header_t));
1870 f->next_data_offset = next_data_offset;
1872 map_main.ip6_reass_buffered_counter++;
1878 map_ip4_reass_reinit (u32 * trashed_reass, u32 * dropped_packets)
1880 map_main_t *mm = &map_main;
1883 if (dropped_packets)
1884 *dropped_packets = mm->ip4_reass_buffered_counter;
1886 *trashed_reass = mm->ip4_reass_allocated;
1887 if (mm->ip4_reass_fifo_last != MAP_REASS_INDEX_NONE)
1889 u16 ri = mm->ip4_reass_fifo_last;
1892 map_ip4_reass_t *r = pool_elt_at_index (mm->ip4_reass_pool, ri);
1893 for (i = 0; i < MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
1894 if (r->fragments[i] != ~0)
1895 map_ip4_drop_pi (r->fragments[i]);
1898 pool_put (mm->ip4_reass_pool, r);
1900 while (ri != mm->ip4_reass_fifo_last);
1903 vec_free (mm->ip4_reass_hash_table);
1904 vec_resize (mm->ip4_reass_hash_table, 1 << mm->ip4_reass_ht_log2len);
1905 for (i = 0; i < (1 << mm->ip4_reass_ht_log2len); i++)
1906 mm->ip4_reass_hash_table[i] = MAP_REASS_INDEX_NONE;
1907 pool_free (mm->ip4_reass_pool);
1908 pool_alloc (mm->ip4_reass_pool, mm->ip4_reass_conf_pool_size);
1910 mm->ip4_reass_allocated = 0;
1911 mm->ip4_reass_fifo_last = MAP_REASS_INDEX_NONE;
1912 mm->ip4_reass_buffered_counter = 0;
1916 map_get_ht_log2len (f32 ht_ratio, u16 pool_size)
1918 u32 desired_size = (u32) (pool_size * ht_ratio);
1920 for (i = 1; i < 31; i++)
1921 if ((1 << i) >= desired_size)
1927 map_ip4_reass_conf_ht_ratio (f32 ht_ratio, u32 * trashed_reass,
1928 u32 * dropped_packets)
1930 map_main_t *mm = &map_main;
1931 if (ht_ratio > MAP_IP4_REASS_CONF_HT_RATIO_MAX)
1934 map_ip4_reass_lock ();
1935 mm->ip4_reass_conf_ht_ratio = ht_ratio;
1936 mm->ip4_reass_ht_log2len =
1937 map_get_ht_log2len (ht_ratio, mm->ip4_reass_conf_pool_size);
1938 map_ip4_reass_reinit (trashed_reass, dropped_packets);
1939 map_ip4_reass_unlock ();
1944 map_ip4_reass_conf_pool_size (u16 pool_size, u32 * trashed_reass,
1945 u32 * dropped_packets)
1947 map_main_t *mm = &map_main;
1948 if (pool_size > MAP_IP4_REASS_CONF_POOL_SIZE_MAX)
1951 map_ip4_reass_lock ();
1952 mm->ip4_reass_conf_pool_size = pool_size;
1953 map_ip4_reass_reinit (trashed_reass, dropped_packets);
1954 map_ip4_reass_unlock ();
1959 map_ip4_reass_conf_lifetime (u16 lifetime_ms)
1961 map_main.ip4_reass_conf_lifetime_ms = lifetime_ms;
1966 map_ip4_reass_conf_buffers (u32 buffers)
1968 map_main.ip4_reass_conf_buffers = buffers;
1973 map_ip6_reass_reinit (u32 * trashed_reass, u32 * dropped_packets)
1975 map_main_t *mm = &map_main;
1976 if (dropped_packets)
1977 *dropped_packets = mm->ip6_reass_buffered_counter;
1979 *trashed_reass = mm->ip6_reass_allocated;
1981 if (mm->ip6_reass_fifo_last != MAP_REASS_INDEX_NONE)
1983 u16 ri = mm->ip6_reass_fifo_last;
1986 map_ip6_reass_t *r = pool_elt_at_index (mm->ip6_reass_pool, ri);
1987 for (i = 0; i < MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
1988 if (r->fragments[i].pi != ~0)
1989 map_ip6_drop_pi (r->fragments[i].pi);
1992 pool_put (mm->ip6_reass_pool, r);
1994 while (ri != mm->ip6_reass_fifo_last);
1995 mm->ip6_reass_fifo_last = MAP_REASS_INDEX_NONE;
1998 vec_free (mm->ip6_reass_hash_table);
1999 vec_resize (mm->ip6_reass_hash_table, 1 << mm->ip6_reass_ht_log2len);
2000 for (i = 0; i < (1 << mm->ip6_reass_ht_log2len); i++)
2001 mm->ip6_reass_hash_table[i] = MAP_REASS_INDEX_NONE;
2002 pool_free (mm->ip6_reass_pool);
2003 pool_alloc (mm->ip6_reass_pool, mm->ip4_reass_conf_pool_size);
2005 mm->ip6_reass_allocated = 0;
2006 mm->ip6_reass_buffered_counter = 0;
2010 map_ip6_reass_conf_ht_ratio (f32 ht_ratio, u32 * trashed_reass,
2011 u32 * dropped_packets)
2013 map_main_t *mm = &map_main;
2014 if (ht_ratio > MAP_IP6_REASS_CONF_HT_RATIO_MAX)
2017 map_ip6_reass_lock ();
2018 mm->ip6_reass_conf_ht_ratio = ht_ratio;
2019 mm->ip6_reass_ht_log2len =
2020 map_get_ht_log2len (ht_ratio, mm->ip6_reass_conf_pool_size);
2021 map_ip6_reass_reinit (trashed_reass, dropped_packets);
2022 map_ip6_reass_unlock ();
2027 map_ip6_reass_conf_pool_size (u16 pool_size, u32 * trashed_reass,
2028 u32 * dropped_packets)
2030 map_main_t *mm = &map_main;
2031 if (pool_size > MAP_IP6_REASS_CONF_POOL_SIZE_MAX)
2034 map_ip6_reass_lock ();
2035 mm->ip6_reass_conf_pool_size = pool_size;
2036 map_ip6_reass_reinit (trashed_reass, dropped_packets);
2037 map_ip6_reass_unlock ();
2042 map_ip6_reass_conf_lifetime (u16 lifetime_ms)
2044 map_main.ip6_reass_conf_lifetime_ms = lifetime_ms;
2049 map_ip6_reass_conf_buffers (u32 buffers)
2051 map_main.ip6_reass_conf_buffers = buffers;
2058 * Configure MAP reassembly behaviour
2061 * @cliexstart{map params reassembly}
2064 VLIB_CLI_COMMAND(map_ip4_reass_lifetime_command, static) = {
2065 .path = "map params reassembly",
2066 .short_help = "map params reassembly [ip4 | ip6] [lifetime <lifetime-ms>] "
2067 "[pool-size <pool-size>] [buffers <buffers>] "
2068 "[ht-ratio <ht-ratio>]",
2069 .function = map_params_reass_command_fn,
2073 * Set or copy the IP TOS/Traffic Class field
2076 * @cliexstart{map params traffic-class}
2078 * This command is used to set the traffic-class field in translated
2079 * or encapsulated packets. If copy is specifed (the default) then the
2080 * traffic-class/TOS field is copied from the original packet to the
2081 * translated / encapsulating header.
2084 VLIB_CLI_COMMAND(map_traffic_class_command, static) = {
2085 .path = "map params traffic-class",
2086 .short_help = "map params traffic-class {0x0-0xff | copy}",
2087 .function = map_traffic_class_command_fn,
2091 * Bypass IP4/IP6 lookup
2094 * @cliexstart{map params pre-resolve}
2096 * Bypass a second FIB lookup of the translated or encapsulated
2097 * packet, and forward the packet directly to the specified
2098 * next-hop. This optimization trades forwarding flexibility for
2102 VLIB_CLI_COMMAND(map_pre_resolve_command, static) = {
2103 .path = "map params pre-resolve",
2104 .short_help = " map params pre-resolve {ip4-nh <address>} "
2105 "| {ip6-nh <address>}",
2106 .function = map_pre_resolve_command_fn,
2110 * Enable or disable the MAP-E inbound security check
2113 * @cliexstart{map params security-check}
2115 * By default, a decapsulated packet's IPv4 source address will be
2116 * verified against the outer header's IPv6 source address. Disabling
2117 * this feature will allow IPv4 source address spoofing.
2120 VLIB_CLI_COMMAND(map_security_check_command, static) = {
2121 .path = "map params security-check",
2122 .short_help = "map params security-check on|off",
2123 .function = map_security_check_command_fn,
2127 * Specifiy the IPv4 source address used for relayed ICMP error messages
2130 * @cliexstart{map params icmp source-address}
2132 * This command specifies which IPv4 source address (must be local to
2133 * the system), that is used for relayed received IPv6 ICMP error
2137 VLIB_CLI_COMMAND(map_icmp_relay_source_address_command, static) = {
2138 .path = "map params icmp source-address",
2139 .short_help = "map params icmp source-address <ip4-address>",
2140 .function = map_icmp_relay_source_address_command_fn,
2144 * Send IPv6 ICMP unreachables
2147 * @cliexstart{map params icmp6 unreachables}
2149 * Send IPv6 ICMP unreachable messages back if security check fails or
2150 * no MAP domain exists.
2153 VLIB_CLI_COMMAND(map_icmp_unreachables_command, static) = {
2154 .path = "map params icmp6 unreachables",
2155 .short_help = "map params icmp6 unreachables {on|off}",
2156 .function = map_icmp_unreachables_command_fn,
2160 * Configure MAP fragmentation behaviour
2163 * @cliexstart{map params fragment}
2166 VLIB_CLI_COMMAND(map_fragment_command, static) = {
2167 .path = "map params fragment",
2168 .short_help = "map params fragment inner|outer",
2169 .function = map_fragment_command_fn,
2173 * Ignore the IPv4 Don't fragment bit
2176 * @cliexstart{map params fragment ignore-df}
2178 * Allows fragmentation of the IPv4 packet even if the DF bit is
2179 * set. The choice between inner or outer fragmentation of tunnel
2180 * packets is complicated. The benefit of inner fragmentation is that
2181 * the ultimate endpoint must reassemble, instead of the tunnel
2185 VLIB_CLI_COMMAND(map_fragment_df_command, static) = {
2186 .path = "map params fragment ignore-df",
2187 .short_help = "map params fragment ignore-df on|off",
2188 .function = map_fragment_df_command_fn,
2192 * Specifiy if the inbound security check should be done on fragments
2195 * @cliexstart{map params security-check fragments}
2197 * Typically the inbound on-decapsulation security check is only done
2198 * on the first packet. The packet that contains the L4
2199 * information. While a security check on every fragment is possible,
2200 * it has a cost. State must be created on the first fragment.
2203 VLIB_CLI_COMMAND(map_security_check_frag_command, static) = {
2204 .path = "map params security-check fragments",
2205 .short_help = "map params security-check fragments on|off",
2206 .function = map_security_check_frag_command_fn,
2213 * @cliexstart{map add domain}
2216 VLIB_CLI_COMMAND(map_add_domain_command, static) = {
2217 .path = "map add domain",
2218 .short_help = "map add domain ip4-pfx <ip4-pfx> ip6-pfx <ip6-pfx> "
2219 "ip6-src <ip6-pfx> ea-bits-len <n> psid-offset <n> psid-len <n> "
2220 "[map-t] [mtu <mtu>]",
2221 .function = map_add_domain_command_fn,
2225 * Add MAP rule to a domain
2228 * @cliexstart{map add rule}
2231 VLIB_CLI_COMMAND(map_add_rule_command, static) = {
2232 .path = "map add rule",
2233 .short_help = "map add rule index <domain> psid <psid> ip6-dst <ip6-addr>",
2234 .function = map_add_rule_command_fn,
2241 * @cliexstart{map del domain}
2244 VLIB_CLI_COMMAND(map_del_command, static) = {
2245 .path = "map del domain",
2246 .short_help = "map del domain index <domain>",
2247 .function = map_del_domain_command_fn,
2254 * @cliexstart{show map domain}
2257 VLIB_CLI_COMMAND(show_map_domain_command, static) = {
2258 .path = "show map domain",
2259 .short_help = "show map domain index <n> [counters]",
2260 .function = show_map_domain_command_fn,
2264 * Show MAP statistics
2267 * @cliexstart{show map stats}
2270 VLIB_CLI_COMMAND(show_map_stats_command, static) = {
2271 .path = "show map stats",
2272 .short_help = "show map stats",
2273 .function = show_map_stats_command_fn,
2277 * Show MAP fragmentation information
2280 * @cliexstart{show map fragments}
2283 VLIB_CLI_COMMAND(show_map_fragments_command, static) = {
2284 .path = "show map fragments",
2285 .short_help = "show map fragments",
2286 .function = show_map_fragments_command_fn,
2294 map_init (vlib_main_t * vm)
2296 map_main_t *mm = &map_main;
2297 mm->vnet_main = vnet_get_main ();
2300 #ifdef MAP_SKIP_IP6_LOOKUP
2301 fib_protocol_t proto;
2303 FOR_EACH_FIB_PROTOCOL (proto)
2305 map_pre_resolve_init (&pre_resolved[proto]);
2313 /* Inbound security check */
2314 mm->sec_check = true;
2315 mm->sec_check_frag = false;
2317 /* ICMP6 Type 1, Code 5 for security check failure */
2318 mm->icmp6_enabled = false;
2320 /* Inner or outer fragmentation */
2321 mm->frag_inner = false;
2322 mm->frag_ignore_df = false;
2324 vec_validate (mm->domain_counters, MAP_N_DOMAIN_COUNTER - 1);
2325 mm->domain_counters[MAP_DOMAIN_COUNTER_RX].name = "rx";
2326 mm->domain_counters[MAP_DOMAIN_COUNTER_TX].name = "tx";
2328 vlib_validate_simple_counter (&mm->icmp_relayed, 0);
2329 vlib_zero_simple_counter (&mm->icmp_relayed, 0);
2331 /* IP4 virtual reassembly */
2332 mm->ip4_reass_hash_table = 0;
2333 mm->ip4_reass_pool = 0;
2334 mm->ip4_reass_lock =
2335 clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES, CLIB_CACHE_LINE_BYTES);
2336 mm->ip4_reass_conf_ht_ratio = MAP_IP4_REASS_HT_RATIO_DEFAULT;
2337 mm->ip4_reass_conf_lifetime_ms = MAP_IP4_REASS_LIFETIME_DEFAULT;
2338 mm->ip4_reass_conf_pool_size = MAP_IP4_REASS_POOL_SIZE_DEFAULT;
2339 mm->ip4_reass_conf_buffers = MAP_IP4_REASS_BUFFERS_DEFAULT;
2340 mm->ip4_reass_ht_log2len =
2341 map_get_ht_log2len (mm->ip4_reass_conf_ht_ratio,
2342 mm->ip4_reass_conf_pool_size);
2343 mm->ip4_reass_fifo_last = MAP_REASS_INDEX_NONE;
2344 map_ip4_reass_reinit (NULL, NULL);
2346 /* IP6 virtual reassembly */
2347 mm->ip6_reass_hash_table = 0;
2348 mm->ip6_reass_pool = 0;
2349 mm->ip6_reass_lock =
2350 clib_mem_alloc_aligned (CLIB_CACHE_LINE_BYTES, CLIB_CACHE_LINE_BYTES);
2351 mm->ip6_reass_conf_ht_ratio = MAP_IP6_REASS_HT_RATIO_DEFAULT;
2352 mm->ip6_reass_conf_lifetime_ms = MAP_IP6_REASS_LIFETIME_DEFAULT;
2353 mm->ip6_reass_conf_pool_size = MAP_IP6_REASS_POOL_SIZE_DEFAULT;
2354 mm->ip6_reass_conf_buffers = MAP_IP6_REASS_BUFFERS_DEFAULT;
2355 mm->ip6_reass_ht_log2len =
2356 map_get_ht_log2len (mm->ip6_reass_conf_ht_ratio,
2357 mm->ip6_reass_conf_pool_size);
2358 mm->ip6_reass_fifo_last = MAP_REASS_INDEX_NONE;
2359 map_ip6_reass_reinit (NULL, NULL);
2361 #ifdef MAP_SKIP_IP6_LOOKUP
2362 fib_node_register_type (FIB_NODE_TYPE_MAP_E, &map_vft);
2364 map_dpo_module_init ();
2369 VLIB_INIT_FUNCTION (map_init);
2372 * fd.io coding-style-patch-verification: ON
2375 * eval: (c-set-style "gnu")