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),
68 bd_find_or_add_bd_index (bd_main_t * bdm, u32 bd_id)
76 while (hash_get (bdm->bd_index_by_bd_id, bd_id))
81 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
86 rv = clib_bitmap_first_clear (bdm->bd_index_bitmap);
88 /* mark this index busy */
89 bdm->bd_index_bitmap = clib_bitmap_set (bdm->bd_index_bitmap, rv, 1);
91 hash_set (bdm->bd_index_by_bd_id, bd_id, rv);
93 vec_validate (l2input_main.bd_configs, rv);
94 l2input_main.bd_configs[rv].bd_id = bd_id;
100 bd_delete_bd_index (bd_main_t * bdm, u32 bd_id)
105 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
107 return VNET_API_ERROR_NO_SUCH_ENTRY;
111 /* mark this index clear */
112 bdm->bd_index_bitmap = clib_bitmap_set (bdm->bd_index_bitmap, bd_index, 0);
113 hash_unset (bdm->bd_index_by_bd_id, bd_id);
115 l2input_main.bd_configs[bd_index].bd_id = ~0;
116 l2input_main.bd_configs[bd_index].feature_bitmap = 0;
118 l2fib_flush_bd_mac (vlib_get_main (), bd_index);
124 update_flood_count (l2_bridge_domain_t * bd_config)
126 bd_config->flood_count = vec_len (bd_config->members) -
127 (bd_config->tun_master_count ? bd_config->tun_normal_count : 0);
131 bd_add_member (l2_bridge_domain_t * bd_config, l2_flood_member_t * member)
134 vnet_sw_interface_t *sw_if = vnet_get_sw_interface
135 (vnet_get_main (), member->sw_if_index);
138 * Add one element to the vector
139 * vector is ordered [ bvi, normal/tun_masters..., tun_normals... ]
140 * When flooding, the bvi interface (if present) must be the last member
141 * processed due to how BVI processing can change the packet. To enable
142 * this order, we make the bvi interface the first in the vector and
143 * flooding walks the vector in reverse.
145 switch (sw_if->flood_class)
147 case VNET_FLOOD_CLASS_TUNNEL_MASTER:
148 bd_config->tun_master_count++;
152 case VNET_FLOOD_CLASS_NORMAL:
153 ix = (member->flags & L2_FLOOD_MEMBER_BVI) ? 0 :
154 vec_len (bd_config->members) - bd_config->tun_normal_count;
156 case VNET_FLOOD_CLASS_TUNNEL_NORMAL:
157 ix = vec_len (bd_config->members);
158 bd_config->tun_normal_count++;
162 vec_insert_elts (bd_config->members, member, 1, ix);
163 update_flood_count (bd_config);
166 #define BD_REMOVE_ERROR_OK 0
167 #define BD_REMOVE_ERROR_NOT_FOUND 1
170 bd_remove_member (l2_bridge_domain_t * bd_config, u32 sw_if_index)
174 /* Find and delete the member */
175 vec_foreach_index (ix, bd_config->members)
177 l2_flood_member_t *m = vec_elt_at_index (bd_config->members, ix);
178 if (m->sw_if_index == sw_if_index)
180 vnet_sw_interface_t *sw_if = vnet_get_sw_interface
181 (vnet_get_main (), sw_if_index);
183 if (sw_if->flood_class != VNET_FLOOD_CLASS_NORMAL)
185 if (sw_if->flood_class == VNET_FLOOD_CLASS_TUNNEL_MASTER)
186 bd_config->tun_master_count--;
187 else if (sw_if->flood_class == VNET_FLOOD_CLASS_TUNNEL_NORMAL)
188 bd_config->tun_normal_count--;
190 vec_delete (bd_config->members, 1, ix);
191 update_flood_count (bd_config);
193 return BD_REMOVE_ERROR_OK;
197 return BD_REMOVE_ERROR_NOT_FOUND;
202 l2bd_init (vlib_main_t * vm)
204 bd_main_t *bdm = &bd_main;
206 bdm->bd_index_by_bd_id = hash_create (0, sizeof (uword));
208 * create a dummy bd with bd_id of 0 and bd_index of 0 with feature set
209 * to packet drop only. Thus, packets received from any L2 interface with
210 * uninitialized bd_index of 0 can be dropped safely.
212 bd_index = bd_find_or_add_bd_index (bdm, 0);
213 ASSERT (bd_index == 0);
214 l2input_main.bd_configs[0].feature_bitmap = L2INPUT_FEAT_DROP;
220 VLIB_INIT_FUNCTION (l2bd_init);
224 Set the learn/forward/flood flags for the bridge domain.
225 Return 0 if ok, non-zero if for an error.
228 bd_set_flags (vlib_main_t * vm, u32 bd_index, u32 flags, u32 enable)
231 l2_bridge_domain_t *bd_config;
232 u32 feature_bitmap = 0;
234 vec_validate (l2input_main.bd_configs, bd_index);
235 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
237 bd_validate (bd_config);
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;
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 bridge-domain learn enable/disable.
297 set bridge-domain learn <bd_id> [disable]
299 static clib_error_t *
300 bd_learn (vlib_main_t * vm,
301 unformat_input_t * input, vlib_cli_command_t * cmd)
303 bd_main_t *bdm = &bd_main;
304 clib_error_t *error = 0;
309 if (!unformat (input, "%d", &bd_id))
311 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
312 format_unformat_error, input);
316 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
319 return clib_error_return (0, "No such bridge domain %d", bd_id);
324 if (unformat (input, "disable"))
329 /* set the bridge domain flag */
330 if (bd_set_flags (vm, bd_index, L2_LEARN, enable))
333 clib_error_return (0, "bridge-domain id %d out of range", bd_index);
342 * Layer 2 learning can be enabled and disabled on each
343 * interface and on each bridge-domain. Use this command to
344 * manage bridge-domains. It is enabled by default.
347 * Example of how to enable learning (where 200 is the bridge-domain-id):
348 * @cliexcmd{set bridge-domain learn 200}
349 * Example of how to disable learning (where 200 is the bridge-domain-id):
350 * @cliexcmd{set bridge-domain learn 200 disable}
353 VLIB_CLI_COMMAND (bd_learn_cli, static) = {
354 .path = "set bridge-domain learn",
355 .short_help = "set bridge-domain learn <bridge-domain-id> [disable]",
356 .function = bd_learn,
361 Set bridge-domain forward enable/disable.
363 set bridge-domain forward <bd_index> [disable]
365 static clib_error_t *
366 bd_fwd (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
368 bd_main_t *bdm = &bd_main;
369 clib_error_t *error = 0;
374 if (!unformat (input, "%d", &bd_id))
376 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
377 format_unformat_error, input);
381 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
384 return clib_error_return (0, "No such bridge domain %d", bd_id);
389 if (unformat (input, "disable"))
394 /* set the bridge domain flag */
395 if (bd_set_flags (vm, bd_index, L2_FWD, enable))
398 clib_error_return (0, "bridge-domain id %d out of range", bd_index);
408 * Layer 2 unicast forwarding can be enabled and disabled on each
409 * interface and on each bridge-domain. Use this command to
410 * manage bridge-domains. It is enabled by default.
413 * Example of how to enable forwarding (where 200 is the bridge-domain-id):
414 * @cliexcmd{set bridge-domain forward 200}
415 * Example of how to disable forwarding (where 200 is the bridge-domain-id):
416 * @cliexcmd{set bridge-domain forward 200 disable}
419 VLIB_CLI_COMMAND (bd_fwd_cli, static) = {
420 .path = "set bridge-domain forward",
421 .short_help = "set bridge-domain forward <bridge-domain-id> [disable]",
427 Set bridge-domain flood enable/disable.
429 set bridge-domain flood <bd_index> [disable]
431 static clib_error_t *
432 bd_flood (vlib_main_t * vm,
433 unformat_input_t * input, vlib_cli_command_t * cmd)
435 bd_main_t *bdm = &bd_main;
436 clib_error_t *error = 0;
441 if (!unformat (input, "%d", &bd_id))
443 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
444 format_unformat_error, input);
448 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
451 return clib_error_return (0, "No such bridge domain %d", bd_id);
456 if (unformat (input, "disable"))
461 /* set the bridge domain flag */
462 if (bd_set_flags (vm, bd_index, L2_FLOOD, enable))
465 clib_error_return (0, "bridge-domain id %d out of range", bd_index);
474 * Layer 2 flooding can be enabled and disabled on each
475 * interface and on each bridge-domain. Use this command to
476 * manage bridge-domains. It is enabled by default.
479 * Example of how to enable flooding (where 200 is the bridge-domain-id):
480 * @cliexcmd{set bridge-domain flood 200}
481 * Example of how to disable flooding (where 200 is the bridge-domain-id):
482 * @cliexcmd{set bridge-domain flood 200 disable}
485 VLIB_CLI_COMMAND (bd_flood_cli, static) = {
486 .path = "set bridge-domain flood",
487 .short_help = "set bridge-domain flood <bridge-domain-id> [disable]",
488 .function = bd_flood,
493 Set bridge-domain unkown-unicast flood enable/disable.
495 set bridge-domain uu-flood <bd_index> [disable]
497 static clib_error_t *
498 bd_uu_flood (vlib_main_t * vm,
499 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);
514 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
517 return clib_error_return (0, "No such bridge domain %d", bd_id);
522 if (unformat (input, "disable"))
527 /* set the bridge domain flag */
528 if (bd_set_flags (vm, bd_index, L2_UU_FLOOD, enable))
531 clib_error_return (0, "bridge-domain id %d out of range", bd_index);
540 * Layer 2 unknown-unicast flooding can be enabled and disabled on each
541 * bridge-domain. It is enabled by default.
544 * Example of how to enable unknown-unicast flooding (where 200 is the
546 * @cliexcmd{set bridge-domain uu-flood 200}
547 * Example of how to disable unknown-unicast flooding (where 200 is the bridge-domain-id):
548 * @cliexcmd{set bridge-domain uu-flood 200 disable}
551 VLIB_CLI_COMMAND (bd_uu_flood_cli, static) = {
552 .path = "set bridge-domain uu-flood",
553 .short_help = "set bridge-domain uu-flood <bridge-domain-id> [disable]",
554 .function = bd_uu_flood,
559 Set bridge-domain arp term enable/disable.
561 set bridge-domain arp term <bridge-domain-id> [disable]
563 static clib_error_t *
564 bd_arp_term (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);
580 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
584 return clib_error_return (0, "No such bridge domain %d", bd_id);
587 if (unformat (input, "disable"))
590 /* set the bridge domain flag */
591 if (bd_set_flags (vm, bd_index, L2_ARP_TERM, enable))
594 clib_error_return (0, "bridge-domain id %d out of range", bd_index);
602 static clib_error_t *
603 bd_mac_age (vlib_main_t * vm,
604 unformat_input_t * input, vlib_cli_command_t * cmd)
606 bd_main_t *bdm = &bd_main;
607 clib_error_t *error = 0;
612 if (!unformat (input, "%d", &bd_id))
614 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
615 format_unformat_error, input);
619 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
622 return clib_error_return (0, "No such bridge domain %d", bd_id);
626 if (!unformat (input, "%u", &age))
629 clib_error_return (0, "expecting ageing time in minutes but got `%U'",
630 format_unformat_error, input);
634 /* set the bridge domain flag */
638 clib_error_return (0, "mac aging time cannot be bigger than 255");
641 bd_set_mac_age (vm, bd_index, (u8) age);
648 * Layer 2 mac aging can be enabled and disabled on each
649 * bridge-domain. Use this command to set or disable mac aging
650 * on specific bridge-domains. It is disabled by default.
653 * Example of how to set mac aging (where 200 is the bridge-domain-id and
654 * 5 is aging time in minutes):
655 * @cliexcmd{set bridge-domain mac-age 200 5}
656 * Example of how to disable mac aging (where 200 is the bridge-domain-id):
657 * @cliexcmd{set bridge-domain flood 200 0}
660 VLIB_CLI_COMMAND (bd_mac_age_cli, static) = {
661 .path = "set bridge-domain mac-age",
662 .short_help = "set bridge-domain mac-age <bridge-domain-id> <mins>",
663 .function = bd_mac_age,
668 * Modify whether or not an existing bridge-domain should terminate and respond
669 * to ARP Requests. ARP Termination is disabled by default.
672 * Example of how to enable ARP termination (where 200 is the bridge-domain-id):
673 * @cliexcmd{set bridge-domain arp term 200}
674 * Example of how to disable ARP termination (where 200 is the bridge-domain-id):
675 * @cliexcmd{set bridge-domain arp term 200 disable}
678 VLIB_CLI_COMMAND (bd_arp_term_cli, static) = {
679 .path = "set bridge-domain arp term",
680 .short_help = "set bridge-domain arp term <bridge-domain-id> [disable]",
681 .function = bd_arp_term,
687 * Add/delete IP address to MAC address mapping.
689 * The clib hash implementation stores uword entries in the hash table.
690 * The hash table mac_by_ip4 is keyed via IP4 address and store the
691 * 6-byte MAC address directly in the hash table entry uword.
693 * @warning This only works for 64-bit processor with 8-byte uword;
694 * which means this code *WILL NOT WORK* for a 32-bit prcessor with
698 bd_add_del_ip_mac (u32 bd_index,
699 u8 * ip_addr, u8 * mac_addr, u8 is_ip6, u8 is_add)
701 l2input_main_t *l2im = &l2input_main;
702 l2_bridge_domain_t *bd_cfg = l2input_bd_config_from_index (l2im, bd_index);
703 u64 new_mac = *(u64 *) mac_addr;
705 u16 *mac16 = (u16 *) & new_mac;
707 ASSERT (sizeof (uword) == sizeof (u64)); /* make sure uword is 8 bytes */
709 mac16[3] = 0; /* Clear last 2 unsed bytes of the 8-byte MAC address */
712 ip6_address_t *ip6_addr_key;
714 old_mac = (u64 *) hash_get_mem (bd_cfg->mac_by_ip6, ip_addr);
718 { /* new entry - allocate and craete ip6 address key */
719 ip6_addr_key = clib_mem_alloc (sizeof (ip6_address_t));
720 clib_memcpy (ip6_addr_key, ip_addr, sizeof (ip6_address_t));
722 else if (*old_mac == new_mac)
723 { /* same mac entry already exist for ip6 address */
727 { /* updat mac for ip6 address */
728 hp = hash_get_pair (bd_cfg->mac_by_ip6, ip_addr);
729 ip6_addr_key = (ip6_address_t *) hp->key;
731 hash_set_mem (bd_cfg->mac_by_ip6, ip6_addr_key, new_mac);
735 if (old_mac && (*old_mac == new_mac))
737 hp = hash_get_pair (bd_cfg->mac_by_ip6, ip_addr);
738 ip6_addr_key = (ip6_address_t *) hp->key;
739 hash_unset_mem (bd_cfg->mac_by_ip6, ip_addr);
740 clib_mem_free (ip6_addr_key);
748 ip4_address_t ip4_addr = *(ip4_address_t *) ip_addr;
749 old_mac = (u64 *) hash_get (bd_cfg->mac_by_ip4, ip4_addr.as_u32);
752 if (old_mac && (*old_mac == new_mac))
753 return 0; /* mac entry already exist */
754 hash_set (bd_cfg->mac_by_ip4, ip4_addr.as_u32, new_mac);
758 if (old_mac && (*old_mac == new_mac))
759 hash_unset (bd_cfg->mac_by_ip4, ip4_addr.as_u32);
768 Set bridge-domain arp entry add/delete.
770 set bridge-domain arp entry <bridge-domain-id> <ip-addr> <mac-addr> [del]
772 static clib_error_t *
773 bd_arp_entry (vlib_main_t * vm,
774 unformat_input_t * input, vlib_cli_command_t * cmd)
776 bd_main_t *bdm = &bd_main;
777 clib_error_t *error = 0;
785 if (!unformat (input, "%d", &bd_id))
787 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
788 format_unformat_error, input);
792 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
797 return clib_error_return (0, "No such bridge domain %d", bd_id);
799 if (unformat (input, "%U", unformat_ip4_address, ip_addr))
803 else if (unformat (input, "%U", unformat_ip6_address, ip_addr))
809 error = clib_error_return (0, "expecting IP address but got `%U'",
810 format_unformat_error, input);
814 if (!unformat (input, "%U", unformat_ethernet_address, mac_addr))
816 error = clib_error_return (0, "expecting MAC address but got `%U'",
817 format_unformat_error, input);
821 if (unformat (input, "del"))
826 /* set the bridge domain flagAdd IP-MAC entry into bridge domain */
827 if (bd_add_del_ip_mac (bd_index, ip_addr, mac_addr, is_ip6, is_add))
829 error = clib_error_return (0, "MAC %s for IP %U and MAC %U failed",
830 is_add ? "add" : "del",
832 format_ip4_address : format_ip6_address,
833 ip_addr, format_ethernet_address, mac_addr);
841 * Add an ARP entry to an existing bridge-domain.
844 * Example of how to add an ARP entry (where 200 is the bridge-domain-id):
845 * @cliexcmd{set bridge-domain arp entry 200 192.168.72.45 52:54:00:3b:83:1a}
846 * Example of how to delete an ARP entry (where 200 is the bridge-domain-id):
847 * @cliexcmd{set bridge-domain arp entry 200 192.168.72.45 52:54:00:3b:83:1a del}
850 VLIB_CLI_COMMAND (bd_arp_entry_cli, static) = {
851 .path = "set bridge-domain arp entry",
852 .short_help = "set bridge-domain arp entry <bridge-domain-id> <ip-addr> <mac-addr> [del]",
853 .function = bd_arp_entry,
858 format_vtr (u8 * s, va_list * args)
860 u32 vtr_op = va_arg (*args, u32);
861 u32 dot1q = va_arg (*args, u32);
862 u32 tag1 = va_arg (*args, u32);
863 u32 tag2 = va_arg (*args, u32);
866 case L2_VTR_DISABLED:
867 return format (s, "none");
869 return format (s, "push-1 %s %d", dot1q ? "dot1q" : "dot1ad", tag1);
871 return format (s, "push-2 %s %d %d", dot1q ? "dot1q" : "dot1ad", tag1,
874 return format (s, "pop-1");
876 return format (s, "pop-2");
877 case L2_VTR_TRANSLATE_1_1:
878 return format (s, "trans-1-1 %s %d", dot1q ? "dot1q" : "dot1ad", tag1);
879 case L2_VTR_TRANSLATE_1_2:
880 return format (s, "trans-1-2 %s %d %d", dot1q ? "dot1q" : "dot1ad",
882 case L2_VTR_TRANSLATE_2_1:
883 return format (s, "trans-2-1 %s %d", dot1q ? "dot1q" : "dot1ad", tag1);
884 case L2_VTR_TRANSLATE_2_2:
885 return format (s, "trans-2-2 %s %d %d", dot1q ? "dot1q" : "dot1ad",
888 return format (s, "none");
893 Show bridge-domain state.
895 show bridge-domain [<bd_index>]
897 static clib_error_t *
898 bd_show (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
900 vnet_main_t *vnm = vnet_get_main ();
901 bd_main_t *bdm = &bd_main;
902 clib_error_t *error = 0;
904 l2_bridge_domain_t *bd_config;
913 end = vec_len (l2input_main.bd_configs);
915 if (unformat (input, "%d", &bd_id))
917 if (unformat (input, "detail"))
919 else if (unformat (input, "det"))
921 if (unformat (input, "int"))
923 if (unformat (input, "arp"))
926 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
930 return clib_error_return (0, "No such bridge domain %d", bd_id);
932 vec_validate (l2input_main.bd_configs, bd_index);
933 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
934 if (bd_is_valid (bd_config))
941 vlib_cli_output (vm, "bridge-domain %d not in use", bd_id);
946 /* Show all bridge-domains that have been initialized */
949 for (bd_index = start; bd_index < end; bd_index++)
951 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
952 if (bd_is_valid (bd_config))
958 "%=5s %=7s %=4s %=9s %=9s %=9s %=9s %=9s %=9s %=9s",
959 "ID", "Index", "BSN", "Age(min)", "Learning",
960 "U-Forwrd", "UU-Flood", "Flooding", "ARP-Term",
964 if (bd_config->mac_age)
965 as = format (as, "%d", bd_config->mac_age);
967 as = format (as, "off");
969 "%=5d %=7d %=4d %=9v %=9s %=9s %=9s %=9s %=9s %=9U",
970 bd_config->bd_id, bd_index, bd_config->seq_num, as,
971 bd_config->feature_bitmap & L2INPUT_FEAT_LEARN ?
973 bd_config->feature_bitmap & L2INPUT_FEAT_FWD ?
975 bd_config->feature_bitmap & L2INPUT_FEAT_UU_FLOOD ?
977 bd_config->feature_bitmap & L2INPUT_FEAT_FLOOD ?
979 bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM ?
981 format_vnet_sw_if_index_name_with_NA,
982 vnm, bd_config->bvi_sw_if_index);
983 vec_reset_length (as);
987 /* Show all member interfaces */
989 vec_foreach_index (i, bd_config->members)
991 l2_flood_member_t *member =
992 vec_elt_at_index (bd_config->members, i);
993 l2_input_config_t *int_config =
994 l2input_intf_config (member->sw_if_index);
995 u32 vtr_opr, dot1q, tag1, tag2;
998 vlib_cli_output (vm, "\n%=30s%=7s%=5s%=5s%=5s%=9s%=30s",
999 "Interface", "If-idx", "ISN", "SHG",
1000 "BVI", "TxFlood", "VLAN-Tag-Rewrite");
1002 l2vtr_get (vm, vnm, member->sw_if_index, &vtr_opr, &dot1q,
1004 vlib_cli_output (vm, "%=30U%=7d%=5d%=5d%=5s%=9s%=30U",
1005 format_vnet_sw_if_index_name, vnm,
1006 member->sw_if_index, member->sw_if_index,
1007 int_config->seq_num, member->shg,
1008 member->flags & L2_FLOOD_MEMBER_BVI ? "*" :
1009 "-", i < bd_config->flood_count ? "*" : "-",
1010 format_vtr, vtr_opr, dot1q, tag1, tag2);
1014 if ((detail || arp) &&
1015 (bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM))
1018 ip6_address_t *ip6_addr;
1020 vlib_cli_output (vm,
1021 "\n IP4/IP6 to MAC table for ARP Termination");
1024 hash_foreach (ip4_addr, mac_addr, bd_config->mac_by_ip4,
1026 vlib_cli_output (vm, "%=40U => %=20U",
1027 format_ip4_address, &ip4_addr,
1028 format_ethernet_address, &mac_addr);
1031 hash_foreach_mem (ip6_addr, mac_addr, bd_config->mac_by_ip6,
1033 vlib_cli_output (vm, "%=40U => %=20U",
1034 format_ip6_address, ip6_addr,
1035 format_ethernet_address, &mac_addr);
1045 vlib_cli_output (vm, "no bridge-domains in use");
1053 * Show a summary of all the bridge-domain instances or detailed view of a
1054 * single bridge-domain. Bridge-domains are created by adding an interface
1055 * to a bridge using the '<em>set interface l2 bridge</em>' command.
1059 * Example of displaying all bridge-domains:
1060 * @cliexstart{show bridge-domain}
1061 * ID Index Learning U-Forwrd UU-Flood Flooding ARP-Term BVI-Intf
1062 * 0 0 off off off off off local0
1063 * 200 1 on on on on off N/A
1066 * Example of displaying details of a single bridge-domains:
1067 * @cliexstart{show bridge-domain 200 detail}
1068 * ID Index Learning U-Forwrd UU-Flood Flooding ARP-Term BVI-Intf
1069 * 200 1 on on on on off N/A
1071 * Interface Index SHG BVI VLAN-Tag-Rewrite
1072 * GigabitEthernet0/8/0.200 3 0 - none
1073 * GigabitEthernet0/9/0.200 4 0 - none
1078 VLIB_CLI_COMMAND (bd_show_cli, static) = {
1079 .path = "show bridge-domain",
1080 .short_help = "show bridge-domain [bridge-domain-id [detail|int|arp]]",
1081 .function = bd_show,
1086 bd_add_del (l2_bridge_domain_add_del_args_t * a)
1088 bd_main_t *bdm = &bd_main;
1089 vlib_main_t *vm = bdm->vlib_main;
1090 u32 enable_flags = 0, disable_flags = 0;
1096 bd_index = bd_find_or_add_bd_index (bdm, a->bd_id);
1101 enable_flags |= L2_FLOOD;
1103 disable_flags |= L2_FLOOD;
1106 enable_flags |= L2_UU_FLOOD;
1108 disable_flags |= L2_UU_FLOOD;
1111 enable_flags |= L2_FWD;
1113 disable_flags |= L2_FWD;
1116 enable_flags |= L2_LEARN;
1118 disable_flags |= L2_LEARN;
1121 enable_flags |= L2_ARP_TERM;
1123 disable_flags |= L2_ARP_TERM;
1126 bd_set_flags (vm, bd_index, enable_flags, 1 /* enable */ );
1129 bd_set_flags (vm, bd_index, disable_flags, 0 /* disable */ );
1131 bd_set_mac_age (vm, bd_index, a->mac_age);
1134 rv = bd_delete_bd_index (bdm, a->bd_id);
1140 Create or delete bridge-domain.
1142 create bridge-domain <bd_index> [learn <0|1>] [forward <0|1>] [uu-flood <0|1>]
1143 [flood <0|1>] [arp-term <0|1>] [mac-age <nn>] [del]
1146 static clib_error_t *
1147 bd_add_del_command_fn (vlib_main_t * vm, unformat_input_t * input,
1148 vlib_cli_command_t * cmd)
1150 unformat_input_t _line_input, *line_input = &_line_input;
1151 clib_error_t *error = 0;
1154 u32 flood = 1, forward = 1, learn = 1, uu_flood = 0, arp_term = 0;
1156 l2_bridge_domain_add_del_args_t _a, *a = &_a;
1159 /* Get a line of input. */
1160 if (!unformat_user (input, unformat_line_input, line_input))
1163 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1165 if (unformat (line_input, "%d", &bd_id))
1167 else if (unformat (line_input, "flood %d", &flood))
1169 else if (unformat (line_input, "uu-flood %d", &uu_flood))
1171 else if (unformat (line_input, "forward %d", &forward))
1173 else if (unformat (line_input, "arp-term %d", &arp_term))
1175 else if (unformat (line_input, "mac-age %d", &mac_age))
1177 else if (unformat (line_input, "del"))
1180 flood = uu_flood = forward = learn = 0;
1188 error = clib_error_return (0, "bridge-domain-id not specified");
1194 error = clib_error_return (0, "mac age must be less than 256");
1198 memset (a, 0, sizeof (*a));
1201 a->flood = (u8) flood;
1202 a->uu_flood = (u8) uu_flood;
1203 a->forward = (u8) forward;
1204 a->learn = (u8) learn;
1205 a->arp_term = (u8) arp_term;
1206 a->mac_age = (u8) mac_age;
1208 rv = bd_add_del (a);
1214 vlib_cli_output (vm, "bridge-domain %d", bd_id);
1216 case VNET_API_ERROR_NO_SUCH_ENTRY:
1217 error = clib_error_return (0, "bridge domain id does not exist");
1220 error = clib_error_return (0, "bd_add_del returned %d", rv);
1225 unformat_free (line_input);
1232 * Create/Delete bridge-domain instance
1236 * Example of creating bridge-domain 1:
1237 * @cliexstart{create bridge-domain 1}
1241 * Example of creating bridge-domain 2 with enabling arp-term, mac-age 60:
1242 * @cliexstart{create bridge-domain 2 arp-term 1 mac-age 60}
1245 * vpp# show bridge-domain
1246 * ID Index BSN Age(min) Learning U-Forwrd UU-Flood Flooding ARP-Term BVI-Intf
1247 * 0 0 0 off off off off off off local0
1248 * 1 1 0 off on on off on off N/A
1249 * 2 2 0 60 on on off on on N/A
1253 * Example of delete bridge-domain 1:
1254 * @cliexstart{create bridge-domain 1 del}
1260 VLIB_CLI_COMMAND (bd_create_cli, static) = {
1261 .path = "create bridge-domain",
1262 .short_help = "create bridge-domain <bridge-domain-id>"
1263 " [learn <0|1>] [forward <0|1>] [uu-flood <0|1>] [flood <0|1>] [arp-term <0|1>]"
1264 " [mac-age <nn>] [del]",
1265 .function = bd_add_del_command_fn,
1272 * fd.io coding-style-patch-verification: ON
1275 * eval: (c-set-style "gnu")