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