2 * Copyright (c) 2018 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.
16 #include <vlib/vlib.h>
17 #include <vnet/vnet.h>
18 #include <vppinfra/error.h>
19 #include <vnet/ethernet/ethernet.h>
20 #include <vnet/feature/feature.h>
21 #include <vnet/gso/gso.h>
22 #include <vnet/ip/icmp46_packet.h>
23 #include <vnet/ip/ip4.h>
24 #include <vnet/ip/ip6.h>
25 #include <vnet/udp/udp_packet.h>
35 format_gso_trace (u8 * s, va_list * args)
37 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
38 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
39 gso_trace_t *t = va_arg (*args, gso_trace_t *);
41 if (t->flags & VNET_BUFFER_F_GSO)
43 s = format (s, "gso_sz %d gso_l4_hdr_sz %d",
44 t->gso_size, t->gso_l4_hdr_sz);
48 s = format (s, "non-gso buffer");
54 static_always_inline u16
55 tso_alloc_tx_bufs (vlib_main_t * vm,
56 vnet_interface_per_thread_data_t * ptd,
57 vlib_buffer_t * b0, u32 n_bytes_b0, u16 l234_sz,
58 u16 gso_size, gso_header_offset_t * gho)
61 clib_min (gso_size, vlib_buffer_get_default_data_size (vm) - l234_sz
62 - gho->l2_hdr_offset);
64 /* rounded-up division */
65 u16 n_bufs = (n_bytes_b0 - l234_sz + (size - 1)) / size;
69 vec_validate (ptd->split_buffers, n_bufs - 1);
71 n_alloc = vlib_buffer_alloc (vm, ptd->split_buffers, n_bufs);
74 vlib_buffer_free (vm, ptd->split_buffers, n_alloc);
80 static_always_inline void
81 tso_init_buf_from_template_base (vlib_buffer_t * nb0, vlib_buffer_t * b0,
82 u32 flags, u16 length)
84 nb0->current_data = b0->current_data;
85 nb0->total_length_not_including_first_buffer = 0;
86 nb0->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID | flags;
87 nb0->trace_handle = b0->trace_handle;
88 clib_memcpy_fast (&nb0->opaque, &b0->opaque, sizeof (nb0->opaque));
89 clib_memcpy_fast (vlib_buffer_get_current (nb0),
90 vlib_buffer_get_current (b0), length);
91 nb0->current_length = length;
94 static_always_inline void
95 tso_init_buf_from_template (vlib_main_t * vm, vlib_buffer_t * nb0,
96 vlib_buffer_t * b0, u16 template_data_sz,
97 u16 gso_size, u8 ** p_dst_ptr, u16 * p_dst_left,
98 u32 next_tcp_seq, u32 flags,
99 gso_header_offset_t * gho)
101 tso_init_buf_from_template_base (nb0, b0, flags, template_data_sz);
105 vlib_buffer_get_default_data_size (vm) - (template_data_sz +
107 *p_dst_ptr = vlib_buffer_get_current (nb0) + template_data_sz;
110 (tcp_header_t *) (vlib_buffer_get_current (nb0) + gho->l4_hdr_offset);
111 tcp->seq_number = clib_host_to_net_u32 (next_tcp_seq);
114 static_always_inline void
115 tso_fixup_segmented_buf (vlib_buffer_t * b0, u8 tcp_flags, int is_ip6,
116 gso_header_offset_t * gho)
119 (ip4_header_t *) (vlib_buffer_get_current (b0) + gho->l3_hdr_offset);
121 (ip6_header_t *) (vlib_buffer_get_current (b0) + gho->l3_hdr_offset);
123 (tcp_header_t *) (vlib_buffer_get_current (b0) + gho->l4_hdr_offset);
125 tcp->flags = tcp_flags;
128 ip6->payload_length =
129 clib_host_to_net_u16 (b0->current_length -
130 (gho->l4_hdr_offset - gho->l2_hdr_offset));
133 clib_host_to_net_u16 (b0->current_length -
134 (gho->l3_hdr_offset - gho->l2_hdr_offset));
138 * Allocate the necessary number of ptd->split_buffers,
139 * and segment the possibly chained buffer(s) from b0 into
142 * Return the cumulative number of bytes sent or zero
143 * if allocation failed.
146 static_always_inline u32
147 tso_segment_buffer (vlib_main_t * vm, vnet_interface_per_thread_data_t * ptd,
148 u32 sbi0, vlib_buffer_t * sb0, gso_header_offset_t * gho,
149 u32 n_bytes_b0, int is_ip6)
152 u16 gso_size = vnet_buffer2 (sb0)->gso_size;
154 int l4_hdr_sz = gho->l4_hdr_sz;
155 u8 save_tcp_flags = 0;
156 u8 tcp_flags_no_fin_psh = 0;
157 u32 next_tcp_seq = 0;
160 (tcp_header_t *) (vlib_buffer_get_current (sb0) + gho->l4_hdr_offset);
161 next_tcp_seq = clib_net_to_host_u32 (tcp->seq_number);
162 /* store original flags for last packet and reset FIN and PSH */
163 save_tcp_flags = tcp->flags;
164 tcp_flags_no_fin_psh = tcp->flags & ~(TCP_FLAG_FIN | TCP_FLAG_PSH);
168 sb0->flags & ~(VNET_BUFFER_F_GSO | VLIB_BUFFER_NEXT_PRESENT);
169 u16 l234_sz = gho->l4_hdr_offset + l4_hdr_sz - gho->l2_hdr_offset;
170 int first_data_size = clib_min (gso_size, sb0->current_length - l234_sz);
171 next_tcp_seq += first_data_size;
174 (!tso_alloc_tx_bufs (vm, ptd, sb0, n_bytes_b0, l234_sz, gso_size, gho)))
177 vlib_buffer_t *b0 = vlib_get_buffer (vm, ptd->split_buffers[0]);
178 tso_init_buf_from_template_base (b0, sb0, default_bflags,
179 l234_sz + first_data_size);
181 u32 total_src_left = n_bytes_b0 - l234_sz - first_data_size;
184 /* Need to copy more segments */
185 u8 *src_ptr, *dst_ptr;
186 u16 src_left, dst_left;
187 /* current source buffer */
188 vlib_buffer_t *csb0 = sb0;
190 /* current dest buffer */
192 u16 dbi = 1; /* the buffer [0] is b0 */
194 src_ptr = vlib_buffer_get_current (sb0) + l234_sz + first_data_size;
195 src_left = sb0->current_length - l234_sz - first_data_size;
197 tso_fixup_segmented_buf (b0, tcp_flags_no_fin_psh, is_ip6, gho);
199 /* grab a second buffer and prepare the loop */
200 ASSERT (dbi < vec_len (ptd->split_buffers));
201 cdb0 = vlib_get_buffer (vm, ptd->split_buffers[dbi++]);
202 tso_init_buf_from_template (vm, cdb0, b0, l234_sz, gso_size, &dst_ptr,
203 &dst_left, next_tcp_seq, default_bflags,
206 /* an arbitrary large number to catch the runaway loops */
208 while (total_src_left)
211 clib_panic ("infinite loop detected");
212 u16 bytes_to_copy = clib_min (src_left, dst_left);
214 clib_memcpy_fast (dst_ptr, src_ptr, bytes_to_copy);
216 src_left -= bytes_to_copy;
217 src_ptr += bytes_to_copy;
218 total_src_left -= bytes_to_copy;
219 dst_left -= bytes_to_copy;
220 dst_ptr += bytes_to_copy;
221 next_tcp_seq += bytes_to_copy;
222 cdb0->current_length += bytes_to_copy;
226 int has_next = (csb0->flags & VLIB_BUFFER_NEXT_PRESENT);
227 u32 next_bi = csb0->next_buffer;
229 /* init src to the next buffer in chain */
233 csb0 = vlib_get_buffer (vm, csbi0);
234 src_left = csb0->current_length;
235 src_ptr = vlib_buffer_get_current (csb0);
239 ASSERT (total_src_left == 0);
243 if (0 == dst_left && total_src_left)
245 n_tx_bytes += cdb0->current_length;
246 tso_fixup_segmented_buf (cdb0, tcp_flags_no_fin_psh, is_ip6,
248 ASSERT (dbi < vec_len (ptd->split_buffers));
249 cdb0 = vlib_get_buffer (vm, ptd->split_buffers[dbi++]);
250 tso_init_buf_from_template (vm, cdb0, b0, l234_sz,
251 gso_size, &dst_ptr, &dst_left,
252 next_tcp_seq, default_bflags, gho);
256 tso_fixup_segmented_buf (cdb0, save_tcp_flags, is_ip6, gho);
258 n_tx_bytes += cdb0->current_length;
260 n_tx_bytes += b0->current_length;
264 static_always_inline void
265 drop_one_buffer_and_count (vlib_main_t * vm, vnet_main_t * vnm,
266 vlib_node_runtime_t * node, u32 * pbi0,
267 u32 sw_if_index, u32 drop_error_code)
269 u32 thread_index = vm->thread_index;
271 vlib_simple_counter_main_t *cm;
273 vec_elt_at_index (vnm->interface_main.sw_if_counters,
274 VNET_INTERFACE_COUNTER_TX_ERROR);
275 vlib_increment_simple_counter (cm, thread_index, sw_if_index, 1);
277 vlib_error_drop_buffers (vm, node, pbi0,
278 /* buffer stride */ 1,
280 VNET_INTERFACE_OUTPUT_NEXT_DROP,
281 node->node_index, drop_error_code);
284 static_always_inline uword
285 vnet_gso_node_inline (vlib_main_t * vm,
286 vlib_node_runtime_t * node,
287 vlib_frame_t * frame,
289 vnet_hw_interface_t * hi,
290 int is_ip6, int do_segmentation)
293 u32 next_index = node->cached_next_index;
294 u32 *from = vlib_frame_vector_args (frame);
295 u32 n_left_from = frame->n_vectors;
296 u32 *from_end = from + n_left_from;
297 u32 thread_index = vm->thread_index;
298 vnet_interface_main_t *im = &vnm->interface_main;
299 vnet_interface_per_thread_data_t *ptd =
300 vec_elt_at_index (im->per_thread_data, thread_index);
301 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
303 vlib_get_buffers (vm, from, b, n_left_from);
305 while (n_left_from > 0)
309 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
311 if (!do_segmentation)
312 while (from + 8 <= from_end && n_left_to_next >= 4)
314 u32 bi0, bi1, bi2, bi3;
315 u32 next0, next1, next2, next3;
316 u32 swif0, swif1, swif2, swif3;
317 gso_trace_t *t0, *t1, *t2, *t3;
318 vnet_hw_interface_t *hi0, *hi1, *hi2, *hi3;
320 /* Prefetch next iteration. */
321 vlib_prefetch_buffer_header (b[4], LOAD);
322 vlib_prefetch_buffer_header (b[5], LOAD);
323 vlib_prefetch_buffer_header (b[6], LOAD);
324 vlib_prefetch_buffer_header (b[7], LOAD);
335 swif0 = vnet_buffer (b[0])->sw_if_index[VLIB_TX];
336 swif1 = vnet_buffer (b[1])->sw_if_index[VLIB_TX];
337 swif2 = vnet_buffer (b[2])->sw_if_index[VLIB_TX];
338 swif3 = vnet_buffer (b[3])->sw_if_index[VLIB_TX];
340 if (PREDICT_FALSE (hi->sw_if_index != swif0))
342 hi0 = vnet_get_sup_hw_interface (vnm, swif0);
343 if ((hi0->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO) == 0 &&
344 (b[0]->flags & VNET_BUFFER_F_GSO))
347 if (PREDICT_FALSE (hi->sw_if_index != swif1))
349 hi1 = vnet_get_sup_hw_interface (vnm, swif1);
350 if (!(hi1->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO) &&
351 (b[1]->flags & VNET_BUFFER_F_GSO))
354 if (PREDICT_FALSE (hi->sw_if_index != swif2))
356 hi2 = vnet_get_sup_hw_interface (vnm, swif2);
357 if ((hi2->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO) == 0 &&
358 (b[2]->flags & VNET_BUFFER_F_GSO))
361 if (PREDICT_FALSE (hi->sw_if_index != swif3))
363 hi3 = vnet_get_sup_hw_interface (vnm, swif3);
364 if (!(hi3->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO) &&
365 (b[3]->flags & VNET_BUFFER_F_GSO))
369 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
371 t0 = vlib_add_trace (vm, node, b[0], sizeof (t0[0]));
372 t0->flags = b[0]->flags & VNET_BUFFER_F_GSO;
373 t0->gso_size = vnet_buffer2 (b[0])->gso_size;
374 t0->gso_l4_hdr_sz = vnet_buffer2 (b[0])->gso_l4_hdr_sz;
376 if (b[1]->flags & VLIB_BUFFER_IS_TRACED)
378 t1 = vlib_add_trace (vm, node, b[1], sizeof (t1[0]));
379 t1->flags = b[1]->flags & VNET_BUFFER_F_GSO;
380 t1->gso_size = vnet_buffer2 (b[1])->gso_size;
381 t1->gso_l4_hdr_sz = vnet_buffer2 (b[1])->gso_l4_hdr_sz;
383 if (b[2]->flags & VLIB_BUFFER_IS_TRACED)
385 t2 = vlib_add_trace (vm, node, b[2], sizeof (t2[0]));
386 t2->flags = b[2]->flags & VNET_BUFFER_F_GSO;
387 t2->gso_size = vnet_buffer2 (b[2])->gso_size;
388 t2->gso_l4_hdr_sz = vnet_buffer2 (b[2])->gso_l4_hdr_sz;
390 if (b[3]->flags & VLIB_BUFFER_IS_TRACED)
392 t3 = vlib_add_trace (vm, node, b[3], sizeof (t3[0]));
393 t3->flags = b[3]->flags & VNET_BUFFER_F_GSO;
394 t3->gso_size = vnet_buffer2 (b[3])->gso_size;
395 t3->gso_l4_hdr_sz = vnet_buffer2 (b[3])->gso_l4_hdr_sz;
405 vnet_feature_next (&next0, b[0]);
406 vnet_feature_next (&next1, b[1]);
407 vnet_feature_next (&next2, b[2]);
408 vnet_feature_next (&next3, b[3]);
409 vlib_validate_buffer_enqueue_x4 (vm, node, next_index, to_next,
410 n_left_to_next, bi0, bi1, bi2,
411 bi3, next0, next1, next2, next3);
415 while (from + 1 <= from_end && n_left_to_next > 0)
419 vnet_hw_interface_t *hi0;
421 u32 do_segmentation0 = 0;
423 swif0 = vnet_buffer (b[0])->sw_if_index[VLIB_TX];
424 if (PREDICT_FALSE (hi->sw_if_index != swif0))
426 hi0 = vnet_get_sup_hw_interface (vnm, swif0);
427 if ((hi0->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO) == 0 &&
428 (b[0]->flags & VNET_BUFFER_F_GSO))
429 do_segmentation0 = 1;
432 do_segmentation0 = do_segmentation;
434 /* speculatively enqueue b0 to the current next frame */
435 to_next[0] = bi0 = from[0];
441 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
443 t0 = vlib_add_trace (vm, node, b[0], sizeof (t0[0]));
444 t0->flags = b[0]->flags & VNET_BUFFER_F_GSO;
445 t0->gso_size = vnet_buffer2 (b[0])->gso_size;
446 t0->gso_l4_hdr_sz = vnet_buffer2 (b[0])->gso_l4_hdr_sz;
449 if (do_segmentation0)
451 if (PREDICT_FALSE (b[0]->flags & VNET_BUFFER_F_GSO))
454 * Undo the enqueue of the b0 - it is not going anywhere,
455 * and will be freed either after it's segmented or
456 * when dropped, if there is no buffers to segment into.
460 /* undo the counting. */
461 gso_header_offset_t gho;
462 u32 n_bytes_b0 = vlib_buffer_length_in_chain (vm, b[0]);
465 gho = vnet_gso_header_offset_parser (b[0], is_ip6);
467 tso_segment_buffer (vm, ptd, bi0, b[0], &gho, n_bytes_b0,
470 if (PREDICT_FALSE (n_tx_bytes == 0))
472 drop_one_buffer_and_count (vm, vnm, node, from - 1,
474 VNET_INTERFACE_OUTPUT_ERROR_NO_BUFFERS_FOR_GSO);
479 u16 n_tx_bufs = vec_len (ptd->split_buffers);
480 u32 *from_seg = ptd->split_buffers;
482 while (n_tx_bufs > 0)
486 if (n_tx_bufs >= n_left_to_next)
488 while (n_left_to_next > 0)
490 sbi0 = to_next[0] = from_seg[0];
491 sb0 = vlib_get_buffer (vm, sbi0);
496 vnet_feature_next (&next0, sb0);
497 vlib_validate_buffer_enqueue_x1 (vm, node,
503 vlib_put_next_frame (vm, node, next_index,
505 vlib_get_new_next_frame (vm, node, next_index,
506 to_next, n_left_to_next);
508 while (n_tx_bufs > 0)
510 sbi0 = to_next[0] = from_seg[0];
511 sb0 = vlib_get_buffer (vm, sbi0);
516 vnet_feature_next (&next0, sb0);
517 vlib_validate_buffer_enqueue_x1 (vm, node,
524 /* The buffers were enqueued. Reset the length */
525 _vec_len (ptd->split_buffers) = 0;
526 /* Free the now segmented buffer */
527 vlib_buffer_free_one (vm, bi0);
533 vnet_feature_next (&next0, b[0]);
534 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
535 n_left_to_next, bi0, next0);
538 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
541 return frame->n_vectors;
544 static_always_inline uword
545 vnet_gso_inline (vlib_main_t * vm,
546 vlib_node_runtime_t * node, vlib_frame_t * frame, int is_ip6)
548 vnet_main_t *vnm = vnet_get_main ();
549 vnet_hw_interface_t *hi;
551 if (frame->n_vectors > 0)
553 u32 *from = vlib_frame_vector_args (frame);
554 vlib_buffer_t *b = vlib_get_buffer (vm, from[0]);
555 hi = vnet_get_sup_hw_interface (vnm,
556 vnet_buffer (b)->sw_if_index[VLIB_TX]);
558 if (hi->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO)
559 return vnet_gso_node_inline (vm, node, frame, vnm, hi,
560 is_ip6, /* do_segmentation */ 0);
562 return vnet_gso_node_inline (vm, node, frame, vnm, hi,
563 is_ip6, /* do_segmentation */ 1);
568 VLIB_NODE_FN (gso_l2_ip4_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
569 vlib_frame_t * frame)
571 return vnet_gso_inline (vm, node, frame, 0 /* ip6 */ );
574 VLIB_NODE_FN (gso_l2_ip6_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
575 vlib_frame_t * frame)
577 return vnet_gso_inline (vm, node, frame, 1 /* ip6 */ );
580 VLIB_NODE_FN (gso_ip4_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
581 vlib_frame_t * frame)
583 return vnet_gso_inline (vm, node, frame, 0 /* ip6 */ );
586 VLIB_NODE_FN (gso_ip6_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
587 vlib_frame_t * frame)
589 return vnet_gso_inline (vm, node, frame, 1 /* ip6 */ );
594 VLIB_REGISTER_NODE (gso_l2_ip4_node) = {
595 .vector_size = sizeof (u32),
596 .format_trace = format_gso_trace,
597 .type = VLIB_NODE_TYPE_INTERNAL,
600 .name = "gso-l2-ip4",
603 VLIB_REGISTER_NODE (gso_l2_ip6_node) = {
604 .vector_size = sizeof (u32),
605 .format_trace = format_gso_trace,
606 .type = VLIB_NODE_TYPE_INTERNAL,
609 .name = "gso-l2-ip6",
612 VLIB_REGISTER_NODE (gso_ip4_node) = {
613 .vector_size = sizeof (u32),
614 .format_trace = format_gso_trace,
615 .type = VLIB_NODE_TYPE_INTERNAL,
621 VLIB_REGISTER_NODE (gso_ip6_node) = {
622 .vector_size = sizeof (u32),
623 .format_trace = format_gso_trace,
624 .type = VLIB_NODE_TYPE_INTERNAL,
630 VNET_FEATURE_INIT (gso_l2_ip4_node, static) = {
631 .arc_name = "l2-output-ip4",
632 .node_name = "gso-l2-ip4",
633 .runs_before = VNET_FEATURES ("l2-output-feat-arc-end"),
636 VNET_FEATURE_INIT (gso_l2_ip6_node, static) = {
637 .arc_name = "l2-output-ip6",
638 .node_name = "gso-l2-ip6",
639 .runs_before = VNET_FEATURES ("l2-output-feat-arc-end"),
642 VNET_FEATURE_INIT (gso_ip4_node, static) = {
643 .arc_name = "ip4-output",
644 .node_name = "gso-ip4",
645 .runs_after = VNET_FEATURES ("ipsec4-output-feature"),
646 .runs_before = VNET_FEATURES ("interface-output"),
649 VNET_FEATURE_INIT (gso_ip6_node, static) = {
650 .arc_name = "ip6-output",
651 .node_name = "gso-ip6",
652 .runs_after = VNET_FEATURES ("ipsec6-output-feature"),
653 .runs_before = VNET_FEATURES ("interface-output"),
657 * fd.io coding-style-patch-verification: ON
660 * eval: (c-set-style "gnu")