25bfbae8bfcf3d9e0475e36e0f4ef632941e16a8
[bertos.git] / kern / proc.h
1 /*!
2  * \file
3  * <!--
4  * Copyright 2001,2004 Develer S.r.l. (http://www.develer.com/)
5  * Copyright 1999,2000,2001 Bernardo Innocenti <bernie@develer.com>
6  * This file is part of DevLib - See devlib/README for information.
7  * -->
8  *
9  * \brief Process scheduler (public interface).
10  *
11  * \version $Id$
12  *
13  * \author Bernardo Innocenti <bernie@develer.com>
14  */
15
16 /*#*
17  *#* $Log$
18  *#* Revision 1.9  2005/04/11 19:10:28  bernie
19  *#* Include top-level headers from cfg/ subdir.
20  *#*
21  *#* Revision 1.8  2004/11/16 22:37:14  bernie
22  *#* Replace IPTR with iptr_t.
23  *#*
24  *#* Revision 1.7  2004/10/19 08:54:55  bernie
25  *#* Define forbid_cnt.
26  *#*
27  *#* Revision 1.6  2004/10/03 20:44:18  bernie
28  *#* Remove stale declarations (moved to monitor.h).
29  *#*
30  *#* Revision 1.2  2004/06/03 11:27:09  bernie
31  *#* Add dual-license information.
32  *#*
33  *#* Revision 1.1  2004/05/23 17:27:00  bernie
34  *#* Import kern/ subdirectory.
35  *#*
36  *#*/
37
38 #ifndef KERN_PROC_H
39 #define KERN_PROC_H
40
41 #include <cfg/compiler.h>
42 #include <cfg/cpu.h>
43 #include <cfg/config_kern.h>
44
45 /* Fwd decl */
46 struct Process;
47
48 /* Task scheduling services */
49 void proc_init(void);
50 struct Process *proc_new_with_name(const char* name, void (*entry)(void), iptr_t data, size_t stacksize, cpustack_t *stack);
51
52 #if !CONFIG_KERN_MONITOR
53         #define proc_new(entry,data,size,stack) proc_new_with_name(NULL,(entry),(data),(size),(stack))
54 #else
55         #define proc_new(entry,data,size,stack) proc_new_with_name(#entry,(entry),(data),(size),(stack))
56 #endif
57
58 void proc_exit(void);
59 void proc_switch(void);
60 void proc_test(void);
61 struct Process* proc_current(void);
62 iptr_t proc_current_user_data(void);
63 void proc_rename(struct Process* proc, const char* name);
64
65 #if CONFIG_KERN_PREEMPTIVE
66         void proc_forbid(void);
67         void proc_permit(void);
68 #else
69         INLINE void proc_forbid(void) { /* nop */ }
70         INLINE void proc_permit(void) { /* nop */ }
71 #endif
72
73 /*!
74  * Execute a block of \a CODE atomically with respect to task scheduling.
75  */
76 #define PROC_ATOMIC(CODE) \
77         do { \
78                 proc_forbid(); \
79                 CODE; \
80                 proc_permit(); \
81         } while(0)
82
83 #endif /* KERN_PROC_H */
84