mbuf: introduce a flag to indicate a control mbuf
[dpdk.git] / lib / librte_mbuf / rte_mbuf.h
index d66b9bd..b9a1c66 100644 (file)
@@ -91,6 +91,7 @@ extern "C" {
 #define PKT_TX_IPV4_CSUM     0x1000 /**< Alias of PKT_TX_IP_CKSUM. */
 #define PKT_TX_IPV4          PKT_RX_IPV4_HDR /**< IPv4 with no IP checksum offload. */
 #define PKT_TX_IPV6          PKT_RX_IPV6_HDR /**< IPv6 packet */
+
 /*
  * Bit 14~13 used for L4 packet type with checksum enabled.
  *     00: Reserved
@@ -106,40 +107,25 @@ extern "C" {
 /* Bit 15 */
 #define PKT_TX_IEEE1588_TMST 0x8000 /**< TX IEEE1588 packet to timestamp. */
 
+/* Use final bit of flags to indicate a control mbuf */
+#define CTRL_MBUF_FLAG       (1ULL << 63)
+
 /**
  * Bit Mask to indicate what bits required for building TX context
  */
 #define PKT_TX_OFFLOAD_MASK (PKT_TX_VLAN_PKT | PKT_TX_IP_CKSUM | PKT_TX_L4_MASK)
 
-/** Offload features */
-union rte_vlan_macip {
-       uint32_t data;
-       struct {
-               uint16_t l3_len:9; /**< L3 (IP) Header Length. */
-               uint16_t l2_len:7; /**< L2 (MAC) Header Length. */
-               uint16_t vlan_tci;
-               /**< VLAN Tag Control Identifier (CPU order). */
-       } f;
-};
-
-/*
- * Compare mask for vlan_macip_len.data,
- * should be in sync with rte_vlan_macip.f layout.
- * */
-#define TX_VLAN_CMP_MASK        0xFFFF0000  /**< VLAN length - 16-bits. */
-#define TX_MAC_LEN_CMP_MASK     0x0000FE00  /**< MAC length - 7-bits. */
-#define TX_IP_LEN_CMP_MASK      0x000001FF  /**< IP  length - 9-bits. */
-/**< MAC+IP  length. */
-#define TX_MACIP_LEN_CMP_MASK   (TX_MAC_LEN_CMP_MASK | TX_IP_LEN_CMP_MASK)
-
 /**
  * The generic rte_mbuf, containing a packet mbuf.
  */
 struct rte_mbuf {
-       struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
        void *buf_addr;           /**< Virtual address of segment buffer. */
        phys_addr_t buf_physaddr; /**< Physical address of segment buffer. */
+
+       /* next 8 bytes are initialised on RX descriptor rearm */
        uint16_t buf_len;         /**< Length of segment buffer. */
+       uint16_t data_off;
+
 #ifdef RTE_MBUF_REFCNT
        /**
         * 16-bit Reference counter.
@@ -156,21 +142,23 @@ struct rte_mbuf {
 #else
        uint16_t refcnt_reserved;     /**< Do not use this field */
 #endif
-       uint16_t reserved;            /**< Unused field. Required for padding */
-       uint16_t ol_flags;            /**< Offload features. */
-
-       /* valid for any segment */
-       struct rte_mbuf *next;  /**< Next segment of scattered packet. */
-       void* data;             /**< Start address of data in segment buffer. */
-       uint16_t data_len;      /**< Amount of data in segment buffer. */
-
-       /* these fields are valid for first segment only */
        uint8_t nb_segs;        /**< Number of segments. */
-       uint8_t in_port;        /**< Input port. */
-       uint32_t pkt_len;       /**< Total pkt len: sum of all segment data_len. */
+       uint8_t port;           /**< Input port. */
 
-       /* offload features, valid for first segment only */
-       union rte_vlan_macip vlan_macip;
+       uint64_t ol_flags;      /**< Offload features. */
+
+       /* remaining bytes are set on RX when pulling packet from descriptor */
+       uint16_t reserved2;     /**< Unused field. Required for padding */
+       uint16_t data_len;      /**< Amount of data in segment buffer. */
+       uint32_t pkt_len;       /**< Total pkt len: sum of all segments. */
+       union {
+               uint16_t l2_l3_len; /**< combined l2/l3 lengths as single var */
+               struct {
+                       uint16_t l3_len:9;      /**< L3 (IP) Header Length. */
+                       uint16_t l2_len:7;      /**< L2 (MAC) Header Length. */
+               };
+       };
+       uint16_t vlan_tci;      /**< VLAN Tag Control Identifier (CPU order). */
        union {
                uint32_t rss;       /**< RSS hash result if RSS enabled */
                struct {
@@ -180,12 +168,16 @@ struct rte_mbuf {
                uint32_t sched;     /**< Hierarchical scheduler */
        } hash;                 /**< hash information */
 
+       /* fields only used in slow path or on TX */
+       struct rte_mempool *pool; /**< Pool from which mbuf was allocated. */
+       struct rte_mbuf *next;    /**< Next segment of scattered packet. */
+
        union {
                uint8_t metadata[0];
                uint16_t metadata16[0];
                uint32_t metadata32[0];
                uint64_t metadata64[0];
-       };
+       } __rte_cache_aligned;
 } __rte_cache_aligned;
 
 #define RTE_MBUF_METADATA_UINT8(mbuf, offset)              \
@@ -471,7 +463,7 @@ void rte_ctrlmbuf_init(struct rte_mempool *mp, void *opaque_arg,
  * @param m
  *   The control mbuf.
  */
-#define rte_ctrlmbuf_data(m) ((m)->data)
+#define rte_ctrlmbuf_data(m) ((char *)((m)->buf_addr) + (m)->data_off)
 
 /**
  * A macro that returns the length of the carried data.
@@ -483,6 +475,21 @@ void rte_ctrlmbuf_init(struct rte_mempool *mp, void *opaque_arg,
  */
 #define rte_ctrlmbuf_len(m) rte_pktmbuf_data_len(m)
 
+/**
+ * Tests if an mbuf is a control mbuf
+ *
+ * @param m
+ *   The mbuf to be tested
+ * @return
+ *   - True (1) if the mbuf is a control mbuf
+ *   - False(0) otherwise
+ */
+static inline int
+rte_is_ctrlmbuf(struct rte_mbuf *m)
+{
+       return (!!(m->ol_flags & CTRL_MBUF_FLAG));
+}
+
 /* Operations on pkt mbuf */
 
 /**
@@ -536,18 +543,16 @@ void rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg);
  */
 static inline void rte_pktmbuf_reset(struct rte_mbuf *m)
 {
-       uint32_t buf_ofs;
-
        m->next = NULL;
        m->pkt_len = 0;
-       m->vlan_macip.data = 0;
+       m->l2_l3_len = 0;
+       m->vlan_tci = 0;
        m->nb_segs = 1;
-       m->in_port = 0xff;
+       m->port = 0xff;
 
        m->ol_flags = 0;
-       buf_ofs = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
+       m->data_off = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
                        RTE_PKTMBUF_HEADROOM : m->buf_len;
-       m->data = (char*) m->buf_addr + buf_ofs;
 
        m->data_len = 0;
        __rte_mbuf_sanity_check(m, 1);
@@ -604,10 +609,11 @@ static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *md)
        mi->buf_len = md->buf_len;
 
        mi->next = md->next;
-       mi->data = md->data;
+       mi->data_off = md->data_off;
        mi->data_len = md->data_len;
-       mi->in_port = md->in_port;
-       mi->vlan_macip = md->vlan_macip;
+       mi->port = md->port;
+       mi->vlan_tci = md->vlan_tci;
+       mi->l2_l3_len = md->l2_l3_len;
        mi->hash = md->hash;
 
        mi->next = NULL;
@@ -633,16 +639,14 @@ static inline void rte_pktmbuf_detach(struct rte_mbuf *m)
 {
        const struct rte_mempool *mp = m->pool;
        void *buf = RTE_MBUF_TO_BADDR(m);
-       uint32_t buf_ofs;
        uint32_t buf_len = mp->elt_size - sizeof(*m);
        m->buf_physaddr = rte_mempool_virt2phy(mp, m) + sizeof (*m);
 
        m->buf_addr = buf;
        m->buf_len = (uint16_t)buf_len;
 
-       buf_ofs = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
+       m->data_off = (RTE_PKTMBUF_HEADROOM <= m->buf_len) ?
                        RTE_PKTMBUF_HEADROOM : m->buf_len;
-       m->data = (char*) m->buf_addr + buf_ofs;
 
        m->data_len = 0;
 }
@@ -806,7 +810,7 @@ static inline void rte_pktmbuf_refcnt_update(struct rte_mbuf *m, int16_t v)
 static inline uint16_t rte_pktmbuf_headroom(const struct rte_mbuf *m)
 {
        __rte_mbuf_sanity_check(m, 1);
-       return (uint16_t) ((char*) m->data - (char*) m->buf_addr);
+       return m->data_off;
 }
 
 /**
@@ -854,7 +858,7 @@ static inline struct rte_mbuf *rte_pktmbuf_lastseg(struct rte_mbuf *m)
  * @param t
  *   The type to cast the result into.
  */
-#define rte_pktmbuf_mtod(m, t) ((t)((m)->data))
+#define rte_pktmbuf_mtod(m, t) ((t)((char *)(m)->buf_addr + (m)->data_off))
 
 /**
  * A macro that returns the length of the packet.
@@ -899,11 +903,11 @@ static inline char *rte_pktmbuf_prepend(struct rte_mbuf *m,
        if (unlikely(len > rte_pktmbuf_headroom(m)))
                return NULL;
 
-       m->data = (char*) m->data - len;
+       m->data_off -= len;
        m->data_len = (uint16_t)(m->data_len + len);
        m->pkt_len  = (m->pkt_len + len);
 
-       return (char*) m->data;
+       return (char *)m->buf_addr + m->data_off;
 }
 
 /**
@@ -932,7 +936,7 @@ static inline char *rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
        if (unlikely(len > rte_pktmbuf_tailroom(m_last)))
                return NULL;
 
-       tail = (char*) m_last->data + m_last->data_len;
+       tail = (char *)m_last->buf_addr + m_last->data_off + m_last->data_len;
        m_last->data_len = (uint16_t)(m_last->data_len + len);
        m->pkt_len  = (m->pkt_len + len);
        return (char*) tail;
@@ -960,9 +964,9 @@ static inline char *rte_pktmbuf_adj(struct rte_mbuf *m, uint16_t len)
                return NULL;
 
        m->data_len = (uint16_t)(m->data_len - len);
-       m->data = ((char*) m->data + len);
+       m->data_off += len;
        m->pkt_len  = (m->pkt_len - len);
-       return (char*) m->data;
+       return (char *)m->buf_addr + m->data_off;
 }
 
 /**