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 pthread_mutex_t vq_config_lock;
124 uint64_t last_traffic_tic;
126 pthread_mutex_t timer_lock;
127 pthread_cond_t timer_cond;
128 volatile uint8_t timer_on;
131 uint32_t timer_delay_us;
132 uint32_t no_traffic_time_s;
133 struct rte_vdpa_device *vdev; /* vDPA device. */
134 int vid; /* vhost device id. */
135 struct ibv_context *ctx; /* Device context. */
136 struct rte_pci_device *pci_dev;
137 struct mlx5_hca_vdpa_attr caps;
138 uint32_t pdn; /* Protection Domain number. */
140 uint32_t gpa_mkey_index;
141 struct ibv_mr *null_mr;
142 struct rte_vhost_memory *vmem;
144 struct mlx5dv_devx_event_channel *eventc;
145 struct mlx5dv_devx_uar *uar;
146 struct rte_intr_handle intr_handle;
147 struct mlx5_devx_obj *td;
148 struct mlx5_devx_obj *tis;
150 uint64_t features; /* Negotiated features. */
151 uint16_t log_max_rqt_size;
152 struct mlx5_vdpa_steer steer;
153 struct mlx5dv_var *var;
155 SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
156 struct mlx5_vdpa_virtq virtqs[];
160 MLX5_VDPA_STATS_RECEIVED_DESCRIPTORS,
161 MLX5_VDPA_STATS_COMPLETED_DESCRIPTORS,
162 MLX5_VDPA_STATS_BAD_DESCRIPTOR_ERRORS,
163 MLX5_VDPA_STATS_EXCEED_MAX_CHAIN,
164 MLX5_VDPA_STATS_INVALID_BUFFER,
165 MLX5_VDPA_STATS_COMPLETION_ERRORS,
170 * Check whether virtq is for traffic receive.
171 * According to VIRTIO_NET Spec the virtqueues index identity its type by:
176 * 2(N-1)+1 transmitqN
179 static inline uint8_t
180 is_virtq_recvq(int virtq_index, int nr_vring)
182 if (virtq_index % 2 == 0 && virtq_index != nr_vring - 1)
188 * Release all the prepared memory regions and all their related resources.
191 * The vdpa driver private structure.
193 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
196 * Register all the memory regions of the virtio device to the HW and allocate
197 * all their related resources.
200 * The vdpa driver private structure.
203 * 0 on success, a negative errno value otherwise and rte_errno is set.
205 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
209 * Create an event QP and all its related resources.
212 * The vdpa driver private structure.
214 * Number of descriptors.
216 * The guest notification file descriptor.
218 * Pointer to the event QP structure.
221 * 0 on success, -1 otherwise and rte_errno is set.
223 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
224 int callfd, struct mlx5_vdpa_event_qp *eqp);
227 * Destroy an event QP and all its related resources.
230 * Pointer to the event QP structure.
232 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
235 * Release all the event global resources.
238 * The vdpa driver private structure.
240 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
246 * The vdpa driver private structure.
249 * 0 on success, a negative errno value otherwise and rte_errno is set.
251 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
257 * The vdpa driver private structure.
259 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
262 * Release a virtq and all its related resources.
265 * The vdpa driver private structure.
267 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
270 * Create all the HW virtqs resources and all their related resources.
273 * The vdpa driver private structure.
276 * 0 on success, a negative errno value otherwise and rte_errno is set.
278 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
281 * Enable\Disable virtq..
284 * The vdpa driver private structure.
288 * Set to enable, otherwise disable.
291 * 0 on success, a negative value otherwise.
293 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_priv *priv, int index, int enable);
296 * Unset steering and release all its related resources- stop traffic.
299 * The vdpa driver private structure.
301 void mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
304 * Update steering according to the received queues status.
307 * The vdpa driver private structure.
310 * 0 on success, a negative value otherwise.
312 int mlx5_vdpa_steer_update(struct mlx5_vdpa_priv *priv);
315 * Setup steering and all its related resources to enable RSS traffic from the
316 * device to all the Rx host queues.
319 * The vdpa driver private structure.
322 * 0 on success, a negative value otherwise.
324 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
327 * Enable\Disable live migration logging.
330 * The vdpa driver private structure.
332 * Set for enable, unset for disable.
335 * 0 on success, a negative value otherwise.
337 int mlx5_vdpa_logging_enable(struct mlx5_vdpa_priv *priv, int enable);
340 * Set dirty bitmap logging to allow live migration.
343 * The vdpa driver private structure.
344 * @param[in] log_base
346 * @param[in] log_size
350 * 0 on success, a negative value otherwise.
352 int mlx5_vdpa_dirty_bitmap_set(struct mlx5_vdpa_priv *priv, uint64_t log_base,
356 * Log all virtqs information for live migration.
359 * The vdpa driver private structure.
361 * Set for enable, unset for disable.
364 * 0 on success, a negative value otherwise.
366 int mlx5_vdpa_lm_log(struct mlx5_vdpa_priv *priv);
369 * Modify virtq state to be ready or suspend.
372 * The vdpa driver private virtq structure.
374 * Set for ready, otherwise suspend.
377 * 0 on success, a negative value otherwise.
379 int mlx5_vdpa_virtq_modify(struct mlx5_vdpa_virtq *virtq, int state);
382 * Stop virtq before destroying it.
385 * The vdpa driver private structure.
390 * 0 on success, a negative value otherwise.
392 int mlx5_vdpa_virtq_stop(struct mlx5_vdpa_priv *priv, int index);
395 * Get virtq statistics.
398 * The vdpa driver private structure.
402 * The virtq statistics array to fill.
404 * The number of elements in @p stats array.
407 * A negative value on error, otherwise the number of entries filled in the
411 mlx5_vdpa_virtq_stats_get(struct mlx5_vdpa_priv *priv, int qid,
412 struct rte_vdpa_stat *stats, unsigned int n);
415 * Reset virtq statistics.
418 * The vdpa driver private structure.
423 * A negative value on error, otherwise 0.
426 mlx5_vdpa_virtq_stats_reset(struct mlx5_vdpa_priv *priv, int qid);
427 #endif /* RTE_PMD_MLX5_VDPA_H_ */