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 <rte_vdpa_dev.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>
28 #define MLX5_VDPA_INTR_RETRIES 256
29 #define MLX5_VDPA_INTR_RETRIES_USEC 1000
31 #ifndef VIRTIO_F_ORDER_PLATFORM
32 #define VIRTIO_F_ORDER_PLATFORM 36
35 #ifndef VIRTIO_F_RING_PACKED
36 #define VIRTIO_F_RING_PACKED 34
39 #define MLX5_VDPA_DEFAULT_TIMER_DELAY_US 0u
40 #define MLX5_VDPA_DEFAULT_TIMER_STEP_US 1u
49 struct mlx5_devx_obj *cq;
50 struct mlx5dv_devx_umem *umem_obj;
52 volatile void *umem_buf;
53 volatile struct mlx5_cqe *cqes;
55 volatile uint32_t *db_rec;
59 struct mlx5_vdpa_event_qp {
60 struct mlx5_vdpa_cq cq;
61 struct mlx5_devx_obj *fw_qp;
62 struct mlx5_devx_obj *sw_qp;
63 struct mlx5dv_devx_umem *umem_obj;
65 volatile uint32_t *db_rec;
68 struct mlx5_vdpa_query_mr {
69 SLIST_ENTRY(mlx5_vdpa_query_mr) next;
72 struct mlx5dv_devx_umem *umem;
73 struct mlx5_devx_obj *mkey;
78 MLX5_VDPA_NOTIFIER_STATE_DISABLED,
79 MLX5_VDPA_NOTIFIER_STATE_ENABLED,
80 MLX5_VDPA_NOTIFIER_STATE_ERR
83 struct mlx5_vdpa_virtq {
84 SLIST_ENTRY(mlx5_vdpa_virtq) next;
88 uint8_t notifier_state;
91 struct mlx5_vdpa_priv *priv;
92 struct mlx5_devx_obj *virtq;
93 struct mlx5_devx_obj *counters;
94 struct mlx5_vdpa_event_qp eqp;
96 struct mlx5dv_devx_umem *obj;
100 struct rte_intr_handle intr_handle;
101 uint64_t err_time[3]; /* RDTSC time of recent errors. */
103 struct mlx5_devx_virtio_q_couners_attr reset;
106 struct mlx5_vdpa_steer {
107 struct mlx5_devx_obj *rqt;
111 struct mlx5dv_flow_matcher *matcher;
112 struct mlx5_devx_obj *tir;
119 MLX5_VDPA_EVENT_MODE_DYNAMIC_TIMER,
120 MLX5_VDPA_EVENT_MODE_FIXED_TIMER,
121 MLX5_VDPA_EVENT_MODE_ONLY_INTERRUPT
124 struct mlx5_vdpa_priv {
125 TAILQ_ENTRY(mlx5_vdpa_priv) next;
127 pthread_mutex_t vq_config_lock;
128 uint64_t last_traffic_tic;
130 pthread_mutex_t timer_lock;
131 pthread_cond_t timer_cond;
132 volatile uint8_t timer_on;
134 int event_core; /* Event thread cpu affinity core. */
136 uint32_t timer_delay_us;
137 uint32_t no_traffic_time_s;
138 struct rte_vdpa_device *vdev; /* vDPA device. */
139 int vid; /* vhost device id. */
140 struct ibv_context *ctx; /* Device context. */
141 struct rte_pci_device *pci_dev;
142 struct mlx5_hca_vdpa_attr caps;
143 uint32_t pdn; /* Protection Domain number. */
145 uint32_t gpa_mkey_index;
146 struct ibv_mr *null_mr;
147 struct rte_vhost_memory *vmem;
149 struct mlx5dv_devx_event_channel *eventc;
150 struct mlx5dv_devx_event_channel *err_chnl;
151 struct mlx5dv_devx_uar *uar;
152 struct rte_intr_handle intr_handle;
153 struct rte_intr_handle err_intr_handle;
154 struct mlx5_devx_obj *td;
155 struct mlx5_devx_obj *tiss[16]; /* TIS list for each LAG port. */
157 uint8_t num_lag_ports;
158 uint64_t features; /* Negotiated features. */
159 uint16_t log_max_rqt_size;
160 struct mlx5_vdpa_steer steer;
161 struct mlx5dv_var *var;
163 SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
164 struct mlx5_vdpa_virtq virtqs[];
168 MLX5_VDPA_STATS_RECEIVED_DESCRIPTORS,
169 MLX5_VDPA_STATS_COMPLETED_DESCRIPTORS,
170 MLX5_VDPA_STATS_BAD_DESCRIPTOR_ERRORS,
171 MLX5_VDPA_STATS_EXCEED_MAX_CHAIN,
172 MLX5_VDPA_STATS_INVALID_BUFFER,
173 MLX5_VDPA_STATS_COMPLETION_ERRORS,
178 * Check whether virtq is for traffic receive.
179 * According to VIRTIO_NET Spec the virtqueues index identity its type by:
184 * 2(N-1)+1 transmitqN
187 static inline uint8_t
188 is_virtq_recvq(int virtq_index, int nr_vring)
190 if (virtq_index % 2 == 0 && virtq_index != nr_vring - 1)
196 * Release all the prepared memory regions and all their related resources.
199 * The vdpa driver private structure.
201 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
204 * Register all the memory regions of the virtio device to the HW and allocate
205 * all their related resources.
208 * The vdpa driver private structure.
211 * 0 on success, a negative errno value otherwise and rte_errno is set.
213 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
217 * Create an event QP and all its related resources.
220 * The vdpa driver private structure.
222 * Number of descriptors.
224 * The guest notification file descriptor.
226 * Pointer to the event QP structure.
229 * 0 on success, -1 otherwise and rte_errno is set.
231 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
232 int callfd, struct mlx5_vdpa_event_qp *eqp);
235 * Destroy an event QP and all its related resources.
238 * Pointer to the event QP structure.
240 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
243 * Release all the event global resources.
246 * The vdpa driver private structure.
248 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
254 * The vdpa driver private structure.
257 * 0 on success, a negative errno value otherwise and rte_errno is set.
259 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
265 * The vdpa driver private structure.
267 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
270 * Setup error interrupt handler.
273 * The vdpa driver private structure.
276 * 0 on success, a negative errno value otherwise and rte_errno is set.
278 int mlx5_vdpa_err_event_setup(struct mlx5_vdpa_priv *priv);
281 * Unset error event handler.
284 * The vdpa driver private structure.
286 void mlx5_vdpa_err_event_unset(struct mlx5_vdpa_priv *priv);
289 * Release a virtq and all its related resources.
292 * The vdpa driver private structure.
294 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
297 * Create all the HW virtqs resources and all their related resources.
300 * The vdpa driver private structure.
303 * 0 on success, a negative errno value otherwise and rte_errno is set.
305 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
308 * Enable\Disable virtq..
311 * The vdpa driver private structure.
315 * Set to enable, otherwise disable.
318 * 0 on success, a negative value otherwise.
320 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_priv *priv, int index, int enable);
323 * Unset steering and release all its related resources- stop traffic.
326 * The vdpa driver private structure.
328 void mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
331 * Update steering according to the received queues status.
334 * The vdpa driver private structure.
337 * 0 on success, a negative value otherwise.
339 int mlx5_vdpa_steer_update(struct mlx5_vdpa_priv *priv);
342 * Setup steering and all its related resources to enable RSS traffic from the
343 * device to all the Rx host queues.
346 * The vdpa driver private structure.
349 * 0 on success, a negative value otherwise.
351 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
354 * Enable\Disable live migration logging.
357 * The vdpa driver private structure.
359 * Set for enable, unset for disable.
362 * 0 on success, a negative value otherwise.
364 int mlx5_vdpa_logging_enable(struct mlx5_vdpa_priv *priv, int enable);
367 * Set dirty bitmap logging to allow live migration.
370 * The vdpa driver private structure.
371 * @param[in] log_base
373 * @param[in] log_size
377 * 0 on success, a negative value otherwise.
379 int mlx5_vdpa_dirty_bitmap_set(struct mlx5_vdpa_priv *priv, uint64_t log_base,
383 * Log all virtqs information for live migration.
386 * The vdpa driver private structure.
388 * Set for enable, unset for disable.
391 * 0 on success, a negative value otherwise.
393 int mlx5_vdpa_lm_log(struct mlx5_vdpa_priv *priv);
396 * Modify virtq state to be ready or suspend.
399 * The vdpa driver private virtq structure.
401 * Set for ready, otherwise suspend.
404 * 0 on success, a negative value otherwise.
406 int mlx5_vdpa_virtq_modify(struct mlx5_vdpa_virtq *virtq, int state);
409 * Stop virtq before destroying it.
412 * The vdpa driver private structure.
417 * 0 on success, a negative value otherwise.
419 int mlx5_vdpa_virtq_stop(struct mlx5_vdpa_priv *priv, int index);
422 * Query virtq information.
425 * The vdpa driver private structure.
430 * 0 on success, a negative value otherwise.
432 int mlx5_vdpa_virtq_query(struct mlx5_vdpa_priv *priv, int index);
435 * Get virtq statistics.
438 * The vdpa driver private structure.
442 * The virtq statistics array to fill.
444 * The number of elements in @p stats array.
447 * A negative value on error, otherwise the number of entries filled in the
451 mlx5_vdpa_virtq_stats_get(struct mlx5_vdpa_priv *priv, int qid,
452 struct rte_vdpa_stat *stats, unsigned int n);
455 * Reset virtq statistics.
458 * The vdpa driver private structure.
463 * A negative value on error, otherwise 0.
466 mlx5_vdpa_virtq_stats_reset(struct mlx5_vdpa_priv *priv, int qid);
467 #endif /* RTE_PMD_MLX5_VDPA_H_ */