vnet/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
  32 typedef CLIB_PACKED (struct {
  33   ip4_header_t ip4;            /* 20 bytes */
  34   udp_header_t udp;            /* 8 bytes */
  35   vxlan_header_t vxlan;        /* 8 bytes */
  36 }) ip4_vxlan_header_t;
  37
  38 typedef CLIB_PACKED (struct {
  39   ip6_header_t ip6;            /* 40 bytes */
  40   udp_header_t udp;            /* 8 bytes */
  41   vxlan_header_t vxlan;        /* 8 bytes */
  42 }) ip6_vxlan_header_t;
  43
  44 typedef CLIB_PACKED(struct {
  45   /*
  46    * Key fields: ip src and vxlan vni on incoming VXLAN packet
  47    * all fields in NET byte order
  48    */
  49   union {
  50     struct {
  51       u32 src;
  52       u32 vni;                 /* shifted left 8 bits */
  53     };
  54     u64 as_u64;
  55   };
  56 }) vxlan4_tunnel_key_t;
  57
  58 typedef CLIB_PACKED(struct {
  59   /*
  60    * Key fields: ip src and vxlan vni on incoming VXLAN packet
  61    * all fields in NET byte order
  62    */
  63   ip6_address_t src;
  64   u32 vni;                 /* shifted left 8 bits */
  65 }) vxlan6_tunnel_key_t;
  66
  67 typedef struct {
  68   /* Rewrite string. $$$$ embed vnet_rewrite header */
  69   u8 * rewrite;
  70
  71   /* FIB DPO for IP forwarding of VXLAN encap packet */
  72   dpo_id_t next_dpo;
  73
  74   /* storage for the hash key */
  75   union {
  76     vxlan4_tunnel_key_t *key4; /* unused for now */
  77     vxlan6_tunnel_key_t *key6;
  78   };
  79
  80   /* vxlan VNI in HOST byte order */
  81   u32 vni;
  82
  83   /* tunnel src and dst addresses */
  84   ip46_address_t src;
  85   ip46_address_t dst;
  86
  87   /* The FIB index for src/dst addresses */
  88   u32 encap_fib_index;
  89
  90   /* vnet intfc index */
  91   u32 sw_if_index;
  92   u32 hw_if_index;
  93
  94   /**
  95    * Linkage into the FIB object graph
  96    */
  97   fib_node_t node;
  98
  99   /* The FIB entry sourced by the tunnel for its destination prefix */
 100   fib_node_index_t fib_entry_index;
 101
 102   /**
 103    * The tunnel is a child of the FIB entry for its desintion. 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 } vxlan_tunnel_t;
 110
 111 #define foreach_vxlan_input_next        \
 112 _(DROP, "error-drop")                   \
 113 _(L2_INPUT, "l2-input")
 114
 115 typedef enum {
 116 #define _(s,n) VXLAN_INPUT_NEXT_##s,
 117   foreach_vxlan_input_next
 118 #undef _
 119   VXLAN_INPUT_N_NEXT,
 120 } vxlan_input_next_t;
 121
 122 typedef enum {
 123 #define vxlan_error(n,s) VXLAN_ERROR_##n,
 124 #include <vnet/vxlan/vxlan_error.def>
 125 #undef vxlan_error
 126   VXLAN_N_ERROR,
 127 } vxlan_input_error_t;
 128
 129 typedef struct {
 130   /* vector of encap tunnel instances */
 131   vxlan_tunnel_t *tunnels;
 132
 133   /* lookup tunnel by key */
 134   uword * vxlan4_tunnel_by_key; /* keyed on ipv4.dst + vni */
 135   uword * vxlan6_tunnel_by_key; /* keyed on ipv6.dst + vni */
 136
 137   /* Free vlib hw_if_indices */
 138   u32 * free_vxlan_tunnel_hw_if_indices;
 139
 140   /* Mapping from sw_if_index to tunnel index */
 141   u32 * tunnel_index_by_sw_if_index;
 142
 143   /* convenience */
 144   vlib_main_t * vlib_main;
 145   vnet_main_t * vnet_main;
 146 } vxlan_main_t;
 147
 148 vxlan_main_t vxlan_main;
 149
 150 extern vlib_node_registration_t vxlan4_input_node;
 151 extern vlib_node_registration_t vxlan6_input_node;
 152 extern vlib_node_registration_t vxlan4_encap_node;
 153 extern vlib_node_registration_t vxlan6_encap_node;
 154
 155 u8 * format_vxlan_encap_trace (u8 * s, va_list * args);
 156
 157 typedef struct {
 158   u8 is_add;
 159
 160   /* we normally use is_ip4, but since this adds to the
 161    * structure, this seems less of abreaking change */
 162   u8 is_ip6;
 163   ip46_address_t src, dst;
 164   u32 encap_fib_index;
 165   u32 decap_next_index;
 166   u32 vni;
 167 } vnet_vxlan_add_del_tunnel_args_t;
 168
 169 int vnet_vxlan_add_del_tunnel
 170 (vnet_vxlan_add_del_tunnel_args_t *a, u32 * sw_if_indexp);
 171
 172 #endif /* included_vnet_vxlan_h */