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>
55 #include <rte_mempool.h>
56 #include <rte_spinlock.h>
57 #include <rte_malloc.h>
65 * Basic tests: done on one core with and without cache:
67 * - Get one object, put one object
68 * - Get two objects, put two objects
69 * - Get all objects, test that their content is not modified and
70 * put them back in the pool.
73 #define MEMPOOL_ELT_SIZE 2048
75 #define MEMPOOL_SIZE ((rte_lcore_count()*(MAX_KEEP+RTE_MEMPOOL_CACHE_MAX_SIZE))-1)
77 #define LOG_ERR() printf("test failed at %s():%d\n", __func__, __LINE__)
78 #define RET_ERR() do { \
82 #define GOTO_ERR(var, label) do { \
88 static rte_atomic32_t synchro;
91 * save the object number in the first 4 bytes of object data. All
92 * other bytes are set to 0.
95 my_obj_init(struct rte_mempool *mp, __attribute__((unused)) void *arg,
96 void *obj, unsigned i)
98 uint32_t *objnum = obj;
100 memset(obj, 0, mp->elt_size);
104 /* basic tests (done on one core) */
106 test_mempool_basic(struct rte_mempool *mp, int use_external_cache)
115 struct rte_mempool_cache *cache;
117 if (use_external_cache) {
118 /* Create a user-owned mempool cache. */
119 cache = rte_mempool_cache_create(RTE_MEMPOOL_CACHE_MAX_SIZE,
124 /* May be NULL if cache is disabled. */
125 cache = rte_mempool_default_cache(mp, rte_lcore_id());
128 /* dump the mempool status */
129 rte_mempool_dump(stdout, mp);
131 printf("get an object\n");
132 if (rte_mempool_generic_get(mp, &obj, 1, cache, 0) < 0)
134 rte_mempool_dump(stdout, mp);
136 /* tests that improve coverage */
137 printf("get object count\n");
138 /* We have to count the extra caches, one in this case. */
139 offset = use_external_cache ? 1 * cache->len : 0;
140 if (rte_mempool_avail_count(mp) + offset != MEMPOOL_SIZE - 1)
143 printf("get private data\n");
144 if (rte_mempool_get_priv(mp) != (char *)mp +
145 MEMPOOL_HEADER_SIZE(mp, mp->cache_size))
148 #ifndef RTE_EXEC_ENV_BSDAPP /* rte_mem_virt2phy() not supported on bsd */
149 printf("get physical address of an object\n");
150 if (rte_mempool_virt2phy(mp, obj) != rte_mem_virt2phy(obj))
154 printf("put the object back\n");
155 rte_mempool_generic_put(mp, &obj, 1, cache, 0);
156 rte_mempool_dump(stdout, mp);
158 printf("get 2 objects\n");
159 if (rte_mempool_generic_get(mp, &obj, 1, cache, 0) < 0)
161 if (rte_mempool_generic_get(mp, &obj2, 1, cache, 0) < 0) {
162 rte_mempool_generic_put(mp, &obj, 1, cache, 0);
165 rte_mempool_dump(stdout, mp);
167 printf("put the objects back\n");
168 rte_mempool_generic_put(mp, &obj, 1, cache, 0);
169 rte_mempool_generic_put(mp, &obj2, 1, cache, 0);
170 rte_mempool_dump(stdout, mp);
173 * get many objects: we cannot get them all because the cache
174 * on other cores may not be empty.
176 objtable = malloc(MEMPOOL_SIZE * sizeof(void *));
177 if (objtable == NULL)
180 for (i = 0; i < MEMPOOL_SIZE; i++) {
181 if (rte_mempool_generic_get(mp, &objtable[i], 1, cache, 0) < 0)
186 * for each object, check that its content was not modified,
187 * and put objects back in pool
193 if (*objnum > MEMPOOL_SIZE) {
194 printf("bad object number(%d)\n", *objnum);
198 for (j = sizeof(*objnum); j < mp->elt_size; j++) {
199 if (obj_data[j] != 0)
203 rte_mempool_generic_put(mp, &objtable[i], 1, cache, 0);
208 printf("objects were modified!\n");
211 if (use_external_cache) {
212 rte_mempool_cache_flush(cache, mp);
213 rte_mempool_cache_free(cache);
219 static int test_mempool_creation_with_exceeded_cache_size(void)
221 struct rte_mempool *mp_cov;
223 mp_cov = rte_mempool_create("test_mempool_cache_too_big",
226 RTE_MEMPOOL_CACHE_MAX_SIZE + 32, 0,
231 if (mp_cov != NULL) {
232 rte_mempool_free(mp_cov);
239 static struct rte_mempool *mp_spsc;
240 static rte_spinlock_t scsp_spinlock;
241 static void *scsp_obj_table[MAX_KEEP];
244 * single producer function
246 static int test_mempool_single_producer(void)
250 uint64_t start_cycles, end_cycles;
251 uint64_t duration = rte_get_timer_hz() / 4;
253 start_cycles = rte_get_timer_cycles();
255 end_cycles = rte_get_timer_cycles();
256 /* duration uses up, stop producing */
257 if (start_cycles + duration < end_cycles)
259 rte_spinlock_lock(&scsp_spinlock);
260 for (i = 0; i < MAX_KEEP; i ++) {
261 if (NULL != scsp_obj_table[i]) {
262 obj = scsp_obj_table[i];
266 rte_spinlock_unlock(&scsp_spinlock);
270 if (rte_mempool_from_obj(obj) != mp_spsc) {
271 printf("obj not owned by this mempool\n");
274 rte_mempool_put(mp_spsc, obj);
275 rte_spinlock_lock(&scsp_spinlock);
276 scsp_obj_table[i] = NULL;
277 rte_spinlock_unlock(&scsp_spinlock);
284 * single consumer function
286 static int test_mempool_single_consumer(void)
290 uint64_t start_cycles, end_cycles;
291 uint64_t duration = rte_get_timer_hz() / 8;
293 start_cycles = rte_get_timer_cycles();
295 end_cycles = rte_get_timer_cycles();
296 /* duration uses up, stop consuming */
297 if (start_cycles + duration < end_cycles)
299 rte_spinlock_lock(&scsp_spinlock);
300 for (i = 0; i < MAX_KEEP; i ++) {
301 if (NULL == scsp_obj_table[i])
304 rte_spinlock_unlock(&scsp_spinlock);
307 if (rte_mempool_get(mp_spsc, &obj) < 0)
309 rte_spinlock_lock(&scsp_spinlock);
310 scsp_obj_table[i] = obj;
311 rte_spinlock_unlock(&scsp_spinlock);
318 * test function for mempool test based on singple consumer and single producer,
319 * can run on one lcore only
322 test_mempool_launch_single_consumer(__attribute__((unused)) void *arg)
324 return test_mempool_single_consumer();
328 my_mp_init(struct rte_mempool *mp, __attribute__((unused)) void *arg)
330 printf("mempool name is %s\n", mp->name);
331 /* nothing to be implemented here*/
336 * it tests the mempool operations based on singple producer and single consumer
339 test_mempool_sp_sc(void)
342 unsigned lcore_id = rte_lcore_id();
345 /* create a mempool with single producer/consumer ring */
346 if (mp_spsc == NULL) {
347 mp_spsc = rte_mempool_create("test_mempool_sp_sc", MEMPOOL_SIZE,
348 MEMPOOL_ELT_SIZE, 0, 0,
352 MEMPOOL_F_NO_CACHE_ALIGN | MEMPOOL_F_SP_PUT |
357 if (rte_mempool_lookup("test_mempool_sp_sc") != mp_spsc) {
358 printf("Cannot lookup mempool from its name\n");
362 lcore_next = rte_get_next_lcore(lcore_id, 0, 1);
363 if (lcore_next >= RTE_MAX_LCORE) {
367 if (rte_eal_lcore_role(lcore_next) != ROLE_RTE) {
371 rte_spinlock_init(&scsp_spinlock);
372 memset(scsp_obj_table, 0, sizeof(scsp_obj_table));
373 rte_eal_remote_launch(test_mempool_launch_single_consumer, NULL,
375 if (test_mempool_single_producer() < 0)
378 if (rte_eal_wait_lcore(lcore_next) < 0)
382 rte_mempool_free(mp_spsc);
389 * it tests some more basic of mempool
392 test_mempool_basic_ex(struct rte_mempool *mp)
402 obj = rte_calloc("test_mempool_basic_ex", MEMPOOL_SIZE,
405 printf("test_mempool_basic_ex fail to rte_malloc\n");
408 printf("test_mempool_basic_ex now mempool (%s) has %u free entries\n",
409 mp->name, rte_mempool_in_use_count(mp));
410 if (rte_mempool_full(mp) != 1) {
411 printf("test_mempool_basic_ex the mempool should be full\n");
412 goto fail_mp_basic_ex;
415 for (i = 0; i < MEMPOOL_SIZE; i ++) {
416 if (rte_mempool_get(mp, &obj[i]) < 0) {
417 printf("test_mp_basic_ex fail to get object for [%u]\n",
419 goto fail_mp_basic_ex;
422 if (rte_mempool_get(mp, &err_obj) == 0) {
423 printf("test_mempool_basic_ex get an impossible obj\n");
424 goto fail_mp_basic_ex;
426 printf("number: %u\n", i);
427 if (rte_mempool_empty(mp) != 1) {
428 printf("test_mempool_basic_ex the mempool should be empty\n");
429 goto fail_mp_basic_ex;
432 for (i = 0; i < MEMPOOL_SIZE; i++)
433 rte_mempool_put(mp, obj[i]);
435 if (rte_mempool_full(mp) != 1) {
436 printf("test_mempool_basic_ex the mempool should be full\n");
437 goto fail_mp_basic_ex;
444 rte_free((void *)obj);
450 test_mempool_same_name_twice_creation(void)
452 struct rte_mempool *mp_tc, *mp_tc2;
454 mp_tc = rte_mempool_create("test_mempool_same_name", MEMPOOL_SIZE,
455 MEMPOOL_ELT_SIZE, 0, 0,
463 mp_tc2 = rte_mempool_create("test_mempool_same_name", MEMPOOL_SIZE,
464 MEMPOOL_ELT_SIZE, 0, 0,
469 if (mp_tc2 != NULL) {
470 rte_mempool_free(mp_tc);
471 rte_mempool_free(mp_tc2);
475 rte_mempool_free(mp_tc);
480 * BAsic test for mempool_xmem functions.
483 test_mempool_xmem_misc(void)
485 uint32_t elt_num, total_size;
490 total_size = rte_mempool_calc_obj_size(MEMPOOL_ELT_SIZE, 0, NULL);
491 sz = rte_mempool_xmem_size(elt_num, total_size, MEMPOOL_PG_SHIFT_MAX);
493 usz = rte_mempool_xmem_usage(NULL, elt_num, total_size, 0, 1,
494 MEMPOOL_PG_SHIFT_MAX);
496 if (sz != (size_t)usz) {
497 printf("failure @ %s: rte_mempool_xmem_usage(%u, %u) "
498 "returns: %#zx, while expected: %#zx;\n",
499 __func__, elt_num, total_size, sz, (size_t)usz);
507 walk_cb(struct rte_mempool *mp, void *userdata __rte_unused)
509 printf("\t%s\n", mp->name);
516 struct rte_mempool *mp_cache = NULL;
517 struct rte_mempool *mp_nocache = NULL;
518 struct rte_mempool *mp_stack = NULL;
520 rte_atomic32_init(&synchro);
522 /* create a mempool (without cache) */
523 mp_nocache = rte_mempool_create("test_nocache", MEMPOOL_SIZE,
524 MEMPOOL_ELT_SIZE, 0, 0,
529 if (mp_nocache == NULL) {
530 printf("cannot allocate mp_nocache mempool\n");
534 /* create a mempool (with cache) */
535 mp_cache = rte_mempool_create("test_cache", MEMPOOL_SIZE,
537 RTE_MEMPOOL_CACHE_MAX_SIZE, 0,
542 if (mp_cache == NULL) {
543 printf("cannot allocate mp_cache mempool\n");
547 /* create a mempool with an external handler */
548 mp_stack = rte_mempool_create_empty("test_stack",
551 RTE_MEMPOOL_CACHE_MAX_SIZE, 0,
554 if (mp_stack == NULL) {
555 printf("cannot allocate mp_stack mempool\n");
558 if (rte_mempool_set_ops_byname(mp_stack, "stack", NULL) < 0) {
559 printf("cannot set stack handler\n");
562 if (rte_mempool_populate_default(mp_stack) < 0) {
563 printf("cannot populate mp_stack mempool\n");
566 rte_mempool_obj_iter(mp_stack, my_obj_init, NULL);
568 /* retrieve the mempool from its name */
569 if (rte_mempool_lookup("test_nocache") != mp_nocache) {
570 printf("Cannot lookup mempool from its name\n");
574 printf("Walk into mempools:\n");
575 rte_mempool_walk(walk_cb, NULL);
577 rte_mempool_list_dump(stdout);
579 /* basic tests without cache */
580 if (test_mempool_basic(mp_nocache, 0) < 0)
583 /* basic tests with cache */
584 if (test_mempool_basic(mp_cache, 0) < 0)
587 /* basic tests with user-owned cache */
588 if (test_mempool_basic(mp_nocache, 1) < 0)
591 /* more basic tests without cache */
592 if (test_mempool_basic_ex(mp_nocache) < 0)
595 /* mempool operation test based on single producer and single comsumer */
596 if (test_mempool_sp_sc() < 0)
599 if (test_mempool_creation_with_exceeded_cache_size() < 0)
602 if (test_mempool_same_name_twice_creation() < 0)
605 if (test_mempool_xmem_misc() < 0)
608 /* test the stack handler */
609 if (test_mempool_basic(mp_stack, 1) < 0)
612 rte_mempool_list_dump(stdout);
617 rte_mempool_free(mp_nocache);
618 rte_mempool_free(mp_cache);
619 rte_mempool_free(mp_stack);
623 REGISTER_TEST_COMMAND(mempool_autotest, test_mempool);