FD.io VPP  v20.09-64-g4f7b92f0a
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 event 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  * Flags associated with an L2 Fib Entry
107  * - static mac, no MAC move
108  * - not subject to age
109  * - mac is for a bridged virtual interface
110  * - drop packets to/from this mac
111  * - MAC learned to be sent in L2 MAC event
112  * -MAC learned is a MAC move
113  */
114 #define foreach_l2fib_entry_result_attr \
115  _(STATIC, 0, "static") \
116  _(AGE_NOT, 1, "age-not") \
117  _(BVI, 2, "bvi") \
118  _(FILTER, 3, "filter") \
119  _(LRN_EVT, 4, "learn-event") \
120  _(LRN_MOV, 5, "learn-move")
121 
123 {
125 #define _(a,v,s) L2FIB_ENTRY_RESULT_FLAG_##a = (1 << v),
127 #undef _
128 } __attribute__ ((packed)) l2fib_entry_result_flags_t;
129 
130 STATIC_ASSERT_SIZEOF (l2fib_entry_result_flags_t, 1);
131 
132 extern u8 *format_l2fib_entry_result_flags (u8 * s, va_list * args);
133 
134 /*
135  * The l2fib entry results
136  */
137 typedef struct l2fib_entry_result_t_
138 {
139  union
140  {
141  struct
142  {
143  u32 sw_if_index; /* output sw_if_index (L3 intf if bvi==1) */
144  l2fib_entry_result_flags_t flags;
145 
146  u8 timestamp; /* timestamp for aging */
147  l2fib_seq_num_t sn; /* bd/int seq num */
148  } fields;
150  };
152 
154 
155 #define _(a,v,s) \
156  always_inline int \
157  l2fib_entry_result_is_set_##a (const l2fib_entry_result_t *r) { \
158  return (r->fields.flags & L2FIB_ENTRY_RESULT_FLAG_##a); \
159  }
161 #undef _
162 #define _(a,v,s) \
163  always_inline void \
164  l2fib_entry_result_set_##a (l2fib_entry_result_t *r) { \
165  r->fields.flags |= L2FIB_ENTRY_RESULT_FLAG_##a; \
166  }
168 #undef _
169 #define _(a,v,s) \
170  always_inline void \
171  l2fib_entry_result_clear_##a (l2fib_entry_result_t *r) { \
172  r->fields.flags &= ~L2FIB_ENTRY_RESULT_FLAG_##a; \
173  }
175 #undef _
176  static inline void
178  l2fib_entry_result_flags_t bits)
179 {
180  r->fields.flags |= bits;
181 }
182 
183 static inline void
185  l2fib_entry_result_flags_t bits)
186 {
187  r->fields.flags &= ~bits;
188 }
189 
190 /* L2 MAC event entry action enums (see mac_entry definition in l2.api) */
191 typedef enum
192 {
197 
198 /**
199  * Compute the hash for the given key and return
200  * the corresponding bucket index
201  */
204 {
205  u32 result;
206  u32 temp_a;
207  u32 temp_b;
208 
209  result = 0xa5a5a5a5; /* some seed */
210  temp_a = key->words.w0;
211  temp_b = key->words.w1;
212  hash_mix32 (temp_a, temp_b, result);
213 
214  return result % L2FIB_NUM_BUCKETS;
215 }
216 
218 l2fib_make_key (const u8 * mac_address, u16 bd_index)
219 {
220  u64 temp;
221 
222  /*
223  * The mac address in memory is A:B:C:D:E:F
224  * The bd id in register is H:L
225  */
226 #if CLIB_ARCH_IS_LITTLE_ENDIAN
227  /*
228  * Create the in-register key as F:E:D:C:B:A:H:L
229  * In memory the key is L:H:A:B:C:D:E:F
230  */
231  temp = CLIB_MEM_OVERFLOW_LOAD (*, (u64 *) mac_address) << 16;
232  temp = (temp & ~0xffff) | (u64) (bd_index);
233 #else
234  /*
235  * Create the in-register key as H:L:A:B:C:D:E:F
236  * In memory the key is H:L:A:B:C:D:E:F
237  */
238  temp = CLIB_MEM_OVERFLOW_LOAD (*, (u64 *) mac_address) >> 16;
239  temp = temp | (((u64) bd_index) << 48);
240 #endif
241 
242  return temp;
243 }
244 
245 
246 
247 /**
248  * Lookup the entry for mac and bd_index in the mac table for 1 packet.
249  * Cached_key and cached_result are used as a one-entry cache.
250  * The function reads and updates them as needed.
251  *
252  * mac0 and bd_index0 are the keys. The entry is written to result0.
253  * If the entry was not found, result0 is set to ~0.
254  *
255  * key0 return with the computed key, convenient if the entry needs,
256  * to be updated afterward.
257  */
258 
260 l2fib_lookup_1 (BVT (clib_bihash) * mac_table,
261  l2fib_entry_key_t * cached_key,
262  l2fib_entry_result_t * cached_result,
263  u8 * mac0,
264  u16 bd_index0,
265  l2fib_entry_key_t * key0, l2fib_entry_result_t * result0)
266 {
267  /* set up key */
268  key0->raw = l2fib_make_key (mac0, bd_index0);
269 
270  if (key0->raw == cached_key->raw)
271  {
272  /* Hit in the one-entry cache */
273  result0->raw = cached_result->raw;
274  }
275  else
276  {
277  /* Do a regular mac table lookup */
278  BVT (clib_bihash_kv) kv;
279 
280  kv.key = key0->raw;
281  kv.value = ~0ULL;
282  BV (clib_bihash_search_inline) (mac_table, &kv);
283  result0->raw = kv.value;
284 
285  /* Update one-entry cache */
286  cached_key->raw = key0->raw;
287  cached_result->raw = result0->raw;
288  }
289 }
290 
291 
292 /**
293  * Lookup the entry for mac and bd_index in the mac table for 2 packets.
294  * The lookups for the two packets are interleaved.
295  *
296  * Cached_key and cached_result are used as a one-entry cache.
297  * The function reads and updates them as needed.
298  *
299  * mac0 and bd_index0 are the keys. The entry is written to result0.
300  * If the entry was not found, result0 is set to ~0. The same
301  * holds for mac1/bd_index1/result1.
302  */
304 l2fib_lookup_2 (BVT (clib_bihash) * mac_table,
305  l2fib_entry_key_t * cached_key,
306  l2fib_entry_result_t * cached_result,
307  u8 * mac0,
308  u8 * mac1,
309  u16 bd_index0,
310  u16 bd_index1,
311  l2fib_entry_key_t * key0,
312  l2fib_entry_key_t * key1,
313  l2fib_entry_result_t * result0,
314  l2fib_entry_result_t * result1)
315 {
316  /* set up key */
317  key0->raw = l2fib_make_key (mac0, bd_index0);
318  key1->raw = l2fib_make_key (mac1, bd_index1);
319 
320  if ((key0->raw == cached_key->raw) && (key1->raw == cached_key->raw))
321  {
322  /* Both hit in the one-entry cache */
323  result0->raw = cached_result->raw;
324  result1->raw = cached_result->raw;
325  }
326  else
327  {
328  BVT (clib_bihash_kv) kv0, kv1;
329 
330  /*
331  * Do a regular mac table lookup
332  * Interleave lookups for packet 0 and packet 1
333  */
334  kv0.key = key0->raw;
335  kv1.key = key1->raw;
336  kv0.value = ~0ULL;
337  kv1.value = ~0ULL;
338 
339  BV (clib_bihash_search_inline) (mac_table, &kv0);
340  BV (clib_bihash_search_inline) (mac_table, &kv1);
341 
342  result0->raw = kv0.value;
343  result1->raw = kv1.value;
344 
345  /* Update one-entry cache */
346  cached_key->raw = key1->raw;
347  cached_result->raw = result1->raw;
348  }
349 }
350 
352 l2fib_lookup_4 (BVT (clib_bihash) * mac_table,
353  l2fib_entry_key_t * cached_key,
354  l2fib_entry_result_t * cached_result,
355  const u8 * mac0,
356  const u8 * mac1,
357  const u8 * mac2,
358  const u8 * mac3,
359  u16 bd_index0,
360  u16 bd_index1,
361  u16 bd_index2,
362  u16 bd_index3,
363  l2fib_entry_key_t * key0,
364  l2fib_entry_key_t * key1,
365  l2fib_entry_key_t * key2,
366  l2fib_entry_key_t * key3,
367  l2fib_entry_result_t * result0,
368  l2fib_entry_result_t * result1,
369  l2fib_entry_result_t * result2,
370  l2fib_entry_result_t * result3)
371 {
372  /* set up key */
373  key0->raw = l2fib_make_key (mac0, bd_index0);
374  key1->raw = l2fib_make_key (mac1, bd_index1);
375  key2->raw = l2fib_make_key (mac2, bd_index2);
376  key3->raw = l2fib_make_key (mac3, bd_index3);
377 
378  if ((key0->raw == cached_key->raw) && (key1->raw == cached_key->raw) &&
379  (key2->raw == cached_key->raw) && (key3->raw == cached_key->raw))
380  {
381  /* Both hit in the one-entry cache */
382  result0->raw = cached_result->raw;
383  result1->raw = cached_result->raw;
384  result2->raw = cached_result->raw;
385  result3->raw = cached_result->raw;
386  }
387  else
388  {
389  BVT (clib_bihash_kv) kv0, kv1, kv2, kv3;
390 
391  /*
392  * Do a regular mac table lookup
393  * Interleave lookups for packet 0 and packet 1
394  */
395  kv0.key = key0->raw;
396  kv1.key = key1->raw;
397  kv2.key = key2->raw;
398  kv3.key = key3->raw;
399  kv0.value = ~0ULL;
400  kv1.value = ~0ULL;
401  kv2.value = ~0ULL;
402  kv3.value = ~0ULL;
403 
404  BV (clib_bihash_search_inline) (mac_table, &kv0);
405  BV (clib_bihash_search_inline) (mac_table, &kv1);
406  BV (clib_bihash_search_inline) (mac_table, &kv2);
407  BV (clib_bihash_search_inline) (mac_table, &kv3);
408 
409  result0->raw = kv0.value;
410  result1->raw = kv1.value;
411  result2->raw = kv2.value;
412  result3->raw = kv3.value;
413 
414  /* Update one-entry cache */
415  cached_key->raw = key1->raw;
416  cached_result->raw = result1->raw;
417  }
418 }
419 
420 void l2fib_clear_table (void);
421 
422 void
423 l2fib_add_entry (const u8 * mac,
424  u32 bd_index,
425  u32 sw_if_index, l2fib_entry_result_flags_t flags);
426 
427 static inline void
428 l2fib_add_filter_entry (const u8 * mac, u32 bd_index)
429 {
430  l2fib_add_entry (mac, bd_index, ~0,
431  (L2FIB_ENTRY_RESULT_FLAG_FILTER |
432  L2FIB_ENTRY_RESULT_FLAG_STATIC));
433 }
434 
435 u32 l2fib_del_entry (const u8 * mac, u32 bd_index, u32 sw_if_index);
436 
438 
439 void l2fib_flush_int_mac (vlib_main_t * vm, u32 sw_if_index);
440 
441 void l2fib_flush_bd_mac (vlib_main_t * vm, u32 bd_index);
442 
443 void l2fib_flush_all_mac (vlib_main_t * vm);
444 
445 void
446 l2fib_table_dump (u32 bd_index, l2fib_entry_key_t ** l2fe_key,
447  l2fib_entry_result_t ** l2fe_res);
448 
449 u8 *format_vnet_sw_if_index_name_with_NA (u8 * s, va_list * args);
450 
452 l2fib_swif_seq_num (u32 sw_if_index)
453 {
454  l2fib_main_t *mp = &l2fib_main;
455  return vec_elt_at_index (mp->swif_seq_num, sw_if_index);
456 }
457 
460 {
461  l2fib_main_t *mp = &l2fib_main;
462  vec_validate (mp->swif_seq_num, sw_if_index);
463  return l2fib_swif_seq_num (sw_if_index);
464 }
465 
466 BVT (clib_bihash) * get_mac_table (void);
467 
468 #endif
469 
470 /*
471  * fd.io coding-style-patch-verification: ON
472  *
473  * Local Variables:
474  * eval: (c-set-style "gnu")
475  * End:
476  */
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:509
f64 evt_scan_duration
Definition: l2_fib.h:52
vlib_main_t * vlib_main
Definition: l2_fib.h:62
struct l2fib_entry_key_t::@450::@453 words
vnet_main_t * vnet_main
Definition: l2_fib.h:63
unsigned long u64
Definition: types.h:89
u64 raw
Definition: l2_fib.h:149
u32 w1
Definition: l2_fib.h:83
l2fib_entry_result_flags_t flags
Definition: l2_fib.h:144
static_always_inline u8 * l2fib_swif_seq_num(u32 sw_if_index)
Definition: l2_fib.h:452
u32 max_macs_in_event
Definition: l2_fib.h:59
enum l2fib_entry_result_flags_t_ l2fib_entry_result_flags_t
unsigned char u8
Definition: types.h:56
double f64
Definition: types.h:142
Definition: l2_fib.h:137
u32 w0
Definition: l2_fib.h:82
#define static_always_inline
Definition: clib.h:108
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, l2fib_entry_result_t *result0)
Lookup the entry for mac and bd_index in the mac table for 1 packet.
Definition: l2_fib.h:260
static void l2fib_entry_result_clear_bits(l2fib_entry_result_t *r, l2fib_entry_result_flags_t bits)
Definition: l2_fib.h:184
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
void l2fib_flush_all_mac(vlib_main_t *vm)
Flush all non static MACs - flushes all valid BDs.
Definition: l2_fib.c:830
unsigned int u32
Definition: types.h:88
struct l2fib_entry_result_t_ l2fib_entry_result_t
u32 sw_if_index
Definition: l2_fib.h:143
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:459
unsigned short u16
Definition: types.h:57
u8 * format_l2fib_entry_result_flags(u8 *s, va_list *args)
Definition: l2_fib.c:58
void l2fib_add_entry(const u8 *mac, u32 bd_index, u32 sw_if_index, l2fib_entry_result_flags_t flags)
Add an entry to the l2fib.
Definition: l2_fib.c:405
#define always_inline
Definition: ipsec.h:28
BVT(clib_bihash) *get_mac_table(void)
Definition: l2_fib.c:972
static_always_inline void l2fib_lookup_4(BVT(clib_bihash) *mac_table, l2fib_entry_key_t *cached_key, l2fib_entry_result_t *cached_result, const u8 *mac0, const u8 *mac1, const u8 *mac2, const 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, l2fib_entry_result_t *result0, l2fib_entry_result_t *result1, l2fib_entry_result_t *result2, l2fib_entry_result_t *result3)
Definition: l2_fib.h:352
STATIC_ASSERT_SIZEOF(l2fib_entry_key_t, 8)
int clib_bihash_search_inline(clib_bihash *h, clib_bihash_kv *in_out_kv)
Search a bi-hash table.
#define L2FIB_NUM_BUCKETS
Definition: l2_fib.h:27
l2fib_seq_num_t sn
Definition: l2_fib.h:147
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, 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:304
struct l2fib_entry_result_t_::@458::@460 fields
l2fib_entry_result_flags_t_
Definition: l2_fib.h:122
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:819
#define hash_mix32(a0, b0, c0)
Definition: hash.h:539
static u64 l2fib_make_key(const u8 *mac_address, u16 bd_index)
Definition: l2_fib.h:218
u8 timestamp
Definition: l2_fib.h:146
void l2fib_clear_table(void)
Definition: l2_fib.c:347
Definition: l2_fib.h:71
void l2fib_table_dump(u32 bd_index, l2fib_entry_key_t **l2fe_key, l2fib_entry_result_t **l2fe_res)
Definition: l2_fib.c:134
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:809
typedef key
Definition: ipsec_types.api:85
#define foreach_l2fib_entry_result_attr
Flags associated with an L2 Fib Entry.
Definition: l2_fib.h:114
u32 l2fib_del_entry(const u8 *mac, u32 bd_index, u32 sw_if_index)
Delete an entry from the l2fib.
Definition: l2_fib.c:689
l2_mac_event_action_t
Definition: l2_fib.h:191
u8 * format_vnet_sw_if_index_name_with_NA(u8 *s, va_list *args)
Format sw_if_index.
Definition: l2_fib.c:91
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:203
u16 bd_index
Definition: l2_fib.h:77
static void l2fib_add_filter_entry(const u8 *mac, u32 bd_index)
Definition: l2_fib.h:428
static foreach_l2fib_entry_result_attr void l2fib_entry_result_set_bits(l2fib_entry_result_t *r, l2fib_entry_result_flags_t bits)
Definition: l2_fib.h:177
#define CLIB_MEM_OVERFLOW_LOAD(f, src)
Definition: sanitizer.h:49
manual_print typedef u8 mac_address[6]
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:786