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>
30 #include <dpdk/device/dpdk_priv.h>
32 static char *dpdk_error_strings[] = {
38 /* make sure all flags we need are stored in lower 32 bits */
39 STATIC_ASSERT ((u64) (PKT_RX_IP_CKSUM_BAD | PKT_RX_FDIR | PKT_RX_LRO) <
41 "dpdk flags not in lower word, fix needed");
43 static_always_inline uword
44 dpdk_process_subseq_segs (vlib_main_t * vm, vlib_buffer_t * b,
45 struct rte_mbuf *mb, vlib_buffer_t * bt)
48 struct rte_mbuf *mb_seg = 0;
49 vlib_buffer_t *b_seg, *b_chain = 0;
56 b->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
57 b->total_length_not_including_first_buffer = 0;
59 while (nb_seg < mb->nb_segs)
63 b_seg = vlib_buffer_from_rte_mbuf (mb_seg);
64 vlib_buffer_copy_template (b_seg, bt);
67 * The driver (e.g. virtio) may not put the packet data at the start
68 * of the segment, so don't assume b_seg->current_data == 0 is correct.
71 (mb_seg->buf_addr + mb_seg->data_off) - (void *) b_seg->data;
73 b_seg->current_length = mb_seg->data_len;
74 b->total_length_not_including_first_buffer += mb_seg->data_len;
76 b_chain->flags |= VLIB_BUFFER_NEXT_PRESENT;
77 b_chain->next_buffer = vlib_get_buffer_index (vm, b_seg);
80 mb_seg = mb_seg->next;
83 return b->total_length_not_including_first_buffer;
86 static_always_inline void
87 dpdk_prefetch_mbuf_x4 (struct rte_mbuf *mb[])
89 clib_prefetch_load (mb[0]);
90 clib_prefetch_load (mb[1]);
91 clib_prefetch_load (mb[2]);
92 clib_prefetch_load (mb[3]);
95 static_always_inline void
96 dpdk_prefetch_buffer_x4 (struct rte_mbuf *mb[])
99 b = vlib_buffer_from_rte_mbuf (mb[0]);
100 clib_prefetch_load (b);
101 b = vlib_buffer_from_rte_mbuf (mb[1]);
102 clib_prefetch_load (b);
103 b = vlib_buffer_from_rte_mbuf (mb[2]);
104 clib_prefetch_load (b);
105 b = vlib_buffer_from_rte_mbuf (mb[3]);
106 clib_prefetch_load (b);
109 /** \brief Main DPDK input node
112 This is the main DPDK input node: across each assigned interface,
113 call rte_eth_rx_burst(...) or similar to obtain a vector of
114 packets to process. Derive @c vlib_buffer_t metadata from
115 <code>struct rte_mbuf</code> metadata,
116 Depending on the resulting metadata: adjust <code>b->current_data,
117 b->current_length </code> and dispatch directly to
118 ip4-input-no-checksum, or ip6-input. Trace the packet if required.
120 @param vm vlib_main_t corresponding to the current thread
121 @param node vlib_node_runtime_t
122 @param f vlib_frame_t input-node, not used.
124 @par Graph mechanics: buffer metadata, next index usage
127 - <code>struct rte_mbuf mb->ol_flags</code>
128 - PKT_RX_IP_CKSUM_BAD
131 - <code>b->error</code> if the packet is to be dropped immediately
132 - <code>b->current_data, b->current_length</code>
133 - adjusted as needed to skip the L2 header in direct-dispatch cases
134 - <code>vnet_buffer(b)->sw_if_index[VLIB_RX]</code>
135 - rx interface sw_if_index
136 - <code>vnet_buffer(b)->sw_if_index[VLIB_TX] = ~0</code>
137 - required by ipX-lookup
138 - <code>b->flags</code>
139 - to indicate multi-segment pkts (VLIB_BUFFER_NEXT_PRESENT), etc.
142 - Static arcs to: error-drop, ethernet-input,
143 ip4-input-no-checksum, ip6-input, mpls-input
144 - per-interface redirection, controlled by
145 <code>xd->per_interface_next_index</code>
148 static_always_inline u32
149 dpdk_ol_flags_extract (struct rte_mbuf **mb, u32 *flags, int count)
153 for (i = 0; i < count; i++)
155 /* all flags we are interested in are in lower 8 bits but
157 flags[i] = (u32) mb[i]->ol_flags;
163 static_always_inline uword
164 dpdk_process_rx_burst (vlib_main_t *vm, dpdk_per_thread_data_t *ptd,
165 uword n_rx_packets, int maybe_multiseg, u32 *or_flagsp)
167 u32 n_left = n_rx_packets;
169 struct rte_mbuf **mb = ptd->mbufs;
171 u32 *flags, or_flags = 0;
177 /* copy template into local variable - will save per packet load */
178 vlib_buffer_copy_template (&bt, &ptd->buffer_template);
181 dpdk_prefetch_buffer_x4 (mb + 4);
183 b[0] = vlib_buffer_from_rte_mbuf (mb[0]);
184 b[1] = vlib_buffer_from_rte_mbuf (mb[1]);
185 b[2] = vlib_buffer_from_rte_mbuf (mb[2]);
186 b[3] = vlib_buffer_from_rte_mbuf (mb[3]);
188 vlib_buffer_copy_template (b[0], &bt);
189 vlib_buffer_copy_template (b[1], &bt);
190 vlib_buffer_copy_template (b[2], &bt);
191 vlib_buffer_copy_template (b[3], &bt);
193 dpdk_prefetch_mbuf_x4 (mb + 4);
195 or_flags |= dpdk_ol_flags_extract (mb, flags, 4);
198 b[0]->current_data = mb[0]->data_off - RTE_PKTMBUF_HEADROOM;
199 n_bytes += b[0]->current_length = mb[0]->data_len;
201 b[1]->current_data = mb[1]->data_off - RTE_PKTMBUF_HEADROOM;
202 n_bytes += b[1]->current_length = mb[1]->data_len;
204 b[2]->current_data = mb[2]->data_off - RTE_PKTMBUF_HEADROOM;
205 n_bytes += b[2]->current_length = mb[2]->data_len;
207 b[3]->current_data = mb[3]->data_off - RTE_PKTMBUF_HEADROOM;
208 n_bytes += b[3]->current_length = mb[3]->data_len;
212 n_bytes += dpdk_process_subseq_segs (vm, b[0], mb[0], &bt);
213 n_bytes += dpdk_process_subseq_segs (vm, b[1], mb[1], &bt);
214 n_bytes += dpdk_process_subseq_segs (vm, b[2], mb[2], &bt);
215 n_bytes += dpdk_process_subseq_segs (vm, b[3], mb[3], &bt);
225 b[0] = vlib_buffer_from_rte_mbuf (mb[0]);
226 vlib_buffer_copy_template (b[0], &bt);
227 or_flags |= dpdk_ol_flags_extract (mb, flags, 1);
230 b[0]->current_data = mb[0]->data_off - RTE_PKTMBUF_HEADROOM;
231 n_bytes += b[0]->current_length = mb[0]->data_len;
234 n_bytes += dpdk_process_subseq_segs (vm, b[0], mb[0], &bt);
241 *or_flagsp = or_flags;
245 static_always_inline void
246 dpdk_process_flow_offload (dpdk_device_t * xd, dpdk_per_thread_data_t * ptd,
250 dpdk_flow_lookup_entry_t *fle;
253 /* TODO prefetch and quad-loop */
254 for (n = 0; n < n_rx_packets; n++)
256 if ((ptd->flags[n] & PKT_RX_FDIR_ID) == 0)
259 fle = pool_elt_at_index (xd->flow_lookup_entries,
260 ptd->mbufs[n]->hash.fdir.hi);
262 if (fle->next_index != (u16) ~ 0)
263 ptd->next[n] = fle->next_index;
265 if (fle->flow_id != ~0)
267 b0 = vlib_buffer_from_rte_mbuf (ptd->mbufs[n]);
268 b0->flow_id = fle->flow_id;
271 if (fle->buffer_advance != ~0)
273 b0 = vlib_buffer_from_rte_mbuf (ptd->mbufs[n]);
274 vlib_buffer_advance (b0, fle->buffer_advance);
279 static_always_inline u16
280 dpdk_lro_find_l4_hdr_sz (vlib_buffer_t *b)
283 u16 current_offset = 0;
284 ethernet_header_t *e;
286 u8 *data = vlib_buffer_get_current (b);
289 current_offset += sizeof (e[0]);
290 ethertype = clib_net_to_host_u16 (e->type);
291 if (ethernet_frame_is_tagged (ethertype))
293 ethernet_vlan_header_t *vlan = (ethernet_vlan_header_t *) (e + 1);
294 ethertype = clib_net_to_host_u16 (vlan->type);
295 current_offset += sizeof (*vlan);
296 if (ethertype == ETHERNET_TYPE_VLAN)
299 current_offset += sizeof (*vlan);
300 ethertype = clib_net_to_host_u16 (vlan->type);
303 data += current_offset;
304 if (ethertype == ETHERNET_TYPE_IP4)
306 data += sizeof (ip4_header_t);
308 l4_hdr_sz = tcp_header_bytes (tcp);
312 /* FIXME: extension headers...*/
313 data += sizeof (ip6_header_t);
315 l4_hdr_sz = tcp_header_bytes (tcp);
320 static_always_inline void
321 dpdk_process_lro_offload (dpdk_device_t *xd, dpdk_per_thread_data_t *ptd,
326 for (n = 0; n < n_rx_packets; n++)
328 b0 = vlib_buffer_from_rte_mbuf (ptd->mbufs[n]);
329 if (ptd->flags[n] & PKT_RX_LRO)
331 b0->flags |= VNET_BUFFER_F_GSO;
332 vnet_buffer2 (b0)->gso_size = ptd->mbufs[n]->tso_segsz;
333 vnet_buffer2 (b0)->gso_l4_hdr_sz = dpdk_lro_find_l4_hdr_sz (b0);
338 static_always_inline u32
339 dpdk_device_input (vlib_main_t * vm, dpdk_main_t * dm, dpdk_device_t * xd,
340 vlib_node_runtime_t * node, u32 thread_index, u16 queue_id)
342 uword n_rx_packets = 0, n_rx_bytes;
343 dpdk_rx_queue_t *rxq = vec_elt_at_index (xd->rx_queues, queue_id);
346 u32 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
347 struct rte_mbuf **mb;
354 dpdk_per_thread_data_t *ptd = vec_elt_at_index (dm->per_thread_data,
356 vlib_buffer_t *bt = &ptd->buffer_template;
358 if ((xd->flags & DPDK_DEVICE_FLAG_ADMIN_UP) == 0)
361 /* get up to DPDK_RX_BURST_SZ buffers from PMD */
362 while (n_rx_packets < DPDK_RX_BURST_SZ)
364 n = rte_eth_rx_burst (xd->port_id, queue_id,
365 ptd->mbufs + n_rx_packets,
366 DPDK_RX_BURST_SZ - n_rx_packets);
373 if (n_rx_packets == 0)
376 /* Update buffer template */
377 vnet_buffer (bt)->sw_if_index[VLIB_RX] = xd->sw_if_index;
378 bt->error = node->errors[DPDK_ERROR_NONE];
379 /* as DPDK is allocating empty buffers from mempool provided before interface
380 start for each queue, it is safe to store this in the template */
381 bt->buffer_pool_index = rxq->buffer_pool_index;
383 vnet_buffer (bt)->feature_arc_index = 0;
384 bt->current_config_index = 0;
386 /* receive burst of packets from DPDK PMD */
387 if (PREDICT_FALSE (xd->per_interface_next_index != ~0))
388 next_index = xd->per_interface_next_index;
390 /* as all packets belong to the same interface feature arc lookup
391 can be don once and result stored in the buffer template */
392 if (PREDICT_FALSE (vnet_device_input_have_features (xd->sw_if_index)))
393 vnet_feature_start_device_input_x1 (xd->sw_if_index, &next_index, bt);
395 if (xd->flags & DPDK_DEVICE_FLAG_MAYBE_MULTISEG)
396 n_rx_bytes = dpdk_process_rx_burst (vm, ptd, n_rx_packets, 1, &or_flags);
398 n_rx_bytes = dpdk_process_rx_burst (vm, ptd, n_rx_packets, 0, &or_flags);
400 if (PREDICT_FALSE ((or_flags & PKT_RX_LRO)))
401 dpdk_process_lro_offload (xd, ptd, n_rx_packets);
403 if (PREDICT_FALSE (or_flags & PKT_RX_FDIR))
405 /* some packets will need to go to different next nodes */
406 for (n = 0; n < n_rx_packets; n++)
407 ptd->next[n] = next_index;
409 /* flow offload - process if rx flow offload enabled and at least one
411 if (PREDICT_FALSE ((xd->flags & DPDK_DEVICE_FLAG_RX_FLOW_OFFLOAD) &&
412 (or_flags & PKT_RX_FDIR)))
413 dpdk_process_flow_offload (xd, ptd, n_rx_packets);
415 /* enqueue buffers to the next node */
416 vlib_get_buffer_indices_with_offset (vm, (void **) ptd->mbufs,
417 ptd->buffers, n_rx_packets,
418 sizeof (struct rte_mbuf));
420 vlib_buffer_enqueue_to_next (vm, node, ptd->buffers, ptd->next,
425 u32 *to_next, n_left_to_next;
427 vlib_get_new_next_frame (vm, node, next_index, to_next, n_left_to_next);
428 vlib_get_buffer_indices_with_offset (vm, (void **) ptd->mbufs, to_next,
430 sizeof (struct rte_mbuf));
432 if (PREDICT_TRUE (next_index == VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT))
434 vlib_next_frame_t *nf;
436 ethernet_input_frame_t *ef;
437 nf = vlib_node_runtime_get_next_frame (vm, node, next_index);
438 f = vlib_get_frame (vm, nf->frame);
439 f->flags = ETH_INPUT_FRAME_F_SINGLE_SW_IF_IDX;
441 ef = vlib_frame_scalar_args (f);
442 ef->sw_if_index = xd->sw_if_index;
443 ef->hw_if_index = xd->hw_if_index;
445 /* if PMD supports ip4 checksum check and there are no packets
446 marked as ip4 checksum bad we can notify ethernet input so it
447 can send pacets to ip4-input-no-checksum node */
448 if (xd->flags & DPDK_DEVICE_FLAG_RX_IP4_CKSUM &&
449 (or_flags & PKT_RX_IP_CKSUM_BAD) == 0)
450 f->flags |= ETH_INPUT_FRAME_F_IP4_CKSUM_OK;
451 vlib_frame_no_append (f);
453 n_left_to_next -= n_rx_packets;
454 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
458 /* packet trace if enabled */
459 if (PREDICT_FALSE ((n_trace = vlib_get_trace_count (vm, node))))
462 vlib_get_buffer_indices_with_offset (vm, (void **) ptd->mbufs,
463 ptd->buffers, n_rx_packets,
464 sizeof (struct rte_mbuf));
466 n_left = n_rx_packets;
467 buffers = ptd->buffers;
471 while (n_trace && n_left)
473 b0 = vlib_get_buffer (vm, buffers[0]);
474 if (single_next == 0)
475 next_index = next[0];
479 (vm, node, next_index, b0, /* follow_chain */ 0)))
482 dpdk_rx_trace_t *t0 =
483 vlib_add_trace (vm, node, b0, sizeof t0[0]);
484 t0->queue_index = queue_id;
485 t0->device_index = xd->device_index;
486 t0->buffer_index = vlib_get_buffer_index (vm, b0);
488 clib_memcpy_fast (&t0->mb, mb[0], sizeof t0->mb);
489 clib_memcpy_fast (&t0->buffer, b0,
490 sizeof b0[0] - sizeof b0->pre_data);
491 clib_memcpy_fast (t0->buffer.pre_data, b0->data,
492 sizeof t0->buffer.pre_data);
493 clib_memcpy_fast (&t0->data, mb[0]->buf_addr + mb[0]->data_off,
503 vlib_set_trace_count (vm, node, n_trace);
506 vlib_increment_combined_counter
507 (vnet_get_main ()->interface_main.combined_sw_if_counters
508 + VNET_INTERFACE_COUNTER_RX, thread_index, xd->sw_if_index,
509 n_rx_packets, n_rx_bytes);
511 vnet_device_increment_rx_packets (thread_index, n_rx_packets);
516 VLIB_NODE_FN (dpdk_input_node) (vlib_main_t * vm, vlib_node_runtime_t * node,
519 dpdk_main_t *dm = &dpdk_main;
521 uword n_rx_packets = 0;
522 vnet_hw_if_rxq_poll_vector_t *pv;
523 u32 thread_index = node->thread_index;
526 * Poll all devices on this cpu for input/interrupts.
529 pv = vnet_hw_if_get_rxq_poll_vector (vm, node);
531 for (int i = 0; i < vec_len (pv); i++)
533 xd = vec_elt_at_index (dm->devices, pv[i].dev_instance);
535 dpdk_device_input (vm, dm, xd, node, thread_index, pv[i].queue_id);
541 VLIB_REGISTER_NODE (dpdk_input_node) = {
542 .type = VLIB_NODE_TYPE_INPUT,
543 .name = "dpdk-input",
544 .sibling_of = "device-input",
545 .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
547 /* Will be enabled if/when hardware is detected. */
548 .state = VLIB_NODE_STATE_DISABLED,
550 .format_buffer = format_ethernet_header_with_length,
551 .format_trace = format_dpdk_rx_trace,
553 .n_errors = DPDK_N_ERROR,
554 .error_strings = dpdk_error_strings,
559 * fd.io coding-style-patch-verification: ON
562 * eval: (c-set-style "gnu")