3dd2ed4c4dd6efcf28ba684a954f69892127262f
[deb_dpdk.git] / test / test / test_rwlock.c
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
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
16  *       distribution.
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.
20  *
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.
32  */
33
34 #include <stdio.h>
35 #include <stdint.h>
36 #include <unistd.h>
37 #include <sys/queue.h>
38
39 #include <rte_common.h>
40 #include <rte_memory.h>
41 #include <rte_memzone.h>
42 #include <rte_per_lcore.h>
43 #include <rte_launch.h>
44 #include <rte_atomic.h>
45 #include <rte_rwlock.h>
46 #include <rte_eal.h>
47 #include <rte_lcore.h>
48 #include <rte_cycles.h>
49
50 #include "test.h"
51
52 /*
53  * rwlock test
54  * ===========
55  *
56  * - There is a global rwlock and a table of rwlocks (one per lcore).
57  *
58  * - The test function takes all of these locks and launches the
59  *   ``test_rwlock_per_core()`` function on each core (except the master).
60  *
61  *   - The function takes the global write lock, display something,
62  *     then releases the global lock.
63  *   - Then, it takes the per-lcore write lock, display something, and
64  *     releases the per-core lock.
65  *   - Finally, a read lock is taken during 100 ms, then released.
66  *
67  * - The main function unlocks the per-lcore locks sequentially and
68  *   waits between each lock. This triggers the display of a message
69  *   for each core, in the correct order.
70  *
71  *   Then, it tries to take the global write lock and display the last
72  *   message. The autotest script checks that the message order is correct.
73  */
74
75 static rte_rwlock_t sl;
76 static rte_rwlock_t sl_tab[RTE_MAX_LCORE];
77
78 static int
79 test_rwlock_per_core(__attribute__((unused)) void *arg)
80 {
81         rte_rwlock_write_lock(&sl);
82         printf("Global write lock taken on core %u\n", rte_lcore_id());
83         rte_rwlock_write_unlock(&sl);
84
85         rte_rwlock_write_lock(&sl_tab[rte_lcore_id()]);
86         printf("Hello from core %u !\n", rte_lcore_id());
87         rte_rwlock_write_unlock(&sl_tab[rte_lcore_id()]);
88
89         rte_rwlock_read_lock(&sl);
90         printf("Global read lock taken on core %u\n", rte_lcore_id());
91         rte_delay_ms(100);
92         printf("Release global read lock on core %u\n", rte_lcore_id());
93         rte_rwlock_read_unlock(&sl);
94
95         return 0;
96 }
97
98 static int
99 test_rwlock(void)
100 {
101         int i;
102
103         rte_rwlock_init(&sl);
104         for (i=0; i<RTE_MAX_LCORE; i++)
105                 rte_rwlock_init(&sl_tab[i]);
106
107         rte_rwlock_write_lock(&sl);
108
109         RTE_LCORE_FOREACH_SLAVE(i) {
110                 rte_rwlock_write_lock(&sl_tab[i]);
111                 rte_eal_remote_launch(test_rwlock_per_core, NULL, i);
112         }
113
114         rte_rwlock_write_unlock(&sl);
115
116         RTE_LCORE_FOREACH_SLAVE(i) {
117                 rte_rwlock_write_unlock(&sl_tab[i]);
118                 rte_delay_ms(100);
119         }
120
121         rte_rwlock_write_lock(&sl);
122         /* this message should be the last message of test */
123         printf("Global write lock taken on master core %u\n", rte_lcore_id());
124         rte_rwlock_write_unlock(&sl);
125
126         rte_eal_mp_wait_lcore();
127
128         return 0;
129 }
130
131 REGISTER_TEST_COMMAND(rwlock_autotest, test_rwlock);