4 * Copyright(c) 2010-2013 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.
42 * The mbuf library provides the ability to create and destroy buffers
43 * that may be used by the RTE application to store message
44 * buffers. The message buffers are stored in a mempool, using the
45 * RTE mempool library.
47 * This library provide an API to allocate/free mbufs, manipulate
48 * control message buffer (ctrlmbuf), which are generic message
49 * buffers, and packet buffers (pktmbuf), which are used to carry
52 * To understand the concepts of packet buffers or mbufs, you
53 * should read "TCP/IP Illustrated, Volume 2: The Implementation,
54 * Addison-Wesley, 1995, ISBN 0-201-63354-X from Richard Stevens"
55 * http://www.kohala.com/start/tcpipiv2.html
57 * The main modification of this implementation is the use of mbuf for
58 * transports other than packets. mbufs can have other types.
62 #include <rte_mempool.h>
63 #include <rte_atomic.h>
64 #include <rte_prefetch.h>
65 #include <rte_branch_prediction.h>
72 * A control message buffer.
75 void *data; /**< Pointer to data. */
76 uint32_t data_len; /**< Length of data. */
81 * Packet Offload Features Flags. It also carry packet type information.
82 * Critical resources. Both rx/tx shared these bits. Be cautious on any change
84 #define PKT_RX_VLAN_PKT 0x0001 /**< RX packet is a 802.1q VLAN packet. */
85 #define PKT_RX_RSS_HASH 0x0002 /**< RX packet with RSS hash result. */
86 #define PKT_RX_FDIR 0x0004 /**< RX packet with FDIR infos. */
87 #define PKT_RX_L4_CKSUM_BAD 0x0008 /**< L4 cksum of RX pkt. is not OK. */
88 #define PKT_RX_IP_CKSUM_BAD 0x0010 /**< IP cksum of RX pkt. is not OK. */
89 #define PKT_RX_IPV4_HDR 0x0020 /**< RX packet with IPv4 header. */
90 #define PKT_RX_IPV4_HDR_EXT 0x0040 /**< RX packet with extended IPv4 header. */
91 #define PKT_RX_IPV6_HDR 0x0080 /**< RX packet with IPv6 header. */
92 #define PKT_RX_IPV6_HDR_EXT 0x0100 /**< RX packet with extended IPv6 header. */
93 #define PKT_RX_IEEE1588_PTP 0x0200 /**< RX IEEE1588 L2 Ethernet PT Packet. */
94 #define PKT_RX_IEEE1588_TMST 0x0400 /**< RX IEEE1588 L2/L4 timestamped packet.*/
96 #define PKT_TX_VLAN_PKT 0x0800 /**< TX packet is a 802.1q VLAN packet. */
97 #define PKT_TX_IP_CKSUM 0x1000 /**< IP cksum of TX pkt. computed by NIC. */
99 * Bit 14~13 used for L4 packet type with checksum enabled.
105 #define PKT_TX_L4_MASK 0x6000 /**< Mask bits for L4 checksum offload request. */
106 #define PKT_TX_L4_NO_CKSUM 0x0000 /**< Disable L4 cksum of TX pkt. */
107 #define PKT_TX_TCP_CKSUM 0x2000 /**< TCP cksum of TX pkt. computed by NIC. */
108 #define PKT_TX_SCTP_CKSUM 0x4000 /**< SCTP cksum of TX pkt. computed by NIC. */
109 #define PKT_TX_UDP_CKSUM 0x6000 /**< UDP cksum of TX pkt. computed by NIC. */
111 #define PKT_TX_IEEE1588_TMST 0x8000 /**< TX IEEE1588 packet to timestamp. */
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 /** Offload features */
119 union rte_vlan_macip {
122 uint16_t l3_len:9; /**< L3 (IP) Header Length. */
123 uint16_t l2_len:7; /**< L2 (MAC) Header Length. */
125 /**< VLAN Tag Control Identifier (CPU order). */
130 * Compare mask for vlan_macip_len.data,
131 * should be in sync with rte_vlan_macip.f layout.
133 #define TX_VLAN_CMP_MASK 0xFFFF0000 /**< VLAN length - 16-bits. */
134 #define TX_MAC_LEN_CMP_MASK 0x0000FE00 /**< MAC length - 7-bits. */
135 #define TX_IP_LEN_CMP_MASK 0x000001FF /**< IP length - 9-bits. */
136 /**< MAC+IP length. */
137 #define TX_MACIP_LEN_CMP_MASK (TX_MAC_LEN_CMP_MASK | TX_IP_LEN_CMP_MASK)
140 * A packet message buffer.
143 /* valid for any segment */
144 struct rte_mbuf *next; /**< Next segment of scattered packet. */
145 void* data; /**< Start address of data in segment buffer. */
146 uint16_t data_len; /**< Amount of data in segment buffer. */
148 /* these fields are valid for first segment only */
149 uint8_t nb_segs; /**< Number of segments. */
150 uint8_t in_port; /**< Input port. */
151 uint32_t pkt_len; /**< Total pkt len: sum of all segment data_len. */
153 /* offload features */
154 union rte_vlan_macip vlan_macip;
156 uint32_t rss; /**< RSS hash result if RSS enabled */
160 } fdir; /**< Filter identifier if FDIR enabled */
161 uint32_t sched; /**< Hierarchical scheduler */
162 } hash; /**< hash information */
166 * This enum indicates the mbuf type.
169 RTE_MBUF_CTRL, /**< Control mbuf. */
170 RTE_MBUF_PKT, /**< Packet mbuf. */
174 * The generic rte_mbuf, containing a packet mbuf or a control mbuf.
177 struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
178 void *buf_addr; /**< Virtual address of segment buffer. */
179 phys_addr_t buf_physaddr; /**< Physical address of segment buffer. */
180 uint16_t buf_len; /**< Length of segment buffer. */
181 #ifdef RTE_MBUF_SCATTER_GATHER
183 * 16-bit Reference counter.
184 * It should only be accessed using the following functions:
185 * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
186 * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
187 * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
191 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
192 uint16_t refcnt; /**< Non-atomically accessed refcnt */
195 uint16_t refcnt_reserved; /**< Do not use this field */
197 uint8_t type; /**< Type of mbuf. */
198 uint8_t reserved; /**< Unused field. Required for padding. */
199 uint16_t ol_flags; /**< Offload features. */
202 struct rte_ctrlmbuf ctrl;
203 struct rte_pktmbuf pkt;
205 } __rte_cache_aligned;
208 * Given the buf_addr returns the pointer to corresponding mbuf.
210 #define RTE_MBUF_FROM_BADDR(ba) (((struct rte_mbuf *)(ba)) - 1)
213 * Given the pointer to mbuf returns an address where it's buf_addr
216 #define RTE_MBUF_TO_BADDR(mb) (((struct rte_mbuf *)(mb)) + 1)
219 * Returns TRUE if given mbuf is indirect, or FALSE otherwise.
221 #define RTE_MBUF_INDIRECT(mb) (RTE_MBUF_FROM_BADDR((mb)->buf_addr) != (mb))
224 * Returns TRUE if given mbuf is direct, or FALSE otherwise.
226 #define RTE_MBUF_DIRECT(mb) (RTE_MBUF_FROM_BADDR((mb)->buf_addr) == (mb))
230 * Private data in case of pktmbuf pool.
232 * A structure that contains some pktmbuf_pool-specific data that are
233 * appended after the mempool structure (in private data).
235 struct rte_pktmbuf_pool_private {
236 uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf.*/
239 #ifdef RTE_LIBRTE_MBUF_DEBUG
241 /** check mbuf type in debug mode */
242 #define __rte_mbuf_sanity_check(m, t, is_h) rte_mbuf_sanity_check(m, t, is_h)
244 /** check mbuf type in debug mode if mbuf pointer is not null */
245 #define __rte_mbuf_sanity_check_raw(m, t, is_h) do { \
247 rte_mbuf_sanity_check(m, t, is_h); \
250 /** MBUF asserts in debug mode */
251 #define RTE_MBUF_ASSERT(exp) \
253 rte_panic("line%d\tassert \"" #exp "\" failed\n", __LINE__); \
256 #else /* RTE_LIBRTE_MBUF_DEBUG */
258 /** check mbuf type in debug mode */
259 #define __rte_mbuf_sanity_check(m, t, is_h) do { } while(0)
261 /** check mbuf type in debug mode if mbuf pointer is not null */
262 #define __rte_mbuf_sanity_check_raw(m, t, is_h) do { } while(0)
264 /** MBUF asserts in debug mode */
265 #define RTE_MBUF_ASSERT(exp) do { } while(0)
267 #endif /* RTE_LIBRTE_MBUF_DEBUG */
269 #ifdef RTE_MBUF_SCATTER_GATHER
270 #ifdef RTE_MBUF_REFCNT_ATOMIC
273 * Adds given value to an mbuf's refcnt and returns its new value.
277 * Value to add/subtract
281 static inline uint16_t
282 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
284 return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
288 * Reads the value of an mbuf's refcnt.
292 * Reference count number.
294 static inline uint16_t
295 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
297 return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
301 * Sets an mbuf's refcnt to a defined value.
308 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
310 rte_atomic16_set(&m->refcnt_atomic, new_value);
313 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
316 * Adds given value to an mbuf's refcnt and returns its new value.
318 static inline uint16_t
319 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
321 m->refcnt = (uint16_t)(m->refcnt + value);
326 * Reads the value of an mbuf's refcnt.
328 static inline uint16_t
329 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
335 * Sets an mbuf's refcnt to the defined value.
338 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
340 m->refcnt = new_value;
343 #endif /* RTE_MBUF_REFCNT_ATOMIC */
346 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { \
351 #else /* ! RTE_MBUF_SCATTER_GATHER */
354 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { } while(0)
356 #define rte_mbuf_refcnt_set(m,v) do { } while(0)
358 #endif /* RTE_MBUF_SCATTER_GATHER */
362 * Sanity checks on an mbuf.
364 * Check the consistency of the given mbuf. The function will cause a
365 * panic if corruption is detected.
368 * The mbuf to be checked.
370 * The expected type of the mbuf.
372 * True if the mbuf is a packet header, false if it is a sub-segment
373 * of a packet (in this case, some fields like nb_segs are not checked)
376 rte_mbuf_sanity_check(const struct rte_mbuf *m, enum rte_mbuf_type t,
380 * @internal Allocate a new mbuf from mempool *mp*.
381 * The use of that function is reserved for RTE internal needs.
382 * Please use either rte_ctrlmbuf_alloc() or rte_pktmbuf_alloc().
385 * The mempool from which mbuf is allocated.
387 * - The pointer to the new mbuf on success.
388 * - NULL if allocation failed.
390 static inline struct rte_mbuf *__rte_mbuf_raw_alloc(struct rte_mempool *mp)
394 if (rte_mempool_get(mp, &mb) < 0)
396 m = (struct rte_mbuf *)mb;
397 #ifdef RTE_MBUF_SCATTER_GATHER
398 RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
399 rte_mbuf_refcnt_set(m, 1);
400 #endif /* RTE_MBUF_SCATTER_GATHER */
405 * @internal Put mbuf back into its original mempool.
406 * The use of that function is reserved for RTE internal needs.
407 * Please use either rte_ctrlmbuf_free() or rte_pktmbuf_free().
410 * The mbuf to be freed.
412 static inline void __rte_mbuf_raw_free(struct rte_mbuf *m)
414 #ifdef RTE_MBUF_SCATTER_GATHER
415 RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
416 #endif /* RTE_MBUF_SCATTER_GATHER */
417 rte_mempool_put(m->pool, m);
420 /* Operations on ctrl mbuf */
423 * The control mbuf constructor.
425 * This function initializes some fields in an mbuf structure that are
426 * not modified by the user once created (mbuf type, origin pool, buffer
427 * start address, and so on). This function is given as a callback function
428 * to rte_mempool_create() at pool creation time.
431 * The mempool from which the mbuf is allocated.
433 * A pointer that can be used by the user to retrieve useful information
434 * for mbuf initialization. This pointer comes from the ``init_arg``
435 * parameter of rte_mempool_create().
437 * The mbuf to initialize.
439 * The index of the mbuf in the pool table.
441 void rte_ctrlmbuf_init(struct rte_mempool *mp, void *opaque_arg,
442 void *m, unsigned i);
445 * Allocate a new mbuf (type is ctrl) from mempool *mp*.
447 * This new mbuf is initialized with data pointing to the beginning of
448 * buffer, and with a length of zero.
451 * The mempool from which the mbuf is allocated.
453 * - The pointer to the new mbuf on success.
454 * - NULL if allocation failed.
456 static inline struct rte_mbuf *rte_ctrlmbuf_alloc(struct rte_mempool *mp)
459 if ((m = __rte_mbuf_raw_alloc(mp)) != NULL) {
460 m->ctrl.data = m->buf_addr;
461 m->ctrl.data_len = 0;
462 __rte_mbuf_sanity_check(m, RTE_MBUF_CTRL, 0);
468 * Free a control mbuf back into its original mempool.
471 * The control mbuf to be freed.
473 static inline void rte_ctrlmbuf_free(struct rte_mbuf *m)
475 __rte_mbuf_sanity_check(m, RTE_MBUF_CTRL, 0);
476 #ifdef RTE_MBUF_SCATTER_GATHER
477 if (rte_mbuf_refcnt_update(m, -1) == 0)
478 #endif /* RTE_MBUF_SCATTER_GATHER */
479 __rte_mbuf_raw_free(m);
483 * A macro that returns the pointer to the carried data.
485 * The value that can be read or assigned.
490 #define rte_ctrlmbuf_data(m) ((m)->ctrl.data)
493 * A macro that returns the length of the carried data.
495 * The value that can be read or assigned.
500 #define rte_ctrlmbuf_len(m) ((m)->ctrl.data_len)
502 /* Operations on pkt mbuf */
505 * The packet mbuf constructor.
507 * This function initializes some fields in the mbuf structure that are not
508 * modified by the user once created (mbuf type, origin pool, buffer start
509 * address, and so on). This function is given as a callback function to
510 * rte_mempool_create() at pool creation time.
513 * The mempool from which mbufs originate.
515 * A pointer that can be used by the user to retrieve useful information
516 * for mbuf initialization. This pointer comes from the ``init_arg``
517 * parameter of rte_mempool_create().
519 * The mbuf to initialize.
521 * The index of the mbuf in the pool table.
523 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
524 void *m, unsigned i);
528 * A packet mbuf pool constructor.
530 * This function initializes the mempool private data in the case of a
531 * pktmbuf pool. This private data is needed by the driver. The
532 * function is given as a callback function to rte_mempool_create() at
533 * pool creation. It can be extended by the user, for example, to
534 * provide another packet size.
537 * The mempool from which mbufs originate.
539 * A pointer that can be used by the user to retrieve useful information
540 * for mbuf initialization. This pointer comes from the ``init_arg``
541 * parameter of rte_mempool_create().
543 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
546 * Reset the fields of a packet mbuf to their default values.
548 * The given mbuf must have only one segment.
551 * The packet mbuf to be resetted.
553 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
559 m->pkt.vlan_macip.data = 0;
561 m->pkt.in_port = 0xff;
564 buf_ofs = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
565 RTE_PKTMBUF_HEADROOM : m->buf_len;
566 m->pkt.data = (char*) m->buf_addr + buf_ofs;
569 __rte_mbuf_sanity_check(m, RTE_MBUF_PKT, 1);
573 * Allocate a new mbuf (type is pkt) from a mempool.
575 * This new mbuf contains one segment, which has a length of 0. The pointer
576 * to data is initialized to have some bytes of headroom in the buffer
577 * (if buffer size allows).
580 * The mempool from which the mbuf is allocated.
582 * - The pointer to the new mbuf on success.
583 * - NULL if allocation failed.
585 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
588 if ((m = __rte_mbuf_raw_alloc(mp)) != NULL)
589 rte_pktmbuf_reset(m);
593 #ifdef RTE_MBUF_SCATTER_GATHER
596 * Attach packet mbuf to another packet mbuf.
597 * After attachment we refer the mbuf we attached as 'indirect',
598 * while mbuf we attached to as 'direct'.
599 * Right now, not supported:
600 * - attachment to indirect mbuf (e.g. - md has to be direct).
601 * - attachment for already indirect mbuf (e.g. - mi has to be direct).
602 * - mbuf we trying to attach (mi) is used by someone else
603 * e.g. it's reference counter is greater then 1.
606 * The indirect packet mbuf.
608 * The direct packet mbuf.
611 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *md)
613 RTE_MBUF_ASSERT(RTE_MBUF_DIRECT(md) &&
614 RTE_MBUF_DIRECT(mi) &&
615 rte_mbuf_refcnt_read(mi) == 1);
617 rte_mbuf_refcnt_update(md, 1);
618 mi->buf_physaddr = md->buf_physaddr;
619 mi->buf_addr = md->buf_addr;
620 mi->buf_len = md->buf_len;
625 mi->pkt.pkt_len = mi->pkt.data_len;
628 __rte_mbuf_sanity_check(mi, RTE_MBUF_PKT, 1);
629 __rte_mbuf_sanity_check(md, RTE_MBUF_PKT, 0);
633 * Detach an indirect packet mbuf -
634 * - restore original mbuf address and length values.
635 * - reset pktmbuf data and data_len to their default values.
636 * All other fields of the given packet mbuf will be left intact.
639 * The indirect attached packet mbuf.
642 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
644 const struct rte_mempool *mp = m->pool;
645 void *buf = RTE_MBUF_TO_BADDR(m);
647 uint32_t buf_len = mp->elt_size - sizeof(*m);
648 m->buf_physaddr = rte_mempool_virt2phy(mp, m) + sizeof (*m);
651 m->buf_len = (uint16_t)buf_len;
653 buf_ofs = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
654 RTE_PKTMBUF_HEADROOM : m->buf_len;
655 m->pkt.data = (char*) m->buf_addr + buf_ofs;
660 #endif /* RTE_MBUF_SCATTER_GATHER */
663 * Free a segment of a packet mbuf into its original mempool.
665 * Free an mbuf, without parsing other segments in case of chained
669 * The packet mbuf segment to be freed.
671 static inline void rte_pktmbuf_free_seg(struct rte_mbuf *m)
673 __rte_mbuf_sanity_check(m, RTE_MBUF_PKT, 0);
675 #ifdef RTE_MBUF_SCATTER_GATHER
676 if (likely (rte_mbuf_refcnt_read(m) == 1) ||
677 likely (rte_mbuf_refcnt_update(m, -1) == 0)) {
678 struct rte_mbuf *md = RTE_MBUF_FROM_BADDR(m->buf_addr);
680 rte_mbuf_refcnt_set(m, 0);
682 /* if this is an indirect mbuf, then
684 * - free attached mbuf segment
686 if (unlikely (md != m)) {
687 rte_pktmbuf_detach(m);
688 if (rte_mbuf_refcnt_update(md, -1) == 0)
689 __rte_mbuf_raw_free(md);
692 __rte_mbuf_raw_free(m);
693 #ifdef RTE_MBUF_SCATTER_GATHER
699 * Free a packet mbuf back into its original mempool.
701 * Free an mbuf, and all its segments in case of chained buffers. Each
702 * segment is added back into its original mempool.
705 * The packet mbuf to be freed.
707 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
709 struct rte_mbuf *m_next;
711 __rte_mbuf_sanity_check(m, RTE_MBUF_PKT, 1);
714 m_next = m->pkt.next;
715 rte_pktmbuf_free_seg(m);
720 #ifdef RTE_MBUF_SCATTER_GATHER
723 * Creates a "clone" of the given packet mbuf.
725 * Walks through all segments of the given packet mbuf, and for each of them:
726 * - Creates a new packet mbuf from the given pool.
727 * - Attaches newly created mbuf to the segment.
728 * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
729 * from the original packet mbuf.
732 * The packet mbuf to be cloned.
734 * The mempool from which the "clone" mbufs are allocated.
736 * - The pointer to the new "clone" mbuf on success.
737 * - NULL if allocation fails.
739 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
740 struct rte_mempool *mp)
742 struct rte_mbuf *mc, *mi, **prev;
746 if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
750 prev = &mi->pkt.next;
751 pktlen = md->pkt.pkt_len;
756 rte_pktmbuf_attach(mi, md);
758 prev = &mi->pkt.next;
759 } while ((md = md->pkt.next) != NULL &&
760 (mi = rte_pktmbuf_alloc(mp)) != NULL);
763 mc->pkt.nb_segs = nseg;
764 mc->pkt.pkt_len = pktlen;
766 /* Allocation of new indirect segment failed */
767 if (unlikely (mi == NULL)) {
768 rte_pktmbuf_free(mc);
772 __rte_mbuf_sanity_check(mc, RTE_MBUF_PKT, 1);
777 * Adds given value to the refcnt of all packet mbuf segments.
779 * Walks through all segments of given packet mbuf and for each of them
780 * invokes rte_mbuf_refcnt_update().
783 * The packet mbuf whose refcnt to be updated.
785 * The value to add to the mbuf's segments refcnt.
787 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
789 __rte_mbuf_sanity_check(m, RTE_MBUF_PKT, 1);
792 rte_mbuf_refcnt_update(m, v);
793 } while ((m = m->pkt.next) != NULL);
796 #endif /* RTE_MBUF_SCATTER_GATHER */
799 * Get the headroom in a packet mbuf.
804 * The length of the headroom.
806 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
808 __rte_mbuf_sanity_check(m, RTE_MBUF_PKT, 1);
809 return (uint16_t) ((char*) m->pkt.data - (char*) m->buf_addr);
813 * Get the tailroom of a packet mbuf.
818 * The length of the tailroom.
820 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
822 __rte_mbuf_sanity_check(m, RTE_MBUF_PKT, 1);
823 return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
828 * Get the last segment of the packet.
833 * The last segment of the given mbuf.
835 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
837 struct rte_mbuf *m2 = (struct rte_mbuf *)m;
839 __rte_mbuf_sanity_check(m, RTE_MBUF_PKT, 1);
840 while (m2->pkt.next != NULL)
846 * A macro that points to the start of the data in the mbuf.
848 * The returned pointer is cast to type t. Before using this
849 * function, the user must ensure that m_headlen(m) is large enough to
855 * The type to cast the result into.
857 #define rte_pktmbuf_mtod(m, t) ((t)((m)->pkt.data))
860 * A macro that returns the length of the packet.
862 * The value can be read or assigned.
867 #define rte_pktmbuf_pkt_len(m) ((m)->pkt.pkt_len)
870 * A macro that returns the length of the segment.
872 * The value can be read or assigned.
877 #define rte_pktmbuf_data_len(m) ((m)->pkt.data_len)
880 * Prepend len bytes to an mbuf data area.
882 * Returns a pointer to the new
883 * data start address. If there is not enough headroom in the first
884 * segment, the function will return NULL, without modifying the mbuf.
889 * The amount of data to prepend (in bytes).
891 * A pointer to the start of the newly prepended data, or
892 * NULL if there is not enough headroom space in the first segment
894 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
897 __rte_mbuf_sanity_check(m, RTE_MBUF_PKT, 1);
899 if (unlikely(len > rte_pktmbuf_headroom(m)))
902 m->pkt.data = (char*) m->pkt.data - len;
903 m->pkt.data_len = (uint16_t)(m->pkt.data_len + len);
904 m->pkt.pkt_len = (m->pkt.pkt_len + len);
906 return (char*) m->pkt.data;
910 * Append len bytes to an mbuf.
912 * Append len bytes to an mbuf and return a pointer to the start address
913 * of the added data. If there is not enough tailroom in the last
914 * segment, the function will return NULL, without modifying the mbuf.
919 * The amount of data to append (in bytes).
921 * A pointer to the start of the newly appended data, or
922 * NULL if there is not enough tailroom space in the last segment
924 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
927 struct rte_mbuf *m_last;
929 __rte_mbuf_sanity_check(m, RTE_MBUF_PKT, 1);
931 m_last = rte_pktmbuf_lastseg(m);
932 if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
935 tail = (char*) m_last->pkt.data + m_last->pkt.data_len;
936 m_last->pkt.data_len = (uint16_t)(m_last->pkt.data_len + len);
937 m->pkt.pkt_len = (m->pkt.pkt_len + len);
942 * Remove len bytes at the beginning of an mbuf.
944 * Returns a pointer to the start address of the new data area. If the
945 * length is greater than the length of the first segment, then the
946 * function will fail and return NULL, without modifying the mbuf.
951 * The amount of data to remove (in bytes).
953 * A pointer to the new start of the data.
955 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
957 __rte_mbuf_sanity_check(m, RTE_MBUF_PKT, 1);
959 if (unlikely(len > m->pkt.data_len))
962 m->pkt.data_len = (uint16_t)(m->pkt.data_len - len);
963 m->pkt.data = ((char*) m->pkt.data + len);
964 m->pkt.pkt_len = (m->pkt.pkt_len - len);
965 return (char*) m->pkt.data;
969 * Remove len bytes of data at the end of the mbuf.
971 * If the length is greater than the length of the last segment, the
972 * function will fail and return -1 without modifying the mbuf.
977 * The amount of data to remove (in bytes).
982 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
984 struct rte_mbuf *m_last;
986 __rte_mbuf_sanity_check(m, RTE_MBUF_PKT, 1);
988 m_last = rte_pktmbuf_lastseg(m);
989 if (unlikely(len > m_last->pkt.data_len))
992 m_last->pkt.data_len = (uint16_t)(m_last->pkt.data_len - len);
993 m->pkt.pkt_len = (m->pkt.pkt_len - len);
998 * Test if mbuf data is contiguous.
1003 * - 1, if all data is contiguous (one segment).
1004 * - 0, if there is several segments.
1006 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
1008 __rte_mbuf_sanity_check(m, RTE_MBUF_PKT, 1);
1009 return !!(m->pkt.nb_segs == 1);
1013 * Dump an mbuf structure to the console.
1015 * Dump all fields for the given packet mbuf and all its associated
1016 * segments (in the case of a chained buffer).
1021 * If dump_len != 0, also dump the "dump_len" first data bytes of
1024 void rte_pktmbuf_dump(const struct rte_mbuf *m, unsigned dump_len);
1030 #endif /* _RTE_MBUF_H_ */