ipip: Tunnel flags controlling copying data to/from payload/encap
[vpp.git] / src / vnet / ip / ip6_packet.h
index b8f8d6e..8c06984 100644 (file)
@@ -67,8 +67,15 @@ typedef CLIB_PACKED (struct {
 }) ip6_address_fib_t;
 /* *INDENT-ON* */
 
+typedef enum
+{
+  IP46_TYPE_ANY,
+  IP46_TYPE_IP4,
+  IP46_TYPE_IP6
+} ip46_type_t;
+
 /* *INDENT-OFF* */
-typedef CLIB_PACKED (union {
+typedef CLIB_PACKED (union ip46_address_t_ {
   struct {
     u32 pad[3];
     ip4_address_t ip4;
@@ -88,6 +95,35 @@ typedef CLIB_PACKED (union {
                                          && ((a1)->as_u64[1] == (a2)->as_u64[1]))
 #define ip46_address_initializer {{{ 0 }}}
 
+static_always_inline int
+ip46_address_is_equal_v4 (const ip46_address_t * ip46,
+                         const ip4_address_t * ip4)
+{
+  return (ip46->ip4.as_u32 == ip4->as_u32);
+}
+
+static_always_inline int
+ip46_address_is_equal_v6 (const ip46_address_t * ip46,
+                         const ip6_address_t * ip6)
+{
+  return ((ip46->ip6.as_u64[0] == ip6->as_u64[0]) &&
+         (ip46->ip6.as_u64[1] == ip6->as_u64[1]));
+}
+
+static_always_inline void
+ip46_address_copy (ip46_address_t * dst, const ip46_address_t * src)
+{
+  dst->as_u64[0] = src->as_u64[0];
+  dst->as_u64[1] = src->as_u64[1];
+}
+
+static_always_inline void
+ip46_address_set_ip6 (ip46_address_t * dst, const ip6_address_t * src)
+{
+  dst->as_u64[0] = src->as_u64[0];
+  dst->as_u64[1] = src->as_u64[1];
+}
+
 always_inline ip46_address_t
 to_ip46 (u32 is_ipv6, u8 * buf)
 {
@@ -101,8 +137,8 @@ to_ip46 (u32 is_ipv6, u8 * buf)
 
 
 always_inline void
-ip6_addr_fib_init (ip6_address_fib_t * addr_fib, ip6_address_t * address,
-                  u32 fib_index)
+ip6_addr_fib_init (ip6_address_fib_t * addr_fib,
+                  const ip6_address_t * address, u32 fib_index)
 {
   addr_fib->ip6_addr = *address;
   addr_fib->fib_index = fib_index;
@@ -148,18 +184,25 @@ typedef enum
 } ip6_multicast_link_local_group_id_t;
 
 always_inline uword
-ip6_address_is_multicast (ip6_address_t * a)
+ip6_address_is_multicast (const ip6_address_t * a)
 {
   return a->as_u8[0] == 0xff;
 }
 
 always_inline uword
-ip46_address_is_multicast (ip46_address_t * a)
+ip46_address_is_multicast (const ip46_address_t * a)
 {
   return ip46_address_is_ip4 (a) ? ip4_address_is_multicast (&a->ip4) :
     ip6_address_is_multicast (&a->ip6);
 }
 
+always_inline void
+ip6_address_copy (ip6_address_t * dst, const ip6_address_t * src)
+{
+  dst->as_u64[0] = src->as_u64[0];
+  dst->as_u64[1] = src->as_u64[1];
+}
+
 always_inline void
 ip6_set_reserved_multicast_address (ip6_address_t * a,
                                    ip6_multicast_address_scope_t scope,
@@ -182,23 +225,6 @@ ip6_set_solicited_node_multicast_address (ip6_address_t * a, u32 id)
   a->as_u32[3] = clib_host_to_net_u32 (id);
 }
 
-always_inline void
-ip6_link_local_address_from_ethernet_address (ip6_address_t * a,
-                                             u8 * ethernet_address)
-{
-  a->as_u64[0] = a->as_u64[1] = 0;
-  a->as_u16[0] = clib_host_to_net_u16 (0xfe80);
-  /* Always set locally administered bit (6). */
-  a->as_u8[0x8] = ethernet_address[0] | (1 << 6);
-  a->as_u8[0x9] = ethernet_address[1];
-  a->as_u8[0xa] = ethernet_address[2];
-  a->as_u8[0xb] = 0xff;
-  a->as_u8[0xc] = 0xfe;
-  a->as_u8[0xd] = ethernet_address[3];
-  a->as_u8[0xe] = ethernet_address[4];
-  a->as_u8[0xf] = ethernet_address[5];
-}
-
 always_inline void
 ip6_multicast_ethernet_address (u8 * ethernet_address, u32 group_id)
 {
@@ -211,7 +237,7 @@ ip6_multicast_ethernet_address (u8 * ethernet_address, u32 group_id)
 }
 
 always_inline uword
-ip6_address_is_equal (ip6_address_t * a, ip6_address_t * b)
+ip6_address_is_equal (const ip6_address_t * a, const ip6_address_t * b)
 {
   int i;
   for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
@@ -221,8 +247,9 @@ ip6_address_is_equal (ip6_address_t * a, ip6_address_t * b)
 }
 
 always_inline uword
-ip6_address_is_equal_masked (ip6_address_t * a, ip6_address_t * b,
-                            ip6_address_t * mask)
+ip6_address_is_equal_masked (const ip6_address_t * a,
+                            const ip6_address_t * b,
+                            const ip6_address_t * mask)
 {
   int i;
   for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
@@ -238,7 +265,7 @@ ip6_address_is_equal_masked (ip6_address_t * a, ip6_address_t * b,
 }
 
 always_inline void
-ip6_address_mask (ip6_address_t * a, ip6_address_t * mask)
+ip6_address_mask (ip6_address_t * a, const ip6_address_t * mask)
 {
   int i;
   for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
@@ -258,7 +285,7 @@ ip6_address_mask_from_width (ip6_address_t * a, u32 width)
 {
   int i, byte, bit, bitnum;
   ASSERT (width <= 128);
-  memset (a, 0, sizeof (a[0]));
+  clib_memset (a, 0, sizeof (a[0]));
   for (i = 0; i < width; i++)
     {
       bitnum = (7 - (i & 7));
@@ -269,7 +296,7 @@ ip6_address_mask_from_width (ip6_address_t * a, u32 width)
 }
 
 always_inline uword
-ip6_address_is_zero (ip6_address_t * a)
+ip6_address_is_zero (const ip6_address_t * a)
 {
   int i;
   for (i = 0; i < ARRAY_LEN (a->as_uword); i++)
@@ -280,21 +307,18 @@ ip6_address_is_zero (ip6_address_t * a)
 
 /* Check for unspecified address ::0 */
 always_inline uword
-ip6_address_is_unspecified (ip6_address_t * a)
+ip6_address_is_unspecified (const ip6_address_t * a)
 {
   return ip6_address_is_zero (a);
 }
 
 /* Check for loopback address ::1 */
 always_inline uword
-ip6_address_is_loopback (ip6_address_t * a)
+ip6_address_is_loopback (const ip6_address_t * a)
 {
-  uword is_loopback;
-  u8 save = a->as_u8[15];
-  a->as_u8[15] = save ^ 1;
-  is_loopback = ip6_address_is_zero (a);
-  a->as_u8[15] = save;
-  return is_loopback;
+  return (a->as_u64[0] == 0 &&
+         a->as_u32[2] == 0 &&
+         a->as_u16[6] == 0 && a->as_u8[14] == 0 && a->as_u8[15] == 1);
 }
 
 /* Check for link local unicast fe80::/10. */
@@ -306,21 +330,21 @@ ip6_address_is_link_local_unicast (const ip6_address_t * a)
 
 /* Check for unique local unicast fc00::/7. */
 always_inline uword
-ip6_address_is_local_unicast (ip6_address_t * a)
+ip6_address_is_local_unicast (const ip6_address_t * a)
 {
   return (a->as_u8[0] & 0xfe) == 0xfc;
 }
 
 /* Check for unique global unicast 2000::/3. */
 always_inline uword
-ip6_address_is_global_unicast (ip6_address_t * a)
+ip6_address_is_global_unicast (const ip6_address_t * a)
 {
   return (a->as_u8[0] & 0xe0) == 0x20;
 }
 
 /* Check for solicited node multicast 0xff02::1:ff00:0/104 */
 always_inline uword
-ip6_is_solicited_node_multicast_address (ip6_address_t * a)
+ip6_is_solicited_node_multicast_address (const ip6_address_t * a)
 {
   return (a->as_u32[0] == clib_host_to_net_u32 (0xff020000)
          && a->as_u32[1] == 0
@@ -328,6 +352,18 @@ ip6_is_solicited_node_multicast_address (ip6_address_t * a)
          && a->as_u8[12] == 0xff);
 }
 
+always_inline u32
+ip6_address_hash_to_u32 (const ip6_address_t * a)
+{
+  return (a->as_u32[0] ^ a->as_u32[1] ^ a->as_u32[2] ^ a->as_u32[3]);
+}
+
+always_inline u64
+ip6_address_hash_to_u64 (const ip6_address_t * a)
+{
+  return (a->as_u64[0] ^ a->as_u64[1]);
+}
+
 typedef struct
 {
   /* 4 bit version, 8 bit traffic class and 20 bit flow label. */
@@ -347,21 +383,35 @@ typedef struct
   ip6_address_t src_address, dst_address;
 } ip6_header_t;
 
-always_inline u8
+always_inline ip_dscp_t
 ip6_traffic_class (const ip6_header_t * i)
 {
   return (i->ip_version_traffic_class_and_flow_label & 0x0FF00000) >> 20;
 }
 
-static_always_inline u8
+static_always_inline ip_dscp_t
 ip6_traffic_class_network_order (const ip6_header_t * ip6)
 {
   return (clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label)
          & 0x0ff00000) >> 20;
 }
 
+static_always_inline ip_dscp_t
+ip6_dscp_network_order (const ip6_header_t * ip6)
+{
+  return (clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label)
+         & 0x0fc00000) >> 22;
+}
+
+static_always_inline ip_ecn_t
+ip6_ecn_network_order (const ip6_header_t * ip6)
+{
+  return (clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label)
+         & 0x00300000) >> 20;
+}
+
 static_always_inline void
-ip6_set_traffic_class_network_order (ip6_header_t * ip6, u8 dscp)
+ip6_set_traffic_class_network_order (ip6_header_t * ip6, ip_dscp_t dscp)
 {
   u32 tmp =
     clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label);
@@ -370,6 +420,26 @@ ip6_set_traffic_class_network_order (ip6_header_t * ip6, u8 dscp)
   ip6->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32 (tmp);
 }
 
+static_always_inline void
+ip6_set_dscp_network_order (ip6_header_t * ip6, ip_dscp_t dscp)
+{
+  u32 tmp =
+    clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label);
+  tmp &= 0xf03fffff;
+  tmp |= (dscp << 22);
+  ip6->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32 (tmp);
+}
+
+static_always_inline void
+ip6_set_ecn_network_order (ip6_header_t * ip6, ip_ecn_t ecn)
+{
+  u32 tmp =
+    clib_net_to_host_u32 (ip6->ip_version_traffic_class_and_flow_label);
+  tmp &= 0xffcfffff;
+  tmp |= (ecn << 20);
+  ip6->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32 (tmp);
+}
+
 always_inline void *
 ip6_next_header (ip6_header_t * i)
 {
@@ -474,54 +544,118 @@ typedef CLIB_PACKED (struct {
   /* Length of this header plus option data in 8 byte units. */
   u8 n_data_u64s;
 }) ip6_ext_header_t;
+/* *INDENT-ON* */
+
+#define foreach_ext_hdr_type \
+  _(IP6_HOP_BY_HOP_OPTIONS) \
+  _(IPV6_ROUTE) \
+  _(IPV6_FRAGMENTATION) \
+  _(IPSEC_ESP) \
+  _(IPSEC_AH) \
+  _(IP6_DESTINATION_OPTIONS) \
+  _(MOBILITY) \
+  _(HIP) \
+  _(SHIM6)
 
-always_inline u8 ip6_ext_hdr(u8 nexthdr)
+always_inline u8
+ip6_ext_hdr (u8 nexthdr)
 {
+#ifdef CLIB_HAVE_VEC128
+  static const u8x16 ext_hdr_types = {
+#define _(x) IP_PROTOCOL_##x,
+    foreach_ext_hdr_type
+#undef _
+  };
+
+  return !u8x16_is_all_zero (ext_hdr_types == u8x16_splat (nexthdr));
+#else
   /*
    * find out if nexthdr is an extension header or a protocol
    */
-  return   (nexthdr == IP_PROTOCOL_IP6_HOP_BY_HOP_OPTIONS) ||
-    (nexthdr == IP_PROTOCOL_IPV6_FRAGMENTATION)  ||
-    (nexthdr == IP_PROTOCOL_IPSEC_AH)      ||
-    (nexthdr == IP_PROTOCOL_IPV6_ROUTE)      ||
-    (nexthdr == IP_PROTOCOL_IP6_DESTINATION_OPTIONS);
+  return 0
+#define _(x) || (nexthdr == IP_PROTOCOL_##x)
+    foreach_ext_hdr_type;
+#undef _
+#endif
 }
 
 #define ip6_ext_header_len(p)  ((((ip6_ext_header_t *)(p))->n_data_u64s+1) << 3)
 #define ip6_ext_authhdr_len(p) ((((ip6_ext_header_t *)(p))->n_data_u64s+2) << 2)
 
 always_inline void *
-ip6_ext_next_header (ip6_ext_header_t *ext_hdr )
-{ return (void *)((u8 *) ext_hdr + ip6_ext_header_len(ext_hdr)); }
+ip6_ext_next_header (ip6_ext_header_t * ext_hdr)
+{
+  return (void *) ((u8 *) ext_hdr + ip6_ext_header_len (ext_hdr));
+}
+
+always_inline int
+vlib_object_within_buffer_data (vlib_main_t * vm, vlib_buffer_t * b,
+                               void *obj, size_t len)
+{
+  u8 *o = obj;
+  if (o < b->data ||
+      o + len > b->data + vlib_buffer_get_default_data_size (vm))
+    return 0;
+  return 1;
+}
 
 /*
- * Macro to find the IPv6 ext header of type t
- * I is the IPv6 header
- * P is the previous IPv6 ext header (NULL if none)
- * M is the matched IPv6 ext header of type t
+ * find ipv6 extension header within ipv6 header within buffer b
+ *
+ * @param vm
+ * @param b buffer to limit search to
+ * @param ip6_header ipv6 header
+ * @param header_type extension header type to search for
+ * @param[out] prev_ext_header address of header preceding found header
  */
-#define ip6_ext_header_find_t(i, p, m, t)               \
-if ((i)->protocol == t)                                 \
-{                                                       \
-  (m) = (void *)((i)+1);                                \
-  (p) = NULL;                                           \
-}                                                       \
-else                                                    \
-{                                                       \
-  (m) = NULL;                                           \
-  (p) = (void *)((i)+1);                                \
-  while (ip6_ext_hdr((p)->next_hdr) &&                  \
-    ((ip6_ext_header_t *)(p))->next_hdr != (t))         \
-  {                                                     \
-    (p) = ip6_ext_next_header((p));                     \
-  }                                                     \
-  if ( ((p)->next_hdr) == (t))                          \
-  {                                                     \
-    (m) = (void *)(ip6_ext_next_header((p)));           \
-  }                                                     \
+always_inline void *
+ip6_ext_header_find (vlib_main_t * vm, vlib_buffer_t * b,
+                    ip6_header_t * ip6_header, u8 header_type,
+                    ip6_ext_header_t ** prev_ext_header)
+{
+  ip6_ext_header_t *prev = NULL;
+  ip6_ext_header_t *result = NULL;
+  if ((ip6_header)->protocol == header_type)
+    {
+      result = (void *) (ip6_header + 1);
+      if (!vlib_object_within_buffer_data (vm, b, result,
+                                          ip6_ext_header_len (result)))
+       {
+         result = NULL;
+       }
+    }
+  else
+    {
+      result = NULL;
+      prev = (void *) (ip6_header + 1);
+      while (ip6_ext_hdr (prev->next_hdr) && prev->next_hdr != header_type)
+       {
+         prev = ip6_ext_next_header (prev);
+         if (!vlib_object_within_buffer_data (vm, b, prev,
+                                              ip6_ext_header_len (prev)))
+           {
+             prev = NULL;
+             break;
+           }
+       }
+      if (prev && (prev->next_hdr == header_type))
+       {
+         result = ip6_ext_next_header (prev);
+         if (!vlib_object_within_buffer_data (vm, b, result,
+                                              ip6_ext_header_len (result)))
+           {
+             result = NULL;
+           }
+       }
+    }
+  if (prev_ext_header)
+    {
+      *prev_ext_header = prev;
+    }
+  return result;
 }
 
-
+/* *INDENT-OFF* */
 typedef CLIB_PACKED (struct {
   u8 next_hdr;
   /* Length of this header plus option data in 8 byte units. */