/* * gre.h: types/functions for gre. * * Copyright (c) 2012 Cisco and/or its affiliates. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at: * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #ifndef included_gre_h #define included_gre_h #include #include #include #include #include #include extern vnet_hw_interface_class_t gre_hw_interface_class; typedef enum { #define gre_error(n,s) GRE_ERROR_##n, #include #undef gre_error GRE_N_ERROR, } gre_error_t; /** * @brief The GRE tunnel type */ typedef enum gre_tunnel_type_t_ { /** * L3 GRE (i.e. this tunnel is in L3 mode) */ GRE_TUNNEL_TYPE_L3 = 0, /** * Transparent Ethernet Bridging - the tunnel is in L2 mode */ GRE_TUNNEL_TYPE_TEB = 1, /** * ERSPAN type 2 - the tunnel is for port mirror SPAN output. Each tunnel is * associated with a session ID and expected to be used for encap and output * of mirrored packet from a L2 network only. There is no support for * receiving ERSPAN packets from a GRE ERSPAN tunnel in VPP. */ GRE_TUNNEL_TYPE_ERSPAN = 2, } gre_tunnel_type_t; #define GRE_TUNNEL_TYPE_N (GRE_TUNNEL_TYPE_ERSPAN + 1) #define GRE_TUNNEL_TYPE_NAMES { \ [GRE_TUNNEL_TYPE_L3] = "L3", \ [GRE_TUNNEL_TYPE_TEB] = "TEB", \ [GRE_TUNNEL_TYPE_ERSPAN] = "ERSPAN", \ } /** * A GRE payload protocol registration */ typedef struct { /** Name (a c string). */ char *name; /** GRE protocol type in host byte order. */ gre_protocol_t protocol; /** GRE tunnel type */ gre_tunnel_type_t tunnel_type; /** Node which handles this type. */ u32 node_index; /** Next index for this type. */ u32 next_index; } gre_protocol_info_t; /** * @brief Key for a IPv4 GRE Tunnel */ typedef struct gre_tunnel_key4_t_ { /** * Source and destination IP addresses */ union { struct { ip4_address_t gtk_src; ip4_address_t gtk_dst; }; u64 gtk_as_u64; }; /** * FIB table index, ERSPAN session ID and tunnel type in u32 bit fields: * - The FIB table index the src,dst addresses are in, top 20 bits * - The Session ID for ERSPAN tunnel type and 0 otherwise, next 10 bits * - Tunnel type, bottom 2 bits */ u32 gtk_fidx_ssid_type; } __attribute__ ((packed)) gre_tunnel_key4_t; /** * @brief Key for a IPv6 GRE Tunnel * We use a different type so that the V4 key hash is as small as possible */ typedef struct gre_tunnel_key6_t_ { /** * Source and destination IP addresses */ ip6_address_t gtk_src; ip6_address_t gtk_dst; /** * FIB table index, ERSPAN session ID and tunnel type in u32 bit fields: * - The FIB table index the src,dst addresses are in, top 20 bits * - The Session ID for ERSPAN tunnel type and 0 otherwise, next 10 bits * - Tunnel type, bottom 2 bits */ u32 gtk_fidx_ssid_type; } __attribute__ ((packed)) gre_tunnel_key6_t; #define GTK_FIB_INDEX_SHIFT 12 #define GTK_FIB_INDEX_MASK 0xfffff000 #define GTK_TYPE_SHIFT 0 #define GTK_TYPE_MASK 0x3 #define GTK_SESSION_ID_SHIFT 2 #define GTK_SESSION_ID_MASK 0xffc #define GTK_SESSION_ID_MAX (GTK_SESSION_ID_MASK >> GTK_SESSION_ID_SHIFT) /** * Union of the two possible key types */ typedef union gre_tunnel_key_t_ { gre_tunnel_key4_t gtk_v4; gre_tunnel_key6_t gtk_v6; } gre_tunnel_key_t; /** * Used for GRE header seq number generation for ERSPAN encap */ typedef struct { u32 seq_num; u32 ref_count; } gre_sn_t; /** * Hash key for GRE header seq number generation for ERSPAN encap */ typedef struct { ip46_address_t src; ip46_address_t dst; u32 fib_index; } gre_sn_key_t; /** * @brief A representation of a GRE tunnel */ typedef struct { /** * Required for pool_get_aligned */ CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); /** * The hash table's key stored in separate memory since the tunnel_t * memory can realloc. */ gre_tunnel_key_t *key; /** * The tunnel's source/local address */ ip46_address_t tunnel_src; /** * The tunnel's destination/remote address */ fib_prefix_t tunnel_dst; /** * The FIB in which the src.dst address are present */ u32 outer_fib_index; u32