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 static struct rte_mempool *mp;
81 static struct rte_mempool *mp_cache, *mp_nocache;
83 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;
96 memset(obj, 0, mp->elt_size);
100 /* basic tests (done on one core) */
102 test_mempool_basic(void)
111 /* dump the mempool status */
112 rte_mempool_dump(stdout, mp);
114 printf("get an object\n");
115 if (rte_mempool_get(mp, &obj) < 0)
117 rte_mempool_dump(stdout, mp);
119 /* tests that improve coverage */
120 printf("get object count\n");
121 if (rte_mempool_count(mp) != MEMPOOL_SIZE - 1)
124 printf("get private data\n");
125 if (rte_mempool_get_priv(mp) != (char *)mp +
126 MEMPOOL_HEADER_SIZE(mp, mp->cache_size))
129 #ifndef RTE_EXEC_ENV_BSDAPP /* rte_mem_virt2phy() not supported on bsd */
130 printf("get physical address of an object\n");
131 if (rte_mempool_virt2phy(mp, obj) != rte_mem_virt2phy(obj))
135 printf("put the object back\n");
136 rte_mempool_put(mp, obj);
137 rte_mempool_dump(stdout, mp);
139 printf("get 2 objects\n");
140 if (rte_mempool_get(mp, &obj) < 0)
142 if (rte_mempool_get(mp, &obj2) < 0) {
143 rte_mempool_put(mp, obj);
146 rte_mempool_dump(stdout, mp);
148 printf("put the objects back\n");
149 rte_mempool_put(mp, obj);
150 rte_mempool_put(mp, obj2);
151 rte_mempool_dump(stdout, mp);
154 * get many objects: we cannot get them all because the cache
155 * on other cores may not be empty.
157 objtable = malloc(MEMPOOL_SIZE * sizeof(void *));
158 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\n");
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_creation_with_exceeded_cache_size", MEMPOOL_SIZE,
201 RTE_MEMPOOL_CACHE_MAX_SIZE + 32, 0,
212 static struct rte_mempool *mp_spsc;
213 static rte_spinlock_t scsp_spinlock;
214 static void *scsp_obj_table[MAX_KEEP];
217 * single producer function
219 static int test_mempool_single_producer(void)
223 uint64_t start_cycles, end_cycles;
224 uint64_t duration = rte_get_timer_hz() * 8;
226 start_cycles = rte_get_timer_cycles();
228 end_cycles = rte_get_timer_cycles();
229 /* duration uses up, stop producing */
230 if (start_cycles + duration < end_cycles)
232 rte_spinlock_lock(&scsp_spinlock);
233 for (i = 0; i < MAX_KEEP; i ++) {
234 if (NULL != scsp_obj_table[i]) {
235 obj = scsp_obj_table[i];
239 rte_spinlock_unlock(&scsp_spinlock);
243 if (rte_mempool_from_obj(obj) != mp_spsc) {
244 printf("test_mempool_single_producer there is an obj not owned by this mempool\n");
247 rte_mempool_sp_put(mp_spsc, obj);
248 rte_spinlock_lock(&scsp_spinlock);
249 scsp_obj_table[i] = NULL;
250 rte_spinlock_unlock(&scsp_spinlock);
257 * single consumer function
259 static int test_mempool_single_consumer(void)
263 uint64_t start_cycles, end_cycles;
264 uint64_t duration = rte_get_timer_hz() * 5;
266 start_cycles = rte_get_timer_cycles();
268 end_cycles = rte_get_timer_cycles();
269 /* duration uses up, stop consuming */
270 if (start_cycles + duration < end_cycles)
272 rte_spinlock_lock(&scsp_spinlock);
273 for (i = 0; i < MAX_KEEP; i ++) {
274 if (NULL == scsp_obj_table[i])
277 rte_spinlock_unlock(&scsp_spinlock);
280 if (rte_mempool_sc_get(mp_spsc, &obj) < 0)
282 rte_spinlock_lock(&scsp_spinlock);
283 scsp_obj_table[i] = obj;
284 rte_spinlock_unlock(&scsp_spinlock);
291 * test function for mempool test based on singple consumer and single producer, can run on one lcore only
293 static int test_mempool_launch_single_consumer(__attribute__((unused)) void *arg)
295 return test_mempool_single_consumer();
298 static void my_mp_init(struct rte_mempool * mp, __attribute__((unused)) void * arg)
300 printf("mempool name is %s\n", mp->name);
301 /* nothing to be implemented here*/
306 * it tests the mempool operations based on singple producer and single consumer
309 test_mempool_sp_sc(void)
312 unsigned lcore_id = rte_lcore_id();
315 /* create a mempool with single producer/consumer ring */
316 if (NULL == mp_spsc) {
317 mp_spsc = rte_mempool_create("test_mempool_sp_sc", MEMPOOL_SIZE,
318 MEMPOOL_ELT_SIZE, 0, 0,
321 SOCKET_ID_ANY, MEMPOOL_F_NO_CACHE_ALIGN | MEMPOOL_F_SP_PUT | MEMPOOL_F_SC_GET);
322 if (NULL == mp_spsc) {
326 if (rte_mempool_lookup("test_mempool_sp_sc") != mp_spsc) {
327 printf("Cannot lookup mempool from its name\n");
330 lcore_next = rte_get_next_lcore(lcore_id, 0, 1);
331 if (RTE_MAX_LCORE <= lcore_next)
333 if (rte_eal_lcore_role(lcore_next) != ROLE_RTE)
335 rte_spinlock_init(&scsp_spinlock);
336 memset(scsp_obj_table, 0, sizeof(scsp_obj_table));
337 rte_eal_remote_launch(test_mempool_launch_single_consumer, NULL, lcore_next);
338 if(test_mempool_single_producer() < 0)
341 if(rte_eal_wait_lcore(lcore_next) < 0)
348 * it tests some more basic of mempool
351 test_mempool_basic_ex(struct rte_mempool * mp)
361 obj = rte_calloc("test_mempool_basic_ex", MEMPOOL_SIZE , sizeof(void *), 0);
363 printf("test_mempool_basic_ex fail to rte_malloc\n");
366 printf("test_mempool_basic_ex now mempool (%s) has %u free entries\n", mp->name, rte_mempool_free_count(mp));
367 if (rte_mempool_full(mp) != 1) {
368 printf("test_mempool_basic_ex the mempool is not full but it should be\n");
369 goto fail_mp_basic_ex;
372 for (i = 0; i < MEMPOOL_SIZE; i ++) {
373 if (rte_mempool_mc_get(mp, &obj[i]) < 0) {
374 printf("fail_mp_basic_ex fail to get mempool object for [%u]\n", i);
375 goto fail_mp_basic_ex;
378 if (rte_mempool_mc_get(mp, &err_obj) == 0) {
379 printf("test_mempool_basic_ex get an impossible obj from mempool\n");
380 goto fail_mp_basic_ex;
382 printf("number: %u\n", i);
383 if (rte_mempool_empty(mp) != 1) {
384 printf("test_mempool_basic_ex the mempool is not empty but it should be\n");
385 goto fail_mp_basic_ex;
388 for (i = 0; i < MEMPOOL_SIZE; i ++) {
389 rte_mempool_mp_put(mp, obj[i]);
391 if (rte_mempool_full(mp) != 1) {
392 printf("test_mempool_basic_ex the mempool is not full but it should be\n");
393 goto fail_mp_basic_ex;
400 rte_free((void *)obj);
406 test_mempool_same_name_twice_creation(void)
408 struct rte_mempool *mp_tc;
410 mp_tc = rte_mempool_create("test_mempool_same_name_twice_creation", MEMPOOL_SIZE,
411 MEMPOOL_ELT_SIZE, 0, 0,
418 mp_tc = rte_mempool_create("test_mempool_same_name_twice_creation", MEMPOOL_SIZE,
419 MEMPOOL_ELT_SIZE, 0, 0,
430 * BAsic test for mempool_xmem functions.
433 test_mempool_xmem_misc(void)
435 uint32_t elt_num, total_size;
440 total_size = rte_mempool_calc_obj_size(MEMPOOL_ELT_SIZE, 0, NULL);
441 sz = rte_mempool_xmem_size(elt_num, total_size, MEMPOOL_PG_SHIFT_MAX);
443 usz = rte_mempool_xmem_usage(NULL, elt_num, total_size, 0, 1,
444 MEMPOOL_PG_SHIFT_MAX);
446 if(sz != (size_t)usz) {
447 printf("failure @ %s: rte_mempool_xmem_usage(%u, %u) "
448 "returns: %#zx, while expected: %#zx;\n",
449 __func__, elt_num, total_size, sz, (size_t)usz);
459 rte_atomic32_init(&synchro);
461 /* create a mempool (without cache) */
462 if (mp_nocache == NULL)
463 mp_nocache = rte_mempool_create("test_nocache", MEMPOOL_SIZE,
464 MEMPOOL_ELT_SIZE, 0, 0,
468 if (mp_nocache == NULL)
471 /* create a mempool (with cache) */
472 if (mp_cache == NULL)
473 mp_cache = rte_mempool_create("test_cache", MEMPOOL_SIZE,
475 RTE_MEMPOOL_CACHE_MAX_SIZE, 0,
479 if (mp_cache == NULL)
483 /* retrieve the mempool from its name */
484 if (rte_mempool_lookup("test_nocache") != mp_nocache) {
485 printf("Cannot lookup mempool from its name\n");
489 rte_mempool_list_dump(stdout);
491 /* basic tests without cache */
493 if (test_mempool_basic() < 0)
496 /* basic tests with cache */
498 if (test_mempool_basic() < 0)
501 /* more basic tests without cache */
502 if (test_mempool_basic_ex(mp_nocache) < 0)
505 /* mempool operation test based on single producer and single comsumer */
506 if (test_mempool_sp_sc() < 0)
509 if (test_mempool_creation_with_exceeded_cache_size() < 0)
512 if (test_mempool_same_name_twice_creation() < 0)
515 if (test_mempool_xmem_misc() < 0)
518 rte_mempool_list_dump(stdout);
523 static struct test_command mempool_cmd = {
524 .command = "mempool_autotest",
525 .callback = test_mempool,
527 REGISTER_TEST_COMMAND(mempool_cmd);