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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * @brief Functions for encapsulating VXLAN GPE tunnels
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>
25 #include <vnet/udp/udp_inlines.h>
26 #include <vnet/vxlan-gpe/vxlan_gpe.h>
28 /** Statistics (not really errors) */
29 #define foreach_vxlan_gpe_encap_error \
30 _(ENCAPSULATED, "good packets encapsulated")
33 * @brief VXLAN GPE encap error strings
35 static char *vxlan_gpe_encap_error_strings[] = {
36 #define _(sym,string) string,
37 foreach_vxlan_gpe_encap_error
42 * @brief Struct for VXLAN GPE errors/counters
46 #define _(sym,str) VXLAN_GPE_ENCAP_ERROR_##sym,
47 foreach_vxlan_gpe_encap_error
49 VXLAN_GPE_ENCAP_N_ERROR,
50 } vxlan_gpe_encap_error_t;
53 * @brief Struct for tracing VXLAN GPE encapsulated packets
58 } vxlan_gpe_encap_trace_t;
61 * @brief Trace of packets encapsulated in VXLAN GPE
70 format_vxlan_gpe_encap_trace (u8 * s, va_list * args)
72 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
73 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
74 vxlan_gpe_encap_trace_t *t = va_arg (*args, vxlan_gpe_encap_trace_t *);
76 s = format (s, "VXLAN-GPE-ENCAP: tunnel %d", t->tunnel_index);
81 * @brief Instantiates UDP + VXLAN-GPE header then set next node to IP4|6 lookup
85 * @param *t0 contains rewrite header
86 * @param *next0 relative index of next dispatch function (next node)
87 * @param is_v4 Is this IPv4? (or IPv6)
91 vxlan_gpe_encap_one_inline (vxlan_gpe_main_t * ngm, vlib_buffer_t * b0,
92 vxlan_gpe_tunnel_t * t0, u32 * next0, u8 is_v4)
94 ASSERT (sizeof (ip4_vxlan_gpe_header_t) == 36);
95 ASSERT (sizeof (ip6_vxlan_gpe_header_t) == 56);
97 ip_udp_encap_one (ngm->vlib_main, b0, t0->rewrite, t0->rewrite_size, is_v4);
98 next0[0] = t0->encap_next_node;
102 * @brief Instantiates UDP + VXLAN-GPE header then set next node to IP4|6 lookup for two packets
107 * @param *t0 contains rewrite header for Packet0
108 * @param *t1 contains rewrite header for Packet1
109 * @param *next0 relative index of next dispatch function (next node) for Packet0
110 * @param *next1 relative index of next dispatch function (next node) for Packet1
111 * @param is_v4 Is this IPv4? (or IPv6)
115 vxlan_gpe_encap_two_inline (vxlan_gpe_main_t * ngm, vlib_buffer_t * b0,
116 vlib_buffer_t * b1, vxlan_gpe_tunnel_t * t0,
117 vxlan_gpe_tunnel_t * t1, u32 * next0,
118 u32 * next1, u8 is_v4)
120 ASSERT (sizeof (ip4_vxlan_gpe_header_t) == 36);
121 ASSERT (sizeof (ip6_vxlan_gpe_header_t) == 56);
123 ip_udp_encap_one (ngm->vlib_main, b0, t0->rewrite, t0->rewrite_size, is_v4);
124 ip_udp_encap_one (ngm->vlib_main, b1, t1->rewrite, t1->rewrite_size, is_v4);
125 next0[0] = next1[0] = t0->encap_next_node;
129 * @brief Common processing for IPv4 and IPv6 VXLAN GPE encap dispatch functions
131 * It is worth noting that other than trivial UDP forwarding (transit), VXLAN GPE
132 * tunnels are "establish local". This means that we don't have a TX interface as yet
133 * as we need to look up where the outer-header dest is. By setting the TX index in the
134 * buffer metadata to the encap FIB, we can do a lookup to get the adjacency and real TX.
136 * vnet_buffer(b0)->sw_if_index[VLIB_TX] = t0->encap_fib_index;
138 * @node vxlan-gpe-input
143 * @return from_frame->n_vectors
147 vxlan_gpe_encap (vlib_main_t * vm,
148 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
150 u32 n_left_from, next_index, *from, *to_next;
151 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
152 vnet_main_t *vnm = ngm->vnet_main;
153 vnet_interface_main_t *im = &vnm->interface_main;
154 u32 pkts_encapsulated = 0;
155 u32 thread_index = vm->thread_index;
156 u32 stats_sw_if_index, stats_n_packets, stats_n_bytes;
157 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
159 from = vlib_frame_vector_args (from_frame);
160 n_left_from = from_frame->n_vectors;
162 next_index = node->cached_next_index;
163 stats_sw_if_index = node->runtime_data[0];
164 stats_n_packets = stats_n_bytes = 0;
165 vlib_get_buffers (vm, from, bufs, n_left_from);
167 while (n_left_from > 0)
170 u32 sw_if_index0 = ~0, sw_if_index1 = ~0, len0, len1;
171 vnet_hw_interface_t *hi0, *hi1;
172 vxlan_gpe_tunnel_t *t0 = NULL, *t1 = NULL;
173 u8 is_ip4_0 = 0, is_ip4_1 = 0;
175 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
177 while (n_left_from >= 4 && n_left_to_next >= 2)
182 next0 = next1 = VXLAN_GPE_ENCAP_NEXT_IP4_LOOKUP;
184 /* Prefetch next iteration. */
186 vlib_prefetch_buffer_header (b[2], LOAD);
187 vlib_prefetch_buffer_header (b[3], LOAD);
189 CLIB_PREFETCH (b[2]->data - CLIB_CACHE_LINE_BYTES,
190 2 * CLIB_CACHE_LINE_BYTES, LOAD);
191 CLIB_PREFETCH (b[3]->data - CLIB_CACHE_LINE_BYTES,
192 2 * CLIB_CACHE_LINE_BYTES, LOAD);
204 /* get the flag "is_ip4" */
205 if (sw_if_index0 != vnet_buffer (b[0])->sw_if_index[VLIB_TX])
207 sw_if_index0 = vnet_buffer (b[0])->sw_if_index[VLIB_TX];
209 vnet_get_sup_hw_interface (vnm,
210 vnet_buffer (b[0])->sw_if_index
212 t0 = pool_elt_at_index (ngm->tunnels, hi0->dev_instance);
213 is_ip4_0 = (t0->flags & VXLAN_GPE_TUNNEL_IS_IPV4);
216 /* get the flag "is_ip4" */
217 if (sw_if_index1 != vnet_buffer (b[1])->sw_if_index[VLIB_TX])
219 if (sw_if_index0 == vnet_buffer (b[1])->sw_if_index[VLIB_TX])
221 sw_if_index1 = sw_if_index0;
228 sw_if_index1 = vnet_buffer (b[1])->sw_if_index[VLIB_TX];
230 vnet_get_sup_hw_interface (vnm,
231 vnet_buffer (b[1])->sw_if_index
233 t1 = pool_elt_at_index (ngm->tunnels, hi1->dev_instance);
234 is_ip4_1 = (t1->flags & VXLAN_GPE_TUNNEL_IS_IPV4);
238 if (PREDICT_TRUE (is_ip4_0 == is_ip4_1))
240 vxlan_gpe_encap_two_inline (ngm, b[0], b[1], t0, t1, &next0,
245 vxlan_gpe_encap_one_inline (ngm, b[0], t0, &next0, is_ip4_0);
246 vxlan_gpe_encap_one_inline (ngm, b[1], t1, &next1, is_ip4_1);
249 /* Reset to look up tunnel partner in the configured FIB */
250 vnet_buffer (b[0])->sw_if_index[VLIB_TX] = t0->encap_fib_index;
251 vnet_buffer (b[1])->sw_if_index[VLIB_TX] = t1->encap_fib_index;
252 vnet_buffer (b[0])->sw_if_index[VLIB_RX] = sw_if_index0;
253 vnet_buffer (b[1])->sw_if_index[VLIB_RX] = sw_if_index1;
254 pkts_encapsulated += 2;
256 len0 = vlib_buffer_length_in_chain (vm, b[0]);
257 len1 = vlib_buffer_length_in_chain (vm, b[1]);
258 stats_n_packets += 2;
259 stats_n_bytes += len0 + len1;
261 /* Batch stats increment on the same vxlan tunnel so counter is not
262 incremented per packet. Note stats are still incremented for deleted
263 and admin-down tunnel where packets are dropped. It is not worthwhile
264 to check for this rare case and affect normal path performance. */
265 if (PREDICT_FALSE ((sw_if_index0 != stats_sw_if_index)
266 || (sw_if_index1 != stats_sw_if_index)))
268 stats_n_packets -= 2;
269 stats_n_bytes -= len0 + len1;
270 if (sw_if_index0 == sw_if_index1)
273 vlib_increment_combined_counter
274 (im->combined_sw_if_counters +
275 VNET_INTERFACE_COUNTER_TX, thread_index,
276 stats_sw_if_index, stats_n_packets, stats_n_bytes);
277 stats_sw_if_index = sw_if_index0;
279 stats_n_bytes = len0 + len1;
283 vlib_increment_combined_counter (im->combined_sw_if_counters
285 VNET_INTERFACE_COUNTER_TX,
286 thread_index, sw_if_index0,
288 vlib_increment_combined_counter (im->combined_sw_if_counters
290 VNET_INTERFACE_COUNTER_TX,
291 thread_index, sw_if_index1,
296 if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
298 vxlan_gpe_encap_trace_t *tr =
299 vlib_add_trace (vm, node, b[0], sizeof (*tr));
300 tr->tunnel_index = t0 - ngm->tunnels;
303 if (PREDICT_FALSE (b[1]->flags & VLIB_BUFFER_IS_TRACED))
305 vxlan_gpe_encap_trace_t *tr = vlib_add_trace (vm, node, b[1],
307 tr->tunnel_index = t1 - ngm->tunnels;
311 vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
312 n_left_to_next, bi0, bi1, next0,
316 while (n_left_from > 0 && n_left_to_next > 0)
319 u32 next0 = VXLAN_GPE_ENCAP_NEXT_IP4_LOOKUP;
328 /* get the flag "is_ip4" */
329 if (sw_if_index0 != vnet_buffer (b[0])->sw_if_index[VLIB_TX])
331 sw_if_index0 = vnet_buffer (b[0])->sw_if_index[VLIB_TX];
333 vnet_get_sup_hw_interface (vnm,
334 vnet_buffer (b[0])->sw_if_index
337 t0 = pool_elt_at_index (ngm->tunnels, hi0->dev_instance);
339 is_ip4_0 = (t0->flags & VXLAN_GPE_TUNNEL_IS_IPV4);
342 vxlan_gpe_encap_one_inline (ngm, b[0], t0, &next0, is_ip4_0);
344 /* Reset to look up tunnel partner in the configured FIB */
345 vnet_buffer (b[0])->sw_if_index[VLIB_TX] = t0->encap_fib_index;
346 vnet_buffer (b[0])->sw_if_index[VLIB_RX] = sw_if_index0;
349 len0 = vlib_buffer_length_in_chain (vm, b[0]);
350 stats_n_packets += 1;
351 stats_n_bytes += len0;
353 /* Batch stats increment on the same vxlan tunnel so counter is not
354 * incremented per packet. Note stats are still incremented for deleted
355 * and admin-down tunnel where packets are dropped. It is not worthwhile
356 * to check for this rare case and affect normal path performance. */
357 if (PREDICT_FALSE (sw_if_index0 != stats_sw_if_index))
359 stats_n_packets -= 1;
360 stats_n_bytes -= len0;
362 vlib_increment_combined_counter (im->combined_sw_if_counters +
363 VNET_INTERFACE_COUNTER_TX,
369 stats_n_bytes = len0;
370 stats_sw_if_index = sw_if_index0;
372 if (PREDICT_FALSE (b[0]->flags & VLIB_BUFFER_IS_TRACED))
374 vxlan_gpe_encap_trace_t *tr = vlib_add_trace (vm, node, b[0],
376 tr->tunnel_index = t0 - ngm->tunnels;
380 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
381 n_left_to_next, bi0, next0);
384 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
386 vlib_node_increment_counter (vm, node->node_index,
387 VXLAN_GPE_ENCAP_ERROR_ENCAPSULATED,
389 /* Increment any remaining batch stats */
392 vlib_increment_combined_counter (im->combined_sw_if_counters +
393 VNET_INTERFACE_COUNTER_TX,
394 thread_index, stats_sw_if_index,
395 stats_n_packets, stats_n_bytes);
396 node->runtime_data[0] = stats_sw_if_index;
399 return from_frame->n_vectors;
403 VLIB_REGISTER_NODE (vxlan_gpe_encap_node) = {
404 .function = vxlan_gpe_encap,
405 .name = "vxlan-gpe-encap",
406 .vector_size = sizeof (u32),
407 .format_trace = format_vxlan_gpe_encap_trace,
408 .type = VLIB_NODE_TYPE_INTERNAL,
410 .n_errors = ARRAY_LEN(vxlan_gpe_encap_error_strings),
411 .error_strings = vxlan_gpe_encap_error_strings,
413 .n_next_nodes = VXLAN_GPE_ENCAP_N_NEXT,
416 [VXLAN_GPE_ENCAP_NEXT_IP4_LOOKUP] = "ip4-lookup",
417 [VXLAN_GPE_ENCAP_NEXT_IP6_LOOKUP] = "ip6-lookup",
418 [VXLAN_GPE_ENCAP_NEXT_DROP] = "error-drop",
425 * fd.io coding-style-patch-verification: ON
428 * eval: (c-set-style "gnu")