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