FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
l2_fib.h
Go to the documentation of this file.
1 /*
2  * l2_fib.h : layer 2 forwarding table (aka mac table)
3  *
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:
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
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.
16  */
17 
18 #ifndef included_l2fib_h
19 #define included_l2fib_h
20 
21 #include <vlib/vlib.h>
22 #include <vppinfra/bihash_8_8.h>
23 
24 /*
25  * The size of the hash table
26  */
27 #define L2FIB_NUM_BUCKETS (64 * 1024)
28 #define L2FIB_MEMORY_SIZE (512<<20)
29 
30 /* Ager scan interval is 1 minute for aging */
31 #define L2FIB_AGE_SCAN_INTERVAL (60.0)
32 
33 /* MAC event scan delay is 100 msec unless specified by MAC event client */
34 #define L2FIB_EVENT_SCAN_DELAY_DEFAULT (0.1)
35 
36 /* Max MACs in a event message is 100 unless specified by MAC event client */
37 #define L2FIB_EVENT_MAX_MACS_DEFAULT (100)
38 
39 /* MAC event learn limit is 1000 unless specified by MAC event client */
40 #define L2FIB_EVENT_LEARN_LIMIT_DEFAULT (1000)
41 
42 typedef struct
43 {
44 
45  /* hash table */
46  BVT (clib_bihash) mac_table;
47 
48  /* per swif vector of sequence number for interface based flush of MACs */
50 
51  /* last event or ager scan duration */
54 
55  /* delay between event scans, default to 100 msec */
57 
58  /* max macs in evet message, default to 100 entries */
60 
61  /* convenience variables */
64 } l2fib_main_t;
65 
67 
68 /*
69  * The L2fib key is the mac address and bridge domain ID
70  */
71 typedef struct
72 {
73  union
74  {
75  struct
76  {
78  u8 mac[6];
79  } fields;
80  struct
81  {
84  } words;
86  };
88 
90 
91 
92 typedef struct
93 {
94  union
95  {
96  struct
97  {
99  u8 bd;
100  };
102  };
104 
105 /*
106  * The l2fib entry results
107  */
108 typedef struct
109 {
110  union
111  {
112  struct
113  {
114  u32 sw_if_index; /* output sw_if_index (L3 intf if bvi==1) */
115 
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 */
121  u8 unused:3;
122 
123  u8 timestamp; /* timestamp for aging */
124  l2fib_seq_num_t sn; /* bd/int seq num */
125  } fields;
127  };
129 
131 
132 /**
133  * Compute the hash for the given key and return
134  * the corresponding bucket index
135  */
138 {
139  u32 result;
140  u32 temp_a;
141  u32 temp_b;
142 
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);
147 
148  return result % L2FIB_NUM_BUCKETS;
149 }
150 
151 /**
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.
155  */
156 always_inline u64 __attribute__ ((no_sanitize_address))
157 l2fib_make_key (u8 * mac_address, u16 bd_index)
158 {
159  u64 temp;
160 
161  /*
162  * The mac address in memory is A:B:C:D:E:F
163  * The bd id in register is H:L
164  */
165 #if CLIB_ARCH_IS_LITTLE_ENDIAN
166  /*
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
169  */
170  temp = *((u64 *) (mac_address)) << 16;
171  temp = (temp & ~0xffff) | (u64) (bd_index);
172 #else
173  /*
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
176  */
177  temp = *((u64 *) (mac_address)) >> 16;
178  temp = temp | (((u64) bd_index) << 48);
179 #endif
180 
181  return temp;
182 }
183 
184 
185 
186 /**
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.
190  *
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.
193  *
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.
197  */
198 
200 l2fib_lookup_1 (BVT (clib_bihash) * mac_table,
201  l2fib_entry_key_t * cached_key,
202  l2fib_entry_result_t * cached_result,
203  u8 * mac0,
204  u16 bd_index0,
205  l2fib_entry_key_t * key0,
206  u32 * bucket0, l2fib_entry_result_t * result0)
207 {
208  /* set up key */
209  key0->raw = l2fib_make_key (mac0, bd_index0);
210  *bucket0 = ~0;
211 
212  if (key0->raw == cached_key->raw)
213  {
214  /* Hit in the one-entry cache */
215  result0->raw = cached_result->raw;
216  }
217  else
218  {
219  /* Do a regular mac table lookup */
220  BVT (clib_bihash_kv) kv;
221 
222  kv.key = key0->raw;
223  kv.value = ~0ULL;
224  BV (clib_bihash_search_inline) (mac_table, &kv);
225  result0->raw = kv.value;
226 
227  /* Update one-entry cache */
228  cached_key->raw = key0->raw;
229  cached_result->raw = result0->raw;
230  }
231 }
232 
233 
234 /**
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.
237  *
238  * Cached_key and cached_result are used as a one-entry cache.
239  * The function reads and updates them as needed.
240  *
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.
244  */
246 l2fib_lookup_2 (BVT (clib_bihash) * mac_table,
247  l2fib_entry_key_t * cached_key,
248  l2fib_entry_result_t * cached_result,
249  u8 * mac0,
250  u8 * mac1,
251  u16 bd_index0,
252  u16 bd_index1,
253  l2fib_entry_key_t * key0,
254  l2fib_entry_key_t * key1,
255  u32 * bucket0,
256  u32 * bucket1,
257  l2fib_entry_result_t * result0,
258  l2fib_entry_result_t * result1)
259 {
260  /* set up key */
261  key0->raw = l2fib_make_key (mac0, bd_index0);
262  key1->raw = l2fib_make_key (mac1, bd_index1);
263 
264  if ((key0->raw == cached_key->raw) && (key1->raw == cached_key->raw))
265  {
266  /* Both hit in the one-entry cache */
267  result0->raw = cached_result->raw;
268  result1->raw = cached_result->raw;
269  *bucket0 = ~0;
270  *bucket1 = ~0;
271 
272  }
273  else
274  {
275  BVT (clib_bihash_kv) kv0, kv1;
276 
277  /*
278  * Do a regular mac table lookup
279  * Interleave lookups for packet 0 and packet 1
280  */
281  kv0.key = key0->raw;
282  kv1.key = key1->raw;
283  kv0.value = ~0ULL;
284  kv1.value = ~0ULL;
285 
286  BV (clib_bihash_search_inline) (mac_table, &kv0);
287  BV (clib_bihash_search_inline) (mac_table, &kv1);
288 
289  result0->raw = kv0.value;
290  result1->raw = kv1.value;
291 
292  /* Update one-entry cache */
293  cached_key->raw = key1->raw;
294  cached_result->raw = result1->raw;
295  }
296 }
297 
299 l2fib_lookup_4 (BVT (clib_bihash) * mac_table,
300  l2fib_entry_key_t * cached_key,
301  l2fib_entry_result_t * cached_result,
302  u8 * mac0,
303  u8 * mac1,
304  u8 * mac2,
305  u8 * mac3,
306  u16 bd_index0,
307  u16 bd_index1,
308  u16 bd_index2,
309  u16 bd_index3,
310  l2fib_entry_key_t * key0,
311  l2fib_entry_key_t * key1,
312  l2fib_entry_key_t * key2,
313  l2fib_entry_key_t * key3,
314  u32 * bucket0,
315  u32 * bucket1,
316  u32 * bucket2,
317  u32 * bucket3,
318  l2fib_entry_result_t * result0,
319  l2fib_entry_result_t * result1,
320  l2fib_entry_result_t * result2,
321  l2fib_entry_result_t * result3)
322 {
323  /* set up key */
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);
328 
329  if ((key0->raw == cached_key->raw) && (key1->raw == cached_key->raw) &&
330  (key2->raw == cached_key->raw) && (key3->raw == cached_key->raw))
331  {
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;
337  *bucket0 = ~0;
338  *bucket1 = ~0;
339  *bucket2 = ~0;
340  *bucket3 = ~0;
341 
342  }
343  else
344  {
345  BVT (clib_bihash_kv) kv0, kv1, kv2, kv3;
346 
347  /*
348  * Do a regular mac table lookup
349  * Interleave lookups for packet 0 and packet 1
350  */
351  kv0.key = key0->raw;
352  kv1.key = key1->raw;
353  kv2.key = key2->raw;
354  kv3.key = key3->raw;
355  kv0.value = ~0ULL;
356  kv1.value = ~0ULL;
357  kv2.value = ~0ULL;
358  kv3.value = ~0ULL;
359 
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);
364 
365  result0->raw = kv0.value;
366  result1->raw = kv1.value;
367  result2->raw = kv2.value;
368  result3->raw = kv3.value;
369 
370  /* Update one-entry cache */
371  cached_key->raw = key1->raw;
372  cached_result->raw = result1->raw;
373  }
374 }
375 
376 void l2fib_clear_table (void);
377 
378 void
379 l2fib_add_entry (u8 * mac,
380  u32 bd_index,
381  u32 sw_if_index, u8 static_mac, u8 drop_mac, u8 bvi_mac);
382 
383 static inline void
384 l2fib_add_fwd_entry (u8 * mac, u32 bd_index, u32 sw_if_index, u8 static_mac,
385  u8 bvi_mac)
386 {
387  l2fib_add_entry (mac, bd_index, sw_if_index, static_mac, 0, bvi_mac);
388 }
389 
390 static inline void
391 l2fib_add_filter_entry (u8 * mac, u32 bd_index)
392 {
393  l2fib_add_entry (mac, bd_index, ~0, 1, 1, 0);
394 }
395 
396 u32 l2fib_del_entry (u8 * mac, u32 bd_index);
397 
399 
400 void l2fib_flush_int_mac (vlib_main_t * vm, u32 sw_if_index);
401 
402 void l2fib_flush_bd_mac (vlib_main_t * vm, u32 bd_index);
403 
404 void l2fib_flush_all_mac (vlib_main_t * vm);
405 
406 void
407 l2fib_table_dump (u32 bd_index, l2fib_entry_key_t ** l2fe_key,
408  l2fib_entry_result_t ** l2fe_res);
409 
410 u8 *format_vnet_sw_if_index_name_with_NA (u8 * s, va_list * args);
411 
413 l2fib_swif_seq_num (u32 sw_if_index)
414 {
415  l2fib_main_t *mp = &l2fib_main;
416  return vec_elt_at_index (mp->swif_seq_num, sw_if_index);
417 }
418 
421 {
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);
425 }
426 
427 BVT (clib_bihash) * get_mac_table (void);
428 
429 #endif
430 
431 /*
432  * fd.io coding-style-patch-verification: ON
433  *
434  * Local Variables:
435  * eval: (c-set-style "gnu")
436  * End:
437  */
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:432
f64 evt_scan_duration
Definition: l2_fib.h:52
vlib_main_t * vlib_main
Definition: l2_fib.h:62
vnet_main_t * vnet_main
Definition: l2_fib.h:63
u32 w1
Definition: l2_fib.h:83
static_always_inline u8 * l2fib_swif_seq_num(u32 sw_if_index)
Definition: l2_fib.h:413
u32 max_macs_in_event
Definition: l2_fib.h:59
Definition: l2_fib.h:108
u32 w0
Definition: l2_fib.h:82
#define static_always_inline
Definition: clib.h:93
#define always_inline
Definition: clib.h:92
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
unsigned long u64
Definition: types.h:89
void l2fib_flush_all_mac(vlib_main_t *vm)
Flush all non static MACs - flushes all valid BDs.
Definition: l2_fib.c:789
void l2fib_add_entry(u8 *mac, u32 bd_index, u32 sw_if_index, u8 static_mac, u8 drop_mac, u8 bvi_mac)
Add an entry to the l2fib.
Definition: l2_fib.c:356
struct l2fib_entry_key_t::@206::@209 words
f64 event_scan_delay
Definition: l2_fib.h:56
static_always_inline u8 * l2fib_valid_swif_seq_num(u32 sw_if_index)
Definition: l2_fib.h:420
BVT(clib_bihash)*get_mac_table(void)
Definition: l2_fib.c:931
STATIC_ASSERT_SIZEOF(l2fib_entry_key_t, 8)
#define L2FIB_NUM_BUCKETS
Definition: l2_fib.h:27
static void l2fib_add_fwd_entry(u8 *mac, u32 bd_index, u32 sw_if_index, u8 static_mac, u8 bvi_mac)
Definition: l2_fib.h:384
u64 raw
Definition: l2_fib.h:126
u32 sw_if_index
Definition: l2_fib.h:114
vlib_main_t * vm
Definition: buffer.c:283
l2fib_seq_num_t sn
Definition: l2_fib.h:124
u8 * swif_seq_num
Definition: l2_fib.h:49
f64 age_scan_duration
Definition: l2_fib.h:53
void l2fib_flush_bd_mac(vlib_main_t *vm, u32 bd_index)
Flush all non static MACs in a bridge domain.
Definition: l2_fib.c:778
#define hash_mix32(a0, b0, c0)
Definition: hash.h:538
u32 l2fib_del_entry(u8 *mac, u32 bd_index)
Delete an entry from the l2fib.
Definition: l2_fib.c:671
static_always_inline void l2fib_lookup_2(BVT(clib_bihash)*mac_table, l2fib_entry_key_t *cached_key, l2fib_entry_result_t *cached_result, u8 *mac0, u8 *mac1, u16 bd_index0, u16 bd_index1, l2fib_entry_key_t *key0, l2fib_entry_key_t *key1, u32 *bucket0, u32 *bucket1, l2fib_entry_result_t *result0, l2fib_entry_result_t *result1)
Lookup the entry for mac and bd_index in the mac table for 2 packets.
Definition: l2_fib.h:246
void l2fib_clear_table(void)
Definition: l2_fib.c:298
unsigned int u32
Definition: types.h:88
Definition: l2_fib.h:71
static void l2fib_add_filter_entry(u8 *mac, u32 bd_index)
Definition: l2_fib.h:391
void l2fib_table_dump(u32 bd_index, l2fib_entry_key_t **l2fe_key, l2fib_entry_result_t **l2fe_res)
Definition: l2_fib.c:86
void l2fib_flush_int_mac(vlib_main_t *vm, u32 sw_if_index)
Flush all non static MACs from an interface.
Definition: l2_fib.c:768
u8 timestamp
Definition: l2_fib.h:123
unsigned short u16
Definition: types.h:57
double f64
Definition: types.h:142
unsigned char u8
Definition: types.h:56
u8 * format_vnet_sw_if_index_name_with_NA(u8 *s, va_list *args)
Format sw_if_index.
Definition: l2_fib.c:70
static u32 l2fib_compute_hash_bucket(l2fib_entry_key_t *key)
Compute the hash for the given key and return the corresponding bucket index.
Definition: l2_fib.h:137
static u64 l2fib_make_key(u8 *mac_address, u16 bd_index)
make address sanitizer skip this: The 6-Bytes mac-address is cast into an 8-Bytes u64...
Definition: l2_fib.h:157
u16 bd_index
Definition: l2_fib.h:77
static_always_inline void l2fib_lookup_4(BVT(clib_bihash)*mac_table, l2fib_entry_key_t *cached_key, l2fib_entry_result_t *cached_result, u8 *mac0, u8 *mac1, u8 *mac2, u8 *mac3, u16 bd_index0, u16 bd_index1, u16 bd_index2, u16 bd_index3, l2fib_entry_key_t *key0, l2fib_entry_key_t *key1, l2fib_entry_key_t *key2, l2fib_entry_key_t *key3, u32 *bucket0, u32 *bucket1, u32 *bucket2, u32 *bucket3, l2fib_entry_result_t *result0, l2fib_entry_result_t *result1, l2fib_entry_result_t *result2, l2fib_entry_result_t *result3)
Definition: l2_fib.h:299
static_always_inline void l2fib_lookup_1(BVT(clib_bihash)*mac_table, l2fib_entry_key_t *cached_key, l2fib_entry_result_t *cached_result, u8 *mac0, u16 bd_index0, l2fib_entry_key_t *key0, u32 *bucket0, l2fib_entry_result_t *result0)
Lookup the entry for mac and bd_index in the mac table for 1 packet.
Definition: l2_fib.h:200
l2fib_main_t l2fib_main
Definition: l2_fib.c:55
u64 raw
Definition: l2_fib.h:85
void l2fib_start_ager_scan(vlib_main_t *vm)
Kick off ager to scan MACs to age/delete MAC entries.
Definition: l2_fib.c:745