4 * Copyright 2015 6WIND S.A.
5 * Copyright 2015 Mellanox.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
34 #ifndef RTE_PMD_MLX5_RXTX_H_
35 #define RTE_PMD_MLX5_RXTX_H_
41 /* ISO C doesn't support unnamed structs/unions, disabling -pedantic. */
43 #pragma GCC diagnostic ignored "-pedantic"
45 #include <infiniband/verbs.h>
47 #pragma GCC diagnostic error "-pedantic"
50 /* DPDK headers don't like -pedantic. */
52 #pragma GCC diagnostic ignored "-pedantic"
55 #include <rte_mempool.h>
57 #pragma GCC diagnostic error "-pedantic"
60 #include "mlx5_utils.h"
62 #include "mlx5_defs.h"
64 struct mlx5_rxq_stats {
65 unsigned int idx; /**< Mapping index. */
66 #ifdef MLX5_PMD_SOFT_COUNTERS
67 uint64_t ipackets; /**< Total of successfully received packets. */
68 uint64_t ibytes; /**< Total of successfully received bytes. */
70 uint64_t idropped; /**< Total of packets dropped when RX ring full. */
71 uint64_t rx_nombuf; /**< Total of RX mbuf allocation failures. */
74 struct mlx5_txq_stats {
75 unsigned int idx; /**< Mapping index. */
76 #ifdef MLX5_PMD_SOFT_COUNTERS
77 uint64_t opackets; /**< Total of successfully sent packets. */
78 uint64_t obytes; /**< Total of successfully sent bytes. */
80 uint64_t odropped; /**< Total of packets not sent when TX ring full. */
83 /* RX element (scattered packets). */
85 struct ibv_sge sges[MLX5_PMD_SGE_WR_N]; /* Scatter/Gather Elements. */
86 struct rte_mbuf *bufs[MLX5_PMD_SGE_WR_N]; /* SGEs buffers. */
91 struct ibv_sge sge; /* Scatter/Gather Element. */
92 struct rte_mbuf *buf; /* SGE buffer. */
97 /* RX queue descriptor. */
99 struct priv *priv; /* Back pointer to private data. */
100 struct rte_mempool *mp; /* Memory Pool for allocations. */
101 struct ibv_mr *mr; /* Memory Region (for mp). */
102 struct ibv_cq *cq; /* Completion Queue. */
103 struct ibv_exp_wq *wq; /* Work Queue. */
104 struct ibv_exp_wq_family *if_wq; /* WQ burst interface. */
105 struct ibv_exp_cq_family *if_cq; /* CQ interface. */
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)[]. */
110 struct rxq_elt_sp (*sp)[]; /* Scattered RX elements. */
111 struct rxq_elt (*no_sp)[]; /* RX elements. */
113 unsigned int sp:1; /* Use scattered RX elements. */
114 unsigned int csum:1; /* Enable checksum offloading. */
115 unsigned int csum_l2tun:1; /* Same for L2 tunnels. */
116 uint32_t mb_len; /* Length of a mp-issued mbuf. */
117 struct mlx5_rxq_stats stats; /* RX queue counters. */
118 unsigned int socket; /* CPU socket ID for allocations. */
119 struct ibv_exp_res_domain *rd; /* Resource Domain. */
122 /* Hash RX queue types. */
130 /* Flow structure with Ethernet specification. It is packed to prevent padding
131 * between attr and spec as this layout is expected by libibverbs. */
132 struct flow_attr_spec_eth {
133 struct ibv_flow_attr attr;
134 struct ibv_flow_spec_eth spec;
135 } __attribute__((packed));
137 /* Define a struct flow_attr_spec_eth object as an array of at least
138 * "size" bytes. Room after the first index is normally used to store
139 * extra flow specifications. */
140 #define FLOW_ATTR_SPEC_ETH(name, size) \
141 struct flow_attr_spec_eth name \
142 [((size) / sizeof(struct flow_attr_spec_eth)) + \
143 !!((size) % sizeof(struct flow_attr_spec_eth))]
145 /* Initialization data for hash RX queue. */
146 struct hash_rxq_init {
147 uint64_t hash_fields; /* Fields that participate in the hash. */
148 uint64_t dpdk_rss_hf; /* Matching DPDK RSS hash fields. */
149 unsigned int flow_priority; /* Flow priority to use. */
150 struct ibv_flow_spec flow_spec; /* Flow specification template. */
151 const struct hash_rxq_init *underlayer; /* Pointer to underlayer. */
154 /* Initialization data for indirection table. */
155 struct ind_table_init {
156 unsigned int max_size; /* Maximum number of WQs. */
157 /* Hash RX queues using this table. */
158 unsigned int hash_types;
159 unsigned int hash_types_n;
163 struct priv *priv; /* Back pointer to private data. */
164 struct ibv_qp *qp; /* Hash RX QP. */
165 enum hash_rxq_type type; /* Hash RX queue type. */
166 /* MAC flow steering rules, one per VLAN ID. */
167 struct ibv_flow *mac_flow[MLX5_MAX_MAC_ADDRESSES][MLX5_MAX_VLAN_IDS];
168 struct ibv_flow *promisc_flow; /* Promiscuous flow. */
169 struct ibv_flow *allmulti_flow; /* Multicast flow. */
174 struct rte_mbuf *buf;
177 /* Linear buffer type. It is used when transmitting buffers with too many
178 * segments that do not fit the hardware queue (see max_send_sge).
179 * Extra segments are copied (linearized) in such buffers, replacing the
180 * last SGE during TX.
181 * The size is arbitrary but large enough to hold a jumbo frame with
182 * 8 segments considering mbuf.buf_len is about 2048 bytes. */
183 typedef uint8_t linear_t[16384];
185 /* TX queue descriptor. */
187 struct priv *priv; /* Back pointer to private data. */
189 struct rte_mempool *mp; /* Cached Memory Pool. */
190 struct ibv_mr *mr; /* Memory Region (for mp). */
191 uint32_t lkey; /* mr->lkey */
192 } mp2mr[MLX5_PMD_TX_MP_CACHE]; /* MP to MR translation table. */
193 struct ibv_cq *cq; /* Completion Queue. */
194 struct ibv_qp *qp; /* Queue Pair. */
195 struct ibv_exp_qp_burst_family *if_qp; /* QP burst interface. */
196 struct ibv_exp_cq_family *if_cq; /* CQ interface. */
197 #if MLX5_PMD_MAX_INLINE > 0
198 uint32_t max_inline; /* Max inline send size <= MLX5_PMD_MAX_INLINE. */
200 unsigned int elts_n; /* (*elts)[] length. */
201 struct txq_elt (*elts)[]; /* TX elements. */
202 unsigned int elts_head; /* Current index in (*elts)[]. */
203 unsigned int elts_tail; /* First element awaiting completion. */
204 unsigned int elts_comp; /* Number of completion requests. */
205 unsigned int elts_comp_cd; /* Countdown for next completion request. */
206 unsigned int elts_comp_cd_init; /* Initial value for countdown. */
207 struct mlx5_txq_stats stats; /* TX queue counters. */
208 linear_t (*elts_linear)[]; /* Linearized buffers. */
209 struct ibv_mr *mr_linear; /* Memory Region for linearized buffers. */
210 unsigned int socket; /* CPU socket ID for allocations. */
211 struct ibv_exp_res_domain *rd; /* Resource Domain. */
216 extern const struct hash_rxq_init hash_rxq_init[];
217 extern const unsigned int hash_rxq_init_n;
219 extern uint8_t rss_hash_default_key[];
220 extern const size_t rss_hash_default_key_len;
222 size_t hash_rxq_flow_attr(const struct hash_rxq *, struct ibv_flow_attr *,
224 int priv_create_hash_rxqs(struct priv *);
225 void priv_destroy_hash_rxqs(struct priv *);
226 void rxq_cleanup(struct rxq *);
227 int rxq_rehash(struct rte_eth_dev *, struct rxq *);
228 int rxq_setup(struct rte_eth_dev *, struct rxq *, uint16_t, unsigned int,
229 const struct rte_eth_rxconf *, struct rte_mempool *);
230 int mlx5_rx_queue_setup(struct rte_eth_dev *, uint16_t, uint16_t, unsigned int,
231 const struct rte_eth_rxconf *, struct rte_mempool *);
232 void mlx5_rx_queue_release(void *);
236 void txq_cleanup(struct txq *);
237 int mlx5_tx_queue_setup(struct rte_eth_dev *, uint16_t, uint16_t, unsigned int,
238 const struct rte_eth_txconf *);
239 void mlx5_tx_queue_release(void *);
243 uint16_t mlx5_tx_burst(void *, struct rte_mbuf **, uint16_t);
244 uint16_t mlx5_rx_burst_sp(void *, struct rte_mbuf **, uint16_t);
245 uint16_t mlx5_rx_burst(void *, struct rte_mbuf **, uint16_t);
246 uint16_t removed_tx_burst(void *, struct rte_mbuf **, uint16_t);
247 uint16_t removed_rx_burst(void *, struct rte_mbuf **, uint16_t);
249 #endif /* RTE_PMD_MLX5_RXTX_H_ */