IPv6 HBH: Refactor code. Separate out RFC2460 HBH handling and the more experimental

[vpp.git] / vnet / vnet / ip / ip6.h

diff --git a/vnet/vnet/ip/ip6.h b/vnet/vnet/ip/ip6.h
index b104359..b0384d3 100644 (file)
--- a/vnet/vnet/ip/ip6.h
+++ b/vnet/vnet/ip/ip6.h
@@ -42,8 +42,9 @@
 
 #include <vlib/mc.h>
 #include <vnet/ip/ip6_packet.h>
+#include <vnet/ip/ip6_hop_by_hop_packet.h>
 #include <vnet/ip/lookup.h>
-
+#include <stdbool.h>
 #include <vppinfra/bihash_24_8.h>
 #include <vppinfra/bihash_template.h>
 
@@ -176,6 +177,9 @@ typedef struct ip6_main_t {
 
     u8 pad[3];
   } host_config;
+
+  /* HBH processing enabled? */
+  u8 hbh_enabled;
 } ip6_main_t;
 
 /* Global ip6 main structure. */
@@ -204,6 +208,29 @@ typedef union {
 u32 ip6_fib_lookup (ip6_main_t * im, u32 sw_if_index, ip6_address_t * dst);
 u32 ip6_fib_lookup_with_table (ip6_main_t * im, u32 fib_index, 
                                ip6_address_t * dst);
+
+/**
+ * \brief Get or create an IPv6 fib.
+ *
+ * Get or create an IPv6 fib with the provided fib ID or index.
+ * The fib ID is a possibly-sparse user-defined value while
+ * the fib index defines the position of the fib in the fib vector.
+ *
+ * \param im
+ *      ip6_main pointer.
+ * \param table_index_or_id
+ *      The table index if \c IP6_ROUTE_FLAG_FIB_INDEX bit is set in \p flags.
+ *      Otherwise, when set to \c ~0, an arbitrary and unused fib ID is picked
+ *      and can be retrieved with \c ret->table_id.
+ *      Otherwise, it is the fib ID to be used to retrieve or create the desired fib.
+ * \param flags
+ *      Indicates whether \p table_index_or_id is the fib index or ID.
+ *      When the bit \c IP6_ROUTE_FLAG_FIB_INDEX is set, \p table_index_or_id
+ *      is considered as the fib index, and the fib ID otherwise.
+ * \return A pointer to the retrieved or created fib.
+ *
+ * \remark When getting a fib with the fib index, the fib MUST already exist.
+ */
 ip6_fib_t * find_ip6_fib_by_table_index_or_id (ip6_main_t * im, 
                                                u32 table_index_or_id, 
                                                u32 flags);
@@ -498,4 +525,23 @@ ip6_compute_flow_hash (ip6_header_t * ip, u32 flow_hash_config)
     return (u32) c;
 }
 
+/*
+ * Hop-by-Hop handling
+ */
+typedef struct {
+  /* Array of function pointers to HBH option handling routines */
+  int (*options[256])(vlib_buffer_t *b, ip6_header_t *ip, ip6_hop_by_hop_option_t *opt);
+  u8 *(*trace[256])(u8 *s, ip6_hop_by_hop_option_t *opt);
+} ip6_hop_by_hop_main_t;
+
+extern ip6_hop_by_hop_main_t ip6_hop_by_hop_main;
+
+int ip6_hbh_register_option (u8 option,
+                            int options(vlib_buffer_t *b, ip6_header_t *ip, ip6_hop_by_hop_option_t *opt),
+                            u8 *trace(u8 *s, ip6_hop_by_hop_option_t *opt));
+int ip6_hbh_unregister_option (u8 option);
+
+/* Flag used by IOAM code. Classifier sets it pop-hop-by-hop checks it */
+#define OI_DECAP   100
+
 #endif /* included_ip_ip6_h */