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_mempool.h>
66 #include <rte_memory.h>
67 #include <rte_atomic.h>
68 #include <rte_prefetch.h>
69 #include <rte_branch_prediction.h>
70 #include <rte_mbuf_ptype.h>
77 * Packet Offload Features Flags. It also carry packet type information.
78 * Critical resources. Both rx/tx shared these bits. Be cautious on any change
80 * - RX flags start at bit position zero, and get added to the left of previous
82 * - The most-significant 3 bits are reserved for generic mbuf flags
83 * - TX flags therefore start at bit position 60 (i.e. 63-3), and new flags get
84 * added to the right of the previously defined flags i.e. they should count
85 * downwards, not upwards.
87 * Keep these flags synchronized with rte_get_rx_ol_flag_name() and
88 * rte_get_tx_ol_flag_name().
92 * The RX packet is a 802.1q VLAN packet, and the tci has been
93 * saved in in mbuf->vlan_tci.
94 * If the flag PKT_RX_VLAN_STRIPPED is also present, the VLAN
95 * header has been stripped from mbuf data, else it is still
98 #define PKT_RX_VLAN (1ULL << 0)
100 #define PKT_RX_RSS_HASH (1ULL << 1) /**< RX packet with RSS hash result. */
101 #define PKT_RX_FDIR (1ULL << 2) /**< RX packet with FDIR match indicate. */
105 * Checking this flag alone is deprecated: check the 2 bits of
106 * PKT_RX_L4_CKSUM_MASK.
107 * This flag was set when the L4 checksum of a packet was detected as
108 * wrong by the hardware.
110 #define PKT_RX_L4_CKSUM_BAD (1ULL << 3)
114 * Checking this flag alone is deprecated: check the 2 bits of
115 * PKT_RX_IP_CKSUM_MASK.
116 * This flag was set when the IP checksum of a packet was detected as
117 * wrong by the hardware.
119 #define PKT_RX_IP_CKSUM_BAD (1ULL << 4)
121 #define PKT_RX_EIP_CKSUM_BAD (1ULL << 5) /**< External IP header checksum error. */
124 * A vlan has been stripped by the hardware and its tci is saved in
125 * mbuf->vlan_tci. This can only happen if vlan stripping is enabled
126 * in the RX configuration of the PMD.
127 * When PKT_RX_VLAN_STRIPPED is set, PKT_RX_VLAN must also be set.
129 #define PKT_RX_VLAN_STRIPPED (1ULL << 6)
132 * Mask of bits used to determine the status of RX IP checksum.
133 * - PKT_RX_IP_CKSUM_UNKNOWN: no information about the RX IP checksum
134 * - PKT_RX_IP_CKSUM_BAD: the IP checksum in the packet is wrong
135 * - PKT_RX_IP_CKSUM_GOOD: the IP checksum in the packet is valid
136 * - PKT_RX_IP_CKSUM_NONE: the IP checksum is not correct in the packet
137 * data, but the integrity of the IP header is verified.
139 #define PKT_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7))
141 #define PKT_RX_IP_CKSUM_UNKNOWN 0
142 #define PKT_RX_IP_CKSUM_BAD (1ULL << 4)
143 #define PKT_RX_IP_CKSUM_GOOD (1ULL << 7)
144 #define PKT_RX_IP_CKSUM_NONE ((1ULL << 4) | (1ULL << 7))
147 * Mask of bits used to determine the status of RX L4 checksum.
148 * - PKT_RX_L4_CKSUM_UNKNOWN: no information about the RX L4 checksum
149 * - PKT_RX_L4_CKSUM_BAD: the L4 checksum in the packet is wrong
150 * - PKT_RX_L4_CKSUM_GOOD: the L4 checksum in the packet is valid
151 * - PKT_RX_L4_CKSUM_NONE: the L4 checksum is not correct in the packet
152 * data, but the integrity of the L4 data is verified.
154 #define PKT_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8))
156 #define PKT_RX_L4_CKSUM_UNKNOWN 0
157 #define PKT_RX_L4_CKSUM_BAD (1ULL << 3)
158 #define PKT_RX_L4_CKSUM_GOOD (1ULL << 8)
159 #define PKT_RX_L4_CKSUM_NONE ((1ULL << 3) | (1ULL << 8))
161 #define PKT_RX_IEEE1588_PTP (1ULL << 9) /**< RX IEEE1588 L2 Ethernet PT Packet. */
162 #define PKT_RX_IEEE1588_TMST (1ULL << 10) /**< RX IEEE1588 L2/L4 timestamped packet.*/
163 #define PKT_RX_FDIR_ID (1ULL << 13) /**< FD id reported if FDIR match. */
164 #define PKT_RX_FDIR_FLX (1ULL << 14) /**< Flexible bytes reported if FDIR match. */
167 * The 2 vlans have been stripped by the hardware and their tci are
168 * saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer).
169 * This can only happen if vlan stripping is enabled in the RX
170 * configuration of the PMD. If this flag is set,
171 * When PKT_RX_QINQ_STRIPPED is set, the flags (PKT_RX_VLAN |
172 * PKT_RX_VLAN_STRIPPED | PKT_RX_QINQ) must also be set.
174 #define PKT_RX_QINQ_STRIPPED (1ULL << 15)
177 * When packets are coalesced by a hardware or virtual driver, this flag
178 * can be set in the RX mbuf, meaning that the m->tso_segsz field is
179 * valid and is set to the segment size of original packets.
181 #define PKT_RX_LRO (1ULL << 16)
184 * Indicate that the timestamp field in the mbuf is valid.
186 #define PKT_RX_TIMESTAMP (1ULL << 17)
189 * Indicate that security offload processing was applied on the RX packet.
191 #define PKT_RX_SEC_OFFLOAD (1ULL << 18)
194 * Indicate that security offload processing failed on the RX packet.
196 #define PKT_RX_SEC_OFFLOAD_FAILED (1ULL << 19)
199 * The RX packet is a double VLAN, and the outer tci has been
200 * saved in in mbuf->vlan_tci_outer.
201 * If the flag PKT_RX_QINQ_STRIPPED is also present, both VLANs
202 * headers have been stripped from mbuf data, else they are still
205 #define PKT_RX_QINQ (1ULL << 20)
207 /* add new RX flags here */
209 /* add new TX flags here */
212 * UDP Fragmentation Offload flag. This flag is used for enabling UDP
213 * fragmentation in SW or in HW. When use UFO, mbuf->tso_segsz is used
214 * to store the MSS of UDP fragments.
216 #define PKT_TX_UDP_SEG (1ULL << 42)
219 * Request security offload processing on the TX packet.
221 #define PKT_TX_SEC_OFFLOAD (1ULL << 43)
224 * Offload the MACsec. This flag must be set by the application to enable
225 * this offload feature for a packet to be transmitted.
227 #define PKT_TX_MACSEC (1ULL << 44)
230 * Bits 45:48 used for the tunnel type.
231 * When doing Tx offload like TSO or checksum, the HW needs to configure the
232 * tunnel type into the HW descriptors.
234 #define PKT_TX_TUNNEL_VXLAN (0x1ULL << 45)
235 #define PKT_TX_TUNNEL_GRE (0x2ULL << 45)
236 #define PKT_TX_TUNNEL_IPIP (0x3ULL << 45)
237 #define PKT_TX_TUNNEL_GENEVE (0x4ULL << 45)
238 /**< TX packet with MPLS-in-UDP RFC 7510 header. */
239 #define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45)
240 /* add new TX TUNNEL type here */
241 #define PKT_TX_TUNNEL_MASK (0xFULL << 45)
244 * Second VLAN insertion (QinQ) flag.
246 #define PKT_TX_QINQ_PKT (1ULL << 49) /**< TX packet with double VLAN inserted. */
249 * TCP segmentation offload. To enable this offload feature for a
250 * packet to be transmitted on hardware supporting TSO:
251 * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies
253 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
254 * - if it's IPv4, set the PKT_TX_IP_CKSUM flag and write the IP checksum
256 * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz
257 * - calculate the pseudo header checksum without taking ip_len in account,
258 * and set it in the TCP header. Refer to rte_ipv4_phdr_cksum() and
259 * rte_ipv6_phdr_cksum() that can be used as helpers.
261 #define PKT_TX_TCP_SEG (1ULL << 50)
263 #define PKT_TX_IEEE1588_TMST (1ULL << 51) /**< TX IEEE1588 packet to timestamp. */
266 * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved,
267 * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware
268 * L4 checksum offload, the user needs to:
269 * - fill l2_len and l3_len in mbuf
270 * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM
271 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
272 * - calculate the pseudo header checksum and set it in the L4 header (only
273 * for TCP or UDP). See rte_ipv4_phdr_cksum() and rte_ipv6_phdr_cksum().
274 * For SCTP, set the crc field to 0.
276 #define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */
277 #define PKT_TX_TCP_CKSUM (1ULL << 52) /**< TCP cksum of TX pkt. computed by NIC. */
278 #define PKT_TX_SCTP_CKSUM (2ULL << 52) /**< SCTP cksum of TX pkt. computed by NIC. */
279 #define PKT_TX_UDP_CKSUM (3ULL << 52) /**< UDP cksum of TX pkt. computed by NIC. */
280 #define PKT_TX_L4_MASK (3ULL << 52) /**< Mask for L4 cksum offload request. */
283 * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should
284 * also be set by the application, although a PMD will only check
286 * - set the IP checksum field in the packet to 0
287 * - fill the mbuf offload information: l2_len, l3_len
289 #define PKT_TX_IP_CKSUM (1ULL << 54)
292 * Packet is IPv4. This flag must be set when using any offload feature
293 * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4
294 * packet. If the packet is a tunneled packet, this flag is related to
297 #define PKT_TX_IPV4 (1ULL << 55)
300 * Packet is IPv6. This flag must be set when using an offload feature
301 * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6
302 * packet. If the packet is a tunneled packet, this flag is related to
305 #define PKT_TX_IPV6 (1ULL << 56)
307 #define PKT_TX_VLAN_PKT (1ULL << 57) /**< TX packet is a 802.1q VLAN packet. */
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, alto ugh
312 * a PMD will only check PKT_TX_IP_CKSUM. The IP checksum field in the
313 * packet must be set to 0.
314 * - set the outer IP checksum field in the packet to 0
315 * - fill the mbuf offload information: outer_l2_len, outer_l3_len
317 #define PKT_TX_OUTER_IP_CKSUM (1ULL << 58)
320 * Packet outer header is IPv4. This flag must be set when using any
321 * outer offload feature (L3 or L4 checksum) to tell the NIC that the
322 * outer header of the tunneled packet is an IPv4 packet.
324 #define PKT_TX_OUTER_IPV4 (1ULL << 59)
327 * Packet outer header is IPv6. This flag must be set when using any
328 * outer offload feature (L4 checksum) to tell the NIC that the outer
329 * header of the tunneled packet is an IPv6 packet.
331 #define PKT_TX_OUTER_IPV6 (1ULL << 60)
334 * Bitmask of all supported packet Tx offload features flags,
335 * which can be set for packet.
337 #define PKT_TX_OFFLOAD_MASK ( \
340 PKT_TX_OUTER_IP_CKSUM | \
342 PKT_TX_IEEE1588_TMST | \
345 PKT_TX_TUNNEL_MASK | \
349 #define __RESERVED (1ULL << 61) /**< reserved for future mbuf use */
351 #define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */
353 /* Use final bit of flags to indicate a control mbuf */
354 #define CTRL_MBUF_FLAG (1ULL << 63) /**< Mbuf contains control data */
356 /** Alignment constraint of mbuf private area. */
357 #define RTE_MBUF_PRIV_ALIGN 8
360 * Get the name of a RX offload flag
363 * The mask describing the flag.
365 * The name of this flag, or NULL if it's not a valid RX flag.
367 const char *rte_get_rx_ol_flag_name(uint64_t mask);
370 * Dump the list of RX offload flags in a buffer
373 * The mask describing the RX flags.
377 * The length of the buffer.
379 * 0 on success, (-1) on error.
381 int rte_get_rx_ol_flag_list(uint64_t mask, char *buf, size_t buflen);
384 * Get the name of a TX offload flag
387 * The mask describing the flag. Usually only one bit must be set.
388 * Several bits can be given if they belong to the same mask.
389 * Ex: PKT_TX_L4_MASK.
391 * The name of this flag, or NULL if it's not a valid TX flag.
393 const char *rte_get_tx_ol_flag_name(uint64_t mask);
396 * Dump the list of TX offload flags in a buffer
399 * The mask describing the TX flags.
403 * The length of the buffer.
405 * 0 on success, (-1) on error.
407 int rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen);
410 * Some NICs need at least 2KB buffer to RX standard Ethernet frame without
411 * splitting it into multiple segments.
412 * So, for mbufs that planned to be involved into RX/TX, the recommended
413 * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM.
415 #define RTE_MBUF_DEFAULT_DATAROOM 2048
416 #define RTE_MBUF_DEFAULT_BUF_SIZE \
417 (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM)
419 /* define a set of marker types that can be used to refer to set points in the
422 typedef void *MARKER[0]; /**< generic marker for a point in a structure */
424 typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */
426 typedef uint64_t MARKER64[0]; /**< marker that allows us to overwrite 8 bytes
427 * with a single assignment */
430 * The generic rte_mbuf, containing a packet mbuf.
435 void *buf_addr; /**< Virtual address of segment buffer. */
437 * Physical address of segment buffer.
438 * Force alignment to 8-bytes, so as to ensure we have the exact
439 * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes
440 * working on vector drivers easier.
445 rte_iova_t buf_physaddr; /**< deprecated */
446 } __rte_aligned(sizeof(rte_iova_t));
448 /* next 8 bytes are initialised on RX descriptor rearm */
453 * Reference counter. Its size should at least equal to the size
454 * of port field (16 bits), to support zero-copy broadcast.
455 * It should only be accessed using the following functions:
456 * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
457 * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
458 * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
463 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
464 uint16_t refcnt; /**< Non-atomically accessed refcnt */
466 uint16_t nb_segs; /**< Number of segments. */
468 /** Input port (16 bits to support more than 256 virtual ports). */
471 uint64_t ol_flags; /**< Offload features. */
473 /* remaining bytes are set on RX when pulling packet from descriptor */
474 MARKER rx_descriptor_fields1;
477 * The packet type, which is the combination of outer/inner L2, L3, L4
478 * and tunnel types. The packet_type is about data really present in the
479 * mbuf. Example: if vlan stripping is enabled, a received vlan packet
480 * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the
481 * vlan is stripped from the data.
485 uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */
487 uint32_t l2_type:4; /**< (Outer) L2 type. */
488 uint32_t l3_type:4; /**< (Outer) L3 type. */
489 uint32_t l4_type:4; /**< (Outer) L4 type. */
490 uint32_t tun_type:4; /**< Tunnel type. */
493 uint8_t inner_esp_next_proto;
494 /**< ESP next protocol type, valid if
495 * RTE_PTYPE_TUNNEL_ESP tunnel type is set
500 uint8_t inner_l2_type:4;
501 /**< Inner L2 type. */
502 uint8_t inner_l3_type:4;
503 /**< Inner L3 type. */
506 uint32_t inner_l4_type:4; /**< Inner L4 type. */
510 uint32_t pkt_len; /**< Total pkt len: sum of all segments. */
511 uint16_t data_len; /**< Amount of data in segment buffer. */
512 /** VLAN TCI (CPU order), valid if PKT_RX_VLAN_STRIPPED is set. */
516 uint32_t rss; /**< RSS hash result if RSS enabled */
525 /**< Second 4 flexible bytes */
528 /**< First 4 flexible bytes or FD ID, dependent on
529 PKT_RX_FDIR_* flag in ol_flags. */
530 } fdir; /**< Filter identifier if FDIR enabled */
534 } sched; /**< Hierarchical scheduler */
535 uint32_t usr; /**< User defined tags. See rte_distributor_process() */
536 } hash; /**< hash information */
538 /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ_STRIPPED is set. */
539 uint16_t vlan_tci_outer;
541 uint16_t buf_len; /**< Length of segment buffer. */
543 /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference
544 * are not normalized but are always the same for a given port.
548 /* second cache line - fields only used in slow path or on TX */
549 MARKER cacheline1 __rte_cache_min_aligned;
553 void *userdata; /**< Can be used for external metadata */
554 uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */
557 struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
558 struct rte_mbuf *next; /**< Next segment of scattered packet. */
560 /* fields to support TX offloads */
563 uint64_t tx_offload; /**< combined for easy fetch */
567 /**< L2 (MAC) Header Length for non-tunneling pkt.
568 * Outer_L4_len + ... + Inner_L2_len for tunneling pkt.
570 uint64_t l3_len:9; /**< L3 (IP) Header Length. */
571 uint64_t l4_len:8; /**< L4 (TCP/UDP) Header Length. */
572 uint64_t tso_segsz:16; /**< TCP TSO segment size */
574 /* fields for TX offloading of tunnels */
575 uint64_t outer_l3_len:9; /**< Outer L3 (IP) Hdr Length. */
576 uint64_t outer_l2_len:7; /**< Outer L2 (MAC) Hdr Length. */
578 /* uint64_t unused:8; */
582 /** Size of the application private data. In case of an indirect
583 * mbuf, it stores the direct mbuf private data size. */
586 /** Timesync flags for use with IEEE1588. */
589 /** Sequence number. See also rte_reorder_insert(). */
592 } __rte_cache_aligned;
594 /**< Maximum number of nb_segs allowed. */
595 #define RTE_MBUF_MAX_NB_SEGS UINT16_MAX
598 * Prefetch the first part of the mbuf
600 * The first 64 bytes of the mbuf corresponds to fields that are used early
601 * in the receive path. If the cache line of the architecture is higher than
602 * 64B, the second part will also be prefetched.
605 * The pointer to the mbuf.
608 rte_mbuf_prefetch_part1(struct rte_mbuf *m)
610 rte_prefetch0(&m->cacheline0);
614 * Prefetch the second part of the mbuf
616 * The next 64 bytes of the mbuf corresponds to fields that are used in the
617 * transmit path. If the cache line of the architecture is higher than 64B,
618 * this function does nothing as it is expected that the full mbuf is
622 * The pointer to the mbuf.
625 rte_mbuf_prefetch_part2(struct rte_mbuf *m)
627 #if RTE_CACHE_LINE_SIZE == 64
628 rte_prefetch0(&m->cacheline1);
635 static inline uint16_t rte_pktmbuf_priv_size(struct rte_mempool *mp);
638 * Return the IO address of the beginning of the mbuf data
641 * The pointer to the mbuf.
643 * The IO address of the beginning of the mbuf data
645 static inline rte_iova_t
646 rte_mbuf_data_iova(const struct rte_mbuf *mb)
648 return mb->buf_iova + mb->data_off;
652 static inline phys_addr_t
653 rte_mbuf_data_dma_addr(const struct rte_mbuf *mb)
655 return rte_mbuf_data_iova(mb);
659 * Return the default IO address of the beginning of the mbuf data
661 * This function is used by drivers in their receive function, as it
662 * returns the location where data should be written by the NIC, taking
663 * the default headroom in account.
666 * The pointer to the mbuf.
668 * The IO address of the beginning of the mbuf data
670 static inline rte_iova_t
671 rte_mbuf_data_iova_default(const struct rte_mbuf *mb)
673 return mb->buf_iova + RTE_PKTMBUF_HEADROOM;
677 static inline phys_addr_t
678 rte_mbuf_data_dma_addr_default(const struct rte_mbuf *mb)
680 return rte_mbuf_data_iova_default(mb);
684 * Return the mbuf owning the data buffer address of an indirect mbuf.
687 * The pointer to the indirect mbuf.
689 * The address of the direct mbuf corresponding to buffer_addr.
691 static inline struct rte_mbuf *
692 rte_mbuf_from_indirect(struct rte_mbuf *mi)
694 return (struct rte_mbuf *)RTE_PTR_SUB(mi->buf_addr, sizeof(*mi) + mi->priv_size);
698 * Return the buffer address embedded in the given mbuf.
701 * The pointer to the mbuf.
703 * The address of the data buffer owned by the mbuf.
706 rte_mbuf_to_baddr(struct rte_mbuf *md)
709 buffer_addr = (char *)md + sizeof(*md) + rte_pktmbuf_priv_size(md->pool);
714 * Returns TRUE if given mbuf is indirect, or FALSE otherwise.
716 #define RTE_MBUF_INDIRECT(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF)
719 * Returns TRUE if given mbuf is direct, or FALSE otherwise.
721 #define RTE_MBUF_DIRECT(mb) (!RTE_MBUF_INDIRECT(mb))
724 * Private data in case of pktmbuf pool.
726 * A structure that contains some pktmbuf_pool-specific data that are
727 * appended after the mempool structure (in private data).
729 struct rte_pktmbuf_pool_private {
730 uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf. */
731 uint16_t mbuf_priv_size; /**< Size of private area in each mbuf. */
734 #ifdef RTE_LIBRTE_MBUF_DEBUG
736 /** check mbuf type in debug mode */
737 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
739 #else /* RTE_LIBRTE_MBUF_DEBUG */
741 /** check mbuf type in debug mode */
742 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
744 #endif /* RTE_LIBRTE_MBUF_DEBUG */
746 #ifdef RTE_MBUF_REFCNT_ATOMIC
749 * Reads the value of an mbuf's refcnt.
753 * Reference count number.
755 static inline uint16_t
756 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
758 return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
762 * Sets an mbuf's refcnt to a defined value.
769 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
771 rte_atomic16_set(&m->refcnt_atomic, new_value);
775 * Adds given value to an mbuf's refcnt and returns its new value.
779 * Value to add/subtract
783 static inline uint16_t
784 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
787 * The atomic_add is an expensive operation, so we don't want to
788 * call it in the case where we know we are the uniq holder of
789 * this mbuf (i.e. ref_cnt == 1). Otherwise, an atomic
790 * operation has to be used because concurrent accesses on the
791 * reference counter can occur.
793 if (likely(rte_mbuf_refcnt_read(m) == 1)) {
794 rte_mbuf_refcnt_set(m, 1 + value);
798 return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
801 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
804 * Adds given value to an mbuf's refcnt and returns its new value.
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 * Reads the value of an mbuf's refcnt.
816 static inline uint16_t
817 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
823 * Sets an mbuf's refcnt to the defined value.
826 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
828 m->refcnt = new_value;
831 #endif /* RTE_MBUF_REFCNT_ATOMIC */
834 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { \
841 * Sanity checks on an mbuf.
843 * Check the consistency of the given mbuf. The function will cause a
844 * panic if corruption is detected.
847 * The mbuf to be checked.
849 * True if the mbuf is a packet header, false if it is a sub-segment
850 * of a packet (in this case, some fields like nb_segs are not checked)
853 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
855 #define MBUF_RAW_ALLOC_CHECK(m) do { \
856 RTE_ASSERT(rte_mbuf_refcnt_read(m) == 1); \
857 RTE_ASSERT((m)->next == NULL); \
858 RTE_ASSERT((m)->nb_segs == 1); \
859 __rte_mbuf_sanity_check(m, 0); \
863 * Allocate an uninitialized mbuf from mempool *mp*.
865 * This function can be used by PMDs (especially in RX functions) to
866 * allocate an uninitialized mbuf. The driver is responsible of
867 * initializing all the required fields. See rte_pktmbuf_reset().
868 * For standard needs, prefer rte_pktmbuf_alloc().
870 * The caller can expect that the following fields of the mbuf structure
871 * are initialized: buf_addr, buf_iova, buf_len, refcnt=1, nb_segs=1,
872 * next=NULL, pool, priv_size. The other fields must be initialized
876 * The mempool from which mbuf is allocated.
878 * - The pointer to the new mbuf on success.
879 * - NULL if allocation failed.
881 static inline struct rte_mbuf *rte_mbuf_raw_alloc(struct rte_mempool *mp)
886 if (rte_mempool_get(mp, &mb) < 0)
888 m = (struct rte_mbuf *)mb;
889 MBUF_RAW_ALLOC_CHECK(m);
894 * Put mbuf back into its original mempool.
896 * The caller must ensure that the mbuf is direct and properly
897 * reinitialized (refcnt=1, next=NULL, nb_segs=1), as done by
898 * rte_pktmbuf_prefree_seg().
900 * This function should be used with care, when optimization is
901 * required. For standard needs, prefer rte_pktmbuf_free() or
902 * rte_pktmbuf_free_seg().
905 * The mbuf to be freed.
907 static __rte_always_inline void
908 rte_mbuf_raw_free(struct rte_mbuf *m)
910 RTE_ASSERT(RTE_MBUF_DIRECT(m));
911 RTE_ASSERT(rte_mbuf_refcnt_read(m) == 1);
912 RTE_ASSERT(m->next == NULL);
913 RTE_ASSERT(m->nb_segs == 1);
914 __rte_mbuf_sanity_check(m, 0);
915 rte_mempool_put(m->pool, m);
918 /* compat with older versions */
921 __rte_mbuf_raw_free(struct rte_mbuf *m)
923 rte_mbuf_raw_free(m);
926 /* Operations on ctrl mbuf */
929 * The control mbuf constructor.
931 * This function initializes some fields in an mbuf structure that are
932 * not modified by the user once created (mbuf type, origin pool, buffer
933 * start address, and so on). This function is given as a callback function
934 * to rte_mempool_obj_iter() or rte_mempool_create() at pool creation time.
937 * The mempool from which the mbuf is allocated.
939 * A pointer that can be used by the user to retrieve useful information
940 * for mbuf initialization. This pointer is the opaque argument passed to
941 * rte_mempool_obj_iter() or rte_mempool_create().
943 * The mbuf to initialize.
945 * The index of the mbuf in the pool table.
947 void rte_ctrlmbuf_init(struct rte_mempool *mp, void *opaque_arg,
948 void *m, unsigned i);
951 * Allocate a new mbuf (type is ctrl) from mempool *mp*.
953 * This new mbuf is initialized with data pointing to the beginning of
954 * buffer, and with a length of zero.
957 * The mempool from which the mbuf is allocated.
959 * - The pointer to the new mbuf on success.
960 * - NULL if allocation failed.
962 #define rte_ctrlmbuf_alloc(mp) rte_pktmbuf_alloc(mp)
965 * Free a control mbuf back into its original mempool.
968 * The control mbuf to be freed.
970 #define rte_ctrlmbuf_free(m) rte_pktmbuf_free(m)
973 * A macro that returns the pointer to the carried data.
975 * The value that can be read or assigned.
980 #define rte_ctrlmbuf_data(m) ((char *)((m)->buf_addr) + (m)->data_off)
983 * A macro that returns the length of the carried data.
985 * The value that can be read or assigned.
990 #define rte_ctrlmbuf_len(m) rte_pktmbuf_data_len(m)
993 * Tests if an mbuf is a control mbuf
996 * The mbuf to be tested
998 * - True (1) if the mbuf is a control mbuf
999 * - False(0) otherwise
1002 rte_is_ctrlmbuf(struct rte_mbuf *m)
1004 return !!(m->ol_flags & CTRL_MBUF_FLAG);
1007 /* Operations on pkt mbuf */
1010 * The packet mbuf constructor.
1012 * This function initializes some fields in the mbuf structure that are
1013 * not modified by the user once created (origin pool, buffer start
1014 * address, and so on). This function is given as a callback function to
1015 * rte_mempool_obj_iter() or rte_mempool_create() at pool creation time.
1018 * The mempool from which mbufs originate.
1020 * A pointer that can be used by the user to retrieve useful information
1021 * for mbuf initialization. This pointer is the opaque argument passed to
1022 * rte_mempool_obj_iter() or rte_mempool_create().
1024 * The mbuf to initialize.
1026 * The index of the mbuf in the pool table.
1028 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
1029 void *m, unsigned i);
1033 * A packet mbuf pool constructor.
1035 * This function initializes the mempool private data in the case of a
1036 * pktmbuf pool. This private data is needed by the driver. The
1037 * function must be called on the mempool before it is used, or it
1038 * can be given as a callback function to rte_mempool_create() at
1039 * pool creation. It can be extended by the user, for example, to
1040 * provide another packet size.
1043 * The mempool from which mbufs originate.
1045 * A pointer that can be used by the user to retrieve useful information
1046 * for mbuf initialization. This pointer is the opaque argument passed to
1047 * rte_mempool_create().
1049 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
1052 * Create a mbuf pool.
1054 * This function creates and initializes a packet mbuf pool. It is
1055 * a wrapper to rte_mempool functions.
1058 * The name of the mbuf pool.
1060 * The number of elements in the mbuf pool. The optimum size (in terms
1061 * of memory usage) for a mempool is when n is a power of two minus one:
1064 * Size of the per-core object cache. See rte_mempool_create() for
1067 * Size of application private are between the rte_mbuf structure
1068 * and the data buffer. This value must be aligned to RTE_MBUF_PRIV_ALIGN.
1069 * @param data_room_size
1070 * Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
1072 * The socket identifier where the memory should be allocated. The
1073 * value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
1076 * The pointer to the new allocated mempool, on success. NULL on error
1077 * with rte_errno set appropriately. Possible rte_errno values include:
1078 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
1079 * - E_RTE_SECONDARY - function was called from a secondary process instance
1080 * - EINVAL - cache size provided is too large, or priv_size is not aligned.
1081 * - ENOSPC - the maximum number of memzones has already been allocated
1082 * - EEXIST - a memzone with the same name already exists
1083 * - ENOMEM - no appropriate memory area found in which to create memzone
1085 struct rte_mempool *
1086 rte_pktmbuf_pool_create(const char *name, unsigned n,
1087 unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
1091 * Get the data room size of mbufs stored in a pktmbuf_pool
1093 * The data room size is the amount of data that can be stored in a
1094 * mbuf including the headroom (RTE_PKTMBUF_HEADROOM).
1097 * The packet mbuf pool.
1099 * The data room size of mbufs stored in this mempool.
1101 static inline uint16_t
1102 rte_pktmbuf_data_room_size(struct rte_mempool *mp)
1104 struct rte_pktmbuf_pool_private *mbp_priv;
1106 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1107 return mbp_priv->mbuf_data_room_size;
1111 * Get the application private size of mbufs stored in a pktmbuf_pool
1113 * The private size of mbuf is a zone located between the rte_mbuf
1114 * structure and the data buffer where an application can store data
1115 * associated to a packet.
1118 * The packet mbuf pool.
1120 * The private size of mbufs stored in this mempool.
1122 static inline uint16_t
1123 rte_pktmbuf_priv_size(struct rte_mempool *mp)
1125 struct rte_pktmbuf_pool_private *mbp_priv;
1127 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1128 return mbp_priv->mbuf_priv_size;
1132 * Reset the data_off field of a packet mbuf to its default value.
1134 * The given mbuf must have only one segment, which should be empty.
1137 * The packet mbuf's data_off field has to be reset.
1139 static inline void rte_pktmbuf_reset_headroom(struct rte_mbuf *m)
1141 m->data_off = RTE_MIN(RTE_PKTMBUF_HEADROOM, (uint16_t)m->buf_len);
1145 * Reset the fields of a packet mbuf to their default values.
1147 * The given mbuf must have only one segment.
1150 * The packet mbuf to be resetted.
1152 #define MBUF_INVALID_PORT UINT16_MAX
1154 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
1160 m->vlan_tci_outer = 0;
1162 m->port = MBUF_INVALID_PORT;
1166 rte_pktmbuf_reset_headroom(m);
1169 __rte_mbuf_sanity_check(m, 1);
1173 * Allocate a new mbuf from a mempool.
1175 * This new mbuf contains one segment, which has a length of 0. The pointer
1176 * to data is initialized to have some bytes of headroom in the buffer
1177 * (if buffer size allows).
1180 * The mempool from which the mbuf is allocated.
1182 * - The pointer to the new mbuf on success.
1183 * - NULL if allocation failed.
1185 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
1188 if ((m = rte_mbuf_raw_alloc(mp)) != NULL)
1189 rte_pktmbuf_reset(m);
1194 * Allocate a bulk of mbufs, initialize refcnt and reset the fields to default
1198 * The mempool from which mbufs are allocated.
1200 * Array of pointers to mbufs
1205 * - -ENOENT: Not enough entries in the mempool; no mbufs are retrieved.
1207 static inline int rte_pktmbuf_alloc_bulk(struct rte_mempool *pool,
1208 struct rte_mbuf **mbufs, unsigned count)
1213 rc = rte_mempool_get_bulk(pool, (void **)mbufs, count);
1217 /* To understand duff's device on loop unwinding optimization, see
1218 * https://en.wikipedia.org/wiki/Duff's_device.
1219 * Here while() loop is used rather than do() while{} to avoid extra
1220 * check if count is zero.
1222 switch (count % 4) {
1224 while (idx != count) {
1225 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1226 rte_pktmbuf_reset(mbufs[idx]);
1230 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1231 rte_pktmbuf_reset(mbufs[idx]);
1235 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1236 rte_pktmbuf_reset(mbufs[idx]);
1240 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1241 rte_pktmbuf_reset(mbufs[idx]);
1250 * Attach packet mbuf to another packet mbuf.
1252 * After attachment we refer the mbuf we attached as 'indirect',
1253 * while mbuf we attached to as 'direct'.
1254 * The direct mbuf's reference counter is incremented.
1256 * Right now, not supported:
1257 * - attachment for already indirect mbuf (e.g. - mi has to be direct).
1258 * - mbuf we trying to attach (mi) is used by someone else
1259 * e.g. it's reference counter is greater then 1.
1262 * The indirect packet mbuf.
1264 * The packet mbuf we're attaching to.
1266 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *m)
1268 struct rte_mbuf *md;
1270 RTE_ASSERT(RTE_MBUF_DIRECT(mi) &&
1271 rte_mbuf_refcnt_read(mi) == 1);
1273 /* if m is not direct, get the mbuf that embeds the data */
1274 if (RTE_MBUF_DIRECT(m))
1277 md = rte_mbuf_from_indirect(m);
1279 rte_mbuf_refcnt_update(md, 1);
1280 mi->priv_size = m->priv_size;
1281 mi->buf_iova = m->buf_iova;
1282 mi->buf_addr = m->buf_addr;
1283 mi->buf_len = m->buf_len;
1285 mi->data_off = m->data_off;
1286 mi->data_len = m->data_len;
1288 mi->vlan_tci = m->vlan_tci;
1289 mi->vlan_tci_outer = m->vlan_tci_outer;
1290 mi->tx_offload = m->tx_offload;
1294 mi->pkt_len = mi->data_len;
1296 mi->ol_flags = m->ol_flags | IND_ATTACHED_MBUF;
1297 mi->packet_type = m->packet_type;
1298 mi->timestamp = m->timestamp;
1300 __rte_mbuf_sanity_check(mi, 1);
1301 __rte_mbuf_sanity_check(m, 0);
1305 * Detach an indirect packet mbuf.
1307 * - restore original mbuf address and length values.
1308 * - reset pktmbuf data and data_len to their default values.
1309 * - decrement the direct mbuf's reference counter. When the
1310 * reference counter becomes 0, the direct mbuf is freed.
1312 * All other fields of the given packet mbuf will be left intact.
1315 * The indirect attached packet mbuf.
1317 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
1319 struct rte_mbuf *md = rte_mbuf_from_indirect(m);
1320 struct rte_mempool *mp = m->pool;
1321 uint32_t mbuf_size, buf_len, priv_size;
1323 priv_size = rte_pktmbuf_priv_size(mp);
1324 mbuf_size = sizeof(struct rte_mbuf) + priv_size;
1325 buf_len = rte_pktmbuf_data_room_size(mp);
1327 m->priv_size = priv_size;
1328 m->buf_addr = (char *)m + mbuf_size;
1329 m->buf_iova = rte_mempool_virt2iova(m) + mbuf_size;
1330 m->buf_len = (uint16_t)buf_len;
1331 rte_pktmbuf_reset_headroom(m);
1335 if (rte_mbuf_refcnt_update(md, -1) == 0) {
1338 rte_mbuf_refcnt_set(md, 1);
1339 rte_mbuf_raw_free(md);
1344 * Decrease reference counter and unlink a mbuf segment
1346 * This function does the same than a free, except that it does not
1347 * return the segment to its pool.
1348 * It decreases the reference counter, and if it reaches 0, it is
1349 * detached from its parent for an indirect mbuf.
1352 * The mbuf to be unlinked
1354 * - (m) if it is the last reference. It can be recycled or freed.
1355 * - (NULL) if the mbuf still has remaining references on it.
1357 static __rte_always_inline struct rte_mbuf *
1358 rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
1360 __rte_mbuf_sanity_check(m, 0);
1362 if (likely(rte_mbuf_refcnt_read(m) == 1)) {
1364 if (RTE_MBUF_INDIRECT(m))
1365 rte_pktmbuf_detach(m);
1367 if (m->next != NULL) {
1374 } else if (rte_atomic16_add_return(&m->refcnt_atomic, -1) == 0) {
1377 if (RTE_MBUF_INDIRECT(m))
1378 rte_pktmbuf_detach(m);
1380 if (m->next != NULL) {
1384 rte_mbuf_refcnt_set(m, 1);
1391 /* deprecated, replaced by rte_pktmbuf_prefree_seg() */
1393 static inline struct rte_mbuf *
1394 __rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
1396 return rte_pktmbuf_prefree_seg(m);
1400 * Free a segment of a packet mbuf into its original mempool.
1402 * Free an mbuf, without parsing other segments in case of chained
1406 * The packet mbuf segment to be freed.
1408 static __rte_always_inline void
1409 rte_pktmbuf_free_seg(struct rte_mbuf *m)
1411 m = rte_pktmbuf_prefree_seg(m);
1412 if (likely(m != NULL))
1413 rte_mbuf_raw_free(m);
1417 * Free a packet mbuf back into its original mempool.
1419 * Free an mbuf, and all its segments in case of chained buffers. Each
1420 * segment is added back into its original mempool.
1423 * The packet mbuf to be freed.
1425 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
1427 struct rte_mbuf *m_next;
1429 __rte_mbuf_sanity_check(m, 1);
1433 rte_pktmbuf_free_seg(m);
1439 * Creates a "clone" of the given packet mbuf.
1441 * Walks through all segments of the given packet mbuf, and for each of them:
1442 * - Creates a new packet mbuf from the given pool.
1443 * - Attaches newly created mbuf to the segment.
1444 * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
1445 * from the original packet mbuf.
1448 * The packet mbuf to be cloned.
1450 * The mempool from which the "clone" mbufs are allocated.
1452 * - The pointer to the new "clone" mbuf on success.
1453 * - NULL if allocation fails.
1455 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
1456 struct rte_mempool *mp)
1458 struct rte_mbuf *mc, *mi, **prev;
1462 if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
1467 pktlen = md->pkt_len;
1472 rte_pktmbuf_attach(mi, md);
1475 } while ((md = md->next) != NULL &&
1476 (mi = rte_pktmbuf_alloc(mp)) != NULL);
1480 mc->pkt_len = pktlen;
1482 /* Allocation of new indirect segment failed */
1483 if (unlikely (mi == NULL)) {
1484 rte_pktmbuf_free(mc);
1488 __rte_mbuf_sanity_check(mc, 1);
1493 * Adds given value to the refcnt of all packet mbuf segments.
1495 * Walks through all segments of given packet mbuf and for each of them
1496 * invokes rte_mbuf_refcnt_update().
1499 * The packet mbuf whose refcnt to be updated.
1501 * The value to add to the mbuf's segments refcnt.
1503 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
1505 __rte_mbuf_sanity_check(m, 1);
1508 rte_mbuf_refcnt_update(m, v);
1509 } while ((m = m->next) != NULL);
1513 * Get the headroom in a packet mbuf.
1518 * The length of the headroom.
1520 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
1522 __rte_mbuf_sanity_check(m, 0);
1527 * Get the tailroom of a packet mbuf.
1532 * The length of the tailroom.
1534 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
1536 __rte_mbuf_sanity_check(m, 0);
1537 return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
1542 * Get the last segment of the packet.
1547 * The last segment of the given mbuf.
1549 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
1551 __rte_mbuf_sanity_check(m, 1);
1552 while (m->next != NULL)
1558 * A macro that points to an offset into the data in the mbuf.
1560 * The returned pointer is cast to type t. Before using this
1561 * function, the user must ensure that the first segment is large
1562 * enough to accommodate its data.
1567 * The offset into the mbuf data.
1569 * The type to cast the result into.
1571 #define rte_pktmbuf_mtod_offset(m, t, o) \
1572 ((t)((char *)(m)->buf_addr + (m)->data_off + (o)))
1575 * A macro that points to the start of the data in the mbuf.
1577 * The returned pointer is cast to type t. Before using this
1578 * function, the user must ensure that the first segment is large
1579 * enough to accommodate its data.
1584 * The type to cast the result into.
1586 #define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0)
1589 * A macro that returns the IO address that points to an offset of the
1590 * start of the data in the mbuf
1595 * The offset into the data to calculate address from.
1597 #define rte_pktmbuf_iova_offset(m, o) \
1598 (rte_iova_t)((m)->buf_iova + (m)->data_off + (o))
1601 #define rte_pktmbuf_mtophys_offset(m, o) \
1602 rte_pktmbuf_iova_offset(m, o)
1605 * A macro that returns the IO address that points to the start of the
1611 #define rte_pktmbuf_iova(m) rte_pktmbuf_iova_offset(m, 0)
1614 #define rte_pktmbuf_mtophys(m) rte_pktmbuf_iova(m)
1617 * A macro that returns the length of the packet.
1619 * The value can be read or assigned.
1624 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
1627 * A macro that returns the length of the segment.
1629 * The value can be read or assigned.
1634 #define rte_pktmbuf_data_len(m) ((m)->data_len)
1637 * Prepend len bytes to an mbuf data area.
1639 * Returns a pointer to the new
1640 * data start address. If there is not enough headroom in the first
1641 * segment, the function will return NULL, without modifying the mbuf.
1646 * The amount of data to prepend (in bytes).
1648 * A pointer to the start of the newly prepended data, or
1649 * NULL if there is not enough headroom space in the first segment
1651 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
1654 __rte_mbuf_sanity_check(m, 1);
1656 if (unlikely(len > rte_pktmbuf_headroom(m)))
1660 m->data_len = (uint16_t)(m->data_len + len);
1661 m->pkt_len = (m->pkt_len + len);
1663 return (char *)m->buf_addr + m->data_off;
1667 * Append len bytes to an mbuf.
1669 * Append len bytes to an mbuf and return a pointer to the start address
1670 * of the added data. If there is not enough tailroom in the last
1671 * segment, the function will return NULL, without modifying the mbuf.
1676 * The amount of data to append (in bytes).
1678 * A pointer to the start of the newly appended data, or
1679 * NULL if there is not enough tailroom space in the last segment
1681 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
1684 struct rte_mbuf *m_last;
1686 __rte_mbuf_sanity_check(m, 1);
1688 m_last = rte_pktmbuf_lastseg(m);
1689 if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
1692 tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
1693 m_last->data_len = (uint16_t)(m_last->data_len + len);
1694 m->pkt_len = (m->pkt_len + len);
1695 return (char*) tail;
1699 * Remove len bytes at the beginning of an mbuf.
1701 * Returns a pointer to the start address of the new data area. If the
1702 * length is greater than the length of the first segment, then the
1703 * function will fail and return NULL, without modifying the mbuf.
1708 * The amount of data to remove (in bytes).
1710 * A pointer to the new start of the data.
1712 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
1714 __rte_mbuf_sanity_check(m, 1);
1716 if (unlikely(len > m->data_len))
1719 m->data_len = (uint16_t)(m->data_len - len);
1721 m->pkt_len = (m->pkt_len - len);
1722 return (char *)m->buf_addr + m->data_off;
1726 * Remove len bytes of data at the end of the mbuf.
1728 * If the length is greater than the length of the last segment, the
1729 * function will fail and return -1 without modifying the mbuf.
1734 * The amount of data to remove (in bytes).
1739 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
1741 struct rte_mbuf *m_last;
1743 __rte_mbuf_sanity_check(m, 1);
1745 m_last = rte_pktmbuf_lastseg(m);
1746 if (unlikely(len > m_last->data_len))
1749 m_last->data_len = (uint16_t)(m_last->data_len - len);
1750 m->pkt_len = (m->pkt_len - len);
1755 * Test if mbuf data is contiguous.
1760 * - 1, if all data is contiguous (one segment).
1761 * - 0, if there is several segments.
1763 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
1765 __rte_mbuf_sanity_check(m, 1);
1766 return !!(m->nb_segs == 1);
1770 * @internal used by rte_pktmbuf_read().
1772 const void *__rte_pktmbuf_read(const struct rte_mbuf *m, uint32_t off,
1773 uint32_t len, void *buf);
1776 * Read len data bytes in a mbuf at specified offset.
1778 * If the data is contiguous, return the pointer in the mbuf data, else
1779 * copy the data in the buffer provided by the user and return its
1783 * The pointer to the mbuf.
1785 * The offset of the data in the mbuf.
1787 * The amount of bytes to read.
1789 * The buffer where data is copied if it is not contiguous in mbuf
1790 * data. Its length should be at least equal to the len parameter.
1792 * The pointer to the data, either in the mbuf if it is contiguous,
1793 * or in the user buffer. If mbuf is too small, NULL is returned.
1795 static inline const void *rte_pktmbuf_read(const struct rte_mbuf *m,
1796 uint32_t off, uint32_t len, void *buf)
1798 if (likely(off + len <= rte_pktmbuf_data_len(m)))
1799 return rte_pktmbuf_mtod_offset(m, char *, off);
1801 return __rte_pktmbuf_read(m, off, len, buf);
1805 * Chain an mbuf to another, thereby creating a segmented packet.
1807 * Note: The implementation will do a linear walk over the segments to find
1808 * the tail entry. For cases when there are many segments, it's better to
1809 * chain the entries manually.
1812 * The head of the mbuf chain (the first packet)
1814 * The mbuf to put last in the chain
1818 * - -EOVERFLOW, if the chain segment limit exceeded
1820 static inline int rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail)
1822 struct rte_mbuf *cur_tail;
1824 /* Check for number-of-segments-overflow */
1825 if (head->nb_segs + tail->nb_segs > RTE_MBUF_MAX_NB_SEGS)
1828 /* Chain 'tail' onto the old tail */
1829 cur_tail = rte_pktmbuf_lastseg(head);
1830 cur_tail->next = tail;
1832 /* accumulate number of segments and total length. */
1833 head->nb_segs += tail->nb_segs;
1834 head->pkt_len += tail->pkt_len;
1836 /* pkt_len is only set in the head */
1837 tail->pkt_len = tail->data_len;
1843 * Validate general requirements for Tx offload in mbuf.
1845 * This function checks correctness and completeness of Tx offload settings.
1848 * The packet mbuf to be validated.
1850 * 0 if packet is valid
1853 rte_validate_tx_offload(const struct rte_mbuf *m)
1855 uint64_t ol_flags = m->ol_flags;
1856 uint64_t inner_l3_offset = m->l2_len;
1858 /* Does packet set any of available offloads? */
1859 if (!(ol_flags & PKT_TX_OFFLOAD_MASK))
1862 if (ol_flags & PKT_TX_OUTER_IP_CKSUM)
1863 inner_l3_offset += m->outer_l2_len + m->outer_l3_len;
1865 /* Headers are fragmented */
1866 if (rte_pktmbuf_data_len(m) < inner_l3_offset + m->l3_len + m->l4_len)
1869 /* IP checksum can be counted only for IPv4 packet */
1870 if ((ol_flags & PKT_TX_IP_CKSUM) && (ol_flags & PKT_TX_IPV6))
1873 /* IP type not set when required */
1874 if (ol_flags & (PKT_TX_L4_MASK | PKT_TX_TCP_SEG))
1875 if (!(ol_flags & (PKT_TX_IPV4 | PKT_TX_IPV6)))
1878 /* Check requirements for TSO packet */
1879 if (ol_flags & PKT_TX_TCP_SEG)
1880 if ((m->tso_segsz == 0) ||
1881 ((ol_flags & PKT_TX_IPV4) &&
1882 !(ol_flags & PKT_TX_IP_CKSUM)))
1885 /* PKT_TX_OUTER_IP_CKSUM set for non outer IPv4 packet. */
1886 if ((ol_flags & PKT_TX_OUTER_IP_CKSUM) &&
1887 !(ol_flags & PKT_TX_OUTER_IPV4))
1894 * Linearize data in mbuf.
1896 * This function moves the mbuf data in the first segment if there is enough
1897 * tailroom. The subsequent segments are unchained and freed.
1906 rte_pktmbuf_linearize(struct rte_mbuf *mbuf)
1908 int seg_len, copy_len;
1910 struct rte_mbuf *m_next;
1913 if (rte_pktmbuf_is_contiguous(mbuf))
1916 /* Extend first segment to the total packet length */
1917 copy_len = rte_pktmbuf_pkt_len(mbuf) - rte_pktmbuf_data_len(mbuf);
1919 if (unlikely(copy_len > rte_pktmbuf_tailroom(mbuf)))
1922 buffer = rte_pktmbuf_mtod_offset(mbuf, char *, mbuf->data_len);
1923 mbuf->data_len = (uint16_t)(mbuf->pkt_len);
1925 /* Append data from next segments to the first one */
1930 seg_len = rte_pktmbuf_data_len(m);
1931 rte_memcpy(buffer, rte_pktmbuf_mtod(m, char *), seg_len);
1934 rte_pktmbuf_free_seg(m);
1945 * Dump an mbuf structure to a file.
1947 * Dump all fields for the given packet mbuf and all its associated
1948 * segments (in the case of a chained buffer).
1951 * A pointer to a file for output
1955 * If dump_len != 0, also dump the "dump_len" first data bytes of
1958 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
1964 #endif /* _RTE_MBUF_H_ */