aboutsummaryrefslogtreecommitdiffstats
path: root/vnet/vnet/l2/l2_fib.h
diff options
context:
space:
mode:
Diffstat (limited to 'vnet/vnet/l2/l2_fib.h')
-rw-r--r--vnet/vnet/l2/l2_fib.h226
1 files changed, 226 insertions, 0 deletions
diff --git a/vnet/vnet/l2/l2_fib.h b/vnet/vnet/l2/l2_fib.h
new file mode 100644
index 00000000000..1dcc0200f60
--- /dev/null
+++ b/vnet/vnet/l2/l2_fib.h
@@ -0,0 +1,226 @@
+/*
+ * l2_fib.h : layer 2 forwarding table (aka mac table)
+ *
+ * Copyright (c) 2013 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef included_l2fib_h
+#define included_l2fib_h
+
+#include <vlib/vlib.h>
+#include <vppinfra/bihash_8_8.h>
+
+/*
+ * The size of the hash table
+ */
+#define L2FIB_NUM_BUCKETS (64 * 1024)
+#define L2FIB_MEMORY_SIZE (256<<20)
+
+/*
+ * The L2fib key is the mac address and bridge domain ID
+ */
+typedef struct {
+ union {
+ struct {
+ u16 bd_index;
+ u8 mac[6];
+ } fields;
+ struct {
+ u32 w0;
+ u32 w1;
+ } words;
+ u64 raw;
+ };
+} l2fib_entry_key_t;
+
+/*
+ * The l2fib entry results
+ */
+typedef struct {
+ union {
+ struct {
+ u32 sw_if_index; // output sw_if_index (L3 interface if bvi==1)
+
+ u8 static_mac:1; // static mac, no dataplane learning
+ u8 bvi:1; // mac is for a bridged virtual interface
+ u8 filter:1; // drop packets to/from this mac
+ u8 refresh:1; // refresh flag for aging
+ u8 unused1:4;
+ u8 timestamp; // timestamp for aging
+ u16 unused2;
+ } fields;
+ u64 raw;
+ };
+} l2fib_entry_result_t;
+
+
+// Compute the hash for the given key and return the corresponding bucket index
+always_inline
+u32 l2fib_compute_hash_bucket (l2fib_entry_key_t *key) {
+ u32 result;
+ u32 temp_a;
+ u32 temp_b;
+
+ result = 0xa5a5a5a5; // some seed
+ temp_a = key->words.w0;
+ temp_b = key->words.w1;
+ hash_mix32(temp_a, temp_b, result);
+
+ return result % L2FIB_NUM_BUCKETS;
+}
+
+always_inline
+u64 l2fib_make_key (u8 * mac_address, u16 bd_index) {
+ u64 temp;
+
+ // The mac address in memory is A:B:C:D:E:F
+ // The bd id in register is H:L
+#if CLIB_ARCH_IS_LITTLE_ENDIAN
+ // Create the in-register key as F:E:D:C:B:A:H:L
+ // In memory the key is L:H:A:B:C:D:E:F
+ temp = *((u64 *)(mac_address - 2));
+ temp = (temp & ~0xffff) | (u64)(bd_index);
+#else
+ // Create the in-register key as H:L:A:B:C:D:E:F
+ // In memory the key is H:L:A:B:C:D:E:F
+ temp = *((u64 *)(mac_address)) >> 16;
+ temp = temp | (bd_index << 48);
+#endif
+
+ return temp;
+}
+
+
+
+// Lookup the entry for mac and bd_index in the mac table for 1 packet.
+// Cached_key and cached_result are used as a one-entry cache.
+// The function reads and updates them as needed.
+//
+// mac0 and bd_index0 are the keys. The entry is written to result0.
+// If the entry was not found, result0 is set to ~0.
+//
+// key0 and bucket0 return with the computed key and hash bucket,
+// convenient if the entry needs to be updated afterward.
+// If the cached_result was used, bucket0 is set to ~0.
+
+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)
+{
+ // set up key
+ key0->raw = l2fib_make_key (mac0, bd_index0);
+ *bucket0 = ~0;
+
+ if (key0->raw == cached_key->raw) {
+ // Hit in the one-entry cache
+ result0->raw = cached_result->raw;
+ } else {
+ // Do a regular mac table lookup
+ BVT(clib_bihash_kv) kv;
+
+ kv.key = key0->raw;
+ kv.value = ~0ULL;
+ BV(clib_bihash_search_inline) (mac_table, &kv);
+ result0->raw = kv.value;
+
+ // Update one-entry cache
+ cached_key->raw = key0->raw;
+ cached_result->raw = result0->raw;
+ }
+}
+
+
+// Lookup the entry for mac and bd_index in the mac table for 2 packets.
+// The lookups for the two packets are interleaved.
+//
+// Cached_key and cached_result are used as a one-entry cache.
+// The function reads and updates them as needed.
+//
+// mac0 and bd_index0 are the keys. The entry is written to result0.
+// If the entry was not found, result0 is set to ~0. The same
+// holds for mac1/bd_index1/result1.
+
+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)
+{
+ // set up key
+ key0->raw = l2fib_make_key (mac0, bd_index0);
+ key1->raw = l2fib_make_key (mac1, bd_index1);
+
+ if ((key0->raw == cached_key->raw) &&
+ (key1->raw == cached_key->raw)) {
+ // Both hit in the one-entry cache
+ result0->raw = cached_result->raw;
+ result1->raw = cached_result->raw;
+ *bucket0 = ~0;
+ *bucket1 = ~0;
+
+ } else {
+ BVT(clib_bihash_kv) kv0, kv1;
+
+ // Do a regular mac table lookup
+ // Interleave lookups for packet 0 and packet 1
+ kv0.key = key0->raw;
+ kv1.key = key1->raw;
+ kv0.value = ~0ULL;
+ kv1.value = ~0ULL;
+
+ BV(clib_bihash_search_inline) (mac_table, &kv0);
+ BV(clib_bihash_search_inline) (mac_table, &kv1);
+
+ result0->raw = kv0.value;
+ result1->raw = kv1.value;
+
+ // Update one-entry cache
+ cached_key->raw = key1->raw;
+ cached_result->raw = result1->raw;
+ }
+}
+
+
+BVT(clib_bihash) *get_mac_table(void);
+void l2fib_clear_table (uint keep_static);
+void l2fib_add_entry (u64 mac,
+ u32 bd_index,
+ u32 sw_if_index,
+ u32 static_mac,
+ u32 drop_mac,
+ u32 bvi_mac);
+u32 l2fib_del_entry (u64 mac,
+ u32 bd_index);
+
+void l2fib_table_dump (u32 bd_index, l2fib_entry_key_t **l2fe_key,
+ l2fib_entry_result_t **l2fe_res);
+
+u8 * format_vnet_sw_if_index_name_with_NA (u8 * s, va_list * args);
+
+#endif