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_vdpa_event_qp eqp;
  80         struct {
  81                 struct mlx5dv_devx_umem *obj;
  82                 void *buf;
  83                 uint32_t size;
  84         } umems[3];
  85         struct rte_intr_handle intr_handle;
  86 };
  87
  88 struct mlx5_vdpa_steer {
  89         struct mlx5_devx_obj *rqt;
  90         void *domain;
  91         void *tbl;
  92         struct {
  93                 struct mlx5dv_flow_matcher *matcher;
  94                 struct mlx5_devx_obj *tir;
  95                 void *tir_action;
  96                 void *flow;
  97         } rss[7];
  98 };
  99
 100 struct mlx5_vdpa_priv {
 101         TAILQ_ENTRY(mlx5_vdpa_priv) next;
 102         uint8_t configured;
 103         int id; /* vDPA device id. */
 104         int vid; /* vhost device id. */
 105         struct ibv_context *ctx; /* Device context. */
 106         struct rte_vdpa_dev_addr dev_addr;
 107         struct mlx5_hca_vdpa_attr caps;
 108         uint32_t pdn; /* Protection Domain number. */
 109         struct ibv_pd *pd;
 110         uint32_t gpa_mkey_index;
 111         struct ibv_mr *null_mr;
 112         struct rte_vhost_memory *vmem;
 113         uint32_t eqn;
 114         struct mlx5dv_devx_event_channel *eventc;
 115         struct mlx5dv_devx_uar *uar;
 116         struct rte_intr_handle intr_handle;
 117         struct mlx5_devx_obj *td;
 118         struct mlx5_devx_obj *tis;
 119         uint16_t nr_virtqs;
 120         uint64_t features; /* Negotiated features. */
 121         uint16_t log_max_rqt_size;
 122         SLIST_HEAD(virtq_list, mlx5_vdpa_virtq) virtq_list;
 123         struct mlx5_vdpa_steer steer;
 124         struct mlx5dv_var *var;
 125         void *virtq_db_addr;
 126         SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
 127 };
 128
 129 /**
 130  * Release all the prepared memory regions and all their related resources.
 131  *
 132  * @param[in] priv
 133  *   The vdpa driver private structure.
 134  */
 135 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
 136
 137 /**
 138  * Register all the memory regions of the virtio device to the HW and allocate
 139  * all their related resources.
 140  *
 141  * @param[in] priv
 142  *   The vdpa driver private structure.
 143  *
 144  * @return
 145  *   0 on success, a negative errno value otherwise and rte_errno is set.
 146  */
 147 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
 148
 149
 150 /**
 151  * Create an event QP and all its related resources.
 152  *
 153  * @param[in] priv
 154  *   The vdpa driver private structure.
 155  * @param[in] desc_n
 156  *   Number of descriptors.
 157  * @param[in] callfd
 158  *   The guest notification file descriptor.
 159  * @param[in/out] eqp
 160  *   Pointer to the event QP structure.
 161  *
 162  * @return
 163  *   0 on success, -1 otherwise and rte_errno is set.
 164  */
 165 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
 166                               int callfd, struct mlx5_vdpa_event_qp *eqp);
 167
 168 /**
 169  * Destroy an event QP and all its related resources.
 170  *
 171  * @param[in/out] eqp
 172  *   Pointer to the event QP structure.
 173  */
 174 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
 175
 176 /**
 177  * Release all the event global resources.
 178  *
 179  * @param[in] priv
 180  *   The vdpa driver private structure.
 181  */
 182 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
 183
 184 /**
 185  * Setup CQE event.
 186  *
 187  * @param[in] priv
 188  *   The vdpa driver private structure.
 189  *
 190  * @return
 191  *   0 on success, a negative errno value otherwise and rte_errno is set.
 192  */
 193 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
 194
 195 /**
 196  * Unset CQE event .
 197  *
 198  * @param[in] priv
 199  *   The vdpa driver private structure.
 200  */
 201 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
 202
 203 /**
 204  * Release a virtq and all its related resources.
 205  *
 206  * @param[in] priv
 207  *   The vdpa driver private structure.
 208  */
 209 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
 210
 211 /**
 212  * Create all the HW virtqs resources and all their related resources.
 213  *
 214  * @param[in] priv
 215  *   The vdpa driver private structure.
 216  *
 217  * @return
 218  *   0 on success, a negative errno value otherwise and rte_errno is set.
 219  */
 220 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
 221
 222 /**
 223  * Enable\Disable virtq..
 224  *
 225  * @param[in] virtq
 226  *   The vdpa driver private virtq structure.
 227  * @param[in] enable
 228  *   Set to enable, otherwise disable.
 229  *
 230  * @return
 231  *   0 on success, a negative value otherwise.
 232  */
 233 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_virtq *virtq, int enable);
 234
 235 /**
 236  * Unset steering and release all its related resources- stop traffic.
 237  *
 238  * @param[in] priv
 239  *   The vdpa driver private structure.
 240  */
 241 int mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
 242
 243 /**
 244  * Setup steering and all its related resources to enable RSS traffic from the
 245  * device to all the Rx host queues.
 246  *
 247  * @param[in] priv
 248  *   The vdpa driver private structure.
 249  *
 250  * @return
 251  *   0 on success, a negative value otherwise.
 252  */
 253 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
 254
 255 /**
 256  * Enable\Disable live migration logging.
 257  *
 258  * @param[in] priv
 259  *   The vdpa driver private structure.
 260  * @param[in] enable
 261  *   Set for enable, unset for disable.
 262  *
 263  * @return
 264  *   0 on success, a negative value otherwise.
 265  */
 266 int mlx5_vdpa_logging_enable(struct mlx5_vdpa_priv *priv, int enable);
 267
 268 /**
 269  * Set dirty bitmap logging to allow live migration.
 270  *
 271  * @param[in] priv
 272  *   The vdpa driver private structure.
 273  * @param[in] log_base
 274  *   Vhost log base.
 275  * @param[in] log_size
 276  *   Vhost log size.
 277  *
 278  * @return
 279  *   0 on success, a negative value otherwise.
 280  */
 281 int mlx5_vdpa_dirty_bitmap_set(struct mlx5_vdpa_priv *priv, uint64_t log_base,
 282                                uint64_t log_size);
 283
 284 /**
 285  * Log all virtqs information for live migration.
 286  *
 287  * @param[in] priv
 288  *   The vdpa driver private structure.
 289  * @param[in] enable
 290  *   Set for enable, unset for disable.
 291  *
 292  * @return
 293  *   0 on success, a negative value otherwise.
 294  */
 295 int mlx5_vdpa_lm_log(struct mlx5_vdpa_priv *priv);
 296
 297 /**
 298  * Modify virtq state to be ready or suspend.
 299  *
 300  * @param[in] virtq
 301  *   The vdpa driver private virtq structure.
 302  * @param[in] state
 303  *   Set for ready, otherwise suspend.
 304  *
 305  * @return
 306  *   0 on success, a negative value otherwise.
 307  */
 308 int mlx5_vdpa_virtq_modify(struct mlx5_vdpa_virtq *virtq, int state);
 309
 310 #endif /* RTE_PMD_MLX5_VDPA_H_ */