From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 54587A046B for ; Tue, 20 Aug 2019 17:07:58 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id E33251BF01; Tue, 20 Aug 2019 17:07:42 +0200 (CEST) Received: from mta114.f1.k8.com.br (mta114.f1.k8.com.br [187.73.32.186]) by dpdk.org (Postfix) with ESMTP id E88263423 for ; Fri, 16 Aug 2019 20:51:13 +0200 (CEST) Received: from [192.168.86.43] (pool-108-20-205-122.bstnma.fios.verizon.net [108.20.205.122]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtpz.f1.k8.com.br (Postfix) with ESMTPSA id CEA8A200BD; Fri, 16 Aug 2019 18:51:10 +0000 (UTC) X-DKIM: OpenDKIM Filter v2.6.8 smtpz.f1.k8.com.br CEA8A200BD DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=digirati.com.br; s=default; t=1565981472; bh=SKZsHH4RQvf+yZ/MnKyW+9IkGJ4I96Eulm//Uxe8ZzY=; h=Subject:To:From:Date:Feedback-ID; b=O+2bWleyzMRD/wTeZ2R9jd8W6F/fIpr9AY+alSzMBaDpxLD389gMt40SBJ7O50JKY tqKAfBN4YiKnsHxykytjW86u88KNyaN2Y/dz/J1yQDxLOA9gJdikqlImG1xRim3AaI 4rojSmImcnE86eEOKEyQTcVuNnvTE5bIhk3i1ntE= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=k8.com.br; s=default; t=1565981472; bh=SKZsHH4RQvf+yZ/MnKyW+9IkGJ4I96Eulm//Uxe8ZzY=; h=Subject:To:From:Date:Feedback-ID; b=Y8/V2fTVM7X4EkVqji8973cPPavltQ3BHOD8WxGQK7EPXolbqdhT7CAJfNijH/UL1 o+a7oe4Y6wAL2sUj8BTM96sS8jqf3+XJOYLjkzsHoL1UHWnTbPduEidt6yFwf7Y8vA 1+rqmPFea+ff5BmCpKLQC+coflY0o2KEMDgQ3PIA= To: Konstantin Ananyev , dev@dpdk.org Cc: olivier.matz@6wind.com, anatoly.burakov@intel.com, vipin.varghese@intel.com References: <20190816125304.29719-1-konstantin.ananyev@intel.com> <20190816125304.29719-3-konstantin.ananyev@intel.com> From: Michel Machado Organization: Digirati Internet LTDA. Message-ID: Date: Fri, 16 Aug 2019 14:51:08 -0400 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.8.0 MIME-Version: 1.0 In-Reply-To: <20190816125304.29719-3-konstantin.ananyev@intel.com> Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: pt-BR Content-Transfer-Encoding: 7bit X-HN-S: bWljaGVsQGRpZ2lyYXRpLmNvbS5icg== X-HN-R: ZGV2QGRwZGsub3Jn a29uc3RhbnRpbi5hbmFueWV2QGludGVsLmNvbQ== Feedback-ID: MjAxOTA4MTY=:bWljaGVsQGRpZ2lyYXRpLmNvbS5icg==:ZGlnaXJhdGkuY29tLmJy:k8networks X-Mailman-Approved-At: Tue, 20 Aug 2019 17:07:38 +0200 Subject: Re: [dpdk-dev] [PATCH 2/3] mbuf: move mbuf definition into a separate file X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Acked-by: Michel Machado [ ]'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 > --- > 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 > #include > #include > +#include > > #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 instead. > + */ > + > +#include > +#include > +#include > + > +#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_ */ >