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 * RX packet is a 802.1q VLAN packet. This flag was set by PMDs when
93 * the packet is recognized as a VLAN, but the behavior between PMDs
94 * was not the same. This flag is kept for some time to avoid breaking
95 * applications and should be replaced by PKT_RX_VLAN_STRIPPED.
97 #define PKT_RX_VLAN_PKT (1ULL << 0)
99 #define PKT_RX_RSS_HASH (1ULL << 1) /**< RX packet with RSS hash result. */
100 #define PKT_RX_FDIR (1ULL << 2) /**< RX packet with FDIR match indicate. */
104 * Checking this flag alone is deprecated: check the 2 bits of
105 * PKT_RX_L4_CKSUM_MASK.
106 * This flag was set when the L4 checksum of a packet was detected as
107 * wrong by the hardware.
109 #define PKT_RX_L4_CKSUM_BAD (1ULL << 3)
113 * Checking this flag alone is deprecated: check the 2 bits of
114 * PKT_RX_IP_CKSUM_MASK.
115 * This flag was set when the IP checksum of a packet was detected as
116 * wrong by the hardware.
118 #define PKT_RX_IP_CKSUM_BAD (1ULL << 4)
120 #define PKT_RX_EIP_CKSUM_BAD (1ULL << 5) /**< External IP header checksum error. */
123 * A vlan has been stripped by the hardware and its tci is saved in
124 * mbuf->vlan_tci. This can only happen if vlan stripping is enabled
125 * in the RX configuration of the PMD.
127 #define PKT_RX_VLAN_STRIPPED (1ULL << 6)
130 * Mask of bits used to determine the status of RX IP checksum.
131 * - PKT_RX_IP_CKSUM_UNKNOWN: no information about the RX IP checksum
132 * - PKT_RX_IP_CKSUM_BAD: the IP checksum in the packet is wrong
133 * - PKT_RX_IP_CKSUM_GOOD: the IP checksum in the packet is valid
134 * - PKT_RX_IP_CKSUM_NONE: the IP checksum is not correct in the packet
135 * data, but the integrity of the IP header is verified.
137 #define PKT_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7))
139 #define PKT_RX_IP_CKSUM_UNKNOWN 0
140 #define PKT_RX_IP_CKSUM_BAD (1ULL << 4)
141 #define PKT_RX_IP_CKSUM_GOOD (1ULL << 7)
142 #define PKT_RX_IP_CKSUM_NONE ((1ULL << 4) | (1ULL << 7))
145 * Mask of bits used to determine the status of RX L4 checksum.
146 * - PKT_RX_L4_CKSUM_UNKNOWN: no information about the RX L4 checksum
147 * - PKT_RX_L4_CKSUM_BAD: the L4 checksum in the packet is wrong
148 * - PKT_RX_L4_CKSUM_GOOD: the L4 checksum in the packet is valid
149 * - PKT_RX_L4_CKSUM_NONE: the L4 checksum is not correct in the packet
150 * data, but the integrity of the L4 data is verified.
152 #define PKT_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8))
154 #define PKT_RX_L4_CKSUM_UNKNOWN 0
155 #define PKT_RX_L4_CKSUM_BAD (1ULL << 3)
156 #define PKT_RX_L4_CKSUM_GOOD (1ULL << 8)
157 #define PKT_RX_L4_CKSUM_NONE ((1ULL << 3) | (1ULL << 8))
159 #define PKT_RX_IEEE1588_PTP (1ULL << 9) /**< RX IEEE1588 L2 Ethernet PT Packet. */
160 #define PKT_RX_IEEE1588_TMST (1ULL << 10) /**< RX IEEE1588 L2/L4 timestamped packet.*/
161 #define PKT_RX_FDIR_ID (1ULL << 13) /**< FD id reported if FDIR match. */
162 #define PKT_RX_FDIR_FLX (1ULL << 14) /**< Flexible bytes reported if FDIR match. */
165 * The 2 vlans have been stripped by the hardware and their tci are
166 * saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer).
167 * This can only happen if vlan stripping is enabled in the RX
168 * configuration of the PMD. If this flag is set, PKT_RX_VLAN_STRIPPED
171 #define PKT_RX_QINQ_STRIPPED (1ULL << 15)
175 * RX packet with double VLAN stripped.
176 * This flag is replaced by PKT_RX_QINQ_STRIPPED.
178 #define PKT_RX_QINQ_PKT PKT_RX_QINQ_STRIPPED
181 * When packets are coalesced by a hardware or virtual driver, this flag
182 * can be set in the RX mbuf, meaning that the m->tso_segsz field is
183 * valid and is set to the segment size of original packets.
185 #define PKT_RX_LRO (1ULL << 16)
188 * Indicate that the timestamp field in the mbuf is valid.
190 #define PKT_RX_TIMESTAMP (1ULL << 17)
193 * Indicate that security offload processing was applied on the RX packet.
195 #define PKT_RX_SEC_OFFLOAD (1ULL << 18)
198 * Indicate that security offload processing failed on the RX packet.
200 #define PKT_RX_SEC_OFFLOAD_FAILED (1ULL << 19)
202 /* add new RX flags here */
204 /* add new TX flags here */
207 * Request security offload processing on the TX packet.
209 #define PKT_TX_SEC_OFFLOAD (1ULL << 43)
212 * Offload the MACsec. This flag must be set by the application to enable
213 * this offload feature for a packet to be transmitted.
215 #define PKT_TX_MACSEC (1ULL << 44)
218 * Bits 45:48 used for the tunnel type.
219 * When doing Tx offload like TSO or checksum, the HW needs to configure the
220 * tunnel type into the HW descriptors.
222 #define PKT_TX_TUNNEL_VXLAN (0x1ULL << 45)
223 #define PKT_TX_TUNNEL_GRE (0x2ULL << 45)
224 #define PKT_TX_TUNNEL_IPIP (0x3ULL << 45)
225 #define PKT_TX_TUNNEL_GENEVE (0x4ULL << 45)
226 /**< TX packet with MPLS-in-UDP RFC 7510 header. */
227 #define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45)
228 /* add new TX TUNNEL type here */
229 #define PKT_TX_TUNNEL_MASK (0xFULL << 45)
232 * Second VLAN insertion (QinQ) flag.
234 #define PKT_TX_QINQ_PKT (1ULL << 49) /**< TX packet with double VLAN inserted. */
237 * TCP segmentation offload. To enable this offload feature for a
238 * packet to be transmitted on hardware supporting TSO:
239 * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies
241 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
242 * - if it's IPv4, set the PKT_TX_IP_CKSUM flag and write the IP checksum
244 * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz
245 * - calculate the pseudo header checksum without taking ip_len in account,
246 * and set it in the TCP header. Refer to rte_ipv4_phdr_cksum() and
247 * rte_ipv6_phdr_cksum() that can be used as helpers.
249 #define PKT_TX_TCP_SEG (1ULL << 50)
251 #define PKT_TX_IEEE1588_TMST (1ULL << 51) /**< TX IEEE1588 packet to timestamp. */
254 * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved,
255 * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware
256 * L4 checksum offload, the user needs to:
257 * - fill l2_len and l3_len in mbuf
258 * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM
259 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
260 * - calculate the pseudo header checksum and set it in the L4 header (only
261 * for TCP or UDP). See rte_ipv4_phdr_cksum() and rte_ipv6_phdr_cksum().
262 * For SCTP, set the crc field to 0.
264 #define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */
265 #define PKT_TX_TCP_CKSUM (1ULL << 52) /**< TCP cksum of TX pkt. computed by NIC. */
266 #define PKT_TX_SCTP_CKSUM (2ULL << 52) /**< SCTP cksum of TX pkt. computed by NIC. */
267 #define PKT_TX_UDP_CKSUM (3ULL << 52) /**< UDP cksum of TX pkt. computed by NIC. */
268 #define PKT_TX_L4_MASK (3ULL << 52) /**< Mask for L4 cksum offload request. */
271 * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should
272 * also be set by the application, although a PMD will only check
274 * - set the IP checksum field in the packet to 0
275 * - fill the mbuf offload information: l2_len, l3_len
277 #define PKT_TX_IP_CKSUM (1ULL << 54)
280 * Packet is IPv4. This flag must be set when using any offload feature
281 * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4
282 * packet. If the packet is a tunneled packet, this flag is related to
285 #define PKT_TX_IPV4 (1ULL << 55)
288 * Packet is IPv6. This flag must be set when using an offload feature
289 * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6
290 * packet. If the packet is a tunneled packet, this flag is related to
293 #define PKT_TX_IPV6 (1ULL << 56)
295 #define PKT_TX_VLAN_PKT (1ULL << 57) /**< TX packet is a 802.1q VLAN packet. */
298 * Offload the IP checksum of an external header in the hardware. The
299 * flag PKT_TX_OUTER_IPV4 should also be set by the application, alto ugh
300 * a PMD will only check PKT_TX_IP_CKSUM. The IP checksum field in the
301 * packet must be set to 0.
302 * - set the outer IP checksum field in the packet to 0
303 * - fill the mbuf offload information: outer_l2_len, outer_l3_len
305 #define PKT_TX_OUTER_IP_CKSUM (1ULL << 58)
308 * Packet outer header is IPv4. This flag must be set when using any
309 * outer offload feature (L3 or L4 checksum) to tell the NIC that the
310 * outer header of the tunneled packet is an IPv4 packet.
312 #define PKT_TX_OUTER_IPV4 (1ULL << 59)
315 * Packet outer header is IPv6. This flag must be set when using any
316 * outer offload feature (L4 checksum) to tell the NIC that the outer
317 * header of the tunneled packet is an IPv6 packet.
319 #define PKT_TX_OUTER_IPV6 (1ULL << 60)
322 * Bitmask of all supported packet Tx offload features flags,
323 * which can be set for packet.
325 #define PKT_TX_OFFLOAD_MASK ( \
328 PKT_TX_OUTER_IP_CKSUM | \
330 PKT_TX_IEEE1588_TMST | \
333 PKT_TX_TUNNEL_MASK | \
337 #define __RESERVED (1ULL << 61) /**< reserved for future mbuf use */
339 #define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */
341 /* Use final bit of flags to indicate a control mbuf */
342 #define CTRL_MBUF_FLAG (1ULL << 63) /**< Mbuf contains control data */
344 /** Alignment constraint of mbuf private area. */
345 #define RTE_MBUF_PRIV_ALIGN 8
348 * Get the name of a RX offload flag
351 * The mask describing the flag.
353 * The name of this flag, or NULL if it's not a valid RX flag.
355 const char *rte_get_rx_ol_flag_name(uint64_t mask);
358 * Dump the list of RX offload flags in a buffer
361 * The mask describing the RX flags.
365 * The length of the buffer.
367 * 0 on success, (-1) on error.
369 int rte_get_rx_ol_flag_list(uint64_t mask, char *buf, size_t buflen);
372 * Get the name of a TX offload flag
375 * The mask describing the flag. Usually only one bit must be set.
376 * Several bits can be given if they belong to the same mask.
377 * Ex: PKT_TX_L4_MASK.
379 * The name of this flag, or NULL if it's not a valid TX flag.
381 const char *rte_get_tx_ol_flag_name(uint64_t mask);
384 * Dump the list of TX offload flags in a buffer
387 * The mask describing the TX flags.
391 * The length of the buffer.
393 * 0 on success, (-1) on error.
395 int rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen);
398 * Some NICs need at least 2KB buffer to RX standard Ethernet frame without
399 * splitting it into multiple segments.
400 * So, for mbufs that planned to be involved into RX/TX, the recommended
401 * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM.
403 #define RTE_MBUF_DEFAULT_DATAROOM 2048
404 #define RTE_MBUF_DEFAULT_BUF_SIZE \
405 (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM)
407 /* define a set of marker types that can be used to refer to set points in the
410 typedef void *MARKER[0]; /**< generic marker for a point in a structure */
412 typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */
414 typedef uint64_t MARKER64[0]; /**< marker that allows us to overwrite 8 bytes
415 * with a single assignment */
418 * The generic rte_mbuf, containing a packet mbuf.
423 void *buf_addr; /**< Virtual address of segment buffer. */
425 * Physical address of segment buffer.
426 * Force alignment to 8-bytes, so as to ensure we have the exact
427 * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes
428 * working on vector drivers easier.
430 phys_addr_t buf_physaddr __rte_aligned(sizeof(phys_addr_t));
432 /* next 8 bytes are initialised on RX descriptor rearm */
437 * Reference counter. Its size should at least equal to the size
438 * of port field (16 bits), to support zero-copy broadcast.
439 * It should only be accessed using the following functions:
440 * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
441 * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
442 * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
447 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
448 uint16_t refcnt; /**< Non-atomically accessed refcnt */
450 uint16_t nb_segs; /**< Number of segments. */
452 /** Input port (16 bits to support more than 256 virtual ports). */
455 uint64_t ol_flags; /**< Offload features. */
457 /* remaining bytes are set on RX when pulling packet from descriptor */
458 MARKER rx_descriptor_fields1;
461 * The packet type, which is the combination of outer/inner L2, L3, L4
462 * and tunnel types. The packet_type is about data really present in the
463 * mbuf. Example: if vlan stripping is enabled, a received vlan packet
464 * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the
465 * vlan is stripped from the data.
469 uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */
471 uint32_t l2_type:4; /**< (Outer) L2 type. */
472 uint32_t l3_type:4; /**< (Outer) L3 type. */
473 uint32_t l4_type:4; /**< (Outer) L4 type. */
474 uint32_t tun_type:4; /**< Tunnel type. */
477 uint8_t inner_esp_next_proto;
478 /**< ESP next protocol type, valid if
479 * RTE_PTYPE_TUNNEL_ESP tunnel type is set
484 uint8_t inner_l2_type:4;
485 /**< Inner L2 type. */
486 uint8_t inner_l3_type:4;
487 /**< Inner L3 type. */
490 uint32_t inner_l4_type:4; /**< Inner L4 type. */
494 uint32_t pkt_len; /**< Total pkt len: sum of all segments. */
495 uint16_t data_len; /**< Amount of data in segment buffer. */
496 /** VLAN TCI (CPU order), valid if PKT_RX_VLAN_STRIPPED is set. */
500 uint32_t rss; /**< RSS hash result if RSS enabled */
509 /**< Second 4 flexible bytes */
512 /**< First 4 flexible bytes or FD ID, dependent on
513 PKT_RX_FDIR_* flag in ol_flags. */
514 } fdir; /**< Filter identifier if FDIR enabled */
518 } sched; /**< Hierarchical scheduler */
519 uint32_t usr; /**< User defined tags. See rte_distributor_process() */
520 } hash; /**< hash information */
522 /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ_STRIPPED is set. */
523 uint16_t vlan_tci_outer;
525 uint16_t buf_len; /**< Length of segment buffer. */
527 /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference
528 * are not normalized but are always the same for a given port.
532 /* second cache line - fields only used in slow path or on TX */
533 MARKER cacheline1 __rte_cache_min_aligned;
537 void *userdata; /**< Can be used for external metadata */
538 uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */
541 struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
542 struct rte_mbuf *next; /**< Next segment of scattered packet. */
544 /* fields to support TX offloads */
547 uint64_t tx_offload; /**< combined for easy fetch */
551 /**< L2 (MAC) Header Length for non-tunneling pkt.
552 * Outer_L4_len + ... + Inner_L2_len for tunneling pkt.
554 uint64_t l3_len:9; /**< L3 (IP) Header Length. */
555 uint64_t l4_len:8; /**< L4 (TCP/UDP) Header Length. */
556 uint64_t tso_segsz:16; /**< TCP TSO segment size */
558 /* fields for TX offloading of tunnels */
559 uint64_t outer_l3_len:9; /**< Outer L3 (IP) Hdr Length. */
560 uint64_t outer_l2_len:7; /**< Outer L2 (MAC) Hdr Length. */
562 /* uint64_t unused:8; */
566 /** Size of the application private data. In case of an indirect
567 * mbuf, it stores the direct mbuf private data size. */
570 /** Timesync flags for use with IEEE1588. */
573 /** Sequence number. See also rte_reorder_insert(). */
576 } __rte_cache_aligned;
579 * Prefetch the first part of the mbuf
581 * The first 64 bytes of the mbuf corresponds to fields that are used early
582 * in the receive path. If the cache line of the architecture is higher than
583 * 64B, the second part will also be prefetched.
586 * The pointer to the mbuf.
589 rte_mbuf_prefetch_part1(struct rte_mbuf *m)
591 rte_prefetch0(&m->cacheline0);
595 * Prefetch the second part of the mbuf
597 * The next 64 bytes of the mbuf corresponds to fields that are used in the
598 * transmit path. If the cache line of the architecture is higher than 64B,
599 * this function does nothing as it is expected that the full mbuf is
603 * The pointer to the mbuf.
606 rte_mbuf_prefetch_part2(struct rte_mbuf *m)
608 #if RTE_CACHE_LINE_SIZE == 64
609 rte_prefetch0(&m->cacheline1);
616 static inline uint16_t rte_pktmbuf_priv_size(struct rte_mempool *mp);
619 * Return the DMA address of the beginning of the mbuf data
622 * The pointer to the mbuf.
624 * The physical address of the beginning of the mbuf data
626 static inline phys_addr_t
627 rte_mbuf_data_dma_addr(const struct rte_mbuf *mb)
629 return mb->buf_physaddr + mb->data_off;
633 * Return the default DMA address of the beginning of the mbuf data
635 * This function is used by drivers in their receive function, as it
636 * returns the location where data should be written by the NIC, taking
637 * the default headroom in account.
640 * The pointer to the mbuf.
642 * The physical address of the beginning of the mbuf data
644 static inline phys_addr_t
645 rte_mbuf_data_dma_addr_default(const struct rte_mbuf *mb)
647 return mb->buf_physaddr + RTE_PKTMBUF_HEADROOM;
651 * Return the mbuf owning the data buffer address of an indirect mbuf.
654 * The pointer to the indirect mbuf.
656 * The address of the direct mbuf corresponding to buffer_addr.
658 static inline struct rte_mbuf *
659 rte_mbuf_from_indirect(struct rte_mbuf *mi)
661 return (struct rte_mbuf *)RTE_PTR_SUB(mi->buf_addr, sizeof(*mi) + mi->priv_size);
665 * Return the buffer address embedded in the given mbuf.
668 * The pointer to the mbuf.
670 * The address of the data buffer owned by the mbuf.
673 rte_mbuf_to_baddr(struct rte_mbuf *md)
676 buffer_addr = (char *)md + sizeof(*md) + rte_pktmbuf_priv_size(md->pool);
681 * Returns TRUE if given mbuf is indirect, or FALSE otherwise.
683 #define RTE_MBUF_INDIRECT(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF)
686 * Returns TRUE if given mbuf is direct, or FALSE otherwise.
688 #define RTE_MBUF_DIRECT(mb) (!RTE_MBUF_INDIRECT(mb))
691 * Private data in case of pktmbuf pool.
693 * A structure that contains some pktmbuf_pool-specific data that are
694 * appended after the mempool structure (in private data).
696 struct rte_pktmbuf_pool_private {
697 uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf. */
698 uint16_t mbuf_priv_size; /**< Size of private area in each mbuf. */
701 #ifdef RTE_LIBRTE_MBUF_DEBUG
703 /** check mbuf type in debug mode */
704 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
706 #else /* RTE_LIBRTE_MBUF_DEBUG */
708 /** check mbuf type in debug mode */
709 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
711 #endif /* RTE_LIBRTE_MBUF_DEBUG */
713 #ifdef RTE_MBUF_REFCNT_ATOMIC
716 * Reads the value of an mbuf's refcnt.
720 * Reference count number.
722 static inline uint16_t
723 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
725 return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
729 * Sets an mbuf's refcnt to a defined value.
736 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
738 rte_atomic16_set(&m->refcnt_atomic, new_value);
742 * Adds given value to an mbuf's refcnt and returns its new value.
746 * Value to add/subtract
750 static inline uint16_t
751 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
754 * The atomic_add is an expensive operation, so we don't want to
755 * call it in the case where we know we are the uniq holder of
756 * this mbuf (i.e. ref_cnt == 1). Otherwise, an atomic
757 * operation has to be used because concurrent accesses on the
758 * reference counter can occur.
760 if (likely(rte_mbuf_refcnt_read(m) == 1)) {
761 rte_mbuf_refcnt_set(m, 1 + value);
765 return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
768 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
771 * Adds given value to an mbuf's refcnt and returns its new value.
773 static inline uint16_t
774 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
776 m->refcnt = (uint16_t)(m->refcnt + value);
781 * Reads the value of an mbuf's refcnt.
783 static inline uint16_t
784 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
790 * Sets an mbuf's refcnt to the defined value.
793 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
795 m->refcnt = new_value;
798 #endif /* RTE_MBUF_REFCNT_ATOMIC */
801 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { \
808 * Sanity checks on an mbuf.
810 * Check the consistency of the given mbuf. The function will cause a
811 * panic if corruption is detected.
814 * The mbuf to be checked.
816 * True if the mbuf is a packet header, false if it is a sub-segment
817 * of a packet (in this case, some fields like nb_segs are not checked)
820 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
822 #define MBUF_RAW_ALLOC_CHECK(m) do { \
823 RTE_ASSERT(rte_mbuf_refcnt_read(m) == 1); \
824 RTE_ASSERT((m)->next == NULL); \
825 RTE_ASSERT((m)->nb_segs == 1); \
826 __rte_mbuf_sanity_check(m, 0); \
830 * Allocate an unitialized mbuf from mempool *mp*.
832 * This function can be used by PMDs (especially in RX functions) to
833 * allocate an unitialized mbuf. The driver is responsible of
834 * initializing all the required fields. See rte_pktmbuf_reset().
835 * For standard needs, prefer rte_pktmbuf_alloc().
837 * The caller can expect that the following fields of the mbuf structure
838 * are initialized: buf_addr, buf_physaddr, buf_len, refcnt=1, nb_segs=1,
839 * next=NULL, pool, priv_size. The other fields must be initialized
843 * The mempool from which mbuf is allocated.
845 * - The pointer to the new mbuf on success.
846 * - NULL if allocation failed.
848 static inline struct rte_mbuf *rte_mbuf_raw_alloc(struct rte_mempool *mp)
853 if (rte_mempool_get(mp, &mb) < 0)
855 m = (struct rte_mbuf *)mb;
856 MBUF_RAW_ALLOC_CHECK(m);
861 * Put mbuf back into its original mempool.
863 * The caller must ensure that the mbuf is direct and properly
864 * reinitialized (refcnt=1, next=NULL, nb_segs=1), as done by
865 * rte_pktmbuf_prefree_seg().
867 * This function should be used with care, when optimization is
868 * required. For standard needs, prefer rte_pktmbuf_free() or
869 * rte_pktmbuf_free_seg().
872 * The mbuf to be freed.
874 static __rte_always_inline void
875 rte_mbuf_raw_free(struct rte_mbuf *m)
877 RTE_ASSERT(RTE_MBUF_DIRECT(m));
878 RTE_ASSERT(rte_mbuf_refcnt_read(m) == 1);
879 RTE_ASSERT(m->next == NULL);
880 RTE_ASSERT(m->nb_segs == 1);
881 __rte_mbuf_sanity_check(m, 0);
882 rte_mempool_put(m->pool, m);
885 /* compat with older versions */
888 __rte_mbuf_raw_free(struct rte_mbuf *m)
890 rte_mbuf_raw_free(m);
893 /* Operations on ctrl mbuf */
896 * The control mbuf constructor.
898 * This function initializes some fields in an mbuf structure that are
899 * not modified by the user once created (mbuf type, origin pool, buffer
900 * start address, and so on). This function is given as a callback function
901 * to rte_mempool_obj_iter() or rte_mempool_create() at pool creation time.
904 * The mempool from which the mbuf is allocated.
906 * A pointer that can be used by the user to retrieve useful information
907 * for mbuf initialization. This pointer is the opaque argument passed to
908 * rte_mempool_obj_iter() or rte_mempool_create().
910 * The mbuf to initialize.
912 * The index of the mbuf in the pool table.
914 void rte_ctrlmbuf_init(struct rte_mempool *mp, void *opaque_arg,
915 void *m, unsigned i);
918 * Allocate a new mbuf (type is ctrl) from mempool *mp*.
920 * This new mbuf is initialized with data pointing to the beginning of
921 * buffer, and with a length of zero.
924 * The mempool from which the mbuf is allocated.
926 * - The pointer to the new mbuf on success.
927 * - NULL if allocation failed.
929 #define rte_ctrlmbuf_alloc(mp) rte_pktmbuf_alloc(mp)
932 * Free a control mbuf back into its original mempool.
935 * The control mbuf to be freed.
937 #define rte_ctrlmbuf_free(m) rte_pktmbuf_free(m)
940 * A macro that returns the pointer to the carried data.
942 * The value that can be read or assigned.
947 #define rte_ctrlmbuf_data(m) ((char *)((m)->buf_addr) + (m)->data_off)
950 * A macro that returns the length of the carried data.
952 * The value that can be read or assigned.
957 #define rte_ctrlmbuf_len(m) rte_pktmbuf_data_len(m)
960 * Tests if an mbuf is a control mbuf
963 * The mbuf to be tested
965 * - True (1) if the mbuf is a control mbuf
966 * - False(0) otherwise
969 rte_is_ctrlmbuf(struct rte_mbuf *m)
971 return !!(m->ol_flags & CTRL_MBUF_FLAG);
974 /* Operations on pkt mbuf */
977 * The packet mbuf constructor.
979 * This function initializes some fields in the mbuf structure that are
980 * not modified by the user once created (origin pool, buffer start
981 * address, and so on). This function is given as a callback function to
982 * rte_mempool_obj_iter() or rte_mempool_create() at pool creation time.
985 * The mempool from which mbufs originate.
987 * A pointer that can be used by the user to retrieve useful information
988 * for mbuf initialization. This pointer is the opaque argument passed to
989 * rte_mempool_obj_iter() or rte_mempool_create().
991 * The mbuf to initialize.
993 * The index of the mbuf in the pool table.
995 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
996 void *m, unsigned i);
1000 * A packet mbuf pool constructor.
1002 * This function initializes the mempool private data in the case of a
1003 * pktmbuf pool. This private data is needed by the driver. The
1004 * function must be called on the mempool before it is used, or it
1005 * can be given as a callback function to rte_mempool_create() at
1006 * pool creation. It can be extended by the user, for example, to
1007 * provide another packet size.
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_create().
1016 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
1019 * Create a mbuf pool.
1021 * This function creates and initializes a packet mbuf pool. It is
1022 * a wrapper to rte_mempool functions.
1025 * The name of the mbuf pool.
1027 * The number of elements in the mbuf pool. The optimum size (in terms
1028 * of memory usage) for a mempool is when n is a power of two minus one:
1031 * Size of the per-core object cache. See rte_mempool_create() for
1034 * Size of application private are between the rte_mbuf structure
1035 * and the data buffer. This value must be aligned to RTE_MBUF_PRIV_ALIGN.
1036 * @param data_room_size
1037 * Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
1039 * The socket identifier where the memory should be allocated. The
1040 * value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
1043 * The pointer to the new allocated mempool, on success. NULL on error
1044 * with rte_errno set appropriately. Possible rte_errno values include:
1045 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
1046 * - E_RTE_SECONDARY - function was called from a secondary process instance
1047 * - EINVAL - cache size provided is too large, or priv_size is not aligned.
1048 * - ENOSPC - the maximum number of memzones has already been allocated
1049 * - EEXIST - a memzone with the same name already exists
1050 * - ENOMEM - no appropriate memory area found in which to create memzone
1052 struct rte_mempool *
1053 rte_pktmbuf_pool_create(const char *name, unsigned n,
1054 unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
1058 * Get the data room size of mbufs stored in a pktmbuf_pool
1060 * The data room size is the amount of data that can be stored in a
1061 * mbuf including the headroom (RTE_PKTMBUF_HEADROOM).
1064 * The packet mbuf pool.
1066 * The data room size of mbufs stored in this mempool.
1068 static inline uint16_t
1069 rte_pktmbuf_data_room_size(struct rte_mempool *mp)
1071 struct rte_pktmbuf_pool_private *mbp_priv;
1073 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1074 return mbp_priv->mbuf_data_room_size;
1078 * Get the application private size of mbufs stored in a pktmbuf_pool
1080 * The private size of mbuf is a zone located between the rte_mbuf
1081 * structure and the data buffer where an application can store data
1082 * associated to a packet.
1085 * The packet mbuf pool.
1087 * The private size of mbufs stored in this mempool.
1089 static inline uint16_t
1090 rte_pktmbuf_priv_size(struct rte_mempool *mp)
1092 struct rte_pktmbuf_pool_private *mbp_priv;
1094 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
1095 return mbp_priv->mbuf_priv_size;
1099 * Reset the data_off field of a packet mbuf to its default value.
1101 * The given mbuf must have only one segment, which should be empty.
1104 * The packet mbuf's data_off field has to be reset.
1106 static inline void rte_pktmbuf_reset_headroom(struct rte_mbuf *m)
1108 m->data_off = RTE_MIN(RTE_PKTMBUF_HEADROOM, (uint16_t)m->buf_len);
1112 * Reset the fields of a packet mbuf to their default values.
1114 * The given mbuf must have only one segment.
1117 * The packet mbuf to be resetted.
1119 #define MBUF_INVALID_PORT UINT16_MAX
1121 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
1127 m->vlan_tci_outer = 0;
1129 m->port = MBUF_INVALID_PORT;
1133 rte_pktmbuf_reset_headroom(m);
1136 __rte_mbuf_sanity_check(m, 1);
1140 * Allocate a new mbuf from a mempool.
1142 * This new mbuf contains one segment, which has a length of 0. The pointer
1143 * to data is initialized to have some bytes of headroom in the buffer
1144 * (if buffer size allows).
1147 * The mempool from which the mbuf is allocated.
1149 * - The pointer to the new mbuf on success.
1150 * - NULL if allocation failed.
1152 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
1155 if ((m = rte_mbuf_raw_alloc(mp)) != NULL)
1156 rte_pktmbuf_reset(m);
1161 * Allocate a bulk of mbufs, initialize refcnt and reset the fields to default
1165 * The mempool from which mbufs are allocated.
1167 * Array of pointers to mbufs
1172 * - -ENOENT: Not enough entries in the mempool; no mbufs are retrieved.
1174 static inline int rte_pktmbuf_alloc_bulk(struct rte_mempool *pool,
1175 struct rte_mbuf **mbufs, unsigned count)
1180 rc = rte_mempool_get_bulk(pool, (void **)mbufs, count);
1184 /* To understand duff's device on loop unwinding optimization, see
1185 * https://en.wikipedia.org/wiki/Duff's_device.
1186 * Here while() loop is used rather than do() while{} to avoid extra
1187 * check if count is zero.
1189 switch (count % 4) {
1191 while (idx != count) {
1192 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1193 rte_pktmbuf_reset(mbufs[idx]);
1197 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1198 rte_pktmbuf_reset(mbufs[idx]);
1202 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1203 rte_pktmbuf_reset(mbufs[idx]);
1207 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
1208 rte_pktmbuf_reset(mbufs[idx]);
1217 * Attach packet mbuf to another packet mbuf.
1219 * After attachment we refer the mbuf we attached as 'indirect',
1220 * while mbuf we attached to as 'direct'.
1221 * The direct mbuf's reference counter is incremented.
1223 * Right now, not supported:
1224 * - attachment for already indirect mbuf (e.g. - mi has to be direct).
1225 * - mbuf we trying to attach (mi) is used by someone else
1226 * e.g. it's reference counter is greater then 1.
1229 * The indirect packet mbuf.
1231 * The packet mbuf we're attaching to.
1233 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *m)
1235 struct rte_mbuf *md;
1237 RTE_ASSERT(RTE_MBUF_DIRECT(mi) &&
1238 rte_mbuf_refcnt_read(mi) == 1);
1240 /* if m is not direct, get the mbuf that embeds the data */
1241 if (RTE_MBUF_DIRECT(m))
1244 md = rte_mbuf_from_indirect(m);
1246 rte_mbuf_refcnt_update(md, 1);
1247 mi->priv_size = m->priv_size;
1248 mi->buf_physaddr = m->buf_physaddr;
1249 mi->buf_addr = m->buf_addr;
1250 mi->buf_len = m->buf_len;
1252 mi->data_off = m->data_off;
1253 mi->data_len = m->data_len;
1255 mi->vlan_tci = m->vlan_tci;
1256 mi->vlan_tci_outer = m->vlan_tci_outer;
1257 mi->tx_offload = m->tx_offload;
1261 mi->pkt_len = mi->data_len;
1263 mi->ol_flags = m->ol_flags | IND_ATTACHED_MBUF;
1264 mi->packet_type = m->packet_type;
1265 mi->timestamp = m->timestamp;
1267 __rte_mbuf_sanity_check(mi, 1);
1268 __rte_mbuf_sanity_check(m, 0);
1272 * Detach an indirect packet mbuf.
1274 * - restore original mbuf address and length values.
1275 * - reset pktmbuf data and data_len to their default values.
1276 * - decrement the direct mbuf's reference counter. When the
1277 * reference counter becomes 0, the direct mbuf is freed.
1279 * All other fields of the given packet mbuf will be left intact.
1282 * The indirect attached packet mbuf.
1284 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
1286 struct rte_mbuf *md = rte_mbuf_from_indirect(m);
1287 struct rte_mempool *mp = m->pool;
1288 uint32_t mbuf_size, buf_len, priv_size;
1290 priv_size = rte_pktmbuf_priv_size(mp);
1291 mbuf_size = sizeof(struct rte_mbuf) + priv_size;
1292 buf_len = rte_pktmbuf_data_room_size(mp);
1294 m->priv_size = priv_size;
1295 m->buf_addr = (char *)m + mbuf_size;
1296 m->buf_physaddr = rte_mempool_virt2phy(mp, m) + mbuf_size;
1297 m->buf_len = (uint16_t)buf_len;
1298 rte_pktmbuf_reset_headroom(m);
1302 if (rte_mbuf_refcnt_update(md, -1) == 0) {
1305 rte_mbuf_refcnt_set(md, 1);
1306 rte_mbuf_raw_free(md);
1311 * Decrease reference counter and unlink a mbuf segment
1313 * This function does the same than a free, except that it does not
1314 * return the segment to its pool.
1315 * It decreases the reference counter, and if it reaches 0, it is
1316 * detached from its parent for an indirect mbuf.
1319 * The mbuf to be unlinked
1321 * - (m) if it is the last reference. It can be recycled or freed.
1322 * - (NULL) if the mbuf still has remaining references on it.
1324 static __rte_always_inline struct rte_mbuf *
1325 rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
1327 __rte_mbuf_sanity_check(m, 0);
1329 if (likely(rte_mbuf_refcnt_read(m) == 1)) {
1331 if (RTE_MBUF_INDIRECT(m))
1332 rte_pktmbuf_detach(m);
1334 if (m->next != NULL) {
1341 } else if (rte_atomic16_add_return(&m->refcnt_atomic, -1) == 0) {
1344 if (RTE_MBUF_INDIRECT(m))
1345 rte_pktmbuf_detach(m);
1347 if (m->next != NULL) {
1351 rte_mbuf_refcnt_set(m, 1);
1358 /* deprecated, replaced by rte_pktmbuf_prefree_seg() */
1360 static inline struct rte_mbuf *
1361 __rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
1363 return rte_pktmbuf_prefree_seg(m);
1367 * Free a segment of a packet mbuf into its original mempool.
1369 * Free an mbuf, without parsing other segments in case of chained
1373 * The packet mbuf segment to be freed.
1375 static __rte_always_inline void
1376 rte_pktmbuf_free_seg(struct rte_mbuf *m)
1378 m = rte_pktmbuf_prefree_seg(m);
1379 if (likely(m != NULL))
1380 rte_mbuf_raw_free(m);
1384 * Free a packet mbuf back into its original mempool.
1386 * Free an mbuf, and all its segments in case of chained buffers. Each
1387 * segment is added back into its original mempool.
1390 * The packet mbuf to be freed.
1392 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
1394 struct rte_mbuf *m_next;
1396 __rte_mbuf_sanity_check(m, 1);
1400 rte_pktmbuf_free_seg(m);
1406 * Creates a "clone" of the given packet mbuf.
1408 * Walks through all segments of the given packet mbuf, and for each of them:
1409 * - Creates a new packet mbuf from the given pool.
1410 * - Attaches newly created mbuf to the segment.
1411 * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
1412 * from the original packet mbuf.
1415 * The packet mbuf to be cloned.
1417 * The mempool from which the "clone" mbufs are allocated.
1419 * - The pointer to the new "clone" mbuf on success.
1420 * - NULL if allocation fails.
1422 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
1423 struct rte_mempool *mp)
1425 struct rte_mbuf *mc, *mi, **prev;
1429 if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
1434 pktlen = md->pkt_len;
1439 rte_pktmbuf_attach(mi, md);
1442 } while ((md = md->next) != NULL &&
1443 (mi = rte_pktmbuf_alloc(mp)) != NULL);
1447 mc->pkt_len = pktlen;
1449 /* Allocation of new indirect segment failed */
1450 if (unlikely (mi == NULL)) {
1451 rte_pktmbuf_free(mc);
1455 __rte_mbuf_sanity_check(mc, 1);
1460 * Adds given value to the refcnt of all packet mbuf segments.
1462 * Walks through all segments of given packet mbuf and for each of them
1463 * invokes rte_mbuf_refcnt_update().
1466 * The packet mbuf whose refcnt to be updated.
1468 * The value to add to the mbuf's segments refcnt.
1470 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
1472 __rte_mbuf_sanity_check(m, 1);
1475 rte_mbuf_refcnt_update(m, v);
1476 } while ((m = m->next) != NULL);
1480 * Get the headroom in a packet mbuf.
1485 * The length of the headroom.
1487 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
1489 __rte_mbuf_sanity_check(m, 0);
1494 * Get the tailroom of a packet mbuf.
1499 * The length of the tailroom.
1501 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
1503 __rte_mbuf_sanity_check(m, 0);
1504 return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
1509 * Get the last segment of the packet.
1514 * The last segment of the given mbuf.
1516 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
1518 struct rte_mbuf *m2 = (struct rte_mbuf *)m;
1520 __rte_mbuf_sanity_check(m, 1);
1521 while (m2->next != NULL)
1527 * A macro that points to an offset into the data in the mbuf.
1529 * The returned pointer is cast to type t. Before using this
1530 * function, the user must ensure that the first segment is large
1531 * enough to accommodate its data.
1536 * The offset into the mbuf data.
1538 * The type to cast the result into.
1540 #define rte_pktmbuf_mtod_offset(m, t, o) \
1541 ((t)((char *)(m)->buf_addr + (m)->data_off + (o)))
1544 * A macro that points to the start of the data in the mbuf.
1546 * The returned pointer is cast to type t. Before using this
1547 * function, the user must ensure that the first segment is large
1548 * enough to accommodate its data.
1553 * The type to cast the result into.
1555 #define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0)
1558 * A macro that returns the physical address that points to an offset of the
1559 * start of the data in the mbuf
1564 * The offset into the data to calculate address from.
1566 #define rte_pktmbuf_mtophys_offset(m, o) \
1567 (phys_addr_t)((m)->buf_physaddr + (m)->data_off + (o))
1570 * A macro that returns the physical address that points to the start of the
1576 #define rte_pktmbuf_mtophys(m) rte_pktmbuf_mtophys_offset(m, 0)
1579 * A macro that returns the length of the packet.
1581 * The value can be read or assigned.
1586 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
1589 * A macro that returns the length of the segment.
1591 * The value can be read or assigned.
1596 #define rte_pktmbuf_data_len(m) ((m)->data_len)
1599 * Prepend len bytes to an mbuf data area.
1601 * Returns a pointer to the new
1602 * data start address. If there is not enough headroom in the first
1603 * segment, the function will return NULL, without modifying the mbuf.
1608 * The amount of data to prepend (in bytes).
1610 * A pointer to the start of the newly prepended data, or
1611 * NULL if there is not enough headroom space in the first segment
1613 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
1616 __rte_mbuf_sanity_check(m, 1);
1618 if (unlikely(len > rte_pktmbuf_headroom(m)))
1622 m->data_len = (uint16_t)(m->data_len + len);
1623 m->pkt_len = (m->pkt_len + len);
1625 return (char *)m->buf_addr + m->data_off;
1629 * Append len bytes to an mbuf.
1631 * Append len bytes to an mbuf and return a pointer to the start address
1632 * of the added data. If there is not enough tailroom in the last
1633 * segment, the function will return NULL, without modifying the mbuf.
1638 * The amount of data to append (in bytes).
1640 * A pointer to the start of the newly appended data, or
1641 * NULL if there is not enough tailroom space in the last segment
1643 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
1646 struct rte_mbuf *m_last;
1648 __rte_mbuf_sanity_check(m, 1);
1650 m_last = rte_pktmbuf_lastseg(m);
1651 if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
1654 tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
1655 m_last->data_len = (uint16_t)(m_last->data_len + len);
1656 m->pkt_len = (m->pkt_len + len);
1657 return (char*) tail;
1661 * Remove len bytes at the beginning of an mbuf.
1663 * Returns a pointer to the start address of the new data area. If the
1664 * length is greater than the length of the first segment, then the
1665 * function will fail and return NULL, without modifying the mbuf.
1670 * The amount of data to remove (in bytes).
1672 * A pointer to the new start of the data.
1674 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
1676 __rte_mbuf_sanity_check(m, 1);
1678 if (unlikely(len > m->data_len))
1681 m->data_len = (uint16_t)(m->data_len - len);
1683 m->pkt_len = (m->pkt_len - len);
1684 return (char *)m->buf_addr + m->data_off;
1688 * Remove len bytes of data at the end of the mbuf.
1690 * If the length is greater than the length of the last segment, the
1691 * function will fail and return -1 without modifying the mbuf.
1696 * The amount of data to remove (in bytes).
1701 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
1703 struct rte_mbuf *m_last;
1705 __rte_mbuf_sanity_check(m, 1);
1707 m_last = rte_pktmbuf_lastseg(m);
1708 if (unlikely(len > m_last->data_len))
1711 m_last->data_len = (uint16_t)(m_last->data_len - len);
1712 m->pkt_len = (m->pkt_len - len);
1717 * Test if mbuf data is contiguous.
1722 * - 1, if all data is contiguous (one segment).
1723 * - 0, if there is several segments.
1725 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
1727 __rte_mbuf_sanity_check(m, 1);
1728 return !!(m->nb_segs == 1);
1732 * @internal used by rte_pktmbuf_read().
1734 const void *__rte_pktmbuf_read(const struct rte_mbuf *m, uint32_t off,
1735 uint32_t len, void *buf);
1738 * Read len data bytes in a mbuf at specified offset.
1740 * If the data is contiguous, return the pointer in the mbuf data, else
1741 * copy the data in the buffer provided by the user and return its
1745 * The pointer to the mbuf.
1747 * The offset of the data in the mbuf.
1749 * The amount of bytes to read.
1751 * The buffer where data is copied if it is not contigous in mbuf
1752 * data. Its length should be at least equal to the len parameter.
1754 * The pointer to the data, either in the mbuf if it is contiguous,
1755 * or in the user buffer. If mbuf is too small, NULL is returned.
1757 static inline const void *rte_pktmbuf_read(const struct rte_mbuf *m,
1758 uint32_t off, uint32_t len, void *buf)
1760 if (likely(off + len <= rte_pktmbuf_data_len(m)))
1761 return rte_pktmbuf_mtod_offset(m, char *, off);
1763 return __rte_pktmbuf_read(m, off, len, buf);
1767 * Chain an mbuf to another, thereby creating a segmented packet.
1769 * Note: The implementation will do a linear walk over the segments to find
1770 * the tail entry. For cases when there are many segments, it's better to
1771 * chain the entries manually.
1774 * The head of the mbuf chain (the first packet)
1776 * The mbuf to put last in the chain
1780 * - -EOVERFLOW, if the chain is full (256 entries)
1782 static inline int rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail)
1784 struct rte_mbuf *cur_tail;
1786 /* Check for number-of-segments-overflow */
1787 if (head->nb_segs + tail->nb_segs >= 1 << (sizeof(head->nb_segs) * 8))
1790 /* Chain 'tail' onto the old tail */
1791 cur_tail = rte_pktmbuf_lastseg(head);
1792 cur_tail->next = tail;
1794 /* accumulate number of segments and total length. */
1795 head->nb_segs = (uint8_t)(head->nb_segs + tail->nb_segs);
1796 head->pkt_len += tail->pkt_len;
1798 /* pkt_len is only set in the head */
1799 tail->pkt_len = tail->data_len;
1805 * Validate general requirements for Tx offload in mbuf.
1807 * This function checks correctness and completeness of Tx offload settings.
1810 * The packet mbuf to be validated.
1812 * 0 if packet is valid
1815 rte_validate_tx_offload(const struct rte_mbuf *m)
1817 uint64_t ol_flags = m->ol_flags;
1818 uint64_t inner_l3_offset = m->l2_len;
1820 /* Does packet set any of available offloads? */
1821 if (!(ol_flags & PKT_TX_OFFLOAD_MASK))
1824 if (ol_flags & PKT_TX_OUTER_IP_CKSUM)
1825 inner_l3_offset += m->outer_l2_len + m->outer_l3_len;
1827 /* Headers are fragmented */
1828 if (rte_pktmbuf_data_len(m) < inner_l3_offset + m->l3_len + m->l4_len)
1831 /* IP checksum can be counted only for IPv4 packet */
1832 if ((ol_flags & PKT_TX_IP_CKSUM) && (ol_flags & PKT_TX_IPV6))
1835 /* IP type not set when required */
1836 if (ol_flags & (PKT_TX_L4_MASK | PKT_TX_TCP_SEG))
1837 if (!(ol_flags & (PKT_TX_IPV4 | PKT_TX_IPV6)))
1840 /* Check requirements for TSO packet */
1841 if (ol_flags & PKT_TX_TCP_SEG)
1842 if ((m->tso_segsz == 0) ||
1843 ((ol_flags & PKT_TX_IPV4) &&
1844 !(ol_flags & PKT_TX_IP_CKSUM)))
1847 /* PKT_TX_OUTER_IP_CKSUM set for non outer IPv4 packet. */
1848 if ((ol_flags & PKT_TX_OUTER_IP_CKSUM) &&
1849 !(ol_flags & PKT_TX_OUTER_IPV4))
1856 * Linearize data in mbuf.
1858 * This function moves the mbuf data in the first segment if there is enough
1859 * tailroom. The subsequent segments are unchained and freed.
1868 rte_pktmbuf_linearize(struct rte_mbuf *mbuf)
1870 int seg_len, copy_len;
1872 struct rte_mbuf *m_next;
1875 if (rte_pktmbuf_is_contiguous(mbuf))
1878 /* Extend first segment to the total packet length */
1879 copy_len = rte_pktmbuf_pkt_len(mbuf) - rte_pktmbuf_data_len(mbuf);
1881 if (unlikely(copy_len > rte_pktmbuf_tailroom(mbuf)))
1884 buffer = rte_pktmbuf_mtod_offset(mbuf, char *, mbuf->data_len);
1885 mbuf->data_len = (uint16_t)(mbuf->pkt_len);
1887 /* Append data from next segments to the first one */
1892 seg_len = rte_pktmbuf_data_len(m);
1893 rte_memcpy(buffer, rte_pktmbuf_mtod(m, char *), seg_len);
1896 rte_pktmbuf_free_seg(m);
1907 * Dump an mbuf structure to a file.
1909 * Dump all fields for the given packet mbuf and all its associated
1910 * segments (in the case of a chained buffer).
1913 * A pointer to a file for output
1917 * If dump_len != 0, also dump the "dump_len" first data bytes of
1920 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
1926 #endif /* _RTE_MBUF_H_ */