mbuf: fix performance with 128-byte cache line
[dpdk.git] / app / test / test_mbuf.c
index 1b25481..98ff93a 100644 (file)
@@ -48,7 +48,6 @@
 #include <rte_memcpy.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>
@@ -62,7 +61,7 @@
 
 #include "test.h"
 
-#define MBUF_SIZE               2048
+#define MBUF_DATA_SIZE          2048
 #define NB_MBUF                 128
 #define MBUF_TEST_DATA_LEN      1464
 #define MBUF_TEST_DATA_LEN2     50
 #define MBUF_TEST_HDR2_LEN      30
 #define MBUF_TEST_ALL_HDRS_LEN  (MBUF_TEST_HDR1_LEN+MBUF_TEST_HDR2_LEN)
 
+/* size of private data for mbuf in pktmbuf_pool2 */
+#define MBUF2_PRIV_SIZE         128
+
 #define REFCNT_MAX_ITER         64
 #define REFCNT_MAX_TIMEOUT      10
 #define REFCNT_MAX_REF          (RTE_MAX_LCORE)
 #define REFCNT_MBUF_NUM         64
-#define REFCNT_MBUF_SIZE        (sizeof (struct rte_mbuf) + RTE_PKTMBUF_HEADROOM)
 #define REFCNT_RING_SIZE        (REFCNT_MBUF_NUM * REFCNT_MAX_REF)
 
+#define MAGIC_DATA              0x42424242
+
 #define MAKE_STRING(x)          # x
 
 static struct rte_mempool *pktmbuf_pool = NULL;
+static struct rte_mempool *pktmbuf_pool2 = NULL;
 
-#if defined RTE_MBUF_REFCNT  && defined RTE_MBUF_REFCNT_ATOMIC
+#ifdef RTE_MBUF_REFCNT_ATOMIC
 
 static struct rte_mempool *refcnt_pool = NULL;
 static struct rte_ring *refcnt_mbuf_ring = NULL;
@@ -124,6 +128,10 @@ static unsigned refcnt_lcore[RTE_MAX_LCORE];
  *    - Repeat the test to check that allocation operations
  *      reinitialize the mbuf correctly.
  *
+ * #. Test packet cloning
+ *    - Clone a mbuf and verify the data
+ *    - Clone the cloned mbuf and verify the data
+ *    - Attach a mbuf to another that does not have the same priv_size.
  */
 
 #define GOTO_FAIL(str, ...) do {                                       \
@@ -322,52 +330,209 @@ fail:
 static int
 testclone_testupdate_testdetach(void)
 {
-#ifndef RTE_MBUF_REFCNT
-       return 0;
-#else
-       struct rte_mbuf *mc = NULL;
+       struct rte_mbuf *m = NULL;
        struct rte_mbuf *clone = NULL;
+       struct rte_mbuf *clone2 = NULL;
+       unaligned_uint32_t *data;
 
        /* alloc a mbuf */
-
-       mc = rte_pktmbuf_alloc(pktmbuf_pool);
-       if (mc == NULL)
+       m = rte_pktmbuf_alloc(pktmbuf_pool);
+       if (m == NULL)
                GOTO_FAIL("ooops not allocating mbuf");
 
-       if (rte_pktmbuf_pkt_len(mc) != 0)
+       if (rte_pktmbuf_pkt_len(m) != 0)
                GOTO_FAIL("Bad length");
 
+       rte_pktmbuf_append(m, sizeof(uint32_t));
+       data = rte_pktmbuf_mtod(m, unaligned_uint32_t *);
+       *data = MAGIC_DATA;
 
        /* clone the allocated mbuf */
-       clone = rte_pktmbuf_clone(mc, pktmbuf_pool);
+       clone = rte_pktmbuf_clone(m, pktmbuf_pool);
        if (clone == NULL)
                GOTO_FAIL("cannot clone data\n");
+
+       data = rte_pktmbuf_mtod(clone, unaligned_uint32_t *);
+       if (*data != MAGIC_DATA)
+               GOTO_FAIL("invalid data in clone\n");
+
+       if (rte_mbuf_refcnt_read(m) != 2)
+               GOTO_FAIL("invalid refcnt in m\n");
+
+       /* free the clone */
        rte_pktmbuf_free(clone);
+       clone = NULL;
 
-       mc->next = rte_pktmbuf_alloc(pktmbuf_pool);
-       if(mc->next == NULL)
+       /* same test with a chained mbuf */
+       m->next = rte_pktmbuf_alloc(pktmbuf_pool);
+       if (m->next == NULL)
                GOTO_FAIL("Next Pkt Null\n");
 
-       clone = rte_pktmbuf_clone(mc, pktmbuf_pool);
+       rte_pktmbuf_append(m->next, sizeof(uint32_t));
+       data = rte_pktmbuf_mtod(m->next, unaligned_uint32_t *);
+       *data = MAGIC_DATA;
+
+       clone = rte_pktmbuf_clone(m, pktmbuf_pool);
        if (clone == NULL)
                GOTO_FAIL("cannot clone data\n");
 
+       data = rte_pktmbuf_mtod(clone, unaligned_uint32_t *);
+       if (*data != MAGIC_DATA)
+               GOTO_FAIL("invalid data in clone\n");
+
+       data = rte_pktmbuf_mtod(clone->next, unaligned_uint32_t *);
+       if (*data != MAGIC_DATA)
+               GOTO_FAIL("invalid data in clone->next\n");
+
+       if (rte_mbuf_refcnt_read(m) != 2)
+               GOTO_FAIL("invalid refcnt in m\n");
+
+       if (rte_mbuf_refcnt_read(m->next) != 2)
+               GOTO_FAIL("invalid refcnt in m->next\n");
+
+       /* try to clone the clone */
+
+       clone2 = rte_pktmbuf_clone(clone, pktmbuf_pool);
+       if (clone2 == NULL)
+               GOTO_FAIL("cannot clone the clone\n");
+
+       data = rte_pktmbuf_mtod(clone2, unaligned_uint32_t *);
+       if (*data != MAGIC_DATA)
+               GOTO_FAIL("invalid data in clone2\n");
+
+       data = rte_pktmbuf_mtod(clone2->next, unaligned_uint32_t *);
+       if (*data != MAGIC_DATA)
+               GOTO_FAIL("invalid data in clone2->next\n");
+
+       if (rte_mbuf_refcnt_read(m) != 3)
+               GOTO_FAIL("invalid refcnt in m\n");
+
+       if (rte_mbuf_refcnt_read(m->next) != 3)
+               GOTO_FAIL("invalid refcnt in m->next\n");
+
        /* free mbuf */
-       rte_pktmbuf_free(mc);
+       rte_pktmbuf_free(m);
        rte_pktmbuf_free(clone);
-       mc = NULL;
+       rte_pktmbuf_free(clone2);
+
+       m = NULL;
        clone = NULL;
+       clone2 = NULL;
+       printf("%s ok\n", __func__);
        return 0;
 
 fail:
-       if (mc)
-               rte_pktmbuf_free(mc);
+       if (m)
+               rte_pktmbuf_free(m);
+       if (clone)
+               rte_pktmbuf_free(clone);
+       if (clone2)
+               rte_pktmbuf_free(clone2);
        return -1;
-#endif /* RTE_MBUF_REFCNT */
 }
-#undef GOTO_FAIL
 
+static int
+test_attach_from_different_pool(void)
+{
+       struct rte_mbuf *m = NULL;
+       struct rte_mbuf *clone = NULL;
+       struct rte_mbuf *clone2 = NULL;
+       char *data, *c_data, *c_data2;
 
+       /* alloc a mbuf */
+       m = rte_pktmbuf_alloc(pktmbuf_pool);
+       if (m == NULL)
+               GOTO_FAIL("cannot allocate mbuf");
+
+       if (rte_pktmbuf_pkt_len(m) != 0)
+               GOTO_FAIL("Bad length");
+
+       data = rte_pktmbuf_mtod(m, char *);
+
+       /* allocate a new mbuf from the second pool, and attach it to the first
+        * mbuf */
+       clone = rte_pktmbuf_alloc(pktmbuf_pool2);
+       if (clone == NULL)
+               GOTO_FAIL("cannot allocate mbuf from second pool\n");
+
+       /* check data room size and priv size, and erase priv */
+       if (rte_pktmbuf_data_room_size(clone->pool) != 0)
+               GOTO_FAIL("data room size should be 0\n");
+       if (rte_pktmbuf_priv_size(clone->pool) != MBUF2_PRIV_SIZE)
+               GOTO_FAIL("data room size should be %d\n", MBUF2_PRIV_SIZE);
+       memset(clone + 1, 0, MBUF2_PRIV_SIZE);
+
+       /* save data pointer to compare it after detach() */
+       c_data = rte_pktmbuf_mtod(clone, char *);
+       if (c_data != (char *)clone + sizeof(*clone) + MBUF2_PRIV_SIZE)
+               GOTO_FAIL("bad data pointer in clone");
+       if (rte_pktmbuf_headroom(clone) != 0)
+               GOTO_FAIL("bad headroom in clone");
+
+       rte_pktmbuf_attach(clone, m);
+
+       if (rte_pktmbuf_mtod(clone, char *) != data)
+               GOTO_FAIL("clone was not attached properly\n");
+       if (rte_pktmbuf_headroom(clone) != RTE_PKTMBUF_HEADROOM)
+               GOTO_FAIL("bad headroom in clone after attach");
+       if (rte_mbuf_refcnt_read(m) != 2)
+               GOTO_FAIL("invalid refcnt in m\n");
+
+       /* allocate a new mbuf from the second pool, and attach it to the first
+        * cloned mbuf */
+       clone2 = rte_pktmbuf_alloc(pktmbuf_pool2);
+       if (clone2 == NULL)
+               GOTO_FAIL("cannot allocate clone2 from second pool\n");
+
+       /* check data room size and priv size, and erase priv */
+       if (rte_pktmbuf_data_room_size(clone2->pool) != 0)
+               GOTO_FAIL("data room size should be 0\n");
+       if (rte_pktmbuf_priv_size(clone2->pool) != MBUF2_PRIV_SIZE)
+               GOTO_FAIL("data room size should be %d\n", MBUF2_PRIV_SIZE);
+       memset(clone2 + 1, 0, MBUF2_PRIV_SIZE);
+
+       /* save data pointer to compare it after detach() */
+       c_data2 = rte_pktmbuf_mtod(clone2, char *);
+       if (c_data2 != (char *)clone2 + sizeof(*clone2) + MBUF2_PRIV_SIZE)
+               GOTO_FAIL("bad data pointer in clone2");
+       if (rte_pktmbuf_headroom(clone2) != 0)
+               GOTO_FAIL("bad headroom in clone2");
+
+       rte_pktmbuf_attach(clone2, clone);
+
+       if (rte_pktmbuf_mtod(clone2, char *) != data)
+               GOTO_FAIL("clone2 was not attached properly\n");
+       if (rte_pktmbuf_headroom(clone2) != RTE_PKTMBUF_HEADROOM)
+               GOTO_FAIL("bad headroom in clone2 after attach");
+       if (rte_mbuf_refcnt_read(m) != 3)
+               GOTO_FAIL("invalid refcnt in m\n");
+
+       /* detach the clones */
+       rte_pktmbuf_detach(clone);
+       if (c_data != rte_pktmbuf_mtod(clone, char *))
+               GOTO_FAIL("clone was not detached properly\n");
+
+       rte_pktmbuf_detach(clone2);
+       if (c_data2 != rte_pktmbuf_mtod(clone2, char *))
+               GOTO_FAIL("clone2 was not detached properly\n");
+
+       /* free the clones and the initial mbuf */
+       rte_pktmbuf_free(clone2);
+       rte_pktmbuf_free(clone);
+       rte_pktmbuf_free(m);
+       printf("%s ok\n", __func__);
+       return 0;
+
+fail:
+       if (m)
+               rte_pktmbuf_free(m);
+       if (clone)
+               rte_pktmbuf_free(clone);
+       if (clone2)
+               rte_pktmbuf_free(clone2);
+       return -1;
+}
+#undef GOTO_FAIL
 
 /*
  * test allocation and free of mbufs
@@ -396,13 +561,11 @@ test_pktmbuf_pool(void)
                printf("Error pool not empty");
                ret = -1;
        }
-#ifdef RTE_MBUF_REFCNT
        extra = rte_pktmbuf_clone(m[0], pktmbuf_pool);
        if(extra != NULL) {
                printf("Error pool not empty");
                ret = -1;
        }
-#endif
        /* free them */
        for (i=0; i<NB_MBUF; i++) {
                if (m[i] != NULL)
@@ -431,6 +594,7 @@ test_pktmbuf_pool_ptr(void)
                if (m[i] == NULL) {
                        printf("rte_pktmbuf_alloc() failed (%u)\n", i);
                        ret = -1;
+                       break;
                }
                m[i]->data_off += 64;
        }
@@ -450,6 +614,7 @@ test_pktmbuf_pool_ptr(void)
                if (m[i] == NULL) {
                        printf("rte_pktmbuf_alloc() failed (%u)\n", i);
                        ret = -1;
+                       break;
                }
                if (m[i]->data_off != RTE_PKTMBUF_HEADROOM) {
                        printf("invalid data_off\n");
@@ -504,12 +669,11 @@ test_pktmbuf_free_segment(void)
 
 /*
  * Stress test for rte_mbuf atomic refcnt.
- * Implies that:
- * RTE_MBUF_REFCNT and RTE_MBUF_REFCNT_ATOMIC are both defined.
+ * Implies that RTE_MBUF_REFCNT_ATOMIC is defined.
  * For more efficency, recomended to run with RTE_LIBRTE_MBUF_DEBUG defined.
  */
 
-#if defined RTE_MBUF_REFCNT  && defined RTE_MBUF_REFCNT_ATOMIC
+#ifdef RTE_MBUF_REFCNT_ATOMIC
 
 static int
 test_refcnt_slave(__attribute__((unused)) void *arg)
@@ -532,7 +696,7 @@ test_refcnt_slave(__attribute__((unused)) void *arg)
        printf("%s finished at lcore %u, "
               "number of freed mbufs: %u\n",
               __func__, lcore, free);
-       return (0);
+       return 0;
 }
 
 static void
@@ -606,7 +770,7 @@ test_refcnt_master(void)
        rte_wmb();
 
        printf("%s finished at lcore %u\n", __func__, lcore);
-       return (0);
+       return 0;
 }
 
 #endif
@@ -614,7 +778,7 @@ test_refcnt_master(void)
 static int
 test_refcnt_mbuf(void)
 {
-#if defined RTE_MBUF_REFCNT  && defined RTE_MBUF_REFCNT_ATOMIC
+#ifdef RTE_MBUF_REFCNT_ATOMIC
 
        unsigned lnum, master, slave, tref;
 
@@ -622,7 +786,7 @@ test_refcnt_mbuf(void)
        if ((lnum = rte_lcore_count()) == 1) {
                printf("skipping %s, number of lcores: %u is not enough\n",
                    __func__, lnum);
-               return (0);
+               return 0;
        }
 
        printf("starting %s, at %u lcores\n", __func__, lnum);
@@ -630,15 +794,13 @@ test_refcnt_mbuf(void)
        /* create refcnt pool & ring if they don't exist */
 
        if (refcnt_pool == NULL &&
-                       (refcnt_pool = rte_mempool_create(
-                       MAKE_STRING(refcnt_pool),
-                       REFCNT_MBUF_NUM, REFCNT_MBUF_SIZE, 0,
-                       sizeof(struct rte_pktmbuf_pool_private),
-                       rte_pktmbuf_pool_init, NULL, rte_pktmbuf_init, NULL,
-                       SOCKET_ID_ANY, 0)) == NULL) {
+                       (refcnt_pool = rte_pktmbuf_pool_create(
+                               MAKE_STRING(refcnt_pool),
+                               REFCNT_MBUF_NUM, 0, 0, 0,
+                               SOCKET_ID_ANY)) == NULL) {
                printf("%s: cannot allocate " MAKE_STRING(refcnt_pool) "\n",
                    __func__);
-               return (-1);
+               return -1;
        }
 
        if (refcnt_mbuf_ring == NULL &&
@@ -647,7 +809,7 @@ test_refcnt_mbuf(void)
                        RING_F_SP_ENQ)) == NULL) {
                printf("%s: cannot allocate " MAKE_STRING(refcnt_mbuf_ring)
                    "\n", __func__);
-               return (-1);
+               return -1;
        }
 
        refcnt_stop_slaves = 0;
@@ -674,24 +836,13 @@ test_refcnt_mbuf(void)
        rte_ring_dump(stdout, refcnt_mbuf_ring);
 
 #endif
-       return (0);
-}
-
-#ifdef RTE_EXEC_ENV_BAREMETAL
-
-/* baremetal - don't test failing sanity checks */
-static int
-test_failing_mbuf_sanity_check(void)
-{
        return 0;
 }
 
-#else
-
 #include <unistd.h>
 #include <sys/wait.h>
 
-/* linuxapp - use fork() to test mbuf errors panic */
+/* use fork() to test mbuf errors panic */
 static int
 verify_mbuf_check_panics(struct rte_mbuf *buf)
 {
@@ -758,7 +909,6 @@ test_failing_mbuf_sanity_check(void)
                return -1;
        }
 
-#ifdef RTE_MBUF_REFCNT
        badbuf = *buf;
        badbuf.refcnt = 0;
        if (verify_mbuf_check_panics(&badbuf)) {
@@ -772,27 +922,20 @@ test_failing_mbuf_sanity_check(void)
                printf("Error with bad-refcnt(MAX) mbuf test\n");
                return -1;
        }
-#endif
 
        return 0;
 }
-#endif
 
 
 static int
 test_mbuf(void)
 {
-       RTE_BUILD_BUG_ON(sizeof(struct rte_mbuf) != 64);
+       RTE_BUILD_BUG_ON(sizeof(struct rte_mbuf) != RTE_CACHE_LINE_MIN_SIZE * 2);
 
        /* create pktmbuf pool if it does not exist */
        if (pktmbuf_pool == NULL) {
-               pktmbuf_pool =
-                       rte_mempool_create("test_pktmbuf_pool", NB_MBUF,
-                                          MBUF_SIZE, 32,
-                                          sizeof(struct rte_pktmbuf_pool_private),
-                                          rte_pktmbuf_pool_init, NULL,
-                                          rte_pktmbuf_init, NULL,
-                                          SOCKET_ID_ANY, 0);
+               pktmbuf_pool = rte_pktmbuf_pool_create("test_pktmbuf_pool",
+                       NB_MBUF, 32, 0, MBUF_DATA_SIZE, SOCKET_ID_ANY);
        }
 
        if (pktmbuf_pool == NULL) {
@@ -800,6 +943,18 @@ test_mbuf(void)
                return -1;
        }
 
+       /* create a specific pktmbuf pool with a priv_size != 0 and no data
+        * room size */
+       if (pktmbuf_pool2 == NULL) {
+               pktmbuf_pool2 = rte_pktmbuf_pool_create("test_pktmbuf_pool2",
+                       NB_MBUF, 32, MBUF2_PRIV_SIZE, 0, SOCKET_ID_ANY);
+       }
+
+       if (pktmbuf_pool2 == NULL) {
+               printf("cannot allocate mbuf pool\n");
+               return -1;
+       }
+
        /* test multiple mbuf alloc */
        if (test_pktmbuf_pool() < 0) {
                printf("test_mbuf_pool() failed\n");
@@ -850,6 +1005,11 @@ test_mbuf(void)
                return -1;
        }
 
+       if (test_attach_from_different_pool() < 0) {
+               printf("test_attach_from_different_pool() failed\n");
+               return -1;
+       }
+
        if (test_refcnt_mbuf()<0){
                printf("test_refcnt_mbuf() failed \n");
                return -1;