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;
59 emit_line_number_info (MonoDwarfWriter *w, MonoMethod *method,
60 char *start_symbol, char *end_symbol,
61 guint8 *code, guint32 code_size,
62 MonoDebugMethodJitInfo *debug_info);
65 * mono_dwarf_writer_create:
67 * Create a DWARF writer object. WRITER is the underlying image writer this
68 * writer will emit to. IL_FILE is the file where IL code will be dumped to for
69 * methods which have no line number info. It can be NULL.
70 * If APPENDING is TRUE, the output file will be in assembleable state after each
71 * call to the _emit_ functions. This is used for XDEBUG. If APPENDING is FALSE,
72 * a separate mono_dwarf_writer_close () call is needed to finish the emission of
76 mono_dwarf_writer_create (MonoImageWriter *writer, FILE *il_file, int il_file_start_line, gboolean appending, gboolean emit_line_numbers)
78 MonoDwarfWriter *w = g_new0 (MonoDwarfWriter, 1);
81 * The appending flag is needed because we use subsections to order things in
82 * the debug info, and:
83 * - apple's assembler doesn't support them
84 * - the binary writer has problems with subsections+alignment
85 * So instead of subsections, we use the _close () function in AOT mode,
86 * which writes out things in order.
91 w->il_file_line_index = il_file_start_line;
92 w->appending = appending;
95 g_assert (img_writer_subsections_supported (w->w));
100 if (!img_writer_subsections_supported (w->w))
101 /* Can't emit line number info without subsections */
102 w->emit_line = FALSE;
104 /* Collect line number info and emit it at once */
105 w->collect_line_info = TRUE;
108 if (!emit_line_numbers) {
109 w->emit_line = FALSE;
110 w->collect_line_info = FALSE;
113 w->fp = img_writer_get_fp (w->w);
114 w->temp_prefix = img_writer_get_temp_label_prefix (w->w);
116 w->class_to_die = g_hash_table_new (NULL, NULL);
117 w->class_to_vtype_die = g_hash_table_new (NULL, NULL);
118 w->class_to_pointer_die = g_hash_table_new (NULL, NULL);
119 w->class_to_reference_die = g_hash_table_new (NULL, NULL);
120 w->cur_file_index = -1;
126 mono_dwarf_writer_destroy (MonoDwarfWriter *w)
132 mono_dwarf_writer_get_il_file_line_index (MonoDwarfWriter *w)
134 return w->il_file_line_index;
137 /* Wrappers around the image writer functions */
140 emit_section_change (MonoDwarfWriter *w, const char *section_name, int subsection_index)
142 img_writer_emit_section_change (w->w, section_name, subsection_index);
146 emit_push_section (MonoDwarfWriter *w, const char *section_name, int subsection)
148 img_writer_emit_push_section (w->w, section_name, subsection);
152 emit_pop_section (MonoDwarfWriter *w)
154 img_writer_emit_pop_section (w->w);
158 emit_local_symbol (MonoDwarfWriter *w, const char *name, const char *end_label, gboolean func)
160 img_writer_emit_local_symbol (w->w, name, end_label, func);
164 emit_label (MonoDwarfWriter *w, const char *name)
166 img_writer_emit_label (w->w, name);
170 emit_bytes (MonoDwarfWriter *w, const guint8* buf, int size)
172 img_writer_emit_bytes (w->w, buf, size);
176 emit_string (MonoDwarfWriter *w, const char *value)
178 img_writer_emit_string (w->w, value);
182 emit_line (MonoDwarfWriter *w)
184 img_writer_emit_line (w->w);
188 emit_alignment (MonoDwarfWriter *w, int size)
190 img_writer_emit_alignment (w->w, size);
194 emit_pointer_unaligned (MonoDwarfWriter *w, const char *target)
196 img_writer_emit_pointer_unaligned (w->w, target);
200 emit_pointer (MonoDwarfWriter *w, const char *target)
202 img_writer_emit_pointer (w->w, target);
206 emit_int16 (MonoDwarfWriter *w, int value)
208 img_writer_emit_int16 (w->w, value);
212 emit_int32 (MonoDwarfWriter *w, int value)
214 img_writer_emit_int32 (w->w, value);
218 emit_symbol_diff (MonoDwarfWriter *w, const char *end, const char* start, int offset)
220 img_writer_emit_symbol_diff (w->w, end, start, offset);
224 emit_zero_bytes (MonoDwarfWriter *w, int num)
226 img_writer_emit_zero_bytes (w->w, num);
230 emit_byte (MonoDwarfWriter *w, guint8 val)
232 img_writer_emit_byte (w->w, val);
235 static G_GNUC_UNUSED void
236 emit_uleb128 (MonoDwarfWriter *w, guint32 value)
239 guint8 b = value & 0x7f;
241 if (value != 0) /* more bytes to come */
247 static G_GNUC_UNUSED void
248 emit_sleb128 (MonoDwarfWriter *w, gint64 value)
251 gboolean negative = (value < 0);
258 /* the following is unnecessary if the
259 * implementation of >>= uses an arithmetic rather
260 * than logical shift for a signed left operand
264 value |= - ((gint64)1 <<(size - 7));
265 /* sign bit of byte is second high order bit (0x40) */
266 if ((value == 0 && !(byte & 0x40)) ||
267 (value == -1 && (byte & 0x40)))
275 static G_GNUC_UNUSED void
276 encode_uleb128 (guint32 value, guint8 *buf, guint8 **endbuf)
281 guint8 b = value & 0x7f;
283 if (value != 0) /* more bytes to come */
291 static G_GNUC_UNUSED void
292 encode_sleb128 (gint32 value, guint8 *buf, guint8 **endbuf)
295 gboolean negative = (value < 0);
303 /* the following is unnecessary if the
304 * implementation of >>= uses an arithmetic rather
305 * than logical shift for a signed left operand
309 value |= - (1 <<(size - 7));
310 /* sign bit of byte is second high order bit (0x40) */
311 if ((value == 0 && !(byte & 0x40)) ||
312 (value == -1 && (byte & 0x40)))
323 emit_dwarf_abbrev (MonoDwarfWriter *w, int code, int tag, gboolean has_child,
324 int *attrs, int attrs_len)
328 emit_uleb128 (w, code);
329 emit_uleb128 (w, tag);
330 emit_byte (w, has_child);
332 for (i = 0; i < attrs_len; i++)
333 emit_uleb128 (w, attrs [i]);
339 emit_cie (MonoDwarfWriter *w)
341 emit_section_change (w, ".debug_frame", 0);
343 emit_alignment (w, 8);
346 emit_symbol_diff (w, ".Lcie0_end", ".Lcie0_start", 0); /* length */
347 emit_label (w, ".Lcie0_start");
348 emit_int32 (w, 0xffffffff); /* CIE id */
349 emit_byte (w, 3); /* version */
350 emit_string (w, ""); /* augmention */
351 emit_sleb128 (w, 1); /* code alignment factor */
352 emit_sleb128 (w, mono_unwind_get_dwarf_data_align ()); /* data alignment factor */
353 emit_uleb128 (w, mono_unwind_get_dwarf_pc_reg ());
355 w->cie_program = w->cie_program;
356 if (w->cie_program) {
358 guint8 *uw_info = mono_unwind_ops_encode (w->cie_program, &uw_info_len);
359 emit_bytes (w, uw_info, uw_info_len);
363 emit_alignment (w, sizeof (gpointer));
364 emit_label (w, ".Lcie0_end");
368 emit_pointer_value (MonoDwarfWriter *w, gpointer ptr)
370 gssize val = (gssize)ptr;
371 emit_bytes (w, (guint8*)&val, sizeof (gpointer));
375 emit_fde (MonoDwarfWriter *w, int fde_index, char *start_symbol, char *end_symbol,
376 guint8 *code, guint32 code_size, GSList *unwind_ops, gboolean use_cie)
384 emit_section_change (w, ".debug_frame", 0);
386 sprintf (symbol1, ".Lfde%d_start", fde_index);
387 sprintf (symbol2, ".Lfde%d_end", fde_index);
388 emit_symbol_diff (w, symbol2, symbol1, 0); /* length */
389 emit_label (w, symbol1);
390 emit_int32 (w, 0); /* CIE_pointer */
392 emit_pointer (w, start_symbol); /* initial_location */
394 emit_symbol_diff (w, end_symbol, start_symbol, 0); /* address_range */
396 g_assert (code_size);
397 emit_int32 (w, code_size);
400 emit_pointer_value (w, code);
401 emit_int32 (w, code_size);
403 #if SIZEOF_VOID_P == 8
404 /* Upper 32 bits of code size */
409 if (w->cie_program) {
410 // FIXME: Check that the ops really begin with the CIE program */
413 for (i = 0; i < g_slist_length (w->cie_program); ++i)
418 /* Convert the list of MonoUnwindOps to the format used by DWARF */
419 uw_info = mono_unwind_ops_encode (l, &uw_info_len);
420 emit_bytes (w, uw_info, uw_info_len);
423 emit_alignment (w, sizeof (mgreg_t));
424 emit_label (w, symbol2);
428 #define ABBREV_COMPILE_UNIT 1
429 #define ABBREV_SUBPROGRAM 2
430 #define ABBREV_PARAM 3
431 #define ABBREV_BASE_TYPE 4
432 #define ABBREV_STRUCT_TYPE 5
433 #define ABBREV_DATA_MEMBER 6
434 #define ABBREV_TYPEDEF 7
435 #define ABBREV_ENUM_TYPE 8
436 #define ABBREV_ENUMERATOR 9
437 #define ABBREV_NAMESPACE 10
438 #define ABBREV_VARIABLE 11
439 #define ABBREV_VARIABLE_LOCLIST 12
440 #define ABBREV_POINTER_TYPE 13
441 #define ABBREV_REFERENCE_TYPE 14
442 #define ABBREV_PARAM_LOCLIST 15
443 #define ABBREV_INHERITANCE 16
444 #define ABBREV_STRUCT_TYPE_NOCHILDREN 17
445 #define ABBREV_TRAMP_SUBPROGRAM 18
447 static int compile_unit_attr [] = {
448 DW_AT_producer ,DW_FORM_string,
449 DW_AT_name ,DW_FORM_string,
450 DW_AT_comp_dir ,DW_FORM_string,
451 DW_AT_language ,DW_FORM_data1,
452 DW_AT_low_pc ,DW_FORM_addr,
453 DW_AT_high_pc ,DW_FORM_addr,
454 DW_AT_stmt_list ,DW_FORM_data4
457 static int subprogram_attr [] = {
458 DW_AT_name , DW_FORM_string,
460 DW_AT_description , DW_FORM_string,
462 DW_AT_low_pc , DW_FORM_addr,
463 DW_AT_high_pc , DW_FORM_addr,
464 DW_AT_frame_base , DW_FORM_block1
467 static int tramp_subprogram_attr [] = {
468 DW_AT_name , DW_FORM_string,
470 DW_AT_description , DW_FORM_string,
472 DW_AT_low_pc , DW_FORM_addr,
473 DW_AT_high_pc , DW_FORM_addr,
476 static int param_attr [] = {
477 DW_AT_name, DW_FORM_string,
478 DW_AT_type, DW_FORM_ref4,
479 DW_AT_location, DW_FORM_block1
482 static int param_loclist_attr [] = {
483 DW_AT_name, DW_FORM_string,
484 DW_AT_type, DW_FORM_ref4,
485 DW_AT_location, DW_FORM_data4
488 static int base_type_attr [] = {
489 DW_AT_byte_size, DW_FORM_data1,
490 DW_AT_encoding, DW_FORM_data1,
491 DW_AT_name, DW_FORM_string
494 static int struct_type_attr [] = {
495 DW_AT_name, DW_FORM_string,
496 DW_AT_byte_size, DW_FORM_udata,
499 static int data_member_attr [] = {
500 DW_AT_name, DW_FORM_string,
501 DW_AT_type, DW_FORM_ref4,
502 DW_AT_data_member_location, DW_FORM_block1
505 static int typedef_attr [] = {
506 DW_AT_name, DW_FORM_string,
507 DW_AT_type, DW_FORM_ref4
510 static int pointer_type_attr [] = {
511 DW_AT_type, DW_FORM_ref4,
514 static int reference_type_attr [] = {
515 DW_AT_type, DW_FORM_ref4,
518 static int enum_type_attr [] = {
519 DW_AT_name, DW_FORM_string,
520 DW_AT_byte_size, DW_FORM_udata,
521 DW_AT_type, DW_FORM_ref4,
524 static int enumerator_attr [] = {
525 DW_AT_name, DW_FORM_string,
526 DW_AT_const_value, DW_FORM_sdata,
529 static int namespace_attr [] = {
530 DW_AT_name, DW_FORM_string,
533 static int variable_attr [] = {
534 DW_AT_name, DW_FORM_string,
535 DW_AT_type, DW_FORM_ref4,
536 DW_AT_location, DW_FORM_block1
539 static int variable_loclist_attr [] = {
540 DW_AT_name, DW_FORM_string,
541 DW_AT_type, DW_FORM_ref4,
542 DW_AT_location, DW_FORM_data4
545 static int inheritance_attr [] = {
546 DW_AT_type, DW_FORM_ref4,
547 DW_AT_data_member_location, DW_FORM_block1
550 typedef struct DwarfBasicType {
551 const char *die_name, *name;
557 static DwarfBasicType basic_types [] = {
558 { ".LDIE_I1", "sbyte", MONO_TYPE_I1, 1, DW_ATE_signed },
559 { ".LDIE_U1", "byte", MONO_TYPE_U1, 1, DW_ATE_unsigned },
560 { ".LDIE_I2", "short", MONO_TYPE_I2, 2, DW_ATE_signed },
561 { ".LDIE_U2", "ushort", MONO_TYPE_U2, 2, DW_ATE_unsigned },
562 { ".LDIE_I4", "int", MONO_TYPE_I4, 4, DW_ATE_signed },
563 { ".LDIE_U4", "uint", MONO_TYPE_U4, 4, DW_ATE_unsigned },
564 { ".LDIE_I8", "long", MONO_TYPE_I8, 8, DW_ATE_signed },
565 { ".LDIE_U8", "ulong", MONO_TYPE_U8, 8, DW_ATE_unsigned },
566 { ".LDIE_I", "intptr", MONO_TYPE_I, SIZEOF_VOID_P, DW_ATE_signed },
567 { ".LDIE_U", "uintptr", MONO_TYPE_U, SIZEOF_VOID_P, DW_ATE_unsigned },
568 { ".LDIE_R4", "float", MONO_TYPE_R4, 4, DW_ATE_float },
569 { ".LDIE_R8", "double", MONO_TYPE_R8, 8, DW_ATE_float },
570 { ".LDIE_BOOLEAN", "boolean", MONO_TYPE_BOOLEAN, 1, DW_ATE_boolean },
571 { ".LDIE_CHAR", "char", MONO_TYPE_CHAR, 2, DW_ATE_unsigned_char },
572 { ".LDIE_STRING", "string", MONO_TYPE_STRING, sizeof (gpointer), DW_ATE_address },
573 { ".LDIE_OBJECT", "object", MONO_TYPE_OBJECT, sizeof (gpointer), DW_ATE_address },
574 { ".LDIE_SZARRAY", "object", MONO_TYPE_SZARRAY, sizeof (gpointer), DW_ATE_address },
577 /* Constants for encoding line number special opcodes */
578 #define OPCODE_BASE 13
580 #define LINE_RANGE 14
582 /* Subsections of the .debug_line section */
583 #define LINE_SUBSECTION_HEADER 1
584 #define LINE_SUBSECTION_INCLUDES 2
585 #define LINE_SUBSECTION_FILES 3
586 #define LINE_SUBSECTION_DATA 4
587 #define LINE_SUBSECTION_END 5
590 emit_line_number_file_name (MonoDwarfWriter *w, const char *name,
591 gint64 last_mod_time, gint64 file_size)
595 char *basename = NULL;
597 if (!w->file_to_index)
598 w->file_to_index = g_hash_table_new (g_str_hash, g_str_equal);
600 index = GPOINTER_TO_UINT (g_hash_table_lookup (w->file_to_index, name));
604 if (g_path_is_absolute (name)) {
605 char *dir = g_path_get_dirname (name);
607 if (!w->dir_to_index)
608 w->dir_to_index = g_hash_table_new (g_str_hash, g_str_equal);
610 dir_index = GPOINTER_TO_UINT (g_hash_table_lookup (w->dir_to_index, dir));
611 if (dir_index == 0) {
612 emit_section_change (w, ".debug_line", LINE_SUBSECTION_INCLUDES);
613 emit_string (w, dir);
615 dir_index = ++ w->line_number_dir_index;
616 g_hash_table_insert (w->dir_to_index, g_strdup (dir), GUINT_TO_POINTER (dir_index));
621 basename = g_path_get_basename (name);
626 emit_section_change (w, ".debug_line", LINE_SUBSECTION_FILES);
629 emit_string (w, basename);
631 emit_string (w, name);
632 emit_uleb128 (w, dir_index);
636 emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
641 index = ++ w->line_number_file_index;
642 g_hash_table_insert (w->file_to_index, g_strdup (name), GUINT_TO_POINTER (index));
648 get_line_number_file_name (MonoDwarfWriter *w, const char *name)
652 g_assert (w->file_to_index);
653 index = GPOINTER_TO_UINT (g_hash_table_lookup (w->file_to_index, name));
654 g_assert (index > 0);
659 add_line_number_file_name (MonoDwarfWriter *w, const char *name,
660 gint64 last_mod_time, gint64 file_size)
665 if (!w->file_to_index) {
666 w->file_to_index = g_hash_table_new (g_str_hash, g_str_equal);
667 w->index_to_file = g_hash_table_new (NULL, NULL);
670 index = GPOINTER_TO_UINT (g_hash_table_lookup (w->file_to_index, name));
673 index = w->line_number_file_index;
674 w->line_number_file_index ++;
675 copy = g_strdup (name);
676 g_hash_table_insert (w->file_to_index, copy, GUINT_TO_POINTER (index + 1));
677 g_hash_table_insert (w->index_to_file, GUINT_TO_POINTER (index + 1), copy);
683 emit_line_number_info_begin (MonoDwarfWriter *w)
685 /* Line number info header */
687 * GAS seems to emit its own data to the end of the first subsection, so we use
688 * subsections 1, 2 etc:
689 * 1 - contains the header
690 * 2 - contains the file names
691 * 3 - contains the end of the header + the data
694 emit_section_change (w, ".debug_line", 0);
695 emit_label (w, ".Ldebug_line_section_start");
696 emit_section_change (w, ".debug_line", LINE_SUBSECTION_HEADER);
697 emit_label (w, ".Ldebug_line_start");
698 emit_symbol_diff (w, ".Ldebug_line_end", ".", -4); /* length */
699 emit_int16 (w, 0x2); /* version */
700 emit_symbol_diff (w, ".Ldebug_line_header_end", ".", -4); /* header_length */
701 emit_byte (w, 1); /* minimum_instruction_length */
702 emit_byte (w, 1); /* default_is_stmt */
703 emit_byte (w, LINE_BASE); /* line_base */
704 emit_byte (w, LINE_RANGE); /* line_range */
705 emit_byte (w, OPCODE_BASE); /* opcode_base */
706 emit_byte (w, 0); /* standard_opcode_lengths */
720 emit_section_change (w, ".debug_line", LINE_SUBSECTION_INCLUDES);
722 /* End of Includes */
723 emit_section_change (w, ".debug_line", LINE_SUBSECTION_FILES);
727 emit_line_number_file_name (w, "xdb.il", 0, 0);
730 emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
733 emit_label (w, ".Ldebug_line_header_end");
735 /* Emit this into a separate subsection so it gets placed at the end */
736 emit_section_change (w, ".debug_line", LINE_SUBSECTION_END);
740 emit_byte (w, DW_LNE_end_sequence);
742 emit_label (w, ".Ldebug_line_end");
746 mono_dwarf_escape_path (const char *name)
748 if (strchr (name, '\\')) {
753 s = g_malloc0 ((len + 1) * 2);
755 for (i = 0; i < len; ++i) {
756 if (name [i] == '\\') {
765 return g_strdup (name);
769 emit_all_line_number_info (MonoDwarfWriter *w)
772 GHashTable *dir_to_index, *index_to_dir;
776 g_assert (w->collect_line_info);
778 add_line_number_file_name (w, "<unknown>", 0, 0);
781 info_list = g_slist_reverse (w->line_info);
782 for (l = info_list; l; l = l->next) {
783 MethodLineNumberInfo *info = l->data;
784 MonoDebugMethodInfo *minfo;
786 GPtrArray *source_file_list;
789 minfo = mono_debug_lookup_method (info->method);
793 mono_debug_symfile_get_line_numbers_full (minfo, &source_file, &source_file_list, NULL, NULL, NULL, NULL, NULL);
794 for (i = 0; i < source_file_list->len; ++i) {
795 MonoDebugSourceInfo *sinfo = g_ptr_array_index (source_file_list, i);
796 add_line_number_file_name (w, sinfo->source_file, 0, 0);
800 /* Preprocess files */
801 dir_to_index = g_hash_table_new (g_str_hash, g_str_equal);
802 index_to_dir = g_hash_table_new (NULL, NULL);
803 for (i = 0; i < w->line_number_file_index; ++i) {
804 char *name = g_hash_table_lookup (w->index_to_file, GUINT_TO_POINTER (i + 1));
808 if (g_path_is_absolute (name)) {
809 char *dir = g_path_get_dirname (name);
811 dir_index = GPOINTER_TO_UINT (g_hash_table_lookup (dir_to_index, dir));
812 if (dir_index == 0) {
813 dir_index = w->line_number_dir_index;
814 w->line_number_dir_index ++;
815 copy = g_strdup (dir);
816 g_hash_table_insert (dir_to_index, copy, GUINT_TO_POINTER (dir_index + 1));
817 g_hash_table_insert (index_to_dir, GUINT_TO_POINTER (dir_index + 1), copy);
826 /* Line number info header */
827 emit_section_change (w, ".debug_line", 0);
828 emit_label (w, ".Ldebug_line_section_start");
829 emit_label (w, ".Ldebug_line_start");
830 emit_symbol_diff (w, ".Ldebug_line_end", ".", -4); /* length */
831 emit_int16 (w, 0x2); /* version */
832 emit_symbol_diff (w, ".Ldebug_line_header_end", ".", -4); /* header_length */
833 emit_byte (w, 1); /* minimum_instruction_length */
834 emit_byte (w, 1); /* default_is_stmt */
835 emit_byte (w, LINE_BASE); /* line_base */
836 emit_byte (w, LINE_RANGE); /* line_range */
837 emit_byte (w, OPCODE_BASE); /* opcode_base */
838 emit_byte (w, 0); /* standard_opcode_lengths */
852 emit_section_change (w, ".debug_line", 0);
853 for (i = 0; i < w->line_number_dir_index; ++i) {
854 char *dir = g_hash_table_lookup (index_to_dir, GUINT_TO_POINTER (i + 1));
856 emit_string (w, mono_dwarf_escape_path (dir));
858 /* End of Includes */
862 for (i = 0; i < w->line_number_file_index; ++i) {
863 char *name = g_hash_table_lookup (w->index_to_file, GUINT_TO_POINTER (i + 1));
864 char *basename = NULL, *dir;
867 if (g_path_is_absolute (name)) {
868 dir = g_path_get_dirname (name);
870 dir_index = GPOINTER_TO_UINT (g_hash_table_lookup (dir_to_index, dir));
871 basename = g_path_get_basename (name);
875 emit_string (w, basename);
877 emit_string (w, mono_dwarf_escape_path (name));
878 emit_uleb128 (w, dir_index);
886 emit_label (w, ".Ldebug_line_header_end");
888 /* Emit line number table */
889 for (l = info_list; l; l = l->next) {
890 MethodLineNumberInfo *info = l->data;
892 emit_line_number_info (w, info->method, info->start_symbol, info->end_symbol, info->code, info->code_size, info->debug_info);
894 g_slist_free (info_list);
898 emit_byte (w, DW_LNE_end_sequence);
900 emit_label (w, ".Ldebug_line_end");
904 * Some assemblers like apple's do not support subsections, so we can't place
905 * .Ldebug_info_end at the end of the section using subsections. Instead, we
906 * define it every time something gets added to the .debug_info section.
907 * The apple assember seems to use the last definition.
910 emit_debug_info_end (MonoDwarfWriter *w)
912 /* This doesn't seem to work/required with recent iphone sdk versions */
914 if (!img_writer_subsections_supported (w->w))
915 fprintf (w->fp, "\n.set %sdebug_info_end,.\n", w->temp_prefix);
920 mono_dwarf_writer_emit_base_info (MonoDwarfWriter *w, GSList *base_unwind_program)
922 char *s, *build_info;
925 w->cie_program = base_unwind_program;
927 emit_section_change (w, ".debug_abbrev", 0);
928 emit_dwarf_abbrev (w, ABBREV_COMPILE_UNIT, DW_TAG_compile_unit, TRUE,
929 compile_unit_attr, G_N_ELEMENTS (compile_unit_attr));
930 emit_dwarf_abbrev (w, ABBREV_SUBPROGRAM, DW_TAG_subprogram, TRUE,
931 subprogram_attr, G_N_ELEMENTS (subprogram_attr));
932 emit_dwarf_abbrev (w, ABBREV_PARAM, DW_TAG_formal_parameter, FALSE,
933 param_attr, G_N_ELEMENTS (param_attr));
934 emit_dwarf_abbrev (w, ABBREV_PARAM_LOCLIST, DW_TAG_formal_parameter, FALSE,
935 param_loclist_attr, G_N_ELEMENTS (param_loclist_attr));
936 emit_dwarf_abbrev (w, ABBREV_BASE_TYPE, DW_TAG_base_type, FALSE,
937 base_type_attr, G_N_ELEMENTS (base_type_attr));
938 emit_dwarf_abbrev (w, ABBREV_STRUCT_TYPE, DW_TAG_class_type, TRUE,
939 struct_type_attr, G_N_ELEMENTS (struct_type_attr));
940 emit_dwarf_abbrev (w, ABBREV_STRUCT_TYPE_NOCHILDREN, DW_TAG_class_type, FALSE,
941 struct_type_attr, G_N_ELEMENTS (struct_type_attr));
942 emit_dwarf_abbrev (w, ABBREV_DATA_MEMBER, DW_TAG_member, FALSE,
943 data_member_attr, G_N_ELEMENTS (data_member_attr));
944 emit_dwarf_abbrev (w, ABBREV_TYPEDEF, DW_TAG_typedef, FALSE,
945 typedef_attr, G_N_ELEMENTS (typedef_attr));
946 emit_dwarf_abbrev (w, ABBREV_ENUM_TYPE, DW_TAG_enumeration_type, TRUE,
947 enum_type_attr, G_N_ELEMENTS (enum_type_attr));
948 emit_dwarf_abbrev (w, ABBREV_ENUMERATOR, DW_TAG_enumerator, FALSE,
949 enumerator_attr, G_N_ELEMENTS (enumerator_attr));
950 emit_dwarf_abbrev (w, ABBREV_NAMESPACE, DW_TAG_namespace, TRUE,
951 namespace_attr, G_N_ELEMENTS (namespace_attr));
952 emit_dwarf_abbrev (w, ABBREV_VARIABLE, DW_TAG_variable, FALSE,
953 variable_attr, G_N_ELEMENTS (variable_attr));
954 emit_dwarf_abbrev (w, ABBREV_VARIABLE_LOCLIST, DW_TAG_variable, FALSE,
955 variable_loclist_attr, G_N_ELEMENTS (variable_loclist_attr));
956 emit_dwarf_abbrev (w, ABBREV_POINTER_TYPE, DW_TAG_pointer_type, FALSE,
957 pointer_type_attr, G_N_ELEMENTS (pointer_type_attr));
958 emit_dwarf_abbrev (w, ABBREV_REFERENCE_TYPE, DW_TAG_reference_type, FALSE,
959 reference_type_attr, G_N_ELEMENTS (reference_type_attr));
960 emit_dwarf_abbrev (w, ABBREV_INHERITANCE, DW_TAG_inheritance, FALSE,
961 inheritance_attr, G_N_ELEMENTS (inheritance_attr));
962 emit_dwarf_abbrev (w, ABBREV_TRAMP_SUBPROGRAM, DW_TAG_subprogram, FALSE,
963 tramp_subprogram_attr, G_N_ELEMENTS (tramp_subprogram_attr));
966 emit_section_change (w, ".debug_info", 0);
967 emit_label (w, ".Ldebug_info_start");
968 emit_symbol_diff (w, ".Ldebug_info_end", ".Ldebug_info_begin", 0); /* length */
969 emit_label (w, ".Ldebug_info_begin");
970 emit_int16 (w, 0x2); /* DWARF version 2 */
971 emit_int32 (w, 0); /* .debug_abbrev offset */
972 emit_byte (w, sizeof (gpointer)); /* address size */
974 if (img_writer_subsections_supported (w->w) && w->appending) {
975 /* Emit this into a separate section so it gets placed at the end */
976 emit_section_change (w, ".debug_info", 1);
977 emit_byte (w, 0); /* close COMPILE_UNIT */
978 emit_label (w, ".Ldebug_info_end");
979 emit_section_change (w, ".debug_info", 0);
982 /* Compilation unit */
983 emit_uleb128 (w, ABBREV_COMPILE_UNIT);
984 build_info = mono_get_runtime_build_info ();
985 s = g_strdup_printf ("Mono AOT Compiler %s", build_info);
989 emit_string (w, "JITted code");
991 emit_byte (w, DW_LANG_C);
992 emit_pointer_value (w, 0);
993 emit_pointer_value (w, 0);
994 /* offset into .debug_line section */
995 emit_symbol_diff (w, ".Ldebug_line_start", ".Ldebug_line_section_start", 0);
998 for (i = 0; i < G_N_ELEMENTS (basic_types); ++i) {
999 emit_label (w, basic_types [i].die_name);
1000 emit_uleb128 (w, ABBREV_BASE_TYPE);
1001 emit_byte (w, basic_types [i].size);
1002 emit_byte (w, basic_types [i].encoding);
1003 emit_string (w, basic_types [i].name);
1006 emit_debug_info_end (w);
1008 /* debug_loc section */
1009 emit_section_change (w, ".debug_loc", 0);
1010 emit_label (w, ".Ldebug_loc_start");
1012 /* debug_line section */
1014 * We emit some info even if emit_line is FALSE, as the
1015 * apple linker seems to require a .debug_line section.
1017 if (!w->collect_line_info)
1018 emit_line_number_info_begin (w);
1024 * mono_dwarf_writer_close:
1026 * Finalize the emitted debugging info.
1029 mono_dwarf_writer_close (MonoDwarfWriter *w)
1031 if (!w->appending) {
1032 emit_section_change (w, ".debug_info", 0);
1033 emit_byte (w, 0); /* close COMPILE_UNIT */
1034 emit_label (w, ".Ldebug_info_end");
1037 if (w->collect_line_info)
1038 emit_all_line_number_info (w);
1041 static void emit_type (MonoDwarfWriter *w, MonoType *t);
1042 static const char* get_type_die (MonoDwarfWriter *w, MonoType *t);
1045 get_class_die (MonoDwarfWriter *w, MonoClass *klass, gboolean vtype)
1050 cache = w->class_to_vtype_die;
1052 cache = w->class_to_die;
1054 return g_hash_table_lookup (cache, klass);
1057 /* Returns the local symbol pointing to the emitted debug info */
1059 emit_class_dwarf_info (MonoDwarfWriter *w, MonoClass *klass, gboolean vtype)
1061 char *die, *pointer_die, *reference_die;
1062 char *full_name, *p;
1064 MonoClassField *field;
1067 gboolean emit_namespace = FALSE, has_children;
1071 cache = w->class_to_vtype_die;
1073 cache = w->class_to_die;
1075 die = g_hash_table_lookup (cache, klass);
1079 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) ||
1080 (klass->byval_arg.type >= MONO_TYPE_BOOLEAN && klass->byval_arg.type <= MONO_TYPE_R8 && !vtype)))
1084 * FIXME: gdb can't handle namespaces in languages it doesn't know about.
1087 if (klass->name_space && klass->name_space [0] != '\0')
1088 emit_namespace = TRUE;
1090 if (emit_namespace) {
1091 emit_uleb128 (w, ABBREV_NAMESPACE);
1092 emit_string (w, klass->name_space);
1095 full_name = g_strdup_printf ("%s%s%s", klass->name_space, klass->name_space ? "." : "", klass->name);
1097 * gdb doesn't support namespaces for non-C++ dwarf objects, so use _
1098 * to separate components.
1100 for (p = full_name; *p; p ++)
1104 die = g_strdup_printf (".LTDIE_%d", w->tdie_index);
1105 pointer_die = g_strdup_printf (".LTDIE_%d_POINTER", w->tdie_index);
1106 reference_die = g_strdup_printf (".LTDIE_%d_REFERENCE", w->tdie_index);
1109 g_hash_table_insert (w->class_to_pointer_die, klass, pointer_die);
1110 g_hash_table_insert (w->class_to_reference_die, klass, reference_die);
1111 g_hash_table_insert (cache, klass, die);
1113 if (klass->enumtype) {
1114 int size = mono_class_value_size (mono_class_from_mono_type (mono_class_enum_basetype (klass)), NULL);
1116 emit_label (w, die);
1118 emit_uleb128 (w, ABBREV_ENUM_TYPE);
1119 emit_string (w, full_name);
1120 emit_uleb128 (w, size);
1121 for (k = 0; k < G_N_ELEMENTS (basic_types); ++k)
1122 if (basic_types [k].type == mono_class_enum_basetype (klass)->type)
1124 g_assert (k < G_N_ELEMENTS (basic_types));
1125 emit_symbol_diff (w, basic_types [k].die_name, ".Ldebug_info_start", 0);
1127 /* Emit enum values */
1129 while ((field = mono_class_get_fields (klass, &iter))) {
1132 MonoTypeEnum def_type;
1134 if (strcmp ("value__", mono_field_get_name (field)) == 0)
1136 if (mono_field_is_deleted (field))
1139 emit_uleb128 (w, ABBREV_ENUMERATOR);
1140 emit_string (w, mono_field_get_name (field));
1142 p = mono_class_get_field_default_value (field, &def_type);
1143 len = mono_metadata_decode_blob_size (p, &p);
1144 switch (mono_class_enum_basetype (klass)->type) {
1147 case MONO_TYPE_BOOLEAN:
1148 emit_sleb128 (w, *p);
1152 case MONO_TYPE_CHAR:
1153 emit_sleb128 (w, read16 (p));
1157 emit_sleb128 (w, read32 (p));
1161 emit_sleb128 (w, read64 (p));
1165 #if SIZEOF_VOID_P == 8
1166 emit_sleb128 (w, read64 (p));
1168 emit_sleb128 (w, read32 (p));
1172 g_assert_not_reached ();
1176 has_children = TRUE;
1183 parent_die = emit_class_dwarf_info (w, klass->parent, FALSE);
1187 /* Emit field types */
1189 while ((field = mono_class_get_fields (klass, &iter))) {
1190 if (field->type->attrs & FIELD_ATTRIBUTE_STATIC)
1193 emit_type (w, field->type);
1197 has_children = parent_die || mono_class_get_fields (klass, &iter);
1199 emit_label (w, die);
1201 emit_uleb128 (w, has_children ? ABBREV_STRUCT_TYPE : ABBREV_STRUCT_TYPE_NOCHILDREN);
1202 emit_string (w, full_name);
1203 emit_uleb128 (w, klass->instance_size);
1206 emit_uleb128 (w, ABBREV_INHERITANCE);
1207 emit_symbol_diff (w, parent_die, ".Ldebug_info_start", 0);
1210 *p ++= DW_OP_plus_uconst;
1211 encode_uleb128 (0, p, &p);
1212 emit_byte (w, p - buf);
1213 emit_bytes (w, buf, p - buf);
1218 while ((field = mono_class_get_fields (klass, &iter))) {
1219 if (field->type->attrs & FIELD_ATTRIBUTE_STATIC)
1222 fdie = get_type_die (w, field->type);
1224 emit_uleb128 (w, ABBREV_DATA_MEMBER);
1225 emit_string (w, field->name);
1226 emit_symbol_diff (w, fdie, ".Ldebug_info_start", 0);
1229 *p ++= DW_OP_plus_uconst;
1230 if (klass->valuetype && vtype)
1231 encode_uleb128 (field->offset - sizeof (MonoObject), p, &p);
1233 encode_uleb128 (field->offset, p, &p);
1235 emit_byte (w, p - buf);
1236 emit_bytes (w, buf, p - buf);
1243 emit_uleb128 (w, 0x0);
1245 /* Add a typedef, so we can reference the type without a 'struct' in gdb */
1246 emit_uleb128 (w, ABBREV_TYPEDEF);
1247 emit_string (w, full_name);
1248 emit_symbol_diff (w, die, ".Ldebug_info_start", 0);
1250 /* Add a pointer type */
1251 emit_label (w, pointer_die);
1253 emit_uleb128 (w, ABBREV_POINTER_TYPE);
1254 emit_symbol_diff (w, die, ".Ldebug_info_start", 0);
1256 /* Add a reference type */
1257 emit_label (w, reference_die);
1259 emit_uleb128 (w, ABBREV_REFERENCE_TYPE);
1260 emit_symbol_diff (w, die, ".Ldebug_info_start", 0);
1264 if (emit_namespace) {
1266 emit_uleb128 (w, 0x0);
1272 static gboolean base_types_emitted [64];
1275 get_type_die (MonoDwarfWriter *w, MonoType *t)
1277 MonoClass *klass = mono_class_from_mono_type (t);
1282 if (t->type == MONO_TYPE_VALUETYPE) {
1283 tdie = g_hash_table_lookup (w->class_to_pointer_die, klass);
1286 tdie = get_class_die (w, klass, FALSE);
1287 /* Should return a pointer type to a reference */
1290 t = &mono_defaults.int_class->byval_arg;
1292 for (j = 0; j < G_N_ELEMENTS (basic_types); ++j)
1293 if (basic_types [j].type == t->type)
1295 if (j < G_N_ELEMENTS (basic_types)) {
1296 tdie = basic_types [j].die_name;
1299 case MONO_TYPE_CLASS:
1300 tdie = g_hash_table_lookup (w->class_to_reference_die, klass);
1301 //tdie = ".LDIE_OBJECT";
1303 case MONO_TYPE_ARRAY:
1304 tdie = ".LDIE_OBJECT";
1306 case MONO_TYPE_VALUETYPE:
1307 if (klass->enumtype)
1308 tdie = get_class_die (w, klass, FALSE);
1312 case MONO_TYPE_GENERICINST:
1313 if (!MONO_TYPE_ISSTRUCT (t)) {
1314 tdie = g_hash_table_lookup (w->class_to_reference_die, klass);
1334 emit_type (MonoDwarfWriter *w, MonoType *t)
1336 MonoClass *klass = mono_class_from_mono_type (t);
1341 if (t->type == MONO_TYPE_VALUETYPE) {
1342 tdie = emit_class_dwarf_info (w, klass, TRUE);
1347 emit_class_dwarf_info (w, klass, FALSE);
1350 t = &mono_defaults.int_class->byval_arg;
1352 for (j = 0; j < G_N_ELEMENTS (basic_types); ++j)
1353 if (basic_types [j].type == t->type)
1355 if (j < G_N_ELEMENTS (basic_types)) {
1356 /* Emit a boxed version of base types */
1357 if (j < 64 && !base_types_emitted [j]) {
1358 emit_class_dwarf_info (w, klass, FALSE);
1359 base_types_emitted [j] = TRUE;
1363 case MONO_TYPE_CLASS:
1364 emit_class_dwarf_info (w, klass, FALSE);
1366 case MONO_TYPE_ARRAY:
1368 case MONO_TYPE_VALUETYPE:
1369 if (klass->enumtype)
1370 emit_class_dwarf_info (w, klass, FALSE);
1372 case MONO_TYPE_GENERICINST:
1373 if (!MONO_TYPE_ISSTRUCT (t))
1374 emit_class_dwarf_info (w, klass, FALSE);
1385 emit_var_type (MonoDwarfWriter *w, MonoType *t)
1389 tdie = get_type_die (w, t);
1391 emit_symbol_diff (w, tdie, ".Ldebug_info_start", 0);
1395 encode_var_location (MonoDwarfWriter *w, MonoInst *ins, guint8 *p, guint8 **endp)
1398 /* FIXME: This needs a location list, since the args can go from reg->stack */
1399 if (!ins || ins->flags & MONO_INST_IS_DEAD) {
1400 /* gdb treats this as optimized out */
1401 } else if (ins->opcode == OP_REGVAR) {
1402 *p = DW_OP_reg0 + mono_hw_reg_to_dwarf_reg (ins->dreg);
1404 } else if (ins->opcode == OP_REGOFFSET) {
1405 *p ++= DW_OP_breg0 + mono_hw_reg_to_dwarf_reg (ins->inst_basereg);
1406 encode_sleb128 (ins->inst_offset, p, &p);
1416 emit_loclist (MonoDwarfWriter *w, MonoInst *ins,
1417 guint8 *loclist_begin_addr, guint8 *loclist_end_addr,
1418 guint8 *expr, guint32 expr_len)
1422 emit_push_section (w, ".debug_loc", 0);
1423 sprintf (label, ".Lloclist_%d", w->loclist_index ++ );
1424 emit_label (w, label);
1426 emit_pointer_value (w, loclist_begin_addr);
1427 emit_pointer_value (w, loclist_end_addr);
1428 emit_byte (w, expr_len % 256);
1429 emit_byte (w, expr_len / 256);
1430 emit_bytes (w, expr, expr_len);
1432 emit_pointer_value (w, NULL);
1433 emit_pointer_value (w, NULL);
1435 emit_pop_section (w);
1436 emit_symbol_diff (w, label, ".Ldebug_loc_start", 0);
1440 * MonoDisHelper->tokener doesn't take an IP argument, and we can't add one since
1441 * it is a public header.
1443 static const guint8 *token_handler_ip;
1446 token_handler (MonoDisHelper *dh, MonoMethod *method, guint32 token)
1449 MonoMethod *cmethod;
1451 MonoClassField *field;
1452 gpointer data = NULL;
1454 if (method->wrapper_type)
1455 data = mono_method_get_wrapper_data (method, token);
1457 switch (*token_handler_ip) {
1461 if (method->wrapper_type)
1464 klass = mono_class_get_full (method->klass->image, token, NULL);
1465 res = g_strdup_printf ("<%s>", klass->name);
1470 if (method->wrapper_type)
1473 cmethod = mono_get_method_full (method->klass->image, token, NULL, NULL);
1474 desc = mono_method_full_name (cmethod, TRUE);
1475 res = g_strdup_printf ("<%s>", desc);
1479 if (method->wrapper_type) {
1480 desc = mono_signature_get_desc (data, FALSE);
1481 res = g_strdup_printf ("<%s>", desc);
1484 res = g_strdup_printf ("<0x%08x>", token);
1491 if (method->wrapper_type)
1494 field = mono_field_from_token (method->klass->image, token, &klass, NULL);
1495 desc = mono_field_full_name (field);
1496 res = g_strdup_printf ("<%s>", desc);
1500 res = g_strdup_printf ("<0x%08x>", token);
1510 * Produce a disassembled form of the IL instruction at IP. This is an extension
1511 * of mono_disasm_code_one () which can disasm tokens, handle wrapper methods, and
1512 * CEE_MONO_ opcodes.
1515 disasm_ins (MonoMethod *method, const guchar *ip, const guint8 **endip)
1519 MonoMethodHeader *header = mono_method_get_header (method);
1521 memset (&dh, 0, sizeof (dh));
1523 dh.label_format = "IL_%04x: ";
1524 dh.label_target = "IL_%04x";
1525 dh.tokener = token_handler;
1527 token_handler_ip = ip;
1528 if (*ip == MONO_CUSTOM_PREFIX) {
1533 case CEE_MONO_ICALL: {
1534 MonoJitICallInfo *info;
1536 token = read32 (ip + 2);
1537 data = mono_method_get_wrapper_data (method, token);
1538 info = mono_find_jit_icall_by_addr (data);
1541 dis = g_strdup_printf ("IL_%04x: mono_icall <%s>", (int)(ip - header->code), info->name);
1545 case CEE_MONO_CLASSCONST: {
1546 token = read32 (ip + 2);
1547 data = mono_method_get_wrapper_data (method, token);
1549 dis = g_strdup_printf ("IL_%04x: mono_classconst <%s>", (int)(ip - header->code), ((MonoClass*)data)->name);
1554 dis = mono_disasm_code_one (&dh, method, ip, &ip);
1557 dis = mono_disasm_code_one (&dh, method, ip, &ip);
1559 token_handler_ip = NULL;
1562 mono_metadata_free_mh (header);
1567 il_offset_from_address (MonoMethod *method, MonoDebugMethodJitInfo *jit,
1568 guint32 native_offset)
1572 if (!jit->line_numbers)
1575 for (i = jit->num_line_numbers - 1; i >= 0; i--) {
1576 MonoDebugLineNumberEntry lne = jit->line_numbers [i];
1578 if (lne.native_offset <= native_offset)
1579 return lne.il_offset;
1585 static int max_special_addr_diff = 0;
1588 emit_advance_op (MonoDwarfWriter *w, int line_diff, int addr_diff)
1592 /* Use a special opcode if possible */
1593 if (line_diff - LINE_BASE >= 0 && line_diff - LINE_BASE < LINE_RANGE) {
1594 if (max_special_addr_diff == 0)
1595 max_special_addr_diff = (255 - OPCODE_BASE) / LINE_RANGE;
1597 if (addr_diff > max_special_addr_diff && (addr_diff < 2 * max_special_addr_diff)) {
1598 emit_byte (w, DW_LNS_const_add_pc);
1599 addr_diff -= max_special_addr_diff;
1602 opcode = (line_diff - LINE_BASE) + (LINE_RANGE * addr_diff) + OPCODE_BASE;
1608 emit_byte (w, opcode);
1610 //printf ("large: %d %d %d\n", line_diff, addr_diff, max_special_addr_diff);
1611 emit_byte (w, DW_LNS_advance_line);
1612 emit_sleb128 (w, line_diff);
1613 emit_byte (w, DW_LNS_advance_pc);
1614 emit_sleb128 (w, addr_diff);
1615 emit_byte (w, DW_LNS_copy);
1620 compare_lne (MonoDebugLineNumberEntry *a, MonoDebugLineNumberEntry *b)
1622 if (a->native_offset == b->native_offset)
1623 return a->il_offset - b->il_offset;
1625 return a->native_offset - b->native_offset;
1629 emit_line_number_info (MonoDwarfWriter *w, MonoMethod *method,
1630 char *start_symbol, char *end_symbol,
1631 guint8 *code, guint32 code_size,
1632 MonoDebugMethodJitInfo *debug_info)
1634 guint32 prev_line = 0;
1635 guint32 prev_native_offset = 0;
1636 int i, file_index, il_offset, prev_il_offset;
1637 gboolean first = TRUE;
1638 MonoDebugSourceLocation *loc;
1639 char *prev_file_name = NULL;
1640 MonoMethodHeader *header = mono_method_get_header (method);
1641 MonoDebugMethodInfo *minfo;
1642 MonoDebugLineNumberEntry *ln_array;
1643 int *native_to_il_offset = NULL;
1645 if (!w->emit_line) {
1646 mono_metadata_free_mh (header);
1650 minfo = mono_debug_lookup_method (method);
1652 /* Compute the native->IL offset mapping */
1654 g_assert (code_size);
1656 ln_array = g_new0 (MonoDebugLineNumberEntry, debug_info->num_line_numbers);
1657 memcpy (ln_array, debug_info->line_numbers, debug_info->num_line_numbers * sizeof (MonoDebugLineNumberEntry));
1659 qsort (ln_array, debug_info->num_line_numbers, sizeof (MonoDebugLineNumberEntry), (gpointer)compare_lne);
1661 native_to_il_offset = g_new0 (int, code_size + 1);
1663 for (i = 0; i < debug_info->num_line_numbers; ++i) {
1665 MonoDebugLineNumberEntry *lne = &ln_array [i];
1668 for (j = 0; j < lne->native_offset; ++j)
1669 native_to_il_offset [j] = -1;
1672 if (i < debug_info->num_line_numbers - 1) {
1673 MonoDebugLineNumberEntry *lne_next = &ln_array [i + 1];
1675 for (j = lne->native_offset; j < lne_next->native_offset; ++j)
1676 native_to_il_offset [j] = lne->il_offset;
1678 for (j = lne->native_offset; j < code_size; ++j)
1679 native_to_il_offset [j] = lne->il_offset;
1685 prev_il_offset = -1;
1687 for (i = 0; i < code_size; ++i) {
1688 int line_diff, addr_diff;
1693 if (!debug_info->line_numbers)
1696 if (native_to_il_offset)
1697 il_offset = native_to_il_offset [i];
1699 il_offset = il_offset_from_address (method, debug_info, i);
1701 il_offset = il_offset_from_address (method, debug_info, i);
1703 g_assert (il_offset == native_to_il_offset [i]);
1706 il_offset = native_to_il_offset [i];
1710 if (il_offset == prev_il_offset)
1713 prev_il_offset = il_offset;
1715 loc = mono_debug_symfile_lookup_location (minfo, il_offset);
1716 if (!(loc && loc->source_file))
1719 line_diff = (gint32)loc->row - (gint32)prev_line;
1720 addr_diff = i - prev_native_offset;
1723 emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
1726 emit_byte (w, sizeof (gpointer) + 1);
1727 emit_byte (w, DW_LNE_set_address);
1729 emit_pointer_unaligned (w, start_symbol);
1731 emit_pointer_value (w, code);
1734 * The prolog+initlocals region does not have a line number, this
1735 * makes them belong to the first line of the method.
1737 emit_byte (w, DW_LNS_advance_line);
1738 //printf ("FIRST: %d %d %d\n", prev_line, loc->row, il_offset);
1739 emit_sleb128 (w, (gint32)loc->row - (gint32)prev_line);
1740 prev_line = loc->row;
1741 prev_native_offset = i;
1745 if (loc->row != prev_line) {
1746 if (!prev_file_name || strcmp (loc->source_file, prev_file_name) != 0) {
1747 /* Add an entry to the file table */
1748 /* FIXME: Avoid duplicates */
1749 if (w->collect_line_info)
1750 file_index = get_line_number_file_name (w, loc->source_file) + 1;
1752 file_index = emit_line_number_file_name (w, loc->source_file, 0, 0);
1753 g_free (prev_file_name);
1754 prev_file_name = g_strdup (loc->source_file);
1756 if (w->cur_file_index != file_index) {
1757 emit_byte (w, DW_LNS_set_file);
1758 emit_uleb128 (w, file_index);
1759 emit_byte (w, DW_LNS_copy);
1760 w->cur_file_index = file_index;
1763 //printf ("X: %p(+0x%x) %d %s:%d(+%d)\n", code + i, addr_diff, loc->il_offset, loc->source_file, loc->row, line_diff);
1764 emit_advance_op (w, line_diff, addr_diff);
1766 prev_line = loc->row;
1767 prev_native_offset = i;
1770 mono_debug_symfile_free_location (loc);
1773 g_free (native_to_il_offset);
1774 g_free (prev_file_name);
1777 emit_byte (w, DW_LNS_advance_pc);
1778 emit_sleb128 (w, code_size - prev_native_offset);
1779 emit_byte (w, DW_LNS_copy);
1783 emit_byte (w, DW_LNE_end_sequence);
1784 } else if (!start_symbol) {
1785 /* No debug info, XDEBUG mode */
1787 const guint8 *ip = header->code;
1788 int prev_line, prev_native_offset;
1792 * Emit the IL code into a temporary file and emit line number info
1793 * referencing that file.
1796 name = mono_method_full_name (method, TRUE);
1797 fprintf (w->il_file, "// %s\n", name);
1798 w->il_file_line_index ++;
1801 il_to_line = g_new0 (int, header->code_size);
1803 emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
1805 emit_byte (w, sizeof (gpointer) + 1);
1806 emit_byte (w, DW_LNE_set_address);
1807 emit_pointer_value (w, code);
1809 // FIXME: Optimize this
1810 while (ip < header->code + header->code_size) {
1811 int il_offset = ip - header->code;
1814 w->il_file_line_index ++;
1816 dis = disasm_ins (method, ip, &ip);
1817 fprintf (w->il_file, "%s\n", dis);
1820 il_to_line [il_offset] = w->il_file_line_index;
1823 /* Emit line number info */
1825 prev_native_offset = 0;
1826 for (i = 0; i < debug_info->num_line_numbers; ++i) {
1827 MonoDebugLineNumberEntry *lne = &debug_info->line_numbers [i];
1830 if (lne->il_offset >= header->code_size)
1832 line = il_to_line [lne->il_offset];
1835 * This seems to happen randomly, it looks like il_offset points
1836 * into the middle of an instruction.
1840 printf ("%s\n", mono_method_full_name (method, TRUE));
1841 printf ("%d %d\n", lne->il_offset, header->code_size);
1846 if (line - prev_line != 0) {
1847 emit_advance_op (w, line - prev_line, (gint32)lne->native_offset - prev_native_offset);
1850 prev_native_offset = lne->native_offset;
1854 emit_byte (w, DW_LNS_advance_pc);
1855 emit_sleb128 (w, code_size - prev_native_offset);
1856 emit_byte (w, DW_LNS_copy);
1860 emit_byte (w, DW_LNE_end_sequence);
1862 fflush (w->il_file);
1863 g_free (il_to_line);
1865 mono_metadata_free_mh (header);
1868 static MonoMethodVar*
1869 find_vmv (MonoCompile *cfg, MonoInst *ins)
1874 for (j = 0; j < cfg->num_varinfo; ++j) {
1875 if (cfg->varinfo [j] == ins)
1879 if (j < cfg->num_varinfo) {
1880 return MONO_VARINFO (cfg, j);
1888 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)
1891 MonoMethodSignature *sig;
1892 MonoMethodHeader *header;
1894 MonoDebugLocalsInfo *locals_info;
1899 emit_section_change (w, ".debug_info", 0);
1901 sig = mono_method_signature (method);
1902 header = mono_method_get_header (method);
1904 /* Parameter types */
1905 for (i = 0; i < sig->param_count + sig->hasthis; ++i) {
1908 if (i == 0 && sig->hasthis) {
1909 if (method->klass->valuetype)
1910 t = &method->klass->this_arg;
1912 t = &method->klass->byval_arg;
1914 t = sig->params [i - sig->hasthis];
1919 //emit_type (w, &mono_defaults.int32_class->byval_arg);
1922 for (i = 0; i < header->num_locals; ++i) {
1923 emit_type (w, header->locals [i]);
1927 names = g_new0 (char *, sig->param_count);
1928 mono_method_get_param_names (method, (const char **) names);
1930 emit_uleb128 (w, ABBREV_SUBPROGRAM);
1931 name = mono_method_full_name (method, FALSE);
1932 emit_string (w, name);
1934 emit_string (w, name);
1938 emit_pointer_unaligned (w, start_symbol);
1939 emit_pointer_unaligned (w, end_symbol);
1941 emit_pointer_value (w, code);
1942 emit_pointer_value (w, code + code_size);
1946 emit_byte (w, DW_OP_breg6);
1950 for (i = 0; i < sig->param_count + sig->hasthis; ++i) {
1951 MonoInst *arg = args ? args [i] : NULL;
1954 char pname_buf [128];
1955 MonoMethodVar *vmv = NULL;
1956 gboolean need_loclist = FALSE;
1958 vmv = find_vmv (cfg, arg);
1959 if (code && vmv && (vmv->live_range_start || vmv->live_range_end))
1960 need_loclist = TRUE;
1962 if (i == 0 && sig->hasthis) {
1963 if (method->klass->valuetype)
1964 t = &method->klass->this_arg;
1966 t = &method->klass->byval_arg;
1969 t = sig->params [i - sig->hasthis];
1970 pname = names [i - sig->hasthis];
1973 emit_uleb128 (w, need_loclist ? ABBREV_PARAM_LOCLIST : ABBREV_PARAM);
1975 if (pname[0] == '\0') {
1976 sprintf (pname_buf, "param%d", i - sig->hasthis);
1979 emit_string (w, pname);
1981 if (!arg || arg->flags & MONO_INST_IS_DEAD)
1982 emit_var_type (w, &mono_defaults.int32_class->byval_arg);
1984 emit_var_type (w, t);
1987 encode_var_location (w, arg, p, &p);
1989 vmv->live_range_start = 0;
1990 if (vmv->live_range_end == 0)
1991 /* FIXME: Uses made in calls are not recorded */
1992 vmv->live_range_end = code_size;
1993 emit_loclist (w, arg, code + vmv->live_range_start, code + vmv->live_range_end, buf, p - buf);
1995 emit_byte (w, p - buf);
1996 emit_bytes (w, buf, p - buf);
2002 locals_info = mono_debug_lookup_locals (method);
2004 for (i = 0; i < header->num_locals; ++i) {
2005 MonoInst *ins = locals [i];
2006 char name_buf [128];
2008 MonoMethodVar *vmv = NULL;
2009 gboolean need_loclist = FALSE;
2012 /* ins->dreg no longer contains the original vreg */
2013 vmv = find_vmv (cfg, ins);
2015 if (vmv->live_range_start) {
2016 /* This variable has a precise live range */
2017 need_loclist = TRUE;
2021 emit_uleb128 (w, need_loclist ? ABBREV_VARIABLE_LOCLIST : ABBREV_VARIABLE);
2025 for (j = 0; j < locals_info->num_locals; ++j)
2026 if (locals_info->locals [j].index == i)
2028 if (j < locals_info->num_locals)
2029 lname = locals_info->locals [j].name;
2032 emit_string (w, lname);
2034 sprintf (name_buf, "V_%d", i);
2035 emit_string (w, name_buf);
2038 if (!ins || ins->flags & MONO_INST_IS_DEAD)
2039 emit_var_type (w, &mono_defaults.int32_class->byval_arg);
2041 emit_var_type (w, header->locals [i]);
2044 encode_var_location (w, ins, p, &p);
2047 if (vmv->live_range_end == 0)
2048 /* FIXME: Uses made in calls are not recorded */
2049 vmv->live_range_end = code_size;
2050 emit_loclist (w, ins, code + vmv->live_range_start, code + vmv->live_range_end, buf, p - buf);
2052 emit_byte (w, p - buf);
2053 emit_bytes (w, buf, p - buf);
2058 mono_debug_symfile_free_locals (locals_info);
2060 /* Subprogram end */
2061 emit_uleb128 (w, 0x0);
2065 emit_debug_info_end (w);
2067 /* Emit unwind info */
2069 emit_fde (w, w->fde_index, start_symbol, end_symbol, code, code_size, unwind_info, TRUE);
2073 /* Emit line number info */
2074 /* != could happen when using --regression */
2075 if (debug_info && (debug_info->code_start == code)) {
2076 if (w->collect_line_info) {
2077 MethodLineNumberInfo *info;
2079 /* Save the information needed to emit the line number info later at once */
2080 info = g_new0 (MethodLineNumberInfo, 1);
2081 info->method = method;
2082 info->start_symbol = g_strdup (start_symbol);
2083 info->end_symbol = g_strdup (end_symbol);
2085 info->code_size = code_size;
2086 info->debug_info = debug_info;
2087 w->line_info = g_slist_prepend (w->line_info, info);
2089 emit_line_number_info (w, method, start_symbol, end_symbol, code, code_size, debug_info);
2094 mono_metadata_free_mh (header);
2098 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)
2100 emit_section_change (w, ".debug_info", 0);
2103 emit_uleb128 (w, ABBREV_TRAMP_SUBPROGRAM);
2104 emit_string (w, tramp_name);
2105 emit_pointer_value (w, code);
2106 emit_pointer_value (w, code + code_size);
2108 /* Subprogram end */
2109 emit_uleb128 (w, 0x0);
2111 emit_debug_info_end (w);
2113 /* Emit unwind info */
2114 emit_fde (w, w->fde_index, start_symbol, end_symbol, code, code_size, unwind_info, FALSE);
2117 #endif /* End of: !defined(DISABLE_AOT) && !defined(DISABLE_JIT) */