2005-12-12 Zoltan Varga <vargaz@gmail.com>
[mono.git] / mono / mini / debug-mini.c
index c47cc5f0b5f5b3eaa205d0f3953360182b747e68..c7d98c3ce106a519fe8a72303225d3f7156524da 100644 (file)
 #include <mono/metadata/verify.h>
 #include <mono/metadata/mono-config.h>
 #include <mono/metadata/mono-debug.h>
-/* mono-debug-debugger.h nneds config.h to work... */
+#include <mono/metadata/appdomain.h>
+/* mono-debug-debugger.h needs config.h to work... */
 #include "config.h"
 #include <mono/metadata/mono-debug-debugger.h>
 
-static void
-record_line_number (MonoDebugMethodJitInfo *jit, guint32 address, guint32 offset)
-{
-       MonoDebugLineNumberEntry *lne = g_new0 (MonoDebugLineNumberEntry, 1);
-
-       lne->address = address;
-       lne->offset = offset;
-
-       g_array_append_val (jit->line_numbers, *lne);
-}
+#ifdef HAVE_VALGRIND_H
+#include <valgrind/valgrind.h>
+#endif
 
 typedef struct
 {
        MonoDebugMethodJitInfo *jit;
+       GArray *line_numbers;
        guint32 has_line_numbers;
        guint32 breakpoint_id;
 } MiniDebugMethodInfo;
 
+static inline void
+record_line_number (MiniDebugMethodInfo *info, guint32 address, guint32 offset)
+{
+       MonoDebugLineNumberEntry lne;
+
+       lne.native_offset = address;
+       lne.il_offset = 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)
                return;
 
-       if ((method->iflags & METHOD_IMPL_ATTRIBUTE_INTERNAL_CALL) ||
-           (method->iflags & METHOD_IMPL_ATTRIBUTE_RUNTIME) ||
-           (method->flags & METHOD_ATTRIBUTE_PINVOKE_IMPL) ||
-           (method->flags & METHOD_ATTRIBUTE_ABSTRACT) ||
-           (method->wrapper_type != MONO_WRAPPER_NONE))
-               return;
-
        info = g_new0 (MiniDebugMethodInfo, 1);
        info->breakpoint_id = breakpoint_id;
 
@@ -69,11 +67,11 @@ mono_debug_open_method (MonoCompile *cfg)
 
        mono_class_init (cfg->method->klass);
 
-       g_assert (((MonoMethodNormal*)cfg->method)->header);
-       header = ((MonoMethodNormal*)cfg->method)->header;
-
+       header = mono_method_get_header (cfg->method);
+       g_assert (header);
+       
        info->jit = jit = g_new0 (MonoDebugMethodJitInfo, 1);
-       jit->line_numbers = g_array_new (FALSE, TRUE, sizeof (MonoDebugLineNumberEntry));
+       info->line_numbers = g_array_new (FALSE, TRUE, sizeof (MonoDebugLineNumberEntry));
        jit->num_locals = header->num_locals;
        jit->locals = g_new0 (MonoDebugVarInfo, jit->num_locals);
 }
@@ -90,47 +88,155 @@ write_variable (MonoInst *inst, MonoDebugVarInfo *var)
        }
 }
 
+/*
+ * mono_debug_add_vg_method:
+ *
+ *  Register symbol information for the method with valgrind
+ */
+static void 
+mono_debug_add_vg_method (MonoMethod *method, MonoDebugMethodJitInfo *jit)
+{
+#ifdef VALGRIND_ADD_LINE_INFO
+       MonoMethodHeader *header;
+       int i;
+       char *filename = NULL;
+       guint32 address, line_number;
+       const char *full_name;
+       guint32 *addresses;
+       guint32 *lines;
+
+       if (!RUNNING_ON_VALGRIND)
+               return;
+
+       header = mono_method_get_header (method);
+
+       full_name = mono_method_full_name (method, TRUE);
+
+       addresses = g_new0 (guint32, header->code_size + 1);
+       lines = g_new0 (guint32, header->code_size + 1);
+
+       /* 
+        * Very simple code to convert the addr->offset mappings that mono has
+        * into [addr-addr] ->line number mappings.
+        */
+
+       /* Create offset->line number mapping */
+       for (i = 0; i < header->code_size; ++i) {
+               char *fname;
+
+               fname = mono_debug_source_location_from_il_offset (method, i, &lines [i]);
+               if (!filename)
+                       filename = fname;
+       }
+
+       /* Create address->offset mapping */
+       for (i = 0; i < jit->num_line_numbers; ++i) {
+               MonoDebugLineNumberEntry *lne = jit->line_numbers [i];
+
+               g_assert (lne->offset <= header->code_size);
+
+               if ((addresses [lne->offset] == 0) || (lne->address < addresses [lne->offset]))
+                       addresses [lne->offset] = lne->address;
+       }
+       /* Fill out missing addresses */
+       address = 0;
+       for (i = 0; i < header->code_size; ++i) {
+               if (addresses [i] == 0)
+                       addresses [i] = address;
+               else
+                       address = addresses [i];
+       }
+       
+       address = 0;
+       line_number = 0;
+       i = 0;
+       while (i < header->code_size) {
+               if (lines [i] == line_number)
+                       i ++;
+               else {
+                       if (line_number > 0) {
+                               //g_assert (addresses [i] - 1 >= address);
+                               
+                               if (addresses [i] - 1 >= address) {
+                                       VALGRIND_ADD_LINE_INFO (jit->code_start + address, jit->code_start + addresses [i] - 1, filename, line_number);
+                                       //printf ("[%d-%d] -> %d.\n", address, addresses [i] - 1, line_number);
+                               }
+                       }
+                       address = addresses [i];
+                       line_number = lines [i];
+               }
+       }
+
+       if (line_number > 0) {
+               VALGRIND_ADD_LINE_INFO (jit->code_start + address, jit->code_start + jit->code_size - 1, filename, line_number);
+               //printf ("[%d-%d] -> %d.\n", address, jit->code_size - 1, line_number);
+       }
+
+       VALGRIND_ADD_SYMBOL (jit->code_start, jit->code_size, full_name);
+
+       g_free (addresses);
+       g_free (lines);
+#endif /* VALGRIND_ADD_LINE_INFO */
+}
+
 void
 mono_debug_close_method (MonoCompile *cfg)
 {
        MiniDebugMethodInfo *info;
        MonoDebugMethodJitInfo *jit;
        MonoMethodHeader *header;
+       MonoMethodSignature *sig;
        MonoMethod *method;
        int i;
 
        info = (MiniDebugMethodInfo *) cfg->debug_info;
-       if (!info || !info->jit)
+       if (!info || !info->jit) {
+               if (info)
+                       g_free (info);
                return;
+       }
 
        method = cfg->method;
-       header = ((MonoMethodNormal*)method)->header;
+       header = mono_method_get_header (method);
+       sig = mono_method_signature (method);
 
        jit = info->jit;
        jit->code_start = cfg->native_code;
        jit->epilogue_begin = cfg->epilog_begin;
        jit->code_size = cfg->code_len;
 
-       record_line_number (jit, jit->epilogue_begin, header->code_size);
+       record_line_number (info, jit->epilogue_begin, header->code_size);
 
-       jit->num_params = method->signature->param_count;
+       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]);
 
-       if (method->signature->hasthis) {
+       if (sig->hasthis) {
                jit->this_var = g_new0 (MonoDebugVarInfo, 1);
                write_variable (cfg->varinfo [0], jit->this_var);
        }
 
        for (i = 0; i < jit->num_params; i++)
-               write_variable (cfg->varinfo [i + method->signature->hasthis], &jit->params [i]);
+               write_variable (cfg->varinfo [i + sig->hasthis], &jit->params [i]);
+
+       jit->num_line_numbers = info->line_numbers->len;
+       jit->line_numbers = g_new0 (MonoDebugLineNumberEntry, jit->num_line_numbers);
+
+       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);
 
+       mono_debug_add_vg_method (method, jit);
+
        if (info->breakpoint_id)
                mono_debugger_breakpoint_callback (method, info->breakpoint_id);
+
+       mono_debug_free_method_jit_info (jit);
+       g_array_free (info->line_numbers, TRUE);
+       g_free (info);
 }
 
 void
@@ -144,8 +250,8 @@ mono_debug_record_line_number (MonoCompile *cfg, MonoInst *ins, guint32 address)
        if (!info || !info->jit || !ins->cil_code)
                return;
 
-       g_assert (((MonoMethodNormal*)cfg->method)->header);
-       header = ((MonoMethodNormal*)cfg->method)->header;
+       header = mono_method_get_header (cfg->method);
+       g_assert (header);
 
        if ((ins->cil_code < header->code) ||
            (ins->cil_code > header->code + header->code_size))
@@ -157,7 +263,253 @@ mono_debug_record_line_number (MonoCompile *cfg, MonoInst *ins, guint32 address)
                info->has_line_numbers = TRUE;
        }
 
-       record_line_number (info->jit, address, offset);
+       record_line_number (info, address, offset);
+}
+
+static inline void
+encode_value (gint32 value, guint8 *buf, guint8 **endbuf)
+{
+       guint8 *p = buf;
+
+       //printf ("ENCODE: %d 0x%x.\n", value, value);
+
+       /* 
+        * Same encoding as the one used in the metadata, extended to handle values
+        * greater than 0x1fffffff.
+        */
+       if ((value >= 0) && (value <= 127))
+               *p++ = value;
+       else if ((value >= 0) && (value <= 16383)) {
+               p [0] = 0x80 | (value >> 8);
+               p [1] = value & 0xff;
+               p += 2;
+       } else if ((value >= 0) && (value <= 0x1fffffff)) {
+               p [0] = (value >> 24) | 0xc0;
+               p [1] = (value >> 16) & 0xff;
+               p [2] = (value >> 8) & 0xff;
+               p [3] = value & 0xff;
+               p += 4;
+       }
+       else {
+               p [0] = 0xff;
+               p [1] = (value >> 24) & 0xff;
+               p [2] = (value >> 16) & 0xff;
+               p [3] = (value >> 8) & 0xff;
+               p [4] = value & 0xff;
+               p += 5;
+       }
+       if (endbuf)
+               *endbuf = p;
+}
+
+static inline gint32
+decode_value (guint8 *ptr, guint8 **rptr)
+{
+       guint8 b = *ptr;
+       gint32 len;
+       
+       if ((b & 0x80) == 0){
+               len = b;
+               ++ptr;
+       } else if ((b & 0x40) == 0){
+               len = ((b & 0x3f) << 8 | ptr [1]);
+               ptr += 2;
+       } else if (b != 0xff) {
+               len = ((b & 0x1f) << 24) |
+                       (ptr [1] << 16) |
+                       (ptr [2] << 8) |
+                       ptr [3];
+               ptr += 4;
+       }
+       else {
+               len = (ptr [1] << 24) | (ptr [2] << 16) | (ptr [3] << 8) | ptr [4];
+               ptr += 5;
+       }
+       if (rptr)
+               *rptr = ptr;
+
+       //printf ("DECODE: %d.\n", len);
+       return len;
+}
+
+static void
+serialize_variable (MonoDebugVarInfo *var, guint8 *p, guint8 **endbuf)
+{
+       guint32 flags = var->index & MONO_DEBUG_VAR_ADDRESS_MODE_FLAGS;
+
+       switch (flags) {
+       case MONO_DEBUG_VAR_ADDRESS_MODE_REGISTER:
+               encode_value (var->index, p, &p);
+               break;
+       case MONO_DEBUG_VAR_ADDRESS_MODE_REGOFFSET:
+               encode_value (var->index, p, &p);
+               encode_value (var->offset, p, &p);
+               break;
+       default:
+               g_assert_not_reached ();
+       }
+       *endbuf = p;
+}
+
+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) {
+               *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);
+       encode_value (jit->epilogue_begin, p, &p);
+       encode_value (jit->prologue_end, p, &p);
+       encode_value (jit->code_size, p, &p);
+
+       for (i = 0; i < jit->num_params; ++i)
+               serialize_variable (&jit->params [i], p, &p);
+
+       if (mono_method_signature (cfg->method)->hasthis)
+               serialize_variable (jit->this_var, p, &p);
+
+       for (i = 0; i < jit->num_locals; i++)
+               serialize_variable (&jit->locals [i], p, &p);
+
+       encode_value (jit->num_line_numbers, p, &p);
+
+       prev_offset = 0;
+       prev_native_offset = 0;
+       for (i = 0; i < jit->num_line_numbers; ++i) {
+               /* Sometimes, the offset values are not in increasing order */
+               MonoDebugLineNumberEntry *lne = &jit->line_numbers [i];
+               encode_value (lne->il_offset - prev_offset, p, &p);
+               encode_value (lne->native_offset - prev_native_offset, p, &p);
+               prev_offset = lne->il_offset;
+               prev_native_offset = lne->native_offset;
+       }
+
+       g_assert (p - buf < size);
+
+       *out_buf = buf;
+       *buf_len = p - buf;
+}
+
+static void
+deserialize_variable (MonoDebugVarInfo *var, guint8 *p, guint8 **endbuf)
+{
+       guint32 flags;
+
+       var->index = decode_value (p, &p);
+
+       flags = var->index & MONO_DEBUG_VAR_ADDRESS_MODE_FLAGS;
+
+       switch (flags) {
+       case MONO_DEBUG_VAR_ADDRESS_MODE_REGISTER:
+               break;
+       case MONO_DEBUG_VAR_ADDRESS_MODE_REGOFFSET:
+               var->offset = decode_value (p, &p);
+               break;
+       default:
+               g_assert_not_reached ();
+       }
+       *endbuf = p;
+}
+
+static MonoDebugMethodJitInfo *
+deserialize_debug_info (MonoMethod *method, guint8 *code_start, guint8 *buf, guint32 buf_len)
+{
+       MonoMethodHeader *header;
+       gint32 offset, native_offset, prev_offset, prev_native_offset;
+       MonoDebugMethodJitInfo *jit;
+       guint8 *p;
+       int i;
+
+       header = mono_method_get_header (method);
+       g_assert (header);
+
+       jit = g_new0 (MonoDebugMethodJitInfo, 1);
+       jit->code_start = code_start;
+       jit->num_locals = header->num_locals;
+       jit->locals = g_new0 (MonoDebugVarInfo, jit->num_locals);
+       jit->num_params = mono_method_signature (method)->param_count;
+       jit->params = g_new0 (MonoDebugVarInfo, jit->num_params);
+
+       p = buf;
+       jit->epilogue_begin = decode_value (p, &p);
+       jit->prologue_end = decode_value (p, &p);
+       jit->code_size = decode_value (p, &p);
+
+       for (i = 0; i < jit->num_params; ++i)
+               deserialize_variable (&jit->params [i], p, &p);
+
+       if (mono_method_signature (method)->hasthis) {
+               jit->this_var = g_new0 (MonoDebugVarInfo, 1);
+               deserialize_variable (jit->this_var, p, &p);
+       }
+
+       for (i = 0; i < jit->num_locals; i++)
+               deserialize_variable (&jit->locals [i], p, &p);
+
+       jit->num_line_numbers = decode_value (p, &p);
+       jit->line_numbers = g_new0 (MonoDebugLineNumberEntry, jit->num_line_numbers);
+
+       prev_offset = 0;
+       prev_native_offset = 0;
+       for (i = 0; i < jit->num_line_numbers; ++i) {
+               MonoDebugLineNumberEntry *lne = &jit->line_numbers [i];
+
+               offset = prev_offset + decode_value (p, &p);
+               native_offset = prev_native_offset + decode_value (p, &p);
+
+               lne->native_offset = native_offset;
+               lne->il_offset = offset;
+
+               prev_offset = offset;
+               prev_native_offset = native_offset;
+       }
+
+       return jit;
+}
+
+void
+mono_debug_add_aot_method (MonoDomain *domain, MonoMethod *method, guint8 *code_start, 
+                          guint8 *debug_info, guint32 debug_info_len)
+{
+       MonoDebugMethodJitInfo *jit;
+
+       if (mono_debug_format == MONO_DEBUG_FORMAT_NONE)
+               return;
+
+       if ((method->iflags & METHOD_IMPL_ATTRIBUTE_INTERNAL_CALL) ||
+           (method->iflags & METHOD_IMPL_ATTRIBUTE_RUNTIME) ||
+           (method->flags & METHOD_ATTRIBUTE_PINVOKE_IMPL) ||
+           (method->flags & METHOD_ATTRIBUTE_ABSTRACT) ||
+           (method->wrapper_type != MONO_WRAPPER_NONE))
+               return;
+
+       if (debug_info_len == 0)
+               return;
+
+       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);
+
+       mono_debug_free_method_jit_info (jit);
 }
 
 MonoDomain *
@@ -178,11 +530,21 @@ mono_init_debugger (const char *file, const char *opt_flags)
 
        mono_config_parse (NULL);
 
-       error = mono_verify_corlib ();
+       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);
        }
 
        return domain;
 }
+
+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);
+}