FD.io VPP  v20.05.1-6-gf53edbc3b
Vector Packet Processing
gre.h
Go to the documentation of this file.
1 /*
2  * gre.h: types/functions for gre.
3  *
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:
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
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.
16  */
17 
18 #ifndef included_gre_h
19 #define included_gre_h
20 
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>
27 #include <vnet/tunnel/tunnel.h>
28 #include <vnet/teib/teib.h>
29 
32 
33 typedef enum
34 {
35 #define gre_error(n,s) GRE_ERROR_##n,
36 #include <vnet/gre/error.def>
37 #undef gre_error
39 } gre_error_t;
40 
41 /**
42  * L3: GRE (i.e. this tunnel is in L3 mode)
43  * TEB: Transparent Ethernet Bridging - the tunnel is in L2 mode
44  * ERSPAN: type 2 - the tunnel is for port mirror SPAN output. Each tunnel is
45  * associated with a session ID and expected to be used for encap
46  * and output of mirrored packet from a L2 network only. There is
47  * no support for receiving ERSPAN packets from a GRE ERSPAN tunnel
48  */
49 #define foreach_gre_tunnel_type \
50  _(L3, "L3") \
51  _(TEB, "TEB") \
52  _(ERSPAN, "ERSPAN") \
53 
54 /**
55  * @brief The GRE tunnel type
56  */
57 typedef enum gre_tunnel_type_t_
58 {
59 #define _(n, s) GRE_TUNNEL_TYPE_##n,
61 #undef _
62 } __clib_packed gre_tunnel_type_t;
63 
64 extern u8 *format_gre_tunnel_type (u8 * s, va_list * args);
65 
66 
67 /**
68  * A GRE payload protocol registration
69  */
70 typedef struct
71 {
72  /** Name (a c string). */
73  char *name;
74 
75  /** GRE protocol type in host byte order. */
77 
78  /** GRE tunnel type */
79  gre_tunnel_type_t tunnel_type;
80 
81  /** Node which handles this type. */
83 
84  /** Next index for this type. */
87 
88 /**
89  * Elements of the GRE key that are common for v6 and v6 addresses
90  */
92 {
93  union
94  {
95  struct
96  {
99  gre_tunnel_type_t type;
101  };
103  };
105 
107 
108 /**
109  * @brief Key for a IPv4 GRE Tunnel
110  */
111 typedef struct gre_tunnel_key4_t_
112 {
113  /**
114  * Source and destination IP addresses
115  */
116  union
117  {
118  struct
119  {
122  };
124  };
125 
126  /** address independent attributes */
128 } __attribute__ ((packed)) gre_tunnel_key4_t;
129 
131 
132 /**
133  * @brief Key for a IPv6 GRE Tunnel
134  * We use a different type so that the V4 key hash is as small as possible
135  */
136 typedef struct gre_tunnel_key6_t_
137 {
138  /**
139  * Source and destination IP addresses
140  */
141  ip6_address_t gtk_src;
142  ip6_address_t gtk_dst;
143 
144  /** address independent attributes */
146 } __attribute__ ((packed)) gre_tunnel_key6_t;
147 
149 
150 /**
151  * Union of the two possible key types
152  */
153 typedef union gre_tunnel_key_t_
154 {
158 
159 /**
160  * The session ID is only a 10 bit value
161  */
162 #define GTK_SESSION_ID_MAX (0x3ff)
163 
164 /**
165  * Used for GRE header seq number generation for ERSPAN encap
166  */
167 typedef struct
168 {
171 } gre_sn_t;
172 
173 /**
174  * Hash key for GRE header seq number generation for ERSPAN encap
175  */
176 typedef struct
177 {
178  ip46_address_t src;
179  ip46_address_t dst;
181 } gre_sn_key_t;
182 
183 /**
184  * @brief A representation of a GRE tunnel
185  */
186 typedef struct
187 {
188  /**
189  * Required for pool_get_aligned
190  */
191  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
192 
193  /**
194  * The tunnel's source/local address
195  */
196  ip46_address_t tunnel_src;
197  /**
198  * The tunnel's destination/remote address
199  */
201  /**
202  * The FIB in which the src.dst address are present
203  */
207  gre_tunnel_type_t type;
210 
211  /**
212  * an L2 tunnel always rquires an L2 midchain. cache here for DP.
213  */
215 
216  /**
217  * ERSPAN type 2 session ID, least significant 10 bits of u16
218  */
220 
221  /**
222  * GRE header sequence number (SN) used for ERSPAN type 2 header, must be
223  * bumped automically to be thread safe. As multiple GRE tunnels are created
224  * for the same fib-idx/DIP/SIP with different ERSPAN session number, they all
225  * share the same SN which is kept per FIB/DIP/SIP, as specified by RFC2890.
226  */
228 
229 
230  u32 dev_instance; /* Real device instance in tunnel vector */
231  u32 user_instance; /* Instance name being shown to user */
232 } gre_tunnel_t;
233 
234 typedef struct
235 {
238 } next_info_t;
239 
240 /**
241  * @brief GRE related global data
242  */
243 typedef struct
244 {
245  /**
246  * pool of tunnel instances
247  */
249 
250  /**
251  * GRE payload protocol registrations
252  */
254 
255  /**
256  * Hash tables mapping name/protocol to protocol info index.
257  */
258  uword *protocol_info_by_name, *protocol_info_by_protocol;
259 
260  /**
261  * Hash mapping to tunnels with ipv4 src/dst addr
262  */
264 
265  /**
266  * Hash mapping to tunnels with ipv6 src/dst addr
267  */
269 
270  /**
271  * Hash mapping tunnel src/dst addr and fib-idx to sequence number
272  */
274 
275  /**
276  * Mapping from sw_if_index to tunnel index
277  */
279 
280  /* Sparse vector mapping gre protocol in network byte order
281  to next index. */
283 
284  /* convenience */
287 
288  /* Record used instances */
290 } gre_main_t;
291 
292 /**
293  * @brief IPv4 and GRE header.
294  */
295 /* *INDENT-OFF* */
296 typedef CLIB_PACKED (struct {
298  gre_header_t gre;
299 }) ip4_and_gre_header_t;
300 /* *INDENT-ON* */
301 
302 /**
303  * @brief IPv6 and GRE header.
304  */
305 /* *INDENT-OFF* */
306 typedef CLIB_PACKED (struct {
308  gre_header_t gre;
309 }) ip6_and_gre_header_t;
310 /* *INDENT-ON* */
311 
314 {
315  uword *p = hash_get (em->protocol_info_by_protocol, protocol);
316  return p ? vec_elt_at_index (em->protocol_infos, p[0]) : 0;
317 }
318 
319 extern gre_main_t gre_main;
320 
322  u32 hw_if_index, u32 flags);
323 
324 extern void gre_tunnel_stack (adj_index_t ai);
325 extern void gre_update_adj (vnet_main_t * vnm,
326  u32 sw_if_index, adj_index_t ai);
327 
328 typedef struct mgre_walk_ctx_t_
329 {
330  const gre_tunnel_t *t;
331  const teib_entry_t *ne;
333 
336 
340 
346 
347 /* Parse gre protocol as 0xXXXX or protocol name.
348  In either host or network byte order. */
351 
352 /* Parse gre header. */
355 
356 void
358  u32 node_index, gre_tunnel_type_t tunnel_type);
359 
360 /* manually added to the interface output node in gre.c */
361 #define GRE_OUTPUT_NEXT_LOOKUP 1
362 
363 typedef struct
364 {
366  gre_tunnel_type_t type;
370  ip46_address_t src, dst;
375 
377  u32 * sw_if_indexp);
378 
379 static inline void
382  u32 fib_index,
383  gre_tunnel_type_t ttype,
385 {
386  key->gtk_src = src;
387  key->gtk_dst = dst;
388  key->gtk_common.type = ttype;
389  key->gtk_common.mode = tmode;
392 }
393 
394 static inline int
396  const gre_tunnel_key4_t * key2)
397 {
398  return ((key1->gtk_as_u64 == key2->gtk_as_u64) &&
399  (key1->gtk_common.as_u64 == key2->gtk_common.as_u64));
400 }
401 
402 static inline void
403 gre_mk_key6 (const ip6_address_t * src,
404  const ip6_address_t * dst,
405  u32 fib_index,
406  gre_tunnel_type_t ttype,
408 {
409  key->gtk_src = *src;
410  key->gtk_dst = *dst;
411  key->gtk_common.type = ttype;
412  key->gtk_common.mode = tmode;
415 }
416 
417 static inline int
419  const gre_tunnel_key6_t * key2)
420 {
421  return (ip6_address_is_equal (&key1->gtk_src, &key2->gtk_src) &&
422  ip6_address_is_equal (&key1->gtk_dst, &key2->gtk_dst) &&
423  (key1->gtk_common.as_u64 == key2->gtk_common.as_u64));
424 }
425 
426 static inline void
428 {
429  key->src = gt->tunnel_src;
430  key->dst = gt->tunnel_dst.fp_addr;
431  key->fib_index = gt->outer_fib_index;
432 }
433 
434 #endif /* included_gre_h */
435 
436 /*
437  * fd.io coding-style-patch-verification: ON
438  *
439  * Local Variables:
440  * eval: (c-set-style "gnu")
441  * End:
442  */
vnet_main_t * vnet_main
Definition: gre.h:286
uword * seq_num_by_key
Hash mapping tunnel src/dst addr and fib-idx to sequence number.
Definition: gre.h:273
vlib_node_registration_t gre_teb_encap_node
(constructor) VLIB_REGISTER_NODE (gre_teb_encap_node)
Definition: gre.c:670
static void gre_mk_key6(const ip6_address_t *src, const ip6_address_t *dst, u32 fib_index, gre_tunnel_type_t ttype, tunnel_mode_t tmode, u16 session_id, gre_tunnel_key6_t *key)
Definition: gre.h:403
vlib_node_registration_t gre4_input_node
(constructor) VLIB_REGISTER_NODE (gre4_input_node)
Definition: node.c:454
uword * tunnel_by_key6
Hash mapping to tunnels with ipv6 src/dst addr.
Definition: gre.h:268
GRE related global data.
Definition: gre.h:243
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
format_function_t format_gre_header_with_length
Definition: gre.h:339
ip4_address_t gtk_dst
Definition: gre.h:121
u32 hw_if_index
Definition: gre.h:205
Key for a IPv6 GRE Tunnel We use a different type so that the V4 key hash is as small as possible...
Definition: gre.h:136
a
Definition: bitmap.h:538
adj_walk_rc_t mgre_mk_complete_walk(adj_index_t ai, void *data)
Definition: gre.c:429
uword * protocol_info_by_protocol
Definition: gre.h:258
unsigned long u64
Definition: types.h:89
struct gre_tunnel_key_common_t_ gre_tunnel_key_common_t
Elements of the GRE key that are common for v6 and v6 addresses.
gre_protocol_t protocol
GRE protocol type in host byte order.
Definition: gre.h:76
char * name
Name (a c string).
Definition: gre.h:73
A GRE payload protocol registration.
Definition: gre.h:70
int vnet_gre_tunnel_add_del(vnet_gre_tunnel_add_del_args_t *a, u32 *sw_if_indexp)
Definition: interface.c:526
tunnel_mode_t mode
Definition: gre.h:367
u32 outer_fib_index
The FIB in which the src.dst address are present.
Definition: gre.h:204
vl_api_address_t src
Definition: gre.api:54
STATIC_ASSERT_SIZEOF(gre_tunnel_key_common_t, sizeof(u64))
const gre_tunnel_t * t
Definition: gre.h:330
typedef CLIB_PACKED(struct { ip4_header_t ip4;gre_header_t gre;}) ip4_and_gre_header_t
IPv4 and GRE header.
gre_tunnel_type_t_
The GRE tunnel type.
Definition: gre.h:57
struct _vnet_device_class vnet_device_class_t
unsigned char u8
Definition: types.h:56
ip4_address_t gtk_src
Definition: gre.h:120
u32 * tunnel_index_by_sw_if_index
Mapping from sw_if_index to tunnel index.
Definition: gre.h:278
u64 gtk_as_u64
Definition: gre.h:123
static void gre_mk_key4(ip4_address_t src, ip4_address_t dst, u32 fib_index, gre_tunnel_type_t ttype, tunnel_mode_t tmode, u16 session_id, gre_tunnel_key4_t *key)
Definition: gre.h:380
u32 seq_num
Definition: gre.h:169
vnet_hw_interface_class_t mgre_hw_interface_class
u8 *() format_function_t(u8 *s, va_list *args)
Definition: format.h:48
Hash key for GRE header seq number generation for ERSPAN encap.
Definition: gre.h:176
vl_api_ip_proto_t protocol
Definition: lb_types.api:71
u32 sw_if_index
Definition: gre.h:206
u32 dev_instance
Definition: gre.h:230
ip6_address_t gtk_dst
Definition: gre.h:142
vl_api_ip6_address_t ip6
Definition: one.api:424
void gre_tunnel_stack(adj_index_t ai)
gre_tunnel_stack
Definition: interface.c:132
enum adj_walk_rc_t_ adj_walk_rc_t
return codes from a adjacency walker callback function
gre_tunnel_type_t tunnel_type
GRE tunnel type.
Definition: gre.h:79
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
Aggregate type for a prefix.
Definition: fib_types.h:203
ip46_address_t src
Definition: gre.h:370
unsigned int u32
Definition: types.h:88
adj_index_t l2_adj_index
an L2 tunnel always rquires an L2 midchain.
Definition: gre.h:214
unformat_function_t unformat_gre_header
Definition: gre.h:353
ip46_address_t tunnel_src
The tunnel&#39;s source/local address.
Definition: gre.h:196
#define hash_get(h, key)
Definition: hash.h:249
uword * tunnel_by_key4
Hash mapping to tunnels with ipv4 src/dst addr.
Definition: gre.h:263
A representation of a GRE tunnel.
Definition: gre.h:186
uword * instance_used
Definition: gre.h:289
ip46_address_t fp_addr
The address type is not deriveable from the fp_addr member.
Definition: fib_types.h:226
struct gre_tunnel_key6_t_ gre_tunnel_key6_t
Key for a IPv6 GRE Tunnel We use a different type so that the V4 key hash is as small as possible...
ip6_address_t gtk_src
Source and destination IP addresses.
Definition: gre.h:141
unformat_function_t unformat_gre_protocol_net_byte_order
Definition: gre.h:350
unsigned short u16
Definition: types.h:57
static int gre_match_key4(const gre_tunnel_key4_t *key1, const gre_tunnel_key4_t *key2)
Definition: gre.h:395
gre_tunnel_key4_t gtk_v4
Definition: gre.h:155
u32 node_index
Node which handles this type.
Definition: gre.h:82
#define always_inline
Definition: ipsec.h:28
vl_api_ip4_address_t ip4
Definition: one.api:376
void gre_register_input_protocol(vlib_main_t *vm, gre_protocol_t protocol, u32 node_index, gre_tunnel_type_t tunnel_type)
Definition: node.c:499
gre_tunnel_type_t type
Definition: gre.h:99
static int gre_match_key6(const gre_tunnel_key6_t *key1, const gre_tunnel_key6_t *key2)
Definition: gre.h:418
uword() unformat_function_t(unformat_input_t *input, va_list *args)
Definition: format.h:233
vl_api_address_t dst
Definition: gre.api:55
enum tunnel_encap_decap_flags_t_ tunnel_encap_decap_flags_t
vlib_main_t * vm
Definition: in2out_ed.c:1599
Key for a IPv4 GRE Tunnel.
Definition: gre.h:111
union gre_tunnel_key_t_ gre_tunnel_key_t
Union of the two possible key types.
gre_tunnel_type_t type
Definition: gre.h:207
Definition: teib.c:29
gre_sn_t * gre_sn
GRE header sequence number (SN) used for ERSPAN type 2 header, must be bumped automically to be threa...
Definition: gre.h:227
gre_tunnel_key6_t gtk_v6
Definition: gre.h:156
u8 tunnel_type
Definition: gre.h:237
format_function_t format_gre_protocol
Definition: gre.h:337
ip46_address_t src
Definition: gre.h:178
gre_protocol_t
Definition: packet.h:30
ip46_address_t dst
Definition: gre.h:179
Used for GRE header seq number generation for ERSPAN encap.
Definition: gre.h:167
tunnel_mode_t mode
Definition: gre.h:100
u32 adj_index_t
An index for adjacencies.
Definition: adj_types.h:30
vlib_node_registration_t gre_erspan_encap_node
(constructor) VLIB_REGISTER_NODE (gre_erspan_encap_node)
Definition: gre.c:683
gre_tunnel_type_t type
Definition: gre.h:366
const teib_entry_t * ne
Definition: gre.h:331
u8 data[128]
Definition: ipsec_types.api:89
u32 next_index
Next index for this type.
Definition: gre.h:85
Elements of the GRE key that are common for v6 and v6 addresses.
Definition: gre.h:91
void gre_update_adj(vnet_main_t *vnm, u32 sw_if_index, adj_index_t ai)
Definition: gre.c:404
gre_tunnel_t * tunnels
pool of tunnel instances
Definition: gre.h:248
u32 fib_index
Definition: gre.h:180
tunnel_mode_t mode
Definition: gre.h:208
gre_main_t gre_main
static uword ip6_address_is_equal(const ip6_address_t *a, const ip6_address_t *b)
Definition: ip6_packet.h:167
next_info_t * next_by_protocol
Definition: gre.h:282
Union of the two possible key types.
Definition: gre.h:153
vnet_hw_interface_class_t gre_hw_interface_class
u32 user_instance
Definition: gre.h:231
typedef key
Definition: ipsec_types.api:85
struct _vlib_node_registration vlib_node_registration_t
vnet_device_class_t gre_device_class
clib_error_t * gre_interface_admin_up_down(vnet_main_t *vnm, u32 hw_if_index, u32 flags)
Definition: interface.c:552
struct _vnet_hw_interface_class vnet_hw_interface_class_t
u8 * format_gre_tunnel_type(u8 *s, va_list *args)
Definition: interface.c:31
u64 uword
Definition: types.h:112
u32 ref_count
Definition: gre.h:170
#define foreach_gre_tunnel_type
L3: GRE (i.e.
Definition: gre.h:49
unformat_function_t unformat_pg_gre_header
Definition: gre.h:354
u8 next_index
Definition: gre.h:236
gre_tunnel_key_common_t gtk_common
address independent attributes
Definition: gre.h:145
tunnel_encap_decap_flags_t flags
Definition: gre.h:373
adj_walk_rc_t mgre_mk_incomplete_walk(adj_index_t ai, void *data)
Definition: gre.c:449
vlib_node_registration_t gre6_input_node
(constructor) VLIB_REGISTER_NODE (gre6_input_node)
Definition: node.c:474
unformat_function_t unformat_gre_protocol_host_byte_order
Definition: gre.h:349
enum gre_tunnel_type_t_ gre_tunnel_type_t
The GRE tunnel type.
fib_prefix_t tunnel_dst
The tunnel&#39;s destination/remote address.
Definition: gre.h:200
static gre_protocol_info_t * gre_get_protocol_info(gre_main_t *em, gre_protocol_t protocol)
Definition: gre.h:313
gre_protocol_info_t * protocol_infos
GRE payload protocol registrations.
Definition: gre.h:253
vlib_main_t * vlib_main
Definition: gre.h:285
format_function_t format_gre_header
Definition: gre.h:338
u16 session_id
ERSPAN type 2 session ID, least significant 10 bits of u16.
Definition: gre.h:219
enum tunnel_mode_t_ tunnel_mode_t
static void gre_mk_sn_key(const gre_tunnel_t *gt, gre_sn_key_t *key)
Definition: gre.h:427
tunnel_encap_decap_flags_t flags
Definition: gre.h:209
struct mgre_walk_ctx_t_ mgre_walk_ctx_t
gre_tunnel_key_common_t gtk_common
address independent attributes
Definition: gre.h:127
struct gre_tunnel_key4_t_ gre_tunnel_key4_t
Key for a IPv4 GRE Tunnel.
gre_error_t
Definition: gre.h:33