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/ip/format.h>
25 #include <vnet/adj/adj_types.h>
26 #include <vnet/tunnel/tunnel.h>
27 #include <vnet/teib/teib.h>
29 extern vnet_hw_interface_class_t gre_hw_interface_class;
30 extern vnet_hw_interface_class_t mgre_hw_interface_class;
34 #define gre_error(n,s) GRE_ERROR_##n,
35 #include <vnet/gre/error.def>
41 * L3: GRE (i.e. this tunnel is in L3 mode)
42 * TEB: Transparent Ethernet Bridging - the tunnel is in L2 mode
43 * ERSPAN: type 2 - the tunnel is for port mirror SPAN output. Each tunnel is
44 * associated with a session ID and expected to be used for encap
45 * and output of mirrored packet from a L2 network only. There is
46 * no support for receiving ERSPAN packets from a GRE ERSPAN tunnel
48 #define foreach_gre_tunnel_type \
54 * @brief The GRE tunnel type
56 typedef enum gre_tunnel_type_t_
58 #define _(n, s) GRE_TUNNEL_TYPE_##n,
59 foreach_gre_tunnel_type
61 } __clib_packed gre_tunnel_type_t;
63 extern u8 *format_gre_tunnel_type (u8 * s, va_list * args);
67 * A GRE payload protocol registration
71 /** Name (a c string). */
74 /** GRE protocol type in host byte order. */
75 gre_protocol_t protocol;
77 /** GRE tunnel type */
78 gre_tunnel_type_t tunnel_type;
80 /** Node which handles this type. */
83 /** Next index for this type. */
85 } gre_protocol_info_t;
88 * Elements of the GRE key that are common for v6 and v6 addresses
90 typedef struct gre_tunnel_key_common_t_
98 gre_tunnel_type_t type;
103 } gre_tunnel_key_common_t;
105 STATIC_ASSERT_SIZEOF (gre_tunnel_key_common_t, sizeof (u64));
108 * @brief Key for a IPv4 GRE Tunnel
110 typedef struct gre_tunnel_key4_t_
113 * Source and destination IP addresses
119 ip4_address_t gtk_src;
120 ip4_address_t gtk_dst;
125 /** address independent attributes */
126 gre_tunnel_key_common_t gtk_common;
127 } __attribute__ ((packed)) gre_tunnel_key4_t;
129 STATIC_ASSERT_SIZEOF (gre_tunnel_key4_t, 2 * sizeof (u64));
132 * @brief Key for a IPv6 GRE Tunnel
133 * We use a different type so that the V4 key hash is as small as possible
135 typedef struct gre_tunnel_key6_t_
138 * Source and destination IP addresses
140 ip6_address_t gtk_src;
141 ip6_address_t gtk_dst;
143 /** address independent attributes */
144 gre_tunnel_key_common_t gtk_common;
145 } __attribute__ ((packed)) gre_tunnel_key6_t;
147 STATIC_ASSERT_SIZEOF (gre_tunnel_key6_t, 5 * sizeof (u64));
150 * Union of the two possible key types
152 typedef union gre_tunnel_key_t_
154 gre_tunnel_key4_t gtk_v4;
155 gre_tunnel_key6_t gtk_v6;
159 * The session ID is only a 10 bit value
161 #define GTK_SESSION_ID_MAX (0x3ff)
164 * Used for GRE header seq number generation for ERSPAN encap
173 * Hash key for GRE header seq number generation for ERSPAN encap
183 * @brief A representation of a GRE tunnel
188 * Required for pool_get_aligned
190 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
193 * The tunnel's source/local address
195 ip46_address_t tunnel_src;
197 * The tunnel's destination/remote address
199 fib_prefix_t tunnel_dst;
201 * The FIB in which the src.dst address are present
206 gre_tunnel_type_t type;
208 tunnel_encap_decap_flags_t flags;
211 * an L2 tunnel always rquires an L2 midchain. cache here for DP.
213 adj_index_t l2_adj_index;
216 * ERSPAN type 2 session ID, least significant 10 bits of u16
221 * GRE header sequence number (SN) used for ERSPAN type 2 header, must be
222 * bumped automically to be thread safe. As multiple GRE tunnels are created
223 * for the same fib-idx/DIP/SIP with different ERSPAN session number, they all
224 * share the same SN which is kept per FIB/DIP/SIP, as specified by RFC2890.
229 u32 dev_instance; /* Real device instance in tunnel vector */
230 u32 user_instance; /* Instance name being shown to user */
240 * @brief GRE related global data
245 * pool of tunnel instances
247 gre_tunnel_t *tunnels;
250 * GRE payload protocol registrations
252 gre_protocol_info_t *protocol_infos;
255 * Hash tables mapping name/protocol to protocol info index.
257 uword *protocol_info_by_name, *protocol_info_by_protocol;
260 * Hash mapping to tunnels with ipv4 src/dst addr
262 uword *tunnel_by_key4;
265 * Hash mapping to tunnels with ipv6 src/dst addr
267 uword *tunnel_by_key6;
270 * Hash mapping tunnel src/dst addr and fib-idx to sequence number
272 uword *seq_num_by_key;
275 * Mapping from sw_if_index to tunnel index
277 u32 *tunnel_index_by_sw_if_index;
279 /* Sparse vector mapping gre protocol in network byte order
281 next_info_t *next_by_protocol;
284 vlib_main_t *vlib_main;
285 vnet_main_t *vnet_main;
287 /* Record used instances */
288 uword *instance_used;
292 * @brief IPv4 and GRE header.
295 typedef CLIB_PACKED (struct {
298 }) ip4_and_gre_header_t;
302 * @brief IPv6 and GRE header.
305 typedef CLIB_PACKED (struct {
308 }) ip6_and_gre_header_t;
311 always_inline gre_protocol_info_t *
312 gre_get_protocol_info (gre_main_t * em, gre_protocol_t protocol)
314 uword *p = hash_get (em->protocol_info_by_protocol, protocol);
315 return p ? vec_elt_at_index (em->protocol_infos, p[0]) : 0;
318 extern gre_main_t gre_main;
320 extern clib_error_t *gre_interface_admin_up_down (vnet_main_t * vnm,
321 u32 hw_if_index, u32 flags);
323 extern void gre_tunnel_stack (adj_index_t ai);
324 extern void gre_update_adj (vnet_main_t * vnm,
325 u32 sw_if_index, adj_index_t ai);
327 typedef struct mgre_walk_ctx_t_
329 const gre_tunnel_t *t;
330 const teib_entry_t *ne;
333 adj_walk_rc_t mgre_mk_complete_walk (adj_index_t ai, void *data);
334 adj_walk_rc_t mgre_mk_incomplete_walk (adj_index_t ai, void *data);
336 format_function_t format_gre_protocol;
337 format_function_t format_gre_header;
338 format_function_t format_gre_header_with_length;
340 extern vlib_node_registration_t gre4_input_node;
341 extern vlib_node_registration_t gre6_input_node;
342 extern vlib_node_registration_t gre_erspan_encap_node;
343 extern vlib_node_registration_t gre_teb_encap_node;
344 extern vnet_device_class_t gre_device_class;
346 /* Parse gre protocol as 0xXXXX or protocol name.
347 In either host or network byte order. */
348 unformat_function_t unformat_gre_protocol_host_byte_order;
349 unformat_function_t unformat_gre_protocol_net_byte_order;
351 /* Parse gre header. */
352 unformat_function_t unformat_gre_header;
353 unformat_function_t unformat_pg_gre_header;
356 gre_register_input_protocol (vlib_main_t * vm, gre_protocol_t protocol,
357 u32 node_index, gre_tunnel_type_t tunnel_type);
359 /* manually added to the interface output node in gre.c */
360 #define GRE_OUTPUT_NEXT_LOOKUP 1
365 gre_tunnel_type_t type;
369 ip46_address_t src, dst;
372 tunnel_encap_decap_flags_t flags;
373 } vnet_gre_tunnel_add_del_args_t;
375 extern int vnet_gre_tunnel_add_del (vnet_gre_tunnel_add_del_args_t * a,
379 gre_mk_key4 (ip4_address_t src,
382 gre_tunnel_type_t ttype,
383 tunnel_mode_t tmode, u16 session_id, gre_tunnel_key4_t * key)
387 key->gtk_common.type = ttype;
388 key->gtk_common.mode = tmode;
389 key->gtk_common.fib_index = fib_index;
390 key->gtk_common.session_id = session_id;
394 gre_match_key4 (const gre_tunnel_key4_t * key1,
395 const gre_tunnel_key4_t * key2)
397 return ((key1->gtk_as_u64 == key2->gtk_as_u64) &&
398 (key1->gtk_common.as_u64 == key2->gtk_common.as_u64));
402 gre_mk_key6 (const ip6_address_t * src,
403 const ip6_address_t * dst,
405 gre_tunnel_type_t ttype,
406 tunnel_mode_t tmode, u16 session_id, gre_tunnel_key6_t * key)
410 key->gtk_common.type = ttype;
411 key->gtk_common.mode = tmode;
412 key->gtk_common.fib_index = fib_index;
413 key->gtk_common.session_id = session_id;
417 gre_match_key6 (const gre_tunnel_key6_t * key1,
418 const gre_tunnel_key6_t * key2)
420 return (ip6_address_is_equal (&key1->gtk_src, &key2->gtk_src) &&
421 ip6_address_is_equal (&key1->gtk_dst, &key2->gtk_dst) &&
422 (key1->gtk_common.as_u64 == key2->gtk_common.as_u64));
426 gre_mk_sn_key (const gre_tunnel_t * gt, gre_sn_key_t * key)
428 key->src = gt->tunnel_src;
429 key->dst = gt->tunnel_dst.fp_addr;
430 key->fib_index = gt->outer_fib_index;
433 #endif /* included_gre_h */
436 * fd.io coding-style-patch-verification: ON
439 * eval: (c-set-style "gnu")