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_qp sw_qp;
60 struct mlx5_vdpa_query_mr {
61 SLIST_ENTRY(mlx5_vdpa_query_mr) next;
64 struct mlx5dv_devx_umem *umem;
65 struct mlx5_devx_obj *mkey;
70 MLX5_VDPA_NOTIFIER_STATE_DISABLED,
71 MLX5_VDPA_NOTIFIER_STATE_ENABLED,
72 MLX5_VDPA_NOTIFIER_STATE_ERR
75 struct mlx5_vdpa_virtq {
76 SLIST_ENTRY(mlx5_vdpa_virtq) next;
80 uint8_t notifier_state;
83 struct mlx5_vdpa_priv *priv;
84 struct mlx5_devx_obj *virtq;
85 struct mlx5_devx_obj *counters;
86 struct mlx5_vdpa_event_qp eqp;
88 struct mlx5dv_devx_umem *obj;
92 struct rte_intr_handle intr_handle;
93 uint64_t err_time[3]; /* RDTSC time of recent errors. */
95 struct mlx5_devx_virtio_q_couners_attr reset;
98 struct mlx5_vdpa_steer {
99 struct mlx5_devx_obj *rqt;
103 struct mlx5dv_flow_matcher *matcher;
104 struct mlx5_devx_obj *tir;
111 MLX5_VDPA_EVENT_MODE_DYNAMIC_TIMER,
112 MLX5_VDPA_EVENT_MODE_FIXED_TIMER,
113 MLX5_VDPA_EVENT_MODE_ONLY_INTERRUPT
116 struct mlx5_vdpa_priv {
117 TAILQ_ENTRY(mlx5_vdpa_priv) next;
119 pthread_mutex_t vq_config_lock;
120 uint64_t no_traffic_counter;
123 int event_core; /* Event thread cpu affinity core. */
125 uint32_t timer_delay_us;
126 uint32_t no_traffic_max;
127 uint8_t hw_latency_mode; /* Hardware CQ moderation mode. */
128 uint16_t hw_max_latency_us; /* Hardware CQ moderation period in usec. */
129 uint16_t hw_max_pending_comp; /* Hardware CQ moderation counter. */
130 struct rte_vdpa_device *vdev; /* vDPA device. */
131 int vid; /* vhost device id. */
132 struct ibv_context *ctx; /* Device context. */
133 struct mlx5_hca_vdpa_attr caps;
134 uint32_t pdn; /* Protection Domain number. */
136 uint32_t gpa_mkey_index;
137 struct ibv_mr *null_mr;
138 struct rte_vhost_memory *vmem;
139 struct mlx5dv_devx_event_channel *eventc;
140 struct mlx5dv_devx_event_channel *err_chnl;
141 struct mlx5dv_devx_uar *uar;
142 struct rte_intr_handle err_intr_handle;
143 struct mlx5_devx_obj *td;
144 struct mlx5_devx_obj *tiss[16]; /* TIS list for each LAG port. */
146 uint8_t num_lag_ports;
147 uint8_t qp_ts_format;
148 uint64_t features; /* Negotiated features. */
149 uint16_t log_max_rqt_size;
150 struct mlx5_vdpa_steer steer;
151 struct mlx5dv_var *var;
153 SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
154 struct mlx5_vdpa_virtq virtqs[];
158 MLX5_VDPA_STATS_RECEIVED_DESCRIPTORS,
159 MLX5_VDPA_STATS_COMPLETED_DESCRIPTORS,
160 MLX5_VDPA_STATS_BAD_DESCRIPTOR_ERRORS,
161 MLX5_VDPA_STATS_EXCEED_MAX_CHAIN,
162 MLX5_VDPA_STATS_INVALID_BUFFER,
163 MLX5_VDPA_STATS_COMPLETION_ERRORS,
168 * Check whether virtq is for traffic receive.
169 * According to VIRTIO_NET Spec the virtqueues index identity its type by:
174 * 2(N-1)+1 transmitqN
177 static inline uint8_t
178 is_virtq_recvq(int virtq_index, int nr_vring)
180 if (virtq_index % 2 == 0 && virtq_index != nr_vring - 1)
186 * Release all the prepared memory regions and all their related resources.
189 * The vdpa driver private structure.
191 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
194 * Register all the memory regions of the virtio device to the HW and allocate
195 * all their related resources.
198 * The vdpa driver private structure.
201 * 0 on success, a negative errno value otherwise and rte_errno is set.
203 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
207 * Create an event QP and all its related resources.
210 * The vdpa driver private structure.
212 * Number of descriptors.
214 * The guest notification file descriptor.
216 * Pointer to the event QP structure.
219 * 0 on success, -1 otherwise and rte_errno is set.
221 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
222 int callfd, struct mlx5_vdpa_event_qp *eqp);
225 * Destroy an event QP and all its related resources.
228 * Pointer to the event QP structure.
230 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
233 * Release all the event global resources.
236 * The vdpa driver private structure.
238 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
244 * The vdpa driver private structure.
247 * 0 on success, a negative errno value otherwise and rte_errno is set.
249 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
255 * The vdpa driver private structure.
257 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
260 * Setup error interrupt handler.
263 * The vdpa driver private structure.
266 * 0 on success, a negative errno value otherwise and rte_errno is set.
268 int mlx5_vdpa_err_event_setup(struct mlx5_vdpa_priv *priv);
271 * Unset error event handler.
274 * The vdpa driver private structure.
276 void mlx5_vdpa_err_event_unset(struct mlx5_vdpa_priv *priv);
279 * Release a virtq and all its related resources.
282 * The vdpa driver private structure.
284 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
287 * Create all the HW virtqs resources and all their related resources.
290 * The vdpa driver private structure.
293 * 0 on success, a negative errno value otherwise and rte_errno is set.
295 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
298 * Enable\Disable virtq..
301 * The vdpa driver private structure.
305 * Set to enable, otherwise disable.
308 * 0 on success, a negative value otherwise.
310 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_priv *priv, int index, int enable);
313 * Unset steering and release all its related resources- stop traffic.
316 * The vdpa driver private structure.
318 void mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
321 * Update steering according to the received queues status.
324 * The vdpa driver private structure.
327 * 0 on success, a negative value otherwise.
329 int mlx5_vdpa_steer_update(struct mlx5_vdpa_priv *priv);
332 * Setup steering and all its related resources to enable RSS traffic from the
333 * device to all the Rx host queues.
336 * The vdpa driver private structure.
339 * 0 on success, a negative value otherwise.
341 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
344 * Enable\Disable live migration logging.
347 * The vdpa driver private structure.
349 * Set for enable, unset for disable.
352 * 0 on success, a negative value otherwise.
354 int mlx5_vdpa_logging_enable(struct mlx5_vdpa_priv *priv, int enable);
357 * Set dirty bitmap logging to allow live migration.
360 * The vdpa driver private structure.
361 * @param[in] log_base
363 * @param[in] log_size
367 * 0 on success, a negative value otherwise.
369 int mlx5_vdpa_dirty_bitmap_set(struct mlx5_vdpa_priv *priv, uint64_t log_base,
373 * Log all virtqs information for live migration.
376 * The vdpa driver private structure.
378 * Set for enable, unset for disable.
381 * 0 on success, a negative value otherwise.
383 int mlx5_vdpa_lm_log(struct mlx5_vdpa_priv *priv);
386 * Modify virtq state to be ready or suspend.
389 * The vdpa driver private virtq structure.
391 * Set for ready, otherwise suspend.
394 * 0 on success, a negative value otherwise.
396 int mlx5_vdpa_virtq_modify(struct mlx5_vdpa_virtq *virtq, int state);
399 * Stop virtq before destroying it.
402 * The vdpa driver private structure.
407 * 0 on success, a negative value otherwise.
409 int mlx5_vdpa_virtq_stop(struct mlx5_vdpa_priv *priv, int index);
412 * Query virtq information.
415 * The vdpa driver private structure.
420 * 0 on success, a negative value otherwise.
422 int mlx5_vdpa_virtq_query(struct mlx5_vdpa_priv *priv, int index);
425 * Get virtq statistics.
428 * The vdpa driver private structure.
432 * The virtq statistics array to fill.
434 * The number of elements in @p stats array.
437 * A negative value on error, otherwise the number of entries filled in the
441 mlx5_vdpa_virtq_stats_get(struct mlx5_vdpa_priv *priv, int qid,
442 struct rte_vdpa_stat *stats, unsigned int n);
445 * Reset virtq statistics.
448 * The vdpa driver private structure.
453 * A negative value on error, otherwise 0.
456 mlx5_vdpa_virtq_stats_reset(struct mlx5_vdpa_priv *priv, int qid);
457 #endif /* RTE_PMD_MLX5_VDPA_H_ */