2 * l2_bd.c : layer 2 bridge domain
4 * Copyright (c) 2013 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 <vlib/vlib.h>
19 #include <vnet/vnet.h>
21 #include <vnet/ethernet/ethernet.h>
22 #include <vnet/ip/format.h>
23 #include <vnet/l2/l2_input.h>
24 #include <vnet/l2/feat_bitmap.h>
25 #include <vnet/l2/l2_bd.h>
26 #include <vnet/l2/l2_learn.h>
27 #include <vnet/l2/l2_fib.h>
28 #include <vnet/l2/l2_vtr.h>
29 #include <vnet/ip/ip4_packet.h>
30 #include <vnet/ip/ip6_packet.h>
32 #include <vppinfra/error.h>
33 #include <vppinfra/hash.h>
34 #include <vppinfra/vec.h>
38 * @brief Ethernet Bridge Domain.
40 * Code in this file manages Layer 2 bridge domains.
47 Init bridge domain if not done already.
48 For feature bitmap, set all bits except ARP termination
51 bd_validate (l2_bridge_domain_t * bd_config)
53 if (bd_is_valid (bd_config))
55 bd_config->feature_bitmap =
56 ~(L2INPUT_FEAT_ARP_TERM | L2INPUT_FEAT_UU_FWD | L2INPUT_FEAT_ARP_UFWD);
57 bd_config->bvi_sw_if_index = ~0;
58 bd_config->uu_fwd_sw_if_index = ~0;
59 bd_config->members = 0;
60 bd_config->flood_count = 0;
61 bd_config->tun_master_count = 0;
62 bd_config->tun_normal_count = 0;
63 bd_config->no_flood_count = 0;
64 bd_config->mac_by_ip4 = 0;
65 bd_config->mac_by_ip6 = hash_create_mem (0, sizeof (ip6_address_t),
70 bd_find_index (bd_main_t * bdm, u32 bd_id)
72 u32 *p = (u32 *) hash_get (bdm->bd_index_by_bd_id, bd_id);
79 bd_add_bd_index (bd_main_t * bdm, u32 bd_id)
81 ASSERT (!hash_get (bdm->bd_index_by_bd_id, bd_id));
82 u32 rv = clib_bitmap_first_clear (bdm->bd_index_bitmap);
84 /* mark this index taken */
85 bdm->bd_index_bitmap = clib_bitmap_set (bdm->bd_index_bitmap, rv, 1);
87 hash_set (bdm->bd_index_by_bd_id, bd_id, rv);
89 vec_validate (l2input_main.bd_configs, rv);
90 l2input_main.bd_configs[rv].bd_id = bd_id;
91 l2input_main.bd_configs[rv].learn_limit =
92 l2learn_main.bd_default_learn_limit;
93 l2input_main.bd_configs[rv].learn_count = 0;
99 bd_free_ip_mac_tables (l2_bridge_domain_t * bd)
102 ip6_address_t *ip6_addr_key;
104 hash_free (bd->mac_by_ip4);
106 hash_foreach_mem (ip6_addr_key, mac_addr, bd->mac_by_ip6,
108 clib_mem_free (ip6_addr_key); /* free memory used for ip6 addr key */
111 hash_free (bd->mac_by_ip6);
115 bd_delete (bd_main_t * bdm, u32 bd_index)
117 l2_bridge_domain_t *bd = &l2input_main.bd_configs[bd_index];
118 u32 bd_id = bd->bd_id;
120 /* flush non-static MACs in BD and removed bd_id from hash table */
121 l2fib_flush_bd_mac (vlib_get_main (), bd_index);
122 hash_unset (bdm->bd_index_by_bd_id, bd_id);
124 /* mark this index clear */
125 bdm->bd_index_bitmap = clib_bitmap_set (bdm->bd_index_bitmap, bd_index, 0);
127 /* clear BD config for reuse: bd_id to -1 and clear feature_bitmap */
129 bd->feature_bitmap = 0;
131 bd->learn_count = ~0;
134 vec_free (bd->bd_tag);
136 /* free memory used by BD */
137 vec_free (bd->members);
138 bd_free_ip_mac_tables (bd);
144 update_flood_count (l2_bridge_domain_t * bd_config)
146 bd_config->flood_count = (vec_len (bd_config->members) -
147 (bd_config->tun_master_count ?
148 bd_config->tun_normal_count : 0));
149 bd_config->flood_count -= bd_config->no_flood_count;
153 bd_add_member (l2_bridge_domain_t * bd_config, l2_flood_member_t * member)
156 vnet_sw_interface_t *sw_if = vnet_get_sw_interface
157 (vnet_get_main (), member->sw_if_index);
160 * Add one element to the vector
161 * vector is ordered [ bvi, normal/tun_masters..., tun_normals... no_flood]
162 * When flooding, the bvi interface (if present) must be the last member
163 * processed due to how BVI processing can change the packet. To enable
164 * this order, we make the bvi interface the first in the vector and
165 * flooding walks the vector in reverse. The flood-count determines where
166 * in the member list to start the walk from.
168 switch (sw_if->flood_class)
170 case VNET_FLOOD_CLASS_NO_FLOOD:
171 bd_config->no_flood_count++;
172 ix = vec_len (bd_config->members);
174 case VNET_FLOOD_CLASS_BVI:
177 case VNET_FLOOD_CLASS_TUNNEL_MASTER:
178 bd_config->tun_master_count++;
180 case VNET_FLOOD_CLASS_NORMAL:
181 ix = (vec_len (bd_config->members) -
182 bd_config->tun_normal_count - bd_config->no_flood_count);
184 case VNET_FLOOD_CLASS_TUNNEL_NORMAL:
185 ix = (vec_len (bd_config->members) - bd_config->no_flood_count);
186 bd_config->tun_normal_count++;
190 vec_insert_elts (bd_config->members, member, 1, ix);
191 update_flood_count (bd_config);
194 #define BD_REMOVE_ERROR_OK 0
195 #define BD_REMOVE_ERROR_NOT_FOUND 1
198 bd_remove_member (l2_bridge_domain_t * bd_config, u32 sw_if_index)
202 /* Find and delete the member */
203 vec_foreach_index (ix, bd_config->members)
205 l2_flood_member_t *m = vec_elt_at_index (bd_config->members, ix);
206 if (m->sw_if_index == sw_if_index)
208 vnet_sw_interface_t *sw_if = vnet_get_sw_interface
209 (vnet_get_main (), sw_if_index);
211 if (sw_if->flood_class != VNET_FLOOD_CLASS_NORMAL)
213 if (sw_if->flood_class == VNET_FLOOD_CLASS_TUNNEL_MASTER)
214 bd_config->tun_master_count--;
215 else if (sw_if->flood_class == VNET_FLOOD_CLASS_TUNNEL_NORMAL)
216 bd_config->tun_normal_count--;
217 else if (sw_if->flood_class == VNET_FLOOD_CLASS_NO_FLOOD)
218 bd_config->no_flood_count--;
220 vec_delete (bd_config->members, 1, ix);
221 update_flood_count (bd_config);
223 return BD_REMOVE_ERROR_OK;
227 return BD_REMOVE_ERROR_NOT_FOUND;
232 l2bd_init (vlib_main_t * vm)
234 bd_main_t *bdm = &bd_main;
235 bdm->bd_index_by_bd_id = hash_create (0, sizeof (uword));
237 * create a placeholder bd with bd_id of 0 and bd_index of 0 with feature set
238 * to packet drop only. Thus, packets received from any L2 interface with
239 * uninitialized bd_index of 0 can be dropped safely.
241 u32 bd_index = bd_add_bd_index (bdm, 0);
242 ASSERT (bd_index == 0);
243 l2input_main.bd_configs[0].feature_bitmap = L2INPUT_FEAT_DROP;
249 VLIB_INIT_FUNCTION (l2bd_init);
252 bd_get (u32 bd_index)
254 if (bd_index < vec_len (l2input_main.bd_configs))
255 return (vec_elt_at_index (l2input_main.bd_configs, bd_index));
260 bd_input_walk (u32 bd_index, bd_input_walk_fn_t fn, void *data)
262 l2_flood_member_t *member;
263 l2_bridge_domain_t *bd;
267 bd = bd_get (bd_index);
271 vec_foreach (member, bd->members)
273 if (WALK_STOP == fn (bd_index, member->sw_if_index))
275 sw_if_index = member->sw_if_index;
280 return (sw_if_index);
284 b2_input_recache (u32 bd_index)
286 bd_input_walk (bd_index, l2input_recache, NULL);
290 Set the learn/forward/flood flags for the bridge domain.
291 Return 0 if ok, non-zero if for an error.
294 bd_set_flags (vlib_main_t * vm, u32 bd_index, bd_flags_t flags, u32 enable)
297 l2_bridge_domain_t *bd_config = l2input_bd_config (bd_index);
298 bd_validate (bd_config);
299 u32 feature_bitmap = 0;
301 if (flags & L2_LEARN)
303 feature_bitmap |= L2INPUT_FEAT_LEARN;
307 feature_bitmap |= L2INPUT_FEAT_FWD;
309 if (flags & L2_FLOOD)
311 feature_bitmap |= L2INPUT_FEAT_FLOOD;
313 if (flags & L2_UU_FLOOD)
315 feature_bitmap |= L2INPUT_FEAT_UU_FLOOD;
317 if (flags & L2_ARP_TERM)
319 feature_bitmap |= L2INPUT_FEAT_ARP_TERM;
321 if (flags & L2_ARP_UFWD)
323 feature_bitmap |= L2INPUT_FEAT_ARP_UFWD;
328 bd_config->feature_bitmap |= feature_bitmap;
332 bd_config->feature_bitmap &= ~feature_bitmap;
335 b2_input_recache (bd_index);
337 return bd_config->feature_bitmap;
341 Set the mac age for the bridge domain.
344 bd_set_mac_age (vlib_main_t * vm, u32 bd_index, u8 age)
346 l2_bridge_domain_t *bd_config;
349 vec_validate (l2input_main.bd_configs, bd_index);
350 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
351 bd_config->mac_age = age;
352 b2_input_recache (bd_index);
354 /* check if there is at least one bd with mac aging enabled */
355 vec_foreach (bd_config, l2input_main.bd_configs)
356 enable |= bd_config->bd_id != ~0 && bd_config->mac_age != 0;
358 vlib_process_signal_event (vm, l2fib_mac_age_scanner_process_node.index,
359 enable ? L2_MAC_AGE_PROCESS_EVENT_START :
360 L2_MAC_AGE_PROCESS_EVENT_STOP, 0);
364 Set learn limit for the bridge domain.
367 bd_set_learn_limit (vlib_main_t *vm, u32 bd_index, u32 learn_limit)
369 l2_bridge_domain_t *bd_config;
370 vec_validate (l2input_main.bd_configs, bd_index);
371 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
372 bd_config->learn_limit = learn_limit;
376 Set the tag for the bridge domain.
379 bd_set_bd_tag (vlib_main_t * vm, u32 bd_index, u8 * bd_tag)
382 l2_bridge_domain_t *bd_config;
383 vec_validate (l2input_main.bd_configs, bd_index);
384 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
386 old = bd_config->bd_tag;
390 bd_config->bd_tag = format (0, "%s%c", bd_tag, 0);
394 bd_config->bd_tag = NULL;
401 Set bridge-domain learn enable/disable.
403 set bridge-domain learn <bd_id> [disable]
405 static clib_error_t *
406 bd_learn (vlib_main_t * vm,
407 unformat_input_t * input, vlib_cli_command_t * cmd)
409 bd_main_t *bdm = &bd_main;
410 clib_error_t *error = 0;
415 if (!unformat (input, "%d", &bd_id))
417 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
418 format_unformat_error, input);
423 return clib_error_return (0,
424 "No operations on the default bridge domain are supported");
426 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
429 return clib_error_return (0, "No such bridge domain %d", bd_id);
434 if (unformat (input, "disable"))
439 /* set the bridge domain flag */
440 bd_set_flags (vm, bd_index, L2_LEARN, enable);
447 * Layer 2 learning can be enabled and disabled on each
448 * interface and on each bridge-domain. Use this command to
449 * manage bridge-domains. It is enabled by default.
452 * Example of how to enable learning (where 200 is the bridge-domain-id):
453 * @cliexcmd{set bridge-domain learn 200}
454 * Example of how to disable learning (where 200 is the bridge-domain-id):
455 * @cliexcmd{set bridge-domain learn 200 disable}
458 VLIB_CLI_COMMAND (bd_learn_cli, static) = {
459 .path = "set bridge-domain learn",
460 .short_help = "set bridge-domain learn <bridge-domain-id> [disable]",
461 .function = bd_learn,
465 static clib_error_t *
466 bd_default_learn_limit (vlib_main_t *vm, unformat_input_t *input,
467 vlib_cli_command_t *cmd)
469 l2learn_main_t *l2m = &l2learn_main;
470 clib_error_t *error = 0;
473 if (!unformat (input, "%d", &learn_limit))
475 error = clib_error_return (
476 0, "expecting per bridge-domain max entry number got`%U'",
477 format_unformat_error, input);
481 l2m->bd_default_learn_limit = learn_limit;
487 VLIB_CLI_COMMAND (bd_default_learn_limit_cli, static) = {
488 .path = "set bridge-domain default-learn-limit",
489 .short_help = "set bridge-domain default-learn-limit <maxentries>",
490 .function = bd_default_learn_limit,
494 Set bridge-domain forward enable/disable.
496 set bridge-domain forward <bd_index> [disable]
498 static clib_error_t *
499 bd_fwd (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
501 bd_main_t *bdm = &bd_main;
502 clib_error_t *error = 0;
507 if (!unformat (input, "%d", &bd_id))
509 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
510 format_unformat_error, input);
515 return clib_error_return (0,
516 "No operations on the default bridge domain are supported");
518 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
521 return clib_error_return (0, "No such bridge domain %d", bd_id);
526 if (unformat (input, "disable"))
531 /* set the bridge domain flag */
532 bd_set_flags (vm, bd_index, L2_FWD, enable);
540 * Layer 2 unicast forwarding can be enabled and disabled on each
541 * interface and on each bridge-domain. Use this command to
542 * manage bridge-domains. It is enabled by default.
545 * Example of how to enable forwarding (where 200 is the bridge-domain-id):
546 * @cliexcmd{set bridge-domain forward 200}
547 * Example of how to disable forwarding (where 200 is the bridge-domain-id):
548 * @cliexcmd{set bridge-domain forward 200 disable}
551 VLIB_CLI_COMMAND (bd_fwd_cli, static) = {
552 .path = "set bridge-domain forward",
553 .short_help = "set bridge-domain forward <bridge-domain-id> [disable]",
559 Set bridge-domain flood enable/disable.
561 set bridge-domain flood <bd_index> [disable]
563 static clib_error_t *
564 bd_flood (vlib_main_t * vm,
565 unformat_input_t * input, vlib_cli_command_t * cmd)
567 bd_main_t *bdm = &bd_main;
568 clib_error_t *error = 0;
573 if (!unformat (input, "%d", &bd_id))
575 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
576 format_unformat_error, input);
581 return clib_error_return (0,
582 "No operations on the default bridge domain are supported");
584 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
587 return clib_error_return (0, "No such bridge domain %d", bd_id);
592 if (unformat (input, "disable"))
597 /* set the bridge domain flag */
598 bd_set_flags (vm, bd_index, L2_FLOOD, enable);
605 * Layer 2 flooding can be enabled and disabled on each
606 * interface and on each bridge-domain. Use this command to
607 * manage bridge-domains. It is enabled by default.
610 * Example of how to enable flooding (where 200 is the bridge-domain-id):
611 * @cliexcmd{set bridge-domain flood 200}
612 * Example of how to disable flooding (where 200 is the bridge-domain-id):
613 * @cliexcmd{set bridge-domain flood 200 disable}
616 VLIB_CLI_COMMAND (bd_flood_cli, static) = {
617 .path = "set bridge-domain flood",
618 .short_help = "set bridge-domain flood <bridge-domain-id> [disable]",
619 .function = bd_flood,
624 Set bridge-domain unknown-unicast flood enable/disable.
626 set bridge-domain uu-flood <bd_index> [disable]
628 static clib_error_t *
629 bd_uu_flood (vlib_main_t * vm,
630 unformat_input_t * input, vlib_cli_command_t * cmd)
632 bd_main_t *bdm = &bd_main;
633 clib_error_t *error = 0;
638 if (!unformat (input, "%d", &bd_id))
640 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
641 format_unformat_error, input);
646 return clib_error_return (0,
647 "No operations on the default bridge domain are supported");
649 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
652 return clib_error_return (0, "No such bridge domain %d", bd_id);
657 if (unformat (input, "disable"))
662 /* set the bridge domain flag */
663 bd_set_flags (vm, bd_index, L2_UU_FLOOD, enable);
670 * Layer 2 unknown-unicast flooding can be enabled and disabled on each
671 * bridge-domain. It is enabled by default.
674 * Example of how to enable unknown-unicast flooding (where 200 is the
676 * @cliexcmd{set bridge-domain uu-flood 200}
677 * Example of how to disable unknown-unicast flooding (where 200 is the bridge-domain-id):
678 * @cliexcmd{set bridge-domain uu-flood 200 disable}
681 VLIB_CLI_COMMAND (bd_uu_flood_cli, static) = {
682 .path = "set bridge-domain uu-flood",
683 .short_help = "set bridge-domain uu-flood <bridge-domain-id> [disable]",
684 .function = bd_uu_flood,
689 Set bridge-domain arp-unicast forward enable/disable.
691 set bridge-domain arp-ufwd <bd_index> [disable]
693 static clib_error_t *
694 bd_arp_ufwd (vlib_main_t * vm,
695 unformat_input_t * input, vlib_cli_command_t * cmd)
697 bd_main_t *bdm = &bd_main;
698 clib_error_t *error = 0;
703 if (!unformat (input, "%d", &bd_id))
705 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
706 format_unformat_error, input);
711 return clib_error_return (0,
712 "No operations on the default bridge domain are supported");
714 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
717 return clib_error_return (0, "No such bridge domain %d", bd_id);
722 if (unformat (input, "disable"))
727 /* set the bridge domain flag */
728 bd_set_flags (vm, bd_index, L2_ARP_UFWD, enable);
735 * Layer 2 arp-unicast forwarding can be enabled and disabled on each
736 * bridge-domain. It is disabled by default.
739 * Example of how to enable arp-unicast forwarding (where 200 is the
741 * @cliexcmd{set bridge-domain arp-ufwd 200}
742 * Example of how to disable arp-unicast forwarding (where 200 is the bridge-domain-id):
743 * @cliexcmd{set bridge-domain arp-ufwd 200 disable}
746 VLIB_CLI_COMMAND (bd_arp_ufwd_cli, static) = {
747 .path = "set bridge-domain arp-ufwd",
748 .short_help = "set bridge-domain arp-ufwd <bridge-domain-id> [disable]",
749 .function = bd_arp_ufwd,
754 Set bridge-domain arp term enable/disable.
756 set bridge-domain arp term <bridge-domain-id> [disable]
758 static clib_error_t *
759 bd_arp_term (vlib_main_t * vm,
760 unformat_input_t * input, vlib_cli_command_t * cmd)
762 bd_main_t *bdm = &bd_main;
763 clib_error_t *error = 0;
768 if (!unformat (input, "%d", &bd_id))
770 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
771 format_unformat_error, input);
776 return clib_error_return (0,
777 "No operations on the default bridge domain are supported");
779 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
783 return clib_error_return (0, "No such bridge domain %d", bd_id);
786 if (unformat (input, "disable"))
789 /* set the bridge domain flag */
790 bd_set_flags (vm, bd_index, L2_ARP_TERM, enable);
796 static clib_error_t *
797 bd_mac_age (vlib_main_t * vm,
798 unformat_input_t * input, vlib_cli_command_t * cmd)
800 bd_main_t *bdm = &bd_main;
801 clib_error_t *error = 0;
806 if (!unformat (input, "%d", &bd_id))
808 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
809 format_unformat_error, input);
814 return clib_error_return (0,
815 "No operations on the default bridge domain are supported");
817 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
820 return clib_error_return (0, "No such bridge domain %d", bd_id);
824 if (!unformat (input, "%u", &age))
827 clib_error_return (0, "expecting ageing time in minutes but got `%U'",
828 format_unformat_error, input);
832 /* set the bridge domain flag */
836 clib_error_return (0, "mac aging time cannot be bigger than 255");
839 bd_set_mac_age (vm, bd_index, (u8) age);
846 * Layer 2 mac aging can be enabled and disabled on each
847 * bridge-domain. Use this command to set or disable mac aging
848 * on specific bridge-domains. It is disabled by default.
851 * Example of how to set mac aging (where 200 is the bridge-domain-id and
852 * 5 is aging time in minutes):
853 * @cliexcmd{set bridge-domain mac-age 200 5}
854 * Example of how to disable mac aging (where 200 is the bridge-domain-id):
855 * @cliexcmd{set bridge-domain flood 200 0}
858 VLIB_CLI_COMMAND (bd_mac_age_cli, static) = {
859 .path = "set bridge-domain mac-age",
860 .short_help = "set bridge-domain mac-age <bridge-domain-id> <mins>",
861 .function = bd_mac_age,
865 static clib_error_t *
866 bd_learn_limit (vlib_main_t *vm, unformat_input_t *input,
867 vlib_cli_command_t *cmd)
869 bd_main_t *bdm = &bd_main;
870 clib_error_t *error = 0;
875 if (!unformat (input, "%d", &bd_id))
877 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
878 format_unformat_error, input);
883 return clib_error_return (
884 0, "No operations on the default bridge domain are supported");
886 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
889 return clib_error_return (0, "No such bridge domain %d", bd_id);
893 if (!unformat (input, "%u", &learn_limit))
895 error = clib_error_return (
896 0, "expecting maxium number of learned entries but got `%U'",
897 format_unformat_error, input);
901 bd_set_learn_limit (vm, bd_index, learn_limit);
907 VLIB_CLI_COMMAND (bd_learn_limit_cli, static) = {
908 .path = "set bridge-domain learn-limit",
910 "set bridge-domain learn-limit <bridge-domain-id> <learn-limit>",
911 .function = bd_learn_limit,
915 * Modify whether or not an existing bridge-domain should terminate and respond
916 * to ARP Requests. ARP Termination is disabled by default.
919 * Example of how to enable ARP termination (where 200 is the bridge-domain-id):
920 * @cliexcmd{set bridge-domain arp term 200}
921 * Example of how to disable ARP termination (where 200 is the bridge-domain-id):
922 * @cliexcmd{set bridge-domain arp term 200 disable}
925 VLIB_CLI_COMMAND (bd_arp_term_cli, static) = {
926 .path = "set bridge-domain arp term",
927 .short_help = "set bridge-domain arp term <bridge-domain-id> [disable]",
928 .function = bd_arp_term,
934 * Add/delete IP address to MAC address mapping.
936 * The clib hash implementation stores uword entries in the hash table.
937 * The hash table mac_by_ip4 is keyed via IP4 address and store the
938 * 6-byte MAC address directly in the hash table entry uword.
940 * @warning This only works for 64-bit processor with 8-byte uword;
941 * which means this code *WILL NOT WORK* for a 32-bit processor with
945 bd_add_del_ip_mac (u32 bd_index,
947 const ip46_address_t * ip,
948 const mac_address_t * mac, u8 is_add)
950 l2_bridge_domain_t *bd_cfg = l2input_bd_config (bd_index);
951 u64 new_mac = mac_address_as_u64 (mac);
954 /* make sure uword is 8 bytes */
955 ASSERT (sizeof (uword) == sizeof (u64));
956 ASSERT (bd_is_valid (bd_cfg));
958 if (IP46_TYPE_IP6 == type)
960 ip6_address_t *ip6_addr_key;
962 old_mac = (u64 *) hash_get_mem (bd_cfg->mac_by_ip6, &ip->ip6);
967 /* new entry - allocate and create ip6 address key */
968 ip6_addr_key = clib_mem_alloc (sizeof (ip6_address_t));
969 clib_memcpy (ip6_addr_key, &ip->ip6, sizeof (ip6_address_t));
971 else if (*old_mac == new_mac)
973 /* same mac entry already exist for ip6 address */
978 /* update mac for ip6 address */
979 hp = hash_get_pair (bd_cfg->mac_by_ip6, &ip->ip6);
980 ip6_addr_key = (ip6_address_t *) hp->key;
982 hash_set_mem (bd_cfg->mac_by_ip6, ip6_addr_key, new_mac);
986 if (old_mac && (*old_mac == new_mac))
988 hp = hash_get_pair (bd_cfg->mac_by_ip6, &ip->ip6);
989 ip6_addr_key = (ip6_address_t *) hp->key;
990 hash_unset_mem (bd_cfg->mac_by_ip6, &ip->ip6);
991 clib_mem_free (ip6_addr_key);
999 old_mac = (u64 *) hash_get (bd_cfg->mac_by_ip4, ip->ip4.as_u32);
1002 if (old_mac && (*old_mac == new_mac))
1003 /* mac entry already exist */
1005 hash_set (bd_cfg->mac_by_ip4, ip->ip4.as_u32, new_mac);
1009 if (old_mac && (*old_mac == new_mac))
1010 hash_unset (bd_cfg->mac_by_ip4, ip->ip4.as_u32);
1019 * Flush IP address to MAC address mapping tables in a BD.
1022 bd_flush_ip_mac (u32 bd_index)
1024 l2_bridge_domain_t *bd = l2input_bd_config (bd_index);
1025 ASSERT (bd_is_valid (bd));
1026 bd_free_ip_mac_tables (bd);
1029 hash_create_mem (0, sizeof (ip6_address_t), sizeof (uword));
1033 Set bridge-domain arp entry add/delete.
1035 set bridge-domain arp entry <bridge-domain-id> <ip-addr> <mac-addr> [del]
1037 static clib_error_t *
1038 bd_arp_entry (vlib_main_t * vm,
1039 unformat_input_t * input, vlib_cli_command_t * cmd)
1041 ip46_address_t ip_addr = ip46_address_initializer;
1042 ip46_type_t type = IP46_TYPE_IP4;
1043 bd_main_t *bdm = &bd_main;
1044 clib_error_t *error = 0;
1045 u32 bd_index, bd_id;
1050 if (!unformat (input, "%d", &bd_id))
1052 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
1053 format_unformat_error, input);
1058 return clib_error_return (0,
1059 "No operations on the default bridge domain are supported");
1061 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
1066 return clib_error_return (0, "No such bridge domain %d", bd_id);
1068 if (unformat (input, "%U", unformat_ip4_address, &ip_addr.ip4))
1070 type = IP46_TYPE_IP4;
1072 else if (unformat (input, "%U", unformat_ip6_address, &ip_addr.ip6))
1074 type = IP46_TYPE_IP6;
1076 else if (unformat (input, "del-all"))
1078 bd_flush_ip_mac (bd_index);
1083 error = clib_error_return (0, "expecting IP address but got `%U'",
1084 format_unformat_error, input);
1088 if (!unformat (input, "%U", unformat_mac_address_t, &mac))
1090 error = clib_error_return (0, "expecting MAC address but got `%U'",
1091 format_unformat_error, input);
1095 if (unformat (input, "del"))
1100 /* set the bridge domain flagAdd IP-MAC entry into bridge domain */
1101 if (bd_add_del_ip_mac (bd_index, type, &ip_addr, &mac, is_add))
1103 error = clib_error_return (0, "MAC %s for IP %U and MAC %U failed",
1104 is_add ? "add" : "del",
1105 format_ip46_address, &ip_addr, IP46_TYPE_ANY,
1106 format_mac_address_t, &mac);
1114 * Add an ARP entry to an existing bridge-domain.
1117 * Example of how to add an ARP entry (where 200 is the bridge-domain-id):
1118 * @cliexcmd{set bridge-domain arp entry 200 192.168.72.45 52:54:00:3b:83:1a}
1119 * Example of how to delete an ARP entry (where 200 is the bridge-domain-id):
1120 * @cliexcmd{set bridge-domain arp entry 200 192.168.72.45 52:54:00:3b:83:1a del}
1123 VLIB_CLI_COMMAND (bd_arp_entry_cli, static) = {
1124 .path = "set bridge-domain arp entry",
1125 .short_help = "set bridge-domain arp entry <bridge-domain-id> [<ip-addr> <mac-addr> [del] | del-all]",
1126 .function = bd_arp_entry,
1131 format_uu_cfg (u8 * s, va_list * args)
1133 l2_bridge_domain_t *bd_config = va_arg (*args, l2_bridge_domain_t *);
1135 if (bd_config->feature_bitmap & L2INPUT_FEAT_UU_FWD)
1136 return (format (s, "%U", format_vnet_sw_if_index_name_with_NA,
1137 vnet_get_main (), bd_config->uu_fwd_sw_if_index));
1138 else if (bd_config->feature_bitmap & L2INPUT_FEAT_UU_FLOOD)
1139 return (format (s, "flood"));
1141 return (format (s, "drop"));
1145 Show bridge-domain state.
1147 show bridge-domain [<bd_index>]
1149 static clib_error_t *
1150 bd_show (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
1152 vnet_main_t *vnm = vnet_get_main ();
1153 bd_main_t *bdm = &bd_main;
1154 clib_error_t *error = 0;
1156 l2_bridge_domain_t *bd_config;
1166 end = vec_len (l2input_main.bd_configs);
1168 if (unformat (input, "%d", &bd_id))
1170 if (unformat (input, "detail"))
1172 else if (unformat (input, "det"))
1174 if (unformat (input, "int"))
1176 if (unformat (input, "arp"))
1178 if (unformat (input, "bd-tag"))
1182 return clib_error_return (0,
1183 "No operations on the default bridge domain are supported");
1185 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
1189 return clib_error_return (0, "No such bridge domain %d", bd_id);
1191 vec_validate (l2input_main.bd_configs, bd_index);
1192 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
1193 if (bd_is_valid (bd_config))
1200 vlib_cli_output (vm, "bridge-domain %d not in use", bd_id);
1205 /* Show all bridge-domains that have been initialized */
1208 for (bd_index = start; bd_index < end; bd_index++)
1210 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
1211 if (bd_is_valid (bd_config))
1216 vlib_cli_output (vm,
1217 "%=8s %=7s %=4s %=9s %=9s %=9s %=11s %=9s %=9s "
1218 "%=9s %=8s %=8s %=11s",
1219 "BD-ID", "Index", "BSN", "Age(min)", "Learning",
1220 "U-Forwrd", "UU-Flood", "Flooding", "ARP-Term",
1221 "arp-ufwd", "Learn-count", "Learn-limit",
1225 if (bd_config->mac_age)
1226 as = format (as, "%d", bd_config->mac_age);
1228 as = format (as, "off");
1231 "%=8d %=7d %=4d %=9v %=9s %=9s %=11U %=9s %=9s %=9s %=8d %=8d "
1233 bd_config->bd_id, bd_index, bd_config->seq_num, as,
1234 bd_config->feature_bitmap & L2INPUT_FEAT_LEARN ? "on" : "off",
1235 bd_config->feature_bitmap & L2INPUT_FEAT_FWD ? "on" : "off",
1236 format_uu_cfg, bd_config,
1237 bd_config->feature_bitmap & L2INPUT_FEAT_FLOOD ? "on" : "off",
1238 bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM ? "on" : "off",
1239 bd_config->feature_bitmap & L2INPUT_FEAT_ARP_UFWD ? "on" : "off",
1240 bd_config->learn_count, bd_config->learn_limit,
1241 format_vnet_sw_if_index_name_with_NA, vnm,
1242 bd_config->bvi_sw_if_index);
1244 vlib_cli_output (vm, "%U", format_l2_input_feature_bitmap,
1245 bd_config->feature_bitmap);
1246 vec_reset_length (as);
1250 /* Show all member interfaces */
1252 vec_foreach_index (i, bd_config->members)
1254 l2_flood_member_t *member =
1255 vec_elt_at_index (bd_config->members, i);
1256 u8 swif_seq_num = l2_input_seq_num (member->sw_if_index);
1257 u32 vtr_opr, dot1q, tag1, tag2;
1260 vlib_cli_output (vm, "\n%=30s%=7s%=5s%=5s%=5s%=9s%=30s",
1261 "Interface", "If-idx", "ISN", "SHG",
1262 "BVI", "TxFlood", "VLAN-Tag-Rewrite");
1264 l2vtr_get (vm, vnm, member->sw_if_index, &vtr_opr, &dot1q,
1266 vlib_cli_output (vm, "%=30U%=7d%=5d%=5d%=5s%=9s%=30U",
1267 format_vnet_sw_if_index_name, vnm,
1268 member->sw_if_index, member->sw_if_index,
1269 swif_seq_num, member->shg,
1270 member->flags & L2_FLOOD_MEMBER_BVI ? "*" :
1271 "-", i < bd_config->flood_count ? "*" : "-",
1272 format_vtr, vtr_opr, dot1q, tag1, tag2);
1274 if (~0 != bd_config->uu_fwd_sw_if_index)
1275 vlib_cli_output (vm, "%=30U%=7d%=5d%=5d%=5s%=9s%=30s",
1276 format_vnet_sw_if_index_name, vnm,
1277 bd_config->uu_fwd_sw_if_index,
1278 bd_config->uu_fwd_sw_if_index,
1279 0, 0, "uu", "-", "None");
1283 if ((detail || arp) &&
1284 (bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM))
1287 ip6_address_t *ip6_addr;
1289 vlib_cli_output (vm,
1290 "\n IP4/IP6 to MAC table for ARP Termination");
1293 hash_foreach (ip4_addr, mac_addr, bd_config->mac_by_ip4,
1295 vlib_cli_output (vm, "%=40U => %=20U",
1296 format_ip4_address, &ip4_addr,
1297 format_ethernet_address, &mac_addr);
1300 hash_foreach_mem (ip6_addr, mac_addr, bd_config->mac_by_ip6,
1302 vlib_cli_output (vm, "%=40U => %=20U",
1303 format_ip6_address, ip6_addr,
1304 format_ethernet_address, &mac_addr);
1309 if ((detail || bd_tag) && (bd_config->bd_tag))
1311 vlib_cli_output (vm, "\n BD-Tag: %s", bd_config->bd_tag);
1320 vlib_cli_output (vm, "no bridge-domains in use");
1328 * Show a summary of all the bridge-domain instances or detailed view of a
1329 * single bridge-domain. Bridge-domains are created by adding an interface
1330 * to a bridge using the '<em>set interface l2 bridge</em>' command.
1334 * Example of displaying all bridge-domains:
1335 * @cliexstart{show bridge-domain}
1336 * ID Index Learning U-Forwrd UU-Flood Flooding ARP-Term BVI-Intf
1337 * 0 0 off off off off off local0
1338 * 200 1 on on on on off N/A
1341 * Example of displaying details of a single bridge-domains:
1342 * @cliexstart{show bridge-domain 200 detail}
1343 * ID Index Learning U-Forwrd UU-Flood Flooding ARP-Term BVI-Intf
1344 * 200 1 on on on on off N/A
1346 * Interface Index SHG BVI VLAN-Tag-Rewrite
1347 * GigabitEthernet0/8/0.200 3 0 - none
1348 * GigabitEthernet0/9/0.200 4 0 - none
1353 VLIB_CLI_COMMAND (bd_show_cli, static) = {
1354 .path = "show bridge-domain",
1355 .short_help = "show bridge-domain [bridge-domain-id [detail|int|arp|bd-tag]]",
1356 .function = bd_show,
1361 bd_add_del (l2_bridge_domain_add_del_args_t * a)
1363 bd_main_t *bdm = &bd_main;
1364 l2fib_main_t *fm = &l2fib_main;
1365 vlib_main_t *vm = bdm->vlib_main;
1368 if (fm->mac_table_initialized == 0)
1369 l2fib_table_init ();
1371 u32 bd_index = bd_find_index (bdm, a->bd_id);
1375 return VNET_API_ERROR_BD_ALREADY_EXISTS;
1376 if (a->bd_id > L2_BD_ID_MAX)
1377 return VNET_API_ERROR_BD_ID_EXCEED_MAX;
1378 bd_index = bd_add_bd_index (bdm, a->bd_id);
1380 bd_flags_t enable_flags = 0, disable_flags = 0;
1382 enable_flags |= L2_FLOOD;
1384 disable_flags |= L2_FLOOD;
1387 enable_flags |= L2_UU_FLOOD;
1389 disable_flags |= L2_UU_FLOOD;
1392 enable_flags |= L2_FWD;
1394 disable_flags |= L2_FWD;
1397 enable_flags |= L2_LEARN;
1399 disable_flags |= L2_LEARN;
1402 enable_flags |= L2_ARP_TERM;
1404 disable_flags |= L2_ARP_TERM;
1407 enable_flags |= L2_ARP_UFWD;
1409 disable_flags |= L2_ARP_UFWD;
1412 bd_set_flags (vm, bd_index, enable_flags, 1 /* enable */ );
1415 bd_set_flags (vm, bd_index, disable_flags, 0 /* disable */ );
1417 bd_set_mac_age (vm, bd_index, a->mac_age);
1420 bd_set_bd_tag (vm, bd_index, a->bd_tag);
1422 bd_set_learn_limit (vm, bd_index, l2learn_main.bd_default_learn_limit);
1423 vec_elt_at_index (l2input_main.bd_configs, bd_index)->learn_count = 0;
1428 return VNET_API_ERROR_NO_SUCH_ENTRY;
1430 return VNET_API_ERROR_BD_NOT_MODIFIABLE;
1431 if (vec_len (l2input_main.bd_configs[bd_index].members))
1432 return VNET_API_ERROR_BD_IN_USE;
1433 rv = bd_delete (bdm, bd_index);
1440 Create or delete bridge-domain.
1442 create bridge-domain <bd_index> [learn <0|1>] [forward <0|1>] [uu-flood <0|1>] [flood <0|1>]
1443 [arp-term <0|1>] [mac-age <nn>] [bd-tag <tag>] [del]
1446 static clib_error_t *
1447 bd_add_del_command_fn (vlib_main_t * vm, unformat_input_t * input,
1448 vlib_cli_command_t * cmd)
1450 unformat_input_t _line_input, *line_input = &_line_input;
1451 clib_error_t *error = 0;
1454 u32 flood = 1, forward = 1, learn = 1, uu_flood = 1, arp_term =
1458 l2_bridge_domain_add_del_args_t _a, *a = &_a;
1461 /* Get a line of input. */
1462 if (!unformat_user (input, unformat_line_input, line_input))
1465 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1467 if (unformat (line_input, "%d", &bd_id))
1469 else if (unformat (line_input, "flood %d", &flood))
1471 else if (unformat (line_input, "uu-flood %d", &uu_flood))
1473 else if (unformat (line_input, "forward %d", &forward))
1475 else if (unformat (line_input, "learn %d", &learn))
1477 else if (unformat (line_input, "arp-term %d", &arp_term))
1479 else if (unformat (line_input, "arp-ufwd %d", &arp_ufwd))
1481 else if (unformat (line_input, "mac-age %d", &mac_age))
1483 else if (unformat (line_input, "bd-tag %s", &bd_tag))
1485 else if (unformat (line_input, "del"))
1488 flood = uu_flood = forward = learn = 0;
1496 error = clib_error_return (0, "bridge-domain-id not specified");
1502 error = clib_error_return (0, "bridge domain 0 can not be modified");
1508 error = clib_error_return (0, "mac age must be less than 256");
1511 if ((bd_tag) && (strlen ((char *) bd_tag) > 63))
1513 error = clib_error_return (0, "bd-tag cannot be longer than 63");
1517 clib_memset (a, 0, sizeof (*a));
1520 a->flood = (u8) flood;
1521 a->uu_flood = (u8) uu_flood;
1522 a->forward = (u8) forward;
1523 a->learn = (u8) learn;
1524 a->arp_term = (u8) arp_term;
1525 a->arp_ufwd = (u8) arp_ufwd;
1526 a->mac_age = (u8) mac_age;
1529 rv = bd_add_del (a);
1535 vlib_cli_output (vm, "bridge-domain %d", bd_id);
1537 case VNET_API_ERROR_BD_IN_USE:
1538 error = clib_error_return (0, "bridge domain in use - remove members");
1540 case VNET_API_ERROR_NO_SUCH_ENTRY:
1541 error = clib_error_return (0, "bridge domain ID does not exist");
1543 case VNET_API_ERROR_BD_NOT_MODIFIABLE:
1544 error = clib_error_return (0, "bridge domain 0 can not be modified");
1546 case VNET_API_ERROR_BD_ID_EXCEED_MAX:
1547 error = clib_error_return (0, "bridge domain ID exceed 16M limit");
1550 error = clib_error_return (0, "bd_add_del returned %d", rv);
1556 unformat_free (line_input);
1563 * Create/Delete bridge-domain instance
1567 * Example of creating bridge-domain 1:
1568 * @cliexstart{create bridge-domain 1}
1572 * Example of creating bridge-domain 2 with enabling arp-term, mac-age 60:
1573 * @cliexstart{create bridge-domain 2 arp-term 1 mac-age 60}
1576 * vpp# show bridge-domain
1577 * ID Index BSN Age(min) Learning U-Forwrd UU-Flood Flooding ARP-Term BVI-Intf
1578 * 0 0 0 off off off off off off local0
1579 * 1 1 0 off on on off on off N/A
1580 * 2 2 0 60 on on off on on N/A
1584 * Example of delete bridge-domain 1:
1585 * @cliexstart{create bridge-domain 1 del}
1591 VLIB_CLI_COMMAND (bd_create_cli, static) = {
1592 .path = "create bridge-domain",
1593 .short_help = "create bridge-domain <bridge-domain-id>"
1594 " [learn <0|1>] [forward <0|1>] [uu-flood <0|1>] [flood <0|1>] [arp-term <0|1>]"
1595 " [arp-ufwd <0|1>] [mac-age <nn>] [bd-tag <tag>] [del]",
1596 .function = bd_add_del_command_fn,
1603 * fd.io coding-style-patch-verification: ON
1606 * eval: (c-set-style "gnu")