386594e0cbd0edc8de1669df813f9212516d4f1b
[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 README.devlib 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.11  2006/02/21 16:06:55  bernie
19  *#* Cleanup/update process scheduling.
20  *#*
21  *#* Revision 1.10  2005/11/04 16:20:02  bernie
22  *#* Fix reference to README.devlib in header.
23  *#*
24  *#* Revision 1.9  2005/04/11 19:10:28  bernie
25  *#* Include top-level headers from cfg/ subdir.
26  *#*
27  *#* Revision 1.8  2004/11/16 22:37:14  bernie
28  *#* Replace IPTR with iptr_t.
29  *#*
30  *#* Revision 1.7  2004/10/19 08:54:55  bernie
31  *#* Define forbid_cnt.
32  *#*
33  *#* Revision 1.6  2004/10/03 20:44:18  bernie
34  *#* Remove stale declarations (moved to monitor.h).
35  *#*
36  *#* Revision 1.2  2004/06/03 11:27:09  bernie
37  *#* Add dual-license information.
38  *#*
39  *#* Revision 1.1  2004/05/23 17:27:00  bernie
40  *#* Import kern/ subdirectory.
41  *#*
42  *#*/
43
44 #ifndef KERN_PROC_H
45 #define KERN_PROC_H
46
47 #include <cfg/compiler.h>
48 #include <cfg/cpu.h>
49 #include <config_kern.h>
50
51 /* Fwd decl */
52 struct Process;
53
54 /* Task scheduling services */
55 void proc_init(void);
56 struct Process *proc_new_with_name(const char* name, void (*entry)(void), iptr_t data, size_t stacksize, cpustack_t *stack);
57
58 #if !CONFIG_KERN_MONITOR
59         #define proc_new(entry,data,size,stack) proc_new_with_name(NULL,(entry),(data),(size),(stack))
60 #else
61         #define proc_new(entry,data,size,stack) proc_new_with_name(#entry,(entry),(data),(size),(stack))
62 #endif
63
64 void proc_exit(void);
65 void proc_switch(void);
66 void proc_test(void);
67 struct Process* proc_current(void);
68 iptr_t proc_current_user_data(void);
69 void proc_rename(struct Process* proc, const char* name);
70
71 #if CONFIG_KERN_PREEMPTIVE
72         void proc_forbid(void);
73         void proc_permit(void);
74 #else
75         INLINE void proc_forbid(void) { /* nop */ }
76         INLINE void proc_permit(void) { /* nop */ }
77 #endif
78
79 /*!
80  * Execute a block of \a CODE atomically with respect to task scheduling.
81  */
82 #define PROC_ATOMIC(CODE) \
83         do { \
84                 proc_forbid(); \
85                 CODE; \
86                 proc_permit(); \
87         } while(0)
88
89 #endif /* KERN_PROC_H */
90