src/plugins/vxlan/vxlan.h

   1 /*
   2  * Copyright (c) 2015 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_h
  16 #define included_vnet_vxlan_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/ip/vtep.h>
  25 #include <vnet/l2/l2_input.h>
  26 #include <vnet/l2/l2_output.h>
  27 #include <vnet/l2/l2_bd.h>
  28 #include <vnet/ethernet/ethernet.h>
  29 #include <vxlan/vxlan_packet.h>
  30 #include <vnet/ip/ip4_packet.h>
  31 #include <vnet/ip/ip6_packet.h>
  32 #include <vnet/udp/udp_packet.h>
  33 #include <vnet/dpo/dpo.h>
  34 #include <vnet/adj/adj_types.h>
  35
  36 typedef CLIB_PACKED (struct {
  37   ip4_header_t ip4;     /* 20 bytes */
  38   udp_header_t udp;     /* 8 bytes */
  39   vxlan_header_t vxlan; /* 8 bytes */
  40 }) ip4_vxlan_header_t;
  41
  42 typedef CLIB_PACKED (struct {
  43   ip6_header_t ip6;     /* 40 bytes */
  44   udp_header_t udp;     /* 8 bytes */
  45   vxlan_header_t vxlan; /* 8 bytes */
  46 }) ip6_vxlan_header_t;
  47
  48 /*
  49 * Key fields: remote ip, vni on incoming VXLAN packet
  50 * all fields in NET byte order
  51 */
  52 typedef clib_bihash_kv_16_8_t vxlan4_tunnel_key_t;
  53
  54 /*
  55 * Key fields: remote ip, vni and fib index on incoming VXLAN packet
  56 * ip, vni fields in NET byte order
  57 * fib index field in host byte order
  58 */
  59 typedef clib_bihash_kv_24_8_t vxlan6_tunnel_key_t;
  60
  61 typedef union
  62 {
  63   struct
  64   {
  65     u32 sw_if_index;            /* unicast - input interface / mcast - stats interface */
  66     union
  67     {
  68       struct                    /* unicast action */
  69       {
  70         u16 next_index;
  71         u8 error;
  72       };
  73       ip4_address_t local_ip;   /* used as dst ip for mcast pkts to assign them to unicast tunnel */
  74     };
  75   };
  76   u64 as_u64;
  77 } vxlan_decap_info_t;
  78
  79 typedef struct
  80 {
  81   /* Required for pool_get_aligned */
  82   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  83
  84   /* FIB DPO for IP forwarding of VXLAN encap packet */
  85   dpo_id_t next_dpo;
  86
  87   /* vxlan VNI in HOST byte order */
  88   u32 vni;
  89
  90   /* tunnel src and dst addresses */
  91   ip46_address_t src;
  92   ip46_address_t dst;
  93
  94   /* udp-ports */
  95   u16 src_port;
  96   u16 dst_port;
  97
  98   /* mcast packet output intfc index (used only if dst is mcast) */
  99   u32 mcast_sw_if_index;
 100
 101   /* decap next index */
 102   u16 decap_next_index;
 103
 104   /* The FIB index for src/dst addresses */
 105   u32 encap_fib_index;
 106
 107   /* vnet intfc index */
 108   u32 sw_if_index;
 109   u32 hw_if_index;
 110
 111   /**
 112    * Linkage into the FIB object graph
 113    */
 114   fib_node_t node;
 115
 116   /*
 117    * The FIB entry for (depending on VXLAN tunnel is unicast or mcast)
 118    * sending unicast VXLAN encap packets or receiving mcast VXLAN packets
 119    */
 120   fib_node_index_t fib_entry_index;
 121   adj_index_t mcast_adj_index;
 122
 123   /**
 124    * The tunnel is a child of the FIB entry for its destination. This is
 125    * so it receives updates when the forwarding information for that entry
 126    * changes.
 127    * The tunnels sibling index on the FIB entry's dependency list.
 128    */
 129   u32 sibling_index;
 130
 131   u32 flow_index;               /* infra flow index */
 132   u32 dev_instance;             /* Real device instance in tunnel vector */
 133   u32 user_instance;            /* Instance name being shown to user */
 134
 135   VNET_DECLARE_REWRITE;
 136 } vxlan_tunnel_t;
 137
 138 #define foreach_vxlan_input_next        \
 139 _(DROP, "error-drop")                   \
 140 _(L2_INPUT, "l2-input")
 141
 142 typedef enum
 143 {
 144 #define _(s,n) VXLAN_INPUT_NEXT_##s,
 145   foreach_vxlan_input_next
 146 #undef _
 147     VXLAN_INPUT_N_NEXT,
 148 } vxlan_input_next_t;
 149
 150 typedef enum
 151 {
 152 #define vxlan_error(n,s) VXLAN_ERROR_##n,
 153 #include <vxlan/vxlan_error.def>
 154 #undef vxlan_error
 155   VXLAN_N_ERROR,
 156 } vxlan_input_error_t;
 157
 158 typedef struct
 159 {
 160   /* vector of encap tunnel instances */
 161   vxlan_tunnel_t *tunnels;
 162
 163   /* lookup tunnel by key */
 164   clib_bihash_16_8_t
 165     vxlan4_tunnel_by_key; /* keyed on ipv4.dst + src_port + fib + vni */
 166   clib_bihash_24_8_t
 167     vxlan6_tunnel_by_key; /* keyed on ipv6.dst + src_port + fib + vni */
 168
 169   /* local VTEP IPs ref count used by vxlan-bypass node to check if
 170      received VXLAN packet DIP matches any local VTEP address */
 171   vtep_table_t vtep_table;
 172
 173   /* mcast shared info */
 174   uword *mcast_shared;          /* keyed on mcast ip46 addr */
 175
 176   /* Mapping from sw_if_index to tunnel index */
 177   u32 *tunnel_index_by_sw_if_index;
 178
 179   /* graph node state */
 180   uword *bm_ip4_bypass_enabled_by_sw_if;
 181   uword *bm_ip6_bypass_enabled_by_sw_if;
 182
 183   /* convenience */
 184   vlib_main_t *vlib_main;
 185   vnet_main_t *vnet_main;
 186
 187   /* Record used instances */
 188   uword *instance_used;
 189   u32 flow_id_start;
 190
 191   /* cache for last 8 vxlan tunnel */
 192   vtep4_cache_t vtep4_u512;
 193
 194 } vxlan_main_t;
 195
 196 extern vxlan_main_t vxlan_main;
 197
 198 extern vlib_node_registration_t vxlan4_input_node;
 199 extern vlib_node_registration_t vxlan6_input_node;
 200 extern vlib_node_registration_t vxlan4_encap_node;
 201 extern vlib_node_registration_t vxlan6_encap_node;
 202 extern vlib_node_registration_t vxlan4_flow_input_node;
 203
 204 u8 *format_vxlan_encap_trace (u8 * s, va_list * args);
 205
 206 typedef struct
 207 {
 208   u8 is_add;
 209
 210   /* we normally use is_ip4, but since this adds to the
 211    * structure, this seems less of a breaking change */
 212   u8 is_ip6;
 213   u8 is_l3;
 214   u32 instance;
 215   ip46_address_t src, dst;
 216   u32 mcast_sw_if_index;
 217   u32 encap_fib_index;
 218   u32 decap_next_index;
 219   u32 vni;
 220   u16 src_port;
 221   u16 dst_port;
 222 } vnet_vxlan_add_del_tunnel_args_t;
 223
 224 int vnet_vxlan_add_del_tunnel
 225   (vnet_vxlan_add_del_tunnel_args_t * a, u32 * sw_if_indexp);
 226
 227 void vnet_int_vxlan_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable);
 228
 229 int vnet_vxlan_add_del_rx_flow (u32 hw_if_index, u32 t_imdex, int is_add);
 230
 231 u32 vnet_vxlan_get_tunnel_index (u32 sw_if_index);
 232 #endif /* included_vnet_vxlan_h */
 233
 234 /*
 235  * fd.io coding-style-patch-verification: ON
 236  *
 237  * Local Variables:
 238  * eval: (c-set-style "gnu")
 239  * End:
 240  */