1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2019 Mellanox Technologies, Ltd
3 */
4
5 #ifndef RTE_PMD_MLX5_VDPA_H_
6 #define RTE_PMD_MLX5_VDPA_H_
7
8 #include <linux/virtio_net.h>
9 #include <sys/queue.h>
10
11 #ifdef PEDANTIC
12 #pragma GCC diagnostic ignored "-Wpedantic"
13 #endif
14 #include <rte_vdpa.h>
15 #include <vdpa_driver.h>
16 #include <rte_vhost.h>
17 #ifdef PEDANTIC
18 #pragma GCC diagnostic error "-Wpedantic"
19 #endif
20 #include <rte_spinlock.h>
21 #include <rte_interrupts.h>
22
23 #include <mlx5_glue.h>
24 #include <mlx5_devx_cmds.h>
25 #include <mlx5_common_devx.h>
26 #include <mlx5_prm.h>
27
28
29 #define MLX5_VDPA_INTR_RETRIES 256
30 #define MLX5_VDPA_INTR_RETRIES_USEC 1000
31
32 #ifndef VIRTIO_F_ORDER_PLATFORM
33 #define VIRTIO_F_ORDER_PLATFORM 36
34 #endif
35
36 #ifndef VIRTIO_F_RING_PACKED
37 #define VIRTIO_F_RING_PACKED 34
38 #endif
39
40 #define MLX5_VDPA_DEFAULT_TIMER_DELAY_US 0u
41 #define MLX5_VDPA_DEFAULT_TIMER_STEP_US 1u
42
43 struct mlx5_vdpa_cq {
44 uint16_t log_desc_n;
45 uint32_t cq_ci:24;
46 uint32_t arm_sn:2;
47 uint32_t armed:1;
48 int callfd;
49 rte_spinlock_t sl;
50 struct mlx5_devx_cq cq_obj;
51 uint64_t errors;
52 };
53
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;
58 };
59
60 struct mlx5_vdpa_query_mr {
61 SLIST_ENTRY(mlx5_vdpa_query_mr) next;
62 union {
63 struct ibv_mr *mr;
64 struct mlx5_devx_obj *mkey;
65 };
66 int is_indirect;
67 };
68
69 enum {
70 MLX5_VDPA_NOTIFIER_STATE_DISABLED,
71 MLX5_VDPA_NOTIFIER_STATE_ENABLED,
72 MLX5_VDPA_NOTIFIER_STATE_ERR
73 };
74
75 struct mlx5_vdpa_virtq {
76 SLIST_ENTRY(mlx5_vdpa_virtq) next;
77 uint8_t enable;
78 uint16_t index;
79 uint16_t vq_size;
80 uint8_t notifier_state;
81 bool stopped;
82 uint32_t version;
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;
87 struct {
88 struct mlx5dv_devx_umem *obj;
89 void *buf;
90 uint32_t size;
91 } umems[3];
92 struct rte_intr_handle *intr_handle;
93 uint64_t err_time[3]; /* RDTSC time of recent errors. */
94 uint32_t n_retry;
95 struct mlx5_devx_virtio_q_couners_attr stats;
96 struct mlx5_devx_virtio_q_couners_attr reset;
97 };
98
99 struct mlx5_vdpa_steer {
100 struct mlx5_devx_obj *rqt;
101 void *domain;
102 void *tbl;
103 struct {
104 struct mlx5dv_flow_matcher *matcher;
105 struct mlx5_devx_obj *tir;
106 void *tir_action;
107 void *flow;
108 } rss[7];
109 };
110
111 enum {
112 MLX5_VDPA_EVENT_MODE_DYNAMIC_TIMER,
113 MLX5_VDPA_EVENT_MODE_FIXED_TIMER,
114 MLX5_VDPA_EVENT_MODE_ONLY_INTERRUPT
115 };
116
117 enum mlx5_dev_state {
118 MLX5_VDPA_STATE_PROBED = 0,
119 MLX5_VDPA_STATE_CONFIGURED,
120 MLX5_VDPA_STATE_IN_PROGRESS /* Shutting down. */
121 };
122
123 struct mlx5_vdpa_priv {
124 TAILQ_ENTRY(mlx5_vdpa_priv) next;
125 bool connected;
126 enum mlx5_dev_state state;
127 pthread_mutex_t vq_config_lock;
128 uint64_t no_traffic_counter;
129 pthread_t timer_tid;
130 int event_mode;
131 int event_core; /* Event thread cpu affinity core. */
132 uint32_t event_us;
133 uint32_t timer_delay_us;
134 uint32_t no_traffic_max;
135 uint8_t hw_latency_mode; /* Hardware CQ moderation mode. */
136 uint16_t hw_max_latency_us; /* Hardware CQ moderation period in usec. */
137 uint16_t hw_max_pending_comp; /* Hardware CQ moderation counter. */
138 struct rte_vdpa_device *vdev; /* vDPA device. */
139 struct mlx5_common_device *cdev; /* Backend mlx5 device. */
140 int vid; /* vhost device id. */
141 struct mlx5_hca_vdpa_attr caps;
142 uint32_t gpa_mkey_index;
143 struct ibv_mr *null_mr;
144 struct rte_vhost_memory *vmem;
145 struct mlx5dv_devx_event_channel *eventc;
146 struct mlx5dv_devx_event_channel *err_chnl;
147 struct mlx5_uar uar;
148 struct rte_intr_handle *err_intr_handle;
149 struct mlx5_devx_obj *td;
150 struct mlx5_devx_obj *tiss[16]; /* TIS list for each LAG port. */
151 uint16_t nr_virtqs;
152 uint8_t num_lag_ports;
153 uint64_t features; /* Negotiated features. */
154 uint16_t log_max_rqt_size;
155 struct mlx5_vdpa_steer steer;
156 struct mlx5dv_var *var;
157 void *virtq_db_addr;
158 struct mlx5_pmd_wrapped_mr lm_mr;
159 SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
160 struct mlx5_vdpa_virtq virtqs[];
161 };
162
163 enum {
164 MLX5_VDPA_STATS_RECEIVED_DESCRIPTORS,
165 MLX5_VDPA_STATS_COMPLETED_DESCRIPTORS,
166 MLX5_VDPA_STATS_BAD_DESCRIPTOR_ERRORS,
167 MLX5_VDPA_STATS_EXCEED_MAX_CHAIN,
168 MLX5_VDPA_STATS_INVALID_BUFFER,
169 MLX5_VDPA_STATS_COMPLETION_ERRORS,
170 MLX5_VDPA_STATS_MAX
171 };
172
173 /*
174 * Check whether virtq is for traffic receive.
175 * According to VIRTIO_NET Spec the virtqueues index identity its type by:
176 * 0 receiveq1
177 * 1 transmitq1
178 * ...
179 * 2(N-1) receiveqN
180 * 2(N-1)+1 transmitqN
181 * 2N controlq
182 */
183 static inline uint8_t
is_virtq_recvq(int virtq_index,int nr_vring)184 is_virtq_recvq(int virtq_index, int nr_vring)
185 {
186 if (virtq_index % 2 == 0 && virtq_index != nr_vring - 1)
187 return 1;
188 return 0;
189 }
190
191 /**
192 * Release all the prepared memory regions and all their related resources.
193 *
194 * @param[in] priv
195 * The vdpa driver private structure.
196 */
197 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
198
199 /**
200 * Register all the memory regions of the virtio device to the HW and allocate
201 * all their related resources.
202 *
203 * @param[in] priv
204 * The vdpa driver private structure.
205 *
206 * @return
207 * 0 on success, a negative errno value otherwise and rte_errno is set.
208 */
209 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
210
211
212 /**
213 * Create an event QP and all its related resources.
214 *
215 * @param[in] priv
216 * The vdpa driver private structure.
217 * @param[in] desc_n
218 * Number of descriptors.
219 * @param[in] callfd
220 * The guest notification file descriptor.
221 * @param[in/out] eqp
222 * Pointer to the event QP structure.
223 *
224 * @return
225 * 0 on success, -1 otherwise and rte_errno is set.
226 */
227 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
228 int callfd, struct mlx5_vdpa_event_qp *eqp);
229
230 /**
231 * Destroy an event QP and all its related resources.
232 *
233 * @param[in/out] eqp
234 * Pointer to the event QP structure.
235 */
236 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
237
238 /**
239 * Create all the event global resources.
240 *
241 * @param[in] priv
242 * The vdpa driver private structure.
243 */
244 int
245 mlx5_vdpa_event_qp_global_prepare(struct mlx5_vdpa_priv *priv);
246
247 /**
248 * Release all the event global resources.
249 *
250 * @param[in] priv
251 * The vdpa driver private structure.
252 */
253 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
254
255 /**
256 * Setup CQE event.
257 *
258 * @param[in] priv
259 * The vdpa driver private structure.
260 *
261 * @return
262 * 0 on success, a negative errno value otherwise and rte_errno is set.
263 */
264 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
265
266 /**
267 * Unset CQE event .
268 *
269 * @param[in] priv
270 * The vdpa driver private structure.
271 */
272 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
273
274 /**
275 * Setup error interrupt handler.
276 *
277 * @param[in] priv
278 * The vdpa driver private structure.
279 *
280 * @return
281 * 0 on success, a negative errno value otherwise and rte_errno is set.
282 */
283 int mlx5_vdpa_err_event_setup(struct mlx5_vdpa_priv *priv);
284
285 /**
286 * Unset error event handler.
287 *
288 * @param[in] priv
289 * The vdpa driver private structure.
290 */
291 void mlx5_vdpa_err_event_unset(struct mlx5_vdpa_priv *priv);
292
293 /**
294 * Release virtqs and resources except that to be reused.
295 *
296 * @param[in] priv
297 * The vdpa driver private structure.
298 */
299 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
300
301 /**
302 * Cleanup cached resources of all virtqs.
303 *
304 * @param[in] priv
305 * The vdpa driver private structure.
306 */
307 void mlx5_vdpa_virtqs_cleanup(struct mlx5_vdpa_priv *priv);
308
309 /**
310 * Create all the HW virtqs resources and all their related resources.
311 *
312 * @param[in] priv
313 * The vdpa driver private structure.
314 *
315 * @return
316 * 0 on success, a negative errno value otherwise and rte_errno is set.
317 */
318 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
319
320 /**
321 * Enable\Disable virtq..
322 *
323 * @param[in] priv
324 * The vdpa driver private structure.
325 * @param[in] index
326 * The virtq index.
327 * @param[in] enable
328 * Set to enable, otherwise disable.
329 *
330 * @return
331 * 0 on success, a negative value otherwise.
332 */
333 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_priv *priv, int index, int enable);
334
335 /**
336 * Unset steering - stop traffic.
337 *
338 * @param[in] priv
339 * The vdpa driver private structure.
340 */
341 void mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
342
343 /**
344 * Update steering according to the received queues status.
345 *
346 * @param[in] priv
347 * The vdpa driver private structure.
348 *
349 * @return
350 * 0 on success, a negative value otherwise.
351 */
352 int mlx5_vdpa_steer_update(struct mlx5_vdpa_priv *priv);
353
354 /**
355 * Setup steering and all its related resources to enable RSS traffic from the
356 * device to all the Rx host queues.
357 *
358 * @param[in] priv
359 * The vdpa driver private structure.
360 *
361 * @return
362 * 0 on success, a negative value otherwise.
363 */
364 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
365
366 /**
367 * Enable\Disable live migration logging.
368 *
369 * @param[in] priv
370 * The vdpa driver private structure.
371 * @param[in] enable
372 * Set for enable, unset for disable.
373 *
374 * @return
375 * 0 on success, a negative value otherwise.
376 */
377 int mlx5_vdpa_logging_enable(struct mlx5_vdpa_priv *priv, int enable);
378
379 /**
380 * Set dirty bitmap logging to allow live migration.
381 *
382 * @param[in] priv
383 * The vdpa driver private structure.
384 * @param[in] log_base
385 * Vhost log base.
386 * @param[in] log_size
387 * Vhost log size.
388 *
389 * @return
390 * 0 on success, a negative value otherwise.
391 */
392 int mlx5_vdpa_dirty_bitmap_set(struct mlx5_vdpa_priv *priv, uint64_t log_base,
393 uint64_t log_size);
394
395 /**
396 * Log all virtqs information for live migration.
397 *
398 * @param[in] priv
399 * The vdpa driver private structure.
400 * @param[in] enable
401 * Set for enable, unset for disable.
402 *
403 * @return
404 * 0 on success, a negative value otherwise.
405 */
406 int mlx5_vdpa_lm_log(struct mlx5_vdpa_priv *priv);
407
408 /**
409 * Modify virtq state to be ready or suspend.
410 *
411 * @param[in] virtq
412 * The vdpa driver private virtq structure.
413 * @param[in] state
414 * Set for ready, otherwise suspend.
415 *
416 * @return
417 * 0 on success, a negative value otherwise.
418 */
419 int mlx5_vdpa_virtq_modify(struct mlx5_vdpa_virtq *virtq, int state);
420
421 /**
422 * Stop virtq before destroying it.
423 *
424 * @param[in] priv
425 * The vdpa driver private structure.
426 * @param[in] index
427 * The virtq index.
428 *
429 * @return
430 * 0 on success, a negative value otherwise.
431 */
432 int mlx5_vdpa_virtq_stop(struct mlx5_vdpa_priv *priv, int index);
433
434 /**
435 * Query virtq information.
436 *
437 * @param[in] priv
438 * The vdpa driver private structure.
439 * @param[in] index
440 * The virtq index.
441 *
442 * @return
443 * 0 on success, a negative value otherwise.
444 */
445 int mlx5_vdpa_virtq_query(struct mlx5_vdpa_priv *priv, int index);
446
447 /**
448 * Get virtq statistics.
449 *
450 * @param[in] priv
451 * The vdpa driver private structure.
452 * @param[in] qid
453 * The virtq index.
454 * @param stats
455 * The virtq statistics array to fill.
456 * @param n
457 * The number of elements in @p stats array.
458 *
459 * @return
460 * A negative value on error, otherwise the number of entries filled in the
461 * @p stats array.
462 */
463 int
464 mlx5_vdpa_virtq_stats_get(struct mlx5_vdpa_priv *priv, int qid,
465 struct rte_vdpa_stat *stats, unsigned int n);
466
467 /**
468 * Reset virtq statistics.
469 *
470 * @param[in] priv
471 * The vdpa driver private structure.
472 * @param[in] qid
473 * The virtq index.
474 *
475 * @return
476 * A negative value on error, otherwise 0.
477 */
478 int
479 mlx5_vdpa_virtq_stats_reset(struct mlx5_vdpa_priv *priv, int qid);
480 #endif /* RTE_PMD_MLX5_VDPA_H_ */
481