mbuf: add new Rx flags for stripped VLAN
[dpdk.git] / lib / librte_mbuf / rte_mbuf.c
index 52e7574..2ece742 100644 (file)
@@ -2,6 +2,7 @@
  *   BSD LICENSE
  *
  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
+ *   Copyright 2014 6WIND S.A.
  *   All rights reserved.
  *
  *   Redistribution and use in source and binary forms, with or without
@@ -47,7 +48,6 @@
 #include <rte_memory.h>
 #include <rte_memzone.h>
 #include <rte_launch.h>
-#include <rte_tailq.h>
 #include <rte_eal.h>
 #include <rte_per_lcore.h>
 #include <rte_lcore.h>
@@ -58,6 +58,7 @@
 #include <rte_mbuf.h>
 #include <rte_string_fns.h>
 #include <rte_hexdump.h>
+#include <rte_errno.h>
 
 /*
  * ctrlmbuf constructor, given as a callback function to
@@ -81,17 +82,30 @@ rte_ctrlmbuf_init(struct rte_mempool *mp,
 void
 rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg)
 {
-       struct rte_pktmbuf_pool_private *mbp_priv;
+       struct rte_pktmbuf_pool_private *user_mbp_priv, *mbp_priv;
+       struct rte_pktmbuf_pool_private default_mbp_priv;
        uint16_t roomsz;
 
-       mbp_priv = rte_mempool_get_priv(mp);
-       roomsz = (uint16_t)(uintptr_t)opaque_arg;
+       RTE_ASSERT(mp->elt_size >= sizeof(struct rte_mbuf));
+
+       /* if no structure is provided, assume no mbuf private area */
+       user_mbp_priv = opaque_arg;
+       if (user_mbp_priv == NULL) {
+               default_mbp_priv.mbuf_priv_size = 0;
+               if (mp->elt_size > sizeof(struct rte_mbuf))
+                       roomsz = mp->elt_size - sizeof(struct rte_mbuf);
+               else
+                       roomsz = 0;
+               default_mbp_priv.mbuf_data_room_size = roomsz;
+               user_mbp_priv = &default_mbp_priv;
+       }
 
-       /* Use default data room size. */
-       if (0 == roomsz)
-               roomsz = 2048 + RTE_PKTMBUF_HEADROOM;
+       RTE_ASSERT(mp->elt_size >= sizeof(struct rte_mbuf) +
+               user_mbp_priv->mbuf_data_room_size +
+               user_mbp_priv->mbuf_priv_size);
 
-       mbp_priv->mbuf_data_room_size = roomsz;
+       mbp_priv = rte_mempool_get_priv(mp);
+       memcpy(mbp_priv, user_mbp_priv, sizeof(*mbp_priv));
 }
 
 /*
@@ -106,16 +120,22 @@ rte_pktmbuf_init(struct rte_mempool *mp,
                 __attribute__((unused)) unsigned i)
 {
        struct rte_mbuf *m = _m;
-       uint32_t buf_len = mp->elt_size - sizeof(struct rte_mbuf);
+       uint32_t mbuf_size, buf_len, priv_size;
+
+       priv_size = rte_pktmbuf_priv_size(mp);
+       mbuf_size = sizeof(struct rte_mbuf) + priv_size;
+       buf_len = rte_pktmbuf_data_room_size(mp);
 
-       RTE_MBUF_ASSERT(mp->elt_size >= sizeof(struct rte_mbuf));
+       RTE_ASSERT(RTE_ALIGN(priv_size, RTE_MBUF_PRIV_ALIGN) == priv_size);
+       RTE_ASSERT(mp->elt_size >= mbuf_size);
+       RTE_ASSERT(buf_len <= UINT16_MAX);
 
        memset(m, 0, mp->elt_size);
 
-       /* start of buffer is just after mbuf structure */
-       m->buf_addr = (char *)m + sizeof(struct rte_mbuf);
-       m->buf_physaddr = rte_mempool_virt2phy(mp, m) +
-                       sizeof(struct rte_mbuf);
+       /* start of buffer is after mbuf structure and priv data */
+       m->priv_size = priv_size;
+       m->buf_addr = (char *)m + mbuf_size;
+       m->buf_physaddr = rte_mempool_virt2phy(mp, m) + mbuf_size;
        m->buf_len = (uint16_t)buf_len;
 
        /* keep some headroom between start of buffer and data */
@@ -127,6 +147,32 @@ rte_pktmbuf_init(struct rte_mempool *mp,
        m->port = 0xff;
 }
 
+/* helper to create a mbuf pool */
+struct rte_mempool *
+rte_pktmbuf_pool_create(const char *name, unsigned n,
+       unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
+       int socket_id)
+{
+       struct rte_pktmbuf_pool_private mbp_priv;
+       unsigned elt_size;
+
+       if (RTE_ALIGN(priv_size, RTE_MBUF_PRIV_ALIGN) != priv_size) {
+               RTE_LOG(ERR, MBUF, "mbuf priv_size=%u is not aligned\n",
+                       priv_size);
+               rte_errno = EINVAL;
+               return NULL;
+       }
+       elt_size = sizeof(struct rte_mbuf) + (unsigned)priv_size +
+               (unsigned)data_room_size;
+       mbp_priv.mbuf_data_room_size = data_room_size;
+       mbp_priv.mbuf_priv_size = priv_size;
+
+       return rte_mempool_create(name, n, elt_size,
+               cache_size, sizeof(struct rte_pktmbuf_pool_private),
+               rte_pktmbuf_pool_init, &mbp_priv, rte_pktmbuf_init, NULL,
+               socket_id, 0);
+}
+
 /* do some sanity checks on a mbuf: panic if it fails */
 void
 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header)
@@ -145,11 +191,9 @@ rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header)
        if (m->buf_addr == NULL)
                rte_panic("bad virt addr\n");
 
-#ifdef RTE_MBUF_REFCNT
        uint16_t cnt = rte_mbuf_refcnt_read(m);
        if ((cnt == 0) || (cnt == UINT16_MAX))
                rte_panic("bad ref cnt\n");
-#endif
 
        /* nothing to check for sub-segments */
        if (is_header == 0)
@@ -196,3 +240,51 @@ rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len)
                nb_segs --;
        }
 }
+
+/*
+ * Get the name of a RX offload flag. Must be kept synchronized with flag
+ * definitions in rte_mbuf.h.
+ */
+const char *rte_get_rx_ol_flag_name(uint64_t mask)
+{
+       switch (mask) {
+       case PKT_RX_VLAN_PKT: return "PKT_RX_VLAN_PKT";
+       case PKT_RX_RSS_HASH: return "PKT_RX_RSS_HASH";
+       case PKT_RX_FDIR: return "PKT_RX_FDIR";
+       case PKT_RX_L4_CKSUM_BAD: return "PKT_RX_L4_CKSUM_BAD";
+       case PKT_RX_IP_CKSUM_BAD: return "PKT_RX_IP_CKSUM_BAD";
+       case PKT_RX_EIP_CKSUM_BAD: return "PKT_RX_EIP_CKSUM_BAD";
+       /* case PKT_RX_OVERSIZE: return "PKT_RX_OVERSIZE"; */
+       /* case PKT_RX_HBUF_OVERFLOW: return "PKT_RX_HBUF_OVERFLOW"; */
+       /* case PKT_RX_RECIP_ERR: return "PKT_RX_RECIP_ERR"; */
+       /* case PKT_RX_MAC_ERR: return "PKT_RX_MAC_ERR"; */
+       case PKT_RX_VLAN_STRIPPED: return "PKT_RX_VLAN_STRIPPED";
+       case PKT_RX_IEEE1588_PTP: return "PKT_RX_IEEE1588_PTP";
+       case PKT_RX_IEEE1588_TMST: return "PKT_RX_IEEE1588_TMST";
+       case PKT_RX_QINQ_STRIPPED: return "PKT_RX_QINQ_STRIPPED";
+       default: return NULL;
+       }
+}
+
+/*
+ * Get the name of a TX offload flag. Must be kept synchronized with flag
+ * definitions in rte_mbuf.h.
+ */
+const char *rte_get_tx_ol_flag_name(uint64_t mask)
+{
+       switch (mask) {
+       case PKT_TX_VLAN_PKT: return "PKT_TX_VLAN_PKT";
+       case PKT_TX_IP_CKSUM: return "PKT_TX_IP_CKSUM";
+       case PKT_TX_TCP_CKSUM: return "PKT_TX_TCP_CKSUM";
+       case PKT_TX_SCTP_CKSUM: return "PKT_TX_SCTP_CKSUM";
+       case PKT_TX_UDP_CKSUM: return "PKT_TX_UDP_CKSUM";
+       case PKT_TX_IEEE1588_TMST: return "PKT_TX_IEEE1588_TMST";
+       case PKT_TX_TCP_SEG: return "PKT_TX_TCP_SEG";
+       case PKT_TX_IPV4: return "PKT_TX_IPV4";
+       case PKT_TX_IPV6: return "PKT_TX_IPV6";
+       case PKT_TX_OUTER_IP_CKSUM: return "PKT_TX_OUTER_IP_CKSUM";
+       case PKT_TX_OUTER_IPV4: return "PKT_TX_OUTER_IPV4";
+       case PKT_TX_OUTER_IPV6: return "PKT_TX_OUTER_IPV6";
+       default: return NULL;
+       }
+}