FD.io VPP  v17.10-9-gd594711
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  */
34 static char * vxlan_gpe_encap_error_strings[] = {
35 #define _(sym,string) string,
37 #undef _
38 };
39 
40 /**
41  * @brief Struct for VXLAN GPE errors/counters
42  */
43 typedef enum {
44 #define _(sym,str) VXLAN_GPE_ENCAP_ERROR_##sym,
46 #undef _
49 
50 /**
51  * @brief Struct for tracing VXLAN GPE encapsulated packets
52  */
53 typedef struct {
56 
57 /**
58  * @brief Trace of packets encapsulated in VXLAN GPE
59  *
60  * @param *s
61  * @param *args
62  *
63  * @return *s
64  *
65  */
66 u8 * format_vxlan_gpe_encap_trace (u8 * s, va_list * args)
67 {
68  CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
69  CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
71  = va_arg (*args, vxlan_gpe_encap_trace_t *);
72 
73  s = format (s, "VXLAN-GPE-ENCAP: tunnel %d", t->tunnel_index);
74  return s;
75 }
76 
77 /**
78  * @brief Instantiates UDP + VXLAN-GPE header then set next node to IP4|6 lookup
79  *
80  * @param *ngm
81  * @param *b0
82  * @param *t0 contains rewrite header
83  * @param *next0 relative index of next dispatch function (next node)
84  * @param is_v4 Is this IPv4? (or IPv6)
85  *
86  */
87 always_inline void
89  vxlan_gpe_tunnel_t * t0, u32 * next0,
90  u8 is_v4)
91 {
92  ASSERT(sizeof(ip4_vxlan_gpe_header_t) == 36);
93  ASSERT(sizeof(ip6_vxlan_gpe_header_t) == 56);
94 
95  ip_udp_encap_one (ngm->vlib_main, b0, t0->rewrite, t0->rewrite_size, is_v4);
96  next0[0] = t0->encap_next_node;
97 }
98 
99 /**
100  * @brief Instantiates UDP + VXLAN-GPE header then set next node to IP4|6 lookup for two packets
101  *
102  * @param *ngm
103  * @param *b0 Packet0
104  * @param *b1 Packet1
105  * @param *t0 contains rewrite header for Packet0
106  * @param *t1 contains rewrite header for Packet1
107  * @param *next0 relative index of next dispatch function (next node) for Packet0
108  * @param *next1 relative index of next dispatch function (next node) for Packet1
109  * @param is_v4 Is this IPv4? (or IPv6)
110  *
111  */
112 always_inline void
115  vxlan_gpe_tunnel_t * t1, u32 * next0,
116  u32 * next1, u8 is_v4)
117 {
118  ASSERT(sizeof(ip4_vxlan_gpe_header_t) == 36);
119  ASSERT(sizeof(ip6_vxlan_gpe_header_t) == 56);
120 
121  ip_udp_encap_one (ngm->vlib_main, b0, t0->rewrite, t0->rewrite_size, is_v4);
122  ip_udp_encap_one (ngm->vlib_main, b1, t1->rewrite, t1->rewrite_size, is_v4);
123  next0[0] = next1[0] = t0->encap_next_node;
124 }
125 
126 /**
127  * @brief Common processing for IPv4 and IPv6 VXLAN GPE encap dispatch functions
128  *
129  * It is worth noting that other than trivial UDP forwarding (transit), VXLAN GPE
130  * tunnels are "establish local". This means that we don't have a TX interface as yet
131  * as we need to look up where the outer-header dest is. By setting the TX index in the
132  * buffer metadata to the encap FIB, we can do a lookup to get the adjacency and real TX.
133  *
134  * vnet_buffer(b0)->sw_if_index[VLIB_TX] = t0->encap_fib_index;
135  *
136  * @node vxlan-gpe-input
137  * @param *vm
138  * @param *node
139  * @param *from_frame
140  *
141  * @return from_frame->n_vectors
142  *
143  */
144 static uword
146  vlib_node_runtime_t * node,
147  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 = vlib_get_thread_index ();
155  u32 stats_sw_if_index, stats_n_packets, stats_n_bytes;
156 
157  from = vlib_frame_vector_args (from_frame);
158  n_left_from = from_frame->n_vectors;
159 
160  next_index = node->cached_next_index;
161  stats_sw_if_index = node->runtime_data[0];
162  stats_n_packets = stats_n_bytes = 0;
163 
164  while (n_left_from > 0)
165  {
166  u32 n_left_to_next;
167 
168  vlib_get_next_frame(vm, node, next_index, to_next, n_left_to_next);
169 
170  while (n_left_from >= 4 && n_left_to_next >= 2)
171  {
172  u32 bi0, bi1;
173  vlib_buffer_t * b0, *b1;
174  u32 next0, next1;
175  u32 sw_if_index0, sw_if_index1, len0, len1;
176  vnet_hw_interface_t * hi0, *hi1;
177  vxlan_gpe_tunnel_t * t0, *t1;
178  u8 is_ip4_0, is_ip4_1;
179 
180  next0 = next1 = VXLAN_GPE_ENCAP_NEXT_IP4_LOOKUP;
181 
182  /* Prefetch next iteration. */
183  {
184  vlib_buffer_t * p2, *p3;
185 
186  p2 = vlib_get_buffer (vm, from[2]);
187  p3 = vlib_get_buffer (vm, from[3]);
188 
189  vlib_prefetch_buffer_header(p2, LOAD);
190  vlib_prefetch_buffer_header(p3, LOAD);
191 
194  }
195 
196  bi0 = from[0];
197  bi1 = from[1];
198  to_next[0] = bi0;
199  to_next[1] = bi1;
200  from += 2;
201  to_next += 2;
202  n_left_to_next -= 2;
203  n_left_from -= 2;
204 
205  b0 = vlib_get_buffer (vm, bi0);
206  b1 = vlib_get_buffer (vm, bi1);
207 
208  /* 1-wide cache? */
209  sw_if_index0 = vnet_buffer(b0)->sw_if_index[VLIB_TX];
210  sw_if_index1 = vnet_buffer(b1)->sw_if_index[VLIB_TX];
211  hi0 = vnet_get_sup_hw_interface (vnm, vnet_buffer(b0)->sw_if_index[VLIB_TX]);
212  hi1 = vnet_get_sup_hw_interface (vnm, vnet_buffer(b1)->sw_if_index[VLIB_TX]);
213 
214  t0 = pool_elt_at_index(ngm->tunnels, hi0->dev_instance);
215  t1 = pool_elt_at_index(ngm->tunnels, hi1->dev_instance);
216 
217  is_ip4_0 = (t0->flags & VXLAN_GPE_TUNNEL_IS_IPV4);
218  is_ip4_1 = (t1->flags & VXLAN_GPE_TUNNEL_IS_IPV4);
219 
220  if (PREDICT_TRUE(is_ip4_0 == is_ip4_1))
221  {
222  vxlan_gpe_encap_two_inline (ngm, b0, b1, t0, t1, &next0, &next1,is_ip4_0);
223  }
224  else
225  {
226  vxlan_gpe_encap_one_inline (ngm, b0, t0, &next0, is_ip4_0);
227  vxlan_gpe_encap_one_inline (ngm, b1, t1, &next1, is_ip4_1);
228  }
229 
230  /* Reset to look up tunnel partner in the configured FIB */
231  vnet_buffer(b0)->sw_if_index[VLIB_TX] = t0->encap_fib_index;
232  vnet_buffer(b1)->sw_if_index[VLIB_TX] = t1->encap_fib_index;
233  vnet_buffer(b0)->sw_if_index[VLIB_RX] = sw_if_index0;
234  vnet_buffer(b1)->sw_if_index[VLIB_RX] = sw_if_index1;
235  pkts_encapsulated += 2;
236 
237  len0 = vlib_buffer_length_in_chain (vm, b0);
238  len1 = vlib_buffer_length_in_chain (vm, b0);
239  stats_n_packets += 2;
240  stats_n_bytes += len0 + len1;
241 
242  /* Batch stats increment on the same vxlan tunnel so counter is not
243  incremented per packet. Note stats are still incremented for deleted
244  and admin-down tunnel where packets are dropped. It is not worthwhile
245  to check for this rare case and affect normal path performance. */
246  if (PREDICT_FALSE((sw_if_index0 != stats_sw_if_index)
247  || (sw_if_index1 != stats_sw_if_index)))
248  {
249  stats_n_packets -= 2;
250  stats_n_bytes -= len0 + len1;
251  if (sw_if_index0 == sw_if_index1)
252  {
253  if (stats_n_packets)
256  thread_index, stats_sw_if_index, stats_n_packets, stats_n_bytes);
257  stats_sw_if_index = sw_if_index0;
258  stats_n_packets = 2;
259  stats_n_bytes = len0 + len1;
260  }
261  else
262  {
265  thread_index, sw_if_index0, 1, len0);
268  thread_index, sw_if_index1, 1, len1);
269  }
270  }
271 
273  {
274  vxlan_gpe_encap_trace_t *tr = vlib_add_trace (vm, node, b0, sizeof(*tr));
275  tr->tunnel_index = t0 - ngm->tunnels;
276  }
277 
279  {
280  vxlan_gpe_encap_trace_t *tr = vlib_add_trace (vm, node, b1,
281  sizeof(*tr));
282  tr->tunnel_index = t1 - ngm->tunnels;
283  }
284 
285  vlib_validate_buffer_enqueue_x2(vm, node, next_index, to_next,
286  n_left_to_next, bi0, bi1, next0, next1);
287  }
288 
289  while (n_left_from > 0 && n_left_to_next > 0)
290  {
291  u32 bi0;
292  vlib_buffer_t * b0;
294  u32 sw_if_index0, len0;
295  vnet_hw_interface_t * hi0;
296  vxlan_gpe_tunnel_t * t0;
297  u8 is_ip4_0;
298 
299  bi0 = from[0];
300  to_next[0] = bi0;
301  from += 1;
302  to_next += 1;
303  n_left_from -= 1;
304  n_left_to_next -= 1;
305 
306  b0 = vlib_get_buffer (vm, bi0);
307 
308  /* 1-wide cache? */
309  sw_if_index0 = vnet_buffer(b0)->sw_if_index[VLIB_TX];
310  hi0 = vnet_get_sup_hw_interface (vnm, vnet_buffer(b0)->sw_if_index[VLIB_TX]);
311 
312  t0 = pool_elt_at_index(ngm->tunnels, hi0->dev_instance);
313 
314  is_ip4_0 = (t0->flags & VXLAN_GPE_TUNNEL_IS_IPV4);
315 
316  vxlan_gpe_encap_one_inline (ngm, b0, t0, &next0, is_ip4_0);
317 
318  /* Reset to look up tunnel partner in the configured FIB */
319  vnet_buffer(b0)->sw_if_index[VLIB_TX] = t0->encap_fib_index;
320  vnet_buffer(b0)->sw_if_index[VLIB_RX] = sw_if_index0;
321  pkts_encapsulated++;
322 
323  len0 = vlib_buffer_length_in_chain (vm, b0);
324  stats_n_packets += 1;
325  stats_n_bytes += len0;
326 
327  /* Batch stats increment on the same vxlan tunnel so counter is not
328  * incremented per packet. Note stats are still incremented for deleted
329  * and admin-down tunnel where packets are dropped. It is not worthwhile
330  * to check for this rare case and affect normal path performance. */
331  if (PREDICT_FALSE(sw_if_index0 != stats_sw_if_index))
332  {
333  stats_n_packets -= 1;
334  stats_n_bytes -= len0;
335  if (stats_n_packets)
338  thread_index, stats_sw_if_index, stats_n_packets, stats_n_bytes);
339  stats_n_packets = 1;
340  stats_n_bytes = len0;
341  stats_sw_if_index = sw_if_index0;
342  }
344  {
345  vxlan_gpe_encap_trace_t *tr = vlib_add_trace (vm, node, b0,
346  sizeof(*tr));
347  tr->tunnel_index = t0 - ngm->tunnels;
348  }
349  vlib_validate_buffer_enqueue_x1(vm, node, next_index, to_next,
350  n_left_to_next, bi0, next0);
351  }
352 
353  vlib_put_next_frame (vm, node, next_index, n_left_to_next);
354  }
356  VXLAN_GPE_ENCAP_ERROR_ENCAPSULATED,
357  pkts_encapsulated);
358  /* Increment any remaining batch stats */
359  if (stats_n_packets)
360  {
363  stats_sw_if_index, stats_n_packets, stats_n_bytes);
364  node->runtime_data[0] = stats_sw_if_index;
365  }
366 
367  return from_frame->n_vectors;
368 }
369 
371  .function = vxlan_gpe_encap,
372  .name = "vxlan-gpe-encap",
373  .vector_size = sizeof (u32),
374  .format_trace = format_vxlan_gpe_encap_trace,
375  .type = VLIB_NODE_TYPE_INTERNAL,
376 
378  .error_strings = vxlan_gpe_encap_error_strings,
379 
380  .n_next_nodes = VXLAN_GPE_ENCAP_N_NEXT,
381 
382  .next_nodes = {
383  [VXLAN_GPE_ENCAP_NEXT_IP4_LOOKUP] = "ip4-lookup",
384  [VXLAN_GPE_ENCAP_NEXT_IP6_LOOKUP] = "ip6-lookup",
385  [VXLAN_GPE_ENCAP_NEXT_DROP] = "error-drop",
386  },
387 };
388 
#define CLIB_UNUSED(x)
Definition: clib.h:79
u32 flags
flags
Definition: vxlan_gpe.h:125
#define foreach_vxlan_gpe_encap_error
Statistics (not really errors)
Definition: encap.c:28
Struct for tracing VXLAN GPE encapsulated packets.
Definition: encap.c:53
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:211
u8 runtime_data[0]
Function dependent node-runtime data.
Definition: node.h:464
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:56
#define PREDICT_TRUE(x)
Definition: clib.h:98
VXLAN GPE definitions.
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
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:107
vnet_main_t * vnet_main
State convenience vnet_main_t.
Definition: vxlan_gpe.h:206
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:145
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:88
#define always_inline
Definition: clib.h:84
vlib_combined_counter_main_t * combined_sw_if_counters
Definition: interface.h:668
#define vlib_prefetch_buffer_header(b, type)
Prefetch buffer metadata.
Definition: buffer.h:169
u8 * format_vxlan_gpe_encap_trace(u8 *s, va_list *args)
Trace of packets encapsulated in VXLAN GPE.
Definition: encap.c:66
u8 * rewrite
Rewrite string.
Definition: vxlan_gpe.h:96
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:458
Struct for VXLAN GPE tunnel.
Definition: vxlan_gpe.h:94
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:113
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:45
vlib_main_t * vlib_main
State convenience vlib_main_t.
Definition: vxlan_gpe.h:204
#define PREDICT_FALSE(x)
Definition: clib.h:97
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:239
u32 node_index
Node index.
Definition: node.h:437
#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:216
#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:364
static void vlib_node_increment_counter(vlib_main_t *vm, u32 node_index, u32 counter_index, u64 increment)
Definition: node_funcs.h:1158
u16 n_vectors
Definition: node.h:344
static_always_inline uword vlib_get_thread_index(void)
Definition: threads.h:221
#define CLIB_PREFETCH(addr, size, type)
Definition: cache.h:82
vlib_main_t * vm
Definition: buffer.c:283
#define VLIB_BUFFER_IS_TRACED
Definition: buffer.h:93
#define ARRAY_LEN(x)
Definition: clib.h:59
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:454
u16 cached_next_index
Next frame index that vector arguments were last enqueued to last time this node ran.
Definition: node.h:456
#define ASSERT(truth)
unsigned int u32
Definition: types.h:88
u8 rewrite_size
rewrite size for dynamic plugins like iOAM
Definition: vxlan_gpe.h:128
Struct for VXLAN GPE node state.
Definition: vxlan_gpe.h:182
vxlan_gpe_tunnel_t * tunnels
vector of encap tunnel instances
Definition: vxlan_gpe.h:184
u64 uword
Definition: types.h:112
static void * vlib_add_trace(vlib_main_t *vm, vlib_node_runtime_t *r, vlib_buffer_t *b, u32 n_data_bytes)
Definition: trace_funcs.h:55
Definition: defs.h:47
unsigned char u8
Definition: types.h:56
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:267
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:112
#define vnet_buffer(b)
Definition: buffer.h:306
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:143
uword encap_next_node
Next node after VxLAN-GPE encap.
Definition: vxlan_gpe.h:131
u8 data[0]
Packet data.
Definition: buffer.h:157
vlib_node_registration_t vxlan_gpe_encap_node
(constructor) VLIB_REGISTER_NODE (vxlan_gpe_encap_node)
Definition: encap.c:370
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:67
#define VXLAN_GPE_TUNNEL_IS_IPV4
Flags for vxlan_gpe_tunnel_t.
Definition: vxlan_gpe.h:156
u32 flags
buffer flags: VLIB_BUFFER_FREE_LIST_INDEX_MASK: bits used to store free list index, VLIB_BUFFER_IS_TRACED: trace this buffer.
Definition: buffer.h:75
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:57
Definition: defs.h:46