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_common_devx.h>
  26 #include <mlx5_prm.h>
  27
  28
  29 #define MLX5_VDPA_INTR_RETRIES 256
  30 #define MLX5_VDPA_INTR_RETRIES_USEC 1000
  31
  32 #ifndef VIRTIO_F_ORDER_PLATFORM
  33 #define VIRTIO_F_ORDER_PLATFORM 36
  34 #endif
  35
  36 #ifndef VIRTIO_F_RING_PACKED
  37 #define VIRTIO_F_RING_PACKED 34
  38 #endif
  39
  40 #define MLX5_VDPA_DEFAULT_TIMER_DELAY_US 0u
  41 #define MLX5_VDPA_DEFAULT_TIMER_STEP_US 1u
  42
  43 struct mlx5_vdpa_cq {
  44         uint16_t log_desc_n;
  45         uint32_t cq_ci:24;
  46         uint32_t arm_sn:2;
  47         uint32_t armed:1;
  48         int callfd;
  49         rte_spinlock_t sl;
  50         struct mlx5_devx_cq cq_obj;
  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 enum {
  73         MLX5_VDPA_NOTIFIER_STATE_DISABLED,
  74         MLX5_VDPA_NOTIFIER_STATE_ENABLED,
  75         MLX5_VDPA_NOTIFIER_STATE_ERR
  76 };
  77
  78 struct mlx5_vdpa_virtq {
  79         SLIST_ENTRY(mlx5_vdpa_virtq) next;
  80         uint8_t enable;
  81         uint16_t index;
  82         uint16_t vq_size;
  83         uint8_t notifier_state;
  84         bool stopped;
  85         uint32_t version;
  86         struct mlx5_vdpa_priv *priv;
  87         struct mlx5_devx_obj *virtq;
  88         struct mlx5_devx_obj *counters;
  89         struct mlx5_vdpa_event_qp eqp;
  90         struct {
  91                 struct mlx5dv_devx_umem *obj;
  92                 void *buf;
  93                 uint32_t size;
  94         } umems[3];
  95         struct rte_intr_handle intr_handle;
  96         uint64_t err_time[3]; /* RDTSC time of recent errors. */
  97         uint32_t n_retry;
  98         struct mlx5_devx_virtio_q_couners_attr reset;
  99 };
 100
 101 struct mlx5_vdpa_steer {
 102         struct mlx5_devx_obj *rqt;
 103         void *domain;
 104         void *tbl;
 105         struct {
 106                 struct mlx5dv_flow_matcher *matcher;
 107                 struct mlx5_devx_obj *tir;
 108                 void *tir_action;
 109                 void *flow;
 110         } rss[7];
 111 };
 112
 113 enum {
 114         MLX5_VDPA_EVENT_MODE_DYNAMIC_TIMER,
 115         MLX5_VDPA_EVENT_MODE_FIXED_TIMER,
 116         MLX5_VDPA_EVENT_MODE_ONLY_INTERRUPT
 117 };
 118
 119 struct mlx5_vdpa_priv {
 120         TAILQ_ENTRY(mlx5_vdpa_priv) next;
 121         uint8_t configured;
 122         pthread_mutex_t vq_config_lock;
 123         uint64_t no_traffic_counter;
 124         pthread_t timer_tid;
 125         int event_mode;
 126         int event_core; /* Event thread cpu affinity core. */
 127         uint32_t event_us;
 128         uint32_t timer_delay_us;
 129         uint32_t no_traffic_max;
 130         uint8_t hw_latency_mode; /* Hardware CQ moderation mode. */
 131         uint16_t hw_max_latency_us; /* Hardware CQ moderation period in usec. */
 132         uint16_t hw_max_pending_comp; /* Hardware CQ moderation counter. */
 133         struct rte_vdpa_device *vdev; /* vDPA device. */
 134         int vid; /* vhost device id. */
 135         struct ibv_context *ctx; /* Device context. */
 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         struct mlx5dv_devx_event_channel *eventc;
 143         struct mlx5dv_devx_event_channel *err_chnl;
 144         struct mlx5dv_devx_uar *uar;
 145         struct rte_intr_handle err_intr_handle;
 146         struct mlx5_devx_obj *td;
 147         struct mlx5_devx_obj *tiss[16]; /* TIS list for each LAG port. */
 148         uint16_t nr_virtqs;
 149         uint8_t num_lag_ports;
 150         uint8_t qp_ts_format;
 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  * Setup error interrupt handler.
 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_err_event_setup(struct mlx5_vdpa_priv *priv);
 272
 273 /**
 274  * Unset error event handler.
 275  *
 276  * @param[in] priv
 277  *   The vdpa driver private structure.
 278  */
 279 void mlx5_vdpa_err_event_unset(struct mlx5_vdpa_priv *priv);
 280
 281 /**
 282  * Release a virtq and all its related resources.
 283  *
 284  * @param[in] priv
 285  *   The vdpa driver private structure.
 286  */
 287 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
 288
 289 /**
 290  * Create all the HW virtqs resources and all their related resources.
 291  *
 292  * @param[in] priv
 293  *   The vdpa driver private structure.
 294  *
 295  * @return
 296  *   0 on success, a negative errno value otherwise and rte_errno is set.
 297  */
 298 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
 299
 300 /**
 301  * Enable\Disable virtq..
 302  *
 303  * @param[in] priv
 304  *   The vdpa driver private structure.
 305  * @param[in] index
 306  *   The virtq index.
 307  * @param[in] enable
 308  *   Set to enable, otherwise disable.
 309  *
 310  * @return
 311  *   0 on success, a negative value otherwise.
 312  */
 313 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_priv *priv, int index, int enable);
 314
 315 /**
 316  * Unset steering and release all its related resources- stop traffic.
 317  *
 318  * @param[in] priv
 319  *   The vdpa driver private structure.
 320  */
 321 void mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
 322
 323 /**
 324  * Update steering according to the received queues status.
 325  *
 326  * @param[in] priv
 327  *   The vdpa driver private structure.
 328  *
 329  * @return
 330  *   0 on success, a negative value otherwise.
 331  */
 332 int mlx5_vdpa_steer_update(struct mlx5_vdpa_priv *priv);
 333
 334 /**
 335  * Setup steering and all its related resources to enable RSS traffic from the
 336  * device to all the Rx host queues.
 337  *
 338  * @param[in] priv
 339  *   The vdpa driver private structure.
 340  *
 341  * @return
 342  *   0 on success, a negative value otherwise.
 343  */
 344 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
 345
 346 /**
 347  * Enable\Disable live migration logging.
 348  *
 349  * @param[in] priv
 350  *   The vdpa driver private structure.
 351  * @param[in] enable
 352  *   Set for enable, unset for disable.
 353  *
 354  * @return
 355  *   0 on success, a negative value otherwise.
 356  */
 357 int mlx5_vdpa_logging_enable(struct mlx5_vdpa_priv *priv, int enable);
 358
 359 /**
 360  * Set dirty bitmap logging to allow live migration.
 361  *
 362  * @param[in] priv
 363  *   The vdpa driver private structure.
 364  * @param[in] log_base
 365  *   Vhost log base.
 366  * @param[in] log_size
 367  *   Vhost log size.
 368  *
 369  * @return
 370  *   0 on success, a negative value otherwise.
 371  */
 372 int mlx5_vdpa_dirty_bitmap_set(struct mlx5_vdpa_priv *priv, uint64_t log_base,
 373                                uint64_t log_size);
 374
 375 /**
 376  * Log all virtqs information for live migration.
 377  *
 378  * @param[in] priv
 379  *   The vdpa driver private structure.
 380  * @param[in] enable
 381  *   Set for enable, unset for disable.
 382  *
 383  * @return
 384  *   0 on success, a negative value otherwise.
 385  */
 386 int mlx5_vdpa_lm_log(struct mlx5_vdpa_priv *priv);
 387
 388 /**
 389  * Modify virtq state to be ready or suspend.
 390  *
 391  * @param[in] virtq
 392  *   The vdpa driver private virtq structure.
 393  * @param[in] state
 394  *   Set for ready, otherwise suspend.
 395  *
 396  * @return
 397  *   0 on success, a negative value otherwise.
 398  */
 399 int mlx5_vdpa_virtq_modify(struct mlx5_vdpa_virtq *virtq, int state);
 400
 401 /**
 402  * Stop virtq before destroying it.
 403  *
 404  * @param[in] priv
 405  *   The vdpa driver private structure.
 406  * @param[in] index
 407  *   The virtq index.
 408  *
 409  * @return
 410  *   0 on success, a negative value otherwise.
 411  */
 412 int mlx5_vdpa_virtq_stop(struct mlx5_vdpa_priv *priv, int index);
 413
 414 /**
 415  * Query virtq information.
 416  *
 417  * @param[in] priv
 418  *   The vdpa driver private structure.
 419  * @param[in] index
 420  *   The virtq index.
 421  *
 422  * @return
 423  *   0 on success, a negative value otherwise.
 424  */
 425 int mlx5_vdpa_virtq_query(struct mlx5_vdpa_priv *priv, int index);
 426
 427 /**
 428  * Get virtq statistics.
 429  *
 430  * @param[in] priv
 431  *   The vdpa driver private structure.
 432  * @param[in] qid
 433  *   The virtq index.
 434  * @param stats
 435  *   The virtq statistics array to fill.
 436  * @param n
 437  *   The number of elements in @p stats array.
 438  *
 439  * @return
 440  *   A negative value on error, otherwise the number of entries filled in the
 441  *   @p stats array.
 442  */
 443 int
 444 mlx5_vdpa_virtq_stats_get(struct mlx5_vdpa_priv *priv, int qid,
 445                           struct rte_vdpa_stat *stats, unsigned int n);
 446
 447 /**
 448  * Reset virtq statistics.
 449  *
 450  * @param[in] priv
 451  *   The vdpa driver private structure.
 452  * @param[in] qid
 453  *   The virtq index.
 454  *
 455  * @return
 456  *   A negative value on error, otherwise 0.
 457  */
 458 int
 459 mlx5_vdpa_virtq_stats_reset(struct mlx5_vdpa_priv *priv, int qid);
 460 #endif /* RTE_PMD_MLX5_VDPA_H_ */