1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation.
3 * Copyright 2014 6WIND S.A.
13 * The mbuf library provides the ability to create and destroy buffers
14 * that may be used by the RTE application to store message
15 * buffers. The message buffers are stored in a mempool, using the
16 * RTE mempool library.
18 * The preferred way to create a mbuf pool is to use
19 * rte_pktmbuf_pool_create(). However, in some situations, an
20 * application may want to have more control (ex: populate the pool with
21 * specific memory), in this case it is possible to use functions from
22 * rte_mempool. See how rte_pktmbuf_pool_create() is implemented for
25 * This library provides an API to allocate/free packet mbufs, which are
26 * used to carry network packets.
28 * To understand the concepts of packet buffers or mbufs, you
29 * should read "TCP/IP Illustrated, Volume 2: The Implementation,
30 * Addison-Wesley, 1995, ISBN 0-201-63354-X from Richard Stevens"
31 * http://www.kohala.com/start/tcpipiv2.html
35 #include <rte_compat.h>
36 #include <rte_common.h>
37 #include <rte_config.h>
38 #include <rte_mempool.h>
39 #include <rte_memory.h>
40 #include <rte_atomic.h>
41 #include <rte_prefetch.h>
42 #include <rte_branch_prediction.h>
43 #include <rte_byteorder.h>
44 #include <rte_mbuf_ptype.h>
45 #include <rte_mbuf_core.h>
52 * Get the name of a RX offload flag
55 * The mask describing the flag.
57 * The name of this flag, or NULL if it's not a valid RX flag.
59 const char *rte_get_rx_ol_flag_name(uint64_t mask);
62 * Dump the list of RX offload flags in a buffer
65 * The mask describing the RX flags.
69 * The length of the buffer.
71 * 0 on success, (-1) on error.
73 int rte_get_rx_ol_flag_list(uint64_t mask, char *buf, size_t buflen);
76 * Get the name of a TX offload flag
79 * The mask describing the flag. Usually only one bit must be set.
80 * Several bits can be given if they belong to the same mask.
83 * The name of this flag, or NULL if it's not a valid TX flag.
85 const char *rte_get_tx_ol_flag_name(uint64_t mask);
88 * Dump the list of TX offload flags in a buffer
91 * The mask describing the TX flags.
95 * The length of the buffer.
97 * 0 on success, (-1) on error.
99 int rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen);
102 * Prefetch the first part of the mbuf
104 * The first 64 bytes of the mbuf corresponds to fields that are used early
105 * in the receive path. If the cache line of the architecture is higher than
106 * 64B, the second part will also be prefetched.
109 * The pointer to the mbuf.
112 rte_mbuf_prefetch_part1(struct rte_mbuf *m)
114 rte_prefetch0(&m->cacheline0);
118 * Prefetch the second part of the mbuf
120 * The next 64 bytes of the mbuf corresponds to fields that are used in the
121 * transmit path. If the cache line of the architecture is higher than 64B,
122 * this function does nothing as it is expected that the full mbuf is
126 * The pointer to the mbuf.
129 rte_mbuf_prefetch_part2(struct rte_mbuf *m)
131 #if RTE_CACHE_LINE_SIZE == 64
132 rte_prefetch0(&m->cacheline1);
139 static inline uint16_t rte_pktmbuf_priv_size(struct rte_mempool *mp);
142 * Return the IO address of the beginning of the mbuf data
145 * The pointer to the mbuf.
147 * The IO address of the beginning of the mbuf data
149 static inline rte_iova_t
150 rte_mbuf_data_iova(const struct rte_mbuf *mb)
152 return mb->buf_iova + mb->data_off;
156 static inline phys_addr_t
157 rte_mbuf_data_dma_addr(const struct rte_mbuf *mb)
159 return rte_mbuf_data_iova(mb);
163 * Return the default IO address of the beginning of the mbuf data
165 * This function is used by drivers in their receive function, as it
166 * returns the location where data should be written by the NIC, taking
167 * the default headroom in account.
170 * The pointer to the mbuf.
172 * The IO address of the beginning of the mbuf data
174 static inline rte_iova_t
175 rte_mbuf_data_iova_default(const struct rte_mbuf *mb)
177 return mb->buf_iova + RTE_PKTMBUF_HEADROOM;
181 static inline phys_addr_t
182 rte_mbuf_data_dma_addr_default(const struct rte_mbuf *mb)
184 return rte_mbuf_data_iova_default(mb);
188 * Return the mbuf owning the data buffer address of an indirect mbuf.
191 * The pointer to the indirect mbuf.
193 * The address of the direct mbuf corresponding to buffer_addr.
195 static inline struct rte_mbuf *
196 rte_mbuf_from_indirect(struct rte_mbuf *mi)
198 return (struct rte_mbuf *)RTE_PTR_SUB(mi->buf_addr, sizeof(*mi) + mi->priv_size);
202 * Return address of buffer embedded in the given mbuf.
204 * The return value shall be same as mb->buf_addr if the mbuf is already
205 * initialized and direct. However, this API is useful if mempool of the
206 * mbuf is already known because it doesn't need to access mbuf contents in
207 * order to get the mempool pointer.
210 * @b EXPERIMENTAL: This API may change without prior notice.
211 * This will be used by rte_mbuf_to_baddr() which has redundant code once
212 * experimental tag is removed.
215 * The pointer to the mbuf.
217 * The pointer to the mempool of the mbuf.
219 * The pointer of the mbuf buffer.
223 rte_mbuf_buf_addr(struct rte_mbuf *mb, struct rte_mempool *mp)
225 return (char *)mb + sizeof(*mb) + rte_pktmbuf_priv_size(mp);
229 * Return the default address of the beginning of the mbuf data.
232 * @b EXPERIMENTAL: This API may change without prior notice.
235 * The pointer to the mbuf.
237 * The pointer of the beginning of the mbuf data.
241 rte_mbuf_data_addr_default(__rte_unused struct rte_mbuf *mb)
243 /* gcc complains about calling this experimental function even
244 * when not using it. Hide it with ALLOW_EXPERIMENTAL_API.
246 #ifdef ALLOW_EXPERIMENTAL_API
247 return rte_mbuf_buf_addr(mb, mb->pool) + RTE_PKTMBUF_HEADROOM;
254 * Return address of buffer embedded in the given mbuf.
256 * @note: Accessing mempool pointer of a mbuf is expensive because the
257 * pointer is stored in the 2nd cache line of mbuf. If mempool is known, it
258 * is better not to reference the mempool pointer in mbuf but calling
259 * rte_mbuf_buf_addr() would be more efficient.
262 * The pointer to the mbuf.
264 * The address of the data buffer owned by the mbuf.
267 rte_mbuf_to_baddr(struct rte_mbuf *md)
269 #ifdef ALLOW_EXPERIMENTAL_API
270 return rte_mbuf_buf_addr(md, md->pool);
273 buffer_addr = (char *)md + sizeof(*md) + rte_pktmbuf_priv_size(md->pool);
279 * Return the starting address of the private data area embedded in
282 * Note that no check is made to ensure that a private data area
283 * actually exists in the supplied mbuf.
286 * The pointer to the mbuf.
288 * The starting address of the private data area of the given mbuf.
292 rte_mbuf_to_priv(struct rte_mbuf *m)
294 return RTE_PTR_ADD(m, sizeof(struct rte_mbuf));
298 * Private data in case of pktmbuf pool.
300 * A structure that contains some pktmbuf_pool-specific data that are
301 * appended after the mempool structure (in private data).
303 struct rte_pktmbuf_pool_private {
304 uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf. */
305 uint16_t mbuf_priv_size; /**< Size of private area in each mbuf. */
306 uint32_t flags; /**< reserved for future use. */
310 * Return the flags from private data in an mempool structure.
313 * A pointer to the mempool structure.
315 * The flags from the private data structure.
317 static inline uint32_t
318 rte_pktmbuf_priv_flags(struct rte_mempool *mp)
320 struct rte_pktmbuf_pool_private *mbp_priv;
322 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
323 return mbp_priv->flags;
327 * When set, pktmbuf mempool will hold only mbufs with pinned external
328 * buffer. The external buffer will be attached to the mbuf at the
329 * memory pool creation and will never be detached by the mbuf free calls.
330 * mbuf should not contain any room for data after the mbuf structure.
332 #define RTE_PKTMBUF_POOL_F_PINNED_EXT_BUF (1 << 0)
335 * Returns non zero if given mbuf has a pinned external buffer, or zero
336 * otherwise. The pinned external buffer is allocated at pool creation
337 * time and should not be freed on mbuf freeing.
339 * External buffer is a user-provided anonymous buffer.
341 #define RTE_MBUF_HAS_PINNED_EXTBUF(mb) \
342 (rte_pktmbuf_priv_flags(mb->pool) & RTE_PKTMBUF_POOL_F_PINNED_EXT_BUF)
344 #ifdef RTE_LIBRTE_MBUF_DEBUG
346 /** check mbuf type in debug mode */
347 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
349 #else /* RTE_LIBRTE_MBUF_DEBUG */
351 /** check mbuf type in debug mode */
352 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
354 #endif /* RTE_LIBRTE_MBUF_DEBUG */
356 #ifdef RTE_MBUF_REFCNT_ATOMIC
359 * Reads the value of an mbuf's refcnt.
363 * Reference count number.
365 static inline uint16_t
366 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
368 return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
372 * Sets an mbuf's refcnt to a defined value.
379 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
381 rte_atomic16_set(&m->refcnt_atomic, (int16_t)new_value);
385 static inline uint16_t
386 __rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
388 return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
392 * Adds given value to an mbuf's refcnt and returns its new value.
396 * Value to add/subtract
400 static inline uint16_t
401 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
404 * The atomic_add is an expensive operation, so we don't want to
405 * call it in the case where we know we are the unique holder of
406 * this mbuf (i.e. ref_cnt == 1). Otherwise, an atomic
407 * operation has to be used because concurrent accesses on the
408 * reference counter can occur.
410 if (likely(rte_mbuf_refcnt_read(m) == 1)) {
412 rte_mbuf_refcnt_set(m, (uint16_t)value);
413 return (uint16_t)value;
416 return __rte_mbuf_refcnt_update(m, value);
419 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
422 static inline uint16_t
423 __rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
425 m->refcnt = (uint16_t)(m->refcnt + value);
430 * Adds given value to an mbuf's refcnt and returns its new value.
432 static inline uint16_t
433 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
435 return __rte_mbuf_refcnt_update(m, value);
439 * Reads the value of an mbuf's refcnt.
441 static inline uint16_t
442 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
448 * Sets an mbuf's refcnt to the defined value.
451 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
453 m->refcnt = new_value;
456 #endif /* RTE_MBUF_REFCNT_ATOMIC */
459 * Reads the refcnt of an external buffer.
462 * Shared data of the external buffer.
464 * Reference count number.
466 static inline uint16_t
467 rte_mbuf_ext_refcnt_read(const struct rte_mbuf_ext_shared_info *shinfo)
469 return (uint16_t)(rte_atomic16_read(&shinfo->refcnt_atomic));
473 * Set refcnt of an external buffer.
476 * Shared data of the external buffer.
481 rte_mbuf_ext_refcnt_set(struct rte_mbuf_ext_shared_info *shinfo,
484 rte_atomic16_set(&shinfo->refcnt_atomic, (int16_t)new_value);
488 * Add given value to refcnt of an external buffer and return its new
492 * Shared data of the external buffer.
494 * Value to add/subtract
498 static inline uint16_t
499 rte_mbuf_ext_refcnt_update(struct rte_mbuf_ext_shared_info *shinfo,
502 if (likely(rte_mbuf_ext_refcnt_read(shinfo) == 1)) {
504 rte_mbuf_ext_refcnt_set(shinfo, (uint16_t)value);
505 return (uint16_t)value;
508 return (uint16_t)rte_atomic16_add_return(&shinfo->refcnt_atomic, value);
512 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { \
519 * Sanity checks on an mbuf.
521 * Check the consistency of the given mbuf. The function will cause a
522 * panic if corruption is detected.
525 * The mbuf to be checked.
527 * True if the mbuf is a packet header, false if it is a sub-segment
528 * of a packet (in this case, some fields like nb_segs are not checked)
531 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
534 * Sanity checks on a mbuf.
536 * Almost like rte_mbuf_sanity_check(), but this function gives the reason
537 * if corruption is detected rather than panic.
540 * The mbuf to be checked.
542 * True if the mbuf is a packet header, false if it is a sub-segment
543 * of a packet (in this case, some fields like nb_segs are not checked)
545 * A reference to a string pointer where to store the reason why a mbuf is
546 * considered invalid.
548 * - 0 if no issue has been found, reason is left untouched.
549 * - -1 if a problem is detected, reason then points to a string describing
550 * the reason why the mbuf is deemed invalid.
553 int rte_mbuf_check(const struct rte_mbuf *m, int is_header,
554 const char **reason);
556 #define MBUF_RAW_ALLOC_CHECK(m) do { \
557 RTE_ASSERT(rte_mbuf_refcnt_read(m) == 1); \
558 RTE_ASSERT((m)->next == NULL); \
559 RTE_ASSERT((m)->nb_segs == 1); \
560 __rte_mbuf_sanity_check(m, 0); \
564 * Allocate an uninitialized mbuf from mempool *mp*.
566 * This function can be used by PMDs (especially in RX functions) to
567 * allocate an uninitialized mbuf. The driver is responsible of
568 * initializing all the required fields. See rte_pktmbuf_reset().
569 * For standard needs, prefer rte_pktmbuf_alloc().
571 * The caller can expect that the following fields of the mbuf structure
572 * are initialized: buf_addr, buf_iova, buf_len, refcnt=1, nb_segs=1,
573 * next=NULL, pool, priv_size. The other fields must be initialized
577 * The mempool from which mbuf is allocated.
579 * - The pointer to the new mbuf on success.
580 * - NULL if allocation failed.
582 static inline struct rte_mbuf *rte_mbuf_raw_alloc(struct rte_mempool *mp)
586 if (rte_mempool_get(mp, (void **)&m) < 0)
588 MBUF_RAW_ALLOC_CHECK(m);
593 * Put mbuf back into its original mempool.
595 * The caller must ensure that the mbuf is direct and properly
596 * reinitialized (refcnt=1, next=NULL, nb_segs=1), as done by
597 * rte_pktmbuf_prefree_seg().
599 * This function should be used with care, when optimization is
600 * required. For standard needs, prefer rte_pktmbuf_free() or
601 * rte_pktmbuf_free_seg().
604 * The mbuf to be freed.
606 static __rte_always_inline void
607 rte_mbuf_raw_free(struct rte_mbuf *m)
609 RTE_ASSERT(!RTE_MBUF_CLONED(m) &&
610 (!RTE_MBUF_HAS_EXTBUF(m) || RTE_MBUF_HAS_PINNED_EXTBUF(m)));
611 RTE_ASSERT(rte_mbuf_refcnt_read(m) == 1);
612 RTE_ASSERT(m->next == NULL);
613 RTE_ASSERT(m->nb_segs == 1);
614 __rte_mbuf_sanity_check(m, 0);
615 rte_mempool_put(m->pool, m);
619 * The packet mbuf constructor.
621 * This function initializes some fields in the mbuf structure that are
622 * not modified by the user once created (origin pool, buffer start
623 * address, and so on). This function is given as a callback function to
624 * rte_mempool_obj_iter() or rte_mempool_create() at pool creation time.
627 * The mempool from which mbufs originate.
629 * A pointer that can be used by the user to retrieve useful information
630 * for mbuf initialization. This pointer is the opaque argument passed to
631 * rte_mempool_obj_iter() or rte_mempool_create().
633 * The mbuf to initialize.
635 * The index of the mbuf in the pool table.
637 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
638 void *m, unsigned i);
642 * A packet mbuf pool constructor.
644 * This function initializes the mempool private data in the case of a
645 * pktmbuf pool. This private data is needed by the driver. The
646 * function must be called on the mempool before it is used, or it
647 * can be given as a callback function to rte_mempool_create() at
648 * pool creation. It can be extended by the user, for example, to
649 * provide another packet size.
652 * The mempool from which mbufs originate.
654 * A pointer that can be used by the user to retrieve useful information
655 * for mbuf initialization. This pointer is the opaque argument passed to
656 * rte_mempool_create().
658 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
661 * Create a mbuf pool.
663 * This function creates and initializes a packet mbuf pool. It is
664 * a wrapper to rte_mempool functions.
667 * The name of the mbuf pool.
669 * The number of elements in the mbuf pool. The optimum size (in terms
670 * of memory usage) for a mempool is when n is a power of two minus one:
673 * Size of the per-core object cache. See rte_mempool_create() for
676 * Size of application private are between the rte_mbuf structure
677 * and the data buffer. This value must be aligned to RTE_MBUF_PRIV_ALIGN.
678 * @param data_room_size
679 * Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
681 * The socket identifier where the memory should be allocated. The
682 * value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
685 * The pointer to the new allocated mempool, on success. NULL on error
686 * with rte_errno set appropriately. Possible rte_errno values include:
687 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
688 * - E_RTE_SECONDARY - function was called from a secondary process instance
689 * - EINVAL - cache size provided is too large, or priv_size is not aligned.
690 * - ENOSPC - the maximum number of memzones has already been allocated
691 * - EEXIST - a memzone with the same name already exists
692 * - ENOMEM - no appropriate memory area found in which to create memzone
695 rte_pktmbuf_pool_create(const char *name, unsigned n,
696 unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
700 * Create a mbuf pool with a given mempool ops name
702 * This function creates and initializes a packet mbuf pool. It is
703 * a wrapper to rte_mempool functions.
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. This value must be aligned to RTE_MBUF_PRIV_ALIGN.
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 mempool ops name to be used for this mempool instead of
725 * default mempool. The value can be *NULL* to use default mempool.
727 * The pointer to the new allocated mempool, on success. NULL on error
728 * with rte_errno set appropriately. Possible rte_errno values include:
729 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
730 * - E_RTE_SECONDARY - function was called from a secondary process instance
731 * - EINVAL - cache size provided is too large, or priv_size is not aligned.
732 * - ENOSPC - the maximum number of memzones has already been allocated
733 * - EEXIST - a memzone with the same name already exists
734 * - ENOMEM - no appropriate memory area found in which to create memzone
737 rte_pktmbuf_pool_create_by_ops(const char *name, unsigned int n,
738 unsigned int cache_size, uint16_t priv_size, uint16_t data_room_size,
739 int socket_id, const char *ops_name);
742 * Get the data room size of mbufs stored in a pktmbuf_pool
744 * The data room size is the amount of data that can be stored in a
745 * mbuf including the headroom (RTE_PKTMBUF_HEADROOM).
748 * The packet mbuf pool.
750 * The data room size of mbufs stored in this mempool.
752 static inline uint16_t
753 rte_pktmbuf_data_room_size(struct rte_mempool *mp)
755 struct rte_pktmbuf_pool_private *mbp_priv;
757 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
758 return mbp_priv->mbuf_data_room_size;
762 * Get the application private size of mbufs stored in a pktmbuf_pool
764 * The private size of mbuf is a zone located between the rte_mbuf
765 * structure and the data buffer where an application can store data
766 * associated to a packet.
769 * The packet mbuf pool.
771 * The private size of mbufs stored in this mempool.
773 static inline uint16_t
774 rte_pktmbuf_priv_size(struct rte_mempool *mp)
776 struct rte_pktmbuf_pool_private *mbp_priv;
778 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
779 return mbp_priv->mbuf_priv_size;
783 * Reset the data_off field of a packet mbuf to its default value.
785 * The given mbuf must have only one segment, which should be empty.
788 * The packet mbuf's data_off field has to be reset.
790 static inline void rte_pktmbuf_reset_headroom(struct rte_mbuf *m)
792 m->data_off = (uint16_t)RTE_MIN((uint16_t)RTE_PKTMBUF_HEADROOM,
793 (uint16_t)m->buf_len);
797 * Reset the fields of a packet mbuf to their default values.
799 * The given mbuf must have only one segment.
802 * The packet mbuf to be reset.
804 #define MBUF_INVALID_PORT UINT16_MAX
806 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
812 m->vlan_tci_outer = 0;
814 m->port = MBUF_INVALID_PORT;
816 m->ol_flags &= EXT_ATTACHED_MBUF;
818 rte_pktmbuf_reset_headroom(m);
821 __rte_mbuf_sanity_check(m, 1);
825 * Allocate a new mbuf from a mempool.
827 * This new mbuf contains one segment, which has a length of 0. The pointer
828 * to data is initialized to have some bytes of headroom in the buffer
829 * (if buffer size allows).
832 * The mempool from which the mbuf is allocated.
834 * - The pointer to the new mbuf on success.
835 * - NULL if allocation failed.
837 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
840 if ((m = rte_mbuf_raw_alloc(mp)) != NULL)
841 rte_pktmbuf_reset(m);
846 * Allocate a bulk of mbufs, initialize refcnt and reset the fields to default
850 * The mempool from which mbufs are allocated.
852 * Array of pointers to mbufs
857 * - -ENOENT: Not enough entries in the mempool; no mbufs are retrieved.
859 static inline int rte_pktmbuf_alloc_bulk(struct rte_mempool *pool,
860 struct rte_mbuf **mbufs, unsigned count)
865 rc = rte_mempool_get_bulk(pool, (void **)mbufs, count);
869 /* To understand duff's device on loop unwinding optimization, see
870 * https://en.wikipedia.org/wiki/Duff's_device.
871 * Here while() loop is used rather than do() while{} to avoid extra
872 * check if count is zero.
876 while (idx != count) {
877 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
878 rte_pktmbuf_reset(mbufs[idx]);
882 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
883 rte_pktmbuf_reset(mbufs[idx]);
887 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
888 rte_pktmbuf_reset(mbufs[idx]);
892 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
893 rte_pktmbuf_reset(mbufs[idx]);
902 * Initialize shared data at the end of an external buffer before attaching
903 * to a mbuf by ``rte_pktmbuf_attach_extbuf()``. This is not a mandatory
904 * initialization but a helper function to simply spare a few bytes at the
905 * end of the buffer for shared data. If shared data is allocated
906 * separately, this should not be called but application has to properly
907 * initialize the shared data according to its need.
909 * Free callback and its argument is saved and the refcnt is set to 1.
912 * The value of buf_len will be reduced to RTE_PTR_DIFF(shinfo, buf_addr)
913 * after this initialization. This shall be used for
914 * ``rte_pktmbuf_attach_extbuf()``
917 * The pointer to the external buffer.
918 * @param [in,out] buf_len
919 * The pointer to length of the external buffer. Input value must be
920 * larger than the size of ``struct rte_mbuf_ext_shared_info`` and
921 * padding for alignment. If not enough, this function will return NULL.
922 * Adjusted buffer length will be returned through this pointer.
924 * Free callback function to call when the external buffer needs to be
927 * Argument for the free callback function.
930 * A pointer to the initialized shared data on success, return NULL
933 static inline struct rte_mbuf_ext_shared_info *
934 rte_pktmbuf_ext_shinfo_init_helper(void *buf_addr, uint16_t *buf_len,
935 rte_mbuf_extbuf_free_callback_t free_cb, void *fcb_opaque)
937 struct rte_mbuf_ext_shared_info *shinfo;
938 void *buf_end = RTE_PTR_ADD(buf_addr, *buf_len);
941 addr = RTE_PTR_ALIGN_FLOOR(RTE_PTR_SUB(buf_end, sizeof(*shinfo)),
943 if (addr <= buf_addr)
946 shinfo = (struct rte_mbuf_ext_shared_info *)addr;
947 shinfo->free_cb = free_cb;
948 shinfo->fcb_opaque = fcb_opaque;
949 rte_mbuf_ext_refcnt_set(shinfo, 1);
951 *buf_len = (uint16_t)RTE_PTR_DIFF(shinfo, buf_addr);
956 * Attach an external buffer to a mbuf.
958 * User-managed anonymous buffer can be attached to an mbuf. When attaching
959 * it, corresponding free callback function and its argument should be
960 * provided via shinfo. This callback function will be called once all the
961 * mbufs are detached from the buffer (refcnt becomes zero).
963 * The headroom length of the attaching mbuf will be set to zero and this
964 * can be properly adjusted after attachment. For example, ``rte_pktmbuf_adj()``
965 * or ``rte_pktmbuf_reset_headroom()`` might be used.
967 * Similarly, the packet length is initialized to 0. If the buffer contains
968 * data, the user has to adjust ``data_len`` and the ``pkt_len`` field of
969 * the mbuf accordingly.
971 * More mbufs can be attached to the same external buffer by
972 * ``rte_pktmbuf_attach()`` once the external buffer has been attached by
975 * Detachment can be done by either ``rte_pktmbuf_detach_extbuf()`` or
976 * ``rte_pktmbuf_detach()``.
978 * Memory for shared data must be provided and user must initialize all of
979 * the content properly, especially free callback and refcnt. The pointer
980 * of shared data will be stored in m->shinfo.
981 * ``rte_pktmbuf_ext_shinfo_init_helper`` can help to simply spare a few
982 * bytes at the end of buffer for the shared data, store free callback and
983 * its argument and set the refcnt to 1. The following is an example:
985 * struct rte_mbuf_ext_shared_info *shinfo =
986 * rte_pktmbuf_ext_shinfo_init_helper(buf_addr, &buf_len,
988 * rte_pktmbuf_attach_extbuf(m, buf_addr, buf_iova, buf_len, shinfo);
989 * rte_pktmbuf_reset_headroom(m);
990 * rte_pktmbuf_adj(m, data_len);
992 * Attaching an external buffer is quite similar to mbuf indirection in
993 * replacing buffer addresses and length of a mbuf, but a few differences:
994 * - When an indirect mbuf is attached, refcnt of the direct mbuf would be
995 * 2 as long as the direct mbuf itself isn't freed after the attachment.
996 * In such cases, the buffer area of a direct mbuf must be read-only. But
997 * external buffer has its own refcnt and it starts from 1. Unless
998 * multiple mbufs are attached to a mbuf having an external buffer, the
999 * external buffer is writable.
1000 * - There's no need to allocate buffer from a mempool. Any buffer can be
1001 * attached with appropriate free callback and its IO address.
1002 * - Smaller metadata is required to maintain shared data such as refcnt.
1005 * The pointer to the mbuf.
1007 * The pointer to the external buffer.
1009 * IO address of the external buffer.
1011 * The size of the external buffer.
1013 * User-provided memory for shared data of the external buffer.
1016 rte_pktmbuf_attach_extbuf(struct rte_mbuf *m, void *buf_addr,
1017 rte_iova_t buf_iova, uint16_t buf_len,
1018 struct rte_mbuf_ext_shared_info *shinfo)
1020 /* mbuf should not be read-only */
1021 RTE_ASSERT(RTE_MBUF_DIRECT(m) && rte_mbuf_refcnt_read(m) == 1);
1022 RTE_ASSERT(shinfo->free_cb != NULL);
1024 m->buf_addr = buf_addr;
1025 m->buf_iova = buf_iova;
1026 m->buf_len = buf_len;
1031 m->ol_flags |= EXT_ATTACHED_MBUF;
1036 * Detach the external buffer attached to a mbuf, same as
1037 * ``rte_pktmbuf_detach()``
1040 * The mbuf having external buffer.
1042 #define rte_pktmbuf_detach_extbuf(m) rte_pktmbuf_detach(m)
1045 * Copy dynamic fields from msrc to mdst.
1048 * The destination mbuf.
1053 rte_mbuf_dynfield_copy(struct rte_mbuf *mdst, const struct rte_mbuf *msrc)
1055 memcpy(&mdst->dynfield1, msrc->dynfield1, sizeof(mdst->dynfield1));
1060 __rte_pktmbuf_copy_hdr(struct rte_mbuf *mdst, const struct rte_mbuf *msrc)
1062 mdst->port = msrc->port;
1063 mdst->vlan_tci = msrc->vlan_tci;
1064 mdst->vlan_tci_outer = msrc->vlan_tci_outer;
1065 mdst->tx_offload = msrc->tx_offload;
1066 mdst->hash = msrc->hash;
1067 mdst->packet_type = msrc->packet_type;
1068 mdst->timestamp = msrc->timestamp;
1069 rte_mbuf_dynfield_copy(mdst, msrc);
1073 * Attach packet mbuf to another packet mbuf.
1075 * If the mbuf we are attaching to isn't a direct buffer and is attached to
1076 * an external buffer, the mbuf being attached will be attached to the
1077 * external buffer instead of mbuf indirection.
1079 * Otherwise, the mbuf will be indirectly attached. After attachment we
1080 * refer the mbuf we attached as 'indirect', while mbuf we attached to as
1081 * 'direct'. The direct mbuf's reference counter is incremented.
1083 * Right now, not supported:
1084 * - attachment for already indirect mbuf (e.g. - mi has to be direct).
1085 * - mbuf we trying to attach (mi) is used by someone else
1086 * e.g. it's reference counter is greater then 1.
1089 * The indirect packet mbuf.
1091 * The packet mbuf we're attaching to.
1093 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *m)
1095 RTE_ASSERT(RTE_MBUF_DIRECT(mi) &&
1096 rte_mbuf_refcnt_read(mi) == 1);
1098 if (RTE_MBUF_HAS_EXTBUF(m)) {
1099 rte_mbuf_ext_refcnt_update(m->shinfo, 1);
1100 mi->ol_flags = m->ol_flags;
1101 mi->shinfo = m->shinfo;
1103 /* if m is not direct, get the mbuf that embeds the data */
1104 rte_mbuf_refcnt_update(rte_mbuf_from_indirect(m), 1);
1105 mi->priv_size = m->priv_size;
1106 mi->ol_flags = m->ol_flags | IND_ATTACHED_MBUF;
1109 __rte_pktmbuf_copy_hdr(mi, m);
1111 mi->data_off = m->data_off;
1112 mi->data_len = m->data_len;
1113 mi->buf_iova = m->buf_iova;
1114 mi->buf_addr = m->buf_addr;
1115 mi->buf_len = m->buf_len;
1118 mi->pkt_len = mi->data_len;
1121 __rte_mbuf_sanity_check(mi, 1);
1122 __rte_mbuf_sanity_check(m, 0);
1126 * @internal used by rte_pktmbuf_detach().
1128 * Decrement the reference counter of the external buffer. When the
1129 * reference counter becomes 0, the buffer is freed by pre-registered
1133 __rte_pktmbuf_free_extbuf(struct rte_mbuf *m)
1135 RTE_ASSERT(RTE_MBUF_HAS_EXTBUF(m));
1136 RTE_ASSERT(m->shinfo != NULL);
1138 if (rte_mbuf_ext_refcnt_update(m->shinfo, -1) == 0)
1139 m->shinfo->free_cb(m->buf_addr, m->shinfo->fcb_opaque);
1143 * @internal used by rte_pktmbuf_detach().
1145 * Decrement the direct mbuf's reference counter. When the reference
1146 * counter becomes 0, the direct mbuf is freed.
1149 __rte_pktmbuf_free_direct(struct rte_mbuf *m)
1151 struct rte_mbuf *md;
1153 RTE_ASSERT(RTE_MBUF_CLONED(m));
1155 md = rte_mbuf_from_indirect(m);
1157 if (rte_mbuf_refcnt_update(md, -1) == 0) {
1160 rte_mbuf_refcnt_set(md, 1);
1161 rte_mbuf_raw_free(md);
1166 * Detach a packet mbuf from external buffer or direct buffer.
1168 * - decrement refcnt and free the external/direct buffer if refcnt
1170 * - restore original mbuf address and length values.
1171 * - reset pktmbuf data and data_len to their default values.
1173 * All other fields of the given packet mbuf will be left intact.
1175 * If the packet mbuf was allocated from the pool with pinned
1176 * external buffers the rte_pktmbuf_detach does nothing with the
1177 * mbuf of this kind, because the pinned buffers are not supposed
1181 * The indirect attached packet mbuf.
1183 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
1185 struct rte_mempool *mp = m->pool;
1186 uint32_t mbuf_size, buf_len;
1189 if (RTE_MBUF_HAS_EXTBUF(m)) {
1191 * The mbuf has the external attached buffer,
1192 * we should check the type of the memory pool where
1193 * the mbuf was allocated from to detect the pinned
1196 uint32_t flags = rte_pktmbuf_priv_flags(mp);
1198 if (flags & RTE_PKTMBUF_POOL_F_PINNED_EXT_BUF) {
1200 * The pinned external buffer should not be
1201 * detached from its backing mbuf, just exit.
1205 __rte_pktmbuf_free_extbuf(m);
1207 __rte_pktmbuf_free_direct(m);
1209 priv_size = rte_pktmbuf_priv_size(mp);
1210 mbuf_size = (uint32_t)(sizeof(struct rte_mbuf) + priv_size);
1211 buf_len = rte_pktmbuf_data_room_size(mp);
1213 m->priv_size = priv_size;
1214 m->buf_addr = (char *)m + mbuf_size;
1215 m->buf_iova = rte_mempool_virt2iova(m) + mbuf_size;
1216 m->buf_len = (uint16_t)buf_len;
1217 rte_pktmbuf_reset_headroom(m);
1223 * @internal Handle the packet mbufs with attached pinned external buffer
1224 * on the mbuf freeing:
1226 * - return zero if reference counter in shinfo is one. It means there is
1227 * no more reference to this pinned buffer and mbuf can be returned to
1230 * - otherwise (if reference counter is not one), decrement reference
1231 * counter and return non-zero value to prevent freeing the backing mbuf.
1233 * Returns non zero if mbuf should not be freed.
1235 static inline int __rte_pktmbuf_pinned_extbuf_decref(struct rte_mbuf *m)
1237 struct rte_mbuf_ext_shared_info *shinfo;
1239 /* Clear flags, mbuf is being freed. */
1240 m->ol_flags = EXT_ATTACHED_MBUF;
1243 /* Optimize for performance - do not dec/reinit */
1244 if (likely(rte_mbuf_ext_refcnt_read(shinfo) == 1))
1248 * Direct usage of add primitive to avoid
1249 * duplication of comparing with one.
1251 if (likely(rte_atomic16_add_return
1252 (&shinfo->refcnt_atomic, -1)))
1255 /* Reinitialize counter before mbuf freeing. */
1256 rte_mbuf_ext_refcnt_set(shinfo, 1);
1261 * Decrease reference counter and unlink a mbuf segment
1263 * This function does the same than a free, except that it does not
1264 * return the segment to its pool.
1265 * It decreases the reference counter, and if it reaches 0, it is
1266 * detached from its parent for an indirect mbuf.
1269 * The mbuf to be unlinked
1271 * - (m) if it is the last reference. It can be recycled or freed.
1272 * - (NULL) if the mbuf still has remaining references on it.
1274 static __rte_always_inline struct rte_mbuf *
1275 rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
1277 __rte_mbuf_sanity_check(m, 0);
1279 if (likely(rte_mbuf_refcnt_read(m) == 1)) {
1281 if (!RTE_MBUF_DIRECT(m)) {
1282 if (!RTE_MBUF_HAS_EXTBUF(m) ||
1283 !RTE_MBUF_HAS_PINNED_EXTBUF(m))
1284 rte_pktmbuf_detach(m);
1285 else if (__rte_pktmbuf_pinned_extbuf_decref(m))
1289 if (m->next != NULL) {
1296 } else if (__rte_mbuf_refcnt_update(m, -1) == 0) {
1298 if (!RTE_MBUF_DIRECT(m)) {
1299 if (!RTE_MBUF_HAS_EXTBUF(m) ||
1300 !RTE_MBUF_HAS_PINNED_EXTBUF(m))
1301 rte_pktmbuf_detach(m);
1302 else if (__rte_pktmbuf_pinned_extbuf_decref(m))
1306 if (m->next != NULL) {
1310 rte_mbuf_refcnt_set(m, 1);
1318 * Free a segment of a packet mbuf into its original mempool.
1320 * Free an mbuf, without parsing other segments in case of chained
1324 * The packet mbuf segment to be freed.
1326 static __rte_always_inline void
1327 rte_pktmbuf_free_seg(struct rte_mbuf *m)
1329 m = rte_pktmbuf_prefree_seg(m);
1330 if (likely(m != NULL))
1331 rte_mbuf_raw_free(m);
1335 * Free a packet mbuf back into its original mempool.
1337 * Free an mbuf, and all its segments in case of chained buffers. Each
1338 * segment is added back into its original mempool.
1341 * The packet mbuf to be freed. If NULL, the function does nothing.
1343 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
1345 struct rte_mbuf *m_next;
1348 __rte_mbuf_sanity_check(m, 1);
1352 rte_pktmbuf_free_seg(m);
1358 * Free a bulk of packet mbufs back into their original mempools.
1360 * Free a bulk of mbufs, and all their segments in case of chained buffers.
1361 * Each segment is added back into its original mempool.
1364 * Array of pointers to packet mbufs.
1365 * The array may contain NULL pointers.
1370 void rte_pktmbuf_free_bulk(struct rte_mbuf **mbufs, unsigned int count);
1373 * Create a "clone" of the given packet mbuf.
1375 * Walks through all segments of the given packet mbuf, and for each of them:
1376 * - Creates a new packet mbuf from the given pool.
1377 * - Attaches newly created mbuf to the segment.
1378 * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
1379 * from the original packet mbuf.
1382 * The packet mbuf to be cloned.
1384 * The mempool from which the "clone" mbufs are allocated.
1386 * - The pointer to the new "clone" mbuf on success.
1387 * - NULL if allocation fails.
1390 rte_pktmbuf_clone(struct rte_mbuf *md, struct rte_mempool *mp);
1393 * Create a full copy of a given packet mbuf.
1395 * Copies all the data from a given packet mbuf to a newly allocated
1396 * set of mbufs. The private data are is not copied.
1399 * The packet mbuf to be copiedd.
1401 * The mempool from which the "clone" mbufs are allocated.
1403 * The number of bytes to skip before copying.
1404 * If the mbuf does not have that many bytes, it is an error
1405 * and NULL is returned.
1407 * The upper limit on bytes to copy. Passing UINT32_MAX
1408 * means all data (after offset).
1410 * - The pointer to the new "clone" mbuf on success.
1411 * - NULL if allocation fails.
1415 rte_pktmbuf_copy(const struct rte_mbuf *m, struct rte_mempool *mp,
1416 uint32_t offset, uint32_t length);
1419 * Adds given value to the refcnt of all packet mbuf segments.
1421 * Walks through all segments of given packet mbuf and for each of them
1422 * invokes rte_mbuf_refcnt_update().
1425 * The packet mbuf whose refcnt to be updated.
1427 * The value to add to the mbuf's segments refcnt.
1429 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
1431 __rte_mbuf_sanity_check(m, 1);
1434 rte_mbuf_refcnt_update(m, v);
1435 } while ((m = m->next) != NULL);
1439 * Get the headroom in a packet mbuf.
1444 * The length of the headroom.
1446 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
1448 __rte_mbuf_sanity_check(m, 0);
1453 * Get the tailroom of a packet mbuf.
1458 * The length of the tailroom.
1460 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
1462 __rte_mbuf_sanity_check(m, 0);
1463 return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
1468 * Get the last segment of the packet.
1473 * The last segment of the given mbuf.
1475 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
1477 __rte_mbuf_sanity_check(m, 1);
1478 while (m->next != NULL)
1484 #define rte_pktmbuf_mtophys_offset(m, o) \
1485 rte_pktmbuf_iova_offset(m, o)
1488 #define rte_pktmbuf_mtophys(m) rte_pktmbuf_iova(m)
1491 * A macro that returns the length of the packet.
1493 * The value can be read or assigned.
1498 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
1501 * A macro that returns the length of the segment.
1503 * The value can be read or assigned.
1508 #define rte_pktmbuf_data_len(m) ((m)->data_len)
1511 * Prepend len bytes to an mbuf data area.
1513 * Returns a pointer to the new
1514 * data start address. If there is not enough headroom in the first
1515 * segment, the function will return NULL, without modifying the mbuf.
1520 * The amount of data to prepend (in bytes).
1522 * A pointer to the start of the newly prepended data, or
1523 * NULL if there is not enough headroom space in the first segment
1525 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
1528 __rte_mbuf_sanity_check(m, 1);
1530 if (unlikely(len > rte_pktmbuf_headroom(m)))
1533 /* NB: elaborating the subtraction like this instead of using
1534 * -= allows us to ensure the result type is uint16_t
1535 * avoiding compiler warnings on gcc 8.1 at least */
1536 m->data_off = (uint16_t)(m->data_off - len);
1537 m->data_len = (uint16_t)(m->data_len + len);
1538 m->pkt_len = (m->pkt_len + len);
1540 return (char *)m->buf_addr + m->data_off;
1544 * Append len bytes to an mbuf.
1546 * Append len bytes to an mbuf and return a pointer to the start address
1547 * of the added data. If there is not enough tailroom in the last
1548 * segment, the function will return NULL, without modifying the mbuf.
1553 * The amount of data to append (in bytes).
1555 * A pointer to the start of the newly appended data, or
1556 * NULL if there is not enough tailroom space in the last segment
1558 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
1561 struct rte_mbuf *m_last;
1563 __rte_mbuf_sanity_check(m, 1);
1565 m_last = rte_pktmbuf_lastseg(m);
1566 if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
1569 tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
1570 m_last->data_len = (uint16_t)(m_last->data_len + len);
1571 m->pkt_len = (m->pkt_len + len);
1572 return (char*) tail;
1576 * Remove len bytes at the beginning of an mbuf.
1578 * Returns a pointer to the start address of the new data area. If the
1579 * length is greater than the length of the first segment, then the
1580 * function will fail and return NULL, without modifying the mbuf.
1585 * The amount of data to remove (in bytes).
1587 * A pointer to the new start of the data.
1589 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
1591 __rte_mbuf_sanity_check(m, 1);
1593 if (unlikely(len > m->data_len))
1596 /* NB: elaborating the addition like this instead of using
1597 * += allows us to ensure the result type is uint16_t
1598 * avoiding compiler warnings on gcc 8.1 at least */
1599 m->data_len = (uint16_t)(m->data_len - len);
1600 m->data_off = (uint16_t)(m->data_off + len);
1601 m->pkt_len = (m->pkt_len - len);
1602 return (char *)m->buf_addr + m->data_off;
1606 * Remove len bytes of data at the end of the mbuf.
1608 * If the length is greater than the length of the last segment, the
1609 * function will fail and return -1 without modifying the mbuf.
1614 * The amount of data to remove (in bytes).
1619 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
1621 struct rte_mbuf *m_last;
1623 __rte_mbuf_sanity_check(m, 1);
1625 m_last = rte_pktmbuf_lastseg(m);
1626 if (unlikely(len > m_last->data_len))
1629 m_last->data_len = (uint16_t)(m_last->data_len - len);
1630 m->pkt_len = (m->pkt_len - len);
1635 * Test if mbuf data is contiguous.
1640 * - 1, if all data is contiguous (one segment).
1641 * - 0, if there is several segments.
1643 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
1645 __rte_mbuf_sanity_check(m, 1);
1646 return !!(m->nb_segs == 1);
1650 * @internal used by rte_pktmbuf_read().
1652 const void *__rte_pktmbuf_read(const struct rte_mbuf *m, uint32_t off,
1653 uint32_t len, void *buf);
1656 * Read len data bytes in a mbuf at specified offset.
1658 * If the data is contiguous, return the pointer in the mbuf data, else
1659 * copy the data in the buffer provided by the user and return its
1663 * The pointer to the mbuf.
1665 * The offset of the data in the mbuf.
1667 * The amount of bytes to read.
1669 * The buffer where data is copied if it is not contiguous in mbuf
1670 * data. Its length should be at least equal to the len parameter.
1672 * The pointer to the data, either in the mbuf if it is contiguous,
1673 * or in the user buffer. If mbuf is too small, NULL is returned.
1675 static inline const void *rte_pktmbuf_read(const struct rte_mbuf *m,
1676 uint32_t off, uint32_t len, void *buf)
1678 if (likely(off + len <= rte_pktmbuf_data_len(m)))
1679 return rte_pktmbuf_mtod_offset(m, char *, off);
1681 return __rte_pktmbuf_read(m, off, len, buf);
1685 * Chain an mbuf to another, thereby creating a segmented packet.
1687 * Note: The implementation will do a linear walk over the segments to find
1688 * the tail entry. For cases when there are many segments, it's better to
1689 * chain the entries manually.
1692 * The head of the mbuf chain (the first packet)
1694 * The mbuf to put last in the chain
1698 * - -EOVERFLOW, if the chain segment limit exceeded
1700 static inline int rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail)
1702 struct rte_mbuf *cur_tail;
1704 /* Check for number-of-segments-overflow */
1705 if (head->nb_segs + tail->nb_segs > RTE_MBUF_MAX_NB_SEGS)
1708 /* Chain 'tail' onto the old tail */
1709 cur_tail = rte_pktmbuf_lastseg(head);
1710 cur_tail->next = tail;
1712 /* accumulate number of segments and total length.
1713 * NB: elaborating the addition like this instead of using
1714 * -= allows us to ensure the result type is uint16_t
1715 * avoiding compiler warnings on gcc 8.1 at least */
1716 head->nb_segs = (uint16_t)(head->nb_segs + tail->nb_segs);
1717 head->pkt_len += tail->pkt_len;
1719 /* pkt_len is only set in the head */
1720 tail->pkt_len = tail->data_len;
1727 * @b EXPERIMENTAL: This API may change without prior notice.
1729 * For given input values generate raw tx_offload value.
1730 * Note that it is caller responsibility to make sure that input parameters
1731 * don't exceed maximum bit-field values.
1741 * outer_l3_len value.
1743 * outer_l2_len value.
1747 * raw tx_offload value.
1749 static __rte_always_inline uint64_t
1750 rte_mbuf_tx_offload(uint64_t il2, uint64_t il3, uint64_t il4, uint64_t tso,
1751 uint64_t ol3, uint64_t ol2, uint64_t unused)
1753 return il2 << RTE_MBUF_L2_LEN_OFS |
1754 il3 << RTE_MBUF_L3_LEN_OFS |
1755 il4 << RTE_MBUF_L4_LEN_OFS |
1756 tso << RTE_MBUF_TSO_SEGSZ_OFS |
1757 ol3 << RTE_MBUF_OUTL3_LEN_OFS |
1758 ol2 << RTE_MBUF_OUTL2_LEN_OFS |
1759 unused << RTE_MBUF_TXOFLD_UNUSED_OFS;
1763 * Validate general requirements for Tx offload in mbuf.
1765 * This function checks correctness and completeness of Tx offload settings.
1768 * The packet mbuf to be validated.
1770 * 0 if packet is valid
1773 rte_validate_tx_offload(const struct rte_mbuf *m)
1775 uint64_t ol_flags = m->ol_flags;
1777 /* Does packet set any of available offloads? */
1778 if (!(ol_flags & PKT_TX_OFFLOAD_MASK))
1781 /* IP checksum can be counted only for IPv4 packet */
1782 if ((ol_flags & PKT_TX_IP_CKSUM) && (ol_flags & PKT_TX_IPV6))
1785 /* IP type not set when required */
1786 if (ol_flags & (PKT_TX_L4_MASK | PKT_TX_TCP_SEG))
1787 if (!(ol_flags & (PKT_TX_IPV4 | PKT_TX_IPV6)))
1790 /* Check requirements for TSO packet */
1791 if (ol_flags & PKT_TX_TCP_SEG)
1792 if ((m->tso_segsz == 0) ||
1793 ((ol_flags & PKT_TX_IPV4) &&
1794 !(ol_flags & PKT_TX_IP_CKSUM)))
1797 /* PKT_TX_OUTER_IP_CKSUM set for non outer IPv4 packet. */
1798 if ((ol_flags & PKT_TX_OUTER_IP_CKSUM) &&
1799 !(ol_flags & PKT_TX_OUTER_IPV4))
1806 * @internal used by rte_pktmbuf_linearize().
1808 int __rte_pktmbuf_linearize(struct rte_mbuf *mbuf);
1811 * Linearize data in mbuf.
1813 * This function moves the mbuf data in the first segment if there is enough
1814 * tailroom. The subsequent segments are unchained and freed.
1823 rte_pktmbuf_linearize(struct rte_mbuf *mbuf)
1825 if (rte_pktmbuf_is_contiguous(mbuf))
1827 return __rte_pktmbuf_linearize(mbuf);
1831 * Dump an mbuf structure to a file.
1833 * Dump all fields for the given packet mbuf and all its associated
1834 * segments (in the case of a chained buffer).
1837 * A pointer to a file for output
1841 * If dump_len != 0, also dump the "dump_len" first data bytes of
1844 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
1847 * Get the value of mbuf sched queue_id field.
1849 static inline uint32_t
1850 rte_mbuf_sched_queue_get(const struct rte_mbuf *m)
1852 return m->hash.sched.queue_id;
1856 * Get the value of mbuf sched traffic_class field.
1858 static inline uint8_t
1859 rte_mbuf_sched_traffic_class_get(const struct rte_mbuf *m)
1861 return m->hash.sched.traffic_class;
1865 * Get the value of mbuf sched color field.
1867 static inline uint8_t
1868 rte_mbuf_sched_color_get(const struct rte_mbuf *m)
1870 return m->hash.sched.color;
1874 * Get the values of mbuf sched queue_id, traffic_class and color.
1879 * Returns the queue id
1880 * @param traffic_class
1881 * Returns the traffic class id
1883 * Returns the colour id
1886 rte_mbuf_sched_get(const struct rte_mbuf *m, uint32_t *queue_id,
1887 uint8_t *traffic_class,
1890 struct rte_mbuf_sched sched = m->hash.sched;
1892 *queue_id = sched.queue_id;
1893 *traffic_class = sched.traffic_class;
1894 *color = sched.color;
1898 * Set the mbuf sched queue_id to the defined value.
1901 rte_mbuf_sched_queue_set(struct rte_mbuf *m, uint32_t queue_id)
1903 m->hash.sched.queue_id = queue_id;
1907 * Set the mbuf sched traffic_class id to the defined value.
1910 rte_mbuf_sched_traffic_class_set(struct rte_mbuf *m, uint8_t traffic_class)
1912 m->hash.sched.traffic_class = traffic_class;
1916 * Set the mbuf sched color id to the defined value.
1919 rte_mbuf_sched_color_set(struct rte_mbuf *m, uint8_t color)
1921 m->hash.sched.color = color;
1925 * Set the mbuf sched queue_id, traffic_class and color.
1930 * Queue id value to be set
1931 * @param traffic_class
1932 * Traffic class id value to be set
1934 * Color id to be set
1937 rte_mbuf_sched_set(struct rte_mbuf *m, uint32_t queue_id,
1938 uint8_t traffic_class,
1941 m->hash.sched = (struct rte_mbuf_sched){
1942 .queue_id = queue_id,
1943 .traffic_class = traffic_class,
1953 #endif /* _RTE_MBUF_H_ */