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 << 39)
192 /* add new TX flags here, don't forget to update PKT_LAST_FREE */
195 * Indicate that the metadata field in the mbuf is in use.
197 #define PKT_TX_METADATA (1ULL << 40)
200 * Outer UDP checksum offload flag. This flag is used for enabling
201 * outer UDP checksum in PMD. To use outer UDP checksum, the user needs to
202 * 1) Enable the following in mbuf,
203 * a) Fill outer_l2_len and outer_l3_len in mbuf.
204 * b) Set the PKT_TX_OUTER_UDP_CKSUM flag.
205 * c) Set the PKT_TX_OUTER_IPV4 or PKT_TX_OUTER_IPV6 flag.
206 * 2) Configure DEV_TX_OFFLOAD_OUTER_UDP_CKSUM offload flag.
208 #define PKT_TX_OUTER_UDP_CKSUM (1ULL << 41)
211 * UDP Fragmentation Offload flag. This flag is used for enabling UDP
212 * fragmentation in SW or in HW. When use UFO, mbuf->tso_segsz is used
213 * to store the MSS of UDP fragments.
215 #define PKT_TX_UDP_SEG (1ULL << 42)
218 * Request security offload processing on the TX packet.
220 #define PKT_TX_SEC_OFFLOAD (1ULL << 43)
223 * Offload the MACsec. This flag must be set by the application to enable
224 * this offload feature for a packet to be transmitted.
226 #define PKT_TX_MACSEC (1ULL << 44)
229 * Bits 45:48 used for the tunnel type.
230 * The tunnel type must be specified for TSO or checksum on the inner part
232 * These flags can be used with PKT_TX_TCP_SEG for TSO, or PKT_TX_xxx_CKSUM.
233 * The mbuf fields for inner and outer header lengths are required:
234 * outer_l2_len, outer_l3_len, l2_len, l3_len, l4_len and tso_segsz for TSO.
236 #define PKT_TX_TUNNEL_VXLAN (0x1ULL << 45)
237 #define PKT_TX_TUNNEL_GRE (0x2ULL << 45)
238 #define PKT_TX_TUNNEL_IPIP (0x3ULL << 45)
239 #define PKT_TX_TUNNEL_GENEVE (0x4ULL << 45)
240 /** TX packet with MPLS-in-UDP RFC 7510 header. */
241 #define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45)
242 #define PKT_TX_TUNNEL_VXLAN_GPE (0x6ULL << 45)
243 #define PKT_TX_TUNNEL_GTP (0x7ULL << 45)
245 * Generic IP encapsulated tunnel type, used for TSO and checksum offload.
246 * It can be used for tunnels which are not standards or listed above.
247 * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_GRE
248 * or PKT_TX_TUNNEL_IPIP if possible.
249 * The ethdev must be configured with DEV_TX_OFFLOAD_IP_TNL_TSO.
250 * Outer and inner checksums are done according to the existing flags like
252 * Specific tunnel headers that contain payload length, sequence id
253 * or checksum are not expected to be updated.
255 #define PKT_TX_TUNNEL_IP (0xDULL << 45)
257 * Generic UDP encapsulated tunnel type, used for TSO and checksum offload.
258 * UDP tunnel type implies outer IP layer.
259 * It can be used for tunnels which are not standards or listed above.
260 * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_VXLAN
262 * The ethdev must be configured with DEV_TX_OFFLOAD_UDP_TNL_TSO.
263 * Outer and inner checksums are done according to the existing flags like
265 * Specific tunnel headers that contain payload length, sequence id
266 * or checksum are not expected to be updated.
268 #define PKT_TX_TUNNEL_UDP (0xEULL << 45)
269 /* add new TX TUNNEL type here */
270 #define PKT_TX_TUNNEL_MASK (0xFULL << 45)
273 * Double VLAN insertion (QinQ) request to driver, driver may offload the
274 * insertion based on device capability.
275 * mbuf 'vlan_tci' & 'vlan_tci_outer' must be valid when this flag is set.
277 #define PKT_TX_QINQ (1ULL << 49)
278 /* this old name is deprecated */
279 #define PKT_TX_QINQ_PKT PKT_TX_QINQ
282 * TCP segmentation offload. To enable this offload feature for a
283 * packet to be transmitted on hardware supporting TSO:
284 * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies
286 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
287 * - if it's IPv4, set the PKT_TX_IP_CKSUM flag
288 * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz
290 #define PKT_TX_TCP_SEG (1ULL << 50)
292 /** TX IEEE1588 packet to timestamp. */
293 #define PKT_TX_IEEE1588_TMST (1ULL << 51)
296 * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved,
297 * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware
298 * L4 checksum offload, the user needs to:
299 * - fill l2_len and l3_len in mbuf
300 * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM
301 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
303 #define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */
305 /** TCP cksum of TX pkt. computed by NIC. */
306 #define PKT_TX_TCP_CKSUM (1ULL << 52)
308 /** SCTP cksum of TX pkt. computed by NIC. */
309 #define PKT_TX_SCTP_CKSUM (2ULL << 52)
311 /** UDP cksum of TX pkt. computed by NIC. */
312 #define PKT_TX_UDP_CKSUM (3ULL << 52)
314 /** Mask for L4 cksum offload request. */
315 #define PKT_TX_L4_MASK (3ULL << 52)
318 * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should
319 * also be set by the application, although a PMD will only check
321 * - fill the mbuf offload information: l2_len, l3_len
323 #define PKT_TX_IP_CKSUM (1ULL << 54)
326 * Packet is IPv4. This flag must be set when using any offload feature
327 * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4
328 * packet. If the packet is a tunneled packet, this flag is related to
331 #define PKT_TX_IPV4 (1ULL << 55)
334 * Packet is IPv6. This flag must be set when using an offload feature
335 * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6
336 * packet. If the packet is a tunneled packet, this flag is related to
339 #define PKT_TX_IPV6 (1ULL << 56)
342 * VLAN tag insertion request to driver, driver may offload the insertion
343 * based on the device capability.
344 * mbuf 'vlan_tci' field must be valid when this flag is set.
346 #define PKT_TX_VLAN (1ULL << 57)
347 /* this old name is deprecated */
348 #define PKT_TX_VLAN_PKT PKT_TX_VLAN
351 * Offload the IP checksum of an external header in the hardware. The
352 * flag PKT_TX_OUTER_IPV4 should also be set by the application, although
353 * a PMD will only check PKT_TX_OUTER_IP_CKSUM.
354 * - fill the mbuf offload information: outer_l2_len, outer_l3_len
356 #define PKT_TX_OUTER_IP_CKSUM (1ULL << 58)
359 * Packet outer header is IPv4. This flag must be set when using any
360 * outer offload feature (L3 or L4 checksum) to tell the NIC that the
361 * outer header of the tunneled packet is an IPv4 packet.
363 #define PKT_TX_OUTER_IPV4 (1ULL << 59)
366 * Packet outer header is IPv6. This flag must be set when using any
367 * outer offload feature (L4 checksum) to tell the NIC that the outer
368 * header of the tunneled packet is an IPv6 packet.
370 #define PKT_TX_OUTER_IPV6 (1ULL << 60)
373 * Bitmask of all supported packet Tx offload features flags,
374 * which can be set for packet.
376 #define PKT_TX_OFFLOAD_MASK ( \
377 PKT_TX_OUTER_IPV6 | \
378 PKT_TX_OUTER_IPV4 | \
379 PKT_TX_OUTER_IP_CKSUM | \
385 PKT_TX_IEEE1588_TMST | \
388 PKT_TX_TUNNEL_MASK | \
390 PKT_TX_SEC_OFFLOAD | \
392 PKT_TX_OUTER_UDP_CKSUM | \
396 * Mbuf having an external buffer attached. shinfo in mbuf must be filled.
398 #define EXT_ATTACHED_MBUF (1ULL << 61)
400 #define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */
402 /** Alignment constraint of mbuf private area. */
403 #define RTE_MBUF_PRIV_ALIGN 8
406 * Some NICs need at least 2KB buffer to RX standard Ethernet frame without
407 * splitting it into multiple segments.
408 * So, for mbufs that planned to be involved into RX/TX, the recommended
409 * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM.
411 #define RTE_MBUF_DEFAULT_DATAROOM 2048
412 #define RTE_MBUF_DEFAULT_BUF_SIZE \
413 (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM)
416 * define a set of marker types that can be used to refer to set points in the
420 typedef void *MARKER[0]; /**< generic marker for a point in a structure */
422 typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */
424 /** marker that allows us to overwrite 8 bytes with a single assignment */
426 typedef uint64_t MARKER64[0];
428 struct rte_mbuf_sched {
429 uint32_t queue_id; /**< Queue ID. */
430 uint8_t traffic_class;
431 /**< Traffic class ID. Traffic class 0
432 * is the highest priority traffic class.
435 /**< Color. @see enum rte_color.*/
436 uint16_t reserved; /**< Reserved. */
437 }; /**< Hierarchical scheduler */
440 * enum for the tx_offload bit-fields lengths and offsets.
441 * defines the layout of rte_mbuf tx_offload field.
444 RTE_MBUF_L2_LEN_BITS = 7,
445 RTE_MBUF_L3_LEN_BITS = 9,
446 RTE_MBUF_L4_LEN_BITS = 8,
447 RTE_MBUF_TSO_SEGSZ_BITS = 16,
448 RTE_MBUF_OUTL3_LEN_BITS = 9,
449 RTE_MBUF_OUTL2_LEN_BITS = 7,
450 RTE_MBUF_TXOFLD_UNUSED_BITS = sizeof(uint64_t) * CHAR_BIT -
451 RTE_MBUF_L2_LEN_BITS -
452 RTE_MBUF_L3_LEN_BITS -
453 RTE_MBUF_L4_LEN_BITS -
454 RTE_MBUF_TSO_SEGSZ_BITS -
455 RTE_MBUF_OUTL3_LEN_BITS -
456 RTE_MBUF_OUTL2_LEN_BITS,
457 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
458 RTE_MBUF_L2_LEN_OFS =
459 sizeof(uint64_t) * CHAR_BIT - RTE_MBUF_L2_LEN_BITS,
460 RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS - RTE_MBUF_L3_LEN_BITS,
461 RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS - RTE_MBUF_L4_LEN_BITS,
462 RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS - RTE_MBUF_TSO_SEGSZ_BITS,
463 RTE_MBUF_OUTL3_LEN_OFS =
464 RTE_MBUF_TSO_SEGSZ_OFS - RTE_MBUF_OUTL3_LEN_BITS,
465 RTE_MBUF_OUTL2_LEN_OFS =
466 RTE_MBUF_OUTL3_LEN_OFS - RTE_MBUF_OUTL2_LEN_BITS,
467 RTE_MBUF_TXOFLD_UNUSED_OFS =
468 RTE_MBUF_OUTL2_LEN_OFS - RTE_MBUF_TXOFLD_UNUSED_BITS,
470 RTE_MBUF_L2_LEN_OFS = 0,
471 RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS + RTE_MBUF_L2_LEN_BITS,
472 RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS + RTE_MBUF_L3_LEN_BITS,
473 RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS + RTE_MBUF_L4_LEN_BITS,
474 RTE_MBUF_OUTL3_LEN_OFS =
475 RTE_MBUF_TSO_SEGSZ_OFS + RTE_MBUF_TSO_SEGSZ_BITS,
476 RTE_MBUF_OUTL2_LEN_OFS =
477 RTE_MBUF_OUTL3_LEN_OFS + RTE_MBUF_OUTL3_LEN_BITS,
478 RTE_MBUF_TXOFLD_UNUSED_OFS =
479 RTE_MBUF_OUTL2_LEN_OFS + RTE_MBUF_OUTL2_LEN_BITS,
484 * The generic rte_mbuf, containing a packet mbuf.
489 void *buf_addr; /**< Virtual address of segment buffer. */
491 * Physical address of segment buffer.
492 * Force alignment to 8-bytes, so as to ensure we have the exact
493 * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes
494 * working on vector drivers easier.
499 rte_iova_t buf_physaddr; /**< deprecated */
500 } __rte_aligned(sizeof(rte_iova_t));
502 /* next 8 bytes are initialised on RX descriptor rearm */
507 * Reference counter. Its size should at least equal to the size
508 * of port field (16 bits), to support zero-copy broadcast.
509 * It should only be accessed using the following functions:
510 * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
511 * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
512 * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
517 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
518 /** Non-atomically accessed refcnt */
521 uint16_t nb_segs; /**< Number of segments. */
523 /** Input port (16 bits to support more than 256 virtual ports).
524 * The event eth Tx adapter uses this field to specify the output port.
528 uint64_t ol_flags; /**< Offload features. */
530 /* remaining bytes are set on RX when pulling packet from descriptor */
531 MARKER rx_descriptor_fields1;
534 * The packet type, which is the combination of outer/inner L2, L3, L4
535 * and tunnel types. The packet_type is about data really present in the
536 * mbuf. Example: if vlan stripping is enabled, a received vlan packet
537 * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the
538 * vlan is stripped from the data.
542 uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */
544 uint32_t l2_type:4; /**< (Outer) L2 type. */
545 uint32_t l3_type:4; /**< (Outer) L3 type. */
546 uint32_t l4_type:4; /**< (Outer) L4 type. */
547 uint32_t tun_type:4; /**< Tunnel type. */
550 uint8_t inner_esp_next_proto;
551 /**< ESP next protocol type, valid if
552 * RTE_PTYPE_TUNNEL_ESP tunnel type is set
557 uint8_t inner_l2_type:4;
558 /**< Inner L2 type. */
559 uint8_t inner_l3_type:4;
560 /**< Inner L3 type. */
563 uint32_t inner_l4_type:4; /**< Inner L4 type. */
567 uint32_t pkt_len; /**< Total pkt len: sum of all segments. */
568 uint16_t data_len; /**< Amount of data in segment buffer. */
569 /** VLAN TCI (CPU order), valid if PKT_RX_VLAN is set. */
575 uint32_t rss; /**< RSS hash result if RSS enabled */
583 /**< Second 4 flexible bytes */
586 /**< First 4 flexible bytes or FD ID, dependent
587 * on PKT_RX_FDIR_* flag in ol_flags.
589 } fdir; /**< Filter identifier if FDIR enabled */
590 struct rte_mbuf_sched sched;
591 /**< Hierarchical scheduler : 8 bytes */
596 /**< The event eth Tx adapter uses this field
597 * to store Tx queue id.
598 * @see rte_event_eth_tx_adapter_txq_set()
600 } txadapter; /**< Eventdev ethdev Tx adapter */
601 /**< User defined tags. See rte_distributor_process() */
603 } hash; /**< hash information */
606 * Application specific metadata value
607 * for egress flow rule match.
608 * Valid if PKT_TX_METADATA is set.
609 * Located here to allow conjunct use
610 * with hash.sched.hi.
612 uint32_t tx_metadata;
617 /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ is set. */
618 uint16_t vlan_tci_outer;
620 uint16_t buf_len; /**< Length of segment buffer. */
622 /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference
623 * are not normalized but are always the same for a given port.
624 * Some devices allow to query rte_eth_read_clock that will return the
625 * current device timestamp.
629 /* second cache line - fields only used in slow path or on TX */
630 MARKER cacheline1 __rte_cache_min_aligned;
634 void *userdata; /**< Can be used for external metadata */
635 uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */
638 struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
639 struct rte_mbuf *next; /**< Next segment of scattered packet. */
641 /* fields to support TX offloads */
644 uint64_t tx_offload; /**< combined for easy fetch */
647 uint64_t l2_len:RTE_MBUF_L2_LEN_BITS;
648 /**< L2 (MAC) Header Length for non-tunneling pkt.
649 * Outer_L4_len + ... + Inner_L2_len for tunneling pkt.
651 uint64_t l3_len:RTE_MBUF_L3_LEN_BITS;
652 /**< L3 (IP) Header Length. */
653 uint64_t l4_len:RTE_MBUF_L4_LEN_BITS;
654 /**< L4 (TCP/UDP) Header Length. */
655 uint64_t tso_segsz:RTE_MBUF_TSO_SEGSZ_BITS;
656 /**< TCP TSO segment size */
659 * Fields for Tx offloading of tunnels.
660 * These are undefined for packets which don't request
661 * any tunnel offloads (outer IP or UDP checksum,
664 * PMDs should not use these fields unconditionally
665 * when calculating offsets.
667 * Applications are expected to set appropriate tunnel
668 * offload flags when they fill in these fields.
670 uint64_t outer_l3_len:RTE_MBUF_OUTL3_LEN_BITS;
671 /**< Outer L3 (IP) Hdr Length. */
672 uint64_t outer_l2_len:RTE_MBUF_OUTL2_LEN_BITS;
673 /**< Outer L2 (MAC) Hdr Length. */
675 /* uint64_t unused:RTE_MBUF_TXOFLD_UNUSED_BITS; */
679 /** Size of the application private data. In case of an indirect
680 * mbuf, it stores the direct mbuf private data size.
684 /** Timesync flags for use with IEEE1588. */
687 /** Sequence number. See also rte_reorder_insert(). */
690 /** Shared data for external buffer attached to mbuf. See
691 * rte_pktmbuf_attach_extbuf().
693 struct rte_mbuf_ext_shared_info *shinfo;
695 uint64_t dynfield1[2]; /**< Reserved for dynamic fields. */
696 } __rte_cache_aligned;
699 * Function typedef of callback to free externally attached buffer.
701 typedef void (*rte_mbuf_extbuf_free_callback_t)(void *addr, void *opaque);
704 * Shared data at the end of an external buffer.
706 struct rte_mbuf_ext_shared_info {
707 rte_mbuf_extbuf_free_callback_t free_cb; /**< Free callback function */
708 void *fcb_opaque; /**< Free callback argument */
709 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
712 /**< Maximum number of nb_segs allowed. */
713 #define RTE_MBUF_MAX_NB_SEGS UINT16_MAX
716 * Returns TRUE if given mbuf is cloned by mbuf indirection, or FALSE
719 * If a mbuf has its data in another mbuf and references it by mbuf
720 * indirection, this mbuf can be defined as a cloned mbuf.
722 #define RTE_MBUF_CLONED(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF)
725 * Returns TRUE if given mbuf has an external buffer, or FALSE otherwise.
727 * External buffer is a user-provided anonymous buffer.
729 #define RTE_MBUF_HAS_EXTBUF(mb) ((mb)->ol_flags & EXT_ATTACHED_MBUF)
732 * Returns TRUE if given mbuf is direct, or FALSE otherwise.
734 * If a mbuf embeds its own data after the rte_mbuf structure, this mbuf
735 * can be defined as a direct mbuf.
737 #define RTE_MBUF_DIRECT(mb) \
738 (!((mb)->ol_flags & (IND_ATTACHED_MBUF | EXT_ATTACHED_MBUF)))
740 #define MBUF_INVALID_PORT UINT16_MAX
743 * A macro that points to an offset into 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 offset into the mbuf data.
754 * The type to cast the result into.
756 #define rte_pktmbuf_mtod_offset(m, t, o) \
757 ((t)((char *)(m)->buf_addr + (m)->data_off + (o)))
760 * A macro that points to the start of the data in the mbuf.
762 * The returned pointer is cast to type t. Before using this
763 * function, the user must ensure that the first segment is large
764 * enough to accommodate its data.
769 * The type to cast the result into.
771 #define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0)
774 * A macro that returns the IO address that points to an offset of the
775 * start of the data in the mbuf
780 * The offset into the data to calculate address from.
782 #define rte_pktmbuf_iova_offset(m, o) \
783 (rte_iova_t)((m)->buf_iova + (m)->data_off + (o))
786 * A macro that returns the IO address that points to the start of the
792 #define rte_pktmbuf_iova(m) rte_pktmbuf_iova_offset(m, 0)
798 #endif /* _RTE_MBUF_CORE_H_ */