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/l2/l2_input.h>
27 #include <vnet/l2/l2_output.h>
28 #include <vnet/l2/l2_bd.h>
29 #include <vnet/ethernet/ethernet.h>
30 #include <vnet/ip/ip4_packet.h>
31 #include <vnet/ip/ip6_packet.h>
32 #include <vnet/udp/udp.h>
33 #include <vnet/dpo/dpo.h>
34 #include <vnet/adj/adj_types.h>
35 #include <vnet/fib/fib_table.h>
39 * Octets 8 7 6 5 4 3 2 1
40 * 1 Version PT (*) E S PN
42 * 3 Length (1st Octet)
43 * 4 Length (2nd Octet)
44 * 5 Tunnel Endpoint Identifier (1st Octet)
45 * 6 Tunnel Endpoint Identifier (2nd Octet)
46 * 7 Tunnel Endpoint Identifier (3rd Octet)
47 * 8 Tunnel Endpoint Identifier (4th Octet)
48 * 9 Sequence Number (1st Octet)1) 4)
49 * 10 Sequence Number (2nd Octet)1) 4)
50 * 11 N-PDU Number2) 4)
51 * 12 Next Extension Header Type3) 4)
58 u16 length; /* length in octets of the data following the fixed part of the header */
65 #define GTPU_V1_HDR_LEN 8
67 #define GTPU_VER_MASK (7<<5)
68 #define GTPU_PT_BIT (1<<4)
69 #define GTPU_E_BIT (1<<2)
70 #define GTPU_S_BIT (1<<1)
71 #define GTPU_PN_BIT (1<<0)
72 #define GTPU_E_S_PN_BIT (7<<0)
74 #define GTPU_V1_VER (1<<5)
76 #define GTPU_PT_GTP (1<<4)
77 #define GTPU_TYPE_GTPU 255
80 typedef CLIB_PACKED(struct
82 ip4_header_t ip4; /* 20 bytes */
83 udp_header_t udp; /* 8 bytes */
84 gtpu_header_t gtpu; /* 8 bytes */
89 typedef CLIB_PACKED(struct
91 ip6_header_t ip6; /* 40 bytes */
92 udp_header_t udp; /* 8 bytes */
93 gtpu_header_t gtpu; /* 8 bytes */
101 * Key fields: ip src and gtpu teid on incoming gtpu packet
102 * all fields in NET byte order
111 }) gtpu4_tunnel_key_t;
118 * Key fields: ip src and gtpu teid on incoming gtpu packet
119 * all fields in NET byte order
123 }) gtpu6_tunnel_key_t;
128 /* Required for pool_get_aligned */
129 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
134 /* FIB DPO for IP forwarding of gtpu encap packet */
137 /* gtpu teid in HOST byte order */
140 /* tunnel src and dst addresses */
144 /* mcast packet output intf index (used only if dst is mcast) */
145 u32 mcast_sw_if_index;
147 /* decap next index */
148 u32 decap_next_index;
150 /* The FIB index for src/dst addresses */
153 /* vnet intfc index */
158 * Linkage into the FIB object graph
163 * The FIB entry for (depending on gtpu tunnel is unicast or mcast)
164 * sending unicast gtpu encap packets or receiving mcast gtpu packets
166 fib_node_index_t fib_entry_index;
167 adj_index_t mcast_adj_index;
170 * The tunnel is a child of the FIB entry for its destination. This is
171 * so it receives updates when the forwarding information for that entry
173 * The tunnels sibling index on the FIB entry's dependency list.
178 #define foreach_gtpu_input_next \
179 _(DROP, "error-drop") \
180 _(L2_INPUT, "l2-input") \
181 _(IP4_INPUT, "ip4-input") \
182 _(IP6_INPUT, "ip6-input" )
186 #define _(s,n) GTPU_INPUT_NEXT_##s,
187 foreach_gtpu_input_next
194 #define gtpu_error(n,s) GTPU_ERROR_##n,
195 #include <gtpu/gtpu_error.def>
198 } gtpu_input_error_t;
202 /* vector of encap tunnel instances */
203 gtpu_tunnel_t *tunnels;
205 /* lookup tunnel by key */
206 uword *gtpu4_tunnel_by_key; /* keyed on ipv4.dst + teid */
207 uword *gtpu6_tunnel_by_key; /* keyed on ipv6.dst + teid */
209 /* local VTEP IPs ref count used by gtpu-bypass node to check if
210 received gtpu packet DIP matches any local VTEP address */
211 uword *vtep4; /* local ip4 VTEPs keyed on their ip4 addr */
212 uword *vtep6; /* local ip6 VTEPs keyed on their ip6 addr */
214 /* mcast shared info */
215 uword *mcast_shared; /* keyed on mcast ip46 addr */
217 /* Free vlib hw_if_indices */
218 u32 *free_gtpu_tunnel_hw_if_indices;
220 /* Mapping from sw_if_index to tunnel index */
221 u32 *tunnel_index_by_sw_if_index;
224 * Node type for registering to fib changes.
226 fib_node_type_t fib_node_type;
228 /* API message ID base */
232 vlib_main_t *vlib_main;
233 vnet_main_t *vnet_main;
236 extern gtpu_main_t gtpu_main;
238 extern vlib_node_registration_t gtpu4_input_node;
239 extern vlib_node_registration_t gtpu6_input_node;
240 extern vlib_node_registration_t gtpu4_encap_node;
241 extern vlib_node_registration_t gtpu6_encap_node;
243 u8 *format_gtpu_encap_trace (u8 * s, va_list * args);
249 ip46_address_t src, dst;
250 u32 mcast_sw_if_index;
252 u32 decap_next_index;
254 } vnet_gtpu_add_del_tunnel_args_t;
256 int vnet_gtpu_add_del_tunnel
257 (vnet_gtpu_add_del_tunnel_args_t * a, u32 * sw_if_indexp);
259 void vnet_int_gtpu_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable);
260 #endif /* included_vnet_gtpu_h */
264 * fd.io coding-style-patch-verification: ON
267 * eval: (c-set-style "gnu")