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 incr_mac_address (u8 * mac)
60 u64 tmp = *((u64 *) mac);
61 tmp = clib_net_to_host_u64 (tmp);
62 tmp += 1 << 16; /* skip unused (least significant) octets */
63 tmp = clib_host_to_net_u64 (tmp);
65 clib_memcpy (mac, &tmp, 6);
68 /** Format sw_if_index. If the value is ~0, use the text "N/A" */
70 format_vnet_sw_if_index_name_with_NA (u8 * s, va_list * args)
72 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
73 u32 sw_if_index = va_arg (*args, u32);
74 if (sw_if_index == ~0)
75 return format (s, "N/A");
77 vnet_sw_interface_t *swif = vnet_get_sw_interface_safe (vnm, sw_if_index);
79 return format (s, "Stale");
81 return format (s, "%U", format_vnet_sw_interface_name, vnm,
82 vnet_get_sw_interface_safe (vnm, sw_if_index));
85 typedef struct l2fib_dump_walk_ctx_t_
88 l2fib_entry_key_t *l2fe_key;
89 l2fib_entry_result_t *l2fe_res;
90 } l2fib_dump_walk_ctx_t;
93 l2fib_dump_walk_cb (BVT (clib_bihash_kv) * kvp, void *arg)
95 l2fib_dump_walk_ctx_t *ctx = arg;
96 l2fib_entry_result_t result;
97 l2fib_entry_key_t key;
100 result.raw = kvp->value;
102 if ((ctx->bd_index == ~0) || (ctx->bd_index == key.fields.bd_index))
104 vec_add1 (ctx->l2fe_key, key);
105 vec_add1 (ctx->l2fe_res, result);
110 l2fib_table_dump (u32 bd_index,
111 l2fib_entry_key_t ** l2fe_key,
112 l2fib_entry_result_t ** l2fe_res)
114 l2fib_main_t *msm = &l2fib_main;
115 l2fib_dump_walk_ctx_t ctx = {
116 .bd_index = bd_index,
119 BV (clib_bihash_foreach_key_value_pair)
120 (&msm->mac_table, l2fib_dump_walk_cb, &ctx);
122 *l2fe_key = ctx.l2fe_key;
123 *l2fe_res = ctx.l2fe_res;
126 typedef struct l2fib_show_walk_ctx_t_
137 } l2fib_show_walk_ctx_t;
140 l2fib_show_walk_cb (BVT (clib_bihash_kv) * kvp, void *arg)
142 l2fib_show_walk_ctx_t *ctx = arg;
143 l2_bridge_domain_t *bd_config;
144 l2fib_entry_result_t result;
145 l2fib_entry_key_t key;
147 if (ctx->verbose && ctx->first_entry)
149 ctx->first_entry = 0;
150 vlib_cli_output (ctx->vm,
151 "%=19s%=7s%=7s%=8s%=9s%=7s%=7s%=5s%=30s",
152 "Mac-Address", "BD-Idx", "If-Idx",
153 "BSN-ISN", "Age(min)", "static", "filter",
154 "bvi", "Interface-Name");
158 result.raw = kvp->value;
159 ctx->total_entries++;
162 ((ctx->bd_index >> 31) || (ctx->bd_index == key.fields.bd_index)))
166 if (ctx->learn && l2fib_entry_result_is_set_AGE_NOT (&result))
167 return; /* skip provisioned macs */
169 if (ctx->add && !l2fib_entry_result_is_set_AGE_NOT (&result))
170 return; /* skip learned macs */
172 bd_config = vec_elt_at_index (l2input_main.bd_configs,
173 key.fields.bd_index);
175 if (l2fib_entry_result_is_set_AGE_NOT (&result))
176 s = format (s, "no");
177 else if (bd_config->mac_age == 0)
181 i16 delta = ctx->now - result.fields.timestamp;
182 delta += delta < 0 ? 256 : 0;
183 s = format (s, "%d", delta);
186 vlib_cli_output (ctx->vm,
187 "%=19U%=7d%=7d %3d/%-3d%=9v%=7s%=7s%=5s%=30U",
188 format_ethernet_address, key.fields.mac,
190 result.fields.sw_if_index == ~0
191 ? -1 : result.fields.sw_if_index,
192 result.fields.sn.bd, result.fields.sn.swif, s,
193 l2fib_entry_result_is_set_STATIC (&result) ? "*" : "-",
194 l2fib_entry_result_is_set_FILTER (&result) ? "*" : "-",
195 l2fib_entry_result_is_set_BVI (&result) ? "*" : "-",
196 format_vnet_sw_if_index_name_with_NA,
197 ctx->vnm, result.fields.sw_if_index);
202 /** Display the contents of the l2fib. */
203 static clib_error_t *
204 show_l2fib (vlib_main_t * vm,
205 unformat_input_t * input, vlib_cli_command_t * cmd)
207 bd_main_t *bdm = &bd_main;
208 l2fib_main_t *msm = &l2fib_main;
211 l2fib_show_walk_ctx_t ctx = {
214 .now = (u8) (vlib_time_now (vm) / 60),
216 .vnm = msm->vnet_main,
219 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
221 if (unformat (input, "raw"))
227 else if (unformat (input, "verbose"))
229 else if (unformat (input, "all"))
231 else if (unformat (input, "bd_index %d", &ctx.bd_index))
233 else if (unformat (input, "learn"))
239 else if (unformat (input, "add"))
245 else if (unformat (input, "bd_id %d", &bd_id))
247 uword *p = hash_get (bdm->bd_index_by_bd_id, bd_id);
254 return clib_error_return (0,
255 "bridge domain id %d doesn't exist\n",
262 BV (clib_bihash_foreach_key_value_pair)
263 (&msm->mac_table, l2fib_show_walk_cb, &ctx);
265 if (ctx.total_entries == 0)
266 vlib_cli_output (vm, "no l2fib entries");
269 l2learn_main_t *lm = &l2learn_main;
270 vlib_cli_output (vm, "L2FIB total/learned entries: %d/%d "
271 "Last scan time: %.4esec Learn limit: %d ",
272 ctx.total_entries, lm->global_learn_count,
273 msm->age_scan_duration, lm->global_learn_limit);
275 vlib_cli_output (vm, "L2MAC events client PID: %d "
276 "Last e-scan time: %.4esec Delay: %.2esec "
277 "Max macs in event: %d",
278 lm->client_pid, msm->evt_scan_duration,
279 msm->event_scan_delay, msm->max_macs_in_event);
283 vlib_cli_output (vm, "Raw Hash Table:\n%U\n",
284 BV (format_bihash), &msm->mac_table, 1 /* verbose */ );
290 * This command displays the MAC Address entries of the L2 FIB table.
291 * Output can be filtered to just get the number of MAC Addresses or display
292 * each MAC Address for all bridge domains or just a single bridge domain.
295 * Example of how to display the number of MAC Address entries in the L2
297 * @cliexstart{show l2fib}
300 * Example of how to display all the MAC Address entries in the L2
302 * @cliexstart{show l2fib all}
303 * Mac Address BD Idx Interface Index static filter bvi refresh timestamp
304 * 52:54:00:53:18:33 1 GigabitEthernet0/8/0.200 3 0 0 0 0 0
305 * 52:54:00:53:18:55 1 GigabitEthernet0/8/0.200 3 1 0 0 0 0
306 * 52:54:00:53:18:77 1 N/A -1 1 1 0 0 0
311 VLIB_CLI_COMMAND (show_l2fib_cli, static) = {
312 .path = "show l2fib",
313 .short_help = "show l2fib [all] | [bd_id <nn> | bd_index <nn>] [learn | add] | [raw]",
314 .function = show_l2fib,
319 /* Remove all entries from the l2fib */
321 l2fib_clear_table (void)
323 l2fib_main_t *mp = &l2fib_main;
325 /* Remove all entries */
326 BV (clib_bihash_free) (&mp->mac_table);
327 BV (clib_bihash_init) (&mp->mac_table, "l2fib mac table",
328 L2FIB_NUM_BUCKETS, L2FIB_MEMORY_SIZE);
329 l2learn_main.global_learn_count = 0;
332 /** Clear all entries in L2FIB.
333 * @TODO: Later we may want a way to remove only the non-static entries
335 static clib_error_t *
336 clear_l2fib (vlib_main_t * vm,
337 unformat_input_t * input, vlib_cli_command_t * cmd)
339 l2fib_clear_table ();
344 * This command clears all the MAC Address entries from the L2 FIB table.
347 * Example of how to clear the L2 FIB Table:
348 * @cliexcmd{clear l2fib}
349 * Example to show the L2 FIB Table has been cleared:
350 * @cliexstart{show l2fib verbose}
355 VLIB_CLI_COMMAND (clear_l2fib_cli, static) = {
356 .path = "clear l2fib",
357 .short_help = "clear l2fib",
358 .function = clear_l2fib,
362 static inline l2fib_seq_num_t
363 l2fib_cur_seq_num (u32 bd_index, u32 sw_if_index)
365 l2_bridge_domain_t *bd_config = l2input_bd_config (bd_index);
367 return (l2fib_seq_num_t) {
368 .swif = *l2fib_swif_seq_num (sw_if_index),
369 .bd = bd_config->seq_num,
375 * Add an entry to the l2fib.
376 * If the entry already exists then overwrite it
379 l2fib_add_entry (const u8 * mac, u32 bd_index,
380 u32 sw_if_index, l2fib_entry_result_flags_t flags)
382 l2fib_entry_key_t key;
383 l2fib_entry_result_t result;
384 __attribute__ ((unused)) u32 bucket_contents;
385 l2fib_main_t *fm = &l2fib_main;
386 l2learn_main_t *lm = &l2learn_main;
387 BVT (clib_bihash_kv) kv;
390 key.raw = l2fib_make_key (mac, bd_index);
392 /* check if entry already exist */
393 if (BV (clib_bihash_search) (&fm->mac_table, &kv, &kv))
395 /* decrement counter if overwriting a learned mac */
396 result.raw = kv.value;
397 if ((!l2fib_entry_result_is_set_AGE_NOT (&result))
398 && (lm->global_learn_count))
399 lm->global_learn_count--;
403 result.raw = 0; /* clear all fields */
404 result.fields.sw_if_index = sw_if_index;
405 result.fields.flags = flags;
407 /* no aging for provisioned entry */
408 l2fib_entry_result_set_AGE_NOT (&result);
411 kv.value = result.raw;
413 BV (clib_bihash_add_del) (&fm->mac_table, &kv, 1 /* is_add */ );
417 * Add an entry to the L2FIB.
419 * l2fib add <mac> <bd> <intf> [static] [bvi]
420 * l2fib add <mac> <bd> filter
421 * Note that filter and bvi entries are always static
423 static clib_error_t *
424 l2fib_add (vlib_main_t * vm,
425 unformat_input_t * input, vlib_cli_command_t * cmd)
427 bd_main_t *bdm = &bd_main;
428 vnet_main_t *vnm = vnet_get_main ();
429 clib_error_t *error = 0;
433 u32 sw_if_index = ~0;
435 l2fib_entry_result_flags_t flags;
437 flags = L2FIB_ENTRY_RESULT_FLAG_NONE;
439 if (!unformat (input, "%U", unformat_ethernet_address, mac))
441 error = clib_error_return (0, "expected mac address `%U'",
442 format_unformat_error, input);
446 if (!unformat (input, "%d", &bd_id))
448 error = clib_error_return (0, "expected bridge domain ID `%U'",
449 format_unformat_error, input);
453 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
456 error = clib_error_return (0, "bridge domain ID %d invalid", bd_id);
461 if (unformat (input, "filter"))
463 l2fib_add_filter_entry (mac, bd_index);
467 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
469 error = clib_error_return (0, "unknown interface `%U'",
470 format_unformat_error, input);
474 if (unformat (input, "static"))
475 flags |= L2FIB_ENTRY_RESULT_FLAG_STATIC;
476 else if (unformat (input, "bvi"))
477 flags |= (L2FIB_ENTRY_RESULT_FLAG_STATIC | L2FIB_ENTRY_RESULT_FLAG_BVI);
479 if (vec_len (l2input_main.configs) <= sw_if_index)
481 error = clib_error_return (0, "Interface sw_if_index %d not in L2 mode",
486 l2fib_add_entry (mac, bd_index, sw_if_index, flags);
493 * This command adds a MAC Address entry to the L2 FIB table
494 * of an existing bridge-domain. The MAC Address can be static
495 * or dynamic. This command also allows a filter to be added,
496 * such that packets with given MAC Addresses (source mac or
497 * destination mac match) are dropped.
500 * Example of how to add a dynamic MAC Address entry to the L2 FIB table
501 * of a bridge-domain (where 200 is the bridge-domain-id):
502 * @cliexcmd{l2fib add 52:54:00:53:18:33 200 GigabitEthernet0/8/0.200}
503 * Example of how to add a static MAC Address entry to the L2 FIB table
504 * of a bridge-domain (where 200 is the bridge-domain-id):
505 * @cliexcmd{l2fib add 52:54:00:53:18:55 200 GigabitEthernet0/8/0.200 static}
506 * Example of how to add a filter such that a packet with the given MAC
507 * Address will be dropped in a given bridge-domain (where 200 is the
509 * @cliexcmd{l2fib add 52:54:00:53:18:77 200 filter}
510 * Example of show command of the provisioned MAC Addresses and filters:
511 * @cliexstart{show l2fib verbose}
512 * Mac Address BD Idx Interface Index static filter bvi refresh timestamp
513 * 52:54:00:53:18:33 1 GigabitEthernet0/8/0.200 3 0 0 0 0 0
514 * 52:54:00:53:18:55 1 GigabitEthernet0/8/0.200 3 1 0 0 0 0
515 * 52:54:00:53:18:77 1 N/A -1 1 1 0 0 0
520 VLIB_CLI_COMMAND (l2fib_add_cli, static) = {
522 .short_help = "l2fib add <mac> <bridge-domain-id> filter | <intf> [static | bvi]",
523 .function = l2fib_add,
528 static clib_error_t *
529 l2fib_test_command_fn (vlib_main_t * vm,
530 unformat_input_t * input, vlib_cli_command_t * cmd)
532 clib_error_t *error = 0;
533 u8 mac[6], save_mac[6];
543 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
545 if (unformat (input, "mac %U", unformat_ethernet_address, mac))
547 else if (unformat (input, "add"))
549 else if (unformat (input, "del"))
551 else if (unformat (input, "check"))
553 else if (unformat (input, "count %d", &count))
560 return clib_error_return (0, "mac not set");
562 if (is_add == 0 && is_del == 0 && is_check == 0)
563 return clib_error_return (0,
564 "noop: pick at least one of (add,del,check)");
566 clib_memcpy (save_mac, mac, 6);
570 for (i = 0; i < count; i++)
572 l2fib_add_entry (mac, bd_index, sw_if_index,
573 L2FIB_ENTRY_RESULT_FLAG_NONE);
574 incr_mac_address (mac);
580 BVT (clib_bihash_kv) kv;
581 l2fib_main_t *mp = &l2fib_main;
583 clib_memcpy (mac, save_mac, 6);
585 for (i = 0; i < count; i++)
587 kv.key = l2fib_make_key (mac, bd_index);
588 if (BV (clib_bihash_search) (&mp->mac_table, &kv, &kv))
590 clib_warning ("key %U AWOL", format_ethernet_address, mac);
593 incr_mac_address (mac);
599 clib_memcpy (mac, save_mac, 6);
601 for (i = 0; i < count; i++)
603 l2fib_del_entry (mac, bd_index, 0);
604 incr_mac_address (mac);
612 * The set of '<em>test l2fib</em>' commands allow the L2 FIB table of the default
613 * bridge domain (bridge-domain-id of 0) to be modified.
617 * Example of how to add a set of 4 sequential MAC Address entries to L2
618 * FIB table of the default bridge-domain:
619 * @cliexcmd{test l2fib add mac 52:54:00:53:00:00 count 4}
621 * Show the set of 4 sequential MAC Address entries that were added:
622 * @cliexstart{show l2fib verbose}
623 * Mac Address BD Idx Interface Index static filter bvi refresh timestamp
624 * 52:54:00:53:00:00 0 GigabitEthernet0/8/0.300 8 0 0 0 0 0
625 * 52:54:00:53:00:01 0 GigabitEthernet0/8/0.300 8 0 0 0 0 0
626 * 52:54:00:53:00:03 0 GigabitEthernet0/8/0.300 8 0 0 0 0 0
627 * 52:54:00:53:00:02 0 GigabitEthernet0/8/0.300 8 0 0 0 0 0
631 * Example of how to check that the set of 4 sequential MAC Address
632 * entries were added to L2 FIB table of the default
633 * bridge-domain. Used a count of 5 to produce an error:
635 * @cliexcmd{test l2fib check mac 52:54:00:53:00:00 count 5}
636 * The output of the check command is in the log files. Log file
637 * location may vary based on your OS and Version:
639 * <b><em># tail -f /var/log/messages | grep l2fib_test_command_fn</em></b>
641 * Sep 7 17:15:24 localhost vnet[4952]: l2fib_test_command_fn:446: key 52:54:00:53:00:04 AWOL
643 * Example of how to delete a set of 4 sequential MAC Address entries
644 * from L2 FIB table of the default bridge-domain:
645 * @cliexcmd{test l2fib del mac 52:54:00:53:00:00 count 4}
649 VLIB_CLI_COMMAND (l2fib_test_command, static) = {
650 .path = "test l2fib",
651 .short_help = "test l2fib [add|del|check] mac <base-addr> count <nn>",
652 .function = l2fib_test_command_fn,
658 * Delete an entry from the l2fib.
659 * Return 0 if the entry was deleted, or 1 it was not found or if
660 * sw_if_index is non-zero and does not match that in the entry.
663 l2fib_del_entry (const u8 * mac, u32 bd_index, u32 sw_if_index)
665 l2fib_entry_result_t result;
666 l2fib_main_t *mp = &l2fib_main;
667 BVT (clib_bihash_kv) kv;
670 kv.key = l2fib_make_key (mac, bd_index);
672 if (BV (clib_bihash_search) (&mp->mac_table, &kv, &kv))
675 result.raw = kv.value;
677 /* check if sw_if_index of entry match */
678 if ((sw_if_index != 0) && (sw_if_index != result.fields.sw_if_index))
681 /* decrement counter if dynamically learned mac */
682 if ((!l2fib_entry_result_is_set_AGE_NOT (&result)) &&
683 (l2learn_main.global_learn_count))
684 l2learn_main.global_learn_count--;
686 /* Remove entry from hash table */
687 BV (clib_bihash_add_del) (&mp->mac_table, &kv, 0 /* is_add */ );
692 * Delete an entry from the L2FIB.
694 * l2fib del <mac> <bd-id>
696 static clib_error_t *
697 l2fib_del (vlib_main_t * vm,
698 unformat_input_t * input, vlib_cli_command_t * cmd)
700 bd_main_t *bdm = &bd_main;
701 clib_error_t *error = 0;
707 if (!unformat (input, "%U", unformat_ethernet_address, mac))
709 error = clib_error_return (0, "expected mac address `%U'",
710 format_unformat_error, input);
714 if (!unformat (input, "%d", &bd_id))
716 error = clib_error_return (0, "expected bridge domain ID `%U'",
717 format_unformat_error, input);
721 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
724 error = clib_error_return (0, "bridge domain ID %d invalid", bd_id);
729 /* Delete the entry */
730 if (l2fib_del_entry (mac, bd_index, 0))
732 error = clib_error_return (0, "mac entry not found");
741 * This command deletes an existing MAC Address entry from the L2 FIB
742 * table of an existing bridge-domain.
745 * 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):
746 * @cliexcmd{l2fib del 52:54:00:53:18:33 200}
749 VLIB_CLI_COMMAND (l2fib_del_cli, static) = {
751 .short_help = "l2fib del <mac> <bridge-domain-id> []",
752 .function = l2fib_del,
757 Kick off ager to scan MACs to age/delete MAC entries
760 l2fib_start_ager_scan (vlib_main_t * vm)
762 uword evt = L2_MAC_AGE_PROCESS_EVENT_ONE_PASS;
764 /* check if there is at least one bd with mac aging enabled */
765 l2_bridge_domain_t *bd_config;
766 vec_foreach (bd_config, l2input_main.bd_configs)
768 if (bd_config->bd_id != ~0 && bd_config->mac_age != 0)
770 evt = L2_MAC_AGE_PROCESS_EVENT_START;
775 vlib_process_signal_event (vm, l2fib_mac_age_scanner_process_node.index,
780 Flush all non static MACs from an interface
783 l2fib_flush_int_mac (vlib_main_t * vm, u32 sw_if_index)
785 *l2fib_swif_seq_num (sw_if_index) += 1;
786 l2fib_start_ager_scan (vm);
790 Flush all non static MACs in a bridge domain
793 l2fib_flush_bd_mac (vlib_main_t * vm, u32 bd_index)
795 l2_bridge_domain_t *bd_config = l2input_bd_config (bd_index);
796 bd_config->seq_num += 1;
797 l2fib_start_ager_scan (vm);
801 Flush all non static MACs - flushes all valid BDs
804 l2fib_flush_all_mac (vlib_main_t * vm)
806 l2_bridge_domain_t *bd_config;
807 vec_foreach (bd_config, l2input_main.bd_configs)
808 if (bd_is_valid (bd_config))
809 bd_config->seq_num += 1;
811 l2fib_start_ager_scan (vm);
816 Flush MACs, except static ones, associated with an interface
818 l2fib flush-mac interface <if-name>
820 static clib_error_t *
821 l2fib_flush_mac_int (vlib_main_t * vm,
822 unformat_input_t * input, vlib_cli_command_t * cmd)
824 vnet_main_t *vnm = vnet_get_main ();
825 clib_error_t *error = 0;
828 if (!unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
830 error = clib_error_return (0, "unknown interface `%U'",
831 format_unformat_error, input);
835 l2fib_flush_int_mac (vm, sw_if_index);
842 Flush all MACs, except static ones
846 static clib_error_t *
847 l2fib_flush_mac_all (vlib_main_t * vm,
848 unformat_input_t * input, vlib_cli_command_t * cmd)
850 l2fib_flush_all_mac (vm);
855 * This command kick off ager to delete all existing MAC Address entries,
856 * except static ones, associated with an interface from the L2 FIB table.
859 * Example of how to flush MAC Address entries learned on an interface from the L2 FIB table:
860 * @cliexcmd{l2fib flush-mac interface GigabitEthernet2/1/0}
863 VLIB_CLI_COMMAND (l2fib_flush_mac_all_cli, static) = {
864 .path = "l2fib flush-mac all",
865 .short_help = "l2fib flush-mac all",
866 .function = l2fib_flush_mac_all,
871 * This command kick off ager to delete all existing MAC Address entries,
872 * except static ones, associated with an interface from the L2 FIB table.
875 * Example of how to flush MAC Address entries learned on an interface from the L2 FIB table:
876 * @cliexcmd{l2fib flush-mac interface GigabitEthernet2/1/0}
879 VLIB_CLI_COMMAND (l2fib_flush_mac_int_cli, static) = {
880 .path = "l2fib flush-mac interface",
881 .short_help = "l2fib flush-mac interface <if-name>",
882 .function = l2fib_flush_mac_int,
887 Flush bridge-domain MACs except static ones.
889 l2fib flush-mac bridge-domain <bd-id>
891 static clib_error_t *
892 l2fib_flush_mac_bd (vlib_main_t * vm,
893 unformat_input_t * input, vlib_cli_command_t * cmd)
895 bd_main_t *bdm = &bd_main;
896 clib_error_t *error = 0;
900 if (!unformat (input, "%d", &bd_id))
902 error = clib_error_return (0, "expecting bridge-domain id but got `%U'",
903 format_unformat_error, input);
907 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
911 return clib_error_return (0, "No such bridge domain %d", bd_id);
913 l2fib_flush_bd_mac (vm, bd_index);
920 * This command kick off ager to delete all existing MAC Address entries,
921 * except static ones, in a bridge domain from the L2 FIB table.
924 * Example of how to flush MAC Address entries learned in a bridge domain from the L2 FIB table:
925 * @cliexcmd{l2fib flush-mac bridge-domain 1000}
928 VLIB_CLI_COMMAND (l2fib_flush_mac_bd_cli, static) = {
929 .path = "l2fib flush-mac bridge-domain",
930 .short_help = "l2fib flush-mac bridge-domain <bd-id>",
931 .function = l2fib_flush_mac_bd,
936 l2fib_sw_interface_up_down (vnet_main_t * vnm, u32 sw_if_index, u32 flags)
938 l2_input_config_t *config = l2input_intf_config (sw_if_index);
939 if ((flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) == 0 && config->bridge)
940 l2fib_flush_int_mac (vnm->vlib_main, sw_if_index);
944 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (l2fib_sw_interface_up_down);
946 BVT (clib_bihash) * get_mac_table (void)
948 l2fib_main_t *mp = &l2fib_main;
949 return &mp->mac_table;
952 static_always_inline void *
953 allocate_mac_evt_buf (u32 client, u32 client_index)
955 l2fib_main_t *fm = &l2fib_main;
956 vl_api_l2_macs_event_t *mp = vl_msg_api_alloc
957 (sizeof (*mp) + (fm->max_macs_in_event * sizeof (vl_api_mac_entry_t)));
958 mp->_vl_msg_id = htons (VL_API_L2_MACS_EVENT);
959 mp->pid = htonl (client);
960 mp->client_index = client_index;
964 static_always_inline f64
965 l2fib_scan (vlib_main_t * vm, f64 start_time, u8 event_only)
967 l2fib_main_t *fm = &l2fib_main;
968 l2learn_main_t *lm = &l2learn_main;
970 BVT (clib_bihash) * h = &fm->mac_table;
972 f64 last_start = start_time;
977 u32 client = lm->client_pid;
978 u32 cl_idx = lm->client_index;
979 vl_api_l2_macs_event_t *mp = 0;
980 vl_api_registration_t *reg = 0;
984 mp = allocate_mac_evt_buf (client, cl_idx);
985 reg = vl_api_client_index_to_registration (lm->client_index);
988 for (i = 0; i < h->nbuckets; i++)
990 /* allow no more than 20us without a pause */
991 delta_t = vlib_time_now (vm) - last_start;
994 vlib_process_suspend (vm, 100e-6); /* suspend for 100 us */
995 last_start = vlib_time_now (vm);
999 if (i < (h->nbuckets - 3))
1001 BVT (clib_bihash_bucket) * b = &h->buckets[i + 3];
1002 CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, LOAD);
1003 b = &h->buckets[i + 1];
1006 BVT (clib_bihash_value) * v =
1007 BV (clib_bihash_get_value) (h, b->offset);
1008 CLIB_PREFETCH (v, CLIB_CACHE_LINE_BYTES, LOAD);
1012 BVT (clib_bihash_bucket) * b = &h->buckets[i];
1015 BVT (clib_bihash_value) * v = BV (clib_bihash_get_value) (h, b->offset);
1016 for (j = 0; j < (1 << b->log2_pages); j++)
1018 for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
1020 if (v->kvp[k].key == ~0ULL && v->kvp[k].value == ~0ULL)
1023 l2fib_entry_key_t key = {.raw = v->kvp[k].key };
1024 l2fib_entry_result_t result = {.raw = v->kvp[k].value };
1026 if (!l2fib_entry_result_is_set_AGE_NOT (&result))
1031 if (PREDICT_FALSE (evt_idx >= fm->max_macs_in_event))
1033 /* event message full, send it and start a new one */
1034 if (reg && vl_api_can_send_msg (reg))
1036 mp->n_macs = htonl (evt_idx);
1037 vl_api_send_msg (reg, (u8 *) mp);
1038 mp = allocate_mac_evt_buf (client, cl_idx);
1043 clib_warning ("MAC event to pid %d queue stuffed!"
1044 " %d MAC entries lost", client,
1050 if (l2fib_entry_result_is_set_LRN_EVT (&result))
1052 /* copy mac entry to event msg */
1053 clib_memcpy (mp->mac[evt_idx].mac_addr, key.fields.mac,
1055 mp->mac[evt_idx].action =
1056 l2fib_entry_result_is_set_LRN_MOV (&result) ?
1057 MAC_EVENT_ACTION_MOVE : MAC_EVENT_ACTION_ADD;
1058 mp->mac[evt_idx].sw_if_index =
1059 htonl (result.fields.sw_if_index);
1060 /* clear event bits and update mac entry */
1061 l2fib_entry_result_clear_LRN_EVT (&result);
1062 l2fib_entry_result_clear_LRN_MOV (&result);
1063 BVT (clib_bihash_kv) kv;
1065 kv.value = result.raw;
1066 BV (clib_bihash_add_del) (&fm->mac_table, &kv, 1);
1068 continue; /* skip aging */
1072 if (event_only || l2fib_entry_result_is_set_AGE_NOT (&result))
1073 continue; /* skip aging - static_mac always age_not */
1075 /* start aging processing */
1076 u32 bd_index = key.fields.bd_index;
1077 u32 sw_if_index = result.fields.sw_if_index;
1078 u16 sn = l2fib_cur_seq_num (bd_index, sw_if_index).as_u16;
1079 if (result.fields.sn.as_u16 != sn)
1080 goto age_out; /* stale mac */
1082 l2_bridge_domain_t *bd_config =
1083 vec_elt_at_index (l2input_main.bd_configs, bd_index);
1085 if (bd_config->mac_age == 0)
1086 continue; /* skip aging */
1088 i16 delta = (u8) (start_time / 60) - result.fields.timestamp;
1089 delta += delta < 0 ? 256 : 0;
1091 if (delta < bd_config->mac_age)
1092 continue; /* still valid */
1097 /* copy mac entry to event msg */
1098 clib_memcpy (mp->mac[evt_idx].mac_addr, key.fields.mac, 6);
1099 mp->mac[evt_idx].action = MAC_EVENT_ACTION_DELETE;
1100 mp->mac[evt_idx].sw_if_index =
1101 htonl (result.fields.sw_if_index);
1104 /* delete mac entry */
1105 BVT (clib_bihash_kv) kv;
1107 BV (clib_bihash_add_del) (&fm->mac_table, &kv, 0);
1110 * Note: we may have just freed the bucket's backing
1111 * storage, so check right here...
1122 /* keep learn count consistent */
1123 l2learn_main.global_learn_count = learn_count;
1127 /* send any outstanding mac event message else free message buffer */
1130 if (reg && vl_api_can_send_msg (reg))
1132 mp->n_macs = htonl (evt_idx);
1133 vl_api_send_msg (reg, (u8 *) mp);
1138 clib_warning ("MAC event to pid %d queue stuffed!"
1139 " %d MAC entries lost", client, evt_idx);
1140 vl_msg_api_free (mp);
1144 vl_msg_api_free (mp);
1146 return delta_t + accum_t;
1150 l2fib_mac_age_scanner_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
1153 uword event_type, *event_data = 0;
1154 l2fib_main_t *fm = &l2fib_main;
1155 l2learn_main_t *lm = &l2learn_main;
1157 f64 start_time, next_age_scan_time = CLIB_TIME_MAX;
1162 vlib_process_wait_for_event_or_clock (vm, fm->event_scan_delay);
1165 f64 t = next_age_scan_time - vlib_time_now (vm);
1166 vlib_process_wait_for_event_or_clock (vm, t);
1169 vlib_process_wait_for_event (vm);
1171 event_type = vlib_process_get_events (vm, &event_data);
1172 vec_reset_length (event_data);
1174 start_time = vlib_time_now (vm);
1176 { SCAN_MAC_AGE, SCAN_MAC_EVENT, SCAN_DISABLE } scan = SCAN_MAC_AGE;
1180 case ~0: /* timer expired */
1181 if (lm->client_pid != 0 && start_time < next_age_scan_time)
1182 scan = SCAN_MAC_EVENT;
1185 case L2_MAC_AGE_PROCESS_EVENT_START:
1189 case L2_MAC_AGE_PROCESS_EVENT_STOP:
1191 scan = SCAN_DISABLE;
1194 case L2_MAC_AGE_PROCESS_EVENT_ONE_PASS:
1201 if (scan == SCAN_MAC_EVENT)
1202 l2fib_main.evt_scan_duration = l2fib_scan (vm, start_time, 1);
1205 if (scan == SCAN_MAC_AGE)
1206 l2fib_main.age_scan_duration = l2fib_scan (vm, start_time, 0);
1207 if (scan == SCAN_DISABLE)
1209 l2fib_main.age_scan_duration = 0;
1210 l2fib_main.evt_scan_duration = 0;
1212 /* schedule next scan */
1214 next_age_scan_time = start_time + L2FIB_AGE_SCAN_INTERVAL;
1216 next_age_scan_time = CLIB_TIME_MAX;
1223 VLIB_REGISTER_NODE (l2fib_mac_age_scanner_process_node) = {
1224 .function = l2fib_mac_age_scanner_process,
1225 .type = VLIB_NODE_TYPE_PROCESS,
1226 .name = "l2fib-mac-age-scanner-process",
1231 l2fib_init (vlib_main_t * vm)
1233 l2fib_main_t *mp = &l2fib_main;
1234 l2fib_entry_key_t test_key;
1238 mp->vnet_main = vnet_get_main ();
1240 /* Create the hash table */
1241 BV (clib_bihash_init) (&mp->mac_table, "l2fib mac table",
1242 L2FIB_NUM_BUCKETS, L2FIB_MEMORY_SIZE);
1244 /* verify the key constructor is good, since it is endian-sensitive */
1245 memset (test_mac, 0, sizeof (test_mac));
1248 test_key.raw = l2fib_make_key ((u8 *) & test_mac, 0x1234);
1249 ASSERT (test_key.fields.mac[0] == 0x11);
1250 ASSERT (test_key.fields.bd_index == 0x1234);
1255 VLIB_INIT_FUNCTION (l2fib_init);
1258 * fd.io coding-style-patch-verification: ON
1261 * eval: (c-set-style "gnu")