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_kern.h"
  44 #include <cfg/compiler.h>
  45
  46 #include <cpu/types.h>        /* for cpu_stack_t */
  47
  48 #include <struct/list.h>
  49
  50 #if CONFIG_KERN_PREEMPT
  51         #include <ucontext.h> // XXX
  52 #endif
  53
  54 typedef struct Process
  55 {
  56 #if CONFIG_KERN_PRI
  57         PriNode      link;        /**< Link Process into scheduler lists */
  58 #else
  59         Node         link;        /**< Link Process into scheduler lists */
  60 #endif
  61         cpu_stack_t  *stack;       /**< Per-process SP */
  62         iptr_t       user_data;   /**< Custom data passed to the process */
  63
  64 #if CONFIG_KERN_SIGNALS
  65         sigmask_t    sig_wait;    /**< Signals the process is waiting for */
  66         sigmask_t    sig_recv;    /**< Received signals */
  67 #endif
  68
  69 #if CONFIG_KERN_HEAP
  70         uint16_t     flags;       /**< Flags */
  71 #endif
  72
  73 #if CONFIG_KERN_HEAP | CONFIG_KERN_MONITOR | (ARCH & ARCH_EMUL)
  74         cpu_stack_t  *stack_base;  /**< Base of process stack */
  75         size_t       stack_size;  /**< Size of process stack */
  76 #endif
  77
  78 #if CONFIG_KERN_PREEMPT
  79         ucontext_t   context;
  80 #endif
  81
  82 #if CONFIG_KERN_MONITOR
  83         struct ProcMonitor
  84         {
  85                 Node        link;
  86                 const char *name;
  87         } monitor;
  88 #endif
  89
  90 } Process;
  91
  92
  93 /**
  94  * \name Flags for Process.flags.
  95  * \{
  96  */
  97 #define PF_FREESTACK  BV(0)  /**< Free the stack when process dies */
  98 /*\}*/
  99
 100
 101 /** Track running processes. */
 102 extern REGISTER Process *CurrentProcess;
 103
 104 /**
 105  * Track ready processes.
 106  *
 107  * Access to this list must be performed with interrupts disabled
 108  */
 109 extern REGISTER List     ProcReadyList;
 110
 111 #if CONFIG_KERN_PRI
 112         #define SCHED_ENQUEUE_INTERNAL(proc) LIST_ENQUEUE(&ProcReadyList, &(proc)->link)
 113 #else
 114         #define SCHED_ENQUEUE_INTERNAL(proc) ADDTAIL(&ProcReadyList, &(proc)->link)
 115 #endif
 116
 117 /**
 118  * Enqueue a process in the ready list.
 119  *
 120  * Always use this macro to instert a process in the ready list, as its
 121  * might vary to implement a different scheduling algorithms.
 122  *
 123  * \note Access to the scheduler ready list must be performed with
 124  *       interrupts disabled.
 125  */
 126 #define SCHED_ENQUEUE(proc)  do { \
 127                 IRQ_ASSERT_DISABLED(); \
 128                 LIST_ASSERT_VALID(&ProcReadyList); \
 129                 SCHED_ENQUEUE_INTERNAL(proc); \
 130         } while (0)
 131
 132
 133 /// Schedule another process *without* adding the current one to the ready list.
 134 void proc_switch(void);
 135
 136 #if CONFIG_KERN_PREEMPT
 137 void proc_entry(void (*user_entry)(void));
 138 void preempt_init(void);
 139 #endif
 140
 141 #if CONFIG_KERN_MONITOR
 142         /** Initialize the monitor */
 143         void monitor_init(void);
 144
 145         /** Register a process into the monitor */
 146         void monitor_add(Process *proc, const char *name);
 147
 148         /** Unregister a process from the monitor */
 149         void monitor_remove(Process *proc);
 150
 151         /** Rename a process */
 152         void monitor_rename(Process *proc, const char *name);
 153 #endif /* CONFIG_KERN_MONITOR */
 154
 155 #endif /* KERN_PROC_P_H */