6 #ifndef _RTE_MBUF_CORE_H_
7 #define _RTE_MBUF_CORE_H_
21 #include <rte_compat.h>
50 #define RTE_MBUF_F_RX_VLAN (1ULL << 0)
51 #define PKT_RX_VLAN RTE_DEPRECATED(PKT_RX_VLAN) RTE_MBUF_F_RX_VLAN
54 #define RTE_MBUF_F_RX_RSS_HASH (1ULL << 1)
55 #define PKT_RX_RSS_HASH RTE_DEPRECATED(PKT_RX_RSS_HASH) RTE_MBUF_F_RX_RSS_HASH
58 #define RTE_MBUF_F_RX_FDIR (1ULL << 2)
59 #define PKT_RX_FDIR RTE_DEPRECATED(PKT_RX_FDIR) RTE_MBUF_F_RX_FDIR
65 #define RTE_MBUF_F_RX_OUTER_IP_CKSUM_BAD (1ULL << 5)
66 #define PKT_RX_OUTER_IP_CKSUM_BAD RTE_DEPRECATED(PKT_RX_OUTER_IP_CKSUM_BAD) \
67 RTE_MBUF_F_RX_OUTER_IP_CKSUM_BAD
75 #define RTE_MBUF_F_RX_VLAN_STRIPPED (1ULL << 6)
76 #define PKT_RX_VLAN_STRIPPED RTE_DEPRECATED(PKT_RX_VLAN_STRIPPED) \
77 RTE_MBUF_F_RX_VLAN_STRIPPED
87 #define RTE_MBUF_F_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7))
88 #define PKT_RX_IP_CKSUM_MASK RTE_DEPRECATED(PKT_RX_IP_CKSUM_MASK) \
89 RTE_MBUF_F_RX_IP_CKSUM_MASK
91 #define RTE_MBUF_F_RX_IP_CKSUM_UNKNOWN 0
92 #define RTE_MBUF_F_RX_IP_CKSUM_BAD (1ULL << 4)
93 #define RTE_MBUF_F_RX_IP_CKSUM_GOOD (1ULL << 7)
94 #define RTE_MBUF_F_RX_IP_CKSUM_NONE ((1ULL << 4) | (1ULL << 7))
95 #define PKT_RX_IP_CKSUM_UNKNOWN RTE_DEPRECATED(PKT_RX_IP_CKSUM_UNKNOWN) \
96 RTE_MBUF_F_RX_IP_CKSUM_UNKNOWN
97 #define PKT_RX_IP_CKSUM_BAD RTE_DEPRECATED(PKT_RX_IP_CKSUM_BAD) \
98 RTE_MBUF_F_RX_IP_CKSUM_BAD
99 #define PKT_RX_IP_CKSUM_GOOD RTE_DEPRECATED(PKT_RX_IP_CKSUM_GOOD) \
100 RTE_MBUF_F_RX_IP_CKSUM_GOOD
101 #define PKT_RX_IP_CKSUM_NONE RTE_DEPRECATED(PKT_RX_IP_CKSUM_NONE) \
102 RTE_MBUF_F_RX_IP_CKSUM_NONE
112 #define RTE_MBUF_F_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8))
113 #define PKT_RX_L4_CKSUM_MASK RTE_DEPRECATED(PKT_RX_L4_CKSUM_MASK) \
114 RTE_MBUF_F_RX_L4_CKSUM_MASK
116 #define RTE_MBUF_F_RX_L4_CKSUM_UNKNOWN 0
117 #define RTE_MBUF_F_RX_L4_CKSUM_BAD (1ULL << 3)
118 #define RTE_MBUF_F_RX_L4_CKSUM_GOOD (1ULL << 8)
119 #define RTE_MBUF_F_RX_L4_CKSUM_NONE ((1ULL << 3) | (1ULL << 8))
120 #define PKT_RX_L4_CKSUM_UNKNOWN RTE_DEPRECATED(PKT_RX_L4_CKSUM_UNKNOWN) \
121 RTE_MBUF_F_RX_L4_CKSUM_UNKNOWN
122 #define PKT_RX_L4_CKSUM_BAD RTE_DEPRECATED(PKT_RX_L4_CKSUM_BAD) \
123 RTE_MBUF_F_RX_L4_CKSUM_BAD
124 #define PKT_RX_L4_CKSUM_GOOD RTE_DEPRECATED(PKT_RX_L4_CKSUM_GOOD) \
125 RTE_MBUF_F_RX_L4_CKSUM_GOOD
126 #define PKT_RX_L4_CKSUM_NONE RTE_DEPRECATED(PKT_RX_L4_CKSUM_NONE) \
127 RTE_MBUF_F_RX_L4_CKSUM_NONE
130 #define RTE_MBUF_F_RX_IEEE1588_PTP (1ULL << 9)
131 #define PKT_RX_IEEE1588_PTP RTE_DEPRECATED(PKT_RX_IEEE1588_PTP) \
132 RTE_MBUF_F_RX_IEEE1588_PTP
135 #define RTE_MBUF_F_RX_IEEE1588_TMST (1ULL << 10)
136 #define PKT_RX_IEEE1588_TMST RTE_DEPRECATED(PKT_RX_IEEE1588_TMST) \
137 RTE_MBUF_F_RX_IEEE1588_TMST
140 #define RTE_MBUF_F_RX_FDIR_ID (1ULL << 13)
141 #define PKT_RX_FDIR_ID RTE_DEPRECATED(PKT_RX_FDIR_ID) \
142 RTE_MBUF_F_RX_FDIR_ID
145 #define RTE_MBUF_F_RX_FDIR_FLX (1ULL << 14)
146 #define PKT_RX_FDIR_FLX RTE_DEPRECATED(PKT_RX_FDIR_FLX) \
147 RTE_MBUF_F_RX_FDIR_FLX
164 #define RTE_MBUF_F_RX_QINQ_STRIPPED (1ULL << 15)
165 #define PKT_RX_QINQ_STRIPPED RTE_DEPRECATED(PKT_RX_QINQ_STRIPPED) \
166 RTE_MBUF_F_RX_QINQ_STRIPPED
173 #define RTE_MBUF_F_RX_LRO (1ULL << 16)
174 #define PKT_RX_LRO RTE_DEPRECATED(PKT_RX_LRO) RTE_MBUF_F_RX_LRO
181 #define RTE_MBUF_F_RX_SEC_OFFLOAD (1ULL << 18)
182 #define PKT_RX_SEC_OFFLOAD RTE_DEPRECATED(PKT_RX_SEC_OFFLOAD) \
183 RTE_MBUF_F_RX_SEC_OFFLOAD
188 #define RTE_MBUF_F_RX_SEC_OFFLOAD_FAILED (1ULL << 19)
189 #define PKT_RX_SEC_OFFLOAD_FAILED RTE_DEPRECATED(PKT_RX_SEC_OFFLOAD_FAILED) \
190 RTE_MBUF_F_RX_SEC_OFFLOAD_FAILED
200 #define RTE_MBUF_F_RX_QINQ (1ULL << 20)
201 #define PKT_RX_QINQ RTE_DEPRECATED(PKT_RX_QINQ) RTE_MBUF_F_RX_QINQ
218 #define RTE_MBUF_F_RX_OUTER_L4_CKSUM_MASK ((1ULL << 21) | (1ULL << 22))
219 #define PKT_RX_OUTER_L4_CKSUM_MASK RTE_DEPRECATED(PKT_RX_OUTER_L4_CKSUM_MASK) \
220 RTE_MBUF_F_RX_OUTER_L4_CKSUM_MASK
222 #define RTE_MBUF_F_RX_OUTER_L4_CKSUM_UNKNOWN 0
223 #define RTE_MBUF_F_RX_OUTER_L4_CKSUM_BAD (1ULL << 21)
224 #define RTE_MBUF_F_RX_OUTER_L4_CKSUM_GOOD (1ULL << 22)
225 #define RTE_MBUF_F_RX_OUTER_L4_CKSUM_INVALID ((1ULL << 21) | (1ULL << 22))
226 #define PKT_RX_OUTER_L4_CKSUM_UNKNOWN \
227 RTE_DEPRECATED(PKT_RX_OUTER_L4_CKSUM_UNKNOWN) \
228 RTE_MBUF_F_RX_OUTER_L4_CKSUM_UNKNOWN
229 #define PKT_RX_OUTER_L4_CKSUM_BAD RTE_DEPRECATED(PKT_RX_OUTER_L4_CKSUM_BAD) \
230 RTE_MBUF_F_RX_OUTER_L4_CKSUM_BAD
231 #define PKT_RX_OUTER_L4_CKSUM_GOOD RTE_DEPRECATED(PKT_RX_OUTER_L4_CKSUM_GOOD) \
232 RTE_MBUF_F_RX_OUTER_L4_CKSUM_GOOD
233 #define PKT_RX_OUTER_L4_CKSUM_INVALID \
234 RTE_DEPRECATED(PKT_RX_OUTER_L4_CKSUM_INVALID) \
235 RTE_MBUF_F_RX_OUTER_L4_CKSUM_INVALID
239 #define RTE_MBUF_F_FIRST_FREE (1ULL << 23)
240 #define PKT_FIRST_FREE RTE_DEPRECATED(PKT_FIRST_FREE) RTE_MBUF_F_FIRST_FREE
241 #define RTE_MBUF_F_LAST_FREE (1ULL << 40)
242 #define PKT_LAST_FREE RTE_DEPRECATED(PKT_LAST_FREE) RTE_MBUF_F_LAST_FREE
255 #define RTE_MBUF_F_TX_OUTER_UDP_CKSUM (1ULL << 41)
256 #define PKT_TX_OUTER_UDP_CKSUM RTE_DEPRECATED(PKT_TX_OUTER_UDP_CKSUM) \
257 RTE_MBUF_F_TX_OUTER_UDP_CKSUM
264 #define RTE_MBUF_F_TX_UDP_SEG (1ULL << 42)
265 #define PKT_TX_UDP_SEG RTE_DEPRECATED(PKT_TX_UDP_SEG) RTE_MBUF_F_TX_UDP_SEG
272 #define RTE_MBUF_F_TX_SEC_OFFLOAD (1ULL << 43)
273 #define PKT_TX_SEC_OFFLOAD RTE_DEPRECATED(PKT_TX_SEC_OFFLOAD) \
274 RTE_MBUF_F_TX_SEC_OFFLOAD
280 #define RTE_MBUF_F_TX_MACSEC (1ULL << 44)
281 #define PKT_TX_MACSEC RTE_DEPRECATED(PKT_TX_MACSEC) RTE_MBUF_F_TX_MACSEC
292 #define RTE_MBUF_F_TX_TUNNEL_VXLAN (0x1ULL << 45)
293 #define RTE_MBUF_F_TX_TUNNEL_GRE (0x2ULL << 45)
294 #define RTE_MBUF_F_TX_TUNNEL_IPIP (0x3ULL << 45)
295 #define RTE_MBUF_F_TX_TUNNEL_GENEVE (0x4ULL << 45)
297 #define RTE_MBUF_F_TX_TUNNEL_MPLSINUDP (0x5ULL << 45)
298 #define RTE_MBUF_F_TX_TUNNEL_VXLAN_GPE (0x6ULL << 45)
299 #define RTE_MBUF_F_TX_TUNNEL_GTP (0x7ULL << 45)
300 #define RTE_MBUF_F_TX_TUNNEL_ESP (0x8ULL << 45)
312 #define RTE_MBUF_F_TX_TUNNEL_IP (0xDULL << 45)
325 #define RTE_MBUF_F_TX_TUNNEL_UDP (0xEULL << 45)
327 #define RTE_MBUF_F_TX_TUNNEL_MASK (0xFULL << 45)
329 #define PKT_TX_TUNNEL_VXLAN RTE_DEPRECATED(PKT_TX_TUNNEL_VXLAN) \
330 RTE_MBUF_F_TX_TUNNEL_VXLAN
331 #define PKT_TX_TUNNEL_GRE RTE_DEPRECATED(PKT_TX_TUNNEL_GRE) \
332 RTE_MBUF_F_TX_TUNNEL_GRE
333 #define PKT_TX_TUNNEL_IPIP RTE_DEPRECATED(PKT_TX_TUNNEL_IPIP) \
334 RTE_MBUF_F_TX_TUNNEL_IPIP
335 #define PKT_TX_TUNNEL_GENEVE RTE_DEPRECATED(PKT_TX_TUNNEL_GENEVE) \
336 RTE_MBUF_F_TX_TUNNEL_GENEVE
337 #define PKT_TX_TUNNEL_MPLSINUDP RTE_DEPRECATED(PKT_TX_TUNNEL_MPLSINUDP) \
338 RTE_MBUF_F_TX_TUNNEL_MPLSINUDP
339 #define PKT_TX_TUNNEL_VXLAN_GPE RTE_DEPRECATED(PKT_TX_TUNNEL_VXLAN_GPE) \
340 RTE_MBUF_F_TX_TUNNEL_VXLAN_GPE
341 #define PKT_TX_TUNNEL_GTP RTE_DEPRECATED(PKT_TX_TUNNEL_GTP) \
342 RTE_MBUF_F_TX_TUNNEL_GTP
343 #define PKT_TX_TUNNEL_IP RTE_DEPRECATED(PKT_TX_TUNNEL_IP) \
344 RTE_MBUF_F_TX_TUNNEL_IP
345 #define PKT_TX_TUNNEL_UDP RTE_DEPRECATED(PKT_TX_TUNNEL_UDP) \
346 RTE_MBUF_F_TX_TUNNEL_UDP
347 #define PKT_TX_TUNNEL_MASK RTE_DEPRECATED(PKT_TX_TUNNEL_MASK) \
348 RTE_MBUF_F_TX_TUNNEL_MASK
355 #define RTE_MBUF_F_TX_QINQ (1ULL << 49)
356 #define PKT_TX_QINQ RTE_DEPRECATED(PKT_TX_QINQ) RTE_MBUF_F_TX_QINQ
357 #define PKT_TX_QINQ_PKT RTE_DEPRECATED(PKT_TX_QINQ_PKT) RTE_MBUF_F_TX_QINQ
368 #define RTE_MBUF_F_TX_TCP_SEG (1ULL << 50)
369 #define PKT_TX_TCP_SEG RTE_DEPRECATED(PKT_TX_TCP_SEG) RTE_MBUF_F_TX_TCP_SEG
372 #define RTE_MBUF_F_TX_IEEE1588_TMST (1ULL << 51)
373 #define PKT_TX_IEEE1588_TMST RTE_DEPRECATED(PKT_TX_IEEE1588_TMST) \
374 RTE_MBUF_F_TX_IEEE1588_TMST
387 #define RTE_MBUF_F_TX_L4_NO_CKSUM (0ULL << 52)
390 #define RTE_MBUF_F_TX_TCP_CKSUM (1ULL << 52)
393 #define RTE_MBUF_F_TX_SCTP_CKSUM (2ULL << 52)
396 #define RTE_MBUF_F_TX_UDP_CKSUM (3ULL << 52)
399 #define RTE_MBUF_F_TX_L4_MASK (3ULL << 52)
401 #define PKT_TX_L4_NO_CKSUM RTE_DEPRECATED(PKT_TX_L4_NO_CKSUM) \
402 RTE_MBUF_F_TX_L4_NO_CKSUM
403 #define PKT_TX_TCP_CKSUM RTE_DEPRECATED(PKT_TX_TCP_CKSUM) \
404 RTE_MBUF_F_TX_TCP_CKSUM
405 #define PKT_TX_SCTP_CKSUM RTE_DEPRECATED(PKT_TX_SCTP_CKSUM) \
406 RTE_MBUF_F_TX_SCTP_CKSUM
407 #define PKT_TX_UDP_CKSUM RTE_DEPRECATED(PKT_TX_UDP_CKSUM) \
408 RTE_MBUF_F_TX_UDP_CKSUM
409 #define PKT_TX_L4_MASK RTE_DEPRECATED(PKT_TX_L4_MASK) RTE_MBUF_F_TX_L4_MASK
417 #define RTE_MBUF_F_TX_IP_CKSUM (1ULL << 54)
418 #define PKT_TX_IP_CKSUM RTE_DEPRECATED(PKT_TX_IP_CKSUM) RTE_MBUF_F_TX_IP_CKSUM
426 #define RTE_MBUF_F_TX_IPV4 (1ULL << 55)
427 #define PKT_TX_IPV4 RTE_DEPRECATED(PKT_TX_IPV4) RTE_MBUF_F_TX_IPV4
435 #define RTE_MBUF_F_TX_IPV6 (1ULL << 56)
436 #define PKT_TX_IPV6 RTE_DEPRECATED(PKT_TX_IPV6) RTE_MBUF_F_TX_IPV6
443 #define RTE_MBUF_F_TX_VLAN (1ULL << 57)
444 #define PKT_TX_VLAN RTE_DEPRECATED(PKT_TX_VLAN) RTE_MBUF_F_TX_VLAN
445 #define PKT_TX_VLAN_PKT RTE_DEPRECATED(PKT_TX_VLAN_PKT) RTE_MBUF_F_TX_VLAN
453 #define RTE_MBUF_F_TX_OUTER_IP_CKSUM (1ULL << 58)
454 #define PKT_TX_OUTER_IP_CKSUM RTE_DEPRECATED(PKT_TX_OUTER_IP_CKSUM) \
455 RTE_MBUF_F_TX_OUTER_IP_CKSUM
462 #define RTE_MBUF_F_TX_OUTER_IPV4 (1ULL << 59)
463 #define PKT_TX_OUTER_IPV4 RTE_DEPRECATED(PKT_TX_OUTER_IPV4) \
464 RTE_MBUF_F_TX_OUTER_IPV4
471 #define RTE_MBUF_F_TX_OUTER_IPV6 (1ULL << 60)
472 #define PKT_TX_OUTER_IPV6 RTE_DEPRECATED(PKT_TX_OUTER_IPV6) \
473 RTE_MBUF_F_TX_OUTER_IPV6
479 #define RTE_MBUF_F_TX_OFFLOAD_MASK ( \
480 RTE_MBUF_F_TX_OUTER_IPV6 | \
481 RTE_MBUF_F_TX_OUTER_IPV4 | \
482 RTE_MBUF_F_TX_OUTER_IP_CKSUM | \
483 RTE_MBUF_F_TX_VLAN | \
484 RTE_MBUF_F_TX_IPV6 | \
485 RTE_MBUF_F_TX_IPV4 | \
486 RTE_MBUF_F_TX_IP_CKSUM | \
487 RTE_MBUF_F_TX_L4_MASK | \
488 RTE_MBUF_F_TX_IEEE1588_TMST | \
489 RTE_MBUF_F_TX_TCP_SEG | \
490 RTE_MBUF_F_TX_QINQ | \
491 RTE_MBUF_F_TX_TUNNEL_MASK | \
492 RTE_MBUF_F_TX_MACSEC | \
493 RTE_MBUF_F_TX_SEC_OFFLOAD | \
494 RTE_MBUF_F_TX_UDP_SEG | \
495 RTE_MBUF_F_TX_OUTER_UDP_CKSUM)
496 #define PKT_TX_OFFLOAD_MASK RTE_DEPRECATED(PKT_TX_OFFLOAD_MASK) RTE_MBUF_F_TX_OFFLOAD_MASK
501 #define RTE_MBUF_F_EXTERNAL (1ULL << 61)
502 #define EXT_ATTACHED_MBUF RTE_DEPRECATED(EXT_ATTACHED_MBUF) RTE_MBUF_F_EXTERNAL
504 #define RTE_MBUF_F_INDIRECT (1ULL << 62)
505 #define IND_ATTACHED_MBUF RTE_DEPRECATED(IND_ATTACHED_MBUF) RTE_MBUF_F_INDIRECT
508 #define RTE_MBUF_PRIV_ALIGN 8
516 #define RTE_MBUF_DEFAULT_DATAROOM 2048
517 #define RTE_MBUF_DEFAULT_BUF_SIZE \
518 (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM)
520 struct rte_mbuf_sched {
522 uint8_t traffic_class;
536 RTE_MBUF_L2_LEN_BITS = 7,
537 RTE_MBUF_L3_LEN_BITS = 9,
538 RTE_MBUF_L4_LEN_BITS = 8,
539 RTE_MBUF_TSO_SEGSZ_BITS = 16,
540 RTE_MBUF_OUTL3_LEN_BITS = 9,
541 RTE_MBUF_OUTL2_LEN_BITS = 7,
542 RTE_MBUF_TXOFLD_UNUSED_BITS =
sizeof(uint64_t) * CHAR_BIT -
543 RTE_MBUF_L2_LEN_BITS -
544 RTE_MBUF_L3_LEN_BITS -
545 RTE_MBUF_L4_LEN_BITS -
546 RTE_MBUF_TSO_SEGSZ_BITS -
547 RTE_MBUF_OUTL3_LEN_BITS -
548 RTE_MBUF_OUTL2_LEN_BITS,
549 #
if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
550 RTE_MBUF_L2_LEN_OFS =
551 sizeof(uint64_t) * CHAR_BIT - RTE_MBUF_L2_LEN_BITS,
552 RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS - RTE_MBUF_L3_LEN_BITS,
553 RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS - RTE_MBUF_L4_LEN_BITS,
554 RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS - RTE_MBUF_TSO_SEGSZ_BITS,
555 RTE_MBUF_OUTL3_LEN_OFS =
556 RTE_MBUF_TSO_SEGSZ_OFS - RTE_MBUF_OUTL3_LEN_BITS,
557 RTE_MBUF_OUTL2_LEN_OFS =
558 RTE_MBUF_OUTL3_LEN_OFS - RTE_MBUF_OUTL2_LEN_BITS,
559 RTE_MBUF_TXOFLD_UNUSED_OFS =
560 RTE_MBUF_OUTL2_LEN_OFS - RTE_MBUF_TXOFLD_UNUSED_BITS,
562 RTE_MBUF_L2_LEN_OFS = 0,
563 RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS + RTE_MBUF_L2_LEN_BITS,
564 RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS + RTE_MBUF_L3_LEN_BITS,
565 RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS + RTE_MBUF_L4_LEN_BITS,
566 RTE_MBUF_OUTL3_LEN_OFS =
567 RTE_MBUF_TSO_SEGSZ_OFS + RTE_MBUF_TSO_SEGSZ_BITS,
568 RTE_MBUF_OUTL2_LEN_OFS =
569 RTE_MBUF_OUTL3_LEN_OFS + RTE_MBUF_OUTL3_LEN_BITS,
570 RTE_MBUF_TXOFLD_UNUSED_OFS =
571 RTE_MBUF_OUTL2_LEN_OFS + RTE_MBUF_OUTL2_LEN_BITS,
779 #define RTE_MBUF_MAX_NB_SEGS UINT16_MAX
788 #define RTE_MBUF_CLONED(mb) ((mb)->ol_flags & RTE_MBUF_F_INDIRECT)
795 #define RTE_MBUF_HAS_EXTBUF(mb) ((mb)->ol_flags & RTE_MBUF_F_EXTERNAL)
803 #define RTE_MBUF_DIRECT(mb) \
804 (!((mb)->ol_flags & (RTE_MBUF_F_INDIRECT | RTE_MBUF_F_EXTERNAL)))
807 #define RTE_MBUF_PORT_INVALID UINT16_MAX
809 #define MBUF_INVALID_PORT RTE_MBUF_PORT_INVALID
825 #define rte_pktmbuf_mtod_offset(m, t, o) \
826 ((t)(void *)((char *)(m)->buf_addr + (m)->data_off + (o)))
840 #define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0)
851 #define rte_pktmbuf_iova_offset(m, o) \
852 (rte_iova_t)((m)->buf_iova + (m)->data_off + (o))
861 #define rte_pktmbuf_iova(m) rte_pktmbuf_iova_offset(m, 0)