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  * \defgroup kern_proc Process (Threads) management
  34  * \ingroup kern
  35  * \{
  36  *
  37  * \brief BeRTOS Kernel core (Process scheduler).
  38  *
  39  * This is the core kernel module. It allows you to create new processes
  40  * (which are called \b threads in other systems) and set the priority of
  41  * each process.
  42  *
  43  * A process needs a work area (called \b stack) to run. To create a process,
  44  * you need to declare a stack area, then create the process.
  45  * You may also pass NULL for the stack area, if you have enabled kernel heap:
  46  * in this case the stack will be automatically allocated.
  47  *
  48  * Example:
  49  * \code
  50  * PROC_DEFINE_STACK(stack1, 200);
  51  *
  52  * void NORETURN proc1_run(void)
  53  * {
  54  *    while (1)
  55  *    {
  56  *       LOG_INFO("I'm alive!\n");
  57  *       timer_delay(1000);
  58  *    }
  59  * }
  60  *
  61  *
  62  * int main()
  63  * {
  64  *    Process *p1 = proc_new(proc1_run, NULL, stack1, sizeof(stack1));
  65  *    // here the process is already running
  66  *    proc_setPri(p1, 2);
  67  *    // ...
  68  * }
  69  * \endcode
  70  *
  71  * The Process struct must be regarded as an opaque data type, do not access
  72  * any of its members directly.
  73  *
  74  * The entry point function should be declared as NORETURN, because it will
  75  * remove a warning and enable compiler optimizations.
  76  *
  77  * You can temporarily disable preemption calling proc_forbid(); remember
  78  * to enable it again calling proc_permit().
  79  *
  80  * \note You should hardly need to manually release the CPU; however you
  81  *       can do it using the cpu_relax() function. It is illegal to release
  82  *       the CPU with preemption disabled.
  83  *
  84  * \author Bernie Innocenti <bernie@codewiz.org>
  85  *
  86  * $WIZ$ module_name = "kernel"
  87  * $WIZ$ module_configuration = "bertos/cfg/cfg_proc.h"
  88  * $WIZ$ module_depends = "switch_ctx"
  89  * $WIZ$ module_supports = "not atmega103"
  90  */
  91
  92 #ifndef KERN_PROC_H
  93 #define KERN_PROC_H
  94
  95 #include "sem.h"
  96 #include "cfg/cfg_proc.h"
  97 #include "cfg/cfg_signal.h"
  98 #include "cfg/cfg_monitor.h"
  99
 100 #include <struct/list.h> // Node, PriNode
 101
 102 #include <cfg/compiler.h>
 103 #include <cfg/debug.h> // ASSERT()
 104
 105 #include <cpu/types.h> // cpu_stack_t
 106 #include <cpu/frame.h> // CPU_SAVED_REGS_CNT
 107
 108 /*
 109  * WARNING: struct Process is considered private, so its definition can change any time
 110  * without notice. DO NOT RELY on any field defined here, use only the interface
 111  * functions below.
 112  *
 113  * You have been warned.
 114  */
 115 typedef struct Process
 116 {
 117 #if CONFIG_KERN_PRI
 118         PriNode      link;        /**< Link Process into scheduler lists */
 119 # if CONFIG_KERN_PRI_INHERIT
 120         PriNode      inh_link;    /**< Link Process into priority inheritance lists */
 121         List         inh_list;    /**< Priority inheritance list for this Process */
 122         Semaphore    *inh_blocked_by;  /**< Semaphore blocking this Process */
 123         int          orig_pri;    /**< Process priority without considering inheritance */
 124 # endif
 125 #else
 126         Node         link;        /**< Link Process into scheduler lists */
 127 #endif
 128         cpu_stack_t  *stack;       /**< Per-process SP */
 129         iptr_t       user_data;   /**< Custom data passed to the process */
 130
 131 #if CONFIG_KERN_SIGNALS
 132         Signal       sig;
 133 #endif
 134
 135 #if CONFIG_KERN_HEAP
 136         uint16_t     flags;       /**< Flags */
 137 #endif
 138
 139 #if CONFIG_KERN_HEAP | CONFIG_KERN_MONITOR
 140         cpu_stack_t  *stack_base;  /**< Base of process stack */
 141         size_t       stack_size;  /**< Size of process stack */
 142 #endif
 143
 144         /* The actual process entry point */
 145         void (*user_entry)(void);
 146
 147 #if CONFIG_KERN_MONITOR
 148         struct ProcMonitor
 149         {
 150                 Node        link;
 151                 const char *name;
 152         } monitor;
 153 #endif
 154
 155 } Process;
 156
 157 /**
 158  * Initialize the process subsystem (kernel).
 159  * It must be called before using any process related function.
 160  */
 161 void proc_init(void);
 162
 163 struct Process *proc_new_with_name(const char *name, void (*entry)(void), iptr_t data, size_t stacksize, cpu_stack_t *stack);
 164
 165 #if !CONFIG_KERN_MONITOR
 166         /**
 167          * Create a new named process and schedules it for execution.
 168          *
 169          * When defining the stacksize take into account that you may want at least:
 170          * \li save all the registers for each nested function call;
 171          * \li have memory for the struct Process, which is positioned at the bottom
 172          * of the stack;
 173          * \li have some memory for temporary variables inside called functions.
 174          *
 175          * The value given by KERN_MINSTACKSIZE is rather safe to use in the first place.
 176          *
 177          * \param entry Function that the process will execute.
 178          * \param data Pointer to user data.
 179          * \param size Length of the stack.
 180          * \param stack Pointer to the memory area to be used as a stack.
 181          *
 182          * \return Process structure of new created process
 183          *         if successful, NULL otherwise.
 184          */
 185         #define proc_new(entry,data,size,stack) proc_new_with_name(NULL,(entry),(data),(size),(stack))
 186 #else
 187         #define proc_new(entry,data,size,stack) proc_new_with_name(#entry,(entry),(data),(size),(stack))
 188 #endif
 189
 190 /**
 191  * Terminate the execution of the current process.
 192  */
 193 void proc_exit(void);
 194
 195 /*
 196  * Public scheduling class methods.
 197  */
 198 void proc_yield(void);
 199
 200 #if CONFIG_KERN_PREEMPT
 201 bool proc_needPreempt(void);
 202 void proc_preempt(void);
 203 #else
 204 INLINE bool proc_needPreempt(void)
 205 {
 206         return false;
 207 }
 208
 209 INLINE void proc_preempt(void)
 210 {
 211 }
 212 #endif
 213
 214 void proc_rename(struct Process *proc, const char *name);
 215 const char *proc_name(struct Process *proc);
 216 const char *proc_currentName(void);
 217
 218 /**
 219  * Return a pointer to the user data of the current process.
 220  *
 221  * To obtain user data, just call this function inside the process. Remember to cast
 222  * the returned pointer to the correct type.
 223  * \return Pointer to the user data of the current process.
 224  */
 225 INLINE iptr_t proc_currentUserData(void)
 226 {
 227         extern struct Process *current_process;
 228         return current_process->user_data;
 229 }
 230
 231 int proc_testSetup(void);
 232 int proc_testRun(void);
 233 int proc_testTearDown(void);
 234
 235 /**
 236  * Return the context structure of the currently running process.
 237  *
 238  * The details of the Process structure are private to the scheduler.
 239  * The address returned by this function is an opaque pointer that can
 240  * be passed as an argument to other process-related functions.
 241  */
 242 INLINE struct Process *proc_current(void)
 243 {
 244         extern struct Process *current_process;
 245         return current_process;
 246 }
 247
 248 #if CONFIG_KERN_PRI
 249         void proc_setPri(struct Process *proc, int pri);
 250 #else
 251         INLINE void proc_setPri(UNUSED_ARG(struct Process *,proc), UNUSED_ARG(int, pri))
 252         {
 253         }
 254 #endif
 255
 256 #if CONFIG_KERN_PREEMPT
 257
 258         /**
 259          * Disable preemptive task switching.
 260          *
 261          * The scheduler maintains a global nesting counter.  Task switching is
 262          * effectively re-enabled only when the number of calls to proc_permit()
 263          * matches the number of calls to proc_forbid().
 264          *
 265          * \note Calling functions that could sleep while task switching is disabled
 266          * is dangerous and unsupported.
 267          *
 268          * \note proc_permit() expands inline to 1-2 asm instructions, so it's a
 269          * very efficient locking primitive in simple but performance-critical
 270          * situations.  In all other cases, semaphores offer a more flexible and
 271          * fine-grained locking primitive.
 272          *
 273          * \sa proc_permit()
 274          */
 275         INLINE void proc_forbid(void)
 276         {
 277                 extern cpu_atomic_t preempt_count;
 278                 /*
 279                  * We don't need to protect the counter against other processes.
 280                  * The reason why is a bit subtle.
 281                  *
 282                  * If a process gets here, preempt_forbid_cnt can be either 0,
 283                  * or != 0.  In the latter case, preemption is already disabled
 284                  * and no concurrency issues can occur.
 285                  *
 286                  * In the former case, we could be preempted just after reading the
 287                  * value 0 from memory, and a concurrent process might, in fact,
 288                  * bump the value of preempt_forbid_cnt under our nose!
 289                  *
 290                  * BUT: if this ever happens, then we won't get another chance to
 291                  * run until the other process calls proc_permit() to re-enable
 292                  * preemption.  At this point, the value of preempt_forbid_cnt
 293                  * must be back to 0, and thus what we had originally read from
 294                  * memory happens to be valid.
 295                  *
 296                  * No matter how hard you think about it, and how complicated you
 297                  * make your scenario, the above holds true as long as
 298                  * "preempt_forbid_cnt != 0" means that no task switching is
 299                  * possible.
 300                  */
 301                 ++preempt_count;
 302
 303                 /*
 304                  * Make sure preempt_count is flushed to memory so the preemption
 305                  * softirq will see the correct value from now on.
 306                  */
 307                 MEMORY_BARRIER;
 308         }
 309
 310         /**
 311          * Re-enable preemptive task switching.
 312          *
 313          * \sa proc_forbid()
 314          */
 315         INLINE void proc_permit(void)
 316         {
 317                 extern cpu_atomic_t preempt_count;
 318
 319                 /*
 320                  * This is to ensure any global state changed by the process gets
 321                  * flushed to memory before task switching is re-enabled.
 322                  */
 323                 MEMORY_BARRIER;
 324                 /* No need to protect against interrupts here. */
 325                 ASSERT(preempt_count > 0);
 326                 --preempt_count;
 327                 /*
 328                  * This ensures preempt_count is flushed to memory immediately so the
 329                  * preemption interrupt sees the correct value.
 330                  */
 331                 MEMORY_BARRIER;
 332         }
 333
 334         /**
 335          * \return true if preemptive task switching is allowed.
 336          * \note This accessor is needed because preempt_count
 337          *       must be absoultely private.
 338          */
 339         INLINE bool proc_preemptAllowed(void)
 340         {
 341                 extern cpu_atomic_t preempt_count;
 342                 return (preempt_count == 0);
 343         }
 344 #else /* CONFIG_KERN_PREEMPT */
 345         #define proc_forbid() /* NOP */
 346         #define proc_permit() /* NOP */
 347         #define proc_preemptAllowed() (true)
 348 #endif /* CONFIG_KERN_PREEMPT */
 349
 350 /** Deprecated, use the proc_preemptAllowed() macro. */
 351 #define proc_allowed() proc_preemptAllowed()
 352
 353 /**
 354  * Execute a block of \a CODE atomically with respect to task scheduling.
 355  */
 356 #define PROC_ATOMIC(CODE) \
 357         do { \
 358                 proc_forbid(); \
 359                 CODE; \
 360                 proc_permit(); \
 361         } while(0)
 362
 363 /**
 364  * Default stack size for each thread, in bytes.
 365  *
 366  * The goal here is to allow a minimal task to save all of its
 367  * registers twice, plus push a maximum of 32 variables on the
 368  * stack. We add also struct Process size since we save it into the process'
 369  * stack.
 370  *
 371  * The actual size computed by the default formula greatly depends on what
 372  * options are active and on the architecture.
 373  *
 374  * Note that on most 16bit architectures, interrupts will also
 375  * run on the stack of the currently running process.  Nested
 376  * interrupts will greatly increases the amount of stack space
 377  * required per process.  Use irqmanager to minimize stack
 378  * usage.
 379  */
 380
 381 #if (ARCH & ARCH_EMUL)
 382         /* We need a large stack because system libraries are bloated */
 383         #define KERN_MINSTACKSIZE 65536
 384 #else
 385         #if CONFIG_KERN_PREEMPT
 386                 /*
 387                  * A preemptible kernel needs a larger stack compared to the
 388                  * cooperative case. A task can be interrupted anytime in each
 389                  * node of the call graph, at any level of depth. This may
 390                  * result in a higher stack consumption, to call the ISR, save
 391                  * the current user context and to execute the kernel
 392                  * preemption routines implemented as ISR prologue and
 393                  * epilogue. All these calls are nested into the process stack.
 394                  *
 395                  * So, to reduce the risk of stack overflow/underflow problems
 396                  * add a x2 to the portion stack reserved to the user process.
 397                  */
 398                 #define KERN_MINSTACKSIZE \
 399                         (sizeof(Process) + CPU_SAVED_REGS_CNT * 2 * sizeof(cpu_stack_t) \
 400                         + 32 * sizeof(int) * 2)
 401         #else
 402                 #define KERN_MINSTACKSIZE \
 403                         (sizeof(Process) + CPU_SAVED_REGS_CNT * 2 * sizeof(cpu_stack_t) \
 404                         + 32 * sizeof(int))
 405         #endif /* CONFIG_KERN_PREEMPT */
 406
 407 #endif
 408
 409 #ifndef CONFIG_KERN_MINSTACKSIZE
 410         /* For backward compatibility */
 411         #define CONFIG_KERN_MINSTACKSIZE KERN_MINSTACKSIZE
 412 #else
 413         #warning FIXME: This macro is deprecated, use KERN_MINSTACKSIZE instead
 414 #endif
 415
 416 /**
 417  * Utility macro to allocate a stack of size \a size.
 418  *
 419  * This macro define a static stack for one process and do
 420  * check if given stack size is enough to run process.
 421  * \note If you plan to use kprintf() and similar functions, you will need
 422  * at least KERN_MINSTACKSIZE * 2 bytes.
 423  *
 424  * \param name Variable name for the stack.
 425  * \param size Stack size in bytes. It must be at least KERN_MINSTACKSIZE.
 426  */
 427 #define PROC_DEFINE_STACK(name, size) \
 428         cpu_stack_t name[((size) + sizeof(cpu_stack_t) - 1) / sizeof(cpu_stack_t)]; \
 429         STATIC_ASSERT((size) >= KERN_MINSTACKSIZE);
 430
 431 /* Memory fill codes to help debugging */
 432 #if CONFIG_KERN_MONITOR
 433         #include <cpu/types.h>
 434         #if (SIZEOF_CPUSTACK_T == 1)
 435                 /* 8bit cpu_stack_t */
 436                 #define CONFIG_KERN_STACKFILLCODE  0xA5
 437                 #define CONFIG_KERN_MEMFILLCODE    0xDB
 438         #elif (SIZEOF_CPUSTACK_T == 2)
 439                 /* 16bit cpu_stack_t */
 440                 #define CONFIG_KERN_STACKFILLCODE  0xA5A5
 441                 #define CONFIG_KERN_MEMFILLCODE    0xDBDB
 442         #elif (SIZEOF_CPUSTACK_T == 4)
 443                 /* 32bit cpu_stack_t */
 444                 #define CONFIG_KERN_STACKFILLCODE  0xA5A5A5A5UL
 445                 #define CONFIG_KERN_MEMFILLCODE    0xDBDBDBDBUL
 446         #elif (SIZEOF_CPUSTACK_T == 8)
 447                 /* 64bit cpu_stack_t */
 448                 #define CONFIG_KERN_STACKFILLCODE  0xA5A5A5A5A5A5A5A5ULL
 449                 #define CONFIG_KERN_MEMFILLCODE    0xDBDBDBDBDBDBDBDBULL
 450         #else
 451                 #error No cpu_stack_t size supported!
 452         #endif
 453 #endif
 454 /** \} */ //defgroup kern_proc
 455
 456 #endif /* KERN_PROC_H */