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)
60 u16 length; /* length in octets of the data following the fixed part of the header */
67 #define GTPU_V1_HDR_LEN 8
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)
76 #define GTPU_V1_VER (1<<5)
78 #define GTPU_PT_GTP (1<<4)
79 #define GTPU_TYPE_GTPU 255
82 typedef CLIB_PACKED(struct
84 ip4_header_t ip4; /* 20 bytes */
85 udp_header_t udp; /* 8 bytes */
86 gtpu_header_t gtpu; /* 12 bytes */
91 typedef CLIB_PACKED(struct
93 ip6_header_t ip6; /* 40 bytes */
94 udp_header_t udp; /* 8 bytes */
95 gtpu_header_t gtpu; /* 8 bytes */
103 * Key fields: ip src and gtpu teid on incoming gtpu packet
104 * all fields in NET byte order
113 }) gtpu4_tunnel_key_t;
120 * Key fields: ip src and gtpu teid on incoming gtpu packet
121 * all fields in NET byte order
125 }) gtpu6_tunnel_key_t;
130 /* Required for pool_get_aligned */
131 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
136 /* FIB DPO for IP forwarding of gtpu encap packet */
139 /* gtpu local(rx) and remote(tx) TEIDs in HOST byte order */
143 /* tunnel src and dst addresses */
147 /* mcast packet output intf index (used only if dst is mcast) */
148 u32 mcast_sw_if_index;
150 /* decap next index */
151 u32 decap_next_index;
153 /* The FIB index for src/dst addresses */
156 /* vnet intfc index */
161 * Linkage into the FIB object graph
166 * The FIB entry for (depending on gtpu tunnel is unicast or mcast)
167 * sending unicast gtpu encap packets or receiving mcast gtpu packets
169 fib_node_index_t fib_entry_index;
170 adj_index_t mcast_adj_index;
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
176 * The tunnels sibling index on the FIB entry's dependency list.
180 u32 flow_index; /* infra flow index */
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" )
191 #define _(s,n) GTPU_INPUT_NEXT_##s,
192 foreach_gtpu_input_next
199 #define gtpu_error(n,s) GTPU_ERROR_##n,
200 #include <gtpu/gtpu_error.def>
203 } gtpu_input_error_t;
207 /* vector of encap tunnel instances */
208 gtpu_tunnel_t *tunnels;
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 */
214 /* local VTEP IPs ref count used by gtpu-bypass node to check if
215 received gtpu packet DIP matches any local VTEP address */
216 vtep_table_t vtep_table;
218 /* mcast shared info */
219 uword *mcast_shared; /* keyed on mcast ip46 addr */
221 /* Free vlib hw_if_indices */
222 u32 *free_gtpu_tunnel_hw_if_indices;
224 /* Mapping from sw_if_index to tunnel index */
225 u32 *tunnel_index_by_sw_if_index;
228 * Node type for registering to fib changes.
230 fib_node_type_t fib_node_type;
232 /* API message ID base */
236 vlib_main_t *vlib_main;
237 vnet_main_t *vnet_main;
239 /* cache for last 8 gtpu tunnel */
240 #ifdef CLIB_HAVE_VEC512
241 vtep4_cache_t vtep4_u512;
246 extern gtpu_main_t gtpu_main;
248 extern vlib_node_registration_t gtpu4_input_node;
249 extern vlib_node_registration_t gtpu6_input_node;
250 extern vlib_node_registration_t gtpu4_encap_node;
251 extern vlib_node_registration_t gtpu6_encap_node;
252 extern vlib_node_registration_t gtpu4_flow_input_node;
254 u8 *format_gtpu_encap_trace (u8 * s, va_list * args);
259 #define GTPU_DEL_TUNNEL 0
260 #define GTPU_ADD_TUNNEL 1
261 #define GTPU_UPD_TTEID 2
262 ip46_address_t src, dst;
263 u32 mcast_sw_if_index;
265 u32 decap_next_index;
266 u32 teid; /* local or rx teid */
267 u32 tteid; /* remote or tx teid */
268 } vnet_gtpu_add_mod_del_tunnel_args_t;
270 int vnet_gtpu_add_mod_del_tunnel
271 (vnet_gtpu_add_mod_del_tunnel_args_t * a, u32 * sw_if_indexp);
277 } gtpu_encap_trace_t;
279 void vnet_int_gtpu_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable);
280 u32 vnet_gtpu_get_tunnel_index (u32 sw_if_index);
281 int vnet_gtpu_add_del_rx_flow (u32 hw_if_index, u32 t_imdex, int is_add);
283 #endif /* included_vnet_gtpu_h */
287 * fd.io coding-style-patch-verification: ON
290 * eval: (c-set-style "gnu")