2 * dwarfwriter.c: Creation of DWARF debug information
5 * Zoltan Varga (vargaz@gmail.com)
7 * (C) 2008-2009 Novell, Inc.
11 #include "dwarfwriter.h"
13 #include <sys/types.h>
20 #include <mono/metadata/mono-endian.h>
21 #include <mono/metadata/debug-mono-symfile.h>
22 #include <mono/utils/mono-compiler.h>
24 #ifndef PLATFORM_WIN32
25 #include <mono/utils/freebsd-elf32.h>
26 #include <mono/utils/freebsd-elf64.h>
29 #include <mono/utils/freebsd-dwarf.h>
31 struct _MonoDwarfWriter
34 GHashTable *class_to_die, *class_to_vtype_die, *class_to_pointer_die;
35 int fde_index, tdie_index, line_number_file_index, line_number_dir_index;
36 GHashTable *file_to_index, *dir_to_index;
38 int il_file_line_index, loclist_index;
43 * mono_dwarf_writer_create:
45 * Create a DWARF writer object. WRITER is the underlying image writer this
46 * writer will emit to. IL_FILE is the file where IL code will be dumped to for
47 * methods which have no line number info. It can be NULL.
50 mono_dwarf_writer_create (MonoImageWriter *writer, FILE *il_file)
52 MonoDwarfWriter *w = g_new0 (MonoDwarfWriter, 1);
61 mono_dwarf_writer_destroy (MonoDwarfWriter *w)
66 /* Wrappers around the image writer functions */
69 emit_section_change (MonoDwarfWriter *w, const char *section_name, int subsection_index)
71 img_writer_emit_section_change (w->w, section_name, subsection_index);
75 emit_push_section (MonoDwarfWriter *w, const char *section_name, int subsection)
77 img_writer_emit_push_section (w->w, section_name, subsection);
81 emit_pop_section (MonoDwarfWriter *w)
83 img_writer_emit_pop_section (w->w);
87 emit_local_symbol (MonoDwarfWriter *w, const char *name, const char *end_label, gboolean func)
89 img_writer_emit_local_symbol (w->w, name, end_label, func);
93 emit_label (MonoDwarfWriter *w, const char *name)
95 img_writer_emit_label (w->w, name);
99 emit_bytes (MonoDwarfWriter *w, const guint8* buf, int size)
101 img_writer_emit_bytes (w->w, buf, size);
105 emit_string (MonoDwarfWriter *w, const char *value)
107 img_writer_emit_string (w->w, value);
111 emit_line (MonoDwarfWriter *w)
113 img_writer_emit_line (w->w);
117 emit_alignment (MonoDwarfWriter *w, int size)
119 img_writer_emit_alignment (w->w, size);
123 emit_pointer_unaligned (MonoDwarfWriter *w, const char *target)
125 img_writer_emit_pointer_unaligned (w->w, target);
129 emit_pointer (MonoDwarfWriter *w, const char *target)
131 img_writer_emit_pointer (w->w, target);
135 emit_int16 (MonoDwarfWriter *w, int value)
137 img_writer_emit_int16 (w->w, value);
141 emit_int32 (MonoDwarfWriter *w, int value)
143 img_writer_emit_int32 (w->w, value);
147 emit_symbol_diff (MonoDwarfWriter *w, const char *end, const char* start, int offset)
149 img_writer_emit_symbol_diff (w->w, end, start, offset);
153 emit_zero_bytes (MonoDwarfWriter *w, int num)
155 img_writer_emit_zero_bytes (w->w, num);
159 emit_byte (MonoDwarfWriter *w, guint8 val)
161 img_writer_emit_byte (w->w, val);
164 static G_GNUC_UNUSED void
165 emit_uleb128 (MonoDwarfWriter *w, guint32 value)
168 guint8 b = value & 0x7f;
170 if (value != 0) /* more bytes to come */
176 static G_GNUC_UNUSED void
177 emit_sleb128 (MonoDwarfWriter *w, gint64 value)
180 gboolean negative = (value < 0);
187 /* the following is unnecessary if the
188 * implementation of >>= uses an arithmetic rather
189 * than logical shift for a signed left operand
193 value |= - ((gint64)1 <<(size - 7));
194 /* sign bit of byte is second high order bit (0x40) */
195 if ((value == 0 && !(byte & 0x40)) ||
196 (value == -1 && (byte & 0x40)))
204 static G_GNUC_UNUSED void
205 encode_uleb128 (guint32 value, guint8 *buf, guint8 **endbuf)
210 guint8 b = value & 0x7f;
212 if (value != 0) /* more bytes to come */
220 static G_GNUC_UNUSED void
221 encode_sleb128 (gint32 value, guint8 *buf, guint8 **endbuf)
224 gboolean negative = (value < 0);
232 /* the following is unnecessary if the
233 * implementation of >>= uses an arithmetic rather
234 * than logical shift for a signed left operand
238 value |= - (1 <<(size - 7));
239 /* sign bit of byte is second high order bit (0x40) */
240 if ((value == 0 && !(byte & 0x40)) ||
241 (value == -1 && (byte & 0x40)))
252 emit_dwarf_abbrev (MonoDwarfWriter *w, int code, int tag, gboolean has_child,
253 int *attrs, int attrs_len)
257 emit_uleb128 (w, code);
258 emit_uleb128 (w, tag);
259 emit_byte (w, has_child);
261 for (i = 0; i < attrs_len; i++)
262 emit_uleb128 (w, attrs [i]);
268 emit_cie (MonoDwarfWriter *w)
270 emit_section_change (w, ".debug_frame", 0);
272 emit_alignment (w, 8);
275 emit_symbol_diff (w, ".Lcie0_end", ".", -4); /* length */
276 emit_int32 (w, 0xffffffff); /* CIE id */
277 emit_byte (w, 3); /* version */
278 emit_string (w, ""); /* augmention */
279 emit_sleb128 (w, 1); /* code alignment factor */
280 emit_sleb128 (w, mono_unwind_get_dwarf_data_align ()); /* data alignment factor */
281 emit_uleb128 (w, mono_unwind_get_dwarf_pc_reg ());
283 w->cie_program = w->cie_program;
284 if (w->cie_program) {
286 guint8 *uw_info = mono_unwind_ops_encode (w->cie_program, &uw_info_len);
287 emit_bytes (w, uw_info, uw_info_len);
291 emit_alignment (w, sizeof (gpointer));
292 emit_label (w, ".Lcie0_end");
296 emit_pointer_value (MonoDwarfWriter *w, gpointer ptr)
298 gssize val = (gssize)ptr;
299 emit_bytes (w, (guint8*)&val, sizeof (gpointer));
303 emit_fde (MonoDwarfWriter *w, int fde_index, char *start_symbol, char *end_symbol,
304 guint8 *code, guint32 code_size, GSList *unwind_ops, gboolean use_cie)
311 emit_section_change (w, ".debug_frame", 0);
313 sprintf (symbol, ".Lfde%d_end", fde_index);
314 emit_symbol_diff (w, symbol, ".", -4); /* length */
315 emit_int32 (w, 0); /* CIE_pointer */
317 emit_pointer (w, start_symbol); /* initial_location */
319 emit_symbol_diff (w, end_symbol, start_symbol, 0); /* address_range */
321 g_assert (code_size);
322 emit_int32 (w, code_size);
325 emit_pointer_value (w, code);
326 emit_int32 (w, code_size);
328 #if SIZEOF_VOID_P == 8
329 /* Upper 32 bits of code size */
334 if (w->cie_program) {
335 // FIXME: Check that the ops really begin with the CIE program */
338 for (i = 0; i < g_slist_length (w->cie_program); ++i)
342 /* Convert the list of MonoUnwindOps to the format used by DWARF */
343 uw_info = mono_unwind_ops_encode (l, &uw_info_len);
344 emit_bytes (w, uw_info, uw_info_len);
347 emit_alignment (w, sizeof (gpointer));
348 sprintf (symbol, ".Lfde%d_end", fde_index);
349 emit_label (w, symbol);
353 #define ABBREV_COMPILE_UNIT 1
354 #define ABBREV_SUBPROGRAM 2
355 #define ABBREV_PARAM 3
356 #define ABBREV_BASE_TYPE 4
357 #define ABBREV_STRUCT_TYPE 5
358 #define ABBREV_DATA_MEMBER 6
359 #define ABBREV_TYPEDEF 7
360 #define ABBREV_ENUM_TYPE 8
361 #define ABBREV_ENUMERATOR 9
362 #define ABBREV_NAMESPACE 10
363 #define ABBREV_VARIABLE 11
364 #define ABBREV_VARIABLE_LOCLIST 12
365 #define ABBREV_POINTER_TYPE 13
366 #define ABBREV_PARAM_LOCLIST 14
368 static int compile_unit_attr [] = {
369 DW_AT_producer ,DW_FORM_string,
370 DW_AT_name ,DW_FORM_string,
371 DW_AT_comp_dir ,DW_FORM_string,
372 DW_AT_language ,DW_FORM_data1,
373 DW_AT_low_pc ,DW_FORM_addr,
374 DW_AT_high_pc ,DW_FORM_addr,
375 DW_AT_stmt_list ,DW_FORM_data4
378 static int subprogram_attr [] = {
379 DW_AT_name , DW_FORM_string,
380 DW_AT_low_pc , DW_FORM_addr,
381 DW_AT_high_pc , DW_FORM_addr,
382 DW_AT_frame_base , DW_FORM_block1
385 static int param_attr [] = {
386 DW_AT_name, DW_FORM_string,
387 DW_AT_type, DW_FORM_ref4,
388 DW_AT_location, DW_FORM_block1
391 static int param_loclist_attr [] = {
392 DW_AT_name, DW_FORM_string,
393 DW_AT_type, DW_FORM_ref4,
394 DW_AT_location, DW_FORM_data4
397 static int base_type_attr [] = {
398 DW_AT_byte_size, DW_FORM_data1,
399 DW_AT_encoding, DW_FORM_data1,
400 DW_AT_name, DW_FORM_string
403 static int struct_type_attr [] = {
404 DW_AT_name, DW_FORM_string,
405 DW_AT_byte_size, DW_FORM_udata,
408 static int data_member_attr [] = {
409 DW_AT_name, DW_FORM_string,
410 DW_AT_type, DW_FORM_ref4,
411 DW_AT_data_member_location, DW_FORM_block1
414 static int typedef_attr [] = {
415 DW_AT_name, DW_FORM_string,
416 DW_AT_type, DW_FORM_ref4
419 static int pointer_type_attr [] = {
420 DW_AT_type, DW_FORM_ref4,
423 static int enum_type_attr [] = {
424 DW_AT_name, DW_FORM_string,
425 DW_AT_byte_size, DW_FORM_udata,
426 DW_AT_type, DW_FORM_ref4,
429 static int enumerator_attr [] = {
430 DW_AT_name, DW_FORM_string,
431 DW_AT_const_value, DW_FORM_sdata,
434 static int namespace_attr [] = {
435 DW_AT_name, DW_FORM_string,
438 static int variable_attr [] = {
439 DW_AT_name, DW_FORM_string,
440 DW_AT_type, DW_FORM_ref4,
441 DW_AT_location, DW_FORM_block1
444 static int variable_loclist_attr [] = {
445 DW_AT_name, DW_FORM_string,
446 DW_AT_type, DW_FORM_ref4,
447 DW_AT_location, DW_FORM_data4
450 typedef struct DwarfBasicType {
451 const char *die_name, *name;
457 static DwarfBasicType basic_types [] = {
458 { ".LDIE_I1", "sbyte", MONO_TYPE_I1, 1, DW_ATE_signed },
459 { ".LDIE_U1", "byte", MONO_TYPE_U1, 1, DW_ATE_unsigned },
460 { ".LDIE_I2", "short", MONO_TYPE_I2, 2, DW_ATE_signed },
461 { ".LDIE_U2", "ushort", MONO_TYPE_U2, 2, DW_ATE_unsigned },
462 { ".LDIE_I4", "int", MONO_TYPE_I4, 4, DW_ATE_signed },
463 { ".LDIE_U4", "uint", MONO_TYPE_U4, 4, DW_ATE_unsigned },
464 { ".LDIE_I8", "long", MONO_TYPE_I8, 8, DW_ATE_signed },
465 { ".LDIE_U8", "ulong", MONO_TYPE_U8, 8, DW_ATE_unsigned },
466 { ".LDIE_I", "intptr", MONO_TYPE_I, SIZEOF_VOID_P, DW_ATE_signed },
467 { ".LDIE_U", "uintptr", MONO_TYPE_U, SIZEOF_VOID_P, DW_ATE_unsigned },
468 { ".LDIE_R4", "float", MONO_TYPE_R4, 4, DW_ATE_float },
469 { ".LDIE_R8", "double", MONO_TYPE_R8, 8, DW_ATE_float },
470 { ".LDIE_BOOLEAN", "boolean", MONO_TYPE_BOOLEAN, 1, DW_ATE_boolean },
471 { ".LDIE_CHAR", "char", MONO_TYPE_CHAR, 2, DW_ATE_unsigned_char },
472 { ".LDIE_STRING", "string", MONO_TYPE_STRING, sizeof (gpointer), DW_ATE_address },
473 { ".LDIE_OBJECT", "object", MONO_TYPE_OBJECT, sizeof (gpointer), DW_ATE_address },
474 { ".LDIE_SZARRAY", "object", MONO_TYPE_SZARRAY, sizeof (gpointer), DW_ATE_address },
477 /* Constants for encoding line number special opcodes */
478 #define OPCODE_BASE 13
480 #define LINE_RANGE 14
482 /* Subsections of the .debug_line section */
483 #define LINE_SUBSECTION_HEADER 1
484 #define LINE_SUBSECTION_INCLUDES 2
485 #define LINE_SUBSECTION_FILES 3
486 #define LINE_SUBSECTION_DATA 4
487 #define LINE_SUBSECTION_END 5
490 emit_line_number_file_name (MonoDwarfWriter *w, const char *name,
491 gint64 last_mod_time, gint64 file_size)
495 char *basename = NULL;
497 if (!w->file_to_index)
498 w->file_to_index = g_hash_table_new (g_str_hash, g_str_equal);
500 index = GPOINTER_TO_UINT (g_hash_table_lookup (w->file_to_index, name));
504 if (g_path_is_absolute (name)) {
505 char *dir = g_path_get_dirname (name);
507 if (!w->dir_to_index)
508 w->dir_to_index = g_hash_table_new (g_str_hash, g_str_equal);
510 dir_index = GPOINTER_TO_UINT (g_hash_table_lookup (w->dir_to_index, dir));
511 if (dir_index == 0) {
512 emit_section_change (w, ".debug_line", LINE_SUBSECTION_INCLUDES);
513 emit_string (w, dir);
515 dir_index = ++ w->line_number_dir_index;
516 g_hash_table_insert (w->dir_to_index, g_strdup (dir), GUINT_TO_POINTER (dir_index));
521 basename = g_path_get_basename (name);
526 emit_section_change (w, ".debug_line", LINE_SUBSECTION_FILES);
529 emit_string (w, basename);
531 emit_string (w, name);
532 emit_uleb128 (w, dir_index);
536 emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
541 index = ++ w->line_number_file_index;
542 g_hash_table_insert (w->file_to_index, g_strdup (name), GUINT_TO_POINTER (index));
548 emit_line_number_info_begin (MonoDwarfWriter *w)
551 /* FIXME: This doesn't seem to work with !xdebug */
552 emit_section_change (w, ".debug_line", 0);
553 emit_label (w, ".Ldebug_line_start");
554 emit_label (w, ".Ldebug_line_section_start");
558 /* Line number info header */
560 * GAS seems to emit its own data to the end of the first subsection, so we use
561 * subsections 1, 2 etc:
562 * 1 - contains the header
563 * 2 - contains the file names
564 * 3 - contains the end of the header + the data
567 emit_section_change (w, ".debug_line", 0);
568 emit_label (w, ".Ldebug_line_section_start");
569 emit_section_change (w, ".debug_line", LINE_SUBSECTION_HEADER);
570 emit_label (w, ".Ldebug_line_start");
571 emit_symbol_diff (w, ".Ldebug_line_end", ".", -4); /* length */
572 emit_int16 (w, 0x2); /* version */
573 emit_symbol_diff (w, ".Ldebug_line_header_end", ".", -4); /* header_length */
574 emit_byte (w, 1); /* minimum_instruction_length */
575 emit_byte (w, 1); /* default_is_stmt */
576 emit_byte (w, LINE_BASE); /* line_base */
577 emit_byte (w, LINE_RANGE); /* line_range */
578 emit_byte (w, OPCODE_BASE); /* opcode_base */
579 emit_byte (w, 0); /* standard_opcode_lengths */
593 emit_section_change (w, ".debug_line", LINE_SUBSECTION_INCLUDES);
595 /* End of Includes */
596 emit_section_change (w, ".debug_line", LINE_SUBSECTION_FILES);
600 emit_line_number_file_name (w, "xdb.il", 0, 0);
603 emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
606 emit_label (w, ".Ldebug_line_header_end");
608 /* Emit this into a separate subsection so it gets placed at the end */
609 emit_section_change (w, ".debug_line", LINE_SUBSECTION_END);
613 emit_byte (w, DW_LNE_end_sequence);
615 emit_label (w, ".Ldebug_line_end");
619 mono_dwarf_writer_emit_base_info (MonoDwarfWriter *w, GSList *base_unwind_program)
621 char *s, *build_info;
624 w->cie_program = base_unwind_program;
626 emit_section_change (w, ".debug_abbrev", 0);
627 emit_dwarf_abbrev (w, ABBREV_COMPILE_UNIT, DW_TAG_compile_unit, TRUE,
628 compile_unit_attr, G_N_ELEMENTS (compile_unit_attr));
629 emit_dwarf_abbrev (w, ABBREV_SUBPROGRAM, DW_TAG_subprogram, TRUE,
630 subprogram_attr, G_N_ELEMENTS (subprogram_attr));
631 emit_dwarf_abbrev (w, ABBREV_PARAM, DW_TAG_formal_parameter, FALSE,
632 param_attr, G_N_ELEMENTS (param_attr));
633 emit_dwarf_abbrev (w, ABBREV_PARAM_LOCLIST, DW_TAG_formal_parameter, FALSE,
634 param_loclist_attr, G_N_ELEMENTS (param_loclist_attr));
635 emit_dwarf_abbrev (w, ABBREV_BASE_TYPE, DW_TAG_base_type, FALSE,
636 base_type_attr, G_N_ELEMENTS (base_type_attr));
637 emit_dwarf_abbrev (w, ABBREV_STRUCT_TYPE, DW_TAG_class_type, TRUE,
638 struct_type_attr, G_N_ELEMENTS (struct_type_attr));
639 emit_dwarf_abbrev (w, ABBREV_DATA_MEMBER, DW_TAG_member, FALSE,
640 data_member_attr, G_N_ELEMENTS (data_member_attr));
641 emit_dwarf_abbrev (w, ABBREV_TYPEDEF, DW_TAG_typedef, FALSE,
642 typedef_attr, G_N_ELEMENTS (typedef_attr));
643 emit_dwarf_abbrev (w, ABBREV_ENUM_TYPE, DW_TAG_enumeration_type, TRUE,
644 enum_type_attr, G_N_ELEMENTS (enum_type_attr));
645 emit_dwarf_abbrev (w, ABBREV_ENUMERATOR, DW_TAG_enumerator, FALSE,
646 enumerator_attr, G_N_ELEMENTS (enumerator_attr));
647 emit_dwarf_abbrev (w, ABBREV_NAMESPACE, DW_TAG_namespace, TRUE,
648 namespace_attr, G_N_ELEMENTS (namespace_attr));
649 emit_dwarf_abbrev (w, ABBREV_VARIABLE, DW_TAG_variable, FALSE,
650 variable_attr, G_N_ELEMENTS (variable_attr));
651 emit_dwarf_abbrev (w, ABBREV_VARIABLE_LOCLIST, DW_TAG_variable, FALSE,
652 variable_loclist_attr, G_N_ELEMENTS (variable_loclist_attr));
653 emit_dwarf_abbrev (w, ABBREV_POINTER_TYPE, DW_TAG_pointer_type, FALSE,
654 pointer_type_attr, G_N_ELEMENTS (pointer_type_attr));
657 emit_section_change (w, ".debug_info", 0);
658 emit_label (w, ".Ldebug_info_start");
659 emit_symbol_diff (w, ".Ldebug_info_end", ".", -4); /* length */
660 emit_int16 (w, 0x2); /* DWARF version 2 */
661 emit_int32 (w, 0); /* .debug_abbrev offset */
662 emit_byte (w, sizeof (gpointer)); /* address size */
664 /* Emit this into a separate section so it gets placed at the end */
665 emit_section_change (w, ".debug_info", 1);
666 emit_int32 (w, 0); /* close everything */
667 emit_label (w, ".Ldebug_info_end");
668 emit_section_change (w, ".debug_info", 0);
670 /* Compilation unit */
671 emit_uleb128 (w, ABBREV_COMPILE_UNIT);
672 build_info = mono_get_runtime_build_info ();
673 s = g_strdup_printf ("Mono AOT Compiler %s", build_info);
677 emit_string (w, "JITted code");
679 emit_byte (w, DW_LANG_C);
680 emit_pointer_value (w, 0);
681 emit_pointer_value (w, 0);
682 /* offset into .debug_line section */
683 emit_symbol_diff (w, ".Ldebug_line_start", ".Ldebug_line_section_start", 0);
686 for (i = 0; i < G_N_ELEMENTS (basic_types); ++i) {
687 emit_label (w, basic_types [i].die_name);
688 emit_uleb128 (w, ABBREV_BASE_TYPE);
689 emit_byte (w, basic_types [i].size);
690 emit_byte (w, basic_types [i].encoding);
691 emit_string (w, basic_types [i].name);
694 /* debug_loc section */
695 emit_section_change (w, ".debug_loc", 0);
696 emit_label (w, ".Ldebug_loc_start");
698 /* debug_line section */
699 emit_line_number_info_begin (w);
704 /* Returns the local symbol pointing to the emitted debug info */
706 emit_class_dwarf_info (MonoDwarfWriter *w, MonoClass *klass, gboolean vtype)
708 char *die, *pointer_die;
711 MonoClassField *field;
714 gboolean emit_namespace = FALSE;
718 if (!w->class_to_die)
719 w->class_to_die = g_hash_table_new (NULL, NULL);
720 if (!w->class_to_vtype_die)
721 w->class_to_vtype_die = g_hash_table_new (NULL, NULL);
722 if (!w->class_to_pointer_die)
723 w->class_to_pointer_die = g_hash_table_new (NULL, NULL);
726 cache = w->class_to_vtype_die;
728 cache = w->class_to_die;
730 die = g_hash_table_lookup (cache, klass);
734 if (!((klass->byval_arg.type == MONO_TYPE_CLASS) || klass->enumtype || (klass->byval_arg.type == MONO_TYPE_VALUETYPE && vtype)))
738 * FIXME: gdb can't handle namespaces in languages it doesn't know about.
741 if (klass->name_space && klass->name_space [0] != '\0')
742 emit_namespace = TRUE;
744 if (emit_namespace) {
745 emit_uleb128 (w, ABBREV_NAMESPACE);
746 emit_string (w, klass->name_space);
749 full_name = g_strdup_printf ("%s%s%s", klass->name_space, klass->name_space ? "." : "", klass->name);
751 die = g_strdup_printf (".LTDIE_%d", w->tdie_index);
754 if (klass->enumtype) {
755 int size = mono_class_value_size (mono_class_from_mono_type (mono_class_enum_basetype (klass)), NULL);
757 emit_uleb128 (w, ABBREV_ENUM_TYPE);
758 emit_string (w, full_name);
759 emit_uleb128 (w, size);
760 for (k = 0; k < G_N_ELEMENTS (basic_types); ++k)
761 if (basic_types [k].type == mono_class_enum_basetype (klass)->type)
763 g_assert (k < G_N_ELEMENTS (basic_types));
764 emit_symbol_diff (w, basic_types [k].die_name, ".Ldebug_info_start", 0);
766 /* Emit enum values */
768 while ((field = mono_class_get_fields (klass, &iter))) {
771 MonoTypeEnum def_type;
773 if (strcmp ("value__", mono_field_get_name (field)) == 0)
775 if (mono_field_is_deleted (field))
778 emit_uleb128 (w, ABBREV_ENUMERATOR);
779 emit_string (w, mono_field_get_name (field));
781 p = mono_class_get_field_default_value (field, &def_type);
782 len = mono_metadata_decode_blob_size (p, &p);
783 switch (mono_class_enum_basetype (klass)->type) {
786 case MONO_TYPE_BOOLEAN:
787 emit_sleb128 (w, *p);
792 emit_sleb128 (w, read16 (p));
796 emit_sleb128 (w, read32 (p));
800 emit_sleb128 (w, read64 (p));
804 #if SIZEOF_VOID_P == 8
805 emit_sleb128 (w, read64 (p));
807 emit_sleb128 (w, read32 (p));
811 g_assert_not_reached ();
815 emit_uleb128 (w, ABBREV_STRUCT_TYPE);
816 emit_string (w, full_name);
817 emit_uleb128 (w, klass->instance_size);
821 while ((field = mono_class_get_fields (klass, &iter))) {
825 if (field->type->attrs & FIELD_ATTRIBUTE_STATIC)
828 for (k = 0; k < G_N_ELEMENTS (basic_types); ++k)
829 if (basic_types [k].type == field->type->type)
831 if (k < G_N_ELEMENTS (basic_types) && field->type->type != MONO_TYPE_SZARRAY && field->type->type != MONO_TYPE_CLASS) {
832 fdie = basic_types [k].die_name;
834 emit_uleb128 (w, ABBREV_DATA_MEMBER);
835 emit_string (w, field->name);
836 emit_symbol_diff (w, fdie, ".Ldebug_info_start", 0);
839 *p ++= DW_OP_plus_uconst;
840 if (klass->valuetype && vtype)
841 encode_uleb128 (field->offset - sizeof (MonoObject), p, &p);
843 encode_uleb128 (field->offset, p, &p);
845 emit_byte (w, p - buf);
846 emit_bytes (w, buf, p - buf);
852 emit_uleb128 (w, 0x0);
854 /* Add a typedef, so we can reference the type without a 'struct' in gdb */
855 emit_uleb128 (w, ABBREV_TYPEDEF);
856 emit_string (w, full_name);
857 emit_symbol_diff (w, die, ".Ldebug_info_start", 0);
859 /* Add a pointer type */
860 pointer_die = g_strdup_printf (".LTDIE_%d_POINTER", w->tdie_index);
861 emit_label (w, pointer_die);
863 emit_uleb128 (w, ABBREV_POINTER_TYPE);
864 emit_symbol_diff (w, die, ".Ldebug_info_start", 0);
866 g_hash_table_insert (w->class_to_pointer_die, klass, pointer_die);
871 if (emit_namespace) {
873 emit_uleb128 (w, 0x0);
876 g_hash_table_insert (cache, klass, die);
881 emit_type (MonoDwarfWriter *w, MonoType *t)
883 MonoClass *klass = mono_class_from_mono_type (t);
888 if (t->type == MONO_TYPE_VALUETYPE) {
889 tdie = emit_class_dwarf_info (w, klass, TRUE);
891 return g_hash_table_lookup (w->class_to_pointer_die, klass);
894 t = &mono_defaults.int_class->byval_arg;
896 for (j = 0; j < G_N_ELEMENTS (basic_types); ++j)
897 if (basic_types [j].type == t->type)
899 if (j < G_N_ELEMENTS (basic_types))
900 tdie = basic_types [j].die_name;
903 case MONO_TYPE_CLASS:
904 emit_class_dwarf_info (w, klass, FALSE);
905 tdie = ".LDIE_OBJECT";
907 case MONO_TYPE_ARRAY:
908 tdie = ".LDIE_OBJECT";
910 case MONO_TYPE_VALUETYPE:
912 tdie = emit_class_dwarf_info (w, klass, FALSE);
926 emit_var_type (MonoDwarfWriter *w, MonoType *t)
930 tdie = emit_type (w, t);
932 emit_symbol_diff (w, tdie, ".Ldebug_info_start", 0);
936 encode_var_location (MonoDwarfWriter *w, MonoInst *ins, guint8 *p, guint8 **endp)
939 /* FIXME: This needs a location list, since the args can go from reg->stack */
940 if (!ins || ins->flags & MONO_INST_IS_DEAD) {
941 /* gdb treats this as optimized out */
942 } else if (ins->opcode == OP_REGVAR) {
943 *p = DW_OP_reg0 + mono_hw_reg_to_dwarf_reg (ins->dreg);
945 } else if (ins->opcode == OP_REGOFFSET) {
946 *p ++= DW_OP_breg0 + mono_hw_reg_to_dwarf_reg (ins->inst_basereg);
947 encode_sleb128 (ins->inst_offset, p, &p);
957 emit_loclist (MonoDwarfWriter *w, MonoInst *ins,
958 guint8 *loclist_begin_addr, guint8 *loclist_end_addr,
959 guint8 *expr, guint32 expr_len)
963 emit_push_section (w, ".debug_loc", 0);
964 sprintf (label, ".Lloclist_%d", w->loclist_index ++ );
965 emit_label (w, label);
967 emit_pointer_value (w, loclist_begin_addr);
968 emit_pointer_value (w, loclist_end_addr);
969 emit_byte (w, expr_len % 256);
970 emit_byte (w, expr_len / 256);
971 emit_bytes (w, expr, expr_len);
973 emit_pointer_value (w, NULL);
974 emit_pointer_value (w, NULL);
976 emit_pop_section (w);
977 emit_symbol_diff (w, label, ".Ldebug_loc_start", 0);
981 * MonoDisHelper->tokener doesn't take an IP argument, and we can't add one since
982 * it is a public header.
984 static const guint8 *token_handler_ip;
987 token_handler (MonoDisHelper *dh, MonoMethod *method, guint32 token)
992 MonoClassField *field;
993 gpointer data = NULL;
995 if (method->wrapper_type)
996 data = mono_method_get_wrapper_data (method, token);
998 switch (*token_handler_ip) {
1002 if (method->wrapper_type)
1005 klass = mono_class_get_full (method->klass->image, token, NULL);
1006 res = g_strdup_printf ("<%s>", klass->name);
1011 if (method->wrapper_type)
1014 cmethod = mono_get_method_full (method->klass->image, token, NULL, NULL);
1015 desc = mono_method_full_name (cmethod, TRUE);
1016 res = g_strdup_printf ("<%s>", desc);
1020 if (method->wrapper_type) {
1021 desc = mono_signature_get_desc (data, FALSE);
1022 res = g_strdup_printf ("<%s>", desc);
1025 res = g_strdup_printf ("<0x%08x>", token);
1032 if (method->wrapper_type)
1035 field = mono_field_from_token (method->klass->image, token, &klass, NULL);
1036 desc = mono_field_full_name (field);
1037 res = g_strdup_printf ("<%s>", desc);
1041 res = g_strdup_printf ("<0x%08x>", token);
1051 * Produce a disassembled form of the IL instruction at IP. This is an extension
1052 * of mono_disasm_code_one () which can disasm tokens, handle wrapper methods, and
1053 * CEE_MONO_ opcodes.
1056 disasm_ins (MonoMethod *method, const guchar *ip, const guint8 **endip)
1060 MonoMethodHeader *header = mono_method_get_header (method);
1062 memset (&dh, 0, sizeof (dh));
1064 dh.label_format = "IL_%04x: ";
1065 dh.label_target = "IL_%04x";
1066 dh.tokener = token_handler;
1068 token_handler_ip = ip;
1069 if (*ip == MONO_CUSTOM_PREFIX) {
1074 case CEE_MONO_ICALL: {
1075 MonoJitICallInfo *info;
1077 token = read32 (ip + 2);
1078 data = mono_method_get_wrapper_data (method, token);
1079 info = mono_find_jit_icall_by_addr (data);
1082 dis = g_strdup_printf ("IL_%04x: mono_icall <%s>", (int)(ip - header->code), info->name);
1086 case CEE_MONO_CLASSCONST: {
1087 token = read32 (ip + 2);
1088 data = mono_method_get_wrapper_data (method, token);
1090 dis = g_strdup_printf ("IL_%04x: mono_classconst <%s>", (int)(ip - header->code), ((MonoClass*)data)->name);
1095 dis = mono_disasm_code_one (&dh, method, ip, &ip);
1098 dis = mono_disasm_code_one (&dh, method, ip, &ip);
1100 token_handler_ip = NULL;
1107 il_offset_from_address (MonoMethod *method, MonoDebugMethodJitInfo *jit,
1108 guint32 native_offset)
1112 if (!jit->line_numbers)
1115 for (i = jit->num_line_numbers - 1; i >= 0; i--) {
1116 MonoDebugLineNumberEntry lne = jit->line_numbers [i];
1118 if (lne.native_offset <= native_offset)
1119 return lne.il_offset;
1125 static int max_special_addr_diff = 0;
1128 emit_advance_op (MonoDwarfWriter *w, int line_diff, int addr_diff)
1132 /* Use a special opcode if possible */
1133 if (line_diff - LINE_BASE >= 0 && line_diff - LINE_BASE < LINE_RANGE) {
1134 if (max_special_addr_diff == 0)
1135 max_special_addr_diff = (255 - OPCODE_BASE) / LINE_RANGE;
1137 if (addr_diff > max_special_addr_diff && (addr_diff < 2 * max_special_addr_diff)) {
1138 emit_byte (w, DW_LNS_const_add_pc);
1139 addr_diff -= max_special_addr_diff;
1142 opcode = (line_diff - LINE_BASE) + (LINE_RANGE * addr_diff) + OPCODE_BASE;
1148 emit_byte (w, opcode);
1150 emit_byte (w, DW_LNS_advance_line);
1151 emit_sleb128 (w, line_diff);
1152 emit_byte (w, DW_LNS_advance_pc);
1153 emit_sleb128 (w, addr_diff);
1154 emit_byte (w, DW_LNS_copy);
1159 compare_lne (MonoDebugLineNumberEntry *a, MonoDebugLineNumberEntry *b)
1161 if (a->native_offset == b->native_offset)
1162 return a->il_offset - b->il_offset;
1164 return a->native_offset - b->native_offset;
1168 emit_line_number_info (MonoDwarfWriter *w, MonoMethod *method, guint8 *code,
1169 guint32 code_size, MonoDebugMethodJitInfo *debug_info)
1171 guint32 prev_line = 0;
1172 guint32 prev_native_offset = 0;
1173 int i, file_index, il_offset, prev_il_offset;
1174 gboolean first = TRUE;
1175 MonoDebugSourceLocation *loc;
1176 char *prev_file_name = NULL;
1177 MonoMethodHeader *header = mono_method_get_header (method);
1178 MonoDebugMethodInfo *minfo;
1180 int *native_to_il_offset = NULL;
1183 // FIXME: The set_address op below only works with xdebug
1186 minfo = mono_debug_lookup_method (method);
1188 /* Compute the native->IL offset mapping */
1190 #ifndef _EGLIB_MAJOR
1191 ln_array = g_array_sized_new (FALSE, FALSE, sizeof (MonoDebugLineNumberEntry),
1192 debug_info->num_line_numbers);
1193 g_array_append_vals (ln_array, debug_info->line_numbers, debug_info->num_line_numbers);
1194 g_array_sort (ln_array, (GCompareFunc)compare_lne);
1195 native_to_il_offset = g_new0 (int, code_size + 1);
1197 for (i = 0; i < debug_info->num_line_numbers; ++i) {
1199 MonoDebugLineNumberEntry lne = g_array_index (ln_array, MonoDebugLineNumberEntry, i);
1202 for (j = 0; j < lne.native_offset; ++j)
1203 native_to_il_offset [j] = -1;
1206 if (i < debug_info->num_line_numbers - 1) {
1207 MonoDebugLineNumberEntry lne_next = g_array_index (ln_array, MonoDebugLineNumberEntry, i + 1);
1209 for (j = lne.native_offset; j < lne_next.native_offset; ++j)
1210 native_to_il_offset [j] = lne.il_offset;
1212 for (j = lne.native_offset; j < code_size; ++j)
1213 native_to_il_offset [j] = lne.il_offset;
1216 g_array_free (ln_array, TRUE);
1220 prev_il_offset = -1;
1222 for (i = 0; i < code_size; ++i) {
1226 if (!debug_info->line_numbers)
1229 if (native_to_il_offset)
1230 il_offset = native_to_il_offset [i];
1232 il_offset = il_offset_from_address (method, debug_info, i);
1234 il_offset = il_offset_from_address (method, debug_info, i);
1236 g_assert (il_offset == native_to_il_offset [i]);
1239 il_offset = native_to_il_offset [i];
1243 if (il_offset == prev_il_offset)
1246 prev_il_offset = il_offset;
1248 loc = mono_debug_symfile_lookup_location (minfo, il_offset);
1251 int line_diff = (gint32)loc->row - (gint32)prev_line;
1252 int addr_diff = i - prev_native_offset;
1255 emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
1258 emit_byte (w, sizeof (gpointer) + 1);
1259 emit_byte (w, DW_LNE_set_address);
1260 emit_pointer_value (w, code);
1263 * The prolog+initlocals region does not have a line number, this
1264 * makes them belong to the first line of the method.
1266 emit_byte (w, DW_LNS_advance_line);
1267 emit_sleb128 (w, (gint32)loc->row - (gint32)prev_line);
1268 prev_line = loc->row;
1271 if (loc->row != prev_line) {
1272 if (!prev_file_name || strcmp (loc->source_file, prev_file_name) != 0) {
1273 /* Add an entry to the file table */
1274 /* FIXME: Avoid duplicates */
1275 file_index = emit_line_number_file_name (w, loc->source_file, 0, 0);
1276 g_free (prev_file_name);
1277 prev_file_name = g_strdup (loc->source_file);
1279 emit_byte (w, DW_LNS_set_file);
1280 emit_uleb128 (w, file_index);
1281 emit_byte (w, DW_LNS_copy);
1284 //printf ("X: %p(+0x%x) %d %s:%d(+%d)\n", code + i, addr_diff, loc->il_offset, loc->source_file, loc->row, line_diff);
1286 emit_advance_op (w, line_diff, addr_diff);
1288 prev_line = loc->row;
1289 prev_native_offset = i;
1297 g_free (prev_file_name);
1300 emit_byte (w, DW_LNS_advance_pc);
1301 emit_sleb128 (w, code_size - prev_native_offset);
1302 emit_byte (w, DW_LNS_copy);
1306 emit_byte (w, DW_LNE_end_sequence);
1308 /* No debug info, XDEBUG mode */
1310 const guint8 *ip = header->code;
1311 int prev_line, prev_native_offset;
1315 * Emit the IL code into a temporary file and emit line number info
1316 * referencing that file.
1319 name = mono_method_full_name (method, TRUE);
1320 fprintf (w->il_file, "// %s\n", name);
1321 w->il_file_line_index ++;
1324 il_to_line = g_new0 (int, header->code_size);
1326 emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
1328 emit_byte (w, sizeof (gpointer) + 1);
1329 emit_byte (w, DW_LNE_set_address);
1330 emit_pointer_value (w, code);
1332 // FIXME: Optimize this
1333 while (ip < header->code + header->code_size) {
1334 int il_offset = ip - header->code;
1337 w->il_file_line_index ++;
1339 dis = disasm_ins (method, ip, &ip);
1340 fprintf (w->il_file, "%s\n", dis);
1343 il_to_line [il_offset] = w->il_file_line_index;
1346 /* Emit line number info */
1348 prev_native_offset = 0;
1349 for (i = 0; i < debug_info->num_line_numbers; ++i) {
1350 MonoDebugLineNumberEntry *lne = &debug_info->line_numbers [i];
1353 if (lne->il_offset >= header->code_size)
1355 line = il_to_line [lne->il_offset];
1358 * This seems to happen randomly, it looks like il_offset points
1359 * into the middle of an instruction.
1363 printf ("%s\n", mono_method_full_name (method, TRUE));
1364 printf ("%d %d\n", lne->il_offset, header->code_size);
1369 if (line - prev_line != 0) {
1370 emit_advance_op (w, line - prev_line, (gint32)lne->native_offset - prev_native_offset);
1373 prev_native_offset = lne->native_offset;
1377 emit_byte (w, DW_LNS_advance_pc);
1378 emit_sleb128 (w, code_size - prev_native_offset);
1379 emit_byte (w, DW_LNS_copy);
1383 emit_byte (w, DW_LNE_end_sequence);
1385 fflush (w->il_file);
1386 g_free (il_to_line);
1390 static MonoMethodVar*
1391 find_vmv (MonoCompile *cfg, MonoInst *ins)
1396 for (j = 0; j < cfg->num_varinfo; ++j) {
1397 if (cfg->varinfo [j] == ins)
1401 if (j < cfg->num_varinfo) {
1402 return MONO_VARINFO (cfg, j);
1410 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)
1413 MonoMethodSignature *sig;
1414 MonoMethodHeader *header;
1415 char **names, **tdies, **local_tdies;
1422 emit_section_change (w, ".debug_info", 0);
1424 sig = mono_method_signature (method);
1425 header = mono_method_get_header (method);
1427 /* Parameter types */
1428 tdies = g_new0 (char *, sig->param_count + sig->hasthis);
1429 for (i = 0; i < sig->param_count + sig->hasthis; ++i) {
1432 if (i == 0 && sig->hasthis) {
1433 t = &method->klass->this_arg;
1435 t = sig->params [i - sig->hasthis];
1442 local_tdies = g_new0 (char *, header->num_locals);
1443 for (i = 0; i < header->num_locals; ++i) {
1444 emit_type (w, header->locals [i]);
1448 names = g_new0 (char *, sig->param_count);
1449 mono_method_get_param_names (method, (const char **) names);
1451 emit_uleb128 (w, ABBREV_SUBPROGRAM);
1452 name = mono_method_full_name (method, FALSE);
1453 emit_string (w, name);
1456 emit_pointer_unaligned (w, start_symbol);
1457 emit_pointer_unaligned (w, end_symbol);
1459 emit_pointer_value (w, code);
1460 emit_pointer_value (w, code + code_size);
1464 emit_byte (w, DW_OP_breg6);
1468 for (i = 0; i < sig->param_count + sig->hasthis; ++i) {
1469 MonoInst *arg = args ? args [i] : NULL;
1472 char pname_buf [128];
1473 MonoMethodVar *vmv = NULL;
1474 gboolean need_loclist = FALSE;
1476 vmv = find_vmv (cfg, arg);
1477 if (code && vmv && (vmv->live_range_start || vmv->live_range_end))
1478 need_loclist = TRUE;
1480 if (i == 0 && sig->hasthis) {
1481 if (method->klass->valuetype)
1482 t = &method->klass->this_arg;
1484 t = &mono_defaults.object_class->byval_arg;
1487 t = sig->params [i - sig->hasthis];
1488 pname = names [i - sig->hasthis];
1491 emit_uleb128 (w, need_loclist ? ABBREV_PARAM_LOCLIST : ABBREV_PARAM);
1493 if (pname[0] == '\0') {
1494 sprintf (pname_buf, "param%d", i - sig->hasthis);
1497 emit_string (w, pname);
1499 if (!arg || arg->flags & MONO_INST_IS_DEAD)
1500 emit_var_type (w, &mono_defaults.int32_class->byval_arg);
1502 emit_var_type (w, t);
1505 encode_var_location (w, arg, p, &p);
1507 vmv->live_range_start = 0;
1508 if (vmv->live_range_end == 0)
1509 /* FIXME: Uses made in calls are not recorded */
1510 vmv->live_range_end = code_size;
1511 emit_loclist (w, arg, code + vmv->live_range_start, code + vmv->live_range_end, buf, p - buf);
1513 emit_byte (w, p - buf);
1514 emit_bytes (w, buf, p - buf);
1520 num_locals = mono_debug_lookup_locals (method, &local_names, &local_indexes);
1522 for (i = 0; i < header->num_locals; ++i) {
1523 MonoInst *ins = locals [i];
1524 char name_buf [128];
1526 MonoMethodVar *vmv = NULL;
1527 gboolean need_loclist = FALSE;
1529 /* ins->dreg no longer contains the original vreg */
1530 vmv = find_vmv (cfg, ins);
1532 if (vmv->live_range_start) {
1533 /* This variable has a precise live range */
1534 need_loclist = TRUE;
1538 emit_uleb128 (w, need_loclist ? ABBREV_VARIABLE_LOCLIST : ABBREV_VARIABLE);
1540 for (j = 0; j < num_locals; ++j)
1541 if (local_indexes [j] == i)
1543 if (j < num_locals) {
1544 emit_string (w, local_names [j]);
1546 sprintf (name_buf, "V_%d", i);
1547 emit_string (w, name_buf);
1550 if (!ins || ins->flags & MONO_INST_IS_DEAD)
1551 emit_var_type (w, &mono_defaults.int32_class->byval_arg);
1553 emit_var_type (w, header->locals [i]);
1556 encode_var_location (w, ins, p, &p);
1559 if (vmv->live_range_end == 0)
1560 /* FIXME: Uses made in calls are not recorded */
1561 vmv->live_range_end = code_size;
1562 emit_loclist (w, ins, code + vmv->live_range_start, code + vmv->live_range_end, buf, p - buf);
1564 emit_byte (w, p - buf);
1565 emit_bytes (w, buf, p - buf);
1569 g_free (local_names);
1570 g_free (local_indexes);
1572 /* Subprogram end */
1573 emit_uleb128 (w, 0x0);
1577 /* Emit unwind info */
1579 emit_fde (w, w->fde_index, start_symbol, end_symbol, code, code_size, unwind_info, TRUE);
1583 /* Emit line number info */
1584 if (code && debug_info)
1585 emit_line_number_info (w, method, code, code_size, debug_info);
1591 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)
1593 emit_section_change (w, ".debug_info", 0);
1596 emit_uleb128 (w, ABBREV_SUBPROGRAM);
1597 emit_string (w, tramp_name);
1598 emit_pointer_value (w, code);
1599 emit_pointer_value (w, code + code_size);
1602 emit_byte (w, DW_OP_breg6);
1605 /* Subprogram end */
1606 emit_uleb128 (w, 0x0);
1608 /* Emit unwind info */
1609 emit_fde (w, w->fde_index, start_symbol, end_symbol, code, code_size, unwind_info, FALSE);