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,
468 DW_AT_low_pc , DW_FORM_addr,
469 DW_AT_high_pc , DW_FORM_addr,
472 static int param_attr [] = {
473 DW_AT_name, DW_FORM_string,
474 DW_AT_type, DW_FORM_ref4,
475 DW_AT_location, DW_FORM_block1
478 static int param_loclist_attr [] = {
479 DW_AT_name, DW_FORM_string,
480 DW_AT_type, DW_FORM_ref4,
481 DW_AT_location, DW_FORM_data4
484 static int base_type_attr [] = {
485 DW_AT_byte_size, DW_FORM_data1,
486 DW_AT_encoding, DW_FORM_data1,
487 DW_AT_name, DW_FORM_string
490 static int struct_type_attr [] = {
491 DW_AT_name, DW_FORM_string,
492 DW_AT_byte_size, DW_FORM_udata,
495 static int data_member_attr [] = {
496 DW_AT_name, DW_FORM_string,
497 DW_AT_type, DW_FORM_ref4,
498 DW_AT_data_member_location, DW_FORM_block1
501 static int typedef_attr [] = {
502 DW_AT_name, DW_FORM_string,
503 DW_AT_type, DW_FORM_ref4
506 static int pointer_type_attr [] = {
507 DW_AT_type, DW_FORM_ref4,
510 static int reference_type_attr [] = {
511 DW_AT_type, DW_FORM_ref4,
514 static int enum_type_attr [] = {
515 DW_AT_name, DW_FORM_string,
516 DW_AT_byte_size, DW_FORM_udata,
517 DW_AT_type, DW_FORM_ref4,
520 static int enumerator_attr [] = {
521 DW_AT_name, DW_FORM_string,
522 DW_AT_const_value, DW_FORM_sdata,
525 static int namespace_attr [] = {
526 DW_AT_name, DW_FORM_string,
529 static int variable_attr [] = {
530 DW_AT_name, DW_FORM_string,
531 DW_AT_type, DW_FORM_ref4,
532 DW_AT_location, DW_FORM_block1
535 static int variable_loclist_attr [] = {
536 DW_AT_name, DW_FORM_string,
537 DW_AT_type, DW_FORM_ref4,
538 DW_AT_location, DW_FORM_data4
541 static int inheritance_attr [] = {
542 DW_AT_type, DW_FORM_ref4,
543 DW_AT_data_member_location, DW_FORM_block1
546 typedef struct DwarfBasicType {
547 const char *die_name, *name;
553 static DwarfBasicType basic_types [] = {
554 { ".LDIE_I1", "sbyte", MONO_TYPE_I1, 1, DW_ATE_signed },
555 { ".LDIE_U1", "byte", MONO_TYPE_U1, 1, DW_ATE_unsigned },
556 { ".LDIE_I2", "short", MONO_TYPE_I2, 2, DW_ATE_signed },
557 { ".LDIE_U2", "ushort", MONO_TYPE_U2, 2, DW_ATE_unsigned },
558 { ".LDIE_I4", "int", MONO_TYPE_I4, 4, DW_ATE_signed },
559 { ".LDIE_U4", "uint", MONO_TYPE_U4, 4, DW_ATE_unsigned },
560 { ".LDIE_I8", "long", MONO_TYPE_I8, 8, DW_ATE_signed },
561 { ".LDIE_U8", "ulong", MONO_TYPE_U8, 8, DW_ATE_unsigned },
562 { ".LDIE_I", "intptr", MONO_TYPE_I, SIZEOF_VOID_P, DW_ATE_signed },
563 { ".LDIE_U", "uintptr", MONO_TYPE_U, SIZEOF_VOID_P, DW_ATE_unsigned },
564 { ".LDIE_R4", "float", MONO_TYPE_R4, 4, DW_ATE_float },
565 { ".LDIE_R8", "double", MONO_TYPE_R8, 8, DW_ATE_float },
566 { ".LDIE_BOOLEAN", "boolean", MONO_TYPE_BOOLEAN, 1, DW_ATE_boolean },
567 { ".LDIE_CHAR", "char", MONO_TYPE_CHAR, 2, DW_ATE_unsigned_char },
568 { ".LDIE_STRING", "string", MONO_TYPE_STRING, sizeof (gpointer), DW_ATE_address },
569 { ".LDIE_OBJECT", "object", MONO_TYPE_OBJECT, sizeof (gpointer), DW_ATE_address },
570 { ".LDIE_SZARRAY", "object", MONO_TYPE_SZARRAY, sizeof (gpointer), DW_ATE_address },
573 /* Constants for encoding line number special opcodes */
574 #define OPCODE_BASE 13
576 #define LINE_RANGE 14
578 /* Subsections of the .debug_line section */
579 #define LINE_SUBSECTION_HEADER 1
580 #define LINE_SUBSECTION_INCLUDES 2
581 #define LINE_SUBSECTION_FILES 3
582 #define LINE_SUBSECTION_DATA 4
583 #define LINE_SUBSECTION_END 5
586 emit_line_number_file_name (MonoDwarfWriter *w, const char *name,
587 gint64 last_mod_time, gint64 file_size)
591 char *basename = NULL;
593 if (!w->file_to_index)
594 w->file_to_index = g_hash_table_new (g_str_hash, g_str_equal);
596 index = GPOINTER_TO_UINT (g_hash_table_lookup (w->file_to_index, name));
600 if (g_path_is_absolute (name)) {
601 char *dir = g_path_get_dirname (name);
603 if (!w->dir_to_index)
604 w->dir_to_index = g_hash_table_new (g_str_hash, g_str_equal);
606 dir_index = GPOINTER_TO_UINT (g_hash_table_lookup (w->dir_to_index, dir));
607 if (dir_index == 0) {
608 emit_section_change (w, ".debug_line", LINE_SUBSECTION_INCLUDES);
609 emit_string (w, dir);
611 dir_index = ++ w->line_number_dir_index;
612 g_hash_table_insert (w->dir_to_index, g_strdup (dir), GUINT_TO_POINTER (dir_index));
617 basename = g_path_get_basename (name);
622 emit_section_change (w, ".debug_line", LINE_SUBSECTION_FILES);
625 emit_string (w, basename);
627 emit_string (w, name);
628 emit_uleb128 (w, dir_index);
632 emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
637 index = ++ w->line_number_file_index;
638 g_hash_table_insert (w->file_to_index, g_strdup (name), GUINT_TO_POINTER (index));
644 get_line_number_file_name (MonoDwarfWriter *w, const char *name)
648 g_assert (w->file_to_index);
649 index = GPOINTER_TO_UINT (g_hash_table_lookup (w->file_to_index, name));
650 g_assert (index > 0);
655 add_line_number_file_name (MonoDwarfWriter *w, const char *name,
656 gint64 last_mod_time, gint64 file_size)
661 if (!w->file_to_index) {
662 w->file_to_index = g_hash_table_new (g_str_hash, g_str_equal);
663 w->index_to_file = g_hash_table_new (NULL, NULL);
666 index = GPOINTER_TO_UINT (g_hash_table_lookup (w->file_to_index, name));
669 index = w->line_number_file_index;
670 w->line_number_file_index ++;
671 copy = g_strdup (name);
672 g_hash_table_insert (w->file_to_index, copy, GUINT_TO_POINTER (index + 1));
673 g_hash_table_insert (w->index_to_file, GUINT_TO_POINTER (index + 1), copy);
679 emit_line_number_info_begin (MonoDwarfWriter *w)
681 /* Line number info header */
683 * GAS seems to emit its own data to the end of the first subsection, so we use
684 * subsections 1, 2 etc:
685 * 1 - contains the header
686 * 2 - contains the file names
687 * 3 - contains the end of the header + the data
690 emit_section_change (w, ".debug_line", 0);
691 emit_label (w, ".Ldebug_line_section_start");
692 emit_section_change (w, ".debug_line", LINE_SUBSECTION_HEADER);
693 emit_label (w, ".Ldebug_line_start");
694 emit_symbol_diff (w, ".Ldebug_line_end", ".", -4); /* length */
695 emit_int16 (w, 0x2); /* version */
696 emit_symbol_diff (w, ".Ldebug_line_header_end", ".", -4); /* header_length */
697 emit_byte (w, 1); /* minimum_instruction_length */
698 emit_byte (w, 1); /* default_is_stmt */
699 emit_byte (w, LINE_BASE); /* line_base */
700 emit_byte (w, LINE_RANGE); /* line_range */
701 emit_byte (w, OPCODE_BASE); /* opcode_base */
702 emit_byte (w, 0); /* standard_opcode_lengths */
716 emit_section_change (w, ".debug_line", LINE_SUBSECTION_INCLUDES);
718 /* End of Includes */
719 emit_section_change (w, ".debug_line", LINE_SUBSECTION_FILES);
723 emit_line_number_file_name (w, "xdb.il", 0, 0);
726 emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
729 emit_label (w, ".Ldebug_line_header_end");
731 /* Emit this into a separate subsection so it gets placed at the end */
732 emit_section_change (w, ".debug_line", LINE_SUBSECTION_END);
736 emit_byte (w, DW_LNE_end_sequence);
738 emit_label (w, ".Ldebug_line_end");
742 mono_dwarf_escape_path (const char *name)
744 if (strchr (name, '\\')) {
749 s = g_malloc0 ((len + 1) * 2);
751 for (i = 0; i < len; ++i) {
752 if (name [i] == '\\') {
761 return g_strdup (name);
765 emit_all_line_number_info (MonoDwarfWriter *w)
768 GHashTable *dir_to_index, *index_to_dir;
772 g_assert (w->collect_line_info);
774 add_line_number_file_name (w, "<unknown>", 0, 0);
777 info_list = g_slist_reverse (w->line_info);
778 for (l = info_list; l; l = l->next) {
779 MethodLineNumberInfo *info = l->data;
780 MonoDebugMethodInfo *minfo;
782 GPtrArray *source_file_list;
785 minfo = mono_debug_lookup_method (info->method);
789 mono_debug_symfile_get_line_numbers_full (minfo, &source_file, &source_file_list, NULL, NULL, NULL, NULL, NULL);
790 for (i = 0; i < source_file_list->len; ++i) {
791 MonoDebugSourceInfo *sinfo = g_ptr_array_index (source_file_list, i);
792 add_line_number_file_name (w, sinfo->source_file, 0, 0);
796 /* Preprocess files */
797 dir_to_index = g_hash_table_new (g_str_hash, g_str_equal);
798 index_to_dir = g_hash_table_new (NULL, NULL);
799 for (i = 0; i < w->line_number_file_index; ++i) {
800 char *name = g_hash_table_lookup (w->index_to_file, GUINT_TO_POINTER (i + 1));
804 if (g_path_is_absolute (name)) {
805 char *dir = g_path_get_dirname (name);
807 dir_index = GPOINTER_TO_UINT (g_hash_table_lookup (dir_to_index, dir));
808 if (dir_index == 0) {
809 dir_index = w->line_number_dir_index;
810 w->line_number_dir_index ++;
811 copy = g_strdup (dir);
812 g_hash_table_insert (dir_to_index, copy, GUINT_TO_POINTER (dir_index + 1));
813 g_hash_table_insert (index_to_dir, GUINT_TO_POINTER (dir_index + 1), copy);
822 /* Line number info header */
823 emit_section_change (w, ".debug_line", 0);
824 emit_label (w, ".Ldebug_line_section_start");
825 emit_label (w, ".Ldebug_line_start");
826 emit_symbol_diff (w, ".Ldebug_line_end", ".", -4); /* length */
827 emit_int16 (w, 0x2); /* version */
828 emit_symbol_diff (w, ".Ldebug_line_header_end", ".", -4); /* header_length */
829 emit_byte (w, 1); /* minimum_instruction_length */
830 emit_byte (w, 1); /* default_is_stmt */
831 emit_byte (w, LINE_BASE); /* line_base */
832 emit_byte (w, LINE_RANGE); /* line_range */
833 emit_byte (w, OPCODE_BASE); /* opcode_base */
834 emit_byte (w, 0); /* standard_opcode_lengths */
848 emit_section_change (w, ".debug_line", 0);
849 for (i = 0; i < w->line_number_dir_index; ++i) {
850 char *dir = g_hash_table_lookup (index_to_dir, GUINT_TO_POINTER (i + 1));
852 emit_string (w, mono_dwarf_escape_path (dir));
854 /* End of Includes */
858 for (i = 0; i < w->line_number_file_index; ++i) {
859 char *name = g_hash_table_lookup (w->index_to_file, GUINT_TO_POINTER (i + 1));
860 char *basename = NULL, *dir;
863 if (g_path_is_absolute (name)) {
864 dir = g_path_get_dirname (name);
866 dir_index = GPOINTER_TO_UINT (g_hash_table_lookup (dir_to_index, dir));
867 basename = g_path_get_basename (name);
871 emit_string (w, basename);
873 emit_string (w, mono_dwarf_escape_path (name));
874 emit_uleb128 (w, dir_index);
882 emit_label (w, ".Ldebug_line_header_end");
884 /* Emit line number table */
885 for (l = info_list; l; l = l->next) {
886 MethodLineNumberInfo *info = l->data;
887 MonoDebugMethodJitInfo *dmji;
889 dmji = mono_debug_find_method (info->method, mono_domain_get ());;
890 emit_line_number_info (w, info->method, info->start_symbol, info->end_symbol, info->code, info->code_size, dmji);
891 mono_debug_free_method_jit_info (dmji);
893 g_slist_free (info_list);
897 emit_byte (w, DW_LNE_end_sequence);
899 emit_label (w, ".Ldebug_line_end");
903 * Some assemblers like apple's do not support subsections, so we can't place
904 * .Ldebug_info_end at the end of the section using subsections. Instead, we
905 * define it every time something gets added to the .debug_info section.
906 * The apple assember seems to use the last definition.
909 emit_debug_info_end (MonoDwarfWriter *w)
911 /* This doesn't seem to work/required with recent iphone sdk versions */
913 if (!img_writer_subsections_supported (w->w))
914 fprintf (w->fp, "\n.set %sdebug_info_end,.\n", w->temp_prefix);
919 mono_dwarf_writer_emit_base_info (MonoDwarfWriter *w, GSList *base_unwind_program)
921 char *s, *build_info;
924 w->cie_program = base_unwind_program;
926 emit_section_change (w, ".debug_abbrev", 0);
927 emit_dwarf_abbrev (w, ABBREV_COMPILE_UNIT, DW_TAG_compile_unit, TRUE,
928 compile_unit_attr, G_N_ELEMENTS (compile_unit_attr));
929 emit_dwarf_abbrev (w, ABBREV_SUBPROGRAM, DW_TAG_subprogram, TRUE,
930 subprogram_attr, G_N_ELEMENTS (subprogram_attr));
931 emit_dwarf_abbrev (w, ABBREV_PARAM, DW_TAG_formal_parameter, FALSE,
932 param_attr, G_N_ELEMENTS (param_attr));
933 emit_dwarf_abbrev (w, ABBREV_PARAM_LOCLIST, DW_TAG_formal_parameter, FALSE,
934 param_loclist_attr, G_N_ELEMENTS (param_loclist_attr));
935 emit_dwarf_abbrev (w, ABBREV_BASE_TYPE, DW_TAG_base_type, FALSE,
936 base_type_attr, G_N_ELEMENTS (base_type_attr));
937 emit_dwarf_abbrev (w, ABBREV_STRUCT_TYPE, DW_TAG_class_type, TRUE,
938 struct_type_attr, G_N_ELEMENTS (struct_type_attr));
939 emit_dwarf_abbrev (w, ABBREV_STRUCT_TYPE_NOCHILDREN, DW_TAG_class_type, FALSE,
940 struct_type_attr, G_N_ELEMENTS (struct_type_attr));
941 emit_dwarf_abbrev (w, ABBREV_DATA_MEMBER, DW_TAG_member, FALSE,
942 data_member_attr, G_N_ELEMENTS (data_member_attr));
943 emit_dwarf_abbrev (w, ABBREV_TYPEDEF, DW_TAG_typedef, FALSE,
944 typedef_attr, G_N_ELEMENTS (typedef_attr));
945 emit_dwarf_abbrev (w, ABBREV_ENUM_TYPE, DW_TAG_enumeration_type, TRUE,
946 enum_type_attr, G_N_ELEMENTS (enum_type_attr));
947 emit_dwarf_abbrev (w, ABBREV_ENUMERATOR, DW_TAG_enumerator, FALSE,
948 enumerator_attr, G_N_ELEMENTS (enumerator_attr));
949 emit_dwarf_abbrev (w, ABBREV_NAMESPACE, DW_TAG_namespace, TRUE,
950 namespace_attr, G_N_ELEMENTS (namespace_attr));
951 emit_dwarf_abbrev (w, ABBREV_VARIABLE, DW_TAG_variable, FALSE,
952 variable_attr, G_N_ELEMENTS (variable_attr));
953 emit_dwarf_abbrev (w, ABBREV_VARIABLE_LOCLIST, DW_TAG_variable, FALSE,
954 variable_loclist_attr, G_N_ELEMENTS (variable_loclist_attr));
955 emit_dwarf_abbrev (w, ABBREV_POINTER_TYPE, DW_TAG_pointer_type, FALSE,
956 pointer_type_attr, G_N_ELEMENTS (pointer_type_attr));
957 emit_dwarf_abbrev (w, ABBREV_REFERENCE_TYPE, DW_TAG_reference_type, FALSE,
958 reference_type_attr, G_N_ELEMENTS (reference_type_attr));
959 emit_dwarf_abbrev (w, ABBREV_INHERITANCE, DW_TAG_inheritance, FALSE,
960 inheritance_attr, G_N_ELEMENTS (inheritance_attr));
961 emit_dwarf_abbrev (w, ABBREV_TRAMP_SUBPROGRAM, DW_TAG_subprogram, FALSE,
962 tramp_subprogram_attr, G_N_ELEMENTS (tramp_subprogram_attr));
965 emit_section_change (w, ".debug_info", 0);
966 emit_label (w, ".Ldebug_info_start");
967 emit_symbol_diff (w, ".Ldebug_info_end", ".Ldebug_info_begin", 0); /* length */
968 emit_label (w, ".Ldebug_info_begin");
969 emit_int16 (w, 0x2); /* DWARF version 2 */
970 emit_int32 (w, 0); /* .debug_abbrev offset */
971 emit_byte (w, sizeof (gpointer)); /* address size */
973 if (img_writer_subsections_supported (w->w) && w->appending) {
974 /* Emit this into a separate section so it gets placed at the end */
975 emit_section_change (w, ".debug_info", 1);
976 emit_byte (w, 0); /* close COMPILE_UNIT */
977 emit_label (w, ".Ldebug_info_end");
978 emit_section_change (w, ".debug_info", 0);
981 /* Compilation unit */
982 emit_uleb128 (w, ABBREV_COMPILE_UNIT);
983 build_info = mono_get_runtime_build_info ();
984 s = g_strdup_printf ("Mono AOT Compiler %s", build_info);
988 emit_string (w, "JITted code");
990 emit_byte (w, DW_LANG_C);
991 emit_pointer_value (w, 0);
992 emit_pointer_value (w, 0);
993 /* offset into .debug_line section */
995 emit_symbol_diff (w, ".Ldebug_line_start", ".Ldebug_line_section_start", 0);
997 emit_pointer_value (w, 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");
1018 * mono_dwarf_writer_close:
1020 * Finalize the emitted debugging info.
1023 mono_dwarf_writer_close (MonoDwarfWriter *w)
1025 if (!w->appending) {
1026 emit_section_change (w, ".debug_info", 0);
1027 emit_byte (w, 0); /* close COMPILE_UNIT */
1028 emit_label (w, ".Ldebug_info_end");
1031 if (w->collect_line_info)
1032 emit_all_line_number_info (w);
1035 static void emit_type (MonoDwarfWriter *w, MonoType *t);
1036 static const char* get_type_die (MonoDwarfWriter *w, MonoType *t);
1039 get_class_die (MonoDwarfWriter *w, MonoClass *klass, gboolean vtype)
1044 cache = w->class_to_vtype_die;
1046 cache = w->class_to_die;
1048 return g_hash_table_lookup (cache, klass);
1051 /* Returns the local symbol pointing to the emitted debug info */
1053 emit_class_dwarf_info (MonoDwarfWriter *w, MonoClass *klass, gboolean vtype)
1055 char *die, *pointer_die, *reference_die;
1056 char *full_name, *p;
1058 MonoClassField *field;
1061 gboolean emit_namespace = FALSE, has_children;
1065 cache = w->class_to_vtype_die;
1067 cache = w->class_to_die;
1069 die = g_hash_table_lookup (cache, klass);
1073 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) ||
1074 (klass->byval_arg.type >= MONO_TYPE_BOOLEAN && klass->byval_arg.type <= MONO_TYPE_R8 && !vtype)))
1078 * FIXME: gdb can't handle namespaces in languages it doesn't know about.
1081 if (klass->name_space && klass->name_space [0] != '\0')
1082 emit_namespace = TRUE;
1084 if (emit_namespace) {
1085 emit_uleb128 (w, ABBREV_NAMESPACE);
1086 emit_string (w, klass->name_space);
1089 full_name = g_strdup_printf ("%s%s%s", klass->name_space, klass->name_space ? "." : "", klass->name);
1091 * gdb doesn't support namespaces for non-C++ dwarf objects, so use _
1092 * to separate components.
1094 for (p = full_name; *p; p ++)
1098 die = g_strdup_printf (".LTDIE_%d", w->tdie_index);
1099 pointer_die = g_strdup_printf (".LTDIE_%d_POINTER", w->tdie_index);
1100 reference_die = g_strdup_printf (".LTDIE_%d_REFERENCE", w->tdie_index);
1103 g_hash_table_insert (w->class_to_pointer_die, klass, pointer_die);
1104 g_hash_table_insert (w->class_to_reference_die, klass, reference_die);
1105 g_hash_table_insert (cache, klass, die);
1107 if (klass->enumtype) {
1108 int size = mono_class_value_size (mono_class_from_mono_type (mono_class_enum_basetype (klass)), NULL);
1110 emit_label (w, die);
1112 emit_uleb128 (w, ABBREV_ENUM_TYPE);
1113 emit_string (w, full_name);
1114 emit_uleb128 (w, size);
1115 for (k = 0; k < G_N_ELEMENTS (basic_types); ++k)
1116 if (basic_types [k].type == mono_class_enum_basetype (klass)->type)
1118 g_assert (k < G_N_ELEMENTS (basic_types));
1119 emit_symbol_diff (w, basic_types [k].die_name, ".Ldebug_info_start", 0);
1121 /* Emit enum values */
1123 while ((field = mono_class_get_fields (klass, &iter))) {
1126 MonoTypeEnum def_type;
1128 if (strcmp ("value__", mono_field_get_name (field)) == 0)
1130 if (mono_field_is_deleted (field))
1133 emit_uleb128 (w, ABBREV_ENUMERATOR);
1134 emit_string (w, mono_field_get_name (field));
1136 p = mono_class_get_field_default_value (field, &def_type);
1137 len = mono_metadata_decode_blob_size (p, &p);
1138 switch (mono_class_enum_basetype (klass)->type) {
1141 case MONO_TYPE_BOOLEAN:
1142 emit_sleb128 (w, *p);
1146 case MONO_TYPE_CHAR:
1147 emit_sleb128 (w, read16 (p));
1151 emit_sleb128 (w, read32 (p));
1155 emit_sleb128 (w, read64 (p));
1159 #if SIZEOF_VOID_P == 8
1160 emit_sleb128 (w, read64 (p));
1162 emit_sleb128 (w, read32 (p));
1166 g_assert_not_reached ();
1170 has_children = TRUE;
1177 parent_die = emit_class_dwarf_info (w, klass->parent, FALSE);
1181 /* Emit field types */
1183 while ((field = mono_class_get_fields (klass, &iter))) {
1184 if (field->type->attrs & FIELD_ATTRIBUTE_STATIC)
1187 emit_type (w, field->type);
1191 has_children = parent_die || mono_class_get_fields (klass, &iter);
1193 emit_label (w, die);
1195 emit_uleb128 (w, has_children ? ABBREV_STRUCT_TYPE : ABBREV_STRUCT_TYPE_NOCHILDREN);
1196 emit_string (w, full_name);
1197 emit_uleb128 (w, klass->instance_size);
1200 emit_uleb128 (w, ABBREV_INHERITANCE);
1201 emit_symbol_diff (w, parent_die, ".Ldebug_info_start", 0);
1204 *p ++= DW_OP_plus_uconst;
1205 encode_uleb128 (0, p, &p);
1206 emit_byte (w, p - buf);
1207 emit_bytes (w, buf, p - buf);
1212 while ((field = mono_class_get_fields (klass, &iter))) {
1213 if (field->type->attrs & FIELD_ATTRIBUTE_STATIC)
1216 fdie = get_type_die (w, field->type);
1218 emit_uleb128 (w, ABBREV_DATA_MEMBER);
1219 emit_string (w, field->name);
1220 emit_symbol_diff (w, fdie, ".Ldebug_info_start", 0);
1223 *p ++= DW_OP_plus_uconst;
1224 if (klass->valuetype && vtype)
1225 encode_uleb128 (field->offset - sizeof (MonoObject), p, &p);
1227 encode_uleb128 (field->offset, p, &p);
1229 emit_byte (w, p - buf);
1230 emit_bytes (w, buf, p - buf);
1237 emit_uleb128 (w, 0x0);
1239 /* Add a typedef, so we can reference the type without a 'struct' in gdb */
1240 emit_uleb128 (w, ABBREV_TYPEDEF);
1241 emit_string (w, full_name);
1242 emit_symbol_diff (w, die, ".Ldebug_info_start", 0);
1244 /* Add a pointer type */
1245 emit_label (w, pointer_die);
1247 emit_uleb128 (w, ABBREV_POINTER_TYPE);
1248 emit_symbol_diff (w, die, ".Ldebug_info_start", 0);
1250 /* Add a reference type */
1251 emit_label (w, reference_die);
1253 emit_uleb128 (w, ABBREV_REFERENCE_TYPE);
1254 emit_symbol_diff (w, die, ".Ldebug_info_start", 0);
1258 if (emit_namespace) {
1260 emit_uleb128 (w, 0x0);
1266 static gboolean base_types_emitted [64];
1269 get_type_die (MonoDwarfWriter *w, MonoType *t)
1271 MonoClass *klass = mono_class_from_mono_type (t);
1276 if (t->type == MONO_TYPE_VALUETYPE) {
1277 tdie = g_hash_table_lookup (w->class_to_pointer_die, klass);
1280 tdie = get_class_die (w, klass, FALSE);
1281 /* Should return a pointer type to a reference */
1284 t = &mono_defaults.int_class->byval_arg;
1286 for (j = 0; j < G_N_ELEMENTS (basic_types); ++j)
1287 if (basic_types [j].type == t->type)
1289 if (j < G_N_ELEMENTS (basic_types)) {
1290 tdie = basic_types [j].die_name;
1293 case MONO_TYPE_CLASS:
1294 tdie = g_hash_table_lookup (w->class_to_reference_die, klass);
1295 //tdie = ".LDIE_OBJECT";
1297 case MONO_TYPE_ARRAY:
1298 tdie = ".LDIE_OBJECT";
1300 case MONO_TYPE_VALUETYPE:
1301 if (klass->enumtype)
1302 tdie = get_class_die (w, klass, FALSE);
1306 case MONO_TYPE_GENERICINST:
1307 if (!MONO_TYPE_ISSTRUCT (t)) {
1308 tdie = g_hash_table_lookup (w->class_to_reference_die, klass);
1328 emit_type (MonoDwarfWriter *w, MonoType *t)
1330 MonoClass *klass = mono_class_from_mono_type (t);
1335 if (t->type == MONO_TYPE_VALUETYPE) {
1336 tdie = emit_class_dwarf_info (w, klass, TRUE);
1341 emit_class_dwarf_info (w, klass, FALSE);
1344 t = &mono_defaults.int_class->byval_arg;
1346 for (j = 0; j < G_N_ELEMENTS (basic_types); ++j)
1347 if (basic_types [j].type == t->type)
1349 if (j < G_N_ELEMENTS (basic_types)) {
1350 /* Emit a boxed version of base types */
1351 if (j < 64 && !base_types_emitted [j]) {
1352 emit_class_dwarf_info (w, klass, FALSE);
1353 base_types_emitted [j] = TRUE;
1357 case MONO_TYPE_CLASS:
1358 emit_class_dwarf_info (w, klass, FALSE);
1360 case MONO_TYPE_ARRAY:
1362 case MONO_TYPE_VALUETYPE:
1363 if (klass->enumtype)
1364 emit_class_dwarf_info (w, klass, FALSE);
1366 case MONO_TYPE_GENERICINST:
1367 if (!MONO_TYPE_ISSTRUCT (t))
1368 emit_class_dwarf_info (w, klass, FALSE);
1379 emit_var_type (MonoDwarfWriter *w, MonoType *t)
1383 tdie = get_type_die (w, t);
1385 emit_symbol_diff (w, tdie, ".Ldebug_info_start", 0);
1389 encode_var_location (MonoDwarfWriter *w, MonoInst *ins, guint8 *p, guint8 **endp)
1392 /* FIXME: This needs a location list, since the args can go from reg->stack */
1393 if (!ins || ins->flags & MONO_INST_IS_DEAD) {
1394 /* gdb treats this as optimized out */
1395 } else if (ins->opcode == OP_REGVAR) {
1396 *p = DW_OP_reg0 + mono_hw_reg_to_dwarf_reg (ins->dreg);
1398 } else if (ins->opcode == OP_REGOFFSET) {
1399 *p ++= DW_OP_breg0 + mono_hw_reg_to_dwarf_reg (ins->inst_basereg);
1400 encode_sleb128 (ins->inst_offset, p, &p);
1410 emit_loclist (MonoDwarfWriter *w, MonoInst *ins,
1411 guint8 *loclist_begin_addr, guint8 *loclist_end_addr,
1412 guint8 *expr, guint32 expr_len)
1416 emit_push_section (w, ".debug_loc", 0);
1417 sprintf (label, ".Lloclist_%d", w->loclist_index ++ );
1418 emit_label (w, label);
1420 emit_pointer_value (w, loclist_begin_addr);
1421 emit_pointer_value (w, loclist_end_addr);
1422 emit_byte (w, expr_len % 256);
1423 emit_byte (w, expr_len / 256);
1424 emit_bytes (w, expr, expr_len);
1426 emit_pointer_value (w, NULL);
1427 emit_pointer_value (w, NULL);
1429 emit_pop_section (w);
1430 emit_symbol_diff (w, label, ".Ldebug_loc_start", 0);
1434 * MonoDisHelper->tokener doesn't take an IP argument, and we can't add one since
1435 * it is a public header.
1437 static const guint8 *token_handler_ip;
1440 token_handler (MonoDisHelper *dh, MonoMethod *method, guint32 token)
1443 MonoMethod *cmethod;
1445 MonoClassField *field;
1446 gpointer data = NULL;
1448 if (method->wrapper_type)
1449 data = mono_method_get_wrapper_data (method, token);
1451 switch (*token_handler_ip) {
1455 if (method->wrapper_type)
1458 klass = mono_class_get_full (method->klass->image, token, NULL);
1459 res = g_strdup_printf ("<%s>", klass->name);
1464 if (method->wrapper_type)
1467 cmethod = mono_get_method_full (method->klass->image, token, NULL, NULL);
1468 desc = mono_method_full_name (cmethod, TRUE);
1469 res = g_strdup_printf ("<%s>", desc);
1473 if (method->wrapper_type) {
1474 desc = mono_signature_get_desc (data, FALSE);
1475 res = g_strdup_printf ("<%s>", desc);
1478 res = g_strdup_printf ("<0x%08x>", token);
1485 if (method->wrapper_type)
1488 field = mono_field_from_token (method->klass->image, token, &klass, NULL);
1489 desc = mono_field_full_name (field);
1490 res = g_strdup_printf ("<%s>", desc);
1494 res = g_strdup_printf ("<0x%08x>", token);
1504 * Produce a disassembled form of the IL instruction at IP. This is an extension
1505 * of mono_disasm_code_one () which can disasm tokens, handle wrapper methods, and
1506 * CEE_MONO_ opcodes.
1509 disasm_ins (MonoMethod *method, const guchar *ip, const guint8 **endip)
1513 MonoMethodHeader *header = mono_method_get_header (method);
1515 memset (&dh, 0, sizeof (dh));
1517 dh.label_format = "IL_%04x: ";
1518 dh.label_target = "IL_%04x";
1519 dh.tokener = token_handler;
1521 token_handler_ip = ip;
1522 if (*ip == MONO_CUSTOM_PREFIX) {
1527 case CEE_MONO_ICALL: {
1528 MonoJitICallInfo *info;
1530 token = read32 (ip + 2);
1531 data = mono_method_get_wrapper_data (method, token);
1532 info = mono_find_jit_icall_by_addr (data);
1535 dis = g_strdup_printf ("IL_%04x: mono_icall <%s>", (int)(ip - header->code), info->name);
1539 case CEE_MONO_CLASSCONST: {
1540 token = read32 (ip + 2);
1541 data = mono_method_get_wrapper_data (method, token);
1543 dis = g_strdup_printf ("IL_%04x: mono_classconst <%s>", (int)(ip - header->code), ((MonoClass*)data)->name);
1548 dis = mono_disasm_code_one (&dh, method, ip, &ip);
1551 dis = mono_disasm_code_one (&dh, method, ip, &ip);
1553 token_handler_ip = NULL;
1556 mono_metadata_free_mh (header);
1561 il_offset_from_address (MonoMethod *method, MonoDebugMethodJitInfo *jit,
1562 guint32 native_offset)
1566 if (!jit->line_numbers)
1569 for (i = jit->num_line_numbers - 1; i >= 0; i--) {
1570 MonoDebugLineNumberEntry lne = jit->line_numbers [i];
1572 if (lne.native_offset <= native_offset)
1573 return lne.il_offset;
1579 static int max_special_addr_diff = 0;
1582 emit_advance_op (MonoDwarfWriter *w, int line_diff, int addr_diff)
1586 /* Use a special opcode if possible */
1587 if (line_diff - LINE_BASE >= 0 && line_diff - LINE_BASE < LINE_RANGE) {
1588 if (max_special_addr_diff == 0)
1589 max_special_addr_diff = (255 - OPCODE_BASE) / LINE_RANGE;
1591 if (addr_diff > max_special_addr_diff && (addr_diff < 2 * max_special_addr_diff)) {
1592 emit_byte (w, DW_LNS_const_add_pc);
1593 addr_diff -= max_special_addr_diff;
1596 opcode = (line_diff - LINE_BASE) + (LINE_RANGE * addr_diff) + OPCODE_BASE;
1602 emit_byte (w, opcode);
1604 //printf ("large: %d %d %d\n", line_diff, addr_diff, max_special_addr_diff);
1605 emit_byte (w, DW_LNS_advance_line);
1606 emit_sleb128 (w, line_diff);
1607 emit_byte (w, DW_LNS_advance_pc);
1608 emit_sleb128 (w, addr_diff);
1609 emit_byte (w, DW_LNS_copy);
1614 compare_lne (MonoDebugLineNumberEntry *a, MonoDebugLineNumberEntry *b)
1616 if (a->native_offset == b->native_offset)
1617 return a->il_offset - b->il_offset;
1619 return a->native_offset - b->native_offset;
1623 emit_line_number_info (MonoDwarfWriter *w, MonoMethod *method,
1624 char *start_symbol, char *end_symbol,
1625 guint8 *code, guint32 code_size,
1626 MonoDebugMethodJitInfo *debug_info)
1628 guint32 prev_line = 0;
1629 guint32 prev_native_offset = 0;
1630 int i, file_index, il_offset, prev_il_offset;
1631 gboolean first = TRUE;
1632 MonoDebugSourceLocation *loc;
1633 char *prev_file_name = NULL;
1634 MonoMethodHeader *header = mono_method_get_header (method);
1635 MonoDebugMethodInfo *minfo;
1636 MonoDebugLineNumberEntry *ln_array;
1637 int *native_to_il_offset = NULL;
1639 if (!w->emit_line) {
1640 mono_metadata_free_mh (header);
1644 minfo = mono_debug_lookup_method (method);
1646 /* Compute the native->IL offset mapping */
1648 g_assert (code_size);
1650 ln_array = g_new0 (MonoDebugLineNumberEntry, debug_info->num_line_numbers);
1651 memcpy (ln_array, debug_info->line_numbers, debug_info->num_line_numbers * sizeof (MonoDebugLineNumberEntry));
1653 qsort (ln_array, debug_info->num_line_numbers, sizeof (MonoDebugLineNumberEntry), (gpointer)compare_lne);
1655 native_to_il_offset = g_new0 (int, code_size + 1);
1657 for (i = 0; i < debug_info->num_line_numbers; ++i) {
1659 MonoDebugLineNumberEntry *lne = &ln_array [i];
1662 for (j = 0; j < lne->native_offset; ++j)
1663 native_to_il_offset [j] = -1;
1666 if (i < debug_info->num_line_numbers - 1) {
1667 MonoDebugLineNumberEntry *lne_next = &ln_array [i + 1];
1669 for (j = lne->native_offset; j < lne_next->native_offset; ++j)
1670 native_to_il_offset [j] = lne->il_offset;
1672 for (j = lne->native_offset; j < code_size; ++j)
1673 native_to_il_offset [j] = lne->il_offset;
1679 prev_il_offset = -1;
1681 for (i = 0; i < code_size; ++i) {
1682 int line_diff, addr_diff;
1687 if (!debug_info->line_numbers)
1690 if (native_to_il_offset)
1691 il_offset = native_to_il_offset [i];
1693 il_offset = il_offset_from_address (method, debug_info, i);
1695 il_offset = il_offset_from_address (method, debug_info, i);
1697 g_assert (il_offset == native_to_il_offset [i]);
1700 il_offset = native_to_il_offset [i];
1704 if (il_offset == prev_il_offset)
1707 prev_il_offset = il_offset;
1709 loc = mono_debug_symfile_lookup_location (minfo, il_offset);
1710 if (!(loc && loc->source_file))
1713 line_diff = (gint32)loc->row - (gint32)prev_line;
1714 addr_diff = i - prev_native_offset;
1717 emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
1720 emit_byte (w, sizeof (gpointer) + 1);
1721 emit_byte (w, DW_LNE_set_address);
1723 emit_pointer_unaligned (w, start_symbol);
1725 emit_pointer_value (w, code);
1728 * The prolog+initlocals region does not have a line number, this
1729 * makes them belong to the first line of the method.
1731 emit_byte (w, DW_LNS_advance_line);
1732 //printf ("FIRST: %d %d %d\n", prev_line, loc->row, il_offset);
1733 emit_sleb128 (w, (gint32)loc->row - (gint32)prev_line);
1734 prev_line = loc->row;
1735 prev_native_offset = i;
1739 if (loc->row != prev_line) {
1740 if (!prev_file_name || strcmp (loc->source_file, prev_file_name) != 0) {
1741 /* Add an entry to the file table */
1742 /* FIXME: Avoid duplicates */
1743 if (w->collect_line_info)
1744 file_index = get_line_number_file_name (w, loc->source_file) + 1;
1746 file_index = emit_line_number_file_name (w, loc->source_file, 0, 0);
1747 g_free (prev_file_name);
1748 prev_file_name = g_strdup (loc->source_file);
1750 if (w->cur_file_index != file_index) {
1751 emit_byte (w, DW_LNS_set_file);
1752 emit_uleb128 (w, file_index);
1753 emit_byte (w, DW_LNS_copy);
1754 w->cur_file_index = file_index;
1757 //printf ("X: %p(+0x%x) %d %s:%d(+%d)\n", code + i, addr_diff, loc->il_offset, loc->source_file, loc->row, line_diff);
1758 emit_advance_op (w, line_diff, addr_diff);
1760 prev_line = loc->row;
1761 prev_native_offset = i;
1764 mono_debug_symfile_free_location (loc);
1767 g_free (native_to_il_offset);
1768 g_free (prev_file_name);
1771 emit_byte (w, DW_LNS_advance_pc);
1772 emit_sleb128 (w, code_size - prev_native_offset);
1773 emit_byte (w, DW_LNS_copy);
1777 emit_byte (w, DW_LNE_end_sequence);
1778 } else if (!start_symbol) {
1779 /* No debug info, XDEBUG mode */
1781 const guint8 *ip = header->code;
1782 int prev_line, prev_native_offset;
1786 * Emit the IL code into a temporary file and emit line number info
1787 * referencing that file.
1790 name = mono_method_full_name (method, TRUE);
1791 fprintf (w->il_file, "// %s\n", name);
1792 w->il_file_line_index ++;
1795 il_to_line = g_new0 (int, header->code_size);
1797 emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
1799 emit_byte (w, sizeof (gpointer) + 1);
1800 emit_byte (w, DW_LNE_set_address);
1801 emit_pointer_value (w, code);
1803 // FIXME: Optimize this
1804 while (ip < header->code + header->code_size) {
1805 int il_offset = ip - header->code;
1808 w->il_file_line_index ++;
1810 dis = disasm_ins (method, ip, &ip);
1811 fprintf (w->il_file, "%s\n", dis);
1814 il_to_line [il_offset] = w->il_file_line_index;
1817 /* Emit line number info */
1819 prev_native_offset = 0;
1820 for (i = 0; i < debug_info->num_line_numbers; ++i) {
1821 MonoDebugLineNumberEntry *lne = &debug_info->line_numbers [i];
1824 if (lne->il_offset >= header->code_size)
1826 line = il_to_line [lne->il_offset];
1829 * This seems to happen randomly, it looks like il_offset points
1830 * into the middle of an instruction.
1834 printf ("%s\n", mono_method_full_name (method, TRUE));
1835 printf ("%d %d\n", lne->il_offset, header->code_size);
1840 if (line - prev_line != 0) {
1841 emit_advance_op (w, line - prev_line, (gint32)lne->native_offset - prev_native_offset);
1844 prev_native_offset = lne->native_offset;
1848 emit_byte (w, DW_LNS_advance_pc);
1849 emit_sleb128 (w, code_size - prev_native_offset);
1850 emit_byte (w, DW_LNS_copy);
1854 emit_byte (w, DW_LNE_end_sequence);
1856 fflush (w->il_file);
1857 g_free (il_to_line);
1859 mono_metadata_free_mh (header);
1862 static MonoMethodVar*
1863 find_vmv (MonoCompile *cfg, MonoInst *ins)
1868 for (j = 0; j < cfg->num_varinfo; ++j) {
1869 if (cfg->varinfo [j] == ins)
1873 if (j < cfg->num_varinfo) {
1874 return MONO_VARINFO (cfg, j);
1882 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)
1885 MonoMethodSignature *sig;
1886 MonoMethodHeader *header;
1888 MonoDebugLocalsInfo *locals_info;
1893 emit_section_change (w, ".debug_info", 0);
1895 sig = mono_method_signature (method);
1896 header = mono_method_get_header (method);
1898 /* Parameter types */
1899 for (i = 0; i < sig->param_count + sig->hasthis; ++i) {
1902 if (i == 0 && sig->hasthis) {
1903 if (method->klass->valuetype)
1904 t = &method->klass->this_arg;
1906 t = &method->klass->byval_arg;
1908 t = sig->params [i - sig->hasthis];
1913 //emit_type (w, &mono_defaults.int32_class->byval_arg);
1916 for (i = 0; i < header->num_locals; ++i) {
1917 emit_type (w, header->locals [i]);
1921 names = g_new0 (char *, sig->param_count);
1922 mono_method_get_param_names (method, (const char **) names);
1924 emit_uleb128 (w, ABBREV_SUBPROGRAM);
1925 name = mono_method_full_name (method, FALSE);
1926 emit_string (w, name);
1928 emit_string (w, name);
1932 emit_pointer_unaligned (w, start_symbol);
1933 emit_pointer_unaligned (w, end_symbol);
1935 emit_pointer_value (w, code);
1936 emit_pointer_value (w, code + code_size);
1940 emit_byte (w, DW_OP_breg6);
1944 for (i = 0; i < sig->param_count + sig->hasthis; ++i) {
1945 MonoInst *arg = args ? args [i] : NULL;
1948 char pname_buf [128];
1949 MonoMethodVar *vmv = NULL;
1950 gboolean need_loclist = FALSE;
1952 vmv = find_vmv (cfg, arg);
1953 if (code && vmv && (vmv->live_range_start || vmv->live_range_end))
1954 need_loclist = TRUE;
1956 if (i == 0 && sig->hasthis) {
1957 if (method->klass->valuetype)
1958 t = &method->klass->this_arg;
1960 t = &method->klass->byval_arg;
1963 t = sig->params [i - sig->hasthis];
1964 pname = names [i - sig->hasthis];
1967 emit_uleb128 (w, need_loclist ? ABBREV_PARAM_LOCLIST : ABBREV_PARAM);
1969 if (pname[0] == '\0') {
1970 sprintf (pname_buf, "param%d", i - sig->hasthis);
1973 emit_string (w, pname);
1975 if (!arg || arg->flags & MONO_INST_IS_DEAD)
1976 emit_var_type (w, &mono_defaults.int32_class->byval_arg);
1978 emit_var_type (w, t);
1981 encode_var_location (w, arg, p, &p);
1983 vmv->live_range_start = 0;
1984 if (vmv->live_range_end == 0)
1985 /* FIXME: Uses made in calls are not recorded */
1986 vmv->live_range_end = code_size;
1987 emit_loclist (w, arg, code + vmv->live_range_start, code + vmv->live_range_end, buf, p - buf);
1989 emit_byte (w, p - buf);
1990 emit_bytes (w, buf, p - buf);
1996 locals_info = mono_debug_lookup_locals (method);
1998 for (i = 0; i < header->num_locals; ++i) {
1999 MonoInst *ins = locals [i];
2000 char name_buf [128];
2002 MonoMethodVar *vmv = NULL;
2003 gboolean need_loclist = FALSE;
2006 /* ins->dreg no longer contains the original vreg */
2007 vmv = find_vmv (cfg, ins);
2009 if (vmv->live_range_start) {
2010 /* This variable has a precise live range */
2011 need_loclist = TRUE;
2015 emit_uleb128 (w, need_loclist ? ABBREV_VARIABLE_LOCLIST : ABBREV_VARIABLE);
2019 for (j = 0; j < locals_info->num_locals; ++j)
2020 if (locals_info->locals [j].index == i)
2022 if (j < locals_info->num_locals)
2023 lname = locals_info->locals [j].name;
2026 emit_string (w, lname);
2028 sprintf (name_buf, "V_%d", i);
2029 emit_string (w, name_buf);
2032 if (!ins || ins->flags & MONO_INST_IS_DEAD)
2033 emit_var_type (w, &mono_defaults.int32_class->byval_arg);
2035 emit_var_type (w, header->locals [i]);
2038 encode_var_location (w, ins, p, &p);
2041 if (vmv->live_range_end == 0)
2042 /* FIXME: Uses made in calls are not recorded */
2043 vmv->live_range_end = code_size;
2044 emit_loclist (w, ins, code + vmv->live_range_start, code + vmv->live_range_end, buf, p - buf);
2046 emit_byte (w, p - buf);
2047 emit_bytes (w, buf, p - buf);
2052 mono_debug_symfile_free_locals (locals_info);
2054 /* Subprogram end */
2055 emit_uleb128 (w, 0x0);
2059 emit_debug_info_end (w);
2061 /* Emit unwind info */
2063 emit_fde (w, w->fde_index, start_symbol, end_symbol, code, code_size, unwind_info, TRUE);
2067 /* Emit line number info */
2068 /* != could happen when using --regression */
2069 if (debug_info && (debug_info->code_start == code)) {
2070 if (w->collect_line_info) {
2071 MethodLineNumberInfo *info;
2073 /* Save the information needed to emit the line number info later at once */
2074 info = g_new0 (MethodLineNumberInfo, 1);
2075 info->method = method;
2076 info->start_symbol = g_strdup (start_symbol);
2077 info->end_symbol = g_strdup (end_symbol);
2079 info->code_size = code_size;
2080 w->line_info = g_slist_prepend (w->line_info, info);
2082 emit_line_number_info (w, method, start_symbol, end_symbol, code, code_size, debug_info);
2087 mono_metadata_free_mh (header);
2091 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)
2093 emit_section_change (w, ".debug_info", 0);
2096 emit_uleb128 (w, ABBREV_TRAMP_SUBPROGRAM);
2097 emit_string (w, tramp_name);
2098 emit_pointer_value (w, code);
2099 emit_pointer_value (w, code + code_size);
2101 /* Subprogram end */
2102 emit_uleb128 (w, 0x0);
2104 emit_debug_info_end (w);
2106 /* Emit unwind info */
2107 emit_fde (w, w->fde_index, start_symbol, end_symbol, code, code_size, unwind_info, FALSE);
2110 #endif /* End of: !defined(DISABLE_AOT) && !defined(DISABLE_JIT) */