7989a50403aac3a58bc95c1b664d2719f80059ee
[dpdk.git] / drivers / net / mlx5 / mlx5_rxtx.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright 2015 6WIND S.A.
3  * Copyright 2015 Mellanox Technologies, Ltd
4  */
5
6 #ifndef RTE_PMD_MLX5_RXTX_H_
7 #define RTE_PMD_MLX5_RXTX_H_
8
9 #include <stddef.h>
10 #include <stdint.h>
11 #include <sys/queue.h>
12
13 #include <rte_mbuf.h>
14 #include <rte_mempool.h>
15 #include <rte_common.h>
16 #include <rte_hexdump.h>
17 #include <rte_spinlock.h>
18 #include <rte_io.h>
19 #include <rte_bus_pci.h>
20 #include <rte_malloc.h>
21 #include <rte_cycles.h>
22
23 #include <mlx5_glue.h>
24 #include <mlx5_prm.h>
25 #include <mlx5_common.h>
26 #include <mlx5_common_mr.h>
27
28 #include "mlx5_defs.h"
29 #include "mlx5_utils.h"
30 #include "mlx5.h"
31 #include "mlx5_autoconf.h"
32 #include "mlx5_mr.h"
33
34 /* Support tunnel matching. */
35 #define MLX5_FLOW_TUNNEL 10
36
37 /* Mbuf dynamic flag offset for inline. */
38 extern uint64_t rte_net_mlx5_dynf_inline_mask;
39
40 struct mlx5_rxq_stats {
41 #ifdef MLX5_PMD_SOFT_COUNTERS
42         uint64_t ipackets; /**< Total of successfully received packets. */
43         uint64_t ibytes; /**< Total of successfully received bytes. */
44 #endif
45         uint64_t idropped; /**< Total of packets dropped when RX ring full. */
46         uint64_t rx_nombuf; /**< Total of RX mbuf allocation failures. */
47 };
48
49 struct mlx5_txq_stats {
50 #ifdef MLX5_PMD_SOFT_COUNTERS
51         uint64_t opackets; /**< Total of successfully sent packets. */
52         uint64_t obytes; /**< Total of successfully sent bytes. */
53 #endif
54         uint64_t oerrors; /**< Total number of failed transmitted packets. */
55 };
56
57 struct mlx5_priv;
58
59 /* Compressed CQE context. */
60 struct rxq_zip {
61         uint16_t ai; /* Array index. */
62         uint16_t ca; /* Current array index. */
63         uint16_t na; /* Next array index. */
64         uint16_t cq_ci; /* The next CQE. */
65         uint32_t cqe_cnt; /* Number of CQEs. */
66 };
67
68 /* Multi-Packet RQ buffer header. */
69 struct mlx5_mprq_buf {
70         struct rte_mempool *mp;
71         uint16_t refcnt; /* Atomically accessed refcnt. */
72         uint8_t pad[RTE_PKTMBUF_HEADROOM]; /* Headroom for the first packet. */
73         struct rte_mbuf_ext_shared_info shinfos[];
74         /*
75          * Shared information per stride.
76          * More memory will be allocated for the first stride head-room and for
77          * the strides data.
78          */
79 } __rte_cache_aligned;
80
81 /* Get pointer to the first stride. */
82 #define mlx5_mprq_buf_addr(ptr, strd_n) (RTE_PTR_ADD((ptr), \
83                                 sizeof(struct mlx5_mprq_buf) + \
84                                 (strd_n) * \
85                                 sizeof(struct rte_mbuf_ext_shared_info) + \
86                                 RTE_PKTMBUF_HEADROOM))
87
88 #define MLX5_MIN_SINGLE_STRIDE_LOG_NUM_BYTES 6
89 #define MLX5_MIN_SINGLE_WQE_LOG_NUM_STRIDES 9
90
91 enum mlx5_rxq_err_state {
92         MLX5_RXQ_ERR_STATE_NO_ERROR = 0,
93         MLX5_RXQ_ERR_STATE_NEED_RESET,
94         MLX5_RXQ_ERR_STATE_NEED_READY,
95 };
96
97 enum mlx5_rqx_code {
98         MLX5_RXQ_CODE_EXIT = 0,
99         MLX5_RXQ_CODE_NOMBUF,
100         MLX5_RXQ_CODE_DROPPED,
101 };
102
103 struct mlx5_eth_rxseg {
104         struct rte_mempool *mp; /**< Memory pool to allocate segment from. */
105         uint16_t length; /**< Segment data length, configures split point. */
106         uint16_t offset; /**< Data offset from beginning of mbuf data buffer. */
107         uint32_t reserved; /**< Reserved field. */
108 };
109
110 /* RX queue descriptor. */
111 struct mlx5_rxq_data {
112         unsigned int csum:1; /* Enable checksum offloading. */
113         unsigned int hw_timestamp:1; /* Enable HW timestamp. */
114         unsigned int rt_timestamp:1; /* Realtime timestamp format. */
115         unsigned int vlan_strip:1; /* Enable VLAN stripping. */
116         unsigned int crc_present:1; /* CRC must be subtracted. */
117         unsigned int sges_n:3; /* Log 2 of SGEs (max buffers per packet). */
118         unsigned int cqe_n:4; /* Log 2 of CQ elements. */
119         unsigned int elts_n:4; /* Log 2 of Mbufs. */
120         unsigned int rss_hash:1; /* RSS hash result is enabled. */
121         unsigned int mark:1; /* Marked flow available on the queue. */
122         unsigned int strd_num_n:5; /* Log 2 of the number of stride. */
123         unsigned int strd_sz_n:4; /* Log 2 of stride size. */
124         unsigned int strd_shift_en:1; /* Enable 2bytes shift on a stride. */
125         unsigned int err_state:2; /* enum mlx5_rxq_err_state. */
126         unsigned int strd_scatter_en:1; /* Scattered packets from a stride. */
127         unsigned int lro:1; /* Enable LRO. */
128         unsigned int dynf_meta:1; /* Dynamic metadata is configured. */
129         unsigned int mcqe_format:3; /* Dynamic metadata is configured. */
130         volatile uint32_t *rq_db;
131         volatile uint32_t *cq_db;
132         uint16_t port_id;
133         uint32_t elts_ci;
134         uint32_t rq_ci;
135         uint16_t consumed_strd; /* Number of consumed strides in WQE. */
136         uint32_t rq_pi;
137         uint32_t cq_ci;
138         uint16_t rq_repl_thresh; /* Threshold for buffer replenishment. */
139         uint32_t byte_mask;
140         union {
141                 struct rxq_zip zip; /* Compressed context. */
142                 uint16_t decompressed;
143                 /* Number of ready mbufs decompressed from the CQ. */
144         };
145         struct mlx5_mr_ctrl mr_ctrl; /* MR control descriptor. */
146         uint16_t mprq_max_memcpy_len; /* Maximum size of packet to memcpy. */
147         volatile void *wqes;
148         volatile struct mlx5_cqe(*cqes)[];
149         struct rte_mbuf *(*elts)[];
150         struct mlx5_mprq_buf *(*mprq_bufs)[];
151         struct rte_mempool *mp;
152         struct rte_mempool *mprq_mp; /* Mempool for Multi-Packet RQ. */
153         struct mlx5_mprq_buf *mprq_repl; /* Stashed mbuf for replenish. */
154         struct mlx5_dev_ctx_shared *sh; /* Shared context. */
155         uint16_t idx; /* Queue index. */
156         struct mlx5_rxq_stats stats;
157         rte_xmm_t mbuf_initializer; /* Default rearm/flags for vectorized Rx. */
158         struct rte_mbuf fake_mbuf; /* elts padding for vectorized Rx. */
159         void *cq_uar; /* Verbs CQ user access region. */
160         uint32_t cqn; /* CQ number. */
161         uint8_t cq_arm_sn; /* CQ arm seq number. */
162 #ifndef RTE_ARCH_64
163         rte_spinlock_t *uar_lock_cq;
164         /* CQ (UAR) access lock required for 32bit implementations */
165 #endif
166         uint32_t tunnel; /* Tunnel information. */
167         int timestamp_offset; /* Dynamic mbuf field for timestamp. */
168         uint64_t timestamp_rx_flag; /* Dynamic mbuf flag for timestamp. */
169         uint64_t flow_meta_mask;
170         int32_t flow_meta_offset;
171         uint32_t rxseg_n; /* Number of split segment descriptions. */
172         struct mlx5_eth_rxseg rxseg[MLX5_MAX_RXQ_NSEG];
173         /* Buffer split segment descriptions - sizes, offsets, pools. */
174 } __rte_cache_aligned;
175
176 enum mlx5_rxq_type {
177         MLX5_RXQ_TYPE_STANDARD, /* Standard Rx queue. */
178         MLX5_RXQ_TYPE_HAIRPIN, /* Hairpin Rx queue. */
179         MLX5_RXQ_TYPE_UNDEFINED,
180 };
181
182 /* RX queue control descriptor. */
183 struct mlx5_rxq_ctrl {
184         struct mlx5_rxq_data rxq; /* Data path structure. */
185         LIST_ENTRY(mlx5_rxq_ctrl) next; /* Pointer to the next element. */
186         uint32_t refcnt; /* Reference counter. */
187         struct mlx5_rxq_obj *obj; /* Verbs/DevX elements. */
188         struct mlx5_priv *priv; /* Back pointer to private data. */
189         enum mlx5_rxq_type type; /* Rxq type. */
190         unsigned int socket; /* CPU socket ID for allocations. */
191         unsigned int irq:1; /* Whether IRQ is enabled. */
192         uint32_t flow_mark_n; /* Number of Mark/Flag flows using this Queue. */
193         uint32_t flow_tunnels_n[MLX5_FLOW_TUNNEL]; /* Tunnels counters. */
194         uint32_t wqn; /* WQ number. */
195         uint16_t dump_file_n; /* Number of dump files. */
196         struct mlx5_devx_dbr_page *rq_dbrec_page;
197         uint64_t rq_dbr_offset;
198         /* Storing RQ door-bell information, needed when freeing door-bell. */
199         struct mlx5_devx_dbr_page *cq_dbrec_page;
200         uint64_t cq_dbr_offset;
201         /* Storing CQ door-bell information, needed when freeing door-bell. */
202         void *wq_umem; /* WQ buffer registration info. */
203         void *cq_umem; /* CQ buffer registration info. */
204         struct rte_eth_hairpin_conf hairpin_conf; /* Hairpin configuration. */
205         uint32_t hairpin_status; /* Hairpin binding status. */
206 };
207
208 /* TX queue send local data. */
209 __extension__
210 struct mlx5_txq_local {
211         struct mlx5_wqe *wqe_last; /* last sent WQE pointer. */
212         struct rte_mbuf *mbuf; /* first mbuf to process. */
213         uint16_t pkts_copy; /* packets copied to elts. */
214         uint16_t pkts_sent; /* packets sent. */
215         uint16_t pkts_loop; /* packets sent on loop entry. */
216         uint16_t elts_free; /* available elts remain. */
217         uint16_t wqe_free; /* available wqe remain. */
218         uint16_t mbuf_off; /* data offset in current mbuf. */
219         uint16_t mbuf_nseg; /* number of remaining mbuf. */
220 };
221
222 /* TX queue descriptor. */
223 __extension__
224 struct mlx5_txq_data {
225         uint16_t elts_head; /* Current counter in (*elts)[]. */
226         uint16_t elts_tail; /* Counter of first element awaiting completion. */
227         uint16_t elts_comp; /* elts index since last completion request. */
228         uint16_t elts_s; /* Number of mbuf elements. */
229         uint16_t elts_m; /* Mask for mbuf elements indices. */
230         /* Fields related to elts mbuf storage. */
231         uint16_t wqe_ci; /* Consumer index for work queue. */
232         uint16_t wqe_pi; /* Producer index for work queue. */
233         uint16_t wqe_s; /* Number of WQ elements. */
234         uint16_t wqe_m; /* Mask Number for WQ elements. */
235         uint16_t wqe_comp; /* WQE index since last completion request. */
236         uint16_t wqe_thres; /* WQE threshold to request completion in CQ. */
237         /* WQ related fields. */
238         uint16_t cq_ci; /* Consumer index for completion queue. */
239         uint16_t cq_pi; /* Production index for completion queue. */
240         uint16_t cqe_s; /* Number of CQ elements. */
241         uint16_t cqe_m; /* Mask for CQ indices. */
242         /* CQ related fields. */
243         uint16_t elts_n:4; /* elts[] length (in log2). */
244         uint16_t cqe_n:4; /* Number of CQ elements (in log2). */
245         uint16_t wqe_n:4; /* Number of WQ elements (in log2). */
246         uint16_t tso_en:1; /* When set hardware TSO is enabled. */
247         uint16_t tunnel_en:1;
248         /* When set TX offload for tunneled packets are supported. */
249         uint16_t swp_en:1; /* Whether SW parser is enabled. */
250         uint16_t vlan_en:1; /* VLAN insertion in WQE is supported. */
251         uint16_t db_nc:1; /* Doorbell mapped to non-cached region. */
252         uint16_t db_heu:1; /* Doorbell heuristic write barrier. */
253         uint16_t inlen_send; /* Ordinary send data inline size. */
254         uint16_t inlen_empw; /* eMPW max packet size to inline. */
255         uint16_t inlen_mode; /* Minimal data length to inline. */
256         uint32_t qp_num_8s; /* QP number shifted by 8. */
257         uint64_t offloads; /* Offloads for Tx Queue. */
258         struct mlx5_mr_ctrl mr_ctrl; /* MR control descriptor. */
259         struct mlx5_wqe *wqes; /* Work queue. */
260         struct mlx5_wqe *wqes_end; /* Work queue array limit. */
261 #ifdef RTE_LIBRTE_MLX5_DEBUG
262         uint32_t *fcqs; /* Free completion queue (debug extended). */
263 #else
264         uint16_t *fcqs; /* Free completion queue. */
265 #endif
266         volatile struct mlx5_cqe *cqes; /* Completion queue. */
267         volatile uint32_t *qp_db; /* Work queue doorbell. */
268         volatile uint32_t *cq_db; /* Completion queue doorbell. */
269         uint16_t port_id; /* Port ID of device. */
270         uint16_t idx; /* Queue index. */
271         uint64_t ts_mask; /* Timestamp flag dynamic mask. */
272         int32_t ts_offset; /* Timestamp field dynamic offset. */
273         struct mlx5_dev_ctx_shared *sh; /* Shared context. */
274         struct mlx5_txq_stats stats; /* TX queue counters. */
275 #ifndef RTE_ARCH_64
276         rte_spinlock_t *uar_lock;
277         /* UAR access lock required for 32bit implementations */
278 #endif
279         struct rte_mbuf *elts[0];
280         /* Storage for queued packets, must be the last field. */
281 } __rte_cache_aligned;
282
283 enum mlx5_txq_type {
284         MLX5_TXQ_TYPE_STANDARD, /* Standard Tx queue. */
285         MLX5_TXQ_TYPE_HAIRPIN, /* Hairpin Rx queue. */
286 };
287
288 /* TX queue control descriptor. */
289 struct mlx5_txq_ctrl {
290         LIST_ENTRY(mlx5_txq_ctrl) next; /* Pointer to the next element. */
291         uint32_t refcnt; /* Reference counter. */
292         unsigned int socket; /* CPU socket ID for allocations. */
293         enum mlx5_txq_type type; /* The txq ctrl type. */
294         unsigned int max_inline_data; /* Max inline data. */
295         unsigned int max_tso_header; /* Max TSO header size. */
296         struct mlx5_txq_obj *obj; /* Verbs/DevX queue object. */
297         struct mlx5_priv *priv; /* Back pointer to private data. */
298         off_t uar_mmap_offset; /* UAR mmap offset for non-primary process. */
299         void *bf_reg; /* BlueFlame register from Verbs. */
300         uint16_t dump_file_n; /* Number of dump files. */
301         struct rte_eth_hairpin_conf hairpin_conf; /* Hairpin configuration. */
302         uint32_t hairpin_status; /* Hairpin binding status. */
303         struct mlx5_txq_data txq; /* Data path structure. */
304         /* Must be the last field in the structure, contains elts[]. */
305 };
306
307 #define MLX5_TX_BFREG(txq) \
308                 (MLX5_PROC_PRIV((txq)->port_id)->uar_table[(txq)->idx])
309
310 /* mlx5_rxq.c */
311
312 extern uint8_t rss_hash_default_key[];
313
314 int mlx5_check_mprq_support(struct rte_eth_dev *dev);
315 int mlx5_rxq_mprq_enabled(struct mlx5_rxq_data *rxq);
316 int mlx5_mprq_enabled(struct rte_eth_dev *dev);
317 unsigned int mlx5_rxq_cqe_num(struct mlx5_rxq_data *rxq_data);
318 int mlx5_mprq_free_mp(struct rte_eth_dev *dev);
319 int mlx5_mprq_alloc_mp(struct rte_eth_dev *dev);
320 int mlx5_rx_queue_start(struct rte_eth_dev *dev, uint16_t queue_id);
321 int mlx5_rx_queue_stop(struct rte_eth_dev *dev, uint16_t queue_id);
322 int mlx5_rx_queue_start_primary(struct rte_eth_dev *dev, uint16_t queue_id);
323 int mlx5_rx_queue_stop_primary(struct rte_eth_dev *dev, uint16_t queue_id);
324 int mlx5_rx_queue_setup(struct rte_eth_dev *dev, uint16_t idx, uint16_t desc,
325                         unsigned int socket, const struct rte_eth_rxconf *conf,
326                         struct rte_mempool *mp);
327 int mlx5_rx_hairpin_queue_setup
328         (struct rte_eth_dev *dev, uint16_t idx, uint16_t desc,
329          const struct rte_eth_hairpin_conf *hairpin_conf);
330 void mlx5_rx_queue_release(void *dpdk_rxq);
331 int mlx5_rx_intr_vec_enable(struct rte_eth_dev *dev);
332 void mlx5_rx_intr_vec_disable(struct rte_eth_dev *dev);
333 int mlx5_rx_intr_enable(struct rte_eth_dev *dev, uint16_t rx_queue_id);
334 int mlx5_rx_intr_disable(struct rte_eth_dev *dev, uint16_t rx_queue_id);
335 int mlx5_rxq_obj_verify(struct rte_eth_dev *dev);
336 struct mlx5_rxq_ctrl *mlx5_rxq_new(struct rte_eth_dev *dev, uint16_t idx,
337                                    uint16_t desc, unsigned int socket,
338                                    const struct rte_eth_rxconf *conf,
339                                    const struct rte_eth_rxseg_split *rx_seg,
340                                    uint16_t n_seg);
341 struct mlx5_rxq_ctrl *mlx5_rxq_hairpin_new
342         (struct rte_eth_dev *dev, uint16_t idx, uint16_t desc,
343          const struct rte_eth_hairpin_conf *hairpin_conf);
344 struct mlx5_rxq_ctrl *mlx5_rxq_get(struct rte_eth_dev *dev, uint16_t idx);
345 int mlx5_rxq_release(struct rte_eth_dev *dev, uint16_t idx);
346 int mlx5_rxq_verify(struct rte_eth_dev *dev);
347 int rxq_alloc_elts(struct mlx5_rxq_ctrl *rxq_ctrl);
348 int mlx5_ind_table_obj_verify(struct rte_eth_dev *dev);
349 struct mlx5_ind_table_obj *mlx5_ind_table_obj_get(struct rte_eth_dev *dev,
350                                                   const uint16_t *queues,
351                                                   uint32_t queues_n);
352 int mlx5_ind_table_obj_release(struct rte_eth_dev *dev,
353                                struct mlx5_ind_table_obj *ind_tbl,
354                                bool standalone);
355 int mlx5_ind_table_obj_setup(struct rte_eth_dev *dev,
356                              struct mlx5_ind_table_obj *ind_tbl);
357 int mlx5_ind_table_obj_modify(struct rte_eth_dev *dev,
358                               struct mlx5_ind_table_obj *ind_tbl,
359                               uint16_t *queues, const uint32_t queues_n,
360                               bool standalone);
361 struct mlx5_cache_entry *mlx5_hrxq_create_cb(struct mlx5_cache_list *list,
362                 struct mlx5_cache_entry *entry __rte_unused, void *cb_ctx);
363 int mlx5_hrxq_match_cb(struct mlx5_cache_list *list,
364                        struct mlx5_cache_entry *entry,
365                        void *cb_ctx);
366 void mlx5_hrxq_remove_cb(struct mlx5_cache_list *list,
367                          struct mlx5_cache_entry *entry);
368 uint32_t mlx5_hrxq_get(struct rte_eth_dev *dev,
369                        struct mlx5_flow_rss_desc *rss_desc);
370 int mlx5_hrxq_release(struct rte_eth_dev *dev, uint32_t hxrq_idx);
371 uint32_t mlx5_hrxq_verify(struct rte_eth_dev *dev);
372
373
374 enum mlx5_rxq_type mlx5_rxq_get_type(struct rte_eth_dev *dev, uint16_t idx);
375 const struct rte_eth_hairpin_conf *mlx5_rxq_get_hairpin_conf
376         (struct rte_eth_dev *dev, uint16_t idx);
377 struct mlx5_hrxq *mlx5_drop_action_create(struct rte_eth_dev *dev);
378 void mlx5_drop_action_destroy(struct rte_eth_dev *dev);
379 uint64_t mlx5_get_rx_port_offloads(void);
380 uint64_t mlx5_get_rx_queue_offloads(struct rte_eth_dev *dev);
381 void mlx5_rxq_timestamp_set(struct rte_eth_dev *dev);
382 int mlx5_hrxq_modify(struct rte_eth_dev *dev, uint32_t hxrq_idx,
383                      const uint8_t *rss_key, uint32_t rss_key_len,
384                      uint64_t hash_fields,
385                      const uint16_t *queues, uint32_t queues_n);
386
387 /* mlx5_txq.c */
388
389 int mlx5_tx_queue_start(struct rte_eth_dev *dev, uint16_t queue_id);
390 int mlx5_tx_queue_stop(struct rte_eth_dev *dev, uint16_t queue_id);
391 int mlx5_tx_queue_start_primary(struct rte_eth_dev *dev, uint16_t queue_id);
392 int mlx5_tx_queue_stop_primary(struct rte_eth_dev *dev, uint16_t queue_id);
393 int mlx5_tx_queue_setup(struct rte_eth_dev *dev, uint16_t idx, uint16_t desc,
394                         unsigned int socket, const struct rte_eth_txconf *conf);
395 int mlx5_tx_hairpin_queue_setup
396         (struct rte_eth_dev *dev, uint16_t idx, uint16_t desc,
397          const struct rte_eth_hairpin_conf *hairpin_conf);
398 void mlx5_tx_queue_release(void *dpdk_txq);
399 void txq_uar_init(struct mlx5_txq_ctrl *txq_ctrl);
400 int mlx5_tx_uar_init_secondary(struct rte_eth_dev *dev, int fd);
401 void mlx5_tx_uar_uninit_secondary(struct rte_eth_dev *dev);
402 int mlx5_txq_obj_verify(struct rte_eth_dev *dev);
403 struct mlx5_txq_ctrl *mlx5_txq_new(struct rte_eth_dev *dev, uint16_t idx,
404                                    uint16_t desc, unsigned int socket,
405                                    const struct rte_eth_txconf *conf);
406 struct mlx5_txq_ctrl *mlx5_txq_hairpin_new
407         (struct rte_eth_dev *dev, uint16_t idx, uint16_t desc,
408          const struct rte_eth_hairpin_conf *hairpin_conf);
409 struct mlx5_txq_ctrl *mlx5_txq_get(struct rte_eth_dev *dev, uint16_t idx);
410 int mlx5_txq_release(struct rte_eth_dev *dev, uint16_t idx);
411 int mlx5_txq_releasable(struct rte_eth_dev *dev, uint16_t idx);
412 int mlx5_txq_verify(struct rte_eth_dev *dev);
413 void txq_alloc_elts(struct mlx5_txq_ctrl *txq_ctrl);
414 void txq_free_elts(struct mlx5_txq_ctrl *txq_ctrl);
415 uint64_t mlx5_get_tx_port_offloads(struct rte_eth_dev *dev);
416 void mlx5_txq_dynf_timestamp_set(struct rte_eth_dev *dev);
417
418 /* mlx5_rxtx.c */
419
420 extern uint32_t mlx5_ptype_table[];
421 extern uint8_t mlx5_cksum_table[];
422 extern uint8_t mlx5_swp_types_table[];
423
424 void mlx5_set_ptype_table(void);
425 void mlx5_set_cksum_table(void);
426 void mlx5_set_swp_types_table(void);
427 uint16_t mlx5_rx_burst(void *dpdk_rxq, struct rte_mbuf **pkts, uint16_t pkts_n);
428 void mlx5_rxq_initialize(struct mlx5_rxq_data *rxq);
429 __rte_noinline int mlx5_rx_err_handle(struct mlx5_rxq_data *rxq, uint8_t vec);
430 void mlx5_mprq_buf_free_cb(void *addr, void *opaque);
431 void mlx5_mprq_buf_free(struct mlx5_mprq_buf *buf);
432 uint16_t mlx5_rx_burst_mprq(void *dpdk_rxq, struct rte_mbuf **pkts,
433                             uint16_t pkts_n);
434 uint16_t removed_tx_burst(void *dpdk_txq, struct rte_mbuf **pkts,
435                           uint16_t pkts_n);
436 uint16_t removed_rx_burst(void *dpdk_rxq, struct rte_mbuf **pkts,
437                           uint16_t pkts_n);
438 int mlx5_rx_descriptor_status(void *rx_queue, uint16_t offset);
439 int mlx5_tx_descriptor_status(void *tx_queue, uint16_t offset);
440 uint32_t mlx5_rx_queue_count(struct rte_eth_dev *dev, uint16_t rx_queue_id);
441 void mlx5_dump_debug_information(const char *path, const char *title,
442                                  const void *buf, unsigned int len);
443 int mlx5_queue_state_modify_primary(struct rte_eth_dev *dev,
444                         const struct mlx5_mp_arg_queue_state_modify *sm);
445 void mlx5_rxq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
446                        struct rte_eth_rxq_info *qinfo);
447 void mlx5_txq_info_get(struct rte_eth_dev *dev, uint16_t queue_id,
448                        struct rte_eth_txq_info *qinfo);
449 int mlx5_rx_burst_mode_get(struct rte_eth_dev *dev, uint16_t rx_queue_id,
450                            struct rte_eth_burst_mode *mode);
451 int mlx5_tx_burst_mode_get(struct rte_eth_dev *dev, uint16_t tx_queue_id,
452                            struct rte_eth_burst_mode *mode);
453
454 /* Vectorized version of mlx5_rxtx.c */
455 int mlx5_rxq_check_vec_support(struct mlx5_rxq_data *rxq_data);
456 int mlx5_check_vec_rx_support(struct rte_eth_dev *dev);
457 uint16_t mlx5_rx_burst_vec(void *dpdk_txq, struct rte_mbuf **pkts,
458                            uint16_t pkts_n);
459 uint16_t mlx5_rx_burst_mprq_vec(void *dpdk_txq, struct rte_mbuf **pkts,
460                                 uint16_t pkts_n);
461
462 /* mlx5_mr.c */
463
464 void mlx5_mr_flush_local_cache(struct mlx5_mr_ctrl *mr_ctrl);
465 uint32_t mlx5_rx_addr2mr_bh(struct mlx5_rxq_data *rxq, uintptr_t addr);
466 uint32_t mlx5_tx_mb2mr_bh(struct mlx5_txq_data *txq, struct rte_mbuf *mb);
467 uint32_t mlx5_tx_update_ext_mp(struct mlx5_txq_data *txq, uintptr_t addr,
468                                struct rte_mempool *mp);
469 int mlx5_dma_map(struct rte_pci_device *pdev, void *addr, uint64_t iova,
470                  size_t len);
471 int mlx5_dma_unmap(struct rte_pci_device *pdev, void *addr, uint64_t iova,
472                    size_t len);
473
474 /**
475  * Provide safe 64bit store operation to mlx5 UAR region for both 32bit and
476  * 64bit architectures.
477  *
478  * @param val
479  *   value to write in CPU endian format.
480  * @param addr
481  *   Address to write to.
482  * @param lock
483  *   Address of the lock to use for that UAR access.
484  */
485 static __rte_always_inline void
486 __mlx5_uar_write64_relaxed(uint64_t val, void *addr,
487                            rte_spinlock_t *lock __rte_unused)
488 {
489 #ifdef RTE_ARCH_64
490         *(uint64_t *)addr = val;
491 #else /* !RTE_ARCH_64 */
492         rte_spinlock_lock(lock);
493         *(uint32_t *)addr = val;
494         rte_io_wmb();
495         *((uint32_t *)addr + 1) = val >> 32;
496         rte_spinlock_unlock(lock);
497 #endif
498 }
499
500 /**
501  * Provide safe 64bit store operation to mlx5 UAR region for both 32bit and
502  * 64bit architectures while guaranteeing the order of execution with the
503  * code being executed.
504  *
505  * @param val
506  *   value to write in CPU endian format.
507  * @param addr
508  *   Address to write to.
509  * @param lock
510  *   Address of the lock to use for that UAR access.
511  */
512 static __rte_always_inline void
513 __mlx5_uar_write64(uint64_t val, void *addr, rte_spinlock_t *lock)
514 {
515         rte_io_wmb();
516         __mlx5_uar_write64_relaxed(val, addr, lock);
517 }
518
519 /* Assist macros, used instead of directly calling the functions they wrap. */
520 #ifdef RTE_ARCH_64
521 #define mlx5_uar_write64_relaxed(val, dst, lock) \
522                 __mlx5_uar_write64_relaxed(val, dst, NULL)
523 #define mlx5_uar_write64(val, dst, lock) __mlx5_uar_write64(val, dst, NULL)
524 #else
525 #define mlx5_uar_write64_relaxed(val, dst, lock) \
526                 __mlx5_uar_write64_relaxed(val, dst, lock)
527 #define mlx5_uar_write64(val, dst, lock) __mlx5_uar_write64(val, dst, lock)
528 #endif
529
530 /**
531  * Get Memory Pool (MP) from mbuf. If mbuf is indirect, the pool from which the
532  * cloned mbuf is allocated is returned instead.
533  *
534  * @param buf
535  *   Pointer to mbuf.
536  *
537  * @return
538  *   Memory pool where data is located for given mbuf.
539  */
540 static inline struct rte_mempool *
541 mlx5_mb2mp(struct rte_mbuf *buf)
542 {
543         if (unlikely(RTE_MBUF_CLONED(buf)))
544                 return rte_mbuf_from_indirect(buf)->pool;
545         return buf->pool;
546 }
547
548 /**
549  * Query LKey from a packet buffer for Rx. No need to flush local caches for Rx
550  * as mempool is pre-configured and static.
551  *
552  * @param rxq
553  *   Pointer to Rx queue structure.
554  * @param addr
555  *   Address to search.
556  *
557  * @return
558  *   Searched LKey on success, UINT32_MAX on no match.
559  */
560 static __rte_always_inline uint32_t
561 mlx5_rx_addr2mr(struct mlx5_rxq_data *rxq, uintptr_t addr)
562 {
563         struct mlx5_mr_ctrl *mr_ctrl = &rxq->mr_ctrl;
564         uint32_t lkey;
565
566         /* Linear search on MR cache array. */
567         lkey = mlx5_mr_lookup_lkey(mr_ctrl->cache, &mr_ctrl->mru,
568                                    MLX5_MR_CACHE_N, addr);
569         if (likely(lkey != UINT32_MAX))
570                 return lkey;
571         /* Take slower bottom-half (Binary Search) on miss. */
572         return mlx5_rx_addr2mr_bh(rxq, addr);
573 }
574
575 #define mlx5_rx_mb2mr(rxq, mb) mlx5_rx_addr2mr(rxq, (uintptr_t)((mb)->buf_addr))
576
577 /**
578  * Query LKey from a packet buffer for Tx. If not found, add the mempool.
579  *
580  * @param txq
581  *   Pointer to Tx queue structure.
582  * @param addr
583  *   Address to search.
584  *
585  * @return
586  *   Searched LKey on success, UINT32_MAX on no match.
587  */
588 static __rte_always_inline uint32_t
589 mlx5_tx_mb2mr(struct mlx5_txq_data *txq, struct rte_mbuf *mb)
590 {
591         struct mlx5_mr_ctrl *mr_ctrl = &txq->mr_ctrl;
592         uintptr_t addr = (uintptr_t)mb->buf_addr;
593         uint32_t lkey;
594
595         /* Check generation bit to see if there's any change on existing MRs. */
596         if (unlikely(*mr_ctrl->dev_gen_ptr != mr_ctrl->cur_gen))
597                 mlx5_mr_flush_local_cache(mr_ctrl);
598         /* Linear search on MR cache array. */
599         lkey = mlx5_mr_lookup_lkey(mr_ctrl->cache, &mr_ctrl->mru,
600                                    MLX5_MR_CACHE_N, addr);
601         if (likely(lkey != UINT32_MAX))
602                 return lkey;
603         /* Take slower bottom-half on miss. */
604         return mlx5_tx_mb2mr_bh(txq, mb);
605 }
606
607 /**
608  * Ring TX queue doorbell and flush the update if requested.
609  *
610  * @param txq
611  *   Pointer to TX queue structure.
612  * @param wqe
613  *   Pointer to the last WQE posted in the NIC.
614  * @param cond
615  *   Request for write memory barrier after BlueFlame update.
616  */
617 static __rte_always_inline void
618 mlx5_tx_dbrec_cond_wmb(struct mlx5_txq_data *txq, volatile struct mlx5_wqe *wqe,
619                        int cond)
620 {
621         uint64_t *dst = MLX5_TX_BFREG(txq);
622         volatile uint64_t *src = ((volatile uint64_t *)wqe);
623
624         rte_io_wmb();
625         *txq->qp_db = rte_cpu_to_be_32(txq->wqe_ci);
626         /* Ensure ordering between DB record and BF copy. */
627         rte_wmb();
628         mlx5_uar_write64_relaxed(*src, dst, txq->uar_lock);
629         if (cond)
630                 rte_wmb();
631 }
632
633 /**
634  * Ring TX queue doorbell and flush the update by write memory barrier.
635  *
636  * @param txq
637  *   Pointer to TX queue structure.
638  * @param wqe
639  *   Pointer to the last WQE posted in the NIC.
640  */
641 static __rte_always_inline void
642 mlx5_tx_dbrec(struct mlx5_txq_data *txq, volatile struct mlx5_wqe *wqe)
643 {
644         mlx5_tx_dbrec_cond_wmb(txq, wqe, 1);
645 }
646
647 /**
648  * Convert timestamp from HW format to linear counter
649  * from Packet Pacing Clock Queue CQE timestamp format.
650  *
651  * @param sh
652  *   Pointer to the device shared context. Might be needed
653  *   to convert according current device configuration.
654  * @param ts
655  *   Timestamp from CQE to convert.
656  * @return
657  *   UTC in nanoseconds
658  */
659 static __rte_always_inline uint64_t
660 mlx5_txpp_convert_rx_ts(struct mlx5_dev_ctx_shared *sh, uint64_t ts)
661 {
662         RTE_SET_USED(sh);
663         return (ts & UINT32_MAX) + (ts >> 32) * NS_PER_S;
664 }
665
666 /**
667  * Convert timestamp from mbuf format to linear counter
668  * of Clock Queue completions (24 bits)
669  *
670  * @param sh
671  *   Pointer to the device shared context to fetch Tx
672  *   packet pacing timestamp and parameters.
673  * @param ts
674  *   Timestamp from mbuf to convert.
675  * @return
676  *   positive or zero value - completion ID to wait
677  *   negative value - conversion error
678  */
679 static __rte_always_inline int32_t
680 mlx5_txpp_convert_tx_ts(struct mlx5_dev_ctx_shared *sh, uint64_t mts)
681 {
682         uint64_t ts, ci;
683         uint32_t tick;
684
685         do {
686                 /*
687                  * Read atomically two uint64_t fields and compare lsb bits.
688                  * It there is no match - the timestamp was updated in
689                  * the service thread, data should be re-read.
690                  */
691                 rte_compiler_barrier();
692                 ci = __atomic_load_n(&sh->txpp.ts.ci_ts, __ATOMIC_RELAXED);
693                 ts = __atomic_load_n(&sh->txpp.ts.ts, __ATOMIC_RELAXED);
694                 rte_compiler_barrier();
695                 if (!((ts ^ ci) << (64 - MLX5_CQ_INDEX_WIDTH)))
696                         break;
697         } while (true);
698         /* Perform the skew correction, positive value to send earlier. */
699         mts -= sh->txpp.skew;
700         mts -= ts;
701         if (unlikely(mts >= UINT64_MAX / 2)) {
702                 /* We have negative integer, mts is in the past. */
703                 __atomic_fetch_add(&sh->txpp.err_ts_past,
704                                    1, __ATOMIC_RELAXED);
705                 return -1;
706         }
707         tick = sh->txpp.tick;
708         MLX5_ASSERT(tick);
709         /* Convert delta to completions, round up. */
710         mts = (mts + tick - 1) / tick;
711         if (unlikely(mts >= (1 << MLX5_CQ_INDEX_WIDTH) / 2 - 1)) {
712                 /* We have mts is too distant future. */
713                 __atomic_fetch_add(&sh->txpp.err_ts_future,
714                                    1, __ATOMIC_RELAXED);
715                 return -1;
716         }
717         mts <<= 64 - MLX5_CQ_INDEX_WIDTH;
718         ci += mts;
719         ci >>= 64 - MLX5_CQ_INDEX_WIDTH;
720         return ci;
721 }
722
723 /**
724  * Set timestamp in mbuf dynamic field.
725  *
726  * @param mbuf
727  *   Structure to write into.
728  * @param offset
729  *   Dynamic field offset in mbuf structure.
730  * @param timestamp
731  *   Value to write.
732  */
733 static __rte_always_inline void
734 mlx5_timestamp_set(struct rte_mbuf *mbuf, int offset,
735                 rte_mbuf_timestamp_t timestamp)
736 {
737         *RTE_MBUF_DYNFIELD(mbuf, offset, rte_mbuf_timestamp_t *) = timestamp;
738 }
739
740 /**
741  * Replace MPRQ buffer.
742  *
743  * @param rxq
744  *   Pointer to Rx queue structure.
745  * @param rq_idx
746  *   RQ index to replace.
747  */
748 static __rte_always_inline void
749 mprq_buf_replace(struct mlx5_rxq_data *rxq, uint16_t rq_idx)
750 {
751         const uint32_t strd_n = 1 << rxq->strd_num_n;
752         struct mlx5_mprq_buf *rep = rxq->mprq_repl;
753         volatile struct mlx5_wqe_data_seg *wqe =
754                 &((volatile struct mlx5_wqe_mprq *)rxq->wqes)[rq_idx].dseg;
755         struct mlx5_mprq_buf *buf = (*rxq->mprq_bufs)[rq_idx];
756         void *addr;
757
758         if (__atomic_load_n(&buf->refcnt, __ATOMIC_RELAXED) > 1) {
759                 MLX5_ASSERT(rep != NULL);
760                 /* Replace MPRQ buf. */
761                 (*rxq->mprq_bufs)[rq_idx] = rep;
762                 /* Replace WQE. */
763                 addr = mlx5_mprq_buf_addr(rep, strd_n);
764                 wqe->addr = rte_cpu_to_be_64((uintptr_t)addr);
765                 /* If there's only one MR, no need to replace LKey in WQE. */
766                 if (unlikely(mlx5_mr_btree_len(&rxq->mr_ctrl.cache_bh) > 1))
767                         wqe->lkey = mlx5_rx_addr2mr(rxq, (uintptr_t)addr);
768                 /* Stash a mbuf for next replacement. */
769                 if (likely(!rte_mempool_get(rxq->mprq_mp, (void **)&rep)))
770                         rxq->mprq_repl = rep;
771                 else
772                         rxq->mprq_repl = NULL;
773                 /* Release the old buffer. */
774                 mlx5_mprq_buf_free(buf);
775         } else if (unlikely(rxq->mprq_repl == NULL)) {
776                 struct mlx5_mprq_buf *rep;
777
778                 /*
779                  * Currently, the MPRQ mempool is out of buffer
780                  * and doing memcpy regardless of the size of Rx
781                  * packet. Retry allocation to get back to
782                  * normal.
783                  */
784                 if (!rte_mempool_get(rxq->mprq_mp, (void **)&rep))
785                         rxq->mprq_repl = rep;
786         }
787 }
788
789 /**
790  * Attach or copy MPRQ buffer content to a packet.
791  *
792  * @param rxq
793  *   Pointer to Rx queue structure.
794  * @param pkt
795  *   Pointer to a packet to fill.
796  * @param len
797  *   Packet length.
798  * @param buf
799  *   Pointer to a MPRQ buffer to take the data from.
800  * @param strd_idx
801  *   Stride index to start from.
802  * @param strd_cnt
803  *   Number of strides to consume.
804  */
805 static __rte_always_inline enum mlx5_rqx_code
806 mprq_buf_to_pkt(struct mlx5_rxq_data *rxq, struct rte_mbuf *pkt, uint32_t len,
807                 struct mlx5_mprq_buf *buf, uint16_t strd_idx, uint16_t strd_cnt)
808 {
809         const uint32_t strd_n = 1 << rxq->strd_num_n;
810         const uint16_t strd_sz = 1 << rxq->strd_sz_n;
811         const uint16_t strd_shift =
812                 MLX5_MPRQ_STRIDE_SHIFT_BYTE * rxq->strd_shift_en;
813         const int32_t hdrm_overlap =
814                 len + RTE_PKTMBUF_HEADROOM - strd_cnt * strd_sz;
815         const uint32_t offset = strd_idx * strd_sz + strd_shift;
816         void *addr = RTE_PTR_ADD(mlx5_mprq_buf_addr(buf, strd_n), offset);
817
818         /*
819          * Memcpy packets to the target mbuf if:
820          * - The size of packet is smaller than mprq_max_memcpy_len.
821          * - Out of buffer in the Mempool for Multi-Packet RQ.
822          * - The packet's stride overlaps a headroom and scatter is off.
823          */
824         if (len <= rxq->mprq_max_memcpy_len ||
825             rxq->mprq_repl == NULL ||
826             (hdrm_overlap > 0 && !rxq->strd_scatter_en)) {
827                 if (likely(len <=
828                            (uint32_t)(pkt->buf_len - RTE_PKTMBUF_HEADROOM))) {
829                         rte_memcpy(rte_pktmbuf_mtod(pkt, void *),
830                                    addr, len);
831                         DATA_LEN(pkt) = len;
832                 } else if (rxq->strd_scatter_en) {
833                         struct rte_mbuf *prev = pkt;
834                         uint32_t seg_len = RTE_MIN(len, (uint32_t)
835                                 (pkt->buf_len - RTE_PKTMBUF_HEADROOM));
836                         uint32_t rem_len = len - seg_len;
837
838                         rte_memcpy(rte_pktmbuf_mtod(pkt, void *),
839                                    addr, seg_len);
840                         DATA_LEN(pkt) = seg_len;
841                         while (rem_len) {
842                                 struct rte_mbuf *next =
843                                         rte_pktmbuf_alloc(rxq->mp);
844
845                                 if (unlikely(next == NULL))
846                                         return MLX5_RXQ_CODE_NOMBUF;
847                                 NEXT(prev) = next;
848                                 SET_DATA_OFF(next, 0);
849                                 addr = RTE_PTR_ADD(addr, seg_len);
850                                 seg_len = RTE_MIN(rem_len, (uint32_t)
851                                         (next->buf_len - RTE_PKTMBUF_HEADROOM));
852                                 rte_memcpy
853                                         (rte_pktmbuf_mtod(next, void *),
854                                          addr, seg_len);
855                                 DATA_LEN(next) = seg_len;
856                                 rem_len -= seg_len;
857                                 prev = next;
858                                 ++NB_SEGS(pkt);
859                         }
860                 } else {
861                         return MLX5_RXQ_CODE_DROPPED;
862                 }
863         } else {
864                 rte_iova_t buf_iova;
865                 struct rte_mbuf_ext_shared_info *shinfo;
866                 uint16_t buf_len = strd_cnt * strd_sz;
867                 void *buf_addr;
868
869                 /* Increment the refcnt of the whole chunk. */
870                 __atomic_add_fetch(&buf->refcnt, 1, __ATOMIC_RELAXED);
871                 MLX5_ASSERT(__atomic_load_n(&buf->refcnt,
872                             __ATOMIC_RELAXED) <= strd_n + 1);
873                 buf_addr = RTE_PTR_SUB(addr, RTE_PKTMBUF_HEADROOM);
874                 /*
875                  * MLX5 device doesn't use iova but it is necessary in a
876                  * case where the Rx packet is transmitted via a
877                  * different PMD.
878                  */
879                 buf_iova = rte_mempool_virt2iova(buf) +
880                            RTE_PTR_DIFF(buf_addr, buf);
881                 shinfo = &buf->shinfos[strd_idx];
882                 rte_mbuf_ext_refcnt_set(shinfo, 1);
883                 /*
884                  * EXT_ATTACHED_MBUF will be set to pkt->ol_flags when
885                  * attaching the stride to mbuf and more offload flags
886                  * will be added below by calling rxq_cq_to_mbuf().
887                  * Other fields will be overwritten.
888                  */
889                 rte_pktmbuf_attach_extbuf(pkt, buf_addr, buf_iova,
890                                           buf_len, shinfo);
891                 /* Set mbuf head-room. */
892                 SET_DATA_OFF(pkt, RTE_PKTMBUF_HEADROOM);
893                 MLX5_ASSERT(pkt->ol_flags == EXT_ATTACHED_MBUF);
894                 MLX5_ASSERT(rte_pktmbuf_tailroom(pkt) >=
895                         len - (hdrm_overlap > 0 ? hdrm_overlap : 0));
896                 DATA_LEN(pkt) = len;
897                 /*
898                  * Copy the last fragment of a packet (up to headroom
899                  * size bytes) in case there is a stride overlap with
900                  * a next packet's headroom. Allocate a separate mbuf
901                  * to store this fragment and link it. Scatter is on.
902                  */
903                 if (hdrm_overlap > 0) {
904                         MLX5_ASSERT(rxq->strd_scatter_en);
905                         struct rte_mbuf *seg =
906                                 rte_pktmbuf_alloc(rxq->mp);
907
908                         if (unlikely(seg == NULL))
909                                 return MLX5_RXQ_CODE_NOMBUF;
910                         SET_DATA_OFF(seg, 0);
911                         rte_memcpy(rte_pktmbuf_mtod(seg, void *),
912                                 RTE_PTR_ADD(addr, len - hdrm_overlap),
913                                 hdrm_overlap);
914                         DATA_LEN(seg) = hdrm_overlap;
915                         DATA_LEN(pkt) = len - hdrm_overlap;
916                         NEXT(pkt) = seg;
917                         NB_SEGS(pkt) = 2;
918                 }
919         }
920         return MLX5_RXQ_CODE_EXIT;
921 }
922
923 #endif /* RTE_PMD_MLX5_RXTX_H_ */