xref: /dpdk/app/test/test_timer_racecond.c (revision da4eae27)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2015 Akamai Technologies.
3  * All rights reserved.
4  *
5  *   Redistribution and use in source and binary forms, with or without
6  *   modification, are permitted provided that the following conditions
7  *   are met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  *       notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above copyright
12  *       notice, this list of conditions and the following disclaimer in
13  *       the documentation and/or other materials provided with the
14  *       distribution.
15  *     * Neither the name of Intel Corporation nor the names of its
16  *       contributors may be used to endorse or promote products derived
17  *       from this software without specific prior written permission.
18  *
19  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #include "test.h"
33 
34 #include <stdio.h>
35 #include <unistd.h>
36 #include <inttypes.h>
37 #include <rte_cycles.h>
38 #include <rte_timer.h>
39 #include <rte_common.h>
40 #include <rte_lcore.h>
41 #include <rte_random.h>
42 #include <rte_malloc.h>
43 #include <rte_pause.h>
44 
45 #ifdef RTE_EXEC_ENV_LINUX
46 #define usec_delay(us) usleep(us)
47 #else
48 #define usec_delay(us) rte_delay_us(us)
49 #endif
50 
51 #define BILLION (1UL << 30)
52 
53 #define TEST_DURATION_S 4 /* in seconds */
54 #define N_TIMERS    50
55 
56 static struct rte_timer timer[N_TIMERS];
57 static unsigned timer_lcore_id[N_TIMERS];
58 
59 static unsigned master;
60 static volatile unsigned stop_slaves;
61 
62 static int reload_timer(struct rte_timer *tim);
63 
64 int timer_logtype_test;
65 
66 RTE_INIT(test_timer_init_log)
67 {
68 	timer_logtype_test = rte_log_register("test.timer");
69 }
70 
71 static void
72 timer_cb(struct rte_timer *tim, void *arg __rte_unused)
73 {
74 	/* Simulate slow callback function, 100 us. */
75 	rte_delay_us(100);
76 	if (tim == &timer[0])
77 		rte_log(RTE_LOG_DEBUG, timer_logtype_test,
78 			"------------------------------------------------\n");
79 	rte_log(RTE_LOG_DEBUG, timer_logtype_test, "%s: core %u timer %"
80 		PRIuPTR "\n", __func__, rte_lcore_id(), tim - timer);
81 	(void)reload_timer(tim);
82 }
83 
84 RTE_DEFINE_PER_LCORE(unsigned, n_reset_collisions);
85 
86 static int
87 reload_timer(struct rte_timer *tim)
88 {
89 	/* Make timer expire roughly when the TSC hits the next BILLION
90 	 * multiple. Add in timer's index to make them expire in nearly
91 	 * sorted order. This makes all timers somewhat synchronized,
92 	 * firing ~2-3 times per second, assuming 2-3 GHz TSCs.
93 	 */
94 	uint64_t ticks = BILLION - (rte_get_timer_cycles() % BILLION) +
95 	    (tim - timer);
96 	int ret;
97 
98 	ret = rte_timer_reset(tim, ticks, PERIODICAL, master, timer_cb, NULL);
99 	if (ret != 0) {
100 		rte_log(RTE_LOG_DEBUG, timer_logtype_test,
101 			"- core %u failed to reset timer %" PRIuPTR " (OK)\n",
102 			rte_lcore_id(), tim - timer);
103 		RTE_PER_LCORE(n_reset_collisions) += 1;
104 	}
105 	return ret;
106 }
107 
108 static int
109 slave_main_loop(__rte_unused void *arg)
110 {
111 	unsigned lcore_id = rte_lcore_id();
112 	unsigned i;
113 
114 	RTE_PER_LCORE(n_reset_collisions) = 0;
115 
116 	printf("Starting main loop on core %u\n", lcore_id);
117 
118 	while (!stop_slaves) {
119 		/* Wait until the timer manager is running.
120 		 * We know it's running when we see timer[0] NOT pending.
121 		 */
122 		if (rte_timer_pending(&timer[0])) {
123 			rte_pause();
124 			continue;
125 		}
126 
127 		/* Now, go cause some havoc!
128 		 * Reload our timers.
129 		 */
130 		for (i = 0; i < N_TIMERS; i++) {
131 			if (timer_lcore_id[i] == lcore_id)
132 				(void)reload_timer(&timer[i]);
133 		}
134 		usec_delay(100*1000); /* sleep 100 ms */
135 	}
136 
137 	if (RTE_PER_LCORE(n_reset_collisions) != 0) {
138 		printf("- core %u, %u reset collisions (OK)\n",
139 			lcore_id, RTE_PER_LCORE(n_reset_collisions));
140 	}
141 	return 0;
142 }
143 
144 static int
145 test_timer_racecond(void)
146 {
147 	int ret;
148 	uint64_t hz;
149 	uint64_t cur_time;
150 	uint64_t end_time;
151 	int64_t diff = 0;
152 	unsigned lcore_id;
153 	unsigned i;
154 
155 	master = lcore_id = rte_lcore_id();
156 	hz = rte_get_timer_hz();
157 
158 	/* init and start timers */
159 	for (i = 0; i < N_TIMERS; i++) {
160 		rte_timer_init(&timer[i]);
161 		ret = reload_timer(&timer[i]);
162 		TEST_ASSERT(ret == 0, "reload_timer failed");
163 
164 		/* Distribute timers to slaves.
165 		 * Note that we assign timer[0] to the master.
166 		 */
167 		timer_lcore_id[i] = lcore_id;
168 		lcore_id = rte_get_next_lcore(lcore_id, 1, 1);
169 	}
170 
171 	/* calculate the "end of test" time */
172 	cur_time = rte_get_timer_cycles();
173 	end_time = cur_time + (hz * TEST_DURATION_S);
174 
175 	/* start slave cores */
176 	stop_slaves = 0;
177 	printf("Start timer manage race condition test (%u seconds)\n",
178 			TEST_DURATION_S);
179 	rte_eal_mp_remote_launch(slave_main_loop, NULL, SKIP_MASTER);
180 
181 	while (diff >= 0) {
182 		/* run the timers */
183 		rte_timer_manage();
184 
185 		/* wait 100 ms */
186 		usec_delay(100*1000);
187 
188 		cur_time = rte_get_timer_cycles();
189 		diff = end_time - cur_time;
190 	}
191 
192 	/* stop slave cores */
193 	printf("Stopping timer manage race condition test\n");
194 	stop_slaves = 1;
195 	rte_eal_mp_wait_lcore();
196 
197 	/* stop timers */
198 	for (i = 0; i < N_TIMERS; i++) {
199 		ret = rte_timer_stop(&timer[i]);
200 		TEST_ASSERT(ret == 0, "rte_timer_stop failed");
201 	}
202 
203 	return TEST_SUCCESS;
204 }
205 
206 REGISTER_TEST_COMMAND(timer_racecond_autotest, test_timer_racecond);
207