A Protocol Independent Hierarchical FIB (VPP-352)
[vpp.git] / vnet / vnet / lisp-gpe / lisp_gpe.h
index fd7a114..66009cc 100644 (file)
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * @file
+ * @brief LISP-GPE definitions.
+ */
 
 #ifndef included_vnet_lisp_gpe_h
 #define included_vnet_lisp_gpe_h
 #include <vnet/ip/udp.h>
 #include <vnet/lisp-cp/lisp_types.h>
 #include <vnet/lisp-gpe/lisp_gpe_packet.h>
+#include <vnet/adj/adj_types.h>
 
-/* encap headers */
+/** IP4-UDP-LISP encap header */
+/* *INDENT-OFF* */
 typedef CLIB_PACKED (struct {
   ip4_header_t ip4;             /* 20 bytes */
   udp_header_t udp;             /* 8 bytes */
   lisp_gpe_header_t lisp;       /* 8 bytes */
 }) ip4_udp_lisp_gpe_header_t;
+/* *INDENT-ON* */
 
+/** IP6-UDP-LISP encap header */
+/* *INDENT-OFF* */
 typedef CLIB_PACKED (struct {
   ip6_header_t ip6;             /* 40 bytes */
   udp_header_t udp;             /* 8 bytes */
   lisp_gpe_header_t lisp;       /* 8 bytes */
 }) ip6_udp_lisp_gpe_header_t;
+/* *INDENT-ON* */
 
+/** LISP-GPE tunnel structure */
 typedef struct
 {
-  union
-  {
-    struct
-    {
-      /* within the dp only ip and mac can be eids */
-      union
-      {
-        ip_prefix_t rmt_ippref;
-        u8 rmt_mac[6];
-      };
-      ip_address_t rmt_loc;
-      u32 vni;
-    };
-    u8 as_u8[40];
-  };
-} lisp_gpe_tunnel_key_t;
+  /** tunnel src and dst addresses */
+  locator_pair_t *locator_pairs;
 
-typedef struct
-{
-  /* Rewrite string. $$$$ embed vnet_rewrite header */
-  u8 * rewrite;
+  /** locator-pairs with best priority become sub-tunnels */
+  u32 *sub_tunnels;
 
-  /* decap next index */
+  /** decap next index */
   u32 decap_next_index;
 
-  /* tunnel src and dst addresses */
-  ip_address_t src;
-  ip_address_t dst;
+  /* TODO remove */
+  ip_address_t src, dst;
+
+  /** FIB indices */
+  u32 encap_fib_index;         /* tunnel partner lookup here */
+  u32 decap_fib_index;         /* inner IP lookup here */
 
-  /* FIB indices */
-  u32 encap_fib_index;          /* tunnel partner lookup here */
-  u32 decap_fib_index;          /* inner IP lookup here */
+  /** index of the source address lookup FIB */
+  u32 src_fib_index;
 
-  /* vnet intfc hw/sw_if_index */
+  /** vnet intfc hw/sw_if_index */
   u32 hw_if_index;
   u32 sw_if_index;
 
-  /* action for 'negative' tunnels */
+  /** L2 path-list */
+  fib_node_index_t l2_path_list;
+
+  /** action for 'negative' tunnels */
   u8 action;
 
-  /* LISP header fields in HOST byte order */
+  /** LISP header fields in HOST byte order */
   u8 flags;
   u8 ver_res;
   u8 res;
@@ -90,140 +90,226 @@ typedef struct
   u32 vni;
 } lisp_gpe_tunnel_t;
 
+/**
+ * @brief A path on which to forward lisp traffic
+ */
+typedef struct lisp_fwd_path_t_
+{
+  /**
+   * The adjacency constructed for the locator pair
+   */
+  index_t lisp_adj;
+
+  /**
+   * Priority. Only the paths with the best priority will be installed in FIB
+   */
+  u8 priority;
+
+  /**
+   * [UE]CMP weigt for the path
+   */
+  u8 weight;
+
+} lisp_fwd_path_t;
+
+/**
+ * @brief A Forwarding entry can be 'normal' or 'negative'
+ * Negative implies we deliberately want to add a FIB entry for an EID
+ * that results in 'spcial' behaviour determined by an 'action'.
+ * @normal' means send it down some tunnels.
+ */
+typedef enum lisp_fwd_entry_type_t_
+{
+  LISP_FWD_ENTRY_TYPE_NORMAL,
+  LISP_FWD_ENTRY_TYPE_NEGATIVE,
+} lisp_fwd_entry_type_t;
+
+typedef enum
+{
+  NO_ACTION,
+  FORWARD_NATIVE,
+  SEND_MAP_REQUEST,
+  DROP
+} negative_fwd_actions_e;
+
+/**
+ * LISP-GPE fwd entry key
+ */
+typedef struct lisp_gpe_fwd_entry_key_t_
+{
+  dp_address_t rmt;
+  dp_address_t lcl;
+  u32 vni;
+} lisp_gpe_fwd_entry_key_t;
+
+/**
+ * @brief A LISP Forwarding Entry
+ *
+ * A forwarding entry is from a locai EID to a remote EID over a set of rloc pairs
+ */
+typedef struct lisp_fwd_entry_t_
+{
+  /**
+   * The Entry's key: {lEID,r-EID,vni}
+   */
+  lisp_gpe_fwd_entry_key_t *key;
+
+  /**
+   * The VRF (in the case of L3) or Bridge-Domain (for L2) index
+   */
+  union
+  {
+    u32 eid_table_id;
+    u32 eid_bd_index;
+  };
+
+  /**
+   * The forwarding entry type
+   */
+  lisp_fwd_entry_type_t type;
+
+  union
+  {
+    /**
+     * @brief When the type is 'normal'
+     *        The RLOC pair that form the route's paths. i.e. where to send
+     *        packets for this route.
+     */
+    lisp_fwd_path_t *paths;
+
+    /**
+     * @brief When the type is negative. The action to take.
+     */
+    negative_fwd_actions_e action;
+  };
+
+  /**
+   * The FIB index for the overlay, i.e. the FIB in which the EIDs
+   * are present
+   */
+  u32 eid_fib_index;
+
+  /**
+   * The SRC-FIB index for created for anding source-route entries
+   */
+  u32 src_fib_index;
+} lisp_fwd_entry_t;
+
+
 #define foreach_lisp_gpe_ip_input_next          \
 _(DROP, "error-drop")                           \
 _(IP4_INPUT, "ip4-input")                       \
 _(IP6_INPUT, "ip6-input")                       \
 _(L2_INPUT, "l2-input")
 
-typedef enum {
+/** Enum of possible next nodes post LISP-GPE decap */
+typedef enum
+{
 #define _(s,n) LISP_GPE_INPUT_NEXT_##s,
   foreach_lisp_gpe_ip_input_next
 #undef _
-  LISP_GPE_INPUT_N_NEXT,
+    LISP_GPE_INPUT_N_NEXT,
 } lisp_gpe_input_next_t;
 
-typedef enum {
+typedef enum
+{
 #define lisp_gpe_error(n,s) LISP_GPE_ERROR_##n,
 #include <vnet/lisp-gpe/lisp_gpe_error.def>
 #undef lisp_gpe_error
   LISP_GPE_N_ERROR,
 } lisp_gpe_error_t;
 
-/* As a first step, reuse v4 fib. The goal of the typedef is to shield
- * consumers from future updates that may result in the lisp ip4 fib diverging
- * from ip4 fib */
-typedef ip4_fib_t ip4_src_fib_t;
-
-typedef struct ip6_src_fib
-{
-  BVT(clib_bihash) ip6_lookup_table;
-
-  /* bitmap/vector of mask widths to search */
-  uword * non_empty_dst_address_length_bitmap;
-  u8 * prefix_lengths_in_search_order;
-  ip6_address_t fib_masks[129];
-  i32 dst_address_length_refcounts[129];
-
-  /* ip6 lookup table config parameters */
-  u32 lookup_table_nbuckets;
-  uword lookup_table_size;
-} ip6_src_fib_t;
-
 typedef struct tunnel_lookup
 {
-  /* Lookup lisp-gpe interfaces by dp table (eg. vrf/bridge index) */
-  uword * hw_if_index_by_dp_table;
+  /** Lookup lisp-gpe interfaces by dp table (eg. vrf/bridge index) */
+  uword *hw_if_index_by_dp_table;
+
+  /** lookup decap tunnel termination sw_if_index by vni and vice versa */
+  uword *sw_if_index_by_vni;
 
-  /* lookup decap tunnel termination sw_if_index by vni and vice versa */
-  uword * sw_if_index_by_vni;
-  uword * vni_by_sw_if_index;
+  // FIXME - Need this?
+  uword *vni_by_sw_if_index;
 } tunnel_lookup_t;
 
+/** LISP-GPE global state*/
 typedef struct lisp_gpe_main
 {
-  /* pool of encap tunnel instances */
-  lisp_gpe_tunnel_t * tunnels;
+  /** pool of encap tunnel instances */
+  lisp_gpe_tunnel_t *tunnels;
 
-  /* lookup tunnel by key */
-  mhash_t lisp_gpe_tunnel_by_key;
-
-  /* Free vlib hw_if_indices */
-  u32 * free_tunnel_hw_if_indices;
+  /** Free vlib hw_if_indices */
+  u32 *free_tunnel_hw_if_indices;
 
   u8 is_en;
 
   /* L3 data structures
    * ================== */
-
-  /* Pool of src fibs that are paired with dst fibs */
-  ip4_src_fib_t * ip4_src_fibs;
-  ip6_src_fib_t * ip6_src_fibs;
-
   tunnel_lookup_t l3_ifaces;
 
-  /* Lookup lgpe_ipX_lookup_next by vrf */
-  uword * lgpe_ip4_lookup_next_index_by_table_id;
-  uword * lgpe_ip6_lookup_next_index_by_table_id;
-
-  /* next node indexes that point ip4/6 lookup to lisp gpe ip lookup */
-  u32 ip4_lookup_next_lgpe_ip4_lookup;
-  u32 ip6_lookup_next_lgpe_ip6_lookup;
-
   /* L2 data structures
    * ================== */
 
-  /* l2 lisp fib */
-  BVT(clib_bihash) l2_fib;
+  /** L2 LISP FIB */
+    BVT (clib_bihash) l2_fib;
 
   tunnel_lookup_t l2_ifaces;
 
-  /* convenience */
-  vlib_main_t * vlib_main;
-  vnet_main_t * vnet_main;
-  ip4_main_t * im4;
-  ip6_main_t * im6;
-  ip_lookup_main_t * lm4;
-  ip_lookup_main_t * lm6;
+  /** Load-balance for a miss in the table */
+  index_t l2_lb_miss;
+  index_t l2_lb_cp_lkup;
+
+  /** convenience */
+  vlib_main_t *vlib_main;
+  vnet_main_t *vnet_main;
+  ip4_main_t *im4;
+  ip6_main_t *im6;
+  ip_lookup_main_t *lm4;
+  ip_lookup_main_t *lm6;
 } lisp_gpe_main_t;
 
+/** LISP-GPE global state*/
 lisp_gpe_main_t lisp_gpe_main;
 
 always_inline lisp_gpe_main_t *
-vnet_lisp_gpe_get_main() {
+vnet_lisp_gpe_get_main ()
+{
   return &lisp_gpe_main;
 }
 
-extern vlib_node_registration_t lgpe_ip4_lookup_node;
-extern vlib_node_registration_t lgpe_ip6_lookup_node;
+
 extern vlib_node_registration_t lisp_gpe_ip4_input_node;
 extern vlib_node_registration_t lisp_gpe_ip6_input_node;
+extern vnet_hw_interface_class_t lisp_gpe_hw_class;
 
-u8 *
-format_lisp_gpe_header_with_length (u8 * s, va_list * args);
+u8 *format_lisp_gpe_header_with_length (u8 * s, va_list * args);
 
+/** Arguments to add an L2/L3 LISP-GPE interface*/
 typedef struct
 {
   u8 is_add;
   union
   {
-    /* vrf */
+    /** vrf */
     u32 table_id;
 
-    /* bridge domain */
+    /** bridge domain */
     u16 bd_id;
 
-    /* generic access */
+    /** generic access */
     u32 dp_table;
   };
   u8 is_l2;
-  u32 vni; /* host byte order */
+
+  /** virtual network identifier in host byte order */
+  u32 vni;
 } vnet_lisp_gpe_add_del_iface_args_t;
 
-u8
-vnet_lisp_gpe_enable_disable_status(void);
+/** Read LISP-GPE status */
+u8 vnet_lisp_gpe_enable_disable_status (void);
+
+/** Add/del LISP-GPE interface. */
 int
-vnet_lisp_gpe_add_del_iface (vnet_lisp_gpe_add_del_iface_args_t *a,
+vnet_lisp_gpe_add_del_iface (vnet_lisp_gpe_add_del_iface_args_t * a,
                             u32 * hw_if_indexp);
 
 typedef struct
@@ -231,53 +317,76 @@ typedef struct
   u8 is_en;
 } vnet_lisp_gpe_enable_disable_args_t;
 
-clib_error_t *
-vnet_lisp_gpe_enable_disable (vnet_lisp_gpe_enable_disable_args_t *a);
+clib_error_t
+  * vnet_lisp_gpe_enable_disable (vnet_lisp_gpe_enable_disable_args_t * a);
 
+/** */
 typedef struct
 {
   u8 is_add;
 
-  /* type of mapping */
+  /** type of mapping */
   u8 is_negative;
-  u8 action;
 
-  /* local and remote eids */
+  /** action for negative mappings */
+  negative_fwd_actions_e action;
+
+  /** local eid */
   gid_address_t lcl_eid;
+
+  /** remote eid */
   gid_address_t rmt_eid;
 
-  /* local and remote locators (underlay attachment points) */
-  ip_address_t lcl_loc;
-  ip_address_t rmt_loc;
+  /** vector of locator pairs */
+  locator_pair_t *locator_pairs;
 
-  /* FIB indices to lookup remote locator at encap and inner IP at decap */
+  /** FIB index to lookup remote locator at encap */
   u32 encap_fib_index;
+
+  /** FIB index to lookup inner IP at decap */
   u32 decap_fib_index;
 
-  u32 decap_next_index; /* TODO is this really needed? */
+  /* TODO remove */
+  u32 decap_next_index;
 
-  /* VNI/tenant id in HOST byte order */
+  /** VNI/tenant id in HOST byte order */
   u32 vni;
 
-  /* vrf or bd where fwd entry should be inserted */
+  /** vrf or bd where fwd entry should be inserted */
   union
   {
+    /** table (vrf) id */
     u32 table_id;
+
+    /** bridge domain id */
     u16 bd_id;
+
+    /** generic access */
+    u32 dp_table;
   };
 } vnet_lisp_gpe_add_del_fwd_entry_args_t;
 
 int
-vnet_lisp_gpe_add_del_fwd_entry (vnet_lisp_gpe_add_del_fwd_entry_args_t *a,
+vnet_lisp_gpe_add_del_fwd_entry (vnet_lisp_gpe_add_del_fwd_entry_args_t * a,
                                 u32 * hw_if_indexp);
 
-int
-ip_sd_fib_add_del_route (lisp_gpe_main_t * lgm, ip_prefix_t * dst_prefix,
-                         ip_prefix_t * src_prefix, u32 table_id,
-                         ip_adjacency_t * add_adj, u8 is_add);
-u32
-ip_sd_fib_get_route (lisp_gpe_main_t * lgm, ip_prefix_t * dst_prefix,
-                     ip_prefix_t * src_prefix, u32 table_id);
+extern void
+ip_src_fib_add_route (u32 src_fib_index,
+                     const ip_prefix_t * src_prefix,
+                     const lisp_fwd_path_t * paths);
+extern void
+ip_src_dst_fib_del_route (u32 src_fib_index,
+                         const ip_prefix_t * src_prefix,
+                         u32 dst_table_id, const ip_prefix_t * dst_prefix);
+extern void
+ip_src_fib_add_route_w_dpo (u32 src_fib_index,
+                           const ip_prefix_t * src_prefix,
+                           const dpo_id_t * src_dpo);
+extern u32
+ip_dst_fib_add_route (u32 dst_table_id, const ip_prefix_t * dst_prefix);
+
+extern fib_route_path_t *lisp_gpe_mk_paths_for_sub_tunnels (lisp_gpe_tunnel_t
+                                                           * t);
 
 #define foreach_lgpe_ip4_lookup_next    \
   _(DROP, "error-drop")                 \
@@ -288,10 +397,10 @@ typedef enum lgpe_ip4_lookup_next
 #define _(sym,str) LGPE_IP4_LOOKUP_NEXT_##sym,
   foreach_lgpe_ip4_lookup_next
 #undef _
-  LGPE_IP4_LOOKUP_N_NEXT,
+    LGPE_IP4_LOOKUP_N_NEXT,
 } lgpe_ip4_lookup_next_t;
 
-#define foreach_lgpe_ip6_lookup_next     \
+#define foreach_lgpe_ip6_lookup_next    \
   _(DROP, "error-drop")                 \
   _(LISP_CP_LOOKUP, "lisp-cp-lookup")
 
@@ -300,16 +409,24 @@ typedef enum lgpe_ip6_lookup_next
 #define _(sym,str) LGPE_IP6_LOOKUP_NEXT_##sym,
   foreach_lgpe_ip6_lookup_next
 #undef _
-  LGPE_IP6_LOOKUP_N_NEXT,
+    LGPE_IP6_LOOKUP_N_NEXT,
 } lgpe_ip6_lookup_next_t;
 
-u8 * format_vnet_lisp_gpe_status (u8 * s, va_list * args);
+u8 *format_vnet_lisp_gpe_status (u8 * s, va_list * args);
 
 #define L2_FIB_DEFAULT_HASH_NUM_BUCKETS (64 * 1024)
 #define L2_FIB_DEFAULT_HASH_MEMORY_SIZE (32<<20)
 
 u32
 lisp_l2_fib_lookup (lisp_gpe_main_t * lgm, u16 bd_index, u8 src_mac[8],
-                    u8 dst_mac[8]);
+                   u8 dst_mac[8]);
 
 #endif /* included_vnet_lisp_gpe_h */
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */