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;
326 #ifdef RTE_LIBRTE_MBUF_DEBUG
328 /** check mbuf type in debug mode */
329 #define __rte_mbuf_sanity_check(m, is_h) rte_mbuf_sanity_check(m, is_h)
331 #else /* RTE_LIBRTE_MBUF_DEBUG */
333 /** check mbuf type in debug mode */
334 #define __rte_mbuf_sanity_check(m, is_h) do { } while (0)
336 #endif /* RTE_LIBRTE_MBUF_DEBUG */
338 #ifdef RTE_MBUF_REFCNT_ATOMIC
341 * Reads the value of an mbuf's refcnt.
345 * Reference count number.
347 static inline uint16_t
348 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
350 return (uint16_t)(rte_atomic16_read(&m->refcnt_atomic));
354 * Sets an mbuf's refcnt to a defined value.
361 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
363 rte_atomic16_set(&m->refcnt_atomic, (int16_t)new_value);
367 static inline uint16_t
368 __rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
370 return (uint16_t)(rte_atomic16_add_return(&m->refcnt_atomic, value));
374 * Adds given value to an mbuf's refcnt and returns its new value.
378 * Value to add/subtract
382 static inline uint16_t
383 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
386 * The atomic_add is an expensive operation, so we don't want to
387 * call it in the case where we know we are the unique holder of
388 * this mbuf (i.e. ref_cnt == 1). Otherwise, an atomic
389 * operation has to be used because concurrent accesses on the
390 * reference counter can occur.
392 if (likely(rte_mbuf_refcnt_read(m) == 1)) {
394 rte_mbuf_refcnt_set(m, (uint16_t)value);
395 return (uint16_t)value;
398 return __rte_mbuf_refcnt_update(m, value);
401 #else /* ! RTE_MBUF_REFCNT_ATOMIC */
404 static inline uint16_t
405 __rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
407 m->refcnt = (uint16_t)(m->refcnt + value);
412 * Adds given value to an mbuf's refcnt and returns its new value.
414 static inline uint16_t
415 rte_mbuf_refcnt_update(struct rte_mbuf *m, int16_t value)
417 return __rte_mbuf_refcnt_update(m, value);
421 * Reads the value of an mbuf's refcnt.
423 static inline uint16_t
424 rte_mbuf_refcnt_read(const struct rte_mbuf *m)
430 * Sets an mbuf's refcnt to the defined value.
433 rte_mbuf_refcnt_set(struct rte_mbuf *m, uint16_t new_value)
435 m->refcnt = new_value;
438 #endif /* RTE_MBUF_REFCNT_ATOMIC */
441 * Reads the refcnt of an external buffer.
444 * Shared data of the external buffer.
446 * Reference count number.
448 static inline uint16_t
449 rte_mbuf_ext_refcnt_read(const struct rte_mbuf_ext_shared_info *shinfo)
451 return (uint16_t)(rte_atomic16_read(&shinfo->refcnt_atomic));
455 * Set refcnt of an external buffer.
458 * Shared data of the external buffer.
463 rte_mbuf_ext_refcnt_set(struct rte_mbuf_ext_shared_info *shinfo,
466 rte_atomic16_set(&shinfo->refcnt_atomic, (int16_t)new_value);
470 * Add given value to refcnt of an external buffer and return its new
474 * Shared data of the external buffer.
476 * Value to add/subtract
480 static inline uint16_t
481 rte_mbuf_ext_refcnt_update(struct rte_mbuf_ext_shared_info *shinfo,
484 if (likely(rte_mbuf_ext_refcnt_read(shinfo) == 1)) {
486 rte_mbuf_ext_refcnt_set(shinfo, (uint16_t)value);
487 return (uint16_t)value;
490 return (uint16_t)rte_atomic16_add_return(&shinfo->refcnt_atomic, value);
494 #define RTE_MBUF_PREFETCH_TO_FREE(m) do { \
501 * Sanity checks on an mbuf.
503 * Check the consistency of the given mbuf. The function will cause a
504 * panic if corruption is detected.
507 * The mbuf to be checked.
509 * True if the mbuf is a packet header, false if it is a sub-segment
510 * of a packet (in this case, some fields like nb_segs are not checked)
513 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header);
516 * Sanity checks on a mbuf.
518 * Almost like rte_mbuf_sanity_check(), but this function gives the reason
519 * if corruption is detected rather than panic.
522 * The mbuf to be checked.
524 * True if the mbuf is a packet header, false if it is a sub-segment
525 * of a packet (in this case, some fields like nb_segs are not checked)
527 * A reference to a string pointer where to store the reason why a mbuf is
528 * considered invalid.
530 * - 0 if no issue has been found, reason is left untouched.
531 * - -1 if a problem is detected, reason then points to a string describing
532 * the reason why the mbuf is deemed invalid.
535 int rte_mbuf_check(const struct rte_mbuf *m, int is_header,
536 const char **reason);
538 #define MBUF_RAW_ALLOC_CHECK(m) do { \
539 RTE_ASSERT(rte_mbuf_refcnt_read(m) == 1); \
540 RTE_ASSERT((m)->next == NULL); \
541 RTE_ASSERT((m)->nb_segs == 1); \
542 __rte_mbuf_sanity_check(m, 0); \
546 * Allocate an uninitialized mbuf from mempool *mp*.
548 * This function can be used by PMDs (especially in RX functions) to
549 * allocate an uninitialized mbuf. The driver is responsible of
550 * initializing all the required fields. See rte_pktmbuf_reset().
551 * For standard needs, prefer rte_pktmbuf_alloc().
553 * The caller can expect that the following fields of the mbuf structure
554 * are initialized: buf_addr, buf_iova, buf_len, refcnt=1, nb_segs=1,
555 * next=NULL, pool, priv_size. The other fields must be initialized
559 * The mempool from which mbuf is allocated.
561 * - The pointer to the new mbuf on success.
562 * - NULL if allocation failed.
564 static inline struct rte_mbuf *rte_mbuf_raw_alloc(struct rte_mempool *mp)
568 if (rte_mempool_get(mp, (void **)&m) < 0)
570 MBUF_RAW_ALLOC_CHECK(m);
575 * Put mbuf back into its original mempool.
577 * The caller must ensure that the mbuf is direct and properly
578 * reinitialized (refcnt=1, next=NULL, nb_segs=1), as done by
579 * rte_pktmbuf_prefree_seg().
581 * This function should be used with care, when optimization is
582 * required. For standard needs, prefer rte_pktmbuf_free() or
583 * rte_pktmbuf_free_seg().
586 * The mbuf to be freed.
588 static __rte_always_inline void
589 rte_mbuf_raw_free(struct rte_mbuf *m)
591 RTE_ASSERT(RTE_MBUF_DIRECT(m));
592 RTE_ASSERT(rte_mbuf_refcnt_read(m) == 1);
593 RTE_ASSERT(m->next == NULL);
594 RTE_ASSERT(m->nb_segs == 1);
595 __rte_mbuf_sanity_check(m, 0);
596 rte_mempool_put(m->pool, m);
600 * The packet mbuf constructor.
602 * This function initializes some fields in the mbuf structure that are
603 * not modified by the user once created (origin pool, buffer start
604 * address, and so on). This function is given as a callback function to
605 * rte_mempool_obj_iter() or rte_mempool_create() at pool creation time.
608 * The mempool from which mbufs originate.
610 * A pointer that can be used by the user to retrieve useful information
611 * for mbuf initialization. This pointer is the opaque argument passed to
612 * rte_mempool_obj_iter() or rte_mempool_create().
614 * The mbuf to initialize.
616 * The index of the mbuf in the pool table.
618 void rte_pktmbuf_init(struct rte_mempool *mp, void *opaque_arg,
619 void *m, unsigned i);
623 * A packet mbuf pool constructor.
625 * This function initializes the mempool private data in the case of a
626 * pktmbuf pool. This private data is needed by the driver. The
627 * function must be called on the mempool before it is used, or it
628 * can be given as a callback function to rte_mempool_create() at
629 * pool creation. It can be extended by the user, for example, to
630 * provide another packet size.
633 * The mempool from which mbufs originate.
635 * A pointer that can be used by the user to retrieve useful information
636 * for mbuf initialization. This pointer is the opaque argument passed to
637 * rte_mempool_create().
639 void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
642 * Create a mbuf pool.
644 * This function creates and initializes a packet mbuf pool. It is
645 * a wrapper to rte_mempool functions.
648 * The name of the mbuf pool.
650 * The number of elements in the mbuf pool. The optimum size (in terms
651 * of memory usage) for a mempool is when n is a power of two minus one:
654 * Size of the per-core object cache. See rte_mempool_create() for
657 * Size of application private are between the rte_mbuf structure
658 * and the data buffer. This value must be aligned to RTE_MBUF_PRIV_ALIGN.
659 * @param data_room_size
660 * Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
662 * The socket identifier where the memory should be allocated. The
663 * value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
666 * The pointer to the new allocated mempool, on success. NULL on error
667 * with rte_errno set appropriately. Possible rte_errno values include:
668 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
669 * - E_RTE_SECONDARY - function was called from a secondary process instance
670 * - EINVAL - cache size provided is too large, or priv_size is not aligned.
671 * - ENOSPC - the maximum number of memzones has already been allocated
672 * - EEXIST - a memzone with the same name already exists
673 * - ENOMEM - no appropriate memory area found in which to create memzone
676 rte_pktmbuf_pool_create(const char *name, unsigned n,
677 unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
681 * Create a mbuf pool with a given mempool ops name
683 * This function creates and initializes a packet mbuf pool. It is
684 * a wrapper to rte_mempool functions.
687 * The name of the mbuf pool.
689 * The number of elements in the mbuf pool. The optimum size (in terms
690 * of memory usage) for a mempool is when n is a power of two minus one:
693 * Size of the per-core object cache. See rte_mempool_create() for
696 * Size of application private are between the rte_mbuf structure
697 * and the data buffer. This value must be aligned to RTE_MBUF_PRIV_ALIGN.
698 * @param data_room_size
699 * Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
701 * The socket identifier where the memory should be allocated. The
702 * value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
705 * The mempool ops name to be used for this mempool instead of
706 * default mempool. The value can be *NULL* to use default mempool.
708 * The pointer to the new allocated mempool, on success. NULL on error
709 * with rte_errno set appropriately. Possible rte_errno values include:
710 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
711 * - E_RTE_SECONDARY - function was called from a secondary process instance
712 * - EINVAL - cache size provided is too large, or priv_size is not aligned.
713 * - ENOSPC - the maximum number of memzones has already been allocated
714 * - EEXIST - a memzone with the same name already exists
715 * - ENOMEM - no appropriate memory area found in which to create memzone
718 rte_pktmbuf_pool_create_by_ops(const char *name, unsigned int n,
719 unsigned int cache_size, uint16_t priv_size, uint16_t data_room_size,
720 int socket_id, const char *ops_name);
723 * Get the data room size of mbufs stored in a pktmbuf_pool
725 * The data room size is the amount of data that can be stored in a
726 * mbuf including the headroom (RTE_PKTMBUF_HEADROOM).
729 * The packet mbuf pool.
731 * The data room size of mbufs stored in this mempool.
733 static inline uint16_t
734 rte_pktmbuf_data_room_size(struct rte_mempool *mp)
736 struct rte_pktmbuf_pool_private *mbp_priv;
738 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
739 return mbp_priv->mbuf_data_room_size;
743 * Get the application private size of mbufs stored in a pktmbuf_pool
745 * The private size of mbuf is a zone located between the rte_mbuf
746 * structure and the data buffer where an application can store data
747 * associated to a packet.
750 * The packet mbuf pool.
752 * The private size of mbufs stored in this mempool.
754 static inline uint16_t
755 rte_pktmbuf_priv_size(struct rte_mempool *mp)
757 struct rte_pktmbuf_pool_private *mbp_priv;
759 mbp_priv = (struct rte_pktmbuf_pool_private *)rte_mempool_get_priv(mp);
760 return mbp_priv->mbuf_priv_size;
764 * Reset the data_off field of a packet mbuf to its default value.
766 * The given mbuf must have only one segment, which should be empty.
769 * The packet mbuf's data_off field has to be reset.
771 static inline void rte_pktmbuf_reset_headroom(struct rte_mbuf *m)
773 m->data_off = (uint16_t)RTE_MIN((uint16_t)RTE_PKTMBUF_HEADROOM,
774 (uint16_t)m->buf_len);
778 * Reset the fields of a packet mbuf to their default values.
780 * The given mbuf must have only one segment.
783 * The packet mbuf to be reset.
785 #define MBUF_INVALID_PORT UINT16_MAX
787 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
793 m->vlan_tci_outer = 0;
795 m->port = MBUF_INVALID_PORT;
799 rte_pktmbuf_reset_headroom(m);
802 __rte_mbuf_sanity_check(m, 1);
806 * Allocate a new mbuf from a mempool.
808 * This new mbuf contains one segment, which has a length of 0. The pointer
809 * to data is initialized to have some bytes of headroom in the buffer
810 * (if buffer size allows).
813 * The mempool from which the mbuf is allocated.
815 * - The pointer to the new mbuf on success.
816 * - NULL if allocation failed.
818 static inline struct rte_mbuf *rte_pktmbuf_alloc(struct rte_mempool *mp)
821 if ((m = rte_mbuf_raw_alloc(mp)) != NULL)
822 rte_pktmbuf_reset(m);
827 * Allocate a bulk of mbufs, initialize refcnt and reset the fields to default
831 * The mempool from which mbufs are allocated.
833 * Array of pointers to mbufs
838 * - -ENOENT: Not enough entries in the mempool; no mbufs are retrieved.
840 static inline int rte_pktmbuf_alloc_bulk(struct rte_mempool *pool,
841 struct rte_mbuf **mbufs, unsigned count)
846 rc = rte_mempool_get_bulk(pool, (void **)mbufs, count);
850 /* To understand duff's device on loop unwinding optimization, see
851 * https://en.wikipedia.org/wiki/Duff's_device.
852 * Here while() loop is used rather than do() while{} to avoid extra
853 * check if count is zero.
857 while (idx != count) {
858 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
859 rte_pktmbuf_reset(mbufs[idx]);
863 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
864 rte_pktmbuf_reset(mbufs[idx]);
868 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
869 rte_pktmbuf_reset(mbufs[idx]);
873 MBUF_RAW_ALLOC_CHECK(mbufs[idx]);
874 rte_pktmbuf_reset(mbufs[idx]);
883 * Initialize shared data at the end of an external buffer before attaching
884 * to a mbuf by ``rte_pktmbuf_attach_extbuf()``. This is not a mandatory
885 * initialization but a helper function to simply spare a few bytes at the
886 * end of the buffer for shared data. If shared data is allocated
887 * separately, this should not be called but application has to properly
888 * initialize the shared data according to its need.
890 * Free callback and its argument is saved and the refcnt is set to 1.
893 * The value of buf_len will be reduced to RTE_PTR_DIFF(shinfo, buf_addr)
894 * after this initialization. This shall be used for
895 * ``rte_pktmbuf_attach_extbuf()``
898 * The pointer to the external buffer.
899 * @param [in,out] buf_len
900 * The pointer to length of the external buffer. Input value must be
901 * larger than the size of ``struct rte_mbuf_ext_shared_info`` and
902 * padding for alignment. If not enough, this function will return NULL.
903 * Adjusted buffer length will be returned through this pointer.
905 * Free callback function to call when the external buffer needs to be
908 * Argument for the free callback function.
911 * A pointer to the initialized shared data on success, return NULL
914 static inline struct rte_mbuf_ext_shared_info *
915 rte_pktmbuf_ext_shinfo_init_helper(void *buf_addr, uint16_t *buf_len,
916 rte_mbuf_extbuf_free_callback_t free_cb, void *fcb_opaque)
918 struct rte_mbuf_ext_shared_info *shinfo;
919 void *buf_end = RTE_PTR_ADD(buf_addr, *buf_len);
922 addr = RTE_PTR_ALIGN_FLOOR(RTE_PTR_SUB(buf_end, sizeof(*shinfo)),
924 if (addr <= buf_addr)
927 shinfo = (struct rte_mbuf_ext_shared_info *)addr;
928 shinfo->free_cb = free_cb;
929 shinfo->fcb_opaque = fcb_opaque;
930 rte_mbuf_ext_refcnt_set(shinfo, 1);
932 *buf_len = (uint16_t)RTE_PTR_DIFF(shinfo, buf_addr);
937 * Attach an external buffer to a mbuf.
939 * User-managed anonymous buffer can be attached to an mbuf. When attaching
940 * it, corresponding free callback function and its argument should be
941 * provided via shinfo. This callback function will be called once all the
942 * mbufs are detached from the buffer (refcnt becomes zero).
944 * The headroom length of the attaching mbuf will be set to zero and this
945 * can be properly adjusted after attachment. For example, ``rte_pktmbuf_adj()``
946 * or ``rte_pktmbuf_reset_headroom()`` might be used.
948 * Similarly, the packet length is initialized to 0. If the buffer contains
949 * data, the user has to adjust ``data_len`` and the ``pkt_len`` field of
950 * the mbuf accordingly.
952 * More mbufs can be attached to the same external buffer by
953 * ``rte_pktmbuf_attach()`` once the external buffer has been attached by
956 * Detachment can be done by either ``rte_pktmbuf_detach_extbuf()`` or
957 * ``rte_pktmbuf_detach()``.
959 * Memory for shared data must be provided and user must initialize all of
960 * the content properly, especially free callback and refcnt. The pointer
961 * of shared data will be stored in m->shinfo.
962 * ``rte_pktmbuf_ext_shinfo_init_helper`` can help to simply spare a few
963 * bytes at the end of buffer for the shared data, store free callback and
964 * its argument and set the refcnt to 1. The following is an example:
966 * struct rte_mbuf_ext_shared_info *shinfo =
967 * rte_pktmbuf_ext_shinfo_init_helper(buf_addr, &buf_len,
969 * rte_pktmbuf_attach_extbuf(m, buf_addr, buf_iova, buf_len, shinfo);
970 * rte_pktmbuf_reset_headroom(m);
971 * rte_pktmbuf_adj(m, data_len);
973 * Attaching an external buffer is quite similar to mbuf indirection in
974 * replacing buffer addresses and length of a mbuf, but a few differences:
975 * - When an indirect mbuf is attached, refcnt of the direct mbuf would be
976 * 2 as long as the direct mbuf itself isn't freed after the attachment.
977 * In such cases, the buffer area of a direct mbuf must be read-only. But
978 * external buffer has its own refcnt and it starts from 1. Unless
979 * multiple mbufs are attached to a mbuf having an external buffer, the
980 * external buffer is writable.
981 * - There's no need to allocate buffer from a mempool. Any buffer can be
982 * attached with appropriate free callback and its IO address.
983 * - Smaller metadata is required to maintain shared data such as refcnt.
986 * The pointer to the mbuf.
988 * The pointer to the external buffer.
990 * IO address of the external buffer.
992 * The size of the external buffer.
994 * User-provided memory for shared data of the external buffer.
997 rte_pktmbuf_attach_extbuf(struct rte_mbuf *m, void *buf_addr,
998 rte_iova_t buf_iova, uint16_t buf_len,
999 struct rte_mbuf_ext_shared_info *shinfo)
1001 /* mbuf should not be read-only */
1002 RTE_ASSERT(RTE_MBUF_DIRECT(m) && rte_mbuf_refcnt_read(m) == 1);
1003 RTE_ASSERT(shinfo->free_cb != NULL);
1005 m->buf_addr = buf_addr;
1006 m->buf_iova = buf_iova;
1007 m->buf_len = buf_len;
1012 m->ol_flags |= EXT_ATTACHED_MBUF;
1017 * Detach the external buffer attached to a mbuf, same as
1018 * ``rte_pktmbuf_detach()``
1021 * The mbuf having external buffer.
1023 #define rte_pktmbuf_detach_extbuf(m) rte_pktmbuf_detach(m)
1026 * Copy dynamic fields from msrc to mdst.
1029 * The destination mbuf.
1034 rte_mbuf_dynfield_copy(struct rte_mbuf *mdst, const struct rte_mbuf *msrc)
1036 memcpy(&mdst->dynfield1, msrc->dynfield1, sizeof(mdst->dynfield1));
1041 __rte_pktmbuf_copy_hdr(struct rte_mbuf *mdst, const struct rte_mbuf *msrc)
1043 mdst->port = msrc->port;
1044 mdst->vlan_tci = msrc->vlan_tci;
1045 mdst->vlan_tci_outer = msrc->vlan_tci_outer;
1046 mdst->tx_offload = msrc->tx_offload;
1047 mdst->hash = msrc->hash;
1048 mdst->packet_type = msrc->packet_type;
1049 mdst->timestamp = msrc->timestamp;
1050 rte_mbuf_dynfield_copy(mdst, msrc);
1054 * Attach packet mbuf to another packet mbuf.
1056 * If the mbuf we are attaching to isn't a direct buffer and is attached to
1057 * an external buffer, the mbuf being attached will be attached to the
1058 * external buffer instead of mbuf indirection.
1060 * Otherwise, the mbuf will be indirectly attached. After attachment we
1061 * refer the mbuf we attached as 'indirect', while mbuf we attached to as
1062 * 'direct'. The direct mbuf's reference counter is incremented.
1064 * Right now, not supported:
1065 * - attachment for already indirect mbuf (e.g. - mi has to be direct).
1066 * - mbuf we trying to attach (mi) is used by someone else
1067 * e.g. it's reference counter is greater then 1.
1070 * The indirect packet mbuf.
1072 * The packet mbuf we're attaching to.
1074 static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *m)
1076 RTE_ASSERT(RTE_MBUF_DIRECT(mi) &&
1077 rte_mbuf_refcnt_read(mi) == 1);
1079 if (RTE_MBUF_HAS_EXTBUF(m)) {
1080 rte_mbuf_ext_refcnt_update(m->shinfo, 1);
1081 mi->ol_flags = m->ol_flags;
1082 mi->shinfo = m->shinfo;
1084 /* if m is not direct, get the mbuf that embeds the data */
1085 rte_mbuf_refcnt_update(rte_mbuf_from_indirect(m), 1);
1086 mi->priv_size = m->priv_size;
1087 mi->ol_flags = m->ol_flags | IND_ATTACHED_MBUF;
1090 __rte_pktmbuf_copy_hdr(mi, m);
1092 mi->data_off = m->data_off;
1093 mi->data_len = m->data_len;
1094 mi->buf_iova = m->buf_iova;
1095 mi->buf_addr = m->buf_addr;
1096 mi->buf_len = m->buf_len;
1099 mi->pkt_len = mi->data_len;
1102 __rte_mbuf_sanity_check(mi, 1);
1103 __rte_mbuf_sanity_check(m, 0);
1107 * @internal used by rte_pktmbuf_detach().
1109 * Decrement the reference counter of the external buffer. When the
1110 * reference counter becomes 0, the buffer is freed by pre-registered
1114 __rte_pktmbuf_free_extbuf(struct rte_mbuf *m)
1116 RTE_ASSERT(RTE_MBUF_HAS_EXTBUF(m));
1117 RTE_ASSERT(m->shinfo != NULL);
1119 if (rte_mbuf_ext_refcnt_update(m->shinfo, -1) == 0)
1120 m->shinfo->free_cb(m->buf_addr, m->shinfo->fcb_opaque);
1124 * @internal used by rte_pktmbuf_detach().
1126 * Decrement the direct mbuf's reference counter. When the reference
1127 * counter becomes 0, the direct mbuf is freed.
1130 __rte_pktmbuf_free_direct(struct rte_mbuf *m)
1132 struct rte_mbuf *md;
1134 RTE_ASSERT(RTE_MBUF_CLONED(m));
1136 md = rte_mbuf_from_indirect(m);
1138 if (rte_mbuf_refcnt_update(md, -1) == 0) {
1141 rte_mbuf_refcnt_set(md, 1);
1142 rte_mbuf_raw_free(md);
1147 * Detach a packet mbuf from external buffer or direct buffer.
1149 * - decrement refcnt and free the external/direct buffer if refcnt
1151 * - restore original mbuf address and length values.
1152 * - reset pktmbuf data and data_len to their default values.
1154 * All other fields of the given packet mbuf will be left intact.
1157 * The indirect attached packet mbuf.
1159 static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
1161 struct rte_mempool *mp = m->pool;
1162 uint32_t mbuf_size, buf_len;
1165 if (RTE_MBUF_HAS_EXTBUF(m))
1166 __rte_pktmbuf_free_extbuf(m);
1168 __rte_pktmbuf_free_direct(m);
1170 priv_size = rte_pktmbuf_priv_size(mp);
1171 mbuf_size = (uint32_t)(sizeof(struct rte_mbuf) + priv_size);
1172 buf_len = rte_pktmbuf_data_room_size(mp);
1174 m->priv_size = priv_size;
1175 m->buf_addr = (char *)m + mbuf_size;
1176 m->buf_iova = rte_mempool_virt2iova(m) + mbuf_size;
1177 m->buf_len = (uint16_t)buf_len;
1178 rte_pktmbuf_reset_headroom(m);
1184 * Decrease reference counter and unlink a mbuf segment
1186 * This function does the same than a free, except that it does not
1187 * return the segment to its pool.
1188 * It decreases the reference counter, and if it reaches 0, it is
1189 * detached from its parent for an indirect mbuf.
1192 * The mbuf to be unlinked
1194 * - (m) if it is the last reference. It can be recycled or freed.
1195 * - (NULL) if the mbuf still has remaining references on it.
1197 static __rte_always_inline struct rte_mbuf *
1198 rte_pktmbuf_prefree_seg(struct rte_mbuf *m)
1200 __rte_mbuf_sanity_check(m, 0);
1202 if (likely(rte_mbuf_refcnt_read(m) == 1)) {
1204 if (!RTE_MBUF_DIRECT(m))
1205 rte_pktmbuf_detach(m);
1207 if (m->next != NULL) {
1214 } else if (__rte_mbuf_refcnt_update(m, -1) == 0) {
1216 if (!RTE_MBUF_DIRECT(m))
1217 rte_pktmbuf_detach(m);
1219 if (m->next != NULL) {
1223 rte_mbuf_refcnt_set(m, 1);
1231 * Free a segment of a packet mbuf into its original mempool.
1233 * Free an mbuf, without parsing other segments in case of chained
1237 * The packet mbuf segment to be freed.
1239 static __rte_always_inline void
1240 rte_pktmbuf_free_seg(struct rte_mbuf *m)
1242 m = rte_pktmbuf_prefree_seg(m);
1243 if (likely(m != NULL))
1244 rte_mbuf_raw_free(m);
1248 * Free a packet mbuf back into its original mempool.
1250 * Free an mbuf, and all its segments in case of chained buffers. Each
1251 * segment is added back into its original mempool.
1254 * The packet mbuf to be freed. If NULL, the function does nothing.
1256 static inline void rte_pktmbuf_free(struct rte_mbuf *m)
1258 struct rte_mbuf *m_next;
1261 __rte_mbuf_sanity_check(m, 1);
1265 rte_pktmbuf_free_seg(m);
1271 * Free a bulk of packet mbufs back into their original mempools.
1273 * Free a bulk of mbufs, and all their segments in case of chained buffers.
1274 * Each segment is added back into its original mempool.
1277 * Array of pointers to packet mbufs.
1278 * The array may contain NULL pointers.
1283 void rte_pktmbuf_free_bulk(struct rte_mbuf **mbufs, unsigned int count);
1286 * Create a "clone" of the given packet mbuf.
1288 * Walks through all segments of the given packet mbuf, and for each of them:
1289 * - Creates a new packet mbuf from the given pool.
1290 * - Attaches newly created mbuf to the segment.
1291 * Then updates pkt_len and nb_segs of the "clone" packet mbuf to match values
1292 * from the original packet mbuf.
1295 * The packet mbuf to be cloned.
1297 * The mempool from which the "clone" mbufs are allocated.
1299 * - The pointer to the new "clone" mbuf on success.
1300 * - NULL if allocation fails.
1303 rte_pktmbuf_clone(struct rte_mbuf *md, struct rte_mempool *mp);
1306 * Create a full copy of a given packet mbuf.
1308 * Copies all the data from a given packet mbuf to a newly allocated
1309 * set of mbufs. The private data are is not copied.
1312 * The packet mbuf to be copiedd.
1314 * The mempool from which the "clone" mbufs are allocated.
1316 * The number of bytes to skip before copying.
1317 * If the mbuf does not have that many bytes, it is an error
1318 * and NULL is returned.
1320 * The upper limit on bytes to copy. Passing UINT32_MAX
1321 * means all data (after offset).
1323 * - The pointer to the new "clone" mbuf on success.
1324 * - NULL if allocation fails.
1328 rte_pktmbuf_copy(const struct rte_mbuf *m, struct rte_mempool *mp,
1329 uint32_t offset, uint32_t length);
1332 * Adds given value to the refcnt of all packet mbuf segments.
1334 * Walks through all segments of given packet mbuf and for each of them
1335 * invokes rte_mbuf_refcnt_update().
1338 * The packet mbuf whose refcnt to be updated.
1340 * The value to add to the mbuf's segments refcnt.
1342 static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
1344 __rte_mbuf_sanity_check(m, 1);
1347 rte_mbuf_refcnt_update(m, v);
1348 } while ((m = m->next) != NULL);
1352 * Get the headroom in a packet mbuf.
1357 * The length of the headroom.
1359 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
1361 __rte_mbuf_sanity_check(m, 0);
1366 * Get the tailroom of a packet mbuf.
1371 * The length of the tailroom.
1373 static inline uint16_t rte_pktmbuf_tailroom(const struct rte_mbuf *m)
1375 __rte_mbuf_sanity_check(m, 0);
1376 return (uint16_t)(m->buf_len - rte_pktmbuf_headroom(m) -
1381 * Get the last segment of the packet.
1386 * The last segment of the given mbuf.
1388 static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
1390 __rte_mbuf_sanity_check(m, 1);
1391 while (m->next != NULL)
1397 #define rte_pktmbuf_mtophys_offset(m, o) \
1398 rte_pktmbuf_iova_offset(m, o)
1401 #define rte_pktmbuf_mtophys(m) rte_pktmbuf_iova(m)
1404 * A macro that returns the length of the packet.
1406 * The value can be read or assigned.
1411 #define rte_pktmbuf_pkt_len(m) ((m)->pkt_len)
1414 * A macro that returns the length of the segment.
1416 * The value can be read or assigned.
1421 #define rte_pktmbuf_data_len(m) ((m)->data_len)
1424 * Prepend len bytes to an mbuf data area.
1426 * Returns a pointer to the new
1427 * data start address. If there is not enough headroom in the first
1428 * segment, the function will return NULL, without modifying the mbuf.
1433 * The amount of data to prepend (in bytes).
1435 * A pointer to the start of the newly prepended data, or
1436 * NULL if there is not enough headroom space in the first segment
1438 static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
1441 __rte_mbuf_sanity_check(m, 1);
1443 if (unlikely(len > rte_pktmbuf_headroom(m)))
1446 /* NB: elaborating the subtraction like this instead of using
1447 * -= allows us to ensure the result type is uint16_t
1448 * avoiding compiler warnings on gcc 8.1 at least */
1449 m->data_off = (uint16_t)(m->data_off - len);
1450 m->data_len = (uint16_t)(m->data_len + len);
1451 m->pkt_len = (m->pkt_len + len);
1453 return (char *)m->buf_addr + m->data_off;
1457 * Append len bytes to an mbuf.
1459 * Append len bytes to an mbuf and return a pointer to the start address
1460 * of the added data. If there is not enough tailroom in the last
1461 * segment, the function will return NULL, without modifying the mbuf.
1466 * The amount of data to append (in bytes).
1468 * A pointer to the start of the newly appended data, or
1469 * NULL if there is not enough tailroom space in the last segment
1471 static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
1474 struct rte_mbuf *m_last;
1476 __rte_mbuf_sanity_check(m, 1);
1478 m_last = rte_pktmbuf_lastseg(m);
1479 if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
1482 tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
1483 m_last->data_len = (uint16_t)(m_last->data_len + len);
1484 m->pkt_len = (m->pkt_len + len);
1485 return (char*) tail;
1489 * Remove len bytes at the beginning of an mbuf.
1491 * Returns a pointer to the start address of the new data area. If the
1492 * length is greater than the length of the first segment, then the
1493 * function will fail and return NULL, without modifying the mbuf.
1498 * The amount of data to remove (in bytes).
1500 * A pointer to the new start of the data.
1502 static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
1504 __rte_mbuf_sanity_check(m, 1);
1506 if (unlikely(len > m->data_len))
1509 /* NB: elaborating the addition like this instead of using
1510 * += allows us to ensure the result type is uint16_t
1511 * avoiding compiler warnings on gcc 8.1 at least */
1512 m->data_len = (uint16_t)(m->data_len - len);
1513 m->data_off = (uint16_t)(m->data_off + len);
1514 m->pkt_len = (m->pkt_len - len);
1515 return (char *)m->buf_addr + m->data_off;
1519 * Remove len bytes of data at the end of the mbuf.
1521 * If the length is greater than the length of the last segment, the
1522 * function will fail and return -1 without modifying the mbuf.
1527 * The amount of data to remove (in bytes).
1532 static inline int rte_pktmbuf_trim(struct rte_mbuf *m, uint16_t len)
1534 struct rte_mbuf *m_last;
1536 __rte_mbuf_sanity_check(m, 1);
1538 m_last = rte_pktmbuf_lastseg(m);
1539 if (unlikely(len > m_last->data_len))
1542 m_last->data_len = (uint16_t)(m_last->data_len - len);
1543 m->pkt_len = (m->pkt_len - len);
1548 * Test if mbuf data is contiguous.
1553 * - 1, if all data is contiguous (one segment).
1554 * - 0, if there is several segments.
1556 static inline int rte_pktmbuf_is_contiguous(const struct rte_mbuf *m)
1558 __rte_mbuf_sanity_check(m, 1);
1559 return !!(m->nb_segs == 1);
1563 * @internal used by rte_pktmbuf_read().
1565 const void *__rte_pktmbuf_read(const struct rte_mbuf *m, uint32_t off,
1566 uint32_t len, void *buf);
1569 * Read len data bytes in a mbuf at specified offset.
1571 * If the data is contiguous, return the pointer in the mbuf data, else
1572 * copy the data in the buffer provided by the user and return its
1576 * The pointer to the mbuf.
1578 * The offset of the data in the mbuf.
1580 * The amount of bytes to read.
1582 * The buffer where data is copied if it is not contiguous in mbuf
1583 * data. Its length should be at least equal to the len parameter.
1585 * The pointer to the data, either in the mbuf if it is contiguous,
1586 * or in the user buffer. If mbuf is too small, NULL is returned.
1588 static inline const void *rte_pktmbuf_read(const struct rte_mbuf *m,
1589 uint32_t off, uint32_t len, void *buf)
1591 if (likely(off + len <= rte_pktmbuf_data_len(m)))
1592 return rte_pktmbuf_mtod_offset(m, char *, off);
1594 return __rte_pktmbuf_read(m, off, len, buf);
1598 * Chain an mbuf to another, thereby creating a segmented packet.
1600 * Note: The implementation will do a linear walk over the segments to find
1601 * the tail entry. For cases when there are many segments, it's better to
1602 * chain the entries manually.
1605 * The head of the mbuf chain (the first packet)
1607 * The mbuf to put last in the chain
1611 * - -EOVERFLOW, if the chain segment limit exceeded
1613 static inline int rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail)
1615 struct rte_mbuf *cur_tail;
1617 /* Check for number-of-segments-overflow */
1618 if (head->nb_segs + tail->nb_segs > RTE_MBUF_MAX_NB_SEGS)
1621 /* Chain 'tail' onto the old tail */
1622 cur_tail = rte_pktmbuf_lastseg(head);
1623 cur_tail->next = tail;
1625 /* accumulate number of segments and total length.
1626 * NB: elaborating the addition like this instead of using
1627 * -= allows us to ensure the result type is uint16_t
1628 * avoiding compiler warnings on gcc 8.1 at least */
1629 head->nb_segs = (uint16_t)(head->nb_segs + tail->nb_segs);
1630 head->pkt_len += tail->pkt_len;
1632 /* pkt_len is only set in the head */
1633 tail->pkt_len = tail->data_len;
1640 * @b EXPERIMENTAL: This API may change without prior notice.
1642 * For given input values generate raw tx_offload value.
1643 * Note that it is caller responsibility to make sure that input parameters
1644 * don't exceed maximum bit-field values.
1654 * outer_l3_len value.
1656 * outer_l2_len value.
1660 * raw tx_offload value.
1662 static __rte_always_inline uint64_t
1663 rte_mbuf_tx_offload(uint64_t il2, uint64_t il3, uint64_t il4, uint64_t tso,
1664 uint64_t ol3, uint64_t ol2, uint64_t unused)
1666 return il2 << RTE_MBUF_L2_LEN_OFS |
1667 il3 << RTE_MBUF_L3_LEN_OFS |
1668 il4 << RTE_MBUF_L4_LEN_OFS |
1669 tso << RTE_MBUF_TSO_SEGSZ_OFS |
1670 ol3 << RTE_MBUF_OUTL3_LEN_OFS |
1671 ol2 << RTE_MBUF_OUTL2_LEN_OFS |
1672 unused << RTE_MBUF_TXOFLD_UNUSED_OFS;
1676 * Validate general requirements for Tx offload in mbuf.
1678 * This function checks correctness and completeness of Tx offload settings.
1681 * The packet mbuf to be validated.
1683 * 0 if packet is valid
1686 rte_validate_tx_offload(const struct rte_mbuf *m)
1688 uint64_t ol_flags = m->ol_flags;
1690 /* Does packet set any of available offloads? */
1691 if (!(ol_flags & PKT_TX_OFFLOAD_MASK))
1694 /* IP checksum can be counted only for IPv4 packet */
1695 if ((ol_flags & PKT_TX_IP_CKSUM) && (ol_flags & PKT_TX_IPV6))
1698 /* IP type not set when required */
1699 if (ol_flags & (PKT_TX_L4_MASK | PKT_TX_TCP_SEG))
1700 if (!(ol_flags & (PKT_TX_IPV4 | PKT_TX_IPV6)))
1703 /* Check requirements for TSO packet */
1704 if (ol_flags & PKT_TX_TCP_SEG)
1705 if ((m->tso_segsz == 0) ||
1706 ((ol_flags & PKT_TX_IPV4) &&
1707 !(ol_flags & PKT_TX_IP_CKSUM)))
1710 /* PKT_TX_OUTER_IP_CKSUM set for non outer IPv4 packet. */
1711 if ((ol_flags & PKT_TX_OUTER_IP_CKSUM) &&
1712 !(ol_flags & PKT_TX_OUTER_IPV4))
1719 * @internal used by rte_pktmbuf_linearize().
1721 int __rte_pktmbuf_linearize(struct rte_mbuf *mbuf);
1724 * Linearize data in mbuf.
1726 * This function moves the mbuf data in the first segment if there is enough
1727 * tailroom. The subsequent segments are unchained and freed.
1736 rte_pktmbuf_linearize(struct rte_mbuf *mbuf)
1738 if (rte_pktmbuf_is_contiguous(mbuf))
1740 return __rte_pktmbuf_linearize(mbuf);
1744 * Dump an mbuf structure to a file.
1746 * Dump all fields for the given packet mbuf and all its associated
1747 * segments (in the case of a chained buffer).
1750 * A pointer to a file for output
1754 * If dump_len != 0, also dump the "dump_len" first data bytes of
1757 void rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len);
1760 * Get the value of mbuf sched queue_id field.
1762 static inline uint32_t
1763 rte_mbuf_sched_queue_get(const struct rte_mbuf *m)
1765 return m->hash.sched.queue_id;
1769 * Get the value of mbuf sched traffic_class field.
1771 static inline uint8_t
1772 rte_mbuf_sched_traffic_class_get(const struct rte_mbuf *m)
1774 return m->hash.sched.traffic_class;
1778 * Get the value of mbuf sched color field.
1780 static inline uint8_t
1781 rte_mbuf_sched_color_get(const struct rte_mbuf *m)
1783 return m->hash.sched.color;
1787 * Get the values of mbuf sched queue_id, traffic_class and color.
1792 * Returns the queue id
1793 * @param traffic_class
1794 * Returns the traffic class id
1796 * Returns the colour id
1799 rte_mbuf_sched_get(const struct rte_mbuf *m, uint32_t *queue_id,
1800 uint8_t *traffic_class,
1803 struct rte_mbuf_sched sched = m->hash.sched;
1805 *queue_id = sched.queue_id;
1806 *traffic_class = sched.traffic_class;
1807 *color = sched.color;
1811 * Set the mbuf sched queue_id to the defined value.
1814 rte_mbuf_sched_queue_set(struct rte_mbuf *m, uint32_t queue_id)
1816 m->hash.sched.queue_id = queue_id;
1820 * Set the mbuf sched traffic_class id to the defined value.
1823 rte_mbuf_sched_traffic_class_set(struct rte_mbuf *m, uint8_t traffic_class)
1825 m->hash.sched.traffic_class = traffic_class;
1829 * Set the mbuf sched color id to the defined value.
1832 rte_mbuf_sched_color_set(struct rte_mbuf *m, uint8_t color)
1834 m->hash.sched.color = color;
1838 * Set the mbuf sched queue_id, traffic_class and color.
1843 * Queue id value to be set
1844 * @param traffic_class
1845 * Traffic class id value to be set
1847 * Color id to be set
1850 rte_mbuf_sched_set(struct rte_mbuf *m, uint32_t queue_id,
1851 uint8_t traffic_class,
1854 m->hash.sched = (struct rte_mbuf_sched){
1855 .queue_id = queue_id,
1856 .traffic_class = traffic_class,
1866 #endif /* _RTE_MBUF_H_ */