2 * l2_fib.c : layer 2 forwarding table (aka mac table)
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.
19 #include <vlib/vlib.h>
20 #include <vnet/vnet.h>
21 #include <vnet/pg/pg.h>
22 #include <vnet/ethernet/ethernet.h>
25 #include <vppinfra/error.h>
26 #include <vppinfra/hash.h>
27 #include <vnet/l2/l2_input.h>
28 #include <vnet/l2/l2_fib.h>
29 #include <vnet/l2/l2_learn.h>
30 #include <vnet/l2/l2_bd.h>
32 #include <vppinfra/bihash_template.c>
34 #include <vlibmemory/api.h>
35 #include <vnet/vnet_msg_enum.h>
37 #define vl_typedefs /* define message structures */
38 #include <vnet/vnet_all_api_h.h>
41 #define vl_endianfun /* define message structures */
42 #include <vnet/vnet_all_api_h.h>
47 * @brief Ethernet MAC Address FIB Table Management.
49 * The MAC Address forwarding table for bridge-domains is called the l2fib.
50 * Entries are added automatically as part of mac learning, but MAC Addresses
51 * entries can also be added manually.
55 l2fib_main_t l2fib_main;
58 format_l2fib_entry_result_flags (u8 * s, va_list * args)
60 l2fib_entry_result_flags_t flags = va_arg (*args, int);
62 if (L2FIB_ENTRY_RESULT_FLAG_NONE == flags)
64 s = format (s, "none");
69 if (flags & L2FIB_ENTRY_RESULT_FLAG_##a) \
70 s = format (s, "%s ", t); \
72 foreach_l2fib_entry_result_attr
79 incr_mac_address (u8 * mac)
81 u64 tmp = *((u64 *) mac);
82 tmp = clib_net_to_host_u64 (tmp);
83 tmp += 1 << 16; /* skip unused (least significant) octets */
84 tmp = clib_host_to_net_u64 (tmp);
86 clib_memcpy_fast (mac, &tmp, 6);
89 /** Format sw_if_index. If the value is ~0, use the text "N/A" */
91 format_vnet_sw_if_index_name_with_NA (u8 * s, va_list * args)
93 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
94 u32 sw_if_index = va_arg (*args, u32);
95 if (sw_if_index == ~0)
96 return format (s, "N/A");
98 vnet_sw_interface_t *swif =
99 vnet_get_sw_interface_or_null (vnm, sw_if_index);
101 return format (s, "Stale");
103 return format (s, "%U", format_vnet_sw_interface_name, vnm,
104 vnet_get_sw_interface_or_null (vnm, sw_if_index));
107 typedef struct l2fib_dump_walk_ctx_t_
110 l2fib_entry_key_t *l2fe_key;
111 l2fib_entry_result_t *l2fe_res;
112 } l2fib_dump_walk_ctx_t;
115 l2fib_dump_walk_cb (BVT (clib_bihash_kv) * kvp, void *arg)
117 l2fib_dump_walk_ctx_t *ctx = arg;
118 l2fib_entry_result_t result;
119 l2fib_entry_key_t key;
122 result.raw = kvp->value;
124 if ((ctx->bd_index == ~0) || (ctx->bd_index == key.fields.bd_index))
126 vec_add1 (ctx->l2fe_key, key);
127 vec_add1 (ctx->l2fe_res, result);
132 l2fib_table_dump (u32 bd_index,
133 l2fib_entry_key_t ** l2fe_key,
134 l2fib_entry_result_t ** l2fe_res)
136 l2fib_main_t *msm = &l2fib_main;
137 l2fib_dump_walk_ctx_t ctx = {
138 .bd_index = bd_index,
141 BV (clib_bihash_foreach_key_value_pair)
142 (&msm->mac_table, l2fib_dump_walk_cb, &ctx);
144 *l2fe_key = ctx.l2fe_key;
145 *l2fe_res = ctx.l2fe_res;
148 typedef struct l2fib_show_walk_ctx_t_
159 } l2fib_show_walk_ctx_t;
162 l2fib_show_walk_cb (BVT (clib_bihash_kv) * kvp, void *arg)
164 l2fib_show_walk_ctx_t *ctx = arg;
165 l2_bridge_domain_t *bd_config;
166 l2fib_entry_result_t result;
167 l2fib_entry_key_t key;
169 if (ctx->verbose && ctx->first_entry)
171 ctx->first_entry = 0;
172 vlib_cli_output (ctx->vm,
173 "%=19s%=7s%=7s%=8s%=9s%=7s%=7s%=5s%=30s",
174 "Mac-Address", "BD-Idx", "If-Idx",
175 "BSN-ISN", "Age(min)", "static", "filter",
176 "bvi", "Interface-Name");
180 result.raw = kvp->value;
181 ctx->total_entries++;
184 ((ctx->bd_index >> 31) || (ctx->bd_index == key.fields.bd_index)))
188 if (ctx->learn && l2fib_entry_result_is_set_AGE_NOT (&result))
189 return; /* skip provisioned macs */
191 if (ctx->add && !l2fib_entry_result_is_set_AGE_NOT (&result))
192 return; /* skip learned macs */
194 bd_config = vec_elt_at_index (l2input_main.bd_configs,
195 key.fields.bd_index);
197 if (l2fib_entry_result_is_set_AGE_NOT (&result))
198 s = format (s, "no");
199 else if (bd_config->mac_age == 0)
203 i16 delta = ctx->now - result.fields.timestamp;
204 delta += delta < 0 ? 256 : 0;
205 s = format (s, "%d", delta);
208 vlib_cli_output (ctx->vm,
209 "%=19U%=7d%=7d %3d/%-3d%=9v%=7s%=7s%=5s%=30U",
210 format_ethernet_address, key.fields.mac,
212 result.fields.sw_if_index == ~0
213 ? -1 : result.fields.sw_if_index,
214 result.fields.sn.bd, result.fields.sn.swif, s,
215 l2fib_entry_result_is_set_STATIC (&result) ? "*" : "-",
216 l2fib_entry_result_is_set_FILTER (&result) ? "*" : "-",
217 l2fib_entry_result_is_set_BVI (&result) ? "*" : "-",
218 format_vnet_sw_if_index_name_with_NA,
219 ctx->vnm, result.fields.sw_if_index);
224 /** Display the contents of the l2fib. */
225 static clib_error_t *
226 show_l2fib (vlib_main_t * vm,
227 unformat_input_t * input, vlib_cli_command_t * cmd)
229 bd_main_t *bdm = &bd_main;
230 l2fib_main_t *msm = &l2fib_main;
233 l2fib_show_walk_ctx_t ctx = {
236 .now = (u8) (vlib_time_now (vm) / 60),
238 .vnm = msm->vnet_main,
241 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
243 if (unformat (input, "raw"))
249 else if (unformat (input, "verbose"))
251 else if (unformat (input, "all"))
253 else if (unformat (input, "bd_index %d", &ctx.bd_index))
255 else if (unformat (input, "learn"))
261 else if (unformat (input, "add"))
267 else if (unformat (input, "bd_id %d", &bd_id))
269 uword *p = hash_get (bdm->bd_index_by_bd_id, bd_id);
276 return clib_error_return (0,
277 "bridge domain id %d doesn't exist\n",
284 BV (clib_bihash_foreach_key_value_pair)
285 (&msm->mac_table, l2fib_show_walk_cb, &ctx);
287 if (ctx.total_entries == 0)
288 vlib_cli_output (vm, "no l2fib entries");
291 l2learn_main_t *lm = &l2learn_main;
292 vlib_cli_output (vm, "L2FIB total/learned entries: %d/%d "
293 "Last scan time: %.4esec Learn limit: %d ",
294 ctx.total_entries, lm->global_learn_count,
295 msm->age_scan_duration, lm->global_learn_limit);
297 vlib_cli_output (vm, "L2MAC events client PID: %d "
298 "Last e-scan time: %.4esec Delay: %.2esec "
299 "Max macs in event: %d",
300 lm->client_pid, msm->evt_scan_duration,
301 msm->event_scan_delay, msm->max_macs_in_event);
305 vlib_cli_output (vm, "Raw Hash Table:\n%U\n",
306 BV (format_bihash), &msm->mac_table, 1 /* verbose */ );
312 * This command displays the MAC Address entries of the L2 FIB table.
313 * Output can be filtered to just get the number of MAC Addresses or display
314 * each MAC Address for all bridge domains or just a single bridge domain.
317 * Example of how to display the number of MAC Address entries in the L2
319 * @cliexstart{show l2fib}
322 * Example of how to display all the MAC Address entries in the L2
324 * @cliexstart{show l2fib all}
325 * Mac Address BD Idx Interface Index static filter bvi refresh timestamp
326 * 52:54:00:53:18:33 1 GigabitEthernet0/8/0.200 3 0 0 0 0 0
327 * 52:54:00:53:18:55 1 GigabitEthernet0/8/0.200 3 1 0 0 0 0
328 * 52:54:00:53:18:77 1 N/A -1 1 1 0 0 0
333 VLIB_CLI_COMMAND (show_l2fib_cli, static) = {
334 .path = "show l2fib",
335 .short_help = "show l2fib [all] | [bd_id <nn> | bd_index <nn>] [learn | add] | [raw]",
336 .function = show_l2fib,
341 /* Remove all entries from the l2fib */
343 l2fib_clear_table (void)
345 l2fib_main_t *mp = &l2fib_main;
347 /* Remove all entries */
348 BV (clib_bihash_free) (&mp->mac_table);
349 BV (clib_bihash_init) (&mp->mac_table, "l2fib mac table",
350 L2FIB_NUM_BUCKETS, L2FIB_MEMORY_SIZE);
351 l2learn_main.global_learn_count = 0;
354 /** Clear all entries in L2FIB.
355 * @TODO: Later we may want a way to remove only the non-static entries
357 static clib_error_t *
358 clear_l2fib (vlib_main_t * vm,
359 unformat_input_t * input, vlib_cli_command_t * cmd)
361 l2fib_clear_table ();
366 * This command clears all the MAC Address entries from the L2 FIB table.
369 * Example of how to clear the L2 FIB Table:
370 * @cliexcmd{clear l2fib}
371 * Example to show the L2 FIB Table has been cleared:
372 * @cliexstart{show l2fib verbose}
377 VLIB_CLI_COMMAND (clear_l2fib_cli, static) = {
378 .path = "clear l2fib",
379 .short_help = "clear l2fib",
380 .function = clear_l2fib,
384 static inline l2fib_seq_num_t
385 l2fib_cur_seq_num (u32 bd_index, u32 sw_if_index)
387 l2_bridge_domain_t *bd_config = l2input_bd_config (bd_index);
389 return (l2fib_seq_num_t) {
390 .swif = *l2fib_swif_seq_num (sw_if_index),
391 .bd = bd_config->seq_num,
397 * Add an entry to the l2fib.
398 * If the entry already exists then overwrite it
401 l2fib_add_entry (const u8 * mac, u32 bd_index,
402 u32 sw_if_index, l2fib_entry_result_flags_t flags)
404 l2fib_entry_key_t key;
405 l2fib_entry_result_t result;
406 __attribute__ ((unused)) u32 bucket_contents;
407 l2fib_main_t *fm = &l2fib_main;
408 l2learn_main_t *lm = &l2learn_main;
409 BVT (clib_bihash_kv) kv;
412 key.raw = l2fib_make_key (mac, bd_index);
414 /* check if entry already exist */
415 if (BV (clib_bihash_search) (&fm->mac_table, &kv, &kv))
417 /* decrement counter if overwriting a learned mac */
418 result.raw = kv.value;
419 if ((!l2fib_entry_result_is_set_AGE_NOT (&result))
420 && (lm->global_learn_count))
421 lm->global_learn_count--;
425 result.raw = 0; /* clear all fields */
426 result.fields.sw_if_index = sw_if_index;
427 result.fields.flags = flags;
429 /* no aging for provisioned entry */
430 l2fib_entry_result_set_AGE_NOT (&result);
433 kv.value = result.raw;
435 BV (clib_bihash_add_del) (&fm->mac_table, &kv, 1 /* is_add */ );
439 * Add an entry to the L2FIB.
441 * l2fib add <mac> <bd> <intf> [static] [bvi]
442 * l2fib add <mac> <bd> filter
443 * Note that filter and bvi entries are always static
445 static clib_error_t *
446 l2fib_add (vlib_main_t * vm,
447 unformat_input_t * input, vlib_cli_command_t * cmd)
449 bd_main_t *bdm = &bd_main;
450 vnet_main_t *vnm = vnet_get_main ();
451 clib_error_t *error = 0;
455 u32 sw_if_index = ~0;
457 l2fib_entry_result_flags_t flags;
459 flags = L2FIB_ENTRY_RESULT_FLAG_NONE;
461 if (!unformat (input, "%U", unformat_ethernet_address, mac))
463 error = clib_error_return (0, "expected mac address `%U'",
464 format_unformat_error, input);
468 if (!unformat (input, "%d", &bd_id))
470 error = clib_error_return (0, "expected bridge domain ID `%U'",
471 format_unformat_error, input);
475 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
478 error = clib_error_return (0, "bridge domain ID %d invalid", bd_id);
483 if (unformat (input, "filter"))
485 l2fib_add_filter_entry (mac, bd_index);
489 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
491 error = clib_error_return (0, "unknown interface `%U'",
492 format_unformat_error, input);
496 if (unformat (input, "static"))
497 flags |= L2FIB_ENTRY_RESULT_FLAG_STATIC;
498 else if (unformat (input, "bvi"))
499 flags |= (L2FIB_ENTRY_RESULT_FLAG_STATIC | L2FIB_ENTRY_RESULT_FLAG_BVI);
501 if (vec_len (l2input_main.configs) <= sw_if_index)
503 error = clib_error_return (0, "Interface sw_if_index %d not in L2 mode",
508 l2fib_add_entry (mac, bd_index, sw_if_index, flags);
515 * This command adds a MAC Address entry to the L2 FIB table
516 * of an existing bridge-domain. The MAC Address can be static
517 * or dynamic. This command also allows a filter to be added,
518 * such that packets with given MAC Addresses (source mac or
519 * destination mac match) are dropped.
522 * Example of how to add a dynamic MAC Address entry to the L2 FIB table
523 * of a bridge-domain (where 200 is the bridge-domain-id):
524 * @cliexcmd{l2fib add 52:54:00:53:18:33 200 GigabitEthernet0/8/0.200}
525 * Example of how to add a static MAC Address entry to the L2 FIB table
526 * of a bridge-domain (where 200 is the bridge-domain-id):
527 * @cliexcmd{l2fib add 52:54:00:53:18:55 200 GigabitEthernet0/8/0.200 static}
528 * Example of how to add a filter such that a packet with the given MAC
529 * Address will be dropped in a given bridge-domain (where 200 is the
531 * @cliexcmd{l2fib add 52:54:00:53:18:77 200 filter}
532 * Example of show command of the provisioned MAC Addresses and filters:
533 * @cliexstart{show l2fib verbose}
534 * Mac Address BD Idx Interface Index static filter bvi refresh timestamp
535 * 52:54:00:53:18:33 1 GigabitEthernet0/8/0.200 3 0 0 0 0 0
536 * 52:54:00:53:18:55 1 GigabitEthernet0/8/0.200 3 1 0 0 0 0
537 * 52:54:00:53:18:77 1 N/A -1 1 1 0 0 0
542 VLIB_CLI_COMMAND (l2fib_add_cli, static) = {
544 .short_help = "l2fib add <mac> <bridge-domain-id> filter | <intf> [static | bvi]",
545 .function = l2fib_add,
550 static clib_error_t *
551 l2fib_test_command_fn (vlib_main_t * vm,
552 unformat_input_t * input, vlib_cli_command_t * cmd)
554 clib_error_t *error = 0;
555 u8 mac[6], save_mac[6];
565 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
567 if (unformat (input, "mac %U", unformat_ethernet_address, mac))
569 else if (unformat (input, "add"))
571 else if (unformat (input, "del"))
573 else if (unformat (input, "check"))
575 else if (unformat (input, "count %d", &count))
582 return clib_error_return (0, "mac not set");
584 if (is_add == 0 && is_del == 0 && is_check == 0)
585 return clib_error_return (0,
586 "noop: pick at least one of (add,del,check)");
588 clib_memcpy_fast (save_mac, mac, 6);
592 for (i = 0; i < count; i++)
594 l2fib_add_entry (mac, bd_index, sw_if_index,
595 L2FIB_ENTRY_RESULT_FLAG_NONE);
596 incr_mac_address (mac);
602 BVT (clib_bihash_kv) kv;
603 l2fib_main_t *mp = &l2fib_main;
605 clib_memcpy_fast (mac, save_mac, 6);
607 for (i = 0; i < count; i++)
609 kv.key = l2fib_make_key (mac, bd_index);
610 if (BV (clib_bihash_search) (&mp->mac_table, &kv, &kv))
612 clib_warning ("key %U AWOL", format_ethernet_address, mac);
615 incr_mac_address (mac);
621 clib_memcpy_fast (mac, save_mac, 6);
623 for (i = 0; i < count; i++)
625 l2fib_del_entry (mac, bd_index, 0);
626 incr_mac_address (mac);
634 * The set of '<em>test l2fib</em>' commands allow the L2 FIB table of the default
635 * bridge domain (bridge-domain-id of 0) to be modified.
639 * Example of how to add a set of 4 sequential MAC Address entries to L2
640 * FIB table of the default bridge-domain:
641 * @cliexcmd{test l2fib add mac 52:54:00:53:00:00 count 4}
643 * Show the set of 4 sequential MAC Address entries that were added:
644 * @cliexstart{show l2fib verbose}
645 * Mac Address BD Idx Interface Index static filter bvi refresh timestamp
646 * 52:54:00:53:00:00 0 GigabitEthernet0/8/0.300 8 0 0 0 0 0
647 * 52:54:00:53:00:01 0 GigabitEthernet0/8/0.300 8 0 0 0 0 0
648 * 52:54:00:53:00:03 0 GigabitEthernet0/8/0.300 8 0 0 0 0 0
649 * 52:54:00:53:00:02 0 GigabitEthernet0/8/0.300 8 0 0 0 0 0
653 * Example of how to check that the set of 4 sequential MAC Address
654 * entries were added to L2 FIB table of the default
655 * bridge-domain. Used a count of 5 to produce an error:
657 * @cliexcmd{test l2fib check mac 52:54:00:53:00:00 count 5}
658 * The output of the check command is in the log files. Log file
659 * location may vary based on your OS and Version:
661 * <b><em># tail -f /var/log/messages | grep l2fib_test_command_fn</em></b>
663 * Sep 7 17:15:24 localhost vnet[4952]: l2fib_test_command_fn:446: key 52:54:00:53:00:04 AWOL
665 * Example of how to delete a set of 4 sequential MAC Address entries
666 * from L2 FIB table of the default bridge-domain:
667 * @cliexcmd{test l2fib del mac 52:54:00:53:00:00 count 4}
671 VLIB_CLI_COMMAND (l2fib_test_command, static) = {
672 .path = "test l2fib",
673 .short_help = "test l2fib [add|del|check] mac <base-addr> count <nn>",
674 .function = l2fib_test_command_fn,
680 * Delete an entry from the l2fib.
681 * Return 0 if the entry was deleted, or 1 it was not found or if
682 * sw_if_index is non-zero and does not match that in the entry.
685 l2fib_del_entry (const u8 * mac, u32 bd_index, u32 sw_if_index)
687 l2fib_entry_result_t result;
688 l2fib_main_t *mp = &l2fib_main;
689 BVT (clib_bihash_kv) kv;
692 kv.key = l2fib_make_key (mac, bd_index);
694 if (BV (clib_bihash_search) (&mp->mac_table, &kv, &kv))
697 result.raw = kv.value;
699 /* check if sw_if_index of entry match */
700 if ((sw_if_index != 0) && (sw_if_index != result.fields.sw_if_index))
703 /* decrement counter if dynamically learned mac */
704 if ((!l2fib_entry_result_is_set_AGE_NOT (&result)) &&
705 (l2learn_main.global_learn_count))
706 l2learn_main.global_learn_count--;
708 /* Remove entry from hash table */
709 BV (clib_bihash_add_del) (&mp->mac_table, &kv, 0 /* is_add */ );
714 * Delete an entry from the L2FIB.
716 * l2fib del <mac> <bd-id>
718 static clib_error_t *
719 l2fib_del (vlib_main_t * vm,
720 unformat_input_t * input, vlib_cli_command_t * cmd)
722 bd_main_t *bdm = &bd_main;
723 clib_error_t *error = 0;
729 if (!unformat (input, "%U", unformat_ethernet_address, mac))
731 error = clib_error_return (0, "expected mac address `%U'",
732 format_unformat_error, input);
736 if (!unformat (input, "%d", &bd_id))
738 error = clib_error_return (0, "expected bridge domain ID `%U'",
739 format_unformat_error, input);
743 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
746 error = clib_error_return (0, "bridge domain ID %d invalid", bd_id);
751 /* Delete the entry */
752 if (l2fib_del_entry (mac, bd_index, 0))
754 error = clib_error_return (0, "mac entry not found");
763 * This command deletes an existing MAC Address entry from the L2 FIB
764 * table of an existing bridge-domain.
767 * Example of how to delete a MAC Address entry from the L2 FIB table of a bridge-domain (where 200 is the bridge-domain-id):
768 * @cliexcmd{l2fib del 52:54:00:53:18:33 200}
771 VLIB_CLI_COMMAND (l2fib_del_cli, static) = {
773 .short_help = "l2fib del <mac> <bridge-domain-id> []",
774 .function = l2fib_del,
779 Kick off ager to scan MACs to age/delete MAC entries
782 l2fib_start_ager_scan (vlib_main_t * vm)
784 uword evt = L2_MAC_AGE_PROCESS_EVENT_ONE_PASS;
786 /* check if there is at least one bd with mac aging enabled */
787 l2_bridge_domain_t *bd_config;
788 vec_foreach (bd_config, l2input_main.bd_configs)
790 if (bd_config->bd_id != ~0 && bd_config->mac_age != 0)
792 evt = L2_MAC_AGE_PROCESS_EVENT_START;
797 vlib_process_signal_event (vm, l2fib_mac_age_scanner_process_node.index,
802 Flush all non static MACs from an interface
805 l2fib_flush_int_mac (vlib_main_t * vm, u32 sw_if_index)
807 *l2fib_swif_seq_num (sw_if_index) += 1;
808 l2fib_start_ager_scan (vm);
812 Flush all non static MACs in a bridge domain
815 l2fib_flush_bd_mac (vlib_main_t * vm, u32 bd_index)
817 l2_bridge_domain_t *bd_config = l2input_bd_config (bd_index);
818 bd_config->seq_num += 1;
819 l2fib_start_ager_scan (vm);
823 Flush all non static MACs - flushes all valid BDs
826 l2fib_flush_all_mac (vlib_main_t * vm)
828 l2_bridge_domain_t *bd_config;
829 vec_foreach (bd_config, l2input_main.bd_configs)
830 if (bd_is_valid (bd_config))
831 bd_config->seq_num += 1;
833 l2fib_start_ager_scan (vm);
838 Flush MACs, except static ones, associated with an interface
840 l2fib flush-mac interface <if-name>
842 static clib_error_t *
843 l2fib_flush_mac_int (vlib_main_t * vm,
844 unformat_input_t * input, vlib_cli_command_t * cmd)
846 vnet_main_t *vnm = vnet_get_main ();
847 clib_error_t *error = 0;
850 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
852 error = clib_error_return (0, "unknown interface `%U'",
853 format_unformat_error, input);
857 l2fib_flush_int_mac (vm, sw_if_index);
864 Flush all MACs, except static ones
868 static clib_error_t *
869 l2fib_flush_mac_all (vlib_main_t * vm,
870 unformat_input_t * input, vlib_cli_command_t * cmd)
872 l2fib_flush_all_mac (vm);
877 * This command kick off ager to delete all existing MAC Address entries,
878 * except static ones, associated with an interface from the L2 FIB table.
881 * Example of how to flush MAC Address entries learned on an interface from the L2 FIB table:
882 * @cliexcmd{l2fib flush-mac interface GigabitEthernet2/1/0}
885 VLIB_CLI_COMMAND (l2fib_flush_mac_all_cli, static) = {
886 .path = "l2fib flush-mac all",
887 .short_help = "l2fib flush-mac all",
888 .function = l2fib_flush_mac_all,
893 * This command kick off ager to delete all existing MAC Address entries,
894 * except static ones, associated with an interface from the L2 FIB table.
897 * Example of how to flush MAC Address entries learned on an interface from the L2 FIB table:
898 * @cliexcmd{l2fib flush-mac interface GigabitEthernet2/1/0}
901 VLIB_CLI_COMMAND (l2fib_flush_mac_int_cli, static) = {
902 .path = "l2fib flush-mac interface",
903 .short_help = "l2fib flush-mac interface <if-name>",
904 .function = l2fib_flush_mac_int,
909 Flush bridge-domain MACs except static ones.
911 l2fib flush-mac bridge-domain <bd-id>
913 static clib_error_t *
914 l2fib_flush_mac_bd (vlib_main_t * vm,
915 unformat_input_t * input, vlib_cli_command_t * cmd)
917 bd_main_t *bdm = &bd_main;
918 clib_error_t *error = 0;
922 if (!unformat (input, "%d", &bd_id))
924 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
925 format_unformat_error, input);
929 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
933 return clib_error_return (0, "No such bridge domain %d", bd_id);
935 l2fib_flush_bd_mac (vm, bd_index);
942 * This command kick off ager to delete all existing MAC Address entries,
943 * except static ones, in a bridge domain from the L2 FIB table.
946 * Example of how to flush MAC Address entries learned in a bridge domain from the L2 FIB table:
947 * @cliexcmd{l2fib flush-mac bridge-domain 1000}
950 VLIB_CLI_COMMAND (l2fib_flush_mac_bd_cli, static) = {
951 .path = "l2fib flush-mac bridge-domain",
952 .short_help = "l2fib flush-mac bridge-domain <bd-id>",
953 .function = l2fib_flush_mac_bd,
958 l2fib_sw_interface_up_down (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
960 l2_input_config_t *config = l2input_intf_config (sw_if_index);
961 if ((flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) == 0 && config->bridge)
962 l2fib_flush_int_mac (vnm->vlib_main, sw_if_index);
966 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (l2fib_sw_interface_up_down);
968 BVT (clib_bihash) * get_mac_table (void)
970 l2fib_main_t *mp = &l2fib_main;
971 return &mp->mac_table;
974 static_always_inline void *
975 allocate_mac_evt_buf (u32 client, u32 client_index)
977 l2fib_main_t *fm = &l2fib_main;
978 vl_api_l2_macs_event_t *mp = vl_msg_api_alloc
979 (sizeof (*mp) + (fm->max_macs_in_event * sizeof (vl_api_mac_entry_t)));
980 mp->_vl_msg_id = htons (VL_API_L2_MACS_EVENT);
981 mp->pid = htonl (client);
982 mp->client_index = client_index;
986 static_always_inline f64
987 l2fib_scan (vlib_main_t * vm, f64 start_time, u8 event_only)
989 l2fib_main_t *fm = &l2fib_main;
990 l2learn_main_t *lm = &l2learn_main;
992 BVT (clib_bihash) * h = &fm->mac_table;
994 f64 last_start = start_time;
999 u32 client = lm->client_pid;
1000 u32 cl_idx = lm->client_index;
1001 vl_api_l2_macs_event_t *mp = 0;
1002 vl_api_registration_t *reg = 0;
1004 /* Don't scan the l2 fib if it hasn't been instantiated yet */
1005 if (alloc_arena (h) == 0)
1010 mp = allocate_mac_evt_buf (client, cl_idx);
1011 reg = vl_api_client_index_to_registration (lm->client_index);
1014 for (i = 0; i < h->nbuckets; i++)
1016 /* allow no more than 20us without a pause */
1017 delta_t = vlib_time_now (vm) - last_start;
1018 if (delta_t > 20e-6)
1020 vlib_process_suspend (vm, 100e-6); /* suspend for 100 us */
1021 last_start = vlib_time_now (vm);
1025 if (i < (h->nbuckets - 3))
1027 BVT (clib_bihash_bucket) * b = &h->buckets[i + 3];
1028 CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, LOAD);
1029 b = &h->buckets[i + 1];
1032 BVT (clib_bihash_value) * v =
1033 BV (clib_bihash_get_value) (h, b->offset);
1034 CLIB_PREFETCH (v, CLIB_CACHE_LINE_BYTES, LOAD);
1038 BVT (clib_bihash_bucket) * b = &h->buckets[i];
1041 BVT (clib_bihash_value) * v = BV (clib_bihash_get_value) (h, b->offset);
1042 for (j = 0; j < (1 << b->log2_pages); j++)
1044 for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
1046 if (v->kvp[k].key == ~0ULL && v->kvp[k].value == ~0ULL)
1049 l2fib_entry_key_t key = {.raw = v->kvp[k].key };
1050 l2fib_entry_result_t result = {.raw = v->kvp[k].value };
1052 if (!l2fib_entry_result_is_set_AGE_NOT (&result))
1057 if (PREDICT_FALSE (evt_idx >= fm->max_macs_in_event))
1059 /* event message full, send it and start a new one */
1060 if (reg && vl_api_can_send_msg (reg))
1062 mp->n_macs = htonl (evt_idx);
1063 vl_api_send_msg (reg, (u8 *) mp);
1064 mp = allocate_mac_evt_buf (client, cl_idx);
1069 clib_warning ("MAC event to pid %d queue stuffed!"
1070 " %d MAC entries lost", client,
1076 if (l2fib_entry_result_is_set_LRN_EVT (&result))
1078 /* copy mac entry to event msg */
1079 clib_memcpy_fast (mp->mac[evt_idx].mac_addr,
1081 mp->mac[evt_idx].action =
1082 l2fib_entry_result_is_set_LRN_MOV (&result) ?
1083 MAC_EVENT_ACTION_MOVE : MAC_EVENT_ACTION_ADD;
1084 mp->mac[evt_idx].sw_if_index =
1085 htonl (result.fields.sw_if_index);
1086 /* clear event bits and update mac entry */
1087 l2fib_entry_result_clear_LRN_EVT (&result);
1088 l2fib_entry_result_clear_LRN_MOV (&result);
1089 BVT (clib_bihash_kv) kv;
1091 kv.value = result.raw;
1092 BV (clib_bihash_add_del) (&fm->mac_table, &kv, 1);
1094 continue; /* skip aging */
1098 if (event_only || l2fib_entry_result_is_set_AGE_NOT (&result))
1099 continue; /* skip aging - static_mac always age_not */
1101 /* start aging processing */
1102 u32 bd_index = key.fields.bd_index;
1103 u32 sw_if_index = result.fields.sw_if_index;
1104 u16 sn = l2fib_cur_seq_num (bd_index, sw_if_index).as_u16;
1105 if (result.fields.sn.as_u16 != sn)
1106 goto age_out; /* stale mac */
1108 l2_bridge_domain_t *bd_config =
1109 vec_elt_at_index (l2input_main.bd_configs, bd_index);
1111 if (bd_config->mac_age == 0)
1112 continue; /* skip aging */
1114 i16 delta = (u8) (start_time / 60) - result.fields.timestamp;
1115 delta += delta < 0 ? 256 : 0;
1117 if (delta < bd_config->mac_age)
1118 continue; /* still valid */
1123 /* copy mac entry to event msg */
1124 clib_memcpy_fast (mp->mac[evt_idx].mac_addr, key.fields.mac,
1126 mp->mac[evt_idx].action = MAC_EVENT_ACTION_DELETE;
1127 mp->mac[evt_idx].sw_if_index =
1128 htonl (result.fields.sw_if_index);
1131 /* delete mac entry */
1132 BVT (clib_bihash_kv) kv;
1134 BV (clib_bihash_add_del) (&fm->mac_table, &kv, 0);
1137 * Note: we may have just freed the bucket's backing
1138 * storage, so check right here...
1149 /* keep learn count consistent */
1150 l2learn_main.global_learn_count = learn_count;
1154 /* send any outstanding mac event message else free message buffer */
1157 if (reg && vl_api_can_send_msg (reg))
1159 mp->n_macs = htonl (evt_idx);
1160 vl_api_send_msg (reg, (u8 *) mp);
1165 clib_warning ("MAC event to pid %d queue stuffed!"
1166 " %d MAC entries lost", client, evt_idx);
1167 vl_msg_api_free (mp);
1171 vl_msg_api_free (mp);
1173 return delta_t + accum_t;
1177 l2fib_mac_age_scanner_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1180 uword event_type, *event_data = 0;
1181 l2fib_main_t *fm = &l2fib_main;
1182 l2learn_main_t *lm = &l2learn_main;
1184 f64 start_time, next_age_scan_time = CLIB_TIME_MAX;
1189 vlib_process_wait_for_event_or_clock (vm, fm->event_scan_delay);
1192 f64 t = next_age_scan_time - vlib_time_now (vm);
1193 vlib_process_wait_for_event_or_clock (vm, t);
1196 vlib_process_wait_for_event (vm);
1198 event_type = vlib_process_get_events (vm, &event_data);
1199 vec_reset_length (event_data);
1201 start_time = vlib_time_now (vm);
1203 { SCAN_MAC_AGE, SCAN_MAC_EVENT, SCAN_DISABLE } scan = SCAN_MAC_AGE;
1207 case ~0: /* timer expired */
1208 if (lm->client_pid != 0 && start_time < next_age_scan_time)
1209 scan = SCAN_MAC_EVENT;
1212 case L2_MAC_AGE_PROCESS_EVENT_START:
1216 case L2_MAC_AGE_PROCESS_EVENT_STOP:
1218 scan = SCAN_DISABLE;
1221 case L2_MAC_AGE_PROCESS_EVENT_ONE_PASS:
1228 if (scan == SCAN_MAC_EVENT)
1229 l2fib_main.evt_scan_duration = l2fib_scan (vm, start_time, 1);
1232 if (scan == SCAN_MAC_AGE)
1233 l2fib_main.age_scan_duration = l2fib_scan (vm, start_time, 0);
1234 if (scan == SCAN_DISABLE)
1236 l2fib_main.age_scan_duration = 0;
1237 l2fib_main.evt_scan_duration = 0;
1239 /* schedule next scan */
1241 next_age_scan_time = start_time + L2FIB_AGE_SCAN_INTERVAL;
1243 next_age_scan_time = CLIB_TIME_MAX;
1250 VLIB_REGISTER_NODE (l2fib_mac_age_scanner_process_node) = {
1251 .function = l2fib_mac_age_scanner_process,
1252 .type = VLIB_NODE_TYPE_PROCESS,
1253 .name = "l2fib-mac-age-scanner-process",
1258 l2fib_init (vlib_main_t * vm)
1260 l2fib_main_t *mp = &l2fib_main;
1261 l2fib_entry_key_t test_key;
1265 mp->vnet_main = vnet_get_main ();
1267 /* Create the hash table */
1268 BV (clib_bihash_init) (&mp->mac_table, "l2fib mac table",
1269 L2FIB_NUM_BUCKETS, L2FIB_MEMORY_SIZE);
1271 /* verify the key constructor is good, since it is endian-sensitive */
1272 clib_memset (test_mac, 0, sizeof (test_mac));
1275 test_key.raw = l2fib_make_key ((u8 *) & test_mac, 0x1234);
1276 ASSERT (test_key.fields.mac[0] == 0x11);
1277 ASSERT (test_key.fields.bd_index == 0x1234);
1282 VLIB_INIT_FUNCTION (l2fib_init);
1285 * fd.io coding-style-patch-verification: ON
1288 * eval: (c-set-style "gnu")