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 *) b->data;
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 *) b->data;
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 *) b->data;
55 return (h->type == clib_host_to_net_u16 (ETHERNET_TYPE_MPLS_UNICAST));
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_error_from_mb (struct rte_mbuf *mb, u32 * next, u8 * error)
79 if (mb->ol_flags & PKT_RX_IP_CKSUM_BAD)
81 *error = DPDK_ERROR_IP_CHECKSUM_ERROR;
82 *next = VNET_DEVICE_INPUT_NEXT_DROP;
85 *error = DPDK_ERROR_NONE;
89 dpdk_rx_trace (dpdk_main_t * dm,
90 vlib_node_runtime_t * node,
92 u16 queue_id, u32 * buffers, uword n_buffers)
94 vlib_main_t *vm = vlib_get_main ();
105 dpdk_rx_dma_trace_t *t0;
112 b0 = vlib_get_buffer (vm, bi0);
113 mb = rte_mbuf_from_vlib_buffer (b0);
115 if (PREDICT_FALSE (xd->per_interface_next_index != ~0))
116 next0 = xd->per_interface_next_index;
118 next0 = dpdk_rx_next_from_etype (mb, b0);
120 dpdk_rx_error_from_mb (mb, &next0, &error0);
122 vlib_trace_buffer (vm, node, next0, b0, /* follow_chain */ 0);
123 t0 = vlib_add_trace (vm, node, b0, sizeof (t0[0]));
124 t0->queue_index = queue_id;
125 t0->device_index = xd->device_index;
126 t0->buffer_index = bi0;
128 clib_memcpy (&t0->mb, mb, sizeof (t0->mb));
129 clib_memcpy (&t0->buffer, b0, sizeof (b0[0]) - sizeof (b0->pre_data));
130 clib_memcpy (t0->buffer.pre_data, b0->data,
131 sizeof (t0->buffer.pre_data));
132 clib_memcpy (&t0->data, mb->buf_addr + mb->data_off, sizeof (t0->data));
139 dpdk_rx_burst (dpdk_main_t * dm, dpdk_device_t * xd, u16 queue_id)
145 n_left = VLIB_FRAME_SIZE;
148 if (PREDICT_TRUE (xd->flags & DPDK_DEVICE_FLAG_PMD))
152 n_this_chunk = rte_eth_rx_burst (xd->device_index, queue_id,
153 xd->rx_vectors[queue_id] +
155 n_buffers += n_this_chunk;
156 n_left -= n_this_chunk;
158 /* Empirically, DPDK r1.8 produces vectors w/ 32 or fewer elts */
159 if (n_this_chunk < 32)
172 static_always_inline void
173 dpdk_process_subseq_segs (vlib_main_t * vm, vlib_buffer_t * b,
174 struct rte_mbuf *mb, vlib_buffer_free_list_t * fl)
177 struct rte_mbuf *mb_seg = 0;
178 vlib_buffer_t *b_seg, *b_chain = 0;
182 while ((mb->nb_segs > 1) && (nb_seg < mb->nb_segs))
184 ASSERT (mb_seg != 0);
186 b_seg = vlib_buffer_from_rte_mbuf (mb_seg);
187 vlib_buffer_init_for_free_list (b_seg, fl);
189 ASSERT ((b_seg->flags & VLIB_BUFFER_NEXT_PRESENT) == 0);
190 ASSERT (b_seg->current_data == 0);
193 * The driver (e.g. virtio) may not put the packet data at the start
194 * of the segment, so don't assume b_seg->current_data == 0 is correct.
196 b_seg->current_data =
197 (mb_seg->buf_addr + mb_seg->data_off) - (void *) b_seg->data;
199 b_seg->current_length = mb_seg->data_len;
200 b->total_length_not_including_first_buffer += mb_seg->data_len;
202 b_chain->flags |= VLIB_BUFFER_NEXT_PRESENT;
203 b_chain->next_buffer = vlib_get_buffer_index (vm, b_seg);
206 mb_seg = mb_seg->next;
211 static_always_inline void
212 dpdk_prefetch_buffer (struct rte_mbuf *mb)
214 vlib_buffer_t *b = vlib_buffer_from_rte_mbuf (mb);
215 CLIB_PREFETCH (mb, CLIB_CACHE_LINE_BYTES, LOAD);
216 CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, STORE);
219 static_always_inline void
220 dpdk_prefetch_buffer_data (struct rte_mbuf *mb)
222 vlib_buffer_t *b = vlib_buffer_from_rte_mbuf (mb);
223 CLIB_PREFETCH (b->data, CLIB_CACHE_LINE_BYTES, STORE);
227 * This function is used when there are no worker threads.
228 * The main thread performs IO and forwards the packets.
230 static_always_inline u32
231 dpdk_device_input (dpdk_main_t * dm, dpdk_device_t * xd,
232 vlib_node_runtime_t * node, u32 cpu_index, u16 queue_id)
235 u32 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
236 u32 n_left_to_next, *to_next;
238 vlib_main_t *vm = vlib_get_main ();
239 uword n_rx_bytes = 0;
240 u32 n_trace, trace_cnt __attribute__ ((unused));
241 vlib_buffer_free_list_t *fl;
242 u32 buffer_flags_template;
244 if ((xd->flags & DPDK_DEVICE_FLAG_ADMIN_UP) == 0)
247 n_buffers = dpdk_rx_burst (dm, xd, queue_id);
254 buffer_flags_template = dm->buffer_flags_template;
256 vec_reset_length (xd->d_trace_buffers[cpu_index]);
257 trace_cnt = n_trace = vlib_get_trace_count (vm, node);
261 u32 n = clib_min (n_trace, n_buffers);
266 struct rte_mbuf *mb = xd->rx_vectors[queue_id][mb_index++];
267 vlib_buffer_t *b = vlib_buffer_from_rte_mbuf (mb);
268 vec_add1 (xd->d_trace_buffers[cpu_index],
269 vlib_get_buffer_index (vm, b));
273 fl = vlib_buffer_get_free_list (vm, VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
277 while (n_buffers > 0)
279 vlib_buffer_t *b0, *b1, *b2, *b3;
280 u32 bi0, next0, l3_offset0;
281 u32 bi1, next1, l3_offset1;
282 u32 bi2, next2, l3_offset2;
283 u32 bi3, next3, l3_offset3;
284 u8 error0, error1, error2, error3;
287 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
289 while (n_buffers > 8 && n_left_to_next > 4)
291 struct rte_mbuf *mb0 = xd->rx_vectors[queue_id][mb_index];
292 struct rte_mbuf *mb1 = xd->rx_vectors[queue_id][mb_index + 1];
293 struct rte_mbuf *mb2 = xd->rx_vectors[queue_id][mb_index + 2];
294 struct rte_mbuf *mb3 = xd->rx_vectors[queue_id][mb_index + 3];
296 dpdk_prefetch_buffer (xd->rx_vectors[queue_id][mb_index + 4]);
297 dpdk_prefetch_buffer (xd->rx_vectors[queue_id][mb_index + 5]);
298 dpdk_prefetch_buffer (xd->rx_vectors[queue_id][mb_index + 6]);
299 dpdk_prefetch_buffer (xd->rx_vectors[queue_id][mb_index + 7]);
301 if (xd->flags & DPDK_DEVICE_FLAG_MAYBE_MULTISEG)
303 if (PREDICT_FALSE (mb0->nb_segs > 1))
304 dpdk_prefetch_buffer (mb0->next);
305 if (PREDICT_FALSE (mb1->nb_segs > 1))
306 dpdk_prefetch_buffer (mb1->next);
307 if (PREDICT_FALSE (mb2->nb_segs > 1))
308 dpdk_prefetch_buffer (mb2->next);
309 if (PREDICT_FALSE (mb3->nb_segs > 1))
310 dpdk_prefetch_buffer (mb3->next);
318 or_ol_flags = (mb0->ol_flags | mb1->ol_flags |
319 mb2->ol_flags | mb3->ol_flags);
320 b0 = vlib_buffer_from_rte_mbuf (mb0);
321 b1 = vlib_buffer_from_rte_mbuf (mb1);
322 b2 = vlib_buffer_from_rte_mbuf (mb2);
323 b3 = vlib_buffer_from_rte_mbuf (mb3);
325 vlib_buffer_init_for_free_list (b0, fl);
326 vlib_buffer_init_for_free_list (b1, fl);
327 vlib_buffer_init_for_free_list (b2, fl);
328 vlib_buffer_init_for_free_list (b3, fl);
330 bi0 = vlib_get_buffer_index (vm, b0);
331 bi1 = vlib_get_buffer_index (vm, b1);
332 bi2 = vlib_get_buffer_index (vm, b2);
333 bi3 = vlib_get_buffer_index (vm, b3);
342 if (PREDICT_FALSE (xd->per_interface_next_index != ~0))
344 next0 = next1 = next2 = next3 = xd->per_interface_next_index;
348 /* prefetch packet data for faster access to the ethertype */
349 dpdk_prefetch_buffer_data (xd->rx_vectors[queue_id]
351 dpdk_prefetch_buffer_data (xd->rx_vectors[queue_id]
353 dpdk_prefetch_buffer_data (xd->rx_vectors[queue_id]
355 dpdk_prefetch_buffer_data (xd->rx_vectors[queue_id]
357 next0 = dpdk_rx_next_from_etype (mb0, b0);
358 next1 = dpdk_rx_next_from_etype (mb1, b1);
359 next2 = dpdk_rx_next_from_etype (mb2, b2);
360 next3 = dpdk_rx_next_from_etype (mb3, b3);
363 if (PREDICT_FALSE (or_ol_flags & PKT_RX_IP_CKSUM_BAD))
365 dpdk_rx_error_from_mb (mb0, &next0, &error0);
366 dpdk_rx_error_from_mb (mb1, &next1, &error1);
367 dpdk_rx_error_from_mb (mb2, &next2, &error2);
368 dpdk_rx_error_from_mb (mb3, &next3, &error3);
369 b0->error = node->errors[error0];
370 b1->error = node->errors[error1];
371 b2->error = node->errors[error2];
372 b3->error = node->errors[error3];
376 b0->error = b1->error = node->errors[DPDK_ERROR_NONE];
377 b2->error = b3->error = node->errors[DPDK_ERROR_NONE];
380 l3_offset0 = device_input_next_node_advance[next0];
381 l3_offset1 = device_input_next_node_advance[next1];
382 l3_offset2 = device_input_next_node_advance[next2];
383 l3_offset3 = device_input_next_node_advance[next3];
385 b0->current_data = l3_offset0 + mb0->data_off;
386 b1->current_data = l3_offset1 + mb1->data_off;
387 b2->current_data = l3_offset2 + mb2->data_off;
388 b3->current_data = l3_offset3 + mb3->data_off;
390 b0->current_data -= RTE_PKTMBUF_HEADROOM;
391 b1->current_data -= RTE_PKTMBUF_HEADROOM;
392 b2->current_data -= RTE_PKTMBUF_HEADROOM;
393 b3->current_data -= RTE_PKTMBUF_HEADROOM;
395 b0->current_length = mb0->data_len - l3_offset0;
396 b1->current_length = mb1->data_len - l3_offset1;
397 b2->current_length = mb2->data_len - l3_offset2;
398 b3->current_length = mb3->data_len - l3_offset3;
400 b0->flags = buffer_flags_template;
401 b1->flags = buffer_flags_template;
402 b2->flags = buffer_flags_template;
403 b3->flags = buffer_flags_template;
405 vnet_buffer (b0)->sw_if_index[VLIB_RX] = xd->vlib_sw_if_index;
406 vnet_buffer (b1)->sw_if_index[VLIB_RX] = xd->vlib_sw_if_index;
407 vnet_buffer (b2)->sw_if_index[VLIB_RX] = xd->vlib_sw_if_index;
408 vnet_buffer (b3)->sw_if_index[VLIB_RX] = xd->vlib_sw_if_index;
410 vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
411 vnet_buffer (b1)->sw_if_index[VLIB_TX] = (u32) ~ 0;
412 vnet_buffer (b2)->sw_if_index[VLIB_TX] = (u32) ~ 0;
413 vnet_buffer (b3)->sw_if_index[VLIB_TX] = (u32) ~ 0;
415 n_rx_bytes += mb0->pkt_len;
416 n_rx_bytes += mb1->pkt_len;
417 n_rx_bytes += mb2->pkt_len;
418 n_rx_bytes += mb3->pkt_len;
420 /* Process subsequent segments of multi-segment packets */
421 if (xd->flags & DPDK_DEVICE_FLAG_MAYBE_MULTISEG)
423 dpdk_process_subseq_segs (vm, b0, mb0, fl);
424 dpdk_process_subseq_segs (vm, b1, mb1, fl);
425 dpdk_process_subseq_segs (vm, b2, mb2, fl);
426 dpdk_process_subseq_segs (vm, b3, mb3, fl);
430 * Turn this on if you run into
431 * "bad monkey" contexts, and you want to know exactly
432 * which nodes they've visited... See main.c...
434 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
435 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
436 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b2);
437 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b3);
439 /* Do we have any driver RX features configured on the interface? */
440 vnet_feature_start_device_input_x4 (xd->vlib_sw_if_index,
441 &next0, &next1, &next2, &next3,
443 l3_offset0, l3_offset1,
444 l3_offset2, l3_offset3);
446 vlib_validate_buffer_enqueue_x4 (vm, node, next_index,
447 to_next, n_left_to_next,
449 next0, next1, next2, next3);
453 while (n_buffers > 0 && n_left_to_next > 0)
455 struct rte_mbuf *mb0 = xd->rx_vectors[queue_id][mb_index];
459 b0 = vlib_buffer_from_rte_mbuf (mb0);
461 /* Prefetch one next segment if it exists. */
462 if (PREDICT_FALSE (mb0->nb_segs > 1))
463 dpdk_prefetch_buffer (mb0->next);
465 vlib_buffer_init_for_free_list (b0, fl);
467 bi0 = vlib_get_buffer_index (vm, b0);
473 if (PREDICT_FALSE (xd->per_interface_next_index != ~0))
474 next0 = xd->per_interface_next_index;
476 next0 = dpdk_rx_next_from_etype (mb0, b0);
478 dpdk_rx_error_from_mb (mb0, &next0, &error0);
479 b0->error = node->errors[error0];
481 l3_offset0 = device_input_next_node_advance[next0];
483 b0->current_data = l3_offset0;
484 b0->current_data += mb0->data_off - RTE_PKTMBUF_HEADROOM;
485 b0->current_length = mb0->data_len - l3_offset0;
487 b0->flags = buffer_flags_template;
489 vnet_buffer (b0)->sw_if_index[VLIB_RX] = xd->vlib_sw_if_index;
490 vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
491 n_rx_bytes += mb0->pkt_len;
493 /* Process subsequent segments of multi-segment packets */
494 dpdk_process_subseq_segs (vm, b0, mb0, fl);
497 * Turn this on if you run into
498 * "bad monkey" contexts, and you want to know exactly
499 * which nodes they've visited... See main.c...
501 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
503 /* Do we have any driver RX features configured on the interface? */
504 vnet_feature_start_device_input_x1 (xd->vlib_sw_if_index, &next0,
507 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
508 to_next, n_left_to_next,
513 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
516 if (PREDICT_FALSE (vec_len (xd->d_trace_buffers[cpu_index]) > 0))
518 dpdk_rx_trace (dm, node, xd, queue_id, xd->d_trace_buffers[cpu_index],
519 vec_len (xd->d_trace_buffers[cpu_index]));
520 vlib_set_trace_count (vm, node, n_trace -
521 vec_len (xd->d_trace_buffers[cpu_index]));
524 vlib_increment_combined_counter
525 (vnet_get_main ()->interface_main.combined_sw_if_counters
526 + VNET_INTERFACE_COUNTER_RX,
527 cpu_index, xd->vlib_sw_if_index, mb_index, n_rx_bytes);
529 vnet_device_increment_rx_packets (cpu_index, mb_index);
535 poll_rate_limit (dpdk_main_t * dm)
537 /* Limit the poll rate by sleeping for N msec between polls */
538 if (PREDICT_FALSE (dm->poll_sleep != 0))
540 struct timespec ts, tsrem;
543 ts.tv_nsec = 1000 * 1000 * dm->poll_sleep; /* 1ms */
545 while (nanosleep (&ts, &tsrem) < 0)
552 /** \brief Main DPDK input node
555 This is the main DPDK input node: across each assigned interface,
556 call rte_eth_rx_burst(...) or similar to obtain a vector of
557 packets to process. Handle early packet discard. Derive @c
558 vlib_buffer_t metadata from <code>struct rte_mbuf</code> metadata,
559 Depending on the resulting metadata: adjust <code>b->current_data,
560 b->current_length </code> and dispatch directly to
561 ip4-input-no-checksum, or ip6-input. Trace the packet if required.
563 @param vm vlib_main_t corresponding to the current thread
564 @param node vlib_node_runtime_t
565 @param f vlib_frame_t input-node, not used.
567 @par Graph mechanics: buffer metadata, next index usage
570 - <code>struct rte_mbuf mb->ol_flags</code>
571 - PKT_RX_IP_CKSUM_BAD
572 - <code> RTE_ETH_IS_xxx_HDR(mb->packet_type) </code>
573 - packet classification result
576 - <code>b->error</code> if the packet is to be dropped immediately
577 - <code>b->current_data, b->current_length</code>
578 - adjusted as needed to skip the L2 header in direct-dispatch cases
579 - <code>vnet_buffer(b)->sw_if_index[VLIB_RX]</code>
580 - rx interface sw_if_index
581 - <code>vnet_buffer(b)->sw_if_index[VLIB_TX] = ~0</code>
582 - required by ipX-lookup
583 - <code>b->flags</code>
584 - to indicate multi-segment pkts (VLIB_BUFFER_NEXT_PRESENT), etc.
587 - Static arcs to: error-drop, ethernet-input,
588 ip4-input-no-checksum, ip6-input, mpls-input
589 - per-interface redirection, controlled by
590 <code>xd->per_interface_next_index</code>
594 dpdk_input (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * f)
596 dpdk_main_t *dm = &dpdk_main;
598 uword n_rx_packets = 0;
599 dpdk_device_and_queue_t *dq;
600 u32 cpu_index = os_get_cpu_number ();
603 * Poll all devices on this cpu for input/interrupts.
606 vec_foreach (dq, dm->devices_by_cpu[cpu_index])
608 xd = vec_elt_at_index(dm->devices, dq->device);
609 n_rx_packets += dpdk_device_input (dm, xd, node, cpu_index, dq->queue_id);
613 poll_rate_limit (dm);
619 VLIB_REGISTER_NODE (dpdk_input_node) = {
620 .function = dpdk_input,
621 .type = VLIB_NODE_TYPE_INPUT,
622 .name = "dpdk-input",
623 .sibling_of = "device-input",
625 /* Will be enabled if/when hardware is detected. */
626 .state = VLIB_NODE_STATE_DISABLED,
628 .format_buffer = format_ethernet_header_with_length,
629 .format_trace = format_dpdk_rx_dma_trace,
631 .n_errors = DPDK_N_ERROR,
632 .error_strings = dpdk_error_strings,
635 VLIB_NODE_FUNCTION_MULTIARCH (dpdk_input_node, dpdk_input);
639 * fd.io coding-style-patch-verification: ON
642 * eval: (c-set-style "gnu")