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_memory.h>
46 #include <rte_memzone.h>
47 #include <rte_launch.h>
48 #include <rte_cycles.h>
50 #include <rte_per_lcore.h>
51 #include <rte_lcore.h>
52 #include <rte_atomic.h>
53 #include <rte_branch_prediction.h>
54 #include <rte_malloc.h>
56 #include <rte_random.h>
57 #include <rte_common.h>
58 #include <rte_errno.h>
59 #include <rte_hexdump.h>
67 * #. Basic tests: done on one core:
69 * - Using single producer/single consumer functions:
71 * - Enqueue one object, two objects, MAX_BULK objects
72 * - Dequeue one object, two objects, MAX_BULK objects
73 * - Check that dequeued pointers are correct
75 * - Using multi producers/multi consumers functions:
77 * - Enqueue one object, two objects, MAX_BULK objects
78 * - Dequeue one object, two objects, MAX_BULK objects
79 * - Check that dequeued pointers are correct
81 * #. Performance tests.
83 * Tests done in test_ring_perf.c
86 #define RING_SIZE 4096
89 static rte_atomic32_t synchro;
91 static struct rte_ring *r;
93 #define TEST_RING_VERIFY(exp) \
95 printf("error at %s:%d\tcondition " #exp " failed\n", \
96 __func__, __LINE__); \
97 rte_ring_dump(stdout, r); \
101 #define TEST_RING_FULL_EMTPY_ITER 8
104 * helper routine for test_ring_basic
107 test_ring_basic_full_empty(void * const src[], void *dst[])
110 const unsigned rsz = RING_SIZE - 1;
112 printf("Basic full/empty test\n");
114 for (i = 0; TEST_RING_FULL_EMTPY_ITER != i; i++) {
116 /* random shift in the ring */
117 rand = RTE_MAX(rte_rand() % RING_SIZE, 1UL);
118 printf("%s: iteration %u, random shift: %u;\n",
120 TEST_RING_VERIFY(rte_ring_enqueue_bulk(r, src, rand,
122 TEST_RING_VERIFY(rte_ring_dequeue_bulk(r, dst, rand,
126 TEST_RING_VERIFY(rte_ring_enqueue_bulk(r, src, rsz, NULL) != 0);
127 TEST_RING_VERIFY(0 == rte_ring_free_count(r));
128 TEST_RING_VERIFY(rsz == rte_ring_count(r));
129 TEST_RING_VERIFY(rte_ring_full(r));
130 TEST_RING_VERIFY(0 == rte_ring_empty(r));
133 TEST_RING_VERIFY(rte_ring_dequeue_bulk(r, dst, rsz,
135 TEST_RING_VERIFY(rsz == rte_ring_free_count(r));
136 TEST_RING_VERIFY(0 == rte_ring_count(r));
137 TEST_RING_VERIFY(0 == rte_ring_full(r));
138 TEST_RING_VERIFY(rte_ring_empty(r));
141 TEST_RING_VERIFY(0 == memcmp(src, dst, rsz));
142 rte_ring_dump(stdout, r);
148 test_ring_basic(void)
150 void **src = NULL, **cur_src = NULL, **dst = NULL, **cur_dst = NULL;
152 unsigned i, num_elems;
154 /* alloc dummy object pointers */
155 src = malloc(RING_SIZE*2*sizeof(void *));
159 for (i = 0; i < RING_SIZE*2 ; i++) {
160 src[i] = (void *)(unsigned long)i;
164 /* alloc some room for copied objects */
165 dst = malloc(RING_SIZE*2*sizeof(void *));
169 memset(dst, 0, RING_SIZE*2*sizeof(void *));
172 printf("enqueue 1 obj\n");
173 ret = rte_ring_sp_enqueue_bulk(r, cur_src, 1, NULL);
178 printf("enqueue 2 objs\n");
179 ret = rte_ring_sp_enqueue_bulk(r, cur_src, 2, NULL);
184 printf("enqueue MAX_BULK objs\n");
185 ret = rte_ring_sp_enqueue_bulk(r, cur_src, MAX_BULK, NULL);
190 printf("dequeue 1 obj\n");
191 ret = rte_ring_sc_dequeue_bulk(r, cur_dst, 1, NULL);
196 printf("dequeue 2 objs\n");
197 ret = rte_ring_sc_dequeue_bulk(r, cur_dst, 2, NULL);
202 printf("dequeue MAX_BULK objs\n");
203 ret = rte_ring_sc_dequeue_bulk(r, cur_dst, MAX_BULK, NULL);
209 if (memcmp(src, dst, cur_dst - dst)) {
210 rte_hexdump(stdout, "src", src, cur_src - src);
211 rte_hexdump(stdout, "dst", dst, cur_dst - dst);
212 printf("data after dequeue is not the same\n");
218 printf("enqueue 1 obj\n");
219 ret = rte_ring_mp_enqueue_bulk(r, cur_src, 1, NULL);
224 printf("enqueue 2 objs\n");
225 ret = rte_ring_mp_enqueue_bulk(r, cur_src, 2, NULL);
230 printf("enqueue MAX_BULK objs\n");
231 ret = rte_ring_mp_enqueue_bulk(r, cur_src, MAX_BULK, NULL);
236 printf("dequeue 1 obj\n");
237 ret = rte_ring_mc_dequeue_bulk(r, cur_dst, 1, NULL);
242 printf("dequeue 2 objs\n");
243 ret = rte_ring_mc_dequeue_bulk(r, cur_dst, 2, NULL);
248 printf("dequeue MAX_BULK objs\n");
249 ret = rte_ring_mc_dequeue_bulk(r, cur_dst, MAX_BULK, NULL);
255 if (memcmp(src, dst, cur_dst - dst)) {
256 rte_hexdump(stdout, "src", src, cur_src - src);
257 rte_hexdump(stdout, "dst", dst, cur_dst - dst);
258 printf("data after dequeue is not the same\n");
264 printf("fill and empty the ring\n");
265 for (i = 0; i<RING_SIZE/MAX_BULK; i++) {
266 ret = rte_ring_mp_enqueue_bulk(r, cur_src, MAX_BULK, NULL);
270 ret = rte_ring_mc_dequeue_bulk(r, cur_dst, MAX_BULK, NULL);
277 if (memcmp(src, dst, cur_dst - dst)) {
278 rte_hexdump(stdout, "src", src, cur_src - src);
279 rte_hexdump(stdout, "dst", dst, cur_dst - dst);
280 printf("data after dequeue is not the same\n");
284 if (test_ring_basic_full_empty(src, dst) != 0)
290 printf("test default bulk enqueue / dequeue\n");
296 ret = rte_ring_enqueue_bulk(r, cur_src, num_elems, NULL);
297 cur_src += num_elems;
299 printf("Cannot enqueue\n");
302 ret = rte_ring_enqueue_bulk(r, cur_src, num_elems, NULL);
303 cur_src += num_elems;
305 printf("Cannot enqueue\n");
308 ret = rte_ring_dequeue_bulk(r, cur_dst, num_elems, NULL);
309 cur_dst += num_elems;
311 printf("Cannot dequeue\n");
314 ret = rte_ring_dequeue_bulk(r, cur_dst, num_elems, NULL);
315 cur_dst += num_elems;
317 printf("Cannot dequeue2\n");
322 if (memcmp(src, dst, cur_dst - dst)) {
323 rte_hexdump(stdout, "src", src, cur_src - src);
324 rte_hexdump(stdout, "dst", dst, cur_dst - dst);
325 printf("data after dequeue is not the same\n");
332 ret = rte_ring_mp_enqueue(r, cur_src);
336 ret = rte_ring_mc_dequeue(r, cur_dst);
351 test_ring_burst_basic(void)
353 void **src = NULL, **cur_src = NULL, **dst = NULL, **cur_dst = NULL;
357 /* alloc dummy object pointers */
358 src = malloc(RING_SIZE*2*sizeof(void *));
362 for (i = 0; i < RING_SIZE*2 ; i++) {
363 src[i] = (void *)(unsigned long)i;
367 /* alloc some room for copied objects */
368 dst = malloc(RING_SIZE*2*sizeof(void *));
372 memset(dst, 0, RING_SIZE*2*sizeof(void *));
375 printf("Test SP & SC basic functions \n");
376 printf("enqueue 1 obj\n");
377 ret = rte_ring_sp_enqueue_burst(r, cur_src, 1, NULL);
379 if ((ret & RTE_RING_SZ_MASK) != 1)
382 printf("enqueue 2 objs\n");
383 ret = rte_ring_sp_enqueue_burst(r, cur_src, 2, NULL);
385 if ((ret & RTE_RING_SZ_MASK) != 2)
388 printf("enqueue MAX_BULK objs\n");
389 ret = rte_ring_sp_enqueue_burst(r, cur_src, MAX_BULK, NULL);
391 if ((ret & RTE_RING_SZ_MASK) != MAX_BULK)
394 printf("dequeue 1 obj\n");
395 ret = rte_ring_sc_dequeue_burst(r, cur_dst, 1, NULL);
397 if ((ret & RTE_RING_SZ_MASK) != 1)
400 printf("dequeue 2 objs\n");
401 ret = rte_ring_sc_dequeue_burst(r, cur_dst, 2, NULL);
403 if ((ret & RTE_RING_SZ_MASK) != 2)
406 printf("dequeue MAX_BULK objs\n");
407 ret = rte_ring_sc_dequeue_burst(r, cur_dst, MAX_BULK, NULL);
409 if ((ret & RTE_RING_SZ_MASK) != MAX_BULK)
413 if (memcmp(src, dst, cur_dst - dst)) {
414 rte_hexdump(stdout, "src", src, cur_src - src);
415 rte_hexdump(stdout, "dst", dst, cur_dst - dst);
416 printf("data after dequeue is not the same\n");
423 printf("Test enqueue without enough memory space \n");
424 for (i = 0; i< (RING_SIZE/MAX_BULK - 1); i++) {
425 ret = rte_ring_sp_enqueue_burst(r, cur_src, MAX_BULK, NULL);
427 if ((ret & RTE_RING_SZ_MASK) != MAX_BULK) {
432 printf("Enqueue 2 objects, free entries = MAX_BULK - 2 \n");
433 ret = rte_ring_sp_enqueue_burst(r, cur_src, 2, NULL);
435 if ((ret & RTE_RING_SZ_MASK) != 2)
438 printf("Enqueue the remaining entries = MAX_BULK - 2 \n");
439 /* Always one free entry left */
440 ret = rte_ring_sp_enqueue_burst(r, cur_src, MAX_BULK, NULL);
441 cur_src += MAX_BULK - 3;
442 if ((ret & RTE_RING_SZ_MASK) != MAX_BULK - 3)
445 printf("Test if ring is full \n");
446 if (rte_ring_full(r) != 1)
449 printf("Test enqueue for a full entry \n");
450 ret = rte_ring_sp_enqueue_burst(r, cur_src, MAX_BULK, NULL);
451 if ((ret & RTE_RING_SZ_MASK) != 0)
454 printf("Test dequeue without enough objects \n");
455 for (i = 0; i<RING_SIZE/MAX_BULK - 1; i++) {
456 ret = rte_ring_sc_dequeue_burst(r, cur_dst, MAX_BULK, NULL);
458 if ((ret & RTE_RING_SZ_MASK) != MAX_BULK)
462 /* Available memory space for the exact MAX_BULK entries */
463 ret = rte_ring_sc_dequeue_burst(r, cur_dst, 2, NULL);
465 if ((ret & RTE_RING_SZ_MASK) != 2)
468 ret = rte_ring_sc_dequeue_burst(r, cur_dst, MAX_BULK, NULL);
469 cur_dst += MAX_BULK - 3;
470 if ((ret & RTE_RING_SZ_MASK) != MAX_BULK - 3)
473 printf("Test if ring is empty \n");
474 /* Check if ring is empty */
475 if (1 != rte_ring_empty(r))
479 if (memcmp(src, dst, cur_dst - dst)) {
480 rte_hexdump(stdout, "src", src, cur_src - src);
481 rte_hexdump(stdout, "dst", dst, cur_dst - dst);
482 printf("data after dequeue is not the same\n");
489 printf("Test MP & MC basic functions \n");
491 printf("enqueue 1 obj\n");
492 ret = rte_ring_mp_enqueue_burst(r, cur_src, 1, NULL);
494 if ((ret & RTE_RING_SZ_MASK) != 1)
497 printf("enqueue 2 objs\n");
498 ret = rte_ring_mp_enqueue_burst(r, cur_src, 2, NULL);
500 if ((ret & RTE_RING_SZ_MASK) != 2)
503 printf("enqueue MAX_BULK objs\n");
504 ret = rte_ring_mp_enqueue_burst(r, cur_src, MAX_BULK, NULL);
506 if ((ret & RTE_RING_SZ_MASK) != MAX_BULK)
509 printf("dequeue 1 obj\n");
510 ret = rte_ring_mc_dequeue_burst(r, cur_dst, 1, NULL);
512 if ((ret & RTE_RING_SZ_MASK) != 1)
515 printf("dequeue 2 objs\n");
516 ret = rte_ring_mc_dequeue_burst(r, cur_dst, 2, NULL);
518 if ((ret & RTE_RING_SZ_MASK) != 2)
521 printf("dequeue MAX_BULK objs\n");
522 ret = rte_ring_mc_dequeue_burst(r, cur_dst, MAX_BULK, NULL);
524 if ((ret & RTE_RING_SZ_MASK) != MAX_BULK)
528 if (memcmp(src, dst, cur_dst - dst)) {
529 rte_hexdump(stdout, "src", src, cur_src - src);
530 rte_hexdump(stdout, "dst", dst, cur_dst - dst);
531 printf("data after dequeue is not the same\n");
538 printf("fill and empty the ring\n");
539 for (i = 0; i<RING_SIZE/MAX_BULK; i++) {
540 ret = rte_ring_mp_enqueue_burst(r, cur_src, MAX_BULK, NULL);
542 if ((ret & RTE_RING_SZ_MASK) != MAX_BULK)
544 ret = rte_ring_mc_dequeue_burst(r, cur_dst, MAX_BULK, NULL);
546 if ((ret & RTE_RING_SZ_MASK) != MAX_BULK)
551 if (memcmp(src, dst, cur_dst - dst)) {
552 rte_hexdump(stdout, "src", src, cur_src - src);
553 rte_hexdump(stdout, "dst", dst, cur_dst - dst);
554 printf("data after dequeue is not the same\n");
561 printf("Test enqueue without enough memory space \n");
562 for (i = 0; i<RING_SIZE/MAX_BULK - 1; i++) {
563 ret = rte_ring_mp_enqueue_burst(r, cur_src, MAX_BULK, NULL);
565 if ((ret & RTE_RING_SZ_MASK) != MAX_BULK)
569 /* Available memory space for the exact MAX_BULK objects */
570 ret = rte_ring_mp_enqueue_burst(r, cur_src, 2, NULL);
572 if ((ret & RTE_RING_SZ_MASK) != 2)
575 ret = rte_ring_mp_enqueue_burst(r, cur_src, MAX_BULK, NULL);
576 cur_src += MAX_BULK - 3;
577 if ((ret & RTE_RING_SZ_MASK) != MAX_BULK - 3)
581 printf("Test dequeue without enough objects \n");
582 for (i = 0; i<RING_SIZE/MAX_BULK - 1; i++) {
583 ret = rte_ring_mc_dequeue_burst(r, cur_dst, MAX_BULK, NULL);
585 if ((ret & RTE_RING_SZ_MASK) != MAX_BULK)
589 /* Available objects - the exact MAX_BULK */
590 ret = rte_ring_mc_dequeue_burst(r, cur_dst, 2, NULL);
592 if ((ret & RTE_RING_SZ_MASK) != 2)
595 ret = rte_ring_mc_dequeue_burst(r, cur_dst, MAX_BULK, NULL);
596 cur_dst += MAX_BULK - 3;
597 if ((ret & RTE_RING_SZ_MASK) != MAX_BULK - 3)
601 if (memcmp(src, dst, cur_dst - dst)) {
602 rte_hexdump(stdout, "src", src, cur_src - src);
603 rte_hexdump(stdout, "dst", dst, cur_dst - dst);
604 printf("data after dequeue is not the same\n");
611 printf("Covering rte_ring_enqueue_burst functions \n");
613 ret = rte_ring_enqueue_burst(r, cur_src, 2, NULL);
615 if ((ret & RTE_RING_SZ_MASK) != 2)
618 ret = rte_ring_dequeue_burst(r, cur_dst, 2, NULL);
623 /* Free memory before test completed */
635 * it will always fail to create ring with a wrong ring size number in this function
638 test_ring_creation_with_wrong_size(void)
640 struct rte_ring * rp = NULL;
642 /* Test if ring size is not power of 2 */
643 rp = rte_ring_create("test_bad_ring_size", RING_SIZE + 1, SOCKET_ID_ANY, 0);
648 /* Test if ring size is exceeding the limit */
649 rp = rte_ring_create("test_bad_ring_size", (RTE_RING_SZ_MASK + 1), SOCKET_ID_ANY, 0);
657 * it tests if it would always fail to create ring with an used ring name
660 test_ring_creation_with_an_used_name(void)
662 struct rte_ring * rp;
664 rp = rte_ring_create("test", RING_SIZE, SOCKET_ID_ANY, 0);
672 * Test to if a non-power of 2 count causes the create
673 * function to fail correctly
676 test_create_count_odd(void)
678 struct rte_ring *r = rte_ring_create("test_ring_count",
679 4097, SOCKET_ID_ANY, 0 );
687 test_lookup_null(void)
689 struct rte_ring *rlp = rte_ring_lookup("ring_not_found");
691 if (rte_errno != ENOENT){
692 printf( "test failed to returnn error on null pointer\n");
699 * it tests some more basic ring operations
702 test_ring_basic_ex(void)
706 struct rte_ring * rp;
709 obj = rte_calloc("test_ring_basic_ex_malloc", RING_SIZE, sizeof(void *), 0);
711 printf("test_ring_basic_ex fail to rte_malloc\n");
715 rp = rte_ring_create("test_ring_basic_ex", RING_SIZE, SOCKET_ID_ANY,
716 RING_F_SP_ENQ | RING_F_SC_DEQ);
718 printf("test_ring_basic_ex fail to create ring\n");
722 if (rte_ring_lookup("test_ring_basic_ex") != rp) {
726 if (rte_ring_empty(rp) != 1) {
727 printf("test_ring_basic_ex ring is not empty but it should be\n");
731 printf("%u ring entries are now free\n", rte_ring_free_count(rp));
733 for (i = 0; i < RING_SIZE; i ++) {
734 rte_ring_enqueue(rp, obj[i]);
737 if (rte_ring_full(rp) != 1) {
738 printf("test_ring_basic_ex ring is not full but it should be\n");
742 for (i = 0; i < RING_SIZE; i ++) {
743 rte_ring_dequeue(rp, &obj[i]);
746 if (rte_ring_empty(rp) != 1) {
747 printf("test_ring_basic_ex ring is not empty but it should be\n");
751 /* Covering the ring burst operation */
752 ret = rte_ring_enqueue_burst(rp, obj, 2, NULL);
753 if ((ret & RTE_RING_SZ_MASK) != 2) {
754 printf("test_ring_basic_ex: rte_ring_enqueue_burst fails \n");
758 ret = rte_ring_dequeue_burst(rp, obj, 2, NULL);
760 printf("test_ring_basic_ex: rte_ring_dequeue_burst fails \n");
775 /* some more basic operations */
776 if (test_ring_basic_ex() < 0)
779 rte_atomic32_init(&synchro);
782 r = rte_ring_create("test", RING_SIZE, SOCKET_ID_ANY, 0);
786 /* retrieve the ring from its name */
787 if (rte_ring_lookup("test") != r) {
788 printf("Cannot lookup ring from its name\n");
792 /* burst operations */
793 if (test_ring_burst_basic() < 0)
796 /* basic operations */
797 if (test_ring_basic() < 0)
800 /* basic operations */
801 if ( test_create_count_odd() < 0){
802 printf ("Test failed to detect odd count\n");
806 printf ( "Test detected odd count\n");
808 if ( test_lookup_null() < 0){
809 printf ("Test failed to detect NULL ring lookup\n");
813 printf ( "Test detected NULL ring lookup \n");
815 /* test of creating ring with wrong size */
816 if (test_ring_creation_with_wrong_size() < 0)
819 /* test of creation ring with an used name */
820 if (test_ring_creation_with_an_used_name() < 0)
823 /* dump the ring status */
824 rte_ring_list_dump(stdout);
829 REGISTER_TEST_COMMAND(ring_autotest, test_ring);