[2019-12] [jit] Avoid passing a vtable argument to DIM methods when making calls...
[mono-project.git] / mono / mini / dwarfwriter.c
blobbf2ff736feb33f055ca902f1638bee5d350b7ea5
1 /**
2 * \file
3 * Creation of DWARF debug information
5 * Author:
6 * Zoltan Varga (vargaz@gmail.com)
8 * (C) 2008-2009 Novell, Inc.
9 */
11 #include "config.h"
12 #include <mono/utils/mono-compiler.h>
14 #if !defined(DISABLE_AOT) && !defined(DISABLE_JIT)
15 #include "dwarfwriter.h"
17 #include <sys/types.h>
18 #include <ctype.h>
19 #include <string.h>
20 #ifdef HAVE_STDINT_H
21 #include <stdint.h>
22 #endif
24 #include <mono/metadata/mono-endian.h>
25 #include <mono/metadata/debug-internals.h>
26 #include <mono/metadata/abi-details.h>
28 #ifndef HOST_WIN32
29 #include <mono/utils/freebsd-elf32.h>
30 #include <mono/utils/freebsd-elf64.h>
31 #endif
33 #include <mono/utils/freebsd-dwarf.h>
35 #define DW_AT_MIPS_linkage_name 0x2007
36 #define DW_LNE_set_prologue_end 0x0a
38 typedef struct {
39 MonoMethod *method;
40 char *start_symbol, *end_symbol;
41 guint8 *code;
42 guint32 code_size;
43 } MethodLineNumberInfo;
45 struct _MonoDwarfWriter
47 MonoImageWriter *w;
48 GHashTable *class_to_die, *class_to_vtype_die, *class_to_pointer_die;
49 GHashTable *class_to_reference_die;
50 int fde_index, tdie_index, line_number_file_index, line_number_dir_index;
51 GHashTable *file_to_index, *index_to_file, *dir_to_index;
52 FILE *il_file;
53 int il_file_line_index, loclist_index;
54 GSList *cie_program;
55 FILE *fp;
56 const char *temp_prefix;
57 gboolean emit_line;
58 GSList *line_info;
59 int cur_file_index;
62 static void
63 emit_line_number_info (MonoDwarfWriter *w, MonoMethod *method,
64 char *start_symbol, char *end_symbol,
65 guint8 *code, guint32 code_size,
66 MonoDebugMethodJitInfo *debug_info);
69 * mono_dwarf_writer_create:
71 * Create a DWARF writer object. WRITER is the underlying image writer this
72 * writer will emit to. IL_FILE is the file where IL code will be dumped to for
73 * methods which have no line number info. It can be NULL.
75 MonoDwarfWriter*
76 mono_dwarf_writer_create (MonoImageWriter *writer, FILE *il_file, int il_file_start_line, gboolean emit_line_numbers)
78 MonoDwarfWriter *w = g_new0 (MonoDwarfWriter, 1);
80 w->w = writer;
81 w->il_file = il_file;
82 w->il_file_line_index = il_file_start_line;
84 w->emit_line = emit_line_numbers;
86 w->fp = mono_img_writer_get_fp (w->w);
87 w->temp_prefix = mono_img_writer_get_temp_label_prefix (w->w);
89 w->class_to_die = g_hash_table_new (NULL, NULL);
90 w->class_to_vtype_die = g_hash_table_new (NULL, NULL);
91 w->class_to_pointer_die = g_hash_table_new (NULL, NULL);
92 w->class_to_reference_die = g_hash_table_new (NULL, NULL);
93 w->cur_file_index = -1;
95 return w;
98 void
99 mono_dwarf_writer_destroy (MonoDwarfWriter *w)
101 g_free (w);
105 mono_dwarf_writer_get_il_file_line_index (MonoDwarfWriter *w)
107 return w->il_file_line_index;
110 /* Wrappers around the image writer functions */
112 static void
113 emit_section_change (MonoDwarfWriter *w, const char *section_name, int subsection_index)
115 mono_img_writer_emit_section_change (w->w, section_name, subsection_index);
118 static void
119 emit_push_section (MonoDwarfWriter *w, const char *section_name, int subsection)
121 mono_img_writer_emit_push_section (w->w, section_name, subsection);
124 static void
125 emit_pop_section (MonoDwarfWriter *w)
127 mono_img_writer_emit_pop_section (w->w);
130 static void
131 emit_label (MonoDwarfWriter *w, const char *name)
133 mono_img_writer_emit_label (w->w, name);
136 static void
137 emit_bytes (MonoDwarfWriter *w, const guint8* buf, int size)
139 mono_img_writer_emit_bytes (w->w, buf, size);
142 static void
143 emit_string (MonoDwarfWriter *w, const char *value)
145 mono_img_writer_emit_string (w->w, value);
148 static void
149 emit_line (MonoDwarfWriter *w)
151 mono_img_writer_emit_line (w->w);
154 static void
155 emit_alignment (MonoDwarfWriter *w, int size)
157 mono_img_writer_emit_alignment (w->w, size);
160 static void
161 emit_pointer_unaligned (MonoDwarfWriter *w, const char *target)
163 mono_img_writer_emit_pointer_unaligned (w->w, target);
166 static void
167 emit_pointer (MonoDwarfWriter *w, const char *target)
169 mono_img_writer_emit_pointer (w->w, target);
172 static void
173 emit_int16 (MonoDwarfWriter *w, int value)
175 mono_img_writer_emit_int16 (w->w, value);
178 static void
179 emit_int32 (MonoDwarfWriter *w, int value)
181 mono_img_writer_emit_int32 (w->w, value);
184 static void
185 emit_symbol_diff (MonoDwarfWriter *w, const char *end, const char* start, int offset)
187 mono_img_writer_emit_symbol_diff (w->w, end, start, offset);
190 static void
191 emit_byte (MonoDwarfWriter *w, guint8 val)
193 mono_img_writer_emit_byte (w->w, val);
196 static void
197 emit_escaped_string (MonoDwarfWriter *w, char *value)
199 int i, len;
201 len = strlen (value);
202 for (i = 0; i < len; ++i) {
203 char c = value [i];
204 if (!(isalnum (c))) {
205 switch (c) {
206 case '_':
207 case '-':
208 case ':':
209 case '.':
210 case ',':
211 case '/':
212 case '<':
213 case '>':
214 case '`':
215 case '(':
216 case ')':
217 case '[':
218 case ']':
219 break;
220 default:
221 value [i] = '_';
222 break;
226 mono_img_writer_emit_string (w->w, value);
229 static G_GNUC_UNUSED void
230 emit_uleb128 (MonoDwarfWriter *w, guint32 value)
232 do {
233 guint8 b = value & 0x7f;
234 value >>= 7;
235 if (value != 0) /* more bytes to come */
236 b |= 0x80;
237 emit_byte (w, b);
238 } while (value);
241 static G_GNUC_UNUSED void
242 emit_sleb128 (MonoDwarfWriter *w, gint64 value)
244 gboolean more = 1;
245 gboolean negative = (value < 0);
246 guint32 size = 64;
247 guint8 byte;
249 while (more) {
250 byte = value & 0x7f;
251 value >>= 7;
252 /* the following is unnecessary if the
253 * implementation of >>= uses an arithmetic rather
254 * than logical shift for a signed left operand
256 if (negative)
257 /* sign extend */
258 value |= - ((gint64)1 <<(size - 7));
259 /* sign bit of byte is second high order bit (0x40) */
260 if ((value == 0 && !(byte & 0x40)) ||
261 (value == -1 && (byte & 0x40)))
262 more = 0;
263 else
264 byte |= 0x80;
265 emit_byte (w, byte);
269 static G_GNUC_UNUSED void
270 encode_uleb128 (guint32 value, guint8 *buf, guint8 **endbuf)
272 guint8 *p = buf;
274 do {
275 guint8 b = value & 0x7f;
276 value >>= 7;
277 if (value != 0) /* more bytes to come */
278 b |= 0x80;
279 *p ++ = b;
280 } while (value);
282 *endbuf = p;
285 static G_GNUC_UNUSED void
286 encode_sleb128 (gint32 value, guint8 *buf, guint8 **endbuf)
288 gboolean more = 1;
289 gboolean negative = (value < 0);
290 guint32 size = 32;
291 guint8 byte;
292 guint8 *p = buf;
294 while (more) {
295 byte = value & 0x7f;
296 value >>= 7;
297 /* the following is unnecessary if the
298 * implementation of >>= uses an arithmetic rather
299 * than logical shift for a signed left operand
301 if (negative)
302 /* sign extend */
303 value |= - (1 <<(size - 7));
304 /* sign bit of byte is second high order bit (0x40) */
305 if ((value == 0 && !(byte & 0x40)) ||
306 (value == -1 && (byte & 0x40)))
307 more = 0;
308 else
309 byte |= 0x80;
310 *p ++= byte;
313 *endbuf = p;
316 static void
317 emit_dwarf_abbrev (MonoDwarfWriter *w, int code, int tag, gboolean has_child,
318 int *attrs, int attrs_len)
320 int i;
322 emit_uleb128 (w, code);
323 emit_uleb128 (w, tag);
324 emit_byte (w, has_child);
326 for (i = 0; i < attrs_len; i++)
327 emit_uleb128 (w, attrs [i]);
328 emit_uleb128 (w, 0);
329 emit_uleb128 (w, 0);
332 static void
333 emit_cie (MonoDwarfWriter *w)
335 emit_section_change (w, ".debug_frame", 0);
337 emit_alignment (w, 8);
339 /* Emit a CIE */
340 emit_symbol_diff (w, ".Lcie0_end", ".Lcie0_start", 0); /* length */
341 emit_label (w, ".Lcie0_start");
342 emit_int32 (w, 0xffffffff); /* CIE id */
343 emit_byte (w, 3); /* version */
344 emit_string (w, ""); /* augmention */
345 emit_sleb128 (w, 1); /* code alignment factor */
346 emit_sleb128 (w, mono_unwind_get_dwarf_data_align ()); /* data alignment factor */
347 emit_uleb128 (w, mono_unwind_get_dwarf_pc_reg ());
349 w->cie_program = w->cie_program;
350 if (w->cie_program) {
351 guint32 uw_info_len;
352 guint8 *uw_info = mono_unwind_ops_encode (w->cie_program, &uw_info_len);
353 emit_bytes (w, uw_info, uw_info_len);
354 g_free (uw_info);
357 emit_alignment (w, sizeof (target_mgreg_t));
358 emit_label (w, ".Lcie0_end");
361 static void
362 emit_pointer_value (MonoDwarfWriter *w, gpointer ptr)
364 gssize val = (gssize)ptr;
365 emit_bytes (w, (guint8*)&val, sizeof (target_mgreg_t));
368 static void
369 emit_fde (MonoDwarfWriter *w, int fde_index, char *start_symbol, char *end_symbol,
370 guint8 *code, guint32 code_size, GSList *unwind_ops, gboolean use_cie)
372 char symbol1 [128];
373 char symbol2 [128];
374 GSList *l;
375 guint8 *uw_info;
376 guint32 uw_info_len;
378 emit_section_change (w, ".debug_frame", 0);
380 sprintf (symbol1, ".Lfde%d_start", fde_index);
381 sprintf (symbol2, ".Lfde%d_end", fde_index);
382 emit_symbol_diff (w, symbol2, symbol1, 0); /* length */
383 emit_label (w, symbol1);
384 emit_int32 (w, 0); /* CIE_pointer */
385 if (start_symbol) {
386 emit_pointer (w, start_symbol); /* initial_location */
387 if (end_symbol)
388 emit_symbol_diff (w, end_symbol, start_symbol, 0); /* address_range */
389 else {
390 g_assert (code_size);
391 emit_int32 (w, code_size);
393 } else {
394 emit_pointer_value (w, code);
395 emit_int32 (w, code_size);
397 #if TARGET_SIZEOF_VOID_P == 8
398 /* Upper 32 bits of code size */
399 emit_int32 (w, 0);
400 #endif
402 l = unwind_ops;
403 if (w->cie_program) {
404 // FIXME: Check that the ops really begin with the CIE program */
405 int i;
407 for (i = 0; i < g_slist_length (w->cie_program); ++i)
408 if (l)
409 l = l->next;
412 /* Convert the list of MonoUnwindOps to the format used by DWARF */
413 uw_info = mono_unwind_ops_encode_full (l, &uw_info_len, FALSE);
414 emit_bytes (w, uw_info, uw_info_len);
415 g_free (uw_info);
417 emit_alignment (w, sizeof (target_mgreg_t));
418 emit_label (w, symbol2);
421 /* Abbrevations */
422 #define ABBREV_COMPILE_UNIT 1
423 #define ABBREV_SUBPROGRAM 2
424 #define ABBREV_PARAM 3
425 #define ABBREV_BASE_TYPE 4
426 #define ABBREV_STRUCT_TYPE 5
427 #define ABBREV_DATA_MEMBER 6
428 #define ABBREV_TYPEDEF 7
429 #define ABBREV_ENUM_TYPE 8
430 #define ABBREV_ENUMERATOR 9
431 #define ABBREV_NAMESPACE 10
432 #define ABBREV_VARIABLE 11
433 #define ABBREV_VARIABLE_LOCLIST 12
434 #define ABBREV_POINTER_TYPE 13
435 #define ABBREV_REFERENCE_TYPE 14
436 #define ABBREV_PARAM_LOCLIST 15
437 #define ABBREV_INHERITANCE 16
438 #define ABBREV_STRUCT_TYPE_NOCHILDREN 17
439 #define ABBREV_TRAMP_SUBPROGRAM 18
441 static int compile_unit_attr [] = {
442 DW_AT_producer ,DW_FORM_string,
443 DW_AT_name ,DW_FORM_string,
444 DW_AT_comp_dir ,DW_FORM_string,
445 DW_AT_language ,DW_FORM_data1,
446 DW_AT_low_pc ,DW_FORM_addr,
447 DW_AT_high_pc ,DW_FORM_addr,
448 DW_AT_stmt_list ,DW_FORM_data4
451 static int subprogram_attr [] = {
452 DW_AT_name , DW_FORM_string,
453 DW_AT_MIPS_linkage_name, DW_FORM_string,
454 DW_AT_decl_file , DW_FORM_udata,
455 DW_AT_decl_line , DW_FORM_udata,
456 #ifndef TARGET_IOS
457 DW_AT_description , DW_FORM_string,
458 #endif
459 DW_AT_low_pc , DW_FORM_addr,
460 DW_AT_high_pc , DW_FORM_addr,
461 DW_AT_frame_base , DW_FORM_block1
464 static int tramp_subprogram_attr [] = {
465 DW_AT_name , DW_FORM_string,
466 DW_AT_low_pc , DW_FORM_addr,
467 DW_AT_high_pc , DW_FORM_addr,
470 static int param_attr [] = {
471 DW_AT_name, DW_FORM_string,
472 DW_AT_type, DW_FORM_ref4,
473 DW_AT_location, DW_FORM_block1
476 static int param_loclist_attr [] = {
477 DW_AT_name, DW_FORM_string,
478 DW_AT_type, DW_FORM_ref4,
479 DW_AT_location, DW_FORM_data4
482 static int base_type_attr [] = {
483 DW_AT_byte_size, DW_FORM_data1,
484 DW_AT_encoding, DW_FORM_data1,
485 DW_AT_name, DW_FORM_string
488 static int struct_type_attr [] = {
489 DW_AT_name, DW_FORM_string,
490 DW_AT_byte_size, DW_FORM_udata,
493 static int data_member_attr [] = {
494 DW_AT_name, DW_FORM_string,
495 DW_AT_type, DW_FORM_ref4,
496 DW_AT_data_member_location, DW_FORM_block1
499 static int typedef_attr [] = {
500 DW_AT_name, DW_FORM_string,
501 DW_AT_type, DW_FORM_ref4
504 static int pointer_type_attr [] = {
505 DW_AT_type, DW_FORM_ref4,
508 static int reference_type_attr [] = {
509 DW_AT_type, DW_FORM_ref4,
512 static int enum_type_attr [] = {
513 DW_AT_name, DW_FORM_string,
514 DW_AT_byte_size, DW_FORM_udata,
515 DW_AT_type, DW_FORM_ref4,
518 static int enumerator_attr [] = {
519 DW_AT_name, DW_FORM_string,
520 DW_AT_const_value, DW_FORM_sdata,
523 static int namespace_attr [] = {
524 DW_AT_name, DW_FORM_string,
527 static int variable_attr [] = {
528 DW_AT_name, DW_FORM_string,
529 DW_AT_type, DW_FORM_ref4,
530 DW_AT_location, DW_FORM_block1
533 static int variable_loclist_attr [] = {
534 DW_AT_name, DW_FORM_string,
535 DW_AT_type, DW_FORM_ref4,
536 DW_AT_location, DW_FORM_data4
539 static int inheritance_attr [] = {
540 DW_AT_type, DW_FORM_ref4,
541 DW_AT_data_member_location, DW_FORM_block1
544 typedef struct DwarfBasicType {
545 const char *die_name, *name;
546 int type;
547 int size;
548 int encoding;
549 } DwarfBasicType;
551 static DwarfBasicType basic_types [] = {
552 { ".LDIE_I1", "sbyte", MONO_TYPE_I1, 1, DW_ATE_signed },
553 { ".LDIE_U1", "byte", MONO_TYPE_U1, 1, DW_ATE_unsigned },
554 { ".LDIE_I2", "short", MONO_TYPE_I2, 2, DW_ATE_signed },
555 { ".LDIE_U2", "ushort", MONO_TYPE_U2, 2, DW_ATE_unsigned },
556 { ".LDIE_I4", "int", MONO_TYPE_I4, 4, DW_ATE_signed },
557 { ".LDIE_U4", "uint", MONO_TYPE_U4, 4, DW_ATE_unsigned },
558 { ".LDIE_I8", "long", MONO_TYPE_I8, 8, DW_ATE_signed },
559 { ".LDIE_U8", "ulong", MONO_TYPE_U8, 8, DW_ATE_unsigned },
560 { ".LDIE_I", "intptr", MONO_TYPE_I, TARGET_SIZEOF_VOID_P, DW_ATE_signed },
561 { ".LDIE_U", "uintptr", MONO_TYPE_U, TARGET_SIZEOF_VOID_P, DW_ATE_unsigned },
562 { ".LDIE_R4", "float", MONO_TYPE_R4, 4, DW_ATE_float },
563 { ".LDIE_R8", "double", MONO_TYPE_R8, 8, DW_ATE_float },
564 { ".LDIE_BOOLEAN", "boolean", MONO_TYPE_BOOLEAN, 1, DW_ATE_boolean },
565 { ".LDIE_CHAR", "char", MONO_TYPE_CHAR, 2, DW_ATE_unsigned_char },
566 { ".LDIE_STRING", "string", MONO_TYPE_STRING, sizeof (target_mgreg_t), DW_ATE_address },
567 { ".LDIE_OBJECT", "object", MONO_TYPE_OBJECT, sizeof (target_mgreg_t), DW_ATE_address },
568 { ".LDIE_SZARRAY", "object", MONO_TYPE_SZARRAY, sizeof (target_mgreg_t), DW_ATE_address },
571 /* Constants for encoding line number special opcodes */
572 #define OPCODE_BASE 13
573 #define LINE_BASE -5
574 #define LINE_RANGE 14
576 static int
577 get_line_number_file_name (MonoDwarfWriter *w, const char *name)
579 int index;
581 g_assert (w->file_to_index);
582 index = GPOINTER_TO_UINT (g_hash_table_lookup (w->file_to_index, name));
583 g_assert (index > 0);
584 return index - 1;
587 static int
588 add_line_number_file_name (MonoDwarfWriter *w, const char *name,
589 gint64 last_mod_time, gint64 file_size)
591 int index;
592 char *copy;
594 if (!w->file_to_index) {
595 w->file_to_index = g_hash_table_new (g_str_hash, g_str_equal);
596 w->index_to_file = g_hash_table_new (NULL, NULL);
599 index = GPOINTER_TO_UINT (g_hash_table_lookup (w->file_to_index, name));
600 if (index > 0)
601 return index - 1;
602 index = w->line_number_file_index;
603 w->line_number_file_index ++;
604 copy = g_strdup (name);
605 g_hash_table_insert (w->file_to_index, copy, GUINT_TO_POINTER (index + 1));
606 g_hash_table_insert (w->index_to_file, GUINT_TO_POINTER (index + 1), copy);
608 return index;
611 char *
612 mono_dwarf_escape_path (const char *name)
614 if (strchr (name, '\\')) {
615 char *s;
616 int len, i, j;
618 len = strlen (name);
619 s = (char *)g_malloc0 ((len + 1) * 2);
620 j = 0;
621 for (i = 0; i < len; ++i) {
622 if (name [i] == '\\') {
623 s [j ++] = '\\';
624 s [j ++] = '\\';
625 } else {
626 s [j ++] = name [i];
629 return s;
631 return g_strdup (name);
634 static void
635 emit_all_line_number_info (MonoDwarfWriter *w)
637 int i;
638 GHashTable *dir_to_index, *index_to_dir;
639 GSList *l;
640 GSList *info_list;
642 add_line_number_file_name (w, "<unknown>", 0, 0);
644 /* Collect files */
645 info_list = g_slist_reverse (w->line_info);
646 for (l = info_list; l; l = l->next) {
647 MethodLineNumberInfo *info = (MethodLineNumberInfo *)l->data;
648 MonoDebugMethodInfo *minfo;
649 GPtrArray *source_file_list;
651 // FIXME: Free stuff
652 minfo = mono_debug_lookup_method (info->method);
653 if (!minfo)
654 continue;
656 mono_debug_get_seq_points (minfo, NULL, &source_file_list, NULL, NULL, NULL);
657 for (i = 0; i < source_file_list->len; ++i) {
658 MonoDebugSourceInfo *sinfo = (MonoDebugSourceInfo *)g_ptr_array_index (source_file_list, i);
659 add_line_number_file_name (w, sinfo->source_file, 0, 0);
663 /* Preprocess files */
664 dir_to_index = g_hash_table_new (g_str_hash, g_str_equal);
665 index_to_dir = g_hash_table_new (NULL, NULL);
666 for (i = 0; i < w->line_number_file_index; ++i) {
667 char *name = (char *)g_hash_table_lookup (w->index_to_file, GUINT_TO_POINTER (i + 1));
668 char *copy;
669 int dir_index = 0;
671 if (g_path_is_absolute (name)) {
672 char *dir = g_path_get_dirname (name);
674 dir_index = GPOINTER_TO_UINT (g_hash_table_lookup (dir_to_index, dir));
675 if (dir_index == 0) {
676 dir_index = w->line_number_dir_index;
677 w->line_number_dir_index ++;
678 copy = g_strdup (dir);
679 g_hash_table_insert (dir_to_index, copy, GUINT_TO_POINTER (dir_index + 1));
680 g_hash_table_insert (index_to_dir, GUINT_TO_POINTER (dir_index + 1), copy);
681 } else {
682 dir_index --;
685 g_free (dir);
689 /* Line number info header */
690 emit_section_change (w, ".debug_line", 0);
691 emit_label (w, ".Ldebug_line_section_start");
692 emit_label (w, ".Ldebug_line_start");
693 emit_symbol_diff (w, ".Ldebug_line_end", ".", -4); /* length */
694 emit_int16 (w, 0x2); /* version */
695 emit_symbol_diff (w, ".Ldebug_line_header_end", ".", -4); /* header_length */
696 emit_byte (w, 1); /* minimum_instruction_length */
697 emit_byte (w, 1); /* default_is_stmt */
698 emit_byte (w, LINE_BASE); /* line_base */
699 emit_byte (w, LINE_RANGE); /* line_range */
700 emit_byte (w, OPCODE_BASE); /* opcode_base */
701 emit_byte (w, 0); /* standard_opcode_lengths */
702 emit_byte (w, 1);
703 emit_byte (w, 1);
704 emit_byte (w, 1);
705 emit_byte (w, 1);
706 emit_byte (w, 0);
707 emit_byte (w, 0);
708 emit_byte (w, 0);
709 emit_byte (w, 1);
710 emit_byte (w, 0);
711 emit_byte (w, 0);
712 emit_byte (w, 1);
714 /* Includes */
715 emit_section_change (w, ".debug_line", 0);
716 for (i = 0; i < w->line_number_dir_index; ++i) {
717 char *dir = (char *)g_hash_table_lookup (index_to_dir, GUINT_TO_POINTER (i + 1));
719 emit_string (w, mono_dwarf_escape_path (dir));
721 /* End of Includes */
722 emit_byte (w, 0);
724 /* Files */
725 for (i = 0; i < w->line_number_file_index; ++i) {
726 char *name = (char *)g_hash_table_lookup (w->index_to_file, GUINT_TO_POINTER (i + 1));
727 char *basename = NULL, *dir;
728 int dir_index = 0;
730 if (g_path_is_absolute (name)) {
731 dir = g_path_get_dirname (name);
733 dir_index = GPOINTER_TO_UINT (g_hash_table_lookup (dir_to_index, dir));
734 basename = g_path_get_basename (name);
737 if (basename)
738 emit_string (w, basename);
739 else
740 emit_string (w, mono_dwarf_escape_path (name));
741 emit_uleb128 (w, dir_index);
742 emit_byte (w, 0);
743 emit_byte (w, 0);
746 /* End of Files */
747 emit_byte (w, 0);
749 emit_label (w, ".Ldebug_line_header_end");
751 /* Emit line number table */
752 for (l = info_list; l; l = l->next) {
753 MethodLineNumberInfo *info = (MethodLineNumberInfo *)l->data;
754 MonoDebugMethodJitInfo *dmji;
756 dmji = mono_debug_find_method (info->method, mono_domain_get ());
757 if (!dmji)
758 continue;
759 emit_line_number_info (w, info->method, info->start_symbol, info->end_symbol, info->code, info->code_size, dmji);
760 mono_debug_free_method_jit_info (dmji);
762 g_slist_free (info_list);
764 emit_byte (w, 0);
765 emit_byte (w, 1);
766 emit_byte (w, DW_LNE_end_sequence);
768 emit_label (w, ".Ldebug_line_end");
772 * Some assemblers like apple's do not support subsections, so we can't place
773 * .Ldebug_info_end at the end of the section using subsections. Instead, we
774 * define it every time something gets added to the .debug_info section.
775 * The apple assember seems to use the last definition.
777 static void
778 emit_debug_info_end (MonoDwarfWriter *w)
780 /* This doesn't seem to work/required with recent iphone sdk versions */
781 #if 0
782 if (!mono_img_writer_subsections_supported (w->w))
783 fprintf (w->fp, "\n.set %sdebug_info_end,.\n", w->temp_prefix);
784 #endif
787 void
788 mono_dwarf_writer_emit_base_info (MonoDwarfWriter *w, const char *cu_name, GSList *base_unwind_program)
790 char *s, *build_info;
791 int i;
793 if (!w->emit_line) {
794 emit_section_change (w, ".debug_line", 0);
795 emit_label (w, ".Ldebug_line_section_start");
796 emit_label (w, ".Ldebug_line_start");
799 w->cie_program = base_unwind_program;
801 emit_section_change (w, ".debug_abbrev", 0);
802 emit_dwarf_abbrev (w, ABBREV_COMPILE_UNIT, DW_TAG_compile_unit, TRUE,
803 compile_unit_attr, G_N_ELEMENTS (compile_unit_attr));
804 emit_dwarf_abbrev (w, ABBREV_SUBPROGRAM, DW_TAG_subprogram, TRUE,
805 subprogram_attr, G_N_ELEMENTS (subprogram_attr));
806 emit_dwarf_abbrev (w, ABBREV_PARAM, DW_TAG_formal_parameter, FALSE,
807 param_attr, G_N_ELEMENTS (param_attr));
808 emit_dwarf_abbrev (w, ABBREV_PARAM_LOCLIST, DW_TAG_formal_parameter, FALSE,
809 param_loclist_attr, G_N_ELEMENTS (param_loclist_attr));
810 emit_dwarf_abbrev (w, ABBREV_BASE_TYPE, DW_TAG_base_type, FALSE,
811 base_type_attr, G_N_ELEMENTS (base_type_attr));
812 emit_dwarf_abbrev (w, ABBREV_STRUCT_TYPE, DW_TAG_class_type, TRUE,
813 struct_type_attr, G_N_ELEMENTS (struct_type_attr));
814 emit_dwarf_abbrev (w, ABBREV_STRUCT_TYPE_NOCHILDREN, DW_TAG_class_type, FALSE,
815 struct_type_attr, G_N_ELEMENTS (struct_type_attr));
816 emit_dwarf_abbrev (w, ABBREV_DATA_MEMBER, DW_TAG_member, FALSE,
817 data_member_attr, G_N_ELEMENTS (data_member_attr));
818 emit_dwarf_abbrev (w, ABBREV_TYPEDEF, DW_TAG_typedef, FALSE,
819 typedef_attr, G_N_ELEMENTS (typedef_attr));
820 emit_dwarf_abbrev (w, ABBREV_ENUM_TYPE, DW_TAG_enumeration_type, TRUE,
821 enum_type_attr, G_N_ELEMENTS (enum_type_attr));
822 emit_dwarf_abbrev (w, ABBREV_ENUMERATOR, DW_TAG_enumerator, FALSE,
823 enumerator_attr, G_N_ELEMENTS (enumerator_attr));
824 emit_dwarf_abbrev (w, ABBREV_NAMESPACE, DW_TAG_namespace, TRUE,
825 namespace_attr, G_N_ELEMENTS (namespace_attr));
826 emit_dwarf_abbrev (w, ABBREV_VARIABLE, DW_TAG_variable, FALSE,
827 variable_attr, G_N_ELEMENTS (variable_attr));
828 emit_dwarf_abbrev (w, ABBREV_VARIABLE_LOCLIST, DW_TAG_variable, FALSE,
829 variable_loclist_attr, G_N_ELEMENTS (variable_loclist_attr));
830 emit_dwarf_abbrev (w, ABBREV_POINTER_TYPE, DW_TAG_pointer_type, FALSE,
831 pointer_type_attr, G_N_ELEMENTS (pointer_type_attr));
832 emit_dwarf_abbrev (w, ABBREV_REFERENCE_TYPE, DW_TAG_reference_type, FALSE,
833 reference_type_attr, G_N_ELEMENTS (reference_type_attr));
834 emit_dwarf_abbrev (w, ABBREV_INHERITANCE, DW_TAG_inheritance, FALSE,
835 inheritance_attr, G_N_ELEMENTS (inheritance_attr));
836 emit_dwarf_abbrev (w, ABBREV_TRAMP_SUBPROGRAM, DW_TAG_subprogram, FALSE,
837 tramp_subprogram_attr, G_N_ELEMENTS (tramp_subprogram_attr));
838 emit_byte (w, 0);
840 emit_section_change (w, ".debug_info", 0);
841 emit_label (w, ".Ldebug_info_start");
842 emit_symbol_diff (w, ".Ldebug_info_end", ".Ldebug_info_begin", 0); /* length */
843 emit_label (w, ".Ldebug_info_begin");
844 emit_int16 (w, 0x2); /* DWARF version 2 */
845 emit_int32 (w, 0); /* .debug_abbrev offset */
846 emit_byte (w, sizeof (target_mgreg_t)); /* address size */
848 /* Compilation unit */
849 emit_uleb128 (w, ABBREV_COMPILE_UNIT);
850 build_info = mono_get_runtime_build_info ();
851 s = g_strdup_printf ("Mono AOT Compiler %s", build_info);
852 emit_string (w, s);
853 g_free (build_info);
854 g_free (s);
855 emit_string (w, cu_name);
856 emit_string (w, "");
857 emit_byte (w, DW_LANG_C);
858 emit_pointer_value (w, 0);
859 emit_pointer_value (w, 0);
860 /* offset into .debug_line section */
861 emit_symbol_diff (w, ".Ldebug_line_start", ".Ldebug_line_section_start", 0);
863 /* Base types */
864 for (i = 0; i < G_N_ELEMENTS (basic_types); ++i) {
865 emit_label (w, basic_types [i].die_name);
866 emit_uleb128 (w, ABBREV_BASE_TYPE);
867 emit_byte (w, basic_types [i].size);
868 emit_byte (w, basic_types [i].encoding);
869 emit_string (w, basic_types [i].name);
872 emit_debug_info_end (w);
874 /* debug_loc section */
875 emit_section_change (w, ".debug_loc", 0);
876 emit_label (w, ".Ldebug_loc_start");
878 emit_cie (w);
882 * mono_dwarf_writer_close:
884 * Finalize the emitted debugging info.
886 void
887 mono_dwarf_writer_close (MonoDwarfWriter *w)
889 emit_section_change (w, ".debug_info", 0);
890 emit_byte (w, 0); /* close COMPILE_UNIT */
891 emit_label (w, ".Ldebug_info_end");
893 if (w->emit_line)
894 emit_all_line_number_info (w);
897 static void emit_type (MonoDwarfWriter *w, MonoType *t);
898 static const char* get_type_die (MonoDwarfWriter *w, MonoType *t);
900 static const char*
901 get_class_die (MonoDwarfWriter *w, MonoClass *klass, gboolean vtype)
903 GHashTable *cache;
905 if (vtype)
906 cache = w->class_to_vtype_die;
907 else
908 cache = w->class_to_die;
910 return (const char *)g_hash_table_lookup (cache, klass);
913 /* Returns the local symbol pointing to the emitted debug info */
914 static char*
915 emit_class_dwarf_info (MonoDwarfWriter *w, MonoClass *klass, gboolean vtype)
917 char *die, *pointer_die, *reference_die;
918 char *full_name, *p;
919 gpointer iter;
920 MonoClassField *field;
921 const char *fdie;
922 int k;
923 gboolean emit_namespace = FALSE, has_children;
924 GHashTable *cache;
926 if (vtype)
927 cache = w->class_to_vtype_die;
928 else
929 cache = w->class_to_die;
931 die = (char *)g_hash_table_lookup (cache, klass);
932 if (die)
933 return die;
935 if (!((m_class_get_byval_arg (klass)->type == MONO_TYPE_CLASS) || (m_class_get_byval_arg (klass)->type == MONO_TYPE_OBJECT) || m_class_get_byval_arg (klass)->type == MONO_TYPE_GENERICINST || m_class_is_enumtype (klass) || (m_class_get_byval_arg (klass)->type == MONO_TYPE_VALUETYPE && vtype) ||
936 (m_class_get_byval_arg (klass)->type >= MONO_TYPE_BOOLEAN && m_class_get_byval_arg (klass)->type <= MONO_TYPE_R8 && !vtype)))
937 return NULL;
940 * FIXME: gdb can't handle namespaces in languages it doesn't know about.
943 if (klass->name_space && klass->name_space [0] != '\0')
944 emit_namespace = TRUE;
946 if (emit_namespace) {
947 emit_uleb128 (w, ABBREV_NAMESPACE);
948 emit_string (w, m_class_get_name_space (klass));
951 full_name = g_strdup_printf ("%s%s%s", m_class_get_name_space (klass), m_class_get_name_space (klass) ? "." : "", m_class_get_name (klass));
953 * gdb doesn't support namespaces for non-C++ dwarf objects, so use _
954 * to separate components.
956 for (p = full_name; *p; p ++)
957 if (*p == '.')
958 *p = '_';
960 die = g_strdup_printf (".LTDIE_%d", w->tdie_index);
961 pointer_die = g_strdup_printf (".LTDIE_%d_POINTER", w->tdie_index);
962 reference_die = g_strdup_printf (".LTDIE_%d_REFERENCE", w->tdie_index);
963 w->tdie_index ++;
965 g_hash_table_insert (w->class_to_pointer_die, klass, pointer_die);
966 g_hash_table_insert (w->class_to_reference_die, klass, reference_die);
967 g_hash_table_insert (cache, klass, die);
969 if (m_class_is_enumtype (klass)) {
970 int size = mono_class_value_size (mono_class_from_mono_type_internal (mono_class_enum_basetype_internal (klass)), NULL);
972 emit_label (w, die);
974 emit_uleb128 (w, ABBREV_ENUM_TYPE);
975 emit_string (w, full_name);
976 emit_uleb128 (w, size);
977 for (k = 0; k < G_N_ELEMENTS (basic_types); ++k)
978 if (basic_types [k].type == mono_class_enum_basetype_internal (klass)->type)
979 break;
980 g_assert (k < G_N_ELEMENTS (basic_types));
981 emit_symbol_diff (w, basic_types [k].die_name, ".Ldebug_info_start", 0);
983 /* Emit enum values */
984 iter = NULL;
985 while ((field = mono_class_get_fields_internal (klass, &iter))) {
986 const char *p;
987 MonoTypeEnum def_type;
989 if (!(field->type->attrs & FIELD_ATTRIBUTE_STATIC))
990 continue;
991 if (mono_field_is_deleted (field))
992 continue;
994 emit_uleb128 (w, ABBREV_ENUMERATOR);
995 emit_string (w, mono_field_get_name (field));
997 p = mono_class_get_field_default_value (field, &def_type);
998 /* len = */ mono_metadata_decode_blob_size (p, &p);
999 switch (mono_class_enum_basetype_internal (klass)->type) {
1000 case MONO_TYPE_U1:
1001 case MONO_TYPE_I1:
1002 case MONO_TYPE_BOOLEAN:
1003 emit_sleb128 (w, *p);
1004 break;
1005 case MONO_TYPE_U2:
1006 case MONO_TYPE_I2:
1007 case MONO_TYPE_CHAR:
1008 emit_sleb128 (w, read16 (p));
1009 break;
1010 case MONO_TYPE_U4:
1011 case MONO_TYPE_I4:
1012 emit_sleb128 (w, read32 (p));
1013 break;
1014 case MONO_TYPE_U8:
1015 case MONO_TYPE_I8:
1016 emit_sleb128 (w, read64 (p));
1017 break;
1018 case MONO_TYPE_I:
1019 case MONO_TYPE_U:
1020 #if TARGET_SIZEOF_VOID_P == 8
1021 emit_sleb128 (w, read64 (p));
1022 #else
1023 emit_sleb128 (w, read32 (p));
1024 #endif
1025 break;
1026 default:
1027 g_assert_not_reached ();
1031 has_children = TRUE;
1032 } else {
1033 guint8 buf [128];
1034 guint8 *p;
1035 char *parent_die;
1037 if (m_class_get_parent (klass))
1038 parent_die = emit_class_dwarf_info (w, m_class_get_parent (klass), FALSE);
1039 else
1040 parent_die = NULL;
1042 /* Emit field types */
1043 iter = NULL;
1044 while ((field = mono_class_get_fields_internal (klass, &iter))) {
1045 if (field->type->attrs & FIELD_ATTRIBUTE_STATIC)
1046 continue;
1048 emit_type (w, field->type);
1051 iter = NULL;
1052 has_children = parent_die || mono_class_get_fields_internal (klass, &iter);
1054 emit_label (w, die);
1056 emit_uleb128 (w, has_children ? ABBREV_STRUCT_TYPE : ABBREV_STRUCT_TYPE_NOCHILDREN);
1057 emit_string (w, full_name);
1058 emit_uleb128 (w, m_class_get_instance_size (klass));
1060 if (parent_die) {
1061 emit_uleb128 (w, ABBREV_INHERITANCE);
1062 emit_symbol_diff (w, parent_die, ".Ldebug_info_start", 0);
1064 p = buf;
1065 *p ++= DW_OP_plus_uconst;
1066 encode_uleb128 (0, p, &p);
1067 emit_byte (w, p - buf);
1068 emit_bytes (w, buf, p - buf);
1071 /* Emit fields */
1072 iter = NULL;
1073 while ((field = mono_class_get_fields_internal (klass, &iter))) {
1074 if (field->type->attrs & FIELD_ATTRIBUTE_STATIC)
1075 continue;
1077 fdie = get_type_die (w, field->type);
1078 if (fdie) {
1079 emit_uleb128 (w, ABBREV_DATA_MEMBER);
1080 emit_string (w, field->name);
1081 emit_symbol_diff (w, fdie, ".Ldebug_info_start", 0);
1082 /* location */
1083 p = buf;
1084 *p ++= DW_OP_plus_uconst;
1085 if (m_class_is_valuetype (klass) && vtype)
1086 encode_uleb128 (field->offset - MONO_ABI_SIZEOF (MonoObject), p, &p);
1087 else
1088 encode_uleb128 (field->offset, p, &p);
1090 emit_byte (w, p - buf);
1091 emit_bytes (w, buf, p - buf);
1096 /* Type end */
1097 if (has_children)
1098 emit_uleb128 (w, 0x0);
1100 /* Add a typedef, so we can reference the type without a 'struct' in gdb */
1101 emit_uleb128 (w, ABBREV_TYPEDEF);
1102 emit_string (w, full_name);
1103 emit_symbol_diff (w, die, ".Ldebug_info_start", 0);
1105 /* Add a pointer type */
1106 emit_label (w, pointer_die);
1108 emit_uleb128 (w, ABBREV_POINTER_TYPE);
1109 emit_symbol_diff (w, die, ".Ldebug_info_start", 0);
1111 /* Add a reference type */
1112 emit_label (w, reference_die);
1114 emit_uleb128 (w, ABBREV_REFERENCE_TYPE);
1115 emit_symbol_diff (w, die, ".Ldebug_info_start", 0);
1117 g_free (full_name);
1119 if (emit_namespace) {
1120 /* Namespace end */
1121 emit_uleb128 (w, 0x0);
1124 return die;
1127 static gboolean base_types_emitted [64];
1129 static const char*
1130 get_type_die (MonoDwarfWriter *w, MonoType *t)
1132 MonoClass *klass = mono_class_from_mono_type_internal (t);
1133 int j;
1134 const char *tdie;
1136 if (t->byref) {
1137 if (t->type == MONO_TYPE_VALUETYPE) {
1138 tdie = (const char *)g_hash_table_lookup (w->class_to_pointer_die, klass);
1140 else {
1141 tdie = get_class_die (w, klass, FALSE);
1142 /* Should return a pointer type to a reference */
1144 // FIXME:
1145 t = mono_get_int_type ();
1147 for (j = 0; j < G_N_ELEMENTS (basic_types); ++j)
1148 if (basic_types [j].type == t->type)
1149 break;
1150 if (j < G_N_ELEMENTS (basic_types)) {
1151 tdie = basic_types [j].die_name;
1152 } else {
1153 switch (t->type) {
1154 case MONO_TYPE_CLASS:
1155 tdie = (const char *)g_hash_table_lookup (w->class_to_reference_die, klass);
1156 //tdie = ".LDIE_OBJECT";
1157 break;
1158 case MONO_TYPE_ARRAY:
1159 tdie = ".LDIE_OBJECT";
1160 break;
1161 case MONO_TYPE_VALUETYPE:
1162 if (m_class_is_enumtype (klass))
1163 tdie = get_class_die (w, klass, FALSE);
1164 else
1165 tdie = ".LDIE_I4";
1166 break;
1167 case MONO_TYPE_GENERICINST:
1168 if (!MONO_TYPE_ISSTRUCT (t)) {
1169 tdie = (const char *)g_hash_table_lookup (w->class_to_reference_die, klass);
1170 } else {
1171 tdie = ".LDIE_I4";
1173 break;
1174 case MONO_TYPE_PTR:
1175 tdie = ".LDIE_I";
1176 break;
1177 default:
1178 tdie = ".LDIE_I4";
1179 break;
1183 g_assert (tdie);
1185 return tdie;
1188 static void
1189 emit_type (MonoDwarfWriter *w, MonoType *t)
1191 MonoClass *klass = mono_class_from_mono_type_internal (t);
1192 int j;
1193 const char *tdie;
1195 if (t->byref) {
1196 if (t->type == MONO_TYPE_VALUETYPE) {
1197 tdie = emit_class_dwarf_info (w, klass, TRUE);
1198 if (tdie)
1199 return;
1201 else {
1202 emit_class_dwarf_info (w, klass, FALSE);
1204 // FIXME:
1205 t = mono_get_int_type ();
1207 for (j = 0; j < G_N_ELEMENTS (basic_types); ++j)
1208 if (basic_types [j].type == t->type)
1209 break;
1210 if (j < G_N_ELEMENTS (basic_types)) {
1211 /* Emit a boxed version of base types */
1212 if (j < 64 && !base_types_emitted [j]) {
1213 emit_class_dwarf_info (w, klass, FALSE);
1214 base_types_emitted [j] = TRUE;
1216 } else {
1217 switch (t->type) {
1218 case MONO_TYPE_CLASS:
1219 emit_class_dwarf_info (w, klass, FALSE);
1220 break;
1221 case MONO_TYPE_ARRAY:
1222 break;
1223 case MONO_TYPE_VALUETYPE:
1224 if (m_class_is_enumtype (klass))
1225 emit_class_dwarf_info (w, klass, FALSE);
1226 break;
1227 case MONO_TYPE_GENERICINST:
1228 if (!MONO_TYPE_ISSTRUCT (t))
1229 emit_class_dwarf_info (w, klass, FALSE);
1230 break;
1231 case MONO_TYPE_PTR:
1232 break;
1233 default:
1234 break;
1239 static void
1240 emit_var_type (MonoDwarfWriter *w, MonoType *t)
1242 const char *tdie;
1244 tdie = get_type_die (w, t);
1246 emit_symbol_diff (w, tdie, ".Ldebug_info_start", 0);
1249 static void
1250 encode_var_location (MonoDwarfWriter *w, MonoInst *ins, guint8 *p, guint8 **endp)
1252 /* location */
1253 /* FIXME: This needs a location list, since the args can go from reg->stack */
1254 if (!ins || ins->flags & MONO_INST_IS_DEAD) {
1255 /* gdb treats this as optimized out */
1256 } else if (ins->opcode == OP_REGVAR) {
1257 *p = DW_OP_reg0 + mono_hw_reg_to_dwarf_reg (ins->dreg);
1258 p ++;
1259 } else if (ins->opcode == OP_REGOFFSET) {
1260 *p ++= DW_OP_breg0 + mono_hw_reg_to_dwarf_reg (ins->inst_basereg);
1261 encode_sleb128 (ins->inst_offset, p, &p);
1262 } else {
1263 // FIXME:
1264 *p ++ = DW_OP_reg0;
1267 *endp = p;
1270 static void
1271 emit_loclist (MonoDwarfWriter *w, MonoInst *ins,
1272 guint8 *loclist_begin_addr, guint8 *loclist_end_addr,
1273 guint8 *expr, guint32 expr_len)
1275 char label [128];
1277 emit_push_section (w, ".debug_loc", 0);
1278 sprintf (label, ".Lloclist_%d", w->loclist_index ++ );
1279 emit_label (w, label);
1281 emit_pointer_value (w, loclist_begin_addr);
1282 emit_pointer_value (w, loclist_end_addr);
1283 emit_byte (w, expr_len % 256);
1284 emit_byte (w, expr_len / 256);
1285 emit_bytes (w, expr, expr_len);
1287 emit_pointer_value (w, NULL);
1288 emit_pointer_value (w, NULL);
1290 emit_pop_section (w);
1291 emit_symbol_diff (w, label, ".Ldebug_loc_start", 0);
1295 * MonoDisHelper->tokener doesn't take an IP argument, and we can't add one since
1296 * it is a public header.
1298 static const guint8 *token_handler_ip;
1300 static char*
1301 token_handler (MonoDisHelper *dh, MonoMethod *method, guint32 token)
1303 ERROR_DECL (error);
1304 char *res, *desc;
1305 MonoMethod *cmethod;
1306 MonoClass *klass;
1307 MonoClassField *field;
1308 gpointer data = NULL;
1310 if (method->wrapper_type)
1311 data = mono_method_get_wrapper_data (method, token);
1313 switch (*token_handler_ip) {
1314 case CEE_ISINST:
1315 case CEE_CASTCLASS:
1316 case CEE_LDELEMA:
1317 if (method->wrapper_type) {
1318 klass = (MonoClass *)data;
1319 } else {
1320 klass = mono_class_get_checked (m_class_get_image (method->klass), token, error);
1321 g_assert (is_ok (error)); /* FIXME error handling */
1323 res = g_strdup_printf ("<%s>", m_class_get_name (klass));
1324 break;
1325 case CEE_NEWOBJ:
1326 case CEE_CALL:
1327 case CEE_CALLVIRT:
1328 if (method->wrapper_type) {
1329 cmethod = (MonoMethod *)data;
1330 } else {
1331 ERROR_DECL (error);
1332 cmethod = mono_get_method_checked (m_class_get_image (method->klass), token, NULL, NULL, error);
1333 if (!cmethod)
1334 g_error ("Could not load method due to %s", mono_error_get_message (error)); /* FIXME don't swallow the error */
1336 desc = mono_method_full_name (cmethod, TRUE);
1337 res = g_strdup_printf ("<%s>", desc);
1338 g_free (desc);
1339 break;
1340 case CEE_CALLI:
1341 if (method->wrapper_type) {
1342 desc = mono_signature_get_desc ((MonoMethodSignature *)data, FALSE);
1343 res = g_strdup_printf ("<%s>", desc);
1344 g_free (desc);
1345 } else {
1346 res = g_strdup_printf ("<0x%08x>", token);
1348 break;
1349 case CEE_LDFLD:
1350 case CEE_LDSFLD:
1351 case CEE_STFLD:
1352 case CEE_STSFLD:
1353 if (method->wrapper_type) {
1354 field = (MonoClassField *)data;
1355 } else {
1356 field = mono_field_from_token_checked (m_class_get_image (method->klass), token, &klass, NULL, error);
1357 g_assert (is_ok (error)); /* FIXME error handling */
1359 desc = mono_field_full_name (field);
1360 res = g_strdup_printf ("<%s>", desc);
1361 g_free (desc);
1362 break;
1363 default:
1364 res = g_strdup_printf ("<0x%08x>", token);
1365 break;
1368 return res;
1372 * disasm_ins:
1374 * Produce a disassembled form of the IL instruction at IP. This is an extension
1375 * of mono_disasm_code_one () which can disasm tokens, handle wrapper methods, and
1376 * CEE_MONO_ opcodes.
1378 static char*
1379 disasm_ins (MonoMethod *method, const guchar *ip, const guint8 **endip)
1381 ERROR_DECL (error);
1382 char *dis;
1383 MonoDisHelper dh;
1384 MonoMethodHeader *header = mono_method_get_header_checked (method, error);
1385 mono_error_assert_ok (error); /* FIXME don't swallow the error */
1387 memset (&dh, 0, sizeof (dh));
1388 dh.newline = "";
1389 dh.label_format = "IL_%04x: ";
1390 dh.label_target = "IL_%04x";
1391 dh.tokener = token_handler;
1393 token_handler_ip = ip;
1394 if (*ip == MONO_CUSTOM_PREFIX) {
1395 guint32 token;
1396 gpointer data;
1398 switch (ip [1]) {
1399 case CEE_MONO_ICALL: {
1400 MonoJitICallInfo const * const info = mono_find_jit_icall_info ((MonoJitICallId)read32 (ip + 2));
1401 dis = g_strdup_printf ("IL_%04x: mono_icall <%s>", (int)(ip - header->code), info->name);
1402 ip += 6;
1403 break;
1405 case CEE_MONO_CLASSCONST: {
1406 token = read32 (ip + 2);
1407 data = mono_method_get_wrapper_data (method, token);
1409 dis = g_strdup_printf ("IL_%04x: mono_classconst <%s>", (int)(ip - header->code), m_class_get_name ((MonoClass*)data));
1410 ip += 6;
1411 break;
1413 default:
1414 dis = mono_disasm_code_one (&dh, method, ip, &ip);
1416 } else {
1417 dis = mono_disasm_code_one (&dh, method, ip, &ip);
1419 token_handler_ip = NULL;
1421 *endip = ip;
1422 mono_metadata_free_mh (header);
1423 return dis;
1426 static gint32
1427 il_offset_from_address (MonoMethod *method, MonoDebugMethodJitInfo *jit,
1428 guint32 native_offset)
1430 int i;
1432 if (!jit->line_numbers)
1433 return -1;
1435 for (i = jit->num_line_numbers - 1; i >= 0; i--) {
1436 MonoDebugLineNumberEntry lne = jit->line_numbers [i];
1438 if (lne.native_offset <= native_offset)
1439 return lne.il_offset;
1442 return -1;
1445 static int max_special_addr_diff = 0;
1447 static void
1448 emit_advance_op (MonoDwarfWriter *w, int line_diff, int addr_diff)
1450 gint64 opcode = 0;
1452 /* Use a special opcode if possible */
1453 if (line_diff - LINE_BASE >= 0 && line_diff - LINE_BASE < LINE_RANGE) {
1454 if (max_special_addr_diff == 0)
1455 max_special_addr_diff = (255 - OPCODE_BASE) / LINE_RANGE;
1457 if (addr_diff > max_special_addr_diff && (addr_diff < 2 * max_special_addr_diff)) {
1458 emit_byte (w, DW_LNS_const_add_pc);
1459 addr_diff -= max_special_addr_diff;
1462 opcode = (line_diff - LINE_BASE) + (LINE_RANGE * addr_diff) + OPCODE_BASE;
1463 if (opcode > 255)
1464 opcode = 0;
1467 if (opcode != 0) {
1468 emit_byte (w, opcode);
1469 } else {
1470 //printf ("large: %d %d %d\n", line_diff, addr_diff, max_special_addr_diff);
1471 emit_byte (w, DW_LNS_advance_line);
1472 emit_sleb128 (w, line_diff);
1473 emit_byte (w, DW_LNS_advance_pc);
1474 emit_sleb128 (w, addr_diff);
1475 emit_byte (w, DW_LNS_copy);
1479 static gint
1480 compare_lne (MonoDebugLineNumberEntry *a, MonoDebugLineNumberEntry *b)
1482 if (a->native_offset == b->native_offset)
1483 return a->il_offset - b->il_offset;
1484 else
1485 return a->native_offset - b->native_offset;
1488 static void
1489 emit_line_number_info (MonoDwarfWriter *w, MonoMethod *method,
1490 char *start_symbol, char *end_symbol,
1491 guint8 *code, guint32 code_size,
1492 MonoDebugMethodJitInfo *debug_info)
1494 ERROR_DECL (error);
1495 guint32 prev_line = 0;
1496 guint32 prev_native_offset = 0;
1497 int i, file_index, il_offset, prev_il_offset;
1498 gboolean first = TRUE;
1499 MonoDebugSourceLocation *loc;
1500 char *prev_file_name = NULL;
1501 MonoMethodHeader *header = mono_method_get_header_checked (method, error);
1502 MonoDebugMethodInfo *minfo;
1503 MonoDebugLineNumberEntry *ln_array;
1504 int *native_to_il_offset = NULL;
1506 mono_error_assert_ok (error); /* FIXME don't swallow the error */
1508 if (!w->emit_line) {
1509 mono_metadata_free_mh (header);
1510 return;
1513 minfo = mono_debug_lookup_method (method);
1515 /* Compute the native->IL offset mapping */
1517 g_assert (code_size);
1519 ln_array = g_new0 (MonoDebugLineNumberEntry, debug_info->num_line_numbers);
1520 memcpy (ln_array, debug_info->line_numbers, debug_info->num_line_numbers * sizeof (MonoDebugLineNumberEntry));
1522 mono_qsort (ln_array, debug_info->num_line_numbers, sizeof (MonoDebugLineNumberEntry), (int (*)(const void *, const void *))compare_lne);
1524 native_to_il_offset = g_new0 (int, code_size + 1);
1526 for (i = 0; i < debug_info->num_line_numbers; ++i) {
1527 int j;
1528 MonoDebugLineNumberEntry *lne = &ln_array [i];
1530 if (i == 0) {
1531 for (j = 0; j < lne->native_offset; ++j)
1532 native_to_il_offset [j] = -1;
1535 if (i < debug_info->num_line_numbers - 1) {
1536 MonoDebugLineNumberEntry *lne_next = &ln_array [i + 1];
1538 for (j = lne->native_offset; j < lne_next->native_offset; ++j)
1539 native_to_il_offset [j] = lne->il_offset;
1540 } else {
1541 for (j = lne->native_offset; j < code_size; ++j)
1542 native_to_il_offset [j] = lne->il_offset;
1545 g_free (ln_array);
1547 prev_line = 1;
1548 prev_il_offset = -1;
1550 w->cur_file_index = -1;
1551 for (i = 0; i < code_size; ++i) {
1552 int line_diff, addr_diff;
1554 if (!minfo)
1555 continue;
1557 if (!debug_info->line_numbers)
1558 continue;
1560 if (native_to_il_offset)
1561 il_offset = native_to_il_offset [i];
1562 else
1563 il_offset = il_offset_from_address (method, debug_info, i);
1565 il_offset = il_offset_from_address (method, debug_info, i);
1567 g_assert (il_offset == native_to_il_offset [i]);
1570 il_offset = native_to_il_offset [i];
1571 if (il_offset < 0)
1572 continue;
1574 if (il_offset == prev_il_offset)
1575 continue;
1577 prev_il_offset = il_offset;
1579 loc = mono_debug_method_lookup_location (minfo, il_offset);
1580 if (!loc)
1581 continue;
1582 if (!loc->source_file) {
1583 mono_debug_free_source_location (loc);
1584 continue;
1587 line_diff = (gint32)loc->row - (gint32)prev_line;
1588 addr_diff = i - prev_native_offset;
1590 if (first) {
1591 emit_section_change (w, ".debug_line", 0);
1593 emit_byte (w, 0);
1594 emit_byte (w, sizeof (target_mgreg_t) + 1);
1595 emit_byte (w, DW_LNE_set_address);
1596 if (start_symbol)
1597 emit_pointer_unaligned (w, start_symbol);
1598 else
1599 emit_pointer_value (w, code);
1600 first = FALSE;
1603 if (loc->row != prev_line) {
1604 if (!prev_file_name || strcmp (loc->source_file, prev_file_name) != 0) {
1605 /* Add an entry to the file table */
1606 /* FIXME: Avoid duplicates */
1607 file_index = get_line_number_file_name (w, loc->source_file) + 1;
1608 g_free (prev_file_name);
1609 prev_file_name = g_strdup (loc->source_file);
1611 if (w->cur_file_index != file_index) {
1612 emit_byte (w, DW_LNS_set_file);
1613 emit_uleb128 (w, file_index);
1614 emit_byte (w, DW_LNS_copy);
1615 w->cur_file_index = file_index;
1620 if (loc->row != prev_line) {
1621 if (prev_native_offset == 0)
1622 emit_byte (w, DW_LNE_set_prologue_end);
1624 //printf ("X: %p(+0x%x) %d %s:%d(+%d)\n", code + i, addr_diff, loc->il_offset, loc->source_file, loc->row, line_diff);
1625 emit_advance_op (w, line_diff, addr_diff);
1627 prev_line = loc->row;
1628 prev_native_offset = i;
1631 mono_debug_free_source_location (loc);
1632 first = FALSE;
1635 g_free (native_to_il_offset);
1636 g_free (prev_file_name);
1638 if (!first) {
1639 emit_byte (w, DW_LNS_advance_pc);
1640 emit_sleb128 (w, code_size - prev_native_offset);
1641 emit_byte (w, DW_LNS_copy);
1643 emit_byte (w, 0);
1644 emit_byte (w, 1);
1645 emit_byte (w, DW_LNE_end_sequence);
1646 } else if (!start_symbol) {
1647 /* No debug info, XDEBUG mode */
1648 char *name, *dis;
1649 const guint8 *ip = header->code;
1650 int prev_line, prev_native_offset;
1651 int *il_to_line;
1654 * Emit the IL code into a temporary file and emit line number info
1655 * referencing that file.
1658 name = mono_method_full_name (method, TRUE);
1659 fprintf (w->il_file, "// %s\n", name);
1660 w->il_file_line_index ++;
1661 g_free (name);
1663 il_to_line = g_new0 (int, header->code_size);
1665 emit_section_change (w, ".debug_line", 0);
1666 emit_byte (w, 0);
1667 emit_byte (w, sizeof (target_mgreg_t) + 1);
1668 emit_byte (w, DW_LNE_set_address);
1669 emit_pointer_value (w, code);
1671 // FIXME: Optimize this
1672 while (ip < header->code + header->code_size) {
1673 int il_offset = ip - header->code;
1675 /* Emit IL */
1676 w->il_file_line_index ++;
1678 dis = disasm_ins (method, ip, &ip);
1679 fprintf (w->il_file, "%s\n", dis);
1680 g_free (dis);
1682 il_to_line [il_offset] = w->il_file_line_index;
1685 /* Emit line number info */
1686 prev_line = 1;
1687 prev_native_offset = 0;
1688 for (i = 0; i < debug_info->num_line_numbers; ++i) {
1689 MonoDebugLineNumberEntry *lne = &debug_info->line_numbers [i];
1690 int line;
1692 if (lne->il_offset >= header->code_size)
1693 continue;
1694 line = il_to_line [lne->il_offset];
1695 if (!line) {
1697 * This seems to happen randomly, it looks like il_offset points
1698 * into the middle of an instruction.
1700 continue;
1702 printf ("%s\n", mono_method_full_name (method, TRUE));
1703 printf ("%d %d\n", lne->il_offset, header->code_size);
1704 g_assert (line);
1708 if (line - prev_line != 0) {
1709 emit_advance_op (w, line - prev_line, (gint32)lne->native_offset - prev_native_offset);
1711 prev_line = line;
1712 prev_native_offset = lne->native_offset;
1716 emit_byte (w, DW_LNS_advance_pc);
1717 emit_sleb128 (w, code_size - prev_native_offset);
1718 emit_byte (w, DW_LNS_copy);
1720 emit_byte (w, 0);
1721 emit_byte (w, 1);
1722 emit_byte (w, DW_LNE_end_sequence);
1724 fflush (w->il_file);
1725 g_free (il_to_line);
1727 mono_metadata_free_mh (header);
1730 static MonoMethodVar*
1731 find_vmv (MonoCompile *cfg, MonoInst *ins)
1733 int j;
1735 if (cfg->varinfo) {
1736 for (j = 0; j < cfg->num_varinfo; ++j) {
1737 if (cfg->varinfo [j] == ins)
1738 break;
1741 if (j < cfg->num_varinfo) {
1742 return MONO_VARINFO (cfg, j);
1746 return NULL;
1749 void
1750 mono_dwarf_writer_emit_method (MonoDwarfWriter *w, MonoCompile *cfg, MonoMethod *method, char *start_symbol, char *end_symbol, char *linkage_name,
1751 guint8 *code, guint32 code_size, MonoInst **args, MonoInst **locals, GSList *unwind_info, MonoDebugMethodJitInfo *debug_info)
1753 ERROR_DECL (error);
1754 char *name;
1755 MonoMethodSignature *sig;
1756 MonoMethodHeader *header;
1757 char **names;
1758 MonoDebugLocalsInfo *locals_info;
1759 MonoDebugMethodInfo *minfo;
1760 MonoDebugSourceLocation *loc = NULL;
1761 int i;
1762 guint8 buf [128];
1763 guint8 *p;
1765 emit_section_change (w, ".debug_info", 0);
1767 sig = mono_method_signature_internal (method);
1768 header = mono_method_get_header_checked (method, error);
1769 mono_error_assert_ok (error); /* FIXME don't swallow the error */
1771 /* Parameter types */
1772 for (i = 0; i < sig->param_count + sig->hasthis; ++i) {
1773 MonoType *t;
1775 if (i == 0 && sig->hasthis) {
1776 if (m_class_is_valuetype (method->klass))
1777 t = m_class_get_this_arg (method->klass);
1778 else
1779 t = m_class_get_byval_arg (method->klass);
1780 } else {
1781 t = sig->params [i - sig->hasthis];
1784 emit_type (w, t);
1786 //emit_type (w, mono_get_int32_type ());
1788 /* Local types */
1789 for (i = 0; i < header->num_locals; ++i) {
1790 emit_type (w, header->locals [i]);
1793 minfo = mono_debug_lookup_method (method);
1794 if (minfo)
1795 loc = mono_debug_method_lookup_location (minfo, 0);
1797 /* Subprogram */
1798 names = g_new0 (char *, sig->param_count);
1799 mono_method_get_param_names (method, (const char **) names);
1801 emit_uleb128 (w, ABBREV_SUBPROGRAM);
1802 /* DW_AT_name */
1803 name = mono_method_full_name (method, FALSE);
1804 emit_escaped_string (w, name);
1805 /* DW_AT_MIPS_linkage_name */
1806 if (linkage_name)
1807 emit_string (w, linkage_name);
1808 else
1809 emit_string (w, "");
1810 /* DW_AT_decl_file/DW_AT_decl_line */
1811 if (loc) {
1812 int file_index = add_line_number_file_name (w, loc->source_file, 0, 0);
1813 emit_uleb128 (w, file_index + 1);
1814 emit_uleb128 (w, loc->row);
1816 mono_debug_free_source_location (loc);
1817 loc = NULL;
1818 } else {
1819 emit_uleb128 (w, 0);
1820 emit_uleb128 (w, 0);
1822 #ifndef TARGET_IOS
1823 emit_string (w, name);
1824 #endif
1825 g_free (name);
1826 if (start_symbol) {
1827 emit_pointer_unaligned (w, start_symbol);
1828 emit_pointer_unaligned (w, end_symbol);
1829 } else {
1830 emit_pointer_value (w, code);
1831 emit_pointer_value (w, code + code_size);
1833 /* frame_base */
1834 emit_byte (w, 2);
1835 emit_byte (w, DW_OP_breg6);
1836 emit_byte (w, 16);
1838 /* Parameters */
1839 for (i = 0; i < sig->param_count + sig->hasthis; ++i) {
1840 MonoInst *arg = args ? args [i] : NULL;
1841 MonoType *t;
1842 const char *pname;
1843 char pname_buf [128];
1844 MonoMethodVar *vmv = NULL;
1845 gboolean need_loclist = FALSE;
1847 vmv = find_vmv (cfg, arg);
1848 if (code && vmv && (vmv->live_range_start || vmv->live_range_end))
1849 need_loclist = TRUE;
1851 if (i == 0 && sig->hasthis) {
1852 if (m_class_is_valuetype (method->klass))
1853 t = m_class_get_this_arg (method->klass);
1854 else
1855 t = m_class_get_byval_arg (method->klass);
1856 pname = "this";
1857 } else {
1858 t = sig->params [i - sig->hasthis];
1859 pname = names [i - sig->hasthis];
1862 emit_uleb128 (w, need_loclist ? ABBREV_PARAM_LOCLIST : ABBREV_PARAM);
1863 /* name */
1864 if (pname[0] == '\0') {
1865 sprintf (pname_buf, "param%d", i - sig->hasthis);
1866 pname = pname_buf;
1868 emit_string (w, pname);
1869 /* type */
1870 if (!arg || arg->flags & MONO_INST_IS_DEAD)
1871 emit_var_type (w, mono_get_int32_type ());
1872 else
1873 emit_var_type (w, t);
1875 p = buf;
1876 encode_var_location (w, arg, p, &p);
1877 if (need_loclist) {
1878 vmv->live_range_start = 0;
1879 if (vmv->live_range_end == 0)
1880 /* FIXME: Uses made in calls are not recorded */
1881 vmv->live_range_end = code_size;
1882 emit_loclist (w, arg, code + vmv->live_range_start, code + vmv->live_range_end, buf, p - buf);
1883 } else {
1884 emit_byte (w, p - buf);
1885 emit_bytes (w, buf, p - buf);
1888 g_free (names);
1890 /* Locals */
1891 locals_info = mono_debug_lookup_locals (method);
1893 for (i = 0; i < header->num_locals; ++i) {
1894 MonoInst *ins = locals [i];
1895 char name_buf [128];
1896 int j;
1897 MonoMethodVar *vmv = NULL;
1898 gboolean need_loclist = FALSE;
1899 char *lname;
1901 /* ins->dreg no longer contains the original vreg */
1902 vmv = find_vmv (cfg, ins);
1903 if (code && vmv) {
1904 if (vmv->live_range_start) {
1905 /* This variable has a precise live range */
1906 need_loclist = TRUE;
1910 emit_uleb128 (w, need_loclist ? ABBREV_VARIABLE_LOCLIST : ABBREV_VARIABLE);
1911 /* name */
1912 lname = NULL;
1913 if (locals_info) {
1914 for (j = 0; j < locals_info->num_locals; ++j)
1915 if (locals_info->locals [j].index == i)
1916 break;
1917 if (j < locals_info->num_locals)
1918 lname = locals_info->locals [j].name;
1920 if (lname) {
1921 emit_string (w, lname);
1922 } else {
1923 sprintf (name_buf, "V_%d", i);
1924 emit_string (w, name_buf);
1926 /* type */
1927 if (!ins || ins->flags & MONO_INST_IS_DEAD)
1928 emit_var_type (w, mono_get_int32_type ());
1929 else
1930 emit_var_type (w, header->locals [i]);
1932 p = buf;
1933 encode_var_location (w, ins, p, &p);
1935 if (need_loclist) {
1936 if (vmv->live_range_end == 0)
1937 /* FIXME: Uses made in calls are not recorded */
1938 vmv->live_range_end = code_size;
1939 emit_loclist (w, ins, code + vmv->live_range_start, code + vmv->live_range_end, buf, p - buf);
1940 } else {
1941 emit_byte (w, p - buf);
1942 emit_bytes (w, buf, p - buf);
1946 if (locals_info)
1947 mono_debug_free_locals (locals_info);
1949 /* Subprogram end */
1950 emit_uleb128 (w, 0x0);
1952 emit_line (w);
1954 emit_debug_info_end (w);
1956 /* Emit unwind info */
1957 if (unwind_info) {
1958 emit_fde (w, w->fde_index, start_symbol, end_symbol, code, code_size, unwind_info, TRUE);
1959 w->fde_index ++;
1962 /* Save the information needed to emit the line number info later at once */
1963 /* != could happen when using --regression */
1964 if (debug_info && (debug_info->code_start == code)) {
1965 MethodLineNumberInfo *info;
1967 info = g_new0 (MethodLineNumberInfo, 1);
1968 info->method = method;
1969 info->start_symbol = g_strdup (start_symbol);
1970 info->end_symbol = g_strdup (end_symbol);
1971 info->code = code;
1972 info->code_size = code_size;
1973 w->line_info = g_slist_prepend (w->line_info, info);
1976 emit_line (w);
1977 mono_metadata_free_mh (header);
1980 void
1981 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)
1983 emit_section_change (w, ".debug_info", 0);
1985 /* Subprogram */
1986 emit_uleb128 (w, ABBREV_TRAMP_SUBPROGRAM);
1987 emit_string (w, tramp_name);
1988 emit_pointer_value (w, code);
1989 emit_pointer_value (w, code + code_size);
1991 /* Subprogram end */
1992 emit_uleb128 (w, 0x0);
1994 emit_debug_info_end (w);
1996 /* Emit unwind info */
1997 emit_fde (w, w->fde_index, start_symbol, end_symbol, code, code_size, unwind_info, FALSE);
1998 w->fde_index ++;
2001 #else /* !defined(DISABLE_AOT) && !defined(DISABLE_JIT) */
2003 MONO_EMPTY_SOURCE_FILE (dwarfwriter);
2005 #endif /* End of: !defined(DISABLE_AOT) && !defined(DISABLE_JIT) */