L2 over MPLS

[vpp.git] / src / vnet / fib / fib_table.h

diff --git a/src/vnet/fib/fib_table.h b/src/vnet/fib/fib_table.h
index cfec516..579740e 100644 (file)
--- a/src/vnet/fib/fib_table.h
+++ b/src/vnet/fib/fib_table.h
@@ -28,18 +28,6 @@
  */
 typedef struct fib_table_t_
 {
-    /**
-     * A union of the protocol specific FIBs that provide the
-     * underlying LPM mechanism.
-     * This element is first in the struct so that it is in the
-     * first cache line.
-     */
-    union {
-       ip4_fib_t v4;
-       ip6_fib_t v6;
-       mpls_fib_t mpls;
-    };
-
     /**
      * Which protocol this table serves. Used to switch on the union above.
      */
@@ -138,14 +126,16 @@ extern fib_node_index_t fib_table_get_less_specific(u32 fib_index,
 
 /**
  * @brief
- *  Add a 'special' entry to the FIB that links to the adj passed
+ *  Add a 'special' entry to the FIB.
  *  A special entry is an entry that the FIB is not expect to resolve
  *  via the usual mechanisms (i.e. recurisve or neighbour adj DB lookup).
- *  Instead the client/source provides the adj to link to.
+ *  Instead the will link to a DPO valid for the source and/or the flags.
  *  This add is reference counting per-source. So n 'removes' are required
  *  for n 'adds', if the entry is no longer required.
+ *  If the source needs to provide non-default forwarding use:
+ *  fib_table_entry_special_dpo_add()
  *
-  * @param fib_index
+ * @param fib_index
  *  The index of the FIB
  *
  * @param prefix
@@ -157,17 +147,13 @@ extern fib_node_index_t fib_table_get_less_specific(u32 fib_index,
  * @param flags
  *  Flags for the entry.
  *
- * @param adj_index
- *  The adjacency to link to.
- *
  * @return
  *  the index of the fib_entry_t that is created (or exists already).
  */
 extern fib_node_index_t fib_table_entry_special_add(u32 fib_index,
                                                    const fib_prefix_t *prefix,
                                                    fib_source_t source,
-                                                   fib_entry_flag_t flags,
-                                                   adj_index_t adj_index);
+                                                   fib_entry_flag_t flags);
 
 /**
  * @brief
@@ -302,7 +288,7 @@ extern fib_node_index_t fib_table_entry_path_add(u32 fib_index,
                                                 const fib_prefix_t *prefix,
                                                 fib_source_t source,
                                                 fib_entry_flag_t flags,
-                                                fib_protocol_t next_hop_proto,
+                                                dpo_proto_t next_hop_proto,
                                                 const ip46_address_t *next_hop,
                                                 u32 next_hop_sw_if_index,
                                                 u32 next_hop_fib_index,
@@ -378,7 +364,7 @@ extern fib_node_index_t fib_table_entry_path_add2(u32 fib_index,
 extern void fib_table_entry_path_remove(u32 fib_index,
                                        const fib_prefix_t *prefix,
                                        fib_source_t source,
-                                       fib_protocol_t next_hop_proto,
+                                       dpo_proto_t next_hop_proto,
                                        const ip46_address_t *next_hop,
                                        u32 next_hop_sw_if_index,
                                        u32 next_hop_fib_index,
@@ -485,7 +471,7 @@ extern fib_node_index_t fib_table_entry_update_one_path(u32 fib_index,
                                                        const fib_prefix_t *prefix,
                                                        fib_source_t source,
                                                        fib_entry_flag_t flags,
-                                                       fib_protocol_t next_hop_proto,
+                                                       dpo_proto_t next_hop_proto,
                                                        const ip46_address_t *next_hop,
                                                        u32 next_hop_sw_if_index,
                                                        u32 next_hop_fib_index,
@@ -679,6 +665,36 @@ extern u32 fib_table_create_and_lock(fib_protocol_t proto,
 extern flow_hash_config_t fib_table_get_flow_hash_config(u32 fib_index,
                                                         fib_protocol_t proto);
 
+/**
+ * @brief
+ *  Get the flow hash configured used by the protocol
+ *
+ * @paran proto
+ *  The protocol of the FIB (and thus the entries therein)
+ *
+ * @return The flow hash config
+ */
+extern flow_hash_config_t fib_table_get_default_flow_hash_config(fib_protocol_t proto);
+
+/**
+ * @brief
+ *  Set the flow hash configured used by the table
+ *
+ * @param fib_index
+ *  The index of the FIB
+ *
+ * @paran proto
+ *  The protocol of the FIB (and thus the entries therein)
+ *
+ * @param hash_config
+ *  The flow-hash config to set
+ *
+ * @return none
+ */
+extern void fib_table_set_flow_hash_config(u32 fib_index,
+                                           fib_protocol_t proto,
+                                           flow_hash_config_t hash_config);
+
 /**
  * @brief
  * Take a reference counting lock on the table
@@ -729,4 +745,20 @@ 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 Call back function when walking entries in a FIB table
+ */
+typedef int (*fib_table_walk_fn_t)(fib_node_index_t fei,
+                                   void *ctx);
+
+/**
+ * @brief Walk all entries in a FIB table
+ * 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_walk(u32 fib_index,
+                           fib_protocol_t proto,
+                           fib_table_walk_fn_t fn,
+                           void *ctx);
+
 #endif