1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation.
3 * Copyright 2014 6WIND S.A.
6 #ifndef _RTE_MBUF_CORE_H_
7 #define _RTE_MBUF_CORE_H_
11 * This file contains definion of RTE mbuf structure itself,
12 * packet offload flags and some related macros.
13 * For majority of DPDK entities, it is not recommended to include
14 * this file directly, use include <rte_mbuf.h> instead.
18 #include <rte_compat.h>
19 #include <generic/rte_atomic.h>
26 * Packet Offload Features Flags. It also carry packet type information.
27 * Critical resources. Both rx/tx shared these bits. Be cautious on any change
29 * - RX flags start at bit position zero, and get added to the left of previous
31 * - The most-significant 3 bits are reserved for generic mbuf flags
32 * - TX flags therefore start at bit position 60 (i.e. 63-3), and new flags get
33 * added to the right of the previously defined flags i.e. they should count
34 * downwards, not upwards.
36 * Keep these flags synchronized with rte_get_rx_ol_flag_name() and
37 * rte_get_tx_ol_flag_name().
41 * The RX packet is a 802.1q VLAN packet, and the tci has been
42 * saved in in mbuf->vlan_tci.
43 * If the flag PKT_RX_VLAN_STRIPPED is also present, the VLAN
44 * header has been stripped from mbuf data, else it is still
47 #define PKT_RX_VLAN (1ULL << 0)
49 /** RX packet with RSS hash result. */
50 #define PKT_RX_RSS_HASH (1ULL << 1)
52 /** RX packet with FDIR match indicate. */
53 #define PKT_RX_FDIR (1ULL << 2)
57 * Checking this flag alone is deprecated: check the 2 bits of
58 * PKT_RX_L4_CKSUM_MASK.
59 * This flag was set when the L4 checksum of a packet was detected as
60 * wrong by the hardware.
62 #define PKT_RX_L4_CKSUM_BAD (1ULL << 3)
66 * Checking this flag alone is deprecated: check the 2 bits of
67 * PKT_RX_IP_CKSUM_MASK.
68 * This flag was set when the IP checksum of a packet was detected as
69 * wrong by the hardware.
71 #define PKT_RX_IP_CKSUM_BAD (1ULL << 4)
73 /** External IP header checksum error. */
74 #define PKT_RX_EIP_CKSUM_BAD (1ULL << 5)
77 * A vlan has been stripped by the hardware and its tci is saved in
78 * mbuf->vlan_tci. This can only happen if vlan stripping is enabled
79 * in the RX configuration of the PMD.
80 * When PKT_RX_VLAN_STRIPPED is set, PKT_RX_VLAN must also be set.
82 #define PKT_RX_VLAN_STRIPPED (1ULL << 6)
85 * Mask of bits used to determine the status of RX IP checksum.
86 * - PKT_RX_IP_CKSUM_UNKNOWN: no information about the RX IP checksum
87 * - PKT_RX_IP_CKSUM_BAD: the IP checksum in the packet is wrong
88 * - PKT_RX_IP_CKSUM_GOOD: the IP checksum in the packet is valid
89 * - PKT_RX_IP_CKSUM_NONE: the IP checksum is not correct in the packet
90 * data, but the integrity of the IP header is verified.
92 #define PKT_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7))
94 #define PKT_RX_IP_CKSUM_UNKNOWN 0
95 #define PKT_RX_IP_CKSUM_BAD (1ULL << 4)
96 #define PKT_RX_IP_CKSUM_GOOD (1ULL << 7)
97 #define PKT_RX_IP_CKSUM_NONE ((1ULL << 4) | (1ULL << 7))
100 * Mask of bits used to determine the status of RX L4 checksum.
101 * - PKT_RX_L4_CKSUM_UNKNOWN: no information about the RX L4 checksum
102 * - PKT_RX_L4_CKSUM_BAD: the L4 checksum in the packet is wrong
103 * - PKT_RX_L4_CKSUM_GOOD: the L4 checksum in the packet is valid
104 * - PKT_RX_L4_CKSUM_NONE: the L4 checksum is not correct in the packet
105 * data, but the integrity of the L4 data is verified.
107 #define PKT_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8))
109 #define PKT_RX_L4_CKSUM_UNKNOWN 0
110 #define PKT_RX_L4_CKSUM_BAD (1ULL << 3)
111 #define PKT_RX_L4_CKSUM_GOOD (1ULL << 8)
112 #define PKT_RX_L4_CKSUM_NONE ((1ULL << 3) | (1ULL << 8))
114 /** RX IEEE1588 L2 Ethernet PT Packet. */
115 #define PKT_RX_IEEE1588_PTP (1ULL << 9)
117 /** RX IEEE1588 L2/L4 timestamped packet.*/
118 #define PKT_RX_IEEE1588_TMST (1ULL << 10)
120 /** FD id reported if FDIR match. */
121 #define PKT_RX_FDIR_ID (1ULL << 13)
123 /** Flexible bytes reported if FDIR match. */
124 #define PKT_RX_FDIR_FLX (1ULL << 14)
127 * The 2 vlans have been stripped by the hardware and their tci are
128 * saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer).
129 * This can only happen if vlan stripping is enabled in the RX
130 * configuration of the PMD.
131 * When PKT_RX_QINQ_STRIPPED is set, the flags (PKT_RX_VLAN |
132 * PKT_RX_VLAN_STRIPPED | PKT_RX_QINQ) must also be set.
134 #define PKT_RX_QINQ_STRIPPED (1ULL << 15)
137 * When packets are coalesced by a hardware or virtual driver, this flag
138 * can be set in the RX mbuf, meaning that the m->tso_segsz field is
139 * valid and is set to the segment size of original packets.
141 #define PKT_RX_LRO (1ULL << 16)
144 * Indicate that the timestamp field in the mbuf is valid.
146 #define PKT_RX_TIMESTAMP (1ULL << 17)
149 * Indicate that security offload processing was applied on the RX packet.
151 #define PKT_RX_SEC_OFFLOAD (1ULL << 18)
154 * Indicate that security offload processing failed on the RX packet.
156 #define PKT_RX_SEC_OFFLOAD_FAILED (1ULL << 19)
159 * The RX packet is a double VLAN, and the outer tci has been
160 * saved in in mbuf->vlan_tci_outer. If PKT_RX_QINQ set, PKT_RX_VLAN
161 * also should be set and inner tci should be saved to mbuf->vlan_tci.
162 * If the flag PKT_RX_QINQ_STRIPPED is also present, both VLANs
163 * headers have been stripped from mbuf data, else they are still
166 #define PKT_RX_QINQ (1ULL << 20)
169 * Mask of bits used to determine the status of outer RX L4 checksum.
170 * - PKT_RX_OUTER_L4_CKSUM_UNKNOWN: no info about the outer RX L4 checksum
171 * - PKT_RX_OUTER_L4_CKSUM_BAD: the outer L4 checksum in the packet is wrong
172 * - PKT_RX_OUTER_L4_CKSUM_GOOD: the outer L4 checksum in the packet is valid
173 * - PKT_RX_OUTER_L4_CKSUM_INVALID: invalid outer L4 checksum state.
175 * The detection of PKT_RX_OUTER_L4_CKSUM_GOOD shall be based on the given
176 * HW capability, At minimum, the PMD should support
177 * PKT_RX_OUTER_L4_CKSUM_UNKNOWN and PKT_RX_OUTER_L4_CKSUM_BAD states
178 * if the DEV_RX_OFFLOAD_OUTER_UDP_CKSUM offload is available.
180 #define PKT_RX_OUTER_L4_CKSUM_MASK ((1ULL << 21) | (1ULL << 22))
182 #define PKT_RX_OUTER_L4_CKSUM_UNKNOWN 0
183 #define PKT_RX_OUTER_L4_CKSUM_BAD (1ULL << 21)
184 #define PKT_RX_OUTER_L4_CKSUM_GOOD (1ULL << 22)
185 #define PKT_RX_OUTER_L4_CKSUM_INVALID ((1ULL << 21) | (1ULL << 22))
187 /* add new RX flags here, don't forget to update PKT_FIRST_FREE */
189 #define PKT_FIRST_FREE (1ULL << 23)
190 #define PKT_LAST_FREE (1ULL << 40)
192 /* add new TX flags here, don't forget to update PKT_LAST_FREE */
195 * Outer UDP checksum offload flag. This flag is used for enabling
196 * outer UDP checksum in PMD. To use outer UDP checksum, the user needs to
197 * 1) Enable the following in mbuf,
198 * a) Fill outer_l2_len and outer_l3_len in mbuf.
199 * b) Set the PKT_TX_OUTER_UDP_CKSUM flag.
200 * c) Set the PKT_TX_OUTER_IPV4 or PKT_TX_OUTER_IPV6 flag.
201 * 2) Configure DEV_TX_OFFLOAD_OUTER_UDP_CKSUM offload flag.
203 #define PKT_TX_OUTER_UDP_CKSUM (1ULL << 41)
206 * UDP Fragmentation Offload flag. This flag is used for enabling UDP
207 * fragmentation in SW or in HW. When use UFO, mbuf->tso_segsz is used
208 * to store the MSS of UDP fragments.
210 #define PKT_TX_UDP_SEG (1ULL << 42)
213 * Request security offload processing on the TX packet.
215 #define PKT_TX_SEC_OFFLOAD (1ULL << 43)
218 * Offload the MACsec. This flag must be set by the application to enable
219 * this offload feature for a packet to be transmitted.
221 #define PKT_TX_MACSEC (1ULL << 44)
224 * Bits 45:48 used for the tunnel type.
225 * The tunnel type must be specified for TSO or checksum on the inner part
227 * These flags can be used with PKT_TX_TCP_SEG for TSO, or PKT_TX_xxx_CKSUM.
228 * The mbuf fields for inner and outer header lengths are required:
229 * outer_l2_len, outer_l3_len, l2_len, l3_len, l4_len and tso_segsz for TSO.
231 #define PKT_TX_TUNNEL_VXLAN (0x1ULL << 45)
232 #define PKT_TX_TUNNEL_GRE (0x2ULL << 45)
233 #define PKT_TX_TUNNEL_IPIP (0x3ULL << 45)
234 #define PKT_TX_TUNNEL_GENEVE (0x4ULL << 45)
235 /** TX packet with MPLS-in-UDP RFC 7510 header. */
236 #define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45)
237 #define PKT_TX_TUNNEL_VXLAN_GPE (0x6ULL << 45)
238 #define PKT_TX_TUNNEL_GTP (0x7ULL << 45)
240 * Generic IP encapsulated tunnel type, used for TSO and checksum offload.
241 * It can be used for tunnels which are not standards or listed above.
242 * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_GRE
243 * or PKT_TX_TUNNEL_IPIP if possible.
244 * The ethdev must be configured with DEV_TX_OFFLOAD_IP_TNL_TSO.
245 * Outer and inner checksums are done according to the existing flags like
247 * Specific tunnel headers that contain payload length, sequence id
248 * or checksum are not expected to be updated.
250 #define PKT_TX_TUNNEL_IP (0xDULL << 45)
252 * Generic UDP encapsulated tunnel type, used for TSO and checksum offload.
253 * UDP tunnel type implies outer IP layer.
254 * It can be used for tunnels which are not standards or listed above.
255 * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_VXLAN
257 * The ethdev must be configured with DEV_TX_OFFLOAD_UDP_TNL_TSO.
258 * Outer and inner checksums are done according to the existing flags like
260 * Specific tunnel headers that contain payload length, sequence id
261 * or checksum are not expected to be updated.
263 #define PKT_TX_TUNNEL_UDP (0xEULL << 45)
264 /* add new TX TUNNEL type here */
265 #define PKT_TX_TUNNEL_MASK (0xFULL << 45)
268 * Double VLAN insertion (QinQ) request to driver, driver may offload the
269 * insertion based on device capability.
270 * mbuf 'vlan_tci' & 'vlan_tci_outer' must be valid when this flag is set.
272 #define PKT_TX_QINQ (1ULL << 49)
273 /* this old name is deprecated */
274 #define PKT_TX_QINQ_PKT PKT_TX_QINQ
277 * TCP segmentation offload. To enable this offload feature for a
278 * packet to be transmitted on hardware supporting TSO:
279 * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies
281 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
282 * - if it's IPv4, set the PKT_TX_IP_CKSUM flag
283 * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz
285 #define PKT_TX_TCP_SEG (1ULL << 50)
287 /** TX IEEE1588 packet to timestamp. */
288 #define PKT_TX_IEEE1588_TMST (1ULL << 51)
291 * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved,
292 * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware
293 * L4 checksum offload, the user needs to:
294 * - fill l2_len and l3_len in mbuf
295 * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM
296 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
298 #define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */
300 /** TCP cksum of TX pkt. computed by NIC. */
301 #define PKT_TX_TCP_CKSUM (1ULL << 52)
303 /** SCTP cksum of TX pkt. computed by NIC. */
304 #define PKT_TX_SCTP_CKSUM (2ULL << 52)
306 /** UDP cksum of TX pkt. computed by NIC. */
307 #define PKT_TX_UDP_CKSUM (3ULL << 52)
309 /** Mask for L4 cksum offload request. */
310 #define PKT_TX_L4_MASK (3ULL << 52)
313 * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should
314 * also be set by the application, although a PMD will only check
316 * - fill the mbuf offload information: l2_len, l3_len
318 #define PKT_TX_IP_CKSUM (1ULL << 54)
321 * Packet is IPv4. This flag must be set when using any offload feature
322 * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4
323 * packet. If the packet is a tunneled packet, this flag is related to
326 #define PKT_TX_IPV4 (1ULL << 55)
329 * Packet is IPv6. This flag must be set when using an offload feature
330 * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6
331 * packet. If the packet is a tunneled packet, this flag is related to
334 #define PKT_TX_IPV6 (1ULL << 56)
337 * VLAN tag insertion request to driver, driver may offload the insertion
338 * based on the device capability.
339 * mbuf 'vlan_tci' field must be valid when this flag is set.
341 #define PKT_TX_VLAN (1ULL << 57)
342 /* this old name is deprecated */
343 #define PKT_TX_VLAN_PKT PKT_TX_VLAN
346 * Offload the IP checksum of an external header in the hardware. The
347 * flag PKT_TX_OUTER_IPV4 should also be set by the application, although
348 * a PMD will only check PKT_TX_OUTER_IP_CKSUM.
349 * - fill the mbuf offload information: outer_l2_len, outer_l3_len
351 #define PKT_TX_OUTER_IP_CKSUM (1ULL << 58)
354 * Packet outer header is IPv4. This flag must be set when using any
355 * outer offload feature (L3 or L4 checksum) to tell the NIC that the
356 * outer header of the tunneled packet is an IPv4 packet.
358 #define PKT_TX_OUTER_IPV4 (1ULL << 59)
361 * Packet outer header is IPv6. This flag must be set when using any
362 * outer offload feature (L4 checksum) to tell the NIC that the outer
363 * header of the tunneled packet is an IPv6 packet.
365 #define PKT_TX_OUTER_IPV6 (1ULL << 60)
368 * Bitmask of all supported packet Tx offload features flags,
369 * which can be set for packet.
371 #define PKT_TX_OFFLOAD_MASK ( \
372 PKT_TX_OUTER_IPV6 | \
373 PKT_TX_OUTER_IPV4 | \
374 PKT_TX_OUTER_IP_CKSUM | \
380 PKT_TX_IEEE1588_TMST | \
383 PKT_TX_TUNNEL_MASK | \
385 PKT_TX_SEC_OFFLOAD | \
387 PKT_TX_OUTER_UDP_CKSUM)
390 * Mbuf having an external buffer attached. shinfo in mbuf must be filled.
392 #define EXT_ATTACHED_MBUF (1ULL << 61)
394 #define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */
396 /** Alignment constraint of mbuf private area. */
397 #define RTE_MBUF_PRIV_ALIGN 8
400 * Some NICs need at least 2KB buffer to RX standard Ethernet frame without
401 * splitting it into multiple segments.
402 * So, for mbufs that planned to be involved into RX/TX, the recommended
403 * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM.
405 #define RTE_MBUF_DEFAULT_DATAROOM 2048
406 #define RTE_MBUF_DEFAULT_BUF_SIZE \
407 (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM)
410 * define a set of marker types that can be used to refer to set points in the
414 typedef void *MARKER[0]; /**< generic marker for a point in a structure */
416 typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */
418 /** marker that allows us to overwrite 8 bytes with a single assignment */
420 typedef uint64_t MARKER64[0];
422 struct rte_mbuf_sched {
423 uint32_t queue_id; /**< Queue ID. */
424 uint8_t traffic_class;
425 /**< Traffic class ID. Traffic class 0
426 * is the highest priority traffic class.
429 /**< Color. @see enum rte_color.*/
430 uint16_t reserved; /**< Reserved. */
431 }; /**< Hierarchical scheduler */
434 * enum for the tx_offload bit-fields lengths and offsets.
435 * defines the layout of rte_mbuf tx_offload field.
438 RTE_MBUF_L2_LEN_BITS = 7,
439 RTE_MBUF_L3_LEN_BITS = 9,
440 RTE_MBUF_L4_LEN_BITS = 8,
441 RTE_MBUF_TSO_SEGSZ_BITS = 16,
442 RTE_MBUF_OUTL3_LEN_BITS = 9,
443 RTE_MBUF_OUTL2_LEN_BITS = 7,
444 RTE_MBUF_TXOFLD_UNUSED_BITS = sizeof(uint64_t) * CHAR_BIT -
445 RTE_MBUF_L2_LEN_BITS -
446 RTE_MBUF_L3_LEN_BITS -
447 RTE_MBUF_L4_LEN_BITS -
448 RTE_MBUF_TSO_SEGSZ_BITS -
449 RTE_MBUF_OUTL3_LEN_BITS -
450 RTE_MBUF_OUTL2_LEN_BITS,
451 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
452 RTE_MBUF_L2_LEN_OFS =
453 sizeof(uint64_t) * CHAR_BIT - RTE_MBUF_L2_LEN_BITS,
454 RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS - RTE_MBUF_L3_LEN_BITS,
455 RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS - RTE_MBUF_L4_LEN_BITS,
456 RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS - RTE_MBUF_TSO_SEGSZ_BITS,
457 RTE_MBUF_OUTL3_LEN_OFS =
458 RTE_MBUF_TSO_SEGSZ_OFS - RTE_MBUF_OUTL3_LEN_BITS,
459 RTE_MBUF_OUTL2_LEN_OFS =
460 RTE_MBUF_OUTL3_LEN_OFS - RTE_MBUF_OUTL2_LEN_BITS,
461 RTE_MBUF_TXOFLD_UNUSED_OFS =
462 RTE_MBUF_OUTL2_LEN_OFS - RTE_MBUF_TXOFLD_UNUSED_BITS,
464 RTE_MBUF_L2_LEN_OFS = 0,
465 RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS + RTE_MBUF_L2_LEN_BITS,
466 RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS + RTE_MBUF_L3_LEN_BITS,
467 RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS + RTE_MBUF_L4_LEN_BITS,
468 RTE_MBUF_OUTL3_LEN_OFS =
469 RTE_MBUF_TSO_SEGSZ_OFS + RTE_MBUF_TSO_SEGSZ_BITS,
470 RTE_MBUF_OUTL2_LEN_OFS =
471 RTE_MBUF_OUTL3_LEN_OFS + RTE_MBUF_OUTL3_LEN_BITS,
472 RTE_MBUF_TXOFLD_UNUSED_OFS =
473 RTE_MBUF_OUTL2_LEN_OFS + RTE_MBUF_OUTL2_LEN_BITS,
478 * The generic rte_mbuf, containing a packet mbuf.
483 void *buf_addr; /**< Virtual address of segment buffer. */
485 * Physical address of segment buffer.
486 * Force alignment to 8-bytes, so as to ensure we have the exact
487 * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes
488 * working on vector drivers easier.
493 rte_iova_t buf_physaddr; /**< deprecated */
494 } __rte_aligned(sizeof(rte_iova_t));
496 /* next 8 bytes are initialised on RX descriptor rearm */
501 * Reference counter. Its size should at least equal to the size
502 * of port field (16 bits), to support zero-copy broadcast.
503 * It should only be accessed using the following functions:
504 * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
505 * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
506 * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
511 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
512 /** Non-atomically accessed refcnt */
515 uint16_t nb_segs; /**< Number of segments. */
517 /** Input port (16 bits to support more than 256 virtual ports).
518 * The event eth Tx adapter uses this field to specify the output port.
522 uint64_t ol_flags; /**< Offload features. */
524 /* remaining bytes are set on RX when pulling packet from descriptor */
525 MARKER rx_descriptor_fields1;
528 * The packet type, which is the combination of outer/inner L2, L3, L4
529 * and tunnel types. The packet_type is about data really present in the
530 * mbuf. Example: if vlan stripping is enabled, a received vlan packet
531 * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the
532 * vlan is stripped from the data.
536 uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */
538 uint32_t l2_type:4; /**< (Outer) L2 type. */
539 uint32_t l3_type:4; /**< (Outer) L3 type. */
540 uint32_t l4_type:4; /**< (Outer) L4 type. */
541 uint32_t tun_type:4; /**< Tunnel type. */
544 uint8_t inner_esp_next_proto;
545 /**< ESP next protocol type, valid if
546 * RTE_PTYPE_TUNNEL_ESP tunnel type is set
551 uint8_t inner_l2_type:4;
552 /**< Inner L2 type. */
553 uint8_t inner_l3_type:4;
554 /**< Inner L3 type. */
557 uint32_t inner_l4_type:4; /**< Inner L4 type. */
561 uint32_t pkt_len; /**< Total pkt len: sum of all segments. */
562 uint16_t data_len; /**< Amount of data in segment buffer. */
563 /** VLAN TCI (CPU order), valid if PKT_RX_VLAN is set. */
569 uint32_t rss; /**< RSS hash result if RSS enabled */
577 /**< Second 4 flexible bytes */
580 /**< First 4 flexible bytes or FD ID, dependent
581 * on PKT_RX_FDIR_* flag in ol_flags.
583 } fdir; /**< Filter identifier if FDIR enabled */
584 struct rte_mbuf_sched sched;
585 /**< Hierarchical scheduler : 8 bytes */
590 /**< The event eth Tx adapter uses this field
591 * to store Tx queue id.
592 * @see rte_event_eth_tx_adapter_txq_set()
594 } txadapter; /**< Eventdev ethdev Tx adapter */
595 /**< User defined tags. See rte_distributor_process() */
597 } hash; /**< hash information */
600 /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ is set. */
601 uint16_t vlan_tci_outer;
603 uint16_t buf_len; /**< Length of segment buffer. */
605 /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference
606 * are not normalized but are always the same for a given port.
607 * Some devices allow to query rte_eth_read_clock that will return the
608 * current device timestamp.
612 /* second cache line - fields only used in slow path or on TX */
613 MARKER cacheline1 __rte_cache_min_aligned;
617 void *userdata; /**< Can be used for external metadata */
618 uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */
621 struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
622 struct rte_mbuf *next; /**< Next segment of scattered packet. */
624 /* fields to support TX offloads */
627 uint64_t tx_offload; /**< combined for easy fetch */
630 uint64_t l2_len:RTE_MBUF_L2_LEN_BITS;
631 /**< L2 (MAC) Header Length for non-tunneling pkt.
632 * Outer_L4_len + ... + Inner_L2_len for tunneling pkt.
634 uint64_t l3_len:RTE_MBUF_L3_LEN_BITS;
635 /**< L3 (IP) Header Length. */
636 uint64_t l4_len:RTE_MBUF_L4_LEN_BITS;
637 /**< L4 (TCP/UDP) Header Length. */
638 uint64_t tso_segsz:RTE_MBUF_TSO_SEGSZ_BITS;
639 /**< TCP TSO segment size */
642 * Fields for Tx offloading of tunnels.
643 * These are undefined for packets which don't request
644 * any tunnel offloads (outer IP or UDP checksum,
647 * PMDs should not use these fields unconditionally
648 * when calculating offsets.
650 * Applications are expected to set appropriate tunnel
651 * offload flags when they fill in these fields.
653 uint64_t outer_l3_len:RTE_MBUF_OUTL3_LEN_BITS;
654 /**< Outer L3 (IP) Hdr Length. */
655 uint64_t outer_l2_len:RTE_MBUF_OUTL2_LEN_BITS;
656 /**< Outer L2 (MAC) Hdr Length. */
658 /* uint64_t unused:RTE_MBUF_TXOFLD_UNUSED_BITS; */
662 /** Size of the application private data. In case of an indirect
663 * mbuf, it stores the direct mbuf private data size.
667 /** Timesync flags for use with IEEE1588. */
670 /** Sequence number. See also rte_reorder_insert(). */
673 /** Shared data for external buffer attached to mbuf. See
674 * rte_pktmbuf_attach_extbuf().
676 struct rte_mbuf_ext_shared_info *shinfo;
678 uint64_t dynfield1[2]; /**< Reserved for dynamic fields. */
679 } __rte_cache_aligned;
682 * Function typedef of callback to free externally attached buffer.
684 typedef void (*rte_mbuf_extbuf_free_callback_t)(void *addr, void *opaque);
687 * Shared data at the end of an external buffer.
689 struct rte_mbuf_ext_shared_info {
690 rte_mbuf_extbuf_free_callback_t free_cb; /**< Free callback function */
691 void *fcb_opaque; /**< Free callback argument */
692 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
695 /**< Maximum number of nb_segs allowed. */
696 #define RTE_MBUF_MAX_NB_SEGS UINT16_MAX
699 * Returns TRUE if given mbuf is cloned by mbuf indirection, or FALSE
702 * If a mbuf has its data in another mbuf and references it by mbuf
703 * indirection, this mbuf can be defined as a cloned mbuf.
705 #define RTE_MBUF_CLONED(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF)
708 * Returns TRUE if given mbuf has an external buffer, or FALSE otherwise.
710 * External buffer is a user-provided anonymous buffer.
712 #define RTE_MBUF_HAS_EXTBUF(mb) ((mb)->ol_flags & EXT_ATTACHED_MBUF)
715 * Returns TRUE if given mbuf is direct, or FALSE otherwise.
717 * If a mbuf embeds its own data after the rte_mbuf structure, this mbuf
718 * can be defined as a direct mbuf.
720 #define RTE_MBUF_DIRECT(mb) \
721 (!((mb)->ol_flags & (IND_ATTACHED_MBUF | EXT_ATTACHED_MBUF)))
723 #define MBUF_INVALID_PORT UINT16_MAX
726 * A macro that points to an offset into the data in the mbuf.
728 * The returned pointer is cast to type t. Before using this
729 * function, the user must ensure that the first segment is large
730 * enough to accommodate its data.
735 * The offset into the mbuf data.
737 * The type to cast the result into.
739 #define rte_pktmbuf_mtod_offset(m, t, o) \
740 ((t)((char *)(m)->buf_addr + (m)->data_off + (o)))
743 * A macro that points to the start of the data in the mbuf.
745 * The returned pointer is cast to type t. Before using this
746 * function, the user must ensure that the first segment is large
747 * enough to accommodate its data.
752 * The type to cast the result into.
754 #define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0)
757 * A macro that returns the IO address that points to an offset of the
758 * start of the data in the mbuf
763 * The offset into the data to calculate address from.
765 #define rte_pktmbuf_iova_offset(m, o) \
766 (rte_iova_t)((m)->buf_iova + (m)->data_off + (o))
769 * A macro that returns the IO address that points to the start of the
775 #define rte_pktmbuf_iova(m) rte_pktmbuf_iova_offset(m, 0)
781 #endif /* _RTE_MBUF_CORE_H_ */