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 Bernie Innocenti <bernie@codewiz.org>
  31  *
  32  * -->
  33  *
  34  * \brief Process scheduler (public interface).
  35  *
  36  * \version $Id$
  37  *
  38  * \author Bernie Innocenti <bernie@codewiz.org>
  39  */
  40 #ifndef KERN_PROC_H
  41 #define KERN_PROC_H
  42
  43 #include "cfg/cfg_kern.h"
  44 #include <cfg/compiler.h>
  45
  46 #include <cpu/irq.h>
  47
  48 /* Fwd decl */
  49 struct Process;
  50
  51 /* Task scheduling services */
  52 void proc_init(void);
  53 struct Process *proc_new_with_name(const char* name, void (*entry)(void), iptr_t data, size_t stacksize, cpustack_t *stack);
  54
  55 #if !CONFIG_KERN_MONITOR
  56         #define proc_new(entry,data,size,stack) proc_new_with_name(NULL,(entry),(data),(size),(stack))
  57 #else
  58         #define proc_new(entry,data,size,stack) proc_new_with_name(#entry,(entry),(data),(size),(stack))
  59 #endif
  60
  61 void proc_exit(void);
  62 void proc_yield(void);
  63 #define proc_switch proc_yield /* OBSOLETE */
  64
  65 int proc_testSetup(void);
  66 int proc_testRun(void);
  67 int proc_testTearDown(void);
  68
  69 struct Process *proc_current(void);
  70 iptr_t proc_current_user_data(void);
  71 void proc_rename(struct Process *proc, const char* name);
  72
  73 #if CONFIG_KERN_PREEMPTIVE
  74         void proc_forbid(void);
  75         void proc_permit(void);
  76 #else
  77         INLINE void proc_forbid(void) { /* nop */ }
  78         INLINE void proc_permit(void) { /* nop */ }
  79 #endif
  80
  81 /**
  82  * Execute a block of \a CODE atomically with respect to task scheduling.
  83  */
  84 #define PROC_ATOMIC(CODE) \
  85         do { \
  86                 proc_forbid(); \
  87                 CODE; \
  88                 proc_permit(); \
  89         } while(0)
  90
  91 #ifndef CONFIG_PROC_DEFSTACKSIZE
  92
  93         #if (ARCH & ARCH_EMUL)
  94                 /* We need a large stack because system libraries are bloated */
  95                 #define CONFIG_PROC_DEFSTACKSIZE  65536
  96         #else
  97                 /**
  98                  * Default stack size for each thread, in bytes.
  99                  *
 100                  * The goal here is to allow a minimal task to save all of its
 101                  * registers twice, plus push a maximum of 32 variables on the
 102                  * stack.
 103                  *
 104                  * The actual size computed by the default formula is:
 105                  *   AVR:    102
 106                  *   i386:   156
 107                  *   ARM:    164
 108                  *   x86_64: 184
 109                  *
 110                  * Note that on most 16bit architectures, interrupts will also
 111                  * run on the stack of the currently running process.  Nested
 112                  * interrupts will greatly increases the amount of stack space
 113                  * required per process.  Use irqmanager to minimize stack
 114                  * usage.
 115                  */
 116                 #define CONFIG_PROC_DEFSTACKSIZE  \
 117                     (CPU_SAVED_REGS_CNT * 2 * sizeof(cpustack_t) \
 118                     + 32 * sizeof(int))
 119         #endif
 120 #endif
 121
 122 /* Memory fill codes to help debugging */
 123 #if CONFIG_KERN_MONITOR
 124         #include <cpu/types.h>
 125         #if (SIZEOF_CPUSTACK_T == 1)
 126                 /* 8bit cpustack_t */
 127                 #define CONFIG_KERN_STACKFILLCODE  0xA5
 128                 #define CONFIG_KERN_MEMFILLCODE    0xDB
 129         #elif (SIZEOF_CPUSTACK_T == 2)
 130                 /* 16bit cpustack_t */
 131                 #define CONFIG_KERN_STACKFILLCODE  0xA5A5
 132                 #define CONFIG_KERN_MEMFILLCODE    0xDBDB
 133         #elif (SIZEOF_CPUSTACK_T == 4)
 134                 /* 32bit cpustack_t */
 135                 #define CONFIG_KERN_STACKFILLCODE  0xA5A5A5A5UL
 136                 #define CONFIG_KERN_MEMFILLCODE    0xDBDBDBDBUL
 137         #elif (SIZEOF_CPUSTACK_T == 8)
 138                 /* 64bit cpustack_t */
 139                 #define CONFIG_KERN_STACKFILLCODE  0xA5A5A5A5A5A5A5A5ULL
 140                 #define CONFIG_KERN_MEMFILLCODE    0xDBDBDBDBDBDBDBDBULL
 141         #else
 142                 #error No cpustack_t size supported!
 143         #endif
 144 #endif
 145 #endif /* KERN_PROC_H */
 146