lib/librte_mbuf/rte_mbuf_core.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation.
   3  * Copyright 2014 6WIND S.A.
   4  */
   5
   6 #ifndef _RTE_MBUF_CORE_H_
   7 #define _RTE_MBUF_CORE_H_
   8
   9 /**
  10  * @file
  11  * This file contains definion of RTE mbuf structure itself,
  12  * packet offload flags and some related macros.
  13  * For majority of DPDK entities, it is not recommended to include
  14  * this file directly, use include <rte_mbuf.h> instead.
  15  *
  16  * New fields and flags should fit in the "dynamic space".
  17  */
  18
  19 #include <stdint.h>
  20 #include <rte_compat.h>
  21 #include <generic/rte_atomic.h>
  22
  23 #ifdef __cplusplus
  24 extern "C" {
  25 #endif
  26
  27 /*
  28  * Packet Offload Features Flags. It also carry packet type information.
  29  * Critical resources. Both rx/tx shared these bits. Be cautious on any change
  30  *
  31  * - RX flags start at bit position zero, and get added to the left of previous
  32  *   flags.
  33  * - The most-significant 3 bits are reserved for generic mbuf flags
  34  * - TX flags therefore start at bit position 60 (i.e. 63-3), and new flags get
  35  *   added to the right of the previously defined flags i.e. they should count
  36  *   downwards, not upwards.
  37  *
  38  * Keep these flags synchronized with rte_get_rx_ol_flag_name() and
  39  * rte_get_tx_ol_flag_name().
  40  */
  41
  42 /**
  43  * The RX packet is a 802.1q VLAN packet, and the tci has been
  44  * saved in in mbuf->vlan_tci.
  45  * If the flag PKT_RX_VLAN_STRIPPED is also present, the VLAN
  46  * header has been stripped from mbuf data, else it is still
  47  * present.
  48  */
  49 #define PKT_RX_VLAN          (1ULL << 0)
  50
  51 /** RX packet with RSS hash result. */
  52 #define PKT_RX_RSS_HASH      (1ULL << 1)
  53
  54  /** RX packet with FDIR match indicate. */
  55 #define PKT_RX_FDIR          (1ULL << 2)
  56
  57 /**
  58  * Deprecated.
  59  * Checking this flag alone is deprecated: check the 2 bits of
  60  * PKT_RX_L4_CKSUM_MASK.
  61  * This flag was set when the L4 checksum of a packet was detected as
  62  * wrong by the hardware.
  63  */
  64 #define PKT_RX_L4_CKSUM_BAD  (1ULL << 3)
  65
  66 /**
  67  * Deprecated.
  68  * Checking this flag alone is deprecated: check the 2 bits of
  69  * PKT_RX_IP_CKSUM_MASK.
  70  * This flag was set when the IP checksum of a packet was detected as
  71  * wrong by the hardware.
  72  */
  73 #define PKT_RX_IP_CKSUM_BAD  (1ULL << 4)
  74
  75  /** External IP header checksum error. */
  76 #define PKT_RX_EIP_CKSUM_BAD (1ULL << 5)
  77
  78 /**
  79  * A vlan has been stripped by the hardware and its tci is saved in
  80  * mbuf->vlan_tci. This can only happen if vlan stripping is enabled
  81  * in the RX configuration of the PMD.
  82  * When PKT_RX_VLAN_STRIPPED is set, PKT_RX_VLAN must also be set.
  83  */
  84 #define PKT_RX_VLAN_STRIPPED (1ULL << 6)
  85
  86 /**
  87  * Mask of bits used to determine the status of RX IP checksum.
  88  * - PKT_RX_IP_CKSUM_UNKNOWN: no information about the RX IP checksum
  89  * - PKT_RX_IP_CKSUM_BAD: the IP checksum in the packet is wrong
  90  * - PKT_RX_IP_CKSUM_GOOD: the IP checksum in the packet is valid
  91  * - PKT_RX_IP_CKSUM_NONE: the IP checksum is not correct in the packet
  92  *   data, but the integrity of the IP header is verified.
  93  */
  94 #define PKT_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7))
  95
  96 #define PKT_RX_IP_CKSUM_UNKNOWN 0
  97 #define PKT_RX_IP_CKSUM_BAD     (1ULL << 4)
  98 #define PKT_RX_IP_CKSUM_GOOD    (1ULL << 7)
  99 #define PKT_RX_IP_CKSUM_NONE    ((1ULL << 4) | (1ULL << 7))
 100
 101 /**
 102  * Mask of bits used to determine the status of RX L4 checksum.
 103  * - PKT_RX_L4_CKSUM_UNKNOWN: no information about the RX L4 checksum
 104  * - PKT_RX_L4_CKSUM_BAD: the L4 checksum in the packet is wrong
 105  * - PKT_RX_L4_CKSUM_GOOD: the L4 checksum in the packet is valid
 106  * - PKT_RX_L4_CKSUM_NONE: the L4 checksum is not correct in the packet
 107  *   data, but the integrity of the L4 data is verified.
 108  */
 109 #define PKT_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8))
 110
 111 #define PKT_RX_L4_CKSUM_UNKNOWN 0
 112 #define PKT_RX_L4_CKSUM_BAD     (1ULL << 3)
 113 #define PKT_RX_L4_CKSUM_GOOD    (1ULL << 8)
 114 #define PKT_RX_L4_CKSUM_NONE    ((1ULL << 3) | (1ULL << 8))
 115
 116 /** RX IEEE1588 L2 Ethernet PT Packet. */
 117 #define PKT_RX_IEEE1588_PTP  (1ULL << 9)
 118
 119 /** RX IEEE1588 L2/L4 timestamped packet.*/
 120 #define PKT_RX_IEEE1588_TMST (1ULL << 10)
 121
 122 /** FD id reported if FDIR match. */
 123 #define PKT_RX_FDIR_ID       (1ULL << 13)
 124
 125 /** Flexible bytes reported if FDIR match. */
 126 #define PKT_RX_FDIR_FLX      (1ULL << 14)
 127
 128 /**
 129  * The outer VLAN has been stripped by the hardware and its TCI is
 130  * saved in mbuf->vlan_tci_outer (outer).
 131  * This can only happen if VLAN stripping is enabled in the Rx
 132  * configuration of the PMD.
 133  * When PKT_RX_QINQ_STRIPPED is set, the flags (PKT_RX_VLAN |  PKT_RX_QINQ)
 134  * must also be set.
 135  *
 136  * - If both PKT_RX_QINQ_STRIPPED and PKT_RX_VLAN_STRIPPED are set, the 2 VLANs
 137  *   have been stripped by the hardware and their TCIs are saved in
 138  *   mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer).
 139  * - If PKT_RX_QINQ_STRIPPED is set and PKT_RX_VLAN_STRIPPED is unset, only the
 140  *   outer VLAN is removed from packet data, but both tci are saved in
 141  *   mbuf->vlan_tci (inner) and mbuf->vlan_tci_outer (outer).
 142  */
 143 #define PKT_RX_QINQ_STRIPPED (1ULL << 15)
 144
 145 /**
 146  * When packets are coalesced by a hardware or virtual driver, this flag
 147  * can be set in the RX mbuf, meaning that the m->tso_segsz field is
 148  * valid and is set to the segment size of original packets.
 149  */
 150 #define PKT_RX_LRO           (1ULL << 16)
 151
 152 /**
 153  * Indicate that the timestamp field in the mbuf is valid.
 154  */
 155 #define PKT_RX_TIMESTAMP     (1ULL << 17)
 156
 157 /**
 158  * Indicate that security offload processing was applied on the RX packet.
 159  */
 160 #define PKT_RX_SEC_OFFLOAD      (1ULL << 18)
 161
 162 /**
 163  * Indicate that security offload processing failed on the RX packet.
 164  */
 165 #define PKT_RX_SEC_OFFLOAD_FAILED       (1ULL << 19)
 166
 167 /**
 168  * The RX packet is a double VLAN, and the outer tci has been
 169  * saved in in mbuf->vlan_tci_outer. If this flag is set:
 170  * - PKT_RX_VLAN must also be set
 171  * -
 172  * also should be set and inner tci should be saved to mbuf->vlan_tci.
 173  * If the flag PKT_RX_QINQ_STRIPPED is also present, both VLANs
 174  * headers have been stripped from mbuf data, else they are still
 175  * present.
 176  */
 177 #define PKT_RX_QINQ          (1ULL << 20)
 178
 179 /**
 180  * Mask of bits used to determine the status of outer RX L4 checksum.
 181  * - PKT_RX_OUTER_L4_CKSUM_UNKNOWN: no info about the outer RX L4 checksum
 182  * - PKT_RX_OUTER_L4_CKSUM_BAD: the outer L4 checksum in the packet is wrong
 183  * - PKT_RX_OUTER_L4_CKSUM_GOOD: the outer L4 checksum in the packet is valid
 184  * - PKT_RX_OUTER_L4_CKSUM_INVALID: invalid outer L4 checksum state.
 185  *
 186  * The detection of PKT_RX_OUTER_L4_CKSUM_GOOD shall be based on the given
 187  * HW capability, At minimum, the PMD should support
 188  * PKT_RX_OUTER_L4_CKSUM_UNKNOWN and PKT_RX_OUTER_L4_CKSUM_BAD states
 189  * if the DEV_RX_OFFLOAD_OUTER_UDP_CKSUM offload is available.
 190  */
 191 #define PKT_RX_OUTER_L4_CKSUM_MASK      ((1ULL << 21) | (1ULL << 22))
 192
 193 #define PKT_RX_OUTER_L4_CKSUM_UNKNOWN   0
 194 #define PKT_RX_OUTER_L4_CKSUM_BAD       (1ULL << 21)
 195 #define PKT_RX_OUTER_L4_CKSUM_GOOD      (1ULL << 22)
 196 #define PKT_RX_OUTER_L4_CKSUM_INVALID   ((1ULL << 21) | (1ULL << 22))
 197
 198 /* add new RX flags here, don't forget to update PKT_FIRST_FREE */
 199
 200 #define PKT_FIRST_FREE (1ULL << 23)
 201 #define PKT_LAST_FREE (1ULL << 40)
 202
 203 /* add new TX flags here, don't forget to update PKT_LAST_FREE  */
 204
 205 /**
 206  * Outer UDP checksum offload flag. This flag is used for enabling
 207  * outer UDP checksum in PMD. To use outer UDP checksum, the user needs to
 208  * 1) Enable the following in mbuf,
 209  * a) Fill outer_l2_len and outer_l3_len in mbuf.
 210  * b) Set the PKT_TX_OUTER_UDP_CKSUM flag.
 211  * c) Set the PKT_TX_OUTER_IPV4 or PKT_TX_OUTER_IPV6 flag.
 212  * 2) Configure DEV_TX_OFFLOAD_OUTER_UDP_CKSUM offload flag.
 213  */
 214 #define PKT_TX_OUTER_UDP_CKSUM     (1ULL << 41)
 215
 216 /**
 217  * UDP Fragmentation Offload flag. This flag is used for enabling UDP
 218  * fragmentation in SW or in HW. When use UFO, mbuf->tso_segsz is used
 219  * to store the MSS of UDP fragments.
 220  */
 221 #define PKT_TX_UDP_SEG  (1ULL << 42)
 222
 223 /**
 224  * Request security offload processing on the TX packet.
 225  */
 226 #define PKT_TX_SEC_OFFLOAD      (1ULL << 43)
 227
 228 /**
 229  * Offload the MACsec. This flag must be set by the application to enable
 230  * this offload feature for a packet to be transmitted.
 231  */
 232 #define PKT_TX_MACSEC        (1ULL << 44)
 233
 234 /**
 235  * Bits 45:48 used for the tunnel type.
 236  * The tunnel type must be specified for TSO or checksum on the inner part
 237  * of tunnel packets.
 238  * These flags can be used with PKT_TX_TCP_SEG for TSO, or PKT_TX_xxx_CKSUM.
 239  * The mbuf fields for inner and outer header lengths are required:
 240  * outer_l2_len, outer_l3_len, l2_len, l3_len, l4_len and tso_segsz for TSO.
 241  */
 242 #define PKT_TX_TUNNEL_VXLAN   (0x1ULL << 45)
 243 #define PKT_TX_TUNNEL_GRE     (0x2ULL << 45)
 244 #define PKT_TX_TUNNEL_IPIP    (0x3ULL << 45)
 245 #define PKT_TX_TUNNEL_GENEVE  (0x4ULL << 45)
 246 /** TX packet with MPLS-in-UDP RFC 7510 header. */
 247 #define PKT_TX_TUNNEL_MPLSINUDP (0x5ULL << 45)
 248 #define PKT_TX_TUNNEL_VXLAN_GPE (0x6ULL << 45)
 249 #define PKT_TX_TUNNEL_GTP       (0x7ULL << 45)
 250 /**
 251  * Generic IP encapsulated tunnel type, used for TSO and checksum offload.
 252  * It can be used for tunnels which are not standards or listed above.
 253  * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_GRE
 254  * or PKT_TX_TUNNEL_IPIP if possible.
 255  * The ethdev must be configured with DEV_TX_OFFLOAD_IP_TNL_TSO.
 256  * Outer and inner checksums are done according to the existing flags like
 257  * PKT_TX_xxx_CKSUM.
 258  * Specific tunnel headers that contain payload length, sequence id
 259  * or checksum are not expected to be updated.
 260  */
 261 #define PKT_TX_TUNNEL_IP (0xDULL << 45)
 262 /**
 263  * Generic UDP encapsulated tunnel type, used for TSO and checksum offload.
 264  * UDP tunnel type implies outer IP layer.
 265  * It can be used for tunnels which are not standards or listed above.
 266  * It is preferred to use specific tunnel flags like PKT_TX_TUNNEL_VXLAN
 267  * if possible.
 268  * The ethdev must be configured with DEV_TX_OFFLOAD_UDP_TNL_TSO.
 269  * Outer and inner checksums are done according to the existing flags like
 270  * PKT_TX_xxx_CKSUM.
 271  * Specific tunnel headers that contain payload length, sequence id
 272  * or checksum are not expected to be updated.
 273  */
 274 #define PKT_TX_TUNNEL_UDP (0xEULL << 45)
 275 /* add new TX TUNNEL type here */
 276 #define PKT_TX_TUNNEL_MASK    (0xFULL << 45)
 277
 278 /**
 279  * Double VLAN insertion (QinQ) request to driver, driver may offload the
 280  * insertion based on device capability.
 281  * mbuf 'vlan_tci' & 'vlan_tci_outer' must be valid when this flag is set.
 282  */
 283 #define PKT_TX_QINQ        (1ULL << 49)
 284 /* this old name is deprecated */
 285 #define PKT_TX_QINQ_PKT    PKT_TX_QINQ
 286
 287 /**
 288  * TCP segmentation offload. To enable this offload feature for a
 289  * packet to be transmitted on hardware supporting TSO:
 290  *  - set the PKT_TX_TCP_SEG flag in mbuf->ol_flags (this flag implies
 291  *    PKT_TX_TCP_CKSUM)
 292  *  - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
 293  *  - if it's IPv4, set the PKT_TX_IP_CKSUM flag
 294  *  - fill the mbuf offload information: l2_len, l3_len, l4_len, tso_segsz
 295  */
 296 #define PKT_TX_TCP_SEG       (1ULL << 50)
 297
 298 /** TX IEEE1588 packet to timestamp. */
 299 #define PKT_TX_IEEE1588_TMST (1ULL << 51)
 300
 301 /**
 302  * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved,
 303  * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware
 304  * L4 checksum offload, the user needs to:
 305  *  - fill l2_len and l3_len in mbuf
 306  *  - set the flags PKT_TX_TCP_CKSUM, PKT_TX_SCTP_CKSUM or PKT_TX_UDP_CKSUM
 307  *  - set the flag PKT_TX_IPV4 or PKT_TX_IPV6
 308  */
 309 #define PKT_TX_L4_NO_CKSUM   (0ULL << 52) /**< Disable L4 cksum of TX pkt. */
 310
 311 /** TCP cksum of TX pkt. computed by NIC. */
 312 #define PKT_TX_TCP_CKSUM     (1ULL << 52)
 313
 314 /** SCTP cksum of TX pkt. computed by NIC. */
 315 #define PKT_TX_SCTP_CKSUM    (2ULL << 52)
 316
 317 /** UDP cksum of TX pkt. computed by NIC. */
 318 #define PKT_TX_UDP_CKSUM     (3ULL << 52)
 319
 320 /** Mask for L4 cksum offload request. */
 321 #define PKT_TX_L4_MASK       (3ULL << 52)
 322
 323 /**
 324  * Offload the IP checksum in the hardware. The flag PKT_TX_IPV4 should
 325  * also be set by the application, although a PMD will only check
 326  * PKT_TX_IP_CKSUM.
 327  *  - fill the mbuf offload information: l2_len, l3_len
 328  */
 329 #define PKT_TX_IP_CKSUM      (1ULL << 54)
 330
 331 /**
 332  * Packet is IPv4. This flag must be set when using any offload feature
 333  * (TSO, L3 or L4 checksum) to tell the NIC that the packet is an IPv4
 334  * packet. If the packet is a tunneled packet, this flag is related to
 335  * the inner headers.
 336  */
 337 #define PKT_TX_IPV4          (1ULL << 55)
 338
 339 /**
 340  * Packet is IPv6. This flag must be set when using an offload feature
 341  * (TSO or L4 checksum) to tell the NIC that the packet is an IPv6
 342  * packet. If the packet is a tunneled packet, this flag is related to
 343  * the inner headers.
 344  */
 345 #define PKT_TX_IPV6          (1ULL << 56)
 346
 347 /**
 348  * VLAN tag insertion request to driver, driver may offload the insertion
 349  * based on the device capability.
 350  * mbuf 'vlan_tci' field must be valid when this flag is set.
 351  */
 352 #define PKT_TX_VLAN          (1ULL << 57)
 353 /* this old name is deprecated */
 354 #define PKT_TX_VLAN_PKT      PKT_TX_VLAN
 355
 356 /**
 357  * Offload the IP checksum of an external header in the hardware. The
 358  * flag PKT_TX_OUTER_IPV4 should also be set by the application, although
 359  * a PMD will only check PKT_TX_OUTER_IP_CKSUM.
 360  *  - fill the mbuf offload information: outer_l2_len, outer_l3_len
 361  */
 362 #define PKT_TX_OUTER_IP_CKSUM   (1ULL << 58)
 363
 364 /**
 365  * Packet outer header is IPv4. This flag must be set when using any
 366  * outer offload feature (L3 or L4 checksum) to tell the NIC that the
 367  * outer header of the tunneled packet is an IPv4 packet.
 368  */
 369 #define PKT_TX_OUTER_IPV4   (1ULL << 59)
 370
 371 /**
 372  * Packet outer header is IPv6. This flag must be set when using any
 373  * outer offload feature (L4 checksum) to tell the NIC that the outer
 374  * header of the tunneled packet is an IPv6 packet.
 375  */
 376 #define PKT_TX_OUTER_IPV6    (1ULL << 60)
 377
 378 /**
 379  * Bitmask of all supported packet Tx offload features flags,
 380  * which can be set for packet.
 381  */
 382 #define PKT_TX_OFFLOAD_MASK (    \
 383                 PKT_TX_OUTER_IPV6 |      \
 384                 PKT_TX_OUTER_IPV4 |      \
 385                 PKT_TX_OUTER_IP_CKSUM |  \
 386                 PKT_TX_VLAN_PKT |        \
 387                 PKT_TX_IPV6 |            \
 388                 PKT_TX_IPV4 |            \
 389                 PKT_TX_IP_CKSUM |        \
 390                 PKT_TX_L4_MASK |         \
 391                 PKT_TX_IEEE1588_TMST |   \
 392                 PKT_TX_TCP_SEG |         \
 393                 PKT_TX_QINQ_PKT |        \
 394                 PKT_TX_TUNNEL_MASK |     \
 395                 PKT_TX_MACSEC |          \
 396                 PKT_TX_SEC_OFFLOAD |     \
 397                 PKT_TX_UDP_SEG |         \
 398                 PKT_TX_OUTER_UDP_CKSUM)
 399
 400 /**
 401  * Mbuf having an external buffer attached. shinfo in mbuf must be filled.
 402  */
 403 #define EXT_ATTACHED_MBUF    (1ULL << 61)
 404
 405 #define IND_ATTACHED_MBUF    (1ULL << 62) /**< Indirect attached mbuf */
 406
 407 /** Alignment constraint of mbuf private area. */
 408 #define RTE_MBUF_PRIV_ALIGN 8
 409
 410 /**
 411  * Some NICs need at least 2KB buffer to RX standard Ethernet frame without
 412  * splitting it into multiple segments.
 413  * So, for mbufs that planned to be involved into RX/TX, the recommended
 414  * minimal buffer length is 2KB + RTE_PKTMBUF_HEADROOM.
 415  */
 416 #define RTE_MBUF_DEFAULT_DATAROOM       2048
 417 #define RTE_MBUF_DEFAULT_BUF_SIZE       \
 418         (RTE_MBUF_DEFAULT_DATAROOM + RTE_PKTMBUF_HEADROOM)
 419
 420 struct rte_mbuf_sched {
 421         uint32_t queue_id;   /**< Queue ID. */
 422         uint8_t traffic_class;
 423         /**< Traffic class ID. Traffic class 0
 424          * is the highest priority traffic class.
 425          */
 426         uint8_t color;
 427         /**< Color. @see enum rte_color.*/
 428         uint16_t reserved;   /**< Reserved. */
 429 }; /**< Hierarchical scheduler */
 430
 431 /**
 432  * enum for the tx_offload bit-fields lengths and offsets.
 433  * defines the layout of rte_mbuf tx_offload field.
 434  */
 435 enum {
 436         RTE_MBUF_L2_LEN_BITS = 7,
 437         RTE_MBUF_L3_LEN_BITS = 9,
 438         RTE_MBUF_L4_LEN_BITS = 8,
 439         RTE_MBUF_TSO_SEGSZ_BITS = 16,
 440         RTE_MBUF_OUTL3_LEN_BITS = 9,
 441         RTE_MBUF_OUTL2_LEN_BITS = 7,
 442         RTE_MBUF_TXOFLD_UNUSED_BITS = sizeof(uint64_t) * CHAR_BIT -
 443                 RTE_MBUF_L2_LEN_BITS -
 444                 RTE_MBUF_L3_LEN_BITS -
 445                 RTE_MBUF_L4_LEN_BITS -
 446                 RTE_MBUF_TSO_SEGSZ_BITS -
 447                 RTE_MBUF_OUTL3_LEN_BITS -
 448                 RTE_MBUF_OUTL2_LEN_BITS,
 449 #if RTE_BYTE_ORDER == RTE_BIG_ENDIAN
 450         RTE_MBUF_L2_LEN_OFS =
 451                 sizeof(uint64_t) * CHAR_BIT - RTE_MBUF_L2_LEN_BITS,
 452         RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS - RTE_MBUF_L3_LEN_BITS,
 453         RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS - RTE_MBUF_L4_LEN_BITS,
 454         RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS - RTE_MBUF_TSO_SEGSZ_BITS,
 455         RTE_MBUF_OUTL3_LEN_OFS =
 456                 RTE_MBUF_TSO_SEGSZ_OFS - RTE_MBUF_OUTL3_LEN_BITS,
 457         RTE_MBUF_OUTL2_LEN_OFS =
 458                 RTE_MBUF_OUTL3_LEN_OFS - RTE_MBUF_OUTL2_LEN_BITS,
 459         RTE_MBUF_TXOFLD_UNUSED_OFS =
 460                 RTE_MBUF_OUTL2_LEN_OFS - RTE_MBUF_TXOFLD_UNUSED_BITS,
 461 #else
 462         RTE_MBUF_L2_LEN_OFS = 0,
 463         RTE_MBUF_L3_LEN_OFS = RTE_MBUF_L2_LEN_OFS + RTE_MBUF_L2_LEN_BITS,
 464         RTE_MBUF_L4_LEN_OFS = RTE_MBUF_L3_LEN_OFS + RTE_MBUF_L3_LEN_BITS,
 465         RTE_MBUF_TSO_SEGSZ_OFS = RTE_MBUF_L4_LEN_OFS + RTE_MBUF_L4_LEN_BITS,
 466         RTE_MBUF_OUTL3_LEN_OFS =
 467                 RTE_MBUF_TSO_SEGSZ_OFS + RTE_MBUF_TSO_SEGSZ_BITS,
 468         RTE_MBUF_OUTL2_LEN_OFS =
 469                 RTE_MBUF_OUTL3_LEN_OFS + RTE_MBUF_OUTL3_LEN_BITS,
 470         RTE_MBUF_TXOFLD_UNUSED_OFS =
 471                 RTE_MBUF_OUTL2_LEN_OFS + RTE_MBUF_OUTL2_LEN_BITS,
 472 #endif
 473 };
 474
 475 /**
 476  * The generic rte_mbuf, containing a packet mbuf.
 477  */
 478 struct rte_mbuf {
 479         RTE_MARKER cacheline0;
 480
 481         void *buf_addr;           /**< Virtual address of segment buffer. */
 482         /**
 483          * Physical address of segment buffer.
 484          * Force alignment to 8-bytes, so as to ensure we have the exact
 485          * same mbuf cacheline0 layout for 32-bit and 64-bit. This makes
 486          * working on vector drivers easier.
 487          */
 488         RTE_STD_C11
 489         union {
 490                 rte_iova_t buf_iova;
 491                 rte_iova_t buf_physaddr; /**< deprecated */
 492         } __rte_aligned(sizeof(rte_iova_t));
 493
 494         /* next 8 bytes are initialised on RX descriptor rearm */
 495         RTE_MARKER64 rearm_data;
 496         uint16_t data_off;
 497
 498         /**
 499          * Reference counter. Its size should at least equal to the size
 500          * of port field (16 bits), to support zero-copy broadcast.
 501          * It should only be accessed using the following functions:
 502          * rte_mbuf_refcnt_update(), rte_mbuf_refcnt_read(), and
 503          * rte_mbuf_refcnt_set(). The functionality of these functions (atomic,
 504          * or non-atomic) is controlled by the CONFIG_RTE_MBUF_REFCNT_ATOMIC
 505          * config option.
 506          */
 507         RTE_STD_C11
 508         union {
 509                 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
 510                 /** Non-atomically accessed refcnt */
 511                 uint16_t refcnt;
 512         };
 513         uint16_t nb_segs;         /**< Number of segments. */
 514
 515         /** Input port (16 bits to support more than 256 virtual ports).
 516          * The event eth Tx adapter uses this field to specify the output port.
 517          */
 518         uint16_t port;
 519
 520         uint64_t ol_flags;        /**< Offload features. */
 521
 522         /* remaining bytes are set on RX when pulling packet from descriptor */
 523         RTE_MARKER rx_descriptor_fields1;
 524
 525         /*
 526          * The packet type, which is the combination of outer/inner L2, L3, L4
 527          * and tunnel types. The packet_type is about data really present in the
 528          * mbuf. Example: if vlan stripping is enabled, a received vlan packet
 529          * would have RTE_PTYPE_L2_ETHER and not RTE_PTYPE_L2_VLAN because the
 530          * vlan is stripped from the data.
 531          */
 532         RTE_STD_C11
 533         union {
 534                 uint32_t packet_type; /**< L2/L3/L4 and tunnel information. */
 535                 __extension__
 536                 struct {
 537                         uint8_t l2_type:4;   /**< (Outer) L2 type. */
 538                         uint8_t l3_type:4;   /**< (Outer) L3 type. */
 539                         uint8_t l4_type:4;   /**< (Outer) L4 type. */
 540                         uint8_t tun_type:4;  /**< Tunnel type. */
 541                         RTE_STD_C11
 542                         union {
 543                                 uint8_t inner_esp_next_proto;
 544                                 /**< ESP next protocol type, valid if
 545                                  * RTE_PTYPE_TUNNEL_ESP tunnel type is set
 546                                  * on both Tx and Rx.
 547                                  */
 548                                 __extension__
 549                                 struct {
 550                                         uint8_t inner_l2_type:4;
 551                                         /**< Inner L2 type. */
 552                                         uint8_t inner_l3_type:4;
 553                                         /**< Inner L3 type. */
 554                                 };
 555                         };
 556                         uint8_t inner_l4_type:4; /**< Inner L4 type. */
 557                 };
 558         };
 559
 560         uint32_t pkt_len;         /**< Total pkt len: sum of all segments. */
 561         uint16_t data_len;        /**< Amount of data in segment buffer. */
 562         /** VLAN TCI (CPU order), valid if PKT_RX_VLAN is set. */
 563         uint16_t vlan_tci;
 564
 565         RTE_STD_C11
 566         union {
 567                 union {
 568                         uint32_t rss;     /**< RSS hash result if RSS enabled */
 569                         struct {
 570                                 union {
 571                                         struct {
 572                                                 uint16_t hash;
 573                                                 uint16_t id;
 574                                         };
 575                                         uint32_t lo;
 576                                         /**< Second 4 flexible bytes */
 577                                 };
 578                                 uint32_t hi;
 579                                 /**< First 4 flexible bytes or FD ID, dependent
 580                                  * on PKT_RX_FDIR_* flag in ol_flags.
 581                                  */
 582                         } fdir; /**< Filter identifier if FDIR enabled */
 583                         struct rte_mbuf_sched sched;
 584                         /**< Hierarchical scheduler : 8 bytes */
 585                         struct {
 586                                 uint32_t reserved1;
 587                                 uint16_t reserved2;
 588                                 uint16_t txq;
 589                                 /**< The event eth Tx adapter uses this field
 590                                  * to store Tx queue id.
 591                                  * @see rte_event_eth_tx_adapter_txq_set()
 592                                  */
 593                         } txadapter; /**< Eventdev ethdev Tx adapter */
 594                         /**< User defined tags. See rte_distributor_process() */
 595                         uint32_t usr;
 596                 } hash;                   /**< hash information */
 597         };
 598
 599         /** Outer VLAN TCI (CPU order), valid if PKT_RX_QINQ is set. */
 600         uint16_t vlan_tci_outer;
 601
 602         uint16_t buf_len;         /**< Length of segment buffer. */
 603
 604         /** Valid if PKT_RX_TIMESTAMP is set. The unit and time reference
 605          * are not normalized but are always the same for a given port.
 606          * Some devices allow to query rte_eth_read_clock that will return the
 607          * current device timestamp.
 608          */
 609         uint64_t timestamp;
 610
 611         /* second cache line - fields only used in slow path or on TX */
 612         RTE_MARKER cacheline1 __rte_cache_min_aligned;
 613
 614         RTE_STD_C11
 615         union {
 616                 void *userdata;   /**< Can be used for external metadata */
 617                 uint64_t udata64; /**< Allow 8-byte userdata on 32-bit */
 618         };
 619
 620         struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
 621         struct rte_mbuf *next;    /**< Next segment of scattered packet. */
 622
 623         /* fields to support TX offloads */
 624         RTE_STD_C11
 625         union {
 626                 uint64_t tx_offload;       /**< combined for easy fetch */
 627                 __extension__
 628                 struct {
 629                         uint64_t l2_len:RTE_MBUF_L2_LEN_BITS;
 630                         /**< L2 (MAC) Header Length for non-tunneling pkt.
 631                          * Outer_L4_len + ... + Inner_L2_len for tunneling pkt.
 632                          */
 633                         uint64_t l3_len:RTE_MBUF_L3_LEN_BITS;
 634                         /**< L3 (IP) Header Length. */
 635                         uint64_t l4_len:RTE_MBUF_L4_LEN_BITS;
 636                         /**< L4 (TCP/UDP) Header Length. */
 637                         uint64_t tso_segsz:RTE_MBUF_TSO_SEGSZ_BITS;
 638                         /**< TCP TSO segment size */
 639
 640                         /*
 641                          * Fields for Tx offloading of tunnels.
 642                          * These are undefined for packets which don't request
 643                          * any tunnel offloads (outer IP or UDP checksum,
 644                          * tunnel TSO).
 645                          *
 646                          * PMDs should not use these fields unconditionally
 647                          * when calculating offsets.
 648                          *
 649                          * Applications are expected to set appropriate tunnel
 650                          * offload flags when they fill in these fields.
 651                          */
 652                         uint64_t outer_l3_len:RTE_MBUF_OUTL3_LEN_BITS;
 653                         /**< Outer L3 (IP) Hdr Length. */
 654                         uint64_t outer_l2_len:RTE_MBUF_OUTL2_LEN_BITS;
 655                         /**< Outer L2 (MAC) Hdr Length. */
 656
 657                         /* uint64_t unused:RTE_MBUF_TXOFLD_UNUSED_BITS; */
 658                 };
 659         };
 660
 661         /** Size of the application private data. In case of an indirect
 662          * mbuf, it stores the direct mbuf private data size.
 663          */
 664         uint16_t priv_size;
 665
 666         /** Timesync flags for use with IEEE1588. */
 667         uint16_t timesync;
 668
 669         /** Sequence number. See also rte_reorder_insert(). */
 670         uint32_t seqn;
 671
 672         /** Shared data for external buffer attached to mbuf. See
 673          * rte_pktmbuf_attach_extbuf().
 674          */
 675         struct rte_mbuf_ext_shared_info *shinfo;
 676
 677         uint64_t dynfield1[2]; /**< Reserved for dynamic fields. */
 678 } __rte_cache_aligned;
 679
 680 /**
 681  * Function typedef of callback to free externally attached buffer.
 682  */
 683 typedef void (*rte_mbuf_extbuf_free_callback_t)(void *addr, void *opaque);
 684
 685 /**
 686  * Shared data at the end of an external buffer.
 687  */
 688 struct rte_mbuf_ext_shared_info {
 689         rte_mbuf_extbuf_free_callback_t free_cb; /**< Free callback function */
 690         void *fcb_opaque;                        /**< Free callback argument */
 691         RTE_STD_C11
 692         union {
 693                 rte_atomic16_t refcnt_atomic; /**< Atomically accessed refcnt */
 694                 uint16_t refcnt;
 695         };
 696 };
 697
 698 /**< Maximum number of nb_segs allowed. */
 699 #define RTE_MBUF_MAX_NB_SEGS    UINT16_MAX
 700
 701 /**
 702  * Returns TRUE if given mbuf is cloned by mbuf indirection, or FALSE
 703  * otherwise.
 704  *
 705  * If a mbuf has its data in another mbuf and references it by mbuf
 706  * indirection, this mbuf can be defined as a cloned mbuf.
 707  */
 708 #define RTE_MBUF_CLONED(mb)     ((mb)->ol_flags & IND_ATTACHED_MBUF)
 709
 710 /**
 711  * Returns TRUE if given mbuf has an external buffer, or FALSE otherwise.
 712  *
 713  * External buffer is a user-provided anonymous buffer.
 714  */
 715 #define RTE_MBUF_HAS_EXTBUF(mb) ((mb)->ol_flags & EXT_ATTACHED_MBUF)
 716
 717 /**
 718  * Returns TRUE if given mbuf is direct, or FALSE otherwise.
 719  *
 720  * If a mbuf embeds its own data after the rte_mbuf structure, this mbuf
 721  * can be defined as a direct mbuf.
 722  */
 723 #define RTE_MBUF_DIRECT(mb) \
 724         (!((mb)->ol_flags & (IND_ATTACHED_MBUF | EXT_ATTACHED_MBUF)))
 725
 726 #define MBUF_INVALID_PORT UINT16_MAX
 727
 728 /**
 729  * A macro that points to an offset into the data in the mbuf.
 730  *
 731  * The returned pointer is cast to type t. Before using this
 732  * function, the user must ensure that the first segment is large
 733  * enough to accommodate its data.
 734  *
 735  * @param m
 736  *   The packet mbuf.
 737  * @param o
 738  *   The offset into the mbuf data.
 739  * @param t
 740  *   The type to cast the result into.
 741  */
 742 #define rte_pktmbuf_mtod_offset(m, t, o)        \
 743         ((t)((char *)(m)->buf_addr + (m)->data_off + (o)))
 744
 745 /**
 746  * A macro that points to the start of the data in the mbuf.
 747  *
 748  * The returned pointer is cast to type t. Before using this
 749  * function, the user must ensure that the first segment is large
 750  * enough to accommodate its data.
 751  *
 752  * @param m
 753  *   The packet mbuf.
 754  * @param t
 755  *   The type to cast the result into.
 756  */
 757 #define rte_pktmbuf_mtod(m, t) rte_pktmbuf_mtod_offset(m, t, 0)
 758
 759 /**
 760  * A macro that returns the IO address that points to an offset of the
 761  * start of the data in the mbuf
 762  *
 763  * @param m
 764  *   The packet mbuf.
 765  * @param o
 766  *   The offset into the data to calculate address from.
 767  */
 768 #define rte_pktmbuf_iova_offset(m, o) \
 769         (rte_iova_t)((m)->buf_iova + (m)->data_off + (o))
 770
 771 /**
 772  * A macro that returns the IO address that points to the start of the
 773  * data in the mbuf
 774  *
 775  * @param m
 776  *   The packet mbuf.
 777  */
 778 #define rte_pktmbuf_iova(m) rte_pktmbuf_iova_offset(m, 0)
 779
 780 #ifdef __cplusplus
 781 }
 782 #endif
 783
 784 #endif /* _RTE_MBUF_CORE_H_ */