src/vnet/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/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/vxlan_packet.h>
  29 #include <vnet/ip/ip4_packet.h>
  30 #include <vnet/ip/ip6_packet.h>
  31 #include <vnet/udp/udp.h>
  32 #include <vnet/dpo/dpo.h>
  33 #include <vnet/adj/adj_types.h>
  34
  35 /* *INDENT-OFF* */
  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 /* *INDENT-ON* */
  48
  49 /*
  50 * Key fields: remote ip, vni on incoming VXLAN packet
  51 * all fields in NET byte order
  52 */
  53 typedef clib_bihash_kv_16_8_t vxlan4_tunnel_key_t;
  54
  55 /*
  56 * Key fields: remote ip, vni and fib index on incoming VXLAN packet
  57 * ip, vni fields in NET byte order
  58 * fib index field in host byte order
  59 */
  60 typedef clib_bihash_kv_24_8_t vxlan6_tunnel_key_t;
  61
  62 typedef union
  63 {
  64   struct
  65   {
  66     u32 sw_if_index;            /* unicast - input interface / mcast - stats interface */
  67     union
  68     {
  69       struct                    /* unicast action */
  70       {
  71         u16 next_index;
  72         u8 error;
  73       };
  74       ip4_address_t local_ip;   /* used as dst ip for mcast pkts to assign them to unicast tunnel */
  75     };
  76   };
  77   u64 as_u64;
  78 } vxlan_decap_info_t;
  79
  80 typedef struct
  81 {
  82   /* Required for pool_get_aligned */
  83   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  84
  85   /* FIB DPO for IP forwarding of VXLAN encap packet */
  86   dpo_id_t next_dpo;
  87
  88   /* vxlan VNI in HOST byte order */
  89   u32 vni;
  90
  91   /* tunnel src and dst addresses */
  92   ip46_address_t src;
  93   ip46_address_t dst;
  94
  95   /* mcast packet output intfc index (used only if dst is mcast) */
  96   u32 mcast_sw_if_index;
  97
  98   /* decap next index */
  99   u16 decap_next_index;
 100
 101   /* The FIB index for src/dst addresses */
 102   u32 encap_fib_index;
 103
 104   /* vnet intfc index */
 105   u32 sw_if_index;
 106   u32 hw_if_index;
 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 tunnel is unicast or mcast)
 115    * sending unicast VXLAN encap packets or receiving mcast VXLAN 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 flow_index;               /* infra flow index */
 129   u32 dev_instance;             /* Real device instance in tunnel vector */
 130   u32 user_instance;            /* Instance name being shown to user */
 131
 132     vnet_declare_rewrite (VLIB_BUFFER_PRE_DATA_SIZE);
 133 } vxlan_tunnel_t;
 134
 135 #define foreach_vxlan_input_next        \
 136 _(DROP, "error-drop")                   \
 137 _(L2_INPUT, "l2-input")
 138
 139 typedef enum
 140 {
 141 #define _(s,n) VXLAN_INPUT_NEXT_##s,
 142   foreach_vxlan_input_next
 143 #undef _
 144     VXLAN_INPUT_N_NEXT,
 145 } vxlan_input_next_t;
 146
 147 typedef enum
 148 {
 149 #define vxlan_error(n,s) VXLAN_ERROR_##n,
 150 #include <vnet/vxlan/vxlan_error.def>
 151 #undef vxlan_error
 152   VXLAN_N_ERROR,
 153 } vxlan_input_error_t;
 154
 155 typedef struct
 156 {
 157   /* vector of encap tunnel instances */
 158   vxlan_tunnel_t *tunnels;
 159
 160   /* lookup tunnel by key */
 161   clib_bihash_16_8_t vxlan4_tunnel_by_key;      /* keyed on ipv4.dst + fib + vni */
 162   clib_bihash_24_8_t vxlan6_tunnel_by_key;      /* keyed on ipv6.dst + fib + vni */
 163
 164   /* local VTEP IPs ref count used by vxlan-bypass node to check if
 165      received VXLAN packet DIP matches any local VTEP address */
 166   uword *vtep4;                 /* local ip4 VTEPs keyed on their ip4 addr */
 167   uword *vtep6;                 /* local ip6 VTEPs keyed on their ip6 addr */
 168
 169   /* mcast shared info */
 170   uword *mcast_shared;          /* keyed on mcast ip46 addr */
 171
 172   /* Mapping from sw_if_index to tunnel index */
 173   u32 *tunnel_index_by_sw_if_index;
 174
 175   /* graph node state */
 176   uword *bm_ip4_bypass_enabled_by_sw_if;
 177   uword *bm_ip6_bypass_enabled_by_sw_if;
 178
 179   /* convenience */
 180   vlib_main_t *vlib_main;
 181   vnet_main_t *vnet_main;
 182
 183   /* Record used instances */
 184   uword *instance_used;
 185   u32 flow_id_start;
 186 } vxlan_main_t;
 187
 188 extern vxlan_main_t vxlan_main;
 189
 190 extern vlib_node_registration_t vxlan4_input_node;
 191 extern vlib_node_registration_t vxlan6_input_node;
 192 extern vlib_node_registration_t vxlan4_encap_node;
 193 extern vlib_node_registration_t vxlan6_encap_node;
 194 extern vlib_node_registration_t vxlan4_flow_input_node;
 195
 196 u8 *format_vxlan_encap_trace (u8 * s, va_list * args);
 197
 198 typedef struct
 199 {
 200   u8 is_add;
 201
 202   /* we normally use is_ip4, but since this adds to the
 203    * structure, this seems less of a breaking change */
 204   u8 is_ip6;
 205   u32 instance;
 206   ip46_address_t src, dst;
 207   u32 mcast_sw_if_index;
 208   u32 encap_fib_index;
 209   u32 decap_next_index;
 210   u32 vni;
 211 } vnet_vxlan_add_del_tunnel_args_t;
 212
 213 int vnet_vxlan_add_del_tunnel
 214   (vnet_vxlan_add_del_tunnel_args_t * a, u32 * sw_if_indexp);
 215
 216 void vnet_int_vxlan_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable);
 217
 218 int vnet_vxlan_add_del_rx_flow (u32 hw_if_index, u32 t_imdex, int is_add);
 219
 220 u32 vnet_vxlan_get_tunnel_index (u32 sw_if_index);
 221 #endif /* included_vnet_vxlan_h */
 222
 223 /*
 224  * fd.io coding-style-patch-verification: ON
 225  *
 226  * Local Variables:
 227  * eval: (c-set-style "gnu")
 228  * End:
 229  */