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