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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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 *------------------------------------------------------------------
18 #ifndef included_vnet_gtpu_h
19 #define included_vnet_gtpu_h
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>
41 * Octets 8 7 6 5 4 3 2 1
42 * 1 Version PT (*) E S PN
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)
56 typedef CLIB_PACKED (struct {
59 u16 length; /* length in octets of the data following the fixed part of the header */
61 /* The following fields exists if and only if one or more of E, S or PN
68 typedef CLIB_PACKED (struct {
75 * DL PDU SESSION INFORMATION (PDU Type 0):
78 * Octets 8 7 6 5 4 3 2 1
79 * 1 type qmp snp spare
82 * UL PDU SESSION INFORMATION (PDU Type 1):
84 * Octets 8 7 6 5 4 3 2 1
85 * 1 type qmp DL d. UL d. snp
86 * 2 n3/n9 delay new IE qos_fi
88 typedef CLIB_PACKED (struct {
91 // Extensions are supported
92 }) pdu_session_container_t;
94 STATIC_ASSERT_SIZEOF (pdu_session_container_t, 2);
95 typedef CLIB_PACKED (struct {
97 pdu_session_container_t pdu;
99 }) gtpu_ext_with_pdu_session_header_t;
101 #define GTPU_V1_HDR_LEN 8
103 #define GTPU_VER_MASK (7<<5)
104 #define GTPU_PT_BIT (1<<4)
105 #define GTPU_RES_BIT (1 << 3)
106 #define GTPU_E_BIT (1<<2)
107 #define GTPU_S_BIT (1<<1)
108 #define GTPU_PN_BIT (1<<0)
109 #define GTPU_E_S_PN_BIT (7<<0)
111 #define GTPU_V1_VER (1<<5)
113 #define GTPU_PT_GTP (1<<4)
114 #define GTPU_TYPE_GTPU 255
116 #define GTPU_EXT_HDR_PDU_SESSION_CONTAINER 133
117 #define GTPU_NO_MORE_EXT_HDR 0
118 #define GTPU_PDU_DL_SESSION_TYPE 0
119 #define GTPU_PDU_UL_SESSION_TYPE (1 << 4)
121 #define GTPU_FORWARD_BAD_HEADER (1 << 0)
122 #define GTPU_FORWARD_UNKNOWN_TEID (1 << 1)
123 #define GTPU_FORWARD_UNKNOWN_TYPE (1 << 2)
125 /* the ipv4 addresses used for the forwarding tunnels. 127.0.0.127 - .129. */
126 #define GTPU_FORWARD_BAD_HEADER_ADDRESS_IPV4 0x7f00007fu
127 #define GTPU_FORWARD_UNKNOWN_TEID_ADDRESS_IPV4 0x8000007fu
128 #define GTPU_FORWARD_UNKNOWN_TYPE_ADDRESS_IPV4 0x8100007fu
130 /* the ipv6 addresses used for the forwarding tunnels.
131 * 2001:db8:ffff:ffff:ffff:ffff:ffff:fffd -
132 * 2001:db8:ffff:ffff:ffff:ffff:ffff:ffff*/
133 #define GTPU_FORWARD_BAD_HEADER_ADDRESS_IPV6 \
135 .as_u64[0] = 0xffffffffb80d0120ull, .as_u64[1] = 0xfdffffffffffffffull \
137 #define GTPU_FORWARD_UNKNOWN_TEID_ADDRESS_IPV6 \
139 .as_u64[0] = 0xffffffffb80d0120ull, .as_u64[1] = 0xfeffffffffffffffull \
141 #define GTPU_FORWARD_UNKNOWN_TYPE_ADDRESS_IPV6 \
143 .as_u64[0] = 0xffffffffb80d0120ull, .as_u64[1] = 0xffffffffffffffffull \
145 typedef CLIB_PACKED(struct
147 ip4_header_t ip4; /* 20 bytes */
148 udp_header_t udp; /* 8 bytes */
149 gtpu_header_t gtpu; /* 12 bytes */
150 gtpu_ext_with_pdu_session_header_t gtpu_ext; /* 4 bytes */
151 }) ip4_gtpu_header_t;
153 typedef CLIB_PACKED(struct
155 ip6_header_t ip6; /* 40 bytes */
156 udp_header_t udp; /* 8 bytes */
157 gtpu_header_t gtpu; /* 12 bytes */
158 gtpu_ext_with_pdu_session_header_t gtpu_ext; /* 4 bytes */
159 }) ip6_gtpu_header_t;
164 * Key fields: ip src and gtpu teid on incoming gtpu packet
165 * all fields in NET byte order
174 }) gtpu4_tunnel_key_t;
179 * Key fields: ip src and gtpu teid on incoming gtpu packet
180 * all fields in NET byte order
184 }) gtpu6_tunnel_key_t;
188 /* Required for pool_get_aligned */
189 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
194 /* FIB DPO for IP forwarding of gtpu encap packet */
197 /* gtpu local(rx) and remote(tx) TEIDs in HOST byte order */
201 /* tunnel src and dst addresses */
205 /* mcast packet output intf index (used only if dst is mcast) */
206 u32 mcast_sw_if_index;
208 /* decap next index */
209 u32 decap_next_index;
211 /* The FIB index for src/dst addresses */
214 /* vnet intfc index */
218 /* PDU session container extension enable/disable */
222 /* The tunnel is used for forwarding */
227 * Linkage into the FIB object graph
232 * The FIB entry for (depending on gtpu tunnel is unicast or mcast)
233 * sending unicast gtpu encap packets or receiving mcast gtpu packets
235 fib_node_index_t fib_entry_index;
236 adj_index_t mcast_adj_index;
239 * The tunnel is a child of the FIB entry for its destination. This is
240 * so it receives updates when the forwarding information for that entry
242 * The tunnels sibling index on the FIB entry's dependency list.
246 u32 flow_index; /* infra flow index */
249 #define foreach_gtpu_input_next \
250 _(DROP, "error-drop") \
251 _(L2_INPUT, "l2-input") \
252 _(IP4_INPUT, "ip4-input") \
253 _(IP6_INPUT, "ip6-input" )
257 #define _(s,n) GTPU_INPUT_NEXT_##s,
258 foreach_gtpu_input_next
265 #define gtpu_error(n,s) GTPU_ERROR_##n,
266 #include <gtpu/gtpu_error.def>
269 } gtpu_input_error_t;
273 /* vector of encap tunnel instances */
274 gtpu_tunnel_t *tunnels;
276 /* lookup tunnel by key */
277 uword *gtpu4_tunnel_by_key; /* keyed on ipv4.dst + teid */
278 uword *gtpu6_tunnel_by_key; /* keyed on ipv6.dst + teid */
280 /* local VTEP IPs ref count used by gtpu-bypass node to check if
281 received gtpu packet DIP matches any local VTEP address */
282 vtep_table_t vtep_table;
284 /* mcast shared info */
285 uword *mcast_shared; /* keyed on mcast ip46 addr */
287 /* Free vlib hw_if_indices */
288 u32 *free_gtpu_tunnel_hw_if_indices;
290 /* Mapping from sw_if_index to tunnel index */
291 u32 *tunnel_index_by_sw_if_index;
294 * Node type for registering to fib changes.
296 fib_node_type_t fib_node_type;
298 /* API message ID base */
301 /* Handle GTP packets of unknown type like echo and error indication,
302 * unknown teid or bad version/header.
303 * All packets will be forwarded to a new IP address,
304 * so that they can be processes outside vpp.
305 * If not set then packets are dropped.
306 * One of more indexes can be unused (~0). */
307 u32 bad_header_forward_tunnel_index_ipv4;
308 u32 unknown_teid_forward_tunnel_index_ipv4;
309 u32 unknown_type_forward_tunnel_index_ipv4;
310 u32 bad_header_forward_tunnel_index_ipv6;
311 u32 unknown_teid_forward_tunnel_index_ipv6;
312 u32 unknown_type_forward_tunnel_index_ipv6;
315 vlib_main_t *vlib_main;
316 vnet_main_t *vnet_main;
318 /* cache for last 8 gtpu tunnel */
319 vtep4_cache_t vtep4_u512;
323 extern gtpu_main_t gtpu_main;
325 extern vlib_node_registration_t gtpu4_input_node;
326 extern vlib_node_registration_t gtpu6_input_node;
327 extern vlib_node_registration_t gtpu4_encap_node;
328 extern vlib_node_registration_t gtpu6_encap_node;
329 extern vlib_node_registration_t gtpu4_flow_input_node;
331 u8 *format_gtpu_encap_trace (u8 * s, va_list * args);
336 #define GTPU_DEL_TUNNEL 0
337 #define GTPU_ADD_TUNNEL 1
338 #define GTPU_UPD_TTEID 2
339 ip46_address_t src, dst;
340 u32 mcast_sw_if_index;
342 u32 decap_next_index;
343 u32 teid; /* local or rx teid */
344 u32 tteid; /* remote or tx teid */
349 } vnet_gtpu_add_mod_del_tunnel_args_t;
351 int vnet_gtpu_add_del_forwarding (vnet_gtpu_add_mod_del_tunnel_args_t *a,
354 int vnet_gtpu_add_mod_del_tunnel
355 (vnet_gtpu_add_mod_del_tunnel_args_t * a, u32 * sw_if_indexp);
363 } gtpu_encap_trace_t;
365 void vnet_int_gtpu_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable);
366 u32 vnet_gtpu_get_tunnel_index (u32 sw_if_index);
367 int vnet_gtpu_add_del_rx_flow (u32 hw_if_index, u32 t_imdex, int is_add);
368 int get_combined_counters (u32 sw_if_index, vlib_counter_t *result_rx,
369 vlib_counter_t *result_tx);
371 #endif /* included_vnet_gtpu_h */
375 * fd.io coding-style-patch-verification: ON
378 * eval: (c-set-style "gnu")