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