src/vnet/vxlan-gbp/vxlan_gbp.h

   1 /*
   2  * Copyright (c) 2018 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 #ifndef included_vnet_vxlan_gbp_h
  16 #define included_vnet_vxlan_gbp_h
  17
  18 #include <vppinfra/error.h>
  19 #include <vppinfra/hash.h>
  20 #include <vppinfra/bihash_16_8.h>
  21 #include <vppinfra/bihash_24_8.h>
  22 #include <vnet/vnet.h>
  23 #include <vnet/ip/ip.h>
  24 #include <vnet/l2/l2_input.h>
  25 #include <vnet/l2/l2_output.h>
  26 #include <vnet/l2/l2_bd.h>
  27 #include <vnet/ethernet/ethernet.h>
  28 #include <vnet/vxlan-gbp/vxlan_gbp_packet.h>
  29 #include <vnet/ip/ip4_packet.h>
  30 #include <vnet/ip/ip6_packet.h>
  31 #include <vnet/udp/udp_local.h>
  32 #include <vnet/udp/udp_packet.h>
  33 #include <vnet/dpo/dpo.h>
  34 #include <vnet/adj/adj_types.h>
  35
  36 /* *INDENT-OFF* */
  37 typedef CLIB_PACKED (struct {
  38   ip4_header_t ip4;     /* 20 bytes */
  39   udp_header_t udp;     /* 8 bytes */
  40   vxlan_gbp_header_t vxlan_gbp; /* 8 bytes */
  41 }) ip4_vxlan_gbp_header_t;
  42
  43 typedef CLIB_PACKED (struct {
  44   ip6_header_t ip6;     /* 40 bytes */
  45   udp_header_t udp;     /* 8 bytes */
  46   vxlan_gbp_header_t vxlan_gbp; /* 8 bytes */
  47 }) ip6_vxlan_gbp_header_t;
  48 /* *INDENT-ON* */
  49
  50 /*
  51 * Key fields: remote ip, vni on incoming VXLAN packet
  52 * all fields in NET byte order
  53 */
  54 typedef clib_bihash_kv_16_8_t vxlan4_gbp_tunnel_key_t;
  55
  56 /*
  57 * Key fields: remote ip, vni and fib index on incoming VXLAN packet
  58 * ip, vni fields in NET byte order
  59 * fib index field in host byte order
  60 */
  61 typedef clib_bihash_kv_24_8_t vxlan6_gbp_tunnel_key_t;
  62
  63 typedef enum vxlan_gbp_tunnel_mode_t_
  64 {
  65   VXLAN_GBP_TUNNEL_MODE_L2,
  66   VXLAN_GBP_TUNNEL_MODE_L3,
  67 } vxlan_gbp_tunnel_mode_t;
  68
  69 extern u8 *format_vxlan_gbp_tunnel_mode (u8 * s, va_list * args);
  70
  71 typedef struct
  72 {
  73   /* Required for pool_get_aligned */
  74   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  75
  76   /* FIB DPO for IP forwarding of VXLAN encap packet */
  77   dpo_id_t next_dpo;
  78
  79   /* flags */
  80   u16 flags;
  81
  82   /* vxlan VNI in HOST byte order */
  83   u32 vni;
  84
  85   /* tunnel src and dst addresses */
  86   ip46_address_t src;
  87   ip46_address_t dst;
  88
  89   /* mcast packet output intfc index (used only if dst is mcast) */
  90   u32 mcast_sw_if_index;
  91
  92   /* The FIB index for src/dst addresses */
  93   u32 encap_fib_index;
  94
  95   /* vnet intfc index */
  96   u32 sw_if_index;
  97   u32 hw_if_index;
  98
  99   /** Next node after VxLAN-GBP encap */
 100   uword encap_next_node;
 101
 102   /**
 103    * Tunnel mode.
 104    * L2 tunnels decap to L2 path, L3 tunnels to the L3 path
 105    */
 106   vxlan_gbp_tunnel_mode_t mode;
 107
 108   /**
 109    * Linkage into the FIB object graph
 110    */
 111   fib_node_t node;
 112
 113   /*
 114    * The FIB entry for (depending on VXLAN-GBP tunnel is unicast or mcast)
 115    * sending unicast VXLAN-GBP encap packets or receiving mcast VXLAN-GBP packets
 116    */
 117   fib_node_index_t fib_entry_index;
 118   adj_index_t mcast_adj_index;
 119
 120   /**
 121    * The tunnel is a child of the FIB entry for its destination. This is
 122    * so it receives updates when the forwarding information for that entry
 123    * changes.
 124    * The tunnels sibling index on the FIB entry's dependency list.
 125    */
 126   u32 sibling_index;
 127
 128   u32 dev_instance;             /* Real device instance in tunnel vector */
 129   u32 user_instance;            /* Instance name being shown to user */
 130
 131
 132     VNET_DECLARE_REWRITE;
 133 } vxlan_gbp_tunnel_t;
 134
 135 #define foreach_vxlan_gbp_input_next         \
 136   _(DROP, "error-drop")                      \
 137   _(PUNT, "punt-dispatch")                   \
 138   _(L2_INPUT, "l2-input")                    \
 139   _(IP4_INPUT, "ip4-input")                  \
 140   _(IP6_INPUT, "ip6-input")
 141
 142 typedef enum
 143 {
 144 #define _(s,n) VXLAN_GBP_INPUT_NEXT_##s,
 145   foreach_vxlan_gbp_input_next
 146 #undef _
 147     VXLAN_GBP_INPUT_N_NEXT,
 148 } vxlan_gbp_input_next_t;
 149
 150 typedef enum
 151 {
 152 #define vxlan_gbp_error(n,s) VXLAN_GBP_ERROR_##n,
 153 #include <vnet/vxlan-gbp/vxlan_gbp_error.def>
 154 #undef vxlan_gbp_error
 155   VXLAN_GBP_N_ERROR,
 156 } vxlan_gbp_input_error_t;
 157
 158 /**
 159  * Call back function packets that do not match a configured tunnel
 160  */
 161 typedef vxlan_gbp_input_next_t (*vxlan_bgp_no_tunnel_t) (vlib_buffer_t * b,
 162                                                          u32 thread_index,
 163                                                          u8 is_ip6);
 164
 165 typedef struct
 166 {
 167   /* vector of encap tunnel instances */
 168   vxlan_gbp_tunnel_t *tunnels;
 169
 170   /* lookup tunnel by key */
 171   clib_bihash_16_8_t vxlan4_gbp_tunnel_by_key;  /* keyed on ipv4.dst + fib + vni */
 172   clib_bihash_24_8_t vxlan6_gbp_tunnel_by_key;  /* keyed on ipv6.dst + fib + vni */
 173
 174   /* local VTEP IPs ref count used by vxlan-bypass node to check if
 175      received VXLAN packet DIP matches any local VTEP address */
 176   uword *vtep4;                 /* local ip4 VTEPs keyed on their ip4 addr */
 177   uword *vtep6;                 /* local ip6 VTEPs keyed on their ip6 addr */
 178
 179   /* mcast shared info */
 180   uword *mcast_shared;          /* keyed on mcast ip46 addr */
 181
 182   /* Mapping from sw_if_index to tunnel index */
 183   u32 *tunnel_index_by_sw_if_index;
 184
 185   /* On demand udp port registration */
 186   u32 udp_ports_registered;
 187
 188   /* convenience */
 189   vlib_main_t *vlib_main;
 190   vnet_main_t *vnet_main;
 191
 192   /* Record used instances */
 193   uword *instance_used;
 194
 195   /**
 196    * Punt reasons for no such tunnel
 197    */
 198   vlib_punt_reason_t punt_no_such_tunnel[FIB_PROTOCOL_IP_MAX];
 199 } vxlan_gbp_main_t;
 200
 201 extern vxlan_gbp_main_t vxlan_gbp_main;
 202
 203 extern vlib_node_registration_t vxlan4_gbp_input_node;
 204 extern vlib_node_registration_t vxlan6_gbp_input_node;
 205 extern vlib_node_registration_t vxlan4_gbp_encap_node;
 206 extern vlib_node_registration_t vxlan6_gbp_encap_node;
 207 extern void vxlan_gbp_register_udp_ports (void);
 208 extern void vxlan_gbp_unregister_udp_ports (void);
 209
 210 u8 *format_vxlan_gbp_encap_trace (u8 * s, va_list * args);
 211
 212 typedef struct
 213 {
 214   u8 is_add;
 215   u8 is_ip6;
 216   u32 instance;
 217   vxlan_gbp_tunnel_mode_t mode;
 218   ip46_address_t src, dst;
 219   u32 mcast_sw_if_index;
 220   u32 encap_fib_index;
 221   u32 vni;
 222 } vnet_vxlan_gbp_tunnel_add_del_args_t;
 223
 224 int vnet_vxlan_gbp_tunnel_add_del
 225   (vnet_vxlan_gbp_tunnel_add_del_args_t * a, u32 * sw_if_indexp);
 226 int vnet_vxlan_gbp_tunnel_del (u32 sw_if_indexp);
 227
 228 void vnet_int_vxlan_gbp_bypass_mode (u32 sw_if_index, u8 is_ip6,
 229                                      u8 is_enable);
 230
 231 always_inline u32
 232 vxlan_gbp_tunnel_by_sw_if_index (u32 sw_if_index)
 233 {
 234   vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
 235
 236   if (sw_if_index >= vec_len (vxm->tunnel_index_by_sw_if_index))
 237     return ~0;
 238
 239   return (vxm->tunnel_index_by_sw_if_index[sw_if_index]);
 240 }
 241
 242 #endif /* included_vnet_vxlan_gbp_h */
 243
 244 /*
 245  * fd.io coding-style-patch-verification: ON
 246  *
 247  * Local Variables:
 248  * eval: (c-set-style "gnu")
 249  * End:
 250  */