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)
118 /* define a set of marker types that can be used to refer to set points in the
120 typedef void *MARKER[0]; /**< generic marker for a point in a structure */
121 typedef uint64_t MARKER64[0]; /**< marker that allows us to overwrite 8 bytes
122 * with a single assignment */
124 * The generic rte_mbuf, containing a packet mbuf.
129 void *buf_addr; /**< Virtual address of segment buffer. */
130 phys_addr_t buf_physaddr; /**< Physical address of segment buffer. */
132 /* next 8 bytes are initialised on RX descriptor rearm */
134 uint16_t buf_len; /**< Length of segment buffer. */
138 * 16-bit Reference counter.
139 * It should only be accessed using the following functions:
140 * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
141 * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
142 * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
146 #ifdef RTE_MBUF_REFCNT
147 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
148 uint16_t refcnt; /**< Non-atomically accessed refcnt */
150 uint16_t refcnt_reserved; /**< Do not use this field */
152 uint8_t nb_segs; /**< Number of segments. */
153 uint8_t port; /**< Input port. */
155 uint64_t ol_flags; /**< Offload features. */
157 /* remaining bytes are set on RX when pulling packet from descriptor */
158 MARKER rx_descriptor_fields1;
159 uint16_t reserved2; /**< Unused field. Required for padding */
160 uint16_t data_len; /**< Amount of data in segment buffer. */
161 uint32_t pkt_len; /**< Total pkt len: sum of all segments. */
163 uint16_t vlan_tci; /**< VLAN Tag Control Identifier (CPU order) */
165 uint32_t rss; /**< RSS hash result if RSS enabled */
169 } fdir; /**< Filter identifier if FDIR enabled */
170 uint32_t sched; /**< Hierarchical scheduler */
171 } hash; /**< hash information */
173 /* second cache line - fields only used in slow path or on TX */
174 MARKER cacheline1 __rte_cache_aligned;
177 void *userdata; /**< Can be used for external metadata */
178 uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */
181 struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
182 struct rte_mbuf *next; /**< Next segment of scattered packet. */
184 /* fields to support TX offloads */
186 uint16_t l2_l3_len; /**< combined l2/l3 lengths as single var */
188 uint16_t l3_len:9; /**< L3 (IP) Header Length. */
189 uint16_t l2_len:7; /**< L2 (MAC) Header Length. */
192 } __rte_cache_aligned;
195 * Given the buf_addr returns the pointer to corresponding mbuf.
197 #define RTE_MBUF_FROM_BADDR(ba) (((struct rte_mbuf *)(ba)) - 1)
200 * Given the pointer to mbuf returns an address where it's buf_addr
203 #define RTE_MBUF_TO_BADDR(mb) (((struct rte_mbuf *)(mb)) + 1)
206 * Returns TRUE if given mbuf is indirect, or FALSE otherwise.
208 #define RTE_MBUF_INDIRECT(mb) (RTE_MBUF_FROM_BADDR((mb)->buf_addr) != (mb))
211 * Returns TRUE if given mbuf is direct, or FALSE otherwise.
213 #define RTE_MBUF_DIRECT(mb) (RTE_MBUF_FROM_BADDR((mb)->buf_addr) == (mb))
217 * Private data in case of pktmbuf pool.
219 * A structure that contains some pktmbuf_pool-specific data that are
220 * appended after the mempool structure (in private data).
222 struct rte_pktmbuf_pool_private {
223 uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf.*/
226 #ifdef RTE_LIBRTE_MBUF_DEBUG
228 /** check mbuf type in debug mode */
229 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
231 /** check mbuf type in debug mode if mbuf pointer is not null */
232 #define __rte_mbuf_sanity_check_raw(m, is_h) do { \
234 rte_mbuf_sanity_check(m, is_h); \
237 /** MBUF asserts in debug mode */
238 #define RTE_MBUF_ASSERT(exp) \
240 rte_panic("line%d\tassert \"" #exp "\" failed\n", __LINE__); \
243 #else /* RTE_LIBRTE_MBUF_DEBUG */
245 /** check mbuf type in debug mode */
246 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
248 /** check mbuf type in debug mode if mbuf pointer is not null */
249 #define __rte_mbuf_sanity_check_raw(m, is_h) do { } while (0)
251 /** MBUF asserts in debug mode */
252 #define RTE_MBUF_ASSERT(exp) do { } while (0)
254 #endif /* RTE_LIBRTE_MBUF_DEBUG */
256 #ifdef RTE_MBUF_REFCNT
257 #ifdef RTE_MBUF_REFCNT_ATOMIC
260 * Adds given value to an mbuf's refcnt and returns its new value.
264 * Value to add/subtract
268 static inline uint16_t
269 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
271 return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
275 * Reads the value of an mbuf's refcnt.
279 * Reference count number.
281 static inline uint16_t
282 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
284 return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
288 * Sets an mbuf's refcnt to a defined value.
295 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
297 rte_atomic16_set(&m->refcnt_atomic, new_value);
300 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
303 * Adds given value to an mbuf's refcnt and returns its new value.
305 static inline uint16_t
306 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
308 m->refcnt = (uint16_t)(m->refcnt + value);
313 * Reads the value of an mbuf's refcnt.
315 static inline uint16_t
316 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
322 * Sets an mbuf's refcnt to the defined value.
325 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
327 m->refcnt = new_value;
330 #endif /* RTE_MBUF_REFCNT_ATOMIC */
333 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { \
338 #else /* ! RTE_MBUF_REFCNT */
341 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { } while(0)
343 #define rte_mbuf_refcnt_set(m,v) do { } while(0)
345 #endif /* RTE_MBUF_REFCNT */
349 * Sanity checks on an mbuf.
351 * Check the consistency of the given mbuf. The function will cause a
352 * panic if corruption is detected.
355 * The mbuf to be checked.
357 * True if the mbuf is a packet header, false if it is a sub-segment
358 * of a packet (in this case, some fields like nb_segs are not checked)
361 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
364 * @internal Allocate a new mbuf from mempool *mp*.
365 * The use of that function is reserved for RTE internal needs.
366 * Please use rte_pktmbuf_alloc().
369 * The mempool from which mbuf is allocated.
371 * - The pointer to the new mbuf on success.
372 * - NULL if allocation failed.
374 static inline struct rte_mbuf *__rte_mbuf_raw_alloc(struct rte_mempool *mp)
378 if (rte_mempool_get(mp, &mb) < 0)
380 m = (struct rte_mbuf *)mb;
381 #ifdef RTE_MBUF_REFCNT
382 RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
383 rte_mbuf_refcnt_set(m, 1);
384 #endif /* RTE_MBUF_REFCNT */
389 * @internal Put mbuf back into its original mempool.
390 * The use of that function is reserved for RTE internal needs.
391 * Please use rte_pktmbuf_free().
394 * The mbuf to be freed.
396 static inline void __attribute__((always_inline))
397 __rte_mbuf_raw_free(struct rte_mbuf *m)
399 #ifdef RTE_MBUF_REFCNT
400 RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
401 #endif /* RTE_MBUF_REFCNT */
402 rte_mempool_put(m->pool, m);
405 /* Operations on ctrl mbuf */
408 * The control mbuf constructor.
410 * This function initializes some fields in an mbuf structure that are
411 * not modified by the user once created (mbuf type, origin pool, buffer
412 * start address, and so on). This function is given as a callback function
413 * to rte_mempool_create() at pool creation time.
416 * The mempool from which the mbuf is allocated.
418 * A pointer that can be used by the user to retrieve useful information
419 * for mbuf initialization. This pointer comes from the ``init_arg``
420 * parameter of rte_mempool_create().
422 * The mbuf to initialize.
424 * The index of the mbuf in the pool table.
426 void rte_ctrlmbuf_init(struct rte_mempool *mp, void *opaque_arg,
427 void *m, unsigned i);
430 * Allocate a new mbuf (type is ctrl) from mempool *mp*.
432 * This new mbuf is initialized with data pointing to the beginning of
433 * buffer, and with a length of zero.
436 * The mempool from which the mbuf is allocated.
438 * - The pointer to the new mbuf on success.
439 * - NULL if allocation failed.
441 #define rte_ctrlmbuf_alloc(mp) rte_pktmbuf_alloc(mp)
444 * Free a control mbuf back into its original mempool.
447 * The control mbuf to be freed.
449 #define rte_ctrlmbuf_free(m) rte_pktmbuf_free(m)
452 * A macro that returns the pointer to the carried data.
454 * The value that can be read or assigned.
459 #define rte_ctrlmbuf_data(m) ((char *)((m)->buf_addr) + (m)->data_off)
462 * A macro that returns the length of the carried data.
464 * The value that can be read or assigned.
469 #define rte_ctrlmbuf_len(m) rte_pktmbuf_data_len(m)
472 * Tests if an mbuf is a control mbuf
475 * The mbuf to be tested
477 * - True (1) if the mbuf is a control mbuf
478 * - False(0) otherwise
481 rte_is_ctrlmbuf(struct rte_mbuf *m)
483 return (!!(m->ol_flags & CTRL_MBUF_FLAG));
486 /* Operations on pkt mbuf */
489 * The packet mbuf constructor.
491 * This function initializes some fields in the mbuf structure that are
492 * not modified by the user once created (origin pool, buffer start
493 * address, and so on). This function is given as a callback function to
494 * rte_mempool_create() at pool creation time.
497 * The mempool from which mbufs originate.
499 * A pointer that can be used by the user to retrieve useful information
500 * for mbuf initialization. This pointer comes from the ``init_arg``
501 * parameter of rte_mempool_create().
503 * The mbuf to initialize.
505 * The index of the mbuf in the pool table.
507 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
508 void *m, unsigned i);
512 * A packet mbuf pool constructor.
514 * This function initializes the mempool private data in the case of a
515 * pktmbuf pool. This private data is needed by the driver. The
516 * function is given as a callback function to rte_mempool_create() at
517 * pool creation. It can be extended by the user, for example, to
518 * provide another packet size.
521 * The mempool from which mbufs originate.
523 * A pointer that can be used by the user to retrieve useful information
524 * for mbuf initialization. This pointer comes from the ``init_arg``
525 * parameter of rte_mempool_create().
527 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
530 * Reset the fields of a packet mbuf to their default values.
532 * The given mbuf must have only one segment.
535 * The packet mbuf to be resetted.
537 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
547 m->data_off = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
548 RTE_PKTMBUF_HEADROOM : m->buf_len;
551 __rte_mbuf_sanity_check(m, 1);
555 * Allocate a new mbuf from a mempool.
557 * This new mbuf contains one segment, which has a length of 0. The pointer
558 * to data is initialized to have some bytes of headroom in the buffer
559 * (if buffer size allows).
562 * The mempool from which the mbuf is allocated.
564 * - The pointer to the new mbuf on success.
565 * - NULL if allocation failed.
567 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
570 if ((m = __rte_mbuf_raw_alloc(mp)) != NULL)
571 rte_pktmbuf_reset(m);
575 #ifdef RTE_MBUF_REFCNT
578 * Attach packet mbuf to another packet mbuf.
579 * After attachment we refer the mbuf we attached as 'indirect',
580 * while mbuf we attached to as 'direct'.
581 * Right now, not supported:
582 * - attachment to indirect mbuf (e.g. - md has to be direct).
583 * - attachment for already indirect mbuf (e.g. - mi has to be direct).
584 * - mbuf we trying to attach (mi) is used by someone else
585 * e.g. it's reference counter is greater then 1.
588 * The indirect packet mbuf.
590 * The direct packet mbuf.
593 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *md)
595 RTE_MBUF_ASSERT(RTE_MBUF_DIRECT(md) &&
596 RTE_MBUF_DIRECT(mi) &&
597 rte_mbuf_refcnt_read(mi) == 1);
599 rte_mbuf_refcnt_update(md, 1);
600 mi->buf_physaddr = md->buf_physaddr;
601 mi->buf_addr = md->buf_addr;
602 mi->buf_len = md->buf_len;
605 mi->data_off = md->data_off;
606 mi->data_len = md->data_len;
608 mi->vlan_tci = md->vlan_tci;
609 mi->l2_l3_len = md->l2_l3_len;
613 mi->pkt_len = mi->data_len;
615 mi->ol_flags = md->ol_flags;
617 __rte_mbuf_sanity_check(mi, 1);
618 __rte_mbuf_sanity_check(md, 0);
622 * Detach an indirect packet mbuf -
623 * - restore original mbuf address and length values.
624 * - reset pktmbuf data and data_len to their default values.
625 * All other fields of the given packet mbuf will be left intact.
628 * The indirect attached packet mbuf.
631 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
633 const struct rte_mempool *mp = m->pool;
634 void *buf = RTE_MBUF_TO_BADDR(m);
635 uint32_t buf_len = mp->elt_size - sizeof(*m);
636 m->buf_physaddr = rte_mempool_virt2phy(mp, m) + sizeof (*m);
639 m->buf_len = (uint16_t)buf_len;
641 m->data_off = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
642 RTE_PKTMBUF_HEADROOM : m->buf_len;
647 #endif /* RTE_MBUF_REFCNT */
650 static inline struct rte_mbuf* __attribute__((always_inline))
651 __rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
653 __rte_mbuf_sanity_check(m, 0);
655 #ifdef RTE_MBUF_REFCNT
656 if (likely (rte_mbuf_refcnt_read(m) == 1) ||
657 likely (rte_mbuf_refcnt_update(m, -1) == 0)) {
658 struct rte_mbuf *md = RTE_MBUF_FROM_BADDR(m->buf_addr);
660 rte_mbuf_refcnt_set(m, 0);
662 /* if this is an indirect mbuf, then
664 * - free attached mbuf segment
666 if (unlikely (md != m)) {
667 rte_pktmbuf_detach(m);
668 if (rte_mbuf_refcnt_update(md, -1) == 0)
669 __rte_mbuf_raw_free(md);
673 #ifdef RTE_MBUF_REFCNT
680 * Free a segment of a packet mbuf into its original mempool.
682 * Free an mbuf, without parsing other segments in case of chained
686 * The packet mbuf segment to be freed.
688 static inline void __attribute__((always_inline))
689 rte_pktmbuf_free_seg(struct rte_mbuf *m)
691 if (likely(NULL != (m = __rte_pktmbuf_prefree_seg(m)))) {
693 __rte_mbuf_raw_free(m);
698 * Free a packet mbuf back into its original mempool.
700 * Free an mbuf, and all its segments in case of chained buffers. Each
701 * segment is added back into its original mempool.
704 * The packet mbuf to be freed.
706 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
708 struct rte_mbuf *m_next;
710 __rte_mbuf_sanity_check(m, 1);
714 rte_pktmbuf_free_seg(m);
719 #ifdef RTE_MBUF_REFCNT
722 * Creates a "clone" of the given packet mbuf.
724 * Walks through all segments of the given packet mbuf, and for each of them:
725 * - Creates a new packet mbuf from the given pool.
726 * - Attaches newly created mbuf to the segment.
727 * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
728 * from the original packet mbuf.
731 * The packet mbuf to be cloned.
733 * The mempool from which the "clone" mbufs are allocated.
735 * - The pointer to the new "clone" mbuf on success.
736 * - NULL if allocation fails.
738 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
739 struct rte_mempool *mp)
741 struct rte_mbuf *mc, *mi, **prev;
745 if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
750 pktlen = md->pkt_len;
755 rte_pktmbuf_attach(mi, md);
758 } while ((md = md->next) != NULL &&
759 (mi = rte_pktmbuf_alloc(mp)) != NULL);
763 mc->pkt_len = pktlen;
765 /* Allocation of new indirect segment failed */
766 if (unlikely (mi == NULL)) {
767 rte_pktmbuf_free(mc);
771 __rte_mbuf_sanity_check(mc, 1);
776 * Adds given value to the refcnt of all packet mbuf segments.
778 * Walks through all segments of given packet mbuf and for each of them
779 * invokes rte_mbuf_refcnt_update().
782 * The packet mbuf whose refcnt to be updated.
784 * The value to add to the mbuf's segments refcnt.
786 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
788 __rte_mbuf_sanity_check(m, 1);
791 rte_mbuf_refcnt_update(m, v);
792 } while ((m = m->next) != NULL);
795 #endif /* RTE_MBUF_REFCNT */
798 * Get the headroom in a packet mbuf.
803 * The length of the headroom.
805 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
807 __rte_mbuf_sanity_check(m, 1);
812 * Get the tailroom of a packet mbuf.
817 * The length of the tailroom.
819 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
821 __rte_mbuf_sanity_check(m, 1);
822 return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
827 * Get the last segment of the packet.
832 * The last segment of the given mbuf.
834 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
836 struct rte_mbuf *m2 = (struct rte_mbuf *)m;
838 __rte_mbuf_sanity_check(m, 1);
839 while (m2->next != NULL)
845 * A macro that points to the start of the data in the mbuf.
847 * The returned pointer is cast to type t. Before using this
848 * function, the user must ensure that m_headlen(m) is large enough to
854 * The type to cast the result into.
856 #define rte_pktmbuf_mtod(m, t) ((t)((char *)(m)->buf_addr + (m)->data_off))
859 * A macro that returns the length of the packet.
861 * The value can be read or assigned.
866 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
869 * A macro that returns the length of the segment.
871 * The value can be read or assigned.
876 #define rte_pktmbuf_data_len(m) ((m)->data_len)
879 * Prepend len bytes to an mbuf data area.
881 * Returns a pointer to the new
882 * data start address. If there is not enough headroom in the first
883 * segment, the function will return NULL, without modifying the mbuf.
888 * The amount of data to prepend (in bytes).
890 * A pointer to the start of the newly prepended data, or
891 * NULL if there is not enough headroom space in the first segment
893 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
896 __rte_mbuf_sanity_check(m, 1);
898 if (unlikely(len > rte_pktmbuf_headroom(m)))
902 m->data_len = (uint16_t)(m->data_len + len);
903 m->pkt_len = (m->pkt_len + len);
905 return (char *)m->buf_addr + m->data_off;
909 * Append len bytes to an mbuf.
911 * Append len bytes to an mbuf and return a pointer to the start address
912 * of the added data. If there is not enough tailroom in the last
913 * segment, the function will return NULL, without modifying the mbuf.
918 * The amount of data to append (in bytes).
920 * A pointer to the start of the newly appended data, or
921 * NULL if there is not enough tailroom space in the last segment
923 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
926 struct rte_mbuf *m_last;
928 __rte_mbuf_sanity_check(m, 1);
930 m_last = rte_pktmbuf_lastseg(m);
931 if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
934 tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
935 m_last->data_len = (uint16_t)(m_last->data_len + len);
936 m->pkt_len = (m->pkt_len + len);
941 * Remove len bytes at the beginning of an mbuf.
943 * Returns a pointer to the start address of the new data area. If the
944 * length is greater than the length of the first segment, then the
945 * function will fail and return NULL, without modifying the mbuf.
950 * The amount of data to remove (in bytes).
952 * A pointer to the new start of the data.
954 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
956 __rte_mbuf_sanity_check(m, 1);
958 if (unlikely(len > m->data_len))
961 m->data_len = (uint16_t)(m->data_len - len);
963 m->pkt_len = (m->pkt_len - len);
964 return (char *)m->buf_addr + m->data_off;
968 * Remove len bytes of data at the end of the mbuf.
970 * If the length is greater than the length of the last segment, the
971 * function will fail and return -1 without modifying the mbuf.
976 * The amount of data to remove (in bytes).
981 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
983 struct rte_mbuf *m_last;
985 __rte_mbuf_sanity_check(m, 1);
987 m_last = rte_pktmbuf_lastseg(m);
988 if (unlikely(len > m_last->data_len))
991 m_last->data_len = (uint16_t)(m_last->data_len - len);
992 m->pkt_len = (m->pkt_len - len);
997 * Test if mbuf data is contiguous.
1002 * - 1, if all data is contiguous (one segment).
1003 * - 0, if there is several segments.
1005 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
1007 __rte_mbuf_sanity_check(m, 1);
1008 return !!(m->nb_segs == 1);
1012 * Dump an mbuf structure to the console.
1014 * Dump all fields for the given packet mbuf and all its associated
1015 * segments (in the case of a chained buffer).
1018 * A pointer to a file for output
1022 * If dump_len != 0, also dump the "dump_len" first data bytes of
1025 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
1031 #endif /* _RTE_MBUF_H_ */