4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5 * Copyright 2014 6WIND S.A.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * * Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
18 * * Neither the name of Intel Corporation nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 * The mbuf library provides the ability to create and destroy buffers
43 * that may be used by the RTE application to store message
44 * buffers. The message buffers are stored in a mempool, using the
45 * RTE mempool library.
47 * The preferred way to create a mbuf pool is to use
48 * rte_pktmbuf_pool_create(). However, in some situations, an
49 * application may want to have more control (ex: populate the pool with
50 * specific memory), in this case it is possible to use functions from
51 * rte_mempool. See how rte_pktmbuf_pool_create() is implemented for
54 * This library provides an API to allocate/free packet mbufs, which are
55 * used to carry network packets.
57 * To understand the concepts of packet buffers or mbufs, you
58 * should read "TCP/IP Illustrated, Volume 2: The Implementation,
59 * Addison-Wesley, 1995, ISBN 0-201-63354-X from Richard Stevens"
60 * http://www.kohala.com/start/tcpipiv2.html
64 #include <rte_common.h>
65 #include <rte_config.h>
66 #include <rte_mempool.h>
67 #include <rte_memory.h>
68 #include <rte_atomic.h>
69 #include <rte_prefetch.h>
70 #include <rte_branch_prediction.h>
71 #include <rte_mbuf_ptype.h>
78 * Packet Offload Features Flags. It also carry packet type information.
79 * Critical resources. Both rx/tx shared these bits. Be cautious on any change
81 * - RX flags start at bit position zero, and get added to the left of previous
83 * - The most-significant 3 bits are reserved for generic mbuf flags
84 * - TX flags therefore start at bit position 60 (i.e. 63-3), and new flags get
85 * added to the right of the previously defined flags i.e. they should count
86 * downwards, not upwards.
88 * Keep these flags synchronized with rte_get_rx_ol_flag_name() and
89 * rte_get_tx_ol_flag_name().
93 * The RX packet is a 802.1q VLAN packet, and the tci has been
94 * saved in in mbuf->vlan_tci.
95 * If the flag PKT_RX_VLAN_STRIPPED is also present, the VLAN
96 * header has been stripped from mbuf data, else it is still
99 #define PKT_RX_VLAN (1ULL << 0)
101 #define PKT_RX_RSS_HASH (1ULL << 1) /**< RX packet with RSS hash result. */
102 #define PKT_RX_FDIR (1ULL << 2) /**< RX packet with FDIR match indicate. */
106 * Checking this flag alone is deprecated: check the 2 bits of
107 * PKT_RX_L4_CKSUM_MASK.
108 * This flag was set when the L4 checksum of a packet was detected as
109 * wrong by the hardware.
111 #define PKT_RX_L4_CKSUM_BAD (1ULL << 3)
115 * Checking this flag alone is deprecated: check the 2 bits of
116 * PKT_RX_IP_CKSUM_MASK.
117 * This flag was set when the IP checksum of a packet was detected as
118 * wrong by the hardware.
120 #define PKT_RX_IP_CKSUM_BAD (1ULL << 4)
122 #define PKT_RX_EIP_CKSUM_BAD (1ULL << 5) /**< External IP header checksum error. */
125 * A vlan has been stripped by the hardware and its tci is saved in
126 * mbuf->vlan_tci. This can only happen if vlan stripping is enabled
127 * in the RX configuration of the PMD.
128 * When PKT_RX_VLAN_STRIPPED is set, PKT_RX_VLAN must also be set.
130 #define PKT_RX_VLAN_STRIPPED (1ULL << 6)
133 * Mask of bits used to determine the status of RX IP checksum.
134 * - PKT_RX_IP_CKSUM_UNKNOWN: no information about the RX IP checksum
135 * - PKT_RX_IP_CKSUM_BAD: the IP checksum in the packet is wrong
136 * - PKT_RX_IP_CKSUM_GOOD: the IP checksum in the packet is valid
137 * - PKT_RX_IP_CKSUM_NONE: the IP checksum is not correct in the packet
138 * data, but the integrity of the IP header is verified.
140 #define PKT_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7))
142 #define PKT_RX_IP_CKSUM_UNKNOWN 0
143 #define PKT_RX_IP_CKSUM_BAD (1ULL << 4)
144 #define PKT_RX_IP_CKSUM_GOOD (1ULL << 7)
145 #define PKT_RX_IP_CKSUM_NONE ((1ULL << 4) | (1ULL << 7))
148 * Mask of bits used to determine the status of RX L4 checksum.
149 * - PKT_RX_L4_CKSUM_UNKNOWN: no information about the RX L4 checksum
150 * - PKT_RX_L4_CKSUM_BAD: the L4 checksum in the packet is wrong
151 * - PKT_RX_L4_CKSUM_GOOD: the L4 checksum in the packet is valid
152 * - PKT_RX_L4_CKSUM_NONE: the L4 checksum is not correct in the packet
153 * data, but the integrity of the L4 data is verified.
155 #define PKT_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8))
157 #define PKT_RX_L4_CKSUM_UNKNOWN 0
158 #define PKT_RX_L4_CKSUM_BAD (1ULL << 3)
159 #define PKT_RX_L4_CKSUM_GOOD (1ULL << 8)
160 #define PKT_RX_L4_CKSUM_NONE ((1ULL << 3) | (1ULL << 8))
162 #define PKT_RX_IEEE1588_PTP (1ULL << 9) /**< RX IEEE1588 L2 Ethernet PT Packet. */
163 #define PKT_RX_IEEE1588_TMST (1ULL << 10) /**< RX IEEE1588 L2/L4 timestamped packet.*/
164 #define PKT_RX_FDIR_ID (1ULL << 13) /**< FD id reported if FDIR match. */
165 #define PKT_RX_FDIR_FLX (1ULL << 14) /**< Flexible bytes reported if FDIR match. */
168 * The 2 vlans have been stripped by the hardware and their tci are
169 * saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer).
170 * This can only happen if vlan stripping is enabled in the RX
171 * configuration of the PMD. If this flag is set,
172 * When PKT_RX_QINQ_STRIPPED is set, the flags (PKT_RX_VLAN |
173 * PKT_RX_VLAN_STRIPPED | PKT_RX_QINQ) must also be set.
175 #define PKT_RX_QINQ_STRIPPED (1ULL << 15)
178 * When packets are coalesced by a hardware or virtual driver, this flag
179 * can be set in the RX mbuf, meaning that the m->tso_segsz field is
180 * valid and is set to the segment size of original packets.
182 #define PKT_RX_LRO (1ULL << 16)
185 * Indicate that the timestamp field in the mbuf is valid.
187 #define PKT_RX_TIMESTAMP (1ULL << 17)
190 * Indicate that security offload processing was applied on the RX packet.
192 #define PKT_RX_SEC_OFFLOAD (1ULL << 18)
195 * Indicate that security offload processing failed on the RX packet.
197 #define PKT_RX_SEC_OFFLOAD_FAILED (1ULL << 19)
200 * The RX packet is a double VLAN, and the outer tci has been
201 * saved in in mbuf->vlan_tci_outer.
202 * If the flag PKT_RX_QINQ_STRIPPED is also present, both VLANs
203 * headers have been stripped from mbuf data, else they are still
206 #define PKT_RX_QINQ (1ULL << 20)
208 /* add new RX flags here */
210 /* add new TX flags here */
213 * Request security offload processing on the TX packet.
215 #define PKT_TX_SEC_OFFLOAD (1ULL << 43)
218 * Offload the MACsec. This flag must be set by the application to enable
219 * this offload feature for a packet to be transmitted.
221 #define PKT_TX_MACSEC (1ULL << 44)
224 * Bits 45:48 used for the tunnel type.
225 * The tunnel type must be specified for TSO or checksum on the inner part
227 * These flags can be used with PKT_TX_TCP_SEG for TSO, or PKT_TX_xxx_CKSUM.
228 * The mbuf fields for inner and outer header lengths are required:
229 * outer_l2_len, outer_l3_len, l2_len, l3_len, l4_len and tso_segsz for TSO.
231 #define PKT_TX_TUNNEL_VXLAN (0x1ULL << 45)
232 #define PKT_TX_TUNNEL_GRE (0x2ULL << 45)
233 #define PKT_TX_TUNNEL_IPIP (0x3ULL << 45)
234 #define PKT_TX_TUNNEL_GENEVE (0x4ULL << 45)
235 /** TX packet with MPLS-in-UDP RFC 7510 header. */
236 #define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45)
237 /* add new TX TUNNEL type here */
238 #define PKT_TX_TUNNEL_MASK (0xFULL << 45)
241 * Second VLAN insertion (QinQ) flag.
243 #define PKT_TX_QINQ_PKT (1ULL << 49) /**< TX packet with double VLAN inserted. */
246 * TCP segmentation offload. To enable this offload feature for a
247 * packet to be transmitted on hardware supporting TSO:
248 * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies
250 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
251 * - if it's IPv4, set the PKT_TX_IP_CKSUM flag
252 * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz
254 #define PKT_TX_TCP_SEG (1ULL << 50)
256 #define PKT_TX_IEEE1588_TMST (1ULL << 51) /**< TX IEEE1588 packet to timestamp. */
259 * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved,
260 * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware
261 * L4 checksum offload, the user needs to:
262 * - fill l2_len and l3_len in mbuf
263 * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM
264 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
266 #define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */
267 #define PKT_TX_TCP_CKSUM (1ULL << 52) /**< TCP cksum of TX pkt. computed by NIC. */
268 #define PKT_TX_SCTP_CKSUM (2ULL << 52) /**< SCTP cksum of TX pkt. computed by NIC. */
269 #define PKT_TX_UDP_CKSUM (3ULL << 52) /**< UDP cksum of TX pkt. computed by NIC. */
270 #define PKT_TX_L4_MASK (3ULL << 52) /**< Mask for L4 cksum offload request. */
273 * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should
274 * also be set by the application, although a PMD will only check
276 * - fill the mbuf offload information: l2_len, l3_len
278 #define PKT_TX_IP_CKSUM (1ULL << 54)
281 * Packet is IPv4. This flag must be set when using any offload feature
282 * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4
283 * packet. If the packet is a tunneled packet, this flag is related to
286 #define PKT_TX_IPV4 (1ULL << 55)
289 * Packet is IPv6. This flag must be set when using an offload feature
290 * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6
291 * packet. If the packet is a tunneled packet, this flag is related to
294 #define PKT_TX_IPV6 (1ULL << 56)
296 #define PKT_TX_VLAN_PKT (1ULL << 57) /**< TX packet is a 802.1q VLAN packet. */
299 * Offload the IP checksum of an external header in the hardware. The
300 * flag PKT_TX_OUTER_IPV4 should also be set by the application, although
301 * a PMD will only check PKT_TX_OUTER_IP_CKSUM.
302 * - fill the mbuf offload information: outer_l2_len, outer_l3_len
304 #define PKT_TX_OUTER_IP_CKSUM (1ULL << 58)
307 * Packet outer header is IPv4. This flag must be set when using any
308 * outer offload feature (L3 or L4 checksum) to tell the NIC that the
309 * outer header of the tunneled packet is an IPv4 packet.
311 #define PKT_TX_OUTER_IPV4 (1ULL << 59)
314 * Packet outer header is IPv6. This flag must be set when using any
315 * outer offload feature (L4 checksum) to tell the NIC that the outer
316 * header of the tunneled packet is an IPv6 packet.
318 #define PKT_TX_OUTER_IPV6 (1ULL << 60)
321 * Bitmask of all supported packet Tx offload features flags,
322 * which can be set for packet.
324 #define PKT_TX_OFFLOAD_MASK ( \
325 PKT_TX_OUTER_IPV6 | \
326 PKT_TX_OUTER_IPV4 | \
327 PKT_TX_OUTER_IP_CKSUM | \
333 PKT_TX_IEEE1588_TMST | \
336 PKT_TX_TUNNEL_MASK | \
340 #define __RESERVED (1ULL << 61) /**< reserved for future mbuf use */
342 #define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */
344 /* Use final bit of flags to indicate a control mbuf */
345 #define CTRL_MBUF_FLAG (1ULL << 63) /**< Mbuf contains control data */
347 /** Alignment constraint of mbuf private area. */
348 #define RTE_MBUF_PRIV_ALIGN 8
351 * Get the name of a RX offload flag
354 * The mask describing the flag.
356 * The name of this flag, or NULL if it's not a valid RX flag.
358 const char *rte_get_rx_ol_flag_name(uint64_t mask);
361 * Dump the list of RX offload flags in a buffer
364 * The mask describing the RX flags.
368 * The length of the buffer.
370 * 0 on success, (-1) on error.
372 int rte_get_rx_ol_flag_list(uint64_t mask, char *buf, size_t buflen);
375 * Get the name of a TX offload flag
378 * The mask describing the flag. Usually only one bit must be set.
379 * Several bits can be given if they belong to the same mask.
380 * Ex: PKT_TX_L4_MASK.
382 * The name of this flag, or NULL if it's not a valid TX flag.
384 const char *rte_get_tx_ol_flag_name(uint64_t mask);
387 * Dump the list of TX offload flags in a buffer
390 * The mask describing the TX flags.
394 * The length of the buffer.
396 * 0 on success, (-1) on error.
398 int rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen);
401 * Some NICs need at least 2KB buffer to RX standard Ethernet frame without
402 * splitting it into multiple segments.
403 * So, for mbufs that planned to be involved into RX/TX, the recommended
404 * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM.
406 #define RTE_MBUF_DEFAULT_DATAROOM 2048
407 #define RTE_MBUF_DEFAULT_BUF_SIZE \
408 (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM)
410 /* define a set of marker types that can be used to refer to set points in the
413 typedef void *MARKER[0]; /**< generic marker for a point in a structure */
415 typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */
417 typedef uint64_t MARKER64[0]; /**< marker that allows us to overwrite 8 bytes
418 * with a single assignment */
421 * The generic rte_mbuf, containing a packet mbuf.
426 void *buf_addr; /**< Virtual address of segment buffer. */
428 * Physical address of segment buffer.
429 * Force alignment to 8-bytes, so as to ensure we have the exact
430 * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes
431 * working on vector drivers easier.
436 rte_iova_t buf_physaddr; /**< deprecated */
437 } __rte_aligned(sizeof(rte_iova_t));
439 /* next 8 bytes are initialised on RX descriptor rearm */
444 * Reference counter. Its size should at least equal to the size
445 * of port field (16 bits), to support zero-copy broadcast.
446 * It should only be accessed using the following functions:
447 * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
448 * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
449 * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
454 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
455 uint16_t refcnt; /**< Non-atomically accessed refcnt */
457 uint16_t nb_segs; /**< Number of segments. */
459 /** Input port (16 bits to support more than 256 virtual ports). */
462 uint64_t ol_flags; /**< Offload features. */
464 /* remaining bytes are set on RX when pulling packet from descriptor */
465 MARKER rx_descriptor_fields1;
468 * The packet type, which is the combination of outer/inner L2, L3, L4
469 * and tunnel types. The packet_type is about data really present in the
470 * mbuf. Example: if vlan stripping is enabled, a received vlan packet
471 * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the
472 * vlan is stripped from the data.
476 uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */
478 uint32_t l2_type:4; /**< (Outer) L2 type. */
479 uint32_t l3_type:4; /**< (Outer) L3 type. */
480 uint32_t l4_type:4; /**< (Outer) L4 type. */
481 uint32_t tun_type:4; /**< Tunnel type. */
484 uint8_t inner_esp_next_proto;
485 /**< ESP next protocol type, valid if
486 * RTE_PTYPE_TUNNEL_ESP tunnel type is set
491 uint8_t inner_l2_type:4;
492 /**< Inner L2 type. */
493 uint8_t inner_l3_type:4;
494 /**< Inner L3 type. */
497 uint32_t inner_l4_type:4; /**< Inner L4 type. */
501 uint32_t pkt_len; /**< Total pkt len: sum of all segments. */
502 uint16_t data_len; /**< Amount of data in segment buffer. */
503 /** VLAN TCI (CPU order), valid if PKT_RX_VLAN_STRIPPED is set. */
507 uint32_t rss; /**< RSS hash result if RSS enabled */
516 /**< Second 4 flexible bytes */
519 /**< First 4 flexible bytes or FD ID, dependent on
520 PKT_RX_FDIR_* flag in ol_flags. */
521 } fdir; /**< Filter identifier if FDIR enabled */
525 } sched; /**< Hierarchical scheduler */
526 uint32_t usr; /**< User defined tags. See rte_distributor_process() */
527 } hash; /**< hash information */
529 /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ_STRIPPED is set. */
530 uint16_t vlan_tci_outer;
532 uint16_t buf_len; /**< Length of segment buffer. */
534 /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference
535 * are not normalized but are always the same for a given port.
539 /* second cache line - fields only used in slow path or on TX */
540 MARKER cacheline1 __rte_cache_min_aligned;
544 void *userdata; /**< Can be used for external metadata */
545 uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */
548 struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
549 struct rte_mbuf *next; /**< Next segment of scattered packet. */
551 /* fields to support TX offloads */
554 uint64_t tx_offload; /**< combined for easy fetch */
558 /**< L2 (MAC) Header Length for non-tunneling pkt.
559 * Outer_L4_len + ... + Inner_L2_len for tunneling pkt.
561 uint64_t l3_len:9; /**< L3 (IP) Header Length. */
562 uint64_t l4_len:8; /**< L4 (TCP/UDP) Header Length. */
563 uint64_t tso_segsz:16; /**< TCP TSO segment size */
565 /* fields for TX offloading of tunnels */
566 uint64_t outer_l3_len:9; /**< Outer L3 (IP) Hdr Length. */
567 uint64_t outer_l2_len:7; /**< Outer L2 (MAC) Hdr Length. */
569 /* uint64_t unused:8; */
573 /** Size of the application private data. In case of an indirect
574 * mbuf, it stores the direct mbuf private data size. */
577 /** Timesync flags for use with IEEE1588. */
580 /** Sequence number. See also rte_reorder_insert(). */
583 } __rte_cache_aligned;
585 /**< Maximum number of nb_segs allowed. */
586 #define RTE_MBUF_MAX_NB_SEGS UINT16_MAX
589 * Prefetch the first part of the mbuf
591 * The first 64 bytes of the mbuf corresponds to fields that are used early
592 * in the receive path. If the cache line of the architecture is higher than
593 * 64B, the second part will also be prefetched.
596 * The pointer to the mbuf.
599 rte_mbuf_prefetch_part1(struct rte_mbuf *m)
601 rte_prefetch0(&m->cacheline0);
605 * Prefetch the second part of the mbuf
607 * The next 64 bytes of the mbuf corresponds to fields that are used in the
608 * transmit path. If the cache line of the architecture is higher than 64B,
609 * this function does nothing as it is expected that the full mbuf is
613 * The pointer to the mbuf.
616 rte_mbuf_prefetch_part2(struct rte_mbuf *m)
618 #if RTE_CACHE_LINE_SIZE == 64
619 rte_prefetch0(&m->cacheline1);
626 static inline uint16_t rte_pktmbuf_priv_size(struct rte_mempool *mp);
629 * Return the IO address of the beginning of the mbuf data
632 * The pointer to the mbuf.
634 * The IO address of the beginning of the mbuf data
636 static inline rte_iova_t
637 rte_mbuf_data_iova(const struct rte_mbuf *mb)
639 return mb->buf_iova + mb->data_off;
643 static inline phys_addr_t
644 rte_mbuf_data_dma_addr(const struct rte_mbuf *mb)
646 return rte_mbuf_data_iova(mb);
650 * Return the default IO address of the beginning of the mbuf data
652 * This function is used by drivers in their receive function, as it
653 * returns the location where data should be written by the NIC, taking
654 * the default headroom in account.
657 * The pointer to the mbuf.
659 * The IO address of the beginning of the mbuf data
661 static inline rte_iova_t
662 rte_mbuf_data_iova_default(const struct rte_mbuf *mb)
664 return mb->buf_iova + RTE_PKTMBUF_HEADROOM;
668 static inline phys_addr_t
669 rte_mbuf_data_dma_addr_default(const struct rte_mbuf *mb)
671 return rte_mbuf_data_iova_default(mb);
675 * Return the mbuf owning the data buffer address of an indirect mbuf.
678 * The pointer to the indirect mbuf.
680 * The address of the direct mbuf corresponding to buffer_addr.
682 static inline struct rte_mbuf *
683 rte_mbuf_from_indirect(struct rte_mbuf *mi)
685 return (struct rte_mbuf *)RTE_PTR_SUB(mi->buf_addr, sizeof(*mi) + mi->priv_size);
689 * Return the buffer address embedded in the given mbuf.
692 * The pointer to the mbuf.
694 * The address of the data buffer owned by the mbuf.
697 rte_mbuf_to_baddr(struct rte_mbuf *md)
700 buffer_addr = (char *)md + sizeof(*md) + rte_pktmbuf_priv_size(md->pool);
705 * Returns TRUE if given mbuf is indirect, or FALSE otherwise.
707 #define RTE_MBUF_INDIRECT(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF)
710 * Returns TRUE if given mbuf is direct, or FALSE otherwise.
712 #define RTE_MBUF_DIRECT(mb) (!RTE_MBUF_INDIRECT(mb))
715 * Private data in case of pktmbuf pool.
717 * A structure that contains some pktmbuf_pool-specific data that are
718 * appended after the mempool structure (in private data).
720 struct rte_pktmbuf_pool_private {
721 uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf. */
722 uint16_t mbuf_priv_size; /**< Size of private area in each mbuf. */
725 #ifdef RTE_LIBRTE_MBUF_DEBUG
727 /** check mbuf type in debug mode */
728 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
730 #else /* RTE_LIBRTE_MBUF_DEBUG */
732 /** check mbuf type in debug mode */
733 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
735 #endif /* RTE_LIBRTE_MBUF_DEBUG */
737 #ifdef RTE_MBUF_REFCNT_ATOMIC
740 * Reads the value of an mbuf's refcnt.
744 * Reference count number.
746 static inline uint16_t
747 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
749 return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
753 * Sets an mbuf's refcnt to a defined value.
760 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
762 rte_atomic16_set(&m->refcnt_atomic, (int16_t)new_value);
766 static inline uint16_t
767 __rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
769 return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
773 * Adds given value to an mbuf's refcnt and returns its new value.
777 * Value to add/subtract
781 static inline uint16_t
782 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
785 * The atomic_add is an expensive operation, so we don't want to
786 * call it in the case where we know we are the uniq holder of
787 * this mbuf (i.e. ref_cnt == 1). Otherwise, an atomic
788 * operation has to be used because concurrent accesses on the
789 * reference counter can occur.
791 if (likely(rte_mbuf_refcnt_read(m) == 1)) {
793 rte_mbuf_refcnt_set(m, (uint16_t)value);
794 return (uint16_t)value;
797 return __rte_mbuf_refcnt_update(m, value);
800 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
803 static inline uint16_t
804 __rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
806 m->refcnt = (uint16_t)(m->refcnt + value);
811 * Adds given value to an mbuf's refcnt and returns its new value.
813 static inline uint16_t
814 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
816 return __rte_mbuf_refcnt_update(m, value);
820 * Reads the value of an mbuf's refcnt.
822 static inline uint16_t
823 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
829 * Sets an mbuf's refcnt to the defined value.
832 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
834 m->refcnt = new_value;
837 #endif /* RTE_MBUF_REFCNT_ATOMIC */
840 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { \
847 * Sanity checks on an mbuf.
849 * Check the consistency of the given mbuf. The function will cause a
850 * panic if corruption is detected.
853 * The mbuf to be checked.
855 * True if the mbuf is a packet header, false if it is a sub-segment
856 * of a packet (in this case, some fields like nb_segs are not checked)
859 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
861 #define MBUF_RAW_ALLOC_CHECK(m) do { \
862 RTE_ASSERT(rte_mbuf_refcnt_read(m) == 1); \
863 RTE_ASSERT((m)->next == NULL); \
864 RTE_ASSERT((m)->nb_segs == 1); \
865 __rte_mbuf_sanity_check(m, 0); \
869 * Allocate an uninitialized mbuf from mempool *mp*.
871 * This function can be used by PMDs (especially in RX functions) to
872 * allocate an uninitialized mbuf. The driver is responsible of
873 * initializing all the required fields. See rte_pktmbuf_reset().
874 * For standard needs, prefer rte_pktmbuf_alloc().
876 * The caller can expect that the following fields of the mbuf structure
877 * are initialized: buf_addr, buf_iova, buf_len, refcnt=1, nb_segs=1,
878 * next=NULL, pool, priv_size. The other fields must be initialized
882 * The mempool from which mbuf is allocated.
884 * - The pointer to the new mbuf on success.
885 * - NULL if allocation failed.
887 static inline struct rte_mbuf *rte_mbuf_raw_alloc(struct rte_mempool *mp)
892 if (rte_mempool_get(mp, &mb) < 0)
894 m = (struct rte_mbuf *)mb;
895 MBUF_RAW_ALLOC_CHECK(m);
900 * Put mbuf back into its original mempool.
902 * The caller must ensure that the mbuf is direct and properly
903 * reinitialized (refcnt=1, next=NULL, nb_segs=1), as done by
904 * rte_pktmbuf_prefree_seg().
906 * This function should be used with care, when optimization is
907 * required. For standard needs, prefer rte_pktmbuf_free() or
908 * rte_pktmbuf_free_seg().
911 * The mbuf to be freed.
913 static __rte_always_inline void
914 rte_mbuf_raw_free(struct rte_mbuf *m)
916 RTE_ASSERT(RTE_MBUF_DIRECT(m));
917 RTE_ASSERT(rte_mbuf_refcnt_read(m) == 1);
918 RTE_ASSERT(m->next == NULL);
919 RTE_ASSERT(m->nb_segs == 1);
920 __rte_mbuf_sanity_check(m, 0);
921 rte_mempool_put(m->pool, m);
924 /* compat with older versions */
927 __rte_mbuf_raw_free(struct rte_mbuf *m)
929 rte_mbuf_raw_free(m);
932 /* Operations on ctrl mbuf */
935 * The control mbuf constructor.
937 * This function initializes some fields in an mbuf structure that are
938 * not modified by the user once created (mbuf type, origin pool, buffer
939 * start address, and so on). This function is given as a callback function
940 * to rte_mempool_obj_iter() or rte_mempool_create() at pool creation time.
943 * The mempool from which the mbuf is allocated.
945 * A pointer that can be used by the user to retrieve useful information
946 * for mbuf initialization. This pointer is the opaque argument passed to
947 * rte_mempool_obj_iter() or rte_mempool_create().
949 * The mbuf to initialize.
951 * The index of the mbuf in the pool table.
953 void rte_ctrlmbuf_init(struct rte_mempool *mp, void *opaque_arg,
954 void *m, unsigned i);
957 * Allocate a new mbuf (type is ctrl) from mempool *mp*.
959 * This new mbuf is initialized with data pointing to the beginning of
960 * buffer, and with a length of zero.
963 * The mempool from which the mbuf is allocated.
965 * - The pointer to the new mbuf on success.
966 * - NULL if allocation failed.
968 #define rte_ctrlmbuf_alloc(mp) rte_pktmbuf_alloc(mp)
971 * Free a control mbuf back into its original mempool.
974 * The control mbuf to be freed.
976 #define rte_ctrlmbuf_free(m) rte_pktmbuf_free(m)
979 * A macro that returns the pointer to the carried data.
981 * The value that can be read or assigned.
986 #define rte_ctrlmbuf_data(m) ((char *)((m)->buf_addr) + (m)->data_off)
989 * A macro that returns the length of the carried data.
991 * The value that can be read or assigned.
996 #define rte_ctrlmbuf_len(m) rte_pktmbuf_data_len(m)
999 * Tests if an mbuf is a control mbuf
1002 * The mbuf to be tested
1004 * - True (1) if the mbuf is a control mbuf
1005 * - False(0) otherwise
1008 rte_is_ctrlmbuf(struct rte_mbuf *m)
1010 return !!(m->ol_flags & CTRL_MBUF_FLAG);
1013 /* Operations on pkt mbuf */
1016 * The packet mbuf constructor.
1018 * This function initializes some fields in the mbuf structure that are
1019 * not modified by the user once created (origin pool, buffer start
1020 * address, and so on). This function is given as a callback function to
1021 * rte_mempool_obj_iter() or rte_mempool_create() at pool creation time.
1024 * The mempool from which mbufs originate.
1026 * A pointer that can be used by the user to retrieve useful information
1027 * for mbuf initialization. This pointer is the opaque argument passed to
1028 * rte_mempool_obj_iter() or rte_mempool_create().
1030 * The mbuf to initialize.
1032 * The index of the mbuf in the pool table.
1034 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
1035 void *m, unsigned i);
1039 * A packet mbuf pool constructor.
1041 * This function initializes the mempool private data in the case of a
1042 * pktmbuf pool. This private data is needed by the driver. The
1043 * function must be called on the mempool before it is used, or it
1044 * can be given as a callback function to rte_mempool_create() at
1045 * pool creation. It can be extended by the user, for example, to
1046 * provide another packet size.
1049 * The mempool from which mbufs originate.
1051 * A pointer that can be used by the user to retrieve useful information
1052 * for mbuf initialization. This pointer is the opaque argument passed to
1053 * rte_mempool_create().
1055 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
1058 * Create a mbuf pool.
1060 * This function creates and initializes a packet mbuf pool. It is
1061 * a wrapper to rte_mempool functions.
1064 * The name of the mbuf pool.
1066 * The number of elements in the mbuf pool. The optimum size (in terms
1067 * of memory usage) for a mempool is when n is a power of two minus one:
1070 * Size of the per-core object cache. See rte_mempool_create() for
1073 * Size of application private are between the rte_mbuf structure
1074 * and the data buffer. This value must be aligned to RTE_MBUF_PRIV_ALIGN.
1075 * @param data_room_size
1076 * Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
1078 * The socket identifier where the memory should be allocated. The
1079 * value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
1082 * The pointer to the new allocated mempool, on success. NULL on error
1083 * with rte_errno set appropriately. Possible rte_errno values include:
1084 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
1085 * - E_RTE_SECONDARY - function was called from a secondary process instance
1086 * - EINVAL - cache size provided is too large, or priv_size is not aligned.
1087 * - ENOSPC - the maximum number of memzones has already been allocated
1088 * - EEXIST - a memzone with the same name already exists
1089 * - ENOMEM - no appropriate memory area found in which to create memzone
1091 struct rte_mempool *
1092 rte_pktmbuf_pool_create(const char *name, unsigned n,
1093 unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
1097 * Get the data room size of mbufs stored in a pktmbuf_pool
1099 * The data room size is the amount of data that can be stored in a
1100 * mbuf including the headroom (RTE_PKTMBUF_HEADROOM).
1103 * The packet mbuf pool.
1105 * The data room size of mbufs stored in this mempool.
1107 static inline uint16_t
1108 rte_pktmbuf_data_room_size(struct rte_mempool *mp)
1110 struct rte_pktmbuf_pool_private *mbp_priv;
1112 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1113 return mbp_priv->mbuf_data_room_size;
1117 * Get the application private size of mbufs stored in a pktmbuf_pool
1119 * The private size of mbuf is a zone located between the rte_mbuf
1120 * structure and the data buffer where an application can store data
1121 * associated to a packet.
1124 * The packet mbuf pool.
1126 * The private size of mbufs stored in this mempool.
1128 static inline uint16_t
1129 rte_pktmbuf_priv_size(struct rte_mempool *mp)
1131 struct rte_pktmbuf_pool_private *mbp_priv;
1133 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1134 return mbp_priv->mbuf_priv_size;
1138 * Reset the data_off field of a packet mbuf to its default value.
1140 * The given mbuf must have only one segment, which should be empty.
1143 * The packet mbuf's data_off field has to be reset.
1145 static inline void rte_pktmbuf_reset_headroom(struct rte_mbuf *m)
1147 m->data_off = (uint16_t)RTE_MIN((uint16_t)RTE_PKTMBUF_HEADROOM,
1148 (uint16_t)m->buf_len);
1152 * Reset the fields of a packet mbuf to their default values.
1154 * The given mbuf must have only one segment.
1157 * The packet mbuf to be resetted.
1159 #define MBUF_INVALID_PORT UINT16_MAX
1161 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
1167 m->vlan_tci_outer = 0;
1169 m->port = MBUF_INVALID_PORT;
1173 rte_pktmbuf_reset_headroom(m);
1176 __rte_mbuf_sanity_check(m, 1);
1180 * Allocate a new mbuf from a mempool.
1182 * This new mbuf contains one segment, which has a length of 0. The pointer
1183 * to data is initialized to have some bytes of headroom in the buffer
1184 * (if buffer size allows).
1187 * The mempool from which the mbuf is allocated.
1189 * - The pointer to the new mbuf on success.
1190 * - NULL if allocation failed.
1192 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
1195 if ((m = rte_mbuf_raw_alloc(mp)) != NULL)
1196 rte_pktmbuf_reset(m);
1201 * Allocate a bulk of mbufs, initialize refcnt and reset the fields to default
1205 * The mempool from which mbufs are allocated.
1207 * Array of pointers to mbufs
1212 * - -ENOENT: Not enough entries in the mempool; no mbufs are retrieved.
1214 static inline int rte_pktmbuf_alloc_bulk(struct rte_mempool *pool,
1215 struct rte_mbuf **mbufs, unsigned count)
1220 rc = rte_mempool_get_bulk(pool, (void **)mbufs, count);
1224 /* To understand duff's device on loop unwinding optimization, see
1225 * https://en.wikipedia.org/wiki/Duff's_device.
1226 * Here while() loop is used rather than do() while{} to avoid extra
1227 * check if count is zero.
1229 switch (count % 4) {
1231 while (idx != count) {
1232 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1233 rte_pktmbuf_reset(mbufs[idx]);
1237 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1238 rte_pktmbuf_reset(mbufs[idx]);
1242 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1243 rte_pktmbuf_reset(mbufs[idx]);
1247 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1248 rte_pktmbuf_reset(mbufs[idx]);
1257 * Attach packet mbuf to another packet mbuf.
1259 * After attachment we refer the mbuf we attached as 'indirect',
1260 * while mbuf we attached to as 'direct'.
1261 * The direct mbuf's reference counter is incremented.
1263 * Right now, not supported:
1264 * - attachment for already indirect mbuf (e.g. - mi has to be direct).
1265 * - mbuf we trying to attach (mi) is used by someone else
1266 * e.g. it's reference counter is greater then 1.
1269 * The indirect packet mbuf.
1271 * The packet mbuf we're attaching to.
1273 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *m)
1275 struct rte_mbuf *md;
1277 RTE_ASSERT(RTE_MBUF_DIRECT(mi) &&
1278 rte_mbuf_refcnt_read(mi) == 1);
1280 /* if m is not direct, get the mbuf that embeds the data */
1281 if (RTE_MBUF_DIRECT(m))
1284 md = rte_mbuf_from_indirect(m);
1286 rte_mbuf_refcnt_update(md, 1);
1287 mi->priv_size = m->priv_size;
1288 mi->buf_iova = m->buf_iova;
1289 mi->buf_addr = m->buf_addr;
1290 mi->buf_len = m->buf_len;
1292 mi->data_off = m->data_off;
1293 mi->data_len = m->data_len;
1295 mi->vlan_tci = m->vlan_tci;
1296 mi->vlan_tci_outer = m->vlan_tci_outer;
1297 mi->tx_offload = m->tx_offload;
1301 mi->pkt_len = mi->data_len;
1303 mi->ol_flags = m->ol_flags | IND_ATTACHED_MBUF;
1304 mi->packet_type = m->packet_type;
1305 mi->timestamp = m->timestamp;
1307 __rte_mbuf_sanity_check(mi, 1);
1308 __rte_mbuf_sanity_check(m, 0);
1312 * Detach an indirect packet mbuf.
1314 * - restore original mbuf address and length values.
1315 * - reset pktmbuf data and data_len to their default values.
1316 * - decrement the direct mbuf's reference counter. When the
1317 * reference counter becomes 0, the direct mbuf is freed.
1319 * All other fields of the given packet mbuf will be left intact.
1322 * The indirect attached packet mbuf.
1324 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
1326 struct rte_mbuf *md = rte_mbuf_from_indirect(m);
1327 struct rte_mempool *mp = m->pool;
1328 uint32_t mbuf_size, buf_len;
1331 priv_size = rte_pktmbuf_priv_size(mp);
1332 mbuf_size = (uint32_t)(sizeof(struct rte_mbuf) + priv_size);
1333 buf_len = rte_pktmbuf_data_room_size(mp);
1335 m->priv_size = priv_size;
1336 m->buf_addr = (char *)m + mbuf_size;
1337 m->buf_iova = rte_mempool_virt2iova(m) + mbuf_size;
1338 m->buf_len = (uint16_t)buf_len;
1339 rte_pktmbuf_reset_headroom(m);
1343 if (rte_mbuf_refcnt_update(md, -1) == 0) {
1346 rte_mbuf_refcnt_set(md, 1);
1347 rte_mbuf_raw_free(md);
1352 * Decrease reference counter and unlink a mbuf segment
1354 * This function does the same than a free, except that it does not
1355 * return the segment to its pool.
1356 * It decreases the reference counter, and if it reaches 0, it is
1357 * detached from its parent for an indirect mbuf.
1360 * The mbuf to be unlinked
1362 * - (m) if it is the last reference. It can be recycled or freed.
1363 * - (NULL) if the mbuf still has remaining references on it.
1365 static __rte_always_inline struct rte_mbuf *
1366 rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
1368 __rte_mbuf_sanity_check(m, 0);
1370 if (likely(rte_mbuf_refcnt_read(m) == 1)) {
1372 if (RTE_MBUF_INDIRECT(m))
1373 rte_pktmbuf_detach(m);
1375 if (m->next != NULL) {
1382 } else if (__rte_mbuf_refcnt_update(m, -1) == 0) {
1384 if (RTE_MBUF_INDIRECT(m))
1385 rte_pktmbuf_detach(m);
1387 if (m->next != NULL) {
1391 rte_mbuf_refcnt_set(m, 1);
1398 /* deprecated, replaced by rte_pktmbuf_prefree_seg() */
1400 static inline struct rte_mbuf *
1401 __rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
1403 return rte_pktmbuf_prefree_seg(m);
1407 * Free a segment of a packet mbuf into its original mempool.
1409 * Free an mbuf, without parsing other segments in case of chained
1413 * The packet mbuf segment to be freed.
1415 static __rte_always_inline void
1416 rte_pktmbuf_free_seg(struct rte_mbuf *m)
1418 m = rte_pktmbuf_prefree_seg(m);
1419 if (likely(m != NULL))
1420 rte_mbuf_raw_free(m);
1424 * Free a packet mbuf back into its original mempool.
1426 * Free an mbuf, and all its segments in case of chained buffers. Each
1427 * segment is added back into its original mempool.
1430 * The packet mbuf to be freed. If NULL, the function does nothing.
1432 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
1434 struct rte_mbuf *m_next;
1437 __rte_mbuf_sanity_check(m, 1);
1441 rte_pktmbuf_free_seg(m);
1447 * Creates a "clone" of the given packet mbuf.
1449 * Walks through all segments of the given packet mbuf, and for each of them:
1450 * - Creates a new packet mbuf from the given pool.
1451 * - Attaches newly created mbuf to the segment.
1452 * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
1453 * from the original packet mbuf.
1456 * The packet mbuf to be cloned.
1458 * The mempool from which the "clone" mbufs are allocated.
1460 * - The pointer to the new "clone" mbuf on success.
1461 * - NULL if allocation fails.
1463 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
1464 struct rte_mempool *mp)
1466 struct rte_mbuf *mc, *mi, **prev;
1470 if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
1475 pktlen = md->pkt_len;
1480 rte_pktmbuf_attach(mi, md);
1483 } while ((md = md->next) != NULL &&
1484 (mi = rte_pktmbuf_alloc(mp)) != NULL);
1488 mc->pkt_len = pktlen;
1490 /* Allocation of new indirect segment failed */
1491 if (unlikely (mi == NULL)) {
1492 rte_pktmbuf_free(mc);
1496 __rte_mbuf_sanity_check(mc, 1);
1501 * Adds given value to the refcnt of all packet mbuf segments.
1503 * Walks through all segments of given packet mbuf and for each of them
1504 * invokes rte_mbuf_refcnt_update().
1507 * The packet mbuf whose refcnt to be updated.
1509 * The value to add to the mbuf's segments refcnt.
1511 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
1513 __rte_mbuf_sanity_check(m, 1);
1516 rte_mbuf_refcnt_update(m, v);
1517 } while ((m = m->next) != NULL);
1521 * Get the headroom in a packet mbuf.
1526 * The length of the headroom.
1528 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
1530 __rte_mbuf_sanity_check(m, 0);
1535 * Get the tailroom of a packet mbuf.
1540 * The length of the tailroom.
1542 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
1544 __rte_mbuf_sanity_check(m, 0);
1545 return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
1550 * Get the last segment of the packet.
1555 * The last segment of the given mbuf.
1557 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
1559 struct rte_mbuf *m2 = (struct rte_mbuf *)m;
1561 __rte_mbuf_sanity_check(m, 1);
1562 while (m2->next != NULL)
1568 * A macro that points to an offset into the data in the mbuf.
1570 * The returned pointer is cast to type t. Before using this
1571 * function, the user must ensure that the first segment is large
1572 * enough to accommodate its data.
1577 * The offset into the mbuf data.
1579 * The type to cast the result into.
1581 #define rte_pktmbuf_mtod_offset(m, t, o) \
1582 ((t)((char *)(m)->buf_addr + (m)->data_off + (o)))
1585 * A macro that points to the start of the data in the mbuf.
1587 * The returned pointer is cast to type t. Before using this
1588 * function, the user must ensure that the first segment is large
1589 * enough to accommodate its data.
1594 * The type to cast the result into.
1596 #define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0)
1599 * A macro that returns the IO address that points to an offset of the
1600 * start of the data in the mbuf
1605 * The offset into the data to calculate address from.
1607 #define rte_pktmbuf_iova_offset(m, o) \
1608 (rte_iova_t)((m)->buf_iova + (m)->data_off + (o))
1611 #define rte_pktmbuf_mtophys_offset(m, o) \
1612 rte_pktmbuf_iova_offset(m, o)
1615 * A macro that returns the IO address that points to the start of the
1621 #define rte_pktmbuf_iova(m) rte_pktmbuf_iova_offset(m, 0)
1624 #define rte_pktmbuf_mtophys(m) rte_pktmbuf_iova(m)
1627 * A macro that returns the length of the packet.
1629 * The value can be read or assigned.
1634 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
1637 * A macro that returns the length of the segment.
1639 * The value can be read or assigned.
1644 #define rte_pktmbuf_data_len(m) ((m)->data_len)
1647 * Prepend len bytes to an mbuf data area.
1649 * Returns a pointer to the new
1650 * data start address. If there is not enough headroom in the first
1651 * segment, the function will return NULL, without modifying the mbuf.
1656 * The amount of data to prepend (in bytes).
1658 * A pointer to the start of the newly prepended data, or
1659 * NULL if there is not enough headroom space in the first segment
1661 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
1664 __rte_mbuf_sanity_check(m, 1);
1666 if (unlikely(len > rte_pktmbuf_headroom(m)))
1669 /* NB: elaborating the subtraction like this instead of using
1670 * -= allows us to ensure the result type is uint16_t
1671 * avoiding compiler warnings on gcc 8.1 at least */
1672 m->data_off = (uint16_t)(m->data_off - len);
1673 m->data_len = (uint16_t)(m->data_len + len);
1674 m->pkt_len = (m->pkt_len + len);
1676 return (char *)m->buf_addr + m->data_off;
1680 * Append len bytes to an mbuf.
1682 * Append len bytes to an mbuf and return a pointer to the start address
1683 * of the added data. If there is not enough tailroom in the last
1684 * segment, the function will return NULL, without modifying the mbuf.
1689 * The amount of data to append (in bytes).
1691 * A pointer to the start of the newly appended data, or
1692 * NULL if there is not enough tailroom space in the last segment
1694 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
1697 struct rte_mbuf *m_last;
1699 __rte_mbuf_sanity_check(m, 1);
1701 m_last = rte_pktmbuf_lastseg(m);
1702 if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
1705 tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
1706 m_last->data_len = (uint16_t)(m_last->data_len + len);
1707 m->pkt_len = (m->pkt_len + len);
1708 return (char*) tail;
1712 * Remove len bytes at the beginning of an mbuf.
1714 * Returns a pointer to the start address of the new data area. If the
1715 * length is greater than the length of the first segment, then the
1716 * function will fail and return NULL, without modifying the mbuf.
1721 * The amount of data to remove (in bytes).
1723 * A pointer to the new start of the data.
1725 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
1727 __rte_mbuf_sanity_check(m, 1);
1729 if (unlikely(len > m->data_len))
1732 /* NB: elaborating the addition like this instead of using
1733 * += allows us to ensure the result type is uint16_t
1734 * avoiding compiler warnings on gcc 8.1 at least */
1735 m->data_len = (uint16_t)(m->data_len - len);
1736 m->data_off = (uint16_t)(m->data_off + len);
1737 m->pkt_len = (m->pkt_len - len);
1738 return (char *)m->buf_addr + m->data_off;
1742 * Remove len bytes of data at the end of the mbuf.
1744 * If the length is greater than the length of the last segment, the
1745 * function will fail and return -1 without modifying the mbuf.
1750 * The amount of data to remove (in bytes).
1755 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
1757 struct rte_mbuf *m_last;
1759 __rte_mbuf_sanity_check(m, 1);
1761 m_last = rte_pktmbuf_lastseg(m);
1762 if (unlikely(len > m_last->data_len))
1765 m_last->data_len = (uint16_t)(m_last->data_len - len);
1766 m->pkt_len = (m->pkt_len - len);
1771 * Test if mbuf data is contiguous.
1776 * - 1, if all data is contiguous (one segment).
1777 * - 0, if there is several segments.
1779 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
1781 __rte_mbuf_sanity_check(m, 1);
1782 return !!(m->nb_segs == 1);
1786 * @internal used by rte_pktmbuf_read().
1788 const void *__rte_pktmbuf_read(const struct rte_mbuf *m, uint32_t off,
1789 uint32_t len, void *buf);
1792 * Read len data bytes in a mbuf at specified offset.
1794 * If the data is contiguous, return the pointer in the mbuf data, else
1795 * copy the data in the buffer provided by the user and return its
1799 * The pointer to the mbuf.
1801 * The offset of the data in the mbuf.
1803 * The amount of bytes to read.
1805 * The buffer where data is copied if it is not contiguous in mbuf
1806 * data. Its length should be at least equal to the len parameter.
1808 * The pointer to the data, either in the mbuf if it is contiguous,
1809 * or in the user buffer. If mbuf is too small, NULL is returned.
1811 static inline const void *rte_pktmbuf_read(const struct rte_mbuf *m,
1812 uint32_t off, uint32_t len, void *buf)
1814 if (likely(off + len <= rte_pktmbuf_data_len(m)))
1815 return rte_pktmbuf_mtod_offset(m, char *, off);
1817 return __rte_pktmbuf_read(m, off, len, buf);
1821 * Chain an mbuf to another, thereby creating a segmented packet.
1823 * Note: The implementation will do a linear walk over the segments to find
1824 * the tail entry. For cases when there are many segments, it's better to
1825 * chain the entries manually.
1828 * The head of the mbuf chain (the first packet)
1830 * The mbuf to put last in the chain
1834 * - -EOVERFLOW, if the chain segment limit exceeded
1836 static inline int rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail)
1838 struct rte_mbuf *cur_tail;
1840 /* Check for number-of-segments-overflow */
1841 if (head->nb_segs + tail->nb_segs > RTE_MBUF_MAX_NB_SEGS)
1844 /* Chain 'tail' onto the old tail */
1845 cur_tail = rte_pktmbuf_lastseg(head);
1846 cur_tail->next = tail;
1848 /* accumulate number of segments and total length.
1849 * NB: elaborating the addition like this instead of using
1850 * -= allows us to ensure the result type is uint16_t
1851 * avoiding compiler warnings on gcc 8.1 at least */
1852 head->nb_segs = (uint16_t)(head->nb_segs + tail->nb_segs);
1853 head->pkt_len += tail->pkt_len;
1855 /* pkt_len is only set in the head */
1856 tail->pkt_len = tail->data_len;
1862 * Validate general requirements for Tx offload in mbuf.
1864 * This function checks correctness and completeness of Tx offload settings.
1867 * The packet mbuf to be validated.
1869 * 0 if packet is valid
1872 rte_validate_tx_offload(const struct rte_mbuf *m)
1874 uint64_t ol_flags = m->ol_flags;
1875 uint64_t inner_l3_offset = m->l2_len;
1877 /* Does packet set any of available offloads? */
1878 if (!(ol_flags & PKT_TX_OFFLOAD_MASK))
1881 if (ol_flags & PKT_TX_OUTER_IP_CKSUM)
1882 /* NB: elaborating the addition like this instead of using
1883 * += gives the result uint64_t type instead of int,
1884 * avoiding compiler warnings on gcc 8.1 at least */
1885 inner_l3_offset = inner_l3_offset + m->outer_l2_len +
1888 /* Headers are fragmented */
1889 if (rte_pktmbuf_data_len(m) < inner_l3_offset + m->l3_len + m->l4_len)
1892 /* IP checksum can be counted only for IPv4 packet */
1893 if ((ol_flags & PKT_TX_IP_CKSUM) && (ol_flags & PKT_TX_IPV6))
1896 /* IP type not set when required */
1897 if (ol_flags & (PKT_TX_L4_MASK | PKT_TX_TCP_SEG))
1898 if (!(ol_flags & (PKT_TX_IPV4 | PKT_TX_IPV6)))
1901 /* Check requirements for TSO packet */
1902 if (ol_flags & PKT_TX_TCP_SEG)
1903 if ((m->tso_segsz == 0) ||
1904 ((ol_flags & PKT_TX_IPV4) &&
1905 !(ol_flags & PKT_TX_IP_CKSUM)))
1908 /* PKT_TX_OUTER_IP_CKSUM set for non outer IPv4 packet. */
1909 if ((ol_flags & PKT_TX_OUTER_IP_CKSUM) &&
1910 !(ol_flags & PKT_TX_OUTER_IPV4))
1917 * Linearize data in mbuf.
1919 * This function moves the mbuf data in the first segment if there is enough
1920 * tailroom. The subsequent segments are unchained and freed.
1929 rte_pktmbuf_linearize(struct rte_mbuf *mbuf)
1931 size_t seg_len, copy_len;
1933 struct rte_mbuf *m_next;
1936 if (rte_pktmbuf_is_contiguous(mbuf))
1939 /* Extend first segment to the total packet length */
1940 copy_len = rte_pktmbuf_pkt_len(mbuf) - rte_pktmbuf_data_len(mbuf);
1942 if (unlikely(copy_len > rte_pktmbuf_tailroom(mbuf)))
1945 buffer = rte_pktmbuf_mtod_offset(mbuf, char *, mbuf->data_len);
1946 mbuf->data_len = (uint16_t)(mbuf->pkt_len);
1948 /* Append data from next segments to the first one */
1953 seg_len = rte_pktmbuf_data_len(m);
1954 rte_memcpy(buffer, rte_pktmbuf_mtod(m, char *), seg_len);
1957 rte_pktmbuf_free_seg(m);
1968 * Dump an mbuf structure to a file.
1970 * Dump all fields for the given packet mbuf and all its associated
1971 * segments (in the case of a chained buffer).
1974 * A pointer to a file for output
1978 * If dump_len != 0, also dump the "dump_len" first data bytes of
1981 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
1987 #endif /* _RTE_MBUF_H_ */