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. */
  85 struct rxq_elt {
  86         struct ibv_sge sge; /* Scatter/Gather Element. */
  87         struct rte_mbuf *buf; /* SGE buffer. */
  88 };
  89
  90 /* Flow director queue structure. */
  91 struct fdir_queue {
  92         struct ibv_qp *qp; /* Associated RX QP. */
  93         struct ibv_exp_rwq_ind_table *ind_table; /* Indirection table. */
  94 };
  95
  96 struct priv;
  97
  98 /* RX queue descriptor. */
  99 struct rxq {
 100         struct priv *priv; /* Back pointer to private data. */
 101         struct rte_mempool *mp; /* Memory Pool for allocations. */
 102         struct ibv_cq *cq; /* Completion Queue. */
 103         struct ibv_exp_wq *wq; /* Work Queue. */
 104         int32_t (*poll)(); /* Verbs poll function. */
 105         int32_t (*recv)(); /* Verbs receive function. */
 106         unsigned int port_id; /* Port ID for incoming packets. */
 107         unsigned int elts_n; /* (*elts)[] length. */
 108         unsigned int elts_head; /* Current index in (*elts)[]. */
 109         unsigned int csum:1; /* Enable checksum offloading. */
 110         unsigned int csum_l2tun:1; /* Same for L2 tunnels. */
 111         unsigned int vlan_strip:1; /* Enable VLAN stripping. */
 112         unsigned int crc_present:1; /* CRC must be subtracted. */
 113         struct rxq_elt (*elts)[]; /* RX elements. */
 114         struct mlx5_rxq_stats stats; /* RX queue counters. */
 115 } __rte_cache_aligned;
 116
 117 /* RX queue control descriptor. */
 118 struct rxq_ctrl {
 119         struct ibv_exp_res_domain *rd; /* Resource Domain. */
 120         struct fdir_queue fdir_queue; /* Flow director queue. */
 121         struct ibv_mr *mr; /* Memory Region (for mp). */
 122         struct ibv_exp_wq_family *if_wq; /* WQ burst interface. */
 123 #ifdef HAVE_EXP_DEVICE_ATTR_VLAN_OFFLOADS
 124         struct ibv_exp_cq_family_v1 *if_cq; /* CQ interface. */
 125 #else /* HAVE_EXP_DEVICE_ATTR_VLAN_OFFLOADS */
 126         struct ibv_exp_cq_family *if_cq; /* CQ interface. */
 127 #endif /* HAVE_EXP_DEVICE_ATTR_VLAN_OFFLOADS */
 128         unsigned int socket; /* CPU socket ID for allocations. */
 129         struct rxq rxq; /* Data path structure. */
 130 };
 131
 132 /* Hash RX queue types. */
 133 enum hash_rxq_type {
 134         HASH_RXQ_TCPV4,
 135         HASH_RXQ_UDPV4,
 136         HASH_RXQ_IPV4,
 137 #ifdef HAVE_FLOW_SPEC_IPV6
 138         HASH_RXQ_TCPV6,
 139         HASH_RXQ_UDPV6,
 140         HASH_RXQ_IPV6,
 141 #endif /* HAVE_FLOW_SPEC_IPV6 */
 142         HASH_RXQ_ETH,
 143 };
 144
 145 /* Flow structure with Ethernet specification. It is packed to prevent padding
 146  * between attr and spec as this layout is expected by libibverbs. */
 147 struct flow_attr_spec_eth {
 148         struct ibv_exp_flow_attr attr;
 149         struct ibv_exp_flow_spec_eth spec;
 150 } __attribute__((packed));
 151
 152 /* Define a struct flow_attr_spec_eth object as an array of at least
 153  * "size" bytes. Room after the first index is normally used to store
 154  * extra flow specifications. */
 155 #define FLOW_ATTR_SPEC_ETH(name, size) \
 156         struct flow_attr_spec_eth name \
 157                 [((size) / sizeof(struct flow_attr_spec_eth)) + \
 158                  !!((size) % sizeof(struct flow_attr_spec_eth))]
 159
 160 /* Initialization data for hash RX queue. */
 161 struct hash_rxq_init {
 162         uint64_t hash_fields; /* Fields that participate in the hash. */
 163         uint64_t dpdk_rss_hf; /* Matching DPDK RSS hash fields. */
 164         unsigned int flow_priority; /* Flow priority to use. */
 165         union {
 166                 struct {
 167                         enum ibv_exp_flow_spec_type type;
 168                         uint16_t size;
 169                 } hdr;
 170                 struct ibv_exp_flow_spec_tcp_udp tcp_udp;
 171                 struct ibv_exp_flow_spec_ipv4 ipv4;
 172 #ifdef HAVE_FLOW_SPEC_IPV6
 173                 struct ibv_exp_flow_spec_ipv6 ipv6;
 174 #endif /* HAVE_FLOW_SPEC_IPV6 */
 175                 struct ibv_exp_flow_spec_eth eth;
 176         } flow_spec; /* Flow specification template. */
 177         const struct hash_rxq_init *underlayer; /* Pointer to underlayer. */
 178 };
 179
 180 /* Initialization data for indirection table. */
 181 struct ind_table_init {
 182         unsigned int max_size; /* Maximum number of WQs. */
 183         /* Hash RX queues using this table. */
 184         unsigned int hash_types;
 185         unsigned int hash_types_n;
 186 };
 187
 188 /* Initialization data for special flows. */
 189 struct special_flow_init {
 190         uint8_t dst_mac_val[6];
 191         uint8_t dst_mac_mask[6];
 192         unsigned int hash_types;
 193         unsigned int per_vlan:1;
 194 };
 195
 196 enum hash_rxq_flow_type {
 197         HASH_RXQ_FLOW_TYPE_PROMISC,
 198         HASH_RXQ_FLOW_TYPE_ALLMULTI,
 199         HASH_RXQ_FLOW_TYPE_BROADCAST,
 200         HASH_RXQ_FLOW_TYPE_IPV6MULTI,
 201         HASH_RXQ_FLOW_TYPE_MAC,
 202 };
 203
 204 #ifndef NDEBUG
 205 static inline const char *
 206 hash_rxq_flow_type_str(enum hash_rxq_flow_type flow_type)
 207 {
 208         switch (flow_type) {
 209         case HASH_RXQ_FLOW_TYPE_PROMISC:
 210                 return "promiscuous";
 211         case HASH_RXQ_FLOW_TYPE_ALLMULTI:
 212                 return "allmulticast";
 213         case HASH_RXQ_FLOW_TYPE_BROADCAST:
 214                 return "broadcast";
 215         case HASH_RXQ_FLOW_TYPE_IPV6MULTI:
 216                 return "IPv6 multicast";
 217         case HASH_RXQ_FLOW_TYPE_MAC:
 218                 return "MAC";
 219         }
 220         return NULL;
 221 }
 222 #endif /* NDEBUG */
 223
 224 struct hash_rxq {
 225         struct priv *priv; /* Back pointer to private data. */
 226         struct ibv_qp *qp; /* Hash RX QP. */
 227         enum hash_rxq_type type; /* Hash RX queue type. */
 228         /* MAC flow steering rules, one per VLAN ID. */
 229         struct ibv_exp_flow *mac_flow
 230                 [MLX5_MAX_MAC_ADDRESSES][MLX5_MAX_VLAN_IDS];
 231         struct ibv_exp_flow *special_flow
 232                 [MLX5_MAX_SPECIAL_FLOWS][MLX5_MAX_VLAN_IDS];
 233 };
 234
 235 /* TX element. */
 236 struct txq_elt {
 237         struct rte_mbuf *buf;
 238 };
 239
 240 /* TX queue descriptor. */
 241 struct txq {
 242         struct priv *priv; /* Back pointer to private data. */
 243         int32_t (*poll_cnt)(struct ibv_cq *cq, uint32_t max);
 244         int (*send_pending)();
 245 #ifdef HAVE_VERBS_VLAN_INSERTION
 246         int (*send_pending_vlan)();
 247 #endif
 248         int (*send_flush)(struct ibv_qp *qp);
 249         struct ibv_cq *cq; /* Completion Queue. */
 250         struct ibv_qp *qp; /* Queue Pair. */
 251         struct txq_elt (*elts)[]; /* TX elements. */
 252         unsigned int elts_n; /* (*elts)[] length. */
 253         unsigned int elts_head; /* Current index in (*elts)[]. */
 254         unsigned int elts_tail; /* First element awaiting completion. */
 255         unsigned int elts_comp; /* Number of completion requests. */
 256         unsigned int elts_comp_cd; /* Countdown for next completion request. */
 257         unsigned int elts_comp_cd_init; /* Initial value for countdown. */
 258         struct {
 259                 const struct rte_mempool *mp; /* Cached Memory Pool. */
 260                 struct ibv_mr *mr; /* Memory Region (for mp). */
 261                 uint32_t lkey; /* mr->lkey */
 262         } mp2mr[MLX5_PMD_TX_MP_CACHE]; /* MP to MR translation table. */
 263         struct mlx5_txq_stats stats; /* TX queue counters. */
 264 } __rte_cache_aligned;
 265
 266 /* TX queue control descriptor. */
 267 struct txq_ctrl {
 268 #ifdef HAVE_VERBS_VLAN_INSERTION
 269         struct ibv_exp_qp_burst_family_v1 *if_qp; /* QP burst interface. */
 270 #else
 271         struct ibv_exp_qp_burst_family *if_qp; /* QP burst interface. */
 272 #endif
 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         struct txq txq; /* Data path structure. */
 277 };
 278
 279 /* mlx5_rxq.c */
 280
 281 extern const struct hash_rxq_init hash_rxq_init[];
 282 extern const unsigned int hash_rxq_init_n;
 283
 284 extern uint8_t rss_hash_default_key[];
 285 extern const size_t rss_hash_default_key_len;
 286
 287 size_t priv_flow_attr(struct priv *, struct ibv_exp_flow_attr *,
 288                       size_t, enum hash_rxq_type);
 289 int priv_create_hash_rxqs(struct priv *);
 290 void priv_destroy_hash_rxqs(struct priv *);
 291 int priv_allow_flow_type(struct priv *, enum hash_rxq_flow_type);
 292 int priv_rehash_flows(struct priv *);
 293 void rxq_cleanup(struct rxq_ctrl *);
 294 int rxq_rehash(struct rte_eth_dev *, struct rxq_ctrl *);
 295 int rxq_setup(struct rte_eth_dev *, struct rxq_ctrl *, uint16_t, unsigned int,
 296               const struct rte_eth_rxconf *, struct rte_mempool *);
 297 int mlx5_rx_queue_setup(struct rte_eth_dev *, uint16_t, uint16_t, unsigned int,
 298                         const struct rte_eth_rxconf *, struct rte_mempool *);
 299 void mlx5_rx_queue_release(void *);
 300 uint16_t mlx5_rx_burst_secondary_setup(void *, struct rte_mbuf **, uint16_t);
 301
 302 /* mlx5_txq.c */
 303
 304 void txq_cleanup(struct txq_ctrl *);
 305 int txq_setup(struct rte_eth_dev *, struct txq_ctrl *, uint16_t, unsigned int,
 306               const struct rte_eth_txconf *);
 307 int mlx5_tx_queue_setup(struct rte_eth_dev *, uint16_t, uint16_t, unsigned int,
 308                         const struct rte_eth_txconf *);
 309 void mlx5_tx_queue_release(void *);
 310 uint16_t mlx5_tx_burst_secondary_setup(void *, struct rte_mbuf **, uint16_t);
 311
 312 /* mlx5_rxtx.c */
 313
 314 uint16_t mlx5_tx_burst(void *, struct rte_mbuf **, uint16_t);
 315 uint16_t mlx5_rx_burst(void *, struct rte_mbuf **, uint16_t);
 316 uint16_t removed_tx_burst(void *, struct rte_mbuf **, uint16_t);
 317 uint16_t removed_rx_burst(void *, struct rte_mbuf **, uint16_t);
 318
 319 /* mlx5_mr.c */
 320
 321 struct ibv_mr *mlx5_mp2mr(struct ibv_pd *, struct rte_mempool *);
 322 void txq_mp2mr_iter(struct rte_mempool *, void *);
 323 uint32_t txq_mp2mr_reg(struct txq *, struct rte_mempool *, unsigned int);
 324
 325 #endif /* RTE_PMD_MLX5_RXTX_H_ */