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 int
 240 mono_threads_pthread_kill (MonoThreadInfo *info, int signum)
 241 {
 242         THREADS_SUSPEND_DEBUG ("sending signal %d to %p[%p]\n", signum, info, mono_thread_info_get_tid (info));
 243 #ifdef USE_TKILL_ON_ANDROID
 244         int result, old_errno = errno;
 245         result = tkill (info->native_handle, signum);
 246         if (result < 0) {
 247                 result = errno;
 248                 errno = old_errno;
 249         }
 250         return result;
 251 #elif defined(__native_client__)
 252         /* Workaround pthread_kill abort() in NaCl glibc. */
 253         return 0;
 254 #else
 255         return pthread_kill (mono_thread_info_get_tid (info), signum);
 256 #endif
 257 }
 258
 259 MonoNativeThreadId
 260 mono_native_thread_id_get (void)
 261 {
 262         return pthread_self ();
 263 }
 264
 265 gboolean
 266 mono_native_thread_id_equals (MonoNativeThreadId id1, MonoNativeThreadId id2)
 267 {
 268         return pthread_equal (id1, id2);
 269 }
 270
 271 /*
 272  * mono_native_thread_create:
 273  *
 274  *   Low level thread creation function without any GC wrappers.
 275  */
 276 gboolean
 277 mono_native_thread_create (MonoNativeThreadId *tid, gpointer func, gpointer arg)
 278 {
 279         return pthread_create (tid, NULL, (void *(*)(void *)) func, arg) == 0;
 280 }
 281
 282 void
 283 mono_threads_core_set_name (MonoNativeThreadId tid, const char *name)
 284 {
 285 #if defined (HAVE_PTHREAD_SETNAME_NP) && !defined (__MACH__)
 286         if (!name) {
 287                 pthread_setname_np (tid, "");
 288         } else {
 289                 char n [16];
 290
 291                 strncpy (n, name, 16);
 292                 n [15] = '\0';
 293                 pthread_setname_np (tid, n);
 294         }
 295 #endif
 296 }
 297
 298
 299 #if defined (USE_POSIX_BACKEND) && !defined (USE_COOP_GC)
 300
 301 static int suspend_signal_num;
 302 static int restart_signal_num;
 303 static int abort_signal_num;
 304 static sigset_t suspend_signal_mask;
 305 static sigset_t suspend_ack_signal_mask;
 306
 307
 308 #if defined(__APPLE__) || defined(__OpenBSD__) || defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
 309 #define DEFAULT_SUSPEND_SIGNAL SIGXFSZ
 310 #else
 311 #define DEFAULT_SUSPEND_SIGNAL SIGPWR
 312 #endif
 313 #define DEFAULT_RESTART_SIGNAL SIGXCPU
 314
 315 static int
 316 mono_thread_search_alt_signal (int min_signal)
 317 {
 318 #if !defined (SIGRTMIN)
 319         g_error ("signal search only works with RTMIN");
 320 #else
 321         int i;
 322         /* we try to avoid SIGRTMIN and any one that might have been set already, see bug #75387 */
 323         for (i = MAX (min_signal, SIGRTMIN) + 1; i < SIGRTMAX; ++i) {
 324                 struct sigaction sinfo;
 325                 sigaction (i, NULL, &sinfo);
 326                 if (sinfo.sa_handler == SIG_DFL && (void*)sinfo.sa_sigaction == (void*)SIG_DFL) {
 327                         return i;
 328                 }
 329         }
 330         g_error ("Could not find an available signal");
 331 #endif
 332 }
 333
 334 static int
 335 mono_thread_get_alt_suspend_signal (void)
 336 {
 337 #if defined(PLATFORM_ANDROID)
 338         return SIGUNUSED;
 339 #elif !defined (SIGRTMIN)
 340 #ifdef SIGUSR1
 341         return SIGUSR1;
 342 #else
 343         return -1;
 344 #endif /* SIGUSR1 */
 345 #else
 346         static int suspend_signum = -1;
 347         if (suspend_signum == -1)
 348                 suspend_signum = mono_thread_search_alt_signal (-1);
 349         return suspend_signum;
 350 #endif /* SIGRTMIN */
 351 }
 352
 353 static int
 354 mono_thread_get_alt_resume_signal (void)
 355 {
 356 #if defined(PLATFORM_ANDROID)
 357         return SIGTTOU;
 358 #elif !defined (SIGRTMIN)
 359 #ifdef SIGUSR2
 360         return SIGUSR2;
 361 #else
 362         return -1;
 363 #endif /* SIGUSR1 */
 364 #else
 365         static int resume_signum = -1;
 366         if (resume_signum == -1)
 367                 resume_signum = mono_thread_search_alt_signal (mono_thread_get_alt_suspend_signal () + 1);
 368         return resume_signum;
 369 #endif /* SIGRTMIN */
 370 }
 371
 372
 373 static int
 374 mono_threads_get_abort_signal (void)
 375 {
 376 #if defined(PLATFORM_ANDROID)
 377         return SIGTTIN;
 378 #elif !defined (SIGRTMIN)
 379 #ifdef SIGTTIN
 380         return SIGTTIN;
 381 #else
 382         return -1;
 383 #endif /* SIGRTMIN */
 384 #else
 385         static int abort_signum = -1;
 386         if (abort_signum == -1)
 387                 abort_signum = mono_thread_search_alt_signal (mono_thread_get_alt_resume_signal () + 1);
 388         return abort_signum;
 389 #endif /* SIGRTMIN */
 390 }
 391
 392
 393 #if !defined(__native_client__)
 394 static void
 395 restart_signal_handler (int _dummy, siginfo_t *_info, void *context)
 396 {
 397         MonoThreadInfo *info;
 398         int old_errno = errno;
 399
 400         info = mono_thread_info_current ();
 401         info->signal = restart_signal_num;
 402         errno = old_errno;
 403 }
 404
 405 static void
 406 suspend_signal_handler (int _dummy, siginfo_t *info, void *context)
 407 {
 408         int old_errno = errno;
 409         int hp_save_index = mono_hazard_pointer_save_for_signal_handler ();
 410
 411
 412         MonoThreadInfo *current = mono_thread_info_current ();
 413         gboolean ret;
 414
 415         THREADS_SUSPEND_DEBUG ("SIGNAL HANDLER FOR %p [%p]\n", current, (void*)current->native_handle);
 416         if (current->syscall_break_signal) {
 417                 current->syscall_break_signal = FALSE;
 418                 THREADS_SUSPEND_DEBUG ("\tsyscall break for %p\n", current);
 419                 mono_threads_notify_initiator_of_abort (current);
 420                 goto done;
 421         }
 422
 423         /* Have we raced with self suspend? */
 424         if (!mono_threads_transition_finish_async_suspend (current)) {
 425                 current->suspend_can_continue = TRUE;
 426                 THREADS_SUSPEND_DEBUG ("\tlost race with self suspend %p\n", current);
 427                 goto done;
 428         }
 429
 430         ret = mono_threads_get_runtime_callbacks ()->thread_state_init_from_sigctx (&current->thread_saved_state [ASYNC_SUSPEND_STATE_INDEX], context);
 431
 432         /* thread_state_init_from_sigctx return FALSE if the current thread is detaching and suspend can't continue. */
 433         current->suspend_can_continue = ret;
 434
 435
 436         /*
 437         Block the restart signal.
 438         We need to block the restart signal while posting to the suspend_ack semaphore or we race to sigsuspend,
 439         which might miss the signal and get stuck.
 440         */
 441         pthread_sigmask (SIG_BLOCK, &suspend_ack_signal_mask, NULL);
 442
 443         /* We're done suspending */
 444         mono_threads_notify_initiator_of_suspend (current);
 445
 446         /* This thread is doomed, all we can do is give up and let the suspender recover. */
 447         if (!ret) {
 448                 THREADS_SUSPEND_DEBUG ("\tThread is dying, failed to capture state %p\n", current);
 449                 mono_threads_transition_async_suspend_compensation (current);
 450                 /* Unblock the restart signal. */
 451                 pthread_sigmask (SIG_UNBLOCK, &suspend_ack_signal_mask, NULL);
 452
 453                 goto done;
 454         }
 455
 456         do {
 457                 current->signal = 0;
 458                 sigsuspend (&suspend_signal_mask);
 459         } while (current->signal != restart_signal_num);
 460
 461         /* Unblock the restart signal. */
 462         pthread_sigmask (SIG_UNBLOCK, &suspend_ack_signal_mask, NULL);
 463
 464         if (current->async_target) {
 465 #if MONO_ARCH_HAS_MONO_CONTEXT
 466                 MonoContext tmp = current->thread_saved_state [ASYNC_SUSPEND_STATE_INDEX].ctx;
 467                 mono_threads_get_runtime_callbacks ()->setup_async_callback (&tmp, current->async_target, current->user_data);
 468                 current->async_target = current->user_data = NULL;
 469                 mono_monoctx_to_sigctx (&tmp, context);
 470 #else
 471                 g_error ("The new interruption machinery requires a working mono-context");
 472 #endif
 473         }
 474
 475         /* We're done resuming */
 476         mono_threads_notify_initiator_of_resume (current);
 477
 478 done:
 479         mono_hazard_pointer_restore_for_signal_handler (hp_save_index);
 480         errno = old_errno;
 481 }
 482
 483 static void
 484 abort_signal_handler (int _dummy, siginfo_t *info, void *context)
 485 {
 486         suspend_signal_handler (_dummy, info, context);
 487 }
 488
 489 #endif
 490
 491 static void
 492 mono_posix_add_signal_handler (int signo, gpointer handler, int flags)
 493 {
 494 #if !defined(__native_client__)
 495         /*FIXME, move the code from mini to utils and do the right thing!*/
 496         struct sigaction sa;
 497         struct sigaction previous_sa;
 498         int ret;
 499
 500         sa.sa_sigaction = handler;
 501         sigfillset (&sa.sa_mask);
 502
 503         sa.sa_flags = SA_SIGINFO | flags;
 504         ret = sigaction (signo, &sa, &previous_sa);
 505
 506         g_assert (ret != -1);
 507 #endif
 508 }
 509
 510 void
 511 mono_threads_init_platform (void)
 512 {
 513         sigset_t signal_set;
 514
 515         abort_signal_num = mono_threads_get_abort_signal ();
 516         if (mono_thread_info_unified_management_enabled ()) {
 517                 suspend_signal_num = DEFAULT_SUSPEND_SIGNAL;
 518                 restart_signal_num = DEFAULT_RESTART_SIGNAL;
 519         } else {
 520                 suspend_signal_num = mono_thread_get_alt_suspend_signal ();
 521                 restart_signal_num = mono_thread_get_alt_resume_signal ();
 522         }
 523
 524         sigfillset (&suspend_signal_mask);
 525         sigdelset (&suspend_signal_mask, restart_signal_num);
 526
 527         sigemptyset (&suspend_ack_signal_mask);
 528         sigaddset (&suspend_ack_signal_mask, restart_signal_num);
 529
 530         mono_posix_add_signal_handler (suspend_signal_num, suspend_signal_handler, SA_RESTART);
 531         mono_posix_add_signal_handler (restart_signal_num, restart_signal_handler, SA_RESTART);
 532         mono_posix_add_signal_handler (abort_signal_num, abort_signal_handler, 0);
 533
 534         /* ensure all the new signals are unblocked */
 535         sigemptyset (&signal_set);
 536         sigaddset (&signal_set, suspend_signal_num);
 537         sigaddset (&signal_set, restart_signal_num);
 538         sigaddset (&signal_set, abort_signal_num);
 539         sigprocmask (SIG_UNBLOCK, &signal_set, NULL);
 540 }
 541
 542 void
 543 mono_threads_core_abort_syscall (MonoThreadInfo *info)
 544 {
 545         /*
 546         We signal a thread to break it from the urrent syscall.
 547         This signal should not be interpreted as a suspend request.
 548         */
 549         info->syscall_break_signal = TRUE;
 550         if (!mono_threads_pthread_kill (info, abort_signal_num))
 551                 mono_threads_add_to_pending_operation_set (info);
 552 }
 553
 554 gboolean
 555 mono_threads_core_needs_abort_syscall (void)
 556 {
 557         return TRUE;
 558 }
 559
 560 gboolean
 561 mono_threads_core_begin_async_suspend (MonoThreadInfo *info, gboolean interrupt_kernel)
 562 {
 563         int sig = interrupt_kernel ? abort_signal_num :  suspend_signal_num;
 564
 565         if (!mono_threads_pthread_kill (info, sig)) {
 566                 mono_threads_add_to_pending_operation_set (info);
 567                 return TRUE;
 568         }
 569         return FALSE;
 570 }
 571
 572 gboolean
 573 mono_threads_core_check_suspend_result (MonoThreadInfo *info)
 574 {
 575         return info->suspend_can_continue;
 576 }
 577
 578 /*
 579 This begins async resume. This function must do the following:
 580
 581 - Install an async target if one was requested.
 582 - Notify the target to resume.
 583 */
 584 gboolean
 585 mono_threads_core_begin_async_resume (MonoThreadInfo *info)
 586 {
 587         mono_threads_add_to_pending_operation_set (info);
 588         return mono_threads_pthread_kill (info, restart_signal_num) == 0;
 589 }
 590
 591 void
 592 mono_threads_platform_register (MonoThreadInfo *info)
 593 {
 594 #if defined (PLATFORM_ANDROID)
 595         info->native_handle = gettid ();
 596 #endif
 597 }
 598
 599 void
 600 mono_threads_platform_free (MonoThreadInfo *info)
 601 {
 602 }
 603
 604 void
 605 mono_threads_core_begin_global_suspend (void)
 606 {
 607 }
 608
 609 void
 610 mono_threads_core_end_global_suspend (void)
 611 {
 612 }
 613
 614 #endif /*defined (USE_POSIX_BACKEND)*/
 615
 616 #endif