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 "-pedantic"
  44 #endif
  45 #include <infiniband/verbs.h>
  46 #ifdef PEDANTIC
  47 #pragma GCC diagnostic error "-pedantic"
  48 #endif
  49
  50 /* DPDK headers don't like -pedantic. */
  51 #ifdef PEDANTIC
  52 #pragma GCC diagnostic ignored "-pedantic"
  53 #endif
  54 #include <rte_mbuf.h>
  55 #include <rte_mempool.h>
  56 #ifdef PEDANTIC
  57 #pragma GCC diagnostic error "-pedantic"
  58 #endif
  59
  60 #include "mlx5_utils.h"
  61 #include "mlx5.h"
  62 #include "mlx5_autoconf.h"
  63 #include "mlx5_defs.h"
  64
  65 struct mlx5_rxq_stats {
  66         unsigned int idx; /**< Mapping index. */
  67 #ifdef MLX5_PMD_SOFT_COUNTERS
  68         uint64_t ipackets; /**< Total of successfully received packets. */
  69         uint64_t ibytes; /**< Total of successfully received bytes. */
  70 #endif
  71         uint64_t idropped; /**< Total of packets dropped when RX ring full. */
  72         uint64_t rx_nombuf; /**< Total of RX mbuf allocation failures. */
  73 };
  74
  75 struct mlx5_txq_stats {
  76         unsigned int idx; /**< Mapping index. */
  77 #ifdef MLX5_PMD_SOFT_COUNTERS
  78         uint64_t opackets; /**< Total of successfully sent packets. */
  79         uint64_t obytes; /**< Total of successfully sent bytes. */
  80 #endif
  81         uint64_t odropped; /**< Total of packets not sent when TX ring full. */
  82 };
  83
  84 /* RX element (scattered packets). */
  85 struct rxq_elt_sp {
  86         struct ibv_sge sges[MLX5_PMD_SGE_WR_N]; /* Scatter/Gather Elements. */
  87         struct rte_mbuf *bufs[MLX5_PMD_SGE_WR_N]; /* SGEs buffers. */
  88 };
  89
  90 /* RX element. */
  91 struct rxq_elt {
  92         struct ibv_sge sge; /* Scatter/Gather Element. */
  93         struct rte_mbuf *buf; /* SGE buffer. */
  94 };
  95
  96 /* Flow director queue structure. */
  97 struct fdir_queue {
  98         struct ibv_qp *qp; /* Associated RX QP. */
  99         struct ibv_exp_rwq_ind_table *ind_table; /* Indirection table. */
 100 };
 101
 102 struct priv;
 103
 104 /* RX queue descriptor. */
 105 struct rxq {
 106         struct priv *priv; /* Back pointer to private data. */
 107         struct rte_mempool *mp; /* Memory Pool for allocations. */
 108         struct ibv_mr *mr; /* Memory Region (for mp). */
 109         struct ibv_cq *cq; /* Completion Queue. */
 110         struct ibv_exp_wq *wq; /* Work Queue. */
 111         struct ibv_exp_wq_family *if_wq; /* WQ burst interface. */
 112         struct ibv_exp_cq_family *if_cq; /* CQ interface. */
 113         unsigned int port_id; /* Port ID for incoming packets. */
 114         unsigned int elts_n; /* (*elts)[] length. */
 115         unsigned int elts_head; /* Current index in (*elts)[]. */
 116         union {
 117                 struct rxq_elt_sp (*sp)[]; /* Scattered RX elements. */
 118                 struct rxq_elt (*no_sp)[]; /* RX elements. */
 119         } elts;
 120         unsigned int sp:1; /* Use scattered RX elements. */
 121         unsigned int csum:1; /* Enable checksum offloading. */
 122         unsigned int csum_l2tun:1; /* Same for L2 tunnels. */
 123         uint32_t mb_len; /* Length of a mp-issued mbuf. */
 124         struct mlx5_rxq_stats stats; /* RX queue counters. */
 125         unsigned int socket; /* CPU socket ID for allocations. */
 126         struct ibv_exp_res_domain *rd; /* Resource Domain. */
 127         struct fdir_queue fdir_queue; /* Flow director queue. */
 128 };
 129
 130 /* Hash RX queue types. */
 131 enum hash_rxq_type {
 132         HASH_RXQ_TCPV4,
 133         HASH_RXQ_UDPV4,
 134         HASH_RXQ_IPV4,
 135 #ifdef HAVE_FLOW_SPEC_IPV6
 136         HASH_RXQ_TCPV6,
 137         HASH_RXQ_UDPV6,
 138         HASH_RXQ_IPV6,
 139 #endif /* HAVE_FLOW_SPEC_IPV6 */
 140         HASH_RXQ_ETH,
 141 };
 142
 143 /* Flow structure with Ethernet specification. It is packed to prevent padding
 144  * between attr and spec as this layout is expected by libibverbs. */
 145 struct flow_attr_spec_eth {
 146         struct ibv_exp_flow_attr attr;
 147         struct ibv_exp_flow_spec_eth spec;
 148 } __attribute__((packed));
 149
 150 /* Define a struct flow_attr_spec_eth object as an array of at least
 151  * "size" bytes. Room after the first index is normally used to store
 152  * extra flow specifications. */
 153 #define FLOW_ATTR_SPEC_ETH(name, size) \
 154         struct flow_attr_spec_eth name \
 155                 [((size) / sizeof(struct flow_attr_spec_eth)) + \
 156                  !!((size) % sizeof(struct flow_attr_spec_eth))]
 157
 158 /* Initialization data for hash RX queue. */
 159 struct hash_rxq_init {
 160         uint64_t hash_fields; /* Fields that participate in the hash. */
 161         uint64_t dpdk_rss_hf; /* Matching DPDK RSS hash fields. */
 162         unsigned int flow_priority; /* Flow priority to use. */
 163         union {
 164                 struct {
 165                         enum ibv_exp_flow_spec_type type;
 166                         uint16_t size;
 167                 } hdr;
 168                 struct ibv_exp_flow_spec_tcp_udp tcp_udp;
 169                 struct ibv_exp_flow_spec_ipv4 ipv4;
 170 #ifdef HAVE_FLOW_SPEC_IPV6
 171                 struct ibv_exp_flow_spec_ipv6 ipv6;
 172 #endif /* HAVE_FLOW_SPEC_IPV6 */
 173                 struct ibv_exp_flow_spec_eth eth;
 174         } flow_spec; /* Flow specification template. */
 175         const struct hash_rxq_init *underlayer; /* Pointer to underlayer. */
 176 };
 177
 178 /* Initialization data for indirection table. */
 179 struct ind_table_init {
 180         unsigned int max_size; /* Maximum number of WQs. */
 181         /* Hash RX queues using this table. */
 182         unsigned int hash_types;
 183         unsigned int hash_types_n;
 184 };
 185
 186 /* Initialization data for special flows. */
 187 struct special_flow_init {
 188         uint8_t dst_mac_val[6];
 189         uint8_t dst_mac_mask[6];
 190         unsigned int hash_types;
 191 };
 192
 193 enum hash_rxq_flow_type {
 194         HASH_RXQ_FLOW_TYPE_PROMISC,
 195         HASH_RXQ_FLOW_TYPE_ALLMULTI,
 196         HASH_RXQ_FLOW_TYPE_BROADCAST,
 197         HASH_RXQ_FLOW_TYPE_IPV6MULTI,
 198         HASH_RXQ_FLOW_TYPE_MAC,
 199 };
 200
 201 #ifndef NDEBUG
 202 static inline const char *
 203 hash_rxq_flow_type_str(enum hash_rxq_flow_type flow_type)
 204 {
 205         switch (flow_type) {
 206         case HASH_RXQ_FLOW_TYPE_PROMISC:
 207                 return "promiscuous";
 208         case HASH_RXQ_FLOW_TYPE_ALLMULTI:
 209                 return "allmulticast";
 210         case HASH_RXQ_FLOW_TYPE_BROADCAST:
 211                 return "broadcast";
 212         case HASH_RXQ_FLOW_TYPE_IPV6MULTI:
 213                 return "IPv6 multicast";
 214         case HASH_RXQ_FLOW_TYPE_MAC:
 215                 return "MAC";
 216         }
 217         return NULL;
 218 }
 219 #endif /* NDEBUG */
 220
 221 struct hash_rxq {
 222         struct priv *priv; /* Back pointer to private data. */
 223         struct ibv_qp *qp; /* Hash RX QP. */
 224         enum hash_rxq_type type; /* Hash RX queue type. */
 225         /* MAC flow steering rules, one per VLAN ID. */
 226         struct ibv_exp_flow *mac_flow[MLX5_MAX_MAC_ADDRESSES][MLX5_MAX_VLAN_IDS];
 227         struct ibv_exp_flow *special_flow[MLX5_MAX_SPECIAL_FLOWS];
 228 };
 229
 230 /* TX element. */
 231 struct txq_elt {
 232         struct rte_mbuf *buf;
 233 };
 234
 235 /* Linear buffer type. It is used when transmitting buffers with too many
 236  * segments that do not fit the hardware queue (see max_send_sge).
 237  * Extra segments are copied (linearized) in such buffers, replacing the
 238  * last SGE during TX.
 239  * The size is arbitrary but large enough to hold a jumbo frame with
 240  * 8 segments considering mbuf.buf_len is about 2048 bytes. */
 241 typedef uint8_t linear_t[16384];
 242
 243 /* TX queue descriptor. */
 244 struct txq {
 245         struct priv *priv; /* Back pointer to private data. */
 246         struct {
 247                 const struct rte_mempool *mp; /* Cached Memory Pool. */
 248                 struct ibv_mr *mr; /* Memory Region (for mp). */
 249                 uint32_t lkey; /* mr->lkey */
 250         } mp2mr[MLX5_PMD_TX_MP_CACHE]; /* MP to MR translation table. */
 251         struct ibv_cq *cq; /* Completion Queue. */
 252         struct ibv_qp *qp; /* Queue Pair. */
 253         struct ibv_exp_qp_burst_family *if_qp; /* QP burst interface. */
 254         struct ibv_exp_cq_family *if_cq; /* CQ interface. */
 255 #if MLX5_PMD_MAX_INLINE > 0
 256         uint32_t max_inline; /* Max inline send size <= MLX5_PMD_MAX_INLINE. */
 257 #endif
 258         unsigned int elts_n; /* (*elts)[] length. */
 259         struct txq_elt (*elts)[]; /* TX elements. */
 260         unsigned int elts_head; /* Current index in (*elts)[]. */
 261         unsigned int elts_tail; /* First element awaiting completion. */
 262         unsigned int elts_comp; /* Number of completion requests. */
 263         unsigned int elts_comp_cd; /* Countdown for next completion request. */
 264         unsigned int elts_comp_cd_init; /* Initial value for countdown. */
 265         struct mlx5_txq_stats stats; /* TX queue counters. */
 266         linear_t (*elts_linear)[]; /* Linearized buffers. */
 267         struct ibv_mr *mr_linear; /* Memory Region for linearized buffers. */
 268         unsigned int socket; /* CPU socket ID for allocations. */
 269         struct ibv_exp_res_domain *rd; /* Resource Domain. */
 270 };
 271
 272 /* mlx5_rxq.c */
 273
 274 extern const struct hash_rxq_init hash_rxq_init[];
 275 extern const unsigned int hash_rxq_init_n;
 276
 277 extern uint8_t rss_hash_default_key[];
 278 extern const size_t rss_hash_default_key_len;
 279
 280 size_t priv_flow_attr(struct priv *, struct ibv_exp_flow_attr *,
 281                       size_t, enum hash_rxq_type);
 282 int priv_create_hash_rxqs(struct priv *);
 283 void priv_destroy_hash_rxqs(struct priv *);
 284 int priv_allow_flow_type(struct priv *, enum hash_rxq_flow_type);
 285 int priv_rehash_flows(struct priv *);
 286 void rxq_cleanup(struct rxq *);
 287 int rxq_rehash(struct rte_eth_dev *, struct rxq *);
 288 int rxq_setup(struct rte_eth_dev *, struct rxq *, uint16_t, unsigned int,
 289               const struct rte_eth_rxconf *, struct rte_mempool *);
 290 int mlx5_rx_queue_setup(struct rte_eth_dev *, uint16_t, uint16_t, unsigned int,
 291                         const struct rte_eth_rxconf *, struct rte_mempool *);
 292 void mlx5_rx_queue_release(void *);
 293
 294 /* mlx5_txq.c */
 295
 296 void txq_cleanup(struct txq *);
 297 int mlx5_tx_queue_setup(struct rte_eth_dev *, uint16_t, uint16_t, unsigned int,
 298                         const struct rte_eth_txconf *);
 299 void mlx5_tx_queue_release(void *);
 300
 301 /* mlx5_rxtx.c */
 302
 303 void txq_mp2mr_iter(const struct rte_mempool *, void *);
 304 uint16_t mlx5_tx_burst(void *, struct rte_mbuf **, uint16_t);
 305 uint16_t mlx5_rx_burst_sp(void *, struct rte_mbuf **, uint16_t);
 306 uint16_t mlx5_rx_burst(void *, struct rte_mbuf **, uint16_t);
 307 uint16_t removed_tx_burst(void *, struct rte_mbuf **, uint16_t);
 308 uint16_t removed_rx_burst(void *, struct rte_mbuf **, uint16_t);
 309
 310 #endif /* RTE_PMD_MLX5_RXTX_H_ */