1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2021 6WIND S.A.
3 * Copyright 2021 Mellanox Technologies, Ltd
6 #ifndef RTE_PMD_MLX5_TX_H_
7 #define RTE_PMD_MLX5_TX_H_
10 #include <sys/queue.h>
13 #include <rte_mempool.h>
14 #include <rte_common.h>
15 #include <rte_spinlock.h>
17 #include <mlx5_common.h>
18 #include <mlx5_common_mr.h>
21 #include "mlx5_autoconf.h"
23 /* TX burst subroutines return codes. */
24 enum mlx5_txcmp_code {
25 MLX5_TXCMP_CODE_EXIT = 0,
26 MLX5_TXCMP_CODE_ERROR,
27 MLX5_TXCMP_CODE_SINGLE,
28 MLX5_TXCMP_CODE_MULTI,
34 * These defines are used to configure Tx burst routine option set supported
35 * at compile time. The not specified options are optimized out due to if
36 * conditions can be explicitly calculated at compile time.
37 * The offloads with bigger runtime check (require more CPU cycles toskip)
38 * overhead should have the bigger index - this is needed to select the better
39 * matching routine function if no exact match and some offloads are not
42 #define MLX5_TXOFF_CONFIG_MULTI (1u << 0) /* Multi-segment packets.*/
43 #define MLX5_TXOFF_CONFIG_TSO (1u << 1) /* TCP send offload supported.*/
44 #define MLX5_TXOFF_CONFIG_SWP (1u << 2) /* Tunnels/SW Parser offloads.*/
45 #define MLX5_TXOFF_CONFIG_CSUM (1u << 3) /* Check Sums offloaded. */
46 #define MLX5_TXOFF_CONFIG_INLINE (1u << 4) /* Data inlining supported. */
47 #define MLX5_TXOFF_CONFIG_VLAN (1u << 5) /* VLAN insertion supported.*/
48 #define MLX5_TXOFF_CONFIG_METADATA (1u << 6) /* Flow metadata. */
49 #define MLX5_TXOFF_CONFIG_EMPW (1u << 8) /* Enhanced MPW supported.*/
50 #define MLX5_TXOFF_CONFIG_MPW (1u << 9) /* Legacy MPW supported.*/
51 #define MLX5_TXOFF_CONFIG_TXPP (1u << 10) /* Scheduling on timestamp.*/
53 /* The most common offloads groups. */
54 #define MLX5_TXOFF_CONFIG_NONE 0
55 #define MLX5_TXOFF_CONFIG_FULL (MLX5_TXOFF_CONFIG_MULTI | \
56 MLX5_TXOFF_CONFIG_TSO | \
57 MLX5_TXOFF_CONFIG_SWP | \
58 MLX5_TXOFF_CONFIG_CSUM | \
59 MLX5_TXOFF_CONFIG_INLINE | \
60 MLX5_TXOFF_CONFIG_VLAN | \
61 MLX5_TXOFF_CONFIG_METADATA)
63 #define MLX5_TXOFF_CONFIG(mask) (olx & MLX5_TXOFF_CONFIG_##mask)
65 #define MLX5_TXOFF_PRE_DECL(func) \
66 uint16_t mlx5_tx_burst_##func(void *txq, \
67 struct rte_mbuf **pkts, \
70 #define MLX5_TXOFF_DECL(func, olx) \
71 uint16_t mlx5_tx_burst_##func(void *txq, \
72 struct rte_mbuf **pkts, \
75 return mlx5_tx_burst_tmpl((struct mlx5_txq_data *)txq, \
76 pkts, pkts_n, (olx)); \
79 /* Mbuf dynamic flag offset for inline. */
80 extern uint64_t rte_net_mlx5_dynf_inline_mask;
81 #define RTE_MBUF_F_TX_DYNF_NOINLINE rte_net_mlx5_dynf_inline_mask
83 extern uint32_t mlx5_ptype_table[] __rte_cache_aligned;
84 extern uint8_t mlx5_cksum_table[1 << 10] __rte_cache_aligned;
85 extern uint8_t mlx5_swp_types_table[1 << 10] __rte_cache_aligned;
87 struct mlx5_txq_stats {
88 #ifdef MLX5_PMD_SOFT_COUNTERS
89 uint64_t opackets; /**< Total of successfully sent packets. */
90 uint64_t obytes; /**< Total of successfully sent bytes. */
92 uint64_t oerrors; /**< Total number of failed transmitted packets. */
95 /* TX queue send local data. */
97 struct mlx5_txq_local {
98 struct mlx5_wqe *wqe_last; /* last sent WQE pointer. */
99 struct rte_mbuf *mbuf; /* first mbuf to process. */
100 uint16_t pkts_copy; /* packets copied to elts. */
101 uint16_t pkts_sent; /* packets sent. */
102 uint16_t pkts_loop; /* packets sent on loop entry. */
103 uint16_t elts_free; /* available elts remain. */
104 uint16_t wqe_free; /* available wqe remain. */
105 uint16_t mbuf_off; /* data offset in current mbuf. */
106 uint16_t mbuf_nseg; /* number of remaining mbuf. */
107 uint16_t mbuf_free; /* number of inline mbufs to free. */
110 /* TX queue descriptor. */
112 struct mlx5_txq_data {
113 uint16_t elts_head; /* Current counter in (*elts)[]. */
114 uint16_t elts_tail; /* Counter of first element awaiting completion. */
115 uint16_t elts_comp; /* elts index since last completion request. */
116 uint16_t elts_s; /* Number of mbuf elements. */
117 uint16_t elts_m; /* Mask for mbuf elements indices. */
118 /* Fields related to elts mbuf storage. */
119 uint16_t wqe_ci; /* Consumer index for work queue. */
120 uint16_t wqe_pi; /* Producer index for work queue. */
121 uint16_t wqe_s; /* Number of WQ elements. */
122 uint16_t wqe_m; /* Mask Number for WQ elements. */
123 uint16_t wqe_comp; /* WQE index since last completion request. */
124 uint16_t wqe_thres; /* WQE threshold to request completion in CQ. */
125 /* WQ related fields. */
126 uint16_t cq_ci; /* Consumer index for completion queue. */
127 uint16_t cq_pi; /* Production index for completion queue. */
128 uint16_t cqe_s; /* Number of CQ elements. */
129 uint16_t cqe_m; /* Mask for CQ indices. */
130 /* CQ related fields. */
131 uint16_t elts_n:4; /* elts[] length (in log2). */
132 uint16_t cqe_n:4; /* Number of CQ elements (in log2). */
133 uint16_t wqe_n:4; /* Number of WQ elements (in log2). */
134 uint16_t tso_en:1; /* When set hardware TSO is enabled. */
135 uint16_t tunnel_en:1;
136 /* When set TX offload for tunneled packets are supported. */
137 uint16_t swp_en:1; /* Whether SW parser is enabled. */
138 uint16_t vlan_en:1; /* VLAN insertion in WQE is supported. */
139 uint16_t db_nc:1; /* Doorbell mapped to non-cached region. */
140 uint16_t db_heu:1; /* Doorbell heuristic write barrier. */
141 uint16_t fast_free:1; /* mbuf fast free on Tx is enabled. */
142 uint16_t inlen_send; /* Ordinary send data inline size. */
143 uint16_t inlen_empw; /* eMPW max packet size to inline. */
144 uint16_t inlen_mode; /* Minimal data length to inline. */
145 uint32_t qp_num_8s; /* QP number shifted by 8. */
146 uint64_t offloads; /* Offloads for Tx Queue. */
147 struct mlx5_mr_ctrl mr_ctrl; /* MR control descriptor. */
148 struct mlx5_wqe *wqes; /* Work queue. */
149 struct mlx5_wqe *wqes_end; /* Work queue array limit. */
150 #ifdef RTE_LIBRTE_MLX5_DEBUG
151 uint32_t *fcqs; /* Free completion queue (debug extended). */
153 uint16_t *fcqs; /* Free completion queue. */
155 volatile struct mlx5_cqe *cqes; /* Completion queue. */
156 volatile uint32_t *qp_db; /* Work queue doorbell. */
157 volatile uint32_t *cq_db; /* Completion queue doorbell. */
158 uint16_t port_id; /* Port ID of device. */
159 uint16_t idx; /* Queue index. */
160 uint64_t ts_mask; /* Timestamp flag dynamic mask. */
161 int32_t ts_offset; /* Timestamp field dynamic offset. */
162 struct mlx5_dev_ctx_shared *sh; /* Shared context. */
163 struct mlx5_txq_stats stats; /* TX queue counters. */
164 struct mlx5_uar_data uar_data;
165 struct rte_mbuf *elts[0];
166 /* Storage for queued packets, must be the last field. */
167 } __rte_cache_aligned;
170 MLX5_TXQ_TYPE_STANDARD, /* Standard Tx queue. */
171 MLX5_TXQ_TYPE_HAIRPIN, /* Hairpin Tx queue. */
174 /* TX queue control descriptor. */
175 struct mlx5_txq_ctrl {
176 LIST_ENTRY(mlx5_txq_ctrl) next; /* Pointer to the next element. */
177 uint32_t refcnt; /* Reference counter. */
178 unsigned int socket; /* CPU socket ID for allocations. */
179 enum mlx5_txq_type type; /* The txq ctrl type. */
180 unsigned int max_inline_data; /* Max inline data. */
181 unsigned int max_tso_header; /* Max TSO header size. */
182 struct mlx5_txq_obj *obj; /* Verbs/DevX queue object. */
183 struct mlx5_priv *priv; /* Back pointer to private data. */
184 off_t uar_mmap_offset; /* UAR mmap offset for non-primary process. */
185 uint16_t dump_file_n; /* Number of dump files. */
186 struct rte_eth_hairpin_conf hairpin_conf; /* Hairpin configuration. */
187 uint32_t hairpin_status; /* Hairpin binding status. */
188 struct mlx5_txq_data txq; /* Data path structure. */
189 /* Must be the last field in the structure, contains elts[]. */
194 int mlx5_tx_queue_start(struct rte_eth_dev *dev, uint16_t queue_id);
195 int mlx5_tx_queue_stop(struct rte_eth_dev *dev, uint16_t queue_id);
196 int mlx5_tx_queue_start_primary(struct rte_eth_dev *dev, uint16_t queue_id);
197 int mlx5_tx_queue_stop_primary(struct rte_eth_dev *dev, uint16_t queue_id);
198 int mlx5_tx_queue_setup(struct rte_eth_dev *dev, uint16_t idx, uint16_t desc,
199 unsigned int socket, const struct rte_eth_txconf *conf);
200 int mlx5_tx_hairpin_queue_setup
201 (struct rte_eth_dev *dev, uint16_t idx, uint16_t desc,
202 const struct rte_eth_hairpin_conf *hairpin_conf);
203 void mlx5_tx_queue_release(struct rte_eth_dev *dev, uint16_t qid);
204 int mlx5_tx_uar_init_secondary(struct rte_eth_dev *dev, int fd);
205 void mlx5_tx_uar_uninit_secondary(struct rte_eth_dev *dev);
206 int mlx5_txq_obj_verify(struct rte_eth_dev *dev);
207 struct mlx5_txq_ctrl *mlx5_txq_new(struct rte_eth_dev *dev, uint16_t idx,
208 uint16_t desc, unsigned int socket,
209 const struct rte_eth_txconf *conf);
210 struct mlx5_txq_ctrl *mlx5_txq_hairpin_new
211 (struct rte_eth_dev *dev, uint16_t idx, uint16_t desc,
212 const struct rte_eth_hairpin_conf *hairpin_conf);
213 struct mlx5_txq_ctrl *mlx5_txq_get(struct rte_eth_dev *dev, uint16_t idx);
214 int mlx5_txq_release(struct rte_eth_dev *dev, uint16_t idx);
215 int mlx5_txq_releasable(struct rte_eth_dev *dev, uint16_t idx);
216 int mlx5_txq_verify(struct rte_eth_dev *dev);
217 void txq_alloc_elts(struct mlx5_txq_ctrl *txq_ctrl);
218 void txq_free_elts(struct mlx5_txq_ctrl *txq_ctrl);
219 uint64_t mlx5_get_tx_port_offloads(struct rte_eth_dev *dev);
220 void mlx5_txq_dynf_timestamp_set(struct rte_eth_dev *dev);
224 uint16_t removed_tx_burst(void *dpdk_txq, struct rte_mbuf **pkts,
226 void mlx5_tx_handle_completion(struct mlx5_txq_data *__rte_restrict txq,
227 unsigned int olx __rte_unused);
228 int mlx5_tx_descriptor_status(void *tx_queue, uint16_t offset);
229 void mlx5_txq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
230 struct rte_eth_txq_info *qinfo);
231 int mlx5_tx_burst_mode_get(struct rte_eth_dev *dev, uint16_t tx_queue_id,
232 struct rte_eth_burst_mode *mode);
236 MLX5_TXOFF_PRE_DECL(full_empw);
237 MLX5_TXOFF_PRE_DECL(none_empw);
238 MLX5_TXOFF_PRE_DECL(md_empw);
239 MLX5_TXOFF_PRE_DECL(mt_empw);
240 MLX5_TXOFF_PRE_DECL(mtsc_empw);
241 MLX5_TXOFF_PRE_DECL(mti_empw);
242 MLX5_TXOFF_PRE_DECL(mtv_empw);
243 MLX5_TXOFF_PRE_DECL(mtiv_empw);
244 MLX5_TXOFF_PRE_DECL(sc_empw);
245 MLX5_TXOFF_PRE_DECL(sci_empw);
246 MLX5_TXOFF_PRE_DECL(scv_empw);
247 MLX5_TXOFF_PRE_DECL(sciv_empw);
248 MLX5_TXOFF_PRE_DECL(i_empw);
249 MLX5_TXOFF_PRE_DECL(v_empw);
250 MLX5_TXOFF_PRE_DECL(iv_empw);
252 /* mlx5_tx_nompw.c */
254 MLX5_TXOFF_PRE_DECL(full);
255 MLX5_TXOFF_PRE_DECL(none);
256 MLX5_TXOFF_PRE_DECL(md);
257 MLX5_TXOFF_PRE_DECL(mt);
258 MLX5_TXOFF_PRE_DECL(mtsc);
259 MLX5_TXOFF_PRE_DECL(mti);
260 MLX5_TXOFF_PRE_DECL(mtv);
261 MLX5_TXOFF_PRE_DECL(mtiv);
262 MLX5_TXOFF_PRE_DECL(sc);
263 MLX5_TXOFF_PRE_DECL(sci);
264 MLX5_TXOFF_PRE_DECL(scv);
265 MLX5_TXOFF_PRE_DECL(sciv);
266 MLX5_TXOFF_PRE_DECL(i);
267 MLX5_TXOFF_PRE_DECL(v);
268 MLX5_TXOFF_PRE_DECL(iv);
272 MLX5_TXOFF_PRE_DECL(full_ts_nompw);
273 MLX5_TXOFF_PRE_DECL(full_ts_nompwi);
274 MLX5_TXOFF_PRE_DECL(full_ts);
275 MLX5_TXOFF_PRE_DECL(full_ts_noi);
276 MLX5_TXOFF_PRE_DECL(none_ts);
277 MLX5_TXOFF_PRE_DECL(mdi_ts);
278 MLX5_TXOFF_PRE_DECL(mti_ts);
279 MLX5_TXOFF_PRE_DECL(mtiv_ts);
283 MLX5_TXOFF_PRE_DECL(none_mpw);
284 MLX5_TXOFF_PRE_DECL(mci_mpw);
285 MLX5_TXOFF_PRE_DECL(mc_mpw);
286 MLX5_TXOFF_PRE_DECL(i_mpw);
288 static __rte_always_inline struct mlx5_uar_data *
289 mlx5_tx_bfreg(struct mlx5_txq_data *txq)
291 return &MLX5_PROC_PRIV(txq->port_id)->uar_table[txq->idx];
295 * Ring TX queue doorbell and flush the update by write memory barrier.
298 * Pointer to TX queue structure.
300 * Pointer to the last WQE posted in the NIC.
302 static __rte_always_inline void
303 mlx5_tx_dbrec(struct mlx5_txq_data *txq, volatile struct mlx5_wqe *wqe)
305 mlx5_doorbell_ring(mlx5_tx_bfreg(txq), *(volatile uint64_t *)wqe,
306 txq->wqe_ci, txq->qp_db, 1);
310 * Convert timestamp from mbuf format to linear counter
311 * of Clock Queue completions (24 bits).
314 * Pointer to the device shared context to fetch Tx
315 * packet pacing timestamp and parameters.
317 * Timestamp from mbuf to convert.
319 * positive or zero value - completion ID to wait.
320 * negative value - conversion error.
322 static __rte_always_inline int32_t
323 mlx5_txpp_convert_tx_ts(struct mlx5_dev_ctx_shared *sh, uint64_t mts)
330 * Read atomically two uint64_t fields and compare lsb bits.
331 * It there is no match - the timestamp was updated in
332 * the service thread, data should be re-read.
334 rte_compiler_barrier();
335 ci = __atomic_load_n(&sh->txpp.ts.ci_ts, __ATOMIC_RELAXED);
336 ts = __atomic_load_n(&sh->txpp.ts.ts, __ATOMIC_RELAXED);
337 rte_compiler_barrier();
338 if (!((ts ^ ci) << (64 - MLX5_CQ_INDEX_WIDTH)))
341 /* Perform the skew correction, positive value to send earlier. */
342 mts -= sh->txpp.skew;
344 if (unlikely(mts >= UINT64_MAX / 2)) {
345 /* We have negative integer, mts is in the past. */
346 __atomic_fetch_add(&sh->txpp.err_ts_past,
347 1, __ATOMIC_RELAXED);
350 tick = sh->txpp.tick;
352 /* Convert delta to completions, round up. */
353 mts = (mts + tick - 1) / tick;
354 if (unlikely(mts >= (1 << MLX5_CQ_INDEX_WIDTH) / 2 - 1)) {
355 /* We have mts is too distant future. */
356 __atomic_fetch_add(&sh->txpp.err_ts_future,
357 1, __ATOMIC_RELAXED);
360 mts <<= 64 - MLX5_CQ_INDEX_WIDTH;
362 ci >>= 64 - MLX5_CQ_INDEX_WIDTH;
367 * Set Software Parser flags and offsets in Ethernet Segment of WQE.
368 * Flags must be preliminary initialized to zero.
371 * Pointer to burst routine local context.
373 * Pointer to store Software Parser flags.
375 * Configured Tx offloads mask. It is fully defined at
376 * compile time and may be used for optimization.
379 * Software Parser offsets packed in dword.
380 * Software Parser flags are set by pointer.
382 static __rte_always_inline uint32_t
383 txq_mbuf_to_swp(struct mlx5_txq_local *__rte_restrict loc,
388 unsigned int idx, off;
391 if (!MLX5_TXOFF_CONFIG(SWP))
393 ol = loc->mbuf->ol_flags;
394 tunnel = ol & RTE_MBUF_F_TX_TUNNEL_MASK;
396 * Check whether Software Parser is required.
397 * Only customized tunnels may ask for.
399 if (likely(tunnel != RTE_MBUF_F_TX_TUNNEL_UDP && tunnel != RTE_MBUF_F_TX_TUNNEL_IP))
402 * The index should have:
403 * bit[0:1] = RTE_MBUF_F_TX_L4_MASK
404 * bit[4] = RTE_MBUF_F_TX_IPV6
405 * bit[8] = RTE_MBUF_F_TX_OUTER_IPV6
406 * bit[9] = RTE_MBUF_F_TX_OUTER_UDP
408 idx = (ol & (RTE_MBUF_F_TX_L4_MASK | RTE_MBUF_F_TX_IPV6 | RTE_MBUF_F_TX_OUTER_IPV6)) >> 52;
409 idx |= (tunnel == RTE_MBUF_F_TX_TUNNEL_UDP) ? (1 << 9) : 0;
410 *swp_flags = mlx5_swp_types_table[idx];
412 * Set offsets for SW parser. Since ConnectX-5, SW parser just
413 * complements HW parser. SW parser starts to engage only if HW parser
414 * can't reach a header. For the older devices, HW parser will not kick
415 * in if any of SWP offsets is set. Therefore, all of the L3 offsets
416 * should be set regardless of HW offload.
418 off = loc->mbuf->outer_l2_len;
419 if (MLX5_TXOFF_CONFIG(VLAN) && ol & RTE_MBUF_F_TX_VLAN)
420 off += sizeof(struct rte_vlan_hdr);
421 set = (off >> 1) << 8; /* Outer L3 offset. */
422 off += loc->mbuf->outer_l3_len;
423 if (tunnel == RTE_MBUF_F_TX_TUNNEL_UDP)
424 set |= off >> 1; /* Outer L4 offset. */
425 if (ol & (RTE_MBUF_F_TX_IPV4 | RTE_MBUF_F_TX_IPV6)) { /* Inner IP. */
426 const uint64_t csum = ol & RTE_MBUF_F_TX_L4_MASK;
427 off += loc->mbuf->l2_len;
428 set |= (off >> 1) << 24; /* Inner L3 offset. */
429 if (csum == RTE_MBUF_F_TX_TCP_CKSUM ||
430 csum == RTE_MBUF_F_TX_UDP_CKSUM ||
431 (MLX5_TXOFF_CONFIG(TSO) && ol & RTE_MBUF_F_TX_TCP_SEG)) {
432 off += loc->mbuf->l3_len;
433 set |= (off >> 1) << 16; /* Inner L4 offset. */
436 set = rte_cpu_to_le_32(set);
441 * Convert the Checksum offloads to Verbs.
444 * Pointer to the mbuf.
447 * Converted checksum flags.
449 static __rte_always_inline uint8_t
450 txq_ol_cksum_to_cs(struct rte_mbuf *buf)
453 uint8_t is_tunnel = !!(buf->ol_flags & RTE_MBUF_F_TX_TUNNEL_MASK);
454 const uint64_t ol_flags_mask = RTE_MBUF_F_TX_TCP_SEG | RTE_MBUF_F_TX_L4_MASK |
455 RTE_MBUF_F_TX_IP_CKSUM | RTE_MBUF_F_TX_OUTER_IP_CKSUM;
458 * The index should have:
459 * bit[0] = RTE_MBUF_F_TX_TCP_SEG
460 * bit[2:3] = RTE_MBUF_F_TX_UDP_CKSUM, RTE_MBUF_F_TX_TCP_CKSUM
461 * bit[4] = RTE_MBUF_F_TX_IP_CKSUM
462 * bit[8] = RTE_MBUF_F_TX_OUTER_IP_CKSUM
465 idx = ((buf->ol_flags & ol_flags_mask) >> 50) | (!!is_tunnel << 9);
466 return mlx5_cksum_table[idx];
470 * Free the mbufs from the linear array of pointers.
473 * Pointer to Tx queue structure.
475 * Pointer to array of packets to be free.
477 * Number of packets to be freed.
479 * Configured Tx offloads mask. It is fully defined at
480 * compile time and may be used for optimization.
482 static __rte_always_inline void
483 mlx5_tx_free_mbuf(struct mlx5_txq_data *__rte_restrict txq,
484 struct rte_mbuf **__rte_restrict pkts,
486 unsigned int olx __rte_unused)
488 struct rte_mempool *pool = NULL;
489 struct rte_mbuf **p_free = NULL;
490 struct rte_mbuf *mbuf;
491 unsigned int n_free = 0;
494 * The implemented algorithm eliminates
495 * copying pointers to temporary array
496 * for rte_mempool_put_bulk() calls.
501 * Free mbufs directly to the pool in bulk
502 * if fast free offload is engaged
504 if (!MLX5_TXOFF_CONFIG(MULTI) && txq->fast_free) {
507 rte_mempool_put_bulk(pool, (void *)pkts, pkts_n);
513 * Decrement mbuf reference counter, detach
514 * indirect and external buffers if needed.
516 mbuf = rte_pktmbuf_prefree_seg(*pkts);
517 if (likely(mbuf != NULL)) {
518 MLX5_ASSERT(mbuf == *pkts);
519 if (likely(n_free != 0)) {
520 if (unlikely(pool != mbuf->pool))
521 /* From different pool. */
524 /* Start new scan array. */
531 if (unlikely(pkts_n == 0)) {
537 * This happens if mbuf is still referenced.
538 * We can't put it back to the pool, skip.
542 if (unlikely(n_free != 0))
543 /* There is some array to free.*/
545 if (unlikely(pkts_n == 0))
546 /* Last mbuf, nothing to free. */
552 * This loop is implemented to avoid multiple
553 * inlining of rte_mempool_put_bulk().
559 * Free the array of pre-freed mbufs
560 * belonging to the same memory pool.
562 rte_mempool_put_bulk(pool, (void *)p_free, n_free);
563 if (unlikely(mbuf != NULL)) {
564 /* There is the request to start new scan. */
569 if (likely(pkts_n != 0))
572 * This is the last mbuf to be freed.
573 * Do one more loop iteration to complete.
574 * This is rare case of the last unique mbuf.
579 if (likely(pkts_n == 0))
588 * No inline version to free buffers for optimal call
589 * on the tx_burst completion.
591 static __rte_noinline void
592 __mlx5_tx_free_mbuf(struct mlx5_txq_data *__rte_restrict txq,
593 struct rte_mbuf **__rte_restrict pkts,
595 unsigned int olx __rte_unused)
597 mlx5_tx_free_mbuf(txq, pkts, pkts_n, olx);
601 * Free the mbuf from the elts ring buffer till new tail.
604 * Pointer to Tx queue structure.
606 * Index in elts to free up to, becomes new elts tail.
608 * Configured Tx offloads mask. It is fully defined at
609 * compile time and may be used for optimization.
611 static __rte_always_inline void
612 mlx5_tx_free_elts(struct mlx5_txq_data *__rte_restrict txq,
614 unsigned int olx __rte_unused)
616 uint16_t n_elts = tail - txq->elts_tail;
619 MLX5_ASSERT(n_elts <= txq->elts_s);
621 * Implement a loop to support ring buffer wraparound
622 * with single inlining of mlx5_tx_free_mbuf().
627 part = txq->elts_s - (txq->elts_tail & txq->elts_m);
628 part = RTE_MIN(part, n_elts);
630 MLX5_ASSERT(part <= txq->elts_s);
631 mlx5_tx_free_mbuf(txq,
632 &txq->elts[txq->elts_tail & txq->elts_m],
634 txq->elts_tail += part;
640 * Store the mbuf being sent into elts ring buffer.
641 * On Tx completion these mbufs will be freed.
644 * Pointer to Tx queue structure.
646 * Pointer to array of packets to be stored.
648 * Number of packets to be stored.
650 * Configured Tx offloads mask. It is fully defined at
651 * compile time and may be used for optimization.
653 static __rte_always_inline void
654 mlx5_tx_copy_elts(struct mlx5_txq_data *__rte_restrict txq,
655 struct rte_mbuf **__rte_restrict pkts,
657 unsigned int olx __rte_unused)
660 struct rte_mbuf **elts = (struct rte_mbuf **)txq->elts;
664 part = txq->elts_s - (txq->elts_head & txq->elts_m);
666 MLX5_ASSERT(part <= txq->elts_s);
667 /* This code is a good candidate for vectorizing with SIMD. */
668 rte_memcpy((void *)(elts + (txq->elts_head & txq->elts_m)),
670 RTE_MIN(part, pkts_n) * sizeof(struct rte_mbuf *));
671 txq->elts_head += pkts_n;
672 if (unlikely(part < pkts_n))
673 /* The copy is wrapping around the elts array. */
674 rte_memcpy((void *)elts, (void *)(pkts + part),
675 (pkts_n - part) * sizeof(struct rte_mbuf *));
679 * Check if the completion request flag should be set in the last WQE.
680 * Both pushed mbufs and WQEs are monitored and the completion request
681 * flag is set if any of thresholds is reached.
684 * Pointer to TX queue structure.
686 * Pointer to burst routine local context.
688 * Configured Tx offloads mask. It is fully defined at
689 * compile time and may be used for optimization.
691 static __rte_always_inline void
692 mlx5_tx_request_completion(struct mlx5_txq_data *__rte_restrict txq,
693 struct mlx5_txq_local *__rte_restrict loc,
696 uint16_t head = txq->elts_head;
699 part = MLX5_TXOFF_CONFIG(INLINE) ?
700 0 : loc->pkts_sent - loc->pkts_copy;
702 if ((uint16_t)(head - txq->elts_comp) >= MLX5_TX_COMP_THRESH ||
703 (MLX5_TXOFF_CONFIG(INLINE) &&
704 (uint16_t)(txq->wqe_ci - txq->wqe_comp) >= txq->wqe_thres)) {
705 volatile struct mlx5_wqe *last = loc->wqe_last;
708 txq->elts_comp = head;
709 if (MLX5_TXOFF_CONFIG(INLINE))
710 txq->wqe_comp = txq->wqe_ci;
711 /* Request unconditional completion on last WQE. */
712 last->cseg.flags = RTE_BE32(MLX5_COMP_ALWAYS <<
713 MLX5_COMP_MODE_OFFSET);
714 /* Save elts_head in dedicated free on completion queue. */
715 #ifdef RTE_LIBRTE_MLX5_DEBUG
716 txq->fcqs[txq->cq_pi++ & txq->cqe_m] = head |
717 (last->cseg.opcode >> 8) << 16;
719 txq->fcqs[txq->cq_pi++ & txq->cqe_m] = head;
721 /* A CQE slot must always be available. */
722 MLX5_ASSERT((txq->cq_pi - txq->cq_ci) <= txq->cqe_s);
727 * Build the Control Segment with specified opcode:
729 * - MLX5_OPCODE_ENHANCED_MPSW
733 * Pointer to TX queue structure.
735 * Pointer to burst routine local context.
737 * Pointer to WQE to fill with built Control Segment.
739 * Supposed length of WQE in segments.
741 * SQ WQE opcode to put into Control Segment.
743 * Configured Tx offloads mask. It is fully defined at
744 * compile time and may be used for optimization.
746 static __rte_always_inline void
747 mlx5_tx_cseg_init(struct mlx5_txq_data *__rte_restrict txq,
748 struct mlx5_txq_local *__rte_restrict loc __rte_unused,
749 struct mlx5_wqe *__rte_restrict wqe,
752 unsigned int olx __rte_unused)
754 struct mlx5_wqe_cseg *__rte_restrict cs = &wqe->cseg;
756 /* For legacy MPW replace the EMPW by TSO with modifier. */
757 if (MLX5_TXOFF_CONFIG(MPW) && opcode == MLX5_OPCODE_ENHANCED_MPSW)
758 opcode = MLX5_OPCODE_TSO | MLX5_OPC_MOD_MPW << 24;
759 cs->opcode = rte_cpu_to_be_32((txq->wqe_ci << 8) | opcode);
760 cs->sq_ds = rte_cpu_to_be_32(txq->qp_num_8s | ds);
761 cs->flags = RTE_BE32(MLX5_COMP_ONLY_FIRST_ERR <<
762 MLX5_COMP_MODE_OFFSET);
763 cs->misc = RTE_BE32(0);
767 * Build the Synchronize Queue Segment with specified completion index.
770 * Pointer to TX queue structure.
772 * Pointer to burst routine local context.
774 * Pointer to WQE to fill with built Control Segment.
776 * Completion index in Clock Queue to wait.
778 * Configured Tx offloads mask. It is fully defined at
779 * compile time and may be used for optimization.
781 static __rte_always_inline void
782 mlx5_tx_wseg_init(struct mlx5_txq_data *restrict txq,
783 struct mlx5_txq_local *restrict loc __rte_unused,
784 struct mlx5_wqe *restrict wqe,
786 unsigned int olx __rte_unused)
788 struct mlx5_wqe_qseg *qs;
790 qs = RTE_PTR_ADD(wqe, MLX5_WSEG_SIZE);
791 qs->max_index = rte_cpu_to_be_32(wci);
792 qs->qpn_cqn = rte_cpu_to_be_32(txq->sh->txpp.clock_queue.cq_obj.cq->id);
793 qs->reserved0 = RTE_BE32(0);
794 qs->reserved1 = RTE_BE32(0);
798 * Build the Ethernet Segment without inlined data.
799 * Supports Software Parser, Checksums and VLAN insertion Tx offload features.
802 * Pointer to TX queue structure.
804 * Pointer to burst routine local context.
806 * Pointer to WQE to fill with built Ethernet Segment.
808 * Configured Tx offloads mask. It is fully defined at
809 * compile time and may be used for optimization.
811 static __rte_always_inline void
812 mlx5_tx_eseg_none(struct mlx5_txq_data *__rte_restrict txq __rte_unused,
813 struct mlx5_txq_local *__rte_restrict loc,
814 struct mlx5_wqe *__rte_restrict wqe,
817 struct mlx5_wqe_eseg *__rte_restrict es = &wqe->eseg;
821 * Calculate and set check sum flags first, dword field
822 * in segment may be shared with Software Parser flags.
824 csum = MLX5_TXOFF_CONFIG(CSUM) ? txq_ol_cksum_to_cs(loc->mbuf) : 0;
825 es->flags = rte_cpu_to_le_32(csum);
827 * Calculate and set Software Parser offsets and flags.
828 * These flags a set for custom UDP and IP tunnel packets.
830 es->swp_offs = txq_mbuf_to_swp(loc, &es->swp_flags, olx);
831 /* Fill metadata field if needed. */
832 es->metadata = MLX5_TXOFF_CONFIG(METADATA) ?
833 loc->mbuf->ol_flags & RTE_MBUF_DYNFLAG_TX_METADATA ?
834 rte_cpu_to_be_32(*RTE_FLOW_DYNF_METADATA(loc->mbuf)) :
836 /* Engage VLAN tag insertion feature if requested. */
837 if (MLX5_TXOFF_CONFIG(VLAN) &&
838 loc->mbuf->ol_flags & RTE_MBUF_F_TX_VLAN) {
840 * We should get here only if device support
841 * this feature correctly.
843 MLX5_ASSERT(txq->vlan_en);
844 es->inline_hdr = rte_cpu_to_be_32(MLX5_ETH_WQE_VLAN_INSERT |
845 loc->mbuf->vlan_tci);
847 es->inline_hdr = RTE_BE32(0);
852 * Build the Ethernet Segment with minimal inlined data
853 * of MLX5_ESEG_MIN_INLINE_SIZE bytes length. This is
854 * used to fill the gap in single WQEBB WQEs.
855 * Supports Software Parser, Checksums and VLAN
856 * insertion Tx offload features.
859 * Pointer to TX queue structure.
861 * Pointer to burst routine local context.
863 * Pointer to WQE to fill with built Ethernet Segment.
865 * Length of VLAN tag insertion if any.
867 * Configured Tx offloads mask. It is fully defined at
868 * compile time and may be used for optimization.
870 static __rte_always_inline void
871 mlx5_tx_eseg_dmin(struct mlx5_txq_data *__rte_restrict txq __rte_unused,
872 struct mlx5_txq_local *__rte_restrict loc,
873 struct mlx5_wqe *__rte_restrict wqe,
877 struct mlx5_wqe_eseg *__rte_restrict es = &wqe->eseg;
879 uint8_t *psrc, *pdst;
882 * Calculate and set check sum flags first, dword field
883 * in segment may be shared with Software Parser flags.
885 csum = MLX5_TXOFF_CONFIG(CSUM) ? txq_ol_cksum_to_cs(loc->mbuf) : 0;
886 es->flags = rte_cpu_to_le_32(csum);
888 * Calculate and set Software Parser offsets and flags.
889 * These flags a set for custom UDP and IP tunnel packets.
891 es->swp_offs = txq_mbuf_to_swp(loc, &es->swp_flags, olx);
892 /* Fill metadata field if needed. */
893 es->metadata = MLX5_TXOFF_CONFIG(METADATA) ?
894 loc->mbuf->ol_flags & RTE_MBUF_DYNFLAG_TX_METADATA ?
895 rte_cpu_to_be_32(*RTE_FLOW_DYNF_METADATA(loc->mbuf)) :
897 psrc = rte_pktmbuf_mtod(loc->mbuf, uint8_t *);
898 es->inline_hdr_sz = RTE_BE16(MLX5_ESEG_MIN_INLINE_SIZE);
899 es->inline_data = *(unaligned_uint16_t *)psrc;
900 psrc += sizeof(uint16_t);
901 pdst = (uint8_t *)(es + 1);
902 if (MLX5_TXOFF_CONFIG(VLAN) && vlan) {
903 /* Implement VLAN tag insertion as part inline data. */
904 memcpy(pdst, psrc, 2 * RTE_ETHER_ADDR_LEN - sizeof(uint16_t));
905 pdst += 2 * RTE_ETHER_ADDR_LEN - sizeof(uint16_t);
906 psrc += 2 * RTE_ETHER_ADDR_LEN - sizeof(uint16_t);
907 /* Insert VLAN ethertype + VLAN tag. */
908 *(unaligned_uint32_t *)pdst = rte_cpu_to_be_32
909 ((RTE_ETHER_TYPE_VLAN << 16) |
910 loc->mbuf->vlan_tci);
911 pdst += sizeof(struct rte_vlan_hdr);
912 /* Copy the rest two bytes from packet data. */
913 MLX5_ASSERT(pdst == RTE_PTR_ALIGN(pdst, sizeof(uint16_t)));
914 *(uint16_t *)pdst = *(unaligned_uint16_t *)psrc;
916 /* Fill the gap in the title WQEBB with inline data. */
917 rte_mov16(pdst, psrc);
922 * Build the Ethernet Segment with entire packet data inlining. Checks the
923 * boundary of WQEBB and ring buffer wrapping, supports Software Parser,
924 * Checksums and VLAN insertion Tx offload features.
927 * Pointer to TX queue structure.
929 * Pointer to burst routine local context.
931 * Pointer to WQE to fill with built Ethernet Segment.
933 * Length of VLAN tag insertion if any.
935 * Length of data to inline (VLAN included, if any).
937 * TSO flag, set mss field from the packet.
939 * Configured Tx offloads mask. It is fully defined at
940 * compile time and may be used for optimization.
943 * Pointer to the next Data Segment (aligned and wrapped around).
945 static __rte_always_inline struct mlx5_wqe_dseg *
946 mlx5_tx_eseg_data(struct mlx5_txq_data *__rte_restrict txq,
947 struct mlx5_txq_local *__rte_restrict loc,
948 struct mlx5_wqe *__rte_restrict wqe,
954 struct mlx5_wqe_eseg *__rte_restrict es = &wqe->eseg;
956 uint8_t *psrc, *pdst;
960 * Calculate and set check sum flags first, dword field
961 * in segment may be shared with Software Parser flags.
963 csum = MLX5_TXOFF_CONFIG(CSUM) ? txq_ol_cksum_to_cs(loc->mbuf) : 0;
966 csum |= loc->mbuf->tso_segsz;
967 es->flags = rte_cpu_to_be_32(csum);
969 es->flags = rte_cpu_to_le_32(csum);
972 * Calculate and set Software Parser offsets and flags.
973 * These flags a set for custom UDP and IP tunnel packets.
975 es->swp_offs = txq_mbuf_to_swp(loc, &es->swp_flags, olx);
976 /* Fill metadata field if needed. */
977 es->metadata = MLX5_TXOFF_CONFIG(METADATA) ?
978 loc->mbuf->ol_flags & RTE_MBUF_DYNFLAG_TX_METADATA ?
979 rte_cpu_to_be_32(*RTE_FLOW_DYNF_METADATA(loc->mbuf)) :
981 psrc = rte_pktmbuf_mtod(loc->mbuf, uint8_t *);
982 es->inline_hdr_sz = rte_cpu_to_be_16(inlen);
983 es->inline_data = *(unaligned_uint16_t *)psrc;
984 psrc += sizeof(uint16_t);
985 pdst = (uint8_t *)(es + 1);
986 if (MLX5_TXOFF_CONFIG(VLAN) && vlan) {
987 /* Implement VLAN tag insertion as part inline data. */
988 memcpy(pdst, psrc, 2 * RTE_ETHER_ADDR_LEN - sizeof(uint16_t));
989 pdst += 2 * RTE_ETHER_ADDR_LEN - sizeof(uint16_t);
990 psrc += 2 * RTE_ETHER_ADDR_LEN - sizeof(uint16_t);
991 /* Insert VLAN ethertype + VLAN tag. */
992 *(unaligned_uint32_t *)pdst = rte_cpu_to_be_32
993 ((RTE_ETHER_TYPE_VLAN << 16) |
994 loc->mbuf->vlan_tci);
995 pdst += sizeof(struct rte_vlan_hdr);
996 /* Copy the rest two bytes from packet data. */
997 MLX5_ASSERT(pdst == RTE_PTR_ALIGN(pdst, sizeof(uint16_t)));
998 *(uint16_t *)pdst = *(unaligned_uint16_t *)psrc;
999 psrc += sizeof(uint16_t);
1001 /* Fill the gap in the title WQEBB with inline data. */
1002 rte_mov16(pdst, psrc);
1003 psrc += sizeof(rte_v128u32_t);
1005 pdst = (uint8_t *)(es + 2);
1006 MLX5_ASSERT(inlen >= MLX5_ESEG_MIN_INLINE_SIZE);
1007 MLX5_ASSERT(pdst < (uint8_t *)txq->wqes_end);
1008 inlen -= MLX5_ESEG_MIN_INLINE_SIZE;
1010 MLX5_ASSERT(pdst == RTE_PTR_ALIGN(pdst, MLX5_WSEG_SIZE));
1011 return (struct mlx5_wqe_dseg *)pdst;
1014 * The WQEBB space availability is checked by caller.
1015 * Here we should be aware of WQE ring buffer wraparound only.
1017 part = (uint8_t *)txq->wqes_end - pdst;
1018 part = RTE_MIN(part, inlen);
1020 rte_memcpy(pdst, psrc, part);
1022 if (likely(!inlen)) {
1024 * If return value is not used by the caller
1025 * the code below will be optimized out.
1028 pdst = RTE_PTR_ALIGN(pdst, MLX5_WSEG_SIZE);
1029 if (unlikely(pdst >= (uint8_t *)txq->wqes_end))
1030 pdst = (uint8_t *)txq->wqes;
1031 return (struct mlx5_wqe_dseg *)pdst;
1033 pdst = (uint8_t *)txq->wqes;
1040 * Copy data from chain of mbuf to the specified linear buffer.
1041 * Checksums and VLAN insertion Tx offload features. If data
1042 * from some mbuf copied completely this mbuf is freed. Local
1043 * structure is used to keep the byte stream state.
1046 * Pointer to the destination linear buffer.
1048 * Pointer to burst routine local context.
1050 * Length of data to be copied.
1052 * Length of data to be copied ignoring no inline hint.
1054 * Configured Tx offloads mask. It is fully defined at
1055 * compile time and may be used for optimization.
1058 * Number of actual copied data bytes. This is always greater than or
1059 * equal to must parameter and might be lesser than len in no inline
1060 * hint flag is encountered.
1062 static __rte_always_inline unsigned int
1063 mlx5_tx_mseg_memcpy(uint8_t *pdst,
1064 struct mlx5_txq_local *__rte_restrict loc,
1067 unsigned int olx __rte_unused)
1069 struct rte_mbuf *mbuf;
1070 unsigned int part, dlen, copy = 0;
1074 MLX5_ASSERT(must <= len);
1076 /* Allow zero length packets, must check first. */
1077 dlen = rte_pktmbuf_data_len(loc->mbuf);
1078 if (dlen <= loc->mbuf_off) {
1079 /* Exhausted packet, just free. */
1081 loc->mbuf = mbuf->next;
1082 rte_pktmbuf_free_seg(mbuf);
1084 MLX5_ASSERT(loc->mbuf_nseg > 1);
1085 MLX5_ASSERT(loc->mbuf);
1087 if (loc->mbuf->ol_flags & RTE_MBUF_F_TX_DYNF_NOINLINE) {
1092 * We already copied the minimal
1093 * requested amount of data.
1098 if (diff <= rte_pktmbuf_data_len(loc->mbuf)) {
1100 * Copy only the minimal required
1101 * part of the data buffer.
1108 dlen -= loc->mbuf_off;
1109 psrc = rte_pktmbuf_mtod_offset(loc->mbuf, uint8_t *,
1111 part = RTE_MIN(len, dlen);
1112 rte_memcpy(pdst, psrc, part);
1114 loc->mbuf_off += part;
1117 if (loc->mbuf_off >= rte_pktmbuf_data_len(loc->mbuf)) {
1119 /* Exhausted packet, just free. */
1121 loc->mbuf = mbuf->next;
1122 rte_pktmbuf_free_seg(mbuf);
1124 MLX5_ASSERT(loc->mbuf_nseg >= 1);
1134 * Build the Ethernet Segment with inlined data from multi-segment packet.
1135 * Checks the boundary of WQEBB and ring buffer wrapping, supports Software
1136 * Parser, Checksums and VLAN insertion Tx offload features.
1139 * Pointer to TX queue structure.
1141 * Pointer to burst routine local context.
1143 * Pointer to WQE to fill with built Ethernet Segment.
1145 * Length of VLAN tag insertion if any.
1147 * Length of data to inline (VLAN included, if any).
1149 * TSO flag, set mss field from the packet.
1151 * Configured Tx offloads mask. It is fully defined at
1152 * compile time and may be used for optimization.
1155 * Pointer to the next Data Segment (aligned and possible NOT wrapped
1156 * around - caller should do wrapping check on its own).
1158 static __rte_always_inline struct mlx5_wqe_dseg *
1159 mlx5_tx_eseg_mdat(struct mlx5_txq_data *__rte_restrict txq,
1160 struct mlx5_txq_local *__rte_restrict loc,
1161 struct mlx5_wqe *__rte_restrict wqe,
1167 struct mlx5_wqe_eseg *__rte_restrict es = &wqe->eseg;
1170 unsigned int part, tlen = 0;
1173 * Calculate and set check sum flags first, uint32_t field
1174 * in segment may be shared with Software Parser flags.
1176 csum = MLX5_TXOFF_CONFIG(CSUM) ? txq_ol_cksum_to_cs(loc->mbuf) : 0;
1179 csum |= loc->mbuf->tso_segsz;
1180 es->flags = rte_cpu_to_be_32(csum);
1182 es->flags = rte_cpu_to_le_32(csum);
1185 * Calculate and set Software Parser offsets and flags.
1186 * These flags a set for custom UDP and IP tunnel packets.
1188 es->swp_offs = txq_mbuf_to_swp(loc, &es->swp_flags, olx);
1189 /* Fill metadata field if needed. */
1190 es->metadata = MLX5_TXOFF_CONFIG(METADATA) ?
1191 loc->mbuf->ol_flags & RTE_MBUF_DYNFLAG_TX_METADATA ?
1192 rte_cpu_to_be_32(*RTE_FLOW_DYNF_METADATA(loc->mbuf)) :
1194 MLX5_ASSERT(inlen >= MLX5_ESEG_MIN_INLINE_SIZE);
1195 pdst = (uint8_t *)&es->inline_data;
1196 if (MLX5_TXOFF_CONFIG(VLAN) && vlan) {
1197 /* Implement VLAN tag insertion as part inline data. */
1198 mlx5_tx_mseg_memcpy(pdst, loc,
1199 2 * RTE_ETHER_ADDR_LEN,
1200 2 * RTE_ETHER_ADDR_LEN, olx);
1201 pdst += 2 * RTE_ETHER_ADDR_LEN;
1202 *(unaligned_uint32_t *)pdst = rte_cpu_to_be_32
1203 ((RTE_ETHER_TYPE_VLAN << 16) |
1204 loc->mbuf->vlan_tci);
1205 pdst += sizeof(struct rte_vlan_hdr);
1206 tlen += 2 * RTE_ETHER_ADDR_LEN + sizeof(struct rte_vlan_hdr);
1208 MLX5_ASSERT(pdst < (uint8_t *)txq->wqes_end);
1210 * The WQEBB space availability is checked by caller.
1211 * Here we should be aware of WQE ring buffer wraparound only.
1213 part = (uint8_t *)txq->wqes_end - pdst;
1214 part = RTE_MIN(part, inlen - tlen);
1220 * Copying may be interrupted inside the routine
1221 * if run into no inline hint flag.
1223 copy = tso ? inlen : txq->inlen_mode;
1224 copy = tlen >= copy ? 0 : (copy - tlen);
1225 copy = mlx5_tx_mseg_memcpy(pdst, loc, part, copy, olx);
1227 if (likely(inlen <= tlen) || copy < part) {
1228 es->inline_hdr_sz = rte_cpu_to_be_16(tlen);
1230 pdst = RTE_PTR_ALIGN(pdst, MLX5_WSEG_SIZE);
1231 return (struct mlx5_wqe_dseg *)pdst;
1233 pdst = (uint8_t *)txq->wqes;
1234 part = inlen - tlen;
1239 * Build the Data Segment of pointer type.
1242 * Pointer to TX queue structure.
1244 * Pointer to burst routine local context.
1246 * Pointer to WQE to fill with built Data Segment.
1248 * Data buffer to point.
1250 * Data buffer length.
1252 * Configured Tx offloads mask. It is fully defined at
1253 * compile time and may be used for optimization.
1255 static __rte_always_inline void
1256 mlx5_tx_dseg_ptr(struct mlx5_txq_data *__rte_restrict txq,
1257 struct mlx5_txq_local *__rte_restrict loc,
1258 struct mlx5_wqe_dseg *__rte_restrict dseg,
1261 unsigned int olx __rte_unused)
1265 dseg->bcount = rte_cpu_to_be_32(len);
1266 dseg->lkey = mlx5_mr_mb2mr(&txq->mr_ctrl, loc->mbuf);
1267 dseg->pbuf = rte_cpu_to_be_64((uintptr_t)buf);
1271 * Build the Data Segment of pointer type or inline if data length is less than
1272 * buffer in minimal Data Segment size.
1275 * Pointer to TX queue structure.
1277 * Pointer to burst routine local context.
1279 * Pointer to WQE to fill with built Data Segment.
1281 * Data buffer to point.
1283 * Data buffer length.
1285 * Configured Tx offloads mask. It is fully defined at
1286 * compile time and may be used for optimization.
1288 static __rte_always_inline void
1289 mlx5_tx_dseg_iptr(struct mlx5_txq_data *__rte_restrict txq,
1290 struct mlx5_txq_local *__rte_restrict loc,
1291 struct mlx5_wqe_dseg *__rte_restrict dseg,
1294 unsigned int olx __rte_unused)
1300 if (len > MLX5_DSEG_MIN_INLINE_SIZE) {
1301 dseg->bcount = rte_cpu_to_be_32(len);
1302 dseg->lkey = mlx5_mr_mb2mr(&txq->mr_ctrl, loc->mbuf);
1303 dseg->pbuf = rte_cpu_to_be_64((uintptr_t)buf);
1307 dseg->bcount = rte_cpu_to_be_32(len | MLX5_ETH_WQE_DATA_INLINE);
1308 /* Unrolled implementation of generic rte_memcpy. */
1309 dst = (uintptr_t)&dseg->inline_data[0];
1310 src = (uintptr_t)buf;
1312 #ifdef RTE_ARCH_STRICT_ALIGN
1313 MLX5_ASSERT(dst == RTE_PTR_ALIGN(dst, sizeof(uint32_t)));
1314 *(uint32_t *)dst = *(unaligned_uint32_t *)src;
1315 dst += sizeof(uint32_t);
1316 src += sizeof(uint32_t);
1317 *(uint32_t *)dst = *(unaligned_uint32_t *)src;
1318 dst += sizeof(uint32_t);
1319 src += sizeof(uint32_t);
1321 *(uint64_t *)dst = *(unaligned_uint64_t *)src;
1322 dst += sizeof(uint64_t);
1323 src += sizeof(uint64_t);
1327 *(uint32_t *)dst = *(unaligned_uint32_t *)src;
1328 dst += sizeof(uint32_t);
1329 src += sizeof(uint32_t);
1332 *(uint16_t *)dst = *(unaligned_uint16_t *)src;
1333 dst += sizeof(uint16_t);
1334 src += sizeof(uint16_t);
1337 *(uint8_t *)dst = *(uint8_t *)src;
1341 * Build the Data Segment of inlined data from single
1342 * segment packet, no VLAN insertion.
1345 * Pointer to TX queue structure.
1347 * Pointer to burst routine local context.
1349 * Pointer to WQE to fill with built Data Segment.
1351 * Data buffer to point.
1353 * Data buffer length.
1355 * Configured Tx offloads mask. It is fully defined at
1356 * compile time and may be used for optimization.
1359 * Pointer to the next Data Segment after inlined data.
1360 * Ring buffer wraparound check is needed. We do not do it here because it
1361 * may not be needed for the last packet in the eMPW session.
1363 static __rte_always_inline struct mlx5_wqe_dseg *
1364 mlx5_tx_dseg_empw(struct mlx5_txq_data *__rte_restrict txq,
1365 struct mlx5_txq_local *__rte_restrict loc __rte_unused,
1366 struct mlx5_wqe_dseg *__rte_restrict dseg,
1369 unsigned int olx __rte_unused)
1374 if (!MLX5_TXOFF_CONFIG(MPW)) {
1375 /* Store the descriptor byte counter for eMPW sessions. */
1376 dseg->bcount = rte_cpu_to_be_32(len | MLX5_ETH_WQE_DATA_INLINE);
1377 pdst = &dseg->inline_data[0];
1379 /* The entire legacy MPW session counter is stored on close. */
1380 pdst = (uint8_t *)dseg;
1383 * The WQEBB space availability is checked by caller.
1384 * Here we should be aware of WQE ring buffer wraparound only.
1386 part = (uint8_t *)txq->wqes_end - pdst;
1387 part = RTE_MIN(part, len);
1389 rte_memcpy(pdst, buf, part);
1393 if (!MLX5_TXOFF_CONFIG(MPW))
1394 pdst = RTE_PTR_ALIGN(pdst, MLX5_WSEG_SIZE);
1395 /* Note: no final wraparound check here. */
1396 return (struct mlx5_wqe_dseg *)pdst;
1398 pdst = (uint8_t *)txq->wqes;
1405 * Build the Data Segment of inlined data from single
1406 * segment packet with VLAN insertion.
1409 * Pointer to TX queue structure.
1411 * Pointer to burst routine local context.
1413 * Pointer to the dseg fill with built Data Segment.
1415 * Data buffer to point.
1417 * Data buffer length.
1419 * Configured Tx offloads mask. It is fully defined at
1420 * compile time and may be used for optimization.
1423 * Pointer to the next Data Segment after inlined data.
1424 * Ring buffer wraparound check is needed.
1426 static __rte_always_inline struct mlx5_wqe_dseg *
1427 mlx5_tx_dseg_vlan(struct mlx5_txq_data *__rte_restrict txq,
1428 struct mlx5_txq_local *__rte_restrict loc __rte_unused,
1429 struct mlx5_wqe_dseg *__rte_restrict dseg,
1432 unsigned int olx __rte_unused)
1438 MLX5_ASSERT(len > MLX5_ESEG_MIN_INLINE_SIZE);
1439 if (!MLX5_TXOFF_CONFIG(MPW)) {
1440 /* Store the descriptor byte counter for eMPW sessions. */
1441 dseg->bcount = rte_cpu_to_be_32
1442 ((len + sizeof(struct rte_vlan_hdr)) |
1443 MLX5_ETH_WQE_DATA_INLINE);
1444 pdst = &dseg->inline_data[0];
1446 /* The entire legacy MPW session counter is stored on close. */
1447 pdst = (uint8_t *)dseg;
1449 memcpy(pdst, buf, MLX5_DSEG_MIN_INLINE_SIZE);
1450 buf += MLX5_DSEG_MIN_INLINE_SIZE;
1451 pdst += MLX5_DSEG_MIN_INLINE_SIZE;
1452 len -= MLX5_DSEG_MIN_INLINE_SIZE;
1453 /* Insert VLAN ethertype + VLAN tag. Pointer is aligned. */
1454 MLX5_ASSERT(pdst == RTE_PTR_ALIGN(pdst, MLX5_WSEG_SIZE));
1455 if (unlikely(pdst >= (uint8_t *)txq->wqes_end))
1456 pdst = (uint8_t *)txq->wqes;
1457 *(uint32_t *)pdst = rte_cpu_to_be_32((RTE_ETHER_TYPE_VLAN << 16) |
1458 loc->mbuf->vlan_tci);
1459 pdst += sizeof(struct rte_vlan_hdr);
1461 * The WQEBB space availability is checked by caller.
1462 * Here we should be aware of WQE ring buffer wraparound only.
1464 part = (uint8_t *)txq->wqes_end - pdst;
1465 part = RTE_MIN(part, len);
1467 rte_memcpy(pdst, buf, part);
1471 if (!MLX5_TXOFF_CONFIG(MPW))
1472 pdst = RTE_PTR_ALIGN(pdst, MLX5_WSEG_SIZE);
1473 /* Note: no final wraparound check here. */
1474 return (struct mlx5_wqe_dseg *)pdst;
1476 pdst = (uint8_t *)txq->wqes;
1483 * Build the Ethernet Segment with optionally inlined data with
1484 * VLAN insertion and following Data Segments (if any) from
1485 * multi-segment packet. Used by ordinary send and TSO.
1488 * Pointer to TX queue structure.
1490 * Pointer to burst routine local context.
1492 * Pointer to WQE to fill with built Ethernet/Data Segments.
1494 * Length of VLAN header to insert, 0 means no VLAN insertion.
1496 * Data length to inline. For TSO this parameter specifies exact value,
1497 * for ordinary send routine can be aligned by caller to provide better WQE
1498 * space saving and data buffer start address alignment.
1499 * This length includes VLAN header being inserted.
1501 * Zero means ordinary send, inlined data can be extended,
1502 * otherwise this is TSO, inlined data length is fixed.
1504 * Configured Tx offloads mask. It is fully defined at
1505 * compile time and may be used for optimization.
1508 * Actual size of built WQE in segments.
1510 static __rte_always_inline unsigned int
1511 mlx5_tx_mseg_build(struct mlx5_txq_data *__rte_restrict txq,
1512 struct mlx5_txq_local *__rte_restrict loc,
1513 struct mlx5_wqe *__rte_restrict wqe,
1517 unsigned int olx __rte_unused)
1519 struct mlx5_wqe_dseg *__rte_restrict dseg;
1522 MLX5_ASSERT((rte_pktmbuf_pkt_len(loc->mbuf) + vlan) >= inlen);
1523 loc->mbuf_nseg = NB_SEGS(loc->mbuf);
1526 dseg = mlx5_tx_eseg_mdat(txq, loc, wqe, vlan, inlen, tso, olx);
1527 if (!loc->mbuf_nseg)
1530 * There are still some mbuf remaining, not inlined.
1531 * The first mbuf may be partially inlined and we
1532 * must process the possible non-zero data offset.
1534 if (loc->mbuf_off) {
1539 * Exhausted packets must be dropped before.
1540 * Non-zero offset means there are some data
1541 * remained in the packet.
1543 MLX5_ASSERT(loc->mbuf_off < rte_pktmbuf_data_len(loc->mbuf));
1544 MLX5_ASSERT(rte_pktmbuf_data_len(loc->mbuf));
1545 dptr = rte_pktmbuf_mtod_offset(loc->mbuf, uint8_t *,
1547 dlen = rte_pktmbuf_data_len(loc->mbuf) - loc->mbuf_off;
1549 * Build the pointer/minimal Data Segment.
1550 * Do ring buffer wrapping check in advance.
1552 if ((uintptr_t)dseg >= (uintptr_t)txq->wqes_end)
1553 dseg = (struct mlx5_wqe_dseg *)txq->wqes;
1554 mlx5_tx_dseg_iptr(txq, loc, dseg, dptr, dlen, olx);
1555 /* Store the mbuf to be freed on completion. */
1556 MLX5_ASSERT(loc->elts_free);
1557 txq->elts[txq->elts_head++ & txq->elts_m] = loc->mbuf;
1560 if (--loc->mbuf_nseg == 0)
1562 loc->mbuf = loc->mbuf->next;
1566 if (unlikely(!rte_pktmbuf_data_len(loc->mbuf))) {
1567 struct rte_mbuf *mbuf;
1569 /* Zero length segment found, just skip. */
1571 loc->mbuf = loc->mbuf->next;
1572 rte_pktmbuf_free_seg(mbuf);
1573 if (--loc->mbuf_nseg == 0)
1576 if ((uintptr_t)dseg >= (uintptr_t)txq->wqes_end)
1577 dseg = (struct mlx5_wqe_dseg *)txq->wqes;
1580 rte_pktmbuf_mtod(loc->mbuf, uint8_t *),
1581 rte_pktmbuf_data_len(loc->mbuf), olx);
1582 MLX5_ASSERT(loc->elts_free);
1583 txq->elts[txq->elts_head++ & txq->elts_m] = loc->mbuf;
1586 if (--loc->mbuf_nseg == 0)
1588 loc->mbuf = loc->mbuf->next;
1593 /* Calculate actual segments used from the dseg pointer. */
1594 if ((uintptr_t)wqe < (uintptr_t)dseg)
1595 ds = ((uintptr_t)dseg - (uintptr_t)wqe) / MLX5_WSEG_SIZE;
1597 ds = (((uintptr_t)dseg - (uintptr_t)wqe) +
1598 txq->wqe_s * MLX5_WQE_SIZE) / MLX5_WSEG_SIZE;
1603 * The routine checks timestamp flag in the current packet,
1604 * and push WAIT WQE into the queue if scheduling is required.
1607 * Pointer to TX queue structure.
1609 * Pointer to burst routine local context.
1611 * Configured Tx offloads mask. It is fully defined at
1612 * compile time and may be used for optimization.
1615 * MLX5_TXCMP_CODE_EXIT - sending is done or impossible.
1616 * MLX5_TXCMP_CODE_SINGLE - continue processing with the packet.
1617 * MLX5_TXCMP_CODE_MULTI - the WAIT inserted, continue processing.
1618 * Local context variables partially updated.
1620 static __rte_always_inline enum mlx5_txcmp_code
1621 mlx5_tx_schedule_send(struct mlx5_txq_data *restrict txq,
1622 struct mlx5_txq_local *restrict loc,
1625 if (MLX5_TXOFF_CONFIG(TXPP) &&
1626 loc->mbuf->ol_flags & txq->ts_mask) {
1627 struct mlx5_wqe *wqe;
1632 * Estimate the required space quickly and roughly.
1633 * We would like to ensure the packet can be pushed
1634 * to the queue and we won't get the orphan WAIT WQE.
1636 if (loc->wqe_free <= MLX5_WQE_SIZE_MAX / MLX5_WQE_SIZE ||
1637 loc->elts_free < NB_SEGS(loc->mbuf))
1638 return MLX5_TXCMP_CODE_EXIT;
1639 /* Convert the timestamp into completion to wait. */
1640 ts = *RTE_MBUF_DYNFIELD(loc->mbuf, txq->ts_offset, uint64_t *);
1641 wci = mlx5_txpp_convert_tx_ts(txq->sh, ts);
1642 if (unlikely(wci < 0))
1643 return MLX5_TXCMP_CODE_SINGLE;
1644 /* Build the WAIT WQE with specified completion. */
1645 wqe = txq->wqes + (txq->wqe_ci & txq->wqe_m);
1646 mlx5_tx_cseg_init(txq, loc, wqe, 2, MLX5_OPCODE_WAIT, olx);
1647 mlx5_tx_wseg_init(txq, loc, wqe, wci, olx);
1650 return MLX5_TXCMP_CODE_MULTI;
1652 return MLX5_TXCMP_CODE_SINGLE;
1656 * Tx one packet function for multi-segment TSO. Supports all
1657 * types of Tx offloads, uses MLX5_OPCODE_TSO to build WQEs,
1658 * sends one packet per WQE.
1660 * This routine is responsible for storing processed mbuf
1661 * into elts ring buffer and update elts_head.
1664 * Pointer to TX queue structure.
1666 * Pointer to burst routine local context.
1668 * Configured Tx offloads mask. It is fully defined at
1669 * compile time and may be used for optimization.
1672 * MLX5_TXCMP_CODE_EXIT - sending is done or impossible.
1673 * MLX5_TXCMP_CODE_ERROR - some unrecoverable error occurred.
1674 * Local context variables partially updated.
1676 static __rte_always_inline enum mlx5_txcmp_code
1677 mlx5_tx_packet_multi_tso(struct mlx5_txq_data *__rte_restrict txq,
1678 struct mlx5_txq_local *__rte_restrict loc,
1681 struct mlx5_wqe *__rte_restrict wqe;
1682 unsigned int ds, dlen, inlen, ntcp, vlan = 0;
1684 if (MLX5_TXOFF_CONFIG(TXPP)) {
1685 enum mlx5_txcmp_code wret;
1687 /* Generate WAIT for scheduling if requested. */
1688 wret = mlx5_tx_schedule_send(txq, loc, olx);
1689 if (wret == MLX5_TXCMP_CODE_EXIT)
1690 return MLX5_TXCMP_CODE_EXIT;
1691 if (wret == MLX5_TXCMP_CODE_ERROR)
1692 return MLX5_TXCMP_CODE_ERROR;
1695 * Calculate data length to be inlined to estimate
1696 * the required space in WQE ring buffer.
1698 dlen = rte_pktmbuf_pkt_len(loc->mbuf);
1699 if (MLX5_TXOFF_CONFIG(VLAN) && loc->mbuf->ol_flags & RTE_MBUF_F_TX_VLAN)
1700 vlan = sizeof(struct rte_vlan_hdr);
1701 inlen = loc->mbuf->l2_len + vlan +
1702 loc->mbuf->l3_len + loc->mbuf->l4_len;
1703 if (unlikely((!inlen || !loc->mbuf->tso_segsz)))
1704 return MLX5_TXCMP_CODE_ERROR;
1705 if (loc->mbuf->ol_flags & RTE_MBUF_F_TX_TUNNEL_MASK)
1706 inlen += loc->mbuf->outer_l2_len + loc->mbuf->outer_l3_len;
1707 /* Packet must contain all TSO headers. */
1708 if (unlikely(inlen > MLX5_MAX_TSO_HEADER ||
1709 inlen <= MLX5_ESEG_MIN_INLINE_SIZE ||
1710 inlen > (dlen + vlan)))
1711 return MLX5_TXCMP_CODE_ERROR;
1712 MLX5_ASSERT(inlen >= txq->inlen_mode);
1714 * Check whether there are enough free WQEBBs:
1716 * - Ethernet Segment
1717 * - First Segment of inlined Ethernet data
1718 * - ... data continued ...
1719 * - Data Segments of pointer/min inline type
1721 ds = NB_SEGS(loc->mbuf) + 2 + (inlen -
1722 MLX5_ESEG_MIN_INLINE_SIZE +
1724 MLX5_WSEG_SIZE - 1) / MLX5_WSEG_SIZE;
1725 if (unlikely(loc->wqe_free < ((ds + 3) / 4)))
1726 return MLX5_TXCMP_CODE_EXIT;
1727 /* Check for maximal WQE size. */
1728 if (unlikely((MLX5_WQE_SIZE_MAX / MLX5_WSEG_SIZE) < ((ds + 3) / 4)))
1729 return MLX5_TXCMP_CODE_ERROR;
1730 #ifdef MLX5_PMD_SOFT_COUNTERS
1731 /* Update sent data bytes/packets counters. */
1732 ntcp = (dlen - (inlen - vlan) + loc->mbuf->tso_segsz - 1) /
1733 loc->mbuf->tso_segsz;
1735 * One will be added for mbuf itself at the end of the mlx5_tx_burst
1736 * from loc->pkts_sent field.
1739 txq->stats.opackets += ntcp;
1740 txq->stats.obytes += dlen + vlan + ntcp * inlen;
1742 wqe = txq->wqes + (txq->wqe_ci & txq->wqe_m);
1743 loc->wqe_last = wqe;
1744 mlx5_tx_cseg_init(txq, loc, wqe, 0, MLX5_OPCODE_TSO, olx);
1745 ds = mlx5_tx_mseg_build(txq, loc, wqe, vlan, inlen, 1, olx);
1746 wqe->cseg.sq_ds = rte_cpu_to_be_32(txq->qp_num_8s | ds);
1747 txq->wqe_ci += (ds + 3) / 4;
1748 loc->wqe_free -= (ds + 3) / 4;
1749 return MLX5_TXCMP_CODE_MULTI;
1753 * Tx one packet function for multi-segment SEND. Supports all types of Tx
1754 * offloads, uses MLX5_OPCODE_SEND to build WQEs, sends one packet per WQE,
1755 * without any data inlining in Ethernet Segment.
1757 * This routine is responsible for storing processed mbuf
1758 * into elts ring buffer and update elts_head.
1761 * Pointer to TX queue structure.
1763 * Pointer to burst routine local context.
1765 * Configured Tx offloads mask. It is fully defined at
1766 * compile time and may be used for optimization.
1769 * MLX5_TXCMP_CODE_EXIT - sending is done or impossible.
1770 * MLX5_TXCMP_CODE_ERROR - some unrecoverable error occurred.
1771 * Local context variables partially updated.
1773 static __rte_always_inline enum mlx5_txcmp_code
1774 mlx5_tx_packet_multi_send(struct mlx5_txq_data *__rte_restrict txq,
1775 struct mlx5_txq_local *__rte_restrict loc,
1778 struct mlx5_wqe_dseg *__rte_restrict dseg;
1779 struct mlx5_wqe *__rte_restrict wqe;
1780 unsigned int ds, nseg;
1782 MLX5_ASSERT(NB_SEGS(loc->mbuf) > 1);
1783 if (MLX5_TXOFF_CONFIG(TXPP)) {
1784 enum mlx5_txcmp_code wret;
1786 /* Generate WAIT for scheduling if requested. */
1787 wret = mlx5_tx_schedule_send(txq, loc, olx);
1788 if (wret == MLX5_TXCMP_CODE_EXIT)
1789 return MLX5_TXCMP_CODE_EXIT;
1790 if (wret == MLX5_TXCMP_CODE_ERROR)
1791 return MLX5_TXCMP_CODE_ERROR;
1794 * No inline at all, it means the CPU cycles saving is prioritized at
1795 * configuration, we should not copy any packet data to WQE.
1797 nseg = NB_SEGS(loc->mbuf);
1799 if (unlikely(loc->wqe_free < ((ds + 3) / 4)))
1800 return MLX5_TXCMP_CODE_EXIT;
1801 /* Check for maximal WQE size. */
1802 if (unlikely((MLX5_WQE_SIZE_MAX / MLX5_WSEG_SIZE) < ((ds + 3) / 4)))
1803 return MLX5_TXCMP_CODE_ERROR;
1805 * Some Tx offloads may cause an error if packet is not long enough,
1806 * check against assumed minimal length.
1808 if (rte_pktmbuf_pkt_len(loc->mbuf) <= MLX5_ESEG_MIN_INLINE_SIZE)
1809 return MLX5_TXCMP_CODE_ERROR;
1810 #ifdef MLX5_PMD_SOFT_COUNTERS
1811 /* Update sent data bytes counter. */
1812 txq->stats.obytes += rte_pktmbuf_pkt_len(loc->mbuf);
1813 if (MLX5_TXOFF_CONFIG(VLAN) &&
1814 loc->mbuf->ol_flags & RTE_MBUF_F_TX_VLAN)
1815 txq->stats.obytes += sizeof(struct rte_vlan_hdr);
1818 * SEND WQE, one WQEBB:
1819 * - Control Segment, SEND opcode
1820 * - Ethernet Segment, optional VLAN, no inline
1821 * - Data Segments, pointer only type
1823 wqe = txq->wqes + (txq->wqe_ci & txq->wqe_m);
1824 loc->wqe_last = wqe;
1825 mlx5_tx_cseg_init(txq, loc, wqe, ds, MLX5_OPCODE_SEND, olx);
1826 mlx5_tx_eseg_none(txq, loc, wqe, olx);
1827 dseg = &wqe->dseg[0];
1829 if (unlikely(!rte_pktmbuf_data_len(loc->mbuf))) {
1830 struct rte_mbuf *mbuf;
1833 * Zero length segment found, have to correct total
1834 * size of WQE in segments.
1835 * It is supposed to be rare occasion, so in normal
1836 * case (no zero length segments) we avoid extra
1837 * writing to the Control Segment.
1840 wqe->cseg.sq_ds -= RTE_BE32(1);
1842 loc->mbuf = mbuf->next;
1843 rte_pktmbuf_free_seg(mbuf);
1849 rte_pktmbuf_mtod(loc->mbuf, uint8_t *),
1850 rte_pktmbuf_data_len(loc->mbuf), olx);
1851 txq->elts[txq->elts_head++ & txq->elts_m] = loc->mbuf;
1856 if ((uintptr_t)dseg >= (uintptr_t)txq->wqes_end)
1857 dseg = (struct mlx5_wqe_dseg *)txq->wqes;
1858 loc->mbuf = loc->mbuf->next;
1861 txq->wqe_ci += (ds + 3) / 4;
1862 loc->wqe_free -= (ds + 3) / 4;
1863 return MLX5_TXCMP_CODE_MULTI;
1867 * Tx one packet function for multi-segment SEND. Supports all
1868 * types of Tx offloads, uses MLX5_OPCODE_SEND to build WQEs,
1869 * sends one packet per WQE, with data inlining in
1870 * Ethernet Segment and minimal Data Segments.
1872 * This routine is responsible for storing processed mbuf
1873 * into elts ring buffer and update elts_head.
1876 * Pointer to TX queue structure.
1878 * Pointer to burst routine local context.
1880 * Configured Tx offloads mask. It is fully defined at
1881 * compile time and may be used for optimization.
1884 * MLX5_TXCMP_CODE_EXIT - sending is done or impossible.
1885 * MLX5_TXCMP_CODE_ERROR - some unrecoverable error occurred.
1886 * Local context variables partially updated.
1888 static __rte_always_inline enum mlx5_txcmp_code
1889 mlx5_tx_packet_multi_inline(struct mlx5_txq_data *__rte_restrict txq,
1890 struct mlx5_txq_local *__rte_restrict loc,
1893 struct mlx5_wqe *__rte_restrict wqe;
1894 unsigned int ds, inlen, dlen, vlan = 0;
1896 MLX5_ASSERT(MLX5_TXOFF_CONFIG(INLINE));
1897 MLX5_ASSERT(NB_SEGS(loc->mbuf) > 1);
1898 if (MLX5_TXOFF_CONFIG(TXPP)) {
1899 enum mlx5_txcmp_code wret;
1901 /* Generate WAIT for scheduling if requested. */
1902 wret = mlx5_tx_schedule_send(txq, loc, olx);
1903 if (wret == MLX5_TXCMP_CODE_EXIT)
1904 return MLX5_TXCMP_CODE_EXIT;
1905 if (wret == MLX5_TXCMP_CODE_ERROR)
1906 return MLX5_TXCMP_CODE_ERROR;
1909 * First calculate data length to be inlined
1910 * to estimate the required space for WQE.
1912 dlen = rte_pktmbuf_pkt_len(loc->mbuf);
1913 if (MLX5_TXOFF_CONFIG(VLAN) && loc->mbuf->ol_flags & RTE_MBUF_F_TX_VLAN)
1914 vlan = sizeof(struct rte_vlan_hdr);
1915 inlen = dlen + vlan;
1916 /* Check against minimal length. */
1917 if (inlen <= MLX5_ESEG_MIN_INLINE_SIZE)
1918 return MLX5_TXCMP_CODE_ERROR;
1919 MLX5_ASSERT(txq->inlen_send >= MLX5_ESEG_MIN_INLINE_SIZE);
1920 if (inlen > txq->inlen_send ||
1921 loc->mbuf->ol_flags & RTE_MBUF_F_TX_DYNF_NOINLINE) {
1922 struct rte_mbuf *mbuf;
1927 nxlen = rte_pktmbuf_data_len(mbuf);
1929 * Packet length exceeds the allowed inline data length,
1930 * check whether the minimal inlining is required.
1932 if (txq->inlen_mode) {
1933 MLX5_ASSERT(txq->inlen_mode >=
1934 MLX5_ESEG_MIN_INLINE_SIZE);
1935 MLX5_ASSERT(txq->inlen_mode <= txq->inlen_send);
1936 inlen = RTE_MIN(txq->inlen_mode, inlen);
1937 } else if (vlan && !txq->vlan_en) {
1939 * VLAN insertion is requested and hardware does not
1940 * support the offload, will do with software inline.
1942 inlen = MLX5_ESEG_MIN_INLINE_SIZE;
1943 } else if (mbuf->ol_flags & RTE_MBUF_F_TX_DYNF_NOINLINE ||
1944 nxlen > txq->inlen_send) {
1945 return mlx5_tx_packet_multi_send(txq, loc, olx);
1949 if (mbuf->ol_flags & RTE_MBUF_F_TX_DYNF_NOINLINE)
1952 * Now we know the minimal amount of data is requested
1953 * to inline. Check whether we should inline the buffers
1954 * from the chain beginning to eliminate some mbufs.
1956 if (unlikely(nxlen <= txq->inlen_send)) {
1957 /* We can inline first mbuf at least. */
1958 if (nxlen < inlen) {
1961 /* Scan mbufs till inlen filled. */
1966 nxlen = rte_pktmbuf_data_len(mbuf);
1968 } while (unlikely(nxlen < inlen));
1969 if (unlikely(nxlen > txq->inlen_send)) {
1970 /* We cannot inline entire mbuf. */
1971 smlen = inlen - smlen;
1972 start = rte_pktmbuf_mtod_offset
1973 (mbuf, uintptr_t, smlen);
1981 /* There should be not end of packet. */
1983 if (mbuf->ol_flags & RTE_MBUF_F_TX_DYNF_NOINLINE)
1985 nxlen = inlen + rte_pktmbuf_data_len(mbuf);
1986 } while (unlikely(nxlen < txq->inlen_send));
1988 start = rte_pktmbuf_mtod(mbuf, uintptr_t);
1990 * Check whether we can do inline to align start
1991 * address of data buffer to cacheline.
1994 start = (~start + 1) & (RTE_CACHE_LINE_SIZE - 1);
1995 if (unlikely(start)) {
1997 if (start <= txq->inlen_send)
2002 * Check whether there are enough free WQEBBs:
2004 * - Ethernet Segment
2005 * - First Segment of inlined Ethernet data
2006 * - ... data continued ...
2007 * - Data Segments of pointer/min inline type
2009 * Estimate the number of Data Segments conservatively,
2010 * supposing no any mbufs is being freed during inlining.
2013 MLX5_ASSERT(inlen <= txq->inlen_send);
2014 ds = NB_SEGS(loc->mbuf) + 2 + (inlen -
2015 MLX5_ESEG_MIN_INLINE_SIZE +
2017 MLX5_WSEG_SIZE - 1) / MLX5_WSEG_SIZE;
2018 if (unlikely(loc->wqe_free < ((ds + 3) / 4)))
2019 return MLX5_TXCMP_CODE_EXIT;
2020 /* Check for maximal WQE size. */
2021 if (unlikely((MLX5_WQE_SIZE_MAX / MLX5_WSEG_SIZE) < ((ds + 3) / 4)))
2022 return MLX5_TXCMP_CODE_ERROR;
2023 #ifdef MLX5_PMD_SOFT_COUNTERS
2024 /* Update sent data bytes/packets counters. */
2025 txq->stats.obytes += dlen + vlan;
2027 wqe = txq->wqes + (txq->wqe_ci & txq->wqe_m);
2028 loc->wqe_last = wqe;
2029 mlx5_tx_cseg_init(txq, loc, wqe, 0, MLX5_OPCODE_SEND, olx);
2030 ds = mlx5_tx_mseg_build(txq, loc, wqe, vlan, inlen, 0, olx);
2031 wqe->cseg.sq_ds = rte_cpu_to_be_32(txq->qp_num_8s | ds);
2032 txq->wqe_ci += (ds + 3) / 4;
2033 loc->wqe_free -= (ds + 3) / 4;
2034 return MLX5_TXCMP_CODE_MULTI;
2038 * Tx burst function for multi-segment packets. Supports all
2039 * types of Tx offloads, uses MLX5_OPCODE_SEND/TSO to build WQEs,
2040 * sends one packet per WQE. Function stops sending if it
2041 * encounters the single-segment packet.
2043 * This routine is responsible for storing processed mbuf
2044 * into elts ring buffer and update elts_head.
2047 * Pointer to TX queue structure.
2049 * Packets to transmit.
2051 * Number of packets in array.
2053 * Pointer to burst routine local context.
2055 * Configured Tx offloads mask. It is fully defined at
2056 * compile time and may be used for optimization.
2059 * MLX5_TXCMP_CODE_EXIT - sending is done or impossible.
2060 * MLX5_TXCMP_CODE_ERROR - some unrecoverable error occurred.
2061 * MLX5_TXCMP_CODE_SINGLE - single-segment packet encountered.
2062 * MLX5_TXCMP_CODE_TSO - TSO single-segment packet encountered.
2063 * Local context variables updated.
2065 static __rte_always_inline enum mlx5_txcmp_code
2066 mlx5_tx_burst_mseg(struct mlx5_txq_data *__rte_restrict txq,
2067 struct rte_mbuf **__rte_restrict pkts,
2068 unsigned int pkts_n,
2069 struct mlx5_txq_local *__rte_restrict loc,
2072 MLX5_ASSERT(loc->elts_free && loc->wqe_free);
2073 MLX5_ASSERT(pkts_n > loc->pkts_sent);
2074 pkts += loc->pkts_sent + 1;
2075 pkts_n -= loc->pkts_sent;
2077 enum mlx5_txcmp_code ret;
2079 MLX5_ASSERT(NB_SEGS(loc->mbuf) > 1);
2081 * Estimate the number of free elts quickly but conservatively.
2082 * Some segment may be fully inlined and freed,
2083 * ignore this here - precise estimation is costly.
2085 if (loc->elts_free < NB_SEGS(loc->mbuf))
2086 return MLX5_TXCMP_CODE_EXIT;
2087 if (MLX5_TXOFF_CONFIG(TSO) &&
2088 unlikely(loc->mbuf->ol_flags & RTE_MBUF_F_TX_TCP_SEG)) {
2089 /* Proceed with multi-segment TSO. */
2090 ret = mlx5_tx_packet_multi_tso(txq, loc, olx);
2091 } else if (MLX5_TXOFF_CONFIG(INLINE)) {
2092 /* Proceed with multi-segment SEND with inlining. */
2093 ret = mlx5_tx_packet_multi_inline(txq, loc, olx);
2095 /* Proceed with multi-segment SEND w/o inlining. */
2096 ret = mlx5_tx_packet_multi_send(txq, loc, olx);
2098 if (ret == MLX5_TXCMP_CODE_EXIT)
2099 return MLX5_TXCMP_CODE_EXIT;
2100 if (ret == MLX5_TXCMP_CODE_ERROR)
2101 return MLX5_TXCMP_CODE_ERROR;
2102 /* WQE is built, go to the next packet. */
2105 if (unlikely(!pkts_n || !loc->elts_free || !loc->wqe_free))
2106 return MLX5_TXCMP_CODE_EXIT;
2107 loc->mbuf = *pkts++;
2109 rte_prefetch0(*pkts);
2110 if (likely(NB_SEGS(loc->mbuf) > 1))
2112 /* Here ends the series of multi-segment packets. */
2113 if (MLX5_TXOFF_CONFIG(TSO) &&
2114 unlikely(loc->mbuf->ol_flags & RTE_MBUF_F_TX_TCP_SEG))
2115 return MLX5_TXCMP_CODE_TSO;
2116 return MLX5_TXCMP_CODE_SINGLE;
2122 * Tx burst function for single-segment packets with TSO.
2123 * Supports all types of Tx offloads, except multi-packets.
2124 * Uses MLX5_OPCODE_TSO to build WQEs, sends one packet per WQE.
2125 * Function stops sending if it encounters the multi-segment
2126 * packet or packet without TSO requested.
2128 * The routine is responsible for storing processed mbuf into elts ring buffer
2129 * and update elts_head if inline offloads is requested due to possible early
2130 * freeing of the inlined mbufs (can not store pkts array in elts as a batch).
2133 * Pointer to TX queue structure.
2135 * Packets to transmit.
2137 * Number of packets in array.
2139 * Pointer to burst routine local context.
2141 * Configured Tx offloads mask. It is fully defined at
2142 * compile time and may be used for optimization.
2145 * MLX5_TXCMP_CODE_EXIT - sending is done or impossible.
2146 * MLX5_TXCMP_CODE_ERROR - some unrecoverable error occurred.
2147 * MLX5_TXCMP_CODE_SINGLE - single-segment packet encountered.
2148 * MLX5_TXCMP_CODE_MULTI - multi-segment packet encountered.
2149 * Local context variables updated.
2151 static __rte_always_inline enum mlx5_txcmp_code
2152 mlx5_tx_burst_tso(struct mlx5_txq_data *__rte_restrict txq,
2153 struct rte_mbuf **__rte_restrict pkts,
2154 unsigned int pkts_n,
2155 struct mlx5_txq_local *__rte_restrict loc,
2158 MLX5_ASSERT(loc->elts_free && loc->wqe_free);
2159 MLX5_ASSERT(pkts_n > loc->pkts_sent);
2160 pkts += loc->pkts_sent + 1;
2161 pkts_n -= loc->pkts_sent;
2163 struct mlx5_wqe_dseg *__rte_restrict dseg;
2164 struct mlx5_wqe *__rte_restrict wqe;
2165 unsigned int ds, dlen, hlen, ntcp, vlan = 0;
2168 MLX5_ASSERT(NB_SEGS(loc->mbuf) == 1);
2169 if (MLX5_TXOFF_CONFIG(TXPP)) {
2170 enum mlx5_txcmp_code wret;
2172 /* Generate WAIT for scheduling if requested. */
2173 wret = mlx5_tx_schedule_send(txq, loc, olx);
2174 if (wret == MLX5_TXCMP_CODE_EXIT)
2175 return MLX5_TXCMP_CODE_EXIT;
2176 if (wret == MLX5_TXCMP_CODE_ERROR)
2177 return MLX5_TXCMP_CODE_ERROR;
2179 dlen = rte_pktmbuf_data_len(loc->mbuf);
2180 if (MLX5_TXOFF_CONFIG(VLAN) &&
2181 loc->mbuf->ol_flags & RTE_MBUF_F_TX_VLAN) {
2182 vlan = sizeof(struct rte_vlan_hdr);
2185 * First calculate the WQE size to check
2186 * whether we have enough space in ring buffer.
2188 hlen = loc->mbuf->l2_len + vlan +
2189 loc->mbuf->l3_len + loc->mbuf->l4_len;
2190 if (unlikely((!hlen || !loc->mbuf->tso_segsz)))
2191 return MLX5_TXCMP_CODE_ERROR;
2192 if (loc->mbuf->ol_flags & RTE_MBUF_F_TX_TUNNEL_MASK)
2193 hlen += loc->mbuf->outer_l2_len +
2194 loc->mbuf->outer_l3_len;
2195 /* Segment must contain all TSO headers. */
2196 if (unlikely(hlen > MLX5_MAX_TSO_HEADER ||
2197 hlen <= MLX5_ESEG_MIN_INLINE_SIZE ||
2198 hlen > (dlen + vlan)))
2199 return MLX5_TXCMP_CODE_ERROR;
2201 * Check whether there are enough free WQEBBs:
2203 * - Ethernet Segment
2204 * - First Segment of inlined Ethernet data
2205 * - ... data continued ...
2206 * - Finishing Data Segment of pointer type
2208 ds = 4 + (hlen - MLX5_ESEG_MIN_INLINE_SIZE +
2209 MLX5_WSEG_SIZE - 1) / MLX5_WSEG_SIZE;
2210 if (loc->wqe_free < ((ds + 3) / 4))
2211 return MLX5_TXCMP_CODE_EXIT;
2212 #ifdef MLX5_PMD_SOFT_COUNTERS
2213 /* Update sent data bytes/packets counters. */
2214 ntcp = (dlen + vlan - hlen +
2215 loc->mbuf->tso_segsz - 1) /
2216 loc->mbuf->tso_segsz;
2218 * One will be added for mbuf itself at the end
2219 * of the mlx5_tx_burst from loc->pkts_sent field.
2222 txq->stats.opackets += ntcp;
2223 txq->stats.obytes += dlen + vlan + ntcp * hlen;
2226 * Build the TSO WQE:
2228 * - Ethernet Segment with hlen bytes inlined
2229 * - Data Segment of pointer type
2231 wqe = txq->wqes + (txq->wqe_ci & txq->wqe_m);
2232 loc->wqe_last = wqe;
2233 mlx5_tx_cseg_init(txq, loc, wqe, ds,
2234 MLX5_OPCODE_TSO, olx);
2235 dseg = mlx5_tx_eseg_data(txq, loc, wqe, vlan, hlen, 1, olx);
2236 dptr = rte_pktmbuf_mtod(loc->mbuf, uint8_t *) + hlen - vlan;
2237 dlen -= hlen - vlan;
2238 mlx5_tx_dseg_ptr(txq, loc, dseg, dptr, dlen, olx);
2240 * WQE is built, update the loop parameters
2241 * and go to the next packet.
2243 txq->wqe_ci += (ds + 3) / 4;
2244 loc->wqe_free -= (ds + 3) / 4;
2245 if (MLX5_TXOFF_CONFIG(INLINE))
2246 txq->elts[txq->elts_head++ & txq->elts_m] = loc->mbuf;
2250 if (unlikely(!pkts_n || !loc->elts_free || !loc->wqe_free))
2251 return MLX5_TXCMP_CODE_EXIT;
2252 loc->mbuf = *pkts++;
2254 rte_prefetch0(*pkts);
2255 if (MLX5_TXOFF_CONFIG(MULTI) &&
2256 unlikely(NB_SEGS(loc->mbuf) > 1))
2257 return MLX5_TXCMP_CODE_MULTI;
2258 if (likely(!(loc->mbuf->ol_flags & RTE_MBUF_F_TX_TCP_SEG)))
2259 return MLX5_TXCMP_CODE_SINGLE;
2260 /* Continue with the next TSO packet. */
2266 * Analyze the packet and select the best method to send.
2269 * Pointer to TX queue structure.
2271 * Pointer to burst routine local context.
2273 * Configured Tx offloads mask. It is fully defined at
2274 * compile time and may be used for optimization.
2276 * The predefined flag whether do complete check for
2277 * multi-segment packets and TSO.
2280 * MLX5_TXCMP_CODE_MULTI - multi-segment packet encountered.
2281 * MLX5_TXCMP_CODE_TSO - TSO required, use TSO/LSO.
2282 * MLX5_TXCMP_CODE_SINGLE - single-segment packet, use SEND.
2283 * MLX5_TXCMP_CODE_EMPW - single-segment packet, use MPW.
2285 static __rte_always_inline enum mlx5_txcmp_code
2286 mlx5_tx_able_to_empw(struct mlx5_txq_data *__rte_restrict txq,
2287 struct mlx5_txq_local *__rte_restrict loc,
2291 /* Check for multi-segment packet. */
2293 MLX5_TXOFF_CONFIG(MULTI) &&
2294 unlikely(NB_SEGS(loc->mbuf) > 1))
2295 return MLX5_TXCMP_CODE_MULTI;
2296 /* Check for TSO packet. */
2298 MLX5_TXOFF_CONFIG(TSO) &&
2299 unlikely(loc->mbuf->ol_flags & RTE_MBUF_F_TX_TCP_SEG))
2300 return MLX5_TXCMP_CODE_TSO;
2301 /* Check if eMPW is enabled at all. */
2302 if (!MLX5_TXOFF_CONFIG(EMPW))
2303 return MLX5_TXCMP_CODE_SINGLE;
2304 /* Check if eMPW can be engaged. */
2305 if (MLX5_TXOFF_CONFIG(VLAN) &&
2306 unlikely(loc->mbuf->ol_flags & RTE_MBUF_F_TX_VLAN) &&
2307 (!MLX5_TXOFF_CONFIG(INLINE) ||
2308 unlikely((rte_pktmbuf_data_len(loc->mbuf) +
2309 sizeof(struct rte_vlan_hdr)) > txq->inlen_empw))) {
2311 * eMPW does not support VLAN insertion offload, we have to
2312 * inline the entire packet but packet is too long for inlining.
2314 return MLX5_TXCMP_CODE_SINGLE;
2316 return MLX5_TXCMP_CODE_EMPW;
2320 * Check the next packet attributes to match with the eMPW batch ones.
2321 * In addition, for legacy MPW the packet length is checked either.
2324 * Pointer to TX queue structure.
2326 * Pointer to Ethernet Segment of eMPW batch.
2328 * Pointer to burst routine local context.
2330 * Length of previous packet in MPW descriptor.
2332 * Configured Tx offloads mask. It is fully defined at
2333 * compile time and may be used for optimization.
2336 * true - packet match with eMPW batch attributes.
2337 * false - no match, eMPW should be restarted.
2339 static __rte_always_inline bool
2340 mlx5_tx_match_empw(struct mlx5_txq_data *__rte_restrict txq,
2341 struct mlx5_wqe_eseg *__rte_restrict es,
2342 struct mlx5_txq_local *__rte_restrict loc,
2346 uint8_t swp_flags = 0;
2348 /* Compare the checksum flags, if any. */
2349 if (MLX5_TXOFF_CONFIG(CSUM) &&
2350 txq_ol_cksum_to_cs(loc->mbuf) != es->cs_flags)
2352 /* Compare the Software Parser offsets and flags. */
2353 if (MLX5_TXOFF_CONFIG(SWP) &&
2354 (es->swp_offs != txq_mbuf_to_swp(loc, &swp_flags, olx) ||
2355 es->swp_flags != swp_flags))
2357 /* Fill metadata field if needed. */
2358 if (MLX5_TXOFF_CONFIG(METADATA) &&
2359 es->metadata != (loc->mbuf->ol_flags & RTE_MBUF_DYNFLAG_TX_METADATA ?
2360 rte_cpu_to_be_32(*RTE_FLOW_DYNF_METADATA(loc->mbuf)) : 0))
2362 /* Legacy MPW can send packets with the same length only. */
2363 if (MLX5_TXOFF_CONFIG(MPW) &&
2364 dlen != rte_pktmbuf_data_len(loc->mbuf))
2366 /* There must be no VLAN packets in eMPW loop. */
2367 if (MLX5_TXOFF_CONFIG(VLAN))
2368 MLX5_ASSERT(!(loc->mbuf->ol_flags & RTE_MBUF_F_TX_VLAN));
2369 /* Check if the scheduling is requested. */
2370 if (MLX5_TXOFF_CONFIG(TXPP) &&
2371 loc->mbuf->ol_flags & txq->ts_mask)
2377 * Update send loop variables and WQE for eMPW loop without data inlining.
2378 * Number of Data Segments is equal to the number of sent packets.
2381 * Pointer to TX queue structure.
2383 * Pointer to burst routine local context.
2385 * Number of packets/Data Segments/Packets.
2387 * Accumulated statistics, bytes sent.
2389 * Configured Tx offloads mask. It is fully defined at
2390 * compile time and may be used for optimization.
2393 * true - packet match with eMPW batch attributes.
2394 * false - no match, eMPW should be restarted.
2396 static __rte_always_inline void
2397 mlx5_tx_sdone_empw(struct mlx5_txq_data *__rte_restrict txq,
2398 struct mlx5_txq_local *__rte_restrict loc,
2401 unsigned int olx __rte_unused)
2403 MLX5_ASSERT(!MLX5_TXOFF_CONFIG(INLINE));
2404 #ifdef MLX5_PMD_SOFT_COUNTERS
2405 /* Update sent data bytes counter. */
2406 txq->stats.obytes += slen;
2410 loc->elts_free -= ds;
2411 loc->pkts_sent += ds;
2413 loc->wqe_last->cseg.sq_ds = rte_cpu_to_be_32(txq->qp_num_8s | ds);
2414 txq->wqe_ci += (ds + 3) / 4;
2415 loc->wqe_free -= (ds + 3) / 4;
2419 * Update send loop variables and WQE for eMPW loop with data inlining.
2420 * Gets the size of pushed descriptors and data to the WQE.
2423 * Pointer to TX queue structure.
2425 * Pointer to burst routine local context.
2427 * Total size of descriptor/data in bytes.
2429 * Accumulated statistics, data bytes sent.
2431 * The base WQE for the eMPW/MPW descriptor.
2433 * Configured Tx offloads mask. It is fully defined at
2434 * compile time and may be used for optimization.
2437 * true - packet match with eMPW batch attributes.
2438 * false - no match, eMPW should be restarted.
2440 static __rte_always_inline void
2441 mlx5_tx_idone_empw(struct mlx5_txq_data *__rte_restrict txq,
2442 struct mlx5_txq_local *__rte_restrict loc,
2445 struct mlx5_wqe *__rte_restrict wqem,
2446 unsigned int olx __rte_unused)
2448 struct mlx5_wqe_dseg *dseg = &wqem->dseg[0];
2450 MLX5_ASSERT(MLX5_TXOFF_CONFIG(INLINE));
2451 #ifdef MLX5_PMD_SOFT_COUNTERS
2452 /* Update sent data bytes counter. */
2453 txq->stats.obytes += slen;
2457 if (MLX5_TXOFF_CONFIG(MPW) && dseg->bcount == RTE_BE32(0)) {
2459 * If the legacy MPW session contains the inline packets
2460 * we should set the only inline data segment length
2461 * and align the total length to the segment size.
2463 MLX5_ASSERT(len > sizeof(dseg->bcount));
2464 dseg->bcount = rte_cpu_to_be_32((len - sizeof(dseg->bcount)) |
2465 MLX5_ETH_WQE_DATA_INLINE);
2466 len = (len + MLX5_WSEG_SIZE - 1) / MLX5_WSEG_SIZE + 2;
2469 * The session is not legacy MPW or contains the
2470 * data buffer pointer segments.
2472 MLX5_ASSERT((len % MLX5_WSEG_SIZE) == 0);
2473 len = len / MLX5_WSEG_SIZE + 2;
2475 wqem->cseg.sq_ds = rte_cpu_to_be_32(txq->qp_num_8s | len);
2476 txq->wqe_ci += (len + 3) / 4;
2477 loc->wqe_free -= (len + 3) / 4;
2478 loc->wqe_last = wqem;
2482 * The set of Tx burst functions for single-segment packets without TSO
2483 * and with Multi-Packet Writing feature support.
2484 * Supports all types of Tx offloads, except multi-packets and TSO.
2486 * Uses MLX5_OPCODE_EMPW to build WQEs if possible and sends as many packet
2487 * per WQE as it can. If eMPW is not configured or packet can not be sent with
2488 * eMPW (VLAN insertion) the ordinary SEND opcode is used and only one packet
2491 * Functions stop sending if it encounters the multi-segment packet or packet
2492 * with TSO requested.
2494 * The routines are responsible for storing processed mbuf into elts ring buffer
2495 * and update elts_head if inlining offload is requested. Otherwise the copying
2496 * mbufs to elts can be postponed and completed at the end of burst routine.
2499 * Pointer to TX queue structure.
2501 * Packets to transmit.
2503 * Number of packets in array.
2505 * Pointer to burst routine local context.
2507 * Configured Tx offloads mask. It is fully defined at
2508 * compile time and may be used for optimization.
2511 * MLX5_TXCMP_CODE_EXIT - sending is done or impossible.
2512 * MLX5_TXCMP_CODE_ERROR - some unrecoverable error occurred.
2513 * MLX5_TXCMP_CODE_MULTI - multi-segment packet encountered.
2514 * MLX5_TXCMP_CODE_TSO - TSO packet encountered.
2515 * MLX5_TXCMP_CODE_SINGLE - used inside functions set.
2516 * MLX5_TXCMP_CODE_EMPW - used inside functions set.
2518 * Local context variables updated.
2521 * The routine sends packets with MLX5_OPCODE_EMPW
2522 * without inlining, this is dedicated optimized branch.
2523 * No VLAN insertion is supported.
2525 static __rte_always_inline enum mlx5_txcmp_code
2526 mlx5_tx_burst_empw_simple(struct mlx5_txq_data *__rte_restrict txq,
2527 struct rte_mbuf **__rte_restrict pkts,
2528 unsigned int pkts_n,
2529 struct mlx5_txq_local *__rte_restrict loc,
2533 * Subroutine is the part of mlx5_tx_burst_single() and sends
2534 * single-segment packet with eMPW opcode without data inlining.
2536 MLX5_ASSERT(!MLX5_TXOFF_CONFIG(INLINE));
2537 MLX5_ASSERT(MLX5_TXOFF_CONFIG(EMPW));
2538 MLX5_ASSERT(loc->elts_free && loc->wqe_free);
2539 MLX5_ASSERT(pkts_n > loc->pkts_sent);
2540 pkts += loc->pkts_sent + 1;
2541 pkts_n -= loc->pkts_sent;
2543 struct mlx5_wqe_dseg *__rte_restrict dseg;
2544 struct mlx5_wqe_eseg *__rte_restrict eseg;
2545 enum mlx5_txcmp_code ret;
2546 unsigned int part, loop;
2547 unsigned int slen = 0;
2550 MLX5_ASSERT(NB_SEGS(loc->mbuf) == 1);
2551 if (MLX5_TXOFF_CONFIG(TXPP)) {
2552 enum mlx5_txcmp_code wret;
2554 /* Generate WAIT for scheduling if requested. */
2555 wret = mlx5_tx_schedule_send(txq, loc, olx);
2556 if (wret == MLX5_TXCMP_CODE_EXIT)
2557 return MLX5_TXCMP_CODE_EXIT;
2558 if (wret == MLX5_TXCMP_CODE_ERROR)
2559 return MLX5_TXCMP_CODE_ERROR;
2561 part = RTE_MIN(pkts_n, MLX5_TXOFF_CONFIG(MPW) ?
2562 MLX5_MPW_MAX_PACKETS :
2563 MLX5_EMPW_MAX_PACKETS);
2564 if (unlikely(loc->elts_free < part)) {
2565 /* We have no enough elts to save all mbufs. */
2566 if (unlikely(loc->elts_free < MLX5_EMPW_MIN_PACKETS))
2567 return MLX5_TXCMP_CODE_EXIT;
2568 /* But we still able to send at least minimal eMPW. */
2569 part = loc->elts_free;
2571 /* Check whether we have enough WQEs */
2572 if (unlikely(loc->wqe_free < ((2 + part + 3) / 4))) {
2573 if (unlikely(loc->wqe_free <
2574 ((2 + MLX5_EMPW_MIN_PACKETS + 3) / 4)))
2575 return MLX5_TXCMP_CODE_EXIT;
2576 part = (loc->wqe_free * 4) - 2;
2578 if (likely(part > 1))
2579 rte_prefetch0(*pkts);
2580 loc->wqe_last = txq->wqes + (txq->wqe_ci & txq->wqe_m);
2582 * Build eMPW title WQEBB:
2583 * - Control Segment, eMPW opcode
2584 * - Ethernet Segment, no inline
2586 mlx5_tx_cseg_init(txq, loc, loc->wqe_last, part + 2,
2587 MLX5_OPCODE_ENHANCED_MPSW, olx);
2588 mlx5_tx_eseg_none(txq, loc, loc->wqe_last,
2589 olx & ~MLX5_TXOFF_CONFIG_VLAN);
2590 eseg = &loc->wqe_last->eseg;
2591 dseg = &loc->wqe_last->dseg[0];
2593 /* Store the packet length for legacy MPW. */
2594 if (MLX5_TXOFF_CONFIG(MPW))
2595 eseg->mss = rte_cpu_to_be_16
2596 (rte_pktmbuf_data_len(loc->mbuf));
2598 uint32_t dlen = rte_pktmbuf_data_len(loc->mbuf);
2599 #ifdef MLX5_PMD_SOFT_COUNTERS
2600 /* Update sent data bytes counter. */
2605 rte_pktmbuf_mtod(loc->mbuf, uint8_t *),
2607 if (unlikely(--loop == 0))
2609 loc->mbuf = *pkts++;
2610 if (likely(loop > 1))
2611 rte_prefetch0(*pkts);
2612 ret = mlx5_tx_able_to_empw(txq, loc, olx, true);
2614 * Unroll the completion code to avoid
2615 * returning variable value - it results in
2616 * unoptimized sequent checking in caller.
2618 if (ret == MLX5_TXCMP_CODE_MULTI) {
2620 mlx5_tx_sdone_empw(txq, loc, part, slen, olx);
2621 if (unlikely(!loc->elts_free ||
2623 return MLX5_TXCMP_CODE_EXIT;
2624 return MLX5_TXCMP_CODE_MULTI;
2626 MLX5_ASSERT(NB_SEGS(loc->mbuf) == 1);
2627 if (ret == MLX5_TXCMP_CODE_TSO) {
2629 mlx5_tx_sdone_empw(txq, loc, part, slen, olx);
2630 if (unlikely(!loc->elts_free ||
2632 return MLX5_TXCMP_CODE_EXIT;
2633 return MLX5_TXCMP_CODE_TSO;
2635 if (ret == MLX5_TXCMP_CODE_SINGLE) {
2637 mlx5_tx_sdone_empw(txq, loc, part, slen, olx);
2638 if (unlikely(!loc->elts_free ||
2640 return MLX5_TXCMP_CODE_EXIT;
2641 return MLX5_TXCMP_CODE_SINGLE;
2643 if (ret != MLX5_TXCMP_CODE_EMPW) {
2646 mlx5_tx_sdone_empw(txq, loc, part, slen, olx);
2647 return MLX5_TXCMP_CODE_ERROR;
2650 * Check whether packet parameters coincide
2651 * within assumed eMPW batch:
2652 * - check sum settings
2654 * - software parser settings
2655 * - packets length (legacy MPW only)
2656 * - scheduling is not required
2658 if (!mlx5_tx_match_empw(txq, eseg, loc, dlen, olx)) {
2661 mlx5_tx_sdone_empw(txq, loc, part, slen, olx);
2662 if (unlikely(!loc->elts_free ||
2664 return MLX5_TXCMP_CODE_EXIT;
2668 /* Packet attributes match, continue the same eMPW. */
2670 if ((uintptr_t)dseg >= (uintptr_t)txq->wqes_end)
2671 dseg = (struct mlx5_wqe_dseg *)txq->wqes;
2673 /* eMPW is built successfully, update loop parameters. */
2675 MLX5_ASSERT(pkts_n >= part);
2676 #ifdef MLX5_PMD_SOFT_COUNTERS
2677 /* Update sent data bytes counter. */
2678 txq->stats.obytes += slen;
2680 loc->elts_free -= part;
2681 loc->pkts_sent += part;
2682 txq->wqe_ci += (2 + part + 3) / 4;
2683 loc->wqe_free -= (2 + part + 3) / 4;
2685 if (unlikely(!pkts_n || !loc->elts_free || !loc->wqe_free))
2686 return MLX5_TXCMP_CODE_EXIT;
2687 loc->mbuf = *pkts++;
2688 ret = mlx5_tx_able_to_empw(txq, loc, olx, true);
2689 if (unlikely(ret != MLX5_TXCMP_CODE_EMPW))
2691 /* Continue sending eMPW batches. */
2697 * The routine sends packets with MLX5_OPCODE_EMPW
2698 * with inlining, optionally supports VLAN insertion.
2700 static __rte_always_inline enum mlx5_txcmp_code
2701 mlx5_tx_burst_empw_inline(struct mlx5_txq_data *__rte_restrict txq,
2702 struct rte_mbuf **__rte_restrict pkts,
2703 unsigned int pkts_n,
2704 struct mlx5_txq_local *__rte_restrict loc,
2708 * Subroutine is the part of mlx5_tx_burst_single() and sends
2709 * single-segment packet with eMPW opcode with data inlining.
2711 MLX5_ASSERT(MLX5_TXOFF_CONFIG(INLINE));
2712 MLX5_ASSERT(MLX5_TXOFF_CONFIG(EMPW));
2713 MLX5_ASSERT(loc->elts_free && loc->wqe_free);
2714 MLX5_ASSERT(pkts_n > loc->pkts_sent);
2715 pkts += loc->pkts_sent + 1;
2716 pkts_n -= loc->pkts_sent;
2718 struct mlx5_wqe_dseg *__rte_restrict dseg;
2719 struct mlx5_wqe *__rte_restrict wqem;
2720 enum mlx5_txcmp_code ret;
2721 unsigned int room, part, nlim;
2722 unsigned int slen = 0;
2724 MLX5_ASSERT(NB_SEGS(loc->mbuf) == 1);
2725 if (MLX5_TXOFF_CONFIG(TXPP)) {
2726 enum mlx5_txcmp_code wret;
2728 /* Generate WAIT for scheduling if requested. */
2729 wret = mlx5_tx_schedule_send(txq, loc, olx);
2730 if (wret == MLX5_TXCMP_CODE_EXIT)
2731 return MLX5_TXCMP_CODE_EXIT;
2732 if (wret == MLX5_TXCMP_CODE_ERROR)
2733 return MLX5_TXCMP_CODE_ERROR;
2736 * Limits the amount of packets in one WQE
2737 * to improve CQE latency generation.
2739 nlim = RTE_MIN(pkts_n, MLX5_TXOFF_CONFIG(MPW) ?
2740 MLX5_MPW_INLINE_MAX_PACKETS :
2741 MLX5_EMPW_MAX_PACKETS);
2742 /* Check whether we have minimal amount WQEs */
2743 if (unlikely(loc->wqe_free <
2744 ((2 + MLX5_EMPW_MIN_PACKETS + 3) / 4)))
2745 return MLX5_TXCMP_CODE_EXIT;
2746 if (likely(pkts_n > 1))
2747 rte_prefetch0(*pkts);
2748 wqem = txq->wqes + (txq->wqe_ci & txq->wqe_m);
2750 * Build eMPW title WQEBB:
2751 * - Control Segment, eMPW opcode, zero DS
2752 * - Ethernet Segment, no inline
2754 mlx5_tx_cseg_init(txq, loc, wqem, 0,
2755 MLX5_OPCODE_ENHANCED_MPSW, olx);
2756 mlx5_tx_eseg_none(txq, loc, wqem,
2757 olx & ~MLX5_TXOFF_CONFIG_VLAN);
2758 dseg = &wqem->dseg[0];
2759 /* Store the packet length for legacy MPW. */
2760 if (MLX5_TXOFF_CONFIG(MPW))
2761 wqem->eseg.mss = rte_cpu_to_be_16
2762 (rte_pktmbuf_data_len(loc->mbuf));
2763 room = RTE_MIN(MLX5_WQE_SIZE_MAX / MLX5_WQE_SIZE,
2764 loc->wqe_free) * MLX5_WQE_SIZE -
2765 MLX5_WQE_CSEG_SIZE -
2767 /* Limit the room for legacy MPW sessions for performance. */
2768 if (MLX5_TXOFF_CONFIG(MPW))
2769 room = RTE_MIN(room,
2770 RTE_MAX(txq->inlen_empw +
2771 sizeof(dseg->bcount) +
2772 (MLX5_TXOFF_CONFIG(VLAN) ?
2773 sizeof(struct rte_vlan_hdr) : 0),
2774 MLX5_MPW_INLINE_MAX_PACKETS *
2775 MLX5_WQE_DSEG_SIZE));
2776 /* Build WQE till we have space, packets and resources. */
2779 uint32_t dlen = rte_pktmbuf_data_len(loc->mbuf);
2780 uint8_t *dptr = rte_pktmbuf_mtod(loc->mbuf, uint8_t *);
2783 MLX5_ASSERT(room >= MLX5_WQE_DSEG_SIZE);
2784 MLX5_ASSERT((room % MLX5_WQE_DSEG_SIZE) == 0);
2785 MLX5_ASSERT((uintptr_t)dseg < (uintptr_t)txq->wqes_end);
2787 * Some Tx offloads may cause an error if packet is not
2788 * long enough, check against assumed minimal length.
2790 if (unlikely(dlen <= MLX5_ESEG_MIN_INLINE_SIZE)) {
2792 if (unlikely(!part))
2793 return MLX5_TXCMP_CODE_ERROR;
2795 * We have some successfully built
2796 * packet Data Segments to send.
2798 mlx5_tx_idone_empw(txq, loc, part,
2800 return MLX5_TXCMP_CODE_ERROR;
2802 /* Inline or not inline - that's the Question. */
2803 if (dlen > txq->inlen_empw ||
2804 loc->mbuf->ol_flags & RTE_MBUF_F_TX_DYNF_NOINLINE)
2806 if (MLX5_TXOFF_CONFIG(MPW)) {
2807 if (dlen > txq->inlen_send)
2811 /* Open new inline MPW session. */
2812 tlen += sizeof(dseg->bcount);
2813 dseg->bcount = RTE_BE32(0);
2815 (dseg, sizeof(dseg->bcount));
2818 * No pointer and inline descriptor
2819 * intermix for legacy MPW sessions.
2821 if (wqem->dseg[0].bcount)
2825 tlen = sizeof(dseg->bcount) + dlen;
2827 /* Inline entire packet, optional VLAN insertion. */
2828 if (MLX5_TXOFF_CONFIG(VLAN) &&
2829 loc->mbuf->ol_flags & RTE_MBUF_F_TX_VLAN) {
2831 * The packet length must be checked in
2832 * mlx5_tx_able_to_empw() and packet
2833 * fits into inline length guaranteed.
2836 sizeof(struct rte_vlan_hdr)) <=
2838 tlen += sizeof(struct rte_vlan_hdr);
2841 dseg = mlx5_tx_dseg_vlan(txq, loc, dseg,
2843 #ifdef MLX5_PMD_SOFT_COUNTERS
2844 /* Update sent data bytes counter. */
2845 slen += sizeof(struct rte_vlan_hdr);
2850 dseg = mlx5_tx_dseg_empw(txq, loc, dseg,
2853 if (!MLX5_TXOFF_CONFIG(MPW))
2854 tlen = RTE_ALIGN(tlen, MLX5_WSEG_SIZE);
2855 MLX5_ASSERT(room >= tlen);
2858 * Packet data are completely inline,
2859 * we can try to free the packet.
2861 if (likely(loc->pkts_sent == loc->mbuf_free)) {
2863 * All the packets from the burst beginning
2864 * are inline, we can free mbufs directly
2865 * from the origin array on tx_burst exit().
2871 * In order no to call rte_pktmbuf_free_seg() here,
2872 * in the most inner loop (that might be very
2873 * expensive) we just save the mbuf in elts.
2875 txq->elts[txq->elts_head++ & txq->elts_m] = loc->mbuf;
2880 * No pointer and inline descriptor
2881 * intermix for legacy MPW sessions.
2883 if (MLX5_TXOFF_CONFIG(MPW) &&
2885 wqem->dseg[0].bcount == RTE_BE32(0))
2888 * Not inlinable VLAN packets are
2889 * proceeded outside of this routine.
2891 MLX5_ASSERT(room >= MLX5_WQE_DSEG_SIZE);
2892 if (MLX5_TXOFF_CONFIG(VLAN))
2893 MLX5_ASSERT(!(loc->mbuf->ol_flags &
2894 RTE_MBUF_F_TX_VLAN));
2895 mlx5_tx_dseg_ptr(txq, loc, dseg, dptr, dlen, olx);
2896 /* We have to store mbuf in elts.*/
2897 txq->elts[txq->elts_head++ & txq->elts_m] = loc->mbuf;
2899 room -= MLX5_WQE_DSEG_SIZE;
2900 /* Ring buffer wraparound is checked at the loop end.*/
2903 #ifdef MLX5_PMD_SOFT_COUNTERS
2904 /* Update sent data bytes counter. */
2909 if (unlikely(!pkts_n || !loc->elts_free)) {
2911 * We have no resources/packets to
2912 * continue build descriptors.
2915 mlx5_tx_idone_empw(txq, loc, part,
2917 return MLX5_TXCMP_CODE_EXIT;
2919 loc->mbuf = *pkts++;
2920 if (likely(pkts_n > 1))
2921 rte_prefetch0(*pkts);
2922 ret = mlx5_tx_able_to_empw(txq, loc, olx, true);
2924 * Unroll the completion code to avoid
2925 * returning variable value - it results in
2926 * unoptimized sequent checking in caller.
2928 if (ret == MLX5_TXCMP_CODE_MULTI) {
2930 mlx5_tx_idone_empw(txq, loc, part,
2932 if (unlikely(!loc->elts_free ||
2934 return MLX5_TXCMP_CODE_EXIT;
2935 return MLX5_TXCMP_CODE_MULTI;
2937 MLX5_ASSERT(NB_SEGS(loc->mbuf) == 1);
2938 if (ret == MLX5_TXCMP_CODE_TSO) {
2940 mlx5_tx_idone_empw(txq, loc, part,
2942 if (unlikely(!loc->elts_free ||
2944 return MLX5_TXCMP_CODE_EXIT;
2945 return MLX5_TXCMP_CODE_TSO;
2947 if (ret == MLX5_TXCMP_CODE_SINGLE) {
2949 mlx5_tx_idone_empw(txq, loc, part,
2951 if (unlikely(!loc->elts_free ||
2953 return MLX5_TXCMP_CODE_EXIT;
2954 return MLX5_TXCMP_CODE_SINGLE;
2956 if (ret != MLX5_TXCMP_CODE_EMPW) {
2959 mlx5_tx_idone_empw(txq, loc, part,
2961 return MLX5_TXCMP_CODE_ERROR;
2963 /* Check if we have minimal room left. */
2965 if (unlikely(!nlim || room < MLX5_WQE_DSEG_SIZE))
2968 * Check whether packet parameters coincide
2969 * within assumed eMPW batch:
2970 * - check sum settings
2972 * - software parser settings
2973 * - packets length (legacy MPW only)
2974 * - scheduling is not required
2976 if (!mlx5_tx_match_empw(txq, &wqem->eseg,
2979 /* Packet attributes match, continue the same eMPW. */
2980 if ((uintptr_t)dseg >= (uintptr_t)txq->wqes_end)
2981 dseg = (struct mlx5_wqe_dseg *)txq->wqes;
2984 * We get here to close an existing eMPW
2985 * session and start the new one.
2987 MLX5_ASSERT(pkts_n);
2989 if (unlikely(!part))
2990 return MLX5_TXCMP_CODE_EXIT;
2991 mlx5_tx_idone_empw(txq, loc, part, slen, wqem, olx);
2992 if (unlikely(!loc->elts_free ||
2994 return MLX5_TXCMP_CODE_EXIT;
2995 /* Continue the loop with new eMPW session. */
3001 * The routine sends packets with ordinary MLX5_OPCODE_SEND.
3002 * Data inlining and VLAN insertion are supported.
3004 static __rte_always_inline enum mlx5_txcmp_code
3005 mlx5_tx_burst_single_send(struct mlx5_txq_data *__rte_restrict txq,
3006 struct rte_mbuf **__rte_restrict pkts,
3007 unsigned int pkts_n,
3008 struct mlx5_txq_local *__rte_restrict loc,
3012 * Subroutine is the part of mlx5_tx_burst_single()
3013 * and sends single-segment packet with SEND opcode.
3015 MLX5_ASSERT(loc->elts_free && loc->wqe_free);
3016 MLX5_ASSERT(pkts_n > loc->pkts_sent);
3017 pkts += loc->pkts_sent + 1;
3018 pkts_n -= loc->pkts_sent;
3020 struct mlx5_wqe *__rte_restrict wqe;
3021 enum mlx5_txcmp_code ret;
3023 MLX5_ASSERT(NB_SEGS(loc->mbuf) == 1);
3024 if (MLX5_TXOFF_CONFIG(TXPP)) {
3025 enum mlx5_txcmp_code wret;
3027 /* Generate WAIT for scheduling if requested. */
3028 wret = mlx5_tx_schedule_send(txq, loc, olx);
3029 if (wret == MLX5_TXCMP_CODE_EXIT)
3030 return MLX5_TXCMP_CODE_EXIT;
3031 if (wret == MLX5_TXCMP_CODE_ERROR)
3032 return MLX5_TXCMP_CODE_ERROR;
3034 if (MLX5_TXOFF_CONFIG(INLINE)) {
3035 unsigned int inlen, vlan = 0;
3037 inlen = rte_pktmbuf_data_len(loc->mbuf);
3038 if (MLX5_TXOFF_CONFIG(VLAN) &&
3039 loc->mbuf->ol_flags & RTE_MBUF_F_TX_VLAN) {
3040 vlan = sizeof(struct rte_vlan_hdr);
3044 * If inlining is enabled at configuration time
3045 * the limit must be not less than minimal size.
3046 * Otherwise we would do extra check for data
3047 * size to avoid crashes due to length overflow.
3049 MLX5_ASSERT(txq->inlen_send >=
3050 MLX5_ESEG_MIN_INLINE_SIZE);
3051 if (inlen <= txq->inlen_send) {
3052 unsigned int seg_n, wqe_n;
3054 rte_prefetch0(rte_pktmbuf_mtod
3055 (loc->mbuf, uint8_t *));
3056 /* Check against minimal length. */
3057 if (inlen <= MLX5_ESEG_MIN_INLINE_SIZE)
3058 return MLX5_TXCMP_CODE_ERROR;
3059 if (loc->mbuf->ol_flags &
3060 RTE_MBUF_F_TX_DYNF_NOINLINE) {
3062 * The hint flag not to inline packet
3063 * data is set. Check whether we can
3066 if ((!MLX5_TXOFF_CONFIG(EMPW) &&
3068 (MLX5_TXOFF_CONFIG(MPW) &&
3070 if (inlen <= txq->inlen_send)
3073 * The hardware requires the
3074 * minimal inline data header.
3076 goto single_min_inline;
3078 if (MLX5_TXOFF_CONFIG(VLAN) &&
3079 vlan && !txq->vlan_en) {
3081 * We must insert VLAN tag
3082 * by software means.
3084 goto single_part_inline;
3086 goto single_no_inline;
3090 * Completely inlined packet data WQE:
3091 * - Control Segment, SEND opcode
3092 * - Ethernet Segment, no VLAN insertion
3093 * - Data inlined, VLAN optionally inserted
3094 * - Alignment to MLX5_WSEG_SIZE
3095 * Have to estimate amount of WQEBBs
3097 seg_n = (inlen + 3 * MLX5_WSEG_SIZE -
3098 MLX5_ESEG_MIN_INLINE_SIZE +
3099 MLX5_WSEG_SIZE - 1) / MLX5_WSEG_SIZE;
3100 /* Check if there are enough WQEBBs. */
3101 wqe_n = (seg_n + 3) / 4;
3102 if (wqe_n > loc->wqe_free)
3103 return MLX5_TXCMP_CODE_EXIT;
3104 wqe = txq->wqes + (txq->wqe_ci & txq->wqe_m);
3105 loc->wqe_last = wqe;
3106 mlx5_tx_cseg_init(txq, loc, wqe, seg_n,
3107 MLX5_OPCODE_SEND, olx);
3108 mlx5_tx_eseg_data(txq, loc, wqe,
3109 vlan, inlen, 0, olx);
3110 txq->wqe_ci += wqe_n;
3111 loc->wqe_free -= wqe_n;
3113 * Packet data are completely inlined,
3114 * free the packet immediately.
3116 rte_pktmbuf_free_seg(loc->mbuf);
3117 } else if ((!MLX5_TXOFF_CONFIG(EMPW) ||
3118 MLX5_TXOFF_CONFIG(MPW)) &&
3121 * If minimal inlining is requested the eMPW
3122 * feature should be disabled due to data is
3123 * inlined into Ethernet Segment, which can
3124 * not contain inlined data for eMPW due to
3125 * segment shared for all packets.
3127 struct mlx5_wqe_dseg *__rte_restrict dseg;
3132 * The inline-mode settings require
3133 * to inline the specified amount of
3134 * data bytes to the Ethernet Segment.
3135 * We should check the free space in
3136 * WQE ring buffer to inline partially.
3139 MLX5_ASSERT(txq->inlen_send >= txq->inlen_mode);
3140 MLX5_ASSERT(inlen > txq->inlen_mode);
3141 MLX5_ASSERT(txq->inlen_mode >=
3142 MLX5_ESEG_MIN_INLINE_SIZE);
3144 * Check whether there are enough free WQEBBs:
3146 * - Ethernet Segment
3147 * - First Segment of inlined Ethernet data
3148 * - ... data continued ...
3149 * - Finishing Data Segment of pointer type
3151 ds = (MLX5_WQE_CSEG_SIZE +
3152 MLX5_WQE_ESEG_SIZE +
3153 MLX5_WQE_DSEG_SIZE +
3155 MLX5_ESEG_MIN_INLINE_SIZE +
3156 MLX5_WQE_DSEG_SIZE +
3157 MLX5_WSEG_SIZE - 1) / MLX5_WSEG_SIZE;
3158 if (loc->wqe_free < ((ds + 3) / 4))
3159 return MLX5_TXCMP_CODE_EXIT;
3161 * Build the ordinary SEND WQE:
3163 * - Ethernet Segment, inline inlen_mode bytes
3164 * - Data Segment of pointer type
3166 wqe = txq->wqes + (txq->wqe_ci & txq->wqe_m);
3167 loc->wqe_last = wqe;
3168 mlx5_tx_cseg_init(txq, loc, wqe, ds,
3169 MLX5_OPCODE_SEND, olx);
3170 dseg = mlx5_tx_eseg_data(txq, loc, wqe, vlan,
3173 dptr = rte_pktmbuf_mtod(loc->mbuf, uint8_t *) +
3174 txq->inlen_mode - vlan;
3175 inlen -= txq->inlen_mode;
3176 mlx5_tx_dseg_ptr(txq, loc, dseg,
3179 * WQE is built, update the loop parameters
3180 * and got to the next packet.
3182 txq->wqe_ci += (ds + 3) / 4;
3183 loc->wqe_free -= (ds + 3) / 4;
3184 /* We have to store mbuf in elts.*/
3185 MLX5_ASSERT(MLX5_TXOFF_CONFIG(INLINE));
3186 txq->elts[txq->elts_head++ & txq->elts_m] =
3194 * Partially inlined packet data WQE, we have
3195 * some space in title WQEBB, we can fill it
3196 * with some packet data. It takes one WQEBB,
3197 * it is available, no extra space check:
3198 * - Control Segment, SEND opcode
3199 * - Ethernet Segment, no VLAN insertion
3200 * - MLX5_ESEG_MIN_INLINE_SIZE bytes of Data
3201 * - Data Segment, pointer type
3203 * We also get here if VLAN insertion is not
3204 * supported by HW, the inline is enabled.
3207 wqe = txq->wqes + (txq->wqe_ci & txq->wqe_m);
3208 loc->wqe_last = wqe;
3209 mlx5_tx_cseg_init(txq, loc, wqe, 4,
3210 MLX5_OPCODE_SEND, olx);
3211 mlx5_tx_eseg_dmin(txq, loc, wqe, vlan, olx);
3212 dptr = rte_pktmbuf_mtod(loc->mbuf, uint8_t *) +
3213 MLX5_ESEG_MIN_INLINE_SIZE - vlan;
3215 * The length check is performed above, by
3216 * comparing with txq->inlen_send. We should
3217 * not get overflow here.
3219 MLX5_ASSERT(inlen > MLX5_ESEG_MIN_INLINE_SIZE);
3220 dlen = inlen - MLX5_ESEG_MIN_INLINE_SIZE;
3221 mlx5_tx_dseg_ptr(txq, loc, &wqe->dseg[1],
3225 /* We have to store mbuf in elts.*/
3226 MLX5_ASSERT(MLX5_TXOFF_CONFIG(INLINE));
3227 txq->elts[txq->elts_head++ & txq->elts_m] =
3231 #ifdef MLX5_PMD_SOFT_COUNTERS
3232 /* Update sent data bytes counter. */
3233 txq->stats.obytes += vlan +
3234 rte_pktmbuf_data_len(loc->mbuf);
3238 * No inline at all, it means the CPU cycles saving
3239 * is prioritized at configuration, we should not
3240 * copy any packet data to WQE.
3242 * SEND WQE, one WQEBB:
3243 * - Control Segment, SEND opcode
3244 * - Ethernet Segment, optional VLAN, no inline
3245 * - Data Segment, pointer type
3248 wqe = txq->wqes + (txq->wqe_ci & txq->wqe_m);
3249 loc->wqe_last = wqe;
3250 mlx5_tx_cseg_init(txq, loc, wqe, 3,
3251 MLX5_OPCODE_SEND, olx);
3252 mlx5_tx_eseg_none(txq, loc, wqe, olx);
3254 (txq, loc, &wqe->dseg[0],
3255 rte_pktmbuf_mtod(loc->mbuf, uint8_t *),
3256 rte_pktmbuf_data_len(loc->mbuf), olx);
3260 * We should not store mbuf pointer in elts
3261 * if no inlining is configured, this is done
3262 * by calling routine in a batch copy.
3264 MLX5_ASSERT(!MLX5_TXOFF_CONFIG(INLINE));
3266 #ifdef MLX5_PMD_SOFT_COUNTERS
3267 /* Update sent data bytes counter. */
3268 txq->stats.obytes += rte_pktmbuf_data_len(loc->mbuf);
3269 if (MLX5_TXOFF_CONFIG(VLAN) &&
3270 loc->mbuf->ol_flags & RTE_MBUF_F_TX_VLAN)
3271 txq->stats.obytes +=
3272 sizeof(struct rte_vlan_hdr);
3277 if (unlikely(!pkts_n || !loc->elts_free || !loc->wqe_free))
3278 return MLX5_TXCMP_CODE_EXIT;
3279 loc->mbuf = *pkts++;
3281 rte_prefetch0(*pkts);
3282 ret = mlx5_tx_able_to_empw(txq, loc, olx, true);
3283 if (unlikely(ret != MLX5_TXCMP_CODE_SINGLE))
3289 static __rte_always_inline enum mlx5_txcmp_code
3290 mlx5_tx_burst_single(struct mlx5_txq_data *__rte_restrict txq,
3291 struct rte_mbuf **__rte_restrict pkts,
3292 unsigned int pkts_n,
3293 struct mlx5_txq_local *__rte_restrict loc,
3296 enum mlx5_txcmp_code ret;
3298 ret = mlx5_tx_able_to_empw(txq, loc, olx, false);
3299 if (ret == MLX5_TXCMP_CODE_SINGLE)
3301 MLX5_ASSERT(ret == MLX5_TXCMP_CODE_EMPW);
3303 /* Optimize for inline/no inline eMPW send. */
3304 ret = (MLX5_TXOFF_CONFIG(INLINE)) ?
3305 mlx5_tx_burst_empw_inline
3306 (txq, pkts, pkts_n, loc, olx) :
3307 mlx5_tx_burst_empw_simple
3308 (txq, pkts, pkts_n, loc, olx);
3309 if (ret != MLX5_TXCMP_CODE_SINGLE)
3311 /* The resources to send one packet should remain. */
3312 MLX5_ASSERT(loc->elts_free && loc->wqe_free);
3314 ret = mlx5_tx_burst_single_send(txq, pkts, pkts_n, loc, olx);
3315 MLX5_ASSERT(ret != MLX5_TXCMP_CODE_SINGLE);
3316 if (ret != MLX5_TXCMP_CODE_EMPW)
3318 /* The resources to send one packet should remain. */
3319 MLX5_ASSERT(loc->elts_free && loc->wqe_free);
3324 * DPDK Tx callback template. This is configured template used to generate
3325 * routines optimized for specified offload setup.
3326 * One of this generated functions is chosen at SQ configuration time.
3329 * Generic pointer to TX queue structure.
3331 * Packets to transmit.
3333 * Number of packets in array.
3335 * Configured offloads mask, presents the bits of MLX5_TXOFF_CONFIG_xxx
3336 * values. Should be static to take compile time static configuration
3340 * Number of packets successfully transmitted (<= pkts_n).
3342 static __rte_always_inline uint16_t
3343 mlx5_tx_burst_tmpl(struct mlx5_txq_data *__rte_restrict txq,
3344 struct rte_mbuf **__rte_restrict pkts,
3348 struct mlx5_txq_local loc;
3349 enum mlx5_txcmp_code ret;
3352 MLX5_ASSERT(txq->elts_s >= (uint16_t)(txq->elts_head - txq->elts_tail));
3353 MLX5_ASSERT(txq->wqe_s >= (uint16_t)(txq->wqe_ci - txq->wqe_pi));
3354 if (unlikely(!pkts_n))
3356 if (MLX5_TXOFF_CONFIG(INLINE))
3360 loc.wqe_last = NULL;
3363 loc.pkts_loop = loc.pkts_sent;
3365 * Check if there are some CQEs, if any:
3366 * - process an encountered errors
3367 * - process the completed WQEs
3368 * - free related mbufs
3369 * - doorbell the NIC about processed CQEs
3371 rte_prefetch0(*(pkts + loc.pkts_sent));
3372 mlx5_tx_handle_completion(txq, olx);
3374 * Calculate the number of available resources - elts and WQEs.
3375 * There are two possible different scenarios:
3376 * - no data inlining into WQEs, one WQEBB may contains up to
3377 * four packets, in this case elts become scarce resource
3378 * - data inlining into WQEs, one packet may require multiple
3379 * WQEBBs, the WQEs become the limiting factor.
3381 MLX5_ASSERT(txq->elts_s >= (uint16_t)(txq->elts_head - txq->elts_tail));
3382 loc.elts_free = txq->elts_s -
3383 (uint16_t)(txq->elts_head - txq->elts_tail);
3384 MLX5_ASSERT(txq->wqe_s >= (uint16_t)(txq->wqe_ci - txq->wqe_pi));
3385 loc.wqe_free = txq->wqe_s -
3386 (uint16_t)(txq->wqe_ci - txq->wqe_pi);
3387 if (unlikely(!loc.elts_free || !loc.wqe_free))
3391 * Fetch the packet from array. Usually this is the first
3392 * packet in series of multi/single segment packets.
3394 loc.mbuf = *(pkts + loc.pkts_sent);
3395 /* Dedicated branch for multi-segment packets. */
3396 if (MLX5_TXOFF_CONFIG(MULTI) &&
3397 unlikely(NB_SEGS(loc.mbuf) > 1)) {
3399 * Multi-segment packet encountered.
3400 * Hardware is able to process it only
3401 * with SEND/TSO opcodes, one packet
3402 * per WQE, do it in dedicated routine.
3405 MLX5_ASSERT(loc.pkts_sent >= loc.pkts_copy);
3406 part = loc.pkts_sent - loc.pkts_copy;
3407 if (!MLX5_TXOFF_CONFIG(INLINE) && part) {
3409 * There are some single-segment mbufs not
3410 * stored in elts. The mbufs must be in the
3411 * same order as WQEs, so we must copy the
3412 * mbufs to elts here, before the coming
3413 * multi-segment packet mbufs is appended.
3415 mlx5_tx_copy_elts(txq, pkts + loc.pkts_copy,
3417 loc.pkts_copy = loc.pkts_sent;
3419 MLX5_ASSERT(pkts_n > loc.pkts_sent);
3420 ret = mlx5_tx_burst_mseg(txq, pkts, pkts_n, &loc, olx);
3421 if (!MLX5_TXOFF_CONFIG(INLINE))
3422 loc.pkts_copy = loc.pkts_sent;
3424 * These returned code checks are supposed
3425 * to be optimized out due to routine inlining.
3427 if (ret == MLX5_TXCMP_CODE_EXIT) {
3429 * The routine returns this code when
3430 * all packets are sent or there is no
3431 * enough resources to complete request.
3435 if (ret == MLX5_TXCMP_CODE_ERROR) {
3437 * The routine returns this code when some error
3438 * in the incoming packets format occurred.
3440 txq->stats.oerrors++;
3443 if (ret == MLX5_TXCMP_CODE_SINGLE) {
3445 * The single-segment packet was encountered
3446 * in the array, try to send it with the
3447 * best optimized way, possible engaging eMPW.
3449 goto enter_send_single;
3451 if (MLX5_TXOFF_CONFIG(TSO) &&
3452 ret == MLX5_TXCMP_CODE_TSO) {
3454 * The single-segment TSO packet was
3455 * encountered in the array.
3457 goto enter_send_tso;
3459 /* We must not get here. Something is going wrong. */
3461 txq->stats.oerrors++;
3464 /* Dedicated branch for single-segment TSO packets. */
3465 if (MLX5_TXOFF_CONFIG(TSO) &&
3466 unlikely(loc.mbuf->ol_flags & RTE_MBUF_F_TX_TCP_SEG)) {
3468 * TSO might require special way for inlining
3469 * (dedicated parameters) and is sent with
3470 * MLX5_OPCODE_TSO opcode only, provide this
3471 * in dedicated branch.
3474 MLX5_ASSERT(NB_SEGS(loc.mbuf) == 1);
3475 MLX5_ASSERT(pkts_n > loc.pkts_sent);
3476 ret = mlx5_tx_burst_tso(txq, pkts, pkts_n, &loc, olx);
3478 * These returned code checks are supposed
3479 * to be optimized out due to routine inlining.
3481 if (ret == MLX5_TXCMP_CODE_EXIT)
3483 if (ret == MLX5_TXCMP_CODE_ERROR) {
3484 txq->stats.oerrors++;
3487 if (ret == MLX5_TXCMP_CODE_SINGLE)
3488 goto enter_send_single;
3489 if (MLX5_TXOFF_CONFIG(MULTI) &&
3490 ret == MLX5_TXCMP_CODE_MULTI) {
3492 * The multi-segment packet was
3493 * encountered in the array.
3495 goto enter_send_multi;
3497 /* We must not get here. Something is going wrong. */
3499 txq->stats.oerrors++;
3503 * The dedicated branch for the single-segment packets
3504 * without TSO. Often these ones can be sent using
3505 * MLX5_OPCODE_EMPW with multiple packets in one WQE.
3506 * The routine builds the WQEs till it encounters
3507 * the TSO or multi-segment packet (in case if these
3508 * offloads are requested at SQ configuration time).
3511 MLX5_ASSERT(pkts_n > loc.pkts_sent);
3512 ret = mlx5_tx_burst_single(txq, pkts, pkts_n, &loc, olx);
3514 * These returned code checks are supposed
3515 * to be optimized out due to routine inlining.
3517 if (ret == MLX5_TXCMP_CODE_EXIT)
3519 if (ret == MLX5_TXCMP_CODE_ERROR) {
3520 txq->stats.oerrors++;
3523 if (MLX5_TXOFF_CONFIG(MULTI) &&
3524 ret == MLX5_TXCMP_CODE_MULTI) {
3526 * The multi-segment packet was
3527 * encountered in the array.
3529 goto enter_send_multi;
3531 if (MLX5_TXOFF_CONFIG(TSO) &&
3532 ret == MLX5_TXCMP_CODE_TSO) {
3534 * The single-segment TSO packet was
3535 * encountered in the array.
3537 goto enter_send_tso;
3539 /* We must not get here. Something is going wrong. */
3541 txq->stats.oerrors++;
3545 * Main Tx loop is completed, do the rest:
3546 * - set completion request if thresholds are reached
3547 * - doorbell the hardware
3548 * - copy the rest of mbufs to elts (if any)
3550 MLX5_ASSERT(MLX5_TXOFF_CONFIG(INLINE) ||
3551 loc.pkts_sent >= loc.pkts_copy);
3552 /* Take a shortcut if nothing is sent. */
3553 if (unlikely(loc.pkts_sent == loc.pkts_loop))
3555 /* Request CQE generation if limits are reached. */
3556 mlx5_tx_request_completion(txq, &loc, olx);
3558 * Ring QP doorbell immediately after WQE building completion
3559 * to improve latencies. The pure software related data treatment
3560 * can be completed after doorbell. Tx CQEs for this SQ are
3561 * processed in this thread only by the polling.
3563 * The rdma core library can map doorbell register in two ways,
3564 * depending on the environment variable "MLX5_SHUT_UP_BF":
3566 * - as regular cached memory, the variable is either missing or
3567 * set to zero. This type of mapping may cause the significant
3568 * doorbell register writing latency and requires explicit memory
3569 * write barrier to mitigate this issue and prevent write combining.
3571 * - as non-cached memory, the variable is present and set to not "0"
3572 * value. This type of mapping may cause performance impact under
3573 * heavy loading conditions but the explicit write memory barrier is
3574 * not required and it may improve core performance.
3576 * - the legacy behaviour (prior 19.08 release) was to use some
3577 * heuristics to decide whether write memory barrier should
3578 * be performed. This behavior is supported with specifying
3579 * tx_db_nc=2, write barrier is skipped if application provides
3580 * the full recommended burst of packets, it supposes the next
3581 * packets are coming and the write barrier will be issued on
3582 * the next burst (after descriptor writing, at least).
3584 mlx5_doorbell_ring(mlx5_tx_bfreg(txq),
3585 *(volatile uint64_t *)loc.wqe_last, txq->wqe_ci,
3586 txq->qp_db, !txq->db_nc &&
3587 (!txq->db_heu || pkts_n % MLX5_TX_DEFAULT_BURST));
3588 /* Not all of the mbufs may be stored into elts yet. */
3589 part = MLX5_TXOFF_CONFIG(INLINE) ? 0 : loc.pkts_sent - loc.pkts_copy;
3590 if (!MLX5_TXOFF_CONFIG(INLINE) && part) {
3592 * There are some single-segment mbufs not stored in elts.
3593 * It can be only if the last packet was single-segment.
3594 * The copying is gathered into one place due to it is
3595 * a good opportunity to optimize that with SIMD.
3596 * Unfortunately if inlining is enabled the gaps in pointer
3597 * array may happen due to early freeing of the inlined mbufs.
3599 mlx5_tx_copy_elts(txq, pkts + loc.pkts_copy, part, olx);
3600 loc.pkts_copy = loc.pkts_sent;
3602 MLX5_ASSERT(txq->elts_s >= (uint16_t)(txq->elts_head - txq->elts_tail));
3603 MLX5_ASSERT(txq->wqe_s >= (uint16_t)(txq->wqe_ci - txq->wqe_pi));
3604 if (pkts_n > loc.pkts_sent) {
3606 * If burst size is large there might be no enough CQE
3607 * fetched from completion queue and no enough resources
3608 * freed to send all the packets.
3613 #ifdef MLX5_PMD_SOFT_COUNTERS
3614 /* Increment sent packets counter. */
3615 txq->stats.opackets += loc.pkts_sent;
3617 if (MLX5_TXOFF_CONFIG(INLINE) && loc.mbuf_free)
3618 __mlx5_tx_free_mbuf(txq, pkts, loc.mbuf_free, olx);
3619 return loc.pkts_sent;
3622 #endif /* RTE_PMD_MLX5_TX_H_ */