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 ? bd_config->tun_normal_count : 0);
136 bd_add_member (l2_bridge_domain_t * bd_config, l2_flood_member_t * member)
139 vnet_sw_interface_t *sw_if = vnet_get_sw_interface
140 (vnet_get_main (), member->sw_if_index);
143 * Add one element to the vector
144 * vector is ordered [ bvi, normal/tun_masters..., tun_normals... ]
145 * When flooding, the bvi interface (if present) must be the last member
146 * processed due to how BVI processing can change the packet. To enable
147 * this order, we make the bvi interface the first in the vector and
148 * flooding walks the vector in reverse.
150 switch (sw_if->flood_class)
152 case VNET_FLOOD_CLASS_TUNNEL_MASTER:
153 bd_config->tun_master_count++;
157 case VNET_FLOOD_CLASS_NORMAL:
158 ix = (member->flags & L2_FLOOD_MEMBER_BVI) ? 0 :
159 vec_len (bd_config->members) - bd_config->tun_normal_count;
161 case VNET_FLOOD_CLASS_TUNNEL_NORMAL:
162 ix = vec_len (bd_config->members);
163 bd_config->tun_normal_count++;
167 vec_insert_elts (bd_config->members, member, 1, ix);
168 update_flood_count (bd_config);
171 #define BD_REMOVE_ERROR_OK 0
172 #define BD_REMOVE_ERROR_NOT_FOUND 1
175 bd_remove_member (l2_bridge_domain_t * bd_config, u32 sw_if_index)
179 /* Find and delete the member */
180 vec_foreach_index (ix, bd_config->members)
182 l2_flood_member_t *m = vec_elt_at_index (bd_config->members, ix);
183 if (m->sw_if_index == sw_if_index)
185 vnet_sw_interface_t *sw_if = vnet_get_sw_interface
186 (vnet_get_main (), sw_if_index);
188 if (sw_if->flood_class != VNET_FLOOD_CLASS_NORMAL)
190 if (sw_if->flood_class == VNET_FLOOD_CLASS_TUNNEL_MASTER)
191 bd_config->tun_master_count--;
192 else if (sw_if->flood_class == VNET_FLOOD_CLASS_TUNNEL_NORMAL)
193 bd_config->tun_normal_count--;
195 vec_delete (bd_config->members, 1, ix);
196 update_flood_count (bd_config);
198 return BD_REMOVE_ERROR_OK;
202 return BD_REMOVE_ERROR_NOT_FOUND;
207 l2bd_init (vlib_main_t * vm)
209 bd_main_t *bdm = &bd_main;
210 bdm->bd_index_by_bd_id = hash_create (0, sizeof (uword));
212 * create a dummy bd with bd_id of 0 and bd_index of 0 with feature set
213 * to packet drop only. Thus, packets received from any L2 interface with
214 * uninitialized bd_index of 0 can be dropped safely.
216 u32 bd_index = bd_add_bd_index (bdm, 0);
217 ASSERT (bd_index == 0);
218 l2input_main.bd_configs[0].feature_bitmap = L2INPUT_FEAT_DROP;
224 VLIB_INIT_FUNCTION (l2bd_init);
228 Set the learn/forward/flood flags for the bridge domain.
229 Return 0 if ok, non-zero if for an error.
232 bd_set_flags (vlib_main_t * vm, u32 bd_index, u32 flags, u32 enable)
235 l2_bridge_domain_t *bd_config = l2input_bd_config (bd_index);
236 bd_validate (bd_config);
237 u32 feature_bitmap = 0;
239 if (flags & L2_LEARN)
241 feature_bitmap |= L2INPUT_FEAT_LEARN;
245 feature_bitmap |= L2INPUT_FEAT_FWD;
247 if (flags & L2_FLOOD)
249 feature_bitmap |= L2INPUT_FEAT_FLOOD;
251 if (flags & L2_UU_FLOOD)
253 feature_bitmap |= L2INPUT_FEAT_UU_FLOOD;
255 if (flags & L2_ARP_TERM)
257 feature_bitmap |= L2INPUT_FEAT_ARP_TERM;
262 bd_config->feature_bitmap |= feature_bitmap;
266 bd_config->feature_bitmap &= ~feature_bitmap;
269 return bd_config->feature_bitmap;
273 Set the mac age for the bridge domain.
276 bd_set_mac_age (vlib_main_t * vm, u32 bd_index, u8 age)
278 l2_bridge_domain_t *bd_config;
281 vec_validate (l2input_main.bd_configs, bd_index);
282 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
283 bd_config->mac_age = age;
285 /* check if there is at least one bd with mac aging enabled */
286 vec_foreach (bd_config, l2input_main.bd_configs)
287 enable |= bd_config->bd_id != ~0 && bd_config->mac_age != 0;
289 vlib_process_signal_event (vm, l2fib_mac_age_scanner_process_node.index,
290 enable ? L2_MAC_AGE_PROCESS_EVENT_START :
291 L2_MAC_AGE_PROCESS_EVENT_STOP, 0);
295 Set the tag for the bridge domain.
299 bd_set_bd_tag (vlib_main_t * vm, u32 bd_index, u8 * bd_tag)
302 l2_bridge_domain_t *bd_config;
303 vec_validate (l2input_main.bd_configs, bd_index);
304 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
306 old = bd_config->bd_tag;
310 bd_config->bd_tag = format (0, "%s%c", bd_tag, 0);
314 bd_config->bd_tag = NULL;
321 Set bridge-domain learn enable/disable.
323 set bridge-domain learn <bd_id> [disable]
325 static clib_error_t *
326 bd_learn (vlib_main_t * vm,
327 unformat_input_t * input, vlib_cli_command_t * cmd)
329 bd_main_t *bdm = &bd_main;
330 clib_error_t *error = 0;
335 if (!unformat (input, "%d", &bd_id))
337 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
338 format_unformat_error, input);
343 return clib_error_return (0,
344 "No operations on the default bridge domain are supported");
346 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
349 return clib_error_return (0, "No such bridge domain %d", bd_id);
354 if (unformat (input, "disable"))
359 /* set the bridge domain flag */
360 bd_set_flags (vm, bd_index, L2_LEARN, enable);
367 * Layer 2 learning can be enabled and disabled on each
368 * interface and on each bridge-domain. Use this command to
369 * manage bridge-domains. It is enabled by default.
372 * Example of how to enable learning (where 200 is the bridge-domain-id):
373 * @cliexcmd{set bridge-domain learn 200}
374 * Example of how to disable learning (where 200 is the bridge-domain-id):
375 * @cliexcmd{set bridge-domain learn 200 disable}
378 VLIB_CLI_COMMAND (bd_learn_cli, static) = {
379 .path = "set bridge-domain learn",
380 .short_help = "set bridge-domain learn <bridge-domain-id> [disable]",
381 .function = bd_learn,
386 Set bridge-domain forward enable/disable.
388 set bridge-domain forward <bd_index> [disable]
390 static clib_error_t *
391 bd_fwd (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
393 bd_main_t *bdm = &bd_main;
394 clib_error_t *error = 0;
399 if (!unformat (input, "%d", &bd_id))
401 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
402 format_unformat_error, input);
407 return clib_error_return (0,
408 "No operations on the default bridge domain are supported");
410 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
413 return clib_error_return (0, "No such bridge domain %d", bd_id);
418 if (unformat (input, "disable"))
423 /* set the bridge domain flag */
424 bd_set_flags (vm, bd_index, L2_FWD, enable);
432 * Layer 2 unicast forwarding can be enabled and disabled on each
433 * interface and on each bridge-domain. Use this command to
434 * manage bridge-domains. It is enabled by default.
437 * Example of how to enable forwarding (where 200 is the bridge-domain-id):
438 * @cliexcmd{set bridge-domain forward 200}
439 * Example of how to disable forwarding (where 200 is the bridge-domain-id):
440 * @cliexcmd{set bridge-domain forward 200 disable}
443 VLIB_CLI_COMMAND (bd_fwd_cli, static) = {
444 .path = "set bridge-domain forward",
445 .short_help = "set bridge-domain forward <bridge-domain-id> [disable]",
451 Set bridge-domain flood enable/disable.
453 set bridge-domain flood <bd_index> [disable]
455 static clib_error_t *
456 bd_flood (vlib_main_t * vm,
457 unformat_input_t * input, vlib_cli_command_t * cmd)
459 bd_main_t *bdm = &bd_main;
460 clib_error_t *error = 0;
465 if (!unformat (input, "%d", &bd_id))
467 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
468 format_unformat_error, input);
473 return clib_error_return (0,
474 "No operations on the default bridge domain are supported");
476 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
479 return clib_error_return (0, "No such bridge domain %d", bd_id);
484 if (unformat (input, "disable"))
489 /* set the bridge domain flag */
490 bd_set_flags (vm, bd_index, L2_FLOOD, enable);
497 * Layer 2 flooding can be enabled and disabled on each
498 * interface and on each bridge-domain. Use this command to
499 * manage bridge-domains. It is enabled by default.
502 * Example of how to enable flooding (where 200 is the bridge-domain-id):
503 * @cliexcmd{set bridge-domain flood 200}
504 * Example of how to disable flooding (where 200 is the bridge-domain-id):
505 * @cliexcmd{set bridge-domain flood 200 disable}
508 VLIB_CLI_COMMAND (bd_flood_cli, static) = {
509 .path = "set bridge-domain flood",
510 .short_help = "set bridge-domain flood <bridge-domain-id> [disable]",
511 .function = bd_flood,
516 Set bridge-domain unkown-unicast flood enable/disable.
518 set bridge-domain uu-flood <bd_index> [disable]
520 static clib_error_t *
521 bd_uu_flood (vlib_main_t * vm,
522 unformat_input_t * input, vlib_cli_command_t * cmd)
524 bd_main_t *bdm = &bd_main;
525 clib_error_t *error = 0;
530 if (!unformat (input, "%d", &bd_id))
532 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
533 format_unformat_error, input);
538 return clib_error_return (0,
539 "No operations on the default bridge domain are supported");
541 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
544 return clib_error_return (0, "No such bridge domain %d", bd_id);
549 if (unformat (input, "disable"))
554 /* set the bridge domain flag */
555 bd_set_flags (vm, bd_index, L2_UU_FLOOD, enable);
562 * Layer 2 unknown-unicast flooding can be enabled and disabled on each
563 * bridge-domain. It is enabled by default.
566 * Example of how to enable unknown-unicast flooding (where 200 is the
568 * @cliexcmd{set bridge-domain uu-flood 200}
569 * Example of how to disable unknown-unicast flooding (where 200 is the bridge-domain-id):
570 * @cliexcmd{set bridge-domain uu-flood 200 disable}
573 VLIB_CLI_COMMAND (bd_uu_flood_cli, static) = {
574 .path = "set bridge-domain uu-flood",
575 .short_help = "set bridge-domain uu-flood <bridge-domain-id> [disable]",
576 .function = bd_uu_flood,
581 Set bridge-domain arp term enable/disable.
583 set bridge-domain arp term <bridge-domain-id> [disable]
585 static clib_error_t *
586 bd_arp_term (vlib_main_t * vm,
587 unformat_input_t * input, vlib_cli_command_t * cmd)
589 bd_main_t *bdm = &bd_main;
590 clib_error_t *error = 0;
595 if (!unformat (input, "%d", &bd_id))
597 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
598 format_unformat_error, input);
603 return clib_error_return (0,
604 "No operations on the default bridge domain are supported");
606 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
610 return clib_error_return (0, "No such bridge domain %d", bd_id);
613 if (unformat (input, "disable"))
616 /* set the bridge domain flag */
617 bd_set_flags (vm, bd_index, L2_ARP_TERM, enable);
623 static clib_error_t *
624 bd_mac_age (vlib_main_t * vm,
625 unformat_input_t * input, vlib_cli_command_t * cmd)
627 bd_main_t *bdm = &bd_main;
628 clib_error_t *error = 0;
633 if (!unformat (input, "%d", &bd_id))
635 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
636 format_unformat_error, input);
641 return clib_error_return (0,
642 "No operations on the default bridge domain are supported");
644 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
647 return clib_error_return (0, "No such bridge domain %d", bd_id);
651 if (!unformat (input, "%u", &age))
654 clib_error_return (0, "expecting ageing time in minutes but got `%U'",
655 format_unformat_error, input);
659 /* set the bridge domain flag */
663 clib_error_return (0, "mac aging time cannot be bigger than 255");
666 bd_set_mac_age (vm, bd_index, (u8) age);
673 * Layer 2 mac aging can be enabled and disabled on each
674 * bridge-domain. Use this command to set or disable mac aging
675 * on specific bridge-domains. It is disabled by default.
678 * Example of how to set mac aging (where 200 is the bridge-domain-id and
679 * 5 is aging time in minutes):
680 * @cliexcmd{set bridge-domain mac-age 200 5}
681 * Example of how to disable mac aging (where 200 is the bridge-domain-id):
682 * @cliexcmd{set bridge-domain flood 200 0}
685 VLIB_CLI_COMMAND (bd_mac_age_cli, static) = {
686 .path = "set bridge-domain mac-age",
687 .short_help = "set bridge-domain mac-age <bridge-domain-id> <mins>",
688 .function = bd_mac_age,
693 * Modify whether or not an existing bridge-domain should terminate and respond
694 * to ARP Requests. ARP Termination is disabled by default.
697 * Example of how to enable ARP termination (where 200 is the bridge-domain-id):
698 * @cliexcmd{set bridge-domain arp term 200}
699 * Example of how to disable ARP termination (where 200 is the bridge-domain-id):
700 * @cliexcmd{set bridge-domain arp term 200 disable}
703 VLIB_CLI_COMMAND (bd_arp_term_cli, static) = {
704 .path = "set bridge-domain arp term",
705 .short_help = "set bridge-domain arp term <bridge-domain-id> [disable]",
706 .function = bd_arp_term,
712 * Add/delete IP address to MAC address mapping.
714 * The clib hash implementation stores uword entries in the hash table.
715 * The hash table mac_by_ip4 is keyed via IP4 address and store the
716 * 6-byte MAC address directly in the hash table entry uword.
718 * @warning This only works for 64-bit processor with 8-byte uword;
719 * which means this code *WILL NOT WORK* for a 32-bit prcessor with
723 bd_add_del_ip_mac (u32 bd_index,
724 u8 * ip_addr, u8 * mac_addr, u8 is_ip6, u8 is_add)
726 l2_bridge_domain_t *bd_cfg = l2input_bd_config (bd_index);
727 u64 new_mac = *(u64 *) mac_addr;
729 u16 *mac16 = (u16 *) & new_mac;
731 ASSERT (sizeof (uword) == sizeof (u64)); /* make sure uword is 8 bytes */
732 ASSERT (bd_is_valid (bd_cfg));
734 mac16[3] = 0; /* Clear last 2 unsed bytes of the 8-byte MAC address */
737 ip6_address_t *ip6_addr_key;
739 old_mac = (u64 *) hash_get_mem (bd_cfg->mac_by_ip6, ip_addr);
743 { /* new entry - allocate and craete ip6 address key */
744 ip6_addr_key = clib_mem_alloc (sizeof (ip6_address_t));
745 clib_memcpy (ip6_addr_key, ip_addr, sizeof (ip6_address_t));
747 else if (*old_mac == new_mac)
748 { /* same mac entry already exist for ip6 address */
752 { /* updat mac for ip6 address */
753 hp = hash_get_pair (bd_cfg->mac_by_ip6, ip_addr);
754 ip6_addr_key = (ip6_address_t *) hp->key;
756 hash_set_mem (bd_cfg->mac_by_ip6, ip6_addr_key, new_mac);
760 if (old_mac && (*old_mac == new_mac))
762 hp = hash_get_pair (bd_cfg->mac_by_ip6, ip_addr);
763 ip6_addr_key = (ip6_address_t *) hp->key;
764 hash_unset_mem (bd_cfg->mac_by_ip6, ip_addr);
765 clib_mem_free (ip6_addr_key);
773 ip4_address_t ip4_addr = *(ip4_address_t *) ip_addr;
774 old_mac = (u64 *) hash_get (bd_cfg->mac_by_ip4, ip4_addr.as_u32);
777 if (old_mac && (*old_mac == new_mac))
778 return 0; /* mac entry already exist */
779 hash_set (bd_cfg->mac_by_ip4, ip4_addr.as_u32, new_mac);
783 if (old_mac && (*old_mac == new_mac))
784 hash_unset (bd_cfg->mac_by_ip4, ip4_addr.as_u32);
793 Set bridge-domain arp entry add/delete.
795 set bridge-domain arp entry <bridge-domain-id> <ip-addr> <mac-addr> [del]
797 static clib_error_t *
798 bd_arp_entry (vlib_main_t * vm,
799 unformat_input_t * input, vlib_cli_command_t * cmd)
801 bd_main_t *bdm = &bd_main;
802 clib_error_t *error = 0;
810 if (!unformat (input, "%d", &bd_id))
812 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
813 format_unformat_error, input);
818 return clib_error_return (0,
819 "No operations on the default bridge domain are supported");
821 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
826 return clib_error_return (0, "No such bridge domain %d", bd_id);
828 if (unformat (input, "%U", unformat_ip4_address, ip_addr))
832 else if (unformat (input, "%U", unformat_ip6_address, ip_addr))
838 error = clib_error_return (0, "expecting IP address but got `%U'",
839 format_unformat_error, input);
843 if (!unformat (input, "%U", unformat_ethernet_address, mac_addr))
845 error = clib_error_return (0, "expecting MAC address but got `%U'",
846 format_unformat_error, input);
850 if (unformat (input, "del"))
855 /* set the bridge domain flagAdd IP-MAC entry into bridge domain */
856 if (bd_add_del_ip_mac (bd_index, ip_addr, mac_addr, is_ip6, is_add))
858 error = clib_error_return (0, "MAC %s for IP %U and MAC %U failed",
859 is_add ? "add" : "del",
861 format_ip4_address : format_ip6_address,
862 ip_addr, format_ethernet_address, mac_addr);
870 * Add an ARP entry to an existing bridge-domain.
873 * Example of how to add an ARP entry (where 200 is the bridge-domain-id):
874 * @cliexcmd{set bridge-domain arp entry 200 192.168.72.45 52:54:00:3b:83:1a}
875 * Example of how to delete an ARP entry (where 200 is the bridge-domain-id):
876 * @cliexcmd{set bridge-domain arp entry 200 192.168.72.45 52:54:00:3b:83:1a del}
879 VLIB_CLI_COMMAND (bd_arp_entry_cli, static) = {
880 .path = "set bridge-domain arp entry",
881 .short_help = "set bridge-domain arp entry <bridge-domain-id> <ip-addr> <mac-addr> [del]",
882 .function = bd_arp_entry,
887 format_vtr (u8 * s, va_list * args)
889 u32 vtr_op = va_arg (*args, u32);
890 u32 dot1q = va_arg (*args, u32);
891 u32 tag1 = va_arg (*args, u32);
892 u32 tag2 = va_arg (*args, u32);
895 case L2_VTR_DISABLED:
896 return format (s, "none");
898 return format (s, "push-1 %s %d", dot1q ? "dot1q" : "dot1ad", tag1);
900 return format (s, "push-2 %s %d %d", dot1q ? "dot1q" : "dot1ad", tag1,
903 return format (s, "pop-1");
905 return format (s, "pop-2");
906 case L2_VTR_TRANSLATE_1_1:
907 return format (s, "trans-1-1 %s %d", dot1q ? "dot1q" : "dot1ad", tag1);
908 case L2_VTR_TRANSLATE_1_2:
909 return format (s, "trans-1-2 %s %d %d", dot1q ? "dot1q" : "dot1ad",
911 case L2_VTR_TRANSLATE_2_1:
912 return format (s, "trans-2-1 %s %d", dot1q ? "dot1q" : "dot1ad", tag1);
913 case L2_VTR_TRANSLATE_2_2:
914 return format (s, "trans-2-2 %s %d %d", dot1q ? "dot1q" : "dot1ad",
917 return format (s, "none");
922 Show bridge-domain state.
924 show bridge-domain [<bd_index>]
926 static clib_error_t *
927 bd_show (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
929 vnet_main_t *vnm = vnet_get_main ();
930 bd_main_t *bdm = &bd_main;
931 clib_error_t *error = 0;
933 l2_bridge_domain_t *bd_config;
943 end = vec_len (l2input_main.bd_configs);
945 if (unformat (input, "%d", &bd_id))
947 if (unformat (input, "detail"))
949 else if (unformat (input, "det"))
951 if (unformat (input, "int"))
953 if (unformat (input, "arp"))
955 if (unformat (input, "bd-tag"))
959 return clib_error_return (0,
960 "No operations on the default bridge domain are supported");
962 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
966 return clib_error_return (0, "No such bridge domain %d", bd_id);
968 vec_validate (l2input_main.bd_configs, bd_index);
969 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
970 if (bd_is_valid (bd_config))
977 vlib_cli_output (vm, "bridge-domain %d not in use", bd_id);
982 /* Show all bridge-domains that have been initialized */
985 for (bd_index = start; bd_index < end; bd_index++)
987 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
988 if (bd_is_valid (bd_config))
994 "%=8s %=7s %=4s %=9s %=9s %=9s %=9s %=9s %=9s %=9s",
995 "BD-ID", "Index", "BSN", "Age(min)",
996 "Learning", "U-Forwrd", "UU-Flood", "Flooding",
997 "ARP-Term", "BVI-Intf");
1000 if (bd_config->mac_age)
1001 as = format (as, "%d", bd_config->mac_age);
1003 as = format (as, "off");
1004 vlib_cli_output (vm,
1005 "%=8d %=7d %=4d %=9v %=9s %=9s %=9s %=9s %=9s %=9U",
1006 bd_config->bd_id, bd_index, bd_config->seq_num, as,
1007 bd_config->feature_bitmap & L2INPUT_FEAT_LEARN ?
1009 bd_config->feature_bitmap & L2INPUT_FEAT_FWD ?
1011 bd_config->feature_bitmap & L2INPUT_FEAT_UU_FLOOD ?
1013 bd_config->feature_bitmap & L2INPUT_FEAT_FLOOD ?
1015 bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM ?
1017 format_vnet_sw_if_index_name_with_NA,
1018 vnm, bd_config->bvi_sw_if_index);
1019 vec_reset_length (as);
1023 /* Show all member interfaces */
1025 vec_foreach_index (i, bd_config->members)
1027 l2_flood_member_t *member =
1028 vec_elt_at_index (bd_config->members, i);
1029 u8 swif_seq_num = *l2fib_swif_seq_num (member->sw_if_index);
1030 u32 vtr_opr, dot1q, tag1, tag2;
1033 vlib_cli_output (vm, "\n%=30s%=7s%=5s%=5s%=5s%=9s%=30s",
1034 "Interface", "If-idx", "ISN", "SHG",
1035 "BVI", "TxFlood", "VLAN-Tag-Rewrite");
1037 l2vtr_get (vm, vnm, member->sw_if_index, &vtr_opr, &dot1q,
1039 vlib_cli_output (vm, "%=30U%=7d%=5d%=5d%=5s%=9s%=30U",
1040 format_vnet_sw_if_index_name, vnm,
1041 member->sw_if_index, member->sw_if_index,
1042 swif_seq_num, member->shg,
1043 member->flags & L2_FLOOD_MEMBER_BVI ? "*" :
1044 "-", i < bd_config->flood_count ? "*" : "-",
1045 format_vtr, vtr_opr, dot1q, tag1, tag2);
1049 if ((detail || arp) &&
1050 (bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM))
1053 ip6_address_t *ip6_addr;
1055 vlib_cli_output (vm,
1056 "\n IP4/IP6 to MAC table for ARP Termination");
1059 hash_foreach (ip4_addr, mac_addr, bd_config->mac_by_ip4,
1061 vlib_cli_output (vm, "%=40U => %=20U",
1062 format_ip4_address, &ip4_addr,
1063 format_ethernet_address, &mac_addr);
1066 hash_foreach_mem (ip6_addr, mac_addr, bd_config->mac_by_ip6,
1068 vlib_cli_output (vm, "%=40U => %=20U",
1069 format_ip6_address, ip6_addr,
1070 format_ethernet_address, &mac_addr);
1075 if ((detail || bd_tag) && (bd_config->bd_tag))
1077 vlib_cli_output (vm, "\n BD-Tag: %s", bd_config->bd_tag);
1086 vlib_cli_output (vm, "no bridge-domains in use");
1094 * Show a summary of all the bridge-domain instances or detailed view of a
1095 * single bridge-domain. Bridge-domains are created by adding an interface
1096 * to a bridge using the '<em>set interface l2 bridge</em>' command.
1100 * Example of displaying all bridge-domains:
1101 * @cliexstart{show bridge-domain}
1102 * ID Index Learning U-Forwrd UU-Flood Flooding ARP-Term BVI-Intf
1103 * 0 0 off off off off off local0
1104 * 200 1 on on on on off N/A
1107 * Example of displaying details of a single bridge-domains:
1108 * @cliexstart{show bridge-domain 200 detail}
1109 * ID Index Learning U-Forwrd UU-Flood Flooding ARP-Term BVI-Intf
1110 * 200 1 on on on on off N/A
1112 * Interface Index SHG BVI VLAN-Tag-Rewrite
1113 * GigabitEthernet0/8/0.200 3 0 - none
1114 * GigabitEthernet0/9/0.200 4 0 - none
1119 VLIB_CLI_COMMAND (bd_show_cli, static) = {
1120 .path = "show bridge-domain",
1121 .short_help = "show bridge-domain [bridge-domain-id [detail|int|arp|bd-tag]]",
1122 .function = bd_show,
1127 bd_add_del (l2_bridge_domain_add_del_args_t * a)
1129 bd_main_t *bdm = &bd_main;
1130 vlib_main_t *vm = bdm->vlib_main;
1133 u32 bd_index = bd_find_index (bdm, a->bd_id);
1137 return VNET_API_ERROR_BD_ALREADY_EXISTS;
1138 if (a->bd_id > L2_BD_ID_MAX)
1139 return VNET_API_ERROR_BD_ID_EXCEED_MAX;
1140 bd_index = bd_add_bd_index (bdm, a->bd_id);
1142 u32 enable_flags = 0, disable_flags = 0;
1144 enable_flags |= L2_FLOOD;
1146 disable_flags |= L2_FLOOD;
1149 enable_flags |= L2_UU_FLOOD;
1151 disable_flags |= L2_UU_FLOOD;
1154 enable_flags |= L2_FWD;
1156 disable_flags |= L2_FWD;
1159 enable_flags |= L2_LEARN;
1161 disable_flags |= L2_LEARN;
1164 enable_flags |= L2_ARP_TERM;
1166 disable_flags |= L2_ARP_TERM;
1169 bd_set_flags (vm, bd_index, enable_flags, 1 /* enable */ );
1172 bd_set_flags (vm, bd_index, disable_flags, 0 /* disable */ );
1174 bd_set_mac_age (vm, bd_index, a->mac_age);
1177 bd_set_bd_tag (vm, bd_index, a->bd_tag);
1183 return VNET_API_ERROR_NO_SUCH_ENTRY;
1185 return VNET_API_ERROR_BD_NOT_MODIFIABLE;
1186 if (vec_len (l2input_main.bd_configs[bd_index].members))
1187 return VNET_API_ERROR_BD_IN_USE;
1188 rv = bd_delete (bdm, bd_index);
1195 Create or delete bridge-domain.
1197 create bridge-domain <bd_index> [learn <0|1>] [forward <0|1>] [uu-flood <0|1>] [flood <0|1>]
1198 [arp-term <0|1>] [mac-age <nn>] [bd-tag <tag>] [del]
1201 static clib_error_t *
1202 bd_add_del_command_fn (vlib_main_t * vm, unformat_input_t * input,
1203 vlib_cli_command_t * cmd)
1205 unformat_input_t _line_input, *line_input = &_line_input;
1206 clib_error_t *error = 0;
1209 u32 flood = 1, forward = 1, learn = 1, uu_flood = 1, arp_term = 0;
1212 l2_bridge_domain_add_del_args_t _a, *a = &_a;
1215 /* Get a line of input. */
1216 if (!unformat_user (input, unformat_line_input, line_input))
1219 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1221 if (unformat (line_input, "%d", &bd_id))
1223 else if (unformat (line_input, "flood %d", &flood))
1225 else if (unformat (line_input, "uu-flood %d", &uu_flood))
1227 else if (unformat (line_input, "forward %d", &forward))
1229 else if (unformat (line_input, "learn %d", &learn))
1231 else if (unformat (line_input, "arp-term %d", &arp_term))
1233 else if (unformat (line_input, "mac-age %d", &mac_age))
1235 else if (unformat (line_input, "bd-tag %s", &bd_tag))
1237 else if (unformat (line_input, "del"))
1240 flood = uu_flood = forward = learn = 0;
1248 error = clib_error_return (0, "bridge-domain-id not specified");
1254 error = clib_error_return (0, "bridge domain 0 can not be modified");
1260 error = clib_error_return (0, "mac age must be less than 256");
1263 if ((bd_tag) && (strlen ((char *) bd_tag) > 63))
1265 error = clib_error_return (0, "bd-tag cannot be longer than 63");
1269 memset (a, 0, sizeof (*a));
1272 a->flood = (u8) flood;
1273 a->uu_flood = (u8) uu_flood;
1274 a->forward = (u8) forward;
1275 a->learn = (u8) learn;
1276 a->arp_term = (u8) arp_term;
1277 a->mac_age = (u8) mac_age;
1280 rv = bd_add_del (a);
1286 vlib_cli_output (vm, "bridge-domain %d", bd_id);
1288 case VNET_API_ERROR_BD_IN_USE:
1289 error = clib_error_return (0, "bridge domain in use - remove members");
1291 case VNET_API_ERROR_NO_SUCH_ENTRY:
1292 error = clib_error_return (0, "bridge domain ID does not exist");
1294 case VNET_API_ERROR_BD_NOT_MODIFIABLE:
1295 error = clib_error_return (0, "bridge domain 0 can not be modified");
1297 case VNET_API_ERROR_BD_ID_EXCEED_MAX:
1298 error = clib_error_return (0, "bridge domain ID exceed 16M limit");
1301 error = clib_error_return (0, "bd_add_del returned %d", rv);
1307 unformat_free (line_input);
1314 * Create/Delete bridge-domain instance
1318 * Example of creating bridge-domain 1:
1319 * @cliexstart{create bridge-domain 1}
1323 * Example of creating bridge-domain 2 with enabling arp-term, mac-age 60:
1324 * @cliexstart{create bridge-domain 2 arp-term 1 mac-age 60}
1327 * vpp# show bridge-domain
1328 * ID Index BSN Age(min) Learning U-Forwrd UU-Flood Flooding ARP-Term BVI-Intf
1329 * 0 0 0 off off off off off off local0
1330 * 1 1 0 off on on off on off N/A
1331 * 2 2 0 60 on on off on on N/A
1335 * Example of delete bridge-domain 1:
1336 * @cliexstart{create bridge-domain 1 del}
1342 VLIB_CLI_COMMAND (bd_create_cli, static) = {
1343 .path = "create bridge-domain",
1344 .short_help = "create bridge-domain <bridge-domain-id>"
1345 " [learn <0|1>] [forward <0|1>] [uu-flood <0|1>] [flood <0|1>] [arp-term <0|1>]"
1346 " [mac-age <nn>] [bd-tag <tag>] [del]",
1347 .function = bd_add_del_command_fn,
1354 * fd.io coding-style-patch-verification: ON
1357 * eval: (c-set-style "gnu")