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.
37 #include <rte_common.h>
38 #include <rte_cycles.h>
39 #include <rte_interrupts.h>
40 #include <rte_common.h>
41 #include <rte_atomic.h>
42 #include <rte_alarm.h>
46 #define US_PER_MS 1000
48 #define RTE_TEST_ALARM_TIMEOUT 10 /* ms */
49 #define RTE_TEST_CHECK_PERIOD 3 /* ms */
50 #define RTE_TEST_MAX_REPEAT 20
52 static volatile int flag;
55 test_alarm_callback(void *cb_arg)
58 printf("Callback setting flag - OK. [cb_arg = %p]\n", cb_arg);
61 static rte_atomic32_t cb_count;
64 test_multi_cb(void *arg)
66 rte_atomic32_inc(&cb_count);
67 printf("In %s - arg = %p\n", __func__, arg);
70 static volatile int recursive_error = 0;
73 test_remove_in_callback(void *arg)
75 printf("In %s - arg = %p\n", __func__, arg);
76 if (rte_eal_alarm_cancel(test_remove_in_callback, arg) ||
77 rte_eal_alarm_cancel(test_remove_in_callback, (void *)-1)) {
78 printf("Error - cancelling callback from within function succeeded!\n");
81 flag = (int)((uintptr_t)arg);
84 static volatile int flag_2;
87 test_remove_in_callback_2(void *arg)
89 if (rte_eal_alarm_cancel(test_remove_in_callback_2, arg) || rte_eal_alarm_cancel(test_remove_in_callback_2, (void *)-1)) {
90 printf("Error - cancelling callback of test_remove_in_callback_2\n");
97 test_multi_alarms(void)
103 printf("Expect 6 callbacks in order...\n");
104 /* add two alarms in order */
105 rte_eal_alarm_set(10 * US_PER_MS, test_multi_cb, (void *)1);
106 rte_eal_alarm_set(20 * US_PER_MS, test_multi_cb, (void *)2);
108 /* now add in reverse order */
109 rte_eal_alarm_set(60 * US_PER_MS, test_multi_cb, (void *)6);
110 rte_eal_alarm_set(50 * US_PER_MS, test_multi_cb, (void *)5);
111 rte_eal_alarm_set(40 * US_PER_MS, test_multi_cb, (void *)4);
112 rte_eal_alarm_set(30 * US_PER_MS, test_multi_cb, (void *)3);
114 /* wait for expiry */
116 if (cb_count.cnt != 6) {
117 printf("Missing callbacks\n");
118 /* remove any callbacks that might remain */
119 rte_eal_alarm_cancel(test_multi_cb, (void *)-1);
124 printf("Expect only callbacks with args 1 and 3...\n");
125 /* Add 3 flags, then delete one */
126 rte_eal_alarm_set(30 * US_PER_MS, test_multi_cb, (void *)3);
127 rte_eal_alarm_set(20 * US_PER_MS, test_multi_cb, (void *)2);
128 rte_eal_alarm_set(10 * US_PER_MS, test_multi_cb, (void *)1);
129 rm_count = rte_eal_alarm_cancel(test_multi_cb, (void *)2);
132 if (cb_count.cnt != 2 || rm_count != 1) {
133 printf("Error: invalid flags count or alarm removal failure"
134 " - flags value = %d, expected = %d\n",
135 (int)cb_count.cnt, 2);
136 /* remove any callbacks that might remain */
137 rte_eal_alarm_cancel(test_multi_cb, (void *)-1);
141 printf("Testing adding and then removing multiple alarms\n");
142 /* finally test that no callbacks are called if we delete them all*/
143 rte_eal_alarm_set(10 * US_PER_MS, test_multi_cb, (void *)1);
144 rte_eal_alarm_set(10 * US_PER_MS, test_multi_cb, (void *)2);
145 rte_eal_alarm_set(10 * US_PER_MS, test_multi_cb, (void *)3);
146 rm_count = rte_eal_alarm_cancel(test_alarm_callback, (void *)-1);
148 printf("Error removing non-existant alarm succeeded\n");
149 rte_eal_alarm_cancel(test_multi_cb, (void *) -1);
152 rm_count = rte_eal_alarm_cancel(test_multi_cb, (void *) -1);
154 printf("Error removing all pending alarm callbacks\n");
158 /* Test that we cannot cancel an alarm from within the callback itself
159 * Also test that we can cancel head-of-line callbacks ok.*/
162 rte_eal_alarm_set(10 * US_PER_MS, test_remove_in_callback, (void *)1);
163 rte_eal_alarm_set(20 * US_PER_MS, test_remove_in_callback, (void *)2);
164 rm_count = rte_eal_alarm_cancel(test_remove_in_callback, (void *)1);
166 printf("Error cancelling head-of-list callback\n");
171 printf("Error, cancelling head-of-list leads to premature callback\n");
175 while (flag != 2 && count++ < RTE_TEST_MAX_REPEAT)
179 printf("Error - expected callback not called\n");
180 rte_eal_alarm_cancel(test_remove_in_callback, (void *)-1);
183 if (recursive_error == 1)
186 /* Check if it can cancel all for the same callback */
187 printf("Testing canceling all for the same callback\n");
189 rte_eal_alarm_set(10 * US_PER_MS, test_remove_in_callback, (void *)1);
190 rte_eal_alarm_set(20 * US_PER_MS, test_remove_in_callback_2, (void *)2);
191 rte_eal_alarm_set(30 * US_PER_MS, test_remove_in_callback_2, (void *)3);
192 rte_eal_alarm_set(40 * US_PER_MS, test_remove_in_callback, (void *)4);
193 rm_count = rte_eal_alarm_cancel(test_remove_in_callback_2, (void *)-1);
195 printf("Error, cannot cancel all for the same callback\n");
198 rm_count = rte_eal_alarm_cancel(test_remove_in_callback, (void *)-1);
200 printf("Error, cannot cancel all for the same callback\n");
212 /* check if the callback will be called */
213 printf("check if the callback will be called\n");
215 if (rte_eal_alarm_set(RTE_TEST_ALARM_TIMEOUT * US_PER_MS,
216 test_alarm_callback, NULL) < 0) {
217 printf("fail to set alarm callback\n");
220 while (flag == 0 && count++ < RTE_TEST_MAX_REPEAT)
221 rte_delay_ms(RTE_TEST_CHECK_PERIOD);
224 printf("Callback not called\n");
228 /* check if it will fail to set alarm with wrong us value */
229 printf("check if it will fail to set alarm with wrong ms values\n");
230 if (rte_eal_alarm_set(0, test_alarm_callback,
232 printf("should not be successful with 0 us value\n");
235 if (rte_eal_alarm_set(UINT64_MAX - 1, test_alarm_callback,
237 printf("should not be successful with (UINT64_MAX-1) us value\n");
241 /* check if it will fail to set alarm with null callback parameter */
242 printf("check if it will fail to set alarm with null callback parameter\n");
243 if (rte_eal_alarm_set(RTE_TEST_ALARM_TIMEOUT, NULL, NULL) >= 0) {
244 printf("should not be successful to set alarm with null callback parameter\n");
248 /* check if it will fail to remove alarm with null callback parameter */
249 printf("check if it will fail to remove alarm with null callback parameter\n");
250 if (rte_eal_alarm_cancel(NULL, NULL) == 0) {
251 printf("should not be successful to remove alarm with null callback parameter");
255 if (test_multi_alarms() != 0)
261 REGISTER_TEST_COMMAND(alarm_autotest, test_alarm);