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