2 * gre.h: types/functions for gre.
4 * Copyright (c) 2012 Cisco and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 #ifndef included_gre_h
19 #define included_gre_h
21 #include <vnet/vnet.h>
22 #include <vnet/gre/packet.h>
23 #include <vnet/ip/ip.h>
24 #include <vnet/pg/pg.h>
25 #include <vnet/ip/format.h>
26 #include <vnet/adj/adj_types.h>
28 extern vnet_hw_interface_class_t gre_hw_interface_class;
31 #define gre_error(n,s) GRE_ERROR_##n,
32 #include <vnet/gre/error.def>
38 * A GRE payload protocol registration
41 /** Name (a c string). */
44 /** GRE protocol type in host byte order. */
45 gre_protocol_t protocol;
47 /** Node which handles this type. */
50 /** Next index for this type. */
52 } gre_protocol_info_t;
55 * @brief The GRE tunnel type
57 typedef enum gre_tunnel_tyoe_t_
60 * L3 GRE (i.e. this tunnel is in L3 mode)
64 * Transparent Ethernet Bridging - the tunnel is in L2 mode
69 #define GRE_TUNNEL_TYPE_NAMES { \
70 [GRE_TUNNEL_TYPE_L3] = "L3", \
71 [GRE_TUNNEL_TYPE_TEB] = "TEB", \
74 #define GRE_TUNNEL_N_TYPES ((gre_tunnel_type_t)GRE_TUNNEL_TYPE_TEB+1)
77 * @brief A representation of a GRE tunnel
81 * Linkage into the FIB object graph
86 * The tunnel's source/local address
88 ip46_address_t tunnel_src;
90 * The tunnel's destination/remote address
92 fib_prefix_t tunnel_dst;
94 * The FIB in which the src.dst address are present
99 gre_tunnel_type_t type;
102 * The FIB entry sourced by the tunnel for its destination prefix
104 fib_node_index_t fib_entry_index;
107 * The tunnel is a child of the FIB entry for its desintion. This is
108 * so it receives updates when the forwarding information for that entry
110 * The tunnels sibling index on the FIB entry's dependency list.
115 * on a L2 tunnel this is the VLIB arc from the L2-tx to the l2-midchain
120 * an L2 tunnel always rquires an L2 midchain. cache here for DP.
122 adj_index_t l2_adj_index;
126 * @brief GRE related global data
130 * pool of tunnel instances
132 gre_tunnel_t *tunnels;
135 * GRE payload protocol registrations
137 gre_protocol_info_t * protocol_infos;
140 * Hash tables mapping name/protocol to protocol info index.
142 uword * protocol_info_by_name, * protocol_info_by_protocol;
145 * Hash mapping ipv4 src/dst addr pair to tunnel
147 uword * tunnel_by_key4;
150 * Hash mapping ipv6 src/dst addr pair to tunnel
152 uword * tunnel_by_key6;
155 * Free vlib hw_if_indices.
156 * A free list per-tunnel type since the interfaces ctreated are fo different
157 * types and we cannot change the type.
159 u32 * free_gre_tunnel_hw_if_indices[GRE_TUNNEL_N_TYPES];
162 * Mapping from sw_if_index to tunnel index
164 u32 * tunnel_index_by_sw_if_index;
166 /* Sparse vector mapping gre protocol in network byte order
168 u16 * next_by_protocol;
171 vlib_main_t * vlib_main;
172 vnet_main_t * vnet_main;
176 * @brief IPv4 and GRE header.
178 typedef CLIB_PACKED (struct {
181 }) ip4_and_gre_header_t;
184 * @brief IPv6 and GRE header.
186 typedef CLIB_PACKED (struct {
189 }) ip6_and_gre_header_t;
191 always_inline gre_protocol_info_t *
192 gre_get_protocol_info (gre_main_t * em, gre_protocol_t protocol)
194 uword * p = hash_get (em->protocol_info_by_protocol, protocol);
195 return p ? vec_elt_at_index (em->protocol_infos, p[0]) : 0;
200 /* Register given node index to take input for given gre type. */
202 gre_register_input_type (vlib_main_t * vm,
203 gre_protocol_t protocol,
206 extern clib_error_t * gre_interface_admin_up_down (vnet_main_t * vnm,
210 extern void gre_tunnel_stack (adj_index_t ai);
211 extern void gre_update_adj (vnet_main_t * vnm,
215 format_function_t format_gre_protocol;
216 format_function_t format_gre_header;
217 format_function_t format_gre_header_with_length;
219 extern vlib_node_registration_t gre4_input_node;
220 extern vlib_node_registration_t gre6_input_node;
221 extern vnet_device_class_t gre_device_class;
222 extern vnet_device_class_t gre_device_teb_class;
224 /* Parse gre protocol as 0xXXXX or protocol name.
225 In either host or network byte order. */
226 unformat_function_t unformat_gre_protocol_host_byte_order;
227 unformat_function_t unformat_gre_protocol_net_byte_order;
229 /* Parse gre header. */
230 unformat_function_t unformat_gre_header;
231 unformat_function_t unformat_pg_gre_header;
234 gre_register_input_protocol (vlib_main_t * vm,
235 gre_protocol_t protocol,
238 /* manually added to the interface output node in gre.c */
239 #define GRE_OUTPUT_NEXT_LOOKUP 1
244 ip46_address_t src, dst;
248 } vnet_gre_add_del_tunnel_args_t;
250 int vnet_gre_add_del_tunnel
251 (vnet_gre_add_del_tunnel_args_t *a, u32 * sw_if_indexp);
253 #endif /* included_gre_h */