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