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 (256<<20)
31 * The L2fib key is the mac address and bridge domain ID
51 STATIC_ASSERT_SIZEOF (l2fib_entry_key_t, 8);
54 * The l2fib entry results
62 u32 sw_if_index; /* output sw_if_index (L3 interface if bvi==1) */
64 u8 static_mac:1; /* static mac, no dataplane learning */
65 u8 bvi:1; /* mac is for a bridged virtual interface */
66 u8 filter:1; /* drop packets to/from this mac */
68 u8 timestamp; /* timestamp for aging */
69 u8 int_sn; /* interface seq num */
70 u8 bd_sn; /* bridge domain seq num */
74 } l2fib_entry_result_t;
76 STATIC_ASSERT_SIZEOF (l2fib_entry_result_t, 8);
79 * Compute the hash for the given key and return
80 * the corresponding bucket index
83 l2fib_compute_hash_bucket (l2fib_entry_key_t * key)
89 result = 0xa5a5a5a5; /* some seed */
90 temp_a = key->words.w0;
91 temp_b = key->words.w1;
92 hash_mix32 (temp_a, temp_b, result);
94 return result % L2FIB_NUM_BUCKETS;
98 l2fib_make_key (u8 * mac_address, u16 bd_index)
103 * The mac address in memory is A:B:C:D:E:F
104 * The bd id in register is H:L
106 #if CLIB_ARCH_IS_LITTLE_ENDIAN
108 * Create the in-register key as F:E:D:C:B:A:H:L
109 * In memory the key is L:H:A:B:C:D:E:F
111 temp = *((u64 *) (mac_address)) << 16;
112 temp = (temp & ~0xffff) | (u64) (bd_index);
115 * Create the in-register key as H:L:A:B:C:D:E:F
116 * In memory the key is H:L:A:B:C:D:E:F
118 temp = *((u64 *) (mac_address)) >> 16;
119 temp = temp | (((u64) bd_index) << 48);
128 * Lookup the entry for mac and bd_index in the mac table for 1 packet.
129 * Cached_key and cached_result are used as a one-entry cache.
130 * The function reads and updates them as needed.
132 * mac0 and bd_index0 are the keys. The entry is written to result0.
133 * If the entry was not found, result0 is set to ~0.
135 * key0 and bucket0 return with the computed key and hash bucket,
136 * convenient if the entry needs to be updated afterward.
137 * If the cached_result was used, bucket0 is set to ~0.
140 static_always_inline void
141 l2fib_lookup_1 (BVT (clib_bihash) * mac_table,
142 l2fib_entry_key_t * cached_key,
143 l2fib_entry_result_t * cached_result,
146 l2fib_entry_key_t * key0,
147 u32 * bucket0, l2fib_entry_result_t * result0)
150 key0->raw = l2fib_make_key (mac0, bd_index0);
153 if (key0->raw == cached_key->raw)
155 /* Hit in the one-entry cache */
156 result0->raw = cached_result->raw;
160 /* Do a regular mac table lookup */
161 BVT (clib_bihash_kv) kv;
165 BV (clib_bihash_search_inline) (mac_table, &kv);
166 result0->raw = kv.value;
168 /* Update one-entry cache */
169 cached_key->raw = key0->raw;
170 cached_result->raw = result0->raw;
176 * Lookup the entry for mac and bd_index in the mac table for 2 packets.
177 * The lookups for the two packets are interleaved.
179 * Cached_key and cached_result are used as a one-entry cache.
180 * The function reads and updates them as needed.
182 * mac0 and bd_index0 are the keys. The entry is written to result0.
183 * If the entry was not found, result0 is set to ~0. The same
184 * holds for mac1/bd_index1/result1.
186 static_always_inline void
187 l2fib_lookup_2 (BVT (clib_bihash) * mac_table,
188 l2fib_entry_key_t * cached_key,
189 l2fib_entry_result_t * cached_result,
194 l2fib_entry_key_t * key0,
195 l2fib_entry_key_t * key1,
198 l2fib_entry_result_t * result0,
199 l2fib_entry_result_t * result1)
202 key0->raw = l2fib_make_key (mac0, bd_index0);
203 key1->raw = l2fib_make_key (mac1, bd_index1);
205 if ((key0->raw == cached_key->raw) && (key1->raw == cached_key->raw))
207 /* Both hit in the one-entry cache */
208 result0->raw = cached_result->raw;
209 result1->raw = cached_result->raw;
216 BVT (clib_bihash_kv) kv0, kv1;
219 * Do a regular mac table lookup
220 * Interleave lookups for packet 0 and packet 1
227 BV (clib_bihash_search_inline) (mac_table, &kv0);
228 BV (clib_bihash_search_inline) (mac_table, &kv1);
230 result0->raw = kv0.value;
231 result1->raw = kv1.value;
233 /* Update one-entry cache */
234 cached_key->raw = key1->raw;
235 cached_result->raw = result1->raw;
239 static_always_inline void
240 l2fib_lookup_4 (BVT (clib_bihash) * mac_table,
241 l2fib_entry_key_t * cached_key,
242 l2fib_entry_result_t * cached_result,
251 l2fib_entry_key_t * key0,
252 l2fib_entry_key_t * key1,
253 l2fib_entry_key_t * key2,
254 l2fib_entry_key_t * key3,
259 l2fib_entry_result_t * result0,
260 l2fib_entry_result_t * result1,
261 l2fib_entry_result_t * result2,
262 l2fib_entry_result_t * result3)
265 key0->raw = l2fib_make_key (mac0, bd_index0);
266 key1->raw = l2fib_make_key (mac1, bd_index1);
267 key2->raw = l2fib_make_key (mac2, bd_index2);
268 key3->raw = l2fib_make_key (mac3, bd_index3);
270 if ((key0->raw == cached_key->raw) && (key1->raw == cached_key->raw) &&
271 (key2->raw == cached_key->raw) && (key3->raw == cached_key->raw))
273 /* Both hit in the one-entry cache */
274 result0->raw = cached_result->raw;
275 result1->raw = cached_result->raw;
276 result2->raw = cached_result->raw;
277 result3->raw = cached_result->raw;
286 BVT (clib_bihash_kv) kv0, kv1, kv2, kv3;
289 * Do a regular mac table lookup
290 * Interleave lookups for packet 0 and packet 1
301 BV (clib_bihash_search_inline) (mac_table, &kv0);
302 BV (clib_bihash_search_inline) (mac_table, &kv1);
303 BV (clib_bihash_search_inline) (mac_table, &kv2);
304 BV (clib_bihash_search_inline) (mac_table, &kv3);
306 result0->raw = kv0.value;
307 result1->raw = kv1.value;
308 result2->raw = kv2.value;
309 result3->raw = kv3.value;
311 /* Update one-entry cache */
312 cached_key->raw = key1->raw;
313 cached_result->raw = result1->raw;
317 void l2fib_clear_table (uint keep_static);
320 l2fib_add_entry (u64 mac,
322 u32 sw_if_index, u32 static_mac, u32 drop_mac, u32 bvi_mac);
324 u32 l2fib_del_entry (u64 mac, u32 bd_index);
326 void l2fib_start_ager_scan (vlib_main_t * vm);
328 void l2fib_flush_int_mac (vlib_main_t * vm, u32 sw_if_index);
330 void l2fib_flush_bd_mac (vlib_main_t * vm, u32 bd_index);
333 l2fib_table_dump (u32 bd_index, l2fib_entry_key_t ** l2fe_key,
334 l2fib_entry_result_t ** l2fe_res);
336 u8 *format_vnet_sw_if_index_name_with_NA (u8 * s, va_list * args);
338 BVT (clib_bihash) * get_mac_table (void);
343 * fd.io coding-style-patch-verification: ON
346 * eval: (c-set-style "gnu")