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_prm.h>
  26
  27
  28 #define MLX5_VDPA_INTR_RETRIES 256
  29 #define MLX5_VDPA_INTR_RETRIES_USEC 1000
  30
  31 #ifndef VIRTIO_F_ORDER_PLATFORM
  32 #define VIRTIO_F_ORDER_PLATFORM 36
  33 #endif
  34
  35 #ifndef VIRTIO_F_RING_PACKED
  36 #define VIRTIO_F_RING_PACKED 34
  37 #endif
  38
  39 #define MLX5_VDPA_DEFAULT_TIMER_DELAY_US 0u
  40 #define MLX5_VDPA_DEFAULT_TIMER_STEP_US 1u
  41
  42 struct mlx5_vdpa_cq {
  43         uint16_t log_desc_n;
  44         uint32_t cq_ci:24;
  45         uint32_t arm_sn:2;
  46         uint32_t armed:1;
  47         int callfd;
  48         rte_spinlock_t sl;
  49         struct mlx5_devx_obj *cq;
  50         struct mlx5dv_devx_umem *umem_obj;
  51         union {
  52                 volatile void *umem_buf;
  53                 volatile struct mlx5_cqe *cqes;
  54         };
  55         volatile uint32_t *db_rec;
  56         uint64_t errors;
  57 };
  58
  59 struct mlx5_vdpa_event_qp {
  60         struct mlx5_vdpa_cq cq;
  61         struct mlx5_devx_obj *fw_qp;
  62         struct mlx5_devx_obj *sw_qp;
  63         struct mlx5dv_devx_umem *umem_obj;
  64         void *umem_buf;
  65         volatile uint32_t *db_rec;
  66 };
  67
  68 struct mlx5_vdpa_query_mr {
  69         SLIST_ENTRY(mlx5_vdpa_query_mr) next;
  70         void *addr;
  71         uint64_t length;
  72         struct mlx5dv_devx_umem *umem;
  73         struct mlx5_devx_obj *mkey;
  74         int is_indirect;
  75 };
  76
  77 enum {
  78         MLX5_VDPA_NOTIFIER_STATE_DISABLED,
  79         MLX5_VDPA_NOTIFIER_STATE_ENABLED,
  80         MLX5_VDPA_NOTIFIER_STATE_ERR
  81 };
  82
  83 struct mlx5_vdpa_virtq {
  84         SLIST_ENTRY(mlx5_vdpa_virtq) next;
  85         uint8_t enable;
  86         uint16_t index;
  87         uint16_t vq_size;
  88         uint8_t notifier_state;
  89         bool stopped;
  90         uint32_t version;
  91         struct mlx5_vdpa_priv *priv;
  92         struct mlx5_devx_obj *virtq;
  93         struct mlx5_devx_obj *counters;
  94         struct mlx5_vdpa_event_qp eqp;
  95         struct {
  96                 struct mlx5dv_devx_umem *obj;
  97                 void *buf;
  98                 uint32_t size;
  99         } umems[3];
 100         struct rte_intr_handle intr_handle;
 101         uint64_t err_time[3]; /* RDTSC time of recent errors. */
 102         uint32_t n_retry;
 103         struct mlx5_devx_virtio_q_couners_attr reset;
 104 };
 105
 106 struct mlx5_vdpa_steer {
 107         struct mlx5_devx_obj *rqt;
 108         void *domain;
 109         void *tbl;
 110         struct {
 111                 struct mlx5dv_flow_matcher *matcher;
 112                 struct mlx5_devx_obj *tir;
 113                 void *tir_action;
 114                 void *flow;
 115         } rss[7];
 116 };
 117
 118 enum {
 119         MLX5_VDPA_EVENT_MODE_DYNAMIC_TIMER,
 120         MLX5_VDPA_EVENT_MODE_FIXED_TIMER,
 121         MLX5_VDPA_EVENT_MODE_ONLY_INTERRUPT
 122 };
 123
 124 struct mlx5_vdpa_priv {
 125         TAILQ_ENTRY(mlx5_vdpa_priv) next;
 126         uint8_t configured;
 127         pthread_mutex_t vq_config_lock;
 128         uint64_t last_traffic_tic;
 129         pthread_t timer_tid;
 130         pthread_mutex_t timer_lock;
 131         pthread_cond_t timer_cond;
 132         volatile uint8_t timer_on;
 133         int event_mode;
 134         int event_core; /* Event thread cpu affinity core. */
 135         uint32_t event_us;
 136         uint32_t timer_delay_us;
 137         uint32_t no_traffic_time_s;
 138         uint8_t hw_latency_mode; /* Hardware CQ moderation mode. */
 139         uint16_t hw_max_latency_us; /* Hardware CQ moderation period in usec. */
 140         uint16_t hw_max_pending_comp; /* Hardware CQ moderation counter. */
 141         struct rte_vdpa_device *vdev; /* vDPA device. */
 142         int vid; /* vhost device id. */
 143         struct ibv_context *ctx; /* Device context. */
 144         struct rte_pci_device *pci_dev;
 145         struct mlx5_hca_vdpa_attr caps;
 146         uint32_t pdn; /* Protection Domain number. */
 147         struct ibv_pd *pd;
 148         uint32_t gpa_mkey_index;
 149         struct ibv_mr *null_mr;
 150         struct rte_vhost_memory *vmem;
 151         uint32_t eqn;
 152         struct mlx5dv_devx_event_channel *eventc;
 153         struct mlx5dv_devx_event_channel *err_chnl;
 154         struct mlx5dv_devx_uar *uar;
 155         struct rte_intr_handle intr_handle;
 156         struct rte_intr_handle err_intr_handle;
 157         struct mlx5_devx_obj *td;
 158         struct mlx5_devx_obj *tiss[16]; /* TIS list for each LAG port. */
 159         uint16_t nr_virtqs;
 160         uint8_t num_lag_ports;
 161         uint64_t features; /* Negotiated features. */
 162         uint16_t log_max_rqt_size;
 163         struct mlx5_vdpa_steer steer;
 164         struct mlx5dv_var *var;
 165         void *virtq_db_addr;
 166         SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
 167         struct mlx5_vdpa_virtq virtqs[];
 168 };
 169
 170 enum {
 171         MLX5_VDPA_STATS_RECEIVED_DESCRIPTORS,
 172         MLX5_VDPA_STATS_COMPLETED_DESCRIPTORS,
 173         MLX5_VDPA_STATS_BAD_DESCRIPTOR_ERRORS,
 174         MLX5_VDPA_STATS_EXCEED_MAX_CHAIN,
 175         MLX5_VDPA_STATS_INVALID_BUFFER,
 176         MLX5_VDPA_STATS_COMPLETION_ERRORS,
 177         MLX5_VDPA_STATS_MAX
 178 };
 179
 180 /*
 181  * Check whether virtq is for traffic receive.
 182  * According to VIRTIO_NET Spec the virtqueues index identity its type by:
 183  * 0 receiveq1
 184  * 1 transmitq1
 185  * ...
 186  * 2(N-1) receiveqN
 187  * 2(N-1)+1 transmitqN
 188  * 2N controlq
 189  */
 190 static inline uint8_t
 191 is_virtq_recvq(int virtq_index, int nr_vring)
 192 {
 193         if (virtq_index % 2 == 0 && virtq_index != nr_vring - 1)
 194                 return 1;
 195         return 0;
 196 }
 197
 198 /**
 199  * Release all the prepared memory regions and all their related resources.
 200  *
 201  * @param[in] priv
 202  *   The vdpa driver private structure.
 203  */
 204 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
 205
 206 /**
 207  * Register all the memory regions of the virtio device to the HW and allocate
 208  * all their related resources.
 209  *
 210  * @param[in] priv
 211  *   The vdpa driver private structure.
 212  *
 213  * @return
 214  *   0 on success, a negative errno value otherwise and rte_errno is set.
 215  */
 216 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
 217
 218
 219 /**
 220  * Create an event QP and all its related resources.
 221  *
 222  * @param[in] priv
 223  *   The vdpa driver private structure.
 224  * @param[in] desc_n
 225  *   Number of descriptors.
 226  * @param[in] callfd
 227  *   The guest notification file descriptor.
 228  * @param[in/out] eqp
 229  *   Pointer to the event QP structure.
 230  *
 231  * @return
 232  *   0 on success, -1 otherwise and rte_errno is set.
 233  */
 234 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
 235                               int callfd, struct mlx5_vdpa_event_qp *eqp);
 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  * 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_ */