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 * Keep these flags synchronized with rte_get_rx_ol_flag_name() and
79 * rte_get_tx_ol_flag_name().
81 #define PKT_RX_VLAN_PKT (1ULL << 0) /**< RX packet is a 802.1q VLAN packet. */
82 #define PKT_RX_RSS_HASH (1ULL << 1) /**< RX packet with RSS hash result. */
83 #define PKT_RX_FDIR (1ULL << 2) /**< RX packet with FDIR match indicate. */
84 #define PKT_RX_L4_CKSUM_BAD (1ULL << 3) /**< L4 cksum of RX pkt. is not OK. */
85 #define PKT_RX_IP_CKSUM_BAD (1ULL << 4) /**< IP cksum of RX pkt. is not OK. */
86 #define PKT_RX_EIP_CKSUM_BAD (0ULL << 0) /**< External IP header checksum error. */
87 #define PKT_RX_OVERSIZE (0ULL << 0) /**< Num of desc of an RX pkt oversize. */
88 #define PKT_RX_HBUF_OVERFLOW (0ULL << 0) /**< Header buffer overflow. */
89 #define PKT_RX_RECIP_ERR (0ULL << 0) /**< Hardware processing error. */
90 #define PKT_RX_MAC_ERR (0ULL << 0) /**< MAC error. */
91 #define PKT_RX_IPV4_HDR (1ULL << 5) /**< RX packet with IPv4 header. */
92 #define PKT_RX_IPV4_HDR_EXT (1ULL << 6) /**< RX packet with extended IPv4 header. */
93 #define PKT_RX_IPV6_HDR (1ULL << 7) /**< RX packet with IPv6 header. */
94 #define PKT_RX_IPV6_HDR_EXT (1ULL << 8) /**< RX packet with extended IPv6 header. */
95 #define PKT_RX_IEEE1588_PTP (1ULL << 9) /**< RX IEEE1588 L2 Ethernet PT Packet. */
96 #define PKT_RX_IEEE1588_TMST (1ULL << 10) /**< RX IEEE1588 L2/L4 timestamped packet.*/
97 #define PKT_RX_TUNNEL_IPV4_HDR (1ULL << 11) /**< RX tunnel packet with IPv4 header.*/
98 #define PKT_RX_TUNNEL_IPV6_HDR (1ULL << 12) /**< RX tunnel packet with IPv6 header. */
99 #define PKT_RX_FDIR_ID (1ULL << 13) /**< FD id reported if FDIR match. */
100 #define PKT_RX_FDIR_FLX (1ULL << 14) /**< Flexible bytes reported if FDIR match. */
101 /* add new RX flags here */
103 /* add new TX flags here */
104 #define PKT_TX_VXLAN_CKSUM (1ULL << 50) /**< TX checksum of VXLAN computed by NIC */
105 #define PKT_TX_IEEE1588_TMST (1ULL << 51) /**< TX IEEE1588 packet to timestamp. */
108 * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved,
109 * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware
110 * L4 checksum offload, the user needs to:
111 * - fill l2_len and l3_len in mbuf
112 * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM
113 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
114 * - calculate the pseudo header checksum and set it in the L4 header (only
115 * for TCP or UDP). See rte_ipv4_phdr_cksum() and rte_ipv6_phdr_cksum().
116 * For SCTP, set the crc field to 0.
118 #define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */
119 #define PKT_TX_TCP_CKSUM (1ULL << 52) /**< TCP cksum of TX pkt. computed by NIC. */
120 #define PKT_TX_SCTP_CKSUM (2ULL << 52) /**< SCTP cksum of TX pkt. computed by NIC. */
121 #define PKT_TX_UDP_CKSUM (3ULL << 52) /**< UDP cksum of TX pkt. computed by NIC. */
122 #define PKT_TX_L4_MASK (3ULL << 52) /**< Mask for L4 cksum offload request. */
124 #define PKT_TX_IP_CKSUM (1ULL << 54) /**< IP cksum of TX pkt. computed by NIC. */
125 #define PKT_TX_IPV4_CSUM PKT_TX_IP_CKSUM /**< Alias of PKT_TX_IP_CKSUM. */
127 /** Tell the NIC it's an IPv4 packet. Required for L4 checksum offload. */
128 #define PKT_TX_IPV4 PKT_RX_IPV4_HDR
130 /** Tell the NIC it's an IPv6 packet. Required for L4 checksum offload. */
131 #define PKT_TX_IPV6 PKT_RX_IPV6_HDR
133 #define PKT_TX_VLAN_PKT (1ULL << 55) /**< TX packet is a 802.1q VLAN packet. */
135 /* Use final bit of flags to indicate a control mbuf */
136 #define CTRL_MBUF_FLAG (1ULL << 63) /**< Mbuf contains control data */
139 * Get the name of a RX offload flag
142 * The mask describing the flag.
144 * The name of this flag, or NULL if it's not a valid RX flag.
146 const char *rte_get_rx_ol_flag_name(uint64_t mask);
149 * Get the name of a TX offload flag
152 * The mask describing the flag. Usually only one bit must be set.
153 * Several bits can be given if they belong to the same mask.
154 * Ex: PKT_TX_L4_MASK.
156 * The name of this flag, or NULL if it's not a valid TX flag.
158 const char *rte_get_tx_ol_flag_name(uint64_t mask);
160 /* define a set of marker types that can be used to refer to set points in the
162 typedef void *MARKER[0]; /**< generic marker for a point in a structure */
163 typedef uint64_t MARKER64[0]; /**< marker that allows us to overwrite 8 bytes
164 * with a single assignment */
166 * The generic rte_mbuf, containing a packet mbuf.
171 void *buf_addr; /**< Virtual address of segment buffer. */
172 phys_addr_t buf_physaddr; /**< Physical address of segment buffer. */
174 /* next 8 bytes are initialised on RX descriptor rearm */
176 uint16_t buf_len; /**< Length of segment buffer. */
180 * 16-bit Reference counter.
181 * It should only be accessed using the following functions:
182 * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
183 * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
184 * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
188 #ifdef RTE_MBUF_REFCNT
189 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
190 uint16_t refcnt; /**< Non-atomically accessed refcnt */
192 uint16_t refcnt_reserved; /**< Do not use this field */
194 uint8_t nb_segs; /**< Number of segments. */
195 uint8_t port; /**< Input port. */
197 uint64_t ol_flags; /**< Offload features. */
199 /* remaining bytes are set on RX when pulling packet from descriptor */
200 MARKER rx_descriptor_fields1;
203 * The packet type, which is used to indicate ordinary packet and also
204 * tunneled packet format, i.e. each number is represented a type of
207 uint16_t packet_type;
209 uint16_t data_len; /**< Amount of data in segment buffer. */
210 uint32_t pkt_len; /**< Total pkt len: sum of all segments. */
211 uint16_t vlan_tci; /**< VLAN Tag Control Identifier (CPU order) */
214 uint32_t rss; /**< RSS hash result if RSS enabled */
222 /**< Second 4 flexible bytes */
225 /**< First 4 flexible bytes or FD ID, dependent on
226 PKT_RX_FDIR_* flag in ol_flags. */
227 } fdir; /**< Filter identifier if FDIR enabled */
228 uint32_t sched; /**< Hierarchical scheduler */
229 uint32_t usr; /**< User defined tags. See @rte_distributor_process */
230 } hash; /**< hash information */
232 /* second cache line - fields only used in slow path or on TX */
233 MARKER cacheline1 __rte_cache_aligned;
236 void *userdata; /**< Can be used for external metadata */
237 uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */
240 struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
241 struct rte_mbuf *next; /**< Next segment of scattered packet. */
243 /* fields to support TX offloads */
245 uint16_t l2_l3_len; /**< combined l2/l3 lengths as single var */
247 uint16_t l3_len:9; /**< L3 (IP) Header Length. */
248 uint16_t l2_len:7; /**< L2 (MAC) Header Length. */
252 /* fields for TX offloading of tunnels */
254 uint16_t inner_l2_l3_len;
255 /**< combined inner l2/l3 lengths as single var */
257 uint16_t inner_l3_len:9;
258 /**< inner L3 (IP) Header Length. */
259 uint16_t inner_l2_len:7;
260 /**< inner L2 (MAC) Header Length. */
263 } __rte_cache_aligned;
266 * Given the buf_addr returns the pointer to corresponding mbuf.
268 #define RTE_MBUF_FROM_BADDR(ba) (((struct rte_mbuf *)(ba)) - 1)
271 * Given the pointer to mbuf returns an address where it's buf_addr
274 #define RTE_MBUF_TO_BADDR(mb) (((struct rte_mbuf *)(mb)) + 1)
277 * Returns TRUE if given mbuf is indirect, or FALSE otherwise.
279 #define RTE_MBUF_INDIRECT(mb) (RTE_MBUF_FROM_BADDR((mb)->buf_addr) != (mb))
282 * Returns TRUE if given mbuf is direct, or FALSE otherwise.
284 #define RTE_MBUF_DIRECT(mb) (RTE_MBUF_FROM_BADDR((mb)->buf_addr) == (mb))
288 * Private data in case of pktmbuf pool.
290 * A structure that contains some pktmbuf_pool-specific data that are
291 * appended after the mempool structure (in private data).
293 struct rte_pktmbuf_pool_private {
294 uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf.*/
297 #ifdef RTE_LIBRTE_MBUF_DEBUG
299 /** check mbuf type in debug mode */
300 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
302 /** check mbuf type in debug mode if mbuf pointer is not null */
303 #define __rte_mbuf_sanity_check_raw(m, is_h) do { \
305 rte_mbuf_sanity_check(m, is_h); \
308 /** MBUF asserts in debug mode */
309 #define RTE_MBUF_ASSERT(exp) \
311 rte_panic("line%d\tassert \"" #exp "\" failed\n", __LINE__); \
314 #else /* RTE_LIBRTE_MBUF_DEBUG */
316 /** check mbuf type in debug mode */
317 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
319 /** check mbuf type in debug mode if mbuf pointer is not null */
320 #define __rte_mbuf_sanity_check_raw(m, is_h) do { } while (0)
322 /** MBUF asserts in debug mode */
323 #define RTE_MBUF_ASSERT(exp) do { } while (0)
325 #endif /* RTE_LIBRTE_MBUF_DEBUG */
327 #ifdef RTE_MBUF_REFCNT
328 #ifdef RTE_MBUF_REFCNT_ATOMIC
331 * Adds given value to an mbuf's refcnt and returns its new value.
335 * Value to add/subtract
339 static inline uint16_t
340 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
342 return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
346 * Reads the value of an mbuf's refcnt.
350 * Reference count number.
352 static inline uint16_t
353 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
355 return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
359 * Sets an mbuf's refcnt to a defined value.
366 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
368 rte_atomic16_set(&m->refcnt_atomic, new_value);
371 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
374 * Adds given value to an mbuf's refcnt and returns its new value.
376 static inline uint16_t
377 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
379 m->refcnt = (uint16_t)(m->refcnt + value);
384 * Reads the value of an mbuf's refcnt.
386 static inline uint16_t
387 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
393 * Sets an mbuf's refcnt to the defined value.
396 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
398 m->refcnt = new_value;
401 #endif /* RTE_MBUF_REFCNT_ATOMIC */
404 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { \
409 #else /* ! RTE_MBUF_REFCNT */
412 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { } while(0)
414 #define rte_mbuf_refcnt_set(m,v) do { } while(0)
416 #endif /* RTE_MBUF_REFCNT */
420 * Sanity checks on an mbuf.
422 * Check the consistency of the given mbuf. The function will cause a
423 * panic if corruption is detected.
426 * The mbuf to be checked.
428 * True if the mbuf is a packet header, false if it is a sub-segment
429 * of a packet (in this case, some fields like nb_segs are not checked)
432 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
435 * @internal Allocate a new mbuf from mempool *mp*.
436 * The use of that function is reserved for RTE internal needs.
437 * Please use rte_pktmbuf_alloc().
440 * The mempool from which mbuf is allocated.
442 * - The pointer to the new mbuf on success.
443 * - NULL if allocation failed.
445 static inline struct rte_mbuf *__rte_mbuf_raw_alloc(struct rte_mempool *mp)
449 if (rte_mempool_get(mp, &mb) < 0)
451 m = (struct rte_mbuf *)mb;
452 #ifdef RTE_MBUF_REFCNT
453 RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
454 rte_mbuf_refcnt_set(m, 1);
455 #endif /* RTE_MBUF_REFCNT */
460 * @internal Put mbuf back into its original mempool.
461 * The use of that function is reserved for RTE internal needs.
462 * Please use rte_pktmbuf_free().
465 * The mbuf to be freed.
467 static inline void __attribute__((always_inline))
468 __rte_mbuf_raw_free(struct rte_mbuf *m)
470 #ifdef RTE_MBUF_REFCNT
471 RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
472 #endif /* RTE_MBUF_REFCNT */
473 rte_mempool_put(m->pool, m);
476 /* Operations on ctrl mbuf */
479 * The control mbuf constructor.
481 * This function initializes some fields in an mbuf structure that are
482 * not modified by the user once created (mbuf type, origin pool, buffer
483 * start address, and so on). This function is given as a callback function
484 * to rte_mempool_create() at pool creation time.
487 * The mempool from which the mbuf is allocated.
489 * A pointer that can be used by the user to retrieve useful information
490 * for mbuf initialization. This pointer comes from the ``init_arg``
491 * parameter of rte_mempool_create().
493 * The mbuf to initialize.
495 * The index of the mbuf in the pool table.
497 void rte_ctrlmbuf_init(struct rte_mempool *mp, void *opaque_arg,
498 void *m, unsigned i);
501 * Allocate a new mbuf (type is ctrl) from mempool *mp*.
503 * This new mbuf is initialized with data pointing to the beginning of
504 * buffer, and with a length of zero.
507 * The mempool from which the mbuf is allocated.
509 * - The pointer to the new mbuf on success.
510 * - NULL if allocation failed.
512 #define rte_ctrlmbuf_alloc(mp) rte_pktmbuf_alloc(mp)
515 * Free a control mbuf back into its original mempool.
518 * The control mbuf to be freed.
520 #define rte_ctrlmbuf_free(m) rte_pktmbuf_free(m)
523 * A macro that returns the pointer to the carried data.
525 * The value that can be read or assigned.
530 #define rte_ctrlmbuf_data(m) ((char *)((m)->buf_addr) + (m)->data_off)
533 * A macro that returns the length of the carried data.
535 * The value that can be read or assigned.
540 #define rte_ctrlmbuf_len(m) rte_pktmbuf_data_len(m)
543 * Tests if an mbuf is a control mbuf
546 * The mbuf to be tested
548 * - True (1) if the mbuf is a control mbuf
549 * - False(0) otherwise
552 rte_is_ctrlmbuf(struct rte_mbuf *m)
554 return (!!(m->ol_flags & CTRL_MBUF_FLAG));
557 /* Operations on pkt mbuf */
560 * The packet mbuf constructor.
562 * This function initializes some fields in the mbuf structure that are
563 * not modified by the user once created (origin pool, buffer start
564 * address, and so on). This function is given as a callback function to
565 * rte_mempool_create() at pool creation time.
568 * The mempool from which mbufs originate.
570 * A pointer that can be used by the user to retrieve useful information
571 * for mbuf initialization. This pointer comes from the ``init_arg``
572 * parameter of rte_mempool_create().
574 * The mbuf to initialize.
576 * The index of the mbuf in the pool table.
578 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
579 void *m, unsigned i);
583 * A packet mbuf pool constructor.
585 * This function initializes the mempool private data in the case of a
586 * pktmbuf pool. This private data is needed by the driver. The
587 * function is given as a callback function to rte_mempool_create() at
588 * pool creation. It can be extended by the user, for example, to
589 * provide another packet size.
592 * The mempool from which mbufs originate.
594 * A pointer that can be used by the user to retrieve useful information
595 * for mbuf initialization. This pointer comes from the ``init_arg``
596 * parameter of rte_mempool_create().
598 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
601 * Reset the fields of a packet mbuf to their default values.
603 * The given mbuf must have only one segment.
606 * The packet mbuf to be resetted.
608 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
613 m->inner_l2_l3_len = 0;
620 m->data_off = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
621 RTE_PKTMBUF_HEADROOM : m->buf_len;
624 __rte_mbuf_sanity_check(m, 1);
628 * Allocate a new mbuf from a mempool.
630 * This new mbuf contains one segment, which has a length of 0. The pointer
631 * to data is initialized to have some bytes of headroom in the buffer
632 * (if buffer size allows).
635 * The mempool from which the mbuf is allocated.
637 * - The pointer to the new mbuf on success.
638 * - NULL if allocation failed.
640 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
643 if ((m = __rte_mbuf_raw_alloc(mp)) != NULL)
644 rte_pktmbuf_reset(m);
648 #ifdef RTE_MBUF_REFCNT
651 * Attach packet mbuf to another packet mbuf.
652 * After attachment we refer the mbuf we attached as 'indirect',
653 * while mbuf we attached to as 'direct'.
654 * Right now, not supported:
655 * - attachment to indirect mbuf (e.g. - md has to be direct).
656 * - attachment for already indirect mbuf (e.g. - mi has to be direct).
657 * - mbuf we trying to attach (mi) is used by someone else
658 * e.g. it's reference counter is greater then 1.
661 * The indirect packet mbuf.
663 * The direct packet mbuf.
666 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *md)
668 RTE_MBUF_ASSERT(RTE_MBUF_DIRECT(md) &&
669 RTE_MBUF_DIRECT(mi) &&
670 rte_mbuf_refcnt_read(mi) == 1);
672 rte_mbuf_refcnt_update(md, 1);
673 mi->buf_physaddr = md->buf_physaddr;
674 mi->buf_addr = md->buf_addr;
675 mi->buf_len = md->buf_len;
678 mi->data_off = md->data_off;
679 mi->data_len = md->data_len;
681 mi->vlan_tci = md->vlan_tci;
682 mi->l2_l3_len = md->l2_l3_len;
683 mi->inner_l2_l3_len = md->inner_l2_l3_len;
687 mi->pkt_len = mi->data_len;
689 mi->ol_flags = md->ol_flags;
690 mi->packet_type = md->packet_type;
692 __rte_mbuf_sanity_check(mi, 1);
693 __rte_mbuf_sanity_check(md, 0);
697 * Detach an indirect packet mbuf -
698 * - restore original mbuf address and length values.
699 * - reset pktmbuf data and data_len to their default values.
700 * All other fields of the given packet mbuf will be left intact.
703 * The indirect attached packet mbuf.
706 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
708 const struct rte_mempool *mp = m->pool;
709 void *buf = RTE_MBUF_TO_BADDR(m);
710 uint32_t buf_len = mp->elt_size - sizeof(*m);
711 m->buf_physaddr = rte_mempool_virt2phy(mp, m) + sizeof (*m);
714 m->buf_len = (uint16_t)buf_len;
716 m->data_off = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
717 RTE_PKTMBUF_HEADROOM : m->buf_len;
722 #endif /* RTE_MBUF_REFCNT */
725 static inline struct rte_mbuf* __attribute__((always_inline))
726 __rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
728 __rte_mbuf_sanity_check(m, 0);
730 #ifdef RTE_MBUF_REFCNT
731 if (likely (rte_mbuf_refcnt_read(m) == 1) ||
732 likely (rte_mbuf_refcnt_update(m, -1) == 0)) {
733 struct rte_mbuf *md = RTE_MBUF_FROM_BADDR(m->buf_addr);
735 rte_mbuf_refcnt_set(m, 0);
737 /* if this is an indirect mbuf, then
739 * - free attached mbuf segment
741 if (unlikely (md != m)) {
742 rte_pktmbuf_detach(m);
743 if (rte_mbuf_refcnt_update(md, -1) == 0)
744 __rte_mbuf_raw_free(md);
748 #ifdef RTE_MBUF_REFCNT
755 * Free a segment of a packet mbuf into its original mempool.
757 * Free an mbuf, without parsing other segments in case of chained
761 * The packet mbuf segment to be freed.
763 static inline void __attribute__((always_inline))
764 rte_pktmbuf_free_seg(struct rte_mbuf *m)
766 if (likely(NULL != (m = __rte_pktmbuf_prefree_seg(m)))) {
768 __rte_mbuf_raw_free(m);
773 * Free a packet mbuf back into its original mempool.
775 * Free an mbuf, and all its segments in case of chained buffers. Each
776 * segment is added back into its original mempool.
779 * The packet mbuf to be freed.
781 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
783 struct rte_mbuf *m_next;
785 __rte_mbuf_sanity_check(m, 1);
789 rte_pktmbuf_free_seg(m);
794 #ifdef RTE_MBUF_REFCNT
797 * Creates a "clone" of the given packet mbuf.
799 * Walks through all segments of the given packet mbuf, and for each of them:
800 * - Creates a new packet mbuf from the given pool.
801 * - Attaches newly created mbuf to the segment.
802 * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
803 * from the original packet mbuf.
806 * The packet mbuf to be cloned.
808 * The mempool from which the "clone" mbufs are allocated.
810 * - The pointer to the new "clone" mbuf on success.
811 * - NULL if allocation fails.
813 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
814 struct rte_mempool *mp)
816 struct rte_mbuf *mc, *mi, **prev;
820 if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
825 pktlen = md->pkt_len;
830 rte_pktmbuf_attach(mi, md);
833 } while ((md = md->next) != NULL &&
834 (mi = rte_pktmbuf_alloc(mp)) != NULL);
838 mc->pkt_len = pktlen;
840 /* Allocation of new indirect segment failed */
841 if (unlikely (mi == NULL)) {
842 rte_pktmbuf_free(mc);
846 __rte_mbuf_sanity_check(mc, 1);
851 * Adds given value to the refcnt of all packet mbuf segments.
853 * Walks through all segments of given packet mbuf and for each of them
854 * invokes rte_mbuf_refcnt_update().
857 * The packet mbuf whose refcnt to be updated.
859 * The value to add to the mbuf's segments refcnt.
861 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
863 __rte_mbuf_sanity_check(m, 1);
866 rte_mbuf_refcnt_update(m, v);
867 } while ((m = m->next) != NULL);
870 #endif /* RTE_MBUF_REFCNT */
873 * Get the headroom in a packet mbuf.
878 * The length of the headroom.
880 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
882 __rte_mbuf_sanity_check(m, 1);
887 * Get the tailroom of a packet mbuf.
892 * The length of the tailroom.
894 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
896 __rte_mbuf_sanity_check(m, 1);
897 return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
902 * Get the last segment of the packet.
907 * The last segment of the given mbuf.
909 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
911 struct rte_mbuf *m2 = (struct rte_mbuf *)m;
913 __rte_mbuf_sanity_check(m, 1);
914 while (m2->next != NULL)
920 * A macro that points to the start of the data in the mbuf.
922 * The returned pointer is cast to type t. Before using this
923 * function, the user must ensure that m_headlen(m) is large enough to
929 * The type to cast the result into.
931 #define rte_pktmbuf_mtod(m, t) ((t)((char *)(m)->buf_addr + (m)->data_off))
934 * A macro that returns the length of the packet.
936 * The value can be read or assigned.
941 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
944 * A macro that returns the length of the segment.
946 * The value can be read or assigned.
951 #define rte_pktmbuf_data_len(m) ((m)->data_len)
954 * Prepend len bytes to an mbuf data area.
956 * Returns a pointer to the new
957 * data start address. If there is not enough headroom in the first
958 * segment, the function will return NULL, without modifying the mbuf.
963 * The amount of data to prepend (in bytes).
965 * A pointer to the start of the newly prepended data, or
966 * NULL if there is not enough headroom space in the first segment
968 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
971 __rte_mbuf_sanity_check(m, 1);
973 if (unlikely(len > rte_pktmbuf_headroom(m)))
977 m->data_len = (uint16_t)(m->data_len + len);
978 m->pkt_len = (m->pkt_len + len);
980 return (char *)m->buf_addr + m->data_off;
984 * Append len bytes to an mbuf.
986 * Append len bytes to an mbuf and return a pointer to the start address
987 * of the added data. If there is not enough tailroom in the last
988 * segment, the function will return NULL, without modifying the mbuf.
993 * The amount of data to append (in bytes).
995 * A pointer to the start of the newly appended data, or
996 * NULL if there is not enough tailroom space in the last segment
998 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
1001 struct rte_mbuf *m_last;
1003 __rte_mbuf_sanity_check(m, 1);
1005 m_last = rte_pktmbuf_lastseg(m);
1006 if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
1009 tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
1010 m_last->data_len = (uint16_t)(m_last->data_len + len);
1011 m->pkt_len = (m->pkt_len + len);
1012 return (char*) tail;
1016 * Remove len bytes at the beginning of an mbuf.
1018 * Returns a pointer to the start address of the new data area. If the
1019 * length is greater than the length of the first segment, then the
1020 * function will fail and return NULL, without modifying the mbuf.
1025 * The amount of data to remove (in bytes).
1027 * A pointer to the new start of the data.
1029 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
1031 __rte_mbuf_sanity_check(m, 1);
1033 if (unlikely(len > m->data_len))
1036 m->data_len = (uint16_t)(m->data_len - len);
1038 m->pkt_len = (m->pkt_len - len);
1039 return (char *)m->buf_addr + m->data_off;
1043 * Remove len bytes of data at the end of the mbuf.
1045 * If the length is greater than the length of the last segment, the
1046 * function will fail and return -1 without modifying the mbuf.
1051 * The amount of data to remove (in bytes).
1056 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
1058 struct rte_mbuf *m_last;
1060 __rte_mbuf_sanity_check(m, 1);
1062 m_last = rte_pktmbuf_lastseg(m);
1063 if (unlikely(len > m_last->data_len))
1066 m_last->data_len = (uint16_t)(m_last->data_len - len);
1067 m->pkt_len = (m->pkt_len - len);
1072 * Test if mbuf data is contiguous.
1077 * - 1, if all data is contiguous (one segment).
1078 * - 0, if there is several segments.
1080 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
1082 __rte_mbuf_sanity_check(m, 1);
1083 return !!(m->nb_segs == 1);
1087 * Dump an mbuf structure to the console.
1089 * Dump all fields for the given packet mbuf and all its associated
1090 * segments (in the case of a chained buffer).
1093 * A pointer to a file for output
1097 * If dump_len != 0, also dump the "dump_len" first data bytes of
1100 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
1106 #endif /* _RTE_MBUF_H_ */