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);
296 bd_set_bd_tag (vlib_main_t * vm, u32 bd_index, u8 * bd_tag)
299 l2_bridge_domain_t *bd_config;
300 vec_validate (l2input_main.bd_configs, bd_index);
301 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
303 old = bd_config->bd_tag;
307 bd_config->bd_tag = format (0, "%s%c", bd_tag, 0);
311 bd_config->bd_tag = NULL;
318 Set bridge-domain learn enable/disable.
320 set bridge-domain learn <bd_id> [disable]
322 static clib_error_t *
323 bd_learn (vlib_main_t * vm,
324 unformat_input_t * input, vlib_cli_command_t * cmd)
326 bd_main_t *bdm = &bd_main;
327 clib_error_t *error = 0;
332 if (!unformat (input, "%d", &bd_id))
334 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
335 format_unformat_error, input);
340 return clib_error_return (0,
341 "No operations on the default bridge domain are supported");
343 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
346 return clib_error_return (0, "No such bridge domain %d", bd_id);
351 if (unformat (input, "disable"))
356 /* set the bridge domain flag */
357 bd_set_flags (vm, bd_index, L2_LEARN, enable);
364 * Layer 2 learning can be enabled and disabled on each
365 * interface and on each bridge-domain. Use this command to
366 * manage bridge-domains. It is enabled by default.
369 * Example of how to enable learning (where 200 is the bridge-domain-id):
370 * @cliexcmd{set bridge-domain learn 200}
371 * Example of how to disable learning (where 200 is the bridge-domain-id):
372 * @cliexcmd{set bridge-domain learn 200 disable}
375 VLIB_CLI_COMMAND (bd_learn_cli, static) = {
376 .path = "set bridge-domain learn",
377 .short_help = "set bridge-domain learn <bridge-domain-id> [disable]",
378 .function = bd_learn,
383 Set bridge-domain forward enable/disable.
385 set bridge-domain forward <bd_index> [disable]
387 static clib_error_t *
388 bd_fwd (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
390 bd_main_t *bdm = &bd_main;
391 clib_error_t *error = 0;
396 if (!unformat (input, "%d", &bd_id))
398 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
399 format_unformat_error, input);
404 return clib_error_return (0,
405 "No operations on the default bridge domain are supported");
407 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
410 return clib_error_return (0, "No such bridge domain %d", bd_id);
415 if (unformat (input, "disable"))
420 /* set the bridge domain flag */
421 bd_set_flags (vm, bd_index, L2_FWD, enable);
429 * Layer 2 unicast forwarding can be enabled and disabled on each
430 * interface and on each bridge-domain. Use this command to
431 * manage bridge-domains. It is enabled by default.
434 * Example of how to enable forwarding (where 200 is the bridge-domain-id):
435 * @cliexcmd{set bridge-domain forward 200}
436 * Example of how to disable forwarding (where 200 is the bridge-domain-id):
437 * @cliexcmd{set bridge-domain forward 200 disable}
440 VLIB_CLI_COMMAND (bd_fwd_cli, static) = {
441 .path = "set bridge-domain forward",
442 .short_help = "set bridge-domain forward <bridge-domain-id> [disable]",
448 Set bridge-domain flood enable/disable.
450 set bridge-domain flood <bd_index> [disable]
452 static clib_error_t *
453 bd_flood (vlib_main_t * vm,
454 unformat_input_t * input, vlib_cli_command_t * cmd)
456 bd_main_t *bdm = &bd_main;
457 clib_error_t *error = 0;
462 if (!unformat (input, "%d", &bd_id))
464 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
465 format_unformat_error, input);
470 return clib_error_return (0,
471 "No operations on the default bridge domain are supported");
473 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
476 return clib_error_return (0, "No such bridge domain %d", bd_id);
481 if (unformat (input, "disable"))
486 /* set the bridge domain flag */
487 bd_set_flags (vm, bd_index, L2_FLOOD, enable);
494 * Layer 2 flooding can be enabled and disabled on each
495 * interface and on each bridge-domain. Use this command to
496 * manage bridge-domains. It is enabled by default.
499 * Example of how to enable flooding (where 200 is the bridge-domain-id):
500 * @cliexcmd{set bridge-domain flood 200}
501 * Example of how to disable flooding (where 200 is the bridge-domain-id):
502 * @cliexcmd{set bridge-domain flood 200 disable}
505 VLIB_CLI_COMMAND (bd_flood_cli, static) = {
506 .path = "set bridge-domain flood",
507 .short_help = "set bridge-domain flood <bridge-domain-id> [disable]",
508 .function = bd_flood,
513 Set bridge-domain unkown-unicast flood enable/disable.
515 set bridge-domain uu-flood <bd_index> [disable]
517 static clib_error_t *
518 bd_uu_flood (vlib_main_t * vm,
519 unformat_input_t * input, vlib_cli_command_t * cmd)
521 bd_main_t *bdm = &bd_main;
522 clib_error_t *error = 0;
527 if (!unformat (input, "%d", &bd_id))
529 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
530 format_unformat_error, input);
535 return clib_error_return (0,
536 "No operations on the default bridge domain are supported");
538 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
541 return clib_error_return (0, "No such bridge domain %d", bd_id);
546 if (unformat (input, "disable"))
551 /* set the bridge domain flag */
552 bd_set_flags (vm, bd_index, L2_UU_FLOOD, enable);
559 * Layer 2 unknown-unicast flooding can be enabled and disabled on each
560 * bridge-domain. It is enabled by default.
563 * Example of how to enable unknown-unicast flooding (where 200 is the
565 * @cliexcmd{set bridge-domain uu-flood 200}
566 * Example of how to disable unknown-unicast flooding (where 200 is the bridge-domain-id):
567 * @cliexcmd{set bridge-domain uu-flood 200 disable}
570 VLIB_CLI_COMMAND (bd_uu_flood_cli, static) = {
571 .path = "set bridge-domain uu-flood",
572 .short_help = "set bridge-domain uu-flood <bridge-domain-id> [disable]",
573 .function = bd_uu_flood,
578 Set bridge-domain arp term enable/disable.
580 set bridge-domain arp term <bridge-domain-id> [disable]
582 static clib_error_t *
583 bd_arp_term (vlib_main_t * vm,
584 unformat_input_t * input, vlib_cli_command_t * cmd)
586 bd_main_t *bdm = &bd_main;
587 clib_error_t *error = 0;
592 if (!unformat (input, "%d", &bd_id))
594 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
595 format_unformat_error, input);
600 return clib_error_return (0,
601 "No operations on the default bridge domain are supported");
603 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
607 return clib_error_return (0, "No such bridge domain %d", bd_id);
610 if (unformat (input, "disable"))
613 /* set the bridge domain flag */
614 bd_set_flags (vm, bd_index, L2_ARP_TERM, enable);
620 static clib_error_t *
621 bd_mac_age (vlib_main_t * vm,
622 unformat_input_t * input, vlib_cli_command_t * cmd)
624 bd_main_t *bdm = &bd_main;
625 clib_error_t *error = 0;
630 if (!unformat (input, "%d", &bd_id))
632 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
633 format_unformat_error, input);
638 return clib_error_return (0,
639 "No operations on the default bridge domain are supported");
641 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
644 return clib_error_return (0, "No such bridge domain %d", bd_id);
648 if (!unformat (input, "%u", &age))
651 clib_error_return (0, "expecting ageing time in minutes but got `%U'",
652 format_unformat_error, input);
656 /* set the bridge domain flag */
660 clib_error_return (0, "mac aging time cannot be bigger than 255");
663 bd_set_mac_age (vm, bd_index, (u8) age);
670 * Layer 2 mac aging can be enabled and disabled on each
671 * bridge-domain. Use this command to set or disable mac aging
672 * on specific bridge-domains. It is disabled by default.
675 * Example of how to set mac aging (where 200 is the bridge-domain-id and
676 * 5 is aging time in minutes):
677 * @cliexcmd{set bridge-domain mac-age 200 5}
678 * Example of how to disable mac aging (where 200 is the bridge-domain-id):
679 * @cliexcmd{set bridge-domain flood 200 0}
682 VLIB_CLI_COMMAND (bd_mac_age_cli, static) = {
683 .path = "set bridge-domain mac-age",
684 .short_help = "set bridge-domain mac-age <bridge-domain-id> <mins>",
685 .function = bd_mac_age,
690 * Modify whether or not an existing bridge-domain should terminate and respond
691 * to ARP Requests. ARP Termination is disabled by default.
694 * Example of how to enable ARP termination (where 200 is the bridge-domain-id):
695 * @cliexcmd{set bridge-domain arp term 200}
696 * Example of how to disable ARP termination (where 200 is the bridge-domain-id):
697 * @cliexcmd{set bridge-domain arp term 200 disable}
700 VLIB_CLI_COMMAND (bd_arp_term_cli, static) = {
701 .path = "set bridge-domain arp term",
702 .short_help = "set bridge-domain arp term <bridge-domain-id> [disable]",
703 .function = bd_arp_term,
709 * Add/delete IP address to MAC address mapping.
711 * The clib hash implementation stores uword entries in the hash table.
712 * The hash table mac_by_ip4 is keyed via IP4 address and store the
713 * 6-byte MAC address directly in the hash table entry uword.
715 * @warning This only works for 64-bit processor with 8-byte uword;
716 * which means this code *WILL NOT WORK* for a 32-bit prcessor with
720 bd_add_del_ip_mac (u32 bd_index,
721 u8 * ip_addr, u8 * mac_addr, u8 is_ip6, u8 is_add)
723 l2_bridge_domain_t *bd_cfg = l2input_bd_config (bd_index);
724 u64 new_mac = *(u64 *) mac_addr;
726 u16 *mac16 = (u16 *) & new_mac;
728 ASSERT (sizeof (uword) == sizeof (u64)); /* make sure uword is 8 bytes */
729 ASSERT (bd_is_valid (bd_cfg));
731 mac16[3] = 0; /* Clear last 2 unsed bytes of the 8-byte MAC address */
734 ip6_address_t *ip6_addr_key;
736 old_mac = (u64 *) hash_get_mem (bd_cfg->mac_by_ip6, ip_addr);
740 { /* new entry - allocate and craete ip6 address key */
741 ip6_addr_key = clib_mem_alloc (sizeof (ip6_address_t));
742 clib_memcpy (ip6_addr_key, ip_addr, sizeof (ip6_address_t));
744 else if (*old_mac == new_mac)
745 { /* same mac entry already exist for ip6 address */
749 { /* updat mac for ip6 address */
750 hp = hash_get_pair (bd_cfg->mac_by_ip6, ip_addr);
751 ip6_addr_key = (ip6_address_t *) hp->key;
753 hash_set_mem (bd_cfg->mac_by_ip6, ip6_addr_key, new_mac);
757 if (old_mac && (*old_mac == new_mac))
759 hp = hash_get_pair (bd_cfg->mac_by_ip6, ip_addr);
760 ip6_addr_key = (ip6_address_t *) hp->key;
761 hash_unset_mem (bd_cfg->mac_by_ip6, ip_addr);
762 clib_mem_free (ip6_addr_key);
770 ip4_address_t ip4_addr = *(ip4_address_t *) ip_addr;
771 old_mac = (u64 *) hash_get (bd_cfg->mac_by_ip4, ip4_addr.as_u32);
774 if (old_mac && (*old_mac == new_mac))
775 return 0; /* mac entry already exist */
776 hash_set (bd_cfg->mac_by_ip4, ip4_addr.as_u32, new_mac);
780 if (old_mac && (*old_mac == new_mac))
781 hash_unset (bd_cfg->mac_by_ip4, ip4_addr.as_u32);
790 Set bridge-domain arp entry add/delete.
792 set bridge-domain arp entry <bridge-domain-id> <ip-addr> <mac-addr> [del]
794 static clib_error_t *
795 bd_arp_entry (vlib_main_t * vm,
796 unformat_input_t * input, vlib_cli_command_t * cmd)
798 bd_main_t *bdm = &bd_main;
799 clib_error_t *error = 0;
807 if (!unformat (input, "%d", &bd_id))
809 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
810 format_unformat_error, input);
815 return clib_error_return (0,
816 "No operations on the default bridge domain are supported");
818 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
823 return clib_error_return (0, "No such bridge domain %d", bd_id);
825 if (unformat (input, "%U", unformat_ip4_address, ip_addr))
829 else if (unformat (input, "%U", unformat_ip6_address, ip_addr))
835 error = clib_error_return (0, "expecting IP address but got `%U'",
836 format_unformat_error, input);
840 if (!unformat (input, "%U", unformat_ethernet_address, mac_addr))
842 error = clib_error_return (0, "expecting MAC address but got `%U'",
843 format_unformat_error, input);
847 if (unformat (input, "del"))
852 /* set the bridge domain flagAdd IP-MAC entry into bridge domain */
853 if (bd_add_del_ip_mac (bd_index, ip_addr, mac_addr, is_ip6, is_add))
855 error = clib_error_return (0, "MAC %s for IP %U and MAC %U failed",
856 is_add ? "add" : "del",
858 format_ip4_address : format_ip6_address,
859 ip_addr, format_ethernet_address, mac_addr);
867 * Add an ARP entry to an existing bridge-domain.
870 * Example of how to add an ARP entry (where 200 is the bridge-domain-id):
871 * @cliexcmd{set bridge-domain arp entry 200 192.168.72.45 52:54:00:3b:83:1a}
872 * Example of how to delete an ARP entry (where 200 is the bridge-domain-id):
873 * @cliexcmd{set bridge-domain arp entry 200 192.168.72.45 52:54:00:3b:83:1a del}
876 VLIB_CLI_COMMAND (bd_arp_entry_cli, static) = {
877 .path = "set bridge-domain arp entry",
878 .short_help = "set bridge-domain arp entry <bridge-domain-id> <ip-addr> <mac-addr> [del]",
879 .function = bd_arp_entry,
884 format_vtr (u8 * s, va_list * args)
886 u32 vtr_op = va_arg (*args, u32);
887 u32 dot1q = va_arg (*args, u32);
888 u32 tag1 = va_arg (*args, u32);
889 u32 tag2 = va_arg (*args, u32);
892 case L2_VTR_DISABLED:
893 return format (s, "none");
895 return format (s, "push-1 %s %d", dot1q ? "dot1q" : "dot1ad", tag1);
897 return format (s, "push-2 %s %d %d", dot1q ? "dot1q" : "dot1ad", tag1,
900 return format (s, "pop-1");
902 return format (s, "pop-2");
903 case L2_VTR_TRANSLATE_1_1:
904 return format (s, "trans-1-1 %s %d", dot1q ? "dot1q" : "dot1ad", tag1);
905 case L2_VTR_TRANSLATE_1_2:
906 return format (s, "trans-1-2 %s %d %d", dot1q ? "dot1q" : "dot1ad",
908 case L2_VTR_TRANSLATE_2_1:
909 return format (s, "trans-2-1 %s %d", dot1q ? "dot1q" : "dot1ad", tag1);
910 case L2_VTR_TRANSLATE_2_2:
911 return format (s, "trans-2-2 %s %d %d", dot1q ? "dot1q" : "dot1ad",
914 return format (s, "none");
919 Show bridge-domain state.
921 show bridge-domain [<bd_index>]
923 static clib_error_t *
924 bd_show (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
926 vnet_main_t *vnm = vnet_get_main ();
927 bd_main_t *bdm = &bd_main;
928 clib_error_t *error = 0;
930 l2_bridge_domain_t *bd_config;
940 end = vec_len (l2input_main.bd_configs);
942 if (unformat (input, "%d", &bd_id))
944 if (unformat (input, "detail"))
946 else if (unformat (input, "det"))
948 if (unformat (input, "int"))
950 if (unformat (input, "arp"))
952 if (unformat (input, "bd-tag"))
956 return clib_error_return (0,
957 "No operations on the default bridge domain are supported");
959 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
963 return clib_error_return (0, "No such bridge domain %d", bd_id);
965 vec_validate (l2input_main.bd_configs, bd_index);
966 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
967 if (bd_is_valid (bd_config))
974 vlib_cli_output (vm, "bridge-domain %d not in use", bd_id);
979 /* Show all bridge-domains that have been initialized */
982 for (bd_index = start; bd_index < end; bd_index++)
984 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
985 if (bd_is_valid (bd_config))
991 "%=8s %=7s %=4s %=9s %=9s %=9s %=9s %=9s %=9s %=9s",
992 "BD-ID", "Index", "BSN", "Age(min)",
993 "Learning", "U-Forwrd", "UU-Flood", "Flooding",
994 "ARP-Term", "BVI-Intf");
997 if (bd_config->mac_age)
998 as = format (as, "%d", bd_config->mac_age);
1000 as = format (as, "off");
1001 vlib_cli_output (vm,
1002 "%=8d %=7d %=4d %=9v %=9s %=9s %=9s %=9s %=9s %=9U",
1003 bd_config->bd_id, bd_index, bd_config->seq_num, as,
1004 bd_config->feature_bitmap & L2INPUT_FEAT_LEARN ?
1006 bd_config->feature_bitmap & L2INPUT_FEAT_FWD ?
1008 bd_config->feature_bitmap & L2INPUT_FEAT_UU_FLOOD ?
1010 bd_config->feature_bitmap & L2INPUT_FEAT_FLOOD ?
1012 bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM ?
1014 format_vnet_sw_if_index_name_with_NA,
1015 vnm, bd_config->bvi_sw_if_index);
1016 vec_reset_length (as);
1020 /* Show all member interfaces */
1022 vec_foreach_index (i, bd_config->members)
1024 l2_flood_member_t *member =
1025 vec_elt_at_index (bd_config->members, i);
1026 u8 swif_seq_num = *l2fib_swif_seq_num (member->sw_if_index);
1027 u32 vtr_opr, dot1q, tag1, tag2;
1030 vlib_cli_output (vm, "\n%=30s%=7s%=5s%=5s%=5s%=9s%=30s",
1031 "Interface", "If-idx", "ISN", "SHG",
1032 "BVI", "TxFlood", "VLAN-Tag-Rewrite");
1034 l2vtr_get (vm, vnm, member->sw_if_index, &vtr_opr, &dot1q,
1036 vlib_cli_output (vm, "%=30U%=7d%=5d%=5d%=5s%=9s%=30U",
1037 format_vnet_sw_if_index_name, vnm,
1038 member->sw_if_index, member->sw_if_index,
1039 swif_seq_num, member->shg,
1040 member->flags & L2_FLOOD_MEMBER_BVI ? "*" :
1041 "-", i < bd_config->flood_count ? "*" : "-",
1042 format_vtr, vtr_opr, dot1q, tag1, tag2);
1046 if ((detail || arp) &&
1047 (bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM))
1050 ip6_address_t *ip6_addr;
1052 vlib_cli_output (vm,
1053 "\n IP4/IP6 to MAC table for ARP Termination");
1056 hash_foreach (ip4_addr, mac_addr, bd_config->mac_by_ip4,
1058 vlib_cli_output (vm, "%=40U => %=20U",
1059 format_ip4_address, &ip4_addr,
1060 format_ethernet_address, &mac_addr);
1063 hash_foreach_mem (ip6_addr, mac_addr, bd_config->mac_by_ip6,
1065 vlib_cli_output (vm, "%=40U => %=20U",
1066 format_ip6_address, ip6_addr,
1067 format_ethernet_address, &mac_addr);
1072 if ((detail || bd_tag) && (bd_config->bd_tag))
1074 vlib_cli_output (vm, "\n BD-Tag: %s", bd_config->bd_tag);
1083 vlib_cli_output (vm, "no bridge-domains in use");
1091 * Show a summary of all the bridge-domain instances or detailed view of a
1092 * single bridge-domain. Bridge-domains are created by adding an interface
1093 * to a bridge using the '<em>set interface l2 bridge</em>' command.
1097 * Example of displaying all bridge-domains:
1098 * @cliexstart{show bridge-domain}
1099 * ID Index Learning U-Forwrd UU-Flood Flooding ARP-Term BVI-Intf
1100 * 0 0 off off off off off local0
1101 * 200 1 on on on on off N/A
1104 * Example of displaying details of a single bridge-domains:
1105 * @cliexstart{show bridge-domain 200 detail}
1106 * ID Index Learning U-Forwrd UU-Flood Flooding ARP-Term BVI-Intf
1107 * 200 1 on on on on off N/A
1109 * Interface Index SHG BVI VLAN-Tag-Rewrite
1110 * GigabitEthernet0/8/0.200 3 0 - none
1111 * GigabitEthernet0/9/0.200 4 0 - none
1116 VLIB_CLI_COMMAND (bd_show_cli, static) = {
1117 .path = "show bridge-domain",
1118 .short_help = "show bridge-domain [bridge-domain-id [detail|int|arp|bd-tag]]",
1119 .function = bd_show,
1124 bd_add_del (l2_bridge_domain_add_del_args_t * a)
1126 bd_main_t *bdm = &bd_main;
1127 vlib_main_t *vm = bdm->vlib_main;
1130 u32 bd_index = bd_find_index (bdm, a->bd_id);
1134 return VNET_API_ERROR_BD_ALREADY_EXISTS;
1135 if (a->bd_id > L2_BD_ID_MAX)
1136 return VNET_API_ERROR_BD_ID_EXCEED_MAX;
1137 bd_index = bd_add_bd_index (bdm, a->bd_id);
1139 u32 enable_flags = 0, disable_flags = 0;
1141 enable_flags |= L2_FLOOD;
1143 disable_flags |= L2_FLOOD;
1146 enable_flags |= L2_UU_FLOOD;
1148 disable_flags |= L2_UU_FLOOD;
1151 enable_flags |= L2_FWD;
1153 disable_flags |= L2_FWD;
1156 enable_flags |= L2_LEARN;
1158 disable_flags |= L2_LEARN;
1161 enable_flags |= L2_ARP_TERM;
1163 disable_flags |= L2_ARP_TERM;
1166 bd_set_flags (vm, bd_index, enable_flags, 1 /* enable */ );
1169 bd_set_flags (vm, bd_index, disable_flags, 0 /* disable */ );
1171 bd_set_mac_age (vm, bd_index, a->mac_age);
1174 bd_set_bd_tag (vm, bd_index, a->bd_tag);
1180 return VNET_API_ERROR_NO_SUCH_ENTRY;
1182 return VNET_API_ERROR_BD_NOT_MODIFIABLE;
1183 if (vec_len (l2input_main.bd_configs[bd_index].members))
1184 return VNET_API_ERROR_BD_IN_USE;
1185 rv = bd_delete (bdm, bd_index);
1192 Create or delete bridge-domain.
1194 create bridge-domain <bd_index> [learn <0|1>] [forward <0|1>] [uu-flood <0|1>]
1195 [flood <0|1>] [arp-term <0|1>] [mac-age <nn>] [del]
1198 static clib_error_t *
1199 bd_add_del_command_fn (vlib_main_t * vm, unformat_input_t * input,
1200 vlib_cli_command_t * cmd)
1202 unformat_input_t _line_input, *line_input = &_line_input;
1203 clib_error_t *error = 0;
1206 u32 flood = 1, forward = 1, learn = 1, uu_flood = 1, arp_term = 0;
1209 l2_bridge_domain_add_del_args_t _a, *a = &_a;
1212 /* Get a line of input. */
1213 if (!unformat_user (input, unformat_line_input, line_input))
1216 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1218 if (unformat (line_input, "%d", &bd_id))
1220 else if (unformat (line_input, "flood %d", &flood))
1222 else if (unformat (line_input, "uu-flood %d", &uu_flood))
1224 else if (unformat (line_input, "forward %d", &forward))
1226 else if (unformat (line_input, "learn %d", &learn))
1228 else if (unformat (line_input, "arp-term %d", &arp_term))
1230 else if (unformat (line_input, "mac-age %d", &mac_age))
1232 else if (unformat (line_input, "bd-tag %s", &bd_tag))
1234 else if (unformat (line_input, "del"))
1237 flood = uu_flood = forward = learn = 0;
1245 error = clib_error_return (0, "bridge-domain-id not specified");
1251 error = clib_error_return (0, "bridge domain 0 can not be modified");
1257 error = clib_error_return (0, "mac age must be less than 256");
1260 if ((bd_tag) && (strlen ((char *) bd_tag) > 63))
1262 error = clib_error_return (0, "bd-tag cannot be longer than 63");
1266 memset (a, 0, sizeof (*a));
1269 a->flood = (u8) flood;
1270 a->uu_flood = (u8) uu_flood;
1271 a->forward = (u8) forward;
1272 a->learn = (u8) learn;
1273 a->arp_term = (u8) arp_term;
1274 a->mac_age = (u8) mac_age;
1277 rv = bd_add_del (a);
1283 vlib_cli_output (vm, "bridge-domain %d", bd_id);
1285 case VNET_API_ERROR_BD_IN_USE:
1286 error = clib_error_return (0, "bridge domain in use - remove members");
1288 case VNET_API_ERROR_NO_SUCH_ENTRY:
1289 error = clib_error_return (0, "bridge domain ID does not exist");
1291 case VNET_API_ERROR_BD_NOT_MODIFIABLE:
1292 error = clib_error_return (0, "bridge domain 0 can not be modified");
1294 case VNET_API_ERROR_BD_ID_EXCEED_MAX:
1295 error = clib_error_return (0, "bridge domain ID exceed 16M limit");
1298 error = clib_error_return (0, "bd_add_del returned %d", rv);
1304 unformat_free (line_input);
1311 * Create/Delete bridge-domain instance
1315 * Example of creating bridge-domain 1:
1316 * @cliexstart{create bridge-domain 1}
1320 * Example of creating bridge-domain 2 with enabling arp-term, mac-age 60:
1321 * @cliexstart{create bridge-domain 2 arp-term 1 mac-age 60}
1324 * vpp# show bridge-domain
1325 * ID Index BSN Age(min) Learning U-Forwrd UU-Flood Flooding ARP-Term BVI-Intf
1326 * 0 0 0 off off off off off off local0
1327 * 1 1 0 off on on off on off N/A
1328 * 2 2 0 60 on on off on on N/A
1332 * Example of delete bridge-domain 1:
1333 * @cliexstart{create bridge-domain 1 del}
1339 VLIB_CLI_COMMAND (bd_create_cli, static) = {
1340 .path = "create bridge-domain",
1341 .short_help = "create bridge-domain <bridge-domain-id>"
1342 " [learn <0|1>] [forward <0|1>] [uu-flood <0|1>] [flood <0|1>] [arp-term <0|1>]"
1343 " [mac-age <nn>] [bd-tag <tag>] [del]",
1344 .function = bd_add_del_command_fn,
1351 * fd.io coding-style-patch-verification: ON
1354 * eval: (c-set-style "gnu")