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 #define ALLOW_EXPERIMENTAL_API
23 #include <rte_config.h>
26 #include <rte_bus_pci.h>
27 #include <rte_bus_vmbus.h>
28 #include <rte_ethdev.h>
29 #include <rte_version.h>
31 #if RTE_VERSION >= RTE_VERSION_NUM(22, 11, 0, 0)
36 #include <bus_driver.h>
37 #include <bus_pci_driver.h>
38 #include <bus_vmbus_driver.h>
41 #include <vnet/devices/devices.h>
44 #define always_inline static inline
46 #define always_inline static inline __attribute__ ((__always_inline__))
49 #include <vlib/pci/pci.h>
50 #include <vlib/vmbus/vmbus.h>
51 #include <vnet/flow/flow.h>
53 extern vnet_device_class_t dpdk_device_class;
54 extern vlib_node_registration_t dpdk_input_node;
55 extern vlib_node_registration_t admin_up_down_process_node;
57 typedef uint16_t dpdk_portid_t;
59 #define foreach_dpdk_device_flags \
60 _ (0, ADMIN_UP, "admin-up") \
61 _ (1, PROMISC, "promisc") \
62 _ (3, PMD_INIT_FAIL, "pmd-init-fail") \
63 _ (4, MAYBE_MULTISEG, "maybe-multiseg") \
64 _ (5, HAVE_SUBIF, "subif") \
65 _ (9, TX_OFFLOAD, "tx-offload") \
66 _ (10, INTEL_PHDR_CKSUM, "intel-phdr-cksum") \
67 _ (11, RX_FLOW_OFFLOAD, "rx-flow-offload") \
68 _ (12, RX_IP4_CKSUM, "rx-ip4-cksum") \
69 _ (13, INT_SUPPORTED, "int-supported") \
70 _ (14, INT_UNMASKABLE, "int-unmaskable")
74 #define _(a, b, c) DPDK_DEVICE_FLAG_##b = (1 << a),
75 foreach_dpdk_device_flags
83 struct rte_flow *handle;
91 } dpdk_flow_lookup_entry_t;
95 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
99 uword clib_file_index;
104 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
105 clib_spinlock_t lock;
113 } dpdk_driver_name_t;
117 dpdk_driver_name_t *drivers;
118 const char *interface_name_prefix;
121 u32 supported_flow_actions;
122 u32 enable_lsc_int : 1;
123 u32 enable_rxq_int : 1;
124 u32 disable_rx_scatter : 1;
125 u32 program_vlans : 1;
126 u32 mq_mode_none : 1;
127 u32 interface_number_from_port_id : 1;
128 u32 use_intel_phdr_cksum : 1;
129 u32 int_unmaskable : 1;
132 dpdk_driver_t *dpdk_driver_find (const char *name, const char **desc);
138 u16 disable_multi_seg : 1;
141 u16 enable_tcp_udp_checksum : 1;
142 u16 enable_outer_checksum_offload : 1;
143 u16 enable_lsc_int : 1;
144 u16 enable_rxq_int : 1;
145 u16 disable_tx_checksum_offload : 1;
147 u16 disable_rx_scatter : 1;
152 u32 max_lro_pkt_size;
158 STATIC_ASSERT_SIZEOF (dpdk_port_conf_t, 24);
162 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
164 dpdk_rx_queue_t *rx_queues;
165 dpdk_tx_queue_t *tx_queues;
167 /* Instance ID to access internal device array. */
174 /* next node index if we decide to steal the rx graph arc */
175 u32 per_interface_next_index;
179 /* DPDK device port number */
180 dpdk_portid_t port_id;
183 CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
187 dpdk_driver_t *driver;
191 /* number of sub-interfaces */
195 u32 supported_flow_actions;
196 dpdk_flow_entry_t *flow_entries; /* pool */
197 dpdk_flow_lookup_entry_t *flow_lookup_entries; /* pool */
198 u32 *parked_lookup_indexes; /* vector */
199 u32 parked_loop_count;
200 struct rte_flow_error last_flow_error;
202 struct rte_eth_link link;
203 f64 time_last_link_update;
205 struct rte_eth_stats stats;
206 struct rte_eth_stats last_stats;
207 struct rte_eth_xstat *xstats;
208 f64 time_last_stats_update;
211 u8 *default_mac_address;
213 /* maximum supported max frame size */
214 u32 max_supported_frame_size;
216 /* due to lack of API to get ethernet max_frame_size we store information
217 * deducted from device info */
218 u8 driver_frame_overhead;
221 clib_error_t *errors;
222 dpdk_port_conf_t conf;
225 #define DPDK_STATS_POLL_INTERVAL (10.0)
226 #define DPDK_MIN_STATS_POLL_INTERVAL (0.001) /* 1msec */
228 #define DPDK_LINK_POLL_INTERVAL (3.0)
229 #define DPDK_MIN_LINK_POLL_INTERVAL (0.001) /* 1msec */
231 #define foreach_dpdk_device_config_item \
236 _ (max_lro_pkt_size) \
244 } dpdk_device_addr_type_t;
250 vlib_pci_addr_t pci_addr;
251 vlib_vmbus_addr_t vmbus_addr;
253 dpdk_device_addr_type_t dev_addr_type;
258 #define _(x) uword x;
259 foreach_dpdk_device_config_item
261 clib_bitmap_t * workers;
264 clib_bitmap_t *rss_queues;
266 #define DPDK_DEVICE_TSO_DEFAULT 0
267 #define DPDK_DEVICE_TSO_OFF 1
268 #define DPDK_DEVICE_TSO_ON 2
269 } dpdk_device_config_t;
276 u8 *eal_init_args_str;
280 u16 max_simd_bitwidth;
282 #define DPDK_MAX_SIMD_BITWIDTH_DEFAULT 0
283 #define DPDK_MAX_SIMD_BITWIDTH_256 256
284 #define DPDK_MAX_SIMD_BITWIDTH_512 512
287 * format interface names ala xxxEthernet%d/%d/%d instead of
288 * xxxEthernet%x/%x/%x.
290 u8 interface_name_format_decimal;
292 /* per-device config */
293 dpdk_device_config_t default_devconf;
294 dpdk_device_config_t *dev_confs;
295 uword *device_config_index_by_pci_addr;
296 mhash_t device_config_index_by_vmbus_addr;
298 /* devices blacklist by pci vendor_id, device_id */
299 u32 *blacklist_by_pci_vendor_and_device;
300 /* devices blacklist by VMBUS address */
301 vlib_vmbus_addr_t *blacklist_by_vmbus_addr;
303 } dpdk_config_main_t;
305 extern dpdk_config_main_t dpdk_config_main;
307 #define DPDK_RX_BURST_SZ VLIB_FRAME_SIZE
311 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
312 struct rte_mbuf *mbufs[DPDK_RX_BURST_SZ];
313 u32 buffers[DPDK_RX_BURST_SZ];
314 u16 next[DPDK_RX_BURST_SZ];
315 u16 etype[DPDK_RX_BURST_SZ];
316 u32 flags[DPDK_RX_BURST_SZ];
317 vlib_buffer_t buffer_template;
318 } dpdk_per_thread_data_t;
323 dpdk_device_t *devices;
324 dpdk_per_thread_data_t *per_thread_data;
327 * flag indicating that a posted admin up/down
328 * (via post_sw_interface_set_flags) is in progress
330 u8 admin_up_down_in_progress;
332 /* control interval of dpdk link state and stat polling */
333 f64 link_state_poll_interval;
334 f64 stat_poll_interval;
336 dpdk_config_main_t *conf;
337 dpdk_port_conf_t default_port_conf;
339 /* API message ID base */
343 vlib_log_class_t log_default;
344 vlib_log_class_t log_cryptodev;
347 extern dpdk_main_t dpdk_main;
355 u8 data[256]; /* First 256 data bytes, used for hexdump */
356 /* Copy of VLIB buffer; packet data stored in pre_data. */
357 vlib_buffer_t buffer;
366 u8 data[256]; /* First 256 data bytes, used for hexdump */
367 vlib_buffer_t buffer; /* Copy of VLIB buffer; pkt data stored in pre_data. */
370 void dpdk_device_setup (dpdk_device_t * xd);
371 void dpdk_device_start (dpdk_device_t * xd);
372 void dpdk_device_stop (dpdk_device_t * xd);
373 int dpdk_port_state_callback (dpdk_portid_t port_id,
374 enum rte_eth_event_type type,
375 void *param, void *ret_param);
377 #define foreach_dpdk_error \
378 _(NONE, "no error") \
379 _(RX_PACKET_ERROR, "Rx packet errors") \
380 _(RX_BAD_FCS, "Rx bad fcs") \
381 _(IP_CHECKSUM_ERROR, "Rx ip checksum errors") \
382 _(RX_ALLOC_FAIL, "rx buf alloc from free list failed") \
383 _(RX_ALLOC_NO_PHYSMEM, "rx buf alloc failed no physmem") \
384 _(RX_ALLOC_DROP_PKTS, "rx packets dropped due to alloc error")
388 #define _(f,s) DPDK_ERROR_##f,
394 #define dpdk_log_err(...) \
395 vlib_log(VLIB_LOG_LEVEL_ERR, dpdk_main.log_default, __VA_ARGS__)
396 #define dpdk_log_warn(...) \
397 vlib_log(VLIB_LOG_LEVEL_WARNING, dpdk_main.log_default, __VA_ARGS__)
398 #define dpdk_log_notice(...) \
399 vlib_log(VLIB_LOG_LEVEL_NOTICE, dpdk_main.log_default, __VA_ARGS__)
400 #define dpdk_log_info(...) \
401 vlib_log(VLIB_LOG_LEVEL_INFO, dpdk_main.log_default, __VA_ARGS__)
402 #define dpdk_log_debug(...) \
403 vlib_log (VLIB_LOG_LEVEL_DEBUG, dpdk_main.log_default, __VA_ARGS__)
405 void dpdk_update_link_state (dpdk_device_t * xd, f64 now);
407 #define foreach_dpdk_rss_hf \
408 _ (0, RTE_ETH_RSS_FRAG_IPV4, "ipv4-frag") \
409 _ (1, RTE_ETH_RSS_NONFRAG_IPV4_TCP, "ipv4-tcp") \
410 _ (2, RTE_ETH_RSS_NONFRAG_IPV4_UDP, "ipv4-udp") \
411 _ (3, RTE_ETH_RSS_NONFRAG_IPV4_SCTP, "ipv4-sctp") \
412 _ (4, RTE_ETH_RSS_NONFRAG_IPV4_OTHER, "ipv4-other") \
413 _ (5, RTE_ETH_RSS_IPV4, "ipv4") \
414 _ (6, RTE_ETH_RSS_IPV6_TCP_EX, "ipv6-tcp-ex") \
415 _ (7, RTE_ETH_RSS_IPV6_UDP_EX, "ipv6-udp-ex") \
416 _ (8, RTE_ETH_RSS_FRAG_IPV6, "ipv6-frag") \
417 _ (9, RTE_ETH_RSS_NONFRAG_IPV6_TCP, "ipv6-tcp") \
418 _ (10, RTE_ETH_RSS_NONFRAG_IPV6_UDP, "ipv6-udp") \
419 _ (11, RTE_ETH_RSS_NONFRAG_IPV6_SCTP, "ipv6-sctp") \
420 _ (12, RTE_ETH_RSS_NONFRAG_IPV6_OTHER, "ipv6-other") \
421 _ (13, RTE_ETH_RSS_IPV6_EX, "ipv6-ex") \
422 _ (14, RTE_ETH_RSS_IPV6, "ipv6") \
423 _ (15, RTE_ETH_RSS_L2_PAYLOAD, "l2-payload") \
424 _ (16, RTE_ETH_RSS_PORT, "port") \
425 _ (17, RTE_ETH_RSS_VXLAN, "vxlan") \
426 _ (18, RTE_ETH_RSS_GENEVE, "geneve") \
427 _ (19, RTE_ETH_RSS_NVGRE, "nvgre") \
428 _ (20, RTE_ETH_RSS_GTPU, "gtpu") \
429 _ (21, RTE_ETH_RSS_ESP, "esp") \
430 _ (22, RTE_ETH_RSS_L2TPV3, "l2tpv3") \
431 _ (60, RTE_ETH_RSS_L4_DST_ONLY, "l4-dst-only") \
432 _ (61, RTE_ETH_RSS_L4_SRC_ONLY, "l4-src-only") \
433 _ (62, RTE_ETH_RSS_L3_DST_ONLY, "l3-dst-only") \
434 _ (63, RTE_ETH_RSS_L3_SRC_ONLY, "l3-src-only")
436 format_function_t format_dpdk_device_name;
437 format_function_t format_dpdk_device;
438 format_function_t format_dpdk_device_errors;
439 format_function_t format_dpdk_tx_trace;
440 format_function_t format_dpdk_rx_trace;
441 format_function_t format_dpdk_rte_mbuf;
442 format_function_t format_dpdk_rx_rte_mbuf;
443 format_function_t format_dpdk_flow;
444 format_function_t format_dpdk_rss_hf_name;
445 format_function_t format_dpdk_rx_offload_caps;
446 format_function_t format_dpdk_tx_offload_caps;
447 format_function_t format_dpdk_burst_fn;
448 format_function_t format_dpdk_rte_device;
449 vnet_flow_dev_ops_function_t dpdk_flow_ops_fn;
451 clib_error_t *unformat_rss_fn (unformat_input_t * input, uword * rss_fn);
453 struct rte_pci_device *dpdk_get_pci_device (const struct rte_eth_dev_info
455 struct rte_vmbus_device *
456 dpdk_get_vmbus_device (const struct rte_eth_dev_info *info);
457 void dpdk_cli_reference (void);
460 int dpdk_buffer_validate_trajectory_all (u32 * uninitialized);
461 void dpdk_buffer_poison_trajectory_all (void);
464 #endif /* __included_dpdk_h__ */
467 * fd.io coding-style-patch-verification: ON
470 * eval: (c-set-style "gnu")