vlib: clean up r2 plugin registration relocator
[vpp.git] / src / vnet / l2 / l2_fib.h
index 7cc2dc5..e24d427 100644 (file)
@@ -24,8 +24,8 @@
 /*
  * The size of the hash table
  */
-#define L2FIB_NUM_BUCKETS (64 * 1024)
-#define L2FIB_MEMORY_SIZE (512<<20)
+#define L2FIB_NUM_BUCKETS (256 * 1024)
+#define L2FIB_MEMORY_SIZE (128<<20)
 
 /* Ager scan interval is 1 minute for aging */
 #define L2FIB_AGE_SCAN_INTERVAL                (60.0)
@@ -45,8 +45,14 @@ typedef struct
   /* hash table */
   BVT (clib_bihash) mac_table;
 
-  /* per swif vector of sequence number for interface based flush of MACs */
-  u8 *swif_seq_num;
+  /* number of buckets in the hash table */
+  uword mac_table_n_buckets;
+
+  /* hash table memory size */
+  uword mac_table_memory_size;
+
+  /* hash table initialized */
+  u8 mac_table_initialized;
 
   /* last event or ager scan duration */
   f64 evt_scan_duration;
@@ -55,7 +61,7 @@ typedef struct
   /* delay between event scans, default to 100 msec */
   f64 event_scan_delay;
 
-  /* max macs in evet message, default to 100 entries */
+  /* max macs in event message, default to 100 entries */
   u32 max_macs_in_event;
 
   /* convenience variables */
@@ -88,37 +94,77 @@ typedef struct
 
 STATIC_ASSERT_SIZEOF (l2fib_entry_key_t, 8);
 
+/**
+ * A combined representation of the sequence number associated
+ * with the interface and the BD.
+ * The BD is in higher bits, the interface in the lower bits, but
+ * the order is not important.
+ *
+ * It's convenient to represent this as an union of two u8s,
+ * but then in the DP one is forced to do short writes, followed
+ * by long reads, which is a sure thing for a stall
+ */
+typedef u16 l2fib_seq_num_t;
 
-typedef struct
+static_always_inline l2fib_seq_num_t
+l2_fib_mk_seq_num (u8 bd_sn, u8 if_sn)
 {
-  union
-  {
-    struct
-    {
-      u8 swif;
-      u8 bd;
-    };
-    u16 as_u16;
-  };
-} l2fib_seq_num_t;
+  return (((u16) bd_sn) << 8) | if_sn;
+}
+
+static_always_inline l2fib_seq_num_t
+l2_fib_update_seq_num (l2fib_seq_num_t sn, u8 if_sn)
+{
+  sn &= 0xff00;
+  sn |= if_sn;
+
+  return (sn);
+}
+
+extern void l2_fib_extract_seq_num (l2fib_seq_num_t sn, u8 * bd_sn,
+                                   u8 * if_sn);
+extern u8 *format_l2_fib_seq_num (u8 * s, va_list * a);
+
+/**
+ * Flags associated with an L2 Fib Entry
+ *   - static mac, no MAC move
+ *   - not subject to age
+ *   - mac is for a bridged virtual interface
+ *   - drop packets to/from this mac
+ *   - MAC learned to be sent in L2 MAC event
+ *   -MAC learned is a MAC move
+ */
+#define foreach_l2fib_entry_result_attr       \
+  _(STATIC,  0, "static")                     \
+  _(AGE_NOT, 1, "age-not")                    \
+  _(BVI,     2, "bvi")                        \
+  _(FILTER,  3, "filter")                     \
+  _(LRN_EVT, 4, "learn-event")                \
+  _(LRN_MOV, 5, "learn-move")
+
+typedef enum l2fib_entry_result_flags_t_
+{
+  L2FIB_ENTRY_RESULT_FLAG_NONE = 0,
+#define _(a,v,s) L2FIB_ENTRY_RESULT_FLAG_##a = (1 << v),
+  foreach_l2fib_entry_result_attr
+#undef _
+} __attribute__ ((packed)) l2fib_entry_result_flags_t;
+
+STATIC_ASSERT_SIZEOF (l2fib_entry_result_flags_t, 1);
+
+extern u8 *format_l2fib_entry_result_flags (u8 * s, va_list * args);
 
 /*
  * The l2fib entry results
  */
-typedef struct
+typedef struct l2fib_entry_result_t_
 {
   union
   {
     struct
     {
       u32 sw_if_index;         /* output sw_if_index (L3 intf if bvi==1) */
-
-      u8 static_mac:1;         /* static mac, no MAC move */
-      u8 age_not:1;            /* not subject to age */
-      u8 bvi:1;                        /* mac is for a bridged virtual interface */
-      u8 filter:1;             /* drop packets to/from this mac */
-      u8 lrn_evt:1;            /* MAC learned to be sent in L2 MAC event */
-      u8 unused:3;
+      l2fib_entry_result_flags_t flags;
 
       u8 timestamp;            /* timestamp for aging */
       l2fib_seq_num_t sn;      /* bd/int seq num */
@@ -129,6 +175,49 @@ typedef struct
 
 STATIC_ASSERT_SIZEOF (l2fib_entry_result_t, 8);
 
+#define _(a,v,s)                                                        \
+  always_inline int                                                     \
+  l2fib_entry_result_is_set_##a (const l2fib_entry_result_t *r) {       \
+    return (r->fields.flags & L2FIB_ENTRY_RESULT_FLAG_##a);             \
+  }
+foreach_l2fib_entry_result_attr
+#undef _
+#define _(a,v,s)                                                        \
+  always_inline void                                                    \
+  l2fib_entry_result_set_##a (l2fib_entry_result_t *r) {       \
+    r->fields.flags |= L2FIB_ENTRY_RESULT_FLAG_##a;             \
+  }
+  foreach_l2fib_entry_result_attr
+#undef _
+#define _(a,v,s)                                                        \
+  always_inline void                                                    \
+  l2fib_entry_result_clear_##a (l2fib_entry_result_t *r) {       \
+    r->fields.flags &= ~L2FIB_ENTRY_RESULT_FLAG_##a;             \
+  }
+  foreach_l2fib_entry_result_attr
+#undef _
+  static inline void
+l2fib_entry_result_set_bits (l2fib_entry_result_t * r,
+                            l2fib_entry_result_flags_t bits)
+{
+  r->fields.flags |= bits;
+}
+
+static inline void
+l2fib_entry_result_clear_bits (l2fib_entry_result_t * r,
+                              l2fib_entry_result_flags_t bits)
+{
+  r->fields.flags &= ~bits;
+}
+
+/* L2 MAC event entry action enums (see mac_entry definition in l2.api) */
+typedef enum
+{
+  MAC_EVENT_ACTION_ADD = 0,
+  MAC_EVENT_ACTION_DELETE = 1,
+  MAC_EVENT_ACTION_MOVE = 2,
+} l2_mac_event_action_t;
+
 /**
  * Compute the hash for the given key and return
  * the corresponding bucket index
@@ -149,31 +238,11 @@ l2fib_compute_hash_bucket (l2fib_entry_key_t * key)
 }
 
 always_inline u64
-l2fib_make_key (u8 * mac_address, u16 bd_index)
+l2fib_make_key (const 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)) << 16;
-  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 | (((u64) bd_index) << 48);
-#endif
-
-  return temp;
+  l2fib_entry_key_t key = { .fields.bd_index = bd_index };
+  clib_memcpy_fast (&key.fields.mac, mac_address, sizeof (key.fields.mac));
+  return key.raw;
 }
 
 
@@ -186,9 +255,8 @@ l2fib_make_key (u8 * mac_address, u16 bd_index)
  * 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.
+ * key0 return with the computed key, convenient if the entry needs,
+ * to be updated afterward.
  */
 
 static_always_inline void
@@ -197,12 +265,10 @@ l2fib_lookup_1 (BVT (clib_bihash) * mac_table,
                l2fib_entry_result_t * cached_result,
                u8 * mac0,
                u16 bd_index0,
-               l2fib_entry_key_t * key0,
-               u32 * bucket0, l2fib_entry_result_t * result0)
+               l2fib_entry_key_t * key0, l2fib_entry_result_t * result0)
 {
   /* set up key */
   key0->raw = l2fib_make_key (mac0, bd_index0);
-  *bucket0 = ~0;
 
   if (key0->raw == cached_key->raw)
     {
@@ -247,8 +313,6 @@ l2fib_lookup_2 (BVT (clib_bihash) * mac_table,
                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)
 {
@@ -261,9 +325,6 @@ l2fib_lookup_2 (BVT (clib_bihash) * mac_table,
       /* Both hit in the one-entry cache */
       result0->raw = cached_result->raw;
       result1->raw = cached_result->raw;
-      *bucket0 = ~0;
-      *bucket1 = ~0;
-
     }
   else
     {
@@ -294,10 +355,10 @@ 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,
+               const u8 * mac0,
+               const u8 * mac1,
+               const u8 * mac2,
+               const u8 * mac3,
                u16 bd_index0,
                u16 bd_index1,
                u16 bd_index2,
@@ -306,10 +367,6 @@ l2fib_lookup_4 (BVT (clib_bihash) * mac_table,
                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,
@@ -329,11 +386,6 @@ l2fib_lookup_4 (BVT (clib_bihash) * mac_table,
       result1->raw = cached_result->raw;
       result2->raw = cached_result->raw;
       result3->raw = cached_result->raw;
-      *bucket0 = ~0;
-      *bucket1 = ~0;
-      *bucket2 = ~0;
-      *bucket3 = ~0;
-
     }
   else
     {
@@ -370,25 +422,22 @@ l2fib_lookup_4 (BVT (clib_bihash) * mac_table,
 
 void l2fib_clear_table (void);
 
+void l2fib_table_init (void);
+
 void
-l2fib_add_entry (u64 mac,
+l2fib_add_entry (const u8 * mac,
                 u32 bd_index,
-                u32 sw_if_index, u8 static_mac, u8 drop_mac, u8 bvi_mac);
-
-static inline void
-l2fib_add_fwd_entry (u64 mac, u32 bd_index, u32 sw_if_index, u8 static_mac,
-                    u8 bvi_mac)
-{
-  l2fib_add_entry (mac, bd_index, sw_if_index, static_mac, 0, bvi_mac);
-}
+                u32 sw_if_index, l2fib_entry_result_flags_t flags);
 
 static inline void
-l2fib_add_filter_entry (u64 mac, u32 bd_index)
+l2fib_add_filter_entry (const u8 * mac, u32 bd_index)
 {
-  l2fib_add_entry (mac, bd_index, ~0, 1, 1, 0);
+  l2fib_add_entry (mac, bd_index, ~0,
+                  (L2FIB_ENTRY_RESULT_FLAG_FILTER |
+                   L2FIB_ENTRY_RESULT_FLAG_STATIC));
 }
 
-u32 l2fib_del_entry (u64 mac, u32 bd_index);
+u32 l2fib_del_entry (const u8 * mac, u32 bd_index, u32 sw_if_index);
 
 void l2fib_start_ager_scan (vlib_main_t * vm);
 
@@ -404,21 +453,6 @@ l2fib_table_dump (u32 bd_index, l2fib_entry_key_t ** l2fe_key,
 
 u8 *format_vnet_sw_if_index_name_with_NA (u8 * s, va_list * args);
 
-static_always_inline u8 *
-l2fib_swif_seq_num (u32 sw_if_index)
-{
-  l2fib_main_t *mp = &l2fib_main;
-  return vec_elt_at_index (mp->swif_seq_num, sw_if_index);
-}
-
-static_always_inline u8 *
-l2fib_valid_swif_seq_num (u32 sw_if_index)
-{
-  l2fib_main_t *mp = &l2fib_main;
-  vec_validate (mp->swif_seq_num, sw_if_index);
-  return l2fib_swif_seq_num (sw_if_index);
-}
-
 BVT (clib_bihash) * get_mac_table (void);
 
 #endif