1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation.
3 * Copyright 2014 6WIND S.A.
13 * The mbuf library provides the ability to create and destroy buffers
14 * that may be used by the RTE application to store message
15 * buffers. The message buffers are stored in a mempool, using the
16 * RTE mempool library.
18 * The preferred way to create a mbuf pool is to use
19 * rte_pktmbuf_pool_create(). However, in some situations, an
20 * application may want to have more control (ex: populate the pool with
21 * specific memory), in this case it is possible to use functions from
22 * rte_mempool. See how rte_pktmbuf_pool_create() is implemented for
25 * This library provides an API to allocate/free packet mbufs, which are
26 * used to carry network packets.
28 * To understand the concepts of packet buffers or mbufs, you
29 * should read "TCP/IP Illustrated, Volume 2: The Implementation,
30 * Addison-Wesley, 1995, ISBN 0-201-63354-X from Richard Stevens"
31 * http://www.kohala.com/start/tcpipiv2.html
35 #include <rte_compat.h>
36 #include <rte_common.h>
37 #include <rte_config.h>
38 #include <rte_mempool.h>
39 #include <rte_memory.h>
40 #include <rte_atomic.h>
41 #include <rte_prefetch.h>
42 #include <rte_branch_prediction.h>
43 #include <rte_mbuf_ptype.h>
50 * Packet Offload Features Flags. It also carry packet type information.
51 * Critical resources. Both rx/tx shared these bits. Be cautious on any change
53 * - RX flags start at bit position zero, and get added to the left of previous
55 * - The most-significant 3 bits are reserved for generic mbuf flags
56 * - TX flags therefore start at bit position 60 (i.e. 63-3), and new flags get
57 * added to the right of the previously defined flags i.e. they should count
58 * downwards, not upwards.
60 * Keep these flags synchronized with rte_get_rx_ol_flag_name() and
61 * rte_get_tx_ol_flag_name().
65 * The RX packet is a 802.1q VLAN packet, and the tci has been
66 * saved in in mbuf->vlan_tci.
67 * If the flag PKT_RX_VLAN_STRIPPED is also present, the VLAN
68 * header has been stripped from mbuf data, else it is still
71 #define PKT_RX_VLAN (1ULL << 0)
73 #define PKT_RX_RSS_HASH (1ULL << 1) /**< RX packet with RSS hash result. */
74 #define PKT_RX_FDIR (1ULL << 2) /**< RX packet with FDIR match indicate. */
78 * Checking this flag alone is deprecated: check the 2 bits of
79 * PKT_RX_L4_CKSUM_MASK.
80 * This flag was set when the L4 checksum of a packet was detected as
81 * wrong by the hardware.
83 #define PKT_RX_L4_CKSUM_BAD (1ULL << 3)
87 * Checking this flag alone is deprecated: check the 2 bits of
88 * PKT_RX_IP_CKSUM_MASK.
89 * This flag was set when the IP checksum of a packet was detected as
90 * wrong by the hardware.
92 #define PKT_RX_IP_CKSUM_BAD (1ULL << 4)
94 #define PKT_RX_EIP_CKSUM_BAD (1ULL << 5) /**< External IP header checksum error. */
97 * A vlan has been stripped by the hardware and its tci is saved in
98 * mbuf->vlan_tci. This can only happen if vlan stripping is enabled
99 * in the RX configuration of the PMD.
100 * When PKT_RX_VLAN_STRIPPED is set, PKT_RX_VLAN must also be set.
102 #define PKT_RX_VLAN_STRIPPED (1ULL << 6)
105 * Mask of bits used to determine the status of RX IP checksum.
106 * - PKT_RX_IP_CKSUM_UNKNOWN: no information about the RX IP checksum
107 * - PKT_RX_IP_CKSUM_BAD: the IP checksum in the packet is wrong
108 * - PKT_RX_IP_CKSUM_GOOD: the IP checksum in the packet is valid
109 * - PKT_RX_IP_CKSUM_NONE: the IP checksum is not correct in the packet
110 * data, but the integrity of the IP header is verified.
112 #define PKT_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7))
114 #define PKT_RX_IP_CKSUM_UNKNOWN 0
115 #define PKT_RX_IP_CKSUM_BAD (1ULL << 4)
116 #define PKT_RX_IP_CKSUM_GOOD (1ULL << 7)
117 #define PKT_RX_IP_CKSUM_NONE ((1ULL << 4) | (1ULL << 7))
120 * Mask of bits used to determine the status of RX L4 checksum.
121 * - PKT_RX_L4_CKSUM_UNKNOWN: no information about the RX L4 checksum
122 * - PKT_RX_L4_CKSUM_BAD: the L4 checksum in the packet is wrong
123 * - PKT_RX_L4_CKSUM_GOOD: the L4 checksum in the packet is valid
124 * - PKT_RX_L4_CKSUM_NONE: the L4 checksum is not correct in the packet
125 * data, but the integrity of the L4 data is verified.
127 #define PKT_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8))
129 #define PKT_RX_L4_CKSUM_UNKNOWN 0
130 #define PKT_RX_L4_CKSUM_BAD (1ULL << 3)
131 #define PKT_RX_L4_CKSUM_GOOD (1ULL << 8)
132 #define PKT_RX_L4_CKSUM_NONE ((1ULL << 3) | (1ULL << 8))
134 #define PKT_RX_IEEE1588_PTP (1ULL << 9) /**< RX IEEE1588 L2 Ethernet PT Packet. */
135 #define PKT_RX_IEEE1588_TMST (1ULL << 10) /**< RX IEEE1588 L2/L4 timestamped packet.*/
136 #define PKT_RX_FDIR_ID (1ULL << 13) /**< FD id reported if FDIR match. */
137 #define PKT_RX_FDIR_FLX (1ULL << 14) /**< Flexible bytes reported if FDIR match. */
140 * The 2 vlans have been stripped by the hardware and their tci are
141 * saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer).
142 * This can only happen if vlan stripping is enabled in the RX
143 * configuration of the PMD. If this flag is set,
144 * When PKT_RX_QINQ_STRIPPED is set, the flags (PKT_RX_VLAN |
145 * PKT_RX_VLAN_STRIPPED | PKT_RX_QINQ) must also be set.
147 #define PKT_RX_QINQ_STRIPPED (1ULL << 15)
150 * When packets are coalesced by a hardware or virtual driver, this flag
151 * can be set in the RX mbuf, meaning that the m->tso_segsz field is
152 * valid and is set to the segment size of original packets.
154 #define PKT_RX_LRO (1ULL << 16)
157 * Indicate that the timestamp field in the mbuf is valid.
159 #define PKT_RX_TIMESTAMP (1ULL << 17)
162 * Indicate that security offload processing was applied on the RX packet.
164 #define PKT_RX_SEC_OFFLOAD (1ULL << 18)
167 * Indicate that security offload processing failed on the RX packet.
169 #define PKT_RX_SEC_OFFLOAD_FAILED (1ULL << 19)
172 * The RX packet is a double VLAN, and the outer tci has been
173 * saved in in mbuf->vlan_tci_outer.
174 * If the flag PKT_RX_QINQ_STRIPPED is also present, both VLANs
175 * headers have been stripped from mbuf data, else they are still
178 #define PKT_RX_QINQ (1ULL << 20)
180 /* add new RX flags here */
182 /* add new TX flags here */
185 * UDP Fragmentation Offload flag. This flag is used for enabling UDP
186 * fragmentation in SW or in HW. When use UFO, mbuf->tso_segsz is used
187 * to store the MSS of UDP fragments.
189 #define PKT_TX_UDP_SEG (1ULL << 42)
192 * Request security offload processing on the TX packet.
194 #define PKT_TX_SEC_OFFLOAD (1ULL << 43)
197 * Offload the MACsec. This flag must be set by the application to enable
198 * this offload feature for a packet to be transmitted.
200 #define PKT_TX_MACSEC (1ULL << 44)
203 * Bits 45:48 used for the tunnel type.
204 * When doing Tx offload like TSO or checksum, the HW needs to configure the
205 * tunnel type into the HW descriptors.
207 #define PKT_TX_TUNNEL_VXLAN (0x1ULL << 45)
208 #define PKT_TX_TUNNEL_GRE (0x2ULL << 45)
209 #define PKT_TX_TUNNEL_IPIP (0x3ULL << 45)
210 #define PKT_TX_TUNNEL_GENEVE (0x4ULL << 45)
211 /**< TX packet with MPLS-in-UDP RFC 7510 header. */
212 #define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45)
213 /* add new TX TUNNEL type here */
214 #define PKT_TX_TUNNEL_MASK (0xFULL << 45)
217 * Second VLAN insertion (QinQ) flag.
219 #define PKT_TX_QINQ (1ULL << 49) /**< TX packet with double VLAN inserted. */
220 /* this old name is deprecated */
221 #define PKT_TX_QINQ_PKT PKT_TX_QINQ
224 * TCP segmentation offload. To enable this offload feature for a
225 * packet to be transmitted on hardware supporting TSO:
226 * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies
228 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
229 * - if it's IPv4, set the PKT_TX_IP_CKSUM flag and write the IP checksum
231 * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz
232 * - calculate the pseudo header checksum without taking ip_len in account,
233 * and set it in the TCP header. Refer to rte_ipv4_phdr_cksum() and
234 * rte_ipv6_phdr_cksum() that can be used as helpers.
236 #define PKT_TX_TCP_SEG (1ULL << 50)
238 #define PKT_TX_IEEE1588_TMST (1ULL << 51) /**< TX IEEE1588 packet to timestamp. */
241 * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved,
242 * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware
243 * L4 checksum offload, the user needs to:
244 * - fill l2_len and l3_len in mbuf
245 * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM
246 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
247 * - calculate the pseudo header checksum and set it in the L4 header (only
248 * for TCP or UDP). See rte_ipv4_phdr_cksum() and rte_ipv6_phdr_cksum().
249 * For SCTP, set the crc field to 0.
251 #define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */
252 #define PKT_TX_TCP_CKSUM (1ULL << 52) /**< TCP cksum of TX pkt. computed by NIC. */
253 #define PKT_TX_SCTP_CKSUM (2ULL << 52) /**< SCTP cksum of TX pkt. computed by NIC. */
254 #define PKT_TX_UDP_CKSUM (3ULL << 52) /**< UDP cksum of TX pkt. computed by NIC. */
255 #define PKT_TX_L4_MASK (3ULL << 52) /**< Mask for L4 cksum offload request. */
258 * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should
259 * also be set by the application, although a PMD will only check
261 * - set the IP checksum field in the packet to 0
262 * - fill the mbuf offload information: l2_len, l3_len
264 #define PKT_TX_IP_CKSUM (1ULL << 54)
267 * Packet is IPv4. This flag must be set when using any offload feature
268 * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4
269 * packet. If the packet is a tunneled packet, this flag is related to
272 #define PKT_TX_IPV4 (1ULL << 55)
275 * Packet is IPv6. This flag must be set when using an offload feature
276 * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6
277 * packet. If the packet is a tunneled packet, this flag is related to
280 #define PKT_TX_IPV6 (1ULL << 56)
283 * TX packet is a 802.1q VLAN packet.
285 #define PKT_TX_VLAN (1ULL << 57)
286 /* this old name is deprecated */
287 #define PKT_TX_VLAN_PKT PKT_TX_VLAN
290 * Offload the IP checksum of an external header in the hardware. The
291 * flag PKT_TX_OUTER_IPV4 should also be set by the application, alto ugh
292 * a PMD will only check PKT_TX_IP_CKSUM. The IP checksum field in the
293 * packet must be set to 0.
294 * - set the outer IP checksum field in the packet to 0
295 * - fill the mbuf offload information: outer_l2_len, outer_l3_len
297 #define PKT_TX_OUTER_IP_CKSUM (1ULL << 58)
300 * Packet outer header is IPv4. This flag must be set when using any
301 * outer offload feature (L3 or L4 checksum) to tell the NIC that the
302 * outer header of the tunneled packet is an IPv4 packet.
304 #define PKT_TX_OUTER_IPV4 (1ULL << 59)
307 * Packet outer header is IPv6. This flag must be set when using any
308 * outer offload feature (L4 checksum) to tell the NIC that the outer
309 * header of the tunneled packet is an IPv6 packet.
311 #define PKT_TX_OUTER_IPV6 (1ULL << 60)
314 * Bitmask of all supported packet Tx offload features flags,
315 * which can be set for packet.
317 #define PKT_TX_OFFLOAD_MASK ( \
320 PKT_TX_OUTER_IP_CKSUM | \
322 PKT_TX_IEEE1588_TMST | \
325 PKT_TX_TUNNEL_MASK | \
329 #define __RESERVED (1ULL << 61) /**< reserved for future mbuf use */
331 #define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */
333 /* Use final bit of flags to indicate a control mbuf */
334 #define CTRL_MBUF_FLAG (1ULL << 63) /**< Mbuf contains control data */
336 /** Alignment constraint of mbuf private area. */
337 #define RTE_MBUF_PRIV_ALIGN 8
340 * Get the name of a RX offload flag
343 * The mask describing the flag.
345 * The name of this flag, or NULL if it's not a valid RX flag.
347 const char *rte_get_rx_ol_flag_name(uint64_t mask);
350 * Dump the list of RX offload flags in a buffer
353 * The mask describing the RX flags.
357 * The length of the buffer.
359 * 0 on success, (-1) on error.
361 int rte_get_rx_ol_flag_list(uint64_t mask, char *buf, size_t buflen);
364 * Get the name of a TX offload flag
367 * The mask describing the flag. Usually only one bit must be set.
368 * Several bits can be given if they belong to the same mask.
369 * Ex: PKT_TX_L4_MASK.
371 * The name of this flag, or NULL if it's not a valid TX flag.
373 const char *rte_get_tx_ol_flag_name(uint64_t mask);
376 * Dump the list of TX offload flags in a buffer
379 * The mask describing the TX flags.
383 * The length of the buffer.
385 * 0 on success, (-1) on error.
387 int rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen);
390 * Some NICs need at least 2KB buffer to RX standard Ethernet frame without
391 * splitting it into multiple segments.
392 * So, for mbufs that planned to be involved into RX/TX, the recommended
393 * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM.
395 #define RTE_MBUF_DEFAULT_DATAROOM 2048
396 #define RTE_MBUF_DEFAULT_BUF_SIZE \
397 (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM)
399 /* define a set of marker types that can be used to refer to set points in the
402 typedef void *MARKER[0]; /**< generic marker for a point in a structure */
404 typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */
406 typedef uint64_t MARKER64[0]; /**< marker that allows us to overwrite 8 bytes
407 * with a single assignment */
410 * The generic rte_mbuf, containing a packet mbuf.
415 void *buf_addr; /**< Virtual address of segment buffer. */
417 * Physical address of segment buffer.
418 * Force alignment to 8-bytes, so as to ensure we have the exact
419 * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes
420 * working on vector drivers easier.
425 rte_iova_t buf_physaddr; /**< deprecated */
426 } __rte_aligned(sizeof(rte_iova_t));
428 /* next 8 bytes are initialised on RX descriptor rearm */
433 * Reference counter. Its size should at least equal to the size
434 * of port field (16 bits), to support zero-copy broadcast.
435 * It should only be accessed using the following functions:
436 * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
437 * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
438 * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
443 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
444 uint16_t refcnt; /**< Non-atomically accessed refcnt */
446 uint16_t nb_segs; /**< Number of segments. */
448 /** Input port (16 bits to support more than 256 virtual ports). */
451 uint64_t ol_flags; /**< Offload features. */
453 /* remaining bytes are set on RX when pulling packet from descriptor */
454 MARKER rx_descriptor_fields1;
457 * The packet type, which is the combination of outer/inner L2, L3, L4
458 * and tunnel types. The packet_type is about data really present in the
459 * mbuf. Example: if vlan stripping is enabled, a received vlan packet
460 * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the
461 * vlan is stripped from the data.
465 uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */
467 uint32_t l2_type:4; /**< (Outer) L2 type. */
468 uint32_t l3_type:4; /**< (Outer) L3 type. */
469 uint32_t l4_type:4; /**< (Outer) L4 type. */
470 uint32_t tun_type:4; /**< Tunnel type. */
473 uint8_t inner_esp_next_proto;
474 /**< ESP next protocol type, valid if
475 * RTE_PTYPE_TUNNEL_ESP tunnel type is set
480 uint8_t inner_l2_type:4;
481 /**< Inner L2 type. */
482 uint8_t inner_l3_type:4;
483 /**< Inner L3 type. */
486 uint32_t inner_l4_type:4; /**< Inner L4 type. */
490 uint32_t pkt_len; /**< Total pkt len: sum of all segments. */
491 uint16_t data_len; /**< Amount of data in segment buffer. */
492 /** VLAN TCI (CPU order), valid if PKT_RX_VLAN is set. */
496 uint32_t rss; /**< RSS hash result if RSS enabled */
505 /**< Second 4 flexible bytes */
508 /**< First 4 flexible bytes or FD ID, dependent on
509 PKT_RX_FDIR_* flag in ol_flags. */
510 } fdir; /**< Filter identifier if FDIR enabled */
514 } sched; /**< Hierarchical scheduler */
515 uint32_t usr; /**< User defined tags. See rte_distributor_process() */
516 } hash; /**< hash information */
518 /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ is set. */
519 uint16_t vlan_tci_outer;
521 uint16_t buf_len; /**< Length of segment buffer. */
523 /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference
524 * are not normalized but are always the same for a given port.
528 /* second cache line - fields only used in slow path or on TX */
529 MARKER cacheline1 __rte_cache_min_aligned;
533 void *userdata; /**< Can be used for external metadata */
534 uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */
537 struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
538 struct rte_mbuf *next; /**< Next segment of scattered packet. */
540 /* fields to support TX offloads */
543 uint64_t tx_offload; /**< combined for easy fetch */
547 /**< L2 (MAC) Header Length for non-tunneling pkt.
548 * Outer_L4_len + ... + Inner_L2_len for tunneling pkt.
550 uint64_t l3_len:9; /**< L3 (IP) Header Length. */
551 uint64_t l4_len:8; /**< L4 (TCP/UDP) Header Length. */
552 uint64_t tso_segsz:16; /**< TCP TSO segment size */
554 /* fields for TX offloading of tunnels */
555 uint64_t outer_l3_len:9; /**< Outer L3 (IP) Hdr Length. */
556 uint64_t outer_l2_len:7; /**< Outer L2 (MAC) Hdr Length. */
558 /* uint64_t unused:8; */
562 /** Size of the application private data. In case of an indirect
563 * mbuf, it stores the direct mbuf private data size. */
566 /** Timesync flags for use with IEEE1588. */
569 /** Sequence number. See also rte_reorder_insert(). */
572 } __rte_cache_aligned;
574 /**< Maximum number of nb_segs allowed. */
575 #define RTE_MBUF_MAX_NB_SEGS UINT16_MAX
578 * Prefetch the first part of the mbuf
580 * The first 64 bytes of the mbuf corresponds to fields that are used early
581 * in the receive path. If the cache line of the architecture is higher than
582 * 64B, the second part will also be prefetched.
585 * The pointer to the mbuf.
588 rte_mbuf_prefetch_part1(struct rte_mbuf *m)
590 rte_prefetch0(&m->cacheline0);
594 * Prefetch the second part of the mbuf
596 * The next 64 bytes of the mbuf corresponds to fields that are used in the
597 * transmit path. If the cache line of the architecture is higher than 64B,
598 * this function does nothing as it is expected that the full mbuf is
602 * The pointer to the mbuf.
605 rte_mbuf_prefetch_part2(struct rte_mbuf *m)
607 #if RTE_CACHE_LINE_SIZE == 64
608 rte_prefetch0(&m->cacheline1);
615 static inline uint16_t rte_pktmbuf_priv_size(struct rte_mempool *mp);
618 * Return the IO address of the beginning of the mbuf data
621 * The pointer to the mbuf.
623 * The IO address of the beginning of the mbuf data
625 static inline rte_iova_t
626 rte_mbuf_data_iova(const struct rte_mbuf *mb)
628 return mb->buf_iova + mb->data_off;
632 static inline phys_addr_t
633 rte_mbuf_data_dma_addr(const struct rte_mbuf *mb)
635 return rte_mbuf_data_iova(mb);
639 * Return the default IO address of the beginning of the mbuf data
641 * This function is used by drivers in their receive function, as it
642 * returns the location where data should be written by the NIC, taking
643 * the default headroom in account.
646 * The pointer to the mbuf.
648 * The IO address of the beginning of the mbuf data
650 static inline rte_iova_t
651 rte_mbuf_data_iova_default(const struct rte_mbuf *mb)
653 return mb->buf_iova + RTE_PKTMBUF_HEADROOM;
657 static inline phys_addr_t
658 rte_mbuf_data_dma_addr_default(const struct rte_mbuf *mb)
660 return rte_mbuf_data_iova_default(mb);
664 * Return the mbuf owning the data buffer address of an indirect mbuf.
667 * The pointer to the indirect mbuf.
669 * The address of the direct mbuf corresponding to buffer_addr.
671 static inline struct rte_mbuf *
672 rte_mbuf_from_indirect(struct rte_mbuf *mi)
674 return (struct rte_mbuf *)RTE_PTR_SUB(mi->buf_addr, sizeof(*mi) + mi->priv_size);
678 * Return the buffer address embedded in the given mbuf.
681 * The pointer to the mbuf.
683 * The address of the data buffer owned by the mbuf.
686 rte_mbuf_to_baddr(struct rte_mbuf *md)
689 buffer_addr = (char *)md + sizeof(*md) + rte_pktmbuf_priv_size(md->pool);
694 * Returns TRUE if given mbuf is indirect, or FALSE otherwise.
696 #define RTE_MBUF_INDIRECT(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF)
699 * Returns TRUE if given mbuf is direct, or FALSE otherwise.
701 #define RTE_MBUF_DIRECT(mb) (!RTE_MBUF_INDIRECT(mb))
704 * Private data in case of pktmbuf pool.
706 * A structure that contains some pktmbuf_pool-specific data that are
707 * appended after the mempool structure (in private data).
709 struct rte_pktmbuf_pool_private {
710 uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf. */
711 uint16_t mbuf_priv_size; /**< Size of private area in each mbuf. */
714 #ifdef RTE_LIBRTE_MBUF_DEBUG
716 /** check mbuf type in debug mode */
717 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
719 #else /* RTE_LIBRTE_MBUF_DEBUG */
721 /** check mbuf type in debug mode */
722 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
724 #endif /* RTE_LIBRTE_MBUF_DEBUG */
726 #ifdef RTE_MBUF_REFCNT_ATOMIC
729 * Reads the value of an mbuf's refcnt.
733 * Reference count number.
735 static inline uint16_t
736 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
738 return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
742 * Sets an mbuf's refcnt to a defined value.
749 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
751 rte_atomic16_set(&m->refcnt_atomic, new_value);
755 static inline uint16_t
756 __rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
758 return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
762 * Adds given value to an mbuf's refcnt and returns its new value.
766 * Value to add/subtract
770 static inline uint16_t
771 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
774 * The atomic_add is an expensive operation, so we don't want to
775 * call it in the case where we know we are the uniq holder of
776 * this mbuf (i.e. ref_cnt == 1). Otherwise, an atomic
777 * operation has to be used because concurrent accesses on the
778 * reference counter can occur.
780 if (likely(rte_mbuf_refcnt_read(m) == 1)) {
781 rte_mbuf_refcnt_set(m, 1 + value);
785 return __rte_mbuf_refcnt_update(m, value);
788 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
791 static inline uint16_t
792 __rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
794 m->refcnt = (uint16_t)(m->refcnt + value);
799 * Adds given value to an mbuf's refcnt and returns its new value.
801 static inline uint16_t
802 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
804 return __rte_mbuf_refcnt_update(m, value);
808 * Reads the value of an mbuf's refcnt.
810 static inline uint16_t
811 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
817 * Sets an mbuf's refcnt to the defined value.
820 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
822 m->refcnt = new_value;
825 #endif /* RTE_MBUF_REFCNT_ATOMIC */
828 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { \
835 * Sanity checks on an mbuf.
837 * Check the consistency of the given mbuf. The function will cause a
838 * panic if corruption is detected.
841 * The mbuf to be checked.
843 * True if the mbuf is a packet header, false if it is a sub-segment
844 * of a packet (in this case, some fields like nb_segs are not checked)
847 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
849 #define MBUF_RAW_ALLOC_CHECK(m) do { \
850 RTE_ASSERT(rte_mbuf_refcnt_read(m) == 1); \
851 RTE_ASSERT((m)->next == NULL); \
852 RTE_ASSERT((m)->nb_segs == 1); \
853 __rte_mbuf_sanity_check(m, 0); \
857 * Allocate an uninitialized mbuf from mempool *mp*.
859 * This function can be used by PMDs (especially in RX functions) to
860 * allocate an uninitialized mbuf. The driver is responsible of
861 * initializing all the required fields. See rte_pktmbuf_reset().
862 * For standard needs, prefer rte_pktmbuf_alloc().
864 * The caller can expect that the following fields of the mbuf structure
865 * are initialized: buf_addr, buf_iova, buf_len, refcnt=1, nb_segs=1,
866 * next=NULL, pool, priv_size. The other fields must be initialized
870 * The mempool from which mbuf is allocated.
872 * - The pointer to the new mbuf on success.
873 * - NULL if allocation failed.
875 static inline struct rte_mbuf *rte_mbuf_raw_alloc(struct rte_mempool *mp)
879 if (rte_mempool_get(mp, (void **)&m) < 0)
881 MBUF_RAW_ALLOC_CHECK(m);
886 * Put mbuf back into its original mempool.
888 * The caller must ensure that the mbuf is direct and properly
889 * reinitialized (refcnt=1, next=NULL, nb_segs=1), as done by
890 * rte_pktmbuf_prefree_seg().
892 * This function should be used with care, when optimization is
893 * required. For standard needs, prefer rte_pktmbuf_free() or
894 * rte_pktmbuf_free_seg().
897 * The mbuf to be freed.
899 static __rte_always_inline void
900 rte_mbuf_raw_free(struct rte_mbuf *m)
902 RTE_ASSERT(RTE_MBUF_DIRECT(m));
903 RTE_ASSERT(rte_mbuf_refcnt_read(m) == 1);
904 RTE_ASSERT(m->next == NULL);
905 RTE_ASSERT(m->nb_segs == 1);
906 __rte_mbuf_sanity_check(m, 0);
907 rte_mempool_put(m->pool, m);
910 /* compat with older versions */
913 __rte_mbuf_raw_free(struct rte_mbuf *m)
915 rte_mbuf_raw_free(m);
918 /* Operations on ctrl mbuf */
921 * The control mbuf constructor.
923 * This function initializes some fields in an mbuf structure that are
924 * not modified by the user once created (mbuf type, origin pool, buffer
925 * start address, and so on). This function is given as a callback function
926 * to rte_mempool_obj_iter() or rte_mempool_create() at pool creation time.
929 * The mempool from which the mbuf is allocated.
931 * A pointer that can be used by the user to retrieve useful information
932 * for mbuf initialization. This pointer is the opaque argument passed to
933 * rte_mempool_obj_iter() or rte_mempool_create().
935 * The mbuf to initialize.
937 * The index of the mbuf in the pool table.
939 void rte_ctrlmbuf_init(struct rte_mempool *mp, void *opaque_arg,
940 void *m, unsigned i);
943 * Allocate a new mbuf (type is ctrl) from mempool *mp*.
945 * This new mbuf is initialized with data pointing to the beginning of
946 * buffer, and with a length of zero.
949 * The mempool from which the mbuf is allocated.
951 * - The pointer to the new mbuf on success.
952 * - NULL if allocation failed.
954 #define rte_ctrlmbuf_alloc(mp) rte_pktmbuf_alloc(mp)
957 * Free a control mbuf back into its original mempool.
960 * The control mbuf to be freed.
962 #define rte_ctrlmbuf_free(m) rte_pktmbuf_free(m)
965 * A macro that returns the pointer to the carried data.
967 * The value that can be read or assigned.
972 #define rte_ctrlmbuf_data(m) ((char *)((m)->buf_addr) + (m)->data_off)
975 * A macro that returns the length of the carried data.
977 * The value that can be read or assigned.
982 #define rte_ctrlmbuf_len(m) rte_pktmbuf_data_len(m)
985 * Tests if an mbuf is a control mbuf
988 * The mbuf to be tested
990 * - True (1) if the mbuf is a control mbuf
991 * - False(0) otherwise
994 rte_is_ctrlmbuf(struct rte_mbuf *m)
996 return !!(m->ol_flags & CTRL_MBUF_FLAG);
999 /* Operations on pkt mbuf */
1002 * The packet mbuf constructor.
1004 * This function initializes some fields in the mbuf structure that are
1005 * not modified by the user once created (origin pool, buffer start
1006 * address, and so on). This function is given as a callback function to
1007 * rte_mempool_obj_iter() or rte_mempool_create() at pool creation time.
1010 * The mempool from which mbufs originate.
1012 * A pointer that can be used by the user to retrieve useful information
1013 * for mbuf initialization. This pointer is the opaque argument passed to
1014 * rte_mempool_obj_iter() or rte_mempool_create().
1016 * The mbuf to initialize.
1018 * The index of the mbuf in the pool table.
1020 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
1021 void *m, unsigned i);
1025 * A packet mbuf pool constructor.
1027 * This function initializes the mempool private data in the case of a
1028 * pktmbuf pool. This private data is needed by the driver. The
1029 * function must be called on the mempool before it is used, or it
1030 * can be given as a callback function to rte_mempool_create() at
1031 * pool creation. It can be extended by the user, for example, to
1032 * provide another packet size.
1035 * The mempool from which mbufs originate.
1037 * A pointer that can be used by the user to retrieve useful information
1038 * for mbuf initialization. This pointer is the opaque argument passed to
1039 * rte_mempool_create().
1041 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
1044 * Create a mbuf pool.
1046 * This function creates and initializes a packet mbuf pool. It is
1047 * a wrapper to rte_mempool functions.
1050 * The name of the mbuf pool.
1052 * The number of elements in the mbuf pool. The optimum size (in terms
1053 * of memory usage) for a mempool is when n is a power of two minus one:
1056 * Size of the per-core object cache. See rte_mempool_create() for
1059 * Size of application private are between the rte_mbuf structure
1060 * and the data buffer. This value must be aligned to RTE_MBUF_PRIV_ALIGN.
1061 * @param data_room_size
1062 * Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
1064 * The socket identifier where the memory should be allocated. The
1065 * value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
1068 * The pointer to the new allocated mempool, on success. NULL on error
1069 * with rte_errno set appropriately. Possible rte_errno values include:
1070 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
1071 * - E_RTE_SECONDARY - function was called from a secondary process instance
1072 * - EINVAL - cache size provided is too large, or priv_size is not aligned.
1073 * - ENOSPC - the maximum number of memzones has already been allocated
1074 * - EEXIST - a memzone with the same name already exists
1075 * - ENOMEM - no appropriate memory area found in which to create memzone
1077 struct rte_mempool *
1078 rte_pktmbuf_pool_create(const char *name, unsigned n,
1079 unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
1083 * Create a mbuf pool with a given mempool ops name
1085 * This function creates and initializes a packet mbuf pool. It is
1086 * a wrapper to rte_mempool functions.
1089 * The name of the mbuf pool.
1091 * The number of elements in the mbuf pool. The optimum size (in terms
1092 * of memory usage) for a mempool is when n is a power of two minus one:
1095 * Size of the per-core object cache. See rte_mempool_create() for
1098 * Size of application private are between the rte_mbuf structure
1099 * and the data buffer. This value must be aligned to RTE_MBUF_PRIV_ALIGN.
1100 * @param data_room_size
1101 * Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
1103 * The socket identifier where the memory should be allocated. The
1104 * value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
1107 * The mempool ops name to be used for this mempool instead of
1108 * default mempool. The value can be *NULL* to use default mempool.
1110 * The pointer to the new allocated mempool, on success. NULL on error
1111 * with rte_errno set appropriately. Possible rte_errno values include:
1112 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
1113 * - E_RTE_SECONDARY - function was called from a secondary process instance
1114 * - EINVAL - cache size provided is too large, or priv_size is not aligned.
1115 * - ENOSPC - the maximum number of memzones has already been allocated
1116 * - EEXIST - a memzone with the same name already exists
1117 * - ENOMEM - no appropriate memory area found in which to create memzone
1119 struct rte_mempool * __rte_experimental
1120 rte_pktmbuf_pool_create_by_ops(const char *name, unsigned int n,
1121 unsigned int cache_size, uint16_t priv_size, uint16_t data_room_size,
1122 int socket_id, const char *ops_name);
1125 * Get the data room size of mbufs stored in a pktmbuf_pool
1127 * The data room size is the amount of data that can be stored in a
1128 * mbuf including the headroom (RTE_PKTMBUF_HEADROOM).
1131 * The packet mbuf pool.
1133 * The data room size of mbufs stored in this mempool.
1135 static inline uint16_t
1136 rte_pktmbuf_data_room_size(struct rte_mempool *mp)
1138 struct rte_pktmbuf_pool_private *mbp_priv;
1140 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1141 return mbp_priv->mbuf_data_room_size;
1145 * Get the application private size of mbufs stored in a pktmbuf_pool
1147 * The private size of mbuf is a zone located between the rte_mbuf
1148 * structure and the data buffer where an application can store data
1149 * associated to a packet.
1152 * The packet mbuf pool.
1154 * The private size of mbufs stored in this mempool.
1156 static inline uint16_t
1157 rte_pktmbuf_priv_size(struct rte_mempool *mp)
1159 struct rte_pktmbuf_pool_private *mbp_priv;
1161 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1162 return mbp_priv->mbuf_priv_size;
1166 * Reset the data_off field of a packet mbuf to its default value.
1168 * The given mbuf must have only one segment, which should be empty.
1171 * The packet mbuf's data_off field has to be reset.
1173 static inline void rte_pktmbuf_reset_headroom(struct rte_mbuf *m)
1175 m->data_off = RTE_MIN(RTE_PKTMBUF_HEADROOM, (uint16_t)m->buf_len);
1179 * Reset the fields of a packet mbuf to their default values.
1181 * The given mbuf must have only one segment.
1184 * The packet mbuf to be resetted.
1186 #define MBUF_INVALID_PORT UINT16_MAX
1188 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
1194 m->vlan_tci_outer = 0;
1196 m->port = MBUF_INVALID_PORT;
1200 rte_pktmbuf_reset_headroom(m);
1203 __rte_mbuf_sanity_check(m, 1);
1207 * Allocate a new mbuf from a mempool.
1209 * This new mbuf contains one segment, which has a length of 0. The pointer
1210 * to data is initialized to have some bytes of headroom in the buffer
1211 * (if buffer size allows).
1214 * The mempool from which the mbuf is allocated.
1216 * - The pointer to the new mbuf on success.
1217 * - NULL if allocation failed.
1219 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
1222 if ((m = rte_mbuf_raw_alloc(mp)) != NULL)
1223 rte_pktmbuf_reset(m);
1228 * Allocate a bulk of mbufs, initialize refcnt and reset the fields to default
1232 * The mempool from which mbufs are allocated.
1234 * Array of pointers to mbufs
1239 * - -ENOENT: Not enough entries in the mempool; no mbufs are retrieved.
1241 static inline int rte_pktmbuf_alloc_bulk(struct rte_mempool *pool,
1242 struct rte_mbuf **mbufs, unsigned count)
1247 rc = rte_mempool_get_bulk(pool, (void **)mbufs, count);
1251 /* To understand duff's device on loop unwinding optimization, see
1252 * https://en.wikipedia.org/wiki/Duff's_device.
1253 * Here while() loop is used rather than do() while{} to avoid extra
1254 * check if count is zero.
1256 switch (count % 4) {
1258 while (idx != count) {
1259 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1260 rte_pktmbuf_reset(mbufs[idx]);
1264 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1265 rte_pktmbuf_reset(mbufs[idx]);
1269 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1270 rte_pktmbuf_reset(mbufs[idx]);
1274 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1275 rte_pktmbuf_reset(mbufs[idx]);
1284 * Attach packet mbuf to another packet mbuf.
1286 * After attachment we refer the mbuf we attached as 'indirect',
1287 * while mbuf we attached to as 'direct'.
1288 * The direct mbuf's reference counter is incremented.
1290 * Right now, not supported:
1291 * - attachment for already indirect mbuf (e.g. - mi has to be direct).
1292 * - mbuf we trying to attach (mi) is used by someone else
1293 * e.g. it's reference counter is greater then 1.
1296 * The indirect packet mbuf.
1298 * The packet mbuf we're attaching to.
1300 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *m)
1302 struct rte_mbuf *md;
1304 RTE_ASSERT(RTE_MBUF_DIRECT(mi) &&
1305 rte_mbuf_refcnt_read(mi) == 1);
1307 /* if m is not direct, get the mbuf that embeds the data */
1308 if (RTE_MBUF_DIRECT(m))
1311 md = rte_mbuf_from_indirect(m);
1313 rte_mbuf_refcnt_update(md, 1);
1314 mi->priv_size = m->priv_size;
1315 mi->buf_iova = m->buf_iova;
1316 mi->buf_addr = m->buf_addr;
1317 mi->buf_len = m->buf_len;
1319 mi->data_off = m->data_off;
1320 mi->data_len = m->data_len;
1322 mi->vlan_tci = m->vlan_tci;
1323 mi->vlan_tci_outer = m->vlan_tci_outer;
1324 mi->tx_offload = m->tx_offload;
1328 mi->pkt_len = mi->data_len;
1330 mi->ol_flags = m->ol_flags | IND_ATTACHED_MBUF;
1331 mi->packet_type = m->packet_type;
1332 mi->timestamp = m->timestamp;
1334 __rte_mbuf_sanity_check(mi, 1);
1335 __rte_mbuf_sanity_check(m, 0);
1339 * Detach an indirect packet mbuf.
1341 * - restore original mbuf address and length values.
1342 * - reset pktmbuf data and data_len to their default values.
1343 * - decrement the direct mbuf's reference counter. When the
1344 * reference counter becomes 0, the direct mbuf is freed.
1346 * All other fields of the given packet mbuf will be left intact.
1349 * The indirect attached packet mbuf.
1351 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
1353 struct rte_mbuf *md = rte_mbuf_from_indirect(m);
1354 struct rte_mempool *mp = m->pool;
1355 uint32_t mbuf_size, buf_len, priv_size;
1357 priv_size = rte_pktmbuf_priv_size(mp);
1358 mbuf_size = sizeof(struct rte_mbuf) + priv_size;
1359 buf_len = rte_pktmbuf_data_room_size(mp);
1361 m->priv_size = priv_size;
1362 m->buf_addr = (char *)m + mbuf_size;
1363 m->buf_iova = rte_mempool_virt2iova(m) + mbuf_size;
1364 m->buf_len = (uint16_t)buf_len;
1365 rte_pktmbuf_reset_headroom(m);
1369 if (rte_mbuf_refcnt_update(md, -1) == 0) {
1372 rte_mbuf_refcnt_set(md, 1);
1373 rte_mbuf_raw_free(md);
1378 * Decrease reference counter and unlink a mbuf segment
1380 * This function does the same than a free, except that it does not
1381 * return the segment to its pool.
1382 * It decreases the reference counter, and if it reaches 0, it is
1383 * detached from its parent for an indirect mbuf.
1386 * The mbuf to be unlinked
1388 * - (m) if it is the last reference. It can be recycled or freed.
1389 * - (NULL) if the mbuf still has remaining references on it.
1391 static __rte_always_inline struct rte_mbuf *
1392 rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
1394 __rte_mbuf_sanity_check(m, 0);
1396 if (likely(rte_mbuf_refcnt_read(m) == 1)) {
1398 if (RTE_MBUF_INDIRECT(m))
1399 rte_pktmbuf_detach(m);
1401 if (m->next != NULL) {
1408 } else if (__rte_mbuf_refcnt_update(m, -1) == 0) {
1410 if (RTE_MBUF_INDIRECT(m))
1411 rte_pktmbuf_detach(m);
1413 if (m->next != NULL) {
1417 rte_mbuf_refcnt_set(m, 1);
1424 /* deprecated, replaced by rte_pktmbuf_prefree_seg() */
1426 static inline struct rte_mbuf *
1427 __rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
1429 return rte_pktmbuf_prefree_seg(m);
1433 * Free a segment of a packet mbuf into its original mempool.
1435 * Free an mbuf, without parsing other segments in case of chained
1439 * The packet mbuf segment to be freed.
1441 static __rte_always_inline void
1442 rte_pktmbuf_free_seg(struct rte_mbuf *m)
1444 m = rte_pktmbuf_prefree_seg(m);
1445 if (likely(m != NULL))
1446 rte_mbuf_raw_free(m);
1450 * Free a packet mbuf back into its original mempool.
1452 * Free an mbuf, and all its segments in case of chained buffers. Each
1453 * segment is added back into its original mempool.
1456 * The packet mbuf to be freed. If NULL, the function does nothing.
1458 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
1460 struct rte_mbuf *m_next;
1463 __rte_mbuf_sanity_check(m, 1);
1467 rte_pktmbuf_free_seg(m);
1473 * Creates a "clone" of the given packet mbuf.
1475 * Walks through all segments of the given packet mbuf, and for each of them:
1476 * - Creates a new packet mbuf from the given pool.
1477 * - Attaches newly created mbuf to the segment.
1478 * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
1479 * from the original packet mbuf.
1482 * The packet mbuf to be cloned.
1484 * The mempool from which the "clone" mbufs are allocated.
1486 * - The pointer to the new "clone" mbuf on success.
1487 * - NULL if allocation fails.
1489 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
1490 struct rte_mempool *mp)
1492 struct rte_mbuf *mc, *mi, **prev;
1496 if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
1501 pktlen = md->pkt_len;
1506 rte_pktmbuf_attach(mi, md);
1509 } while ((md = md->next) != NULL &&
1510 (mi = rte_pktmbuf_alloc(mp)) != NULL);
1514 mc->pkt_len = pktlen;
1516 /* Allocation of new indirect segment failed */
1517 if (unlikely (mi == NULL)) {
1518 rte_pktmbuf_free(mc);
1522 __rte_mbuf_sanity_check(mc, 1);
1527 * Adds given value to the refcnt of all packet mbuf segments.
1529 * Walks through all segments of given packet mbuf and for each of them
1530 * invokes rte_mbuf_refcnt_update().
1533 * The packet mbuf whose refcnt to be updated.
1535 * The value to add to the mbuf's segments refcnt.
1537 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
1539 __rte_mbuf_sanity_check(m, 1);
1542 rte_mbuf_refcnt_update(m, v);
1543 } while ((m = m->next) != NULL);
1547 * Get the headroom in a packet mbuf.
1552 * The length of the headroom.
1554 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
1556 __rte_mbuf_sanity_check(m, 0);
1561 * Get the tailroom of a packet mbuf.
1566 * The length of the tailroom.
1568 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
1570 __rte_mbuf_sanity_check(m, 0);
1571 return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
1576 * Get the last segment of the packet.
1581 * The last segment of the given mbuf.
1583 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
1585 __rte_mbuf_sanity_check(m, 1);
1586 while (m->next != NULL)
1592 * A macro that points to an offset into the data in the mbuf.
1594 * The returned pointer is cast to type t. Before using this
1595 * function, the user must ensure that the first segment is large
1596 * enough to accommodate its data.
1601 * The offset into the mbuf data.
1603 * The type to cast the result into.
1605 #define rte_pktmbuf_mtod_offset(m, t, o) \
1606 ((t)((char *)(m)->buf_addr + (m)->data_off + (o)))
1609 * A macro that points to the start of the data in the mbuf.
1611 * The returned pointer is cast to type t. Before using this
1612 * function, the user must ensure that the first segment is large
1613 * enough to accommodate its data.
1618 * The type to cast the result into.
1620 #define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0)
1623 * A macro that returns the IO address that points to an offset of the
1624 * start of the data in the mbuf
1629 * The offset into the data to calculate address from.
1631 #define rte_pktmbuf_iova_offset(m, o) \
1632 (rte_iova_t)((m)->buf_iova + (m)->data_off + (o))
1635 #define rte_pktmbuf_mtophys_offset(m, o) \
1636 rte_pktmbuf_iova_offset(m, o)
1639 * A macro that returns the IO address that points to the start of the
1645 #define rte_pktmbuf_iova(m) rte_pktmbuf_iova_offset(m, 0)
1648 #define rte_pktmbuf_mtophys(m) rte_pktmbuf_iova(m)
1651 * A macro that returns the length of the packet.
1653 * The value can be read or assigned.
1658 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
1661 * A macro that returns the length of the segment.
1663 * The value can be read or assigned.
1668 #define rte_pktmbuf_data_len(m) ((m)->data_len)
1671 * Prepend len bytes to an mbuf data area.
1673 * Returns a pointer to the new
1674 * data start address. If there is not enough headroom in the first
1675 * segment, the function will return NULL, without modifying the mbuf.
1680 * The amount of data to prepend (in bytes).
1682 * A pointer to the start of the newly prepended data, or
1683 * NULL if there is not enough headroom space in the first segment
1685 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
1688 __rte_mbuf_sanity_check(m, 1);
1690 if (unlikely(len > rte_pktmbuf_headroom(m)))
1694 m->data_len = (uint16_t)(m->data_len + len);
1695 m->pkt_len = (m->pkt_len + len);
1697 return (char *)m->buf_addr + m->data_off;
1701 * Append len bytes to an mbuf.
1703 * Append len bytes to an mbuf and return a pointer to the start address
1704 * of the added data. If there is not enough tailroom in the last
1705 * segment, the function will return NULL, without modifying the mbuf.
1710 * The amount of data to append (in bytes).
1712 * A pointer to the start of the newly appended data, or
1713 * NULL if there is not enough tailroom space in the last segment
1715 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
1718 struct rte_mbuf *m_last;
1720 __rte_mbuf_sanity_check(m, 1);
1722 m_last = rte_pktmbuf_lastseg(m);
1723 if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
1726 tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
1727 m_last->data_len = (uint16_t)(m_last->data_len + len);
1728 m->pkt_len = (m->pkt_len + len);
1729 return (char*) tail;
1733 * Remove len bytes at the beginning of an mbuf.
1735 * Returns a pointer to the start address of the new data area. If the
1736 * length is greater than the length of the first segment, then the
1737 * function will fail and return NULL, without modifying the mbuf.
1742 * The amount of data to remove (in bytes).
1744 * A pointer to the new start of the data.
1746 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
1748 __rte_mbuf_sanity_check(m, 1);
1750 if (unlikely(len > m->data_len))
1753 m->data_len = (uint16_t)(m->data_len - len);
1755 m->pkt_len = (m->pkt_len - len);
1756 return (char *)m->buf_addr + m->data_off;
1760 * Remove len bytes of data at the end of the mbuf.
1762 * If the length is greater than the length of the last segment, the
1763 * function will fail and return -1 without modifying the mbuf.
1768 * The amount of data to remove (in bytes).
1773 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
1775 struct rte_mbuf *m_last;
1777 __rte_mbuf_sanity_check(m, 1);
1779 m_last = rte_pktmbuf_lastseg(m);
1780 if (unlikely(len > m_last->data_len))
1783 m_last->data_len = (uint16_t)(m_last->data_len - len);
1784 m->pkt_len = (m->pkt_len - len);
1789 * Test if mbuf data is contiguous.
1794 * - 1, if all data is contiguous (one segment).
1795 * - 0, if there is several segments.
1797 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
1799 __rte_mbuf_sanity_check(m, 1);
1800 return !!(m->nb_segs == 1);
1804 * @internal used by rte_pktmbuf_read().
1806 const void *__rte_pktmbuf_read(const struct rte_mbuf *m, uint32_t off,
1807 uint32_t len, void *buf);
1810 * Read len data bytes in a mbuf at specified offset.
1812 * If the data is contiguous, return the pointer in the mbuf data, else
1813 * copy the data in the buffer provided by the user and return its
1817 * The pointer to the mbuf.
1819 * The offset of the data in the mbuf.
1821 * The amount of bytes to read.
1823 * The buffer where data is copied if it is not contiguous in mbuf
1824 * data. Its length should be at least equal to the len parameter.
1826 * The pointer to the data, either in the mbuf if it is contiguous,
1827 * or in the user buffer. If mbuf is too small, NULL is returned.
1829 static inline const void *rte_pktmbuf_read(const struct rte_mbuf *m,
1830 uint32_t off, uint32_t len, void *buf)
1832 if (likely(off + len <= rte_pktmbuf_data_len(m)))
1833 return rte_pktmbuf_mtod_offset(m, char *, off);
1835 return __rte_pktmbuf_read(m, off, len, buf);
1839 * Chain an mbuf to another, thereby creating a segmented packet.
1841 * Note: The implementation will do a linear walk over the segments to find
1842 * the tail entry. For cases when there are many segments, it's better to
1843 * chain the entries manually.
1846 * The head of the mbuf chain (the first packet)
1848 * The mbuf to put last in the chain
1852 * - -EOVERFLOW, if the chain segment limit exceeded
1854 static inline int rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail)
1856 struct rte_mbuf *cur_tail;
1858 /* Check for number-of-segments-overflow */
1859 if (head->nb_segs + tail->nb_segs > RTE_MBUF_MAX_NB_SEGS)
1862 /* Chain 'tail' onto the old tail */
1863 cur_tail = rte_pktmbuf_lastseg(head);
1864 cur_tail->next = tail;
1866 /* accumulate number of segments and total length. */
1867 head->nb_segs += tail->nb_segs;
1868 head->pkt_len += tail->pkt_len;
1870 /* pkt_len is only set in the head */
1871 tail->pkt_len = tail->data_len;
1877 * Validate general requirements for Tx offload in mbuf.
1879 * This function checks correctness and completeness of Tx offload settings.
1882 * The packet mbuf to be validated.
1884 * 0 if packet is valid
1887 rte_validate_tx_offload(const struct rte_mbuf *m)
1889 uint64_t ol_flags = m->ol_flags;
1890 uint64_t inner_l3_offset = m->l2_len;
1892 /* Does packet set any of available offloads? */
1893 if (!(ol_flags & PKT_TX_OFFLOAD_MASK))
1896 if (ol_flags & PKT_TX_OUTER_IP_CKSUM)
1897 inner_l3_offset += m->outer_l2_len + m->outer_l3_len;
1899 /* Headers are fragmented */
1900 if (rte_pktmbuf_data_len(m) < inner_l3_offset + m->l3_len + m->l4_len)
1903 /* IP checksum can be counted only for IPv4 packet */
1904 if ((ol_flags & PKT_TX_IP_CKSUM) && (ol_flags & PKT_TX_IPV6))
1907 /* IP type not set when required */
1908 if (ol_flags & (PKT_TX_L4_MASK | PKT_TX_TCP_SEG))
1909 if (!(ol_flags & (PKT_TX_IPV4 | PKT_TX_IPV6)))
1912 /* Check requirements for TSO packet */
1913 if (ol_flags & PKT_TX_TCP_SEG)
1914 if ((m->tso_segsz == 0) ||
1915 ((ol_flags & PKT_TX_IPV4) &&
1916 !(ol_flags & PKT_TX_IP_CKSUM)))
1919 /* PKT_TX_OUTER_IP_CKSUM set for non outer IPv4 packet. */
1920 if ((ol_flags & PKT_TX_OUTER_IP_CKSUM) &&
1921 !(ol_flags & PKT_TX_OUTER_IPV4))
1928 * Linearize data in mbuf.
1930 * This function moves the mbuf data in the first segment if there is enough
1931 * tailroom. The subsequent segments are unchained and freed.
1940 rte_pktmbuf_linearize(struct rte_mbuf *mbuf)
1942 int seg_len, copy_len;
1944 struct rte_mbuf *m_next;
1947 if (rte_pktmbuf_is_contiguous(mbuf))
1950 /* Extend first segment to the total packet length */
1951 copy_len = rte_pktmbuf_pkt_len(mbuf) - rte_pktmbuf_data_len(mbuf);
1953 if (unlikely(copy_len > rte_pktmbuf_tailroom(mbuf)))
1956 buffer = rte_pktmbuf_mtod_offset(mbuf, char *, mbuf->data_len);
1957 mbuf->data_len = (uint16_t)(mbuf->pkt_len);
1959 /* Append data from next segments to the first one */
1964 seg_len = rte_pktmbuf_data_len(m);
1965 rte_memcpy(buffer, rte_pktmbuf_mtod(m, char *), seg_len);
1968 rte_pktmbuf_free_seg(m);
1979 * Dump an mbuf structure to a file.
1981 * Dump all fields for the given packet mbuf and all its associated
1982 * segments (in the case of a chained buffer).
1985 * A pointer to a file for output
1989 * If dump_len != 0, also dump the "dump_len" first data bytes of
1992 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
1998 #endif /* _RTE_MBUF_H_ */