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>
47 #include <rte_virtio_net.h>
48 #include <rte_version.h>
49 #include <rte_eth_bond.h>
50 #include <rte_sched.h>
52 #include <vnet/unix/pcap.h>
53 #include <vnet/devices/virtio/vhost-user.h>
56 #define always_inline static inline
58 #define always_inline static inline __attribute__ ((__always_inline__))
61 #if RTE_VERSION < RTE_VERSION_NUM(16, 7, 0, 0)
62 #define DPDK_VHOST_USER 1
64 #define DPDK_VHOST_USER 0
67 #include <vlib/pci/pci.h>
69 #define NB_MBUF (16<<10)
71 extern vnet_device_class_t dpdk_device_class;
72 extern vlib_node_registration_t dpdk_input_node;
73 extern vlib_node_registration_t handoff_dispatch_node;
75 #define foreach_dpdk_pmd \
76 _ ("rte_nicvf_pmd", THUNDERX) \
77 _ ("rte_em_pmd", E1000EM) \
78 _ ("rte_igb_pmd", IGB) \
79 _ ("rte_igbvf_pmd", IGBVF) \
80 _ ("rte_ixgbe_pmd", IXGBE) \
81 _ ("rte_ixgbevf_pmd", IXGBEVF) \
82 _ ("rte_i40e_pmd", I40E) \
83 _ ("rte_i40evf_pmd", I40EVF) \
84 _ ("rte_virtio_pmd", VIRTIO) \
85 _ ("rte_enic_pmd", ENIC) \
86 _ ("rte_vmxnet3_pmd", VMXNET3) \
87 _ ("AF_PACKET PMD", AF_PACKET) \
88 _ ("rte_bond_pmd", BOND) \
89 _ ("rte_pmd_fm10k", FM10K) \
90 _ ("rte_cxgbe_pmd", CXGBE) \
91 _ ("rte_dpaa2_dpni", DPAA2)
96 #define _(s,f) VNET_DPDK_PMD_##f,
99 VNET_DPDK_PMD_UNKNOWN, /* must be last */
104 VNET_DPDK_PORT_TYPE_ETH_1G,
105 VNET_DPDK_PORT_TYPE_ETH_10G,
106 VNET_DPDK_PORT_TYPE_ETH_40G,
107 VNET_DPDK_PORT_TYPE_ETH_BOND,
108 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
109 VNET_DPDK_PORT_TYPE_AF_PACKET,
110 VNET_DPDK_PORT_TYPE_UNKNOWN,
119 #define DPDK_EFD_MAX_DISCARD_RATE 10
126 u32 consec_full_frames_cnt;
131 u32 total_packet_cnt;
142 u32 n_since_last_int;
154 char sock_filename[256];
161 dpdk_vu_vring vrings[VHOST_MAX_QUEUE_PAIRS * 2];
162 u64 region_addr[VHOST_MEMORY_MAX_NREGIONS];
163 u32 region_fd[VHOST_MEMORY_MAX_NREGIONS];
164 u64 region_offset[VHOST_MEMORY_MAX_NREGIONS];
168 typedef void (*dpdk_flowcontrol_callback_t) (vlib_main_t * vm,
169 u32 hw_if_index, u32 n_packets);
172 * The header for the tx_vector in dpdk_device_t.
173 * Head and tail are indexes into the tx_vector and are of type
174 * u64 so they never overflow.
184 struct rte_ring *swq;
186 u64 hqos_field0_slabmask;
187 u32 hqos_field0_slabpos;
188 u32 hqos_field0_slabshr;
189 u64 hqos_field1_slabmask;
190 u32 hqos_field1_slabpos;
191 u32 hqos_field1_slabshr;
192 u64 hqos_field2_slabmask;
193 u32 hqos_field2_slabpos;
194 u32 hqos_field2_slabshr;
195 u32 hqos_tc_table[64];
196 } dpdk_device_hqos_per_worker_thread_t;
200 struct rte_ring **swq;
201 struct rte_mbuf **pkts_enq;
202 struct rte_mbuf **pkts_deq;
203 struct rte_sched_port *hqos;
208 } dpdk_device_hqos_per_hqos_thread_t;
212 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
213 volatile u32 **lockp;
218 u32 vlib_hw_if_index;
219 u32 vlib_sw_if_index;
221 /* next node index if we decide to steal the rx graph arc */
222 u32 per_interface_next_index;
224 /* dpdk rte_mbuf rx and tx vectors, VLIB_FRAME_SIZE */
225 struct rte_mbuf ***tx_vectors; /* one per worker thread */
226 struct rte_mbuf ***rx_vectors;
228 /* vector of traced contexts, per device */
229 u32 *d_trace_buffers;
235 #define DPDK_DEVICE_FLAG_ADMIN_UP (1 << 0)
236 #define DPDK_DEVICE_FLAG_PROMISC (1 << 1)
237 #define DPDK_DEVICE_FLAG_PMD (1 << 2)
239 #define DPDK_DEVICE_FLAG_VHOST_USER (1 << 4)
240 #define DPDK_DEVICE_FLAG_HAVE_SUBIF (1 << 5)
241 #define DPDK_DEVICE_FLAG_HQOS (1 << 6)
244 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
246 u8 *interface_name_suffix;
248 /* number of sub-interfaces */
255 u16 *cpu_socket_id_by_queue;
256 struct rte_eth_conf port_conf;
257 struct rte_eth_txconf tx_conf;
260 dpdk_device_hqos_per_worker_thread_t *hqos_wt;
261 dpdk_device_hqos_per_hqos_thread_t *hqos_ht;
264 /* vhost-user related */
266 struct virtio_net vu_vhost_dev;
268 dpdk_vu_intf_t *vu_intf;
272 u8 af_packet_port_id;
274 struct rte_eth_link link;
275 f64 time_last_link_update;
277 struct rte_eth_stats stats;
278 struct rte_eth_stats last_stats;
279 struct rte_eth_stats last_cleared_stats;
280 #if RTE_VERSION >= RTE_VERSION_NUM(16, 7, 0, 0)
281 struct rte_eth_xstat *xstats;
282 struct rte_eth_xstat *last_cleared_xstats;
284 struct rte_eth_xstats *xstats;
285 struct rte_eth_xstats *last_cleared_xstats;
287 f64 time_last_stats_update;
288 dpdk_port_type_t port_type;
290 dpdk_efd_agent_t efd_agent;
291 u8 need_txlock; /* Used by VNET_DPDK_DEV_VHOST_USER */
294 #define DPDK_STATS_POLL_INTERVAL (10.0)
295 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
297 #define DPDK_LINK_POLL_INTERVAL (3.0)
298 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
302 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
304 /* total input packet counter */
305 u64 aggregate_rx_packets;
310 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
312 /* total input packet counter */
313 u64 aggregate_rx_packets;
314 } dpdk_hqos_thread_t;
320 } dpdk_device_and_queue_t;
322 /* Early-Fast-Discard (EFD) */
323 #define DPDK_EFD_DISABLED 0
324 #define DPDK_EFD_DISCARD_ENABLED (1 << 0)
325 #define DPDK_EFD_MONITOR_ENABLED (1 << 1)
326 #define DPDK_EFD_DROPALL_ENABLED (1 << 2)
328 #define DPDK_EFD_DEFAULT_DEVICE_QUEUE_HI_THRESH_PCT 90
329 #define DPDK_EFD_DEFAULT_CONSEC_FULL_FRAMES_HI_THRESH 6
331 typedef struct dpdk_efd_t
335 u16 consec_full_frames_hi_thresh;
339 #ifndef DPDK_HQOS_DBG_BYPASS
340 #define DPDK_HQOS_DBG_BYPASS 0
343 typedef struct dpdk_device_config_hqos_t
346 u32 hqos_thread_valid;
352 u32 pktfield0_slabpos;
353 u32 pktfield1_slabpos;
354 u32 pktfield2_slabpos;
355 u64 pktfield0_slabmask;
356 u64 pktfield1_slabmask;
357 u64 pktfield2_slabmask;
360 struct rte_sched_port_params port;
361 struct rte_sched_subport_params *subport;
362 struct rte_sched_pipe_params *pipe;
364 } dpdk_device_config_hqos_t;
366 int dpdk_hqos_validate_mask (u64 mask, u32 n);
367 void dpdk_device_config_hqos_pipe_profile_default (dpdk_device_config_hqos_t *
368 hqos, u32 pipe_profile_id);
369 void dpdk_device_config_hqos_default (dpdk_device_config_hqos_t * hqos);
370 clib_error_t *dpdk_port_setup_hqos (dpdk_device_t * xd,
371 dpdk_device_config_hqos_t * hqos);
372 void dpdk_hqos_metadata_set (dpdk_device_hqos_per_worker_thread_t * hqos,
373 struct rte_mbuf **pkts, u32 n_pkts);
375 #define foreach_dpdk_device_config_item \
384 vlib_pci_addr_t pci_addr;
386 u8 vlan_strip_offload;
387 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
388 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
389 #define DPDK_DEVICE_VLAN_STRIP_ON 2
391 #define _(x) uword x;
392 foreach_dpdk_device_config_item
394 clib_bitmap_t * workers;
396 dpdk_device_config_hqos_t hqos;
397 } dpdk_device_config_t;
404 u8 *eal_init_args_str;
407 u8 enable_tcp_udp_checksum;
409 /* Required config parameters */
410 u8 coremask_set_manually;
411 u8 nchannels_set_manually;
415 u8 num_kni; /* while kni_init allows u32, port_id in callback fn is only u8 */
418 * format interface names ala xxxEthernet%d/%d/%d instead of
419 * xxxEthernet%x/%x/%x.
421 u8 interface_name_format_decimal;
423 /* virtio vhost-user switch */
426 /* vhost-user coalescence frames config */
427 u32 vhost_coalesce_frames;
428 f64 vhost_coalesce_time;
430 /* per-device config */
431 dpdk_device_config_t default_devconf;
432 dpdk_device_config_t *dev_confs;
433 uword *device_config_index_by_pci_addr;
435 } dpdk_config_main_t;
437 dpdk_config_main_t dpdk_config_main;
443 dpdk_device_t *devices;
444 dpdk_device_and_queue_t **devices_by_cpu;
445 dpdk_device_and_queue_t **devices_by_hqos_cpu;
447 /* per-thread recycle lists */
450 /* buffer flags template, configurable to enable/disable tcp / udp cksum */
451 u32 buffer_flags_template;
453 /* flow control callback. If 0 then flow control is disabled */
454 dpdk_flowcontrol_callback_t flowcontrol_callback;
456 /* vlib buffer free list, must be same size as an rte_mbuf */
457 u32 vlib_buffer_free_list_index;
459 /* dpdk worker "threads" */
460 dpdk_worker_t *workers;
462 /* dpdk HQoS "threads" */
463 dpdk_hqos_thread_t *hqos_threads;
465 /* Ethernet input node index */
466 u32 ethernet_input_node_index;
468 /* pcap tracing [only works if (CLIB_DEBUG > 0)] */
470 pcap_main_t pcap_main;
472 u32 pcap_sw_if_index;
473 u32 pcap_pkts_to_capture;
476 uword *dpdk_device_by_kni_port_id;
477 uword *vu_sw_if_index_by_listener_fd;
478 uword *vu_sw_if_index_by_sock_fd;
479 u32 *vu_inactive_interfaces_device_index;
483 /* efd (early-fast-discard) settings */
487 * flag indicating that a posted admin up/down
488 * (via post_sw_interface_set_flags) is in progress
490 u8 admin_up_down_in_progress;
494 /* which cpus are running dpdk-input */
495 int input_cpu_first_index;
498 /* which cpus are running I/O TX */
499 int hqos_cpu_first_index;
502 /* control interval of dpdk link state and stat polling */
503 f64 link_state_poll_interval;
504 f64 stat_poll_interval;
506 /* Sleep for this many MS after each device poll */
510 vlib_main_t *vlib_main;
511 vnet_main_t *vnet_main;
512 dpdk_config_main_t *conf;
515 dpdk_main_t dpdk_main;
519 DPDK_RX_NEXT_IP4_INPUT,
520 DPDK_RX_NEXT_IP6_INPUT,
521 DPDK_RX_NEXT_MPLS_INPUT,
522 DPDK_RX_NEXT_ETHERNET_INPUT,
533 /* Copy of VLIB buffer; packet data stored in pre_data. */
534 vlib_buffer_t buffer;
535 } dpdk_tx_dma_trace_t;
543 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
544 u8 data[256]; /* First 256 data bytes, used for hexdump */
545 } dpdk_rx_dma_trace_t;
547 void vnet_buffer_needs_dpdk_mb (vlib_buffer_t * b);
549 void dpdk_set_next_node (dpdk_rx_next_t, char *);
551 clib_error_t *dpdk_set_mac_address (vnet_hw_interface_t * hi, char *address);
553 clib_error_t *dpdk_set_mc_filter (vnet_hw_interface_t * hi,
554 struct ether_addr mc_addr_vec[], int naddr);
556 void dpdk_thread_input (dpdk_main_t * dm, dpdk_device_t * xd);
558 clib_error_t *dpdk_port_setup (dpdk_main_t * dm, dpdk_device_t * xd);
560 void dpdk_set_flowcontrol_callback (vlib_main_t * vm,
561 dpdk_flowcontrol_callback_t callback);
563 u32 dpdk_interface_tx_vector (vlib_main_t * vm, u32 dev_instance);
565 void set_efd_bitmap (u8 * bitmap, u32 value, u32 op);
567 struct rte_mbuf *dpdk_replicate_packet_mb (vlib_buffer_t * b);
568 struct rte_mbuf *dpdk_zerocopy_replicate_packet_mb (vlib_buffer_t * b);
570 #define foreach_dpdk_error \
571 _(NONE, "no error") \
572 _(RX_PACKET_ERROR, "Rx packet errors") \
573 _(RX_BAD_FCS, "Rx bad fcs") \
574 _(L4_CHECKSUM_ERROR, "Rx L4 checksum errors") \
575 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
576 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
577 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
578 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error") \
579 _(IPV4_EFD_DROP_PKTS, "IPV4 Early Fast Discard rx drops") \
580 _(IPV6_EFD_DROP_PKTS, "IPV6 Early Fast Discard rx drops") \
581 _(MPLS_EFD_DROP_PKTS, "MPLS Early Fast Discard rx drops") \
582 _(VLAN_EFD_DROP_PKTS, "VLAN Early Fast Discard rx drops")
586 #define _(f,s) DPDK_ERROR_##f,
593 * Increment EFD drop counter
595 static_always_inline void
596 increment_efd_drop_counter (vlib_main_t * vm, u32 counter_index, u32 count)
600 my_n = vlib_get_node (vm, dpdk_input_node.index);
601 vm->error_main.counters[my_n->error_heap_index + counter_index] += count;
604 int dpdk_set_stat_poll_interval (f64 interval);
605 int dpdk_set_link_state_poll_interval (f64 interval);
606 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
607 void dpdk_device_lock_init (dpdk_device_t * xd);
608 void dpdk_device_lock_free (dpdk_device_t * xd);
609 void dpdk_efd_update_counters (dpdk_device_t * xd, u32 n_buffers,
611 u32 is_efd_discardable (vlib_thread_main_t * tm, vlib_buffer_t * b0,
612 struct rte_mbuf *mb);
615 /* dpdk vhost-user interrupt management */
616 u8 dpdk_vhost_user_want_interrupt (dpdk_device_t * xd, int idx);
617 void dpdk_vhost_user_send_interrupt (vlib_main_t * vm, dpdk_device_t * xd,
623 vnet_get_aggregate_rx_packets (void)
625 dpdk_main_t *dm = &dpdk_main;
629 vec_foreach (dw, dm->workers) sum += dw->aggregate_rx_packets;
634 void dpdk_rx_trace (dpdk_main_t * dm,
635 vlib_node_runtime_t * node,
637 u16 queue_id, u32 * buffers, uword n_buffers);
639 #define EFD_OPERATION_LESS_THAN 0
640 #define EFD_OPERATION_GREATER_OR_EQUAL 1
642 void efd_config (u32 enabled,
643 u32 ip_prec, u32 ip_op,
644 u32 mpls_exp, u32 mpls_op, u32 vlan_cos, u32 vlan_op);
646 void post_sw_interface_set_flags (vlib_main_t * vm, u32 sw_if_index,
650 typedef struct vhost_user_memory vhost_user_memory_t;
652 void dpdk_vhost_user_process_init (void **ctx);
653 void dpdk_vhost_user_process_cleanup (void *ctx);
654 uword dpdk_vhost_user_process_if (vlib_main_t * vm, dpdk_device_t * xd,
658 int dpdk_vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
659 const char *sock_filename,
663 u8 renumber, u32 custom_dev_instance,
665 int dpdk_vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
666 const char *sock_filename,
670 u8 renumber, u32 custom_dev_instance);
671 int dpdk_vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm,
673 int dpdk_vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
674 vhost_user_intf_details_t ** out_vuids);
677 u32 dpdk_get_admin_up_down_in_progress (void);
679 u32 dpdk_num_mbufs (void);
681 dpdk_pmd_t dpdk_get_pmd_type (vnet_hw_interface_t * hi);
683 i8 dpdk_get_cpu_socket (vnet_hw_interface_t * hi);
685 void *dpdk_input_multiarch_select ();
686 void *dpdk_input_rss_multiarch_select ();
687 void *dpdk_input_efd_multiarch_select ();
689 clib_error_t *dpdk_get_hw_interface_stats (u32 hw_if_index,
690 struct rte_eth_stats *dest);
692 format_function_t format_dpdk_device_name;
693 format_function_t format_dpdk_device;
694 format_function_t format_dpdk_tx_dma_trace;
695 format_function_t format_dpdk_rx_dma_trace;
696 format_function_t format_dpdk_rte_mbuf;
697 format_function_t format_dpdk_rx_rte_mbuf;
698 unformat_function_t unformat_socket_mem;
699 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
700 clib_error_t *unformat_hqos (unformat_input_t * input,
701 dpdk_device_config_hqos_t * hqos);
704 admin_up_down_process (vlib_main_t * vm,
705 vlib_node_runtime_t * rt, vlib_frame_t * f);
707 #endif /* __included_dpdk_h__ */
710 * fd.io coding-style-patch-verification: ON
713 * eval: (c-set-style "gnu")