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/ethernet/ethernet.h>
24 #include <vppinfra/error.h>
25 #include <vppinfra/hash.h>
26 #include <vnet/l2/l2_input.h>
27 #include <vnet/l2/l2_fib.h>
28 #include <vnet/l2/l2_learn.h>
29 #include <vnet/l2/l2_bd.h>
30 #include <vppinfra/bihash_template.c>
31 #include <vlibmemory/api.h>
33 #include <vnet/l2/l2.api_enum.h>
34 #include <vnet/l2/l2.api_types.h>
37 #include <vnet/l2/l2.api.h>
42 * @brief Ethernet MAC Address FIB Table Management.
44 * The MAC Address forwarding table for bridge-domains is called the l2fib.
45 * Entries are added automatically as part of mac learning, but MAC Addresses
46 * entries can also be added manually.
50 l2fib_main_t l2fib_main;
53 format_l2fib_entry_result_flags (u8 * s, va_list * args)
55 l2fib_entry_result_flags_t flags = va_arg (*args, int);
57 if (L2FIB_ENTRY_RESULT_FLAG_NONE == flags)
59 s = format (s, "none");
64 if (flags & L2FIB_ENTRY_RESULT_FLAG_##a) \
65 s = format (s, "%s ", t); \
67 foreach_l2fib_entry_result_attr
74 incr_mac_address (u8 * mac)
76 u64 tmp = *((u64 *) mac);
77 tmp = clib_net_to_host_u64 (tmp);
78 tmp += 1 << 16; /* skip unused (least significant) octets */
79 tmp = clib_host_to_net_u64 (tmp);
81 clib_memcpy_fast (mac, &tmp, 6);
84 /** Format sw_if_index. If the value is ~0, use the text "N/A" */
86 format_vnet_sw_if_index_name_with_NA (u8 * s, va_list * args)
88 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
89 u32 sw_if_index = va_arg (*args, u32);
90 if (sw_if_index == ~0)
91 return format (s, "N/A");
93 vnet_sw_interface_t *swif =
94 vnet_get_sw_interface_or_null (vnm, sw_if_index);
96 return format (s, "Stale");
98 return format (s, "%U", format_vnet_sw_if_index_name, vnm, sw_if_index);
101 typedef struct l2fib_dump_walk_ctx_t_
104 l2fib_entry_key_t *l2fe_key;
105 l2fib_entry_result_t *l2fe_res;
106 } l2fib_dump_walk_ctx_t;
109 l2fib_dump_walk_cb (BVT (clib_bihash_kv) * kvp, void *arg)
111 l2fib_dump_walk_ctx_t *ctx = arg;
112 l2fib_entry_result_t result;
113 l2fib_entry_key_t key;
116 result.raw = kvp->value;
118 if ((ctx->bd_index == ~0) || (ctx->bd_index == key.fields.bd_index))
120 vec_add1 (ctx->l2fe_key, key);
121 vec_add1 (ctx->l2fe_res, result);
124 return (BIHASH_WALK_CONTINUE);
128 l2fib_table_dump (u32 bd_index,
129 l2fib_entry_key_t ** l2fe_key,
130 l2fib_entry_result_t ** l2fe_res)
132 l2fib_main_t *msm = &l2fib_main;
133 l2fib_dump_walk_ctx_t ctx = {
134 .bd_index = bd_index,
137 BV (clib_bihash_foreach_key_value_pair)
138 (&msm->mac_table, l2fib_dump_walk_cb, &ctx);
140 *l2fe_key = ctx.l2fe_key;
141 *l2fe_res = ctx.l2fe_res;
145 l2_fib_extract_seq_num (l2fib_seq_num_t sn, u8 * bd_sn, u8 * if_sn)
152 format_l2_fib_seq_num (u8 * s, va_list * a)
154 l2fib_seq_num_t sn = va_arg (*a, int);
157 l2_fib_extract_seq_num (sn, &bd_sn, &if_sn);
159 s = format (s, "%3d/%-3d", bd_sn, if_sn);
164 typedef struct l2fib_show_walk_ctx_t_
175 } l2fib_show_walk_ctx_t;
178 l2fib_show_walk_cb (BVT (clib_bihash_kv) * kvp, void *arg)
180 l2fib_show_walk_ctx_t *ctx = arg;
181 l2_bridge_domain_t *bd_config;
182 l2fib_entry_result_t result;
183 l2fib_entry_key_t key;
185 if (ctx->verbose && ctx->first_entry)
187 ctx->first_entry = 0;
188 vlib_cli_output (ctx->vm,
189 "%=19s%=7s%=7s%=8s%=9s%=7s%=7s%=5s%=30s",
190 "Mac-Address", "BD-Idx", "If-Idx",
191 "BSN-ISN", "Age(min)", "static", "filter",
192 "bvi", "Interface-Name");
196 result.raw = kvp->value;
197 ctx->total_entries++;
200 ((ctx->bd_index >> 31) || (ctx->bd_index == key.fields.bd_index)))
204 if (ctx->learn && l2fib_entry_result_is_set_AGE_NOT (&result))
205 return (BIHASH_WALK_CONTINUE); /* skip provisioned macs */
207 if (ctx->add && !l2fib_entry_result_is_set_AGE_NOT (&result))
208 return (BIHASH_WALK_CONTINUE); /* skip learned macs */
210 bd_config = &vec_elt (l2input_main.bd_configs, key.fields.bd_index);
212 if (l2fib_entry_result_is_set_AGE_NOT (&result))
213 s = format (s, "no");
214 else if (bd_config->mac_age == 0)
218 i16 delta = ctx->now - result.fields.timestamp;
219 delta += delta < 0 ? 256 : 0;
220 s = format (s, "%d", delta);
223 vlib_cli_output (ctx->vm,
224 "%=19U%=7d%=7d %U%=9v%=7s%=7s%=5s%=30U",
225 format_ethernet_address, key.fields.mac,
227 result.fields.sw_if_index == ~0
228 ? -1 : result.fields.sw_if_index,
229 format_l2_fib_seq_num, result.fields.sn, s,
230 l2fib_entry_result_is_set_STATIC (&result) ? "*" : "-",
231 l2fib_entry_result_is_set_FILTER (&result) ? "*" : "-",
232 l2fib_entry_result_is_set_BVI (&result) ? "*" : "-",
233 format_vnet_sw_if_index_name_with_NA,
234 ctx->vnm, result.fields.sw_if_index);
238 return (BIHASH_WALK_CONTINUE);
241 /** Display the contents of the l2fib. */
242 static clib_error_t *
243 show_l2fib (vlib_main_t * vm,
244 unformat_input_t * input, vlib_cli_command_t * cmd)
246 bd_main_t *bdm = &bd_main;
247 l2fib_main_t *msm = &l2fib_main;
250 l2fib_show_walk_ctx_t ctx = {
253 .now = (u8) (vlib_time_now (vm) / 60),
255 .vnm = msm->vnet_main,
258 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
260 if (unformat (input, "raw"))
266 else if (unformat (input, "verbose"))
268 else if (unformat (input, "all"))
270 else if (unformat (input, "bd_index %d", &ctx.bd_index))
272 else if (unformat (input, "learn"))
278 else if (unformat (input, "add"))
284 else if (unformat (input, "bd_id %d", &bd_id))
286 uword *p = hash_get (bdm->bd_index_by_bd_id, bd_id);
293 return clib_error_return (0,
294 "bridge domain id %d doesn't exist\n",
301 if (msm->mac_table_initialized == 0)
303 vlib_cli_output (vm, "no l2fib entries");
307 BV (clib_bihash_foreach_key_value_pair)
308 (&msm->mac_table, l2fib_show_walk_cb, &ctx);
310 if (ctx.total_entries == 0)
311 vlib_cli_output (vm, "no l2fib entries");
314 l2learn_main_t *lm = &l2learn_main;
315 vlib_cli_output (vm, "L2FIB total/learned entries: %d/%d "
316 "Last scan time: %.4esec Learn limit: %d ",
317 ctx.total_entries, lm->global_learn_count,
318 msm->age_scan_duration, lm->global_learn_limit);
320 vlib_cli_output (vm, "L2MAC events client PID: %d "
321 "Last e-scan time: %.4esec Delay: %.2esec "
322 "Max macs in event: %d",
323 lm->client_pid, msm->evt_scan_duration,
324 msm->event_scan_delay, msm->max_macs_in_event);
328 vlib_cli_output (vm, "Raw Hash Table:\n%U\n",
329 BV (format_bihash), &msm->mac_table, 1 /* verbose */ );
335 * This command displays the MAC Address entries of the L2 FIB table.
336 * Output can be filtered to just get the number of MAC Addresses or display
337 * each MAC Address for all bridge domains or just a single bridge domain.
340 * Example of how to display the number of MAC Address entries in the L2
342 * @cliexstart{show l2fib}
345 * Example of how to display all the MAC Address entries in the L2
347 * @cliexstart{show l2fib all}
348 * Mac Address BD Idx Interface Index static filter bvi refresh timestamp
349 * 52:54:00:53:18:33 1 GigabitEthernet0/8/0.200 3 0 0 0 0 0
350 * 52:54:00:53:18:55 1 GigabitEthernet0/8/0.200 3 1 0 0 0 0
351 * 52:54:00:53:18:77 1 N/A -1 1 1 0 0 0
355 VLIB_CLI_COMMAND (show_l2fib_cli, static) = {
356 .path = "show l2fib",
357 .short_help = "show l2fib [all] | [bd_id <nn> | bd_index <nn>] [learn | add] | [raw]",
358 .function = show_l2fib,
362 l2fib_table_init (void)
364 l2fib_main_t *mp = &l2fib_main;
366 if (mp->mac_table_initialized == 1)
369 BV (clib_bihash_init) (&mp->mac_table, "l2fib mac table",
370 mp->mac_table_n_buckets, mp->mac_table_memory_size);
371 mp->mac_table_initialized = 1;
374 /* Remove all entries from the l2fib */
376 l2fib_clear_table (void)
378 l2fib_main_t *mp = &l2fib_main;
379 l2_bridge_domain_t *bd_config;
381 if (mp->mac_table_initialized == 0)
384 mp->mac_table_initialized = 0;
386 /* Remove all entries */
387 BV (clib_bihash_free) (&mp->mac_table);
389 l2learn_main.global_learn_count = 0;
390 vec_foreach (bd_config, l2input_main.bd_configs)
391 bd_config->learn_count = 0;
394 /** Clear all entries in L2FIB.
395 * @TODO: Later we may want a way to remove only the non-static entries
397 static clib_error_t *
398 clear_l2fib (vlib_main_t * vm,
399 unformat_input_t * input, vlib_cli_command_t * cmd)
401 l2fib_clear_table ();
406 * This command clears all the MAC Address entries from the L2 FIB table.
409 * Example of how to clear the L2 FIB Table:
410 * @cliexcmd{clear l2fib}
411 * Example to show the L2 FIB Table has been cleared:
412 * @cliexstart{show l2fib verbose}
416 VLIB_CLI_COMMAND (clear_l2fib_cli, static) = {
417 .path = "clear l2fib",
418 .short_help = "clear l2fib",
419 .function = clear_l2fib,
422 static l2fib_seq_num_t
423 l2fib_cur_seq_num (u32 bd_index, u32 sw_if_index)
425 l2_bridge_domain_t *bd_config = l2input_bd_config (bd_index);
427 return l2_fib_mk_seq_num (bd_config->seq_num,
428 l2_input_seq_num (sw_if_index));
432 * Add an entry to the l2fib.
433 * If the entry already exists then overwrite it
436 l2fib_add_entry (const u8 * mac, u32 bd_index,
437 u32 sw_if_index, l2fib_entry_result_flags_t flags)
439 l2fib_entry_key_t key;
440 l2fib_entry_result_t result;
441 __attribute__ ((unused)) u32 bucket_contents;
442 l2fib_main_t *fm = &l2fib_main;
443 l2learn_main_t *lm = &l2learn_main;
444 BVT (clib_bihash_kv) kv;
446 if (fm->mac_table_initialized == 0)
450 key.raw = l2fib_make_key (mac, bd_index);
453 /* check if entry already exist */
454 if (BV (clib_bihash_search) (&fm->mac_table, &kv, &kv))
456 /* decrement counter if overwriting a learned mac */
457 result.raw = kv.value;
458 if (!l2fib_entry_result_is_set_AGE_NOT (&result))
460 l2_bridge_domain_t *bd_config =
461 vec_elt_at_index (l2input_main.bd_configs, bd_index);
463 /* check if learn_count == 0 in case of race condition between 2
464 * workers adding an entry simultaneously */
465 /* learn_count variable may have little inaccuracy because they are
466 * not incremented/decremented with atomic operations */
467 /* l2fib_scan is call every 2sec fixing potential inaccuracy */
468 if (lm->global_learn_count)
469 lm->global_learn_count--;
470 if (bd_config->learn_count)
471 bd_config->learn_count--;
476 result.raw = 0; /* clear all fields */
477 result.fields.sw_if_index = sw_if_index;
478 result.fields.flags = flags;
480 /* no aging for provisioned entry */
481 l2fib_entry_result_set_AGE_NOT (&result);
483 kv.value = result.raw;
485 BV (clib_bihash_add_del) (&fm->mac_table, &kv, 1 /* is_add */ );
489 * Add an entry to the L2FIB.
491 * l2fib add <mac> <bd> <intf> [static] [bvi]
492 * l2fib add <mac> <bd> filter
493 * Note that filter and bvi entries are always static
495 static clib_error_t *
496 l2fib_add (vlib_main_t * vm,
497 unformat_input_t * input, vlib_cli_command_t * cmd)
499 bd_main_t *bdm = &bd_main;
500 vnet_main_t *vnm = vnet_get_main ();
501 clib_error_t *error = 0;
505 u32 sw_if_index = ~0;
507 l2fib_entry_result_flags_t flags;
509 flags = L2FIB_ENTRY_RESULT_FLAG_NONE;
511 if (!unformat (input, "%U", unformat_ethernet_address, mac))
513 error = clib_error_return (0, "expected mac address `%U'",
514 format_unformat_error, input);
518 if (!unformat (input, "%d", &bd_id))
520 error = clib_error_return (0, "expected bridge domain ID `%U'",
521 format_unformat_error, input);
525 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
528 error = clib_error_return (0, "bridge domain ID %d invalid", bd_id);
533 if (unformat (input, "filter"))
535 l2fib_add_filter_entry (mac, bd_index);
539 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
541 error = clib_error_return (0, "unknown interface `%U'",
542 format_unformat_error, input);
546 if (unformat (input, "static"))
547 flags |= L2FIB_ENTRY_RESULT_FLAG_STATIC;
548 else if (unformat (input, "bvi"))
549 flags |= (L2FIB_ENTRY_RESULT_FLAG_STATIC | L2FIB_ENTRY_RESULT_FLAG_BVI);
551 if (vec_len (l2input_main.configs) <= sw_if_index)
553 error = clib_error_return (0, "Interface sw_if_index %d not in L2 mode",
558 l2fib_add_entry (mac, bd_index, sw_if_index, flags);
565 * This command adds a MAC Address entry to the L2 FIB table
566 * of an existing bridge-domain. The MAC Address can be static
567 * or dynamic. This command also allows a filter to be added,
568 * such that packets with given MAC Addresses (source mac or
569 * destination mac match) are dropped.
572 * Example of how to add a dynamic MAC Address entry to the L2 FIB table
573 * of a bridge-domain (where 200 is the bridge-domain-id):
574 * @cliexcmd{l2fib add 52:54:00:53:18:33 200 GigabitEthernet0/8/0.200}
575 * Example of how to add a static MAC Address entry to the L2 FIB table
576 * of a bridge-domain (where 200 is the bridge-domain-id):
577 * @cliexcmd{l2fib add 52:54:00:53:18:55 200 GigabitEthernet0/8/0.200 static}
578 * Example of how to add a filter such that a packet with the given MAC
579 * Address will be dropped in a given bridge-domain (where 200 is the
581 * @cliexcmd{l2fib add 52:54:00:53:18:77 200 filter}
582 * Example of show command of the provisioned MAC Addresses and filters:
583 * @cliexstart{show l2fib verbose}
584 * Mac Address BD Idx Interface Index static filter bvi refresh timestamp
585 * 52:54:00:53:18:33 1 GigabitEthernet0/8/0.200 3 0 0 0 0 0
586 * 52:54:00:53:18:55 1 GigabitEthernet0/8/0.200 3 1 0 0 0 0
587 * 52:54:00:53:18:77 1 N/A -1 1 1 0 0 0
591 VLIB_CLI_COMMAND (l2fib_add_cli, static) = {
593 .short_help = "l2fib add <mac> <bridge-domain-id> filter | <intf> [static | bvi]",
594 .function = l2fib_add,
598 static clib_error_t *
599 l2fib_test_command_fn (vlib_main_t * vm,
600 unformat_input_t * input, vlib_cli_command_t * cmd)
602 u8 mac[8], save_mac[6];
612 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
614 if (unformat (input, "mac %U", unformat_ethernet_address, mac))
616 else if (unformat (input, "add"))
618 else if (unformat (input, "del"))
620 else if (unformat (input, "check"))
622 else if (unformat (input, "count %d", &count))
629 return clib_error_return (0, "mac not set");
631 if (is_add == 0 && is_del == 0 && is_check == 0)
632 return clib_error_return (0,
633 "noop: pick at least one of (add,del,check)");
635 clib_memcpy_fast (save_mac, mac, 6);
639 for (i = 0; i < count; i++)
641 l2fib_add_entry (mac, bd_index, sw_if_index,
642 L2FIB_ENTRY_RESULT_FLAG_NONE);
643 incr_mac_address (mac);
649 BVT (clib_bihash_kv) kv;
650 l2fib_main_t *mp = &l2fib_main;
652 if (mp->mac_table_initialized == 0)
653 return clib_error_return (0, "mac table is not initialized");
655 clib_memcpy_fast (mac, save_mac, 6);
657 for (i = 0; i < count; i++)
659 kv.key = l2fib_make_key (mac, bd_index);
660 if (BV (clib_bihash_search) (&mp->mac_table, &kv, &kv))
662 clib_warning ("key %U AWOL", format_ethernet_address, mac);
665 incr_mac_address (mac);
671 clib_memcpy_fast (mac, save_mac, 6);
673 for (i = 0; i < count; i++)
675 l2fib_del_entry (mac, bd_index, 0);
676 incr_mac_address (mac);
684 * The set of '<em>test l2fib</em>' commands allow the L2 FIB table of the default
685 * bridge domain (bridge-domain-id of 0) to be modified.
689 * Example of how to add a set of 4 sequential MAC Address entries to L2
690 * FIB table of the default bridge-domain:
691 * @cliexcmd{test l2fib add mac 52:54:00:53:00:00 count 4}
693 * Show the set of 4 sequential MAC Address entries that were added:
694 * @cliexstart{show l2fib verbose}
695 * Mac Address BD Idx Interface Index static filter bvi refresh timestamp
696 * 52:54:00:53:00:00 0 GigabitEthernet0/8/0.300 8 0 0 0 0 0
697 * 52:54:00:53:00:01 0 GigabitEthernet0/8/0.300 8 0 0 0 0 0
698 * 52:54:00:53:00:03 0 GigabitEthernet0/8/0.300 8 0 0 0 0 0
699 * 52:54:00:53:00:02 0 GigabitEthernet0/8/0.300 8 0 0 0 0 0
703 * Example of how to check that the set of 4 sequential MAC Address
704 * entries were added to L2 FIB table of the default
705 * bridge-domain. Used a count of 5 to produce an error:
707 * @cliexcmd{test l2fib check mac 52:54:00:53:00:00 count 5}
708 * The output of the check command is in the log files. Log file
709 * location may vary based on your OS and Version:
711 * <b><em># tail -f /var/log/messages | grep l2fib_test_command_fn</em></b>
713 * Sep 7 17:15:24 localhost vnet[4952]: l2fib_test_command_fn:446: key 52:54:00:53:00:04 AWOL
715 * Example of how to delete a set of 4 sequential MAC Address entries
716 * from L2 FIB table of the default bridge-domain:
717 * @cliexcmd{test l2fib del mac 52:54:00:53:00:00 count 4}
720 VLIB_CLI_COMMAND (l2fib_test_command, static) = {
721 .path = "test l2fib",
722 .short_help = "test l2fib [add|del|check] mac <base-addr> count <nn>",
723 .function = l2fib_test_command_fn,
728 * Delete an entry from the l2fib.
729 * Return 0 if the entry was deleted, or 1 it was not found or if
730 * sw_if_index is non-zero and does not match that in the entry.
733 l2fib_del_entry (const u8 * mac, u32 bd_index, u32 sw_if_index)
735 l2fib_entry_result_t result;
736 l2fib_main_t *mp = &l2fib_main;
737 BVT (clib_bihash_kv) kv;
739 if (mp->mac_table_initialized == 0)
743 kv.key = l2fib_make_key (mac, bd_index);
745 if (BV (clib_bihash_search) (&mp->mac_table, &kv, &kv))
748 result.raw = kv.value;
750 /* check if sw_if_index of entry match */
751 if ((sw_if_index != 0) && (sw_if_index != result.fields.sw_if_index))
754 /* decrement counter if dynamically learned mac */
755 if (!l2fib_entry_result_is_set_AGE_NOT (&result))
757 l2_bridge_domain_t *bd_config =
758 vec_elt_at_index (l2input_main.bd_configs, bd_index);
759 if (l2learn_main.global_learn_count)
760 l2learn_main.global_learn_count--;
761 if (bd_config->learn_count)
762 bd_config->learn_count--;
765 /* Remove entry from hash table */
766 BV (clib_bihash_add_del) (&mp->mac_table, &kv, 0 /* is_add */ );
771 * Delete an entry from the L2FIB.
773 * l2fib del <mac> <bd-id>
775 static clib_error_t *
776 l2fib_del (vlib_main_t * vm,
777 unformat_input_t * input, vlib_cli_command_t * cmd)
779 bd_main_t *bdm = &bd_main;
780 clib_error_t *error = 0;
786 if (!unformat (input, "%U", unformat_ethernet_address, mac))
788 error = clib_error_return (0, "expected mac address `%U'",
789 format_unformat_error, input);
793 if (!unformat (input, "%d", &bd_id))
795 error = clib_error_return (0, "expected bridge domain ID `%U'",
796 format_unformat_error, input);
800 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
803 error = clib_error_return (0, "bridge domain ID %d invalid", bd_id);
808 /* Delete the entry */
809 if (l2fib_del_entry (mac, bd_index, 0))
811 error = clib_error_return (0, "mac entry not found");
820 * This command deletes an existing MAC Address entry from the L2 FIB
821 * table of an existing bridge-domain.
824 * 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):
825 * @cliexcmd{l2fib del 52:54:00:53:18:33 200}
827 VLIB_CLI_COMMAND (l2fib_del_cli, static) = {
829 .short_help = "l2fib del <mac> <bridge-domain-id> []",
830 .function = l2fib_del,
833 static clib_error_t *
834 l2fib_set_scan_delay (vlib_main_t *vm, unformat_input_t *input,
835 vlib_cli_command_t *cmd)
837 clib_error_t *error = 0;
839 l2fib_main_t *fm = &l2fib_main;
841 if (!unformat (input, "%d", &scan_delay))
843 error = clib_error_return (0, "expecting delay but got `%U'",
844 format_unformat_error, input);
847 fm->event_scan_delay = (f64) (scan_delay) *10e-3;
848 l2fib_flush_all_mac (vlib_get_main ());
854 * This command set scan delay (in 1/10s unit)
857 VLIB_CLI_COMMAND (l2fib_set_scan_delay_cli, static) = {
858 .path = "set l2fib scan-delay",
859 .short_help = "set l2fib scan-delay <delay>",
860 .function = l2fib_set_scan_delay,
864 Kick off ager to scan MACs to age/delete MAC entries
867 l2fib_start_ager_scan (vlib_main_t * vm)
869 uword evt = L2_MAC_AGE_PROCESS_EVENT_ONE_PASS;
871 /* check if there is at least one bd with mac aging enabled */
872 l2_bridge_domain_t *bd_config;
873 vec_foreach (bd_config, l2input_main.bd_configs)
875 if (bd_config->bd_id != ~0 && bd_config->mac_age != 0)
877 evt = L2_MAC_AGE_PROCESS_EVENT_START;
882 vlib_process_signal_event (vm, l2fib_mac_age_scanner_process_node.index,
887 Flush all non static MACs from an interface
890 l2fib_flush_int_mac (vlib_main_t * vm, u32 sw_if_index)
892 l2_input_seq_num_inc (sw_if_index);
893 l2fib_start_ager_scan (vm);
897 Flush all non static MACs in a bridge domain
900 l2fib_flush_bd_mac (vlib_main_t * vm, u32 bd_index)
902 l2_bridge_domain_t *bd_config = l2input_bd_config (bd_index);
903 bd_config->seq_num += 1;
904 l2fib_start_ager_scan (vm);
908 Flush all non static MACs - flushes all valid BDs
911 l2fib_flush_all_mac (vlib_main_t * vm)
913 l2_bridge_domain_t *bd_config;
914 vec_foreach (bd_config, l2input_main.bd_configs)
915 if (bd_is_valid (bd_config))
916 bd_config->seq_num += 1;
918 l2fib_start_ager_scan (vm);
923 Flush MACs, except static ones, associated with an interface
925 l2fib flush-mac interface <if-name>
927 static clib_error_t *
928 l2fib_flush_mac_int (vlib_main_t * vm,
929 unformat_input_t * input, vlib_cli_command_t * cmd)
931 vnet_main_t *vnm = vnet_get_main ();
932 clib_error_t *error = 0;
935 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
937 error = clib_error_return (0, "unknown interface `%U'",
938 format_unformat_error, input);
942 l2fib_flush_int_mac (vm, sw_if_index);
949 Flush all MACs, except static ones
953 static clib_error_t *
954 l2fib_flush_mac_all (vlib_main_t * vm,
955 unformat_input_t * input, vlib_cli_command_t * cmd)
957 l2fib_flush_all_mac (vm);
962 * This command kick off ager to delete all existing MAC Address entries,
963 * except static ones, associated with an interface from the L2 FIB table.
966 * Example of how to flush MAC Address entries learned on an interface from the L2 FIB table:
967 * @cliexcmd{l2fib flush-mac interface GigabitEthernet2/1/0}
969 VLIB_CLI_COMMAND (l2fib_flush_mac_all_cli, static) = {
970 .path = "l2fib flush-mac all",
971 .short_help = "l2fib flush-mac all",
972 .function = l2fib_flush_mac_all,
976 * This command kick off ager to delete all existing MAC Address entries,
977 * except static ones, associated with an interface from the L2 FIB table.
980 * Example of how to flush MAC Address entries learned on an interface from the L2 FIB table:
981 * @cliexcmd{l2fib flush-mac interface GigabitEthernet2/1/0}
983 VLIB_CLI_COMMAND (l2fib_flush_mac_int_cli, static) = {
984 .path = "l2fib flush-mac interface",
985 .short_help = "l2fib flush-mac interface <if-name>",
986 .function = l2fib_flush_mac_int,
990 Flush bridge-domain MACs except static ones.
992 l2fib flush-mac bridge-domain <bd-id>
994 static clib_error_t *
995 l2fib_flush_mac_bd (vlib_main_t * vm,
996 unformat_input_t * input, vlib_cli_command_t * cmd)
998 bd_main_t *bdm = &bd_main;
999 clib_error_t *error = 0;
1000 u32 bd_index, bd_id;
1003 if (!unformat (input, "%d", &bd_id))
1005 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
1006 format_unformat_error, input);
1010 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
1014 return clib_error_return (0, "No such bridge domain %d", bd_id);
1016 l2fib_flush_bd_mac (vm, bd_index);
1023 * This command kick off ager to delete all existing MAC Address entries,
1024 * except static ones, in a bridge domain from the L2 FIB table.
1027 * Example of how to flush MAC Address entries learned in a bridge domain from the L2 FIB table:
1028 * @cliexcmd{l2fib flush-mac bridge-domain 1000}
1030 VLIB_CLI_COMMAND (l2fib_flush_mac_bd_cli, static) = {
1031 .path = "l2fib flush-mac bridge-domain",
1032 .short_help = "l2fib flush-mac bridge-domain <bd-id>",
1033 .function = l2fib_flush_mac_bd,
1037 l2fib_sw_interface_up_down (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
1039 l2_input_config_t *config = l2input_intf_config (sw_if_index);
1040 if ((flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) == 0 &&
1041 l2_input_is_bridge (config))
1042 l2fib_flush_int_mac (vnm->vlib_main, sw_if_index);
1046 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (l2fib_sw_interface_up_down);
1048 BVT (clib_bihash) * get_mac_table (void)
1050 l2fib_main_t *mp = &l2fib_main;
1051 return &mp->mac_table;
1054 static_always_inline void *
1055 allocate_mac_evt_buf (u32 client, u32 client_index)
1057 l2fib_main_t *fm = &l2fib_main;
1058 vl_api_l2_macs_event_t *mp = vl_msg_api_alloc
1059 (sizeof (*mp) + (fm->max_macs_in_event * sizeof (vl_api_mac_entry_t)));
1060 mp->_vl_msg_id = htons (l2input_main.msg_id_base + VL_API_L2_MACS_EVENT);
1061 mp->pid = htonl (client);
1062 mp->client_index = client_index;
1066 static_always_inline f64
1067 l2fib_scan (vlib_main_t * vm, f64 start_time, u8 event_only)
1069 l2fib_main_t *fm = &l2fib_main;
1070 l2learn_main_t *lm = &l2learn_main;
1072 BVT (clib_bihash) * h = &fm->mac_table;
1074 f64 last_start = start_time;
1078 u32 learn_count = 0;
1079 u32 client = lm->client_pid;
1080 u32 cl_idx = lm->client_index;
1081 vl_api_l2_macs_event_t *mp = 0;
1082 vl_api_registration_t *reg = 0;
1084 static u32 *bd_learn_counts = 0;
1086 /* Don't scan the l2 fib if it hasn't been instantiated yet */
1087 if (alloc_arena (h) == 0)
1090 vec_reset_length (bd_learn_counts);
1091 vec_validate (bd_learn_counts, vec_len (l2input_main.bd_configs) - 1);
1095 mp = allocate_mac_evt_buf (client, cl_idx);
1096 reg = vl_api_client_index_to_registration (lm->client_index);
1099 for (i = 0; i < h->nbuckets; i++)
1101 /* allow no more than 20us without a pause */
1102 delta_t = vlib_time_now (vm) - last_start;
1103 if (delta_t > 20e-6)
1105 vlib_process_suspend (vm, 100e-6); /* suspend for 100 us */
1106 /* in case a new bd was created while sleeping */
1107 vec_validate (bd_learn_counts,
1108 vec_len (l2input_main.bd_configs) - 1);
1109 last_start = vlib_time_now (vm);
1113 if (i < (h->nbuckets - 3))
1115 BVT (clib_bihash_bucket) * b =
1116 BV (clib_bihash_get_bucket) (h, i + 3);
1117 clib_prefetch_load (b);
1118 b = BV (clib_bihash_get_bucket) (h, i + 1);
1119 if (!BV (clib_bihash_bucket_is_empty) (b))
1121 BVT (clib_bihash_value) * v =
1122 BV (clib_bihash_get_value) (h, b->offset);
1123 clib_prefetch_load (v);
1127 BVT (clib_bihash_bucket) * b = BV (clib_bihash_get_bucket) (h, i);
1128 if (BV (clib_bihash_bucket_is_empty) (b))
1130 BVT (clib_bihash_value) * v = BV (clib_bihash_get_value) (h, b->offset);
1131 for (j = 0; j < (1 << b->log2_pages); j++)
1133 for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
1135 if (BV (clib_bihash_is_free) (&v->kvp[k]))
1138 l2fib_entry_key_t key = {.raw = v->kvp[k].key };
1139 l2fib_entry_result_t result = {.raw = v->kvp[k].value };
1141 if (!l2fib_entry_result_is_set_AGE_NOT (&result))
1144 vec_elt (bd_learn_counts, key.fields.bd_index)++;
1149 if (PREDICT_FALSE (evt_idx >= fm->max_macs_in_event))
1151 /* event message full, send it and start a new one */
1152 if (reg && vl_api_can_send_msg (reg))
1154 mp->n_macs = htonl (evt_idx);
1155 vl_api_send_msg (reg, (u8 *) mp);
1156 mp = allocate_mac_evt_buf (client, cl_idx);
1161 clib_warning ("MAC event to pid %d queue stuffed!"
1162 " %d MAC entries lost", client,
1168 if (l2fib_entry_result_is_set_LRN_EVT (&result))
1170 /* copy mac entry to event msg */
1171 clib_memcpy_fast (mp->mac[evt_idx].mac_addr,
1173 mp->mac[evt_idx].action =
1174 l2fib_entry_result_is_set_LRN_MOV (&result) ?
1175 (vl_api_mac_event_action_t) MAC_EVENT_ACTION_MOVE
1176 : (vl_api_mac_event_action_t) MAC_EVENT_ACTION_ADD;
1177 mp->mac[evt_idx].action =
1178 htonl (mp->mac[evt_idx].action);
1179 mp->mac[evt_idx].sw_if_index =
1180 htonl (result.fields.sw_if_index);
1181 /* clear event bits and update mac entry */
1182 l2fib_entry_result_clear_LRN_EVT (&result);
1183 l2fib_entry_result_clear_LRN_MOV (&result);
1184 BVT (clib_bihash_kv) kv;
1186 kv.value = result.raw;
1187 BV (clib_bihash_add_del) (&fm->mac_table, &kv, 1);
1189 continue; /* skip aging */
1193 if (event_only || l2fib_entry_result_is_set_AGE_NOT (&result))
1194 continue; /* skip aging - static_mac always age_not */
1196 /* start aging processing */
1197 u32 bd_index = key.fields.bd_index;
1198 u32 sw_if_index = result.fields.sw_if_index;
1199 u16 sn = l2fib_cur_seq_num (bd_index, sw_if_index);
1200 if (result.fields.sn != sn)
1201 goto age_out; /* stale mac */
1203 l2_bridge_domain_t *bd_config =
1204 vec_elt_at_index (l2input_main.bd_configs, bd_index);
1206 if (bd_config->mac_age == 0)
1207 continue; /* skip aging */
1209 i16 delta = (u8) (start_time / 60) - result.fields.timestamp;
1210 delta += delta < 0 ? 256 : 0;
1212 if (delta < bd_config->mac_age)
1213 continue; /* still valid */
1218 /* copy mac entry to event msg */
1219 clib_memcpy_fast (mp->mac[evt_idx].mac_addr, key.fields.mac,
1221 mp->mac[evt_idx].action =
1222 (vl_api_mac_event_action_t) MAC_EVENT_ACTION_DELETE;
1223 mp->mac[evt_idx].action = htonl (mp->mac[evt_idx].action);
1224 mp->mac[evt_idx].sw_if_index =
1225 htonl (result.fields.sw_if_index);
1228 /* delete mac entry */
1229 BVT (clib_bihash_kv) kv;
1231 BV (clib_bihash_add_del) (&fm->mac_table, &kv, 0);
1233 vec_elt (bd_learn_counts, key.fields.bd_index)--;
1235 * Note: we may have just freed the bucket's backing
1236 * storage, so check right here...
1238 if (BV (clib_bihash_bucket_is_empty) (b))
1247 /* keep learn count consistent */
1248 l2learn_main.global_learn_count = learn_count;
1249 vec_foreach_index (bd_index, l2input_main.bd_configs)
1251 vec_elt (l2input_main.bd_configs, bd_index).learn_count =
1252 vec_elt (bd_learn_counts, bd_index);
1257 /* send any outstanding mac event message else free message buffer */
1260 if (reg && vl_api_can_send_msg (reg))
1262 mp->n_macs = htonl (evt_idx);
1263 vl_api_send_msg (reg, (u8 *) mp);
1268 clib_warning ("MAC event to pid %d queue stuffed!"
1269 " %d MAC entries lost", client, evt_idx);
1270 vl_msg_api_free (mp);
1274 vl_msg_api_free (mp);
1276 return delta_t + accum_t;
1280 l2fib_mac_age_scanner_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1283 uword event_type, *event_data = 0;
1284 l2fib_main_t *fm = &l2fib_main;
1285 l2learn_main_t *lm = &l2learn_main;
1287 f64 start_time, next_age_scan_time = CLIB_TIME_MAX;
1292 vlib_process_wait_for_event_or_clock (vm, fm->event_scan_delay);
1295 f64 t = next_age_scan_time - vlib_time_now (vm);
1296 vlib_process_wait_for_event_or_clock (vm, t);
1299 vlib_process_wait_for_event (vm);
1301 event_type = vlib_process_get_events (vm, &event_data);
1302 vec_reset_length (event_data);
1304 start_time = vlib_time_now (vm);
1306 { SCAN_MAC_AGE, SCAN_MAC_EVENT, SCAN_DISABLE } scan = SCAN_MAC_AGE;
1310 case ~0: /* timer expired */
1311 if (lm->client_pid != 0 && start_time < next_age_scan_time)
1312 scan = SCAN_MAC_EVENT;
1315 case L2_MAC_AGE_PROCESS_EVENT_START:
1319 case L2_MAC_AGE_PROCESS_EVENT_STOP:
1321 scan = SCAN_DISABLE;
1324 case L2_MAC_AGE_PROCESS_EVENT_ONE_PASS:
1331 if (scan == SCAN_MAC_EVENT)
1332 l2fib_main.evt_scan_duration = l2fib_scan (vm, start_time, 1);
1335 if (scan == SCAN_MAC_AGE)
1336 l2fib_main.age_scan_duration = l2fib_scan (vm, start_time, 0);
1337 if (scan == SCAN_DISABLE)
1339 l2fib_main.age_scan_duration = 0;
1340 l2fib_main.evt_scan_duration = 0;
1342 /* schedule next scan */
1344 next_age_scan_time = start_time + L2FIB_AGE_SCAN_INTERVAL;
1346 next_age_scan_time = CLIB_TIME_MAX;
1352 VLIB_REGISTER_NODE (l2fib_mac_age_scanner_process_node) = {
1353 .function = l2fib_mac_age_scanner_process,
1354 .type = VLIB_NODE_TYPE_PROCESS,
1355 .name = "l2fib-mac-age-scanner-process",
1359 l2fib_init (vlib_main_t * vm)
1361 l2fib_main_t *mp = &l2fib_main;
1362 l2fib_entry_key_t test_key;
1366 mp->vnet_main = vnet_get_main ();
1367 if (mp->mac_table_n_buckets == 0)
1368 mp->mac_table_n_buckets = L2FIB_NUM_BUCKETS;
1369 if (mp->mac_table_memory_size == 0)
1370 mp->mac_table_memory_size = L2FIB_MEMORY_SIZE;
1371 mp->mac_table_initialized = 0;
1373 /* verify the key constructor is good, since it is endian-sensitive */
1374 clib_memset (test_mac, 0, sizeof (test_mac));
1377 test_key.raw = l2fib_make_key ((u8 *) & test_mac, 0x1234);
1378 ASSERT (test_key.fields.mac[0] == 0x11);
1379 ASSERT (test_key.fields.bd_index == 0x1234);
1384 VLIB_INIT_FUNCTION (l2fib_init);
1386 static clib_error_t *
1387 lfib_config (vlib_main_t * vm, unformat_input_t * input)
1389 l2fib_main_t *lm = &l2fib_main;
1390 uword table_size = ~0;
1393 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1395 if (unformat (input, "table-size %U", unformat_memory_size,
1398 else if (unformat (input, "num-buckets %u", &n_buckets))
1401 return clib_error_return (0, "unknown input `%U'",
1402 format_unformat_error, input);
1405 if (n_buckets != ~0)
1407 if (!is_pow2 (n_buckets))
1408 return clib_error_return (0, "num-buckets must be power of 2");
1409 lm->mac_table_n_buckets = n_buckets;
1412 if (table_size != ~0)
1413 lm->mac_table_memory_size = table_size;
1417 VLIB_CONFIG_FUNCTION (lfib_config, "l2fib");
1420 * fd.io coding-style-patch-verification: ON
1423 * eval: (c-set-style "gnu")