4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5 * Copyright 2014 6WIND S.A.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * * Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
18 * * Neither the name of Intel Corporation nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * 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 packet mbufs, which are
48 * used to carry network packets.
50 * To understand the concepts of packet buffers or mbufs, you
51 * should read "TCP/IP Illustrated, Volume 2: The Implementation,
52 * Addison-Wesley, 1995, ISBN 0-201-63354-X from Richard Stevens"
53 * http://www.kohala.com/start/tcpipiv2.html
57 #include <rte_common.h>
58 #include <rte_mempool.h>
59 #include <rte_memory.h>
60 #include <rte_atomic.h>
61 #include <rte_prefetch.h>
62 #include <rte_branch_prediction.h>
68 /* deprecated options */
69 #pragma GCC poison RTE_MBUF_SCATTER_GATHER
70 #pragma GCC poison RTE_MBUF_REFCNT
73 * Packet Offload Features Flags. It also carry packet type information.
74 * Critical resources. Both rx/tx shared these bits. Be cautious on any change
76 * - RX flags start at bit position zero, and get added to the left of previous
78 * - The most-significant 8 bits are reserved for generic mbuf flags
79 * - TX flags therefore start at bit position 55 (i.e. 63-8), and new flags get
80 * added to the right of the previously defined flags
82 * Keep these flags synchronized with rte_get_rx_ol_flag_name() and
83 * rte_get_tx_ol_flag_name().
85 #define PKT_RX_VLAN_PKT (1ULL << 0) /**< RX packet is a 802.1q VLAN packet. */
86 #define PKT_RX_RSS_HASH (1ULL << 1) /**< RX packet with RSS hash result. */
87 #define PKT_RX_FDIR (1ULL << 2) /**< RX packet with FDIR match indicate. */
88 #define PKT_RX_L4_CKSUM_BAD (1ULL << 3) /**< L4 cksum of RX pkt. is not OK. */
89 #define PKT_RX_IP_CKSUM_BAD (1ULL << 4) /**< IP cksum of RX pkt. is not OK. */
90 #define PKT_RX_EIP_CKSUM_BAD (0ULL << 0) /**< External IP header checksum error. */
91 #define PKT_RX_OVERSIZE (0ULL << 0) /**< Num of desc of an RX pkt oversize. */
92 #define PKT_RX_HBUF_OVERFLOW (0ULL << 0) /**< Header buffer overflow. */
93 #define PKT_RX_RECIP_ERR (0ULL << 0) /**< Hardware processing error. */
94 #define PKT_RX_MAC_ERR (0ULL << 0) /**< MAC error. */
95 #define PKT_RX_IPV4_HDR (1ULL << 5) /**< RX packet with IPv4 header. */
96 #define PKT_RX_IPV4_HDR_EXT (1ULL << 6) /**< RX packet with extended IPv4 header. */
97 #define PKT_RX_IPV6_HDR (1ULL << 7) /**< RX packet with IPv6 header. */
98 #define PKT_RX_IPV6_HDR_EXT (1ULL << 8) /**< RX packet with extended IPv6 header. */
99 #define PKT_RX_IEEE1588_PTP (1ULL << 9) /**< RX IEEE1588 L2 Ethernet PT Packet. */
100 #define PKT_RX_IEEE1588_TMST (1ULL << 10) /**< RX IEEE1588 L2/L4 timestamped packet.*/
101 #define PKT_RX_TUNNEL_IPV4_HDR (1ULL << 11) /**< RX tunnel packet with IPv4 header.*/
102 #define PKT_RX_TUNNEL_IPV6_HDR (1ULL << 12) /**< RX tunnel packet with IPv6 header. */
103 #define PKT_RX_FDIR_ID (1ULL << 13) /**< FD id reported if FDIR match. */
104 #define PKT_RX_FDIR_FLX (1ULL << 14) /**< Flexible bytes reported if FDIR match. */
105 #define PKT_RX_QINQ_PKT (1ULL << 15) /**< RX packet with double VLAN stripped. */
106 /* add new RX flags here */
108 /* add new TX flags here */
111 * Second VLAN insertion (QinQ) flag.
113 #define PKT_TX_QINQ_PKT (1ULL << 49) /**< TX packet with double VLAN inserted. */
116 * TCP segmentation offload. To enable this offload feature for a
117 * packet to be transmitted on hardware supporting TSO:
118 * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies
120 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
121 * - if it's IPv4, set the PKT_TX_IP_CKSUM flag and write the IP checksum
123 * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz
124 * - calculate the pseudo header checksum without taking ip_len in account,
125 * and set it in the TCP header. Refer to rte_ipv4_phdr_cksum() and
126 * rte_ipv6_phdr_cksum() that can be used as helpers.
128 #define PKT_TX_TCP_SEG (1ULL << 50)
130 #define PKT_TX_IEEE1588_TMST (1ULL << 51) /**< TX IEEE1588 packet to timestamp. */
133 * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved,
134 * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware
135 * L4 checksum offload, the user needs to:
136 * - fill l2_len and l3_len in mbuf
137 * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM
138 * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
139 * - calculate the pseudo header checksum and set it in the L4 header (only
140 * for TCP or UDP). See rte_ipv4_phdr_cksum() and rte_ipv6_phdr_cksum().
141 * For SCTP, set the crc field to 0.
143 #define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */
144 #define PKT_TX_TCP_CKSUM (1ULL << 52) /**< TCP cksum of TX pkt. computed by NIC. */
145 #define PKT_TX_SCTP_CKSUM (2ULL << 52) /**< SCTP cksum of TX pkt. computed by NIC. */
146 #define PKT_TX_UDP_CKSUM (3ULL << 52) /**< UDP cksum of TX pkt. computed by NIC. */
147 #define PKT_TX_L4_MASK (3ULL << 52) /**< Mask for L4 cksum offload request. */
150 * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should
151 * also be set by the application, although a PMD will only check
153 * - set the IP checksum field in the packet to 0
154 * - fill the mbuf offload information: l2_len, l3_len
156 #define PKT_TX_IP_CKSUM (1ULL << 54)
159 * Packet is IPv4. This flag must be set when using any offload feature
160 * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4
161 * packet. If the packet is a tunneled packet, this flag is related to
164 #define PKT_TX_IPV4 (1ULL << 55)
167 * Packet is IPv6. This flag must be set when using an offload feature
168 * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6
169 * packet. If the packet is a tunneled packet, this flag is related to
172 #define PKT_TX_IPV6 (1ULL << 56)
174 #define PKT_TX_VLAN_PKT (1ULL << 57) /**< TX packet is a 802.1q VLAN packet. */
177 * Offload the IP checksum of an external header in the hardware. The
178 * flag PKT_TX_OUTER_IPV4 should also be set by the application, alto ugh
179 * a PMD will only check PKT_TX_IP_CKSUM. The IP checksum field in the
180 * packet must be set to 0.
181 * - set the outer IP checksum field in the packet to 0
182 * - fill the mbuf offload information: outer_l2_len, outer_l3_len
184 #define PKT_TX_OUTER_IP_CKSUM (1ULL << 58)
187 * Packet outer header is IPv4. This flag must be set when using any
188 * outer offload feature (L3 or L4 checksum) to tell the NIC that the
189 * outer header of the tunneled packet is an IPv4 packet.
191 #define PKT_TX_OUTER_IPV4 (1ULL << 59)
194 * Packet outer header is IPv6. This flag must be set when using any
195 * outer offload feature (L4 checksum) to tell the NIC that the outer
196 * header of the tunneled packet is an IPv6 packet.
198 #define PKT_TX_OUTER_IPV6 (1ULL << 60)
200 #define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */
202 /* Use final bit of flags to indicate a control mbuf */
203 #define CTRL_MBUF_FLAG (1ULL << 63) /**< Mbuf contains control data */
206 * Get the name of a RX offload flag
209 * The mask describing the flag.
211 * The name of this flag, or NULL if it's not a valid RX flag.
213 const char *rte_get_rx_ol_flag_name(uint64_t mask);
216 * Get the name of a TX offload flag
219 * The mask describing the flag. Usually only one bit must be set.
220 * Several bits can be given if they belong to the same mask.
221 * Ex: PKT_TX_L4_MASK.
223 * The name of this flag, or NULL if it's not a valid TX flag.
225 const char *rte_get_tx_ol_flag_name(uint64_t mask);
228 * Some NICs need at least 2KB buffer to RX standard Ethernet frame without
229 * splitting it into multiple segments.
230 * So, for mbufs that planned to be involved into RX/TX, the recommended
231 * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM.
233 #define RTE_MBUF_DEFAULT_DATAROOM 2048
234 #define RTE_MBUF_DEFAULT_BUF_SIZE \
235 (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM)
237 /* define a set of marker types that can be used to refer to set points in the
239 typedef void *MARKER[0]; /**< generic marker for a point in a structure */
240 typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */
241 typedef uint64_t MARKER64[0]; /**< marker that allows us to overwrite 8 bytes
242 * with a single assignment */
245 * The generic rte_mbuf, containing a packet mbuf.
250 void *buf_addr; /**< Virtual address of segment buffer. */
251 phys_addr_t buf_physaddr; /**< Physical address of segment buffer. */
253 uint16_t buf_len; /**< Length of segment buffer. */
255 /* next 6 bytes are initialised on RX descriptor rearm */
260 * 16-bit Reference counter.
261 * It should only be accessed using the following functions:
262 * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
263 * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
264 * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
268 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
269 uint16_t refcnt; /**< Non-atomically accessed refcnt */
271 uint8_t nb_segs; /**< Number of segments. */
272 uint8_t port; /**< Input port. */
274 uint64_t ol_flags; /**< Offload features. */
276 /* remaining bytes are set on RX when pulling packet from descriptor */
277 MARKER rx_descriptor_fields1;
280 * The packet type, which is used to indicate ordinary packet and also
281 * tunneled packet format, i.e. each number is represented a type of
284 uint16_t packet_type;
286 uint16_t data_len; /**< Amount of data in segment buffer. */
287 uint32_t pkt_len; /**< Total pkt len: sum of all segments. */
288 uint16_t vlan_tci; /**< VLAN Tag Control Identifier (CPU order) */
289 uint16_t vlan_tci_outer; /**< Outer VLAN Tag Control Identifier (CPU order) */
291 uint32_t rss; /**< RSS hash result if RSS enabled */
299 /**< Second 4 flexible bytes */
302 /**< First 4 flexible bytes or FD ID, dependent on
303 PKT_RX_FDIR_* flag in ol_flags. */
304 } fdir; /**< Filter identifier if FDIR enabled */
305 uint32_t sched; /**< Hierarchical scheduler */
306 uint32_t usr; /**< User defined tags. See rte_distributor_process() */
307 } hash; /**< hash information */
309 uint32_t seqn; /**< Sequence number. See also rte_reorder_insert() */
311 /* second cache line - fields only used in slow path or on TX */
312 MARKER cacheline1 __rte_cache_aligned;
315 void *userdata; /**< Can be used for external metadata */
316 uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */
319 struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
320 struct rte_mbuf *next; /**< Next segment of scattered packet. */
322 /* fields to support TX offloads */
324 uint64_t tx_offload; /**< combined for easy fetch */
326 uint64_t l2_len:7; /**< L2 (MAC) Header Length. */
327 uint64_t l3_len:9; /**< L3 (IP) Header Length. */
328 uint64_t l4_len:8; /**< L4 (TCP/UDP) Header Length. */
329 uint64_t tso_segsz:16; /**< TCP TSO segment size */
331 /* fields for TX offloading of tunnels */
332 uint64_t outer_l3_len:9; /**< Outer L3 (IP) Hdr Length. */
333 uint64_t outer_l2_len:7; /**< Outer L2 (MAC) Hdr Length. */
335 /* uint64_t unused:8; */
339 /** Size of the application private data. In case of an indirect
340 * mbuf, it stores the direct mbuf private data size. */
342 } __rte_cache_aligned;
344 static inline uint16_t rte_pktmbuf_priv_size(struct rte_mempool *mp);
347 * Return the mbuf owning the data buffer address of an indirect mbuf.
350 * The pointer to the indirect mbuf.
352 * The address of the direct mbuf corresponding to buffer_addr.
354 static inline struct rte_mbuf *
355 rte_mbuf_from_indirect(struct rte_mbuf *mi)
357 return RTE_PTR_SUB(mi->buf_addr, sizeof(*mi) + mi->priv_size);
361 * Return the buffer address embedded in the given mbuf.
364 * The pointer to the mbuf.
366 * The address of the data buffer owned by the mbuf.
369 rte_mbuf_to_baddr(struct rte_mbuf *md)
372 buffer_addr = (char *)md + sizeof(*md) + rte_pktmbuf_priv_size(md->pool);
377 * Returns TRUE if given mbuf is indirect, or FALSE otherwise.
379 #define RTE_MBUF_INDIRECT(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF)
382 * Returns TRUE if given mbuf is direct, or FALSE otherwise.
384 #define RTE_MBUF_DIRECT(mb) (!RTE_MBUF_INDIRECT(mb))
387 * Private data in case of pktmbuf pool.
389 * A structure that contains some pktmbuf_pool-specific data that are
390 * appended after the mempool structure (in private data).
392 struct rte_pktmbuf_pool_private {
393 uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf. */
394 uint16_t mbuf_priv_size; /**< Size of private area in each mbuf. */
397 #ifdef RTE_LIBRTE_MBUF_DEBUG
399 /** check mbuf type in debug mode */
400 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
402 /** check mbuf type in debug mode if mbuf pointer is not null */
403 #define __rte_mbuf_sanity_check_raw(m, is_h) do { \
405 rte_mbuf_sanity_check(m, is_h); \
408 /** MBUF asserts in debug mode */
409 #define RTE_MBUF_ASSERT(exp) \
411 rte_panic("line%d\tassert \"" #exp "\" failed\n", __LINE__); \
414 #else /* RTE_LIBRTE_MBUF_DEBUG */
416 /** check mbuf type in debug mode */
417 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
419 /** check mbuf type in debug mode if mbuf pointer is not null */
420 #define __rte_mbuf_sanity_check_raw(m, is_h) do { } while (0)
422 /** MBUF asserts in debug mode */
423 #define RTE_MBUF_ASSERT(exp) do { } while (0)
425 #endif /* RTE_LIBRTE_MBUF_DEBUG */
427 #ifdef RTE_MBUF_REFCNT_ATOMIC
430 * Reads the value of an mbuf's refcnt.
434 * Reference count number.
436 static inline uint16_t
437 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
439 return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
443 * Sets an mbuf's refcnt to a defined value.
450 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
452 rte_atomic16_set(&m->refcnt_atomic, new_value);
456 * Adds given value to an mbuf's refcnt and returns its new value.
460 * Value to add/subtract
464 static inline uint16_t
465 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
468 * The atomic_add is an expensive operation, so we don't want to
469 * call it in the case where we know we are the uniq holder of
470 * this mbuf (i.e. ref_cnt == 1). Otherwise, an atomic
471 * operation has to be used because concurrent accesses on the
472 * reference counter can occur.
474 if (likely(rte_mbuf_refcnt_read(m) == 1)) {
475 rte_mbuf_refcnt_set(m, 1 + value);
479 return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
482 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
485 * Adds given value to an mbuf's refcnt and returns its new value.
487 static inline uint16_t
488 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
490 m->refcnt = (uint16_t)(m->refcnt + value);
495 * Reads the value of an mbuf's refcnt.
497 static inline uint16_t
498 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
504 * Sets an mbuf's refcnt to the defined value.
507 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
509 m->refcnt = new_value;
512 #endif /* RTE_MBUF_REFCNT_ATOMIC */
515 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { \
522 * Sanity checks on an mbuf.
524 * Check the consistency of the given mbuf. The function will cause a
525 * panic if corruption is detected.
528 * The mbuf to be checked.
530 * True if the mbuf is a packet header, false if it is a sub-segment
531 * of a packet (in this case, some fields like nb_segs are not checked)
534 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
537 * @internal Allocate a new mbuf from mempool *mp*.
538 * The use of that function is reserved for RTE internal needs.
539 * Please use rte_pktmbuf_alloc().
542 * The mempool from which mbuf is allocated.
544 * - The pointer to the new mbuf on success.
545 * - NULL if allocation failed.
547 static inline struct rte_mbuf *__rte_mbuf_raw_alloc(struct rte_mempool *mp)
551 if (rte_mempool_get(mp, &mb) < 0)
553 m = (struct rte_mbuf *)mb;
554 RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
555 rte_mbuf_refcnt_set(m, 1);
560 * @internal Put mbuf back into its original mempool.
561 * The use of that function is reserved for RTE internal needs.
562 * Please use rte_pktmbuf_free().
565 * The mbuf to be freed.
567 static inline void __attribute__((always_inline))
568 __rte_mbuf_raw_free(struct rte_mbuf *m)
570 RTE_MBUF_ASSERT(rte_mbuf_refcnt_read(m) == 0);
571 rte_mempool_put(m->pool, m);
574 /* Operations on ctrl mbuf */
577 * The control mbuf constructor.
579 * This function initializes some fields in an mbuf structure that are
580 * not modified by the user once created (mbuf type, origin pool, buffer
581 * start address, and so on). This function is given as a callback function
582 * to rte_mempool_create() at pool creation time.
585 * The mempool from which the mbuf is allocated.
587 * A pointer that can be used by the user to retrieve useful information
588 * for mbuf initialization. This pointer comes from the ``init_arg``
589 * parameter of rte_mempool_create().
591 * The mbuf to initialize.
593 * The index of the mbuf in the pool table.
595 void rte_ctrlmbuf_init(struct rte_mempool *mp, void *opaque_arg,
596 void *m, unsigned i);
599 * Allocate a new mbuf (type is ctrl) from mempool *mp*.
601 * This new mbuf is initialized with data pointing to the beginning of
602 * buffer, and with a length of zero.
605 * The mempool from which the mbuf is allocated.
607 * - The pointer to the new mbuf on success.
608 * - NULL if allocation failed.
610 #define rte_ctrlmbuf_alloc(mp) rte_pktmbuf_alloc(mp)
613 * Free a control mbuf back into its original mempool.
616 * The control mbuf to be freed.
618 #define rte_ctrlmbuf_free(m) rte_pktmbuf_free(m)
621 * A macro that returns the pointer to the carried data.
623 * The value that can be read or assigned.
628 #define rte_ctrlmbuf_data(m) ((char *)((m)->buf_addr) + (m)->data_off)
631 * A macro that returns the length of the carried data.
633 * The value that can be read or assigned.
638 #define rte_ctrlmbuf_len(m) rte_pktmbuf_data_len(m)
641 * Tests if an mbuf is a control mbuf
644 * The mbuf to be tested
646 * - True (1) if the mbuf is a control mbuf
647 * - False(0) otherwise
650 rte_is_ctrlmbuf(struct rte_mbuf *m)
652 return !!(m->ol_flags & CTRL_MBUF_FLAG);
655 /* Operations on pkt mbuf */
658 * The packet mbuf constructor.
660 * This function initializes some fields in the mbuf structure that are
661 * not modified by the user once created (origin pool, buffer start
662 * address, and so on). This function is given as a callback function to
663 * rte_mempool_create() at pool creation time.
666 * The mempool from which mbufs originate.
668 * A pointer that can be used by the user to retrieve useful information
669 * for mbuf initialization. This pointer comes from the ``init_arg``
670 * parameter of rte_mempool_create().
672 * The mbuf to initialize.
674 * The index of the mbuf in the pool table.
676 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
677 void *m, unsigned i);
681 * A packet mbuf pool constructor.
683 * This function initializes the mempool private data in the case of a
684 * pktmbuf pool. This private data is needed by the driver. The
685 * function is given as a callback function to rte_mempool_create() at
686 * pool creation. It can be extended by the user, for example, to
687 * provide another packet size.
690 * The mempool from which mbufs originate.
692 * A pointer that can be used by the user to retrieve useful information
693 * for mbuf initialization. This pointer comes from the ``init_arg``
694 * parameter of rte_mempool_create().
696 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
699 * Create a mbuf pool.
701 * This function creates and initializes a packet mbuf pool. It is
702 * a wrapper to rte_mempool_create() with the proper packet constructor
703 * and mempool constructor.
706 * The name of the mbuf pool.
708 * The number of elements in the mbuf pool. The optimum size (in terms
709 * of memory usage) for a mempool is when n is a power of two minus one:
712 * Size of the per-core object cache. See rte_mempool_create() for
715 * Size of application private are between the rte_mbuf structure
716 * and the data buffer.
717 * @param data_room_size
718 * Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
720 * The socket identifier where the memory should be allocated. The
721 * value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
724 * The pointer to the new allocated mempool, on success. NULL on error
725 * with rte_errno set appropriately. Possible rte_errno values include:
726 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
727 * - E_RTE_SECONDARY - function was called from a secondary process instance
728 * - EINVAL - cache size provided is too large
729 * - ENOSPC - the maximum number of memzones has already been allocated
730 * - EEXIST - a memzone with the same name already exists
731 * - ENOMEM - no appropriate memory area found in which to create memzone
734 rte_pktmbuf_pool_create(const char *name, unsigned n,
735 unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
739 * Get the data room size of mbufs stored in a pktmbuf_pool
741 * The data room size is the amount of data that can be stored in a
742 * mbuf including the headroom (RTE_PKTMBUF_HEADROOM).
745 * The packet mbuf pool.
747 * The data room size of mbufs stored in this mempool.
749 static inline uint16_t
750 rte_pktmbuf_data_room_size(struct rte_mempool *mp)
752 struct rte_pktmbuf_pool_private *mbp_priv;
754 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
755 return mbp_priv->mbuf_data_room_size;
759 * Get the application private size of mbufs stored in a pktmbuf_pool
761 * The private size of mbuf is a zone located between the rte_mbuf
762 * structure and the data buffer where an application can store data
763 * associated to a packet.
766 * The packet mbuf pool.
768 * The private size of mbufs stored in this mempool.
770 static inline uint16_t
771 rte_pktmbuf_priv_size(struct rte_mempool *mp)
773 struct rte_pktmbuf_pool_private *mbp_priv;
775 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
776 return mbp_priv->mbuf_priv_size;
780 * Reset the fields of a packet mbuf to their default values.
782 * The given mbuf must have only one segment.
785 * The packet mbuf to be resetted.
787 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
793 m->vlan_tci_outer = 0;
799 m->data_off = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
800 RTE_PKTMBUF_HEADROOM : m->buf_len;
803 __rte_mbuf_sanity_check(m, 1);
807 * Allocate a new mbuf from a mempool.
809 * This new mbuf contains one segment, which has a length of 0. The pointer
810 * to data is initialized to have some bytes of headroom in the buffer
811 * (if buffer size allows).
814 * The mempool from which the mbuf is allocated.
816 * - The pointer to the new mbuf on success.
817 * - NULL if allocation failed.
819 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
822 if ((m = __rte_mbuf_raw_alloc(mp)) != NULL)
823 rte_pktmbuf_reset(m);
828 * Attach packet mbuf to another packet mbuf.
830 * After attachment we refer the mbuf we attached as 'indirect',
831 * while mbuf we attached to as 'direct'.
832 * Right now, not supported:
833 * - attachment for already indirect mbuf (e.g. - mi has to be direct).
834 * - mbuf we trying to attach (mi) is used by someone else
835 * e.g. it's reference counter is greater then 1.
838 * The indirect packet mbuf.
840 * The packet mbuf we're attaching to.
842 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *m)
846 RTE_MBUF_ASSERT(RTE_MBUF_DIRECT(mi) &&
847 rte_mbuf_refcnt_read(mi) == 1);
849 /* if m is not direct, get the mbuf that embeds the data */
850 if (RTE_MBUF_DIRECT(m))
853 md = rte_mbuf_from_indirect(m);
855 rte_mbuf_refcnt_update(md, 1);
856 mi->priv_size = m->priv_size;
857 mi->buf_physaddr = m->buf_physaddr;
858 mi->buf_addr = m->buf_addr;
859 mi->buf_len = m->buf_len;
862 mi->data_off = m->data_off;
863 mi->data_len = m->data_len;
865 mi->vlan_tci = m->vlan_tci;
866 mi->vlan_tci_outer = m->vlan_tci_outer;
867 mi->tx_offload = m->tx_offload;
871 mi->pkt_len = mi->data_len;
873 mi->ol_flags = m->ol_flags | IND_ATTACHED_MBUF;
874 mi->packet_type = m->packet_type;
876 __rte_mbuf_sanity_check(mi, 1);
877 __rte_mbuf_sanity_check(m, 0);
881 * Detach an indirect packet mbuf.
883 * - restore original mbuf address and length values.
884 * - reset pktmbuf data and data_len to their default values.
885 * All other fields of the given packet mbuf will be left intact.
888 * The indirect attached packet mbuf.
890 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
892 struct rte_mempool *mp = m->pool;
893 uint32_t mbuf_size, buf_len, priv_size;
895 priv_size = rte_pktmbuf_priv_size(mp);
896 mbuf_size = sizeof(struct rte_mbuf) + priv_size;
897 buf_len = rte_pktmbuf_data_room_size(mp);
899 m->priv_size = priv_size;
900 m->buf_addr = (char *)m + mbuf_size;
901 m->buf_physaddr = rte_mempool_virt2phy(mp, m) + mbuf_size;
902 m->buf_len = (uint16_t)buf_len;
903 m->data_off = RTE_MIN(RTE_PKTMBUF_HEADROOM, (uint16_t)m->buf_len);
908 static inline struct rte_mbuf* __attribute__((always_inline))
909 __rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
911 __rte_mbuf_sanity_check(m, 0);
913 if (likely(rte_mbuf_refcnt_update(m, -1) == 0)) {
915 /* if this is an indirect mbuf, then
917 * - free attached mbuf segment
919 if (RTE_MBUF_INDIRECT(m)) {
920 struct rte_mbuf *md = rte_mbuf_from_indirect(m);
921 rte_pktmbuf_detach(m);
922 if (rte_mbuf_refcnt_update(md, -1) == 0)
923 __rte_mbuf_raw_free(md);
931 * Free a segment of a packet mbuf into its original mempool.
933 * Free an mbuf, without parsing other segments in case of chained
937 * The packet mbuf segment to be freed.
939 static inline void __attribute__((always_inline))
940 rte_pktmbuf_free_seg(struct rte_mbuf *m)
942 if (likely(NULL != (m = __rte_pktmbuf_prefree_seg(m)))) {
944 __rte_mbuf_raw_free(m);
949 * Free a packet mbuf back into its original mempool.
951 * Free an mbuf, and all its segments in case of chained buffers. Each
952 * segment is added back into its original mempool.
955 * The packet mbuf to be freed.
957 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
959 struct rte_mbuf *m_next;
961 __rte_mbuf_sanity_check(m, 1);
965 rte_pktmbuf_free_seg(m);
971 * Creates a "clone" of the given packet mbuf.
973 * Walks through all segments of the given packet mbuf, and for each of them:
974 * - Creates a new packet mbuf from the given pool.
975 * - Attaches newly created mbuf to the segment.
976 * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
977 * from the original packet mbuf.
980 * The packet mbuf to be cloned.
982 * The mempool from which the "clone" mbufs are allocated.
984 * - The pointer to the new "clone" mbuf on success.
985 * - NULL if allocation fails.
987 static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
988 struct rte_mempool *mp)
990 struct rte_mbuf *mc, *mi, **prev;
994 if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
999 pktlen = md->pkt_len;
1004 rte_pktmbuf_attach(mi, md);
1007 } while ((md = md->next) != NULL &&
1008 (mi = rte_pktmbuf_alloc(mp)) != NULL);
1012 mc->pkt_len = pktlen;
1014 /* Allocation of new indirect segment failed */
1015 if (unlikely (mi == NULL)) {
1016 rte_pktmbuf_free(mc);
1020 __rte_mbuf_sanity_check(mc, 1);
1025 * Adds given value to the refcnt of all packet mbuf segments.
1027 * Walks through all segments of given packet mbuf and for each of them
1028 * invokes rte_mbuf_refcnt_update().
1031 * The packet mbuf whose refcnt to be updated.
1033 * The value to add to the mbuf's segments refcnt.
1035 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
1037 __rte_mbuf_sanity_check(m, 1);
1040 rte_mbuf_refcnt_update(m, v);
1041 } while ((m = m->next) != NULL);
1045 * Get the headroom in a packet mbuf.
1050 * The length of the headroom.
1052 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
1054 __rte_mbuf_sanity_check(m, 1);
1059 * Get the tailroom of a packet mbuf.
1064 * The length of the tailroom.
1066 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
1068 __rte_mbuf_sanity_check(m, 1);
1069 return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
1074 * Get the last segment of the packet.
1079 * The last segment of the given mbuf.
1081 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
1083 struct rte_mbuf *m2 = (struct rte_mbuf *)m;
1085 __rte_mbuf_sanity_check(m, 1);
1086 while (m2->next != NULL)
1092 * A macro that points to an offset into the data in the mbuf.
1094 * The returned pointer is cast to type t. Before using this
1095 * function, the user must ensure that the first segment is large
1096 * enough to accommodate its data.
1101 * The offset into the mbuf data.
1103 * The type to cast the result into.
1105 #define rte_pktmbuf_mtod_offset(m, t, o) \
1106 ((t)((char *)(m)->buf_addr + (m)->data_off + (o)))
1109 * A macro that points to the start of the data in the mbuf.
1111 * The returned pointer is cast to type t. Before using this
1112 * function, the user must ensure that the first segment is large
1113 * enough to accommodate its data.
1118 * The type to cast the result into.
1120 #define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0)
1123 * A macro that returns the length of the packet.
1125 * The value can be read or assigned.
1130 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
1133 * A macro that returns the length of the segment.
1135 * The value can be read or assigned.
1140 #define rte_pktmbuf_data_len(m) ((m)->data_len)
1143 * Prepend len bytes to an mbuf data area.
1145 * Returns a pointer to the new
1146 * data start address. If there is not enough headroom in the first
1147 * segment, the function will return NULL, without modifying the mbuf.
1152 * The amount of data to prepend (in bytes).
1154 * A pointer to the start of the newly prepended data, or
1155 * NULL if there is not enough headroom space in the first segment
1157 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
1160 __rte_mbuf_sanity_check(m, 1);
1162 if (unlikely(len > rte_pktmbuf_headroom(m)))
1166 m->data_len = (uint16_t)(m->data_len + len);
1167 m->pkt_len = (m->pkt_len + len);
1169 return (char *)m->buf_addr + m->data_off;
1173 * Append len bytes to an mbuf.
1175 * Append len bytes to an mbuf and return a pointer to the start address
1176 * of the added data. If there is not enough tailroom in the last
1177 * segment, the function will return NULL, without modifying the mbuf.
1182 * The amount of data to append (in bytes).
1184 * A pointer to the start of the newly appended data, or
1185 * NULL if there is not enough tailroom space in the last segment
1187 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
1190 struct rte_mbuf *m_last;
1192 __rte_mbuf_sanity_check(m, 1);
1194 m_last = rte_pktmbuf_lastseg(m);
1195 if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
1198 tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
1199 m_last->data_len = (uint16_t)(m_last->data_len + len);
1200 m->pkt_len = (m->pkt_len + len);
1201 return (char*) tail;
1205 * Remove len bytes at the beginning of an mbuf.
1207 * Returns a pointer to the start address of the new data area. If the
1208 * length is greater than the length of the first segment, then the
1209 * function will fail and return NULL, without modifying the mbuf.
1214 * The amount of data to remove (in bytes).
1216 * A pointer to the new start of the data.
1218 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
1220 __rte_mbuf_sanity_check(m, 1);
1222 if (unlikely(len > m->data_len))
1225 m->data_len = (uint16_t)(m->data_len - len);
1227 m->pkt_len = (m->pkt_len - len);
1228 return (char *)m->buf_addr + m->data_off;
1232 * Remove len bytes of data at the end of the mbuf.
1234 * If the length is greater than the length of the last segment, the
1235 * function will fail and return -1 without modifying the mbuf.
1240 * The amount of data to remove (in bytes).
1245 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
1247 struct rte_mbuf *m_last;
1249 __rte_mbuf_sanity_check(m, 1);
1251 m_last = rte_pktmbuf_lastseg(m);
1252 if (unlikely(len > m_last->data_len))
1255 m_last->data_len = (uint16_t)(m_last->data_len - len);
1256 m->pkt_len = (m->pkt_len - len);
1261 * Test if mbuf data is contiguous.
1266 * - 1, if all data is contiguous (one segment).
1267 * - 0, if there is several segments.
1269 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
1271 __rte_mbuf_sanity_check(m, 1);
1272 return !!(m->nb_segs == 1);
1276 * Dump an mbuf structure to the console.
1278 * Dump all fields for the given packet mbuf and all its associated
1279 * segments (in the case of a chained buffer).
1282 * A pointer to a file for output
1286 * If dump_len != 0, also dump the "dump_len" first data bytes of
1289 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
1295 #endif /* _RTE_MBUF_H_ */