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