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