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;
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;
135 uint32_t timer_delay_us;
136 uint32_t no_traffic_time_s;
137 struct rte_vdpa_device *vdev; /* vDPA device. */
138 int vid; /* vhost device id. */
139 struct ibv_context *ctx; /* Device context. */
140 struct rte_pci_device *pci_dev;
141 struct mlx5_hca_vdpa_attr caps;
142 uint32_t pdn; /* Protection Domain number. */
144 uint32_t gpa_mkey_index;
145 struct ibv_mr *null_mr;
146 struct rte_vhost_memory *vmem;
148 struct mlx5dv_devx_event_channel *eventc;
149 struct mlx5dv_devx_event_channel *err_chnl;
150 struct mlx5dv_devx_uar *uar;
151 struct rte_intr_handle intr_handle;
152 struct rte_intr_handle err_intr_handle;
153 struct mlx5_devx_obj *td;
154 struct mlx5_devx_obj *tis;
156 uint64_t features; /* Negotiated features. */
157 uint16_t log_max_rqt_size;
158 struct mlx5_vdpa_steer steer;
159 struct mlx5dv_var *var;
161 SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
162 struct mlx5_vdpa_virtq virtqs[];
166 MLX5_VDPA_STATS_RECEIVED_DESCRIPTORS,
167 MLX5_VDPA_STATS_COMPLETED_DESCRIPTORS,
168 MLX5_VDPA_STATS_BAD_DESCRIPTOR_ERRORS,
169 MLX5_VDPA_STATS_EXCEED_MAX_CHAIN,
170 MLX5_VDPA_STATS_INVALID_BUFFER,
171 MLX5_VDPA_STATS_COMPLETION_ERRORS,
176 * Check whether virtq is for traffic receive.
177 * According to VIRTIO_NET Spec the virtqueues index identity its type by:
182 * 2(N-1)+1 transmitqN
185 static inline uint8_t
186 is_virtq_recvq(int virtq_index, int nr_vring)
188 if (virtq_index % 2 == 0 && virtq_index != nr_vring - 1)
194 * Release all the prepared memory regions and all their related resources.
197 * The vdpa driver private structure.
199 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
202 * Register all the memory regions of the virtio device to the HW and allocate
203 * all their related resources.
206 * The vdpa driver private structure.
209 * 0 on success, a negative errno value otherwise and rte_errno is set.
211 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
215 * Create an event QP and all its related resources.
218 * The vdpa driver private structure.
220 * Number of descriptors.
222 * The guest notification file descriptor.
224 * Pointer to the event QP structure.
227 * 0 on success, -1 otherwise and rte_errno is set.
229 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
230 int callfd, struct mlx5_vdpa_event_qp *eqp);
233 * Destroy an event QP and all its related resources.
236 * Pointer to the event QP structure.
238 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
241 * Release all the event global resources.
244 * The vdpa driver private structure.
246 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
252 * The vdpa driver private structure.
255 * 0 on success, a negative errno value otherwise and rte_errno is set.
257 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
263 * The vdpa driver private structure.
265 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
268 * Setup error interrupt handler.
271 * The vdpa driver private structure.
274 * 0 on success, a negative errno value otherwise and rte_errno is set.
276 int mlx5_vdpa_err_event_setup(struct mlx5_vdpa_priv *priv);
279 * Unset error event handler.
282 * The vdpa driver private structure.
284 void mlx5_vdpa_err_event_unset(struct mlx5_vdpa_priv *priv);
287 * Release a virtq and all its related resources.
290 * The vdpa driver private structure.
292 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
295 * Create all the HW virtqs resources and all their related resources.
298 * The vdpa driver private structure.
301 * 0 on success, a negative errno value otherwise and rte_errno is set.
303 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
306 * Enable\Disable virtq..
309 * The vdpa driver private structure.
313 * Set to enable, otherwise disable.
316 * 0 on success, a negative value otherwise.
318 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_priv *priv, int index, int enable);
321 * Unset steering and release all its related resources- stop traffic.
324 * The vdpa driver private structure.
326 void mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
329 * Update steering according to the received queues status.
332 * The vdpa driver private structure.
335 * 0 on success, a negative value otherwise.
337 int mlx5_vdpa_steer_update(struct mlx5_vdpa_priv *priv);
340 * Setup steering and all its related resources to enable RSS traffic from the
341 * device to all the Rx host queues.
344 * The vdpa driver private structure.
347 * 0 on success, a negative value otherwise.
349 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
352 * Enable\Disable live migration logging.
355 * The vdpa driver private structure.
357 * Set for enable, unset for disable.
360 * 0 on success, a negative value otherwise.
362 int mlx5_vdpa_logging_enable(struct mlx5_vdpa_priv *priv, int enable);
365 * Set dirty bitmap logging to allow live migration.
368 * The vdpa driver private structure.
369 * @param[in] log_base
371 * @param[in] log_size
375 * 0 on success, a negative value otherwise.
377 int mlx5_vdpa_dirty_bitmap_set(struct mlx5_vdpa_priv *priv, uint64_t log_base,
381 * Log all virtqs information for live migration.
384 * The vdpa driver private structure.
386 * Set for enable, unset for disable.
389 * 0 on success, a negative value otherwise.
391 int mlx5_vdpa_lm_log(struct mlx5_vdpa_priv *priv);
394 * Modify virtq state to be ready or suspend.
397 * The vdpa driver private virtq structure.
399 * Set for ready, otherwise suspend.
402 * 0 on success, a negative value otherwise.
404 int mlx5_vdpa_virtq_modify(struct mlx5_vdpa_virtq *virtq, int state);
407 * Stop virtq before destroying it.
410 * The vdpa driver private structure.
415 * 0 on success, a negative value otherwise.
417 int mlx5_vdpa_virtq_stop(struct mlx5_vdpa_priv *priv, int index);
420 * Query virtq information.
423 * The vdpa driver private structure.
428 * 0 on success, a negative value otherwise.
430 int mlx5_vdpa_virtq_query(struct mlx5_vdpa_priv *priv, int index);
433 * Get virtq statistics.
436 * The vdpa driver private structure.
440 * The virtq statistics array to fill.
442 * The number of elements in @p stats array.
445 * A negative value on error, otherwise the number of entries filled in the
449 mlx5_vdpa_virtq_stats_get(struct mlx5_vdpa_priv *priv, int qid,
450 struct rte_vdpa_stat *stats, unsigned int n);
453 * Reset virtq statistics.
456 * The vdpa driver private structure.
461 * A negative value on error, otherwise 0.
464 mlx5_vdpa_virtq_stats_reset(struct mlx5_vdpa_priv *priv, int qid);
465 #endif /* RTE_PMD_MLX5_VDPA_H_ */