Imported Upstream version 16.04
[deb_dpdk.git] / app / test / test_mempool.c
diff --git a/app/test/test_mempool.c b/app/test/test_mempool.c
new file mode 100644 (file)
index 0000000..f0f823b
--- /dev/null
@@ -0,0 +1,528 @@
+/*-
+ *   BSD LICENSE
+ *
+ *   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
+ *   are met:
+ *
+ *     * 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
+ *       distribution.
+ *     * 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
+ *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <string.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <stdint.h>
+#include <inttypes.h>
+#include <stdarg.h>
+#include <errno.h>
+#include <sys/queue.h>
+
+#include <rte_common.h>
+#include <rte_log.h>
+#include <rte_debug.h>
+#include <rte_memory.h>
+#include <rte_memzone.h>
+#include <rte_launch.h>
+#include <rte_cycles.h>
+#include <rte_eal.h>
+#include <rte_per_lcore.h>
+#include <rte_lcore.h>
+#include <rte_atomic.h>
+#include <rte_branch_prediction.h>
+#include <rte_ring.h>
+#include <rte_mempool.h>
+#include <rte_spinlock.h>
+#include <rte_malloc.h>
+
+#include "test.h"
+
+/*
+ * Mempool
+ * =======
+ *
+ * Basic tests: done on one core with and without cache:
+ *
+ *    - Get one object, put one object
+ *    - Get two objects, put two objects
+ *    - Get all objects, test that their content is not modified and
+ *      put them back in the pool.
+ */
+
+#define N 65536
+#define TIME_S 5
+#define MEMPOOL_ELT_SIZE 2048
+#define MAX_KEEP 128
+#define MEMPOOL_SIZE ((rte_lcore_count()*(MAX_KEEP+RTE_MEMPOOL_CACHE_MAX_SIZE))-1)
+
+static struct rte_mempool *mp;
+static struct rte_mempool *mp_cache, *mp_nocache;
+
+static rte_atomic32_t synchro;
+
+
+
+/*
+ * save the object number in the first 4 bytes of object data. All
+ * other bytes are set to 0.
+ */
+static void
+my_obj_init(struct rte_mempool *mp, __attribute__((unused)) void *arg,
+           void *obj, unsigned i)
+{
+       uint32_t *objnum = obj;
+       memset(obj, 0, mp->elt_size);
+       *objnum = i;
+}
+
+/* basic tests (done on one core) */
+static int
+test_mempool_basic(void)
+{
+       uint32_t *objnum;
+       void **objtable;
+       void *obj, *obj2;
+       char *obj_data;
+       int ret = 0;
+       unsigned i, j;
+
+       /* dump the mempool status */
+       rte_mempool_dump(stdout, mp);
+
+       printf("get an object\n");
+       if (rte_mempool_get(mp, &obj) < 0)
+               return -1;
+       rte_mempool_dump(stdout, mp);
+
+       /* tests that improve coverage */
+       printf("get object count\n");
+       if (rte_mempool_count(mp) != MEMPOOL_SIZE - 1)
+               return -1;
+
+       printf("get private data\n");
+       if (rte_mempool_get_priv(mp) !=
+                       (char*) mp + MEMPOOL_HEADER_SIZE(mp, mp->pg_num))
+               return -1;
+
+       printf("get physical address of an object\n");
+       if (MEMPOOL_IS_CONTIG(mp) &&
+                       rte_mempool_virt2phy(mp, obj) !=
+                       (phys_addr_t) (mp->phys_addr +
+                       (phys_addr_t) ((char*) obj - (char*) mp)))
+               return -1;
+
+       printf("put the object back\n");
+       rte_mempool_put(mp, obj);
+       rte_mempool_dump(stdout, mp);
+
+       printf("get 2 objects\n");
+       if (rte_mempool_get(mp, &obj) < 0)
+               return -1;
+       if (rte_mempool_get(mp, &obj2) < 0) {
+               rte_mempool_put(mp, obj);
+               return -1;
+       }
+       rte_mempool_dump(stdout, mp);
+
+       printf("put the objects back\n");
+       rte_mempool_put(mp, obj);
+       rte_mempool_put(mp, obj2);
+       rte_mempool_dump(stdout, mp);
+
+       /*
+        * get many objects: we cannot get them all because the cache
+        * on other cores may not be empty.
+        */
+       objtable = malloc(MEMPOOL_SIZE * sizeof(void *));
+       if (objtable == NULL) {
+               return -1;
+       }
+
+       for (i=0; i<MEMPOOL_SIZE; i++) {
+               if (rte_mempool_get(mp, &objtable[i]) < 0)
+                       break;
+       }
+
+       /*
+        * for each object, check that its content was not modified,
+        * and put objects back in pool
+        */
+       while (i--) {
+               obj = objtable[i];
+               obj_data = obj;
+               objnum = obj;
+               if (*objnum > MEMPOOL_SIZE) {
+                       printf("bad object number\n");
+                       ret = -1;
+                       break;
+               }
+               for (j=sizeof(*objnum); j<mp->elt_size; j++) {
+                       if (obj_data[j] != 0)
+                               ret = -1;
+               }
+
+               rte_mempool_put(mp, objtable[i]);
+       }
+
+       free(objtable);
+       if (ret == -1)
+               printf("objects were modified!\n");
+
+       return ret;
+}
+
+static int test_mempool_creation_with_exceeded_cache_size(void)
+{
+       struct rte_mempool *mp_cov;
+
+       mp_cov = rte_mempool_create("test_mempool_creation_with_exceeded_cache_size", MEMPOOL_SIZE,
+                                             MEMPOOL_ELT_SIZE,
+                                             RTE_MEMPOOL_CACHE_MAX_SIZE + 32, 0,
+                                             NULL, NULL,
+                                             my_obj_init, NULL,
+                                             SOCKET_ID_ANY, 0);
+       if(NULL != mp_cov) {
+               return -1;
+       }
+
+       return 0;
+}
+
+static struct rte_mempool *mp_spsc;
+static rte_spinlock_t scsp_spinlock;
+static void *scsp_obj_table[MAX_KEEP];
+
+/*
+ * single producer function
+ */
+static int test_mempool_single_producer(void)
+{
+       unsigned int i;
+       void *obj = NULL;
+       uint64_t start_cycles, end_cycles;
+       uint64_t duration = rte_get_timer_hz() * 8;
+
+       start_cycles = rte_get_timer_cycles();
+       while (1) {
+               end_cycles = rte_get_timer_cycles();
+               /* duration uses up, stop producing */
+               if (start_cycles + duration < end_cycles)
+                       break;
+               rte_spinlock_lock(&scsp_spinlock);
+               for (i = 0; i < MAX_KEEP; i ++) {
+                       if (NULL != scsp_obj_table[i]) {
+                               obj = scsp_obj_table[i];
+                               break;
+                       }
+               }
+               rte_spinlock_unlock(&scsp_spinlock);
+               if (i >= MAX_KEEP) {
+                       continue;
+               }
+               if (rte_mempool_from_obj(obj) != mp_spsc) {
+                       printf("test_mempool_single_producer there is an obj not owned by this mempool\n");
+                       return -1;
+               }
+               rte_mempool_sp_put(mp_spsc, obj);
+               rte_spinlock_lock(&scsp_spinlock);
+               scsp_obj_table[i] = NULL;
+               rte_spinlock_unlock(&scsp_spinlock);
+       }
+
+       return 0;
+}
+
+/*
+ * single consumer function
+ */
+static int test_mempool_single_consumer(void)
+{
+       unsigned int i;
+       void * obj;
+       uint64_t start_cycles, end_cycles;
+       uint64_t duration = rte_get_timer_hz() * 5;
+
+       start_cycles = rte_get_timer_cycles();
+       while (1) {
+               end_cycles = rte_get_timer_cycles();
+               /* duration uses up, stop consuming */
+               if (start_cycles + duration < end_cycles)
+                       break;
+               rte_spinlock_lock(&scsp_spinlock);
+               for (i = 0; i < MAX_KEEP; i ++) {
+                       if (NULL == scsp_obj_table[i])
+                               break;
+               }
+               rte_spinlock_unlock(&scsp_spinlock);
+               if (i >= MAX_KEEP)
+                       continue;
+               if (rte_mempool_sc_get(mp_spsc, &obj) < 0)
+                       break;
+               rte_spinlock_lock(&scsp_spinlock);
+               scsp_obj_table[i] = obj;
+               rte_spinlock_unlock(&scsp_spinlock);
+       }
+
+       return 0;
+}
+
+/*
+ * test function for mempool test based on singple consumer and single producer, can run on one lcore only
+ */
+static int test_mempool_launch_single_consumer(__attribute__((unused)) void *arg)
+{
+       return test_mempool_single_consumer();
+}
+
+static void my_mp_init(struct rte_mempool * mp, __attribute__((unused)) void * arg)
+{
+       printf("mempool name is %s\n", mp->name);
+       /* nothing to be implemented here*/
+       return ;
+}
+
+/*
+ * it tests the mempool operations based on singple producer and single consumer
+ */
+static int
+test_mempool_sp_sc(void)
+{
+       int ret = 0;
+       unsigned lcore_id = rte_lcore_id();
+       unsigned lcore_next;
+
+       /* create a mempool with single producer/consumer ring */
+       if (NULL == mp_spsc) {
+               mp_spsc = rte_mempool_create("test_mempool_sp_sc", MEMPOOL_SIZE,
+                                               MEMPOOL_ELT_SIZE, 0, 0,
+                                               my_mp_init, NULL,
+                                               my_obj_init, NULL,
+                                               SOCKET_ID_ANY, MEMPOOL_F_NO_CACHE_ALIGN | MEMPOOL_F_SP_PUT | MEMPOOL_F_SC_GET);
+               if (NULL == mp_spsc) {
+                       return -1;
+               }
+       }
+       if (rte_mempool_lookup("test_mempool_sp_sc") != mp_spsc) {
+               printf("Cannot lookup mempool from its name\n");
+               return -1;
+       }
+       lcore_next = rte_get_next_lcore(lcore_id, 0, 1);
+       if (RTE_MAX_LCORE <= lcore_next)
+               return -1;
+       if (rte_eal_lcore_role(lcore_next) != ROLE_RTE)
+               return -1;
+       rte_spinlock_init(&scsp_spinlock);
+       memset(scsp_obj_table, 0, sizeof(scsp_obj_table));
+       rte_eal_remote_launch(test_mempool_launch_single_consumer, NULL, lcore_next);
+       if(test_mempool_single_producer() < 0)
+               ret = -1;
+
+       if(rte_eal_wait_lcore(lcore_next) < 0)
+               ret = -1;
+
+       return ret;
+}
+
+/*
+ * it tests some more basic of mempool
+ */
+static int
+test_mempool_basic_ex(struct rte_mempool * mp)
+{
+       unsigned i;
+       void **obj;
+       void *err_obj;
+       int ret = -1;
+
+       if (mp == NULL)
+               return ret;
+
+       obj = rte_calloc("test_mempool_basic_ex", MEMPOOL_SIZE , sizeof(void *), 0);
+       if (obj == NULL) {
+               printf("test_mempool_basic_ex fail to rte_malloc\n");
+               return ret;
+       }
+       printf("test_mempool_basic_ex now mempool (%s) has %u free entries\n", mp->name, rte_mempool_free_count(mp));
+       if (rte_mempool_full(mp) != 1) {
+               printf("test_mempool_basic_ex the mempool is not full but it should be\n");
+               goto fail_mp_basic_ex;
+       }
+
+       for (i = 0; i < MEMPOOL_SIZE; i ++) {
+               if (rte_mempool_mc_get(mp, &obj[i]) < 0) {
+                       printf("fail_mp_basic_ex fail to get mempool object for [%u]\n", i);
+                       goto fail_mp_basic_ex;
+               }
+       }
+       if (rte_mempool_mc_get(mp, &err_obj) == 0) {
+               printf("test_mempool_basic_ex get an impossible obj from mempool\n");
+               goto fail_mp_basic_ex;
+       }
+       printf("number: %u\n", i);
+       if (rte_mempool_empty(mp) != 1) {
+               printf("test_mempool_basic_ex the mempool is not empty but it should be\n");
+               goto fail_mp_basic_ex;
+       }
+
+       for (i = 0; i < MEMPOOL_SIZE; i ++) {
+               rte_mempool_mp_put(mp, obj[i]);
+       }
+       if (rte_mempool_full(mp) != 1) {
+               printf("test_mempool_basic_ex the mempool is not full but it should be\n");
+               goto fail_mp_basic_ex;
+       }
+
+       ret = 0;
+
+fail_mp_basic_ex:
+       if (obj != NULL)
+               rte_free((void *)obj);
+
+       return ret;
+}
+
+static int
+test_mempool_same_name_twice_creation(void)
+{
+       struct rte_mempool *mp_tc;
+
+       mp_tc = rte_mempool_create("test_mempool_same_name_twice_creation", MEMPOOL_SIZE,
+                                               MEMPOOL_ELT_SIZE, 0, 0,
+                                               NULL, NULL,
+                                               NULL, NULL,
+                                               SOCKET_ID_ANY, 0);
+       if (NULL == mp_tc)
+               return -1;
+
+       mp_tc = rte_mempool_create("test_mempool_same_name_twice_creation", MEMPOOL_SIZE,
+                                               MEMPOOL_ELT_SIZE, 0, 0,
+                                               NULL, NULL,
+                                               NULL, NULL,
+                                               SOCKET_ID_ANY, 0);
+       if (NULL != mp_tc)
+               return -1;
+
+       return 0;
+}
+
+/*
+ * BAsic test for mempool_xmem functions.
+ */
+static int
+test_mempool_xmem_misc(void)
+{
+       uint32_t elt_num, total_size;
+       size_t sz;
+       ssize_t usz;
+
+       elt_num = MAX_KEEP;
+       total_size = rte_mempool_calc_obj_size(MEMPOOL_ELT_SIZE, 0, NULL);
+       sz = rte_mempool_xmem_size(elt_num, total_size, MEMPOOL_PG_SHIFT_MAX);
+
+       usz = rte_mempool_xmem_usage(NULL, elt_num, total_size, 0, 1,
+               MEMPOOL_PG_SHIFT_MAX);
+
+       if(sz != (size_t)usz)  {
+               printf("failure @ %s: rte_mempool_xmem_usage(%u, %u) "
+                       "returns: %#zx, while expected: %#zx;\n",
+                       __func__, elt_num, total_size, sz, (size_t)usz);
+               return -1;
+       }
+
+       return 0;
+}
+
+static int
+test_mempool(void)
+{
+       rte_atomic32_init(&synchro);
+
+       /* create a mempool (without cache) */
+       if (mp_nocache == NULL)
+               mp_nocache = rte_mempool_create("test_nocache", MEMPOOL_SIZE,
+                                               MEMPOOL_ELT_SIZE, 0, 0,
+                                               NULL, NULL,
+                                               my_obj_init, NULL,
+                                               SOCKET_ID_ANY, 0);
+       if (mp_nocache == NULL)
+               return -1;
+
+       /* create a mempool (with cache) */
+       if (mp_cache == NULL)
+               mp_cache = rte_mempool_create("test_cache", MEMPOOL_SIZE,
+                                             MEMPOOL_ELT_SIZE,
+                                             RTE_MEMPOOL_CACHE_MAX_SIZE, 0,
+                                             NULL, NULL,
+                                             my_obj_init, NULL,
+                                             SOCKET_ID_ANY, 0);
+       if (mp_cache == NULL)
+               return -1;
+
+
+       /* retrieve the mempool from its name */
+       if (rte_mempool_lookup("test_nocache") != mp_nocache) {
+               printf("Cannot lookup mempool from its name\n");
+               return -1;
+       }
+
+       rte_mempool_list_dump(stdout);
+
+       /* basic tests without cache */
+       mp = mp_nocache;
+       if (test_mempool_basic() < 0)
+               return -1;
+
+       /* basic tests with cache */
+       mp = mp_cache;
+       if (test_mempool_basic() < 0)
+               return -1;
+
+       /* more basic tests without cache */
+       if (test_mempool_basic_ex(mp_nocache) < 0)
+               return -1;
+
+       /* mempool operation test based on single producer and single comsumer */
+       if (test_mempool_sp_sc() < 0)
+               return -1;
+
+       if (test_mempool_creation_with_exceeded_cache_size() < 0)
+               return -1;
+
+       if (test_mempool_same_name_twice_creation() < 0)
+               return -1;
+
+       if (test_mempool_xmem_misc() < 0)
+               return -1;
+
+       rte_mempool_list_dump(stdout);
+
+       return 0;
+}
+
+static struct test_command mempool_cmd = {
+       .command = "mempool_autotest",
+       .callback = test_mempool,
+};
+REGISTER_TEST_COMMAND(mempool_cmd);