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. If this flag is set,
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.
174 * If the flag PKT_RX_QINQ_STRIPPED is also present, both VLANs
175 * headers have been stripped from mbuf data, else they are still
178 #define PKT_RX_QINQ (1ULL << 20)
180 /* add new RX flags here */
182 /* add new TX flags here */
185 * UDP Fragmentation Offload flag. This flag is used for enabling UDP
186 * fragmentation in SW or in HW. When use UFO, mbuf->tso_segsz is used
187 * to store the MSS of UDP fragments.
189 #define PKT_TX_UDP_SEG (1ULL << 42)
192 * Request security offload processing on the TX packet.
194 #define PKT_TX_SEC_OFFLOAD (1ULL << 43)
197 * Offload the MACsec. This flag must be set by the application to enable
198 * this offload feature for a packet to be transmitted.
200 #define PKT_TX_MACSEC (1ULL << 44)
203 * Bits 45:48 used for the tunnel type.
204 * The tunnel type must be specified for TSO or checksum on the inner part
206 * These flags can be used with PKT_TX_TCP_SEG for TSO, or PKT_TX_xxx_CKSUM.
207 * The mbuf fields for inner and outer header lengths are required:
208 * outer_l2_len, outer_l3_len, l2_len, l3_len, l4_len and tso_segsz for TSO.
210 #define PKT_TX_TUNNEL_VXLAN (0x1ULL << 45)
211 #define PKT_TX_TUNNEL_GRE (0x2ULL << 45)
212 #define PKT_TX_TUNNEL_IPIP (0x3ULL << 45)
213 #define PKT_TX_TUNNEL_GENEVE (0x4ULL << 45)
214 /** TX packet with MPLS-in-UDP RFC 7510 header. */
215 #define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45)
216 #define PKT_TX_TUNNEL_VXLAN_GPE (0x6ULL << 45)
218 * Generic IP encapsulated tunnel type, used for TSO and checksum offload.
219 * It can be used for tunnels which are not standards or listed above.
220 * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_GRE
221 * or PKT_TX_TUNNEL_IPIP if possible.
222 * The ethdev must be configured with DEV_TX_OFFLOAD_IP_TNL_TSO.
223 * Outer and inner checksums are done according to the existing flags like
225 * Specific tunnel headers that contain payload length, sequence id
226 * or checksum are not expected to be updated.
228 #define PKT_TX_TUNNEL_IP (0xDULL << 45)
230 * Generic UDP encapsulated tunnel type, used for TSO and checksum offload.
231 * UDP tunnel type implies outer IP layer.
232 * It can be used for tunnels which are not standards or listed above.
233 * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_VXLAN
235 * The ethdev must be configured with DEV_TX_OFFLOAD_UDP_TNL_TSO.
236 * Outer and inner checksums are done according to the existing flags like
238 * Specific tunnel headers that contain payload length, sequence id
239 * or checksum are not expected to be updated.
241 #define PKT_TX_TUNNEL_UDP (0xEULL << 45)
242 /* add new TX TUNNEL type here */
243 #define PKT_TX_TUNNEL_MASK (0xFULL << 45)
246 * Second VLAN insertion (QinQ) flag.
248 #define PKT_TX_QINQ (1ULL << 49) /**< TX packet with double VLAN inserted. */
249 /* this old name is deprecated */
250 #define PKT_TX_QINQ_PKT PKT_TX_QINQ
253 * TCP segmentation offload. To enable this offload feature for a
254 * packet to be transmitted on hardware supporting TSO:
255 * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies
257 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
258 * - if it's IPv4, set the PKT_TX_IP_CKSUM flag
259 * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz
261 #define PKT_TX_TCP_SEG (1ULL << 50)
263 #define PKT_TX_IEEE1588_TMST (1ULL << 51) /**< TX IEEE1588 packet to timestamp. */
266 * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved,
267 * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware
268 * L4 checksum offload, the user needs to:
269 * - fill l2_len and l3_len in mbuf
270 * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM
271 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
273 #define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */
274 #define PKT_TX_TCP_CKSUM (1ULL << 52) /**< TCP cksum of TX pkt. computed by NIC. */
275 #define PKT_TX_SCTP_CKSUM (2ULL << 52) /**< SCTP cksum of TX pkt. computed by NIC. */
276 #define PKT_TX_UDP_CKSUM (3ULL << 52) /**< UDP cksum of TX pkt. computed by NIC. */
277 #define PKT_TX_L4_MASK (3ULL << 52) /**< Mask for L4 cksum offload request. */
280 * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should
281 * also be set by the application, although a PMD will only check
283 * - fill the mbuf offload information: l2_len, l3_len
285 #define PKT_TX_IP_CKSUM (1ULL << 54)
288 * Packet is IPv4. This flag must be set when using any offload feature
289 * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4
290 * packet. If the packet is a tunneled packet, this flag is related to
293 #define PKT_TX_IPV4 (1ULL << 55)
296 * Packet is IPv6. This flag must be set when using an offload feature
297 * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6
298 * packet. If the packet is a tunneled packet, this flag is related to
301 #define PKT_TX_IPV6 (1ULL << 56)
304 * TX packet is a 802.1q VLAN packet.
306 #define PKT_TX_VLAN (1ULL << 57)
307 /* this old name is deprecated */
308 #define PKT_TX_VLAN_PKT PKT_TX_VLAN
311 * Offload the IP checksum of an external header in the hardware. The
312 * flag PKT_TX_OUTER_IPV4 should also be set by the application, although
313 * a PMD will only check PKT_TX_OUTER_IP_CKSUM.
314 * - fill the mbuf offload information: outer_l2_len, outer_l3_len
316 #define PKT_TX_OUTER_IP_CKSUM (1ULL << 58)
319 * Packet outer header is IPv4. This flag must be set when using any
320 * outer offload feature (L3 or L4 checksum) to tell the NIC that the
321 * outer header of the tunneled packet is an IPv4 packet.
323 #define PKT_TX_OUTER_IPV4 (1ULL << 59)
326 * Packet outer header is IPv6. This flag must be set when using any
327 * outer offload feature (L4 checksum) to tell the NIC that the outer
328 * header of the tunneled packet is an IPv6 packet.
330 #define PKT_TX_OUTER_IPV6 (1ULL << 60)
333 * Bitmask of all supported packet Tx offload features flags,
334 * which can be set for packet.
336 #define PKT_TX_OFFLOAD_MASK ( \
339 PKT_TX_OUTER_IP_CKSUM | \
341 PKT_TX_IEEE1588_TMST | \
344 PKT_TX_TUNNEL_MASK | \
349 * Mbuf having an external buffer attached. shinfo in mbuf must be filled.
351 #define EXT_ATTACHED_MBUF (1ULL << 61)
353 #define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */
355 /** Alignment constraint of mbuf private area. */
356 #define RTE_MBUF_PRIV_ALIGN 8
359 * Get the name of a RX offload flag
362 * The mask describing the flag.
364 * The name of this flag, or NULL if it's not a valid RX flag.
366 const char *rte_get_rx_ol_flag_name(uint64_t mask);
369 * Dump the list of RX offload flags in a buffer
372 * The mask describing the RX flags.
376 * The length of the buffer.
378 * 0 on success, (-1) on error.
380 int rte_get_rx_ol_flag_list(uint64_t mask, char *buf, size_t buflen);
383 * Get the name of a TX offload flag
386 * The mask describing the flag. Usually only one bit must be set.
387 * Several bits can be given if they belong to the same mask.
388 * Ex: PKT_TX_L4_MASK.
390 * The name of this flag, or NULL if it's not a valid TX flag.
392 const char *rte_get_tx_ol_flag_name(uint64_t mask);
395 * Dump the list of TX offload flags in a buffer
398 * The mask describing the TX flags.
402 * The length of the buffer.
404 * 0 on success, (-1) on error.
406 int rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen);
409 * Some NICs need at least 2KB buffer to RX standard Ethernet frame without
410 * splitting it into multiple segments.
411 * So, for mbufs that planned to be involved into RX/TX, the recommended
412 * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM.
414 #define RTE_MBUF_DEFAULT_DATAROOM 2048
415 #define RTE_MBUF_DEFAULT_BUF_SIZE \
416 (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM)
418 /* define a set of marker types that can be used to refer to set points in the
421 typedef void *MARKER[0]; /**< generic marker for a point in a structure */
423 typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */
425 typedef uint64_t MARKER64[0]; /**< marker that allows us to overwrite 8 bytes
426 * with a single assignment */
429 * The generic rte_mbuf, containing a packet mbuf.
434 void *buf_addr; /**< Virtual address of segment buffer. */
436 * Physical address of segment buffer.
437 * Force alignment to 8-bytes, so as to ensure we have the exact
438 * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes
439 * working on vector drivers easier.
444 rte_iova_t buf_physaddr; /**< deprecated */
445 } __rte_aligned(sizeof(rte_iova_t));
447 /* next 8 bytes are initialised on RX descriptor rearm */
452 * Reference counter. Its size should at least equal to the size
453 * of port field (16 bits), to support zero-copy broadcast.
454 * It should only be accessed using the following functions:
455 * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
456 * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
457 * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
462 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
463 uint16_t refcnt; /**< Non-atomically accessed refcnt */
465 uint16_t nb_segs; /**< Number of segments. */
467 /** Input port (16 bits to support more than 256 virtual ports).
468 * The event eth Tx adapter uses this field to specify the output port.
472 uint64_t ol_flags; /**< Offload features. */
474 /* remaining bytes are set on RX when pulling packet from descriptor */
475 MARKER rx_descriptor_fields1;
478 * The packet type, which is the combination of outer/inner L2, L3, L4
479 * and tunnel types. The packet_type is about data really present in the
480 * mbuf. Example: if vlan stripping is enabled, a received vlan packet
481 * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the
482 * vlan is stripped from the data.
486 uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */
488 uint32_t l2_type:4; /**< (Outer) L2 type. */
489 uint32_t l3_type:4; /**< (Outer) L3 type. */
490 uint32_t l4_type:4; /**< (Outer) L4 type. */
491 uint32_t tun_type:4; /**< Tunnel type. */
494 uint8_t inner_esp_next_proto;
495 /**< ESP next protocol type, valid if
496 * RTE_PTYPE_TUNNEL_ESP tunnel type is set
501 uint8_t inner_l2_type:4;
502 /**< Inner L2 type. */
503 uint8_t inner_l3_type:4;
504 /**< Inner L3 type. */
507 uint32_t inner_l4_type:4; /**< Inner L4 type. */
511 uint32_t pkt_len; /**< Total pkt len: sum of all segments. */
512 uint16_t data_len; /**< Amount of data in segment buffer. */
513 /** VLAN TCI (CPU order), valid if PKT_RX_VLAN is set. */
517 uint32_t rss; /**< RSS hash result if RSS enabled */
526 /**< Second 4 flexible bytes */
529 /**< First 4 flexible bytes or FD ID, dependent on
530 PKT_RX_FDIR_* flag in ol_flags. */
531 } fdir; /**< Filter identifier if FDIR enabled */
535 /**< The event eth Tx adapter uses this field to store
536 * Tx queue id. @see rte_event_eth_tx_adapter_txq_set()
538 } sched; /**< Hierarchical scheduler */
539 uint32_t usr; /**< User defined tags. See rte_distributor_process() */
540 } hash; /**< hash information */
542 /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ is set. */
543 uint16_t vlan_tci_outer;
545 uint16_t buf_len; /**< Length of segment buffer. */
547 /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference
548 * are not normalized but are always the same for a given port.
552 /* second cache line - fields only used in slow path or on TX */
553 MARKER cacheline1 __rte_cache_min_aligned;
557 void *userdata; /**< Can be used for external metadata */
558 uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */
561 struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
562 struct rte_mbuf *next; /**< Next segment of scattered packet. */
564 /* fields to support TX offloads */
567 uint64_t tx_offload; /**< combined for easy fetch */
571 /**< L2 (MAC) Header Length for non-tunneling pkt.
572 * Outer_L4_len + ... + Inner_L2_len for tunneling pkt.
574 uint64_t l3_len:9; /**< L3 (IP) Header Length. */
575 uint64_t l4_len:8; /**< L4 (TCP/UDP) Header Length. */
576 uint64_t tso_segsz:16; /**< TCP TSO segment size */
578 /* fields for TX offloading of tunnels */
579 uint64_t outer_l3_len:9; /**< Outer L3 (IP) Hdr Length. */
580 uint64_t outer_l2_len:7; /**< Outer L2 (MAC) Hdr Length. */
582 /* uint64_t unused:8; */
586 /** Size of the application private data. In case of an indirect
587 * mbuf, it stores the direct mbuf private data size. */
590 /** Timesync flags for use with IEEE1588. */
593 /** Sequence number. See also rte_reorder_insert(). */
596 /** Shared data for external buffer attached to mbuf. See
597 * rte_pktmbuf_attach_extbuf().
599 struct rte_mbuf_ext_shared_info *shinfo;
601 } __rte_cache_aligned;
604 * Function typedef of callback to free externally attached buffer.
606 typedef void (*rte_mbuf_extbuf_free_callback_t)(void *addr, void *opaque);
609 * Shared data at the end of an external buffer.
611 struct rte_mbuf_ext_shared_info {
612 rte_mbuf_extbuf_free_callback_t free_cb; /**< Free callback function */
613 void *fcb_opaque; /**< Free callback argument */
614 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
617 /**< Maximum number of nb_segs allowed. */
618 #define RTE_MBUF_MAX_NB_SEGS UINT16_MAX
621 * Prefetch the first part of the mbuf
623 * The first 64 bytes of the mbuf corresponds to fields that are used early
624 * in the receive path. If the cache line of the architecture is higher than
625 * 64B, the second part will also be prefetched.
628 * The pointer to the mbuf.
631 rte_mbuf_prefetch_part1(struct rte_mbuf *m)
633 rte_prefetch0(&m->cacheline0);
637 * Prefetch the second part of the mbuf
639 * The next 64 bytes of the mbuf corresponds to fields that are used in the
640 * transmit path. If the cache line of the architecture is higher than 64B,
641 * this function does nothing as it is expected that the full mbuf is
645 * The pointer to the mbuf.
648 rte_mbuf_prefetch_part2(struct rte_mbuf *m)
650 #if RTE_CACHE_LINE_SIZE == 64
651 rte_prefetch0(&m->cacheline1);
658 static inline uint16_t rte_pktmbuf_priv_size(struct rte_mempool *mp);
661 * Return the IO address of the beginning of the mbuf data
664 * The pointer to the mbuf.
666 * The IO address of the beginning of the mbuf data
668 static inline rte_iova_t
669 rte_mbuf_data_iova(const struct rte_mbuf *mb)
671 return mb->buf_iova + mb->data_off;
675 static inline phys_addr_t
676 rte_mbuf_data_dma_addr(const struct rte_mbuf *mb)
678 return rte_mbuf_data_iova(mb);
682 * Return the default IO address of the beginning of the mbuf data
684 * This function is used by drivers in their receive function, as it
685 * returns the location where data should be written by the NIC, taking
686 * the default headroom in account.
689 * The pointer to the mbuf.
691 * The IO address of the beginning of the mbuf data
693 static inline rte_iova_t
694 rte_mbuf_data_iova_default(const struct rte_mbuf *mb)
696 return mb->buf_iova + RTE_PKTMBUF_HEADROOM;
700 static inline phys_addr_t
701 rte_mbuf_data_dma_addr_default(const struct rte_mbuf *mb)
703 return rte_mbuf_data_iova_default(mb);
707 * Return the mbuf owning the data buffer address of an indirect mbuf.
710 * The pointer to the indirect mbuf.
712 * The address of the direct mbuf corresponding to buffer_addr.
714 static inline struct rte_mbuf *
715 rte_mbuf_from_indirect(struct rte_mbuf *mi)
717 return (struct rte_mbuf *)RTE_PTR_SUB(mi->buf_addr, sizeof(*mi) + mi->priv_size);
721 * Return the buffer address embedded in the given mbuf.
724 * The pointer to the mbuf.
726 * The address of the data buffer owned by the mbuf.
729 rte_mbuf_to_baddr(struct rte_mbuf *md)
732 buffer_addr = (char *)md + sizeof(*md) + rte_pktmbuf_priv_size(md->pool);
737 * Return the starting address of the private data area embedded in
740 * Note that no check is made to ensure that a private data area
741 * actually exists in the supplied mbuf.
744 * The pointer to the mbuf.
746 * The starting address of the private data area of the given mbuf.
748 static inline void * __rte_experimental
749 rte_mbuf_to_priv(struct rte_mbuf *m)
751 return RTE_PTR_ADD(m, sizeof(struct rte_mbuf));
755 * Returns TRUE if given mbuf is cloned by mbuf indirection, or FALSE
758 * If a mbuf has its data in another mbuf and references it by mbuf
759 * indirection, this mbuf can be defined as a cloned mbuf.
761 #define RTE_MBUF_CLONED(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF)
765 * Use RTE_MBUF_CLONED().
767 #define RTE_MBUF_INDIRECT(mb) RTE_MBUF_CLONED(mb)
770 * Returns TRUE if given mbuf has an external buffer, or FALSE otherwise.
772 * External buffer is a user-provided anonymous buffer.
774 #define RTE_MBUF_HAS_EXTBUF(mb) ((mb)->ol_flags & EXT_ATTACHED_MBUF)
777 * Returns TRUE if given mbuf is direct, or FALSE otherwise.
779 * If a mbuf embeds its own data after the rte_mbuf structure, this mbuf
780 * can be defined as a direct mbuf.
782 #define RTE_MBUF_DIRECT(mb) \
783 (!((mb)->ol_flags & (IND_ATTACHED_MBUF | EXT_ATTACHED_MBUF)))
786 * Private data in case of pktmbuf pool.
788 * A structure that contains some pktmbuf_pool-specific data that are
789 * appended after the mempool structure (in private data).
791 struct rte_pktmbuf_pool_private {
792 uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf. */
793 uint16_t mbuf_priv_size; /**< Size of private area in each mbuf. */
796 #ifdef RTE_LIBRTE_MBUF_DEBUG
798 /** check mbuf type in debug mode */
799 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
801 #else /* RTE_LIBRTE_MBUF_DEBUG */
803 /** check mbuf type in debug mode */
804 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
806 #endif /* RTE_LIBRTE_MBUF_DEBUG */
808 #ifdef RTE_MBUF_REFCNT_ATOMIC
811 * Reads the value of an mbuf's refcnt.
815 * Reference count number.
817 static inline uint16_t
818 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
820 return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
824 * Sets an mbuf's refcnt to a defined value.
831 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
833 rte_atomic16_set(&m->refcnt_atomic, (int16_t)new_value);
837 static inline uint16_t
838 __rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
840 return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
844 * Adds given value to an mbuf's refcnt and returns its new value.
848 * Value to add/subtract
852 static inline uint16_t
853 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
856 * The atomic_add is an expensive operation, so we don't want to
857 * call it in the case where we know we are the uniq holder of
858 * this mbuf (i.e. ref_cnt == 1). Otherwise, an atomic
859 * operation has to be used because concurrent accesses on the
860 * reference counter can occur.
862 if (likely(rte_mbuf_refcnt_read(m) == 1)) {
864 rte_mbuf_refcnt_set(m, (uint16_t)value);
865 return (uint16_t)value;
868 return __rte_mbuf_refcnt_update(m, value);
871 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
874 static inline uint16_t
875 __rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
877 m->refcnt = (uint16_t)(m->refcnt + value);
882 * Adds given value to an mbuf's refcnt and returns its new value.
884 static inline uint16_t
885 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
887 return __rte_mbuf_refcnt_update(m, value);
891 * Reads the value of an mbuf's refcnt.
893 static inline uint16_t
894 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
900 * Sets an mbuf's refcnt to the defined value.
903 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
905 m->refcnt = new_value;
908 #endif /* RTE_MBUF_REFCNT_ATOMIC */
911 * Reads the refcnt of an external buffer.
914 * Shared data of the external buffer.
916 * Reference count number.
918 static inline uint16_t
919 rte_mbuf_ext_refcnt_read(const struct rte_mbuf_ext_shared_info *shinfo)
921 return (uint16_t)(rte_atomic16_read(&shinfo->refcnt_atomic));
925 * Set refcnt of an external buffer.
928 * Shared data of the external buffer.
933 rte_mbuf_ext_refcnt_set(struct rte_mbuf_ext_shared_info *shinfo,
936 rte_atomic16_set(&shinfo->refcnt_atomic, (int16_t)new_value);
940 * Add given value to refcnt of an external buffer and return its new
944 * Shared data of the external buffer.
946 * Value to add/subtract
950 static inline uint16_t
951 rte_mbuf_ext_refcnt_update(struct rte_mbuf_ext_shared_info *shinfo,
954 if (likely(rte_mbuf_ext_refcnt_read(shinfo) == 1)) {
956 rte_mbuf_ext_refcnt_set(shinfo, (uint16_t)value);
957 return (uint16_t)value;
960 return (uint16_t)rte_atomic16_add_return(&shinfo->refcnt_atomic, value);
964 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { \
971 * Sanity checks on an mbuf.
973 * Check the consistency of the given mbuf. The function will cause a
974 * panic if corruption is detected.
977 * The mbuf to be checked.
979 * True if the mbuf is a packet header, false if it is a sub-segment
980 * of a packet (in this case, some fields like nb_segs are not checked)
983 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
985 #define MBUF_RAW_ALLOC_CHECK(m) do { \
986 RTE_ASSERT(rte_mbuf_refcnt_read(m) == 1); \
987 RTE_ASSERT((m)->next == NULL); \
988 RTE_ASSERT((m)->nb_segs == 1); \
989 __rte_mbuf_sanity_check(m, 0); \
993 * Allocate an uninitialized mbuf from mempool *mp*.
995 * This function can be used by PMDs (especially in RX functions) to
996 * allocate an uninitialized mbuf. The driver is responsible of
997 * initializing all the required fields. See rte_pktmbuf_reset().
998 * For standard needs, prefer rte_pktmbuf_alloc().
1000 * The caller can expect that the following fields of the mbuf structure
1001 * are initialized: buf_addr, buf_iova, buf_len, refcnt=1, nb_segs=1,
1002 * next=NULL, pool, priv_size. The other fields must be initialized
1006 * The mempool from which mbuf is allocated.
1008 * - The pointer to the new mbuf on success.
1009 * - NULL if allocation failed.
1011 static inline struct rte_mbuf *rte_mbuf_raw_alloc(struct rte_mempool *mp)
1015 if (rte_mempool_get(mp, (void **)&m) < 0)
1017 MBUF_RAW_ALLOC_CHECK(m);
1022 * Put mbuf back into its original mempool.
1024 * The caller must ensure that the mbuf is direct and properly
1025 * reinitialized (refcnt=1, next=NULL, nb_segs=1), as done by
1026 * rte_pktmbuf_prefree_seg().
1028 * This function should be used with care, when optimization is
1029 * required. For standard needs, prefer rte_pktmbuf_free() or
1030 * rte_pktmbuf_free_seg().
1033 * The mbuf to be freed.
1035 static __rte_always_inline void
1036 rte_mbuf_raw_free(struct rte_mbuf *m)
1038 RTE_ASSERT(RTE_MBUF_DIRECT(m));
1039 RTE_ASSERT(rte_mbuf_refcnt_read(m) == 1);
1040 RTE_ASSERT(m->next == NULL);
1041 RTE_ASSERT(m->nb_segs == 1);
1042 __rte_mbuf_sanity_check(m, 0);
1043 rte_mempool_put(m->pool, m);
1047 * The packet mbuf constructor.
1049 * This function initializes some fields in the mbuf structure that are
1050 * not modified by the user once created (origin pool, buffer start
1051 * address, and so on). This function is given as a callback function to
1052 * rte_mempool_obj_iter() or rte_mempool_create() at pool creation time.
1055 * The mempool from which mbufs originate.
1057 * A pointer that can be used by the user to retrieve useful information
1058 * for mbuf initialization. This pointer is the opaque argument passed to
1059 * rte_mempool_obj_iter() or rte_mempool_create().
1061 * The mbuf to initialize.
1063 * The index of the mbuf in the pool table.
1065 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
1066 void *m, unsigned i);
1070 * A packet mbuf pool constructor.
1072 * This function initializes the mempool private data in the case of a
1073 * pktmbuf pool. This private data is needed by the driver. The
1074 * function must be called on the mempool before it is used, or it
1075 * can be given as a callback function to rte_mempool_create() at
1076 * pool creation. It can be extended by the user, for example, to
1077 * provide another packet size.
1080 * The mempool from which mbufs originate.
1082 * A pointer that can be used by the user to retrieve useful information
1083 * for mbuf initialization. This pointer is the opaque argument passed to
1084 * rte_mempool_create().
1086 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
1089 * Create a mbuf pool.
1091 * This function creates and initializes a packet mbuf pool. It is
1092 * a wrapper to rte_mempool functions.
1095 * The name of the mbuf pool.
1097 * The number of elements in the mbuf pool. The optimum size (in terms
1098 * of memory usage) for a mempool is when n is a power of two minus one:
1101 * Size of the per-core object cache. See rte_mempool_create() for
1104 * Size of application private are between the rte_mbuf structure
1105 * and the data buffer. This value must be aligned to RTE_MBUF_PRIV_ALIGN.
1106 * @param data_room_size
1107 * Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
1109 * The socket identifier where the memory should be allocated. The
1110 * value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
1113 * The pointer to the new allocated mempool, on success. NULL on error
1114 * with rte_errno set appropriately. Possible rte_errno values include:
1115 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
1116 * - E_RTE_SECONDARY - function was called from a secondary process instance
1117 * - EINVAL - cache size provided is too large, or priv_size is not aligned.
1118 * - ENOSPC - the maximum number of memzones has already been allocated
1119 * - EEXIST - a memzone with the same name already exists
1120 * - ENOMEM - no appropriate memory area found in which to create memzone
1122 struct rte_mempool *
1123 rte_pktmbuf_pool_create(const char *name, unsigned n,
1124 unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
1128 * Create a mbuf pool with a given mempool ops name
1130 * This function creates and initializes a packet mbuf pool. It is
1131 * a wrapper to rte_mempool functions.
1134 * The name of the mbuf pool.
1136 * The number of elements in the mbuf pool. The optimum size (in terms
1137 * of memory usage) for a mempool is when n is a power of two minus one:
1140 * Size of the per-core object cache. See rte_mempool_create() for
1143 * Size of application private are between the rte_mbuf structure
1144 * and the data buffer. This value must be aligned to RTE_MBUF_PRIV_ALIGN.
1145 * @param data_room_size
1146 * Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
1148 * The socket identifier where the memory should be allocated. The
1149 * value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
1152 * The mempool ops name to be used for this mempool instead of
1153 * default mempool. The value can be *NULL* to use default mempool.
1155 * The pointer to the new allocated mempool, on success. NULL on error
1156 * with rte_errno set appropriately. Possible rte_errno values include:
1157 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
1158 * - E_RTE_SECONDARY - function was called from a secondary process instance
1159 * - EINVAL - cache size provided is too large, or priv_size is not aligned.
1160 * - ENOSPC - the maximum number of memzones has already been allocated
1161 * - EEXIST - a memzone with the same name already exists
1162 * - ENOMEM - no appropriate memory area found in which to create memzone
1164 struct rte_mempool *
1165 rte_pktmbuf_pool_create_by_ops(const char *name, unsigned int n,
1166 unsigned int cache_size, uint16_t priv_size, uint16_t data_room_size,
1167 int socket_id, const char *ops_name);
1170 * Get the data room size of mbufs stored in a pktmbuf_pool
1172 * The data room size is the amount of data that can be stored in a
1173 * mbuf including the headroom (RTE_PKTMBUF_HEADROOM).
1176 * The packet mbuf pool.
1178 * The data room size of mbufs stored in this mempool.
1180 static inline uint16_t
1181 rte_pktmbuf_data_room_size(struct rte_mempool *mp)
1183 struct rte_pktmbuf_pool_private *mbp_priv;
1185 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1186 return mbp_priv->mbuf_data_room_size;
1190 * Get the application private size of mbufs stored in a pktmbuf_pool
1192 * The private size of mbuf is a zone located between the rte_mbuf
1193 * structure and the data buffer where an application can store data
1194 * associated to a packet.
1197 * The packet mbuf pool.
1199 * The private size of mbufs stored in this mempool.
1201 static inline uint16_t
1202 rte_pktmbuf_priv_size(struct rte_mempool *mp)
1204 struct rte_pktmbuf_pool_private *mbp_priv;
1206 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1207 return mbp_priv->mbuf_priv_size;
1211 * Reset the data_off field of a packet mbuf to its default value.
1213 * The given mbuf must have only one segment, which should be empty.
1216 * The packet mbuf's data_off field has to be reset.
1218 static inline void rte_pktmbuf_reset_headroom(struct rte_mbuf *m)
1220 m->data_off = (uint16_t)RTE_MIN((uint16_t)RTE_PKTMBUF_HEADROOM,
1221 (uint16_t)m->buf_len);
1225 * Reset the fields of a packet mbuf to their default values.
1227 * The given mbuf must have only one segment.
1230 * The packet mbuf to be resetted.
1232 #define MBUF_INVALID_PORT UINT16_MAX
1234 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
1240 m->vlan_tci_outer = 0;
1242 m->port = MBUF_INVALID_PORT;
1246 rte_pktmbuf_reset_headroom(m);
1249 __rte_mbuf_sanity_check(m, 1);
1253 * Allocate a new mbuf from a mempool.
1255 * This new mbuf contains one segment, which has a length of 0. The pointer
1256 * to data is initialized to have some bytes of headroom in the buffer
1257 * (if buffer size allows).
1260 * The mempool from which the mbuf is allocated.
1262 * - The pointer to the new mbuf on success.
1263 * - NULL if allocation failed.
1265 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
1268 if ((m = rte_mbuf_raw_alloc(mp)) != NULL)
1269 rte_pktmbuf_reset(m);
1274 * Allocate a bulk of mbufs, initialize refcnt and reset the fields to default
1278 * The mempool from which mbufs are allocated.
1280 * Array of pointers to mbufs
1285 * - -ENOENT: Not enough entries in the mempool; no mbufs are retrieved.
1287 static inline int rte_pktmbuf_alloc_bulk(struct rte_mempool *pool,
1288 struct rte_mbuf **mbufs, unsigned count)
1293 rc = rte_mempool_get_bulk(pool, (void **)mbufs, count);
1297 /* To understand duff's device on loop unwinding optimization, see
1298 * https://en.wikipedia.org/wiki/Duff's_device.
1299 * Here while() loop is used rather than do() while{} to avoid extra
1300 * check if count is zero.
1302 switch (count % 4) {
1304 while (idx != count) {
1305 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1306 rte_pktmbuf_reset(mbufs[idx]);
1310 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1311 rte_pktmbuf_reset(mbufs[idx]);
1315 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1316 rte_pktmbuf_reset(mbufs[idx]);
1320 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1321 rte_pktmbuf_reset(mbufs[idx]);
1330 * Initialize shared data at the end of an external buffer before attaching
1331 * to a mbuf by ``rte_pktmbuf_attach_extbuf()``. This is not a mandatory
1332 * initialization but a helper function to simply spare a few bytes at the
1333 * end of the buffer for shared data. If shared data is allocated
1334 * separately, this should not be called but application has to properly
1335 * initialize the shared data according to its need.
1337 * Free callback and its argument is saved and the refcnt is set to 1.
1340 * The value of buf_len will be reduced to RTE_PTR_DIFF(shinfo, buf_addr)
1341 * after this initialization. This shall be used for
1342 * ``rte_pktmbuf_attach_extbuf()``
1345 * The pointer to the external buffer.
1346 * @param [in,out] buf_len
1347 * The pointer to length of the external buffer. Input value must be
1348 * larger than the size of ``struct rte_mbuf_ext_shared_info`` and
1349 * padding for alignment. If not enough, this function will return NULL.
1350 * Adjusted buffer length will be returned through this pointer.
1352 * Free callback function to call when the external buffer needs to be
1355 * Argument for the free callback function.
1358 * A pointer to the initialized shared data on success, return NULL
1361 static inline struct rte_mbuf_ext_shared_info *
1362 rte_pktmbuf_ext_shinfo_init_helper(void *buf_addr, uint16_t *buf_len,
1363 rte_mbuf_extbuf_free_callback_t free_cb, void *fcb_opaque)
1365 struct rte_mbuf_ext_shared_info *shinfo;
1366 void *buf_end = RTE_PTR_ADD(buf_addr, *buf_len);
1369 addr = RTE_PTR_ALIGN_FLOOR(RTE_PTR_SUB(buf_end, sizeof(*shinfo)),
1371 if (addr <= buf_addr)
1374 shinfo = (struct rte_mbuf_ext_shared_info *)addr;
1375 shinfo->free_cb = free_cb;
1376 shinfo->fcb_opaque = fcb_opaque;
1377 rte_mbuf_ext_refcnt_set(shinfo, 1);
1379 *buf_len = (uint16_t)RTE_PTR_DIFF(shinfo, buf_addr);
1384 * Attach an external buffer to a mbuf.
1386 * User-managed anonymous buffer can be attached to an mbuf. When attaching
1387 * it, corresponding free callback function and its argument should be
1388 * provided via shinfo. This callback function will be called once all the
1389 * mbufs are detached from the buffer (refcnt becomes zero).
1391 * The headroom for the attaching mbuf will be set to zero and this can be
1392 * properly adjusted after attachment. For example, ``rte_pktmbuf_adj()``
1393 * or ``rte_pktmbuf_reset_headroom()`` might be used.
1395 * More mbufs can be attached to the same external buffer by
1396 * ``rte_pktmbuf_attach()`` once the external buffer has been attached by
1399 * Detachment can be done by either ``rte_pktmbuf_detach_extbuf()`` or
1400 * ``rte_pktmbuf_detach()``.
1402 * Memory for shared data must be provided and user must initialize all of
1403 * the content properly, escpecially free callback and refcnt. The pointer
1404 * of shared data will be stored in m->shinfo.
1405 * ``rte_pktmbuf_ext_shinfo_init_helper`` can help to simply spare a few
1406 * bytes at the end of buffer for the shared data, store free callback and
1407 * its argument and set the refcnt to 1. The following is an example:
1409 * struct rte_mbuf_ext_shared_info *shinfo =
1410 * rte_pktmbuf_ext_shinfo_init_helper(buf_addr, &buf_len,
1411 * free_cb, fcb_arg);
1412 * rte_pktmbuf_attach_extbuf(m, buf_addr, buf_iova, buf_len, shinfo);
1413 * rte_pktmbuf_reset_headroom(m);
1414 * rte_pktmbuf_adj(m, data_len);
1416 * Attaching an external buffer is quite similar to mbuf indirection in
1417 * replacing buffer addresses and length of a mbuf, but a few differences:
1418 * - When an indirect mbuf is attached, refcnt of the direct mbuf would be
1419 * 2 as long as the direct mbuf itself isn't freed after the attachment.
1420 * In such cases, the buffer area of a direct mbuf must be read-only. But
1421 * external buffer has its own refcnt and it starts from 1. Unless
1422 * multiple mbufs are attached to a mbuf having an external buffer, the
1423 * external buffer is writable.
1424 * - There's no need to allocate buffer from a mempool. Any buffer can be
1425 * attached with appropriate free callback and its IO address.
1426 * - Smaller metadata is required to maintain shared data such as refcnt.
1429 * @b EXPERIMENTAL: This API may change without prior notice.
1430 * Once external buffer is enabled by allowing experimental API,
1431 * ``RTE_MBUF_DIRECT()`` and ``RTE_MBUF_INDIRECT()`` are no longer
1432 * exclusive. A mbuf can be considered direct if it is neither indirect nor
1433 * having external buffer.
1436 * The pointer to the mbuf.
1438 * The pointer to the external buffer.
1440 * IO address of the external buffer.
1442 * The size of the external buffer.
1444 * User-provided memory for shared data of the external buffer.
1446 static inline void __rte_experimental
1447 rte_pktmbuf_attach_extbuf(struct rte_mbuf *m, void *buf_addr,
1448 rte_iova_t buf_iova, uint16_t buf_len,
1449 struct rte_mbuf_ext_shared_info *shinfo)
1451 /* mbuf should not be read-only */
1452 RTE_ASSERT(RTE_MBUF_DIRECT(m) && rte_mbuf_refcnt_read(m) == 1);
1453 RTE_ASSERT(shinfo->free_cb != NULL);
1455 m->buf_addr = buf_addr;
1456 m->buf_iova = buf_iova;
1457 m->buf_len = buf_len;
1462 m->ol_flags |= EXT_ATTACHED_MBUF;
1467 * Detach the external buffer attached to a mbuf, same as
1468 * ``rte_pktmbuf_detach()``
1471 * The mbuf having external buffer.
1473 #define rte_pktmbuf_detach_extbuf(m) rte_pktmbuf_detach(m)
1476 * Attach packet mbuf to another packet mbuf.
1478 * If the mbuf we are attaching to isn't a direct buffer and is attached to
1479 * an external buffer, the mbuf being attached will be attached to the
1480 * external buffer instead of mbuf indirection.
1482 * Otherwise, the mbuf will be indirectly attached. After attachment we
1483 * refer the mbuf we attached as 'indirect', while mbuf we attached to as
1484 * 'direct'. The direct mbuf's reference counter is incremented.
1486 * Right now, not supported:
1487 * - attachment for already indirect mbuf (e.g. - mi has to be direct).
1488 * - mbuf we trying to attach (mi) is used by someone else
1489 * e.g. it's reference counter is greater then 1.
1492 * The indirect packet mbuf.
1494 * The packet mbuf we're attaching to.
1496 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *m)
1498 RTE_ASSERT(RTE_MBUF_DIRECT(mi) &&
1499 rte_mbuf_refcnt_read(mi) == 1);
1501 if (RTE_MBUF_HAS_EXTBUF(m)) {
1502 rte_mbuf_ext_refcnt_update(m->shinfo, 1);
1503 mi->ol_flags = m->ol_flags;
1504 mi->shinfo = m->shinfo;
1506 /* if m is not direct, get the mbuf that embeds the data */
1507 rte_mbuf_refcnt_update(rte_mbuf_from_indirect(m), 1);
1508 mi->priv_size = m->priv_size;
1509 mi->ol_flags = m->ol_flags | IND_ATTACHED_MBUF;
1512 mi->buf_iova = m->buf_iova;
1513 mi->buf_addr = m->buf_addr;
1514 mi->buf_len = m->buf_len;
1516 mi->data_off = m->data_off;
1517 mi->data_len = m->data_len;
1519 mi->vlan_tci = m->vlan_tci;
1520 mi->vlan_tci_outer = m->vlan_tci_outer;
1521 mi->tx_offload = m->tx_offload;
1525 mi->pkt_len = mi->data_len;
1527 mi->packet_type = m->packet_type;
1528 mi->timestamp = m->timestamp;
1530 __rte_mbuf_sanity_check(mi, 1);
1531 __rte_mbuf_sanity_check(m, 0);
1535 * @internal used by rte_pktmbuf_detach().
1537 * Decrement the reference counter of the external buffer. When the
1538 * reference counter becomes 0, the buffer is freed by pre-registered
1542 __rte_pktmbuf_free_extbuf(struct rte_mbuf *m)
1544 RTE_ASSERT(RTE_MBUF_HAS_EXTBUF(m));
1545 RTE_ASSERT(m->shinfo != NULL);
1547 if (rte_mbuf_ext_refcnt_update(m->shinfo, -1) == 0)
1548 m->shinfo->free_cb(m->buf_addr, m->shinfo->fcb_opaque);
1552 * @internal used by rte_pktmbuf_detach().
1554 * Decrement the direct mbuf's reference counter. When the reference
1555 * counter becomes 0, the direct mbuf is freed.
1558 __rte_pktmbuf_free_direct(struct rte_mbuf *m)
1560 struct rte_mbuf *md;
1562 RTE_ASSERT(RTE_MBUF_INDIRECT(m));
1564 md = rte_mbuf_from_indirect(m);
1566 if (rte_mbuf_refcnt_update(md, -1) == 0) {
1569 rte_mbuf_refcnt_set(md, 1);
1570 rte_mbuf_raw_free(md);
1575 * Detach a packet mbuf from external buffer or direct buffer.
1577 * - decrement refcnt and free the external/direct buffer if refcnt
1579 * - restore original mbuf address and length values.
1580 * - reset pktmbuf data and data_len to their default values.
1582 * All other fields of the given packet mbuf will be left intact.
1585 * The indirect attached packet mbuf.
1587 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
1589 struct rte_mempool *mp = m->pool;
1590 uint32_t mbuf_size, buf_len;
1593 if (RTE_MBUF_HAS_EXTBUF(m))
1594 __rte_pktmbuf_free_extbuf(m);
1596 __rte_pktmbuf_free_direct(m);
1598 priv_size = rte_pktmbuf_priv_size(mp);
1599 mbuf_size = (uint32_t)(sizeof(struct rte_mbuf) + priv_size);
1600 buf_len = rte_pktmbuf_data_room_size(mp);
1602 m->priv_size = priv_size;
1603 m->buf_addr = (char *)m + mbuf_size;
1604 m->buf_iova = rte_mempool_virt2iova(m) + mbuf_size;
1605 m->buf_len = (uint16_t)buf_len;
1606 rte_pktmbuf_reset_headroom(m);
1612 * Decrease reference counter and unlink a mbuf segment
1614 * This function does the same than a free, except that it does not
1615 * return the segment to its pool.
1616 * It decreases the reference counter, and if it reaches 0, it is
1617 * detached from its parent for an indirect mbuf.
1620 * The mbuf to be unlinked
1622 * - (m) if it is the last reference. It can be recycled or freed.
1623 * - (NULL) if the mbuf still has remaining references on it.
1625 static __rte_always_inline struct rte_mbuf *
1626 rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
1628 __rte_mbuf_sanity_check(m, 0);
1630 if (likely(rte_mbuf_refcnt_read(m) == 1)) {
1632 if (!RTE_MBUF_DIRECT(m))
1633 rte_pktmbuf_detach(m);
1635 if (m->next != NULL) {
1642 } else if (__rte_mbuf_refcnt_update(m, -1) == 0) {
1644 if (!RTE_MBUF_DIRECT(m))
1645 rte_pktmbuf_detach(m);
1647 if (m->next != NULL) {
1651 rte_mbuf_refcnt_set(m, 1);
1659 * Free a segment of a packet mbuf into its original mempool.
1661 * Free an mbuf, without parsing other segments in case of chained
1665 * The packet mbuf segment to be freed.
1667 static __rte_always_inline void
1668 rte_pktmbuf_free_seg(struct rte_mbuf *m)
1670 m = rte_pktmbuf_prefree_seg(m);
1671 if (likely(m != NULL))
1672 rte_mbuf_raw_free(m);
1676 * Free a packet mbuf back into its original mempool.
1678 * Free an mbuf, and all its segments in case of chained buffers. Each
1679 * segment is added back into its original mempool.
1682 * The packet mbuf to be freed. If NULL, the function does nothing.
1684 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
1686 struct rte_mbuf *m_next;
1689 __rte_mbuf_sanity_check(m, 1);
1693 rte_pktmbuf_free_seg(m);
1699 * Creates a "clone" of the given packet mbuf.
1701 * Walks through all segments of the given packet mbuf, and for each of them:
1702 * - Creates a new packet mbuf from the given pool.
1703 * - Attaches newly created mbuf to the segment.
1704 * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
1705 * from the original packet mbuf.
1708 * The packet mbuf to be cloned.
1710 * The mempool from which the "clone" mbufs are allocated.
1712 * - The pointer to the new "clone" mbuf on success.
1713 * - NULL if allocation fails.
1715 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
1716 struct rte_mempool *mp)
1718 struct rte_mbuf *mc, *mi, **prev;
1722 if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
1727 pktlen = md->pkt_len;
1732 rte_pktmbuf_attach(mi, md);
1735 } while ((md = md->next) != NULL &&
1736 (mi = rte_pktmbuf_alloc(mp)) != NULL);
1740 mc->pkt_len = pktlen;
1742 /* Allocation of new indirect segment failed */
1743 if (unlikely (mi == NULL)) {
1744 rte_pktmbuf_free(mc);
1748 __rte_mbuf_sanity_check(mc, 1);
1753 * Adds given value to the refcnt of all packet mbuf segments.
1755 * Walks through all segments of given packet mbuf and for each of them
1756 * invokes rte_mbuf_refcnt_update().
1759 * The packet mbuf whose refcnt to be updated.
1761 * The value to add to the mbuf's segments refcnt.
1763 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
1765 __rte_mbuf_sanity_check(m, 1);
1768 rte_mbuf_refcnt_update(m, v);
1769 } while ((m = m->next) != NULL);
1773 * Get the headroom in a packet mbuf.
1778 * The length of the headroom.
1780 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
1782 __rte_mbuf_sanity_check(m, 0);
1787 * Get the tailroom of a packet mbuf.
1792 * The length of the tailroom.
1794 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
1796 __rte_mbuf_sanity_check(m, 0);
1797 return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
1802 * Get the last segment of the packet.
1807 * The last segment of the given mbuf.
1809 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
1811 __rte_mbuf_sanity_check(m, 1);
1812 while (m->next != NULL)
1818 * A macro that points to an offset into the data in the mbuf.
1820 * The returned pointer is cast to type t. Before using this
1821 * function, the user must ensure that the first segment is large
1822 * enough to accommodate its data.
1827 * The offset into the mbuf data.
1829 * The type to cast the result into.
1831 #define rte_pktmbuf_mtod_offset(m, t, o) \
1832 ((t)((char *)(m)->buf_addr + (m)->data_off + (o)))
1835 * A macro that points to the start of the data in the mbuf.
1837 * The returned pointer is cast to type t. Before using this
1838 * function, the user must ensure that the first segment is large
1839 * enough to accommodate its data.
1844 * The type to cast the result into.
1846 #define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0)
1849 * A macro that returns the IO address that points to an offset of the
1850 * start of the data in the mbuf
1855 * The offset into the data to calculate address from.
1857 #define rte_pktmbuf_iova_offset(m, o) \
1858 (rte_iova_t)((m)->buf_iova + (m)->data_off + (o))
1861 #define rte_pktmbuf_mtophys_offset(m, o) \
1862 rte_pktmbuf_iova_offset(m, o)
1865 * A macro that returns the IO address that points to the start of the
1871 #define rte_pktmbuf_iova(m) rte_pktmbuf_iova_offset(m, 0)
1874 #define rte_pktmbuf_mtophys(m) rte_pktmbuf_iova(m)
1877 * A macro that returns the length of the packet.
1879 * The value can be read or assigned.
1884 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
1887 * A macro that returns the length of the segment.
1889 * The value can be read or assigned.
1894 #define rte_pktmbuf_data_len(m) ((m)->data_len)
1897 * Prepend len bytes to an mbuf data area.
1899 * Returns a pointer to the new
1900 * data start address. If there is not enough headroom in the first
1901 * segment, the function will return NULL, without modifying the mbuf.
1906 * The amount of data to prepend (in bytes).
1908 * A pointer to the start of the newly prepended data, or
1909 * NULL if there is not enough headroom space in the first segment
1911 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
1914 __rte_mbuf_sanity_check(m, 1);
1916 if (unlikely(len > rte_pktmbuf_headroom(m)))
1919 /* NB: elaborating the subtraction like this instead of using
1920 * -= allows us to ensure the result type is uint16_t
1921 * avoiding compiler warnings on gcc 8.1 at least */
1922 m->data_off = (uint16_t)(m->data_off - len);
1923 m->data_len = (uint16_t)(m->data_len + len);
1924 m->pkt_len = (m->pkt_len + len);
1926 return (char *)m->buf_addr + m->data_off;
1930 * Append len bytes to an mbuf.
1932 * Append len bytes to an mbuf and return a pointer to the start address
1933 * of the added data. If there is not enough tailroom in the last
1934 * segment, the function will return NULL, without modifying the mbuf.
1939 * The amount of data to append (in bytes).
1941 * A pointer to the start of the newly appended data, or
1942 * NULL if there is not enough tailroom space in the last segment
1944 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
1947 struct rte_mbuf *m_last;
1949 __rte_mbuf_sanity_check(m, 1);
1951 m_last = rte_pktmbuf_lastseg(m);
1952 if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
1955 tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
1956 m_last->data_len = (uint16_t)(m_last->data_len + len);
1957 m->pkt_len = (m->pkt_len + len);
1958 return (char*) tail;
1962 * Remove len bytes at the beginning of an mbuf.
1964 * Returns a pointer to the start address of the new data area. If the
1965 * length is greater than the length of the first segment, then the
1966 * function will fail and return NULL, without modifying the mbuf.
1971 * The amount of data to remove (in bytes).
1973 * A pointer to the new start of the data.
1975 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
1977 __rte_mbuf_sanity_check(m, 1);
1979 if (unlikely(len > m->data_len))
1982 /* NB: elaborating the addition 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_len = (uint16_t)(m->data_len - len);
1986 m->data_off = (uint16_t)(m->data_off + len);
1987 m->pkt_len = (m->pkt_len - len);
1988 return (char *)m->buf_addr + m->data_off;
1992 * Remove len bytes of data at the end of the mbuf.
1994 * If the length is greater than the length of the last segment, the
1995 * function will fail and return -1 without modifying the mbuf.
2000 * The amount of data to remove (in bytes).
2005 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
2007 struct rte_mbuf *m_last;
2009 __rte_mbuf_sanity_check(m, 1);
2011 m_last = rte_pktmbuf_lastseg(m);
2012 if (unlikely(len > m_last->data_len))
2015 m_last->data_len = (uint16_t)(m_last->data_len - len);
2016 m->pkt_len = (m->pkt_len - len);
2021 * Test if mbuf data is contiguous.
2026 * - 1, if all data is contiguous (one segment).
2027 * - 0, if there is several segments.
2029 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
2031 __rte_mbuf_sanity_check(m, 1);
2032 return !!(m->nb_segs == 1);
2036 * @internal used by rte_pktmbuf_read().
2038 const void *__rte_pktmbuf_read(const struct rte_mbuf *m, uint32_t off,
2039 uint32_t len, void *buf);
2042 * Read len data bytes in a mbuf at specified offset.
2044 * If the data is contiguous, return the pointer in the mbuf data, else
2045 * copy the data in the buffer provided by the user and return its
2049 * The pointer to the mbuf.
2051 * The offset of the data in the mbuf.
2053 * The amount of bytes to read.
2055 * The buffer where data is copied if it is not contiguous in mbuf
2056 * data. Its length should be at least equal to the len parameter.
2058 * The pointer to the data, either in the mbuf if it is contiguous,
2059 * or in the user buffer. If mbuf is too small, NULL is returned.
2061 static inline const void *rte_pktmbuf_read(const struct rte_mbuf *m,
2062 uint32_t off, uint32_t len, void *buf)
2064 if (likely(off + len <= rte_pktmbuf_data_len(m)))
2065 return rte_pktmbuf_mtod_offset(m, char *, off);
2067 return __rte_pktmbuf_read(m, off, len, buf);
2071 * Chain an mbuf to another, thereby creating a segmented packet.
2073 * Note: The implementation will do a linear walk over the segments to find
2074 * the tail entry. For cases when there are many segments, it's better to
2075 * chain the entries manually.
2078 * The head of the mbuf chain (the first packet)
2080 * The mbuf to put last in the chain
2084 * - -EOVERFLOW, if the chain segment limit exceeded
2086 static inline int rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail)
2088 struct rte_mbuf *cur_tail;
2090 /* Check for number-of-segments-overflow */
2091 if (head->nb_segs + tail->nb_segs > RTE_MBUF_MAX_NB_SEGS)
2094 /* Chain 'tail' onto the old tail */
2095 cur_tail = rte_pktmbuf_lastseg(head);
2096 cur_tail->next = tail;
2098 /* accumulate number of segments and total length.
2099 * NB: elaborating the addition like this instead of using
2100 * -= allows us to ensure the result type is uint16_t
2101 * avoiding compiler warnings on gcc 8.1 at least */
2102 head->nb_segs = (uint16_t)(head->nb_segs + tail->nb_segs);
2103 head->pkt_len += tail->pkt_len;
2105 /* pkt_len is only set in the head */
2106 tail->pkt_len = tail->data_len;
2112 * Validate general requirements for Tx offload in mbuf.
2114 * This function checks correctness and completeness of Tx offload settings.
2117 * The packet mbuf to be validated.
2119 * 0 if packet is valid
2122 rte_validate_tx_offload(const struct rte_mbuf *m)
2124 uint64_t ol_flags = m->ol_flags;
2125 uint64_t inner_l3_offset = m->l2_len;
2127 /* Does packet set any of available offloads? */
2128 if (!(ol_flags & PKT_TX_OFFLOAD_MASK))
2131 if (ol_flags & PKT_TX_OUTER_IP_CKSUM)
2132 /* NB: elaborating the addition like this instead of using
2133 * += gives the result uint64_t type instead of int,
2134 * avoiding compiler warnings on gcc 8.1 at least */
2135 inner_l3_offset = inner_l3_offset + m->outer_l2_len +
2138 /* Headers are fragmented */
2139 if (rte_pktmbuf_data_len(m) < inner_l3_offset + m->l3_len + m->l4_len)
2142 /* IP checksum can be counted only for IPv4 packet */
2143 if ((ol_flags & PKT_TX_IP_CKSUM) && (ol_flags & PKT_TX_IPV6))
2146 /* IP type not set when required */
2147 if (ol_flags & (PKT_TX_L4_MASK | PKT_TX_TCP_SEG))
2148 if (!(ol_flags & (PKT_TX_IPV4 | PKT_TX_IPV6)))
2151 /* Check requirements for TSO packet */
2152 if (ol_flags & PKT_TX_TCP_SEG)
2153 if ((m->tso_segsz == 0) ||
2154 ((ol_flags & PKT_TX_IPV4) &&
2155 !(ol_flags & PKT_TX_IP_CKSUM)))
2158 /* PKT_TX_OUTER_IP_CKSUM set for non outer IPv4 packet. */
2159 if ((ol_flags & PKT_TX_OUTER_IP_CKSUM) &&
2160 !(ol_flags & PKT_TX_OUTER_IPV4))
2167 * Linearize data in mbuf.
2169 * This function moves the mbuf data in the first segment if there is enough
2170 * tailroom. The subsequent segments are unchained and freed.
2179 rte_pktmbuf_linearize(struct rte_mbuf *mbuf)
2181 size_t seg_len, copy_len;
2183 struct rte_mbuf *m_next;
2186 if (rte_pktmbuf_is_contiguous(mbuf))
2189 /* Extend first segment to the total packet length */
2190 copy_len = rte_pktmbuf_pkt_len(mbuf) - rte_pktmbuf_data_len(mbuf);
2192 if (unlikely(copy_len > rte_pktmbuf_tailroom(mbuf)))
2195 buffer = rte_pktmbuf_mtod_offset(mbuf, char *, mbuf->data_len);
2196 mbuf->data_len = (uint16_t)(mbuf->pkt_len);
2198 /* Append data from next segments to the first one */
2203 seg_len = rte_pktmbuf_data_len(m);
2204 rte_memcpy(buffer, rte_pktmbuf_mtod(m, char *), seg_len);
2207 rte_pktmbuf_free_seg(m);
2218 * Dump an mbuf structure to a file.
2220 * Dump all fields for the given packet mbuf and all its associated
2221 * segments (in the case of a chained buffer).
2224 * A pointer to a file for output
2228 * If dump_len != 0, also dump the "dump_len" first data bytes of
2231 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
2237 #endif /* _RTE_MBUF_H_ */