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 } MethodLineNumberInfo;
40 struct _MonoDwarfWriter
43 GHashTable *class_to_die, *class_to_vtype_die, *class_to_pointer_die;
44 GHashTable *class_to_reference_die;
45 int fde_index, tdie_index, line_number_file_index, line_number_dir_index;
46 GHashTable *file_to_index, *index_to_file, *dir_to_index;
48 int il_file_line_index, loclist_index;
51 const char *temp_prefix;
52 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, gboolean emit_line_numbers)
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 if (!emit_line_numbers) {
108 w->emit_line = FALSE;
109 w->collect_line_info = FALSE;
112 w->fp = img_writer_get_fp (w->w);
113 w->temp_prefix = img_writer_get_temp_label_prefix (w->w);
115 w->class_to_die = g_hash_table_new (NULL, NULL);
116 w->class_to_vtype_die = g_hash_table_new (NULL, NULL);
117 w->class_to_pointer_die = g_hash_table_new (NULL, NULL);
118 w->class_to_reference_die = g_hash_table_new (NULL, NULL);
119 w->cur_file_index = -1;
125 mono_dwarf_writer_destroy (MonoDwarfWriter *w)
131 mono_dwarf_writer_get_il_file_line_index (MonoDwarfWriter *w)
133 return w->il_file_line_index;
136 /* Wrappers around the image writer functions */
139 emit_section_change (MonoDwarfWriter *w, const char *section_name, int subsection_index)
141 img_writer_emit_section_change (w->w, section_name, subsection_index);
145 emit_push_section (MonoDwarfWriter *w, const char *section_name, int subsection)
147 img_writer_emit_push_section (w->w, section_name, subsection);
151 emit_pop_section (MonoDwarfWriter *w)
153 img_writer_emit_pop_section (w->w);
157 emit_local_symbol (MonoDwarfWriter *w, const char *name, const char *end_label, gboolean func)
159 img_writer_emit_local_symbol (w->w, name, end_label, func);
163 emit_label (MonoDwarfWriter *w, const char *name)
165 img_writer_emit_label (w->w, name);
169 emit_bytes (MonoDwarfWriter *w, const guint8* buf, int size)
171 img_writer_emit_bytes (w->w, buf, size);
175 emit_string (MonoDwarfWriter *w, const char *value)
177 img_writer_emit_string (w->w, value);
181 emit_line (MonoDwarfWriter *w)
183 img_writer_emit_line (w->w);
187 emit_alignment (MonoDwarfWriter *w, int size)
189 img_writer_emit_alignment (w->w, size);
193 emit_pointer_unaligned (MonoDwarfWriter *w, const char *target)
195 img_writer_emit_pointer_unaligned (w->w, target);
199 emit_pointer (MonoDwarfWriter *w, const char *target)
201 img_writer_emit_pointer (w->w, target);
205 emit_int16 (MonoDwarfWriter *w, int value)
207 img_writer_emit_int16 (w->w, value);
211 emit_int32 (MonoDwarfWriter *w, int value)
213 img_writer_emit_int32 (w->w, value);
217 emit_symbol_diff (MonoDwarfWriter *w, const char *end, const char* start, int offset)
219 img_writer_emit_symbol_diff (w->w, end, start, offset);
223 emit_zero_bytes (MonoDwarfWriter *w, int num)
225 img_writer_emit_zero_bytes (w->w, num);
229 emit_byte (MonoDwarfWriter *w, guint8 val)
231 img_writer_emit_byte (w->w, val);
234 static G_GNUC_UNUSED void
235 emit_uleb128 (MonoDwarfWriter *w, guint32 value)
238 guint8 b = value & 0x7f;
240 if (value != 0) /* more bytes to come */
246 static G_GNUC_UNUSED void
247 emit_sleb128 (MonoDwarfWriter *w, gint64 value)
250 gboolean negative = (value < 0);
257 /* the following is unnecessary if the
258 * implementation of >>= uses an arithmetic rather
259 * than logical shift for a signed left operand
263 value |= - ((gint64)1 <<(size - 7));
264 /* sign bit of byte is second high order bit (0x40) */
265 if ((value == 0 && !(byte & 0x40)) ||
266 (value == -1 && (byte & 0x40)))
274 static G_GNUC_UNUSED void
275 encode_uleb128 (guint32 value, guint8 *buf, guint8 **endbuf)
280 guint8 b = value & 0x7f;
282 if (value != 0) /* more bytes to come */
290 static G_GNUC_UNUSED void
291 encode_sleb128 (gint32 value, guint8 *buf, guint8 **endbuf)
294 gboolean negative = (value < 0);
302 /* the following is unnecessary if the
303 * implementation of >>= uses an arithmetic rather
304 * than logical shift for a signed left operand
308 value |= - (1 <<(size - 7));
309 /* sign bit of byte is second high order bit (0x40) */
310 if ((value == 0 && !(byte & 0x40)) ||
311 (value == -1 && (byte & 0x40)))
322 emit_dwarf_abbrev (MonoDwarfWriter *w, int code, int tag, gboolean has_child,
323 int *attrs, int attrs_len)
327 emit_uleb128 (w, code);
328 emit_uleb128 (w, tag);
329 emit_byte (w, has_child);
331 for (i = 0; i < attrs_len; i++)
332 emit_uleb128 (w, attrs [i]);
338 emit_cie (MonoDwarfWriter *w)
340 emit_section_change (w, ".debug_frame", 0);
342 emit_alignment (w, 8);
345 emit_symbol_diff (w, ".Lcie0_end", ".Lcie0_start", 0); /* length */
346 emit_label (w, ".Lcie0_start");
347 emit_int32 (w, 0xffffffff); /* CIE id */
348 emit_byte (w, 3); /* version */
349 emit_string (w, ""); /* augmention */
350 emit_sleb128 (w, 1); /* code alignment factor */
351 emit_sleb128 (w, mono_unwind_get_dwarf_data_align ()); /* data alignment factor */
352 emit_uleb128 (w, mono_unwind_get_dwarf_pc_reg ());
354 w->cie_program = w->cie_program;
355 if (w->cie_program) {
357 guint8 *uw_info = mono_unwind_ops_encode (w->cie_program, &uw_info_len);
358 emit_bytes (w, uw_info, uw_info_len);
362 emit_alignment (w, sizeof (gpointer));
363 emit_label (w, ".Lcie0_end");
367 emit_pointer_value (MonoDwarfWriter *w, gpointer ptr)
369 gssize val = (gssize)ptr;
370 emit_bytes (w, (guint8*)&val, sizeof (gpointer));
374 emit_fde (MonoDwarfWriter *w, int fde_index, char *start_symbol, char *end_symbol,
375 guint8 *code, guint32 code_size, GSList *unwind_ops, gboolean use_cie)
383 emit_section_change (w, ".debug_frame", 0);
385 sprintf (symbol1, ".Lfde%d_start", fde_index);
386 sprintf (symbol2, ".Lfde%d_end", fde_index);
387 emit_symbol_diff (w, symbol2, symbol1, 0); /* length */
388 emit_label (w, symbol1);
389 emit_int32 (w, 0); /* CIE_pointer */
391 emit_pointer (w, start_symbol); /* initial_location */
393 emit_symbol_diff (w, end_symbol, start_symbol, 0); /* address_range */
395 g_assert (code_size);
396 emit_int32 (w, code_size);
399 emit_pointer_value (w, code);
400 emit_int32 (w, code_size);
402 #if SIZEOF_VOID_P == 8
403 /* Upper 32 bits of code size */
408 if (w->cie_program) {
409 // FIXME: Check that the ops really begin with the CIE program */
412 for (i = 0; i < g_slist_length (w->cie_program); ++i)
417 /* Convert the list of MonoUnwindOps to the format used by DWARF */
418 uw_info = mono_unwind_ops_encode (l, &uw_info_len);
419 emit_bytes (w, uw_info, uw_info_len);
422 emit_alignment (w, sizeof (mgreg_t));
423 emit_label (w, symbol2);
427 #define ABBREV_COMPILE_UNIT 1
428 #define ABBREV_SUBPROGRAM 2
429 #define ABBREV_PARAM 3
430 #define ABBREV_BASE_TYPE 4
431 #define ABBREV_STRUCT_TYPE 5
432 #define ABBREV_DATA_MEMBER 6
433 #define ABBREV_TYPEDEF 7
434 #define ABBREV_ENUM_TYPE 8
435 #define ABBREV_ENUMERATOR 9
436 #define ABBREV_NAMESPACE 10
437 #define ABBREV_VARIABLE 11
438 #define ABBREV_VARIABLE_LOCLIST 12
439 #define ABBREV_POINTER_TYPE 13
440 #define ABBREV_REFERENCE_TYPE 14
441 #define ABBREV_PARAM_LOCLIST 15
442 #define ABBREV_INHERITANCE 16
443 #define ABBREV_STRUCT_TYPE_NOCHILDREN 17
444 #define ABBREV_TRAMP_SUBPROGRAM 18
446 static int compile_unit_attr [] = {
447 DW_AT_producer ,DW_FORM_string,
448 DW_AT_name ,DW_FORM_string,
449 DW_AT_comp_dir ,DW_FORM_string,
450 DW_AT_language ,DW_FORM_data1,
451 DW_AT_low_pc ,DW_FORM_addr,
452 DW_AT_high_pc ,DW_FORM_addr,
453 DW_AT_stmt_list ,DW_FORM_data4
456 static int subprogram_attr [] = {
457 DW_AT_name , DW_FORM_string,
459 DW_AT_description , DW_FORM_string,
461 DW_AT_low_pc , DW_FORM_addr,
462 DW_AT_high_pc , DW_FORM_addr,
463 DW_AT_frame_base , DW_FORM_block1
466 static int tramp_subprogram_attr [] = {
467 DW_AT_name , DW_FORM_string,
469 DW_AT_description , DW_FORM_string,
471 DW_AT_low_pc , DW_FORM_addr,
472 DW_AT_high_pc , DW_FORM_addr,
475 static int param_attr [] = {
476 DW_AT_name, DW_FORM_string,
477 DW_AT_type, DW_FORM_ref4,
478 DW_AT_location, DW_FORM_block1
481 static int param_loclist_attr [] = {
482 DW_AT_name, DW_FORM_string,
483 DW_AT_type, DW_FORM_ref4,
484 DW_AT_location, DW_FORM_data4
487 static int base_type_attr [] = {
488 DW_AT_byte_size, DW_FORM_data1,
489 DW_AT_encoding, DW_FORM_data1,
490 DW_AT_name, DW_FORM_string
493 static int struct_type_attr [] = {
494 DW_AT_name, DW_FORM_string,
495 DW_AT_byte_size, DW_FORM_udata,
498 static int data_member_attr [] = {
499 DW_AT_name, DW_FORM_string,
500 DW_AT_type, DW_FORM_ref4,
501 DW_AT_data_member_location, DW_FORM_block1
504 static int typedef_attr [] = {
505 DW_AT_name, DW_FORM_string,
506 DW_AT_type, DW_FORM_ref4
509 static int pointer_type_attr [] = {
510 DW_AT_type, DW_FORM_ref4,
513 static int reference_type_attr [] = {
514 DW_AT_type, DW_FORM_ref4,
517 static int enum_type_attr [] = {
518 DW_AT_name, DW_FORM_string,
519 DW_AT_byte_size, DW_FORM_udata,
520 DW_AT_type, DW_FORM_ref4,
523 static int enumerator_attr [] = {
524 DW_AT_name, DW_FORM_string,
525 DW_AT_const_value, DW_FORM_sdata,
528 static int namespace_attr [] = {
529 DW_AT_name, DW_FORM_string,
532 static int variable_attr [] = {
533 DW_AT_name, DW_FORM_string,
534 DW_AT_type, DW_FORM_ref4,
535 DW_AT_location, DW_FORM_block1
538 static int variable_loclist_attr [] = {
539 DW_AT_name, DW_FORM_string,
540 DW_AT_type, DW_FORM_ref4,
541 DW_AT_location, DW_FORM_data4
544 static int inheritance_attr [] = {
545 DW_AT_type, DW_FORM_ref4,
546 DW_AT_data_member_location, DW_FORM_block1
549 typedef struct DwarfBasicType {
550 const char *die_name, *name;
556 static DwarfBasicType basic_types [] = {
557 { ".LDIE_I1", "sbyte", MONO_TYPE_I1, 1, DW_ATE_signed },
558 { ".LDIE_U1", "byte", MONO_TYPE_U1, 1, DW_ATE_unsigned },
559 { ".LDIE_I2", "short", MONO_TYPE_I2, 2, DW_ATE_signed },
560 { ".LDIE_U2", "ushort", MONO_TYPE_U2, 2, DW_ATE_unsigned },
561 { ".LDIE_I4", "int", MONO_TYPE_I4, 4, DW_ATE_signed },
562 { ".LDIE_U4", "uint", MONO_TYPE_U4, 4, DW_ATE_unsigned },
563 { ".LDIE_I8", "long", MONO_TYPE_I8, 8, DW_ATE_signed },
564 { ".LDIE_U8", "ulong", MONO_TYPE_U8, 8, DW_ATE_unsigned },
565 { ".LDIE_I", "intptr", MONO_TYPE_I, SIZEOF_VOID_P, DW_ATE_signed },
566 { ".LDIE_U", "uintptr", MONO_TYPE_U, SIZEOF_VOID_P, DW_ATE_unsigned },
567 { ".LDIE_R4", "float", MONO_TYPE_R4, 4, DW_ATE_float },
568 { ".LDIE_R8", "double", MONO_TYPE_R8, 8, DW_ATE_float },
569 { ".LDIE_BOOLEAN", "boolean", MONO_TYPE_BOOLEAN, 1, DW_ATE_boolean },
570 { ".LDIE_CHAR", "char", MONO_TYPE_CHAR, 2, DW_ATE_unsigned_char },
571 { ".LDIE_STRING", "string", MONO_TYPE_STRING, sizeof (gpointer), DW_ATE_address },
572 { ".LDIE_OBJECT", "object", MONO_TYPE_OBJECT, sizeof (gpointer), DW_ATE_address },
573 { ".LDIE_SZARRAY", "object", MONO_TYPE_SZARRAY, sizeof (gpointer), DW_ATE_address },
576 /* Constants for encoding line number special opcodes */
577 #define OPCODE_BASE 13
579 #define LINE_RANGE 14
581 /* Subsections of the .debug_line section */
582 #define LINE_SUBSECTION_HEADER 1
583 #define LINE_SUBSECTION_INCLUDES 2
584 #define LINE_SUBSECTION_FILES 3
585 #define LINE_SUBSECTION_DATA 4
586 #define LINE_SUBSECTION_END 5
589 emit_line_number_file_name (MonoDwarfWriter *w, const char *name,
590 gint64 last_mod_time, gint64 file_size)
594 char *basename = NULL;
596 if (!w->file_to_index)
597 w->file_to_index = g_hash_table_new (g_str_hash, g_str_equal);
599 index = GPOINTER_TO_UINT (g_hash_table_lookup (w->file_to_index, name));
603 if (g_path_is_absolute (name)) {
604 char *dir = g_path_get_dirname (name);
606 if (!w->dir_to_index)
607 w->dir_to_index = g_hash_table_new (g_str_hash, g_str_equal);
609 dir_index = GPOINTER_TO_UINT (g_hash_table_lookup (w->dir_to_index, dir));
610 if (dir_index == 0) {
611 emit_section_change (w, ".debug_line", LINE_SUBSECTION_INCLUDES);
612 emit_string (w, dir);
614 dir_index = ++ w->line_number_dir_index;
615 g_hash_table_insert (w->dir_to_index, g_strdup (dir), GUINT_TO_POINTER (dir_index));
620 basename = g_path_get_basename (name);
625 emit_section_change (w, ".debug_line", LINE_SUBSECTION_FILES);
628 emit_string (w, basename);
630 emit_string (w, name);
631 emit_uleb128 (w, dir_index);
635 emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
640 index = ++ w->line_number_file_index;
641 g_hash_table_insert (w->file_to_index, g_strdup (name), GUINT_TO_POINTER (index));
647 get_line_number_file_name (MonoDwarfWriter *w, const char *name)
651 g_assert (w->file_to_index);
652 index = GPOINTER_TO_UINT (g_hash_table_lookup (w->file_to_index, name));
653 g_assert (index > 0);
658 add_line_number_file_name (MonoDwarfWriter *w, const char *name,
659 gint64 last_mod_time, gint64 file_size)
664 if (!w->file_to_index) {
665 w->file_to_index = g_hash_table_new (g_str_hash, g_str_equal);
666 w->index_to_file = g_hash_table_new (NULL, NULL);
669 index = GPOINTER_TO_UINT (g_hash_table_lookup (w->file_to_index, name));
672 index = w->line_number_file_index;
673 w->line_number_file_index ++;
674 copy = g_strdup (name);
675 g_hash_table_insert (w->file_to_index, copy, GUINT_TO_POINTER (index + 1));
676 g_hash_table_insert (w->index_to_file, GUINT_TO_POINTER (index + 1), copy);
682 emit_line_number_info_begin (MonoDwarfWriter *w)
684 /* Line number info header */
686 * GAS seems to emit its own data to the end of the first subsection, so we use
687 * subsections 1, 2 etc:
688 * 1 - contains the header
689 * 2 - contains the file names
690 * 3 - contains the end of the header + the data
693 emit_section_change (w, ".debug_line", 0);
694 emit_label (w, ".Ldebug_line_section_start");
695 emit_section_change (w, ".debug_line", LINE_SUBSECTION_HEADER);
696 emit_label (w, ".Ldebug_line_start");
697 emit_symbol_diff (w, ".Ldebug_line_end", ".", -4); /* length */
698 emit_int16 (w, 0x2); /* version */
699 emit_symbol_diff (w, ".Ldebug_line_header_end", ".", -4); /* header_length */
700 emit_byte (w, 1); /* minimum_instruction_length */
701 emit_byte (w, 1); /* default_is_stmt */
702 emit_byte (w, LINE_BASE); /* line_base */
703 emit_byte (w, LINE_RANGE); /* line_range */
704 emit_byte (w, OPCODE_BASE); /* opcode_base */
705 emit_byte (w, 0); /* standard_opcode_lengths */
719 emit_section_change (w, ".debug_line", LINE_SUBSECTION_INCLUDES);
721 /* End of Includes */
722 emit_section_change (w, ".debug_line", LINE_SUBSECTION_FILES);
726 emit_line_number_file_name (w, "xdb.il", 0, 0);
729 emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
732 emit_label (w, ".Ldebug_line_header_end");
734 /* Emit this into a separate subsection so it gets placed at the end */
735 emit_section_change (w, ".debug_line", LINE_SUBSECTION_END);
739 emit_byte (w, DW_LNE_end_sequence);
741 emit_label (w, ".Ldebug_line_end");
745 mono_dwarf_escape_path (const char *name)
747 if (strchr (name, '\\')) {
752 s = g_malloc0 ((len + 1) * 2);
754 for (i = 0; i < len; ++i) {
755 if (name [i] == '\\') {
764 return g_strdup (name);
768 emit_all_line_number_info (MonoDwarfWriter *w)
771 GHashTable *dir_to_index, *index_to_dir;
775 g_assert (w->collect_line_info);
777 add_line_number_file_name (w, "<unknown>", 0, 0);
780 info_list = g_slist_reverse (w->line_info);
781 for (l = info_list; l; l = l->next) {
782 MethodLineNumberInfo *info = l->data;
783 MonoDebugMethodInfo *minfo;
785 GPtrArray *source_file_list;
788 minfo = mono_debug_lookup_method (info->method);
792 mono_debug_symfile_get_line_numbers_full (minfo, &source_file, &source_file_list, NULL, NULL, NULL, NULL, NULL);
793 for (i = 0; i < source_file_list->len; ++i) {
794 MonoDebugSourceInfo *sinfo = g_ptr_array_index (source_file_list, i);
795 add_line_number_file_name (w, sinfo->source_file, 0, 0);
799 /* Preprocess files */
800 dir_to_index = g_hash_table_new (g_str_hash, g_str_equal);
801 index_to_dir = g_hash_table_new (NULL, NULL);
802 for (i = 0; i < w->line_number_file_index; ++i) {
803 char *name = g_hash_table_lookup (w->index_to_file, GUINT_TO_POINTER (i + 1));
807 if (g_path_is_absolute (name)) {
808 char *dir = g_path_get_dirname (name);
810 dir_index = GPOINTER_TO_UINT (g_hash_table_lookup (dir_to_index, dir));
811 if (dir_index == 0) {
812 dir_index = w->line_number_dir_index;
813 w->line_number_dir_index ++;
814 copy = g_strdup (dir);
815 g_hash_table_insert (dir_to_index, copy, GUINT_TO_POINTER (dir_index + 1));
816 g_hash_table_insert (index_to_dir, GUINT_TO_POINTER (dir_index + 1), copy);
825 /* Line number info header */
826 emit_section_change (w, ".debug_line", 0);
827 emit_label (w, ".Ldebug_line_section_start");
828 emit_label (w, ".Ldebug_line_start");
829 emit_symbol_diff (w, ".Ldebug_line_end", ".", -4); /* length */
830 emit_int16 (w, 0x2); /* version */
831 emit_symbol_diff (w, ".Ldebug_line_header_end", ".", -4); /* header_length */
832 emit_byte (w, 1); /* minimum_instruction_length */
833 emit_byte (w, 1); /* default_is_stmt */
834 emit_byte (w, LINE_BASE); /* line_base */
835 emit_byte (w, LINE_RANGE); /* line_range */
836 emit_byte (w, OPCODE_BASE); /* opcode_base */
837 emit_byte (w, 0); /* standard_opcode_lengths */
851 emit_section_change (w, ".debug_line", 0);
852 for (i = 0; i < w->line_number_dir_index; ++i) {
853 char *dir = g_hash_table_lookup (index_to_dir, GUINT_TO_POINTER (i + 1));
855 emit_string (w, mono_dwarf_escape_path (dir));
857 /* End of Includes */
861 for (i = 0; i < w->line_number_file_index; ++i) {
862 char *name = g_hash_table_lookup (w->index_to_file, GUINT_TO_POINTER (i + 1));
863 char *basename = NULL, *dir;
866 if (g_path_is_absolute (name)) {
867 dir = g_path_get_dirname (name);
869 dir_index = GPOINTER_TO_UINT (g_hash_table_lookup (dir_to_index, dir));
870 basename = g_path_get_basename (name);
874 emit_string (w, basename);
876 emit_string (w, mono_dwarf_escape_path (name));
877 emit_uleb128 (w, dir_index);
885 emit_label (w, ".Ldebug_line_header_end");
887 /* Emit line number table */
888 for (l = info_list; l; l = l->next) {
889 MethodLineNumberInfo *info = l->data;
890 MonoDebugMethodJitInfo *dmji;
892 dmji = mono_debug_find_method (info->method, mono_domain_get ());;
893 emit_line_number_info (w, info->method, info->start_symbol, info->end_symbol, info->code, info->code_size, dmji);
894 mono_debug_free_method_jit_info (dmji);
896 g_slist_free (info_list);
900 emit_byte (w, DW_LNE_end_sequence);
902 emit_label (w, ".Ldebug_line_end");
906 * Some assemblers like apple's do not support subsections, so we can't place
907 * .Ldebug_info_end at the end of the section using subsections. Instead, we
908 * define it every time something gets added to the .debug_info section.
909 * The apple assember seems to use the last definition.
912 emit_debug_info_end (MonoDwarfWriter *w)
914 /* This doesn't seem to work/required with recent iphone sdk versions */
916 if (!img_writer_subsections_supported (w->w))
917 fprintf (w->fp, "\n.set %sdebug_info_end,.\n", w->temp_prefix);
922 mono_dwarf_writer_emit_base_info (MonoDwarfWriter *w, GSList *base_unwind_program)
924 char *s, *build_info;
927 w->cie_program = base_unwind_program;
929 emit_section_change (w, ".debug_abbrev", 0);
930 emit_dwarf_abbrev (w, ABBREV_COMPILE_UNIT, DW_TAG_compile_unit, TRUE,
931 compile_unit_attr, G_N_ELEMENTS (compile_unit_attr));
932 emit_dwarf_abbrev (w, ABBREV_SUBPROGRAM, DW_TAG_subprogram, TRUE,
933 subprogram_attr, G_N_ELEMENTS (subprogram_attr));
934 emit_dwarf_abbrev (w, ABBREV_PARAM, DW_TAG_formal_parameter, FALSE,
935 param_attr, G_N_ELEMENTS (param_attr));
936 emit_dwarf_abbrev (w, ABBREV_PARAM_LOCLIST, DW_TAG_formal_parameter, FALSE,
937 param_loclist_attr, G_N_ELEMENTS (param_loclist_attr));
938 emit_dwarf_abbrev (w, ABBREV_BASE_TYPE, DW_TAG_base_type, FALSE,
939 base_type_attr, G_N_ELEMENTS (base_type_attr));
940 emit_dwarf_abbrev (w, ABBREV_STRUCT_TYPE, DW_TAG_class_type, TRUE,
941 struct_type_attr, G_N_ELEMENTS (struct_type_attr));
942 emit_dwarf_abbrev (w, ABBREV_STRUCT_TYPE_NOCHILDREN, DW_TAG_class_type, FALSE,
943 struct_type_attr, G_N_ELEMENTS (struct_type_attr));
944 emit_dwarf_abbrev (w, ABBREV_DATA_MEMBER, DW_TAG_member, FALSE,
945 data_member_attr, G_N_ELEMENTS (data_member_attr));
946 emit_dwarf_abbrev (w, ABBREV_TYPEDEF, DW_TAG_typedef, FALSE,
947 typedef_attr, G_N_ELEMENTS (typedef_attr));
948 emit_dwarf_abbrev (w, ABBREV_ENUM_TYPE, DW_TAG_enumeration_type, TRUE,
949 enum_type_attr, G_N_ELEMENTS (enum_type_attr));
950 emit_dwarf_abbrev (w, ABBREV_ENUMERATOR, DW_TAG_enumerator, FALSE,
951 enumerator_attr, G_N_ELEMENTS (enumerator_attr));
952 emit_dwarf_abbrev (w, ABBREV_NAMESPACE, DW_TAG_namespace, TRUE,
953 namespace_attr, G_N_ELEMENTS (namespace_attr));
954 emit_dwarf_abbrev (w, ABBREV_VARIABLE, DW_TAG_variable, FALSE,
955 variable_attr, G_N_ELEMENTS (variable_attr));
956 emit_dwarf_abbrev (w, ABBREV_VARIABLE_LOCLIST, DW_TAG_variable, FALSE,
957 variable_loclist_attr, G_N_ELEMENTS (variable_loclist_attr));
958 emit_dwarf_abbrev (w, ABBREV_POINTER_TYPE, DW_TAG_pointer_type, FALSE,
959 pointer_type_attr, G_N_ELEMENTS (pointer_type_attr));
960 emit_dwarf_abbrev (w, ABBREV_REFERENCE_TYPE, DW_TAG_reference_type, FALSE,
961 reference_type_attr, G_N_ELEMENTS (reference_type_attr));
962 emit_dwarf_abbrev (w, ABBREV_INHERITANCE, DW_TAG_inheritance, FALSE,
963 inheritance_attr, G_N_ELEMENTS (inheritance_attr));
964 emit_dwarf_abbrev (w, ABBREV_TRAMP_SUBPROGRAM, DW_TAG_subprogram, FALSE,
965 tramp_subprogram_attr, G_N_ELEMENTS (tramp_subprogram_attr));
968 emit_section_change (w, ".debug_info", 0);
969 emit_label (w, ".Ldebug_info_start");
970 emit_symbol_diff (w, ".Ldebug_info_end", ".Ldebug_info_begin", 0); /* length */
971 emit_label (w, ".Ldebug_info_begin");
972 emit_int16 (w, 0x2); /* DWARF version 2 */
973 emit_int32 (w, 0); /* .debug_abbrev offset */
974 emit_byte (w, sizeof (gpointer)); /* address size */
976 if (img_writer_subsections_supported (w->w) && w->appending) {
977 /* Emit this into a separate section so it gets placed at the end */
978 emit_section_change (w, ".debug_info", 1);
979 emit_byte (w, 0); /* close COMPILE_UNIT */
980 emit_label (w, ".Ldebug_info_end");
981 emit_section_change (w, ".debug_info", 0);
984 /* Compilation unit */
985 emit_uleb128 (w, ABBREV_COMPILE_UNIT);
986 build_info = mono_get_runtime_build_info ();
987 s = g_strdup_printf ("Mono AOT Compiler %s", build_info);
991 emit_string (w, "JITted code");
993 emit_byte (w, DW_LANG_C);
994 emit_pointer_value (w, 0);
995 emit_pointer_value (w, 0);
996 /* offset into .debug_line section */
997 emit_symbol_diff (w, ".Ldebug_line_start", ".Ldebug_line_section_start", 0);
1000 for (i = 0; i < G_N_ELEMENTS (basic_types); ++i) {
1001 emit_label (w, basic_types [i].die_name);
1002 emit_uleb128 (w, ABBREV_BASE_TYPE);
1003 emit_byte (w, basic_types [i].size);
1004 emit_byte (w, basic_types [i].encoding);
1005 emit_string (w, basic_types [i].name);
1008 emit_debug_info_end (w);
1010 /* debug_loc section */
1011 emit_section_change (w, ".debug_loc", 0);
1012 emit_label (w, ".Ldebug_loc_start");
1014 /* debug_line section */
1016 * We emit some info even if emit_line is FALSE, as the
1017 * apple linker seems to require a .debug_line section.
1019 if (!w->collect_line_info)
1020 emit_line_number_info_begin (w);
1026 * mono_dwarf_writer_close:
1028 * Finalize the emitted debugging info.
1031 mono_dwarf_writer_close (MonoDwarfWriter *w)
1033 if (!w->appending) {
1034 emit_section_change (w, ".debug_info", 0);
1035 emit_byte (w, 0); /* close COMPILE_UNIT */
1036 emit_label (w, ".Ldebug_info_end");
1039 if (w->collect_line_info)
1040 emit_all_line_number_info (w);
1043 static void emit_type (MonoDwarfWriter *w, MonoType *t);
1044 static const char* get_type_die (MonoDwarfWriter *w, MonoType *t);
1047 get_class_die (MonoDwarfWriter *w, MonoClass *klass, gboolean vtype)
1052 cache = w->class_to_vtype_die;
1054 cache = w->class_to_die;
1056 return g_hash_table_lookup (cache, klass);
1059 /* Returns the local symbol pointing to the emitted debug info */
1061 emit_class_dwarf_info (MonoDwarfWriter *w, MonoClass *klass, gboolean vtype)
1063 char *die, *pointer_die, *reference_die;
1064 char *full_name, *p;
1066 MonoClassField *field;
1069 gboolean emit_namespace = FALSE, has_children;
1073 cache = w->class_to_vtype_die;
1075 cache = w->class_to_die;
1077 die = g_hash_table_lookup (cache, klass);
1081 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) ||
1082 (klass->byval_arg.type >= MONO_TYPE_BOOLEAN && klass->byval_arg.type <= MONO_TYPE_R8 && !vtype)))
1086 * FIXME: gdb can't handle namespaces in languages it doesn't know about.
1089 if (klass->name_space && klass->name_space [0] != '\0')
1090 emit_namespace = TRUE;
1092 if (emit_namespace) {
1093 emit_uleb128 (w, ABBREV_NAMESPACE);
1094 emit_string (w, klass->name_space);
1097 full_name = g_strdup_printf ("%s%s%s", klass->name_space, klass->name_space ? "." : "", klass->name);
1099 * gdb doesn't support namespaces for non-C++ dwarf objects, so use _
1100 * to separate components.
1102 for (p = full_name; *p; p ++)
1106 die = g_strdup_printf (".LTDIE_%d", w->tdie_index);
1107 pointer_die = g_strdup_printf (".LTDIE_%d_POINTER", w->tdie_index);
1108 reference_die = g_strdup_printf (".LTDIE_%d_REFERENCE", w->tdie_index);
1111 g_hash_table_insert (w->class_to_pointer_die, klass, pointer_die);
1112 g_hash_table_insert (w->class_to_reference_die, klass, reference_die);
1113 g_hash_table_insert (cache, klass, die);
1115 if (klass->enumtype) {
1116 int size = mono_class_value_size (mono_class_from_mono_type (mono_class_enum_basetype (klass)), NULL);
1118 emit_label (w, die);
1120 emit_uleb128 (w, ABBREV_ENUM_TYPE);
1121 emit_string (w, full_name);
1122 emit_uleb128 (w, size);
1123 for (k = 0; k < G_N_ELEMENTS (basic_types); ++k)
1124 if (basic_types [k].type == mono_class_enum_basetype (klass)->type)
1126 g_assert (k < G_N_ELEMENTS (basic_types));
1127 emit_symbol_diff (w, basic_types [k].die_name, ".Ldebug_info_start", 0);
1129 /* Emit enum values */
1131 while ((field = mono_class_get_fields (klass, &iter))) {
1134 MonoTypeEnum def_type;
1136 if (strcmp ("value__", mono_field_get_name (field)) == 0)
1138 if (mono_field_is_deleted (field))
1141 emit_uleb128 (w, ABBREV_ENUMERATOR);
1142 emit_string (w, mono_field_get_name (field));
1144 p = mono_class_get_field_default_value (field, &def_type);
1145 len = mono_metadata_decode_blob_size (p, &p);
1146 switch (mono_class_enum_basetype (klass)->type) {
1149 case MONO_TYPE_BOOLEAN:
1150 emit_sleb128 (w, *p);
1154 case MONO_TYPE_CHAR:
1155 emit_sleb128 (w, read16 (p));
1159 emit_sleb128 (w, read32 (p));
1163 emit_sleb128 (w, read64 (p));
1167 #if SIZEOF_VOID_P == 8
1168 emit_sleb128 (w, read64 (p));
1170 emit_sleb128 (w, read32 (p));
1174 g_assert_not_reached ();
1178 has_children = TRUE;
1185 parent_die = emit_class_dwarf_info (w, klass->parent, FALSE);
1189 /* Emit field types */
1191 while ((field = mono_class_get_fields (klass, &iter))) {
1192 if (field->type->attrs & FIELD_ATTRIBUTE_STATIC)
1195 emit_type (w, field->type);
1199 has_children = parent_die || mono_class_get_fields (klass, &iter);
1201 emit_label (w, die);
1203 emit_uleb128 (w, has_children ? ABBREV_STRUCT_TYPE : ABBREV_STRUCT_TYPE_NOCHILDREN);
1204 emit_string (w, full_name);
1205 emit_uleb128 (w, klass->instance_size);
1208 emit_uleb128 (w, ABBREV_INHERITANCE);
1209 emit_symbol_diff (w, parent_die, ".Ldebug_info_start", 0);
1212 *p ++= DW_OP_plus_uconst;
1213 encode_uleb128 (0, p, &p);
1214 emit_byte (w, p - buf);
1215 emit_bytes (w, buf, p - buf);
1220 while ((field = mono_class_get_fields (klass, &iter))) {
1221 if (field->type->attrs & FIELD_ATTRIBUTE_STATIC)
1224 fdie = get_type_die (w, field->type);
1226 emit_uleb128 (w, ABBREV_DATA_MEMBER);
1227 emit_string (w, field->name);
1228 emit_symbol_diff (w, fdie, ".Ldebug_info_start", 0);
1231 *p ++= DW_OP_plus_uconst;
1232 if (klass->valuetype && vtype)
1233 encode_uleb128 (field->offset - sizeof (MonoObject), p, &p);
1235 encode_uleb128 (field->offset, p, &p);
1237 emit_byte (w, p - buf);
1238 emit_bytes (w, buf, p - buf);
1245 emit_uleb128 (w, 0x0);
1247 /* Add a typedef, so we can reference the type without a 'struct' in gdb */
1248 emit_uleb128 (w, ABBREV_TYPEDEF);
1249 emit_string (w, full_name);
1250 emit_symbol_diff (w, die, ".Ldebug_info_start", 0);
1252 /* Add a pointer type */
1253 emit_label (w, pointer_die);
1255 emit_uleb128 (w, ABBREV_POINTER_TYPE);
1256 emit_symbol_diff (w, die, ".Ldebug_info_start", 0);
1258 /* Add a reference type */
1259 emit_label (w, reference_die);
1261 emit_uleb128 (w, ABBREV_REFERENCE_TYPE);
1262 emit_symbol_diff (w, die, ".Ldebug_info_start", 0);
1266 if (emit_namespace) {
1268 emit_uleb128 (w, 0x0);
1274 static gboolean base_types_emitted [64];
1277 get_type_die (MonoDwarfWriter *w, MonoType *t)
1279 MonoClass *klass = mono_class_from_mono_type (t);
1284 if (t->type == MONO_TYPE_VALUETYPE) {
1285 tdie = g_hash_table_lookup (w->class_to_pointer_die, klass);
1288 tdie = get_class_die (w, klass, FALSE);
1289 /* Should return a pointer type to a reference */
1292 t = &mono_defaults.int_class->byval_arg;
1294 for (j = 0; j < G_N_ELEMENTS (basic_types); ++j)
1295 if (basic_types [j].type == t->type)
1297 if (j < G_N_ELEMENTS (basic_types)) {
1298 tdie = basic_types [j].die_name;
1301 case MONO_TYPE_CLASS:
1302 tdie = g_hash_table_lookup (w->class_to_reference_die, klass);
1303 //tdie = ".LDIE_OBJECT";
1305 case MONO_TYPE_ARRAY:
1306 tdie = ".LDIE_OBJECT";
1308 case MONO_TYPE_VALUETYPE:
1309 if (klass->enumtype)
1310 tdie = get_class_die (w, klass, FALSE);
1314 case MONO_TYPE_GENERICINST:
1315 if (!MONO_TYPE_ISSTRUCT (t)) {
1316 tdie = g_hash_table_lookup (w->class_to_reference_die, klass);
1336 emit_type (MonoDwarfWriter *w, MonoType *t)
1338 MonoClass *klass = mono_class_from_mono_type (t);
1343 if (t->type == MONO_TYPE_VALUETYPE) {
1344 tdie = emit_class_dwarf_info (w, klass, TRUE);
1349 emit_class_dwarf_info (w, klass, FALSE);
1352 t = &mono_defaults.int_class->byval_arg;
1354 for (j = 0; j < G_N_ELEMENTS (basic_types); ++j)
1355 if (basic_types [j].type == t->type)
1357 if (j < G_N_ELEMENTS (basic_types)) {
1358 /* Emit a boxed version of base types */
1359 if (j < 64 && !base_types_emitted [j]) {
1360 emit_class_dwarf_info (w, klass, FALSE);
1361 base_types_emitted [j] = TRUE;
1365 case MONO_TYPE_CLASS:
1366 emit_class_dwarf_info (w, klass, FALSE);
1368 case MONO_TYPE_ARRAY:
1370 case MONO_TYPE_VALUETYPE:
1371 if (klass->enumtype)
1372 emit_class_dwarf_info (w, klass, FALSE);
1374 case MONO_TYPE_GENERICINST:
1375 if (!MONO_TYPE_ISSTRUCT (t))
1376 emit_class_dwarf_info (w, klass, FALSE);
1387 emit_var_type (MonoDwarfWriter *w, MonoType *t)
1391 tdie = get_type_die (w, t);
1393 emit_symbol_diff (w, tdie, ".Ldebug_info_start", 0);
1397 encode_var_location (MonoDwarfWriter *w, MonoInst *ins, guint8 *p, guint8 **endp)
1400 /* FIXME: This needs a location list, since the args can go from reg->stack */
1401 if (!ins || ins->flags & MONO_INST_IS_DEAD) {
1402 /* gdb treats this as optimized out */
1403 } else if (ins->opcode == OP_REGVAR) {
1404 *p = DW_OP_reg0 + mono_hw_reg_to_dwarf_reg (ins->dreg);
1406 } else if (ins->opcode == OP_REGOFFSET) {
1407 *p ++= DW_OP_breg0 + mono_hw_reg_to_dwarf_reg (ins->inst_basereg);
1408 encode_sleb128 (ins->inst_offset, p, &p);
1418 emit_loclist (MonoDwarfWriter *w, MonoInst *ins,
1419 guint8 *loclist_begin_addr, guint8 *loclist_end_addr,
1420 guint8 *expr, guint32 expr_len)
1424 emit_push_section (w, ".debug_loc", 0);
1425 sprintf (label, ".Lloclist_%d", w->loclist_index ++ );
1426 emit_label (w, label);
1428 emit_pointer_value (w, loclist_begin_addr);
1429 emit_pointer_value (w, loclist_end_addr);
1430 emit_byte (w, expr_len % 256);
1431 emit_byte (w, expr_len / 256);
1432 emit_bytes (w, expr, expr_len);
1434 emit_pointer_value (w, NULL);
1435 emit_pointer_value (w, NULL);
1437 emit_pop_section (w);
1438 emit_symbol_diff (w, label, ".Ldebug_loc_start", 0);
1442 * MonoDisHelper->tokener doesn't take an IP argument, and we can't add one since
1443 * it is a public header.
1445 static const guint8 *token_handler_ip;
1448 token_handler (MonoDisHelper *dh, MonoMethod *method, guint32 token)
1451 MonoMethod *cmethod;
1453 MonoClassField *field;
1454 gpointer data = NULL;
1456 if (method->wrapper_type)
1457 data = mono_method_get_wrapper_data (method, token);
1459 switch (*token_handler_ip) {
1463 if (method->wrapper_type)
1466 klass = mono_class_get_full (method->klass->image, token, NULL);
1467 res = g_strdup_printf ("<%s>", klass->name);
1472 if (method->wrapper_type)
1475 cmethod = mono_get_method_full (method->klass->image, token, NULL, NULL);
1476 desc = mono_method_full_name (cmethod, TRUE);
1477 res = g_strdup_printf ("<%s>", desc);
1481 if (method->wrapper_type) {
1482 desc = mono_signature_get_desc (data, FALSE);
1483 res = g_strdup_printf ("<%s>", desc);
1486 res = g_strdup_printf ("<0x%08x>", token);
1493 if (method->wrapper_type)
1496 field = mono_field_from_token (method->klass->image, token, &klass, NULL);
1497 desc = mono_field_full_name (field);
1498 res = g_strdup_printf ("<%s>", desc);
1502 res = g_strdup_printf ("<0x%08x>", token);
1512 * Produce a disassembled form of the IL instruction at IP. This is an extension
1513 * of mono_disasm_code_one () which can disasm tokens, handle wrapper methods, and
1514 * CEE_MONO_ opcodes.
1517 disasm_ins (MonoMethod *method, const guchar *ip, const guint8 **endip)
1521 MonoMethodHeader *header = mono_method_get_header (method);
1523 memset (&dh, 0, sizeof (dh));
1525 dh.label_format = "IL_%04x: ";
1526 dh.label_target = "IL_%04x";
1527 dh.tokener = token_handler;
1529 token_handler_ip = ip;
1530 if (*ip == MONO_CUSTOM_PREFIX) {
1535 case CEE_MONO_ICALL: {
1536 MonoJitICallInfo *info;
1538 token = read32 (ip + 2);
1539 data = mono_method_get_wrapper_data (method, token);
1540 info = mono_find_jit_icall_by_addr (data);
1543 dis = g_strdup_printf ("IL_%04x: mono_icall <%s>", (int)(ip - header->code), info->name);
1547 case CEE_MONO_CLASSCONST: {
1548 token = read32 (ip + 2);
1549 data = mono_method_get_wrapper_data (method, token);
1551 dis = g_strdup_printf ("IL_%04x: mono_classconst <%s>", (int)(ip - header->code), ((MonoClass*)data)->name);
1556 dis = mono_disasm_code_one (&dh, method, ip, &ip);
1559 dis = mono_disasm_code_one (&dh, method, ip, &ip);
1561 token_handler_ip = NULL;
1564 mono_metadata_free_mh (header);
1569 il_offset_from_address (MonoMethod *method, MonoDebugMethodJitInfo *jit,
1570 guint32 native_offset)
1574 if (!jit->line_numbers)
1577 for (i = jit->num_line_numbers - 1; i >= 0; i--) {
1578 MonoDebugLineNumberEntry lne = jit->line_numbers [i];
1580 if (lne.native_offset <= native_offset)
1581 return lne.il_offset;
1587 static int max_special_addr_diff = 0;
1590 emit_advance_op (MonoDwarfWriter *w, int line_diff, int addr_diff)
1594 /* Use a special opcode if possible */
1595 if (line_diff - LINE_BASE >= 0 && line_diff - LINE_BASE < LINE_RANGE) {
1596 if (max_special_addr_diff == 0)
1597 max_special_addr_diff = (255 - OPCODE_BASE) / LINE_RANGE;
1599 if (addr_diff > max_special_addr_diff && (addr_diff < 2 * max_special_addr_diff)) {
1600 emit_byte (w, DW_LNS_const_add_pc);
1601 addr_diff -= max_special_addr_diff;
1604 opcode = (line_diff - LINE_BASE) + (LINE_RANGE * addr_diff) + OPCODE_BASE;
1610 emit_byte (w, opcode);
1612 //printf ("large: %d %d %d\n", line_diff, addr_diff, max_special_addr_diff);
1613 emit_byte (w, DW_LNS_advance_line);
1614 emit_sleb128 (w, line_diff);
1615 emit_byte (w, DW_LNS_advance_pc);
1616 emit_sleb128 (w, addr_diff);
1617 emit_byte (w, DW_LNS_copy);
1622 compare_lne (MonoDebugLineNumberEntry *a, MonoDebugLineNumberEntry *b)
1624 if (a->native_offset == b->native_offset)
1625 return a->il_offset - b->il_offset;
1627 return a->native_offset - b->native_offset;
1631 emit_line_number_info (MonoDwarfWriter *w, MonoMethod *method,
1632 char *start_symbol, char *end_symbol,
1633 guint8 *code, guint32 code_size,
1634 MonoDebugMethodJitInfo *debug_info)
1636 guint32 prev_line = 0;
1637 guint32 prev_native_offset = 0;
1638 int i, file_index, il_offset, prev_il_offset;
1639 gboolean first = TRUE;
1640 MonoDebugSourceLocation *loc;
1641 char *prev_file_name = NULL;
1642 MonoMethodHeader *header = mono_method_get_header (method);
1643 MonoDebugMethodInfo *minfo;
1644 MonoDebugLineNumberEntry *ln_array;
1645 int *native_to_il_offset = NULL;
1647 if (!w->emit_line) {
1648 mono_metadata_free_mh (header);
1652 minfo = mono_debug_lookup_method (method);
1654 /* Compute the native->IL offset mapping */
1656 g_assert (code_size);
1658 ln_array = g_new0 (MonoDebugLineNumberEntry, debug_info->num_line_numbers);
1659 memcpy (ln_array, debug_info->line_numbers, debug_info->num_line_numbers * sizeof (MonoDebugLineNumberEntry));
1661 qsort (ln_array, debug_info->num_line_numbers, sizeof (MonoDebugLineNumberEntry), (gpointer)compare_lne);
1663 native_to_il_offset = g_new0 (int, code_size + 1);
1665 for (i = 0; i < debug_info->num_line_numbers; ++i) {
1667 MonoDebugLineNumberEntry *lne = &ln_array [i];
1670 for (j = 0; j < lne->native_offset; ++j)
1671 native_to_il_offset [j] = -1;
1674 if (i < debug_info->num_line_numbers - 1) {
1675 MonoDebugLineNumberEntry *lne_next = &ln_array [i + 1];
1677 for (j = lne->native_offset; j < lne_next->native_offset; ++j)
1678 native_to_il_offset [j] = lne->il_offset;
1680 for (j = lne->native_offset; j < code_size; ++j)
1681 native_to_il_offset [j] = lne->il_offset;
1687 prev_il_offset = -1;
1689 for (i = 0; i < code_size; ++i) {
1690 int line_diff, addr_diff;
1695 if (!debug_info->line_numbers)
1698 if (native_to_il_offset)
1699 il_offset = native_to_il_offset [i];
1701 il_offset = il_offset_from_address (method, debug_info, i);
1703 il_offset = il_offset_from_address (method, debug_info, i);
1705 g_assert (il_offset == native_to_il_offset [i]);
1708 il_offset = native_to_il_offset [i];
1712 if (il_offset == prev_il_offset)
1715 prev_il_offset = il_offset;
1717 loc = mono_debug_symfile_lookup_location (minfo, il_offset);
1718 if (!(loc && loc->source_file))
1721 line_diff = (gint32)loc->row - (gint32)prev_line;
1722 addr_diff = i - prev_native_offset;
1725 emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
1728 emit_byte (w, sizeof (gpointer) + 1);
1729 emit_byte (w, DW_LNE_set_address);
1731 emit_pointer_unaligned (w, start_symbol);
1733 emit_pointer_value (w, code);
1736 * The prolog+initlocals region does not have a line number, this
1737 * makes them belong to the first line of the method.
1739 emit_byte (w, DW_LNS_advance_line);
1740 //printf ("FIRST: %d %d %d\n", prev_line, loc->row, il_offset);
1741 emit_sleb128 (w, (gint32)loc->row - (gint32)prev_line);
1742 prev_line = loc->row;
1743 prev_native_offset = i;
1747 if (loc->row != prev_line) {
1748 if (!prev_file_name || strcmp (loc->source_file, prev_file_name) != 0) {
1749 /* Add an entry to the file table */
1750 /* FIXME: Avoid duplicates */
1751 if (w->collect_line_info)
1752 file_index = get_line_number_file_name (w, loc->source_file) + 1;
1754 file_index = emit_line_number_file_name (w, loc->source_file, 0, 0);
1755 g_free (prev_file_name);
1756 prev_file_name = g_strdup (loc->source_file);
1758 if (w->cur_file_index != file_index) {
1759 emit_byte (w, DW_LNS_set_file);
1760 emit_uleb128 (w, file_index);
1761 emit_byte (w, DW_LNS_copy);
1762 w->cur_file_index = file_index;
1765 //printf ("X: %p(+0x%x) %d %s:%d(+%d)\n", code + i, addr_diff, loc->il_offset, loc->source_file, loc->row, line_diff);
1766 emit_advance_op (w, line_diff, addr_diff);
1768 prev_line = loc->row;
1769 prev_native_offset = i;
1772 mono_debug_symfile_free_location (loc);
1775 g_free (native_to_il_offset);
1776 g_free (prev_file_name);
1779 emit_byte (w, DW_LNS_advance_pc);
1780 emit_sleb128 (w, code_size - prev_native_offset);
1781 emit_byte (w, DW_LNS_copy);
1785 emit_byte (w, DW_LNE_end_sequence);
1786 } else if (!start_symbol) {
1787 /* No debug info, XDEBUG mode */
1789 const guint8 *ip = header->code;
1790 int prev_line, prev_native_offset;
1794 * Emit the IL code into a temporary file and emit line number info
1795 * referencing that file.
1798 name = mono_method_full_name (method, TRUE);
1799 fprintf (w->il_file, "// %s\n", name);
1800 w->il_file_line_index ++;
1803 il_to_line = g_new0 (int, header->code_size);
1805 emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
1807 emit_byte (w, sizeof (gpointer) + 1);
1808 emit_byte (w, DW_LNE_set_address);
1809 emit_pointer_value (w, code);
1811 // FIXME: Optimize this
1812 while (ip < header->code + header->code_size) {
1813 int il_offset = ip - header->code;
1816 w->il_file_line_index ++;
1818 dis = disasm_ins (method, ip, &ip);
1819 fprintf (w->il_file, "%s\n", dis);
1822 il_to_line [il_offset] = w->il_file_line_index;
1825 /* Emit line number info */
1827 prev_native_offset = 0;
1828 for (i = 0; i < debug_info->num_line_numbers; ++i) {
1829 MonoDebugLineNumberEntry *lne = &debug_info->line_numbers [i];
1832 if (lne->il_offset >= header->code_size)
1834 line = il_to_line [lne->il_offset];
1837 * This seems to happen randomly, it looks like il_offset points
1838 * into the middle of an instruction.
1842 printf ("%s\n", mono_method_full_name (method, TRUE));
1843 printf ("%d %d\n", lne->il_offset, header->code_size);
1848 if (line - prev_line != 0) {
1849 emit_advance_op (w, line - prev_line, (gint32)lne->native_offset - prev_native_offset);
1852 prev_native_offset = lne->native_offset;
1856 emit_byte (w, DW_LNS_advance_pc);
1857 emit_sleb128 (w, code_size - prev_native_offset);
1858 emit_byte (w, DW_LNS_copy);
1862 emit_byte (w, DW_LNE_end_sequence);
1864 fflush (w->il_file);
1865 g_free (il_to_line);
1867 mono_metadata_free_mh (header);
1870 static MonoMethodVar*
1871 find_vmv (MonoCompile *cfg, MonoInst *ins)
1876 for (j = 0; j < cfg->num_varinfo; ++j) {
1877 if (cfg->varinfo [j] == ins)
1881 if (j < cfg->num_varinfo) {
1882 return MONO_VARINFO (cfg, j);
1890 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)
1893 MonoMethodSignature *sig;
1894 MonoMethodHeader *header;
1896 MonoDebugLocalsInfo *locals_info;
1901 emit_section_change (w, ".debug_info", 0);
1903 sig = mono_method_signature (method);
1904 header = mono_method_get_header (method);
1906 /* Parameter types */
1907 for (i = 0; i < sig->param_count + sig->hasthis; ++i) {
1910 if (i == 0 && sig->hasthis) {
1911 if (method->klass->valuetype)
1912 t = &method->klass->this_arg;
1914 t = &method->klass->byval_arg;
1916 t = sig->params [i - sig->hasthis];
1921 //emit_type (w, &mono_defaults.int32_class->byval_arg);
1924 for (i = 0; i < header->num_locals; ++i) {
1925 emit_type (w, header->locals [i]);
1929 names = g_new0 (char *, sig->param_count);
1930 mono_method_get_param_names (method, (const char **) names);
1932 emit_uleb128 (w, ABBREV_SUBPROGRAM);
1933 name = mono_method_full_name (method, FALSE);
1934 emit_string (w, name);
1936 emit_string (w, name);
1940 emit_pointer_unaligned (w, start_symbol);
1941 emit_pointer_unaligned (w, end_symbol);
1943 emit_pointer_value (w, code);
1944 emit_pointer_value (w, code + code_size);
1948 emit_byte (w, DW_OP_breg6);
1952 for (i = 0; i < sig->param_count + sig->hasthis; ++i) {
1953 MonoInst *arg = args ? args [i] : NULL;
1956 char pname_buf [128];
1957 MonoMethodVar *vmv = NULL;
1958 gboolean need_loclist = FALSE;
1960 vmv = find_vmv (cfg, arg);
1961 if (code && vmv && (vmv->live_range_start || vmv->live_range_end))
1962 need_loclist = TRUE;
1964 if (i == 0 && sig->hasthis) {
1965 if (method->klass->valuetype)
1966 t = &method->klass->this_arg;
1968 t = &method->klass->byval_arg;
1971 t = sig->params [i - sig->hasthis];
1972 pname = names [i - sig->hasthis];
1975 emit_uleb128 (w, need_loclist ? ABBREV_PARAM_LOCLIST : ABBREV_PARAM);
1977 if (pname[0] == '\0') {
1978 sprintf (pname_buf, "param%d", i - sig->hasthis);
1981 emit_string (w, pname);
1983 if (!arg || arg->flags & MONO_INST_IS_DEAD)
1984 emit_var_type (w, &mono_defaults.int32_class->byval_arg);
1986 emit_var_type (w, t);
1989 encode_var_location (w, arg, p, &p);
1991 vmv->live_range_start = 0;
1992 if (vmv->live_range_end == 0)
1993 /* FIXME: Uses made in calls are not recorded */
1994 vmv->live_range_end = code_size;
1995 emit_loclist (w, arg, code + vmv->live_range_start, code + vmv->live_range_end, buf, p - buf);
1997 emit_byte (w, p - buf);
1998 emit_bytes (w, buf, p - buf);
2004 locals_info = mono_debug_lookup_locals (method);
2006 for (i = 0; i < header->num_locals; ++i) {
2007 MonoInst *ins = locals [i];
2008 char name_buf [128];
2010 MonoMethodVar *vmv = NULL;
2011 gboolean need_loclist = FALSE;
2014 /* ins->dreg no longer contains the original vreg */
2015 vmv = find_vmv (cfg, ins);
2017 if (vmv->live_range_start) {
2018 /* This variable has a precise live range */
2019 need_loclist = TRUE;
2023 emit_uleb128 (w, need_loclist ? ABBREV_VARIABLE_LOCLIST : ABBREV_VARIABLE);
2027 for (j = 0; j < locals_info->num_locals; ++j)
2028 if (locals_info->locals [j].index == i)
2030 if (j < locals_info->num_locals)
2031 lname = locals_info->locals [j].name;
2034 emit_string (w, lname);
2036 sprintf (name_buf, "V_%d", i);
2037 emit_string (w, name_buf);
2040 if (!ins || ins->flags & MONO_INST_IS_DEAD)
2041 emit_var_type (w, &mono_defaults.int32_class->byval_arg);
2043 emit_var_type (w, header->locals [i]);
2046 encode_var_location (w, ins, p, &p);
2049 if (vmv->live_range_end == 0)
2050 /* FIXME: Uses made in calls are not recorded */
2051 vmv->live_range_end = code_size;
2052 emit_loclist (w, ins, code + vmv->live_range_start, code + vmv->live_range_end, buf, p - buf);
2054 emit_byte (w, p - buf);
2055 emit_bytes (w, buf, p - buf);
2060 mono_debug_symfile_free_locals (locals_info);
2062 /* Subprogram end */
2063 emit_uleb128 (w, 0x0);
2067 emit_debug_info_end (w);
2069 /* Emit unwind info */
2071 emit_fde (w, w->fde_index, start_symbol, end_symbol, code, code_size, unwind_info, TRUE);
2075 /* Emit line number info */
2076 /* != could happen when using --regression */
2077 if (debug_info && (debug_info->code_start == code)) {
2078 if (w->collect_line_info) {
2079 MethodLineNumberInfo *info;
2081 /* Save the information needed to emit the line number info later at once */
2082 info = g_new0 (MethodLineNumberInfo, 1);
2083 info->method = method;
2084 info->start_symbol = g_strdup (start_symbol);
2085 info->end_symbol = g_strdup (end_symbol);
2087 info->code_size = code_size;
2088 w->line_info = g_slist_prepend (w->line_info, info);
2090 emit_line_number_info (w, method, start_symbol, end_symbol, code, code_size, debug_info);
2095 mono_metadata_free_mh (header);
2099 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)
2101 emit_section_change (w, ".debug_info", 0);
2104 emit_uleb128 (w, ABBREV_TRAMP_SUBPROGRAM);
2105 emit_string (w, tramp_name);
2106 emit_pointer_value (w, code);
2107 emit_pointer_value (w, code + code_size);
2109 /* Subprogram end */
2110 emit_uleb128 (w, 0x0);
2112 emit_debug_info_end (w);
2114 /* Emit unwind info */
2115 emit_fde (w, w->fde_index, start_symbol, end_symbol, code, code_size, unwind_info, FALSE);
2118 #endif /* End of: !defined(DISABLE_AOT) && !defined(DISABLE_JIT) */