drivers/vdpa/mlx5/mlx5_vdpa.h

   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 <rte_vhost.h>
  16 #ifdef PEDANTIC
  17 #pragma GCC diagnostic error "-Wpedantic"
  18 #endif
  19 #include <rte_spinlock.h>
  20 #include <rte_interrupts.h>
  21
  22 #include <mlx5_glue.h>
  23 #include <mlx5_devx_cmds.h>
  24 #include <mlx5_prm.h>
  25
  26
  27 #define MLX5_VDPA_INTR_RETRIES 256
  28 #define MLX5_VDPA_INTR_RETRIES_USEC 1000
  29
  30 #ifndef VIRTIO_F_ORDER_PLATFORM
  31 #define VIRTIO_F_ORDER_PLATFORM 36
  32 #endif
  33
  34 #ifndef VIRTIO_F_RING_PACKED
  35 #define VIRTIO_F_RING_PACKED 34
  36 #endif
  37
  38 struct mlx5_vdpa_cq {
  39         uint16_t log_desc_n;
  40         uint32_t cq_ci:24;
  41         uint32_t arm_sn:2;
  42         int callfd;
  43         rte_spinlock_t sl;
  44         struct mlx5_devx_obj *cq;
  45         struct mlx5dv_devx_umem *umem_obj;
  46         union {
  47                 volatile void *umem_buf;
  48                 volatile struct mlx5_cqe *cqes;
  49         };
  50         volatile uint32_t *db_rec;
  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_obj *sw_qp;
  58         struct mlx5dv_devx_umem *umem_obj;
  59         void *umem_buf;
  60         volatile uint32_t *db_rec;
  61 };
  62
  63 struct mlx5_vdpa_query_mr {
  64         SLIST_ENTRY(mlx5_vdpa_query_mr) next;
  65         void *addr;
  66         uint64_t length;
  67         struct mlx5dv_devx_umem *umem;
  68         struct mlx5_devx_obj *mkey;
  69         int is_indirect;
  70 };
  71
  72 struct mlx5_vdpa_virtq {
  73         SLIST_ENTRY(mlx5_vdpa_virtq) next;
  74         uint8_t enable;
  75         uint16_t index;
  76         uint16_t vq_size;
  77         struct mlx5_vdpa_priv *priv;
  78         struct mlx5_devx_obj *virtq;
  79         struct mlx5_devx_obj *counters;
  80         struct mlx5_vdpa_event_qp eqp;
  81         struct {
  82                 struct mlx5dv_devx_umem *obj;
  83                 void *buf;
  84                 uint32_t size;
  85         } umems[3];
  86         struct rte_intr_handle intr_handle;
  87         struct mlx5_devx_virtio_q_couners_attr reset;
  88 };
  89
  90 struct mlx5_vdpa_steer {
  91         struct mlx5_devx_obj *rqt;
  92         void *domain;
  93         void *tbl;
  94         struct {
  95                 struct mlx5dv_flow_matcher *matcher;
  96                 struct mlx5_devx_obj *tir;
  97                 void *tir_action;
  98                 void *flow;
  99         } rss[7];
 100 };
 101
 102 struct mlx5_vdpa_priv {
 103         TAILQ_ENTRY(mlx5_vdpa_priv) next;
 104         uint8_t configured;
 105         uint8_t direct_notifier; /* Whether direct notifier is on or off. */
 106         int id; /* vDPA device id. */
 107         int vid; /* vhost device id. */
 108         struct ibv_context *ctx; /* Device context. */
 109         struct rte_pci_device *pci_dev;
 110         struct mlx5_hca_vdpa_attr caps;
 111         uint32_t pdn; /* Protection Domain number. */
 112         struct ibv_pd *pd;
 113         uint32_t gpa_mkey_index;
 114         struct ibv_mr *null_mr;
 115         struct rte_vhost_memory *vmem;
 116         uint32_t eqn;
 117         struct mlx5dv_devx_event_channel *eventc;
 118         struct mlx5dv_devx_uar *uar;
 119         struct rte_intr_handle intr_handle;
 120         struct mlx5_devx_obj *td;
 121         struct mlx5_devx_obj *tis;
 122         uint16_t nr_virtqs;
 123         uint64_t features; /* Negotiated features. */
 124         uint16_t log_max_rqt_size;
 125         struct mlx5_vdpa_steer steer;
 126         struct mlx5dv_var *var;
 127         void *virtq_db_addr;
 128         SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
 129         struct mlx5_vdpa_virtq virtqs[];
 130 };
 131
 132 enum {
 133         MLX5_VDPA_STATS_RECEIVED_DESCRIPTORS,
 134         MLX5_VDPA_STATS_COMPLETED_DESCRIPTORS,
 135         MLX5_VDPA_STATS_BAD_DESCRIPTOR_ERRORS,
 136         MLX5_VDPA_STATS_EXCEED_MAX_CHAIN,
 137         MLX5_VDPA_STATS_INVALID_BUFFER,
 138         MLX5_VDPA_STATS_COMPLETION_ERRORS,
 139         MLX5_VDPA_STATS_MAX
 140 };
 141
 142 /*
 143  * Check whether virtq is for traffic receive.
 144  * According to VIRTIO_NET Spec the virtqueues index identity its type by:
 145  * 0 receiveq1
 146  * 1 transmitq1
 147  * ...
 148  * 2(N-1) receiveqN
 149  * 2(N-1)+1 transmitqN
 150  * 2N controlq
 151  */
 152 static inline uint8_t
 153 is_virtq_recvq(int virtq_index, int nr_vring)
 154 {
 155         if (virtq_index % 2 == 0 && virtq_index != nr_vring - 1)
 156                 return 1;
 157         return 0;
 158 }
 159
 160 /**
 161  * Release all the prepared memory regions and all their related resources.
 162  *
 163  * @param[in] priv
 164  *   The vdpa driver private structure.
 165  */
 166 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
 167
 168 /**
 169  * Register all the memory regions of the virtio device to the HW and allocate
 170  * all their related resources.
 171  *
 172  * @param[in] priv
 173  *   The vdpa driver private structure.
 174  *
 175  * @return
 176  *   0 on success, a negative errno value otherwise and rte_errno is set.
 177  */
 178 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
 179
 180
 181 /**
 182  * Create an event QP and all its related resources.
 183  *
 184  * @param[in] priv
 185  *   The vdpa driver private structure.
 186  * @param[in] desc_n
 187  *   Number of descriptors.
 188  * @param[in] callfd
 189  *   The guest notification file descriptor.
 190  * @param[in/out] eqp
 191  *   Pointer to the event QP structure.
 192  *
 193  * @return
 194  *   0 on success, -1 otherwise and rte_errno is set.
 195  */
 196 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
 197                               int callfd, struct mlx5_vdpa_event_qp *eqp);
 198
 199 /**
 200  * Destroy an event QP and all its related resources.
 201  *
 202  * @param[in/out] eqp
 203  *   Pointer to the event QP structure.
 204  */
 205 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
 206
 207 /**
 208  * Release all the event global resources.
 209  *
 210  * @param[in] priv
 211  *   The vdpa driver private structure.
 212  */
 213 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
 214
 215 /**
 216  * Setup CQE event.
 217  *
 218  * @param[in] priv
 219  *   The vdpa driver private structure.
 220  *
 221  * @return
 222  *   0 on success, a negative errno value otherwise and rte_errno is set.
 223  */
 224 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
 225
 226 /**
 227  * Unset CQE event .
 228  *
 229  * @param[in] priv
 230  *   The vdpa driver private structure.
 231  */
 232 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
 233
 234 /**
 235  * Release a virtq and all its related resources.
 236  *
 237  * @param[in] priv
 238  *   The vdpa driver private structure.
 239  */
 240 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
 241
 242 /**
 243  * Create all the HW virtqs resources and all their related resources.
 244  *
 245  * @param[in] priv
 246  *   The vdpa driver private structure.
 247  *
 248  * @return
 249  *   0 on success, a negative errno value otherwise and rte_errno is set.
 250  */
 251 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
 252
 253 /**
 254  * Enable\Disable virtq..
 255  *
 256  * @param[in] priv
 257  *   The vdpa driver private structure.
 258  * @param[in] index
 259  *   The virtq index.
 260  * @param[in] enable
 261  *   Set to enable, otherwise disable.
 262  *
 263  * @return
 264  *   0 on success, a negative value otherwise.
 265  */
 266 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_priv *priv, int index, int enable);
 267
 268 /**
 269  * Unset steering and release all its related resources- stop traffic.
 270  *
 271  * @param[in] priv
 272  *   The vdpa driver private structure.
 273  */
 274 void mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
 275
 276 /**
 277  * Update steering according to the received queues status.
 278  *
 279  * @param[in] priv
 280  *   The vdpa driver private structure.
 281  *
 282  * @return
 283  *   0 on success, a negative value otherwise.
 284  */
 285 int mlx5_vdpa_steer_update(struct mlx5_vdpa_priv *priv);
 286
 287 /**
 288  * Setup steering and all its related resources to enable RSS traffic from the
 289  * device to all the Rx host queues.
 290  *
 291  * @param[in] priv
 292  *   The vdpa driver private structure.
 293  *
 294  * @return
 295  *   0 on success, a negative value otherwise.
 296  */
 297 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
 298
 299 /**
 300  * Enable\Disable live migration logging.
 301  *
 302  * @param[in] priv
 303  *   The vdpa driver private structure.
 304  * @param[in] enable
 305  *   Set for enable, unset for disable.
 306  *
 307  * @return
 308  *   0 on success, a negative value otherwise.
 309  */
 310 int mlx5_vdpa_logging_enable(struct mlx5_vdpa_priv *priv, int enable);
 311
 312 /**
 313  * Set dirty bitmap logging to allow live migration.
 314  *
 315  * @param[in] priv
 316  *   The vdpa driver private structure.
 317  * @param[in] log_base
 318  *   Vhost log base.
 319  * @param[in] log_size
 320  *   Vhost log size.
 321  *
 322  * @return
 323  *   0 on success, a negative value otherwise.
 324  */
 325 int mlx5_vdpa_dirty_bitmap_set(struct mlx5_vdpa_priv *priv, uint64_t log_base,
 326                                uint64_t log_size);
 327
 328 /**
 329  * Log all virtqs information for live migration.
 330  *
 331  * @param[in] priv
 332  *   The vdpa driver private structure.
 333  * @param[in] enable
 334  *   Set for enable, unset for disable.
 335  *
 336  * @return
 337  *   0 on success, a negative value otherwise.
 338  */
 339 int mlx5_vdpa_lm_log(struct mlx5_vdpa_priv *priv);
 340
 341 /**
 342  * Modify virtq state to be ready or suspend.
 343  *
 344  * @param[in] virtq
 345  *   The vdpa driver private virtq structure.
 346  * @param[in] state
 347  *   Set for ready, otherwise suspend.
 348  *
 349  * @return
 350  *   0 on success, a negative value otherwise.
 351  */
 352 int mlx5_vdpa_virtq_modify(struct mlx5_vdpa_virtq *virtq, int state);
 353
 354 /**
 355  * Stop virtq before destroying it.
 356  *
 357  * @param[in] priv
 358  *   The vdpa driver private structure.
 359  * @param[in] index
 360  *   The virtq index.
 361  *
 362  * @return
 363  *   0 on success, a negative value otherwise.
 364  */
 365 int mlx5_vdpa_virtq_stop(struct mlx5_vdpa_priv *priv, int index);
 366
 367 /**
 368  * Get virtq statistics.
 369  *
 370  * @param[in] priv
 371  *   The vdpa driver private structure.
 372  * @param[in] qid
 373  *   The virtq index.
 374  * @param stats
 375  *   The virtq statistics array to fill.
 376  * @param n
 377  *   The number of elements in @p stats array.
 378  *
 379  * @return
 380  *   A negative value on error, otherwise the number of entries filled in the
 381  *   @p stats array.
 382  */
 383 int
 384 mlx5_vdpa_virtq_stats_get(struct mlx5_vdpa_priv *priv, int qid,
 385                           struct rte_vdpa_stat *stats, unsigned int n);
 386
 387 /**
 388  * Reset virtq statistics.
 389  *
 390  * @param[in] priv
 391  *   The vdpa driver private structure.
 392  * @param[in] qid
 393  *   The virtq index.
 394  *
 395  * @return
 396  *   A negative value on error, otherwise 0.
 397  */
 398 int
 399 mlx5_vdpa_virtq_stats_reset(struct mlx5_vdpa_priv *priv, int qid);
 400 #endif /* RTE_PMD_MLX5_VDPA_H_ */