5 * Mono Project (http://www.mono-project.com)
7 * Copyright 2001-2003 Ximian, Inc (http://www.ximian.com)
8 * Copyright 2004-2009 Novell, Inc (http://www.novell.com)
9 * Copyright 2011 Xamarin Inc (http://www.xamarin.com)
13 #include <mono/metadata/assembly.h>
14 #include <mono/metadata/tabledefs.h>
15 #include <mono/metadata/tokentype.h>
16 #include <mono/metadata/appdomain.h>
17 #include <mono/metadata/class-internals.h>
18 #include <mono/metadata/mono-debug.h>
19 #include <mono/metadata/mono-debug-debugger.h>
20 #include <mono/metadata/mono-endian.h>
21 #include <mono/metadata/gc-internal.h>
22 #include <mono/metadata/mempool.h>
25 #define ALIGN_TO(val,align) ((((guint64)val) + ((align) - 1)) & ~((align) - 1))
27 #if NO_UNALIGNED_ACCESS
28 #define WRITE_UNALIGNED(type, addr, val) \
29 memcpy(addr, &val, sizeof(type))
30 #define READ_UNALIGNED(type, addr, val) \
31 memcpy(&val, addr, sizeof(type))
33 #define WRITE_UNALIGNED(type, addr, val) \
34 (*(type *)(addr) = (val))
35 #define READ_UNALIGNED(type, addr, val) \
36 val = (*(type *)(addr))
39 /* This contains per-domain info */
40 struct _MonoDebugDataTable {
42 GHashTable *method_address_hash;
45 /* This contains JIT debugging information about a method in serialized format */
46 struct _MonoDebugMethodAddress {
47 const guint8 *code_start;
49 guint8 data [MONO_ZERO_LEN_ARRAY];
52 static MonoDebugFormat mono_debug_format = MONO_DEBUG_FORMAT_NONE;
54 static gboolean mono_debug_initialized = FALSE;
55 /* Maps MonoImage -> MonoMonoDebugHandle */
56 static GHashTable *mono_debug_handles;
57 /* Maps MonoDomain -> MonoDataTable */
58 static GHashTable *data_table_hash;
60 static mono_mutex_t debugger_lock_mutex;
62 static int initialized = 0;
63 static gboolean is_attached = FALSE;
65 static MonoDebugHandle *mono_debug_open_image (MonoImage *image, const guint8 *raw_contents, int size);
67 static MonoDebugHandle *mono_debug_get_image (MonoImage *image);
68 static void mono_debug_add_assembly (MonoAssembly *assembly,
71 static MonoDebugHandle *open_symfile_from_bundle (MonoImage *image);
73 static MonoDebugDataTable *
74 create_data_table (MonoDomain *domain)
76 MonoDebugDataTable *table;
78 table = g_new0 (MonoDebugDataTable, 1);
80 table->mp = mono_mempool_new ();
81 table->method_address_hash = g_hash_table_new (NULL, NULL);
84 g_hash_table_insert (data_table_hash, domain, table);
90 free_data_table (MonoDebugDataTable *table)
92 mono_mempool_destroy (table->mp);
93 g_hash_table_destroy (table->method_address_hash);
98 static MonoDebugDataTable *
99 lookup_data_table (MonoDomain *domain)
101 MonoDebugDataTable *table;
103 table = g_hash_table_lookup (data_table_hash, domain);
105 g_error ("lookup_data_table () failed for %p\n", domain);
112 free_debug_handle (MonoDebugHandle *handle)
115 mono_debug_close_mono_symbol_file (handle->symfile);
116 /* decrease the refcount added with mono_image_addref () */
117 mono_image_close (handle->image);
122 * Initialize debugging support.
124 * This method must be called after loading corlib,
125 * but before opening the application's main assembly because we need to set some
129 mono_debug_init (MonoDebugFormat format)
131 g_assert (!mono_debug_initialized);
132 if (format == MONO_DEBUG_FORMAT_DEBUGGER)
133 g_error ("The mdb debugger is no longer supported.");
135 mono_debug_initialized = TRUE;
136 mono_debug_format = format;
138 mono_debugger_initialize ();
140 mono_debugger_lock ();
142 mono_debug_handles = g_hash_table_new_full
143 (NULL, NULL, NULL, (GDestroyNotify) free_debug_handle);
145 data_table_hash = g_hash_table_new_full (
146 NULL, NULL, NULL, (GDestroyNotify) free_data_table);
148 mono_install_assembly_load_hook (mono_debug_add_assembly, NULL);
150 mono_debugger_unlock ();
154 mono_debug_open_image_from_memory (MonoImage *image, const guint8 *raw_contents, int size)
156 if (!mono_debug_initialized)
159 mono_debug_open_image (image, raw_contents, size);
163 mono_debug_cleanup (void)
165 if (mono_debug_handles)
166 g_hash_table_destroy (mono_debug_handles);
167 mono_debug_handles = NULL;
169 if (data_table_hash) {
170 g_hash_table_destroy (data_table_hash);
171 data_table_hash = NULL;
176 mono_debug_domain_create (MonoDomain *domain)
178 MonoDebugDataTable *table;
180 if (!mono_debug_initialized)
183 mono_debugger_lock ();
185 table = create_data_table (domain);
187 mono_debugger_unlock ();
191 mono_debug_domain_unload (MonoDomain *domain)
193 MonoDebugDataTable *table;
195 if (!mono_debug_initialized)
198 mono_debugger_lock ();
200 table = g_hash_table_lookup (data_table_hash, domain);
202 g_warning (G_STRLOC ": unloading unknown domain %p / %d",
203 domain, mono_domain_get_id (domain));
204 mono_debugger_unlock ();
208 g_hash_table_remove (data_table_hash, domain);
210 mono_debugger_unlock ();
214 * LOCKING: Assumes the debug lock is held.
216 static MonoDebugHandle *
217 mono_debug_get_image (MonoImage *image)
219 return g_hash_table_lookup (mono_debug_handles, image);
223 mono_debug_close_image (MonoImage *image)
225 MonoDebugHandle *handle;
227 if (!mono_debug_initialized)
230 mono_debugger_lock ();
232 handle = mono_debug_get_image (image);
234 mono_debugger_unlock ();
238 g_hash_table_remove (mono_debug_handles, image);
240 mono_debugger_unlock ();
243 static MonoDebugHandle *
244 mono_debug_open_image (MonoImage *image, const guint8 *raw_contents, int size)
246 MonoDebugHandle *handle;
248 if (mono_image_is_dynamic (image))
251 mono_debugger_lock ();
253 handle = mono_debug_get_image (image);
254 if (handle != NULL) {
255 mono_debugger_unlock ();
259 handle = g_new0 (MonoDebugHandle, 1);
261 handle->image = image;
262 mono_image_addref (image);
264 handle->symfile = mono_debug_open_mono_symbols (
265 handle, raw_contents, size, FALSE);
267 g_hash_table_insert (mono_debug_handles, image, handle);
269 mono_debugger_unlock ();
275 mono_debug_add_assembly (MonoAssembly *assembly, gpointer user_data)
277 MonoDebugHandle *handle;
280 mono_debugger_lock ();
281 image = mono_assembly_get_image (assembly);
282 handle = open_symfile_from_bundle (image);
284 mono_debug_open_image (image, NULL, 0);
285 mono_debugger_unlock ();
288 struct LookupMethodData
290 MonoDebugMethodInfo *minfo;
295 lookup_method_func (gpointer key, gpointer value, gpointer user_data)
297 MonoDebugHandle *handle = (MonoDebugHandle *) value;
298 struct LookupMethodData *data = (struct LookupMethodData *) user_data;
304 data->minfo = mono_debug_symfile_lookup_method (handle, data->method);
307 static MonoDebugMethodInfo *
308 mono_debug_lookup_method_internal (MonoMethod *method)
310 struct LookupMethodData data;
313 data.method = method;
315 if (!mono_debug_handles)
318 g_hash_table_foreach (mono_debug_handles, lookup_method_func, &data);
323 * mono_debug_lookup_method:
325 * Lookup symbol file information for the method @method. The returned
326 * `MonoDebugMethodInfo' is a private structure, but it can be passed to
327 * mono_debug_symfile_lookup_location().
329 MonoDebugMethodInfo *
330 mono_debug_lookup_method (MonoMethod *method)
332 MonoDebugMethodInfo *minfo;
334 mono_debugger_lock ();
335 minfo = mono_debug_lookup_method_internal (method);
336 mono_debugger_unlock ();
341 write_leb128 (guint32 value, guint8 *ptr, guint8 **rptr)
344 guint8 byte = value & 0x7f;
355 write_sleb128 (gint32 value, guint8 *ptr, guint8 **rptr)
360 guint8 byte = value & 0x7f;
363 if (((value == 0) && ((byte & 0x40) == 0)) || ((value == -1) && (byte & 0x40)))
374 write_variable (MonoDebugVarInfo *var, guint8 *ptr, guint8 **rptr)
376 write_leb128 (var->index, ptr, &ptr);
377 write_sleb128 (var->offset, ptr, &ptr);
378 write_leb128 (var->size, ptr, &ptr);
379 write_leb128 (var->begin_scope, ptr, &ptr);
380 write_leb128 (var->end_scope, ptr, &ptr);
381 WRITE_UNALIGNED (gpointer, ptr, var->type);
382 ptr += sizeof (gpointer);
386 MonoDebugMethodAddress *
387 mono_debug_add_method (MonoMethod *method, MonoDebugMethodJitInfo *jit, MonoDomain *domain)
389 MonoDebugDataTable *table;
390 MonoDebugMethodAddress *address;
391 MonoDebugMethodInfo *minfo;
392 MonoDebugHandle *handle;
393 guint8 buffer [BUFSIZ];
394 guint8 *ptr, *oldptr;
395 guint32 i, size, total_size, max_size;
397 mono_debugger_lock ();
399 table = lookup_data_table (domain);
401 handle = mono_debug_get_image (method->klass->image);
402 minfo = mono_debug_lookup_method_internal (method);
404 max_size = (5 * 5) + 1 + (10 * jit->num_line_numbers) +
405 (25 + sizeof (gpointer)) * (1 + jit->num_params + jit->num_locals);
407 if (max_size > BUFSIZ)
408 ptr = oldptr = g_malloc (max_size);
410 ptr = oldptr = buffer;
412 write_leb128 (jit->prologue_end, ptr, &ptr);
413 write_leb128 (jit->epilogue_begin, ptr, &ptr);
415 write_leb128 (jit->num_line_numbers, ptr, &ptr);
416 for (i = 0; i < jit->num_line_numbers; i++) {
417 MonoDebugLineNumberEntry *lne = &jit->line_numbers [i];
419 write_sleb128 (lne->il_offset, ptr, &ptr);
420 write_sleb128 (lne->native_offset, ptr, &ptr);
423 *ptr++ = jit->this_var ? 1 : 0;
425 write_variable (jit->this_var, ptr, &ptr);
427 write_leb128 (jit->num_params, ptr, &ptr);
428 for (i = 0; i < jit->num_params; i++)
429 write_variable (&jit->params [i], ptr, &ptr);
431 write_leb128 (jit->num_locals, ptr, &ptr);
432 for (i = 0; i < jit->num_locals; i++)
433 write_variable (&jit->locals [i], ptr, &ptr);
435 *ptr++ = jit->gsharedvt_info_var ? 1 : 0;
436 if (jit->gsharedvt_info_var) {
437 write_variable (jit->gsharedvt_info_var, ptr, &ptr);
438 write_variable (jit->gsharedvt_locals_var, ptr, &ptr);
442 g_assert (size < max_size);
443 total_size = size + sizeof (MonoDebugMethodAddress);
445 if (method_is_dynamic (method)) {
446 address = g_malloc0 (total_size);
448 address = mono_mempool_alloc (table->mp, total_size);
451 address->code_start = jit->code_start;
452 address->code_size = jit->code_size;
454 memcpy (&address->data, oldptr, size);
455 if (max_size > BUFSIZ)
458 g_hash_table_insert (table->method_address_hash, method, address);
460 mono_debugger_unlock ();
465 mono_debug_remove_method (MonoMethod *method, MonoDomain *domain)
467 MonoDebugDataTable *table;
468 MonoDebugMethodAddress *address;
470 if (!mono_debug_initialized)
473 g_assert (method_is_dynamic (method));
475 mono_debugger_lock ();
477 table = lookup_data_table (domain);
479 address = g_hash_table_lookup (table->method_address_hash, method);
483 g_hash_table_remove (table->method_address_hash, method);
485 mono_debugger_unlock ();
489 mono_debug_add_delegate_trampoline (gpointer code, int size)
493 static inline guint32
494 read_leb128 (guint8 *ptr, guint8 **rptr)
496 guint32 result = 0, shift = 0;
499 guint8 byte = *ptr++;
501 result |= (byte & 0x7f) << shift;
502 if ((byte & 0x80) == 0)
512 read_sleb128 (guint8 *ptr, guint8 **rptr)
518 guint8 byte = *ptr++;
520 result |= (byte & 0x7f) << shift;
526 if ((shift < 32) && (byte & 0x40))
527 result |= - (1 << shift);
536 read_variable (MonoDebugVarInfo *var, guint8 *ptr, guint8 **rptr)
538 var->index = read_leb128 (ptr, &ptr);
539 var->offset = read_sleb128 (ptr, &ptr);
540 var->size = read_leb128 (ptr, &ptr);
541 var->begin_scope = read_leb128 (ptr, &ptr);
542 var->end_scope = read_leb128 (ptr, &ptr);
543 READ_UNALIGNED (gpointer, ptr, var->type);
544 ptr += sizeof (gpointer);
549 mono_debug_free_method_jit_info (MonoDebugMethodJitInfo *jit)
553 g_free (jit->line_numbers);
554 g_free (jit->this_var);
555 g_free (jit->params);
556 g_free (jit->locals);
557 g_free (jit->gsharedvt_info_var);
558 g_free (jit->gsharedvt_locals_var);
562 static MonoDebugMethodJitInfo *
563 mono_debug_read_method (MonoDebugMethodAddress *address)
565 MonoDebugMethodJitInfo *jit;
569 jit = g_new0 (MonoDebugMethodJitInfo, 1);
570 jit->code_start = address->code_start;
571 jit->code_size = address->code_size;
573 ptr = (guint8 *) &address->data;
575 jit->prologue_end = read_leb128 (ptr, &ptr);
576 jit->epilogue_begin = read_leb128 (ptr, &ptr);
578 jit->num_line_numbers = read_leb128 (ptr, &ptr);
579 jit->line_numbers = g_new0 (MonoDebugLineNumberEntry, jit->num_line_numbers);
580 for (i = 0; i < jit->num_line_numbers; i++) {
581 MonoDebugLineNumberEntry *lne = &jit->line_numbers [i];
583 lne->il_offset = read_sleb128 (ptr, &ptr);
584 lne->native_offset = read_sleb128 (ptr, &ptr);
588 jit->this_var = g_new0 (MonoDebugVarInfo, 1);
589 read_variable (jit->this_var, ptr, &ptr);
592 jit->num_params = read_leb128 (ptr, &ptr);
593 jit->params = g_new0 (MonoDebugVarInfo, jit->num_params);
594 for (i = 0; i < jit->num_params; i++)
595 read_variable (&jit->params [i], ptr, &ptr);
597 jit->num_locals = read_leb128 (ptr, &ptr);
598 jit->locals = g_new0 (MonoDebugVarInfo, jit->num_locals);
599 for (i = 0; i < jit->num_locals; i++)
600 read_variable (&jit->locals [i], ptr, &ptr);
603 jit->gsharedvt_info_var = g_new0 (MonoDebugVarInfo, 1);
604 jit->gsharedvt_locals_var = g_new0 (MonoDebugVarInfo, 1);
605 read_variable (jit->gsharedvt_info_var, ptr, &ptr);
606 read_variable (jit->gsharedvt_locals_var, ptr, &ptr);
612 static MonoDebugMethodJitInfo *
613 find_method (MonoMethod *method, MonoDomain *domain)
615 MonoDebugDataTable *table;
616 MonoDebugMethodAddress *address;
618 table = lookup_data_table (domain);
619 address = g_hash_table_lookup (table->method_address_hash, method);
624 return mono_debug_read_method (address);
627 MonoDebugMethodJitInfo *
628 mono_debug_find_method (MonoMethod *method, MonoDomain *domain)
630 MonoDebugMethodJitInfo *res;
632 if (mono_debug_format == MONO_DEBUG_FORMAT_NONE)
635 mono_debugger_lock ();
636 res = find_method (method, domain);
637 mono_debugger_unlock ();
641 MonoDebugMethodAddressList *
642 mono_debug_lookup_method_addresses (MonoMethod *method)
644 g_assert_not_reached ();
649 il_offset_from_address (MonoMethod *method, MonoDomain *domain, guint32 native_offset)
651 MonoDebugMethodJitInfo *jit;
654 jit = find_method (method, domain);
655 if (!jit || !jit->line_numbers)
656 goto cleanup_and_fail;
658 for (i = jit->num_line_numbers - 1; i >= 0; i--) {
659 MonoDebugLineNumberEntry lne = jit->line_numbers [i];
661 if (lne.native_offset <= native_offset) {
662 mono_debug_free_method_jit_info (jit);
663 return lne.il_offset;
668 mono_debug_free_method_jit_info (jit);
673 * mono_debug_il_offset_from_address:
675 * Compute the IL offset corresponding to NATIVE_OFFSET inside the native
676 * code of METHOD in DOMAIN.
679 mono_debug_il_offset_from_address (MonoMethod *method, MonoDomain *domain, guint32 native_offset)
683 mono_debugger_lock ();
685 res = il_offset_from_address (method, domain, native_offset);
687 mono_debugger_unlock ();
693 * mono_debug_lookup_source_location:
694 * @address: Native offset within the @method's machine code.
696 * Lookup the source code corresponding to the machine instruction located at
697 * native offset @address within @method.
699 * The returned `MonoDebugSourceLocation' contains both file / line number
700 * information and the corresponding IL offset. It must be freed by
701 * mono_debug_free_source_location().
703 MonoDebugSourceLocation *
704 mono_debug_lookup_source_location (MonoMethod *method, guint32 address, MonoDomain *domain)
706 MonoDebugMethodInfo *minfo;
707 MonoDebugSourceLocation *location;
710 if (mono_debug_format == MONO_DEBUG_FORMAT_NONE)
713 mono_debugger_lock ();
714 minfo = mono_debug_lookup_method_internal (method);
715 if (!minfo || !minfo->handle || !minfo->handle->symfile || !mono_debug_symfile_is_loaded (minfo->handle->symfile)) {
716 mono_debugger_unlock ();
720 offset = il_offset_from_address (method, domain, address);
722 mono_debugger_unlock ();
726 location = mono_debug_symfile_lookup_location (minfo, offset);
727 mono_debugger_unlock ();
732 * mono_debug_lookup_locals:
734 * Return information about the local variables of MINFO.
735 * The result should be freed using mono_debug_symfile_free_locals ().
738 mono_debug_lookup_locals (MonoMethod *method)
740 MonoDebugMethodInfo *minfo;
741 MonoDebugLocalsInfo *res;
743 if (mono_debug_format == MONO_DEBUG_FORMAT_NONE)
746 mono_debugger_lock ();
747 minfo = mono_debug_lookup_method_internal (method);
748 if (!minfo || !minfo->handle || !minfo->handle->symfile || !mono_debug_symfile_is_loaded (minfo->handle->symfile)) {
749 mono_debugger_unlock ();
753 res = mono_debug_symfile_lookup_locals (minfo);
754 mono_debugger_unlock ();
760 * mono_debug_free_source_location:
761 * @location: A `MonoDebugSourceLocation'.
763 * Frees the @location.
766 mono_debug_free_source_location (MonoDebugSourceLocation *location)
769 g_free (location->source_file);
775 * mono_debug_print_stack_frame:
776 * @native_offset: Native offset within the @method's machine code.
778 * Conventient wrapper around mono_debug_lookup_source_location() which can be
779 * used if you only want to use the location to print a stack frame.
782 mono_debug_print_stack_frame (MonoMethod *method, guint32 native_offset, MonoDomain *domain)
784 MonoDebugSourceLocation *location;
785 gchar *fname, *ptr, *res;
788 fname = mono_method_full_name (method, TRUE);
789 for (ptr = fname; *ptr; ptr++) {
790 if (*ptr == ':') *ptr = '.';
793 location = mono_debug_lookup_source_location (method, native_offset, domain);
796 if (mono_debug_initialized) {
797 mono_debugger_lock ();
798 offset = il_offset_from_address (method, domain, native_offset);
799 mono_debugger_unlock ();
805 res = g_strdup_printf ("at %s <0x%05x>", fname, native_offset);
807 res = g_strdup_printf ("at %s <IL 0x%05x, 0x%05x>", fname, offset, native_offset);
812 res = g_strdup_printf ("at %s [0x%05x] in %s:%d", fname, location->il_offset,
813 location->source_file, location->row);
816 mono_debug_free_source_location (location);
821 mono_set_is_debugger_attached (gboolean attached)
823 is_attached = attached;
827 mono_is_debugger_attached (void)
836 typedef struct _BundledSymfile BundledSymfile;
838 struct _BundledSymfile {
839 BundledSymfile *next;
841 const mono_byte *raw_contents;
845 static BundledSymfile *bundled_symfiles = NULL;
848 mono_register_symfile_for_assembly (const char *assembly_name, const mono_byte *raw_contents, int size)
850 BundledSymfile *bsymfile;
852 bsymfile = g_new0 (BundledSymfile, 1);
853 bsymfile->aname = assembly_name;
854 bsymfile->raw_contents = raw_contents;
855 bsymfile->size = size;
856 bsymfile->next = bundled_symfiles;
857 bundled_symfiles = bsymfile;
860 static MonoDebugHandle *
861 open_symfile_from_bundle (MonoImage *image)
863 BundledSymfile *bsymfile;
865 for (bsymfile = bundled_symfiles; bsymfile; bsymfile = bsymfile->next) {
866 if (strcmp (bsymfile->aname, image->module_name))
869 return mono_debug_open_image (image, bsymfile->raw_contents, bsymfile->size);
876 mono_debugger_lock (void)
878 g_assert (initialized);
879 mono_mutex_lock (&debugger_lock_mutex);
883 mono_debugger_unlock (void)
885 g_assert (initialized);
886 mono_mutex_unlock (&debugger_lock_mutex);
890 mono_debugger_initialize ()
892 mono_mutex_init_recursive (&debugger_lock_mutex);
897 * mono_debug_enabled:
899 * Returns true is debug information is enabled. This doesn't relate if a debugger is present or not.
902 mono_debug_enabled (void)
904 return mono_debug_format != MONO_DEBUG_FORMAT_NONE;