GBP V2
[vpp.git] / src / vnet / fib / fib_table.h
index 6c26404..8b86f8d 100644 (file)
 #define FIB_TABLE_N_LOCKS (FIB_SOURCE_MAX+1)
 #define FIB_TABLE_TOTAL_LOCKS FIB_SOURCE_MAX
 
+/**
+ * Flags for the source data
+ */
+typedef enum fib_table_attribute_t_ {
+    /**
+     * Marker. Add new values after this one.
+     */
+    FIB_TABLE_ATTRIBUTE_FIRST,
+    /**
+     * the table is for IP6 link local addresses
+     */
+    FIB_TABLE_ATTRIBUTE_IP6_LL = FIB_TABLE_ATTRIBUTE_FIRST,
+    /**
+     * Marker. add new entries before this one.
+     */
+    FIB_TABLE_ATTRIBUTE_LAST = FIB_TABLE_ATTRIBUTE_IP6_LL,
+} fib_table_attribute_t;
+
+#define FIB_TABLE_ATTRIBUTE_MAX (FIB_TABLE_ATTRIBUTE_LAST+1)
+
+#define FIB_TABLE_ATTRIBUTES {                  \
+    [FIB_TABLE_ATTRIBUTE_IP6_LL]  = "ip6-ll",   \
+}
+
+#define FOR_EACH_FIB_TABLE_ATTRIBUTE(_item)            \
+    for (_item = FIB_TABLE_ATTRIBUTE_FIRST;            \
+        _item < FIB_TABLE_ATTRIBUTE_MAX;               \
+        _item++)
+
+typedef enum fib_table_flags_t_ {
+    FIB_TABLE_FLAG_NONE   = 0,
+    FIB_TABLE_FLAG_IP6_LL  = (1 << FIB_TABLE_ATTRIBUTE_IP6_LL),
+} __attribute__ ((packed)) fib_table_flags_t;
+
 /**
  * @brief 
  *   A protocol Independent FIB table
@@ -39,6 +73,11 @@ typedef struct fib_table_t_
      */
     fib_protocol_t ft_proto;
 
+    /**
+     * Table flags
+     */
+    fib_table_flags_t ft_flags;
+
     /**
      * per-source number of locks on the table
      */
@@ -299,7 +338,7 @@ extern fib_node_index_t fib_table_entry_path_add(u32 fib_index,
                                                 u32 next_hop_sw_if_index,
                                                 u32 next_hop_fib_index,
                                                 u32 next_hop_weight,
-                                                mpls_label_t *next_hop_label_stack,
+                                                fib_mpls_label_t *next_hop_label_stack,
                                                 fib_route_path_flags_t pf);
 /**
  * @brief
@@ -482,7 +521,7 @@ extern fib_node_index_t fib_table_entry_update_one_path(u32 fib_index,
                                                        u32 next_hop_sw_if_index,
                                                        u32 next_hop_fib_index,
                                                        u32 next_hop_weight,
-                                                       mpls_label_t *next_hop_label_stack,
+                                                       fib_mpls_label_t *next_hop_label_stack,
                                                        fib_route_path_flags_t pf);
 
 /**
@@ -604,6 +643,21 @@ extern u32 fib_table_get_index_for_sw_if_index(fib_protocol_t proto,
 extern u32 fib_table_get_table_id_for_sw_if_index(fib_protocol_t proto,
                                                  u32 sw_if_index);
 
+/**
+ * @brief
+ *  Get the Table-ID of the FIB from protocol and index
+ *
+ * @param fib_index
+ *  The FIB index
+ *
+ * @paran proto
+ *  The protocol of the FIB (and thus the entries therein)
+ *
+ * @return fib_index
+ *  The tableID of the FIB
+ */
+extern u32 fib_table_get_table_id(u32 fib_index, fib_protocol_t proto);
+
 /**
  * @brief
  *  Get the index of the FIB for a Table-ID. This DOES NOT create the
@@ -697,7 +751,7 @@ extern u32 fib_table_create_and_lock(fib_protocol_t proto,
  *  The index of the FIB
  *
  * @paran proto
- *  The protocol of the FIB (and thus the entries therein)
+ *  The protocol the packets the flow hash will be calculated for.
  *
  * @return The flow hash config
  */
@@ -792,11 +846,30 @@ extern u32 fib_table_get_num_entries(u32 fib_index,
 extern fib_table_t *fib_table_get(fib_node_index_t index,
                                  fib_protocol_t proto);
 
+/**
+ * @brief return code controlling how a table walk proceeds
+ */
+typedef enum fib_table_walk_rc_t_
+{
+    /**
+     * Continue on to the next entry
+     */
+    FIB_TABLE_WALK_CONTINUE,
+    /**
+     * Do no traverse down this sub-tree
+     */
+    FIB_TABLE_WALK_SUB_TREE_STOP,
+    /**
+     * Stop the walk completely
+     */
+    FIB_TABLE_WALK_STOP,
+} fib_table_walk_rc_t;
+
 /**
  * @brief Call back function when walking entries in a FIB table
  */
-typedef int (*fib_table_walk_fn_t)(fib_node_index_t fei,
-                                   void *ctx);
+typedef fib_table_walk_rc_t (*fib_table_walk_fn_t)(fib_node_index_t fei,
+                                                   void *ctx);
 
 /**
  * @brief Walk all entries in a FIB table
@@ -808,4 +881,21 @@ extern void fib_table_walk(u32 fib_index,
                            fib_table_walk_fn_t fn,
                            void *ctx);
 
+/**
+ * @brief Walk all entries in a sub-tree FIB table. The 'root' paraneter
+ * is the prefix at the root of the sub-tree.
+ * N.B: This is NOT safe to deletes. If you need to delete walk the whole
+ * table and store elements in a vector, then delete the elements
+ */
+extern void fib_table_sub_tree_walk(u32 fib_index,
+                                    fib_protocol_t proto,
+                                    const fib_prefix_t *root,
+                                    fib_table_walk_fn_t fn,
+                                    void *ctx);
+
+/**
+ * @brief format (display) the memory used by the FIB tables
+ */
+extern u8 *format_fib_table_memory(u8 *s, va_list *args);
+
 #endif