5 #include <mono/metadata/metadata.h>
6 #include <mono/metadata/tabledefs.h>
7 #include <mono/metadata/rawbuffer.h>
8 #include <mono/metadata/tokentype.h>
9 #include <mono/metadata/appdomain.h>
10 #include <mono/metadata/exception.h>
11 #include <mono/metadata/debug-helpers.h>
12 #include <mono/metadata/debug-mono-symfile.h>
17 struct MonoSymbolFilePriv
23 guint32 string_table_size;
24 guint32 string_offset_size;
26 GHashTable *method_table;
27 GHashTable *method_hash;
28 MonoSymbolFileOffsetTable *offset_table;
29 GPtrArray *range_table;
35 MonoDebugMethodInfo *minfo;
36 MonoSymbolFileMethodEntry *entry;
37 guint32 method_name_offset;
40 } MonoSymbolFileMethodEntryPriv;
42 static int write_string_table (MonoSymbolFile *symfile);
43 static int create_symfile (MonoSymbolFile *symfile, gboolean emit_warnings);
44 static void close_symfile (MonoSymbolFile *symfile);
47 free_method_info (MonoDebugMethodInfo *minfo)
54 load_symfile (MonoSymbolFile *symfile)
56 MonoSymbolFilePriv *priv = symfile->_priv;
57 MonoSymbolFileMethodEntry *me;
58 const char *ptr, *start;
63 ptr = start = symfile->raw_contents;
65 magic = *((guint64 *) ptr)++;
66 if (magic != MONO_SYMBOL_FILE_MAGIC) {
67 g_warning ("Symbol file %s has is not a mono symbol file", priv->file_name);
71 version = *((guint32 *) ptr)++;
72 if (version != MONO_SYMBOL_FILE_VERSION) {
73 g_warning ("Symbol file %s has incorrect line number table version "
74 "(expected %d, got %ld)", priv->file_name,
75 MONO_SYMBOL_FILE_VERSION, version);
79 priv->offset_table = (MonoSymbolFileOffsetTable *) ptr;
80 symfile->address_table_size = priv->offset_table->address_table_size;
87 priv->method_table = g_hash_table_new_full (g_direct_hash, g_direct_equal, NULL,
88 (GDestroyNotify) g_free);
89 priv->method_hash = g_hash_table_new_full (g_direct_hash, g_direct_equal, NULL,
90 (GDestroyNotify) free_method_info);
92 ptr = symfile->raw_contents + priv->offset_table->method_table_offset;
93 me = (MonoSymbolFileMethodEntry *) ptr;
95 for (i = 0; i < priv->offset_table->method_count; i++, me++) {
96 MonoMethod *method = mono_get_method (priv->image, me->token, NULL);
97 MonoSymbolFileMethodEntryPriv *mep;
98 MonoDebugMethodInfo *minfo;
103 if ((method->iflags & METHOD_IMPL_ATTRIBUTE_INTERNAL_CALL) ||
104 (method->iflags & METHOD_IMPL_ATTRIBUTE_RUNTIME) ||
105 (method->flags & METHOD_ATTRIBUTE_PINVOKE_IMPL))
106 g_assert_not_reached ();
108 if (!((MonoMethodNormal *) method)->header) {
109 g_warning (G_STRLOC ": Internal error: method %s.%s doesn't have a header",
110 method->klass->name, method->name);
114 minfo = g_new0 (MonoDebugMethodInfo, 1);
115 minfo->file_offset = ((const char *) me) - start;
116 minfo->method = method;
117 minfo->symfile = symfile;
118 minfo->num_il_offsets = me->num_line_numbers;
119 minfo->il_offsets = (MonoSymbolFileLineNumberEntry *)
120 (symfile->raw_contents + me->line_number_table_offset);
122 mep = g_new0 (MonoSymbolFileMethodEntryPriv, 1);
123 mep->method = method;
128 mep->method_name_offset = priv->string_table_size;
129 mep->name = g_strdup_printf ("%s%s.%s", method->klass->name_space,
130 method->klass->name, method->name);
131 priv->string_table_size += strlen (mep->name) + 1;
133 g_hash_table_insert (priv->method_table, method, mep);
134 g_hash_table_insert (priv->method_hash, method, minfo);
137 if (!write_string_table (symfile))
144 mono_debug_open_mono_symbol_file (MonoImage *image, const char *filename, gboolean emit_warnings)
146 MonoSymbolFile *symfile;
147 MonoSymbolFilePriv *priv;
152 fd = open (filename, O_RDONLY);
155 g_warning ("Can't open symbol file: %s", filename);
159 file_size = lseek (fd, 0, SEEK_END);
160 lseek (fd, 0, SEEK_SET);
162 if (file_size == (off_t) -1) {
164 g_warning ("Can't get size of symbol file: %s", filename);
168 ptr = mono_raw_buffer_load (fd, FALSE, 0, file_size);
171 g_warning ("Can't read symbol file: %s", filename);
175 symfile = g_new0 (MonoSymbolFile, 1);
176 symfile->magic = MONO_SYMBOL_FILE_MAGIC;
177 symfile->version = MONO_SYMBOL_FILE_VERSION;
178 symfile->image_file = g_strdup (image->name);
179 symfile->raw_contents = ptr;
180 symfile->raw_contents_size = file_size;
182 symfile->_priv = priv = g_new0 (MonoSymbolFilePriv, 1);
186 priv->file_name = g_strdup (filename);
188 if (!load_symfile (symfile)) {
189 mono_debug_close_mono_symbol_file (symfile);
197 close_symfile (MonoSymbolFile *symfile)
199 MonoSymbolFilePriv *priv = symfile->_priv;
201 if (symfile->raw_contents) {
202 mono_raw_buffer_free (symfile->raw_contents);
203 symfile->raw_contents = NULL;
211 if (priv->method_table) {
212 g_hash_table_destroy (priv->method_table);
213 priv->method_table = NULL;
216 if (priv->method_hash) {
217 g_hash_table_destroy (priv->method_hash);
218 priv->method_hash = NULL;
221 if (symfile->is_dynamic)
222 unlink (priv->file_name);
224 if (symfile->image_file) {
225 g_free (symfile->image_file);
226 symfile->image_file = NULL;
229 if (priv->file_name) {
230 g_free (priv->file_name);
231 priv->file_name = NULL;
238 mono_debug_close_mono_symbol_file (MonoSymbolFile *symfile)
243 close_symfile (symfile);
245 g_free (symfile->_priv->source_file);
246 g_free (symfile->_priv);
251 write_string (int fd, const char *string)
253 guint32 length = strlen (string);
255 if (write (fd, &length, sizeof (length)) < 0)
258 if (write (fd, string, strlen (string)) < 0)
265 read_string (const char *ptr)
267 int len = *((guint32 *) ptr)++;
269 return g_filename_from_utf8 (ptr, len, NULL, NULL, NULL);
273 mono_debug_find_source_location (MonoSymbolFile *symfile, MonoMethod *method, guint32 offset,
274 guint32 *line_number)
276 MonoSymbolFilePriv *priv = symfile->_priv;
277 MonoSymbolFileLineNumberEntry *lne;
278 MonoSymbolFileMethodEntryPriv *mep;
279 gchar *source_file = NULL;
283 if (!priv->method_table || symfile->is_dynamic)
286 mep = g_hash_table_lookup (priv->method_table, method);
290 if (mep->entry->source_file_offset)
291 source_file = read_string (symfile->raw_contents + mep->entry->source_file_offset);
293 ptr = symfile->raw_contents + mep->entry->line_number_table_offset;
295 lne = (MonoSymbolFileLineNumberEntry *) ptr;
297 for (i = 0; i < mep->entry->num_line_numbers; i++, lne++) {
298 if (lne->offset < offset)
302 *line_number = lne->row;
307 } else if (source_file) {
308 gchar *retval = g_strdup_printf ("%s:%d", source_file, lne->row);
309 g_free (source_file);
312 return g_strdup_printf ("%d", lne->row);
319 update_method_func (gpointer key, gpointer value, gpointer user_data)
321 MonoSymbolFile *symfile = (MonoSymbolFile *) user_data;
322 MonoSymbolFileMethodEntryPriv *mep = (MonoSymbolFileMethodEntryPriv *) value;
323 MonoSymbolFileMethodAddress *address;
324 MonoDebugVarInfo *var_table;
325 MonoSymbolFileLineNumberEntry *lne;
326 MonoDebugRangeInfo *range;
330 mep->minfo = g_hash_table_lookup (symfile->_priv->method_hash, mep->method);
335 if (!mep->minfo->jit)
338 address = (MonoSymbolFileMethodAddress *)
339 (symfile->address_table + mep->entry->address_table_offset);
341 address->is_valid = TRUE;
342 address->start_address = GPOINTER_TO_UINT (mep->minfo->jit->code_start);
343 address->end_address = GPOINTER_TO_UINT (mep->minfo->jit->code_start + mep->minfo->jit->code_size);
345 range = g_new0 (MonoDebugRangeInfo, 1);
346 range->start_address = address->start_address;
347 range->end_address = address->end_address;
348 range->file_offset = mep->minfo->file_offset;
350 var_table = (MonoDebugVarInfo *)
351 (symfile->address_table + mep->entry->variable_table_offset);
353 if (mep->entry->this_type_index) {
354 if (!mep->minfo->jit->this_var) {
355 g_warning (G_STRLOC ": Method %s.%s doesn't have `this'.",
356 mep->method->klass->name, mep->method->name);
359 *var_table++ = *mep->minfo->jit->this_var;
362 if (mep->minfo->jit->num_params != mep->entry->num_parameters) {
363 g_warning (G_STRLOC ": Method %s.%s has %d parameters, but symbol file claims it has %d.",
364 mep->method->klass->name, mep->method->name, mep->minfo->jit->num_params,
365 mep->entry->num_parameters);
366 var_table += mep->entry->num_parameters;
368 for (i = 0; i < mep->minfo->jit->num_params; i++)
369 *var_table++ = mep->minfo->jit->params [i];
371 if (mep->minfo->jit->num_locals != mep->entry->num_locals) {
372 g_warning (G_STRLOC ": Method %s.%s has %d locals, but symbol file claims it has %d.",
373 mep->method->klass->name, mep->method->name, mep->minfo->jit->num_locals,
374 mep->entry->num_locals);
375 var_table += mep->entry->num_locals;
377 for (i = 0; i < mep->minfo->jit->num_locals; i++)
378 *var_table++ = mep->minfo->jit->locals [i];
380 g_ptr_array_add (symfile->_priv->range_table, range);
382 lne = (MonoSymbolFileLineNumberEntry *)
383 (symfile->raw_contents + mep->entry->line_number_table_offset);
385 for (i = 0; i < mep->entry->num_line_numbers; i++, lne++) {
389 address->line_addresses [i] = 0;
391 } else if (lne->offset == 0) {
392 address->line_addresses [i] = mep->minfo->jit->prologue_end;
396 address->line_addresses [i] = mep->minfo->jit->code_size;
398 for (j = 0; j < mep->minfo->num_il_offsets; j++) {
399 MonoSymbolFileLineNumberEntry *il = &mep->minfo->il_offsets [j];
401 if (il->offset >= lne->offset) {
402 address->line_addresses [i] = mep->minfo->jit->il_addresses [j];
410 range_table_compare_func (gconstpointer a, gconstpointer b)
412 const MonoDebugRangeInfo *r1 = (const MonoDebugRangeInfo *) a;
413 const MonoDebugRangeInfo *r2 = (const MonoDebugRangeInfo *) b;
415 if (r1->start_address < r2->start_address)
417 else if (r1->start_address > r2->start_address)
424 mono_debug_update_mono_symbol_file (MonoSymbolFile *symfile)
428 if (!symfile->_priv->method_table)
431 symfile->_priv->range_table = g_ptr_array_new ();
433 if (!symfile->address_table)
434 symfile->address_table = g_malloc0 (symfile->address_table_size);
436 g_hash_table_foreach (symfile->_priv->method_table, update_method_func, symfile);
438 symfile->range_table_size = symfile->_priv->range_table->len * sizeof (MonoDebugRangeInfo);
439 symfile->range_table = g_malloc0 (symfile->range_table_size);
441 g_ptr_array_sort (symfile->_priv->range_table, range_table_compare_func);
443 for (i = 0; i < symfile->_priv->range_table->len; i++) {
444 MonoDebugRangeInfo *range = g_ptr_array_index (symfile->_priv->range_table, i);
446 symfile->range_table [i] = *range;
449 g_ptr_array_free (symfile->_priv->range_table, TRUE);
450 symfile->_priv->range_table = NULL;
454 free_method_entry (MonoSymbolFileMethodEntryPriv *mep)
462 create_method (MonoSymbolFile *symfile, guint32 token, MonoMethod *method)
464 MonoSymbolFileMethodEntryPriv *mep;
465 MonoDebugMethodInfo *minfo;
467 g_assert (method->klass->image == symfile->_priv->image);
469 mep = g_new0 (MonoSymbolFileMethodEntryPriv, 1);
470 mep->entry = g_new0 (MonoSymbolFileMethodEntry, 1);
471 mep->entry->token = token;
472 mep->entry->source_file_offset = symfile->_priv->offset_table->source_table_offset;
474 mep->method_name_offset = symfile->_priv->string_table_size;
475 mep->name = g_strdup_printf ("%s%s.%s", method->klass->name_space,
476 method->klass->name, method->name);
477 symfile->_priv->string_table_size += strlen (mep->name) + 1;
479 minfo = g_new0 (MonoDebugMethodInfo, 1);
480 minfo->method = method;
481 minfo->symfile = symfile;
484 mep->method = method;
486 symfile->_priv->offset_table->method_count++;
488 g_hash_table_insert (symfile->_priv->method_table, method, mep);
489 g_hash_table_insert (symfile->_priv->method_hash, method, minfo);
493 write_method (gpointer key, gpointer value, gpointer user_data)
495 MonoSymbolFile *symfile = (MonoSymbolFile *) user_data;
496 MonoSymbolFileMethodEntryPriv *mep = (MonoSymbolFileMethodEntryPriv *) value;
498 if (symfile->_priv->error)
501 mep->minfo->file_offset = lseek (symfile->_priv->fd, 0, SEEK_CUR);
503 if (write (symfile->_priv->fd, mep->entry, sizeof (MonoSymbolFileMethodEntry)) < 0) {
504 symfile->_priv->error = TRUE;
510 write_line_numbers (gpointer key, gpointer value, gpointer user_data)
512 MonoSymbolFile *symfile = (MonoSymbolFile *) user_data;
513 MonoSymbolFilePriv *priv = symfile->_priv;
514 MonoSymbolFileMethodEntryPriv *mep = (MonoSymbolFileMethodEntryPriv *) value;
515 MonoSymbolFileLineNumberEntry lne;
516 const unsigned char *ip, *start, *end;
517 MonoMethodHeader *header;
522 if ((mep->method->iflags & METHOD_IMPL_ATTRIBUTE_INTERNAL_CALL) ||
523 (mep->method->iflags & METHOD_IMPL_ATTRIBUTE_RUNTIME) ||
524 (mep->method->flags & METHOD_ATTRIBUTE_PINVOKE_IMPL))
525 g_assert_not_reached ();
527 header = ((MonoMethodNormal *) mep->method)->header;
530 mep->entry->line_number_table_offset = lseek (priv->fd, 0, SEEK_CUR);
531 ++mep->entry->num_line_numbers;
536 if (write (priv->fd, &lne, sizeof (MonoSymbolFileLineNumberEntry)) < 0) {
541 ip = start = header->code;
542 end = ip + header->code_size;
547 ++mep->entry->num_line_numbers;
548 lne.offset = ip - start;
551 if (write (priv->fd, &lne, sizeof (MonoSymbolFileLineNumberEntry)) < 0) {
556 line = mono_disasm_code_one (NULL, mep->method, ip, &ip);
560 mep->entry->address_table_offset = symfile->address_table_size;
561 mep->entry->address_table_size = sizeof (MonoSymbolFileMethodAddress) +
562 mep->entry->num_line_numbers * sizeof (guint32);
564 symfile->address_table_size += mep->entry->address_table_size;
568 create_methods (MonoSymbolFile *symfile)
570 MonoImage *image = symfile->_priv->image;
571 MonoTableInfo *table = &image->tables [MONO_TABLE_METHOD];
574 for (idx = 1; idx <= table->rows; idx++) {
575 guint32 token = mono_metadata_make_token (MONO_TABLE_METHOD, idx);
576 MonoMethod *method = mono_get_method (image, token, NULL);
578 if ((method->iflags & METHOD_IMPL_ATTRIBUTE_INTERNAL_CALL) ||
579 (method->iflags & METHOD_IMPL_ATTRIBUTE_RUNTIME) ||
580 (method->flags & METHOD_ATTRIBUTE_PINVOKE_IMPL))
583 if (method->wrapper_type != MONO_WRAPPER_NONE)
586 if ((method->iflags & METHOD_IMPL_ATTRIBUTE_INTERNAL_CALL) ||
587 (method->iflags & METHOD_IMPL_ATTRIBUTE_RUNTIME) ||
588 (method->flags & METHOD_ATTRIBUTE_PINVOKE_IMPL))
589 g_assert_not_reached ();
591 if (!((MonoMethodNormal *) method)->header) {
592 g_warning (G_STRLOC ": Internal error: method %s.%s doesn't have a header",
593 method->klass->name, method->name);
597 create_method (symfile, token, method);
602 load_line_numbers (gpointer key, gpointer value, gpointer user_data)
604 MonoSymbolFile *symfile = (MonoSymbolFile *) user_data;
605 MonoSymbolFileMethodEntryPriv *mep = (MonoSymbolFileMethodEntryPriv *) value;
607 mep->minfo->num_il_offsets = mep->entry->num_line_numbers;
608 mep->minfo->il_offsets = (MonoSymbolFileLineNumberEntry *)
609 (symfile->raw_contents + mep->entry->line_number_table_offset);
613 create_symfile (MonoSymbolFile *symfile, gboolean emit_warnings)
615 MonoSymbolFilePriv *priv = symfile->_priv;
621 priv->fd = g_file_open_tmp (NULL, &priv->file_name, NULL);
622 if (priv->fd == -1) {
624 g_warning ("Can't create symbol file");
628 magic = MONO_SYMBOL_FILE_MAGIC;
629 if (write (priv->fd, &magic, sizeof (magic)) < 0)
632 version = MONO_SYMBOL_FILE_VERSION;
633 if (write (priv->fd, &version, sizeof (version)) < 0)
636 offset = lseek (priv->fd, 0, SEEK_CUR);
638 priv->offset_table = g_new0 (MonoSymbolFileOffsetTable, 1);
639 if (write (priv->fd, priv->offset_table, sizeof (MonoSymbolFileOffsetTable)) < 0)
643 // Write source file table.
645 if (priv->source_file) {
646 priv->offset_table->source_table_offset = lseek (priv->fd, 0, SEEK_CUR);
647 if (!write_string (priv->fd, priv->source_file))
649 priv->offset_table->source_table_size = lseek (priv->fd, 0, SEEK_CUR) -
650 priv->offset_table->source_table_offset;
654 // Create method table.
657 priv->method_table = g_hash_table_new_full (g_direct_hash, g_direct_equal, NULL,
658 (GDestroyNotify) free_method_entry);
659 priv->method_hash = g_hash_table_new_full (g_direct_hash, g_direct_equal, NULL,
660 (GDestroyNotify) free_method_info);
662 create_methods (symfile);
665 // Write line numbers.
668 priv->offset_table->line_number_table_offset = lseek (priv->fd, 0, SEEK_CUR);
670 g_hash_table_foreach (priv->method_table, write_line_numbers, symfile);
674 priv->offset_table->line_number_table_size = lseek (priv->fd, 0, SEEK_CUR) -
675 priv->offset_table->line_number_table_offset;
678 // Write method table.
681 priv->offset_table->method_table_offset = lseek (priv->fd, 0, SEEK_CUR);
683 g_hash_table_foreach (priv->method_table, write_method, symfile);
687 priv->offset_table->method_table_size = lseek (priv->fd, 0, SEEK_CUR) -
688 priv->offset_table->method_table_offset;
691 // Write offset table.
694 symfile->raw_contents_size = lseek (priv->fd, 0, SEEK_CUR);
695 priv->offset_table->address_table_size = symfile->address_table_size;
697 lseek (priv->fd, offset, SEEK_SET);
698 if (write (priv->fd, priv->offset_table, sizeof (MonoSymbolFileOffsetTable)) < 0)
701 lseek (priv->fd, symfile->raw_contents_size, SEEK_SET);
703 ptr = mono_raw_buffer_load (priv->fd, TRUE, 0, symfile->raw_contents_size);
707 symfile->raw_contents = ptr;
710 // Load line number table.
712 g_hash_table_foreach (priv->method_table, load_line_numbers, symfile);
716 if (!write_string_table (symfile))
723 mono_debug_create_mono_symbol_file (MonoImage *image)
725 MonoSymbolFile *symfile;
727 symfile = g_new0 (MonoSymbolFile, 1);
728 symfile->magic = MONO_SYMBOL_FILE_MAGIC;
729 symfile->version = MONO_SYMBOL_FILE_VERSION;
730 symfile->is_dynamic = TRUE;
731 symfile->image_file = g_strdup (image->name);
733 symfile->_priv = g_new0 (MonoSymbolFilePriv, 1);
734 symfile->_priv->image = image;
736 if (!create_symfile (symfile, TRUE)) {
737 mono_debug_close_mono_symbol_file (symfile);
744 MonoDebugMethodInfo *
745 mono_debug_find_method (MonoSymbolFile *symfile, MonoMethod *method)
747 return g_hash_table_lookup (symfile->_priv->method_hash, method);
751 write_method_name (gpointer key, gpointer value, gpointer user_data)
753 MonoSymbolFile *symfile = (MonoSymbolFile *) user_data;
754 MonoSymbolFileMethodEntryPriv *mep = (MonoSymbolFileMethodEntryPriv *) value;
755 MonoSymbolFilePriv *priv = symfile->_priv;
756 guint8 *offset_ptr, *string_ptr;
759 offset = mep->method_name_offset + priv->string_offset_size;
761 offset_ptr = symfile->string_table + mep->index * 4;
762 string_ptr = symfile->string_table + offset;
764 *((guint32 *) offset_ptr) = offset;
765 strcpy (string_ptr, mep->name);
769 write_string_table (MonoSymbolFile *symfile)
771 MonoSymbolFilePriv *priv = symfile->_priv;
773 priv->string_offset_size = priv->offset_table->method_count * 4;
775 symfile->string_table_size = priv->string_table_size + priv->string_offset_size;
776 symfile->string_table = g_malloc0 (symfile->string_table_size);
778 g_hash_table_foreach (symfile->_priv->method_table, write_method_name, symfile);
782 MonoReflectionMethod *
783 ves_icall_MonoDebugger_GetMethod (MonoReflectionAssembly *assembly, guint32 token)
787 method = mono_get_method (assembly->assembly->image, token, NULL);
789 return mono_method_get_object (mono_domain_get (), method, NULL);