2 * dwarfwriter.c: Creation of DWARF debug information
5 * Zoltan Varga (vargaz@gmail.com)
7 * (C) 2008-2009 Novell, Inc.
12 #if !defined(DISABLE_AOT) && !defined(DISABLE_JIT)
13 #include "dwarfwriter.h"
15 #include <sys/types.h>
22 #include <mono/metadata/mono-endian.h>
23 #include <mono/metadata/debug-mono-symfile.h>
24 #include <mono/utils/mono-compiler.h>
27 #include <mono/utils/freebsd-elf32.h>
28 #include <mono/utils/freebsd-elf64.h>
31 #include <mono/utils/freebsd-dwarf.h>
35 char *start_symbol, *end_symbol;
38 MonoDebugMethodJitInfo *debug_info;
39 } MethodLineNumberInfo;
41 struct _MonoDwarfWriter
44 GHashTable *class_to_die, *class_to_vtype_die, *class_to_pointer_die;
45 GHashTable *class_to_reference_die;
46 int fde_index, tdie_index, line_number_file_index, line_number_dir_index;
47 GHashTable *file_to_index, *index_to_file, *dir_to_index;
49 int il_file_line_index, loclist_index;
52 const char *temp_prefix;
53 gboolean emit_line, appending, collect_line_info;
58 emit_line_number_info (MonoDwarfWriter *w, MonoMethod *method,
59 char *start_symbol, char *end_symbol,
60 guint8 *code, guint32 code_size,
61 MonoDebugMethodJitInfo *debug_info);
64 * mono_dwarf_writer_create:
66 * Create a DWARF writer object. WRITER is the underlying image writer this
67 * writer will emit to. IL_FILE is the file where IL code will be dumped to for
68 * methods which have no line number info. It can be NULL.
69 * If APPENDING is TRUE, the output file will be in assembleable state after each
70 * call to the _emit_ functions. This is used for XDEBUG. If APPENDING is FALSE,
71 * a separate mono_dwarf_writer_close () call is needed to finish the emission of
75 mono_dwarf_writer_create (MonoImageWriter *writer, FILE *il_file, int il_file_start_line, gboolean appending)
77 MonoDwarfWriter *w = g_new0 (MonoDwarfWriter, 1);
80 * The appending flag is needed because we use subsections to order things in
81 * the debug info, and:
82 * - apple's assembler doesn't support them
83 * - the binary writer has problems with subsections+alignment
84 * So instead of subsections, we use the _close () function in AOT mode,
85 * which writes out things in order.
90 w->il_file_line_index = il_file_start_line;
91 w->appending = appending;
94 g_assert (img_writer_subsections_supported (w->w));
99 if (!img_writer_subsections_supported (w->w))
100 /* Can't emit line number info without subsections */
101 w->emit_line = FALSE;
103 /* Collect line number info and emit it at once */
104 w->collect_line_info = TRUE;
107 w->fp = img_writer_get_fp (w->w);
108 w->temp_prefix = img_writer_get_temp_label_prefix (w->w);
110 w->class_to_die = g_hash_table_new (NULL, NULL);
111 w->class_to_vtype_die = g_hash_table_new (NULL, NULL);
112 w->class_to_pointer_die = g_hash_table_new (NULL, NULL);
113 w->class_to_reference_die = g_hash_table_new (NULL, NULL);
119 mono_dwarf_writer_destroy (MonoDwarfWriter *w)
125 mono_dwarf_writer_get_il_file_line_index (MonoDwarfWriter *w)
127 return w->il_file_line_index;
130 /* Wrappers around the image writer functions */
133 emit_section_change (MonoDwarfWriter *w, const char *section_name, int subsection_index)
135 img_writer_emit_section_change (w->w, section_name, subsection_index);
139 emit_push_section (MonoDwarfWriter *w, const char *section_name, int subsection)
141 img_writer_emit_push_section (w->w, section_name, subsection);
145 emit_pop_section (MonoDwarfWriter *w)
147 img_writer_emit_pop_section (w->w);
151 emit_local_symbol (MonoDwarfWriter *w, const char *name, const char *end_label, gboolean func)
153 img_writer_emit_local_symbol (w->w, name, end_label, func);
157 emit_label (MonoDwarfWriter *w, const char *name)
159 img_writer_emit_label (w->w, name);
163 emit_bytes (MonoDwarfWriter *w, const guint8* buf, int size)
165 img_writer_emit_bytes (w->w, buf, size);
169 emit_string (MonoDwarfWriter *w, const char *value)
171 img_writer_emit_string (w->w, value);
175 emit_line (MonoDwarfWriter *w)
177 img_writer_emit_line (w->w);
181 emit_alignment (MonoDwarfWriter *w, int size)
183 img_writer_emit_alignment (w->w, size);
187 emit_pointer_unaligned (MonoDwarfWriter *w, const char *target)
189 img_writer_emit_pointer_unaligned (w->w, target);
193 emit_pointer (MonoDwarfWriter *w, const char *target)
195 img_writer_emit_pointer (w->w, target);
199 emit_int16 (MonoDwarfWriter *w, int value)
201 img_writer_emit_int16 (w->w, value);
205 emit_int32 (MonoDwarfWriter *w, int value)
207 img_writer_emit_int32 (w->w, value);
211 emit_symbol_diff (MonoDwarfWriter *w, const char *end, const char* start, int offset)
213 img_writer_emit_symbol_diff (w->w, end, start, offset);
217 emit_zero_bytes (MonoDwarfWriter *w, int num)
219 img_writer_emit_zero_bytes (w->w, num);
223 emit_byte (MonoDwarfWriter *w, guint8 val)
225 img_writer_emit_byte (w->w, val);
228 static G_GNUC_UNUSED void
229 emit_uleb128 (MonoDwarfWriter *w, guint32 value)
232 guint8 b = value & 0x7f;
234 if (value != 0) /* more bytes to come */
240 static G_GNUC_UNUSED void
241 emit_sleb128 (MonoDwarfWriter *w, gint64 value)
244 gboolean negative = (value < 0);
251 /* the following is unnecessary if the
252 * implementation of >>= uses an arithmetic rather
253 * than logical shift for a signed left operand
257 value |= - ((gint64)1 <<(size - 7));
258 /* sign bit of byte is second high order bit (0x40) */
259 if ((value == 0 && !(byte & 0x40)) ||
260 (value == -1 && (byte & 0x40)))
268 static G_GNUC_UNUSED void
269 encode_uleb128 (guint32 value, guint8 *buf, guint8 **endbuf)
274 guint8 b = value & 0x7f;
276 if (value != 0) /* more bytes to come */
284 static G_GNUC_UNUSED void
285 encode_sleb128 (gint32 value, guint8 *buf, guint8 **endbuf)
288 gboolean negative = (value < 0);
296 /* the following is unnecessary if the
297 * implementation of >>= uses an arithmetic rather
298 * than logical shift for a signed left operand
302 value |= - (1 <<(size - 7));
303 /* sign bit of byte is second high order bit (0x40) */
304 if ((value == 0 && !(byte & 0x40)) ||
305 (value == -1 && (byte & 0x40)))
316 emit_dwarf_abbrev (MonoDwarfWriter *w, int code, int tag, gboolean has_child,
317 int *attrs, int attrs_len)
321 emit_uleb128 (w, code);
322 emit_uleb128 (w, tag);
323 emit_byte (w, has_child);
325 for (i = 0; i < attrs_len; i++)
326 emit_uleb128 (w, attrs [i]);
332 emit_cie (MonoDwarfWriter *w)
334 emit_section_change (w, ".debug_frame", 0);
336 emit_alignment (w, 8);
339 emit_symbol_diff (w, ".Lcie0_end", ".Lcie0_start", 0); /* length */
340 emit_label (w, ".Lcie0_start");
341 emit_int32 (w, 0xffffffff); /* CIE id */
342 emit_byte (w, 3); /* version */
343 emit_string (w, ""); /* augmention */
344 emit_sleb128 (w, 1); /* code alignment factor */
345 emit_sleb128 (w, mono_unwind_get_dwarf_data_align ()); /* data alignment factor */
346 emit_uleb128 (w, mono_unwind_get_dwarf_pc_reg ());
348 w->cie_program = w->cie_program;
349 if (w->cie_program) {
351 guint8 *uw_info = mono_unwind_ops_encode (w->cie_program, &uw_info_len);
352 emit_bytes (w, uw_info, uw_info_len);
356 emit_alignment (w, sizeof (gpointer));
357 emit_label (w, ".Lcie0_end");
361 emit_pointer_value (MonoDwarfWriter *w, gpointer ptr)
363 gssize val = (gssize)ptr;
364 emit_bytes (w, (guint8*)&val, sizeof (gpointer));
368 emit_fde (MonoDwarfWriter *w, int fde_index, char *start_symbol, char *end_symbol,
369 guint8 *code, guint32 code_size, GSList *unwind_ops, gboolean use_cie)
377 emit_section_change (w, ".debug_frame", 0);
379 sprintf (symbol1, ".Lfde%d_start", fde_index);
380 sprintf (symbol2, ".Lfde%d_end", fde_index);
381 emit_symbol_diff (w, symbol2, symbol1, 0); /* length */
382 emit_label (w, symbol1);
383 emit_int32 (w, 0); /* CIE_pointer */
385 emit_pointer (w, start_symbol); /* initial_location */
387 emit_symbol_diff (w, end_symbol, start_symbol, 0); /* address_range */
389 g_assert (code_size);
390 emit_int32 (w, code_size);
393 emit_pointer_value (w, code);
394 emit_int32 (w, code_size);
396 #if SIZEOF_VOID_P == 8
397 /* Upper 32 bits of code size */
402 if (w->cie_program) {
403 // FIXME: Check that the ops really begin with the CIE program */
406 for (i = 0; i < g_slist_length (w->cie_program); ++i)
411 /* Convert the list of MonoUnwindOps to the format used by DWARF */
412 uw_info = mono_unwind_ops_encode (l, &uw_info_len);
413 emit_bytes (w, uw_info, uw_info_len);
416 emit_alignment (w, sizeof (mgreg_t));
417 emit_label (w, symbol2);
421 #define ABBREV_COMPILE_UNIT 1
422 #define ABBREV_SUBPROGRAM 2
423 #define ABBREV_PARAM 3
424 #define ABBREV_BASE_TYPE 4
425 #define ABBREV_STRUCT_TYPE 5
426 #define ABBREV_DATA_MEMBER 6
427 #define ABBREV_TYPEDEF 7
428 #define ABBREV_ENUM_TYPE 8
429 #define ABBREV_ENUMERATOR 9
430 #define ABBREV_NAMESPACE 10
431 #define ABBREV_VARIABLE 11
432 #define ABBREV_VARIABLE_LOCLIST 12
433 #define ABBREV_POINTER_TYPE 13
434 #define ABBREV_REFERENCE_TYPE 14
435 #define ABBREV_PARAM_LOCLIST 15
436 #define ABBREV_INHERITANCE 16
437 #define ABBREV_STRUCT_TYPE_NOCHILDREN 17
439 static int compile_unit_attr [] = {
440 DW_AT_producer ,DW_FORM_string,
441 DW_AT_name ,DW_FORM_string,
442 DW_AT_comp_dir ,DW_FORM_string,
443 DW_AT_language ,DW_FORM_data1,
444 DW_AT_low_pc ,DW_FORM_addr,
445 DW_AT_high_pc ,DW_FORM_addr,
446 DW_AT_stmt_list ,DW_FORM_data4
449 static int subprogram_attr [] = {
450 DW_AT_name , DW_FORM_string,
451 DW_AT_description , DW_FORM_string,
452 DW_AT_low_pc , DW_FORM_addr,
453 DW_AT_high_pc , DW_FORM_addr,
454 DW_AT_frame_base , DW_FORM_block1
457 static int param_attr [] = {
458 DW_AT_name, DW_FORM_string,
459 DW_AT_type, DW_FORM_ref4,
460 DW_AT_location, DW_FORM_block1
463 static int param_loclist_attr [] = {
464 DW_AT_name, DW_FORM_string,
465 DW_AT_type, DW_FORM_ref4,
466 DW_AT_location, DW_FORM_data4
469 static int base_type_attr [] = {
470 DW_AT_byte_size, DW_FORM_data1,
471 DW_AT_encoding, DW_FORM_data1,
472 DW_AT_name, DW_FORM_string
475 static int struct_type_attr [] = {
476 DW_AT_name, DW_FORM_string,
477 DW_AT_byte_size, DW_FORM_udata,
480 static int data_member_attr [] = {
481 DW_AT_name, DW_FORM_string,
482 DW_AT_type, DW_FORM_ref4,
483 DW_AT_data_member_location, DW_FORM_block1
486 static int typedef_attr [] = {
487 DW_AT_name, DW_FORM_string,
488 DW_AT_type, DW_FORM_ref4
491 static int pointer_type_attr [] = {
492 DW_AT_type, DW_FORM_ref4,
495 static int reference_type_attr [] = {
496 DW_AT_type, DW_FORM_ref4,
499 static int enum_type_attr [] = {
500 DW_AT_name, DW_FORM_string,
501 DW_AT_byte_size, DW_FORM_udata,
502 DW_AT_type, DW_FORM_ref4,
505 static int enumerator_attr [] = {
506 DW_AT_name, DW_FORM_string,
507 DW_AT_const_value, DW_FORM_sdata,
510 static int namespace_attr [] = {
511 DW_AT_name, DW_FORM_string,
514 static int variable_attr [] = {
515 DW_AT_name, DW_FORM_string,
516 DW_AT_type, DW_FORM_ref4,
517 DW_AT_location, DW_FORM_block1
520 static int variable_loclist_attr [] = {
521 DW_AT_name, DW_FORM_string,
522 DW_AT_type, DW_FORM_ref4,
523 DW_AT_location, DW_FORM_data4
526 static int inheritance_attr [] = {
527 DW_AT_type, DW_FORM_ref4,
528 DW_AT_data_member_location, DW_FORM_block1
531 typedef struct DwarfBasicType {
532 const char *die_name, *name;
538 static DwarfBasicType basic_types [] = {
539 { ".LDIE_I1", "sbyte", MONO_TYPE_I1, 1, DW_ATE_signed },
540 { ".LDIE_U1", "byte", MONO_TYPE_U1, 1, DW_ATE_unsigned },
541 { ".LDIE_I2", "short", MONO_TYPE_I2, 2, DW_ATE_signed },
542 { ".LDIE_U2", "ushort", MONO_TYPE_U2, 2, DW_ATE_unsigned },
543 { ".LDIE_I4", "int", MONO_TYPE_I4, 4, DW_ATE_signed },
544 { ".LDIE_U4", "uint", MONO_TYPE_U4, 4, DW_ATE_unsigned },
545 { ".LDIE_I8", "long", MONO_TYPE_I8, 8, DW_ATE_signed },
546 { ".LDIE_U8", "ulong", MONO_TYPE_U8, 8, DW_ATE_unsigned },
547 { ".LDIE_I", "intptr", MONO_TYPE_I, SIZEOF_VOID_P, DW_ATE_signed },
548 { ".LDIE_U", "uintptr", MONO_TYPE_U, SIZEOF_VOID_P, DW_ATE_unsigned },
549 { ".LDIE_R4", "float", MONO_TYPE_R4, 4, DW_ATE_float },
550 { ".LDIE_R8", "double", MONO_TYPE_R8, 8, DW_ATE_float },
551 { ".LDIE_BOOLEAN", "boolean", MONO_TYPE_BOOLEAN, 1, DW_ATE_boolean },
552 { ".LDIE_CHAR", "char", MONO_TYPE_CHAR, 2, DW_ATE_unsigned_char },
553 { ".LDIE_STRING", "string", MONO_TYPE_STRING, sizeof (gpointer), DW_ATE_address },
554 { ".LDIE_OBJECT", "object", MONO_TYPE_OBJECT, sizeof (gpointer), DW_ATE_address },
555 { ".LDIE_SZARRAY", "object", MONO_TYPE_SZARRAY, sizeof (gpointer), DW_ATE_address },
558 /* Constants for encoding line number special opcodes */
559 #define OPCODE_BASE 13
561 #define LINE_RANGE 14
563 /* Subsections of the .debug_line section */
564 #define LINE_SUBSECTION_HEADER 1
565 #define LINE_SUBSECTION_INCLUDES 2
566 #define LINE_SUBSECTION_FILES 3
567 #define LINE_SUBSECTION_DATA 4
568 #define LINE_SUBSECTION_END 5
571 emit_line_number_file_name (MonoDwarfWriter *w, const char *name,
572 gint64 last_mod_time, gint64 file_size)
576 char *basename = NULL;
578 if (!w->file_to_index)
579 w->file_to_index = g_hash_table_new (g_str_hash, g_str_equal);
581 index = GPOINTER_TO_UINT (g_hash_table_lookup (w->file_to_index, name));
585 if (g_path_is_absolute (name)) {
586 char *dir = g_path_get_dirname (name);
588 if (!w->dir_to_index)
589 w->dir_to_index = g_hash_table_new (g_str_hash, g_str_equal);
591 dir_index = GPOINTER_TO_UINT (g_hash_table_lookup (w->dir_to_index, dir));
592 if (dir_index == 0) {
593 emit_section_change (w, ".debug_line", LINE_SUBSECTION_INCLUDES);
594 emit_string (w, dir);
596 dir_index = ++ w->line_number_dir_index;
597 g_hash_table_insert (w->dir_to_index, g_strdup (dir), GUINT_TO_POINTER (dir_index));
602 basename = g_path_get_basename (name);
607 emit_section_change (w, ".debug_line", LINE_SUBSECTION_FILES);
610 emit_string (w, basename);
612 emit_string (w, name);
613 emit_uleb128 (w, dir_index);
617 emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
622 index = ++ w->line_number_file_index;
623 g_hash_table_insert (w->file_to_index, g_strdup (name), GUINT_TO_POINTER (index));
629 get_line_number_file_name (MonoDwarfWriter *w, const char *name)
633 g_assert (w->file_to_index);
634 index = GPOINTER_TO_UINT (g_hash_table_lookup (w->file_to_index, name));
635 g_assert (index > 0);
640 add_line_number_file_name (MonoDwarfWriter *w, const char *name,
641 gint64 last_mod_time, gint64 file_size)
646 if (!w->file_to_index) {
647 w->file_to_index = g_hash_table_new (g_str_hash, g_str_equal);
648 w->index_to_file = g_hash_table_new (NULL, NULL);
651 index = GPOINTER_TO_UINT (g_hash_table_lookup (w->file_to_index, name));
654 index = w->line_number_file_index;
655 w->line_number_file_index ++;
656 copy = g_strdup (name);
657 g_hash_table_insert (w->file_to_index, copy, GUINT_TO_POINTER (index + 1));
658 g_hash_table_insert (w->index_to_file, GUINT_TO_POINTER (index + 1), copy);
664 emit_line_number_info_begin (MonoDwarfWriter *w)
666 /* Line number info header */
668 * GAS seems to emit its own data to the end of the first subsection, so we use
669 * subsections 1, 2 etc:
670 * 1 - contains the header
671 * 2 - contains the file names
672 * 3 - contains the end of the header + the data
675 emit_section_change (w, ".debug_line", 0);
676 emit_label (w, ".Ldebug_line_section_start");
677 emit_section_change (w, ".debug_line", LINE_SUBSECTION_HEADER);
678 emit_label (w, ".Ldebug_line_start");
679 emit_symbol_diff (w, ".Ldebug_line_end", ".", -4); /* length */
680 emit_int16 (w, 0x2); /* version */
681 emit_symbol_diff (w, ".Ldebug_line_header_end", ".", -4); /* header_length */
682 emit_byte (w, 1); /* minimum_instruction_length */
683 emit_byte (w, 1); /* default_is_stmt */
684 emit_byte (w, LINE_BASE); /* line_base */
685 emit_byte (w, LINE_RANGE); /* line_range */
686 emit_byte (w, OPCODE_BASE); /* opcode_base */
687 emit_byte (w, 0); /* standard_opcode_lengths */
701 emit_section_change (w, ".debug_line", LINE_SUBSECTION_INCLUDES);
703 /* End of Includes */
704 emit_section_change (w, ".debug_line", LINE_SUBSECTION_FILES);
708 emit_line_number_file_name (w, "xdb.il", 0, 0);
711 emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
714 emit_label (w, ".Ldebug_line_header_end");
716 /* Emit this into a separate subsection so it gets placed at the end */
717 emit_section_change (w, ".debug_line", LINE_SUBSECTION_END);
721 emit_byte (w, DW_LNE_end_sequence);
723 emit_label (w, ".Ldebug_line_end");
727 escape_path (char *name)
729 if (strchr (name, '\\')) {
730 char *s = g_malloc (strlen (name) * 2);
735 for (i = 0; i < len; ++i) {
736 if (name [i] == '\\') {
749 emit_all_line_number_info (MonoDwarfWriter *w)
752 GHashTable *dir_to_index, *index_to_dir;
755 g_assert (w->collect_line_info);
757 add_line_number_file_name (w, "xdb.il", 0, 0);
760 // FIXME: Revert list
761 for (l = w->line_info; l; l = l->next) {
762 MethodLineNumberInfo *info = l->data;
763 MonoDebugMethodInfo *minfo;
765 GPtrArray *source_file_list;
768 minfo = mono_debug_lookup_method (info->method);
772 mono_debug_symfile_get_line_numbers_full (minfo, &source_file, &source_file_list, NULL, NULL, NULL, NULL, NULL);
773 for (i = 0; i < source_file_list->len; ++i) {
774 MonoDebugSourceInfo *sinfo = g_ptr_array_index (source_file_list, i);
775 add_line_number_file_name (w, sinfo->source_file, 0, 0);
779 /* Preprocess files */
780 dir_to_index = g_hash_table_new (g_str_hash, g_str_equal);
781 index_to_dir = g_hash_table_new (NULL, NULL);
782 for (i = 0; i < w->line_number_file_index; ++i) {
783 char *name = g_hash_table_lookup (w->index_to_file, GUINT_TO_POINTER (i + 1));
787 if (g_path_is_absolute (name)) {
788 char *dir = g_path_get_dirname (name);
790 dir_index = GPOINTER_TO_UINT (g_hash_table_lookup (dir_to_index, dir));
791 if (dir_index == 0) {
792 dir_index = w->line_number_dir_index;
793 w->line_number_dir_index ++;
794 copy = g_strdup (dir);
795 g_hash_table_insert (dir_to_index, copy, GUINT_TO_POINTER (dir_index + 1));
796 g_hash_table_insert (index_to_dir, GUINT_TO_POINTER (dir_index + 1), copy);
805 /* Line number info header */
806 emit_section_change (w, ".debug_line", 0);
807 emit_label (w, ".Ldebug_line_section_start");
808 emit_label (w, ".Ldebug_line_start");
809 emit_symbol_diff (w, ".Ldebug_line_end", ".", -4); /* length */
810 emit_int16 (w, 0x2); /* version */
811 emit_symbol_diff (w, ".Ldebug_line_header_end", ".", -4); /* header_length */
812 emit_byte (w, 1); /* minimum_instruction_length */
813 emit_byte (w, 1); /* default_is_stmt */
814 emit_byte (w, LINE_BASE); /* line_base */
815 emit_byte (w, LINE_RANGE); /* line_range */
816 emit_byte (w, OPCODE_BASE); /* opcode_base */
817 emit_byte (w, 0); /* standard_opcode_lengths */
831 emit_section_change (w, ".debug_line", 0);
832 for (i = 0; i < w->line_number_dir_index; ++i) {
833 char *dir = g_hash_table_lookup (index_to_dir, GUINT_TO_POINTER (i + 1));
835 emit_string (w, escape_path (dir));
837 /* End of Includes */
841 for (i = 0; i < w->line_number_file_index; ++i) {
842 char *name = g_hash_table_lookup (w->index_to_file, GUINT_TO_POINTER (i + 1));
843 char *basename = NULL, *dir;
846 if (g_path_is_absolute (name)) {
847 dir = g_path_get_dirname (name);
849 dir_index = GPOINTER_TO_UINT (g_hash_table_lookup (dir_to_index, dir));
850 basename = g_path_get_basename (name);
854 emit_string (w, basename);
856 emit_string (w, escape_path (name));
857 emit_uleb128 (w, dir_index);
865 emit_label (w, ".Ldebug_line_header_end");
867 /* Emit line number table */
868 for (l = w->line_info; l; l = l->next) {
869 MethodLineNumberInfo *info = l->data;
871 emit_line_number_info (w, info->method, info->start_symbol, info->end_symbol, info->code, info->code_size, info->debug_info);
876 emit_byte (w, DW_LNE_end_sequence);
878 emit_label (w, ".Ldebug_line_end");
882 * Some assemblers like apple's do not support subsections, so we can't place
883 * .Ldebug_info_end at the end of the section using subsections. Instead, we
884 * define it every time something gets added to the .debug_info section.
885 * The apple assember seems to use the last definition.
888 emit_debug_info_end (MonoDwarfWriter *w)
890 /* This doesn't seem to work/required with recent iphone sdk versions */
892 if (!img_writer_subsections_supported (w->w))
893 fprintf (w->fp, "\n.set %sdebug_info_end,.\n", w->temp_prefix);
898 mono_dwarf_writer_emit_base_info (MonoDwarfWriter *w, GSList *base_unwind_program)
900 char *s, *build_info;
903 w->cie_program = base_unwind_program;
905 emit_section_change (w, ".debug_abbrev", 0);
906 emit_dwarf_abbrev (w, ABBREV_COMPILE_UNIT, DW_TAG_compile_unit, TRUE,
907 compile_unit_attr, G_N_ELEMENTS (compile_unit_attr));
908 emit_dwarf_abbrev (w, ABBREV_SUBPROGRAM, DW_TAG_subprogram, TRUE,
909 subprogram_attr, G_N_ELEMENTS (subprogram_attr));
910 emit_dwarf_abbrev (w, ABBREV_PARAM, DW_TAG_formal_parameter, FALSE,
911 param_attr, G_N_ELEMENTS (param_attr));
912 emit_dwarf_abbrev (w, ABBREV_PARAM_LOCLIST, DW_TAG_formal_parameter, FALSE,
913 param_loclist_attr, G_N_ELEMENTS (param_loclist_attr));
914 emit_dwarf_abbrev (w, ABBREV_BASE_TYPE, DW_TAG_base_type, FALSE,
915 base_type_attr, G_N_ELEMENTS (base_type_attr));
916 emit_dwarf_abbrev (w, ABBREV_STRUCT_TYPE, DW_TAG_class_type, TRUE,
917 struct_type_attr, G_N_ELEMENTS (struct_type_attr));
918 emit_dwarf_abbrev (w, ABBREV_STRUCT_TYPE_NOCHILDREN, DW_TAG_class_type, FALSE,
919 struct_type_attr, G_N_ELEMENTS (struct_type_attr));
920 emit_dwarf_abbrev (w, ABBREV_DATA_MEMBER, DW_TAG_member, FALSE,
921 data_member_attr, G_N_ELEMENTS (data_member_attr));
922 emit_dwarf_abbrev (w, ABBREV_TYPEDEF, DW_TAG_typedef, FALSE,
923 typedef_attr, G_N_ELEMENTS (typedef_attr));
924 emit_dwarf_abbrev (w, ABBREV_ENUM_TYPE, DW_TAG_enumeration_type, TRUE,
925 enum_type_attr, G_N_ELEMENTS (enum_type_attr));
926 emit_dwarf_abbrev (w, ABBREV_ENUMERATOR, DW_TAG_enumerator, FALSE,
927 enumerator_attr, G_N_ELEMENTS (enumerator_attr));
928 emit_dwarf_abbrev (w, ABBREV_NAMESPACE, DW_TAG_namespace, TRUE,
929 namespace_attr, G_N_ELEMENTS (namespace_attr));
930 emit_dwarf_abbrev (w, ABBREV_VARIABLE, DW_TAG_variable, FALSE,
931 variable_attr, G_N_ELEMENTS (variable_attr));
932 emit_dwarf_abbrev (w, ABBREV_VARIABLE_LOCLIST, DW_TAG_variable, FALSE,
933 variable_loclist_attr, G_N_ELEMENTS (variable_loclist_attr));
934 emit_dwarf_abbrev (w, ABBREV_POINTER_TYPE, DW_TAG_pointer_type, FALSE,
935 pointer_type_attr, G_N_ELEMENTS (pointer_type_attr));
936 emit_dwarf_abbrev (w, ABBREV_REFERENCE_TYPE, DW_TAG_reference_type, FALSE,
937 reference_type_attr, G_N_ELEMENTS (reference_type_attr));
938 emit_dwarf_abbrev (w, ABBREV_INHERITANCE, DW_TAG_inheritance, FALSE,
939 inheritance_attr, G_N_ELEMENTS (inheritance_attr));
942 emit_section_change (w, ".debug_info", 0);
943 emit_label (w, ".Ldebug_info_start");
944 emit_symbol_diff (w, ".Ldebug_info_end", ".Ldebug_info_begin", 0); /* length */
945 emit_label (w, ".Ldebug_info_begin");
946 emit_int16 (w, 0x2); /* DWARF version 2 */
947 emit_int32 (w, 0); /* .debug_abbrev offset */
948 emit_byte (w, sizeof (gpointer)); /* address size */
950 if (img_writer_subsections_supported (w->w) && w->appending) {
951 /* Emit this into a separate section so it gets placed at the end */
952 emit_section_change (w, ".debug_info", 1);
953 emit_byte (w, 0); /* close COMPILE_UNIT */
954 emit_label (w, ".Ldebug_info_end");
955 emit_section_change (w, ".debug_info", 0);
958 /* Compilation unit */
959 emit_uleb128 (w, ABBREV_COMPILE_UNIT);
960 build_info = mono_get_runtime_build_info ();
961 s = g_strdup_printf ("Mono AOT Compiler %s", build_info);
965 emit_string (w, "JITted code");
967 emit_byte (w, DW_LANG_C);
968 emit_pointer_value (w, 0);
969 emit_pointer_value (w, 0);
970 /* offset into .debug_line section */
971 emit_symbol_diff (w, ".Ldebug_line_start", ".Ldebug_line_section_start", 0);
974 for (i = 0; i < G_N_ELEMENTS (basic_types); ++i) {
975 emit_label (w, basic_types [i].die_name);
976 emit_uleb128 (w, ABBREV_BASE_TYPE);
977 emit_byte (w, basic_types [i].size);
978 emit_byte (w, basic_types [i].encoding);
979 emit_string (w, basic_types [i].name);
982 emit_debug_info_end (w);
984 /* debug_loc section */
985 emit_section_change (w, ".debug_loc", 0);
986 emit_label (w, ".Ldebug_loc_start");
988 /* debug_line section */
990 * We emit some info even if emit_line is FALSE, as the
991 * apple linker seems to require a .debug_line section.
993 if (!w->collect_line_info)
994 emit_line_number_info_begin (w);
1000 * mono_dwarf_writer_close:
1002 * Finalize the emitted debugging info.
1005 mono_dwarf_writer_close (MonoDwarfWriter *w)
1007 if (!w->appending) {
1008 emit_section_change (w, ".debug_info", 0);
1009 emit_byte (w, 0); /* close COMPILE_UNIT */
1010 emit_label (w, ".Ldebug_info_end");
1013 if (w->collect_line_info)
1014 emit_all_line_number_info (w);
1017 static void emit_type (MonoDwarfWriter *w, MonoType *t);
1018 static const char* get_type_die (MonoDwarfWriter *w, MonoType *t);
1021 get_class_die (MonoDwarfWriter *w, MonoClass *klass, gboolean vtype)
1026 cache = w->class_to_vtype_die;
1028 cache = w->class_to_die;
1030 return g_hash_table_lookup (cache, klass);
1033 /* Returns the local symbol pointing to the emitted debug info */
1035 emit_class_dwarf_info (MonoDwarfWriter *w, MonoClass *klass, gboolean vtype)
1037 char *die, *pointer_die, *reference_die;
1038 char *full_name, *p;
1040 MonoClassField *field;
1043 gboolean emit_namespace = FALSE, has_children;
1047 cache = w->class_to_vtype_die;
1049 cache = w->class_to_die;
1051 die = g_hash_table_lookup (cache, klass);
1055 if (!((klass->byval_arg.type == MONO_TYPE_CLASS) || (klass->byval_arg.type == MONO_TYPE_OBJECT) || klass->byval_arg.type == MONO_TYPE_GENERICINST || klass->enumtype || (klass->byval_arg.type == MONO_TYPE_VALUETYPE && vtype) ||
1056 (klass->byval_arg.type >= MONO_TYPE_BOOLEAN && klass->byval_arg.type <= MONO_TYPE_R8 && !vtype)))
1060 * FIXME: gdb can't handle namespaces in languages it doesn't know about.
1063 if (klass->name_space && klass->name_space [0] != '\0')
1064 emit_namespace = TRUE;
1066 if (emit_namespace) {
1067 emit_uleb128 (w, ABBREV_NAMESPACE);
1068 emit_string (w, klass->name_space);
1071 full_name = g_strdup_printf ("%s%s%s", klass->name_space, klass->name_space ? "." : "", klass->name);
1073 * gdb doesn't support namespaces for non-C++ dwarf objects, so use _
1074 * to separate components.
1076 for (p = full_name; *p; p ++)
1080 die = g_strdup_printf (".LTDIE_%d", w->tdie_index);
1081 pointer_die = g_strdup_printf (".LTDIE_%d_POINTER", w->tdie_index);
1082 reference_die = g_strdup_printf (".LTDIE_%d_REFERENCE", w->tdie_index);
1085 g_hash_table_insert (w->class_to_pointer_die, klass, pointer_die);
1086 g_hash_table_insert (w->class_to_reference_die, klass, reference_die);
1087 g_hash_table_insert (cache, klass, die);
1089 if (klass->enumtype) {
1090 int size = mono_class_value_size (mono_class_from_mono_type (mono_class_enum_basetype (klass)), NULL);
1092 emit_label (w, die);
1094 emit_uleb128 (w, ABBREV_ENUM_TYPE);
1095 emit_string (w, full_name);
1096 emit_uleb128 (w, size);
1097 for (k = 0; k < G_N_ELEMENTS (basic_types); ++k)
1098 if (basic_types [k].type == mono_class_enum_basetype (klass)->type)
1100 g_assert (k < G_N_ELEMENTS (basic_types));
1101 emit_symbol_diff (w, basic_types [k].die_name, ".Ldebug_info_start", 0);
1103 /* Emit enum values */
1105 while ((field = mono_class_get_fields (klass, &iter))) {
1108 MonoTypeEnum def_type;
1110 if (strcmp ("value__", mono_field_get_name (field)) == 0)
1112 if (mono_field_is_deleted (field))
1115 emit_uleb128 (w, ABBREV_ENUMERATOR);
1116 emit_string (w, mono_field_get_name (field));
1118 p = mono_class_get_field_default_value (field, &def_type);
1119 len = mono_metadata_decode_blob_size (p, &p);
1120 switch (mono_class_enum_basetype (klass)->type) {
1123 case MONO_TYPE_BOOLEAN:
1124 emit_sleb128 (w, *p);
1128 case MONO_TYPE_CHAR:
1129 emit_sleb128 (w, read16 (p));
1133 emit_sleb128 (w, read32 (p));
1137 emit_sleb128 (w, read64 (p));
1141 #if SIZEOF_VOID_P == 8
1142 emit_sleb128 (w, read64 (p));
1144 emit_sleb128 (w, read32 (p));
1148 g_assert_not_reached ();
1152 has_children = TRUE;
1159 parent_die = emit_class_dwarf_info (w, klass->parent, FALSE);
1163 /* Emit field types */
1165 while ((field = mono_class_get_fields (klass, &iter))) {
1166 if (field->type->attrs & FIELD_ATTRIBUTE_STATIC)
1169 emit_type (w, field->type);
1173 has_children = parent_die || mono_class_get_fields (klass, &iter);
1175 emit_label (w, die);
1177 emit_uleb128 (w, has_children ? ABBREV_STRUCT_TYPE : ABBREV_STRUCT_TYPE_NOCHILDREN);
1178 emit_string (w, full_name);
1179 emit_uleb128 (w, klass->instance_size);
1182 emit_uleb128 (w, ABBREV_INHERITANCE);
1183 emit_symbol_diff (w, parent_die, ".Ldebug_info_start", 0);
1186 *p ++= DW_OP_plus_uconst;
1187 encode_uleb128 (0, p, &p);
1188 emit_byte (w, p - buf);
1189 emit_bytes (w, buf, p - buf);
1194 while ((field = mono_class_get_fields (klass, &iter))) {
1195 if (field->type->attrs & FIELD_ATTRIBUTE_STATIC)
1198 fdie = get_type_die (w, field->type);
1200 emit_uleb128 (w, ABBREV_DATA_MEMBER);
1201 emit_string (w, field->name);
1202 emit_symbol_diff (w, fdie, ".Ldebug_info_start", 0);
1205 *p ++= DW_OP_plus_uconst;
1206 if (klass->valuetype && vtype)
1207 encode_uleb128 (field->offset - sizeof (MonoObject), p, &p);
1209 encode_uleb128 (field->offset, p, &p);
1211 emit_byte (w, p - buf);
1212 emit_bytes (w, buf, p - buf);
1219 emit_uleb128 (w, 0x0);
1221 /* Add a typedef, so we can reference the type without a 'struct' in gdb */
1222 emit_uleb128 (w, ABBREV_TYPEDEF);
1223 emit_string (w, full_name);
1224 emit_symbol_diff (w, die, ".Ldebug_info_start", 0);
1226 /* Add a pointer type */
1227 emit_label (w, pointer_die);
1229 emit_uleb128 (w, ABBREV_POINTER_TYPE);
1230 emit_symbol_diff (w, die, ".Ldebug_info_start", 0);
1232 /* Add a reference type */
1233 emit_label (w, reference_die);
1235 emit_uleb128 (w, ABBREV_REFERENCE_TYPE);
1236 emit_symbol_diff (w, die, ".Ldebug_info_start", 0);
1240 if (emit_namespace) {
1242 emit_uleb128 (w, 0x0);
1248 static gboolean base_types_emitted [64];
1251 get_type_die (MonoDwarfWriter *w, MonoType *t)
1253 MonoClass *klass = mono_class_from_mono_type (t);
1258 if (t->type == MONO_TYPE_VALUETYPE) {
1259 tdie = g_hash_table_lookup (w->class_to_pointer_die, klass);
1262 tdie = get_class_die (w, klass, FALSE);
1263 /* Should return a pointer type to a reference */
1266 t = &mono_defaults.int_class->byval_arg;
1268 for (j = 0; j < G_N_ELEMENTS (basic_types); ++j)
1269 if (basic_types [j].type == t->type)
1271 if (j < G_N_ELEMENTS (basic_types)) {
1272 tdie = basic_types [j].die_name;
1275 case MONO_TYPE_CLASS:
1276 tdie = g_hash_table_lookup (w->class_to_reference_die, klass);
1277 //tdie = ".LDIE_OBJECT";
1279 case MONO_TYPE_ARRAY:
1280 tdie = ".LDIE_OBJECT";
1282 case MONO_TYPE_VALUETYPE:
1283 if (klass->enumtype)
1284 tdie = get_class_die (w, klass, FALSE);
1288 case MONO_TYPE_GENERICINST:
1289 if (!MONO_TYPE_ISSTRUCT (t)) {
1290 tdie = g_hash_table_lookup (w->class_to_reference_die, klass);
1310 emit_type (MonoDwarfWriter *w, MonoType *t)
1312 MonoClass *klass = mono_class_from_mono_type (t);
1317 if (t->type == MONO_TYPE_VALUETYPE) {
1318 tdie = emit_class_dwarf_info (w, klass, TRUE);
1323 emit_class_dwarf_info (w, klass, FALSE);
1326 t = &mono_defaults.int_class->byval_arg;
1328 for (j = 0; j < G_N_ELEMENTS (basic_types); ++j)
1329 if (basic_types [j].type == t->type)
1331 if (j < G_N_ELEMENTS (basic_types)) {
1332 /* Emit a boxed version of base types */
1333 if (j < 64 && !base_types_emitted [j]) {
1334 emit_class_dwarf_info (w, klass, FALSE);
1335 base_types_emitted [j] = TRUE;
1339 case MONO_TYPE_CLASS:
1340 emit_class_dwarf_info (w, klass, FALSE);
1342 case MONO_TYPE_ARRAY:
1344 case MONO_TYPE_VALUETYPE:
1345 if (klass->enumtype)
1346 emit_class_dwarf_info (w, klass, FALSE);
1348 case MONO_TYPE_GENERICINST:
1349 if (!MONO_TYPE_ISSTRUCT (t))
1350 emit_class_dwarf_info (w, klass, FALSE);
1361 emit_var_type (MonoDwarfWriter *w, MonoType *t)
1365 tdie = get_type_die (w, t);
1367 emit_symbol_diff (w, tdie, ".Ldebug_info_start", 0);
1371 encode_var_location (MonoDwarfWriter *w, MonoInst *ins, guint8 *p, guint8 **endp)
1374 /* FIXME: This needs a location list, since the args can go from reg->stack */
1375 if (!ins || ins->flags & MONO_INST_IS_DEAD) {
1376 /* gdb treats this as optimized out */
1377 } else if (ins->opcode == OP_REGVAR) {
1378 *p = DW_OP_reg0 + mono_hw_reg_to_dwarf_reg (ins->dreg);
1380 } else if (ins->opcode == OP_REGOFFSET) {
1381 *p ++= DW_OP_breg0 + mono_hw_reg_to_dwarf_reg (ins->inst_basereg);
1382 encode_sleb128 (ins->inst_offset, p, &p);
1392 emit_loclist (MonoDwarfWriter *w, MonoInst *ins,
1393 guint8 *loclist_begin_addr, guint8 *loclist_end_addr,
1394 guint8 *expr, guint32 expr_len)
1398 emit_push_section (w, ".debug_loc", 0);
1399 sprintf (label, ".Lloclist_%d", w->loclist_index ++ );
1400 emit_label (w, label);
1402 emit_pointer_value (w, loclist_begin_addr);
1403 emit_pointer_value (w, loclist_end_addr);
1404 emit_byte (w, expr_len % 256);
1405 emit_byte (w, expr_len / 256);
1406 emit_bytes (w, expr, expr_len);
1408 emit_pointer_value (w, NULL);
1409 emit_pointer_value (w, NULL);
1411 emit_pop_section (w);
1412 emit_symbol_diff (w, label, ".Ldebug_loc_start", 0);
1416 * MonoDisHelper->tokener doesn't take an IP argument, and we can't add one since
1417 * it is a public header.
1419 static const guint8 *token_handler_ip;
1422 token_handler (MonoDisHelper *dh, MonoMethod *method, guint32 token)
1425 MonoMethod *cmethod;
1427 MonoClassField *field;
1428 gpointer data = NULL;
1430 if (method->wrapper_type)
1431 data = mono_method_get_wrapper_data (method, token);
1433 switch (*token_handler_ip) {
1437 if (method->wrapper_type)
1440 klass = mono_class_get_full (method->klass->image, token, NULL);
1441 res = g_strdup_printf ("<%s>", klass->name);
1446 if (method->wrapper_type)
1449 cmethod = mono_get_method_full (method->klass->image, token, NULL, NULL);
1450 desc = mono_method_full_name (cmethod, TRUE);
1451 res = g_strdup_printf ("<%s>", desc);
1455 if (method->wrapper_type) {
1456 desc = mono_signature_get_desc (data, FALSE);
1457 res = g_strdup_printf ("<%s>", desc);
1460 res = g_strdup_printf ("<0x%08x>", token);
1467 if (method->wrapper_type)
1470 field = mono_field_from_token (method->klass->image, token, &klass, NULL);
1471 desc = mono_field_full_name (field);
1472 res = g_strdup_printf ("<%s>", desc);
1476 res = g_strdup_printf ("<0x%08x>", token);
1486 * Produce a disassembled form of the IL instruction at IP. This is an extension
1487 * of mono_disasm_code_one () which can disasm tokens, handle wrapper methods, and
1488 * CEE_MONO_ opcodes.
1491 disasm_ins (MonoMethod *method, const guchar *ip, const guint8 **endip)
1495 MonoMethodHeader *header = mono_method_get_header (method);
1497 memset (&dh, 0, sizeof (dh));
1499 dh.label_format = "IL_%04x: ";
1500 dh.label_target = "IL_%04x";
1501 dh.tokener = token_handler;
1503 token_handler_ip = ip;
1504 if (*ip == MONO_CUSTOM_PREFIX) {
1509 case CEE_MONO_ICALL: {
1510 MonoJitICallInfo *info;
1512 token = read32 (ip + 2);
1513 data = mono_method_get_wrapper_data (method, token);
1514 info = mono_find_jit_icall_by_addr (data);
1517 dis = g_strdup_printf ("IL_%04x: mono_icall <%s>", (int)(ip - header->code), info->name);
1521 case CEE_MONO_CLASSCONST: {
1522 token = read32 (ip + 2);
1523 data = mono_method_get_wrapper_data (method, token);
1525 dis = g_strdup_printf ("IL_%04x: mono_classconst <%s>", (int)(ip - header->code), ((MonoClass*)data)->name);
1530 dis = mono_disasm_code_one (&dh, method, ip, &ip);
1533 dis = mono_disasm_code_one (&dh, method, ip, &ip);
1535 token_handler_ip = NULL;
1538 mono_metadata_free_mh (header);
1543 il_offset_from_address (MonoMethod *method, MonoDebugMethodJitInfo *jit,
1544 guint32 native_offset)
1548 if (!jit->line_numbers)
1551 for (i = jit->num_line_numbers - 1; i >= 0; i--) {
1552 MonoDebugLineNumberEntry lne = jit->line_numbers [i];
1554 if (lne.native_offset <= native_offset)
1555 return lne.il_offset;
1561 static int max_special_addr_diff = 0;
1564 emit_advance_op (MonoDwarfWriter *w, int line_diff, int addr_diff)
1568 /* Use a special opcode if possible */
1569 if (line_diff - LINE_BASE >= 0 && line_diff - LINE_BASE < LINE_RANGE) {
1570 if (max_special_addr_diff == 0)
1571 max_special_addr_diff = (255 - OPCODE_BASE) / LINE_RANGE;
1573 if (addr_diff > max_special_addr_diff && (addr_diff < 2 * max_special_addr_diff)) {
1574 emit_byte (w, DW_LNS_const_add_pc);
1575 addr_diff -= max_special_addr_diff;
1578 opcode = (line_diff - LINE_BASE) + (LINE_RANGE * addr_diff) + OPCODE_BASE;
1584 emit_byte (w, opcode);
1586 emit_byte (w, DW_LNS_advance_line);
1587 emit_sleb128 (w, line_diff);
1588 emit_byte (w, DW_LNS_advance_pc);
1589 emit_sleb128 (w, addr_diff);
1590 emit_byte (w, DW_LNS_copy);
1595 compare_lne (MonoDebugLineNumberEntry *a, MonoDebugLineNumberEntry *b)
1597 if (a->native_offset == b->native_offset)
1598 return a->il_offset - b->il_offset;
1600 return a->native_offset - b->native_offset;
1604 emit_line_number_info (MonoDwarfWriter *w, MonoMethod *method,
1605 char *start_symbol, char *end_symbol,
1606 guint8 *code, guint32 code_size,
1607 MonoDebugMethodJitInfo *debug_info)
1609 guint32 prev_line = 0;
1610 guint32 prev_native_offset = 0;
1611 int i, file_index, il_offset, prev_il_offset;
1612 gboolean first = TRUE;
1613 MonoDebugSourceLocation *loc;
1614 char *prev_file_name = NULL;
1615 MonoMethodHeader *header = mono_method_get_header (method);
1616 MonoDebugMethodInfo *minfo;
1617 MonoDebugLineNumberEntry *ln_array;
1618 int *native_to_il_offset = NULL;
1620 if (!w->emit_line) {
1621 mono_metadata_free_mh (header);
1625 minfo = mono_debug_lookup_method (method);
1627 /* Compute the native->IL offset mapping */
1629 g_assert (code_size);
1631 ln_array = g_new0 (MonoDebugLineNumberEntry, debug_info->num_line_numbers);
1632 memcpy (ln_array, debug_info->line_numbers, debug_info->num_line_numbers * sizeof (MonoDebugLineNumberEntry));
1634 qsort (ln_array, debug_info->num_line_numbers, sizeof (MonoDebugLineNumberEntry), (gpointer)compare_lne);
1636 native_to_il_offset = g_new0 (int, code_size + 1);
1638 for (i = 0; i < debug_info->num_line_numbers; ++i) {
1640 MonoDebugLineNumberEntry *lne = &ln_array [i];
1643 for (j = 0; j < lne->native_offset; ++j)
1644 native_to_il_offset [j] = -1;
1647 if (i < debug_info->num_line_numbers - 1) {
1648 MonoDebugLineNumberEntry *lne_next = &ln_array [i + 1];
1650 for (j = lne->native_offset; j < lne_next->native_offset; ++j)
1651 native_to_il_offset [j] = lne->il_offset;
1653 for (j = lne->native_offset; j < code_size; ++j)
1654 native_to_il_offset [j] = lne->il_offset;
1660 prev_il_offset = -1;
1662 for (i = 0; i < code_size; ++i) {
1666 if (!debug_info->line_numbers)
1669 if (native_to_il_offset)
1670 il_offset = native_to_il_offset [i];
1672 il_offset = il_offset_from_address (method, debug_info, i);
1674 il_offset = il_offset_from_address (method, debug_info, i);
1676 g_assert (il_offset == native_to_il_offset [i]);
1679 il_offset = native_to_il_offset [i];
1683 if (il_offset == prev_il_offset)
1686 prev_il_offset = il_offset;
1688 loc = mono_debug_symfile_lookup_location (minfo, il_offset);
1689 if (loc && loc->source_file) {
1690 int line_diff = (gint32)loc->row - (gint32)prev_line;
1691 int addr_diff = i - prev_native_offset;
1694 emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
1697 emit_byte (w, sizeof (gpointer) + 1);
1698 emit_byte (w, DW_LNE_set_address);
1700 emit_pointer_unaligned (w, start_symbol);
1702 emit_pointer_value (w, code);
1705 * The prolog+initlocals region does not have a line number, this
1706 * makes them belong to the first line of the method.
1708 emit_byte (w, DW_LNS_advance_line);
1709 emit_sleb128 (w, (gint32)loc->row - (gint32)prev_line);
1710 prev_line = loc->row;
1713 if (loc->row != prev_line) {
1714 if (!prev_file_name || strcmp (loc->source_file, prev_file_name) != 0) {
1715 /* Add an entry to the file table */
1716 /* FIXME: Avoid duplicates */
1717 if (w->collect_line_info)
1718 file_index = get_line_number_file_name (w, loc->source_file) + 1;
1720 file_index = emit_line_number_file_name (w, loc->source_file, 0, 0);
1721 g_free (prev_file_name);
1722 prev_file_name = g_strdup (loc->source_file);
1724 emit_byte (w, DW_LNS_set_file);
1725 emit_uleb128 (w, file_index);
1726 emit_byte (w, DW_LNS_copy);
1728 //printf ("X: %p(+0x%x) %d %s:%d(+%d)\n", code + i, addr_diff, loc->il_offset, loc->source_file, loc->row, line_diff);
1730 emit_advance_op (w, line_diff, addr_diff);
1732 prev_line = loc->row;
1733 prev_native_offset = i;
1738 mono_debug_symfile_free_location (loc);
1742 g_free (native_to_il_offset);
1743 g_free (prev_file_name);
1746 emit_byte (w, DW_LNS_advance_pc);
1747 emit_sleb128 (w, code_size - prev_native_offset);
1748 emit_byte (w, DW_LNS_copy);
1752 emit_byte (w, DW_LNE_end_sequence);
1753 } else if (!start_symbol) {
1754 /* No debug info, XDEBUG mode */
1756 const guint8 *ip = header->code;
1757 int prev_line, prev_native_offset;
1761 * Emit the IL code into a temporary file and emit line number info
1762 * referencing that file.
1765 name = mono_method_full_name (method, TRUE);
1766 fprintf (w->il_file, "// %s\n", name);
1767 w->il_file_line_index ++;
1770 il_to_line = g_new0 (int, header->code_size);
1772 emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
1774 emit_byte (w, sizeof (gpointer) + 1);
1775 emit_byte (w, DW_LNE_set_address);
1776 emit_pointer_value (w, code);
1778 // FIXME: Optimize this
1779 while (ip < header->code + header->code_size) {
1780 int il_offset = ip - header->code;
1783 w->il_file_line_index ++;
1785 dis = disasm_ins (method, ip, &ip);
1786 fprintf (w->il_file, "%s\n", dis);
1789 il_to_line [il_offset] = w->il_file_line_index;
1792 /* Emit line number info */
1794 prev_native_offset = 0;
1795 for (i = 0; i < debug_info->num_line_numbers; ++i) {
1796 MonoDebugLineNumberEntry *lne = &debug_info->line_numbers [i];
1799 if (lne->il_offset >= header->code_size)
1801 line = il_to_line [lne->il_offset];
1804 * This seems to happen randomly, it looks like il_offset points
1805 * into the middle of an instruction.
1809 printf ("%s\n", mono_method_full_name (method, TRUE));
1810 printf ("%d %d\n", lne->il_offset, header->code_size);
1815 if (line - prev_line != 0) {
1816 emit_advance_op (w, line - prev_line, (gint32)lne->native_offset - prev_native_offset);
1819 prev_native_offset = lne->native_offset;
1823 emit_byte (w, DW_LNS_advance_pc);
1824 emit_sleb128 (w, code_size - prev_native_offset);
1825 emit_byte (w, DW_LNS_copy);
1829 emit_byte (w, DW_LNE_end_sequence);
1831 fflush (w->il_file);
1832 g_free (il_to_line);
1834 mono_metadata_free_mh (header);
1837 static MonoMethodVar*
1838 find_vmv (MonoCompile *cfg, MonoInst *ins)
1843 for (j = 0; j < cfg->num_varinfo; ++j) {
1844 if (cfg->varinfo [j] == ins)
1848 if (j < cfg->num_varinfo) {
1849 return MONO_VARINFO (cfg, j);
1857 mono_dwarf_writer_emit_method (MonoDwarfWriter *w, MonoCompile *cfg, MonoMethod *method, char *start_symbol, char *end_symbol, guint8 *code, guint32 code_size, MonoInst **args, MonoInst **locals, GSList *unwind_info, MonoDebugMethodJitInfo *debug_info)
1860 MonoMethodSignature *sig;
1861 MonoMethodHeader *header;
1863 MonoDebugLocalsInfo *locals_info;
1868 emit_section_change (w, ".debug_info", 0);
1870 sig = mono_method_signature (method);
1871 header = mono_method_get_header (method);
1873 /* Parameter types */
1874 for (i = 0; i < sig->param_count + sig->hasthis; ++i) {
1877 if (i == 0 && sig->hasthis) {
1878 if (method->klass->valuetype)
1879 t = &method->klass->this_arg;
1881 t = &method->klass->byval_arg;
1883 t = sig->params [i - sig->hasthis];
1888 //emit_type (w, &mono_defaults.int32_class->byval_arg);
1891 for (i = 0; i < header->num_locals; ++i) {
1892 emit_type (w, header->locals [i]);
1896 names = g_new0 (char *, sig->param_count);
1897 mono_method_get_param_names (method, (const char **) names);
1899 emit_uleb128 (w, ABBREV_SUBPROGRAM);
1900 name = mono_method_full_name (method, FALSE);
1901 emit_string (w, name);
1902 emit_string (w, name);
1905 emit_pointer_unaligned (w, start_symbol);
1906 emit_pointer_unaligned (w, end_symbol);
1908 emit_pointer_value (w, code);
1909 emit_pointer_value (w, code + code_size);
1913 emit_byte (w, DW_OP_breg6);
1917 for (i = 0; i < sig->param_count + sig->hasthis; ++i) {
1918 MonoInst *arg = args ? args [i] : NULL;
1921 char pname_buf [128];
1922 MonoMethodVar *vmv = NULL;
1923 gboolean need_loclist = FALSE;
1925 vmv = find_vmv (cfg, arg);
1926 if (code && vmv && (vmv->live_range_start || vmv->live_range_end))
1927 need_loclist = TRUE;
1929 if (i == 0 && sig->hasthis) {
1930 if (method->klass->valuetype)
1931 t = &method->klass->this_arg;
1933 t = &method->klass->byval_arg;
1936 t = sig->params [i - sig->hasthis];
1937 pname = names [i - sig->hasthis];
1940 emit_uleb128 (w, need_loclist ? ABBREV_PARAM_LOCLIST : ABBREV_PARAM);
1942 if (pname[0] == '\0') {
1943 sprintf (pname_buf, "param%d", i - sig->hasthis);
1946 emit_string (w, pname);
1948 if (!arg || arg->flags & MONO_INST_IS_DEAD)
1949 emit_var_type (w, &mono_defaults.int32_class->byval_arg);
1951 emit_var_type (w, t);
1954 encode_var_location (w, arg, p, &p);
1956 vmv->live_range_start = 0;
1957 if (vmv->live_range_end == 0)
1958 /* FIXME: Uses made in calls are not recorded */
1959 vmv->live_range_end = code_size;
1960 emit_loclist (w, arg, code + vmv->live_range_start, code + vmv->live_range_end, buf, p - buf);
1962 emit_byte (w, p - buf);
1963 emit_bytes (w, buf, p - buf);
1969 locals_info = mono_debug_lookup_locals (method);
1971 for (i = 0; i < header->num_locals; ++i) {
1972 MonoInst *ins = locals [i];
1973 char name_buf [128];
1975 MonoMethodVar *vmv = NULL;
1976 gboolean need_loclist = FALSE;
1979 /* ins->dreg no longer contains the original vreg */
1980 vmv = find_vmv (cfg, ins);
1982 if (vmv->live_range_start) {
1983 /* This variable has a precise live range */
1984 need_loclist = TRUE;
1988 emit_uleb128 (w, need_loclist ? ABBREV_VARIABLE_LOCLIST : ABBREV_VARIABLE);
1992 for (j = 0; j < locals_info->num_locals; ++j)
1993 if (locals_info->locals [j].index == i)
1995 if (j < locals_info->num_locals)
1996 lname = locals_info->locals [j].name;
1999 emit_string (w, lname);
2001 sprintf (name_buf, "V_%d", i);
2002 emit_string (w, name_buf);
2005 if (!ins || ins->flags & MONO_INST_IS_DEAD)
2006 emit_var_type (w, &mono_defaults.int32_class->byval_arg);
2008 emit_var_type (w, header->locals [i]);
2011 encode_var_location (w, ins, p, &p);
2014 if (vmv->live_range_end == 0)
2015 /* FIXME: Uses made in calls are not recorded */
2016 vmv->live_range_end = code_size;
2017 emit_loclist (w, ins, code + vmv->live_range_start, code + vmv->live_range_end, buf, p - buf);
2019 emit_byte (w, p - buf);
2020 emit_bytes (w, buf, p - buf);
2025 mono_debug_symfile_free_locals (locals_info);
2027 /* Subprogram end */
2028 emit_uleb128 (w, 0x0);
2032 emit_debug_info_end (w);
2034 /* Emit unwind info */
2036 emit_fde (w, w->fde_index, start_symbol, end_symbol, code, code_size, unwind_info, TRUE);
2040 /* Emit line number info */
2041 /* != could happen when using --regression */
2042 if (debug_info && (debug_info->code_start == code)) {
2043 if (w->collect_line_info) {
2044 MethodLineNumberInfo *info;
2046 /* Save the information needed to emit the line number info later at once */
2047 info = g_new0 (MethodLineNumberInfo, 1);
2048 info->method = method;
2049 info->start_symbol = g_strdup (start_symbol);
2050 info->end_symbol = g_strdup (end_symbol);
2052 info->code_size = code_size;
2053 info->debug_info = debug_info;
2054 w->line_info = g_slist_prepend (w->line_info, info);
2056 emit_line_number_info (w, method, start_symbol, end_symbol, code, code_size, debug_info);
2061 mono_metadata_free_mh (header);
2065 mono_dwarf_writer_emit_trampoline (MonoDwarfWriter *w, const char *tramp_name, char *start_symbol, char *end_symbol, guint8 *code, guint32 code_size, GSList *unwind_info)
2067 emit_section_change (w, ".debug_info", 0);
2070 emit_uleb128 (w, ABBREV_SUBPROGRAM);
2071 emit_string (w, tramp_name);
2072 emit_pointer_value (w, code);
2073 emit_pointer_value (w, code + code_size);
2076 emit_byte (w, DW_OP_breg6);
2079 /* Subprogram end */
2080 emit_uleb128 (w, 0x0);
2082 emit_debug_info_end (w);
2084 /* Emit unwind info */
2085 emit_fde (w, w->fde_index, start_symbol, end_symbol, code, code_size, unwind_info, FALSE);
2088 #endif /* End of: !defined(DISABLE_AOT) && !defined(DISABLE_JIT) */