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