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/buffer.h>
23 #include <dpdk/device/dpdk.h>
24 #include <vnet/classify/vnet_classify.h>
25 #include <vnet/mpls/packet.h>
26 #include <vnet/devices/devices.h>
27 #include <vnet/interface/rx_queue_funcs.h>
28 #include <vnet/feature/feature.h>
29 #include <vnet/tcp/tcp_packet.h>
31 #include <dpdk/device/dpdk_priv.h>
33 static char *dpdk_error_strings[] = {
39 /* make sure all flags we need are stored in lower 32 bits */
40 STATIC_ASSERT ((u64) (RTE_MBUF_F_RX_IP_CKSUM_BAD | RTE_MBUF_F_RX_L4_CKSUM_BAD |
41 RTE_MBUF_F_RX_FDIR | RTE_MBUF_F_RX_LRO) < (1ULL << 32),
42 "dpdk flags not in lower word, fix needed");
44 STATIC_ASSERT (RTE_MBUF_F_RX_L4_CKSUM_BAD == (1ULL << 3),
45 "bit number of RTE_MBUF_F_RX_L4_CKSUM_BAD is no longer 3!");
47 static_always_inline uword
48 dpdk_process_subseq_segs (vlib_main_t * vm, vlib_buffer_t * b,
49 struct rte_mbuf *mb, vlib_buffer_t * bt)
52 struct rte_mbuf *mb_seg = 0;
53 vlib_buffer_t *b_seg, *b_chain = 0;
60 b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
61 b->total_length_not_including_first_buffer = 0;
63 while (nb_seg < mb->nb_segs)
67 b_seg = vlib_buffer_from_rte_mbuf (mb_seg);
68 vlib_buffer_copy_template (b_seg, bt);
71 * The driver (e.g. virtio) may not put the packet data at the start
72 * of the segment, so don't assume b_seg->current_data == 0 is correct.
75 (mb_seg->buf_addr + mb_seg->data_off) - (void *) b_seg->data;
77 b_seg->current_length = mb_seg->data_len;
78 b->total_length_not_including_first_buffer += mb_seg->data_len;
80 b_chain->flags |= VLIB_BUFFER_NEXT_PRESENT;
81 b_chain->next_buffer = vlib_get_buffer_index (vm, b_seg);
84 mb_seg = mb_seg->next;
87 return b->total_length_not_including_first_buffer;
90 static_always_inline void
91 dpdk_prefetch_mbuf_x4 (struct rte_mbuf *mb[])
93 clib_prefetch_load (mb[0]);
94 clib_prefetch_load (mb[1]);
95 clib_prefetch_load (mb[2]);
96 clib_prefetch_load (mb[3]);
99 static_always_inline void
100 dpdk_prefetch_buffer_x4 (struct rte_mbuf *mb[])
103 b = vlib_buffer_from_rte_mbuf (mb[0]);
104 clib_prefetch_store (b);
105 b = vlib_buffer_from_rte_mbuf (mb[1]);
106 clib_prefetch_store (b);
107 b = vlib_buffer_from_rte_mbuf (mb[2]);
108 clib_prefetch_store (b);
109 b = vlib_buffer_from_rte_mbuf (mb[3]);
110 clib_prefetch_store (b);
113 /** \brief Main DPDK input node
116 This is the main DPDK input node: across each assigned interface,
117 call rte_eth_rx_burst(...) or similar to obtain a vector of
118 packets to process. Derive @c vlib_buffer_t metadata from
119 <code>struct rte_mbuf</code> metadata,
120 Depending on the resulting metadata: adjust <code>b->current_data,
121 b->current_length </code> and dispatch directly to
122 ip4-input-no-checksum, or ip6-input. Trace the packet if required.
124 @param vm vlib_main_t corresponding to the current thread
125 @param node vlib_node_runtime_t
126 @param f vlib_frame_t input-node, not used.
128 @par Graph mechanics: buffer metadata, next index usage
131 - <code>struct rte_mbuf mb->ol_flags</code>
132 - RTE_MBUF_F_RX_IP_CKSUM_BAD
135 - <code>b->error</code> if the packet is to be dropped immediately
136 - <code>b->current_data, b->current_length</code>
137 - adjusted as needed to skip the L2 header in direct-dispatch cases
138 - <code>vnet_buffer(b)->sw_if_index[VLIB_RX]</code>
139 - rx interface sw_if_index
140 - <code>vnet_buffer(b)->sw_if_index[VLIB_TX] = ~0</code>
141 - required by ipX-lookup
142 - <code>b->flags</code>
143 - to indicate multi-segment pkts (VLIB_BUFFER_NEXT_PRESENT), etc.
146 - Static arcs to: error-drop, ethernet-input,
147 ip4-input-no-checksum, ip6-input, mpls-input
148 - per-interface redirection, controlled by
149 <code>xd->per_interface_next_index</code>
152 static_always_inline u32
153 dpdk_ol_flags_extract (struct rte_mbuf **mb, u32 *flags, int count)
157 for (i = 0; i < count; i++)
159 /* all flags we are interested in are in lower 8 bits but
161 flags[i] = (u32) mb[i]->ol_flags;
167 static_always_inline uword
168 dpdk_process_rx_burst (vlib_main_t *vm, dpdk_per_thread_data_t *ptd,
169 uword n_rx_packets, int maybe_multiseg, u32 *or_flagsp)
171 u32 n_left = n_rx_packets;
173 struct rte_mbuf **mb = ptd->mbufs;
175 u32 *flags, or_flags = 0;
181 /* copy template into local variable - will save per packet load */
182 vlib_buffer_copy_template (&bt, &ptd->buffer_template);
185 dpdk_prefetch_buffer_x4 (mb + 4);
187 b[0] = vlib_buffer_from_rte_mbuf (mb[0]);
188 b[1] = vlib_buffer_from_rte_mbuf (mb[1]);
189 b[2] = vlib_buffer_from_rte_mbuf (mb[2]);
190 b[3] = vlib_buffer_from_rte_mbuf (mb[3]);
192 vlib_buffer_copy_template (b[0], &bt);
193 vlib_buffer_copy_template (b[1], &bt);
194 vlib_buffer_copy_template (b[2], &bt);
195 vlib_buffer_copy_template (b[3], &bt);
197 dpdk_prefetch_mbuf_x4 (mb + 4);
199 or_flags |= dpdk_ol_flags_extract (mb, flags, 4);
202 b[0]->current_data = mb[0]->data_off - RTE_PKTMBUF_HEADROOM;
203 n_bytes += b[0]->current_length = mb[0]->data_len;
205 b[1]->current_data = mb[1]->data_off - RTE_PKTMBUF_HEADROOM;
206 n_bytes += b[1]->current_length = mb[1]->data_len;
208 b[2]->current_data = mb[2]->data_off - RTE_PKTMBUF_HEADROOM;
209 n_bytes += b[2]->current_length = mb[2]->data_len;
211 b[3]->current_data = mb[3]->data_off - RTE_PKTMBUF_HEADROOM;
212 n_bytes += b[3]->current_length = mb[3]->data_len;
216 n_bytes += dpdk_process_subseq_segs (vm, b[0], mb[0], &bt);
217 n_bytes += dpdk_process_subseq_segs (vm, b[1], mb[1], &bt);
218 n_bytes += dpdk_process_subseq_segs (vm, b[2], mb[2], &bt);
219 n_bytes += dpdk_process_subseq_segs (vm, b[3], mb[3], &bt);
229 b[0] = vlib_buffer_from_rte_mbuf (mb[0]);
230 vlib_buffer_copy_template (b[0], &bt);
231 or_flags |= dpdk_ol_flags_extract (mb, flags, 1);
234 b[0]->current_data = mb[0]->data_off - RTE_PKTMBUF_HEADROOM;
235 n_bytes += b[0]->current_length = mb[0]->data_len;
238 n_bytes += dpdk_process_subseq_segs (vm, b[0], mb[0], &bt);
245 *or_flagsp = or_flags;
249 static_always_inline void
250 dpdk_process_flow_offload (dpdk_device_t * xd, dpdk_per_thread_data_t * ptd,
254 dpdk_flow_lookup_entry_t *fle;
257 /* TODO prefetch and quad-loop */
258 for (n = 0; n < n_rx_packets; n++)
260 if ((ptd->flags[n] & RTE_MBUF_F_RX_FDIR_ID) == 0)
263 fle = pool_elt_at_index (xd->flow_lookup_entries,
264 ptd->mbufs[n]->hash.fdir.hi);
266 if (fle->next_index != (u16) ~ 0)
267 ptd->next[n] = fle->next_index;
269 if (fle->flow_id != ~0)
271 b0 = vlib_buffer_from_rte_mbuf (ptd->mbufs[n]);
272 b0->flow_id = fle->flow_id;
275 if (fle->buffer_advance != ~0)
277 b0 = vlib_buffer_from_rte_mbuf (ptd->mbufs[n]);
278 vlib_buffer_advance (b0, fle->buffer_advance);
283 static_always_inline u16
284 dpdk_lro_find_l4_hdr_sz (vlib_buffer_t *b)
287 u16 current_offset = 0;
288 ethernet_header_t *e;
290 u8 *data = vlib_buffer_get_current (b);
293 current_offset += sizeof (e[0]);
294 ethertype = clib_net_to_host_u16 (e->type);
295 if (ethernet_frame_is_tagged (ethertype))
297 ethernet_vlan_header_t *vlan = (ethernet_vlan_header_t *) (e + 1);
298 ethertype = clib_net_to_host_u16 (vlan->type);
299 current_offset += sizeof (*vlan);
300 if (ethertype == ETHERNET_TYPE_VLAN)
303 current_offset += sizeof (*vlan);
304 ethertype = clib_net_to_host_u16 (vlan->type);
307 data += current_offset;
308 if (ethertype == ETHERNET_TYPE_IP4)
310 data += sizeof (ip4_header_t);
312 l4_hdr_sz = tcp_header_bytes (tcp);
316 /* FIXME: extension headers...*/
317 data += sizeof (ip6_header_t);
319 l4_hdr_sz = tcp_header_bytes (tcp);
324 static_always_inline void
325 dpdk_process_lro_offload (dpdk_device_t *xd, dpdk_per_thread_data_t *ptd,
330 for (n = 0; n < n_rx_packets; n++)
332 b0 = vlib_buffer_from_rte_mbuf (ptd->mbufs[n]);
333 if (ptd->flags[n] & RTE_MBUF_F_RX_LRO)
335 b0->flags |= VNET_BUFFER_F_GSO;
336 vnet_buffer2 (b0)->gso_size = ptd->mbufs[n]->tso_segsz;
337 vnet_buffer2 (b0)->gso_l4_hdr_sz = dpdk_lro_find_l4_hdr_sz (b0);
342 static_always_inline u32
343 dpdk_device_input (vlib_main_t * vm, dpdk_main_t * dm, dpdk_device_t * xd,
344 vlib_node_runtime_t * node, u32 thread_index, u16 queue_id)
346 uword n_rx_packets = 0, n_rx_bytes;
347 dpdk_rx_queue_t *rxq = vec_elt_at_index (xd->rx_queues, queue_id);
350 u32 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
351 struct rte_mbuf **mb;
358 dpdk_per_thread_data_t *ptd = vec_elt_at_index (dm->per_thread_data,
360 vlib_buffer_t *bt = &ptd->buffer_template;
362 if ((xd->flags & DPDK_DEVICE_FLAG_ADMIN_UP) == 0)
365 /* get up to DPDK_RX_BURST_SZ buffers from PMD */
366 while (n_rx_packets < DPDK_RX_BURST_SZ)
368 n = rte_eth_rx_burst (xd->port_id, queue_id,
369 ptd->mbufs + n_rx_packets,
370 DPDK_RX_BURST_SZ - n_rx_packets);
377 if (n_rx_packets == 0)
380 /* Update buffer template */
381 vnet_buffer (bt)->sw_if_index[VLIB_RX] = xd->sw_if_index;
382 bt->error = node->errors[DPDK_ERROR_NONE];
383 bt->flags = xd->buffer_flags;
384 /* as DPDK is allocating empty buffers from mempool provided before interface
385 start for each queue, it is safe to store this in the template */
386 bt->buffer_pool_index = rxq->buffer_pool_index;
388 vnet_buffer (bt)->feature_arc_index = 0;
389 bt->current_config_index = 0;
391 /* receive burst of packets from DPDK PMD */
392 if (PREDICT_FALSE (xd->per_interface_next_index != ~0))
393 next_index = xd->per_interface_next_index;
395 /* as all packets belong to the same interface feature arc lookup
396 can be don once and result stored in the buffer template */
397 if (PREDICT_FALSE (vnet_device_input_have_features (xd->sw_if_index)))
398 vnet_feature_start_device_input_x1 (xd->sw_if_index, &next_index, bt);
400 if (xd->flags & DPDK_DEVICE_FLAG_MAYBE_MULTISEG)
401 n_rx_bytes = dpdk_process_rx_burst (vm, ptd, n_rx_packets, 1, &or_flags);
403 n_rx_bytes = dpdk_process_rx_burst (vm, ptd, n_rx_packets, 0, &or_flags);
405 if (PREDICT_FALSE ((or_flags & RTE_MBUF_F_RX_LRO)))
406 dpdk_process_lro_offload (xd, ptd, n_rx_packets);
408 if (PREDICT_FALSE ((or_flags & RTE_MBUF_F_RX_L4_CKSUM_BAD) &&
409 (xd->buffer_flags & VNET_BUFFER_F_L4_CHECKSUM_CORRECT)))
411 for (n = 0; n < n_rx_packets; n++)
413 /* Check and reset VNET_BUFFER_F_L4_CHECKSUM_CORRECT flag
414 if RTE_MBUF_F_RX_L4_CKSUM_BAD is set.
415 The magic num 3 is the bit number of RTE_MBUF_F_RX_L4_CKSUM_BAD
416 which is defined in DPDK.
417 Have made a STATIC_ASSERT in this file to ensure this.
419 b0 = vlib_buffer_from_rte_mbuf (ptd->mbufs[n]);
420 b0->flags ^= (ptd->flags[n] & RTE_MBUF_F_RX_L4_CKSUM_BAD)
421 << (VNET_BUFFER_F_LOG2_L4_CHECKSUM_CORRECT - 3);
425 if (PREDICT_FALSE (or_flags & RTE_MBUF_F_RX_FDIR))
427 /* some packets will need to go to different next nodes */
428 for (n = 0; n < n_rx_packets; n++)
429 ptd->next[n] = next_index;
431 /* flow offload - process if rx flow offload enabled and at least one
433 if (PREDICT_FALSE ((xd->flags & DPDK_DEVICE_FLAG_RX_FLOW_OFFLOAD) &&
434 (or_flags & RTE_MBUF_F_RX_FDIR)))
435 dpdk_process_flow_offload (xd, ptd, n_rx_packets);
437 /* enqueue buffers to the next node */
438 vlib_get_buffer_indices_with_offset (vm, (void **) ptd->mbufs,
439 ptd->buffers, n_rx_packets,
440 sizeof (struct rte_mbuf));
442 vlib_buffer_enqueue_to_next (vm, node, ptd->buffers, ptd->next,
447 u32 *to_next, n_left_to_next;
449 vlib_get_new_next_frame (vm, node, next_index, to_next, n_left_to_next);
450 vlib_get_buffer_indices_with_offset (vm, (void **) ptd->mbufs, to_next,
452 sizeof (struct rte_mbuf));
454 if (PREDICT_TRUE (next_index == VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT))
456 vlib_next_frame_t *nf;
458 ethernet_input_frame_t *ef;
459 nf = vlib_node_runtime_get_next_frame (vm, node, next_index);
460 f = vlib_get_frame (vm, nf->frame);
461 f->flags = ETH_INPUT_FRAME_F_SINGLE_SW_IF_IDX;
463 ef = vlib_frame_scalar_args (f);
464 ef->sw_if_index = xd->sw_if_index;
465 ef->hw_if_index = xd->hw_if_index;
467 /* if PMD supports ip4 checksum check and there are no packets
468 marked as ip4 checksum bad we can notify ethernet input so it
469 can send pacets to ip4-input-no-checksum node */
470 if (xd->flags & DPDK_DEVICE_FLAG_RX_IP4_CKSUM &&
471 (or_flags & RTE_MBUF_F_RX_IP_CKSUM_BAD) == 0)
472 f->flags |= ETH_INPUT_FRAME_F_IP4_CKSUM_OK;
473 vlib_frame_no_append (f);
475 n_left_to_next -= n_rx_packets;
476 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
480 /* packet trace if enabled */
481 if (PREDICT_FALSE ((n_trace = vlib_get_trace_count (vm, node))))
484 vlib_get_buffer_indices_with_offset (vm, (void **) ptd->mbufs,
485 ptd->buffers, n_rx_packets,
486 sizeof (struct rte_mbuf));
488 n_left = n_rx_packets;
489 buffers = ptd->buffers;
493 while (n_trace && n_left)
495 b0 = vlib_get_buffer (vm, buffers[0]);
496 if (single_next == 0)
497 next_index = next[0];
501 (vm, node, next_index, b0, /* follow_chain */ 0)))
504 dpdk_rx_trace_t *t0 =
505 vlib_add_trace (vm, node, b0, sizeof t0[0]);
506 t0->queue_index = queue_id;
507 t0->device_index = xd->device_index;
508 t0->buffer_index = vlib_get_buffer_index (vm, b0);
510 clib_memcpy_fast (&t0->mb, mb[0], sizeof t0->mb);
511 clib_memcpy_fast (&t0->buffer, b0,
512 sizeof b0[0] - sizeof b0->pre_data);
513 clib_memcpy_fast (t0->buffer.pre_data, b0->data,
514 sizeof t0->buffer.pre_data);
515 clib_memcpy_fast (&t0->data, mb[0]->buf_addr + mb[0]->data_off,
525 vlib_set_trace_count (vm, node, n_trace);
528 vlib_increment_combined_counter
529 (vnet_get_main ()->interface_main.combined_sw_if_counters
530 + VNET_INTERFACE_COUNTER_RX, thread_index, xd->sw_if_index,
531 n_rx_packets, n_rx_bytes);
533 vnet_device_increment_rx_packets (thread_index, n_rx_packets);
538 VLIB_NODE_FN (dpdk_input_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
541 dpdk_main_t *dm = &dpdk_main;
543 uword n_rx_packets = 0;
544 vnet_hw_if_rxq_poll_vector_t *pv;
545 u32 thread_index = node->thread_index;
548 * Poll all devices on this cpu for input/interrupts.
551 pv = vnet_hw_if_get_rxq_poll_vector (vm, node);
553 for (int i = 0; i < vec_len (pv); i++)
555 xd = vec_elt_at_index (dm->devices, pv[i].dev_instance);
557 dpdk_device_input (vm, dm, xd, node, thread_index, pv[i].queue_id);
563 VLIB_REGISTER_NODE (dpdk_input_node) = {
564 .type = VLIB_NODE_TYPE_INPUT,
565 .name = "dpdk-input",
566 .sibling_of = "device-input",
567 .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
569 /* Will be enabled if/when hardware is detected. */
570 .state = VLIB_NODE_STATE_DISABLED,
572 .format_buffer = format_ethernet_header_with_length,
573 .format_trace = format_dpdk_rx_trace,
575 .n_errors = DPDK_N_ERROR,
576 .error_strings = dpdk_error_strings,
581 * fd.io coding-style-patch-verification: ON
584 * eval: (c-set-style "gnu")