4 * Copyright(c) 2010-2012 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.
42 #include <sys/queue.h>
44 #include <rte_common.h>
46 #include <rte_debug.h>
47 #include <rte_memory.h>
48 #include <rte_memzone.h>
49 #include <rte_launch.h>
50 #include <rte_cycles.h>
51 #include <rte_tailq.h>
53 #include <rte_per_lcore.h>
54 #include <rte_lcore.h>
55 #include <rte_atomic.h>
56 #include <rte_branch_prediction.h>
58 #include <rte_mempool.h>
59 #include <rte_spinlock.h>
60 #include <rte_malloc.h>
62 #include <cmdline_parse.h>
70 * Basic tests: done on one core with and without cache:
72 * - Get one object, put one object
73 * - Get two objects, put two objects
74 * - Get all objects, test that their content is not modified and
75 * put them back in the pool.
80 #define MEMPOOL_ELT_SIZE 2048
82 #define MEMPOOL_SIZE ((RTE_MAX_LCORE*(MAX_KEEP+RTE_MEMPOOL_CACHE_MAX_SIZE))-1)
84 static struct rte_mempool *mp;
85 static struct rte_mempool *mp_cache, *mp_nocache;
87 static rte_atomic32_t synchro;
92 * save the object number in the first 4 bytes of object data. All
93 * other bytes are set to 0.
96 my_obj_init(struct rte_mempool *mp, __attribute__((unused)) void *arg,
97 void *obj, unsigned i)
99 uint32_t *objnum = obj;
100 memset(obj, 0, mp->elt_size);
104 /* basic tests (done on one core) */
106 test_mempool_basic(void)
115 /* dump the mempool status */
116 rte_mempool_dump(mp);
118 printf("get an object\n");
119 if (rte_mempool_get(mp, &obj) < 0)
121 rte_mempool_dump(mp);
123 /* tests that improve coverage */
124 printf("get object count\n");
125 if (rte_mempool_count(mp) != MEMPOOL_SIZE - 1)
128 printf("get private data\n");
129 if (rte_mempool_get_priv(mp) !=
130 (char*) mp + sizeof(struct rte_mempool))
133 printf("get physical address of an object\n");
134 if (rte_mempool_virt2phy(mp, obj) !=
135 (phys_addr_t) (mp->phys_addr + (phys_addr_t) ((char*) obj - (char*) mp)))
138 printf("put the object back\n");
139 rte_mempool_put(mp, obj);
140 rte_mempool_dump(mp);
142 printf("get 2 objects\n");
143 if (rte_mempool_get(mp, &obj) < 0)
145 if (rte_mempool_get(mp, &obj2) < 0) {
146 rte_mempool_put(mp, obj);
149 rte_mempool_dump(mp);
151 printf("put the objects back\n");
152 rte_mempool_put(mp, obj);
153 rte_mempool_put(mp, obj2);
154 rte_mempool_dump(mp);
157 * get many objects: we cannot get them all because the cache
158 * on other cores may not be empty.
160 objtable = malloc(MEMPOOL_SIZE * sizeof(void *));
161 if (objtable == NULL) {
165 for (i=0; i<MEMPOOL_SIZE; i++) {
166 if (rte_mempool_get(mp, &objtable[i]) < 0)
171 * for each object, check that its content was not modified,
172 * and put objects back in pool
178 if (*objnum > MEMPOOL_SIZE) {
179 printf("bad object number\n");
183 for (j=sizeof(*objnum); j<mp->elt_size; j++) {
184 if (obj_data[j] != 0)
188 rte_mempool_put(mp, objtable[i]);
193 printf("objects were modified!\n");
198 static int test_mempool_creation_with_exceeded_cache_size(void)
200 struct rte_mempool *mp_cov;
202 mp_cov = rte_mempool_create("test_mempool_creation_with_exceeded_cache_size", MEMPOOL_SIZE,
204 RTE_MEMPOOL_CACHE_MAX_SIZE + 32, 0,
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_hpet_hz() * 8;
229 start_cycles = rte_get_hpet_cycles();
231 end_cycles = rte_get_hpet_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("test_mempool_single_producer there is an 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_hpet_hz() * 5;
269 start_cycles = rte_get_hpet_cycles();
271 end_cycles = rte_get_hpet_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, can run on one lcore only
296 static int test_mempool_launch_single_consumer(__attribute__((unused)) void *arg)
298 return test_mempool_single_consumer();
301 static void my_mp_init(struct rte_mempool * mp, __attribute__((unused)) void * arg)
303 printf("mempool name is %s\n", mp->name);
304 /* nothing to be implemented here*/
309 * it tests the mempool operations based on singple producer and single consumer
312 test_mempool_sp_sc(void)
315 unsigned lcore_id = rte_lcore_id();
318 /* create a mempool with single producer/consumer ring */
319 if (NULL == mp_spsc) {
320 mp_spsc = rte_mempool_create("test_mempool_sp_sc", MEMPOOL_SIZE,
321 MEMPOOL_ELT_SIZE, 0, 0,
324 SOCKET_ID_ANY, MEMPOOL_F_NO_CACHE_ALIGN | MEMPOOL_F_SP_PUT | MEMPOOL_F_SC_GET);
325 if (NULL == mp_spsc) {
329 if (rte_mempool_lookup("test_mempool_sp_sc") != mp_spsc) {
330 printf("Cannot lookup mempool from its name\n");
333 lcore_next = rte_get_next_lcore(lcore_id, 0, 1);
334 if (RTE_MAX_LCORE <= lcore_next)
336 if (rte_eal_lcore_role(lcore_next) != ROLE_RTE)
338 rte_spinlock_init(&scsp_spinlock);
339 memset(scsp_obj_table, 0, sizeof(scsp_obj_table));
340 rte_eal_remote_launch(test_mempool_launch_single_consumer, NULL, lcore_next);
341 if(test_mempool_single_producer() < 0)
344 if(rte_eal_wait_lcore(lcore_next) < 0)
351 * it tests some more basic of mempool
354 test_mempool_basic_ex(struct rte_mempool * mp)
364 obj = (void **)rte_zmalloc("test_mempool_basic_ex", (MEMPOOL_SIZE * sizeof(void *)), 0);
366 printf("test_mempool_basic_ex fail to rte_malloc\n");
369 printf("test_mempool_basic_ex now mempool (%s) has %u free entries\n", mp->name, rte_mempool_free_count(mp));
370 if (rte_mempool_full(mp) != 1) {
371 printf("test_mempool_basic_ex the mempool is not full but it should be\n");
372 goto fail_mp_basic_ex;
375 for (i = 0; i < MEMPOOL_SIZE; i ++) {
376 if (rte_mempool_mc_get(mp, &obj[i]) < 0) {
377 printf("fail_mp_basic_ex fail to get mempool object for [%u]\n", i);
378 goto fail_mp_basic_ex;
381 if (rte_mempool_mc_get(mp, &err_obj) == 0) {
382 printf("test_mempool_basic_ex get an impossible obj from mempool\n");
383 goto fail_mp_basic_ex;
385 printf("number: %u\n", i);
386 if (rte_mempool_empty(mp) != 1) {
387 printf("test_mempool_basic_ex the mempool is not empty but it should be\n");
388 goto fail_mp_basic_ex;
391 for (i = 0; i < MEMPOOL_SIZE; i ++) {
392 rte_mempool_mp_put(mp, obj[i]);
394 if (rte_mempool_full(mp) != 1) {
395 printf("test_mempool_basic_ex the mempool is not full but it should be\n");
396 goto fail_mp_basic_ex;
403 rte_free((void *)obj);
409 test_mempool_same_name_twice_creation(void)
411 struct rte_mempool *mp_tc;
413 mp_tc = rte_mempool_create("test_mempool_same_name_twice_creation", MEMPOOL_SIZE,
414 MEMPOOL_ELT_SIZE, 0, 0,
421 mp_tc = rte_mempool_create("test_mempool_same_name_twice_creation", MEMPOOL_SIZE,
422 MEMPOOL_ELT_SIZE, 0, 0,
435 rte_atomic32_init(&synchro);
437 /* create a mempool (without cache) */
438 if (mp_nocache == NULL)
439 mp_nocache = rte_mempool_create("test_nocache", MEMPOOL_SIZE,
440 MEMPOOL_ELT_SIZE, 0, 0,
444 if (mp_nocache == NULL)
447 /* create a mempool (with cache) */
448 if (mp_cache == NULL)
449 mp_cache = rte_mempool_create("test_cache", MEMPOOL_SIZE,
451 RTE_MEMPOOL_CACHE_MAX_SIZE, 0,
455 if (mp_cache == NULL)
459 /* retrieve the mempool from its name */
460 if (rte_mempool_lookup("test_nocache") != mp_nocache) {
461 printf("Cannot lookup mempool from its name\n");
465 rte_mempool_list_dump();
467 /* basic tests without cache */
469 if (test_mempool_basic() < 0)
472 /* basic tests with cache */
474 if (test_mempool_basic() < 0)
477 /* more basic tests without cache */
478 if (test_mempool_basic_ex(mp_nocache) < 0)
481 /* mempool operation test based on single producer and single comsumer */
482 if (test_mempool_sp_sc() < 0)
485 if (test_mempool_creation_with_exceeded_cache_size() < 0)
488 if (test_mempool_same_name_twice_creation() < 0)
491 rte_mempool_list_dump();