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