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