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