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