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_IPV4_CSUM PKT_TX_IP_CKSUM /**< Alias of PKT_TX_IP_CKSUM. */
100 #define PKT_TX_IPV4 PKT_RX_IPV4_HDR /**< IPv4 with no IP checksum offload. */
101 #define PKT_TX_IPV6 PKT_RX_IPV6_HDR /**< IPv6 packet */
104 * Bits 52+53 used for L4 packet type with checksum enabled.
110 #define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */
111 #define PKT_TX_TCP_CKSUM (1ULL << 52) /**< TCP cksum of TX pkt. computed by NIC. */
112 #define PKT_TX_SCTP_CKSUM (2ULL << 52) /**< SCTP cksum of TX pkt. computed by NIC. */
113 #define PKT_TX_UDP_CKSUM (3ULL << 52) /**< UDP cksum of TX pkt. computed by NIC. */
114 #define PKT_TX_L4_MASK (3ULL << 52) /**< Mask for L4 cksum offload request. */
116 /* Bit 51 - IEEE1588*/
117 #define PKT_TX_IEEE1588_TMST (1ULL << 51) /**< TX IEEE1588 packet to timestamp. */
119 /* Use final bit of flags to indicate a control mbuf */
120 #define CTRL_MBUF_FLAG (1ULL << 63) /**< Mbuf contains control data */
123 * Bit Mask to indicate what bits required for building TX context
125 #define PKT_TX_OFFLOAD_MASK (PKT_TX_VLAN_PKT | PKT_TX_IP_CKSUM | PKT_TX_L4_MASK)
127 /* define a set of marker types that can be used to refer to set points in the
129 typedef void *MARKER[0]; /**< generic marker for a point in a structure */
130 typedef uint64_t MARKER64[0]; /**< marker that allows us to overwrite 8 bytes
131 * with a single assignment */
133 * The generic rte_mbuf, containing a packet mbuf.
138 void *buf_addr; /**< Virtual address of segment buffer. */
139 phys_addr_t buf_physaddr; /**< Physical address of segment buffer. */
141 /* next 8 bytes are initialised on RX descriptor rearm */
143 uint16_t buf_len; /**< Length of segment buffer. */
147 * 16-bit Reference counter.
148 * It should only be accessed using the following functions:
149 * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
150 * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
151 * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
155 #ifdef RTE_MBUF_REFCNT
156 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
157 uint16_t refcnt; /**< Non-atomically accessed refcnt */
159 uint16_t refcnt_reserved; /**< Do not use this field */
161 uint8_t nb_segs; /**< Number of segments. */
162 uint8_t port; /**< Input port. */
164 uint64_t ol_flags; /**< Offload features. */
166 /* remaining bytes are set on RX when pulling packet from descriptor */
167 MARKER rx_descriptor_fields1;
170 * The packet type, which is used to indicate ordinary packet and also
171 * tunneled packet format, i.e. each number is represented a type of
174 uint16_t packet_type;
176 uint16_t data_len; /**< Amount of data in segment buffer. */
177 uint32_t pkt_len; /**< Total pkt len: sum of all segments. */
178 uint16_t vlan_tci; /**< VLAN Tag Control Identifier (CPU order) */
181 uint32_t rss; /**< RSS hash result if RSS enabled */
185 } fdir; /**< Filter identifier if FDIR enabled */
186 uint32_t sched; /**< Hierarchical scheduler */
187 } hash; /**< hash information */
189 /* second cache line - fields only used in slow path or on TX */
190 MARKER cacheline1 __rte_cache_aligned;
193 void *userdata; /**< Can be used for external metadata */
194 uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */
197 struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
198 struct rte_mbuf *next; /**< Next segment of scattered packet. */
200 /* fields to support TX offloads */
202 uint16_t l2_l3_len; /**< combined l2/l3 lengths as single var */
204 uint16_t l3_len:9; /**< L3 (IP) Header Length. */
205 uint16_t l2_len:7; /**< L2 (MAC) Header Length. */
209 /* fields for TX offloading of tunnels */
211 uint16_t inner_l2_l3_len;
212 /**< combined inner l2/l3 lengths as single var */
214 uint16_t inner_l3_len:9;
215 /**< inner L3 (IP) Header Length. */
216 uint16_t inner_l2_len:7;
217 /**< inner L2 (MAC) Header Length. */
220 } __rte_cache_aligned;
223 * Given the buf_addr returns the pointer to corresponding mbuf.
225 #define RTE_MBUF_FROM_BADDR(ba) (((struct rte_mbuf *)(ba)) - 1)
228 * Given the pointer to mbuf returns an address where it's buf_addr
231 #define RTE_MBUF_TO_BADDR(mb) (((struct rte_mbuf *)(mb)) + 1)
234 * Returns TRUE if given mbuf is indirect, or FALSE otherwise.
236 #define RTE_MBUF_INDIRECT(mb) (RTE_MBUF_FROM_BADDR((mb)->buf_addr) != (mb))
239 * Returns TRUE if given mbuf is direct, or FALSE otherwise.
241 #define RTE_MBUF_DIRECT(mb) (RTE_MBUF_FROM_BADDR((mb)->buf_addr) == (mb))
245 * Private data in case of pktmbuf pool.
247 * A structure that contains some pktmbuf_pool-specific data that are
248 * appended after the mempool structure (in private data).
250 struct rte_pktmbuf_pool_private {
251 uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf.*/
254 #ifdef RTE_LIBRTE_MBUF_DEBUG
256 /** check mbuf type in debug mode */
257 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
259 /** check mbuf type in debug mode if mbuf pointer is not null */
260 #define __rte_mbuf_sanity_check_raw(m, is_h) do { \
262 rte_mbuf_sanity_check(m, is_h); \
265 /** MBUF asserts in debug mode */
266 #define RTE_MBUF_ASSERT(exp) \
268 rte_panic("line%d\tassert \"" #exp "\" failed\n", __LINE__); \
271 #else /* RTE_LIBRTE_MBUF_DEBUG */
273 /** check mbuf type in debug mode */
274 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
276 /** check mbuf type in debug mode if mbuf pointer is not null */
277 #define __rte_mbuf_sanity_check_raw(m, is_h) do { } while (0)
279 /** MBUF asserts in debug mode */
280 #define RTE_MBUF_ASSERT(exp) do { } while (0)
282 #endif /* RTE_LIBRTE_MBUF_DEBUG */
284 #ifdef RTE_MBUF_REFCNT
285 #ifdef RTE_MBUF_REFCNT_ATOMIC
288 * Adds given value to an mbuf's refcnt and returns its new value.
292 * Value to add/subtract
296 static inline uint16_t
297 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
299 return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
303 * Reads the value of an mbuf's refcnt.
307 * Reference count number.
309 static inline uint16_t
310 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
312 return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
316 * Sets an mbuf's refcnt to a defined value.
323 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
325 rte_atomic16_set(&m->refcnt_atomic, new_value);
328 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
331 * Adds given value to an mbuf's refcnt and returns its new value.
333 static inline uint16_t
334 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
336 m->refcnt = (uint16_t)(m->refcnt + value);
341 * Reads the value of an mbuf's refcnt.
343 static inline uint16_t
344 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
350 * Sets an mbuf's refcnt to the defined value.
353 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
355 m->refcnt = new_value;
358 #endif /* RTE_MBUF_REFCNT_ATOMIC */
361 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { \
366 #else /* ! RTE_MBUF_REFCNT */
369 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { } while(0)
371 #define rte_mbuf_refcnt_set(m,v) do { } while(0)
373 #endif /* RTE_MBUF_REFCNT */
377 * Sanity checks on an mbuf.
379 * Check the consistency of the given mbuf. The function will cause a
380 * panic if corruption is detected.
383 * The mbuf to be checked.
385 * True if the mbuf is a packet header, false if it is a sub-segment
386 * of a packet (in this case, some fields like nb_segs are not checked)
389 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
392 * @internal Allocate a new mbuf from mempool *mp*.
393 * The use of that function is reserved for RTE internal needs.
394 * Please use rte_pktmbuf_alloc().
397 * The mempool from which mbuf is allocated.
399 * - The pointer to the new mbuf on success.
400 * - NULL if allocation failed.
402 static inline struct rte_mbuf *__rte_mbuf_raw_alloc(struct rte_mempool *mp)
406 if (rte_mempool_get(mp, &mb) < 0)
408 m = (struct rte_mbuf *)mb;
409 #ifdef RTE_MBUF_REFCNT
410 RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
411 rte_mbuf_refcnt_set(m, 1);
412 #endif /* RTE_MBUF_REFCNT */
417 * @internal Put mbuf back into its original mempool.
418 * The use of that function is reserved for RTE internal needs.
419 * Please use rte_pktmbuf_free().
422 * The mbuf to be freed.
424 static inline void __attribute__((always_inline))
425 __rte_mbuf_raw_free(struct rte_mbuf *m)
427 #ifdef RTE_MBUF_REFCNT
428 RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
429 #endif /* RTE_MBUF_REFCNT */
430 rte_mempool_put(m->pool, m);
433 /* Operations on ctrl mbuf */
436 * The control mbuf constructor.
438 * This function initializes some fields in an mbuf structure that are
439 * not modified by the user once created (mbuf type, origin pool, buffer
440 * start address, and so on). This function is given as a callback function
441 * to rte_mempool_create() at pool creation time.
444 * The mempool from which the mbuf is allocated.
446 * A pointer that can be used by the user to retrieve useful information
447 * for mbuf initialization. This pointer comes from the ``init_arg``
448 * parameter of rte_mempool_create().
450 * The mbuf to initialize.
452 * The index of the mbuf in the pool table.
454 void rte_ctrlmbuf_init(struct rte_mempool *mp, void *opaque_arg,
455 void *m, unsigned i);
458 * Allocate a new mbuf (type is ctrl) from mempool *mp*.
460 * This new mbuf is initialized with data pointing to the beginning of
461 * buffer, and with a length of zero.
464 * The mempool from which the mbuf is allocated.
466 * - The pointer to the new mbuf on success.
467 * - NULL if allocation failed.
469 #define rte_ctrlmbuf_alloc(mp) rte_pktmbuf_alloc(mp)
472 * Free a control mbuf back into its original mempool.
475 * The control mbuf to be freed.
477 #define rte_ctrlmbuf_free(m) rte_pktmbuf_free(m)
480 * A macro that returns the pointer to the carried data.
482 * The value that can be read or assigned.
487 #define rte_ctrlmbuf_data(m) ((char *)((m)->buf_addr) + (m)->data_off)
490 * A macro that returns the length of the carried data.
492 * The value that can be read or assigned.
497 #define rte_ctrlmbuf_len(m) rte_pktmbuf_data_len(m)
500 * Tests if an mbuf is a control mbuf
503 * The mbuf to be tested
505 * - True (1) if the mbuf is a control mbuf
506 * - False(0) otherwise
509 rte_is_ctrlmbuf(struct rte_mbuf *m)
511 return (!!(m->ol_flags & CTRL_MBUF_FLAG));
514 /* Operations on pkt mbuf */
517 * The packet mbuf constructor.
519 * This function initializes some fields in the mbuf structure that are
520 * not modified by the user once created (origin pool, buffer start
521 * address, and so on). This function is given as a callback function to
522 * rte_mempool_create() at pool creation time.
525 * The mempool from which mbufs originate.
527 * A pointer that can be used by the user to retrieve useful information
528 * for mbuf initialization. This pointer comes from the ``init_arg``
529 * parameter of rte_mempool_create().
531 * The mbuf to initialize.
533 * The index of the mbuf in the pool table.
535 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
536 void *m, unsigned i);
540 * A packet mbuf pool constructor.
542 * This function initializes the mempool private data in the case of a
543 * pktmbuf pool. This private data is needed by the driver. The
544 * function is given as a callback function to rte_mempool_create() at
545 * pool creation. It can be extended by the user, for example, to
546 * provide another packet size.
549 * The mempool from which mbufs originate.
551 * A pointer that can be used by the user to retrieve useful information
552 * for mbuf initialization. This pointer comes from the ``init_arg``
553 * parameter of rte_mempool_create().
555 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
558 * Reset the fields of a packet mbuf to their default values.
560 * The given mbuf must have only one segment.
563 * The packet mbuf to be resetted.
565 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
570 m->inner_l2_l3_len = 0;
577 m->data_off = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
578 RTE_PKTMBUF_HEADROOM : m->buf_len;
581 __rte_mbuf_sanity_check(m, 1);
585 * Allocate a new mbuf from a mempool.
587 * This new mbuf contains one segment, which has a length of 0. The pointer
588 * to data is initialized to have some bytes of headroom in the buffer
589 * (if buffer size allows).
592 * The mempool from which the mbuf is allocated.
594 * - The pointer to the new mbuf on success.
595 * - NULL if allocation failed.
597 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
600 if ((m = __rte_mbuf_raw_alloc(mp)) != NULL)
601 rte_pktmbuf_reset(m);
605 #ifdef RTE_MBUF_REFCNT
608 * Attach packet mbuf to another packet mbuf.
609 * After attachment we refer the mbuf we attached as 'indirect',
610 * while mbuf we attached to as 'direct'.
611 * Right now, not supported:
612 * - attachment to indirect mbuf (e.g. - md has to be direct).
613 * - attachment for already indirect mbuf (e.g. - mi has to be direct).
614 * - mbuf we trying to attach (mi) is used by someone else
615 * e.g. it's reference counter is greater then 1.
618 * The indirect packet mbuf.
620 * The direct packet mbuf.
623 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *md)
625 RTE_MBUF_ASSERT(RTE_MBUF_DIRECT(md) &&
626 RTE_MBUF_DIRECT(mi) &&
627 rte_mbuf_refcnt_read(mi) == 1);
629 rte_mbuf_refcnt_update(md, 1);
630 mi->buf_physaddr = md->buf_physaddr;
631 mi->buf_addr = md->buf_addr;
632 mi->buf_len = md->buf_len;
635 mi->data_off = md->data_off;
636 mi->data_len = md->data_len;
638 mi->vlan_tci = md->vlan_tci;
639 mi->l2_l3_len = md->l2_l3_len;
640 mi->inner_l2_l3_len = md->inner_l2_l3_len;
644 mi->pkt_len = mi->data_len;
646 mi->ol_flags = md->ol_flags;
647 mi->packet_type = md->packet_type;
649 __rte_mbuf_sanity_check(mi, 1);
650 __rte_mbuf_sanity_check(md, 0);
654 * Detach an indirect packet mbuf -
655 * - restore original mbuf address and length values.
656 * - reset pktmbuf data and data_len to their default values.
657 * All other fields of the given packet mbuf will be left intact.
660 * The indirect attached packet mbuf.
663 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
665 const struct rte_mempool *mp = m->pool;
666 void *buf = RTE_MBUF_TO_BADDR(m);
667 uint32_t buf_len = mp->elt_size - sizeof(*m);
668 m->buf_physaddr = rte_mempool_virt2phy(mp, m) + sizeof (*m);
671 m->buf_len = (uint16_t)buf_len;
673 m->data_off = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
674 RTE_PKTMBUF_HEADROOM : m->buf_len;
679 #endif /* RTE_MBUF_REFCNT */
682 static inline struct rte_mbuf* __attribute__((always_inline))
683 __rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
685 __rte_mbuf_sanity_check(m, 0);
687 #ifdef RTE_MBUF_REFCNT
688 if (likely (rte_mbuf_refcnt_read(m) == 1) ||
689 likely (rte_mbuf_refcnt_update(m, -1) == 0)) {
690 struct rte_mbuf *md = RTE_MBUF_FROM_BADDR(m->buf_addr);
692 rte_mbuf_refcnt_set(m, 0);
694 /* if this is an indirect mbuf, then
696 * - free attached mbuf segment
698 if (unlikely (md != m)) {
699 rte_pktmbuf_detach(m);
700 if (rte_mbuf_refcnt_update(md, -1) == 0)
701 __rte_mbuf_raw_free(md);
705 #ifdef RTE_MBUF_REFCNT
712 * Free a segment of a packet mbuf into its original mempool.
714 * Free an mbuf, without parsing other segments in case of chained
718 * The packet mbuf segment to be freed.
720 static inline void __attribute__((always_inline))
721 rte_pktmbuf_free_seg(struct rte_mbuf *m)
723 if (likely(NULL != (m = __rte_pktmbuf_prefree_seg(m)))) {
725 __rte_mbuf_raw_free(m);
730 * Free a packet mbuf back into its original mempool.
732 * Free an mbuf, and all its segments in case of chained buffers. Each
733 * segment is added back into its original mempool.
736 * The packet mbuf to be freed.
738 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
740 struct rte_mbuf *m_next;
742 __rte_mbuf_sanity_check(m, 1);
746 rte_pktmbuf_free_seg(m);
751 #ifdef RTE_MBUF_REFCNT
754 * Creates a "clone" of the given packet mbuf.
756 * Walks through all segments of the given packet mbuf, and for each of them:
757 * - Creates a new packet mbuf from the given pool.
758 * - Attaches newly created mbuf to the segment.
759 * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
760 * from the original packet mbuf.
763 * The packet mbuf to be cloned.
765 * The mempool from which the "clone" mbufs are allocated.
767 * - The pointer to the new "clone" mbuf on success.
768 * - NULL if allocation fails.
770 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
771 struct rte_mempool *mp)
773 struct rte_mbuf *mc, *mi, **prev;
777 if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
782 pktlen = md->pkt_len;
787 rte_pktmbuf_attach(mi, md);
790 } while ((md = md->next) != NULL &&
791 (mi = rte_pktmbuf_alloc(mp)) != NULL);
795 mc->pkt_len = pktlen;
797 /* Allocation of new indirect segment failed */
798 if (unlikely (mi == NULL)) {
799 rte_pktmbuf_free(mc);
803 __rte_mbuf_sanity_check(mc, 1);
808 * Adds given value to the refcnt of all packet mbuf segments.
810 * Walks through all segments of given packet mbuf and for each of them
811 * invokes rte_mbuf_refcnt_update().
814 * The packet mbuf whose refcnt to be updated.
816 * The value to add to the mbuf's segments refcnt.
818 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
820 __rte_mbuf_sanity_check(m, 1);
823 rte_mbuf_refcnt_update(m, v);
824 } while ((m = m->next) != NULL);
827 #endif /* RTE_MBUF_REFCNT */
830 * Get the headroom in a packet mbuf.
835 * The length of the headroom.
837 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
839 __rte_mbuf_sanity_check(m, 1);
844 * Get the tailroom of a packet mbuf.
849 * The length of the tailroom.
851 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
853 __rte_mbuf_sanity_check(m, 1);
854 return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
859 * Get the last segment of the packet.
864 * The last segment of the given mbuf.
866 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
868 struct rte_mbuf *m2 = (struct rte_mbuf *)m;
870 __rte_mbuf_sanity_check(m, 1);
871 while (m2->next != NULL)
877 * A macro that points to the start of the data in the mbuf.
879 * The returned pointer is cast to type t. Before using this
880 * function, the user must ensure that m_headlen(m) is large enough to
886 * The type to cast the result into.
888 #define rte_pktmbuf_mtod(m, t) ((t)((char *)(m)->buf_addr + (m)->data_off))
891 * A macro that returns the length of the packet.
893 * The value can be read or assigned.
898 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
901 * A macro that returns the length of the segment.
903 * The value can be read or assigned.
908 #define rte_pktmbuf_data_len(m) ((m)->data_len)
911 * Prepend len bytes to an mbuf data area.
913 * Returns a pointer to the new
914 * data start address. If there is not enough headroom in the first
915 * segment, the function will return NULL, without modifying the mbuf.
920 * The amount of data to prepend (in bytes).
922 * A pointer to the start of the newly prepended data, or
923 * NULL if there is not enough headroom space in the first segment
925 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
928 __rte_mbuf_sanity_check(m, 1);
930 if (unlikely(len > rte_pktmbuf_headroom(m)))
934 m->data_len = (uint16_t)(m->data_len + len);
935 m->pkt_len = (m->pkt_len + len);
937 return (char *)m->buf_addr + m->data_off;
941 * Append len bytes to an mbuf.
943 * Append len bytes to an mbuf and return a pointer to the start address
944 * of the added data. If there is not enough tailroom in the last
945 * segment, the function will return NULL, without modifying the mbuf.
950 * The amount of data to append (in bytes).
952 * A pointer to the start of the newly appended data, or
953 * NULL if there is not enough tailroom space in the last segment
955 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
958 struct rte_mbuf *m_last;
960 __rte_mbuf_sanity_check(m, 1);
962 m_last = rte_pktmbuf_lastseg(m);
963 if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
966 tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
967 m_last->data_len = (uint16_t)(m_last->data_len + len);
968 m->pkt_len = (m->pkt_len + len);
973 * Remove len bytes at the beginning of an mbuf.
975 * Returns a pointer to the start address of the new data area. If the
976 * length is greater than the length of the first segment, then the
977 * function will fail and return NULL, without modifying the mbuf.
982 * The amount of data to remove (in bytes).
984 * A pointer to the new start of the data.
986 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
988 __rte_mbuf_sanity_check(m, 1);
990 if (unlikely(len > m->data_len))
993 m->data_len = (uint16_t)(m->data_len - len);
995 m->pkt_len = (m->pkt_len - len);
996 return (char *)m->buf_addr + m->data_off;
1000 * Remove len bytes of data at the end of the mbuf.
1002 * If the length is greater than the length of the last segment, the
1003 * function will fail and return -1 without modifying the mbuf.
1008 * The amount of data to remove (in bytes).
1013 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
1015 struct rte_mbuf *m_last;
1017 __rte_mbuf_sanity_check(m, 1);
1019 m_last = rte_pktmbuf_lastseg(m);
1020 if (unlikely(len > m_last->data_len))
1023 m_last->data_len = (uint16_t)(m_last->data_len - len);
1024 m->pkt_len = (m->pkt_len - len);
1029 * Test if mbuf data is contiguous.
1034 * - 1, if all data is contiguous (one segment).
1035 * - 0, if there is several segments.
1037 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
1039 __rte_mbuf_sanity_check(m, 1);
1040 return !!(m->nb_segs == 1);
1044 * Dump an mbuf structure to the console.
1046 * Dump all fields for the given packet mbuf and all its associated
1047 * segments (in the case of a chained buffer).
1050 * A pointer to a file for output
1054 * If dump_len != 0, also dump the "dump_len" first data bytes of
1057 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
1063 #endif /* _RTE_MBUF_H_ */