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 <vdpa_driver.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_qp sw_qp;
  58         uint16_t qp_pi;
  59 };
  60
  61 struct mlx5_vdpa_query_mr {
  62         SLIST_ENTRY(mlx5_vdpa_query_mr) next;
  63         union {
  64                 struct ibv_mr *mr;
  65                 struct mlx5_devx_obj *mkey;
  66         };
  67         int is_indirect;
  68 };
  69
  70 enum {
  71         MLX5_VDPA_NOTIFIER_STATE_DISABLED,
  72         MLX5_VDPA_NOTIFIER_STATE_ENABLED,
  73         MLX5_VDPA_NOTIFIER_STATE_ERR
  74 };
  75
  76 struct mlx5_vdpa_virtq {
  77         SLIST_ENTRY(mlx5_vdpa_virtq) next;
  78         uint8_t enable;
  79         uint16_t index;
  80         uint16_t vq_size;
  81         uint8_t notifier_state;
  82         bool stopped;
  83         uint32_t version;
  84         struct mlx5_vdpa_priv *priv;
  85         struct mlx5_devx_obj *virtq;
  86         struct mlx5_devx_obj *counters;
  87         struct mlx5_vdpa_event_qp eqp;
  88         struct {
  89                 struct mlx5dv_devx_umem *obj;
  90                 void *buf;
  91                 uint32_t size;
  92         } umems[3];
  93         struct rte_intr_handle *intr_handle;
  94         uint64_t err_time[3]; /* RDTSC time of recent errors. */
  95         uint32_t n_retry;
  96         struct mlx5_devx_virtio_q_couners_attr stats;
  97         struct mlx5_devx_virtio_q_couners_attr reset;
  98 };
  99
 100 struct mlx5_vdpa_steer {
 101         struct mlx5_devx_obj *rqt;
 102         void *domain;
 103         void *tbl;
 104         struct {
 105                 struct mlx5dv_flow_matcher *matcher;
 106                 struct mlx5_devx_obj *tir;
 107                 void *tir_action;
 108                 void *flow;
 109         } rss[7];
 110 };
 111
 112 enum {
 113         MLX5_VDPA_EVENT_MODE_DYNAMIC_TIMER,
 114         MLX5_VDPA_EVENT_MODE_FIXED_TIMER,
 115         MLX5_VDPA_EVENT_MODE_ONLY_INTERRUPT
 116 };
 117
 118 enum mlx5_dev_state {
 119         MLX5_VDPA_STATE_PROBED = 0,
 120         MLX5_VDPA_STATE_CONFIGURED,
 121         MLX5_VDPA_STATE_IN_PROGRESS /* Shutting down. */
 122 };
 123
 124 struct mlx5_vdpa_priv {
 125         TAILQ_ENTRY(mlx5_vdpa_priv) next;
 126         bool connected;
 127         enum mlx5_dev_state state;
 128         pthread_mutex_t vq_config_lock;
 129         uint64_t no_traffic_counter;
 130         pthread_t timer_tid;
 131         int event_mode;
 132         int event_core; /* Event thread cpu affinity core. */
 133         uint32_t event_us;
 134         uint32_t timer_delay_us;
 135         uint32_t no_traffic_max;
 136         uint8_t hw_latency_mode; /* Hardware CQ moderation mode. */
 137         uint16_t hw_max_latency_us; /* Hardware CQ moderation period in usec. */
 138         uint16_t hw_max_pending_comp; /* Hardware CQ moderation counter. */
 139         uint16_t queue_size; /* virtq depth for pre-creating virtq resource */
 140         uint16_t queues; /* Max virtq pair for pre-creating virtq resource */
 141         struct rte_vdpa_device *vdev; /* vDPA device. */
 142         struct mlx5_common_device *cdev; /* Backend mlx5 device. */
 143         int vid; /* vhost device id. */
 144         struct mlx5_hca_vdpa_attr caps;
 145         uint32_t gpa_mkey_index;
 146         struct ibv_mr *null_mr;
 147         struct rte_vhost_memory *vmem;
 148         struct mlx5dv_devx_event_channel *eventc;
 149         struct mlx5dv_devx_event_channel *err_chnl;
 150         struct mlx5_uar uar;
 151         struct rte_intr_handle *err_intr_handle;
 152         struct mlx5_devx_obj *td;
 153         struct mlx5_devx_obj *tiss[16]; /* TIS list for each LAG port. */
 154         uint16_t nr_virtqs;
 155         uint8_t num_lag_ports;
 156         uint64_t features; /* Negotiated features. */
 157         uint16_t log_max_rqt_size;
 158         struct mlx5_vdpa_steer steer;
 159         struct mlx5dv_var *var;
 160         void *virtq_db_addr;
 161         struct mlx5_pmd_wrapped_mr lm_mr;
 162         SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
 163         struct mlx5_vdpa_virtq virtqs[];
 164 };
 165
 166 enum {
 167         MLX5_VDPA_STATS_RECEIVED_DESCRIPTORS,
 168         MLX5_VDPA_STATS_COMPLETED_DESCRIPTORS,
 169         MLX5_VDPA_STATS_BAD_DESCRIPTOR_ERRORS,
 170         MLX5_VDPA_STATS_EXCEED_MAX_CHAIN,
 171         MLX5_VDPA_STATS_INVALID_BUFFER,
 172         MLX5_VDPA_STATS_COMPLETION_ERRORS,
 173         MLX5_VDPA_STATS_MAX
 174 };
 175
 176 /*
 177  * Check whether virtq is for traffic receive.
 178  * According to VIRTIO_NET Spec the virtqueues index identity its type by:
 179  * 0 receiveq1
 180  * 1 transmitq1
 181  * ...
 182  * 2(N-1) receiveqN
 183  * 2(N-1)+1 transmitqN
 184  * 2N controlq
 185  */
 186 static inline uint8_t
 187 is_virtq_recvq(int virtq_index, int nr_vring)
 188 {
 189         if (virtq_index % 2 == 0 && virtq_index != nr_vring - 1)
 190                 return 1;
 191         return 0;
 192 }
 193
 194 /**
 195  * Release all the prepared memory regions and all their related resources.
 196  *
 197  * @param[in] priv
 198  *   The vdpa driver private structure.
 199  */
 200 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
 201
 202 /**
 203  * Register all the memory regions of the virtio device to the HW and allocate
 204  * all their related resources.
 205  *
 206  * @param[in] priv
 207  *   The vdpa driver private structure.
 208  *
 209  * @return
 210  *   0 on success, a negative errno value otherwise and rte_errno is set.
 211  */
 212 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
 213
 214
 215 /**
 216  * Create an event QP and all its related resources.
 217  *
 218  * @param[in] priv
 219  *   The vdpa driver private structure.
 220  * @param[in] desc_n
 221  *   Number of descriptors.
 222  * @param[in] callfd
 223  *   The guest notification file descriptor.
 224  * @param[in/out] eqp
 225  *   Pointer to the event QP structure.
 226  *
 227  * @return
 228  *   0 on success, -1 otherwise and rte_errno is set.
 229  */
 230 int mlx5_vdpa_event_qp_prepare(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
 231                               int callfd, struct mlx5_vdpa_event_qp *eqp);
 232
 233 /**
 234  * Destroy an event QP and all its related resources.
 235  *
 236  * @param[in/out] eqp
 237  *   Pointer to the event QP structure.
 238  */
 239 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
 240
 241 /**
 242  * Create all the event global resources.
 243  *
 244  * @param[in] priv
 245  *   The vdpa driver private structure.
 246  */
 247 int
 248 mlx5_vdpa_event_qp_global_prepare(struct mlx5_vdpa_priv *priv);
 249
 250 /**
 251  * Release all the event global resources.
 252  *
 253  * @param[in] priv
 254  *   The vdpa driver private structure.
 255  */
 256 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
 257
 258 /**
 259  * Setup CQE event.
 260  *
 261  * @param[in] priv
 262  *   The vdpa driver private structure.
 263  *
 264  * @return
 265  *   0 on success, a negative errno value otherwise and rte_errno is set.
 266  */
 267 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
 268
 269 /**
 270  * Unset CQE event .
 271  *
 272  * @param[in] priv
 273  *   The vdpa driver private structure.
 274  */
 275 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
 276
 277 /**
 278  * Setup error interrupt handler.
 279  *
 280  * @param[in] priv
 281  *   The vdpa driver private structure.
 282  *
 283  * @return
 284  *   0 on success, a negative errno value otherwise and rte_errno is set.
 285  */
 286 int mlx5_vdpa_err_event_setup(struct mlx5_vdpa_priv *priv);
 287
 288 /**
 289  * Unset error event handler.
 290  *
 291  * @param[in] priv
 292  *   The vdpa driver private structure.
 293  */
 294 void mlx5_vdpa_err_event_unset(struct mlx5_vdpa_priv *priv);
 295
 296 /**
 297  * Release virtqs and resources except that to be reused.
 298  *
 299  * @param[in] priv
 300  *   The vdpa driver private structure.
 301  */
 302 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
 303
 304 /**
 305  * Cleanup cached resources of all virtqs.
 306  *
 307  * @param[in] priv
 308  *   The vdpa driver private structure.
 309  */
 310 void mlx5_vdpa_virtqs_cleanup(struct mlx5_vdpa_priv *priv);
 311
 312 /**
 313  * Create all the HW virtqs resources and all their related resources.
 314  *
 315  * @param[in] priv
 316  *   The vdpa driver private structure.
 317  *
 318  * @return
 319  *   0 on success, a negative errno value otherwise and rte_errno is set.
 320  */
 321 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
 322
 323 /**
 324  * Enable\Disable virtq..
 325  *
 326  * @param[in] priv
 327  *   The vdpa driver private structure.
 328  * @param[in] index
 329  *   The virtq index.
 330  * @param[in] enable
 331  *   Set to enable, otherwise disable.
 332  *
 333  * @return
 334  *   0 on success, a negative value otherwise.
 335  */
 336 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_priv *priv, int index, int enable);
 337
 338 /**
 339  * Unset steering - stop traffic.
 340  *
 341  * @param[in] priv
 342  *   The vdpa driver private structure.
 343  */
 344 void mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
 345
 346 /**
 347  * Update steering according to the received queues status.
 348  *
 349  * @param[in] priv
 350  *   The vdpa driver private structure.
 351  *
 352  * @return
 353  *   0 on success, a negative value otherwise.
 354  */
 355 int mlx5_vdpa_steer_update(struct mlx5_vdpa_priv *priv);
 356
 357 /**
 358  * Setup steering and all its related resources to enable RSS traffic from the
 359  * device to all the Rx host queues.
 360  *
 361  * @param[in] priv
 362  *   The vdpa driver private structure.
 363  *
 364  * @return
 365  *   0 on success, a negative value otherwise.
 366  */
 367 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
 368
 369 /**
 370  * Enable\Disable live migration logging.
 371  *
 372  * @param[in] priv
 373  *   The vdpa driver private structure.
 374  * @param[in] enable
 375  *   Set for enable, unset for disable.
 376  *
 377  * @return
 378  *   0 on success, a negative value otherwise.
 379  */
 380 int mlx5_vdpa_logging_enable(struct mlx5_vdpa_priv *priv, int enable);
 381
 382 /**
 383  * Set dirty bitmap logging to allow live migration.
 384  *
 385  * @param[in] priv
 386  *   The vdpa driver private structure.
 387  * @param[in] log_base
 388  *   Vhost log base.
 389  * @param[in] log_size
 390  *   Vhost log size.
 391  *
 392  * @return
 393  *   0 on success, a negative value otherwise.
 394  */
 395 int mlx5_vdpa_dirty_bitmap_set(struct mlx5_vdpa_priv *priv, uint64_t log_base,
 396                                uint64_t log_size);
 397
 398 /**
 399  * Log all virtqs information for live migration.
 400  *
 401  * @param[in] priv
 402  *   The vdpa driver private structure.
 403  * @param[in] enable
 404  *   Set for enable, unset for disable.
 405  *
 406  * @return
 407  *   0 on success, a negative value otherwise.
 408  */
 409 int mlx5_vdpa_lm_log(struct mlx5_vdpa_priv *priv);
 410
 411 /**
 412  * Modify virtq state to be ready or suspend.
 413  *
 414  * @param[in] virtq
 415  *   The vdpa driver private virtq structure.
 416  * @param[in] state
 417  *   Set for ready, otherwise suspend.
 418  *
 419  * @return
 420  *   0 on success, a negative value otherwise.
 421  */
 422 int mlx5_vdpa_virtq_modify(struct mlx5_vdpa_virtq *virtq, int state);
 423
 424 /**
 425  * Stop virtq before destroying it.
 426  *
 427  * @param[in] priv
 428  *   The vdpa driver private structure.
 429  * @param[in] index
 430  *   The virtq index.
 431  *
 432  * @return
 433  *   0 on success, a negative value otherwise.
 434  */
 435 int mlx5_vdpa_virtq_stop(struct mlx5_vdpa_priv *priv, int index);
 436
 437 /**
 438  * Query virtq information.
 439  *
 440  * @param[in] priv
 441  *   The vdpa driver private structure.
 442  * @param[in] index
 443  *   The virtq index.
 444  *
 445  * @return
 446  *   0 on success, a negative value otherwise.
 447  */
 448 int mlx5_vdpa_virtq_query(struct mlx5_vdpa_priv *priv, int index);
 449
 450 /**
 451  * Get virtq statistics.
 452  *
 453  * @param[in] priv
 454  *   The vdpa driver private structure.
 455  * @param[in] qid
 456  *   The virtq index.
 457  * @param stats
 458  *   The virtq statistics array to fill.
 459  * @param n
 460  *   The number of elements in @p stats array.
 461  *
 462  * @return
 463  *   A negative value on error, otherwise the number of entries filled in the
 464  *   @p stats array.
 465  */
 466 int
 467 mlx5_vdpa_virtq_stats_get(struct mlx5_vdpa_priv *priv, int qid,
 468                           struct rte_vdpa_stat *stats, unsigned int n);
 469
 470 /**
 471  * Reset virtq statistics.
 472  *
 473  * @param[in] priv
 474  *   The vdpa driver private structure.
 475  * @param[in] qid
 476  *   The virtq index.
 477  *
 478  * @return
 479  *   A negative value on error, otherwise 0.
 480  */
 481 int
 482 mlx5_vdpa_virtq_stats_reset(struct mlx5_vdpa_priv *priv, int qid);
 483
 484 /**
 485  * Drain virtq CQ CQE.
 486  *
 487  * @param[in] priv
 488  *   The vdpa driver private structure.
 489  */
 490 void
 491 mlx5_vdpa_drain_cq(struct mlx5_vdpa_priv *priv);
 492 #endif /* RTE_PMD_MLX5_VDPA_H_ */