apps: use helper to create mbuf pools
[dpdk.git] / app / test / test_mbuf.c
index 3efad0f..4774263 100644 (file)
@@ -1,35 +1,34 @@
 /*-
  *   BSD LICENSE
- * 
- *   Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
+ *
+ *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
  *   All rights reserved.
- * 
- *   Redistribution and use in source and binary forms, with or without 
- *   modification, are permitted provided that the following conditions 
+ *
+ *   Redistribution and use in source and binary forms, with or without
+ *   modification, are permitted provided that the following conditions
  *   are met:
- * 
- *     * Redistributions of source code must retain the above copyright 
+ *
+ *     * Redistributions of source code must retain the above copyright
  *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright 
- *       notice, this list of conditions and the following disclaimer in 
- *       the documentation and/or other materials provided with the 
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in
+ *       the documentation and/or other materials provided with the
  *       distribution.
- *     * Neither the name of Intel Corporation nor the names of its 
- *       contributors may be used to endorse or promote products derived 
+ *     * Neither the name of Intel Corporation nor the names of its
+ *       contributors may be used to endorse or promote products derived
  *       from this software without specific prior written permission.
- * 
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
+ *
+ *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- * 
  */
 
 #include <string.h>
@@ -49,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>
 #include <rte_random.h>
 #include <rte_cycles.h>
 
-#include <cmdline_parse.h>
-
 #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 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 MAKE_STRING(x)          # x
 
 static struct rte_mempool *pktmbuf_pool = NULL;
-static struct rte_mempool *ctrlmbuf_pool = NULL;
 
-#if defined RTE_MBUF_SCATTER_GATHER  && 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;
@@ -161,7 +155,7 @@ test_pktmbuf_with_non_ascii_data(void)
        memset(data, 0xff, rte_pktmbuf_pkt_len(m));
        if (!rte_pktmbuf_is_contiguous(m))
                GOTO_FAIL("Buffer should be continuous");
-       rte_pktmbuf_dump(m, MBUF_TEST_DATA_LEN);
+       rte_pktmbuf_dump(stdout, m, MBUF_TEST_DATA_LEN);
 
        rte_pktmbuf_free(m);
 
@@ -194,7 +188,7 @@ test_one_pktmbuf(void)
        if (rte_pktmbuf_pkt_len(m) != 0)
                GOTO_FAIL("Bad length");
 
-       rte_pktmbuf_dump(m, 0);
+       rte_pktmbuf_dump(stdout, m, 0);
 
        /* append data */
 
@@ -208,8 +202,8 @@ test_one_pktmbuf(void)
        memset(data, 0x66, rte_pktmbuf_pkt_len(m));
        if (!rte_pktmbuf_is_contiguous(m))
                GOTO_FAIL("Buffer should be continuous");
-       rte_pktmbuf_dump(m, MBUF_TEST_DATA_LEN);
-       rte_pktmbuf_dump(m, 2*MBUF_TEST_DATA_LEN);
+       rte_pktmbuf_dump(stdout, m, MBUF_TEST_DATA_LEN);
+       rte_pktmbuf_dump(stdout, m, 2*MBUF_TEST_DATA_LEN);
 
        /* this append should fail */
 
@@ -275,9 +269,9 @@ test_one_pktmbuf(void)
                GOTO_FAIL("Buffer should be continuous");
        memset(hdr, 0x55, MBUF_TEST_HDR2_LEN);
 
-       rte_mbuf_sanity_check(m, RTE_MBUF_PKT, 1);
-       rte_mbuf_sanity_check(m, RTE_MBUF_PKT, 0);
-       rte_pktmbuf_dump(m, 0);
+       rte_mbuf_sanity_check(m, 1);
+       rte_mbuf_sanity_check(m, 0);
+       rte_pktmbuf_dump(stdout, m, 0);
 
        /* this prepend should fail */
 
@@ -323,54 +317,9 @@ fail:
        return -1;
 }
 
-/*
- * test control mbuf
- */
-static int
-test_one_ctrlmbuf(void)
-{
-       struct rte_mbuf *m = NULL;
-       char message[] = "This is a message carried by a ctrlmbuf";
-
-       printf("Test ctrlmbuf API\n");
-
-       /* alloc a mbuf */
-
-       m = rte_ctrlmbuf_alloc(ctrlmbuf_pool);
-       if (m == NULL)
-               GOTO_FAIL("Cannot allocate mbuf");
-       if (rte_ctrlmbuf_len(m) != 0)
-               GOTO_FAIL("Bad length");
-
-       /* set data */
-       rte_ctrlmbuf_data(m) = &message;
-       rte_ctrlmbuf_len(m) = sizeof(message);
-
-       /* read data */
-       if (rte_ctrlmbuf_data(m) != message)
-               GOTO_FAIL("Invalid data pointer");
-       if (rte_ctrlmbuf_len(m) != sizeof(message))
-               GOTO_FAIL("Invalid len");
-
-       rte_mbuf_sanity_check(m, RTE_MBUF_CTRL, 0);
-
-       /* free mbuf */
-       rte_ctrlmbuf_free(m);
-       m = NULL;
-       return 0;
-
-fail:
-       if (m)
-               rte_ctrlmbuf_free(m);
-       return -1;
-}
-
 static int
 testclone_testupdate_testdetach(void)
 {
-#ifndef RTE_MBUF_SCATTER_GATHER
-       return 0;
-#else
        struct rte_mbuf *mc = NULL;
        struct rte_mbuf *clone = NULL;
 
@@ -390,8 +339,8 @@ testclone_testupdate_testdetach(void)
                GOTO_FAIL("cannot clone data\n");
        rte_pktmbuf_free(clone);
 
-       mc->pkt.next = rte_pktmbuf_alloc(pktmbuf_pool);
-       if(mc->pkt.next == NULL)
+       mc->next = rte_pktmbuf_alloc(pktmbuf_pool);
+       if(mc->next == NULL)
                GOTO_FAIL("Next Pkt Null\n");
 
        clone = rte_pktmbuf_clone(mc, pktmbuf_pool);
@@ -409,7 +358,6 @@ fail:
        if (mc)
                rte_pktmbuf_free(mc);
        return -1;
-#endif /* RTE_MBUF_SCATTER_GATHER */
 }
 #undef GOTO_FAIL
 
@@ -442,13 +390,11 @@ test_pktmbuf_pool(void)
                printf("Error pool not empty");
                ret = -1;
        }
-#ifdef RTE_MBUF_SCATTER_GATHER
        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)
@@ -467,7 +413,7 @@ test_pktmbuf_pool_ptr(void)
        unsigned i;
        struct rte_mbuf *m[NB_MBUF];
        int ret = 0;
-               
+
        for (i=0; i<NB_MBUF; i++)
                m[i] = NULL;
 
@@ -478,7 +424,7 @@ test_pktmbuf_pool_ptr(void)
                        printf("rte_pktmbuf_alloc() failed (%u)\n", i);
                        ret = -1;
                }
-               m[i]->pkt.data = RTE_PTR_ADD(m[i]->pkt.data, 64);
+               m[i]->data_off += 64;
        }
 
        /* free them */
@@ -486,10 +432,10 @@ test_pktmbuf_pool_ptr(void)
                if (m[i] != NULL)
                        rte_pktmbuf_free(m[i]);
        }
-       
+
        for (i=0; i<NB_MBUF; i++)
                m[i] = NULL;
-               
+
        /* alloc NB_MBUF mbufs */
        for (i=0; i<NB_MBUF; i++) {
                m[i] = rte_pktmbuf_alloc(pktmbuf_pool);
@@ -497,8 +443,8 @@ test_pktmbuf_pool_ptr(void)
                        printf("rte_pktmbuf_alloc() failed (%u)\n", i);
                        ret = -1;
                }
-               if (m[i]->pkt.data != RTE_PTR_ADD(m[i]->buf_addr, RTE_PKTMBUF_HEADROOM)) {
-                       printf ("pkt.data pointer not set properly\n");
+               if (m[i]->data_off != RTE_PKTMBUF_HEADROOM) {
+                       printf("invalid data_off\n");
                        ret = -1;
                }
        }
@@ -539,7 +485,7 @@ test_pktmbuf_free_segment(void)
                        mb = m[i];
                        while(mb != NULL) {
                                mt = mb;
-                               mb = mb->pkt.next;
+                               mb = mb->next;
                                rte_pktmbuf_free_seg(mt);
                        }
                }
@@ -550,12 +496,11 @@ test_pktmbuf_free_segment(void)
 
 /*
  * Stress test for rte_mbuf atomic refcnt.
- * Implies that:
- * RTE_MBUF_SCATTER_GATHER 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_SCATTER_GATHER  && defined RTE_MBUF_REFCNT_ATOMIC
+#ifdef RTE_MBUF_REFCNT_ATOMIC
 
 static int
 test_refcnt_slave(__attribute__((unused)) void *arg)
@@ -660,7 +605,7 @@ test_refcnt_master(void)
 static int
 test_refcnt_mbuf(void)
 {
-#if defined RTE_MBUF_SCATTER_GATHER  && defined RTE_MBUF_REFCNT_ATOMIC
+#ifdef RTE_MBUF_REFCNT_ATOMIC
 
        unsigned lnum, master, slave, tref;
 
@@ -676,12 +621,10 @@ 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);
@@ -716,28 +659,17 @@ test_refcnt_mbuf(void)
                rte_panic("refernced mbufs: %u, freed mbufs: %u\n",
                          tref, refcnt_lcore[master]);
 
-       rte_mempool_dump(refcnt_pool);
-       rte_ring_dump(refcnt_mbuf_ring);
+       rte_mempool_dump(stdout, refcnt_pool);
+       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)
 {
@@ -747,7 +679,7 @@ verify_mbuf_check_panics(struct rte_mbuf *buf)
        pid = fork();
 
        if (pid == 0) {
-               rte_mbuf_sanity_check(buf, RTE_MBUF_PKT, 1); /* should panic */
+               rte_mbuf_sanity_check(buf, 1); /* should panic */
                exit(0);  /* return normally if it doesn't panic */
        } else if (pid < 0){
                printf("Fork Failed\n");
@@ -783,13 +715,6 @@ test_failing_mbuf_sanity_check(void)
                return -1;
        }
 
-       badbuf = *buf;
-       badbuf.type = (uint8_t)-1;
-       if (verify_mbuf_check_panics(&badbuf)) {
-               printf("Error with bad-type mbuf test\n");
-               return -1;
-       }
-
        badbuf = *buf;
        badbuf.pool = NULL;
        if (verify_mbuf_check_panics(&badbuf)) {
@@ -811,7 +736,6 @@ test_failing_mbuf_sanity_check(void)
                return -1;
        }
 
-#ifdef RTE_MBUF_SCATTER_GATHER
        badbuf = *buf;
        badbuf.refcnt = 0;
        if (verify_mbuf_check_panics(&badbuf)) {
@@ -825,27 +749,20 @@ test_failing_mbuf_sanity_check(void)
                printf("Error with bad-refcnt(MAX) mbuf test\n");
                return -1;
        }
-#endif
 
        return 0;
 }
-#endif
 
 
-int
+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_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) {
@@ -864,7 +781,7 @@ test_mbuf(void)
                printf("test_mbuf_pool() failed (2)\n");
                return -1;
        }
-       
+
        /* test that the pointer to the data on a packet mbuf is set properly */
        if (test_pktmbuf_pool_ptr() < 0) {
                printf("test_pktmbuf_pool_ptr() failed\n");
@@ -892,22 +809,6 @@ test_mbuf(void)
                return -1;
        }
 
-       /* create ctrlmbuf pool if it does not exist */
-       if (ctrlmbuf_pool == NULL) {
-               ctrlmbuf_pool =
-                       rte_mempool_create("test_ctrlmbuf_pool", NB_MBUF,
-                                          sizeof(struct rte_mbuf), 32, 0,
-                                          NULL, NULL,
-                                          rte_ctrlmbuf_init, NULL,
-                                          SOCKET_ID_ANY, 0);
-       }
-
-       /* test control mbuf */
-       if (test_one_ctrlmbuf() < 0) {
-               printf("test_one_ctrlmbuf() failed\n");
-               return -1;
-       }
-
        /* test free pktmbuf segment one by one */
        if (test_pktmbuf_free_segment() < 0) {
                printf("test_pktmbuf_free_segment() failed.\n");
@@ -930,3 +831,9 @@ test_mbuf(void)
        }
        return 0;
 }
+
+static struct test_command mbuf_cmd = {
+       .command = "mbuf_autotest",
+       .callback = test_mbuf,
+};
+REGISTER_TEST_COMMAND(mbuf_cmd);