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