4be0b25eb8821a5361a7526a4ed2f3c6cc77fc41
[bertos.git] / 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"
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 #endif
58
59 #include <cpu/types.h> // cpu_stack_t
60 #include <cpu/frame.h> // CPU_SAVED_REGS_CNT
61
62 /*
63  * WARNING: struct Process is considered private, so its definition can change any time
64  * without notice. DO NOT RELY on any field defined here, use only the interface
65  * functions below.
66  *
67  * You have been warned.
68  */
69 typedef struct Process
70 {
71 #if CONFIG_KERN_PRI
72         PriNode      link;        /**< Link Process into scheduler lists */
73 #else
74         Node         link;        /**< Link Process into scheduler lists */
75 #endif
76         cpu_stack_t  *stack;       /**< Per-process SP */
77         iptr_t       user_data;   /**< Custom data passed to the process */
78
79 #if CONFIG_KERN_SIGNALS
80         sigmask_t    sig_wait;    /**< Signals the process is waiting for */
81         sigmask_t    sig_recv;    /**< Received signals */
82 #endif
83
84 #if CONFIG_KERN_HEAP
85         uint16_t     flags;       /**< Flags */
86 #endif
87
88 #if CONFIG_KERN_HEAP | CONFIG_KERN_MONITOR | (ARCH & ARCH_EMUL)
89         cpu_stack_t  *stack_base;  /**< Base of process stack */
90         size_t       stack_size;  /**< Size of process stack */
91 #endif
92
93 #if CONFIG_KERN_PREEMPT
94         ucontext_t   context;
95 #endif
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  * Co-operative context switch.
147  *
148  * The process that calls this function will release the CPU before its cpu quantum
149  * expires, the scheduler will run to select the next process that will take control
150  * of the processor.
151  * \note This function is available only if CONFIG_KERN is enabled
152  * \sa cpu_relax(), which is the recommended method to release the cpu.
153  */
154 void proc_yield(void);
155
156 void proc_rename(struct Process *proc, const char *name);
157 const char *proc_name(struct Process *proc);
158 const char *proc_currentName(void);
159
160 /**
161  * Return a pointer to the user data of the current process.
162  *
163  * To obtain user data, just call this function inside the process. Remember to cast
164  * the returned pointer to the correct type.
165  * \return Pointer to the user data of the current process.
166  */
167 iptr_t proc_currentUserData(void);
168
169 int proc_testSetup(void);
170 int proc_testRun(void);
171 int proc_testTearDown(void);
172
173 /**
174  * Return the context structure of the currently running process.
175  *
176  * The details of the Process structure are private to the scheduler.
177  * The address returned by this function is an opaque pointer that can
178  * be passed as an argument to other process-related functions.
179  */
180 INLINE struct Process *proc_current(void)
181 {
182         extern struct Process *CurrentProcess;
183         return CurrentProcess;
184 }
185
186 #if CONFIG_KERN_PRI
187         void proc_setPri(struct Process *proc, int pri);
188 #else
189         INLINE void proc_setPri(UNUSED_ARG(struct Process *,proc), UNUSED_ARG(int, pri))
190         {
191         }
192 #endif
193
194 /**
195  * Disable preemptive task switching.
196  *
197  * The scheduler maintains a global nesting counter.  Task switching is
198  * effectively re-enabled only when the number of calls to proc_permit()
199  * matches the number of calls to proc_forbid().
200  *
201  * \note Calling functions that could sleep while task switching is disabled
202  * is dangerous and unsupported.
203  *
204  * \note calling proc_forbid() from within an interrupt is illegal and
205  * meaningless.
206  *
207  * \note proc_permit() expands inline to 1-2 asm instructions, so it's a
208  * very efficient locking primitive in simple but performance-critical
209  * situations.  In all other cases, semaphores offer a more flexible and
210  * fine-grained locking primitive.
211  *
212  * \sa proc_permit()
213  */
214 INLINE void proc_forbid(void)
215 {
216         #if CONFIG_KERN_PREEMPT
217                 extern cpu_atomic_t _preempt_forbid_cnt;
218                 /*
219                  * We don't need to protect the counter against other processes.
220                  * The reason why is a bit subtle.
221                  *
222                  * If a process gets here, preempt_forbid_cnt can be either 0,
223                  * or != 0.  In the latter case, preemption is already disabled
224                  * and no concurrency issues can occur.
225                  *
226                  * In the former case, we could be preempted just after reading the
227                  * value 0 from memory, and a concurrent process might, in fact,
228                  * bump the value of preempt_forbid_cnt under our nose!
229                  *
230                  * BUT: if this ever happens, then we won't get another chance to
231                  * run until the other process calls proc_permit() to re-enable
232                  * preemption.  At this point, the value of preempt_forbid_cnt
233                  * must be back to 0, and thus what we had originally read from
234                  * memory happens to be valid.
235                  *
236                  * No matter how hard you think about it, and how complicated you
237                  * make your scenario, the above holds true as long as
238                  * "preempt_forbid_cnt != 0" means that no task switching is
239                  * possible.
240                  */
241                 ++_preempt_forbid_cnt;
242
243                 /*
244                  * Make sure _preempt_forbid_cnt is flushed to memory so the
245                  * preemption softirq will see the correct value from now on.
246                  */
247                 MEMORY_BARRIER;
248         #endif
249 }
250
251 /**
252  * Re-enable preemptive task switching.
253  *
254  * \sa proc_forbid()
255  */
256 INLINE void proc_permit(void)
257 {
258         #if CONFIG_KERN_PREEMPT
259
260                 /*
261                  * This is to ensure any global state changed by the process gets
262                  * flushed to memory before task switching is re-enabled.
263                  */
264                 MEMORY_BARRIER;
265                 extern cpu_atomic_t _preempt_forbid_cnt;
266                 /* No need to protect against interrupts here. */
267                 ASSERT(_preempt_forbid_cnt != 0);
268                 --_preempt_forbid_cnt;
269
270                 /*
271                  * This ensures _preempt_forbid_cnt is flushed to memory immediately
272                  * so the preemption interrupt sees the correct value.
273                  */
274                 MEMORY_BARRIER;
275
276         #endif
277 }
278
279 /**
280  * \return true if preemptive task switching is allowed.
281  * \note This accessor is needed because _preempt_forbid_cnt
282  *       must be absoultely private.
283  */
284 INLINE bool proc_allowed(void)
285 {
286         #if CONFIG_KERN_PREEMPT
287                 extern cpu_atomic_t _preempt_forbid_cnt;
288                 return (_preempt_forbid_cnt == 0);
289         #else
290                 return true;
291         #endif
292 }
293
294 /**
295  * Execute a block of \a CODE atomically with respect to task scheduling.
296  */
297 #define PROC_ATOMIC(CODE) \
298         do { \
299                 proc_forbid(); \
300                 CODE; \
301                 proc_permit(); \
302         } while(0)
303
304 /**
305  * Default stack size for each thread, in bytes.
306  *
307  * The goal here is to allow a minimal task to save all of its
308  * registers twice, plus push a maximum of 32 variables on the
309  * stack. We add also struct Process size since we save it into the process'
310  * stack.
311  *
312  * The actual size computed by the default formula greatly depends on what
313  * options are active and on the architecture.
314  *
315  * Note that on most 16bit architectures, interrupts will also
316  * run on the stack of the currently running process.  Nested
317  * interrupts will greatly increases the amount of stack space
318  * required per process.  Use irqmanager to minimize stack
319  * usage.
320  */
321
322 #if (ARCH & ARCH_EMUL)
323         /* We need a large stack because system libraries are bloated */
324         #define KERN_MINSTACKSIZE 65536
325 #else
326         #define KERN_MINSTACKSIZE \
327                 (sizeof(Process) + CPU_SAVED_REGS_CNT * 2 * sizeof(cpu_stack_t) \
328                 + 32 * sizeof(int))
329 #endif
330
331 #ifndef CONFIG_KERN_MINSTACKSIZE
332         /* For backward compatibility */
333         #define CONFIG_KERN_MINSTACKSIZE KERN_MINSTACKSIZE
334 #else
335         #warning FIXME: This macro is deprecated, use KERN_MINSTACKSIZE instead
336 #endif
337
338 /**
339  * Utility macro to allocate a stack of size \a size.
340  *
341  * This macro define a static stack for one process and do
342  * check if given stack size is enough to run process.
343  * \note If you plan to use kprintf() and similar functions, you will need
344  * at least KERN_MINSTACKSIZE * 2 bytes.
345  *
346  * \param name Variable name for the stack.
347  * \param size Stack size in bytes. It must be at least KERN_MINSTACKSIZE.
348  */
349 #define PROC_DEFINE_STACK(name, size) \
350         STATIC_ASSERT((size) >= KERN_MINSTACKSIZE); \
351         cpu_stack_t name[(size) / sizeof(cpu_stack_t)];
352
353 /* Memory fill codes to help debugging */
354 #if CONFIG_KERN_MONITOR
355         #include <cpu/types.h>
356         #if (SIZEOF_CPUSTACK_T == 1)
357                 /* 8bit cpu_stack_t */
358                 #define CONFIG_KERN_STACKFILLCODE  0xA5
359                 #define CONFIG_KERN_MEMFILLCODE    0xDB
360         #elif (SIZEOF_CPUSTACK_T == 2)
361                 /* 16bit cpu_stack_t */
362                 #define CONFIG_KERN_STACKFILLCODE  0xA5A5
363                 #define CONFIG_KERN_MEMFILLCODE    0xDBDB
364         #elif (SIZEOF_CPUSTACK_T == 4)
365                 /* 32bit cpu_stack_t */
366                 #define CONFIG_KERN_STACKFILLCODE  0xA5A5A5A5UL
367                 #define CONFIG_KERN_MEMFILLCODE    0xDBDBDBDBUL
368         #elif (SIZEOF_CPUSTACK_T == 8)
369                 /* 64bit cpu_stack_t */
370                 #define CONFIG_KERN_STACKFILLCODE  0xA5A5A5A5A5A5A5A5ULL
371                 #define CONFIG_KERN_MEMFILLCODE    0xDBDBDBDBDBDBDBDBULL
372         #else
373                 #error No cpu_stack_t size supported!
374         #endif
375 #endif
376
377 #endif /* KERN_PROC_H */