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 #if RTE_VERSION < RTE_VERSION_NUM(16, 7, 0, 0)
65 #define DPDK_VHOST_USER 1
67 #define DPDK_VHOST_USER 0
70 #include <vlib/pci/pci.h>
72 #define NB_MBUF (16<<10)
74 extern vnet_device_class_t dpdk_device_class;
75 extern vlib_node_registration_t dpdk_input_node;
76 extern vlib_node_registration_t handoff_dispatch_node;
79 VNET_DPDK_DEV_ETH = 1, /* Standard DPDK PMD driver */
80 VNET_DPDK_DEV_KNI, /* Kernel NIC Interface */
81 VNET_DPDK_DEV_VHOST_USER,
82 VNET_DPDK_DEV_UNKNOWN, /* must be last */
85 #define foreach_dpdk_pmd \
86 _ ("rte_nicvf_pmd", THUNDERX) \
87 _ ("rte_em_pmd", E1000EM) \
88 _ ("rte_igb_pmd", IGB) \
89 _ ("rte_igbvf_pmd", IGBVF) \
90 _ ("rte_ixgbe_pmd", IXGBE) \
91 _ ("rte_ixgbevf_pmd", IXGBEVF) \
92 _ ("rte_i40e_pmd", I40E) \
93 _ ("rte_i40evf_pmd", I40EVF) \
94 _ ("rte_virtio_pmd", VIRTIO) \
95 _ ("rte_enic_pmd", ENIC) \
96 _ ("rte_vmxnet3_pmd", VMXNET3) \
97 _ ("AF_PACKET PMD", AF_PACKET) \
98 _ ("rte_bond_pmd", BOND) \
99 _ ("rte_pmd_fm10k", FM10K) \
100 _ ("rte_cxgbe_pmd", CXGBE) \
101 _ ("rte_dpaa2_dpni", DPAA2)
105 #define _(s,f) VNET_DPDK_PMD_##f,
108 VNET_DPDK_PMD_UNKNOWN, /* must be last */
112 VNET_DPDK_PORT_TYPE_ETH_1G,
113 VNET_DPDK_PORT_TYPE_ETH_10G,
114 VNET_DPDK_PORT_TYPE_ETH_40G,
115 VNET_DPDK_PORT_TYPE_ETH_BOND,
116 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
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;
147 u32 n_since_last_int;
158 char sock_filename[256];
165 dpdk_vu_vring vrings[VHOST_MAX_QUEUE_PAIRS * 2];
166 u64 region_addr[VHOST_MEMORY_MAX_NREGIONS];
167 u32 region_fd[VHOST_MEMORY_MAX_NREGIONS];
168 u64 region_offset[VHOST_MEMORY_MAX_NREGIONS];
172 typedef void (*dpdk_flowcontrol_callback_t) (vlib_main_t *vm,
177 * The header for the tx_vector in dpdk_device_t.
178 * Head and tail are indexes into the tx_vector and are of type
179 * u64 so they never overflow.
187 CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
188 volatile u32 **lockp;
193 u32 vlib_hw_if_index;
194 u32 vlib_sw_if_index;
196 /* next node index if we decide to steal the rx graph arc */
197 u32 per_interface_next_index;
199 /* dpdk rte_mbuf rx and tx vectors, VLIB_FRAME_SIZE */
200 struct rte_mbuf *** tx_vectors; /* one per worker thread */
201 struct rte_mbuf *** rx_vectors;
203 /* vector of traced contexts, per device */
204 u32 * d_trace_buffers;
206 /* number of sub-interfaces */
209 dpdk_device_type_t dev_type:8;
216 CLIB_CACHE_LINE_ALIGN_MARK(cacheline1);
218 u8 * interface_name_suffix;
225 u16 * cpu_socket_id_by_queue;
226 struct rte_eth_conf port_conf;
227 struct rte_eth_txconf tx_conf;
234 /* vhost-user related */
236 struct virtio_net vu_vhost_dev;
238 dpdk_vu_intf_t *vu_intf;
242 u8 af_packet_port_id;
244 struct rte_eth_link link;
245 f64 time_last_link_update;
247 struct rte_eth_stats stats;
248 struct rte_eth_stats last_stats;
249 struct rte_eth_stats last_cleared_stats;
250 #if RTE_VERSION >= RTE_VERSION_NUM(16, 7, 0, 0)
251 struct rte_eth_xstat * xstats;
252 struct rte_eth_xstat * last_cleared_xstats;
254 struct rte_eth_xstats * xstats;
255 struct rte_eth_xstats * last_cleared_xstats;
257 f64 time_last_stats_update;
258 dpdk_port_type_t port_type;
260 dpdk_efd_agent_t efd_agent;
261 u8 need_txlock; /* Used by VNET_DPDK_DEV_VHOST_USER */
265 #define DPDK_TX_RING_SIZE (4 * 1024)
267 #define DPDK_STATS_POLL_INTERVAL (10.0)
268 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
270 #define DPDK_LINK_POLL_INTERVAL (3.0)
271 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
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;
301 #define foreach_dpdk_device_config_item \
309 vlib_pci_addr_t pci_addr;
311 u8 vlan_strip_offload;
312 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
313 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
314 #define DPDK_DEVICE_VLAN_STRIP_ON 2
316 #define _(x) uword x;
317 foreach_dpdk_device_config_item
319 clib_bitmap_t * workers;
320 } dpdk_device_config_t;
326 u8 * eal_init_args_str;
327 u8 * uio_driver_name;
329 u8 enable_tcp_udp_checksum;
331 /* Required config parameters */
332 u8 coremask_set_manually;
333 u8 nchannels_set_manually;
337 u8 num_kni;/* while kni_init allows u32, port_id in callback fn is only u8 */
340 * format interface names ala xxxEthernet%d/%d/%d instead of
341 * xxxEthernet%x/%x/%x.
343 u8 interface_name_format_decimal;
345 /* virtio vhost-user switch */
348 /* vhost-user coalescence frames config */
349 u32 vhost_coalesce_frames;
350 f64 vhost_coalesce_time;
352 /* per-device config */
353 dpdk_device_config_t default_devconf;
354 dpdk_device_config_t * dev_confs;
355 uword * device_config_index_by_pci_addr;
357 } dpdk_config_main_t;
359 dpdk_config_main_t dpdk_config_main;
364 dpdk_device_t * devices;
365 dpdk_device_and_queue_t ** devices_by_cpu;
367 /* per-thread recycle lists */
370 /* buffer flags template, configurable to enable/disable tcp / udp cksum */
371 u32 buffer_flags_template;
373 /* flow control callback. If 0 then flow control is disabled */
374 dpdk_flowcontrol_callback_t flowcontrol_callback;
376 /* vlib buffer free list, must be same size as an rte_mbuf */
377 u32 vlib_buffer_free_list_index;
379 /* dpdk worker "threads" */
380 dpdk_worker_t * workers;
383 /* Ethernet input node index */
384 u32 ethernet_input_node_index;
386 /* pcap tracing [only works if (CLIB_DEBUG > 0)] */
388 pcap_main_t pcap_main;
390 u32 pcap_sw_if_index;
391 u32 pcap_pkts_to_capture;
394 uword * dpdk_device_by_kni_port_id;
395 uword * vu_sw_if_index_by_listener_fd;
396 uword * vu_sw_if_index_by_sock_fd;
397 u32 * vu_inactive_interfaces_device_index;
401 /* efd (early-fast-discard) settings */
405 * flag indicating that a posted admin up/down
406 * (via post_sw_interface_set_flags) is in progress
408 u8 admin_up_down_in_progress;
412 /* which cpus are running dpdk-input */
413 int input_cpu_first_index;
416 /* control interval of dpdk link state and stat polling */
417 f64 link_state_poll_interval;
418 f64 stat_poll_interval;
420 /* Sleep for this many MS after each device poll */
424 vlib_main_t * vlib_main;
425 vnet_main_t * vnet_main;
426 dpdk_config_main_t * conf;
429 dpdk_main_t dpdk_main;
432 DPDK_RX_NEXT_IP4_INPUT,
433 DPDK_RX_NEXT_IP6_INPUT,
434 DPDK_RX_NEXT_MPLS_INPUT,
435 DPDK_RX_NEXT_ETHERNET_INPUT,
445 /* Copy of VLIB buffer; packet data stored in pre_data. */
446 vlib_buffer_t buffer;
447 } dpdk_tx_dma_trace_t;
454 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
455 u8 data[256]; /* First 256 data bytes, used for hexdump */
456 } dpdk_rx_dma_trace_t;
458 void vnet_buffer_needs_dpdk_mb (vlib_buffer_t * b);
460 void dpdk_set_next_node (dpdk_rx_next_t, char *);
462 clib_error_t * dpdk_set_mac_address (vnet_hw_interface_t * hi, char * address);
464 clib_error_t * dpdk_set_mc_filter (vnet_hw_interface_t * hi,
465 struct ether_addr mc_addr_vec[], int naddr);
467 void dpdk_thread_input (dpdk_main_t * dm, dpdk_device_t * xd);
469 clib_error_t * dpdk_port_setup (dpdk_main_t * dm, dpdk_device_t * xd);
471 void dpdk_set_flowcontrol_callback (vlib_main_t *vm,
472 dpdk_flowcontrol_callback_t callback);
474 u32 dpdk_interface_tx_vector (vlib_main_t * vm, u32 dev_instance);
476 void set_efd_bitmap (u8 *bitmap, u32 value, u32 op);
478 struct rte_mbuf * dpdk_replicate_packet_mb (vlib_buffer_t * b);
479 struct rte_mbuf * dpdk_zerocopy_replicate_packet_mb (vlib_buffer_t * b);
481 #define foreach_dpdk_error \
482 _(NONE, "no error") \
483 _(RX_PACKET_ERROR, "Rx packet errors") \
484 _(RX_BAD_FCS, "Rx bad fcs") \
485 _(L4_CHECKSUM_ERROR, "Rx L4 checksum errors") \
486 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
487 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
488 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
489 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error") \
490 _(IPV4_EFD_DROP_PKTS, "IPV4 Early Fast Discard rx drops") \
491 _(IPV6_EFD_DROP_PKTS, "IPV6 Early Fast Discard rx drops") \
492 _(MPLS_EFD_DROP_PKTS, "MPLS Early Fast Discard rx drops") \
493 _(VLAN_EFD_DROP_PKTS, "VLAN Early Fast Discard rx drops")
496 #define _(f,s) DPDK_ERROR_##f,
503 * Increment EFD drop counter
506 void increment_efd_drop_counter (vlib_main_t * vm, u32 counter_index, u32 count)
510 my_n = vlib_get_node (vm, dpdk_input_node.index);
511 vm->error_main.counters[my_n->error_heap_index+counter_index] += count;
514 int dpdk_set_stat_poll_interval (f64 interval);
515 int dpdk_set_link_state_poll_interval (f64 interval);
516 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
517 void dpdk_device_lock_init(dpdk_device_t * xd);
518 void dpdk_device_lock_free(dpdk_device_t * xd);
519 void dpdk_efd_update_counters(dpdk_device_t *xd, u32 n_buffers, u16 enabled);
520 u32 is_efd_discardable(vlib_thread_main_t *tm,
522 struct rte_mbuf *mb);
525 /* dpdk vhost-user interrupt management */
526 u8 dpdk_vhost_user_want_interrupt (dpdk_device_t *xd, int idx);
527 void dpdk_vhost_user_send_interrupt (vlib_main_t * vm, dpdk_device_t * xd,
532 static inline u64 vnet_get_aggregate_rx_packets (void)
534 dpdk_main_t * dm = &dpdk_main;
538 vec_foreach(dw, dm->workers)
539 sum += dw->aggregate_rx_packets;
544 void dpdk_rx_trace (dpdk_main_t * dm,
545 vlib_node_runtime_t * node,
551 #define EFD_OPERATION_LESS_THAN 0
552 #define EFD_OPERATION_GREATER_OR_EQUAL 1
554 void efd_config(u32 enabled,
555 u32 ip_prec, u32 ip_op,
556 u32 mpls_exp, u32 mpls_op,
557 u32 vlan_cos, u32 vlan_op);
559 void post_sw_interface_set_flags (vlib_main_t *vm, u32 sw_if_index, u32 flags);
562 typedef struct vhost_user_memory vhost_user_memory_t;
564 void dpdk_vhost_user_process_init (void **ctx);
565 void dpdk_vhost_user_process_cleanup (void *ctx);
566 uword dpdk_vhost_user_process_if (vlib_main_t *vm, dpdk_device_t *xd, void *ctx);
569 int dpdk_vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
570 const char * sock_filename,
574 u8 renumber, u32 custom_dev_instance,
576 int dpdk_vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
577 const char * sock_filename,
581 u8 renumber, u32 custom_dev_instance);
582 int dpdk_vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm,
584 int dpdk_vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
585 vhost_user_intf_details_t **out_vuids);
588 u32 dpdk_get_admin_up_down_in_progress (void);
590 u32 dpdk_num_mbufs (void);
592 dpdk_pmd_t dpdk_get_pmd_type (vnet_hw_interface_t *hi);
594 i8 dpdk_get_cpu_socket (vnet_hw_interface_t *hi);
596 void * dpdk_input_multiarch_select();
597 void * dpdk_input_rss_multiarch_select();
598 void * dpdk_input_efd_multiarch_select();
601 dpdk_get_hw_interface_stats (u32 hw_if_index, struct rte_eth_stats* dest);
603 format_function_t format_dpdk_device_name;
604 format_function_t format_dpdk_device;
605 format_function_t format_dpdk_tx_dma_trace;
606 format_function_t format_dpdk_rx_dma_trace;
607 format_function_t format_dpdk_rte_mbuf;
608 format_function_t format_dpdk_rx_rte_mbuf;
609 unformat_function_t unformat_socket_mem;
610 clib_error_t * unformat_rss_fn(unformat_input_t * input, uword * rss_fn);
614 dpdk_pmd_constructor_init()
616 /* Add references to DPDK Driver Constructor functions to get the dynamic
617 * loader to pull in the driver library & run the constructors.
621 void devinitfn_ ##d(void); \
622 __attribute__((unused)) void (* volatile pf)(void); \
623 pf = devinitfn_ ##d; \
626 #ifdef RTE_LIBRTE_EM_PMD
630 #ifdef RTE_LIBRTE_IGB_PMD
634 #ifdef RTE_LIBRTE_IXGBE_PMD
638 #ifdef RTE_LIBRTE_I40E_PMD
643 #ifdef RTE_LIBRTE_FM10K_PMD
647 #ifdef RTE_LIBRTE_VIRTIO_PMD
651 #ifdef RTE_LIBRTE_VMXNET3_PMD
652 _(rte_vmxnet3_driver)
655 #ifdef RTE_LIBRTE_VICE_PMD
659 #ifdef RTE_LIBRTE_ENIC_PMD
663 #ifdef RTE_LIBRTE_PMD_AF_PACKET
667 #ifdef RTE_LIBRTE_CXGBE_PMD
671 #ifdef RTE_LIBRTE_PMD_BOND
675 #ifdef RTE_LIBRTE_DPAA2_PMD
682 * At the moment, the ThunderX NIC driver doesn't have
683 * an entry point named "devinitfn_rte_xxx_driver"
688 __attribute__((unused)) void (* volatile pf)(void); \
692 #ifdef RTE_LIBRTE_THUNDERVNIC_PMD
693 _(rte_nicvf_pmd_init)
700 admin_up_down_process (vlib_main_t * vm,
701 vlib_node_runtime_t * rt,
704 #endif /* __included_dpdk_h__ */