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 100u
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;
77 struct mlx5_vdpa_virtq {
78 SLIST_ENTRY(mlx5_vdpa_virtq) next;
82 struct mlx5_vdpa_priv *priv;
83 struct mlx5_devx_obj *virtq;
84 struct mlx5_devx_obj *counters;
85 struct mlx5_vdpa_event_qp eqp;
87 struct mlx5dv_devx_umem *obj;
91 struct rte_intr_handle intr_handle;
92 struct mlx5_devx_virtio_q_couners_attr reset;
95 struct mlx5_vdpa_steer {
96 struct mlx5_devx_obj *rqt;
100 struct mlx5dv_flow_matcher *matcher;
101 struct mlx5_devx_obj *tir;
108 MLX5_VDPA_EVENT_MODE_DYNAMIC_TIMER,
109 MLX5_VDPA_EVENT_MODE_FIXED_TIMER,
110 MLX5_VDPA_EVENT_MODE_ONLY_INTERRUPT
113 struct mlx5_vdpa_priv {
114 TAILQ_ENTRY(mlx5_vdpa_priv) next;
116 uint8_t direct_notifier; /* Whether direct notifier is on or off. */
117 uint64_t last_traffic_tic;
119 pthread_mutex_t timer_lock;
120 pthread_cond_t timer_cond;
121 volatile uint8_t timer_on;
124 uint32_t timer_delay_us;
125 uint32_t no_traffic_time_s;
126 struct rte_vdpa_device *vdev; /* vDPA device. */
127 int vid; /* vhost device id. */
128 struct ibv_context *ctx; /* Device context. */
129 struct rte_pci_device *pci_dev;
130 struct mlx5_hca_vdpa_attr caps;
131 uint32_t pdn; /* Protection Domain number. */
133 uint32_t gpa_mkey_index;
134 struct ibv_mr *null_mr;
135 struct rte_vhost_memory *vmem;
137 struct mlx5dv_devx_event_channel *eventc;
138 struct mlx5dv_devx_uar *uar;
139 struct rte_intr_handle intr_handle;
140 struct mlx5_devx_obj *td;
141 struct mlx5_devx_obj *tis;
143 uint64_t features; /* Negotiated features. */
144 uint16_t log_max_rqt_size;
145 struct mlx5_vdpa_steer steer;
146 struct mlx5dv_var *var;
148 SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
149 struct mlx5_vdpa_virtq virtqs[];
153 MLX5_VDPA_STATS_RECEIVED_DESCRIPTORS,
154 MLX5_VDPA_STATS_COMPLETED_DESCRIPTORS,
155 MLX5_VDPA_STATS_BAD_DESCRIPTOR_ERRORS,
156 MLX5_VDPA_STATS_EXCEED_MAX_CHAIN,
157 MLX5_VDPA_STATS_INVALID_BUFFER,
158 MLX5_VDPA_STATS_COMPLETION_ERRORS,
163 * Check whether virtq is for traffic receive.
164 * According to VIRTIO_NET Spec the virtqueues index identity its type by:
169 * 2(N-1)+1 transmitqN
172 static inline uint8_t
173 is_virtq_recvq(int virtq_index, int nr_vring)
175 if (virtq_index % 2 == 0 && virtq_index != nr_vring - 1)
181 * Release all the prepared memory regions and all their related resources.
184 * The vdpa driver private structure.
186 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
189 * Register all the memory regions of the virtio device to the HW and allocate
190 * all their related resources.
193 * The vdpa driver private structure.
196 * 0 on success, a negative errno value otherwise and rte_errno is set.
198 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
202 * Create an event QP and all its related resources.
205 * The vdpa driver private structure.
207 * Number of descriptors.
209 * The guest notification file descriptor.
211 * Pointer to the event QP structure.
214 * 0 on success, -1 otherwise and rte_errno is set.
216 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
217 int callfd, struct mlx5_vdpa_event_qp *eqp);
220 * Destroy an event QP and all its related resources.
223 * Pointer to the event QP structure.
225 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
228 * Release all the event global resources.
231 * The vdpa driver private structure.
233 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
239 * The vdpa driver private structure.
242 * 0 on success, a negative errno value otherwise and rte_errno is set.
244 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
250 * The vdpa driver private structure.
252 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
255 * Release a virtq and all its related resources.
258 * The vdpa driver private structure.
260 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
263 * Create all the HW virtqs resources and all their related resources.
266 * The vdpa driver private structure.
269 * 0 on success, a negative errno value otherwise and rte_errno is set.
271 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
274 * Enable\Disable virtq..
277 * The vdpa driver private structure.
281 * Set to enable, otherwise disable.
284 * 0 on success, a negative value otherwise.
286 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_priv *priv, int index, int enable);
289 * Unset steering and release all its related resources- stop traffic.
292 * The vdpa driver private structure.
294 void mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
297 * Update steering according to the received queues status.
300 * The vdpa driver private structure.
303 * 0 on success, a negative value otherwise.
305 int mlx5_vdpa_steer_update(struct mlx5_vdpa_priv *priv);
308 * Setup steering and all its related resources to enable RSS traffic from the
309 * device to all the Rx host queues.
312 * The vdpa driver private structure.
315 * 0 on success, a negative value otherwise.
317 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
320 * Enable\Disable live migration logging.
323 * The vdpa driver private structure.
325 * Set for enable, unset for disable.
328 * 0 on success, a negative value otherwise.
330 int mlx5_vdpa_logging_enable(struct mlx5_vdpa_priv *priv, int enable);
333 * Set dirty bitmap logging to allow live migration.
336 * The vdpa driver private structure.
337 * @param[in] log_base
339 * @param[in] log_size
343 * 0 on success, a negative value otherwise.
345 int mlx5_vdpa_dirty_bitmap_set(struct mlx5_vdpa_priv *priv, uint64_t log_base,
349 * Log all virtqs information for live migration.
352 * The vdpa driver private structure.
354 * Set for enable, unset for disable.
357 * 0 on success, a negative value otherwise.
359 int mlx5_vdpa_lm_log(struct mlx5_vdpa_priv *priv);
362 * Modify virtq state to be ready or suspend.
365 * The vdpa driver private virtq structure.
367 * Set for ready, otherwise suspend.
370 * 0 on success, a negative value otherwise.
372 int mlx5_vdpa_virtq_modify(struct mlx5_vdpa_virtq *virtq, int state);
375 * Stop virtq before destroying it.
378 * The vdpa driver private structure.
383 * 0 on success, a negative value otherwise.
385 int mlx5_vdpa_virtq_stop(struct mlx5_vdpa_priv *priv, int index);
388 * Get virtq statistics.
391 * The vdpa driver private structure.
395 * The virtq statistics array to fill.
397 * The number of elements in @p stats array.
400 * A negative value on error, otherwise the number of entries filled in the
404 mlx5_vdpa_virtq_stats_get(struct mlx5_vdpa_priv *priv, int qid,
405 struct rte_vdpa_stat *stats, unsigned int n);
408 * Reset virtq statistics.
411 * The vdpa driver private structure.
416 * A negative value on error, otherwise 0.
419 mlx5_vdpa_virtq_stats_reset(struct mlx5_vdpa_priv *priv, int qid);
420 #endif /* RTE_PMD_MLX5_VDPA_H_ */