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>
25 #include <rte_memory.h>
27 #include <rte_per_lcore.h>
28 #include <rte_cycles.h>
29 #include <rte_lcore.h>
30 #include <rte_per_lcore.h>
31 #include <rte_interrupts.h>
33 #include <rte_ether.h>
34 #include <rte_ethdev.h>
36 #include <rte_mempool.h>
38 #include <rte_version.h>
39 #include <rte_eth_bond.h>
40 #include <rte_sched.h>
42 #include <rte_bus_pci.h>
45 #include <vnet/unix/pcap.h>
46 #include <vnet/devices/devices.h>
49 #define always_inline static inline
51 #define always_inline static inline __attribute__ ((__always_inline__))
54 #include <vlib/pci/pci.h>
55 #include <vnet/flow/flow.h>
57 #define NB_MBUF (16<<10)
59 extern vnet_device_class_t dpdk_device_class;
60 extern vlib_node_registration_t dpdk_input_node;
62 #define foreach_dpdk_pmd \
63 _ ("net_thunderx", THUNDERX) \
64 _ ("net_e1000_em", E1000EM) \
65 _ ("net_e1000_igb", IGB) \
66 _ ("net_e1000_igb_vf", IGBVF) \
67 _ ("net_ixgbe", IXGBE) \
68 _ ("net_ixgbe_vf", IXGBEVF) \
69 _ ("net_i40e", I40E) \
70 _ ("net_i40e_vf", I40EVF) \
71 _ ("net_virtio", VIRTIO) \
72 _ ("net_enic", ENIC) \
73 _ ("net_vmxnet3", VMXNET3) \
74 _ ("AF_PACKET PMD", AF_PACKET) \
75 _ ("net_bonding", BOND) \
76 _ ("net_fm10k", FM10K) \
77 _ ("net_cxgbe", CXGBE) \
78 _ ("net_mlx4", MLX4) \
79 _ ("net_mlx5", MLX5) \
80 _ ("net_dpaa2", DPAA2) \
81 _ ("net_virtio_user", VIRTIO_USER) \
82 _ ("net_vhost", VHOST_ETHER) \
88 #define _(s,f) VNET_DPDK_PMD_##f,
91 VNET_DPDK_PMD_UNKNOWN, /* must be last */
96 VNET_DPDK_PORT_TYPE_ETH_1G,
97 VNET_DPDK_PORT_TYPE_ETH_2_5G,
98 VNET_DPDK_PORT_TYPE_ETH_5G,
99 VNET_DPDK_PORT_TYPE_ETH_10G,
100 VNET_DPDK_PORT_TYPE_ETH_20G,
101 VNET_DPDK_PORT_TYPE_ETH_25G,
102 VNET_DPDK_PORT_TYPE_ETH_40G,
103 VNET_DPDK_PORT_TYPE_ETH_50G,
104 VNET_DPDK_PORT_TYPE_ETH_56G,
105 VNET_DPDK_PORT_TYPE_ETH_100G,
106 VNET_DPDK_PORT_TYPE_ETH_BOND,
107 VNET_DPDK_PORT_TYPE_ETH_SWITCH,
108 VNET_DPDK_PORT_TYPE_AF_PACKET,
109 VNET_DPDK_PORT_TYPE_ETH_VF,
110 VNET_DPDK_PORT_TYPE_VIRTIO_USER,
111 VNET_DPDK_PORT_TYPE_VHOST_ETHER,
112 VNET_DPDK_PORT_TYPE_UNKNOWN,
115 typedef uint16_t dpdk_portid_t;
119 /* Required for vec_validate_aligned */
120 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
122 struct rte_ring *swq;
124 u64 hqos_field0_slabmask;
125 u32 hqos_field0_slabpos;
126 u32 hqos_field0_slabshr;
127 u64 hqos_field1_slabmask;
128 u32 hqos_field1_slabpos;
129 u32 hqos_field1_slabshr;
130 u64 hqos_field2_slabmask;
131 u32 hqos_field2_slabpos;
132 u32 hqos_field2_slabshr;
133 u32 hqos_tc_table[64];
134 } dpdk_device_hqos_per_worker_thread_t;
138 /* Required for vec_validate_aligned */
139 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
140 struct rte_ring **swq;
141 struct rte_mbuf **pkts_enq;
142 struct rte_mbuf **pkts_deq;
143 struct rte_sched_port *hqos;
149 } dpdk_device_hqos_per_hqos_thread_t;
151 #define foreach_dpdk_device_flags \
152 _( 0, ADMIN_UP, "admin-up") \
153 _( 1, PROMISC, "promisc") \
155 _( 3, PMD_INIT_FAIL, "pmd-init-fail") \
156 _( 4, MAYBE_MULTISEG, "maybe-multiseg") \
157 _( 5, HAVE_SUBIF, "subif") \
158 _( 6, HQOS, "hqos") \
159 _( 7, BOND_SLAVE, "bond-slave") \
160 _( 8, BOND_SLAVE_UP, "bond-slave-up") \
161 _( 9, TX_OFFLOAD, "tx-offload") \
162 _(10, INTEL_PHDR_CKSUM, "intel-phdr-cksum") \
163 _(11, RX_FLOW_OFFLOAD, "rx-flow-offload")
167 #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a),
168 foreach_dpdk_device_flags
176 struct rte_flow *handle;
184 } dpdk_flow_lookup_entry_t;
188 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
189 volatile u32 **lockp;
192 dpdk_portid_t device_index;
197 /* next node index if we decide to steal the rx graph arc */
198 u32 per_interface_next_index;
206 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
208 u8 *interface_name_suffix;
210 /* number of sub-interfaces */
217 u16 *cpu_socket_id_by_queue;
218 u8 *buffer_pool_for_queue;
219 struct rte_eth_conf port_conf;
220 struct rte_eth_txconf tx_conf;
223 u32 supported_flow_actions;
224 dpdk_flow_entry_t *flow_entries; /* pool */
225 dpdk_flow_lookup_entry_t *flow_lookup_entries; /* vector */
226 struct rte_flow_error last_flow_error;
229 dpdk_device_hqos_per_worker_thread_t *hqos_wt;
230 dpdk_device_hqos_per_hqos_thread_t *hqos_ht;
232 /* af_packet or BondEthernet instance number */
233 dpdk_portid_t port_id;
235 /* Bonded interface port# of a slave -
236 only valid if DPDK_DEVICE_FLAG_BOND_SLAVE bit is set */
237 dpdk_portid_t bond_port;
239 struct rte_eth_link link;
240 f64 time_last_link_update;
242 struct rte_eth_stats stats;
243 struct rte_eth_stats last_stats;
244 struct rte_eth_stats last_cleared_stats;
245 struct rte_eth_xstat *xstats;
246 struct rte_eth_xstat *last_cleared_xstats;
247 f64 time_last_stats_update;
248 dpdk_port_type_t port_type;
251 u8 *default_mac_address;
254 clib_error_t *errors;
257 #define DPDK_STATS_POLL_INTERVAL (10.0)
258 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
260 #define DPDK_LINK_POLL_INTERVAL (3.0)
261 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
267 } dpdk_device_and_queue_t;
269 #ifndef DPDK_HQOS_DBG_BYPASS
270 #define DPDK_HQOS_DBG_BYPASS 0
273 #ifndef HQOS_FLUSH_COUNT_THRESHOLD
274 #define HQOS_FLUSH_COUNT_THRESHOLD 100000
277 typedef struct dpdk_device_config_hqos_t
280 u32 hqos_thread_valid;
286 u32 pktfield0_slabpos;
287 u32 pktfield1_slabpos;
288 u32 pktfield2_slabpos;
289 u64 pktfield0_slabmask;
290 u64 pktfield1_slabmask;
291 u64 pktfield2_slabmask;
294 struct rte_sched_port_params port;
295 struct rte_sched_subport_params *subport;
296 struct rte_sched_pipe_params *pipe;
298 } dpdk_device_config_hqos_t;
300 int dpdk_hqos_validate_mask (u64 mask, u32 n);
301 void dpdk_device_config_hqos_pipe_profile_default (dpdk_device_config_hqos_t *
302 hqos, u32 pipe_profile_id);
303 void dpdk_device_config_hqos_default (dpdk_device_config_hqos_t * hqos);
304 clib_error_t *dpdk_port_setup_hqos (dpdk_device_t * xd,
305 dpdk_device_config_hqos_t * hqos);
306 void dpdk_hqos_metadata_set (dpdk_device_hqos_per_worker_thread_t * hqos,
307 struct rte_mbuf **pkts, u32 n_pkts);
309 #define foreach_dpdk_device_config_item \
318 vlib_pci_addr_t pci_addr;
320 u8 vlan_strip_offload;
321 #define DPDK_DEVICE_VLAN_STRIP_DEFAULT 0
322 #define DPDK_DEVICE_VLAN_STRIP_OFF 1
323 #define DPDK_DEVICE_VLAN_STRIP_ON 2
325 #define _(x) uword x;
326 foreach_dpdk_device_config_item
328 clib_bitmap_t * workers;
330 dpdk_device_config_hqos_t hqos;
331 } dpdk_device_config_t;
338 u8 *eal_init_args_str;
341 u8 enable_tcp_udp_checksum;
342 u8 no_tx_checksum_offload;
344 /* Required config parameters */
345 u8 coremask_set_manually;
346 u8 nchannels_set_manually;
352 * format interface names ala xxxEthernet%d/%d/%d instead of
353 * xxxEthernet%x/%x/%x.
355 u8 interface_name_format_decimal;
357 /* per-device config */
358 dpdk_device_config_t default_devconf;
359 dpdk_device_config_t *dev_confs;
360 uword *device_config_index_by_pci_addr;
362 } dpdk_config_main_t;
364 extern dpdk_config_main_t dpdk_config_main;
366 #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE
370 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
371 struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ];
372 u32 buffers[DPDK_RX_BURST_SZ];
373 u16 next[DPDK_RX_BURST_SZ];
374 u16 etype[DPDK_RX_BURST_SZ];
375 u8 flags[DPDK_RX_BURST_SZ];
376 vlib_buffer_t buffer_template;
377 } dpdk_per_thread_data_t;
383 dpdk_device_t *devices;
384 dpdk_device_and_queue_t **devices_by_hqos_cpu;
385 dpdk_per_thread_data_t *per_thread_data;
387 /* per-thread recycle lists */
390 /* buffer flags template, configurable to enable/disable tcp / udp cksum */
391 u32 buffer_flags_template;
393 /* pcap tracing [only works if (CLIB_DEBUG > 0)] */
395 pcap_main_t pcap_main;
397 u32 pcap_sw_if_index;
398 u32 pcap_pkts_to_capture;
401 * flag indicating that a posted admin up/down
402 * (via post_sw_interface_set_flags) is in progress
404 u8 admin_up_down_in_progress;
406 /* which cpus are running I/O TX */
407 int hqos_cpu_first_index;
410 /* control interval of dpdk link state and stat polling */
411 f64 link_state_poll_interval;
412 f64 stat_poll_interval;
414 /* Sleep for this many usec after each device poll */
418 vlib_main_t *vlib_main;
419 vnet_main_t *vnet_main;
420 dpdk_config_main_t *conf;
423 struct rte_mempool **pktmbuf_pools;
425 /* API message ID base */
429 vlib_log_class_t log_default;
432 extern dpdk_main_t dpdk_main;
440 /* Copy of VLIB buffer; packet data stored in pre_data. */
441 vlib_buffer_t buffer;
442 u8 data[256]; /* First 256 data bytes, used for hexdump */
451 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
452 u8 data[256]; /* First 256 data bytes, used for hexdump */
455 void dpdk_device_setup (dpdk_device_t * xd);
456 void dpdk_device_start (dpdk_device_t * xd);
457 void dpdk_device_stop (dpdk_device_t * xd);
459 int dpdk_port_state_callback (dpdk_portid_t port_id,
460 enum rte_eth_event_type type,
461 void *param, void *ret_param);
463 #define foreach_dpdk_error \
464 _(NONE, "no error") \
465 _(RX_PACKET_ERROR, "Rx packet errors") \
466 _(RX_BAD_FCS, "Rx bad fcs") \
467 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
468 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
469 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
470 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
474 #define _(f,s) DPDK_ERROR_##f,
480 #define dpdk_log_err(...) \
481 vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
482 #define dpdk_log_warn(...) \
483 vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
484 #define dpdk_log_notice(...) \
485 vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
486 #define dpdk_log_info(...) \
487 vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
489 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
491 format_function_t format_dpdk_device_name;
492 format_function_t format_dpdk_device;
493 format_function_t format_dpdk_device_errors;
494 format_function_t format_dpdk_tx_trace;
495 format_function_t format_dpdk_rx_trace;
496 format_function_t format_dpdk_rte_mbuf;
497 format_function_t format_dpdk_rx_rte_mbuf;
498 format_function_t format_dpdk_flow;
499 unformat_function_t unformat_dpdk_log_level;
500 vnet_flow_dev_ops_function_t dpdk_flow_ops_fn;
502 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
503 clib_error_t *unformat_hqos (unformat_input_t * input,
504 dpdk_device_config_hqos_t * hqos);
507 admin_up_down_process (vlib_main_t * vm,
508 vlib_node_runtime_t * rt, vlib_frame_t * f);
510 clib_error_t *dpdk_pool_create (vlib_main_t * vm, u8 * pool_name,
511 u32 elt_size, u32 num_elts,
512 u32 pool_priv_size, u16 cache_size, u8 numa,
513 struct rte_mempool **_mp,
514 vlib_physmem_region_index_t * pri);
516 clib_error_t *dpdk_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
520 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
521 void dpdk_buffer_poison_trajectory_all (void);
524 #endif /* __included_dpdk_h__ */
527 * fd.io coding-style-patch-verification: ON
530 * eval: (c-set-style "gnu")