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