4 * This file is part of BeRTOS.
6 * Bertos is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * As a special exception, you may use this file as part of a free software
21 * library without restriction. Specifically, if other files instantiate
22 * templates or use macros or inline functions from this file, or you compile
23 * this file and link it with other files to produce an executable, this
24 * file does not by itself cause the resulting executable to be covered by
25 * the GNU General Public License. This exception does not however
26 * invalidate any other reasons why the executable file might be covered by
27 * the GNU General Public License.
29 * Copyright 2009 Develer S.r.l. (http://www.develer.com/)
33 * \brief Test kernel preemption.
35 * This testcase spawns TASKS parallel threads that runs for TIME seconds. They
36 * continuously spin updating a global counter (one counter for each thread).
38 * At exit each thread checks if the others have been che chance to update
39 * their own counter. If not, it means the preemption didn't occur and the
40 * testcase returns an error message.
42 * Otherwise, if all the threads have been able to update their own counter it
43 * means preemption successfully occurs, since there is no active sleep inside
44 * each thread's implementation.
46 * \author Andrea Righi <arighi@develer.com>
48 * $test$: cp bertos/cfg/cfg_proc.h $cfgdir/
49 * $test$: echo "#undef CONFIG_KERN" >> $cfgdir/cfg_proc.h
50 * $test$: echo "#define CONFIG_KERN 1" >> $cfgdir/cfg_proc.h
51 * $test$: echo "#undef CONFIG_KERN_PRI" >> $cfgdir/cfg_proc.h
52 * $test$: echo "#define CONFIG_KERN_PRI 1" >> $cfgdir/cfg_proc.h
53 * $test$: echo "#undef CONFIG_KERN_PREEMPT" >> $cfgdir/cfg_proc.h
54 * $test$: echo "#define CONFIG_KERN_PREEMPT 1" >> $cfgdir/cfg_proc.h
55 * $test$: cp bertos/cfg/cfg_monitor.h $cfgdir/
56 * $test$: sed -i "s/CONFIG_KERN_MONITOR 0/CONFIG_KERN_MONITOR 1/" $cfgdir/cfg_monitor.h
57 * $test$: cp bertos/cfg/cfg_signal.h $cfgdir/
58 * $test$: echo "#undef CONFIG_KERN_SIGNALS" >> $cfgdir/cfg_signal.h
59 * $test$: echo "#define CONFIG_KERN_SIGNALS 1" >> $cfgdir/cfg_signal.h
63 #include <stdio.h> // sprintf
64 #include <string.h> // memset
66 #include <kern/proc.h>
68 #include <kern/monitor.h>
70 #include <drv/timer.h>
72 #include <cfg/cfg_proc.h>
80 /* Number of tasks to spawn */
83 static char name[TASKS][32];
85 static unsigned int done[TASKS];
87 static cpu_atomic_t barrier[TASKS];
88 static cpu_atomic_t main_barrier;
90 /* Base time delay for processes using timer_delay() */
93 // Define process stacks for test.
94 #define WORKER_STACK_SIZE KERN_MINSTACKSIZE * 2
97 #define WORKER_STACK(id) NULL
98 #else /* !CONFIG_KERN_HEAP */
99 static cpu_stack_t worker_stack[TASKS][(WORKER_STACK_SIZE +
100 sizeof(cpu_stack_t) - 1) / sizeof(cpu_stack_t)];
101 #define WORKER_STACK(id) (&worker_stack[id][0])
102 #endif /* CONFIG_KERN_HEAP */
104 static int prime_numbers[] =
106 1, 3, 5, 7, 11, 13, 17, 19,
107 23, 29, 31, 37, 41, 43, 47, 53,
109 STATIC_ASSERT(TASKS <= countof(prime_numbers));
111 #if CONFIG_KERN_PREEMPT
112 /* Time to run each preemptible thread (in seconds) */
115 static unsigned long preempt_counter[TASKS];
116 static unsigned int preempt_done[TASKS];
119 static void cleanup(void)
121 #if CONFIG_KERN_PREEMPT
122 // Clear shared data (this is needed when this testcase is embedded in
123 // the demo application).
124 memset(preempt_counter, 0, sizeof(preempt_counter));
125 memset(preempt_done, 0, sizeof(preempt_done));
126 #endif /* CONFIG_KERN_PREEMPT */
127 memset(done, 0, sizeof(done));
128 memset(barrier, 0, sizeof(barrier));
132 static void worker(void)
134 ssize_t pid = (ssize_t)proc_currentUserData();
135 long tot = prime_numbers[pid - 1];
136 unsigned int my_count = 0;
139 barrier[pid - 1] = 1;
140 /* Synchronize on the main barrier */
141 while (!main_barrier)
143 for (i = 0; i < tot; i++)
146 PROC_ATOMIC(kprintf("> %s[%zd] running\n", __func__, pid));
147 timer_delay(tot * DELAY);
150 PROC_ATOMIC(kprintf("> %s[%zd] completed\n", __func__, pid));
153 static int worker_test(void)
157 // Init the test processes
159 kputs("Run Proc test..\n");
160 for (i = 0; i < TASKS; i++)
163 snprintf(&name[i][0], sizeof(name[i]), "worker_%zd", i + 1);
164 name[i][sizeof(name[i]) - 1] = '\0';
165 proc_new_with_name(name[i], worker, (iptr_t)(i + 1),
166 WORKER_STACK_SIZE, WORKER_STACK(i));
168 /* Synchronize on start */
171 for (i = 0; i < TASKS; i++)
180 kputs("> Main: Processes started\n");
183 for (i = 0; i < TASKS; i++)
193 kputs("> Main: process test finished..ok!\n");
197 #if CONFIG_KERN_PREEMPT
198 static void preempt_worker(void)
200 ssize_t pid = (ssize_t)proc_currentUserData();
201 unsigned long *my_count = &preempt_counter[pid - 1];
205 barrier[pid - 1] = 1;
206 /* Synchronize on the main barrier */
207 while (!main_barrier)
209 PROC_ATOMIC(kprintf("> %s[%zd] running\n", __func__, pid));
210 start = timer_clock();
211 stop = ms_to_ticks(TIME * 1000);
212 while (timer_clock() - start < stop)
214 IRQ_ASSERT_ENABLED();
216 /* be sure to wrap to a value different than 0 */
217 if (UNLIKELY(*my_count == (unsigned int)~0))
220 PROC_ATOMIC(kprintf("> %s[%zd] completed: (counter = %lu)\n",
221 __func__, pid, *my_count));
222 for (i = 0; i < TASKS; i++)
223 if (!preempt_counter[i])
225 preempt_done[pid - 1] = TEST_FAIL;
228 preempt_done[pid - 1] = TEST_OK;
231 static int preempt_worker_test(void)
233 unsigned long score = 0;
236 // Init the test processes
238 kputs("Run Preemption test..\n");
239 for (i = 0; i < TASKS; i++)
242 snprintf(&name[i][0], sizeof(name[i]),
243 "preempt_worker_%zd", i + 1);
244 name[i][sizeof(name[i]) - 1] = '\0';
245 proc_new_with_name(name[i], preempt_worker, (iptr_t)(i + 1),
246 WORKER_STACK_SIZE, WORKER_STACK(i));
248 kputs("> Main: Processes created\n");
249 /* Synchronize on start */
252 for (i = 0; i < TASKS; i++)
259 /* Now all threads have been created, start them all */
262 kputs("> Main: Processes started\n");
265 for (i = 0; i < TASKS; i++)
267 if (!preempt_done[i])
269 else if (preempt_done[i] == TEST_FAIL)
271 kputs("> Main: process test finished..fail!\n");
280 for (i = 0; i < TASKS; i++)
281 score += preempt_counter[i];
282 kputs("> Main: process test finished..ok!\n");
283 kprintf("> Score: %lu\n", score);
286 #endif /* CONFIG_KERN_PREEMPT */
288 #if CONFIG_KERN_SIGNALS & CONFIG_KERN_PRI
290 // Define params to test priority
291 #define PROC_PRI_TEST(num) static void proc_pri_test##num(void) \
293 struct Process *main_proc = (struct Process *) proc_currentUserData(); \
294 kputs("> Process: " #num "\n"); \
295 sig_signal(main_proc, SIG_USER##num); \
298 // Default priority is 0
299 #define PROC_PRI_TEST_INIT(num, proc) \
301 struct Process *p = proc_new(proc_pri_test##num, (proc), \
303 WORKER_STACK(num)); \
304 proc_setPri(p, num + 1); \
311 static int prio_worker_test(void)
313 struct Process *curr = proc_current();
314 int orig_pri = curr->link.pri;
317 // test process priority
318 // main process must have the higher priority to check signals received
319 proc_setPri(proc_current(), 10);
321 kputs("Run Priority test..\n");
322 // the order in which the processes are created is important!
323 PROC_PRI_TEST_INIT(0, curr);
324 PROC_PRI_TEST_INIT(1, curr);
325 PROC_PRI_TEST_INIT(2, curr);
327 // signals must be: USER2, 1, 0 in order
328 sigmask_t signals = sig_wait(SIG_USER0 | SIG_USER1 | SIG_USER2);
329 if (!(signals & SIG_USER2))
334 signals = sig_wait(SIG_USER0 | SIG_USER1 | SIG_USER2);
335 if (!(signals & SIG_USER1))
340 signals = sig_wait(SIG_USER0 | SIG_USER1 | SIG_USER2);
341 if (!(signals & SIG_USER0))
346 // All processes must have quit by now, but just in case...
347 signals = sig_waitTimeout(SIG_USER0 | SIG_USER1 | SIG_USER2, 200);
348 if (signals & (SIG_USER0 | SIG_USER1 | SIG_USER2))
353 if (signals & SIG_TIMEOUT)
355 kputs("Priority test successfull.\n");
358 proc_setPri(proc_current(), orig_pri);
360 kputs("Priority test failed.\n");
363 #endif /* CONFIG_KERN_SIGNALS & CONFIG_KERN_PRI */
366 * Process scheduling test
368 int proc_testRun(void)
372 #if CONFIG_KERN_PREEMPT
373 preempt_worker_test();
374 #endif /* CONFIG_KERN_PREEMPT */
375 #if CONFIG_KERN_SIGNALS & CONFIG_KERN_PRI
377 #endif /* CONFIG_KERN_SIGNALS & CONFIG_KERN_PRI */
381 int proc_testSetup(void)
385 kprintf("Init Timer..");
389 kprintf("Init Process..");
396 int proc_testTearDown(void)
398 kputs("TearDown Process test.\n");