Improve l2_macs_events API to provide MAC move information

[vpp.git] / src / vnet / l2 / l2_fib.h

diff --git a/src/vnet/l2/l2_fib.h b/src/vnet/l2/l2_fib.h
index 7e49d74..ad7035b 100644 (file)
--- a/src/vnet/l2/l2_fib.h
+++ b/src/vnet/l2/l2_fib.h
@@ -25,7 +25,45 @@
  * The size of the hash table
  */
 #define L2FIB_NUM_BUCKETS (64 * 1024)
-#define L2FIB_MEMORY_SIZE (256<<20)
+#define L2FIB_MEMORY_SIZE (512<<20)
+
+/* Ager scan interval is 1 minute for aging */
+#define L2FIB_AGE_SCAN_INTERVAL                (60.0)
+
+/* MAC event scan delay is 100 msec unless specified by MAC event client */
+#define L2FIB_EVENT_SCAN_DELAY_DEFAULT (0.1)
+
+/* Max MACs in a event message is 100 unless specified by MAC event client */
+#define L2FIB_EVENT_MAX_MACS_DEFAULT   (100)
+
+/* MAC event learn limit is 1000 unless specified by MAC event client */
+#define L2FIB_EVENT_LEARN_LIMIT_DEFAULT        (1000)
+
+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;
+
+  /* last event or ager scan duration */
+  f64 evt_scan_duration;
+  f64 age_scan_duration;
+
+  /* delay between event scans, default to 100 msec */
+  f64 event_scan_delay;
+
+  /* max macs in evet message, default to 100 entries */
+  u32 max_macs_in_event;
+
+  /* convenience variables */
+  vlib_main_t *vlib_main;
+  vnet_main_t *vnet_main;
+} l2fib_main_t;
+
+extern l2fib_main_t l2fib_main;
 
 /*
  * The L2fib key is the mac address and bridge domain ID
@@ -50,6 +88,20 @@ typedef struct
 
 STATIC_ASSERT_SIZEOF (l2fib_entry_key_t, 8);
 
+
+typedef struct
+{
+  union
+  {
+    struct
+    {
+      u8 swif;
+      u8 bd;
+    };
+    u16 as_u16;
+  };
+} l2fib_seq_num_t;
+
 /*
  * The l2fib entry results
  */
@@ -59,15 +111,18 @@ typedef struct
   {
     struct
     {
-      u32 sw_if_index;         /* output sw_if_index (L3 interface if bvi==1) */
+      u32 sw_if_index;         /* output sw_if_index (L3 intf if bvi==1) */
 
-      u8 static_mac:1;         /* static mac, no dataplane learning */
+      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 unused1:5;
+      u8 lrn_evt:1;            /* MAC learned to be sent in L2 MAC event */
+      u8 lrn_mov:1;            /* MAC learned is a MAC move */
+      u8 unused:2;
+
       u8 timestamp;            /* timestamp for aging */
-      u8 int_sn;               /* interface seq num */
-      u8 bd_sn;                        /* bridge domain seq num */
+      l2fib_seq_num_t sn;      /* bd/int seq num */
     } fields;
     u64 raw;
   };
@@ -75,6 +130,14 @@ typedef struct
 
 STATIC_ASSERT_SIZEOF (l2fib_entry_result_t, 8);
 
+/* 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
@@ -94,7 +157,12 @@ l2fib_compute_hash_bucket (l2fib_entry_key_t * key)
   return result % L2FIB_NUM_BUCKETS;
 }
 
-always_inline u64
+/**
+ * make address sanitizer skip this:
+ * The 6-Bytes mac-address is cast into an 8-Bytes u64, with 2 additional Bytes.
+ * l2fib_make_key() does read those two Bytes but does not use them.
+ */
+always_inline u64 __attribute__ ((no_sanitize_address))
 l2fib_make_key (u8 * mac_address, u16 bd_index)
 {
   u64 temp;
@@ -314,14 +382,27 @@ l2fib_lookup_4 (BVT (clib_bihash) * mac_table,
     }
 }
 
-void l2fib_clear_table (uint keep_static);
+void l2fib_clear_table (void);
 
 void
-l2fib_add_entry (u64 mac,
+l2fib_add_entry (u8 * mac,
                 u32 bd_index,
-                u32 sw_if_index, u32 static_mac, u32 drop_mac, u32 bvi_mac);
+                u32 sw_if_index, u8 static_mac, u8 drop_mac, u8 bvi_mac);
+
+static inline void
+l2fib_add_fwd_entry (u8 * 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 l2fib_del_entry (u64 mac, u32 bd_index);
+static inline void
+l2fib_add_filter_entry (u8 * mac, u32 bd_index)
+{
+  l2fib_add_entry (mac, bd_index, ~0, 1, 1, 0);
+}
+
+u32 l2fib_del_entry (u8 * mac, u32 bd_index);
 
 void l2fib_start_ager_scan (vlib_main_t * vm);
 
@@ -329,12 +410,29 @@ void l2fib_flush_int_mac (vlib_main_t * vm, u32 sw_if_index);
 
 void l2fib_flush_bd_mac (vlib_main_t * vm, u32 bd_index);
 
+void l2fib_flush_all_mac (vlib_main_t * vm);
+
 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);
 
+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