FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
encap.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 /**
16  * @file
17  * @brief Functions for encapsulating VXLAN GPE tunnels
18  *
19 */
20 #include <vppinfra/error.h>
21 #include <vppinfra/hash.h>
22 #include <vnet/vnet.h>
23 #include <vnet/ip/ip.h>
24 #include <vnet/ethernet/ethernet.h>
26 
27 /** Statistics (not really errors) */
28 #define foreach_vxlan_gpe_encap_error \
29 _(ENCAPSULATED, "good packets encapsulated")
30 
31 /**
32  * @brief VXLAN GPE encap error strings
33  */
35 #define _(sym,string) string,
37 #undef _
38 };
39 
40 /**
41  * @brief Struct for VXLAN GPE errors/counters
42  */
43 typedef enum
44 {
45 #define _(sym,str) VXLAN_GPE_ENCAP_ERROR_##sym,
47 #undef _
50 
51 /**
52  * @brief Struct for tracing VXLAN GPE encapsulated packets
53  */
54 typedef struct
55 {
58 
59 /**
60  * @brief Trace of packets encapsulated in VXLAN GPE
61  *
62  * @param *s
63  * @param *args
64  *
65  * @return *s
66  *
67  */
68 u8 *
69 format_vxlan_gpe_encap_trace (u8 * s, va_list * args)
70 {
71  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
72  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
73  vxlan_gpe_encap_trace_t *t = va_arg (*args, vxlan_gpe_encap_trace_t *);
74 
75  s = format (s, "VXLAN-GPE-ENCAP: tunnel %d", t->tunnel_index);
76  return s;
77 }
78 
79 /**
80  * @brief Instantiates UDP + VXLAN-GPE header then set next node to IP4|6 lookup
81  *
82  * @param *ngm
83  * @param *b0
84  * @param *t0 contains rewrite header
85  * @param *next0 relative index of next dispatch function (next node)
86  * @param is_v4 Is this IPv4? (or IPv6)
87  *
88  */
89 always_inline void
91  vxlan_gpe_tunnel_t * t0, u32 * next0, u8 is_v4)
92 {
93  ASSERT (sizeof (ip4_vxlan_gpe_header_t) == 36);
94  ASSERT (sizeof (ip6_vxlan_gpe_header_t) == 56);
95 
96  ip_udp_encap_one (ngm->vlib_main, b0, t0->rewrite, t0->rewrite_size, is_v4);
97  next0[0] = t0->encap_next_node;
98 }
99 
100 /**
101  * @brief Instantiates UDP + VXLAN-GPE header then set next node to IP4|6 lookup for two packets
102  *
103  * @param *ngm
104  * @param *b0 Packet0
105  * @param *b1 Packet1
106  * @param *t0 contains rewrite header for Packet0
107  * @param *t1 contains rewrite header for Packet1
108  * @param *next0 relative index of next dispatch function (next node) for Packet0
109  * @param *next1 relative index of next dispatch function (next node) for Packet1
110  * @param is_v4 Is this IPv4? (or IPv6)
111  *
112  */
113 always_inline void
116  vxlan_gpe_tunnel_t * t1, u32 * next0,
117  u32 * next1, u8 is_v4)
118 {
119  ASSERT (sizeof (ip4_vxlan_gpe_header_t) == 36);
120  ASSERT (sizeof (ip6_vxlan_gpe_header_t) == 56);
121 
122  ip_udp_encap_one (ngm->vlib_main, b0, t0->rewrite, t0->rewrite_size, is_v4);
123  ip_udp_encap_one (ngm->vlib_main, b1, t1->rewrite, t1->rewrite_size, is_v4);
124  next0[0] = next1[0] = t0->encap_next_node;
125 }
126 
127 /**
128  * @brief Common processing for IPv4 and IPv6 VXLAN GPE encap dispatch functions
129  *
130  * It is worth noting that other than trivial UDP forwarding (transit), VXLAN GPE
131  * tunnels are "establish local". This means that we don't have a TX interface as yet
132  * as we need to look up where the outer-header dest is. By setting the TX index in the
133  * buffer metadata to the encap FIB, we can do a lookup to get the adjacency and real TX.
134  *
135  * vnet_buffer(b0)->sw_if_index[VLIB_TX] = t0->encap_fib_index;
136  *
137  * @node vxlan-gpe-input
138  * @param *vm
139  * @param *node
140  * @param *from_frame
141  *
142  * @return from_frame->n_vectors
143  *
144  */
145 static uword
147  vlib_node_runtime_t * node, vlib_frame_t * from_frame)
148 {
149  u32 n_left_from, next_index, *from, *to_next;
151  vnet_main_t *vnm = ngm->vnet_main;
153  u32 pkts_encapsulated = 0;
154  u32 thread_index = vm->thread_index;
155  u32 stats_sw_if_index, stats_n_packets, stats_n_bytes;
156  vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
157 
158  from = vlib_frame_vector_args (from_frame);
159  n_left_from = from_frame->n_vectors;
160 
161  next_index = node->cached_next_index;
162  stats_sw_if_index = node->runtime_data[0];
163  stats_n_packets = stats_n_bytes = 0;
164  vlib_get_buffers (vm, from, bufs, n_left_from);
165 
166  while (n_left_from > 0)
167  {
168  u32 n_left_to_next;
169  u32 sw_if_index0 = ~0, sw_if_index1 = ~0, len0, len1;
170  vnet_hw_interface_t *hi0, *hi1;
171  vxlan_gpe_tunnel_t *t0 = NULL, *t1 = NULL;
172  u8 is_ip4_0 = 0, is_ip4_1 = 0;
173 
174  vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
175 
176  while (n_left_from >= 4 && n_left_to_next >= 2)
177  {
178  u32 bi0, bi1;
179  u32 next0, next1;
180 
181  next0 = next1 = VXLAN_GPE_ENCAP_NEXT_IP4_LOOKUP;
182 
183  /* Prefetch next iteration. */
184  {
185  vlib_prefetch_buffer_header (b[2], LOAD);
186  vlib_prefetch_buffer_header (b[3], LOAD);
187 
189  2 * CLIB_CACHE_LINE_BYTES, LOAD);
191  2 * CLIB_CACHE_LINE_BYTES, LOAD);
192  }
193 
194  bi0 = from[0];
195  bi1 = from[1];
196  to_next[0] = bi0;
197  to_next[1] = bi1;
198  from += 2;
199  to_next += 2;
200  n_left_to_next -= 2;
201  n_left_from -= 2;
202 
203  /* get the flag "is_ip4" */
204  if (sw_if_index0 != vnet_buffer (b[0])->sw_if_index[VLIB_TX])
205  {
206  sw_if_index0 = vnet_buffer (b[0])->sw_if_index[VLIB_TX];
207  hi0 =
209  vnet_buffer (b[0])->sw_if_index
210  [VLIB_TX]);
211  t0 = pool_elt_at_index (ngm->tunnels, hi0->dev_instance);
212  is_ip4_0 = (t0->flags & VXLAN_GPE_TUNNEL_IS_IPV4);
213  }
214 
215  /* get the flag "is_ip4" */
216  if (sw_if_index1 != vnet_buffer (b[1])->sw_if_index[VLIB_TX])
217  {
218  if (sw_if_index0 == vnet_buffer (b[1])->sw_if_index[VLIB_TX])
219  {
220  sw_if_index1 = sw_if_index0;
221  hi1 = hi0;
222  t1 = t0;
223  is_ip4_1 = is_ip4_0;
224  }
225  else
226  {
227  sw_if_index1 = vnet_buffer (b[1])->sw_if_index[VLIB_TX];
228  hi1 =
230  vnet_buffer (b[1])->sw_if_index
231  [VLIB_TX]);
232  t1 = pool_elt_at_index (ngm->tunnels, hi1->dev_instance);
233  is_ip4_1 = (t1->flags & VXLAN_GPE_TUNNEL_IS_IPV4);
234  }
235  }
236 
237  if (PREDICT_TRUE (is_ip4_0 == is_ip4_1))
238  {
239  vxlan_gpe_encap_two_inline (ngm, b[0], b[1], t0, t1, &next0,
240  &next1, is_ip4_0);
241  }
242  else
243  {
244  vxlan_gpe_encap_one_inline (ngm, b[0], t0, &next0, is_ip4_0);
245  vxlan_gpe_encap_one_inline (ngm, b[1], t1, &next1, is_ip4_1);
246  }
247 
248  /* Reset to look up tunnel partner in the configured FIB */
249  vnet_buffer (b[0])->sw_if_index[VLIB_TX] = t0->encap_fib_index;
250  vnet_buffer (b[1])->sw_if_index[VLIB_TX] = t1->encap_fib_index;
251  vnet_buffer (b[0])->sw_if_index[VLIB_RX] = sw_if_index0;
252  vnet_buffer (b[1])->sw_if_index[VLIB_RX] = sw_if_index1;
253  pkts_encapsulated += 2;
254 
255  len0 = vlib_buffer_length_in_chain (vm, b[0]);
256  len1 = vlib_buffer_length_in_chain (vm, b[1]);
257  stats_n_packets += 2;
258  stats_n_bytes += len0 + len1;
259 
260  /* Batch stats increment on the same vxlan tunnel so counter is not
261  incremented per packet. Note stats are still incremented for deleted
262  and admin-down tunnel where packets are dropped. It is not worthwhile
263  to check for this rare case and affect normal path performance. */
264  if (PREDICT_FALSE ((sw_if_index0 != stats_sw_if_index)
265  || (sw_if_index1 != stats_sw_if_index)))
266  {
267  stats_n_packets -= 2;
268  stats_n_bytes -= len0 + len1;
269  if (sw_if_index0 == sw_if_index1)
270  {
271  if (stats_n_packets)
274  VNET_INTERFACE_COUNTER_TX, thread_index,
275  stats_sw_if_index, stats_n_packets, stats_n_bytes);
276  stats_sw_if_index = sw_if_index0;
277  stats_n_packets = 2;
278  stats_n_bytes = len0 + len1;
279  }
280  else
281  {
283  +
285  thread_index, sw_if_index0,
286  1, len0);
288  +
290  thread_index, sw_if_index1,
291  1, len1);
292  }
293  }
294 
295  if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
296  {
298  vlib_add_trace (vm, node, b[0], sizeof (*tr));
299  tr->tunnel_index = t0 - ngm->tunnels;
300  }
301 
302  if (PREDICT_FALSE (b[1]->flags & VLIB_BUFFER_IS_TRACED))
303  {
304  vxlan_gpe_encap_trace_t *tr = vlib_add_trace (vm, node, b[1],
305  sizeof (*tr));
306  tr->tunnel_index = t1 - ngm->tunnels;
307  }
308  b += 2;
309 
310  vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
311  n_left_to_next, bi0, bi1, next0,
312  next1);
313  }
314 
315  while (n_left_from > 0 && n_left_to_next > 0)
316  {
317  u32 bi0;
319 
320  bi0 = from[0];
321  to_next[0] = bi0;
322  from += 1;
323  to_next += 1;
324  n_left_from -= 1;
325  n_left_to_next -= 1;
326 
327  /* get the flag "is_ip4" */
328  if (sw_if_index0 != vnet_buffer (b[0])->sw_if_index[VLIB_TX])
329  {
330  sw_if_index0 = vnet_buffer (b[0])->sw_if_index[VLIB_TX];
331  hi0 =
333  vnet_buffer (b[0])->sw_if_index
334  [VLIB_TX]);
335 
336  t0 = pool_elt_at_index (ngm->tunnels, hi0->dev_instance);
337 
338  is_ip4_0 = (t0->flags & VXLAN_GPE_TUNNEL_IS_IPV4);
339  }
340 
341  vxlan_gpe_encap_one_inline (ngm, b[0], t0, &next0, is_ip4_0);
342 
343  /* Reset to look up tunnel partner in the configured FIB */
344  vnet_buffer (b[0])->sw_if_index[VLIB_TX] = t0->encap_fib_index;
345  vnet_buffer (b[0])->sw_if_index[VLIB_RX] = sw_if_index0;
346  pkts_encapsulated++;
347 
348  len0 = vlib_buffer_length_in_chain (vm, b[0]);
349  stats_n_packets += 1;
350  stats_n_bytes += len0;
351 
352  /* Batch stats increment on the same vxlan tunnel so counter is not
353  * incremented per packet. Note stats are still incremented for deleted
354  * and admin-down tunnel where packets are dropped. It is not worthwhile
355  * to check for this rare case and affect normal path performance. */
356  if (PREDICT_FALSE (sw_if_index0 != stats_sw_if_index))
357  {
358  stats_n_packets -= 1;
359  stats_n_bytes -= len0;
360  if (stats_n_packets)
363  thread_index,
364  stats_sw_if_index,
365  stats_n_packets,
366  stats_n_bytes);
367  stats_n_packets = 1;
368  stats_n_bytes = len0;
369  stats_sw_if_index = sw_if_index0;
370  }
371  if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
372  {
373  vxlan_gpe_encap_trace_t *tr = vlib_add_trace (vm, node, b[0],
374  sizeof (*tr));
375  tr->tunnel_index = t0 - ngm->tunnels;
376  }
377  b += 1;
378 
379  vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
380  n_left_to_next, bi0, next0);
381  }
382 
383  vlib_put_next_frame (vm, node, next_index, n_left_to_next);
384  }
386  VXLAN_GPE_ENCAP_ERROR_ENCAPSULATED,
387  pkts_encapsulated);
388  /* Increment any remaining batch stats */
389  if (stats_n_packets)
390  {
393  thread_index, stats_sw_if_index,
394  stats_n_packets, stats_n_bytes);
395  node->runtime_data[0] = stats_sw_if_index;
396  }
397 
398  return from_frame->n_vectors;
399 }
400 
401 /* *INDENT-OFF* */
403  .function = vxlan_gpe_encap,
404  .name = "vxlan-gpe-encap",
405  .vector_size = sizeof (u32),
406  .format_trace = format_vxlan_gpe_encap_trace,
408 
410  .error_strings = vxlan_gpe_encap_error_strings,
411 
412  .n_next_nodes = VXLAN_GPE_ENCAP_N_NEXT,
413 
414  .next_nodes = {
415  [VXLAN_GPE_ENCAP_NEXT_IP4_LOOKUP] = "ip4-lookup",
416  [VXLAN_GPE_ENCAP_NEXT_IP6_LOOKUP] = "ip6-lookup",
417  [VXLAN_GPE_ENCAP_NEXT_DROP] = "error-drop",
418  },
419 };
420 /* *INDENT-ON* */
421 
422 
423 /*
424  * fd.io coding-style-patch-verification: ON
425  *
426  * Local Variables:
427  * eval: (c-set-style "gnu")
428  * End:
429  */
#define CLIB_UNUSED(x)
Definition: clib.h:87
u32 flags
flags
Definition: vxlan_gpe.h:138
#define foreach_vxlan_gpe_encap_error
Statistics (not really errors)
Definition: encap.c:28
vl_api_wireguard_peer_flags_t flags
Definition: wireguard.api:103
Struct for tracing VXLAN GPE encapsulated packets.
Definition: encap.c:54
static void vlib_increment_combined_counter(vlib_combined_counter_main_t *cm, u32 thread_index, u32 index, u64 n_packets, u64 n_bytes)
Increment a combined counter.
Definition: counter.h:220
u8 runtime_data[0]
Function dependent node-runtime data.
Definition: node.h:518
static vnet_hw_interface_t * vnet_get_sup_hw_interface(vnet_main_t *vnm, u32 sw_if_index)
vnet_interface_main_t interface_main
Definition: vnet.h:59
#define PREDICT_TRUE(x)
Definition: clib.h:121
VXLAN GPE definitions.
u32 thread_index
Definition: main.h:249
vlib_main_t * vm
Definition: in2out_ed.c:1582
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
static uword vlib_buffer_length_in_chain(vlib_main_t *vm, vlib_buffer_t *b)
Get length in bytes of the buffer chain.
Definition: buffer_funcs.h:402
unsigned char u8
Definition: types.h:56
vnet_main_t * vnet_main
State convenience vnet_main_t.
Definition: vxlan_gpe.h:221
u8 data[128]
Definition: ipsec_types.api:89
static uword vxlan_gpe_encap(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *from_frame)
Common processing for IPv4 and IPv6 VXLAN GPE encap dispatch functions.
Definition: encap.c:146
static void vxlan_gpe_encap_one_inline(vxlan_gpe_main_t *ngm, vlib_buffer_t *b0, vxlan_gpe_tunnel_t *t0, u32 *next0, u8 is_v4)
Instantiates UDP + VXLAN-GPE header then set next node to IP4|6 lookup.
Definition: encap.c:90
vlib_combined_counter_main_t * combined_sw_if_counters
Definition: interface.h:881
#define vlib_prefetch_buffer_header(b, type)
Prefetch buffer metadata.
Definition: buffer.h:203
u8 * format_vxlan_gpe_encap_trace(u8 *s, va_list *args)
Trace of packets encapsulated in VXLAN GPE.
Definition: encap.c:69
unsigned int u32
Definition: types.h:88
#define VLIB_FRAME_SIZE
Definition: node.h:377
u8 * rewrite
Rewrite string.
Definition: vxlan_gpe.h:109
vl_api_fib_path_type_t type
Definition: fib_types.api:123
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:534
Struct for VXLAN GPE tunnel.
Definition: vxlan_gpe.h:103
static void vxlan_gpe_encap_two_inline(vxlan_gpe_main_t *ngm, vlib_buffer_t *b0, vlib_buffer_t *b1, vxlan_gpe_tunnel_t *t0, vxlan_gpe_tunnel_t *t1, u32 *next0, u32 *next1, u8 is_v4)
Instantiates UDP + VXLAN-GPE header then set next node to IP4|6 lookup for two packets.
Definition: encap.c:114
vxlan_gpe_encap_error_t
Struct for VXLAN GPE errors/counters.
Definition: encap.c:43
vxlan_gpe_main_t vxlan_gpe_main
Definition: vxlan_gpe.c:46
vlib_main_t * vlib_main
State convenience vlib_main_t.
Definition: vxlan_gpe.h:219
#define PREDICT_FALSE(x)
Definition: clib.h:120
#define always_inline
Definition: ipsec.h:28
static void ip_udp_encap_one(vlib_main_t *vm, vlib_buffer_t *b0, u8 *ec0, word ec_len, u8 is_ip4)
Definition: udp.h:374
u32 node_index
Node index.
Definition: node.h:487
#define vlib_validate_buffer_enqueue_x2(vm, node, next_index, to_next, n_left_to_next, bi0, bi1, next0, next1)
Finish enqueueing two buffers forward in the graph.
Definition: buffer_node.h:70
#define vlib_validate_buffer_enqueue_x1(vm, node, next_index, to_next, n_left_to_next, bi0, next0)
Finish enqueueing one buffer forward in the graph.
Definition: buffer_node.h:224
#define vlib_get_next_frame(vm, node, next_index, vectors, n_vectors_left)
Get pointer to next frame vector data by (vlib_node_runtime_t, next_index).
Definition: node_funcs.h:391
static void vlib_node_increment_counter(vlib_main_t *vm, u32 node_index, u32 counter_index, u64 increment)
Definition: node_funcs.h:1231
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:169
u16 n_vectors
Definition: node.h:396
#define CLIB_PREFETCH(addr, size, type)
Definition: cache.h:80
#define ARRAY_LEN(x)
Definition: clib.h:67
void vlib_put_next_frame(vlib_main_t *vm, vlib_node_runtime_t *r, u32 next_index, u32 n_vectors_left)
Release pointer to next frame vector data.
Definition: main.c:483
vlib_main_t vlib_node_runtime_t * node
Definition: in2out_ed.c:1582
u16 cached_next_index
Next frame index that vector arguments were last enqueued to last time this node ran.
Definition: node.h:510
#define ASSERT(truth)
u8 rewrite_size
rewrite size for dynamic plugins like iOAM
Definition: vxlan_gpe.h:141
Struct for VXLAN GPE node state.
Definition: vxlan_gpe.h:197
vxlan_gpe_tunnel_t * tunnels
vector of encap tunnel instances
Definition: vxlan_gpe.h:200
Definition: defs.h:47
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:297
static char * vxlan_gpe_encap_error_strings[]
VXLAN GPE encap error strings.
Definition: encap.c:34
u32 encap_fib_index
FIB indices - tunnel partner lookup here.
Definition: vxlan_gpe.h:125
#define vnet_buffer(b)
Definition: buffer.h:417
uword encap_next_node
Next node after VxLAN-GPE encap.
Definition: vxlan_gpe.h:144
void * vlib_add_trace(vlib_main_t *vm, vlib_node_runtime_t *r, vlib_buffer_t *b, u32 n_data_bytes)
Definition: trace.c:577
vlib_node_registration_t vxlan_gpe_encap_node
(constructor) VLIB_REGISTER_NODE (vxlan_gpe_encap_node)
Definition: encap.c:402
static_always_inline void vlib_get_buffers(vlib_main_t *vm, u32 *bi, vlib_buffer_t **b, int count)
Translate array of buffer indices into buffer pointers.
Definition: buffer_funcs.h:280
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59
#define VXLAN_GPE_TUNNEL_IS_IPV4
Flags for vxlan_gpe_tunnel_t.
Definition: vxlan_gpe.h:169
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:33
Definition: defs.h:46