1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation.
3 * Copyright 2014 6WIND S.A.
13 * The mbuf library provides the ability to create and destroy buffers
14 * that may be used by the RTE application to store message
15 * buffers. The message buffers are stored in a mempool, using the
16 * RTE mempool library.
18 * The preferred way to create a mbuf pool is to use
19 * rte_pktmbuf_pool_create(). However, in some situations, an
20 * application may want to have more control (ex: populate the pool with
21 * specific memory), in this case it is possible to use functions from
22 * rte_mempool. See how rte_pktmbuf_pool_create() is implemented for
25 * This library provides an API to allocate/free packet mbufs, which are
26 * used to carry network packets.
28 * To understand the concepts of packet buffers or mbufs, you
29 * should read "TCP/IP Illustrated, Volume 2: The Implementation,
30 * Addison-Wesley, 1995, ISBN 0-201-63354-X from Richard Stevens"
31 * http://www.kohala.com/start/tcpipiv2.html
35 #include <rte_compat.h>
36 #include <rte_common.h>
37 #include <rte_config.h>
38 #include <rte_mempool.h>
39 #include <rte_memory.h>
40 #include <rte_atomic.h>
41 #include <rte_prefetch.h>
42 #include <rte_branch_prediction.h>
43 #include <rte_mbuf_ptype.h>
50 * Packet Offload Features Flags. It also carry packet type information.
51 * Critical resources. Both rx/tx shared these bits. Be cautious on any change
53 * - RX flags start at bit position zero, and get added to the left of previous
55 * - The most-significant 3 bits are reserved for generic mbuf flags
56 * - TX flags therefore start at bit position 60 (i.e. 63-3), and new flags get
57 * added to the right of the previously defined flags i.e. they should count
58 * downwards, not upwards.
60 * Keep these flags synchronized with rte_get_rx_ol_flag_name() and
61 * rte_get_tx_ol_flag_name().
65 * The RX packet is a 802.1q VLAN packet, and the tci has been
66 * saved in in mbuf->vlan_tci.
67 * If the flag PKT_RX_VLAN_STRIPPED is also present, the VLAN
68 * header has been stripped from mbuf data, else it is still
71 #define PKT_RX_VLAN (1ULL << 0)
73 #define PKT_RX_RSS_HASH (1ULL << 1) /**< RX packet with RSS hash result. */
74 #define PKT_RX_FDIR (1ULL << 2) /**< RX packet with FDIR match indicate. */
78 * Checking this flag alone is deprecated: check the 2 bits of
79 * PKT_RX_L4_CKSUM_MASK.
80 * This flag was set when the L4 checksum of a packet was detected as
81 * wrong by the hardware.
83 #define PKT_RX_L4_CKSUM_BAD (1ULL << 3)
87 * Checking this flag alone is deprecated: check the 2 bits of
88 * PKT_RX_IP_CKSUM_MASK.
89 * This flag was set when the IP checksum of a packet was detected as
90 * wrong by the hardware.
92 #define PKT_RX_IP_CKSUM_BAD (1ULL << 4)
94 #define PKT_RX_EIP_CKSUM_BAD (1ULL << 5) /**< External IP header checksum error. */
97 * A vlan has been stripped by the hardware and its tci is saved in
98 * mbuf->vlan_tci. This can only happen if vlan stripping is enabled
99 * in the RX configuration of the PMD.
100 * When PKT_RX_VLAN_STRIPPED is set, PKT_RX_VLAN must also be set.
102 #define PKT_RX_VLAN_STRIPPED (1ULL << 6)
105 * Mask of bits used to determine the status of RX IP checksum.
106 * - PKT_RX_IP_CKSUM_UNKNOWN: no information about the RX IP checksum
107 * - PKT_RX_IP_CKSUM_BAD: the IP checksum in the packet is wrong
108 * - PKT_RX_IP_CKSUM_GOOD: the IP checksum in the packet is valid
109 * - PKT_RX_IP_CKSUM_NONE: the IP checksum is not correct in the packet
110 * data, but the integrity of the IP header is verified.
112 #define PKT_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7))
114 #define PKT_RX_IP_CKSUM_UNKNOWN 0
115 #define PKT_RX_IP_CKSUM_BAD (1ULL << 4)
116 #define PKT_RX_IP_CKSUM_GOOD (1ULL << 7)
117 #define PKT_RX_IP_CKSUM_NONE ((1ULL << 4) | (1ULL << 7))
120 * Mask of bits used to determine the status of RX L4 checksum.
121 * - PKT_RX_L4_CKSUM_UNKNOWN: no information about the RX L4 checksum
122 * - PKT_RX_L4_CKSUM_BAD: the L4 checksum in the packet is wrong
123 * - PKT_RX_L4_CKSUM_GOOD: the L4 checksum in the packet is valid
124 * - PKT_RX_L4_CKSUM_NONE: the L4 checksum is not correct in the packet
125 * data, but the integrity of the L4 data is verified.
127 #define PKT_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8))
129 #define PKT_RX_L4_CKSUM_UNKNOWN 0
130 #define PKT_RX_L4_CKSUM_BAD (1ULL << 3)
131 #define PKT_RX_L4_CKSUM_GOOD (1ULL << 8)
132 #define PKT_RX_L4_CKSUM_NONE ((1ULL << 3) | (1ULL << 8))
134 #define PKT_RX_IEEE1588_PTP (1ULL << 9) /**< RX IEEE1588 L2 Ethernet PT Packet. */
135 #define PKT_RX_IEEE1588_TMST (1ULL << 10) /**< RX IEEE1588 L2/L4 timestamped packet.*/
136 #define PKT_RX_FDIR_ID (1ULL << 13) /**< FD id reported if FDIR match. */
137 #define PKT_RX_FDIR_FLX (1ULL << 14) /**< Flexible bytes reported if FDIR match. */
140 * The 2 vlans have been stripped by the hardware and their tci are
141 * saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer).
142 * This can only happen if vlan stripping is enabled in the RX
143 * configuration of the PMD.
144 * When PKT_RX_QINQ_STRIPPED is set, the flags (PKT_RX_VLAN |
145 * PKT_RX_VLAN_STRIPPED | PKT_RX_QINQ) must also be set.
147 #define PKT_RX_QINQ_STRIPPED (1ULL << 15)
150 * When packets are coalesced by a hardware or virtual driver, this flag
151 * can be set in the RX mbuf, meaning that the m->tso_segsz field is
152 * valid and is set to the segment size of original packets.
154 #define PKT_RX_LRO (1ULL << 16)
157 * Indicate that the timestamp field in the mbuf is valid.
159 #define PKT_RX_TIMESTAMP (1ULL << 17)
162 * Indicate that security offload processing was applied on the RX packet.
164 #define PKT_RX_SEC_OFFLOAD (1ULL << 18)
167 * Indicate that security offload processing failed on the RX packet.
169 #define PKT_RX_SEC_OFFLOAD_FAILED (1ULL << 19)
172 * The RX packet is a double VLAN, and the outer tci has been
173 * saved in in mbuf->vlan_tci_outer. If PKT_RX_QINQ set, PKT_RX_VLAN
174 * also should be set and inner tci should be saved to mbuf->vlan_tci.
175 * If the flag PKT_RX_QINQ_STRIPPED is also present, both VLANs
176 * headers have been stripped from mbuf data, else they are still
179 #define PKT_RX_QINQ (1ULL << 20)
182 * Mask of bits used to determine the status of outer RX L4 checksum.
183 * - PKT_RX_OUTER_L4_CKSUM_UNKNOWN: no info about the outer RX L4 checksum
184 * - PKT_RX_OUTER_L4_CKSUM_BAD: the outer L4 checksum in the packet is wrong
185 * - PKT_RX_OUTER_L4_CKSUM_GOOD: the outer L4 checksum in the packet is valid
186 * - PKT_RX_OUTER_L4_CKSUM_INVALID: invalid outer L4 checksum state.
188 * The detection of PKT_RX_OUTER_L4_CKSUM_GOOD shall be based on the given
189 * HW capability, At minimum, the PMD should support
190 * PKT_RX_OUTER_L4_CKSUM_UNKNOWN and PKT_RX_OUTER_L4_CKSUM_BAD states
191 * if the DEV_RX_OFFLOAD_OUTER_UDP_CKSUM offload is available.
193 #define PKT_RX_OUTER_L4_CKSUM_MASK ((1ULL << 21) | (1ULL << 22))
195 #define PKT_RX_OUTER_L4_CKSUM_UNKNOWN 0
196 #define PKT_RX_OUTER_L4_CKSUM_BAD (1ULL << 21)
197 #define PKT_RX_OUTER_L4_CKSUM_GOOD (1ULL << 22)
198 #define PKT_RX_OUTER_L4_CKSUM_INVALID ((1ULL << 21) | (1ULL << 22))
200 /* add new RX flags here */
202 /* add new TX flags here */
205 * Indicate that the metadata field in the mbuf is in use.
207 #define PKT_TX_METADATA (1ULL << 40)
210 * Outer UDP checksum offload flag. This flag is used for enabling
211 * outer UDP checksum in PMD. To use outer UDP checksum, the user needs to
212 * 1) Enable the following in mbuf,
213 * a) Fill outer_l2_len and outer_l3_len in mbuf.
214 * b) Set the PKT_TX_OUTER_UDP_CKSUM flag.
215 * c) Set the PKT_TX_OUTER_IPV4 or PKT_TX_OUTER_IPV6 flag.
216 * 2) Configure DEV_TX_OFFLOAD_OUTER_UDP_CKSUM offload flag.
218 #define PKT_TX_OUTER_UDP_CKSUM (1ULL << 41)
221 * UDP Fragmentation Offload flag. This flag is used for enabling UDP
222 * fragmentation in SW or in HW. When use UFO, mbuf->tso_segsz is used
223 * to store the MSS of UDP fragments.
225 #define PKT_TX_UDP_SEG (1ULL << 42)
228 * Request security offload processing on the TX packet.
230 #define PKT_TX_SEC_OFFLOAD (1ULL << 43)
233 * Offload the MACsec. This flag must be set by the application to enable
234 * this offload feature for a packet to be transmitted.
236 #define PKT_TX_MACSEC (1ULL << 44)
239 * Bits 45:48 used for the tunnel type.
240 * The tunnel type must be specified for TSO or checksum on the inner part
242 * These flags can be used with PKT_TX_TCP_SEG for TSO, or PKT_TX_xxx_CKSUM.
243 * The mbuf fields for inner and outer header lengths are required:
244 * outer_l2_len, outer_l3_len, l2_len, l3_len, l4_len and tso_segsz for TSO.
246 #define PKT_TX_TUNNEL_VXLAN (0x1ULL << 45)
247 #define PKT_TX_TUNNEL_GRE (0x2ULL << 45)
248 #define PKT_TX_TUNNEL_IPIP (0x3ULL << 45)
249 #define PKT_TX_TUNNEL_GENEVE (0x4ULL << 45)
250 /** TX packet with MPLS-in-UDP RFC 7510 header. */
251 #define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45)
252 #define PKT_TX_TUNNEL_VXLAN_GPE (0x6ULL << 45)
254 * Generic IP encapsulated tunnel type, used for TSO and checksum offload.
255 * It can be used for tunnels which are not standards or listed above.
256 * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_GRE
257 * or PKT_TX_TUNNEL_IPIP if possible.
258 * The ethdev must be configured with DEV_TX_OFFLOAD_IP_TNL_TSO.
259 * Outer and inner checksums are done according to the existing flags like
261 * Specific tunnel headers that contain payload length, sequence id
262 * or checksum are not expected to be updated.
264 #define PKT_TX_TUNNEL_IP (0xDULL << 45)
266 * Generic UDP encapsulated tunnel type, used for TSO and checksum offload.
267 * UDP tunnel type implies outer IP layer.
268 * It can be used for tunnels which are not standards or listed above.
269 * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_VXLAN
271 * The ethdev must be configured with DEV_TX_OFFLOAD_UDP_TNL_TSO.
272 * Outer and inner checksums are done according to the existing flags like
274 * Specific tunnel headers that contain payload length, sequence id
275 * or checksum are not expected to be updated.
277 #define PKT_TX_TUNNEL_UDP (0xEULL << 45)
278 /* add new TX TUNNEL type here */
279 #define PKT_TX_TUNNEL_MASK (0xFULL << 45)
282 * Double VLAN insertion (QinQ) request to driver, driver may offload the
283 * insertion based on device capability.
284 * mbuf 'vlan_tci' & 'vlan_tci_outer' must be valid when this flag is set.
286 #define PKT_TX_QINQ (1ULL << 49)
287 /* this old name is deprecated */
288 #define PKT_TX_QINQ_PKT PKT_TX_QINQ
291 * TCP segmentation offload. To enable this offload feature for a
292 * packet to be transmitted on hardware supporting TSO:
293 * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies
295 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
296 * - if it's IPv4, set the PKT_TX_IP_CKSUM flag
297 * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz
299 #define PKT_TX_TCP_SEG (1ULL << 50)
301 #define PKT_TX_IEEE1588_TMST (1ULL << 51) /**< TX IEEE1588 packet to timestamp. */
304 * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved,
305 * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware
306 * L4 checksum offload, the user needs to:
307 * - fill l2_len and l3_len in mbuf
308 * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM
309 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
311 #define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */
312 #define PKT_TX_TCP_CKSUM (1ULL << 52) /**< TCP cksum of TX pkt. computed by NIC. */
313 #define PKT_TX_SCTP_CKSUM (2ULL << 52) /**< SCTP cksum of TX pkt. computed by NIC. */
314 #define PKT_TX_UDP_CKSUM (3ULL << 52) /**< UDP cksum of TX pkt. computed by NIC. */
315 #define PKT_TX_L4_MASK (3ULL << 52) /**< Mask for L4 cksum offload request. */
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 * Get the name of a RX offload flag
409 * The mask describing the flag.
411 * The name of this flag, or NULL if it's not a valid RX flag.
413 const char *rte_get_rx_ol_flag_name(uint64_t mask);
416 * Dump the list of RX offload flags in a buffer
419 * The mask describing the RX flags.
423 * The length of the buffer.
425 * 0 on success, (-1) on error.
427 int rte_get_rx_ol_flag_list(uint64_t mask, char *buf, size_t buflen);
430 * Get the name of a TX offload flag
433 * The mask describing the flag. Usually only one bit must be set.
434 * Several bits can be given if they belong to the same mask.
435 * Ex: PKT_TX_L4_MASK.
437 * The name of this flag, or NULL if it's not a valid TX flag.
439 const char *rte_get_tx_ol_flag_name(uint64_t mask);
442 * Dump the list of TX offload flags in a buffer
445 * The mask describing the TX flags.
449 * The length of the buffer.
451 * 0 on success, (-1) on error.
453 int rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen);
456 * Some NICs need at least 2KB buffer to RX standard Ethernet frame without
457 * splitting it into multiple segments.
458 * So, for mbufs that planned to be involved into RX/TX, the recommended
459 * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM.
461 #define RTE_MBUF_DEFAULT_DATAROOM 2048
462 #define RTE_MBUF_DEFAULT_BUF_SIZE \
463 (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM)
465 /* define a set of marker types that can be used to refer to set points in the
468 typedef void *MARKER[0]; /**< generic marker for a point in a structure */
470 typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */
472 typedef uint64_t MARKER64[0]; /**< marker that allows us to overwrite 8 bytes
473 * with a single assignment */
476 * The generic rte_mbuf, containing a packet mbuf.
481 void *buf_addr; /**< Virtual address of segment buffer. */
483 * Physical address of segment buffer.
484 * Force alignment to 8-bytes, so as to ensure we have the exact
485 * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes
486 * working on vector drivers easier.
491 rte_iova_t buf_physaddr; /**< deprecated */
492 } __rte_aligned(sizeof(rte_iova_t));
494 /* next 8 bytes are initialised on RX descriptor rearm */
499 * Reference counter. Its size should at least equal to the size
500 * of port field (16 bits), to support zero-copy broadcast.
501 * It should only be accessed using the following functions:
502 * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
503 * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
504 * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
509 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
510 uint16_t refcnt; /**< Non-atomically accessed refcnt */
512 uint16_t nb_segs; /**< Number of segments. */
514 /** Input port (16 bits to support more than 256 virtual ports).
515 * The event eth Tx adapter uses this field to specify the output port.
519 uint64_t ol_flags; /**< Offload features. */
521 /* remaining bytes are set on RX when pulling packet from descriptor */
522 MARKER rx_descriptor_fields1;
525 * The packet type, which is the combination of outer/inner L2, L3, L4
526 * and tunnel types. The packet_type is about data really present in the
527 * mbuf. Example: if vlan stripping is enabled, a received vlan packet
528 * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the
529 * vlan is stripped from the data.
533 uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */
535 uint32_t l2_type:4; /**< (Outer) L2 type. */
536 uint32_t l3_type:4; /**< (Outer) L3 type. */
537 uint32_t l4_type:4; /**< (Outer) L4 type. */
538 uint32_t tun_type:4; /**< Tunnel type. */
541 uint8_t inner_esp_next_proto;
542 /**< ESP next protocol type, valid if
543 * RTE_PTYPE_TUNNEL_ESP tunnel type is set
548 uint8_t inner_l2_type:4;
549 /**< Inner L2 type. */
550 uint8_t inner_l3_type:4;
551 /**< Inner L3 type. */
554 uint32_t inner_l4_type:4; /**< Inner L4 type. */
558 uint32_t pkt_len; /**< Total pkt len: sum of all segments. */
559 uint16_t data_len; /**< Amount of data in segment buffer. */
560 /** VLAN TCI (CPU order), valid if PKT_RX_VLAN is set. */
566 uint32_t rss; /**< RSS hash result if RSS enabled */
574 /**< Second 4 flexible bytes */
577 /**< First 4 flexible bytes or FD ID, dependent
578 * on PKT_RX_FDIR_* flag in ol_flags.
580 } fdir; /**< Filter identifier if FDIR enabled */
584 /**< The event eth Tx adapter uses this field
585 * to store Tx queue id.
586 * @see rte_event_eth_tx_adapter_txq_set()
588 } sched; /**< Hierarchical scheduler */
589 /**< User defined tags. See rte_distributor_process() */
591 } hash; /**< hash information */
594 * Application specific metadata value
595 * for egress flow rule match.
596 * Valid if PKT_TX_METADATA is set.
597 * Located here to allow conjunct use
598 * with hash.sched.hi.
600 uint32_t tx_metadata;
605 /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ is set. */
606 uint16_t vlan_tci_outer;
608 uint16_t buf_len; /**< Length of segment buffer. */
610 /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference
611 * are not normalized but are always the same for a given port.
615 /* second cache line - fields only used in slow path or on TX */
616 MARKER cacheline1 __rte_cache_min_aligned;
620 void *userdata; /**< Can be used for external metadata */
621 uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */
624 struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
625 struct rte_mbuf *next; /**< Next segment of scattered packet. */
627 /* fields to support TX offloads */
630 uint64_t tx_offload; /**< combined for easy fetch */
634 /**< L2 (MAC) Header Length for non-tunneling pkt.
635 * Outer_L4_len + ... + Inner_L2_len for tunneling pkt.
637 uint64_t l3_len:9; /**< L3 (IP) Header Length. */
638 uint64_t l4_len:8; /**< L4 (TCP/UDP) Header Length. */
639 uint64_t tso_segsz:16; /**< TCP TSO segment size */
641 /* fields for TX offloading of tunnels */
642 uint64_t outer_l3_len:9; /**< Outer L3 (IP) Hdr Length. */
643 uint64_t outer_l2_len:7; /**< Outer L2 (MAC) Hdr Length. */
645 /* uint64_t unused:8; */
649 /** Size of the application private data. In case of an indirect
650 * mbuf, it stores the direct mbuf private data size. */
653 /** Timesync flags for use with IEEE1588. */
656 /** Sequence number. See also rte_reorder_insert(). */
659 /** Shared data for external buffer attached to mbuf. See
660 * rte_pktmbuf_attach_extbuf().
662 struct rte_mbuf_ext_shared_info *shinfo;
664 } __rte_cache_aligned;
667 * Function typedef of callback to free externally attached buffer.
669 typedef void (*rte_mbuf_extbuf_free_callback_t)(void *addr, void *opaque);
672 * Shared data at the end of an external buffer.
674 struct rte_mbuf_ext_shared_info {
675 rte_mbuf_extbuf_free_callback_t free_cb; /**< Free callback function */
676 void *fcb_opaque; /**< Free callback argument */
677 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
680 /**< Maximum number of nb_segs allowed. */
681 #define RTE_MBUF_MAX_NB_SEGS UINT16_MAX
684 * Prefetch the first part of the mbuf
686 * The first 64 bytes of the mbuf corresponds to fields that are used early
687 * in the receive path. If the cache line of the architecture is higher than
688 * 64B, the second part will also be prefetched.
691 * The pointer to the mbuf.
694 rte_mbuf_prefetch_part1(struct rte_mbuf *m)
696 rte_prefetch0(&m->cacheline0);
700 * Prefetch the second part of the mbuf
702 * The next 64 bytes of the mbuf corresponds to fields that are used in the
703 * transmit path. If the cache line of the architecture is higher than 64B,
704 * this function does nothing as it is expected that the full mbuf is
708 * The pointer to the mbuf.
711 rte_mbuf_prefetch_part2(struct rte_mbuf *m)
713 #if RTE_CACHE_LINE_SIZE == 64
714 rte_prefetch0(&m->cacheline1);
721 static inline uint16_t rte_pktmbuf_priv_size(struct rte_mempool *mp);
724 * Return the IO address of the beginning of the mbuf data
727 * The pointer to the mbuf.
729 * The IO address of the beginning of the mbuf data
731 static inline rte_iova_t
732 rte_mbuf_data_iova(const struct rte_mbuf *mb)
734 return mb->buf_iova + mb->data_off;
738 static inline phys_addr_t
739 rte_mbuf_data_dma_addr(const struct rte_mbuf *mb)
741 return rte_mbuf_data_iova(mb);
745 * Return the default IO address of the beginning of the mbuf data
747 * This function is used by drivers in their receive function, as it
748 * returns the location where data should be written by the NIC, taking
749 * the default headroom in account.
752 * The pointer to the mbuf.
754 * The IO address of the beginning of the mbuf data
756 static inline rte_iova_t
757 rte_mbuf_data_iova_default(const struct rte_mbuf *mb)
759 return mb->buf_iova + RTE_PKTMBUF_HEADROOM;
763 static inline phys_addr_t
764 rte_mbuf_data_dma_addr_default(const struct rte_mbuf *mb)
766 return rte_mbuf_data_iova_default(mb);
770 * Return the mbuf owning the data buffer address of an indirect mbuf.
773 * The pointer to the indirect mbuf.
775 * The address of the direct mbuf corresponding to buffer_addr.
777 static inline struct rte_mbuf *
778 rte_mbuf_from_indirect(struct rte_mbuf *mi)
780 return (struct rte_mbuf *)RTE_PTR_SUB(mi->buf_addr, sizeof(*mi) + mi->priv_size);
784 * Return the buffer address embedded in the given mbuf.
787 * The pointer to the mbuf.
789 * The address of the data buffer owned by the mbuf.
792 rte_mbuf_to_baddr(struct rte_mbuf *md)
795 buffer_addr = (char *)md + sizeof(*md) + rte_pktmbuf_priv_size(md->pool);
800 * Return the starting address of the private data area embedded in
803 * Note that no check is made to ensure that a private data area
804 * actually exists in the supplied mbuf.
807 * The pointer to the mbuf.
809 * The starting address of the private data area of the given mbuf.
811 static inline void * __rte_experimental
812 rte_mbuf_to_priv(struct rte_mbuf *m)
814 return RTE_PTR_ADD(m, sizeof(struct rte_mbuf));
818 * Returns TRUE if given mbuf is cloned by mbuf indirection, or FALSE
821 * If a mbuf has its data in another mbuf and references it by mbuf
822 * indirection, this mbuf can be defined as a cloned mbuf.
824 #define RTE_MBUF_CLONED(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF)
828 * Use RTE_MBUF_CLONED().
830 #define RTE_MBUF_INDIRECT(mb) RTE_MBUF_CLONED(mb)
833 * Returns TRUE if given mbuf has an external buffer, or FALSE otherwise.
835 * External buffer is a user-provided anonymous buffer.
837 #define RTE_MBUF_HAS_EXTBUF(mb) ((mb)->ol_flags & EXT_ATTACHED_MBUF)
840 * Returns TRUE if given mbuf is direct, or FALSE otherwise.
842 * If a mbuf embeds its own data after the rte_mbuf structure, this mbuf
843 * can be defined as a direct mbuf.
845 #define RTE_MBUF_DIRECT(mb) \
846 (!((mb)->ol_flags & (IND_ATTACHED_MBUF | EXT_ATTACHED_MBUF)))
849 * Private data in case of pktmbuf pool.
851 * A structure that contains some pktmbuf_pool-specific data that are
852 * appended after the mempool structure (in private data).
854 struct rte_pktmbuf_pool_private {
855 uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf. */
856 uint16_t mbuf_priv_size; /**< Size of private area in each mbuf. */
859 #ifdef RTE_LIBRTE_MBUF_DEBUG
861 /** check mbuf type in debug mode */
862 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
864 #else /* RTE_LIBRTE_MBUF_DEBUG */
866 /** check mbuf type in debug mode */
867 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
869 #endif /* RTE_LIBRTE_MBUF_DEBUG */
871 #ifdef RTE_MBUF_REFCNT_ATOMIC
874 * Reads the value of an mbuf's refcnt.
878 * Reference count number.
880 static inline uint16_t
881 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
883 return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
887 * Sets an mbuf's refcnt to a defined value.
894 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
896 rte_atomic16_set(&m->refcnt_atomic, (int16_t)new_value);
900 static inline uint16_t
901 __rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
903 return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
907 * Adds given value to an mbuf's refcnt and returns its new value.
911 * Value to add/subtract
915 static inline uint16_t
916 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
919 * The atomic_add is an expensive operation, so we don't want to
920 * call it in the case where we know we are the unique holder of
921 * this mbuf (i.e. ref_cnt == 1). Otherwise, an atomic
922 * operation has to be used because concurrent accesses on the
923 * reference counter can occur.
925 if (likely(rte_mbuf_refcnt_read(m) == 1)) {
927 rte_mbuf_refcnt_set(m, (uint16_t)value);
928 return (uint16_t)value;
931 return __rte_mbuf_refcnt_update(m, value);
934 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
937 static inline uint16_t
938 __rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
940 m->refcnt = (uint16_t)(m->refcnt + value);
945 * Adds given value to an mbuf's refcnt and returns its new value.
947 static inline uint16_t
948 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
950 return __rte_mbuf_refcnt_update(m, value);
954 * Reads the value of an mbuf's refcnt.
956 static inline uint16_t
957 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
963 * Sets an mbuf's refcnt to the defined value.
966 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
968 m->refcnt = new_value;
971 #endif /* RTE_MBUF_REFCNT_ATOMIC */
974 * Reads the refcnt of an external buffer.
977 * Shared data of the external buffer.
979 * Reference count number.
981 static inline uint16_t
982 rte_mbuf_ext_refcnt_read(const struct rte_mbuf_ext_shared_info *shinfo)
984 return (uint16_t)(rte_atomic16_read(&shinfo->refcnt_atomic));
988 * Set refcnt of an external buffer.
991 * Shared data of the external buffer.
996 rte_mbuf_ext_refcnt_set(struct rte_mbuf_ext_shared_info *shinfo,
999 rte_atomic16_set(&shinfo->refcnt_atomic, (int16_t)new_value);
1003 * Add given value to refcnt of an external buffer and return its new
1007 * Shared data of the external buffer.
1009 * Value to add/subtract
1013 static inline uint16_t
1014 rte_mbuf_ext_refcnt_update(struct rte_mbuf_ext_shared_info *shinfo,
1017 if (likely(rte_mbuf_ext_refcnt_read(shinfo) == 1)) {
1019 rte_mbuf_ext_refcnt_set(shinfo, (uint16_t)value);
1020 return (uint16_t)value;
1023 return (uint16_t)rte_atomic16_add_return(&shinfo->refcnt_atomic, value);
1026 /** Mbuf prefetch */
1027 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { \
1034 * Sanity checks on an mbuf.
1036 * Check the consistency of the given mbuf. The function will cause a
1037 * panic if corruption is detected.
1040 * The mbuf to be checked.
1042 * True if the mbuf is a packet header, false if it is a sub-segment
1043 * of a packet (in this case, some fields like nb_segs are not checked)
1046 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
1048 #define MBUF_RAW_ALLOC_CHECK(m) do { \
1049 RTE_ASSERT(rte_mbuf_refcnt_read(m) == 1); \
1050 RTE_ASSERT((m)->next == NULL); \
1051 RTE_ASSERT((m)->nb_segs == 1); \
1052 __rte_mbuf_sanity_check(m, 0); \
1056 * Allocate an uninitialized mbuf from mempool *mp*.
1058 * This function can be used by PMDs (especially in RX functions) to
1059 * allocate an uninitialized mbuf. The driver is responsible of
1060 * initializing all the required fields. See rte_pktmbuf_reset().
1061 * For standard needs, prefer rte_pktmbuf_alloc().
1063 * The caller can expect that the following fields of the mbuf structure
1064 * are initialized: buf_addr, buf_iova, buf_len, refcnt=1, nb_segs=1,
1065 * next=NULL, pool, priv_size. The other fields must be initialized
1069 * The mempool from which mbuf is allocated.
1071 * - The pointer to the new mbuf on success.
1072 * - NULL if allocation failed.
1074 static inline struct rte_mbuf *rte_mbuf_raw_alloc(struct rte_mempool *mp)
1078 if (rte_mempool_get(mp, (void **)&m) < 0)
1080 MBUF_RAW_ALLOC_CHECK(m);
1085 * Put mbuf back into its original mempool.
1087 * The caller must ensure that the mbuf is direct and properly
1088 * reinitialized (refcnt=1, next=NULL, nb_segs=1), as done by
1089 * rte_pktmbuf_prefree_seg().
1091 * This function should be used with care, when optimization is
1092 * required. For standard needs, prefer rte_pktmbuf_free() or
1093 * rte_pktmbuf_free_seg().
1096 * The mbuf to be freed.
1098 static __rte_always_inline void
1099 rte_mbuf_raw_free(struct rte_mbuf *m)
1101 RTE_ASSERT(RTE_MBUF_DIRECT(m));
1102 RTE_ASSERT(rte_mbuf_refcnt_read(m) == 1);
1103 RTE_ASSERT(m->next == NULL);
1104 RTE_ASSERT(m->nb_segs == 1);
1105 __rte_mbuf_sanity_check(m, 0);
1106 rte_mempool_put(m->pool, m);
1110 * The packet mbuf constructor.
1112 * This function initializes some fields in the mbuf structure that are
1113 * not modified by the user once created (origin pool, buffer start
1114 * address, and so on). This function is given as a callback function to
1115 * rte_mempool_obj_iter() or rte_mempool_create() at pool creation time.
1118 * The mempool from which mbufs originate.
1120 * A pointer that can be used by the user to retrieve useful information
1121 * for mbuf initialization. This pointer is the opaque argument passed to
1122 * rte_mempool_obj_iter() or rte_mempool_create().
1124 * The mbuf to initialize.
1126 * The index of the mbuf in the pool table.
1128 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
1129 void *m, unsigned i);
1133 * A packet mbuf pool constructor.
1135 * This function initializes the mempool private data in the case of a
1136 * pktmbuf pool. This private data is needed by the driver. The
1137 * function must be called on the mempool before it is used, or it
1138 * can be given as a callback function to rte_mempool_create() at
1139 * pool creation. It can be extended by the user, for example, to
1140 * provide another packet size.
1143 * The mempool from which mbufs originate.
1145 * A pointer that can be used by the user to retrieve useful information
1146 * for mbuf initialization. This pointer is the opaque argument passed to
1147 * rte_mempool_create().
1149 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
1152 * Create a mbuf pool.
1154 * This function creates and initializes a packet mbuf pool. It is
1155 * a wrapper to rte_mempool functions.
1158 * The name of the mbuf pool.
1160 * The number of elements in the mbuf pool. The optimum size (in terms
1161 * of memory usage) for a mempool is when n is a power of two minus one:
1164 * Size of the per-core object cache. See rte_mempool_create() for
1167 * Size of application private are between the rte_mbuf structure
1168 * and the data buffer. This value must be aligned to RTE_MBUF_PRIV_ALIGN.
1169 * @param data_room_size
1170 * Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
1172 * The socket identifier where the memory should be allocated. The
1173 * value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
1176 * The pointer to the new allocated mempool, on success. NULL on error
1177 * with rte_errno set appropriately. Possible rte_errno values include:
1178 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
1179 * - E_RTE_SECONDARY - function was called from a secondary process instance
1180 * - EINVAL - cache size provided is too large, or priv_size is not aligned.
1181 * - ENOSPC - the maximum number of memzones has already been allocated
1182 * - EEXIST - a memzone with the same name already exists
1183 * - ENOMEM - no appropriate memory area found in which to create memzone
1185 struct rte_mempool *
1186 rte_pktmbuf_pool_create(const char *name, unsigned n,
1187 unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
1191 * Create a mbuf pool with a given mempool ops name
1193 * This function creates and initializes a packet mbuf pool. It is
1194 * a wrapper to rte_mempool functions.
1197 * The name of the mbuf pool.
1199 * The number of elements in the mbuf pool. The optimum size (in terms
1200 * of memory usage) for a mempool is when n is a power of two minus one:
1203 * Size of the per-core object cache. See rte_mempool_create() for
1206 * Size of application private are between the rte_mbuf structure
1207 * and the data buffer. This value must be aligned to RTE_MBUF_PRIV_ALIGN.
1208 * @param data_room_size
1209 * Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
1211 * The socket identifier where the memory should be allocated. The
1212 * value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
1215 * The mempool ops name to be used for this mempool instead of
1216 * default mempool. The value can be *NULL* to use default mempool.
1218 * The pointer to the new allocated mempool, on success. NULL on error
1219 * with rte_errno set appropriately. Possible rte_errno values include:
1220 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
1221 * - E_RTE_SECONDARY - function was called from a secondary process instance
1222 * - EINVAL - cache size provided is too large, or priv_size is not aligned.
1223 * - ENOSPC - the maximum number of memzones has already been allocated
1224 * - EEXIST - a memzone with the same name already exists
1225 * - ENOMEM - no appropriate memory area found in which to create memzone
1227 struct rte_mempool *
1228 rte_pktmbuf_pool_create_by_ops(const char *name, unsigned int n,
1229 unsigned int cache_size, uint16_t priv_size, uint16_t data_room_size,
1230 int socket_id, const char *ops_name);
1233 * Get the data room size of mbufs stored in a pktmbuf_pool
1235 * The data room size is the amount of data that can be stored in a
1236 * mbuf including the headroom (RTE_PKTMBUF_HEADROOM).
1239 * The packet mbuf pool.
1241 * The data room size of mbufs stored in this mempool.
1243 static inline uint16_t
1244 rte_pktmbuf_data_room_size(struct rte_mempool *mp)
1246 struct rte_pktmbuf_pool_private *mbp_priv;
1248 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1249 return mbp_priv->mbuf_data_room_size;
1253 * Get the application private size of mbufs stored in a pktmbuf_pool
1255 * The private size of mbuf is a zone located between the rte_mbuf
1256 * structure and the data buffer where an application can store data
1257 * associated to a packet.
1260 * The packet mbuf pool.
1262 * The private size of mbufs stored in this mempool.
1264 static inline uint16_t
1265 rte_pktmbuf_priv_size(struct rte_mempool *mp)
1267 struct rte_pktmbuf_pool_private *mbp_priv;
1269 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1270 return mbp_priv->mbuf_priv_size;
1274 * Reset the data_off field of a packet mbuf to its default value.
1276 * The given mbuf must have only one segment, which should be empty.
1279 * The packet mbuf's data_off field has to be reset.
1281 static inline void rte_pktmbuf_reset_headroom(struct rte_mbuf *m)
1283 m->data_off = (uint16_t)RTE_MIN((uint16_t)RTE_PKTMBUF_HEADROOM,
1284 (uint16_t)m->buf_len);
1288 * Reset the fields of a packet mbuf to their default values.
1290 * The given mbuf must have only one segment.
1293 * The packet mbuf to be reset.
1295 #define MBUF_INVALID_PORT UINT16_MAX
1297 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
1303 m->vlan_tci_outer = 0;
1305 m->port = MBUF_INVALID_PORT;
1309 rte_pktmbuf_reset_headroom(m);
1312 __rte_mbuf_sanity_check(m, 1);
1316 * Allocate a new mbuf from a mempool.
1318 * This new mbuf contains one segment, which has a length of 0. The pointer
1319 * to data is initialized to have some bytes of headroom in the buffer
1320 * (if buffer size allows).
1323 * The mempool from which the mbuf is allocated.
1325 * - The pointer to the new mbuf on success.
1326 * - NULL if allocation failed.
1328 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
1331 if ((m = rte_mbuf_raw_alloc(mp)) != NULL)
1332 rte_pktmbuf_reset(m);
1337 * Allocate a bulk of mbufs, initialize refcnt and reset the fields to default
1341 * The mempool from which mbufs are allocated.
1343 * Array of pointers to mbufs
1348 * - -ENOENT: Not enough entries in the mempool; no mbufs are retrieved.
1350 static inline int rte_pktmbuf_alloc_bulk(struct rte_mempool *pool,
1351 struct rte_mbuf **mbufs, unsigned count)
1356 rc = rte_mempool_get_bulk(pool, (void **)mbufs, count);
1360 /* To understand duff's device on loop unwinding optimization, see
1361 * https://en.wikipedia.org/wiki/Duff's_device.
1362 * Here while() loop is used rather than do() while{} to avoid extra
1363 * check if count is zero.
1365 switch (count % 4) {
1367 while (idx != count) {
1368 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1369 rte_pktmbuf_reset(mbufs[idx]);
1373 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1374 rte_pktmbuf_reset(mbufs[idx]);
1378 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1379 rte_pktmbuf_reset(mbufs[idx]);
1383 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1384 rte_pktmbuf_reset(mbufs[idx]);
1393 * Initialize shared data at the end of an external buffer before attaching
1394 * to a mbuf by ``rte_pktmbuf_attach_extbuf()``. This is not a mandatory
1395 * initialization but a helper function to simply spare a few bytes at the
1396 * end of the buffer for shared data. If shared data is allocated
1397 * separately, this should not be called but application has to properly
1398 * initialize the shared data according to its need.
1400 * Free callback and its argument is saved and the refcnt is set to 1.
1403 * The value of buf_len will be reduced to RTE_PTR_DIFF(shinfo, buf_addr)
1404 * after this initialization. This shall be used for
1405 * ``rte_pktmbuf_attach_extbuf()``
1408 * The pointer to the external buffer.
1409 * @param [in,out] buf_len
1410 * The pointer to length of the external buffer. Input value must be
1411 * larger than the size of ``struct rte_mbuf_ext_shared_info`` and
1412 * padding for alignment. If not enough, this function will return NULL.
1413 * Adjusted buffer length will be returned through this pointer.
1415 * Free callback function to call when the external buffer needs to be
1418 * Argument for the free callback function.
1421 * A pointer to the initialized shared data on success, return NULL
1424 static inline struct rte_mbuf_ext_shared_info *
1425 rte_pktmbuf_ext_shinfo_init_helper(void *buf_addr, uint16_t *buf_len,
1426 rte_mbuf_extbuf_free_callback_t free_cb, void *fcb_opaque)
1428 struct rte_mbuf_ext_shared_info *shinfo;
1429 void *buf_end = RTE_PTR_ADD(buf_addr, *buf_len);
1432 addr = RTE_PTR_ALIGN_FLOOR(RTE_PTR_SUB(buf_end, sizeof(*shinfo)),
1434 if (addr <= buf_addr)
1437 shinfo = (struct rte_mbuf_ext_shared_info *)addr;
1438 shinfo->free_cb = free_cb;
1439 shinfo->fcb_opaque = fcb_opaque;
1440 rte_mbuf_ext_refcnt_set(shinfo, 1);
1442 *buf_len = (uint16_t)RTE_PTR_DIFF(shinfo, buf_addr);
1447 * Attach an external buffer to a mbuf.
1449 * User-managed anonymous buffer can be attached to an mbuf. When attaching
1450 * it, corresponding free callback function and its argument should be
1451 * provided via shinfo. This callback function will be called once all the
1452 * mbufs are detached from the buffer (refcnt becomes zero).
1454 * The headroom for the attaching mbuf will be set to zero and this can be
1455 * properly adjusted after attachment. For example, ``rte_pktmbuf_adj()``
1456 * or ``rte_pktmbuf_reset_headroom()`` might be used.
1458 * More mbufs can be attached to the same external buffer by
1459 * ``rte_pktmbuf_attach()`` once the external buffer has been attached by
1462 * Detachment can be done by either ``rte_pktmbuf_detach_extbuf()`` or
1463 * ``rte_pktmbuf_detach()``.
1465 * Memory for shared data must be provided and user must initialize all of
1466 * the content properly, especially free callback and refcnt. The pointer
1467 * of shared data will be stored in m->shinfo.
1468 * ``rte_pktmbuf_ext_shinfo_init_helper`` can help to simply spare a few
1469 * bytes at the end of buffer for the shared data, store free callback and
1470 * its argument and set the refcnt to 1. The following is an example:
1472 * struct rte_mbuf_ext_shared_info *shinfo =
1473 * rte_pktmbuf_ext_shinfo_init_helper(buf_addr, &buf_len,
1474 * free_cb, fcb_arg);
1475 * rte_pktmbuf_attach_extbuf(m, buf_addr, buf_iova, buf_len, shinfo);
1476 * rte_pktmbuf_reset_headroom(m);
1477 * rte_pktmbuf_adj(m, data_len);
1479 * Attaching an external buffer is quite similar to mbuf indirection in
1480 * replacing buffer addresses and length of a mbuf, but a few differences:
1481 * - When an indirect mbuf is attached, refcnt of the direct mbuf would be
1482 * 2 as long as the direct mbuf itself isn't freed after the attachment.
1483 * In such cases, the buffer area of a direct mbuf must be read-only. But
1484 * external buffer has its own refcnt and it starts from 1. Unless
1485 * multiple mbufs are attached to a mbuf having an external buffer, the
1486 * external buffer is writable.
1487 * - There's no need to allocate buffer from a mempool. Any buffer can be
1488 * attached with appropriate free callback and its IO address.
1489 * - Smaller metadata is required to maintain shared data such as refcnt.
1492 * @b EXPERIMENTAL: This API may change without prior notice.
1493 * Once external buffer is enabled by allowing experimental API,
1494 * ``RTE_MBUF_DIRECT()`` and ``RTE_MBUF_INDIRECT()`` are no longer
1495 * exclusive. A mbuf can be considered direct if it is neither indirect nor
1496 * having external buffer.
1499 * The pointer to the mbuf.
1501 * The pointer to the external buffer.
1503 * IO address of the external buffer.
1505 * The size of the external buffer.
1507 * User-provided memory for shared data of the external buffer.
1509 static inline void __rte_experimental
1510 rte_pktmbuf_attach_extbuf(struct rte_mbuf *m, void *buf_addr,
1511 rte_iova_t buf_iova, uint16_t buf_len,
1512 struct rte_mbuf_ext_shared_info *shinfo)
1514 /* mbuf should not be read-only */
1515 RTE_ASSERT(RTE_MBUF_DIRECT(m) && rte_mbuf_refcnt_read(m) == 1);
1516 RTE_ASSERT(shinfo->free_cb != NULL);
1518 m->buf_addr = buf_addr;
1519 m->buf_iova = buf_iova;
1520 m->buf_len = buf_len;
1525 m->ol_flags |= EXT_ATTACHED_MBUF;
1530 * Detach the external buffer attached to a mbuf, same as
1531 * ``rte_pktmbuf_detach()``
1534 * The mbuf having external buffer.
1536 #define rte_pktmbuf_detach_extbuf(m) rte_pktmbuf_detach(m)
1539 * Attach packet mbuf to another packet mbuf.
1541 * If the mbuf we are attaching to isn't a direct buffer and is attached to
1542 * an external buffer, the mbuf being attached will be attached to the
1543 * external buffer instead of mbuf indirection.
1545 * Otherwise, the mbuf will be indirectly attached. After attachment we
1546 * refer the mbuf we attached as 'indirect', while mbuf we attached to as
1547 * 'direct'. The direct mbuf's reference counter is incremented.
1549 * Right now, not supported:
1550 * - attachment for already indirect mbuf (e.g. - mi has to be direct).
1551 * - mbuf we trying to attach (mi) is used by someone else
1552 * e.g. it's reference counter is greater then 1.
1555 * The indirect packet mbuf.
1557 * The packet mbuf we're attaching to.
1559 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *m)
1561 RTE_ASSERT(RTE_MBUF_DIRECT(mi) &&
1562 rte_mbuf_refcnt_read(mi) == 1);
1564 if (RTE_MBUF_HAS_EXTBUF(m)) {
1565 rte_mbuf_ext_refcnt_update(m->shinfo, 1);
1566 mi->ol_flags = m->ol_flags;
1567 mi->shinfo = m->shinfo;
1569 /* if m is not direct, get the mbuf that embeds the data */
1570 rte_mbuf_refcnt_update(rte_mbuf_from_indirect(m), 1);
1571 mi->priv_size = m->priv_size;
1572 mi->ol_flags = m->ol_flags | IND_ATTACHED_MBUF;
1575 mi->buf_iova = m->buf_iova;
1576 mi->buf_addr = m->buf_addr;
1577 mi->buf_len = m->buf_len;
1579 mi->data_off = m->data_off;
1580 mi->data_len = m->data_len;
1582 mi->vlan_tci = m->vlan_tci;
1583 mi->vlan_tci_outer = m->vlan_tci_outer;
1584 mi->tx_offload = m->tx_offload;
1588 mi->pkt_len = mi->data_len;
1590 mi->packet_type = m->packet_type;
1591 mi->timestamp = m->timestamp;
1593 __rte_mbuf_sanity_check(mi, 1);
1594 __rte_mbuf_sanity_check(m, 0);
1598 * @internal used by rte_pktmbuf_detach().
1600 * Decrement the reference counter of the external buffer. When the
1601 * reference counter becomes 0, the buffer is freed by pre-registered
1605 __rte_pktmbuf_free_extbuf(struct rte_mbuf *m)
1607 RTE_ASSERT(RTE_MBUF_HAS_EXTBUF(m));
1608 RTE_ASSERT(m->shinfo != NULL);
1610 if (rte_mbuf_ext_refcnt_update(m->shinfo, -1) == 0)
1611 m->shinfo->free_cb(m->buf_addr, m->shinfo->fcb_opaque);
1615 * @internal used by rte_pktmbuf_detach().
1617 * Decrement the direct mbuf's reference counter. When the reference
1618 * counter becomes 0, the direct mbuf is freed.
1621 __rte_pktmbuf_free_direct(struct rte_mbuf *m)
1623 struct rte_mbuf *md;
1625 RTE_ASSERT(RTE_MBUF_INDIRECT(m));
1627 md = rte_mbuf_from_indirect(m);
1629 if (rte_mbuf_refcnt_update(md, -1) == 0) {
1632 rte_mbuf_refcnt_set(md, 1);
1633 rte_mbuf_raw_free(md);
1638 * Detach a packet mbuf from external buffer or direct buffer.
1640 * - decrement refcnt and free the external/direct buffer if refcnt
1642 * - restore original mbuf address and length values.
1643 * - reset pktmbuf data and data_len to their default values.
1645 * All other fields of the given packet mbuf will be left intact.
1648 * The indirect attached packet mbuf.
1650 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
1652 struct rte_mempool *mp = m->pool;
1653 uint32_t mbuf_size, buf_len;
1656 if (RTE_MBUF_HAS_EXTBUF(m))
1657 __rte_pktmbuf_free_extbuf(m);
1659 __rte_pktmbuf_free_direct(m);
1661 priv_size = rte_pktmbuf_priv_size(mp);
1662 mbuf_size = (uint32_t)(sizeof(struct rte_mbuf) + priv_size);
1663 buf_len = rte_pktmbuf_data_room_size(mp);
1665 m->priv_size = priv_size;
1666 m->buf_addr = (char *)m + mbuf_size;
1667 m->buf_iova = rte_mempool_virt2iova(m) + mbuf_size;
1668 m->buf_len = (uint16_t)buf_len;
1669 rte_pktmbuf_reset_headroom(m);
1675 * Decrease reference counter and unlink a mbuf segment
1677 * This function does the same than a free, except that it does not
1678 * return the segment to its pool.
1679 * It decreases the reference counter, and if it reaches 0, it is
1680 * detached from its parent for an indirect mbuf.
1683 * The mbuf to be unlinked
1685 * - (m) if it is the last reference. It can be recycled or freed.
1686 * - (NULL) if the mbuf still has remaining references on it.
1688 static __rte_always_inline struct rte_mbuf *
1689 rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
1691 __rte_mbuf_sanity_check(m, 0);
1693 if (likely(rte_mbuf_refcnt_read(m) == 1)) {
1695 if (!RTE_MBUF_DIRECT(m))
1696 rte_pktmbuf_detach(m);
1698 if (m->next != NULL) {
1705 } else if (__rte_mbuf_refcnt_update(m, -1) == 0) {
1707 if (!RTE_MBUF_DIRECT(m))
1708 rte_pktmbuf_detach(m);
1710 if (m->next != NULL) {
1714 rte_mbuf_refcnt_set(m, 1);
1722 * Free a segment of a packet mbuf into its original mempool.
1724 * Free an mbuf, without parsing other segments in case of chained
1728 * The packet mbuf segment to be freed.
1730 static __rte_always_inline void
1731 rte_pktmbuf_free_seg(struct rte_mbuf *m)
1733 m = rte_pktmbuf_prefree_seg(m);
1734 if (likely(m != NULL))
1735 rte_mbuf_raw_free(m);
1739 * Free a packet mbuf back into its original mempool.
1741 * Free an mbuf, and all its segments in case of chained buffers. Each
1742 * segment is added back into its original mempool.
1745 * The packet mbuf to be freed. If NULL, the function does nothing.
1747 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
1749 struct rte_mbuf *m_next;
1752 __rte_mbuf_sanity_check(m, 1);
1756 rte_pktmbuf_free_seg(m);
1762 * Creates a "clone" of the given packet mbuf.
1764 * Walks through all segments of the given packet mbuf, and for each of them:
1765 * - Creates a new packet mbuf from the given pool.
1766 * - Attaches newly created mbuf to the segment.
1767 * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
1768 * from the original packet mbuf.
1771 * The packet mbuf to be cloned.
1773 * The mempool from which the "clone" mbufs are allocated.
1775 * - The pointer to the new "clone" mbuf on success.
1776 * - NULL if allocation fails.
1778 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
1779 struct rte_mempool *mp)
1781 struct rte_mbuf *mc, *mi, **prev;
1785 if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
1790 pktlen = md->pkt_len;
1795 rte_pktmbuf_attach(mi, md);
1798 } while ((md = md->next) != NULL &&
1799 (mi = rte_pktmbuf_alloc(mp)) != NULL);
1803 mc->pkt_len = pktlen;
1805 /* Allocation of new indirect segment failed */
1806 if (unlikely (mi == NULL)) {
1807 rte_pktmbuf_free(mc);
1811 __rte_mbuf_sanity_check(mc, 1);
1816 * Adds given value to the refcnt of all packet mbuf segments.
1818 * Walks through all segments of given packet mbuf and for each of them
1819 * invokes rte_mbuf_refcnt_update().
1822 * The packet mbuf whose refcnt to be updated.
1824 * The value to add to the mbuf's segments refcnt.
1826 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
1828 __rte_mbuf_sanity_check(m, 1);
1831 rte_mbuf_refcnt_update(m, v);
1832 } while ((m = m->next) != NULL);
1836 * Get the headroom in a packet mbuf.
1841 * The length of the headroom.
1843 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
1845 __rte_mbuf_sanity_check(m, 0);
1850 * Get the tailroom of a packet mbuf.
1855 * The length of the tailroom.
1857 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
1859 __rte_mbuf_sanity_check(m, 0);
1860 return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
1865 * Get the last segment of the packet.
1870 * The last segment of the given mbuf.
1872 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
1874 __rte_mbuf_sanity_check(m, 1);
1875 while (m->next != NULL)
1881 * A macro that points to an offset into the data in the mbuf.
1883 * The returned pointer is cast to type t. Before using this
1884 * function, the user must ensure that the first segment is large
1885 * enough to accommodate its data.
1890 * The offset into the mbuf data.
1892 * The type to cast the result into.
1894 #define rte_pktmbuf_mtod_offset(m, t, o) \
1895 ((t)((char *)(m)->buf_addr + (m)->data_off + (o)))
1898 * A macro that points to the start of the data in the mbuf.
1900 * The returned pointer is cast to type t. Before using this
1901 * function, the user must ensure that the first segment is large
1902 * enough to accommodate its data.
1907 * The type to cast the result into.
1909 #define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0)
1912 * A macro that returns the IO address that points to an offset of the
1913 * start of the data in the mbuf
1918 * The offset into the data to calculate address from.
1920 #define rte_pktmbuf_iova_offset(m, o) \
1921 (rte_iova_t)((m)->buf_iova + (m)->data_off + (o))
1924 #define rte_pktmbuf_mtophys_offset(m, o) \
1925 rte_pktmbuf_iova_offset(m, o)
1928 * A macro that returns the IO address that points to the start of the
1934 #define rte_pktmbuf_iova(m) rte_pktmbuf_iova_offset(m, 0)
1937 #define rte_pktmbuf_mtophys(m) rte_pktmbuf_iova(m)
1940 * A macro that returns the length of the packet.
1942 * The value can be read or assigned.
1947 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
1950 * A macro that returns the length of the segment.
1952 * The value can be read or assigned.
1957 #define rte_pktmbuf_data_len(m) ((m)->data_len)
1960 * Prepend len bytes to an mbuf data area.
1962 * Returns a pointer to the new
1963 * data start address. If there is not enough headroom in the first
1964 * segment, the function will return NULL, without modifying the mbuf.
1969 * The amount of data to prepend (in bytes).
1971 * A pointer to the start of the newly prepended data, or
1972 * NULL if there is not enough headroom space in the first segment
1974 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
1977 __rte_mbuf_sanity_check(m, 1);
1979 if (unlikely(len > rte_pktmbuf_headroom(m)))
1982 /* NB: elaborating the subtraction like this instead of using
1983 * -= allows us to ensure the result type is uint16_t
1984 * avoiding compiler warnings on gcc 8.1 at least */
1985 m->data_off = (uint16_t)(m->data_off - len);
1986 m->data_len = (uint16_t)(m->data_len + len);
1987 m->pkt_len = (m->pkt_len + len);
1989 return (char *)m->buf_addr + m->data_off;
1993 * Append len bytes to an mbuf.
1995 * Append len bytes to an mbuf and return a pointer to the start address
1996 * of the added data. If there is not enough tailroom in the last
1997 * segment, the function will return NULL, without modifying the mbuf.
2002 * The amount of data to append (in bytes).
2004 * A pointer to the start of the newly appended data, or
2005 * NULL if there is not enough tailroom space in the last segment
2007 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
2010 struct rte_mbuf *m_last;
2012 __rte_mbuf_sanity_check(m, 1);
2014 m_last = rte_pktmbuf_lastseg(m);
2015 if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
2018 tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
2019 m_last->data_len = (uint16_t)(m_last->data_len + len);
2020 m->pkt_len = (m->pkt_len + len);
2021 return (char*) tail;
2025 * Remove len bytes at the beginning of an mbuf.
2027 * Returns a pointer to the start address of the new data area. If the
2028 * length is greater than the length of the first segment, then the
2029 * function will fail and return NULL, without modifying the mbuf.
2034 * The amount of data to remove (in bytes).
2036 * A pointer to the new start of the data.
2038 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
2040 __rte_mbuf_sanity_check(m, 1);
2042 if (unlikely(len > m->data_len))
2045 /* NB: elaborating the addition like this instead of using
2046 * += allows us to ensure the result type is uint16_t
2047 * avoiding compiler warnings on gcc 8.1 at least */
2048 m->data_len = (uint16_t)(m->data_len - len);
2049 m->data_off = (uint16_t)(m->data_off + len);
2050 m->pkt_len = (m->pkt_len - len);
2051 return (char *)m->buf_addr + m->data_off;
2055 * Remove len bytes of data at the end of the mbuf.
2057 * If the length is greater than the length of the last segment, the
2058 * function will fail and return -1 without modifying the mbuf.
2063 * The amount of data to remove (in bytes).
2068 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
2070 struct rte_mbuf *m_last;
2072 __rte_mbuf_sanity_check(m, 1);
2074 m_last = rte_pktmbuf_lastseg(m);
2075 if (unlikely(len > m_last->data_len))
2078 m_last->data_len = (uint16_t)(m_last->data_len - len);
2079 m->pkt_len = (m->pkt_len - len);
2084 * Test if mbuf data is contiguous.
2089 * - 1, if all data is contiguous (one segment).
2090 * - 0, if there is several segments.
2092 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
2094 __rte_mbuf_sanity_check(m, 1);
2095 return !!(m->nb_segs == 1);
2099 * @internal used by rte_pktmbuf_read().
2101 const void *__rte_pktmbuf_read(const struct rte_mbuf *m, uint32_t off,
2102 uint32_t len, void *buf);
2105 * Read len data bytes in a mbuf at specified offset.
2107 * If the data is contiguous, return the pointer in the mbuf data, else
2108 * copy the data in the buffer provided by the user and return its
2112 * The pointer to the mbuf.
2114 * The offset of the data in the mbuf.
2116 * The amount of bytes to read.
2118 * The buffer where data is copied if it is not contiguous in mbuf
2119 * data. Its length should be at least equal to the len parameter.
2121 * The pointer to the data, either in the mbuf if it is contiguous,
2122 * or in the user buffer. If mbuf is too small, NULL is returned.
2124 static inline const void *rte_pktmbuf_read(const struct rte_mbuf *m,
2125 uint32_t off, uint32_t len, void *buf)
2127 if (likely(off + len <= rte_pktmbuf_data_len(m)))
2128 return rte_pktmbuf_mtod_offset(m, char *, off);
2130 return __rte_pktmbuf_read(m, off, len, buf);
2134 * Chain an mbuf to another, thereby creating a segmented packet.
2136 * Note: The implementation will do a linear walk over the segments to find
2137 * the tail entry. For cases when there are many segments, it's better to
2138 * chain the entries manually.
2141 * The head of the mbuf chain (the first packet)
2143 * The mbuf to put last in the chain
2147 * - -EOVERFLOW, if the chain segment limit exceeded
2149 static inline int rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail)
2151 struct rte_mbuf *cur_tail;
2153 /* Check for number-of-segments-overflow */
2154 if (head->nb_segs + tail->nb_segs > RTE_MBUF_MAX_NB_SEGS)
2157 /* Chain 'tail' onto the old tail */
2158 cur_tail = rte_pktmbuf_lastseg(head);
2159 cur_tail->next = tail;
2161 /* accumulate number of segments and total length.
2162 * NB: elaborating the addition like this instead of using
2163 * -= allows us to ensure the result type is uint16_t
2164 * avoiding compiler warnings on gcc 8.1 at least */
2165 head->nb_segs = (uint16_t)(head->nb_segs + tail->nb_segs);
2166 head->pkt_len += tail->pkt_len;
2168 /* pkt_len is only set in the head */
2169 tail->pkt_len = tail->data_len;
2175 * Validate general requirements for Tx offload in mbuf.
2177 * This function checks correctness and completeness of Tx offload settings.
2180 * The packet mbuf to be validated.
2182 * 0 if packet is valid
2185 rte_validate_tx_offload(const struct rte_mbuf *m)
2187 uint64_t ol_flags = m->ol_flags;
2188 uint64_t inner_l3_offset = m->l2_len;
2190 /* Does packet set any of available offloads? */
2191 if (!(ol_flags & PKT_TX_OFFLOAD_MASK))
2194 if (ol_flags & PKT_TX_OUTER_IP_CKSUM)
2195 /* NB: elaborating the addition like this instead of using
2196 * += gives the result uint64_t type instead of int,
2197 * avoiding compiler warnings on gcc 8.1 at least */
2198 inner_l3_offset = inner_l3_offset + m->outer_l2_len +
2201 /* Headers are fragmented */
2202 if (rte_pktmbuf_data_len(m) < inner_l3_offset + m->l3_len + m->l4_len)
2205 /* IP checksum can be counted only for IPv4 packet */
2206 if ((ol_flags & PKT_TX_IP_CKSUM) && (ol_flags & PKT_TX_IPV6))
2209 /* IP type not set when required */
2210 if (ol_flags & (PKT_TX_L4_MASK | PKT_TX_TCP_SEG))
2211 if (!(ol_flags & (PKT_TX_IPV4 | PKT_TX_IPV6)))
2214 /* Check requirements for TSO packet */
2215 if (ol_flags & PKT_TX_TCP_SEG)
2216 if ((m->tso_segsz == 0) ||
2217 ((ol_flags & PKT_TX_IPV4) &&
2218 !(ol_flags & PKT_TX_IP_CKSUM)))
2221 /* PKT_TX_OUTER_IP_CKSUM set for non outer IPv4 packet. */
2222 if ((ol_flags & PKT_TX_OUTER_IP_CKSUM) &&
2223 !(ol_flags & PKT_TX_OUTER_IPV4))
2230 * Linearize data in mbuf.
2232 * This function moves the mbuf data in the first segment if there is enough
2233 * tailroom. The subsequent segments are unchained and freed.
2242 rte_pktmbuf_linearize(struct rte_mbuf *mbuf)
2244 size_t seg_len, copy_len;
2246 struct rte_mbuf *m_next;
2249 if (rte_pktmbuf_is_contiguous(mbuf))
2252 /* Extend first segment to the total packet length */
2253 copy_len = rte_pktmbuf_pkt_len(mbuf) - rte_pktmbuf_data_len(mbuf);
2255 if (unlikely(copy_len > rte_pktmbuf_tailroom(mbuf)))
2258 buffer = rte_pktmbuf_mtod_offset(mbuf, char *, mbuf->data_len);
2259 mbuf->data_len = (uint16_t)(mbuf->pkt_len);
2261 /* Append data from next segments to the first one */
2266 seg_len = rte_pktmbuf_data_len(m);
2267 rte_memcpy(buffer, rte_pktmbuf_mtod(m, char *), seg_len);
2270 rte_pktmbuf_free_seg(m);
2281 * Dump an mbuf structure to a file.
2283 * Dump all fields for the given packet mbuf and all its associated
2284 * segments (in the case of a chained buffer).
2287 * A pointer to a file for output
2291 * If dump_len != 0, also dump the "dump_len" first data bytes of
2294 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
2300 #endif /* _RTE_MBUF_H_ */