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", "coop"
  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 /**
  66  * Initialize the process subsystem (kernel).
  67  * It must be called before using any process related function.
  68  */
  69 void proc_init(void);
  70
  71 /**
  72  * Create a new named process and schedules it for execution.
  73  *
  74  * \note The function
  75  * \code
  76  * proc_new(entry, data, stacksize, stack)
  77  * \endcode
  78  * is a more convenient way to create a process, as you don't have to specify
  79  * the name.
  80  *
  81  * \param name Name of the process (currently unused).
  82  * \param entry Function that the process will execute.
  83  * \param data Pointer to user data.
  84  * \param stacksize Length of the stack.
  85  * \param stack Pointer to the memory area to be used as a stack.
  86  */
  87 struct Process *proc_new_with_name(const char *name, void (*entry)(void), iptr_t data, size_t stacksize, cpu_stack_t *stack);
  88
  89 #if !CONFIG_KERN_MONITOR
  90         #define proc_new(entry,data,size,stack) proc_new_with_name(NULL,(entry),(data),(size),(stack))
  91 #else
  92         #define proc_new(entry,data,size,stack) proc_new_with_name(#entry,(entry),(data),(size),(stack))
  93 #endif
  94
  95 /**
  96  * Terminate the execution of the current process.
  97  */
  98 void proc_exit(void);
  99
 100 /**
 101  * Co-operative context switch.
 102  *
 103  * The process that calls this function will release the CPU before its cpu quantum
 104  * expires, the scheduler will run to select the next process that will take control
 105  * of the processor.
 106  * \note This function is available only if CONFIG_KERN is enabled
 107  * \sa cpu_relax(), which is the recommended method to release the cpu.
 108  */
 109 void proc_yield(void);
 110
 111 void proc_rename(struct Process *proc, const char *name);
 112 const char *proc_name(struct Process *proc);
 113 const char *proc_currentName(void);
 114
 115 /**
 116  * Return a pointer to the user data of the current process.
 117  *
 118  * To obtain user data, just call this function inside the process. Remember to cast
 119  * the returned pointer to the correct type.
 120  * \return Pointer to the user data of the current process.
 121  */
 122 iptr_t proc_currentUserData(void);
 123
 124 int proc_testSetup(void);
 125 int proc_testRun(void);
 126 int proc_testTearDown(void);
 127
 128 /**
 129  * Return the context structure of the currently running process.
 130  *
 131  * The details of the Process structure are private to the scheduler.
 132  * The address returned by this function is an opaque pointer that can
 133  * be passed as an argument to other process-related functions.
 134  */
 135 INLINE struct Process *proc_current(void)
 136 {
 137         extern struct Process *CurrentProcess;
 138         return CurrentProcess;
 139 }
 140
 141 #if CONFIG_KERN_PRI
 142         void proc_setPri(struct Process *proc, int pri);
 143 #else
 144         INLINE void proc_setPri(UNUSED_ARG(struct Process *,proc), UNUSED_ARG(int, pri))
 145         {
 146         }
 147 #endif
 148
 149 /**
 150  * Disable preemptive task switching.
 151  *
 152  * The scheduler maintains a global nesting counter.  Task switching is
 153  * effectively re-enabled only when the number of calls to proc_permit()
 154  * matches the number of calls to proc_forbid().
 155  *
 156  * \note Calling functions that could sleep while task switching is disabled
 157  * is dangerous and unsupported.
 158  *
 159  * \note calling proc_forbid() from within an interrupt is illegal and
 160  * meaningless.
 161  *
 162  * \note proc_permit() expands inline to 1-2 asm instructions, so it's a
 163  * very efficient locking primitive in simple but performance-critical
 164  * situations.  In all other cases, semaphores offer a more flexible and
 165  * fine-grained locking primitive.
 166  *
 167  * \sa proc_permit()
 168  */
 169 INLINE void proc_forbid(void)
 170 {
 171         #if CONFIG_KERN_PREEMPT
 172                 extern cpu_atomic_t _preempt_forbid_cnt;
 173                 /*
 174                  * We don't need to protect the counter against other processes.
 175                  * The reason why is a bit subtle.
 176                  *
 177                  * If a process gets here, preempt_forbid_cnt can be either 0,
 178                  * or != 0.  In the latter case, preemption is already disabled
 179                  * and no concurrency issues can occur.
 180                  *
 181                  * In the former case, we could be preempted just after reading the
 182                  * value 0 from memory, and a concurrent process might, in fact,
 183                  * bump the value of preempt_forbid_cnt under our nose!
 184                  *
 185                  * BUT: if this ever happens, then we won't get another chance to
 186                  * run until the other process calls proc_permit() to re-enable
 187                  * preemption.  At this point, the value of preempt_forbid_cnt
 188                  * must be back to 0, and thus what we had originally read from
 189                  * memory happens to be valid.
 190                  *
 191                  * No matter how hard you think about it, and how complicated you
 192                  * make your scenario, the above holds true as long as
 193                  * "preempt_forbid_cnt != 0" means that no task switching is
 194                  * possible.
 195                  */
 196                 ++_preempt_forbid_cnt;
 197
 198                 /*
 199                  * Make sure _preempt_forbid_cnt is flushed to memory so the
 200                  * preemption softirq will see the correct value from now on.
 201                  */
 202                 MEMORY_BARRIER;
 203         #endif
 204 }
 205
 206 /**
 207  * Re-enable preemptive task switching.
 208  *
 209  * \sa proc_forbid()
 210  */
 211 INLINE void proc_permit(void)
 212 {
 213         #if CONFIG_KERN_PREEMPT
 214
 215                 /*
 216                  * This is to ensure any global state changed by the process gets
 217                  * flushed to memory before task switching is re-enabled.
 218                  */
 219                 MEMORY_BARRIER;
 220                 extern cpu_atomic_t _preempt_forbid_cnt;
 221                 /* No need to protect against interrupts here. */
 222                 ASSERT(_preempt_forbid_cnt != 0);
 223                 --_preempt_forbid_cnt;
 224
 225                 /*
 226                  * This ensures _preempt_forbid_cnt is flushed to memory immediately
 227                  * so the preemption interrupt sees the correct value.
 228                  */
 229                 MEMORY_BARRIER;
 230
 231         #endif
 232 }
 233
 234 /**
 235  * \return true if preemptive task switching is allowed.
 236  * \note This accessor is needed because _preempt_forbid_cnt
 237  *       must be absoultely private.
 238  */
 239 INLINE bool proc_allowed(void)
 240 {
 241         #if CONFIG_KERN_PREEMPT
 242                 extern cpu_atomic_t _preempt_forbid_cnt;
 243                 return (_preempt_forbid_cnt == 0);
 244         #else
 245                 return true;
 246         #endif
 247 }
 248
 249 /**
 250  * Execute a block of \a CODE atomically with respect to task scheduling.
 251  */
 252 #define PROC_ATOMIC(CODE) \
 253         do { \
 254                 proc_forbid(); \
 255                 CODE; \
 256                 proc_permit(); \
 257         } while(0)
 258
 259 #ifndef CONFIG_KERN_MINSTACKSIZE
 260
 261         #if (ARCH & ARCH_EMUL)
 262                 /* We need a large stack because system libraries are bloated */
 263                 #define CONFIG_KERN_MINSTACKSIZE  65536
 264         #else
 265                 /**
 266                  * Default stack size for each thread, in bytes.
 267                  *
 268                  * The goal here is to allow a minimal task to save all of its
 269                  * registers twice, plus push a maximum of 32 variables on the
 270                  * stack.
 271                  *
 272                  * The actual size computed by the default formula is:
 273                  *  \li AVR:    102
 274                  *  \li i386:   156
 275                  *  \li ARM:    164
 276                  *  \li x86_64: 184
 277                  *
 278                  * Note that on most 16bit architectures, interrupts will also
 279                  * run on the stack of the currently running process.  Nested
 280                  * interrupts will greatly increases the amount of stack space
 281                  * required per process.  Use irqmanager to minimize stack
 282                  * usage.
 283                  */
 284                 #define CONFIG_KERN_MINSTACKSIZE  \
 285                     (CPU_SAVED_REGS_CNT * 2 * sizeof(cpu_stack_t) \
 286                     + 48 * sizeof(int))
 287         #endif
 288 #endif
 289
 290 /* Memory fill codes to help debugging */
 291 #if CONFIG_KERN_MONITOR
 292         #include <cpu/types.h>
 293         #if (SIZEOF_CPUSTACK_T == 1)
 294                 /* 8bit cpu_stack_t */
 295                 #define CONFIG_KERN_STACKFILLCODE  0xA5
 296                 #define CONFIG_KERN_MEMFILLCODE    0xDB
 297         #elif (SIZEOF_CPUSTACK_T == 2)
 298                 /* 16bit cpu_stack_t */
 299                 #define CONFIG_KERN_STACKFILLCODE  0xA5A5
 300                 #define CONFIG_KERN_MEMFILLCODE    0xDBDB
 301         #elif (SIZEOF_CPUSTACK_T == 4)
 302                 /* 32bit cpu_stack_t */
 303                 #define CONFIG_KERN_STACKFILLCODE  0xA5A5A5A5UL
 304                 #define CONFIG_KERN_MEMFILLCODE    0xDBDBDBDBUL
 305         #elif (SIZEOF_CPUSTACK_T == 8)
 306                 /* 64bit cpu_stack_t */
 307                 #define CONFIG_KERN_STACKFILLCODE  0xA5A5A5A5A5A5A5A5ULL
 308                 #define CONFIG_KERN_MEMFILLCODE    0xDBDBDBDBDBDBDBDBULL
 309         #else
 310                 #error No cpu_stack_t size supported!
 311         #endif
 312 #endif
 313
 314 #endif /* KERN_PROC_H */