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 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 mlx5_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         struct mlx5_pmd_wrapped_mr lm_mr;
 151         SLIST_HEAD(mr_list, mlx5_vdpa_query_mr) mr_list;
 152         struct mlx5_vdpa_virtq virtqs[];
 153 };
 154
 155 enum {
 156         MLX5_VDPA_STATS_RECEIVED_DESCRIPTORS,
 157         MLX5_VDPA_STATS_COMPLETED_DESCRIPTORS,
 158         MLX5_VDPA_STATS_BAD_DESCRIPTOR_ERRORS,
 159         MLX5_VDPA_STATS_EXCEED_MAX_CHAIN,
 160         MLX5_VDPA_STATS_INVALID_BUFFER,
 161         MLX5_VDPA_STATS_COMPLETION_ERRORS,
 162         MLX5_VDPA_STATS_MAX
 163 };
 164
 165 /*
 166  * Check whether virtq is for traffic receive.
 167  * According to VIRTIO_NET Spec the virtqueues index identity its type by:
 168  * 0 receiveq1
 169  * 1 transmitq1
 170  * ...
 171  * 2(N-1) receiveqN
 172  * 2(N-1)+1 transmitqN
 173  * 2N controlq
 174  */
 175 static inline uint8_t
 176 is_virtq_recvq(int virtq_index, int nr_vring)
 177 {
 178         if (virtq_index % 2 == 0 && virtq_index != nr_vring - 1)
 179                 return 1;
 180         return 0;
 181 }
 182
 183 /**
 184  * Release all the prepared memory regions and all their related resources.
 185  *
 186  * @param[in] priv
 187  *   The vdpa driver private structure.
 188  */
 189 void mlx5_vdpa_mem_dereg(struct mlx5_vdpa_priv *priv);
 190
 191 /**
 192  * Register all the memory regions of the virtio device to the HW and allocate
 193  * all their related resources.
 194  *
 195  * @param[in] priv
 196  *   The vdpa driver private structure.
 197  *
 198  * @return
 199  *   0 on success, a negative errno value otherwise and rte_errno is set.
 200  */
 201 int mlx5_vdpa_mem_register(struct mlx5_vdpa_priv *priv);
 202
 203
 204 /**
 205  * Create an event QP and all its related resources.
 206  *
 207  * @param[in] priv
 208  *   The vdpa driver private structure.
 209  * @param[in] desc_n
 210  *   Number of descriptors.
 211  * @param[in] callfd
 212  *   The guest notification file descriptor.
 213  * @param[in/out] eqp
 214  *   Pointer to the event QP structure.
 215  *
 216  * @return
 217  *   0 on success, -1 otherwise and rte_errno is set.
 218  */
 219 int mlx5_vdpa_event_qp_create(struct mlx5_vdpa_priv *priv, uint16_t desc_n,
 220                               int callfd, struct mlx5_vdpa_event_qp *eqp);
 221
 222 /**
 223  * Destroy an event QP and all its related resources.
 224  *
 225  * @param[in/out] eqp
 226  *   Pointer to the event QP structure.
 227  */
 228 void mlx5_vdpa_event_qp_destroy(struct mlx5_vdpa_event_qp *eqp);
 229
 230 /**
 231  * Release all the event global resources.
 232  *
 233  * @param[in] priv
 234  *   The vdpa driver private structure.
 235  */
 236 void mlx5_vdpa_event_qp_global_release(struct mlx5_vdpa_priv *priv);
 237
 238 /**
 239  * Setup CQE event.
 240  *
 241  * @param[in] priv
 242  *   The vdpa driver private structure.
 243  *
 244  * @return
 245  *   0 on success, a negative errno value otherwise and rte_errno is set.
 246  */
 247 int mlx5_vdpa_cqe_event_setup(struct mlx5_vdpa_priv *priv);
 248
 249 /**
 250  * Unset CQE event .
 251  *
 252  * @param[in] priv
 253  *   The vdpa driver private structure.
 254  */
 255 void mlx5_vdpa_cqe_event_unset(struct mlx5_vdpa_priv *priv);
 256
 257 /**
 258  * Setup error interrupt handler.
 259  *
 260  * @param[in] priv
 261  *   The vdpa driver private structure.
 262  *
 263  * @return
 264  *   0 on success, a negative errno value otherwise and rte_errno is set.
 265  */
 266 int mlx5_vdpa_err_event_setup(struct mlx5_vdpa_priv *priv);
 267
 268 /**
 269  * Unset error event handler.
 270  *
 271  * @param[in] priv
 272  *   The vdpa driver private structure.
 273  */
 274 void mlx5_vdpa_err_event_unset(struct mlx5_vdpa_priv *priv);
 275
 276 /**
 277  * Release a virtq and all its related resources.
 278  *
 279  * @param[in] priv
 280  *   The vdpa driver private structure.
 281  */
 282 void mlx5_vdpa_virtqs_release(struct mlx5_vdpa_priv *priv);
 283
 284 /**
 285  * Create all the HW virtqs resources and all their related resources.
 286  *
 287  * @param[in] priv
 288  *   The vdpa driver private structure.
 289  *
 290  * @return
 291  *   0 on success, a negative errno value otherwise and rte_errno is set.
 292  */
 293 int mlx5_vdpa_virtqs_prepare(struct mlx5_vdpa_priv *priv);
 294
 295 /**
 296  * Enable\Disable virtq..
 297  *
 298  * @param[in] priv
 299  *   The vdpa driver private structure.
 300  * @param[in] index
 301  *   The virtq index.
 302  * @param[in] enable
 303  *   Set to enable, otherwise disable.
 304  *
 305  * @return
 306  *   0 on success, a negative value otherwise.
 307  */
 308 int mlx5_vdpa_virtq_enable(struct mlx5_vdpa_priv *priv, int index, int enable);
 309
 310 /**
 311  * Unset steering and release all its related resources- stop traffic.
 312  *
 313  * @param[in] priv
 314  *   The vdpa driver private structure.
 315  */
 316 void mlx5_vdpa_steer_unset(struct mlx5_vdpa_priv *priv);
 317
 318 /**
 319  * Update steering according to the received queues status.
 320  *
 321  * @param[in] priv
 322  *   The vdpa driver private structure.
 323  *
 324  * @return
 325  *   0 on success, a negative value otherwise.
 326  */
 327 int mlx5_vdpa_steer_update(struct mlx5_vdpa_priv *priv);
 328
 329 /**
 330  * Setup steering and all its related resources to enable RSS traffic from the
 331  * device to all the Rx host queues.
 332  *
 333  * @param[in] priv
 334  *   The vdpa driver private structure.
 335  *
 336  * @return
 337  *   0 on success, a negative value otherwise.
 338  */
 339 int mlx5_vdpa_steer_setup(struct mlx5_vdpa_priv *priv);
 340
 341 /**
 342  * Enable\Disable live migration logging.
 343  *
 344  * @param[in] priv
 345  *   The vdpa driver private structure.
 346  * @param[in] enable
 347  *   Set for enable, unset for disable.
 348  *
 349  * @return
 350  *   0 on success, a negative value otherwise.
 351  */
 352 int mlx5_vdpa_logging_enable(struct mlx5_vdpa_priv *priv, int enable);
 353
 354 /**
 355  * Set dirty bitmap logging to allow live migration.
 356  *
 357  * @param[in] priv
 358  *   The vdpa driver private structure.
 359  * @param[in] log_base
 360  *   Vhost log base.
 361  * @param[in] log_size
 362  *   Vhost log size.
 363  *
 364  * @return
 365  *   0 on success, a negative value otherwise.
 366  */
 367 int mlx5_vdpa_dirty_bitmap_set(struct mlx5_vdpa_priv *priv, uint64_t log_base,
 368                                uint64_t log_size);
 369
 370 /**
 371  * Log all virtqs information for live migration.
 372  *
 373  * @param[in] priv
 374  *   The vdpa driver private structure.
 375  * @param[in] enable
 376  *   Set for enable, unset for disable.
 377  *
 378  * @return
 379  *   0 on success, a negative value otherwise.
 380  */
 381 int mlx5_vdpa_lm_log(struct mlx5_vdpa_priv *priv);
 382
 383 /**
 384  * Modify virtq state to be ready or suspend.
 385  *
 386  * @param[in] virtq
 387  *   The vdpa driver private virtq structure.
 388  * @param[in] state
 389  *   Set for ready, otherwise suspend.
 390  *
 391  * @return
 392  *   0 on success, a negative value otherwise.
 393  */
 394 int mlx5_vdpa_virtq_modify(struct mlx5_vdpa_virtq *virtq, int state);
 395
 396 /**
 397  * Stop virtq before destroying it.
 398  *
 399  * @param[in] priv
 400  *   The vdpa driver private structure.
 401  * @param[in] index
 402  *   The virtq index.
 403  *
 404  * @return
 405  *   0 on success, a negative value otherwise.
 406  */
 407 int mlx5_vdpa_virtq_stop(struct mlx5_vdpa_priv *priv, int index);
 408
 409 /**
 410  * Query virtq information.
 411  *
 412  * @param[in] priv
 413  *   The vdpa driver private structure.
 414  * @param[in] index
 415  *   The virtq index.
 416  *
 417  * @return
 418  *   0 on success, a negative value otherwise.
 419  */
 420 int mlx5_vdpa_virtq_query(struct mlx5_vdpa_priv *priv, int index);
 421
 422 /**
 423  * Get virtq statistics.
 424  *
 425  * @param[in] priv
 426  *   The vdpa driver private structure.
 427  * @param[in] qid
 428  *   The virtq index.
 429  * @param stats
 430  *   The virtq statistics array to fill.
 431  * @param n
 432  *   The number of elements in @p stats array.
 433  *
 434  * @return
 435  *   A negative value on error, otherwise the number of entries filled in the
 436  *   @p stats array.
 437  */
 438 int
 439 mlx5_vdpa_virtq_stats_get(struct mlx5_vdpa_priv *priv, int qid,
 440                           struct rte_vdpa_stat *stats, unsigned int n);
 441
 442 /**
 443  * Reset virtq statistics.
 444  *
 445  * @param[in] priv
 446  *   The vdpa driver private structure.
 447  * @param[in] qid
 448  *   The virtq index.
 449  *
 450  * @return
 451  *   A negative value on error, otherwise 0.
 452  */
 453 int
 454 mlx5_vdpa_virtq_stats_reset(struct mlx5_vdpa_priv *priv, int qid);
 455 #endif /* RTE_PMD_MLX5_VDPA_H_ */