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)
217 * Generic IP encapsulated tunnel type, used for TSO and checksum offload.
218 * It can be used for tunnels which are not standards or listed above.
219 * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_GRE
220 * or PKT_TX_TUNNEL_IPIP if possible.
221 * The ethdev must be configured with DEV_TX_OFFLOAD_IP_TNL_TSO.
222 * Outer and inner checksums are done according to the existing flags like
224 * Specific tunnel headers that contain payload length, sequence id
225 * or checksum are not expected to be updated.
227 #define PKT_TX_TUNNEL_IP (0xDULL << 45)
229 * Generic UDP encapsulated tunnel type, used for TSO and checksum offload.
230 * UDP tunnel type implies outer IP layer.
231 * It can be used for tunnels which are not standards or listed above.
232 * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_VXLAN
234 * The ethdev must be configured with DEV_TX_OFFLOAD_UDP_TNL_TSO.
235 * Outer and inner checksums are done according to the existing flags like
237 * Specific tunnel headers that contain payload length, sequence id
238 * or checksum are not expected to be updated.
240 #define PKT_TX_TUNNEL_UDP (0xEULL << 45)
241 /* add new TX TUNNEL type here */
242 #define PKT_TX_TUNNEL_MASK (0xFULL << 45)
245 * Second VLAN insertion (QinQ) flag.
247 #define PKT_TX_QINQ (1ULL << 49) /**< TX packet with double VLAN inserted. */
248 /* this old name is deprecated */
249 #define PKT_TX_QINQ_PKT PKT_TX_QINQ
252 * TCP segmentation offload. To enable this offload feature for a
253 * packet to be transmitted on hardware supporting TSO:
254 * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies
256 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
257 * - if it's IPv4, set the PKT_TX_IP_CKSUM flag
258 * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz
260 #define PKT_TX_TCP_SEG (1ULL << 50)
262 #define PKT_TX_IEEE1588_TMST (1ULL << 51) /**< TX IEEE1588 packet to timestamp. */
265 * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved,
266 * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware
267 * L4 checksum offload, the user needs to:
268 * - fill l2_len and l3_len in mbuf
269 * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM
270 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
272 #define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */
273 #define PKT_TX_TCP_CKSUM (1ULL << 52) /**< TCP cksum of TX pkt. computed by NIC. */
274 #define PKT_TX_SCTP_CKSUM (2ULL << 52) /**< SCTP cksum of TX pkt. computed by NIC. */
275 #define PKT_TX_UDP_CKSUM (3ULL << 52) /**< UDP cksum of TX pkt. computed by NIC. */
276 #define PKT_TX_L4_MASK (3ULL << 52) /**< Mask for L4 cksum offload request. */
279 * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should
280 * also be set by the application, although a PMD will only check
282 * - fill the mbuf offload information: l2_len, l3_len
284 #define PKT_TX_IP_CKSUM (1ULL << 54)
287 * Packet is IPv4. This flag must be set when using any offload feature
288 * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4
289 * packet. If the packet is a tunneled packet, this flag is related to
292 #define PKT_TX_IPV4 (1ULL << 55)
295 * Packet is IPv6. This flag must be set when using an offload feature
296 * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6
297 * packet. If the packet is a tunneled packet, this flag is related to
300 #define PKT_TX_IPV6 (1ULL << 56)
303 * TX packet is a 802.1q VLAN packet.
305 #define PKT_TX_VLAN (1ULL << 57)
306 /* this old name is deprecated */
307 #define PKT_TX_VLAN_PKT PKT_TX_VLAN
310 * Offload the IP checksum of an external header in the hardware. The
311 * flag PKT_TX_OUTER_IPV4 should also be set by the application, although
312 * a PMD will only check PKT_TX_OUTER_IP_CKSUM.
313 * - fill the mbuf offload information: outer_l2_len, outer_l3_len
315 #define PKT_TX_OUTER_IP_CKSUM (1ULL << 58)
318 * Packet outer header is IPv4. This flag must be set when using any
319 * outer offload feature (L3 or L4 checksum) to tell the NIC that the
320 * outer header of the tunneled packet is an IPv4 packet.
322 #define PKT_TX_OUTER_IPV4 (1ULL << 59)
325 * Packet outer header is IPv6. This flag must be set when using any
326 * outer offload feature (L4 checksum) to tell the NIC that the outer
327 * header of the tunneled packet is an IPv6 packet.
329 #define PKT_TX_OUTER_IPV6 (1ULL << 60)
332 * Bitmask of all supported packet Tx offload features flags,
333 * which can be set for packet.
335 #define PKT_TX_OFFLOAD_MASK ( \
338 PKT_TX_OUTER_IP_CKSUM | \
340 PKT_TX_IEEE1588_TMST | \
343 PKT_TX_TUNNEL_MASK | \
347 #define __RESERVED (1ULL << 61) /**< reserved for future mbuf use */
349 #define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */
351 /** Alignment constraint of mbuf private area. */
352 #define RTE_MBUF_PRIV_ALIGN 8
355 * Get the name of a RX offload flag
358 * The mask describing the flag.
360 * The name of this flag, or NULL if it's not a valid RX flag.
362 const char *rte_get_rx_ol_flag_name(uint64_t mask);
365 * Dump the list of RX offload flags in a buffer
368 * The mask describing the RX flags.
372 * The length of the buffer.
374 * 0 on success, (-1) on error.
376 int rte_get_rx_ol_flag_list(uint64_t mask, char *buf, size_t buflen);
379 * Get the name of a TX offload flag
382 * The mask describing the flag. Usually only one bit must be set.
383 * Several bits can be given if they belong to the same mask.
384 * Ex: PKT_TX_L4_MASK.
386 * The name of this flag, or NULL if it's not a valid TX flag.
388 const char *rte_get_tx_ol_flag_name(uint64_t mask);
391 * Dump the list of TX offload flags in a buffer
394 * The mask describing the TX flags.
398 * The length of the buffer.
400 * 0 on success, (-1) on error.
402 int rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen);
405 * Some NICs need at least 2KB buffer to RX standard Ethernet frame without
406 * splitting it into multiple segments.
407 * So, for mbufs that planned to be involved into RX/TX, the recommended
408 * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM.
410 #define RTE_MBUF_DEFAULT_DATAROOM 2048
411 #define RTE_MBUF_DEFAULT_BUF_SIZE \
412 (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM)
414 /* define a set of marker types that can be used to refer to set points in the
417 typedef void *MARKER[0]; /**< generic marker for a point in a structure */
419 typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */
421 typedef uint64_t MARKER64[0]; /**< marker that allows us to overwrite 8 bytes
422 * with a single assignment */
425 * The generic rte_mbuf, containing a packet mbuf.
430 void *buf_addr; /**< Virtual address of segment buffer. */
432 * Physical address of segment buffer.
433 * Force alignment to 8-bytes, so as to ensure we have the exact
434 * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes
435 * working on vector drivers easier.
440 rte_iova_t buf_physaddr; /**< deprecated */
441 } __rte_aligned(sizeof(rte_iova_t));
443 /* next 8 bytes are initialised on RX descriptor rearm */
448 * Reference counter. Its size should at least equal to the size
449 * of port field (16 bits), to support zero-copy broadcast.
450 * It should only be accessed using the following functions:
451 * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
452 * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
453 * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
458 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
459 uint16_t refcnt; /**< Non-atomically accessed refcnt */
461 uint16_t nb_segs; /**< Number of segments. */
463 /** Input port (16 bits to support more than 256 virtual ports). */
466 uint64_t ol_flags; /**< Offload features. */
468 /* remaining bytes are set on RX when pulling packet from descriptor */
469 MARKER rx_descriptor_fields1;
472 * The packet type, which is the combination of outer/inner L2, L3, L4
473 * and tunnel types. The packet_type is about data really present in the
474 * mbuf. Example: if vlan stripping is enabled, a received vlan packet
475 * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the
476 * vlan is stripped from the data.
480 uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */
482 uint32_t l2_type:4; /**< (Outer) L2 type. */
483 uint32_t l3_type:4; /**< (Outer) L3 type. */
484 uint32_t l4_type:4; /**< (Outer) L4 type. */
485 uint32_t tun_type:4; /**< Tunnel type. */
488 uint8_t inner_esp_next_proto;
489 /**< ESP next protocol type, valid if
490 * RTE_PTYPE_TUNNEL_ESP tunnel type is set
495 uint8_t inner_l2_type:4;
496 /**< Inner L2 type. */
497 uint8_t inner_l3_type:4;
498 /**< Inner L3 type. */
501 uint32_t inner_l4_type:4; /**< Inner L4 type. */
505 uint32_t pkt_len; /**< Total pkt len: sum of all segments. */
506 uint16_t data_len; /**< Amount of data in segment buffer. */
507 /** VLAN TCI (CPU order), valid if PKT_RX_VLAN is set. */
511 uint32_t rss; /**< RSS hash result if RSS enabled */
520 /**< Second 4 flexible bytes */
523 /**< First 4 flexible bytes or FD ID, dependent on
524 PKT_RX_FDIR_* flag in ol_flags. */
525 } fdir; /**< Filter identifier if FDIR enabled */
529 } sched; /**< Hierarchical scheduler */
530 uint32_t usr; /**< User defined tags. See rte_distributor_process() */
531 } hash; /**< hash information */
533 /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ is set. */
534 uint16_t vlan_tci_outer;
536 uint16_t buf_len; /**< Length of segment buffer. */
538 /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference
539 * are not normalized but are always the same for a given port.
543 /* second cache line - fields only used in slow path or on TX */
544 MARKER cacheline1 __rte_cache_min_aligned;
548 void *userdata; /**< Can be used for external metadata */
549 uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */
552 struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
553 struct rte_mbuf *next; /**< Next segment of scattered packet. */
555 /* fields to support TX offloads */
558 uint64_t tx_offload; /**< combined for easy fetch */
562 /**< L2 (MAC) Header Length for non-tunneling pkt.
563 * Outer_L4_len + ... + Inner_L2_len for tunneling pkt.
565 uint64_t l3_len:9; /**< L3 (IP) Header Length. */
566 uint64_t l4_len:8; /**< L4 (TCP/UDP) Header Length. */
567 uint64_t tso_segsz:16; /**< TCP TSO segment size */
569 /* fields for TX offloading of tunnels */
570 uint64_t outer_l3_len:9; /**< Outer L3 (IP) Hdr Length. */
571 uint64_t outer_l2_len:7; /**< Outer L2 (MAC) Hdr Length. */
573 /* uint64_t unused:8; */
577 /** Size of the application private data. In case of an indirect
578 * mbuf, it stores the direct mbuf private data size. */
581 /** Timesync flags for use with IEEE1588. */
584 /** Sequence number. See also rte_reorder_insert(). */
587 } __rte_cache_aligned;
589 /**< Maximum number of nb_segs allowed. */
590 #define RTE_MBUF_MAX_NB_SEGS UINT16_MAX
593 * Prefetch the first part of the mbuf
595 * The first 64 bytes of the mbuf corresponds to fields that are used early
596 * in the receive path. If the cache line of the architecture is higher than
597 * 64B, the second part will also be prefetched.
600 * The pointer to the mbuf.
603 rte_mbuf_prefetch_part1(struct rte_mbuf *m)
605 rte_prefetch0(&m->cacheline0);
609 * Prefetch the second part of the mbuf
611 * The next 64 bytes of the mbuf corresponds to fields that are used in the
612 * transmit path. If the cache line of the architecture is higher than 64B,
613 * this function does nothing as it is expected that the full mbuf is
617 * The pointer to the mbuf.
620 rte_mbuf_prefetch_part2(struct rte_mbuf *m)
622 #if RTE_CACHE_LINE_SIZE == 64
623 rte_prefetch0(&m->cacheline1);
630 static inline uint16_t rte_pktmbuf_priv_size(struct rte_mempool *mp);
633 * Return the IO address of the beginning of the mbuf data
636 * The pointer to the mbuf.
638 * The IO address of the beginning of the mbuf data
640 static inline rte_iova_t
641 rte_mbuf_data_iova(const struct rte_mbuf *mb)
643 return mb->buf_iova + mb->data_off;
647 static inline phys_addr_t
648 rte_mbuf_data_dma_addr(const struct rte_mbuf *mb)
650 return rte_mbuf_data_iova(mb);
654 * Return the default IO address of the beginning of the mbuf data
656 * This function is used by drivers in their receive function, as it
657 * returns the location where data should be written by the NIC, taking
658 * the default headroom in account.
661 * The pointer to the mbuf.
663 * The IO address of the beginning of the mbuf data
665 static inline rte_iova_t
666 rte_mbuf_data_iova_default(const struct rte_mbuf *mb)
668 return mb->buf_iova + RTE_PKTMBUF_HEADROOM;
672 static inline phys_addr_t
673 rte_mbuf_data_dma_addr_default(const struct rte_mbuf *mb)
675 return rte_mbuf_data_iova_default(mb);
679 * Return the mbuf owning the data buffer address of an indirect mbuf.
682 * The pointer to the indirect mbuf.
684 * The address of the direct mbuf corresponding to buffer_addr.
686 static inline struct rte_mbuf *
687 rte_mbuf_from_indirect(struct rte_mbuf *mi)
689 return (struct rte_mbuf *)RTE_PTR_SUB(mi->buf_addr, sizeof(*mi) + mi->priv_size);
693 * Return the buffer address embedded in the given mbuf.
696 * The pointer to the mbuf.
698 * The address of the data buffer owned by the mbuf.
701 rte_mbuf_to_baddr(struct rte_mbuf *md)
704 buffer_addr = (char *)md + sizeof(*md) + rte_pktmbuf_priv_size(md->pool);
709 * Returns TRUE if given mbuf is indirect, or FALSE otherwise.
711 #define RTE_MBUF_INDIRECT(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF)
714 * Returns TRUE if given mbuf is direct, or FALSE otherwise.
716 #define RTE_MBUF_DIRECT(mb) (!RTE_MBUF_INDIRECT(mb))
719 * Private data in case of pktmbuf pool.
721 * A structure that contains some pktmbuf_pool-specific data that are
722 * appended after the mempool structure (in private data).
724 struct rte_pktmbuf_pool_private {
725 uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf. */
726 uint16_t mbuf_priv_size; /**< Size of private area in each mbuf. */
729 #ifdef RTE_LIBRTE_MBUF_DEBUG
731 /** check mbuf type in debug mode */
732 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
734 #else /* RTE_LIBRTE_MBUF_DEBUG */
736 /** check mbuf type in debug mode */
737 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
739 #endif /* RTE_LIBRTE_MBUF_DEBUG */
741 #ifdef RTE_MBUF_REFCNT_ATOMIC
744 * Reads the value of an mbuf's refcnt.
748 * Reference count number.
750 static inline uint16_t
751 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
753 return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
757 * Sets an mbuf's refcnt to a defined value.
764 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
766 rte_atomic16_set(&m->refcnt_atomic, new_value);
770 static inline uint16_t
771 __rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
773 return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
777 * Adds given value to an mbuf's refcnt and returns its new value.
781 * Value to add/subtract
785 static inline uint16_t
786 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
789 * The atomic_add is an expensive operation, so we don't want to
790 * call it in the case where we know we are the uniq holder of
791 * this mbuf (i.e. ref_cnt == 1). Otherwise, an atomic
792 * operation has to be used because concurrent accesses on the
793 * reference counter can occur.
795 if (likely(rte_mbuf_refcnt_read(m) == 1)) {
796 rte_mbuf_refcnt_set(m, 1 + value);
800 return __rte_mbuf_refcnt_update(m, value);
803 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
806 static inline uint16_t
807 __rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
809 m->refcnt = (uint16_t)(m->refcnt + value);
814 * Adds given value to an mbuf's refcnt and returns its new value.
816 static inline uint16_t
817 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
819 return __rte_mbuf_refcnt_update(m, value);
823 * Reads the value of an mbuf's refcnt.
825 static inline uint16_t
826 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
832 * Sets an mbuf's refcnt to the defined value.
835 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
837 m->refcnt = new_value;
840 #endif /* RTE_MBUF_REFCNT_ATOMIC */
843 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { \
850 * Sanity checks on an mbuf.
852 * Check the consistency of the given mbuf. The function will cause a
853 * panic if corruption is detected.
856 * The mbuf to be checked.
858 * True if the mbuf is a packet header, false if it is a sub-segment
859 * of a packet (in this case, some fields like nb_segs are not checked)
862 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
864 #define MBUF_RAW_ALLOC_CHECK(m) do { \
865 RTE_ASSERT(rte_mbuf_refcnt_read(m) == 1); \
866 RTE_ASSERT((m)->next == NULL); \
867 RTE_ASSERT((m)->nb_segs == 1); \
868 __rte_mbuf_sanity_check(m, 0); \
872 * Allocate an uninitialized mbuf from mempool *mp*.
874 * This function can be used by PMDs (especially in RX functions) to
875 * allocate an uninitialized mbuf. The driver is responsible of
876 * initializing all the required fields. See rte_pktmbuf_reset().
877 * For standard needs, prefer rte_pktmbuf_alloc().
879 * The caller can expect that the following fields of the mbuf structure
880 * are initialized: buf_addr, buf_iova, buf_len, refcnt=1, nb_segs=1,
881 * next=NULL, pool, priv_size. The other fields must be initialized
885 * The mempool from which mbuf is allocated.
887 * - The pointer to the new mbuf on success.
888 * - NULL if allocation failed.
890 static inline struct rte_mbuf *rte_mbuf_raw_alloc(struct rte_mempool *mp)
894 if (rte_mempool_get(mp, (void **)&m) < 0)
896 MBUF_RAW_ALLOC_CHECK(m);
901 * Put mbuf back into its original mempool.
903 * The caller must ensure that the mbuf is direct and properly
904 * reinitialized (refcnt=1, next=NULL, nb_segs=1), as done by
905 * rte_pktmbuf_prefree_seg().
907 * This function should be used with care, when optimization is
908 * required. For standard needs, prefer rte_pktmbuf_free() or
909 * rte_pktmbuf_free_seg().
912 * The mbuf to be freed.
914 static __rte_always_inline void
915 rte_mbuf_raw_free(struct rte_mbuf *m)
917 RTE_ASSERT(RTE_MBUF_DIRECT(m));
918 RTE_ASSERT(rte_mbuf_refcnt_read(m) == 1);
919 RTE_ASSERT(m->next == NULL);
920 RTE_ASSERT(m->nb_segs == 1);
921 __rte_mbuf_sanity_check(m, 0);
922 rte_mempool_put(m->pool, m);
925 /* compat with older versions */
928 __rte_mbuf_raw_free(struct rte_mbuf *m)
930 rte_mbuf_raw_free(m);
934 * The packet mbuf constructor.
936 * This function initializes some fields in the mbuf structure that are
937 * not modified by the user once created (origin pool, buffer start
938 * address, and so on). This function is given as a callback function to
939 * rte_mempool_obj_iter() or rte_mempool_create() at pool creation time.
942 * The mempool from which mbufs originate.
944 * A pointer that can be used by the user to retrieve useful information
945 * for mbuf initialization. This pointer is the opaque argument passed to
946 * rte_mempool_obj_iter() or rte_mempool_create().
948 * The mbuf to initialize.
950 * The index of the mbuf in the pool table.
952 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
953 void *m, unsigned i);
957 * A packet mbuf pool constructor.
959 * This function initializes the mempool private data in the case of a
960 * pktmbuf pool. This private data is needed by the driver. The
961 * function must be called on the mempool before it is used, or it
962 * can be given as a callback function to rte_mempool_create() at
963 * pool creation. It can be extended by the user, for example, to
964 * provide another packet size.
967 * The mempool from which mbufs originate.
969 * A pointer that can be used by the user to retrieve useful information
970 * for mbuf initialization. This pointer is the opaque argument passed to
971 * rte_mempool_create().
973 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
976 * Create a mbuf pool.
978 * This function creates and initializes a packet mbuf pool. It is
979 * a wrapper to rte_mempool functions.
982 * The name of the mbuf pool.
984 * The number of elements in the mbuf pool. The optimum size (in terms
985 * of memory usage) for a mempool is when n is a power of two minus one:
988 * Size of the per-core object cache. See rte_mempool_create() for
991 * Size of application private are between the rte_mbuf structure
992 * and the data buffer. This value must be aligned to RTE_MBUF_PRIV_ALIGN.
993 * @param data_room_size
994 * Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
996 * The socket identifier where the memory should be allocated. The
997 * value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
1000 * The pointer to the new allocated mempool, on success. NULL on error
1001 * with rte_errno set appropriately. Possible rte_errno values include:
1002 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
1003 * - E_RTE_SECONDARY - function was called from a secondary process instance
1004 * - EINVAL - cache size provided is too large, or priv_size is not aligned.
1005 * - ENOSPC - the maximum number of memzones has already been allocated
1006 * - EEXIST - a memzone with the same name already exists
1007 * - ENOMEM - no appropriate memory area found in which to create memzone
1009 struct rte_mempool *
1010 rte_pktmbuf_pool_create(const char *name, unsigned n,
1011 unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
1015 * Create a mbuf pool with a given mempool ops name
1017 * This function creates and initializes a packet mbuf pool. It is
1018 * a wrapper to rte_mempool functions.
1021 * The name of the mbuf pool.
1023 * The number of elements in the mbuf pool. The optimum size (in terms
1024 * of memory usage) for a mempool is when n is a power of two minus one:
1027 * Size of the per-core object cache. See rte_mempool_create() for
1030 * Size of application private are between the rte_mbuf structure
1031 * and the data buffer. This value must be aligned to RTE_MBUF_PRIV_ALIGN.
1032 * @param data_room_size
1033 * Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
1035 * The socket identifier where the memory should be allocated. The
1036 * value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
1039 * The mempool ops name to be used for this mempool instead of
1040 * default mempool. The value can be *NULL* to use default mempool.
1042 * The pointer to the new allocated mempool, on success. NULL on error
1043 * with rte_errno set appropriately. Possible rte_errno values include:
1044 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
1045 * - E_RTE_SECONDARY - function was called from a secondary process instance
1046 * - EINVAL - cache size provided is too large, or priv_size is not aligned.
1047 * - ENOSPC - the maximum number of memzones has already been allocated
1048 * - EEXIST - a memzone with the same name already exists
1049 * - ENOMEM - no appropriate memory area found in which to create memzone
1051 struct rte_mempool * __rte_experimental
1052 rte_pktmbuf_pool_create_by_ops(const char *name, unsigned int n,
1053 unsigned int cache_size, uint16_t priv_size, uint16_t data_room_size,
1054 int socket_id, const char *ops_name);
1057 * Get the data room size of mbufs stored in a pktmbuf_pool
1059 * The data room size is the amount of data that can be stored in a
1060 * mbuf including the headroom (RTE_PKTMBUF_HEADROOM).
1063 * The packet mbuf pool.
1065 * The data room size of mbufs stored in this mempool.
1067 static inline uint16_t
1068 rte_pktmbuf_data_room_size(struct rte_mempool *mp)
1070 struct rte_pktmbuf_pool_private *mbp_priv;
1072 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1073 return mbp_priv->mbuf_data_room_size;
1077 * Get the application private size of mbufs stored in a pktmbuf_pool
1079 * The private size of mbuf is a zone located between the rte_mbuf
1080 * structure and the data buffer where an application can store data
1081 * associated to a packet.
1084 * The packet mbuf pool.
1086 * The private size of mbufs stored in this mempool.
1088 static inline uint16_t
1089 rte_pktmbuf_priv_size(struct rte_mempool *mp)
1091 struct rte_pktmbuf_pool_private *mbp_priv;
1093 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1094 return mbp_priv->mbuf_priv_size;
1098 * Reset the data_off field of a packet mbuf to its default value.
1100 * The given mbuf must have only one segment, which should be empty.
1103 * The packet mbuf's data_off field has to be reset.
1105 static inline void rte_pktmbuf_reset_headroom(struct rte_mbuf *m)
1107 m->data_off = RTE_MIN(RTE_PKTMBUF_HEADROOM, (uint16_t)m->buf_len);
1111 * Reset the fields of a packet mbuf to their default values.
1113 * The given mbuf must have only one segment.
1116 * The packet mbuf to be resetted.
1118 #define MBUF_INVALID_PORT UINT16_MAX
1120 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
1126 m->vlan_tci_outer = 0;
1128 m->port = MBUF_INVALID_PORT;
1132 rte_pktmbuf_reset_headroom(m);
1135 __rte_mbuf_sanity_check(m, 1);
1139 * Allocate a new mbuf from a mempool.
1141 * This new mbuf contains one segment, which has a length of 0. The pointer
1142 * to data is initialized to have some bytes of headroom in the buffer
1143 * (if buffer size allows).
1146 * The mempool from which the mbuf is allocated.
1148 * - The pointer to the new mbuf on success.
1149 * - NULL if allocation failed.
1151 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
1154 if ((m = rte_mbuf_raw_alloc(mp)) != NULL)
1155 rte_pktmbuf_reset(m);
1160 * Allocate a bulk of mbufs, initialize refcnt and reset the fields to default
1164 * The mempool from which mbufs are allocated.
1166 * Array of pointers to mbufs
1171 * - -ENOENT: Not enough entries in the mempool; no mbufs are retrieved.
1173 static inline int rte_pktmbuf_alloc_bulk(struct rte_mempool *pool,
1174 struct rte_mbuf **mbufs, unsigned count)
1179 rc = rte_mempool_get_bulk(pool, (void **)mbufs, count);
1183 /* To understand duff's device on loop unwinding optimization, see
1184 * https://en.wikipedia.org/wiki/Duff's_device.
1185 * Here while() loop is used rather than do() while{} to avoid extra
1186 * check if count is zero.
1188 switch (count % 4) {
1190 while (idx != count) {
1191 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1192 rte_pktmbuf_reset(mbufs[idx]);
1196 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1197 rte_pktmbuf_reset(mbufs[idx]);
1201 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1202 rte_pktmbuf_reset(mbufs[idx]);
1206 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1207 rte_pktmbuf_reset(mbufs[idx]);
1216 * Attach packet mbuf to another packet mbuf.
1218 * After attachment we refer the mbuf we attached as 'indirect',
1219 * while mbuf we attached to as 'direct'.
1220 * The direct mbuf's reference counter is incremented.
1222 * Right now, not supported:
1223 * - attachment for already indirect mbuf (e.g. - mi has to be direct).
1224 * - mbuf we trying to attach (mi) is used by someone else
1225 * e.g. it's reference counter is greater then 1.
1228 * The indirect packet mbuf.
1230 * The packet mbuf we're attaching to.
1232 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *m)
1234 struct rte_mbuf *md;
1236 RTE_ASSERT(RTE_MBUF_DIRECT(mi) &&
1237 rte_mbuf_refcnt_read(mi) == 1);
1239 /* if m is not direct, get the mbuf that embeds the data */
1240 if (RTE_MBUF_DIRECT(m))
1243 md = rte_mbuf_from_indirect(m);
1245 rte_mbuf_refcnt_update(md, 1);
1246 mi->priv_size = m->priv_size;
1247 mi->buf_iova = m->buf_iova;
1248 mi->buf_addr = m->buf_addr;
1249 mi->buf_len = m->buf_len;
1251 mi->data_off = m->data_off;
1252 mi->data_len = m->data_len;
1254 mi->vlan_tci = m->vlan_tci;
1255 mi->vlan_tci_outer = m->vlan_tci_outer;
1256 mi->tx_offload = m->tx_offload;
1260 mi->pkt_len = mi->data_len;
1262 mi->ol_flags = m->ol_flags | IND_ATTACHED_MBUF;
1263 mi->packet_type = m->packet_type;
1264 mi->timestamp = m->timestamp;
1266 __rte_mbuf_sanity_check(mi, 1);
1267 __rte_mbuf_sanity_check(m, 0);
1271 * Detach an indirect packet mbuf.
1273 * - restore original mbuf address and length values.
1274 * - reset pktmbuf data and data_len to their default values.
1275 * - decrement the direct mbuf's reference counter. When the
1276 * reference counter becomes 0, the direct mbuf is freed.
1278 * All other fields of the given packet mbuf will be left intact.
1281 * The indirect attached packet mbuf.
1283 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
1285 struct rte_mbuf *md = rte_mbuf_from_indirect(m);
1286 struct rte_mempool *mp = m->pool;
1287 uint32_t mbuf_size, buf_len, priv_size;
1289 priv_size = rte_pktmbuf_priv_size(mp);
1290 mbuf_size = sizeof(struct rte_mbuf) + priv_size;
1291 buf_len = rte_pktmbuf_data_room_size(mp);
1293 m->priv_size = priv_size;
1294 m->buf_addr = (char *)m + mbuf_size;
1295 m->buf_iova = rte_mempool_virt2iova(m) + mbuf_size;
1296 m->buf_len = (uint16_t)buf_len;
1297 rte_pktmbuf_reset_headroom(m);
1301 if (rte_mbuf_refcnt_update(md, -1) == 0) {
1304 rte_mbuf_refcnt_set(md, 1);
1305 rte_mbuf_raw_free(md);
1310 * Decrease reference counter and unlink a mbuf segment
1312 * This function does the same than a free, except that it does not
1313 * return the segment to its pool.
1314 * It decreases the reference counter, and if it reaches 0, it is
1315 * detached from its parent for an indirect mbuf.
1318 * The mbuf to be unlinked
1320 * - (m) if it is the last reference. It can be recycled or freed.
1321 * - (NULL) if the mbuf still has remaining references on it.
1323 static __rte_always_inline struct rte_mbuf *
1324 rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
1326 __rte_mbuf_sanity_check(m, 0);
1328 if (likely(rte_mbuf_refcnt_read(m) == 1)) {
1330 if (RTE_MBUF_INDIRECT(m))
1331 rte_pktmbuf_detach(m);
1333 if (m->next != NULL) {
1340 } else if (__rte_mbuf_refcnt_update(m, -1) == 0) {
1342 if (RTE_MBUF_INDIRECT(m))
1343 rte_pktmbuf_detach(m);
1345 if (m->next != NULL) {
1349 rte_mbuf_refcnt_set(m, 1);
1356 /* deprecated, replaced by rte_pktmbuf_prefree_seg() */
1358 static inline struct rte_mbuf *
1359 __rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
1361 return rte_pktmbuf_prefree_seg(m);
1365 * Free a segment of a packet mbuf into its original mempool.
1367 * Free an mbuf, without parsing other segments in case of chained
1371 * The packet mbuf segment to be freed.
1373 static __rte_always_inline void
1374 rte_pktmbuf_free_seg(struct rte_mbuf *m)
1376 m = rte_pktmbuf_prefree_seg(m);
1377 if (likely(m != NULL))
1378 rte_mbuf_raw_free(m);
1382 * Free a packet mbuf back into its original mempool.
1384 * Free an mbuf, and all its segments in case of chained buffers. Each
1385 * segment is added back into its original mempool.
1388 * The packet mbuf to be freed. If NULL, the function does nothing.
1390 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
1392 struct rte_mbuf *m_next;
1395 __rte_mbuf_sanity_check(m, 1);
1399 rte_pktmbuf_free_seg(m);
1405 * Creates a "clone" of the given packet mbuf.
1407 * Walks through all segments of the given packet mbuf, and for each of them:
1408 * - Creates a new packet mbuf from the given pool.
1409 * - Attaches newly created mbuf to the segment.
1410 * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
1411 * from the original packet mbuf.
1414 * The packet mbuf to be cloned.
1416 * The mempool from which the "clone" mbufs are allocated.
1418 * - The pointer to the new "clone" mbuf on success.
1419 * - NULL if allocation fails.
1421 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
1422 struct rte_mempool *mp)
1424 struct rte_mbuf *mc, *mi, **prev;
1428 if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
1433 pktlen = md->pkt_len;
1438 rte_pktmbuf_attach(mi, md);
1441 } while ((md = md->next) != NULL &&
1442 (mi = rte_pktmbuf_alloc(mp)) != NULL);
1446 mc->pkt_len = pktlen;
1448 /* Allocation of new indirect segment failed */
1449 if (unlikely (mi == NULL)) {
1450 rte_pktmbuf_free(mc);
1454 __rte_mbuf_sanity_check(mc, 1);
1459 * Adds given value to the refcnt of all packet mbuf segments.
1461 * Walks through all segments of given packet mbuf and for each of them
1462 * invokes rte_mbuf_refcnt_update().
1465 * The packet mbuf whose refcnt to be updated.
1467 * The value to add to the mbuf's segments refcnt.
1469 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
1471 __rte_mbuf_sanity_check(m, 1);
1474 rte_mbuf_refcnt_update(m, v);
1475 } while ((m = m->next) != NULL);
1479 * Get the headroom in a packet mbuf.
1484 * The length of the headroom.
1486 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
1488 __rte_mbuf_sanity_check(m, 0);
1493 * Get the tailroom of a packet mbuf.
1498 * The length of the tailroom.
1500 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
1502 __rte_mbuf_sanity_check(m, 0);
1503 return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
1508 * Get the last segment of the packet.
1513 * The last segment of the given mbuf.
1515 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
1517 __rte_mbuf_sanity_check(m, 1);
1518 while (m->next != NULL)
1524 * A macro that points to an offset into the data in the mbuf.
1526 * The returned pointer is cast to type t. Before using this
1527 * function, the user must ensure that the first segment is large
1528 * enough to accommodate its data.
1533 * The offset into the mbuf data.
1535 * The type to cast the result into.
1537 #define rte_pktmbuf_mtod_offset(m, t, o) \
1538 ((t)((char *)(m)->buf_addr + (m)->data_off + (o)))
1541 * A macro that points to the start of the data in the mbuf.
1543 * The returned pointer is cast to type t. Before using this
1544 * function, the user must ensure that the first segment is large
1545 * enough to accommodate its data.
1550 * The type to cast the result into.
1552 #define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0)
1555 * A macro that returns the IO address that points to an offset of the
1556 * start of the data in the mbuf
1561 * The offset into the data to calculate address from.
1563 #define rte_pktmbuf_iova_offset(m, o) \
1564 (rte_iova_t)((m)->buf_iova + (m)->data_off + (o))
1567 #define rte_pktmbuf_mtophys_offset(m, o) \
1568 rte_pktmbuf_iova_offset(m, o)
1571 * A macro that returns the IO address that points to the start of the
1577 #define rte_pktmbuf_iova(m) rte_pktmbuf_iova_offset(m, 0)
1580 #define rte_pktmbuf_mtophys(m) rte_pktmbuf_iova(m)
1583 * A macro that returns the length of the packet.
1585 * The value can be read or assigned.
1590 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
1593 * A macro that returns the length of the segment.
1595 * The value can be read or assigned.
1600 #define rte_pktmbuf_data_len(m) ((m)->data_len)
1603 * Prepend len bytes to an mbuf data area.
1605 * Returns a pointer to the new
1606 * data start address. If there is not enough headroom in the first
1607 * segment, the function will return NULL, without modifying the mbuf.
1612 * The amount of data to prepend (in bytes).
1614 * A pointer to the start of the newly prepended data, or
1615 * NULL if there is not enough headroom space in the first segment
1617 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
1620 __rte_mbuf_sanity_check(m, 1);
1622 if (unlikely(len > rte_pktmbuf_headroom(m)))
1626 m->data_len = (uint16_t)(m->data_len + len);
1627 m->pkt_len = (m->pkt_len + len);
1629 return (char *)m->buf_addr + m->data_off;
1633 * Append len bytes to an mbuf.
1635 * Append len bytes to an mbuf and return a pointer to the start address
1636 * of the added data. If there is not enough tailroom in the last
1637 * segment, the function will return NULL, without modifying the mbuf.
1642 * The amount of data to append (in bytes).
1644 * A pointer to the start of the newly appended data, or
1645 * NULL if there is not enough tailroom space in the last segment
1647 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
1650 struct rte_mbuf *m_last;
1652 __rte_mbuf_sanity_check(m, 1);
1654 m_last = rte_pktmbuf_lastseg(m);
1655 if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
1658 tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
1659 m_last->data_len = (uint16_t)(m_last->data_len + len);
1660 m->pkt_len = (m->pkt_len + len);
1661 return (char*) tail;
1665 * Remove len bytes at the beginning of an mbuf.
1667 * Returns a pointer to the start address of the new data area. If the
1668 * length is greater than the length of the first segment, then the
1669 * function will fail and return NULL, without modifying the mbuf.
1674 * The amount of data to remove (in bytes).
1676 * A pointer to the new start of the data.
1678 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
1680 __rte_mbuf_sanity_check(m, 1);
1682 if (unlikely(len > m->data_len))
1685 m->data_len = (uint16_t)(m->data_len - len);
1687 m->pkt_len = (m->pkt_len - len);
1688 return (char *)m->buf_addr + m->data_off;
1692 * Remove len bytes of data at the end of the mbuf.
1694 * If the length is greater than the length of the last segment, the
1695 * function will fail and return -1 without modifying the mbuf.
1700 * The amount of data to remove (in bytes).
1705 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
1707 struct rte_mbuf *m_last;
1709 __rte_mbuf_sanity_check(m, 1);
1711 m_last = rte_pktmbuf_lastseg(m);
1712 if (unlikely(len > m_last->data_len))
1715 m_last->data_len = (uint16_t)(m_last->data_len - len);
1716 m->pkt_len = (m->pkt_len - len);
1721 * Test if mbuf data is contiguous.
1726 * - 1, if all data is contiguous (one segment).
1727 * - 0, if there is several segments.
1729 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
1731 __rte_mbuf_sanity_check(m, 1);
1732 return !!(m->nb_segs == 1);
1736 * @internal used by rte_pktmbuf_read().
1738 const void *__rte_pktmbuf_read(const struct rte_mbuf *m, uint32_t off,
1739 uint32_t len, void *buf);
1742 * Read len data bytes in a mbuf at specified offset.
1744 * If the data is contiguous, return the pointer in the mbuf data, else
1745 * copy the data in the buffer provided by the user and return its
1749 * The pointer to the mbuf.
1751 * The offset of the data in the mbuf.
1753 * The amount of bytes to read.
1755 * The buffer where data is copied if it is not contiguous in mbuf
1756 * data. Its length should be at least equal to the len parameter.
1758 * The pointer to the data, either in the mbuf if it is contiguous,
1759 * or in the user buffer. If mbuf is too small, NULL is returned.
1761 static inline const void *rte_pktmbuf_read(const struct rte_mbuf *m,
1762 uint32_t off, uint32_t len, void *buf)
1764 if (likely(off + len <= rte_pktmbuf_data_len(m)))
1765 return rte_pktmbuf_mtod_offset(m, char *, off);
1767 return __rte_pktmbuf_read(m, off, len, buf);
1771 * Chain an mbuf to another, thereby creating a segmented packet.
1773 * Note: The implementation will do a linear walk over the segments to find
1774 * the tail entry. For cases when there are many segments, it's better to
1775 * chain the entries manually.
1778 * The head of the mbuf chain (the first packet)
1780 * The mbuf to put last in the chain
1784 * - -EOVERFLOW, if the chain segment limit exceeded
1786 static inline int rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail)
1788 struct rte_mbuf *cur_tail;
1790 /* Check for number-of-segments-overflow */
1791 if (head->nb_segs + tail->nb_segs > RTE_MBUF_MAX_NB_SEGS)
1794 /* Chain 'tail' onto the old tail */
1795 cur_tail = rte_pktmbuf_lastseg(head);
1796 cur_tail->next = tail;
1798 /* accumulate number of segments and total length. */
1799 head->nb_segs += tail->nb_segs;
1800 head->pkt_len += tail->pkt_len;
1802 /* pkt_len is only set in the head */
1803 tail->pkt_len = tail->data_len;
1809 * Validate general requirements for Tx offload in mbuf.
1811 * This function checks correctness and completeness of Tx offload settings.
1814 * The packet mbuf to be validated.
1816 * 0 if packet is valid
1819 rte_validate_tx_offload(const struct rte_mbuf *m)
1821 uint64_t ol_flags = m->ol_flags;
1822 uint64_t inner_l3_offset = m->l2_len;
1824 /* Does packet set any of available offloads? */
1825 if (!(ol_flags & PKT_TX_OFFLOAD_MASK))
1828 if (ol_flags & PKT_TX_OUTER_IP_CKSUM)
1829 inner_l3_offset += m->outer_l2_len + m->outer_l3_len;
1831 /* Headers are fragmented */
1832 if (rte_pktmbuf_data_len(m) < inner_l3_offset + m->l3_len + m->l4_len)
1835 /* IP checksum can be counted only for IPv4 packet */
1836 if ((ol_flags & PKT_TX_IP_CKSUM) && (ol_flags & PKT_TX_IPV6))
1839 /* IP type not set when required */
1840 if (ol_flags & (PKT_TX_L4_MASK | PKT_TX_TCP_SEG))
1841 if (!(ol_flags & (PKT_TX_IPV4 | PKT_TX_IPV6)))
1844 /* Check requirements for TSO packet */
1845 if (ol_flags & PKT_TX_TCP_SEG)
1846 if ((m->tso_segsz == 0) ||
1847 ((ol_flags & PKT_TX_IPV4) &&
1848 !(ol_flags & PKT_TX_IP_CKSUM)))
1851 /* PKT_TX_OUTER_IP_CKSUM set for non outer IPv4 packet. */
1852 if ((ol_flags & PKT_TX_OUTER_IP_CKSUM) &&
1853 !(ol_flags & PKT_TX_OUTER_IPV4))
1860 * Linearize data in mbuf.
1862 * This function moves the mbuf data in the first segment if there is enough
1863 * tailroom. The subsequent segments are unchained and freed.
1872 rte_pktmbuf_linearize(struct rte_mbuf *mbuf)
1874 int seg_len, copy_len;
1876 struct rte_mbuf *m_next;
1879 if (rte_pktmbuf_is_contiguous(mbuf))
1882 /* Extend first segment to the total packet length */
1883 copy_len = rte_pktmbuf_pkt_len(mbuf) - rte_pktmbuf_data_len(mbuf);
1885 if (unlikely(copy_len > rte_pktmbuf_tailroom(mbuf)))
1888 buffer = rte_pktmbuf_mtod_offset(mbuf, char *, mbuf->data_len);
1889 mbuf->data_len = (uint16_t)(mbuf->pkt_len);
1891 /* Append data from next segments to the first one */
1896 seg_len = rte_pktmbuf_data_len(m);
1897 rte_memcpy(buffer, rte_pktmbuf_mtod(m, char *), seg_len);
1900 rte_pktmbuf_free_seg(m);
1911 * Dump an mbuf structure to a file.
1913 * Dump all fields for the given packet mbuf and all its associated
1914 * segments (in the case of a chained buffer).
1917 * A pointer to a file for output
1921 * If dump_len != 0, also dump the "dump_len" first data bytes of
1924 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
1930 #endif /* _RTE_MBUF_H_ */