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         uint8_t direct_notifier; /* Whether direct notifier is on or off. */
 104         int id; /* vDPA device id. */
 105         int vid; /* vhost device id. */
 106         struct ibv_context *ctx; /* Device context. */
 107         struct rte_vdpa_dev_addr dev_addr;
 108         struct mlx5_hca_vdpa_attr caps;
 109         uint32_t pdn; /* Protection Domain number. */
 110         struct ibv_pd *pd;
 111         uint32_t gpa_mkey_index;
 112         struct ibv_mr *null_mr;
 113         struct rte_vhost_memory *vmem;
 114         uint32_t eqn;
 115         struct mlx5dv_devx_event_channel *eventc;
 116         struct mlx5dv_devx_uar *uar;
 117         struct rte_intr_handle intr_handle;
 118         struct mlx5_devx_obj *td;
 119         struct mlx5_devx_obj *tis;
 120         uint16_t nr_virtqs;
 121         uint64_t features; /* Negotiated features. */
 122         uint16_t log_max_rqt_size;
 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         struct mlx5_vdpa_virtq virtqs[];
 128 };
 129
 130 /*
 131  * Check whether virtq is for traffic receive.
 132  * According to VIRTIO_NET Spec the virtqueues index identity its type by:
 133  * 0 receiveq1
 134  * 1 transmitq1
 135  * ...
 136  * 2(N-1) receiveqN
 137  * 2(N-1)+1 transmitqN
 138  * 2N controlq
 139  */
 140 static inline uint8_t
 141 is_virtq_recvq(int virtq_index, int nr_vring)
 142 {
 143         if (virtq_index % 2 == 0 && virtq_index != nr_vring - 1)
 144                 return 1;
 145         return 0;
 146 }
 147
 148 /**
 149  * Release all the prepared memory regions and all their related resources.
 150  *
 151  * @param[in] priv
 152  *   The vdpa driver private structure.
 153  */
 154 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
 155
 156 /**
 157  * Register all the memory regions of the virtio device to the HW and allocate
 158  * all their related resources.
 159  *
 160  * @param[in] priv
 161  *   The vdpa driver private structure.
 162  *
 163  * @return
 164  *   0 on success, a negative errno value otherwise and rte_errno is set.
 165  */
 166 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
 167
 168
 169 /**
 170  * Create an event QP and all its related resources.
 171  *
 172  * @param[in] priv
 173  *   The vdpa driver private structure.
 174  * @param[in] desc_n
 175  *   Number of descriptors.
 176  * @param[in] callfd
 177  *   The guest notification file descriptor.
 178  * @param[in/out] eqp
 179  *   Pointer to the event QP structure.
 180  *
 181  * @return
 182  *   0 on success, -1 otherwise and rte_errno is set.
 183  */
 184 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
 185                               int callfd, struct mlx5_vdpa_event_qp *eqp);
 186
 187 /**
 188  * Destroy an event QP and all its related resources.
 189  *
 190  * @param[in/out] eqp
 191  *   Pointer to the event QP structure.
 192  */
 193 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
 194
 195 /**
 196  * Release all the event global resources.
 197  *
 198  * @param[in] priv
 199  *   The vdpa driver private structure.
 200  */
 201 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
 202
 203 /**
 204  * Setup CQE event.
 205  *
 206  * @param[in] priv
 207  *   The vdpa driver private structure.
 208  *
 209  * @return
 210  *   0 on success, a negative errno value otherwise and rte_errno is set.
 211  */
 212 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
 213
 214 /**
 215  * Unset CQE event .
 216  *
 217  * @param[in] priv
 218  *   The vdpa driver private structure.
 219  */
 220 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
 221
 222 /**
 223  * Release a virtq and all its related resources.
 224  *
 225  * @param[in] priv
 226  *   The vdpa driver private structure.
 227  */
 228 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
 229
 230 /**
 231  * Create all the HW virtqs resources and all their related resources.
 232  *
 233  * @param[in] priv
 234  *   The vdpa driver private structure.
 235  *
 236  * @return
 237  *   0 on success, a negative errno value otherwise and rte_errno is set.
 238  */
 239 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
 240
 241 /**
 242  * Enable\Disable virtq..
 243  *
 244  * @param[in] priv
 245  *   The vdpa driver private structure.
 246  * @param[in] index
 247  *   The virtq index.
 248  * @param[in] enable
 249  *   Set to enable, otherwise disable.
 250  *
 251  * @return
 252  *   0 on success, a negative value otherwise.
 253  */
 254 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_priv *priv, int index, int enable);
 255
 256 /**
 257  * Unset steering and release all its related resources- stop traffic.
 258  *
 259  * @param[in] priv
 260  *   The vdpa driver private structure.
 261  */
 262 void mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
 263
 264 /**
 265  * Update steering according to the received queues status.
 266  *
 267  * @param[in] priv
 268  *   The vdpa driver private structure.
 269  *
 270  * @return
 271  *   0 on success, a negative value otherwise.
 272  */
 273 int mlx5_vdpa_steer_update(struct mlx5_vdpa_priv *priv);
 274
 275 /**
 276  * Setup steering and all its related resources to enable RSS traffic from the
 277  * device to all the Rx host queues.
 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_setup(struct mlx5_vdpa_priv *priv);
 286
 287 /**
 288  * Enable\Disable live migration logging.
 289  *
 290  * @param[in] priv
 291  *   The vdpa driver private structure.
 292  * @param[in] enable
 293  *   Set for enable, unset for disable.
 294  *
 295  * @return
 296  *   0 on success, a negative value otherwise.
 297  */
 298 int mlx5_vdpa_logging_enable(struct mlx5_vdpa_priv *priv, int enable);
 299
 300 /**
 301  * Set dirty bitmap logging to allow live migration.
 302  *
 303  * @param[in] priv
 304  *   The vdpa driver private structure.
 305  * @param[in] log_base
 306  *   Vhost log base.
 307  * @param[in] log_size
 308  *   Vhost log size.
 309  *
 310  * @return
 311  *   0 on success, a negative value otherwise.
 312  */
 313 int mlx5_vdpa_dirty_bitmap_set(struct mlx5_vdpa_priv *priv, uint64_t log_base,
 314                                uint64_t log_size);
 315
 316 /**
 317  * Log all virtqs information for live migration.
 318  *
 319  * @param[in] priv
 320  *   The vdpa driver private structure.
 321  * @param[in] enable
 322  *   Set for enable, unset for disable.
 323  *
 324  * @return
 325  *   0 on success, a negative value otherwise.
 326  */
 327 int mlx5_vdpa_lm_log(struct mlx5_vdpa_priv *priv);
 328
 329 /**
 330  * Modify virtq state to be ready or suspend.
 331  *
 332  * @param[in] virtq
 333  *   The vdpa driver private virtq structure.
 334  * @param[in] state
 335  *   Set for ready, otherwise suspend.
 336  *
 337  * @return
 338  *   0 on success, a negative value otherwise.
 339  */
 340 int mlx5_vdpa_virtq_modify(struct mlx5_vdpa_virtq *virtq, int state);
 341
 342 /**
 343  * Stop virtq before destroying it.
 344  *
 345  * @param[in] priv
 346  *   The vdpa driver private structure.
 347  * @param[in] index
 348  *   The virtq index.
 349  *
 350  * @return
 351  *   0 on success, a negative value otherwise.
 352  */
 353 int mlx5_vdpa_virtq_stop(struct mlx5_vdpa_priv *priv, int index);
 354
 355 #endif /* RTE_PMD_MLX5_VDPA_H_ */