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