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