drivers/net/mlx5/mlx5_rxtx.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright 2015 6WIND S.A.
   5  *   Copyright 2015 Mellanox.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of 6WIND S.A. nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef RTE_PMD_MLX5_RXTX_H_
  35 #define RTE_PMD_MLX5_RXTX_H_
  36
  37 #include <stddef.h>
  38 #include <stdint.h>
  39
  40 /* Verbs header. */
  41 /* ISO C doesn't support unnamed structs/unions, disabling -pedantic. */
  42 #ifdef PEDANTIC
  43 #pragma GCC diagnostic ignored "-Wpedantic"
  44 #endif
  45 #include <infiniband/verbs.h>
  46 #include <infiniband/mlx5_hw.h>
  47 #ifdef PEDANTIC
  48 #pragma GCC diagnostic error "-Wpedantic"
  49 #endif
  50
  51 /* DPDK headers don't like -pedantic. */
  52 #ifdef PEDANTIC
  53 #pragma GCC diagnostic ignored "-Wpedantic"
  54 #endif
  55 #include <rte_mbuf.h>
  56 #include <rte_mempool.h>
  57 #include <rte_common.h>
  58 #ifdef PEDANTIC
  59 #pragma GCC diagnostic error "-Wpedantic"
  60 #endif
  61
  62 #include "mlx5_utils.h"
  63 #include "mlx5.h"
  64 #include "mlx5_autoconf.h"
  65 #include "mlx5_defs.h"
  66 #include "mlx5_prm.h"
  67
  68 struct mlx5_rxq_stats {
  69         unsigned int idx; /**< Mapping index. */
  70 #ifdef MLX5_PMD_SOFT_COUNTERS
  71         uint64_t ipackets; /**< Total of successfully received packets. */
  72         uint64_t ibytes; /**< Total of successfully received bytes. */
  73 #endif
  74         uint64_t idropped; /**< Total of packets dropped when RX ring full. */
  75         uint64_t rx_nombuf; /**< Total of RX mbuf allocation failures. */
  76 };
  77
  78 struct mlx5_txq_stats {
  79         unsigned int idx; /**< Mapping index. */
  80 #ifdef MLX5_PMD_SOFT_COUNTERS
  81         uint64_t opackets; /**< Total of successfully sent packets. */
  82         uint64_t obytes; /**< Total of successfully sent bytes. */
  83 #endif
  84         uint64_t odropped; /**< Total of packets not sent when TX ring full. */
  85 };
  86
  87 /* Flow director queue structure. */
  88 struct fdir_queue {
  89         struct ibv_qp *qp; /* Associated RX QP. */
  90         struct ibv_exp_rwq_ind_table *ind_table; /* Indirection table. */
  91         struct ibv_exp_wq *wq; /* Work queue. */
  92         struct ibv_cq *cq; /* Completion queue. */
  93 };
  94
  95 struct priv;
  96
  97 /* Compressed CQE context. */
  98 struct rxq_zip {
  99         uint16_t ai; /* Array index. */
 100         uint16_t ca; /* Current array index. */
 101         uint16_t na; /* Next array index. */
 102         uint16_t cq_ci; /* The next CQE. */
 103         uint32_t cqe_cnt; /* Number of CQEs. */
 104 };
 105
 106 /* RX queue descriptor. */
 107 struct rxq {
 108         unsigned int csum:1; /* Enable checksum offloading. */
 109         unsigned int csum_l2tun:1; /* Same for L2 tunnels. */
 110         unsigned int vlan_strip:1; /* Enable VLAN stripping. */
 111         unsigned int crc_present:1; /* CRC must be subtracted. */
 112         unsigned int sges_n:2; /* Log 2 of SGEs (max buffers per packet). */
 113         unsigned int cqe_n:4; /* Log 2 of CQ elements. */
 114         unsigned int elts_n:4; /* Log 2 of Mbufs. */
 115         unsigned int port_id:8;
 116         unsigned int rss_hash:1; /* RSS hash result is enabled. */
 117         unsigned int mark:1; /* Marked flow available on the queue. */
 118         unsigned int :8; /* Remaining bits. */
 119         volatile uint32_t *rq_db;
 120         volatile uint32_t *cq_db;
 121         uint16_t rq_ci;
 122         uint16_t cq_ci;
 123         volatile struct mlx5_wqe_data_seg(*wqes)[];
 124         volatile struct mlx5_cqe(*cqes)[];
 125         struct rxq_zip zip; /* Compressed context. */
 126         struct rte_mbuf *(*elts)[];
 127         struct rte_mempool *mp;
 128         struct mlx5_rxq_stats stats;
 129 } __rte_cache_aligned;
 130
 131 /* RX queue control descriptor. */
 132 struct rxq_ctrl {
 133         struct priv *priv; /* Back pointer to private data. */
 134         struct ibv_cq *cq; /* Completion Queue. */
 135         struct ibv_exp_wq *wq; /* Work Queue. */
 136         struct ibv_exp_res_domain *rd; /* Resource Domain. */
 137         struct fdir_queue *fdir_queue; /* Flow director queue. */
 138         struct ibv_mr *mr; /* Memory Region (for mp). */
 139         struct ibv_exp_wq_family *if_wq; /* WQ burst interface. */
 140         struct ibv_exp_cq_family_v1 *if_cq; /* CQ interface. */
 141         unsigned int socket; /* CPU socket ID for allocations. */
 142         struct rxq rxq; /* Data path structure. */
 143 };
 144
 145 /* Hash RX queue types. */
 146 enum hash_rxq_type {
 147         HASH_RXQ_TCPV4,
 148         HASH_RXQ_UDPV4,
 149         HASH_RXQ_IPV4,
 150         HASH_RXQ_TCPV6,
 151         HASH_RXQ_UDPV6,
 152         HASH_RXQ_IPV6,
 153         HASH_RXQ_ETH,
 154 };
 155
 156 /* Flow structure with Ethernet specification. It is packed to prevent padding
 157  * between attr and spec as this layout is expected by libibverbs. */
 158 struct flow_attr_spec_eth {
 159         struct ibv_exp_flow_attr attr;
 160         struct ibv_exp_flow_spec_eth spec;
 161 } __attribute__((packed));
 162
 163 /* Define a struct flow_attr_spec_eth object as an array of at least
 164  * "size" bytes. Room after the first index is normally used to store
 165  * extra flow specifications. */
 166 #define FLOW_ATTR_SPEC_ETH(name, size) \
 167         struct flow_attr_spec_eth name \
 168                 [((size) / sizeof(struct flow_attr_spec_eth)) + \
 169                  !!((size) % sizeof(struct flow_attr_spec_eth))]
 170
 171 /* Initialization data for hash RX queue. */
 172 struct hash_rxq_init {
 173         uint64_t hash_fields; /* Fields that participate in the hash. */
 174         uint64_t dpdk_rss_hf; /* Matching DPDK RSS hash fields. */
 175         unsigned int flow_priority; /* Flow priority to use. */
 176         union {
 177                 struct {
 178                         enum ibv_exp_flow_spec_type type;
 179                         uint16_t size;
 180                 } hdr;
 181                 struct ibv_exp_flow_spec_tcp_udp tcp_udp;
 182                 struct ibv_exp_flow_spec_ipv4 ipv4;
 183                 struct ibv_exp_flow_spec_ipv6 ipv6;
 184                 struct ibv_exp_flow_spec_eth eth;
 185         } flow_spec; /* Flow specification template. */
 186         const struct hash_rxq_init *underlayer; /* Pointer to underlayer. */
 187 };
 188
 189 /* Initialization data for indirection table. */
 190 struct ind_table_init {
 191         unsigned int max_size; /* Maximum number of WQs. */
 192         /* Hash RX queues using this table. */
 193         unsigned int hash_types;
 194         unsigned int hash_types_n;
 195 };
 196
 197 /* Initialization data for special flows. */
 198 struct special_flow_init {
 199         uint8_t dst_mac_val[6];
 200         uint8_t dst_mac_mask[6];
 201         unsigned int hash_types;
 202         unsigned int per_vlan:1;
 203 };
 204
 205 enum hash_rxq_flow_type {
 206         HASH_RXQ_FLOW_TYPE_PROMISC,
 207         HASH_RXQ_FLOW_TYPE_ALLMULTI,
 208         HASH_RXQ_FLOW_TYPE_BROADCAST,
 209         HASH_RXQ_FLOW_TYPE_IPV6MULTI,
 210         HASH_RXQ_FLOW_TYPE_MAC,
 211 };
 212
 213 #ifndef NDEBUG
 214 static inline const char *
 215 hash_rxq_flow_type_str(enum hash_rxq_flow_type flow_type)
 216 {
 217         switch (flow_type) {
 218         case HASH_RXQ_FLOW_TYPE_PROMISC:
 219                 return "promiscuous";
 220         case HASH_RXQ_FLOW_TYPE_ALLMULTI:
 221                 return "allmulticast";
 222         case HASH_RXQ_FLOW_TYPE_BROADCAST:
 223                 return "broadcast";
 224         case HASH_RXQ_FLOW_TYPE_IPV6MULTI:
 225                 return "IPv6 multicast";
 226         case HASH_RXQ_FLOW_TYPE_MAC:
 227                 return "MAC";
 228         }
 229         return NULL;
 230 }
 231 #endif /* NDEBUG */
 232
 233 struct hash_rxq {
 234         struct priv *priv; /* Back pointer to private data. */
 235         struct ibv_qp *qp; /* Hash RX QP. */
 236         enum hash_rxq_type type; /* Hash RX queue type. */
 237         /* MAC flow steering rules, one per VLAN ID. */
 238         struct ibv_exp_flow *mac_flow
 239                 [MLX5_MAX_MAC_ADDRESSES][MLX5_MAX_VLAN_IDS];
 240         struct ibv_exp_flow *special_flow
 241                 [MLX5_MAX_SPECIAL_FLOWS][MLX5_MAX_VLAN_IDS];
 242 };
 243
 244 /* TX queue descriptor. */
 245 RTE_STD_C11
 246 struct txq {
 247         uint16_t elts_head; /* Current index in (*elts)[]. */
 248         uint16_t elts_tail; /* First element awaiting completion. */
 249         uint16_t elts_comp; /* Counter since last completion request. */
 250         uint16_t cq_ci; /* Consumer index for completion queue. */
 251         uint16_t wqe_ci; /* Consumer index for work queue. */
 252         uint16_t wqe_pi; /* Producer index for work queue. */
 253         uint16_t elts_n:4; /* (*elts)[] length (in log2). */
 254         uint16_t cqe_n:4; /* Number of CQ elements (in log2). */
 255         uint16_t wqe_n:4; /* Number of of WQ elements (in log2). */
 256         uint16_t max_inline; /* Multiple of RTE_CACHE_LINE_SIZE to inline. */
 257         uint16_t inline_en:1; /* When set inline is enabled. */
 258         uint16_t tso_en:1; /* When set hardware TSO is enabled. */
 259         uint32_t qp_num_8s; /* QP number shifted by 8. */
 260         volatile struct mlx5_cqe (*cqes)[]; /* Completion queue. */
 261         volatile void *wqes; /* Work queue (use volatile to write into). */
 262         volatile uint32_t *qp_db; /* Work queue doorbell. */
 263         volatile uint32_t *cq_db; /* Completion queue doorbell. */
 264         volatile void *bf_reg; /* Blueflame register. */
 265         struct {
 266                 const struct rte_mempool *mp; /* Cached Memory Pool. */
 267                 struct ibv_mr *mr; /* Memory Region (for mp). */
 268                 uint32_t lkey; /* htonl(mr->lkey) */
 269         } mp2mr[MLX5_PMD_TX_MP_CACHE]; /* MP to MR translation table. */
 270         struct rte_mbuf *(*elts)[]; /* TX elements. */
 271         struct mlx5_txq_stats stats; /* TX queue counters. */
 272 } __rte_cache_aligned;
 273
 274 /* TX queue control descriptor. */
 275 struct txq_ctrl {
 276         struct priv *priv; /* Back pointer to private data. */
 277         struct ibv_cq *cq; /* Completion Queue. */
 278         struct ibv_qp *qp; /* Queue Pair. */
 279         struct ibv_exp_qp_burst_family *if_qp; /* QP burst interface. */
 280         struct ibv_exp_cq_family *if_cq; /* CQ interface. */
 281         struct ibv_exp_res_domain *rd; /* Resource Domain. */
 282         unsigned int socket; /* CPU socket ID for allocations. */
 283         struct txq txq; /* Data path structure. */
 284 };
 285
 286 /* mlx5_rxq.c */
 287
 288 extern const struct hash_rxq_init hash_rxq_init[];
 289 extern const unsigned int hash_rxq_init_n;
 290
 291 extern uint8_t rss_hash_default_key[];
 292 extern const size_t rss_hash_default_key_len;
 293
 294 size_t priv_flow_attr(struct priv *, struct ibv_exp_flow_attr *,
 295                       size_t, enum hash_rxq_type);
 296 int priv_create_hash_rxqs(struct priv *);
 297 void priv_destroy_hash_rxqs(struct priv *);
 298 int priv_allow_flow_type(struct priv *, enum hash_rxq_flow_type);
 299 int priv_rehash_flows(struct priv *);
 300 void rxq_cleanup(struct rxq_ctrl *);
 301 int rxq_rehash(struct rte_eth_dev *, struct rxq_ctrl *);
 302 int rxq_ctrl_setup(struct rte_eth_dev *, struct rxq_ctrl *, uint16_t,
 303                    unsigned int, const struct rte_eth_rxconf *,
 304                    struct rte_mempool *);
 305 int mlx5_rx_queue_setup(struct rte_eth_dev *, uint16_t, uint16_t, unsigned int,
 306                         const struct rte_eth_rxconf *, struct rte_mempool *);
 307 void mlx5_rx_queue_release(void *);
 308 uint16_t mlx5_rx_burst_secondary_setup(void *, struct rte_mbuf **, uint16_t);
 309
 310 /* mlx5_txq.c */
 311
 312 void txq_cleanup(struct txq_ctrl *);
 313 int txq_ctrl_setup(struct rte_eth_dev *, struct txq_ctrl *, uint16_t,
 314                    unsigned int, const struct rte_eth_txconf *);
 315 int mlx5_tx_queue_setup(struct rte_eth_dev *, uint16_t, uint16_t, unsigned int,
 316                         const struct rte_eth_txconf *);
 317 void mlx5_tx_queue_release(void *);
 318 uint16_t mlx5_tx_burst_secondary_setup(void *, struct rte_mbuf **, uint16_t);
 319
 320 /* mlx5_rxtx.c */
 321
 322 uint16_t mlx5_tx_burst(void *, struct rte_mbuf **, uint16_t);
 323 uint16_t mlx5_tx_burst_mpw(void *, struct rte_mbuf **, uint16_t);
 324 uint16_t mlx5_tx_burst_mpw_inline(void *, struct rte_mbuf **, uint16_t);
 325 uint16_t mlx5_rx_burst(void *, struct rte_mbuf **, uint16_t);
 326 uint16_t removed_tx_burst(void *, struct rte_mbuf **, uint16_t);
 327 uint16_t removed_rx_burst(void *, struct rte_mbuf **, uint16_t);
 328 int mlx5_rx_descriptor_status(void *, uint16_t);
 329 int mlx5_tx_descriptor_status(void *, uint16_t);
 330
 331 /* mlx5_mr.c */
 332
 333 struct ibv_mr *mlx5_mp2mr(struct ibv_pd *, struct rte_mempool *);
 334 void txq_mp2mr_iter(struct rte_mempool *, void *);
 335 uint32_t txq_mp2mr_reg(struct txq *, struct rte_mempool *, unsigned int);
 336
 337 #endif /* RTE_PMD_MLX5_RXTX_H_ */