2 * mini-darwin.c: Darwin/MacOS support for Mono.
5 * Mono Team (mono-list@lists.ximian.com)
7 * Copyright 2001-2003 Ximian, Inc.
8 * Copyright 2003-2011 Novell, Inc (http://www.novell.com)
9 * Copyright 2011 Xamarin, Inc (http://www.xamarin.com)
11 * See LICENSE for licensing information.
22 #ifdef HAVE_SYS_TIME_H
26 #include <mono/metadata/assembly.h>
27 #include <mono/metadata/loader.h>
28 #include <mono/metadata/tabledefs.h>
29 #include <mono/metadata/class.h>
30 #include <mono/metadata/object.h>
31 #include <mono/metadata/tokentype.h>
32 #include <mono/metadata/tabledefs.h>
33 #include <mono/metadata/threads.h>
34 #include <mono/metadata/appdomain.h>
35 #include <mono/metadata/debug-helpers.h>
36 #include <mono/io-layer/io-layer.h>
37 #include "mono/metadata/profiler.h"
38 #include <mono/metadata/profiler-private.h>
39 #include <mono/metadata/mono-config.h>
40 #include <mono/metadata/environment.h>
41 #include <mono/metadata/mono-debug.h>
42 #include <mono/metadata/threads-types.h>
43 #include <mono/metadata/verify.h>
44 #include <mono/metadata/verify-internals.h>
45 #include <mono/metadata/mempool-internals.h>
46 #include <mono/metadata/attach.h>
47 #include <mono/metadata/gc-internal.h>
48 #include <mono/utils/mono-math.h>
49 #include <mono/utils/mono-compiler.h>
50 #include <mono/utils/mono-counters.h>
51 #include <mono/utils/mono-logger-internal.h>
52 #include <mono/utils/mono-mmap.h>
53 #include <mono/utils/dtrace.h>
61 #include "jit-icalls.h"
64 #include <mach/mach.h>
65 #include <mach/mach_error.h>
66 #include <mach/exception.h>
67 #include <mach/task.h>
70 #include <AvailabilityMacros.h>
72 #if defined (TARGET_OSX) && (MAC_OS_X_VERSION_MIN_REQUIRED <= MAC_OS_X_VERSION_10_5)
73 #define NEEDS_EXCEPTION_THREAD
76 #ifdef NEEDS_EXCEPTION_THREAD
79 * This code disables the CrashReporter of MacOS X by installing
80 * a dummy Mach exception handler.
84 * http://darwinsource.opendarwin.org/10.4.3/xnu-792.6.22/osfmk/man/exc_server.html
86 extern boolean_t exc_server (mach_msg_header_t *request_msg, mach_msg_header_t *reply_msg);
89 * The exception message
92 mach_msg_base_t msg; /* common mach message header */
93 char payload [1024]; /* opaque */
94 } mach_exception_msg_t;
96 /* The exception port */
97 static mach_port_t mach_exception_port = VM_MAP_NULL;
100 catch_exception_raise (
101 mach_port_t exception_port,
104 exception_type_t exception,
105 exception_data_t code,
106 mach_msg_type_number_t code_count);
109 * Implicitly called by exc_server. Must be public.
111 * http://darwinsource.opendarwin.org/10.4.3/xnu-792.6.22/osfmk/man/catch_exception_raise.html
114 catch_exception_raise (
115 mach_port_t exception_port,
118 exception_type_t exception,
119 exception_data_t code,
120 mach_msg_type_number_t code_count)
122 /* consume the exception */
127 * Exception thread handler.
131 mach_exception_thread (void *arg)
134 mach_exception_msg_t request;
135 mach_exception_msg_t reply;
136 mach_msg_return_t result;
138 /* receive from "mach_exception_port" */
139 result = mach_msg (&request.msg.header,
140 MACH_RCV_MSG | MACH_RCV_LARGE,
144 MACH_MSG_TIMEOUT_NONE,
147 g_assert (result == MACH_MSG_SUCCESS);
149 /* dispatch to catch_exception_raise () */
150 exc_server (&request.msg.header, &reply.msg.header);
152 /* send back to sender */
153 result = mach_msg (&reply.msg.header,
155 reply.msg.header.msgh_size,
158 MACH_MSG_TIMEOUT_NONE,
162 If we try to abort the thread while delivering an exception. The port will be gone since the kernel
163 setup a send once port to deliver the resume message and thread_abort will consume it.
165 g_assert (result == MACH_MSG_SUCCESS || result == MACH_SEND_INVALID_DEST);
171 macosx_register_exception_handler (void)
177 if (mach_exception_port != VM_MAP_NULL)
180 task = mach_task_self ();
182 /* create the "mach_exception_port" with send & receive rights */
183 g_assert (mach_port_allocate (task, MACH_PORT_RIGHT_RECEIVE,
184 &mach_exception_port) == KERN_SUCCESS);
185 g_assert (mach_port_insert_right (task, mach_exception_port, mach_exception_port,
186 MACH_MSG_TYPE_MAKE_SEND) == KERN_SUCCESS);
188 /* create the exception handler thread */
189 g_assert (!pthread_attr_init (&attr));
190 g_assert (!pthread_attr_setdetachstate (&attr, PTHREAD_CREATE_DETACHED));
191 g_assert (!pthread_create (&thread, &attr, mach_exception_thread, NULL));
192 pthread_attr_destroy (&attr);
195 * register "mach_exception_port" as a receiver for the
196 * EXC_BAD_ACCESS exception
198 * http://darwinsource.opendarwin.org/10.4.3/xnu-792.6.22/osfmk/man/task_set_exception_ports.html
200 g_assert (task_set_exception_ports (task, EXC_MASK_BAD_ACCESS,
203 MACHINE_THREAD_STATE) == KERN_SUCCESS);
205 mono_gc_register_mach_exception_thread (thread);
210 /* This is #define'd by Boehm GC to _GC_dlopen. */
213 void* dlopen(const char* path, int mode);
216 mono_runtime_install_handlers (void)
218 #ifdef NEEDS_EXCEPTION_THREAD
219 macosx_register_exception_handler ();
221 mono_runtime_posix_install_handlers ();
223 /* Snow Leopard has a horrible bug: http://openradar.appspot.com/7209349
224 * This causes obscure SIGTRAP's for any application that comes across this built on
225 * Snow Leopard. This is a horrible hack to ensure that the private __CFInitialize
226 * is run on the main thread, so that we don't get SIGTRAPs later
228 #if defined (__APPLE__) && (defined (__i386__) || defined (__x86_64__))
230 void *handle = dlopen ("/System/Library/Frameworks/CoreFoundation.framework/CoreFoundation", RTLD_LAZY);
240 mono_runtime_syscall_fork ()
242 return (pid_t) fork ();
246 mono_gdb_render_native_backtraces (pid_t crashed_pid)
248 const char *argv [5];
249 char template [] = "/tmp/mono-gdb-commands.XXXXXX";
251 gboolean using_lldb = FALSE;
253 argv [0] = g_find_program_in_path ("gdb");
255 argv [0] = g_find_program_in_path ("lldb");
259 if (argv [0] == NULL)
262 if (mkstemp (template) == -1)
265 commands = fopen (template, "w");
267 fprintf (commands, "process attach --pid %ld\n", (long) crashed_pid);
268 fprintf (commands, "script lldb.debugger.HandleCommand (\"thread list\")\n");
269 fprintf (commands, "script lldb.debugger.HandleCommand (\"thread backtrace all\")\n");
270 fprintf (commands, "detach\n");
271 fprintf (commands, "quit\n");
272 argv [1] = "--source";
277 fprintf (commands, "attach %ld\n", (long) crashed_pid);
278 fprintf (commands, "info threads\n");
279 fprintf (commands, "thread apply all bt\n");
288 execv (argv [0], (char**)argv);
293 mono_thread_state_init_from_handle (MonoThreadUnwindState *tctx, MonoNativeThreadId thread_id, MonoNativeThreadHandle thread_handle)
296 mach_msg_type_number_t num_state;
297 thread_state_t state;
300 guint32 domain_key, jit_key;
301 MonoJitTlsData *jit_tls;
303 #if defined (MONO_ARCH_ENABLE_MONO_LMF_VAR)
307 /*Zero enough state to make sure the caller doesn't confuse itself*/
309 tctx->unwind_data [MONO_UNWIND_DATA_DOMAIN] = NULL;
310 tctx->unwind_data [MONO_UNWIND_DATA_LMF] = NULL;
311 tctx->unwind_data [MONO_UNWIND_DATA_JIT_TLS] = NULL;
313 state = (thread_state_t) alloca (mono_mach_arch_get_thread_state_size ());
314 mctx = (mcontext_t) alloca (mono_mach_arch_get_mcontext_size ());
316 ret = mono_mach_arch_get_thread_state (thread_handle, state, &num_state);
317 if (ret != KERN_SUCCESS)
320 mono_mach_arch_thread_state_to_mcontext (state, mctx);
321 ctx.uc_mcontext = mctx;
323 mono_sigctx_to_monoctx (&ctx, &tctx->ctx);
325 domain_key = mono_domain_get_tls_key ();
326 jit_key = mono_get_jit_tls_key ();
328 jit_tls = mono_mach_arch_get_tls_value_from_thread (thread_id, jit_key);
329 domain = mono_mach_arch_get_tls_value_from_thread (thread_id, domain_key);
331 /*Thread already started to cleanup, can no longer capture unwind state*/
332 if (!jit_tls || !domain)
335 #if defined (MONO_ARCH_ENABLE_MONO_LMF_VAR)
336 lmf_key = mono_get_lmf_tls_offset ();
337 tctx->unwind_data [MONO_UNWIND_DATA_LMF] = mono_mach_arch_get_tls_value_from_thread (thread_id, lmf_key);;
339 tctx->unwind_data [MONO_UNWIND_DATA_LMF] = jit_tls ? jit_tls->lmf : NULL;
342 tctx->unwind_data [MONO_UNWIND_DATA_DOMAIN] = domain;
343 tctx->unwind_data [MONO_UNWIND_DATA_JIT_TLS] = jit_tls;