2 * threads.c: Thread handles
5 * Dick Porter (dick@ximian.com)
7 * (C) 2002 Ximian, Inc.
12 #include <mono/os/gc_wrapper.h>
13 #include "mono/utils/mono-hash.h"
22 #include <mono/io-layer/wapi.h>
23 #include <mono/io-layer/wapi-private.h>
24 #include <mono/io-layer/timed-thread.h>
25 #include <mono/io-layer/handles-private.h>
26 #include <mono/io-layer/misc-private.h>
27 #include <mono/io-layer/mono-mutex.h>
28 #include <mono/io-layer/thread-private.h>
29 #include <mono/io-layer/mono-spinlock.h>
33 #undef TLS_PTHREAD_MUTEX
36 /* Hash threads with tids. I thought of using TLS for this, but that
37 * would have to set the data in the new thread, which is more hassle
39 static mono_once_t thread_hash_once = MONO_ONCE_INIT;
40 static mono_mutex_t thread_hash_mutex = MONO_MUTEX_INITIALIZER;
41 static GHashTable *thread_hash=NULL;
44 static MonoGHashTable *tls_gc_hash = NULL;
47 static void thread_close_private (gpointer handle);
48 static void thread_own (gpointer handle);
50 struct _WapiHandleOps _wapi_thread_ops = {
51 NULL, /* close_shared */
52 thread_close_private, /* close_private */
58 static mono_once_t thread_ops_once=MONO_ONCE_INIT;
60 static void thread_ops_init (void)
62 _wapi_handle_register_capabilities (WAPI_HANDLE_THREAD,
63 WAPI_HANDLE_CAP_WAIT);
66 static void thread_close_private (gpointer handle)
68 struct _WapiHandlePrivate_thread *thread_handle;
71 ok=_wapi_lookup_handle (handle, WAPI_HANDLE_THREAD, NULL,
72 (gpointer *)&thread_handle);
74 g_warning (G_GNUC_PRETTY_FUNCTION
75 ": error looking up thread handle %p", handle);
80 g_message(G_GNUC_PRETTY_FUNCTION
81 ": closing thread handle %p with thread %p id %ld",
82 handle, thread_handle->thread,
83 thread_handle->thread->id);
86 if(thread_handle->thread!=NULL) {
87 _wapi_timed_thread_destroy (thread_handle->thread);
91 static void thread_own (gpointer handle)
93 struct _WapiHandle_thread *thread_handle;
94 struct _WapiHandlePrivate_thread *thread_private_handle;
97 ok=_wapi_lookup_handle (handle, WAPI_HANDLE_THREAD,
98 (gpointer *)&thread_handle,
99 (gpointer *)&thread_private_handle);
101 g_warning (G_GNUC_PRETTY_FUNCTION
102 ": error looking up thread handle %p", handle);
106 if(thread_private_handle->joined==FALSE) {
107 _wapi_timed_thread_join (thread_private_handle->thread, NULL,
109 thread_private_handle->joined=TRUE;
113 static void thread_exit(guint32 exitstatus, gpointer handle)
115 struct _WapiHandle_thread *thread_handle;
116 struct _WapiHandlePrivate_thread *thread_private_handle;
119 ok=_wapi_lookup_handle (handle, WAPI_HANDLE_THREAD,
120 (gpointer *)&thread_handle,
121 (gpointer *)&thread_private_handle);
123 g_warning (G_GNUC_PRETTY_FUNCTION
124 ": error looking up thread handle %p", handle);
128 _wapi_handle_lock_handle (handle);
131 g_message (G_GNUC_PRETTY_FUNCTION
132 ": Recording thread handle %p exit status", handle);
135 thread_handle->exitstatus=exitstatus;
136 thread_handle->state=THREAD_STATE_EXITED;
137 _wapi_handle_set_signal_state (handle, TRUE, TRUE);
139 _wapi_handle_unlock_handle (handle);
142 g_message(G_GNUC_PRETTY_FUNCTION
143 ": Recording thread handle %p id %ld status as %d",
144 handle, thread_private_handle->thread->id, exitstatus);
147 /* Remove this thread from the hash */
148 mono_mutex_lock(&thread_hash_mutex);
149 g_hash_table_remove(thread_hash, &thread_private_handle->thread->id);
150 mono_mutex_unlock(&thread_hash_mutex);
152 /* The thread is no longer active, so unref it */
153 _wapi_handle_unref (handle);
156 static void thread_hash_init(void)
158 thread_hash=g_hash_table_new(g_int_hash, g_int_equal);
163 * @security: Ignored for now.
164 * @stacksize: the size in bytes of the new thread's stack. Use 0 to
165 * default to the normal stack size. (Ignored for now).
166 * @start: The function that the new thread should start with
167 * @param: The parameter to give to @start.
168 * @create: If 0, the new thread is ready to run immediately. If
169 * %CREATE_SUSPENDED, the new thread will be in the suspended state,
170 * requiring a ResumeThread() call to continue running.
171 * @tid: If non-NULL, the ID of the new thread is stored here.
173 * Creates a new threading handle.
175 * Return value: a new handle, or NULL
177 gpointer CreateThread(WapiSecurityAttributes *security G_GNUC_UNUSED, guint32 stacksize G_GNUC_UNUSED,
178 WapiThreadStart start, gpointer param, guint32 create,
181 struct _WapiHandle_thread *thread_handle;
182 struct _WapiHandlePrivate_thread *thread_private_handle;
187 mono_once(&thread_hash_once, thread_hash_init);
188 mono_once (&thread_ops_once, thread_ops_init);
194 handle=_wapi_handle_new (WAPI_HANDLE_THREAD);
195 if(handle==_WAPI_HANDLE_INVALID) {
196 g_warning (G_GNUC_PRETTY_FUNCTION
197 ": error creating thread handle");
201 _wapi_handle_lock_handle (handle);
203 ok=_wapi_lookup_handle (handle, WAPI_HANDLE_THREAD,
204 (gpointer *)&thread_handle,
205 (gpointer *)&thread_private_handle);
207 g_warning (G_GNUC_PRETTY_FUNCTION
208 ": error looking up thread handle %p", handle);
209 _wapi_handle_unlock_handle (handle);
213 /* Hold a reference while the thread is active, because we use
214 * the handle to store thread exit information
216 _wapi_handle_ref (handle);
218 thread_handle->state=THREAD_STATE_START;
220 /* Lock around the thread create, so that the new thread cant
221 * race us to look up the thread handle in GetCurrentThread()
223 mono_mutex_lock(&thread_hash_mutex);
225 ret=_wapi_timed_thread_create(&thread_private_handle->thread, NULL,
226 create, start, thread_exit, param,
230 g_message(G_GNUC_PRETTY_FUNCTION ": Thread create error: %s",
233 mono_mutex_unlock(&thread_hash_mutex);
234 _wapi_handle_unlock_handle (handle);
235 _wapi_handle_unref (handle);
237 /* And again, because of the reference we took above */
238 _wapi_handle_unref (handle);
242 g_hash_table_insert(thread_hash, &thread_private_handle->thread->id,
244 mono_mutex_unlock(&thread_hash_mutex);
247 g_message(G_GNUC_PRETTY_FUNCTION
248 ": Started thread handle %p thread %p ID %ld", handle,
249 thread_private_handle->thread,
250 thread_private_handle->thread->id);
254 #ifdef PTHREAD_POINTER_ID
255 *tid=GPOINTER_TO_UINT(thread_private_handle->thread->id);
257 *tid=thread_private_handle->thread->id;
261 _wapi_handle_unlock_handle (handle);
266 gpointer OpenThread (guint32 access G_GNUC_UNUSED, gboolean inherit G_GNUC_UNUSED, guint32 tid)
270 mono_once(&thread_hash_once, thread_hash_init);
271 mono_once (&thread_ops_once, thread_ops_init);
274 g_message (G_GNUC_PRETTY_FUNCTION ": looking up thread %d", tid);
277 mono_mutex_lock(&thread_hash_mutex);
279 ret=g_hash_table_lookup(thread_hash, &tid);
280 mono_mutex_unlock(&thread_hash_mutex);
283 _wapi_handle_ref (ret);
287 g_message (G_GNUC_PRETTY_FUNCTION ": returning thread handle %p", ret);
295 * @exitcode: Sets the thread's exit code, which can be read from
296 * another thread with GetExitCodeThread().
298 * Terminates the calling thread. A thread can also exit by returning
299 * from its start function. When the last thread in a process
300 * terminates, the process itself terminates.
302 void ExitThread(guint32 exitcode)
304 _wapi_timed_thread_exit(exitcode);
309 * @handle: The thread handle to query
310 * @exitcode: The thread @handle exit code is stored here
312 * Finds the exit code of @handle, and stores it in @exitcode. If the
313 * thread @handle is still running, the value stored is %STILL_ACTIVE.
315 * Return value: %TRUE, or %FALSE on error.
317 gboolean GetExitCodeThread(gpointer handle, guint32 *exitcode)
319 struct _WapiHandle_thread *thread_handle;
320 struct _WapiHandlePrivate_thread *thread_private_handle;
323 ok=_wapi_lookup_handle (handle, WAPI_HANDLE_THREAD,
324 (gpointer *)&thread_handle,
325 (gpointer *)&thread_private_handle);
327 g_warning (G_GNUC_PRETTY_FUNCTION
328 ": error looking up thread handle %p", handle);
333 g_message(G_GNUC_PRETTY_FUNCTION
334 ": Finding exit status for thread handle %p id %ld", handle,
335 thread_private_handle->thread->id);
340 g_message(G_GNUC_PRETTY_FUNCTION
341 ": Nowhere to store exit code");
346 if(thread_handle->state!=THREAD_STATE_EXITED) {
348 g_message(G_GNUC_PRETTY_FUNCTION
349 ": Thread still active (state %d, exited is %d)",
350 thread_handle->state, THREAD_STATE_EXITED);
352 *exitcode=STILL_ACTIVE;
356 *exitcode=thread_handle->exitstatus;
362 * GetCurrentThreadId:
364 * Looks up the thread ID of the current thread. This ID can be
365 * passed to OpenThread() to create a new handle on this thread.
367 * Return value: the thread ID.
369 guint32 GetCurrentThreadId(void)
371 pthread_t tid=pthread_self();
373 #ifdef PTHREAD_POINTER_ID
374 return(GPOINTER_TO_UINT(tid));
380 static gpointer thread_attach(guint32 *tid)
382 struct _WapiHandle_thread *thread_handle;
383 struct _WapiHandlePrivate_thread *thread_private_handle;
388 mono_once(&thread_hash_once, thread_hash_init);
389 mono_once (&thread_ops_once, thread_ops_init);
391 handle=_wapi_handle_new (WAPI_HANDLE_THREAD);
392 if(handle==_WAPI_HANDLE_INVALID) {
393 g_warning (G_GNUC_PRETTY_FUNCTION
394 ": error creating thread handle");
398 _wapi_handle_lock_handle (handle);
400 ok=_wapi_lookup_handle (handle, WAPI_HANDLE_THREAD,
401 (gpointer *)&thread_handle,
402 (gpointer *)&thread_private_handle);
404 g_warning (G_GNUC_PRETTY_FUNCTION
405 ": error looking up thread handle %p", handle);
406 _wapi_handle_unlock_handle (handle);
410 /* Hold a reference while the thread is active, because we use
411 * the handle to store thread exit information
413 _wapi_handle_ref (handle);
415 thread_handle->state=THREAD_STATE_START;
417 /* Lock around the thread create, so that the new thread cant
418 * race us to look up the thread handle in GetCurrentThread()
420 mono_mutex_lock(&thread_hash_mutex);
422 ret=_wapi_timed_thread_attach(&thread_private_handle->thread,
423 thread_exit, handle);
426 g_message(G_GNUC_PRETTY_FUNCTION ": Thread attach error: %s",
429 mono_mutex_unlock(&thread_hash_mutex);
430 _wapi_handle_unlock_handle (handle);
431 _wapi_handle_unref (handle);
433 /* And again, because of the reference we took above */
434 _wapi_handle_unref (handle);
438 g_hash_table_insert(thread_hash, &thread_private_handle->thread->id,
440 mono_mutex_unlock(&thread_hash_mutex);
443 g_message(G_GNUC_PRETTY_FUNCTION
444 ": Attached thread handle %p thread %p ID %ld", handle,
445 thread_private_handle->thread,
446 thread_private_handle->thread->id);
450 #ifdef PTHREAD_POINTER_ID
451 *tid=GPOINTER_TO_UINT(thread_private_handle->thread->id);
453 *tid=thread_private_handle->thread->id;
457 _wapi_handle_unlock_handle (handle);
465 * Looks up the handle associated with the current thread. Under
466 * Windows this is a pseudohandle, and must be duplicated with
467 * DuplicateHandle() for some operations.
469 * Return value: The current thread handle, or %NULL on failure.
470 * (Unknown whether Windows has a possible failure here. It may be
471 * necessary to implement the pseudohandle-constant behaviour).
473 gpointer GetCurrentThread(void)
478 mono_once(&thread_hash_once, thread_hash_init);
479 mono_once (&thread_ops_once, thread_ops_init);
481 tid=GetCurrentThreadId();
483 mono_mutex_lock(&thread_hash_mutex);
485 ret=g_hash_table_lookup(thread_hash, &tid);
486 mono_mutex_unlock(&thread_hash_mutex);
489 ret = thread_attach (NULL);
497 * @handle: the thread handle to resume
499 * Decrements the suspend count of thread @handle. A thread can only
500 * run if its suspend count is zero.
502 * Return value: the previous suspend count, or 0xFFFFFFFF on error.
504 guint32 ResumeThread(gpointer handle)
506 struct _WapiHandle_thread *thread_handle;
507 struct _WapiHandlePrivate_thread *thread_private_handle;
510 ok=_wapi_lookup_handle (handle, WAPI_HANDLE_THREAD,
511 (gpointer *)&thread_handle,
512 (gpointer *)&thread_private_handle);
514 g_warning (G_GNUC_PRETTY_FUNCTION
515 ": error looking up thread handle %p", handle);
519 /* This is still a kludge that only copes with starting a
520 * thread that was suspended on create, so don't bother with
521 * the suspend count crap yet
523 _wapi_timed_thread_resume (thread_private_handle->thread);
530 * @handle: the thread handle to suspend
532 * Increments the suspend count of thread @handle. A thread can only
533 * run if its suspend count is zero.
535 * Return value: the previous suspend count, or 0xFFFFFFFF on error.
537 guint32 SuspendThread(gpointer handle G_GNUC_UNUSED)
543 * We assume here that TLS_MINIMUM_AVAILABLE is less than
544 * PTHREAD_KEYS_MAX, allowing enough overhead for a few TLS keys for
547 * Currently TLS_MINIMUM_AVAILABLE is 64 and _POSIX_THREAD_KEYS_MAX
548 * (the minimum value for PTHREAD_KEYS_MAX) is 128, so we should be
552 static pthread_key_t TLS_keys[TLS_MINIMUM_AVAILABLE];
553 static gboolean TLS_used[TLS_MINIMUM_AVAILABLE]={FALSE};
554 #ifdef TLS_PTHREAD_MUTEX
555 static mono_mutex_t TLS_mutex=MONO_MUTEX_INITIALIZER;
557 static guint32 TLS_spinlock=0;
563 * Allocates a Thread Local Storage (TLS) index. Any thread in the
564 * same process can use this index to store and retrieve values that
565 * are local to that thread.
567 * Return value: The index value, or %TLS_OUT_OF_INDEXES if no index
570 guint32 TlsAlloc(void)
574 #ifdef TLS_PTHREAD_MUTEX
575 mono_mutex_lock(&TLS_mutex);
577 MONO_SPIN_LOCK (TLS_spinlock);
580 for(i=0; i<TLS_MINIMUM_AVAILABLE; i++) {
581 if(TLS_used[i]==FALSE) {
583 pthread_key_create(&TLS_keys[i], NULL);
585 #ifdef TLS_PTHREAD_MUTEX
586 mono_mutex_unlock(&TLS_mutex);
588 MONO_SPIN_UNLOCK (TLS_spinlock);
592 g_message (G_GNUC_PRETTY_FUNCTION ": returning key %d",
600 #ifdef TLS_PTHREAD_MUTEX
601 mono_mutex_unlock(&TLS_mutex);
603 MONO_SPIN_UNLOCK (TLS_spinlock);
607 g_message (G_GNUC_PRETTY_FUNCTION ": out of indices");
611 return(TLS_OUT_OF_INDEXES);
614 #define MAKE_GC_ID(idx) (GUINT_TO_POINTER((idx)|(GetCurrentThreadId()<<8)))
618 * @idx: The TLS index to free
620 * Releases a TLS index, making it available for reuse. This call
621 * will delete any TLS data stored under index @idx in all threads.
623 * Return value: %TRUE on success, %FALSE otherwise.
625 gboolean TlsFree(guint32 idx)
628 g_message (G_GNUC_PRETTY_FUNCTION ": freeing key %d", idx);
631 #ifdef TLS_PTHREAD_MUTEX
632 mono_mutex_lock(&TLS_mutex);
634 MONO_SPIN_LOCK (TLS_spinlock);
637 if(TLS_used[idx]==FALSE) {
638 #ifdef TLS_PTHREAD_MUTEX
639 mono_mutex_unlock(&TLS_mutex);
641 MONO_SPIN_UNLOCK (TLS_spinlock);
647 pthread_key_delete(TLS_keys[idx]);
650 mono_g_hash_table_remove (tls_gc_hash, MAKE_GC_ID (idx));
653 #ifdef TLS_PTHREAD_MUTEX
654 mono_mutex_unlock(&TLS_mutex);
656 MONO_SPIN_UNLOCK (TLS_spinlock);
664 * @idx: The TLS index to retrieve
666 * Retrieves the TLS data stored under index @idx.
668 * Return value: The value stored in the TLS index @idx in the current
669 * thread, or %NULL on error. As %NULL can be a valid return value,
670 * in this case GetLastError() returns %ERROR_SUCCESS.
672 gpointer TlsGetValue(guint32 idx)
677 g_message (G_GNUC_PRETTY_FUNCTION ": looking up key %d", idx);
680 ret=pthread_getspecific(TLS_keys[idx]);
683 g_message (G_GNUC_PRETTY_FUNCTION ": returning %p", ret);
691 * @idx: The TLS index to store
692 * @value: The value to store under index @idx
694 * Stores @value at TLS index @idx.
696 * Return value: %TRUE on success, %FALSE otherwise.
698 gboolean TlsSetValue(guint32 idx, gpointer value)
703 g_message (G_GNUC_PRETTY_FUNCTION ": setting key %d to %p", idx,
707 #ifdef TLS_PTHREAD_MUTEX
708 mono_mutex_lock(&TLS_mutex);
710 MONO_SPIN_LOCK (TLS_spinlock);
713 if(TLS_used[idx]==FALSE) {
715 g_message (G_GNUC_PRETTY_FUNCTION ": key %d unused", idx);
718 #ifdef TLS_PTHREAD_MUTEX
719 mono_mutex_unlock(&TLS_mutex);
721 MONO_SPIN_UNLOCK (TLS_spinlock);
726 ret=pthread_setspecific(TLS_keys[idx], value);
729 g_message (G_GNUC_PRETTY_FUNCTION
730 ": pthread_setspecific error: %s", strerror (ret));
733 #ifdef TLS_PTHREAD_MUTEX
734 mono_mutex_unlock(&TLS_mutex);
736 MONO_SPIN_UNLOCK (TLS_spinlock);
743 tls_gc_hash = mono_g_hash_table_new(g_direct_hash, g_direct_equal);
744 mono_g_hash_table_insert (tls_gc_hash, MAKE_GC_ID (idx), value);
747 #ifdef TLS_PTHREAD_MUTEX
748 mono_mutex_unlock(&TLS_mutex);
750 MONO_SPIN_UNLOCK (TLS_spinlock);
758 * @ms: The time in milliseconds to suspend for
760 * Suspends execution of the current thread for @ms milliseconds. A
761 * value of zero causes the thread to relinquish its time slice. A
762 * value of %INFINITE causes an infinite delay.
764 void Sleep(guint32 ms)
766 struct timespec req, rem;
771 g_message(G_GNUC_PRETTY_FUNCTION ": Sleeping for %d ms", ms);
779 /* FIXME: check for INFINITE and sleep forever */
780 divvy=div((int)ms, 1000);
782 req.tv_sec=divvy.quot;
783 req.tv_nsec=divvy.rem*1000000;
786 ret=nanosleep(&req, &rem);
788 /* Sleep interrupted with rem time remaining */
790 guint32 rems=rem.tv_sec*1000 + rem.tv_nsec/1000000;
792 g_message(G_GNUC_PRETTY_FUNCTION ": Still got %d ms to go",
800 /* FIXME: implement alertable */
801 void SleepEx(guint32 ms, gboolean alertable)
803 if(alertable==TRUE) {
804 g_warning(G_GNUC_PRETTY_FUNCTION ": alertable not implemented");