mono/utils/mono-threads.c

   1 /*
   2  * mono-threads.c: Low-level threading
   3  *
   4  * Author:
   5  *      Rodrigo Kumpera (kumpera@gmail.com)
   6  *
   7  * (C) 2011 Novell, Inc
   8  */
   9
  10 #include <mono/utils/mono-compiler.h>
  11 #include <mono/utils/mono-semaphore.h>
  12 #include <mono/utils/mono-threads.h>
  13 #include <mono/utils/mono-tls.h>
  14 #include <mono/utils/hazard-pointer.h>
  15 #include <mono/metadata/gc-internal.h>
  16 #include <mono/metadata/appdomain.h>
  17
  18 #include <errno.h>
  19
  20 #define THREADS_DEBUG(...)
  21 //#define THREADS_DEBUG(...) g_message(__VA_ARGS__)
  22
  23 /*
  24 Mutex that makes sure only a single thread can be suspending others.
  25 Suspend is a very racy operation since it requires restarting until
  26 the target thread is not on an unsafe region.
  27
  28 We could implement this using critical regions, but would be much much
  29 harder for an operation that is hardly performance critical.
  30
  31 The GC has to acquire this lock before starting a STW to make sure
  32 a runtime suspend won't make it wronly see a thread in a safepoint
  33 when it is in fact not.
  34 */
  35 static CRITICAL_SECTION global_suspend_lock;
  36
  37
  38 static int thread_info_size;
  39 static MonoThreadInfoCallbacks threads_callbacks;
  40 static MonoThreadInfoRuntimeCallbacks runtime_callbacks;
  41 static MonoNativeTlsKey thread_info_key, small_id_key;
  42 static MonoLinkedListSet thread_list;
  43
  44 static inline void
  45 mono_hazard_pointer_clear_all (MonoThreadHazardPointers *hp, int retain)
  46 {
  47         if (retain != 0)
  48                 mono_hazard_pointer_clear (hp, 0);
  49         if (retain != 1)
  50                 mono_hazard_pointer_clear (hp, 1);
  51         if (retain != 2)
  52                 mono_hazard_pointer_clear (hp, 2);
  53 }
  54
  55 /*
  56 If return non null Hazard Pointer 1 holds the return value.
  57 */
  58 MonoThreadInfo*
  59 mono_thread_info_lookup (MonoNativeThreadId id)
  60 {
  61                 MonoThreadHazardPointers *hp = mono_hazard_pointer_get ();
  62
  63         if (!mono_lls_find (&thread_list, hp, (uintptr_t)id)) {
  64                 mono_hazard_pointer_clear_all (hp, -1);
  65                 return NULL;
  66         }
  67
  68         mono_hazard_pointer_clear_all (hp, 1);
  69         return mono_hazard_pointer_get_val (hp, 1);
  70 }
  71
  72 static gboolean
  73 mono_thread_info_insert (MonoThreadInfo *info)
  74 {
  75         MonoThreadHazardPointers *hp = mono_hazard_pointer_get ();
  76
  77         if (!mono_lls_insert (&thread_list, hp, (MonoLinkedListSetNode*)info)) {
  78                 mono_hazard_pointer_clear_all (hp, -1);
  79                 return FALSE;
  80         }
  81
  82         mono_hazard_pointer_clear_all (hp, -1);
  83         return TRUE;
  84 }
  85
  86 static gboolean
  87 mono_thread_info_remove (MonoThreadInfo *info)
  88 {
  89         MonoThreadHazardPointers *hp = mono_hazard_pointer_get ();
  90         gboolean res;
  91
  92         THREADS_DEBUG ("removing info %p\n", info);
  93         res = mono_lls_remove (&thread_list, hp, (MonoLinkedListSetNode*)info);
  94         mono_hazard_pointer_clear_all (hp, -1);
  95         return res;
  96 }
  97
  98 static void
  99 free_thread_info (gpointer mem)
 100 {
 101         MonoThreadInfo *info = mem;
 102
 103         DeleteCriticalSection (&info->suspend_lock);
 104         mono_threads_platform_free (info);
 105
 106         g_free (info);
 107 }
 108
 109 static void*
 110 register_thread (MonoThreadInfo *info, gpointer baseptr)
 111 {
 112         gboolean result;
 113         mono_thread_info_set_tid (info, mono_native_thread_id_get ());
 114         info->small_id = mono_thread_small_id_alloc ();
 115
 116         InitializeCriticalSection (&info->suspend_lock);
 117
 118         /*set TLS early so SMR works */
 119         mono_native_tls_set_value (thread_info_key, info);
 120         mono_native_tls_set_value (small_id_key, GUINT_TO_POINTER (info->small_id + 1));
 121
 122         THREADS_DEBUG ("registering info %p tid %p small id %x\n", info, mono_thread_info_get_tid (info), info->small_id);
 123
 124         if (threads_callbacks.thread_register) {
 125                 if (threads_callbacks.thread_register (info, baseptr) == NULL) {
 126                         g_warning ("thread registation failed\n");
 127                         g_free (info);
 128                         return NULL;
 129                 }
 130         }
 131
 132         mono_threads_platform_register (info);
 133
 134         /*If this fail it means a given thread has been registered twice, which doesn't make sense. */
 135         result = mono_thread_info_insert (info);
 136         g_assert (result);
 137         return info;
 138 }
 139
 140 static void
 141 unregister_thread (void *arg)
 142 {
 143         MonoThreadInfo *info = arg;
 144         int small_id = info->small_id;
 145         g_assert (info);
 146
 147         THREADS_DEBUG ("unregistering info %p\n", info);
 148
 149         /*
 150          * TLS destruction order is not reliable so small_id might be cleaned up
 151          * before us.
 152          */
 153         mono_native_tls_set_value (small_id_key, GUINT_TO_POINTER (info->small_id + 1));
 154
 155         /*
 156         The unregister callback is reposible for calling mono_threads_unregister_current_thread
 157         since it usually needs to be done in sync with the GC does a stop-the-world.
 158         */
 159         if (threads_callbacks.thread_unregister)
 160                 threads_callbacks.thread_unregister (info);
 161         else
 162                 mono_threads_unregister_current_thread (info);
 163
 164         /*now it's safe to free the thread info.*/
 165         mono_thread_hazardous_free_or_queue (info, free_thread_info);
 166         mono_thread_small_id_free (small_id);
 167 }
 168
 169 /**
 170  * Removes the current thread from the thread list.
 171  * This must be called from the thread unregister callback and nowhere else.
 172  * The current thread must be passed as TLS might have already been cleaned up.
 173 */
 174 void
 175 mono_threads_unregister_current_thread (MonoThreadInfo *info)
 176 {
 177         gboolean result;
 178         g_assert (mono_thread_info_get_tid (info) == mono_native_thread_id_get ());
 179         result = mono_thread_info_remove (info);
 180         g_assert (result);
 181
 182 }
 183
 184 MonoThreadInfo*
 185 mono_thread_info_current (void)
 186 {
 187         return mono_native_tls_get_value (thread_info_key);
 188 }
 189
 190 int
 191 mono_thread_info_get_small_id (void)
 192 {
 193         gpointer val = mono_native_tls_get_value (small_id_key);
 194         if (!val)
 195                 return -1;
 196         return GPOINTER_TO_INT (val) - 1;
 197 }
 198
 199 MonoLinkedListSet*
 200 mono_thread_info_list_head (void)
 201 {
 202         return &thread_list;
 203 }
 204
 205 MonoThreadInfo*
 206 mono_thread_info_attach (void *baseptr)
 207 {
 208         MonoThreadInfo *info = mono_native_tls_get_value (thread_info_key);
 209         if (!info) {
 210                 info = g_malloc0 (thread_info_size);
 211                 THREADS_DEBUG ("attaching %p\n", info);
 212                 if (!register_thread (info, baseptr))
 213                         return NULL;
 214         } else if (threads_callbacks.thread_attach) {
 215                 threads_callbacks.thread_attach (info);
 216         }
 217         return info;
 218 }
 219
 220 void
 221 mono_thread_info_dettach (void)
 222 {
 223         MonoThreadInfo *info = mono_native_tls_get_value (thread_info_key);
 224         if (info) {
 225                 THREADS_DEBUG ("detaching %p\n", info);
 226                 unregister_thread (info);
 227         }
 228 }
 229
 230 void
 231 mono_threads_init (MonoThreadInfoCallbacks *callbacks, size_t info_size)
 232 {
 233         gboolean res;
 234         threads_callbacks = *callbacks;
 235         thread_info_size = info_size;
 236 #ifdef HOST_WIN32
 237         res = mono_native_tls_alloc (thread_info_key, NULL);
 238 #else
 239         res = mono_native_tls_alloc (thread_info_key, unregister_thread);
 240 #endif
 241         g_assert (res);
 242
 243         res = mono_native_tls_alloc (small_id_key, NULL);
 244         g_assert (res);
 245
 246         InitializeCriticalSection (&global_suspend_lock);
 247
 248         mono_lls_init (&thread_list, NULL);
 249         mono_thread_smr_init ();
 250         mono_threads_init_platform ();
 251
 252         g_assert (sizeof (MonoNativeThreadId) <= sizeof (uintptr_t));
 253 }
 254
 255 void
 256 mono_threads_runtime_init (MonoThreadInfoRuntimeCallbacks *callbacks)
 257 {
 258         runtime_callbacks = *callbacks;
 259 }
 260
 261 MonoThreadInfoRuntimeCallbacks *
 262 mono_threads_get_runtime_callbacks (void)
 263 {
 264         return &runtime_callbacks;
 265 }
 266
 267 /*
 268 The return value is only valid until a matching mono_thread_info_resume is called
 269 */
 270 static MonoThreadInfo*
 271 mono_thread_info_suspend_sync (MonoNativeThreadId tid, gboolean interrupt_kernel)
 272 {
 273         MonoThreadHazardPointers *hp = mono_hazard_pointer_get ();
 274         MonoThreadInfo *info = mono_thread_info_lookup (tid); /*info on HP1*/
 275         if (!info)
 276                 return NULL;
 277
 278         EnterCriticalSection (&info->suspend_lock);
 279
 280         /*thread is on the process of detaching*/
 281         if (info->thread_state > STATE_RUNNING) {
 282                 mono_hazard_pointer_clear (hp, 1);
 283                 return NULL;
 284         }
 285
 286         THREADS_DEBUG ("suspend %x IN COUNT %d\n", tid, info->suspend_count);
 287
 288         if (info->suspend_count) {
 289                 ++info->suspend_count;
 290                 mono_hazard_pointer_clear (hp, 1);
 291                 LeaveCriticalSection (&info->suspend_lock);
 292                 return info;
 293         }
 294
 295         if (!mono_threads_core_suspend (info)) {
 296                 LeaveCriticalSection (&info->suspend_lock);
 297                 mono_hazard_pointer_clear (hp, 1);
 298                 return NULL;
 299         }
 300
 301         if (interrupt_kernel)
 302                 mono_threads_core_interrupt (info);
 303
 304         ++info->suspend_count;
 305         LeaveCriticalSection (&info->suspend_lock);
 306         mono_hazard_pointer_clear (hp, 1);
 307
 308         return info;
 309 }
 310
 311 void
 312 mono_thread_info_self_suspend ()
 313 {
 314         MonoThreadInfo *info = mono_thread_info_current ();
 315         if (!info)
 316                 return;
 317
 318         EnterCriticalSection (&info->suspend_lock);
 319
 320         THREADS_DEBUG ("self suspend IN COUNT %d\n", info->suspend_count);
 321
 322         g_assert (info->suspend_count == 0);
 323         ++info->suspend_count;
 324
 325         /*
 326         The internal API contract with this function is a bit out of the ordinary.
 327         mono_threads_core_self_suspend executes with suspend_lock taken and must
 328         release it after capturing the current context.
 329         */
 330         mono_threads_core_self_suspend (info);
 331 }
 332
 333 gboolean
 334 mono_thread_info_resume (MonoNativeThreadId tid)
 335 {
 336         gboolean result = TRUE;
 337         MonoThreadHazardPointers *hp = mono_hazard_pointer_get ();
 338         MonoThreadInfo *info = mono_thread_info_lookup (tid); /*info on HP1*/
 339         if (!info)
 340                 return FALSE;
 341
 342         EnterCriticalSection (&info->suspend_lock);
 343
 344         THREADS_DEBUG ("resume %x IN COUNT %d\n",tid, info->suspend_count);
 345
 346         if (info->suspend_count <= 0) {
 347                 LeaveCriticalSection (&info->suspend_lock);
 348                 mono_hazard_pointer_clear (hp, 1);
 349                 return FALSE;
 350         }
 351
 352         /*
 353          * The theory here is that if we manage to suspend the thread it means it did not
 354          * start cleanup since it take the same lock.
 355         */
 356         g_assert (mono_thread_info_get_tid (info));
 357
 358         if (--info->suspend_count == 0)
 359                 result = mono_threads_core_resume (info);
 360
 361         LeaveCriticalSection (&info->suspend_lock);
 362         mono_hazard_pointer_clear (hp, 1);
 363
 364         return result;
 365 }
 366
 367 /*
 368 FIXME fix cardtable WB to be out of line and check with the runtime if the target is not the
 369 WB trampoline. Another option is to encode wb ranges in MonoJitInfo, but that is somewhat hard.
 370 */
 371 static gboolean
 372 is_thread_in_critical_region (MonoThreadInfo *info)
 373 {
 374         MonoMethod *method;
 375         MonoJitInfo *ji = mono_jit_info_table_find (
 376                 info->suspend_state.unwind_data [MONO_UNWIND_DATA_DOMAIN],
 377                 MONO_CONTEXT_GET_IP (&info->suspend_state.ctx));
 378
 379         if (!ji)
 380                 return FALSE;
 381
 382         method = ji->method;
 383
 384         return mono_gc_is_critical_method (method);
 385 }
 386
 387 /*
 388 WARNING:
 389 If we are trying to suspend a target that is on a critical region
 390 and running a syscall we risk looping forever if @interrupt_kernel is FALSE.
 391 So, be VERY carefull in calling this with @interrupt_kernel == FALSE.
 392 */
 393 MonoThreadInfo*
 394 mono_thread_info_safe_suspend_sync (MonoNativeThreadId id, gboolean interrupt_kernel)
 395 {
 396         MonoThreadInfo *info = NULL;
 397         int sleep_duration = 0;
 398
 399         /*FIXME: unify this with self-suspend*/
 400         g_assert (id != mono_native_thread_id_get ());
 401
 402         mono_thread_info_suspend_lock ();
 403
 404         for (;;) {
 405                 if (!(info = mono_thread_info_suspend_sync (id, interrupt_kernel))) {
 406                         g_warning ("failed to suspend thread %p, hopefully it is dead", (gpointer)id);
 407                         mono_thread_info_suspend_unlock ();
 408                         return NULL;
 409                 }
 410                 /*WARNING: We now are in interrupt context until we resume the thread. */
 411                 if (!is_thread_in_critical_region (info))
 412                         break;
 413
 414                 if (!mono_thread_info_resume (id)) {
 415                         g_warning ("failed to result thread %p, hopefully it is dead", (gpointer)id);
 416                         mono_thread_info_suspend_unlock ();
 417                         return NULL;
 418                 }
 419                 THREADS_DEBUG ("restarted thread %p\n", (gpointer)id);
 420
 421                 if (!sleep_duration) {
 422 #ifdef HOST_WIN32
 423                         SwitchToThread ();
 424 #else
 425                         sched_yield ();
 426 #endif
 427                 }
 428                 else {
 429                         g_usleep (sleep_duration);
 430                 }
 431                 sleep_duration += 10;
 432         }
 433
 434         mono_thread_info_suspend_unlock ();
 435         return info;
 436 }
 437
 438 /**
 439 Inject an assynchronous call into the target thread. The target thread must be suspended and
 440 only a single async call can be setup for a given suspend cycle.
 441 This async call must cause stack unwinding as the current implementation doesn't save enough state
 442 to resume execution of the top-of-stack function. It's an acceptable limitation since this is
 443 currently used only to deliver exceptions.
 444 */
 445 void
 446 mono_thread_info_setup_async_call (MonoThreadInfo *info, void (*target_func)(void*), void *user_data)
 447 {
 448         g_assert (info->suspend_count);
 449         /*FIXME this is a bad assert, we probably should do proper locking and fail if one is already set*/
 450         g_assert (!info->async_target);
 451         info->async_target = target_func;
 452         /* This is not GC tracked */
 453         info->user_data = user_data;
 454 }
 455
 456 /*
 457 The suspend lock is held during any suspend in progress.
 458 A GC that has safepoints must take this lock as part of its
 459 STW to make sure no unsafe pending suspend is in progress.
 460 */
 461 void
 462 mono_thread_info_suspend_lock (void)
 463 {
 464         EnterCriticalSection (&global_suspend_lock);
 465 }
 466
 467 void
 468 mono_thread_info_suspend_unlock (void)
 469 {
 470         LeaveCriticalSection (&global_suspend_lock);
 471 }
 472
 473 /*
 474 Disabled by default for now.
 475 To enable this we need mini to implement the callbacks by MonoThreadInfoRuntimeCallbacks
 476 which means mono-context and setup_async_callback, and we need a mono-threads backend.
 477 */
 478 gboolean
 479 mono_thread_info_new_interrupt_enabled (void)
 480 {
 481         return FALSE;
 482 }