FD.io VPP  v17.01-9-ge7dcee4
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 (256<<20)
29 
30 /*
31  * The L2fib key is the mac address and bridge domain ID
32  */
33 typedef struct
34 {
35  union
36  {
37  struct
38  {
40  u8 mac[6];
41  } fields;
42  struct
43  {
46  } words;
48  };
50 
52 
53 /*
54  * The l2fib entry results
55  */
56 typedef struct
57 {
58  union
59  {
60  struct
61  {
62  u32 sw_if_index; /* output sw_if_index (L3 interface if bvi==1) */
63 
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 */
67  u8 unused1:5;
68  u8 timestamp; /* timestamp for aging */
70  } fields;
72  };
74 
76 
77 /**
78  * Compute the hash for the given key and return
79  * the corresponding bucket index
80  */
83 {
84  u32 result;
85  u32 temp_a;
86  u32 temp_b;
87 
88  result = 0xa5a5a5a5; /* some seed */
89  temp_a = key->words.w0;
90  temp_b = key->words.w1;
91  hash_mix32 (temp_a, temp_b, result);
92 
93  return result % L2FIB_NUM_BUCKETS;
94 }
95 
97 l2fib_make_key (u8 * mac_address, u16 bd_index)
98 {
99  u64 temp;
100 
101  /*
102  * The mac address in memory is A:B:C:D:E:F
103  * The bd id in register is H:L
104  */
105 #if CLIB_ARCH_IS_LITTLE_ENDIAN
106  /*
107  * Create the in-register key as F:E:D:C:B:A:H:L
108  * In memory the key is L:H:A:B:C:D:E:F
109  */
110  temp = *((u64 *) (mac_address)) << 16;
111  temp = (temp & ~0xffff) | (u64) (bd_index);
112 #else
113  /*
114  * Create the in-register key as H:L:A:B:C:D:E:F
115  * In memory the key is H:L:A:B:C:D:E:F
116  */
117  temp = *((u64 *) (mac_address)) >> 16;
118  temp = temp | (((u64) bd_index) << 48);
119 #endif
120 
121  return temp;
122 }
123 
124 
125 
126 /**
127  * Lookup the entry for mac and bd_index in the mac table for 1 packet.
128  * Cached_key and cached_result are used as a one-entry cache.
129  * The function reads and updates them as needed.
130  *
131  * mac0 and bd_index0 are the keys. The entry is written to result0.
132  * If the entry was not found, result0 is set to ~0.
133  *
134  * key0 and bucket0 return with the computed key and hash bucket,
135  * convenient if the entry needs to be updated afterward.
136  * If the cached_result was used, bucket0 is set to ~0.
137  */
138 
140 l2fib_lookup_1 (BVT (clib_bihash) * mac_table,
141  l2fib_entry_key_t * cached_key,
142  l2fib_entry_result_t * cached_result,
143  u8 * mac0,
144  u16 bd_index0,
145  l2fib_entry_key_t * key0,
146  u32 * bucket0, l2fib_entry_result_t * result0)
147 {
148  /* set up key */
149  key0->raw = l2fib_make_key (mac0, bd_index0);
150  *bucket0 = ~0;
151 
152  if (key0->raw == cached_key->raw)
153  {
154  /* Hit in the one-entry cache */
155  result0->raw = cached_result->raw;
156  }
157  else
158  {
159  /* Do a regular mac table lookup */
160  BVT (clib_bihash_kv) kv;
161 
162  kv.key = key0->raw;
163  kv.value = ~0ULL;
164  BV (clib_bihash_search_inline) (mac_table, &kv);
165  result0->raw = kv.value;
166 
167  /* Update one-entry cache */
168  cached_key->raw = key0->raw;
169  cached_result->raw = result0->raw;
170  }
171 }
172 
173 
174 /**
175  * Lookup the entry for mac and bd_index in the mac table for 2 packets.
176  * The lookups for the two packets are interleaved.
177  *
178  * Cached_key and cached_result are used as a one-entry cache.
179  * The function reads and updates them as needed.
180  *
181  * mac0 and bd_index0 are the keys. The entry is written to result0.
182  * If the entry was not found, result0 is set to ~0. The same
183  * holds for mac1/bd_index1/result1.
184  */
186 l2fib_lookup_2 (BVT (clib_bihash) * mac_table,
187  l2fib_entry_key_t * cached_key,
188  l2fib_entry_result_t * cached_result,
189  u8 * mac0,
190  u8 * mac1,
191  u16 bd_index0,
192  u16 bd_index1,
193  l2fib_entry_key_t * key0,
194  l2fib_entry_key_t * key1,
195  u32 * bucket0,
196  u32 * bucket1,
197  l2fib_entry_result_t * result0,
198  l2fib_entry_result_t * result1)
199 {
200  /* set up key */
201  key0->raw = l2fib_make_key (mac0, bd_index0);
202  key1->raw = l2fib_make_key (mac1, bd_index1);
203 
204  if ((key0->raw == cached_key->raw) && (key1->raw == cached_key->raw))
205  {
206  /* Both hit in the one-entry cache */
207  result0->raw = cached_result->raw;
208  result1->raw = cached_result->raw;
209  *bucket0 = ~0;
210  *bucket1 = ~0;
211 
212  }
213  else
214  {
215  BVT (clib_bihash_kv) kv0, kv1;
216 
217  /*
218  * Do a regular mac table lookup
219  * Interleave lookups for packet 0 and packet 1
220  */
221  kv0.key = key0->raw;
222  kv1.key = key1->raw;
223  kv0.value = ~0ULL;
224  kv1.value = ~0ULL;
225 
226  BV (clib_bihash_search_inline) (mac_table, &kv0);
227  BV (clib_bihash_search_inline) (mac_table, &kv1);
228 
229  result0->raw = kv0.value;
230  result1->raw = kv1.value;
231 
232  /* Update one-entry cache */
233  cached_key->raw = key1->raw;
234  cached_result->raw = result1->raw;
235  }
236 }
237 
239 l2fib_lookup_4 (BVT (clib_bihash) * mac_table,
240  l2fib_entry_key_t * cached_key,
241  l2fib_entry_result_t * cached_result,
242  u8 * mac0,
243  u8 * mac1,
244  u8 * mac2,
245  u8 * mac3,
246  u16 bd_index0,
247  u16 bd_index1,
248  u16 bd_index2,
249  u16 bd_index3,
250  l2fib_entry_key_t * key0,
251  l2fib_entry_key_t * key1,
252  l2fib_entry_key_t * key2,
253  l2fib_entry_key_t * key3,
254  u32 * bucket0,
255  u32 * bucket1,
256  u32 * bucket2,
257  u32 * bucket3,
258  l2fib_entry_result_t * result0,
259  l2fib_entry_result_t * result1,
260  l2fib_entry_result_t * result2,
261  l2fib_entry_result_t * result3)
262 {
263  /* set up key */
264  key0->raw = l2fib_make_key (mac0, bd_index0);
265  key1->raw = l2fib_make_key (mac1, bd_index1);
266  key2->raw = l2fib_make_key (mac2, bd_index2);
267  key3->raw = l2fib_make_key (mac3, bd_index3);
268 
269  if ((key0->raw == cached_key->raw) && (key1->raw == cached_key->raw) &&
270  (key2->raw == cached_key->raw) && (key3->raw == cached_key->raw))
271  {
272  /* Both hit in the one-entry cache */
273  result0->raw = cached_result->raw;
274  result1->raw = cached_result->raw;
275  result2->raw = cached_result->raw;
276  result3->raw = cached_result->raw;
277  *bucket0 = ~0;
278  *bucket1 = ~0;
279  *bucket2 = ~0;
280  *bucket3 = ~0;
281 
282  }
283  else
284  {
285  BVT (clib_bihash_kv) kv0, kv1, kv2, kv3;
286 
287  /*
288  * Do a regular mac table lookup
289  * Interleave lookups for packet 0 and packet 1
290  */
291  kv0.key = key0->raw;
292  kv1.key = key1->raw;
293  kv2.key = key2->raw;
294  kv3.key = key3->raw;
295  kv0.value = ~0ULL;
296  kv1.value = ~0ULL;
297  kv2.value = ~0ULL;
298  kv3.value = ~0ULL;
299 
300  BV (clib_bihash_search_inline) (mac_table, &kv0);
301  BV (clib_bihash_search_inline) (mac_table, &kv1);
302  BV (clib_bihash_search_inline) (mac_table, &kv2);
303  BV (clib_bihash_search_inline) (mac_table, &kv3);
304 
305  result0->raw = kv0.value;
306  result1->raw = kv1.value;
307  result2->raw = kv2.value;
308  result3->raw = kv3.value;
309 
310  /* Update one-entry cache */
311  cached_key->raw = key1->raw;
312  cached_result->raw = result1->raw;
313  }
314 }
315 
316 BVT (clib_bihash) * get_mac_table (void);
317  void
318  l2fib_clear_table (uint keep_static);
319  void
320  l2fib_add_entry (u64 mac,
321  u32 bd_index,
322  u32 sw_if_index,
323  u32 static_mac, u32 drop_mac, u32 bvi_mac);
324 u32
325 l2fib_del_entry (u64 mac, u32 bd_index);
326 
327  void
328  l2fib_table_dump (u32 bd_index, l2fib_entry_key_t ** l2fe_key,
329  l2fib_entry_result_t ** l2fe_res);
330 
331  u8 *format_vnet_sw_if_index_name_with_NA (u8 * s, va_list * args);
332 
333 #endif
334 
335 /*
336  * fd.io coding-style-patch-verification: ON
337  *
338  * Local Variables:
339  * eval: (c-set-style "gnu")
340  * End:
341  */
u32 w1
Definition: l2_fib.h:45
Definition: l2_fib.h:56
u32 w0
Definition: l2_fib.h:44
#define static_always_inline
Definition: clib.h:85
#define always_inline
Definition: clib.h:84
struct l2fib_entry_key_t::@189::@192 words
unsigned long u64
Definition: types.h:89
void l2fib_add_entry(u64 mac, u32 bd_index, u32 sw_if_index, u32 static_mac, u32 drop_mac, u32 bvi_mac)
Add an entry to the l2fib.
Definition: l2_fib.c:314
u16 unused2
Definition: l2_fib.h:69
BVT(clib_bihash)*get_mac_table(void)
Definition: l2_fib.c:707
STATIC_ASSERT_SIZEOF(l2fib_entry_key_t, 8)
#define L2FIB_NUM_BUCKETS
Definition: l2_fib.h:27
u64 raw
Definition: l2_fib.h:71
u32 sw_if_index
Definition: l2_fib.h:62
u32 l2fib_del_entry(u64 mac, u32 bd_index)
Delete an entry from the l2fib.
Definition: l2_fib.c:612
#define hash_mix32(a0, b0, c0)
Definition: hash.h:515
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:186
unsigned int u32
Definition: types.h:88
Definition: l2_fib.h:33
void l2fib_clear_table(uint keep_static)
Definition: l2_fib.c:259
void l2fib_table_dump(u32 bd_index, l2fib_entry_key_t **l2fe_key, l2fib_entry_result_t **l2fe_res)
Definition: l2_fib.c:73
u8 timestamp
Definition: l2_fib.h:68
unsigned short u16
Definition: types.h:57
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:60
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:82
static u64 l2fib_make_key(u8 *mac_address, u16 bd_index)
Definition: l2_fib.h:97
u16 bd_index
Definition: l2_fib.h:39
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:239
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:140
u64 raw
Definition: l2_fib.h:47