FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
gtpu.h
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * Copyright (c) 2017 Intel and/or its affiliates.
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *------------------------------------------------------------------
16  */
17 
18 #ifndef included_vnet_gtpu_h
19 #define included_vnet_gtpu_h
20 
21 #include <vppinfra/lock.h>
22 #include <vppinfra/error.h>
23 #include <vppinfra/hash.h>
24 #include <vnet/vnet.h>
25 #include <vnet/ip/ip.h>
26 #include <vnet/ip/vtep.h>
27 #include <vnet/l2/l2_input.h>
28 #include <vnet/l2/l2_output.h>
29 #include <vnet/l2/l2_bd.h>
30 #include <vnet/ethernet/ethernet.h>
31 #include <vnet/ip/ip4_packet.h>
32 #include <vnet/ip/ip6_packet.h>
33 #include <vnet/udp/udp_packet.h>
34 #include <vnet/udp/udp_local.h>
35 #include <vnet/dpo/dpo.h>
36 #include <vnet/adj/adj_types.h>
37 #include <vnet/fib/fib_table.h>
38 
39 /**
40  * Bits
41  * Octets 8 7 6 5 4 3 2 1
42  * 1 Version PT (*) E S PN
43  * 2 Message Type
44  * 3 Length (1st Octet)
45  * 4 Length (2nd Octet)
46  * 5 Tunnel Endpoint Identifier (1st Octet)
47  * 6 Tunnel Endpoint Identifier (2nd Octet)
48  * 7 Tunnel Endpoint Identifier (3rd Octet)
49  * 8 Tunnel Endpoint Identifier (4th Octet)
50  * 9 Sequence Number (1st Octet)1) 4)
51  * 10 Sequence Number (2nd Octet)1) 4)
52  * 11 N-PDU Number2) 4)
53  * 12 Next Extension Header Type3) 4)
54 **/
55 
56 typedef struct
57 {
58  u8 ver_flags;
59  u8 type;
60  u16 length; /* length in octets of the data following the fixed part of the header */
61  u32 teid;
66 
67 #define GTPU_V1_HDR_LEN 8
68 
69 #define GTPU_VER_MASK (7<<5)
70 #define GTPU_PT_BIT (1<<4)
71 #define GTPU_E_BIT (1<<2)
72 #define GTPU_S_BIT (1<<1)
73 #define GTPU_PN_BIT (1<<0)
74 #define GTPU_E_S_PN_BIT (7<<0)
75 
76 #define GTPU_V1_VER (1<<5)
77 
78 #define GTPU_PT_GTP (1<<4)
79 #define GTPU_TYPE_GTPU 255
80 
81 /* *INDENT-OFF* */
82 typedef CLIB_PACKED(struct
83 {
84  ip4_header_t ip4; /* 20 bytes */
85  udp_header_t udp; /* 8 bytes */
86  gtpu_header_t gtpu; /* 12 bytes */
88 /* *INDENT-ON* */
89 
90 /* *INDENT-OFF* */
91 typedef CLIB_PACKED(struct
92 {
93  ip6_header_t ip6; /* 40 bytes */
94  udp_header_t udp; /* 8 bytes */
95  gtpu_header_t gtpu; /* 8 bytes */
97 /* *INDENT-ON* */
98 
99 /* *INDENT-OFF* */
100 typedef CLIB_PACKED
101 (struct {
102  /*
103  * Key fields: ip src and gtpu teid on incoming gtpu packet
104  * all fields in NET byte order
105  */
106  union {
107  struct {
108  u32 src;
109  u32 teid;
110  };
111  u64 as_u64;
112  };
113 }) gtpu4_tunnel_key_t;
114 /* *INDENT-ON* */
115 
116 /* *INDENT-OFF* */
117 typedef CLIB_PACKED
118 (struct {
119  /*
120  * Key fields: ip src and gtpu teid on incoming gtpu packet
121  * all fields in NET byte order
122  */
123  ip6_address_t src;
124  u32 teid;
125 }) gtpu6_tunnel_key_t;
126 /* *INDENT-ON* */
127 
128 typedef struct
129 {
130  /* Required for pool_get_aligned */
131  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
132 
133  /* Rewrite string */
135 
136  /* FIB DPO for IP forwarding of gtpu encap packet */
138 
139  /* gtpu local(rx) and remote(tx) TEIDs in HOST byte order */
142 
143  /* tunnel src and dst addresses */
144  ip46_address_t src;
145  ip46_address_t dst;
146 
147  /* mcast packet output intf index (used only if dst is mcast) */
149 
150  /* decap next index */
152 
153  /* The FIB index for src/dst addresses */
155 
156  /* vnet intfc index */
159 
160  /**
161  * Linkage into the FIB object graph
162  */
164 
165  /*
166  * The FIB entry for (depending on gtpu tunnel is unicast or mcast)
167  * sending unicast gtpu encap packets or receiving mcast gtpu packets
168  */
171 
172  /**
173  * The tunnel is a child of the FIB entry for its destination. This is
174  * so it receives updates when the forwarding information for that entry
175  * changes.
176  * The tunnels sibling index on the FIB entry's dependency list.
177  */
179 
180  u32 flow_index; /* infra flow index */
181 } gtpu_tunnel_t;
182 
183 #define foreach_gtpu_input_next \
184 _(DROP, "error-drop") \
185 _(L2_INPUT, "l2-input") \
186 _(IP4_INPUT, "ip4-input") \
187 _(IP6_INPUT, "ip6-input" )
188 
189 typedef enum
190 {
191 #define _(s,n) GTPU_INPUT_NEXT_##s,
193 #undef _
196 
197 typedef enum
198 {
199 #define gtpu_error(n,s) GTPU_ERROR_##n,
200 #include <gtpu/gtpu_error.def>
201 #undef gtpu_error
204 
205 typedef struct
206 {
207  /* vector of encap tunnel instances */
209 
210  /* lookup tunnel by key */
211  uword *gtpu4_tunnel_by_key; /* keyed on ipv4.dst + teid */
212  uword *gtpu6_tunnel_by_key; /* keyed on ipv6.dst + teid */
213 
214  /* local VTEP IPs ref count used by gtpu-bypass node to check if
215  received gtpu packet DIP matches any local VTEP address */
217 
218  /* mcast shared info */
219  uword *mcast_shared; /* keyed on mcast ip46 addr */
220 
221  /* Free vlib hw_if_indices */
223 
224  /* Mapping from sw_if_index to tunnel index */
226 
227  /**
228  * Node type for registering to fib changes.
229  */
231 
232  /* API message ID base */
234 
235  /* convenience */
239  /* cache for last 8 gtpu tunnel */
240 #ifdef CLIB_HAVE_VEC512
241  vtep4_cache_t vtep4_u512;
242 #endif
243 
244 } gtpu_main_t;
245 
246 extern gtpu_main_t gtpu_main;
247 
253 
254 u8 *format_gtpu_encap_trace (u8 * s, va_list * args);
255 
256 typedef struct
257 {
259 #define GTPU_DEL_TUNNEL 0
260 #define GTPU_ADD_TUNNEL 1
261 #define GTPU_UPD_TTEID 2
262  ip46_address_t src, dst;
266  u32 teid; /* local or rx teid */
267  u32 tteid; /* remote or tx teid */
269 
271  (vnet_gtpu_add_mod_del_tunnel_args_t * a, u32 * sw_if_indexp);
272 
273 typedef struct
274 {
278 
281 int vnet_gtpu_add_del_rx_flow (u32 hw_if_index, u32 t_imdex, int is_add);
282 
283 #endif /* included_vnet_gtpu_h */
284 
285 
286 /*
287  * fd.io coding-style-patch-verification: ON
288  *
289  * Local Variables:
290  * eval: (c-set-style "gnu")
291  * End:
292  */
adj_types.h
gtpu_header_t::sequence
u16 sequence
Definition: gtpu.h:62
gtpu_encap_trace_t::tteid
u32 tteid
Definition: gtpu.h:276
gtpu_main_t::msg_id_base
u16 msg_id_base
Definition: gtpu.h:233
gtpu_main
gtpu_main_t gtpu_main
Definition: gtpu.c:36
ip4_gtpu_header_t
Definition: mobile.h:145
gtpu4_input_node
vlib_node_registration_t gtpu4_input_node
(constructor) VLIB_REGISTER_NODE (gtpu4_input_node)
Definition: gtpu_decap.c:747
ip4
vl_api_ip4_address_t ip4
Definition: one.api:376
gtpu_main_t
Definition: gtpu.h:205
gtpu_main_t::fib_node_type
fib_node_type_t fib_node_type
Node type for registering to fib changes.
Definition: gtpu.h:230
gtpu6_input_node
vlib_node_registration_t gtpu6_input_node
(constructor) VLIB_REGISTER_NODE (gtpu6_input_node)
Definition: gtpu_decap.c:767
CLIB_CACHE_LINE_ALIGN_MARK
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
gtpu_main_t::vnet_main
vnet_main_t * vnet_main
Definition: gtpu.h:237
gtpu_tunnel_t::rewrite
u8 * rewrite
Definition: gtpu.h:134
foreach_gtpu_input_next
#define foreach_gtpu_input_next
Definition: gtpu.h:183
vnet_gtpu_add_mod_del_tunnel_args_t::teid
u32 teid
Definition: gtpu.h:266
gtpu_main_t::vtep_table
vtep_table_t vtep_table
Definition: gtpu.h:216
fib_table.h
vnet_gtpu_add_mod_del_tunnel_args_t::src
ip46_address_t src
Definition: gtpu.h:262
gtpu_header_t::pdu_number
u8 pdu_number
Definition: gtpu.h:63
u16
unsigned short u16
Definition: types.h:57
gtpu_tunnel_t::mcast_adj_index
adj_index_t mcast_adj_index
Definition: gtpu.h:170
vnet_gtpu_add_mod_del_tunnel_args_t::opn
u8 opn
Definition: gtpu.h:258
fib_node_type_t
enum fib_node_type_t_ fib_node_type_t
The types of nodes in a FIB graph.
udp_header_t
Definition: udp_packet.h:45
ip4_header_t
Definition: ip4_packet.h:87
ethernet.h
gtpu_encap_trace_t::tunnel_index
u32 tunnel_index
Definition: gtpu.h:275
gtpu_tunnel_t::fib_entry_index
fib_node_index_t fib_entry_index
Definition: gtpu.h:169
ip6_packet.h
gtpu_header_t::next_ext_type
u8 next_ext_type
Definition: gtpu.h:64
gtpu_tunnel_t::src
ip46_address_t src
Definition: gtpu.h:144
vnet_gtpu_add_mod_del_tunnel_args_t::mcast_sw_if_index
u32 mcast_sw_if_index
Definition: gtpu.h:263
gtpu_main_t::flow_id_start
u32 flow_id_start
Definition: gtpu.h:238
gtpu_input_next_t
gtpu_input_next_t
Definition: gtpu.h:189
gtpu_tunnel_t::sw_if_index
u32 sw_if_index
Definition: gtpu.h:157
gtpu_main_t::free_gtpu_tunnel_hw_if_indices
u32 * free_gtpu_tunnel_hw_if_indices
Definition: gtpu.h:222
error.h
dpo.h
vnet_gtpu_add_mod_del_tunnel_args_t::encap_fib_index
u32 encap_fib_index
Definition: gtpu.h:264
gtpu_encap_trace_t
Definition: gtpu.h:273
l2_output.h
lock.h
gtpu_tunnel_t::decap_next_index
u32 decap_next_index
Definition: gtpu.h:151
gtpu_tunnel_t::flow_index
u32 flow_index
Definition: gtpu.h:180
udp_local.h
fib_node_index_t
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:29
udp_packet.h
gtpu_header_t
Definition: mobile.h:90
uword
u64 uword
Definition: types.h:112
GTPU_INPUT_N_NEXT
@ GTPU_INPUT_N_NEXT
Definition: gtpu.h:194
src
vl_api_address_t src
Definition: gre.api:54
gtpu_tunnel_t::dst
ip46_address_t dst
Definition: gtpu.h:145
gtpu_tunnel_t::next_dpo
dpo_id_t next_dpo
Definition: gtpu.h:137
vlib_node_registration_t
struct _vlib_node_registration vlib_node_registration_t
l2_input.h
ip4_packet.h
gtpu_tunnel_t::sibling_index
u32 sibling_index
The tunnel is a child of the FIB entry for its destination.
Definition: gtpu.h:178
is_ip6
bool is_ip6
Definition: ip.api:43
gtpu_input_error_t
gtpu_input_error_t
Definition: gtpu.h:197
vnet_main_t
Definition: vnet.h:76
u64
unsigned long u64
Definition: types.h:89
gtpu_main_t::gtpu4_tunnel_by_key
uword * gtpu4_tunnel_by_key
Definition: gtpu.h:211
ip.h
u32
unsigned int u32
Definition: types.h:88
gtpu_tunnel_t::encap_fib_index
u32 encap_fib_index
Definition: gtpu.h:154
ip6
vl_api_ip6_address_t ip6
Definition: one.api:424
gtpu_main_t::mcast_shared
uword * mcast_shared
Definition: gtpu.h:219
dst
vl_api_ip4_address_t dst
Definition: pnat.api:41
gtpu_tunnel_t::tteid
u32 tteid
Definition: gtpu.h:141
as_u64
u64 as_u64
Definition: bihash_doc.h:63
gtpu_tunnel_t
Definition: gtpu.h:128
gtpu4_encap_node
vlib_node_registration_t gtpu4_encap_node
(constructor) VLIB_REGISTER_NODE (gtpu4_encap_node)
Definition: gtpu_encap.c:687
ip6_header_t
Definition: ip6_packet.h:294
vnet_gtpu_add_mod_del_tunnel_args_t::tteid
u32 tteid
Definition: gtpu.h:267
fib_node_t_
An node in the FIB graph.
Definition: fib_node.h:301
vnet_gtpu_add_mod_del_tunnel_args_t
Definition: gtpu.h:256
CLIB_PACKED
typedef CLIB_PACKED(struct { ip4_header_t ip4;udp_header_t udp;gtpu_header_t gtpu;}) ip4_gtpu_header_t
length
char const int length
Definition: cJSON.h:163
adj_index_t
u32 adj_index_t
An index for adjacencies.
Definition: adj_types.h:30
vlib_main_t
Definition: main.h:102
ip6_gtpu_header_t
Definition: mobile.h:154
hash.h
u8
unsigned char u8
Definition: types.h:56
a
a
Definition: bitmap.h:544
vtep_table_t
Definition: vtep.h:62
gtpu_main_t::tunnel_index_by_sw_if_index
u32 * tunnel_index_by_sw_if_index
Definition: gtpu.h:225
format_gtpu_encap_trace
u8 * format_gtpu_encap_trace(u8 *s, va_list *args)
Definition: gtpu.c:52
gtpu_tunnel_t::teid
u32 teid
Definition: gtpu.h:140
vnet_gtpu_add_mod_del_tunnel
int vnet_gtpu_add_mod_del_tunnel(vnet_gtpu_add_mod_del_tunnel_args_t *a, u32 *sw_if_indexp)
Definition: gtpu.c:353
gtpu_error.def
gtpu_tunnel_t::mcast_sw_if_index
u32 mcast_sw_if_index
Definition: gtpu.h:148
dpo_id_t_
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:172
vnet_gtpu_add_del_rx_flow
int vnet_gtpu_add_del_rx_flow(u32 hw_if_index, u32 t_imdex, int is_add)
Definition: gtpu.c:1112
gtpu_main_t::tunnels
gtpu_tunnel_t * tunnels
Definition: gtpu.h:208
vtep.h
vnet_gtpu_add_mod_del_tunnel_args_t::decap_next_index
u32 decap_next_index
Definition: gtpu.h:265
vnet.h
gtpu6_encap_node
vlib_node_registration_t gtpu6_encap_node
(constructor) VLIB_REGISTER_NODE (gtpu6_encap_node)
Definition: gtpu_encap.c:702
teid
u32 teid
Definition: flow_types.api:182
vnet_gtpu_get_tunnel_index
u32 vnet_gtpu_get_tunnel_index(u32 sw_if_index)
Definition: gtpu.c:1151
sw_if_index
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:34
gtpu4_flow_input_node
vlib_node_registration_t gtpu4_flow_input_node
(constructor) VLIB_REGISTER_NODE (gtpu4_flow_input_node)
Definition: gtpu_decap.c:1738
l2_bd.h
GTPU_N_ERROR
@ GTPU_N_ERROR
Definition: gtpu.h:202
gtpu_tunnel_t::node
fib_node_t node
Linkage into the FIB object graph.
Definition: gtpu.h:163
type
vl_api_fib_path_type_t type
Definition: fib_types.api:123
gtpu_main_t::vlib_main
vlib_main_t * vlib_main
Definition: gtpu.h:236
gtpu_tunnel_t::hw_if_index
u32 hw_if_index
Definition: gtpu.h:158
vnet_int_gtpu_bypass_mode
void vnet_int_gtpu_bypass_mode(u32 sw_if_index, u8 is_ip6, u8 is_enable)
Definition: gtpu.c:943
gtpu_main_t::gtpu6_tunnel_by_key
uword * gtpu6_tunnel_by_key
Definition: gtpu.h:212