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