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