/* * 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 <vnet/vnet.h> #include <vnet/gre/packet.h> #include <vnet/ip/ip.h> #include <vnet/pg/pg.h> #include <vnet/ip/format.h> #include <vnet/adj/adj_types.h> #include <vnet/tunnel/tunnel.h> #include <vnet/teib/teib.h> extern vnet_hw_interface_class_t gre_hw_interface_class; extern vnet_hw_interface_class_t mgre_hw_interface_class; typedef enum { #define gre_error(n,s) GRE_ERROR_##n, #include <vnet/gre/error.def> #undef gre_error GRE_N_ERROR, } gre_error_t; /** * L3: GRE (i.e. this tunnel is in L3 mode) * TEB: Transparent Ethernet Bridging - the tunnel is in L2 mode * 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 */ #define foreach_gre_tunnel_type \ _(L3, "L3") \ _(TEB, "TEB") \ _(ERSPAN, "ERSPAN") \ /** * @brief The GRE tunnel type */ typedef enum gre_tunnel_type_t_ { #define _(n, s) GRE_TUNNEL_TYPE_##n, foreach_gre_tunnel_type #undef _ } __clib_packed gre_tunnel_type_t; extern u8 *format_gre_tunnel_type (u8 * s, va_list * args); /** * 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; /** * Elements of the GRE key that are common for v6 and v6 addresses */ typedef struct gre_tunnel_key_common_t_ { union { struct { u32 fib_index; u16 session_id; gre_tunnel_type_t type; tunnel_mode_t mode; }; u64 as_u64; }; } gre_tunnel_key_common_t; STATIC_ASSERT_SIZEOF (gre_tunnel_key_common_t, sizeof (u64)); /** * @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; }; /** address independent attributes */ gre_tunnel_key_common_t gtk_common; } __attribute__ ((packed)) gre_tunnel_key4_t; STATIC_ASSERT_SIZEOF (gre_tunnel_key4_t, 2 * sizeof (u64)); /** * @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; /** address independent attributes */ gre_tunnel_key_common_t gtk_common; } __attribute__ ((packed)) gre_tunnel_key6_t; STATIC_ASSERT_SIZEOF (gre_tunnel_key6_t, 5 * sizeof (u64)); /** * 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; /** * The session ID is only a 10 bit value */ #define GTK_SESSION_ID_MAX (0x3ff) /** * 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 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 hw_if_index; u32 sw_if_index; gre_tunnel_type_t type; tunnel_mode_t mode; tunnel_encap_decap_flags_t flags; /** * an L2 tunnel always rquires an L2 midchain. cache here for DP. */ adj_index_t l2_adj_index; /** * ERSPAN type 2 session ID, least significant 10 bits of u16 */ u16 session_id; /** * GRE header sequence number (SN) used for ERSPAN type 2 header, must be * bumped automically to be thread safe. As multiple GRE tunnels are created * for the same fib-idx/DIP/SIP with different ERSPAN session number, they all * share the same SN which is kept per FIB/DIP/SIP, as specified by RFC2890. */ gre_sn_t *gre_sn; u32 dev_instance; /* Real device instance in tunnel vector */ u32 user_instance; /* Instance name being shown to user */ } gre_tunnel_t; typedef struct { u8 next_index; u8 tunnel_type; } next_info_t; /** * @brief GRE related global data */ typedef struct { /** * pool of tunnel instances */ gre_tunnel_t *tunnels; /** * GRE payload protocol registrations */ gre_protocol_info_t *protocol_infos; /** * Hash tables mapping name/protocol to protocol info index. <style> @media only all and (prefers-color-scheme: dark) { .highlight .hll { background-color: #49483e } .highlight .c { color: #75715e } /* Comment */ .highlight .err { color: #960050; background-color: #1e0010 } /* Error */ .highlight .k { color: #66d9ef } /* Keyword */ .highlight .l { color: #ae81ff } /* Literal */ .highlight .n { color: #f8f8f2 } /* Name */ .highlight .o { color: #f92672 } /* Operator */ .highlight .p { color: #f8f8f2 } /* Punctuation */ .highlight .ch { color: #75715e } /* Comment.Hashbang */ .highlight .cm { color: #75715e } /* Comment.Multiline */ .highlight .cp { color: #75715e } /* Comment.Preproc */ .highlight .cpf { color: #75715e } /* Comment.PreprocFile */ .highlight .c1 { color: #75715e } /* Comment.Single */ .highlight .cs { color: #75715e } /* Comment.Special */ .highlight .gd { color: #f92672 } /* Generic.Deleted */ .highlight .ge { font-style: italic } /* Generic.Emph */ .highlight .gi { color: #a6e22e } /* Generic.Inserted */ .highlight .gs { font-weight: bold } /* Generic.Strong */ .highlight .gu { color: #75715e } /* Generic.Subheading */ .highlight .kc { color: #66d9ef } /* Keyword.Constant */ .highlight .kd { color: #66d9ef } /* Keyword.Declaration */ .highlight .kn { color: #f92672 } /* Keyword.Namespace */ .highlight .kp { color: #66d9ef } /* Keyword.Pseudo */ .highlight .kr { color: #66d9ef } /* Keyword.Reserved */ .highlight .kt { color: #66d9ef } /* Keyword.Type */ .highlight .ld { color: #e6db74 } /* Literal.Date */ .highlight .m { color: #ae81ff } /* Literal.Number */ .highlight .s { color: #e6db74 } /* Literal.String */ .highlight .na { color: #a6e22e } /* Name.Attribute */ .highlight .nb { color: #f8f8f2 } /* Name.Builtin */ .highlight .nc { color: #a6e22e } /* Name.Class */ .highlight .no { color: #66d9ef } /* Name.Constant */ .highlight .nd { color: #a6e22e } /* Name.Decorator */ .highlight .ni { color: #f8f8f2 } /* Name.Entity */ .highlight .ne { color: #a6e22e } /* Name.Exception */ .highlight .nf { color: #a6e22e } /* Name.Function */ .highlight .nl { color: #f8f8f2 } /* Name.Label */ .highlight .nn { color: #f8f8f2 } /* Name.Namespace */ .highlight .nx { color: #a6e22e } /* Name.Other */ .highlight .py { color: #f8f8f2 } /* Name.Property */ .highlight .nt { color: #f92672 } /* Name.Tag */ .highlight .nv { color: #f8f8f2 } /* Name.Variable */ .highlight .ow { color: #f92672 } /* Operator.Word */ .highlight .w { color: #f8f8f2 } /* Text.Whitespace */ .highlight .mb { color: #ae81ff } /* Literal.Number.Bin */ .highlight .mf { color: #ae81ff } /* Literal.Number.Float */ .highlight .mh { color: #ae81ff } /* Literal.Number.Hex */ .highlight .mi { color: #ae81ff } /* Literal.Number.Integer */ .highlight .mo { color: #ae81ff } /* Literal.Number.Oct */ .highlight .sa { color: #e6db74 } /* Literal.String.Affix */ .highlight .sb { color: #e6db74 } /* Literal.String.Backtick */ .highlight .sc { color: #e6db74 } /* Literal.String.Char */ .highlight .dl { color: #e6db74 } /* Literal.String.Delimiter */ .highlight .sd { color: #e6db74 } /* Literal.String.Doc */ .highlight .s2 { color: #e6db74 } /* Literal.String.Double */ .highlight .se { color: #ae81ff } /* Literal.String.Escape */ .highlight .sh { color: #e6db74 } /* Literal.String.Heredoc */ .highlight .si { color: #e6db74 } /* Literal.String.Interpol */ .highlight .sx { color: #e6db74 } /* Literal.String.Other */ .highlight .sr { color: #e6db74 } /* Literal.String.Regex */ .highlight .s1 { color: #e6db74 } /* Literal.String.Single */ .highlight .ss { color: #e6db74 } /* Literal.String.Symbol */ .highlight .bp { color: #f8f8f2 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #a6e22e } /* Name.Function.Magic */ .highlight .vc { color: #f8f8f2 } /* Name.Variable.Class */ .highlight .vg { color: #f8f8f2 } /* Name.Variable.Global */ .highlight .vi { color: #f8f8f2 } /* Name.Variable.Instance */ .highlight .vm { color: #f8f8f2 } /* Name.Variable.Magic */ .highlight .il { color: #ae81ff } /* Literal.Number.Integer.Long */ } @media (prefers-color-scheme: light) { .highlight .hll { background-color: #ffffcc } .highlight .c { color: #888888 } /* Comment */ .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ .highlight .k { color: #008800; font-weight: bold } /* Keyword */ .highlight .ch { color: #888888 } /* Comment.Hashbang */ .highlight .cm { color: #888888 } /* Comment.Multiline */ .highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */ .highlight .cpf { color: #888888 } /* Comment.PreprocFile */ .highlight .c1 { color: #888888 } /* Comment.Single */ .highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Com