Fix warning for no prototype.
[bertos.git] / bertos / kern / preempt.c
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
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.
10  *
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.
15  *
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
19  *
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.
28  *
29  * Copyright 2008 Bernie Innocenti <bernie@codewiz.org>
30  * -->
31  *
32  * \brief Simple preemptive multitasking scheduler.
33  *
34  * All voluntary and preemptive context switching happens on exit from
35  * a common interrupt (signal) dispatcher.  Preemption on quantum timeout
36  * is regulated by a soft-timer.  Other kinds of preemption could happen
37  * if an interrupt sends a signal to a higher priority process (but this
38  * is still unimplemented).
39  *
40  * In the POSIX implementaiton, context switching is done by the portable
41  * SVR4 swapcontext() facility.
42  *
43  * \version $Id: proc.c 1616 2008-08-10 19:41:26Z bernie $
44  * \author Bernie Innocenti <bernie@codewiz.org>
45  */
46
47 #include <cfg/cfg_kern.h>
48
49 #if CONFIG_KERN_PREEMPT
50
51 #include "proc_p.h"
52 #include "proc.h"
53 #include "idle.h"
54
55 #include <kern/irq.h>
56 #include <kern/monitor.h>
57 #include <cpu/frame.h> // CPU_IDLE
58 #include <cpu/irq.h>   // IRQ_DISABLE()...
59 #include <drv/timer.h>
60 #include <cfg/module.h>
61 #include <cfg/depend.h>    // CONFIG_DEPEND()
62
63 // Check config dependencies
64 CONFIG_DEPEND(CONFIG_KERN_PREEMPT,    CONFIG_KERN_SCHED && CONFIG_TIMER_EVENTS && CONFIG_KERN_IRQ);
65
66 MOD_DEFINE(preempt)
67
68 int preempt_forbid_cnt;
69
70 static Timer preempt_timer;
71
72
73 void proc_schedule(void)
74 {
75         IRQ_DISABLE;
76
77         ASSERT(preempt_forbid_cnt == 0);
78         LIST_ASSERT_VALID(&ProcReadyList);
79         CurrentProcess = (struct Process *)list_remHead(&ProcReadyList);
80         ASSERT2(CurrentProcess, "no idle proc?");
81
82         IRQ_ENABLE;
83
84         TRACEMSG("launching %p:%s", CurrentProcess, proc_currentName());
85 }
86
87 void proc_preempt(UNUSED_ARG(void *, param))
88 {
89         if (!preempt_forbid_cnt)
90         {
91                 IRQ_DISABLE;
92
93                 #if CONFIG_KERN_PRI
94                         Process *rival = (Process *)LIST_HEAD(&ProcReadyList);
95                         if (rival && rival->link.pri >= CurrentProcess->link.pri)
96                         {
97                 #endif
98
99                 TRACEMSG("preempting %p:%s", CurrentProcess, proc_currentName());
100
101 // FIXME: this still breaks havoc, probably because of some reentrancy issue
102 #if 0
103                 SCHED_ENQUEUE(CurrentProcess);
104                 proc_schedule();
105 #endif
106                 #if CONFIG_KERN_PRI
107                         }
108                 #endif
109
110                 IRQ_ENABLE;
111         }
112
113         timer_setDelay(&preempt_timer, CONFIG_KERN_QUANTUM);
114         timer_add(&preempt_timer);
115 }
116
117 void proc_switch(void)
118 {
119         ATOMIC(LIST_ASSERT_VALID(&ProcReadyList));
120         TRACEMSG("%p:%s", CurrentProcess, proc_currentName());
121         ATOMIC(LIST_ASSERT_VALID(&ProcReadyList));
122
123         /* Sleeping with IRQs disabled or preemption forbidden is illegal */
124         IRQ_ASSERT_ENABLED();
125         ASSERT(preempt_forbid_cnt == 0);
126
127         // Will invoke proc_switch() in interrupt context
128         kill(0, SIGUSR1);
129 }
130
131 void proc_yield(void)
132 {
133         TRACEMSG("%p:%s", CurrentProcess, proc_currentName());
134
135         IRQ_DISABLE;
136         SCHED_ENQUEUE(CurrentProcess);
137         IRQ_ENABLE;
138
139         proc_switch();
140 }
141
142 void proc_entry(void (*user_entry)(void))
143 {
144         user_entry();
145         proc_exit();
146 }
147
148 void preempt_init(void)
149 {
150         MOD_CHECK(irq);
151         MOD_CHECK(timer);
152
153         irq_register(SIGUSR1, proc_schedule);
154
155         timer_setSoftint(&preempt_timer, proc_preempt, NULL);
156         timer_setDelay(&preempt_timer, CONFIG_KERN_QUANTUM);
157         timer_add(&preempt_timer);
158
159         idle_init();
160
161         MOD_INIT(preempt);
162 }
163
164 #endif // CONFIG_KERN_PREEMPT