FD.io VPP  v17.01.1-3-gc6833f8
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/ip/ip4.h>
25 #include <vnet/ip/ip4_packet.h>
26 #include <vnet/pg/pg.h>
27 #include <vnet/ip/format.h>
28 #include <vnet/adj/adj_types.h>
29 
31 
32 typedef enum {
33 #define gre_error(n,s) GRE_ERROR_##n,
34 #include <vnet/gre/error.def>
35 #undef gre_error
36  GRE_N_ERROR,
37 } gre_error_t;
38 
39 /**
40  * A GRE payload protocol registration
41  */
42 typedef struct {
43  /** Name (a c string). */
44  char * name;
45 
46  /** GRE protocol type in host byte order. */
48 
49  /** Node which handles this type. */
51 
52  /** Next index for this type. */
55 
56 /**
57  * @brief The GRE tunnel type
58  */
59 typedef enum gre_tunnel_tyoe_t_
60 {
61  /**
62  * L3 GRE (i.e. this tunnel is in L3 mode)
63  */
65  /**
66  * Transparent Ethernet Bridging - the tunnel is in L2 mode
67  */
70 
71 #define GRE_TUNNEL_TYPE_NAMES { \
72  [GRE_TUNNEL_TYPE_L3] = "L3", \
73  [GRE_TUNNEL_TYPE_TEB] = "TEB", \
74 }
75 
76 #define GRE_TUNNEL_N_TYPES ((gre_tunnel_type_t)GRE_TUNNEL_TYPE_TEB+1)
77 
78 /**
79  * @brief A representation of a GRE tunnel
80  */
81 typedef struct {
82  /**
83  * Linkage into the FIB object graph
84  */
86 
87  /**
88  * The tunnel's source/local address
89  */
91  /**
92  * The tunnel's destination/remote address
93  */
95  /**
96  * The FIB in which the src.dst address are present
97  */
101  gre_tunnel_type_t type;
102 
103  /**
104  * The FIB entry sourced by the tunnel for its destination prefix
105  */
107 
108  /**
109  * The tunnel is a child of the FIB entry for its desintion. This is
110  * so it receives updates when the forwarding information for that entry
111  * changes.
112  * The tunnels sibling index on the FIB entry's dependency list.
113  */
115 
116  /**
117  * on a L2 tunnel this is the VLIB arc from the L2-tx to the l2-midchain
118  */
120 
121  /**
122  * an L2 tunnel always rquires an L2 midchain. cache here for DP.
123  */
125 } gre_tunnel_t;
126 
127 /**
128  * @brief GRE related global data
129  */
130 typedef struct {
131  /**
132  * pool of tunnel instances
133  */
135 
136  /**
137  * GRE payload protocol registrations
138  */
140 
141  /**
142  * Hash tables mapping name/protocol to protocol info index.
143  */
144  uword * protocol_info_by_name, * protocol_info_by_protocol;
145  /**
146  * Hash mapping src/dst addr pair to tunnel
147  */
149 
150  /**
151  * Free vlib hw_if_indices.
152  * A free list per-tunnel type since the interfaces ctreated are fo different
153  * types and we cannot change the type.
154  */
155  u32 * free_gre_tunnel_hw_if_indices[GRE_TUNNEL_N_TYPES];
156 
157  /**
158  * Mapping from sw_if_index to tunnel index
159  */
161 
162  /* convenience */
165 } gre_main_t;
166 
167 /**
168  * @brief IPv4 and GRE header.
169  */
170 typedef CLIB_PACKED (struct {
171  ip4_header_t ip4;
172  gre_header_t gre;
173 }) ip4_and_gre_header_t;
174 
177 {
178  uword * p = hash_get (em->protocol_info_by_protocol, protocol);
179  return p ? vec_elt_at_index (em->protocol_infos, p[0]) : 0;
180 }
181 
183 
184 /* Register given node index to take input for given gre type. */
185 void
187  gre_protocol_t protocol,
188  u32 node_index);
189 
191  u32 hw_if_index,
192  u32 flags);
193 
194 extern void gre_tunnel_stack (adj_index_t ai);
195 extern void gre_update_adj (vnet_main_t * vnm,
196  u32 sw_if_index,
197  adj_index_t ai);
198 
202 
206 
207 /* Parse gre protocol as 0xXXXX or protocol name.
208  In either host or network byte order. */
211 
212 /* Parse gre header. */
215 
216 void
218  gre_protocol_t protocol,
219  u32 node_index);
220 
221 /* manually added to the interface output node in gre.c */
222 #define GRE_OUTPUT_NEXT_LOOKUP 1
223 
224 typedef struct {
226 
231 
233  (vnet_gre_add_del_tunnel_args_t *a, u32 * sw_if_indexp);
234 
235 #endif /* included_gre_h */
vnet_main_t * vnet_main
Definition: gre.h:164
GRE related global data.
Definition: gre.h:130
format_function_t format_gre_header_with_length
Definition: gre.h:201
fib_node_index_t fib_entry_index
The FIB entry sourced by the tunnel for its destination prefix.
Definition: gre.h:106
u32 hw_if_index
Definition: gre.h:99
uword( unformat_function_t)(unformat_input_t *input, va_list *args)
Definition: format.h:231
gre_tunnel_tyoe_t_
The GRE tunnel type.
Definition: gre.h:59
typedef CLIB_PACKED(struct{ip4_header_t ip4;gre_header_t gre;}) ip4_and_gre_header_t
IPv4 and GRE header.
a
Definition: bitmap.h:516
uword * protocol_info_by_protocol
Definition: gre.h:144
uword * tunnel_by_key
Hash mapping src/dst addr pair to tunnel.
Definition: gre.h:148
gre_protocol_t protocol
GRE protocol type in host byte order.
Definition: gre.h:47
char * name
Name (a c string).
Definition: gre.h:44
A GRE payload protocol registration.
Definition: gre.h:42
u32 outer_fib_index
The FIB in which the src.dst address are present.
Definition: gre.h:98
#define GRE_TUNNEL_N_TYPES
Definition: gre.h:76
struct _vlib_node_registration vlib_node_registration_t
struct _vnet_device_class vnet_device_class_t
u32 * tunnel_index_by_sw_if_index
Mapping from sw_if_index to tunnel index.
Definition: gre.h:160
ip4_address_t tunnel_dst
The tunnel&#39;s destination/remote address.
Definition: gre.h:94
u32 sibling_index
The tunnel is a child of the FIB entry for its desintion.
Definition: gre.h:114
L3 GRE (i.e.
Definition: gre.h:64
u32 sw_if_index
Definition: gre.h:100
#define always_inline
Definition: clib.h:84
void gre_tunnel_stack(adj_index_t ai)
gre_tunnel_stack
Definition: interface.c:118
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
enum gre_tunnel_tyoe_t_ gre_tunnel_type_t
The GRE tunnel type.
adj_index_t l2_adj_index
an L2 tunnel always rquires an L2 midchain.
Definition: gre.h:124
unformat_function_t unformat_gre_header
Definition: gre.h:213
#define hash_get(h, key)
Definition: hash.h:248
A representation of a GRE tunnel.
Definition: gre.h:81
unformat_function_t unformat_gre_protocol_net_byte_order
Definition: gre.h:210
u32 node_index
Node which handles this type.
Definition: gre.h:50
vnet_device_class_t gre_device_teb_class
An node in the FIB graph.
Definition: fib_node.h:273
gre_tunnel_type_t type
Definition: gre.h:101
format_function_t format_gre_protocol
Definition: gre.h:199
gre_protocol_t
Definition: packet.h:29
ip4_address_t tunnel_src
The tunnel&#39;s source/local address.
Definition: gre.h:90
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:28
u32 adj_index_t
An index for adjacencies.
Definition: adj_types.h:30
unsigned int u32
Definition: types.h:88
u32 next_index
Next index for this type.
Definition: gre.h:53
void gre_update_adj(vnet_main_t *vnm, u32 sw_if_index, adj_index_t ai)
Definition: gre.c:236
gre_tunnel_t * tunnels
pool of tunnel instances
Definition: gre.h:134
gre_main_t gre_main
Definition: gre.h:182
u8 *( format_function_t)(u8 *s, va_list *args)
Definition: format.h:48
vnet_hw_interface_class_t gre_hw_interface_class
vlib_node_registration_t gre_input_node
(constructor) VLIB_REGISTER_NODE (gre_input_node)
Definition: node.c:419
u64 uword
Definition: types.h:112
u32 l2_tx_arc
on a L2 tunnel this is the VLIB arc from the L2-tx to the l2-midchain
Definition: gre.h:119
fib_node_t node
Linkage into the FIB object graph.
Definition: gre.h:85
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:449
int vnet_gre_add_del_tunnel(vnet_gre_add_del_tunnel_args_t *a, u32 *sw_if_indexp)
Definition: interface.c:439
struct _vnet_hw_interface_class vnet_hw_interface_class_t
unsigned char u8
Definition: types.h:56
Transparent Ethernet Bridging - the tunnel is in L2 mode.
Definition: gre.h:68
void gre_register_input_type(vlib_main_t *vm, gre_protocol_t protocol, u32 node_index)
unformat_function_t unformat_pg_gre_header
Definition: gre.h:214
void gre_register_input_protocol(vlib_main_t *vm, gre_protocol_t protocol, u32 node_index)
Definition: node.c:445
unformat_function_t unformat_gre_protocol_host_byte_order
Definition: gre.h:209
static gre_protocol_info_t * gre_get_protocol_info(gre_main_t *em, gre_protocol_t protocol)
Definition: gre.h:176
gre_protocol_info_t * protocol_infos
GRE payload protocol registrations.
Definition: gre.h:139
vlib_main_t * vlib_main
Definition: gre.h:163
format_function_t format_gre_header
Definition: gre.h:200
u32 flags
Definition: vhost-user.h:75
gre_error_t
Definition: gre.h:32