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 #ifndef __included_dpdk_h__
16 #define __included_dpdk_h__
18 /* $$$$ We should rename always_inline -> clib_always_inline */
21 #include <rte_config.h>
23 #include <rte_common.h>
26 #include <rte_memory.h>
27 #include <rte_memcpy.h>
28 #include <rte_memzone.h>
29 #include <rte_tailq.h>
31 #include <rte_per_lcore.h>
32 #include <rte_launch.h>
33 #include <rte_atomic.h>
34 #include <rte_cycles.h>
35 #include <rte_prefetch.h>
36 #include <rte_lcore.h>
37 #include <rte_per_lcore.h>
38 #include <rte_branch_prediction.h>
39 #include <rte_interrupts.h>
41 #include <rte_random.h>
42 #include <rte_debug.h>
43 #include <rte_ether.h>
44 #include <rte_ethdev.h>
46 #include <rte_mempool.h>
51 #include <rte_virtio_net.h>
52 #include <rte_pci_dev_ids.h>
53 #include <rte_version.h>
54 #include <rte_eth_bond.h>
56 #include <vnet/unix/pcap.h>
57 #include <vnet/devices/virtio/vhost-user.h>
60 #define always_inline static inline
62 #define always_inline static inline __attribute__ ((__always_inline__))
65 #define MBUF_SIZE (2048 + sizeof(struct rte_mbuf) + RTE_PKTMBUF_HEADROOM)
66 #define NB_MBUF (32<<10)
68 vnet_device_class_t dpdk_device_class;
69 vlib_node_registration_t dpdk_input_node;
70 vlib_node_registration_t dpdk_io_input_node;
71 vlib_node_registration_t handoff_dispatch_node;
74 VNET_DPDK_DEV_ETH = 1, /* Standard DPDK PMD driver */
75 VNET_DPDK_DEV_KNI, /* Kernel NIC Interface */
76 VNET_DPDK_DEV_VHOST_USER,
77 VNET_DPDK_DEV_UNKNOWN, /* must be last */
80 #define foreach_dpdk_pmd \
81 _ ("rte_nicvf_pmd", THUNDERX) \
82 _ ("rte_em_pmd", E1000EM) \
83 _ ("rte_igb_pmd", IGB) \
84 _ ("rte_igbvf_pmd", IGBVF) \
85 _ ("rte_ixgbe_pmd", IXGBE) \
86 _ ("rte_ixgbevf_pmd", IXGBEVF) \
87 _ ("rte_i40e_pmd", I40E) \
88 _ ("rte_i40evf_pmd", I40EVF) \
89 _ ("rte_virtio_pmd", VIRTIO) \
90 _ ("rte_vice_pmd", VICE) \
91 _ ("rte_enic_pmd", ENIC) \
92 _ ("rte_vmxnet3_pmd", VMXNET3) \
93 _ ("AF_PACKET PMD", AF_PACKET) \
94 _ ("rte_bond_pmd", BOND) \
95 _ ("rte_pmd_fm10k", FM10K) \
96 _ ("rte_cxgbe_pmd", CXGBE)
100 #define _(s,f) VNET_DPDK_PMD_##f,
104 VNET_DPDK_PMD_NETMAP,
106 VNET_DPDK_PMD_UNKNOWN, /* must be last */
110 VNET_DPDK_PORT_TYPE_ETH_1G,
111 VNET_DPDK_PORT_TYPE_ETH_10G,
112 VNET_DPDK_PORT_TYPE_ETH_40G,
113 VNET_DPDK_PORT_TYPE_ETH_BOND,
114 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
116 VNET_DPDK_PORT_TYPE_NETMAP,
118 VNET_DPDK_PORT_TYPE_AF_PACKET,
119 VNET_DPDK_PORT_TYPE_UNKNOWN,
124 vlib_frame_t * frame;
127 #define DPDK_EFD_MAX_DISCARD_RATE 10
133 u32 consec_full_frames_cnt;
138 u32 total_packet_cnt;
145 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
149 u32 n_since_last_int;
158 char sock_filename[256];
165 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
166 dpdk_vu_vring vrings[VHOST_MAX_QUEUE_PAIRS * 2];
168 dpdk_vu_vring vrings[2];
170 u64 region_addr[VHOST_MEMORY_MAX_NREGIONS];
171 u32 region_fd[VHOST_MEMORY_MAX_NREGIONS];
174 typedef void (*dpdk_flowcontrol_callback_t) (vlib_main_t *vm,
179 * The header for the tx_vector in dpdk_device_t.
180 * Head and tail are indexes into the tx_vector and are of type
181 * u64 so they never overflow.
189 CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
190 volatile u32 **lockp;
195 u32 vlib_hw_if_index;
196 u32 vlib_sw_if_index;
198 /* next node index if we decide to steal the rx graph arc */
199 u32 per_interface_next_index;
201 /* dpdk rte_mbuf rx and tx vectors, VLIB_FRAME_SIZE */
202 struct rte_mbuf *** tx_vectors; /* one per worker thread */
203 struct rte_mbuf *** rx_vectors;
205 /* vector of traced contexts, per device */
206 u32 * d_trace_buffers;
208 /* per-worker destination frame queue */
209 dpdk_frame_t * frames;
211 dpdk_device_type_t dev_type:8;
218 CLIB_CACHE_LINE_ALIGN_MARK(cacheline1);
225 u16 * cpu_socket_id_by_queue;
226 struct rte_eth_conf port_conf;
227 struct rte_eth_txconf tx_conf;
233 /* vhost-user related */
235 struct virtio_net vu_vhost_dev;
237 dpdk_vu_intf_t *vu_intf;
240 u8 af_packet_port_id;
242 struct rte_eth_link link;
243 f64 time_last_link_update;
245 struct rte_eth_stats stats;
246 struct rte_eth_stats last_stats;
247 struct rte_eth_xstats * xstats;
248 f64 time_last_stats_update;
249 dpdk_port_type_t port_type;
251 dpdk_efd_agent_t efd_agent;
252 u8 need_txlock; /* Used by VNET_DPDK_DEV_VHOST_USER */
257 CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
265 i32 n_vectors[MAX_NELTS];
266 } frame_queue_trace_t;
268 #define DPDK_TX_RING_SIZE (4 * 1024)
270 #define DPDK_STATS_POLL_INTERVAL 10.0
271 #define DPDK_LINK_POLL_INTERVAL 3.0
274 CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
276 /* total input packet counter */
277 u64 aggregate_rx_packets;
283 } dpdk_device_and_queue_t;
285 /* Early-Fast-Discard (EFD) */
286 #define DPDK_EFD_DISABLED 0
287 #define DPDK_EFD_DISCARD_ENABLED (1 << 0)
288 #define DPDK_EFD_MONITOR_ENABLED (1 << 1)
289 #define DPDK_EFD_DROPALL_ENABLED (1 << 2)
291 #define DPDK_EFD_DEFAULT_DEVICE_QUEUE_HI_THRESH_PCT 90
292 #define DPDK_EFD_DEFAULT_CONSEC_FULL_FRAMES_HI_THRESH 6
294 typedef struct dpdk_efd_t {
297 u16 consec_full_frames_hi_thresh;
304 dpdk_device_t * devices;
305 dpdk_device_and_queue_t ** devices_by_cpu;
307 /* per-thread recycle lists */
310 /* buffer flags template, configurable to enable/disable tcp / udp cksum */
311 u32 buffer_flags_template;
313 /* flow control callback. If 0 then flow control is disabled */
314 dpdk_flowcontrol_callback_t flowcontrol_callback;
316 /* vlib buffer free list, must be same size as an rte_mbuf */
317 u32 vlib_buffer_free_list_index;
320 * format interface names ala xxxEthernet%d/%d/%d instead of
321 * xxxEthernet%x/%x/%x. For VIRL.
323 u8 interface_name_format_decimal;
326 /* dpdk worker "threads" */
327 dpdk_worker_t * workers;
331 u8 * eal_init_args_str;
332 u8 * eth_if_blacklist;
333 u8 * eth_if_whitelist;
334 u8 * uio_driver_name;
337 /* Required config parameters */
338 u8 coremask_set_manually;
339 u8 nchannels_set_manually;
345 u8 num_kni; /* while kni_init allows u32, port_id in callback fn is only u8 */
347 /* Ethernet input node index */
348 u32 ethernet_input_node_index;
350 /* dpdk i/o thread initialization barrier */
351 volatile u32 io_thread_release;
353 /* pcap tracing [only works if (CLIB_DEBUG > 0)] */
355 pcap_main_t pcap_main;
357 u32 pcap_sw_if_index;
358 u32 pcap_pkts_to_capture;
360 /* virtio vhost-user switch */
363 /* vhost-user coalescence frames config */
364 u32 vhost_coalesce_frames;
365 f64 vhost_coalesce_time;
368 uword * dpdk_device_by_kni_port_id;
369 uword * vu_sw_if_index_by_listener_fd;
370 uword * vu_sw_if_index_by_sock_fd;
371 u32 * vu_inactive_interfaces_device_index;
375 /* efd (early-fast-discard) settings */
379 * flag indicating that a posted admin up/down
380 * (via post_sw_interface_set_flags) is in progress
382 u8 admin_up_down_in_progress;
386 /* which cpus are running dpdk-input */
387 int input_cpu_first_index;
391 vlib_main_t * vlib_main;
392 vnet_main_t * vnet_main;
395 dpdk_main_t dpdk_main;
398 DPDK_RX_NEXT_IP4_INPUT,
399 DPDK_RX_NEXT_IP6_INPUT,
400 DPDK_RX_NEXT_MPLS_INPUT,
401 DPDK_RX_NEXT_ETHERNET_INPUT,
411 /* Copy of VLIB buffer; packet data stored in pre_data. */
412 vlib_buffer_t buffer;
413 } dpdk_tx_dma_trace_t;
420 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
421 } dpdk_rx_dma_trace_t;
423 void vnet_buffer_needs_dpdk_mb (vlib_buffer_t * b);
425 void dpdk_set_next_node (dpdk_rx_next_t, char *);
427 clib_error_t * dpdk_set_mac_address (vnet_hw_interface_t * hi, char * address);
429 clib_error_t * dpdk_set_mc_filter (vnet_hw_interface_t * hi,
430 struct ether_addr mc_addr_vec[], int naddr);
432 typedef void (*dpdk_io_thread_callback_t) (vlib_main_t *vm);
434 void dpdk_io_thread (vlib_worker_thread_t * w,
438 dpdk_io_thread_callback_t callback);
439 void dpdk_thread_input (dpdk_main_t * dm, dpdk_device_t * xd);
441 clib_error_t * dpdk_port_setup (dpdk_main_t * dm, dpdk_device_t * xd);
443 void dpdk_set_flowcontrol_callback (vlib_main_t *vm,
444 dpdk_flowcontrol_callback_t callback);
446 u32 dpdk_interface_tx_vector (vlib_main_t * vm, u32 dev_instance);
448 vlib_frame_queue_elt_t * vlib_get_handoff_queue_elt (u32 vlib_worker_index);
450 u32 dpdk_get_handoff_node_index (void);
452 void set_efd_bitmap (u8 *bitmap, u32 value, u32 op);
454 #define foreach_dpdk_error \
455 _(NONE, "no error") \
456 _(RX_PACKET_ERROR, "Rx packet errors") \
457 _(RX_BAD_FCS, "Rx bad fcs") \
458 _(L4_CHECKSUM_ERROR, "Rx L4 checksum errors") \
459 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
460 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
461 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
462 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error") \
463 _(IPV4_EFD_DROP_PKTS, "IPV4 Early Fast Discard rx drops") \
464 _(IPV6_EFD_DROP_PKTS, "IPV6 Early Fast Discard rx drops") \
465 _(MPLS_EFD_DROP_PKTS, "MPLS Early Fast Discard rx drops") \
466 _(VLAN_EFD_DROP_PKTS, "VLAN Early Fast Discard rx drops")
469 #define _(f,s) DPDK_ERROR_##f,
476 * Increment EFD drop counter
479 void increment_efd_drop_counter (vlib_main_t * vm, u32 counter_index, u32 count)
483 my_n = vlib_get_node (vm, dpdk_input_node.index);
484 vm->error_main.counters[my_n->error_heap_index+counter_index] += count;
487 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
488 void dpdk_device_lock_init(dpdk_device_t * xd);
489 void dpdk_device_lock_free(dpdk_device_t * xd);
490 void dpdk_efd_update_counters(dpdk_device_t *xd, u32 n_buffers, u16 enabled);
491 u32 is_efd_discardable(vlib_thread_main_t *tm,
493 struct rte_mbuf *mb);
495 /* dpdk vhost-user interrupt management */
496 u8 dpdk_vhost_user_want_interrupt (dpdk_device_t *xd, int idx);
497 void dpdk_vhost_user_send_interrupt (vlib_main_t * vm, dpdk_device_t * xd,
501 static inline u64 vnet_get_aggregate_rx_packets (void)
503 dpdk_main_t * dm = &dpdk_main;
507 vec_foreach(dw, dm->workers)
508 sum += dw->aggregate_rx_packets;
513 void dpdk_rx_trace (dpdk_main_t * dm,
514 vlib_node_runtime_t * node,
520 #define EFD_OPERATION_LESS_THAN 0
521 #define EFD_OPERATION_GREATER_OR_EQUAL 1
523 void efd_config(u32 enabled,
524 u32 ip_prec, u32 ip_op,
525 u32 mpls_exp, u32 mpls_op,
526 u32 vlan_cos, u32 vlan_op);
528 void post_sw_interface_set_flags (vlib_main_t *vm, u32 sw_if_index, u32 flags);
530 typedef struct vhost_user_memory vhost_user_memory_t;
532 void dpdk_vhost_user_process_init (void **ctx);
533 void dpdk_vhost_user_process_cleanup (void *ctx);
534 uword dpdk_vhost_user_process_if (vlib_main_t *vm, dpdk_device_t *xd, void *ctx);
537 int dpdk_vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
538 const char * sock_filename,
542 u8 renumber, u32 custom_dev_instance,
544 int dpdk_vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
545 const char * sock_filename,
549 u8 renumber, u32 custom_dev_instance);
550 int dpdk_vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm,
552 int dpdk_vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
553 vhost_user_intf_details_t **out_vuids);
555 u32 dpdk_get_admin_up_down_in_progress (void);
558 dpdk_input_rss (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * f);
560 format_function_t format_dpdk_device_name;
561 format_function_t format_dpdk_device;
562 format_function_t format_dpdk_tx_dma_trace;
563 format_function_t format_dpdk_rx_dma_trace;
564 format_function_t format_dpdk_rte_mbuf;
565 format_function_t format_dpdk_rx_rte_mbuf;
566 unformat_function_t unformat_socket_mem;
568 #endif /* __included_dpdk_h__ */