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