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>
50 #include <rte_tailq.h>
52 #include <rte_per_lcore.h>
53 #include <rte_lcore.h>
54 #include <rte_atomic.h>
55 #include <rte_branch_prediction.h>
57 #include <rte_mempool.h>
58 #include <rte_spinlock.h>
59 #include <rte_malloc.h>
67 * Basic tests: done on one core with and without cache:
69 * - Get one object, put one object
70 * - Get two objects, put two objects
71 * - Get all objects, test that their content is not modified and
72 * put them back in the pool.
77 #define MEMPOOL_ELT_SIZE 2048
79 #define MEMPOOL_SIZE ((RTE_MAX_LCORE*(MAX_KEEP+RTE_MEMPOOL_CACHE_MAX_SIZE))-1)
81 static struct rte_mempool *mp;
82 static struct rte_mempool *mp_cache, *mp_nocache;
84 static rte_atomic32_t synchro;
89 * save the object number in the first 4 bytes of object data. All
90 * other bytes are set to 0.
93 my_obj_init(struct rte_mempool *mp, __attribute__((unused)) void *arg,
94 void *obj, unsigned i)
96 uint32_t *objnum = obj;
97 memset(obj, 0, mp->elt_size);
101 /* basic tests (done on one core) */
103 test_mempool_basic(void)
112 /* dump the mempool status */
113 rte_mempool_dump(mp);
115 printf("get an object\n");
116 if (rte_mempool_get(mp, &obj) < 0)
118 rte_mempool_dump(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) !=
127 (char*) mp + MEMPOOL_HEADER_SIZE(mp, mp->pg_num))
130 printf("get physical address of an object\n");
131 if (MEMPOOL_IS_CONTIG(mp) &&
132 rte_mempool_virt2phy(mp, obj) !=
133 (phys_addr_t) (mp->phys_addr +
134 (phys_addr_t) ((char*) obj - (char*) mp)))
137 printf("put the object back\n");
138 rte_mempool_put(mp, obj);
139 rte_mempool_dump(mp);
141 printf("get 2 objects\n");
142 if (rte_mempool_get(mp, &obj) < 0)
144 if (rte_mempool_get(mp, &obj2) < 0) {
145 rte_mempool_put(mp, obj);
148 rte_mempool_dump(mp);
150 printf("put the objects back\n");
151 rte_mempool_put(mp, obj);
152 rte_mempool_put(mp, obj2);
153 rte_mempool_dump(mp);
156 * get many objects: we cannot get them all because the cache
157 * on other cores may not be empty.
159 objtable = malloc(MEMPOOL_SIZE * sizeof(void *));
160 if (objtable == NULL) {
164 for (i=0; i<MEMPOOL_SIZE; i++) {
165 if (rte_mempool_get(mp, &objtable[i]) < 0)
170 * for each object, check that its content was not modified,
171 * and put objects back in pool
177 if (*objnum > MEMPOOL_SIZE) {
178 printf("bad object number\n");
182 for (j=sizeof(*objnum); j<mp->elt_size; j++) {
183 if (obj_data[j] != 0)
187 rte_mempool_put(mp, objtable[i]);
192 printf("objects were modified!\n");
197 static int test_mempool_creation_with_exceeded_cache_size(void)
199 struct rte_mempool *mp_cov;
201 mp_cov = rte_mempool_create("test_mempool_creation_with_exceeded_cache_size", MEMPOOL_SIZE,
203 RTE_MEMPOOL_CACHE_MAX_SIZE + 32, 0,
214 static struct rte_mempool *mp_spsc;
215 static rte_spinlock_t scsp_spinlock;
216 static void *scsp_obj_table[MAX_KEEP];
219 * single producer function
221 static int test_mempool_single_producer(void)
225 uint64_t start_cycles, end_cycles;
226 uint64_t duration = rte_get_timer_hz() * 8;
228 start_cycles = rte_get_timer_cycles();
230 end_cycles = rte_get_timer_cycles();
231 /* duration uses up, stop producing */
232 if (start_cycles + duration < end_cycles)
234 rte_spinlock_lock(&scsp_spinlock);
235 for (i = 0; i < MAX_KEEP; i ++) {
236 if (NULL != scsp_obj_table[i]) {
237 obj = scsp_obj_table[i];
241 rte_spinlock_unlock(&scsp_spinlock);
245 if (rte_mempool_from_obj(obj) != mp_spsc) {
246 printf("test_mempool_single_producer there is an obj not owned by this mempool\n");
249 rte_mempool_sp_put(mp_spsc, obj);
250 rte_spinlock_lock(&scsp_spinlock);
251 scsp_obj_table[i] = NULL;
252 rte_spinlock_unlock(&scsp_spinlock);
259 * single consumer function
261 static int test_mempool_single_consumer(void)
265 uint64_t start_cycles, end_cycles;
266 uint64_t duration = rte_get_timer_hz() * 5;
268 start_cycles = rte_get_timer_cycles();
270 end_cycles = rte_get_timer_cycles();
271 /* duration uses up, stop consuming */
272 if (start_cycles + duration < end_cycles)
274 rte_spinlock_lock(&scsp_spinlock);
275 for (i = 0; i < MAX_KEEP; i ++) {
276 if (NULL == scsp_obj_table[i])
279 rte_spinlock_unlock(&scsp_spinlock);
282 if (rte_mempool_sc_get(mp_spsc, &obj) < 0)
284 rte_spinlock_lock(&scsp_spinlock);
285 scsp_obj_table[i] = obj;
286 rte_spinlock_unlock(&scsp_spinlock);
293 * test function for mempool test based on singple consumer and single producer, can run on one lcore only
295 static int test_mempool_launch_single_consumer(__attribute__((unused)) void *arg)
297 return test_mempool_single_consumer();
300 static void my_mp_init(struct rte_mempool * mp, __attribute__((unused)) void * arg)
302 printf("mempool name is %s\n", mp->name);
303 /* nothing to be implemented here*/
308 * it tests the mempool operations based on singple producer and single consumer
311 test_mempool_sp_sc(void)
314 unsigned lcore_id = rte_lcore_id();
317 /* create a mempool with single producer/consumer ring */
318 if (NULL == mp_spsc) {
319 mp_spsc = rte_mempool_create("test_mempool_sp_sc", MEMPOOL_SIZE,
320 MEMPOOL_ELT_SIZE, 0, 0,
323 SOCKET_ID_ANY, MEMPOOL_F_NO_CACHE_ALIGN | MEMPOOL_F_SP_PUT | MEMPOOL_F_SC_GET);
324 if (NULL == mp_spsc) {
328 if (rte_mempool_lookup("test_mempool_sp_sc") != mp_spsc) {
329 printf("Cannot lookup mempool from its name\n");
332 lcore_next = rte_get_next_lcore(lcore_id, 0, 1);
333 if (RTE_MAX_LCORE <= lcore_next)
335 if (rte_eal_lcore_role(lcore_next) != ROLE_RTE)
337 rte_spinlock_init(&scsp_spinlock);
338 memset(scsp_obj_table, 0, sizeof(scsp_obj_table));
339 rte_eal_remote_launch(test_mempool_launch_single_consumer, NULL, lcore_next);
340 if(test_mempool_single_producer() < 0)
343 if(rte_eal_wait_lcore(lcore_next) < 0)
350 * it tests some more basic of mempool
353 test_mempool_basic_ex(struct rte_mempool * mp)
363 obj = (void **)rte_zmalloc("test_mempool_basic_ex", (MEMPOOL_SIZE * sizeof(void *)), 0);
365 printf("test_mempool_basic_ex fail to rte_malloc\n");
368 printf("test_mempool_basic_ex now mempool (%s) has %u free entries\n", mp->name, rte_mempool_free_count(mp));
369 if (rte_mempool_full(mp) != 1) {
370 printf("test_mempool_basic_ex the mempool is not full but it should be\n");
371 goto fail_mp_basic_ex;
374 for (i = 0; i < MEMPOOL_SIZE; i ++) {
375 if (rte_mempool_mc_get(mp, &obj[i]) < 0) {
376 printf("fail_mp_basic_ex fail to get mempool object for [%u]\n", i);
377 goto fail_mp_basic_ex;
380 if (rte_mempool_mc_get(mp, &err_obj) == 0) {
381 printf("test_mempool_basic_ex get an impossible obj from mempool\n");
382 goto fail_mp_basic_ex;
384 printf("number: %u\n", i);
385 if (rte_mempool_empty(mp) != 1) {
386 printf("test_mempool_basic_ex the mempool is not empty but it should be\n");
387 goto fail_mp_basic_ex;
390 for (i = 0; i < MEMPOOL_SIZE; i ++) {
391 rte_mempool_mp_put(mp, obj[i]);
393 if (rte_mempool_full(mp) != 1) {
394 printf("test_mempool_basic_ex the mempool is not full but it should be\n");
395 goto fail_mp_basic_ex;
402 rte_free((void *)obj);
408 test_mempool_same_name_twice_creation(void)
410 struct rte_mempool *mp_tc;
412 mp_tc = rte_mempool_create("test_mempool_same_name_twice_creation", MEMPOOL_SIZE,
413 MEMPOOL_ELT_SIZE, 0, 0,
420 mp_tc = rte_mempool_create("test_mempool_same_name_twice_creation", MEMPOOL_SIZE,
421 MEMPOOL_ELT_SIZE, 0, 0,
432 * BAsic test for mempool_xmem functions.
435 test_mempool_xmem_misc(void)
437 uint32_t elt_num, total_size;
442 total_size = rte_mempool_calc_obj_size(MEMPOOL_ELT_SIZE, 0, NULL);
443 sz = rte_mempool_xmem_size(elt_num, total_size, MEMPOOL_PG_SHIFT_MAX);
445 usz = rte_mempool_xmem_usage(NULL, elt_num, total_size, 0, 1,
446 MEMPOOL_PG_SHIFT_MAX);
448 if(sz != (size_t)usz) {
449 printf("failure @ %s: rte_mempool_xmem_usage(%u, %u) "
450 "returns: %#zx, while expected: %#zx;\n",
451 __func__, elt_num, total_size, sz, (size_t)usz);
461 rte_atomic32_init(&synchro);
463 /* create a mempool (without cache) */
464 if (mp_nocache == NULL)
465 mp_nocache = rte_mempool_create("test_nocache", MEMPOOL_SIZE,
466 MEMPOOL_ELT_SIZE, 0, 0,
470 if (mp_nocache == NULL)
473 /* create a mempool (with cache) */
474 if (mp_cache == NULL)
475 mp_cache = rte_mempool_create("test_cache", MEMPOOL_SIZE,
477 RTE_MEMPOOL_CACHE_MAX_SIZE, 0,
481 if (mp_cache == NULL)
485 /* retrieve the mempool from its name */
486 if (rte_mempool_lookup("test_nocache") != mp_nocache) {
487 printf("Cannot lookup mempool from its name\n");
491 rte_mempool_list_dump();
493 /* basic tests without cache */
495 if (test_mempool_basic() < 0)
498 /* basic tests with cache */
500 if (test_mempool_basic() < 0)
503 /* more basic tests without cache */
504 if (test_mempool_basic_ex(mp_nocache) < 0)
507 /* mempool operation test based on single producer and single comsumer */
508 if (test_mempool_sp_sc() < 0)
511 if (test_mempool_creation_with_exceeded_cache_size() < 0)
514 if (test_mempool_same_name_twice_creation() < 0)
517 if (test_mempool_xmem_misc() < 0)
520 rte_mempool_list_dump();