37415f3de9d5ab7b7ae0bd047530d8d3f41523fa
[bertos.git] / 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 Bernardo Innocenti <bernie@develer.com>
31  *
32  * -->
33  *
34  * \brief Process scheduler (public interface).
35  *
36  * \version $Id$
37  *
38  * \author Bernardo Innocenti <bernie@develer.com>
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_switch(void);
63 void proc_test(void);
64 struct Process *proc_current(void);
65 iptr_t proc_current_user_data(void);
66 void proc_rename(struct Process *proc, const char* name);
67
68 #if CONFIG_KERN_PREEMPTIVE
69         void proc_forbid(void);
70         void proc_permit(void);
71 #else
72         INLINE void proc_forbid(void) { /* nop */ }
73         INLINE void proc_permit(void) { /* nop */ }
74 #endif
75
76 /**
77  * Execute a block of \a CODE atomically with respect to task scheduling.
78  */
79 #define PROC_ATOMIC(CODE) \
80         do { \
81                 proc_forbid(); \
82                 CODE; \
83                 proc_permit(); \
84         } while(0)
85
86 #endif /* KERN_PROC_H */