/* * threads.c: Thread handles * * Author: * Dick Porter (dick@ximian.com) * * (C) 2002 Ximian, Inc. */ #include #if HAVE_BOEHM_GC #include #include "mono/utils/mono-hash.h" #endif #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #if HAVE_VALGRIND_MEMCHECK_H #include #endif #undef DEBUG #undef TLS_DEBUG /* Hash threads with tids. I thought of using TLS for this, but that * would have to set the data in the new thread, which is more hassle */ static mono_once_t thread_hash_once = MONO_ONCE_INIT; static mono_mutex_t thread_hash_mutex = MONO_MUTEX_INITIALIZER; static GHashTable *thread_hash=NULL; #if HAVE_BOEHM_GC static MonoGHashTable *tls_gc_hash = NULL; #endif static void thread_close_private (gpointer handle); static void thread_own (gpointer handle); struct _WapiHandleOps _wapi_thread_ops = { NULL, /* close_shared */ thread_close_private, /* close_private */ NULL, /* signal */ thread_own, /* own */ NULL, /* is_owned */ }; static mono_once_t thread_ops_once=MONO_ONCE_INIT; #ifdef WITH_INCLUDED_LIBGC static void gc_init (void); #endif static void thread_ops_init (void) { _wapi_handle_register_capabilities (WAPI_HANDLE_THREAD, WAPI_HANDLE_CAP_WAIT); #ifdef WITH_INCLUDED_LIBGC gc_init (); #endif } static void thread_close_private (gpointer handle) { struct _WapiHandlePrivate_thread *thread_handle; gboolean ok; ok=_wapi_lookup_handle (handle, WAPI_HANDLE_THREAD, NULL, (gpointer *)&thread_handle); if(ok==FALSE) { g_warning (G_GNUC_PRETTY_FUNCTION ": error looking up thread handle %p", handle); return; } #ifdef DEBUG g_message(G_GNUC_PRETTY_FUNCTION ": closing thread handle %p with thread %p id %ld", handle, thread_handle->thread, thread_handle->thread->id); #endif thread_handle->thread=NULL; } static void thread_own (gpointer handle) { struct _WapiHandle_thread *thread_handle; struct _WapiHandlePrivate_thread *thread_private_handle; gboolean ok; ok=_wapi_lookup_handle (handle, WAPI_HANDLE_THREAD, (gpointer *)&thread_handle, (gpointer *)&thread_private_handle); if(ok==FALSE) { g_warning (G_GNUC_PRETTY_FUNCTION ": error looking up thread handle %p", handle); return; } if(thread_private_handle->joined==FALSE) { _wapi_timed_thread_join (thread_private_handle->thread, NULL, NULL); thread_private_handle->joined=TRUE; } } static void thread_exit(guint32 exitstatus, gpointer handle) { struct _WapiHandle_thread *thread_handle; struct _WapiHandlePrivate_thread *thread_private_handle; gboolean ok; int thr_ret; ok=_wapi_lookup_handle (handle, WAPI_HANDLE_THREAD, (gpointer *)&thread_handle, (gpointer *)&thread_private_handle); if(ok==FALSE) { g_warning (G_GNUC_PRETTY_FUNCTION ": error looking up thread handle %p", handle); return; } _wapi_mutex_check_abandoned (getpid (), thread_private_handle->thread->id); pthread_cleanup_push ((void(*)(void *))_wapi_handle_unlock_handle, handle); thr_ret = _wapi_handle_lock_handle (handle); g_assert (thr_ret == 0); #ifdef DEBUG g_message (G_GNUC_PRETTY_FUNCTION ": Recording thread handle %p exit status", handle); #endif thread_handle->exitstatus=exitstatus; thread_handle->state=THREAD_STATE_EXITED; _wapi_handle_set_signal_state (handle, TRUE, TRUE); thr_ret = _wapi_handle_unlock_handle (handle); g_assert (thr_ret == 0); pthread_cleanup_pop (0); #ifdef DEBUG g_message(G_GNUC_PRETTY_FUNCTION ": Recording thread handle %p id %ld status as %d", handle, thread_private_handle->thread->id, exitstatus); #endif /* Remove this thread from the hash */ pthread_cleanup_push ((void(*)(void *))mono_mutex_unlock_in_cleanup, (void *)&thread_hash_mutex); thr_ret = mono_mutex_lock(&thread_hash_mutex); g_assert (thr_ret == 0); g_hash_table_remove(thread_hash, &thread_private_handle->thread->id); thr_ret = mono_mutex_unlock(&thread_hash_mutex); g_assert (thr_ret == 0); pthread_cleanup_pop (0); /* The thread is no longer active, so unref it */ _wapi_handle_unref (handle); } static void thread_hash_init(void) { thread_hash=g_hash_table_new(g_int_hash, g_int_equal); } /** * CreateThread: * @security: Ignored for now. * @stacksize: the size in bytes of the new thread's stack. Use 0 to * default to the normal stack size. (Ignored for now). * @start: The function that the new thread should start with * @param: The parameter to give to @start. * @create: If 0, the new thread is ready to run immediately. If * %CREATE_SUSPENDED, the new thread will be in the suspended state, * requiring a ResumeThread() call to continue running. * @tid: If non-NULL, the ID of the new thread is stored here. * * Creates a new threading handle. * * Return value: a new handle, or NULL */ gpointer CreateThread(WapiSecurityAttributes *security G_GNUC_UNUSED, guint32 stacksize, WapiThreadStart start, gpointer param, guint32 create, guint32 *tid) { struct _WapiHandle_thread *thread_handle; struct _WapiHandlePrivate_thread *thread_private_handle; pthread_attr_t attr; gpointer handle; gboolean ok; int ret; int thr_ret; int i, unrefs = 0; gpointer ct_ret = NULL; mono_once(&thread_hash_once, thread_hash_init); mono_once (&thread_ops_once, thread_ops_init); if(start==NULL) { return(NULL); } handle=_wapi_handle_new (WAPI_HANDLE_THREAD); if(handle==_WAPI_HANDLE_INVALID) { g_warning (G_GNUC_PRETTY_FUNCTION ": error creating thread handle"); return(NULL); } pthread_cleanup_push ((void(*)(void *))_wapi_handle_unlock_handle, handle); thr_ret = _wapi_handle_lock_handle (handle); g_assert (thr_ret == 0); ok=_wapi_lookup_handle (handle, WAPI_HANDLE_THREAD, (gpointer *)&thread_handle, (gpointer *)&thread_private_handle); if(ok==FALSE) { g_warning (G_GNUC_PRETTY_FUNCTION ": error looking up thread handle %p", handle); goto cleanup; } /* Hold a reference while the thread is active, because we use * the handle to store thread exit information */ _wapi_handle_ref (handle); thread_handle->state=THREAD_STATE_START; /* Lock around the thread create, so that the new thread cant * race us to look up the thread handle in GetCurrentThread() */ pthread_cleanup_push ((void(*)(void *))mono_mutex_unlock_in_cleanup, (void *)&thread_hash_mutex); thr_ret = mono_mutex_lock(&thread_hash_mutex); g_assert (thr_ret == 0); /* Set a 2M stack size. This is the default on Linux, but BSD * needs it. (The original bug report from Martin Dvorak * set the size to 2M-4k. I don't know why it's short by 4k, so * I'm leaving it as 2M until I'm told differently.) */ thr_ret = pthread_attr_init(&attr); g_assert (thr_ret == 0); /* defaults of 2Mb for 32bits and 4Mb for 64bits */ if (stacksize == 0){ #if HAVE_VALGRIND_MEMCHECK_H if (RUNNING_ON_VALGRIND) stacksize = 1 << 20; else stacksize = (SIZEOF_VOID_P / 2) * 1024 * 1024; #else stacksize = (SIZEOF_VOID_P / 2) * 1024 * 1024; #endif } #ifdef HAVE_PTHREAD_ATTR_SETSTACKSIZE thr_ret = pthread_attr_setstacksize(&attr, stacksize); g_assert (thr_ret == 0); #endif ret=_wapi_timed_thread_create(&thread_private_handle->thread, &attr, create, start, thread_exit, param, handle); if(ret!=0) { #ifdef DEBUG g_message(G_GNUC_PRETTY_FUNCTION ": Thread create error: %s", strerror(ret)); #endif /* Two, because of the reference we took above */ unrefs = 2; goto thread_hash_cleanup; } ct_ret = handle; g_hash_table_insert(thread_hash, &thread_private_handle->thread->id, handle); #ifdef DEBUG g_message(G_GNUC_PRETTY_FUNCTION ": Started thread handle %p thread %p ID %ld", handle, thread_private_handle->thread, thread_private_handle->thread->id); #endif if(tid!=NULL) { #ifdef PTHREAD_POINTER_ID *tid=GPOINTER_TO_UINT(thread_private_handle->thread->id); #else *tid=thread_private_handle->thread->id; #endif } thread_hash_cleanup: thr_ret = mono_mutex_unlock (&thread_hash_mutex); g_assert (thr_ret == 0); pthread_cleanup_pop (0); cleanup: thr_ret = _wapi_handle_unlock_handle (handle); g_assert (thr_ret == 0); pthread_cleanup_pop (0); /* Must not call _wapi_handle_unref() with the handle already * locked */ for (i = 0; i < unrefs; i++) { _wapi_handle_unref (handle); } return(ct_ret); } gpointer OpenThread (guint32 access G_GNUC_UNUSED, gboolean inherit G_GNUC_UNUSED, guint32 tid) { gpointer ret=NULL; int thr_ret; mono_once(&thread_hash_once, thread_hash_init); mono_once (&thread_ops_once, thread_ops_init); #ifdef DEBUG g_message (G_GNUC_PRETTY_FUNCTION ": looking up thread %d", tid); #endif pthread_cleanup_push ((void(*)(void *))mono_mutex_unlock_in_cleanup, (void *)&thread_hash_mutex); thr_ret = mono_mutex_lock(&thread_hash_mutex); g_assert (thr_ret == 0); ret=g_hash_table_lookup(thread_hash, &tid); thr_ret = mono_mutex_unlock(&thread_hash_mutex); g_assert (thr_ret == 0); pthread_cleanup_pop (0); if(ret!=NULL) { _wapi_handle_ref (ret); } #ifdef DEBUG g_message (G_GNUC_PRETTY_FUNCTION ": returning thread handle %p", ret); #endif return(ret); } /** * ExitThread: * @exitcode: Sets the thread's exit code, which can be read from * another thread with GetExitCodeThread(). * * Terminates the calling thread. A thread can also exit by returning * from its start function. When the last thread in a process * terminates, the process itself terminates. */ void ExitThread(guint32 exitcode) { _wapi_timed_thread_exit(exitcode); } /** * GetExitCodeThread: * @handle: The thread handle to query * @exitcode: The thread @handle exit code is stored here * * Finds the exit code of @handle, and stores it in @exitcode. If the * thread @handle is still running, the value stored is %STILL_ACTIVE. * * Return value: %TRUE, or %FALSE on error. */ gboolean GetExitCodeThread(gpointer handle, guint32 *exitcode) { struct _WapiHandle_thread *thread_handle; struct _WapiHandlePrivate_thread *thread_private_handle; gboolean ok; ok=_wapi_lookup_handle (handle, WAPI_HANDLE_THREAD, (gpointer *)&thread_handle, (gpointer *)&thread_private_handle); if(ok==FALSE) { g_warning (G_GNUC_PRETTY_FUNCTION ": error looking up thread handle %p", handle); return(FALSE); } #ifdef DEBUG g_message(G_GNUC_PRETTY_FUNCTION ": Finding exit status for thread handle %p id %ld", handle, thread_private_handle->thread->id); #endif if(exitcode==NULL) { #ifdef DEBUG g_message(G_GNUC_PRETTY_FUNCTION ": Nowhere to store exit code"); #endif return(FALSE); } if(thread_handle->state!=THREAD_STATE_EXITED) { #ifdef DEBUG g_message(G_GNUC_PRETTY_FUNCTION ": Thread still active (state %d, exited is %d)", thread_handle->state, THREAD_STATE_EXITED); #endif *exitcode=STILL_ACTIVE; return(TRUE); } *exitcode=thread_handle->exitstatus; return(TRUE); } /** * GetCurrentThreadId: * * Looks up the thread ID of the current thread. This ID can be * passed to OpenThread() to create a new handle on this thread. * * Return value: the thread ID. */ guint32 GetCurrentThreadId(void) { pthread_t tid=pthread_self(); #ifdef PTHREAD_POINTER_ID return(GPOINTER_TO_UINT(tid)); #else return(tid); #endif } static gpointer thread_attach(guint32 *tid) { struct _WapiHandle_thread *thread_handle; struct _WapiHandlePrivate_thread *thread_private_handle; gpointer handle; gboolean ok; int ret; int thr_ret; int i, unrefs = 0; gpointer ta_ret = NULL; mono_once(&thread_hash_once, thread_hash_init); mono_once (&thread_ops_once, thread_ops_init); handle=_wapi_handle_new (WAPI_HANDLE_THREAD); if(handle==_WAPI_HANDLE_INVALID) { g_warning (G_GNUC_PRETTY_FUNCTION ": error creating thread handle"); return(NULL); } pthread_cleanup_push ((void(*)(void *))_wapi_handle_unlock_handle, handle); thr_ret = _wapi_handle_lock_handle (handle); g_assert (thr_ret == 0); ok=_wapi_lookup_handle (handle, WAPI_HANDLE_THREAD, (gpointer *)&thread_handle, (gpointer *)&thread_private_handle); if(ok==FALSE) { g_warning (G_GNUC_PRETTY_FUNCTION ": error looking up thread handle %p", handle); goto cleanup; } /* Hold a reference while the thread is active, because we use * the handle to store thread exit information */ _wapi_handle_ref (handle); thread_handle->state=THREAD_STATE_START; /* Lock around the thread create, so that the new thread cant * race us to look up the thread handle in GetCurrentThread() */ pthread_cleanup_push ((void(*)(void *))mono_mutex_unlock_in_cleanup, (void *)&thread_hash_mutex); thr_ret = mono_mutex_lock(&thread_hash_mutex); g_assert (thr_ret == 0); ret=_wapi_timed_thread_attach(&thread_private_handle->thread, thread_exit, handle); if(ret!=0) { #ifdef DEBUG g_message(G_GNUC_PRETTY_FUNCTION ": Thread attach error: %s", strerror(ret)); #endif /* Two, because of the reference we took above */ unrefs = 2; goto thread_hash_cleanup; } ta_ret = handle; g_hash_table_insert(thread_hash, &thread_private_handle->thread->id, handle); #ifdef DEBUG g_message(G_GNUC_PRETTY_FUNCTION ": Attached thread handle %p thread %p ID %ld", handle, thread_private_handle->thread, thread_private_handle->thread->id); #endif if(tid!=NULL) { #ifdef PTHREAD_POINTER_ID *tid=GPOINTER_TO_UINT(thread_private_handle->thread->id); #else *tid=thread_private_handle->thread->id; #endif } thread_hash_cleanup: thr_ret = mono_mutex_unlock (&thread_hash_mutex); g_assert (thr_ret == 0); pthread_cleanup_pop (0); cleanup: thr_ret = _wapi_handle_unlock_handle (handle); g_assert (thr_ret == 0); pthread_cleanup_pop (0); /* Must not call _wapi_handle_unref() with the handle already * locked */ for (i = 0; i < unrefs; i++) { _wapi_handle_unref (handle); } return(ta_ret); } /** * GetCurrentThread: * * Looks up the handle associated with the current thread. Under * Windows this is a pseudohandle, and must be duplicated with * DuplicateHandle() for some operations. * * Return value: The current thread handle, or %NULL on failure. * (Unknown whether Windows has a possible failure here. It may be * necessary to implement the pseudohandle-constant behaviour). */ gpointer GetCurrentThread(void) { gpointer ret=NULL; guint32 tid; int thr_ret; mono_once(&thread_hash_once, thread_hash_init); mono_once (&thread_ops_once, thread_ops_init); tid=GetCurrentThreadId(); pthread_cleanup_push ((void(*)(void *))mono_mutex_unlock_in_cleanup, (void *)&thread_hash_mutex); thr_ret = mono_mutex_lock(&thread_hash_mutex); g_assert (thr_ret == 0); ret=g_hash_table_lookup(thread_hash, &tid); thr_ret = mono_mutex_unlock(&thread_hash_mutex); g_assert (thr_ret == 0); pthread_cleanup_pop (0); if (!ret) { ret = thread_attach (NULL); } return(ret); } /** * ResumeThread: * @handle: the thread handle to resume * * Decrements the suspend count of thread @handle. A thread can only * run if its suspend count is zero. * * Return value: the previous suspend count, or 0xFFFFFFFF on error. */ guint32 ResumeThread(gpointer handle) { struct _WapiHandle_thread *thread_handle; struct _WapiHandlePrivate_thread *thread_private_handle; gboolean ok; ok=_wapi_lookup_handle (handle, WAPI_HANDLE_THREAD, (gpointer *)&thread_handle, (gpointer *)&thread_private_handle); if(ok==FALSE) { g_warning (G_GNUC_PRETTY_FUNCTION ": error looking up thread handle %p", handle); return(0xFFFFFFFF); } if (thread_private_handle->thread == NULL) { return(0xFFFFFFFF); } #ifdef WITH_INCLUDED_LIBGC if (thread_private_handle->thread->suspend_count <= 1) _wapi_timed_thread_resume (thread_private_handle->thread); return --thread_private_handle->thread->suspend_count; #else /* This is still a kludge that only copes with starting a * thread that was suspended on create, so don't bother with * the suspend count crap yet */ _wapi_timed_thread_resume (thread_private_handle->thread); return(0xFFFFFFFF); #endif } /** * SuspendThread: * @handle: the thread handle to suspend * * Increments the suspend count of thread @handle. A thread can only * run if its suspend count is zero. * * Return value: the previous suspend count, or 0xFFFFFFFF on error. */ guint32 SuspendThread(gpointer handle) { #ifdef WITH_INCLUDED_LIBGC struct _WapiHandle_thread *thread_handle; struct _WapiHandlePrivate_thread *thread_private_handle; gpointer current; gboolean ok; current = GetCurrentThread (); ok=_wapi_lookup_handle (handle, WAPI_HANDLE_THREAD, (gpointer *)&thread_handle, (gpointer *)&thread_private_handle); if(ok==FALSE) { g_warning (G_GNUC_PRETTY_FUNCTION ": error looking up thread handle %p", handle); return(0xFFFFFFFF); } if (thread_private_handle->thread == NULL) { return(0xFFFFFFFF); } if (!thread_private_handle->thread->suspend_count) { if (handle == current) _wapi_timed_thread_suspend (thread_private_handle->thread); else { pthread_kill (thread_private_handle->thread->id, SIGPWR); while (MONO_SEM_WAIT (&thread_private_handle->thread->suspended_sem) != 0) { if (errno != EINTR) { return(0xFFFFFFFF); } } } } return thread_private_handle->thread->suspend_count++; #else return(0xFFFFFFFF); #endif } /* * We assume here that TLS_MINIMUM_AVAILABLE is less than * PTHREAD_KEYS_MAX, allowing enough overhead for a few TLS keys for * library usage. * * Currently TLS_MINIMUM_AVAILABLE is 64 and _POSIX_THREAD_KEYS_MAX * (the minimum value for PTHREAD_KEYS_MAX) is 128, so we should be * fine. */ static pthread_key_t TLS_keys[TLS_MINIMUM_AVAILABLE]; static gboolean TLS_used[TLS_MINIMUM_AVAILABLE]={FALSE}; static guint32 TLS_spinlock=0; /** * TlsAlloc: * * Allocates a Thread Local Storage (TLS) index. Any thread in the * same process can use this index to store and retrieve values that * are local to that thread. * * Return value: The index value, or %TLS_OUT_OF_INDEXES if no index * is available. */ guint32 TlsAlloc(void) { guint32 i; int thr_ret; MONO_SPIN_LOCK (TLS_spinlock); for(i=0; ithread, apc_callback, param); return(1); } gboolean _wapi_thread_cur_apc_pending (void) { return _wapi_thread_apc_pending (GetCurrentThread ()); } gboolean _wapi_thread_apc_pending (gpointer handle) { struct _WapiHandle_thread *thread_handle; struct _WapiHandlePrivate_thread *thread_private_handle; gboolean ok; ok=_wapi_lookup_handle (handle, WAPI_HANDLE_THREAD, (gpointer *)&thread_handle, (gpointer *)&thread_private_handle); if(ok==FALSE) { g_warning (G_GNUC_PRETTY_FUNCTION ": error looking up thread handle %p", handle); return(FALSE); } return _wapi_timed_thread_apc_pending (thread_private_handle->thread); } gboolean _wapi_thread_dispatch_apc_queue (gpointer handle) { struct _WapiHandle_thread *thread_handle; struct _WapiHandlePrivate_thread *thread_private_handle; gboolean ok; ok=_wapi_lookup_handle (handle, WAPI_HANDLE_THREAD, (gpointer *)&thread_handle, (gpointer *)&thread_private_handle); if(ok==FALSE) { g_warning (G_GNUC_PRETTY_FUNCTION ": error looking up thread handle %p", handle); return(0); } _wapi_timed_thread_dispatch_apc_queue (thread_private_handle->thread); return(1); } #ifdef WITH_INCLUDED_LIBGC static void GC_suspend_handler (int sig) { struct _WapiHandle_thread *thread_handle; struct _WapiHandlePrivate_thread *thread_private_handle; gpointer handle; gboolean ok; handle = GetCurrentThread (); ok=_wapi_lookup_handle (handle, WAPI_HANDLE_THREAD, (gpointer *)&thread_handle, (gpointer *)&thread_private_handle); if(ok==FALSE) { g_warning (G_GNUC_PRETTY_FUNCTION ": error looking up thread handle %p", handle); return; } thread_private_handle->thread->stack_ptr = &ok; MONO_SEM_POST (&thread_private_handle->thread->suspended_sem); _wapi_timed_thread_suspend (thread_private_handle->thread); thread_private_handle->thread->stack_ptr = NULL; } static void gc_init (void) { struct sigaction act; act.sa_handler = GC_suspend_handler; g_assert (sigaction (SIGPWR, &act, NULL) == 0); } void mono_wapi_push_thread_stack (gpointer handle, gpointer stack_ptr) { struct _WapiHandle_thread *thread_handle; struct _WapiHandlePrivate_thread *thread_private_handle; gboolean ok; ok=_wapi_lookup_handle (handle, WAPI_HANDLE_THREAD, (gpointer *)&thread_handle, (gpointer *)&thread_private_handle); if(ok==FALSE) { g_warning (G_GNUC_PRETTY_FUNCTION ": error looking up thread handle %p", handle); return; } GC_push_all_stack (thread_private_handle->thread->stack_ptr, stack_ptr); } #endif /* WITH_INCLUDED_LIBGC */