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 | L2INPUT_FEAT_UU_FWD);
56 bd_config->bvi_sw_if_index = ~0;
57 bd_config->uu_fwd_sw_if_index = ~0;
58 bd_config->members = 0;
59 bd_config->flood_count = 0;
60 bd_config->tun_master_count = 0;
61 bd_config->tun_normal_count = 0;
62 bd_config->no_flood_count = 0;
63 bd_config->mac_by_ip4 = 0;
64 bd_config->mac_by_ip6 = hash_create_mem (0, sizeof (ip6_address_t),
69 bd_find_index (bd_main_t * bdm, u32 bd_id)
71 u32 *p = (u32 *) hash_get (bdm->bd_index_by_bd_id, bd_id);
78 bd_add_bd_index (bd_main_t * bdm, u32 bd_id)
80 ASSERT (!hash_get (bdm->bd_index_by_bd_id, bd_id));
81 u32 rv = clib_bitmap_first_clear (bdm->bd_index_bitmap);
83 /* mark this index taken */
84 bdm->bd_index_bitmap = clib_bitmap_set (bdm->bd_index_bitmap, rv, 1);
86 hash_set (bdm->bd_index_by_bd_id, bd_id, rv);
88 vec_validate (l2input_main.bd_configs, rv);
89 l2input_main.bd_configs[rv].bd_id = bd_id;
95 bd_free_ip_mac_tables (l2_bridge_domain_t * bd)
98 ip6_address_t *ip6_addr_key;
100 hash_free (bd->mac_by_ip4);
102 hash_foreach_mem (ip6_addr_key, mac_addr, bd->mac_by_ip6,
104 clib_mem_free (ip6_addr_key); /* free memory used for ip6 addr key */
107 hash_free (bd->mac_by_ip6);
111 bd_delete (bd_main_t * bdm, u32 bd_index)
113 l2_bridge_domain_t *bd = &l2input_main.bd_configs[bd_index];
114 u32 bd_id = bd->bd_id;
116 /* flush non-static MACs in BD and removed bd_id from hash table */
117 l2fib_flush_bd_mac (vlib_get_main (), bd_index);
118 hash_unset (bdm->bd_index_by_bd_id, bd_id);
120 /* mark this index clear */
121 bdm->bd_index_bitmap = clib_bitmap_set (bdm->bd_index_bitmap, bd_index, 0);
123 /* clear BD config for reuse: bd_id to -1 and clear feature_bitmap */
125 bd->feature_bitmap = 0;
128 vec_free (bd->bd_tag);
130 /* free memory used by BD */
131 vec_free (bd->members);
132 bd_free_ip_mac_tables (bd);
138 update_flood_count (l2_bridge_domain_t * bd_config)
140 bd_config->flood_count = (vec_len (bd_config->members) -
141 (bd_config->tun_master_count ?
142 bd_config->tun_normal_count : 0));
143 bd_config->flood_count -= bd_config->no_flood_count;
147 bd_add_member (l2_bridge_domain_t * bd_config, l2_flood_member_t * member)
150 vnet_sw_interface_t *sw_if = vnet_get_sw_interface
151 (vnet_get_main (), member->sw_if_index);
154 * Add one element to the vector
155 * vector is ordered [ bvi, normal/tun_masters..., tun_normals... no_flood]
156 * When flooding, the bvi interface (if present) must be the last member
157 * processed due to how BVI processing can change the packet. To enable
158 * this order, we make the bvi interface the first in the vector and
159 * flooding walks the vector in reverse. The flood-count determines where
160 * in the member list to start the walk from.
162 switch (sw_if->flood_class)
164 case VNET_FLOOD_CLASS_NO_FLOOD:
165 bd_config->no_flood_count++;
166 ix = vec_len (bd_config->members);
168 case VNET_FLOOD_CLASS_BVI:
171 case VNET_FLOOD_CLASS_TUNNEL_MASTER:
172 bd_config->tun_master_count++;
174 case VNET_FLOOD_CLASS_NORMAL:
175 ix = (vec_len (bd_config->members) -
176 bd_config->tun_normal_count - bd_config->no_flood_count);
178 case VNET_FLOOD_CLASS_TUNNEL_NORMAL:
179 ix = (vec_len (bd_config->members) - bd_config->no_flood_count);
180 bd_config->tun_normal_count++;
184 vec_insert_elts (bd_config->members, member, 1, ix);
185 update_flood_count (bd_config);
188 #define BD_REMOVE_ERROR_OK 0
189 #define BD_REMOVE_ERROR_NOT_FOUND 1
192 bd_remove_member (l2_bridge_domain_t * bd_config, u32 sw_if_index)
196 /* Find and delete the member */
197 vec_foreach_index (ix, bd_config->members)
199 l2_flood_member_t *m = vec_elt_at_index (bd_config->members, ix);
200 if (m->sw_if_index == sw_if_index)
202 vnet_sw_interface_t *sw_if = vnet_get_sw_interface
203 (vnet_get_main (), sw_if_index);
205 if (sw_if->flood_class != VNET_FLOOD_CLASS_NORMAL)
207 if (sw_if->flood_class == VNET_FLOOD_CLASS_TUNNEL_MASTER)
208 bd_config->tun_master_count--;
209 else if (sw_if->flood_class == VNET_FLOOD_CLASS_TUNNEL_NORMAL)
210 bd_config->tun_normal_count--;
211 else if (sw_if->flood_class == VNET_FLOOD_CLASS_NO_FLOOD)
212 bd_config->no_flood_count--;
214 vec_delete (bd_config->members, 1, ix);
215 update_flood_count (bd_config);
217 return BD_REMOVE_ERROR_OK;
221 return BD_REMOVE_ERROR_NOT_FOUND;
226 l2bd_init (vlib_main_t * vm)
228 bd_main_t *bdm = &bd_main;
229 bdm->bd_index_by_bd_id = hash_create (0, sizeof (uword));
231 * create a dummy bd with bd_id of 0 and bd_index of 0 with feature set
232 * to packet drop only. Thus, packets received from any L2 interface with
233 * uninitialized bd_index of 0 can be dropped safely.
235 u32 bd_index = bd_add_bd_index (bdm, 0);
236 ASSERT (bd_index == 0);
237 l2input_main.bd_configs[0].feature_bitmap = L2INPUT_FEAT_DROP;
243 VLIB_INIT_FUNCTION (l2bd_init);
247 Set the learn/forward/flood flags for the bridge domain.
248 Return 0 if ok, non-zero if for an error.
251 bd_set_flags (vlib_main_t * vm, u32 bd_index, bd_flags_t flags, u32 enable)
254 l2_bridge_domain_t *bd_config = l2input_bd_config (bd_index);
255 bd_validate (bd_config);
256 u32 feature_bitmap = 0;
258 if (flags & L2_LEARN)
260 feature_bitmap |= L2INPUT_FEAT_LEARN;
264 feature_bitmap |= L2INPUT_FEAT_FWD;
266 if (flags & L2_FLOOD)
268 feature_bitmap |= L2INPUT_FEAT_FLOOD;
270 if (flags & L2_UU_FLOOD)
272 feature_bitmap |= L2INPUT_FEAT_UU_FLOOD;
274 if (flags & L2_ARP_TERM)
276 feature_bitmap |= L2INPUT_FEAT_ARP_TERM;
281 bd_config->feature_bitmap |= feature_bitmap;
285 bd_config->feature_bitmap &= ~feature_bitmap;
288 return bd_config->feature_bitmap;
292 Set the mac age for the bridge domain.
295 bd_set_mac_age (vlib_main_t * vm, u32 bd_index, u8 age)
297 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);
302 bd_config->mac_age = age;
304 /* check if there is at least one bd with mac aging enabled */
305 vec_foreach (bd_config, l2input_main.bd_configs)
306 enable |= bd_config->bd_id != ~0 && bd_config->mac_age != 0;
308 vlib_process_signal_event (vm, l2fib_mac_age_scanner_process_node.index,
309 enable ? L2_MAC_AGE_PROCESS_EVENT_START :
310 L2_MAC_AGE_PROCESS_EVENT_STOP, 0);
314 Set the tag for the bridge domain.
318 bd_set_bd_tag (vlib_main_t * vm, u32 bd_index, u8 * bd_tag)
321 l2_bridge_domain_t *bd_config;
322 vec_validate (l2input_main.bd_configs, bd_index);
323 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
325 old = bd_config->bd_tag;
329 bd_config->bd_tag = format (0, "%s%c", bd_tag, 0);
333 bd_config->bd_tag = NULL;
340 Set bridge-domain learn enable/disable.
342 set bridge-domain learn <bd_id> [disable]
344 static clib_error_t *
345 bd_learn (vlib_main_t * vm,
346 unformat_input_t * input, vlib_cli_command_t * cmd)
348 bd_main_t *bdm = &bd_main;
349 clib_error_t *error = 0;
354 if (!unformat (input, "%d", &bd_id))
356 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
357 format_unformat_error, input);
362 return clib_error_return (0,
363 "No operations on the default bridge domain are supported");
365 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
368 return clib_error_return (0, "No such bridge domain %d", bd_id);
373 if (unformat (input, "disable"))
378 /* set the bridge domain flag */
379 bd_set_flags (vm, bd_index, L2_LEARN, enable);
386 * Layer 2 learning can be enabled and disabled on each
387 * interface and on each bridge-domain. Use this command to
388 * manage bridge-domains. It is enabled by default.
391 * Example of how to enable learning (where 200 is the bridge-domain-id):
392 * @cliexcmd{set bridge-domain learn 200}
393 * Example of how to disable learning (where 200 is the bridge-domain-id):
394 * @cliexcmd{set bridge-domain learn 200 disable}
397 VLIB_CLI_COMMAND (bd_learn_cli, static) = {
398 .path = "set bridge-domain learn",
399 .short_help = "set bridge-domain learn <bridge-domain-id> [disable]",
400 .function = bd_learn,
405 Set bridge-domain forward enable/disable.
407 set bridge-domain forward <bd_index> [disable]
409 static clib_error_t *
410 bd_fwd (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
412 bd_main_t *bdm = &bd_main;
413 clib_error_t *error = 0;
418 if (!unformat (input, "%d", &bd_id))
420 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
421 format_unformat_error, input);
426 return clib_error_return (0,
427 "No operations on the default bridge domain are supported");
429 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
432 return clib_error_return (0, "No such bridge domain %d", bd_id);
437 if (unformat (input, "disable"))
442 /* set the bridge domain flag */
443 bd_set_flags (vm, bd_index, L2_FWD, enable);
451 * Layer 2 unicast forwarding can be enabled and disabled on each
452 * interface and on each bridge-domain. Use this command to
453 * manage bridge-domains. It is enabled by default.
456 * Example of how to enable forwarding (where 200 is the bridge-domain-id):
457 * @cliexcmd{set bridge-domain forward 200}
458 * Example of how to disable forwarding (where 200 is the bridge-domain-id):
459 * @cliexcmd{set bridge-domain forward 200 disable}
462 VLIB_CLI_COMMAND (bd_fwd_cli, static) = {
463 .path = "set bridge-domain forward",
464 .short_help = "set bridge-domain forward <bridge-domain-id> [disable]",
470 Set bridge-domain flood enable/disable.
472 set bridge-domain flood <bd_index> [disable]
474 static clib_error_t *
475 bd_flood (vlib_main_t * vm,
476 unformat_input_t * input, vlib_cli_command_t * cmd)
478 bd_main_t *bdm = &bd_main;
479 clib_error_t *error = 0;
484 if (!unformat (input, "%d", &bd_id))
486 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
487 format_unformat_error, input);
492 return clib_error_return (0,
493 "No operations on the default bridge domain are supported");
495 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
498 return clib_error_return (0, "No such bridge domain %d", bd_id);
503 if (unformat (input, "disable"))
508 /* set the bridge domain flag */
509 bd_set_flags (vm, bd_index, L2_FLOOD, enable);
516 * Layer 2 flooding can be enabled and disabled on each
517 * interface and on each bridge-domain. Use this command to
518 * manage bridge-domains. It is enabled by default.
521 * Example of how to enable flooding (where 200 is the bridge-domain-id):
522 * @cliexcmd{set bridge-domain flood 200}
523 * Example of how to disable flooding (where 200 is the bridge-domain-id):
524 * @cliexcmd{set bridge-domain flood 200 disable}
527 VLIB_CLI_COMMAND (bd_flood_cli, static) = {
528 .path = "set bridge-domain flood",
529 .short_help = "set bridge-domain flood <bridge-domain-id> [disable]",
530 .function = bd_flood,
535 Set bridge-domain unknown-unicast flood enable/disable.
537 set bridge-domain uu-flood <bd_index> [disable]
539 static clib_error_t *
540 bd_uu_flood (vlib_main_t * vm,
541 unformat_input_t * input, vlib_cli_command_t * cmd)
543 bd_main_t *bdm = &bd_main;
544 clib_error_t *error = 0;
549 if (!unformat (input, "%d", &bd_id))
551 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
552 format_unformat_error, input);
557 return clib_error_return (0,
558 "No operations on the default bridge domain are supported");
560 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
563 return clib_error_return (0, "No such bridge domain %d", bd_id);
568 if (unformat (input, "disable"))
573 /* set the bridge domain flag */
574 bd_set_flags (vm, bd_index, L2_UU_FLOOD, enable);
581 * Layer 2 unknown-unicast flooding can be enabled and disabled on each
582 * bridge-domain. It is enabled by default.
585 * Example of how to enable unknown-unicast flooding (where 200 is the
587 * @cliexcmd{set bridge-domain uu-flood 200}
588 * Example of how to disable unknown-unicast flooding (where 200 is the bridge-domain-id):
589 * @cliexcmd{set bridge-domain uu-flood 200 disable}
592 VLIB_CLI_COMMAND (bd_uu_flood_cli, static) = {
593 .path = "set bridge-domain uu-flood",
594 .short_help = "set bridge-domain uu-flood <bridge-domain-id> [disable]",
595 .function = bd_uu_flood,
600 Set bridge-domain arp term enable/disable.
602 set bridge-domain arp term <bridge-domain-id> [disable]
604 static clib_error_t *
605 bd_arp_term (vlib_main_t * vm,
606 unformat_input_t * input, vlib_cli_command_t * cmd)
608 bd_main_t *bdm = &bd_main;
609 clib_error_t *error = 0;
614 if (!unformat (input, "%d", &bd_id))
616 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
617 format_unformat_error, input);
622 return clib_error_return (0,
623 "No operations on the default bridge domain are supported");
625 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
629 return clib_error_return (0, "No such bridge domain %d", bd_id);
632 if (unformat (input, "disable"))
635 /* set the bridge domain flag */
636 bd_set_flags (vm, bd_index, L2_ARP_TERM, enable);
642 static clib_error_t *
643 bd_mac_age (vlib_main_t * vm,
644 unformat_input_t * input, vlib_cli_command_t * cmd)
646 bd_main_t *bdm = &bd_main;
647 clib_error_t *error = 0;
652 if (!unformat (input, "%d", &bd_id))
654 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
655 format_unformat_error, input);
660 return clib_error_return (0,
661 "No operations on the default bridge domain are supported");
663 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
666 return clib_error_return (0, "No such bridge domain %d", bd_id);
670 if (!unformat (input, "%u", &age))
673 clib_error_return (0, "expecting ageing time in minutes but got `%U'",
674 format_unformat_error, input);
678 /* set the bridge domain flag */
682 clib_error_return (0, "mac aging time cannot be bigger than 255");
685 bd_set_mac_age (vm, bd_index, (u8) age);
692 * Layer 2 mac aging can be enabled and disabled on each
693 * bridge-domain. Use this command to set or disable mac aging
694 * on specific bridge-domains. It is disabled by default.
697 * Example of how to set mac aging (where 200 is the bridge-domain-id and
698 * 5 is aging time in minutes):
699 * @cliexcmd{set bridge-domain mac-age 200 5}
700 * Example of how to disable mac aging (where 200 is the bridge-domain-id):
701 * @cliexcmd{set bridge-domain flood 200 0}
704 VLIB_CLI_COMMAND (bd_mac_age_cli, static) = {
705 .path = "set bridge-domain mac-age",
706 .short_help = "set bridge-domain mac-age <bridge-domain-id> <mins>",
707 .function = bd_mac_age,
712 * Modify whether or not an existing bridge-domain should terminate and respond
713 * to ARP Requests. ARP Termination is disabled by default.
716 * Example of how to enable ARP termination (where 200 is the bridge-domain-id):
717 * @cliexcmd{set bridge-domain arp term 200}
718 * Example of how to disable ARP termination (where 200 is the bridge-domain-id):
719 * @cliexcmd{set bridge-domain arp term 200 disable}
722 VLIB_CLI_COMMAND (bd_arp_term_cli, static) = {
723 .path = "set bridge-domain arp term",
724 .short_help = "set bridge-domain arp term <bridge-domain-id> [disable]",
725 .function = bd_arp_term,
731 * Add/delete IP address to MAC address mapping.
733 * The clib hash implementation stores uword entries in the hash table.
734 * The hash table mac_by_ip4 is keyed via IP4 address and store the
735 * 6-byte MAC address directly in the hash table entry uword.
737 * @warning This only works for 64-bit processor with 8-byte uword;
738 * which means this code *WILL NOT WORK* for a 32-bit processor with
742 bd_add_del_ip_mac (u32 bd_index,
744 const ip46_address_t * ip,
745 const mac_address_t * mac, u8 is_add)
747 l2_bridge_domain_t *bd_cfg = l2input_bd_config (bd_index);
748 u64 new_mac = mac_address_as_u64 (mac);
751 /* make sure uword is 8 bytes */
752 ASSERT (sizeof (uword) == sizeof (u64));
753 ASSERT (bd_is_valid (bd_cfg));
755 if (IP46_TYPE_IP6 == type)
757 ip6_address_t *ip6_addr_key;
759 old_mac = (u64 *) hash_get_mem (bd_cfg->mac_by_ip6, &ip->ip6);
764 /* new entry - allocate and create ip6 address key */
765 ip6_addr_key = clib_mem_alloc (sizeof (ip6_address_t));
766 clib_memcpy (ip6_addr_key, &ip->ip6, sizeof (ip6_address_t));
768 else if (*old_mac == new_mac)
770 /* same mac entry already exist for ip6 address */
775 /* update mac for ip6 address */
776 hp = hash_get_pair (bd_cfg->mac_by_ip6, &ip->ip6);
777 ip6_addr_key = (ip6_address_t *) hp->key;
779 hash_set_mem (bd_cfg->mac_by_ip6, ip6_addr_key, new_mac);
783 if (old_mac && (*old_mac == new_mac))
785 hp = hash_get_pair (bd_cfg->mac_by_ip6, &ip->ip6);
786 ip6_addr_key = (ip6_address_t *) hp->key;
787 hash_unset_mem (bd_cfg->mac_by_ip6, &ip->ip6);
788 clib_mem_free (ip6_addr_key);
796 old_mac = (u64 *) hash_get (bd_cfg->mac_by_ip4, ip->ip4.as_u32);
799 if (old_mac && (*old_mac == new_mac))
800 /* mac entry already exist */
802 hash_set (bd_cfg->mac_by_ip4, ip->ip4.as_u32, new_mac);
806 if (old_mac && (*old_mac == new_mac))
807 hash_unset (bd_cfg->mac_by_ip4, ip->ip4.as_u32);
816 * Flush IP address to MAC address mapping tables in a BD.
819 bd_flush_ip_mac (u32 bd_index)
821 l2_bridge_domain_t *bd = l2input_bd_config (bd_index);
822 ASSERT (bd_is_valid (bd));
823 bd_free_ip_mac_tables (bd);
826 hash_create_mem (0, sizeof (ip6_address_t), sizeof (uword));
830 Set bridge-domain arp entry add/delete.
832 set bridge-domain arp entry <bridge-domain-id> <ip-addr> <mac-addr> [del]
834 static clib_error_t *
835 bd_arp_entry (vlib_main_t * vm,
836 unformat_input_t * input, vlib_cli_command_t * cmd)
838 ip46_address_t ip_addr = ip46_address_initializer;
839 ip46_type_t type = IP46_TYPE_IP4;
840 bd_main_t *bdm = &bd_main;
841 clib_error_t *error = 0;
847 if (!unformat (input, "%d", &bd_id))
849 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
850 format_unformat_error, input);
855 return clib_error_return (0,
856 "No operations on the default bridge domain are supported");
858 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
863 return clib_error_return (0, "No such bridge domain %d", bd_id);
865 if (unformat (input, "%U", unformat_ip4_address, &ip_addr.ip4))
867 type = IP46_TYPE_IP4;
869 else if (unformat (input, "%U", unformat_ip6_address, &ip_addr.ip6))
871 type = IP46_TYPE_IP6;
873 else if (unformat (input, "del-all"))
875 bd_flush_ip_mac (bd_index);
880 error = clib_error_return (0, "expecting IP address but got `%U'",
881 format_unformat_error, input);
885 if (!unformat (input, "%U", unformat_mac_address_t, &mac))
887 error = clib_error_return (0, "expecting MAC address but got `%U'",
888 format_unformat_error, input);
892 if (unformat (input, "del"))
897 /* set the bridge domain flagAdd IP-MAC entry into bridge domain */
898 if (bd_add_del_ip_mac (bd_index, type, &ip_addr, &mac, is_add))
900 error = clib_error_return (0, "MAC %s for IP %U and MAC %U failed",
901 is_add ? "add" : "del",
902 format_ip46_address, &ip_addr, IP46_TYPE_ANY,
903 format_mac_address_t, &mac);
911 * Add an ARP entry to an existing bridge-domain.
914 * Example of how to add an ARP entry (where 200 is the bridge-domain-id):
915 * @cliexcmd{set bridge-domain arp entry 200 192.168.72.45 52:54:00:3b:83:1a}
916 * Example of how to delete an ARP entry (where 200 is the bridge-domain-id):
917 * @cliexcmd{set bridge-domain arp entry 200 192.168.72.45 52:54:00:3b:83:1a del}
920 VLIB_CLI_COMMAND (bd_arp_entry_cli, static) = {
921 .path = "set bridge-domain arp entry",
922 .short_help = "set bridge-domain arp entry <bridge-domain-id> [<ip-addr> <mac-addr> [del] | del-all]",
923 .function = bd_arp_entry,
928 format_vtr (u8 * s, va_list * args)
930 u32 vtr_op = va_arg (*args, u32);
931 u32 dot1q = va_arg (*args, u32);
932 u32 tag1 = va_arg (*args, u32);
933 u32 tag2 = va_arg (*args, u32);
936 case L2_VTR_DISABLED:
937 return format (s, "none");
939 return format (s, "push-1 %s %d", dot1q ? "dot1q" : "dot1ad", tag1);
941 return format (s, "push-2 %s %d %d", dot1q ? "dot1q" : "dot1ad", tag1,
944 return format (s, "pop-1");
946 return format (s, "pop-2");
947 case L2_VTR_TRANSLATE_1_1:
948 return format (s, "trans-1-1 %s %d", dot1q ? "dot1q" : "dot1ad", tag1);
949 case L2_VTR_TRANSLATE_1_2:
950 return format (s, "trans-1-2 %s %d %d", dot1q ? "dot1q" : "dot1ad",
952 case L2_VTR_TRANSLATE_2_1:
953 return format (s, "trans-2-1 %s %d", dot1q ? "dot1q" : "dot1ad", tag1);
954 case L2_VTR_TRANSLATE_2_2:
955 return format (s, "trans-2-2 %s %d %d", dot1q ? "dot1q" : "dot1ad",
958 return format (s, "none");
963 format_uu_cfg (u8 * s, va_list * args)
965 l2_bridge_domain_t *bd_config = va_arg (*args, l2_bridge_domain_t *);
967 if (bd_config->feature_bitmap & L2INPUT_FEAT_UU_FWD)
968 return (format (s, "%U", format_vnet_sw_if_index_name_with_NA,
969 vnet_get_main (), bd_config->uu_fwd_sw_if_index));
970 else if (bd_config->feature_bitmap & L2INPUT_FEAT_UU_FLOOD)
971 return (format (s, "flood"));
973 return (format (s, "drop"));
977 Show bridge-domain state.
979 show bridge-domain [<bd_index>]
981 static clib_error_t *
982 bd_show (vlib_main_t * vm, unformat_input_t * input, vlib_cli_command_t * cmd)
984 vnet_main_t *vnm = vnet_get_main ();
985 bd_main_t *bdm = &bd_main;
986 clib_error_t *error = 0;
988 l2_bridge_domain_t *bd_config;
998 end = vec_len (l2input_main.bd_configs);
1000 if (unformat (input, "%d", &bd_id))
1002 if (unformat (input, "detail"))
1004 else if (unformat (input, "det"))
1006 if (unformat (input, "int"))
1008 if (unformat (input, "arp"))
1010 if (unformat (input, "bd-tag"))
1014 return clib_error_return (0,
1015 "No operations on the default bridge domain are supported");
1017 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
1021 return clib_error_return (0, "No such bridge domain %d", bd_id);
1023 vec_validate (l2input_main.bd_configs, bd_index);
1024 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
1025 if (bd_is_valid (bd_config))
1032 vlib_cli_output (vm, "bridge-domain %d not in use", bd_id);
1037 /* Show all bridge-domains that have been initialized */
1040 for (bd_index = start; bd_index < end; bd_index++)
1042 bd_config = vec_elt_at_index (l2input_main.bd_configs, bd_index);
1043 if (bd_is_valid (bd_config))
1048 vlib_cli_output (vm,
1049 "%=8s %=7s %=4s %=9s %=9s %=9s %=11s %=9s %=9s %=11s",
1050 "BD-ID", "Index", "BSN", "Age(min)",
1051 "Learning", "U-Forwrd", "UU-Flood",
1052 "Flooding", "ARP-Term", "BVI-Intf");
1055 if (bd_config->mac_age)
1056 as = format (as, "%d", bd_config->mac_age);
1058 as = format (as, "off");
1059 vlib_cli_output (vm,
1060 "%=8d %=7d %=4d %=9v %=9s %=9s %=11U %=9s %=9s %=11U",
1061 bd_config->bd_id, bd_index, bd_config->seq_num, as,
1062 bd_config->feature_bitmap & L2INPUT_FEAT_LEARN ?
1064 bd_config->feature_bitmap & L2INPUT_FEAT_FWD ?
1066 format_uu_cfg, bd_config,
1067 bd_config->feature_bitmap & L2INPUT_FEAT_FLOOD ?
1069 bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM ?
1071 format_vnet_sw_if_index_name_with_NA,
1072 vnm, bd_config->bvi_sw_if_index);
1073 vec_reset_length (as);
1077 /* Show all member interfaces */
1079 vec_foreach_index (i, bd_config->members)
1081 l2_flood_member_t *member =
1082 vec_elt_at_index (bd_config->members, i);
1083 u8 swif_seq_num = *l2fib_swif_seq_num (member->sw_if_index);
1084 u32 vtr_opr, dot1q, tag1, tag2;
1087 vlib_cli_output (vm, "\n%=30s%=7s%=5s%=5s%=5s%=9s%=30s",
1088 "Interface", "If-idx", "ISN", "SHG",
1089 "BVI", "TxFlood", "VLAN-Tag-Rewrite");
1091 l2vtr_get (vm, vnm, member->sw_if_index, &vtr_opr, &dot1q,
1093 vlib_cli_output (vm, "%=30U%=7d%=5d%=5d%=5s%=9s%=30U",
1094 format_vnet_sw_if_index_name, vnm,
1095 member->sw_if_index, member->sw_if_index,
1096 swif_seq_num, member->shg,
1097 member->flags & L2_FLOOD_MEMBER_BVI ? "*" :
1098 "-", i < bd_config->flood_count ? "*" : "-",
1099 format_vtr, vtr_opr, dot1q, tag1, tag2);
1101 if (~0 != bd_config->uu_fwd_sw_if_index)
1102 vlib_cli_output (vm, "%=30U%=7d%=5d%=5d%=5s%=9s%=30s",
1103 format_vnet_sw_if_index_name, vnm,
1104 bd_config->uu_fwd_sw_if_index,
1105 bd_config->uu_fwd_sw_if_index,
1106 0, 0, "uu", "-", "None");
1110 if ((detail || arp) &&
1111 (bd_config->feature_bitmap & L2INPUT_FEAT_ARP_TERM))
1114 ip6_address_t *ip6_addr;
1116 vlib_cli_output (vm,
1117 "\n IP4/IP6 to MAC table for ARP Termination");
1120 hash_foreach (ip4_addr, mac_addr, bd_config->mac_by_ip4,
1122 vlib_cli_output (vm, "%=40U => %=20U",
1123 format_ip4_address, &ip4_addr,
1124 format_ethernet_address, &mac_addr);
1127 hash_foreach_mem (ip6_addr, mac_addr, bd_config->mac_by_ip6,
1129 vlib_cli_output (vm, "%=40U => %=20U",
1130 format_ip6_address, ip6_addr,
1131 format_ethernet_address, &mac_addr);
1136 if ((detail || bd_tag) && (bd_config->bd_tag))
1138 vlib_cli_output (vm, "\n BD-Tag: %s", bd_config->bd_tag);
1147 vlib_cli_output (vm, "no bridge-domains in use");
1155 * Show a summary of all the bridge-domain instances or detailed view of a
1156 * single bridge-domain. Bridge-domains are created by adding an interface
1157 * to a bridge using the '<em>set interface l2 bridge</em>' command.
1161 * Example of displaying all bridge-domains:
1162 * @cliexstart{show bridge-domain}
1163 * ID Index Learning U-Forwrd UU-Flood Flooding ARP-Term BVI-Intf
1164 * 0 0 off off off off off local0
1165 * 200 1 on on on on off N/A
1168 * Example of displaying details of a single bridge-domains:
1169 * @cliexstart{show bridge-domain 200 detail}
1170 * ID Index Learning U-Forwrd UU-Flood Flooding ARP-Term BVI-Intf
1171 * 200 1 on on on on off N/A
1173 * Interface Index SHG BVI VLAN-Tag-Rewrite
1174 * GigabitEthernet0/8/0.200 3 0 - none
1175 * GigabitEthernet0/9/0.200 4 0 - none
1180 VLIB_CLI_COMMAND (bd_show_cli, static) = {
1181 .path = "show bridge-domain",
1182 .short_help = "show bridge-domain [bridge-domain-id [detail|int|arp|bd-tag]]",
1183 .function = bd_show,
1188 bd_add_del (l2_bridge_domain_add_del_args_t * a)
1190 bd_main_t *bdm = &bd_main;
1191 vlib_main_t *vm = bdm->vlib_main;
1194 u32 bd_index = bd_find_index (bdm, a->bd_id);
1198 return VNET_API_ERROR_BD_ALREADY_EXISTS;
1199 if (a->bd_id > L2_BD_ID_MAX)
1200 return VNET_API_ERROR_BD_ID_EXCEED_MAX;
1201 bd_index = bd_add_bd_index (bdm, a->bd_id);
1203 bd_flags_t enable_flags = 0, disable_flags = 0;
1205 enable_flags |= L2_FLOOD;
1207 disable_flags |= L2_FLOOD;
1210 enable_flags |= L2_UU_FLOOD;
1212 disable_flags |= L2_UU_FLOOD;
1215 enable_flags |= L2_FWD;
1217 disable_flags |= L2_FWD;
1220 enable_flags |= L2_LEARN;
1222 disable_flags |= L2_LEARN;
1225 enable_flags |= L2_ARP_TERM;
1227 disable_flags |= L2_ARP_TERM;
1230 bd_set_flags (vm, bd_index, enable_flags, 1 /* enable */ );
1233 bd_set_flags (vm, bd_index, disable_flags, 0 /* disable */ );
1235 bd_set_mac_age (vm, bd_index, a->mac_age);
1238 bd_set_bd_tag (vm, bd_index, a->bd_tag);
1244 return VNET_API_ERROR_NO_SUCH_ENTRY;
1246 return VNET_API_ERROR_BD_NOT_MODIFIABLE;
1247 if (vec_len (l2input_main.bd_configs[bd_index].members))
1248 return VNET_API_ERROR_BD_IN_USE;
1249 rv = bd_delete (bdm, bd_index);
1256 Create or delete bridge-domain.
1258 create bridge-domain <bd_index> [learn <0|1>] [forward <0|1>] [uu-flood <0|1>] [flood <0|1>]
1259 [arp-term <0|1>] [mac-age <nn>] [bd-tag <tag>] [del]
1262 static clib_error_t *
1263 bd_add_del_command_fn (vlib_main_t * vm, unformat_input_t * input,
1264 vlib_cli_command_t * cmd)
1266 unformat_input_t _line_input, *line_input = &_line_input;
1267 clib_error_t *error = 0;
1270 u32 flood = 1, forward = 1, learn = 1, uu_flood = 1, arp_term = 0;
1273 l2_bridge_domain_add_del_args_t _a, *a = &_a;
1276 /* Get a line of input. */
1277 if (!unformat_user (input, unformat_line_input, line_input))
1280 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1282 if (unformat (line_input, "%d", &bd_id))
1284 else if (unformat (line_input, "flood %d", &flood))
1286 else if (unformat (line_input, "uu-flood %d", &uu_flood))
1288 else if (unformat (line_input, "forward %d", &forward))
1290 else if (unformat (line_input, "learn %d", &learn))
1292 else if (unformat (line_input, "arp-term %d", &arp_term))
1294 else if (unformat (line_input, "mac-age %d", &mac_age))
1296 else if (unformat (line_input, "bd-tag %s", &bd_tag))
1298 else if (unformat (line_input, "del"))
1301 flood = uu_flood = forward = learn = 0;
1309 error = clib_error_return (0, "bridge-domain-id not specified");
1315 error = clib_error_return (0, "bridge domain 0 can not be modified");
1321 error = clib_error_return (0, "mac age must be less than 256");
1324 if ((bd_tag) && (strlen ((char *) bd_tag) > 63))
1326 error = clib_error_return (0, "bd-tag cannot be longer than 63");
1330 clib_memset (a, 0, sizeof (*a));
1333 a->flood = (u8) flood;
1334 a->uu_flood = (u8) uu_flood;
1335 a->forward = (u8) forward;
1336 a->learn = (u8) learn;
1337 a->arp_term = (u8) arp_term;
1338 a->mac_age = (u8) mac_age;
1341 rv = bd_add_del (a);
1347 vlib_cli_output (vm, "bridge-domain %d", bd_id);
1349 case VNET_API_ERROR_BD_IN_USE:
1350 error = clib_error_return (0, "bridge domain in use - remove members");
1352 case VNET_API_ERROR_NO_SUCH_ENTRY:
1353 error = clib_error_return (0, "bridge domain ID does not exist");
1355 case VNET_API_ERROR_BD_NOT_MODIFIABLE:
1356 error = clib_error_return (0, "bridge domain 0 can not be modified");
1358 case VNET_API_ERROR_BD_ID_EXCEED_MAX:
1359 error = clib_error_return (0, "bridge domain ID exceed 16M limit");
1362 error = clib_error_return (0, "bd_add_del returned %d", rv);
1368 unformat_free (line_input);
1375 * Create/Delete bridge-domain instance
1379 * Example of creating bridge-domain 1:
1380 * @cliexstart{create bridge-domain 1}
1384 * Example of creating bridge-domain 2 with enabling arp-term, mac-age 60:
1385 * @cliexstart{create bridge-domain 2 arp-term 1 mac-age 60}
1388 * vpp# show bridge-domain
1389 * ID Index BSN Age(min) Learning U-Forwrd UU-Flood Flooding ARP-Term BVI-Intf
1390 * 0 0 0 off off off off off off local0
1391 * 1 1 0 off on on off on off N/A
1392 * 2 2 0 60 on on off on on N/A
1396 * Example of delete bridge-domain 1:
1397 * @cliexstart{create bridge-domain 1 del}
1403 VLIB_CLI_COMMAND (bd_create_cli, static) = {
1404 .path = "create bridge-domain",
1405 .short_help = "create bridge-domain <bridge-domain-id>"
1406 " [learn <0|1>] [forward <0|1>] [uu-flood <0|1>] [flood <0|1>] [arp-term <0|1>]"
1407 " [mac-age <nn>] [bd-tag <tag>] [del]",
1408 .function = bd_add_del_command_fn,
1415 * fd.io coding-style-patch-verification: ON
1418 * eval: (c-set-style "gnu")