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;
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;
90 struct mlx5_vdpa_priv *priv;
91 struct mlx5_devx_obj *virtq;
92 struct mlx5_devx_obj *counters;
93 struct mlx5_vdpa_event_qp eqp;
95 struct mlx5dv_devx_umem *obj;
99 struct rte_intr_handle intr_handle;
100 struct mlx5_devx_virtio_q_couners_attr reset;
103 struct mlx5_vdpa_steer {
104 struct mlx5_devx_obj *rqt;
108 struct mlx5dv_flow_matcher *matcher;
109 struct mlx5_devx_obj *tir;
116 MLX5_VDPA_EVENT_MODE_DYNAMIC_TIMER,
117 MLX5_VDPA_EVENT_MODE_FIXED_TIMER,
118 MLX5_VDPA_EVENT_MODE_ONLY_INTERRUPT
121 struct mlx5_vdpa_priv {
122 TAILQ_ENTRY(mlx5_vdpa_priv) next;
124 pthread_mutex_t vq_config_lock;
125 uint64_t last_traffic_tic;
127 pthread_mutex_t timer_lock;
128 pthread_cond_t timer_cond;
129 volatile uint8_t timer_on;
132 uint32_t timer_delay_us;
133 uint32_t no_traffic_time_s;
134 struct rte_vdpa_device *vdev; /* vDPA device. */
135 int vid; /* vhost device id. */
136 struct ibv_context *ctx; /* Device context. */
137 struct rte_pci_device *pci_dev;
138 struct mlx5_hca_vdpa_attr caps;
139 uint32_t pdn; /* Protection Domain number. */
141 uint32_t gpa_mkey_index;
142 struct ibv_mr *null_mr;
143 struct rte_vhost_memory *vmem;
145 struct mlx5dv_devx_event_channel *eventc;
146 struct mlx5dv_devx_uar *uar;
147 struct rte_intr_handle intr_handle;
148 struct mlx5_devx_obj *td;
149 struct mlx5_devx_obj *tis;
151 uint64_t features; /* Negotiated features. */
152 uint16_t log_max_rqt_size;
153 struct mlx5_vdpa_steer steer;
154 struct mlx5dv_var *var;
156 SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
157 struct mlx5_vdpa_virtq virtqs[];
161 MLX5_VDPA_STATS_RECEIVED_DESCRIPTORS,
162 MLX5_VDPA_STATS_COMPLETED_DESCRIPTORS,
163 MLX5_VDPA_STATS_BAD_DESCRIPTOR_ERRORS,
164 MLX5_VDPA_STATS_EXCEED_MAX_CHAIN,
165 MLX5_VDPA_STATS_INVALID_BUFFER,
166 MLX5_VDPA_STATS_COMPLETION_ERRORS,
171 * Check whether virtq is for traffic receive.
172 * According to VIRTIO_NET Spec the virtqueues index identity its type by:
177 * 2(N-1)+1 transmitqN
180 static inline uint8_t
181 is_virtq_recvq(int virtq_index, int nr_vring)
183 if (virtq_index % 2 == 0 && virtq_index != nr_vring - 1)
189 * Release all the prepared memory regions and all their related resources.
192 * The vdpa driver private structure.
194 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
197 * Register all the memory regions of the virtio device to the HW and allocate
198 * all their related resources.
201 * The vdpa driver private structure.
204 * 0 on success, a negative errno value otherwise and rte_errno is set.
206 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
210 * Create an event QP and all its related resources.
213 * The vdpa driver private structure.
215 * Number of descriptors.
217 * The guest notification file descriptor.
219 * Pointer to the event QP structure.
222 * 0 on success, -1 otherwise and rte_errno is set.
224 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
225 int callfd, struct mlx5_vdpa_event_qp *eqp);
228 * Destroy an event QP and all its related resources.
231 * Pointer to the event QP structure.
233 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
236 * Release all the event global resources.
239 * The vdpa driver private structure.
241 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
247 * The vdpa driver private structure.
250 * 0 on success, a negative errno value otherwise and rte_errno is set.
252 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
258 * The vdpa driver private structure.
260 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
263 * Release a virtq and all its related resources.
266 * The vdpa driver private structure.
268 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
271 * Create all the HW virtqs resources and all their related resources.
274 * The vdpa driver private structure.
277 * 0 on success, a negative errno value otherwise and rte_errno is set.
279 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
282 * Enable\Disable virtq..
285 * The vdpa driver private structure.
289 * Set to enable, otherwise disable.
292 * 0 on success, a negative value otherwise.
294 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_priv *priv, int index, int enable);
297 * Unset steering and release all its related resources- stop traffic.
300 * The vdpa driver private structure.
302 void mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
305 * Update steering according to the received queues status.
308 * The vdpa driver private structure.
311 * 0 on success, a negative value otherwise.
313 int mlx5_vdpa_steer_update(struct mlx5_vdpa_priv *priv);
316 * Setup steering and all its related resources to enable RSS traffic from the
317 * device to all the Rx host queues.
320 * The vdpa driver private structure.
323 * 0 on success, a negative value otherwise.
325 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
328 * Enable\Disable live migration logging.
331 * The vdpa driver private structure.
333 * Set for enable, unset for disable.
336 * 0 on success, a negative value otherwise.
338 int mlx5_vdpa_logging_enable(struct mlx5_vdpa_priv *priv, int enable);
341 * Set dirty bitmap logging to allow live migration.
344 * The vdpa driver private structure.
345 * @param[in] log_base
347 * @param[in] log_size
351 * 0 on success, a negative value otherwise.
353 int mlx5_vdpa_dirty_bitmap_set(struct mlx5_vdpa_priv *priv, uint64_t log_base,
357 * Log all virtqs information for live migration.
360 * The vdpa driver private structure.
362 * Set for enable, unset for disable.
365 * 0 on success, a negative value otherwise.
367 int mlx5_vdpa_lm_log(struct mlx5_vdpa_priv *priv);
370 * Modify virtq state to be ready or suspend.
373 * The vdpa driver private virtq structure.
375 * Set for ready, otherwise suspend.
378 * 0 on success, a negative value otherwise.
380 int mlx5_vdpa_virtq_modify(struct mlx5_vdpa_virtq *virtq, int state);
383 * Stop virtq before destroying it.
386 * The vdpa driver private structure.
391 * 0 on success, a negative value otherwise.
393 int mlx5_vdpa_virtq_stop(struct mlx5_vdpa_priv *priv, int index);
396 * Get virtq statistics.
399 * The vdpa driver private structure.
403 * The virtq statistics array to fill.
405 * The number of elements in @p stats array.
408 * A negative value on error, otherwise the number of entries filled in the
412 mlx5_vdpa_virtq_stats_get(struct mlx5_vdpa_priv *priv, int qid,
413 struct rte_vdpa_stat *stats, unsigned int n);
416 * Reset virtq statistics.
419 * The vdpa driver private structure.
424 * A negative value on error, otherwise 0.
427 mlx5_vdpa_virtq_stats_reset(struct mlx5_vdpa_priv *priv, int qid);
428 #endif /* RTE_PMD_MLX5_VDPA_H_ */