4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41 #include <sys/queue.h>
43 #include <rte_common.h>
45 #include <rte_debug.h>
46 #include <rte_memory.h>
47 #include <rte_memzone.h>
48 #include <rte_launch.h>
49 #include <rte_cycles.h>
51 #include <rte_per_lcore.h>
52 #include <rte_lcore.h>
53 #include <rte_atomic.h>
54 #include <rte_branch_prediction.h>
56 #include <rte_mempool.h>
57 #include <rte_spinlock.h>
58 #include <rte_malloc.h>
66 * Basic tests: done on one core with and without cache:
68 * - Get one object, put one object
69 * - Get two objects, put two objects
70 * - Get all objects, test that their content is not modified and
71 * put them back in the pool.
76 #define MEMPOOL_ELT_SIZE 2048
78 #define MEMPOOL_SIZE ((rte_lcore_count()*(MAX_KEEP+RTE_MEMPOOL_CACHE_MAX_SIZE))-1)
80 #define RET_ERR() do { \
81 printf("test failed at %s():%d\n", __func__, __LINE__); \
85 static rte_atomic32_t synchro;
88 * save the object number in the first 4 bytes of object data. All
89 * other bytes are set to 0.
92 my_obj_init(struct rte_mempool *mp, __attribute__((unused)) void *arg,
93 void *obj, unsigned i)
95 uint32_t *objnum = obj;
97 memset(obj, 0, mp->elt_size);
101 /* basic tests (done on one core) */
103 test_mempool_basic(struct rte_mempool *mp)
112 /* dump the mempool status */
113 rte_mempool_dump(stdout, mp);
115 printf("get an object\n");
116 if (rte_mempool_get(mp, &obj) < 0)
118 rte_mempool_dump(stdout, mp);
120 /* tests that improve coverage */
121 printf("get object count\n");
122 if (rte_mempool_count(mp) != MEMPOOL_SIZE - 1)
125 printf("get private data\n");
126 if (rte_mempool_get_priv(mp) != (char *)mp +
127 MEMPOOL_HEADER_SIZE(mp, mp->cache_size))
130 #ifndef RTE_EXEC_ENV_BSDAPP /* rte_mem_virt2phy() not supported on bsd */
131 printf("get physical address of an object\n");
132 if (rte_mempool_virt2phy(mp, obj) != rte_mem_virt2phy(obj))
136 printf("put the object back\n");
137 rte_mempool_put(mp, obj);
138 rte_mempool_dump(stdout, mp);
140 printf("get 2 objects\n");
141 if (rte_mempool_get(mp, &obj) < 0)
143 if (rte_mempool_get(mp, &obj2) < 0) {
144 rte_mempool_put(mp, obj);
147 rte_mempool_dump(stdout, mp);
149 printf("put the objects back\n");
150 rte_mempool_put(mp, obj);
151 rte_mempool_put(mp, obj2);
152 rte_mempool_dump(stdout, mp);
155 * get many objects: we cannot get them all because the cache
156 * on other cores may not be empty.
158 objtable = malloc(MEMPOOL_SIZE * sizeof(void *));
159 if (objtable == NULL)
162 for (i = 0; i < MEMPOOL_SIZE; i++) {
163 if (rte_mempool_get(mp, &objtable[i]) < 0)
168 * for each object, check that its content was not modified,
169 * and put objects back in pool
175 if (*objnum > MEMPOOL_SIZE) {
176 printf("bad object number(%d)\n", *objnum);
180 for (j = sizeof(*objnum); j < mp->elt_size; j++) {
181 if (obj_data[j] != 0)
185 rte_mempool_put(mp, objtable[i]);
190 printf("objects were modified!\n");
195 static int test_mempool_creation_with_exceeded_cache_size(void)
197 struct rte_mempool *mp_cov;
199 mp_cov = rte_mempool_create("test_mempool_cache_too_big",
202 RTE_MEMPOOL_CACHE_MAX_SIZE + 32, 0,
207 if (mp_cov != NULL) {
208 rte_mempool_free(mp_cov);
215 static struct rte_mempool *mp_spsc;
216 static rte_spinlock_t scsp_spinlock;
217 static void *scsp_obj_table[MAX_KEEP];
220 * single producer function
222 static int test_mempool_single_producer(void)
226 uint64_t start_cycles, end_cycles;
227 uint64_t duration = rte_get_timer_hz() / 4;
229 start_cycles = rte_get_timer_cycles();
231 end_cycles = rte_get_timer_cycles();
232 /* duration uses up, stop producing */
233 if (start_cycles + duration < end_cycles)
235 rte_spinlock_lock(&scsp_spinlock);
236 for (i = 0; i < MAX_KEEP; i ++) {
237 if (NULL != scsp_obj_table[i]) {
238 obj = scsp_obj_table[i];
242 rte_spinlock_unlock(&scsp_spinlock);
246 if (rte_mempool_from_obj(obj) != mp_spsc) {
247 printf("obj not owned by this mempool\n");
250 rte_mempool_sp_put(mp_spsc, obj);
251 rte_spinlock_lock(&scsp_spinlock);
252 scsp_obj_table[i] = NULL;
253 rte_spinlock_unlock(&scsp_spinlock);
260 * single consumer function
262 static int test_mempool_single_consumer(void)
266 uint64_t start_cycles, end_cycles;
267 uint64_t duration = rte_get_timer_hz() / 8;
269 start_cycles = rte_get_timer_cycles();
271 end_cycles = rte_get_timer_cycles();
272 /* duration uses up, stop consuming */
273 if (start_cycles + duration < end_cycles)
275 rte_spinlock_lock(&scsp_spinlock);
276 for (i = 0; i < MAX_KEEP; i ++) {
277 if (NULL == scsp_obj_table[i])
280 rte_spinlock_unlock(&scsp_spinlock);
283 if (rte_mempool_sc_get(mp_spsc, &obj) < 0)
285 rte_spinlock_lock(&scsp_spinlock);
286 scsp_obj_table[i] = obj;
287 rte_spinlock_unlock(&scsp_spinlock);
294 * test function for mempool test based on singple consumer and single producer,
295 * can run on one lcore only
297 static int test_mempool_launch_single_consumer(__attribute__((unused)) void *arg)
299 return test_mempool_single_consumer();
302 static void my_mp_init(struct rte_mempool * mp, __attribute__((unused)) void * arg)
304 printf("mempool name is %s\n", mp->name);
305 /* nothing to be implemented here*/
310 * it tests the mempool operations based on singple producer and single consumer
313 test_mempool_sp_sc(void)
316 unsigned lcore_id = rte_lcore_id();
319 /* create a mempool with single producer/consumer ring */
320 if (mp_spsc == NULL) {
321 mp_spsc = rte_mempool_create("test_mempool_sp_sc", MEMPOOL_SIZE,
322 MEMPOOL_ELT_SIZE, 0, 0,
326 MEMPOOL_F_NO_CACHE_ALIGN | MEMPOOL_F_SP_PUT |
331 if (rte_mempool_lookup("test_mempool_sp_sc") != mp_spsc) {
332 printf("Cannot lookup mempool from its name\n");
333 rte_mempool_free(mp_spsc);
336 lcore_next = rte_get_next_lcore(lcore_id, 0, 1);
337 if (lcore_next >= RTE_MAX_LCORE) {
338 rte_mempool_free(mp_spsc);
341 if (rte_eal_lcore_role(lcore_next) != ROLE_RTE) {
342 rte_mempool_free(mp_spsc);
345 rte_spinlock_init(&scsp_spinlock);
346 memset(scsp_obj_table, 0, sizeof(scsp_obj_table));
347 rte_eal_remote_launch(test_mempool_launch_single_consumer, NULL,
349 if (test_mempool_single_producer() < 0)
352 if (rte_eal_wait_lcore(lcore_next) < 0)
354 rte_mempool_free(mp_spsc);
360 * it tests some more basic of mempool
363 test_mempool_basic_ex(struct rte_mempool *mp)
373 obj = rte_calloc("test_mempool_basic_ex", MEMPOOL_SIZE,
376 printf("test_mempool_basic_ex fail to rte_malloc\n");
379 printf("test_mempool_basic_ex now mempool (%s) has %u free entries\n",
380 mp->name, rte_mempool_free_count(mp));
381 if (rte_mempool_full(mp) != 1) {
382 printf("test_mempool_basic_ex the mempool should be full\n");
383 goto fail_mp_basic_ex;
386 for (i = 0; i < MEMPOOL_SIZE; i ++) {
387 if (rte_mempool_mc_get(mp, &obj[i]) < 0) {
388 printf("test_mp_basic_ex fail to get object for [%u]\n",
390 goto fail_mp_basic_ex;
393 if (rte_mempool_mc_get(mp, &err_obj) == 0) {
394 printf("test_mempool_basic_ex get an impossible obj\n");
395 goto fail_mp_basic_ex;
397 printf("number: %u\n", i);
398 if (rte_mempool_empty(mp) != 1) {
399 printf("test_mempool_basic_ex the mempool should be empty\n");
400 goto fail_mp_basic_ex;
403 for (i = 0; i < MEMPOOL_SIZE; i++)
404 rte_mempool_mp_put(mp, obj[i]);
406 if (rte_mempool_full(mp) != 1) {
407 printf("test_mempool_basic_ex the mempool should be full\n");
408 goto fail_mp_basic_ex;
415 rte_free((void *)obj);
421 test_mempool_same_name_twice_creation(void)
423 struct rte_mempool *mp_tc, *mp_tc2;
425 mp_tc = rte_mempool_create("test_mempool_same_name", MEMPOOL_SIZE,
426 MEMPOOL_ELT_SIZE, 0, 0,
434 mp_tc2 = rte_mempool_create("test_mempool_same_name", MEMPOOL_SIZE,
435 MEMPOOL_ELT_SIZE, 0, 0,
440 if (mp_tc2 != NULL) {
441 rte_mempool_free(mp_tc);
442 rte_mempool_free(mp_tc2);
446 rte_mempool_free(mp_tc);
451 * BAsic test for mempool_xmem functions.
454 test_mempool_xmem_misc(void)
456 uint32_t elt_num, total_size;
461 total_size = rte_mempool_calc_obj_size(MEMPOOL_ELT_SIZE, 0, NULL);
462 sz = rte_mempool_xmem_size(elt_num, total_size, MEMPOOL_PG_SHIFT_MAX);
464 usz = rte_mempool_xmem_usage(NULL, elt_num, total_size, 0, 1,
465 MEMPOOL_PG_SHIFT_MAX);
467 if (sz != (size_t)usz) {
468 printf("failure @ %s: rte_mempool_xmem_usage(%u, %u) "
469 "returns: %#zx, while expected: %#zx;\n",
470 __func__, elt_num, total_size, sz, (size_t)usz);
480 struct rte_mempool *mp_cache = NULL;
481 struct rte_mempool *mp_nocache = NULL;
483 rte_atomic32_init(&synchro);
485 /* create a mempool (without cache) */
486 mp_nocache = rte_mempool_create("test_nocache", MEMPOOL_SIZE,
487 MEMPOOL_ELT_SIZE, 0, 0,
492 if (mp_nocache == NULL) {
493 printf("cannot allocate mp_nocache mempool\n");
497 /* create a mempool (with cache) */
498 mp_cache = rte_mempool_create("test_cache", MEMPOOL_SIZE,
500 RTE_MEMPOOL_CACHE_MAX_SIZE, 0,
505 if (mp_cache == NULL) {
506 printf("cannot allocate mp_cache mempool\n");
510 /* retrieve the mempool from its name */
511 if (rte_mempool_lookup("test_nocache") != mp_nocache) {
512 printf("Cannot lookup mempool from its name\n");
516 rte_mempool_list_dump(stdout);
518 /* basic tests without cache */
519 if (test_mempool_basic(mp_nocache) < 0)
522 /* basic tests with cache */
523 if (test_mempool_basic(mp_cache) < 0)
526 /* more basic tests without cache */
527 if (test_mempool_basic_ex(mp_nocache) < 0)
530 /* mempool operation test based on single producer and single comsumer */
531 if (test_mempool_sp_sc() < 0)
534 if (test_mempool_creation_with_exceeded_cache_size() < 0)
537 if (test_mempool_same_name_twice_creation() < 0)
540 if (test_mempool_xmem_misc() < 0)
543 rte_mempool_list_dump(stdout);
548 rte_mempool_free(mp_nocache);
549 rte_mempool_free(mp_cache);
553 static struct test_command mempool_cmd = {
554 .command = "mempool_autotest",
555 .callback = test_mempool,
557 REGISTER_TEST_COMMAND(mempool_cmd);