mono/metadata/debug-mono-symfile.c

   1 #include <config.h>
   2 #include <stdlib.h>
   3 #include <stdio.h>
   4 #include <errno.h>
   5 #include <string.h>
   6 #include <signal.h>
   7 #include <sys/param.h>
   8 #include <sys/stat.h>
   9 #include <mono/metadata/metadata.h>
  10 #include <mono/metadata/tabledefs.h>
  11 #include <mono/metadata/rawbuffer.h>
  12 #include <mono/metadata/tokentype.h>
  13 #include <mono/metadata/appdomain.h>
  14 #include <mono/metadata/exception.h>
  15 #include <mono/metadata/debug-helpers.h>
  16 #include <mono/metadata/mono-debug.h>
  17 #include <mono/metadata/debug-mono-symfile.h>
  18 #include <mono/metadata/mono-debug-debugger.h>
  19 #include <mono/metadata/mono-endian.h>
  20 #include <mono/metadata/metadata-internals.h>
  21 #include <mono/metadata/class-internals.h>
  22
  23 #include <fcntl.h>
  24 #include <unistd.h>
  25
  26 #define RANGE_TABLE_CHUNK_SIZE          256
  27 #define CLASS_TABLE_CHUNK_SIZE          256
  28 #define TYPE_TABLE_PTR_CHUNK_SIZE       256
  29 #define TYPE_TABLE_CHUNK_SIZE           65536
  30
  31 static void
  32 free_method_info (MonoDebugMethodInfo *minfo)
  33 {
  34         g_free (minfo);
  35 }
  36
  37 static gchar *
  38 get_class_name (MonoClass *klass)
  39 {
  40         MonoClass *nested_in = mono_class_get_nesting_type (klass);
  41         const char *name_space;
  42         if (nested_in) {
  43                 gchar *parent_name = get_class_name (nested_in);
  44                 gchar *name = g_strdup_printf ("%s.%s", parent_name, mono_class_get_name (klass));
  45                 g_free (parent_name);
  46                 return name;
  47         }
  48
  49         name_space = mono_class_get_namespace (klass);
  50         return g_strdup_printf ("%s%s%s", name_space,
  51                                 name_space [0] ? "." : "", mono_class_get_name (klass));
  52 }
  53
  54 static int
  55 load_symfile (MonoDebugHandle *handle, MonoSymbolFile *symfile, gboolean in_the_debugger)
  56 {
  57         const char *ptr, *start;
  58         gchar *guid;
  59         guint64 magic;
  60         long version;
  61
  62         ptr = start = symfile->raw_contents;
  63         if (!ptr)
  64                 return FALSE;
  65
  66         magic = read64(ptr);
  67         ptr += sizeof(guint64);
  68         if (magic != MONO_SYMBOL_FILE_MAGIC) {
  69                 if (!in_the_debugger)
  70                         g_warning ("Symbol file %s is not a mono symbol file", symfile->filename);
  71                 return FALSE;
  72         }
  73
  74         version = read32(ptr);
  75         ptr += sizeof(guint32);
  76         if (version != MONO_SYMBOL_FILE_VERSION) {
  77                 if (!in_the_debugger)
  78                         g_warning ("Symbol file %s has incorrect version "
  79                                    "(expected %d, got %ld)", symfile->filename,
  80                                    MONO_SYMBOL_FILE_VERSION, version);
  81                 return FALSE;
  82         }
  83
  84         guid = mono_guid_to_string ((const guint8 *) ptr);
  85         ptr += 16;
  86
  87         if (strcmp (handle->image->guid, guid)) {
  88                 if (!in_the_debugger)
  89                         g_warning ("Symbol file %s doesn't match image %s", symfile->filename,
  90                                    handle->image_file);
  91                 if (guid)
  92                         g_free (guid);
  93                 return FALSE;
  94         }
  95
  96         symfile->offset_table = (MonoSymbolFileOffsetTable *) ptr;
  97
  98         symfile->method_hash = g_hash_table_new_full (
  99                 g_direct_hash, g_direct_equal, NULL, (GDestroyNotify) free_method_info);
 100
 101         g_free (guid);
 102         return TRUE;
 103 }
 104
 105 MonoSymbolFile *
 106 mono_debug_open_mono_symbols (MonoDebugHandle *handle, const guint8 *raw_contents,
 107                               int size, gboolean in_the_debugger)
 108 {
 109         MonoSymbolFile *symfile;
 110         FILE* f;
 111
 112         mono_debugger_lock ();
 113         symfile = g_new0 (MonoSymbolFile, 1);
 114
 115         if (raw_contents != NULL) {
 116                 symfile->raw_contents_size = size;
 117                 symfile->raw_contents = g_malloc (size);
 118                 memcpy(symfile->raw_contents, raw_contents, size);
 119                 symfile->filename = g_strdup_printf ("LoadedFromMemory");
 120         } else {
 121                 symfile->filename = g_strdup_printf ("%s.mdb", mono_image_get_filename (handle->image));
 122
 123                 if ((f = fopen (symfile->filename, "rb"))) {
 124                         struct stat stat_buf;
 125
 126                         if (fstat (fileno (f), &stat_buf) < 0) {
 127                                 if (!in_the_debugger)
 128                                         g_warning ("stat of %s failed: %s",
 129                                                    symfile->filename,  g_strerror (errno));
 130                         } else {
 131                                 symfile->raw_contents_size = stat_buf.st_size;
 132                                 symfile->raw_contents = mono_raw_buffer_load (fileno (f), FALSE, 0, stat_buf.st_size);
 133                         }
 134
 135                         fclose (f);
 136                 }
 137         }
 138
 139         if (load_symfile (handle, symfile, in_the_debugger)) {
 140                 mono_debugger_unlock ();
 141                 return symfile;
 142         } else if (!in_the_debugger) {
 143                 mono_debug_close_mono_symbol_file (symfile);
 144                 mono_debugger_unlock ();
 145                 return NULL;
 146         }
 147
 148         mono_debugger_unlock ();
 149         return symfile;
 150 }
 151
 152 void
 153 mono_debug_close_mono_symbol_file (MonoSymbolFile *symfile)
 154 {
 155         if (!symfile)
 156                 return;
 157
 158         mono_debugger_lock ();
 159         if (symfile->method_hash)
 160                 g_hash_table_destroy (symfile->method_hash);
 161
 162         if (symfile->raw_contents)
 163                 mono_raw_buffer_free ((gpointer) symfile->raw_contents);
 164
 165         if (symfile->filename)
 166                 g_free (symfile->filename);
 167         g_free (symfile);
 168         mono_debugger_unlock ();
 169 }
 170
 171 static int
 172 read_leb128 (const char *ptr, const char **rptr)
 173 {
 174         int ret = 0;
 175         int shift = 0;
 176         char b;
 177
 178         do {
 179                 b = *ptr++;
 180
 181                 ret = ret | ((b & 0x7f) << shift);
 182                 shift += 7;
 183         } while ((b & 0x80) == 0x80);
 184
 185         if (rptr)
 186                 *rptr = ptr;
 187
 188         return ret;
 189 }
 190
 191 static gchar *
 192 read_string (const char *ptr)
 193 {
 194         int len = read_leb128 (ptr, &ptr);
 195         return g_filename_from_utf8 (ptr, len, NULL, NULL, NULL);
 196 }
 197
 198 /**
 199  * mono_debug_symfile_lookup_location:
 200  * @minfo: A `MonoDebugMethodInfo' which can be retrieved by
 201  *         mono_debug_lookup_method().
 202  * @offset: IL offset within the corresponding method's CIL code.
 203  *
 204  * This function is similar to mono_debug_lookup_location(), but we
 205  * already looked up the method and also already did the
 206  * `native address -> IL offset' mapping.
 207  */
 208 MonoDebugSourceLocation *
 209 mono_debug_symfile_lookup_location (MonoDebugMethodInfo *minfo, guint32 offset)
 210 {
 211         MonoSymbolFileLineNumberEntry *lne;
 212         MonoSymbolFile *symfile;
 213         gchar *source_file = NULL;
 214         const char *ptr;
 215         int count, i;
 216
 217         if ((symfile = minfo->handle->symfile) == NULL)
 218                 return NULL;
 219
 220         mono_debugger_lock ();
 221
 222         if (read32(&(minfo->entry->_source_index))) {
 223                 int offset = read32(&(symfile->offset_table->_source_table_offset)) +
 224                         (read32(&(minfo->entry->_source_index)) - 1) * sizeof (MonoSymbolFileSourceEntry);
 225                 MonoSymbolFileSourceEntry *se = (MonoSymbolFileSourceEntry *) (symfile->raw_contents + offset);
 226
 227                 source_file = read_string (symfile->raw_contents + read32(&(se->_name_offset)));
 228         }
 229
 230         ptr = symfile->raw_contents + read32(&(minfo->entry->_line_number_table_offset));
 231
 232         count = read32(&(minfo->entry->_num_line_numbers));
 233         lne = ((MonoSymbolFileLineNumberEntry *) ptr) + count - 1;
 234
 235         for (i = count - 1; i >= 0; i--, lne--) {
 236                 MonoDebugSourceLocation *location;
 237
 238                 if (read32(&(lne->_offset)) > offset)
 239                         continue;
 240
 241                 location = g_new0 (MonoDebugSourceLocation, 1);
 242                 location->source_file = source_file;
 243                 location->row = read32(&(lne->_row));
 244                 location->il_offset = read32(&(lne->_offset));
 245
 246                 mono_debugger_unlock ();
 247                 return location;
 248         }
 249
 250         mono_debugger_unlock ();
 251         return NULL;
 252 }
 253
 254 gint32
 255 _mono_debug_address_from_il_offset (MonoDebugMethodJitInfo *jit, guint32 il_offset)
 256 {
 257         int i;
 258
 259         if (!jit || !jit->line_numbers)
 260                 return -1;
 261
 262         for (i = jit->num_line_numbers - 1; i >= 0; i--) {
 263                 MonoDebugLineNumberEntry lne = jit->line_numbers [i];
 264
 265                 if (lne.il_offset <= il_offset)
 266                         return lne.native_offset;
 267         }
 268
 269         return -1;
 270 }
 271
 272 static int
 273 compare_method (const void *key, const void *object)
 274 {
 275         guint32 token = GPOINTER_TO_UINT (key);
 276         MonoSymbolFileMethodIndexEntry *me = (MonoSymbolFileMethodIndexEntry*)object;
 277
 278         return token - read32(&(me->_token));
 279 }
 280
 281 MonoDebugMethodInfo *
 282 mono_debug_symfile_lookup_method (MonoDebugHandle *handle, MonoMethod *method)
 283 {
 284         MonoSymbolFileMethodEntry *me;
 285         MonoSymbolFileMethodIndexEntry *first_ie, *ie;
 286         MonoDebugMethodInfo *minfo;
 287         MonoSymbolFile *symfile = handle->symfile;
 288
 289         if (!symfile->method_hash)
 290                 return NULL;
 291
 292         if (handle->image != mono_class_get_image (mono_method_get_class (method)))
 293                 return NULL;
 294
 295         mono_debugger_lock ();
 296         first_ie = (MonoSymbolFileMethodIndexEntry *)
 297                 (symfile->raw_contents + read32(&(symfile->offset_table->_method_table_offset)));
 298
 299         ie = bsearch (GUINT_TO_POINTER (mono_method_get_token (method)), first_ie,
 300                                    read32(&(symfile->offset_table->_method_count)),
 301                                    sizeof (MonoSymbolFileMethodIndexEntry), compare_method);
 302
 303         if (!ie) {
 304                 mono_debugger_unlock ();
 305                 return NULL;
 306         }
 307
 308         me = (MonoSymbolFileMethodEntry *) (symfile->raw_contents + read32(&(ie->_file_offset)));
 309
 310         minfo = g_new0 (MonoDebugMethodInfo, 1);
 311         minfo->index = (ie - first_ie) + 1;
 312         minfo->method = method;
 313         minfo->handle = handle;
 314         minfo->num_il_offsets = read32(&(me->_num_line_numbers));
 315         minfo->il_offsets = (MonoSymbolFileLineNumberEntry *)
 316                 (symfile->raw_contents + read32(&(me->_line_number_table_offset)));
 317         minfo->num_lexical_blocks = read32(&(me->_num_lexical_blocks));
 318         minfo->lexical_blocks = (MonoSymbolFileLexicalBlockEntry *)
 319                 (symfile->raw_contents + read32(&(me->_lexical_block_table_offset)));
 320         minfo->entry = me;
 321
 322         g_hash_table_insert (symfile->method_hash, method, minfo);
 323
 324         mono_debugger_unlock ();
 325         return minfo;
 326 }