* src/threads/thread.cpp: Use a finalizer to remove dead threads.
[cacao.git] / src / threads / threadlist.hpp
1 /* src/threads/threadlist.hpp - different thread-lists
2
3    Copyright (C) 1996-2011
4    CACAOVM - Verein zur Foerderung der freien virtuellen Maschine CACAO
5
6    This file is part of CACAO.
7
8    This program is free software; you can redistribute it and/or
9    modify it under the terms of the GNU General Public License as
10    published by the Free Software Foundation; either version 2, or (at
11    your option) any later version.
12
13    This program is distributed in the hope that it will be useful, but
14    WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16    General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21    02110-1301, USA.
22
23 */
24
25
26 #ifndef _THREADLIST_HPP
27 #define _THREADLIST_HPP
28
29 #include "config.h"
30
31 #include <stdint.h>
32
33 #include "threads/thread.hpp"
34
35 #include "toolbox/list.hpp"
36
37 #include "vm/global.h"
38
39
40 /* ThreadList *****************************************************************/
41
42 #ifdef __cplusplus
43
44 class ThreadList {
45 private:
46         static Mutex               _mutex;              // a mutex for all thread lists
47
48         static List<threadobject*> _active_thread_list; // list of active threads
49         static List<threadobject*> _free_thread_list;   // list of free threads
50         static List<int32_t>       _free_index_list;    // list of free thread indexes
51
52         // Thread counters visible to Java.
53         static int32_t             _number_of_started_java_threads;
54         static int32_t             _number_of_active_java_threads;
55         static int32_t             _peak_of_active_java_threads;
56
57         // Thread counters for internal usage.
58         static int32_t             _number_of_non_daemon_threads;
59
60         static void                 remove_from_active_thread_list(threadobject* t);
61         static void                 add_to_free_thread_list(threadobject* t);
62         static void                 add_to_free_index_list(int32_t index);
63
64 private:
65         // Comparator class.
66         class comparator : public std::binary_function<threadobject*, int32_t, bool> {
67         public:
68                 bool operator() (const threadobject* t, const int32_t index) const
69                 {
70                         return (t->index == index);
71                 }
72         };
73
74 public:
75         static void                 lock()   { _mutex.lock(); }
76         static void                 unlock() { _mutex.unlock(); }
77
78         static void                 add_to_active_thread_list(threadobject* t);
79
80         // Thread management methods.
81         static threadobject*        get_main_thread();
82         static threadobject*        get_free_thread();
83         static int32_t              get_free_thread_index();
84         static threadobject*        get_thread_by_index(int32_t index);
85         static threadobject*        get_thread_from_java_object(java_handle_t* h);
86         static void                 release_thread(threadobject* t, bool needs_deactivate);
87         static void                 deactivate_thread(threadobject *t);
88
89         // Thread listing methods.
90         static void                 get_active_threads(List<threadobject*> &list);
91         static void                 get_active_java_threads(List<threadobject*> &list);
92
93         // Thread counting methods visible to Java.
94         static int32_t              get_number_of_started_java_threads();
95         static int32_t              get_number_of_active_java_threads();
96         static int32_t              get_number_of_daemon_java_threads();
97         static int32_t              get_peak_of_active_java_threads();
98         static void                 reset_peak_of_active_java_threads();
99
100         // Thread counting methods for internal use.
101         static int32_t              get_number_of_active_threads();
102         static int32_t              get_number_of_non_daemon_threads();
103
104         // Debugging methods.
105         static void                 dump_threads();
106 };
107
108 struct ThreadListLocker {
109         ThreadListLocker()  { ThreadList::lock(); }
110         ~ThreadListLocker()  { ThreadList::unlock(); }
111 };
112
113
114 inline void ThreadList::add_to_active_thread_list(threadobject* t)
115 {
116         lock();
117         _active_thread_list.push_back(t);
118         t->is_in_active_list = true;
119
120         // Update counter variables.
121         if ((t->flags & THREAD_FLAG_INTERNAL) == 0) {
122                 _number_of_started_java_threads++;
123                 _number_of_active_java_threads++;
124                 _peak_of_active_java_threads = MAX(_peak_of_active_java_threads, _number_of_active_java_threads);
125         }
126         unlock();
127 }
128
129 inline void ThreadList::remove_from_active_thread_list(threadobject* t)
130 {
131         lock();
132         _active_thread_list.remove(t);
133         t->is_in_active_list = false;
134
135         // Update counter variables.
136         if ((t->flags & THREAD_FLAG_INTERNAL) == 0) {
137                 _number_of_active_java_threads--;
138         }
139         unlock();
140 }
141
142 inline void ThreadList::add_to_free_thread_list(threadobject* t)
143 {
144         lock();
145         _free_thread_list.push_back(t);
146         unlock();
147 }
148
149 inline void ThreadList::add_to_free_index_list(int32_t index)
150 {
151         lock();
152         _free_index_list.push_back(index);
153         unlock();
154 }
155
156 inline threadobject* ThreadList::get_main_thread()
157 {
158         lock();
159         threadobject *r = _active_thread_list.front();
160         unlock();
161         return r;
162 }
163
164 inline int32_t ThreadList::get_number_of_active_threads()
165 {
166         lock();
167         int32_t size = _active_thread_list.size();
168         unlock();
169         return size;
170 }
171
172 inline int32_t ThreadList::get_number_of_started_java_threads()
173 {
174         lock();
175         int32_t num = _number_of_started_java_threads;
176         unlock();
177         return num;
178 }
179
180 inline int32_t ThreadList::get_number_of_active_java_threads()
181 {
182         lock();
183         int32_t num = _number_of_active_java_threads;
184         unlock();
185         return num;
186 }
187
188 inline int32_t ThreadList::get_peak_of_active_java_threads()
189 {
190         lock();
191         int32_t num = _peak_of_active_java_threads;
192         unlock();
193         return num;
194 }
195
196 inline void ThreadList::reset_peak_of_active_java_threads()
197 {
198         lock();
199         _peak_of_active_java_threads = _number_of_active_java_threads;
200         unlock();
201 }
202
203 #else
204
205 typedef struct ThreadList ThreadList;
206
207 void ThreadList_lock();
208 void ThreadList_unlock();
209 void ThreadList_dump_threads();
210 threadobject* ThreadList_get_free_thread();
211 int32_t ThreadList_get_free_thread_index();
212 void ThreadList_add_to_active_thread_list(threadobject* t);
213 threadobject* ThreadList_get_thread_by_index(int32_t index);
214 threadobject* ThreadList_get_main_thread();
215 threadobject* ThreadList_get_thread_from_java_object(java_handle_t* h);
216 int32_t ThreadList_get_number_of_non_daemon_threads();
217
218 #endif
219
220 #endif // _THREADLIST_HPP
221
222
223 /*
224  * These are local overrides for various environment variables in Emacs.
225  * Please do not remove this and leave it at the end of the file, where
226  * Emacs will automagically detect them.
227  * ---------------------------------------------------------------------
228  * Local variables:
229  * mode: c++
230  * indent-tabs-mode: t
231  * c-basic-offset: 4
232  * tab-width: 4
233  * End:
234  * vim:noexpandtab:sw=4:ts=4:
235  */