mono/mini/dwarfwriter.c

   1 /*
   2  * dwarfwriter.c: Creation of DWARF debug information
   3  *
   4  * Author:
   5  *   Zoltan Varga (vargaz@gmail.com)
   6  *
   7  * (C) 2008-2009 Novell, Inc.
   8  */
   9
  10 #include "config.h"
  11
  12 #if !defined(DISABLE_AOT) && !defined(DISABLE_JIT)
  13 #include "dwarfwriter.h"
  14
  15 #include <sys/types.h>
  16 #include <ctype.h>
  17 #include <string.h>
  18 #ifdef HAVE_STDINT_H
  19 #include <stdint.h>
  20 #endif
  21
  22 #include <mono/metadata/mono-endian.h>
  23 #include <mono/metadata/debug-mono-symfile.h>
  24 #include <mono/utils/mono-compiler.h>
  25
  26 #ifndef PLATFORM_WIN32
  27 #include <mono/utils/freebsd-elf32.h>
  28 #include <mono/utils/freebsd-elf64.h>
  29 #endif
  30
  31 #include <mono/utils/freebsd-dwarf.h>
  32
  33 struct _MonoDwarfWriter
  34 {
  35         MonoImageWriter *w;
  36         GHashTable *class_to_die, *class_to_vtype_die, *class_to_pointer_die;
  37         GHashTable *class_to_reference_die;
  38         int fde_index, tdie_index, line_number_file_index, line_number_dir_index;
  39         GHashTable *file_to_index, *dir_to_index;
  40         FILE *il_file;
  41         int il_file_line_index, loclist_index;
  42         GSList *cie_program;
  43         FILE *fp;
  44         const char *temp_prefix;
  45         gboolean emit_line, appending;
  46 };
  47
  48 /*
  49  * mono_dwarf_writer_create:
  50  *
  51  *   Create a DWARF writer object. WRITER is the underlying image writer this
  52  * writer will emit to. IL_FILE is the file where IL code will be dumped to for
  53  * methods which have no line number info. It can be NULL.
  54  * If APPENDING is TRUE, the output file will be in assembleable state after each
  55  * call to the _emit_ functions. This is used for XDEBUG. If APPENDING is FALSE,
  56  * a separate mono_dwarf_writer_close () call is needed to finish the emission of
  57  * debug information.
  58  */
  59 MonoDwarfWriter*
  60 mono_dwarf_writer_create (MonoImageWriter *writer, FILE *il_file, gboolean appending)
  61 {
  62         MonoDwarfWriter *w = g_new0 (MonoDwarfWriter, 1);
  63
  64         /*
  65          * The appending flag is needed because we use subsections to order things in
  66          * the debug info, and:
  67          * - apple's assembler doesn't support them
  68          * - the binary writer has problems with subsections+alignment
  69          * So instead of subsections, we use the _close () function in AOT mode,
  70          * which writes out things in order.
  71          */
  72
  73         w->w = writer;
  74         w->il_file = il_file;
  75         w->appending = appending;
  76
  77         if (appending)
  78                 g_assert (img_writer_subsections_supported (w->w));
  79
  80         w->fp = img_writer_get_fp (w->w);
  81         w->temp_prefix = img_writer_get_temp_label_prefix (w->w);
  82
  83         return w;
  84 }
  85
  86 void
  87 mono_dwarf_writer_destroy (MonoDwarfWriter *w)
  88 {
  89         g_free (w);
  90 }
  91
  92 /* Wrappers around the image writer functions */
  93
  94 static inline void
  95 emit_section_change (MonoDwarfWriter *w, const char *section_name, int subsection_index)
  96 {
  97         img_writer_emit_section_change (w->w, section_name, subsection_index);
  98 }
  99
 100 static inline void
 101 emit_push_section (MonoDwarfWriter *w, const char *section_name, int subsection)
 102 {
 103         img_writer_emit_push_section (w->w, section_name, subsection);
 104 }
 105
 106 static inline void
 107 emit_pop_section (MonoDwarfWriter *w)
 108 {
 109         img_writer_emit_pop_section (w->w);
 110 }
 111
 112 static inline void
 113 emit_local_symbol (MonoDwarfWriter *w, const char *name, const char *end_label, gboolean func)
 114 {
 115         img_writer_emit_local_symbol (w->w, name, end_label, func);
 116 }
 117
 118 static inline void
 119 emit_label (MonoDwarfWriter *w, const char *name)
 120 {
 121         img_writer_emit_label (w->w, name);
 122 }
 123
 124 static inline void
 125 emit_bytes (MonoDwarfWriter *w, const guint8* buf, int size)
 126 {
 127         img_writer_emit_bytes (w->w, buf, size);
 128 }
 129
 130 static inline void
 131 emit_string (MonoDwarfWriter *w, const char *value)
 132 {
 133         img_writer_emit_string (w->w, value);
 134 }
 135
 136 static inline void
 137 emit_line (MonoDwarfWriter *w)
 138 {
 139         img_writer_emit_line (w->w);
 140 }
 141
 142 static inline void
 143 emit_alignment (MonoDwarfWriter *w, int size)
 144 {
 145         img_writer_emit_alignment (w->w, size);
 146 }
 147
 148 static inline void
 149 emit_pointer_unaligned (MonoDwarfWriter *w, const char *target)
 150 {
 151         img_writer_emit_pointer_unaligned (w->w, target);
 152 }
 153
 154 static inline void
 155 emit_pointer (MonoDwarfWriter *w, const char *target)
 156 {
 157         img_writer_emit_pointer (w->w, target);
 158 }
 159
 160 static inline void
 161 emit_int16 (MonoDwarfWriter *w, int value)
 162 {
 163         img_writer_emit_int16 (w->w, value);
 164 }
 165
 166 static inline void
 167 emit_int32 (MonoDwarfWriter *w, int value)
 168 {
 169         img_writer_emit_int32 (w->w, value);
 170 }
 171
 172 static inline void
 173 emit_symbol_diff (MonoDwarfWriter *w, const char *end, const char* start, int offset)
 174 {
 175         img_writer_emit_symbol_diff (w->w, end, start, offset);
 176 }
 177
 178 static inline void
 179 emit_zero_bytes (MonoDwarfWriter *w, int num)
 180 {
 181         img_writer_emit_zero_bytes (w->w, num);
 182 }
 183
 184 static inline void
 185 emit_byte (MonoDwarfWriter *w, guint8 val)
 186 {
 187         img_writer_emit_byte (w->w, val);
 188 }
 189
 190 static G_GNUC_UNUSED void
 191 emit_uleb128 (MonoDwarfWriter *w, guint32 value)
 192 {
 193         do {
 194                 guint8 b = value & 0x7f;
 195                 value >>= 7;
 196                 if (value != 0) /* more bytes to come */
 197                         b |= 0x80;
 198                 emit_byte (w, b);
 199         } while (value);
 200 }
 201
 202 static G_GNUC_UNUSED void
 203 emit_sleb128 (MonoDwarfWriter *w, gint64 value)
 204 {
 205         gboolean more = 1;
 206         gboolean negative = (value < 0);
 207         guint32 size = 64;
 208         guint8 byte;
 209
 210         while (more) {
 211                 byte = value & 0x7f;
 212                 value >>= 7;
 213                 /* the following is unnecessary if the
 214                  * implementation of >>= uses an arithmetic rather
 215                  * than logical shift for a signed left operand
 216                  */
 217                 if (negative)
 218                         /* sign extend */
 219                         value |= - ((gint64)1 <<(size - 7));
 220                 /* sign bit of byte is second high order bit (0x40) */
 221                 if ((value == 0 && !(byte & 0x40)) ||
 222                         (value == -1 && (byte & 0x40)))
 223                         more = 0;
 224                 else
 225                         byte |= 0x80;
 226                 emit_byte (w, byte);
 227         }
 228 }
 229
 230 static G_GNUC_UNUSED void
 231 encode_uleb128 (guint32 value, guint8 *buf, guint8 **endbuf)
 232 {
 233         guint8 *p = buf;
 234
 235         do {
 236                 guint8 b = value & 0x7f;
 237                 value >>= 7;
 238                 if (value != 0) /* more bytes to come */
 239                         b |= 0x80;
 240                 *p ++ = b;
 241         } while (value);
 242
 243         *endbuf = p;
 244 }
 245
 246 static G_GNUC_UNUSED void
 247 encode_sleb128 (gint32 value, guint8 *buf, guint8 **endbuf)
 248 {
 249         gboolean more = 1;
 250         gboolean negative = (value < 0);
 251         guint32 size = 32;
 252         guint8 byte;
 253         guint8 *p = buf;
 254
 255         while (more) {
 256                 byte = value & 0x7f;
 257                 value >>= 7;
 258                 /* the following is unnecessary if the
 259                  * implementation of >>= uses an arithmetic rather
 260                  * than logical shift for a signed left operand
 261                  */
 262                 if (negative)
 263                         /* sign extend */
 264                         value |= - (1 <<(size - 7));
 265                 /* sign bit of byte is second high order bit (0x40) */
 266                 if ((value == 0 && !(byte & 0x40)) ||
 267                         (value == -1 && (byte & 0x40)))
 268                         more = 0;
 269                 else
 270                         byte |= 0x80;
 271                 *p ++= byte;
 272         }
 273
 274         *endbuf = p;
 275 }
 276
 277 static void
 278 emit_dwarf_abbrev (MonoDwarfWriter *w, int code, int tag, gboolean has_child,
 279                                    int *attrs, int attrs_len)
 280 {
 281         int i;
 282
 283         emit_uleb128 (w, code);
 284         emit_uleb128 (w, tag);
 285         emit_byte (w, has_child);
 286
 287         for (i = 0; i < attrs_len; i++)
 288                 emit_uleb128 (w, attrs [i]);
 289         emit_uleb128 (w, 0);
 290         emit_uleb128 (w, 0);
 291 }
 292
 293 static void
 294 emit_cie (MonoDwarfWriter *w)
 295 {
 296         emit_section_change (w, ".debug_frame", 0);
 297
 298         emit_alignment (w, 8);
 299
 300         /* Emit a CIE */
 301         emit_symbol_diff (w, ".Lcie0_end", ".Lcie0_start", 0); /* length */
 302         emit_label (w, ".Lcie0_start");
 303         emit_int32 (w, 0xffffffff); /* CIE id */
 304         emit_byte (w, 3); /* version */
 305         emit_string (w, ""); /* augmention */
 306         emit_sleb128 (w, 1); /* code alignment factor */
 307         emit_sleb128 (w, mono_unwind_get_dwarf_data_align ()); /* data alignment factor */
 308         emit_uleb128 (w, mono_unwind_get_dwarf_pc_reg ());
 309
 310         w->cie_program = w->cie_program;
 311         if (w->cie_program) {
 312                 guint32 uw_info_len;
 313                 guint8 *uw_info = mono_unwind_ops_encode (w->cie_program, &uw_info_len);
 314                 emit_bytes (w, uw_info, uw_info_len);
 315                 g_free (uw_info);
 316         }
 317
 318         emit_alignment (w, sizeof (gpointer));
 319         emit_label (w, ".Lcie0_end");
 320 }
 321
 322 static void
 323 emit_pointer_value (MonoDwarfWriter *w, gpointer ptr)
 324 {
 325         gssize val = (gssize)ptr;
 326         emit_bytes (w, (guint8*)&val, sizeof (gpointer));
 327 }
 328
 329 static void
 330 emit_fde (MonoDwarfWriter *w, int fde_index, char *start_symbol, char *end_symbol,
 331                   guint8 *code, guint32 code_size, GSList *unwind_ops, gboolean use_cie)
 332 {
 333         char symbol1 [128];
 334         char symbol2 [128];
 335         GSList *l;
 336         guint8 *uw_info;
 337         guint32 uw_info_len;
 338
 339         emit_section_change (w, ".debug_frame", 0);
 340
 341         sprintf (symbol1, ".Lfde%d_start", fde_index);
 342         sprintf (symbol2, ".Lfde%d_end", fde_index);
 343         emit_symbol_diff (w, symbol2, symbol1, 0); /* length */
 344         emit_label (w, symbol1);
 345         emit_int32 (w, 0); /* CIE_pointer */
 346         if (start_symbol) {
 347                 emit_pointer (w, start_symbol); /* initial_location */
 348                 if (end_symbol)
 349                         emit_symbol_diff (w, end_symbol, start_symbol, 0); /* address_range */
 350                 else {
 351                         g_assert (code_size);
 352                         emit_int32 (w, code_size);
 353                 }
 354         } else {
 355                 emit_pointer_value (w, code);
 356                 emit_int32 (w, code_size);
 357         }
 358 #if SIZEOF_VOID_P == 8
 359         /* Upper 32 bits of code size */
 360         emit_int32 (w, 0);
 361 #endif
 362
 363         l = unwind_ops;
 364         if (w->cie_program) {
 365                 // FIXME: Check that the ops really begin with the CIE program */
 366                 int i;
 367
 368                 for (i = 0; i < g_slist_length (w->cie_program); ++i)
 369                         l = l->next;
 370         }
 371
 372         /* Convert the list of MonoUnwindOps to the format used by DWARF */
 373         uw_info = mono_unwind_ops_encode (l, &uw_info_len);
 374         emit_bytes (w, uw_info, uw_info_len);
 375         g_free (uw_info);
 376
 377         emit_alignment (w, sizeof (mgreg_t));
 378         emit_label (w, symbol2);
 379 }
 380
 381 /* Abbrevations */
 382 #define ABBREV_COMPILE_UNIT 1
 383 #define ABBREV_SUBPROGRAM 2
 384 #define ABBREV_PARAM 3
 385 #define ABBREV_BASE_TYPE 4
 386 #define ABBREV_STRUCT_TYPE 5
 387 #define ABBREV_DATA_MEMBER 6
 388 #define ABBREV_TYPEDEF 7
 389 #define ABBREV_ENUM_TYPE 8
 390 #define ABBREV_ENUMERATOR 9
 391 #define ABBREV_NAMESPACE 10
 392 #define ABBREV_VARIABLE 11
 393 #define ABBREV_VARIABLE_LOCLIST 12
 394 #define ABBREV_POINTER_TYPE 13
 395 #define ABBREV_REFERENCE_TYPE 14
 396 #define ABBREV_PARAM_LOCLIST 15
 397 #define ABBREV_INHERITANCE 16
 398 #define ABBREV_STRUCT_TYPE_NOCHILDREN 17
 399
 400 static int compile_unit_attr [] = {
 401         DW_AT_producer     ,DW_FORM_string,
 402     DW_AT_name         ,DW_FORM_string,
 403     DW_AT_comp_dir     ,DW_FORM_string,
 404         DW_AT_language     ,DW_FORM_data1,
 405     DW_AT_low_pc       ,DW_FORM_addr,
 406     DW_AT_high_pc      ,DW_FORM_addr,
 407         DW_AT_stmt_list    ,DW_FORM_data4
 408 };
 409
 410 static int subprogram_attr [] = {
 411         DW_AT_name         , DW_FORM_string,
 412     DW_AT_low_pc       , DW_FORM_addr,
 413     DW_AT_high_pc      , DW_FORM_addr,
 414         DW_AT_frame_base   , DW_FORM_block1
 415 };
 416
 417 static int param_attr [] = {
 418         DW_AT_name,     DW_FORM_string,
 419         DW_AT_type,     DW_FORM_ref4,
 420         DW_AT_location, DW_FORM_block1
 421 };
 422
 423 static int param_loclist_attr [] = {
 424         DW_AT_name,     DW_FORM_string,
 425         DW_AT_type,     DW_FORM_ref4,
 426         DW_AT_location, DW_FORM_data4
 427 };
 428
 429 static int base_type_attr [] = {
 430         DW_AT_byte_size,   DW_FORM_data1,
 431         DW_AT_encoding,    DW_FORM_data1,
 432         DW_AT_name,        DW_FORM_string
 433 };
 434
 435 static int struct_type_attr [] = {
 436         DW_AT_name,        DW_FORM_string,
 437         DW_AT_byte_size,   DW_FORM_udata,
 438 };
 439
 440 static int data_member_attr [] = {
 441         DW_AT_name,        DW_FORM_string,
 442         DW_AT_type,        DW_FORM_ref4,
 443         DW_AT_data_member_location, DW_FORM_block1
 444 };
 445
 446 static int typedef_attr [] = {
 447         DW_AT_name,        DW_FORM_string,
 448         DW_AT_type,        DW_FORM_ref4
 449 };
 450
 451 static int pointer_type_attr [] = {
 452         DW_AT_type,        DW_FORM_ref4,
 453 };
 454
 455 static int reference_type_attr [] = {
 456         DW_AT_type,        DW_FORM_ref4,
 457 };
 458
 459 static int enum_type_attr [] = {
 460         DW_AT_name,        DW_FORM_string,
 461         DW_AT_byte_size,   DW_FORM_udata,
 462         DW_AT_type,        DW_FORM_ref4,
 463 };
 464
 465 static int enumerator_attr [] = {
 466         DW_AT_name,        DW_FORM_string,
 467         DW_AT_const_value, DW_FORM_sdata,
 468 };
 469
 470 static int namespace_attr [] = {
 471         DW_AT_name,        DW_FORM_string,
 472 };
 473
 474 static int variable_attr [] = {
 475         DW_AT_name,     DW_FORM_string,
 476         DW_AT_type,     DW_FORM_ref4,
 477         DW_AT_location, DW_FORM_block1
 478 };
 479
 480 static int variable_loclist_attr [] = {
 481         DW_AT_name,     DW_FORM_string,
 482         DW_AT_type,     DW_FORM_ref4,
 483         DW_AT_location, DW_FORM_data4
 484 };
 485
 486 static int inheritance_attr [] = {
 487         DW_AT_type,        DW_FORM_ref4,
 488         DW_AT_data_member_location, DW_FORM_block1
 489 };
 490
 491 typedef struct DwarfBasicType {
 492         const char *die_name, *name;
 493         int type;
 494         int size;
 495         int encoding;
 496 } DwarfBasicType;
 497
 498 static DwarfBasicType basic_types [] = {
 499         { ".LDIE_I1", "sbyte", MONO_TYPE_I1, 1, DW_ATE_signed },
 500         { ".LDIE_U1", "byte", MONO_TYPE_U1, 1, DW_ATE_unsigned },
 501         { ".LDIE_I2", "short", MONO_TYPE_I2, 2, DW_ATE_signed },
 502         { ".LDIE_U2", "ushort", MONO_TYPE_U2, 2, DW_ATE_unsigned },
 503         { ".LDIE_I4", "int", MONO_TYPE_I4, 4, DW_ATE_signed },
 504         { ".LDIE_U4", "uint", MONO_TYPE_U4, 4, DW_ATE_unsigned },
 505         { ".LDIE_I8", "long", MONO_TYPE_I8, 8, DW_ATE_signed },
 506         { ".LDIE_U8", "ulong", MONO_TYPE_U8, 8, DW_ATE_unsigned },
 507         { ".LDIE_I", "intptr", MONO_TYPE_I, SIZEOF_VOID_P, DW_ATE_signed },
 508         { ".LDIE_U", "uintptr", MONO_TYPE_U, SIZEOF_VOID_P, DW_ATE_unsigned },
 509         { ".LDIE_R4", "float", MONO_TYPE_R4, 4, DW_ATE_float },
 510         { ".LDIE_R8", "double", MONO_TYPE_R8, 8, DW_ATE_float },
 511         { ".LDIE_BOOLEAN", "boolean", MONO_TYPE_BOOLEAN, 1, DW_ATE_boolean },
 512         { ".LDIE_CHAR", "char", MONO_TYPE_CHAR, 2, DW_ATE_unsigned_char },
 513         { ".LDIE_STRING", "string", MONO_TYPE_STRING, sizeof (gpointer), DW_ATE_address },
 514         { ".LDIE_OBJECT", "object", MONO_TYPE_OBJECT, sizeof (gpointer), DW_ATE_address },
 515         { ".LDIE_SZARRAY", "object", MONO_TYPE_SZARRAY, sizeof (gpointer), DW_ATE_address },
 516 };
 517
 518 /* Constants for encoding line number special opcodes */
 519 #define OPCODE_BASE 13
 520 #define LINE_BASE -5
 521 #define LINE_RANGE 14
 522
 523 /* Subsections of the .debug_line section */
 524 #define LINE_SUBSECTION_HEADER 1
 525 #define LINE_SUBSECTION_INCLUDES 2
 526 #define LINE_SUBSECTION_FILES 3
 527 #define LINE_SUBSECTION_DATA 4
 528 #define LINE_SUBSECTION_END 5
 529
 530 static int
 531 emit_line_number_file_name (MonoDwarfWriter *w, const char *name,
 532                                                         gint64 last_mod_time, gint64 file_size)
 533 {
 534         int index;
 535         int dir_index;
 536         char *basename = NULL;
 537
 538         if (!w->file_to_index)
 539                 w->file_to_index = g_hash_table_new (g_str_hash, g_str_equal);
 540
 541         index = GPOINTER_TO_UINT (g_hash_table_lookup (w->file_to_index, name));
 542         if (index > 0)
 543                 return index;
 544
 545         if (g_path_is_absolute (name)) {
 546                 char *dir = g_path_get_dirname (name);
 547
 548                 if (!w->dir_to_index)
 549                         w->dir_to_index = g_hash_table_new (g_str_hash, g_str_equal);
 550
 551                 dir_index = GPOINTER_TO_UINT (g_hash_table_lookup (w->dir_to_index, dir));
 552                 if (dir_index == 0) {
 553                         emit_section_change (w, ".debug_line", LINE_SUBSECTION_INCLUDES);
 554                         emit_string (w, dir);
 555
 556                         dir_index = ++ w->line_number_dir_index;
 557                         g_hash_table_insert (w->dir_to_index, g_strdup (dir), GUINT_TO_POINTER (dir_index));
 558                 }
 559
 560                 g_free (dir);
 561
 562                 basename = g_path_get_basename (name);
 563         } else {
 564                 dir_index = 0;
 565         }
 566
 567         emit_section_change (w, ".debug_line", LINE_SUBSECTION_FILES);
 568
 569         if (basename)
 570                 emit_string (w, basename);
 571         else
 572                 emit_string (w, name);
 573         emit_uleb128 (w, dir_index);
 574         emit_byte (w, 0);
 575         emit_byte (w, 0);
 576
 577         emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
 578
 579         if (basename)
 580                 g_free (basename);
 581
 582         index = ++ w->line_number_file_index;
 583         g_hash_table_insert (w->file_to_index, g_strdup (name), GUINT_TO_POINTER (index));
 584
 585         return index;
 586 }
 587
 588 static void
 589 emit_line_number_info_begin (MonoDwarfWriter *w)
 590 {
 591         /* Line number info header */
 592         /*
 593          * GAS seems to emit its own data to the end of the first subsection, so we use
 594          * subsections 1, 2 etc:
 595          * 1 - contains the header
 596          * 2 - contains the file names
 597          * 3 - contains the end of the header + the data
 598          * 4 - the end symbol
 599          */
 600         emit_section_change (w, ".debug_line", 0);
 601         emit_label (w, ".Ldebug_line_section_start");
 602         emit_section_change (w, ".debug_line", LINE_SUBSECTION_HEADER);
 603         emit_label (w, ".Ldebug_line_start");
 604         emit_symbol_diff (w, ".Ldebug_line_end", ".", -4); /* length */
 605         emit_int16 (w, 0x2); /* version */
 606         emit_symbol_diff (w, ".Ldebug_line_header_end", ".", -4); /* header_length */
 607         emit_byte (w, 1); /* minimum_instruction_length */
 608         emit_byte (w, 1); /* default_is_stmt */
 609         emit_byte (w, LINE_BASE); /* line_base */
 610         emit_byte (w, LINE_RANGE); /* line_range */
 611         emit_byte (w, OPCODE_BASE); /* opcode_base */
 612         emit_byte (w, 0); /* standard_opcode_lengths */
 613         emit_byte (w, 1);
 614         emit_byte (w, 1);
 615         emit_byte (w, 1);
 616         emit_byte (w, 1);
 617         emit_byte (w, 0);
 618         emit_byte (w, 0);
 619         emit_byte (w, 0);
 620         emit_byte (w, 1);
 621         emit_byte (w, 0);
 622         emit_byte (w, 0);
 623         emit_byte (w, 1);
 624
 625         /* Includes */
 626         emit_section_change (w, ".debug_line", LINE_SUBSECTION_INCLUDES);
 627
 628         /* End of Includes */
 629         emit_section_change (w, ".debug_line", LINE_SUBSECTION_FILES);
 630         emit_byte (w, 0);
 631
 632         /* Files */
 633         emit_line_number_file_name (w, "xdb.il", 0, 0);
 634
 635         /* End of Files */
 636         emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
 637         emit_byte (w, 0);
 638
 639         emit_label (w, ".Ldebug_line_header_end");
 640
 641         /* Emit this into a separate subsection so it gets placed at the end */
 642         emit_section_change (w, ".debug_line", LINE_SUBSECTION_END);
 643
 644         emit_byte (w, 0);
 645         emit_byte (w, 1);
 646         emit_byte (w, DW_LNE_end_sequence);
 647
 648         emit_label (w, ".Ldebug_line_end");
 649 }
 650
 651 /*
 652  * Some assemblers like apple's do not support subsections, so we can't place
 653  * .Ldebug_info_end at the end of the section using subsections. Instead, we
 654  * define it every time something gets added to the .debug_info section.
 655  * The apple assember seems to use the last definition.
 656  */
 657 static void
 658 emit_debug_info_end (MonoDwarfWriter *w)
 659 {
 660         /* This doesn't seem to work/required with recent iphone sdk versions */
 661 #if 0
 662         if (!img_writer_subsections_supported (w->w))
 663                 fprintf (w->fp, "\n.set %sdebug_info_end,.\n", w->temp_prefix);
 664 #endif
 665 }
 666
 667 void
 668 mono_dwarf_writer_emit_base_info (MonoDwarfWriter *w, GSList *base_unwind_program)
 669 {
 670         char *s, *build_info;
 671         int i;
 672
 673         if (!img_writer_subsections_supported (w->w))
 674                 /* Can't emit line number info without subsections */
 675                 w->emit_line = FALSE;
 676         else
 677                 w->emit_line = TRUE;
 678
 679         w->cie_program = base_unwind_program;
 680
 681         emit_section_change (w, ".debug_abbrev", 0);
 682         emit_dwarf_abbrev (w, ABBREV_COMPILE_UNIT, DW_TAG_compile_unit, TRUE,
 683                                            compile_unit_attr, G_N_ELEMENTS (compile_unit_attr));
 684         emit_dwarf_abbrev (w, ABBREV_SUBPROGRAM, DW_TAG_subprogram, TRUE,
 685                                            subprogram_attr, G_N_ELEMENTS (subprogram_attr));
 686         emit_dwarf_abbrev (w, ABBREV_PARAM, DW_TAG_formal_parameter, FALSE,
 687                                            param_attr, G_N_ELEMENTS (param_attr));
 688         emit_dwarf_abbrev (w, ABBREV_PARAM_LOCLIST, DW_TAG_formal_parameter, FALSE,
 689                                            param_loclist_attr, G_N_ELEMENTS (param_loclist_attr));
 690         emit_dwarf_abbrev (w, ABBREV_BASE_TYPE, DW_TAG_base_type, FALSE,
 691                                            base_type_attr, G_N_ELEMENTS (base_type_attr));
 692         emit_dwarf_abbrev (w, ABBREV_STRUCT_TYPE, DW_TAG_class_type, TRUE,
 693                                            struct_type_attr, G_N_ELEMENTS (struct_type_attr));
 694         emit_dwarf_abbrev (w, ABBREV_STRUCT_TYPE_NOCHILDREN, DW_TAG_class_type, FALSE,
 695                                            struct_type_attr, G_N_ELEMENTS (struct_type_attr));
 696         emit_dwarf_abbrev (w, ABBREV_DATA_MEMBER, DW_TAG_member, FALSE,
 697                                            data_member_attr, G_N_ELEMENTS (data_member_attr));
 698         emit_dwarf_abbrev (w, ABBREV_TYPEDEF, DW_TAG_typedef, FALSE,
 699                                            typedef_attr, G_N_ELEMENTS (typedef_attr));
 700         emit_dwarf_abbrev (w, ABBREV_ENUM_TYPE, DW_TAG_enumeration_type, TRUE,
 701                                            enum_type_attr, G_N_ELEMENTS (enum_type_attr));
 702         emit_dwarf_abbrev (w, ABBREV_ENUMERATOR, DW_TAG_enumerator, FALSE,
 703                                            enumerator_attr, G_N_ELEMENTS (enumerator_attr));
 704         emit_dwarf_abbrev (w, ABBREV_NAMESPACE, DW_TAG_namespace, TRUE,
 705                                            namespace_attr, G_N_ELEMENTS (namespace_attr));
 706         emit_dwarf_abbrev (w, ABBREV_VARIABLE, DW_TAG_variable, FALSE,
 707                                            variable_attr, G_N_ELEMENTS (variable_attr));
 708         emit_dwarf_abbrev (w, ABBREV_VARIABLE_LOCLIST, DW_TAG_variable, FALSE,
 709                                            variable_loclist_attr, G_N_ELEMENTS (variable_loclist_attr));
 710         emit_dwarf_abbrev (w, ABBREV_POINTER_TYPE, DW_TAG_pointer_type, FALSE,
 711                                            pointer_type_attr, G_N_ELEMENTS (pointer_type_attr));
 712         emit_dwarf_abbrev (w, ABBREV_REFERENCE_TYPE, DW_TAG_reference_type, FALSE,
 713                                            reference_type_attr, G_N_ELEMENTS (reference_type_attr));
 714         emit_dwarf_abbrev (w, ABBREV_INHERITANCE, DW_TAG_inheritance, FALSE,
 715                                            inheritance_attr, G_N_ELEMENTS (inheritance_attr));
 716         emit_byte (w, 0);
 717
 718         emit_section_change (w, ".debug_info", 0);
 719         emit_label (w, ".Ldebug_info_start");
 720         emit_symbol_diff (w, ".Ldebug_info_end", ".Ldebug_info_begin", 0); /* length */
 721         emit_label (w, ".Ldebug_info_begin");
 722         emit_int16 (w, 0x2); /* DWARF version 2 */
 723         emit_int32 (w, 0); /* .debug_abbrev offset */
 724         emit_byte (w, sizeof (gpointer)); /* address size */
 725
 726         if (img_writer_subsections_supported (w->w) && w->appending) {
 727                 /* Emit this into a separate section so it gets placed at the end */
 728                 emit_section_change (w, ".debug_info", 1);
 729                 emit_byte (w, 0); /* close COMPILE_UNIT */
 730                 emit_label (w, ".Ldebug_info_end");
 731                 emit_section_change (w, ".debug_info", 0);
 732         }
 733
 734         /* Compilation unit */
 735         emit_uleb128 (w, ABBREV_COMPILE_UNIT);
 736         build_info = mono_get_runtime_build_info ();
 737         s = g_strdup_printf ("Mono AOT Compiler %s", build_info);
 738         emit_string (w, s);
 739         g_free (build_info);
 740         g_free (s);
 741         emit_string (w, "JITted code");
 742         emit_string (w, "");
 743         emit_byte (w, DW_LANG_C);
 744         emit_pointer_value (w, 0);
 745         emit_pointer_value (w, 0);
 746         /* offset into .debug_line section */
 747         emit_symbol_diff (w, ".Ldebug_line_start", ".Ldebug_line_section_start", 0);
 748
 749         /* Base types */
 750         for (i = 0; i < G_N_ELEMENTS (basic_types); ++i) {
 751                 emit_label (w, basic_types [i].die_name);
 752                 emit_uleb128 (w, ABBREV_BASE_TYPE);
 753                 emit_byte (w, basic_types [i].size);
 754                 emit_byte (w, basic_types [i].encoding);
 755                 emit_string (w, basic_types [i].name);
 756         }
 757
 758         emit_debug_info_end (w);
 759
 760         /* debug_loc section */
 761         emit_section_change (w, ".debug_loc", 0);
 762         emit_label (w, ".Ldebug_loc_start");
 763
 764         /* debug_line section */
 765         /*
 766          * We emit some info even if emit_line is FALSE, as the
 767          * apple linker seems to require a .debug_line section.
 768          */
 769         emit_line_number_info_begin (w);
 770
 771         emit_cie (w);
 772 }
 773
 774 /*
 775  * mono_dwarf_writer_close:
 776  *
 777  *   Finalize the emitted debugging info.
 778  */
 779 void
 780 mono_dwarf_writer_close (MonoDwarfWriter *w)
 781 {
 782         if (!w->appending) {
 783                 emit_section_change (w, ".debug_info", 0);
 784                 emit_byte (w, 0); /* close COMPILE_UNIT */
 785                 emit_label (w, ".Ldebug_info_end");
 786         }
 787 }
 788
 789 static const char* emit_type (MonoDwarfWriter *w, MonoType *t);
 790
 791 /* Returns the local symbol pointing to the emitted debug info */
 792 static char*
 793 emit_class_dwarf_info (MonoDwarfWriter *w, MonoClass *klass, gboolean vtype)
 794 {
 795         char *die, *pointer_die, *reference_die;
 796         char *full_name, *p;
 797         gpointer iter;
 798         MonoClassField *field;
 799         const char *fdie;
 800         int k;
 801         gboolean emit_namespace = FALSE, has_children;
 802         GHashTable *cache;
 803
 804         // FIXME: Appdomains
 805         if (!w->class_to_die)
 806                 w->class_to_die = g_hash_table_new (NULL, NULL);
 807         if (!w->class_to_vtype_die)
 808                 w->class_to_vtype_die = g_hash_table_new (NULL, NULL);
 809         if (!w->class_to_pointer_die)
 810                 w->class_to_pointer_die = g_hash_table_new (NULL, NULL);
 811         if (!w->class_to_reference_die)
 812                 w->class_to_reference_die = g_hash_table_new (NULL, NULL);
 813
 814         if (vtype)
 815                 cache = w->class_to_vtype_die;
 816         else
 817                 cache = w->class_to_die;
 818
 819         die = g_hash_table_lookup (cache, klass);
 820         if (die)
 821                 return die;
 822
 823         if (!((klass->byval_arg.type == MONO_TYPE_CLASS) || (klass->byval_arg.type == MONO_TYPE_OBJECT) || klass->byval_arg.type == MONO_TYPE_GENERICINST || klass->enumtype || (klass->byval_arg.type == MONO_TYPE_VALUETYPE && vtype)))
 824                 return NULL;
 825
 826         /*
 827          * FIXME: gdb can't handle namespaces in languages it doesn't know about.
 828          */
 829         /*
 830         if (klass->name_space && klass->name_space [0] != '\0')
 831                 emit_namespace = TRUE;
 832         */
 833         if (emit_namespace) {
 834                 emit_uleb128 (w, ABBREV_NAMESPACE);
 835                 emit_string (w, klass->name_space);
 836         }
 837
 838         full_name = g_strdup_printf ("%s%s%s", klass->name_space, klass->name_space ? "." : "", klass->name);
 839         /*
 840          * gdb doesn't support namespaces for non-C++ dwarf objects, so use _
 841          * to separate components.
 842          */
 843         for (p = full_name; *p; p ++)
 844                 if (*p == '.')
 845                         *p = '_';
 846
 847         die = g_strdup_printf (".LTDIE_%d", w->tdie_index);
 848         pointer_die = g_strdup_printf (".LTDIE_%d_POINTER", w->tdie_index);
 849         reference_die = g_strdup_printf (".LTDIE_%d_REFERENCE", w->tdie_index);
 850         w->tdie_index ++;
 851
 852         g_hash_table_insert (w->class_to_pointer_die, klass, pointer_die);
 853         g_hash_table_insert (w->class_to_reference_die, klass, reference_die);
 854         g_hash_table_insert (cache, klass, die);
 855
 856         if (klass->enumtype) {
 857                 int size = mono_class_value_size (mono_class_from_mono_type (mono_class_enum_basetype (klass)), NULL);
 858
 859                 emit_label (w, die);
 860
 861                 emit_uleb128 (w, ABBREV_ENUM_TYPE);
 862                 emit_string (w, full_name);
 863                 emit_uleb128 (w, size);
 864                 for (k = 0; k < G_N_ELEMENTS (basic_types); ++k)
 865                         if (basic_types [k].type == mono_class_enum_basetype (klass)->type)
 866                                 break;
 867                 g_assert (k < G_N_ELEMENTS (basic_types));
 868                 emit_symbol_diff (w, basic_types [k].die_name, ".Ldebug_info_start", 0);
 869
 870                 /* Emit enum values */
 871                 iter = NULL;
 872                 while ((field = mono_class_get_fields (klass, &iter))) {
 873                         const char *p;
 874                         int len;
 875                         MonoTypeEnum def_type;
 876
 877                         if (strcmp ("value__", mono_field_get_name (field)) == 0)
 878                                 continue;
 879                         if (mono_field_is_deleted (field))
 880                                 continue;
 881
 882                         emit_uleb128 (w, ABBREV_ENUMERATOR);
 883                         emit_string (w, mono_field_get_name (field));
 884
 885                         p = mono_class_get_field_default_value (field, &def_type);
 886                         len = mono_metadata_decode_blob_size (p, &p);
 887                         switch (mono_class_enum_basetype (klass)->type) {
 888                         case MONO_TYPE_U1:
 889                         case MONO_TYPE_I1:
 890                         case MONO_TYPE_BOOLEAN:
 891                                 emit_sleb128 (w, *p);
 892                                 break;
 893                         case MONO_TYPE_U2:
 894                         case MONO_TYPE_I2:
 895                         case MONO_TYPE_CHAR:
 896                                 emit_sleb128 (w, read16 (p));
 897                                 break;
 898                         case MONO_TYPE_U4:
 899                         case MONO_TYPE_I4:
 900                                 emit_sleb128 (w, read32 (p));
 901                                 break;
 902                         case MONO_TYPE_U8:
 903                         case MONO_TYPE_I8:
 904                                 emit_sleb128 (w, read64 (p));
 905                                 break;
 906                         case MONO_TYPE_I:
 907                         case MONO_TYPE_U:
 908 #if SIZEOF_VOID_P == 8
 909                                 emit_sleb128 (w, read64 (p));
 910 #else
 911                                 emit_sleb128 (w, read32 (p));
 912 #endif
 913                                 break;
 914                         default:
 915                                 g_assert_not_reached ();
 916                         }
 917                 }
 918
 919                 has_children = TRUE;
 920         } else {
 921                 guint8 buf [128];
 922                 guint8 *p;
 923                 char *parent_die;
 924
 925                 if (klass->parent)
 926                         parent_die = emit_class_dwarf_info (w, klass->parent, FALSE);
 927                 else
 928                         parent_die = NULL;
 929
 930                 /* Emit field types */
 931                 iter = NULL;
 932                 while ((field = mono_class_get_fields (klass, &iter))) {
 933                         if (field->type->attrs & FIELD_ATTRIBUTE_STATIC)
 934                                 continue;
 935
 936                         emit_type (w, field->type);
 937                 }
 938
 939                 iter = NULL;
 940                 has_children = parent_die || mono_class_get_fields (klass, &iter);
 941
 942                 emit_label (w, die);
 943
 944                 emit_uleb128 (w, has_children ? ABBREV_STRUCT_TYPE : ABBREV_STRUCT_TYPE_NOCHILDREN);
 945                 emit_string (w, full_name);
 946                 emit_uleb128 (w, klass->instance_size);
 947
 948                 if (parent_die) {
 949                         emit_uleb128 (w, ABBREV_INHERITANCE);
 950                         emit_symbol_diff (w, parent_die, ".Ldebug_info_start", 0);
 951
 952                         p = buf;
 953                         *p ++= DW_OP_plus_uconst;
 954                         encode_uleb128 (0, p, &p);
 955                         emit_byte (w, p - buf);
 956                         emit_bytes (w, buf, p - buf);
 957                 }
 958
 959                 /* Emit fields */
 960                 iter = NULL;
 961                 while ((field = mono_class_get_fields (klass, &iter))) {
 962                         if (field->type->attrs & FIELD_ATTRIBUTE_STATIC)
 963                                 continue;
 964
 965                         fdie = emit_type (w, field->type);
 966                         if (fdie) {
 967                                 emit_uleb128 (w, ABBREV_DATA_MEMBER);
 968                                 emit_string (w, field->name);
 969                                 emit_symbol_diff (w, fdie, ".Ldebug_info_start", 0);
 970                                 /* location */
 971                                 p = buf;
 972                                 *p ++= DW_OP_plus_uconst;
 973                                 if (klass->valuetype && vtype)
 974                                         encode_uleb128 (field->offset - sizeof (MonoObject), p, &p);
 975                                 else
 976                                         encode_uleb128 (field->offset, p, &p);
 977
 978                                 emit_byte (w, p - buf);
 979                                 emit_bytes (w, buf, p - buf);
 980                         }
 981                 }
 982         }
 983
 984         /* Type end */
 985         if (has_children)
 986                 emit_uleb128 (w, 0x0);
 987
 988         /* Add a typedef, so we can reference the type without a 'struct' in gdb */
 989         emit_uleb128 (w, ABBREV_TYPEDEF);
 990         emit_string (w, full_name);
 991         emit_symbol_diff (w, die, ".Ldebug_info_start", 0);
 992
 993         /* Add a pointer type */
 994         emit_label (w, pointer_die);
 995
 996         emit_uleb128 (w, ABBREV_POINTER_TYPE);
 997         emit_symbol_diff (w, die, ".Ldebug_info_start", 0);
 998
 999         /* Add a reference type */
1000         emit_label (w, reference_die);
1001
1002         emit_uleb128 (w, ABBREV_REFERENCE_TYPE);
1003         emit_symbol_diff (w, die, ".Ldebug_info_start", 0);
1004
1005         g_free (full_name);
1006
1007         if (emit_namespace) {
1008                 /* Namespace end */
1009                 emit_uleb128 (w, 0x0);
1010         }
1011
1012         return die;
1013 }
1014
1015 static const char*
1016 emit_type (MonoDwarfWriter *w, MonoType *t)
1017 {
1018         MonoClass *klass = mono_class_from_mono_type (t);
1019         int j;
1020         const char *tdie;
1021
1022         if (t->byref) {
1023                 if (t->type == MONO_TYPE_VALUETYPE) {
1024                         tdie = emit_class_dwarf_info (w, klass, TRUE);
1025                         if (tdie)
1026                                 return g_hash_table_lookup (w->class_to_pointer_die, klass);
1027                 }
1028                 else {
1029                         tdie = emit_class_dwarf_info (w, klass, FALSE);
1030                         /* Should return a pointer type to a reference */
1031                 }
1032                 // FIXME:
1033                 t = &mono_defaults.int_class->byval_arg;
1034         }
1035         for (j = 0; j < G_N_ELEMENTS (basic_types); ++j)
1036                 if (basic_types [j].type == t->type)
1037                         break;
1038         if (j < G_N_ELEMENTS (basic_types))
1039                 tdie = basic_types [j].die_name;
1040         else {
1041                 switch (t->type) {
1042                 case MONO_TYPE_CLASS:
1043                         emit_class_dwarf_info (w, klass, FALSE);
1044                         tdie = g_hash_table_lookup (w->class_to_reference_die, klass);
1045                         //tdie = ".LDIE_OBJECT";
1046                         break;
1047                 case MONO_TYPE_ARRAY:
1048                         tdie = ".LDIE_OBJECT";
1049                         break;
1050                 case MONO_TYPE_VALUETYPE:
1051                         if (klass->enumtype)
1052                                 tdie = emit_class_dwarf_info (w, klass, FALSE);
1053                         else
1054                                 tdie = ".LDIE_I4";
1055                         break;
1056                 case MONO_TYPE_GENERICINST:
1057                         if (!MONO_TYPE_ISSTRUCT (t)) {
1058                                 emit_class_dwarf_info (w, klass, FALSE);
1059                                 tdie = g_hash_table_lookup (w->class_to_reference_die, klass);
1060                         } else {
1061                                 tdie = ".LDIE_I4";
1062                         }
1063                         break;
1064                 default:
1065                         tdie = ".LDIE_I4";
1066                         break;
1067                 }
1068         }
1069
1070         return tdie;
1071 }
1072
1073 static void
1074 emit_var_type (MonoDwarfWriter *w, MonoType *t)
1075 {
1076         const char *tdie;
1077
1078         tdie = emit_type (w, t);
1079
1080         emit_symbol_diff (w, tdie, ".Ldebug_info_start", 0);
1081 }
1082
1083 static void
1084 encode_var_location (MonoDwarfWriter *w, MonoInst *ins, guint8 *p, guint8 **endp)
1085 {
1086         /* location */
1087         /* FIXME: This needs a location list, since the args can go from reg->stack */
1088         if (!ins || ins->flags & MONO_INST_IS_DEAD) {
1089                 /* gdb treats this as optimized out */
1090         } else if (ins->opcode == OP_REGVAR) {
1091                 *p = DW_OP_reg0 + mono_hw_reg_to_dwarf_reg (ins->dreg);
1092                 p ++;
1093         } else if (ins->opcode == OP_REGOFFSET) {
1094                 *p ++= DW_OP_breg0 + mono_hw_reg_to_dwarf_reg (ins->inst_basereg);
1095                 encode_sleb128 (ins->inst_offset, p, &p);
1096         } else {
1097                 // FIXME:
1098                 *p ++ = DW_OP_reg0;
1099         }
1100
1101         *endp = p;
1102 }
1103
1104 static void
1105 emit_loclist (MonoDwarfWriter *w, MonoInst *ins,
1106                           guint8 *loclist_begin_addr, guint8 *loclist_end_addr,
1107                           guint8 *expr, guint32 expr_len)
1108 {
1109         char label [128];
1110
1111         emit_push_section (w, ".debug_loc", 0);
1112         sprintf (label, ".Lloclist_%d", w->loclist_index ++ );
1113         emit_label (w, label);
1114
1115         emit_pointer_value (w, loclist_begin_addr);
1116         emit_pointer_value (w, loclist_end_addr);
1117         emit_byte (w, expr_len % 256);
1118         emit_byte (w, expr_len / 256);
1119         emit_bytes (w, expr, expr_len);
1120
1121         emit_pointer_value (w, NULL);
1122         emit_pointer_value (w, NULL);
1123
1124         emit_pop_section (w);
1125         emit_symbol_diff (w, label, ".Ldebug_loc_start", 0);
1126 }
1127
1128 /*
1129  * MonoDisHelper->tokener doesn't take an IP argument, and we can't add one since
1130  * it is a public header.
1131  */
1132 static const guint8 *token_handler_ip;
1133
1134 static char*
1135 token_handler (MonoDisHelper *dh, MonoMethod *method, guint32 token)
1136 {
1137         char *res, *desc;
1138         MonoMethod *cmethod;
1139         MonoClass *klass;
1140         MonoClassField *field;
1141         gpointer data = NULL;
1142
1143         if (method->wrapper_type)
1144                 data = mono_method_get_wrapper_data (method, token);
1145
1146         switch (*token_handler_ip) {
1147         case CEE_ISINST:
1148         case CEE_CASTCLASS:
1149         case CEE_LDELEMA:
1150                 if (method->wrapper_type)
1151                         klass = data;
1152                 else
1153                         klass = mono_class_get_full (method->klass->image, token, NULL);
1154                 res = g_strdup_printf ("<%s>", klass->name);
1155                 break;
1156         case CEE_NEWOBJ:
1157         case CEE_CALL:
1158         case CEE_CALLVIRT:
1159                 if (method->wrapper_type)
1160                         cmethod = data;
1161                 else
1162                         cmethod = mono_get_method_full (method->klass->image, token, NULL, NULL);
1163                 desc = mono_method_full_name (cmethod, TRUE);
1164                 res = g_strdup_printf ("<%s>", desc);
1165                 g_free (desc);
1166                 break;
1167         case CEE_CALLI:
1168                 if (method->wrapper_type) {
1169                         desc = mono_signature_get_desc (data, FALSE);
1170                         res = g_strdup_printf ("<%s>", desc);
1171                         g_free (desc);
1172                 } else {
1173                         res = g_strdup_printf ("<0x%08x>", token);
1174                 }
1175                 break;
1176         case CEE_LDFLD:
1177         case CEE_LDSFLD:
1178         case CEE_STFLD:
1179         case CEE_STSFLD:
1180                 if (method->wrapper_type)
1181                         field = data;
1182                 else
1183                         field = mono_field_from_token (method->klass->image, token, &klass, NULL);
1184                 desc = mono_field_full_name (field);
1185                 res = g_strdup_printf ("<%s>", desc);
1186                 g_free (desc);
1187                 break;
1188         default:
1189                 res = g_strdup_printf ("<0x%08x>", token);
1190                 break;
1191         }
1192
1193         return res;
1194 }
1195
1196 /*
1197  * disasm_ins:
1198  *
1199  *   Produce a disassembled form of the IL instruction at IP. This is an extension
1200  * of mono_disasm_code_one () which can disasm tokens, handle wrapper methods, and
1201  * CEE_MONO_ opcodes.
1202  */
1203 static char*
1204 disasm_ins (MonoMethod *method, const guchar *ip, const guint8 **endip)
1205 {
1206         char *dis;
1207         MonoDisHelper dh;
1208         MonoMethodHeader *header = mono_method_get_header (method);
1209
1210         memset (&dh, 0, sizeof (dh));
1211         dh.newline = "";
1212         dh.label_format = "IL_%04x: ";
1213         dh.label_target = "IL_%04x";
1214         dh.tokener = token_handler;
1215
1216         token_handler_ip = ip;
1217         if (*ip == MONO_CUSTOM_PREFIX) {
1218                 guint32 token;
1219                 gpointer data;
1220
1221                 switch (ip [1]) {
1222                 case CEE_MONO_ICALL: {
1223                         MonoJitICallInfo *info;
1224
1225                         token = read32 (ip + 2);
1226                         data = mono_method_get_wrapper_data (method, token);
1227                         info = mono_find_jit_icall_by_addr (data);
1228                         g_assert (info);
1229
1230                         dis = g_strdup_printf ("IL_%04x: mono_icall <%s>", (int)(ip - header->code), info->name);
1231                         ip += 6;
1232                         break;
1233                 }
1234                 case CEE_MONO_CLASSCONST: {
1235                         token = read32 (ip + 2);
1236                         data = mono_method_get_wrapper_data (method, token);
1237
1238                         dis = g_strdup_printf ("IL_%04x: mono_classconst <%s>", (int)(ip - header->code), ((MonoClass*)data)->name);
1239                         ip += 6;
1240                         break;
1241                 }
1242                 default:
1243                         dis = mono_disasm_code_one (&dh, method, ip, &ip);
1244                 }
1245         } else {
1246                 dis = mono_disasm_code_one (&dh, method, ip, &ip);
1247         }
1248         token_handler_ip = NULL;
1249
1250         *endip = ip;
1251         return dis;
1252 }
1253
1254 static gint32
1255 il_offset_from_address (MonoMethod *method, MonoDebugMethodJitInfo *jit,
1256                                                 guint32 native_offset)
1257 {
1258         int i;
1259
1260         if (!jit->line_numbers)
1261                 return -1;
1262
1263         for (i = jit->num_line_numbers - 1; i >= 0; i--) {
1264                 MonoDebugLineNumberEntry lne = jit->line_numbers [i];
1265
1266                 if (lne.native_offset <= native_offset)
1267                         return lne.il_offset;
1268         }
1269
1270         return -1;
1271 }
1272
1273 static int max_special_addr_diff = 0;
1274
1275 static inline void
1276 emit_advance_op (MonoDwarfWriter *w, int line_diff, int addr_diff)
1277 {
1278         gint64 opcode = 0;
1279
1280         /* Use a special opcode if possible */
1281         if (line_diff - LINE_BASE >= 0 && line_diff - LINE_BASE < LINE_RANGE) {
1282                 if (max_special_addr_diff == 0)
1283                         max_special_addr_diff = (255 - OPCODE_BASE) / LINE_RANGE;
1284
1285                 if (addr_diff > max_special_addr_diff && (addr_diff < 2 * max_special_addr_diff)) {
1286                         emit_byte (w, DW_LNS_const_add_pc);
1287                         addr_diff -= max_special_addr_diff;
1288                 }
1289
1290                 opcode = (line_diff - LINE_BASE) + (LINE_RANGE * addr_diff) + OPCODE_BASE;
1291                 if (opcode > 255)
1292                         opcode = 0;
1293         }
1294
1295         if (opcode != 0) {
1296                 emit_byte (w, opcode);
1297         } else {
1298                 emit_byte (w, DW_LNS_advance_line);
1299                 emit_sleb128 (w, line_diff);
1300                 emit_byte (w, DW_LNS_advance_pc);
1301                 emit_sleb128 (w, addr_diff);
1302                 emit_byte (w, DW_LNS_copy);
1303         }
1304 }
1305
1306 static gint
1307 compare_lne (MonoDebugLineNumberEntry *a, MonoDebugLineNumberEntry *b)
1308 {
1309         if (a->native_offset == b->native_offset)
1310                 return a->il_offset - b->il_offset;
1311         else
1312                 return a->native_offset - b->native_offset;
1313 }
1314
1315 static void
1316 emit_line_number_info (MonoDwarfWriter *w, MonoMethod *method,
1317                                            char *start_symbol, char *end_symbol,
1318                                            guint8 *code, guint32 code_size,
1319                                            MonoDebugMethodJitInfo *debug_info)
1320 {
1321         guint32 prev_line = 0;
1322         guint32 prev_native_offset = 0;
1323         int i, file_index, il_offset, prev_il_offset;
1324         gboolean first = TRUE;
1325         MonoDebugSourceLocation *loc;
1326         char *prev_file_name = NULL;
1327         MonoMethodHeader *header = mono_method_get_header (method);
1328         MonoDebugMethodInfo *minfo;
1329         GArray *ln_array;
1330         int *native_to_il_offset = NULL;
1331
1332         if (!w->emit_line)
1333                 return;
1334
1335         minfo = mono_debug_lookup_method (method);
1336
1337         /* Compute the native->IL offset mapping */
1338
1339         g_assert (code_size);
1340
1341 #ifndef _EGLIB_MAJOR
1342         ln_array = g_array_sized_new (FALSE, FALSE, sizeof (MonoDebugLineNumberEntry),
1343                                                                   debug_info->num_line_numbers);
1344         g_array_append_vals (ln_array, debug_info->line_numbers, debug_info->num_line_numbers);
1345         g_array_sort (ln_array, (GCompareFunc)compare_lne);
1346         native_to_il_offset = g_new0 (int, code_size + 1);
1347
1348         for (i = 0; i < debug_info->num_line_numbers; ++i) {
1349                 int j;
1350                 MonoDebugLineNumberEntry lne = g_array_index (ln_array, MonoDebugLineNumberEntry, i);
1351
1352                 if (i == 0) {
1353                         for (j = 0; j < lne.native_offset; ++j)
1354                                 native_to_il_offset [j] = -1;
1355                 }
1356
1357                 if (i < debug_info->num_line_numbers - 1) {
1358                         MonoDebugLineNumberEntry lne_next = g_array_index (ln_array, MonoDebugLineNumberEntry, i + 1);
1359
1360                         for (j = lne.native_offset; j < lne_next.native_offset; ++j)
1361                                 native_to_il_offset [j] = lne.il_offset;
1362                 } else {
1363                         for (j = lne.native_offset; j < code_size; ++j)
1364                                 native_to_il_offset [j] = lne.il_offset;
1365                 }
1366         }
1367         g_array_free (ln_array, TRUE);
1368 #endif
1369
1370         prev_line = 1;
1371         prev_il_offset = -1;
1372
1373         for (i = 0; i < code_size; ++i) {
1374                 if (!minfo)
1375                         continue;
1376
1377                 if (!debug_info->line_numbers)
1378                         continue;
1379
1380                 if (native_to_il_offset)
1381                         il_offset = native_to_il_offset [i];
1382                 else
1383                         il_offset = il_offset_from_address (method, debug_info, i);
1384                 /*
1385                 il_offset = il_offset_from_address (method, debug_info, i);
1386
1387                 g_assert (il_offset == native_to_il_offset [i]);
1388                 */
1389
1390                 il_offset = native_to_il_offset [i];
1391                 if (il_offset < 0)
1392                         continue;
1393
1394                 if (il_offset == prev_il_offset)
1395                         continue;
1396
1397                 prev_il_offset = il_offset;
1398
1399                 loc = mono_debug_symfile_lookup_location (minfo, il_offset);
1400
1401                 if (loc) {
1402                         int line_diff = (gint32)loc->row - (gint32)prev_line;
1403                         int addr_diff = i - prev_native_offset;
1404
1405                         if (first) {
1406                                 emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
1407
1408                                 emit_byte (w, 0);
1409                                 emit_byte (w, sizeof (gpointer) + 1);
1410                                 emit_byte (w, DW_LNE_set_address);
1411                                 if (start_symbol)
1412                                         emit_pointer_unaligned (w, start_symbol);
1413                                 else
1414                                         emit_pointer_value (w, code);
1415
1416                                 /*
1417                                  * The prolog+initlocals region does not have a line number, this
1418                                  * makes them belong to the first line of the method.
1419                                  */
1420                                 emit_byte (w, DW_LNS_advance_line);
1421                                 emit_sleb128 (w, (gint32)loc->row - (gint32)prev_line);
1422                                 prev_line = loc->row;
1423                         }
1424
1425                         if (loc->row != prev_line) {
1426                                 if (!prev_file_name || strcmp (loc->source_file, prev_file_name) != 0) {
1427                                         /* Add an entry to the file table */
1428                                         /* FIXME: Avoid duplicates */
1429                                         file_index = emit_line_number_file_name (w, loc->source_file, 0, 0);
1430                                         g_free (prev_file_name);
1431                                         prev_file_name = g_strdup (loc->source_file);
1432
1433                                         emit_byte (w, DW_LNS_set_file);
1434                                         emit_uleb128 (w, file_index);
1435                                         emit_byte (w, DW_LNS_copy);
1436                                 }
1437
1438                                 //printf ("X: %p(+0x%x) %d %s:%d(+%d)\n", code + i, addr_diff, loc->il_offset, loc->source_file, loc->row, line_diff);
1439
1440                                 emit_advance_op (w, line_diff, addr_diff);
1441
1442                                 prev_line = loc->row;
1443                                 prev_native_offset = i;
1444                         }
1445
1446                         first = FALSE;
1447                         g_free (loc);
1448                 }
1449         }
1450
1451         g_free (prev_file_name);
1452
1453         if (!first) {
1454                 emit_byte (w, DW_LNS_advance_pc);
1455                 emit_sleb128 (w, code_size - prev_native_offset);
1456                 emit_byte (w, DW_LNS_copy);
1457
1458                 emit_byte (w, 0);
1459                 emit_byte (w, 1);
1460                 emit_byte (w, DW_LNE_end_sequence);
1461         } else if (!start_symbol) {
1462                 /* No debug info, XDEBUG mode */
1463                 char *name, *dis;
1464                 const guint8 *ip = header->code;
1465                 int prev_line, prev_native_offset;
1466                 int *il_to_line;
1467
1468                 /*
1469                  * Emit the IL code into a temporary file and emit line number info
1470                  * referencing that file.
1471                  */
1472
1473                 name = mono_method_full_name (method, TRUE);
1474                 fprintf (w->il_file, "// %s\n", name);
1475                 w->il_file_line_index ++;
1476                 g_free (name);
1477
1478                 il_to_line = g_new0 (int, header->code_size);
1479
1480                 emit_section_change (w, ".debug_line", LINE_SUBSECTION_DATA);
1481                 emit_byte (w, 0);
1482                 emit_byte (w, sizeof (gpointer) + 1);
1483                 emit_byte (w, DW_LNE_set_address);
1484                 emit_pointer_value (w, code);
1485
1486                 // FIXME: Optimize this
1487                 while (ip < header->code + header->code_size) {
1488                         int il_offset = ip - header->code;
1489
1490                         /* Emit IL */
1491                         w->il_file_line_index ++;
1492
1493                         dis = disasm_ins (method, ip, &ip);
1494                         fprintf (w->il_file, "%s\n", dis);
1495                         g_free (dis);
1496
1497                         il_to_line [il_offset] = w->il_file_line_index;
1498                 }
1499
1500                 /* Emit line number info */
1501                 prev_line = 1;
1502                 prev_native_offset = 0;
1503                 for (i = 0; i < debug_info->num_line_numbers; ++i) {
1504                         MonoDebugLineNumberEntry *lne = &debug_info->line_numbers [i];
1505                         int line;
1506
1507                         if (lne->il_offset >= header->code_size)
1508                                 continue;
1509                         line = il_to_line [lne->il_offset];
1510                         if (!line) {
1511                                 /*
1512                                  * This seems to happen randomly, it looks like il_offset points
1513                                  * into the middle of an instruction.
1514                                  */
1515                                 continue;
1516                                 /*
1517                                 printf ("%s\n", mono_method_full_name (method, TRUE));
1518                                 printf ("%d %d\n", lne->il_offset, header->code_size);
1519                                 g_assert (line);
1520                                 */
1521                         }
1522
1523                         if (line - prev_line != 0) {
1524                                 emit_advance_op (w, line - prev_line, (gint32)lne->native_offset - prev_native_offset);
1525
1526                                 prev_line = line;
1527                                 prev_native_offset = lne->native_offset;
1528                         }
1529                 }
1530
1531                 emit_byte (w, DW_LNS_advance_pc);
1532                 emit_sleb128 (w, code_size - prev_native_offset);
1533                 emit_byte (w, DW_LNS_copy);
1534
1535                 emit_byte (w, 0);
1536                 emit_byte (w, 1);
1537                 emit_byte (w, DW_LNE_end_sequence);
1538
1539                 fflush (w->il_file);
1540                 g_free (il_to_line);
1541         }
1542 }
1543
1544 static MonoMethodVar*
1545 find_vmv (MonoCompile *cfg, MonoInst *ins)
1546 {
1547         int j;
1548
1549         if (cfg->varinfo) {
1550                 for (j = 0; j < cfg->num_varinfo; ++j) {
1551                         if (cfg->varinfo [j] == ins)
1552                                 break;
1553                 }
1554
1555                 if (j < cfg->num_varinfo) {
1556                         return MONO_VARINFO (cfg, j);
1557                 }
1558         }
1559
1560         return NULL;
1561 }
1562
1563 void
1564 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)
1565 {
1566         char *name;
1567         MonoMethodSignature *sig;
1568         MonoMethodHeader *header;
1569         char **names, **tdies, **local_tdies;
1570         char **local_names;
1571         int *local_indexes;
1572         int i, num_locals;
1573         guint8 buf [128];
1574         guint8 *p;
1575
1576         emit_section_change (w, ".debug_info", 0);
1577
1578         sig = mono_method_signature (method);
1579         header = mono_method_get_header (method);
1580
1581         /* Parameter types */
1582         tdies = g_new0 (char *, sig->param_count + sig->hasthis);
1583         for (i = 0; i < sig->param_count + sig->hasthis; ++i) {
1584                 MonoType *t;
1585
1586                 if (i == 0 && sig->hasthis) {
1587                         if (method->klass->valuetype)
1588                                 t = &method->klass->this_arg;
1589                         else
1590                                 t = &method->klass->byval_arg;
1591                 } else {
1592                         t = sig->params [i - sig->hasthis];
1593                 }
1594
1595                 emit_type (w, t);
1596         }
1597
1598         /* Local types */
1599         local_tdies = g_new0 (char *, header->num_locals);
1600         for (i = 0; i < header->num_locals; ++i) {
1601                 emit_type (w, header->locals [i]);
1602         }
1603
1604         /* Subprogram */
1605         names = g_new0 (char *, sig->param_count);
1606         mono_method_get_param_names (method, (const char **) names);
1607
1608         emit_uleb128 (w, ABBREV_SUBPROGRAM);
1609         name = mono_method_full_name (method, FALSE);
1610         emit_string (w, name);
1611         g_free (name);
1612         if (start_symbol) {
1613                 emit_pointer_unaligned (w, start_symbol);
1614                 emit_pointer_unaligned (w, end_symbol);
1615         } else {
1616                 emit_pointer_value (w, code);
1617                 emit_pointer_value (w, code + code_size);
1618         }
1619         /* frame_base */
1620         emit_byte (w, 2);
1621         emit_byte (w, DW_OP_breg6);
1622         emit_byte (w, 16);
1623
1624         /* Parameters */
1625         for (i = 0; i < sig->param_count + sig->hasthis; ++i) {
1626                 MonoInst *arg = args ? args [i] : NULL;
1627                 MonoType *t;
1628                 const char *pname;
1629                 char pname_buf [128];
1630                 MonoMethodVar *vmv = NULL;
1631                 gboolean need_loclist = FALSE;
1632
1633                 vmv = find_vmv (cfg, arg);
1634                 if (code && vmv && (vmv->live_range_start || vmv->live_range_end))
1635                         need_loclist = TRUE;
1636
1637                 if (i == 0 && sig->hasthis) {
1638                         if (method->klass->valuetype)
1639                                 t = &method->klass->this_arg;
1640                         else
1641                                 t = &method->klass->byval_arg;
1642                         pname = "this";
1643                 } else {
1644                         t = sig->params [i - sig->hasthis];
1645                         pname = names [i - sig->hasthis];
1646                 }
1647
1648                 emit_uleb128 (w, need_loclist ? ABBREV_PARAM_LOCLIST : ABBREV_PARAM);
1649                 /* name */
1650                 if (pname[0] == '\0') {
1651                         sprintf (pname_buf, "param%d", i - sig->hasthis);
1652                         pname = pname_buf;
1653                 }
1654                 emit_string (w, pname);
1655                 /* type */
1656                 if (!arg || arg->flags & MONO_INST_IS_DEAD)
1657                         emit_var_type (w, &mono_defaults.int32_class->byval_arg);
1658                 else
1659                         emit_var_type (w, t);
1660
1661                 p = buf;
1662                 encode_var_location (w, arg, p, &p);
1663                 if (need_loclist) {
1664                         vmv->live_range_start = 0;
1665                         if (vmv->live_range_end == 0)
1666                                 /* FIXME: Uses made in calls are not recorded */
1667                                 vmv->live_range_end = code_size;
1668                         emit_loclist (w, arg, code + vmv->live_range_start, code + vmv->live_range_end, buf, p - buf);
1669                 } else {
1670                         emit_byte (w, p - buf);
1671                         emit_bytes (w, buf, p - buf);
1672                 }
1673         }
1674         g_free (names);
1675
1676         /* Locals */
1677         num_locals = mono_debug_lookup_locals (method, &local_names, &local_indexes);
1678
1679         for (i = 0; i < header->num_locals; ++i) {
1680                 MonoInst *ins = locals [i];
1681                 char name_buf [128];
1682                 int j;
1683                 MonoMethodVar *vmv = NULL;
1684                 gboolean need_loclist = FALSE;
1685
1686                 /* ins->dreg no longer contains the original vreg */
1687                 vmv = find_vmv (cfg, ins);
1688                 if (code && vmv) {
1689                         if (vmv->live_range_start) {
1690                                 /* This variable has a precise live range */
1691                                 need_loclist = TRUE;
1692                         }
1693                 }
1694
1695                 emit_uleb128 (w, need_loclist ? ABBREV_VARIABLE_LOCLIST : ABBREV_VARIABLE);
1696                 /* name */
1697                 for (j = 0; j < num_locals; ++j)
1698                         if (local_indexes [j] == i)
1699                                 break;
1700                 if (j < num_locals) {
1701                         emit_string (w, local_names [j]);
1702                 } else {
1703                         sprintf (name_buf, "V_%d", i);
1704                         emit_string (w, name_buf);
1705                 }
1706                 /* type */
1707                 if (!ins || ins->flags & MONO_INST_IS_DEAD)
1708                         emit_var_type (w, &mono_defaults.int32_class->byval_arg);
1709                 else
1710                         emit_var_type (w, header->locals [i]);
1711
1712                 p = buf;
1713                 encode_var_location (w, ins, p, &p);
1714
1715                 if (need_loclist) {
1716                         if (vmv->live_range_end == 0)
1717                                 /* FIXME: Uses made in calls are not recorded */
1718                                 vmv->live_range_end = code_size;
1719                         emit_loclist (w, ins, code + vmv->live_range_start, code + vmv->live_range_end, buf, p - buf);
1720                 } else {
1721                         emit_byte (w, p - buf);
1722                         emit_bytes (w, buf, p - buf);
1723                 }
1724         }
1725
1726         g_free (local_names);
1727         g_free (local_indexes);
1728
1729         /* Subprogram end */
1730         emit_uleb128 (w, 0x0);
1731
1732         emit_line (w);
1733
1734         emit_debug_info_end (w);
1735
1736         /* Emit unwind info */
1737         if (unwind_info) {
1738                 emit_fde (w, w->fde_index, start_symbol, end_symbol, code, code_size, unwind_info, TRUE);
1739                 w->fde_index ++;
1740         }
1741
1742         /* Emit line number info */
1743         /* != could happen when using --regression */
1744         if (debug_info && (debug_info->code_start == code))
1745                 emit_line_number_info (w, method, start_symbol, end_symbol, code, code_size, debug_info);
1746
1747         emit_line (w);
1748 }
1749
1750 void
1751 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)
1752 {
1753         emit_section_change (w, ".debug_info", 0);
1754
1755         /* Subprogram */
1756         emit_uleb128 (w, ABBREV_SUBPROGRAM);
1757         emit_string (w, tramp_name);
1758         emit_pointer_value (w, code);
1759         emit_pointer_value (w, code + code_size);
1760         /* frame_base */
1761         emit_byte (w, 2);
1762         emit_byte (w, DW_OP_breg6);
1763         emit_byte (w, 16);
1764
1765         /* Subprogram end */
1766         emit_uleb128 (w, 0x0);
1767
1768         emit_debug_info_end (w);
1769
1770         /* Emit unwind info */
1771         emit_fde (w, w->fde_index, start_symbol, end_symbol, code, code_size, unwind_info, FALSE);
1772         w->fde_index ++;
1773 }
1774 #endif /* End of: !defined(DISABLE_AOT) && !defined(DISABLE_JIT) */