bertos/kern/proc.h

   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 2001, 2004 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 1999, 2000, 2001, 2008 Bernie Innocenti <bernie@codewiz.org>
  31  * -->
  32  *
  33  * \brief Bertos Kernel core (Process scheduler).
  34  *
  35  * \version $Id$
  36  * \author Bernie Innocenti <bernie@codewiz.org>
  37  *
  38  * $WIZ$ module_name = "kernel"
  39  * $WIZ$ module_configuration = "bertos/cfg/cfg_proc.h"
  40  * $WIZ$ module_depends = "switch_ctx"
  41  * $WIZ$ module_supports = "not atmega103"
  42  */
  43
  44 #ifndef KERN_PROC_H
  45 #define KERN_PROC_H
  46
  47 #include "cfg/cfg_proc.h"
  48 #include "cfg/cfg_monitor.h"
  49
  50 #include <cfg/compiler.h>
  51
  52 #if CONFIG_KERN_PREEMPT
  53         #include <cfg/debug.h> // ASSERT()
  54 #endif
  55
  56 #include <cpu/types.h> // cpu_stack_t
  57 #include <cpu/frame.h> // CPU_SAVED_REGS_CNT
  58
  59 /*
  60  * Forward declaration. The definition of struct Process is private to the
  61  * scheduler and hidden in proc_p.h.
  62  */
  63 struct Process;
  64
  65 void proc_init(void);
  66 struct Process *proc_new_with_name(const char *name, void (*entry)(void), iptr_t data, size_t stacksize, cpu_stack_t *stack);
  67
  68 #if !CONFIG_KERN_MONITOR
  69         #define proc_new(entry,data,size,stack) proc_new_with_name(NULL,(entry),(data),(size),(stack))
  70 #else
  71         #define proc_new(entry,data,size,stack) proc_new_with_name(#entry,(entry),(data),(size),(stack))
  72 #endif
  73
  74 void proc_exit(void);
  75 void proc_yield(void);
  76 void proc_rename(struct Process *proc, const char *name);
  77 const char *proc_name(struct Process *proc);
  78 const char *proc_currentName(void);
  79 iptr_t proc_currentUserData(void);
  80
  81 int proc_testSetup(void);
  82 int proc_testRun(void);
  83 int proc_testTearDown(void);
  84
  85 /**
  86  * Return the context structure of the currently running process.
  87  *
  88  * The details of the Process structure are private to the scheduler.
  89  * The address returned by this function is an opaque pointer that can
  90  * be passed as an argument to other process-related functions.
  91  */
  92 INLINE struct Process *proc_current(void)
  93 {
  94         extern struct Process *CurrentProcess;
  95         return CurrentProcess;
  96 }
  97
  98 #if CONFIG_KERN_PRI
  99         void proc_setPri(struct Process *proc, int pri);
 100 #else
 101         INLINE void proc_setPri(UNUSED_ARG(struct Process *,proc), UNUSED_ARG(int, pri))
 102         {
 103         }
 104 #endif
 105
 106 /**
 107  * Disable preemptive task switching.
 108  *
 109  * The scheduler maintains a global nesting counter.  Task switching is
 110  * effectively re-enabled only when the number of calls to proc_permit()
 111  * matches the number of calls to proc_forbid().
 112  *
 113  * \note Calling functions that could sleep while task switching is disabled
 114  * is dangerous and unsupported.
 115  *
 116  * \note calling proc_forbid() from within an interrupt is illegal and
 117  * meaningless.
 118  *
 119  * \note proc_permit() expands inline to 1-2 asm instructions, so it's a
 120  * very efficient locking primitive in simple but performance-critical
 121  * situations.  In all other cases, semaphores offer a more flexible and
 122  * fine-grained locking primitive.
 123  *
 124  * \sa proc_permit()
 125  */
 126 INLINE void proc_forbid(void)
 127 {
 128         #if CONFIG_KERN_PREEMPT
 129                 extern cpu_atomic_t _preempt_forbid_cnt;
 130                 /*
 131                  * We don't need to protect the counter against other processes.
 132                  * The reason why is a bit subtle.
 133                  *
 134                  * If a process gets here, preempt_forbid_cnt can be either 0,
 135                  * or != 0.  In the latter case, preemption is already disabled
 136                  * and no concurrency issues can occur.
 137                  *
 138                  * In the former case, we could be preempted just after reading the
 139                  * value 0 from memory, and a concurrent process might, in fact,
 140                  * bump the value of preempt_forbid_cnt under our nose!
 141                  *
 142                  * BUT: if this ever happens, then we won't get another chance to
 143                  * run until the other process calls proc_permit() to re-enable
 144                  * preemption.  At this point, the value of preempt_forbid_cnt
 145                  * must be back to 0, and thus what we had originally read from
 146                  * memory happens to be valid.
 147                  *
 148                  * No matter how hard you think about it, and how complicated you
 149                  * make your scenario, the above holds true as long as
 150                  * "preempt_forbid_cnt != 0" means that no task switching is
 151                  * possible.
 152                  */
 153                 ++_preempt_forbid_cnt;
 154
 155                 /*
 156                  * Make sure _preempt_forbid_cnt is flushed to memory so the
 157                  * preemption softirq will see the correct value from now on.
 158                  */
 159                 MEMORY_BARRIER;
 160         #endif
 161 }
 162
 163 /**
 164  * Re-enable preemptive task switching.
 165  *
 166  * \sa proc_forbid()
 167  */
 168 INLINE void proc_permit(void)
 169 {
 170         #if CONFIG_KERN_PREEMPT
 171
 172                 /*
 173                  * This is to ensure any global state changed by the process gets
 174                  * flushed to memory before task switching is re-enabled.
 175                  */
 176                 MEMORY_BARRIER;
 177                 extern cpu_atomic_t _preempt_forbid_cnt;
 178                 /* No need to protect against interrupts here. */
 179                 ASSERT(_preempt_forbid_cnt != 0);
 180                 --_preempt_forbid_cnt;
 181
 182                 /*
 183                  * This ensures _preempt_forbid_cnt is flushed to memory immediately
 184                  * so the preemption interrupt sees the correct value.
 185                  */
 186                 MEMORY_BARRIER;
 187
 188         #endif
 189 }
 190
 191 /**
 192  * \return true if preemptive task switching is allowed.
 193  * \note This accessor is needed because _preempt_forbid_cnt
 194  *       must be absoultely private.
 195  */
 196 INLINE bool proc_allowed(void)
 197 {
 198         #if CONFIG_KERN_PREEMPT
 199                 extern cpu_atomic_t _preempt_forbid_cnt;
 200                 return (_preempt_forbid_cnt == 0);
 201         #else
 202                 return true;
 203         #endif
 204 }
 205
 206 /**
 207  * Execute a block of \a CODE atomically with respect to task scheduling.
 208  */
 209 #define PROC_ATOMIC(CODE) \
 210         do { \
 211                 proc_forbid(); \
 212                 CODE; \
 213                 proc_permit(); \
 214         } while(0)
 215
 216 #ifndef CONFIG_KERN_MINSTACKSIZE
 217
 218         #if (ARCH & ARCH_EMUL)
 219                 /* We need a large stack because system libraries are bloated */
 220                 #define CONFIG_KERN_MINSTACKSIZE  65536
 221         #else
 222                 /**
 223                  * Default stack size for each thread, in bytes.
 224                  *
 225                  * The goal here is to allow a minimal task to save all of its
 226                  * registers twice, plus push a maximum of 32 variables on the
 227                  * stack.
 228                  *
 229                  * The actual size computed by the default formula is:
 230                  *   AVR:    102
 231                  *   i386:   156
 232                  *   ARM:    164
 233                  *   x86_64: 184
 234                  *
 235                  * Note that on most 16bit architectures, interrupts will also
 236                  * run on the stack of the currently running process.  Nested
 237                  * interrupts will greatly increases the amount of stack space
 238                  * required per process.  Use irqmanager to minimize stack
 239                  * usage.
 240                  */
 241                 #define CONFIG_KERN_MINSTACKSIZE  \
 242                     (CPU_SAVED_REGS_CNT * 2 * sizeof(cpu_stack_t) \
 243                     + 48 * sizeof(int))
 244         #endif
 245 #endif
 246
 247 /* Memory fill codes to help debugging */
 248 #if CONFIG_KERN_MONITOR
 249         #include <cpu/types.h>
 250         #if (SIZEOF_CPUSTACK_T == 1)
 251                 /* 8bit cpu_stack_t */
 252                 #define CONFIG_KERN_STACKFILLCODE  0xA5
 253                 #define CONFIG_KERN_MEMFILLCODE    0xDB
 254         #elif (SIZEOF_CPUSTACK_T == 2)
 255                 /* 16bit cpu_stack_t */
 256                 #define CONFIG_KERN_STACKFILLCODE  0xA5A5
 257                 #define CONFIG_KERN_MEMFILLCODE    0xDBDB
 258         #elif (SIZEOF_CPUSTACK_T == 4)
 259                 /* 32bit cpu_stack_t */
 260                 #define CONFIG_KERN_STACKFILLCODE  0xA5A5A5A5UL
 261                 #define CONFIG_KERN_MEMFILLCODE    0xDBDBDBDBUL
 262         #elif (SIZEOF_CPUSTACK_T == 8)
 263                 /* 64bit cpu_stack_t */
 264                 #define CONFIG_KERN_STACKFILLCODE  0xA5A5A5A5A5A5A5A5ULL
 265                 #define CONFIG_KERN_MEMFILLCODE    0xDBDBDBDBDBDBDBDBULL
 266         #else
 267                 #error No cpu_stack_t size supported!
 268         #endif
 269 #endif
 270
 271 #endif /* KERN_PROC_H */