proc_switch(): rename from proc_schedule(). Split out the real cooperative scheduler.
[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
54 #include <kern/irq.h>
55 #include <kern/monitor.h>
56 #include <cpu/frame.h> // CPU_IDLE
57 #include <cpu/irq.h>   // IRQ_DISABLE()...
58 #include <drv/timer.h>
59 #include <cfg/module.h>
60 #include <cfg/depend.h>    // CONFIG_DEPEND()
61
62 // Check config dependencies
63 CONFIG_DEPEND(CONFIG_KERN_PREEMPT,    CONFIG_KERN_SCHED && CONFIG_TIMER_EVENTS && CONFIG_KERN_IRQ);
64
65 MOD_DEFINE(preempt)
66
67 int preempt_forbid_cnt;
68
69 static Timer preempt_timer;
70
71
72 // fwd decl from idle.c
73 void idle_init(void);
74
75
76 void proc_schedule(void)
77 {
78         IRQ_DISABLE;
79
80         ASSERT(preempt_forbid_cnt == 0);
81         LIST_ASSERT_VALID(&ProcReadyList);
82         CurrentProcess = (struct Process *)list_remHead(&ProcReadyList);
83         ASSERT2(CurrentProcess, "no idle proc?");
84
85         IRQ_ENABLE;
86
87         TRACEMSG("launching %p:%s", CurrentProcess, proc_currentName());
88 }
89
90 void proc_preempt(UNUSED_ARG(void *, param)
91 {
92         if (!preempt_forbid_cnt)
93         {
94                 IRQ_DISABLE;
95
96                 #if CONFIG_KERN_PRI
97                         Process *rival = (Process *)LIST_HEAD(&ProcReadyList);
98                         if (rival && rival->link.pri >= CurrentProcess->link.pri)
99                         {
100                 #endif
101
102                 TRACEMSG("preempting %p:%s", CurrentProcess, proc_currentName());
103
104 // FIXME: this still break havocs, probably because of some reentrancy issue
105 #if 0
106                 SCHED_ENQUEUE(CurrentProcess);
107                 proc_schedule();
108 #endif
109                 #if CONFIG_KERN_PRI
110                         }
111                 #endif
112
113                 IRQ_ENABLE;
114         }
115
116         timer_setDelay(&preempt_timer, CONFIG_KERN_QUANTUM);
117         timer_add(&preempt_timer);
118 }
119
120 void proc_switch(void)
121 {
122         ATOMIC(LIST_ASSERT_VALID(&ProcReadyList));
123         TRACEMSG("%p:%s", CurrentProcess, proc_currentName());
124         ATOMIC(LIST_ASSERT_VALID(&ProcReadyList));
125
126         /* Sleeping with IRQs disabled or preemption forbidden is illegal */
127         IRQ_ASSERT_ENABLED();
128         ASSERT(preempt_forbid_cnt == 0);
129
130         // Will invoke proc_preempt() in interrupt context
131         kill(0, SIGUSR1);
132 }
133
134 void proc_yield(void)
135 {
136         TRACEMSG("%p:%s", CurrentProcess, proc_currentName());
137
138         IRQ_DISABLE;
139         SCHED_ENQUEUE(CurrentProcess);
140         IRQ_ENABLE;
141
142         proc_switch();
143 }
144
145 void proc_entry(void (*user_entry)(void))
146 {
147         user_entry();
148         proc_exit();
149 }
150
151 void preempt_init(void)
152 {
153         MOD_CHECK(irq);
154         MOD_CHECK(timer);
155
156         irq_register(SIGUSR1, proc_preempt);
157
158         timer_setSoftint(&preempt_timer, proc_preempt_timer, NULL);
159         timer_setDelay(&preempt_timer, CONFIG_KERN_QUANTUM);
160         timer_add(&preempt_timer);
161
162         idle_init();
163
164         MOD_INIT(preempt);
165 }
166
167 #endif // CONFIG_KERN_PREEMPT