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