1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2019 Mellanox Technologies, Ltd
5 #ifndef RTE_PMD_MLX5_VDPA_H_
6 #define RTE_PMD_MLX5_VDPA_H_
8 #include <linux/virtio_net.h>
12 #pragma GCC diagnostic ignored "-Wpedantic"
15 #include <vdpa_driver.h>
16 #include <rte_vhost.h>
18 #pragma GCC diagnostic error "-Wpedantic"
20 #include <rte_spinlock.h>
21 #include <rte_interrupts.h>
23 #include <mlx5_glue.h>
24 #include <mlx5_devx_cmds.h>
25 #include <mlx5_common_devx.h>
29 #define MLX5_VDPA_INTR_RETRIES 256
30 #define MLX5_VDPA_INTR_RETRIES_USEC 1000
32 #ifndef VIRTIO_F_ORDER_PLATFORM
33 #define VIRTIO_F_ORDER_PLATFORM 36
36 #ifndef VIRTIO_F_RING_PACKED
37 #define VIRTIO_F_RING_PACKED 34
40 #define MLX5_VDPA_DEFAULT_TIMER_DELAY_US 0u
41 #define MLX5_VDPA_DEFAULT_TIMER_STEP_US 1u
50 struct mlx5_devx_cq cq_obj;
54 struct mlx5_vdpa_event_qp {
55 struct mlx5_vdpa_cq cq;
56 struct mlx5_devx_obj *fw_qp;
57 struct mlx5_devx_qp sw_qp;
60 struct mlx5_vdpa_query_mr {
61 SLIST_ENTRY(mlx5_vdpa_query_mr) next;
64 struct mlx5dv_devx_umem *umem;
65 struct mlx5_devx_obj *mkey;
70 MLX5_VDPA_NOTIFIER_STATE_DISABLED,
71 MLX5_VDPA_NOTIFIER_STATE_ENABLED,
72 MLX5_VDPA_NOTIFIER_STATE_ERR
75 struct mlx5_vdpa_virtq {
76 SLIST_ENTRY(mlx5_vdpa_virtq) next;
80 uint8_t notifier_state;
83 struct mlx5_vdpa_priv *priv;
84 struct mlx5_devx_obj *virtq;
85 struct mlx5_devx_obj *counters;
86 struct mlx5_vdpa_event_qp eqp;
88 struct mlx5dv_devx_umem *obj;
92 struct rte_intr_handle *intr_handle;
93 uint64_t err_time[3]; /* RDTSC time of recent errors. */
95 struct mlx5_devx_virtio_q_couners_attr reset;
98 struct mlx5_vdpa_steer {
99 struct mlx5_devx_obj *rqt;
103 struct mlx5dv_flow_matcher *matcher;
104 struct mlx5_devx_obj *tir;
111 MLX5_VDPA_EVENT_MODE_DYNAMIC_TIMER,
112 MLX5_VDPA_EVENT_MODE_FIXED_TIMER,
113 MLX5_VDPA_EVENT_MODE_ONLY_INTERRUPT
116 struct mlx5_vdpa_priv {
117 TAILQ_ENTRY(mlx5_vdpa_priv) next;
119 pthread_mutex_t vq_config_lock;
120 uint64_t no_traffic_counter;
123 int event_core; /* Event thread cpu affinity core. */
125 uint32_t timer_delay_us;
126 uint32_t no_traffic_max;
127 uint8_t hw_latency_mode; /* Hardware CQ moderation mode. */
128 uint16_t hw_max_latency_us; /* Hardware CQ moderation period in usec. */
129 uint16_t hw_max_pending_comp; /* Hardware CQ moderation counter. */
130 struct rte_vdpa_device *vdev; /* vDPA device. */
131 struct mlx5_common_device *cdev; /* Backend mlx5 device. */
132 int vid; /* vhost device id. */
133 struct mlx5_hca_vdpa_attr caps;
134 uint32_t gpa_mkey_index;
135 struct ibv_mr *null_mr;
136 struct rte_vhost_memory *vmem;
137 struct mlx5dv_devx_event_channel *eventc;
138 struct mlx5dv_devx_event_channel *err_chnl;
140 struct rte_intr_handle *err_intr_handle;
141 struct mlx5_devx_obj *td;
142 struct mlx5_devx_obj *tiss[16]; /* TIS list for each LAG port. */
144 uint8_t num_lag_ports;
145 uint64_t features; /* Negotiated features. */
146 uint16_t log_max_rqt_size;
147 struct mlx5_vdpa_steer steer;
148 struct mlx5dv_var *var;
150 struct mlx5_pmd_wrapped_mr lm_mr;
151 SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
152 struct mlx5_vdpa_virtq virtqs[];
156 MLX5_VDPA_STATS_RECEIVED_DESCRIPTORS,
157 MLX5_VDPA_STATS_COMPLETED_DESCRIPTORS,
158 MLX5_VDPA_STATS_BAD_DESCRIPTOR_ERRORS,
159 MLX5_VDPA_STATS_EXCEED_MAX_CHAIN,
160 MLX5_VDPA_STATS_INVALID_BUFFER,
161 MLX5_VDPA_STATS_COMPLETION_ERRORS,
166 * Check whether virtq is for traffic receive.
167 * According to VIRTIO_NET Spec the virtqueues index identity its type by:
172 * 2(N-1)+1 transmitqN
175 static inline uint8_t
176 is_virtq_recvq(int virtq_index, int nr_vring)
178 if (virtq_index % 2 == 0 && virtq_index != nr_vring - 1)
184 * Release all the prepared memory regions and all their related resources.
187 * The vdpa driver private structure.
189 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
192 * Register all the memory regions of the virtio device to the HW and allocate
193 * all their related resources.
196 * The vdpa driver private structure.
199 * 0 on success, a negative errno value otherwise and rte_errno is set.
201 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
205 * Create an event QP and all its related resources.
208 * The vdpa driver private structure.
210 * Number of descriptors.
212 * The guest notification file descriptor.
214 * Pointer to the event QP structure.
217 * 0 on success, -1 otherwise and rte_errno is set.
219 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
220 int callfd, struct mlx5_vdpa_event_qp *eqp);
223 * Destroy an event QP and all its related resources.
226 * Pointer to the event QP structure.
228 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
231 * Release all the event global resources.
234 * The vdpa driver private structure.
236 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
242 * The vdpa driver private structure.
245 * 0 on success, a negative errno value otherwise and rte_errno is set.
247 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
253 * The vdpa driver private structure.
255 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
258 * Setup error interrupt handler.
261 * The vdpa driver private structure.
264 * 0 on success, a negative errno value otherwise and rte_errno is set.
266 int mlx5_vdpa_err_event_setup(struct mlx5_vdpa_priv *priv);
269 * Unset error event handler.
272 * The vdpa driver private structure.
274 void mlx5_vdpa_err_event_unset(struct mlx5_vdpa_priv *priv);
277 * Release a virtq and all its related resources.
280 * The vdpa driver private structure.
282 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
285 * Create all the HW virtqs resources and all their related resources.
288 * The vdpa driver private structure.
291 * 0 on success, a negative errno value otherwise and rte_errno is set.
293 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
296 * Enable\Disable virtq..
299 * The vdpa driver private structure.
303 * Set to enable, otherwise disable.
306 * 0 on success, a negative value otherwise.
308 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_priv *priv, int index, int enable);
311 * Unset steering and release all its related resources- stop traffic.
314 * The vdpa driver private structure.
316 void mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
319 * Update steering according to the received queues status.
322 * The vdpa driver private structure.
325 * 0 on success, a negative value otherwise.
327 int mlx5_vdpa_steer_update(struct mlx5_vdpa_priv *priv);
330 * Setup steering and all its related resources to enable RSS traffic from the
331 * device to all the Rx host queues.
334 * The vdpa driver private structure.
337 * 0 on success, a negative value otherwise.
339 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
342 * Enable\Disable live migration logging.
345 * The vdpa driver private structure.
347 * Set for enable, unset for disable.
350 * 0 on success, a negative value otherwise.
352 int mlx5_vdpa_logging_enable(struct mlx5_vdpa_priv *priv, int enable);
355 * Set dirty bitmap logging to allow live migration.
358 * The vdpa driver private structure.
359 * @param[in] log_base
361 * @param[in] log_size
365 * 0 on success, a negative value otherwise.
367 int mlx5_vdpa_dirty_bitmap_set(struct mlx5_vdpa_priv *priv, uint64_t log_base,
371 * Log all virtqs information for live migration.
374 * The vdpa driver private structure.
376 * Set for enable, unset for disable.
379 * 0 on success, a negative value otherwise.
381 int mlx5_vdpa_lm_log(struct mlx5_vdpa_priv *priv);
384 * Modify virtq state to be ready or suspend.
387 * The vdpa driver private virtq structure.
389 * Set for ready, otherwise suspend.
392 * 0 on success, a negative value otherwise.
394 int mlx5_vdpa_virtq_modify(struct mlx5_vdpa_virtq *virtq, int state);
397 * Stop virtq before destroying it.
400 * The vdpa driver private structure.
405 * 0 on success, a negative value otherwise.
407 int mlx5_vdpa_virtq_stop(struct mlx5_vdpa_priv *priv, int index);
410 * Query virtq information.
413 * The vdpa driver private structure.
418 * 0 on success, a negative value otherwise.
420 int mlx5_vdpa_virtq_query(struct mlx5_vdpa_priv *priv, int index);
423 * Get virtq statistics.
426 * The vdpa driver private structure.
430 * The virtq statistics array to fill.
432 * The number of elements in @p stats array.
435 * A negative value on error, otherwise the number of entries filled in the
439 mlx5_vdpa_virtq_stats_get(struct mlx5_vdpa_priv *priv, int qid,
440 struct rte_vdpa_stat *stats, unsigned int n);
443 * Reset virtq statistics.
446 * The vdpa driver private structure.
451 * A negative value on error, otherwise 0.
454 mlx5_vdpa_virtq_stats_reset(struct mlx5_vdpa_priv *priv, int qid);
455 #endif /* RTE_PMD_MLX5_VDPA_H_ */