FD.io VPP  v20.01-46-g7006026de
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/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>
36 
37 /**
38  * Bits
39  * Octets 8 7 6 5 4 3 2 1
40  * 1 Version PT (*) E S PN
41  * 2 Message Type
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)
52 **/
53 
54 typedef struct
55 {
56  u8 ver_flags;
57  u8 type;
58  u16 length; /* length in octets of the data following the fixed part of the header */
59  u32 teid;
64 
65 #define GTPU_V1_HDR_LEN 8
66 
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)
73 
74 #define GTPU_V1_VER (1<<5)
75 
76 #define GTPU_PT_GTP (1<<4)
77 #define GTPU_TYPE_GTPU 255
78 
79 /* *INDENT-OFF* */
80 typedef CLIB_PACKED(struct
81 {
82  ip4_header_t ip4; /* 20 bytes */
83  udp_header_t udp; /* 8 bytes */
84  gtpu_header_t gtpu; /* 8 bytes */
86 /* *INDENT-ON* */
87 
88 /* *INDENT-OFF* */
89 typedef CLIB_PACKED(struct
90 {
91  ip6_header_t ip6; /* 40 bytes */
92  udp_header_t udp; /* 8 bytes */
93  gtpu_header_t gtpu; /* 8 bytes */
95 /* *INDENT-ON* */
96 
97 /* *INDENT-OFF* */
98 typedef CLIB_PACKED
99 (struct {
100  /*
101  * Key fields: ip src and gtpu teid on incoming gtpu packet
102  * all fields in NET byte order
103  */
104  union {
105  struct {
106  u32 src;
107  u32 teid;
108  };
109  u64 as_u64;
110  };
111 }) gtpu4_tunnel_key_t;
112 /* *INDENT-ON* */
113 
114 /* *INDENT-OFF* */
115 typedef CLIB_PACKED
116 (struct {
117  /*
118  * Key fields: ip src and gtpu teid on incoming gtpu packet
119  * all fields in NET byte order
120  */
122  u32 teid;
123 }) gtpu6_tunnel_key_t;
124 /* *INDENT-ON* */
125 
126 typedef struct
127 {
128  /* Required for pool_get_aligned */
129  CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
130 
131  /* Rewrite string */
133 
134  /* FIB DPO for IP forwarding of gtpu encap packet */
136 
137  /* gtpu teid in HOST byte order */
139 
140  /* tunnel src and dst addresses */
141  ip46_address_t src;
142  ip46_address_t dst;
143 
144  /* mcast packet output intf index (used only if dst is mcast) */
146 
147  /* decap next index */
149 
150  /* The FIB index for src/dst addresses */
152 
153  /* vnet intfc index */
156 
157  /**
158  * Linkage into the FIB object graph
159  */
161 
162  /*
163  * The FIB entry for (depending on gtpu tunnel is unicast or mcast)
164  * sending unicast gtpu encap packets or receiving mcast gtpu packets
165  */
168 
169  /**
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
172  * changes.
173  * The tunnels sibling index on the FIB entry's dependency list.
174  */
176 } gtpu_tunnel_t;
177 
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" )
183 
184 typedef enum
185 {
186 #define _(s,n) GTPU_INPUT_NEXT_##s,
188 #undef _
191 
192 typedef enum
193 {
194 #define gtpu_error(n,s) GTPU_ERROR_##n,
195 #include <gtpu/gtpu_error.def>
196 #undef gtpu_error
199 
200 typedef struct
201 {
202  /* vector of encap tunnel instances */
204 
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 */
208 
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 */
213 
214  /* mcast shared info */
215  uword *mcast_shared; /* keyed on mcast ip46 addr */
216 
217  /* Free vlib hw_if_indices */
219 
220  /* Mapping from sw_if_index to tunnel index */
222 
223  /**
224  * Node type for registering to fib changes.
225  */
227 
228  /* API message ID base */
230 
231  /* convenience */
234 } gtpu_main_t;
235 
236 extern gtpu_main_t gtpu_main;
237 
242 
243 u8 *format_gtpu_encap_trace (u8 * s, va_list * args);
244 
245 typedef struct
246 {
248  ip46_address_t src, dst;
254 
256  (vnet_gtpu_add_del_tunnel_args_t * a, u32 * sw_if_indexp);
257 
258 typedef struct
259 {
263 
265 #endif /* included_vnet_gtpu_h */
266 
267 
268 /*
269  * fd.io coding-style-patch-verification: ON
270  *
271  * Local Variables:
272  * eval: (c-set-style "gnu")
273  * End:
274  */
vlib_main_t * vlib_main
Definition: gtpu.h:232
vlib_node_registration_t gtpu4_encap_node
(constructor) VLIB_REGISTER_NODE (gtpu4_encap_node)
Definition: gtpu_encap.c:687
#define CLIB_CACHE_LINE_ALIGN_MARK(mark)
Definition: cache.h:60
vnet_main_t * vnet_main
Definition: gtpu.h:233
a
Definition: bitmap.h:538
u32 teid
Definition: gtpu.h:138
u64 as_u64
Definition: bihash_doc.h:63
unsigned long u64
Definition: types.h:89
u32 * tunnel_index_by_sw_if_index
Definition: gtpu.h:221
fib_node_type_t fib_node_type
Node type for registering to fib changes.
Definition: gtpu.h:226
void vnet_int_gtpu_bypass_mode(u32 sw_if_index, u8 is_ip6, u8 is_enable)
Definition: gtpu.c:928
vl_api_address_t src
Definition: gre.api:60
gtpu_input_next_t
Definition: gtpu.h:184
uword * vtep4
Definition: gtpu.h:211
unsigned char u8
Definition: types.h:56
dpo_id_t next_dpo
Definition: gtpu.h:135
vl_api_interface_index_t sw_if_index
Definition: gre.api:59
ip46_address_t src
Definition: gtpu.h:141
u16 msg_id_base
Definition: gtpu.h:229
unsigned int u32
Definition: types.h:88
u16 sequence
Definition: gtpu.h:60
bool is_ip6
Definition: ip.api:43
vl_api_fib_path_type_t type
Definition: fib_types.api:123
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:170
u32 decap_next_index
Definition: gtpu.h:148
uword * vtep6
Definition: gtpu.h:212
unsigned short u16
Definition: types.h:57
gtpu_input_error_t
Definition: gtpu.h:192
adj_index_t mcast_adj_index
Definition: gtpu.h:167
An node in the FIB graph.
Definition: fib_node.h:295
vl_api_address_t dst
Definition: gre.api:61
ip46_address_t dst
Definition: gtpu.h:142
int vnet_gtpu_add_del_tunnel(vnet_gtpu_add_del_tunnel_args_t *a, u32 *sw_if_indexp)
Definition: gtpu.c:373
u8 ip6[16]
Definition: one.api:477
gtpu_main_t gtpu_main
Definition: gtpu.c:36
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:30
u32 sw_if_index
Definition: gtpu.h:154
u32 adj_index_t
An index for adjacencies.
Definition: adj_types.h:30
u32 sibling_index
The tunnel is a child of the FIB entry for its destination.
Definition: gtpu.h:175
#define foreach_gtpu_input_next
Definition: gtpu.h:178
u32 * free_gtpu_tunnel_hw_if_indices
Definition: gtpu.h:218
fib_node_index_t fib_entry_index
Definition: gtpu.h:166
u8 * format_gtpu_encap_trace(u8 *s, va_list *args)
Definition: gtpu.c:52
fib_node_t node
Linkage into the FIB object graph.
Definition: gtpu.h:160
u32 hw_if_index
Definition: gtpu.h:155
u32 encap_fib_index
Definition: gtpu.h:151
u8 pdu_number
Definition: gtpu.h:61
uword * gtpu4_tunnel_by_key
Definition: gtpu.h:206
u32 tunnel_index
Definition: gtpu.h:260
vlib_node_registration_t gtpu6_input_node
(constructor) VLIB_REGISTER_NODE (gtpu6_input_node)
Definition: gtpu_decap.c:781
struct _vlib_node_registration vlib_node_registration_t
uword * mcast_shared
Definition: gtpu.h:215
uword * gtpu6_tunnel_by_key
Definition: gtpu.h:207
u64 uword
Definition: types.h:112
vlib_node_registration_t gtpu6_encap_node
(constructor) VLIB_REGISTER_NODE (gtpu6_encap_node)
Definition: gtpu_encap.c:702
Bits Octets 8 7 6 5 4 3 2 1 1 Version PT (*) E S PN 2 Message Type 3 Length (1st Octet) 4 Length...
Definition: mobile.h:72
u8 next_ext_type
Definition: gtpu.h:62
enum fib_node_type_t_ fib_node_type_t
The types of nodes in a FIB graph.
gtpu_tunnel_t * tunnels
Definition: gtpu.h:203
u8 * rewrite
Definition: gtpu.h:132
u32 ip4
Definition: one.api:440
typedef CLIB_PACKED(struct { ip4_header_t ip4;udp_header_t udp;gtpu_header_t gtpu;}) ip4_gtpu_header_t
vlib_node_registration_t gtpu4_input_node
(constructor) VLIB_REGISTER_NODE (gtpu4_input_node)
Definition: gtpu_decap.c:761
u32 mcast_sw_if_index
Definition: gtpu.h:145