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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * @brief VXLAN GPE definitions
20 #ifndef included_vnet_vxlan_gpe_h
21 #define included_vnet_vxlan_gpe_h
23 #include <vppinfra/error.h>
24 #include <vppinfra/hash.h>
25 #include <vnet/vnet.h>
26 #include <vnet/ip/ip.h>
27 #include <vnet/l2/l2_input.h>
28 #include <vnet/ethernet/ethernet.h>
29 #include <vnet/vxlan-gpe/vxlan_gpe_packet.h>
30 #include <vnet/ip/ip4_packet.h>
31 #include <vnet/ip/ip6_packet.h>
32 #include <vnet/ip/udp.h>
35 * @brief VXLAN GPE header struct
38 typedef CLIB_PACKED (struct {
44 vxlan_gpe_header_t vxlan;
45 }) ip4_vxlan_gpe_header_t;
47 typedef CLIB_PACKED (struct {
53 vxlan_gpe_header_t vxlan;
54 }) ip6_vxlan_gpe_header_t;
57 * @brief Key struct for IPv4 VXLAN GPE tunnel.
58 * Key fields: local remote, vni
59 * all fields in NET byte order
62 typedef CLIB_PACKED(struct {
73 }) vxlan4_gpe_tunnel_key_t;
76 * @brief Key struct for IPv6 VXLAN GPE tunnel.
77 * Key fields: local remote, vni
78 * all fields in NET byte order
81 typedef CLIB_PACKED(struct {
85 }) vxlan6_gpe_tunnel_key_t;
88 * @brief Struct for VXLAN GPE tunnel
91 /** Rewrite string. $$$$ embed vnet_rewrite header */
94 /** encapsulated protocol */
97 /** tunnel local address */
99 /** tunnel remote address */
100 ip46_address_t remote;
102 /** FIB indices - tunnel partner lookup here */
104 /** FIB indices - inner IP packet lookup here */
107 /** VXLAN GPE VNI in HOST byte order, shifted left 8 bits */
110 /** vnet intfc hw_if_index */
112 /** vnet intfc sw_if_index */
118 /** rewrite size for dynamic plugins like iOAM */
121 /** Next node after VxLAN-GPE encap */
122 uword encap_next_node;
123 } vxlan_gpe_tunnel_t;
125 /** Flags for vxlan_gpe_tunnel_t */
126 #define VXLAN_GPE_TUNNEL_IS_IPV4 1
128 /** next nodes for VXLAN GPE input */
129 #define foreach_vxlan_gpe_input_next \
130 _(DROP, "error-drop") \
131 _(IP4_INPUT, "ip4-input") \
132 _(IP6_INPUT, "ip6-input") \
133 _(ETHERNET_INPUT, "ethernet-input")
135 /** struct for next nodes for VXLAN GPE input */
137 #define _(s,n) VXLAN_GPE_INPUT_NEXT_##s,
138 foreach_vxlan_gpe_input_next
140 VXLAN_GPE_INPUT_N_NEXT,
141 } vxlan_gpe_input_next_t;
143 /** struct for VXLAN GPE errors */
145 #define vxlan_gpe_error(n,s) VXLAN_GPE_ERROR_##n,
146 #include <vnet/vxlan-gpe/vxlan_gpe_error.def>
147 #undef vxlan_gpe_error
149 } vxlan_gpe_input_error_t;
151 /** Struct for VXLAN GPE node state */
153 /** vector of encap tunnel instances */
154 vxlan_gpe_tunnel_t *tunnels;
156 /** lookup IPv4 VXLAN GPE tunnel by key */
157 uword * vxlan4_gpe_tunnel_by_key;
158 /** lookup IPv6 VXLAN GPE tunnel by key */
159 uword * vxlan6_gpe_tunnel_by_key;
161 /** Free vlib hw_if_indices */
162 u32 * free_vxlan_gpe_tunnel_hw_if_indices;
164 /** Mapping from sw_if_index to tunnel index */
165 u32 * tunnel_index_by_sw_if_index;
167 /** State convenience vlib_main_t */
168 vlib_main_t * vlib_main;
169 /** State convenience vnet_main_t */
170 vnet_main_t * vnet_main;
172 /** List of next nodes for the decap indexed on protocol */
173 uword decap_next_node_list[VXLAN_GPE_PROTOCOL_MAX];
176 vxlan_gpe_main_t vxlan_gpe_main;
178 extern vlib_node_registration_t vxlan_gpe_encap_node;
179 extern vlib_node_registration_t vxlan4_gpe_input_node;
180 extern vlib_node_registration_t vxlan6_gpe_input_node;
182 u8 * format_vxlan_gpe_encap_trace (u8 * s, va_list * args);
184 /** Struct for VXLAN GPE add/del args */
188 ip46_address_t local, remote;
193 } vnet_vxlan_gpe_add_del_tunnel_args_t;
196 int vnet_vxlan_gpe_add_del_tunnel
197 (vnet_vxlan_gpe_add_del_tunnel_args_t *a, u32 * sw_if_indexp);
200 int vxlan4_gpe_rewrite (vxlan_gpe_tunnel_t * t, u32 extension_size,
201 u8 protocol_override, uword encap_next_node);
202 int vxlan6_gpe_rewrite (vxlan_gpe_tunnel_t * t, u32 extension_size,
203 u8 protocol_override, uword encap_next_node);
206 * @brief Struct for defining VXLAN GPE next nodes
209 VXLAN_GPE_ENCAP_NEXT_IP4_LOOKUP,
210 VXLAN_GPE_ENCAP_NEXT_IP6_LOOKUP,
211 VXLAN_GPE_ENCAP_NEXT_DROP,
212 VXLAN_GPE_ENCAP_N_NEXT
213 } vxlan_gpe_encap_next_t;
216 void vxlan_gpe_unregister_decap_protocol (u8 protocol_id, uword next_node_index);
218 void vxlan_gpe_register_decap_protocol (u8 protocol_id, uword next_node_index);
221 #endif /* included_vnet_vxlan_gpe_h */