* [dpdk-dev] [PATCH 0/3] move mbuf definition into a separate file
@ 2019-08-16 12:53 Konstantin Ananyev
2019-08-16 12:53 ` [dpdk-dev] [PATCH 1/3] eal: move CACHE and IOVA related definitions Konstantin Ananyev
` (3 more replies)
0 siblings, 4 replies; 17+ messages in thread
From: Konstantin Ananyev @ 2019-08-16 12:53 UTC (permalink / raw)
To: dev
Cc: michel, olivier.matz, anatoly.burakov, vipin.varghese,
Konstantin Ananyev
Right now inclusion of rte_mbuf.h header can cause inclusion of
some arch/os specific headers.
That prevents it to be included directly by some
non-DPDK (but related) entities: KNI, BPF programs, etc.
To overcome that problem usually a separate definitions of rte_mbuf
structure is created within these entities.
That aproach has a lot of drawbacks: code duplication, error prone, etc.
This series moves rte_mbuf structure definition (and some related macros)
into a separate file that can be included by both rte_mbuf.h and
other non-DPDK entities.
Note that these moves shouldn't introduce any change for current DPDK code.
Konstantin Ananyev (3):
eal: move CACHE and IOVA related definitions
mbuf: move mbuf definition into a separate file
examples/bpf: remove duplicate mbuf definition
examples/bpf/t2.c | 5 +-
examples/bpf/t3.c | 3 +-
lib/librte_eal/common/include/rte_common.h | 44 ++
lib/librte_eal/common/include/rte_memory.h | 38 -
lib/librte_mbuf/Makefile | 5 +-
lib/librte_mbuf/meson.build | 3 +-
lib/librte_mbuf/rte_mbuf.h | 738 +-----------------
.../mbuf.h => lib/librte_mbuf/rte_mbuf_core.h | 556 ++++++++-----
8 files changed, 428 insertions(+), 964 deletions(-)
rename examples/bpf/mbuf.h => lib/librte_mbuf/rte_mbuf_core.h (51%)
--
2.17.1
^ permalink raw reply [flat|nested] 17+ messages in thread* [dpdk-dev] [PATCH 1/3] eal: move CACHE and IOVA related definitions 2019-08-16 12:53 [dpdk-dev] [PATCH 0/3] move mbuf definition into a separate file Konstantin Ananyev @ 2019-08-16 12:53 ` Konstantin Ananyev 2019-08-16 18:50 ` Michel Machado 2019-08-16 12:53 ` [dpdk-dev] [PATCH 2/3] mbuf: move mbuf definition into a separate file Konstantin Ananyev ` (2 subsequent siblings) 3 siblings, 1 reply; 17+ messages in thread From: Konstantin Ananyev @ 2019-08-16 12:53 UTC (permalink / raw) To: dev Cc: michel, olivier.matz, anatoly.burakov, vipin.varghese, Konstantin Ananyev Right now RTE_CACHE_ and IOVA definitions are located inside rte_memory.h That might cause an unwanted inclusions of arch/os specific header files. See [1] for particular problem example. Probably the simplest way to deal with such problems - move these definitions into rte_commmon.h Note that this move doesn't introduce any change in functionality. [1] https://bugs.dpdk.org/show_bug.cgi?id=321 Suggested-by: Vipin Varghese <vipin.varghese@intel.com> Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com> --- lib/librte_eal/common/include/rte_common.h | 44 ++++++++++++++++++++++ lib/librte_eal/common/include/rte_memory.h | 38 ------------------- 2 files changed, 44 insertions(+), 38 deletions(-) diff --git a/lib/librte_eal/common/include/rte_common.h b/lib/librte_eal/common/include/rte_common.h index 05a3a6401..c275093d7 100644 --- a/lib/librte_eal/common/include/rte_common.h +++ b/lib/librte_eal/common/include/rte_common.h @@ -291,6 +291,50 @@ rte_is_aligned(void *ptr, unsigned align) */ #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)])) +/*********** RTE_CACHE related macros ********/ + +#define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1) /**< Cache line mask. */ + +#define RTE_CACHE_LINE_ROUNDUP(size) \ + (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / \ + RTE_CACHE_LINE_SIZE)) +/**< Return the first cache-aligned value greater or equal to size. */ + +/**< Cache line size in terms of log2 */ +#if RTE_CACHE_LINE_SIZE == 64 +#define RTE_CACHE_LINE_SIZE_LOG2 6 +#elif RTE_CACHE_LINE_SIZE == 128 +#define RTE_CACHE_LINE_SIZE_LOG2 7 +#else +#error "Unsupported cache line size" +#endif + +#define RTE_CACHE_LINE_MIN_SIZE 64 /**< Minimum Cache line size. */ + +/** + * Force alignment to cache line. + */ +#define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE) + +/** + * Force minimum cache line alignment. + */ +#define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE) + +/*********** PA/IOVA type definitions ********/ + +typedef uint64_t phys_addr_t; /**< Physical address. */ +#define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1) +/** + * IO virtual address type. + * When the physical addressing mode (IOVA as PA) is in use, + * the translation from an IO virtual address (IOVA) to a physical address + * is a direct mapping, i.e. the same value. + * Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation. + */ +typedef uint64_t rte_iova_t; +#define RTE_BAD_IOVA ((rte_iova_t)-1) + /** * Combines 32b inputs most significant set bits into the least * significant bits to construct a value with the same MSBs as x diff --git a/lib/librte_eal/common/include/rte_memory.h b/lib/librte_eal/common/include/rte_memory.h index 4717dcb43..38e00e382 100644 --- a/lib/librte_eal/common/include/rte_memory.h +++ b/lib/librte_eal/common/include/rte_memory.h @@ -39,44 +39,6 @@ enum rte_page_sizes { }; #define SOCKET_ID_ANY -1 /**< Any NUMA socket. */ -#define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1) /**< Cache line mask. */ - -#define RTE_CACHE_LINE_ROUNDUP(size) \ - (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE)) -/**< Return the first cache-aligned value greater or equal to size. */ - -/**< Cache line size in terms of log2 */ -#if RTE_CACHE_LINE_SIZE == 64 -#define RTE_CACHE_LINE_SIZE_LOG2 6 -#elif RTE_CACHE_LINE_SIZE == 128 -#define RTE_CACHE_LINE_SIZE_LOG2 7 -#else -#error "Unsupported cache line size" -#endif - -#define RTE_CACHE_LINE_MIN_SIZE 64 /**< Minimum Cache line size. */ - -/** - * Force alignment to cache line. - */ -#define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE) - -/** - * Force minimum cache line alignment. - */ -#define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE) - -typedef uint64_t phys_addr_t; /**< Physical address. */ -#define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1) -/** - * IO virtual address type. - * When the physical addressing mode (IOVA as PA) is in use, - * the translation from an IO virtual address (IOVA) to a physical address - * is a direct mapping, i.e. the same value. - * Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation. - */ -typedef uint64_t rte_iova_t; -#define RTE_BAD_IOVA ((rte_iova_t)-1) /** * Physical memory segment descriptor. -- 2.17.1 ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [dpdk-dev] [PATCH 1/3] eal: move CACHE and IOVA related definitions 2019-08-16 12:53 ` [dpdk-dev] [PATCH 1/3] eal: move CACHE and IOVA related definitions Konstantin Ananyev @ 2019-08-16 18:50 ` Michel Machado 0 siblings, 0 replies; 17+ messages in thread From: Michel Machado @ 2019-08-16 18:50 UTC (permalink / raw) To: Konstantin Ananyev, dev; +Cc: olivier.matz, anatoly.burakov, vipin.varghese Acked-by: Michel Machado <michel@digirati.com.br> [ ]'s Michel Machado On 8/16/19 8:53 AM, Konstantin Ananyev wrote: > Right now RTE_CACHE_ and IOVA definitions are located inside rte_memory.h > That might cause an unwanted inclusions of arch/os specific header files. > See [1] for particular problem example. > Probably the simplest way to deal with such problems - > move these definitions into rte_commmon.h > > Note that this move doesn't introduce any change in functionality. > > [1] https://bugs.dpdk.org/show_bug.cgi?id=321 > > Suggested-by: Vipin Varghese <vipin.varghese@intel.com> > Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com> > --- > lib/librte_eal/common/include/rte_common.h | 44 ++++++++++++++++++++++ > lib/librte_eal/common/include/rte_memory.h | 38 ------------------- > 2 files changed, 44 insertions(+), 38 deletions(-) > > diff --git a/lib/librte_eal/common/include/rte_common.h b/lib/librte_eal/common/include/rte_common.h > index 05a3a6401..c275093d7 100644 > --- a/lib/librte_eal/common/include/rte_common.h > +++ b/lib/librte_eal/common/include/rte_common.h > @@ -291,6 +291,50 @@ rte_is_aligned(void *ptr, unsigned align) > */ > #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)])) > > +/*********** RTE_CACHE related macros ********/ > + > +#define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1) /**< Cache line mask. */ > + > +#define RTE_CACHE_LINE_ROUNDUP(size) \ > + (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / \ > + RTE_CACHE_LINE_SIZE)) > +/**< Return the first cache-aligned value greater or equal to size. */ > + > +/**< Cache line size in terms of log2 */ > +#if RTE_CACHE_LINE_SIZE == 64 > +#define RTE_CACHE_LINE_SIZE_LOG2 6 > +#elif RTE_CACHE_LINE_SIZE == 128 > +#define RTE_CACHE_LINE_SIZE_LOG2 7 > +#else > +#error "Unsupported cache line size" > +#endif > + > +#define RTE_CACHE_LINE_MIN_SIZE 64 /**< Minimum Cache line size. */ > + > +/** > + * Force alignment to cache line. > + */ > +#define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE) > + > +/** > + * Force minimum cache line alignment. > + */ > +#define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE) > + > +/*********** PA/IOVA type definitions ********/ > + > +typedef uint64_t phys_addr_t; /**< Physical address. */ > +#define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1) > +/** > + * IO virtual address type. > + * When the physical addressing mode (IOVA as PA) is in use, > + * the translation from an IO virtual address (IOVA) to a physical address > + * is a direct mapping, i.e. the same value. > + * Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation. > + */ > +typedef uint64_t rte_iova_t; > +#define RTE_BAD_IOVA ((rte_iova_t)-1) > + > /** > * Combines 32b inputs most significant set bits into the least > * significant bits to construct a value with the same MSBs as x > diff --git a/lib/librte_eal/common/include/rte_memory.h b/lib/librte_eal/common/include/rte_memory.h > index 4717dcb43..38e00e382 100644 > --- a/lib/librte_eal/common/include/rte_memory.h > +++ b/lib/librte_eal/common/include/rte_memory.h > @@ -39,44 +39,6 @@ enum rte_page_sizes { > }; > > #define SOCKET_ID_ANY -1 /**< Any NUMA socket. */ > -#define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1) /**< Cache line mask. */ > - > -#define RTE_CACHE_LINE_ROUNDUP(size) \ > - (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE)) > -/**< Return the first cache-aligned value greater or equal to size. */ > - > -/**< Cache line size in terms of log2 */ > -#if RTE_CACHE_LINE_SIZE == 64 > -#define RTE_CACHE_LINE_SIZE_LOG2 6 > -#elif RTE_CACHE_LINE_SIZE == 128 > -#define RTE_CACHE_LINE_SIZE_LOG2 7 > -#else > -#error "Unsupported cache line size" > -#endif > - > -#define RTE_CACHE_LINE_MIN_SIZE 64 /**< Minimum Cache line size. */ > - > -/** > - * Force alignment to cache line. > - */ > -#define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE) > - > -/** > - * Force minimum cache line alignment. > - */ > -#define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE) > - > -typedef uint64_t phys_addr_t; /**< Physical address. */ > -#define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1) > -/** > - * IO virtual address type. > - * When the physical addressing mode (IOVA as PA) is in use, > - * the translation from an IO virtual address (IOVA) to a physical address > - * is a direct mapping, i.e. the same value. > - * Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation. > - */ > -typedef uint64_t rte_iova_t; > -#define RTE_BAD_IOVA ((rte_iova_t)-1) > > /** > * Physical memory segment descriptor. > ^ permalink raw reply [flat|nested] 17+ messages in thread
* [dpdk-dev] [PATCH 2/3] mbuf: move mbuf definition into a separate file 2019-08-16 12:53 [dpdk-dev] [PATCH 0/3] move mbuf definition into a separate file Konstantin Ananyev 2019-08-16 12:53 ` [dpdk-dev] [PATCH 1/3] eal: move CACHE and IOVA related definitions Konstantin Ananyev @ 2019-08-16 12:53 ` Konstantin Ananyev 2019-08-16 18:51 ` Michel Machado 2019-08-16 12:53 ` [dpdk-dev] [PATCH 3/3] examples/bpf: remove duplicate mbuf definition Konstantin Ananyev 2019-09-27 13:50 ` [dpdk-dev] [PATCH v2 0/3] move mbuf definition into a separate file Konstantin Ananyev 3 siblings, 1 reply; 17+ messages in thread From: Konstantin Ananyev @ 2019-08-16 12:53 UTC (permalink / raw) To: dev Cc: michel, olivier.matz, anatoly.burakov, vipin.varghese, Konstantin Ananyev Right now inclusion of rte_mbuf.h header can cause inclusion of some arch/os specific headers. That prevents it to be included directly by some non-DPDK (but related) entities: KNI, BPF programs, etc. To overcome that problem usually a separate definitions of rte_mbuf structure is created within these entities. That aproach has a lot of drawbacks: code duplication, error prone, etc. This patch moves rte_mbuf structure definition (and some related macros) into a separate file that can be included by both rte_mbuf.h and other non-DPDK entities. Note that it doesn't introduce any change for current DPDK code. Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com> --- lib/librte_mbuf/Makefile | 5 +- lib/librte_mbuf/meson.build | 3 +- lib/librte_mbuf/rte_mbuf.h | 738 +---------------------------- lib/librte_mbuf/rte_mbuf_core.h | 793 ++++++++++++++++++++++++++++++++ 4 files changed, 800 insertions(+), 739 deletions(-) create mode 100644 lib/librte_mbuf/rte_mbuf_core.h diff --git a/lib/librte_mbuf/Makefile b/lib/librte_mbuf/Makefile index c8f6d2689..f3b76ad23 100644 --- a/lib/librte_mbuf/Makefile +++ b/lib/librte_mbuf/Makefile @@ -19,6 +19,9 @@ LIBABIVER := 5 SRCS-$(CONFIG_RTE_LIBRTE_MBUF) := rte_mbuf.c rte_mbuf_ptype.c rte_mbuf_pool_ops.c # install includes -SYMLINK-$(CONFIG_RTE_LIBRTE_MBUF)-include := rte_mbuf.h rte_mbuf_ptype.h rte_mbuf_pool_ops.h +SYMLINK-$(CONFIG_RTE_LIBRTE_MBUF)-include := rte_mbuf.h +SYMLINK-$(CONFIG_RTE_LIBRTE_MBUF)-include += rte_mbuf_core.h +SYMLINK-$(CONFIG_RTE_LIBRTE_MBUF)-include += rte_mbuf_ptype.h +SYMLINK-$(CONFIG_RTE_LIBRTE_MBUF)-include += rte_mbuf_pool_ops.h include $(RTE_SDK)/mk/rte.lib.mk diff --git a/lib/librte_mbuf/meson.build b/lib/librte_mbuf/meson.build index 6cc11ebb4..36bb6eb9d 100644 --- a/lib/librte_mbuf/meson.build +++ b/lib/librte_mbuf/meson.build @@ -3,7 +3,8 @@ version = 5 sources = files('rte_mbuf.c', 'rte_mbuf_ptype.c', 'rte_mbuf_pool_ops.c') -headers = files('rte_mbuf.h', 'rte_mbuf_ptype.h', 'rte_mbuf_pool_ops.h') +headers = files('rte_mbuf.h', 'rte_mbuf_core.h', + 'rte_mbuf_ptype.h', 'rte_mbuf_pool_ops.h') deps += ['mempool'] allow_experimental_apis = true diff --git a/lib/librte_mbuf/rte_mbuf.h b/lib/librte_mbuf/rte_mbuf.h index 98225ec80..528b2f121 100644 --- a/lib/librte_mbuf/rte_mbuf.h +++ b/lib/librte_mbuf/rte_mbuf.h @@ -42,367 +42,12 @@ #include <rte_branch_prediction.h> #include <rte_byteorder.h> #include <rte_mbuf_ptype.h> +#include <rte_mbuf_core.h> #ifdef __cplusplus extern "C" { #endif -/* - * Packet Offload Features Flags. It also carry packet type information. - * Critical resources. Both rx/tx shared these bits. Be cautious on any change - * - * - RX flags start at bit position zero, and get added to the left of previous - * flags. - * - The most-significant 3 bits are reserved for generic mbuf flags - * - TX flags therefore start at bit position 60 (i.e. 63-3), and new flags get - * added to the right of the previously defined flags i.e. they should count - * downwards, not upwards. - * - * Keep these flags synchronized with rte_get_rx_ol_flag_name() and - * rte_get_tx_ol_flag_name(). - */ - -/** - * The RX packet is a 802.1q VLAN packet, and the tci has been - * saved in in mbuf->vlan_tci. - * If the flag PKT_RX_VLAN_STRIPPED is also present, the VLAN - * header has been stripped from mbuf data, else it is still - * present. - */ -#define PKT_RX_VLAN (1ULL << 0) - -#define PKT_RX_RSS_HASH (1ULL << 1) /**< RX packet with RSS hash result. */ -#define PKT_RX_FDIR (1ULL << 2) /**< RX packet with FDIR match indicate. */ - -/** - * Deprecated. - * Checking this flag alone is deprecated: check the 2 bits of - * PKT_RX_L4_CKSUM_MASK. - * This flag was set when the L4 checksum of a packet was detected as - * wrong by the hardware. - */ -#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) - -/** - * Deprecated. - * Checking this flag alone is deprecated: check the 2 bits of - * PKT_RX_IP_CKSUM_MASK. - * This flag was set when the IP checksum of a packet was detected as - * wrong by the hardware. - */ -#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) - -#define PKT_RX_EIP_CKSUM_BAD (1ULL << 5) /**< External IP header checksum error. */ - -/** - * A vlan has been stripped by the hardware and its tci is saved in - * mbuf->vlan_tci. This can only happen if vlan stripping is enabled - * in the RX configuration of the PMD. - * When PKT_RX_VLAN_STRIPPED is set, PKT_RX_VLAN must also be set. - */ -#define PKT_RX_VLAN_STRIPPED (1ULL << 6) - -/** - * Mask of bits used to determine the status of RX IP checksum. - * - PKT_RX_IP_CKSUM_UNKNOWN: no information about the RX IP checksum - * - PKT_RX_IP_CKSUM_BAD: the IP checksum in the packet is wrong - * - PKT_RX_IP_CKSUM_GOOD: the IP checksum in the packet is valid - * - PKT_RX_IP_CKSUM_NONE: the IP checksum is not correct in the packet - * data, but the integrity of the IP header is verified. - */ -#define PKT_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7)) - -#define PKT_RX_IP_CKSUM_UNKNOWN 0 -#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) -#define PKT_RX_IP_CKSUM_GOOD (1ULL << 7) -#define PKT_RX_IP_CKSUM_NONE ((1ULL << 4) | (1ULL << 7)) - -/** - * Mask of bits used to determine the status of RX L4 checksum. - * - PKT_RX_L4_CKSUM_UNKNOWN: no information about the RX L4 checksum - * - PKT_RX_L4_CKSUM_BAD: the L4 checksum in the packet is wrong - * - PKT_RX_L4_CKSUM_GOOD: the L4 checksum in the packet is valid - * - PKT_RX_L4_CKSUM_NONE: the L4 checksum is not correct in the packet - * data, but the integrity of the L4 data is verified. - */ -#define PKT_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8)) - -#define PKT_RX_L4_CKSUM_UNKNOWN 0 -#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) -#define PKT_RX_L4_CKSUM_GOOD (1ULL << 8) -#define PKT_RX_L4_CKSUM_NONE ((1ULL << 3) | (1ULL << 8)) - -#define PKT_RX_IEEE1588_PTP (1ULL << 9) /**< RX IEEE1588 L2 Ethernet PT Packet. */ -#define PKT_RX_IEEE1588_TMST (1ULL << 10) /**< RX IEEE1588 L2/L4 timestamped packet.*/ -#define PKT_RX_FDIR_ID (1ULL << 13) /**< FD id reported if FDIR match. */ -#define PKT_RX_FDIR_FLX (1ULL << 14) /**< Flexible bytes reported if FDIR match. */ - -/** - * The 2 vlans have been stripped by the hardware and their tci are - * saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer). - * This can only happen if vlan stripping is enabled in the RX - * configuration of the PMD. - * When PKT_RX_QINQ_STRIPPED is set, the flags (PKT_RX_VLAN | - * PKT_RX_VLAN_STRIPPED | PKT_RX_QINQ) must also be set. - */ -#define PKT_RX_QINQ_STRIPPED (1ULL << 15) - -/** - * When packets are coalesced by a hardware or virtual driver, this flag - * can be set in the RX mbuf, meaning that the m->tso_segsz field is - * valid and is set to the segment size of original packets. - */ -#define PKT_RX_LRO (1ULL << 16) - -/** - * Indicate that the timestamp field in the mbuf is valid. - */ -#define PKT_RX_TIMESTAMP (1ULL << 17) - -/** - * Indicate that security offload processing was applied on the RX packet. - */ -#define PKT_RX_SEC_OFFLOAD (1ULL << 18) - -/** - * Indicate that security offload processing failed on the RX packet. - */ -#define PKT_RX_SEC_OFFLOAD_FAILED (1ULL << 19) - -/** - * The RX packet is a double VLAN, and the outer tci has been - * saved in in mbuf->vlan_tci_outer. If PKT_RX_QINQ set, PKT_RX_VLAN - * also should be set and inner tci should be saved to mbuf->vlan_tci. - * If the flag PKT_RX_QINQ_STRIPPED is also present, both VLANs - * headers have been stripped from mbuf data, else they are still - * present. - */ -#define PKT_RX_QINQ (1ULL << 20) - -/** - * Mask of bits used to determine the status of outer RX L4 checksum. - * - PKT_RX_OUTER_L4_CKSUM_UNKNOWN: no info about the outer RX L4 checksum - * - PKT_RX_OUTER_L4_CKSUM_BAD: the outer L4 checksum in the packet is wrong - * - PKT_RX_OUTER_L4_CKSUM_GOOD: the outer L4 checksum in the packet is valid - * - PKT_RX_OUTER_L4_CKSUM_INVALID: invalid outer L4 checksum state. - * - * The detection of PKT_RX_OUTER_L4_CKSUM_GOOD shall be based on the given - * HW capability, At minimum, the PMD should support - * PKT_RX_OUTER_L4_CKSUM_UNKNOWN and PKT_RX_OUTER_L4_CKSUM_BAD states - * if the DEV_RX_OFFLOAD_OUTER_UDP_CKSUM offload is available. - */ -#define PKT_RX_OUTER_L4_CKSUM_MASK ((1ULL << 21) | (1ULL << 22)) - -#define PKT_RX_OUTER_L4_CKSUM_UNKNOWN 0 -#define PKT_RX_OUTER_L4_CKSUM_BAD (1ULL << 21) -#define PKT_RX_OUTER_L4_CKSUM_GOOD (1ULL << 22) -#define PKT_RX_OUTER_L4_CKSUM_INVALID ((1ULL << 21) | (1ULL << 22)) - -/* add new RX flags here */ - -/* add new TX flags here */ - -/** - * Indicate that the metadata field in the mbuf is in use. - */ -#define PKT_TX_METADATA (1ULL << 40) - -/** - * Outer UDP checksum offload flag. This flag is used for enabling - * outer UDP checksum in PMD. To use outer UDP checksum, the user needs to - * 1) Enable the following in mbuf, - * a) Fill outer_l2_len and outer_l3_len in mbuf. - * b) Set the PKT_TX_OUTER_UDP_CKSUM flag. - * c) Set the PKT_TX_OUTER_IPV4 or PKT_TX_OUTER_IPV6 flag. - * 2) Configure DEV_TX_OFFLOAD_OUTER_UDP_CKSUM offload flag. - */ -#define PKT_TX_OUTER_UDP_CKSUM (1ULL << 41) - -/** - * UDP Fragmentation Offload flag. This flag is used for enabling UDP - * fragmentation in SW or in HW. When use UFO, mbuf->tso_segsz is used - * to store the MSS of UDP fragments. - */ -#define PKT_TX_UDP_SEG (1ULL << 42) - -/** - * Request security offload processing on the TX packet. - */ -#define PKT_TX_SEC_OFFLOAD (1ULL << 43) - -/** - * Offload the MACsec. This flag must be set by the application to enable - * this offload feature for a packet to be transmitted. - */ -#define PKT_TX_MACSEC (1ULL << 44) - -/** - * Bits 45:48 used for the tunnel type. - * The tunnel type must be specified for TSO or checksum on the inner part - * of tunnel packets. - * These flags can be used with PKT_TX_TCP_SEG for TSO, or PKT_TX_xxx_CKSUM. - * The mbuf fields for inner and outer header lengths are required: - * outer_l2_len, outer_l3_len, l2_len, l3_len, l4_len and tso_segsz for TSO. - */ -#define PKT_TX_TUNNEL_VXLAN (0x1ULL << 45) -#define PKT_TX_TUNNEL_GRE (0x2ULL << 45) -#define PKT_TX_TUNNEL_IPIP (0x3ULL << 45) -#define PKT_TX_TUNNEL_GENEVE (0x4ULL << 45) -/** TX packet with MPLS-in-UDP RFC 7510 header. */ -#define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45) -#define PKT_TX_TUNNEL_VXLAN_GPE (0x6ULL << 45) -/** - * Generic IP encapsulated tunnel type, used for TSO and checksum offload. - * It can be used for tunnels which are not standards or listed above. - * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_GRE - * or PKT_TX_TUNNEL_IPIP if possible. - * The ethdev must be configured with DEV_TX_OFFLOAD_IP_TNL_TSO. - * Outer and inner checksums are done according to the existing flags like - * PKT_TX_xxx_CKSUM. - * Specific tunnel headers that contain payload length, sequence id - * or checksum are not expected to be updated. - */ -#define PKT_TX_TUNNEL_IP (0xDULL << 45) -/** - * Generic UDP encapsulated tunnel type, used for TSO and checksum offload. - * UDP tunnel type implies outer IP layer. - * It can be used for tunnels which are not standards or listed above. - * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_VXLAN - * if possible. - * The ethdev must be configured with DEV_TX_OFFLOAD_UDP_TNL_TSO. - * Outer and inner checksums are done according to the existing flags like - * PKT_TX_xxx_CKSUM. - * Specific tunnel headers that contain payload length, sequence id - * or checksum are not expected to be updated. - */ -#define PKT_TX_TUNNEL_UDP (0xEULL << 45) -/* add new TX TUNNEL type here */ -#define PKT_TX_TUNNEL_MASK (0xFULL << 45) - -/** - * Double VLAN insertion (QinQ) request to driver, driver may offload the - * insertion based on device capability. - * mbuf 'vlan_tci' & 'vlan_tci_outer' must be valid when this flag is set. - */ -#define PKT_TX_QINQ (1ULL << 49) -/* this old name is deprecated */ -#define PKT_TX_QINQ_PKT PKT_TX_QINQ - -/** - * TCP segmentation offload. To enable this offload feature for a - * packet to be transmitted on hardware supporting TSO: - * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies - * PKT_TX_TCP_CKSUM) - * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 - * - if it's IPv4, set the PKT_TX_IP_CKSUM flag - * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz - */ -#define PKT_TX_TCP_SEG (1ULL << 50) - -#define PKT_TX_IEEE1588_TMST (1ULL << 51) /**< TX IEEE1588 packet to timestamp. */ - -/** - * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved, - * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware - * L4 checksum offload, the user needs to: - * - fill l2_len and l3_len in mbuf - * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM - * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 - */ -#define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */ -#define PKT_TX_TCP_CKSUM (1ULL << 52) /**< TCP cksum of TX pkt. computed by NIC. */ -#define PKT_TX_SCTP_CKSUM (2ULL << 52) /**< SCTP cksum of TX pkt. computed by NIC. */ -#define PKT_TX_UDP_CKSUM (3ULL << 52) /**< UDP cksum of TX pkt. computed by NIC. */ -#define PKT_TX_L4_MASK (3ULL << 52) /**< Mask for L4 cksum offload request. */ - -/** - * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should - * also be set by the application, although a PMD will only check - * PKT_TX_IP_CKSUM. - * - fill the mbuf offload information: l2_len, l3_len - */ -#define PKT_TX_IP_CKSUM (1ULL << 54) - -/** - * Packet is IPv4. This flag must be set when using any offload feature - * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4 - * packet. If the packet is a tunneled packet, this flag is related to - * the inner headers. - */ -#define PKT_TX_IPV4 (1ULL << 55) - -/** - * Packet is IPv6. This flag must be set when using an offload feature - * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6 - * packet. If the packet is a tunneled packet, this flag is related to - * the inner headers. - */ -#define PKT_TX_IPV6 (1ULL << 56) - -/** - * VLAN tag insertion request to driver, driver may offload the insertion - * based on the device capability. - * mbuf 'vlan_tci' field must be valid when this flag is set. - */ -#define PKT_TX_VLAN (1ULL << 57) -/* this old name is deprecated */ -#define PKT_TX_VLAN_PKT PKT_TX_VLAN - -/** - * Offload the IP checksum of an external header in the hardware. The - * flag PKT_TX_OUTER_IPV4 should also be set by the application, although - * a PMD will only check PKT_TX_OUTER_IP_CKSUM. - * - fill the mbuf offload information: outer_l2_len, outer_l3_len - */ -#define PKT_TX_OUTER_IP_CKSUM (1ULL << 58) - -/** - * Packet outer header is IPv4. This flag must be set when using any - * outer offload feature (L3 or L4 checksum) to tell the NIC that the - * outer header of the tunneled packet is an IPv4 packet. - */ -#define PKT_TX_OUTER_IPV4 (1ULL << 59) - -/** - * Packet outer header is IPv6. This flag must be set when using any - * outer offload feature (L4 checksum) to tell the NIC that the outer - * header of the tunneled packet is an IPv6 packet. - */ -#define PKT_TX_OUTER_IPV6 (1ULL << 60) - -/** - * Bitmask of all supported packet Tx offload features flags, - * which can be set for packet. - */ -#define PKT_TX_OFFLOAD_MASK ( \ - PKT_TX_OUTER_IPV6 | \ - PKT_TX_OUTER_IPV4 | \ - PKT_TX_OUTER_IP_CKSUM | \ - PKT_TX_VLAN_PKT | \ - PKT_TX_IPV6 | \ - PKT_TX_IPV4 | \ - PKT_TX_IP_CKSUM | \ - PKT_TX_L4_MASK | \ - PKT_TX_IEEE1588_TMST | \ - PKT_TX_TCP_SEG | \ - PKT_TX_QINQ_PKT | \ - PKT_TX_TUNNEL_MASK | \ - PKT_TX_MACSEC | \ - PKT_TX_SEC_OFFLOAD | \ - PKT_TX_UDP_SEG | \ - PKT_TX_OUTER_UDP_CKSUM | \ - PKT_TX_METADATA) - -/** - * Mbuf having an external buffer attached. shinfo in mbuf must be filled. - */ -#define EXT_ATTACHED_MBUF (1ULL << 61) - -#define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */ - -/** Alignment constraint of mbuf private area. */ -#define RTE_MBUF_PRIV_ALIGN 8 - /** * Get the name of a RX offload flag * @@ -453,310 +98,6 @@ const char *rte_get_tx_ol_flag_name(uint64_t mask); */ int rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen); -/** - * Some NICs need at least 2KB buffer to RX standard Ethernet frame without - * splitting it into multiple segments. - * So, for mbufs that planned to be involved into RX/TX, the recommended - * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM. - */ -#define RTE_MBUF_DEFAULT_DATAROOM 2048 -#define RTE_MBUF_DEFAULT_BUF_SIZE \ - (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM) - -/* define a set of marker types that can be used to refer to set points in the - * mbuf */ -__extension__ -typedef void *MARKER[0]; /**< generic marker for a point in a structure */ -__extension__ -typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */ -__extension__ -typedef uint64_t MARKER64[0]; /**< marker that allows us to overwrite 8 bytes - * with a single assignment */ - -struct rte_mbuf_sched { - uint32_t queue_id; /**< Queue ID. */ - uint8_t traffic_class; - /**< Traffic class ID. Traffic class 0 - * is the highest priority traffic class. - */ - uint8_t color; - /**< Color. @see enum rte_color.*/ - uint16_t reserved; /**< Reserved. */ -}; /**< Hierarchical scheduler */ - -/** - * enum for the tx_offload bit-fields lengths and offsets. - * defines the layout of rte_mbuf tx_offload field. - */ -enum { - RTE_MBUF_L2_LEN_BITS = 7, - RTE_MBUF_L3_LEN_BITS = 9, - RTE_MBUF_L4_LEN_BITS = 8, - RTE_MBUF_TSO_SEGSZ_BITS = 16, - RTE_MBUF_OUTL3_LEN_BITS = 9, - RTE_MBUF_OUTL2_LEN_BITS = 7, - RTE_MBUF_TXOFLD_UNUSED_BITS = sizeof(uint64_t) * CHAR_BIT - - RTE_MBUF_L2_LEN_BITS - - RTE_MBUF_L3_LEN_BITS - - RTE_MBUF_L4_LEN_BITS - - RTE_MBUF_TSO_SEGSZ_BITS - - RTE_MBUF_OUTL3_LEN_BITS - - RTE_MBUF_OUTL2_LEN_BITS, -#if RTE_BYTE_ORDER == RTE_BIG_ENDIAN - RTE_MBUF_L2_LEN_OFS = - sizeof(uint64_t) * CHAR_BIT - RTE_MBUF_L2_LEN_BITS, - RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS - RTE_MBUF_L3_LEN_BITS, - RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS - RTE_MBUF_L4_LEN_BITS, - RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS - RTE_MBUF_TSO_SEGSZ_BITS, - RTE_MBUF_OUTL3_LEN_OFS = - RTE_MBUF_TSO_SEGSZ_OFS - RTE_MBUF_OUTL3_LEN_BITS, - RTE_MBUF_OUTL2_LEN_OFS = - RTE_MBUF_OUTL3_LEN_OFS - RTE_MBUF_OUTL2_LEN_BITS, - RTE_MBUF_TXOFLD_UNUSED_OFS = - RTE_MBUF_OUTL2_LEN_OFS - RTE_MBUF_TXOFLD_UNUSED_BITS, -#else - RTE_MBUF_L2_LEN_OFS = 0, - RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS + RTE_MBUF_L2_LEN_BITS, - RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS + RTE_MBUF_L3_LEN_BITS, - RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS + RTE_MBUF_L4_LEN_BITS, - RTE_MBUF_OUTL3_LEN_OFS = - RTE_MBUF_TSO_SEGSZ_OFS + RTE_MBUF_TSO_SEGSZ_BITS, - RTE_MBUF_OUTL2_LEN_OFS = - RTE_MBUF_OUTL3_LEN_OFS + RTE_MBUF_OUTL3_LEN_BITS, - RTE_MBUF_TXOFLD_UNUSED_OFS = - RTE_MBUF_OUTL2_LEN_OFS + RTE_MBUF_OUTL2_LEN_BITS, -#endif -}; - -/** - * The generic rte_mbuf, containing a packet mbuf. - */ -struct rte_mbuf { - MARKER cacheline0; - - void *buf_addr; /**< Virtual address of segment buffer. */ - /** - * Physical address of segment buffer. - * Force alignment to 8-bytes, so as to ensure we have the exact - * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes - * working on vector drivers easier. - */ - RTE_STD_C11 - union { - rte_iova_t buf_iova; - rte_iova_t buf_physaddr; /**< deprecated */ - } __rte_aligned(sizeof(rte_iova_t)); - - /* next 8 bytes are initialised on RX descriptor rearm */ - MARKER64 rearm_data; - uint16_t data_off; - - /** - * Reference counter. Its size should at least equal to the size - * of port field (16 bits), to support zero-copy broadcast. - * It should only be accessed using the following functions: - * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and - * rte_mbuf_refcnt_set(). The functionality of these functions (atomic, - * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC - * config option. - */ - RTE_STD_C11 - union { - rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */ - uint16_t refcnt; /**< Non-atomically accessed refcnt */ - }; - uint16_t nb_segs; /**< Number of segments. */ - - /** Input port (16 bits to support more than 256 virtual ports). - * The event eth Tx adapter uses this field to specify the output port. - */ - uint16_t port; - - uint64_t ol_flags; /**< Offload features. */ - - /* remaining bytes are set on RX when pulling packet from descriptor */ - MARKER rx_descriptor_fields1; - - /* - * The packet type, which is the combination of outer/inner L2, L3, L4 - * and tunnel types. The packet_type is about data really present in the - * mbuf. Example: if vlan stripping is enabled, a received vlan packet - * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the - * vlan is stripped from the data. - */ - RTE_STD_C11 - union { - uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */ - struct { - uint32_t l2_type:4; /**< (Outer) L2 type. */ - uint32_t l3_type:4; /**< (Outer) L3 type. */ - uint32_t l4_type:4; /**< (Outer) L4 type. */ - uint32_t tun_type:4; /**< Tunnel type. */ - RTE_STD_C11 - union { - uint8_t inner_esp_next_proto; - /**< ESP next protocol type, valid if - * RTE_PTYPE_TUNNEL_ESP tunnel type is set - * on both Tx and Rx. - */ - __extension__ - struct { - uint8_t inner_l2_type:4; - /**< Inner L2 type. */ - uint8_t inner_l3_type:4; - /**< Inner L3 type. */ - }; - }; - uint32_t inner_l4_type:4; /**< Inner L4 type. */ - }; - }; - - uint32_t pkt_len; /**< Total pkt len: sum of all segments. */ - uint16_t data_len; /**< Amount of data in segment buffer. */ - /** VLAN TCI (CPU order), valid if PKT_RX_VLAN is set. */ - uint16_t vlan_tci; - - RTE_STD_C11 - union { - union { - uint32_t rss; /**< RSS hash result if RSS enabled */ - struct { - union { - struct { - uint16_t hash; - uint16_t id; - }; - uint32_t lo; - /**< Second 4 flexible bytes */ - }; - uint32_t hi; - /**< First 4 flexible bytes or FD ID, dependent - * on PKT_RX_FDIR_* flag in ol_flags. - */ - } fdir; /**< Filter identifier if FDIR enabled */ - struct rte_mbuf_sched sched; - /**< Hierarchical scheduler : 8 bytes */ - struct { - uint32_t reserved1; - uint16_t reserved2; - uint16_t txq; - /**< The event eth Tx adapter uses this field - * to store Tx queue id. - * @see rte_event_eth_tx_adapter_txq_set() - */ - } txadapter; /**< Eventdev ethdev Tx adapter */ - /**< User defined tags. See rte_distributor_process() */ - uint32_t usr; - } hash; /**< hash information */ - struct { - /** - * Application specific metadata value - * for egress flow rule match. - * Valid if PKT_TX_METADATA is set. - * Located here to allow conjunct use - * with hash.sched.hi. - */ - uint32_t tx_metadata; - uint32_t reserved; - }; - }; - - /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ is set. */ - uint16_t vlan_tci_outer; - - uint16_t buf_len; /**< Length of segment buffer. */ - - /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference - * are not normalized but are always the same for a given port. - * Some devices allow to query rte_eth_read_clock that will return the - * current device timestamp. - */ - uint64_t timestamp; - - /* second cache line - fields only used in slow path or on TX */ - MARKER cacheline1 __rte_cache_min_aligned; - - RTE_STD_C11 - union { - void *userdata; /**< Can be used for external metadata */ - uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */ - }; - - struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */ - struct rte_mbuf *next; /**< Next segment of scattered packet. */ - - /* fields to support TX offloads */ - RTE_STD_C11 - union { - uint64_t tx_offload; /**< combined for easy fetch */ - __extension__ - struct { - uint64_t l2_len:RTE_MBUF_L2_LEN_BITS; - /**< L2 (MAC) Header Length for non-tunneling pkt. - * Outer_L4_len + ... + Inner_L2_len for tunneling pkt. - */ - uint64_t l3_len:RTE_MBUF_L3_LEN_BITS; - /**< L3 (IP) Header Length. */ - uint64_t l4_len:RTE_MBUF_L4_LEN_BITS; - /**< L4 (TCP/UDP) Header Length. */ - uint64_t tso_segsz:RTE_MBUF_TSO_SEGSZ_BITS; - /**< TCP TSO segment size */ - - /* - * Fields for Tx offloading of tunnels. - * These are undefined for packets which don't request - * any tunnel offloads (outer IP or UDP checksum, - * tunnel TSO). - * - * PMDs should not use these fields unconditionally - * when calculating offsets. - * - * Applications are expected to set appropriate tunnel - * offload flags when they fill in these fields. - */ - uint64_t outer_l3_len:RTE_MBUF_OUTL3_LEN_BITS; - /**< Outer L3 (IP) Hdr Length. */ - uint64_t outer_l2_len:RTE_MBUF_OUTL2_LEN_BITS; - /**< Outer L2 (MAC) Hdr Length. */ - - /* uint64_t unused:RTE_MBUF_TXOFLD_UNUSED_BITS; */ - }; - }; - - /** Size of the application private data. In case of an indirect - * mbuf, it stores the direct mbuf private data size. */ - uint16_t priv_size; - - /** Timesync flags for use with IEEE1588. */ - uint16_t timesync; - - /** Sequence number. See also rte_reorder_insert(). */ - uint32_t seqn; - - /** Shared data for external buffer attached to mbuf. See - * rte_pktmbuf_attach_extbuf(). - */ - struct rte_mbuf_ext_shared_info *shinfo; - -} __rte_cache_aligned; - -/** - * Function typedef of callback to free externally attached buffer. - */ -typedef void (*rte_mbuf_extbuf_free_callback_t)(void *addr, void *opaque); - -/** - * Shared data at the end of an external buffer. - */ -struct rte_mbuf_ext_shared_info { - rte_mbuf_extbuf_free_callback_t free_cb; /**< Free callback function */ - void *fcb_opaque; /**< Free callback argument */ - rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */ -}; - -/**< Maximum number of nb_segs allowed. */ -#define RTE_MBUF_MAX_NB_SEGS UINT16_MAX - /** * Prefetch the first part of the mbuf * @@ -953,31 +294,6 @@ rte_mbuf_to_priv(struct rte_mbuf *m) return RTE_PTR_ADD(m, sizeof(struct rte_mbuf)); } -/** - * Returns TRUE if given mbuf is cloned by mbuf indirection, or FALSE - * otherwise. - * - * If a mbuf has its data in another mbuf and references it by mbuf - * indirection, this mbuf can be defined as a cloned mbuf. - */ -#define RTE_MBUF_CLONED(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF) - -/** - * Returns TRUE if given mbuf has an external buffer, or FALSE otherwise. - * - * External buffer is a user-provided anonymous buffer. - */ -#define RTE_MBUF_HAS_EXTBUF(mb) ((mb)->ol_flags & EXT_ATTACHED_MBUF) - -/** - * Returns TRUE if given mbuf is direct, or FALSE otherwise. - * - * If a mbuf embeds its own data after the rte_mbuf structure, this mbuf - * can be defined as a direct mbuf. - */ -#define RTE_MBUF_DIRECT(mb) \ - (!((mb)->ol_flags & (IND_ATTACHED_MBUF | EXT_ATTACHED_MBUF))) - /** * Private data in case of pktmbuf pool. * @@ -2026,62 +1342,10 @@ static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m) return m; } -/** - * A macro that points to an offset into the data in the mbuf. - * - * The returned pointer is cast to type t. Before using this - * function, the user must ensure that the first segment is large - * enough to accommodate its data. - * - * @param m - * The packet mbuf. - * @param o - * The offset into the mbuf data. - * @param t - * The type to cast the result into. - */ -#define rte_pktmbuf_mtod_offset(m, t, o) \ - ((t)((char *)(m)->buf_addr + (m)->data_off + (o))) - -/** - * A macro that points to the start of the data in the mbuf. - * - * The returned pointer is cast to type t. Before using this - * function, the user must ensure that the first segment is large - * enough to accommodate its data. - * - * @param m - * The packet mbuf. - * @param t - * The type to cast the result into. - */ -#define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0) - -/** - * A macro that returns the IO address that points to an offset of the - * start of the data in the mbuf - * - * @param m - * The packet mbuf. - * @param o - * The offset into the data to calculate address from. - */ -#define rte_pktmbuf_iova_offset(m, o) \ - (rte_iova_t)((m)->buf_iova + (m)->data_off + (o)) - /* deprecated */ #define rte_pktmbuf_mtophys_offset(m, o) \ rte_pktmbuf_iova_offset(m, o) -/** - * A macro that returns the IO address that points to the start of the - * data in the mbuf - * - * @param m - * The packet mbuf. - */ -#define rte_pktmbuf_iova(m) rte_pktmbuf_iova_offset(m, 0) - /* deprecated */ #define rte_pktmbuf_mtophys(m) rte_pktmbuf_iova(m) diff --git a/lib/librte_mbuf/rte_mbuf_core.h b/lib/librte_mbuf/rte_mbuf_core.h new file mode 100644 index 000000000..f52272e55 --- /dev/null +++ b/lib/librte_mbuf/rte_mbuf_core.h @@ -0,0 +1,793 @@ +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright(c) 2010-2014 Intel Corporation. + * Copyright 2014 6WIND S.A. + */ + +#ifndef _RTE_MBUF_CORE_H_ +#define _RTE_MBUF_CORE_H_ + +/** + * @file + * This file contains definion of RTE mbuf structure itself, + * packet offload flags and some related macros. + * For majority of DPDK entities, it is not recommended to include + * this file directly, use include <rte_mbuf.h> instead. + */ + +#include <stdint.h> +#include <rte_compat.h> +#include <rte_common.h> + +#ifdef __cplusplus +extern "C" { +#endif + +/* + * Packet Offload Features Flags. It also carry packet type information. + * Critical resources. Both rx/tx shared these bits. Be cautious on any change + * + * - RX flags start at bit position zero, and get added to the left of previous + * flags. + * - The most-significant 3 bits are reserved for generic mbuf flags + * - TX flags therefore start at bit position 60 (i.e. 63-3), and new flags get + * added to the right of the previously defined flags i.e. they should count + * downwards, not upwards. + * + * Keep these flags synchronized with rte_get_rx_ol_flag_name() and + * rte_get_tx_ol_flag_name(). + */ + +/** + * The RX packet is a 802.1q VLAN packet, and the tci has been + * saved in in mbuf->vlan_tci. + * If the flag PKT_RX_VLAN_STRIPPED is also present, the VLAN + * header has been stripped from mbuf data, else it is still + * present. + */ +#define PKT_RX_VLAN (1ULL << 0) + +/** RX packet with RSS hash result. */ +#define PKT_RX_RSS_HASH (1ULL << 1) + + /** RX packet with FDIR match indicate. */ +#define PKT_RX_FDIR (1ULL << 2) + +/** + * Deprecated. + * Checking this flag alone is deprecated: check the 2 bits of + * PKT_RX_L4_CKSUM_MASK. + * This flag was set when the L4 checksum of a packet was detected as + * wrong by the hardware. + */ +#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) + +/** + * Deprecated. + * Checking this flag alone is deprecated: check the 2 bits of + * PKT_RX_IP_CKSUM_MASK. + * This flag was set when the IP checksum of a packet was detected as + * wrong by the hardware. + */ +#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) + + /** External IP header checksum error. */ +#define PKT_RX_EIP_CKSUM_BAD (1ULL << 5) + +/** + * A vlan has been stripped by the hardware and its tci is saved in + * mbuf->vlan_tci. This can only happen if vlan stripping is enabled + * in the RX configuration of the PMD. + * When PKT_RX_VLAN_STRIPPED is set, PKT_RX_VLAN must also be set. + */ +#define PKT_RX_VLAN_STRIPPED (1ULL << 6) + +/** + * Mask of bits used to determine the status of RX IP checksum. + * - PKT_RX_IP_CKSUM_UNKNOWN: no information about the RX IP checksum + * - PKT_RX_IP_CKSUM_BAD: the IP checksum in the packet is wrong + * - PKT_RX_IP_CKSUM_GOOD: the IP checksum in the packet is valid + * - PKT_RX_IP_CKSUM_NONE: the IP checksum is not correct in the packet + * data, but the integrity of the IP header is verified. + */ +#define PKT_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7)) + +#define PKT_RX_IP_CKSUM_UNKNOWN 0 +#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) +#define PKT_RX_IP_CKSUM_GOOD (1ULL << 7) +#define PKT_RX_IP_CKSUM_NONE ((1ULL << 4) | (1ULL << 7)) + +/** + * Mask of bits used to determine the status of RX L4 checksum. + * - PKT_RX_L4_CKSUM_UNKNOWN: no information about the RX L4 checksum + * - PKT_RX_L4_CKSUM_BAD: the L4 checksum in the packet is wrong + * - PKT_RX_L4_CKSUM_GOOD: the L4 checksum in the packet is valid + * - PKT_RX_L4_CKSUM_NONE: the L4 checksum is not correct in the packet + * data, but the integrity of the L4 data is verified. + */ +#define PKT_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8)) + +#define PKT_RX_L4_CKSUM_UNKNOWN 0 +#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) +#define PKT_RX_L4_CKSUM_GOOD (1ULL << 8) +#define PKT_RX_L4_CKSUM_NONE ((1ULL << 3) | (1ULL << 8)) + +/** RX IEEE1588 L2 Ethernet PT Packet. */ +#define PKT_RX_IEEE1588_PTP (1ULL << 9) + +/** RX IEEE1588 L2/L4 timestamped packet.*/ +#define PKT_RX_IEEE1588_TMST (1ULL << 10) + +/** FD id reported if FDIR match. */ +#define PKT_RX_FDIR_ID (1ULL << 13) + +/** Flexible bytes reported if FDIR match. */ +#define PKT_RX_FDIR_FLX (1ULL << 14) + +/** + * The 2 vlans have been stripped by the hardware and their tci are + * saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer). + * This can only happen if vlan stripping is enabled in the RX + * configuration of the PMD. + * When PKT_RX_QINQ_STRIPPED is set, the flags (PKT_RX_VLAN | + * PKT_RX_VLAN_STRIPPED | PKT_RX_QINQ) must also be set. + */ +#define PKT_RX_QINQ_STRIPPED (1ULL << 15) + +/** + * When packets are coalesced by a hardware or virtual driver, this flag + * can be set in the RX mbuf, meaning that the m->tso_segsz field is + * valid and is set to the segment size of original packets. + */ +#define PKT_RX_LRO (1ULL << 16) + +/** + * Indicate that the timestamp field in the mbuf is valid. + */ +#define PKT_RX_TIMESTAMP (1ULL << 17) + +/** + * Indicate that security offload processing was applied on the RX packet. + */ +#define PKT_RX_SEC_OFFLOAD (1ULL << 18) + +/** + * Indicate that security offload processing failed on the RX packet. + */ +#define PKT_RX_SEC_OFFLOAD_FAILED (1ULL << 19) + +/** + * The RX packet is a double VLAN, and the outer tci has been + * saved in in mbuf->vlan_tci_outer. If PKT_RX_QINQ set, PKT_RX_VLAN + * also should be set and inner tci should be saved to mbuf->vlan_tci. + * If the flag PKT_RX_QINQ_STRIPPED is also present, both VLANs + * headers have been stripped from mbuf data, else they are still + * present. + */ +#define PKT_RX_QINQ (1ULL << 20) + +/** + * Mask of bits used to determine the status of outer RX L4 checksum. + * - PKT_RX_OUTER_L4_CKSUM_UNKNOWN: no info about the outer RX L4 checksum + * - PKT_RX_OUTER_L4_CKSUM_BAD: the outer L4 checksum in the packet is wrong + * - PKT_RX_OUTER_L4_CKSUM_GOOD: the outer L4 checksum in the packet is valid + * - PKT_RX_OUTER_L4_CKSUM_INVALID: invalid outer L4 checksum state. + * + * The detection of PKT_RX_OUTER_L4_CKSUM_GOOD shall be based on the given + * HW capability, At minimum, the PMD should support + * PKT_RX_OUTER_L4_CKSUM_UNKNOWN and PKT_RX_OUTER_L4_CKSUM_BAD states + * if the DEV_RX_OFFLOAD_OUTER_UDP_CKSUM offload is available. + */ +#define PKT_RX_OUTER_L4_CKSUM_MASK ((1ULL << 21) | (1ULL << 22)) + +#define PKT_RX_OUTER_L4_CKSUM_UNKNOWN 0 +#define PKT_RX_OUTER_L4_CKSUM_BAD (1ULL << 21) +#define PKT_RX_OUTER_L4_CKSUM_GOOD (1ULL << 22) +#define PKT_RX_OUTER_L4_CKSUM_INVALID ((1ULL << 21) | (1ULL << 22)) + +/* add new RX flags here */ + +/* add new TX flags here */ + +/** + * Indicate that the metadata field in the mbuf is in use. + */ +#define PKT_TX_METADATA (1ULL << 40) + +/** + * Outer UDP checksum offload flag. This flag is used for enabling + * outer UDP checksum in PMD. To use outer UDP checksum, the user needs to + * 1) Enable the following in mbuf, + * a) Fill outer_l2_len and outer_l3_len in mbuf. + * b) Set the PKT_TX_OUTER_UDP_CKSUM flag. + * c) Set the PKT_TX_OUTER_IPV4 or PKT_TX_OUTER_IPV6 flag. + * 2) Configure DEV_TX_OFFLOAD_OUTER_UDP_CKSUM offload flag. + */ +#define PKT_TX_OUTER_UDP_CKSUM (1ULL << 41) + +/** + * UDP Fragmentation Offload flag. This flag is used for enabling UDP + * fragmentation in SW or in HW. When use UFO, mbuf->tso_segsz is used + * to store the MSS of UDP fragments. + */ +#define PKT_TX_UDP_SEG (1ULL << 42) + +/** + * Request security offload processing on the TX packet. + */ +#define PKT_TX_SEC_OFFLOAD (1ULL << 43) + +/** + * Offload the MACsec. This flag must be set by the application to enable + * this offload feature for a packet to be transmitted. + */ +#define PKT_TX_MACSEC (1ULL << 44) + +/** + * Bits 45:48 used for the tunnel type. + * The tunnel type must be specified for TSO or checksum on the inner part + * of tunnel packets. + * These flags can be used with PKT_TX_TCP_SEG for TSO, or PKT_TX_xxx_CKSUM. + * The mbuf fields for inner and outer header lengths are required: + * outer_l2_len, outer_l3_len, l2_len, l3_len, l4_len and tso_segsz for TSO. + */ +#define PKT_TX_TUNNEL_VXLAN (0x1ULL << 45) +#define PKT_TX_TUNNEL_GRE (0x2ULL << 45) +#define PKT_TX_TUNNEL_IPIP (0x3ULL << 45) +#define PKT_TX_TUNNEL_GENEVE (0x4ULL << 45) +/** TX packet with MPLS-in-UDP RFC 7510 header. */ +#define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45) +#define PKT_TX_TUNNEL_VXLAN_GPE (0x6ULL << 45) +/** + * Generic IP encapsulated tunnel type, used for TSO and checksum offload. + * It can be used for tunnels which are not standards or listed above. + * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_GRE + * or PKT_TX_TUNNEL_IPIP if possible. + * The ethdev must be configured with DEV_TX_OFFLOAD_IP_TNL_TSO. + * Outer and inner checksums are done according to the existing flags like + * PKT_TX_xxx_CKSUM. + * Specific tunnel headers that contain payload length, sequence id + * or checksum are not expected to be updated. + */ +#define PKT_TX_TUNNEL_IP (0xDULL << 45) +/** + * Generic UDP encapsulated tunnel type, used for TSO and checksum offload. + * UDP tunnel type implies outer IP layer. + * It can be used for tunnels which are not standards or listed above. + * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_VXLAN + * if possible. + * The ethdev must be configured with DEV_TX_OFFLOAD_UDP_TNL_TSO. + * Outer and inner checksums are done according to the existing flags like + * PKT_TX_xxx_CKSUM. + * Specific tunnel headers that contain payload length, sequence id + * or checksum are not expected to be updated. + */ +#define PKT_TX_TUNNEL_UDP (0xEULL << 45) +/* add new TX TUNNEL type here */ +#define PKT_TX_TUNNEL_MASK (0xFULL << 45) + +/** + * Double VLAN insertion (QinQ) request to driver, driver may offload the + * insertion based on device capability. + * mbuf 'vlan_tci' & 'vlan_tci_outer' must be valid when this flag is set. + */ +#define PKT_TX_QINQ (1ULL << 49) +/* this old name is deprecated */ +#define PKT_TX_QINQ_PKT PKT_TX_QINQ + +/** + * TCP segmentation offload. To enable this offload feature for a + * packet to be transmitted on hardware supporting TSO: + * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies + * PKT_TX_TCP_CKSUM) + * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 + * - if it's IPv4, set the PKT_TX_IP_CKSUM flag + * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz + */ +#define PKT_TX_TCP_SEG (1ULL << 50) + +/** TX IEEE1588 packet to timestamp. */ +#define PKT_TX_IEEE1588_TMST (1ULL << 51) + +/** + * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved, + * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware + * L4 checksum offload, the user needs to: + * - fill l2_len and l3_len in mbuf + * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM + * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 + */ +#define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */ + +/** TCP cksum of TX pkt. computed by NIC. */ +#define PKT_TX_TCP_CKSUM (1ULL << 52) + +/** SCTP cksum of TX pkt. computed by NIC. */ +#define PKT_TX_SCTP_CKSUM (2ULL << 52) + +/** UDP cksum of TX pkt. computed by NIC. */ +#define PKT_TX_UDP_CKSUM (3ULL << 52) + +/** Mask for L4 cksum offload request. */ +#define PKT_TX_L4_MASK (3ULL << 52) + +/** + * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should + * also be set by the application, although a PMD will only check + * PKT_TX_IP_CKSUM. + * - fill the mbuf offload information: l2_len, l3_len + */ +#define PKT_TX_IP_CKSUM (1ULL << 54) + +/** + * Packet is IPv4. This flag must be set when using any offload feature + * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4 + * packet. If the packet is a tunneled packet, this flag is related to + * the inner headers. + */ +#define PKT_TX_IPV4 (1ULL << 55) + +/** + * Packet is IPv6. This flag must be set when using an offload feature + * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6 + * packet. If the packet is a tunneled packet, this flag is related to + * the inner headers. + */ +#define PKT_TX_IPV6 (1ULL << 56) + +/** + * VLAN tag insertion request to driver, driver may offload the insertion + * based on the device capability. + * mbuf 'vlan_tci' field must be valid when this flag is set. + */ +#define PKT_TX_VLAN (1ULL << 57) +/* this old name is deprecated */ +#define PKT_TX_VLAN_PKT PKT_TX_VLAN + +/** + * Offload the IP checksum of an external header in the hardware. The + * flag PKT_TX_OUTER_IPV4 should also be set by the application, although + * a PMD will only check PKT_TX_OUTER_IP_CKSUM. + * - fill the mbuf offload information: outer_l2_len, outer_l3_len + */ +#define PKT_TX_OUTER_IP_CKSUM (1ULL << 58) + +/** + * Packet outer header is IPv4. This flag must be set when using any + * outer offload feature (L3 or L4 checksum) to tell the NIC that the + * outer header of the tunneled packet is an IPv4 packet. + */ +#define PKT_TX_OUTER_IPV4 (1ULL << 59) + +/** + * Packet outer header is IPv6. This flag must be set when using any + * outer offload feature (L4 checksum) to tell the NIC that the outer + * header of the tunneled packet is an IPv6 packet. + */ +#define PKT_TX_OUTER_IPV6 (1ULL << 60) + +/** + * Bitmask of all supported packet Tx offload features flags, + * which can be set for packet. + */ +#define PKT_TX_OFFLOAD_MASK ( \ + PKT_TX_OUTER_IPV6 | \ + PKT_TX_OUTER_IPV4 | \ + PKT_TX_OUTER_IP_CKSUM | \ + PKT_TX_VLAN_PKT | \ + PKT_TX_IPV6 | \ + PKT_TX_IPV4 | \ + PKT_TX_IP_CKSUM | \ + PKT_TX_L4_MASK | \ + PKT_TX_IEEE1588_TMST | \ + PKT_TX_TCP_SEG | \ + PKT_TX_QINQ_PKT | \ + PKT_TX_TUNNEL_MASK | \ + PKT_TX_MACSEC | \ + PKT_TX_SEC_OFFLOAD | \ + PKT_TX_UDP_SEG | \ + PKT_TX_OUTER_UDP_CKSUM | \ + PKT_TX_METADATA) + +/** + * Mbuf having an external buffer attached. shinfo in mbuf must be filled. + */ +#define EXT_ATTACHED_MBUF (1ULL << 61) + +#define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */ + +/** Alignment constraint of mbuf private area. */ +#define RTE_MBUF_PRIV_ALIGN 8 + +/** + * Some NICs need at least 2KB buffer to RX standard Ethernet frame without + * splitting it into multiple segments. + * So, for mbufs that planned to be involved into RX/TX, the recommended + * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM. + */ +#define RTE_MBUF_DEFAULT_DATAROOM 2048 +#define RTE_MBUF_DEFAULT_BUF_SIZE \ + (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM) + +/* + * define a set of marker types that can be used to refer to set points in the + * mbuf. + */ +__extension__ +typedef void *MARKER[0]; /**< generic marker for a point in a structure */ +__extension__ +typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */ + + /** marker that allows us to overwrite 8 bytes with a single assignment */ +__extension__ +typedef uint64_t MARKER64[0]; + +struct rte_mbuf_sched { + uint32_t queue_id; /**< Queue ID. */ + uint8_t traffic_class; + /**< Traffic class ID. Traffic class 0 + * is the highest priority traffic class. + */ + uint8_t color; + /**< Color. @see enum rte_color.*/ + uint16_t reserved; /**< Reserved. */ +}; /**< Hierarchical scheduler */ + +/** + * enum for the tx_offload bit-fields lengths and offsets. + * defines the layout of rte_mbuf tx_offload field. + */ +enum { + RTE_MBUF_L2_LEN_BITS = 7, + RTE_MBUF_L3_LEN_BITS = 9, + RTE_MBUF_L4_LEN_BITS = 8, + RTE_MBUF_TSO_SEGSZ_BITS = 16, + RTE_MBUF_OUTL3_LEN_BITS = 9, + RTE_MBUF_OUTL2_LEN_BITS = 7, + RTE_MBUF_TXOFLD_UNUSED_BITS = sizeof(uint64_t) * CHAR_BIT - + RTE_MBUF_L2_LEN_BITS - + RTE_MBUF_L3_LEN_BITS - + RTE_MBUF_L4_LEN_BITS - + RTE_MBUF_TSO_SEGSZ_BITS - + RTE_MBUF_OUTL3_LEN_BITS - + RTE_MBUF_OUTL2_LEN_BITS, +#if RTE_BYTE_ORDER == RTE_BIG_ENDIAN + RTE_MBUF_L2_LEN_OFS = + sizeof(uint64_t) * CHAR_BIT - RTE_MBUF_L2_LEN_BITS, + RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS - RTE_MBUF_L3_LEN_BITS, + RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS - RTE_MBUF_L4_LEN_BITS, + RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS - RTE_MBUF_TSO_SEGSZ_BITS, + RTE_MBUF_OUTL3_LEN_OFS = + RTE_MBUF_TSO_SEGSZ_OFS - RTE_MBUF_OUTL3_LEN_BITS, + RTE_MBUF_OUTL2_LEN_OFS = + RTE_MBUF_OUTL3_LEN_OFS - RTE_MBUF_OUTL2_LEN_BITS, + RTE_MBUF_TXOFLD_UNUSED_OFS = + RTE_MBUF_OUTL2_LEN_OFS - RTE_MBUF_TXOFLD_UNUSED_BITS, +#else + RTE_MBUF_L2_LEN_OFS = 0, + RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS + RTE_MBUF_L2_LEN_BITS, + RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS + RTE_MBUF_L3_LEN_BITS, + RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS + RTE_MBUF_L4_LEN_BITS, + RTE_MBUF_OUTL3_LEN_OFS = + RTE_MBUF_TSO_SEGSZ_OFS + RTE_MBUF_TSO_SEGSZ_BITS, + RTE_MBUF_OUTL2_LEN_OFS = + RTE_MBUF_OUTL3_LEN_OFS + RTE_MBUF_OUTL3_LEN_BITS, + RTE_MBUF_TXOFLD_UNUSED_OFS = + RTE_MBUF_OUTL2_LEN_OFS + RTE_MBUF_OUTL2_LEN_BITS, +#endif +}; + +/** + * The generic rte_mbuf, containing a packet mbuf. + */ +struct rte_mbuf { + MARKER cacheline0; + + void *buf_addr; /**< Virtual address of segment buffer. */ + /** + * Physical address of segment buffer. + * Force alignment to 8-bytes, so as to ensure we have the exact + * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes + * working on vector drivers easier. + */ + RTE_STD_C11 + union { + rte_iova_t buf_iova; + rte_iova_t buf_physaddr; /**< deprecated */ + } __rte_aligned(sizeof(rte_iova_t)); + + /* next 8 bytes are initialised on RX descriptor rearm */ + MARKER64 rearm_data; + uint16_t data_off; + + /** + * Reference counter. Its size should at least equal to the size + * of port field (16 bits), to support zero-copy broadcast. + * It should only be accessed using the following functions: + * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and + * rte_mbuf_refcnt_set(). The functionality of these functions (atomic, + * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC + * config option. + */ + RTE_STD_C11 + union { + rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */ + /** Non-atomically accessed refcnt */ + uint16_t refcnt; + }; + uint16_t nb_segs; /**< Number of segments. */ + + /** Input port (16 bits to support more than 256 virtual ports). + * The event eth Tx adapter uses this field to specify the output port. + */ + uint16_t port; + + uint64_t ol_flags; /**< Offload features. */ + + /* remaining bytes are set on RX when pulling packet from descriptor */ + MARKER rx_descriptor_fields1; + + /* + * The packet type, which is the combination of outer/inner L2, L3, L4 + * and tunnel types. The packet_type is about data really present in the + * mbuf. Example: if vlan stripping is enabled, a received vlan packet + * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the + * vlan is stripped from the data. + */ + RTE_STD_C11 + union { + uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */ + struct { + uint32_t l2_type:4; /**< (Outer) L2 type. */ + uint32_t l3_type:4; /**< (Outer) L3 type. */ + uint32_t l4_type:4; /**< (Outer) L4 type. */ + uint32_t tun_type:4; /**< Tunnel type. */ + RTE_STD_C11 + union { + uint8_t inner_esp_next_proto; + /**< ESP next protocol type, valid if + * RTE_PTYPE_TUNNEL_ESP tunnel type is set + * on both Tx and Rx. + */ + __extension__ + struct { + uint8_t inner_l2_type:4; + /**< Inner L2 type. */ + uint8_t inner_l3_type:4; + /**< Inner L3 type. */ + }; + }; + uint32_t inner_l4_type:4; /**< Inner L4 type. */ + }; + }; + + uint32_t pkt_len; /**< Total pkt len: sum of all segments. */ + uint16_t data_len; /**< Amount of data in segment buffer. */ + /** VLAN TCI (CPU order), valid if PKT_RX_VLAN is set. */ + uint16_t vlan_tci; + + RTE_STD_C11 + union { + union { + uint32_t rss; /**< RSS hash result if RSS enabled */ + struct { + union { + struct { + uint16_t hash; + uint16_t id; + }; + uint32_t lo; + /**< Second 4 flexible bytes */ + }; + uint32_t hi; + /**< First 4 flexible bytes or FD ID, dependent + * on PKT_RX_FDIR_* flag in ol_flags. + */ + } fdir; /**< Filter identifier if FDIR enabled */ + struct rte_mbuf_sched sched; + /**< Hierarchical scheduler : 8 bytes */ + struct { + uint32_t reserved1; + uint16_t reserved2; + uint16_t txq; + /**< The event eth Tx adapter uses this field + * to store Tx queue id. + * @see rte_event_eth_tx_adapter_txq_set() + */ + } txadapter; /**< Eventdev ethdev Tx adapter */ + /**< User defined tags. See rte_distributor_process() */ + uint32_t usr; + } hash; /**< hash information */ + struct { + /** + * Application specific metadata value + * for egress flow rule match. + * Valid if PKT_TX_METADATA is set. + * Located here to allow conjunct use + * with hash.sched.hi. + */ + uint32_t tx_metadata; + uint32_t reserved; + }; + }; + + /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ is set. */ + uint16_t vlan_tci_outer; + + uint16_t buf_len; /**< Length of segment buffer. */ + + /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference + * are not normalized but are always the same for a given port. + * Some devices allow to query rte_eth_read_clock that will return the + * current device timestamp. + */ + uint64_t timestamp; + + /* second cache line - fields only used in slow path or on TX */ + MARKER cacheline1 __rte_cache_min_aligned; + + RTE_STD_C11 + union { + void *userdata; /**< Can be used for external metadata */ + uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */ + }; + + struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */ + struct rte_mbuf *next; /**< Next segment of scattered packet. */ + + /* fields to support TX offloads */ + RTE_STD_C11 + union { + uint64_t tx_offload; /**< combined for easy fetch */ + __extension__ + struct { + uint64_t l2_len:RTE_MBUF_L2_LEN_BITS; + /**< L2 (MAC) Header Length for non-tunneling pkt. + * Outer_L4_len + ... + Inner_L2_len for tunneling pkt. + */ + uint64_t l3_len:RTE_MBUF_L3_LEN_BITS; + /**< L3 (IP) Header Length. */ + uint64_t l4_len:RTE_MBUF_L4_LEN_BITS; + /**< L4 (TCP/UDP) Header Length. */ + uint64_t tso_segsz:RTE_MBUF_TSO_SEGSZ_BITS; + /**< TCP TSO segment size */ + + /* + * Fields for Tx offloading of tunnels. + * These are undefined for packets which don't request + * any tunnel offloads (outer IP or UDP checksum, + * tunnel TSO). + * + * PMDs should not use these fields unconditionally + * when calculating offsets. + * + * Applications are expected to set appropriate tunnel + * offload flags when they fill in these fields. + */ + uint64_t outer_l3_len:RTE_MBUF_OUTL3_LEN_BITS; + /**< Outer L3 (IP) Hdr Length. */ + uint64_t outer_l2_len:RTE_MBUF_OUTL2_LEN_BITS; + /**< Outer L2 (MAC) Hdr Length. */ + + /* uint64_t unused:RTE_MBUF_TXOFLD_UNUSED_BITS; */ + }; + }; + + /** Size of the application private data. In case of an indirect + * mbuf, it stores the direct mbuf private data size. + */ + uint16_t priv_size; + + /** Timesync flags for use with IEEE1588. */ + uint16_t timesync; + + /** Sequence number. See also rte_reorder_insert(). */ + uint32_t seqn; + + /** Shared data for external buffer attached to mbuf. See + * rte_pktmbuf_attach_extbuf(). + */ + struct rte_mbuf_ext_shared_info *shinfo; + +} __rte_cache_aligned; + +/** + * Function typedef of callback to free externally attached buffer. + */ +typedef void (*rte_mbuf_extbuf_free_callback_t)(void *addr, void *opaque); + +/** + * Shared data at the end of an external buffer. + */ +struct rte_mbuf_ext_shared_info { + rte_mbuf_extbuf_free_callback_t free_cb; /**< Free callback function */ + void *fcb_opaque; /**< Free callback argument */ + rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */ +}; + +/**< Maximum number of nb_segs allowed. */ +#define RTE_MBUF_MAX_NB_SEGS UINT16_MAX + +/** + * Returns TRUE if given mbuf is cloned by mbuf indirection, or FALSE + * otherwise. + * + * If a mbuf has its data in another mbuf and references it by mbuf + * indirection, this mbuf can be defined as a cloned mbuf. + */ +#define RTE_MBUF_CLONED(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF) + +/** + * Returns TRUE if given mbuf has an external buffer, or FALSE otherwise. + * + * External buffer is a user-provided anonymous buffer. + */ +#define RTE_MBUF_HAS_EXTBUF(mb) ((mb)->ol_flags & EXT_ATTACHED_MBUF) + +/** + * Returns TRUE if given mbuf is direct, or FALSE otherwise. + * + * If a mbuf embeds its own data after the rte_mbuf structure, this mbuf + * can be defined as a direct mbuf. + */ +#define RTE_MBUF_DIRECT(mb) \ + (!((mb)->ol_flags & (IND_ATTACHED_MBUF | EXT_ATTACHED_MBUF))) + +#define MBUF_INVALID_PORT UINT16_MAX + +/** + * A macro that points to an offset into the data in the mbuf. + * + * The returned pointer is cast to type t. Before using this + * function, the user must ensure that the first segment is large + * enough to accommodate its data. + * + * @param m + * The packet mbuf. + * @param o + * The offset into the mbuf data. + * @param t + * The type to cast the result into. + */ +#define rte_pktmbuf_mtod_offset(m, t, o) \ + ((t)((char *)(m)->buf_addr + (m)->data_off + (o))) + +/** + * A macro that points to the start of the data in the mbuf. + * + * The returned pointer is cast to type t. Before using this + * function, the user must ensure that the first segment is large + * enough to accommodate its data. + * + * @param m + * The packet mbuf. + * @param t + * The type to cast the result into. + */ +#define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0) + +/** + * A macro that returns the IO address that points to an offset of the + * start of the data in the mbuf + * + * @param m + * The packet mbuf. + * @param o + * The offset into the data to calculate address from. + */ +#define rte_pktmbuf_iova_offset(m, o) \ + (rte_iova_t)((m)->buf_iova + (m)->data_off + (o)) + +/** + * A macro that returns the IO address that points to the start of the + * data in the mbuf + * + * @param m + * The packet mbuf. + */ +#define rte_pktmbuf_iova(m) rte_pktmbuf_iova_offset(m, 0) + +#ifdef __cplusplus +} +#endif + +#endif /* _RTE_MBUF_CORE_H_ */ -- 2.17.1 ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [dpdk-dev] [PATCH 2/3] mbuf: move mbuf definition into a separate file 2019-08-16 12:53 ` [dpdk-dev] [PATCH 2/3] mbuf: move mbuf definition into a separate file Konstantin Ananyev @ 2019-08-16 18:51 ` Michel Machado 0 siblings, 0 replies; 17+ messages in thread From: Michel Machado @ 2019-08-16 18:51 UTC (permalink / raw) To: Konstantin Ananyev, dev; +Cc: olivier.matz, anatoly.burakov, vipin.varghese Acked-by: Michel Machado <michel@digirati.com.br> [ ]'s Michel Machado On 8/16/19 8:53 AM, Konstantin Ananyev wrote: > Right now inclusion of rte_mbuf.h header can cause inclusion of > some arch/os specific headers. > That prevents it to be included directly by some > non-DPDK (but related) entities: KNI, BPF programs, etc. > To overcome that problem usually a separate definitions of rte_mbuf > structure is created within these entities. > That aproach has a lot of drawbacks: code duplication, error prone, etc. > This patch moves rte_mbuf structure definition (and some related macros) > into a separate file that can be included by both rte_mbuf.h and > other non-DPDK entities. > > Note that it doesn't introduce any change for current DPDK code. > > Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com> > --- > lib/librte_mbuf/Makefile | 5 +- > lib/librte_mbuf/meson.build | 3 +- > lib/librte_mbuf/rte_mbuf.h | 738 +---------------------------- > lib/librte_mbuf/rte_mbuf_core.h | 793 ++++++++++++++++++++++++++++++++ > 4 files changed, 800 insertions(+), 739 deletions(-) > create mode 100644 lib/librte_mbuf/rte_mbuf_core.h > > diff --git a/lib/librte_mbuf/Makefile b/lib/librte_mbuf/Makefile > index c8f6d2689..f3b76ad23 100644 > --- a/lib/librte_mbuf/Makefile > +++ b/lib/librte_mbuf/Makefile > @@ -19,6 +19,9 @@ LIBABIVER := 5 > SRCS-$(CONFIG_RTE_LIBRTE_MBUF) := rte_mbuf.c rte_mbuf_ptype.c rte_mbuf_pool_ops.c > > # install includes > -SYMLINK-$(CONFIG_RTE_LIBRTE_MBUF)-include := rte_mbuf.h rte_mbuf_ptype.h rte_mbuf_pool_ops.h > +SYMLINK-$(CONFIG_RTE_LIBRTE_MBUF)-include := rte_mbuf.h > +SYMLINK-$(CONFIG_RTE_LIBRTE_MBUF)-include += rte_mbuf_core.h > +SYMLINK-$(CONFIG_RTE_LIBRTE_MBUF)-include += rte_mbuf_ptype.h > +SYMLINK-$(CONFIG_RTE_LIBRTE_MBUF)-include += rte_mbuf_pool_ops.h > > include $(RTE_SDK)/mk/rte.lib.mk > diff --git a/lib/librte_mbuf/meson.build b/lib/librte_mbuf/meson.build > index 6cc11ebb4..36bb6eb9d 100644 > --- a/lib/librte_mbuf/meson.build > +++ b/lib/librte_mbuf/meson.build > @@ -3,7 +3,8 @@ > > version = 5 > sources = files('rte_mbuf.c', 'rte_mbuf_ptype.c', 'rte_mbuf_pool_ops.c') > -headers = files('rte_mbuf.h', 'rte_mbuf_ptype.h', 'rte_mbuf_pool_ops.h') > +headers = files('rte_mbuf.h', 'rte_mbuf_core.h', > + 'rte_mbuf_ptype.h', 'rte_mbuf_pool_ops.h') > deps += ['mempool'] > > allow_experimental_apis = true > diff --git a/lib/librte_mbuf/rte_mbuf.h b/lib/librte_mbuf/rte_mbuf.h > index 98225ec80..528b2f121 100644 > --- a/lib/librte_mbuf/rte_mbuf.h > +++ b/lib/librte_mbuf/rte_mbuf.h > @@ -42,367 +42,12 @@ > #include <rte_branch_prediction.h> > #include <rte_byteorder.h> > #include <rte_mbuf_ptype.h> > +#include <rte_mbuf_core.h> > > #ifdef __cplusplus > extern "C" { > #endif > > -/* > - * Packet Offload Features Flags. It also carry packet type information. > - * Critical resources. Both rx/tx shared these bits. Be cautious on any change > - * > - * - RX flags start at bit position zero, and get added to the left of previous > - * flags. > - * - The most-significant 3 bits are reserved for generic mbuf flags > - * - TX flags therefore start at bit position 60 (i.e. 63-3), and new flags get > - * added to the right of the previously defined flags i.e. they should count > - * downwards, not upwards. > - * > - * Keep these flags synchronized with rte_get_rx_ol_flag_name() and > - * rte_get_tx_ol_flag_name(). > - */ > - > -/** > - * The RX packet is a 802.1q VLAN packet, and the tci has been > - * saved in in mbuf->vlan_tci. > - * If the flag PKT_RX_VLAN_STRIPPED is also present, the VLAN > - * header has been stripped from mbuf data, else it is still > - * present. > - */ > -#define PKT_RX_VLAN (1ULL << 0) > - > -#define PKT_RX_RSS_HASH (1ULL << 1) /**< RX packet with RSS hash result. */ > -#define PKT_RX_FDIR (1ULL << 2) /**< RX packet with FDIR match indicate. */ > - > -/** > - * Deprecated. > - * Checking this flag alone is deprecated: check the 2 bits of > - * PKT_RX_L4_CKSUM_MASK. > - * This flag was set when the L4 checksum of a packet was detected as > - * wrong by the hardware. > - */ > -#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) > - > -/** > - * Deprecated. > - * Checking this flag alone is deprecated: check the 2 bits of > - * PKT_RX_IP_CKSUM_MASK. > - * This flag was set when the IP checksum of a packet was detected as > - * wrong by the hardware. > - */ > -#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) > - > -#define PKT_RX_EIP_CKSUM_BAD (1ULL << 5) /**< External IP header checksum error. */ > - > -/** > - * A vlan has been stripped by the hardware and its tci is saved in > - * mbuf->vlan_tci. This can only happen if vlan stripping is enabled > - * in the RX configuration of the PMD. > - * When PKT_RX_VLAN_STRIPPED is set, PKT_RX_VLAN must also be set. > - */ > -#define PKT_RX_VLAN_STRIPPED (1ULL << 6) > - > -/** > - * Mask of bits used to determine the status of RX IP checksum. > - * - PKT_RX_IP_CKSUM_UNKNOWN: no information about the RX IP checksum > - * - PKT_RX_IP_CKSUM_BAD: the IP checksum in the packet is wrong > - * - PKT_RX_IP_CKSUM_GOOD: the IP checksum in the packet is valid > - * - PKT_RX_IP_CKSUM_NONE: the IP checksum is not correct in the packet > - * data, but the integrity of the IP header is verified. > - */ > -#define PKT_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7)) > - > -#define PKT_RX_IP_CKSUM_UNKNOWN 0 > -#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) > -#define PKT_RX_IP_CKSUM_GOOD (1ULL << 7) > -#define PKT_RX_IP_CKSUM_NONE ((1ULL << 4) | (1ULL << 7)) > - > -/** > - * Mask of bits used to determine the status of RX L4 checksum. > - * - PKT_RX_L4_CKSUM_UNKNOWN: no information about the RX L4 checksum > - * - PKT_RX_L4_CKSUM_BAD: the L4 checksum in the packet is wrong > - * - PKT_RX_L4_CKSUM_GOOD: the L4 checksum in the packet is valid > - * - PKT_RX_L4_CKSUM_NONE: the L4 checksum is not correct in the packet > - * data, but the integrity of the L4 data is verified. > - */ > -#define PKT_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8)) > - > -#define PKT_RX_L4_CKSUM_UNKNOWN 0 > -#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) > -#define PKT_RX_L4_CKSUM_GOOD (1ULL << 8) > -#define PKT_RX_L4_CKSUM_NONE ((1ULL << 3) | (1ULL << 8)) > - > -#define PKT_RX_IEEE1588_PTP (1ULL << 9) /**< RX IEEE1588 L2 Ethernet PT Packet. */ > -#define PKT_RX_IEEE1588_TMST (1ULL << 10) /**< RX IEEE1588 L2/L4 timestamped packet.*/ > -#define PKT_RX_FDIR_ID (1ULL << 13) /**< FD id reported if FDIR match. */ > -#define PKT_RX_FDIR_FLX (1ULL << 14) /**< Flexible bytes reported if FDIR match. */ > - > -/** > - * The 2 vlans have been stripped by the hardware and their tci are > - * saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer). > - * This can only happen if vlan stripping is enabled in the RX > - * configuration of the PMD. > - * When PKT_RX_QINQ_STRIPPED is set, the flags (PKT_RX_VLAN | > - * PKT_RX_VLAN_STRIPPED | PKT_RX_QINQ) must also be set. > - */ > -#define PKT_RX_QINQ_STRIPPED (1ULL << 15) > - > -/** > - * When packets are coalesced by a hardware or virtual driver, this flag > - * can be set in the RX mbuf, meaning that the m->tso_segsz field is > - * valid and is set to the segment size of original packets. > - */ > -#define PKT_RX_LRO (1ULL << 16) > - > -/** > - * Indicate that the timestamp field in the mbuf is valid. > - */ > -#define PKT_RX_TIMESTAMP (1ULL << 17) > - > -/** > - * Indicate that security offload processing was applied on the RX packet. > - */ > -#define PKT_RX_SEC_OFFLOAD (1ULL << 18) > - > -/** > - * Indicate that security offload processing failed on the RX packet. > - */ > -#define PKT_RX_SEC_OFFLOAD_FAILED (1ULL << 19) > - > -/** > - * The RX packet is a double VLAN, and the outer tci has been > - * saved in in mbuf->vlan_tci_outer. If PKT_RX_QINQ set, PKT_RX_VLAN > - * also should be set and inner tci should be saved to mbuf->vlan_tci. > - * If the flag PKT_RX_QINQ_STRIPPED is also present, both VLANs > - * headers have been stripped from mbuf data, else they are still > - * present. > - */ > -#define PKT_RX_QINQ (1ULL << 20) > - > -/** > - * Mask of bits used to determine the status of outer RX L4 checksum. > - * - PKT_RX_OUTER_L4_CKSUM_UNKNOWN: no info about the outer RX L4 checksum > - * - PKT_RX_OUTER_L4_CKSUM_BAD: the outer L4 checksum in the packet is wrong > - * - PKT_RX_OUTER_L4_CKSUM_GOOD: the outer L4 checksum in the packet is valid > - * - PKT_RX_OUTER_L4_CKSUM_INVALID: invalid outer L4 checksum state. > - * > - * The detection of PKT_RX_OUTER_L4_CKSUM_GOOD shall be based on the given > - * HW capability, At minimum, the PMD should support > - * PKT_RX_OUTER_L4_CKSUM_UNKNOWN and PKT_RX_OUTER_L4_CKSUM_BAD states > - * if the DEV_RX_OFFLOAD_OUTER_UDP_CKSUM offload is available. > - */ > -#define PKT_RX_OUTER_L4_CKSUM_MASK ((1ULL << 21) | (1ULL << 22)) > - > -#define PKT_RX_OUTER_L4_CKSUM_UNKNOWN 0 > -#define PKT_RX_OUTER_L4_CKSUM_BAD (1ULL << 21) > -#define PKT_RX_OUTER_L4_CKSUM_GOOD (1ULL << 22) > -#define PKT_RX_OUTER_L4_CKSUM_INVALID ((1ULL << 21) | (1ULL << 22)) > - > -/* add new RX flags here */ > - > -/* add new TX flags here */ > - > -/** > - * Indicate that the metadata field in the mbuf is in use. > - */ > -#define PKT_TX_METADATA (1ULL << 40) > - > -/** > - * Outer UDP checksum offload flag. This flag is used for enabling > - * outer UDP checksum in PMD. To use outer UDP checksum, the user needs to > - * 1) Enable the following in mbuf, > - * a) Fill outer_l2_len and outer_l3_len in mbuf. > - * b) Set the PKT_TX_OUTER_UDP_CKSUM flag. > - * c) Set the PKT_TX_OUTER_IPV4 or PKT_TX_OUTER_IPV6 flag. > - * 2) Configure DEV_TX_OFFLOAD_OUTER_UDP_CKSUM offload flag. > - */ > -#define PKT_TX_OUTER_UDP_CKSUM (1ULL << 41) > - > -/** > - * UDP Fragmentation Offload flag. This flag is used for enabling UDP > - * fragmentation in SW or in HW. When use UFO, mbuf->tso_segsz is used > - * to store the MSS of UDP fragments. > - */ > -#define PKT_TX_UDP_SEG (1ULL << 42) > - > -/** > - * Request security offload processing on the TX packet. > - */ > -#define PKT_TX_SEC_OFFLOAD (1ULL << 43) > - > -/** > - * Offload the MACsec. This flag must be set by the application to enable > - * this offload feature for a packet to be transmitted. > - */ > -#define PKT_TX_MACSEC (1ULL << 44) > - > -/** > - * Bits 45:48 used for the tunnel type. > - * The tunnel type must be specified for TSO or checksum on the inner part > - * of tunnel packets. > - * These flags can be used with PKT_TX_TCP_SEG for TSO, or PKT_TX_xxx_CKSUM. > - * The mbuf fields for inner and outer header lengths are required: > - * outer_l2_len, outer_l3_len, l2_len, l3_len, l4_len and tso_segsz for TSO. > - */ > -#define PKT_TX_TUNNEL_VXLAN (0x1ULL << 45) > -#define PKT_TX_TUNNEL_GRE (0x2ULL << 45) > -#define PKT_TX_TUNNEL_IPIP (0x3ULL << 45) > -#define PKT_TX_TUNNEL_GENEVE (0x4ULL << 45) > -/** TX packet with MPLS-in-UDP RFC 7510 header. */ > -#define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45) > -#define PKT_TX_TUNNEL_VXLAN_GPE (0x6ULL << 45) > -/** > - * Generic IP encapsulated tunnel type, used for TSO and checksum offload. > - * It can be used for tunnels which are not standards or listed above. > - * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_GRE > - * or PKT_TX_TUNNEL_IPIP if possible. > - * The ethdev must be configured with DEV_TX_OFFLOAD_IP_TNL_TSO. > - * Outer and inner checksums are done according to the existing flags like > - * PKT_TX_xxx_CKSUM. > - * Specific tunnel headers that contain payload length, sequence id > - * or checksum are not expected to be updated. > - */ > -#define PKT_TX_TUNNEL_IP (0xDULL << 45) > -/** > - * Generic UDP encapsulated tunnel type, used for TSO and checksum offload. > - * UDP tunnel type implies outer IP layer. > - * It can be used for tunnels which are not standards or listed above. > - * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_VXLAN > - * if possible. > - * The ethdev must be configured with DEV_TX_OFFLOAD_UDP_TNL_TSO. > - * Outer and inner checksums are done according to the existing flags like > - * PKT_TX_xxx_CKSUM. > - * Specific tunnel headers that contain payload length, sequence id > - * or checksum are not expected to be updated. > - */ > -#define PKT_TX_TUNNEL_UDP (0xEULL << 45) > -/* add new TX TUNNEL type here */ > -#define PKT_TX_TUNNEL_MASK (0xFULL << 45) > - > -/** > - * Double VLAN insertion (QinQ) request to driver, driver may offload the > - * insertion based on device capability. > - * mbuf 'vlan_tci' & 'vlan_tci_outer' must be valid when this flag is set. > - */ > -#define PKT_TX_QINQ (1ULL << 49) > -/* this old name is deprecated */ > -#define PKT_TX_QINQ_PKT PKT_TX_QINQ > - > -/** > - * TCP segmentation offload. To enable this offload feature for a > - * packet to be transmitted on hardware supporting TSO: > - * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies > - * PKT_TX_TCP_CKSUM) > - * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 > - * - if it's IPv4, set the PKT_TX_IP_CKSUM flag > - * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz > - */ > -#define PKT_TX_TCP_SEG (1ULL << 50) > - > -#define PKT_TX_IEEE1588_TMST (1ULL << 51) /**< TX IEEE1588 packet to timestamp. */ > - > -/** > - * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved, > - * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware > - * L4 checksum offload, the user needs to: > - * - fill l2_len and l3_len in mbuf > - * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM > - * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 > - */ > -#define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */ > -#define PKT_TX_TCP_CKSUM (1ULL << 52) /**< TCP cksum of TX pkt. computed by NIC. */ > -#define PKT_TX_SCTP_CKSUM (2ULL << 52) /**< SCTP cksum of TX pkt. computed by NIC. */ > -#define PKT_TX_UDP_CKSUM (3ULL << 52) /**< UDP cksum of TX pkt. computed by NIC. */ > -#define PKT_TX_L4_MASK (3ULL << 52) /**< Mask for L4 cksum offload request. */ > - > -/** > - * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should > - * also be set by the application, although a PMD will only check > - * PKT_TX_IP_CKSUM. > - * - fill the mbuf offload information: l2_len, l3_len > - */ > -#define PKT_TX_IP_CKSUM (1ULL << 54) > - > -/** > - * Packet is IPv4. This flag must be set when using any offload feature > - * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4 > - * packet. If the packet is a tunneled packet, this flag is related to > - * the inner headers. > - */ > -#define PKT_TX_IPV4 (1ULL << 55) > - > -/** > - * Packet is IPv6. This flag must be set when using an offload feature > - * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6 > - * packet. If the packet is a tunneled packet, this flag is related to > - * the inner headers. > - */ > -#define PKT_TX_IPV6 (1ULL << 56) > - > -/** > - * VLAN tag insertion request to driver, driver may offload the insertion > - * based on the device capability. > - * mbuf 'vlan_tci' field must be valid when this flag is set. > - */ > -#define PKT_TX_VLAN (1ULL << 57) > -/* this old name is deprecated */ > -#define PKT_TX_VLAN_PKT PKT_TX_VLAN > - > -/** > - * Offload the IP checksum of an external header in the hardware. The > - * flag PKT_TX_OUTER_IPV4 should also be set by the application, although > - * a PMD will only check PKT_TX_OUTER_IP_CKSUM. > - * - fill the mbuf offload information: outer_l2_len, outer_l3_len > - */ > -#define PKT_TX_OUTER_IP_CKSUM (1ULL << 58) > - > -/** > - * Packet outer header is IPv4. This flag must be set when using any > - * outer offload feature (L3 or L4 checksum) to tell the NIC that the > - * outer header of the tunneled packet is an IPv4 packet. > - */ > -#define PKT_TX_OUTER_IPV4 (1ULL << 59) > - > -/** > - * Packet outer header is IPv6. This flag must be set when using any > - * outer offload feature (L4 checksum) to tell the NIC that the outer > - * header of the tunneled packet is an IPv6 packet. > - */ > -#define PKT_TX_OUTER_IPV6 (1ULL << 60) > - > -/** > - * Bitmask of all supported packet Tx offload features flags, > - * which can be set for packet. > - */ > -#define PKT_TX_OFFLOAD_MASK ( \ > - PKT_TX_OUTER_IPV6 | \ > - PKT_TX_OUTER_IPV4 | \ > - PKT_TX_OUTER_IP_CKSUM | \ > - PKT_TX_VLAN_PKT | \ > - PKT_TX_IPV6 | \ > - PKT_TX_IPV4 | \ > - PKT_TX_IP_CKSUM | \ > - PKT_TX_L4_MASK | \ > - PKT_TX_IEEE1588_TMST | \ > - PKT_TX_TCP_SEG | \ > - PKT_TX_QINQ_PKT | \ > - PKT_TX_TUNNEL_MASK | \ > - PKT_TX_MACSEC | \ > - PKT_TX_SEC_OFFLOAD | \ > - PKT_TX_UDP_SEG | \ > - PKT_TX_OUTER_UDP_CKSUM | \ > - PKT_TX_METADATA) > - > -/** > - * Mbuf having an external buffer attached. shinfo in mbuf must be filled. > - */ > -#define EXT_ATTACHED_MBUF (1ULL << 61) > - > -#define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */ > - > -/** Alignment constraint of mbuf private area. */ > -#define RTE_MBUF_PRIV_ALIGN 8 > - > /** > * Get the name of a RX offload flag > * > @@ -453,310 +98,6 @@ const char *rte_get_tx_ol_flag_name(uint64_t mask); > */ > int rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen); > > -/** > - * Some NICs need at least 2KB buffer to RX standard Ethernet frame without > - * splitting it into multiple segments. > - * So, for mbufs that planned to be involved into RX/TX, the recommended > - * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM. > - */ > -#define RTE_MBUF_DEFAULT_DATAROOM 2048 > -#define RTE_MBUF_DEFAULT_BUF_SIZE \ > - (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM) > - > -/* define a set of marker types that can be used to refer to set points in the > - * mbuf */ > -__extension__ > -typedef void *MARKER[0]; /**< generic marker for a point in a structure */ > -__extension__ > -typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */ > -__extension__ > -typedef uint64_t MARKER64[0]; /**< marker that allows us to overwrite 8 bytes > - * with a single assignment */ > - > -struct rte_mbuf_sched { > - uint32_t queue_id; /**< Queue ID. */ > - uint8_t traffic_class; > - /**< Traffic class ID. Traffic class 0 > - * is the highest priority traffic class. > - */ > - uint8_t color; > - /**< Color. @see enum rte_color.*/ > - uint16_t reserved; /**< Reserved. */ > -}; /**< Hierarchical scheduler */ > - > -/** > - * enum for the tx_offload bit-fields lengths and offsets. > - * defines the layout of rte_mbuf tx_offload field. > - */ > -enum { > - RTE_MBUF_L2_LEN_BITS = 7, > - RTE_MBUF_L3_LEN_BITS = 9, > - RTE_MBUF_L4_LEN_BITS = 8, > - RTE_MBUF_TSO_SEGSZ_BITS = 16, > - RTE_MBUF_OUTL3_LEN_BITS = 9, > - RTE_MBUF_OUTL2_LEN_BITS = 7, > - RTE_MBUF_TXOFLD_UNUSED_BITS = sizeof(uint64_t) * CHAR_BIT - > - RTE_MBUF_L2_LEN_BITS - > - RTE_MBUF_L3_LEN_BITS - > - RTE_MBUF_L4_LEN_BITS - > - RTE_MBUF_TSO_SEGSZ_BITS - > - RTE_MBUF_OUTL3_LEN_BITS - > - RTE_MBUF_OUTL2_LEN_BITS, > -#if RTE_BYTE_ORDER == RTE_BIG_ENDIAN > - RTE_MBUF_L2_LEN_OFS = > - sizeof(uint64_t) * CHAR_BIT - RTE_MBUF_L2_LEN_BITS, > - RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS - RTE_MBUF_L3_LEN_BITS, > - RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS - RTE_MBUF_L4_LEN_BITS, > - RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS - RTE_MBUF_TSO_SEGSZ_BITS, > - RTE_MBUF_OUTL3_LEN_OFS = > - RTE_MBUF_TSO_SEGSZ_OFS - RTE_MBUF_OUTL3_LEN_BITS, > - RTE_MBUF_OUTL2_LEN_OFS = > - RTE_MBUF_OUTL3_LEN_OFS - RTE_MBUF_OUTL2_LEN_BITS, > - RTE_MBUF_TXOFLD_UNUSED_OFS = > - RTE_MBUF_OUTL2_LEN_OFS - RTE_MBUF_TXOFLD_UNUSED_BITS, > -#else > - RTE_MBUF_L2_LEN_OFS = 0, > - RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS + RTE_MBUF_L2_LEN_BITS, > - RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS + RTE_MBUF_L3_LEN_BITS, > - RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS + RTE_MBUF_L4_LEN_BITS, > - RTE_MBUF_OUTL3_LEN_OFS = > - RTE_MBUF_TSO_SEGSZ_OFS + RTE_MBUF_TSO_SEGSZ_BITS, > - RTE_MBUF_OUTL2_LEN_OFS = > - RTE_MBUF_OUTL3_LEN_OFS + RTE_MBUF_OUTL3_LEN_BITS, > - RTE_MBUF_TXOFLD_UNUSED_OFS = > - RTE_MBUF_OUTL2_LEN_OFS + RTE_MBUF_OUTL2_LEN_BITS, > -#endif > -}; > - > -/** > - * The generic rte_mbuf, containing a packet mbuf. > - */ > -struct rte_mbuf { > - MARKER cacheline0; > - > - void *buf_addr; /**< Virtual address of segment buffer. */ > - /** > - * Physical address of segment buffer. > - * Force alignment to 8-bytes, so as to ensure we have the exact > - * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes > - * working on vector drivers easier. > - */ > - RTE_STD_C11 > - union { > - rte_iova_t buf_iova; > - rte_iova_t buf_physaddr; /**< deprecated */ > - } __rte_aligned(sizeof(rte_iova_t)); > - > - /* next 8 bytes are initialised on RX descriptor rearm */ > - MARKER64 rearm_data; > - uint16_t data_off; > - > - /** > - * Reference counter. Its size should at least equal to the size > - * of port field (16 bits), to support zero-copy broadcast. > - * It should only be accessed using the following functions: > - * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and > - * rte_mbuf_refcnt_set(). The functionality of these functions (atomic, > - * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC > - * config option. > - */ > - RTE_STD_C11 > - union { > - rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */ > - uint16_t refcnt; /**< Non-atomically accessed refcnt */ > - }; > - uint16_t nb_segs; /**< Number of segments. */ > - > - /** Input port (16 bits to support more than 256 virtual ports). > - * The event eth Tx adapter uses this field to specify the output port. > - */ > - uint16_t port; > - > - uint64_t ol_flags; /**< Offload features. */ > - > - /* remaining bytes are set on RX when pulling packet from descriptor */ > - MARKER rx_descriptor_fields1; > - > - /* > - * The packet type, which is the combination of outer/inner L2, L3, L4 > - * and tunnel types. The packet_type is about data really present in the > - * mbuf. Example: if vlan stripping is enabled, a received vlan packet > - * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the > - * vlan is stripped from the data. > - */ > - RTE_STD_C11 > - union { > - uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */ > - struct { > - uint32_t l2_type:4; /**< (Outer) L2 type. */ > - uint32_t l3_type:4; /**< (Outer) L3 type. */ > - uint32_t l4_type:4; /**< (Outer) L4 type. */ > - uint32_t tun_type:4; /**< Tunnel type. */ > - RTE_STD_C11 > - union { > - uint8_t inner_esp_next_proto; > - /**< ESP next protocol type, valid if > - * RTE_PTYPE_TUNNEL_ESP tunnel type is set > - * on both Tx and Rx. > - */ > - __extension__ > - struct { > - uint8_t inner_l2_type:4; > - /**< Inner L2 type. */ > - uint8_t inner_l3_type:4; > - /**< Inner L3 type. */ > - }; > - }; > - uint32_t inner_l4_type:4; /**< Inner L4 type. */ > - }; > - }; > - > - uint32_t pkt_len; /**< Total pkt len: sum of all segments. */ > - uint16_t data_len; /**< Amount of data in segment buffer. */ > - /** VLAN TCI (CPU order), valid if PKT_RX_VLAN is set. */ > - uint16_t vlan_tci; > - > - RTE_STD_C11 > - union { > - union { > - uint32_t rss; /**< RSS hash result if RSS enabled */ > - struct { > - union { > - struct { > - uint16_t hash; > - uint16_t id; > - }; > - uint32_t lo; > - /**< Second 4 flexible bytes */ > - }; > - uint32_t hi; > - /**< First 4 flexible bytes or FD ID, dependent > - * on PKT_RX_FDIR_* flag in ol_flags. > - */ > - } fdir; /**< Filter identifier if FDIR enabled */ > - struct rte_mbuf_sched sched; > - /**< Hierarchical scheduler : 8 bytes */ > - struct { > - uint32_t reserved1; > - uint16_t reserved2; > - uint16_t txq; > - /**< The event eth Tx adapter uses this field > - * to store Tx queue id. > - * @see rte_event_eth_tx_adapter_txq_set() > - */ > - } txadapter; /**< Eventdev ethdev Tx adapter */ > - /**< User defined tags. See rte_distributor_process() */ > - uint32_t usr; > - } hash; /**< hash information */ > - struct { > - /** > - * Application specific metadata value > - * for egress flow rule match. > - * Valid if PKT_TX_METADATA is set. > - * Located here to allow conjunct use > - * with hash.sched.hi. > - */ > - uint32_t tx_metadata; > - uint32_t reserved; > - }; > - }; > - > - /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ is set. */ > - uint16_t vlan_tci_outer; > - > - uint16_t buf_len; /**< Length of segment buffer. */ > - > - /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference > - * are not normalized but are always the same for a given port. > - * Some devices allow to query rte_eth_read_clock that will return the > - * current device timestamp. > - */ > - uint64_t timestamp; > - > - /* second cache line - fields only used in slow path or on TX */ > - MARKER cacheline1 __rte_cache_min_aligned; > - > - RTE_STD_C11 > - union { > - void *userdata; /**< Can be used for external metadata */ > - uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */ > - }; > - > - struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */ > - struct rte_mbuf *next; /**< Next segment of scattered packet. */ > - > - /* fields to support TX offloads */ > - RTE_STD_C11 > - union { > - uint64_t tx_offload; /**< combined for easy fetch */ > - __extension__ > - struct { > - uint64_t l2_len:RTE_MBUF_L2_LEN_BITS; > - /**< L2 (MAC) Header Length for non-tunneling pkt. > - * Outer_L4_len + ... + Inner_L2_len for tunneling pkt. > - */ > - uint64_t l3_len:RTE_MBUF_L3_LEN_BITS; > - /**< L3 (IP) Header Length. */ > - uint64_t l4_len:RTE_MBUF_L4_LEN_BITS; > - /**< L4 (TCP/UDP) Header Length. */ > - uint64_t tso_segsz:RTE_MBUF_TSO_SEGSZ_BITS; > - /**< TCP TSO segment size */ > - > - /* > - * Fields for Tx offloading of tunnels. > - * These are undefined for packets which don't request > - * any tunnel offloads (outer IP or UDP checksum, > - * tunnel TSO). > - * > - * PMDs should not use these fields unconditionally > - * when calculating offsets. > - * > - * Applications are expected to set appropriate tunnel > - * offload flags when they fill in these fields. > - */ > - uint64_t outer_l3_len:RTE_MBUF_OUTL3_LEN_BITS; > - /**< Outer L3 (IP) Hdr Length. */ > - uint64_t outer_l2_len:RTE_MBUF_OUTL2_LEN_BITS; > - /**< Outer L2 (MAC) Hdr Length. */ > - > - /* uint64_t unused:RTE_MBUF_TXOFLD_UNUSED_BITS; */ > - }; > - }; > - > - /** Size of the application private data. In case of an indirect > - * mbuf, it stores the direct mbuf private data size. */ > - uint16_t priv_size; > - > - /** Timesync flags for use with IEEE1588. */ > - uint16_t timesync; > - > - /** Sequence number. See also rte_reorder_insert(). */ > - uint32_t seqn; > - > - /** Shared data for external buffer attached to mbuf. See > - * rte_pktmbuf_attach_extbuf(). > - */ > - struct rte_mbuf_ext_shared_info *shinfo; > - > -} __rte_cache_aligned; > - > -/** > - * Function typedef of callback to free externally attached buffer. > - */ > -typedef void (*rte_mbuf_extbuf_free_callback_t)(void *addr, void *opaque); > - > -/** > - * Shared data at the end of an external buffer. > - */ > -struct rte_mbuf_ext_shared_info { > - rte_mbuf_extbuf_free_callback_t free_cb; /**< Free callback function */ > - void *fcb_opaque; /**< Free callback argument */ > - rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */ > -}; > - > -/**< Maximum number of nb_segs allowed. */ > -#define RTE_MBUF_MAX_NB_SEGS UINT16_MAX > - > /** > * Prefetch the first part of the mbuf > * > @@ -953,31 +294,6 @@ rte_mbuf_to_priv(struct rte_mbuf *m) > return RTE_PTR_ADD(m, sizeof(struct rte_mbuf)); > } > > -/** > - * Returns TRUE if given mbuf is cloned by mbuf indirection, or FALSE > - * otherwise. > - * > - * If a mbuf has its data in another mbuf and references it by mbuf > - * indirection, this mbuf can be defined as a cloned mbuf. > - */ > -#define RTE_MBUF_CLONED(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF) > - > -/** > - * Returns TRUE if given mbuf has an external buffer, or FALSE otherwise. > - * > - * External buffer is a user-provided anonymous buffer. > - */ > -#define RTE_MBUF_HAS_EXTBUF(mb) ((mb)->ol_flags & EXT_ATTACHED_MBUF) > - > -/** > - * Returns TRUE if given mbuf is direct, or FALSE otherwise. > - * > - * If a mbuf embeds its own data after the rte_mbuf structure, this mbuf > - * can be defined as a direct mbuf. > - */ > -#define RTE_MBUF_DIRECT(mb) \ > - (!((mb)->ol_flags & (IND_ATTACHED_MBUF | EXT_ATTACHED_MBUF))) > - > /** > * Private data in case of pktmbuf pool. > * > @@ -2026,62 +1342,10 @@ static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m) > return m; > } > > -/** > - * A macro that points to an offset into the data in the mbuf. > - * > - * The returned pointer is cast to type t. Before using this > - * function, the user must ensure that the first segment is large > - * enough to accommodate its data. > - * > - * @param m > - * The packet mbuf. > - * @param o > - * The offset into the mbuf data. > - * @param t > - * The type to cast the result into. > - */ > -#define rte_pktmbuf_mtod_offset(m, t, o) \ > - ((t)((char *)(m)->buf_addr + (m)->data_off + (o))) > - > -/** > - * A macro that points to the start of the data in the mbuf. > - * > - * The returned pointer is cast to type t. Before using this > - * function, the user must ensure that the first segment is large > - * enough to accommodate its data. > - * > - * @param m > - * The packet mbuf. > - * @param t > - * The type to cast the result into. > - */ > -#define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0) > - > -/** > - * A macro that returns the IO address that points to an offset of the > - * start of the data in the mbuf > - * > - * @param m > - * The packet mbuf. > - * @param o > - * The offset into the data to calculate address from. > - */ > -#define rte_pktmbuf_iova_offset(m, o) \ > - (rte_iova_t)((m)->buf_iova + (m)->data_off + (o)) > - > /* deprecated */ > #define rte_pktmbuf_mtophys_offset(m, o) \ > rte_pktmbuf_iova_offset(m, o) > > -/** > - * A macro that returns the IO address that points to the start of the > - * data in the mbuf > - * > - * @param m > - * The packet mbuf. > - */ > -#define rte_pktmbuf_iova(m) rte_pktmbuf_iova_offset(m, 0) > - > /* deprecated */ > #define rte_pktmbuf_mtophys(m) rte_pktmbuf_iova(m) > > diff --git a/lib/librte_mbuf/rte_mbuf_core.h b/lib/librte_mbuf/rte_mbuf_core.h > new file mode 100644 > index 000000000..f52272e55 > --- /dev/null > +++ b/lib/librte_mbuf/rte_mbuf_core.h > @@ -0,0 +1,793 @@ > +/* SPDX-License-Identifier: BSD-3-Clause > + * Copyright(c) 2010-2014 Intel Corporation. > + * Copyright 2014 6WIND S.A. > + */ > + > +#ifndef _RTE_MBUF_CORE_H_ > +#define _RTE_MBUF_CORE_H_ > + > +/** > + * @file > + * This file contains definion of RTE mbuf structure itself, > + * packet offload flags and some related macros. > + * For majority of DPDK entities, it is not recommended to include > + * this file directly, use include <rte_mbuf.h> instead. > + */ > + > +#include <stdint.h> > +#include <rte_compat.h> > +#include <rte_common.h> > + > +#ifdef __cplusplus > +extern "C" { > +#endif > + > +/* > + * Packet Offload Features Flags. It also carry packet type information. > + * Critical resources. Both rx/tx shared these bits. Be cautious on any change > + * > + * - RX flags start at bit position zero, and get added to the left of previous > + * flags. > + * - The most-significant 3 bits are reserved for generic mbuf flags > + * - TX flags therefore start at bit position 60 (i.e. 63-3), and new flags get > + * added to the right of the previously defined flags i.e. they should count > + * downwards, not upwards. > + * > + * Keep these flags synchronized with rte_get_rx_ol_flag_name() and > + * rte_get_tx_ol_flag_name(). > + */ > + > +/** > + * The RX packet is a 802.1q VLAN packet, and the tci has been > + * saved in in mbuf->vlan_tci. > + * If the flag PKT_RX_VLAN_STRIPPED is also present, the VLAN > + * header has been stripped from mbuf data, else it is still > + * present. > + */ > +#define PKT_RX_VLAN (1ULL << 0) > + > +/** RX packet with RSS hash result. */ > +#define PKT_RX_RSS_HASH (1ULL << 1) > + > + /** RX packet with FDIR match indicate. */ > +#define PKT_RX_FDIR (1ULL << 2) > + > +/** > + * Deprecated. > + * Checking this flag alone is deprecated: check the 2 bits of > + * PKT_RX_L4_CKSUM_MASK. > + * This flag was set when the L4 checksum of a packet was detected as > + * wrong by the hardware. > + */ > +#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) > + > +/** > + * Deprecated. > + * Checking this flag alone is deprecated: check the 2 bits of > + * PKT_RX_IP_CKSUM_MASK. > + * This flag was set when the IP checksum of a packet was detected as > + * wrong by the hardware. > + */ > +#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) > + > + /** External IP header checksum error. */ > +#define PKT_RX_EIP_CKSUM_BAD (1ULL << 5) > + > +/** > + * A vlan has been stripped by the hardware and its tci is saved in > + * mbuf->vlan_tci. This can only happen if vlan stripping is enabled > + * in the RX configuration of the PMD. > + * When PKT_RX_VLAN_STRIPPED is set, PKT_RX_VLAN must also be set. > + */ > +#define PKT_RX_VLAN_STRIPPED (1ULL << 6) > + > +/** > + * Mask of bits used to determine the status of RX IP checksum. > + * - PKT_RX_IP_CKSUM_UNKNOWN: no information about the RX IP checksum > + * - PKT_RX_IP_CKSUM_BAD: the IP checksum in the packet is wrong > + * - PKT_RX_IP_CKSUM_GOOD: the IP checksum in the packet is valid > + * - PKT_RX_IP_CKSUM_NONE: the IP checksum is not correct in the packet > + * data, but the integrity of the IP header is verified. > + */ > +#define PKT_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7)) > + > +#define PKT_RX_IP_CKSUM_UNKNOWN 0 > +#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) > +#define PKT_RX_IP_CKSUM_GOOD (1ULL << 7) > +#define PKT_RX_IP_CKSUM_NONE ((1ULL << 4) | (1ULL << 7)) > + > +/** > + * Mask of bits used to determine the status of RX L4 checksum. > + * - PKT_RX_L4_CKSUM_UNKNOWN: no information about the RX L4 checksum > + * - PKT_RX_L4_CKSUM_BAD: the L4 checksum in the packet is wrong > + * - PKT_RX_L4_CKSUM_GOOD: the L4 checksum in the packet is valid > + * - PKT_RX_L4_CKSUM_NONE: the L4 checksum is not correct in the packet > + * data, but the integrity of the L4 data is verified. > + */ > +#define PKT_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8)) > + > +#define PKT_RX_L4_CKSUM_UNKNOWN 0 > +#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) > +#define PKT_RX_L4_CKSUM_GOOD (1ULL << 8) > +#define PKT_RX_L4_CKSUM_NONE ((1ULL << 3) | (1ULL << 8)) > + > +/** RX IEEE1588 L2 Ethernet PT Packet. */ > +#define PKT_RX_IEEE1588_PTP (1ULL << 9) > + > +/** RX IEEE1588 L2/L4 timestamped packet.*/ > +#define PKT_RX_IEEE1588_TMST (1ULL << 10) > + > +/** FD id reported if FDIR match. */ > +#define PKT_RX_FDIR_ID (1ULL << 13) > + > +/** Flexible bytes reported if FDIR match. */ > +#define PKT_RX_FDIR_FLX (1ULL << 14) > + > +/** > + * The 2 vlans have been stripped by the hardware and their tci are > + * saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer). > + * This can only happen if vlan stripping is enabled in the RX > + * configuration of the PMD. > + * When PKT_RX_QINQ_STRIPPED is set, the flags (PKT_RX_VLAN | > + * PKT_RX_VLAN_STRIPPED | PKT_RX_QINQ) must also be set. > + */ > +#define PKT_RX_QINQ_STRIPPED (1ULL << 15) > + > +/** > + * When packets are coalesced by a hardware or virtual driver, this flag > + * can be set in the RX mbuf, meaning that the m->tso_segsz field is > + * valid and is set to the segment size of original packets. > + */ > +#define PKT_RX_LRO (1ULL << 16) > + > +/** > + * Indicate that the timestamp field in the mbuf is valid. > + */ > +#define PKT_RX_TIMESTAMP (1ULL << 17) > + > +/** > + * Indicate that security offload processing was applied on the RX packet. > + */ > +#define PKT_RX_SEC_OFFLOAD (1ULL << 18) > + > +/** > + * Indicate that security offload processing failed on the RX packet. > + */ > +#define PKT_RX_SEC_OFFLOAD_FAILED (1ULL << 19) > + > +/** > + * The RX packet is a double VLAN, and the outer tci has been > + * saved in in mbuf->vlan_tci_outer. If PKT_RX_QINQ set, PKT_RX_VLAN > + * also should be set and inner tci should be saved to mbuf->vlan_tci. > + * If the flag PKT_RX_QINQ_STRIPPED is also present, both VLANs > + * headers have been stripped from mbuf data, else they are still > + * present. > + */ > +#define PKT_RX_QINQ (1ULL << 20) > + > +/** > + * Mask of bits used to determine the status of outer RX L4 checksum. > + * - PKT_RX_OUTER_L4_CKSUM_UNKNOWN: no info about the outer RX L4 checksum > + * - PKT_RX_OUTER_L4_CKSUM_BAD: the outer L4 checksum in the packet is wrong > + * - PKT_RX_OUTER_L4_CKSUM_GOOD: the outer L4 checksum in the packet is valid > + * - PKT_RX_OUTER_L4_CKSUM_INVALID: invalid outer L4 checksum state. > + * > + * The detection of PKT_RX_OUTER_L4_CKSUM_GOOD shall be based on the given > + * HW capability, At minimum, the PMD should support > + * PKT_RX_OUTER_L4_CKSUM_UNKNOWN and PKT_RX_OUTER_L4_CKSUM_BAD states > + * if the DEV_RX_OFFLOAD_OUTER_UDP_CKSUM offload is available. > + */ > +#define PKT_RX_OUTER_L4_CKSUM_MASK ((1ULL << 21) | (1ULL << 22)) > + > +#define PKT_RX_OUTER_L4_CKSUM_UNKNOWN 0 > +#define PKT_RX_OUTER_L4_CKSUM_BAD (1ULL << 21) > +#define PKT_RX_OUTER_L4_CKSUM_GOOD (1ULL << 22) > +#define PKT_RX_OUTER_L4_CKSUM_INVALID ((1ULL << 21) | (1ULL << 22)) > + > +/* add new RX flags here */ > + > +/* add new TX flags here */ > + > +/** > + * Indicate that the metadata field in the mbuf is in use. > + */ > +#define PKT_TX_METADATA (1ULL << 40) > + > +/** > + * Outer UDP checksum offload flag. This flag is used for enabling > + * outer UDP checksum in PMD. To use outer UDP checksum, the user needs to > + * 1) Enable the following in mbuf, > + * a) Fill outer_l2_len and outer_l3_len in mbuf. > + * b) Set the PKT_TX_OUTER_UDP_CKSUM flag. > + * c) Set the PKT_TX_OUTER_IPV4 or PKT_TX_OUTER_IPV6 flag. > + * 2) Configure DEV_TX_OFFLOAD_OUTER_UDP_CKSUM offload flag. > + */ > +#define PKT_TX_OUTER_UDP_CKSUM (1ULL << 41) > + > +/** > + * UDP Fragmentation Offload flag. This flag is used for enabling UDP > + * fragmentation in SW or in HW. When use UFO, mbuf->tso_segsz is used > + * to store the MSS of UDP fragments. > + */ > +#define PKT_TX_UDP_SEG (1ULL << 42) > + > +/** > + * Request security offload processing on the TX packet. > + */ > +#define PKT_TX_SEC_OFFLOAD (1ULL << 43) > + > +/** > + * Offload the MACsec. This flag must be set by the application to enable > + * this offload feature for a packet to be transmitted. > + */ > +#define PKT_TX_MACSEC (1ULL << 44) > + > +/** > + * Bits 45:48 used for the tunnel type. > + * The tunnel type must be specified for TSO or checksum on the inner part > + * of tunnel packets. > + * These flags can be used with PKT_TX_TCP_SEG for TSO, or PKT_TX_xxx_CKSUM. > + * The mbuf fields for inner and outer header lengths are required: > + * outer_l2_len, outer_l3_len, l2_len, l3_len, l4_len and tso_segsz for TSO. > + */ > +#define PKT_TX_TUNNEL_VXLAN (0x1ULL << 45) > +#define PKT_TX_TUNNEL_GRE (0x2ULL << 45) > +#define PKT_TX_TUNNEL_IPIP (0x3ULL << 45) > +#define PKT_TX_TUNNEL_GENEVE (0x4ULL << 45) > +/** TX packet with MPLS-in-UDP RFC 7510 header. */ > +#define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45) > +#define PKT_TX_TUNNEL_VXLAN_GPE (0x6ULL << 45) > +/** > + * Generic IP encapsulated tunnel type, used for TSO and checksum offload. > + * It can be used for tunnels which are not standards or listed above. > + * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_GRE > + * or PKT_TX_TUNNEL_IPIP if possible. > + * The ethdev must be configured with DEV_TX_OFFLOAD_IP_TNL_TSO. > + * Outer and inner checksums are done according to the existing flags like > + * PKT_TX_xxx_CKSUM. > + * Specific tunnel headers that contain payload length, sequence id > + * or checksum are not expected to be updated. > + */ > +#define PKT_TX_TUNNEL_IP (0xDULL << 45) > +/** > + * Generic UDP encapsulated tunnel type, used for TSO and checksum offload. > + * UDP tunnel type implies outer IP layer. > + * It can be used for tunnels which are not standards or listed above. > + * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_VXLAN > + * if possible. > + * The ethdev must be configured with DEV_TX_OFFLOAD_UDP_TNL_TSO. > + * Outer and inner checksums are done according to the existing flags like > + * PKT_TX_xxx_CKSUM. > + * Specific tunnel headers that contain payload length, sequence id > + * or checksum are not expected to be updated. > + */ > +#define PKT_TX_TUNNEL_UDP (0xEULL << 45) > +/* add new TX TUNNEL type here */ > +#define PKT_TX_TUNNEL_MASK (0xFULL << 45) > + > +/** > + * Double VLAN insertion (QinQ) request to driver, driver may offload the > + * insertion based on device capability. > + * mbuf 'vlan_tci' & 'vlan_tci_outer' must be valid when this flag is set. > + */ > +#define PKT_TX_QINQ (1ULL << 49) > +/* this old name is deprecated */ > +#define PKT_TX_QINQ_PKT PKT_TX_QINQ > + > +/** > + * TCP segmentation offload. To enable this offload feature for a > + * packet to be transmitted on hardware supporting TSO: > + * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies > + * PKT_TX_TCP_CKSUM) > + * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 > + * - if it's IPv4, set the PKT_TX_IP_CKSUM flag > + * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz > + */ > +#define PKT_TX_TCP_SEG (1ULL << 50) > + > +/** TX IEEE1588 packet to timestamp. */ > +#define PKT_TX_IEEE1588_TMST (1ULL << 51) > + > +/** > + * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved, > + * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware > + * L4 checksum offload, the user needs to: > + * - fill l2_len and l3_len in mbuf > + * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM > + * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 > + */ > +#define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */ > + > +/** TCP cksum of TX pkt. computed by NIC. */ > +#define PKT_TX_TCP_CKSUM (1ULL << 52) > + > +/** SCTP cksum of TX pkt. computed by NIC. */ > +#define PKT_TX_SCTP_CKSUM (2ULL << 52) > + > +/** UDP cksum of TX pkt. computed by NIC. */ > +#define PKT_TX_UDP_CKSUM (3ULL << 52) > + > +/** Mask for L4 cksum offload request. */ > +#define PKT_TX_L4_MASK (3ULL << 52) > + > +/** > + * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should > + * also be set by the application, although a PMD will only check > + * PKT_TX_IP_CKSUM. > + * - fill the mbuf offload information: l2_len, l3_len > + */ > +#define PKT_TX_IP_CKSUM (1ULL << 54) > + > +/** > + * Packet is IPv4. This flag must be set when using any offload feature > + * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4 > + * packet. If the packet is a tunneled packet, this flag is related to > + * the inner headers. > + */ > +#define PKT_TX_IPV4 (1ULL << 55) > + > +/** > + * Packet is IPv6. This flag must be set when using an offload feature > + * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6 > + * packet. If the packet is a tunneled packet, this flag is related to > + * the inner headers. > + */ > +#define PKT_TX_IPV6 (1ULL << 56) > + > +/** > + * VLAN tag insertion request to driver, driver may offload the insertion > + * based on the device capability. > + * mbuf 'vlan_tci' field must be valid when this flag is set. > + */ > +#define PKT_TX_VLAN (1ULL << 57) > +/* this old name is deprecated */ > +#define PKT_TX_VLAN_PKT PKT_TX_VLAN > + > +/** > + * Offload the IP checksum of an external header in the hardware. The > + * flag PKT_TX_OUTER_IPV4 should also be set by the application, although > + * a PMD will only check PKT_TX_OUTER_IP_CKSUM. > + * - fill the mbuf offload information: outer_l2_len, outer_l3_len > + */ > +#define PKT_TX_OUTER_IP_CKSUM (1ULL << 58) > + > +/** > + * Packet outer header is IPv4. This flag must be set when using any > + * outer offload feature (L3 or L4 checksum) to tell the NIC that the > + * outer header of the tunneled packet is an IPv4 packet. > + */ > +#define PKT_TX_OUTER_IPV4 (1ULL << 59) > + > +/** > + * Packet outer header is IPv6. This flag must be set when using any > + * outer offload feature (L4 checksum) to tell the NIC that the outer > + * header of the tunneled packet is an IPv6 packet. > + */ > +#define PKT_TX_OUTER_IPV6 (1ULL << 60) > + > +/** > + * Bitmask of all supported packet Tx offload features flags, > + * which can be set for packet. > + */ > +#define PKT_TX_OFFLOAD_MASK ( \ > + PKT_TX_OUTER_IPV6 | \ > + PKT_TX_OUTER_IPV4 | \ > + PKT_TX_OUTER_IP_CKSUM | \ > + PKT_TX_VLAN_PKT | \ > + PKT_TX_IPV6 | \ > + PKT_TX_IPV4 | \ > + PKT_TX_IP_CKSUM | \ > + PKT_TX_L4_MASK | \ > + PKT_TX_IEEE1588_TMST | \ > + PKT_TX_TCP_SEG | \ > + PKT_TX_QINQ_PKT | \ > + PKT_TX_TUNNEL_MASK | \ > + PKT_TX_MACSEC | \ > + PKT_TX_SEC_OFFLOAD | \ > + PKT_TX_UDP_SEG | \ > + PKT_TX_OUTER_UDP_CKSUM | \ > + PKT_TX_METADATA) > + > +/** > + * Mbuf having an external buffer attached. shinfo in mbuf must be filled. > + */ > +#define EXT_ATTACHED_MBUF (1ULL << 61) > + > +#define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */ > + > +/** Alignment constraint of mbuf private area. */ > +#define RTE_MBUF_PRIV_ALIGN 8 > + > +/** > + * Some NICs need at least 2KB buffer to RX standard Ethernet frame without > + * splitting it into multiple segments. > + * So, for mbufs that planned to be involved into RX/TX, the recommended > + * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM. > + */ > +#define RTE_MBUF_DEFAULT_DATAROOM 2048 > +#define RTE_MBUF_DEFAULT_BUF_SIZE \ > + (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM) > + > +/* > + * define a set of marker types that can be used to refer to set points in the > + * mbuf. > + */ > +__extension__ > +typedef void *MARKER[0]; /**< generic marker for a point in a structure */ > +__extension__ > +typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */ > + > + /** marker that allows us to overwrite 8 bytes with a single assignment */ > +__extension__ > +typedef uint64_t MARKER64[0]; > + > +struct rte_mbuf_sched { > + uint32_t queue_id; /**< Queue ID. */ > + uint8_t traffic_class; > + /**< Traffic class ID. Traffic class 0 > + * is the highest priority traffic class. > + */ > + uint8_t color; > + /**< Color. @see enum rte_color.*/ > + uint16_t reserved; /**< Reserved. */ > +}; /**< Hierarchical scheduler */ > + > +/** > + * enum for the tx_offload bit-fields lengths and offsets. > + * defines the layout of rte_mbuf tx_offload field. > + */ > +enum { > + RTE_MBUF_L2_LEN_BITS = 7, > + RTE_MBUF_L3_LEN_BITS = 9, > + RTE_MBUF_L4_LEN_BITS = 8, > + RTE_MBUF_TSO_SEGSZ_BITS = 16, > + RTE_MBUF_OUTL3_LEN_BITS = 9, > + RTE_MBUF_OUTL2_LEN_BITS = 7, > + RTE_MBUF_TXOFLD_UNUSED_BITS = sizeof(uint64_t) * CHAR_BIT - > + RTE_MBUF_L2_LEN_BITS - > + RTE_MBUF_L3_LEN_BITS - > + RTE_MBUF_L4_LEN_BITS - > + RTE_MBUF_TSO_SEGSZ_BITS - > + RTE_MBUF_OUTL3_LEN_BITS - > + RTE_MBUF_OUTL2_LEN_BITS, > +#if RTE_BYTE_ORDER == RTE_BIG_ENDIAN > + RTE_MBUF_L2_LEN_OFS = > + sizeof(uint64_t) * CHAR_BIT - RTE_MBUF_L2_LEN_BITS, > + RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS - RTE_MBUF_L3_LEN_BITS, > + RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS - RTE_MBUF_L4_LEN_BITS, > + RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS - RTE_MBUF_TSO_SEGSZ_BITS, > + RTE_MBUF_OUTL3_LEN_OFS = > + RTE_MBUF_TSO_SEGSZ_OFS - RTE_MBUF_OUTL3_LEN_BITS, > + RTE_MBUF_OUTL2_LEN_OFS = > + RTE_MBUF_OUTL3_LEN_OFS - RTE_MBUF_OUTL2_LEN_BITS, > + RTE_MBUF_TXOFLD_UNUSED_OFS = > + RTE_MBUF_OUTL2_LEN_OFS - RTE_MBUF_TXOFLD_UNUSED_BITS, > +#else > + RTE_MBUF_L2_LEN_OFS = 0, > + RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS + RTE_MBUF_L2_LEN_BITS, > + RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS + RTE_MBUF_L3_LEN_BITS, > + RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS + RTE_MBUF_L4_LEN_BITS, > + RTE_MBUF_OUTL3_LEN_OFS = > + RTE_MBUF_TSO_SEGSZ_OFS + RTE_MBUF_TSO_SEGSZ_BITS, > + RTE_MBUF_OUTL2_LEN_OFS = > + RTE_MBUF_OUTL3_LEN_OFS + RTE_MBUF_OUTL3_LEN_BITS, > + RTE_MBUF_TXOFLD_UNUSED_OFS = > + RTE_MBUF_OUTL2_LEN_OFS + RTE_MBUF_OUTL2_LEN_BITS, > +#endif > +}; > + > +/** > + * The generic rte_mbuf, containing a packet mbuf. > + */ > +struct rte_mbuf { > + MARKER cacheline0; > + > + void *buf_addr; /**< Virtual address of segment buffer. */ > + /** > + * Physical address of segment buffer. > + * Force alignment to 8-bytes, so as to ensure we have the exact > + * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes > + * working on vector drivers easier. > + */ > + RTE_STD_C11 > + union { > + rte_iova_t buf_iova; > + rte_iova_t buf_physaddr; /**< deprecated */ > + } __rte_aligned(sizeof(rte_iova_t)); > + > + /* next 8 bytes are initialised on RX descriptor rearm */ > + MARKER64 rearm_data; > + uint16_t data_off; > + > + /** > + * Reference counter. Its size should at least equal to the size > + * of port field (16 bits), to support zero-copy broadcast. > + * It should only be accessed using the following functions: > + * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and > + * rte_mbuf_refcnt_set(). The functionality of these functions (atomic, > + * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC > + * config option. > + */ > + RTE_STD_C11 > + union { > + rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */ > + /** Non-atomically accessed refcnt */ > + uint16_t refcnt; > + }; > + uint16_t nb_segs; /**< Number of segments. */ > + > + /** Input port (16 bits to support more than 256 virtual ports). > + * The event eth Tx adapter uses this field to specify the output port. > + */ > + uint16_t port; > + > + uint64_t ol_flags; /**< Offload features. */ > + > + /* remaining bytes are set on RX when pulling packet from descriptor */ > + MARKER rx_descriptor_fields1; > + > + /* > + * The packet type, which is the combination of outer/inner L2, L3, L4 > + * and tunnel types. The packet_type is about data really present in the > + * mbuf. Example: if vlan stripping is enabled, a received vlan packet > + * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the > + * vlan is stripped from the data. > + */ > + RTE_STD_C11 > + union { > + uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */ > + struct { > + uint32_t l2_type:4; /**< (Outer) L2 type. */ > + uint32_t l3_type:4; /**< (Outer) L3 type. */ > + uint32_t l4_type:4; /**< (Outer) L4 type. */ > + uint32_t tun_type:4; /**< Tunnel type. */ > + RTE_STD_C11 > + union { > + uint8_t inner_esp_next_proto; > + /**< ESP next protocol type, valid if > + * RTE_PTYPE_TUNNEL_ESP tunnel type is set > + * on both Tx and Rx. > + */ > + __extension__ > + struct { > + uint8_t inner_l2_type:4; > + /**< Inner L2 type. */ > + uint8_t inner_l3_type:4; > + /**< Inner L3 type. */ > + }; > + }; > + uint32_t inner_l4_type:4; /**< Inner L4 type. */ > + }; > + }; > + > + uint32_t pkt_len; /**< Total pkt len: sum of all segments. */ > + uint16_t data_len; /**< Amount of data in segment buffer. */ > + /** VLAN TCI (CPU order), valid if PKT_RX_VLAN is set. */ > + uint16_t vlan_tci; > + > + RTE_STD_C11 > + union { > + union { > + uint32_t rss; /**< RSS hash result if RSS enabled */ > + struct { > + union { > + struct { > + uint16_t hash; > + uint16_t id; > + }; > + uint32_t lo; > + /**< Second 4 flexible bytes */ > + }; > + uint32_t hi; > + /**< First 4 flexible bytes or FD ID, dependent > + * on PKT_RX_FDIR_* flag in ol_flags. > + */ > + } fdir; /**< Filter identifier if FDIR enabled */ > + struct rte_mbuf_sched sched; > + /**< Hierarchical scheduler : 8 bytes */ > + struct { > + uint32_t reserved1; > + uint16_t reserved2; > + uint16_t txq; > + /**< The event eth Tx adapter uses this field > + * to store Tx queue id. > + * @see rte_event_eth_tx_adapter_txq_set() > + */ > + } txadapter; /**< Eventdev ethdev Tx adapter */ > + /**< User defined tags. See rte_distributor_process() */ > + uint32_t usr; > + } hash; /**< hash information */ > + struct { > + /** > + * Application specific metadata value > + * for egress flow rule match. > + * Valid if PKT_TX_METADATA is set. > + * Located here to allow conjunct use > + * with hash.sched.hi. > + */ > + uint32_t tx_metadata; > + uint32_t reserved; > + }; > + }; > + > + /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ is set. */ > + uint16_t vlan_tci_outer; > + > + uint16_t buf_len; /**< Length of segment buffer. */ > + > + /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference > + * are not normalized but are always the same for a given port. > + * Some devices allow to query rte_eth_read_clock that will return the > + * current device timestamp. > + */ > + uint64_t timestamp; > + > + /* second cache line - fields only used in slow path or on TX */ > + MARKER cacheline1 __rte_cache_min_aligned; > + > + RTE_STD_C11 > + union { > + void *userdata; /**< Can be used for external metadata */ > + uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */ > + }; > + > + struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */ > + struct rte_mbuf *next; /**< Next segment of scattered packet. */ > + > + /* fields to support TX offloads */ > + RTE_STD_C11 > + union { > + uint64_t tx_offload; /**< combined for easy fetch */ > + __extension__ > + struct { > + uint64_t l2_len:RTE_MBUF_L2_LEN_BITS; > + /**< L2 (MAC) Header Length for non-tunneling pkt. > + * Outer_L4_len + ... + Inner_L2_len for tunneling pkt. > + */ > + uint64_t l3_len:RTE_MBUF_L3_LEN_BITS; > + /**< L3 (IP) Header Length. */ > + uint64_t l4_len:RTE_MBUF_L4_LEN_BITS; > + /**< L4 (TCP/UDP) Header Length. */ > + uint64_t tso_segsz:RTE_MBUF_TSO_SEGSZ_BITS; > + /**< TCP TSO segment size */ > + > + /* > + * Fields for Tx offloading of tunnels. > + * These are undefined for packets which don't request > + * any tunnel offloads (outer IP or UDP checksum, > + * tunnel TSO). > + * > + * PMDs should not use these fields unconditionally > + * when calculating offsets. > + * > + * Applications are expected to set appropriate tunnel > + * offload flags when they fill in these fields. > + */ > + uint64_t outer_l3_len:RTE_MBUF_OUTL3_LEN_BITS; > + /**< Outer L3 (IP) Hdr Length. */ > + uint64_t outer_l2_len:RTE_MBUF_OUTL2_LEN_BITS; > + /**< Outer L2 (MAC) Hdr Length. */ > + > + /* uint64_t unused:RTE_MBUF_TXOFLD_UNUSED_BITS; */ > + }; > + }; > + > + /** Size of the application private data. In case of an indirect > + * mbuf, it stores the direct mbuf private data size. > + */ > + uint16_t priv_size; > + > + /** Timesync flags for use with IEEE1588. */ > + uint16_t timesync; > + > + /** Sequence number. See also rte_reorder_insert(). */ > + uint32_t seqn; > + > + /** Shared data for external buffer attached to mbuf. See > + * rte_pktmbuf_attach_extbuf(). > + */ > + struct rte_mbuf_ext_shared_info *shinfo; > + > +} __rte_cache_aligned; > + > +/** > + * Function typedef of callback to free externally attached buffer. > + */ > +typedef void (*rte_mbuf_extbuf_free_callback_t)(void *addr, void *opaque); > + > +/** > + * Shared data at the end of an external buffer. > + */ > +struct rte_mbuf_ext_shared_info { > + rte_mbuf_extbuf_free_callback_t free_cb; /**< Free callback function */ > + void *fcb_opaque; /**< Free callback argument */ > + rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */ > +}; > + > +/**< Maximum number of nb_segs allowed. */ > +#define RTE_MBUF_MAX_NB_SEGS UINT16_MAX > + > +/** > + * Returns TRUE if given mbuf is cloned by mbuf indirection, or FALSE > + * otherwise. > + * > + * If a mbuf has its data in another mbuf and references it by mbuf > + * indirection, this mbuf can be defined as a cloned mbuf. > + */ > +#define RTE_MBUF_CLONED(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF) > + > +/** > + * Returns TRUE if given mbuf has an external buffer, or FALSE otherwise. > + * > + * External buffer is a user-provided anonymous buffer. > + */ > +#define RTE_MBUF_HAS_EXTBUF(mb) ((mb)->ol_flags & EXT_ATTACHED_MBUF) > + > +/** > + * Returns TRUE if given mbuf is direct, or FALSE otherwise. > + * > + * If a mbuf embeds its own data after the rte_mbuf structure, this mbuf > + * can be defined as a direct mbuf. > + */ > +#define RTE_MBUF_DIRECT(mb) \ > + (!((mb)->ol_flags & (IND_ATTACHED_MBUF | EXT_ATTACHED_MBUF))) > + > +#define MBUF_INVALID_PORT UINT16_MAX > + > +/** > + * A macro that points to an offset into the data in the mbuf. > + * > + * The returned pointer is cast to type t. Before using this > + * function, the user must ensure that the first segment is large > + * enough to accommodate its data. > + * > + * @param m > + * The packet mbuf. > + * @param o > + * The offset into the mbuf data. > + * @param t > + * The type to cast the result into. > + */ > +#define rte_pktmbuf_mtod_offset(m, t, o) \ > + ((t)((char *)(m)->buf_addr + (m)->data_off + (o))) > + > +/** > + * A macro that points to the start of the data in the mbuf. > + * > + * The returned pointer is cast to type t. Before using this > + * function, the user must ensure that the first segment is large > + * enough to accommodate its data. > + * > + * @param m > + * The packet mbuf. > + * @param t > + * The type to cast the result into. > + */ > +#define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0) > + > +/** > + * A macro that returns the IO address that points to an offset of the > + * start of the data in the mbuf > + * > + * @param m > + * The packet mbuf. > + * @param o > + * The offset into the data to calculate address from. > + */ > +#define rte_pktmbuf_iova_offset(m, o) \ > + (rte_iova_t)((m)->buf_iova + (m)->data_off + (o)) > + > +/** > + * A macro that returns the IO address that points to the start of the > + * data in the mbuf > + * > + * @param m > + * The packet mbuf. > + */ > +#define rte_pktmbuf_iova(m) rte_pktmbuf_iova_offset(m, 0) > + > +#ifdef __cplusplus > +} > +#endif > + > +#endif /* _RTE_MBUF_CORE_H_ */ > ^ permalink raw reply [flat|nested] 17+ messages in thread
* [dpdk-dev] [PATCH 3/3] examples/bpf: remove duplicate mbuf definition 2019-08-16 12:53 [dpdk-dev] [PATCH 0/3] move mbuf definition into a separate file Konstantin Ananyev 2019-08-16 12:53 ` [dpdk-dev] [PATCH 1/3] eal: move CACHE and IOVA related definitions Konstantin Ananyev 2019-08-16 12:53 ` [dpdk-dev] [PATCH 2/3] mbuf: move mbuf definition into a separate file Konstantin Ananyev @ 2019-08-16 12:53 ` Konstantin Ananyev 2019-08-16 18:44 ` Michel Machado 2019-09-27 13:50 ` [dpdk-dev] [PATCH v2 0/3] move mbuf definition into a separate file Konstantin Ananyev 3 siblings, 1 reply; 17+ messages in thread From: Konstantin Ananyev @ 2019-08-16 12:53 UTC (permalink / raw) To: dev Cc: michel, olivier.matz, anatoly.burakov, vipin.varghese, Konstantin Ananyev Get rid of duplicate definitions for rte_mbuf and related macros. Include rte_mbuf_core.h instead. Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com> --- examples/bpf/mbuf.h | 605 -------------------------------------------- examples/bpf/t2.c | 5 +- examples/bpf/t3.c | 3 +- 3 files changed, 5 insertions(+), 608 deletions(-) delete mode 100644 examples/bpf/mbuf.h diff --git a/examples/bpf/mbuf.h b/examples/bpf/mbuf.h deleted file mode 100644 index e41c3d26e..000000000 --- a/examples/bpf/mbuf.h +++ /dev/null @@ -1,605 +0,0 @@ -/* SPDX-License-Identifier: BSD-3-Clause - * Copyright(c) 2010-2014 Intel Corporation. - * Copyright 2014 6WIND S.A. - */ - -/* - * Snipper from dpdk.org rte_mbuf.h. - * used to provide BPF programs information about rte_mbuf layout. - */ - -#ifndef _MBUF_H_ -#define _MBUF_H_ - -#include <stdint.h> -#include <rte_common.h> - -#ifdef __cplusplus -extern "C" { -#endif - -/* - * Packet Offload Features Flags. It also carry packet type information. - * Critical resources. Both rx/tx shared these bits. Be cautious on any change - * - * - RX flags start at bit position zero, and get added to the left of previous - * flags. - * - The most-significant 3 bits are reserved for generic mbuf flags - * - TX flags therefore start at bit position 60 (i.e. 63-3), and new flags get - * added to the right of the previously defined flags i.e. they should count - * downwards, not upwards. - * - * Keep these flags synchronized with rte_get_rx_ol_flag_name() and - * rte_get_tx_ol_flag_name(). - */ - -/** - * RX packet is a 802.1q VLAN packet. This flag was set by PMDs when - * the packet is recognized as a VLAN, but the behavior between PMDs - * was not the same. This flag is kept for some time to avoid breaking - * applications and should be replaced by PKT_RX_VLAN_STRIPPED. - */ -#define PKT_RX_VLAN_PKT (1ULL << 0) - -#define PKT_RX_RSS_HASH (1ULL << 1) -/**< RX packet with RSS hash result. */ -#define PKT_RX_FDIR (1ULL << 2) -/**< RX packet with FDIR match indicate. */ - -/** - * Deprecated. - * Checking this flag alone is deprecated: check the 2 bits of - * PKT_RX_L4_CKSUM_MASK. - * This flag was set when the L4 checksum of a packet was detected as - * wrong by the hardware. - */ -#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) - -/** - * Deprecated. - * Checking this flag alone is deprecated: check the 2 bits of - * PKT_RX_IP_CKSUM_MASK. - * This flag was set when the IP checksum of a packet was detected as - * wrong by the hardware. - */ -#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) - -#define PKT_RX_EIP_CKSUM_BAD (1ULL << 5) -/**< External IP header checksum error. */ - -/** - * A vlan has been stripped by the hardware and its tci is saved in - * mbuf->vlan_tci. This can only happen if vlan stripping is enabled - * in the RX configuration of the PMD. - */ -#define PKT_RX_VLAN_STRIPPED (1ULL << 6) - -/** - * Mask of bits used to determine the status of RX IP checksum. - * - PKT_RX_IP_CKSUM_UNKNOWN: no information about the RX IP checksum - * - PKT_RX_IP_CKSUM_BAD: the IP checksum in the packet is wrong - * - PKT_RX_IP_CKSUM_GOOD: the IP checksum in the packet is valid - * - PKT_RX_IP_CKSUM_NONE: the IP checksum is not correct in the packet - * data, but the integrity of the IP header is verified. - */ -#define PKT_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7)) - -#define PKT_RX_IP_CKSUM_UNKNOWN 0 -#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) -#define PKT_RX_IP_CKSUM_GOOD (1ULL << 7) -#define PKT_RX_IP_CKSUM_NONE ((1ULL << 4) | (1ULL << 7)) - -/** - * Mask of bits used to determine the status of RX L4 checksum. - * - PKT_RX_L4_CKSUM_UNKNOWN: no information about the RX L4 checksum - * - PKT_RX_L4_CKSUM_BAD: the L4 checksum in the packet is wrong - * - PKT_RX_L4_CKSUM_GOOD: the L4 checksum in the packet is valid - * - PKT_RX_L4_CKSUM_NONE: the L4 checksum is not correct in the packet - * data, but the integrity of the L4 data is verified. - */ -#define PKT_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8)) - -#define PKT_RX_L4_CKSUM_UNKNOWN 0 -#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) -#define PKT_RX_L4_CKSUM_GOOD (1ULL << 8) -#define PKT_RX_L4_CKSUM_NONE ((1ULL << 3) | (1ULL << 8)) - -#define PKT_RX_IEEE1588_PTP (1ULL << 9) -/**< RX IEEE1588 L2 Ethernet PT Packet. */ -#define PKT_RX_IEEE1588_TMST (1ULL << 10) -/**< RX IEEE1588 L2/L4 timestamped packet.*/ -#define PKT_RX_FDIR_ID (1ULL << 13) -/**< FD id reported if FDIR match. */ -#define PKT_RX_FDIR_FLX (1ULL << 14) -/**< Flexible bytes reported if FDIR match. */ - -/** - * The 2 vlans have been stripped by the hardware and their tci are - * saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer). - * This can only happen if vlan stripping is enabled in the RX - * configuration of the PMD. If this flag is set, PKT_RX_VLAN_STRIPPED - * must also be set. - */ -#define PKT_RX_QINQ_STRIPPED (1ULL << 15) - -/** - * Deprecated. - * RX packet with double VLAN stripped. - * This flag is replaced by PKT_RX_QINQ_STRIPPED. - */ -#define PKT_RX_QINQ_PKT PKT_RX_QINQ_STRIPPED - -/** - * When packets are coalesced by a hardware or virtual driver, this flag - * can be set in the RX mbuf, meaning that the m->tso_segsz field is - * valid and is set to the segment size of original packets. - */ -#define PKT_RX_LRO (1ULL << 16) - -/** - * Indicate that the timestamp field in the mbuf is valid. - */ -#define PKT_RX_TIMESTAMP (1ULL << 17) - -/* add new RX flags here */ - -/* add new TX flags here */ - -/** - * Offload the MACsec. This flag must be set by the application to enable - * this offload feature for a packet to be transmitted. - */ -#define PKT_TX_MACSEC (1ULL << 44) - -/** - * Bits 45:48 used for the tunnel type. - * When doing Tx offload like TSO or checksum, the HW needs to configure the - * tunnel type into the HW descriptors. - */ -#define PKT_TX_TUNNEL_VXLAN (0x1ULL << 45) -#define PKT_TX_TUNNEL_GRE (0x2ULL << 45) -#define PKT_TX_TUNNEL_IPIP (0x3ULL << 45) -#define PKT_TX_TUNNEL_GENEVE (0x4ULL << 45) -/**< TX packet with MPLS-in-UDP RFC 7510 header. */ -#define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45) -/* add new TX TUNNEL type here */ -#define PKT_TX_TUNNEL_MASK (0xFULL << 45) - -/** - * Second VLAN insertion (QinQ) flag. - */ -#define PKT_TX_QINQ_PKT (1ULL << 49) -/**< TX packet with double VLAN inserted. */ - -/** - * TCP segmentation offload. To enable this offload feature for a - * packet to be transmitted on hardware supporting TSO: - * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies - * PKT_TX_TCP_CKSUM) - * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 - * - if it's IPv4, set the PKT_TX_IP_CKSUM flag and write the IP checksum - * to 0 in the packet - * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz - * - calculate the pseudo header checksum without taking ip_len in account, - * and set it in the TCP header. Refer to rte_ipv4_phdr_cksum() and - * rte_ipv6_phdr_cksum() that can be used as helpers. - */ -#define PKT_TX_TCP_SEG (1ULL << 50) - -#define PKT_TX_IEEE1588_TMST (1ULL << 51) -/**< TX IEEE1588 packet to timestamp. */ - -/** - * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved, - * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware - * L4 checksum offload, the user needs to: - * - fill l2_len and l3_len in mbuf - * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM - * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 - * - calculate the pseudo header checksum and set it in the L4 header (only - * for TCP or UDP). See rte_ipv4_phdr_cksum() and rte_ipv6_phdr_cksum(). - * For SCTP, set the crc field to 0. - */ -#define PKT_TX_L4_NO_CKSUM (0ULL << 52) -/**< Disable L4 cksum of TX pkt. */ -#define PKT_TX_TCP_CKSUM (1ULL << 52) -/**< TCP cksum of TX pkt. computed by NIC. */ -#define PKT_TX_SCTP_CKSUM (2ULL << 52) -/**< SCTP cksum of TX pkt. computed by NIC. */ -#define PKT_TX_UDP_CKSUM (3ULL << 52) -/**< UDP cksum of TX pkt. computed by NIC. */ -#define PKT_TX_L4_MASK (3ULL << 52) -/**< Mask for L4 cksum offload request. */ - -/** - * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should - * also be set by the application, although a PMD will only check - * PKT_TX_IP_CKSUM. - * - set the IP checksum field in the packet to 0 - * - fill the mbuf offload information: l2_len, l3_len - */ -#define PKT_TX_IP_CKSUM (1ULL << 54) - -/** - * Packet is IPv4. This flag must be set when using any offload feature - * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4 - * packet. If the packet is a tunneled packet, this flag is related to - * the inner headers. - */ -#define PKT_TX_IPV4 (1ULL << 55) - -/** - * Packet is IPv6. This flag must be set when using an offload feature - * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6 - * packet. If the packet is a tunneled packet, this flag is related to - * the inner headers. - */ -#define PKT_TX_IPV6 (1ULL << 56) - -#define PKT_TX_VLAN_PKT (1ULL << 57) -/**< TX packet is a 802.1q VLAN packet. */ - -/** - * Offload the IP checksum of an external header in the hardware. The - * flag PKT_TX_OUTER_IPV4 should also be set by the application, alto ugh - * a PMD will only check PKT_TX_IP_CKSUM. The IP checksum field in the - * packet must be set to 0. - * - set the outer IP checksum field in the packet to 0 - * - fill the mbuf offload information: outer_l2_len, outer_l3_len - */ -#define PKT_TX_OUTER_IP_CKSUM (1ULL << 58) - -/** - * Packet outer header is IPv4. This flag must be set when using any - * outer offload feature (L3 or L4 checksum) to tell the NIC that the - * outer header of the tunneled packet is an IPv4 packet. - */ -#define PKT_TX_OUTER_IPV4 (1ULL << 59) - -/** - * Packet outer header is IPv6. This flag must be set when using any - * outer offload feature (L4 checksum) to tell the NIC that the outer - * header of the tunneled packet is an IPv6 packet. - */ -#define PKT_TX_OUTER_IPV6 (1ULL << 60) - -/** - * Bitmask of all supported packet Tx offload features flags, - * which can be set for packet. - */ -#define PKT_TX_OFFLOAD_MASK ( \ - PKT_TX_IP_CKSUM | \ - PKT_TX_L4_MASK | \ - PKT_TX_OUTER_IP_CKSUM | \ - PKT_TX_TCP_SEG | \ - PKT_TX_IEEE1588_TMST | \ - PKT_TX_QINQ_PKT | \ - PKT_TX_VLAN_PKT | \ - PKT_TX_TUNNEL_MASK | \ - PKT_TX_MACSEC) - -#define __RESERVED (1ULL << 61) /**< reserved for future mbuf use */ - -#define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */ - -/* Use final bit of flags to indicate a control mbuf */ -#define CTRL_MBUF_FLAG (1ULL << 63) /**< Mbuf contains control data */ - -/** Alignment constraint of mbuf private area. */ -#define RTE_MBUF_PRIV_ALIGN 8 - -/** - * Get the name of a RX offload flag - * - * @param mask - * The mask describing the flag. - * @return - * The name of this flag, or NULL if it's not a valid RX flag. - */ -const char *rte_get_rx_ol_flag_name(uint64_t mask); - -/** - * Dump the list of RX offload flags in a buffer - * - * @param mask - * The mask describing the RX flags. - * @param buf - * The output buffer. - * @param buflen - * The length of the buffer. - * @return - * 0 on success, (-1) on error. - */ -int rte_get_rx_ol_flag_list(uint64_t mask, char *buf, size_t buflen); - -/** - * Get the name of a TX offload flag - * - * @param mask - * The mask describing the flag. Usually only one bit must be set. - * Several bits can be given if they belong to the same mask. - * Ex: PKT_TX_L4_MASK. - * @return - * The name of this flag, or NULL if it's not a valid TX flag. - */ -const char *rte_get_tx_ol_flag_name(uint64_t mask); - -/** - * Dump the list of TX offload flags in a buffer - * - * @param mask - * The mask describing the TX flags. - * @param buf - * The output buffer. - * @param buflen - * The length of the buffer. - * @return - * 0 on success, (-1) on error. - */ -int rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen); - -/** - * Some NICs need at least 2KB buffer to RX standard Ethernet frame without - * splitting it into multiple segments. - * So, for mbufs that planned to be involved into RX/TX, the recommended - * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM. - */ -#define RTE_MBUF_DEFAULT_DATAROOM 2048 -#define RTE_MBUF_DEFAULT_BUF_SIZE \ - (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM) - -/* define a set of marker types that can be used to refer to set points in the - * mbuf. - */ -__extension__ -typedef void *MARKER[0]; /**< generic marker for a point in a structure */ -__extension__ -typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */ -__extension__ -typedef uint64_t MARKER64[0]; -/**< marker that allows us to overwrite 8 bytes with a single assignment */ - -typedef struct { - volatile int16_t cnt; /**< An internal counter value. */ -} rte_atomic16_t; - -#define RTE_CACHE_LINE_MIN_SIZE 64 /**< Minimum Cache line size. */ - -/** - * Force minimum cache line alignment. - */ -#define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE) - -/** - * IO virtual address type. - * When the physical addressing mode (IOVA as PA) is in use, - * the translation from an IO virtual address (IOVA) to a physical address - * is a direct mapping, i.e. the same value. - * Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation. - */ -typedef uint64_t rte_iova_t; -#define RTE_BAD_IOVA ((rte_iova_t)-1) - -/** - * The generic rte_mbuf, containing a packet mbuf. - */ -struct rte_mbuf { - MARKER cacheline0; - - void *buf_addr; /**< Virtual address of segment buffer. */ - /** - * Physical address of segment buffer. - * Force alignment to 8-bytes, so as to ensure we have the exact - * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes - * working on vector drivers easier. - */ - RTE_STD_C11 - union { - rte_iova_t buf_iova; - rte_iova_t buf_physaddr; /**< deprecated */ - } __rte_aligned(sizeof(rte_iova_t)); - - /* next 8 bytes are initialised on RX descriptor rearm */ - MARKER64 rearm_data; - uint16_t data_off; - - /** - * Reference counter. Its size should at least equal to the size - * of port field (16 bits), to support zero-copy broadcast. - * It should only be accessed using the following functions: - * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and - * rte_mbuf_refcnt_set(). The functionality of these functions (atomic, - * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC - * config option. - */ - RTE_STD_C11 - union { - rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */ - uint16_t refcnt; - /**< Non-atomically accessed refcnt */ - }; - uint16_t nb_segs; /**< Number of segments. */ - - /** Input port (16 bits to support more than 256 virtual ports). */ - uint16_t port; - - uint64_t ol_flags; /**< Offload features. */ - - /* remaining bytes are set on RX when pulling packet from descriptor */ - MARKER rx_descriptor_fields1; - - /* - * The packet type, which is the combination of outer/inner L2, L3, L4 - * and tunnel types. The packet_type is about data really present in the - * mbuf. Example: if vlan stripping is enabled, a received vlan packet - * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the - * vlan is stripped from the data. - */ - RTE_STD_C11 - union { - uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */ - struct { - uint32_t l2_type:4; /**< (Outer) L2 type. */ - uint32_t l3_type:4; /**< (Outer) L3 type. */ - uint32_t l4_type:4; /**< (Outer) L4 type. */ - uint32_t tun_type:4; /**< Tunnel type. */ - uint32_t inner_l2_type:4; /**< Inner L2 type. */ - uint32_t inner_l3_type:4; /**< Inner L3 type. */ - uint32_t inner_l4_type:4; /**< Inner L4 type. */ - }; - }; - - uint32_t pkt_len; /**< Total pkt len: sum of all segments. */ - uint16_t data_len; /**< Amount of data in segment buffer. */ - /** VLAN TCI (CPU order), valid if PKT_RX_VLAN_STRIPPED is set. */ - uint16_t vlan_tci; - - union { - uint32_t rss; /**< RSS hash result if RSS enabled */ - struct { - RTE_STD_C11 - union { - struct { - uint16_t hash; - uint16_t id; - }; - uint32_t lo; - /**< Second 4 flexible bytes */ - }; - uint32_t hi; - /**< First 4 flexible bytes or FD ID, dependent on - * PKT_RX_FDIR_* flag in ol_flags. - */ - } fdir; /**< Filter identifier if FDIR enabled */ - struct { - uint32_t lo; - uint32_t hi; - } sched; /**< Hierarchical scheduler */ - uint32_t usr; - /**< User defined tags. See rte_distributor_process() */ - } hash; /**< hash information */ - - /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ_STRIPPED is set. */ - uint16_t vlan_tci_outer; - - uint16_t buf_len; /**< Length of segment buffer. */ - - /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference - * are not normalized but are always the same for a given port. - */ - uint64_t timestamp; - - /* second cache line - fields only used in slow path or on TX */ - MARKER cacheline1 __rte_cache_min_aligned; - - RTE_STD_C11 - union { - void *userdata; /**< Can be used for external metadata */ - uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */ - }; - - struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */ - struct rte_mbuf *next; /**< Next segment of scattered packet. */ - - /* fields to support TX offloads */ - RTE_STD_C11 - union { - uint64_t tx_offload; /**< combined for easy fetch */ - __extension__ - struct { - uint64_t l2_len:7; - /**< L2 (MAC) Header Length for non-tunneling pkt. - * Outer_L4_len + ... + Inner_L2_len for tunneling pkt. - */ - uint64_t l3_len:9; /**< L3 (IP) Header Length. */ - uint64_t l4_len:8; /**< L4 (TCP/UDP) Header Length. */ - uint64_t tso_segsz:16; /**< TCP TSO segment size */ - - /* fields for TX offloading of tunnels */ - uint64_t outer_l3_len:9; - /**< Outer L3 (IP) Hdr Length. */ - uint64_t outer_l2_len:7; - /**< Outer L2 (MAC) Hdr Length. */ - - /* uint64_t unused:8; */ - }; - }; - - /** Size of the application private data. In case of an indirect - * mbuf, it stores the direct mbuf private data size. - */ - uint16_t priv_size; - - /** Timesync flags for use with IEEE1588. */ - uint16_t timesync; - - /** Sequence number. See also rte_reorder_insert(). */ - uint32_t seqn; - -} __rte_cache_aligned; - - -/** - * Returns TRUE if given mbuf is cloned by mbuf indirection, or FALSE - * otherwise. - * - * If a mbuf has its data in another mbuf and references it by mbuf - * indirection, this mbuf can be defined as a cloned mbuf. - */ -#define RTE_MBUF_CLONED(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF) - -/** - * Returns TRUE if given mbuf is direct, or FALSE otherwise. - * - * If a mbuf embeds its own data after the rte_mbuf structure, this mbuf - * can be defined as a direct mbuf. - */ -#define RTE_MBUF_DIRECT(mb) (!RTE_MBUF_CLONED(mb)) - -/** - * Private data in case of pktmbuf pool. - * - * A structure that contains some pktmbuf_pool-specific data that are - * appended after the mempool structure (in private data). - */ -struct rte_pktmbuf_pool_private { - uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf. */ - uint16_t mbuf_priv_size; /**< Size of private area in each mbuf. */ -}; - -/** - * A macro that points to an offset into the data in the mbuf. - * - * The returned pointer is cast to type t. Before using this - * function, the user must ensure that the first segment is large - * enough to accommodate its data. - * - * @param m - * The packet mbuf. - * @param o - * The offset into the mbuf data. - * @param t - * The type to cast the result into. - */ -#define rte_pktmbuf_mtod_offset(m, t, o) \ - ((t)((char *)(m)->buf_addr + (m)->data_off + (o))) - -/** - * A macro that points to the start of the data in the mbuf. - * - * The returned pointer is cast to type t. Before using this - * function, the user must ensure that the first segment is large - * enough to accommodate its data. - * - * @param m - * The packet mbuf. - * @param t - * The type to cast the result into. - */ -#define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0) - -#ifdef __cplusplus -} -#endif - -#endif /* _MBUF_H_ */ diff --git a/examples/bpf/t2.c b/examples/bpf/t2.c index 69d7a4fe1..3eee65450 100644 --- a/examples/bpf/t2.c +++ b/examples/bpf/t2.c @@ -16,7 +16,8 @@ #include <stdint.h> #include <stddef.h> #include <rte_config.h> -#include "mbuf.h" +#include <generic/rte_atomic.h> +#include <rte_mbuf_core.h> uint64_t entry(void *pkt) @@ -25,7 +26,7 @@ entry(void *pkt) mb = pkt; mb->vlan_tci = 0; - mb->ol_flags &= ~(PKT_RX_VLAN_PKT | PKT_RX_VLAN_STRIPPED); + mb->ol_flags &= ~(PKT_RX_VLAN | PKT_RX_VLAN_STRIPPED); return 1; } diff --git a/examples/bpf/t3.c b/examples/bpf/t3.c index 9ba34638a..58e0db1c2 100644 --- a/examples/bpf/t3.c +++ b/examples/bpf/t3.c @@ -22,7 +22,8 @@ #include <stdio.h> #include <net/ethernet.h> #include <rte_config.h> -#include "mbuf.h" +#include <generic/rte_atomic.h> +#include <rte_mbuf_core.h> #include <arpa/inet.h> extern void rte_pktmbuf_dump(FILE *, const struct rte_mbuf *, unsigned int); -- 2.17.1 ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [dpdk-dev] [PATCH 3/3] examples/bpf: remove duplicate mbuf definition 2019-08-16 12:53 ` [dpdk-dev] [PATCH 3/3] examples/bpf: remove duplicate mbuf definition Konstantin Ananyev @ 2019-08-16 18:44 ` Michel Machado 0 siblings, 0 replies; 17+ messages in thread From: Michel Machado @ 2019-08-16 18:44 UTC (permalink / raw) To: Konstantin Ananyev, dev; +Cc: olivier.matz, anatoly.burakov, vipin.varghese Since rte_mbuf_core.h requires generic/rte_atomic.h, shouldn't rte_mbuf_core.h include generic/rte_atomic.h instead of forcing users of rte_mbuf_core.h be aware of this dependency? [ ]'s Michel Machado On 8/16/19 8:53 AM, Konstantin Ananyev wrote: > Get rid of duplicate definitions for rte_mbuf and related macros. > Include rte_mbuf_core.h instead. > > Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com> > --- > examples/bpf/mbuf.h | 605 -------------------------------------------- > examples/bpf/t2.c | 5 +- > examples/bpf/t3.c | 3 +- > 3 files changed, 5 insertions(+), 608 deletions(-) > delete mode 100644 examples/bpf/mbuf.h > > diff --git a/examples/bpf/mbuf.h b/examples/bpf/mbuf.h > deleted file mode 100644 > index e41c3d26e..000000000 > --- a/examples/bpf/mbuf.h > +++ /dev/null > @@ -1,605 +0,0 @@ > -/* SPDX-License-Identifier: BSD-3-Clause > - * Copyright(c) 2010-2014 Intel Corporation. > - * Copyright 2014 6WIND S.A. > - */ > - > -/* > - * Snipper from dpdk.org rte_mbuf.h. > - * used to provide BPF programs information about rte_mbuf layout. > - */ > - > -#ifndef _MBUF_H_ > -#define _MBUF_H_ > - > -#include <stdint.h> > -#include <rte_common.h> > - > -#ifdef __cplusplus > -extern "C" { > -#endif > - > -/* > - * Packet Offload Features Flags. It also carry packet type information. > - * Critical resources. Both rx/tx shared these bits. Be cautious on any change > - * > - * - RX flags start at bit position zero, and get added to the left of previous > - * flags. > - * - The most-significant 3 bits are reserved for generic mbuf flags > - * - TX flags therefore start at bit position 60 (i.e. 63-3), and new flags get > - * added to the right of the previously defined flags i.e. they should count > - * downwards, not upwards. > - * > - * Keep these flags synchronized with rte_get_rx_ol_flag_name() and > - * rte_get_tx_ol_flag_name(). > - */ > - > -/** > - * RX packet is a 802.1q VLAN packet. This flag was set by PMDs when > - * the packet is recognized as a VLAN, but the behavior between PMDs > - * was not the same. This flag is kept for some time to avoid breaking > - * applications and should be replaced by PKT_RX_VLAN_STRIPPED. > - */ > -#define PKT_RX_VLAN_PKT (1ULL << 0) > - > -#define PKT_RX_RSS_HASH (1ULL << 1) > -/**< RX packet with RSS hash result. */ > -#define PKT_RX_FDIR (1ULL << 2) > -/**< RX packet with FDIR match indicate. */ > - > -/** > - * Deprecated. > - * Checking this flag alone is deprecated: check the 2 bits of > - * PKT_RX_L4_CKSUM_MASK. > - * This flag was set when the L4 checksum of a packet was detected as > - * wrong by the hardware. > - */ > -#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) > - > -/** > - * Deprecated. > - * Checking this flag alone is deprecated: check the 2 bits of > - * PKT_RX_IP_CKSUM_MASK. > - * This flag was set when the IP checksum of a packet was detected as > - * wrong by the hardware. > - */ > -#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) > - > -#define PKT_RX_EIP_CKSUM_BAD (1ULL << 5) > -/**< External IP header checksum error. */ > - > -/** > - * A vlan has been stripped by the hardware and its tci is saved in > - * mbuf->vlan_tci. This can only happen if vlan stripping is enabled > - * in the RX configuration of the PMD. > - */ > -#define PKT_RX_VLAN_STRIPPED (1ULL << 6) > - > -/** > - * Mask of bits used to determine the status of RX IP checksum. > - * - PKT_RX_IP_CKSUM_UNKNOWN: no information about the RX IP checksum > - * - PKT_RX_IP_CKSUM_BAD: the IP checksum in the packet is wrong > - * - PKT_RX_IP_CKSUM_GOOD: the IP checksum in the packet is valid > - * - PKT_RX_IP_CKSUM_NONE: the IP checksum is not correct in the packet > - * data, but the integrity of the IP header is verified. > - */ > -#define PKT_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7)) > - > -#define PKT_RX_IP_CKSUM_UNKNOWN 0 > -#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) > -#define PKT_RX_IP_CKSUM_GOOD (1ULL << 7) > -#define PKT_RX_IP_CKSUM_NONE ((1ULL << 4) | (1ULL << 7)) > - > -/** > - * Mask of bits used to determine the status of RX L4 checksum. > - * - PKT_RX_L4_CKSUM_UNKNOWN: no information about the RX L4 checksum > - * - PKT_RX_L4_CKSUM_BAD: the L4 checksum in the packet is wrong > - * - PKT_RX_L4_CKSUM_GOOD: the L4 checksum in the packet is valid > - * - PKT_RX_L4_CKSUM_NONE: the L4 checksum is not correct in the packet > - * data, but the integrity of the L4 data is verified. > - */ > -#define PKT_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8)) > - > -#define PKT_RX_L4_CKSUM_UNKNOWN 0 > -#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) > -#define PKT_RX_L4_CKSUM_GOOD (1ULL << 8) > -#define PKT_RX_L4_CKSUM_NONE ((1ULL << 3) | (1ULL << 8)) > - > -#define PKT_RX_IEEE1588_PTP (1ULL << 9) > -/**< RX IEEE1588 L2 Ethernet PT Packet. */ > -#define PKT_RX_IEEE1588_TMST (1ULL << 10) > -/**< RX IEEE1588 L2/L4 timestamped packet.*/ > -#define PKT_RX_FDIR_ID (1ULL << 13) > -/**< FD id reported if FDIR match. */ > -#define PKT_RX_FDIR_FLX (1ULL << 14) > -/**< Flexible bytes reported if FDIR match. */ > - > -/** > - * The 2 vlans have been stripped by the hardware and their tci are > - * saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer). > - * This can only happen if vlan stripping is enabled in the RX > - * configuration of the PMD. If this flag is set, PKT_RX_VLAN_STRIPPED > - * must also be set. > - */ > -#define PKT_RX_QINQ_STRIPPED (1ULL << 15) > - > -/** > - * Deprecated. > - * RX packet with double VLAN stripped. > - * This flag is replaced by PKT_RX_QINQ_STRIPPED. > - */ > -#define PKT_RX_QINQ_PKT PKT_RX_QINQ_STRIPPED > - > -/** > - * When packets are coalesced by a hardware or virtual driver, this flag > - * can be set in the RX mbuf, meaning that the m->tso_segsz field is > - * valid and is set to the segment size of original packets. > - */ > -#define PKT_RX_LRO (1ULL << 16) > - > -/** > - * Indicate that the timestamp field in the mbuf is valid. > - */ > -#define PKT_RX_TIMESTAMP (1ULL << 17) > - > -/* add new RX flags here */ > - > -/* add new TX flags here */ > - > -/** > - * Offload the MACsec. This flag must be set by the application to enable > - * this offload feature for a packet to be transmitted. > - */ > -#define PKT_TX_MACSEC (1ULL << 44) > - > -/** > - * Bits 45:48 used for the tunnel type. > - * When doing Tx offload like TSO or checksum, the HW needs to configure the > - * tunnel type into the HW descriptors. > - */ > -#define PKT_TX_TUNNEL_VXLAN (0x1ULL << 45) > -#define PKT_TX_TUNNEL_GRE (0x2ULL << 45) > -#define PKT_TX_TUNNEL_IPIP (0x3ULL << 45) > -#define PKT_TX_TUNNEL_GENEVE (0x4ULL << 45) > -/**< TX packet with MPLS-in-UDP RFC 7510 header. */ > -#define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45) > -/* add new TX TUNNEL type here */ > -#define PKT_TX_TUNNEL_MASK (0xFULL << 45) > - > -/** > - * Second VLAN insertion (QinQ) flag. > - */ > -#define PKT_TX_QINQ_PKT (1ULL << 49) > -/**< TX packet with double VLAN inserted. */ > - > -/** > - * TCP segmentation offload. To enable this offload feature for a > - * packet to be transmitted on hardware supporting TSO: > - * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies > - * PKT_TX_TCP_CKSUM) > - * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 > - * - if it's IPv4, set the PKT_TX_IP_CKSUM flag and write the IP checksum > - * to 0 in the packet > - * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz > - * - calculate the pseudo header checksum without taking ip_len in account, > - * and set it in the TCP header. Refer to rte_ipv4_phdr_cksum() and > - * rte_ipv6_phdr_cksum() that can be used as helpers. > - */ > -#define PKT_TX_TCP_SEG (1ULL << 50) > - > -#define PKT_TX_IEEE1588_TMST (1ULL << 51) > -/**< TX IEEE1588 packet to timestamp. */ > - > -/** > - * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved, > - * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware > - * L4 checksum offload, the user needs to: > - * - fill l2_len and l3_len in mbuf > - * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM > - * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 > - * - calculate the pseudo header checksum and set it in the L4 header (only > - * for TCP or UDP). See rte_ipv4_phdr_cksum() and rte_ipv6_phdr_cksum(). > - * For SCTP, set the crc field to 0. > - */ > -#define PKT_TX_L4_NO_CKSUM (0ULL << 52) > -/**< Disable L4 cksum of TX pkt. */ > -#define PKT_TX_TCP_CKSUM (1ULL << 52) > -/**< TCP cksum of TX pkt. computed by NIC. */ > -#define PKT_TX_SCTP_CKSUM (2ULL << 52) > -/**< SCTP cksum of TX pkt. computed by NIC. */ > -#define PKT_TX_UDP_CKSUM (3ULL << 52) > -/**< UDP cksum of TX pkt. computed by NIC. */ > -#define PKT_TX_L4_MASK (3ULL << 52) > -/**< Mask for L4 cksum offload request. */ > - > -/** > - * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should > - * also be set by the application, although a PMD will only check > - * PKT_TX_IP_CKSUM. > - * - set the IP checksum field in the packet to 0 > - * - fill the mbuf offload information: l2_len, l3_len > - */ > -#define PKT_TX_IP_CKSUM (1ULL << 54) > - > -/** > - * Packet is IPv4. This flag must be set when using any offload feature > - * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4 > - * packet. If the packet is a tunneled packet, this flag is related to > - * the inner headers. > - */ > -#define PKT_TX_IPV4 (1ULL << 55) > - > -/** > - * Packet is IPv6. This flag must be set when using an offload feature > - * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6 > - * packet. If the packet is a tunneled packet, this flag is related to > - * the inner headers. > - */ > -#define PKT_TX_IPV6 (1ULL << 56) > - > -#define PKT_TX_VLAN_PKT (1ULL << 57) > -/**< TX packet is a 802.1q VLAN packet. */ > - > -/** > - * Offload the IP checksum of an external header in the hardware. The > - * flag PKT_TX_OUTER_IPV4 should also be set by the application, alto ugh > - * a PMD will only check PKT_TX_IP_CKSUM. The IP checksum field in the > - * packet must be set to 0. > - * - set the outer IP checksum field in the packet to 0 > - * - fill the mbuf offload information: outer_l2_len, outer_l3_len > - */ > -#define PKT_TX_OUTER_IP_CKSUM (1ULL << 58) > - > -/** > - * Packet outer header is IPv4. This flag must be set when using any > - * outer offload feature (L3 or L4 checksum) to tell the NIC that the > - * outer header of the tunneled packet is an IPv4 packet. > - */ > -#define PKT_TX_OUTER_IPV4 (1ULL << 59) > - > -/** > - * Packet outer header is IPv6. This flag must be set when using any > - * outer offload feature (L4 checksum) to tell the NIC that the outer > - * header of the tunneled packet is an IPv6 packet. > - */ > -#define PKT_TX_OUTER_IPV6 (1ULL << 60) > - > -/** > - * Bitmask of all supported packet Tx offload features flags, > - * which can be set for packet. > - */ > -#define PKT_TX_OFFLOAD_MASK ( \ > - PKT_TX_IP_CKSUM | \ > - PKT_TX_L4_MASK | \ > - PKT_TX_OUTER_IP_CKSUM | \ > - PKT_TX_TCP_SEG | \ > - PKT_TX_IEEE1588_TMST | \ > - PKT_TX_QINQ_PKT | \ > - PKT_TX_VLAN_PKT | \ > - PKT_TX_TUNNEL_MASK | \ > - PKT_TX_MACSEC) > - > -#define __RESERVED (1ULL << 61) /**< reserved for future mbuf use */ > - > -#define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */ > - > -/* Use final bit of flags to indicate a control mbuf */ > -#define CTRL_MBUF_FLAG (1ULL << 63) /**< Mbuf contains control data */ > - > -/** Alignment constraint of mbuf private area. */ > -#define RTE_MBUF_PRIV_ALIGN 8 > - > -/** > - * Get the name of a RX offload flag > - * > - * @param mask > - * The mask describing the flag. > - * @return > - * The name of this flag, or NULL if it's not a valid RX flag. > - */ > -const char *rte_get_rx_ol_flag_name(uint64_t mask); > - > -/** > - * Dump the list of RX offload flags in a buffer > - * > - * @param mask > - * The mask describing the RX flags. > - * @param buf > - * The output buffer. > - * @param buflen > - * The length of the buffer. > - * @return > - * 0 on success, (-1) on error. > - */ > -int rte_get_rx_ol_flag_list(uint64_t mask, char *buf, size_t buflen); > - > -/** > - * Get the name of a TX offload flag > - * > - * @param mask > - * The mask describing the flag. Usually only one bit must be set. > - * Several bits can be given if they belong to the same mask. > - * Ex: PKT_TX_L4_MASK. > - * @return > - * The name of this flag, or NULL if it's not a valid TX flag. > - */ > -const char *rte_get_tx_ol_flag_name(uint64_t mask); > - > -/** > - * Dump the list of TX offload flags in a buffer > - * > - * @param mask > - * The mask describing the TX flags. > - * @param buf > - * The output buffer. > - * @param buflen > - * The length of the buffer. > - * @return > - * 0 on success, (-1) on error. > - */ > -int rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen); > - > -/** > - * Some NICs need at least 2KB buffer to RX standard Ethernet frame without > - * splitting it into multiple segments. > - * So, for mbufs that planned to be involved into RX/TX, the recommended > - * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM. > - */ > -#define RTE_MBUF_DEFAULT_DATAROOM 2048 > -#define RTE_MBUF_DEFAULT_BUF_SIZE \ > - (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM) > - > -/* define a set of marker types that can be used to refer to set points in the > - * mbuf. > - */ > -__extension__ > -typedef void *MARKER[0]; /**< generic marker for a point in a structure */ > -__extension__ > -typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */ > -__extension__ > -typedef uint64_t MARKER64[0]; > -/**< marker that allows us to overwrite 8 bytes with a single assignment */ > - > -typedef struct { > - volatile int16_t cnt; /**< An internal counter value. */ > -} rte_atomic16_t; > - > -#define RTE_CACHE_LINE_MIN_SIZE 64 /**< Minimum Cache line size. */ > - > -/** > - * Force minimum cache line alignment. > - */ > -#define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE) > - > -/** > - * IO virtual address type. > - * When the physical addressing mode (IOVA as PA) is in use, > - * the translation from an IO virtual address (IOVA) to a physical address > - * is a direct mapping, i.e. the same value. > - * Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation. > - */ > -typedef uint64_t rte_iova_t; > -#define RTE_BAD_IOVA ((rte_iova_t)-1) > - > -/** > - * The generic rte_mbuf, containing a packet mbuf. > - */ > -struct rte_mbuf { > - MARKER cacheline0; > - > - void *buf_addr; /**< Virtual address of segment buffer. */ > - /** > - * Physical address of segment buffer. > - * Force alignment to 8-bytes, so as to ensure we have the exact > - * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes > - * working on vector drivers easier. > - */ > - RTE_STD_C11 > - union { > - rte_iova_t buf_iova; > - rte_iova_t buf_physaddr; /**< deprecated */ > - } __rte_aligned(sizeof(rte_iova_t)); > - > - /* next 8 bytes are initialised on RX descriptor rearm */ > - MARKER64 rearm_data; > - uint16_t data_off; > - > - /** > - * Reference counter. Its size should at least equal to the size > - * of port field (16 bits), to support zero-copy broadcast. > - * It should only be accessed using the following functions: > - * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and > - * rte_mbuf_refcnt_set(). The functionality of these functions (atomic, > - * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC > - * config option. > - */ > - RTE_STD_C11 > - union { > - rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */ > - uint16_t refcnt; > - /**< Non-atomically accessed refcnt */ > - }; > - uint16_t nb_segs; /**< Number of segments. */ > - > - /** Input port (16 bits to support more than 256 virtual ports). */ > - uint16_t port; > - > - uint64_t ol_flags; /**< Offload features. */ > - > - /* remaining bytes are set on RX when pulling packet from descriptor */ > - MARKER rx_descriptor_fields1; > - > - /* > - * The packet type, which is the combination of outer/inner L2, L3, L4 > - * and tunnel types. The packet_type is about data really present in the > - * mbuf. Example: if vlan stripping is enabled, a received vlan packet > - * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the > - * vlan is stripped from the data. > - */ > - RTE_STD_C11 > - union { > - uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */ > - struct { > - uint32_t l2_type:4; /**< (Outer) L2 type. */ > - uint32_t l3_type:4; /**< (Outer) L3 type. */ > - uint32_t l4_type:4; /**< (Outer) L4 type. */ > - uint32_t tun_type:4; /**< Tunnel type. */ > - uint32_t inner_l2_type:4; /**< Inner L2 type. */ > - uint32_t inner_l3_type:4; /**< Inner L3 type. */ > - uint32_t inner_l4_type:4; /**< Inner L4 type. */ > - }; > - }; > - > - uint32_t pkt_len; /**< Total pkt len: sum of all segments. */ > - uint16_t data_len; /**< Amount of data in segment buffer. */ > - /** VLAN TCI (CPU order), valid if PKT_RX_VLAN_STRIPPED is set. */ > - uint16_t vlan_tci; > - > - union { > - uint32_t rss; /**< RSS hash result if RSS enabled */ > - struct { > - RTE_STD_C11 > - union { > - struct { > - uint16_t hash; > - uint16_t id; > - }; > - uint32_t lo; > - /**< Second 4 flexible bytes */ > - }; > - uint32_t hi; > - /**< First 4 flexible bytes or FD ID, dependent on > - * PKT_RX_FDIR_* flag in ol_flags. > - */ > - } fdir; /**< Filter identifier if FDIR enabled */ > - struct { > - uint32_t lo; > - uint32_t hi; > - } sched; /**< Hierarchical scheduler */ > - uint32_t usr; > - /**< User defined tags. See rte_distributor_process() */ > - } hash; /**< hash information */ > - > - /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ_STRIPPED is set. */ > - uint16_t vlan_tci_outer; > - > - uint16_t buf_len; /**< Length of segment buffer. */ > - > - /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference > - * are not normalized but are always the same for a given port. > - */ > - uint64_t timestamp; > - > - /* second cache line - fields only used in slow path or on TX */ > - MARKER cacheline1 __rte_cache_min_aligned; > - > - RTE_STD_C11 > - union { > - void *userdata; /**< Can be used for external metadata */ > - uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */ > - }; > - > - struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */ > - struct rte_mbuf *next; /**< Next segment of scattered packet. */ > - > - /* fields to support TX offloads */ > - RTE_STD_C11 > - union { > - uint64_t tx_offload; /**< combined for easy fetch */ > - __extension__ > - struct { > - uint64_t l2_len:7; > - /**< L2 (MAC) Header Length for non-tunneling pkt. > - * Outer_L4_len + ... + Inner_L2_len for tunneling pkt. > - */ > - uint64_t l3_len:9; /**< L3 (IP) Header Length. */ > - uint64_t l4_len:8; /**< L4 (TCP/UDP) Header Length. */ > - uint64_t tso_segsz:16; /**< TCP TSO segment size */ > - > - /* fields for TX offloading of tunnels */ > - uint64_t outer_l3_len:9; > - /**< Outer L3 (IP) Hdr Length. */ > - uint64_t outer_l2_len:7; > - /**< Outer L2 (MAC) Hdr Length. */ > - > - /* uint64_t unused:8; */ > - }; > - }; > - > - /** Size of the application private data. In case of an indirect > - * mbuf, it stores the direct mbuf private data size. > - */ > - uint16_t priv_size; > - > - /** Timesync flags for use with IEEE1588. */ > - uint16_t timesync; > - > - /** Sequence number. See also rte_reorder_insert(). */ > - uint32_t seqn; > - > -} __rte_cache_aligned; > - > - > -/** > - * Returns TRUE if given mbuf is cloned by mbuf indirection, or FALSE > - * otherwise. > - * > - * If a mbuf has its data in another mbuf and references it by mbuf > - * indirection, this mbuf can be defined as a cloned mbuf. > - */ > -#define RTE_MBUF_CLONED(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF) > - > -/** > - * Returns TRUE if given mbuf is direct, or FALSE otherwise. > - * > - * If a mbuf embeds its own data after the rte_mbuf structure, this mbuf > - * can be defined as a direct mbuf. > - */ > -#define RTE_MBUF_DIRECT(mb) (!RTE_MBUF_CLONED(mb)) > - > -/** > - * Private data in case of pktmbuf pool. > - * > - * A structure that contains some pktmbuf_pool-specific data that are > - * appended after the mempool structure (in private data). > - */ > -struct rte_pktmbuf_pool_private { > - uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf. */ > - uint16_t mbuf_priv_size; /**< Size of private area in each mbuf. */ > -}; > - > -/** > - * A macro that points to an offset into the data in the mbuf. > - * > - * The returned pointer is cast to type t. Before using this > - * function, the user must ensure that the first segment is large > - * enough to accommodate its data. > - * > - * @param m > - * The packet mbuf. > - * @param o > - * The offset into the mbuf data. > - * @param t > - * The type to cast the result into. > - */ > -#define rte_pktmbuf_mtod_offset(m, t, o) \ > - ((t)((char *)(m)->buf_addr + (m)->data_off + (o))) > - > -/** > - * A macro that points to the start of the data in the mbuf. > - * > - * The returned pointer is cast to type t. Before using this > - * function, the user must ensure that the first segment is large > - * enough to accommodate its data. > - * > - * @param m > - * The packet mbuf. > - * @param t > - * The type to cast the result into. > - */ > -#define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0) > - > -#ifdef __cplusplus > -} > -#endif > - > -#endif /* _MBUF_H_ */ > diff --git a/examples/bpf/t2.c b/examples/bpf/t2.c > index 69d7a4fe1..3eee65450 100644 > --- a/examples/bpf/t2.c > +++ b/examples/bpf/t2.c > @@ -16,7 +16,8 @@ > #include <stdint.h> > #include <stddef.h> > #include <rte_config.h> > -#include "mbuf.h" > +#include <generic/rte_atomic.h> > +#include <rte_mbuf_core.h> > > uint64_t > entry(void *pkt) > @@ -25,7 +26,7 @@ entry(void *pkt) > > mb = pkt; > mb->vlan_tci = 0; > - mb->ol_flags &= ~(PKT_RX_VLAN_PKT | PKT_RX_VLAN_STRIPPED); > + mb->ol_flags &= ~(PKT_RX_VLAN | PKT_RX_VLAN_STRIPPED); > > return 1; > } > diff --git a/examples/bpf/t3.c b/examples/bpf/t3.c > index 9ba34638a..58e0db1c2 100644 > --- a/examples/bpf/t3.c > +++ b/examples/bpf/t3.c > @@ -22,7 +22,8 @@ > #include <stdio.h> > #include <net/ethernet.h> > #include <rte_config.h> > -#include "mbuf.h" > +#include <generic/rte_atomic.h> > +#include <rte_mbuf_core.h> > #include <arpa/inet.h> > > extern void rte_pktmbuf_dump(FILE *, const struct rte_mbuf *, unsigned int); > ^ permalink raw reply [flat|nested] 17+ messages in thread
* [dpdk-dev] [PATCH v2 0/3] move mbuf definition into a separate file 2019-08-16 12:53 [dpdk-dev] [PATCH 0/3] move mbuf definition into a separate file Konstantin Ananyev ` (2 preceding siblings ...) 2019-08-16 12:53 ` [dpdk-dev] [PATCH 3/3] examples/bpf: remove duplicate mbuf definition Konstantin Ananyev @ 2019-09-27 13:50 ` Konstantin Ananyev 2019-09-27 13:50 ` [dpdk-dev] [PATCH v2 1/3] eal: move CACHE and IOVA related definitions Konstantin Ananyev ` (3 more replies) 3 siblings, 4 replies; 17+ messages in thread From: Konstantin Ananyev @ 2019-09-27 13:50 UTC (permalink / raw) To: dev Cc: michel, olivier.matz, anatoly.burakov, vipin.varghese, Konstantin Ananyev v1 -> v2 As per Michel comments included <generic/rte_atomic.h> into rte_mbuf_core.h Right now inclusion of rte_mbuf.h header can cause inclusion of some arch/os specific headers. That prevents it to be included directly by some non-DPDK (but related) entities: KNI, BPF programs, etc. To overcome that problem usually a separate definitions of rte_mbuf structure is created within these entities. That aproach has a lot of drawbacks: code duplication, error prone, etc. This series moves rte_mbuf structure definition (and some related macros) into a separate file that can be included by both rte_mbuf.h and other non-DPDK entities. Note that these moves shouldn't introduce any change for current DPDK code. Konstantin Ananyev (3): eal: move CACHE and IOVA related definitions mbuf: move mbuf definition into a separate file examples/bpf: remove duplicate mbuf definition examples/bpf/t2.c | 4 +- examples/bpf/t3.c | 2 +- lib/librte_eal/common/include/rte_common.h | 44 ++ lib/librte_eal/common/include/rte_memory.h | 38 - lib/librte_mbuf/Makefile | 5 +- lib/librte_mbuf/meson.build | 3 +- lib/librte_mbuf/rte_mbuf.h | 738 +----------------- .../mbuf.h => lib/librte_mbuf/rte_mbuf_core.h | 558 ++++++++----- 8 files changed, 427 insertions(+), 965 deletions(-) rename examples/bpf/mbuf.h => lib/librte_mbuf/rte_mbuf_core.h (51%) -- 2.17.1 ^ permalink raw reply [flat|nested] 17+ messages in thread
* [dpdk-dev] [PATCH v2 1/3] eal: move CACHE and IOVA related definitions 2019-09-27 13:50 ` [dpdk-dev] [PATCH v2 0/3] move mbuf definition into a separate file Konstantin Ananyev @ 2019-09-27 13:50 ` Konstantin Ananyev 2019-09-30 19:34 ` Michel Machado 2019-09-27 13:50 ` [dpdk-dev] [PATCH v2 2/3] mbuf: move mbuf definition into a separate file Konstantin Ananyev ` (2 subsequent siblings) 3 siblings, 1 reply; 17+ messages in thread From: Konstantin Ananyev @ 2019-09-27 13:50 UTC (permalink / raw) To: dev Cc: michel, olivier.matz, anatoly.burakov, vipin.varghese, Konstantin Ananyev Right now RTE_CACHE_ and IOVA definitions are located inside rte_memory.h That might cause an unwanted inclusions of arch/os specific header files. See [1] for particular problem example. Probably the simplest way to deal with such problems - move these definitions into rte_commmon.h Note that this move doesn't introduce any change in functionality. [1] https://bugs.dpdk.org/show_bug.cgi?id=321 Suggested-by: Vipin Varghese <vipin.varghese@intel.com> Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com> --- lib/librte_eal/common/include/rte_common.h | 44 ++++++++++++++++++++++ lib/librte_eal/common/include/rte_memory.h | 38 ------------------- 2 files changed, 44 insertions(+), 38 deletions(-) diff --git a/lib/librte_eal/common/include/rte_common.h b/lib/librte_eal/common/include/rte_common.h index 05a3a6401..c275093d7 100644 --- a/lib/librte_eal/common/include/rte_common.h +++ b/lib/librte_eal/common/include/rte_common.h @@ -291,6 +291,50 @@ rte_is_aligned(void *ptr, unsigned align) */ #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)])) +/*********** RTE_CACHE related macros ********/ + +#define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1) /**< Cache line mask. */ + +#define RTE_CACHE_LINE_ROUNDUP(size) \ + (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / \ + RTE_CACHE_LINE_SIZE)) +/**< Return the first cache-aligned value greater or equal to size. */ + +/**< Cache line size in terms of log2 */ +#if RTE_CACHE_LINE_SIZE == 64 +#define RTE_CACHE_LINE_SIZE_LOG2 6 +#elif RTE_CACHE_LINE_SIZE == 128 +#define RTE_CACHE_LINE_SIZE_LOG2 7 +#else +#error "Unsupported cache line size" +#endif + +#define RTE_CACHE_LINE_MIN_SIZE 64 /**< Minimum Cache line size. */ + +/** + * Force alignment to cache line. + */ +#define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE) + +/** + * Force minimum cache line alignment. + */ +#define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE) + +/*********** PA/IOVA type definitions ********/ + +typedef uint64_t phys_addr_t; /**< Physical address. */ +#define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1) +/** + * IO virtual address type. + * When the physical addressing mode (IOVA as PA) is in use, + * the translation from an IO virtual address (IOVA) to a physical address + * is a direct mapping, i.e. the same value. + * Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation. + */ +typedef uint64_t rte_iova_t; +#define RTE_BAD_IOVA ((rte_iova_t)-1) + /** * Combines 32b inputs most significant set bits into the least * significant bits to construct a value with the same MSBs as x diff --git a/lib/librte_eal/common/include/rte_memory.h b/lib/librte_eal/common/include/rte_memory.h index 4717dcb43..38e00e382 100644 --- a/lib/librte_eal/common/include/rte_memory.h +++ b/lib/librte_eal/common/include/rte_memory.h @@ -39,44 +39,6 @@ enum rte_page_sizes { }; #define SOCKET_ID_ANY -1 /**< Any NUMA socket. */ -#define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1) /**< Cache line mask. */ - -#define RTE_CACHE_LINE_ROUNDUP(size) \ - (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE)) -/**< Return the first cache-aligned value greater or equal to size. */ - -/**< Cache line size in terms of log2 */ -#if RTE_CACHE_LINE_SIZE == 64 -#define RTE_CACHE_LINE_SIZE_LOG2 6 -#elif RTE_CACHE_LINE_SIZE == 128 -#define RTE_CACHE_LINE_SIZE_LOG2 7 -#else -#error "Unsupported cache line size" -#endif - -#define RTE_CACHE_LINE_MIN_SIZE 64 /**< Minimum Cache line size. */ - -/** - * Force alignment to cache line. - */ -#define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE) - -/** - * Force minimum cache line alignment. - */ -#define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE) - -typedef uint64_t phys_addr_t; /**< Physical address. */ -#define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1) -/** - * IO virtual address type. - * When the physical addressing mode (IOVA as PA) is in use, - * the translation from an IO virtual address (IOVA) to a physical address - * is a direct mapping, i.e. the same value. - * Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation. - */ -typedef uint64_t rte_iova_t; -#define RTE_BAD_IOVA ((rte_iova_t)-1) /** * Physical memory segment descriptor. -- 2.17.1 ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [dpdk-dev] [PATCH v2 1/3] eal: move CACHE and IOVA related definitions 2019-09-27 13:50 ` [dpdk-dev] [PATCH v2 1/3] eal: move CACHE and IOVA related definitions Konstantin Ananyev @ 2019-09-30 19:34 ` Michel Machado 0 siblings, 0 replies; 17+ messages in thread From: Michel Machado @ 2019-09-30 19:34 UTC (permalink / raw) To: Konstantin Ananyev, dev; +Cc: olivier.matz, anatoly.burakov, vipin.varghese Acked-by: Michel Machado <michel@digirati.com.br> [ ]'s Michel Machado On 9/27/19 9:50 AM, Konstantin Ananyev wrote: > Right now RTE_CACHE_ and IOVA definitions are located inside rte_memory.h > That might cause an unwanted inclusions of arch/os specific header files. > See [1] for particular problem example. > Probably the simplest way to deal with such problems - > move these definitions into rte_commmon.h > > Note that this move doesn't introduce any change in functionality. > > [1] https://bugs.dpdk.org/show_bug.cgi?id=321 > > Suggested-by: Vipin Varghese <vipin.varghese@intel.com> > Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com> > --- > lib/librte_eal/common/include/rte_common.h | 44 ++++++++++++++++++++++ > lib/librte_eal/common/include/rte_memory.h | 38 ------------------- > 2 files changed, 44 insertions(+), 38 deletions(-) > > diff --git a/lib/librte_eal/common/include/rte_common.h b/lib/librte_eal/common/include/rte_common.h > index 05a3a6401..c275093d7 100644 > --- a/lib/librte_eal/common/include/rte_common.h > +++ b/lib/librte_eal/common/include/rte_common.h > @@ -291,6 +291,50 @@ rte_is_aligned(void *ptr, unsigned align) > */ > #define RTE_BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)])) > > +/*********** RTE_CACHE related macros ********/ > + > +#define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1) /**< Cache line mask. */ > + > +#define RTE_CACHE_LINE_ROUNDUP(size) \ > + (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / \ > + RTE_CACHE_LINE_SIZE)) > +/**< Return the first cache-aligned value greater or equal to size. */ > + > +/**< Cache line size in terms of log2 */ > +#if RTE_CACHE_LINE_SIZE == 64 > +#define RTE_CACHE_LINE_SIZE_LOG2 6 > +#elif RTE_CACHE_LINE_SIZE == 128 > +#define RTE_CACHE_LINE_SIZE_LOG2 7 > +#else > +#error "Unsupported cache line size" > +#endif > + > +#define RTE_CACHE_LINE_MIN_SIZE 64 /**< Minimum Cache line size. */ > + > +/** > + * Force alignment to cache line. > + */ > +#define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE) > + > +/** > + * Force minimum cache line alignment. > + */ > +#define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE) > + > +/*********** PA/IOVA type definitions ********/ > + > +typedef uint64_t phys_addr_t; /**< Physical address. */ > +#define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1) > +/** > + * IO virtual address type. > + * When the physical addressing mode (IOVA as PA) is in use, > + * the translation from an IO virtual address (IOVA) to a physical address > + * is a direct mapping, i.e. the same value. > + * Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation. > + */ > +typedef uint64_t rte_iova_t; > +#define RTE_BAD_IOVA ((rte_iova_t)-1) > + > /** > * Combines 32b inputs most significant set bits into the least > * significant bits to construct a value with the same MSBs as x > diff --git a/lib/librte_eal/common/include/rte_memory.h b/lib/librte_eal/common/include/rte_memory.h > index 4717dcb43..38e00e382 100644 > --- a/lib/librte_eal/common/include/rte_memory.h > +++ b/lib/librte_eal/common/include/rte_memory.h > @@ -39,44 +39,6 @@ enum rte_page_sizes { > }; > > #define SOCKET_ID_ANY -1 /**< Any NUMA socket. */ > -#define RTE_CACHE_LINE_MASK (RTE_CACHE_LINE_SIZE-1) /**< Cache line mask. */ > - > -#define RTE_CACHE_LINE_ROUNDUP(size) \ > - (RTE_CACHE_LINE_SIZE * ((size + RTE_CACHE_LINE_SIZE - 1) / RTE_CACHE_LINE_SIZE)) > -/**< Return the first cache-aligned value greater or equal to size. */ > - > -/**< Cache line size in terms of log2 */ > -#if RTE_CACHE_LINE_SIZE == 64 > -#define RTE_CACHE_LINE_SIZE_LOG2 6 > -#elif RTE_CACHE_LINE_SIZE == 128 > -#define RTE_CACHE_LINE_SIZE_LOG2 7 > -#else > -#error "Unsupported cache line size" > -#endif > - > -#define RTE_CACHE_LINE_MIN_SIZE 64 /**< Minimum Cache line size. */ > - > -/** > - * Force alignment to cache line. > - */ > -#define __rte_cache_aligned __rte_aligned(RTE_CACHE_LINE_SIZE) > - > -/** > - * Force minimum cache line alignment. > - */ > -#define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE) > - > -typedef uint64_t phys_addr_t; /**< Physical address. */ > -#define RTE_BAD_PHYS_ADDR ((phys_addr_t)-1) > -/** > - * IO virtual address type. > - * When the physical addressing mode (IOVA as PA) is in use, > - * the translation from an IO virtual address (IOVA) to a physical address > - * is a direct mapping, i.e. the same value. > - * Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation. > - */ > -typedef uint64_t rte_iova_t; > -#define RTE_BAD_IOVA ((rte_iova_t)-1) > > /** > * Physical memory segment descriptor. > ^ permalink raw reply [flat|nested] 17+ messages in thread
* [dpdk-dev] [PATCH v2 2/3] mbuf: move mbuf definition into a separate file 2019-09-27 13:50 ` [dpdk-dev] [PATCH v2 0/3] move mbuf definition into a separate file Konstantin Ananyev 2019-09-27 13:50 ` [dpdk-dev] [PATCH v2 1/3] eal: move CACHE and IOVA related definitions Konstantin Ananyev @ 2019-09-27 13:50 ` Konstantin Ananyev 2019-09-27 14:42 ` Andrew Rybchenko ` (2 more replies) 2019-09-27 13:50 ` [dpdk-dev] [PATCH v2 3/3] examples/bpf: remove duplicate mbuf definition Konstantin Ananyev 2019-10-25 20:33 ` [dpdk-dev] [PATCH v2 0/3] move mbuf definition into a separate file Thomas Monjalon 3 siblings, 3 replies; 17+ messages in thread From: Konstantin Ananyev @ 2019-09-27 13:50 UTC (permalink / raw) To: dev Cc: michel, olivier.matz, anatoly.burakov, vipin.varghese, Konstantin Ananyev Right now inclusion of rte_mbuf.h header can cause inclusion of some arch/os specific headers. That prevents it to be included directly by some non-DPDK (but related) entities: KNI, BPF programs, etc. To overcome that problem usually a separate definitions of rte_mbuf structure is created within these entities. That aproach has a lot of drawbacks: code duplication, error prone, etc. This patch moves rte_mbuf structure definition (and some related macros) into a separate file that can be included by both rte_mbuf.h and other non-DPDK entities. Note that it doesn't introduce any change for current DPDK code. Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com> --- lib/librte_mbuf/Makefile | 5 +- lib/librte_mbuf/meson.build | 3 +- lib/librte_mbuf/rte_mbuf.h | 738 +---------------------------- lib/librte_mbuf/rte_mbuf_core.h | 793 ++++++++++++++++++++++++++++++++ 4 files changed, 800 insertions(+), 739 deletions(-) create mode 100644 lib/librte_mbuf/rte_mbuf_core.h diff --git a/lib/librte_mbuf/Makefile b/lib/librte_mbuf/Makefile index c8f6d2689..f3b76ad23 100644 --- a/lib/librte_mbuf/Makefile +++ b/lib/librte_mbuf/Makefile @@ -19,6 +19,9 @@ LIBABIVER := 5 SRCS-$(CONFIG_RTE_LIBRTE_MBUF) := rte_mbuf.c rte_mbuf_ptype.c rte_mbuf_pool_ops.c # install includes -SYMLINK-$(CONFIG_RTE_LIBRTE_MBUF)-include := rte_mbuf.h rte_mbuf_ptype.h rte_mbuf_pool_ops.h +SYMLINK-$(CONFIG_RTE_LIBRTE_MBUF)-include := rte_mbuf.h +SYMLINK-$(CONFIG_RTE_LIBRTE_MBUF)-include += rte_mbuf_core.h +SYMLINK-$(CONFIG_RTE_LIBRTE_MBUF)-include += rte_mbuf_ptype.h +SYMLINK-$(CONFIG_RTE_LIBRTE_MBUF)-include += rte_mbuf_pool_ops.h include $(RTE_SDK)/mk/rte.lib.mk diff --git a/lib/librte_mbuf/meson.build b/lib/librte_mbuf/meson.build index 6cc11ebb4..36bb6eb9d 100644 --- a/lib/librte_mbuf/meson.build +++ b/lib/librte_mbuf/meson.build @@ -3,7 +3,8 @@ version = 5 sources = files('rte_mbuf.c', 'rte_mbuf_ptype.c', 'rte_mbuf_pool_ops.c') -headers = files('rte_mbuf.h', 'rte_mbuf_ptype.h', 'rte_mbuf_pool_ops.h') +headers = files('rte_mbuf.h', 'rte_mbuf_core.h', + 'rte_mbuf_ptype.h', 'rte_mbuf_pool_ops.h') deps += ['mempool'] allow_experimental_apis = true diff --git a/lib/librte_mbuf/rte_mbuf.h b/lib/librte_mbuf/rte_mbuf.h index 98225ec80..528b2f121 100644 --- a/lib/librte_mbuf/rte_mbuf.h +++ b/lib/librte_mbuf/rte_mbuf.h @@ -42,367 +42,12 @@ #include <rte_branch_prediction.h> #include <rte_byteorder.h> #include <rte_mbuf_ptype.h> +#include <rte_mbuf_core.h> #ifdef __cplusplus extern "C" { #endif -/* - * Packet Offload Features Flags. It also carry packet type information. - * Critical resources. Both rx/tx shared these bits. Be cautious on any change - * - * - RX flags start at bit position zero, and get added to the left of previous - * flags. - * - The most-significant 3 bits are reserved for generic mbuf flags - * - TX flags therefore start at bit position 60 (i.e. 63-3), and new flags get - * added to the right of the previously defined flags i.e. they should count - * downwards, not upwards. - * - * Keep these flags synchronized with rte_get_rx_ol_flag_name() and - * rte_get_tx_ol_flag_name(). - */ - -/** - * The RX packet is a 802.1q VLAN packet, and the tci has been - * saved in in mbuf->vlan_tci. - * If the flag PKT_RX_VLAN_STRIPPED is also present, the VLAN - * header has been stripped from mbuf data, else it is still - * present. - */ -#define PKT_RX_VLAN (1ULL << 0) - -#define PKT_RX_RSS_HASH (1ULL << 1) /**< RX packet with RSS hash result. */ -#define PKT_RX_FDIR (1ULL << 2) /**< RX packet with FDIR match indicate. */ - -/** - * Deprecated. - * Checking this flag alone is deprecated: check the 2 bits of - * PKT_RX_L4_CKSUM_MASK. - * This flag was set when the L4 checksum of a packet was detected as - * wrong by the hardware. - */ -#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) - -/** - * Deprecated. - * Checking this flag alone is deprecated: check the 2 bits of - * PKT_RX_IP_CKSUM_MASK. - * This flag was set when the IP checksum of a packet was detected as - * wrong by the hardware. - */ -#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) - -#define PKT_RX_EIP_CKSUM_BAD (1ULL << 5) /**< External IP header checksum error. */ - -/** - * A vlan has been stripped by the hardware and its tci is saved in - * mbuf->vlan_tci. This can only happen if vlan stripping is enabled - * in the RX configuration of the PMD. - * When PKT_RX_VLAN_STRIPPED is set, PKT_RX_VLAN must also be set. - */ -#define PKT_RX_VLAN_STRIPPED (1ULL << 6) - -/** - * Mask of bits used to determine the status of RX IP checksum. - * - PKT_RX_IP_CKSUM_UNKNOWN: no information about the RX IP checksum - * - PKT_RX_IP_CKSUM_BAD: the IP checksum in the packet is wrong - * - PKT_RX_IP_CKSUM_GOOD: the IP checksum in the packet is valid - * - PKT_RX_IP_CKSUM_NONE: the IP checksum is not correct in the packet - * data, but the integrity of the IP header is verified. - */ -#define PKT_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7)) - -#define PKT_RX_IP_CKSUM_UNKNOWN 0 -#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) -#define PKT_RX_IP_CKSUM_GOOD (1ULL << 7) -#define PKT_RX_IP_CKSUM_NONE ((1ULL << 4) | (1ULL << 7)) - -/** - * Mask of bits used to determine the status of RX L4 checksum. - * - PKT_RX_L4_CKSUM_UNKNOWN: no information about the RX L4 checksum - * - PKT_RX_L4_CKSUM_BAD: the L4 checksum in the packet is wrong - * - PKT_RX_L4_CKSUM_GOOD: the L4 checksum in the packet is valid - * - PKT_RX_L4_CKSUM_NONE: the L4 checksum is not correct in the packet - * data, but the integrity of the L4 data is verified. - */ -#define PKT_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8)) - -#define PKT_RX_L4_CKSUM_UNKNOWN 0 -#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) -#define PKT_RX_L4_CKSUM_GOOD (1ULL << 8) -#define PKT_RX_L4_CKSUM_NONE ((1ULL << 3) | (1ULL << 8)) - -#define PKT_RX_IEEE1588_PTP (1ULL << 9) /**< RX IEEE1588 L2 Ethernet PT Packet. */ -#define PKT_RX_IEEE1588_TMST (1ULL << 10) /**< RX IEEE1588 L2/L4 timestamped packet.*/ -#define PKT_RX_FDIR_ID (1ULL << 13) /**< FD id reported if FDIR match. */ -#define PKT_RX_FDIR_FLX (1ULL << 14) /**< Flexible bytes reported if FDIR match. */ - -/** - * The 2 vlans have been stripped by the hardware and their tci are - * saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer). - * This can only happen if vlan stripping is enabled in the RX - * configuration of the PMD. - * When PKT_RX_QINQ_STRIPPED is set, the flags (PKT_RX_VLAN | - * PKT_RX_VLAN_STRIPPED | PKT_RX_QINQ) must also be set. - */ -#define PKT_RX_QINQ_STRIPPED (1ULL << 15) - -/** - * When packets are coalesced by a hardware or virtual driver, this flag - * can be set in the RX mbuf, meaning that the m->tso_segsz field is - * valid and is set to the segment size of original packets. - */ -#define PKT_RX_LRO (1ULL << 16) - -/** - * Indicate that the timestamp field in the mbuf is valid. - */ -#define PKT_RX_TIMESTAMP (1ULL << 17) - -/** - * Indicate that security offload processing was applied on the RX packet. - */ -#define PKT_RX_SEC_OFFLOAD (1ULL << 18) - -/** - * Indicate that security offload processing failed on the RX packet. - */ -#define PKT_RX_SEC_OFFLOAD_FAILED (1ULL << 19) - -/** - * The RX packet is a double VLAN, and the outer tci has been - * saved in in mbuf->vlan_tci_outer. If PKT_RX_QINQ set, PKT_RX_VLAN - * also should be set and inner tci should be saved to mbuf->vlan_tci. - * If the flag PKT_RX_QINQ_STRIPPED is also present, both VLANs - * headers have been stripped from mbuf data, else they are still - * present. - */ -#define PKT_RX_QINQ (1ULL << 20) - -/** - * Mask of bits used to determine the status of outer RX L4 checksum. - * - PKT_RX_OUTER_L4_CKSUM_UNKNOWN: no info about the outer RX L4 checksum - * - PKT_RX_OUTER_L4_CKSUM_BAD: the outer L4 checksum in the packet is wrong - * - PKT_RX_OUTER_L4_CKSUM_GOOD: the outer L4 checksum in the packet is valid - * - PKT_RX_OUTER_L4_CKSUM_INVALID: invalid outer L4 checksum state. - * - * The detection of PKT_RX_OUTER_L4_CKSUM_GOOD shall be based on the given - * HW capability, At minimum, the PMD should support - * PKT_RX_OUTER_L4_CKSUM_UNKNOWN and PKT_RX_OUTER_L4_CKSUM_BAD states - * if the DEV_RX_OFFLOAD_OUTER_UDP_CKSUM offload is available. - */ -#define PKT_RX_OUTER_L4_CKSUM_MASK ((1ULL << 21) | (1ULL << 22)) - -#define PKT_RX_OUTER_L4_CKSUM_UNKNOWN 0 -#define PKT_RX_OUTER_L4_CKSUM_BAD (1ULL << 21) -#define PKT_RX_OUTER_L4_CKSUM_GOOD (1ULL << 22) -#define PKT_RX_OUTER_L4_CKSUM_INVALID ((1ULL << 21) | (1ULL << 22)) - -/* add new RX flags here */ - -/* add new TX flags here */ - -/** - * Indicate that the metadata field in the mbuf is in use. - */ -#define PKT_TX_METADATA (1ULL << 40) - -/** - * Outer UDP checksum offload flag. This flag is used for enabling - * outer UDP checksum in PMD. To use outer UDP checksum, the user needs to - * 1) Enable the following in mbuf, - * a) Fill outer_l2_len and outer_l3_len in mbuf. - * b) Set the PKT_TX_OUTER_UDP_CKSUM flag. - * c) Set the PKT_TX_OUTER_IPV4 or PKT_TX_OUTER_IPV6 flag. - * 2) Configure DEV_TX_OFFLOAD_OUTER_UDP_CKSUM offload flag. - */ -#define PKT_TX_OUTER_UDP_CKSUM (1ULL << 41) - -/** - * UDP Fragmentation Offload flag. This flag is used for enabling UDP - * fragmentation in SW or in HW. When use UFO, mbuf->tso_segsz is used - * to store the MSS of UDP fragments. - */ -#define PKT_TX_UDP_SEG (1ULL << 42) - -/** - * Request security offload processing on the TX packet. - */ -#define PKT_TX_SEC_OFFLOAD (1ULL << 43) - -/** - * Offload the MACsec. This flag must be set by the application to enable - * this offload feature for a packet to be transmitted. - */ -#define PKT_TX_MACSEC (1ULL << 44) - -/** - * Bits 45:48 used for the tunnel type. - * The tunnel type must be specified for TSO or checksum on the inner part - * of tunnel packets. - * These flags can be used with PKT_TX_TCP_SEG for TSO, or PKT_TX_xxx_CKSUM. - * The mbuf fields for inner and outer header lengths are required: - * outer_l2_len, outer_l3_len, l2_len, l3_len, l4_len and tso_segsz for TSO. - */ -#define PKT_TX_TUNNEL_VXLAN (0x1ULL << 45) -#define PKT_TX_TUNNEL_GRE (0x2ULL << 45) -#define PKT_TX_TUNNEL_IPIP (0x3ULL << 45) -#define PKT_TX_TUNNEL_GENEVE (0x4ULL << 45) -/** TX packet with MPLS-in-UDP RFC 7510 header. */ -#define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45) -#define PKT_TX_TUNNEL_VXLAN_GPE (0x6ULL << 45) -/** - * Generic IP encapsulated tunnel type, used for TSO and checksum offload. - * It can be used for tunnels which are not standards or listed above. - * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_GRE - * or PKT_TX_TUNNEL_IPIP if possible. - * The ethdev must be configured with DEV_TX_OFFLOAD_IP_TNL_TSO. - * Outer and inner checksums are done according to the existing flags like - * PKT_TX_xxx_CKSUM. - * Specific tunnel headers that contain payload length, sequence id - * or checksum are not expected to be updated. - */ -#define PKT_TX_TUNNEL_IP (0xDULL << 45) -/** - * Generic UDP encapsulated tunnel type, used for TSO and checksum offload. - * UDP tunnel type implies outer IP layer. - * It can be used for tunnels which are not standards or listed above. - * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_VXLAN - * if possible. - * The ethdev must be configured with DEV_TX_OFFLOAD_UDP_TNL_TSO. - * Outer and inner checksums are done according to the existing flags like - * PKT_TX_xxx_CKSUM. - * Specific tunnel headers that contain payload length, sequence id - * or checksum are not expected to be updated. - */ -#define PKT_TX_TUNNEL_UDP (0xEULL << 45) -/* add new TX TUNNEL type here */ -#define PKT_TX_TUNNEL_MASK (0xFULL << 45) - -/** - * Double VLAN insertion (QinQ) request to driver, driver may offload the - * insertion based on device capability. - * mbuf 'vlan_tci' & 'vlan_tci_outer' must be valid when this flag is set. - */ -#define PKT_TX_QINQ (1ULL << 49) -/* this old name is deprecated */ -#define PKT_TX_QINQ_PKT PKT_TX_QINQ - -/** - * TCP segmentation offload. To enable this offload feature for a - * packet to be transmitted on hardware supporting TSO: - * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies - * PKT_TX_TCP_CKSUM) - * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 - * - if it's IPv4, set the PKT_TX_IP_CKSUM flag - * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz - */ -#define PKT_TX_TCP_SEG (1ULL << 50) - -#define PKT_TX_IEEE1588_TMST (1ULL << 51) /**< TX IEEE1588 packet to timestamp. */ - -/** - * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved, - * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware - * L4 checksum offload, the user needs to: - * - fill l2_len and l3_len in mbuf - * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM - * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 - */ -#define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */ -#define PKT_TX_TCP_CKSUM (1ULL << 52) /**< TCP cksum of TX pkt. computed by NIC. */ -#define PKT_TX_SCTP_CKSUM (2ULL << 52) /**< SCTP cksum of TX pkt. computed by NIC. */ -#define PKT_TX_UDP_CKSUM (3ULL << 52) /**< UDP cksum of TX pkt. computed by NIC. */ -#define PKT_TX_L4_MASK (3ULL << 52) /**< Mask for L4 cksum offload request. */ - -/** - * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should - * also be set by the application, although a PMD will only check - * PKT_TX_IP_CKSUM. - * - fill the mbuf offload information: l2_len, l3_len - */ -#define PKT_TX_IP_CKSUM (1ULL << 54) - -/** - * Packet is IPv4. This flag must be set when using any offload feature - * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4 - * packet. If the packet is a tunneled packet, this flag is related to - * the inner headers. - */ -#define PKT_TX_IPV4 (1ULL << 55) - -/** - * Packet is IPv6. This flag must be set when using an offload feature - * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6 - * packet. If the packet is a tunneled packet, this flag is related to - * the inner headers. - */ -#define PKT_TX_IPV6 (1ULL << 56) - -/** - * VLAN tag insertion request to driver, driver may offload the insertion - * based on the device capability. - * mbuf 'vlan_tci' field must be valid when this flag is set. - */ -#define PKT_TX_VLAN (1ULL << 57) -/* this old name is deprecated */ -#define PKT_TX_VLAN_PKT PKT_TX_VLAN - -/** - * Offload the IP checksum of an external header in the hardware. The - * flag PKT_TX_OUTER_IPV4 should also be set by the application, although - * a PMD will only check PKT_TX_OUTER_IP_CKSUM. - * - fill the mbuf offload information: outer_l2_len, outer_l3_len - */ -#define PKT_TX_OUTER_IP_CKSUM (1ULL << 58) - -/** - * Packet outer header is IPv4. This flag must be set when using any - * outer offload feature (L3 or L4 checksum) to tell the NIC that the - * outer header of the tunneled packet is an IPv4 packet. - */ -#define PKT_TX_OUTER_IPV4 (1ULL << 59) - -/** - * Packet outer header is IPv6. This flag must be set when using any - * outer offload feature (L4 checksum) to tell the NIC that the outer - * header of the tunneled packet is an IPv6 packet. - */ -#define PKT_TX_OUTER_IPV6 (1ULL << 60) - -/** - * Bitmask of all supported packet Tx offload features flags, - * which can be set for packet. - */ -#define PKT_TX_OFFLOAD_MASK ( \ - PKT_TX_OUTER_IPV6 | \ - PKT_TX_OUTER_IPV4 | \ - PKT_TX_OUTER_IP_CKSUM | \ - PKT_TX_VLAN_PKT | \ - PKT_TX_IPV6 | \ - PKT_TX_IPV4 | \ - PKT_TX_IP_CKSUM | \ - PKT_TX_L4_MASK | \ - PKT_TX_IEEE1588_TMST | \ - PKT_TX_TCP_SEG | \ - PKT_TX_QINQ_PKT | \ - PKT_TX_TUNNEL_MASK | \ - PKT_TX_MACSEC | \ - PKT_TX_SEC_OFFLOAD | \ - PKT_TX_UDP_SEG | \ - PKT_TX_OUTER_UDP_CKSUM | \ - PKT_TX_METADATA) - -/** - * Mbuf having an external buffer attached. shinfo in mbuf must be filled. - */ -#define EXT_ATTACHED_MBUF (1ULL << 61) - -#define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */ - -/** Alignment constraint of mbuf private area. */ -#define RTE_MBUF_PRIV_ALIGN 8 - /** * Get the name of a RX offload flag * @@ -453,310 +98,6 @@ const char *rte_get_tx_ol_flag_name(uint64_t mask); */ int rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen); -/** - * Some NICs need at least 2KB buffer to RX standard Ethernet frame without - * splitting it into multiple segments. - * So, for mbufs that planned to be involved into RX/TX, the recommended - * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM. - */ -#define RTE_MBUF_DEFAULT_DATAROOM 2048 -#define RTE_MBUF_DEFAULT_BUF_SIZE \ - (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM) - -/* define a set of marker types that can be used to refer to set points in the - * mbuf */ -__extension__ -typedef void *MARKER[0]; /**< generic marker for a point in a structure */ -__extension__ -typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */ -__extension__ -typedef uint64_t MARKER64[0]; /**< marker that allows us to overwrite 8 bytes - * with a single assignment */ - -struct rte_mbuf_sched { - uint32_t queue_id; /**< Queue ID. */ - uint8_t traffic_class; - /**< Traffic class ID. Traffic class 0 - * is the highest priority traffic class. - */ - uint8_t color; - /**< Color. @see enum rte_color.*/ - uint16_t reserved; /**< Reserved. */ -}; /**< Hierarchical scheduler */ - -/** - * enum for the tx_offload bit-fields lengths and offsets. - * defines the layout of rte_mbuf tx_offload field. - */ -enum { - RTE_MBUF_L2_LEN_BITS = 7, - RTE_MBUF_L3_LEN_BITS = 9, - RTE_MBUF_L4_LEN_BITS = 8, - RTE_MBUF_TSO_SEGSZ_BITS = 16, - RTE_MBUF_OUTL3_LEN_BITS = 9, - RTE_MBUF_OUTL2_LEN_BITS = 7, - RTE_MBUF_TXOFLD_UNUSED_BITS = sizeof(uint64_t) * CHAR_BIT - - RTE_MBUF_L2_LEN_BITS - - RTE_MBUF_L3_LEN_BITS - - RTE_MBUF_L4_LEN_BITS - - RTE_MBUF_TSO_SEGSZ_BITS - - RTE_MBUF_OUTL3_LEN_BITS - - RTE_MBUF_OUTL2_LEN_BITS, -#if RTE_BYTE_ORDER == RTE_BIG_ENDIAN - RTE_MBUF_L2_LEN_OFS = - sizeof(uint64_t) * CHAR_BIT - RTE_MBUF_L2_LEN_BITS, - RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS - RTE_MBUF_L3_LEN_BITS, - RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS - RTE_MBUF_L4_LEN_BITS, - RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS - RTE_MBUF_TSO_SEGSZ_BITS, - RTE_MBUF_OUTL3_LEN_OFS = - RTE_MBUF_TSO_SEGSZ_OFS - RTE_MBUF_OUTL3_LEN_BITS, - RTE_MBUF_OUTL2_LEN_OFS = - RTE_MBUF_OUTL3_LEN_OFS - RTE_MBUF_OUTL2_LEN_BITS, - RTE_MBUF_TXOFLD_UNUSED_OFS = - RTE_MBUF_OUTL2_LEN_OFS - RTE_MBUF_TXOFLD_UNUSED_BITS, -#else - RTE_MBUF_L2_LEN_OFS = 0, - RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS + RTE_MBUF_L2_LEN_BITS, - RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS + RTE_MBUF_L3_LEN_BITS, - RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS + RTE_MBUF_L4_LEN_BITS, - RTE_MBUF_OUTL3_LEN_OFS = - RTE_MBUF_TSO_SEGSZ_OFS + RTE_MBUF_TSO_SEGSZ_BITS, - RTE_MBUF_OUTL2_LEN_OFS = - RTE_MBUF_OUTL3_LEN_OFS + RTE_MBUF_OUTL3_LEN_BITS, - RTE_MBUF_TXOFLD_UNUSED_OFS = - RTE_MBUF_OUTL2_LEN_OFS + RTE_MBUF_OUTL2_LEN_BITS, -#endif -}; - -/** - * The generic rte_mbuf, containing a packet mbuf. - */ -struct rte_mbuf { - MARKER cacheline0; - - void *buf_addr; /**< Virtual address of segment buffer. */ - /** - * Physical address of segment buffer. - * Force alignment to 8-bytes, so as to ensure we have the exact - * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes - * working on vector drivers easier. - */ - RTE_STD_C11 - union { - rte_iova_t buf_iova; - rte_iova_t buf_physaddr; /**< deprecated */ - } __rte_aligned(sizeof(rte_iova_t)); - - /* next 8 bytes are initialised on RX descriptor rearm */ - MARKER64 rearm_data; - uint16_t data_off; - - /** - * Reference counter. Its size should at least equal to the size - * of port field (16 bits), to support zero-copy broadcast. - * It should only be accessed using the following functions: - * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and - * rte_mbuf_refcnt_set(). The functionality of these functions (atomic, - * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC - * config option. - */ - RTE_STD_C11 - union { - rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */ - uint16_t refcnt; /**< Non-atomically accessed refcnt */ - }; - uint16_t nb_segs; /**< Number of segments. */ - - /** Input port (16 bits to support more than 256 virtual ports). - * The event eth Tx adapter uses this field to specify the output port. - */ - uint16_t port; - - uint64_t ol_flags; /**< Offload features. */ - - /* remaining bytes are set on RX when pulling packet from descriptor */ - MARKER rx_descriptor_fields1; - - /* - * The packet type, which is the combination of outer/inner L2, L3, L4 - * and tunnel types. The packet_type is about data really present in the - * mbuf. Example: if vlan stripping is enabled, a received vlan packet - * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the - * vlan is stripped from the data. - */ - RTE_STD_C11 - union { - uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */ - struct { - uint32_t l2_type:4; /**< (Outer) L2 type. */ - uint32_t l3_type:4; /**< (Outer) L3 type. */ - uint32_t l4_type:4; /**< (Outer) L4 type. */ - uint32_t tun_type:4; /**< Tunnel type. */ - RTE_STD_C11 - union { - uint8_t inner_esp_next_proto; - /**< ESP next protocol type, valid if - * RTE_PTYPE_TUNNEL_ESP tunnel type is set - * on both Tx and Rx. - */ - __extension__ - struct { - uint8_t inner_l2_type:4; - /**< Inner L2 type. */ - uint8_t inner_l3_type:4; - /**< Inner L3 type. */ - }; - }; - uint32_t inner_l4_type:4; /**< Inner L4 type. */ - }; - }; - - uint32_t pkt_len; /**< Total pkt len: sum of all segments. */ - uint16_t data_len; /**< Amount of data in segment buffer. */ - /** VLAN TCI (CPU order), valid if PKT_RX_VLAN is set. */ - uint16_t vlan_tci; - - RTE_STD_C11 - union { - union { - uint32_t rss; /**< RSS hash result if RSS enabled */ - struct { - union { - struct { - uint16_t hash; - uint16_t id; - }; - uint32_t lo; - /**< Second 4 flexible bytes */ - }; - uint32_t hi; - /**< First 4 flexible bytes or FD ID, dependent - * on PKT_RX_FDIR_* flag in ol_flags. - */ - } fdir; /**< Filter identifier if FDIR enabled */ - struct rte_mbuf_sched sched; - /**< Hierarchical scheduler : 8 bytes */ - struct { - uint32_t reserved1; - uint16_t reserved2; - uint16_t txq; - /**< The event eth Tx adapter uses this field - * to store Tx queue id. - * @see rte_event_eth_tx_adapter_txq_set() - */ - } txadapter; /**< Eventdev ethdev Tx adapter */ - /**< User defined tags. See rte_distributor_process() */ - uint32_t usr; - } hash; /**< hash information */ - struct { - /** - * Application specific metadata value - * for egress flow rule match. - * Valid if PKT_TX_METADATA is set. - * Located here to allow conjunct use - * with hash.sched.hi. - */ - uint32_t tx_metadata; - uint32_t reserved; - }; - }; - - /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ is set. */ - uint16_t vlan_tci_outer; - - uint16_t buf_len; /**< Length of segment buffer. */ - - /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference - * are not normalized but are always the same for a given port. - * Some devices allow to query rte_eth_read_clock that will return the - * current device timestamp. - */ - uint64_t timestamp; - - /* second cache line - fields only used in slow path or on TX */ - MARKER cacheline1 __rte_cache_min_aligned; - - RTE_STD_C11 - union { - void *userdata; /**< Can be used for external metadata */ - uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */ - }; - - struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */ - struct rte_mbuf *next; /**< Next segment of scattered packet. */ - - /* fields to support TX offloads */ - RTE_STD_C11 - union { - uint64_t tx_offload; /**< combined for easy fetch */ - __extension__ - struct { - uint64_t l2_len:RTE_MBUF_L2_LEN_BITS; - /**< L2 (MAC) Header Length for non-tunneling pkt. - * Outer_L4_len + ... + Inner_L2_len for tunneling pkt. - */ - uint64_t l3_len:RTE_MBUF_L3_LEN_BITS; - /**< L3 (IP) Header Length. */ - uint64_t l4_len:RTE_MBUF_L4_LEN_BITS; - /**< L4 (TCP/UDP) Header Length. */ - uint64_t tso_segsz:RTE_MBUF_TSO_SEGSZ_BITS; - /**< TCP TSO segment size */ - - /* - * Fields for Tx offloading of tunnels. - * These are undefined for packets which don't request - * any tunnel offloads (outer IP or UDP checksum, - * tunnel TSO). - * - * PMDs should not use these fields unconditionally - * when calculating offsets. - * - * Applications are expected to set appropriate tunnel - * offload flags when they fill in these fields. - */ - uint64_t outer_l3_len:RTE_MBUF_OUTL3_LEN_BITS; - /**< Outer L3 (IP) Hdr Length. */ - uint64_t outer_l2_len:RTE_MBUF_OUTL2_LEN_BITS; - /**< Outer L2 (MAC) Hdr Length. */ - - /* uint64_t unused:RTE_MBUF_TXOFLD_UNUSED_BITS; */ - }; - }; - - /** Size of the application private data. In case of an indirect - * mbuf, it stores the direct mbuf private data size. */ - uint16_t priv_size; - - /** Timesync flags for use with IEEE1588. */ - uint16_t timesync; - - /** Sequence number. See also rte_reorder_insert(). */ - uint32_t seqn; - - /** Shared data for external buffer attached to mbuf. See - * rte_pktmbuf_attach_extbuf(). - */ - struct rte_mbuf_ext_shared_info *shinfo; - -} __rte_cache_aligned; - -/** - * Function typedef of callback to free externally attached buffer. - */ -typedef void (*rte_mbuf_extbuf_free_callback_t)(void *addr, void *opaque); - -/** - * Shared data at the end of an external buffer. - */ -struct rte_mbuf_ext_shared_info { - rte_mbuf_extbuf_free_callback_t free_cb; /**< Free callback function */ - void *fcb_opaque; /**< Free callback argument */ - rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */ -}; - -/**< Maximum number of nb_segs allowed. */ -#define RTE_MBUF_MAX_NB_SEGS UINT16_MAX - /** * Prefetch the first part of the mbuf * @@ -953,31 +294,6 @@ rte_mbuf_to_priv(struct rte_mbuf *m) return RTE_PTR_ADD(m, sizeof(struct rte_mbuf)); } -/** - * Returns TRUE if given mbuf is cloned by mbuf indirection, or FALSE - * otherwise. - * - * If a mbuf has its data in another mbuf and references it by mbuf - * indirection, this mbuf can be defined as a cloned mbuf. - */ -#define RTE_MBUF_CLONED(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF) - -/** - * Returns TRUE if given mbuf has an external buffer, or FALSE otherwise. - * - * External buffer is a user-provided anonymous buffer. - */ -#define RTE_MBUF_HAS_EXTBUF(mb) ((mb)->ol_flags & EXT_ATTACHED_MBUF) - -/** - * Returns TRUE if given mbuf is direct, or FALSE otherwise. - * - * If a mbuf embeds its own data after the rte_mbuf structure, this mbuf - * can be defined as a direct mbuf. - */ -#define RTE_MBUF_DIRECT(mb) \ - (!((mb)->ol_flags & (IND_ATTACHED_MBUF | EXT_ATTACHED_MBUF))) - /** * Private data in case of pktmbuf pool. * @@ -2026,62 +1342,10 @@ static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m) return m; } -/** - * A macro that points to an offset into the data in the mbuf. - * - * The returned pointer is cast to type t. Before using this - * function, the user must ensure that the first segment is large - * enough to accommodate its data. - * - * @param m - * The packet mbuf. - * @param o - * The offset into the mbuf data. - * @param t - * The type to cast the result into. - */ -#define rte_pktmbuf_mtod_offset(m, t, o) \ - ((t)((char *)(m)->buf_addr + (m)->data_off + (o))) - -/** - * A macro that points to the start of the data in the mbuf. - * - * The returned pointer is cast to type t. Before using this - * function, the user must ensure that the first segment is large - * enough to accommodate its data. - * - * @param m - * The packet mbuf. - * @param t - * The type to cast the result into. - */ -#define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0) - -/** - * A macro that returns the IO address that points to an offset of the - * start of the data in the mbuf - * - * @param m - * The packet mbuf. - * @param o - * The offset into the data to calculate address from. - */ -#define rte_pktmbuf_iova_offset(m, o) \ - (rte_iova_t)((m)->buf_iova + (m)->data_off + (o)) - /* deprecated */ #define rte_pktmbuf_mtophys_offset(m, o) \ rte_pktmbuf_iova_offset(m, o) -/** - * A macro that returns the IO address that points to the start of the - * data in the mbuf - * - * @param m - * The packet mbuf. - */ -#define rte_pktmbuf_iova(m) rte_pktmbuf_iova_offset(m, 0) - /* deprecated */ #define rte_pktmbuf_mtophys(m) rte_pktmbuf_iova(m) diff --git a/lib/librte_mbuf/rte_mbuf_core.h b/lib/librte_mbuf/rte_mbuf_core.h new file mode 100644 index 000000000..8fc987eee --- /dev/null +++ b/lib/librte_mbuf/rte_mbuf_core.h @@ -0,0 +1,793 @@ +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright(c) 2010-2014 Intel Corporation. + * Copyright 2014 6WIND S.A. + */ + +#ifndef _RTE_MBUF_CORE_H_ +#define _RTE_MBUF_CORE_H_ + +/** + * @file + * This file contains definion of RTE mbuf structure itself, + * packet offload flags and some related macros. + * For majority of DPDK entities, it is not recommended to include + * this file directly, use include <rte_mbuf.h> instead. + */ + +#include <stdint.h> +#include <rte_compat.h> +#include <generic/rte_atomic.h> + +#ifdef __cplusplus +extern "C" { +#endif + +/* + * Packet Offload Features Flags. It also carry packet type information. + * Critical resources. Both rx/tx shared these bits. Be cautious on any change + * + * - RX flags start at bit position zero, and get added to the left of previous + * flags. + * - The most-significant 3 bits are reserved for generic mbuf flags + * - TX flags therefore start at bit position 60 (i.e. 63-3), and new flags get + * added to the right of the previously defined flags i.e. they should count + * downwards, not upwards. + * + * Keep these flags synchronized with rte_get_rx_ol_flag_name() and + * rte_get_tx_ol_flag_name(). + */ + +/** + * The RX packet is a 802.1q VLAN packet, and the tci has been + * saved in in mbuf->vlan_tci. + * If the flag PKT_RX_VLAN_STRIPPED is also present, the VLAN + * header has been stripped from mbuf data, else it is still + * present. + */ +#define PKT_RX_VLAN (1ULL << 0) + +/** RX packet with RSS hash result. */ +#define PKT_RX_RSS_HASH (1ULL << 1) + + /** RX packet with FDIR match indicate. */ +#define PKT_RX_FDIR (1ULL << 2) + +/** + * Deprecated. + * Checking this flag alone is deprecated: check the 2 bits of + * PKT_RX_L4_CKSUM_MASK. + * This flag was set when the L4 checksum of a packet was detected as + * wrong by the hardware. + */ +#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) + +/** + * Deprecated. + * Checking this flag alone is deprecated: check the 2 bits of + * PKT_RX_IP_CKSUM_MASK. + * This flag was set when the IP checksum of a packet was detected as + * wrong by the hardware. + */ +#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) + + /** External IP header checksum error. */ +#define PKT_RX_EIP_CKSUM_BAD (1ULL << 5) + +/** + * A vlan has been stripped by the hardware and its tci is saved in + * mbuf->vlan_tci. This can only happen if vlan stripping is enabled + * in the RX configuration of the PMD. + * When PKT_RX_VLAN_STRIPPED is set, PKT_RX_VLAN must also be set. + */ +#define PKT_RX_VLAN_STRIPPED (1ULL << 6) + +/** + * Mask of bits used to determine the status of RX IP checksum. + * - PKT_RX_IP_CKSUM_UNKNOWN: no information about the RX IP checksum + * - PKT_RX_IP_CKSUM_BAD: the IP checksum in the packet is wrong + * - PKT_RX_IP_CKSUM_GOOD: the IP checksum in the packet is valid + * - PKT_RX_IP_CKSUM_NONE: the IP checksum is not correct in the packet + * data, but the integrity of the IP header is verified. + */ +#define PKT_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7)) + +#define PKT_RX_IP_CKSUM_UNKNOWN 0 +#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) +#define PKT_RX_IP_CKSUM_GOOD (1ULL << 7) +#define PKT_RX_IP_CKSUM_NONE ((1ULL << 4) | (1ULL << 7)) + +/** + * Mask of bits used to determine the status of RX L4 checksum. + * - PKT_RX_L4_CKSUM_UNKNOWN: no information about the RX L4 checksum + * - PKT_RX_L4_CKSUM_BAD: the L4 checksum in the packet is wrong + * - PKT_RX_L4_CKSUM_GOOD: the L4 checksum in the packet is valid + * - PKT_RX_L4_CKSUM_NONE: the L4 checksum is not correct in the packet + * data, but the integrity of the L4 data is verified. + */ +#define PKT_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8)) + +#define PKT_RX_L4_CKSUM_UNKNOWN 0 +#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) +#define PKT_RX_L4_CKSUM_GOOD (1ULL << 8) +#define PKT_RX_L4_CKSUM_NONE ((1ULL << 3) | (1ULL << 8)) + +/** RX IEEE1588 L2 Ethernet PT Packet. */ +#define PKT_RX_IEEE1588_PTP (1ULL << 9) + +/** RX IEEE1588 L2/L4 timestamped packet.*/ +#define PKT_RX_IEEE1588_TMST (1ULL << 10) + +/** FD id reported if FDIR match. */ +#define PKT_RX_FDIR_ID (1ULL << 13) + +/** Flexible bytes reported if FDIR match. */ +#define PKT_RX_FDIR_FLX (1ULL << 14) + +/** + * The 2 vlans have been stripped by the hardware and their tci are + * saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer). + * This can only happen if vlan stripping is enabled in the RX + * configuration of the PMD. + * When PKT_RX_QINQ_STRIPPED is set, the flags (PKT_RX_VLAN | + * PKT_RX_VLAN_STRIPPED | PKT_RX_QINQ) must also be set. + */ +#define PKT_RX_QINQ_STRIPPED (1ULL << 15) + +/** + * When packets are coalesced by a hardware or virtual driver, this flag + * can be set in the RX mbuf, meaning that the m->tso_segsz field is + * valid and is set to the segment size of original packets. + */ +#define PKT_RX_LRO (1ULL << 16) + +/** + * Indicate that the timestamp field in the mbuf is valid. + */ +#define PKT_RX_TIMESTAMP (1ULL << 17) + +/** + * Indicate that security offload processing was applied on the RX packet. + */ +#define PKT_RX_SEC_OFFLOAD (1ULL << 18) + +/** + * Indicate that security offload processing failed on the RX packet. + */ +#define PKT_RX_SEC_OFFLOAD_FAILED (1ULL << 19) + +/** + * The RX packet is a double VLAN, and the outer tci has been + * saved in in mbuf->vlan_tci_outer. If PKT_RX_QINQ set, PKT_RX_VLAN + * also should be set and inner tci should be saved to mbuf->vlan_tci. + * If the flag PKT_RX_QINQ_STRIPPED is also present, both VLANs + * headers have been stripped from mbuf data, else they are still + * present. + */ +#define PKT_RX_QINQ (1ULL << 20) + +/** + * Mask of bits used to determine the status of outer RX L4 checksum. + * - PKT_RX_OUTER_L4_CKSUM_UNKNOWN: no info about the outer RX L4 checksum + * - PKT_RX_OUTER_L4_CKSUM_BAD: the outer L4 checksum in the packet is wrong + * - PKT_RX_OUTER_L4_CKSUM_GOOD: the outer L4 checksum in the packet is valid + * - PKT_RX_OUTER_L4_CKSUM_INVALID: invalid outer L4 checksum state. + * + * The detection of PKT_RX_OUTER_L4_CKSUM_GOOD shall be based on the given + * HW capability, At minimum, the PMD should support + * PKT_RX_OUTER_L4_CKSUM_UNKNOWN and PKT_RX_OUTER_L4_CKSUM_BAD states + * if the DEV_RX_OFFLOAD_OUTER_UDP_CKSUM offload is available. + */ +#define PKT_RX_OUTER_L4_CKSUM_MASK ((1ULL << 21) | (1ULL << 22)) + +#define PKT_RX_OUTER_L4_CKSUM_UNKNOWN 0 +#define PKT_RX_OUTER_L4_CKSUM_BAD (1ULL << 21) +#define PKT_RX_OUTER_L4_CKSUM_GOOD (1ULL << 22) +#define PKT_RX_OUTER_L4_CKSUM_INVALID ((1ULL << 21) | (1ULL << 22)) + +/* add new RX flags here */ + +/* add new TX flags here */ + +/** + * Indicate that the metadata field in the mbuf is in use. + */ +#define PKT_TX_METADATA (1ULL << 40) + +/** + * Outer UDP checksum offload flag. This flag is used for enabling + * outer UDP checksum in PMD. To use outer UDP checksum, the user needs to + * 1) Enable the following in mbuf, + * a) Fill outer_l2_len and outer_l3_len in mbuf. + * b) Set the PKT_TX_OUTER_UDP_CKSUM flag. + * c) Set the PKT_TX_OUTER_IPV4 or PKT_TX_OUTER_IPV6 flag. + * 2) Configure DEV_TX_OFFLOAD_OUTER_UDP_CKSUM offload flag. + */ +#define PKT_TX_OUTER_UDP_CKSUM (1ULL << 41) + +/** + * UDP Fragmentation Offload flag. This flag is used for enabling UDP + * fragmentation in SW or in HW. When use UFO, mbuf->tso_segsz is used + * to store the MSS of UDP fragments. + */ +#define PKT_TX_UDP_SEG (1ULL << 42) + +/** + * Request security offload processing on the TX packet. + */ +#define PKT_TX_SEC_OFFLOAD (1ULL << 43) + +/** + * Offload the MACsec. This flag must be set by the application to enable + * this offload feature for a packet to be transmitted. + */ +#define PKT_TX_MACSEC (1ULL << 44) + +/** + * Bits 45:48 used for the tunnel type. + * The tunnel type must be specified for TSO or checksum on the inner part + * of tunnel packets. + * These flags can be used with PKT_TX_TCP_SEG for TSO, or PKT_TX_xxx_CKSUM. + * The mbuf fields for inner and outer header lengths are required: + * outer_l2_len, outer_l3_len, l2_len, l3_len, l4_len and tso_segsz for TSO. + */ +#define PKT_TX_TUNNEL_VXLAN (0x1ULL << 45) +#define PKT_TX_TUNNEL_GRE (0x2ULL << 45) +#define PKT_TX_TUNNEL_IPIP (0x3ULL << 45) +#define PKT_TX_TUNNEL_GENEVE (0x4ULL << 45) +/** TX packet with MPLS-in-UDP RFC 7510 header. */ +#define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45) +#define PKT_TX_TUNNEL_VXLAN_GPE (0x6ULL << 45) +/** + * Generic IP encapsulated tunnel type, used for TSO and checksum offload. + * It can be used for tunnels which are not standards or listed above. + * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_GRE + * or PKT_TX_TUNNEL_IPIP if possible. + * The ethdev must be configured with DEV_TX_OFFLOAD_IP_TNL_TSO. + * Outer and inner checksums are done according to the existing flags like + * PKT_TX_xxx_CKSUM. + * Specific tunnel headers that contain payload length, sequence id + * or checksum are not expected to be updated. + */ +#define PKT_TX_TUNNEL_IP (0xDULL << 45) +/** + * Generic UDP encapsulated tunnel type, used for TSO and checksum offload. + * UDP tunnel type implies outer IP layer. + * It can be used for tunnels which are not standards or listed above. + * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_VXLAN + * if possible. + * The ethdev must be configured with DEV_TX_OFFLOAD_UDP_TNL_TSO. + * Outer and inner checksums are done according to the existing flags like + * PKT_TX_xxx_CKSUM. + * Specific tunnel headers that contain payload length, sequence id + * or checksum are not expected to be updated. + */ +#define PKT_TX_TUNNEL_UDP (0xEULL << 45) +/* add new TX TUNNEL type here */ +#define PKT_TX_TUNNEL_MASK (0xFULL << 45) + +/** + * Double VLAN insertion (QinQ) request to driver, driver may offload the + * insertion based on device capability. + * mbuf 'vlan_tci' & 'vlan_tci_outer' must be valid when this flag is set. + */ +#define PKT_TX_QINQ (1ULL << 49) +/* this old name is deprecated */ +#define PKT_TX_QINQ_PKT PKT_TX_QINQ + +/** + * TCP segmentation offload. To enable this offload feature for a + * packet to be transmitted on hardware supporting TSO: + * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies + * PKT_TX_TCP_CKSUM) + * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 + * - if it's IPv4, set the PKT_TX_IP_CKSUM flag + * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz + */ +#define PKT_TX_TCP_SEG (1ULL << 50) + +/** TX IEEE1588 packet to timestamp. */ +#define PKT_TX_IEEE1588_TMST (1ULL << 51) + +/** + * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved, + * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware + * L4 checksum offload, the user needs to: + * - fill l2_len and l3_len in mbuf + * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM + * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 + */ +#define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */ + +/** TCP cksum of TX pkt. computed by NIC. */ +#define PKT_TX_TCP_CKSUM (1ULL << 52) + +/** SCTP cksum of TX pkt. computed by NIC. */ +#define PKT_TX_SCTP_CKSUM (2ULL << 52) + +/** UDP cksum of TX pkt. computed by NIC. */ +#define PKT_TX_UDP_CKSUM (3ULL << 52) + +/** Mask for L4 cksum offload request. */ +#define PKT_TX_L4_MASK (3ULL << 52) + +/** + * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should + * also be set by the application, although a PMD will only check + * PKT_TX_IP_CKSUM. + * - fill the mbuf offload information: l2_len, l3_len + */ +#define PKT_TX_IP_CKSUM (1ULL << 54) + +/** + * Packet is IPv4. This flag must be set when using any offload feature + * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4 + * packet. If the packet is a tunneled packet, this flag is related to + * the inner headers. + */ +#define PKT_TX_IPV4 (1ULL << 55) + +/** + * Packet is IPv6. This flag must be set when using an offload feature + * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6 + * packet. If the packet is a tunneled packet, this flag is related to + * the inner headers. + */ +#define PKT_TX_IPV6 (1ULL << 56) + +/** + * VLAN tag insertion request to driver, driver may offload the insertion + * based on the device capability. + * mbuf 'vlan_tci' field must be valid when this flag is set. + */ +#define PKT_TX_VLAN (1ULL << 57) +/* this old name is deprecated */ +#define PKT_TX_VLAN_PKT PKT_TX_VLAN + +/** + * Offload the IP checksum of an external header in the hardware. The + * flag PKT_TX_OUTER_IPV4 should also be set by the application, although + * a PMD will only check PKT_TX_OUTER_IP_CKSUM. + * - fill the mbuf offload information: outer_l2_len, outer_l3_len + */ +#define PKT_TX_OUTER_IP_CKSUM (1ULL << 58) + +/** + * Packet outer header is IPv4. This flag must be set when using any + * outer offload feature (L3 or L4 checksum) to tell the NIC that the + * outer header of the tunneled packet is an IPv4 packet. + */ +#define PKT_TX_OUTER_IPV4 (1ULL << 59) + +/** + * Packet outer header is IPv6. This flag must be set when using any + * outer offload feature (L4 checksum) to tell the NIC that the outer + * header of the tunneled packet is an IPv6 packet. + */ +#define PKT_TX_OUTER_IPV6 (1ULL << 60) + +/** + * Bitmask of all supported packet Tx offload features flags, + * which can be set for packet. + */ +#define PKT_TX_OFFLOAD_MASK ( \ + PKT_TX_OUTER_IPV6 | \ + PKT_TX_OUTER_IPV4 | \ + PKT_TX_OUTER_IP_CKSUM | \ + PKT_TX_VLAN_PKT | \ + PKT_TX_IPV6 | \ + PKT_TX_IPV4 | \ + PKT_TX_IP_CKSUM | \ + PKT_TX_L4_MASK | \ + PKT_TX_IEEE1588_TMST | \ + PKT_TX_TCP_SEG | \ + PKT_TX_QINQ_PKT | \ + PKT_TX_TUNNEL_MASK | \ + PKT_TX_MACSEC | \ + PKT_TX_SEC_OFFLOAD | \ + PKT_TX_UDP_SEG | \ + PKT_TX_OUTER_UDP_CKSUM | \ + PKT_TX_METADATA) + +/** + * Mbuf having an external buffer attached. shinfo in mbuf must be filled. + */ +#define EXT_ATTACHED_MBUF (1ULL << 61) + +#define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */ + +/** Alignment constraint of mbuf private area. */ +#define RTE_MBUF_PRIV_ALIGN 8 + +/** + * Some NICs need at least 2KB buffer to RX standard Ethernet frame without + * splitting it into multiple segments. + * So, for mbufs that planned to be involved into RX/TX, the recommended + * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM. + */ +#define RTE_MBUF_DEFAULT_DATAROOM 2048 +#define RTE_MBUF_DEFAULT_BUF_SIZE \ + (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM) + +/* + * define a set of marker types that can be used to refer to set points in the + * mbuf. + */ +__extension__ +typedef void *MARKER[0]; /**< generic marker for a point in a structure */ +__extension__ +typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */ + + /** marker that allows us to overwrite 8 bytes with a single assignment */ +__extension__ +typedef uint64_t MARKER64[0]; + +struct rte_mbuf_sched { + uint32_t queue_id; /**< Queue ID. */ + uint8_t traffic_class; + /**< Traffic class ID. Traffic class 0 + * is the highest priority traffic class. + */ + uint8_t color; + /**< Color. @see enum rte_color.*/ + uint16_t reserved; /**< Reserved. */ +}; /**< Hierarchical scheduler */ + +/** + * enum for the tx_offload bit-fields lengths and offsets. + * defines the layout of rte_mbuf tx_offload field. + */ +enum { + RTE_MBUF_L2_LEN_BITS = 7, + RTE_MBUF_L3_LEN_BITS = 9, + RTE_MBUF_L4_LEN_BITS = 8, + RTE_MBUF_TSO_SEGSZ_BITS = 16, + RTE_MBUF_OUTL3_LEN_BITS = 9, + RTE_MBUF_OUTL2_LEN_BITS = 7, + RTE_MBUF_TXOFLD_UNUSED_BITS = sizeof(uint64_t) * CHAR_BIT - + RTE_MBUF_L2_LEN_BITS - + RTE_MBUF_L3_LEN_BITS - + RTE_MBUF_L4_LEN_BITS - + RTE_MBUF_TSO_SEGSZ_BITS - + RTE_MBUF_OUTL3_LEN_BITS - + RTE_MBUF_OUTL2_LEN_BITS, +#if RTE_BYTE_ORDER == RTE_BIG_ENDIAN + RTE_MBUF_L2_LEN_OFS = + sizeof(uint64_t) * CHAR_BIT - RTE_MBUF_L2_LEN_BITS, + RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS - RTE_MBUF_L3_LEN_BITS, + RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS - RTE_MBUF_L4_LEN_BITS, + RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS - RTE_MBUF_TSO_SEGSZ_BITS, + RTE_MBUF_OUTL3_LEN_OFS = + RTE_MBUF_TSO_SEGSZ_OFS - RTE_MBUF_OUTL3_LEN_BITS, + RTE_MBUF_OUTL2_LEN_OFS = + RTE_MBUF_OUTL3_LEN_OFS - RTE_MBUF_OUTL2_LEN_BITS, + RTE_MBUF_TXOFLD_UNUSED_OFS = + RTE_MBUF_OUTL2_LEN_OFS - RTE_MBUF_TXOFLD_UNUSED_BITS, +#else + RTE_MBUF_L2_LEN_OFS = 0, + RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS + RTE_MBUF_L2_LEN_BITS, + RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS + RTE_MBUF_L3_LEN_BITS, + RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS + RTE_MBUF_L4_LEN_BITS, + RTE_MBUF_OUTL3_LEN_OFS = + RTE_MBUF_TSO_SEGSZ_OFS + RTE_MBUF_TSO_SEGSZ_BITS, + RTE_MBUF_OUTL2_LEN_OFS = + RTE_MBUF_OUTL3_LEN_OFS + RTE_MBUF_OUTL3_LEN_BITS, + RTE_MBUF_TXOFLD_UNUSED_OFS = + RTE_MBUF_OUTL2_LEN_OFS + RTE_MBUF_OUTL2_LEN_BITS, +#endif +}; + +/** + * The generic rte_mbuf, containing a packet mbuf. + */ +struct rte_mbuf { + MARKER cacheline0; + + void *buf_addr; /**< Virtual address of segment buffer. */ + /** + * Physical address of segment buffer. + * Force alignment to 8-bytes, so as to ensure we have the exact + * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes + * working on vector drivers easier. + */ + RTE_STD_C11 + union { + rte_iova_t buf_iova; + rte_iova_t buf_physaddr; /**< deprecated */ + } __rte_aligned(sizeof(rte_iova_t)); + + /* next 8 bytes are initialised on RX descriptor rearm */ + MARKER64 rearm_data; + uint16_t data_off; + + /** + * Reference counter. Its size should at least equal to the size + * of port field (16 bits), to support zero-copy broadcast. + * It should only be accessed using the following functions: + * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and + * rte_mbuf_refcnt_set(). The functionality of these functions (atomic, + * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC + * config option. + */ + RTE_STD_C11 + union { + rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */ + /** Non-atomically accessed refcnt */ + uint16_t refcnt; + }; + uint16_t nb_segs; /**< Number of segments. */ + + /** Input port (16 bits to support more than 256 virtual ports). + * The event eth Tx adapter uses this field to specify the output port. + */ + uint16_t port; + + uint64_t ol_flags; /**< Offload features. */ + + /* remaining bytes are set on RX when pulling packet from descriptor */ + MARKER rx_descriptor_fields1; + + /* + * The packet type, which is the combination of outer/inner L2, L3, L4 + * and tunnel types. The packet_type is about data really present in the + * mbuf. Example: if vlan stripping is enabled, a received vlan packet + * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the + * vlan is stripped from the data. + */ + RTE_STD_C11 + union { + uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */ + struct { + uint32_t l2_type:4; /**< (Outer) L2 type. */ + uint32_t l3_type:4; /**< (Outer) L3 type. */ + uint32_t l4_type:4; /**< (Outer) L4 type. */ + uint32_t tun_type:4; /**< Tunnel type. */ + RTE_STD_C11 + union { + uint8_t inner_esp_next_proto; + /**< ESP next protocol type, valid if + * RTE_PTYPE_TUNNEL_ESP tunnel type is set + * on both Tx and Rx. + */ + __extension__ + struct { + uint8_t inner_l2_type:4; + /**< Inner L2 type. */ + uint8_t inner_l3_type:4; + /**< Inner L3 type. */ + }; + }; + uint32_t inner_l4_type:4; /**< Inner L4 type. */ + }; + }; + + uint32_t pkt_len; /**< Total pkt len: sum of all segments. */ + uint16_t data_len; /**< Amount of data in segment buffer. */ + /** VLAN TCI (CPU order), valid if PKT_RX_VLAN is set. */ + uint16_t vlan_tci; + + RTE_STD_C11 + union { + union { + uint32_t rss; /**< RSS hash result if RSS enabled */ + struct { + union { + struct { + uint16_t hash; + uint16_t id; + }; + uint32_t lo; + /**< Second 4 flexible bytes */ + }; + uint32_t hi; + /**< First 4 flexible bytes or FD ID, dependent + * on PKT_RX_FDIR_* flag in ol_flags. + */ + } fdir; /**< Filter identifier if FDIR enabled */ + struct rte_mbuf_sched sched; + /**< Hierarchical scheduler : 8 bytes */ + struct { + uint32_t reserved1; + uint16_t reserved2; + uint16_t txq; + /**< The event eth Tx adapter uses this field + * to store Tx queue id. + * @see rte_event_eth_tx_adapter_txq_set() + */ + } txadapter; /**< Eventdev ethdev Tx adapter */ + /**< User defined tags. See rte_distributor_process() */ + uint32_t usr; + } hash; /**< hash information */ + struct { + /** + * Application specific metadata value + * for egress flow rule match. + * Valid if PKT_TX_METADATA is set. + * Located here to allow conjunct use + * with hash.sched.hi. + */ + uint32_t tx_metadata; + uint32_t reserved; + }; + }; + + /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ is set. */ + uint16_t vlan_tci_outer; + + uint16_t buf_len; /**< Length of segment buffer. */ + + /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference + * are not normalized but are always the same for a given port. + * Some devices allow to query rte_eth_read_clock that will return the + * current device timestamp. + */ + uint64_t timestamp; + + /* second cache line - fields only used in slow path or on TX */ + MARKER cacheline1 __rte_cache_min_aligned; + + RTE_STD_C11 + union { + void *userdata; /**< Can be used for external metadata */ + uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */ + }; + + struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */ + struct rte_mbuf *next; /**< Next segment of scattered packet. */ + + /* fields to support TX offloads */ + RTE_STD_C11 + union { + uint64_t tx_offload; /**< combined for easy fetch */ + __extension__ + struct { + uint64_t l2_len:RTE_MBUF_L2_LEN_BITS; + /**< L2 (MAC) Header Length for non-tunneling pkt. + * Outer_L4_len + ... + Inner_L2_len for tunneling pkt. + */ + uint64_t l3_len:RTE_MBUF_L3_LEN_BITS; + /**< L3 (IP) Header Length. */ + uint64_t l4_len:RTE_MBUF_L4_LEN_BITS; + /**< L4 (TCP/UDP) Header Length. */ + uint64_t tso_segsz:RTE_MBUF_TSO_SEGSZ_BITS; + /**< TCP TSO segment size */ + + /* + * Fields for Tx offloading of tunnels. + * These are undefined for packets which don't request + * any tunnel offloads (outer IP or UDP checksum, + * tunnel TSO). + * + * PMDs should not use these fields unconditionally + * when calculating offsets. + * + * Applications are expected to set appropriate tunnel + * offload flags when they fill in these fields. + */ + uint64_t outer_l3_len:RTE_MBUF_OUTL3_LEN_BITS; + /**< Outer L3 (IP) Hdr Length. */ + uint64_t outer_l2_len:RTE_MBUF_OUTL2_LEN_BITS; + /**< Outer L2 (MAC) Hdr Length. */ + + /* uint64_t unused:RTE_MBUF_TXOFLD_UNUSED_BITS; */ + }; + }; + + /** Size of the application private data. In case of an indirect + * mbuf, it stores the direct mbuf private data size. + */ + uint16_t priv_size; + + /** Timesync flags for use with IEEE1588. */ + uint16_t timesync; + + /** Sequence number. See also rte_reorder_insert(). */ + uint32_t seqn; + + /** Shared data for external buffer attached to mbuf. See + * rte_pktmbuf_attach_extbuf(). + */ + struct rte_mbuf_ext_shared_info *shinfo; + +} __rte_cache_aligned; + +/** + * Function typedef of callback to free externally attached buffer. + */ +typedef void (*rte_mbuf_extbuf_free_callback_t)(void *addr, void *opaque); + +/** + * Shared data at the end of an external buffer. + */ +struct rte_mbuf_ext_shared_info { + rte_mbuf_extbuf_free_callback_t free_cb; /**< Free callback function */ + void *fcb_opaque; /**< Free callback argument */ + rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */ +}; + +/**< Maximum number of nb_segs allowed. */ +#define RTE_MBUF_MAX_NB_SEGS UINT16_MAX + +/** + * Returns TRUE if given mbuf is cloned by mbuf indirection, or FALSE + * otherwise. + * + * If a mbuf has its data in another mbuf and references it by mbuf + * indirection, this mbuf can be defined as a cloned mbuf. + */ +#define RTE_MBUF_CLONED(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF) + +/** + * Returns TRUE if given mbuf has an external buffer, or FALSE otherwise. + * + * External buffer is a user-provided anonymous buffer. + */ +#define RTE_MBUF_HAS_EXTBUF(mb) ((mb)->ol_flags & EXT_ATTACHED_MBUF) + +/** + * Returns TRUE if given mbuf is direct, or FALSE otherwise. + * + * If a mbuf embeds its own data after the rte_mbuf structure, this mbuf + * can be defined as a direct mbuf. + */ +#define RTE_MBUF_DIRECT(mb) \ + (!((mb)->ol_flags & (IND_ATTACHED_MBUF | EXT_ATTACHED_MBUF))) + +#define MBUF_INVALID_PORT UINT16_MAX + +/** + * A macro that points to an offset into the data in the mbuf. + * + * The returned pointer is cast to type t. Before using this + * function, the user must ensure that the first segment is large + * enough to accommodate its data. + * + * @param m + * The packet mbuf. + * @param o + * The offset into the mbuf data. + * @param t + * The type to cast the result into. + */ +#define rte_pktmbuf_mtod_offset(m, t, o) \ + ((t)((char *)(m)->buf_addr + (m)->data_off + (o))) + +/** + * A macro that points to the start of the data in the mbuf. + * + * The returned pointer is cast to type t. Before using this + * function, the user must ensure that the first segment is large + * enough to accommodate its data. + * + * @param m + * The packet mbuf. + * @param t + * The type to cast the result into. + */ +#define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0) + +/** + * A macro that returns the IO address that points to an offset of the + * start of the data in the mbuf + * + * @param m + * The packet mbuf. + * @param o + * The offset into the data to calculate address from. + */ +#define rte_pktmbuf_iova_offset(m, o) \ + (rte_iova_t)((m)->buf_iova + (m)->data_off + (o)) + +/** + * A macro that returns the IO address that points to the start of the + * data in the mbuf + * + * @param m + * The packet mbuf. + */ +#define rte_pktmbuf_iova(m) rte_pktmbuf_iova_offset(m, 0) + +#ifdef __cplusplus +} +#endif + +#endif /* _RTE_MBUF_CORE_H_ */ -- 2.17.1 ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [dpdk-dev] [PATCH v2 2/3] mbuf: move mbuf definition into a separate file 2019-09-27 13:50 ` [dpdk-dev] [PATCH v2 2/3] mbuf: move mbuf definition into a separate file Konstantin Ananyev @ 2019-09-27 14:42 ` Andrew Rybchenko 2019-09-30 19:34 ` Michel Machado 2019-10-16 8:18 ` Olivier Matz 2 siblings, 0 replies; 17+ messages in thread From: Andrew Rybchenko @ 2019-09-27 14:42 UTC (permalink / raw) To: Konstantin Ananyev, dev Cc: michel, olivier.matz, anatoly.burakov, vipin.varghese On 9/27/19 4:50 PM, Konstantin Ananyev wrote: > Right now inclusion of rte_mbuf.h header can cause inclusion of > some arch/os specific headers. > That prevents it to be included directly by some > non-DPDK (but related) entities: KNI, BPF programs, etc. > To overcome that problem usually a separate definitions of rte_mbuf > structure is created within these entities. > That aproach has a lot of drawbacks: code duplication, error prone, etc. > This patch moves rte_mbuf structure definition (and some related macros) > into a separate file that can be included by both rte_mbuf.h and > other non-DPDK entities. > > Note that it doesn't introduce any change for current DPDK code. > > Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com> Acked-by: Andrew Rybchenko <arybchenko@solarflare.com> ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [dpdk-dev] [PATCH v2 2/3] mbuf: move mbuf definition into a separate file 2019-09-27 13:50 ` [dpdk-dev] [PATCH v2 2/3] mbuf: move mbuf definition into a separate file Konstantin Ananyev 2019-09-27 14:42 ` Andrew Rybchenko @ 2019-09-30 19:34 ` Michel Machado 2019-10-16 8:18 ` Olivier Matz 2 siblings, 0 replies; 17+ messages in thread From: Michel Machado @ 2019-09-30 19:34 UTC (permalink / raw) To: Konstantin Ananyev, dev; +Cc: olivier.matz, anatoly.burakov, vipin.varghese Acked-by: Michel Machado <michel@digirati.com.br> [ ]'s Michel Machado On 9/27/19 9:50 AM, Konstantin Ananyev wrote: > Right now inclusion of rte_mbuf.h header can cause inclusion of > some arch/os specific headers. > That prevents it to be included directly by some > non-DPDK (but related) entities: KNI, BPF programs, etc. > To overcome that problem usually a separate definitions of rte_mbuf > structure is created within these entities. > That aproach has a lot of drawbacks: code duplication, error prone, etc. > This patch moves rte_mbuf structure definition (and some related macros) > into a separate file that can be included by both rte_mbuf.h and > other non-DPDK entities. > > Note that it doesn't introduce any change for current DPDK code. > > Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com> > --- > lib/librte_mbuf/Makefile | 5 +- > lib/librte_mbuf/meson.build | 3 +- > lib/librte_mbuf/rte_mbuf.h | 738 +---------------------------- > lib/librte_mbuf/rte_mbuf_core.h | 793 ++++++++++++++++++++++++++++++++ > 4 files changed, 800 insertions(+), 739 deletions(-) > create mode 100644 lib/librte_mbuf/rte_mbuf_core.h > > diff --git a/lib/librte_mbuf/Makefile b/lib/librte_mbuf/Makefile > index c8f6d2689..f3b76ad23 100644 > --- a/lib/librte_mbuf/Makefile > +++ b/lib/librte_mbuf/Makefile > @@ -19,6 +19,9 @@ LIBABIVER := 5 > SRCS-$(CONFIG_RTE_LIBRTE_MBUF) := rte_mbuf.c rte_mbuf_ptype.c rte_mbuf_pool_ops.c > > # install includes > -SYMLINK-$(CONFIG_RTE_LIBRTE_MBUF)-include := rte_mbuf.h rte_mbuf_ptype.h rte_mbuf_pool_ops.h > +SYMLINK-$(CONFIG_RTE_LIBRTE_MBUF)-include := rte_mbuf.h > +SYMLINK-$(CONFIG_RTE_LIBRTE_MBUF)-include += rte_mbuf_core.h > +SYMLINK-$(CONFIG_RTE_LIBRTE_MBUF)-include += rte_mbuf_ptype.h > +SYMLINK-$(CONFIG_RTE_LIBRTE_MBUF)-include += rte_mbuf_pool_ops.h > > include $(RTE_SDK)/mk/rte.lib.mk > diff --git a/lib/librte_mbuf/meson.build b/lib/librte_mbuf/meson.build > index 6cc11ebb4..36bb6eb9d 100644 > --- a/lib/librte_mbuf/meson.build > +++ b/lib/librte_mbuf/meson.build > @@ -3,7 +3,8 @@ > > version = 5 > sources = files('rte_mbuf.c', 'rte_mbuf_ptype.c', 'rte_mbuf_pool_ops.c') > -headers = files('rte_mbuf.h', 'rte_mbuf_ptype.h', 'rte_mbuf_pool_ops.h') > +headers = files('rte_mbuf.h', 'rte_mbuf_core.h', > + 'rte_mbuf_ptype.h', 'rte_mbuf_pool_ops.h') > deps += ['mempool'] > > allow_experimental_apis = true > diff --git a/lib/librte_mbuf/rte_mbuf.h b/lib/librte_mbuf/rte_mbuf.h > index 98225ec80..528b2f121 100644 > --- a/lib/librte_mbuf/rte_mbuf.h > +++ b/lib/librte_mbuf/rte_mbuf.h > @@ -42,367 +42,12 @@ > #include <rte_branch_prediction.h> > #include <rte_byteorder.h> > #include <rte_mbuf_ptype.h> > +#include <rte_mbuf_core.h> > > #ifdef __cplusplus > extern "C" { > #endif > > -/* > - * Packet Offload Features Flags. It also carry packet type information. > - * Critical resources. Both rx/tx shared these bits. Be cautious on any change > - * > - * - RX flags start at bit position zero, and get added to the left of previous > - * flags. > - * - The most-significant 3 bits are reserved for generic mbuf flags > - * - TX flags therefore start at bit position 60 (i.e. 63-3), and new flags get > - * added to the right of the previously defined flags i.e. they should count > - * downwards, not upwards. > - * > - * Keep these flags synchronized with rte_get_rx_ol_flag_name() and > - * rte_get_tx_ol_flag_name(). > - */ > - > -/** > - * The RX packet is a 802.1q VLAN packet, and the tci has been > - * saved in in mbuf->vlan_tci. > - * If the flag PKT_RX_VLAN_STRIPPED is also present, the VLAN > - * header has been stripped from mbuf data, else it is still > - * present. > - */ > -#define PKT_RX_VLAN (1ULL << 0) > - > -#define PKT_RX_RSS_HASH (1ULL << 1) /**< RX packet with RSS hash result. */ > -#define PKT_RX_FDIR (1ULL << 2) /**< RX packet with FDIR match indicate. */ > - > -/** > - * Deprecated. > - * Checking this flag alone is deprecated: check the 2 bits of > - * PKT_RX_L4_CKSUM_MASK. > - * This flag was set when the L4 checksum of a packet was detected as > - * wrong by the hardware. > - */ > -#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) > - > -/** > - * Deprecated. > - * Checking this flag alone is deprecated: check the 2 bits of > - * PKT_RX_IP_CKSUM_MASK. > - * This flag was set when the IP checksum of a packet was detected as > - * wrong by the hardware. > - */ > -#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) > - > -#define PKT_RX_EIP_CKSUM_BAD (1ULL << 5) /**< External IP header checksum error. */ > - > -/** > - * A vlan has been stripped by the hardware and its tci is saved in > - * mbuf->vlan_tci. This can only happen if vlan stripping is enabled > - * in the RX configuration of the PMD. > - * When PKT_RX_VLAN_STRIPPED is set, PKT_RX_VLAN must also be set. > - */ > -#define PKT_RX_VLAN_STRIPPED (1ULL << 6) > - > -/** > - * Mask of bits used to determine the status of RX IP checksum. > - * - PKT_RX_IP_CKSUM_UNKNOWN: no information about the RX IP checksum > - * - PKT_RX_IP_CKSUM_BAD: the IP checksum in the packet is wrong > - * - PKT_RX_IP_CKSUM_GOOD: the IP checksum in the packet is valid > - * - PKT_RX_IP_CKSUM_NONE: the IP checksum is not correct in the packet > - * data, but the integrity of the IP header is verified. > - */ > -#define PKT_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7)) > - > -#define PKT_RX_IP_CKSUM_UNKNOWN 0 > -#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) > -#define PKT_RX_IP_CKSUM_GOOD (1ULL << 7) > -#define PKT_RX_IP_CKSUM_NONE ((1ULL << 4) | (1ULL << 7)) > - > -/** > - * Mask of bits used to determine the status of RX L4 checksum. > - * - PKT_RX_L4_CKSUM_UNKNOWN: no information about the RX L4 checksum > - * - PKT_RX_L4_CKSUM_BAD: the L4 checksum in the packet is wrong > - * - PKT_RX_L4_CKSUM_GOOD: the L4 checksum in the packet is valid > - * - PKT_RX_L4_CKSUM_NONE: the L4 checksum is not correct in the packet > - * data, but the integrity of the L4 data is verified. > - */ > -#define PKT_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8)) > - > -#define PKT_RX_L4_CKSUM_UNKNOWN 0 > -#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) > -#define PKT_RX_L4_CKSUM_GOOD (1ULL << 8) > -#define PKT_RX_L4_CKSUM_NONE ((1ULL << 3) | (1ULL << 8)) > - > -#define PKT_RX_IEEE1588_PTP (1ULL << 9) /**< RX IEEE1588 L2 Ethernet PT Packet. */ > -#define PKT_RX_IEEE1588_TMST (1ULL << 10) /**< RX IEEE1588 L2/L4 timestamped packet.*/ > -#define PKT_RX_FDIR_ID (1ULL << 13) /**< FD id reported if FDIR match. */ > -#define PKT_RX_FDIR_FLX (1ULL << 14) /**< Flexible bytes reported if FDIR match. */ > - > -/** > - * The 2 vlans have been stripped by the hardware and their tci are > - * saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer). > - * This can only happen if vlan stripping is enabled in the RX > - * configuration of the PMD. > - * When PKT_RX_QINQ_STRIPPED is set, the flags (PKT_RX_VLAN | > - * PKT_RX_VLAN_STRIPPED | PKT_RX_QINQ) must also be set. > - */ > -#define PKT_RX_QINQ_STRIPPED (1ULL << 15) > - > -/** > - * When packets are coalesced by a hardware or virtual driver, this flag > - * can be set in the RX mbuf, meaning that the m->tso_segsz field is > - * valid and is set to the segment size of original packets. > - */ > -#define PKT_RX_LRO (1ULL << 16) > - > -/** > - * Indicate that the timestamp field in the mbuf is valid. > - */ > -#define PKT_RX_TIMESTAMP (1ULL << 17) > - > -/** > - * Indicate that security offload processing was applied on the RX packet. > - */ > -#define PKT_RX_SEC_OFFLOAD (1ULL << 18) > - > -/** > - * Indicate that security offload processing failed on the RX packet. > - */ > -#define PKT_RX_SEC_OFFLOAD_FAILED (1ULL << 19) > - > -/** > - * The RX packet is a double VLAN, and the outer tci has been > - * saved in in mbuf->vlan_tci_outer. If PKT_RX_QINQ set, PKT_RX_VLAN > - * also should be set and inner tci should be saved to mbuf->vlan_tci. > - * If the flag PKT_RX_QINQ_STRIPPED is also present, both VLANs > - * headers have been stripped from mbuf data, else they are still > - * present. > - */ > -#define PKT_RX_QINQ (1ULL << 20) > - > -/** > - * Mask of bits used to determine the status of outer RX L4 checksum. > - * - PKT_RX_OUTER_L4_CKSUM_UNKNOWN: no info about the outer RX L4 checksum > - * - PKT_RX_OUTER_L4_CKSUM_BAD: the outer L4 checksum in the packet is wrong > - * - PKT_RX_OUTER_L4_CKSUM_GOOD: the outer L4 checksum in the packet is valid > - * - PKT_RX_OUTER_L4_CKSUM_INVALID: invalid outer L4 checksum state. > - * > - * The detection of PKT_RX_OUTER_L4_CKSUM_GOOD shall be based on the given > - * HW capability, At minimum, the PMD should support > - * PKT_RX_OUTER_L4_CKSUM_UNKNOWN and PKT_RX_OUTER_L4_CKSUM_BAD states > - * if the DEV_RX_OFFLOAD_OUTER_UDP_CKSUM offload is available. > - */ > -#define PKT_RX_OUTER_L4_CKSUM_MASK ((1ULL << 21) | (1ULL << 22)) > - > -#define PKT_RX_OUTER_L4_CKSUM_UNKNOWN 0 > -#define PKT_RX_OUTER_L4_CKSUM_BAD (1ULL << 21) > -#define PKT_RX_OUTER_L4_CKSUM_GOOD (1ULL << 22) > -#define PKT_RX_OUTER_L4_CKSUM_INVALID ((1ULL << 21) | (1ULL << 22)) > - > -/* add new RX flags here */ > - > -/* add new TX flags here */ > - > -/** > - * Indicate that the metadata field in the mbuf is in use. > - */ > -#define PKT_TX_METADATA (1ULL << 40) > - > -/** > - * Outer UDP checksum offload flag. This flag is used for enabling > - * outer UDP checksum in PMD. To use outer UDP checksum, the user needs to > - * 1) Enable the following in mbuf, > - * a) Fill outer_l2_len and outer_l3_len in mbuf. > - * b) Set the PKT_TX_OUTER_UDP_CKSUM flag. > - * c) Set the PKT_TX_OUTER_IPV4 or PKT_TX_OUTER_IPV6 flag. > - * 2) Configure DEV_TX_OFFLOAD_OUTER_UDP_CKSUM offload flag. > - */ > -#define PKT_TX_OUTER_UDP_CKSUM (1ULL << 41) > - > -/** > - * UDP Fragmentation Offload flag. This flag is used for enabling UDP > - * fragmentation in SW or in HW. When use UFO, mbuf->tso_segsz is used > - * to store the MSS of UDP fragments. > - */ > -#define PKT_TX_UDP_SEG (1ULL << 42) > - > -/** > - * Request security offload processing on the TX packet. > - */ > -#define PKT_TX_SEC_OFFLOAD (1ULL << 43) > - > -/** > - * Offload the MACsec. This flag must be set by the application to enable > - * this offload feature for a packet to be transmitted. > - */ > -#define PKT_TX_MACSEC (1ULL << 44) > - > -/** > - * Bits 45:48 used for the tunnel type. > - * The tunnel type must be specified for TSO or checksum on the inner part > - * of tunnel packets. > - * These flags can be used with PKT_TX_TCP_SEG for TSO, or PKT_TX_xxx_CKSUM. > - * The mbuf fields for inner and outer header lengths are required: > - * outer_l2_len, outer_l3_len, l2_len, l3_len, l4_len and tso_segsz for TSO. > - */ > -#define PKT_TX_TUNNEL_VXLAN (0x1ULL << 45) > -#define PKT_TX_TUNNEL_GRE (0x2ULL << 45) > -#define PKT_TX_TUNNEL_IPIP (0x3ULL << 45) > -#define PKT_TX_TUNNEL_GENEVE (0x4ULL << 45) > -/** TX packet with MPLS-in-UDP RFC 7510 header. */ > -#define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45) > -#define PKT_TX_TUNNEL_VXLAN_GPE (0x6ULL << 45) > -/** > - * Generic IP encapsulated tunnel type, used for TSO and checksum offload. > - * It can be used for tunnels which are not standards or listed above. > - * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_GRE > - * or PKT_TX_TUNNEL_IPIP if possible. > - * The ethdev must be configured with DEV_TX_OFFLOAD_IP_TNL_TSO. > - * Outer and inner checksums are done according to the existing flags like > - * PKT_TX_xxx_CKSUM. > - * Specific tunnel headers that contain payload length, sequence id > - * or checksum are not expected to be updated. > - */ > -#define PKT_TX_TUNNEL_IP (0xDULL << 45) > -/** > - * Generic UDP encapsulated tunnel type, used for TSO and checksum offload. > - * UDP tunnel type implies outer IP layer. > - * It can be used for tunnels which are not standards or listed above. > - * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_VXLAN > - * if possible. > - * The ethdev must be configured with DEV_TX_OFFLOAD_UDP_TNL_TSO. > - * Outer and inner checksums are done according to the existing flags like > - * PKT_TX_xxx_CKSUM. > - * Specific tunnel headers that contain payload length, sequence id > - * or checksum are not expected to be updated. > - */ > -#define PKT_TX_TUNNEL_UDP (0xEULL << 45) > -/* add new TX TUNNEL type here */ > -#define PKT_TX_TUNNEL_MASK (0xFULL << 45) > - > -/** > - * Double VLAN insertion (QinQ) request to driver, driver may offload the > - * insertion based on device capability. > - * mbuf 'vlan_tci' & 'vlan_tci_outer' must be valid when this flag is set. > - */ > -#define PKT_TX_QINQ (1ULL << 49) > -/* this old name is deprecated */ > -#define PKT_TX_QINQ_PKT PKT_TX_QINQ > - > -/** > - * TCP segmentation offload. To enable this offload feature for a > - * packet to be transmitted on hardware supporting TSO: > - * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies > - * PKT_TX_TCP_CKSUM) > - * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 > - * - if it's IPv4, set the PKT_TX_IP_CKSUM flag > - * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz > - */ > -#define PKT_TX_TCP_SEG (1ULL << 50) > - > -#define PKT_TX_IEEE1588_TMST (1ULL << 51) /**< TX IEEE1588 packet to timestamp. */ > - > -/** > - * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved, > - * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware > - * L4 checksum offload, the user needs to: > - * - fill l2_len and l3_len in mbuf > - * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM > - * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 > - */ > -#define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */ > -#define PKT_TX_TCP_CKSUM (1ULL << 52) /**< TCP cksum of TX pkt. computed by NIC. */ > -#define PKT_TX_SCTP_CKSUM (2ULL << 52) /**< SCTP cksum of TX pkt. computed by NIC. */ > -#define PKT_TX_UDP_CKSUM (3ULL << 52) /**< UDP cksum of TX pkt. computed by NIC. */ > -#define PKT_TX_L4_MASK (3ULL << 52) /**< Mask for L4 cksum offload request. */ > - > -/** > - * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should > - * also be set by the application, although a PMD will only check > - * PKT_TX_IP_CKSUM. > - * - fill the mbuf offload information: l2_len, l3_len > - */ > -#define PKT_TX_IP_CKSUM (1ULL << 54) > - > -/** > - * Packet is IPv4. This flag must be set when using any offload feature > - * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4 > - * packet. If the packet is a tunneled packet, this flag is related to > - * the inner headers. > - */ > -#define PKT_TX_IPV4 (1ULL << 55) > - > -/** > - * Packet is IPv6. This flag must be set when using an offload feature > - * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6 > - * packet. If the packet is a tunneled packet, this flag is related to > - * the inner headers. > - */ > -#define PKT_TX_IPV6 (1ULL << 56) > - > -/** > - * VLAN tag insertion request to driver, driver may offload the insertion > - * based on the device capability. > - * mbuf 'vlan_tci' field must be valid when this flag is set. > - */ > -#define PKT_TX_VLAN (1ULL << 57) > -/* this old name is deprecated */ > -#define PKT_TX_VLAN_PKT PKT_TX_VLAN > - > -/** > - * Offload the IP checksum of an external header in the hardware. The > - * flag PKT_TX_OUTER_IPV4 should also be set by the application, although > - * a PMD will only check PKT_TX_OUTER_IP_CKSUM. > - * - fill the mbuf offload information: outer_l2_len, outer_l3_len > - */ > -#define PKT_TX_OUTER_IP_CKSUM (1ULL << 58) > - > -/** > - * Packet outer header is IPv4. This flag must be set when using any > - * outer offload feature (L3 or L4 checksum) to tell the NIC that the > - * outer header of the tunneled packet is an IPv4 packet. > - */ > -#define PKT_TX_OUTER_IPV4 (1ULL << 59) > - > -/** > - * Packet outer header is IPv6. This flag must be set when using any > - * outer offload feature (L4 checksum) to tell the NIC that the outer > - * header of the tunneled packet is an IPv6 packet. > - */ > -#define PKT_TX_OUTER_IPV6 (1ULL << 60) > - > -/** > - * Bitmask of all supported packet Tx offload features flags, > - * which can be set for packet. > - */ > -#define PKT_TX_OFFLOAD_MASK ( \ > - PKT_TX_OUTER_IPV6 | \ > - PKT_TX_OUTER_IPV4 | \ > - PKT_TX_OUTER_IP_CKSUM | \ > - PKT_TX_VLAN_PKT | \ > - PKT_TX_IPV6 | \ > - PKT_TX_IPV4 | \ > - PKT_TX_IP_CKSUM | \ > - PKT_TX_L4_MASK | \ > - PKT_TX_IEEE1588_TMST | \ > - PKT_TX_TCP_SEG | \ > - PKT_TX_QINQ_PKT | \ > - PKT_TX_TUNNEL_MASK | \ > - PKT_TX_MACSEC | \ > - PKT_TX_SEC_OFFLOAD | \ > - PKT_TX_UDP_SEG | \ > - PKT_TX_OUTER_UDP_CKSUM | \ > - PKT_TX_METADATA) > - > -/** > - * Mbuf having an external buffer attached. shinfo in mbuf must be filled. > - */ > -#define EXT_ATTACHED_MBUF (1ULL << 61) > - > -#define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */ > - > -/** Alignment constraint of mbuf private area. */ > -#define RTE_MBUF_PRIV_ALIGN 8 > - > /** > * Get the name of a RX offload flag > * > @@ -453,310 +98,6 @@ const char *rte_get_tx_ol_flag_name(uint64_t mask); > */ > int rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen); > > -/** > - * Some NICs need at least 2KB buffer to RX standard Ethernet frame without > - * splitting it into multiple segments. > - * So, for mbufs that planned to be involved into RX/TX, the recommended > - * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM. > - */ > -#define RTE_MBUF_DEFAULT_DATAROOM 2048 > -#define RTE_MBUF_DEFAULT_BUF_SIZE \ > - (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM) > - > -/* define a set of marker types that can be used to refer to set points in the > - * mbuf */ > -__extension__ > -typedef void *MARKER[0]; /**< generic marker for a point in a structure */ > -__extension__ > -typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */ > -__extension__ > -typedef uint64_t MARKER64[0]; /**< marker that allows us to overwrite 8 bytes > - * with a single assignment */ > - > -struct rte_mbuf_sched { > - uint32_t queue_id; /**< Queue ID. */ > - uint8_t traffic_class; > - /**< Traffic class ID. Traffic class 0 > - * is the highest priority traffic class. > - */ > - uint8_t color; > - /**< Color. @see enum rte_color.*/ > - uint16_t reserved; /**< Reserved. */ > -}; /**< Hierarchical scheduler */ > - > -/** > - * enum for the tx_offload bit-fields lengths and offsets. > - * defines the layout of rte_mbuf tx_offload field. > - */ > -enum { > - RTE_MBUF_L2_LEN_BITS = 7, > - RTE_MBUF_L3_LEN_BITS = 9, > - RTE_MBUF_L4_LEN_BITS = 8, > - RTE_MBUF_TSO_SEGSZ_BITS = 16, > - RTE_MBUF_OUTL3_LEN_BITS = 9, > - RTE_MBUF_OUTL2_LEN_BITS = 7, > - RTE_MBUF_TXOFLD_UNUSED_BITS = sizeof(uint64_t) * CHAR_BIT - > - RTE_MBUF_L2_LEN_BITS - > - RTE_MBUF_L3_LEN_BITS - > - RTE_MBUF_L4_LEN_BITS - > - RTE_MBUF_TSO_SEGSZ_BITS - > - RTE_MBUF_OUTL3_LEN_BITS - > - RTE_MBUF_OUTL2_LEN_BITS, > -#if RTE_BYTE_ORDER == RTE_BIG_ENDIAN > - RTE_MBUF_L2_LEN_OFS = > - sizeof(uint64_t) * CHAR_BIT - RTE_MBUF_L2_LEN_BITS, > - RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS - RTE_MBUF_L3_LEN_BITS, > - RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS - RTE_MBUF_L4_LEN_BITS, > - RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS - RTE_MBUF_TSO_SEGSZ_BITS, > - RTE_MBUF_OUTL3_LEN_OFS = > - RTE_MBUF_TSO_SEGSZ_OFS - RTE_MBUF_OUTL3_LEN_BITS, > - RTE_MBUF_OUTL2_LEN_OFS = > - RTE_MBUF_OUTL3_LEN_OFS - RTE_MBUF_OUTL2_LEN_BITS, > - RTE_MBUF_TXOFLD_UNUSED_OFS = > - RTE_MBUF_OUTL2_LEN_OFS - RTE_MBUF_TXOFLD_UNUSED_BITS, > -#else > - RTE_MBUF_L2_LEN_OFS = 0, > - RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS + RTE_MBUF_L2_LEN_BITS, > - RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS + RTE_MBUF_L3_LEN_BITS, > - RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS + RTE_MBUF_L4_LEN_BITS, > - RTE_MBUF_OUTL3_LEN_OFS = > - RTE_MBUF_TSO_SEGSZ_OFS + RTE_MBUF_TSO_SEGSZ_BITS, > - RTE_MBUF_OUTL2_LEN_OFS = > - RTE_MBUF_OUTL3_LEN_OFS + RTE_MBUF_OUTL3_LEN_BITS, > - RTE_MBUF_TXOFLD_UNUSED_OFS = > - RTE_MBUF_OUTL2_LEN_OFS + RTE_MBUF_OUTL2_LEN_BITS, > -#endif > -}; > - > -/** > - * The generic rte_mbuf, containing a packet mbuf. > - */ > -struct rte_mbuf { > - MARKER cacheline0; > - > - void *buf_addr; /**< Virtual address of segment buffer. */ > - /** > - * Physical address of segment buffer. > - * Force alignment to 8-bytes, so as to ensure we have the exact > - * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes > - * working on vector drivers easier. > - */ > - RTE_STD_C11 > - union { > - rte_iova_t buf_iova; > - rte_iova_t buf_physaddr; /**< deprecated */ > - } __rte_aligned(sizeof(rte_iova_t)); > - > - /* next 8 bytes are initialised on RX descriptor rearm */ > - MARKER64 rearm_data; > - uint16_t data_off; > - > - /** > - * Reference counter. Its size should at least equal to the size > - * of port field (16 bits), to support zero-copy broadcast. > - * It should only be accessed using the following functions: > - * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and > - * rte_mbuf_refcnt_set(). The functionality of these functions (atomic, > - * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC > - * config option. > - */ > - RTE_STD_C11 > - union { > - rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */ > - uint16_t refcnt; /**< Non-atomically accessed refcnt */ > - }; > - uint16_t nb_segs; /**< Number of segments. */ > - > - /** Input port (16 bits to support more than 256 virtual ports). > - * The event eth Tx adapter uses this field to specify the output port. > - */ > - uint16_t port; > - > - uint64_t ol_flags; /**< Offload features. */ > - > - /* remaining bytes are set on RX when pulling packet from descriptor */ > - MARKER rx_descriptor_fields1; > - > - /* > - * The packet type, which is the combination of outer/inner L2, L3, L4 > - * and tunnel types. The packet_type is about data really present in the > - * mbuf. Example: if vlan stripping is enabled, a received vlan packet > - * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the > - * vlan is stripped from the data. > - */ > - RTE_STD_C11 > - union { > - uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */ > - struct { > - uint32_t l2_type:4; /**< (Outer) L2 type. */ > - uint32_t l3_type:4; /**< (Outer) L3 type. */ > - uint32_t l4_type:4; /**< (Outer) L4 type. */ > - uint32_t tun_type:4; /**< Tunnel type. */ > - RTE_STD_C11 > - union { > - uint8_t inner_esp_next_proto; > - /**< ESP next protocol type, valid if > - * RTE_PTYPE_TUNNEL_ESP tunnel type is set > - * on both Tx and Rx. > - */ > - __extension__ > - struct { > - uint8_t inner_l2_type:4; > - /**< Inner L2 type. */ > - uint8_t inner_l3_type:4; > - /**< Inner L3 type. */ > - }; > - }; > - uint32_t inner_l4_type:4; /**< Inner L4 type. */ > - }; > - }; > - > - uint32_t pkt_len; /**< Total pkt len: sum of all segments. */ > - uint16_t data_len; /**< Amount of data in segment buffer. */ > - /** VLAN TCI (CPU order), valid if PKT_RX_VLAN is set. */ > - uint16_t vlan_tci; > - > - RTE_STD_C11 > - union { > - union { > - uint32_t rss; /**< RSS hash result if RSS enabled */ > - struct { > - union { > - struct { > - uint16_t hash; > - uint16_t id; > - }; > - uint32_t lo; > - /**< Second 4 flexible bytes */ > - }; > - uint32_t hi; > - /**< First 4 flexible bytes or FD ID, dependent > - * on PKT_RX_FDIR_* flag in ol_flags. > - */ > - } fdir; /**< Filter identifier if FDIR enabled */ > - struct rte_mbuf_sched sched; > - /**< Hierarchical scheduler : 8 bytes */ > - struct { > - uint32_t reserved1; > - uint16_t reserved2; > - uint16_t txq; > - /**< The event eth Tx adapter uses this field > - * to store Tx queue id. > - * @see rte_event_eth_tx_adapter_txq_set() > - */ > - } txadapter; /**< Eventdev ethdev Tx adapter */ > - /**< User defined tags. See rte_distributor_process() */ > - uint32_t usr; > - } hash; /**< hash information */ > - struct { > - /** > - * Application specific metadata value > - * for egress flow rule match. > - * Valid if PKT_TX_METADATA is set. > - * Located here to allow conjunct use > - * with hash.sched.hi. > - */ > - uint32_t tx_metadata; > - uint32_t reserved; > - }; > - }; > - > - /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ is set. */ > - uint16_t vlan_tci_outer; > - > - uint16_t buf_len; /**< Length of segment buffer. */ > - > - /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference > - * are not normalized but are always the same for a given port. > - * Some devices allow to query rte_eth_read_clock that will return the > - * current device timestamp. > - */ > - uint64_t timestamp; > - > - /* second cache line - fields only used in slow path or on TX */ > - MARKER cacheline1 __rte_cache_min_aligned; > - > - RTE_STD_C11 > - union { > - void *userdata; /**< Can be used for external metadata */ > - uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */ > - }; > - > - struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */ > - struct rte_mbuf *next; /**< Next segment of scattered packet. */ > - > - /* fields to support TX offloads */ > - RTE_STD_C11 > - union { > - uint64_t tx_offload; /**< combined for easy fetch */ > - __extension__ > - struct { > - uint64_t l2_len:RTE_MBUF_L2_LEN_BITS; > - /**< L2 (MAC) Header Length for non-tunneling pkt. > - * Outer_L4_len + ... + Inner_L2_len for tunneling pkt. > - */ > - uint64_t l3_len:RTE_MBUF_L3_LEN_BITS; > - /**< L3 (IP) Header Length. */ > - uint64_t l4_len:RTE_MBUF_L4_LEN_BITS; > - /**< L4 (TCP/UDP) Header Length. */ > - uint64_t tso_segsz:RTE_MBUF_TSO_SEGSZ_BITS; > - /**< TCP TSO segment size */ > - > - /* > - * Fields for Tx offloading of tunnels. > - * These are undefined for packets which don't request > - * any tunnel offloads (outer IP or UDP checksum, > - * tunnel TSO). > - * > - * PMDs should not use these fields unconditionally > - * when calculating offsets. > - * > - * Applications are expected to set appropriate tunnel > - * offload flags when they fill in these fields. > - */ > - uint64_t outer_l3_len:RTE_MBUF_OUTL3_LEN_BITS; > - /**< Outer L3 (IP) Hdr Length. */ > - uint64_t outer_l2_len:RTE_MBUF_OUTL2_LEN_BITS; > - /**< Outer L2 (MAC) Hdr Length. */ > - > - /* uint64_t unused:RTE_MBUF_TXOFLD_UNUSED_BITS; */ > - }; > - }; > - > - /** Size of the application private data. In case of an indirect > - * mbuf, it stores the direct mbuf private data size. */ > - uint16_t priv_size; > - > - /** Timesync flags for use with IEEE1588. */ > - uint16_t timesync; > - > - /** Sequence number. See also rte_reorder_insert(). */ > - uint32_t seqn; > - > - /** Shared data for external buffer attached to mbuf. See > - * rte_pktmbuf_attach_extbuf(). > - */ > - struct rte_mbuf_ext_shared_info *shinfo; > - > -} __rte_cache_aligned; > - > -/** > - * Function typedef of callback to free externally attached buffer. > - */ > -typedef void (*rte_mbuf_extbuf_free_callback_t)(void *addr, void *opaque); > - > -/** > - * Shared data at the end of an external buffer. > - */ > -struct rte_mbuf_ext_shared_info { > - rte_mbuf_extbuf_free_callback_t free_cb; /**< Free callback function */ > - void *fcb_opaque; /**< Free callback argument */ > - rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */ > -}; > - > -/**< Maximum number of nb_segs allowed. */ > -#define RTE_MBUF_MAX_NB_SEGS UINT16_MAX > - > /** > * Prefetch the first part of the mbuf > * > @@ -953,31 +294,6 @@ rte_mbuf_to_priv(struct rte_mbuf *m) > return RTE_PTR_ADD(m, sizeof(struct rte_mbuf)); > } > > -/** > - * Returns TRUE if given mbuf is cloned by mbuf indirection, or FALSE > - * otherwise. > - * > - * If a mbuf has its data in another mbuf and references it by mbuf > - * indirection, this mbuf can be defined as a cloned mbuf. > - */ > -#define RTE_MBUF_CLONED(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF) > - > -/** > - * Returns TRUE if given mbuf has an external buffer, or FALSE otherwise. > - * > - * External buffer is a user-provided anonymous buffer. > - */ > -#define RTE_MBUF_HAS_EXTBUF(mb) ((mb)->ol_flags & EXT_ATTACHED_MBUF) > - > -/** > - * Returns TRUE if given mbuf is direct, or FALSE otherwise. > - * > - * If a mbuf embeds its own data after the rte_mbuf structure, this mbuf > - * can be defined as a direct mbuf. > - */ > -#define RTE_MBUF_DIRECT(mb) \ > - (!((mb)->ol_flags & (IND_ATTACHED_MBUF | EXT_ATTACHED_MBUF))) > - > /** > * Private data in case of pktmbuf pool. > * > @@ -2026,62 +1342,10 @@ static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m) > return m; > } > > -/** > - * A macro that points to an offset into the data in the mbuf. > - * > - * The returned pointer is cast to type t. Before using this > - * function, the user must ensure that the first segment is large > - * enough to accommodate its data. > - * > - * @param m > - * The packet mbuf. > - * @param o > - * The offset into the mbuf data. > - * @param t > - * The type to cast the result into. > - */ > -#define rte_pktmbuf_mtod_offset(m, t, o) \ > - ((t)((char *)(m)->buf_addr + (m)->data_off + (o))) > - > -/** > - * A macro that points to the start of the data in the mbuf. > - * > - * The returned pointer is cast to type t. Before using this > - * function, the user must ensure that the first segment is large > - * enough to accommodate its data. > - * > - * @param m > - * The packet mbuf. > - * @param t > - * The type to cast the result into. > - */ > -#define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0) > - > -/** > - * A macro that returns the IO address that points to an offset of the > - * start of the data in the mbuf > - * > - * @param m > - * The packet mbuf. > - * @param o > - * The offset into the data to calculate address from. > - */ > -#define rte_pktmbuf_iova_offset(m, o) \ > - (rte_iova_t)((m)->buf_iova + (m)->data_off + (o)) > - > /* deprecated */ > #define rte_pktmbuf_mtophys_offset(m, o) \ > rte_pktmbuf_iova_offset(m, o) > > -/** > - * A macro that returns the IO address that points to the start of the > - * data in the mbuf > - * > - * @param m > - * The packet mbuf. > - */ > -#define rte_pktmbuf_iova(m) rte_pktmbuf_iova_offset(m, 0) > - > /* deprecated */ > #define rte_pktmbuf_mtophys(m) rte_pktmbuf_iova(m) > > diff --git a/lib/librte_mbuf/rte_mbuf_core.h b/lib/librte_mbuf/rte_mbuf_core.h > new file mode 100644 > index 000000000..8fc987eee > --- /dev/null > +++ b/lib/librte_mbuf/rte_mbuf_core.h > @@ -0,0 +1,793 @@ > +/* SPDX-License-Identifier: BSD-3-Clause > + * Copyright(c) 2010-2014 Intel Corporation. > + * Copyright 2014 6WIND S.A. > + */ > + > +#ifndef _RTE_MBUF_CORE_H_ > +#define _RTE_MBUF_CORE_H_ > + > +/** > + * @file > + * This file contains definion of RTE mbuf structure itself, > + * packet offload flags and some related macros. > + * For majority of DPDK entities, it is not recommended to include > + * this file directly, use include <rte_mbuf.h> instead. > + */ > + > +#include <stdint.h> > +#include <rte_compat.h> > +#include <generic/rte_atomic.h> > + > +#ifdef __cplusplus > +extern "C" { > +#endif > + > +/* > + * Packet Offload Features Flags. It also carry packet type information. > + * Critical resources. Both rx/tx shared these bits. Be cautious on any change > + * > + * - RX flags start at bit position zero, and get added to the left of previous > + * flags. > + * - The most-significant 3 bits are reserved for generic mbuf flags > + * - TX flags therefore start at bit position 60 (i.e. 63-3), and new flags get > + * added to the right of the previously defined flags i.e. they should count > + * downwards, not upwards. > + * > + * Keep these flags synchronized with rte_get_rx_ol_flag_name() and > + * rte_get_tx_ol_flag_name(). > + */ > + > +/** > + * The RX packet is a 802.1q VLAN packet, and the tci has been > + * saved in in mbuf->vlan_tci. > + * If the flag PKT_RX_VLAN_STRIPPED is also present, the VLAN > + * header has been stripped from mbuf data, else it is still > + * present. > + */ > +#define PKT_RX_VLAN (1ULL << 0) > + > +/** RX packet with RSS hash result. */ > +#define PKT_RX_RSS_HASH (1ULL << 1) > + > + /** RX packet with FDIR match indicate. */ > +#define PKT_RX_FDIR (1ULL << 2) > + > +/** > + * Deprecated. > + * Checking this flag alone is deprecated: check the 2 bits of > + * PKT_RX_L4_CKSUM_MASK. > + * This flag was set when the L4 checksum of a packet was detected as > + * wrong by the hardware. > + */ > +#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) > + > +/** > + * Deprecated. > + * Checking this flag alone is deprecated: check the 2 bits of > + * PKT_RX_IP_CKSUM_MASK. > + * This flag was set when the IP checksum of a packet was detected as > + * wrong by the hardware. > + */ > +#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) > + > + /** External IP header checksum error. */ > +#define PKT_RX_EIP_CKSUM_BAD (1ULL << 5) > + > +/** > + * A vlan has been stripped by the hardware and its tci is saved in > + * mbuf->vlan_tci. This can only happen if vlan stripping is enabled > + * in the RX configuration of the PMD. > + * When PKT_RX_VLAN_STRIPPED is set, PKT_RX_VLAN must also be set. > + */ > +#define PKT_RX_VLAN_STRIPPED (1ULL << 6) > + > +/** > + * Mask of bits used to determine the status of RX IP checksum. > + * - PKT_RX_IP_CKSUM_UNKNOWN: no information about the RX IP checksum > + * - PKT_RX_IP_CKSUM_BAD: the IP checksum in the packet is wrong > + * - PKT_RX_IP_CKSUM_GOOD: the IP checksum in the packet is valid > + * - PKT_RX_IP_CKSUM_NONE: the IP checksum is not correct in the packet > + * data, but the integrity of the IP header is verified. > + */ > +#define PKT_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7)) > + > +#define PKT_RX_IP_CKSUM_UNKNOWN 0 > +#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) > +#define PKT_RX_IP_CKSUM_GOOD (1ULL << 7) > +#define PKT_RX_IP_CKSUM_NONE ((1ULL << 4) | (1ULL << 7)) > + > +/** > + * Mask of bits used to determine the status of RX L4 checksum. > + * - PKT_RX_L4_CKSUM_UNKNOWN: no information about the RX L4 checksum > + * - PKT_RX_L4_CKSUM_BAD: the L4 checksum in the packet is wrong > + * - PKT_RX_L4_CKSUM_GOOD: the L4 checksum in the packet is valid > + * - PKT_RX_L4_CKSUM_NONE: the L4 checksum is not correct in the packet > + * data, but the integrity of the L4 data is verified. > + */ > +#define PKT_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8)) > + > +#define PKT_RX_L4_CKSUM_UNKNOWN 0 > +#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) > +#define PKT_RX_L4_CKSUM_GOOD (1ULL << 8) > +#define PKT_RX_L4_CKSUM_NONE ((1ULL << 3) | (1ULL << 8)) > + > +/** RX IEEE1588 L2 Ethernet PT Packet. */ > +#define PKT_RX_IEEE1588_PTP (1ULL << 9) > + > +/** RX IEEE1588 L2/L4 timestamped packet.*/ > +#define PKT_RX_IEEE1588_TMST (1ULL << 10) > + > +/** FD id reported if FDIR match. */ > +#define PKT_RX_FDIR_ID (1ULL << 13) > + > +/** Flexible bytes reported if FDIR match. */ > +#define PKT_RX_FDIR_FLX (1ULL << 14) > + > +/** > + * The 2 vlans have been stripped by the hardware and their tci are > + * saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer). > + * This can only happen if vlan stripping is enabled in the RX > + * configuration of the PMD. > + * When PKT_RX_QINQ_STRIPPED is set, the flags (PKT_RX_VLAN | > + * PKT_RX_VLAN_STRIPPED | PKT_RX_QINQ) must also be set. > + */ > +#define PKT_RX_QINQ_STRIPPED (1ULL << 15) > + > +/** > + * When packets are coalesced by a hardware or virtual driver, this flag > + * can be set in the RX mbuf, meaning that the m->tso_segsz field is > + * valid and is set to the segment size of original packets. > + */ > +#define PKT_RX_LRO (1ULL << 16) > + > +/** > + * Indicate that the timestamp field in the mbuf is valid. > + */ > +#define PKT_RX_TIMESTAMP (1ULL << 17) > + > +/** > + * Indicate that security offload processing was applied on the RX packet. > + */ > +#define PKT_RX_SEC_OFFLOAD (1ULL << 18) > + > +/** > + * Indicate that security offload processing failed on the RX packet. > + */ > +#define PKT_RX_SEC_OFFLOAD_FAILED (1ULL << 19) > + > +/** > + * The RX packet is a double VLAN, and the outer tci has been > + * saved in in mbuf->vlan_tci_outer. If PKT_RX_QINQ set, PKT_RX_VLAN > + * also should be set and inner tci should be saved to mbuf->vlan_tci. > + * If the flag PKT_RX_QINQ_STRIPPED is also present, both VLANs > + * headers have been stripped from mbuf data, else they are still > + * present. > + */ > +#define PKT_RX_QINQ (1ULL << 20) > + > +/** > + * Mask of bits used to determine the status of outer RX L4 checksum. > + * - PKT_RX_OUTER_L4_CKSUM_UNKNOWN: no info about the outer RX L4 checksum > + * - PKT_RX_OUTER_L4_CKSUM_BAD: the outer L4 checksum in the packet is wrong > + * - PKT_RX_OUTER_L4_CKSUM_GOOD: the outer L4 checksum in the packet is valid > + * - PKT_RX_OUTER_L4_CKSUM_INVALID: invalid outer L4 checksum state. > + * > + * The detection of PKT_RX_OUTER_L4_CKSUM_GOOD shall be based on the given > + * HW capability, At minimum, the PMD should support > + * PKT_RX_OUTER_L4_CKSUM_UNKNOWN and PKT_RX_OUTER_L4_CKSUM_BAD states > + * if the DEV_RX_OFFLOAD_OUTER_UDP_CKSUM offload is available. > + */ > +#define PKT_RX_OUTER_L4_CKSUM_MASK ((1ULL << 21) | (1ULL << 22)) > + > +#define PKT_RX_OUTER_L4_CKSUM_UNKNOWN 0 > +#define PKT_RX_OUTER_L4_CKSUM_BAD (1ULL << 21) > +#define PKT_RX_OUTER_L4_CKSUM_GOOD (1ULL << 22) > +#define PKT_RX_OUTER_L4_CKSUM_INVALID ((1ULL << 21) | (1ULL << 22)) > + > +/* add new RX flags here */ > + > +/* add new TX flags here */ > + > +/** > + * Indicate that the metadata field in the mbuf is in use. > + */ > +#define PKT_TX_METADATA (1ULL << 40) > + > +/** > + * Outer UDP checksum offload flag. This flag is used for enabling > + * outer UDP checksum in PMD. To use outer UDP checksum, the user needs to > + * 1) Enable the following in mbuf, > + * a) Fill outer_l2_len and outer_l3_len in mbuf. > + * b) Set the PKT_TX_OUTER_UDP_CKSUM flag. > + * c) Set the PKT_TX_OUTER_IPV4 or PKT_TX_OUTER_IPV6 flag. > + * 2) Configure DEV_TX_OFFLOAD_OUTER_UDP_CKSUM offload flag. > + */ > +#define PKT_TX_OUTER_UDP_CKSUM (1ULL << 41) > + > +/** > + * UDP Fragmentation Offload flag. This flag is used for enabling UDP > + * fragmentation in SW or in HW. When use UFO, mbuf->tso_segsz is used > + * to store the MSS of UDP fragments. > + */ > +#define PKT_TX_UDP_SEG (1ULL << 42) > + > +/** > + * Request security offload processing on the TX packet. > + */ > +#define PKT_TX_SEC_OFFLOAD (1ULL << 43) > + > +/** > + * Offload the MACsec. This flag must be set by the application to enable > + * this offload feature for a packet to be transmitted. > + */ > +#define PKT_TX_MACSEC (1ULL << 44) > + > +/** > + * Bits 45:48 used for the tunnel type. > + * The tunnel type must be specified for TSO or checksum on the inner part > + * of tunnel packets. > + * These flags can be used with PKT_TX_TCP_SEG for TSO, or PKT_TX_xxx_CKSUM. > + * The mbuf fields for inner and outer header lengths are required: > + * outer_l2_len, outer_l3_len, l2_len, l3_len, l4_len and tso_segsz for TSO. > + */ > +#define PKT_TX_TUNNEL_VXLAN (0x1ULL << 45) > +#define PKT_TX_TUNNEL_GRE (0x2ULL << 45) > +#define PKT_TX_TUNNEL_IPIP (0x3ULL << 45) > +#define PKT_TX_TUNNEL_GENEVE (0x4ULL << 45) > +/** TX packet with MPLS-in-UDP RFC 7510 header. */ > +#define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45) > +#define PKT_TX_TUNNEL_VXLAN_GPE (0x6ULL << 45) > +/** > + * Generic IP encapsulated tunnel type, used for TSO and checksum offload. > + * It can be used for tunnels which are not standards or listed above. > + * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_GRE > + * or PKT_TX_TUNNEL_IPIP if possible. > + * The ethdev must be configured with DEV_TX_OFFLOAD_IP_TNL_TSO. > + * Outer and inner checksums are done according to the existing flags like > + * PKT_TX_xxx_CKSUM. > + * Specific tunnel headers that contain payload length, sequence id > + * or checksum are not expected to be updated. > + */ > +#define PKT_TX_TUNNEL_IP (0xDULL << 45) > +/** > + * Generic UDP encapsulated tunnel type, used for TSO and checksum offload. > + * UDP tunnel type implies outer IP layer. > + * It can be used for tunnels which are not standards or listed above. > + * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_VXLAN > + * if possible. > + * The ethdev must be configured with DEV_TX_OFFLOAD_UDP_TNL_TSO. > + * Outer and inner checksums are done according to the existing flags like > + * PKT_TX_xxx_CKSUM. > + * Specific tunnel headers that contain payload length, sequence id > + * or checksum are not expected to be updated. > + */ > +#define PKT_TX_TUNNEL_UDP (0xEULL << 45) > +/* add new TX TUNNEL type here */ > +#define PKT_TX_TUNNEL_MASK (0xFULL << 45) > + > +/** > + * Double VLAN insertion (QinQ) request to driver, driver may offload the > + * insertion based on device capability. > + * mbuf 'vlan_tci' & 'vlan_tci_outer' must be valid when this flag is set. > + */ > +#define PKT_TX_QINQ (1ULL << 49) > +/* this old name is deprecated */ > +#define PKT_TX_QINQ_PKT PKT_TX_QINQ > + > +/** > + * TCP segmentation offload. To enable this offload feature for a > + * packet to be transmitted on hardware supporting TSO: > + * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies > + * PKT_TX_TCP_CKSUM) > + * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 > + * - if it's IPv4, set the PKT_TX_IP_CKSUM flag > + * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz > + */ > +#define PKT_TX_TCP_SEG (1ULL << 50) > + > +/** TX IEEE1588 packet to timestamp. */ > +#define PKT_TX_IEEE1588_TMST (1ULL << 51) > + > +/** > + * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved, > + * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware > + * L4 checksum offload, the user needs to: > + * - fill l2_len and l3_len in mbuf > + * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM > + * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 > + */ > +#define PKT_TX_L4_NO_CKSUM (0ULL << 52) /**< Disable L4 cksum of TX pkt. */ > + > +/** TCP cksum of TX pkt. computed by NIC. */ > +#define PKT_TX_TCP_CKSUM (1ULL << 52) > + > +/** SCTP cksum of TX pkt. computed by NIC. */ > +#define PKT_TX_SCTP_CKSUM (2ULL << 52) > + > +/** UDP cksum of TX pkt. computed by NIC. */ > +#define PKT_TX_UDP_CKSUM (3ULL << 52) > + > +/** Mask for L4 cksum offload request. */ > +#define PKT_TX_L4_MASK (3ULL << 52) > + > +/** > + * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should > + * also be set by the application, although a PMD will only check > + * PKT_TX_IP_CKSUM. > + * - fill the mbuf offload information: l2_len, l3_len > + */ > +#define PKT_TX_IP_CKSUM (1ULL << 54) > + > +/** > + * Packet is IPv4. This flag must be set when using any offload feature > + * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4 > + * packet. If the packet is a tunneled packet, this flag is related to > + * the inner headers. > + */ > +#define PKT_TX_IPV4 (1ULL << 55) > + > +/** > + * Packet is IPv6. This flag must be set when using an offload feature > + * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6 > + * packet. If the packet is a tunneled packet, this flag is related to > + * the inner headers. > + */ > +#define PKT_TX_IPV6 (1ULL << 56) > + > +/** > + * VLAN tag insertion request to driver, driver may offload the insertion > + * based on the device capability. > + * mbuf 'vlan_tci' field must be valid when this flag is set. > + */ > +#define PKT_TX_VLAN (1ULL << 57) > +/* this old name is deprecated */ > +#define PKT_TX_VLAN_PKT PKT_TX_VLAN > + > +/** > + * Offload the IP checksum of an external header in the hardware. The > + * flag PKT_TX_OUTER_IPV4 should also be set by the application, although > + * a PMD will only check PKT_TX_OUTER_IP_CKSUM. > + * - fill the mbuf offload information: outer_l2_len, outer_l3_len > + */ > +#define PKT_TX_OUTER_IP_CKSUM (1ULL << 58) > + > +/** > + * Packet outer header is IPv4. This flag must be set when using any > + * outer offload feature (L3 or L4 checksum) to tell the NIC that the > + * outer header of the tunneled packet is an IPv4 packet. > + */ > +#define PKT_TX_OUTER_IPV4 (1ULL << 59) > + > +/** > + * Packet outer header is IPv6. This flag must be set when using any > + * outer offload feature (L4 checksum) to tell the NIC that the outer > + * header of the tunneled packet is an IPv6 packet. > + */ > +#define PKT_TX_OUTER_IPV6 (1ULL << 60) > + > +/** > + * Bitmask of all supported packet Tx offload features flags, > + * which can be set for packet. > + */ > +#define PKT_TX_OFFLOAD_MASK ( \ > + PKT_TX_OUTER_IPV6 | \ > + PKT_TX_OUTER_IPV4 | \ > + PKT_TX_OUTER_IP_CKSUM | \ > + PKT_TX_VLAN_PKT | \ > + PKT_TX_IPV6 | \ > + PKT_TX_IPV4 | \ > + PKT_TX_IP_CKSUM | \ > + PKT_TX_L4_MASK | \ > + PKT_TX_IEEE1588_TMST | \ > + PKT_TX_TCP_SEG | \ > + PKT_TX_QINQ_PKT | \ > + PKT_TX_TUNNEL_MASK | \ > + PKT_TX_MACSEC | \ > + PKT_TX_SEC_OFFLOAD | \ > + PKT_TX_UDP_SEG | \ > + PKT_TX_OUTER_UDP_CKSUM | \ > + PKT_TX_METADATA) > + > +/** > + * Mbuf having an external buffer attached. shinfo in mbuf must be filled. > + */ > +#define EXT_ATTACHED_MBUF (1ULL << 61) > + > +#define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */ > + > +/** Alignment constraint of mbuf private area. */ > +#define RTE_MBUF_PRIV_ALIGN 8 > + > +/** > + * Some NICs need at least 2KB buffer to RX standard Ethernet frame without > + * splitting it into multiple segments. > + * So, for mbufs that planned to be involved into RX/TX, the recommended > + * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM. > + */ > +#define RTE_MBUF_DEFAULT_DATAROOM 2048 > +#define RTE_MBUF_DEFAULT_BUF_SIZE \ > + (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM) > + > +/* > + * define a set of marker types that can be used to refer to set points in the > + * mbuf. > + */ > +__extension__ > +typedef void *MARKER[0]; /**< generic marker for a point in a structure */ > +__extension__ > +typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */ > + > + /** marker that allows us to overwrite 8 bytes with a single assignment */ > +__extension__ > +typedef uint64_t MARKER64[0]; > + > +struct rte_mbuf_sched { > + uint32_t queue_id; /**< Queue ID. */ > + uint8_t traffic_class; > + /**< Traffic class ID. Traffic class 0 > + * is the highest priority traffic class. > + */ > + uint8_t color; > + /**< Color. @see enum rte_color.*/ > + uint16_t reserved; /**< Reserved. */ > +}; /**< Hierarchical scheduler */ > + > +/** > + * enum for the tx_offload bit-fields lengths and offsets. > + * defines the layout of rte_mbuf tx_offload field. > + */ > +enum { > + RTE_MBUF_L2_LEN_BITS = 7, > + RTE_MBUF_L3_LEN_BITS = 9, > + RTE_MBUF_L4_LEN_BITS = 8, > + RTE_MBUF_TSO_SEGSZ_BITS = 16, > + RTE_MBUF_OUTL3_LEN_BITS = 9, > + RTE_MBUF_OUTL2_LEN_BITS = 7, > + RTE_MBUF_TXOFLD_UNUSED_BITS = sizeof(uint64_t) * CHAR_BIT - > + RTE_MBUF_L2_LEN_BITS - > + RTE_MBUF_L3_LEN_BITS - > + RTE_MBUF_L4_LEN_BITS - > + RTE_MBUF_TSO_SEGSZ_BITS - > + RTE_MBUF_OUTL3_LEN_BITS - > + RTE_MBUF_OUTL2_LEN_BITS, > +#if RTE_BYTE_ORDER == RTE_BIG_ENDIAN > + RTE_MBUF_L2_LEN_OFS = > + sizeof(uint64_t) * CHAR_BIT - RTE_MBUF_L2_LEN_BITS, > + RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS - RTE_MBUF_L3_LEN_BITS, > + RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS - RTE_MBUF_L4_LEN_BITS, > + RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS - RTE_MBUF_TSO_SEGSZ_BITS, > + RTE_MBUF_OUTL3_LEN_OFS = > + RTE_MBUF_TSO_SEGSZ_OFS - RTE_MBUF_OUTL3_LEN_BITS, > + RTE_MBUF_OUTL2_LEN_OFS = > + RTE_MBUF_OUTL3_LEN_OFS - RTE_MBUF_OUTL2_LEN_BITS, > + RTE_MBUF_TXOFLD_UNUSED_OFS = > + RTE_MBUF_OUTL2_LEN_OFS - RTE_MBUF_TXOFLD_UNUSED_BITS, > +#else > + RTE_MBUF_L2_LEN_OFS = 0, > + RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS + RTE_MBUF_L2_LEN_BITS, > + RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS + RTE_MBUF_L3_LEN_BITS, > + RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS + RTE_MBUF_L4_LEN_BITS, > + RTE_MBUF_OUTL3_LEN_OFS = > + RTE_MBUF_TSO_SEGSZ_OFS + RTE_MBUF_TSO_SEGSZ_BITS, > + RTE_MBUF_OUTL2_LEN_OFS = > + RTE_MBUF_OUTL3_LEN_OFS + RTE_MBUF_OUTL3_LEN_BITS, > + RTE_MBUF_TXOFLD_UNUSED_OFS = > + RTE_MBUF_OUTL2_LEN_OFS + RTE_MBUF_OUTL2_LEN_BITS, > +#endif > +}; > + > +/** > + * The generic rte_mbuf, containing a packet mbuf. > + */ > +struct rte_mbuf { > + MARKER cacheline0; > + > + void *buf_addr; /**< Virtual address of segment buffer. */ > + /** > + * Physical address of segment buffer. > + * Force alignment to 8-bytes, so as to ensure we have the exact > + * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes > + * working on vector drivers easier. > + */ > + RTE_STD_C11 > + union { > + rte_iova_t buf_iova; > + rte_iova_t buf_physaddr; /**< deprecated */ > + } __rte_aligned(sizeof(rte_iova_t)); > + > + /* next 8 bytes are initialised on RX descriptor rearm */ > + MARKER64 rearm_data; > + uint16_t data_off; > + > + /** > + * Reference counter. Its size should at least equal to the size > + * of port field (16 bits), to support zero-copy broadcast. > + * It should only be accessed using the following functions: > + * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and > + * rte_mbuf_refcnt_set(). The functionality of these functions (atomic, > + * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC > + * config option. > + */ > + RTE_STD_C11 > + union { > + rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */ > + /** Non-atomically accessed refcnt */ > + uint16_t refcnt; > + }; > + uint16_t nb_segs; /**< Number of segments. */ > + > + /** Input port (16 bits to support more than 256 virtual ports). > + * The event eth Tx adapter uses this field to specify the output port. > + */ > + uint16_t port; > + > + uint64_t ol_flags; /**< Offload features. */ > + > + /* remaining bytes are set on RX when pulling packet from descriptor */ > + MARKER rx_descriptor_fields1; > + > + /* > + * The packet type, which is the combination of outer/inner L2, L3, L4 > + * and tunnel types. The packet_type is about data really present in the > + * mbuf. Example: if vlan stripping is enabled, a received vlan packet > + * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the > + * vlan is stripped from the data. > + */ > + RTE_STD_C11 > + union { > + uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */ > + struct { > + uint32_t l2_type:4; /**< (Outer) L2 type. */ > + uint32_t l3_type:4; /**< (Outer) L3 type. */ > + uint32_t l4_type:4; /**< (Outer) L4 type. */ > + uint32_t tun_type:4; /**< Tunnel type. */ > + RTE_STD_C11 > + union { > + uint8_t inner_esp_next_proto; > + /**< ESP next protocol type, valid if > + * RTE_PTYPE_TUNNEL_ESP tunnel type is set > + * on both Tx and Rx. > + */ > + __extension__ > + struct { > + uint8_t inner_l2_type:4; > + /**< Inner L2 type. */ > + uint8_t inner_l3_type:4; > + /**< Inner L3 type. */ > + }; > + }; > + uint32_t inner_l4_type:4; /**< Inner L4 type. */ > + }; > + }; > + > + uint32_t pkt_len; /**< Total pkt len: sum of all segments. */ > + uint16_t data_len; /**< Amount of data in segment buffer. */ > + /** VLAN TCI (CPU order), valid if PKT_RX_VLAN is set. */ > + uint16_t vlan_tci; > + > + RTE_STD_C11 > + union { > + union { > + uint32_t rss; /**< RSS hash result if RSS enabled */ > + struct { > + union { > + struct { > + uint16_t hash; > + uint16_t id; > + }; > + uint32_t lo; > + /**< Second 4 flexible bytes */ > + }; > + uint32_t hi; > + /**< First 4 flexible bytes or FD ID, dependent > + * on PKT_RX_FDIR_* flag in ol_flags. > + */ > + } fdir; /**< Filter identifier if FDIR enabled */ > + struct rte_mbuf_sched sched; > + /**< Hierarchical scheduler : 8 bytes */ > + struct { > + uint32_t reserved1; > + uint16_t reserved2; > + uint16_t txq; > + /**< The event eth Tx adapter uses this field > + * to store Tx queue id. > + * @see rte_event_eth_tx_adapter_txq_set() > + */ > + } txadapter; /**< Eventdev ethdev Tx adapter */ > + /**< User defined tags. See rte_distributor_process() */ > + uint32_t usr; > + } hash; /**< hash information */ > + struct { > + /** > + * Application specific metadata value > + * for egress flow rule match. > + * Valid if PKT_TX_METADATA is set. > + * Located here to allow conjunct use > + * with hash.sched.hi. > + */ > + uint32_t tx_metadata; > + uint32_t reserved; > + }; > + }; > + > + /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ is set. */ > + uint16_t vlan_tci_outer; > + > + uint16_t buf_len; /**< Length of segment buffer. */ > + > + /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference > + * are not normalized but are always the same for a given port. > + * Some devices allow to query rte_eth_read_clock that will return the > + * current device timestamp. > + */ > + uint64_t timestamp; > + > + /* second cache line - fields only used in slow path or on TX */ > + MARKER cacheline1 __rte_cache_min_aligned; > + > + RTE_STD_C11 > + union { > + void *userdata; /**< Can be used for external metadata */ > + uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */ > + }; > + > + struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */ > + struct rte_mbuf *next; /**< Next segment of scattered packet. */ > + > + /* fields to support TX offloads */ > + RTE_STD_C11 > + union { > + uint64_t tx_offload; /**< combined for easy fetch */ > + __extension__ > + struct { > + uint64_t l2_len:RTE_MBUF_L2_LEN_BITS; > + /**< L2 (MAC) Header Length for non-tunneling pkt. > + * Outer_L4_len + ... + Inner_L2_len for tunneling pkt. > + */ > + uint64_t l3_len:RTE_MBUF_L3_LEN_BITS; > + /**< L3 (IP) Header Length. */ > + uint64_t l4_len:RTE_MBUF_L4_LEN_BITS; > + /**< L4 (TCP/UDP) Header Length. */ > + uint64_t tso_segsz:RTE_MBUF_TSO_SEGSZ_BITS; > + /**< TCP TSO segment size */ > + > + /* > + * Fields for Tx offloading of tunnels. > + * These are undefined for packets which don't request > + * any tunnel offloads (outer IP or UDP checksum, > + * tunnel TSO). > + * > + * PMDs should not use these fields unconditionally > + * when calculating offsets. > + * > + * Applications are expected to set appropriate tunnel > + * offload flags when they fill in these fields. > + */ > + uint64_t outer_l3_len:RTE_MBUF_OUTL3_LEN_BITS; > + /**< Outer L3 (IP) Hdr Length. */ > + uint64_t outer_l2_len:RTE_MBUF_OUTL2_LEN_BITS; > + /**< Outer L2 (MAC) Hdr Length. */ > + > + /* uint64_t unused:RTE_MBUF_TXOFLD_UNUSED_BITS; */ > + }; > + }; > + > + /** Size of the application private data. In case of an indirect > + * mbuf, it stores the direct mbuf private data size. > + */ > + uint16_t priv_size; > + > + /** Timesync flags for use with IEEE1588. */ > + uint16_t timesync; > + > + /** Sequence number. See also rte_reorder_insert(). */ > + uint32_t seqn; > + > + /** Shared data for external buffer attached to mbuf. See > + * rte_pktmbuf_attach_extbuf(). > + */ > + struct rte_mbuf_ext_shared_info *shinfo; > + > +} __rte_cache_aligned; > + > +/** > + * Function typedef of callback to free externally attached buffer. > + */ > +typedef void (*rte_mbuf_extbuf_free_callback_t)(void *addr, void *opaque); > + > +/** > + * Shared data at the end of an external buffer. > + */ > +struct rte_mbuf_ext_shared_info { > + rte_mbuf_extbuf_free_callback_t free_cb; /**< Free callback function */ > + void *fcb_opaque; /**< Free callback argument */ > + rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */ > +}; > + > +/**< Maximum number of nb_segs allowed. */ > +#define RTE_MBUF_MAX_NB_SEGS UINT16_MAX > + > +/** > + * Returns TRUE if given mbuf is cloned by mbuf indirection, or FALSE > + * otherwise. > + * > + * If a mbuf has its data in another mbuf and references it by mbuf > + * indirection, this mbuf can be defined as a cloned mbuf. > + */ > +#define RTE_MBUF_CLONED(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF) > + > +/** > + * Returns TRUE if given mbuf has an external buffer, or FALSE otherwise. > + * > + * External buffer is a user-provided anonymous buffer. > + */ > +#define RTE_MBUF_HAS_EXTBUF(mb) ((mb)->ol_flags & EXT_ATTACHED_MBUF) > + > +/** > + * Returns TRUE if given mbuf is direct, or FALSE otherwise. > + * > + * If a mbuf embeds its own data after the rte_mbuf structure, this mbuf > + * can be defined as a direct mbuf. > + */ > +#define RTE_MBUF_DIRECT(mb) \ > + (!((mb)->ol_flags & (IND_ATTACHED_MBUF | EXT_ATTACHED_MBUF))) > + > +#define MBUF_INVALID_PORT UINT16_MAX > + > +/** > + * A macro that points to an offset into the data in the mbuf. > + * > + * The returned pointer is cast to type t. Before using this > + * function, the user must ensure that the first segment is large > + * enough to accommodate its data. > + * > + * @param m > + * The packet mbuf. > + * @param o > + * The offset into the mbuf data. > + * @param t > + * The type to cast the result into. > + */ > +#define rte_pktmbuf_mtod_offset(m, t, o) \ > + ((t)((char *)(m)->buf_addr + (m)->data_off + (o))) > + > +/** > + * A macro that points to the start of the data in the mbuf. > + * > + * The returned pointer is cast to type t. Before using this > + * function, the user must ensure that the first segment is large > + * enough to accommodate its data. > + * > + * @param m > + * The packet mbuf. > + * @param t > + * The type to cast the result into. > + */ > +#define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0) > + > +/** > + * A macro that returns the IO address that points to an offset of the > + * start of the data in the mbuf > + * > + * @param m > + * The packet mbuf. > + * @param o > + * The offset into the data to calculate address from. > + */ > +#define rte_pktmbuf_iova_offset(m, o) \ > + (rte_iova_t)((m)->buf_iova + (m)->data_off + (o)) > + > +/** > + * A macro that returns the IO address that points to the start of the > + * data in the mbuf > + * > + * @param m > + * The packet mbuf. > + */ > +#define rte_pktmbuf_iova(m) rte_pktmbuf_iova_offset(m, 0) > + > +#ifdef __cplusplus > +} > +#endif > + > +#endif /* _RTE_MBUF_CORE_H_ */ > ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [dpdk-dev] [PATCH v2 2/3] mbuf: move mbuf definition into a separate file 2019-09-27 13:50 ` [dpdk-dev] [PATCH v2 2/3] mbuf: move mbuf definition into a separate file Konstantin Ananyev 2019-09-27 14:42 ` Andrew Rybchenko 2019-09-30 19:34 ` Michel Machado @ 2019-10-16 8:18 ` Olivier Matz 2 siblings, 0 replies; 17+ messages in thread From: Olivier Matz @ 2019-10-16 8:18 UTC (permalink / raw) To: Konstantin Ananyev; +Cc: dev, michel, anatoly.burakov, vipin.varghese On Fri, Sep 27, 2019 at 02:50:53PM +0100, Konstantin Ananyev wrote: > Right now inclusion of rte_mbuf.h header can cause inclusion of > some arch/os specific headers. > That prevents it to be included directly by some > non-DPDK (but related) entities: KNI, BPF programs, etc. > To overcome that problem usually a separate definitions of rte_mbuf > structure is created within these entities. > That aproach has a lot of drawbacks: code duplication, error prone, etc. > This patch moves rte_mbuf structure definition (and some related macros) > into a separate file that can be included by both rte_mbuf.h and > other non-DPDK entities. > > Note that it doesn't introduce any change for current DPDK code. > > Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com> Acked-by: Olivier Matz <olivier.matz@6wind.com> ^ permalink raw reply [flat|nested] 17+ messages in thread
* [dpdk-dev] [PATCH v2 3/3] examples/bpf: remove duplicate mbuf definition 2019-09-27 13:50 ` [dpdk-dev] [PATCH v2 0/3] move mbuf definition into a separate file Konstantin Ananyev 2019-09-27 13:50 ` [dpdk-dev] [PATCH v2 1/3] eal: move CACHE and IOVA related definitions Konstantin Ananyev 2019-09-27 13:50 ` [dpdk-dev] [PATCH v2 2/3] mbuf: move mbuf definition into a separate file Konstantin Ananyev @ 2019-09-27 13:50 ` Konstantin Ananyev 2019-09-30 19:35 ` Michel Machado 2019-10-25 20:33 ` [dpdk-dev] [PATCH v2 0/3] move mbuf definition into a separate file Thomas Monjalon 3 siblings, 1 reply; 17+ messages in thread From: Konstantin Ananyev @ 2019-09-27 13:50 UTC (permalink / raw) To: dev Cc: michel, olivier.matz, anatoly.burakov, vipin.varghese, Konstantin Ananyev Get rid of duplicate definitions for rte_mbuf and related macros. Include rte_mbuf_core.h instead. Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com> --- examples/bpf/mbuf.h | 605 -------------------------------------------- examples/bpf/t2.c | 4 +- examples/bpf/t3.c | 2 +- 3 files changed, 3 insertions(+), 608 deletions(-) delete mode 100644 examples/bpf/mbuf.h diff --git a/examples/bpf/mbuf.h b/examples/bpf/mbuf.h deleted file mode 100644 index e41c3d26e..000000000 --- a/examples/bpf/mbuf.h +++ /dev/null @@ -1,605 +0,0 @@ -/* SPDX-License-Identifier: BSD-3-Clause - * Copyright(c) 2010-2014 Intel Corporation. - * Copyright 2014 6WIND S.A. - */ - -/* - * Snipper from dpdk.org rte_mbuf.h. - * used to provide BPF programs information about rte_mbuf layout. - */ - -#ifndef _MBUF_H_ -#define _MBUF_H_ - -#include <stdint.h> -#include <rte_common.h> - -#ifdef __cplusplus -extern "C" { -#endif - -/* - * Packet Offload Features Flags. It also carry packet type information. - * Critical resources. Both rx/tx shared these bits. Be cautious on any change - * - * - RX flags start at bit position zero, and get added to the left of previous - * flags. - * - The most-significant 3 bits are reserved for generic mbuf flags - * - TX flags therefore start at bit position 60 (i.e. 63-3), and new flags get - * added to the right of the previously defined flags i.e. they should count - * downwards, not upwards. - * - * Keep these flags synchronized with rte_get_rx_ol_flag_name() and - * rte_get_tx_ol_flag_name(). - */ - -/** - * RX packet is a 802.1q VLAN packet. This flag was set by PMDs when - * the packet is recognized as a VLAN, but the behavior between PMDs - * was not the same. This flag is kept for some time to avoid breaking - * applications and should be replaced by PKT_RX_VLAN_STRIPPED. - */ -#define PKT_RX_VLAN_PKT (1ULL << 0) - -#define PKT_RX_RSS_HASH (1ULL << 1) -/**< RX packet with RSS hash result. */ -#define PKT_RX_FDIR (1ULL << 2) -/**< RX packet with FDIR match indicate. */ - -/** - * Deprecated. - * Checking this flag alone is deprecated: check the 2 bits of - * PKT_RX_L4_CKSUM_MASK. - * This flag was set when the L4 checksum of a packet was detected as - * wrong by the hardware. - */ -#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) - -/** - * Deprecated. - * Checking this flag alone is deprecated: check the 2 bits of - * PKT_RX_IP_CKSUM_MASK. - * This flag was set when the IP checksum of a packet was detected as - * wrong by the hardware. - */ -#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) - -#define PKT_RX_EIP_CKSUM_BAD (1ULL << 5) -/**< External IP header checksum error. */ - -/** - * A vlan has been stripped by the hardware and its tci is saved in - * mbuf->vlan_tci. This can only happen if vlan stripping is enabled - * in the RX configuration of the PMD. - */ -#define PKT_RX_VLAN_STRIPPED (1ULL << 6) - -/** - * Mask of bits used to determine the status of RX IP checksum. - * - PKT_RX_IP_CKSUM_UNKNOWN: no information about the RX IP checksum - * - PKT_RX_IP_CKSUM_BAD: the IP checksum in the packet is wrong - * - PKT_RX_IP_CKSUM_GOOD: the IP checksum in the packet is valid - * - PKT_RX_IP_CKSUM_NONE: the IP checksum is not correct in the packet - * data, but the integrity of the IP header is verified. - */ -#define PKT_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7)) - -#define PKT_RX_IP_CKSUM_UNKNOWN 0 -#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) -#define PKT_RX_IP_CKSUM_GOOD (1ULL << 7) -#define PKT_RX_IP_CKSUM_NONE ((1ULL << 4) | (1ULL << 7)) - -/** - * Mask of bits used to determine the status of RX L4 checksum. - * - PKT_RX_L4_CKSUM_UNKNOWN: no information about the RX L4 checksum - * - PKT_RX_L4_CKSUM_BAD: the L4 checksum in the packet is wrong - * - PKT_RX_L4_CKSUM_GOOD: the L4 checksum in the packet is valid - * - PKT_RX_L4_CKSUM_NONE: the L4 checksum is not correct in the packet - * data, but the integrity of the L4 data is verified. - */ -#define PKT_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8)) - -#define PKT_RX_L4_CKSUM_UNKNOWN 0 -#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) -#define PKT_RX_L4_CKSUM_GOOD (1ULL << 8) -#define PKT_RX_L4_CKSUM_NONE ((1ULL << 3) | (1ULL << 8)) - -#define PKT_RX_IEEE1588_PTP (1ULL << 9) -/**< RX IEEE1588 L2 Ethernet PT Packet. */ -#define PKT_RX_IEEE1588_TMST (1ULL << 10) -/**< RX IEEE1588 L2/L4 timestamped packet.*/ -#define PKT_RX_FDIR_ID (1ULL << 13) -/**< FD id reported if FDIR match. */ -#define PKT_RX_FDIR_FLX (1ULL << 14) -/**< Flexible bytes reported if FDIR match. */ - -/** - * The 2 vlans have been stripped by the hardware and their tci are - * saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer). - * This can only happen if vlan stripping is enabled in the RX - * configuration of the PMD. If this flag is set, PKT_RX_VLAN_STRIPPED - * must also be set. - */ -#define PKT_RX_QINQ_STRIPPED (1ULL << 15) - -/** - * Deprecated. - * RX packet with double VLAN stripped. - * This flag is replaced by PKT_RX_QINQ_STRIPPED. - */ -#define PKT_RX_QINQ_PKT PKT_RX_QINQ_STRIPPED - -/** - * When packets are coalesced by a hardware or virtual driver, this flag - * can be set in the RX mbuf, meaning that the m->tso_segsz field is - * valid and is set to the segment size of original packets. - */ -#define PKT_RX_LRO (1ULL << 16) - -/** - * Indicate that the timestamp field in the mbuf is valid. - */ -#define PKT_RX_TIMESTAMP (1ULL << 17) - -/* add new RX flags here */ - -/* add new TX flags here */ - -/** - * Offload the MACsec. This flag must be set by the application to enable - * this offload feature for a packet to be transmitted. - */ -#define PKT_TX_MACSEC (1ULL << 44) - -/** - * Bits 45:48 used for the tunnel type. - * When doing Tx offload like TSO or checksum, the HW needs to configure the - * tunnel type into the HW descriptors. - */ -#define PKT_TX_TUNNEL_VXLAN (0x1ULL << 45) -#define PKT_TX_TUNNEL_GRE (0x2ULL << 45) -#define PKT_TX_TUNNEL_IPIP (0x3ULL << 45) -#define PKT_TX_TUNNEL_GENEVE (0x4ULL << 45) -/**< TX packet with MPLS-in-UDP RFC 7510 header. */ -#define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45) -/* add new TX TUNNEL type here */ -#define PKT_TX_TUNNEL_MASK (0xFULL << 45) - -/** - * Second VLAN insertion (QinQ) flag. - */ -#define PKT_TX_QINQ_PKT (1ULL << 49) -/**< TX packet with double VLAN inserted. */ - -/** - * TCP segmentation offload. To enable this offload feature for a - * packet to be transmitted on hardware supporting TSO: - * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies - * PKT_TX_TCP_CKSUM) - * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 - * - if it's IPv4, set the PKT_TX_IP_CKSUM flag and write the IP checksum - * to 0 in the packet - * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz - * - calculate the pseudo header checksum without taking ip_len in account, - * and set it in the TCP header. Refer to rte_ipv4_phdr_cksum() and - * rte_ipv6_phdr_cksum() that can be used as helpers. - */ -#define PKT_TX_TCP_SEG (1ULL << 50) - -#define PKT_TX_IEEE1588_TMST (1ULL << 51) -/**< TX IEEE1588 packet to timestamp. */ - -/** - * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved, - * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware - * L4 checksum offload, the user needs to: - * - fill l2_len and l3_len in mbuf - * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM - * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 - * - calculate the pseudo header checksum and set it in the L4 header (only - * for TCP or UDP). See rte_ipv4_phdr_cksum() and rte_ipv6_phdr_cksum(). - * For SCTP, set the crc field to 0. - */ -#define PKT_TX_L4_NO_CKSUM (0ULL << 52) -/**< Disable L4 cksum of TX pkt. */ -#define PKT_TX_TCP_CKSUM (1ULL << 52) -/**< TCP cksum of TX pkt. computed by NIC. */ -#define PKT_TX_SCTP_CKSUM (2ULL << 52) -/**< SCTP cksum of TX pkt. computed by NIC. */ -#define PKT_TX_UDP_CKSUM (3ULL << 52) -/**< UDP cksum of TX pkt. computed by NIC. */ -#define PKT_TX_L4_MASK (3ULL << 52) -/**< Mask for L4 cksum offload request. */ - -/** - * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should - * also be set by the application, although a PMD will only check - * PKT_TX_IP_CKSUM. - * - set the IP checksum field in the packet to 0 - * - fill the mbuf offload information: l2_len, l3_len - */ -#define PKT_TX_IP_CKSUM (1ULL << 54) - -/** - * Packet is IPv4. This flag must be set when using any offload feature - * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4 - * packet. If the packet is a tunneled packet, this flag is related to - * the inner headers. - */ -#define PKT_TX_IPV4 (1ULL << 55) - -/** - * Packet is IPv6. This flag must be set when using an offload feature - * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6 - * packet. If the packet is a tunneled packet, this flag is related to - * the inner headers. - */ -#define PKT_TX_IPV6 (1ULL << 56) - -#define PKT_TX_VLAN_PKT (1ULL << 57) -/**< TX packet is a 802.1q VLAN packet. */ - -/** - * Offload the IP checksum of an external header in the hardware. The - * flag PKT_TX_OUTER_IPV4 should also be set by the application, alto ugh - * a PMD will only check PKT_TX_IP_CKSUM. The IP checksum field in the - * packet must be set to 0. - * - set the outer IP checksum field in the packet to 0 - * - fill the mbuf offload information: outer_l2_len, outer_l3_len - */ -#define PKT_TX_OUTER_IP_CKSUM (1ULL << 58) - -/** - * Packet outer header is IPv4. This flag must be set when using any - * outer offload feature (L3 or L4 checksum) to tell the NIC that the - * outer header of the tunneled packet is an IPv4 packet. - */ -#define PKT_TX_OUTER_IPV4 (1ULL << 59) - -/** - * Packet outer header is IPv6. This flag must be set when using any - * outer offload feature (L4 checksum) to tell the NIC that the outer - * header of the tunneled packet is an IPv6 packet. - */ -#define PKT_TX_OUTER_IPV6 (1ULL << 60) - -/** - * Bitmask of all supported packet Tx offload features flags, - * which can be set for packet. - */ -#define PKT_TX_OFFLOAD_MASK ( \ - PKT_TX_IP_CKSUM | \ - PKT_TX_L4_MASK | \ - PKT_TX_OUTER_IP_CKSUM | \ - PKT_TX_TCP_SEG | \ - PKT_TX_IEEE1588_TMST | \ - PKT_TX_QINQ_PKT | \ - PKT_TX_VLAN_PKT | \ - PKT_TX_TUNNEL_MASK | \ - PKT_TX_MACSEC) - -#define __RESERVED (1ULL << 61) /**< reserved for future mbuf use */ - -#define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */ - -/* Use final bit of flags to indicate a control mbuf */ -#define CTRL_MBUF_FLAG (1ULL << 63) /**< Mbuf contains control data */ - -/** Alignment constraint of mbuf private area. */ -#define RTE_MBUF_PRIV_ALIGN 8 - -/** - * Get the name of a RX offload flag - * - * @param mask - * The mask describing the flag. - * @return - * The name of this flag, or NULL if it's not a valid RX flag. - */ -const char *rte_get_rx_ol_flag_name(uint64_t mask); - -/** - * Dump the list of RX offload flags in a buffer - * - * @param mask - * The mask describing the RX flags. - * @param buf - * The output buffer. - * @param buflen - * The length of the buffer. - * @return - * 0 on success, (-1) on error. - */ -int rte_get_rx_ol_flag_list(uint64_t mask, char *buf, size_t buflen); - -/** - * Get the name of a TX offload flag - * - * @param mask - * The mask describing the flag. Usually only one bit must be set. - * Several bits can be given if they belong to the same mask. - * Ex: PKT_TX_L4_MASK. - * @return - * The name of this flag, or NULL if it's not a valid TX flag. - */ -const char *rte_get_tx_ol_flag_name(uint64_t mask); - -/** - * Dump the list of TX offload flags in a buffer - * - * @param mask - * The mask describing the TX flags. - * @param buf - * The output buffer. - * @param buflen - * The length of the buffer. - * @return - * 0 on success, (-1) on error. - */ -int rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen); - -/** - * Some NICs need at least 2KB buffer to RX standard Ethernet frame without - * splitting it into multiple segments. - * So, for mbufs that planned to be involved into RX/TX, the recommended - * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM. - */ -#define RTE_MBUF_DEFAULT_DATAROOM 2048 -#define RTE_MBUF_DEFAULT_BUF_SIZE \ - (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM) - -/* define a set of marker types that can be used to refer to set points in the - * mbuf. - */ -__extension__ -typedef void *MARKER[0]; /**< generic marker for a point in a structure */ -__extension__ -typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */ -__extension__ -typedef uint64_t MARKER64[0]; -/**< marker that allows us to overwrite 8 bytes with a single assignment */ - -typedef struct { - volatile int16_t cnt; /**< An internal counter value. */ -} rte_atomic16_t; - -#define RTE_CACHE_LINE_MIN_SIZE 64 /**< Minimum Cache line size. */ - -/** - * Force minimum cache line alignment. - */ -#define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE) - -/** - * IO virtual address type. - * When the physical addressing mode (IOVA as PA) is in use, - * the translation from an IO virtual address (IOVA) to a physical address - * is a direct mapping, i.e. the same value. - * Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation. - */ -typedef uint64_t rte_iova_t; -#define RTE_BAD_IOVA ((rte_iova_t)-1) - -/** - * The generic rte_mbuf, containing a packet mbuf. - */ -struct rte_mbuf { - MARKER cacheline0; - - void *buf_addr; /**< Virtual address of segment buffer. */ - /** - * Physical address of segment buffer. - * Force alignment to 8-bytes, so as to ensure we have the exact - * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes - * working on vector drivers easier. - */ - RTE_STD_C11 - union { - rte_iova_t buf_iova; - rte_iova_t buf_physaddr; /**< deprecated */ - } __rte_aligned(sizeof(rte_iova_t)); - - /* next 8 bytes are initialised on RX descriptor rearm */ - MARKER64 rearm_data; - uint16_t data_off; - - /** - * Reference counter. Its size should at least equal to the size - * of port field (16 bits), to support zero-copy broadcast. - * It should only be accessed using the following functions: - * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and - * rte_mbuf_refcnt_set(). The functionality of these functions (atomic, - * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC - * config option. - */ - RTE_STD_C11 - union { - rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */ - uint16_t refcnt; - /**< Non-atomically accessed refcnt */ - }; - uint16_t nb_segs; /**< Number of segments. */ - - /** Input port (16 bits to support more than 256 virtual ports). */ - uint16_t port; - - uint64_t ol_flags; /**< Offload features. */ - - /* remaining bytes are set on RX when pulling packet from descriptor */ - MARKER rx_descriptor_fields1; - - /* - * The packet type, which is the combination of outer/inner L2, L3, L4 - * and tunnel types. The packet_type is about data really present in the - * mbuf. Example: if vlan stripping is enabled, a received vlan packet - * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the - * vlan is stripped from the data. - */ - RTE_STD_C11 - union { - uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */ - struct { - uint32_t l2_type:4; /**< (Outer) L2 type. */ - uint32_t l3_type:4; /**< (Outer) L3 type. */ - uint32_t l4_type:4; /**< (Outer) L4 type. */ - uint32_t tun_type:4; /**< Tunnel type. */ - uint32_t inner_l2_type:4; /**< Inner L2 type. */ - uint32_t inner_l3_type:4; /**< Inner L3 type. */ - uint32_t inner_l4_type:4; /**< Inner L4 type. */ - }; - }; - - uint32_t pkt_len; /**< Total pkt len: sum of all segments. */ - uint16_t data_len; /**< Amount of data in segment buffer. */ - /** VLAN TCI (CPU order), valid if PKT_RX_VLAN_STRIPPED is set. */ - uint16_t vlan_tci; - - union { - uint32_t rss; /**< RSS hash result if RSS enabled */ - struct { - RTE_STD_C11 - union { - struct { - uint16_t hash; - uint16_t id; - }; - uint32_t lo; - /**< Second 4 flexible bytes */ - }; - uint32_t hi; - /**< First 4 flexible bytes or FD ID, dependent on - * PKT_RX_FDIR_* flag in ol_flags. - */ - } fdir; /**< Filter identifier if FDIR enabled */ - struct { - uint32_t lo; - uint32_t hi; - } sched; /**< Hierarchical scheduler */ - uint32_t usr; - /**< User defined tags. See rte_distributor_process() */ - } hash; /**< hash information */ - - /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ_STRIPPED is set. */ - uint16_t vlan_tci_outer; - - uint16_t buf_len; /**< Length of segment buffer. */ - - /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference - * are not normalized but are always the same for a given port. - */ - uint64_t timestamp; - - /* second cache line - fields only used in slow path or on TX */ - MARKER cacheline1 __rte_cache_min_aligned; - - RTE_STD_C11 - union { - void *userdata; /**< Can be used for external metadata */ - uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */ - }; - - struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */ - struct rte_mbuf *next; /**< Next segment of scattered packet. */ - - /* fields to support TX offloads */ - RTE_STD_C11 - union { - uint64_t tx_offload; /**< combined for easy fetch */ - __extension__ - struct { - uint64_t l2_len:7; - /**< L2 (MAC) Header Length for non-tunneling pkt. - * Outer_L4_len + ... + Inner_L2_len for tunneling pkt. - */ - uint64_t l3_len:9; /**< L3 (IP) Header Length. */ - uint64_t l4_len:8; /**< L4 (TCP/UDP) Header Length. */ - uint64_t tso_segsz:16; /**< TCP TSO segment size */ - - /* fields for TX offloading of tunnels */ - uint64_t outer_l3_len:9; - /**< Outer L3 (IP) Hdr Length. */ - uint64_t outer_l2_len:7; - /**< Outer L2 (MAC) Hdr Length. */ - - /* uint64_t unused:8; */ - }; - }; - - /** Size of the application private data. In case of an indirect - * mbuf, it stores the direct mbuf private data size. - */ - uint16_t priv_size; - - /** Timesync flags for use with IEEE1588. */ - uint16_t timesync; - - /** Sequence number. See also rte_reorder_insert(). */ - uint32_t seqn; - -} __rte_cache_aligned; - - -/** - * Returns TRUE if given mbuf is cloned by mbuf indirection, or FALSE - * otherwise. - * - * If a mbuf has its data in another mbuf and references it by mbuf - * indirection, this mbuf can be defined as a cloned mbuf. - */ -#define RTE_MBUF_CLONED(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF) - -/** - * Returns TRUE if given mbuf is direct, or FALSE otherwise. - * - * If a mbuf embeds its own data after the rte_mbuf structure, this mbuf - * can be defined as a direct mbuf. - */ -#define RTE_MBUF_DIRECT(mb) (!RTE_MBUF_CLONED(mb)) - -/** - * Private data in case of pktmbuf pool. - * - * A structure that contains some pktmbuf_pool-specific data that are - * appended after the mempool structure (in private data). - */ -struct rte_pktmbuf_pool_private { - uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf. */ - uint16_t mbuf_priv_size; /**< Size of private area in each mbuf. */ -}; - -/** - * A macro that points to an offset into the data in the mbuf. - * - * The returned pointer is cast to type t. Before using this - * function, the user must ensure that the first segment is large - * enough to accommodate its data. - * - * @param m - * The packet mbuf. - * @param o - * The offset into the mbuf data. - * @param t - * The type to cast the result into. - */ -#define rte_pktmbuf_mtod_offset(m, t, o) \ - ((t)((char *)(m)->buf_addr + (m)->data_off + (o))) - -/** - * A macro that points to the start of the data in the mbuf. - * - * The returned pointer is cast to type t. Before using this - * function, the user must ensure that the first segment is large - * enough to accommodate its data. - * - * @param m - * The packet mbuf. - * @param t - * The type to cast the result into. - */ -#define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0) - -#ifdef __cplusplus -} -#endif - -#endif /* _MBUF_H_ */ diff --git a/examples/bpf/t2.c b/examples/bpf/t2.c index 69d7a4fe1..9878eaf7b 100644 --- a/examples/bpf/t2.c +++ b/examples/bpf/t2.c @@ -16,7 +16,7 @@ #include <stdint.h> #include <stddef.h> #include <rte_config.h> -#include "mbuf.h" +#include <rte_mbuf_core.h> uint64_t entry(void *pkt) @@ -25,7 +25,7 @@ entry(void *pkt) mb = pkt; mb->vlan_tci = 0; - mb->ol_flags &= ~(PKT_RX_VLAN_PKT | PKT_RX_VLAN_STRIPPED); + mb->ol_flags &= ~(PKT_RX_VLAN | PKT_RX_VLAN_STRIPPED); return 1; } diff --git a/examples/bpf/t3.c b/examples/bpf/t3.c index 9ba34638a..f58ff64b3 100644 --- a/examples/bpf/t3.c +++ b/examples/bpf/t3.c @@ -22,7 +22,7 @@ #include <stdio.h> #include <net/ethernet.h> #include <rte_config.h> -#include "mbuf.h" +#include <rte_mbuf_core.h> #include <arpa/inet.h> extern void rte_pktmbuf_dump(FILE *, const struct rte_mbuf *, unsigned int); -- 2.17.1 ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [dpdk-dev] [PATCH v2 3/3] examples/bpf: remove duplicate mbuf definition 2019-09-27 13:50 ` [dpdk-dev] [PATCH v2 3/3] examples/bpf: remove duplicate mbuf definition Konstantin Ananyev @ 2019-09-30 19:35 ` Michel Machado 0 siblings, 0 replies; 17+ messages in thread From: Michel Machado @ 2019-09-30 19:35 UTC (permalink / raw) To: Konstantin Ananyev, dev; +Cc: olivier.matz, anatoly.burakov, vipin.varghese Acked-by: Michel Machado <michel@digirati.com.br> [ ]'s Michel Machado On 9/27/19 9:50 AM, Konstantin Ananyev wrote: > Get rid of duplicate definitions for rte_mbuf and related macros. > Include rte_mbuf_core.h instead. > > Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com> > --- > examples/bpf/mbuf.h | 605 -------------------------------------------- > examples/bpf/t2.c | 4 +- > examples/bpf/t3.c | 2 +- > 3 files changed, 3 insertions(+), 608 deletions(-) > delete mode 100644 examples/bpf/mbuf.h > > diff --git a/examples/bpf/mbuf.h b/examples/bpf/mbuf.h > deleted file mode 100644 > index e41c3d26e..000000000 > --- a/examples/bpf/mbuf.h > +++ /dev/null > @@ -1,605 +0,0 @@ > -/* SPDX-License-Identifier: BSD-3-Clause > - * Copyright(c) 2010-2014 Intel Corporation. > - * Copyright 2014 6WIND S.A. > - */ > - > -/* > - * Snipper from dpdk.org rte_mbuf.h. > - * used to provide BPF programs information about rte_mbuf layout. > - */ > - > -#ifndef _MBUF_H_ > -#define _MBUF_H_ > - > -#include <stdint.h> > -#include <rte_common.h> > - > -#ifdef __cplusplus > -extern "C" { > -#endif > - > -/* > - * Packet Offload Features Flags. It also carry packet type information. > - * Critical resources. Both rx/tx shared these bits. Be cautious on any change > - * > - * - RX flags start at bit position zero, and get added to the left of previous > - * flags. > - * - The most-significant 3 bits are reserved for generic mbuf flags > - * - TX flags therefore start at bit position 60 (i.e. 63-3), and new flags get > - * added to the right of the previously defined flags i.e. they should count > - * downwards, not upwards. > - * > - * Keep these flags synchronized with rte_get_rx_ol_flag_name() and > - * rte_get_tx_ol_flag_name(). > - */ > - > -/** > - * RX packet is a 802.1q VLAN packet. This flag was set by PMDs when > - * the packet is recognized as a VLAN, but the behavior between PMDs > - * was not the same. This flag is kept for some time to avoid breaking > - * applications and should be replaced by PKT_RX_VLAN_STRIPPED. > - */ > -#define PKT_RX_VLAN_PKT (1ULL << 0) > - > -#define PKT_RX_RSS_HASH (1ULL << 1) > -/**< RX packet with RSS hash result. */ > -#define PKT_RX_FDIR (1ULL << 2) > -/**< RX packet with FDIR match indicate. */ > - > -/** > - * Deprecated. > - * Checking this flag alone is deprecated: check the 2 bits of > - * PKT_RX_L4_CKSUM_MASK. > - * This flag was set when the L4 checksum of a packet was detected as > - * wrong by the hardware. > - */ > -#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) > - > -/** > - * Deprecated. > - * Checking this flag alone is deprecated: check the 2 bits of > - * PKT_RX_IP_CKSUM_MASK. > - * This flag was set when the IP checksum of a packet was detected as > - * wrong by the hardware. > - */ > -#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) > - > -#define PKT_RX_EIP_CKSUM_BAD (1ULL << 5) > -/**< External IP header checksum error. */ > - > -/** > - * A vlan has been stripped by the hardware and its tci is saved in > - * mbuf->vlan_tci. This can only happen if vlan stripping is enabled > - * in the RX configuration of the PMD. > - */ > -#define PKT_RX_VLAN_STRIPPED (1ULL << 6) > - > -/** > - * Mask of bits used to determine the status of RX IP checksum. > - * - PKT_RX_IP_CKSUM_UNKNOWN: no information about the RX IP checksum > - * - PKT_RX_IP_CKSUM_BAD: the IP checksum in the packet is wrong > - * - PKT_RX_IP_CKSUM_GOOD: the IP checksum in the packet is valid > - * - PKT_RX_IP_CKSUM_NONE: the IP checksum is not correct in the packet > - * data, but the integrity of the IP header is verified. > - */ > -#define PKT_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7)) > - > -#define PKT_RX_IP_CKSUM_UNKNOWN 0 > -#define PKT_RX_IP_CKSUM_BAD (1ULL << 4) > -#define PKT_RX_IP_CKSUM_GOOD (1ULL << 7) > -#define PKT_RX_IP_CKSUM_NONE ((1ULL << 4) | (1ULL << 7)) > - > -/** > - * Mask of bits used to determine the status of RX L4 checksum. > - * - PKT_RX_L4_CKSUM_UNKNOWN: no information about the RX L4 checksum > - * - PKT_RX_L4_CKSUM_BAD: the L4 checksum in the packet is wrong > - * - PKT_RX_L4_CKSUM_GOOD: the L4 checksum in the packet is valid > - * - PKT_RX_L4_CKSUM_NONE: the L4 checksum is not correct in the packet > - * data, but the integrity of the L4 data is verified. > - */ > -#define PKT_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8)) > - > -#define PKT_RX_L4_CKSUM_UNKNOWN 0 > -#define PKT_RX_L4_CKSUM_BAD (1ULL << 3) > -#define PKT_RX_L4_CKSUM_GOOD (1ULL << 8) > -#define PKT_RX_L4_CKSUM_NONE ((1ULL << 3) | (1ULL << 8)) > - > -#define PKT_RX_IEEE1588_PTP (1ULL << 9) > -/**< RX IEEE1588 L2 Ethernet PT Packet. */ > -#define PKT_RX_IEEE1588_TMST (1ULL << 10) > -/**< RX IEEE1588 L2/L4 timestamped packet.*/ > -#define PKT_RX_FDIR_ID (1ULL << 13) > -/**< FD id reported if FDIR match. */ > -#define PKT_RX_FDIR_FLX (1ULL << 14) > -/**< Flexible bytes reported if FDIR match. */ > - > -/** > - * The 2 vlans have been stripped by the hardware and their tci are > - * saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer). > - * This can only happen if vlan stripping is enabled in the RX > - * configuration of the PMD. If this flag is set, PKT_RX_VLAN_STRIPPED > - * must also be set. > - */ > -#define PKT_RX_QINQ_STRIPPED (1ULL << 15) > - > -/** > - * Deprecated. > - * RX packet with double VLAN stripped. > - * This flag is replaced by PKT_RX_QINQ_STRIPPED. > - */ > -#define PKT_RX_QINQ_PKT PKT_RX_QINQ_STRIPPED > - > -/** > - * When packets are coalesced by a hardware or virtual driver, this flag > - * can be set in the RX mbuf, meaning that the m->tso_segsz field is > - * valid and is set to the segment size of original packets. > - */ > -#define PKT_RX_LRO (1ULL << 16) > - > -/** > - * Indicate that the timestamp field in the mbuf is valid. > - */ > -#define PKT_RX_TIMESTAMP (1ULL << 17) > - > -/* add new RX flags here */ > - > -/* add new TX flags here */ > - > -/** > - * Offload the MACsec. This flag must be set by the application to enable > - * this offload feature for a packet to be transmitted. > - */ > -#define PKT_TX_MACSEC (1ULL << 44) > - > -/** > - * Bits 45:48 used for the tunnel type. > - * When doing Tx offload like TSO or checksum, the HW needs to configure the > - * tunnel type into the HW descriptors. > - */ > -#define PKT_TX_TUNNEL_VXLAN (0x1ULL << 45) > -#define PKT_TX_TUNNEL_GRE (0x2ULL << 45) > -#define PKT_TX_TUNNEL_IPIP (0x3ULL << 45) > -#define PKT_TX_TUNNEL_GENEVE (0x4ULL << 45) > -/**< TX packet with MPLS-in-UDP RFC 7510 header. */ > -#define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45) > -/* add new TX TUNNEL type here */ > -#define PKT_TX_TUNNEL_MASK (0xFULL << 45) > - > -/** > - * Second VLAN insertion (QinQ) flag. > - */ > -#define PKT_TX_QINQ_PKT (1ULL << 49) > -/**< TX packet with double VLAN inserted. */ > - > -/** > - * TCP segmentation offload. To enable this offload feature for a > - * packet to be transmitted on hardware supporting TSO: > - * - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies > - * PKT_TX_TCP_CKSUM) > - * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 > - * - if it's IPv4, set the PKT_TX_IP_CKSUM flag and write the IP checksum > - * to 0 in the packet > - * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz > - * - calculate the pseudo header checksum without taking ip_len in account, > - * and set it in the TCP header. Refer to rte_ipv4_phdr_cksum() and > - * rte_ipv6_phdr_cksum() that can be used as helpers. > - */ > -#define PKT_TX_TCP_SEG (1ULL << 50) > - > -#define PKT_TX_IEEE1588_TMST (1ULL << 51) > -/**< TX IEEE1588 packet to timestamp. */ > - > -/** > - * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved, > - * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware > - * L4 checksum offload, the user needs to: > - * - fill l2_len and l3_len in mbuf > - * - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM > - * - set the flag PKT_TX_IPV4 or PKT_TX_IPV6 > - * - calculate the pseudo header checksum and set it in the L4 header (only > - * for TCP or UDP). See rte_ipv4_phdr_cksum() and rte_ipv6_phdr_cksum(). > - * For SCTP, set the crc field to 0. > - */ > -#define PKT_TX_L4_NO_CKSUM (0ULL << 52) > -/**< Disable L4 cksum of TX pkt. */ > -#define PKT_TX_TCP_CKSUM (1ULL << 52) > -/**< TCP cksum of TX pkt. computed by NIC. */ > -#define PKT_TX_SCTP_CKSUM (2ULL << 52) > -/**< SCTP cksum of TX pkt. computed by NIC. */ > -#define PKT_TX_UDP_CKSUM (3ULL << 52) > -/**< UDP cksum of TX pkt. computed by NIC. */ > -#define PKT_TX_L4_MASK (3ULL << 52) > -/**< Mask for L4 cksum offload request. */ > - > -/** > - * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should > - * also be set by the application, although a PMD will only check > - * PKT_TX_IP_CKSUM. > - * - set the IP checksum field in the packet to 0 > - * - fill the mbuf offload information: l2_len, l3_len > - */ > -#define PKT_TX_IP_CKSUM (1ULL << 54) > - > -/** > - * Packet is IPv4. This flag must be set when using any offload feature > - * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4 > - * packet. If the packet is a tunneled packet, this flag is related to > - * the inner headers. > - */ > -#define PKT_TX_IPV4 (1ULL << 55) > - > -/** > - * Packet is IPv6. This flag must be set when using an offload feature > - * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6 > - * packet. If the packet is a tunneled packet, this flag is related to > - * the inner headers. > - */ > -#define PKT_TX_IPV6 (1ULL << 56) > - > -#define PKT_TX_VLAN_PKT (1ULL << 57) > -/**< TX packet is a 802.1q VLAN packet. */ > - > -/** > - * Offload the IP checksum of an external header in the hardware. The > - * flag PKT_TX_OUTER_IPV4 should also be set by the application, alto ugh > - * a PMD will only check PKT_TX_IP_CKSUM. The IP checksum field in the > - * packet must be set to 0. > - * - set the outer IP checksum field in the packet to 0 > - * - fill the mbuf offload information: outer_l2_len, outer_l3_len > - */ > -#define PKT_TX_OUTER_IP_CKSUM (1ULL << 58) > - > -/** > - * Packet outer header is IPv4. This flag must be set when using any > - * outer offload feature (L3 or L4 checksum) to tell the NIC that the > - * outer header of the tunneled packet is an IPv4 packet. > - */ > -#define PKT_TX_OUTER_IPV4 (1ULL << 59) > - > -/** > - * Packet outer header is IPv6. This flag must be set when using any > - * outer offload feature (L4 checksum) to tell the NIC that the outer > - * header of the tunneled packet is an IPv6 packet. > - */ > -#define PKT_TX_OUTER_IPV6 (1ULL << 60) > - > -/** > - * Bitmask of all supported packet Tx offload features flags, > - * which can be set for packet. > - */ > -#define PKT_TX_OFFLOAD_MASK ( \ > - PKT_TX_IP_CKSUM | \ > - PKT_TX_L4_MASK | \ > - PKT_TX_OUTER_IP_CKSUM | \ > - PKT_TX_TCP_SEG | \ > - PKT_TX_IEEE1588_TMST | \ > - PKT_TX_QINQ_PKT | \ > - PKT_TX_VLAN_PKT | \ > - PKT_TX_TUNNEL_MASK | \ > - PKT_TX_MACSEC) > - > -#define __RESERVED (1ULL << 61) /**< reserved for future mbuf use */ > - > -#define IND_ATTACHED_MBUF (1ULL << 62) /**< Indirect attached mbuf */ > - > -/* Use final bit of flags to indicate a control mbuf */ > -#define CTRL_MBUF_FLAG (1ULL << 63) /**< Mbuf contains control data */ > - > -/** Alignment constraint of mbuf private area. */ > -#define RTE_MBUF_PRIV_ALIGN 8 > - > -/** > - * Get the name of a RX offload flag > - * > - * @param mask > - * The mask describing the flag. > - * @return > - * The name of this flag, or NULL if it's not a valid RX flag. > - */ > -const char *rte_get_rx_ol_flag_name(uint64_t mask); > - > -/** > - * Dump the list of RX offload flags in a buffer > - * > - * @param mask > - * The mask describing the RX flags. > - * @param buf > - * The output buffer. > - * @param buflen > - * The length of the buffer. > - * @return > - * 0 on success, (-1) on error. > - */ > -int rte_get_rx_ol_flag_list(uint64_t mask, char *buf, size_t buflen); > - > -/** > - * Get the name of a TX offload flag > - * > - * @param mask > - * The mask describing the flag. Usually only one bit must be set. > - * Several bits can be given if they belong to the same mask. > - * Ex: PKT_TX_L4_MASK. > - * @return > - * The name of this flag, or NULL if it's not a valid TX flag. > - */ > -const char *rte_get_tx_ol_flag_name(uint64_t mask); > - > -/** > - * Dump the list of TX offload flags in a buffer > - * > - * @param mask > - * The mask describing the TX flags. > - * @param buf > - * The output buffer. > - * @param buflen > - * The length of the buffer. > - * @return > - * 0 on success, (-1) on error. > - */ > -int rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen); > - > -/** > - * Some NICs need at least 2KB buffer to RX standard Ethernet frame without > - * splitting it into multiple segments. > - * So, for mbufs that planned to be involved into RX/TX, the recommended > - * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM. > - */ > -#define RTE_MBUF_DEFAULT_DATAROOM 2048 > -#define RTE_MBUF_DEFAULT_BUF_SIZE \ > - (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM) > - > -/* define a set of marker types that can be used to refer to set points in the > - * mbuf. > - */ > -__extension__ > -typedef void *MARKER[0]; /**< generic marker for a point in a structure */ > -__extension__ > -typedef uint8_t MARKER8[0]; /**< generic marker with 1B alignment */ > -__extension__ > -typedef uint64_t MARKER64[0]; > -/**< marker that allows us to overwrite 8 bytes with a single assignment */ > - > -typedef struct { > - volatile int16_t cnt; /**< An internal counter value. */ > -} rte_atomic16_t; > - > -#define RTE_CACHE_LINE_MIN_SIZE 64 /**< Minimum Cache line size. */ > - > -/** > - * Force minimum cache line alignment. > - */ > -#define __rte_cache_min_aligned __rte_aligned(RTE_CACHE_LINE_MIN_SIZE) > - > -/** > - * IO virtual address type. > - * When the physical addressing mode (IOVA as PA) is in use, > - * the translation from an IO virtual address (IOVA) to a physical address > - * is a direct mapping, i.e. the same value. > - * Otherwise, in virtual mode (IOVA as VA), an IOMMU may do the translation. > - */ > -typedef uint64_t rte_iova_t; > -#define RTE_BAD_IOVA ((rte_iova_t)-1) > - > -/** > - * The generic rte_mbuf, containing a packet mbuf. > - */ > -struct rte_mbuf { > - MARKER cacheline0; > - > - void *buf_addr; /**< Virtual address of segment buffer. */ > - /** > - * Physical address of segment buffer. > - * Force alignment to 8-bytes, so as to ensure we have the exact > - * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes > - * working on vector drivers easier. > - */ > - RTE_STD_C11 > - union { > - rte_iova_t buf_iova; > - rte_iova_t buf_physaddr; /**< deprecated */ > - } __rte_aligned(sizeof(rte_iova_t)); > - > - /* next 8 bytes are initialised on RX descriptor rearm */ > - MARKER64 rearm_data; > - uint16_t data_off; > - > - /** > - * Reference counter. Its size should at least equal to the size > - * of port field (16 bits), to support zero-copy broadcast. > - * It should only be accessed using the following functions: > - * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and > - * rte_mbuf_refcnt_set(). The functionality of these functions (atomic, > - * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC > - * config option. > - */ > - RTE_STD_C11 > - union { > - rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */ > - uint16_t refcnt; > - /**< Non-atomically accessed refcnt */ > - }; > - uint16_t nb_segs; /**< Number of segments. */ > - > - /** Input port (16 bits to support more than 256 virtual ports). */ > - uint16_t port; > - > - uint64_t ol_flags; /**< Offload features. */ > - > - /* remaining bytes are set on RX when pulling packet from descriptor */ > - MARKER rx_descriptor_fields1; > - > - /* > - * The packet type, which is the combination of outer/inner L2, L3, L4 > - * and tunnel types. The packet_type is about data really present in the > - * mbuf. Example: if vlan stripping is enabled, a received vlan packet > - * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the > - * vlan is stripped from the data. > - */ > - RTE_STD_C11 > - union { > - uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */ > - struct { > - uint32_t l2_type:4; /**< (Outer) L2 type. */ > - uint32_t l3_type:4; /**< (Outer) L3 type. */ > - uint32_t l4_type:4; /**< (Outer) L4 type. */ > - uint32_t tun_type:4; /**< Tunnel type. */ > - uint32_t inner_l2_type:4; /**< Inner L2 type. */ > - uint32_t inner_l3_type:4; /**< Inner L3 type. */ > - uint32_t inner_l4_type:4; /**< Inner L4 type. */ > - }; > - }; > - > - uint32_t pkt_len; /**< Total pkt len: sum of all segments. */ > - uint16_t data_len; /**< Amount of data in segment buffer. */ > - /** VLAN TCI (CPU order), valid if PKT_RX_VLAN_STRIPPED is set. */ > - uint16_t vlan_tci; > - > - union { > - uint32_t rss; /**< RSS hash result if RSS enabled */ > - struct { > - RTE_STD_C11 > - union { > - struct { > - uint16_t hash; > - uint16_t id; > - }; > - uint32_t lo; > - /**< Second 4 flexible bytes */ > - }; > - uint32_t hi; > - /**< First 4 flexible bytes or FD ID, dependent on > - * PKT_RX_FDIR_* flag in ol_flags. > - */ > - } fdir; /**< Filter identifier if FDIR enabled */ > - struct { > - uint32_t lo; > - uint32_t hi; > - } sched; /**< Hierarchical scheduler */ > - uint32_t usr; > - /**< User defined tags. See rte_distributor_process() */ > - } hash; /**< hash information */ > - > - /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ_STRIPPED is set. */ > - uint16_t vlan_tci_outer; > - > - uint16_t buf_len; /**< Length of segment buffer. */ > - > - /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference > - * are not normalized but are always the same for a given port. > - */ > - uint64_t timestamp; > - > - /* second cache line - fields only used in slow path or on TX */ > - MARKER cacheline1 __rte_cache_min_aligned; > - > - RTE_STD_C11 > - union { > - void *userdata; /**< Can be used for external metadata */ > - uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */ > - }; > - > - struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */ > - struct rte_mbuf *next; /**< Next segment of scattered packet. */ > - > - /* fields to support TX offloads */ > - RTE_STD_C11 > - union { > - uint64_t tx_offload; /**< combined for easy fetch */ > - __extension__ > - struct { > - uint64_t l2_len:7; > - /**< L2 (MAC) Header Length for non-tunneling pkt. > - * Outer_L4_len + ... + Inner_L2_len for tunneling pkt. > - */ > - uint64_t l3_len:9; /**< L3 (IP) Header Length. */ > - uint64_t l4_len:8; /**< L4 (TCP/UDP) Header Length. */ > - uint64_t tso_segsz:16; /**< TCP TSO segment size */ > - > - /* fields for TX offloading of tunnels */ > - uint64_t outer_l3_len:9; > - /**< Outer L3 (IP) Hdr Length. */ > - uint64_t outer_l2_len:7; > - /**< Outer L2 (MAC) Hdr Length. */ > - > - /* uint64_t unused:8; */ > - }; > - }; > - > - /** Size of the application private data. In case of an indirect > - * mbuf, it stores the direct mbuf private data size. > - */ > - uint16_t priv_size; > - > - /** Timesync flags for use with IEEE1588. */ > - uint16_t timesync; > - > - /** Sequence number. See also rte_reorder_insert(). */ > - uint32_t seqn; > - > -} __rte_cache_aligned; > - > - > -/** > - * Returns TRUE if given mbuf is cloned by mbuf indirection, or FALSE > - * otherwise. > - * > - * If a mbuf has its data in another mbuf and references it by mbuf > - * indirection, this mbuf can be defined as a cloned mbuf. > - */ > -#define RTE_MBUF_CLONED(mb) ((mb)->ol_flags & IND_ATTACHED_MBUF) > - > -/** > - * Returns TRUE if given mbuf is direct, or FALSE otherwise. > - * > - * If a mbuf embeds its own data after the rte_mbuf structure, this mbuf > - * can be defined as a direct mbuf. > - */ > -#define RTE_MBUF_DIRECT(mb) (!RTE_MBUF_CLONED(mb)) > - > -/** > - * Private data in case of pktmbuf pool. > - * > - * A structure that contains some pktmbuf_pool-specific data that are > - * appended after the mempool structure (in private data). > - */ > -struct rte_pktmbuf_pool_private { > - uint16_t mbuf_data_room_size; /**< Size of data space in each mbuf. */ > - uint16_t mbuf_priv_size; /**< Size of private area in each mbuf. */ > -}; > - > -/** > - * A macro that points to an offset into the data in the mbuf. > - * > - * The returned pointer is cast to type t. Before using this > - * function, the user must ensure that the first segment is large > - * enough to accommodate its data. > - * > - * @param m > - * The packet mbuf. > - * @param o > - * The offset into the mbuf data. > - * @param t > - * The type to cast the result into. > - */ > -#define rte_pktmbuf_mtod_offset(m, t, o) \ > - ((t)((char *)(m)->buf_addr + (m)->data_off + (o))) > - > -/** > - * A macro that points to the start of the data in the mbuf. > - * > - * The returned pointer is cast to type t. Before using this > - * function, the user must ensure that the first segment is large > - * enough to accommodate its data. > - * > - * @param m > - * The packet mbuf. > - * @param t > - * The type to cast the result into. > - */ > -#define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0) > - > -#ifdef __cplusplus > -} > -#endif > - > -#endif /* _MBUF_H_ */ > diff --git a/examples/bpf/t2.c b/examples/bpf/t2.c > index 69d7a4fe1..9878eaf7b 100644 > --- a/examples/bpf/t2.c > +++ b/examples/bpf/t2.c > @@ -16,7 +16,7 @@ > #include <stdint.h> > #include <stddef.h> > #include <rte_config.h> > -#include "mbuf.h" > +#include <rte_mbuf_core.h> > > uint64_t > entry(void *pkt) > @@ -25,7 +25,7 @@ entry(void *pkt) > > mb = pkt; > mb->vlan_tci = 0; > - mb->ol_flags &= ~(PKT_RX_VLAN_PKT | PKT_RX_VLAN_STRIPPED); > + mb->ol_flags &= ~(PKT_RX_VLAN | PKT_RX_VLAN_STRIPPED); > > return 1; > } > diff --git a/examples/bpf/t3.c b/examples/bpf/t3.c > index 9ba34638a..f58ff64b3 100644 > --- a/examples/bpf/t3.c > +++ b/examples/bpf/t3.c > @@ -22,7 +22,7 @@ > #include <stdio.h> > #include <net/ethernet.h> > #include <rte_config.h> > -#include "mbuf.h" > +#include <rte_mbuf_core.h> > #include <arpa/inet.h> > > extern void rte_pktmbuf_dump(FILE *, const struct rte_mbuf *, unsigned int); > ^ permalink raw reply [flat|nested] 17+ messages in thread
* Re: [dpdk-dev] [PATCH v2 0/3] move mbuf definition into a separate file 2019-09-27 13:50 ` [dpdk-dev] [PATCH v2 0/3] move mbuf definition into a separate file Konstantin Ananyev ` (2 preceding siblings ...) 2019-09-27 13:50 ` [dpdk-dev] [PATCH v2 3/3] examples/bpf: remove duplicate mbuf definition Konstantin Ananyev @ 2019-10-25 20:33 ` Thomas Monjalon 3 siblings, 0 replies; 17+ messages in thread From: Thomas Monjalon @ 2019-10-25 20:33 UTC (permalink / raw) To: Konstantin Ananyev Cc: dev, michel, olivier.matz, anatoly.burakov, vipin.varghese 27/09/2019 15:50, Konstantin Ananyev: > Konstantin Ananyev (3): > eal: move CACHE and IOVA related definitions > mbuf: move mbuf definition into a separate file > examples/bpf: remove duplicate mbuf definition Applied, thanks ^ permalink raw reply [flat|nested] 17+ messages in thread
end of thread, other threads:[~2019-10-25 20:33 UTC | newest] Thread overview: 17+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2019-08-16 12:53 [dpdk-dev] [PATCH 0/3] move mbuf definition into a separate file Konstantin Ananyev 2019-08-16 12:53 ` [dpdk-dev] [PATCH 1/3] eal: move CACHE and IOVA related definitions Konstantin Ananyev 2019-08-16 18:50 ` Michel Machado 2019-08-16 12:53 ` [dpdk-dev] [PATCH 2/3] mbuf: move mbuf definition into a separate file Konstantin Ananyev 2019-08-16 18:51 ` Michel Machado 2019-08-16 12:53 ` [dpdk-dev] [PATCH 3/3] examples/bpf: remove duplicate mbuf definition Konstantin Ananyev 2019-08-16 18:44 ` Michel Machado 2019-09-27 13:50 ` [dpdk-dev] [PATCH v2 0/3] move mbuf definition into a separate file Konstantin Ananyev 2019-09-27 13:50 ` [dpdk-dev] [PATCH v2 1/3] eal: move CACHE and IOVA related definitions Konstantin Ananyev 2019-09-30 19:34 ` Michel Machado 2019-09-27 13:50 ` [dpdk-dev] [PATCH v2 2/3] mbuf: move mbuf definition into a separate file Konstantin Ananyev 2019-09-27 14:42 ` Andrew Rybchenko 2019-09-30 19:34 ` Michel Machado 2019-10-16 8:18 ` Olivier Matz 2019-09-27 13:50 ` [dpdk-dev] [PATCH v2 3/3] examples/bpf: remove duplicate mbuf definition Konstantin Ananyev 2019-09-30 19:35 ` Michel Machado 2019-10-25 20:33 ` [dpdk-dev] [PATCH v2 0/3] move mbuf definition into a separate file Thomas Monjalon
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).