3 * Copyright (c) 2015 Cisco 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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #include <vppinfra/error.h>
17 #include <vppinfra/hash.h>
18 #include <vnet/vnet.h>
19 #include <vnet/ip/ip.h>
20 #include <vnet/ethernet/ethernet.h>
21 #include <vnet/interface_output.h>
22 #include <vnet/vxlan/vxlan.h>
23 #include <vnet/qos/qos_types.h>
24 #include <vnet/adj/rewrite.h>
26 /* Statistics (not all errors) */
27 #define foreach_vxlan_encap_error \
28 _(ENCAPSULATED, "good packets encapsulated")
30 static char *vxlan_encap_error_strings[] = {
31 #define _(sym,string) string,
32 foreach_vxlan_encap_error
38 #define _(sym,str) VXLAN_ENCAP_ERROR_##sym,
39 foreach_vxlan_encap_error
42 } vxlan_encap_error_t;
46 VXLAN_ENCAP_NEXT_DROP,
54 } vxlan_encap_trace_t;
56 #ifndef CLIB_MARCH_VARIANT
58 format_vxlan_encap_trace (u8 * s, va_list * args)
60 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
61 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
62 vxlan_encap_trace_t *t = va_arg (*args, vxlan_encap_trace_t *);
64 s = format (s, "VXLAN encap to vxlan_tunnel%d vni %d",
65 t->tunnel_index, t->vni);
71 vxlan_encap_inline (vlib_main_t * vm,
72 vlib_node_runtime_t * node,
73 vlib_frame_t * from_frame, u8 is_ip4, u8 csum_offload)
75 u32 n_left_from, next_index, *from, *to_next;
76 vxlan_main_t *vxm = &vxlan_main;
77 vnet_main_t *vnm = vxm->vnet_main;
78 vnet_interface_main_t *im = &vnm->interface_main;
79 vlib_combined_counter_main_t *tx_counter =
80 im->combined_sw_if_counters + VNET_INTERFACE_COUNTER_TX;
81 u32 pkts_encapsulated = 0;
82 u32 thread_index = vlib_get_thread_index ();
83 u32 sw_if_index0 = 0, sw_if_index1 = 0;
84 u32 next0 = 0, next1 = 0;
85 vxlan_tunnel_t *t0 = NULL, *t1 = NULL;
86 index_t dpoi_idx0 = INDEX_INVALID, dpoi_idx1 = INDEX_INVALID;
87 vlib_buffer_t *bufs[VLIB_FRAME_SIZE];
88 vlib_buffer_t **b = bufs;
90 from = vlib_frame_vector_args (from_frame);
91 n_left_from = from_frame->n_vectors;
93 next_index = node->cached_next_index;
95 STATIC_ASSERT_SIZEOF (ip6_vxlan_header_t, 56);
96 STATIC_ASSERT_SIZEOF (ip4_vxlan_header_t, 36);
98 u8 const underlay_hdr_len = is_ip4 ?
99 sizeof (ip4_vxlan_header_t) : sizeof (ip6_vxlan_header_t);
100 u16 const l3_len = is_ip4 ? sizeof (ip4_header_t) : sizeof (ip6_header_t);
101 u32 const csum_flags =
102 is_ip4 ? VNET_BUFFER_F_IS_IP4 | VNET_BUFFER_F_L3_HDR_OFFSET_VALID |
103 VNET_BUFFER_F_L4_HDR_OFFSET_VALID :
104 VNET_BUFFER_F_IS_IP6 | VNET_BUFFER_F_L3_HDR_OFFSET_VALID |
105 VNET_BUFFER_F_L4_HDR_OFFSET_VALID;
106 u32 const outer_packet_csum_offload_flags =
107 is_ip4 ? VNET_BUFFER_OFFLOAD_F_IP_CKSUM | VNET_BUFFER_OFFLOAD_F_UDP_CKSUM :
108 VNET_BUFFER_OFFLOAD_F_UDP_CKSUM;
109 u32 const inner_packet_removed_flags =
110 VNET_BUFFER_F_IS_IP4 | VNET_BUFFER_F_IS_IP6 |
111 VNET_BUFFER_F_L2_HDR_OFFSET_VALID | VNET_BUFFER_F_L3_HDR_OFFSET_VALID |
112 VNET_BUFFER_F_L4_HDR_OFFSET_VALID;
114 vlib_get_buffers (vm, from, bufs, n_left_from);
116 while (n_left_from > 0)
120 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
122 while (n_left_from >= 4 && n_left_to_next >= 2)
124 /* Prefetch next iteration. */
126 vlib_prefetch_buffer_header (b[2], LOAD);
127 vlib_prefetch_buffer_header (b[3], LOAD);
129 CLIB_PREFETCH (b[2]->data - CLIB_CACHE_LINE_BYTES,
130 2 * CLIB_CACHE_LINE_BYTES, LOAD);
131 CLIB_PREFETCH (b[3]->data - CLIB_CACHE_LINE_BYTES,
132 2 * CLIB_CACHE_LINE_BYTES, LOAD);
135 u32 bi0 = to_next[0] = from[0];
136 u32 bi1 = to_next[1] = from[1];
142 vlib_buffer_t *b0 = b[0];
143 vlib_buffer_t *b1 = b[1];
146 u32 or_flags = b0->flags | b1->flags;
147 if (csum_offload && (or_flags & VNET_BUFFER_F_OFFLOAD))
149 /* Only calculate the non-GSO packet csum offload */
150 if ((b0->flags & VNET_BUFFER_F_GSO) == 0)
152 vnet_calc_checksums_inline (vm, b0,
154 VNET_BUFFER_F_IS_IP4,
156 VNET_BUFFER_F_IS_IP6);
157 b0->flags &= ~inner_packet_removed_flags;
159 if ((b1->flags & VNET_BUFFER_F_GSO) == 0)
161 vnet_calc_checksums_inline (vm, b1,
163 VNET_BUFFER_F_IS_IP4,
165 VNET_BUFFER_F_IS_IP6);
166 b1->flags &= ~inner_packet_removed_flags;
170 u32 flow_hash0 = vnet_l2_compute_flow_hash (b0);
171 u32 flow_hash1 = vnet_l2_compute_flow_hash (b1);
173 /* Get next node index and adj index from tunnel next_dpo */
174 if (sw_if_index0 != vnet_buffer (b0)->sw_if_index[VLIB_TX])
176 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
177 vnet_hw_interface_t *hi0 =
178 vnet_get_sup_hw_interface (vnm, sw_if_index0);
179 t0 = &vxm->tunnels[hi0->dev_instance];
180 /* Note: change to always set next0 if it may set to drop */
181 next0 = t0->next_dpo.dpoi_next_node;
182 dpoi_idx0 = t0->next_dpo.dpoi_index;
185 /* Get next node index and adj index from tunnel next_dpo */
186 if (sw_if_index1 != vnet_buffer (b1)->sw_if_index[VLIB_TX])
188 if (sw_if_index0 == vnet_buffer (b1)->sw_if_index[VLIB_TX])
190 sw_if_index1 = sw_if_index0;
193 dpoi_idx1 = dpoi_idx0;
197 sw_if_index1 = vnet_buffer (b1)->sw_if_index[VLIB_TX];
198 vnet_hw_interface_t *hi1 =
199 vnet_get_sup_hw_interface (vnm, sw_if_index1);
200 t1 = &vxm->tunnels[hi1->dev_instance];
201 /* Note: change to always set next1 if it may set to drop */
202 next1 = t1->next_dpo.dpoi_next_node;
203 dpoi_idx1 = t1->next_dpo.dpoi_index;
207 vnet_buffer (b0)->ip.adj_index[VLIB_TX] = dpoi_idx0;
208 vnet_buffer (b1)->ip.adj_index[VLIB_TX] = dpoi_idx1;
210 ASSERT (t0->rewrite_header.data_bytes == underlay_hdr_len);
211 ASSERT (t1->rewrite_header.data_bytes == underlay_hdr_len);
212 vnet_rewrite_two_headers (*t0, *t1, vlib_buffer_get_current (b0),
213 vlib_buffer_get_current (b1),
216 vlib_buffer_advance (b0, -underlay_hdr_len);
217 vlib_buffer_advance (b1, -underlay_hdr_len);
219 u32 len0 = vlib_buffer_length_in_chain (vm, b0);
220 u32 len1 = vlib_buffer_length_in_chain (vm, b1);
221 u16 payload_l0 = clib_host_to_net_u16 (len0 - l3_len);
222 u16 payload_l1 = clib_host_to_net_u16 (len1 - l3_len);
224 void *underlay0 = vlib_buffer_get_current (b0);
225 void *underlay1 = vlib_buffer_get_current (b1);
227 ip4_header_t *ip4_0, *ip4_1;
228 qos_bits_t ip4_0_tos = 0, ip4_1_tos = 0;
229 ip6_header_t *ip6_0, *ip6_1;
230 udp_header_t *udp0, *udp1;
234 ip4_vxlan_header_t *hdr0 = underlay0;
235 ip4_vxlan_header_t *hdr1 = underlay1;
237 /* Fix the IP4 checksum and length */
240 ip4_0->length = clib_host_to_net_u16 (len0);
241 ip4_1->length = clib_host_to_net_u16 (len1);
243 if (PREDICT_FALSE (b0->flags & VNET_BUFFER_F_QOS_DATA_VALID))
245 ip4_0_tos = vnet_buffer2 (b0)->qos.bits;
246 ip4_0->tos = ip4_0_tos;
248 if (PREDICT_FALSE (b1->flags & VNET_BUFFER_F_QOS_DATA_VALID))
250 ip4_1_tos = vnet_buffer2 (b1)->qos.bits;
251 ip4_1->tos = ip4_1_tos;
261 ip6_vxlan_header_t *hdr0 = underlay0;
262 ip6_vxlan_header_t *hdr1 = underlay1;
264 /* Fix IP6 payload length */
267 ip6_0->payload_length = payload_l0;
268 ip6_1->payload_length = payload_l1;
276 /* Fix UDP length and set source port */
277 udp0->length = payload_l0;
278 udp0->src_port = flow_hash0;
279 udp1->length = payload_l1;
280 udp1->src_port = flow_hash1;
284 b0->flags |= csum_flags;
285 vnet_buffer (b0)->l3_hdr_offset = l3_0 - b0->data;
286 vnet_buffer (b0)->l4_hdr_offset = (u8 *) udp0 - b0->data;
287 vnet_buffer_offload_flags_set (b0,
288 outer_packet_csum_offload_flags);
289 b1->flags |= csum_flags;
290 vnet_buffer (b1)->l3_hdr_offset = l3_1 - b1->data;
291 vnet_buffer (b1)->l4_hdr_offset = (u8 *) udp1 - b1->data;
292 vnet_buffer_offload_flags_set (b1,
293 outer_packet_csum_offload_flags);
295 /* IPv4 UDP checksum only if checksum offload is used */
298 ip_csum_t sum0 = ip4_0->checksum;
299 sum0 = ip_csum_update (sum0, 0, ip4_0->length, ip4_header_t,
300 length /* changed member */ );
301 if (PREDICT_FALSE (ip4_0_tos))
303 sum0 = ip_csum_update (sum0, 0, ip4_0_tos, ip4_header_t,
304 tos /* changed member */ );
306 ip4_0->checksum = ip_csum_fold (sum0);
307 ip_csum_t sum1 = ip4_1->checksum;
308 sum1 = ip_csum_update (sum1, 0, ip4_1->length, ip4_header_t,
309 length /* changed member */ );
310 if (PREDICT_FALSE (ip4_1_tos))
312 sum1 = ip_csum_update (sum1, 0, ip4_1_tos, ip4_header_t,
313 tos /* changed member */ );
315 ip4_1->checksum = ip_csum_fold (sum1);
317 /* IPv6 UDP checksum is mandatory */
322 udp0->checksum = ip6_tcp_udp_icmp_compute_checksum
323 (vm, b0, ip6_0, &bogus);
325 if (udp0->checksum == 0)
326 udp0->checksum = 0xffff;
327 udp1->checksum = ip6_tcp_udp_icmp_compute_checksum
328 (vm, b1, ip6_1, &bogus);
330 if (udp1->checksum == 0)
331 udp1->checksum = 0xffff;
334 /* save inner packet flow_hash for load-balance node */
335 vnet_buffer (b0)->ip.flow_hash = flow_hash0;
336 vnet_buffer (b1)->ip.flow_hash = flow_hash1;
338 if (sw_if_index0 == sw_if_index1)
340 vlib_increment_combined_counter (tx_counter, thread_index,
341 sw_if_index0, 2, len0 + len1);
345 vlib_increment_combined_counter (tx_counter, thread_index,
346 sw_if_index0, 1, len0);
347 vlib_increment_combined_counter (tx_counter, thread_index,
348 sw_if_index1, 1, len1);
350 pkts_encapsulated += 2;
352 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
354 vxlan_encap_trace_t *tr =
355 vlib_add_trace (vm, node, b0, sizeof (*tr));
356 tr->tunnel_index = t0 - vxm->tunnels;
360 if (PREDICT_FALSE (b1->flags & VLIB_BUFFER_IS_TRACED))
362 vxlan_encap_trace_t *tr =
363 vlib_add_trace (vm, node, b1, sizeof (*tr));
364 tr->tunnel_index = t1 - vxm->tunnels;
368 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
369 to_next, n_left_to_next,
370 bi0, bi1, next0, next1);
373 while (n_left_from > 0 && n_left_to_next > 0)
375 u32 bi0 = to_next[0] = from[0];
381 vlib_buffer_t *b0 = b[0];
384 if (csum_offload && (b0->flags & VNET_BUFFER_F_OFFLOAD))
386 /* Only calculate the non-GSO packet csum offload */
387 if ((b0->flags & VNET_BUFFER_F_GSO) == 0)
389 vnet_calc_checksums_inline (vm, b0,
391 VNET_BUFFER_F_IS_IP4,
393 VNET_BUFFER_F_IS_IP6);
394 b0->flags &= ~inner_packet_removed_flags;
398 u32 flow_hash0 = vnet_l2_compute_flow_hash (b0);
400 /* Get next node index and adj index from tunnel next_dpo */
401 if (sw_if_index0 != vnet_buffer (b0)->sw_if_index[VLIB_TX])
403 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_TX];
404 vnet_hw_interface_t *hi0 =
405 vnet_get_sup_hw_interface (vnm, sw_if_index0);
406 t0 = &vxm->tunnels[hi0->dev_instance];
407 /* Note: change to always set next0 if it may be set to drop */
408 next0 = t0->next_dpo.dpoi_next_node;
409 dpoi_idx0 = t0->next_dpo.dpoi_index;
411 vnet_buffer (b0)->ip.adj_index[VLIB_TX] = dpoi_idx0;
413 ASSERT (t0->rewrite_header.data_bytes == underlay_hdr_len);
414 vnet_rewrite_one_header (*t0, vlib_buffer_get_current (b0),
417 vlib_buffer_advance (b0, -underlay_hdr_len);
418 void *underlay0 = vlib_buffer_get_current (b0);
420 u32 len0 = vlib_buffer_length_in_chain (vm, b0);
421 u16 payload_l0 = clib_host_to_net_u16 (len0 - l3_len);
425 qos_bits_t ip4_0_tos = 0;
430 ip4_vxlan_header_t *hdr = underlay0;
432 /* Fix the IP4 checksum and length */
434 ip4_0->length = clib_host_to_net_u16 (len0);
436 if (PREDICT_FALSE (b0->flags & VNET_BUFFER_F_QOS_DATA_VALID))
438 ip4_0_tos = vnet_buffer2 (b0)->qos.bits;
439 ip4_0->tos = ip4_0_tos;
447 ip6_vxlan_header_t *hdr = underlay0;
449 /* Fix IP6 payload length */
451 ip6_0->payload_length = payload_l0;
457 /* Fix UDP length and set source port */
458 udp0->length = payload_l0;
459 udp0->src_port = flow_hash0;
463 b0->flags |= csum_flags;
464 vnet_buffer (b0)->l3_hdr_offset = l3_0 - b0->data;
465 vnet_buffer (b0)->l4_hdr_offset = (u8 *) udp0 - b0->data;
466 vnet_buffer_offload_flags_set (b0,
467 outer_packet_csum_offload_flags);
469 /* IPv4 UDP checksum only if checksum offload is used */
472 ip_csum_t sum0 = ip4_0->checksum;
473 sum0 = ip_csum_update (sum0, 0, ip4_0->length, ip4_header_t,
474 length /* changed member */ );
475 if (PREDICT_FALSE (ip4_0_tos))
477 sum0 = ip_csum_update (sum0, 0, ip4_0_tos, ip4_header_t,
478 tos /* changed member */ );
480 ip4_0->checksum = ip_csum_fold (sum0);
482 /* IPv6 UDP checksum is mandatory */
487 udp0->checksum = ip6_tcp_udp_icmp_compute_checksum
488 (vm, b0, ip6_0, &bogus);
490 if (udp0->checksum == 0)
491 udp0->checksum = 0xffff;
494 /* reuse inner packet flow_hash for load-balance node */
495 vnet_buffer (b0)->ip.flow_hash = flow_hash0;
497 vlib_increment_combined_counter (tx_counter, thread_index,
498 sw_if_index0, 1, len0);
501 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
503 vxlan_encap_trace_t *tr =
504 vlib_add_trace (vm, node, b0, sizeof (*tr));
505 tr->tunnel_index = t0 - vxm->tunnels;
508 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
509 to_next, n_left_to_next,
513 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
516 /* Do we still need this now that tunnel tx stats is kept? */
517 vlib_node_increment_counter (vm, node->node_index,
518 VXLAN_ENCAP_ERROR_ENCAPSULATED,
521 return from_frame->n_vectors;
524 VLIB_NODE_FN (vxlan4_encap_node) (vlib_main_t * vm,
525 vlib_node_runtime_t * node,
526 vlib_frame_t * from_frame)
528 /* Disable chksum offload as setup overhead in tx node is not worthwhile
529 for ip4 header checksum only, unless udp checksum is also required */
530 return vxlan_encap_inline (vm, node, from_frame, /* is_ip4 */ 1,
531 /* csum_offload */ 0);
534 VLIB_NODE_FN (vxlan6_encap_node) (vlib_main_t * vm,
535 vlib_node_runtime_t * node,
536 vlib_frame_t * from_frame)
538 /* Enable checksum offload for ip6 as udp checksum is mandatory, */
539 return vxlan_encap_inline (vm, node, from_frame, /* is_ip4 */ 0,
540 /* csum_offload */ 1);
544 VLIB_REGISTER_NODE (vxlan4_encap_node) = {
545 .name = "vxlan4-encap",
546 .vector_size = sizeof (u32),
547 .format_trace = format_vxlan_encap_trace,
548 .type = VLIB_NODE_TYPE_INTERNAL,
549 .n_errors = ARRAY_LEN(vxlan_encap_error_strings),
550 .error_strings = vxlan_encap_error_strings,
551 .n_next_nodes = VXLAN_ENCAP_N_NEXT,
553 [VXLAN_ENCAP_NEXT_DROP] = "error-drop",
557 VLIB_REGISTER_NODE (vxlan6_encap_node) = {
558 .name = "vxlan6-encap",
559 .vector_size = sizeof (u32),
560 .format_trace = format_vxlan_encap_trace,
561 .type = VLIB_NODE_TYPE_INTERNAL,
562 .n_errors = ARRAY_LEN(vxlan_encap_error_strings),
563 .error_strings = vxlan_encap_error_strings,
564 .n_next_nodes = VXLAN_ENCAP_N_NEXT,
566 [VXLAN_ENCAP_NEXT_DROP] = "error-drop",
572 * fd.io coding-style-patch-verification: ON
575 * eval: (c-set-style "gnu")