2008-08-18 Zoltan Varga <vargaz@gmail.com>
[mono.git] / mono / mini / debug-mini.c
index 9a5dbdbcdd8c83bb91f9eec96a5d739d7412f6ea..cc06068cf6d69785ffbd48179d14fab79f80a4a4 100644 (file)
@@ -9,18 +9,30 @@
 
 #include "mini.h"
 #include "jit.h"
+#include "config.h"
 #include <mono/metadata/verify.h>
 #include <mono/metadata/mono-config.h>
 #include <mono/metadata/mono-debug.h>
 #include <mono/metadata/appdomain.h>
-/* mono-debug-debugger.h needs config.h to work... */
-#include "config.h"
+#include <mono/metadata/threads-types.h>
+
+#define _IN_THE_MONO_DEBUGGER
 #include <mono/metadata/mono-debug-debugger.h>
+#include "debug-mini.h"
 
 #ifdef HAVE_VALGRIND_H
 #include <valgrind/valgrind.h>
 #endif
 
+#ifdef MONO_DEBUGGER_SUPPORTED
+#include <libgc/include/libgc-mono-debugger.h>
+#endif
+
+typedef struct {
+       guint32 index;
+       MonoMethodDesc *desc;
+} MiniDebugBreakpointInfo;
+
 typedef struct
 {
        MonoDebugMethodJitInfo *jit;
@@ -29,6 +41,33 @@ typedef struct
        guint32 breakpoint_id;
 } MiniDebugMethodInfo;
 
+struct _MonoDebuggerThreadInfo {
+       guint64 tid;
+       guint64 lmf_addr;
+       guint64 end_stack;
+
+       guint64 extended_notifications;
+
+       /* Next pointer. */
+       MonoDebuggerThreadInfo *next;
+
+       /*
+        * The stack bounds are only used when reading a core file.
+        */
+       guint64 stack_start;
+       guint64 signal_stack_start;
+       guint32 stack_size;
+       guint32 signal_stack_size;
+
+       /*
+        * The debugger doesn't access anything beyond this point.
+        */
+       MonoJitTlsData *jit_tls;
+       MonoThread *thread;
+};
+
+MonoDebuggerThreadInfo *mono_debugger_thread_table = NULL;
+
 static inline void
 record_line_number (MiniDebugMethodInfo *info, guint32 address, guint32 offset)
 {
@@ -40,10 +79,10 @@ record_line_number (MiniDebugMethodInfo *info, guint32 address, guint32 offset)
        g_array_append_val (info->line_numbers, lne);
 }
 
+
 void
 mono_debug_init_method (MonoCompile *cfg, MonoBasicBlock *start_block, guint32 breakpoint_id)
 {
-       MonoMethod *method = cfg->method;
        MiniDebugMethodInfo *info;
 
        if (mono_debug_format == MONO_DEBUG_FORMAT_NONE)
@@ -80,9 +119,14 @@ mono_debug_open_method (MonoCompile *cfg)
 static void
 write_variable (MonoInst *inst, MonoDebugVarInfo *var)
 {
+       var->type = inst->inst_vtype;
+
        if (inst->opcode == OP_REGVAR)
                var->index = inst->dreg | MONO_DEBUG_VAR_ADDRESS_MODE_REGISTER;
-       else {
+       else if (inst->flags & MONO_INST_IS_DEAD) {
+               // FIXME:
+               var->index = 0 | MONO_DEBUG_VAR_ADDRESS_MODE_REGISTER;
+       } else {
                /* the debug interface needs fixing to allow 0(%base) address */
                var->index = inst->inst_basereg | MONO_DEBUG_VAR_ADDRESS_MODE_REGOFFSET;
                var->offset = inst->inst_offset;
@@ -99,6 +143,7 @@ mono_debug_add_vg_method (MonoMethod *method, MonoDebugMethodJitInfo *jit)
 {
 #ifdef VALGRIND_ADD_LINE_INFO
        MonoMethodHeader *header;
+       MonoDebugMethodInfo *minfo;
        int i;
        char *filename = NULL;
        guint32 address, line_number;
@@ -121,13 +166,22 @@ mono_debug_add_vg_method (MonoMethod *method, MonoDebugMethodJitInfo *jit)
         * into [addr-addr] ->line number mappings.
         */
 
-       /* Create offset->line number mapping */
-       for (i = 0; i < header->code_size; ++i) {
-               char *fname;
+       minfo = mono_debug_lookup_method (method);
+       if (minfo) {
+               /* Create offset->line number mapping */
+               for (i = 0; i < header->code_size; ++i) {
+                       MonoDebugSourceLocation *location;
+
+                       location = mono_debug_symfile_lookup_location (minfo, i);
+                       if (!location)
+                               continue;
+
+                       lines [i] = location.row;
+                       if (!filename)
+                               filename = location.source_file;
 
-               fname = mono_debug_source_location_from_il_offset (method, i, &lines [i]);
-               if (!filename)
-                       filename = fname;
+                       mono_debug_free_source_location (location);
+               }
        }
 
        /* Create address->offset mapping */
@@ -187,6 +241,7 @@ mono_debug_close_method (MonoCompile *cfg)
        MonoDebugMethodJitInfo *jit;
        MonoMethodHeader *header;
        MonoMethodSignature *sig;
+       MonoDebugMethodAddress *debug_info;
        MonoMethod *method;
        int i;
 
@@ -206,21 +261,22 @@ mono_debug_close_method (MonoCompile *cfg)
        jit->epilogue_begin = cfg->epilog_begin;
        jit->code_size = cfg->code_len;
 
-       record_line_number (info, jit->epilogue_begin, header->code_size);
+       if (jit->epilogue_begin)
+                  record_line_number (info, jit->epilogue_begin, header->code_size);
 
        jit->num_params = sig->param_count;
        jit->params = g_new0 (MonoDebugVarInfo, jit->num_params);
 
        for (i = 0; i < jit->num_locals; i++)
-               write_variable (cfg->varinfo [cfg->locals_start + i], &jit->locals [i]);
+               write_variable (cfg->locals [i], &jit->locals [i]);
 
        if (sig->hasthis) {
                jit->this_var = g_new0 (MonoDebugVarInfo, 1);
-               write_variable (cfg->varinfo [0], jit->this_var);
+               write_variable (cfg->args [0], jit->this_var);
        }
 
        for (i = 0; i < jit->num_params; i++)
-               write_variable (cfg->varinfo [i + sig->hasthis], &jit->params [i]);
+               write_variable (cfg->args [i + sig->hasthis], &jit->params [i]);
 
        jit->num_line_numbers = info->line_numbers->len;
        jit->line_numbers = g_new0 (MonoDebugLineNumberEntry, jit->num_line_numbers);
@@ -228,13 +284,15 @@ mono_debug_close_method (MonoCompile *cfg)
        for (i = 0; i < jit->num_line_numbers; i++)
                jit->line_numbers [i] = g_array_index (info->line_numbers, MonoDebugLineNumberEntry, i);
 
-       mono_debug_add_method (method, jit, cfg->domain);
+       debug_info = mono_debug_add_method (method, jit, cfg->domain);
 
        mono_debug_add_vg_method (method, jit);
 
        if (info->breakpoint_id)
                mono_debugger_breakpoint_callback (method, info->breakpoint_id);
 
+       mono_debugger_check_breakpoints (method, debug_info);
+
        mono_debug_free_method_jit_info (jit);
        g_array_free (info->line_numbers, TRUE);
        g_free (info);
@@ -267,6 +325,33 @@ mono_debug_record_line_number (MonoCompile *cfg, MonoInst *ins, guint32 address)
        record_line_number (info, address, offset);
 }
 
+void
+mono_debug_open_block (MonoCompile *cfg, MonoBasicBlock *bb, guint32 address)
+{
+       MiniDebugMethodInfo *info;
+       MonoMethodHeader *header;
+       guint32 offset;
+
+       info = (MiniDebugMethodInfo *) cfg->debug_info;
+       if (!info || !info->jit || !bb->cil_code)
+               return;
+
+       header = mono_method_get_header (cfg->method);
+       g_assert (header);
+
+       if ((bb->cil_code < header->code) ||
+           (bb->cil_code > header->code + header->code_size))
+               return;
+
+       offset = bb->cil_code - header->code;
+       if (!info->has_line_numbers) {
+               info->jit->prologue_end = address;
+               info->has_line_numbers = TRUE;
+       }
+
+       record_line_number (info, address, offset);
+}
+
 static inline void
 encode_value (gint32 value, guint8 *buf, guint8 **endbuf)
 {
@@ -355,18 +440,17 @@ serialize_variable (MonoDebugVarInfo *var, guint8 *p, guint8 **endbuf)
 void
 mono_debug_serialize_debug_info (MonoCompile *cfg, guint8 **out_buf, guint32 *buf_len)
 {
-       MiniDebugMethodInfo *info;
        MonoDebugMethodJitInfo *jit;
        guint32 size, prev_offset, prev_native_offset;
        guint8 *buf, *p;
        int i;
 
-       info = (MiniDebugMethodInfo *) cfg->debug_info;
-       if (!info || !info->jit) {
+       /* Can't use cfg->debug_info as it is freed by close_method () */
+       jit = mono_debug_find_method (cfg->method, mono_domain_get ());
+       if (!jit) {
                *buf_len = 0;
                return;
        }
-       jit = info->jit;
 
        size = ((jit->num_params + jit->num_locals + 1) * 10) + (jit->num_line_numbers * 10) + 64;
        p = buf = g_malloc (size);
@@ -500,12 +584,6 @@ mono_debug_add_aot_method (MonoDomain *domain, MonoMethod *method, guint8 *code_
 
        jit = deserialize_debug_info (method, code_start, debug_info, debug_info_len);
 
-#if 0
-       jit = mono_debug_read_method ((MonoDebugMethodAddress *) debug_info);
-       jit->code_start = code_start;
-       jit->wrapper_addr = NULL;
-#endif
-
        mono_debug_add_method (method, jit, domain);
 
        mono_debug_add_vg_method (method, jit);
@@ -513,39 +591,260 @@ mono_debug_add_aot_method (MonoDomain *domain, MonoMethod *method, guint8 *code_
        mono_debug_free_method_jit_info (jit);
 }
 
-MonoDomain *
-mono_init_debugger (const char *file, const char *opt_flags)
+void
+mono_debug_add_icall_wrapper (MonoMethod *method, MonoJitICallInfo* callinfo)
+{
+       if (mono_debug_format == MONO_DEBUG_FORMAT_NONE)
+               return;
+
+       // mono_debug_add_wrapper (method, callinfo->wrapper, callinfo->func);
+}
+
+static void
+print_var_info (MonoDebugVarInfo *info, int idx, const char *name, const char *type)
+{
+       switch (info->index & MONO_DEBUG_VAR_ADDRESS_MODE_FLAGS) {
+       case MONO_DEBUG_VAR_ADDRESS_MODE_REGISTER:
+               g_print ("%s %s (%d) in register %s\n", type, name, idx, mono_arch_regname (info->index & (~MONO_DEBUG_VAR_ADDRESS_MODE_FLAGS)));
+               break;
+       case MONO_DEBUG_VAR_ADDRESS_MODE_REGOFFSET:
+               g_print ("%s %s (%d) in memory: base register %s + %d\n", type, name, idx, mono_arch_regname (info->index & (~MONO_DEBUG_VAR_ADDRESS_MODE_FLAGS)), info->offset);
+               break;
+       case MONO_DEBUG_VAR_ADDRESS_MODE_TWO_REGISTERS:
+       default:
+               g_assert_not_reached ();
+       }
+}
+
+/**
+ * mono_debug_print_locals:
+ *
+ * Prints to stdout the information about the local variables in
+ * a method (if @only_arguments is false) or about the arguments.
+ * The information includes the storage info (where the variable 
+ * lives, in a register or in memory).
+ * The method is found by looking up what method has been emitted at
+ * the instruction address @ip.
+ * This is for use inside a debugger.
+ */
+void
+mono_debug_print_vars (gpointer ip, gboolean only_arguments)
+{
+       MonoDomain *domain = mono_domain_get ();
+       MonoJitInfo *ji = mono_jit_info_table_find (domain, ip);
+       MonoDebugMethodJitInfo *jit;
+       int i;
+
+       if (!ji)
+               return;
+
+       jit = mono_debug_find_method (mono_jit_info_get_method (ji), domain);
+       if (!jit)
+               return;
+
+       if (only_arguments) {
+               char **names;
+               names = g_new (char *, jit->num_params);
+               mono_method_get_param_names (mono_jit_info_get_method (ji), (const char **) names);
+               if (jit->this_var)
+                       print_var_info (jit->this_var, 0, "this", "Arg");
+               for (i = 0; i < jit->num_params; ++i) {
+                       print_var_info (&jit->params [i], i, names [i]? names [i]: "unknown name", "Arg");
+               }
+               g_free (names);
+       } else {
+               for (i = 0; i < jit->num_locals; ++i) {
+                       print_var_info (&jit->locals [i], i, "", "Local");
+               }
+       }
+       mono_debug_free_method_jit_info (jit);
+}
+
+/*
+ * The old Debugger breakpoint interface.
+ *
+ * This interface is used to insert breakpoints on methods which are not yet JITed.
+ * The debugging code keeps a list of all such breakpoints and automatically inserts the
+ * breakpoint when the method is JITed.
+ */
+
+static GPtrArray *breakpoints = NULL;
+
+int
+mono_debugger_insert_breakpoint_full (MonoMethodDesc *desc)
+{
+       static int last_breakpoint_id = 0;
+       MiniDebugBreakpointInfo *info;
+
+       info = g_new0 (MiniDebugBreakpointInfo, 1);
+       info->desc = desc;
+       info->index = ++last_breakpoint_id;
+
+       if (!breakpoints)
+               breakpoints = g_ptr_array_new ();
+
+       g_ptr_array_add (breakpoints, info);
+
+       return info->index;
+}
+
+int
+mono_debugger_remove_breakpoint (int breakpoint_id)
 {
-       MonoDomain *domain;
-       const char *error;
-       int opt;
+       int i;
+
+       if (!breakpoints)
+               return 0;
+
+       for (i = 0; i < breakpoints->len; i++) {
+               MiniDebugBreakpointInfo *info = g_ptr_array_index (breakpoints, i);
+
+               if (info->index != breakpoint_id)
+                       continue;
+
+               mono_method_desc_free (info->desc);
+               g_ptr_array_remove (breakpoints, info);
+               g_free (info);
+               return 1;
+       }
+
+       return 0;
+}
+
+int
+mono_debugger_insert_breakpoint (const gchar *method_name, gboolean include_namespace)
+{
+       MonoMethodDesc *desc;
 
-       g_set_prgname (file);
+       desc = mono_method_desc_new (method_name, include_namespace);
+       if (!desc)
+               return 0;
 
-       opt = mono_parse_default_optimizations (opt_flags);
-       opt |= MONO_OPT_SHARED;
+       return mono_debugger_insert_breakpoint_full (desc);
+}
 
-       mono_set_defaults (0, opt);
+int
+mono_debugger_method_has_breakpoint (MonoMethod *method)
+{
+       int i;
 
-       domain = mono_jit_init (file);
+       if (!breakpoints || (method->wrapper_type != MONO_WRAPPER_NONE))
+               return 0;
 
-       mono_config_parse (NULL);
+       for (i = 0; i < breakpoints->len; i++) {
+               MiniDebugBreakpointInfo *info = g_ptr_array_index (breakpoints, i);
 
-       error = mono_check_corlib_version ();
-       if (error) {
-               fprintf (stderr, "Corlib not in sync with this runtime: %s\n", error);
-               fprintf (stderr, "Download a newer corlib or a newer runtime at http://www.go-mono.com/daily.\n");
-               exit (1);
+               if (!mono_method_desc_full_match (info->desc, method))
+                       continue;
+
+               return info->index;
        }
 
-       return domain;
+       return 0;
 }
 
 void
-mono_debug_add_icall_wrapper (MonoMethod *method, MonoJitICallInfo* callinfo)
+mono_debugger_breakpoint_callback (MonoMethod *method, guint32 index)
+{
+       mono_debugger_event (MONO_DEBUGGER_EVENT_JIT_BREAKPOINT, (guint64) (gsize) method, index);
+}
+
+void
+mono_debugger_thread_created (gsize tid, MonoThread *thread, MonoJitTlsData *jit_tls)
+{
+#ifdef MONO_DEBUGGER_SUPPORTED
+       size_t stsize = 0;
+       guint8 *staddr = NULL;
+       MonoDebuggerThreadInfo *info;
+
+       if (mono_debug_format == MONO_DEBUG_FORMAT_NONE)
+               return;
+
+       mono_debugger_lock ();
+
+       mono_thread_get_stack_bounds (&staddr, &stsize);
+
+       info = g_new0 (MonoDebuggerThreadInfo, 1);
+       info->tid = tid;
+       info->thread = thread;
+       info->stack_start = (guint64) (gsize) staddr;
+       info->signal_stack_start = (guint64) (gsize) jit_tls->signal_stack;
+       info->stack_size = stsize;
+       info->signal_stack_size = jit_tls->signal_stack_size;
+       info->end_stack = (guint64) (gsize) GC_mono_debugger_get_stack_ptr ();
+       info->lmf_addr = (guint64) (gsize) mono_get_lmf_addr ();
+       info->jit_tls = jit_tls;
+
+       info->next = mono_debugger_thread_table;
+       mono_debugger_thread_table = info;
+
+       mono_debugger_event (MONO_DEBUGGER_EVENT_THREAD_CREATED,
+                            tid, (guint64) (gsize) info);
+
+       mono_debugger_unlock ();
+#endif /* MONO_DEBUGGER_SUPPORTED */
+}
+
+void
+mono_debugger_thread_cleanup (MonoJitTlsData *jit_tls)
 {
+#ifdef MONO_DEBUGGER_SUPPORTED
+       MonoDebuggerThreadInfo **ptr;
+
        if (mono_debug_format == MONO_DEBUG_FORMAT_NONE)
                return;
 
-       // mono_debug_add_wrapper (method, callinfo->wrapper, callinfo->func);
+       mono_debugger_lock ();
+
+       for (ptr = &mono_debugger_thread_table; *ptr; ptr = &(*ptr)->next) {
+               MonoDebuggerThreadInfo *info = *ptr;
+
+               if (info->jit_tls != jit_tls)
+                       continue;
+
+               mono_debugger_event (MONO_DEBUGGER_EVENT_THREAD_CLEANUP,
+                                    info->tid, (guint64) (gsize) info);
+
+               *ptr = info->next;
+               g_free (info);
+               break;
+       }
+
+       mono_debugger_unlock ();
+#endif
+}
+
+void
+mono_debugger_extended_notification (MonoDebuggerEvent event, guint64 data, guint64 arg)
+{
+#ifdef MONO_DEBUGGER_SUPPORTED
+       MonoDebuggerThreadInfo **ptr;
+       MonoThread *thread = mono_thread_current ();
+
+       if (!mono_debug_using_mono_debugger ())
+               return;
+
+       mono_debugger_lock ();
+
+       for (ptr = &mono_debugger_thread_table; *ptr; ptr = &(*ptr)->next) {
+               MonoDebuggerThreadInfo *info = *ptr;
+
+               if (info->thread != thread)
+                       continue;
+
+               if ((info->extended_notifications & (int) event) == 0)
+                       continue;
+
+               mono_debugger_event (event, data, arg);
+       }
+
+       mono_debugger_unlock ();
+#endif
+}
+
+void
+mono_debugger_trampoline_compiled (MonoMethod *method, const guint8 *code)
+{
+       mono_debugger_extended_notification (MONO_DEBUGGER_EVENT_TRAMPOLINE,
+                                            (guint64) (gsize) method, (guint64) (gsize) code);
 }