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.
12 * Licensed under the MIT license. See LICENSE file in the project root for full license information.
23 #ifdef HAVE_SYS_TIME_H
26 #ifdef HAVE_SYS_SYSCALL_H
27 #include <sys/syscall.h>
32 #include <mono/metadata/assembly.h>
33 #include <mono/metadata/loader.h>
34 #include <mono/metadata/tabledefs.h>
35 #include <mono/metadata/class.h>
36 #include <mono/metadata/object.h>
37 #include <mono/metadata/tokentype.h>
38 #include <mono/metadata/tabledefs.h>
39 #include <mono/metadata/threads.h>
40 #include <mono/metadata/appdomain.h>
41 #include <mono/metadata/debug-helpers.h>
42 #include <mono/io-layer/io-layer.h>
43 #include "mono/metadata/profiler.h"
44 #include <mono/metadata/profiler-private.h>
45 #include <mono/metadata/mono-config.h>
46 #include <mono/metadata/environment.h>
47 #include <mono/metadata/mono-debug.h>
48 #include <mono/metadata/gc-internals.h>
49 #include <mono/metadata/threads-types.h>
50 #include <mono/metadata/verify.h>
51 #include <mono/metadata/verify-internals.h>
52 #include <mono/metadata/mempool-internals.h>
53 #include <mono/metadata/attach.h>
54 #include <mono/utils/mono-math.h>
55 #include <mono/utils/mono-compiler.h>
56 #include <mono/utils/mono-counters.h>
57 #include <mono/utils/mono-logger-internals.h>
58 #include <mono/utils/mono-mmap.h>
59 #include <mono/utils/dtrace.h>
60 #include <mono/utils/mono-signal-handler.h>
61 #include <mono/utils/mono-threads.h>
68 #include "debugger-agent.h"
70 #include "jit-icalls.h"
72 #if defined(__native_client__) || defined(HOST_WATCHOS)
75 mono_runtime_setup_stat_profiler (void)
77 printf("WARNING: mono_runtime_setup_stat_profiler() called!\n");
82 mono_runtime_shutdown_stat_profiler (void)
88 MONO_SIG_HANDLER_SIGNATURE (mono_chain_signal)
93 #ifndef PLATFORM_MACOSX
95 mono_runtime_install_handlers (void)
101 mono_runtime_posix_install_handlers(void)
107 mono_runtime_shutdown_handlers (void)
112 mono_runtime_cleanup_handlers (void)
116 #if !defined(PLATFORM_MACOSX)
118 mono_runtime_syscall_fork (void)
120 g_assert_not_reached();
125 mono_gdb_render_native_backtraces (pid_t crashed_pid)
132 static GHashTable *mono_saved_signal_handlers = NULL;
134 static struct sigaction *
135 get_saved_signal_handler (int signo)
137 if (mono_saved_signal_handlers)
138 /* The hash is only modified during startup, so no need for locking */
139 return (struct sigaction *)g_hash_table_lookup (mono_saved_signal_handlers, GINT_TO_POINTER (signo));
144 save_old_signal_handler (int signo, struct sigaction *old_action)
146 struct sigaction *handler_to_save = (struct sigaction *)g_malloc (sizeof (struct sigaction));
148 mono_trace (G_LOG_LEVEL_DEBUG, MONO_TRACE_CONFIG,
149 "Saving old signal handler for signal %d.", signo);
151 if (! (old_action->sa_flags & SA_SIGINFO)) {
152 handler_to_save->sa_handler = old_action->sa_handler;
154 #ifdef MONO_ARCH_USE_SIGACTION
155 handler_to_save->sa_sigaction = old_action->sa_sigaction;
156 #endif /* MONO_ARCH_USE_SIGACTION */
158 handler_to_save->sa_mask = old_action->sa_mask;
159 handler_to_save->sa_flags = old_action->sa_flags;
161 if (!mono_saved_signal_handlers)
162 mono_saved_signal_handlers = g_hash_table_new (NULL, NULL);
163 g_hash_table_insert (mono_saved_signal_handlers, GINT_TO_POINTER (signo), handler_to_save);
167 free_saved_sig_handler_func (gpointer key, gpointer value, gpointer user_data)
173 free_saved_signal_handlers (void)
175 if (mono_saved_signal_handlers) {
176 g_hash_table_foreach (mono_saved_signal_handlers, free_saved_sig_handler_func, NULL);
177 g_hash_table_destroy (mono_saved_signal_handlers);
178 mono_saved_signal_handlers = NULL;
185 * Call the original signal handler for the signal given by the arguments, which
186 * should be the same as for a signal handler. Returns TRUE if the original handler
187 * was called, false otherwise.
190 MONO_SIG_HANDLER_SIGNATURE (mono_chain_signal)
192 int signal = MONO_SIG_HANDLER_GET_SIGNO ();
193 struct sigaction *saved_handler = (struct sigaction *)get_saved_signal_handler (signal);
195 if (saved_handler && saved_handler->sa_handler) {
196 if (!(saved_handler->sa_flags & SA_SIGINFO)) {
197 saved_handler->sa_handler (signal);
199 #ifdef MONO_ARCH_USE_SIGACTION
200 saved_handler->sa_sigaction (MONO_SIG_HANDLER_PARAMS);
201 #endif /* MONO_ARCH_USE_SIGACTION */
208 MONO_SIG_HANDLER_FUNC (static, sigabrt_signal_handler)
210 MonoJitInfo *ji = NULL;
211 MONO_SIG_HANDLER_INFO_TYPE *info = MONO_SIG_HANDLER_GET_INFO ();
212 MONO_SIG_HANDLER_GET_CONTEXT;
214 if (mono_thread_internal_current ())
215 ji = mono_jit_info_table_find_internal (mono_domain_get (), (char *)mono_arch_ip_from_context (ctx), TRUE, TRUE);
217 if (mono_chain_signal (MONO_SIG_HANDLER_PARAMS))
219 mono_handle_native_sigsegv (SIGABRT, ctx, info);
223 #if defined(__i386__) || defined(__x86_64__)
224 #define FULL_STAT_PROFILER_BACKTRACE 1
225 #define CURRENT_FRAME_GET_BASE_POINTER(f) (* (gpointer*)(f))
226 #define CURRENT_FRAME_GET_RETURN_ADDRESS(f) (* (((gpointer*)(f)) + 1))
227 #if MONO_ARCH_STACK_GROWS_UP
228 #define IS_BEFORE_ON_STACK <
229 #define IS_AFTER_ON_STACK >
231 #define IS_BEFORE_ON_STACK >
232 #define IS_AFTER_ON_STACK <
235 #define FULL_STAT_PROFILER_BACKTRACE 0
240 static int profiling_signal_in_use;
242 #if defined(__ia64__) || defined(__sparc__) || defined(sparc)
244 MONO_SIG_HANDLER_FUNC (static, sigprof_signal_handler)
246 if (mono_chain_signal (MONO_SIG_HANDLER_PARAMS))
255 per_thread_profiler_hit (void *ctx)
257 int call_chain_depth = mono_profiler_stat_get_call_chain_depth ();
258 MonoProfilerCallChainStrategy call_chain_strategy = mono_profiler_stat_get_call_chain_strategy ();
260 if (call_chain_depth == 0) {
261 mono_profiler_stat_hit ((guchar *)mono_arch_ip_from_context (ctx), ctx);
263 MonoJitTlsData *jit_tls = (MonoJitTlsData *)mono_native_tls_get_value (mono_jit_tls_id);
264 int current_frame_index = 1;
265 MonoContext mono_context;
266 guchar *ips [call_chain_depth + 1];
268 mono_sigctx_to_monoctx (ctx, &mono_context);
269 ips [0] = (guchar *)MONO_CONTEXT_GET_IP (&mono_context);
271 if (jit_tls != NULL) {
272 if (call_chain_strategy == MONO_PROFILER_CALL_CHAIN_NATIVE) {
273 #if FULL_STAT_PROFILER_BACKTRACE
274 guchar *current_frame;
275 guchar *stack_bottom;
278 stack_bottom = (guchar *)jit_tls->end_of_stack;
279 stack_top = (guchar *)MONO_CONTEXT_GET_SP (&mono_context);
280 current_frame = (guchar *)MONO_CONTEXT_GET_BP (&mono_context);
282 while ((current_frame_index <= call_chain_depth) &&
283 (stack_bottom IS_BEFORE_ON_STACK (guchar*) current_frame) &&
284 ((guchar*) current_frame IS_BEFORE_ON_STACK stack_top)) {
285 ips [current_frame_index] = (guchar *)CURRENT_FRAME_GET_RETURN_ADDRESS (current_frame);
286 current_frame_index ++;
287 stack_top = current_frame;
288 current_frame = (guchar *)CURRENT_FRAME_GET_BASE_POINTER (current_frame);
291 call_chain_strategy = MONO_PROFILER_CALL_CHAIN_GLIBC;
295 if (call_chain_strategy == MONO_PROFILER_CALL_CHAIN_GLIBC) {
296 #if GLIBC_PROFILER_BACKTRACE
297 current_frame_index = backtrace ((void**) & ips [1], call_chain_depth);
299 call_chain_strategy = MONO_PROFILER_CALL_CHAIN_MANAGED;
303 if (call_chain_strategy == MONO_PROFILER_CALL_CHAIN_MANAGED) {
304 MonoDomain *domain = mono_domain_get ();
305 if (domain != NULL) {
309 MonoContext new_mono_context;
311 ji = mono_find_jit_info (domain, jit_tls, &res, NULL, &mono_context,
312 &new_mono_context, NULL, &lmf, &native_offset, NULL);
313 while ((ji != NULL) && (current_frame_index <= call_chain_depth)) {
314 ips [current_frame_index] = (guchar *)MONO_CONTEXT_GET_IP (&new_mono_context);
315 current_frame_index ++;
316 mono_context = new_mono_context;
317 ji = mono_find_jit_info (domain, jit_tls, &res, NULL, &mono_context,
318 &new_mono_context, NULL, &lmf, &native_offset, NULL);
324 mono_profiler_stat_call_chain (current_frame_index, & ips [0], ctx);
328 MONO_SIG_HANDLER_FUNC (static, sigprof_signal_handler)
330 int old_errno = errno;
332 MONO_SIG_HANDLER_GET_CONTEXT;
334 if (mono_thread_info_get_small_id () == -1)
335 return; //an non-attached thread got the signal
337 if (!mono_domain_get () || !mono_native_tls_get_value (mono_jit_tls_id))
338 return; //thread in the process of dettaching
340 hp_save_index = mono_hazard_pointer_save_for_signal_handler ();
342 /* If we can't consume a profiling request it means we're the initiator. */
343 if (!(mono_threads_consume_async_jobs () & MONO_SERVICE_REQUEST_SAMPLE)) {
344 FOREACH_THREAD_SAFE (info) {
345 if (mono_thread_info_get_tid (info) == mono_native_thread_id_get () ||
346 !mono_thread_info_is_live (info))
349 mono_threads_add_async_job (info, MONO_SERVICE_REQUEST_SAMPLE);
350 mono_threads_pthread_kill (info, profiling_signal_in_use);
351 } FOREACH_THREAD_SAFE_END
354 mono_thread_info_set_is_async_context (TRUE);
355 per_thread_profiler_hit (ctx);
356 mono_thread_info_set_is_async_context (FALSE);
358 mono_hazard_pointer_restore_for_signal_handler (hp_save_index);
361 mono_chain_signal (MONO_SIG_HANDLER_PARAMS);
367 MONO_SIG_HANDLER_FUNC (static, sigquit_signal_handler)
371 /* We use this signal to start the attach agent too */
372 res = mono_attach_start ();
376 mono_threads_request_thread_dump ();
378 mono_chain_signal (MONO_SIG_HANDLER_PARAMS);
381 MONO_SIG_HANDLER_FUNC (static, sigusr2_signal_handler)
383 gboolean enabled = mono_trace_is_enabled ();
385 mono_trace_enable (!enabled);
387 mono_chain_signal (MONO_SIG_HANDLER_PARAMS);
391 add_signal_handler (int signo, gpointer handler, int flags)
394 struct sigaction previous_sa;
396 #ifdef MONO_ARCH_USE_SIGACTION
397 sa.sa_sigaction = (void (*)(int, siginfo_t *, void *))handler;
398 sigemptyset (&sa.sa_mask);
399 sa.sa_flags = SA_SIGINFO | flags;
400 #ifdef MONO_ARCH_SIGSEGV_ON_ALTSTACK
402 /*Apple likes to deliver SIGBUS for *0 */
403 #ifdef PLATFORM_MACOSX
404 if (signo == SIGSEGV || signo == SIGBUS) {
406 if (signo == SIGSEGV) {
408 sa.sa_flags |= SA_ONSTACK;
411 * libgc will crash when trying to do stack marking for threads which are on
412 * an altstack, so delay the suspend signal after the signal handler has
415 if (mono_gc_get_suspend_signal () != -1)
416 sigaddset (&sa.sa_mask, mono_gc_get_suspend_signal ());
419 if (signo == SIGSEGV) {
421 * Delay abort signals while handling SIGSEGVs since they could go unnoticed.
425 sigemptyset (&block_mask);
428 sa.sa_handler = handler;
429 sigemptyset (&sa.sa_mask);
432 g_assert (sigaction (signo, &sa, &previous_sa) != -1);
434 /* if there was already a handler in place for this signal, store it */
435 if (! (previous_sa.sa_flags & SA_SIGINFO) &&
436 (SIG_DFL == previous_sa.sa_handler)) {
437 /* it there is no sa_sigaction function and the sa_handler is default, we can safely ignore this */
439 if (mono_do_signal_chaining)
440 save_old_signal_handler (signo, &previous_sa);
445 remove_signal_handler (int signo)
448 struct sigaction *saved_action = get_saved_signal_handler (signo);
451 sa.sa_handler = SIG_DFL;
452 sigemptyset (&sa.sa_mask);
455 sigaction (signo, &sa, NULL);
457 g_assert (sigaction (signo, saved_action, NULL) != -1);
462 mono_runtime_posix_install_handlers (void)
467 if (mini_get_debug_options ()->handle_sigint)
468 add_signal_handler (SIGINT, mono_sigint_signal_handler, SA_RESTART);
470 add_signal_handler (SIGFPE, mono_sigfpe_signal_handler, 0);
471 add_signal_handler (SIGQUIT, sigquit_signal_handler, SA_RESTART);
472 add_signal_handler (SIGILL, mono_sigill_signal_handler, 0);
473 add_signal_handler (SIGBUS, mono_sigsegv_signal_handler, 0);
474 if (mono_jit_trace_calls != NULL)
475 add_signal_handler (SIGUSR2, sigusr2_signal_handler, SA_RESTART);
477 /* it seems to have become a common bug for some programs that run as parents
478 * of many processes to block signal delivery for real time signals.
479 * We try to detect and work around their breakage here.
481 sigemptyset (&signal_set);
482 if (mono_gc_get_suspend_signal () != -1)
483 sigaddset (&signal_set, mono_gc_get_suspend_signal ());
484 if (mono_gc_get_restart_signal () != -1)
485 sigaddset (&signal_set, mono_gc_get_restart_signal ());
486 sigaddset (&signal_set, SIGCHLD);
487 sigprocmask (SIG_UNBLOCK, &signal_set, NULL);
489 signal (SIGPIPE, SIG_IGN);
491 add_signal_handler (SIGABRT, sigabrt_signal_handler, 0);
494 add_signal_handler (SIGSEGV, mono_sigsegv_signal_handler, 0);
497 #ifndef PLATFORM_MACOSX
499 mono_runtime_install_handlers (void)
501 mono_runtime_posix_install_handlers ();
506 mono_runtime_cleanup_handlers (void)
508 if (mini_get_debug_options ()->handle_sigint)
509 remove_signal_handler (SIGINT);
511 remove_signal_handler (SIGFPE);
512 remove_signal_handler (SIGQUIT);
513 remove_signal_handler (SIGILL);
514 remove_signal_handler (SIGBUS);
515 if (mono_jit_trace_calls != NULL)
516 remove_signal_handler (SIGUSR2);
518 remove_signal_handler (SIGABRT);
520 remove_signal_handler (SIGSEGV);
522 free_saved_signal_handlers ();
525 #ifdef HAVE_LINUX_RTC_H
526 #include <linux/rtc.h>
527 #include <sys/ioctl.h>
529 static int rtc_fd = -1;
532 enable_rtc_timer (gboolean enable)
535 flags = fcntl (rtc_fd, F_GETFL);
544 if (fcntl (rtc_fd, F_SETFL, flags) == -1) {
553 mono_runtime_shutdown_stat_profiler (void)
555 #ifdef HAVE_LINUX_RTC_H
557 enable_rtc_timer (FALSE);
563 get_itimer_mode (void)
565 switch (mono_profiler_get_sampling_mode ()) {
566 case MONO_PROFILER_STAT_MODE_PROCESS: return ITIMER_PROF;
567 case MONO_PROFILER_STAT_MODE_REAL: return ITIMER_REAL;
569 g_assert_not_reached ();
574 get_itimer_signal (void)
576 switch (mono_profiler_get_sampling_mode ()) {
577 case MONO_PROFILER_STAT_MODE_PROCESS: return SIGPROF;
578 case MONO_PROFILER_STAT_MODE_REAL: return SIGALRM;
580 g_assert_not_reached ();
586 mono_runtime_setup_stat_profiler (void)
589 struct itimerval itval;
590 static int inited = 0;
591 #ifdef HAVE_LINUX_RTC_H
592 const char *rtc_freq;
593 if (!inited && (rtc_freq = g_getenv ("MONO_RTC"))) {
597 freq = atoi (rtc_freq);
600 rtc_fd = open ("/dev/rtc", O_RDONLY);
602 perror ("open /dev/rtc");
605 profiling_signal_in_use = SIGPROF;
606 add_signal_handler (profiling_signal_in_use, sigprof_signal_handler, SA_RESTART);
607 if (ioctl (rtc_fd, RTC_IRQP_SET, freq) == -1) {
608 perror ("set rtc freq");
611 if (ioctl (rtc_fd, RTC_PIE_ON, 0) == -1) {
612 perror ("start rtc");
615 if (fcntl (rtc_fd, F_SETSIG, SIGPROF) == -1) {
619 if (fcntl (rtc_fd, F_SETOWN, getpid ()) == -1) {
623 enable_rtc_timer (TRUE);
630 itval.it_interval.tv_usec = (1000000 / mono_profiler_get_sampling_rate ()) - 1;
631 itval.it_interval.tv_sec = 0;
632 itval.it_value = itval.it_interval;
636 profiling_signal_in_use = get_itimer_signal ();
637 add_signal_handler (profiling_signal_in_use, sigprof_signal_handler, SA_RESTART);
638 setitimer (get_itimer_mode (), &itval, NULL);
642 #if !defined(PLATFORM_MACOSX)
644 mono_runtime_syscall_fork ()
646 #if defined(PLATFORM_ANDROID)
647 /* SYS_fork is defined to be __NR_fork which is not defined in some ndk versions */
648 g_assert_not_reached ();
650 #elif defined(SYS_fork)
651 return (pid_t) syscall (SYS_fork);
653 g_assert_not_reached ();
659 mono_gdb_render_native_backtraces (pid_t crashed_pid)
661 const char *argv [9];
662 char template_ [] = "/tmp/mono-lldb-commands.XXXXXX";
665 gboolean using_lldb = FALSE;
667 argv [0] = g_find_program_in_path ("gdb");
668 if (argv [0] == NULL) {
669 argv [0] = g_find_program_in_path ("lldb");
673 if (argv [0] == NULL)
677 if (mkstemp (template_) == -1)
680 commands = fopen (template_, "w");
682 fprintf (commands, "process attach --pid %ld\n", (long) crashed_pid);
683 fprintf (commands, "thread list\n");
684 fprintf (commands, "thread backtrace all\n");
685 fprintf (commands, "detach\n");
686 fprintf (commands, "quit\n");
691 argv [1] = "--source";
692 argv [2] = template_;
696 sprintf (buf1, "attach %ld", (long) crashed_pid);
699 argv [4] = "info threads";
701 argv [6] = "thread apply all bt";
702 argv [7] = "--batch";
706 execv (argv [0], (char**)argv);
712 #endif /* __native_client__ */
714 #if !defined (__MACH__)
717 mono_thread_state_init_from_handle (MonoThreadUnwindState *tctx, MonoThreadInfo *info)
719 g_error ("Posix systems don't support mono_thread_state_init_from_handle");