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/fib_entry_track.h>
20 #include <vnet/fib/ip6_fib.h>
21 #include <vnet/adj/adj.h>
22 #include <vppinfra/crc32.h>
23 #include <vnet/plugin/plugin.h>
24 #include <vpp/app/version.h>
30 * This code supports the following MAP modes:
32 * Algorithmic Shared IPv4 address (ea_bits_len > 0):
33 * ea_bits_len + ip4_prefix > 32
34 * psid_length > 0, ip6_prefix < 64, ip4_prefix <= 32
35 * Algorithmic Full IPv4 address (ea_bits_len > 0):
36 * ea_bits_len + ip4_prefix = 32
37 * psid_length = 0, ip6_prefix < 64, ip4_prefix <= 32
38 * Algorithmic IPv4 prefix (ea_bits_len > 0):
39 * ea_bits_len + ip4_prefix < 32
40 * psid_length = 0, ip6_prefix < 64, ip4_prefix <= 32
42 * Independent Shared IPv4 address (ea_bits_len = 0):
45 * Rule IPv6 address = 128, Rule PSID Set
46 * Independent Full IPv4 address (ea_bits_len = 0):
48 * psid_length = 0, ip6_prefix = 128
49 * Independent IPv4 prefix (ea_bits_len = 0):
51 * psid_length = 0, ip6_prefix = 128
56 * This code supports MAP-T:
58 * With a DMR prefix length of 64 or 96 (RFC6052).
64 * Save user-assigned MAP domain names ("tags") in a vector of
65 * extra domain information.
68 map_save_extras (u32 map_domain_index, u8 * tag)
70 map_main_t *mm = &map_main;
71 map_domain_extra_t *de;
73 if (map_domain_index == ~0)
76 vec_validate (mm->domain_extras, map_domain_index);
77 de = vec_elt_at_index (mm->domain_extras, map_domain_index);
78 clib_memset (de, 0, sizeof (*de));
83 vec_validate_init_c_string (de->tag, tag, strlen ((char *) tag));
88 map_free_extras (u32 map_domain_index)
90 map_main_t *mm = &map_main;
91 map_domain_extra_t *de;
93 if (map_domain_index == ~0)
96 if (map_domain_index >= vec_len (mm->domain_extras))
99 de = vec_elt_at_index (mm->domain_extras, map_domain_index);
108 map_create_domain (ip4_address_t * ip4_prefix,
110 ip6_address_t * ip6_prefix,
112 ip6_address_t * ip6_src,
117 u32 * map_domain_index, u16 mtu, u8 flags, u8 * tag)
119 u8 suffix_len, suffix_shift;
120 map_main_t *mm = &map_main;
123 /* How many, and which bits to grab from the IPv4 DA */
124 if (ip4_prefix_len + ea_bits_len < 32)
126 flags |= MAP_DOMAIN_PREFIX;
127 suffix_shift = 32 - ip4_prefix_len - ea_bits_len;
128 suffix_len = ea_bits_len;
133 suffix_len = 32 - ip4_prefix_len;
136 /* EA bits must be within the first 64 bits */
137 if (ea_bits_len > 0 && ((ip6_prefix_len + ea_bits_len) > 64 ||
138 ip6_prefix_len + suffix_len + psid_length > 64))
141 ("Embedded Address bits must be within the first 64 bits of "
146 /* Get domain index */
147 pool_get_aligned (mm->domains, d, CLIB_CACHE_LINE_BYTES);
148 clib_memset (d, 0, sizeof (*d));
149 *map_domain_index = d - mm->domains;
151 /* Init domain struct */
152 d->ip4_prefix.as_u32 = ip4_prefix->as_u32;
153 d->ip4_prefix_len = ip4_prefix_len;
154 d->ip6_prefix = *ip6_prefix;
155 d->ip6_prefix_len = ip6_prefix_len;
156 d->ip6_src = *ip6_src;
157 d->ip6_src_len = ip6_src_len;
158 d->ea_bits_len = ea_bits_len;
159 d->psid_offset = psid_offset;
160 d->psid_length = psid_length;
163 d->suffix_shift = suffix_shift;
164 d->suffix_mask = (1 << suffix_len) - 1;
166 d->psid_shift = 16 - psid_length - psid_offset;
167 d->psid_mask = (1 << d->psid_length) - 1;
168 d->ea_shift = 64 - ip6_prefix_len - suffix_len - d->psid_length;
170 /* Save a user-assigned MAP domain name if provided. */
172 map_save_extras (*map_domain_index, tag);
174 /* MAP longest match lookup table (input feature / FIB) */
175 mm->ip4_prefix_tbl->add (mm->ip4_prefix_tbl, &d->ip4_prefix,
176 d->ip4_prefix_len, *map_domain_index);
178 /* Really needed? Or always use FIB? */
179 mm->ip6_src_prefix_tbl->add (mm->ip6_src_prefix_tbl, &d->ip6_src,
180 d->ip6_src_len, *map_domain_index);
182 /* Validate packet/byte counters */
183 map_domain_counter_lock (mm);
185 for (i = 0; i < vec_len (mm->simple_domain_counters); i++)
187 vlib_validate_simple_counter (&mm->simple_domain_counters[i],
189 vlib_zero_simple_counter (&mm->simple_domain_counters[i],
192 for (i = 0; i < vec_len (mm->domain_counters); i++)
194 vlib_validate_combined_counter (&mm->domain_counters[i],
196 vlib_zero_combined_counter (&mm->domain_counters[i], *map_domain_index);
198 map_domain_counter_unlock (mm);
207 map_delete_domain (u32 map_domain_index)
209 map_main_t *mm = &map_main;
212 if (pool_is_free_index (mm->domains, map_domain_index))
214 clib_warning ("MAP domain delete: domain does not exist: %d",
219 d = pool_elt_at_index (mm->domains, map_domain_index);
220 mm->ip4_prefix_tbl->delete (mm->ip4_prefix_tbl, &d->ip4_prefix,
222 mm->ip6_src_prefix_tbl->delete (mm->ip6_src_prefix_tbl, &d->ip6_src,
225 /* Release user-assigned MAP domain name. */
226 map_free_extras (map_domain_index);
230 clib_mem_free (d->rules);
232 pool_put (mm->domains, d);
238 map_add_del_psid (u32 map_domain_index, u16 psid, ip6_address_t * tep,
242 map_main_t *mm = &map_main;
244 if (pool_is_free_index (mm->domains, map_domain_index))
246 clib_warning ("MAP rule: domain does not exist: %d", map_domain_index);
249 d = pool_elt_at_index (mm->domains, map_domain_index);
251 /* Rules are only used in 1:1 independent case */
252 if (d->ea_bits_len > 0)
257 u32 l = (0x1 << d->psid_length) * sizeof (ip6_address_t);
258 d->rules = clib_mem_alloc_aligned (l, CLIB_CACHE_LINE_BYTES);
261 clib_memset (d->rules, 0, l);
264 if (psid >= (0x1 << d->psid_length))
266 clib_warning ("MAP rule: PSID outside bounds: %d [%d]", psid,
267 0x1 << d->psid_length);
273 d->rules[psid] = *tep;
277 clib_memset (&d->rules[psid], 0, sizeof (ip6_address_t));
282 #ifdef MAP_SKIP_IP6_LOOKUP
284 * Pre-resolved per-protocol global next-hops
286 map_main_pre_resolved_t pre_resolved[FIB_PROTOCOL_MAX];
289 map_pre_resolve_init (map_main_pre_resolved_t * pr)
291 pr->fei = FIB_NODE_INDEX_INVALID;
292 fib_node_init (&pr->node, FIB_NODE_TYPE_MAP_E);
296 format_map_pre_resolve (u8 * s, va_list * ap)
298 map_main_pre_resolved_t *pr = va_arg (*ap, map_main_pre_resolved_t *);
300 if (FIB_NODE_INDEX_INVALID != pr->fei)
302 const fib_prefix_t *pfx;
304 pfx = fib_entry_get_prefix (pr->fei);
306 return (format (s, "%U (%u)",
307 format_ip46_address, &pfx->fp_addr, IP46_TYPE_ANY,
308 pr->dpo.dpoi_index));
312 return (format (s, "un-set"));
318 * Function definition to inform the FIB node that its last lock has gone.
321 map_last_lock_gone (fib_node_t * node)
324 * The MAP is a root of the graph. As such
325 * it never has children and thus is never locked.
330 static map_main_pre_resolved_t *
331 map_from_fib_node (fib_node_t * node)
333 ASSERT (FIB_NODE_TYPE_MAP_E == node->fn_type);
334 return ((map_main_pre_resolved_t *)
336 STRUCT_OFFSET_OF (map_main_pre_resolved_t, node)));
340 map_stack (map_main_pre_resolved_t * pr)
344 dpo = fib_entry_contribute_ip_forwarding (pr->fei);
346 dpo_copy (&pr->dpo, dpo);
350 * Function definition to backwalk a FIB node
352 static fib_node_back_walk_rc_t
353 map_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
355 map_stack (map_from_fib_node (node));
357 return (FIB_NODE_BACK_WALK_CONTINUE);
361 * Function definition to get a FIB node from its index
364 map_fib_node_get (fib_node_index_t index)
366 return (&pre_resolved[index].node);
370 * Virtual function table registered by MPLS GRE tunnels
371 * for participation in the FIB object graph.
373 const static fib_node_vft_t map_vft = {
374 .fnv_get = map_fib_node_get,
375 .fnv_last_lock = map_last_lock_gone,
376 .fnv_back_walk = map_back_walk,
380 map_fib_resolve (map_main_pre_resolved_t * pr,
381 fib_protocol_t proto, u8 len, const ip46_address_t * addr)
389 pr->fei = fib_entry_track (0, // default fib
390 &pfx, FIB_NODE_TYPE_MAP_E, proto, &pr->sibling);
395 map_fib_unresolve (map_main_pre_resolved_t * pr,
396 fib_protocol_t proto, u8 len, const ip46_address_t * addr)
398 if (pr->fei != FIB_NODE_INDEX_INVALID)
400 fib_entry_untrack (pr->fei, pr->sibling);
402 dpo_reset (&pr->dpo);
404 pr->fei = FIB_NODE_INDEX_INVALID;
405 pr->sibling = FIB_NODE_INDEX_INVALID;
410 map_pre_resolve (ip4_address_t * ip4, ip6_address_t * ip6, bool is_del)
412 if (ip6 && (ip6->as_u64[0] != 0 || ip6->as_u64[1] != 0))
414 ip46_address_t addr = {
418 map_fib_unresolve (&pre_resolved[FIB_PROTOCOL_IP6],
419 FIB_PROTOCOL_IP6, 128, &addr);
421 map_fib_resolve (&pre_resolved[FIB_PROTOCOL_IP6],
422 FIB_PROTOCOL_IP6, 128, &addr);
424 if (ip4 && (ip4->as_u32 != 0))
426 ip46_address_t addr = {
430 map_fib_unresolve (&pre_resolved[FIB_PROTOCOL_IP4],
431 FIB_PROTOCOL_IP4, 32, &addr);
433 map_fib_resolve (&pre_resolved[FIB_PROTOCOL_IP4],
434 FIB_PROTOCOL_IP4, 32, &addr);
439 static clib_error_t *
440 map_security_check_command_fn (vlib_main_t * vm,
441 unformat_input_t * input,
442 vlib_cli_command_t * cmd)
444 unformat_input_t _line_input, *line_input = &_line_input;
445 clib_error_t *error = NULL;
447 bool check_frag = false;
448 bool saw_enable = false;
449 bool saw_frag = false;
451 /* Get a line of input. */
452 if (!unformat_user (input, unformat_line_input, line_input))
455 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
457 if (unformat (line_input, "enable"))
462 else if (unformat (line_input, "disable"))
467 else if (unformat (line_input, "fragments on"))
472 else if (unformat (line_input, "fragments off"))
479 error = clib_error_return (0, "unknown input `%U'",
480 format_unformat_error, line_input);
487 error = clib_error_return (0,
488 "Must specify enable 'enable' or 'disable'");
494 error = clib_error_return (0, "Must specify fragments 'on' or 'off'");
498 map_param_set_security_check (enable, check_frag);
501 unformat_free (line_input);
507 static clib_error_t *
508 map_add_domain_command_fn (vlib_main_t * vm,
509 unformat_input_t * input, vlib_cli_command_t * cmd)
511 unformat_input_t _line_input, *line_input = &_line_input;
512 ip4_address_t ip4_prefix;
513 ip6_address_t ip6_prefix;
514 ip6_address_t ip6_src;
515 u32 ip6_prefix_len = 0, ip4_prefix_len = 0, map_domain_index, ip6_src_len;
517 /* Optional arguments */
518 u32 ea_bits_len = 0, psid_offset = 0, psid_length = 0;
523 clib_error_t *error = NULL;
525 /* Get a line of input. */
526 if (!unformat_user (input, unformat_line_input, line_input))
529 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
532 (line_input, "ip4-pfx %U/%d", unformat_ip4_address, &ip4_prefix,
537 (line_input, "ip6-pfx %U/%d", unformat_ip6_address, &ip6_prefix,
542 (line_input, "ip6-src %U/%d", unformat_ip6_address, &ip6_src,
547 (line_input, "ip6-src %U", unformat_ip6_address, &ip6_src))
549 else if (unformat (line_input, "ea-bits-len %d", &ea_bits_len))
551 else if (unformat (line_input, "psid-offset %d", &psid_offset))
553 else if (unformat (line_input, "psid-len %d", &psid_length))
555 else if (unformat (line_input, "mtu %d", &mtu))
557 else if (unformat (line_input, "tag %v", &tag))
561 error = clib_error_return (0, "unknown input `%U'",
562 format_unformat_error, line_input);
569 error = clib_error_return (0, "mandatory argument(s) missing");
573 map_create_domain (&ip4_prefix, ip4_prefix_len,
574 &ip6_prefix, ip6_prefix_len, &ip6_src, ip6_src_len,
575 ea_bits_len, psid_offset, psid_length, &map_domain_index,
579 unformat_free (line_input);
584 static clib_error_t *
585 map_del_domain_command_fn (vlib_main_t * vm,
586 unformat_input_t * input, vlib_cli_command_t * cmd)
588 unformat_input_t _line_input, *line_input = &_line_input;
590 u32 map_domain_index;
591 clib_error_t *error = NULL;
593 /* Get a line of input. */
594 if (!unformat_user (input, unformat_line_input, line_input))
597 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
599 if (unformat (line_input, "index %d", &map_domain_index))
603 error = clib_error_return (0, "unknown input `%U'",
604 format_unformat_error, line_input);
611 error = clib_error_return (0, "mandatory argument(s) missing");
615 map_delete_domain (map_domain_index);
618 unformat_free (line_input);
623 static clib_error_t *
624 map_add_rule_command_fn (vlib_main_t * vm,
625 unformat_input_t * input, vlib_cli_command_t * cmd)
627 unformat_input_t _line_input, *line_input = &_line_input;
630 u32 psid = 0, map_domain_index;
631 clib_error_t *error = NULL;
633 /* Get a line of input. */
634 if (!unformat_user (input, unformat_line_input, line_input))
637 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
639 if (unformat (line_input, "index %d", &map_domain_index))
641 else if (unformat (line_input, "psid %d", &psid))
644 if (unformat (line_input, "ip6-dst %U", unformat_ip6_address, &tep))
648 error = clib_error_return (0, "unknown input `%U'",
649 format_unformat_error, line_input);
656 error = clib_error_return (0, "mandatory argument(s) missing");
660 if (map_add_del_psid (map_domain_index, psid, &tep, 1) != 0)
662 error = clib_error_return (0, "Failing to add Mapping Rule");
667 unformat_free (line_input);
672 #if MAP_SKIP_IP6_LOOKUP
673 static clib_error_t *
674 map_pre_resolve_command_fn (vlib_main_t * vm,
675 unformat_input_t * input,
676 vlib_cli_command_t * cmd)
678 unformat_input_t _line_input, *line_input = &_line_input;
679 ip4_address_t ip4nh, *p_v4 = NULL;
680 ip6_address_t ip6nh, *p_v6 = NULL;
681 clib_error_t *error = NULL;
684 clib_memset (&ip4nh, 0, sizeof (ip4nh));
685 clib_memset (&ip6nh, 0, sizeof (ip6nh));
687 /* Get a line of input. */
688 if (!unformat_user (input, unformat_line_input, line_input))
691 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
693 if (unformat (line_input, "ip4-nh %U", unformat_ip4_address, &ip4nh))
696 if (unformat (line_input, "ip6-nh %U", unformat_ip6_address, &ip6nh))
698 else if (unformat (line_input, "del"))
702 error = clib_error_return (0, "unknown input `%U'",
703 format_unformat_error, line_input);
708 map_pre_resolve (p_v4, p_v6, is_del);
711 unformat_free (line_input);
717 static clib_error_t *
718 map_icmp_relay_source_address_command_fn (vlib_main_t * vm,
719 unformat_input_t * input,
720 vlib_cli_command_t * cmd)
722 unformat_input_t _line_input, *line_input = &_line_input;
723 ip4_address_t icmp_src_address;
724 ip4_address_t *p_icmp_addr = 0;
725 map_main_t *mm = &map_main;
726 clib_error_t *error = NULL;
728 mm->icmp4_src_address.as_u32 = 0;
730 /* Get a line of input. */
731 if (!unformat_user (input, unformat_line_input, line_input))
734 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
737 (line_input, "%U", unformat_ip4_address, &icmp_src_address))
739 mm->icmp4_src_address = icmp_src_address;
740 p_icmp_addr = &icmp_src_address;
744 error = clib_error_return (0, "unknown input `%U'",
745 format_unformat_error, line_input);
750 map_param_set_icmp (p_icmp_addr);
753 unformat_free (line_input);
758 static clib_error_t *
759 map_icmp_unreachables_command_fn (vlib_main_t * vm,
760 unformat_input_t * input,
761 vlib_cli_command_t * cmd)
763 unformat_input_t _line_input, *line_input = &_line_input;
765 clib_error_t *error = NULL;
766 bool enabled = false;
768 /* Get a line of input. */
769 if (!unformat_user (input, unformat_line_input, line_input))
772 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
775 if (unformat (line_input, "on"))
777 else if (unformat (line_input, "off"))
781 error = clib_error_return (0, "unknown input `%U'",
782 format_unformat_error, line_input);
789 error = clib_error_return (0, "mandatory argument(s) missing");
792 map_param_set_icmp6 (enabled);
795 unformat_free (line_input);
801 static clib_error_t *
802 map_fragment_command_fn (vlib_main_t * vm,
803 unformat_input_t * input, vlib_cli_command_t * cmd)
805 unformat_input_t _line_input, *line_input = &_line_input;
806 clib_error_t *error = NULL;
807 bool frag_inner = false;
808 bool frag_ignore_df = false;
809 bool saw_in_out = false;
812 /* Get a line of input. */
813 if (!unformat_user (input, unformat_line_input, line_input))
816 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
818 if (unformat (line_input, "inner"))
823 else if (unformat (line_input, "outer"))
828 else if (unformat (line_input, "ignore-df"))
830 frag_ignore_df = true;
833 else if (unformat (line_input, "honor-df"))
835 frag_ignore_df = false;
840 error = clib_error_return (0, "unknown input `%U'",
841 format_unformat_error, line_input);
848 error = clib_error_return (0, "Must specify 'inner' or 'outer'");
854 error = clib_error_return (0, "Must specify 'ignore-df' or 'honor-df'");
858 map_param_set_fragmentation (frag_inner, frag_ignore_df);
861 unformat_free (line_input);
866 static clib_error_t *
867 map_traffic_class_command_fn (vlib_main_t * vm,
868 unformat_input_t * input,
869 vlib_cli_command_t * cmd)
871 unformat_input_t _line_input, *line_input = &_line_input;
873 clib_error_t *error = NULL;
874 bool tc_copy = false;
877 /* Get a line of input. */
878 if (!unformat_user (input, unformat_line_input, line_input))
881 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
883 if (unformat (line_input, "copy"))
885 else if (unformat (line_input, "%x", &tc))
889 error = clib_error_return (0, "unknown input `%U'",
890 format_unformat_error, line_input);
895 map_param_set_traffic_class (tc_copy, tc);
898 unformat_free (line_input);
904 map_flags_to_string (u32 flags)
906 if (flags & MAP_DOMAIN_PREFIX)
912 format_map_domain (u8 * s, va_list * args)
914 map_domain_t *d = va_arg (*args, map_domain_t *);
915 bool counters = va_arg (*args, int);
916 map_main_t *mm = &map_main;
917 ip6_address_t ip6_prefix;
918 u32 map_domain_index = d - mm->domains;
919 map_domain_extra_t *de = 0;
922 clib_memset (&ip6_prefix, 0, sizeof (ip6_prefix));
924 ip6_prefix = d->ip6_prefix;
926 if (map_domain_index < vec_len (mm->domain_extras))
927 de = vec_elt_at_index (mm->domain_extras, map_domain_index);
930 "[%d] tag {%s} ip4-pfx %U/%d ip6-pfx %U/%d ip6-src %U/%d "
931 "ea-bits-len %d psid-offset %d psid-len %d mtu %d %s",
932 map_domain_index, (de && de->tag) ? de->tag : (u8 *) "[no-tag]",
933 format_ip4_address, &d->ip4_prefix, d->ip4_prefix_len,
934 format_ip6_address, &ip6_prefix, d->ip6_prefix_len,
935 format_ip6_address, &d->ip6_src, d->ip6_src_len,
936 d->ea_bits_len, d->psid_offset, d->psid_length, d->mtu,
937 map_flags_to_string (d->flags));
941 map_domain_counter_lock (mm);
943 vlib_get_combined_counter (&mm->domain_counters[MAP_DOMAIN_COUNTER_TX],
944 map_domain_index, &v);
945 s = format (s, " TX: %lld/%lld", v.packets, v.bytes);
946 vlib_get_combined_counter (&mm->domain_counters[MAP_DOMAIN_COUNTER_RX],
947 map_domain_index, &v);
948 s = format (s, " RX: %lld/%lld", v.packets, v.bytes);
949 map_domain_counter_unlock (mm);
951 s = format (s, "\n");
957 for (i = 0; i < (0x1 << d->psid_length); i++)
960 if (dst.as_u64[0] == 0 && dst.as_u64[1] == 0)
963 " rule psid: %d ip6-dst %U\n", i, format_ip6_address,
970 static clib_error_t *
971 show_map_domain_command_fn (vlib_main_t * vm, unformat_input_t * input,
972 vlib_cli_command_t * cmd)
974 unformat_input_t _line_input, *line_input = &_line_input;
975 map_main_t *mm = &map_main;
977 bool counters = false;
978 u32 map_domain_index = ~0;
979 clib_error_t *error = NULL;
981 /* Get a line of input. */
982 if (!unformat_user (input, unformat_line_input, line_input))
985 pool_foreach(d, mm->domains,
986 ({vlib_cli_output(vm, "%U", format_map_domain, d, counters);}));
991 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
993 if (unformat (line_input, "counters"))
995 else if (unformat (line_input, "index %d", &map_domain_index))
999 error = clib_error_return (0, "unknown input `%U'",
1000 format_unformat_error, line_input);
1005 if (pool_elts (mm->domains) == 0)
1007 vlib_cli_output (vm, "No MAP domains are configured...");
1011 if (map_domain_index == ~0)
1014 pool_foreach(d, mm->domains,
1015 ({vlib_cli_output(vm, "%U", format_map_domain, d, counters);}));
1020 if (pool_is_free_index (mm->domains, map_domain_index))
1022 error = clib_error_return (0, "MAP domain does not exists %d",
1027 d = pool_elt_at_index (mm->domains, map_domain_index);
1028 vlib_cli_output (vm, "%U", format_map_domain, d, counters);
1032 unformat_free (line_input);
1038 map_error_counter_get (u32 node_index, map_error_t map_error)
1040 vlib_main_t *vm = vlib_get_main ();
1041 vlib_node_runtime_t *error_node = vlib_node_get_runtime (vm, node_index);
1042 vlib_error_main_t *em = &vm->error_main;
1043 vlib_error_t e = error_node->errors[map_error];
1044 vlib_node_t *n = vlib_get_node (vm, node_index);
1047 ci = vlib_error_get_code (&vm->node_main, e);
1048 ASSERT (ci < n->n_errors);
1049 ci += n->error_heap_index;
1051 return (em->counters[ci]);
1054 static clib_error_t *
1055 show_map_stats_command_fn (vlib_main_t * vm, unformat_input_t * input,
1056 vlib_cli_command_t * cmd)
1058 map_main_t *mm = &map_main;
1060 int domains = 0, rules = 0, domaincount = 0, rulecount = 0;
1061 if (pool_elts (mm->domains) == 0)
1063 vlib_cli_output (vm, "No MAP domains are configured...");
1068 pool_foreach(d, mm->domains, ({
1070 rulecount+= 0x1 << d->psid_length;
1071 rules += sizeof(ip6_address_t) * 0x1 << d->psid_length;
1073 domains += sizeof(*d);
1078 vlib_cli_output (vm, "MAP domains structure: %d\n", sizeof (map_domain_t));
1079 vlib_cli_output (vm, "MAP domains: %d (%d bytes)\n", domaincount, domains);
1080 vlib_cli_output (vm, "MAP rules: %d (%d bytes)\n", rulecount, rules);
1081 vlib_cli_output (vm, "Total: %d bytes)\n", rules + domains);
1083 #if MAP_SKIP_IP6_LOOKUP
1084 vlib_cli_output (vm,
1085 "MAP pre-resolve: IP6 next-hop: %U, IP4 next-hop: %U\n",
1086 format_map_pre_resolve, &pre_resolved[FIB_PROTOCOL_IP6],
1087 format_map_pre_resolve, &pre_resolved[FIB_PROTOCOL_IP4]);
1092 vlib_cli_output (vm, "MAP traffic-class: copy");
1094 vlib_cli_output (vm, "MAP traffic-class: %x", mm->tc);
1097 vlib_cli_output (vm, "MAP TCP MSS clamping: %u", mm->tcp_mss);
1099 vlib_cli_output (vm,
1100 "MAP IPv6 inbound security check: %s, fragmented packet security check: %s",
1101 mm->sec_check ? "enabled" : "disabled",
1102 mm->sec_check_frag ? "enabled" : "disabled");
1104 vlib_cli_output (vm, "ICMP-relay IPv4 source address: %U\n",
1105 format_ip4_address, &mm->icmp4_src_address);
1106 vlib_cli_output (vm, "ICMP6 unreachables sent for unmatched packets: %s\n",
1107 mm->icmp6_enabled ? "enabled" : "disabled");
1108 vlib_cli_output (vm, "Inner fragmentation: %s\n",
1109 mm->frag_inner ? "enabled" : "disabled");
1110 vlib_cli_output (vm, "Fragment packets regardless of DF flag: %s\n",
1111 mm->frag_ignore_df ? "enabled" : "disabled");
1116 vlib_combined_counter_main_t *cm = mm->domain_counters;
1117 u64 total_pkts[MAP_N_DOMAIN_COUNTER];
1118 u64 total_bytes[MAP_N_DOMAIN_COUNTER];
1122 clib_memset (total_pkts, 0, sizeof (total_pkts));
1123 clib_memset (total_bytes, 0, sizeof (total_bytes));
1125 map_domain_counter_lock (mm);
1126 vec_foreach (cm, mm->domain_counters)
1128 which = cm - mm->domain_counters;
1130 for (i = 0; i < vlib_combined_counter_n_counters (cm); i++)
1132 vlib_get_combined_counter (cm, i, &v);
1133 total_pkts[which] += v.packets;
1134 total_bytes[which] += v.bytes;
1137 map_domain_counter_unlock (mm);
1139 vlib_cli_output (vm, "Encapsulated packets: %lld bytes: %lld\n",
1140 total_pkts[MAP_DOMAIN_COUNTER_TX],
1141 total_bytes[MAP_DOMAIN_COUNTER_TX]);
1142 vlib_cli_output (vm, "Decapsulated packets: %lld bytes: %lld\n",
1143 total_pkts[MAP_DOMAIN_COUNTER_RX],
1144 total_bytes[MAP_DOMAIN_COUNTER_RX]);
1146 vlib_cli_output (vm, "ICMP relayed packets: %d\n",
1147 vlib_get_simple_counter (&mm->icmp_relayed, 0));
1152 static clib_error_t *
1153 map_if_command_fn (vlib_main_t * vm,
1154 unformat_input_t * input, vlib_cli_command_t * cmd)
1156 unformat_input_t _line_input, *line_input = &_line_input;
1157 clib_error_t *error = NULL;
1158 bool is_enable = true, is_translation = false;
1159 vnet_main_t *vnm = vnet_get_main ();
1160 u32 sw_if_index = ~0;
1162 /* Get a line of input. */
1163 if (!unformat_user (input, unformat_line_input, line_input))
1166 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1169 (line_input, "%U", unformat_vnet_sw_interface, vnm, &sw_if_index))
1171 else if (unformat (line_input, "del"))
1173 else if (unformat (line_input, "map-t"))
1174 is_translation = true;
1177 error = clib_error_return (0, "unknown input `%U'",
1178 format_unformat_error, line_input);
1184 unformat_free (line_input);
1186 if (sw_if_index == ~0)
1188 error = clib_error_return (0, "unknown interface");
1192 int rv = map_if_enable_disable (is_enable, sw_if_index, is_translation);
1195 error = clib_error_return (0, "failure enabling MAP on interface");
1203 * packet trace format function
1206 format_map_trace (u8 * s, va_list * args)
1208 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
1209 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
1210 map_trace_t *t = va_arg (*args, map_trace_t *);
1211 u32 map_domain_index = t->map_domain_index;
1215 format (s, "MAP domain index: %d L4 port: %u", map_domain_index,
1216 clib_net_to_host_u16 (port));
1221 static clib_error_t *
1222 map_tcp_mss_command_fn (vlib_main_t * vm,
1223 unformat_input_t * input, vlib_cli_command_t * cmd)
1225 unformat_input_t _line_input, *line_input = &_line_input;
1226 clib_error_t *error = NULL;
1229 /* Get a line of input. */
1230 if (!unformat_user (input, unformat_line_input, line_input))
1233 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1235 if (unformat (line_input, "%u", &tcp_mss))
1239 error = clib_error_return (0, "unknown input `%U'",
1240 format_unformat_error, line_input);
1245 if (tcp_mss >= (0x1 << 16))
1247 error = clib_error_return (0, "invalid value `%u'", tcp_mss);
1251 map_param_set_tcp (tcp_mss);
1254 unformat_free (line_input);
1263 * Set or copy the IP TOS/Traffic Class field
1266 * @cliexstart{map params traffic-class}
1268 * This command is used to set the traffic-class field in translated
1269 * or encapsulated packets. If copy is specifed (the default) then the
1270 * traffic-class/TOS field is copied from the original packet to the
1271 * translated / encapsulating header.
1274 VLIB_CLI_COMMAND(map_traffic_class_command, static) = {
1275 .path = "map params traffic-class",
1276 .short_help = "map params traffic-class {0x0-0xff | copy}",
1277 .function = map_traffic_class_command_fn,
1284 * @cliexstart{map params tcp-mss}
1286 * This command is used to set the TCP MSS in translated
1287 * or encapsulated packets.
1290 VLIB_CLI_COMMAND(map_tcp_mss_command, static) = {
1291 .path = "map params tcp-mss",
1292 .short_help = "map params tcp-mss <value>",
1293 .function = map_tcp_mss_command_fn,
1297 * Bypass IP4/IP6 lookup
1300 * @cliexstart{map params pre-resolve}
1302 * Bypass a second FIB lookup of the translated or encapsulated
1303 * packet, and forward the packet directly to the specified
1304 * next-hop. This optimization trades forwarding flexibility for
1308 VLIB_CLI_COMMAND(map_pre_resolve_command, static) = {
1309 .path = "map params pre-resolve",
1310 .short_help = " map params pre-resolve {ip4-nh <address>} "
1311 "| {ip6-nh <address>}",
1312 .function = map_pre_resolve_command_fn,
1316 * Enable or disable the MAP-E inbound security check
1317 * Specifiy if the inbound security check should be done on fragments
1320 * @cliexstart{map params security-check}
1322 * By default, a decapsulated packet's IPv4 source address will be
1323 * verified against the outer header's IPv6 source address. Disabling
1324 * this feature will allow IPv4 source address spoofing.
1326 * Typically the inbound on-decapsulation security check is only done
1327 * on the first packet. The packet that contains the L4
1328 * information. While a security check on every fragment is possible,
1329 * it has a cost. State must be created on the first fragment.
1332 VLIB_CLI_COMMAND(map_security_check_command, static) = {
1333 .path = "map params security-check",
1334 .short_help = "map params security-check enable|disable fragments on|off",
1335 .function = map_security_check_command_fn,
1340 * Specifiy the IPv4 source address used for relayed ICMP error messages
1343 * @cliexstart{map params icmp source-address}
1345 * This command specifies which IPv4 source address (must be local to
1346 * the system), that is used for relayed received IPv6 ICMP error
1350 VLIB_CLI_COMMAND(map_icmp_relay_source_address_command, static) = {
1351 .path = "map params icmp source-address",
1352 .short_help = "map params icmp source-address <ip4-address>",
1353 .function = map_icmp_relay_source_address_command_fn,
1357 * Send IPv6 ICMP unreachables
1360 * @cliexstart{map params icmp6 unreachables}
1362 * Send IPv6 ICMP unreachable messages back if security check fails or
1363 * no MAP domain exists.
1366 VLIB_CLI_COMMAND(map_icmp_unreachables_command, static) = {
1367 .path = "map params icmp6 unreachables",
1368 .short_help = "map params icmp6 unreachables {on|off}",
1369 .function = map_icmp_unreachables_command_fn,
1373 * Configure MAP fragmentation behaviour
1376 * @cliexstart{map params fragment}
1378 * Allows fragmentation of the IPv4 packet even if the DF bit is
1379 * set. The choice between inner or outer fragmentation of tunnel
1380 * packets is complicated. The benefit of inner fragmentation is that
1381 * the ultimate endpoint must reassemble, instead of the tunnel
1385 VLIB_CLI_COMMAND(map_fragment_command, static) = {
1386 .path = "map params fragment",
1387 .short_help = "map params fragment inner|outer ignore-df|honor-df",
1388 .function = map_fragment_command_fn,
1396 * @cliexstart{map add domain}
1399 VLIB_CLI_COMMAND(map_add_domain_command, static) = {
1400 .path = "map add domain",
1401 .short_help = "map add domain [tag <tag>] ip4-pfx <ip4-pfx> "
1402 "ip6-pfx <ip6-pfx> "
1403 "ip6-src <ip6-pfx> ea-bits-len <n> psid-offset <n> psid-len <n> "
1404 "[map-t] [mtu <mtu>]",
1405 .function = map_add_domain_command_fn,
1409 * Add MAP rule to a domain
1412 * @cliexstart{map add rule}
1415 VLIB_CLI_COMMAND(map_add_rule_command, static) = {
1416 .path = "map add rule",
1417 .short_help = "map add rule index <domain> psid <psid> ip6-dst <ip6-addr>",
1418 .function = map_add_rule_command_fn,
1425 * @cliexstart{map del domain}
1428 VLIB_CLI_COMMAND(map_del_command, static) = {
1429 .path = "map del domain",
1430 .short_help = "map del domain index <domain>",
1431 .function = map_del_domain_command_fn,
1438 * @cliexstart{show map domain}
1441 VLIB_CLI_COMMAND(show_map_domain_command, static) = {
1442 .path = "show map domain",
1443 .short_help = "show map domain index <n> [counters]",
1444 .function = show_map_domain_command_fn,
1448 * Show MAP statistics
1451 * @cliexstart{show map stats}
1454 VLIB_CLI_COMMAND(show_map_stats_command, static) = {
1455 .path = "show map stats",
1456 .short_help = "show map stats",
1457 .function = show_map_stats_command_fn,
1461 * Enable MAP processing on interface (input feature)
1464 VLIB_CLI_COMMAND(map_if_command, static) = {
1465 .path = "map interface",
1466 .short_help = "map interface <interface-name> [map-t] [del]",
1467 .function = map_if_command_fn,
1470 VLIB_PLUGIN_REGISTER() = {
1471 .version = VPP_BUILD_VER,
1472 .description = "Mapping of Address and Port (MAP)",
1481 map_init (vlib_main_t * vm)
1483 map_main_t *mm = &map_main;
1484 clib_error_t *error = 0;
1486 memset (mm, 0, sizeof (*mm));
1488 mm->vnet_main = vnet_get_main ();
1491 #ifdef MAP_SKIP_IP6_LOOKUP
1492 fib_protocol_t proto;
1494 FOR_EACH_FIB_PROTOCOL (proto)
1496 map_pre_resolve_init (&pre_resolved[proto]);
1504 /* Inbound security check */
1505 mm->sec_check = true;
1506 mm->sec_check_frag = false;
1508 /* ICMP6 Type 1, Code 5 for security check failure */
1509 mm->icmp6_enabled = false;
1511 /* Inner or outer fragmentation */
1512 mm->frag_inner = false;
1513 mm->frag_ignore_df = false;
1515 vec_validate (mm->domain_counters, MAP_N_DOMAIN_COUNTER - 1);
1516 mm->domain_counters[MAP_DOMAIN_COUNTER_RX].name = "/map/rx";
1517 mm->domain_counters[MAP_DOMAIN_COUNTER_TX].name = "/map/tx";
1519 vlib_validate_simple_counter (&mm->icmp_relayed, 0);
1520 vlib_zero_simple_counter (&mm->icmp_relayed, 0);
1521 mm->icmp_relayed.stat_segment_name = "/map/icmp-relayed";
1523 /* IP6 virtual reassembly */
1525 #ifdef MAP_SKIP_IP6_LOOKUP
1526 fib_node_register_type (FIB_NODE_TYPE_MAP_E, &map_vft);
1529 /* LPM lookup tables */
1530 mm->ip4_prefix_tbl = lpm_table_init (LPM_TYPE_KEY32);
1531 mm->ip6_prefix_tbl = lpm_table_init (LPM_TYPE_KEY128);
1532 mm->ip6_src_prefix_tbl = lpm_table_init (LPM_TYPE_KEY128);
1534 mm->bm_trans_enabled_by_sw_if = 0;
1535 mm->bm_encap_enabled_by_sw_if = 0;
1537 error = map_plugin_api_hookup (vm);
1542 VLIB_INIT_FUNCTION (map_init);
1545 * fd.io coding-style-patch-verification: ON
1548 * eval: (c-set-style "gnu")