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 struct
  63 {
  64   /* Required for pool_get_aligned */
  65   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  66
  67   /* FIB DPO for IP forwarding of VXLAN encap packet */
  68   dpo_id_t next_dpo;
  69
  70   /* vxlan VNI in HOST byte order */
  71   u32 vni;
  72
  73   /* tunnel src and dst addresses */
  74   ip46_address_t src;
  75   ip46_address_t dst;
  76
  77   /* mcast packet output intfc index (used only if dst is mcast) */
  78   u32 mcast_sw_if_index;
  79
  80   /* decap next index */
  81   u16 decap_next_index;
  82
  83   /* The FIB index for src/dst addresses */
  84   u32 encap_fib_index;
  85
  86   /* vnet intfc index */
  87   u32 sw_if_index;
  88   u32 hw_if_index;
  89
  90   /**
  91    * Linkage into the FIB object graph
  92    */
  93   fib_node_t node;
  94
  95   /*
  96    * The FIB entry for (depending on VXLAN tunnel is unicast or mcast)
  97    * sending unicast VXLAN encap packets or receiving mcast VXLAN packets
  98    */
  99   fib_node_index_t fib_entry_index;
 100   adj_index_t mcast_adj_index;
 101
 102   /**
 103    * The tunnel is a child of the FIB entry for its destination. This is
 104    * so it receives updates when the forwarding information for that entry
 105    * changes.
 106    * The tunnels sibling index on the FIB entry's dependency list.
 107    */
 108   u32 sibling_index;
 109
 110   u32 flow_index;               /* infra flow index */
 111   u32 dev_instance;             /* Real device instance in tunnel vector */
 112   u32 user_instance;            /* Instance name being shown to user */
 113
 114     vnet_declare_rewrite (VLIB_BUFFER_PRE_DATA_SIZE);
 115 } vxlan_tunnel_t;
 116
 117 #define foreach_vxlan_input_next        \
 118 _(DROP, "error-drop")                   \
 119 _(L2_INPUT, "l2-input")
 120
 121 typedef enum
 122 {
 123 #define _(s,n) VXLAN_INPUT_NEXT_##s,
 124   foreach_vxlan_input_next
 125 #undef _
 126     VXLAN_INPUT_N_NEXT,
 127 } vxlan_input_next_t;
 128
 129 typedef enum
 130 {
 131 #define vxlan_error(n,s) VXLAN_ERROR_##n,
 132 #include <vnet/vxlan/vxlan_error.def>
 133 #undef vxlan_error
 134   VXLAN_N_ERROR,
 135 } vxlan_input_error_t;
 136
 137 typedef struct
 138 {
 139   /* vector of encap tunnel instances */
 140   vxlan_tunnel_t *tunnels;
 141
 142   /* lookup tunnel by key */
 143   clib_bihash_16_8_t vxlan4_tunnel_by_key;      /* keyed on ipv4.dst + fib + vni */
 144   clib_bihash_24_8_t vxlan6_tunnel_by_key;      /* keyed on ipv6.dst + fib + vni */
 145
 146   /* local VTEP IPs ref count used by vxlan-bypass node to check if
 147      received VXLAN packet DIP matches any local VTEP address */
 148   uword *vtep4;                 /* local ip4 VTEPs keyed on their ip4 addr */
 149   uword *vtep6;                 /* local ip6 VTEPs keyed on their ip6 addr */
 150
 151   /* mcast shared info */
 152   uword *mcast_shared;          /* keyed on mcast ip46 addr */
 153
 154   /* Mapping from sw_if_index to tunnel index */
 155   u32 *tunnel_index_by_sw_if_index;
 156
 157   /* convenience */
 158   vlib_main_t *vlib_main;
 159   vnet_main_t *vnet_main;
 160
 161   /* Record used instances */
 162   uword *instance_used;
 163   u32 flow_id_start;
 164 } vxlan_main_t;
 165
 166 extern vxlan_main_t vxlan_main;
 167
 168 extern vlib_node_registration_t vxlan4_input_node;
 169 extern vlib_node_registration_t vxlan6_input_node;
 170 extern vlib_node_registration_t vxlan4_encap_node;
 171 extern vlib_node_registration_t vxlan6_encap_node;
 172 extern vlib_node_registration_t vxlan4_flow_input_node;
 173
 174 u8 *format_vxlan_encap_trace (u8 * s, va_list * args);
 175
 176 typedef struct
 177 {
 178   u8 is_add;
 179
 180   /* we normally use is_ip4, but since this adds to the
 181    * structure, this seems less of a breaking change */
 182   u8 is_ip6;
 183   u32 instance;
 184   ip46_address_t src, dst;
 185   u32 mcast_sw_if_index;
 186   u32 encap_fib_index;
 187   u32 decap_next_index;
 188   u32 vni;
 189 } vnet_vxlan_add_del_tunnel_args_t;
 190
 191 int vnet_vxlan_add_del_tunnel
 192   (vnet_vxlan_add_del_tunnel_args_t * a, u32 * sw_if_indexp);
 193
 194 void vnet_int_vxlan_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable);
 195
 196 int vnet_vxlan_add_del_rx_flow (u32 hw_if_index, u32 t_imdex, int is_add);
 197
 198 u32 vnet_vxlan_get_tunnel_index (u32 sw_if_index);
 199 #endif /* included_vnet_vxlan_h */
 200
 201 /*
 202  * fd.io coding-style-patch-verification: ON
 203  *
 204  * Local Variables:
 205  * eval: (c-set-style "gnu")
 206  * End:
 207  */