pktmbuf_offload.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2010-2022 Intel Corporation.
 * Copyright (c) 2014 6WIND S.A.
 */
 
#ifndef _PKTMBUF_OFFLOAD_H_
#define _PKTMBUF_OFFLOAD_H_
 
#include <stdint.h>
 
#include <cne_common.h>
#include <cne_byteorder.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * Packet Offload Features Flags. It also carry packet type information.
 * Critical resources. Both rx/tx shared these bits. Be cautious on any change
 *
 * - RX flags start at bit position zero, and get added to the left of previous
 *   flags.
 * - The most-significant 3 bits are reserved for generic mbuf flags
 * - TX flags therefore start at bit position 60 (i.e. 63-3), and new flags get
 *   added to the right of the previously defined flags i.e. they should count
 *   downwards, not upwards.
 *
 * Keep these flags synchronized with cne_get_rx_ol_flag_name() and
 * cne_get_tx_ol_flag_name().
 */
 
#define CNE_MBUF_F_RX_VLAN (1ULL << 0)
 
#define CNE_MBUF_F_RX_RSS_HASH (1ULL << 1)
 
#define CNE_MBUF_F_RX_FDIR (1ULL << 2)
 
#define CNE_MBUF_F_RX_OUTER_IP_CKSUM_BAD (1ULL << 5)
 
#define CNE_MBUF_F_RX_VLAN_STRIPPED (1ULL << 6)
 
#define CNE_MBUF_F_RX_IP_CKSUM_MASK ((1ULL << 4) | (1ULL << 7))
 
#define CNE_MBUF_F_RX_IP_CKSUM_UNKNOWN 0
#define CNE_MBUF_F_RX_IP_CKSUM_BAD     (1ULL << 4)
#define CNE_MBUF_F_RX_IP_CKSUM_GOOD    (1ULL << 7)
#define CNE_MBUF_F_RX_IP_CKSUM_NONE    ((1ULL << 4) | (1ULL << 7))
 
#define CNE_MBUF_F_RX_L4_CKSUM_MASK ((1ULL << 3) | (1ULL << 8))
 
#define CNE_MBUF_F_RX_L4_CKSUM_UNKNOWN 0
#define CNE_MBUF_F_RX_L4_CKSUM_BAD     (1ULL << 3)
#define CNE_MBUF_F_RX_L4_CKSUM_GOOD    (1ULL << 8)
#define CNE_MBUF_F_RX_L4_CKSUM_NONE    ((1ULL << 3) | (1ULL << 8))
 
#define CNE_MBUF_F_RX_IEEE1588_PTP (1ULL << 9)
 
#define CNE_MBUF_F_RX_IEEE1588_TMST (1ULL << 10)
 
#define CNE_MBUF_F_RX_FDIR_ID (1ULL << 13)
 
#define CNE_MBUF_F_RX_FDIR_FLX (1ULL << 14)
 
#define CNE_MBUF_F_RX_QINQ_STRIPPED (1ULL << 15)
 
#define CNE_MBUF_F_RX_LRO (1ULL << 16)
 
/* There is no flag defined at offset 17. It is free for any future use. */
 
#define CNE_MBUF_F_RX_SEC_OFFLOAD (1ULL << 18)
 
#define CNE_MBUF_F_RX_SEC_OFFLOAD_FAILED (1ULL << 19)
 
#define CNE_MBUF_F_RX_QINQ (1ULL << 20)
 
#define CNE_MBUF_F_RX_OUTER_L4_CKSUM_MASK ((1ULL << 21) | (1ULL << 22))
 
#define CNE_MBUF_F_RX_OUTER_L4_CKSUM_UNKNOWN 0
#define CNE_MBUF_F_RX_OUTER_L4_CKSUM_BAD     (1ULL << 21)
#define CNE_MBUF_F_RX_OUTER_L4_CKSUM_GOOD    (1ULL << 22)
#define CNE_MBUF_F_RX_OUTER_L4_CKSUM_INVALID ((1ULL << 21) | (1ULL << 22))
 
/* add new RX flags here, don't forget to update CNE_MBUF_F_FIRST_FREE */
 
#define CNE_MBUF_F_FIRST_FREE (1ULL << 23)
#define CNE_MBUF_F_LAST_FREE  (1ULL << 40)
 
/* add new TX flags here, don't forget to update CNE_MBUF_F_LAST_FREE  */
 
#define CNE_MBUF_F_TX_OUTER_UDP_CKSUM (1ULL << 41)
 
#define CNE_MBUF_F_TX_UDP_SEG (1ULL << 42)
 
#define CNE_MBUF_F_TX_SEC_OFFLOAD (1ULL << 43)
 
#define CNE_MBUF_F_TX_MACSEC (1ULL << 44)
 
#define CNE_MBUF_F_TX_TUNNEL_VXLAN  (0x1ULL << 45)
#define CNE_MBUF_F_TX_TUNNEL_GRE    (0x2ULL << 45)
#define CNE_MBUF_F_TX_TUNNEL_IPIP   (0x3ULL << 45)
#define CNE_MBUF_F_TX_TUNNEL_GENEVE (0x4ULL << 45)
#define CNE_MBUF_F_TX_TUNNEL_MPLSINUDP (0x5ULL << 45)
#define CNE_MBUF_F_TX_TUNNEL_VXLAN_GPE (0x6ULL << 45)
#define CNE_MBUF_F_TX_TUNNEL_GTP       (0x7ULL << 45)
#define CNE_MBUF_F_TX_TUNNEL_ESP       (0x8ULL << 45)
#define CNE_MBUF_F_TX_TUNNEL_IP (0xDULL << 45)
#define CNE_MBUF_F_TX_TUNNEL_UDP (0xEULL << 45)
/* add new TX TUNNEL type here */
#define CNE_MBUF_F_TX_TUNNEL_MASK (0xFULL << 45)
 
#define CNE_MBUF_F_TX_QINQ (1ULL << 49)
 
#define CNE_MBUF_F_TX_TCP_SEG (1ULL << 50)
 
#define CNE_MBUF_F_TX_IEEE1588_TMST (1ULL << 51)
 
/*
 * Bits 52+53 used for L4 packet type with checksum enabled: 00: Reserved,
 * 01: TCP checksum, 10: SCTP checksum, 11: UDP checksum. To use hardware
 * L4 checksum offload, the user needs to:
 *  - fill l2_len and l3_len in mbuf
 *  - set the flags CNE_MBUF_F_TX_TCP_CKSUM, CNE_MBUF_F_TX_SCTP_CKSUM or
 *    CNE_MBUF_F_TX_UDP_CKSUM
 *  - set the flag CNE_MBUF_F_TX_IPV4 or CNE_MBUF_F_TX_IPV6
 */
 
#define CNE_MBUF_F_TX_L4_NO_CKSUM (0ULL << 52)
 
#define CNE_MBUF_F_TX_TCP_CKSUM (1ULL << 52)
 
#define CNE_MBUF_F_TX_SCTP_CKSUM (2ULL << 52)
 
#define CNE_MBUF_F_TX_UDP_CKSUM (3ULL << 52)
 
#define CNE_MBUF_F_TX_L4_MASK (3ULL << 52)
 
#define CNE_MBUF_F_TX_IP_CKSUM (1ULL << 54)
 
#define CNE_MBUF_F_TX_IPV4 (1ULL << 55)
 
#define CNE_MBUF_F_TX_IPV6 (1ULL << 56)
 
#define CNE_MBUF_F_TX_VLAN (1ULL << 57)
 
#define CNE_MBUF_F_TX_OUTER_IP_CKSUM (1ULL << 58)
 
#define CNE_MBUF_F_TX_OUTER_IPV4 (1ULL << 59)
 
#define CNE_MBUF_F_TX_OUTER_IPV6 (1ULL << 60)
 
#define CNE_MBUF_TYPE_MCAST (1ULL << 61) 
#define CNE_MBUF_TYPE_BCAST (1ULL << 62) 
#define CNE_MBUF_TYPE_IPv6  (1ULL << 63) 
#define CNE_MBUF_TYPE_MASK                       \
    (CNE_MBUF_TYPE_MCAST | CNE_MBUF_TYPE_BCAST | \
     CNE_MBUF_TYPE_IPv6) 
#define CNE_MBUF_IS_MCAST \
    (CNE_MBUF_TYPE_MCAST | CNE_MBUF_TYPE_BCAST) 
#define CNE_MBUF_F_TX_OFFLOAD_MASK                                                           \
    (CNE_MBUF_F_TX_OUTER_IPV6 | CNE_MBUF_F_TX_OUTER_IPV4 | CNE_MBUF_F_TX_OUTER_IP_CKSUM |    \
     CNE_MBUF_F_TX_VLAN | CNE_MBUF_F_TX_IPV6 | CNE_MBUF_F_TX_IPV4 | CNE_MBUF_F_TX_IP_CKSUM | \
     CNE_MBUF_F_TX_L4_MASK | CNE_MBUF_F_TX_IEEE1588_TMST | CNE_MBUF_F_TX_TCP_SEG |           \
     CNE_MBUF_F_TX_QINQ | CNE_MBUF_F_TX_TUNNEL_MASK | CNE_MBUF_F_TX_MACSEC |                 \
     CNE_MBUF_F_TX_SEC_OFFLOAD | CNE_MBUF_F_TX_UDP_SEG | CNE_MBUF_F_TX_OUTER_UDP_CKSUM)
 
#define CNE_MBUF_F_EXTERNAL (1ULL << 61)
 
#define CNE_MBUF_F_INDIRECT (1ULL << 62) 
enum {
    CNE_MBUF_L2_LEN_BITS        = 7,
    CNE_MBUF_L3_LEN_BITS        = 9,
    CNE_MBUF_L4_LEN_BITS        = 8,
    CNE_MBUF_TSO_SEGSZ_BITS     = 16,
    CNE_MBUF_OUTL3_LEN_BITS     = 9,
    CNE_MBUF_OUTL2_LEN_BITS     = 7,
    CNE_MBUF_TXOFLD_UNUSED_BITS = sizeof(uint64_t) * CHAR_BIT - CNE_MBUF_L2_LEN_BITS -
                                  CNE_MBUF_L3_LEN_BITS - CNE_MBUF_L4_LEN_BITS -
                                  CNE_MBUF_TSO_SEGSZ_BITS - CNE_MBUF_OUTL3_LEN_BITS -
                                  CNE_MBUF_OUTL2_LEN_BITS,
    CNE_MBUF_L2_LEN_OFS        = 0,
    CNE_MBUF_L3_LEN_OFS        = CNE_MBUF_L2_LEN_OFS + CNE_MBUF_L2_LEN_BITS,
    CNE_MBUF_L4_LEN_OFS        = CNE_MBUF_L3_LEN_OFS + CNE_MBUF_L3_LEN_BITS,
    CNE_MBUF_TSO_SEGSZ_OFS     = CNE_MBUF_L4_LEN_OFS + CNE_MBUF_L4_LEN_BITS,
    CNE_MBUF_OUTL3_LEN_OFS     = CNE_MBUF_TSO_SEGSZ_OFS + CNE_MBUF_TSO_SEGSZ_BITS,
    CNE_MBUF_OUTL2_LEN_OFS     = CNE_MBUF_OUTL3_LEN_OFS + CNE_MBUF_OUTL3_LEN_BITS,
    CNE_MBUF_TXOFLD_UNUSED_OFS = CNE_MBUF_OUTL2_LEN_OFS + CNE_MBUF_OUTL2_LEN_BITS,
};
 
#ifdef __cplusplus
}
#endif
 
#endif /* _PKTMBUF_OFFLOAD_H_ */