* Removed all Id tags.
[cacao.git] / src / threads / threads-common.h
1 /* src/threads/threads-common.h - machine independent thread functions
2
3    Copyright (C) 2007 R. Grafl, A. Krall, C. Kruegel,
4    C. Oates, R. Obermaisser, M. Platter, M. Probst, S. Ring,
5    E. Steiner, C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich,
6    J. Wenninger, Institut f. Computersprachen - TU Wien
7
8    This file is part of CACAO.
9
10    This program is free software; you can redistribute it and/or
11    modify it under the terms of the GNU General Public License as
12    published by the Free Software Foundation; either version 2, or (at
13    your option) any later version.
14
15    This program is distributed in the hope that it will be useful, but
16    WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18    General Public License for more details.
19
20    You should have received a copy of the GNU General Public License
21    along with this program; if not, write to the Free Software
22    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23    02110-1301, USA.
24
25 */
26
27
28 #ifndef _THREADS_COMMON_H
29 #define _THREADS_COMMON_H
30
31 #include "config.h"
32 #include "vm/types.h"
33
34 #include "vm/global.h"
35
36 #include "native/jni.h"
37
38 #if defined(ENABLE_THREADS)
39 # include "threads/native/threads.h"
40 #else
41 # include "threads/none/threads.h"
42 #endif
43
44 #include "vmcore/utf8.h"
45
46
47 /* only define the following stuff with thread enabled ************************/
48
49 #if defined(ENABLE_THREADS)
50
51 /* thread states **************************************************************/
52
53 #define THREAD_STATE_NEW              0
54 #define THREAD_STATE_RUNNABLE         1
55 #define THREAD_STATE_BLOCKED          2
56 #define THREAD_STATE_WAITING          3
57 #define THREAD_STATE_TIMED_WAITING    4
58 #define THREAD_STATE_TERMINATED       5
59
60
61 /* thread priorities **********************************************************/
62
63 #define MIN_PRIORITY     1
64 #define NORM_PRIORITY    5
65 #define MAX_PRIORITY     10
66
67
68 #if defined(__LINUX__)
69 /* XXX Remove for exact-GC. */
70 extern bool threads_pthreads_implementation_nptl;
71 #endif
72
73
74 /* function prototypes ********************************************************/
75
76 void          threads_preinit(void);
77
78 threadobject *threads_list_first(void);
79 threadobject *threads_list_next(threadobject *t);
80 s4            threads_list_get_non_daemons(void);
81
82 threadobject *threads_thread_new(void);
83 void          threads_thread_free(threadobject *t);
84
85 bool          threads_thread_start_internal(utf *name, functionptr f);
86 void          threads_thread_start(java_lang_Thread *object);
87
88 void          threads_thread_print_info(threadobject *t);
89
90 ptrint        threads_get_current_tid(void);
91
92 void          threads_thread_state_runnable(threadobject *t);
93 void          threads_thread_state_waiting(threadobject *t);
94 void          threads_thread_state_timed_waiting(threadobject *t);
95 void          threads_thread_state_terminated(threadobject *t);
96 utf          *threads_thread_get_state(threadobject *t);
97
98 bool          threads_thread_is_alive(threadobject *thread);
99
100 void          threads_dump(void);
101 void          threads_thread_print_stacktrace(threadobject *thread);
102 void          threads_print_stacktrace(void);
103
104
105 /* implementation specific functions */
106
107 void          threads_impl_preinit(void);
108
109 void          threads_list_lock(void);
110 void          threads_list_unlock(void);
111
112 void          threads_mutex_join_lock(void);
113 void          threads_mutex_join_unlock(void);
114
115 void          threads_set_current_threadobject(threadobject *thread);
116 void          threads_impl_thread_new(threadobject *t);
117 void          threads_impl_thread_free(threadobject *t);
118 void          threads_impl_thread_start(threadobject *thread, functionptr f);
119
120 void          threads_yield(void);
121
122 #endif /* ENABLE_THREADS */
123
124 #endif /* _THREADS_COMMON_H */
125
126
127 /*
128  * These are local overrides for various environment variables in Emacs.
129  * Please do not remove this and leave it at the end of the file, where
130  * Emacs will automagically detect them.
131  * ---------------------------------------------------------------------
132  * Local variables:
133  * mode: c
134  * indent-tabs-mode: t
135  * c-basic-offset: 4
136  * tab-width: 4
137  * End:
138  * vim:noexpandtab:sw=4:ts=4:
139  */