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>
36 * @brief Ethernet MAC Address FIB Table Management.
38 * The MAC Address forwarding table for bridge-domains is called the l2fib.
39 * Entries are added automatically as part of mac learning, but MAC Addresses
40 * entries can also be added manually.
48 BVT (clib_bihash) mac_table;
50 /* convenience variables */
51 vlib_main_t *vlib_main;
52 vnet_main_t *vnet_main;
55 l2fib_main_t l2fib_main;
58 /** Format sw_if_index. If the value is ~0, use the text "N/A" */
60 format_vnet_sw_if_index_name_with_NA (u8 * s, va_list * args)
62 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
63 u32 sw_if_index = va_arg (*args, u32);
64 if (sw_if_index == ~0)
65 return format (s, "N/A");
67 return format (s, "%U",
68 format_vnet_sw_interface_name, vnm,
69 vnet_get_sw_interface (vnm, sw_if_index));
73 l2fib_table_dump (u32 bd_index, l2fib_entry_key_t ** l2fe_key,
74 l2fib_entry_result_t ** l2fe_res)
76 l2fib_main_t *msm = &l2fib_main;
77 BVT (clib_bihash) * h = &msm->mac_table;
78 clib_bihash_bucket_t *b;
79 BVT (clib_bihash_value) * v;
80 l2fib_entry_key_t key;
81 l2fib_entry_result_t result;
84 for (i = 0; i < h->nbuckets; i++)
89 v = BV (clib_bihash_get_value) (h, b->offset);
90 for (j = 0; j < (1 << b->log2_pages); j++)
92 for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
94 if (v->kvp[k].key == ~0ULL && v->kvp[k].value == ~0ULL)
97 key.raw = v->kvp[k].key;
98 result.raw = v->kvp[k].value;
100 if ((bd_index == ~0) || (bd_index == key.fields.bd_index))
102 vec_add1 (*l2fe_key, key);
103 vec_add1 (*l2fe_res, result);
111 /** Display the contents of the l2fib. */
112 static clib_error_t *
113 show_l2fib (vlib_main_t * vm,
114 unformat_input_t * input, vlib_cli_command_t * cmd)
116 bd_main_t *bdm = &bd_main;
117 l2fib_main_t *msm = &l2fib_main;
118 l2_bridge_domain_t *bd_config;
119 BVT (clib_bihash) * h = &msm->mac_table;
120 clib_bihash_bucket_t *b;
121 BVT (clib_bihash_value) * v;
122 l2fib_entry_key_t key;
123 l2fib_entry_result_t result;
125 u64 total_entries = 0;
129 u32 bd_id, bd_index = ~0;
130 u8 now = (u8) (vlib_time_now (vm) / 60);
133 if (unformat (input, "raw"))
135 else if (unformat (input, "verbose"))
137 else if (unformat (input, "bd_index %d", &bd_index))
139 else if (unformat (input, "bd_id %d", &bd_id))
141 uword *p = hash_get (bdm->bd_index_by_bd_id, bd_id);
149 vlib_cli_output (vm, "no such bridge domain id");
154 for (i = 0; i < h->nbuckets; i++)
159 v = BV (clib_bihash_get_value) (h, b->offset);
160 for (j = 0; j < (1 << b->log2_pages); j++)
162 for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
164 if (v->kvp[k].key == ~0ULL && v->kvp[k].value == ~0ULL)
167 if (verbose && first_entry)
171 "%=19s%=7s%=30s%=7s%=8s%=8s%=5s%=16s",
172 "Mac Address", "BD Idx", "Interface",
173 "Index", "static", "filter", "bvi",
177 key.raw = v->kvp[k].key;
178 result.raw = v->kvp[k].value;
181 & ((bd_index >> 31) || (bd_index == key.fields.bd_index)))
183 bd_config = vec_elt_at_index (l2input_main.bd_configs,
184 key.fields.bd_index);
186 if (bd_config->mac_age)
188 i16 delta = now - result.fields.timestamp;
189 delta += delta < 0 ? 256 : 0;
190 s = format (s, "%d", delta);
193 s = format (s, "disabled");
196 "%=19U%=7d%=30U%=7d%=8d%=8d%=5d%=16v",
197 format_ethernet_address, key.fields.mac,
199 format_vnet_sw_if_index_name_with_NA,
200 msm->vnet_main, result.fields.sw_if_index,
201 result.fields.sw_if_index == ~0
202 ? -1 : result.fields.sw_if_index,
203 result.fields.static_mac,
204 result.fields.filter,
205 result.fields.bvi, s);
206 vec_reset_length (s);
214 if (total_entries == 0)
215 vlib_cli_output (vm, "no l2fib entries");
217 vlib_cli_output (vm, "%lld l2fib entries", total_entries);
220 vlib_cli_output (vm, "Raw Hash Table:\n%U\n",
221 BV (format_bihash), h, 1 /* verbose */ );
228 * This command dispays the MAC Address entries of the L2 FIB table.
229 * Output can be filtered to just get the number of MAC Addresses or display
230 * each MAC Address for all bridge domains or just a single bridge domain.
233 * Example of how to display the number of MAC Address entries in the L2
235 * @cliexstart{show l2fib}
238 * Example of how to display all the MAC Address entries in the L2
240 * @cliexstart{show l2fib verbose}
241 * Mac Address BD Idx Interface Index static filter bvi refresh timestamp
242 * 52:54:00:53:18:33 1 GigabitEthernet0/8/0.200 3 0 0 0 0 0
243 * 52:54:00:53:18:55 1 GigabitEthernet0/8/0.200 3 1 0 0 0 0
244 * 52:54:00:53:18:77 1 N/A -1 1 1 0 0 0
249 VLIB_CLI_COMMAND (show_l2fib_cli, static) = {
250 .path = "show l2fib",
251 .short_help = "show l2fib [verbose | bd_id <nn> | bd_index <nn> | raw]",
252 .function = show_l2fib,
257 /* Remove all entries from the l2fib */
259 l2fib_clear_table (uint keep_static)
261 l2fib_main_t *mp = &l2fib_main;
265 /* TODO: remove only non-static entries */
269 /* Remove all entries */
270 BV (clib_bihash_free) (&mp->mac_table);
271 BV (clib_bihash_init) (&mp->mac_table, "l2fib mac table",
272 L2FIB_NUM_BUCKETS, L2FIB_MEMORY_SIZE);
275 l2learn_main.global_learn_count = 0;
278 /** Clear all entries in L2FIB.
279 * @TODO: Later we may want a way to remove only the non-static entries
281 static clib_error_t *
282 clear_l2fib (vlib_main_t * vm,
283 unformat_input_t * input, vlib_cli_command_t * cmd)
285 l2fib_clear_table (0);
290 * This command clears all the MAC Address entries from the L2 FIB table.
293 * Example of how to clear the L2 FIB Table:
294 * @cliexcmd{clear l2fib}
295 * Example to show the L2 FIB Table has been cleared:
296 * @cliexstart{show l2fib verbose}
301 VLIB_CLI_COMMAND (clear_l2fib_cli, static) = {
302 .path = "clear l2fib",
303 .short_help = "clear l2fib",
304 .function = clear_l2fib,
310 * Add an entry to the l2fib.
311 * If the entry already exists then overwrite it
314 l2fib_add_entry (u64 mac,
316 u32 sw_if_index, u32 static_mac, u32 filter_mac, u32 bvi_mac)
318 l2fib_entry_key_t key;
319 l2fib_entry_result_t result;
320 __attribute__ ((unused)) u32 bucket_contents;
321 l2fib_main_t *mp = &l2fib_main;
322 BVT (clib_bihash_kv) kv;
325 key.raw = l2fib_make_key ((u8 *) & mac, bd_index);
328 result.raw = 0; /* clear all fields */
329 result.fields.sw_if_index = sw_if_index;
330 result.fields.static_mac = static_mac;
331 result.fields.filter = filter_mac;
332 result.fields.bvi = bvi_mac;
335 kv.value = result.raw;
337 BV (clib_bihash_add_del) (&mp->mac_table, &kv, 1 /* is_add */ );
339 /* increment counter if dynamically learned mac */
340 if (result.fields.static_mac)
342 l2learn_main.global_learn_count++;
347 * Add an entry to the L2FIB.
349 * l2fib add <mac> <bd> <intf> [static] [bvi]
350 * l2fib add <mac> <bd> filter
351 * Note that filter and bvi entries are always static
353 static clib_error_t *
354 l2fib_add (vlib_main_t * vm,
355 unformat_input_t * input, vlib_cli_command_t * cmd)
357 bd_main_t *bdm = &bd_main;
358 vnet_main_t *vnm = vnet_get_main ();
359 clib_error_t *error = 0;
363 u32 sw_if_index = ~0;
369 if (!unformat_user (input, unformat_ethernet_address, &mac))
371 error = clib_error_return (0, "expected mac address `%U'",
372 format_unformat_error, input);
376 if (!unformat (input, "%d", &bd_id))
378 error = clib_error_return (0, "expected bridge domain ID `%U'",
379 format_unformat_error, input);
383 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
386 error = clib_error_return (0, "bridge domain ID %d invalid", bd_id);
391 if (unformat (input, "filter"))
401 (input, unformat_vnet_sw_interface, vnm, &sw_if_index))
403 error = clib_error_return (0, "unknown interface `%U'",
404 format_unformat_error, input);
407 if (unformat (input, "static"))
411 else if (unformat (input, "bvi"))
418 l2fib_add_entry (mac, bd_index, sw_if_index, static_mac, filter_mac,
426 * This command adds a MAC Address entry to the L2 FIB table
427 * of an existing bridge-domain. The MAC Address can be static
428 * or dynamic. This command also allows a filter to be added,
429 * such that packets with given MAC Addresses (source mac or
430 * destination mac match) are dropped.
433 * Example of how to add a dynamic MAC Address entry to the L2 FIB table
434 * of a bridge-domain (where 200 is the bridge-domain-id):
435 * @cliexcmd{l2fib add 52:54:00:53:18:33 200 GigabitEthernet0/8/0.200}
436 * Example of how to add a static MAC Address entry to the L2 FIB table
437 * of a bridge-domain (where 200 is the bridge-domain-id):
438 * @cliexcmd{l2fib add 52:54:00:53:18:55 200 GigabitEthernet0/8/0.200 static}
439 * Example of how to add a filter such that a packet with the given MAC
440 * Address will be dropped in a given bridge-domain (where 200 is the
442 * @cliexcmd{l2fib add 52:54:00:53:18:77 200 filter}
443 * Example of show command of the provisioned MAC Addresses and filters:
444 * @cliexstart{show l2fib verbose}
445 * Mac Address BD Idx Interface Index static filter bvi refresh timestamp
446 * 52:54:00:53:18:33 1 GigabitEthernet0/8/0.200 3 0 0 0 0 0
447 * 52:54:00:53:18:55 1 GigabitEthernet0/8/0.200 3 1 0 0 0 0
448 * 52:54:00:53:18:77 1 N/A -1 1 1 0 0 0
453 VLIB_CLI_COMMAND (l2fib_add_cli, static) = {
455 .short_help = "l2fib add <mac> <bridge-domain-id> filter | <intf> [static | bvi]",
456 .function = l2fib_add,
461 static clib_error_t *
462 l2fib_test_command_fn (vlib_main_t * vm,
463 unformat_input_t * input, vlib_cli_command_t * cmd)
465 clib_error_t *error = 0;
478 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
480 if (unformat (input, "mac %U", unformat_ethernet_address, &mac))
482 else if (unformat (input, "add"))
484 else if (unformat (input, "del"))
486 else if (unformat (input, "check"))
488 else if (unformat (input, "count %d", &count))
495 return clib_error_return (0, "mac not set");
497 if (is_add == 0 && is_del == 0 && is_check == 0)
498 return clib_error_return (0,
499 "noop: pick at least one of (add,del,check)");
505 for (i = 0; i < count; i++)
508 l2fib_add_entry (mac, bd_index, sw_if_index, mac,
509 filter_mac, bvi_mac);
510 tmp = clib_net_to_host_u64 (mac);
514 mac = clib_host_to_net_u64 (tmp);
520 BVT (clib_bihash_kv) kv;
521 l2fib_main_t *mp = &l2fib_main;
525 for (i = 0; i < count; i++)
528 kv.key = l2fib_make_key ((u8 *) & mac, bd_index);
529 if (BV (clib_bihash_search) (&mp->mac_table, &kv, &kv))
531 clib_warning ("key %U AWOL", format_ethernet_address, &mac);
534 tmp = clib_net_to_host_u64 (mac);
538 mac = clib_host_to_net_u64 (tmp);
544 for (i = 0; i < count; i++)
548 l2fib_del_entry (mac, bd_index);
550 tmp = clib_net_to_host_u64 (mac);
554 mac = clib_host_to_net_u64 (tmp);
562 * The set of '<em>test l2fib</em>' commands allow the L2 FIB table of the default
563 * bridge domain (bridge-domain-id of 0) to be modified.
567 * Example of how to add a set of 4 sequential MAC Address entries to L2
568 * FIB table of the default bridge-domain:
569 * @cliexcmd{test l2fib add mac 52:54:00:53:00:00 count 4}
571 * Show the set of 4 sequential MAC Address entries that were added:
572 * @cliexstart{show l2fib verbose}
573 * Mac Address BD Idx Interface Index static filter bvi refresh timestamp
574 * 52:54:00:53:00:00 0 GigabitEthernet0/8/0.300 8 0 0 0 0 0
575 * 52:54:00:53:00:01 0 GigabitEthernet0/8/0.300 8 0 0 0 0 0
576 * 52:54:00:53:00:03 0 GigabitEthernet0/8/0.300 8 0 0 0 0 0
577 * 52:54:00:53:00:02 0 GigabitEthernet0/8/0.300 8 0 0 0 0 0
581 * Example of how to check that the set of 4 sequential MAC Address
582 * entries were added to L2 FIB table of the default
583 * bridge-domain. Used a count of 5 to produce an error:
585 * @cliexcmd{test l2fib check mac 52:54:00:53:00:00 count 5}
586 * The output of the check command is in the log files. Log file
587 * location may vary based on your OS and Version:
589 * <b><em># tail -f /var/log/messages | grep l2fib_test_command_fn</em></b>
591 * Sep 7 17:15:24 localhost vnet[4952]: l2fib_test_command_fn:446: key 52:54:00:53:00:04 AWOL
593 * Example of how to delete a set of 4 sequential MAC Address entries
594 * from L2 FIB table of the default bridge-domain:
595 * @cliexcmd{test l2fib del mac 52:54:00:53:00:00 count 4}
599 VLIB_CLI_COMMAND (l2fib_test_command, static) = {
600 .path = "test l2fib",
601 .short_help = "test l2fib [add|del|check] mac <base-addr> count <nn>",
602 .function = l2fib_test_command_fn,
608 * Delete an entry from the l2fib.
609 * Return 0 if the entry was deleted, or 1 if it was not found
612 l2fib_del_entry (u64 mac, u32 bd_index)
615 l2fib_entry_result_t result;
616 l2fib_main_t *mp = &l2fib_main;
617 BVT (clib_bihash_kv) kv;
620 kv.key = l2fib_make_key ((u8 *) & mac, bd_index);
622 if (BV (clib_bihash_search) (&mp->mac_table, &kv, &kv))
625 result.raw = kv.value;
627 /* decrement counter if dynamically learned mac */
628 if (result.fields.static_mac)
630 if (l2learn_main.global_learn_count > 0)
632 l2learn_main.global_learn_count--;
636 /* Remove entry from hash table */
637 BV (clib_bihash_add_del) (&mp->mac_table, &kv, 0 /* is_add */ );
642 * Delete an entry from the L2FIB.
644 * l2fib del <mac> <bd-id>
646 static clib_error_t *
647 l2fib_del (vlib_main_t * vm,
648 unformat_input_t * input, vlib_cli_command_t * cmd)
650 bd_main_t *bdm = &bd_main;
651 clib_error_t *error = 0;
657 if (!unformat_user (input, unformat_ethernet_address, &mac))
659 error = clib_error_return (0, "expected mac address `%U'",
660 format_unformat_error, input);
664 if (!unformat (input, "%d", &bd_id))
666 error = clib_error_return (0, "expected bridge domain ID `%U'",
667 format_unformat_error, input);
671 p = hash_get (bdm->bd_index_by_bd_id, bd_id);
674 error = clib_error_return (0, "bridge domain ID %d invalid", bd_id);
679 /* Delete the entry */
680 if (l2fib_del_entry (mac, bd_index))
682 error = clib_error_return (0, "mac entry not found");
691 * This command deletes an existing MAC Address entry from the L2 FIB
692 * table of an existing bridge-domain.
695 * 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):
696 * @cliexcmd{l2fib del 52:54:00:53:18:33 200}
699 VLIB_CLI_COMMAND (l2fib_del_cli, static) = {
701 .short_help = "l2fib del <mac> <bridge-domain-id>",
702 .function = l2fib_del,
707 BVT (clib_bihash) * get_mac_table (void)
709 l2fib_main_t *mp = &l2fib_main;
710 return &mp->mac_table;
714 l2fib_mac_age_scanner_process (vlib_main_t * vm, vlib_node_runtime_t * rt,
717 uword event_type, *event_data = 0;
718 l2fib_main_t *msm = &l2fib_main;
719 l2_bridge_domain_t *bd_config;
720 BVT (clib_bihash) * h = &msm->mac_table;
721 clib_bihash_bucket_t *b;
722 BVT (clib_bihash_value) * v;
723 l2fib_entry_key_t key;
724 l2fib_entry_result_t result;
727 f64 start_time, last_run_duration = 0, t;
733 vlib_process_wait_for_event_or_clock (vm, 60 - last_run_duration);
735 vlib_process_wait_for_event (vm);
737 event_type = vlib_process_get_events (vm, &event_data);
738 vec_reset_length (event_data);
744 case L2_MAC_AGE_PROCESS_EVENT_START:
747 case L2_MAC_AGE_PROCESS_EVENT_STOP:
753 last_run_duration = start_time = vlib_time_now (vm);
754 for (i = 0; i < h->nbuckets; i++)
756 /* Allow no more than 10us without a pause */
757 t = vlib_time_now (vm);
758 if (t > start_time + 10e-6)
760 vlib_process_suspend (vm, 100e-6); /* suspend for 100 us */
761 start_time = vlib_time_now (vm);
764 if (i < (h->nbuckets - 3))
766 b = &h->buckets[i + 3];
767 CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, LOAD);
768 b = &h->buckets[i + 1];
771 v = BV (clib_bihash_get_value) (h, b->offset);
772 CLIB_PREFETCH (v, CLIB_CACHE_LINE_BYTES, LOAD);
779 v = BV (clib_bihash_get_value) (h, b->offset);
780 for (j = 0; j < (1 << b->log2_pages); j++)
782 for (k = 0; k < BIHASH_KVP_PER_PAGE; k++)
784 if (v->kvp[k].key == ~0ULL && v->kvp[k].value == ~0ULL)
787 key.raw = v->kvp[k].key;
788 result.raw = v->kvp[k].value;
790 if (result.fields.static_mac)
793 bd_config = vec_elt_at_index (l2input_main.bd_configs,
794 key.fields.bd_index);
796 if (bd_config->mac_age == 0)
799 delta = (u8) (start_time / 60) - result.fields.timestamp;
800 delta += delta < 0 ? 256 : 0;
802 if (delta > bd_config->mac_age)
804 void *p = &key.fields.mac;
805 l2fib_del_entry (*(u64 *) p, key.fields.bd_index);
811 last_run_duration = vlib_time_now (vm) - last_run_duration;
817 VLIB_REGISTER_NODE (l2fib_mac_age_scanner_process_node) = {
818 .function = l2fib_mac_age_scanner_process,
819 .type = VLIB_NODE_TYPE_PROCESS,
820 .name = "l2fib-mac-age-scanner-process",
825 l2fib_init (vlib_main_t * vm)
827 l2fib_main_t *mp = &l2fib_main;
828 l2fib_entry_key_t test_key;
832 mp->vnet_main = vnet_get_main ();
834 /* Create the hash table */
835 BV (clib_bihash_init) (&mp->mac_table, "l2fib mac table",
836 L2FIB_NUM_BUCKETS, L2FIB_MEMORY_SIZE);
838 /* verify the key constructor is good, since it is endian-sensitive */
839 memset (test_mac, 0, sizeof (test_mac));
842 test_key.raw = l2fib_make_key ((u8 *) & test_mac, 0x1234);
843 ASSERT (test_key.fields.mac[0] == 0x11);
844 ASSERT (test_key.fields.bd_index == 0x1234);
849 VLIB_INIT_FUNCTION (l2fib_init);
852 * fd.io coding-style-patch-verification: ON
855 * eval: (c-set-style "gnu")