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;
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_enic_pmd", ENIC) \
89 _ ("rte_vmxnet3_pmd", VMXNET3) \
90 _ ("AF_PACKET PMD", AF_PACKET) \
91 _ ("rte_bond_pmd", BOND) \
92 _ ("rte_pmd_fm10k", FM10K) \
93 _ ("rte_cxgbe_pmd", CXGBE) \
94 _ ("rte_dpaa2_dpni", DPAA2)
99 #define _(s,f) VNET_DPDK_PMD_##f,
102 VNET_DPDK_PMD_UNKNOWN, /* must be last */
107 VNET_DPDK_PORT_TYPE_ETH_1G,
108 VNET_DPDK_PORT_TYPE_ETH_10G,
109 VNET_DPDK_PORT_TYPE_ETH_40G,
110 VNET_DPDK_PORT_TYPE_ETH_BOND,
111 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
112 VNET_DPDK_PORT_TYPE_AF_PACKET,
113 VNET_DPDK_PORT_TYPE_UNKNOWN,
122 #define DPDK_EFD_MAX_DISCARD_RATE 10
129 u32 consec_full_frames_cnt;
134 u32 total_packet_cnt;
145 u32 n_since_last_int;
157 char sock_filename[256];
164 dpdk_vu_vring vrings[VHOST_MAX_QUEUE_PAIRS * 2];
165 u64 region_addr[VHOST_MEMORY_MAX_NREGIONS];
166 u32 region_fd[VHOST_MEMORY_MAX_NREGIONS];
167 u64 region_offset[VHOST_MEMORY_MAX_NREGIONS];
171 typedef void (*dpdk_flowcontrol_callback_t) (vlib_main_t * vm,
172 u32 hw_if_index, u32 n_packets);
175 * The header for the tx_vector in dpdk_device_t.
176 * Head and tail are indexes into the tx_vector and are of type
177 * 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;
210 #define DPDK_DEVICE_FLAG_ADMIN_UP (1 << 0)
211 #define DPDK_DEVICE_FLAG_PROMISC (1 << 1)
212 #define DPDK_DEVICE_FLAG_PMD (1 << 2)
213 #define DPDK_DEVICE_FLAG_KNI (1 << 3)
214 #define DPDK_DEVICE_FLAG_VHOST_USER (1 << 4)
215 #define DPDK_DEVICE_FLAG_HAVE_SUBIF (1 << 5)
217 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
219 u8 *interface_name_suffix;
221 /* number of sub-interfaces */
229 u16 *cpu_socket_id_by_queue;
230 struct rte_eth_conf port_conf;
231 struct rte_eth_txconf tx_conf;
238 /* vhost-user related */
240 struct virtio_net vu_vhost_dev;
242 dpdk_vu_intf_t *vu_intf;
246 u8 af_packet_port_id;
248 struct rte_eth_link link;
249 f64 time_last_link_update;
251 struct rte_eth_stats stats;
252 struct rte_eth_stats last_stats;
253 struct rte_eth_stats last_cleared_stats;
254 #if RTE_VERSION >= RTE_VERSION_NUM(16, 7, 0, 0)
255 struct rte_eth_xstat *xstats;
256 struct rte_eth_xstat *last_cleared_xstats;
258 struct rte_eth_xstats *xstats;
259 struct rte_eth_xstats *last_cleared_xstats;
261 f64 time_last_stats_update;
262 dpdk_port_type_t port_type;
264 dpdk_efd_agent_t efd_agent;
265 u8 need_txlock; /* Used by VNET_DPDK_DEV_VHOST_USER */
269 #define DPDK_TX_RING_SIZE (4 * 1024)
271 #define DPDK_STATS_POLL_INTERVAL (10.0)
272 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
274 #define DPDK_LINK_POLL_INTERVAL (3.0)
275 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
279 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
281 /* total input packet counter */
282 u64 aggregate_rx_packets;
289 } dpdk_device_and_queue_t;
291 /* Early-Fast-Discard (EFD) */
292 #define DPDK_EFD_DISABLED 0
293 #define DPDK_EFD_DISCARD_ENABLED (1 << 0)
294 #define DPDK_EFD_MONITOR_ENABLED (1 << 1)
295 #define DPDK_EFD_DROPALL_ENABLED (1 << 2)
297 #define DPDK_EFD_DEFAULT_DEVICE_QUEUE_HI_THRESH_PCT 90
298 #define DPDK_EFD_DEFAULT_CONSEC_FULL_FRAMES_HI_THRESH 6
300 typedef struct dpdk_efd_t
304 u16 consec_full_frames_hi_thresh;
308 #define foreach_dpdk_device_config_item \
317 vlib_pci_addr_t pci_addr;
319 u8 vlan_strip_offload;
320 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
321 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
322 #define DPDK_DEVICE_VLAN_STRIP_ON 2
324 #define _(x) uword x;
325 foreach_dpdk_device_config_item
327 clib_bitmap_t * workers;
328 } dpdk_device_config_t;
335 u8 *eal_init_args_str;
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.
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;
374 dpdk_device_t *devices;
375 dpdk_device_and_queue_t **devices_by_cpu;
377 /* per-thread recycle lists */
380 /* buffer flags template, configurable to enable/disable tcp / udp cksum */
381 u32 buffer_flags_template;
383 /* flow control callback. If 0 then flow control is disabled */
384 dpdk_flowcontrol_callback_t flowcontrol_callback;
386 /* vlib buffer free list, must be same size as an rte_mbuf */
387 u32 vlib_buffer_free_list_index;
389 /* dpdk worker "threads" */
390 dpdk_worker_t *workers;
393 /* Ethernet input node index */
394 u32 ethernet_input_node_index;
396 /* pcap tracing [only works if (CLIB_DEBUG > 0)] */
398 pcap_main_t pcap_main;
400 u32 pcap_sw_if_index;
401 u32 pcap_pkts_to_capture;
404 uword *dpdk_device_by_kni_port_id;
405 uword *vu_sw_if_index_by_listener_fd;
406 uword *vu_sw_if_index_by_sock_fd;
407 u32 *vu_inactive_interfaces_device_index;
411 /* efd (early-fast-discard) settings */
415 * flag indicating that a posted admin up/down
416 * (via post_sw_interface_set_flags) is in progress
418 u8 admin_up_down_in_progress;
422 /* which cpus are running dpdk-input */
423 int input_cpu_first_index;
426 /* control interval of dpdk link state and stat polling */
427 f64 link_state_poll_interval;
428 f64 stat_poll_interval;
430 /* Sleep for this many MS after each device poll */
434 vlib_main_t *vlib_main;
435 vnet_main_t *vnet_main;
436 dpdk_config_main_t *conf;
439 dpdk_main_t dpdk_main;
443 DPDK_RX_NEXT_IP4_INPUT,
444 DPDK_RX_NEXT_IP6_INPUT,
445 DPDK_RX_NEXT_MPLS_INPUT,
446 DPDK_RX_NEXT_ETHERNET_INPUT,
457 /* Copy of VLIB buffer; packet data stored in pre_data. */
458 vlib_buffer_t buffer;
459 } dpdk_tx_dma_trace_t;
467 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
468 u8 data[256]; /* First 256 data bytes, used for hexdump */
469 } dpdk_rx_dma_trace_t;
471 void vnet_buffer_needs_dpdk_mb (vlib_buffer_t * b);
473 void dpdk_set_next_node (dpdk_rx_next_t, char *);
475 clib_error_t *dpdk_set_mac_address (vnet_hw_interface_t * hi, char *address);
477 clib_error_t *dpdk_set_mc_filter (vnet_hw_interface_t * hi,
478 struct ether_addr mc_addr_vec[], int naddr);
480 void dpdk_thread_input (dpdk_main_t * dm, dpdk_device_t * xd);
482 clib_error_t *dpdk_port_setup (dpdk_main_t * dm, dpdk_device_t * xd);
484 void dpdk_set_flowcontrol_callback (vlib_main_t * vm,
485 dpdk_flowcontrol_callback_t callback);
487 u32 dpdk_interface_tx_vector (vlib_main_t * vm, u32 dev_instance);
489 void set_efd_bitmap (u8 * bitmap, u32 value, u32 op);
491 struct rte_mbuf *dpdk_replicate_packet_mb (vlib_buffer_t * b);
492 struct rte_mbuf *dpdk_zerocopy_replicate_packet_mb (vlib_buffer_t * b);
494 #define foreach_dpdk_error \
495 _(NONE, "no error") \
496 _(RX_PACKET_ERROR, "Rx packet errors") \
497 _(RX_BAD_FCS, "Rx bad fcs") \
498 _(L4_CHECKSUM_ERROR, "Rx L4 checksum errors") \
499 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
500 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
501 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
502 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error") \
503 _(IPV4_EFD_DROP_PKTS, "IPV4 Early Fast Discard rx drops") \
504 _(IPV6_EFD_DROP_PKTS, "IPV6 Early Fast Discard rx drops") \
505 _(MPLS_EFD_DROP_PKTS, "MPLS Early Fast Discard rx drops") \
506 _(VLAN_EFD_DROP_PKTS, "VLAN Early Fast Discard rx drops")
510 #define _(f,s) DPDK_ERROR_##f,
517 * Increment EFD drop counter
519 static_always_inline void
520 increment_efd_drop_counter (vlib_main_t * vm, u32 counter_index, u32 count)
524 my_n = vlib_get_node (vm, dpdk_input_node.index);
525 vm->error_main.counters[my_n->error_heap_index + counter_index] += count;
528 int dpdk_set_stat_poll_interval (f64 interval);
529 int dpdk_set_link_state_poll_interval (f64 interval);
530 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
531 void dpdk_device_lock_init (dpdk_device_t * xd);
532 void dpdk_device_lock_free (dpdk_device_t * xd);
533 void dpdk_efd_update_counters (dpdk_device_t * xd, u32 n_buffers,
535 u32 is_efd_discardable (vlib_thread_main_t * tm, vlib_buffer_t * b0,
536 struct rte_mbuf *mb);
539 /* dpdk vhost-user interrupt management */
540 u8 dpdk_vhost_user_want_interrupt (dpdk_device_t * xd, int idx);
541 void dpdk_vhost_user_send_interrupt (vlib_main_t * vm, dpdk_device_t * xd,
547 vnet_get_aggregate_rx_packets (void)
549 dpdk_main_t *dm = &dpdk_main;
553 vec_foreach (dw, dm->workers) sum += dw->aggregate_rx_packets;
558 void dpdk_rx_trace (dpdk_main_t * dm,
559 vlib_node_runtime_t * node,
561 u16 queue_id, u32 * buffers, uword n_buffers);
563 #define EFD_OPERATION_LESS_THAN 0
564 #define EFD_OPERATION_GREATER_OR_EQUAL 1
566 void efd_config (u32 enabled,
567 u32 ip_prec, u32 ip_op,
568 u32 mpls_exp, u32 mpls_op, u32 vlan_cos, u32 vlan_op);
570 void post_sw_interface_set_flags (vlib_main_t * vm, u32 sw_if_index,
574 typedef struct vhost_user_memory vhost_user_memory_t;
576 void dpdk_vhost_user_process_init (void **ctx);
577 void dpdk_vhost_user_process_cleanup (void *ctx);
578 uword dpdk_vhost_user_process_if (vlib_main_t * vm, dpdk_device_t * xd,
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);
601 u32 dpdk_get_admin_up_down_in_progress (void);
603 u32 dpdk_num_mbufs (void);
605 dpdk_pmd_t dpdk_get_pmd_type (vnet_hw_interface_t * hi);
607 i8 dpdk_get_cpu_socket (vnet_hw_interface_t * hi);
609 void *dpdk_input_multiarch_select ();
610 void *dpdk_input_rss_multiarch_select ();
611 void *dpdk_input_efd_multiarch_select ();
613 clib_error_t *dpdk_get_hw_interface_stats (u32 hw_if_index,
614 struct rte_eth_stats *dest);
616 format_function_t format_dpdk_device_name;
617 format_function_t format_dpdk_device;
618 format_function_t format_dpdk_tx_dma_trace;
619 format_function_t format_dpdk_rx_dma_trace;
620 format_function_t format_dpdk_rte_mbuf;
621 format_function_t format_dpdk_rx_rte_mbuf;
622 unformat_function_t unformat_socket_mem;
623 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
627 dpdk_pmd_constructor_init ()
629 /* Add references to DPDK Driver Constructor functions to get the dynamic
630 * loader to pull in the driver library & run the constructors.
634 void devinitfn_ ##d(void); \
635 __attribute__((unused)) void (* volatile pf)(void); \
636 pf = devinitfn_ ##d; \
639 #ifdef RTE_LIBRTE_EM_PMD
642 #ifdef RTE_LIBRTE_IGB_PMD
645 #ifdef RTE_LIBRTE_IXGBE_PMD
648 #ifdef RTE_LIBRTE_I40E_PMD
649 _(rte_i40e_driver) _(rte_i40evf_driver)
651 #ifdef RTE_LIBRTE_FM10K_PMD
654 #ifdef RTE_LIBRTE_VIRTIO_PMD
657 #ifdef RTE_LIBRTE_VMXNET3_PMD
658 _(rte_vmxnet3_driver)
660 #ifdef RTE_LIBRTE_VICE_PMD
663 #ifdef RTE_LIBRTE_ENIC_PMD
666 #ifdef RTE_LIBRTE_PMD_AF_PACKET
669 #ifdef RTE_LIBRTE_CXGBE_PMD
672 #ifdef RTE_LIBRTE_PMD_BOND
675 #ifdef RTE_LIBRTE_DPAA2_PMD
680 * At the moment, the ThunderX NIC driver doesn't have
681 * an entry point named "devinitfn_rte_xxx_driver"
686 __attribute__((unused)) void (* volatile pf)(void); \
689 #ifdef RTE_LIBRTE_THUNDERVNIC_PMD
690 _(rte_nicvf_pmd_init)
696 admin_up_down_process (vlib_main_t * vm,
697 vlib_node_runtime_t * rt, vlib_frame_t * f);
699 #endif /* __included_dpdk_h__ */
702 * fd.io coding-style-patch-verification: ON
705 * eval: (c-set-style "gnu")