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;
89 struct mlx5_vdpa_priv *priv;
90 struct mlx5_devx_obj *virtq;
91 struct mlx5_devx_obj *counters;
92 struct mlx5_vdpa_event_qp eqp;
94 struct mlx5dv_devx_umem *obj;
98 struct rte_intr_handle intr_handle;
99 struct mlx5_devx_virtio_q_couners_attr reset;
102 struct mlx5_vdpa_steer {
103 struct mlx5_devx_obj *rqt;
107 struct mlx5dv_flow_matcher *matcher;
108 struct mlx5_devx_obj *tir;
115 MLX5_VDPA_EVENT_MODE_DYNAMIC_TIMER,
116 MLX5_VDPA_EVENT_MODE_FIXED_TIMER,
117 MLX5_VDPA_EVENT_MODE_ONLY_INTERRUPT
120 struct mlx5_vdpa_priv {
121 TAILQ_ENTRY(mlx5_vdpa_priv) next;
123 uint64_t last_traffic_tic;
125 pthread_mutex_t timer_lock;
126 pthread_cond_t timer_cond;
127 volatile uint8_t timer_on;
130 uint32_t timer_delay_us;
131 uint32_t no_traffic_time_s;
132 struct rte_vdpa_device *vdev; /* vDPA device. */
133 int vid; /* vhost device id. */
134 struct ibv_context *ctx; /* Device context. */
135 struct rte_pci_device *pci_dev;
136 struct mlx5_hca_vdpa_attr caps;
137 uint32_t pdn; /* Protection Domain number. */
139 uint32_t gpa_mkey_index;
140 struct ibv_mr *null_mr;
141 struct rte_vhost_memory *vmem;
143 struct mlx5dv_devx_event_channel *eventc;
144 struct mlx5dv_devx_uar *uar;
145 struct rte_intr_handle intr_handle;
146 struct mlx5_devx_obj *td;
147 struct mlx5_devx_obj *tis;
149 uint64_t features; /* Negotiated features. */
150 uint16_t log_max_rqt_size;
151 struct mlx5_vdpa_steer steer;
152 struct mlx5dv_var *var;
154 SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
155 struct mlx5_vdpa_virtq virtqs[];
159 MLX5_VDPA_STATS_RECEIVED_DESCRIPTORS,
160 MLX5_VDPA_STATS_COMPLETED_DESCRIPTORS,
161 MLX5_VDPA_STATS_BAD_DESCRIPTOR_ERRORS,
162 MLX5_VDPA_STATS_EXCEED_MAX_CHAIN,
163 MLX5_VDPA_STATS_INVALID_BUFFER,
164 MLX5_VDPA_STATS_COMPLETION_ERRORS,
169 * Check whether virtq is for traffic receive.
170 * According to VIRTIO_NET Spec the virtqueues index identity its type by:
175 * 2(N-1)+1 transmitqN
178 static inline uint8_t
179 is_virtq_recvq(int virtq_index, int nr_vring)
181 if (virtq_index % 2 == 0 && virtq_index != nr_vring - 1)
187 * Release all the prepared memory regions and all their related resources.
190 * The vdpa driver private structure.
192 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
195 * Register all the memory regions of the virtio device to the HW and allocate
196 * all their related resources.
199 * The vdpa driver private structure.
202 * 0 on success, a negative errno value otherwise and rte_errno is set.
204 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
208 * Create an event QP and all its related resources.
211 * The vdpa driver private structure.
213 * Number of descriptors.
215 * The guest notification file descriptor.
217 * Pointer to the event QP structure.
220 * 0 on success, -1 otherwise and rte_errno is set.
222 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
223 int callfd, struct mlx5_vdpa_event_qp *eqp);
226 * Destroy an event QP and all its related resources.
229 * Pointer to the event QP structure.
231 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
234 * Release all the event global resources.
237 * The vdpa driver private structure.
239 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
245 * The vdpa driver private structure.
248 * 0 on success, a negative errno value otherwise and rte_errno is set.
250 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
256 * The vdpa driver private structure.
258 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
261 * Release a virtq and all its related resources.
264 * The vdpa driver private structure.
266 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
269 * Create all the HW virtqs resources and all their related resources.
272 * The vdpa driver private structure.
275 * 0 on success, a negative errno value otherwise and rte_errno is set.
277 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
280 * Enable\Disable virtq..
283 * The vdpa driver private structure.
287 * Set to enable, otherwise disable.
290 * 0 on success, a negative value otherwise.
292 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_priv *priv, int index, int enable);
295 * Unset steering and release all its related resources- stop traffic.
298 * The vdpa driver private structure.
300 void mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
303 * Update steering according to the received queues status.
306 * The vdpa driver private structure.
309 * 0 on success, a negative value otherwise.
311 int mlx5_vdpa_steer_update(struct mlx5_vdpa_priv *priv);
314 * Setup steering and all its related resources to enable RSS traffic from the
315 * device to all the Rx host queues.
318 * The vdpa driver private structure.
321 * 0 on success, a negative value otherwise.
323 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
326 * Enable\Disable live migration logging.
329 * The vdpa driver private structure.
331 * Set for enable, unset for disable.
334 * 0 on success, a negative value otherwise.
336 int mlx5_vdpa_logging_enable(struct mlx5_vdpa_priv *priv, int enable);
339 * Set dirty bitmap logging to allow live migration.
342 * The vdpa driver private structure.
343 * @param[in] log_base
345 * @param[in] log_size
349 * 0 on success, a negative value otherwise.
351 int mlx5_vdpa_dirty_bitmap_set(struct mlx5_vdpa_priv *priv, uint64_t log_base,
355 * Log all virtqs information for live migration.
358 * The vdpa driver private structure.
360 * Set for enable, unset for disable.
363 * 0 on success, a negative value otherwise.
365 int mlx5_vdpa_lm_log(struct mlx5_vdpa_priv *priv);
368 * Modify virtq state to be ready or suspend.
371 * The vdpa driver private virtq structure.
373 * Set for ready, otherwise suspend.
376 * 0 on success, a negative value otherwise.
378 int mlx5_vdpa_virtq_modify(struct mlx5_vdpa_virtq *virtq, int state);
381 * Stop virtq before destroying it.
384 * The vdpa driver private structure.
389 * 0 on success, a negative value otherwise.
391 int mlx5_vdpa_virtq_stop(struct mlx5_vdpa_priv *priv, int index);
394 * Get virtq statistics.
397 * The vdpa driver private structure.
401 * The virtq statistics array to fill.
403 * The number of elements in @p stats array.
406 * A negative value on error, otherwise the number of entries filled in the
410 mlx5_vdpa_virtq_stats_get(struct mlx5_vdpa_priv *priv, int qid,
411 struct rte_vdpa_stat *stats, unsigned int n);
414 * Reset virtq statistics.
417 * The vdpa driver private structure.
422 * A negative value on error, otherwise 0.
425 mlx5_vdpa_virtq_stats_reset(struct mlx5_vdpa_priv *priv, int qid);
426 #endif /* RTE_PMD_MLX5_VDPA_H_ */