src/vnet/vxlan-gpe/vxlan_gpe.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 /**
  16  *  @file
  17  *  @brief VXLAN GPE definitions
  18  *
  19 */
  20 #ifndef included_vnet_vxlan_gpe_h
  21 #define included_vnet_vxlan_gpe_h
  22
  23 #include <vppinfra/error.h>
  24 #include <vppinfra/hash.h>
  25 #include <vnet/vnet.h>
  26 #include <vnet/ip/ip.h>
  27 #include <vnet/ip/vtep.h>
  28 #include <vnet/l2/l2_input.h>
  29 #include <vnet/l2/l2_output.h>
  30 #include <vnet/l2/l2_bd.h>
  31 #include <vnet/ethernet/ethernet.h>
  32 #include <vnet/vxlan-gpe/vxlan_gpe_packet.h>
  33 #include <vnet/ip/ip4_packet.h>
  34 #include <vnet/ip/ip6_packet.h>
  35 #include <vnet/udp/udp_packet.h>
  36 #include <vnet/dpo/dpo.h>
  37 #include <vnet/adj/adj_types.h>
  38
  39 /**
  40  * @brief VXLAN GPE header struct
  41  *
  42  */
  43 /* *INDENT-OFF* */
  44 typedef CLIB_PACKED (struct {
  45   /** 20 bytes */
  46   ip4_header_t ip4;
  47   /** 8 bytes */
  48   udp_header_t udp;
  49   /** 8 bytes */
  50   vxlan_gpe_header_t vxlan;
  51 }) ip4_vxlan_gpe_header_t;
  52 /* *INDENT-ON* */
  53
  54 /* *INDENT-OFF* */
  55 typedef CLIB_PACKED (struct {
  56   /** 40 bytes */
  57   ip6_header_t ip6;
  58   /** 8 bytes */
  59   udp_header_t udp;
  60   /** 8 bytes */
  61   vxlan_gpe_header_t vxlan;
  62 }) ip6_vxlan_gpe_header_t;
  63 /* *INDENT-ON* */
  64
  65 /**
  66  * @brief Key struct for IPv4 VXLAN GPE tunnel.
  67  * Key fields: local remote, vni, udp-port
  68  * all fields in NET byte order
  69  * VNI shifted 8 bits
  70  */
  71 /* *INDENT-OFF* */
  72 typedef CLIB_PACKED(struct {
  73   union {
  74     struct {
  75       u32 local;
  76       u32 remote;
  77
  78       u32 vni;
  79       u32 port;
  80     };
  81     u64 as_u64[2];
  82   };
  83 }) vxlan4_gpe_tunnel_key_t;
  84 /* *INDENT-ON* */
  85
  86 /**
  87  * @brief Key struct for IPv6 VXLAN GPE tunnel.
  88  * Key fields: local remote, vni, udp-port
  89  * all fields in NET byte order
  90  * VNI shifted 8 bits
  91  */
  92 /* *INDENT-OFF* */
  93 typedef CLIB_PACKED(struct {
  94   ip6_address_t local;
  95   ip6_address_t remote;
  96   u32 vni;
  97   u32 port;
  98 }) vxlan6_gpe_tunnel_key_t;
  99 /* *INDENT-ON* */
 100
 101 typedef union
 102 {
 103   struct
 104   {
 105     u32 tunnel_index;
 106     u16 next_index;
 107     u8 error;
 108   };
 109   u64 as_u64;
 110 } vxlan_gpe_decap_info_t;
 111
 112 /**
 113  * @brief Struct for VXLAN GPE tunnel
 114  */
 115 typedef struct
 116 {
 117   /* Required for pool_get_aligned */
 118   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 119
 120   /** Rewrite string. $$$$ embed vnet_rewrite header */
 121   u8 *rewrite;
 122
 123   /** encapsulated protocol */
 124   u8 protocol;
 125
 126   /* FIB DPO for IP forwarding of VXLAN-GPE encap packet */
 127   dpo_id_t next_dpo;
 128   /** tunnel local address */
 129   ip46_address_t local;
 130   /** tunnel remote address */
 131   ip46_address_t remote;
 132   /** local udp-port **/
 133   u16 local_port;
 134   /** remote udp-port **/
 135   u16 remote_port;
 136
 137   /* mcast packet output intfc index (used only if dst is mcast) */
 138   u32 mcast_sw_if_index;
 139
 140   /** FIB indices - tunnel partner lookup here */
 141   u32 encap_fib_index;
 142   /** FIB indices - inner IP packet lookup here */
 143   u32 decap_fib_index;
 144
 145   /** VXLAN GPE VNI in HOST byte order, shifted left 8 bits */
 146   u32 vni;
 147
 148   /** vnet intfc hw_if_index */
 149   u32 hw_if_index;
 150   /** vnet intfc sw_if_index */
 151   u32 sw_if_index;
 152
 153   /** flags */
 154   u32 flags;
 155
 156   /** rewrite size for dynamic plugins like iOAM */
 157   u8 rewrite_size;
 158
 159   /** Next node after VxLAN-GPE encap */
 160   uword encap_next_node;
 161
 162   /**
 163    * Linkage into the FIB object graph
 164    */
 165   fib_node_t node;
 166
 167   /*
 168    * The FIB entry for (depending on VXLAN-GPE tunnel is unicast or mcast)
 169    * sending unicast VXLAN-GPE encap packets or receiving mcast VXLAN-GPE packets
 170    */
 171   fib_node_index_t fib_entry_index;
 172   adj_index_t mcast_adj_index;
 173
 174   /**
 175    * The tunnel is a child of the FIB entry for its destination. This is
 176    * so it receives updates when the forwarding information for that entry
 177    * changes.
 178    * The tunnels sibling index on the FIB entry's dependency list.
 179    */
 180   u32 sibling_index;
 181
 182 } vxlan_gpe_tunnel_t;
 183
 184 /** Flags for vxlan_gpe_tunnel_t */
 185 #define VXLAN_GPE_TUNNEL_IS_IPV4        1
 186
 187 /** next nodes for VXLAN GPE input */
 188 #define foreach_vxlan_gpe_input_next        \
 189 _(DROP, "error-drop")                           \
 190 _(IP4_INPUT, "ip4-input")                       \
 191 _(IP6_INPUT, "ip6-input")                       \
 192 _(L2_INPUT, "l2-input")
 193
 194 /** struct for next nodes for VXLAN GPE input */
 195 typedef enum
 196 {
 197 #define _(s,n) VXLAN_GPE_INPUT_NEXT_##s,
 198   foreach_vxlan_gpe_input_next
 199 #undef _
 200     VXLAN_GPE_INPUT_N_NEXT,
 201 } vxlan_gpe_input_next_t;
 202
 203 /** struct for VXLAN GPE errors */
 204 typedef enum
 205 {
 206 #define vxlan_gpe_error(n,s) VXLAN_GPE_ERROR_##n,
 207 #include <vnet/vxlan-gpe/vxlan_gpe_error.def>
 208 #undef vxlan_gpe_error
 209   VXLAN_GPE_N_ERROR,
 210 } vxlan_gpe_input_error_t;
 211
 212 /** Struct for VXLAN GPE node state */
 213 typedef struct
 214 {
 215   /** vector of encap tunnel instances */
 216   vxlan_gpe_tunnel_t *tunnels;
 217
 218   /** lookup IPv4 VXLAN GPE tunnel by key */
 219   uword *vxlan4_gpe_tunnel_by_key;
 220   /** lookup IPv6 VXLAN GPE tunnel by key */
 221   uword *vxlan6_gpe_tunnel_by_key;
 222
 223   /* local VTEP IPs ref count used by vxlan-bypass node to check if
 224      received VXLAN packet DIP matches any local VTEP address */
 225   vtep_table_t vtep_table;
 226   /* mcast shared info */
 227   uword *mcast_shared;          /* keyed on mcast ip46 addr */
 228   /** Free vlib hw_if_indices */
 229   u32 *free_vxlan_gpe_tunnel_hw_if_indices;
 230
 231   /** Mapping from sw_if_index to tunnel index */
 232   u32 *tunnel_index_by_sw_if_index;
 233
 234   /** State convenience vlib_main_t */
 235   vlib_main_t *vlib_main;
 236   /** State convenience vnet_main_t */
 237   vnet_main_t *vnet_main;
 238
 239   /* cache for last 8 vxlan_gpe tunnel */
 240   vtep4_cache_t vtep4_u512;
 241
 242   /** List of next nodes for the decap indexed on protocol */
 243   uword decap_next_node_list[VXLAN_GPE_PROTOCOL_MAX];
 244 } vxlan_gpe_main_t;
 245
 246 extern vxlan_gpe_main_t vxlan_gpe_main;
 247
 248 extern vlib_node_registration_t vxlan_gpe_encap_node;
 249 extern vlib_node_registration_t vxlan4_gpe_input_node;
 250 extern vlib_node_registration_t vxlan6_gpe_input_node;
 251
 252 u8 *format_vxlan_gpe_encap_trace (u8 * s, va_list * args);
 253
 254 /** Struct for VXLAN GPE add/del args */
 255 typedef struct
 256 {
 257   u8 is_add;
 258   u8 is_ip6;
 259   ip46_address_t local, remote;
 260   u8 protocol;
 261   u32 mcast_sw_if_index;
 262   u32 encap_fib_index;
 263   u32 decap_fib_index;
 264   u32 vni;
 265   u16 local_port;
 266   u16 remote_port;
 267 } vnet_vxlan_gpe_add_del_tunnel_args_t;
 268
 269
 270 int vnet_vxlan_gpe_add_del_tunnel
 271   (vnet_vxlan_gpe_add_del_tunnel_args_t * a, u32 * sw_if_indexp);
 272
 273
 274 int vxlan4_gpe_rewrite (vxlan_gpe_tunnel_t * t, u32 extension_size,
 275                         u8 protocol_override, uword encap_next_node);
 276 int vxlan6_gpe_rewrite (vxlan_gpe_tunnel_t * t, u32 extension_size,
 277                         u8 protocol_override, uword encap_next_node);
 278
 279 /**
 280  * @brief Struct for defining VXLAN GPE next nodes
 281  */
 282 typedef enum
 283 {
 284   VXLAN_GPE_ENCAP_NEXT_IP4_LOOKUP,
 285   VXLAN_GPE_ENCAP_NEXT_IP6_LOOKUP,
 286   VXLAN_GPE_ENCAP_NEXT_DROP,
 287   VXLAN_GPE_ENCAP_N_NEXT
 288 } vxlan_gpe_encap_next_t;
 289
 290
 291 void vxlan_gpe_unregister_decap_protocol (u8 protocol_id,
 292                                           uword next_node_index);
 293
 294 void vxlan_gpe_register_decap_protocol (u8 protocol_id,
 295                                         uword next_node_index);
 296
 297 void vnet_int_vxlan_gpe_bypass_mode (u32 sw_if_index, u8 is_ip6,
 298                                      u8 is_enable);
 299
 300 #endif /* included_vnet_vxlan_gpe_h */
 301
 302 /*
 303  * fd.io coding-style-patch-verification: ON
 304  *
 305  * Local Variables:
 306  * eval: (c-set-style "gnu")
 307  * End:
 308  */