bertos/kern/proc_p.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 Bernie Innocenti <bernie@codewiz.org>
  31  *
  32  * -->
  33  *
  34  * \brief Internal scheduler structures and definitions for processes.
  35  *
  36  * \author Bernie Innocenti <bernie@codewiz.org>
  37  */
  38
  39 #ifndef KERN_PROC_P_H
  40 #define KERN_PROC_P_H
  41
  42 #include "cfg/cfg_proc.h"
  43 #include "cfg/cfg_monitor.h"
  44
  45 #include <cfg/compiler.h>
  46
  47 #include <cpu/types.h>        /* for cpu_stack_t */
  48 #include <cpu/irq.h>          // IRQ_ASSERT_DISABLED()
  49
  50 #include <kern/proc.h>   // struct Process
  51
  52 #ifndef asm_switch_context
  53 /**
  54  * CPU dependent context switching routines.
  55  *
  56  * Saving and restoring the context on the stack is done by a CPU-dependent
  57  * support routine which usually needs to be written in assembly.
  58  */
  59 EXTERN_C void asm_switch_context(cpu_stack_t **new_sp, cpu_stack_t **save_sp);
  60 #endif
  61
  62 /**
  63  * \name Flags for Process.flags.
  64  * \{
  65  */
  66 #define PF_FREESTACK  BV(0)  /**< Free the stack when process dies */
  67 /*\}*/
  68
  69
  70 /** Track running processes. */
  71 extern REGISTER Process *current_process;
  72
  73 /**
  74  * Track ready processes.
  75  *
  76  * Access to this list must be performed with interrupts disabled
  77  */
  78 extern REGISTER List     proc_ready_list;
  79
  80 #if CONFIG_KERN_PRI
  81         #define prio_next()     (LIST_EMPTY(&proc_ready_list) ? INT_MIN : \
  82                                         ((PriNode *)LIST_HEAD(&proc_ready_list))->pri)
  83         #define prio_proc(proc) (proc->link.pri)
  84         #define prio_curr()     prio_proc(current_process)
  85
  86         #define SCHED_ENQUEUE_INTERNAL(proc) \
  87                         LIST_ENQUEUE(&proc_ready_list, &(proc)->link)
  88         #define SCHED_ENQUEUE_HEAD_INTERNAL(proc) \
  89                         LIST_ENQUEUE_HEAD(&proc_ready_list, &(proc)->link)
  90 #else
  91         #define prio_next()     0
  92         #define prio_proc(proc) 0
  93         #define prio_curr()     0
  94
  95         #define SCHED_ENQUEUE_INTERNAL(proc) ADDTAIL(&proc_ready_list, &(proc)->link)
  96         #define SCHED_ENQUEUE_HEAD_INTERNAL(proc) ADDHEAD(&proc_ready_list, &(proc)->link)
  97 #endif
  98
  99 /**
 100  * Enqueue a process in the ready list.
 101  *
 102  * Always use this macro to instert a process in the ready list, as its
 103  * might vary to implement a different scheduling algorithms.
 104  *
 105  * \note Access to the scheduler ready list must be performed with
 106  *       interrupts disabled.
 107  */
 108 #define SCHED_ENQUEUE(proc)  do { \
 109                 IRQ_ASSERT_DISABLED(); \
 110                 LIST_ASSERT_VALID(&proc_ready_list); \
 111                 SCHED_ENQUEUE_INTERNAL(proc); \
 112         } while (0)
 113
 114 #define SCHED_ENQUEUE_HEAD(proc)  do { \
 115                 IRQ_ASSERT_DISABLED(); \
 116                 LIST_ASSERT_VALID(&proc_ready_list); \
 117                 SCHED_ENQUEUE_HEAD_INTERNAL(proc); \
 118         } while (0)
 119
 120
 121 #if CONFIG_KERN_PRI
 122 /**
 123  * Changes the priority of an already enqueued process.
 124  *
 125  * Searches and removes the process from the ready list, then uses LIST_ENQUEUE(()
 126  * to insert again to fix priority.
 127  *
 128  * No action is performed for processes that aren't in the ready list, eg. in semaphore queues.
 129  *
 130  * \note Performance could be improved with a different implementation of priority list.
 131  */
 132 INLINE void sched_reenqueue(struct Process *proc)
 133 {
 134         IRQ_ASSERT_DISABLED();
 135         LIST_ASSERT_VALID(&proc_ready_list);
 136         Node *n;
 137         PriNode *pos = NULL;
 138         FOREACH_NODE(n, &proc_ready_list)
 139         {
 140                 if (n == &proc->link.link)
 141                 {
 142                         pos = (PriNode *)n;
 143                         break;
 144                 }
 145         }
 146
 147         // only remove and enqueue again if process is already in the ready list
 148         // otherwise leave it alone
 149         if (pos)
 150         {
 151                 REMOVE(&proc->link.link);
 152                 LIST_ENQUEUE(&proc_ready_list, &proc->link);
 153         }
 154 }
 155 #endif //CONFIG_KERN_PRI
 156
 157 /* Process trampoline */
 158 void proc_entry(void);
 159
 160 /* Schedule another process *without* adding the current one to the ready list. */
 161 void proc_switch(void);
 162
 163 /* Immediately schedule a particular process bypassing the scheduler. */
 164 void proc_wakeup(Process *proc);
 165
 166 /* Initialize a scheduler class. */
 167 void proc_schedInit(void);
 168
 169 #if CONFIG_KERN_MONITOR
 170         /** Initialize the monitor */
 171         void monitor_init(void);
 172
 173         /** Register a process into the monitor */
 174         void monitor_add(Process *proc, const char *name);
 175
 176         /** Unregister a process from the monitor */
 177         void monitor_remove(Process *proc);
 178
 179         /** Rename a process */
 180         void monitor_rename(Process *proc, const char *name);
 181 #endif /* CONFIG_KERN_MONITOR */
 182
 183 /*
 184  * Quantum related macros are used in the
 185  * timer module and must be empty when
 186  * kernel is disabled.
 187  */
 188 #if (CONFIG_KERN && CONFIG_KERN_PREEMPT)
 189 INLINE int preempt_quantum(void)
 190 {
 191         extern int _proc_quantum;
 192         return _proc_quantum;
 193 }
 194
 195 INLINE void proc_decQuantum(void)
 196 {
 197         extern int _proc_quantum;
 198         if (_proc_quantum > 0)
 199                 _proc_quantum--;
 200 }
 201
 202 INLINE void preempt_reset_quantum(void)
 203 {
 204         extern int _proc_quantum;
 205         _proc_quantum = CONFIG_KERN_QUANTUM;
 206 }
 207 #else /* !(CONFIG_KERN && CONFIG_KERN_PREEMPT) */
 208 INLINE int preempt_quantum(void)
 209 {
 210         return 0;
 211 }
 212
 213 INLINE void proc_decQuantum(void)
 214 {
 215 }
 216
 217 INLINE void preempt_reset_quantum(void)
 218 {
 219 }
 220 #endif /* (CONFIG_KERN && CONFIG_KERN_PREEMPT) */
 221
 222 #endif /* KERN_PROC_P_H */