2 * mini-posix.c: POSIX signal handling support for Mono.
5 * Mono Team (mono-list@lists.ximian.com)
7 * Copyright 2001-2003 Ximian, Inc.
8 * Copyright 2003-2008 Ximian, Inc.
9 * Copyright 2011 Xamarin, Inc (http://www.xamarin.com)
11 * See LICENSE for licensing information.
22 #ifdef HAVE_SYS_TIME_H
25 #ifdef HAVE_SYS_SYSCALL_H
26 #include <sys/syscall.h>
31 #include <mono/metadata/assembly.h>
32 #include <mono/metadata/loader.h>
33 #include <mono/metadata/tabledefs.h>
34 #include <mono/metadata/class.h>
35 #include <mono/metadata/object.h>
36 #include <mono/metadata/tokentype.h>
37 #include <mono/metadata/tabledefs.h>
38 #include <mono/metadata/threads.h>
39 #include <mono/metadata/appdomain.h>
40 #include <mono/metadata/debug-helpers.h>
41 #include <mono/io-layer/io-layer.h>
42 #include "mono/metadata/profiler.h"
43 #include <mono/metadata/profiler-private.h>
44 #include <mono/metadata/mono-config.h>
45 #include <mono/metadata/environment.h>
46 #include <mono/metadata/mono-debug.h>
47 #include <mono/metadata/gc-internal.h>
48 #include <mono/metadata/threads-types.h>
49 #include <mono/metadata/verify.h>
50 #include <mono/metadata/verify-internals.h>
51 #include <mono/metadata/mempool-internals.h>
52 #include <mono/metadata/attach.h>
53 #include <mono/utils/mono-math.h>
54 #include <mono/utils/mono-compiler.h>
55 #include <mono/utils/mono-counters.h>
56 #include <mono/utils/mono-logger-internal.h>
57 #include <mono/utils/mono-mmap.h>
58 #include <mono/utils/dtrace.h>
59 #include <mono/utils/mono-signal-handler.h>
60 #include <mono/utils/mono-threads.h>
67 #include "debugger-agent.h"
69 #include "jit-icalls.h"
71 #if defined(__native_client__)
74 mono_runtime_setup_stat_profiler (void)
76 printf("WARNING: mono_runtime_setup_stat_profiler() called!\n");
81 mono_runtime_shutdown_stat_profiler (void)
87 MONO_SIG_HANDLER_SIGNATURE (mono_chain_signal)
93 mono_runtime_install_handlers (void)
98 mono_runtime_shutdown_handlers (void)
103 mono_runtime_cleanup_handlers (void)
108 mono_runtime_syscall_fork (void)
110 g_assert_not_reached();
115 mono_gdb_render_native_backtraces (pid_t crashed_pid)
121 static GHashTable *mono_saved_signal_handlers = NULL;
124 get_saved_signal_handler (int signo)
126 if (mono_saved_signal_handlers)
127 /* The hash is only modified during startup, so no need for locking */
128 return g_hash_table_lookup (mono_saved_signal_handlers, GINT_TO_POINTER (signo));
133 save_old_signal_handler (int signo, struct sigaction *old_action)
135 struct sigaction *handler_to_save = g_malloc (sizeof (struct sigaction));
137 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_CONFIG,
138 "Saving old signal handler for signal %d.", signo);
140 if (! (old_action->sa_flags & SA_SIGINFO)) {
141 handler_to_save->sa_handler = old_action->sa_handler;
143 #ifdef MONO_ARCH_USE_SIGACTION
144 handler_to_save->sa_sigaction = old_action->sa_sigaction;
145 #endif /* MONO_ARCH_USE_SIGACTION */
147 handler_to_save->sa_mask = old_action->sa_mask;
148 handler_to_save->sa_flags = old_action->sa_flags;
150 if (!mono_saved_signal_handlers)
151 mono_saved_signal_handlers = g_hash_table_new (NULL, NULL);
152 g_hash_table_insert (mono_saved_signal_handlers, GINT_TO_POINTER (signo), handler_to_save);
156 free_saved_sig_handler_func (gpointer key, gpointer value, gpointer user_data)
162 free_saved_signal_handlers (void)
164 if (mono_saved_signal_handlers) {
165 g_hash_table_foreach (mono_saved_signal_handlers, free_saved_sig_handler_func, NULL);
166 g_hash_table_destroy (mono_saved_signal_handlers);
167 mono_saved_signal_handlers = NULL;
174 * Call the original signal handler for the signal given by the arguments, which
175 * should be the same as for a signal handler. Returns TRUE if the original handler
176 * was called, false otherwise.
179 MONO_SIG_HANDLER_SIGNATURE (mono_chain_signal)
181 int signal = MONO_SIG_HANDLER_GET_SIGNO ();
182 struct sigaction *saved_handler = get_saved_signal_handler (signal);
184 if (saved_handler && saved_handler->sa_handler) {
185 if (!(saved_handler->sa_flags & SA_SIGINFO)) {
186 saved_handler->sa_handler (signal);
188 #ifdef MONO_ARCH_USE_SIGACTION
189 saved_handler->sa_sigaction (MONO_SIG_HANDLER_PARAMS);
190 #endif /* MONO_ARCH_USE_SIGACTION */
197 MONO_SIG_HANDLER_FUNC (static, sigabrt_signal_handler)
199 MonoJitInfo *ji = NULL;
200 MONO_SIG_HANDLER_GET_CONTEXT;
202 if (mono_thread_internal_current ())
203 ji = mono_jit_info_table_find (mono_domain_get (), mono_arch_ip_from_context (ctx));
205 if (mono_chain_signal (MONO_SIG_HANDLER_PARAMS))
207 mono_handle_native_sigsegv (SIGABRT, ctx);
211 MONO_SIG_HANDLER_FUNC (static, sigusr1_signal_handler)
213 gboolean running_managed;
215 MonoInternalThread *thread = mono_thread_internal_current ();
216 MonoDomain *domain = mono_domain_get ();
218 MONO_SIG_HANDLER_GET_CONTEXT;
220 if (!thread || !domain) {
221 /* The thread might not have started up yet */
222 /* FIXME: Specify the synchronization with start_wrapper () in threads.c */
223 mono_debugger_agent_thread_interrupt (ctx, NULL);
227 if (thread->ignore_next_signal) {
228 thread->ignore_next_signal = FALSE;
232 if (thread->thread_dump_requested) {
233 thread->thread_dump_requested = FALSE;
235 mono_print_thread_dump (ctx);
239 * This is an async signal, so the code below must not call anything which
240 * is not async safe. That includes the pthread locking functions. If we
241 * know that we interrupted managed code, then locking is safe.
244 * On OpenBSD, ctx can be NULL if we are interrupting poll ().
247 ji = mono_jit_info_table_find (mono_domain_get (), mono_arch_ip_from_context(ctx));
248 running_managed = ji != NULL;
250 if (mono_debugger_agent_thread_interrupt (ctx, ji))
253 running_managed = FALSE;
256 /* We can't do handler block checking from metadata since it requires doing
257 * a stack walk with context.
259 * FIXME add full-aot support.
261 #ifdef MONO_ARCH_HAVE_SIGCTX_TO_MONOCTX
262 if (!mono_aot_only && ctx) {
263 MonoThreadUnwindState unwind_state;
264 if (mono_thread_state_init_from_sigctx (&unwind_state, ctx)) {
265 if (mono_install_handler_block_guard (&unwind_state)) {
267 /*Clear current thread from been wapi interrupted otherwise things can go south*/
268 wapi_clear_interruption ();
276 exc = mono_thread_request_interruption (running_managed);
280 mono_arch_handle_exception (ctx, exc);
284 #if defined(__i386__) || defined(__x86_64__)
285 #define FULL_STAT_PROFILER_BACKTRACE 1
286 #define CURRENT_FRAME_GET_BASE_POINTER(f) (* (gpointer*)(f))
287 #define CURRENT_FRAME_GET_RETURN_ADDRESS(f) (* (((gpointer*)(f)) + 1))
288 #if MONO_ARCH_STACK_GROWS_UP
289 #define IS_BEFORE_ON_STACK <
290 #define IS_AFTER_ON_STACK >
292 #define IS_BEFORE_ON_STACK >
293 #define IS_AFTER_ON_STACK <
296 #define FULL_STAT_PROFILER_BACKTRACE 0
300 #if defined(__ia64__) || defined(__sparc__) || defined(sparc) || defined(__s390__) || defined(s390)
302 MONO_SIG_HANDLER_FUNC (static, sigprof_signal_handler)
304 if (mono_chain_signal (MONO_SIG_HANDLER_PARAMS))
312 static int profiling_signal_in_use;
315 per_thread_profiler_hit (void *ctx)
317 int call_chain_depth = mono_profiler_stat_get_call_chain_depth ();
318 MonoProfilerCallChainStrategy call_chain_strategy = mono_profiler_stat_get_call_chain_strategy ();
320 if (call_chain_depth == 0) {
321 mono_profiler_stat_hit (mono_arch_ip_from_context (ctx), ctx);
323 MonoJitTlsData *jit_tls = mono_native_tls_get_value (mono_jit_tls_id);
324 int current_frame_index = 1;
325 MonoContext mono_context;
326 guchar *ips [call_chain_depth + 1];
328 mono_sigctx_to_monoctx (ctx, &mono_context);
329 ips [0] = MONO_CONTEXT_GET_IP (&mono_context);
331 if (jit_tls != NULL) {
332 if (call_chain_strategy == MONO_PROFILER_CALL_CHAIN_NATIVE) {
333 #if FULL_STAT_PROFILER_BACKTRACE
334 guchar *current_frame;
335 guchar *stack_bottom;
338 stack_bottom = jit_tls->end_of_stack;
339 stack_top = MONO_CONTEXT_GET_SP (&mono_context);
340 current_frame = MONO_CONTEXT_GET_BP (&mono_context);
342 while ((current_frame_index <= call_chain_depth) &&
343 (stack_bottom IS_BEFORE_ON_STACK (guchar*) current_frame) &&
344 ((guchar*) current_frame IS_BEFORE_ON_STACK stack_top)) {
345 ips [current_frame_index] = CURRENT_FRAME_GET_RETURN_ADDRESS (current_frame);
346 current_frame_index ++;
347 stack_top = current_frame;
348 current_frame = CURRENT_FRAME_GET_BASE_POINTER (current_frame);
351 call_chain_strategy = MONO_PROFILER_CALL_CHAIN_GLIBC;
355 if (call_chain_strategy == MONO_PROFILER_CALL_CHAIN_GLIBC) {
356 #if GLIBC_PROFILER_BACKTRACE
357 current_frame_index = backtrace ((void**) & ips [1], call_chain_depth);
359 call_chain_strategy = MONO_PROFILER_CALL_CHAIN_MANAGED;
363 if (call_chain_strategy == MONO_PROFILER_CALL_CHAIN_MANAGED) {
364 MonoDomain *domain = mono_domain_get ();
365 if (domain != NULL) {
369 MonoContext new_mono_context;
371 ji = mono_find_jit_info (domain, jit_tls, &res, NULL, &mono_context,
372 &new_mono_context, NULL, &lmf, &native_offset, NULL);
373 while ((ji != NULL) && (current_frame_index <= call_chain_depth)) {
374 ips [current_frame_index] = MONO_CONTEXT_GET_IP (&new_mono_context);
375 current_frame_index ++;
376 mono_context = new_mono_context;
377 ji = mono_find_jit_info (domain, jit_tls, &res, NULL, &mono_context,
378 &new_mono_context, NULL, &lmf, &native_offset, NULL);
384 mono_profiler_stat_call_chain (current_frame_index, & ips [0], ctx);
388 MONO_SIG_HANDLER_FUNC (static, sigprof_signal_handler)
390 MonoThreadInfo *info;
391 int old_errno = errno;
393 MONO_SIG_HANDLER_GET_CONTEXT;
395 if (mono_thread_info_get_small_id () == -1)
396 return; //an non-attached thread got the signal
398 if (!mono_domain_get () || !mono_native_tls_get_value (mono_jit_tls_id))
399 return; //thread in the process of dettaching
401 hp_save_index = mono_hazard_pointer_save_for_signal_handler ();
403 /* If we can't consume a profiling request it means we're the initiator. */
404 if (!(mono_threads_consume_async_jobs () & MONO_SERVICE_REQUEST_SAMPLE)) {
405 FOREACH_THREAD_SAFE (info) {
406 if (mono_thread_info_get_tid (info) == mono_native_thread_id_get ())
409 mono_threads_add_async_job (info, MONO_SERVICE_REQUEST_SAMPLE);
410 mono_threads_pthread_kill (info, profiling_signal_in_use);
411 } END_FOREACH_THREAD_SAFE;
414 mono_thread_info_set_is_async_context (TRUE);
415 per_thread_profiler_hit (ctx);
416 mono_thread_info_set_is_async_context (FALSE);
418 mono_hazard_pointer_restore_for_signal_handler (hp_save_index);
421 mono_chain_signal (MONO_SIG_HANDLER_PARAMS);
427 MONO_SIG_HANDLER_FUNC (static, sigquit_signal_handler)
430 MONO_SIG_HANDLER_GET_CONTEXT;
432 /* We use this signal to start the attach agent too */
433 res = mono_attach_start ();
437 if (mono_thread_info_new_interrupt_enabled ()) {
438 mono_threads_request_thread_dump ();
440 printf ("Full thread dump:\n");
442 mono_threads_request_thread_dump ();
445 * print_thread_dump () skips the current thread, since sending a signal
446 * to it would invoke the signal handler below the sigquit signal handler,
447 * and signal handlers don't create an lmf, so the stack walk could not
450 mono_print_thread_dump (ctx);
453 mono_chain_signal (MONO_SIG_HANDLER_PARAMS);
456 MONO_SIG_HANDLER_FUNC (static, sigusr2_signal_handler)
458 gboolean enabled = mono_trace_is_enabled ();
460 mono_trace_enable (!enabled);
462 mono_chain_signal (MONO_SIG_HANDLER_PARAMS);
466 add_signal_handler (int signo, gpointer handler)
469 struct sigaction previous_sa;
471 #ifdef MONO_ARCH_USE_SIGACTION
472 sa.sa_sigaction = handler;
473 sigemptyset (&sa.sa_mask);
474 sa.sa_flags = SA_SIGINFO;
475 #ifdef MONO_ARCH_SIGSEGV_ON_ALTSTACK
477 /*Apple likes to deliver SIGBUS for *0 */
479 if (signo == SIGSEGV || signo == SIGBUS) {
481 if (signo == SIGSEGV) {
483 sa.sa_flags |= SA_ONSTACK;
486 * libgc will crash when trying to do stack marking for threads which are on
487 * an altstack, so delay the suspend signal after the signal handler has
490 if (mono_gc_get_suspend_signal () != -1)
491 sigaddset (&sa.sa_mask, mono_gc_get_suspend_signal ());
494 if (signo == SIGSEGV) {
496 * Delay abort signals while handling SIGSEGVs since they could go unnoticed.
500 sigemptyset (&block_mask);
501 sigaddset (&sa.sa_mask, mono_thread_get_abort_signal ());
504 sa.sa_handler = handler;
505 sigemptyset (&sa.sa_mask);
508 g_assert (sigaction (signo, &sa, &previous_sa) != -1);
510 /* if there was already a handler in place for this signal, store it */
511 if (! (previous_sa.sa_flags & SA_SIGINFO) &&
512 (SIG_DFL == previous_sa.sa_handler)) {
513 /* it there is no sa_sigaction function and the sa_handler is default, we can safely ignore this */
515 if (mono_do_signal_chaining)
516 save_old_signal_handler (signo, &previous_sa);
521 remove_signal_handler (int signo)
524 struct sigaction *saved_action = get_saved_signal_handler (signo);
527 sa.sa_handler = SIG_DFL;
528 sigemptyset (&sa.sa_mask);
531 sigaction (signo, &sa, NULL);
533 g_assert (sigaction (signo, saved_action, NULL) != -1);
538 mono_runtime_posix_install_handlers (void)
543 if (mini_get_debug_options ()->handle_sigint)
544 add_signal_handler (SIGINT, mono_sigint_signal_handler);
546 add_signal_handler (SIGFPE, mono_sigfpe_signal_handler);
547 add_signal_handler (SIGQUIT, sigquit_signal_handler);
548 add_signal_handler (SIGILL, mono_sigill_signal_handler);
549 add_signal_handler (SIGBUS, mono_sigsegv_signal_handler);
550 if (mono_jit_trace_calls != NULL)
551 add_signal_handler (SIGUSR2, sigusr2_signal_handler);
553 if (!mono_thread_info_new_interrupt_enabled ())
554 add_signal_handler (mono_thread_get_abort_signal (), sigusr1_signal_handler);
555 /* it seems to have become a common bug for some programs that run as parents
556 * of many processes to block signal delivery for real time signals.
557 * We try to detect and work around their breakage here.
559 sigemptyset (&signal_set);
560 sigaddset (&signal_set, mono_thread_get_abort_signal ());
561 if (mono_gc_get_suspend_signal () != -1)
562 sigaddset (&signal_set, mono_gc_get_suspend_signal ());
563 if (mono_gc_get_restart_signal () != -1)
564 sigaddset (&signal_set, mono_gc_get_restart_signal ());
565 sigaddset (&signal_set, SIGCHLD);
566 sigprocmask (SIG_UNBLOCK, &signal_set, NULL);
568 signal (SIGPIPE, SIG_IGN);
570 add_signal_handler (SIGABRT, sigabrt_signal_handler);
573 add_signal_handler (SIGSEGV, mono_sigsegv_signal_handler);
576 #ifndef PLATFORM_MACOSX
578 mono_runtime_install_handlers (void)
580 mono_runtime_posix_install_handlers ();
585 mono_runtime_cleanup_handlers (void)
587 if (mini_get_debug_options ()->handle_sigint)
588 remove_signal_handler (SIGINT);
590 remove_signal_handler (SIGFPE);
591 remove_signal_handler (SIGQUIT);
592 remove_signal_handler (SIGILL);
593 remove_signal_handler (SIGBUS);
594 if (mono_jit_trace_calls != NULL)
595 remove_signal_handler (SIGUSR2);
597 remove_signal_handler (mono_thread_get_abort_signal ());
599 remove_signal_handler (SIGABRT);
601 remove_signal_handler (SIGSEGV);
603 free_saved_signal_handlers ();
606 #ifdef HAVE_LINUX_RTC_H
607 #include <linux/rtc.h>
608 #include <sys/ioctl.h>
610 static int rtc_fd = -1;
613 enable_rtc_timer (gboolean enable)
616 flags = fcntl (rtc_fd, F_GETFL);
625 if (fcntl (rtc_fd, F_SETFL, flags) == -1) {
634 mono_runtime_shutdown_stat_profiler (void)
636 #ifdef HAVE_LINUX_RTC_H
638 enable_rtc_timer (FALSE);
644 get_itimer_mode (void)
646 switch (mono_profiler_get_sampling_mode ()) {
647 case MONO_PROFILER_STAT_MODE_PROCESS: return ITIMER_PROF;
648 case MONO_PROFILER_STAT_MODE_REAL: return ITIMER_REAL;
650 g_assert_not_reached ();
655 get_itimer_signal (void)
657 switch (mono_profiler_get_sampling_mode ()) {
658 case MONO_PROFILER_STAT_MODE_PROCESS: return SIGPROF;
659 case MONO_PROFILER_STAT_MODE_REAL: return SIGALRM;
661 g_assert_not_reached ();
667 mono_runtime_setup_stat_profiler (void)
670 struct itimerval itval;
671 static int inited = 0;
672 #ifdef HAVE_LINUX_RTC_H
673 const char *rtc_freq;
674 if (!inited && (rtc_freq = g_getenv ("MONO_RTC"))) {
678 freq = atoi (rtc_freq);
681 rtc_fd = open ("/dev/rtc", O_RDONLY);
683 perror ("open /dev/rtc");
686 profiling_signal_in_use = SIGPROF;
687 add_signal_handler (profiling_signal_in_use, sigprof_signal_handler);
688 if (ioctl (rtc_fd, RTC_IRQP_SET, freq) == -1) {
689 perror ("set rtc freq");
692 if (ioctl (rtc_fd, RTC_PIE_ON, 0) == -1) {
693 perror ("start rtc");
696 if (fcntl (rtc_fd, F_SETSIG, SIGPROF) == -1) {
700 if (fcntl (rtc_fd, F_SETOWN, getpid ()) == -1) {
704 enable_rtc_timer (TRUE);
711 itval.it_interval.tv_usec = (1000000 / mono_profiler_get_sampling_rate ()) - 1;
712 itval.it_interval.tv_sec = 0;
713 itval.it_value = itval.it_interval;
717 profiling_signal_in_use = get_itimer_signal ();
718 add_signal_handler (profiling_signal_in_use, sigprof_signal_handler);
719 setitimer (get_itimer_mode (), &itval, NULL);
723 #if !defined(__APPLE__)
725 mono_runtime_syscall_fork ()
727 #if defined(PLATFORM_ANDROID)
728 /* SYS_fork is defined to be __NR_fork which is not defined in some ndk versions */
729 g_assert_not_reached ();
731 #elif defined(SYS_fork)
732 return (pid_t) syscall (SYS_fork);
734 g_assert_not_reached ();
740 mono_gdb_render_native_backtraces (pid_t crashed_pid)
742 const char *argv [9];
743 char template [] = "/tmp/mono-lldb-commands.XXXXXX";
746 gboolean using_lldb = FALSE;
748 argv [0] = g_find_program_in_path ("gdb");
749 if (argv [0] == NULL) {
750 argv [0] = g_find_program_in_path ("lldb");
754 if (argv [0] == NULL)
758 if (mkstemp (template) == -1)
761 commands = fopen (template, "w");
763 fprintf (commands, "process attach --pid %ld\n", (long) crashed_pid);
764 fprintf (commands, "thread list\n");
765 fprintf (commands, "thread backtrace all\n");
766 fprintf (commands, "detach\n");
767 fprintf (commands, "quit\n");
772 argv [1] = "--source";
777 sprintf (buf1, "attach %ld", (long) crashed_pid);
780 argv [4] = "info threads";
782 argv [6] = "thread apply all bt";
783 argv [7] = "--batch";
787 execv (argv [0], (char**)argv);
793 #endif /* __native_client__ */
795 #if !defined (__MACH__)
798 mono_thread_state_init_from_handle (MonoThreadUnwindState *tctx, MonoThreadInfo *info)
800 g_error ("Posix systems don't support mono_thread_state_init_from_handle");