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 = ~L2INPUT_FEAT_ARP_TERM;
56 bd_config->bvi_sw_if_index = ~0;
57 bd_config->members = 0;
58 bd_config->flood_count = 0;
59 bd_config->tun_master_count = 0;
60 bd_config->tun_normal_count = 0;
61 bd_config->mac_by_ip4 = 0;
62 bd_config->mac_by_ip6 = hash_create_mem (0, sizeof (ip6_address_t),
67 bd_find_index (bd_main_t * bdm, u32 bd_id)
69 u32 *p = (u32 *) hash_get (bdm->bd_index_by_bd_id, bd_id);
76 bd_add_bd_index (bd_main_t * bdm, u32 bd_id)
78 ASSERT (!hash_get (bdm->bd_index_by_bd_id, bd_id));
79 u32 rv = clib_bitmap_first_clear (bdm->bd_index_bitmap);
81 /* mark this index taken */
82 bdm->bd_index_bitmap = clib_bitmap_set (bdm->bd_index_bitmap, rv, 1);
84 hash_set (bdm->bd_index_by_bd_id, bd_id, rv);
86 vec_validate (l2input_main.bd_configs, rv);
87 l2input_main.bd_configs[rv].bd_id = bd_id;
93 bd_delete (bd_main_t * bdm, u32 bd_index)
95 l2_bridge_domain_t *bd = &l2input_main.bd_configs[bd_index];
96 u32 bd_id = bd->bd_id;
98 ip6_address_t *ip6_addr_key;
100 /* flush non-static MACs in BD and removed bd_id from hash table */
101 l2fib_flush_bd_mac (vlib_get_main (), bd_index);
102 hash_unset (bdm->bd_index_by_bd_id, bd_id);
104 /* mark this index clear */
105 bdm->bd_index_bitmap = clib_bitmap_set (bdm->bd_index_bitmap, bd_index, 0);
107 /* clear BD config for reuse: bd_id to -1 and clear feature_bitmap */
109 bd->feature_bitmap = 0;
112 vec_free (bd->bd_tag);
114 /* free memory used by BD */
115 vec_free (bd->members);
116 hash_free (bd->mac_by_ip4);
118 hash_foreach_mem (ip6_addr_key, mac_addr, bd->mac_by_ip6,
120 clib_mem_free (ip6_addr_key); /* free memory used for ip6 addr key */
123 hash_free (bd->mac_by_ip6);
129 update_flood_count (l2_bridge_domain_t * bd_config)
131 bd_config->flood_count = (vec_len (bd_config->members) -
132 (bd_config->tun_master_count ?
133 bd_config->tun_normal_count : 0));
134 bd_config->flood_count -= bd_config->no_flood_count;
138 bd_add_member (l2_bridge_domain_t * bd_config, l2_flood_member_t * member)
141 vnet_sw_interface_t *sw_if = vnet_get_sw_interface
142 (vnet_get_main (), member->sw_if_index);
145 * Add one element to the vector
146 * vector is ordered [ bvi, normal/tun_masters..., tun_normals... no_flood]
147 * When flooding, the bvi interface (if present) must be the last member
148 * processed due to how BVI processing can change the packet. To enable
149 * this order, we make the bvi interface the first in the vector and
150 * flooding walks the vector in reverse. The flood-count determines where
151 * in the member list to start the walk from.
153 switch (sw_if->flood_class)
155 case VNET_FLOOD_CLASS_NO_FLOOD:
156 bd_config->no_flood_count++;
157 ix = vec_len (bd_config->members);
159 case VNET_FLOOD_CLASS_BVI:
162 case VNET_FLOOD_CLASS_TUNNEL_MASTER:
163 bd_config->tun_master_count++;
165 case VNET_FLOOD_CLASS_NORMAL:
166 ix = (vec_len (bd_config->members) -
167 bd_config->tun_normal_count - bd_config->no_flood_count);
169 case VNET_FLOOD_CLASS_TUNNEL_NORMAL:
170 ix = (vec_len (bd_config->members) - bd_config->no_flood_count);
171 bd_config->tun_normal_count++;
175 vec_insert_elts (bd_config->members, member, 1, ix);
176 update_flood_count (bd_config);
179 #define BD_REMOVE_ERROR_OK 0
180 #define BD_REMOVE_ERROR_NOT_FOUND 1
183 bd_remove_member (l2_bridge_domain_t * bd_config, u32 sw_if_index)
187 /* Find and delete the member */
188 vec_foreach_index (ix, bd_config->members)
190 l2_flood_member_t *m = vec_elt_at_index (bd_config->members, ix);
191 if (m->sw_if_index == sw_if_index)
193 vnet_sw_interface_t *sw_if = vnet_get_sw_interface
194 (vnet_get_main (), sw_if_index);
196 if (sw_if->flood_class != VNET_FLOOD_CLASS_NORMAL)
198 if (sw_if->flood_class == VNET_FLOOD_CLASS_TUNNEL_MASTER)
199 bd_config->tun_master_count--;
200 else if (sw_if->flood_class == VNET_FLOOD_CLASS_TUNNEL_NORMAL)
201 bd_config->tun_normal_count--;
203 vec_delete (bd_config->members, 1, ix);
204 update_flood_count (bd_config);
206 return BD_REMOVE_ERROR_OK;
210 return BD_REMOVE_ERROR_NOT_FOUND;
215 l2bd_init (vlib_main_t * vm)
217 bd_main_t *bdm = &bd_main;
218 bdm->bd_index_by_bd_id = hash_create (0, sizeof (uword));
220 * create a dummy bd with bd_id of 0 and bd_index of 0 with feature set
221 * to packet drop only. Thus, packets received from any L2 interface with
222 * uninitialized bd_index of 0 can be dropped safely.
224 u32 bd_index = bd_add_bd_index (bdm, 0);
225 ASSERT (bd_index == 0);
226 l2input_main.bd_configs[0].feature_bitmap = L2INPUT_FEAT_DROP;
232 VLIB_INIT_FUNCTION (l2bd_init);
236 Set the learn/forward/flood flags for the bridge domain.
237 Return 0 if ok, non-zero if for an error.
240 bd_set_flags (vlib_main_t * vm, u32 bd_index, u32 flags, u32 enable)
243 l2_bridge_domain_t *bd_config = l2input_bd_config (bd_index);
244 bd_validate (bd_config);
245 u32 feature_bitmap = 0;
247 if (flags & L2_LEARN)
249 feature_bitmap |= L2INPUT_FEAT_LEARN;
253 feature_bitmap |= L2INPUT_FEAT_FWD;
255 if (flags & L2_FLOOD)
257 feature_bitmap |= L2INPUT_FEAT_FLOOD;
259 if (flags & L2_UU_FLOOD)
261 feature_bitmap |= L2INPUT_FEAT_UU_FLOOD;
263 if (flags & L2_ARP_TERM)
265 feature_bitmap |= L2INPUT_FEAT_ARP_TERM;
270 bd_config->feature_bitmap |= feature_bitmap;
274 bd_config->feature_bitmap &= ~feature_bitmap;
277 return bd_config->feature_bitmap;
281 Set the mac age for the bridge domain.
284 bd_set_mac_age (vlib_main_t * vm, u32 bd_index, u8 age)
286 l2_bridge_domain_t *bd_config;
289 vec_validate (l2input_main.bd_configs, bd_index);
290 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
291 bd_config->mac_age = age;
293 /* check if there is at least one bd with mac aging enabled */
294 vec_foreach (bd_config, l2input_main.bd_configs)
295 enable |= bd_config->bd_id != ~0 && bd_config->mac_age != 0;
297 vlib_process_signal_event (vm, l2fib_mac_age_scanner_process_node.index,
298 enable ? L2_MAC_AGE_PROCESS_EVENT_START :
299 L2_MAC_AGE_PROCESS_EVENT_STOP, 0);
303 Set the tag for the bridge domain.
307 bd_set_bd_tag (vlib_main_t * vm, u32 bd_index, u8 * bd_tag)
310 l2_bridge_domain_t *bd_config;
311 vec_validate (l2input_main.bd_configs, bd_index);
312 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
314 old = bd_config->bd_tag;
318 bd_config->bd_tag = format (0, "%s%c", bd_tag, 0);
322 bd_config->bd_tag = NULL;
329 Set bridge-domain learn enable/disable.
331 set bridge-domain learn <bd_id> [disable]
333 static clib_error_t *
334 bd_learn (vlib_main_t * vm,
335 unformat_input_t * input, vlib_cli_command_t * cmd)
337 bd_main_t *bdm = &bd_main;
338 clib_error_t *error = 0;
343 if (!unformat (input, "%d", &bd_id))
345 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
346 format_unformat_error, input);
351 return clib_error_return (0,
352 "No operations on the default bridge domain are supported");
354 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
357 return clib_error_return (0, "No such bridge domain %d", bd_id);
362 if (unformat (input, "disable"))
367 /* set the bridge domain flag */
368 bd_set_flags (vm, bd_index, L2_LEARN, enable);
375 * Layer 2 learning can be enabled and disabled on each
376 * interface and on each bridge-domain. Use this command to
377 * manage bridge-domains. It is enabled by default.
380 * Example of how to enable learning (where 200 is the bridge-domain-id):
381 * @cliexcmd{set bridge-domain learn 200}
382 * Example of how to disable learning (where 200 is the bridge-domain-id):
383 * @cliexcmd{set bridge-domain learn 200 disable}
386 VLIB_CLI_COMMAND (bd_learn_cli, static) = {
387 .path = "set bridge-domain learn",
388 .short_help = "set bridge-domain learn <bridge-domain-id> [disable]",
389 .function = bd_learn,
394 Set bridge-domain forward enable/disable.
396 set bridge-domain forward <bd_index> [disable]
398 static clib_error_t *
399 bd_fwd (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
401 bd_main_t *bdm = &bd_main;
402 clib_error_t *error = 0;
407 if (!unformat (input, "%d", &bd_id))
409 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
410 format_unformat_error, input);
415 return clib_error_return (0,
416 "No operations on the default bridge domain are supported");
418 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
421 return clib_error_return (0, "No such bridge domain %d", bd_id);
426 if (unformat (input, "disable"))
431 /* set the bridge domain flag */
432 bd_set_flags (vm, bd_index, L2_FWD, enable);
440 * Layer 2 unicast forwarding can be enabled and disabled on each
441 * interface and on each bridge-domain. Use this command to
442 * manage bridge-domains. It is enabled by default.
445 * Example of how to enable forwarding (where 200 is the bridge-domain-id):
446 * @cliexcmd{set bridge-domain forward 200}
447 * Example of how to disable forwarding (where 200 is the bridge-domain-id):
448 * @cliexcmd{set bridge-domain forward 200 disable}
451 VLIB_CLI_COMMAND (bd_fwd_cli, static) = {
452 .path = "set bridge-domain forward",
453 .short_help = "set bridge-domain forward <bridge-domain-id> [disable]",
459 Set bridge-domain flood enable/disable.
461 set bridge-domain flood <bd_index> [disable]
463 static clib_error_t *
464 bd_flood (vlib_main_t * vm,
465 unformat_input_t * input, vlib_cli_command_t * cmd)
467 bd_main_t *bdm = &bd_main;
468 clib_error_t *error = 0;
473 if (!unformat (input, "%d", &bd_id))
475 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
476 format_unformat_error, input);
481 return clib_error_return (0,
482 "No operations on the default bridge domain are supported");
484 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
487 return clib_error_return (0, "No such bridge domain %d", bd_id);
492 if (unformat (input, "disable"))
497 /* set the bridge domain flag */
498 bd_set_flags (vm, bd_index, L2_FLOOD, enable);
505 * Layer 2 flooding can be enabled and disabled on each
506 * interface and on each bridge-domain. Use this command to
507 * manage bridge-domains. It is enabled by default.
510 * Example of how to enable flooding (where 200 is the bridge-domain-id):
511 * @cliexcmd{set bridge-domain flood 200}
512 * Example of how to disable flooding (where 200 is the bridge-domain-id):
513 * @cliexcmd{set bridge-domain flood 200 disable}
516 VLIB_CLI_COMMAND (bd_flood_cli, static) = {
517 .path = "set bridge-domain flood",
518 .short_help = "set bridge-domain flood <bridge-domain-id> [disable]",
519 .function = bd_flood,
524 Set bridge-domain unknown-unicast flood enable/disable.
526 set bridge-domain uu-flood <bd_index> [disable]
528 static clib_error_t *
529 bd_uu_flood (vlib_main_t * vm,
530 unformat_input_t * input, vlib_cli_command_t * cmd)
532 bd_main_t *bdm = &bd_main;
533 clib_error_t *error = 0;
538 if (!unformat (input, "%d", &bd_id))
540 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
541 format_unformat_error, input);
546 return clib_error_return (0,
547 "No operations on the default bridge domain are supported");
549 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
552 return clib_error_return (0, "No such bridge domain %d", bd_id);
557 if (unformat (input, "disable"))
562 /* set the bridge domain flag */
563 bd_set_flags (vm, bd_index, L2_UU_FLOOD, enable);
570 * Layer 2 unknown-unicast flooding can be enabled and disabled on each
571 * bridge-domain. It is enabled by default.
574 * Example of how to enable unknown-unicast flooding (where 200 is the
576 * @cliexcmd{set bridge-domain uu-flood 200}
577 * Example of how to disable unknown-unicast flooding (where 200 is the bridge-domain-id):
578 * @cliexcmd{set bridge-domain uu-flood 200 disable}
581 VLIB_CLI_COMMAND (bd_uu_flood_cli, static) = {
582 .path = "set bridge-domain uu-flood",
583 .short_help = "set bridge-domain uu-flood <bridge-domain-id> [disable]",
584 .function = bd_uu_flood,
589 Set bridge-domain arp term enable/disable.
591 set bridge-domain arp term <bridge-domain-id> [disable]
593 static clib_error_t *
594 bd_arp_term (vlib_main_t * vm,
595 unformat_input_t * input, vlib_cli_command_t * cmd)
597 bd_main_t *bdm = &bd_main;
598 clib_error_t *error = 0;
603 if (!unformat (input, "%d", &bd_id))
605 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
606 format_unformat_error, input);
611 return clib_error_return (0,
612 "No operations on the default bridge domain are supported");
614 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
618 return clib_error_return (0, "No such bridge domain %d", bd_id);
621 if (unformat (input, "disable"))
624 /* set the bridge domain flag */
625 bd_set_flags (vm, bd_index, L2_ARP_TERM, enable);
631 static clib_error_t *
632 bd_mac_age (vlib_main_t * vm,
633 unformat_input_t * input, vlib_cli_command_t * cmd)
635 bd_main_t *bdm = &bd_main;
636 clib_error_t *error = 0;
641 if (!unformat (input, "%d", &bd_id))
643 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
644 format_unformat_error, input);
649 return clib_error_return (0,
650 "No operations on the default bridge domain are supported");
652 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
655 return clib_error_return (0, "No such bridge domain %d", bd_id);
659 if (!unformat (input, "%u", &age))
662 clib_error_return (0, "expecting ageing time in minutes but got `%U'",
663 format_unformat_error, input);
667 /* set the bridge domain flag */
671 clib_error_return (0, "mac aging time cannot be bigger than 255");
674 bd_set_mac_age (vm, bd_index, (u8) age);
681 * Layer 2 mac aging can be enabled and disabled on each
682 * bridge-domain. Use this command to set or disable mac aging
683 * on specific bridge-domains. It is disabled by default.
686 * Example of how to set mac aging (where 200 is the bridge-domain-id and
687 * 5 is aging time in minutes):
688 * @cliexcmd{set bridge-domain mac-age 200 5}
689 * Example of how to disable mac aging (where 200 is the bridge-domain-id):
690 * @cliexcmd{set bridge-domain flood 200 0}
693 VLIB_CLI_COMMAND (bd_mac_age_cli, static) = {
694 .path = "set bridge-domain mac-age",
695 .short_help = "set bridge-domain mac-age <bridge-domain-id> <mins>",
696 .function = bd_mac_age,
701 * Modify whether or not an existing bridge-domain should terminate and respond
702 * to ARP Requests. ARP Termination is disabled by default.
705 * Example of how to enable ARP termination (where 200 is the bridge-domain-id):
706 * @cliexcmd{set bridge-domain arp term 200}
707 * Example of how to disable ARP termination (where 200 is the bridge-domain-id):
708 * @cliexcmd{set bridge-domain arp term 200 disable}
711 VLIB_CLI_COMMAND (bd_arp_term_cli, static) = {
712 .path = "set bridge-domain arp term",
713 .short_help = "set bridge-domain arp term <bridge-domain-id> [disable]",
714 .function = bd_arp_term,
720 * Add/delete IP address to MAC address mapping.
722 * The clib hash implementation stores uword entries in the hash table.
723 * The hash table mac_by_ip4 is keyed via IP4 address and store the
724 * 6-byte MAC address directly in the hash table entry uword.
726 * @warning This only works for 64-bit processor with 8-byte uword;
727 * which means this code *WILL NOT WORK* for a 32-bit prcessor with
731 bd_add_del_ip_mac (u32 bd_index,
732 u8 * ip_addr, u8 * mac_addr, u8 is_ip6, u8 is_add)
734 l2_bridge_domain_t *bd_cfg = l2input_bd_config (bd_index);
735 u64 new_mac = *(u64 *) mac_addr;
737 u16 *mac16 = (u16 *) & new_mac;
739 ASSERT (sizeof (uword) == sizeof (u64)); /* make sure uword is 8 bytes */
740 ASSERT (bd_is_valid (bd_cfg));
742 mac16[3] = 0; /* Clear last 2 unsed bytes of the 8-byte MAC address */
745 ip6_address_t *ip6_addr_key;
747 old_mac = (u64 *) hash_get_mem (bd_cfg->mac_by_ip6, ip_addr);
751 { /* new entry - allocate and craete ip6 address key */
752 ip6_addr_key = clib_mem_alloc (sizeof (ip6_address_t));
753 clib_memcpy (ip6_addr_key, ip_addr, sizeof (ip6_address_t));
755 else if (*old_mac == new_mac)
756 { /* same mac entry already exist for ip6 address */
760 { /* updat mac for ip6 address */
761 hp = hash_get_pair (bd_cfg->mac_by_ip6, ip_addr);
762 ip6_addr_key = (ip6_address_t *) hp->key;
764 hash_set_mem (bd_cfg->mac_by_ip6, ip6_addr_key, new_mac);
768 if (old_mac && (*old_mac == new_mac))
770 hp = hash_get_pair (bd_cfg->mac_by_ip6, ip_addr);
771 ip6_addr_key = (ip6_address_t *) hp->key;
772 hash_unset_mem (bd_cfg->mac_by_ip6, ip_addr);
773 clib_mem_free (ip6_addr_key);
781 ip4_address_t ip4_addr = *(ip4_address_t *) ip_addr;
782 old_mac = (u64 *) hash_get (bd_cfg->mac_by_ip4, ip4_addr.as_u32);
785 if (old_mac && (*old_mac == new_mac))
786 return 0; /* mac entry already exist */
787 hash_set (bd_cfg->mac_by_ip4, ip4_addr.as_u32, new_mac);
791 if (old_mac && (*old_mac == new_mac))
792 hash_unset (bd_cfg->mac_by_ip4, ip4_addr.as_u32);
801 Set bridge-domain arp entry add/delete.
803 set bridge-domain arp entry <bridge-domain-id> <ip-addr> <mac-addr> [del]
805 static clib_error_t *
806 bd_arp_entry (vlib_main_t * vm,
807 unformat_input_t * input, vlib_cli_command_t * cmd)
809 bd_main_t *bdm = &bd_main;
810 clib_error_t *error = 0;
818 if (!unformat (input, "%d", &bd_id))
820 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
821 format_unformat_error, input);
826 return clib_error_return (0,
827 "No operations on the default bridge domain are supported");
829 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
834 return clib_error_return (0, "No such bridge domain %d", bd_id);
836 if (unformat (input, "%U", unformat_ip4_address, ip_addr))
840 else if (unformat (input, "%U", unformat_ip6_address, ip_addr))
846 error = clib_error_return (0, "expecting IP address but got `%U'",
847 format_unformat_error, input);
851 if (!unformat (input, "%U", unformat_ethernet_address, mac_addr))
853 error = clib_error_return (0, "expecting MAC address but got `%U'",
854 format_unformat_error, input);
858 if (unformat (input, "del"))
863 /* set the bridge domain flagAdd IP-MAC entry into bridge domain */
864 if (bd_add_del_ip_mac (bd_index, ip_addr, mac_addr, is_ip6, is_add))
866 error = clib_error_return (0, "MAC %s for IP %U and MAC %U failed",
867 is_add ? "add" : "del",
869 format_ip4_address : format_ip6_address,
870 ip_addr, format_ethernet_address, mac_addr);
878 * Add an ARP entry to an existing bridge-domain.
881 * Example of how to add an ARP entry (where 200 is the bridge-domain-id):
882 * @cliexcmd{set bridge-domain arp entry 200 192.168.72.45 52:54:00:3b:83:1a}
883 * Example of how to delete an ARP entry (where 200 is the bridge-domain-id):
884 * @cliexcmd{set bridge-domain arp entry 200 192.168.72.45 52:54:00:3b:83:1a del}
887 VLIB_CLI_COMMAND (bd_arp_entry_cli, static) = {
888 .path = "set bridge-domain arp entry",
889 .short_help = "set bridge-domain arp entry <bridge-domain-id> <ip-addr> <mac-addr> [del]",
890 .function = bd_arp_entry,
895 format_vtr (u8 * s, va_list * args)
897 u32 vtr_op = va_arg (*args, u32);
898 u32 dot1q = va_arg (*args, u32);
899 u32 tag1 = va_arg (*args, u32);
900 u32 tag2 = va_arg (*args, u32);
903 case L2_VTR_DISABLED:
904 return format (s, "none");
906 return format (s, "push-1 %s %d", dot1q ? "dot1q" : "dot1ad", tag1);
908 return format (s, "push-2 %s %d %d", dot1q ? "dot1q" : "dot1ad", tag1,
911 return format (s, "pop-1");
913 return format (s, "pop-2");
914 case L2_VTR_TRANSLATE_1_1:
915 return format (s, "trans-1-1 %s %d", dot1q ? "dot1q" : "dot1ad", tag1);
916 case L2_VTR_TRANSLATE_1_2:
917 return format (s, "trans-1-2 %s %d %d", dot1q ? "dot1q" : "dot1ad",
919 case L2_VTR_TRANSLATE_2_1:
920 return format (s, "trans-2-1 %s %d", dot1q ? "dot1q" : "dot1ad", tag1);
921 case L2_VTR_TRANSLATE_2_2:
922 return format (s, "trans-2-2 %s %d %d", dot1q ? "dot1q" : "dot1ad",
925 return format (s, "none");
930 Show bridge-domain state.
932 show bridge-domain [<bd_index>]
934 static clib_error_t *
935 bd_show (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
937 vnet_main_t *vnm = vnet_get_main ();
938 bd_main_t *bdm = &bd_main;
939 clib_error_t *error = 0;
941 l2_bridge_domain_t *bd_config;
951 end = vec_len (l2input_main.bd_configs);
953 if (unformat (input, "%d", &bd_id))
955 if (unformat (input, "detail"))
957 else if (unformat (input, "det"))
959 if (unformat (input, "int"))
961 if (unformat (input, "arp"))
963 if (unformat (input, "bd-tag"))
967 return clib_error_return (0,
968 "No operations on the default bridge domain are supported");
970 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
974 return clib_error_return (0, "No such bridge domain %d", bd_id);
976 vec_validate (l2input_main.bd_configs, bd_index);
977 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
978 if (bd_is_valid (bd_config))
985 vlib_cli_output (vm, "bridge-domain %d not in use", bd_id);
990 /* Show all bridge-domains that have been initialized */
993 for (bd_index = start; bd_index < end; bd_index++)
995 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
996 if (bd_is_valid (bd_config))
1001 vlib_cli_output (vm,
1002 "%=8s %=7s %=4s %=9s %=9s %=9s %=9s %=9s %=9s %=9s",
1003 "BD-ID", "Index", "BSN", "Age(min)",
1004 "Learning", "U-Forwrd", "UU-Flood", "Flooding",
1005 "ARP-Term", "BVI-Intf");
1008 if (bd_config->mac_age)
1009 as = format (as, "%d", bd_config->mac_age);
1011 as = format (as, "off");
1012 vlib_cli_output (vm,
1013 "%=8d %=7d %=4d %=9v %=9s %=9s %=9s %=9s %=9s %=9U",
1014 bd_config->bd_id, bd_index, bd_config->seq_num, as,
1015 bd_config->feature_bitmap & L2INPUT_FEAT_LEARN ?
1017 bd_config->feature_bitmap & L2INPUT_FEAT_FWD ?
1019 bd_config->feature_bitmap & L2INPUT_FEAT_UU_FLOOD ?
1021 bd_config->feature_bitmap & L2INPUT_FEAT_FLOOD ?
1023 bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM ?
1025 format_vnet_sw_if_index_name_with_NA,
1026 vnm, bd_config->bvi_sw_if_index);
1027 vec_reset_length (as);
1031 /* Show all member interfaces */
1033 vec_foreach_index (i, bd_config->members)
1035 l2_flood_member_t *member =
1036 vec_elt_at_index (bd_config->members, i);
1037 u8 swif_seq_num = *l2fib_swif_seq_num (member->sw_if_index);
1038 u32 vtr_opr, dot1q, tag1, tag2;
1041 vlib_cli_output (vm, "\n%=30s%=7s%=5s%=5s%=5s%=9s%=30s",
1042 "Interface", "If-idx", "ISN", "SHG",
1043 "BVI", "TxFlood", "VLAN-Tag-Rewrite");
1045 l2vtr_get (vm, vnm, member->sw_if_index, &vtr_opr, &dot1q,
1047 vlib_cli_output (vm, "%=30U%=7d%=5d%=5d%=5s%=9s%=30U",
1048 format_vnet_sw_if_index_name, vnm,
1049 member->sw_if_index, member->sw_if_index,
1050 swif_seq_num, member->shg,
1051 member->flags & L2_FLOOD_MEMBER_BVI ? "*" :
1052 "-", i < bd_config->flood_count ? "*" : "-",
1053 format_vtr, vtr_opr, dot1q, tag1, tag2);
1057 if ((detail || arp) &&
1058 (bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM))
1061 ip6_address_t *ip6_addr;
1063 vlib_cli_output (vm,
1064 "\n IP4/IP6 to MAC table for ARP Termination");
1067 hash_foreach (ip4_addr, mac_addr, bd_config->mac_by_ip4,
1069 vlib_cli_output (vm, "%=40U => %=20U",
1070 format_ip4_address, &ip4_addr,
1071 format_ethernet_address, &mac_addr);
1074 hash_foreach_mem (ip6_addr, mac_addr, bd_config->mac_by_ip6,
1076 vlib_cli_output (vm, "%=40U => %=20U",
1077 format_ip6_address, ip6_addr,
1078 format_ethernet_address, &mac_addr);
1083 if ((detail || bd_tag) && (bd_config->bd_tag))
1085 vlib_cli_output (vm, "\n BD-Tag: %s", bd_config->bd_tag);
1094 vlib_cli_output (vm, "no bridge-domains in use");
1102 * Show a summary of all the bridge-domain instances or detailed view of a
1103 * single bridge-domain. Bridge-domains are created by adding an interface
1104 * to a bridge using the '<em>set interface l2 bridge</em>' command.
1108 * Example of displaying all bridge-domains:
1109 * @cliexstart{show bridge-domain}
1110 * ID Index Learning U-Forwrd UU-Flood Flooding ARP-Term BVI-Intf
1111 * 0 0 off off off off off local0
1112 * 200 1 on on on on off N/A
1115 * Example of displaying details of a single bridge-domains:
1116 * @cliexstart{show bridge-domain 200 detail}
1117 * ID Index Learning U-Forwrd UU-Flood Flooding ARP-Term BVI-Intf
1118 * 200 1 on on on on off N/A
1120 * Interface Index SHG BVI VLAN-Tag-Rewrite
1121 * GigabitEthernet0/8/0.200 3 0 - none
1122 * GigabitEthernet0/9/0.200 4 0 - none
1127 VLIB_CLI_COMMAND (bd_show_cli, static) = {
1128 .path = "show bridge-domain",
1129 .short_help = "show bridge-domain [bridge-domain-id [detail|int|arp|bd-tag]]",
1130 .function = bd_show,
1135 bd_add_del (l2_bridge_domain_add_del_args_t * a)
1137 bd_main_t *bdm = &bd_main;
1138 vlib_main_t *vm = bdm->vlib_main;
1141 u32 bd_index = bd_find_index (bdm, a->bd_id);
1145 return VNET_API_ERROR_BD_ALREADY_EXISTS;
1146 if (a->bd_id > L2_BD_ID_MAX)
1147 return VNET_API_ERROR_BD_ID_EXCEED_MAX;
1148 bd_index = bd_add_bd_index (bdm, a->bd_id);
1150 u32 enable_flags = 0, disable_flags = 0;
1152 enable_flags |= L2_FLOOD;
1154 disable_flags |= L2_FLOOD;
1157 enable_flags |= L2_UU_FLOOD;
1159 disable_flags |= L2_UU_FLOOD;
1162 enable_flags |= L2_FWD;
1164 disable_flags |= L2_FWD;
1167 enable_flags |= L2_LEARN;
1169 disable_flags |= L2_LEARN;
1172 enable_flags |= L2_ARP_TERM;
1174 disable_flags |= L2_ARP_TERM;
1177 bd_set_flags (vm, bd_index, enable_flags, 1 /* enable */ );
1180 bd_set_flags (vm, bd_index, disable_flags, 0 /* disable */ );
1182 bd_set_mac_age (vm, bd_index, a->mac_age);
1185 bd_set_bd_tag (vm, bd_index, a->bd_tag);
1191 return VNET_API_ERROR_NO_SUCH_ENTRY;
1193 return VNET_API_ERROR_BD_NOT_MODIFIABLE;
1194 if (vec_len (l2input_main.bd_configs[bd_index].members))
1195 return VNET_API_ERROR_BD_IN_USE;
1196 rv = bd_delete (bdm, bd_index);
1203 Create or delete bridge-domain.
1205 create bridge-domain <bd_index> [learn <0|1>] [forward <0|1>] [uu-flood <0|1>] [flood <0|1>]
1206 [arp-term <0|1>] [mac-age <nn>] [bd-tag <tag>] [del]
1209 static clib_error_t *
1210 bd_add_del_command_fn (vlib_main_t * vm, unformat_input_t * input,
1211 vlib_cli_command_t * cmd)
1213 unformat_input_t _line_input, *line_input = &_line_input;
1214 clib_error_t *error = 0;
1217 u32 flood = 1, forward = 1, learn = 1, uu_flood = 1, arp_term = 0;
1220 l2_bridge_domain_add_del_args_t _a, *a = &_a;
1223 /* Get a line of input. */
1224 if (!unformat_user (input, unformat_line_input, line_input))
1227 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1229 if (unformat (line_input, "%d", &bd_id))
1231 else if (unformat (line_input, "flood %d", &flood))
1233 else if (unformat (line_input, "uu-flood %d", &uu_flood))
1235 else if (unformat (line_input, "forward %d", &forward))
1237 else if (unformat (line_input, "learn %d", &learn))
1239 else if (unformat (line_input, "arp-term %d", &arp_term))
1241 else if (unformat (line_input, "mac-age %d", &mac_age))
1243 else if (unformat (line_input, "bd-tag %s", &bd_tag))
1245 else if (unformat (line_input, "del"))
1248 flood = uu_flood = forward = learn = 0;
1256 error = clib_error_return (0, "bridge-domain-id not specified");
1262 error = clib_error_return (0, "bridge domain 0 can not be modified");
1268 error = clib_error_return (0, "mac age must be less than 256");
1271 if ((bd_tag) && (strlen ((char *) bd_tag) > 63))
1273 error = clib_error_return (0, "bd-tag cannot be longer than 63");
1277 memset (a, 0, sizeof (*a));
1280 a->flood = (u8) flood;
1281 a->uu_flood = (u8) uu_flood;
1282 a->forward = (u8) forward;
1283 a->learn = (u8) learn;
1284 a->arp_term = (u8) arp_term;
1285 a->mac_age = (u8) mac_age;
1288 rv = bd_add_del (a);
1294 vlib_cli_output (vm, "bridge-domain %d", bd_id);
1296 case VNET_API_ERROR_BD_IN_USE:
1297 error = clib_error_return (0, "bridge domain in use - remove members");
1299 case VNET_API_ERROR_NO_SUCH_ENTRY:
1300 error = clib_error_return (0, "bridge domain ID does not exist");
1302 case VNET_API_ERROR_BD_NOT_MODIFIABLE:
1303 error = clib_error_return (0, "bridge domain 0 can not be modified");
1305 case VNET_API_ERROR_BD_ID_EXCEED_MAX:
1306 error = clib_error_return (0, "bridge domain ID exceed 16M limit");
1309 error = clib_error_return (0, "bd_add_del returned %d", rv);
1315 unformat_free (line_input);
1322 * Create/Delete bridge-domain instance
1326 * Example of creating bridge-domain 1:
1327 * @cliexstart{create bridge-domain 1}
1331 * Example of creating bridge-domain 2 with enabling arp-term, mac-age 60:
1332 * @cliexstart{create bridge-domain 2 arp-term 1 mac-age 60}
1335 * vpp# show bridge-domain
1336 * ID Index BSN Age(min) Learning U-Forwrd UU-Flood Flooding ARP-Term BVI-Intf
1337 * 0 0 0 off off off off off off local0
1338 * 1 1 0 off on on off on off N/A
1339 * 2 2 0 60 on on off on on N/A
1343 * Example of delete bridge-domain 1:
1344 * @cliexstart{create bridge-domain 1 del}
1350 VLIB_CLI_COMMAND (bd_create_cli, static) = {
1351 .path = "create bridge-domain",
1352 .short_help = "create bridge-domain <bridge-domain-id>"
1353 " [learn <0|1>] [forward <0|1>] [uu-flood <0|1>] [flood <0|1>] [arp-term <0|1>]"
1354 " [mac-age <nn>] [bd-tag <tag>] [del]",
1355 .function = bd_add_del_command_fn,
1362 * fd.io coding-style-patch-verification: ON
1365 * eval: (c-set-style "gnu")