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/vxlan-gpe/vxlan_gpe.h>
27 /** Statistics (not really errors) */
28 #define foreach_vxlan_gpe_encap_error \
29 _(ENCAPSULATED, "good packets encapsulated")
32 * @brief VXLAN GPE encap error strings
34 static char *vxlan_gpe_encap_error_strings[] = {
35 #define _(sym,string) string,
36 foreach_vxlan_gpe_encap_error
41 * @brief Struct for VXLAN GPE errors/counters
45 #define _(sym,str) VXLAN_GPE_ENCAP_ERROR_##sym,
46 foreach_vxlan_gpe_encap_error
48 VXLAN_GPE_ENCAP_N_ERROR,
49 } vxlan_gpe_encap_error_t;
52 * @brief Struct for tracing VXLAN GPE encapsulated packets
57 } vxlan_gpe_encap_trace_t;
60 * @brief Trace of packets encapsulated in VXLAN GPE
69 format_vxlan_gpe_encap_trace (u8 * s, va_list * args)
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 *);
75 s = format (s, "VXLAN-GPE-ENCAP: tunnel %d", t->tunnel_index);
80 * @brief Instantiates UDP + VXLAN-GPE header then set next node to IP4|6 lookup
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)
90 vxlan_gpe_encap_one_inline (vxlan_gpe_main_t * ngm, vlib_buffer_t * b0,
91 vxlan_gpe_tunnel_t * t0, u32 * next0, u8 is_v4)
93 ASSERT (sizeof (ip4_vxlan_gpe_header_t) == 36);
94 ASSERT (sizeof (ip6_vxlan_gpe_header_t) == 56);
96 ip_udp_encap_one (ngm->vlib_main, b0, t0->rewrite, t0->rewrite_size, is_v4);
97 next0[0] = t0->encap_next_node;
101 * @brief Instantiates UDP + VXLAN-GPE header then set next node to IP4|6 lookup for two packets
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)
114 vxlan_gpe_encap_two_inline (vxlan_gpe_main_t * ngm, vlib_buffer_t * b0,
115 vlib_buffer_t * b1, vxlan_gpe_tunnel_t * t0,
116 vxlan_gpe_tunnel_t * t1, u32 * next0,
117 u32 * next1, u8 is_v4)
119 ASSERT (sizeof (ip4_vxlan_gpe_header_t) == 36);
120 ASSERT (sizeof (ip6_vxlan_gpe_header_t) == 56);
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;
128 * @brief Common processing for IPv4 and IPv6 VXLAN GPE encap dispatch functions
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.
135 * vnet_buffer(b0)->sw_if_index[VLIB_TX] = t0->encap_fib_index;
137 * @node vxlan-gpe-input
142 * @return from_frame->n_vectors
146 vxlan_gpe_encap (vlib_main_t * vm,
147 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
149 u32 n_left_from, next_index, *from, *to_next;
150 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
151 vnet_main_t *vnm = ngm->vnet_main;
152 vnet_interface_main_t *im = &vnm->interface_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;
157 from = vlib_frame_vector_args (from_frame);
158 n_left_from = from_frame->n_vectors;
160 next_index = node->cached_next_index;
161 stats_sw_if_index = node->runtime_data[0];
162 stats_n_packets = stats_n_bytes = 0;
164 while (n_left_from > 0)
167 u32 sw_if_index0 = ~0, sw_if_index1 = ~0, len0, len1;
168 vnet_hw_interface_t *hi0, *hi1;
169 vxlan_gpe_tunnel_t *t0 = NULL, *t1 = NULL;
170 u8 is_ip4_0 = 0, is_ip4_1 = 0;
172 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
174 while (n_left_from >= 4 && n_left_to_next >= 2)
177 vlib_buffer_t *b0, *b1;
180 next0 = next1 = VXLAN_GPE_ENCAP_NEXT_IP4_LOOKUP;
182 /* Prefetch next iteration. */
184 vlib_buffer_t *p2, *p3;
186 p2 = vlib_get_buffer (vm, from[2]);
187 p3 = vlib_get_buffer (vm, from[3]);
189 vlib_prefetch_buffer_header (p2, LOAD);
190 vlib_prefetch_buffer_header (p3, LOAD);
192 CLIB_PREFETCH (p2->data, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
193 CLIB_PREFETCH (p3->data, 2 * CLIB_CACHE_LINE_BYTES, LOAD);
205 b0 = vlib_get_buffer (vm, bi0);
206 b1 = vlib_get_buffer (vm, bi1);
208 /* get the flag "is_ip4" */
209 if (sw_if_index0 != vnet_buffer (b0)->sw_if_index[VLIB_TX])
211 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
213 vnet_get_sup_hw_interface (vnm,
214 vnet_buffer (b0)->sw_if_index
216 t0 = pool_elt_at_index (ngm->tunnels, hi0->dev_instance);
217 is_ip4_0 = (t0->flags & VXLAN_GPE_TUNNEL_IS_IPV4);
220 /* get the flag "is_ip4" */
221 if (sw_if_index1 != vnet_buffer (b1)->sw_if_index[VLIB_TX])
223 if (sw_if_index0 == vnet_buffer (b1)->sw_if_index[VLIB_TX])
225 sw_if_index1 = sw_if_index0;
232 sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_TX];
234 vnet_get_sup_hw_interface (vnm,
235 vnet_buffer (b1)->sw_if_index
237 t1 = pool_elt_at_index (ngm->tunnels, hi1->dev_instance);
238 is_ip4_1 = (t1->flags & VXLAN_GPE_TUNNEL_IS_IPV4);
242 if (PREDICT_TRUE (is_ip4_0 == is_ip4_1))
244 vxlan_gpe_encap_two_inline (ngm, b0, b1, t0, t1, &next0, &next1,
249 vxlan_gpe_encap_one_inline (ngm, b0, t0, &next0, is_ip4_0);
250 vxlan_gpe_encap_one_inline (ngm, b1, t1, &next1, is_ip4_1);
253 /* Reset to look up tunnel partner in the configured FIB */
254 vnet_buffer (b0)->sw_if_index[VLIB_TX] = t0->encap_fib_index;
255 vnet_buffer (b1)->sw_if_index[VLIB_TX] = t1->encap_fib_index;
256 vnet_buffer (b0)->sw_if_index[VLIB_RX] = sw_if_index0;
257 vnet_buffer (b1)->sw_if_index[VLIB_RX] = sw_if_index1;
258 pkts_encapsulated += 2;
260 len0 = vlib_buffer_length_in_chain (vm, b0);
261 len1 = vlib_buffer_length_in_chain (vm, b1);
262 stats_n_packets += 2;
263 stats_n_bytes += len0 + len1;
265 /* Batch stats increment on the same vxlan tunnel so counter is not
266 incremented per packet. Note stats are still incremented for deleted
267 and admin-down tunnel where packets are dropped. It is not worthwhile
268 to check for this rare case and affect normal path performance. */
269 if (PREDICT_FALSE ((sw_if_index0 != stats_sw_if_index)
270 || (sw_if_index1 != stats_sw_if_index)))
272 stats_n_packets -= 2;
273 stats_n_bytes -= len0 + len1;
274 if (sw_if_index0 == sw_if_index1)
277 vlib_increment_combined_counter
278 (im->combined_sw_if_counters +
279 VNET_INTERFACE_COUNTER_TX, thread_index,
280 stats_sw_if_index, stats_n_packets, stats_n_bytes);
281 stats_sw_if_index = sw_if_index0;
283 stats_n_bytes = len0 + len1;
287 vlib_increment_combined_counter (im->combined_sw_if_counters
289 VNET_INTERFACE_COUNTER_TX,
290 thread_index, sw_if_index0,
292 vlib_increment_combined_counter (im->combined_sw_if_counters
294 VNET_INTERFACE_COUNTER_TX,
295 thread_index, sw_if_index1,
300 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
302 vxlan_gpe_encap_trace_t *tr =
303 vlib_add_trace (vm, node, b0, sizeof (*tr));
304 tr->tunnel_index = t0 - ngm->tunnels;
307 if (PREDICT_FALSE (b1->flags & VLIB_BUFFER_IS_TRACED))
309 vxlan_gpe_encap_trace_t *tr = vlib_add_trace (vm, node, b1,
311 tr->tunnel_index = t1 - ngm->tunnels;
314 vlib_validate_buffer_enqueue_x2 (vm, node, next_index, to_next,
315 n_left_to_next, bi0, bi1, next0,
319 while (n_left_from > 0 && n_left_to_next > 0)
323 u32 next0 = VXLAN_GPE_ENCAP_NEXT_IP4_LOOKUP;
332 b0 = vlib_get_buffer (vm, bi0);
334 /* get the flag "is_ip4" */
335 if (sw_if_index0 != vnet_buffer (b0)->sw_if_index[VLIB_TX])
337 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
339 vnet_get_sup_hw_interface (vnm,
340 vnet_buffer (b0)->sw_if_index
343 t0 = pool_elt_at_index (ngm->tunnels, hi0->dev_instance);
345 is_ip4_0 = (t0->flags & VXLAN_GPE_TUNNEL_IS_IPV4);
348 vxlan_gpe_encap_one_inline (ngm, b0, t0, &next0, is_ip4_0);
350 /* Reset to look up tunnel partner in the configured FIB */
351 vnet_buffer (b0)->sw_if_index[VLIB_TX] = t0->encap_fib_index;
352 vnet_buffer (b0)->sw_if_index[VLIB_RX] = sw_if_index0;
355 len0 = vlib_buffer_length_in_chain (vm, b0);
356 stats_n_packets += 1;
357 stats_n_bytes += len0;
359 /* Batch stats increment on the same vxlan tunnel so counter is not
360 * incremented per packet. Note stats are still incremented for deleted
361 * and admin-down tunnel where packets are dropped. It is not worthwhile
362 * to check for this rare case and affect normal path performance. */
363 if (PREDICT_FALSE (sw_if_index0 != stats_sw_if_index))
365 stats_n_packets -= 1;
366 stats_n_bytes -= len0;
368 vlib_increment_combined_counter (im->combined_sw_if_counters +
369 VNET_INTERFACE_COUNTER_TX,
375 stats_n_bytes = len0;
376 stats_sw_if_index = sw_if_index0;
378 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
380 vxlan_gpe_encap_trace_t *tr = vlib_add_trace (vm, node, b0,
382 tr->tunnel_index = t0 - ngm->tunnels;
384 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
385 n_left_to_next, bi0, next0);
388 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
390 vlib_node_increment_counter (vm, node->node_index,
391 VXLAN_GPE_ENCAP_ERROR_ENCAPSULATED,
393 /* Increment any remaining batch stats */
396 vlib_increment_combined_counter (im->combined_sw_if_counters +
397 VNET_INTERFACE_COUNTER_TX,
398 thread_index, stats_sw_if_index,
399 stats_n_packets, stats_n_bytes);
400 node->runtime_data[0] = stats_sw_if_index;
403 return from_frame->n_vectors;
407 VLIB_REGISTER_NODE (vxlan_gpe_encap_node) = {
408 .function = vxlan_gpe_encap,
409 .name = "vxlan-gpe-encap",
410 .vector_size = sizeof (u32),
411 .format_trace = format_vxlan_gpe_encap_trace,
412 .type = VLIB_NODE_TYPE_INTERNAL,
414 .n_errors = ARRAY_LEN(vxlan_gpe_encap_error_strings),
415 .error_strings = vxlan_gpe_encap_error_strings,
417 .n_next_nodes = VXLAN_GPE_ENCAP_N_NEXT,
420 [VXLAN_GPE_ENCAP_NEXT_IP4_LOOKUP] = "ip4-lookup",
421 [VXLAN_GPE_ENCAP_NEXT_IP6_LOOKUP] = "ip6-lookup",
422 [VXLAN_GPE_ENCAP_NEXT_DROP] = "error-drop",
429 * fd.io coding-style-patch-verification: ON
432 * eval: (c-set-style "gnu")