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 #define PKT_RX_VLAN_PKT 0x0001 /**< RX packet is a 802.1q VLAN packet. */
73 #define PKT_RX_RSS_HASH 0x0002 /**< RX packet with RSS hash result. */
74 #define PKT_RX_FDIR 0x0004 /**< RX packet with FDIR infos. */
75 #define PKT_RX_L4_CKSUM_BAD 0x0008 /**< L4 cksum of RX pkt. is not OK. */
76 #define PKT_RX_IP_CKSUM_BAD 0x0010 /**< IP cksum of RX pkt. is not OK. */
77 #define PKT_RX_EIP_CKSUM_BAD 0x0000 /**< External IP header checksum error. */
78 #define PKT_RX_OVERSIZE 0x0000 /**< Num of desc of an RX pkt oversize. */
79 #define PKT_RX_HBUF_OVERFLOW 0x0000 /**< Header buffer overflow. */
80 #define PKT_RX_RECIP_ERR 0x0000 /**< Hardware processing error. */
81 #define PKT_RX_MAC_ERR 0x0000 /**< MAC error. */
82 #define PKT_RX_IPV4_HDR 0x0020 /**< RX packet with IPv4 header. */
83 #define PKT_RX_IPV4_HDR_EXT 0x0040 /**< RX packet with extended IPv4 header. */
84 #define PKT_RX_IPV6_HDR 0x0080 /**< RX packet with IPv6 header. */
85 #define PKT_RX_IPV6_HDR_EXT 0x0100 /**< RX packet with extended IPv6 header. */
86 #define PKT_RX_IEEE1588_PTP 0x0200 /**< RX IEEE1588 L2 Ethernet PT Packet. */
87 #define PKT_RX_IEEE1588_TMST 0x0400 /**< RX IEEE1588 L2/L4 timestamped packet.*/
89 #define PKT_TX_VLAN_PKT 0x0800 /**< TX packet is a 802.1q VLAN packet. */
90 #define PKT_TX_IP_CKSUM 0x1000 /**< IP cksum of TX pkt. computed by NIC. */
91 #define PKT_TX_IPV4_CSUM 0x1000 /**< Alias of PKT_TX_IP_CKSUM. */
92 #define PKT_TX_IPV4 PKT_RX_IPV4_HDR /**< IPv4 with no IP checksum offload. */
93 #define PKT_TX_IPV6 PKT_RX_IPV6_HDR /**< IPv6 packet */
96 * Bit 14~13 used for L4 packet type with checksum enabled.
102 #define PKT_TX_L4_MASK 0x6000 /**< Mask bits for L4 checksum offload request. */
103 #define PKT_TX_L4_NO_CKSUM 0x0000 /**< Disable L4 cksum of TX pkt. */
104 #define PKT_TX_TCP_CKSUM 0x2000 /**< TCP cksum of TX pkt. computed by NIC. */
105 #define PKT_TX_SCTP_CKSUM 0x4000 /**< SCTP cksum of TX pkt. computed by NIC. */
106 #define PKT_TX_UDP_CKSUM 0x6000 /**< UDP cksum of TX pkt. computed by NIC. */
108 #define PKT_TX_IEEE1588_TMST 0x8000 /**< TX IEEE1588 packet to timestamp. */
110 /* Use final bit of flags to indicate a control mbuf */
111 #define CTRL_MBUF_FLAG (1ULL << 63)
114 * Bit Mask to indicate what bits required for building TX context
116 #define PKT_TX_OFFLOAD_MASK (PKT_TX_VLAN_PKT | PKT_TX_IP_CKSUM | PKT_TX_L4_MASK)
119 * The generic rte_mbuf, containing a packet mbuf.
122 void *buf_addr; /**< Virtual address of segment buffer. */
123 phys_addr_t buf_physaddr; /**< Physical address of segment buffer. */
125 /* next 8 bytes are initialised on RX descriptor rearm */
126 uint16_t buf_len; /**< Length of segment buffer. */
130 * 16-bit Reference counter.
131 * It should only be accessed using the following functions:
132 * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
133 * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
134 * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
138 #ifdef RTE_MBUF_REFCNT
139 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
140 uint16_t refcnt; /**< Non-atomically accessed refcnt */
142 uint16_t refcnt_reserved; /**< Do not use this field */
144 uint8_t nb_segs; /**< Number of segments. */
145 uint8_t port; /**< Input port. */
147 uint64_t ol_flags; /**< Offload features. */
149 /* remaining bytes are set on RX when pulling packet from descriptor */
150 uint16_t reserved2; /**< Unused field. Required for padding */
151 uint16_t data_len; /**< Amount of data in segment buffer. */
152 uint32_t pkt_len; /**< Total pkt len: sum of all segments. */
154 uint16_t l2_l3_len; /**< combined l2/l3 lengths as single var */
156 uint16_t l3_len:9; /**< L3 (IP) Header Length. */
157 uint16_t l2_len:7; /**< L2 (MAC) Header Length. */
160 uint16_t vlan_tci; /**< VLAN Tag Control Identifier (CPU order) */
162 uint32_t rss; /**< RSS hash result if RSS enabled */
166 } fdir; /**< Filter identifier if FDIR enabled */
167 uint32_t sched; /**< Hierarchical scheduler */
168 } hash; /**< hash information */
170 /* fields only used in slow path or on TX */
171 struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
172 struct rte_mbuf *next; /**< Next segment of scattered packet. */
176 uint16_t metadata16[0];
177 uint32_t metadata32[0];
178 uint64_t metadata64[0];
179 } __rte_cache_aligned;
180 } __rte_cache_aligned;
182 #define RTE_MBUF_METADATA_UINT8(mbuf, offset) \
183 (mbuf->metadata[offset])
184 #define RTE_MBUF_METADATA_UINT16(mbuf, offset) \
185 (mbuf->metadata16[offset/sizeof(uint16_t)])
186 #define RTE_MBUF_METADATA_UINT32(mbuf, offset) \
187 (mbuf->metadata32[offset/sizeof(uint32_t)])
188 #define RTE_MBUF_METADATA_UINT64(mbuf, offset) \
189 (mbuf->metadata64[offset/sizeof(uint64_t)])
191 #define RTE_MBUF_METADATA_UINT8_PTR(mbuf, offset) \
192 (&mbuf->metadata[offset])
193 #define RTE_MBUF_METADATA_UINT16_PTR(mbuf, offset) \
194 (&mbuf->metadata16[offset/sizeof(uint16_t)])
195 #define RTE_MBUF_METADATA_UINT32_PTR(mbuf, offset) \
196 (&mbuf->metadata32[offset/sizeof(uint32_t)])
197 #define RTE_MBUF_METADATA_UINT64_PTR(mbuf, offset) \
198 (&mbuf->metadata64[offset/sizeof(uint64_t)])
201 * Given the buf_addr returns the pointer to corresponding mbuf.
203 #define RTE_MBUF_FROM_BADDR(ba) (((struct rte_mbuf *)(ba)) - 1)
206 * Given the pointer to mbuf returns an address where it's buf_addr
209 #define RTE_MBUF_TO_BADDR(mb) (((struct rte_mbuf *)(mb)) + 1)
212 * Returns TRUE if given mbuf is indirect, or FALSE otherwise.
214 #define RTE_MBUF_INDIRECT(mb) (RTE_MBUF_FROM_BADDR((mb)->buf_addr) != (mb))
217 * Returns TRUE if given mbuf is direct, or FALSE otherwise.
219 #define RTE_MBUF_DIRECT(mb) (RTE_MBUF_FROM_BADDR((mb)->buf_addr) == (mb))
223 * Private data in case of pktmbuf pool.
225 * A structure that contains some pktmbuf_pool-specific data that are
226 * appended after the mempool structure (in private data).
228 struct rte_pktmbuf_pool_private {
229 uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf.*/
232 #ifdef RTE_LIBRTE_MBUF_DEBUG
234 /** check mbuf type in debug mode */
235 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
237 /** check mbuf type in debug mode if mbuf pointer is not null */
238 #define __rte_mbuf_sanity_check_raw(m, is_h) do { \
240 rte_mbuf_sanity_check(m, is_h); \
243 /** MBUF asserts in debug mode */
244 #define RTE_MBUF_ASSERT(exp) \
246 rte_panic("line%d\tassert \"" #exp "\" failed\n", __LINE__); \
249 #else /* RTE_LIBRTE_MBUF_DEBUG */
251 /** check mbuf type in debug mode */
252 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
254 /** check mbuf type in debug mode if mbuf pointer is not null */
255 #define __rte_mbuf_sanity_check_raw(m, is_h) do { } while (0)
257 /** MBUF asserts in debug mode */
258 #define RTE_MBUF_ASSERT(exp) do { } while (0)
260 #endif /* RTE_LIBRTE_MBUF_DEBUG */
262 #ifdef RTE_MBUF_REFCNT
263 #ifdef RTE_MBUF_REFCNT_ATOMIC
266 * Adds given value to an mbuf's refcnt and returns its new value.
270 * Value to add/subtract
274 static inline uint16_t
275 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
277 return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
281 * Reads the value of an mbuf's refcnt.
285 * Reference count number.
287 static inline uint16_t
288 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
290 return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
294 * Sets an mbuf's refcnt to a defined value.
301 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
303 rte_atomic16_set(&m->refcnt_atomic, new_value);
306 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
309 * Adds given value to an mbuf's refcnt and returns its new value.
311 static inline uint16_t
312 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
314 m->refcnt = (uint16_t)(m->refcnt + value);
319 * Reads the value of an mbuf's refcnt.
321 static inline uint16_t
322 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
328 * Sets an mbuf's refcnt to the defined value.
331 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
333 m->refcnt = new_value;
336 #endif /* RTE_MBUF_REFCNT_ATOMIC */
339 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { \
344 #else /* ! RTE_MBUF_REFCNT */
347 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { } while(0)
349 #define rte_mbuf_refcnt_set(m,v) do { } while(0)
351 #endif /* RTE_MBUF_REFCNT */
355 * Sanity checks on an mbuf.
357 * Check the consistency of the given mbuf. The function will cause a
358 * panic if corruption is detected.
361 * The mbuf to be checked.
363 * True if the mbuf is a packet header, false if it is a sub-segment
364 * of a packet (in this case, some fields like nb_segs are not checked)
367 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
370 * @internal Allocate a new mbuf from mempool *mp*.
371 * The use of that function is reserved for RTE internal needs.
372 * Please use rte_pktmbuf_alloc().
375 * The mempool from which mbuf is allocated.
377 * - The pointer to the new mbuf on success.
378 * - NULL if allocation failed.
380 static inline struct rte_mbuf *__rte_mbuf_raw_alloc(struct rte_mempool *mp)
384 if (rte_mempool_get(mp, &mb) < 0)
386 m = (struct rte_mbuf *)mb;
387 #ifdef RTE_MBUF_REFCNT
388 RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
389 rte_mbuf_refcnt_set(m, 1);
390 #endif /* RTE_MBUF_REFCNT */
395 * @internal Put mbuf back into its original mempool.
396 * The use of that function is reserved for RTE internal needs.
397 * Please use rte_pktmbuf_free().
400 * The mbuf to be freed.
402 static inline void __attribute__((always_inline))
403 __rte_mbuf_raw_free(struct rte_mbuf *m)
405 #ifdef RTE_MBUF_REFCNT
406 RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
407 #endif /* RTE_MBUF_REFCNT */
408 rte_mempool_put(m->pool, m);
411 /* Operations on ctrl mbuf */
414 * The control mbuf constructor.
416 * This function initializes some fields in an mbuf structure that are
417 * not modified by the user once created (mbuf type, origin pool, buffer
418 * start address, and so on). This function is given as a callback function
419 * to rte_mempool_create() at pool creation time.
422 * The mempool from which the mbuf is allocated.
424 * A pointer that can be used by the user to retrieve useful information
425 * for mbuf initialization. This pointer comes from the ``init_arg``
426 * parameter of rte_mempool_create().
428 * The mbuf to initialize.
430 * The index of the mbuf in the pool table.
432 void rte_ctrlmbuf_init(struct rte_mempool *mp, void *opaque_arg,
433 void *m, unsigned i);
436 * Allocate a new mbuf (type is ctrl) from mempool *mp*.
438 * This new mbuf is initialized with data pointing to the beginning of
439 * buffer, and with a length of zero.
442 * The mempool from which the mbuf is allocated.
444 * - The pointer to the new mbuf on success.
445 * - NULL if allocation failed.
447 #define rte_ctrlmbuf_alloc(mp) rte_pktmbuf_alloc(mp)
450 * Free a control mbuf back into its original mempool.
453 * The control mbuf to be freed.
455 #define rte_ctrlmbuf_free(m) rte_pktmbuf_free(m)
458 * A macro that returns the pointer to the carried data.
460 * The value that can be read or assigned.
465 #define rte_ctrlmbuf_data(m) ((char *)((m)->buf_addr) + (m)->data_off)
468 * A macro that returns the length of the carried data.
470 * The value that can be read or assigned.
475 #define rte_ctrlmbuf_len(m) rte_pktmbuf_data_len(m)
478 * Tests if an mbuf is a control mbuf
481 * The mbuf to be tested
483 * - True (1) if the mbuf is a control mbuf
484 * - False(0) otherwise
487 rte_is_ctrlmbuf(struct rte_mbuf *m)
489 return (!!(m->ol_flags & CTRL_MBUF_FLAG));
492 /* Operations on pkt mbuf */
495 * The packet mbuf constructor.
497 * This function initializes some fields in the mbuf structure that are
498 * not modified by the user once created (origin pool, buffer start
499 * address, and so on). This function is given as a callback function to
500 * rte_mempool_create() at pool creation time.
503 * The mempool from which mbufs originate.
505 * A pointer that can be used by the user to retrieve useful information
506 * for mbuf initialization. This pointer comes from the ``init_arg``
507 * parameter of rte_mempool_create().
509 * The mbuf to initialize.
511 * The index of the mbuf in the pool table.
513 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
514 void *m, unsigned i);
518 * A packet mbuf pool constructor.
520 * This function initializes the mempool private data in the case of a
521 * pktmbuf pool. This private data is needed by the driver. The
522 * function is given as a callback function to rte_mempool_create() at
523 * pool creation. It can be extended by the user, for example, to
524 * provide another packet size.
527 * The mempool from which mbufs originate.
529 * A pointer that can be used by the user to retrieve useful information
530 * for mbuf initialization. This pointer comes from the ``init_arg``
531 * parameter of rte_mempool_create().
533 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
536 * Reset the fields of a packet mbuf to their default values.
538 * The given mbuf must have only one segment.
541 * The packet mbuf to be resetted.
543 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
553 m->data_off = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
554 RTE_PKTMBUF_HEADROOM : m->buf_len;
557 __rte_mbuf_sanity_check(m, 1);
561 * Allocate a new mbuf from a mempool.
563 * This new mbuf contains one segment, which has a length of 0. The pointer
564 * to data is initialized to have some bytes of headroom in the buffer
565 * (if buffer size allows).
568 * The mempool from which the mbuf is allocated.
570 * - The pointer to the new mbuf on success.
571 * - NULL if allocation failed.
573 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
576 if ((m = __rte_mbuf_raw_alloc(mp)) != NULL)
577 rte_pktmbuf_reset(m);
581 #ifdef RTE_MBUF_REFCNT
584 * Attach packet mbuf to another packet mbuf.
585 * After attachment we refer the mbuf we attached as 'indirect',
586 * while mbuf we attached to as 'direct'.
587 * Right now, not supported:
588 * - attachment to indirect mbuf (e.g. - md has to be direct).
589 * - attachment for already indirect mbuf (e.g. - mi has to be direct).
590 * - mbuf we trying to attach (mi) is used by someone else
591 * e.g. it's reference counter is greater then 1.
594 * The indirect packet mbuf.
596 * The direct packet mbuf.
599 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *md)
601 RTE_MBUF_ASSERT(RTE_MBUF_DIRECT(md) &&
602 RTE_MBUF_DIRECT(mi) &&
603 rte_mbuf_refcnt_read(mi) == 1);
605 rte_mbuf_refcnt_update(md, 1);
606 mi->buf_physaddr = md->buf_physaddr;
607 mi->buf_addr = md->buf_addr;
608 mi->buf_len = md->buf_len;
611 mi->data_off = md->data_off;
612 mi->data_len = md->data_len;
614 mi->vlan_tci = md->vlan_tci;
615 mi->l2_l3_len = md->l2_l3_len;
619 mi->pkt_len = mi->data_len;
621 mi->ol_flags = md->ol_flags;
623 __rte_mbuf_sanity_check(mi, 1);
624 __rte_mbuf_sanity_check(md, 0);
628 * Detach an indirect packet mbuf -
629 * - restore original mbuf address and length values.
630 * - reset pktmbuf data and data_len to their default values.
631 * All other fields of the given packet mbuf will be left intact.
634 * The indirect attached packet mbuf.
637 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
639 const struct rte_mempool *mp = m->pool;
640 void *buf = RTE_MBUF_TO_BADDR(m);
641 uint32_t buf_len = mp->elt_size - sizeof(*m);
642 m->buf_physaddr = rte_mempool_virt2phy(mp, m) + sizeof (*m);
645 m->buf_len = (uint16_t)buf_len;
647 m->data_off = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
648 RTE_PKTMBUF_HEADROOM : m->buf_len;
653 #endif /* RTE_MBUF_REFCNT */
656 static inline struct rte_mbuf* __attribute__((always_inline))
657 __rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
659 __rte_mbuf_sanity_check(m, 0);
661 #ifdef RTE_MBUF_REFCNT
662 if (likely (rte_mbuf_refcnt_read(m) == 1) ||
663 likely (rte_mbuf_refcnt_update(m, -1) == 0)) {
664 struct rte_mbuf *md = RTE_MBUF_FROM_BADDR(m->buf_addr);
666 rte_mbuf_refcnt_set(m, 0);
668 /* if this is an indirect mbuf, then
670 * - free attached mbuf segment
672 if (unlikely (md != m)) {
673 rte_pktmbuf_detach(m);
674 if (rte_mbuf_refcnt_update(md, -1) == 0)
675 __rte_mbuf_raw_free(md);
679 #ifdef RTE_MBUF_REFCNT
686 * Free a segment of a packet mbuf into its original mempool.
688 * Free an mbuf, without parsing other segments in case of chained
692 * The packet mbuf segment to be freed.
694 static inline void __attribute__((always_inline))
695 rte_pktmbuf_free_seg(struct rte_mbuf *m)
697 if (likely(NULL != (m = __rte_pktmbuf_prefree_seg(m))))
698 __rte_mbuf_raw_free(m);
702 * Free a packet mbuf back into its original mempool.
704 * Free an mbuf, and all its segments in case of chained buffers. Each
705 * segment is added back into its original mempool.
708 * The packet mbuf to be freed.
710 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
712 struct rte_mbuf *m_next;
714 __rte_mbuf_sanity_check(m, 1);
718 rte_pktmbuf_free_seg(m);
723 #ifdef RTE_MBUF_REFCNT
726 * Creates a "clone" of the given packet mbuf.
728 * Walks through all segments of the given packet mbuf, and for each of them:
729 * - Creates a new packet mbuf from the given pool.
730 * - Attaches newly created mbuf to the segment.
731 * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
732 * from the original packet mbuf.
735 * The packet mbuf to be cloned.
737 * The mempool from which the "clone" mbufs are allocated.
739 * - The pointer to the new "clone" mbuf on success.
740 * - NULL if allocation fails.
742 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
743 struct rte_mempool *mp)
745 struct rte_mbuf *mc, *mi, **prev;
749 if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
754 pktlen = md->pkt_len;
759 rte_pktmbuf_attach(mi, md);
762 } while ((md = md->next) != NULL &&
763 (mi = rte_pktmbuf_alloc(mp)) != NULL);
767 mc->pkt_len = pktlen;
769 /* Allocation of new indirect segment failed */
770 if (unlikely (mi == NULL)) {
771 rte_pktmbuf_free(mc);
775 __rte_mbuf_sanity_check(mc, 1);
780 * Adds given value to the refcnt of all packet mbuf segments.
782 * Walks through all segments of given packet mbuf and for each of them
783 * invokes rte_mbuf_refcnt_update().
786 * The packet mbuf whose refcnt to be updated.
788 * The value to add to the mbuf's segments refcnt.
790 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
792 __rte_mbuf_sanity_check(m, 1);
795 rte_mbuf_refcnt_update(m, v);
796 } while ((m = m->next) != NULL);
799 #endif /* RTE_MBUF_REFCNT */
802 * Get the headroom in a packet mbuf.
807 * The length of the headroom.
809 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
811 __rte_mbuf_sanity_check(m, 1);
816 * Get the tailroom of a packet mbuf.
821 * The length of the tailroom.
823 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
825 __rte_mbuf_sanity_check(m, 1);
826 return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
831 * Get the last segment of the packet.
836 * The last segment of the given mbuf.
838 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
840 struct rte_mbuf *m2 = (struct rte_mbuf *)m;
842 __rte_mbuf_sanity_check(m, 1);
843 while (m2->next != NULL)
849 * A macro that points to the start of the data in the mbuf.
851 * The returned pointer is cast to type t. Before using this
852 * function, the user must ensure that m_headlen(m) is large enough to
858 * The type to cast the result into.
860 #define rte_pktmbuf_mtod(m, t) ((t)((char *)(m)->buf_addr + (m)->data_off))
863 * A macro that returns the length of the packet.
865 * The value can be read or assigned.
870 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
873 * A macro that returns the length of the segment.
875 * The value can be read or assigned.
880 #define rte_pktmbuf_data_len(m) ((m)->data_len)
883 * Prepend len bytes to an mbuf data area.
885 * Returns a pointer to the new
886 * data start address. If there is not enough headroom in the first
887 * segment, the function will return NULL, without modifying the mbuf.
892 * The amount of data to prepend (in bytes).
894 * A pointer to the start of the newly prepended data, or
895 * NULL if there is not enough headroom space in the first segment
897 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
900 __rte_mbuf_sanity_check(m, 1);
902 if (unlikely(len > rte_pktmbuf_headroom(m)))
906 m->data_len = (uint16_t)(m->data_len + len);
907 m->pkt_len = (m->pkt_len + len);
909 return (char *)m->buf_addr + m->data_off;
913 * Append len bytes to an mbuf.
915 * Append len bytes to an mbuf and return a pointer to the start address
916 * of the added data. If there is not enough tailroom in the last
917 * segment, the function will return NULL, without modifying the mbuf.
922 * The amount of data to append (in bytes).
924 * A pointer to the start of the newly appended data, or
925 * NULL if there is not enough tailroom space in the last segment
927 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
930 struct rte_mbuf *m_last;
932 __rte_mbuf_sanity_check(m, 1);
934 m_last = rte_pktmbuf_lastseg(m);
935 if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
938 tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
939 m_last->data_len = (uint16_t)(m_last->data_len + len);
940 m->pkt_len = (m->pkt_len + len);
945 * Remove len bytes at the beginning of an mbuf.
947 * Returns a pointer to the start address of the new data area. If the
948 * length is greater than the length of the first segment, then the
949 * function will fail and return NULL, without modifying the mbuf.
954 * The amount of data to remove (in bytes).
956 * A pointer to the new start of the data.
958 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
960 __rte_mbuf_sanity_check(m, 1);
962 if (unlikely(len > m->data_len))
965 m->data_len = (uint16_t)(m->data_len - len);
967 m->pkt_len = (m->pkt_len - len);
968 return (char *)m->buf_addr + m->data_off;
972 * Remove len bytes of data at the end of the mbuf.
974 * If the length is greater than the length of the last segment, the
975 * function will fail and return -1 without modifying the mbuf.
980 * The amount of data to remove (in bytes).
985 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
987 struct rte_mbuf *m_last;
989 __rte_mbuf_sanity_check(m, 1);
991 m_last = rte_pktmbuf_lastseg(m);
992 if (unlikely(len > m_last->data_len))
995 m_last->data_len = (uint16_t)(m_last->data_len - len);
996 m->pkt_len = (m->pkt_len - len);
1001 * Test if mbuf data is contiguous.
1006 * - 1, if all data is contiguous (one segment).
1007 * - 0, if there is several segments.
1009 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
1011 __rte_mbuf_sanity_check(m, 1);
1012 return !!(m->nb_segs == 1);
1016 * Dump an mbuf structure to the console.
1018 * Dump all fields for the given packet mbuf and all its associated
1019 * segments (in the case of a chained buffer).
1022 * A pointer to a file for output
1026 * If dump_len != 0, also dump the "dump_len" first data bytes of
1029 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
1035 #endif /* _RTE_MBUF_H_ */