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.
15 #include <vnet/vnet.h>
16 #include <vppinfra/vec.h>
17 #include <vppinfra/error.h>
18 #include <vppinfra/format.h>
19 #include <vppinfra/xxhash.h>
21 #include <vnet/ethernet/ethernet.h>
22 #include <dpdk/device/dpdk.h>
23 #include <vnet/classify/vnet_classify.h>
24 #include <vnet/mpls/packet.h>
25 #include <vnet/handoff.h>
26 #include <vnet/devices/devices.h>
27 #include <vnet/feature/feature.h>
29 #include <dpdk/device/dpdk_priv.h>
31 static char *dpdk_error_strings[] = {
38 vlib_buffer_is_ip4 (vlib_buffer_t * b)
40 ethernet_header_t *h = (ethernet_header_t *) vlib_buffer_get_current (b);
41 return (h->type == clib_host_to_net_u16 (ETHERNET_TYPE_IP4));
45 vlib_buffer_is_ip6 (vlib_buffer_t * b)
47 ethernet_header_t *h = (ethernet_header_t *) vlib_buffer_get_current (b);
48 return (h->type == clib_host_to_net_u16 (ETHERNET_TYPE_IP6));
52 vlib_buffer_is_mpls (vlib_buffer_t * b)
54 ethernet_header_t *h = (ethernet_header_t *) vlib_buffer_get_current (b);
55 return (h->type == clib_host_to_net_u16 (ETHERNET_TYPE_MPLS));
59 dpdk_rx_next_from_etype (struct rte_mbuf * mb, vlib_buffer_t * b0)
61 if (PREDICT_TRUE (vlib_buffer_is_ip4 (b0)))
63 if (PREDICT_TRUE ((mb->ol_flags & PKT_RX_IP_CKSUM_GOOD) != 0))
64 return VNET_DEVICE_INPUT_NEXT_IP4_NCS_INPUT;
66 return VNET_DEVICE_INPUT_NEXT_IP4_INPUT;
68 else if (PREDICT_TRUE (vlib_buffer_is_ip6 (b0)))
69 return VNET_DEVICE_INPUT_NEXT_IP6_INPUT;
70 else if (PREDICT_TRUE (vlib_buffer_is_mpls (b0)))
71 return VNET_DEVICE_INPUT_NEXT_MPLS_INPUT;
73 return VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
77 dpdk_rx_next_from_packet_start (struct rte_mbuf * mb, vlib_buffer_t * b0)
82 start_delta = b0->current_data -
83 ((mb->buf_addr + mb->data_off) - (void *) b0->data);
85 vlib_buffer_advance (b0, -start_delta);
87 if (PREDICT_TRUE (vlib_buffer_is_ip4 (b0)))
89 if (PREDICT_TRUE ((mb->ol_flags & PKT_RX_IP_CKSUM_GOOD) != 0))
90 rv = VNET_DEVICE_INPUT_NEXT_IP4_NCS_INPUT;
92 rv = VNET_DEVICE_INPUT_NEXT_IP4_INPUT;
94 else if (PREDICT_TRUE (vlib_buffer_is_ip6 (b0)))
95 rv = VNET_DEVICE_INPUT_NEXT_IP6_INPUT;
96 else if (PREDICT_TRUE (vlib_buffer_is_mpls (b0)))
97 rv = VNET_DEVICE_INPUT_NEXT_MPLS_INPUT;
99 rv = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
101 vlib_buffer_advance (b0, start_delta);
106 dpdk_rx_error_from_mb (struct rte_mbuf *mb, u32 * next, u8 * error)
108 if (mb->ol_flags & PKT_RX_IP_CKSUM_BAD)
110 *error = DPDK_ERROR_IP_CHECKSUM_ERROR;
111 *next = VNET_DEVICE_INPUT_NEXT_DROP;
114 *error = DPDK_ERROR_NONE;
118 dpdk_rx_trace (dpdk_main_t * dm,
119 vlib_node_runtime_t * node,
121 u16 queue_id, u32 * buffers, uword n_buffers)
123 vlib_main_t *vm = vlib_get_main ();
134 dpdk_rx_dma_trace_t *t0;
141 b0 = vlib_get_buffer (vm, bi0);
142 mb = rte_mbuf_from_vlib_buffer (b0);
144 if (PREDICT_FALSE (xd->per_interface_next_index != ~0))
145 next0 = xd->per_interface_next_index;
147 next0 = dpdk_rx_next_from_packet_start (mb, b0);
149 dpdk_rx_error_from_mb (mb, &next0, &error0);
151 vlib_trace_buffer (vm, node, next0, b0, /* follow_chain */ 0);
152 t0 = vlib_add_trace (vm, node, b0, sizeof (t0[0]));
153 t0->queue_index = queue_id;
154 t0->device_index = xd->device_index;
155 t0->buffer_index = bi0;
157 clib_memcpy (&t0->mb, mb, sizeof (t0->mb));
158 clib_memcpy (&t0->buffer, b0, sizeof (b0[0]) - sizeof (b0->pre_data));
159 clib_memcpy (t0->buffer.pre_data, b0->data,
160 sizeof (t0->buffer.pre_data));
161 clib_memcpy (&t0->data, mb->buf_addr + mb->data_off, sizeof (t0->data));
168 dpdk_rx_burst (dpdk_main_t * dm, dpdk_device_t * xd, u16 queue_id)
174 n_left = VLIB_FRAME_SIZE;
177 if (PREDICT_TRUE (xd->flags & DPDK_DEVICE_FLAG_PMD))
181 n_this_chunk = rte_eth_rx_burst (xd->device_index, queue_id,
182 xd->rx_vectors[queue_id] +
184 n_buffers += n_this_chunk;
185 n_left -= n_this_chunk;
187 /* Empirically, DPDK r1.8 produces vectors w/ 32 or fewer elts */
188 if (n_this_chunk < 32)
201 static_always_inline void
202 dpdk_process_subseq_segs (vlib_main_t * vm, vlib_buffer_t * b,
203 struct rte_mbuf *mb, vlib_buffer_free_list_t * fl)
206 struct rte_mbuf *mb_seg = 0;
207 vlib_buffer_t *b_seg, *b_chain = 0;
211 while ((mb->nb_segs > 1) && (nb_seg < mb->nb_segs))
213 ASSERT (mb_seg != 0);
215 b_seg = vlib_buffer_from_rte_mbuf (mb_seg);
216 vlib_buffer_init_for_free_list (b_seg, fl);
218 ASSERT ((b_seg->flags & VLIB_BUFFER_NEXT_PRESENT) == 0);
219 ASSERT (b_seg->current_data == 0);
222 * The driver (e.g. virtio) may not put the packet data at the start
223 * of the segment, so don't assume b_seg->current_data == 0 is correct.
225 b_seg->current_data =
226 (mb_seg->buf_addr + mb_seg->data_off) - (void *) b_seg->data;
228 b_seg->current_length = mb_seg->data_len;
229 b->total_length_not_including_first_buffer += mb_seg->data_len;
231 b_chain->flags |= VLIB_BUFFER_NEXT_PRESENT;
232 b_chain->next_buffer = vlib_get_buffer_index (vm, b_seg);
235 mb_seg = mb_seg->next;
240 static_always_inline void
241 dpdk_prefetch_buffer (struct rte_mbuf *mb)
243 vlib_buffer_t *b = vlib_buffer_from_rte_mbuf (mb);
244 CLIB_PREFETCH (mb, CLIB_CACHE_LINE_BYTES, LOAD);
245 CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, STORE);
248 static_always_inline void
249 dpdk_prefetch_ethertype (struct rte_mbuf *mb)
251 CLIB_PREFETCH (mb->buf_addr + mb->data_off +
252 STRUCT_OFFSET_OF (ethernet_header_t, type),
253 CLIB_CACHE_LINE_BYTES, LOAD);
258 This function should fill 1st cacheline of vlib_buffer_t metadata with data
259 from buffer template. Instead of filling field by field, we construct
260 template and then use 128/256 bit vector instruction to copy data.
261 This code first loads whole cacheline into 4 128-bit registers (xmm)
262 or two 256 bit registers (ymm) and then stores data into all 4 buffers
263 efectively saving on register load operations.
266 static_always_inline void
267 dpdk_buffer_init_from_template (void *d0, void *d1, void *d2, void *d3,
270 #if defined(CLIB_HAVE_VEC128)
272 for (i = 0; i < 2; i++)
274 *(u8x32 *) (((u8 *) d0) + i * 32) =
275 *(u8x32 *) (((u8 *) d1) + i * 32) =
276 *(u8x32 *) (((u8 *) d2) + i * 32) =
277 *(u8x32 *) (((u8 *) d3) + i * 32) = *(u8x32 *) (((u8 *) s) + i * 32);
279 #elif defined(CLIB_HAVE_VEC64)
281 for (i = 0; i < 4; i++)
283 *(u8x16 *) (((u8 *) d0) + i * 16) =
284 *(u8x16 *) (((u8 *) d1) + i * 16) =
285 *(u8x16 *) (((u8 *) d2) + i * 16) =
286 *(u8x16 *) (((u8 *) d3) + i * 16) = *(u8x16 *) (((u8 *) s) + i * 16);
289 #error "Either CLIB_HAVE_VEC128 or CLIB_HAVE_VEC64 has to be defined"
294 * This function is used when there are no worker threads.
295 * The main thread performs IO and forwards the packets.
297 static_always_inline u32
298 dpdk_device_input (dpdk_main_t * dm, dpdk_device_t * xd,
299 vlib_node_runtime_t * node, u32 thread_index, u16 queue_id,
303 u32 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
304 u32 n_left_to_next, *to_next;
306 vlib_main_t *vm = vlib_get_main ();
307 uword n_rx_bytes = 0;
308 u32 n_trace, trace_cnt __attribute__ ((unused));
309 vlib_buffer_free_list_t *fl;
310 vlib_buffer_t *bt = vec_elt_at_index (dm->buffer_templates, thread_index);
312 if ((xd->flags & DPDK_DEVICE_FLAG_ADMIN_UP) == 0)
315 n_buffers = dpdk_rx_burst (dm, xd, queue_id);
322 vec_reset_length (xd->d_trace_buffers[thread_index]);
323 trace_cnt = n_trace = vlib_get_trace_count (vm, node);
327 u32 n = clib_min (n_trace, n_buffers);
332 struct rte_mbuf *mb = xd->rx_vectors[queue_id][mb_index++];
333 vlib_buffer_t *b = vlib_buffer_from_rte_mbuf (mb);
334 vec_add1 (xd->d_trace_buffers[thread_index],
335 vlib_get_buffer_index (vm, b));
339 fl = vlib_buffer_get_free_list (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
341 /* Update buffer template */
342 vnet_buffer (bt)->sw_if_index[VLIB_RX] = xd->vlib_sw_if_index;
343 bt->error = node->errors[DPDK_ERROR_NONE];
347 while (n_buffers > 0)
349 vlib_buffer_t *b0, *b1, *b2, *b3;
354 u8 error0, error1, error2, error3;
357 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
359 while (n_buffers >= 12 && n_left_to_next >= 4)
361 struct rte_mbuf *mb0, *mb1, *mb2, *mb3;
363 /* prefetches are interleaved with the rest of the code to reduce
364 pressure on L1 cache */
365 dpdk_prefetch_buffer (xd->rx_vectors[queue_id][mb_index + 8]);
366 dpdk_prefetch_ethertype (xd->rx_vectors[queue_id][mb_index + 4]);
368 mb0 = xd->rx_vectors[queue_id][mb_index];
369 mb1 = xd->rx_vectors[queue_id][mb_index + 1];
370 mb2 = xd->rx_vectors[queue_id][mb_index + 2];
371 mb3 = xd->rx_vectors[queue_id][mb_index + 3];
380 if (PREDICT_FALSE (mb0->nb_segs > 1))
381 dpdk_prefetch_buffer (mb0->next);
382 if (PREDICT_FALSE (mb1->nb_segs > 1))
383 dpdk_prefetch_buffer (mb1->next);
384 if (PREDICT_FALSE (mb2->nb_segs > 1))
385 dpdk_prefetch_buffer (mb2->next);
386 if (PREDICT_FALSE (mb3->nb_segs > 1))
387 dpdk_prefetch_buffer (mb3->next);
390 b0 = vlib_buffer_from_rte_mbuf (mb0);
391 b1 = vlib_buffer_from_rte_mbuf (mb1);
392 b2 = vlib_buffer_from_rte_mbuf (mb2);
393 b3 = vlib_buffer_from_rte_mbuf (mb3);
395 dpdk_buffer_init_from_template (b0, b1, b2, b3, bt);
397 dpdk_prefetch_buffer (xd->rx_vectors[queue_id][mb_index + 9]);
398 dpdk_prefetch_ethertype (xd->rx_vectors[queue_id][mb_index + 5]);
400 /* current_data must be set to -RTE_PKTMBUF_HEADROOM in template */
401 b0->current_data += mb0->data_off;
402 b1->current_data += mb1->data_off;
403 b2->current_data += mb2->data_off;
404 b3->current_data += mb3->data_off;
406 b0->current_length = mb0->data_len;
407 b1->current_length = mb1->data_len;
408 b2->current_length = mb2->data_len;
409 b3->current_length = mb3->data_len;
411 dpdk_prefetch_buffer (xd->rx_vectors[queue_id][mb_index + 10]);
412 dpdk_prefetch_ethertype (xd->rx_vectors[queue_id][mb_index + 7]);
414 bi0 = vlib_get_buffer_index (vm, b0);
415 bi1 = vlib_get_buffer_index (vm, b1);
416 bi2 = vlib_get_buffer_index (vm, b2);
417 bi3 = vlib_get_buffer_index (vm, b3);
426 if (PREDICT_FALSE (xd->per_interface_next_index != ~0))
428 next0 = next1 = next2 = next3 = xd->per_interface_next_index;
432 next0 = dpdk_rx_next_from_etype (mb0, b0);
433 next1 = dpdk_rx_next_from_etype (mb1, b1);
434 next2 = dpdk_rx_next_from_etype (mb2, b2);
435 next3 = dpdk_rx_next_from_etype (mb3, b3);
438 dpdk_prefetch_buffer (xd->rx_vectors[queue_id][mb_index + 11]);
439 dpdk_prefetch_ethertype (xd->rx_vectors[queue_id][mb_index + 6]);
441 or_ol_flags = (mb0->ol_flags | mb1->ol_flags |
442 mb2->ol_flags | mb3->ol_flags);
443 if (PREDICT_FALSE (or_ol_flags & PKT_RX_IP_CKSUM_BAD))
445 dpdk_rx_error_from_mb (mb0, &next0, &error0);
446 dpdk_rx_error_from_mb (mb1, &next1, &error1);
447 dpdk_rx_error_from_mb (mb2, &next2, &error2);
448 dpdk_rx_error_from_mb (mb3, &next3, &error3);
449 b0->error = node->errors[error0];
450 b1->error = node->errors[error1];
451 b2->error = node->errors[error2];
452 b3->error = node->errors[error3];
455 vlib_buffer_advance (b0, device_input_next_node_advance[next0]);
456 vlib_buffer_advance (b1, device_input_next_node_advance[next1]);
457 vlib_buffer_advance (b2, device_input_next_node_advance[next2]);
458 vlib_buffer_advance (b3, device_input_next_node_advance[next3]);
460 n_rx_bytes += mb0->pkt_len;
461 n_rx_bytes += mb1->pkt_len;
462 n_rx_bytes += mb2->pkt_len;
463 n_rx_bytes += mb3->pkt_len;
465 /* Process subsequent segments of multi-segment packets */
468 dpdk_process_subseq_segs (vm, b0, mb0, fl);
469 dpdk_process_subseq_segs (vm, b1, mb1, fl);
470 dpdk_process_subseq_segs (vm, b2, mb2, fl);
471 dpdk_process_subseq_segs (vm, b3, mb3, fl);
475 * Turn this on if you run into
476 * "bad monkey" contexts, and you want to know exactly
477 * which nodes they've visited... See main.c...
479 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
480 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
481 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b2);
482 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b3);
484 /* Do we have any driver RX features configured on the interface? */
485 vnet_feature_start_device_input_x4 (xd->vlib_sw_if_index,
486 &next0, &next1, &next2, &next3,
489 vlib_validate_buffer_enqueue_x4 (vm, node, next_index,
490 to_next, n_left_to_next,
492 next0, next1, next2, next3);
496 while (n_buffers > 0 && n_left_to_next > 0)
498 struct rte_mbuf *mb0 = xd->rx_vectors[queue_id][mb_index];
500 if (PREDICT_TRUE (n_buffers > 3))
502 dpdk_prefetch_buffer (xd->rx_vectors[queue_id][mb_index + 2]);
503 dpdk_prefetch_ethertype (xd->rx_vectors[queue_id]
509 b0 = vlib_buffer_from_rte_mbuf (mb0);
511 /* Prefetch one next segment if it exists. */
512 if (PREDICT_FALSE (mb0->nb_segs > 1))
513 dpdk_prefetch_buffer (mb0->next);
515 clib_memcpy (b0, bt, CLIB_CACHE_LINE_BYTES);
517 ASSERT (b0->current_data == -RTE_PKTMBUF_HEADROOM);
518 b0->current_data += mb0->data_off;
519 b0->current_length = mb0->data_len;
521 bi0 = vlib_get_buffer_index (vm, b0);
527 if (PREDICT_FALSE (xd->per_interface_next_index != ~0))
528 next0 = xd->per_interface_next_index;
530 next0 = dpdk_rx_next_from_etype (mb0, b0);
532 dpdk_rx_error_from_mb (mb0, &next0, &error0);
533 b0->error = node->errors[error0];
535 vlib_buffer_advance (b0, device_input_next_node_advance[next0]);
537 n_rx_bytes += mb0->pkt_len;
539 /* Process subsequent segments of multi-segment packets */
540 dpdk_process_subseq_segs (vm, b0, mb0, fl);
543 * Turn this on if you run into
544 * "bad monkey" contexts, and you want to know exactly
545 * which nodes they've visited... See main.c...
547 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
549 /* Do we have any driver RX features configured on the interface? */
550 vnet_feature_start_device_input_x1 (xd->vlib_sw_if_index, &next0,
553 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
554 to_next, n_left_to_next,
559 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
562 if (PREDICT_FALSE (vec_len (xd->d_trace_buffers[thread_index]) > 0))
564 dpdk_rx_trace (dm, node, xd, queue_id,
565 xd->d_trace_buffers[thread_index],
566 vec_len (xd->d_trace_buffers[thread_index]));
567 vlib_set_trace_count (vm, node,
569 vec_len (xd->d_trace_buffers[thread_index]));
572 vlib_increment_combined_counter
573 (vnet_get_main ()->interface_main.combined_sw_if_counters
574 + VNET_INTERFACE_COUNTER_RX,
575 thread_index, xd->vlib_sw_if_index, mb_index, n_rx_bytes);
577 vnet_device_increment_rx_packets (thread_index, mb_index);
583 poll_rate_limit (dpdk_main_t * dm)
585 /* Limit the poll rate by sleeping for N msec between polls */
586 if (PREDICT_FALSE (dm->poll_sleep_usec != 0))
588 struct timespec ts, tsrem;
591 ts.tv_nsec = 1000 * dm->poll_sleep_usec;
593 while (nanosleep (&ts, &tsrem) < 0)
600 /** \brief Main DPDK input node
603 This is the main DPDK input node: across each assigned interface,
604 call rte_eth_rx_burst(...) or similar to obtain a vector of
605 packets to process. Handle early packet discard. Derive @c
606 vlib_buffer_t metadata from <code>struct rte_mbuf</code> metadata,
607 Depending on the resulting metadata: adjust <code>b->current_data,
608 b->current_length </code> and dispatch directly to
609 ip4-input-no-checksum, or ip6-input. Trace the packet if required.
611 @param vm vlib_main_t corresponding to the current thread
612 @param node vlib_node_runtime_t
613 @param f vlib_frame_t input-node, not used.
615 @par Graph mechanics: buffer metadata, next index usage
618 - <code>struct rte_mbuf mb->ol_flags</code>
619 - PKT_RX_IP_CKSUM_BAD
620 - <code> RTE_ETH_IS_xxx_HDR(mb->packet_type) </code>
621 - packet classification result
624 - <code>b->error</code> if the packet is to be dropped immediately
625 - <code>b->current_data, b->current_length</code>
626 - adjusted as needed to skip the L2 header in direct-dispatch cases
627 - <code>vnet_buffer(b)->sw_if_index[VLIB_RX]</code>
628 - rx interface sw_if_index
629 - <code>vnet_buffer(b)->sw_if_index[VLIB_TX] = ~0</code>
630 - required by ipX-lookup
631 - <code>b->flags</code>
632 - to indicate multi-segment pkts (VLIB_BUFFER_NEXT_PRESENT), etc.
635 - Static arcs to: error-drop, ethernet-input,
636 ip4-input-no-checksum, ip6-input, mpls-input
637 - per-interface redirection, controlled by
638 <code>xd->per_interface_next_index</code>
642 dpdk_input (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * f)
644 dpdk_main_t *dm = &dpdk_main;
646 uword n_rx_packets = 0;
647 vnet_device_input_runtime_t *rt = (void *) node->runtime_data;
648 vnet_device_and_queue_t *dq;
649 u32 thread_index = node->thread_index;
652 * Poll all devices on this cpu for input/interrupts.
655 foreach_device_and_queue (dq, rt->devices_and_queues)
657 xd = vec_elt_at_index(dm->devices, dq->dev_instance);
658 if (xd->flags & DPDK_DEVICE_FLAG_MAYBE_MULTISEG)
659 n_rx_packets += dpdk_device_input (dm, xd, node, thread_index, dq->queue_id, /* maybe_multiseg */ 1);
661 n_rx_packets += dpdk_device_input (dm, xd, node, thread_index, dq->queue_id, /* maybe_multiseg */ 0);
665 poll_rate_limit (dm);
671 VLIB_REGISTER_NODE (dpdk_input_node) = {
672 .function = dpdk_input,
673 .type = VLIB_NODE_TYPE_INPUT,
674 .name = "dpdk-input",
675 .sibling_of = "device-input",
677 /* Will be enabled if/when hardware is detected. */
678 .state = VLIB_NODE_STATE_DISABLED,
680 .format_buffer = format_ethernet_header_with_length,
681 .format_trace = format_dpdk_rx_dma_trace,
683 .n_errors = DPDK_N_ERROR,
684 .error_strings = dpdk_error_strings,
687 VLIB_NODE_FUNCTION_MULTIARCH (dpdk_input_node, dpdk_input);
691 * fd.io coding-style-patch-verification: ON
694 * eval: (c-set-style "gnu")