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