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 (16<<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_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) \
95 _ ("rte_dpaa2_dpni", DPAA2)
99 #define _(s,f) VNET_DPDK_PMD_##f,
102 VNET_DPDK_PMD_UNKNOWN, /* must be last */
106 VNET_DPDK_PORT_TYPE_ETH_1G,
107 VNET_DPDK_PORT_TYPE_ETH_10G,
108 VNET_DPDK_PORT_TYPE_ETH_40G,
109 VNET_DPDK_PORT_TYPE_ETH_BOND,
110 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
111 VNET_DPDK_PORT_TYPE_AF_PACKET,
112 VNET_DPDK_PORT_TYPE_UNKNOWN,
117 vlib_frame_t * frame;
120 #define DPDK_EFD_MAX_DISCARD_RATE 10
126 u32 consec_full_frames_cnt;
131 u32 total_packet_cnt;
140 u32 n_since_last_int;
151 char sock_filename[256];
158 dpdk_vu_vring vrings[VHOST_MAX_QUEUE_PAIRS * 2];
159 u64 region_addr[VHOST_MEMORY_MAX_NREGIONS];
160 u32 region_fd[VHOST_MEMORY_MAX_NREGIONS];
161 u64 region_offset[VHOST_MEMORY_MAX_NREGIONS];
164 typedef void (*dpdk_flowcontrol_callback_t) (vlib_main_t *vm,
169 * The header for the tx_vector in dpdk_device_t.
170 * Head and tail are indexes into the tx_vector and are of type
171 * u64 so they never overflow.
179 CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
180 volatile u32 **lockp;
185 u32 vlib_hw_if_index;
186 u32 vlib_sw_if_index;
188 /* next node index if we decide to steal the rx graph arc */
189 u32 per_interface_next_index;
191 /* dpdk rte_mbuf rx and tx vectors, VLIB_FRAME_SIZE */
192 struct rte_mbuf *** tx_vectors; /* one per worker thread */
193 struct rte_mbuf *** rx_vectors;
195 /* vector of traced contexts, per device */
196 u32 * d_trace_buffers;
198 /* per-worker destination frame queue */
199 dpdk_frame_t * frames;
201 /* number of sub-interfaces */
204 dpdk_device_type_t dev_type:8;
211 CLIB_CACHE_LINE_ALIGN_MARK(cacheline1);
218 u16 * cpu_socket_id_by_queue;
219 struct rte_eth_conf port_conf;
220 struct rte_eth_txconf tx_conf;
226 /* vhost-user related */
228 struct virtio_net vu_vhost_dev;
230 dpdk_vu_intf_t *vu_intf;
233 u8 af_packet_port_id;
235 struct rte_eth_link link;
236 f64 time_last_link_update;
238 struct rte_eth_stats stats;
239 struct rte_eth_stats last_stats;
240 struct rte_eth_stats last_cleared_stats;
241 struct rte_eth_xstats * xstats;
242 struct rte_eth_xstats * last_cleared_xstats;
243 f64 time_last_stats_update;
244 dpdk_port_type_t port_type;
246 dpdk_efd_agent_t efd_agent;
247 u8 need_txlock; /* Used by VNET_DPDK_DEV_VHOST_USER */
251 #define DPDK_TX_RING_SIZE (4 * 1024)
253 #define DPDK_STATS_POLL_INTERVAL (10.0)
254 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
256 #define DPDK_LINK_POLL_INTERVAL (3.0)
257 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
260 CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
262 /* total input packet counter */
263 u64 aggregate_rx_packets;
269 } dpdk_device_and_queue_t;
271 /* Early-Fast-Discard (EFD) */
272 #define DPDK_EFD_DISABLED 0
273 #define DPDK_EFD_DISCARD_ENABLED (1 << 0)
274 #define DPDK_EFD_MONITOR_ENABLED (1 << 1)
275 #define DPDK_EFD_DROPALL_ENABLED (1 << 2)
277 #define DPDK_EFD_DEFAULT_DEVICE_QUEUE_HI_THRESH_PCT 90
278 #define DPDK_EFD_DEFAULT_CONSEC_FULL_FRAMES_HI_THRESH 6
280 typedef struct dpdk_efd_t {
283 u16 consec_full_frames_hi_thresh;
287 #define foreach_dpdk_device_config_item \
295 vlib_pci_addr_t pci_addr;
297 u8 vlan_strip_offload;
298 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
299 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
300 #define DPDK_DEVICE_VLAN_STRIP_ON 2
302 #define _(x) uword x;
303 foreach_dpdk_device_config_item
305 clib_bitmap_t * workers;
306 } dpdk_device_config_t;
312 u8 * eal_init_args_str;
313 u8 * uio_driver_name;
315 u8 enable_tcp_udp_checksum;
317 /* Required config parameters */
318 u8 coremask_set_manually;
319 u8 nchannels_set_manually;
323 u8 num_kni;/* while kni_init allows u32, port_id in callback fn is only u8 */
326 * format interface names ala xxxEthernet%d/%d/%d instead of
327 * xxxEthernet%x/%x/%x.
329 u8 interface_name_format_decimal;
331 /* virtio vhost-user switch */
334 /* vhost-user coalescence frames config */
335 u32 vhost_coalesce_frames;
336 f64 vhost_coalesce_time;
338 /* per-device config */
339 dpdk_device_config_t default_devconf;
340 dpdk_device_config_t * dev_confs;
341 uword * device_config_index_by_pci_addr;
343 } dpdk_config_main_t;
345 dpdk_config_main_t dpdk_config_main;
350 dpdk_device_t * devices;
351 dpdk_device_and_queue_t ** devices_by_cpu;
353 /* per-thread recycle lists */
356 /* buffer flags template, configurable to enable/disable tcp / udp cksum */
357 u32 buffer_flags_template;
359 /* flow control callback. If 0 then flow control is disabled */
360 dpdk_flowcontrol_callback_t flowcontrol_callback;
362 /* vlib buffer free list, must be same size as an rte_mbuf */
363 u32 vlib_buffer_free_list_index;
365 /* dpdk worker "threads" */
366 dpdk_worker_t * workers;
369 /* Ethernet input node index */
370 u32 ethernet_input_node_index;
372 /* pcap tracing [only works if (CLIB_DEBUG > 0)] */
374 pcap_main_t pcap_main;
376 u32 pcap_sw_if_index;
377 u32 pcap_pkts_to_capture;
380 uword * dpdk_device_by_kni_port_id;
381 uword * vu_sw_if_index_by_listener_fd;
382 uword * vu_sw_if_index_by_sock_fd;
383 u32 * vu_inactive_interfaces_device_index;
387 /* efd (early-fast-discard) settings */
391 * flag indicating that a posted admin up/down
392 * (via post_sw_interface_set_flags) is in progress
394 u8 admin_up_down_in_progress;
398 /* which cpus are running dpdk-input */
399 int input_cpu_first_index;
402 /* control interval of dpdk link state and stat polling */
403 f64 link_state_poll_interval;
404 f64 stat_poll_interval;
406 /* Sleep for this many MS after each device poll */
410 vlib_main_t * vlib_main;
411 vnet_main_t * vnet_main;
412 dpdk_config_main_t * conf;
415 dpdk_main_t dpdk_main;
418 DPDK_RX_NEXT_IP4_INPUT,
419 DPDK_RX_NEXT_IP6_INPUT,
420 DPDK_RX_NEXT_MPLS_INPUT,
421 DPDK_RX_NEXT_ETHERNET_INPUT,
431 /* Copy of VLIB buffer; packet data stored in pre_data. */
432 vlib_buffer_t buffer;
433 } dpdk_tx_dma_trace_t;
440 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
441 u8 data[256]; /* First 256 data bytes, used for hexdump */
442 } dpdk_rx_dma_trace_t;
444 void vnet_buffer_needs_dpdk_mb (vlib_buffer_t * b);
446 void dpdk_set_next_node (dpdk_rx_next_t, char *);
448 clib_error_t * dpdk_set_mac_address (vnet_hw_interface_t * hi, char * address);
450 clib_error_t * dpdk_set_mc_filter (vnet_hw_interface_t * hi,
451 struct ether_addr mc_addr_vec[], int naddr);
453 void dpdk_thread_input (dpdk_main_t * dm, dpdk_device_t * xd);
455 clib_error_t * dpdk_port_setup (dpdk_main_t * dm, dpdk_device_t * xd);
457 void dpdk_set_flowcontrol_callback (vlib_main_t *vm,
458 dpdk_flowcontrol_callback_t callback);
460 u32 dpdk_interface_tx_vector (vlib_main_t * vm, u32 dev_instance);
462 void set_efd_bitmap (u8 *bitmap, u32 value, u32 op);
464 struct rte_mbuf * dpdk_replicate_packet_mb (vlib_buffer_t * b);
465 struct rte_mbuf * dpdk_zerocopy_replicate_packet_mb (vlib_buffer_t * b);
467 #define foreach_dpdk_error \
468 _(NONE, "no error") \
469 _(RX_PACKET_ERROR, "Rx packet errors") \
470 _(RX_BAD_FCS, "Rx bad fcs") \
471 _(L4_CHECKSUM_ERROR, "Rx L4 checksum errors") \
472 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
473 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
474 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
475 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error") \
476 _(IPV4_EFD_DROP_PKTS, "IPV4 Early Fast Discard rx drops") \
477 _(IPV6_EFD_DROP_PKTS, "IPV6 Early Fast Discard rx drops") \
478 _(MPLS_EFD_DROP_PKTS, "MPLS Early Fast Discard rx drops") \
479 _(VLAN_EFD_DROP_PKTS, "VLAN Early Fast Discard rx drops")
482 #define _(f,s) DPDK_ERROR_##f,
489 * Increment EFD drop counter
492 void increment_efd_drop_counter (vlib_main_t * vm, u32 counter_index, u32 count)
496 my_n = vlib_get_node (vm, dpdk_input_node.index);
497 vm->error_main.counters[my_n->error_heap_index+counter_index] += count;
500 int dpdk_set_stat_poll_interval (f64 interval);
501 int dpdk_set_link_state_poll_interval (f64 interval);
502 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
503 void dpdk_device_lock_init(dpdk_device_t * xd);
504 void dpdk_device_lock_free(dpdk_device_t * xd);
505 void dpdk_efd_update_counters(dpdk_device_t *xd, u32 n_buffers, u16 enabled);
506 u32 is_efd_discardable(vlib_thread_main_t *tm,
508 struct rte_mbuf *mb);
510 /* dpdk vhost-user interrupt management */
511 u8 dpdk_vhost_user_want_interrupt (dpdk_device_t *xd, int idx);
512 void dpdk_vhost_user_send_interrupt (vlib_main_t * vm, dpdk_device_t * xd,
516 static inline u64 vnet_get_aggregate_rx_packets (void)
518 dpdk_main_t * dm = &dpdk_main;
522 vec_foreach(dw, dm->workers)
523 sum += dw->aggregate_rx_packets;
528 void dpdk_rx_trace (dpdk_main_t * dm,
529 vlib_node_runtime_t * node,
535 #define EFD_OPERATION_LESS_THAN 0
536 #define EFD_OPERATION_GREATER_OR_EQUAL 1
538 void efd_config(u32 enabled,
539 u32 ip_prec, u32 ip_op,
540 u32 mpls_exp, u32 mpls_op,
541 u32 vlan_cos, u32 vlan_op);
543 void post_sw_interface_set_flags (vlib_main_t *vm, u32 sw_if_index, u32 flags);
545 typedef struct vhost_user_memory vhost_user_memory_t;
547 void dpdk_vhost_user_process_init (void **ctx);
548 void dpdk_vhost_user_process_cleanup (void *ctx);
549 uword dpdk_vhost_user_process_if (vlib_main_t *vm, dpdk_device_t *xd, void *ctx);
552 int dpdk_vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
553 const char * sock_filename,
557 u8 renumber, u32 custom_dev_instance,
559 int dpdk_vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
560 const char * sock_filename,
564 u8 renumber, u32 custom_dev_instance);
565 int dpdk_vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm,
567 int dpdk_vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
568 vhost_user_intf_details_t **out_vuids);
570 u32 dpdk_get_admin_up_down_in_progress (void);
572 u32 dpdk_num_mbufs (void);
574 dpdk_pmd_t dpdk_get_pmd_type (vnet_hw_interface_t *hi);
576 i8 dpdk_get_cpu_socket (vnet_hw_interface_t *hi);
578 void * dpdk_input_multiarch_select();
579 void * dpdk_input_rss_multiarch_select();
580 void * dpdk_input_efd_multiarch_select();
583 dpdk_get_hw_interface_stats (u32 hw_if_index, struct rte_eth_stats* dest);
585 format_function_t format_dpdk_device_name;
586 format_function_t format_dpdk_device;
587 format_function_t format_dpdk_tx_dma_trace;
588 format_function_t format_dpdk_rx_dma_trace;
589 format_function_t format_dpdk_rte_mbuf;
590 format_function_t format_dpdk_rx_rte_mbuf;
591 unformat_function_t unformat_socket_mem;
592 clib_error_t * unformat_rss_fn(unformat_input_t * input, uword * rss_fn);
596 dpdk_pmd_constructor_init()
598 /* Add references to DPDK Driver Constructor functions to get the dynamic
599 * loader to pull in the driver library & run the constructors.
603 void devinitfn_ ##d(void); \
604 __attribute__((unused)) void (* volatile pf)(void); \
605 pf = devinitfn_ ##d; \
608 #ifdef RTE_LIBRTE_EM_PMD
612 #ifdef RTE_LIBRTE_IGB_PMD
616 #ifdef RTE_LIBRTE_IXGBE_PMD
620 #ifdef RTE_LIBRTE_I40E_PMD
625 #ifdef RTE_LIBRTE_FM10K_PMD
629 #ifdef RTE_LIBRTE_VIRTIO_PMD
633 #ifdef RTE_LIBRTE_VMXNET3_PMD
634 _(rte_vmxnet3_driver)
637 #ifdef RTE_LIBRTE_VICE_PMD
641 #ifdef RTE_LIBRTE_ENIC_PMD
645 #ifdef RTE_LIBRTE_PMD_AF_PACKET
649 #ifdef RTE_LIBRTE_CXGBE_PMD
653 #ifdef RTE_LIBRTE_PMD_BOND
657 #ifdef RTE_LIBRTE_DPAA2_PMD
664 * At the moment, the ThunderX NIC driver doesn't have
665 * an entry point named "devinitfn_rte_xxx_driver"
670 __attribute__((unused)) void (* volatile pf)(void); \
674 #ifdef RTE_LIBRTE_THUNDERVNIC_PMD
675 _(rte_nicvf_pmd_init)
682 admin_up_down_process (vlib_main_t * vm,
683 vlib_node_runtime_t * rt,
686 #endif /* __included_dpdk_h__ */