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.*/
95 #define PKT_TX_VLAN_PKT (1ULL << 55) /**< TX packet is a 802.1q VLAN packet. */
96 #define PKT_TX_IP_CKSUM (1ULL << 54) /**< IP cksum of TX pkt. computed by NIC. */
97 #define PKT_TX_IPV4_CSUM PKT_TX_IP_CKSUM /**< Alias of PKT_TX_IP_CKSUM. */
98 #define PKT_TX_IPV4 PKT_RX_IPV4_HDR /**< IPv4 with no IP checksum offload. */
99 #define PKT_TX_IPV6 PKT_RX_IPV6_HDR /**< IPv6 packet */
102 * Bits 52+53 used for L4 packet type with checksum enabled.
108 #define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */
109 #define PKT_TX_TCP_CKSUM (1ULL << 52) /**< TCP cksum of TX pkt. computed by NIC. */
110 #define PKT_TX_SCTP_CKSUM (2ULL << 52) /**< SCTP cksum of TX pkt. computed by NIC. */
111 #define PKT_TX_UDP_CKSUM (3ULL << 52) /**< UDP cksum of TX pkt. computed by NIC. */
112 #define PKT_TX_L4_MASK (3ULL << 52) /**< Mask for L4 cksum offload request. */
114 /* Bit 51 - IEEE1588*/
115 #define PKT_TX_IEEE1588_TMST (1ULL << 51) /**< TX IEEE1588 packet to timestamp. */
117 /* Use final bit of flags to indicate a control mbuf */
118 #define CTRL_MBUF_FLAG (1ULL << 63) /**< Mbuf contains control data */
121 * Bit Mask to indicate what bits required for building TX context
123 #define PKT_TX_OFFLOAD_MASK (PKT_TX_VLAN_PKT | PKT_TX_IP_CKSUM | PKT_TX_L4_MASK)
125 /* define a set of marker types that can be used to refer to set points in the
127 typedef void *MARKER[0]; /**< generic marker for a point in a structure */
128 typedef uint64_t MARKER64[0]; /**< marker that allows us to overwrite 8 bytes
129 * with a single assignment */
131 * The generic rte_mbuf, containing a packet mbuf.
136 void *buf_addr; /**< Virtual address of segment buffer. */
137 phys_addr_t buf_physaddr; /**< Physical address of segment buffer. */
139 /* next 8 bytes are initialised on RX descriptor rearm */
141 uint16_t buf_len; /**< Length of segment buffer. */
145 * 16-bit Reference counter.
146 * It should only be accessed using the following functions:
147 * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
148 * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
149 * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
153 #ifdef RTE_MBUF_REFCNT
154 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
155 uint16_t refcnt; /**< Non-atomically accessed refcnt */
157 uint16_t refcnt_reserved; /**< Do not use this field */
159 uint8_t nb_segs; /**< Number of segments. */
160 uint8_t port; /**< Input port. */
162 uint64_t ol_flags; /**< Offload features. */
164 /* remaining bytes are set on RX when pulling packet from descriptor */
165 MARKER rx_descriptor_fields1;
168 * The packet type, which is used to indicate ordinary packet and also
169 * tunneled packet format, i.e. each number is represented a type of
172 uint16_t packet_type;
174 uint16_t data_len; /**< Amount of data in segment buffer. */
175 uint32_t pkt_len; /**< Total pkt len: sum of all segments. */
176 uint16_t vlan_tci; /**< VLAN Tag Control Identifier (CPU order) */
179 uint32_t rss; /**< RSS hash result if RSS enabled */
183 } fdir; /**< Filter identifier if FDIR enabled */
184 uint32_t sched; /**< Hierarchical scheduler */
185 } hash; /**< hash information */
187 /* second cache line - fields only used in slow path or on TX */
188 MARKER cacheline1 __rte_cache_aligned;
191 void *userdata; /**< Can be used for external metadata */
192 uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */
195 struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
196 struct rte_mbuf *next; /**< Next segment of scattered packet. */
198 /* fields to support TX offloads */
200 uint16_t l2_l3_len; /**< combined l2/l3 lengths as single var */
202 uint16_t l3_len:9; /**< L3 (IP) Header Length. */
203 uint16_t l2_len:7; /**< L2 (MAC) Header Length. */
207 /* fields for TX offloading of tunnels */
209 uint16_t inner_l2_l3_len;
210 /**< combined inner l2/l3 lengths as single var */
212 uint16_t inner_l3_len:9;
213 /**< inner L3 (IP) Header Length. */
214 uint16_t inner_l2_len:7;
215 /**< inner L2 (MAC) Header Length. */
218 } __rte_cache_aligned;
221 * Given the buf_addr returns the pointer to corresponding mbuf.
223 #define RTE_MBUF_FROM_BADDR(ba) (((struct rte_mbuf *)(ba)) - 1)
226 * Given the pointer to mbuf returns an address where it's buf_addr
229 #define RTE_MBUF_TO_BADDR(mb) (((struct rte_mbuf *)(mb)) + 1)
232 * Returns TRUE if given mbuf is indirect, or FALSE otherwise.
234 #define RTE_MBUF_INDIRECT(mb) (RTE_MBUF_FROM_BADDR((mb)->buf_addr) != (mb))
237 * Returns TRUE if given mbuf is direct, or FALSE otherwise.
239 #define RTE_MBUF_DIRECT(mb) (RTE_MBUF_FROM_BADDR((mb)->buf_addr) == (mb))
243 * Private data in case of pktmbuf pool.
245 * A structure that contains some pktmbuf_pool-specific data that are
246 * appended after the mempool structure (in private data).
248 struct rte_pktmbuf_pool_private {
249 uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf.*/
252 #ifdef RTE_LIBRTE_MBUF_DEBUG
254 /** check mbuf type in debug mode */
255 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
257 /** check mbuf type in debug mode if mbuf pointer is not null */
258 #define __rte_mbuf_sanity_check_raw(m, is_h) do { \
260 rte_mbuf_sanity_check(m, is_h); \
263 /** MBUF asserts in debug mode */
264 #define RTE_MBUF_ASSERT(exp) \
266 rte_panic("line%d\tassert \"" #exp "\" failed\n", __LINE__); \
269 #else /* RTE_LIBRTE_MBUF_DEBUG */
271 /** check mbuf type in debug mode */
272 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
274 /** check mbuf type in debug mode if mbuf pointer is not null */
275 #define __rte_mbuf_sanity_check_raw(m, is_h) do { } while (0)
277 /** MBUF asserts in debug mode */
278 #define RTE_MBUF_ASSERT(exp) do { } while (0)
280 #endif /* RTE_LIBRTE_MBUF_DEBUG */
282 #ifdef RTE_MBUF_REFCNT
283 #ifdef RTE_MBUF_REFCNT_ATOMIC
286 * Adds given value to an mbuf's refcnt and returns its new value.
290 * Value to add/subtract
294 static inline uint16_t
295 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
297 return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
301 * Reads the value of an mbuf's refcnt.
305 * Reference count number.
307 static inline uint16_t
308 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
310 return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
314 * Sets an mbuf's refcnt to a defined value.
321 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
323 rte_atomic16_set(&m->refcnt_atomic, new_value);
326 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
329 * Adds given value to an mbuf's refcnt and returns its new value.
331 static inline uint16_t
332 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
334 m->refcnt = (uint16_t)(m->refcnt + value);
339 * Reads the value of an mbuf's refcnt.
341 static inline uint16_t
342 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
348 * Sets an mbuf's refcnt to the defined value.
351 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
353 m->refcnt = new_value;
356 #endif /* RTE_MBUF_REFCNT_ATOMIC */
359 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { \
364 #else /* ! RTE_MBUF_REFCNT */
367 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { } while(0)
369 #define rte_mbuf_refcnt_set(m,v) do { } while(0)
371 #endif /* RTE_MBUF_REFCNT */
375 * Sanity checks on an mbuf.
377 * Check the consistency of the given mbuf. The function will cause a
378 * panic if corruption is detected.
381 * The mbuf to be checked.
383 * True if the mbuf is a packet header, false if it is a sub-segment
384 * of a packet (in this case, some fields like nb_segs are not checked)
387 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
390 * @internal Allocate a new mbuf from mempool *mp*.
391 * The use of that function is reserved for RTE internal needs.
392 * Please use rte_pktmbuf_alloc().
395 * The mempool from which mbuf is allocated.
397 * - The pointer to the new mbuf on success.
398 * - NULL if allocation failed.
400 static inline struct rte_mbuf *__rte_mbuf_raw_alloc(struct rte_mempool *mp)
404 if (rte_mempool_get(mp, &mb) < 0)
406 m = (struct rte_mbuf *)mb;
407 #ifdef RTE_MBUF_REFCNT
408 RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
409 rte_mbuf_refcnt_set(m, 1);
410 #endif /* RTE_MBUF_REFCNT */
415 * @internal Put mbuf back into its original mempool.
416 * The use of that function is reserved for RTE internal needs.
417 * Please use rte_pktmbuf_free().
420 * The mbuf to be freed.
422 static inline void __attribute__((always_inline))
423 __rte_mbuf_raw_free(struct rte_mbuf *m)
425 #ifdef RTE_MBUF_REFCNT
426 RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
427 #endif /* RTE_MBUF_REFCNT */
428 rte_mempool_put(m->pool, m);
431 /* Operations on ctrl mbuf */
434 * The control mbuf constructor.
436 * This function initializes some fields in an mbuf structure that are
437 * not modified by the user once created (mbuf type, origin pool, buffer
438 * start address, and so on). This function is given as a callback function
439 * to rte_mempool_create() at pool creation time.
442 * The mempool from which the mbuf is allocated.
444 * A pointer that can be used by the user to retrieve useful information
445 * for mbuf initialization. This pointer comes from the ``init_arg``
446 * parameter of rte_mempool_create().
448 * The mbuf to initialize.
450 * The index of the mbuf in the pool table.
452 void rte_ctrlmbuf_init(struct rte_mempool *mp, void *opaque_arg,
453 void *m, unsigned i);
456 * Allocate a new mbuf (type is ctrl) from mempool *mp*.
458 * This new mbuf is initialized with data pointing to the beginning of
459 * buffer, and with a length of zero.
462 * The mempool from which the mbuf is allocated.
464 * - The pointer to the new mbuf on success.
465 * - NULL if allocation failed.
467 #define rte_ctrlmbuf_alloc(mp) rte_pktmbuf_alloc(mp)
470 * Free a control mbuf back into its original mempool.
473 * The control mbuf to be freed.
475 #define rte_ctrlmbuf_free(m) rte_pktmbuf_free(m)
478 * A macro that returns the pointer to the carried data.
480 * The value that can be read or assigned.
485 #define rte_ctrlmbuf_data(m) ((char *)((m)->buf_addr) + (m)->data_off)
488 * A macro that returns the length of the carried data.
490 * The value that can be read or assigned.
495 #define rte_ctrlmbuf_len(m) rte_pktmbuf_data_len(m)
498 * Tests if an mbuf is a control mbuf
501 * The mbuf to be tested
503 * - True (1) if the mbuf is a control mbuf
504 * - False(0) otherwise
507 rte_is_ctrlmbuf(struct rte_mbuf *m)
509 return (!!(m->ol_flags & CTRL_MBUF_FLAG));
512 /* Operations on pkt mbuf */
515 * The packet mbuf constructor.
517 * This function initializes some fields in the mbuf structure that are
518 * not modified by the user once created (origin pool, buffer start
519 * address, and so on). This function is given as a callback function to
520 * rte_mempool_create() at pool creation time.
523 * The mempool from which mbufs originate.
525 * A pointer that can be used by the user to retrieve useful information
526 * for mbuf initialization. This pointer comes from the ``init_arg``
527 * parameter of rte_mempool_create().
529 * The mbuf to initialize.
531 * The index of the mbuf in the pool table.
533 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
534 void *m, unsigned i);
538 * A packet mbuf pool constructor.
540 * This function initializes the mempool private data in the case of a
541 * pktmbuf pool. This private data is needed by the driver. The
542 * function is given as a callback function to rte_mempool_create() at
543 * pool creation. It can be extended by the user, for example, to
544 * provide another packet size.
547 * The mempool from which mbufs originate.
549 * A pointer that can be used by the user to retrieve useful information
550 * for mbuf initialization. This pointer comes from the ``init_arg``
551 * parameter of rte_mempool_create().
553 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
556 * Reset the fields of a packet mbuf to their default values.
558 * The given mbuf must have only one segment.
561 * The packet mbuf to be resetted.
563 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
568 m->inner_l2_l3_len = 0;
575 m->data_off = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
576 RTE_PKTMBUF_HEADROOM : m->buf_len;
579 __rte_mbuf_sanity_check(m, 1);
583 * Allocate a new mbuf from a mempool.
585 * This new mbuf contains one segment, which has a length of 0. The pointer
586 * to data is initialized to have some bytes of headroom in the buffer
587 * (if buffer size allows).
590 * The mempool from which the mbuf is allocated.
592 * - The pointer to the new mbuf on success.
593 * - NULL if allocation failed.
595 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
598 if ((m = __rte_mbuf_raw_alloc(mp)) != NULL)
599 rte_pktmbuf_reset(m);
603 #ifdef RTE_MBUF_REFCNT
606 * Attach packet mbuf to another packet mbuf.
607 * After attachment we refer the mbuf we attached as 'indirect',
608 * while mbuf we attached to as 'direct'.
609 * Right now, not supported:
610 * - attachment to indirect mbuf (e.g. - md has to be direct).
611 * - attachment for already indirect mbuf (e.g. - mi has to be direct).
612 * - mbuf we trying to attach (mi) is used by someone else
613 * e.g. it's reference counter is greater then 1.
616 * The indirect packet mbuf.
618 * The direct packet mbuf.
621 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *md)
623 RTE_MBUF_ASSERT(RTE_MBUF_DIRECT(md) &&
624 RTE_MBUF_DIRECT(mi) &&
625 rte_mbuf_refcnt_read(mi) == 1);
627 rte_mbuf_refcnt_update(md, 1);
628 mi->buf_physaddr = md->buf_physaddr;
629 mi->buf_addr = md->buf_addr;
630 mi->buf_len = md->buf_len;
633 mi->data_off = md->data_off;
634 mi->data_len = md->data_len;
636 mi->vlan_tci = md->vlan_tci;
637 mi->l2_l3_len = md->l2_l3_len;
638 mi->inner_l2_l3_len = md->inner_l2_l3_len;
642 mi->pkt_len = mi->data_len;
644 mi->ol_flags = md->ol_flags;
645 mi->packet_type = md->packet_type;
647 __rte_mbuf_sanity_check(mi, 1);
648 __rte_mbuf_sanity_check(md, 0);
652 * Detach an indirect packet mbuf -
653 * - restore original mbuf address and length values.
654 * - reset pktmbuf data and data_len to their default values.
655 * All other fields of the given packet mbuf will be left intact.
658 * The indirect attached packet mbuf.
661 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
663 const struct rte_mempool *mp = m->pool;
664 void *buf = RTE_MBUF_TO_BADDR(m);
665 uint32_t buf_len = mp->elt_size - sizeof(*m);
666 m->buf_physaddr = rte_mempool_virt2phy(mp, m) + sizeof (*m);
669 m->buf_len = (uint16_t)buf_len;
671 m->data_off = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
672 RTE_PKTMBUF_HEADROOM : m->buf_len;
677 #endif /* RTE_MBUF_REFCNT */
680 static inline struct rte_mbuf* __attribute__((always_inline))
681 __rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
683 __rte_mbuf_sanity_check(m, 0);
685 #ifdef RTE_MBUF_REFCNT
686 if (likely (rte_mbuf_refcnt_read(m) == 1) ||
687 likely (rte_mbuf_refcnt_update(m, -1) == 0)) {
688 struct rte_mbuf *md = RTE_MBUF_FROM_BADDR(m->buf_addr);
690 rte_mbuf_refcnt_set(m, 0);
692 /* if this is an indirect mbuf, then
694 * - free attached mbuf segment
696 if (unlikely (md != m)) {
697 rte_pktmbuf_detach(m);
698 if (rte_mbuf_refcnt_update(md, -1) == 0)
699 __rte_mbuf_raw_free(md);
703 #ifdef RTE_MBUF_REFCNT
710 * Free a segment of a packet mbuf into its original mempool.
712 * Free an mbuf, without parsing other segments in case of chained
716 * The packet mbuf segment to be freed.
718 static inline void __attribute__((always_inline))
719 rte_pktmbuf_free_seg(struct rte_mbuf *m)
721 if (likely(NULL != (m = __rte_pktmbuf_prefree_seg(m)))) {
723 __rte_mbuf_raw_free(m);
728 * Free a packet mbuf back into its original mempool.
730 * Free an mbuf, and all its segments in case of chained buffers. Each
731 * segment is added back into its original mempool.
734 * The packet mbuf to be freed.
736 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
738 struct rte_mbuf *m_next;
740 __rte_mbuf_sanity_check(m, 1);
744 rte_pktmbuf_free_seg(m);
749 #ifdef RTE_MBUF_REFCNT
752 * Creates a "clone" of the given packet mbuf.
754 * Walks through all segments of the given packet mbuf, and for each of them:
755 * - Creates a new packet mbuf from the given pool.
756 * - Attaches newly created mbuf to the segment.
757 * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
758 * from the original packet mbuf.
761 * The packet mbuf to be cloned.
763 * The mempool from which the "clone" mbufs are allocated.
765 * - The pointer to the new "clone" mbuf on success.
766 * - NULL if allocation fails.
768 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
769 struct rte_mempool *mp)
771 struct rte_mbuf *mc, *mi, **prev;
775 if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
780 pktlen = md->pkt_len;
785 rte_pktmbuf_attach(mi, md);
788 } while ((md = md->next) != NULL &&
789 (mi = rte_pktmbuf_alloc(mp)) != NULL);
793 mc->pkt_len = pktlen;
795 /* Allocation of new indirect segment failed */
796 if (unlikely (mi == NULL)) {
797 rte_pktmbuf_free(mc);
801 __rte_mbuf_sanity_check(mc, 1);
806 * Adds given value to the refcnt of all packet mbuf segments.
808 * Walks through all segments of given packet mbuf and for each of them
809 * invokes rte_mbuf_refcnt_update().
812 * The packet mbuf whose refcnt to be updated.
814 * The value to add to the mbuf's segments refcnt.
816 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
818 __rte_mbuf_sanity_check(m, 1);
821 rte_mbuf_refcnt_update(m, v);
822 } while ((m = m->next) != NULL);
825 #endif /* RTE_MBUF_REFCNT */
828 * Get the headroom in a packet mbuf.
833 * The length of the headroom.
835 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
837 __rte_mbuf_sanity_check(m, 1);
842 * Get the tailroom of a packet mbuf.
847 * The length of the tailroom.
849 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
851 __rte_mbuf_sanity_check(m, 1);
852 return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
857 * Get the last segment of the packet.
862 * The last segment of the given mbuf.
864 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
866 struct rte_mbuf *m2 = (struct rte_mbuf *)m;
868 __rte_mbuf_sanity_check(m, 1);
869 while (m2->next != NULL)
875 * A macro that points to the start of the data in the mbuf.
877 * The returned pointer is cast to type t. Before using this
878 * function, the user must ensure that m_headlen(m) is large enough to
884 * The type to cast the result into.
886 #define rte_pktmbuf_mtod(m, t) ((t)((char *)(m)->buf_addr + (m)->data_off))
889 * A macro that returns the length of the packet.
891 * The value can be read or assigned.
896 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
899 * A macro that returns the length of the segment.
901 * The value can be read or assigned.
906 #define rte_pktmbuf_data_len(m) ((m)->data_len)
909 * Prepend len bytes to an mbuf data area.
911 * Returns a pointer to the new
912 * data start address. If there is not enough headroom in the first
913 * segment, the function will return NULL, without modifying the mbuf.
918 * The amount of data to prepend (in bytes).
920 * A pointer to the start of the newly prepended data, or
921 * NULL if there is not enough headroom space in the first segment
923 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
926 __rte_mbuf_sanity_check(m, 1);
928 if (unlikely(len > rte_pktmbuf_headroom(m)))
932 m->data_len = (uint16_t)(m->data_len + len);
933 m->pkt_len = (m->pkt_len + len);
935 return (char *)m->buf_addr + m->data_off;
939 * Append len bytes to an mbuf.
941 * Append len bytes to an mbuf and return a pointer to the start address
942 * of the added data. If there is not enough tailroom in the last
943 * segment, the function will return NULL, without modifying the mbuf.
948 * The amount of data to append (in bytes).
950 * A pointer to the start of the newly appended data, or
951 * NULL if there is not enough tailroom space in the last segment
953 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
956 struct rte_mbuf *m_last;
958 __rte_mbuf_sanity_check(m, 1);
960 m_last = rte_pktmbuf_lastseg(m);
961 if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
964 tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
965 m_last->data_len = (uint16_t)(m_last->data_len + len);
966 m->pkt_len = (m->pkt_len + len);
971 * Remove len bytes at the beginning of an mbuf.
973 * Returns a pointer to the start address of the new data area. If the
974 * length is greater than the length of the first segment, then the
975 * function will fail and return NULL, without modifying the mbuf.
980 * The amount of data to remove (in bytes).
982 * A pointer to the new start of the data.
984 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
986 __rte_mbuf_sanity_check(m, 1);
988 if (unlikely(len > m->data_len))
991 m->data_len = (uint16_t)(m->data_len - len);
993 m->pkt_len = (m->pkt_len - len);
994 return (char *)m->buf_addr + m->data_off;
998 * Remove len bytes of data at the end of the mbuf.
1000 * If the length is greater than the length of the last segment, the
1001 * function will fail and return -1 without modifying the mbuf.
1006 * The amount of data to remove (in bytes).
1011 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
1013 struct rte_mbuf *m_last;
1015 __rte_mbuf_sanity_check(m, 1);
1017 m_last = rte_pktmbuf_lastseg(m);
1018 if (unlikely(len > m_last->data_len))
1021 m_last->data_len = (uint16_t)(m_last->data_len - len);
1022 m->pkt_len = (m->pkt_len - len);
1027 * Test if mbuf data is contiguous.
1032 * - 1, if all data is contiguous (one segment).
1033 * - 0, if there is several segments.
1035 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
1037 __rte_mbuf_sanity_check(m, 1);
1038 return !!(m->nb_segs == 1);
1042 * Dump an mbuf structure to the console.
1044 * Dump all fields for the given packet mbuf and all its associated
1045 * segments (in the case of a chained buffer).
1048 * A pointer to a file for output
1052 * If dump_len != 0, also dump the "dump_len" first data bytes of
1055 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
1061 #endif /* _RTE_MBUF_H_ */