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>
25 #include <mlx5_common_devx.h>
29 #define MLX5_VDPA_INTR_RETRIES 256
30 #define MLX5_VDPA_INTR_RETRIES_USEC 1000
32 #ifndef VIRTIO_F_ORDER_PLATFORM
33 #define VIRTIO_F_ORDER_PLATFORM 36
36 #ifndef VIRTIO_F_RING_PACKED
37 #define VIRTIO_F_RING_PACKED 34
40 #define MLX5_VDPA_DEFAULT_TIMER_DELAY_US 0u
41 #define MLX5_VDPA_DEFAULT_TIMER_STEP_US 1u
50 struct mlx5_devx_cq cq_obj;
54 struct mlx5_vdpa_event_qp {
55 struct mlx5_vdpa_cq cq;
56 struct mlx5_devx_obj *fw_qp;
57 struct mlx5_devx_obj *sw_qp;
58 struct mlx5dv_devx_umem *umem_obj;
60 volatile uint32_t *db_rec;
63 struct mlx5_vdpa_query_mr {
64 SLIST_ENTRY(mlx5_vdpa_query_mr) next;
67 struct mlx5dv_devx_umem *umem;
68 struct mlx5_devx_obj *mkey;
73 MLX5_VDPA_NOTIFIER_STATE_DISABLED,
74 MLX5_VDPA_NOTIFIER_STATE_ENABLED,
75 MLX5_VDPA_NOTIFIER_STATE_ERR
78 struct mlx5_vdpa_virtq {
79 SLIST_ENTRY(mlx5_vdpa_virtq) next;
83 uint8_t notifier_state;
86 struct mlx5_vdpa_priv *priv;
87 struct mlx5_devx_obj *virtq;
88 struct mlx5_devx_obj *counters;
89 struct mlx5_vdpa_event_qp eqp;
91 struct mlx5dv_devx_umem *obj;
95 struct rte_intr_handle intr_handle;
96 uint64_t err_time[3]; /* RDTSC time of recent errors. */
98 struct mlx5_devx_virtio_q_couners_attr reset;
101 struct mlx5_vdpa_steer {
102 struct mlx5_devx_obj *rqt;
106 struct mlx5dv_flow_matcher *matcher;
107 struct mlx5_devx_obj *tir;
114 MLX5_VDPA_EVENT_MODE_DYNAMIC_TIMER,
115 MLX5_VDPA_EVENT_MODE_FIXED_TIMER,
116 MLX5_VDPA_EVENT_MODE_ONLY_INTERRUPT
119 struct mlx5_vdpa_priv {
120 TAILQ_ENTRY(mlx5_vdpa_priv) next;
122 pthread_mutex_t vq_config_lock;
123 uint64_t no_traffic_counter;
126 int event_core; /* Event thread cpu affinity core. */
128 uint32_t timer_delay_us;
129 uint32_t no_traffic_max;
130 uint8_t hw_latency_mode; /* Hardware CQ moderation mode. */
131 uint16_t hw_max_latency_us; /* Hardware CQ moderation period in usec. */
132 uint16_t hw_max_pending_comp; /* Hardware CQ moderation counter. */
133 struct rte_vdpa_device *vdev; /* vDPA device. */
134 int vid; /* vhost device id. */
135 struct ibv_context *ctx; /* Device context. */
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;
142 struct mlx5dv_devx_event_channel *eventc;
143 struct mlx5dv_devx_event_channel *err_chnl;
144 struct mlx5dv_devx_uar *uar;
145 struct rte_intr_handle err_intr_handle;
146 struct mlx5_devx_obj *td;
147 struct mlx5_devx_obj *tiss[16]; /* TIS list for each LAG port. */
149 uint8_t num_lag_ports;
150 uint8_t qp_ts_format;
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 * Setup error interrupt handler.
266 * The vdpa driver private structure.
269 * 0 on success, a negative errno value otherwise and rte_errno is set.
271 int mlx5_vdpa_err_event_setup(struct mlx5_vdpa_priv *priv);
274 * Unset error event handler.
277 * The vdpa driver private structure.
279 void mlx5_vdpa_err_event_unset(struct mlx5_vdpa_priv *priv);
282 * Release a virtq and all its related resources.
285 * The vdpa driver private structure.
287 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
290 * Create all the HW virtqs resources and all their related resources.
293 * The vdpa driver private structure.
296 * 0 on success, a negative errno value otherwise and rte_errno is set.
298 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
301 * Enable\Disable virtq..
304 * The vdpa driver private structure.
308 * Set to enable, otherwise disable.
311 * 0 on success, a negative value otherwise.
313 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_priv *priv, int index, int enable);
316 * Unset steering and release all its related resources- stop traffic.
319 * The vdpa driver private structure.
321 void mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
324 * Update steering according to the received queues status.
327 * The vdpa driver private structure.
330 * 0 on success, a negative value otherwise.
332 int mlx5_vdpa_steer_update(struct mlx5_vdpa_priv *priv);
335 * Setup steering and all its related resources to enable RSS traffic from the
336 * device to all the Rx host queues.
339 * The vdpa driver private structure.
342 * 0 on success, a negative value otherwise.
344 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
347 * Enable\Disable live migration logging.
350 * The vdpa driver private structure.
352 * Set for enable, unset for disable.
355 * 0 on success, a negative value otherwise.
357 int mlx5_vdpa_logging_enable(struct mlx5_vdpa_priv *priv, int enable);
360 * Set dirty bitmap logging to allow live migration.
363 * The vdpa driver private structure.
364 * @param[in] log_base
366 * @param[in] log_size
370 * 0 on success, a negative value otherwise.
372 int mlx5_vdpa_dirty_bitmap_set(struct mlx5_vdpa_priv *priv, uint64_t log_base,
376 * Log all virtqs information for live migration.
379 * The vdpa driver private structure.
381 * Set for enable, unset for disable.
384 * 0 on success, a negative value otherwise.
386 int mlx5_vdpa_lm_log(struct mlx5_vdpa_priv *priv);
389 * Modify virtq state to be ready or suspend.
392 * The vdpa driver private virtq structure.
394 * Set for ready, otherwise suspend.
397 * 0 on success, a negative value otherwise.
399 int mlx5_vdpa_virtq_modify(struct mlx5_vdpa_virtq *virtq, int state);
402 * Stop virtq before destroying it.
405 * The vdpa driver private structure.
410 * 0 on success, a negative value otherwise.
412 int mlx5_vdpa_virtq_stop(struct mlx5_vdpa_priv *priv, int index);
415 * Query virtq information.
418 * The vdpa driver private structure.
423 * 0 on success, a negative value otherwise.
425 int mlx5_vdpa_virtq_query(struct mlx5_vdpa_priv *priv, int index);
428 * Get virtq statistics.
431 * The vdpa driver private structure.
435 * The virtq statistics array to fill.
437 * The number of elements in @p stats array.
440 * A negative value on error, otherwise the number of entries filled in the
444 mlx5_vdpa_virtq_stats_get(struct mlx5_vdpa_priv *priv, int qid,
445 struct rte_vdpa_stat *stats, unsigned int n);
448 * Reset virtq statistics.
451 * The vdpa driver private structure.
456 * A negative value on error, otherwise 0.
459 mlx5_vdpa_virtq_stats_reset(struct mlx5_vdpa_priv *priv, int qid);
460 #endif /* RTE_PMD_MLX5_VDPA_H_ */