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_memzone.h>
28 #include <rte_tailq.h>
30 #include <rte_per_lcore.h>
31 #include <rte_launch.h>
32 #include <rte_atomic.h>
33 #include <rte_cycles.h>
34 #include <rte_prefetch.h>
35 #include <rte_lcore.h>
36 #include <rte_per_lcore.h>
37 #include <rte_branch_prediction.h>
38 #include <rte_interrupts.h>
40 #include <rte_random.h>
41 #include <rte_debug.h>
42 #include <rte_ether.h>
43 #include <rte_ethdev.h>
45 #include <rte_mempool.h>
50 #include <rte_virtio_net.h>
51 #include <rte_pci_dev_ids.h>
52 #include <rte_version.h>
53 #include <rte_eth_bond.h>
55 #include <vnet/unix/pcap.h>
56 #include <vnet/devices/virtio/vhost-user.h>
59 #define always_inline static inline
61 #define always_inline static inline __attribute__ ((__always_inline__))
64 #define NB_MBUF (32<<10)
66 extern vnet_device_class_t dpdk_device_class;
67 extern vlib_node_registration_t dpdk_input_node;
68 extern vlib_node_registration_t dpdk_io_input_node;
69 extern vlib_node_registration_t handoff_dispatch_node;
72 VNET_DPDK_DEV_ETH = 1, /* Standard DPDK PMD driver */
73 VNET_DPDK_DEV_KNI, /* Kernel NIC Interface */
74 VNET_DPDK_DEV_VHOST_USER,
75 VNET_DPDK_DEV_UNKNOWN, /* must be last */
78 #define foreach_dpdk_pmd \
79 _ ("rte_nicvf_pmd", THUNDERX) \
80 _ ("rte_em_pmd", E1000EM) \
81 _ ("rte_igb_pmd", IGB) \
82 _ ("rte_igbvf_pmd", IGBVF) \
83 _ ("rte_ixgbe_pmd", IXGBE) \
84 _ ("rte_ixgbevf_pmd", IXGBEVF) \
85 _ ("rte_i40e_pmd", I40E) \
86 _ ("rte_i40evf_pmd", I40EVF) \
87 _ ("rte_virtio_pmd", VIRTIO) \
88 _ ("rte_vice_pmd", VICE) \
89 _ ("rte_enic_pmd", ENIC) \
90 _ ("rte_vmxnet3_pmd", VMXNET3) \
91 _ ("AF_PACKET PMD", AF_PACKET) \
92 _ ("rte_bond_pmd", BOND) \
93 _ ("rte_pmd_fm10k", FM10K) \
94 _ ("rte_cxgbe_pmd", CXGBE)
98 #define _(s,f) VNET_DPDK_PMD_##f,
102 VNET_DPDK_PMD_NETMAP,
104 VNET_DPDK_PMD_UNKNOWN, /* must be last */
108 VNET_DPDK_PORT_TYPE_ETH_1G,
109 VNET_DPDK_PORT_TYPE_ETH_10G,
110 VNET_DPDK_PORT_TYPE_ETH_40G,
111 VNET_DPDK_PORT_TYPE_ETH_BOND,
112 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
114 VNET_DPDK_PORT_TYPE_NETMAP,
116 VNET_DPDK_PORT_TYPE_AF_PACKET,
117 VNET_DPDK_PORT_TYPE_UNKNOWN,
122 vlib_frame_t * frame;
125 #define DPDK_EFD_MAX_DISCARD_RATE 10
131 u32 consec_full_frames_cnt;
136 u32 total_packet_cnt;
143 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
147 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_stats last_cleared_stats;
248 struct rte_eth_xstats * xstats;
249 struct rte_eth_xstats * last_cleared_xstats;
250 f64 time_last_stats_update;
251 dpdk_port_type_t port_type;
253 dpdk_efd_agent_t efd_agent;
254 u8 need_txlock; /* Used by VNET_DPDK_DEV_VHOST_USER */
259 CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
267 i32 n_vectors[MAX_NELTS];
268 } frame_queue_trace_t;
271 u64 count[MAX_NELTS];
272 } frame_queue_nelt_counter_t;
274 #define DPDK_TX_RING_SIZE (4 * 1024)
276 #define DPDK_STATS_POLL_INTERVAL (10.0)
277 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
279 #define DPDK_LINK_POLL_INTERVAL (3.0)
280 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
283 CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
285 /* total input packet counter */
286 u64 aggregate_rx_packets;
292 } dpdk_device_and_queue_t;
294 /* Early-Fast-Discard (EFD) */
295 #define DPDK_EFD_DISABLED 0
296 #define DPDK_EFD_DISCARD_ENABLED (1 << 0)
297 #define DPDK_EFD_MONITOR_ENABLED (1 << 1)
298 #define DPDK_EFD_DROPALL_ENABLED (1 << 2)
300 #define DPDK_EFD_DEFAULT_DEVICE_QUEUE_HI_THRESH_PCT 90
301 #define DPDK_EFD_DEFAULT_CONSEC_FULL_FRAMES_HI_THRESH 6
303 typedef struct dpdk_efd_t {
306 u16 consec_full_frames_hi_thresh;
313 dpdk_device_t * devices;
314 dpdk_device_and_queue_t ** devices_by_cpu;
316 /* per-thread recycle lists */
319 /* buffer flags template, configurable to enable/disable tcp / udp cksum */
320 u32 buffer_flags_template;
322 /* flow control callback. If 0 then flow control is disabled */
323 dpdk_flowcontrol_callback_t flowcontrol_callback;
325 /* vlib buffer free list, must be same size as an rte_mbuf */
326 u32 vlib_buffer_free_list_index;
329 * format interface names ala xxxEthernet%d/%d/%d instead of
330 * xxxEthernet%x/%x/%x. For VIRL.
332 u8 interface_name_format_decimal;
335 /* dpdk worker "threads" */
336 dpdk_worker_t * workers;
340 u8 * eal_init_args_str;
341 u8 * eth_if_blacklist;
342 u8 * eth_if_whitelist;
343 u8 * uio_driver_name;
346 /* Required config parameters */
347 u8 coremask_set_manually;
348 u8 nchannels_set_manually;
354 u8 num_kni; /* while kni_init allows u32, port_id in callback fn is only u8 */
356 /* Ethernet input node index */
357 u32 ethernet_input_node_index;
359 /* dpdk i/o thread initialization barrier */
360 volatile u32 io_thread_release;
362 /* pcap tracing [only works if (CLIB_DEBUG > 0)] */
364 pcap_main_t pcap_main;
366 u32 pcap_sw_if_index;
367 u32 pcap_pkts_to_capture;
369 /* virtio vhost-user switch */
372 /* vhost-user coalescence frames config */
373 u32 vhost_coalesce_frames;
374 f64 vhost_coalesce_time;
377 uword * dpdk_device_by_kni_port_id;
378 uword * vu_sw_if_index_by_listener_fd;
379 uword * vu_sw_if_index_by_sock_fd;
380 u32 * vu_inactive_interfaces_device_index;
384 /* efd (early-fast-discard) settings */
388 * flag indicating that a posted admin up/down
389 * (via post_sw_interface_set_flags) is in progress
391 u8 admin_up_down_in_progress;
395 /* which cpus are running dpdk-input */
396 int input_cpu_first_index;
399 /* control interval of dpdk link state and stat polling */
400 f64 link_state_poll_interval;
401 f64 stat_poll_interval;
403 /* for frame queue tracing */
404 frame_queue_trace_t *frame_queue_traces;
405 frame_queue_nelt_counter_t *frame_queue_histogram;
408 vlib_main_t * vlib_main;
409 vnet_main_t * vnet_main;
412 dpdk_main_t dpdk_main;
415 DPDK_RX_NEXT_IP4_INPUT,
416 DPDK_RX_NEXT_IP6_INPUT,
417 DPDK_RX_NEXT_MPLS_INPUT,
418 DPDK_RX_NEXT_ETHERNET_INPUT,
428 /* Copy of VLIB buffer; packet data stored in pre_data. */
429 vlib_buffer_t buffer;
430 } dpdk_tx_dma_trace_t;
437 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
438 } dpdk_rx_dma_trace_t;
440 void vnet_buffer_needs_dpdk_mb (vlib_buffer_t * b);
442 void dpdk_set_next_node (dpdk_rx_next_t, char *);
444 clib_error_t * dpdk_set_mac_address (vnet_hw_interface_t * hi, char * address);
446 clib_error_t * dpdk_set_mc_filter (vnet_hw_interface_t * hi,
447 struct ether_addr mc_addr_vec[], int naddr);
449 typedef void (*dpdk_io_thread_callback_t) (vlib_main_t *vm);
451 void dpdk_io_thread (vlib_worker_thread_t * w,
455 dpdk_io_thread_callback_t callback);
456 void dpdk_thread_input (dpdk_main_t * dm, dpdk_device_t * xd);
458 clib_error_t * dpdk_port_setup (dpdk_main_t * dm, dpdk_device_t * xd);
460 void dpdk_set_flowcontrol_callback (vlib_main_t *vm,
461 dpdk_flowcontrol_callback_t callback);
463 u32 dpdk_interface_tx_vector (vlib_main_t * vm, u32 dev_instance);
465 vlib_frame_queue_elt_t * vlib_get_handoff_queue_elt (u32 vlib_worker_index);
467 u32 dpdk_get_handoff_node_index (void);
469 void set_efd_bitmap (u8 *bitmap, u32 value, u32 op);
471 struct rte_mbuf * dpdk_replicate_packet_mb (vlib_buffer_t * b);
472 struct rte_mbuf * dpdk_zerocopy_replicate_packet_mb (vlib_buffer_t * b);
474 #define foreach_dpdk_error \
475 _(NONE, "no error") \
476 _(RX_PACKET_ERROR, "Rx packet errors") \
477 _(RX_BAD_FCS, "Rx bad fcs") \
478 _(L4_CHECKSUM_ERROR, "Rx L4 checksum errors") \
479 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
480 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
481 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
482 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error") \
483 _(IPV4_EFD_DROP_PKTS, "IPV4 Early Fast Discard rx drops") \
484 _(IPV6_EFD_DROP_PKTS, "IPV6 Early Fast Discard rx drops") \
485 _(MPLS_EFD_DROP_PKTS, "MPLS Early Fast Discard rx drops") \
486 _(VLAN_EFD_DROP_PKTS, "VLAN Early Fast Discard rx drops")
489 #define _(f,s) DPDK_ERROR_##f,
496 * Increment EFD drop counter
499 void increment_efd_drop_counter (vlib_main_t * vm, u32 counter_index, u32 count)
503 my_n = vlib_get_node (vm, dpdk_input_node.index);
504 vm->error_main.counters[my_n->error_heap_index+counter_index] += count;
507 int dpdk_set_stat_poll_interval (f64 interval);
508 int dpdk_set_link_state_poll_interval (f64 interval);
509 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
510 void dpdk_device_lock_init(dpdk_device_t * xd);
511 void dpdk_device_lock_free(dpdk_device_t * xd);
512 void dpdk_efd_update_counters(dpdk_device_t *xd, u32 n_buffers, u16 enabled);
513 u32 is_efd_discardable(vlib_thread_main_t *tm,
515 struct rte_mbuf *mb);
517 /* dpdk vhost-user interrupt management */
518 u8 dpdk_vhost_user_want_interrupt (dpdk_device_t *xd, int idx);
519 void dpdk_vhost_user_send_interrupt (vlib_main_t * vm, dpdk_device_t * xd,
523 static inline u64 vnet_get_aggregate_rx_packets (void)
525 dpdk_main_t * dm = &dpdk_main;
529 vec_foreach(dw, dm->workers)
530 sum += dw->aggregate_rx_packets;
535 void dpdk_rx_trace (dpdk_main_t * dm,
536 vlib_node_runtime_t * node,
542 #define EFD_OPERATION_LESS_THAN 0
543 #define EFD_OPERATION_GREATER_OR_EQUAL 1
545 void efd_config(u32 enabled,
546 u32 ip_prec, u32 ip_op,
547 u32 mpls_exp, u32 mpls_op,
548 u32 vlan_cos, u32 vlan_op);
550 void post_sw_interface_set_flags (vlib_main_t *vm, u32 sw_if_index, u32 flags);
552 typedef struct vhost_user_memory vhost_user_memory_t;
554 void dpdk_vhost_user_process_init (void **ctx);
555 void dpdk_vhost_user_process_cleanup (void *ctx);
556 uword dpdk_vhost_user_process_if (vlib_main_t *vm, dpdk_device_t *xd, void *ctx);
559 int dpdk_vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
560 const char * sock_filename,
564 u8 renumber, u32 custom_dev_instance,
566 int dpdk_vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
567 const char * sock_filename,
571 u8 renumber, u32 custom_dev_instance);
572 int dpdk_vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm,
574 int dpdk_vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
575 vhost_user_intf_details_t **out_vuids);
577 u32 dpdk_get_admin_up_down_in_progress (void);
579 u32 dpdk_num_mbufs (void);
581 int dpdk_io_thread_release (void);
583 dpdk_pmd_t dpdk_get_pmd_type (vnet_hw_interface_t *hi);
585 i8 dpdk_get_cpu_socket (vnet_hw_interface_t *hi);
588 dpdk_input_rss (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * f);
591 dpdk_get_hw_interface_stats (u32 hw_if_index, struct rte_eth_stats* dest);
593 format_function_t format_dpdk_device_name;
594 format_function_t format_dpdk_device;
595 format_function_t format_dpdk_tx_dma_trace;
596 format_function_t format_dpdk_rx_dma_trace;
597 format_function_t format_dpdk_rte_mbuf;
598 format_function_t format_dpdk_rx_rte_mbuf;
599 unformat_function_t unformat_socket_mem;
603 dpdk_pmd_constructor_init()
605 /* Add references to DPDK Driver Constructor functions to get the dynamic
606 * loader to pull in the driver library & run the constructors.
610 void devinitfn_ ##d(void); \
611 __attribute__((unused)) void (* volatile pf)(void); \
612 pf = devinitfn_ ##d; \
615 #ifdef RTE_LIBRTE_EM_PMD
619 #ifdef RTE_LIBRTE_IGB_PMD
623 #ifdef RTE_LIBRTE_IXGBE_PMD
627 #ifdef RTE_LIBRTE_I40E_PMD
632 #ifdef RTE_LIBRTE_FM10K_PMD
636 #ifdef RTE_LIBRTE_VIRTIO_PMD
640 #ifdef RTE_LIBRTE_VMXNET3_PMD
641 _(rte_vmxnet3_driver)
644 #ifdef RTE_LIBRTE_VICE_PMD
648 #ifdef RTE_LIBRTE_ENIC_PMD
652 #ifdef RTE_LIBRTE_PMD_AF_PACKET
656 #ifdef RTE_LIBRTE_CXGBE_PMD
660 #ifdef RTE_LIBRTE_PMD_BOND
667 * At the moment, the ThunderX NIC driver doesn't have
668 * an entry point named "devinitfn_rte_xxx_driver"
673 __attribute__((unused)) void (* volatile pf)(void); \
677 #ifdef RTE_LIBRTE_THUNDERVNIC_PMD
678 _(rte_nicvf_pmd_init)
684 #endif /* __included_dpdk_h__ */