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 <vnet/vnet.h>
  21 #include <vnet/ip/ip.h>
  22 #include <vnet/l2/l2_input.h>
  23 #include <vnet/l2/l2_output.h>
  24 #include <vnet/l2/l2_bd.h>
  25 #include <vnet/ethernet/ethernet.h>
  26 #include <vnet/vxlan/vxlan_packet.h>
  27 #include <vnet/ip/ip4_packet.h>
  28 #include <vnet/ip/ip6_packet.h>
  29 #include <vnet/ip/udp.h>
  30 #include <vnet/dpo/dpo.h>
  31 #include <vnet/adj/adj_types.h>
  32
  33 typedef CLIB_PACKED (struct {
  34   ip4_header_t ip4;            /* 20 bytes */
  35   udp_header_t udp;            /* 8 bytes */
  36   vxlan_header_t vxlan;        /* 8 bytes */
  37 }) ip4_vxlan_header_t;
  38
  39 typedef CLIB_PACKED (struct {
  40   ip6_header_t ip6;            /* 40 bytes */
  41   udp_header_t udp;            /* 8 bytes */
  42   vxlan_header_t vxlan;        /* 8 bytes */
  43 }) ip6_vxlan_header_t;
  44
  45 typedef CLIB_PACKED(struct {
  46   /*
  47    * Key fields: ip src and vxlan vni on incoming VXLAN packet
  48    * all fields in NET byte order
  49    */
  50   union {
  51     struct {
  52       u32 src;
  53       u32 vni;                 /* shifted left 8 bits */
  54     };
  55     u64 as_u64;
  56   };
  57 }) vxlan4_tunnel_key_t;
  58
  59 typedef CLIB_PACKED(struct {
  60   /*
  61    * Key fields: ip src and vxlan vni on incoming VXLAN packet
  62    * all fields in NET byte order
  63    */
  64   ip6_address_t src;
  65   u32 vni;                 /* shifted left 8 bits */
  66 }) vxlan6_tunnel_key_t;
  67
  68 typedef struct {
  69   /* Rewrite string. $$$$ embed vnet_rewrite header */
  70   u8 * rewrite;
  71
  72   /* FIB DPO for IP forwarding of VXLAN encap packet */
  73   dpo_id_t next_dpo;
  74
  75   /* storage for the hash key */
  76   union {
  77     vxlan4_tunnel_key_t *key4; /* unused for now */
  78     vxlan6_tunnel_key_t *key6;
  79   };
  80
  81   /* vxlan VNI in HOST byte order */
  82   u32 vni;
  83
  84   /* tunnel src and dst addresses */
  85   ip46_address_t src;
  86   ip46_address_t dst;
  87
  88   /* mcast packet output intfc index (used only if dst is mcast) */
  89   u32 mcast_sw_if_index;
  90
  91   /* decap next index */
  92   u32 decap_next_index;
  93
  94   /* The FIB index for src/dst addresses */
  95   u32 encap_fib_index;
  96
  97   /* vnet intfc index */
  98   u32 sw_if_index;
  99   u32 hw_if_index;
 100
 101   /**
 102    * Linkage into the FIB object graph
 103    */
 104   fib_node_t node;
 105
 106   /*
 107    * The FIB entry for (depending on VXLAN tunnel is unicast or mcast)
 108    * sending unicast VXLAN encap packets or receiving mcast VXLAN packets
 109    */
 110   fib_node_index_t fib_entry_index;
 111   adj_index_t mcast_adj_index;
 112
 113   /**
 114    * The tunnel is a child of the FIB entry for its desintion. This is
 115    * so it receives updates when the forwarding information for that entry
 116    * changes.
 117    * The tunnels sibling index on the FIB entry's dependency list.
 118    */
 119   u32 sibling_index;
 120 } vxlan_tunnel_t;
 121
 122 #define foreach_vxlan_input_next        \
 123 _(DROP, "error-drop")                   \
 124 _(L2_INPUT, "l2-input")
 125
 126 typedef enum {
 127 #define _(s,n) VXLAN_INPUT_NEXT_##s,
 128   foreach_vxlan_input_next
 129 #undef _
 130   VXLAN_INPUT_N_NEXT,
 131 } vxlan_input_next_t;
 132
 133 typedef enum {
 134 #define vxlan_error(n,s) VXLAN_ERROR_##n,
 135 #include <vnet/vxlan/vxlan_error.def>
 136 #undef vxlan_error
 137   VXLAN_N_ERROR,
 138 } vxlan_input_error_t;
 139
 140 typedef struct {
 141   ip46_address_t ip;
 142   fib_node_index_t fib_entry_index;
 143   adj_index_t mcast_adj_index;
 144 } mcast_remote_t;
 145
 146 typedef struct {
 147   /* vector of encap tunnel instances */
 148   vxlan_tunnel_t * tunnels;
 149
 150   /* lookup tunnel by key */
 151   uword * vxlan4_tunnel_by_key; /* keyed on ipv4.dst + vni */
 152   uword * vxlan6_tunnel_by_key; /* keyed on ipv6.dst + vni */
 153
 154   /* local VTEP IPs ref count used by vxlan-bypass node to check if
 155      received VXLAN packet DIP matches any local VTEP address */
 156   uword * vtep4;  /* local ip4 VTEPs keyed on their ip4 addr */
 157   uword * vtep6;  /* local ip6 VTEPs keyed on their ip6 addr */
 158
 159   /* set of active remote mcast VTEP */
 160   mcast_remote_t * mcast_eps;
 161   uword * mcast_ep_by_ip; /* mcast VTEPs keyed on their ip46 addr */
 162
 163   /* Free vlib hw_if_indices */
 164   u32 * free_vxlan_tunnel_hw_if_indices;
 165
 166   /* Mapping from sw_if_index to tunnel index */
 167   u32 * tunnel_index_by_sw_if_index;
 168
 169   /* convenience */
 170   vlib_main_t * vlib_main;
 171   vnet_main_t * vnet_main;
 172 } vxlan_main_t;
 173
 174 vxlan_main_t vxlan_main;
 175
 176 extern vlib_node_registration_t vxlan4_input_node;
 177 extern vlib_node_registration_t vxlan6_input_node;
 178 extern vlib_node_registration_t vxlan4_encap_node;
 179 extern vlib_node_registration_t vxlan6_encap_node;
 180
 181 u8 * format_vxlan_encap_trace (u8 * s, va_list * args);
 182
 183 typedef struct {
 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   ip46_address_t src, dst;
 190   u32 mcast_sw_if_index;
 191   u32 encap_fib_index;
 192   u32 decap_next_index;
 193   u32 vni;
 194 } vnet_vxlan_add_del_tunnel_args_t;
 195
 196 int vnet_vxlan_add_del_tunnel
 197 (vnet_vxlan_add_del_tunnel_args_t *a, u32 * sw_if_indexp);
 198
 199 #endif /* included_vnet_vxlan_h */