4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41 * The mbuf library provides the ability to create and destroy buffers
42 * that may be used by the RTE application to store message
43 * buffers. The message buffers are stored in a mempool, using the
44 * RTE mempool library.
46 * This library provide an API to allocate/free packet mbufs, which are
47 * used to carry network packets.
49 * To understand the concepts of packet buffers or mbufs, you
50 * should read "TCP/IP Illustrated, Volume 2: The Implementation,
51 * Addison-Wesley, 1995, ISBN 0-201-63354-X from Richard Stevens"
52 * http://www.kohala.com/start/tcpipiv2.html
56 #include <rte_mempool.h>
57 #include <rte_atomic.h>
58 #include <rte_prefetch.h>
59 #include <rte_branch_prediction.h>
65 /* deprecated feature, renamed in RTE_MBUF_REFCNT */
66 #pragma GCC poison RTE_MBUF_SCATTER_GATHER
69 * Packet Offload Features Flags. It also carry packet type information.
70 * Critical resources. Both rx/tx shared these bits. Be cautious on any change
72 * - RX flags start at bit position zero, and get added to the left of previous
74 * - The most-significant 8 bits are reserved for generic mbuf flags
75 * - TX flags therefore start at bit position 55 (i.e. 63-8), and new flags get
76 * added to the right of the previously defined flags
78 #define PKT_RX_VLAN_PKT (1ULL << 0) /**< RX packet is a 802.1q VLAN packet. */
79 #define PKT_RX_RSS_HASH (1ULL << 1) /**< RX packet with RSS hash result. */
80 #define PKT_RX_FDIR (1ULL << 2) /**< RX packet with FDIR infos. */
81 #define PKT_RX_L4_CKSUM_BAD (1ULL << 3) /**< L4 cksum of RX pkt. is not OK. */
82 #define PKT_RX_IP_CKSUM_BAD (1ULL << 4) /**< IP cksum of RX pkt. is not OK. */
83 #define PKT_RX_EIP_CKSUM_BAD (0ULL << 0) /**< External IP header checksum error. */
84 #define PKT_RX_OVERSIZE (0ULL << 0) /**< Num of desc of an RX pkt oversize. */
85 #define PKT_RX_HBUF_OVERFLOW (0ULL << 0) /**< Header buffer overflow. */
86 #define PKT_RX_RECIP_ERR (0ULL << 0) /**< Hardware processing error. */
87 #define PKT_RX_MAC_ERR (0ULL << 0) /**< MAC error. */
88 #define PKT_RX_IPV4_HDR (1ULL << 5) /**< RX packet with IPv4 header. */
89 #define PKT_RX_IPV4_HDR_EXT (1ULL << 6) /**< RX packet with extended IPv4 header. */
90 #define PKT_RX_IPV6_HDR (1ULL << 7) /**< RX packet with IPv6 header. */
91 #define PKT_RX_IPV6_HDR_EXT (1ULL << 8) /**< RX packet with extended IPv6 header. */
92 #define PKT_RX_IEEE1588_PTP (1ULL << 9) /**< RX IEEE1588 L2 Ethernet PT Packet. */
93 #define PKT_RX_IEEE1588_TMST (1ULL << 10) /**< RX IEEE1588 L2/L4 timestamped packet.*/
94 #define PKT_RX_TUNNEL_IPV4_HDR (1ULL << 11) /**< RX tunnel packet with IPv4 header.*/
95 #define PKT_RX_TUNNEL_IPV6_HDR (1ULL << 12) /**< RX tunnel packet with IPv6 header. */
97 #define PKT_TX_VLAN_PKT (1ULL << 55) /**< TX packet is a 802.1q VLAN packet. */
98 #define PKT_TX_IP_CKSUM (1ULL << 54) /**< IP cksum of TX pkt. computed by NIC. */
99 #define PKT_TX_VXLAN_CKSUM (1ULL << 50) /**< TX checksum of VXLAN computed by NIC */
100 #define PKT_TX_IPV4_CSUM PKT_TX_IP_CKSUM /**< Alias of PKT_TX_IP_CKSUM. */
101 #define PKT_TX_IPV4 PKT_RX_IPV4_HDR /**< IPv4 with no IP checksum offload. */
102 #define PKT_TX_IPV6 PKT_RX_IPV6_HDR /**< IPv6 packet */
105 * Bits 52+53 used for L4 packet type with checksum enabled.
111 #define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */
112 #define PKT_TX_TCP_CKSUM (1ULL << 52) /**< TCP cksum of TX pkt. computed by NIC. */
113 #define PKT_TX_SCTP_CKSUM (2ULL << 52) /**< SCTP cksum of TX pkt. computed by NIC. */
114 #define PKT_TX_UDP_CKSUM (3ULL << 52) /**< UDP cksum of TX pkt. computed by NIC. */
115 #define PKT_TX_L4_MASK (3ULL << 52) /**< Mask for L4 cksum offload request. */
117 /* Bit 51 - IEEE1588*/
118 #define PKT_TX_IEEE1588_TMST (1ULL << 51) /**< TX IEEE1588 packet to timestamp. */
120 /* Use final bit of flags to indicate a control mbuf */
121 #define CTRL_MBUF_FLAG (1ULL << 63) /**< Mbuf contains control data */
124 * Bit Mask to indicate what bits required for building TX context
126 #define PKT_TX_OFFLOAD_MASK (PKT_TX_VLAN_PKT | PKT_TX_IP_CKSUM | PKT_TX_L4_MASK)
128 /* define a set of marker types that can be used to refer to set points in the
130 typedef void *MARKER[0]; /**< generic marker for a point in a structure */
131 typedef uint64_t MARKER64[0]; /**< marker that allows us to overwrite 8 bytes
132 * with a single assignment */
134 * The generic rte_mbuf, containing a packet mbuf.
139 void *buf_addr; /**< Virtual address of segment buffer. */
140 phys_addr_t buf_physaddr; /**< Physical address of segment buffer. */
142 /* next 8 bytes are initialised on RX descriptor rearm */
144 uint16_t buf_len; /**< Length of segment buffer. */
148 * 16-bit Reference counter.
149 * It should only be accessed using the following functions:
150 * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
151 * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
152 * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
156 #ifdef RTE_MBUF_REFCNT
157 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
158 uint16_t refcnt; /**< Non-atomically accessed refcnt */
160 uint16_t refcnt_reserved; /**< Do not use this field */
162 uint8_t nb_segs; /**< Number of segments. */
163 uint8_t port; /**< Input port. */
165 uint64_t ol_flags; /**< Offload features. */
167 /* remaining bytes are set on RX when pulling packet from descriptor */
168 MARKER rx_descriptor_fields1;
171 * The packet type, which is used to indicate ordinary packet and also
172 * tunneled packet format, i.e. each number is represented a type of
175 uint16_t packet_type;
177 uint16_t data_len; /**< Amount of data in segment buffer. */
178 uint32_t pkt_len; /**< Total pkt len: sum of all segments. */
179 uint16_t vlan_tci; /**< VLAN Tag Control Identifier (CPU order) */
182 uint32_t rss; /**< RSS hash result if RSS enabled */
186 } fdir; /**< Filter identifier if FDIR enabled */
187 uint32_t sched; /**< Hierarchical scheduler */
188 } hash; /**< hash information */
190 /* second cache line - fields only used in slow path or on TX */
191 MARKER cacheline1 __rte_cache_aligned;
194 void *userdata; /**< Can be used for external metadata */
195 uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */
198 struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
199 struct rte_mbuf *next; /**< Next segment of scattered packet. */
201 /* fields to support TX offloads */
203 uint16_t l2_l3_len; /**< combined l2/l3 lengths as single var */
205 uint16_t l3_len:9; /**< L3 (IP) Header Length. */
206 uint16_t l2_len:7; /**< L2 (MAC) Header Length. */
210 /* fields for TX offloading of tunnels */
212 uint16_t inner_l2_l3_len;
213 /**< combined inner l2/l3 lengths as single var */
215 uint16_t inner_l3_len:9;
216 /**< inner L3 (IP) Header Length. */
217 uint16_t inner_l2_len:7;
218 /**< inner L2 (MAC) Header Length. */
221 } __rte_cache_aligned;
224 * Given the buf_addr returns the pointer to corresponding mbuf.
226 #define RTE_MBUF_FROM_BADDR(ba) (((struct rte_mbuf *)(ba)) - 1)
229 * Given the pointer to mbuf returns an address where it's buf_addr
232 #define RTE_MBUF_TO_BADDR(mb) (((struct rte_mbuf *)(mb)) + 1)
235 * Returns TRUE if given mbuf is indirect, or FALSE otherwise.
237 #define RTE_MBUF_INDIRECT(mb) (RTE_MBUF_FROM_BADDR((mb)->buf_addr) != (mb))
240 * Returns TRUE if given mbuf is direct, or FALSE otherwise.
242 #define RTE_MBUF_DIRECT(mb) (RTE_MBUF_FROM_BADDR((mb)->buf_addr) == (mb))
246 * Private data in case of pktmbuf pool.
248 * A structure that contains some pktmbuf_pool-specific data that are
249 * appended after the mempool structure (in private data).
251 struct rte_pktmbuf_pool_private {
252 uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf.*/
255 #ifdef RTE_LIBRTE_MBUF_DEBUG
257 /** check mbuf type in debug mode */
258 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
260 /** check mbuf type in debug mode if mbuf pointer is not null */
261 #define __rte_mbuf_sanity_check_raw(m, is_h) do { \
263 rte_mbuf_sanity_check(m, is_h); \
266 /** MBUF asserts in debug mode */
267 #define RTE_MBUF_ASSERT(exp) \
269 rte_panic("line%d\tassert \"" #exp "\" failed\n", __LINE__); \
272 #else /* RTE_LIBRTE_MBUF_DEBUG */
274 /** check mbuf type in debug mode */
275 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
277 /** check mbuf type in debug mode if mbuf pointer is not null */
278 #define __rte_mbuf_sanity_check_raw(m, is_h) do { } while (0)
280 /** MBUF asserts in debug mode */
281 #define RTE_MBUF_ASSERT(exp) do { } while (0)
283 #endif /* RTE_LIBRTE_MBUF_DEBUG */
285 #ifdef RTE_MBUF_REFCNT
286 #ifdef RTE_MBUF_REFCNT_ATOMIC
289 * Adds given value to an mbuf's refcnt and returns its new value.
293 * Value to add/subtract
297 static inline uint16_t
298 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
300 return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
304 * Reads the value of an mbuf's refcnt.
308 * Reference count number.
310 static inline uint16_t
311 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
313 return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
317 * Sets an mbuf's refcnt to a defined value.
324 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
326 rte_atomic16_set(&m->refcnt_atomic, new_value);
329 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
332 * Adds given value to an mbuf's refcnt and returns its new value.
334 static inline uint16_t
335 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
337 m->refcnt = (uint16_t)(m->refcnt + value);
342 * Reads the value of an mbuf's refcnt.
344 static inline uint16_t
345 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
351 * Sets an mbuf's refcnt to the defined value.
354 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
356 m->refcnt = new_value;
359 #endif /* RTE_MBUF_REFCNT_ATOMIC */
362 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { \
367 #else /* ! RTE_MBUF_REFCNT */
370 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { } while(0)
372 #define rte_mbuf_refcnt_set(m,v) do { } while(0)
374 #endif /* RTE_MBUF_REFCNT */
378 * Sanity checks on an mbuf.
380 * Check the consistency of the given mbuf. The function will cause a
381 * panic if corruption is detected.
384 * The mbuf to be checked.
386 * True if the mbuf is a packet header, false if it is a sub-segment
387 * of a packet (in this case, some fields like nb_segs are not checked)
390 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
393 * @internal Allocate a new mbuf from mempool *mp*.
394 * The use of that function is reserved for RTE internal needs.
395 * Please use rte_pktmbuf_alloc().
398 * The mempool from which mbuf is allocated.
400 * - The pointer to the new mbuf on success.
401 * - NULL if allocation failed.
403 static inline struct rte_mbuf *__rte_mbuf_raw_alloc(struct rte_mempool *mp)
407 if (rte_mempool_get(mp, &mb) < 0)
409 m = (struct rte_mbuf *)mb;
410 #ifdef RTE_MBUF_REFCNT
411 RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
412 rte_mbuf_refcnt_set(m, 1);
413 #endif /* RTE_MBUF_REFCNT */
418 * @internal Put mbuf back into its original mempool.
419 * The use of that function is reserved for RTE internal needs.
420 * Please use rte_pktmbuf_free().
423 * The mbuf to be freed.
425 static inline void __attribute__((always_inline))
426 __rte_mbuf_raw_free(struct rte_mbuf *m)
428 #ifdef RTE_MBUF_REFCNT
429 RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
430 #endif /* RTE_MBUF_REFCNT */
431 rte_mempool_put(m->pool, m);
434 /* Operations on ctrl mbuf */
437 * The control mbuf constructor.
439 * This function initializes some fields in an mbuf structure that are
440 * not modified by the user once created (mbuf type, origin pool, buffer
441 * start address, and so on). This function is given as a callback function
442 * to rte_mempool_create() at pool creation time.
445 * The mempool from which the mbuf is allocated.
447 * A pointer that can be used by the user to retrieve useful information
448 * for mbuf initialization. This pointer comes from the ``init_arg``
449 * parameter of rte_mempool_create().
451 * The mbuf to initialize.
453 * The index of the mbuf in the pool table.
455 void rte_ctrlmbuf_init(struct rte_mempool *mp, void *opaque_arg,
456 void *m, unsigned i);
459 * Allocate a new mbuf (type is ctrl) from mempool *mp*.
461 * This new mbuf is initialized with data pointing to the beginning of
462 * buffer, and with a length of zero.
465 * The mempool from which the mbuf is allocated.
467 * - The pointer to the new mbuf on success.
468 * - NULL if allocation failed.
470 #define rte_ctrlmbuf_alloc(mp) rte_pktmbuf_alloc(mp)
473 * Free a control mbuf back into its original mempool.
476 * The control mbuf to be freed.
478 #define rte_ctrlmbuf_free(m) rte_pktmbuf_free(m)
481 * A macro that returns the pointer to the carried data.
483 * The value that can be read or assigned.
488 #define rte_ctrlmbuf_data(m) ((char *)((m)->buf_addr) + (m)->data_off)
491 * A macro that returns the length of the carried data.
493 * The value that can be read or assigned.
498 #define rte_ctrlmbuf_len(m) rte_pktmbuf_data_len(m)
501 * Tests if an mbuf is a control mbuf
504 * The mbuf to be tested
506 * - True (1) if the mbuf is a control mbuf
507 * - False(0) otherwise
510 rte_is_ctrlmbuf(struct rte_mbuf *m)
512 return (!!(m->ol_flags & CTRL_MBUF_FLAG));
515 /* Operations on pkt mbuf */
518 * The packet mbuf constructor.
520 * This function initializes some fields in the mbuf structure that are
521 * not modified by the user once created (origin pool, buffer start
522 * address, and so on). This function is given as a callback function to
523 * rte_mempool_create() at pool creation time.
526 * The mempool from which mbufs originate.
528 * A pointer that can be used by the user to retrieve useful information
529 * for mbuf initialization. This pointer comes from the ``init_arg``
530 * parameter of rte_mempool_create().
532 * The mbuf to initialize.
534 * The index of the mbuf in the pool table.
536 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
537 void *m, unsigned i);
541 * A packet mbuf pool constructor.
543 * This function initializes the mempool private data in the case of a
544 * pktmbuf pool. This private data is needed by the driver. The
545 * function is given as a callback function to rte_mempool_create() at
546 * pool creation. It can be extended by the user, for example, to
547 * provide another packet size.
550 * The mempool from which mbufs originate.
552 * A pointer that can be used by the user to retrieve useful information
553 * for mbuf initialization. This pointer comes from the ``init_arg``
554 * parameter of rte_mempool_create().
556 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
559 * Reset the fields of a packet mbuf to their default values.
561 * The given mbuf must have only one segment.
564 * The packet mbuf to be resetted.
566 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
571 m->inner_l2_l3_len = 0;
578 m->data_off = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
579 RTE_PKTMBUF_HEADROOM : m->buf_len;
582 __rte_mbuf_sanity_check(m, 1);
586 * Allocate a new mbuf from a mempool.
588 * This new mbuf contains one segment, which has a length of 0. The pointer
589 * to data is initialized to have some bytes of headroom in the buffer
590 * (if buffer size allows).
593 * The mempool from which the mbuf is allocated.
595 * - The pointer to the new mbuf on success.
596 * - NULL if allocation failed.
598 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
601 if ((m = __rte_mbuf_raw_alloc(mp)) != NULL)
602 rte_pktmbuf_reset(m);
606 #ifdef RTE_MBUF_REFCNT
609 * Attach packet mbuf to another packet mbuf.
610 * After attachment we refer the mbuf we attached as 'indirect',
611 * while mbuf we attached to as 'direct'.
612 * Right now, not supported:
613 * - attachment to indirect mbuf (e.g. - md has to be direct).
614 * - attachment for already indirect mbuf (e.g. - mi has to be direct).
615 * - mbuf we trying to attach (mi) is used by someone else
616 * e.g. it's reference counter is greater then 1.
619 * The indirect packet mbuf.
621 * The direct packet mbuf.
624 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *md)
626 RTE_MBUF_ASSERT(RTE_MBUF_DIRECT(md) &&
627 RTE_MBUF_DIRECT(mi) &&
628 rte_mbuf_refcnt_read(mi) == 1);
630 rte_mbuf_refcnt_update(md, 1);
631 mi->buf_physaddr = md->buf_physaddr;
632 mi->buf_addr = md->buf_addr;
633 mi->buf_len = md->buf_len;
636 mi->data_off = md->data_off;
637 mi->data_len = md->data_len;
639 mi->vlan_tci = md->vlan_tci;
640 mi->l2_l3_len = md->l2_l3_len;
641 mi->inner_l2_l3_len = md->inner_l2_l3_len;
645 mi->pkt_len = mi->data_len;
647 mi->ol_flags = md->ol_flags;
648 mi->packet_type = md->packet_type;
650 __rte_mbuf_sanity_check(mi, 1);
651 __rte_mbuf_sanity_check(md, 0);
655 * Detach an indirect packet mbuf -
656 * - restore original mbuf address and length values.
657 * - reset pktmbuf data and data_len to their default values.
658 * All other fields of the given packet mbuf will be left intact.
661 * The indirect attached packet mbuf.
664 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
666 const struct rte_mempool *mp = m->pool;
667 void *buf = RTE_MBUF_TO_BADDR(m);
668 uint32_t buf_len = mp->elt_size - sizeof(*m);
669 m->buf_physaddr = rte_mempool_virt2phy(mp, m) + sizeof (*m);
672 m->buf_len = (uint16_t)buf_len;
674 m->data_off = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
675 RTE_PKTMBUF_HEADROOM : m->buf_len;
680 #endif /* RTE_MBUF_REFCNT */
683 static inline struct rte_mbuf* __attribute__((always_inline))
684 __rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
686 __rte_mbuf_sanity_check(m, 0);
688 #ifdef RTE_MBUF_REFCNT
689 if (likely (rte_mbuf_refcnt_read(m) == 1) ||
690 likely (rte_mbuf_refcnt_update(m, -1) == 0)) {
691 struct rte_mbuf *md = RTE_MBUF_FROM_BADDR(m->buf_addr);
693 rte_mbuf_refcnt_set(m, 0);
695 /* if this is an indirect mbuf, then
697 * - free attached mbuf segment
699 if (unlikely (md != m)) {
700 rte_pktmbuf_detach(m);
701 if (rte_mbuf_refcnt_update(md, -1) == 0)
702 __rte_mbuf_raw_free(md);
706 #ifdef RTE_MBUF_REFCNT
713 * Free a segment of a packet mbuf into its original mempool.
715 * Free an mbuf, without parsing other segments in case of chained
719 * The packet mbuf segment to be freed.
721 static inline void __attribute__((always_inline))
722 rte_pktmbuf_free_seg(struct rte_mbuf *m)
724 if (likely(NULL != (m = __rte_pktmbuf_prefree_seg(m)))) {
726 __rte_mbuf_raw_free(m);
731 * Free a packet mbuf back into its original mempool.
733 * Free an mbuf, and all its segments in case of chained buffers. Each
734 * segment is added back into its original mempool.
737 * The packet mbuf to be freed.
739 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
741 struct rte_mbuf *m_next;
743 __rte_mbuf_sanity_check(m, 1);
747 rte_pktmbuf_free_seg(m);
752 #ifdef RTE_MBUF_REFCNT
755 * Creates a "clone" of the given packet mbuf.
757 * Walks through all segments of the given packet mbuf, and for each of them:
758 * - Creates a new packet mbuf from the given pool.
759 * - Attaches newly created mbuf to the segment.
760 * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
761 * from the original packet mbuf.
764 * The packet mbuf to be cloned.
766 * The mempool from which the "clone" mbufs are allocated.
768 * - The pointer to the new "clone" mbuf on success.
769 * - NULL if allocation fails.
771 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
772 struct rte_mempool *mp)
774 struct rte_mbuf *mc, *mi, **prev;
778 if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
783 pktlen = md->pkt_len;
788 rte_pktmbuf_attach(mi, md);
791 } while ((md = md->next) != NULL &&
792 (mi = rte_pktmbuf_alloc(mp)) != NULL);
796 mc->pkt_len = pktlen;
798 /* Allocation of new indirect segment failed */
799 if (unlikely (mi == NULL)) {
800 rte_pktmbuf_free(mc);
804 __rte_mbuf_sanity_check(mc, 1);
809 * Adds given value to the refcnt of all packet mbuf segments.
811 * Walks through all segments of given packet mbuf and for each of them
812 * invokes rte_mbuf_refcnt_update().
815 * The packet mbuf whose refcnt to be updated.
817 * The value to add to the mbuf's segments refcnt.
819 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
821 __rte_mbuf_sanity_check(m, 1);
824 rte_mbuf_refcnt_update(m, v);
825 } while ((m = m->next) != NULL);
828 #endif /* RTE_MBUF_REFCNT */
831 * Get the headroom in a packet mbuf.
836 * The length of the headroom.
838 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
840 __rte_mbuf_sanity_check(m, 1);
845 * Get the tailroom of a packet mbuf.
850 * The length of the tailroom.
852 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
854 __rte_mbuf_sanity_check(m, 1);
855 return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
860 * Get the last segment of the packet.
865 * The last segment of the given mbuf.
867 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
869 struct rte_mbuf *m2 = (struct rte_mbuf *)m;
871 __rte_mbuf_sanity_check(m, 1);
872 while (m2->next != NULL)
878 * A macro that points to the start of the data in the mbuf.
880 * The returned pointer is cast to type t. Before using this
881 * function, the user must ensure that m_headlen(m) is large enough to
887 * The type to cast the result into.
889 #define rte_pktmbuf_mtod(m, t) ((t)((char *)(m)->buf_addr + (m)->data_off))
892 * A macro that returns the length of the packet.
894 * The value can be read or assigned.
899 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
902 * A macro that returns the length of the segment.
904 * The value can be read or assigned.
909 #define rte_pktmbuf_data_len(m) ((m)->data_len)
912 * Prepend len bytes to an mbuf data area.
914 * Returns a pointer to the new
915 * data start address. If there is not enough headroom in the first
916 * segment, the function will return NULL, without modifying the mbuf.
921 * The amount of data to prepend (in bytes).
923 * A pointer to the start of the newly prepended data, or
924 * NULL if there is not enough headroom space in the first segment
926 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
929 __rte_mbuf_sanity_check(m, 1);
931 if (unlikely(len > rte_pktmbuf_headroom(m)))
935 m->data_len = (uint16_t)(m->data_len + len);
936 m->pkt_len = (m->pkt_len + len);
938 return (char *)m->buf_addr + m->data_off;
942 * Append len bytes to an mbuf.
944 * Append len bytes to an mbuf and return a pointer to the start address
945 * of the added data. If there is not enough tailroom in the last
946 * segment, the function will return NULL, without modifying the mbuf.
951 * The amount of data to append (in bytes).
953 * A pointer to the start of the newly appended data, or
954 * NULL if there is not enough tailroom space in the last segment
956 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
959 struct rte_mbuf *m_last;
961 __rte_mbuf_sanity_check(m, 1);
963 m_last = rte_pktmbuf_lastseg(m);
964 if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
967 tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
968 m_last->data_len = (uint16_t)(m_last->data_len + len);
969 m->pkt_len = (m->pkt_len + len);
974 * Remove len bytes at the beginning of an mbuf.
976 * Returns a pointer to the start address of the new data area. If the
977 * length is greater than the length of the first segment, then the
978 * function will fail and return NULL, without modifying the mbuf.
983 * The amount of data to remove (in bytes).
985 * A pointer to the new start of the data.
987 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
989 __rte_mbuf_sanity_check(m, 1);
991 if (unlikely(len > m->data_len))
994 m->data_len = (uint16_t)(m->data_len - len);
996 m->pkt_len = (m->pkt_len - len);
997 return (char *)m->buf_addr + m->data_off;
1001 * Remove len bytes of data at the end of the mbuf.
1003 * If the length is greater than the length of the last segment, the
1004 * function will fail and return -1 without modifying the mbuf.
1009 * The amount of data to remove (in bytes).
1014 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
1016 struct rte_mbuf *m_last;
1018 __rte_mbuf_sanity_check(m, 1);
1020 m_last = rte_pktmbuf_lastseg(m);
1021 if (unlikely(len > m_last->data_len))
1024 m_last->data_len = (uint16_t)(m_last->data_len - len);
1025 m->pkt_len = (m->pkt_len - len);
1030 * Test if mbuf data is contiguous.
1035 * - 1, if all data is contiguous (one segment).
1036 * - 0, if there is several segments.
1038 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
1040 __rte_mbuf_sanity_check(m, 1);
1041 return !!(m->nb_segs == 1);
1045 * Dump an mbuf structure to the console.
1047 * Dump all fields for the given packet mbuf and all its associated
1048 * segments (in the case of a chained buffer).
1051 * A pointer to a file for output
1055 * If dump_len != 0, also dump the "dump_len" first data bytes of
1058 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
1064 #endif /* _RTE_MBUF_H_ */