4 * This file is part of BeRTOS.
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.
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.
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
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.
29 * Copyright 2001, 2004 Develer S.r.l. (http://www.develer.com/)
30 * Copyright 1999, 2000, 2001, 2008 Bernie Innocenti <bernie@codewiz.org>
33 * \defgroup kern_proc Process (Threads) management
37 * \brief BeRTOS Kernel core (Process scheduler).
39 * This is the core kernel module. It allows you to create new processes
40 * (which are called \b threads in other systems) and set the priority of
43 * A process needs a work area (called \b stack) to run. To create a process,
44 * you need to declare a stack area, then create the process.
45 * You may also pass NULL for the stack area, if you have enabled kernel heap:
46 * in this case the stack will be automatically allocated.
50 * PROC_DEFINE_STACK(stack1, 200);
52 * void NORETURN proc1_run(void)
56 * LOG_INFO("I'm alive!\n");
64 * Process *p1 = proc_new(proc1_run, NULL, stack1, sizeof(stack1));
65 * // here the process is already running
71 * The Process struct must be regarded as an opaque data type, do not access
72 * any of its members directly.
74 * The entry point function should be declared as NORETURN, because it will
75 * remove a warning and enable compiler optimizations.
77 * You can temporarily disable preemption calling proc_forbid(); remember
78 * to enable it again calling proc_permit().
80 * \note You should hardly need to manually release the CPU; however you
81 * can do it using the cpu_relax() function. It is illegal to release
82 * the CPU with preemption disabled.
84 * \author Bernie Innocenti <bernie@codewiz.org>
86 * $WIZ$ module_name = "kernel"
87 * $WIZ$ module_configuration = "bertos/cfg/cfg_proc.h"
88 * $WIZ$ module_depends = "switch_ctx"
89 * $WIZ$ module_supports = "not atmega103"
95 #include "cfg/cfg_proc.h"
96 #include "cfg/cfg_signal.h"
97 #include "cfg/cfg_monitor.h"
100 #include <struct/list.h> // Node, PriNode
102 #include <cfg/compiler.h>
103 #include <cfg/debug.h> // ASSERT()
105 #include <cpu/types.h> // cpu_stack_t
106 #include <cpu/frame.h> // CPU_SAVED_REGS_CNT
108 /* The following silents warnings on nightly tests. We need to regenerate
109 * all the projects before this can be removed.
111 #ifndef CONFIG_KERN_PRI_INHERIT
112 #define CONFIG_KERN_PRI_INHERIT 0
116 * WARNING: struct Process is considered private, so its definition can change any time
117 * without notice. DO NOT RELY on any field defined here, use only the interface
120 * You have been warned.
122 typedef struct Process
125 PriNode link; /**< Link Process into scheduler lists */
126 # if CONFIG_KERN_PRI_INHERIT
127 PriNode inh_link; /**< Link Process into priority inheritance lists */
128 List inh_list; /**< Priority inheritance list for this Process */
129 Semaphore *inh_blocked_by; /**< Semaphore blocking this Process */
130 int orig_pri; /**< Process priority without considering inheritance */
133 Node link; /**< Link Process into scheduler lists */
135 cpu_stack_t *stack; /**< Per-process SP */
136 iptr_t user_data; /**< Custom data passed to the process */
138 #if CONFIG_KERN_SIGNALS
143 uint16_t flags; /**< Flags */
146 #if CONFIG_KERN_HEAP | CONFIG_KERN_MONITOR
147 cpu_stack_t *stack_base; /**< Base of process stack */
148 size_t stack_size; /**< Size of process stack */
151 /* The actual process entry point */
152 void (*user_entry)(void);
154 #if CONFIG_KERN_MONITOR
165 * Initialize the process subsystem (kernel).
166 * It must be called before using any process related function.
168 void proc_init(void);
170 struct Process *proc_new_with_name(const char *name, void (*entry)(void), iptr_t data, size_t stacksize, cpu_stack_t *stack);
172 #if !CONFIG_KERN_MONITOR
174 * Create a new named process and schedules it for execution.
176 * When defining the stacksize take into account that you may want at least:
177 * \li save all the registers for each nested function call;
178 * \li have memory for the struct Process, which is positioned at the bottom
180 * \li have some memory for temporary variables inside called functions.
182 * The value given by KERN_MINSTACKSIZE is rather safe to use in the first place.
184 * \param entry Function that the process will execute.
185 * \param data Pointer to user data.
186 * \param size Length of the stack.
187 * \param stack Pointer to the memory area to be used as a stack.
189 * \return Process structure of new created process
190 * if successful, NULL otherwise.
192 #define proc_new(entry,data,size,stack) proc_new_with_name(NULL,(entry),(data),(size),(stack))
194 #define proc_new(entry,data,size,stack) proc_new_with_name(#entry,(entry),(data),(size),(stack))
198 * Terminate the execution of the current process.
200 void proc_exit(void);
203 * Public scheduling class methods.
205 void proc_yield(void);
207 #if CONFIG_KERN_PREEMPT
208 bool proc_needPreempt(void);
209 void proc_preempt(void);
211 INLINE bool proc_needPreempt(void)
216 INLINE void proc_preempt(void)
221 void proc_rename(struct Process *proc, const char *name);
222 const char *proc_name(struct Process *proc);
223 const char *proc_currentName(void);
226 * Return a pointer to the user data of the current process.
228 * To obtain user data, just call this function inside the process. Remember to cast
229 * the returned pointer to the correct type.
230 * \return Pointer to the user data of the current process.
232 INLINE iptr_t proc_currentUserData(void)
234 extern struct Process *current_process;
235 return current_process->user_data;
238 int proc_testSetup(void);
239 int proc_testRun(void);
240 int proc_testTearDown(void);
243 * Return the context structure of the currently running process.
245 * The details of the Process structure are private to the scheduler.
246 * The address returned by this function is an opaque pointer that can
247 * be passed as an argument to other process-related functions.
249 INLINE struct Process *proc_current(void)
251 extern struct Process *current_process;
252 return current_process;
256 void proc_setPri(struct Process *proc, int pri);
258 INLINE void proc_setPri(UNUSED_ARG(struct Process *,proc), UNUSED_ARG(int, pri))
263 #if CONFIG_KERN_PREEMPT
266 * Disable preemptive task switching.
268 * The scheduler maintains a global nesting counter. Task switching is
269 * effectively re-enabled only when the number of calls to proc_permit()
270 * matches the number of calls to proc_forbid().
272 * \note Calling functions that could sleep while task switching is disabled
273 * is dangerous and unsupported.
275 * \note proc_permit() expands inline to 1-2 asm instructions, so it's a
276 * very efficient locking primitive in simple but performance-critical
277 * situations. In all other cases, semaphores offer a more flexible and
278 * fine-grained locking primitive.
282 INLINE void proc_forbid(void)
284 extern cpu_atomic_t preempt_count;
286 * We don't need to protect the counter against other processes.
287 * The reason why is a bit subtle.
289 * If a process gets here, preempt_forbid_cnt can be either 0,
290 * or != 0. In the latter case, preemption is already disabled
291 * and no concurrency issues can occur.
293 * In the former case, we could be preempted just after reading the
294 * value 0 from memory, and a concurrent process might, in fact,
295 * bump the value of preempt_forbid_cnt under our nose!
297 * BUT: if this ever happens, then we won't get another chance to
298 * run until the other process calls proc_permit() to re-enable
299 * preemption. At this point, the value of preempt_forbid_cnt
300 * must be back to 0, and thus what we had originally read from
301 * memory happens to be valid.
303 * No matter how hard you think about it, and how complicated you
304 * make your scenario, the above holds true as long as
305 * "preempt_forbid_cnt != 0" means that no task switching is
311 * Make sure preempt_count is flushed to memory so the preemption
312 * softirq will see the correct value from now on.
318 * Re-enable preemptive task switching.
322 INLINE void proc_permit(void)
324 extern cpu_atomic_t preempt_count;
327 * This is to ensure any global state changed by the process gets
328 * flushed to memory before task switching is re-enabled.
331 /* No need to protect against interrupts here. */
332 ASSERT(preempt_count > 0);
335 * This ensures preempt_count is flushed to memory immediately so the
336 * preemption interrupt sees the correct value.
342 * \return true if preemptive task switching is allowed.
343 * \note This accessor is needed because preempt_count
344 * must be absoultely private.
346 INLINE bool proc_preemptAllowed(void)
348 extern cpu_atomic_t preempt_count;
349 return (preempt_count == 0);
351 #else /* CONFIG_KERN_PREEMPT */
352 #define proc_forbid() /* NOP */
353 #define proc_permit() /* NOP */
354 #define proc_preemptAllowed() (true)
355 #endif /* CONFIG_KERN_PREEMPT */
357 /** Deprecated, use the proc_preemptAllowed() macro. */
358 #define proc_allowed() proc_preemptAllowed()
361 * Execute a block of \a CODE atomically with respect to task scheduling.
363 #define PROC_ATOMIC(CODE) \
371 * Default stack size for each thread, in bytes.
373 * The goal here is to allow a minimal task to save all of its
374 * registers twice, plus push a maximum of 32 variables on the
375 * stack. We add also struct Process size since we save it into the process'
378 * The actual size computed by the default formula greatly depends on what
379 * options are active and on the architecture.
381 * Note that on most 16bit architectures, interrupts will also
382 * run on the stack of the currently running process. Nested
383 * interrupts will greatly increases the amount of stack space
384 * required per process. Use irqmanager to minimize stack
388 #if (ARCH & ARCH_EMUL)
389 /* We need a large stack because system libraries are bloated */
390 #define KERN_MINSTACKSIZE 65536
392 #if CONFIG_KERN_PREEMPT
394 * A preemptible kernel needs a larger stack compared to the
395 * cooperative case. A task can be interrupted anytime in each
396 * node of the call graph, at any level of depth. This may
397 * result in a higher stack consumption, to call the ISR, save
398 * the current user context and to execute the kernel
399 * preemption routines implemented as ISR prologue and
400 * epilogue. All these calls are nested into the process stack.
402 * So, to reduce the risk of stack overflow/underflow problems
403 * add a x2 to the portion stack reserved to the user process.
405 #define KERN_MINSTACKSIZE \
406 (sizeof(Process) + CPU_SAVED_REGS_CNT * 2 * sizeof(cpu_stack_t) \
407 + 32 * sizeof(int) * 2)
409 #define KERN_MINSTACKSIZE \
410 (sizeof(Process) + CPU_SAVED_REGS_CNT * 2 * sizeof(cpu_stack_t) \
412 #endif /* CONFIG_KERN_PREEMPT */
416 #ifndef CONFIG_KERN_MINSTACKSIZE
417 /* For backward compatibility */
418 #define CONFIG_KERN_MINSTACKSIZE KERN_MINSTACKSIZE
420 #warning FIXME: This macro is deprecated, use KERN_MINSTACKSIZE instead
424 * Utility macro to allocate a stack of size \a size.
426 * This macro define a static stack for one process and do
427 * check if given stack size is enough to run process.
428 * \note If you plan to use kprintf() and similar functions, you will need
429 * at least KERN_MINSTACKSIZE * 2 bytes.
431 * \param name Variable name for the stack.
432 * \param size Stack size in bytes. It must be at least KERN_MINSTACKSIZE.
434 #define PROC_DEFINE_STACK(name, size) \
435 cpu_stack_t name[((size) + sizeof(cpu_stack_t) - 1) / sizeof(cpu_stack_t)]; \
436 STATIC_ASSERT((size) >= KERN_MINSTACKSIZE);
438 /* Memory fill codes to help debugging */
439 #if CONFIG_KERN_MONITOR
440 #include <cpu/types.h>
441 #if (SIZEOF_CPUSTACK_T == 1)
442 /* 8bit cpu_stack_t */
443 #define CONFIG_KERN_STACKFILLCODE 0xA5
444 #define CONFIG_KERN_MEMFILLCODE 0xDB
445 #elif (SIZEOF_CPUSTACK_T == 2)
446 /* 16bit cpu_stack_t */
447 #define CONFIG_KERN_STACKFILLCODE 0xA5A5
448 #define CONFIG_KERN_MEMFILLCODE 0xDBDB
449 #elif (SIZEOF_CPUSTACK_T == 4)
450 /* 32bit cpu_stack_t */
451 #define CONFIG_KERN_STACKFILLCODE 0xA5A5A5A5UL
452 #define CONFIG_KERN_MEMFILLCODE 0xDBDBDBDBUL
453 #elif (SIZEOF_CPUSTACK_T == 8)
454 /* 64bit cpu_stack_t */
455 #define CONFIG_KERN_STACKFILLCODE 0xA5A5A5A5A5A5A5A5ULL
456 #define CONFIG_KERN_MEMFILLCODE 0xDBDBDBDBDBDBDBDBULL
458 #error No cpu_stack_t size supported!
461 /** \} */ //defgroup kern_proc
463 #endif /* KERN_PROC_H */