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/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 <vnet/vxlan/vxlan_packet.h>
  30 #include <vnet/ip/ip4_packet.h>
  31 #include <vnet/ip/ip6_packet.h>
  32 #include <vnet/udp/udp.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_header_t vxlan; /* 8 bytes */
  41 }) ip4_vxlan_header_t;
  42
  43 typedef CLIB_PACKED (struct {
  44   ip6_header_t ip6;     /* 40 bytes */
  45   udp_header_t udp;     /* 8 bytes */
  46   vxlan_header_t vxlan; /* 8 bytes */
  47 }) ip6_vxlan_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_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_tunnel_key_t;
  62
  63 typedef union
  64 {
  65   struct
  66   {
  67     u32 sw_if_index;            /* unicast - input interface / mcast - stats interface */
  68     union
  69     {
  70       struct                    /* unicast action */
  71       {
  72         u16 next_index;
  73         u8 error;
  74       };
  75       ip4_address_t local_ip;   /* used as dst ip for mcast pkts to assign them to unicast tunnel */
  76     };
  77   };
  78   u64 as_u64;
  79 } vxlan_decap_info_t;
  80
  81 typedef struct
  82 {
  83   /* Required for pool_get_aligned */
  84   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  85
  86   /* FIB DPO for IP forwarding of VXLAN encap packet */
  87   dpo_id_t next_dpo;
  88
  89   /* vxlan VNI in HOST byte order */
  90   u32 vni;
  91
  92   /* tunnel src and dst addresses */
  93   ip46_address_t src;
  94   ip46_address_t dst;
  95
  96   /* mcast packet output intfc index (used only if dst is mcast) */
  97   u32 mcast_sw_if_index;
  98
  99   /* decap next index */
 100   u16 decap_next_index;
 101
 102   /* The FIB index for src/dst addresses */
 103   u32 encap_fib_index;
 104
 105   /* vnet intfc index */
 106   u32 sw_if_index;
 107   u32 hw_if_index;
 108
 109   /**
 110    * Linkage into the FIB object graph
 111    */
 112   fib_node_t node;
 113
 114   /*
 115    * The FIB entry for (depending on VXLAN tunnel is unicast or mcast)
 116    * sending unicast VXLAN encap packets or receiving mcast VXLAN packets
 117    */
 118   fib_node_index_t fib_entry_index;
 119   adj_index_t mcast_adj_index;
 120
 121   /**
 122    * The tunnel is a child of the FIB entry for its destination. This is
 123    * so it receives updates when the forwarding information for that entry
 124    * changes.
 125    * The tunnels sibling index on the FIB entry's dependency list.
 126    */
 127   u32 sibling_index;
 128
 129   u32 flow_index;               /* infra flow index */
 130   u32 dev_instance;             /* Real device instance in tunnel vector */
 131   u32 user_instance;            /* Instance name being shown to user */
 132
 133     VNET_DECLARE_REWRITE;
 134 } vxlan_tunnel_t;
 135
 136 #define foreach_vxlan_input_next        \
 137 _(DROP, "error-drop")                   \
 138 _(L2_INPUT, "l2-input")
 139
 140 typedef enum
 141 {
 142 #define _(s,n) VXLAN_INPUT_NEXT_##s,
 143   foreach_vxlan_input_next
 144 #undef _
 145     VXLAN_INPUT_N_NEXT,
 146 } vxlan_input_next_t;
 147
 148 typedef enum
 149 {
 150 #define vxlan_error(n,s) VXLAN_ERROR_##n,
 151 #include <vnet/vxlan/vxlan_error.def>
 152 #undef vxlan_error
 153   VXLAN_N_ERROR,
 154 } vxlan_input_error_t;
 155
 156 typedef struct
 157 {
 158   /* vector of encap tunnel instances */
 159   vxlan_tunnel_t *tunnels;
 160
 161   /* lookup tunnel by key */
 162   clib_bihash_16_8_t vxlan4_tunnel_by_key;      /* keyed on ipv4.dst + fib + vni */
 163   clib_bihash_24_8_t vxlan6_tunnel_by_key;      /* keyed on ipv6.dst + fib + vni */
 164
 165   /* local VTEP IPs ref count used by vxlan-bypass node to check if
 166      received VXLAN packet DIP matches any local VTEP address */
 167   vtep_table_t vtep_table;
 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  */