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         void *addr;
  63         uint64_t length;
  64         struct mlx5dv_devx_umem *umem;
  65         struct mlx5_devx_obj *mkey;
  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 struct mlx5_vdpa_priv {
 117         TAILQ_ENTRY(mlx5_vdpa_priv) next;
 118         uint8_t configured;
 119         pthread_mutex_t vq_config_lock;
 120         uint64_t no_traffic_counter;
 121         pthread_t timer_tid;
 122         int event_mode;
 123         int event_core; /* Event thread cpu affinity core. */
 124         uint32_t event_us;
 125         uint32_t timer_delay_us;
 126         uint32_t no_traffic_max;
 127         uint8_t hw_latency_mode; /* Hardware CQ moderation mode. */
 128         uint16_t hw_max_latency_us; /* Hardware CQ moderation period in usec. */
 129         uint16_t hw_max_pending_comp; /* Hardware CQ moderation counter. */
 130         struct rte_vdpa_device *vdev; /* vDPA device. */
 131         struct mlx5_common_device *cdev; /* Backend mlx5 device. */
 132         int vid; /* vhost device id. */
 133         struct mlx5_hca_vdpa_attr caps;
 134         uint32_t gpa_mkey_index;
 135         struct ibv_mr *null_mr;
 136         struct rte_vhost_memory *vmem;
 137         struct mlx5dv_devx_event_channel *eventc;
 138         struct mlx5dv_devx_event_channel *err_chnl;
 139         struct mlx5dv_devx_uar *uar;
 140         struct rte_intr_handle *err_intr_handle;
 141         struct mlx5_devx_obj *td;
 142         struct mlx5_devx_obj *tiss[16]; /* TIS list for each LAG port. */
 143         uint16_t nr_virtqs;
 144         uint8_t num_lag_ports;
 145         uint64_t features; /* Negotiated features. */
 146         uint16_t log_max_rqt_size;
 147         struct mlx5_vdpa_steer steer;
 148         struct mlx5dv_var *var;
 149         void *virtq_db_addr;
 150         SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
 151         struct mlx5_vdpa_virtq virtqs[];
 152 };
 153
 154 enum {
 155         MLX5_VDPA_STATS_RECEIVED_DESCRIPTORS,
 156         MLX5_VDPA_STATS_COMPLETED_DESCRIPTORS,
 157         MLX5_VDPA_STATS_BAD_DESCRIPTOR_ERRORS,
 158         MLX5_VDPA_STATS_EXCEED_MAX_CHAIN,
 159         MLX5_VDPA_STATS_INVALID_BUFFER,
 160         MLX5_VDPA_STATS_COMPLETION_ERRORS,
 161         MLX5_VDPA_STATS_MAX
 162 };
 163
 164 /*
 165  * Check whether virtq is for traffic receive.
 166  * According to VIRTIO_NET Spec the virtqueues index identity its type by:
 167  * 0 receiveq1
 168  * 1 transmitq1
 169  * ...
 170  * 2(N-1) receiveqN
 171  * 2(N-1)+1 transmitqN
 172  * 2N controlq
 173  */
 174 static inline uint8_t
 175 is_virtq_recvq(int virtq_index, int nr_vring)
 176 {
 177         if (virtq_index % 2 == 0 && virtq_index != nr_vring - 1)
 178                 return 1;
 179         return 0;
 180 }
 181
 182 /**
 183  * Release all the prepared memory regions and all their related resources.
 184  *
 185  * @param[in] priv
 186  *   The vdpa driver private structure.
 187  */
 188 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
 189
 190 /**
 191  * Register all the memory regions of the virtio device to the HW and allocate
 192  * all their related resources.
 193  *
 194  * @param[in] priv
 195  *   The vdpa driver private structure.
 196  *
 197  * @return
 198  *   0 on success, a negative errno value otherwise and rte_errno is set.
 199  */
 200 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
 201
 202
 203 /**
 204  * Create an event QP and all its related resources.
 205  *
 206  * @param[in] priv
 207  *   The vdpa driver private structure.
 208  * @param[in] desc_n
 209  *   Number of descriptors.
 210  * @param[in] callfd
 211  *   The guest notification file descriptor.
 212  * @param[in/out] eqp
 213  *   Pointer to the event QP structure.
 214  *
 215  * @return
 216  *   0 on success, -1 otherwise and rte_errno is set.
 217  */
 218 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
 219                               int callfd, struct mlx5_vdpa_event_qp *eqp);
 220
 221 /**
 222  * Destroy an event QP and all its related resources.
 223  *
 224  * @param[in/out] eqp
 225  *   Pointer to the event QP structure.
 226  */
 227 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
 228
 229 /**
 230  * Release all the event global resources.
 231  *
 232  * @param[in] priv
 233  *   The vdpa driver private structure.
 234  */
 235 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
 236
 237 /**
 238  * Setup CQE event.
 239  *
 240  * @param[in] priv
 241  *   The vdpa driver private structure.
 242  *
 243  * @return
 244  *   0 on success, a negative errno value otherwise and rte_errno is set.
 245  */
 246 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
 247
 248 /**
 249  * Unset CQE event .
 250  *
 251  * @param[in] priv
 252  *   The vdpa driver private structure.
 253  */
 254 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
 255
 256 /**
 257  * Setup error interrupt handler.
 258  *
 259  * @param[in] priv
 260  *   The vdpa driver private structure.
 261  *
 262  * @return
 263  *   0 on success, a negative errno value otherwise and rte_errno is set.
 264  */
 265 int mlx5_vdpa_err_event_setup(struct mlx5_vdpa_priv *priv);
 266
 267 /**
 268  * Unset error event handler.
 269  *
 270  * @param[in] priv
 271  *   The vdpa driver private structure.
 272  */
 273 void mlx5_vdpa_err_event_unset(struct mlx5_vdpa_priv *priv);
 274
 275 /**
 276  * Release a virtq and all its related resources.
 277  *
 278  * @param[in] priv
 279  *   The vdpa driver private structure.
 280  */
 281 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
 282
 283 /**
 284  * Create all the HW virtqs resources and all their related resources.
 285  *
 286  * @param[in] priv
 287  *   The vdpa driver private structure.
 288  *
 289  * @return
 290  *   0 on success, a negative errno value otherwise and rte_errno is set.
 291  */
 292 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
 293
 294 /**
 295  * Enable\Disable virtq..
 296  *
 297  * @param[in] priv
 298  *   The vdpa driver private structure.
 299  * @param[in] index
 300  *   The virtq index.
 301  * @param[in] enable
 302  *   Set to enable, otherwise disable.
 303  *
 304  * @return
 305  *   0 on success, a negative value otherwise.
 306  */
 307 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_priv *priv, int index, int enable);
 308
 309 /**
 310  * Unset steering and release all its related resources- stop traffic.
 311  *
 312  * @param[in] priv
 313  *   The vdpa driver private structure.
 314  */
 315 void mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
 316
 317 /**
 318  * Update steering according to the received queues status.
 319  *
 320  * @param[in] priv
 321  *   The vdpa driver private structure.
 322  *
 323  * @return
 324  *   0 on success, a negative value otherwise.
 325  */
 326 int mlx5_vdpa_steer_update(struct mlx5_vdpa_priv *priv);
 327
 328 /**
 329  * Setup steering and all its related resources to enable RSS traffic from the
 330  * device to all the Rx host queues.
 331  *
 332  * @param[in] priv
 333  *   The vdpa driver private structure.
 334  *
 335  * @return
 336  *   0 on success, a negative value otherwise.
 337  */
 338 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
 339
 340 /**
 341  * Enable\Disable live migration logging.
 342  *
 343  * @param[in] priv
 344  *   The vdpa driver private structure.
 345  * @param[in] enable
 346  *   Set for enable, unset for disable.
 347  *
 348  * @return
 349  *   0 on success, a negative value otherwise.
 350  */
 351 int mlx5_vdpa_logging_enable(struct mlx5_vdpa_priv *priv, int enable);
 352
 353 /**
 354  * Set dirty bitmap logging to allow live migration.
 355  *
 356  * @param[in] priv
 357  *   The vdpa driver private structure.
 358  * @param[in] log_base
 359  *   Vhost log base.
 360  * @param[in] log_size
 361  *   Vhost log size.
 362  *
 363  * @return
 364  *   0 on success, a negative value otherwise.
 365  */
 366 int mlx5_vdpa_dirty_bitmap_set(struct mlx5_vdpa_priv *priv, uint64_t log_base,
 367                                uint64_t log_size);
 368
 369 /**
 370  * Log all virtqs information for live migration.
 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_lm_log(struct mlx5_vdpa_priv *priv);
 381
 382 /**
 383  * Modify virtq state to be ready or suspend.
 384  *
 385  * @param[in] virtq
 386  *   The vdpa driver private virtq structure.
 387  * @param[in] state
 388  *   Set for ready, otherwise suspend.
 389  *
 390  * @return
 391  *   0 on success, a negative value otherwise.
 392  */
 393 int mlx5_vdpa_virtq_modify(struct mlx5_vdpa_virtq *virtq, int state);
 394
 395 /**
 396  * Stop virtq before destroying it.
 397  *
 398  * @param[in] priv
 399  *   The vdpa driver private structure.
 400  * @param[in] index
 401  *   The virtq index.
 402  *
 403  * @return
 404  *   0 on success, a negative value otherwise.
 405  */
 406 int mlx5_vdpa_virtq_stop(struct mlx5_vdpa_priv *priv, int index);
 407
 408 /**
 409  * Query virtq information.
 410  *
 411  * @param[in] priv
 412  *   The vdpa driver private structure.
 413  * @param[in] index
 414  *   The virtq index.
 415  *
 416  * @return
 417  *   0 on success, a negative value otherwise.
 418  */
 419 int mlx5_vdpa_virtq_query(struct mlx5_vdpa_priv *priv, int index);
 420
 421 /**
 422  * Get virtq statistics.
 423  *
 424  * @param[in] priv
 425  *   The vdpa driver private structure.
 426  * @param[in] qid
 427  *   The virtq index.
 428  * @param stats
 429  *   The virtq statistics array to fill.
 430  * @param n
 431  *   The number of elements in @p stats array.
 432  *
 433  * @return
 434  *   A negative value on error, otherwise the number of entries filled in the
 435  *   @p stats array.
 436  */
 437 int
 438 mlx5_vdpa_virtq_stats_get(struct mlx5_vdpa_priv *priv, int qid,
 439                           struct rte_vdpa_stat *stats, unsigned int n);
 440
 441 /**
 442  * Reset virtq statistics.
 443  *
 444  * @param[in] priv
 445  *   The vdpa driver private structure.
 446  * @param[in] qid
 447  *   The virtq index.
 448  *
 449  * @return
 450  *   A negative value on error, otherwise 0.
 451  */
 452 int
 453 mlx5_vdpa_virtq_stats_reset(struct mlx5_vdpa_priv *priv, int qid);
 454 #endif /* RTE_PMD_MLX5_VDPA_H_ */