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  * Copyright 2009 Andrea Righi <arighi@develer.com>
  31  * -->
  32  *
  33  * \brief Simple preemptive multitasking scheduler.
  34  *
  35  * Preemption is explicitly regulated at the exit of each interrupt service
  36  * routine (ISR). Each task obtains a time quantum as soon as it is scheduled
  37  * on the CPU and its quantum is decremented at each clock tick. The frequency
  38  * of the timer determines the system tick granularity and CONFIG_KERN_QUANTUM
  39  * the time sharing interval.
  40  *
  41  * When the quantum expires the handler proc_needPreempt() checks if the
  42  * preemption is enabled and in this case preempt_schedule() is called, that
  43  * possibly replaces the current running thread with a different one.
  44  *
  45  * The preemption can be disabled or enabled via proc_forbid() and
  46  * proc_permit() primitives. This is implemented using a global atomic counter.
  47  * When the counter is greater than 0 the task cannot be preempted; only when
  48  * the counter reaches 0 the task can be preempted again.
  49  *
  50  * Preemption-disabled sections may be nested. The preemption will be
  51  * re-enabled when the outermost preemption-disabled section completes.
  52  *
  53  * The voluntary preemption still happens via proc_switch() or proc_yield().
  54  * The first one assumes the current process has been already added to a
  55  * private wait queue (e.g., on a semaphore or a signal), while the second one
  56  * takes care of adding the process into the ready queue.
  57  *
  58  * Context switch is done by CPU-dependent support routines. In case of a
  59  * voluntary preemption the context switch routine must take care of
  60  * saving/restoring only the callee-save registers (the voluntary-preemption is
  61  * actually a function call). The kernel-preemption always happens inside a
  62  * signal/interrupt context and it must take care of saving all registers. For
  63  * this, in the entry point of each ISR the caller-save registers must be
  64  * saved. In the ISR exit point, if the context switch must happen, we switch
  65  * to user-context and call the same voluntary context switch routine that take
  66  * care of saving/restoring also the callee-save registers. On resume from the
  67  * switch, the interrupt exit point moves back to interrupt-context, resumes
  68  * the caller-save registers (saved in the ISR entry point) and return from the
  69  * interrupt-context.
  70  *
  71  * \note Thread priority (if enabled by CONFIG_KERN_PRI) defines the order in
  72  * the \p proc_ready_list and the capability to deschedule a running process. A
  73  * low-priority thread can't preempt a high-priority thread.
  74  *
  75  * A high-priority process can preempt a low-priority process immediately (it
  76  * will be descheduled and replaced in the interrupt exit point). Processes
  77  * running at the same priority can be descheduled when they expire the time
  78  * quantum.
  79  *
  80  * \note Sleeping while preemption is disabled fallbacks to a busy-wait sleep.
  81  * Voluntary preemption when preemption is disabled raises a kernel bug.
  82  *
  83  * \author Bernie Innocenti <bernie@codewiz.org>
  84  * \author Andrea Righi <arighi@develer.com>
  85  */
  86
  87 #include "cfg/cfg_proc.h"
  88
  89 #include "proc_p.h"
  90 #include "proc.h"
  91
  92 #include <kern/irq.h>
  93 #include <kern/monitor.h>
  94 #include <cpu/frame.h> // CPU_IDLE
  95 #include <cpu/irq.h>   // IRQ_DISABLE()...
  96 #include <cfg/log.h>
  97 #include <cfg/module.h>
  98 #include <cfg/depend.h>    // CONFIG_DEPEND()
  99
 100 // Check config dependencies
 101 CONFIG_DEPEND(CONFIG_KERN_PREEMPT, CONFIG_KERN);
 102
 103 MOD_DEFINE(preempt)
 104
 105 /* Global preemption nesting counter */
 106 cpu_atomic_t preempt_count;
 107
 108 /*
 109  * The time sharing interval: when a process is scheduled on a CPU it gets an
 110  * amount of CONFIG_KERN_QUANTUM clock ticks. When these ticks expires and
 111  * preemption is enabled a new process is selected to run.
 112  */
 113 int _proc_quantum;
 114
 115 /**
 116  * Define function prototypes exported outside.
 117  *
 118  * Required to silent gcc "no previous prototype" warnings.
 119  */
 120 void preempt_yield(void);
 121 int preempt_needPreempt(void);
 122 void preempt_preempt(void);
 123 void preempt_switch(void);
 124 void preempt_wakeup(Process *proc);
 125 void preempt_init(void);
 126
 127 static void preempt_switchTo(Process *proc)
 128 {
 129         Process *old_process = current_process;
 130
 131         SCHED_ENQUEUE(current_process);
 132         _proc_quantum = CONFIG_KERN_QUANTUM;
 133         current_process = proc;
 134         proc_switchTo(current_process, old_process);
 135 }
 136
 137 /**
 138  * Call the scheduler and eventually replace the current running process.
 139  */
 140 static void preempt_schedule(void)
 141 {
 142         _proc_quantum = CONFIG_KERN_QUANTUM;
 143         proc_schedule();
 144 }
 145
 146 /**
 147  * Check if we need to schedule another task
 148  */
 149 int preempt_needPreempt(void)
 150 {
 151         if (UNLIKELY(current_process == NULL))
 152                 return 0;
 153         if (!proc_preemptAllowed())
 154                 return 0;
 155         if (LIST_EMPTY(&proc_ready_list))
 156                 return 0;
 157         return _proc_quantum ? prio_next() > prio_curr() :
 158                         prio_next() >= prio_curr();
 159 }
 160
 161 /**
 162  * Preempt the current task.
 163  */
 164 void preempt_preempt(void)
 165 {
 166         IRQ_ASSERT_DISABLED();
 167         ASSERT(current_process);
 168
 169         /* Perform the kernel preemption */
 170         LOG_INFO("preempting %p:%s\n", current_process, proc_currentName());
 171         /* We are inside a IRQ context, so ATOMIC is not needed here */
 172         SCHED_ENQUEUE(current_process);
 173         preempt_schedule();
 174 }
 175
 176 /**
 177  * Give the control of the CPU to another process.
 178  *
 179  * \note Assume the current process has been already added to a wait queue.
 180  *
 181  * \warning This should be considered an internal kernel function, even if it
 182  * is allowed, usage from application code is strongly discouraged.
 183  */
 184 void preempt_switch(void)
 185 {
 186         ASSERT(proc_preemptAllowed());
 187
 188         ATOMIC(preempt_schedule());
 189 }
 190
 191 /**
 192  * Immediately wakeup a process, dispatching it to the CPU.
 193  */
 194 void preempt_wakeup(Process *proc)
 195 {
 196         ASSERT(proc_preemptAllowed());
 197         ASSERT(current_process);
 198         IRQ_ASSERT_DISABLED();
 199
 200         if (prio_proc(proc) >= prio_curr())
 201                 preempt_switchTo(proc);
 202         else
 203                 SCHED_ENQUEUE_HEAD(proc);
 204 }
 205
 206 /**
 207  * Voluntarily release the CPU.
 208  */
 209 void preempt_yield(void)
 210 {
 211         Process *proc;
 212
 213         /*
 214          * Voluntary preemption while preemption is disabled is considered
 215          * illegal, as not very useful in practice.
 216          *
 217          * ASSERT if it happens.
 218          */
 219         ASSERT(proc_preemptAllowed());
 220         IRQ_ASSERT_ENABLED();
 221
 222         IRQ_DISABLE;
 223         proc = (struct Process *)list_remHead(&proc_ready_list);
 224         if (proc)
 225                 preempt_switchTo(proc);
 226         IRQ_ENABLE;
 227 }
 228
 229 void preempt_init(void)
 230 {
 231         MOD_INIT(preempt);
 232 }