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