mono/utils/mono-threads-posix.c

   1 /*
   2  * mono-threads-posix.c: Low-level threading, posix version
   3  *
   4  * Author:
   5  *      Rodrigo Kumpera (kumpera@gmail.com)
   6  *
   7  * (C) 2011 Novell, Inc
   8  */
   9
  10 #include <config.h>
  11
  12 /* For pthread_main_np, pthread_get_stackaddr_np and pthread_get_stacksize_np */
  13 #if defined (__MACH__)
  14 #define _DARWIN_C_SOURCE 1
  15 #endif
  16
  17 #include <mono/utils/mono-compiler.h>
  18 #include <mono/utils/mono-semaphore.h>
  19 #include <mono/utils/mono-threads.h>
  20 #include <mono/utils/mono-tls.h>
  21 #include <mono/utils/mono-mmap.h>
  22 #include <mono/metadata/threads-types.h>
  23 #include <mono/metadata/gc-internal.h>
  24 #include <limits.h>
  25
  26 #include <errno.h>
  27
  28 #if defined(PLATFORM_ANDROID) && !defined(TARGET_ARM64) && !defined(TARGET_AMD64)
  29 #define USE_TKILL_ON_ANDROID 1
  30 #endif
  31
  32 #ifdef USE_TKILL_ON_ANDROID
  33 extern int tkill (pid_t tid, int signal);
  34 #endif
  35
  36 #if defined(_POSIX_VERSION) || defined(__native_client__)
  37 #include <sys/resource.h>
  38 #include <signal.h>
  39
  40 #if defined(__native_client__)
  41 void nacl_shutdown_gc_thread(void);
  42 #endif
  43
  44 typedef struct {
  45         void *(*start_routine)(void*);
  46         void *arg;
  47         int flags;
  48         MonoSemType registered;
  49         HANDLE handle;
  50 } StartInfo;
  51
  52 static void*
  53 inner_start_thread (void *arg)
  54 {
  55         StartInfo *start_info = (StartInfo *) arg;
  56         void *t_arg = start_info->arg;
  57         int res;
  58         void *(*start_func)(void*) = start_info->start_routine;
  59         guint32 flags = start_info->flags;
  60         void *result;
  61         HANDLE handle;
  62         MonoThreadInfo *info;
  63
  64         /* Register the thread with the io-layer */
  65         handle = wapi_create_thread_handle ();
  66         if (!handle) {
  67                 res = MONO_SEM_POST (&(start_info->registered));
  68                 g_assert (!res);
  69                 return NULL;
  70         }
  71         start_info->handle = handle;
  72
  73         info = mono_thread_info_attach (&result);
  74         MONO_PREPARE_BLOCKING
  75
  76         info->runtime_thread = TRUE;
  77         info->handle = handle;
  78
  79         if (flags & CREATE_SUSPENDED) {
  80                 info->create_suspended = TRUE;
  81                 MONO_SEM_INIT (&info->create_suspended_sem, 0);
  82         }
  83
  84         /* start_info is not valid after this */
  85         res = MONO_SEM_POST (&(start_info->registered));
  86         g_assert (!res);
  87         start_info = NULL;
  88
  89         if (flags & CREATE_SUSPENDED) {
  90                 while (MONO_SEM_WAIT (&info->create_suspended_sem) != 0 &&
  91                            errno == EINTR);
  92                 MONO_SEM_DESTROY (&info->create_suspended_sem);
  93         }
  94
  95         MONO_FINISH_BLOCKING
  96         /* Run the actual main function of the thread */
  97         result = start_func (t_arg);
  98
  99         mono_threads_core_exit (GPOINTER_TO_UINT (result));
 100         g_assert_not_reached ();
 101 }
 102
 103 HANDLE
 104 mono_threads_core_create_thread (LPTHREAD_START_ROUTINE start_routine, gpointer arg, guint32 stack_size, guint32 creation_flags, MonoNativeThreadId *out_tid)
 105 {
 106         pthread_attr_t attr;
 107         int res;
 108         pthread_t thread;
 109         StartInfo start_info;
 110
 111         res = pthread_attr_init (&attr);
 112         g_assert (!res);
 113
 114         if (stack_size == 0) {
 115 #if HAVE_VALGRIND_MEMCHECK_H
 116                 if (RUNNING_ON_VALGRIND)
 117                         stack_size = 1 << 20;
 118                 else
 119                         stack_size = (SIZEOF_VOID_P / 4) * 1024 * 1024;
 120 #else
 121                 stack_size = (SIZEOF_VOID_P / 4) * 1024 * 1024;
 122 #endif
 123         }
 124
 125 #ifdef PTHREAD_STACK_MIN
 126         if (stack_size < PTHREAD_STACK_MIN)
 127                 stack_size = PTHREAD_STACK_MIN;
 128 #endif
 129
 130 #ifdef HAVE_PTHREAD_ATTR_SETSTACKSIZE
 131         res = pthread_attr_setstacksize (&attr, stack_size);
 132         g_assert (!res);
 133 #endif
 134
 135         memset (&start_info, 0, sizeof (StartInfo));
 136         start_info.start_routine = (void *(*)(void *)) start_routine;
 137         start_info.arg = arg;
 138         start_info.flags = creation_flags;
 139         MONO_SEM_INIT (&(start_info.registered), 0);
 140
 141         /* Actually start the thread */
 142         res = mono_gc_pthread_create (&thread, &attr, inner_start_thread, &start_info);
 143         if (res) {
 144                 MONO_SEM_DESTROY (&(start_info.registered));
 145                 return NULL;
 146         }
 147
 148         /* Wait until the thread register itself in various places */
 149         while (MONO_SEM_WAIT (&(start_info.registered)) != 0) {
 150                 /*if (EINTR != errno) ABORT("sem_wait failed"); */
 151         }
 152         MONO_SEM_DESTROY (&(start_info.registered));
 153
 154         if (out_tid)
 155                 *out_tid = thread;
 156
 157         return start_info.handle;
 158 }
 159
 160 /*
 161  * mono_threads_core_resume_created:
 162  *
 163  *   Resume a newly created thread created using CREATE_SUSPENDED.
 164  */
 165 void
 166 mono_threads_core_resume_created (MonoThreadInfo *info, MonoNativeThreadId tid)
 167 {
 168         MONO_SEM_POST (&info->create_suspended_sem);
 169 }
 170
 171 gboolean
 172 mono_threads_core_yield (void)
 173 {
 174         return sched_yield () == 0;
 175 }
 176
 177 void
 178 mono_threads_core_exit (int exit_code)
 179 {
 180         MonoThreadInfo *current = mono_thread_info_current ();
 181
 182 #if defined(__native_client__)
 183         nacl_shutdown_gc_thread();
 184 #endif
 185
 186         wapi_thread_handle_set_exited (current->handle, exit_code);
 187
 188         mono_thread_info_detach ();
 189
 190         pthread_exit (NULL);
 191 }
 192
 193 void
 194 mono_threads_core_unregister (MonoThreadInfo *info)
 195 {
 196         if (info->handle) {
 197                 wapi_thread_handle_set_exited (info->handle, 0);
 198                 info->handle = NULL;
 199         }
 200 }
 201
 202 HANDLE
 203 mono_threads_core_open_handle (void)
 204 {
 205         MonoThreadInfo *info;
 206
 207         info = mono_thread_info_current ();
 208         g_assert (info);
 209
 210         if (!info->handle)
 211                 info->handle = wapi_create_thread_handle ();
 212         else
 213                 wapi_ref_thread_handle (info->handle);
 214         return info->handle;
 215 }
 216
 217 int
 218 mono_threads_get_max_stack_size (void)
 219 {
 220         struct rlimit lim;
 221
 222         /* If getrlimit fails, we don't enforce any limits. */
 223         if (getrlimit (RLIMIT_STACK, &lim))
 224                 return INT_MAX;
 225         /* rlim_t is an unsigned long long on 64bits OSX but we want an int response. */
 226         if (lim.rlim_max > (rlim_t)INT_MAX)
 227                 return INT_MAX;
 228         return (int)lim.rlim_max;
 229 }
 230
 231 HANDLE
 232 mono_threads_core_open_thread_handle (HANDLE handle, MonoNativeThreadId tid)
 233 {
 234         wapi_ref_thread_handle (handle);
 235
 236         return handle;
 237 }
 238
 239 gpointer
 240 mono_threads_core_prepare_interrupt (HANDLE thread_handle)
 241 {
 242         return wapi_prepare_interrupt_thread (thread_handle);
 243 }
 244
 245 void
 246 mono_threads_core_finish_interrupt (gpointer wait_handle)
 247 {
 248         wapi_finish_interrupt_thread (wait_handle);
 249 }
 250
 251 void
 252 mono_threads_core_self_interrupt (void)
 253 {
 254         wapi_self_interrupt ();
 255 }
 256
 257 void
 258 mono_threads_core_clear_interruption (void)
 259 {
 260         wapi_clear_interruption ();
 261 }
 262
 263 int
 264 mono_threads_pthread_kill (MonoThreadInfo *info, int signum)
 265 {
 266         THREADS_SUSPEND_DEBUG ("sending signal %d to %p[%p]\n", signum, info, mono_thread_info_get_tid (info));
 267 #ifdef USE_TKILL_ON_ANDROID
 268         int result, old_errno = errno;
 269         result = tkill (info->native_handle, signum);
 270         if (result < 0) {
 271                 result = errno;
 272                 errno = old_errno;
 273         }
 274         return result;
 275 #elif defined(__native_client__)
 276         /* Workaround pthread_kill abort() in NaCl glibc. */
 277         return 0;
 278 #else
 279         return pthread_kill (mono_thread_info_get_tid (info), signum);
 280 #endif
 281 }
 282
 283 MonoNativeThreadId
 284 mono_native_thread_id_get (void)
 285 {
 286         return pthread_self ();
 287 }
 288
 289 gboolean
 290 mono_native_thread_id_equals (MonoNativeThreadId id1, MonoNativeThreadId id2)
 291 {
 292         return pthread_equal (id1, id2);
 293 }
 294
 295 /*
 296  * mono_native_thread_create:
 297  *
 298  *   Low level thread creation function without any GC wrappers.
 299  */
 300 gboolean
 301 mono_native_thread_create (MonoNativeThreadId *tid, gpointer func, gpointer arg)
 302 {
 303         return pthread_create (tid, NULL, (void *(*)(void *)) func, arg) == 0;
 304 }
 305
 306 void
 307 mono_threads_core_set_name (MonoNativeThreadId tid, const char *name)
 308 {
 309 #if defined (HAVE_PTHREAD_SETNAME_NP) && !defined (__MACH__)
 310         if (!name) {
 311                 pthread_setname_np (tid, "");
 312         } else {
 313                 char n [16];
 314
 315                 strncpy (n, name, 16);
 316                 n [15] = '\0';
 317                 pthread_setname_np (tid, n);
 318         }
 319 #endif
 320 }
 321
 322
 323 #if defined (USE_POSIX_BACKEND) && !defined (USE_COOP_GC)
 324
 325 static int suspend_signal_num;
 326 static int restart_signal_num;
 327 static int abort_signal_num;
 328 static sigset_t suspend_signal_mask;
 329 static sigset_t suspend_ack_signal_mask;
 330
 331
 332 #if defined(__APPLE__) || defined(__OpenBSD__) || defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
 333 #define DEFAULT_SUSPEND_SIGNAL SIGXFSZ
 334 #else
 335 #define DEFAULT_SUSPEND_SIGNAL SIGPWR
 336 #endif
 337 #define DEFAULT_RESTART_SIGNAL SIGXCPU
 338
 339 static int
 340 mono_thread_search_alt_signal (int min_signal)
 341 {
 342 #if !defined (SIGRTMIN)
 343         g_error ("signal search only works with RTMIN");
 344 #else
 345         int i;
 346         /* we try to avoid SIGRTMIN and any one that might have been set already, see bug #75387 */
 347         for (i = MAX (min_signal, SIGRTMIN) + 1; i < SIGRTMAX; ++i) {
 348                 struct sigaction sinfo;
 349                 sigaction (i, NULL, &sinfo);
 350                 if (sinfo.sa_handler == SIG_DFL && (void*)sinfo.sa_sigaction == (void*)SIG_DFL) {
 351                         return i;
 352                 }
 353         }
 354         g_error ("Could not find an available signal");
 355 #endif
 356 }
 357
 358 static int
 359 mono_thread_get_alt_suspend_signal (void)
 360 {
 361 #if defined(PLATFORM_ANDROID)
 362         return SIGUNUSED;
 363 #elif !defined (SIGRTMIN)
 364 #ifdef SIGUSR1
 365         return SIGUSR1;
 366 #else
 367         return -1;
 368 #endif /* SIGUSR1 */
 369 #else
 370         static int suspend_signum = -1;
 371         if (suspend_signum == -1)
 372                 suspend_signum = mono_thread_search_alt_signal (-1);
 373         return suspend_signum;
 374 #endif /* SIGRTMIN */
 375 }
 376
 377 static int
 378 mono_thread_get_alt_resume_signal (void)
 379 {
 380 #if defined(PLATFORM_ANDROID)
 381         return SIGTTOU;
 382 #elif !defined (SIGRTMIN)
 383 #ifdef SIGUSR2
 384         return SIGUSR2;
 385 #else
 386         return -1;
 387 #endif /* SIGUSR1 */
 388 #else
 389         static int resume_signum = -1;
 390         if (resume_signum == -1)
 391                 resume_signum = mono_thread_search_alt_signal (mono_thread_get_alt_suspend_signal () + 1);
 392         return resume_signum;
 393 #endif /* SIGRTMIN */
 394 }
 395
 396
 397 static int
 398 mono_threads_get_abort_signal (void)
 399 {
 400 #if defined(PLATFORM_ANDROID)
 401         return SIGTTIN;
 402 #elif !defined (SIGRTMIN)
 403 #ifdef SIGTTIN
 404         return SIGTTIN;
 405 #else
 406         return -1;
 407 #endif /* SIGRTMIN */
 408 #else
 409         static int abort_signum = -1;
 410         if (abort_signum == -1)
 411                 abort_signum = mono_thread_search_alt_signal (mono_thread_get_alt_resume_signal () + 1);
 412         return abort_signum;
 413 #endif /* SIGRTMIN */
 414 }
 415
 416
 417 #if !defined(__native_client__)
 418 static void
 419 restart_signal_handler (int _dummy, siginfo_t *_info, void *context)
 420 {
 421         MonoThreadInfo *info;
 422         int old_errno = errno;
 423
 424         info = mono_thread_info_current ();
 425         info->signal = restart_signal_num;
 426         errno = old_errno;
 427 }
 428
 429 static void
 430 suspend_signal_handler (int _dummy, siginfo_t *info, void *context)
 431 {
 432         int old_errno = errno;
 433         int hp_save_index = mono_hazard_pointer_save_for_signal_handler ();
 434
 435
 436         MonoThreadInfo *current = mono_thread_info_current ();
 437         gboolean ret;
 438
 439         THREADS_SUSPEND_DEBUG ("SIGNAL HANDLER FOR %p [%p]\n", current, (void*)current->native_handle);
 440         if (current->syscall_break_signal) {
 441                 current->syscall_break_signal = FALSE;
 442                 THREADS_SUSPEND_DEBUG ("\tsyscall break for %p\n", current);
 443                 mono_threads_notify_initiator_of_abort (current);
 444                 goto done;
 445         }
 446
 447         /* Have we raced with self suspend? */
 448         if (!mono_threads_transition_finish_async_suspend (current)) {
 449                 current->suspend_can_continue = TRUE;
 450                 THREADS_SUSPEND_DEBUG ("\tlost race with self suspend %p\n", current);
 451                 goto done;
 452         }
 453
 454         ret = mono_threads_get_runtime_callbacks ()->thread_state_init_from_sigctx (&current->thread_saved_state [ASYNC_SUSPEND_STATE_INDEX], context);
 455
 456         /* thread_state_init_from_sigctx return FALSE if the current thread is detaching and suspend can't continue. */
 457         current->suspend_can_continue = ret;
 458
 459
 460         /*
 461         Block the restart signal.
 462         We need to block the restart signal while posting to the suspend_ack semaphore or we race to sigsuspend,
 463         which might miss the signal and get stuck.
 464         */
 465         pthread_sigmask (SIG_BLOCK, &suspend_ack_signal_mask, NULL);
 466
 467         /* We're done suspending */
 468         mono_threads_notify_initiator_of_suspend (current);
 469
 470         /* This thread is doomed, all we can do is give up and let the suspender recover. */
 471         if (!ret) {
 472                 THREADS_SUSPEND_DEBUG ("\tThread is dying, failed to capture state %p\n", current);
 473                 mono_threads_transition_async_suspend_compensation (current);
 474                 /* Unblock the restart signal. */
 475                 pthread_sigmask (SIG_UNBLOCK, &suspend_ack_signal_mask, NULL);
 476
 477                 goto done;
 478         }
 479
 480         do {
 481                 current->signal = 0;
 482                 sigsuspend (&suspend_signal_mask);
 483         } while (current->signal != restart_signal_num);
 484
 485         /* Unblock the restart signal. */
 486         pthread_sigmask (SIG_UNBLOCK, &suspend_ack_signal_mask, NULL);
 487
 488         if (current->async_target) {
 489 #if MONO_ARCH_HAS_MONO_CONTEXT
 490                 MonoContext tmp = current->thread_saved_state [ASYNC_SUSPEND_STATE_INDEX].ctx;
 491                 mono_threads_get_runtime_callbacks ()->setup_async_callback (&tmp, current->async_target, current->user_data);
 492                 current->async_target = current->user_data = NULL;
 493                 mono_monoctx_to_sigctx (&tmp, context);
 494 #else
 495                 g_error ("The new interruption machinery requires a working mono-context");
 496 #endif
 497         }
 498
 499         /* We're done resuming */
 500         mono_threads_notify_initiator_of_resume (current);
 501
 502 done:
 503         mono_hazard_pointer_restore_for_signal_handler (hp_save_index);
 504         errno = old_errno;
 505 }
 506
 507 static void
 508 abort_signal_handler (int _dummy, siginfo_t *info, void *context)
 509 {
 510         suspend_signal_handler (_dummy, info, context);
 511 }
 512
 513 #endif
 514
 515 static void
 516 mono_posix_add_signal_handler (int signo, gpointer handler, int flags)
 517 {
 518 #if !defined(__native_client__)
 519         /*FIXME, move the code from mini to utils and do the right thing!*/
 520         struct sigaction sa;
 521         struct sigaction previous_sa;
 522         int ret;
 523
 524         sa.sa_sigaction = handler;
 525         sigfillset (&sa.sa_mask);
 526
 527         sa.sa_flags = SA_SIGINFO | flags;
 528         ret = sigaction (signo, &sa, &previous_sa);
 529
 530         g_assert (ret != -1);
 531 #endif
 532 }
 533
 534 void
 535 mono_threads_init_platform (void)
 536 {
 537         sigset_t signal_set;
 538
 539         abort_signal_num = mono_threads_get_abort_signal ();
 540         if (mono_thread_info_unified_management_enabled ()) {
 541                 suspend_signal_num = DEFAULT_SUSPEND_SIGNAL;
 542                 restart_signal_num = DEFAULT_RESTART_SIGNAL;
 543         } else {
 544                 suspend_signal_num = mono_thread_get_alt_suspend_signal ();
 545                 restart_signal_num = mono_thread_get_alt_resume_signal ();
 546         }
 547
 548         sigfillset (&suspend_signal_mask);
 549         sigdelset (&suspend_signal_mask, restart_signal_num);
 550
 551         sigemptyset (&suspend_ack_signal_mask);
 552         sigaddset (&suspend_ack_signal_mask, restart_signal_num);
 553
 554         mono_posix_add_signal_handler (suspend_signal_num, suspend_signal_handler, SA_RESTART);
 555         mono_posix_add_signal_handler (restart_signal_num, restart_signal_handler, SA_RESTART);
 556         mono_posix_add_signal_handler (abort_signal_num, abort_signal_handler, 0);
 557
 558         /* ensure all the new signals are unblocked */
 559         sigemptyset (&signal_set);
 560         sigaddset (&signal_set, suspend_signal_num);
 561         sigaddset (&signal_set, restart_signal_num);
 562         sigaddset (&signal_set, abort_signal_num);
 563         sigprocmask (SIG_UNBLOCK, &signal_set, NULL);
 564 }
 565
 566 void
 567 mono_threads_core_abort_syscall (MonoThreadInfo *info)
 568 {
 569         /*
 570         We signal a thread to break it from the urrent syscall.
 571         This signal should not be interpreted as a suspend request.
 572         */
 573         info->syscall_break_signal = TRUE;
 574         if (!mono_threads_pthread_kill (info, abort_signal_num))
 575                 mono_threads_add_to_pending_operation_set (info);
 576 }
 577
 578 gboolean
 579 mono_threads_core_needs_abort_syscall (void)
 580 {
 581         return TRUE;
 582 }
 583
 584 gboolean
 585 mono_threads_core_begin_async_suspend (MonoThreadInfo *info, gboolean interrupt_kernel)
 586 {
 587         int sig = interrupt_kernel ? abort_signal_num :  suspend_signal_num;
 588
 589         if (!mono_threads_pthread_kill (info, sig)) {
 590                 mono_threads_add_to_pending_operation_set (info);
 591                 return TRUE;
 592         }
 593         return FALSE;
 594 }
 595
 596 gboolean
 597 mono_threads_core_check_suspend_result (MonoThreadInfo *info)
 598 {
 599         return info->suspend_can_continue;
 600 }
 601
 602 /*
 603 This begins async resume. This function must do the following:
 604
 605 - Install an async target if one was requested.
 606 - Notify the target to resume.
 607 */
 608 gboolean
 609 mono_threads_core_begin_async_resume (MonoThreadInfo *info)
 610 {
 611         mono_threads_add_to_pending_operation_set (info);
 612         return mono_threads_pthread_kill (info, restart_signal_num) == 0;
 613 }
 614
 615 void
 616 mono_threads_platform_register (MonoThreadInfo *info)
 617 {
 618 #if defined (PLATFORM_ANDROID)
 619         info->native_handle = gettid ();
 620 #endif
 621 }
 622
 623 void
 624 mono_threads_platform_free (MonoThreadInfo *info)
 625 {
 626 }
 627
 628 void
 629 mono_threads_core_begin_global_suspend (void)
 630 {
 631 }
 632
 633 void
 634 mono_threads_core_end_global_suspend (void)
 635 {
 636 }
 637
 638 #endif /*defined (USE_POSIX_BACKEND)*/
 639
 640 #endif