2 * l2_fib.h : 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.
18 #ifndef included_l2fib_h
19 #define included_l2fib_h
21 #include <vlib/vlib.h>
22 #include <vppinfra/bihash_8_8.h>
25 * The size of the hash table
27 #define L2FIB_NUM_BUCKETS (64 * 1024)
28 #define L2FIB_MEMORY_SIZE (512<<20)
30 /* Ager scan interval is 1 minute for aging */
31 #define L2FIB_AGE_SCAN_INTERVAL (60.0)
33 /* MAC event scan delay is 100 msec unless specified by MAC event client */
34 #define L2FIB_EVENT_SCAN_DELAY_DEFAULT (0.1)
36 /* Max MACs in a event message is 100 unless specified by MAC event client */
37 #define L2FIB_EVENT_MAX_MACS_DEFAULT (100)
39 /* MAC event learn limit is 1000 unless specified by MAC event client */
40 #define L2FIB_EVENT_LEARN_LIMIT_DEFAULT (1000)
46 BVT (clib_bihash) mac_table;
48 /* per swif vector of sequence number for interface based flush of MACs */
51 /* last event or ager scan duration */
52 f64 evt_scan_duration;
53 f64 age_scan_duration;
55 /* delay between event scans, default to 100 msec */
58 /* max macs in evet message, default to 100 entries */
59 u32 max_macs_in_event;
61 /* convenience variables */
62 vlib_main_t *vlib_main;
63 vnet_main_t *vnet_main;
66 extern l2fib_main_t l2fib_main;
69 * The L2fib key is the mac address and bridge domain ID
89 STATIC_ASSERT_SIZEOF (l2fib_entry_key_t, 8);
106 * The l2fib entry results
114 u32 sw_if_index; /* output sw_if_index (L3 intf if bvi==1) */
116 u8 static_mac:1; /* static mac, no MAC move */
117 u8 age_not:1; /* not subject to age */
118 u8 bvi:1; /* mac is for a bridged virtual interface */
119 u8 filter:1; /* drop packets to/from this mac */
120 u8 lrn_evt:1; /* MAC learned to be sent in L2 MAC event */
123 u8 timestamp; /* timestamp for aging */
124 l2fib_seq_num_t sn; /* bd/int seq num */
128 } l2fib_entry_result_t;
130 STATIC_ASSERT_SIZEOF (l2fib_entry_result_t, 8);
133 * Compute the hash for the given key and return
134 * the corresponding bucket index
137 l2fib_compute_hash_bucket (l2fib_entry_key_t * key)
143 result = 0xa5a5a5a5; /* some seed */
144 temp_a = key->words.w0;
145 temp_b = key->words.w1;
146 hash_mix32 (temp_a, temp_b, result);
148 return result % L2FIB_NUM_BUCKETS;
152 * make address sanitizer skip this:
153 * The 6-Bytes mac-address is cast into an 8-Bytes u64, with 2 additional Bytes.
154 * l2fib_make_key() does read those two Bytes but does not use them.
156 always_inline u64 __attribute__ ((no_sanitize_address))
157 l2fib_make_key (u8 * mac_address, u16 bd_index)
162 * The mac address in memory is A:B:C:D:E:F
163 * The bd id in register is H:L
165 #if CLIB_ARCH_IS_LITTLE_ENDIAN
167 * Create the in-register key as F:E:D:C:B:A:H:L
168 * In memory the key is L:H:A:B:C:D:E:F
170 temp = *((u64 *) (mac_address)) << 16;
171 temp = (temp & ~0xffff) | (u64) (bd_index);
174 * Create the in-register key as H:L:A:B:C:D:E:F
175 * In memory the key is H:L:A:B:C:D:E:F
177 temp = *((u64 *) (mac_address)) >> 16;
178 temp = temp | (((u64) bd_index) << 48);
187 * Lookup the entry for mac and bd_index in the mac table for 1 packet.
188 * Cached_key and cached_result are used as a one-entry cache.
189 * The function reads and updates them as needed.
191 * mac0 and bd_index0 are the keys. The entry is written to result0.
192 * If the entry was not found, result0 is set to ~0.
194 * key0 and bucket0 return with the computed key and hash bucket,
195 * convenient if the entry needs to be updated afterward.
196 * If the cached_result was used, bucket0 is set to ~0.
199 static_always_inline void
200 l2fib_lookup_1 (BVT (clib_bihash) * mac_table,
201 l2fib_entry_key_t * cached_key,
202 l2fib_entry_result_t * cached_result,
205 l2fib_entry_key_t * key0,
206 u32 * bucket0, l2fib_entry_result_t * result0)
209 key0->raw = l2fib_make_key (mac0, bd_index0);
212 if (key0->raw == cached_key->raw)
214 /* Hit in the one-entry cache */
215 result0->raw = cached_result->raw;
219 /* Do a regular mac table lookup */
220 BVT (clib_bihash_kv) kv;
224 BV (clib_bihash_search_inline) (mac_table, &kv);
225 result0->raw = kv.value;
227 /* Update one-entry cache */
228 cached_key->raw = key0->raw;
229 cached_result->raw = result0->raw;
235 * Lookup the entry for mac and bd_index in the mac table for 2 packets.
236 * The lookups for the two packets are interleaved.
238 * Cached_key and cached_result are used as a one-entry cache.
239 * The function reads and updates them as needed.
241 * mac0 and bd_index0 are the keys. The entry is written to result0.
242 * If the entry was not found, result0 is set to ~0. The same
243 * holds for mac1/bd_index1/result1.
245 static_always_inline void
246 l2fib_lookup_2 (BVT (clib_bihash) * mac_table,
247 l2fib_entry_key_t * cached_key,
248 l2fib_entry_result_t * cached_result,
253 l2fib_entry_key_t * key0,
254 l2fib_entry_key_t * key1,
257 l2fib_entry_result_t * result0,
258 l2fib_entry_result_t * result1)
261 key0->raw = l2fib_make_key (mac0, bd_index0);
262 key1->raw = l2fib_make_key (mac1, bd_index1);
264 if ((key0->raw == cached_key->raw) && (key1->raw == cached_key->raw))
266 /* Both hit in the one-entry cache */
267 result0->raw = cached_result->raw;
268 result1->raw = cached_result->raw;
275 BVT (clib_bihash_kv) kv0, kv1;
278 * Do a regular mac table lookup
279 * Interleave lookups for packet 0 and packet 1
286 BV (clib_bihash_search_inline) (mac_table, &kv0);
287 BV (clib_bihash_search_inline) (mac_table, &kv1);
289 result0->raw = kv0.value;
290 result1->raw = kv1.value;
292 /* Update one-entry cache */
293 cached_key->raw = key1->raw;
294 cached_result->raw = result1->raw;
298 static_always_inline void
299 l2fib_lookup_4 (BVT (clib_bihash) * mac_table,
300 l2fib_entry_key_t * cached_key,
301 l2fib_entry_result_t * cached_result,
310 l2fib_entry_key_t * key0,
311 l2fib_entry_key_t * key1,
312 l2fib_entry_key_t * key2,
313 l2fib_entry_key_t * key3,
318 l2fib_entry_result_t * result0,
319 l2fib_entry_result_t * result1,
320 l2fib_entry_result_t * result2,
321 l2fib_entry_result_t * result3)
324 key0->raw = l2fib_make_key (mac0, bd_index0);
325 key1->raw = l2fib_make_key (mac1, bd_index1);
326 key2->raw = l2fib_make_key (mac2, bd_index2);
327 key3->raw = l2fib_make_key (mac3, bd_index3);
329 if ((key0->raw == cached_key->raw) && (key1->raw == cached_key->raw) &&
330 (key2->raw == cached_key->raw) && (key3->raw == cached_key->raw))
332 /* Both hit in the one-entry cache */
333 result0->raw = cached_result->raw;
334 result1->raw = cached_result->raw;
335 result2->raw = cached_result->raw;
336 result3->raw = cached_result->raw;
345 BVT (clib_bihash_kv) kv0, kv1, kv2, kv3;
348 * Do a regular mac table lookup
349 * Interleave lookups for packet 0 and packet 1
360 BV (clib_bihash_search_inline) (mac_table, &kv0);
361 BV (clib_bihash_search_inline) (mac_table, &kv1);
362 BV (clib_bihash_search_inline) (mac_table, &kv2);
363 BV (clib_bihash_search_inline) (mac_table, &kv3);
365 result0->raw = kv0.value;
366 result1->raw = kv1.value;
367 result2->raw = kv2.value;
368 result3->raw = kv3.value;
370 /* Update one-entry cache */
371 cached_key->raw = key1->raw;
372 cached_result->raw = result1->raw;
376 void l2fib_clear_table (void);
379 l2fib_add_entry (u8 * mac,
381 u32 sw_if_index, u8 static_mac, u8 drop_mac, u8 bvi_mac);
384 l2fib_add_fwd_entry (u8 * mac, u32 bd_index, u32 sw_if_index, u8 static_mac,
387 l2fib_add_entry (mac, bd_index, sw_if_index, static_mac, 0, bvi_mac);
391 l2fib_add_filter_entry (u8 * mac, u32 bd_index)
393 l2fib_add_entry (mac, bd_index, ~0, 1, 1, 0);
396 u32 l2fib_del_entry (u8 * mac, u32 bd_index);
398 void l2fib_start_ager_scan (vlib_main_t * vm);
400 void l2fib_flush_int_mac (vlib_main_t * vm, u32 sw_if_index);
402 void l2fib_flush_bd_mac (vlib_main_t * vm, u32 bd_index);
404 void l2fib_flush_all_mac (vlib_main_t * vm);
407 l2fib_table_dump (u32 bd_index, l2fib_entry_key_t ** l2fe_key,
408 l2fib_entry_result_t ** l2fe_res);
410 u8 *format_vnet_sw_if_index_name_with_NA (u8 * s, va_list * args);
412 static_always_inline u8 *
413 l2fib_swif_seq_num (u32 sw_if_index)
415 l2fib_main_t *mp = &l2fib_main;
416 return vec_elt_at_index (mp->swif_seq_num, sw_if_index);
419 static_always_inline u8 *
420 l2fib_valid_swif_seq_num (u32 sw_if_index)
422 l2fib_main_t *mp = &l2fib_main;
423 vec_validate (mp->swif_seq_num, sw_if_index);
424 return l2fib_swif_seq_num (sw_if_index);
427 BVT (clib_bihash) * get_mac_table (void);
432 * fd.io coding-style-patch-verification: ON
435 * eval: (c-set-style "gnu")