src/vnet/ip/vtep.h

   1 /*
   2  * Copyright (c) 2020 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #ifndef included_ip_vtep_h
  17 #define included_ip_vtep_h
  18
  19 #include <vppinfra/hash.h>
  20 #include <vnet/ip/ip.h>
  21 #include <vnet/ip/ip46_address.h>
  22
  23 /**
  24  * @brief Tunnel endpoint key (IPv4)
  25  *
  26  * Tunnel modules maintain a set of vtep4_key_t-s to track local IP
  27  * addresses that have tunnels established.  Bypass node consults the
  28  * corresponding set to decide whether a packet should bypass normal
  29  * processing and go directly to the tunnel protocol handler node.
  30  */
  31
  32 typedef CLIB_PACKED
  33 (struct {
  34   union {
  35     struct {
  36       ip4_address_t addr;
  37       u32 fib_index;
  38     };
  39     u64 as_u64;
  40   };
  41 }) vtep4_key_t;
  42
  43 /**
  44  * @brief Tunnel endpoint key (IPv6)
  45  *
  46  * Tunnel modules maintain a set of vtep6_key_t-s to track local IP
  47  * addresses that have tunnels established.  Bypass node consults the
  48  * corresponding set to decide whether a packet should bypass normal
  49  * processing and go directly to the tunnel protocol handler node.
  50  */
  51
  52 typedef CLIB_PACKED
  53 (struct {
  54   ip6_address_t addr;
  55   u32 fib_index;
  56 }) vtep6_key_t;
  57
  58 typedef struct
  59 {
  60   uword *vtep4;                 /* local ip4 VTEPs keyed on their ip4 addr + fib_index */
  61   uword *vtep6;                 /* local ip6 VTEPs keyed on their ip6 addr + fib_index */
  62 } vtep_table_t;
  63
  64 always_inline vtep_table_t
  65 vtep_table_create ()
  66 {
  67   vtep_table_t t = { };
  68   t.vtep6 = hash_create_mem (0, sizeof (vtep6_key_t), sizeof (uword));
  69   return t;
  70 }
  71
  72 uword vtep_addr_ref (vtep_table_t * t, u32 fib_index, ip46_address_t * ip);
  73 uword vtep_addr_unref (vtep_table_t * t, u32 fib_index, ip46_address_t * ip);
  74
  75 always_inline void
  76 vtep4_key_init (vtep4_key_t * k4)
  77 {
  78   k4->as_u64 = ~((u64) 0);
  79 }
  80
  81 always_inline void
  82 vtep6_key_init (vtep6_key_t * k6)
  83 {
  84   ip6_address_set_zero (&k6->addr);
  85   k6->fib_index = (u32) ~ 0;
  86 }
  87
  88 enum
  89 {
  90   VTEP_CHECK_FAIL = 0,
  91   VTEP_CHECK_PASS = 1,
  92   VTEP_CHECK_PASS_UNCHANGED = 2
  93 };
  94
  95 always_inline u8
  96 vtep4_check (vtep_table_t * t, vlib_buffer_t * b0, ip4_header_t * ip40,
  97              vtep4_key_t * last_k4)
  98 {
  99   vtep4_key_t k4;
 100   k4.addr.as_u32 = ip40->dst_address.as_u32;
 101   k4.fib_index = vlib_buffer_get_ip4_fib_index (b0);
 102   if (PREDICT_TRUE (k4.as_u64 == last_k4->as_u64))
 103     return VTEP_CHECK_PASS_UNCHANGED;
 104   if (PREDICT_FALSE (!hash_get (t->vtep4, k4.as_u64)))
 105     return VTEP_CHECK_FAIL;
 106   last_k4->as_u64 = k4.as_u64;
 107   return VTEP_CHECK_PASS;
 108 }
 109
 110 typedef struct
 111 {
 112   vtep4_key_t vtep4_cache[8];
 113   int idx;
 114 } vtep4_cache_t;
 115
 116 #ifdef CLIB_HAVE_VEC512
 117 always_inline u8
 118 vtep4_check_vector (vtep_table_t * t, vlib_buffer_t * b0, ip4_header_t * ip40,
 119                     vtep4_key_t * last_k4, vtep4_cache_t * vtep4_u512)
 120 {
 121   vtep4_key_t k4;
 122   k4.addr.as_u32 = ip40->dst_address.as_u32;
 123   k4.fib_index = vlib_buffer_get_ip4_fib_index (b0);
 124
 125   if (PREDICT_TRUE (k4.as_u64 == last_k4->as_u64))
 126     return VTEP_CHECK_PASS_UNCHANGED;
 127
 128   u64x8 k4_u64x8 = u64x8_splat (k4.as_u64);
 129   u64x8 cache = u64x8_load_unaligned (vtep4_u512->vtep4_cache);
 130   u8 result = u64x8_is_equal_mask (cache, k4_u64x8);
 131   if (PREDICT_TRUE (result != 0))
 132     {
 133       last_k4->as_u64 =
 134         vtep4_u512->vtep4_cache[count_trailing_zeros (result)].as_u64;
 135       return VTEP_CHECK_PASS_UNCHANGED;
 136     }
 137
 138   if (PREDICT_FALSE (!hash_get (t->vtep4, k4.as_u64)))
 139     return VTEP_CHECK_FAIL;
 140
 141   vtep4_u512->vtep4_cache[vtep4_u512->idx].as_u64 = k4.as_u64;
 142   vtep4_u512->idx = (vtep4_u512->idx + 1) & 0x7;
 143
 144   last_k4->as_u64 = k4.as_u64;
 145
 146   return VTEP_CHECK_PASS;
 147 }
 148 #endif
 149
 150 always_inline u8
 151 vtep6_check (vtep_table_t * t, vlib_buffer_t * b0, ip6_header_t * ip60,
 152              vtep6_key_t * last_k6)
 153 {
 154   vtep6_key_t k6;
 155   k6.fib_index = vlib_buffer_get_ip6_fib_index (b0);
 156   if (PREDICT_TRUE (k6.fib_index == last_k6->fib_index
 157                     && ip60->dst_address.as_u64[0] == last_k6->addr.as_u64[0]
 158                     && ip60->dst_address.as_u64[1] ==
 159                     last_k6->addr.as_u64[1]))
 160     {
 161       return VTEP_CHECK_PASS_UNCHANGED;
 162     }
 163   k6.addr = ip60->dst_address;
 164   if (PREDICT_FALSE (!hash_get_mem (t->vtep6, &k6)))
 165     return VTEP_CHECK_FAIL;
 166   *last_k6 = k6;
 167   return VTEP_CHECK_PASS;
 168 }
 169 #endif /* included_ip_vtep_h */
 170
 171 /*
 172  * fd.io coding-style-patch-verification: ON
 173  *
 174  * Local Variables:
 175  * eval: (c-set-style "gnu")
 176  * End:
 177  */