Merge branch "preempt" in "trunk".
[bertos.git] / bertos / kern / proc_test.c
index 4c2f3126d76feea80fea461fa709c70defb6d97b..5b5bf3ff663f842ac20c121c7a3b5e871c69c581 100644 (file)
+/**
+ * \file
+ * <!--
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
+ * Copyright 2009 Develer S.r.l. (http://www.develer.com/)
+ * -->
+ *
+ *
+ * \brief Test kernel preemption.
+ *
+ * This testcase spawns TASKS parallel threads that runs for TIME seconds. They
+ * continuously spin updating a global counter (one counter for each thread).
+ *
+ * At exit each thread checks if the others have been che chance to update
+ * their own counter. If not, it means the preemption didn't occur and the
+ * testcase returns an error message.
+ *
+ * Otherwise, if all the threads have been able to update their own counter it
+ * means preemption successfully occurs, since there is no active sleep inside
+ * each thread's implementation.
+ *
+ * \author Andrea Righi <arighi@develer.com>
+ *
+ * $test$: cp bertos/cfg/cfg_proc.h $cfgdir/
+ * $test$: echo  "#undef CONFIG_KERN" >> $cfgdir/cfg_proc.h
+ * $test$: echo "#define CONFIG_KERN 1" >> $cfgdir/cfg_proc.h
+ * $test$: echo  "#undef CONFIG_KERN_PRI" >> $cfgdir/cfg_proc.h
+ * $test$: echo "#define CONFIG_KERN_PRI 1" >> $cfgdir/cfg_proc.h
+ * $test$: echo  "#undef CONFIG_KERN_PREEMPT" >> $cfgdir/cfg_proc.h
+ * $test$: echo "#define CONFIG_KERN_PREEMPT 1" >> $cfgdir/cfg_proc.h
+ * $test$: cp bertos/cfg/cfg_monitor.h $cfgdir/
+ * $test$: sed -i "s/CONFIG_KERN_MONITOR 0/CONFIG_KERN_MONITOR 1/" $cfgdir/cfg_monitor.h
+ * $test$: cp bertos/cfg/cfg_signal.h $cfgdir/
+ * $test$: echo  "#undef CONFIG_KERN_SIGNALS" >> $cfgdir/cfg_signal.h
+ * $test$: echo "#define CONFIG_KERN_SIGNALS 1" >> $cfgdir/cfg_signal.h
+ *
+ */
+
+#include <stdio.h> // sprintf
+#include <string.h> // memset
 
 #include <kern/proc.h>
+#include <kern/irq.h>
+#include <kern/monitor.h>
+
 #include <drv/timer.h>
+#include <cfg/test.h>
+#include <cfg/cfg_proc.h>
 
-/**
- * Proc scheduling test subthread 1
- */
-static void NORETURN proc_test_thread1(void)
+enum
+{
+       TEST_OK = 1,
+       TEST_FAIL = 2,
+};
+
+/* Number of tasks to spawn */
+#define TASKS  8
+
+static char name[TASKS][32];
+
+static unsigned int done[TASKS];
+
+#define WORKER_STACK_SIZE KERN_MINSTACKSIZE * 3
+
+/* Base time delay for processes using timer_delay() */
+#define DELAY  5
+
+// Define process stacks for test.
+static cpu_stack_t worker_stack[TASKS][WORKER_STACK_SIZE / sizeof(cpu_stack_t)];
+
+static int prime_numbers[] =
+{
+       1, 3, 5, 7, 11, 13, 17, 19,
+       23, 29, 31, 37, 41, 43, 47, 53,
+};
+
+STATIC_ASSERT(TASKS <= countof(prime_numbers));
+
+static void worker(void)
 {
-       for (;;)
+       long pid = (long)proc_currentUserData();
+       long tot = prime_numbers[pid - 1];
+       unsigned int my_count = 0;
+       int i;
+
+       for (i = 0; i < tot; i++)
        {
-               kputs(">task 1\n");
-               timer_delay(50);
-               proc_switch();
+               my_count++;
+               PROC_ATOMIC(kprintf("> %s[%ld] running\n", __func__, pid));
+               timer_delay(tot * DELAY);
        }
+       done[pid - 1] = 1;
+       PROC_ATOMIC(kprintf("> %s[%ld] completed\n", __func__, pid));
 }
 
-/**
- * Proc scheduling test subthread 2
- */
-static void NORETURN proc_test_thread2(void)
+static int worker_test(void)
 {
-       for (;;)
+       long i;
+
+       // Init the test processes
+       kputs("Run Proc test..\n");
+       for (i = 0; i < TASKS; i++)
        {
-               kputs(">task 2\n");
-               timer_delay(75);
-               proc_switch();
+               sprintf(&name[i][0], "worker_%ld", i + 1);
+               proc_new_with_name(name[i], worker, (iptr_t)(i + 1),
+                               WORKER_STACK_SIZE, &worker_stack[i][0]);
        }
+       kputs("> Main: Processes started\n");
+       while (1)
+       {
+               for (i = 0; i < TASKS; i++)
+               {
+                       if (!done[i])
+                               break;
+               }
+               if (i == TASKS)
+                       break;
+               monitor_report();
+               timer_delay(93);
+       }
+       kputs("> Main: process test finished..ok!\n");
+       return 0;
 }
 
-static cpustack_t proc_test_stack1[CONFIG_PROC_DEFSTACKSIZE / sizeof(cpustack_t)];
-static cpustack_t proc_test_stack2[CONFIG_PROC_DEFSTACKSIZE / sizeof(cpustack_t)];
+#if CONFIG_KERN_PREEMPT
+/* Time to run each preemptible thread (in seconds) */
+#define TIME   10
 
-/**
- * Proc scheduling test
- */
-void NORETURN proc_test(void)
+static char preempt_name[TASKS][32];
+
+static cpu_atomic_t barrier[TASKS];
+static cpu_atomic_t main_barrier;
+
+static unsigned int preempt_counter[TASKS];
+static unsigned int preempt_done[TASKS];
+
+static cpu_stack_t preempt_worker_stack[TASKS][WORKER_STACK_SIZE / sizeof(cpu_stack_t)];
+
+static void preempt_worker(void)
 {
-       proc_new(proc_test_thread1, NULL, sizeof(proc_test_stack1), proc_test_stack1);
-       proc_new(proc_test_thread2, NULL, sizeof(proc_test_stack2), proc_test_stack2);
-       kputs("Created tasks\n");
+       long pid = (long)proc_currentUserData();
+       unsigned int *my_count = &preempt_counter[pid - 1];
+       ticks_t start, stop;
+       int i;
 
-       kputs("stack1:\n");
-//     #warning FIXME
-       kdump(proc_test_stack1+sizeof(proc_test_stack1)-64, 64);
-       kputs("stack2:\n");
-//     #warning FIXME
-       kdump(proc_test_stack2+sizeof(proc_test_stack1)-64, 64);
+       barrier[pid - 1] = 1;
+       /* Synchronize on the main barrier */
+       while (!main_barrier)
+               proc_yield();
+       PROC_ATOMIC(kprintf("> %s[%ld] running\n", __func__, pid));
+       start = timer_clock();
+       stop  = ms_to_ticks(TIME * 1000);
+       while (timer_clock() - start < stop)
+       {
+               IRQ_ASSERT_ENABLED();
+               (*my_count)++;
+               /* be sure to wrap to a value different than 0 */
+               if (UNLIKELY(*my_count == (unsigned int)~0))
+                       *my_count = 1;
+       }
+       PROC_ATOMIC(kprintf("> %s[%ld] completed: (counter = %d)\n",
+                               __func__, pid, *my_count));
+       for (i = 0; i < TASKS; i++)
+               if (!preempt_counter[i])
+               {
+                       preempt_done[pid - 1] = TEST_FAIL;
+                       return;
+               }
+       preempt_done[pid - 1] = TEST_OK;
+}
+
+static int preempt_worker_test(void)
+{
+       unsigned long score = 0;
+       long i;
 
-       for (;;)
+       // Init the test processes
+       kputs("Run Preemption test..\n");
+       for (i = 0; i < TASKS; i++)
        {
-               kputs(">main task\n");
-               timer_delay(93);
-               proc_switch();
+               sprintf(&preempt_name[i][0], "preempt_worker_%ld", i + 1);
+               proc_new_with_name(preempt_name[i], preempt_worker, (iptr_t)(i + 1),
+                               WORKER_STACK_SIZE, &preempt_worker_stack[i][0]);
+       }
+       kputs("> Main: Processes created\n");
+       /* Synchronize on start */
+       while (1)
+       {
+               for (i = 0; i < TASKS; i++)
+                       if (!barrier[i])
+                               break;
+               if (i == TASKS)
+                       break;
+               proc_yield();
+       }
+       /* Now all threads have been created, start them all */
+       main_barrier = 1;
+       MEMORY_BARRIER;
+       kputs("> Main: Processes started\n");
+       while (1)
+       {
+               for (i = 0; i < TASKS; i++)
+               {
+                       if (!preempt_done[i])
+                               break;
+                       else if (preempt_done[i] == TEST_FAIL)
+                       {
+                               kputs("> Main: process test finished..fail!\n");
+                               return -1;
+                       }
+               }
+               if (i == TASKS)
+                       break;
+               monitor_report();
+               timer_delay(1000);
        }
+       for (i = 0; i < TASKS; i++)
+               score += preempt_counter[i];
+       kputs("> Main: process test finished..ok!\n");
+       kprintf("> Score: %lu\n", score);
+       return 0;
+}
+#endif /* CONFIG_KERN_PREEMPT */
+
+#if CONFIG_KERN_SIGNALS & CONFIG_KERN_PRI
 
-       ASSERT(false);
+#define PROC_PRI_TEST_STACK(num)  PROC_DEFINE_STACK(proc_test##num##_stack, KERN_MINSTACKSIZE);
+
+// Define params to test priority
+#define PROC_PRI_TEST(num) static void proc_pri_test##num(void) \
+{ \
+       struct Process *main_proc = (struct Process *) proc_currentUserData(); \
+       kputs("> Process: " #num "\n"); \
+       sig_signal(main_proc, SIG_USER##num); \
 }
+
+// Default priority is 0
+#define PROC_PRI_TEST_INIT(num, proc)                                  \
+do {                                                                   \
+       struct Process *p = proc_new(proc_pri_test##num, (proc),        \
+                                       sizeof(proc_test##num##_stack), \
+                                       proc_test##num##_stack);        \
+       proc_setPri(p, num + 1);                                        \
+} while (0)
+
+PROC_PRI_TEST_STACK(0)
+PROC_PRI_TEST_STACK(1)
+PROC_PRI_TEST_STACK(2)
+
+PROC_PRI_TEST(0)
+PROC_PRI_TEST(1)
+PROC_PRI_TEST(2)
+
+static int prio_worker_test(void)
+{
+       struct Process *curr = proc_current();
+       int orig_pri = curr->link.pri;
+       int ret = 0;
+
+       // test process priority
+       // main process must have the higher priority to check signals received
+       proc_setPri(proc_current(), 10);
+
+       kputs("Run Priority test..\n");
+       // the order in which the processes are created is important!
+       PROC_PRI_TEST_INIT(0, curr);
+       PROC_PRI_TEST_INIT(1, curr);
+       PROC_PRI_TEST_INIT(2, curr);
+
+       // signals must be: USER2, 1, 0 in order
+       sigmask_t signals = sig_wait(SIG_USER0 | SIG_USER1 | SIG_USER2);
+       if (!(signals & SIG_USER2))
+       {
+               ret = -1;
+               goto out;
+       }
+       signals = sig_wait(SIG_USER0 | SIG_USER1 | SIG_USER2);
+       if (!(signals & SIG_USER1))
+       {
+               ret = -1;
+               goto out;
+       }
+       signals = sig_wait(SIG_USER0 | SIG_USER1 | SIG_USER2);
+       if (!(signals & SIG_USER0))
+       {
+               ret = -1;
+               goto out;
+       }
+       // All processes must have quit by now, but just in case...
+       signals = sig_waitTimeout(SIG_USER0 | SIG_USER1 | SIG_USER2, 200);
+       if (signals & (SIG_USER0 | SIG_USER1 | SIG_USER2))
+       {
+               ret = -1;
+               goto out;
+       }
+       if (signals & SIG_TIMEOUT)
+       {
+               kputs("Priority test successfull.\n");
+       }
+out:
+       proc_setPri(proc_current(), orig_pri);
+       if (ret != 0)
+               kputs("Priority test failed.\n");
+       return ret;
+}
+#endif /* CONFIG_KERN_SIGNALS & CONFIG_KERN_PRI */
+
+/**
+ * Process scheduling test
+ */
+int proc_testRun(void)
+{
+#if CONFIG_KERN_PREEMPT
+       // Clear shared data (this is needed when this testcase is embedded in
+       // the demo application).
+       memset(preempt_counter, 0, sizeof(preempt_counter));
+       memset(preempt_done, 0, sizeof(preempt_done));
+       memset(barrier, 0, sizeof(barrier));
+       main_barrier = 0;
+#endif /* CONFIG_KERN_PREEMPT */
+       memset(done, 0, sizeof(done));
+
+       /* Start tests */
+       worker_test();
+#if CONFIG_KERN_PREEMPT
+       preempt_worker_test();
+#endif /* CONFIG_KERN_PREEMPT */
+#if CONFIG_KERN_SIGNALS & CONFIG_KERN_PRI
+       prio_worker_test();
+#endif /* CONFIG_KERN_SIGNALS & CONFIG_KERN_PRI */
+       return 0;
+}
+
+int proc_testSetup(void)
+{
+       kdbg_init();
+
+       kprintf("Init Timer..");
+       timer_init();
+       kprintf("Done.\n");
+
+       kprintf("Init Process..");
+       proc_init();
+       kprintf("Done.\n");
+
+       return 0;
+}
+
+int proc_testTearDown(void)
+{
+       kputs("TearDown Process test.\n");
+       return 0;
+}
+
+TEST_MAIN(proc);