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  * \version $Id$
  37  * \author Bernie Innocenti <bernie@codewiz.org>
  38  */
  39
  40 #ifndef KERN_PROC_P_H
  41 #define KERN_PROC_P_H
  42
  43 #include "cfg/cfg_proc.h"
  44 #include "cfg/cfg_monitor.h"
  45
  46 #include <cfg/compiler.h>
  47
  48 #include <cpu/types.h>        /* for cpu_stack_t */
  49 #include <cpu/irq.h>          // IRQ_ASSERT_DISABLED()
  50
  51 #include <kern/proc.h>   // struct Process
  52 #include <kern/idle.h>        // idle_proc
  53
  54
  55 /**
  56  * \name Flags for Process.flags.
  57  * \{
  58  */
  59 #define PF_FREESTACK  BV(0)  /**< Free the stack when process dies */
  60 /*\}*/
  61
  62
  63 /** Track running processes. */
  64 extern REGISTER Process *current_process;
  65
  66 /**
  67  * Track ready processes.
  68  *
  69  * Access to this list must be performed with interrupts disabled
  70  */
  71 extern REGISTER List     proc_ready_list;
  72
  73 #if CONFIG_KERN_PRI
  74         #define prio_next()     (LIST_EMPTY(&proc_ready_list) ? idle_proc->link.pri : \
  75                                         ((PriNode *)LIST_HEAD(&proc_ready_list))->pri)
  76         #define prio_curr()     (current_process->link.pri)
  77
  78         #define SCHED_ENQUEUE_INTERNAL(proc) \
  79                         LIST_ENQUEUE(&proc_ready_list, &(proc)->link)
  80         #define SCHED_ENQUEUE_HEAD_INTERNAL(proc) \
  81                         LIST_ENQUEUE_HEAD(&proc_ready_list, &(proc)->link)
  82 #else
  83         #define prio_next()     0
  84         #define prio_curr()     0
  85
  86         #define SCHED_ENQUEUE_INTERNAL(proc) ADDTAIL(&proc_ready_list, &(proc)->link)
  87         #define SCHED_ENQUEUE_HEAD_INTERNAL(proc) ADDHEAD(&proc_ready_list, &(proc)->link)
  88 #endif
  89
  90 /**
  91  * Enqueue a process in the ready list.
  92  *
  93  * Always use this macro to instert a process in the ready list, as its
  94  * might vary to implement a different scheduling algorithms.
  95  *
  96  * \note Access to the scheduler ready list must be performed with
  97  *       interrupts disabled.
  98  */
  99 #define SCHED_ENQUEUE(proc)  do { \
 100                 IRQ_ASSERT_DISABLED(); \
 101                 LIST_ASSERT_VALID(&proc_ready_list); \
 102                 SCHED_ENQUEUE_INTERNAL(proc); \
 103         } while (0)
 104
 105 #define SCHED_ENQUEUE_HEAD(proc)  do { \
 106                 IRQ_ASSERT_DISABLED(); \
 107                 LIST_ASSERT_VALID(&proc_ready_list); \
 108                 SCHED_ENQUEUE_HEAD_INTERNAL(proc); \
 109         } while (0)
 110
 111
 112 #if CONFIG_KERN_PRI
 113 /**
 114  * Changes the priority of an already enqueued process.
 115  *
 116  * Searches and removes the process from the ready list, then uses LIST_ENQUEUE(()
 117  * to insert again to fix priority.
 118  *
 119  * No action is performed for processes that aren't in the ready list, eg. in semaphore queues.
 120  *
 121  * \note Performance could be improved with a different implementation of priority list.
 122  */
 123 INLINE void sched_reenqueue(struct Process *proc)
 124 {
 125         IRQ_ASSERT_DISABLED();
 126         LIST_ASSERT_VALID(&proc_ready_list);
 127         Node *n;
 128         PriNode *pos = NULL;
 129         FOREACH_NODE(n, &proc_ready_list)
 130         {
 131                 if (n == &proc->link.link)
 132                 {
 133                         pos = (PriNode *)n;
 134                         break;
 135                 }
 136         }
 137
 138         // only remove and enqueue again if process is already in the ready list
 139         // otherwise leave it alone
 140         if (pos)
 141         {
 142                 REMOVE(&proc->link.link);
 143                 LIST_ENQUEUE(&proc_ready_list, &proc->link);
 144         }
 145 }
 146 #endif //CONFIG_KERN_PRI
 147
 148 /* Process trampoline */
 149 void proc_entry(void);
 150
 151 /* Schedule another process *without* adding the current one to the ready list. */
 152 void proc_switch(void);
 153
 154 /* Initialize a scheduler class. */
 155 void proc_schedInit(void);
 156
 157 #if CONFIG_KERN_MONITOR
 158         /** Initialize the monitor */
 159         void monitor_init(void);
 160
 161         /** Register a process into the monitor */
 162         void monitor_add(Process *proc, const char *name);
 163
 164         /** Unregister a process from the monitor */
 165         void monitor_remove(Process *proc);
 166
 167         /** Rename a process */
 168         void monitor_rename(Process *proc, const char *name);
 169 #endif /* CONFIG_KERN_MONITOR */
 170
 171 #endif /* KERN_PROC_P_H */