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,
61 clib_min (gso_size, vlib_buffer_get_default_data_size (vm) - l234_sz);
63 /* rounded-up division */
64 u16 n_bufs = (n_bytes_b0 - l234_sz + (size - 1)) / size;
68 vec_validate (ptd->split_buffers, n_bufs - 1);
70 n_alloc = vlib_buffer_alloc (vm, ptd->split_buffers, n_bufs);
73 vlib_buffer_free (vm, ptd->split_buffers, n_alloc);
79 static_always_inline void
80 tso_init_buf_from_template_base (vlib_buffer_t * nb0, vlib_buffer_t * b0,
81 u32 flags, u16 length)
83 nb0->current_data = b0->current_data;
84 nb0->total_length_not_including_first_buffer = 0;
85 nb0->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID | flags;
86 nb0->trace_handle = b0->trace_handle;
87 clib_memcpy_fast (&nb0->opaque, &b0->opaque, sizeof (nb0->opaque));
88 clib_memcpy_fast (vlib_buffer_get_current (nb0),
89 vlib_buffer_get_current (b0), length);
90 nb0->current_length = length;
93 static_always_inline void
94 tso_init_buf_from_template (vlib_main_t * vm, vlib_buffer_t * nb0,
95 vlib_buffer_t * b0, u16 template_data_sz,
96 u16 gso_size, u8 ** p_dst_ptr, u16 * p_dst_left,
97 u32 next_tcp_seq, u32 flags,
98 gso_header_offset_t * gho)
100 tso_init_buf_from_template_base (nb0, b0, flags, template_data_sz);
104 vlib_buffer_get_default_data_size (vm) - (template_data_sz +
106 *p_dst_ptr = vlib_buffer_get_current (nb0) + template_data_sz;
109 (tcp_header_t *) (vlib_buffer_get_current (nb0) + gho->l4_hdr_offset);
110 tcp->seq_number = clib_host_to_net_u32 (next_tcp_seq);
113 static_always_inline void
114 tso_fixup_segmented_buf (vlib_buffer_t * b0, u8 tcp_flags, int is_ip6,
115 gso_header_offset_t * gho)
118 (ip4_header_t *) (vlib_buffer_get_current (b0) + gho->l3_hdr_offset);
120 (ip6_header_t *) (vlib_buffer_get_current (b0) + gho->l3_hdr_offset);
122 (tcp_header_t *) (vlib_buffer_get_current (b0) + gho->l4_hdr_offset);
124 tcp->flags = tcp_flags;
127 ip6->payload_length =
128 clib_host_to_net_u16 (b0->current_length -
129 (gho->l4_hdr_offset - gho->l2_hdr_offset));
132 clib_host_to_net_u16 (b0->current_length -
133 (gho->l3_hdr_offset - gho->l2_hdr_offset));
137 * Allocate the necessary number of ptd->split_buffers,
138 * and segment the possibly chained buffer(s) from b0 into
141 * Return the cumulative number of bytes sent or zero
142 * if allocation failed.
145 static_always_inline u32
146 tso_segment_buffer (vlib_main_t * vm, vnet_interface_per_thread_data_t * ptd,
147 u32 sbi0, vlib_buffer_t * sb0, gso_header_offset_t * gho,
148 u32 n_bytes_b0, int is_ip6)
151 u16 gso_size = vnet_buffer2 (sb0)->gso_size;
153 int l4_hdr_sz = gho->l4_hdr_sz;
154 u8 save_tcp_flags = 0;
155 u8 tcp_flags_no_fin_psh = 0;
156 u32 next_tcp_seq = 0;
159 (tcp_header_t *) (vlib_buffer_get_current (sb0) + gho->l4_hdr_offset);
160 next_tcp_seq = clib_net_to_host_u32 (tcp->seq_number);
161 /* store original flags for last packet and reset FIN and PSH */
162 save_tcp_flags = tcp->flags;
163 tcp_flags_no_fin_psh = tcp->flags & ~(TCP_FLAG_FIN | TCP_FLAG_PSH);
167 sb0->flags & ~(VNET_BUFFER_F_GSO | VLIB_BUFFER_NEXT_PRESENT);
168 u16 l234_sz = gho->l4_hdr_offset + l4_hdr_sz - gho->l2_hdr_offset;
169 int first_data_size = clib_min (gso_size, sb0->current_length - l234_sz);
170 next_tcp_seq += first_data_size;
173 (!tso_alloc_tx_bufs (vm, ptd, sb0, n_bytes_b0, l234_sz, gso_size)))
176 vlib_buffer_t *b0 = vlib_get_buffer (vm, ptd->split_buffers[0]);
177 tso_init_buf_from_template_base (b0, sb0, default_bflags,
178 l234_sz + first_data_size);
180 u32 total_src_left = n_bytes_b0 - l234_sz - first_data_size;
183 /* Need to copy more segments */
184 u8 *src_ptr, *dst_ptr;
185 u16 src_left, dst_left;
186 /* current source buffer */
187 vlib_buffer_t *csb0 = sb0;
189 /* current dest buffer */
191 u16 dbi = 1; /* the buffer [0] is b0 */
193 src_ptr = vlib_buffer_get_current (sb0) + l234_sz + first_data_size;
194 src_left = sb0->current_length - l234_sz - first_data_size;
196 tso_fixup_segmented_buf (b0, tcp_flags_no_fin_psh, is_ip6, gho);
198 /* grab a second buffer and prepare the loop */
199 ASSERT (dbi < vec_len (ptd->split_buffers));
200 cdb0 = vlib_get_buffer (vm, ptd->split_buffers[dbi++]);
201 tso_init_buf_from_template (vm, cdb0, b0, l234_sz, gso_size, &dst_ptr,
202 &dst_left, next_tcp_seq, default_bflags,
205 /* an arbitrary large number to catch the runaway loops */
207 while (total_src_left)
210 clib_panic ("infinite loop detected");
211 u16 bytes_to_copy = clib_min (src_left, dst_left);
213 clib_memcpy_fast (dst_ptr, src_ptr, bytes_to_copy);
215 src_left -= bytes_to_copy;
216 src_ptr += bytes_to_copy;
217 total_src_left -= bytes_to_copy;
218 dst_left -= bytes_to_copy;
219 dst_ptr += bytes_to_copy;
220 next_tcp_seq += bytes_to_copy;
221 cdb0->current_length += bytes_to_copy;
225 int has_next = (csb0->flags & VLIB_BUFFER_NEXT_PRESENT);
226 u32 next_bi = csb0->next_buffer;
228 /* init src to the next buffer in chain */
232 csb0 = vlib_get_buffer (vm, csbi0);
233 src_left = csb0->current_length;
234 src_ptr = vlib_buffer_get_current (csb0);
238 ASSERT (total_src_left == 0);
242 if (0 == dst_left && total_src_left)
244 n_tx_bytes += cdb0->current_length;
245 tso_fixup_segmented_buf (cdb0, tcp_flags_no_fin_psh, is_ip6,
247 ASSERT (dbi < vec_len (ptd->split_buffers));
248 cdb0 = vlib_get_buffer (vm, ptd->split_buffers[dbi++]);
249 tso_init_buf_from_template (vm, cdb0, b0, l234_sz,
250 gso_size, &dst_ptr, &dst_left,
251 next_tcp_seq, default_bflags, gho);
255 tso_fixup_segmented_buf (cdb0, save_tcp_flags, is_ip6, gho);
257 n_tx_bytes += cdb0->current_length;
259 n_tx_bytes += b0->current_length;
263 static_always_inline void
264 drop_one_buffer_and_count (vlib_main_t * vm, vnet_main_t * vnm,
265 vlib_node_runtime_t * node, u32 * pbi0,
266 u32 sw_if_index, u32 drop_error_code)
268 u32 thread_index = vm->thread_index;
270 vlib_simple_counter_main_t *cm;
272 vec_elt_at_index (vnm->interface_main.sw_if_counters,
273 VNET_INTERFACE_COUNTER_TX_ERROR);
274 vlib_increment_simple_counter (cm, thread_index, sw_if_index, 1);
276 vlib_error_drop_buffers (vm, node, pbi0,
277 /* buffer stride */ 1,
279 VNET_INTERFACE_OUTPUT_NEXT_DROP,
280 node->node_index, drop_error_code);
283 static_always_inline uword
284 vnet_gso_node_inline (vlib_main_t * vm,
285 vlib_node_runtime_t * node,
286 vlib_frame_t * frame,
288 vnet_hw_interface_t * hi,
289 int is_ip6, int do_segmentation)
292 u32 next_index = node->cached_next_index;
293 u32 *from = vlib_frame_vector_args (frame);
294 u32 n_left_from = frame->n_vectors;
295 u32 *from_end = from + n_left_from;
296 u32 thread_index = vm->thread_index;
297 vnet_interface_main_t *im = &vnm->interface_main;
298 vnet_interface_per_thread_data_t *ptd =
299 vec_elt_at_index (im->per_thread_data, thread_index);
300 vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
302 vlib_get_buffers (vm, from, b, n_left_from);
304 while (n_left_from > 0)
308 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
310 if (!do_segmentation)
311 while (from + 8 <= from_end && n_left_to_next >= 4)
313 u32 bi0, bi1, bi2, bi3;
314 u32 next0, next1, next2, next3;
315 u32 swif0, swif1, swif2, swif3;
316 gso_trace_t *t0, *t1, *t2, *t3;
317 vnet_hw_interface_t *hi0, *hi1, *hi2, *hi3;
319 /* Prefetch next iteration. */
320 vlib_prefetch_buffer_header (b[4], LOAD);
321 vlib_prefetch_buffer_header (b[5], LOAD);
322 vlib_prefetch_buffer_header (b[6], LOAD);
323 vlib_prefetch_buffer_header (b[7], LOAD);
334 swif0 = vnet_buffer (b[0])->sw_if_index[VLIB_TX];
335 swif1 = vnet_buffer (b[1])->sw_if_index[VLIB_TX];
336 swif2 = vnet_buffer (b[2])->sw_if_index[VLIB_TX];
337 swif3 = vnet_buffer (b[3])->sw_if_index[VLIB_TX];
339 if (PREDICT_FALSE (hi->sw_if_index != swif0))
341 hi0 = vnet_get_sup_hw_interface (vnm, swif0);
342 if ((hi0->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO) == 0 &&
343 (b[0]->flags & VNET_BUFFER_F_GSO))
346 if (PREDICT_FALSE (hi->sw_if_index != swif1))
348 hi1 = vnet_get_sup_hw_interface (vnm, swif0);
349 if (!(hi1->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO) &&
350 (b[1]->flags & VNET_BUFFER_F_GSO))
353 if (PREDICT_FALSE (hi->sw_if_index != swif2))
355 hi2 = vnet_get_sup_hw_interface (vnm, swif0);
356 if ((hi2->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO) == 0 &&
357 (b[2]->flags & VNET_BUFFER_F_GSO))
360 if (PREDICT_FALSE (hi->sw_if_index != swif3))
362 hi3 = vnet_get_sup_hw_interface (vnm, swif0);
363 if (!(hi3->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO) &&
364 (b[3]->flags & VNET_BUFFER_F_GSO))
368 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
370 t0 = vlib_add_trace (vm, node, b[0], sizeof (t0[0]));
371 t0->flags = b[0]->flags & VNET_BUFFER_F_GSO;
372 t0->gso_size = vnet_buffer2 (b[0])->gso_size;
373 t0->gso_l4_hdr_sz = vnet_buffer2 (b[0])->gso_l4_hdr_sz;
375 if (b[1]->flags & VLIB_BUFFER_IS_TRACED)
377 t1 = vlib_add_trace (vm, node, b[1], sizeof (t1[0]));
378 t1->flags = b[1]->flags & VNET_BUFFER_F_GSO;
379 t1->gso_size = vnet_buffer2 (b[1])->gso_size;
380 t1->gso_l4_hdr_sz = vnet_buffer2 (b[1])->gso_l4_hdr_sz;
382 if (b[2]->flags & VLIB_BUFFER_IS_TRACED)
384 t2 = vlib_add_trace (vm, node, b[2], sizeof (t2[0]));
385 t2->flags = b[2]->flags & VNET_BUFFER_F_GSO;
386 t2->gso_size = vnet_buffer2 (b[2])->gso_size;
387 t2->gso_l4_hdr_sz = vnet_buffer2 (b[2])->gso_l4_hdr_sz;
389 if (b[3]->flags & VLIB_BUFFER_IS_TRACED)
391 t3 = vlib_add_trace (vm, node, b[3], sizeof (t3[0]));
392 t3->flags = b[3]->flags & VNET_BUFFER_F_GSO;
393 t3->gso_size = vnet_buffer2 (b[3])->gso_size;
394 t3->gso_l4_hdr_sz = vnet_buffer2 (b[3])->gso_l4_hdr_sz;
404 vnet_feature_next (&next0, b[0]);
405 vnet_feature_next (&next1, b[1]);
406 vnet_feature_next (&next2, b[2]);
407 vnet_feature_next (&next3, b[3]);
408 vlib_validate_buffer_enqueue_x4 (vm, node, next_index, to_next,
409 n_left_to_next, bi0, bi1, bi2,
410 bi3, next0, next1, next2, next3);
414 while (from + 1 <= from_end && n_left_to_next > 0)
418 vnet_hw_interface_t *hi0;
420 u32 do_segmentation0 = 0;
422 swif0 = vnet_buffer (b[0])->sw_if_index[VLIB_TX];
423 if (PREDICT_FALSE (hi->sw_if_index != swif0))
425 hi0 = vnet_get_sup_hw_interface (vnm, swif0);
426 if ((hi0->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO) == 0 &&
427 (b[0]->flags & VNET_BUFFER_F_GSO))
428 do_segmentation0 = 1;
431 do_segmentation0 = do_segmentation;
433 /* speculatively enqueue b0 to the current next frame */
434 to_next[0] = bi0 = from[0];
440 if (b[0]->flags & VLIB_BUFFER_IS_TRACED)
442 t0 = vlib_add_trace (vm, node, b[0], sizeof (t0[0]));
443 t0->flags = b[0]->flags & VNET_BUFFER_F_GSO;
444 t0->gso_size = vnet_buffer2 (b[0])->gso_size;
445 t0->gso_l4_hdr_sz = vnet_buffer2 (b[0])->gso_l4_hdr_sz;
448 if (do_segmentation0)
450 if (PREDICT_FALSE (b[0]->flags & VNET_BUFFER_F_GSO))
453 * Undo the enqueue of the b0 - it is not going anywhere,
454 * and will be freed either after it's segmented or
455 * when dropped, if there is no buffers to segment into.
459 /* undo the counting. */
460 gso_header_offset_t gho;
461 u32 n_bytes_b0 = vlib_buffer_length_in_chain (vm, b[0]);
464 gho = vnet_gso_header_offset_parser (b[0], is_ip6);
466 tso_segment_buffer (vm, ptd, bi0, b[0], &gho, n_bytes_b0,
469 if (PREDICT_FALSE (n_tx_bytes == 0))
471 drop_one_buffer_and_count (vm, vnm, node, from - 1,
473 VNET_INTERFACE_OUTPUT_ERROR_NO_BUFFERS_FOR_GSO);
478 u16 n_tx_bufs = vec_len (ptd->split_buffers);
479 u32 *from_seg = ptd->split_buffers;
481 while (n_tx_bufs > 0)
485 if (n_tx_bufs >= n_left_to_next)
487 while (n_left_to_next > 0)
489 sbi0 = to_next[0] = from_seg[0];
490 sb0 = vlib_get_buffer (vm, sbi0);
495 vnet_feature_next (&next0, sb0);
496 vlib_validate_buffer_enqueue_x1 (vm, node,
502 vlib_put_next_frame (vm, node, next_index,
504 vlib_get_new_next_frame (vm, node, next_index,
505 to_next, n_left_to_next);
507 while (n_tx_bufs > 0)
509 sbi0 = to_next[0] = from_seg[0];
510 sb0 = vlib_get_buffer (vm, sbi0);
515 vnet_feature_next (&next0, sb0);
516 vlib_validate_buffer_enqueue_x1 (vm, node,
523 /* The buffers were enqueued. Reset the length */
524 _vec_len (ptd->split_buffers) = 0;
525 /* Free the now segmented buffer */
526 vlib_buffer_free_one (vm, bi0);
532 vnet_feature_next (&next0, b[0]);
533 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
534 n_left_to_next, bi0, next0);
537 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
540 return frame->n_vectors;
543 static_always_inline uword
544 vnet_gso_inline (vlib_main_t * vm,
545 vlib_node_runtime_t * node, vlib_frame_t * frame, int is_ip6)
547 vnet_main_t *vnm = vnet_get_main ();
548 vnet_hw_interface_t *hi;
550 if (frame->n_vectors > 0)
552 u32 *from = vlib_frame_vector_args (frame);
553 vlib_buffer_t *b = vlib_get_buffer (vm, from[0]);
554 hi = vnet_get_sup_hw_interface (vnm,
555 vnet_buffer (b)->sw_if_index[VLIB_TX]);
557 if (hi->flags & VNET_HW_INTERFACE_FLAG_SUPPORTS_GSO)
558 return vnet_gso_node_inline (vm, node, frame, vnm, hi,
559 is_ip6, /* do_segmentation */ 0);
561 return vnet_gso_node_inline (vm, node, frame, vnm, hi,
562 is_ip6, /* do_segmentation */ 1);
567 VLIB_NODE_FN (gso_l2_ip4_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
568 vlib_frame_t * frame)
570 return vnet_gso_inline (vm, node, frame, 0 /* ip6 */ );
573 VLIB_NODE_FN (gso_l2_ip6_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
574 vlib_frame_t * frame)
576 return vnet_gso_inline (vm, node, frame, 1 /* ip6 */ );
579 VLIB_NODE_FN (gso_ip4_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
580 vlib_frame_t * frame)
582 return vnet_gso_inline (vm, node, frame, 0 /* ip6 */ );
585 VLIB_NODE_FN (gso_ip6_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
586 vlib_frame_t * frame)
588 return vnet_gso_inline (vm, node, frame, 1 /* ip6 */ );
593 VLIB_REGISTER_NODE (gso_l2_ip4_node) = {
594 .vector_size = sizeof (u32),
595 .format_trace = format_gso_trace,
596 .type = VLIB_NODE_TYPE_INTERNAL,
599 .name = "gso-l2-ip4",
602 VLIB_REGISTER_NODE (gso_l2_ip6_node) = {
603 .vector_size = sizeof (u32),
604 .format_trace = format_gso_trace,
605 .type = VLIB_NODE_TYPE_INTERNAL,
608 .name = "gso-l2-ip6",
611 VLIB_REGISTER_NODE (gso_ip4_node) = {
612 .vector_size = sizeof (u32),
613 .format_trace = format_gso_trace,
614 .type = VLIB_NODE_TYPE_INTERNAL,
620 VLIB_REGISTER_NODE (gso_ip6_node) = {
621 .vector_size = sizeof (u32),
622 .format_trace = format_gso_trace,
623 .type = VLIB_NODE_TYPE_INTERNAL,
629 VNET_FEATURE_INIT (gso_l2_ip4_node, static) = {
630 .arc_name = "l2-output-ip4",
631 .node_name = "gso-l2-ip4",
632 .runs_before = VNET_FEATURES ("l2-output-feat-arc-end"),
635 VNET_FEATURE_INIT (gso_l2_ip6_node, static) = {
636 .arc_name = "l2-output-ip6",
637 .node_name = "gso-l2-ip6",
638 .runs_before = VNET_FEATURES ("l2-output-feat-arc-end"),
641 VNET_FEATURE_INIT (gso_ip4_node, static) = {
642 .arc_name = "ip4-output",
643 .node_name = "gso-ip4",
644 .runs_after = VNET_FEATURES ("ipsec4-output-feature"),
645 .runs_before = VNET_FEATURES ("interface-output"),
648 VNET_FEATURE_INIT (gso_ip6_node, static) = {
649 .arc_name = "ip6-output",
650 .node_name = "gso-ip6",
651 .runs_after = VNET_FEATURES ("ipsec6-output-feature"),
652 .runs_before = VNET_FEATURES ("interface-output"),
656 * fd.io coding-style-patch-verification: ON
659 * eval: (c-set-style "gnu")