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 #include <vlib/pci/pci.h>
66 #define NB_MBUF (32<<10)
68 extern vnet_device_class_t dpdk_device_class;
69 extern vlib_node_registration_t dpdk_input_node;
70 extern vlib_node_registration_t handoff_dispatch_node;
73 VNET_DPDK_DEV_ETH = 1, /* Standard DPDK PMD driver */
74 VNET_DPDK_DEV_KNI, /* Kernel NIC Interface */
75 VNET_DPDK_DEV_VHOST_USER,
76 VNET_DPDK_DEV_UNKNOWN, /* must be last */
79 #define foreach_dpdk_pmd \
80 _ ("rte_nicvf_pmd", THUNDERX) \
81 _ ("rte_em_pmd", E1000EM) \
82 _ ("rte_igb_pmd", IGB) \
83 _ ("rte_igbvf_pmd", IGBVF) \
84 _ ("rte_ixgbe_pmd", IXGBE) \
85 _ ("rte_ixgbevf_pmd", IXGBEVF) \
86 _ ("rte_i40e_pmd", I40E) \
87 _ ("rte_i40evf_pmd", I40EVF) \
88 _ ("rte_virtio_pmd", VIRTIO) \
89 _ ("rte_vice_pmd", VICE) \
90 _ ("rte_enic_pmd", ENIC) \
91 _ ("rte_vmxnet3_pmd", VMXNET3) \
92 _ ("AF_PACKET PMD", AF_PACKET) \
93 _ ("rte_bond_pmd", BOND) \
94 _ ("rte_pmd_fm10k", FM10K) \
95 _ ("rte_cxgbe_pmd", CXGBE)
99 #define _(s,f) VNET_DPDK_PMD_##f,
103 VNET_DPDK_PMD_NETMAP,
105 VNET_DPDK_PMD_UNKNOWN, /* must be last */
109 VNET_DPDK_PORT_TYPE_ETH_1G,
110 VNET_DPDK_PORT_TYPE_ETH_10G,
111 VNET_DPDK_PORT_TYPE_ETH_40G,
112 VNET_DPDK_PORT_TYPE_ETH_BOND,
113 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
115 VNET_DPDK_PORT_TYPE_NETMAP,
117 VNET_DPDK_PORT_TYPE_AF_PACKET,
118 VNET_DPDK_PORT_TYPE_UNKNOWN,
123 vlib_frame_t * frame;
126 #define DPDK_EFD_MAX_DISCARD_RATE 10
132 u32 consec_full_frames_cnt;
137 u32 total_packet_cnt;
144 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
148 u32 n_since_last_int;
159 char sock_filename[256];
166 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
167 dpdk_vu_vring vrings[VHOST_MAX_QUEUE_PAIRS * 2];
169 dpdk_vu_vring vrings[2];
171 u64 region_addr[VHOST_MEMORY_MAX_NREGIONS];
172 u32 region_fd[VHOST_MEMORY_MAX_NREGIONS];
173 u64 region_offset[VHOST_MEMORY_MAX_NREGIONS];
176 typedef void (*dpdk_flowcontrol_callback_t) (vlib_main_t *vm,
181 * The header for the tx_vector in dpdk_device_t.
182 * Head and tail are indexes into the tx_vector and are of type
183 * u64 so they never overflow.
191 CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
192 volatile u32 **lockp;
197 u32 vlib_hw_if_index;
198 u32 vlib_sw_if_index;
200 /* next node index if we decide to steal the rx graph arc */
201 u32 per_interface_next_index;
203 /* dpdk rte_mbuf rx and tx vectors, VLIB_FRAME_SIZE */
204 struct rte_mbuf *** tx_vectors; /* one per worker thread */
205 struct rte_mbuf *** rx_vectors;
207 /* vector of traced contexts, per device */
208 u32 * d_trace_buffers;
210 /* per-worker destination frame queue */
211 dpdk_frame_t * frames;
213 /* number of sub-interfaces */
216 dpdk_device_type_t dev_type:8;
223 CLIB_CACHE_LINE_ALIGN_MARK(cacheline1);
230 u16 * cpu_socket_id_by_queue;
231 struct rte_eth_conf port_conf;
232 struct rte_eth_txconf tx_conf;
238 /* vhost-user related */
240 struct virtio_net vu_vhost_dev;
242 dpdk_vu_intf_t *vu_intf;
245 u8 af_packet_port_id;
247 struct rte_eth_link link;
248 f64 time_last_link_update;
250 struct rte_eth_stats stats;
251 struct rte_eth_stats last_stats;
252 struct rte_eth_stats last_cleared_stats;
253 struct rte_eth_xstats * xstats;
254 struct rte_eth_xstats * last_cleared_xstats;
255 f64 time_last_stats_update;
256 dpdk_port_type_t port_type;
258 dpdk_efd_agent_t efd_agent;
259 u8 need_txlock; /* Used by VNET_DPDK_DEV_VHOST_USER */
264 CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
272 i32 n_vectors[MAX_NELTS];
273 } frame_queue_trace_t;
276 u64 count[MAX_NELTS];
277 } frame_queue_nelt_counter_t;
279 #define DPDK_TX_RING_SIZE (4 * 1024)
281 #define DPDK_STATS_POLL_INTERVAL (10.0)
282 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
284 #define DPDK_LINK_POLL_INTERVAL (3.0)
285 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
288 CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
290 /* total input packet counter */
291 u64 aggregate_rx_packets;
297 } dpdk_device_and_queue_t;
299 /* Early-Fast-Discard (EFD) */
300 #define DPDK_EFD_DISABLED 0
301 #define DPDK_EFD_DISCARD_ENABLED (1 << 0)
302 #define DPDK_EFD_MONITOR_ENABLED (1 << 1)
303 #define DPDK_EFD_DROPALL_ENABLED (1 << 2)
305 #define DPDK_EFD_DEFAULT_DEVICE_QUEUE_HI_THRESH_PCT 90
306 #define DPDK_EFD_DEFAULT_CONSEC_FULL_FRAMES_HI_THRESH 6
308 typedef struct dpdk_efd_t {
311 u16 consec_full_frames_hi_thresh;
315 #define foreach_dpdk_device_config_item \
323 vlib_pci_addr_t pci_addr;
325 #define _(x) uword x;
326 foreach_dpdk_device_config_item
328 clib_bitmap_t * workers;
329 } dpdk_device_config_t;
335 u8 * eal_init_args_str;
336 u8 * uio_driver_name;
338 u8 enable_tcp_udp_checksum;
340 /* Required config parameters */
341 u8 coremask_set_manually;
342 u8 nchannels_set_manually;
346 u8 num_kni;/* while kni_init allows u32, port_id in callback fn is only u8 */
349 * format interface names ala xxxEthernet%d/%d/%d instead of
350 * xxxEthernet%x/%x/%x. For VIRL.
352 u8 interface_name_format_decimal;
354 /* virtio vhost-user switch */
357 /* vhost-user coalescence frames config */
358 u32 vhost_coalesce_frames;
359 f64 vhost_coalesce_time;
361 /* per-device config */
362 dpdk_device_config_t default_devconf;
363 dpdk_device_config_t * dev_confs;
364 uword * device_config_index_by_pci_addr;
366 } dpdk_config_main_t;
368 dpdk_config_main_t dpdk_config_main;
373 dpdk_device_t * devices;
374 dpdk_device_and_queue_t ** devices_by_cpu;
376 /* per-thread recycle lists */
379 /* buffer flags template, configurable to enable/disable tcp / udp cksum */
380 u32 buffer_flags_template;
382 /* flow control callback. If 0 then flow control is disabled */
383 dpdk_flowcontrol_callback_t flowcontrol_callback;
385 /* vlib buffer free list, must be same size as an rte_mbuf */
386 u32 vlib_buffer_free_list_index;
388 /* dpdk worker "threads" */
389 dpdk_worker_t * workers;
392 /* Ethernet input node index */
393 u32 ethernet_input_node_index;
395 /* dpdk i/o thread initialization barrier */
396 volatile u32 worker_thread_release;
398 /* pcap tracing [only works if (CLIB_DEBUG > 0)] */
400 pcap_main_t pcap_main;
402 u32 pcap_sw_if_index;
403 u32 pcap_pkts_to_capture;
406 uword * dpdk_device_by_kni_port_id;
407 uword * vu_sw_if_index_by_listener_fd;
408 uword * vu_sw_if_index_by_sock_fd;
409 u32 * vu_inactive_interfaces_device_index;
413 /* efd (early-fast-discard) settings */
417 * flag indicating that a posted admin up/down
418 * (via post_sw_interface_set_flags) is in progress
420 u8 admin_up_down_in_progress;
424 /* which cpus are running dpdk-input */
425 int input_cpu_first_index;
428 /* control interval of dpdk link state and stat polling */
429 f64 link_state_poll_interval;
430 f64 stat_poll_interval;
432 /* for frame queue tracing */
433 frame_queue_trace_t *frame_queue_traces;
434 frame_queue_nelt_counter_t *frame_queue_histogram;
436 /* Sleep for this many MS after each device poll */
440 vlib_main_t * vlib_main;
441 vnet_main_t * vnet_main;
442 dpdk_config_main_t * conf;
445 dpdk_main_t dpdk_main;
448 DPDK_RX_NEXT_IP4_INPUT,
449 DPDK_RX_NEXT_IP6_INPUT,
450 DPDK_RX_NEXT_MPLS_INPUT,
451 DPDK_RX_NEXT_ETHERNET_INPUT,
461 /* Copy of VLIB buffer; packet data stored in pre_data. */
462 vlib_buffer_t buffer;
463 } dpdk_tx_dma_trace_t;
470 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
471 u8 data[256]; /* First 256 data bytes, used for hexdump */
472 } dpdk_rx_dma_trace_t;
474 void vnet_buffer_needs_dpdk_mb (vlib_buffer_t * b);
476 void dpdk_set_next_node (dpdk_rx_next_t, char *);
478 clib_error_t * dpdk_set_mac_address (vnet_hw_interface_t * hi, char * address);
480 clib_error_t * dpdk_set_mc_filter (vnet_hw_interface_t * hi,
481 struct ether_addr mc_addr_vec[], int naddr);
483 void dpdk_thread_input (dpdk_main_t * dm, dpdk_device_t * xd);
485 clib_error_t * dpdk_port_setup (dpdk_main_t * dm, dpdk_device_t * xd);
487 void dpdk_set_flowcontrol_callback (vlib_main_t *vm,
488 dpdk_flowcontrol_callback_t callback);
490 u32 dpdk_interface_tx_vector (vlib_main_t * vm, u32 dev_instance);
492 void set_efd_bitmap (u8 *bitmap, u32 value, u32 op);
494 struct rte_mbuf * dpdk_replicate_packet_mb (vlib_buffer_t * b);
495 struct rte_mbuf * dpdk_zerocopy_replicate_packet_mb (vlib_buffer_t * b);
497 #define foreach_dpdk_error \
498 _(NONE, "no error") \
499 _(RX_PACKET_ERROR, "Rx packet errors") \
500 _(RX_BAD_FCS, "Rx bad fcs") \
501 _(L4_CHECKSUM_ERROR, "Rx L4 checksum errors") \
502 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
503 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
504 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
505 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error") \
506 _(IPV4_EFD_DROP_PKTS, "IPV4 Early Fast Discard rx drops") \
507 _(IPV6_EFD_DROP_PKTS, "IPV6 Early Fast Discard rx drops") \
508 _(MPLS_EFD_DROP_PKTS, "MPLS Early Fast Discard rx drops") \
509 _(VLAN_EFD_DROP_PKTS, "VLAN Early Fast Discard rx drops")
512 #define _(f,s) DPDK_ERROR_##f,
519 * Increment EFD drop counter
522 void increment_efd_drop_counter (vlib_main_t * vm, u32 counter_index, u32 count)
526 my_n = vlib_get_node (vm, dpdk_input_node.index);
527 vm->error_main.counters[my_n->error_heap_index+counter_index] += count;
530 int dpdk_set_stat_poll_interval (f64 interval);
531 int dpdk_set_link_state_poll_interval (f64 interval);
532 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
533 void dpdk_device_lock_init(dpdk_device_t * xd);
534 void dpdk_device_lock_free(dpdk_device_t * xd);
535 void dpdk_efd_update_counters(dpdk_device_t *xd, u32 n_buffers, u16 enabled);
536 u32 is_efd_discardable(vlib_thread_main_t *tm,
538 struct rte_mbuf *mb);
540 /* dpdk vhost-user interrupt management */
541 u8 dpdk_vhost_user_want_interrupt (dpdk_device_t *xd, int idx);
542 void dpdk_vhost_user_send_interrupt (vlib_main_t * vm, dpdk_device_t * xd,
546 static inline u64 vnet_get_aggregate_rx_packets (void)
548 dpdk_main_t * dm = &dpdk_main;
552 vec_foreach(dw, dm->workers)
553 sum += dw->aggregate_rx_packets;
558 void dpdk_rx_trace (dpdk_main_t * dm,
559 vlib_node_runtime_t * node,
565 #define EFD_OPERATION_LESS_THAN 0
566 #define EFD_OPERATION_GREATER_OR_EQUAL 1
568 void efd_config(u32 enabled,
569 u32 ip_prec, u32 ip_op,
570 u32 mpls_exp, u32 mpls_op,
571 u32 vlan_cos, u32 vlan_op);
573 void post_sw_interface_set_flags (vlib_main_t *vm, u32 sw_if_index, u32 flags);
575 typedef struct vhost_user_memory vhost_user_memory_t;
577 void dpdk_vhost_user_process_init (void **ctx);
578 void dpdk_vhost_user_process_cleanup (void *ctx);
579 uword dpdk_vhost_user_process_if (vlib_main_t *vm, dpdk_device_t *xd, void *ctx);
582 int dpdk_vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
583 const char * sock_filename,
587 u8 renumber, u32 custom_dev_instance,
589 int dpdk_vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
590 const char * sock_filename,
594 u8 renumber, u32 custom_dev_instance);
595 int dpdk_vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm,
597 int dpdk_vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
598 vhost_user_intf_details_t **out_vuids);
600 u32 dpdk_get_admin_up_down_in_progress (void);
602 u32 dpdk_num_mbufs (void);
604 dpdk_pmd_t dpdk_get_pmd_type (vnet_hw_interface_t *hi);
606 i8 dpdk_get_cpu_socket (vnet_hw_interface_t *hi);
608 void * dpdk_input_multiarch_select();
609 void * dpdk_input_rss_multiarch_select();
610 void * dpdk_input_efd_multiarch_select();
613 dpdk_get_hw_interface_stats (u32 hw_if_index, struct rte_eth_stats* dest);
615 format_function_t format_dpdk_device_name;
616 format_function_t format_dpdk_device;
617 format_function_t format_dpdk_tx_dma_trace;
618 format_function_t format_dpdk_rx_dma_trace;
619 format_function_t format_dpdk_rte_mbuf;
620 format_function_t format_dpdk_rx_rte_mbuf;
621 unformat_function_t unformat_socket_mem;
622 clib_error_t * unformat_rss_fn(unformat_input_t * input, uword * rss_fn);
626 dpdk_pmd_constructor_init()
628 /* Add references to DPDK Driver Constructor functions to get the dynamic
629 * loader to pull in the driver library & run the constructors.
633 void devinitfn_ ##d(void); \
634 __attribute__((unused)) void (* volatile pf)(void); \
635 pf = devinitfn_ ##d; \
638 #ifdef RTE_LIBRTE_EM_PMD
642 #ifdef RTE_LIBRTE_IGB_PMD
646 #ifdef RTE_LIBRTE_IXGBE_PMD
650 #ifdef RTE_LIBRTE_I40E_PMD
655 #ifdef RTE_LIBRTE_FM10K_PMD
659 #ifdef RTE_LIBRTE_VIRTIO_PMD
663 #ifdef RTE_LIBRTE_VMXNET3_PMD
664 _(rte_vmxnet3_driver)
667 #ifdef RTE_LIBRTE_VICE_PMD
671 #ifdef RTE_LIBRTE_ENIC_PMD
675 #ifdef RTE_LIBRTE_PMD_AF_PACKET
679 #ifdef RTE_LIBRTE_CXGBE_PMD
683 #ifdef RTE_LIBRTE_PMD_BOND
690 * At the moment, the ThunderX NIC driver doesn't have
691 * an entry point named "devinitfn_rte_xxx_driver"
696 __attribute__((unused)) void (* volatile pf)(void); \
700 #ifdef RTE_LIBRTE_THUNDERVNIC_PMD
701 _(rte_nicvf_pmd_init)
708 admin_up_down_process (vlib_main_t * vm,
709 vlib_node_runtime_t * rt,
712 #endif /* __included_dpdk_h__ */