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/ip4.h>
  22 #include <vnet/ip/ip6.h>
  23
  24 /**
  25  * @brief Tunnel endpoint key (IPv4)
  26  *
  27  * Tunnel modules maintain a set of vtep4_key_t-s to track local IP
  28  * addresses that have tunnels established.  Bypass node consults the
  29  * corresponding set to decide whether a packet should bypass normal
  30  * processing and go directly to the tunnel protocol handler node.
  31  */
  32
  33 /* *INDENT-OFF* */
  34 typedef CLIB_PACKED
  35 (struct {
  36   union {
  37     struct {
  38       ip4_address_t addr;
  39       u32 fib_index;
  40     };
  41     u64 as_u64;
  42   };
  43 }) vtep4_key_t;
  44 /* *INDENT-ON* */
  45
  46 /**
  47  * @brief Tunnel endpoint key (IPv6)
  48  *
  49  * Tunnel modules maintain a set of vtep6_key_t-s to track local IP
  50  * addresses that have tunnels established.  Bypass node consults the
  51  * corresponding set to decide whether a packet should bypass normal
  52  * processing and go directly to the tunnel protocol handler node.
  53  */
  54
  55 /* *INDENT-OFF* */
  56 typedef CLIB_PACKED
  57 (struct {
  58   ip6_address_t addr;
  59   u32 fib_index;
  60 }) vtep6_key_t;
  61 /* *INDENT-ON* */
  62
  63 typedef struct
  64 {
  65   uword *vtep4;                 /* local ip4 VTEPs keyed on their ip4 addr + fib_index */
  66   uword *vtep6;                 /* local ip6 VTEPs keyed on their ip6 addr + fib_index */
  67 } vtep_table_t;
  68
  69 always_inline vtep_table_t
  70 vtep_table_create ()
  71 {
  72   vtep_table_t t = { };
  73   t.vtep6 = hash_create_mem (0, sizeof (vtep6_key_t), sizeof (uword));
  74   return t;
  75 }
  76
  77 uword vtep_addr_ref (vtep_table_t * t, u32 fib_index, ip46_address_t * ip);
  78 uword vtep_addr_unref (vtep_table_t * t, u32 fib_index, ip46_address_t * ip);
  79
  80 always_inline void
  81 vtep4_key_init (vtep4_key_t * k4)
  82 {
  83   k4->as_u64 = ~((u64) 0);
  84 }
  85
  86 always_inline void
  87 vtep6_key_init (vtep6_key_t * k6)
  88 {
  89   ip6_address_set_zero (&k6->addr);
  90   k6->fib_index = (u32) ~ 0;
  91 }
  92
  93 enum
  94 {
  95   VTEP_CHECK_FAIL = 0,
  96   VTEP_CHECK_PASS = 1,
  97   VTEP_CHECK_PASS_UNCHANGED = 2
  98 };
  99
 100 always_inline u8
 101 vtep4_check (vtep_table_t * t, vlib_buffer_t * b0, ip4_header_t * ip40,
 102              vtep4_key_t * last_k4)
 103 {
 104   vtep4_key_t k4;
 105   k4.addr.as_u32 = ip40->dst_address.as_u32;
 106   k4.fib_index = vlib_buffer_get_ip4_fib_index (b0);
 107   if (PREDICT_TRUE (k4.as_u64 == last_k4->as_u64))
 108     return VTEP_CHECK_PASS_UNCHANGED;
 109   if (PREDICT_FALSE (!hash_get (t->vtep4, k4.as_u64)))
 110     return VTEP_CHECK_FAIL;
 111   last_k4->as_u64 = k4.as_u64;
 112   return VTEP_CHECK_PASS;
 113 }
 114
 115 always_inline u8
 116 vtep6_check (vtep_table_t * t, vlib_buffer_t * b0, ip6_header_t * ip60,
 117              vtep6_key_t * last_k6)
 118 {
 119   vtep6_key_t k6;
 120   k6.fib_index = vlib_buffer_get_ip6_fib_index (b0);
 121   if (PREDICT_TRUE (k6.fib_index == last_k6->fib_index
 122                     && ip60->dst_address.as_u64[0] == last_k6->addr.as_u64[0]
 123                     && ip60->dst_address.as_u64[1] ==
 124                     last_k6->addr.as_u64[1]))
 125     {
 126       return VTEP_CHECK_PASS_UNCHANGED;
 127     }
 128   k6.addr = ip60->dst_address;
 129   if (PREDICT_FALSE (!hash_get_mem (t->vtep6, &k6)))
 130     return VTEP_CHECK_FAIL;
 131   *last_k6 = k6;
 132   return VTEP_CHECK_PASS;
 133 }
 134 #endif /* included_ip_vtep_h */
 135
 136 /*
 137  * fd.io coding-style-patch-verification: ON
 138  *
 139  * Local Variables:
 140  * eval: (c-set-style "gnu")
 141  * End:
 142  */