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