/* 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 definition 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. * * New fields and flags should fit in the "dynamic space". */ #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 RTE_MBUF_F_RX_VLAN_STRIPPED is also present, the VLAN * header has been stripped from mbuf data, else it is still * present. */ #define RTE_MBUF_F_RX_VLAN (1ULL << 0) #define PKT_RX_VLAN RTE_DEPRECATED(PKT_RX_VLAN) RTE_MBUF_F_RX_VLAN /** RX packet with RSS hash result. */ #define RTE_MBUF_F_RX_RSS_HASH (1ULL << 1) #define PKT_RX_RSS_HASH RTE_DEPRECATED(PKT_RX_RSS_HASH) RTE_MBUF_F_RX_RSS_HASH /** RX packet with FDIR match indicate. */ #define RTE_MBUF_F_RX_FDIR (1ULL << 2) #define PKT_RX_FDIR RTE_DEPRECATED(PKT_RX_FDIR) RTE_MBUF_F_RX_FDIR /** * This flag is set when the outermost IP header checksum is detected as * wrong by the hardware. */ #define RTE_MBUF_F_RX_OUTER_IP_CKSUM_BAD (1ULL << 5) #define PKT_RX_OUTER_IP_CKSUM_BAD RTE_DEPRECATED(PKT_RX_OUTER_IP_CKSUM_BAD) \ RTE_MBUF_F_RX_OUTER_IP_CKSUM_BAD /** * 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 RTE_MBUF_F_RX_VLAN_STRIPPED is set, RTE_MBUF_F_RX_VLAN must also be set. */ #define RTE_MBUF_F_RX_VLAN_STRIPPED (1ULL << 6) #define PKT_RX_VLAN_STRIPPED RTE_DEPRECATED(PKT_RX_VLAN_STRIPPED) \ RTE_MBUF_F_RX_VLAN_STRIPPED /** * Mask of bits used to determine the status of RX IP checksum. * - RTE_MBUF_F_RX_IP_CKSUM_UNKNOWN: no information about the RX IP checksum * - RTE_MBUF_F_RX_IP_CKSUM_BAD: the IP checksum in the packet is wrong * - RTE_MBUF_F_RX_IP_CKSUM_GOOD: the IP checksum in the packet is valid * - RTE_MBUF_F_RX_IP_CKSUM_NONE: the IP checksum is not correct in the packet * data, but the integrity of the IP header is verified. */ #define RTE_MBUF_F_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7)) #define PKT_RX_IP_CKSUM_MASK RTE_DEPRECATED(PKT_RX_IP_CKSUM_MASK) \ RTE_MBUF_F_RX_IP_CKSUM_MASK #define RTE_MBUF_F_RX_IP_CKSUM_UNKNOWN 0 #define RTE_MBUF_F_RX_IP_CKSUM_BAD (1ULL << 4) #define RTE_MBUF_F_RX_IP_CKSUM_GOOD (1ULL << 7) #define RTE_MBUF_F_RX_IP_CKSUM_NONE ((1ULL << 4) | (1ULL << 7)) #define PKT_RX_IP_CKSUM_UNKNOWN RTE_DEPRECATED(PKT_RX_IP_CKSUM_UNKNOWN) \ RTE_MBUF_F_RX_IP_CKSUM_UNKNOWN #define PKT_RX_IP_CKSUM_BAD RTE_DEPRECATED(PKT_RX_IP_CKSUM_BAD) \ RTE_MBUF_F_RX_IP_CKSUM_BAD #define PKT_RX_IP_CKSUM_GOOD RTE_DEPRECATED(PKT_RX_IP_CKSUM_GOOD) \ RTE_MBUF_F_RX_IP_CKSUM_GOOD #define PKT_RX_IP_CKSUM_NONE RTE_DEPRECATED(PKT_RX_IP_CKSUM_NONE) \ RTE_MBUF_F_RX_IP_CKSUM_NONE /** * Mask of bits used to determine the status of RX L4 checksum. * - RTE_MBUF_F_RX_L4_CKSUM_UNKNOWN: no information about the RX L4 checksum * - RTE_MBUF_F_RX_L4_CKSUM_BAD: the L4 checksum in the packet is wrong * - RTE_MBUF_F_RX_L4_CKSUM_GOOD: the L4 checksum in the packet is valid * - RTE_MBUF_F_RX_L4_CKSUM_NONE: the L4 checksum is not correct in the packet * data, but the integrity of the L4 data is verified. */ #define RTE_MBUF_F_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8)) #define PKT_RX_L4_CKSUM_MASK RTE_DEPRECATED(PKT_RX_L4_CKSUM_MASK) \ RTE_MBUF_F_RX_L4_CKSUM_MASK #define RTE_MBUF_F_RX_L4_CKSUM_UNKNOWN 0 #define RTE_MBUF_F_RX_L4_CKSUM_BAD (1ULL << 3) #define RTE_MBUF_F_RX_L4_CKSUM_GOOD (1ULL << 8) #define RTE_MBUF_F_RX_L4_CKSUM_NONE ((1ULL << 3) | (1ULL << 8)) #define PKT_RX_L4_CKSUM_UNKNOWN RTE_DEPRECATED(PKT_RX_L4_CKSUM_UNKNOWN) \ RTE_MBUF_F_RX_L4_CKSUM_UNKNOWN #define PKT_RX_L4_CKSUM_BAD RTE_DEPRECATED(PKT_RX_L4_CKSUM_BAD) \ RTE_MBUF_F_RX_L4_CKSUM_BAD #define PKT_RX_L4_CKSUM_GOOD RTE_DEPRECATED(PKT_RX_L4_CKSUM_GOOD) \ RTE_MBUF_F_RX_L4_CKSUM_GOOD #define PKT_RX_L4_CKSUM_NONE RTE_DEPRECATED(PKT_RX_L4_CKSUM_NONE) \ RTE_MBUF_F_RX_L4_CKSUM_NONE /** RX IEEE1588 L2 Ethernet PT Packet. */ #define RTE_MBUF_F_RX_IEEE1588_PTP (1ULL << 9) #define PKT_RX_IEEE1588_PTP RTE_DEPRECATED(PKT_RX_IEEE1588_PTP) \ RTE_MBUF_F_RX_IEEE1588_PTP /** RX IEEE1588 L2/L4 timestamped packet.*/ #define RTE_MBUF_F_RX_IEEE1588_TMST (1ULL << 10) #define PKT_RX_IEEE1588_TMST RTE_DEPRECATED(PKT_RX_IEEE1588_TMST) \ RTE_MBUF_F_RX_IEEE1588_TMST /** FD id reported if FDIR match. */ #define RTE_MBUF_F_RX_FDIR_ID (1ULL << 13) #define PKT_RX_FDIR_ID RTE_DEPRECATED(PKT_RX_FDIR_ID) \ RTE_MBUF_F_RX_FDIR_ID /** Flexible bytes reported if FDIR match. */ #define RTE_MBUF_F_RX_FDIR_FLX (1ULL << 14) #define PKT_RX_FDIR_FLX RTE_DEPRECATED(PKT_RX_FDIR_FLX) \ RTE_MBUF_F_RX_FDIR_FLX /** * The outer VLAN has been stripped by the hardware and its TCI is * saved in mbuf->vlan_tci_outer. * This can only happen if VLAN stripping is enabled in the Rx * configuration of the PMD. * When RTE_MBUF_F_RX_QINQ_STRIPPED is set, the flags RTE_MBUF_F_RX_VLAN * and RTE_MBUF_F_RX_QINQ must also be set. * * - If both RTE_MBUF_F_RX_QINQ_STRIPPED and RTE_MBUF_F_RX_VLAN_STRIPPED are * set, the 2 VLANs have been stripped by the hardware and their TCIs are * saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer). * - If RTE_MBUF_F_RX_QINQ_STRIPPED is set and RTE_MBUF_F_RX_VLAN_STRIPPED * is unset, only the outer VLAN is removed from packet data, but both tci * are saved in mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer). */ #define RTE_MBUF_F_RX_QINQ_STRIPPED (1ULL << 15) #define PKT_RX_QINQ_STRIPPED RTE_DEPRECATED(PKT_RX_QINQ_STRIPPED) \ RTE_MBUF_F_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 RTE_MBUF_F_RX_LRO (1ULL << 16) #define PKT_RX_LRO RTE_DEPRECATED(PKT_RX_LRO) RTE_MBUF_F_RX_LRO /* There is no flag defined at offset 17. It is free for any future use. */ /** * Indicate that security offload processing was applied on the RX packet. */ #define RTE_MBUF_F_RX_SEC_OFFLOAD (1ULL << 18) #define PKT_RX_SEC_OFFLOAD RTE_DEPRECATED(PKT_RX_SEC_OFFLOAD) \ RTE_MBUF_F_RX_SEC_OFFLOAD /** * Indicate that security offload processing failed on the RX packet. */ #define RTE_MBUF_F_RX_SEC_OFFLOAD_FAILED (1ULL << 19) #define PKT_RX_SEC_OFFLOAD_FAILED RTE_DEPRECATED(PKT_RX_SEC_OFFLOAD_FAILED) \ RTE_MBUF_F_RX_SEC_OFFLOAD_FAILED /** * The RX packet is a double VLAN, and the outer tci has been * saved in mbuf->vlan_tci_outer. If this flag is set, RTE_MBUF_F_RX_VLAN * must also be set and the inner tci is saved in mbuf->vlan_tci. * If the flag RTE_MBUF_F_RX_QINQ_STRIPPED is also present, both VLANs * headers have been stripped from mbuf data, else they are still * present. */ #define RTE_MBUF_F_RX_QINQ (1ULL << 20) #define PKT_RX_QINQ RTE_DEPRECATED(PKT_RX_QINQ) RTE_MBUF_F_RX_QINQ /** * Mask of bits used to determine the status of outer RX L4 checksum. * - RTE_MBUF_F_RX_OUTER_L4_CKSUM_UNKNOWN: no info about the outer RX L4 * checksum * - RTE_MBUF_F_RX_OUTER_L4_CKSUM_BAD: the outer L4 checksum in the packet * is wrong * - RTE_MBUF_F_RX_OUTER_L4_CKSUM_GOOD: the outer L4 checksum in the packet * is valid * - RTE_MBUF_F_RX_OUTER_L4_CKSUM_INVALID: invalid outer L4 checksum state. * * The detection of RTE_MBUF_F_RX_OUTER_L4_CKSUM_GOOD shall be based on the * given HW capability, At minimum, the PMD should support * RTE_MBUF_F_RX_OUTER_L4_CKSUM_UNKNOWN and RTE_MBUF_F_RX_OUTER_L4_CKSUM_BAD * states if the RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM offload is available. */ #define RTE_MBUF_F_RX_OUTER_L4_CKSUM_MASK ((1ULL << 21) | (1ULL << 22)) #define PKT_RX_OUTER_L4_CKSUM_MASK RTE_DEPRECATED(PKT_RX_OUTER_L4_CKSUM_MASK) \ RTE_MBUF_F_RX_OUTER_L4_CKSUM_MASK #define RTE_MBUF_F_RX_OUTER_L4_CKSUM_UNKNOWN 0 #define RTE_MBUF_F_RX_OUTER_L4_CKSUM_BAD (1ULL << 21) #define RTE_MBUF_F_RX_OUTER_L4_CKSUM_GOOD (1ULL << 22) #define RTE_MBUF_F_RX_OUTER_L4_CKSUM_INVALID ((1ULL << 21) | (1ULL << 22)) #define PKT_RX_OUTER_L4_CKSUM_UNKNOWN \ RTE_DEPRECATED(PKT_RX_OUTER_L4_CKSUM_UNKNOWN) \ RTE_MBUF_F_RX_OUTER_L4_CKSUM_UNKNOWN #define PKT_RX_OUTER_L4_CKSUM_BAD RTE_DEPRECATED(PKT_RX_OUTER_L4_CKSUM_BAD) \ RTE_MBUF_F_RX_OUTER_L4_CKSUM_BAD #define PKT_RX_OUTER_L4_CKSUM_GOOD RTE_DEPRECATED(PKT_RX_OUTER_L4_CKSUM_GOOD) \ RTE_MBUF_F_RX_OUTER_L4_CKSUM_GOOD #define PKT_RX_OUTER_L4_CKSUM_INVALID \ RTE_DEPRECATED(PKT_RX_OUTER_L4_CKSUM_INVALID) \ RTE_MBUF_F_RX_OUTER_L4_CKSUM_INVALID /* add new RX flags here, don't forget to update RTE_MBUF_F_FIRST_FREE */ #define RTE_MBUF_F_FIRST_FREE (1ULL << 23) #define PKT_FIRST_FREE RTE_DEPRECATED(PKT_FIRST_FREE) RTE_MBUF_F_FIRST_FREE #define RTE_MBUF_F_LAST_FREE (1ULL << 40) #define PKT_LAST_FREE RTE_DEPRECATED(PKT_LAST_FREE) RTE_MBUF_F_LAST_FREE /* add new TX flags here, don't forget to update RTE_MBUF_F_LAST_FREE */ /** * 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 RTE_MBUF_F_TX_OUTER_UDP_CKSUM flag. * c) Set the RTE_MBUF_F_TX_OUTER_IPV4 or RTE_MBUF_F_TX_OUTER_IPV6 flag. * 2) Configure RTE_ETH_TX_OFFLOAD_OUTER_UDP_CKSUM offload flag. */ #define RTE_MBUF_F_TX_OUTER_UDP_CKSUM (1ULL << 41) #define PKT_TX_OUTER_UDP_CKSUM RTE_DEPRECATED(PKT_TX_OUTER_UDP_CKSUM) \ RTE_MBUF_F_TX_OUTER_UDP_CKSUM /** * 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 RTE_MBUF_F_TX_UDP_SEG (1ULL << 42) #define PKT_TX_UDP_SEG RTE_DEPRECATED(PKT_TX_UDP_SEG) RTE_MBUF_F_TX_UDP_SEG /** * Request security offload processing on the TX packet. * To use Tx security offload, the user needs to fill l2_len in mbuf * indicating L2 header size and where L3 header starts. */ #define RTE_MBUF_F_TX_SEC_OFFLOAD (1ULL << 43) #define PKT_TX_SEC_OFFLOAD RTE_DEPRECATED(PKT_TX_SEC_OFFLOAD) \ RTE_MBUF_F_TX_SEC_OFFLOAD /** * Offload the MACsec. This flag must be set by the application to enable * this offload feature for a packet to be transmitted. */ #define RTE_MBUF_F_TX_MACSEC (1ULL << 44) #define PKT_TX_MACSEC RTE_DEPRECATED(PKT_TX_MACSEC) RTE_MBUF_F_TX_MACSEC /** * 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 RTE_MBUF_F_TX_TCP_SEG for TSO, or * RTE_MBUF_F_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 RTE_MBUF_F_TX_TUNNEL_VXLAN (0x1ULL << 45) #define RTE_MBUF_F_TX_TUNNEL_GRE (0x2ULL << 45) #define RTE_MBUF_F_TX_TUNNEL_IPIP (0x3ULL << 45) #define RTE_MBUF_F_TX_TUNNEL_GENEVE (0x4ULL << 45) /** TX packet with MPLS-in-UDP RFC 7510 header. */ #define RTE_MBUF_F_TX_TUNNEL_MPLSINUDP (0x5ULL << 45) #define RTE_MBUF_F_TX_TUNNEL_VXLAN_GPE (0x6ULL << 45) #define RTE_MBUF_F_TX_TUNNEL_GTP (0x7ULL << 45) #define RTE_MBUF_F_TX_TUNNEL_ESP (0x8ULL << 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 RTE_MBUF_F_TX_TUNNEL_GRE * or RTE_MBUF_F_TX_TUNNEL_IPIP if possible. * The ethdev must be configured with RTE_ETH_TX_OFFLOAD_IP_TNL_TSO. * Outer and inner checksums are done according to the existing flags like * RTE_MBUF_F_TX_xxx_CKSUM. * Specific tunnel headers that contain payload length, sequence id * or checksum are not expected to be updated. */ #define RTE_MBUF_F_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 RTE_MBUF_F_TX_TUNNEL_VXLAN * if possible. * The ethdev must be configured with RTE_ETH_TX_OFFLOAD_UDP_TNL_TSO. * Outer and inner checksums are done according to the existing flags like * RTE_MBUF_F_TX_xxx_CKSUM. * Specific tunnel headers that contain payload length, sequence id * or checksum are not expected to be updated. */ #define RTE_MBUF_F_TX_TUNNEL_UDP (0xEULL << 45) /* add new TX TUNNEL type here */ #define RTE_MBUF_F_TX_TUNNEL_MASK (0xFULL << 45) #define PKT_TX_TUNNEL_VXLAN RTE_DEPRECATED(PKT_TX_TUNNEL_VXLAN) \ RTE_MBUF_F_TX_TUNNEL_VXLAN #define PKT_TX_TUNNEL_GRE RTE_DEPRECATED(PKT_TX_TUNNEL_GRE) \ RTE_MBUF_F_TX_TUNNEL_GRE #define PKT_TX_TUNNEL_IPIP RTE_DEPRECATED(PKT_TX_TUNNEL_IPIP) \ RTE_MBUF_F_TX_TUNNEL_IPIP #define PKT_TX_TUNNEL_GENEVE RTE_DEPRECATED(PKT_TX_TUNNEL_GENEVE) \ RTE_MBUF_F_TX_TUNNEL_GENEVE #define PKT_TX_TUNNEL_MPLSINUDP RTE_DEPRECATED(PKT_TX_TUNNEL_MPLSINUDP) \ RTE_MBUF_F_TX_TUNNEL_MPLSINUDP #define PKT_TX_TUNNEL_VXLAN_GPE RTE_DEPRECATED(PKT_TX_TUNNEL_VXLAN_GPE) \ RTE_MBUF_F_TX_TUNNEL_VXLAN_GPE #define PKT_TX_TUNNEL_GTP RTE_DEPRECATED(PKT_TX_TUNNEL_GTP) \ RTE_MBUF_F_TX_TUNNEL_GTP #define PKT_TX_TUNNEL_IP RTE_DEPRECATED(PKT_TX_TUNNEL_IP) \ RTE_MBUF_F_TX_TUNNEL_IP #define PKT_TX_TUNNEL_UDP RTE_DEPRECATED(PKT_TX_TUNNEL_UDP) \ RTE_MBUF_F_TX_TUNNEL_UDP #define PKT_TX_TUNNEL_MASK RTE_DEPRECATED(PKT_TX_TUNNEL_MASK) \ RTE_MBUF_F_TX_TUNNEL_MASK /** * 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 RTE_MBUF_F_TX_QINQ (1ULL << 49) #define PKT_TX_QINQ RTE_DEPRECATED(PKT_TX_QINQ) RTE_MBUF_F_TX_QINQ #define PKT_TX_QINQ_PKT RTE_DEPRECATED(PKT_TX_QINQ_PKT) RTE_MBUF_F_TX_QINQ /** * TCP segmentation offload. To enable this offload feature for a * packet to be transmitted on hardware supporting TSO: * - set the RTE_MBUF_F_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies * RTE_MBUF_F_TX_TCP_CKSUM) * - set the flag RTE_MBUF_F_TX_IPV4 or RTE_MBUF_F_TX_IPV6 * - if it's IPv4, set the RTE_MBUF_F_TX_IP_CKSUM flag * - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz */ #define RTE_MBUF_F_TX_TCP_SEG (1ULL << 50) #define PKT_TX_TCP_SEG RTE_DEPRECATED(PKT_TX_TCP_SEG) RTE_MBUF_F_TX_TCP_SEG /** TX IEEE1588 packet to timestamp. */ #define RTE_MBUF_F_TX_IEEE1588_TMST (1ULL << 51) #define PKT_TX_IEEE1588_TMST RTE_DEPRECATED(PKT_TX_IEEE1588_TMST) \ RTE_MBUF_F_TX_IEEE1588_TMST /* * 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 RTE_MBUF_F_TX_TCP_CKSUM, RTE_MBUF_F_TX_SCTP_CKSUM or * RTE_MBUF_F_TX_UDP_CKSUM * - set the flag RTE_MBUF_F_TX_IPV4 or RTE_MBUF_F_TX_IPV6 */ /** Disable L4 cksum of TX pkt. */ #define RTE_MBUF_F_TX_L4_NO_CKSUM (0ULL << 52) /** TCP cksum of TX pkt. computed by NIC. */ #define RTE_MBUF_F_TX_TCP_CKSUM (1ULL << 52) /** SCTP cksum of TX pkt. computed by NIC. */ #define RTE_MBUF_F_TX_SCTP_CKSUM (2ULL << 52) /** UDP cksum of TX pkt. computed by NIC. */ #define RTE_MBUF_F_TX_UDP_CKSUM (3ULL << 52) /** Mask for L4 cksum offload request. */ #define RTE_MBUF_F_TX_L4_MASK (3ULL << 52) #define PKT_TX_L4_NO_CKSUM RTE_DEPRECATED(PKT_TX_L4_NO_CKSUM) \ RTE_MBUF_F_TX_L4_NO_CKSUM #define PKT_TX_TCP_CKSUM RTE_DEPRECATED(PKT_TX_TCP_CKSUM) \ RTE_MBUF_F_TX_TCP_CKSUM #define PKT_TX_SCTP_CKSUM RTE_DEPRECATED(PKT_TX_SCTP_CKSUM) \ RTE_MBUF_F_TX_SCTP_CKSUM #define PKT_TX_UDP_CKSUM RTE_DEPRECATED(PKT_TX_UDP_CKSUM) \ RTE_MBUF_F_TX_UDP_CKSUM #define PKT_TX_L4_MASK RTE_DEPRECATED(PKT_TX_L4_MASK) RTE_MBUF_F_TX_L4_MASK /** * Offload the IP checksum in the hardware. The flag RTE_MBUF_F_TX_IPV4 should * also be set by the application, although a PMD will only check * RTE_MBUF_F_TX_IP_CKSUM. * - fill the mbuf offload information: l2_len, l3_len */ #define RTE_MBUF_F_TX_IP_CKSUM (1ULL << 54) #define PKT_TX_IP_CKSUM RTE_DEPRECATED(PKT_TX_IP_CKSUM) RTE_MBUF_F_TX_IP_CKSUM /** * 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 RTE_MBUF_F_TX_IPV4 (1ULL << 55) #define PKT_TX_IPV4 RTE_DEPRECATED(PKT_TX_IPV4) RTE_MBUF_F_TX_IPV4 /** * 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 RTE_MBUF_F_TX_IPV6 (1ULL << 56) #define PKT_TX_IPV6 RTE_DEPRECATED(PKT_TX_IPV6) RTE_MBUF_F_TX_IPV6 /** * 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 RTE_MBUF_F_TX_VLAN (1ULL << 57) #define PKT_TX_VLAN RTE_DEPRECATED(PKT_TX_VLAN) RTE_MBUF_F_TX_VLAN #define PKT_TX_VLAN_PKT RTE_DEPRECATED(PKT_TX_VLAN_PKT) RTE_MBUF_F_TX_VLAN /** * Offload the IP checksum of an external header in the hardware. The * flag RTE_MBUF_F_TX_OUTER_IPV4 should also be set by the application, although * a PMD will only check RTE_MBUF_F_TX_OUTER_IP_CKSUM. * - fill the mbuf offload information: outer_l2_len, outer_l3_len */ #define RTE_MBUF_F_TX_OUTER_IP_CKSUM (1ULL << 58) #define PKT_TX_OUTER_IP_CKSUM RTE_DEPRECATED(PKT_TX_OUTER_IP_CKSUM) \ RTE_MBUF_F_TX_OUTER_IP_CKSUM /** * 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 RTE_MBUF_F_TX_OUTER_IPV4 (1ULL << 59) #define PKT_TX_OUTER_IPV4 RTE_DEPRECATED(PKT_TX_OUTER_IPV4) \ RTE_MBUF_F_TX_OUTER_IPV4 /** * 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 RTE_MBUF_F_TX_OUTER_IPV6 (1ULL << 60) #define PKT_TX_OUTER_IPV6 RTE_DEPRECATED(PKT_TX_OUTER_IPV6) \ RTE_MBUF_F_TX_OUTER_IPV6 /** * Bitmask of all supported packet Tx offload features flags, * which can be set for packet. */ #define RTE_MBUF_F_TX_OFFLOAD_MASK ( \ RTE_MBUF_F_TX_OUTER_IPV6 | \ RTE_MBUF_F_TX_OUTER_IPV4 | \ RTE_MBUF_F_TX_OUTER_IP_CKSUM | \ RTE_MBUF_F_TX_VLAN | \ RTE_MBUF_F_TX_IPV6 | \ RTE_MBUF_F_TX_IPV4 | \ RTE_MBUF_F_TX_IP_CKSUM | \ RTE_MBUF_F_TX_L4_MASK | \ RTE_MBUF_F_TX_IEEE1588_TMST | \ RTE_MBUF_F_TX_TCP_SEG | \ RTE_MBUF_F_TX_QINQ | \ RTE_MBUF_F_TX_TUNNEL_MASK | \ RTE_MBUF_F_TX_MACSEC | \ RTE_MBUF_F_TX_SEC_OFFLOAD | \ RTE_MBUF_F_TX_UDP_SEG | \ RTE_MBUF_F_TX_OUTER_UDP_CKSUM) #define PKT_TX_OFFLOAD_MASK RTE_DEPRECATED(PKT_TX_OFFLOAD_MASK) RTE_MBUF_F_TX_OFFLOAD_MASK /** * Mbuf having an external buffer attached. shinfo in mbuf must be filled. */ #define RTE_MBUF_F_EXTERNAL (1ULL << 61) #define EXT_ATTACHED_MBUF RTE_DEPRECATED(EXT_ATTACHED_MBUF) RTE_MBUF_F_EXTERNAL #define RTE_MBUF_F_INDIRECT (1ULL << 62) /**< Indirect attached mbuf */ #define IND_ATTACHED_MBUF RTE_DEPRECATED(IND_ATTACHED_MBUF) RTE_MBUF_F_INDIRECT /** 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) 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 { RTE_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_iova_t buf_iova __rte_aligned(sizeof(rte_iova_t)); /* next 8 bytes are initialised on RX descriptor rearm */ RTE_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 RTE_MBUF_REFCNT_ATOMIC flag. */ uint16_t refcnt; /** * Number of segments. Only valid for the first segment of an mbuf * chain. */ uint16_t nb_segs; /** 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 */ RTE_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. */ __extension__ struct { uint8_t l2_type:4; /**< (Outer) L2 type. */ uint8_t l3_type:4; /**< (Outer) L3 type. */ uint8_t l4_type:4; /**< (Outer) L4 type. */ uint8_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. */ }; }; uint8_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 RTE_MBUF_F_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 RTE_MBUF_F_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 */ uint32_t usr; /**< User defined tags. See rte_distributor_process() */ } hash; /**< hash information */ }; /** Outer VLAN TCI (CPU order), valid if RTE_MBUF_F_RX_QINQ is set. */ uint16_t vlan_tci_outer; uint16_t buf_len; /**< Length of segment buffer. */ struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */ /* second cache line - fields only used in slow path or on TX */ RTE_MARKER cacheline1 __rte_cache_min_aligned; /** * Next segment of scattered packet. Must be NULL in the last segment or * in case of non-segmented packet. */ struct rte_mbuf *next; /* 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; */ }; }; /** Shared data for external buffer attached to mbuf. See * rte_pktmbuf_attach_extbuf(). */ struct rte_mbuf_ext_shared_info *shinfo; /** 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; uint32_t dynfield1[9]; /**< Reserved for dynamic fields. */ } __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 */ uint16_t 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 & RTE_MBUF_F_INDIRECT) /** * 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 & RTE_MBUF_F_EXTERNAL) /** * 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 & (RTE_MBUF_F_INDIRECT | RTE_MBUF_F_EXTERNAL))) /** Uninitialized or unspecified port. */ #define RTE_MBUF_PORT_INVALID UINT16_MAX /** For backwards compatibility. */ #define MBUF_INVALID_PORT RTE_MBUF_PORT_INVALID /** * 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)(void *)((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_ */