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 */
95 * Bit 14~13 used for L4 packet type with checksum enabled.
101 #define PKT_TX_L4_MASK 0x6000 /**< Mask bits for L4 checksum offload request. */
102 #define PKT_TX_L4_NO_CKSUM 0x0000 /**< Disable L4 cksum of TX pkt. */
103 #define PKT_TX_TCP_CKSUM 0x2000 /**< TCP cksum of TX pkt. computed by NIC. */
104 #define PKT_TX_SCTP_CKSUM 0x4000 /**< SCTP cksum of TX pkt. computed by NIC. */
105 #define PKT_TX_UDP_CKSUM 0x6000 /**< UDP cksum of TX pkt. computed by NIC. */
107 #define PKT_TX_IEEE1588_TMST 0x8000 /**< TX IEEE1588 packet to timestamp. */
110 * Bit Mask to indicate what bits required for building TX context
112 #define PKT_TX_OFFLOAD_MASK (PKT_TX_VLAN_PKT | PKT_TX_IP_CKSUM | PKT_TX_L4_MASK)
114 /** Offload features */
115 union rte_vlan_macip {
118 uint16_t l3_len:9; /**< L3 (IP) Header Length. */
119 uint16_t l2_len:7; /**< L2 (MAC) Header Length. */
121 /**< VLAN Tag Control Identifier (CPU order). */
126 * Compare mask for vlan_macip_len.data,
127 * should be in sync with rte_vlan_macip.f layout.
129 #define TX_VLAN_CMP_MASK 0xFFFF0000 /**< VLAN length - 16-bits. */
130 #define TX_MAC_LEN_CMP_MASK 0x0000FE00 /**< MAC length - 7-bits. */
131 #define TX_IP_LEN_CMP_MASK 0x000001FF /**< IP length - 9-bits. */
132 /**< MAC+IP length. */
133 #define TX_MACIP_LEN_CMP_MASK (TX_MAC_LEN_CMP_MASK | TX_IP_LEN_CMP_MASK)
136 * A packet message buffer.
139 /* valid for any segment */
140 struct rte_mbuf *next; /**< Next segment of scattered packet. */
141 void* data; /**< Start address of data in segment buffer. */
142 uint16_t data_len; /**< Amount of data in segment buffer. */
144 /* these fields are valid for first segment only */
145 uint8_t nb_segs; /**< Number of segments. */
146 uint8_t in_port; /**< Input port. */
147 uint32_t pkt_len; /**< Total pkt len: sum of all segment data_len. */
149 /* offload features */
150 union rte_vlan_macip vlan_macip;
152 uint32_t rss; /**< RSS hash result if RSS enabled */
156 } fdir; /**< Filter identifier if FDIR enabled */
157 uint32_t sched; /**< Hierarchical scheduler */
158 } hash; /**< hash information */
162 * The generic rte_mbuf, containing a packet mbuf.
165 struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
166 void *buf_addr; /**< Virtual address of segment buffer. */
167 phys_addr_t buf_physaddr; /**< Physical address of segment buffer. */
168 uint16_t buf_len; /**< Length of segment buffer. */
169 #ifdef RTE_MBUF_REFCNT
171 * 16-bit Reference counter.
172 * It should only be accessed using the following functions:
173 * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
174 * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
175 * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
179 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
180 uint16_t refcnt; /**< Non-atomically accessed refcnt */
183 uint16_t refcnt_reserved; /**< Do not use this field */
185 uint16_t reserved; /**< Unused field. Required for padding */
186 uint16_t ol_flags; /**< Offload features. */
188 struct rte_pktmbuf pkt;
192 uint16_t metadata16[0];
193 uint32_t metadata32[0];
194 uint64_t metadata64[0];
196 } __rte_cache_aligned;
198 #define RTE_MBUF_METADATA_UINT8(mbuf, offset) \
199 (mbuf->metadata[offset])
200 #define RTE_MBUF_METADATA_UINT16(mbuf, offset) \
201 (mbuf->metadata16[offset/sizeof(uint16_t)])
202 #define RTE_MBUF_METADATA_UINT32(mbuf, offset) \
203 (mbuf->metadata32[offset/sizeof(uint32_t)])
204 #define RTE_MBUF_METADATA_UINT64(mbuf, offset) \
205 (mbuf->metadata64[offset/sizeof(uint64_t)])
207 #define RTE_MBUF_METADATA_UINT8_PTR(mbuf, offset) \
208 (&mbuf->metadata[offset])
209 #define RTE_MBUF_METADATA_UINT16_PTR(mbuf, offset) \
210 (&mbuf->metadata16[offset/sizeof(uint16_t)])
211 #define RTE_MBUF_METADATA_UINT32_PTR(mbuf, offset) \
212 (&mbuf->metadata32[offset/sizeof(uint32_t)])
213 #define RTE_MBUF_METADATA_UINT64_PTR(mbuf, offset) \
214 (&mbuf->metadata64[offset/sizeof(uint64_t)])
217 * Given the buf_addr returns the pointer to corresponding mbuf.
219 #define RTE_MBUF_FROM_BADDR(ba) (((struct rte_mbuf *)(ba)) - 1)
222 * Given the pointer to mbuf returns an address where it's buf_addr
225 #define RTE_MBUF_TO_BADDR(mb) (((struct rte_mbuf *)(mb)) + 1)
228 * Returns TRUE if given mbuf is indirect, or FALSE otherwise.
230 #define RTE_MBUF_INDIRECT(mb) (RTE_MBUF_FROM_BADDR((mb)->buf_addr) != (mb))
233 * Returns TRUE if given mbuf is direct, or FALSE otherwise.
235 #define RTE_MBUF_DIRECT(mb) (RTE_MBUF_FROM_BADDR((mb)->buf_addr) == (mb))
239 * Private data in case of pktmbuf pool.
241 * A structure that contains some pktmbuf_pool-specific data that are
242 * appended after the mempool structure (in private data).
244 struct rte_pktmbuf_pool_private {
245 uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf.*/
248 #ifdef RTE_LIBRTE_MBUF_DEBUG
250 /** check mbuf type in debug mode */
251 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
253 /** check mbuf type in debug mode if mbuf pointer is not null */
254 #define __rte_mbuf_sanity_check_raw(m, is_h) do { \
256 rte_mbuf_sanity_check(m, is_h); \
259 /** MBUF asserts in debug mode */
260 #define RTE_MBUF_ASSERT(exp) \
262 rte_panic("line%d\tassert \"" #exp "\" failed\n", __LINE__); \
265 #else /* RTE_LIBRTE_MBUF_DEBUG */
267 /** check mbuf type in debug mode */
268 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
270 /** check mbuf type in debug mode if mbuf pointer is not null */
271 #define __rte_mbuf_sanity_check_raw(m, is_h) do { } while (0)
273 /** MBUF asserts in debug mode */
274 #define RTE_MBUF_ASSERT(exp) do { } while (0)
276 #endif /* RTE_LIBRTE_MBUF_DEBUG */
278 #ifdef RTE_MBUF_REFCNT
279 #ifdef RTE_MBUF_REFCNT_ATOMIC
282 * Adds given value to an mbuf's refcnt and returns its new value.
286 * Value to add/subtract
290 static inline uint16_t
291 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
293 return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
297 * Reads the value of an mbuf's refcnt.
301 * Reference count number.
303 static inline uint16_t
304 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
306 return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
310 * Sets an mbuf's refcnt to a defined value.
317 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
319 rte_atomic16_set(&m->refcnt_atomic, new_value);
322 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
325 * Adds given value to an mbuf's refcnt and returns its new value.
327 static inline uint16_t
328 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
330 m->refcnt = (uint16_t)(m->refcnt + value);
335 * Reads the value of an mbuf's refcnt.
337 static inline uint16_t
338 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
344 * Sets an mbuf's refcnt to the defined value.
347 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
349 m->refcnt = new_value;
352 #endif /* RTE_MBUF_REFCNT_ATOMIC */
355 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { \
360 #else /* ! RTE_MBUF_REFCNT */
363 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { } while(0)
365 #define rte_mbuf_refcnt_set(m,v) do { } while(0)
367 #endif /* RTE_MBUF_REFCNT */
371 * Sanity checks on an mbuf.
373 * Check the consistency of the given mbuf. The function will cause a
374 * panic if corruption is detected.
377 * The mbuf to be checked.
379 * True if the mbuf is a packet header, false if it is a sub-segment
380 * of a packet (in this case, some fields like nb_segs are not checked)
383 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
386 * @internal Allocate a new mbuf from mempool *mp*.
387 * The use of that function is reserved for RTE internal needs.
388 * Please use rte_pktmbuf_alloc().
391 * The mempool from which mbuf is allocated.
393 * - The pointer to the new mbuf on success.
394 * - NULL if allocation failed.
396 static inline struct rte_mbuf *__rte_mbuf_raw_alloc(struct rte_mempool *mp)
400 if (rte_mempool_get(mp, &mb) < 0)
402 m = (struct rte_mbuf *)mb;
403 #ifdef RTE_MBUF_REFCNT
404 RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
405 rte_mbuf_refcnt_set(m, 1);
406 #endif /* RTE_MBUF_REFCNT */
411 * @internal Put mbuf back into its original mempool.
412 * The use of that function is reserved for RTE internal needs.
413 * Please use rte_pktmbuf_free().
416 * The mbuf to be freed.
418 static inline void __attribute__((always_inline))
419 __rte_mbuf_raw_free(struct rte_mbuf *m)
421 #ifdef RTE_MBUF_REFCNT
422 RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
423 #endif /* RTE_MBUF_REFCNT */
424 rte_mempool_put(m->pool, m);
427 /* Operations on ctrl mbuf */
430 * The control mbuf constructor.
432 * This function initializes some fields in an mbuf structure that are
433 * not modified by the user once created (mbuf type, origin pool, buffer
434 * start address, and so on). This function is given as a callback function
435 * to rte_mempool_create() at pool creation time.
438 * The mempool from which the mbuf is allocated.
440 * A pointer that can be used by the user to retrieve useful information
441 * for mbuf initialization. This pointer comes from the ``init_arg``
442 * parameter of rte_mempool_create().
444 * The mbuf to initialize.
446 * The index of the mbuf in the pool table.
448 void rte_ctrlmbuf_init(struct rte_mempool *mp, void *opaque_arg,
449 void *m, unsigned i);
452 * Allocate a new mbuf (type is ctrl) from mempool *mp*.
454 * This new mbuf is initialized with data pointing to the beginning of
455 * buffer, and with a length of zero.
458 * The mempool from which the mbuf is allocated.
460 * - The pointer to the new mbuf on success.
461 * - NULL if allocation failed.
463 #define rte_ctrlmbuf_alloc(mp) rte_pktmbuf_alloc(mp)
466 * Free a control mbuf back into its original mempool.
469 * The control mbuf to be freed.
471 #define rte_ctrlmbuf_free(m) rte_pktmbuf_free(m)
474 * A macro that returns the pointer to the carried data.
476 * The value that can be read or assigned.
481 #define rte_ctrlmbuf_data(m) ((m)->pkt.data)
484 * A macro that returns the length of the carried data.
486 * The value that can be read or assigned.
491 #define rte_ctrlmbuf_len(m) rte_pktmbuf_data_len(m)
493 /* Operations on pkt mbuf */
496 * The packet mbuf constructor.
498 * This function initializes some fields in the mbuf structure that are
499 * not modified by the user once created (origin pool, buffer start
500 * address, and so on). This function is given as a callback function to
501 * rte_mempool_create() at pool creation time.
504 * The mempool from which mbufs originate.
506 * A pointer that can be used by the user to retrieve useful information
507 * for mbuf initialization. This pointer comes from the ``init_arg``
508 * parameter of rte_mempool_create().
510 * The mbuf to initialize.
512 * The index of the mbuf in the pool table.
514 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
515 void *m, unsigned i);
519 * A packet mbuf pool constructor.
521 * This function initializes the mempool private data in the case of a
522 * pktmbuf pool. This private data is needed by the driver. The
523 * function is given as a callback function to rte_mempool_create() at
524 * pool creation. It can be extended by the user, for example, to
525 * provide another packet size.
528 * The mempool from which mbufs originate.
530 * A pointer that can be used by the user to retrieve useful information
531 * for mbuf initialization. This pointer comes from the ``init_arg``
532 * parameter of rte_mempool_create().
534 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
537 * Reset the fields of a packet mbuf to their default values.
539 * The given mbuf must have only one segment.
542 * The packet mbuf to be resetted.
544 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
550 m->pkt.vlan_macip.data = 0;
552 m->pkt.in_port = 0xff;
555 buf_ofs = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
556 RTE_PKTMBUF_HEADROOM : m->buf_len;
557 m->pkt.data = (char*) m->buf_addr + buf_ofs;
560 __rte_mbuf_sanity_check(m, 1);
564 * Allocate a new mbuf from a mempool.
566 * This new mbuf contains one segment, which has a length of 0. The pointer
567 * to data is initialized to have some bytes of headroom in the buffer
568 * (if buffer size allows).
571 * The mempool from which the mbuf is allocated.
573 * - The pointer to the new mbuf on success.
574 * - NULL if allocation failed.
576 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
579 if ((m = __rte_mbuf_raw_alloc(mp)) != NULL)
580 rte_pktmbuf_reset(m);
584 #ifdef RTE_MBUF_REFCNT
587 * Attach packet mbuf to another packet mbuf.
588 * After attachment we refer the mbuf we attached as 'indirect',
589 * while mbuf we attached to as 'direct'.
590 * Right now, not supported:
591 * - attachment to indirect mbuf (e.g. - md has to be direct).
592 * - attachment for already indirect mbuf (e.g. - mi has to be direct).
593 * - mbuf we trying to attach (mi) is used by someone else
594 * e.g. it's reference counter is greater then 1.
597 * The indirect packet mbuf.
599 * The direct packet mbuf.
602 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *md)
604 RTE_MBUF_ASSERT(RTE_MBUF_DIRECT(md) &&
605 RTE_MBUF_DIRECT(mi) &&
606 rte_mbuf_refcnt_read(mi) == 1);
608 rte_mbuf_refcnt_update(md, 1);
609 mi->buf_physaddr = md->buf_physaddr;
610 mi->buf_addr = md->buf_addr;
611 mi->buf_len = md->buf_len;
616 mi->pkt.pkt_len = mi->pkt.data_len;
618 mi->ol_flags = md->ol_flags;
620 __rte_mbuf_sanity_check(mi, 1);
621 __rte_mbuf_sanity_check(md, 0);
625 * Detach an indirect packet mbuf -
626 * - restore original mbuf address and length values.
627 * - reset pktmbuf data and data_len to their default values.
628 * All other fields of the given packet mbuf will be left intact.
631 * The indirect attached packet mbuf.
634 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
636 const struct rte_mempool *mp = m->pool;
637 void *buf = RTE_MBUF_TO_BADDR(m);
639 uint32_t buf_len = mp->elt_size - sizeof(*m);
640 m->buf_physaddr = rte_mempool_virt2phy(mp, m) + sizeof (*m);
643 m->buf_len = (uint16_t)buf_len;
645 buf_ofs = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
646 RTE_PKTMBUF_HEADROOM : m->buf_len;
647 m->pkt.data = (char*) m->buf_addr + buf_ofs;
652 #endif /* RTE_MBUF_REFCNT */
655 static inline struct rte_mbuf* __attribute__((always_inline))
656 __rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
658 __rte_mbuf_sanity_check(m, 0);
660 #ifdef RTE_MBUF_REFCNT
661 if (likely (rte_mbuf_refcnt_read(m) == 1) ||
662 likely (rte_mbuf_refcnt_update(m, -1) == 0)) {
663 struct rte_mbuf *md = RTE_MBUF_FROM_BADDR(m->buf_addr);
665 rte_mbuf_refcnt_set(m, 0);
667 /* if this is an indirect mbuf, then
669 * - free attached mbuf segment
671 if (unlikely (md != m)) {
672 rte_pktmbuf_detach(m);
673 if (rte_mbuf_refcnt_update(md, -1) == 0)
674 __rte_mbuf_raw_free(md);
678 #ifdef RTE_MBUF_REFCNT
685 * Free a segment of a packet mbuf into its original mempool.
687 * Free an mbuf, without parsing other segments in case of chained
691 * The packet mbuf segment to be freed.
693 static inline void __attribute__((always_inline))
694 rte_pktmbuf_free_seg(struct rte_mbuf *m)
696 if (likely(NULL != (m = __rte_pktmbuf_prefree_seg(m))))
697 __rte_mbuf_raw_free(m);
701 * Free a packet mbuf back into its original mempool.
703 * Free an mbuf, and all its segments in case of chained buffers. Each
704 * segment is added back into its original mempool.
707 * The packet mbuf to be freed.
709 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
711 struct rte_mbuf *m_next;
713 __rte_mbuf_sanity_check(m, 1);
716 m_next = m->pkt.next;
717 rte_pktmbuf_free_seg(m);
722 #ifdef RTE_MBUF_REFCNT
725 * Creates a "clone" of the given packet mbuf.
727 * Walks through all segments of the given packet mbuf, and for each of them:
728 * - Creates a new packet mbuf from the given pool.
729 * - Attaches newly created mbuf to the segment.
730 * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
731 * from the original packet mbuf.
734 * The packet mbuf to be cloned.
736 * The mempool from which the "clone" mbufs are allocated.
738 * - The pointer to the new "clone" mbuf on success.
739 * - NULL if allocation fails.
741 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
742 struct rte_mempool *mp)
744 struct rte_mbuf *mc, *mi, **prev;
748 if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
752 prev = &mi->pkt.next;
753 pktlen = md->pkt.pkt_len;
758 rte_pktmbuf_attach(mi, md);
760 prev = &mi->pkt.next;
761 } while ((md = md->pkt.next) != NULL &&
762 (mi = rte_pktmbuf_alloc(mp)) != NULL);
765 mc->pkt.nb_segs = nseg;
766 mc->pkt.pkt_len = pktlen;
768 /* Allocation of new indirect segment failed */
769 if (unlikely (mi == NULL)) {
770 rte_pktmbuf_free(mc);
774 __rte_mbuf_sanity_check(mc, 1);
779 * Adds given value to the refcnt of all packet mbuf segments.
781 * Walks through all segments of given packet mbuf and for each of them
782 * invokes rte_mbuf_refcnt_update().
785 * The packet mbuf whose refcnt to be updated.
787 * The value to add to the mbuf's segments refcnt.
789 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
791 __rte_mbuf_sanity_check(m, 1);
794 rte_mbuf_refcnt_update(m, v);
795 } while ((m = m->pkt.next) != NULL);
798 #endif /* RTE_MBUF_REFCNT */
801 * Get the headroom in a packet mbuf.
806 * The length of the headroom.
808 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
810 __rte_mbuf_sanity_check(m, 1);
811 return (uint16_t) ((char*) m->pkt.data - (char*) m->buf_addr);
815 * Get the tailroom of a packet mbuf.
820 * The length of the tailroom.
822 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
824 __rte_mbuf_sanity_check(m, 1);
825 return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
830 * Get the last segment of the packet.
835 * The last segment of the given mbuf.
837 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
839 struct rte_mbuf *m2 = (struct rte_mbuf *)m;
841 __rte_mbuf_sanity_check(m, 1);
842 while (m2->pkt.next != NULL)
848 * A macro that points to the start of the data in the mbuf.
850 * The returned pointer is cast to type t. Before using this
851 * function, the user must ensure that m_headlen(m) is large enough to
857 * The type to cast the result into.
859 #define rte_pktmbuf_mtod(m, t) ((t)((m)->pkt.data))
862 * A macro that returns the length of the packet.
864 * The value can be read or assigned.
869 #define rte_pktmbuf_pkt_len(m) ((m)->pkt.pkt_len)
872 * A macro that returns the length of the segment.
874 * The value can be read or assigned.
879 #define rte_pktmbuf_data_len(m) ((m)->pkt.data_len)
882 * Prepend len bytes to an mbuf data area.
884 * Returns a pointer to the new
885 * data start address. If there is not enough headroom in the first
886 * segment, the function will return NULL, without modifying the mbuf.
891 * The amount of data to prepend (in bytes).
893 * A pointer to the start of the newly prepended data, or
894 * NULL if there is not enough headroom space in the first segment
896 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
899 __rte_mbuf_sanity_check(m, 1);
901 if (unlikely(len > rte_pktmbuf_headroom(m)))
904 m->pkt.data = (char*) m->pkt.data - len;
905 m->pkt.data_len = (uint16_t)(m->pkt.data_len + len);
906 m->pkt.pkt_len = (m->pkt.pkt_len + len);
908 return (char*) m->pkt.data;
912 * Append len bytes to an mbuf.
914 * Append len bytes to an mbuf and return a pointer to the start address
915 * of the added data. If there is not enough tailroom in the last
916 * segment, the function will return NULL, without modifying the mbuf.
921 * The amount of data to append (in bytes).
923 * A pointer to the start of the newly appended data, or
924 * NULL if there is not enough tailroom space in the last segment
926 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
929 struct rte_mbuf *m_last;
931 __rte_mbuf_sanity_check(m, 1);
933 m_last = rte_pktmbuf_lastseg(m);
934 if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
937 tail = (char*) m_last->pkt.data + m_last->pkt.data_len;
938 m_last->pkt.data_len = (uint16_t)(m_last->pkt.data_len + len);
939 m->pkt.pkt_len = (m->pkt.pkt_len + len);
944 * Remove len bytes at the beginning of an mbuf.
946 * Returns a pointer to the start address of the new data area. If the
947 * length is greater than the length of the first segment, then the
948 * function will fail and return NULL, without modifying the mbuf.
953 * The amount of data to remove (in bytes).
955 * A pointer to the new start of the data.
957 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
959 __rte_mbuf_sanity_check(m, 1);
961 if (unlikely(len > m->pkt.data_len))
964 m->pkt.data_len = (uint16_t)(m->pkt.data_len - len);
965 m->pkt.data = ((char*) m->pkt.data + len);
966 m->pkt.pkt_len = (m->pkt.pkt_len - len);
967 return (char*) m->pkt.data;
971 * Remove len bytes of data at the end of the mbuf.
973 * If the length is greater than the length of the last segment, the
974 * function will fail and return -1 without modifying the mbuf.
979 * The amount of data to remove (in bytes).
984 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
986 struct rte_mbuf *m_last;
988 __rte_mbuf_sanity_check(m, 1);
990 m_last = rte_pktmbuf_lastseg(m);
991 if (unlikely(len > m_last->pkt.data_len))
994 m_last->pkt.data_len = (uint16_t)(m_last->pkt.data_len - len);
995 m->pkt.pkt_len = (m->pkt.pkt_len - len);
1000 * Test if mbuf data is contiguous.
1005 * - 1, if all data is contiguous (one segment).
1006 * - 0, if there is several segments.
1008 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
1010 __rte_mbuf_sanity_check(m, 1);
1011 return !!(m->pkt.nb_segs == 1);
1015 * Dump an mbuf structure to the console.
1017 * Dump all fields for the given packet mbuf and all its associated
1018 * segments (in the case of a chained buffer).
1021 * A pointer to a file for output
1025 * If dump_len != 0, also dump the "dump_len" first data bytes of
1028 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
1034 #endif /* _RTE_MBUF_H_ */