nsz Git - libfirm/blob - ir/be/bedwarf.c

   1 /*
   2  * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief   DWARF debugging info support
  23  * @author  Matthias Braun
  24  */
  25 #include "config.h"
  26
  27 #include <stdio.h>
  28 #include <stdlib.h>
  29 #include <assert.h>
  30
  31 #include "bedwarf_t.h"
  32 #include "obst.h"
  33 #include "irprog.h"
  34 #include "irgraph.h"
  35 #include "tv.h"
  36 #include "xmalloc.h"
  37 #include "pmap.h"
  38 #include "pdeq.h"
  39 #include "pset_new.h"
  40 #include "util.h"
  41 #include "obst.h"
  42 #include "array_t.h"
  43 #include "irtools.h"
  44 #include "lc_opts.h"
  45 #include "lc_opts_enum.h"
  46 #include "beabi.h"
  47 #include "bemodule.h"
  48 #include "beemitter.h"
  49 #include "dbginfo.h"
  50 #include "begnuas.h"
  51
  52 enum {
  53         LEVEL_NONE,
  54         LEVEL_BASIC,
  55         LEVEL_LOCATIONS,
  56         LEVEL_FRAMEINFO
  57 };
  58 static int debug_level = LEVEL_NONE;
  59
  60 /**
  61  * Usually we simply use the DW_TAG_xxx numbers for our abbrev IDs, but for
  62  * the cases where we need multiple ids with the same DW_TAG we define new IDs
  63  * here
  64  */
  65 typedef enum custom_abbrevs {
  66         abbrev_void_pointer_type = 100,
  67         abbrev_unnamed_formal_parameter,
  68         abbrev_formal_parameter_no_location,
  69         abbrev_void_subroutine_type,
  70         abbrev_void_subprogram,
  71         abbrev_bitfield_member,
  72 } custom_abbrevs;
  73
  74 /**
  75  * The dwarf handle.
  76  */
  77 typedef struct dwarf_t {
  78         const ir_entity         *cur_ent;     /**< current method entity */
  79         unsigned                 next_type_nr; /**< next type number */
  80         pmap                    *file_map;    /**< a map from file names to number in file list */
  81         const char             **file_list;
  82         const ir_entity        **pubnames_list;
  83         pset_new_t               emitted_types;
  84         const char              *main_file;   /**< name of the main source file */
  85         const char              *curr_file;   /**< name of the current source file */
  86         unsigned                 label_num;
  87         unsigned                 last_line;
  88 } dwarf_t;
  89
  90 static dwarf_t env;
  91
  92 static dwarf_source_language language;
  93 static const char           *comp_dir;
  94
  95 static unsigned insert_file(const char *filename)
  96 {
  97         unsigned num;
  98         void    *entry = pmap_get(env.file_map, filename);
  99         if (entry != NULL) {
 100                 return PTR_TO_INT(entry);
 101         }
 102         ARR_APP1(const char*, env.file_list, filename);
 103         num = (unsigned)ARR_LEN(env.file_list);
 104         pmap_insert(env.file_map, filename, INT_TO_PTR(num));
 105
 106         /* TODO: quote chars in string */
 107         be_emit_irprintf("\t.file %u \"%s\"\n", num, filename);
 108         return num;
 109 }
 110
 111 static void emit_int32(uint32_t value)
 112 {
 113         be_emit_irprintf("\t.long %u\n", value);
 114         be_emit_write_line();
 115 }
 116
 117 static void emit_int16(uint16_t value)
 118 {
 119         be_emit_irprintf("\t.short %u\n", value);
 120         be_emit_write_line();
 121 }
 122
 123 static void emit_int8(uint8_t value)
 124 {
 125         be_emit_irprintf("\t.byte %u\n", value);
 126         be_emit_write_line();
 127 }
 128
 129 static void emit_uleb128(unsigned value)
 130 {
 131         be_emit_irprintf("\t.uleb128 0x%x\n", value);
 132         be_emit_write_line();
 133 }
 134
 135 static unsigned get_uleb128_size(unsigned value)
 136 {
 137         unsigned size = 0;
 138         do {
 139                 value >>= 7;
 140                 size += 1;
 141         } while (value != 0);
 142         return size;
 143 }
 144
 145 static void emit_sleb128(long value)
 146 {
 147         be_emit_irprintf("\t.sleb128 %ld\n", value);
 148         be_emit_write_line();
 149 }
 150
 151 static unsigned get_sleb128_size(long value)
 152 {
 153         unsigned size = 0;
 154         do {
 155                 value >>= 7;
 156                 size += 1;
 157         } while (value != 0 && value != -1);
 158         return size;
 159 }
 160
 161 static void emit_string(const char *string)
 162 {
 163         /* TODO: quote special chars */
 164         be_emit_irprintf("\t.asciz \"%s\"\n", string);
 165         be_emit_write_line();
 166 }
 167
 168 static void emit_ref(const ir_entity *entity)
 169 {
 170         be_emit_cstring("\t.long ");
 171         be_gas_emit_entity(entity);
 172         be_emit_char('\n');
 173         be_emit_write_line();
 174 }
 175
 176 static void emit_string_printf(const char *fmt, ...)
 177 {
 178         va_list ap;
 179         va_start(ap, fmt);
 180         be_emit_cstring("\t.asciz \"");
 181         be_emit_irvprintf(fmt, ap);
 182         be_emit_cstring("\"\n");
 183         va_end(ap);
 184
 185         be_emit_write_line();
 186 }
 187
 188 static void emit_address(const char *name)
 189 {
 190         be_emit_cstring("\t.long ");
 191         be_emit_string(be_gas_get_private_prefix());
 192         be_emit_string(name);
 193         be_emit_char('\n');
 194         be_emit_write_line();
 195 }
 196
 197 static void emit_size(const char *from_label, const char *to_label)
 198 {
 199         be_emit_cstring("\t.long ");
 200         be_emit_string(be_gas_get_private_prefix());
 201         be_emit_string(to_label);
 202         be_emit_cstring(" - ");
 203         be_emit_string(be_gas_get_private_prefix());
 204         be_emit_string(from_label);
 205         be_emit_char('\n');
 206         be_emit_write_line();
 207 }
 208
 209 static void emit_label(const char *name)
 210 {
 211         be_emit_string(be_gas_get_private_prefix());
 212         be_emit_string(name);
 213         be_emit_cstring(":\n");
 214         be_emit_write_line();
 215 }
 216
 217 static void register_attribute(dwarf_attribute attribute, dwarf_form form)
 218 {
 219         emit_uleb128(attribute);
 220         emit_uleb128(form);
 221 }
 222
 223 static void begin_abbrev(unsigned code, dwarf_tag tag, dw_children children)
 224 {
 225         emit_uleb128(code);
 226         emit_uleb128(tag);
 227         emit_int8(children);
 228 }
 229
 230 static void end_abbrev(void)
 231 {
 232         emit_uleb128(0);
 233         emit_uleb128(0);
 234 }
 235
 236 static void emit_line_info(void)
 237 {
 238         be_gas_emit_switch_section(GAS_SECTION_DEBUG_LINE);
 239
 240         emit_label("line_section_begin");
 241         /* on elf systems gas handles producing the line info for us, and we
 242          * don't have to do anything */
 243         if (be_gas_object_file_format != OBJECT_FILE_FORMAT_ELF) {
 244                 size_t i;
 245                 emit_size("line_info_begin", "line_info_end");
 246
 247                 emit_label("line_info_begin");
 248                 emit_int16(2); /* version */
 249                 emit_size("line_info_prolog_begin", "line_info_prolog_end");
 250                 emit_label("line_info_prolog_begin");
 251                 emit_int8(1); /* len of smallest instruction TODO: query from backend */
 252                 emit_int8(1); /* default is statement */
 253                 emit_int8(246); /* line base */
 254                 emit_int8(245); /* line range */
 255                 emit_int8(10); /* opcode base */
 256
 257                 emit_uleb128(0);
 258                 emit_uleb128(1);
 259                 emit_uleb128(1);
 260                 emit_uleb128(1);
 261                 emit_uleb128(1);
 262                 emit_uleb128(0);
 263                 emit_uleb128(0);
 264                 emit_uleb128(0);
 265                 emit_uleb128(1);
 266
 267                 /* include directory list */
 268                 emit_string("/foo/bar");
 269                 emit_int8(0);
 270
 271                 /* file list */
 272                 for (i = 0; i < ARR_LEN(env.file_list); ++i) {
 273                         emit_string(env.file_list[i]);
 274                         emit_uleb128(1); /* directory */
 275                         emit_uleb128(0); /* modification time */
 276                         emit_uleb128(0); /* file length */
 277                 }
 278                 emit_int8(0);
 279
 280                 emit_label("line_info_prolog_end");
 281
 282                 /* TODO: put the line_info program here */
 283
 284                 emit_label("line_info_end");
 285         }
 286 }
 287
 288 static void emit_pubnames(void)
 289 {
 290         size_t i;
 291
 292         be_gas_emit_switch_section(GAS_SECTION_DEBUG_PUBNAMES);
 293
 294         emit_size("pubnames_begin", "pubnames_end");
 295         emit_label("pubnames_begin");
 296
 297         emit_int16(2); /* version */
 298         emit_size("info_section_begin", "info_begin");
 299         emit_size("compile_unit_begin", "compile_unit_end");
 300
 301         for (i = 0; i < ARR_LEN(env.pubnames_list); ++i) {
 302                 const ir_entity *entity = env.pubnames_list[i];
 303                 be_emit_irprintf("\t.long %sE%ld - %sinfo_begin\n",
 304                                  be_gas_get_private_prefix(),
 305                                  get_entity_nr(entity), be_gas_get_private_prefix());
 306                 emit_string(get_entity_name(entity));
 307         }
 308         emit_int32(0);
 309
 310         emit_label("pubnames_end");
 311 }
 312
 313 void be_dwarf_location(dbg_info *dbgi)
 314 {
 315         src_loc_t loc;
 316         unsigned  filenum;
 317
 318         if (debug_level < LEVEL_LOCATIONS)
 319                 return;
 320         loc = ir_retrieve_dbg_info(dbgi);
 321         if (!loc.file)
 322                 return;
 323
 324         filenum = insert_file(loc.file);
 325         be_emit_irprintf("\t.loc %u %u %u\n", filenum, loc.line, loc.column);
 326         be_emit_write_line();
 327 }
 328
 329 void be_dwarf_callframe_register(const arch_register_t *reg)
 330 {
 331         if (debug_level < LEVEL_FRAMEINFO)
 332                 return;
 333         be_emit_cstring("\t.cfi_def_cfa_register ");
 334         be_emit_irprintf("%d\n", reg->dwarf_number);
 335         be_emit_write_line();
 336 }
 337
 338 void be_dwarf_callframe_offset(int offset)
 339 {
 340         if (debug_level < LEVEL_FRAMEINFO)
 341                 return;
 342         be_emit_cstring("\t.cfi_def_cfa_offset ");
 343         be_emit_irprintf("%d\n", offset);
 344         be_emit_write_line();
 345 }
 346
 347 void be_dwarf_callframe_spilloffset(const arch_register_t *reg, int offset)
 348 {
 349         if (debug_level < LEVEL_FRAMEINFO)
 350                 return;
 351         be_emit_cstring("\t.cfi_offset ");
 352         be_emit_irprintf("%d, %d\n", reg->dwarf_number, offset);
 353         be_emit_write_line();
 354 }
 355
 356 static bool is_extern_entity(const ir_entity *entity)
 357 {
 358         ir_visited_t visibility = get_entity_visibility(entity);
 359         return visibility == ir_visibility_external;
 360 }
 361
 362 static void emit_entity_label(const ir_entity *entity)
 363 {
 364         be_emit_irprintf("%sE%ld:\n", be_gas_get_private_prefix(),
 365                          get_entity_nr(entity));
 366         be_emit_write_line();
 367 }
 368
 369 static void register_dbginfo_attributes(void)
 370 {
 371         register_attribute(DW_AT_decl_file,   DW_FORM_udata);
 372         register_attribute(DW_AT_decl_line,   DW_FORM_udata);
 373         register_attribute(DW_AT_decl_column, DW_FORM_udata);
 374 }
 375
 376 static void emit_dbginfo(const dbg_info *dbgi)
 377 {
 378         src_loc_t const loc  = ir_retrieve_dbg_info(dbgi);
 379         unsigned  const file = loc.file ? insert_file(loc.file) : 0;
 380         emit_uleb128(file);
 381         emit_uleb128(loc.line);
 382         emit_uleb128(loc.column);
 383 }
 384
 385 static void emit_type_address(const ir_type *type)
 386 {
 387         be_emit_irprintf("\t.long %sT%ld - %sinfo_begin\n",
 388                          be_gas_get_private_prefix(),
 389                          get_type_nr(type), be_gas_get_private_prefix());
 390         be_emit_write_line();
 391 }
 392
 393 static void emit_subprogram_abbrev(void)
 394 {
 395         begin_abbrev(DW_TAG_subprogram, DW_TAG_subprogram, DW_CHILDREN_yes);
 396         register_attribute(DW_AT_name,      DW_FORM_string);
 397         register_dbginfo_attributes();
 398         register_attribute(DW_AT_type,       DW_FORM_ref4);
 399         register_attribute(DW_AT_external,   DW_FORM_flag);
 400         register_attribute(DW_AT_low_pc,     DW_FORM_addr);
 401         register_attribute(DW_AT_high_pc,    DW_FORM_addr);
 402         //register_attribute(DW_AT_prototyped, DW_FORM_flag);
 403         if (debug_level >= LEVEL_FRAMEINFO)
 404                 register_attribute(DW_AT_frame_base, DW_FORM_block1);
 405         end_abbrev();
 406
 407         begin_abbrev(abbrev_void_subprogram, DW_TAG_subprogram, DW_CHILDREN_yes);
 408         register_attribute(DW_AT_name,       DW_FORM_string);
 409         register_dbginfo_attributes();
 410         register_attribute(DW_AT_external,   DW_FORM_flag);
 411         register_attribute(DW_AT_low_pc,     DW_FORM_addr);
 412         register_attribute(DW_AT_high_pc,    DW_FORM_addr);
 413         //register_attribute(DW_AT_prototyped, DW_FORM_flag);
 414         if (debug_level >= LEVEL_FRAMEINFO)
 415                 register_attribute(DW_AT_frame_base, DW_FORM_block1);
 416         end_abbrev();
 417
 418         begin_abbrev(DW_TAG_formal_parameter, DW_TAG_formal_parameter,
 419                      DW_CHILDREN_no);
 420         register_attribute(DW_AT_name,      DW_FORM_string);
 421         register_dbginfo_attributes();
 422         register_attribute(DW_AT_type,      DW_FORM_ref4);
 423         register_attribute(DW_AT_location,  DW_FORM_block1);
 424         end_abbrev();
 425
 426         begin_abbrev(abbrev_formal_parameter_no_location, DW_TAG_formal_parameter,
 427                      DW_CHILDREN_no);
 428         register_attribute(DW_AT_name,      DW_FORM_string);
 429         register_dbginfo_attributes();
 430         register_attribute(DW_AT_type,      DW_FORM_ref4);
 431         end_abbrev();
 432 }
 433
 434 static void emit_type(ir_type *type);
 435
 436 static void emit_stack_location(long offset)
 437 {
 438         unsigned size = 1 + get_sleb128_size(offset);
 439         emit_int8(size);
 440         emit_int8(DW_OP_fbreg);
 441         emit_sleb128(offset);
 442 }
 443
 444 static void emit_function_parameters(const ir_entity *entity,
 445                                      const parameter_dbg_info_t *infos)
 446 {
 447         ir_type  *type     = get_entity_type(entity);
 448         size_t    n_params = get_method_n_params(type);
 449         dbg_info *dbgi     = get_entity_dbg_info(entity);
 450         size_t    i;
 451         for (i = 0; i < n_params; ++i) {
 452                 ir_type *param_type = get_method_param_type(type, i);
 453
 454                 if (infos != NULL && infos[i].entity != NULL) {
 455                         const ir_entity *entity = infos[i].entity;
 456                         long             offset = get_entity_offset(entity);
 457                         emit_uleb128(DW_TAG_formal_parameter);
 458                         emit_string_printf("arg%u", (unsigned)i);
 459                         emit_dbginfo(dbgi);
 460                         emit_type_address(param_type);
 461                         emit_stack_location(offset);
 462                 } else {
 463                         emit_uleb128(abbrev_formal_parameter_no_location);
 464                         emit_string_printf("arg%u", (unsigned)i);
 465                         emit_dbginfo(dbgi);
 466                         emit_type_address(param_type);
 467                 }
 468         }
 469 }
 470
 471 void be_dwarf_method_before(const ir_entity *entity,
 472                             const parameter_dbg_info_t *parameter_infos)
 473 {
 474         if (debug_level < LEVEL_BASIC)
 475                 return;
 476         {
 477         ir_type *type     = get_entity_type(entity);
 478         size_t   n_ress   = get_method_n_ress(type);
 479         size_t   n_params = get_method_n_params(type);
 480         size_t   i;
 481
 482         be_gas_emit_switch_section(GAS_SECTION_DEBUG_INFO);
 483
 484         if (n_ress > 0) {
 485                 ir_type *res = get_method_res_type(type, 0);
 486                 emit_type(res);
 487         }
 488         for (i = 0; i < n_params; ++i) {
 489                 ir_type *param_type = get_method_param_type(type, i);
 490                 emit_type(param_type);
 491         }
 492
 493         emit_entity_label(entity);
 494         emit_uleb128(n_ress == 0 ? abbrev_void_subprogram : DW_TAG_subprogram);
 495         emit_string(get_entity_ld_name(entity));
 496         emit_dbginfo(get_entity_dbg_info(entity));
 497         if (n_ress > 0) {
 498                 ir_type *res = get_method_res_type(type, 0);
 499                 emit_type_address(res);
 500         }
 501         emit_int8(is_extern_entity(entity));
 502         emit_ref(entity);
 503         be_emit_irprintf("\t.long %smethod_end_%s\n", be_gas_get_private_prefix(),
 504                          get_entity_ld_name(entity));
 505         /* frame_base prog */
 506         emit_int8(1);
 507         emit_int8(DW_OP_call_frame_cfa);
 508
 509         emit_function_parameters(entity, parameter_infos);
 510         emit_int8(0);
 511
 512         ARR_APP1(const ir_entity*, env.pubnames_list, entity);
 513
 514         env.cur_ent = entity;
 515         }
 516 }
 517
 518 void be_dwarf_method_begin(void)
 519 {
 520         if (debug_level < LEVEL_FRAMEINFO)
 521                 return;
 522         be_emit_cstring("\t.cfi_startproc\n");
 523         be_emit_write_line();
 524 }
 525
 526 void be_dwarf_method_end(void)
 527 {
 528         if (debug_level < LEVEL_BASIC)
 529                 return;
 530         const ir_entity *entity = env.cur_ent;
 531         be_emit_irprintf("%smethod_end_%s:\n", be_gas_get_private_prefix(),
 532                          get_entity_ld_name(entity));
 533
 534         if (debug_level >= LEVEL_FRAMEINFO) {
 535                 be_emit_cstring("\t.cfi_endproc\n");
 536                 be_emit_write_line();
 537         }
 538 }
 539
 540 static void emit_base_type_abbrev(void)
 541 {
 542         begin_abbrev(DW_TAG_base_type, DW_TAG_base_type, DW_CHILDREN_no);
 543         register_attribute(DW_AT_encoding,  DW_FORM_data1);
 544         register_attribute(DW_AT_byte_size, DW_FORM_data1);
 545         register_attribute(DW_AT_name,      DW_FORM_string);
 546         end_abbrev();
 547 }
 548
 549 static void emit_type_label(const ir_type *type)
 550 {
 551         be_emit_irprintf("%sT%ld:\n", be_gas_get_private_prefix(), get_type_nr(type));
 552         be_emit_write_line();
 553 }
 554
 555 static void emit_base_type(const ir_type *type)
 556 {
 557         char buf[128];
 558         ir_mode *mode = get_type_mode(type);
 559         ir_print_type(buf, sizeof(buf), type);
 560
 561         emit_type_label(type);
 562         emit_uleb128(DW_TAG_base_type);
 563         if (mode_is_int(mode)) {
 564                 /* bool hack */
 565                 if (strcmp(buf, "_Bool")==0 || strcmp(buf, "bool")==0) {
 566                         emit_int8(DW_ATE_boolean);
 567                 } else {
 568                         emit_int8(mode_is_signed(mode) ? DW_ATE_signed : DW_ATE_unsigned);
 569                 }
 570         } else if (mode_is_reference(mode)) {
 571                 emit_int8(DW_ATE_address);
 572         } else if (mode_is_float(mode)) {
 573                 emit_int8(DW_ATE_float);
 574         } else {
 575                 panic("mode not implemented yet");
 576         }
 577         emit_int8(get_mode_size_bytes(mode));
 578         emit_string(buf);
 579 }
 580
 581 static void emit_pointer_type_abbrev(void)
 582 {
 583         begin_abbrev(DW_TAG_pointer_type, DW_TAG_pointer_type, DW_CHILDREN_no);
 584         register_attribute(DW_AT_type,      DW_FORM_ref4);
 585         register_attribute(DW_AT_byte_size, DW_FORM_data1);
 586         end_abbrev();
 587
 588         /* for void* pointer s*/
 589         begin_abbrev(abbrev_void_pointer_type, DW_TAG_pointer_type, DW_CHILDREN_no);
 590         register_attribute(DW_AT_byte_size, DW_FORM_data1);
 591         end_abbrev();
 592 }
 593
 594 static void emit_pointer_type(const ir_type *type)
 595 {
 596         ir_type *points_to = get_pointer_points_to_type(type);
 597         unsigned size      = get_type_size_bytes(type);
 598         assert(size < 256);
 599
 600         if (!is_Primitive_type(points_to) || get_type_mode(points_to) != mode_ANY) {
 601                 emit_type(points_to);
 602
 603                 emit_type_label(type);
 604                 emit_uleb128(DW_TAG_pointer_type);
 605                 emit_type_address(points_to);
 606         } else {
 607                 emit_type_label(type);
 608                 emit_uleb128(abbrev_void_pointer_type);
 609         }
 610         emit_int8(size);
 611 }
 612
 613 static void emit_array_type_abbrev(void)
 614 {
 615         begin_abbrev(DW_TAG_array_type, DW_TAG_array_type, DW_CHILDREN_yes);
 616         register_attribute(DW_AT_type, DW_FORM_ref4);
 617         end_abbrev();
 618
 619         begin_abbrev(DW_TAG_subrange_type, DW_TAG_subrange_type, DW_CHILDREN_no);
 620         register_attribute(DW_AT_upper_bound, DW_FORM_udata);
 621         end_abbrev();
 622 }
 623
 624 static void emit_array_type(const ir_type *type)
 625 {
 626         ir_type *element_type = get_array_element_type(type);
 627
 628         if (get_array_n_dimensions(type) != 1)
 629                 panic("dwarf: multidimensional arrays no supported yet");
 630
 631         emit_type(element_type);
 632
 633         emit_type_label(type);
 634         emit_uleb128(DW_TAG_array_type);
 635         emit_type_address(element_type);
 636
 637         if (has_array_upper_bound(type, 0)) {
 638                 int bound = get_array_upper_bound_int(type, 0);
 639                 emit_uleb128(DW_TAG_subrange_type);
 640                 emit_uleb128(bound);
 641         }
 642
 643         emit_uleb128(0);
 644 }
 645
 646 static void emit_compound_type_abbrev(void)
 647 {
 648         begin_abbrev(DW_TAG_structure_type, DW_TAG_structure_type, DW_CHILDREN_yes);
 649         register_attribute(DW_AT_byte_size,  DW_FORM_udata);
 650         // TODO register_dbginfo_attributes();
 651         end_abbrev();
 652
 653         begin_abbrev(DW_TAG_union_type, DW_TAG_union_type, DW_CHILDREN_yes);
 654         register_attribute(DW_AT_byte_size,  DW_FORM_udata);
 655         // TODO register_dbginfo_attributes();
 656         end_abbrev();
 657
 658         begin_abbrev(DW_TAG_class_type, DW_TAG_class_type, DW_CHILDREN_yes);
 659         register_attribute(DW_AT_byte_size,  DW_FORM_udata);
 660         // TODO register_dbginfo_attributes();
 661         end_abbrev();
 662
 663         begin_abbrev(DW_TAG_member, DW_TAG_member, DW_CHILDREN_no);
 664         register_attribute(DW_AT_type,                 DW_FORM_ref4);
 665         register_attribute(DW_AT_name,                 DW_FORM_string);
 666         register_dbginfo_attributes();
 667         register_attribute(DW_AT_data_member_location, DW_FORM_block1);
 668         end_abbrev();
 669
 670         begin_abbrev(abbrev_bitfield_member, DW_TAG_member, DW_CHILDREN_no);
 671         register_attribute(DW_AT_byte_size,            DW_FORM_udata);
 672         register_attribute(DW_AT_bit_size,             DW_FORM_udata);
 673         register_attribute(DW_AT_bit_offset,           DW_FORM_udata);
 674         register_attribute(DW_AT_type,                 DW_FORM_ref4);
 675         register_attribute(DW_AT_name,                 DW_FORM_string);
 676         register_dbginfo_attributes();
 677         register_attribute(DW_AT_data_member_location, DW_FORM_block1);
 678         end_abbrev();
 679 }
 680
 681 static void emit_op_plus_uconst(unsigned value)
 682 {
 683         emit_int8(DW_OP_plus_uconst);
 684         emit_uleb128(value);
 685 }
 686
 687 static void emit_compound_type(const ir_type *type)
 688 {
 689         size_t i;
 690         size_t n_members = get_compound_n_members(type);
 691
 692         for (i = 0; i < n_members; ++i) {
 693                 ir_entity *member      = get_compound_member(type, i);
 694                 ir_type   *member_type = get_entity_type(member);
 695                 if (is_Primitive_type(member_type)) {
 696                         ir_type *base = get_primitive_base_type(member_type);
 697                         if (base != NULL)
 698                                 member_type = base;
 699                 }
 700                 emit_type(member_type);
 701         }
 702
 703         emit_type_label(type);
 704         if (is_Struct_type(type)) {
 705                 emit_uleb128(DW_TAG_structure_type);
 706         } else if (is_Union_type(type)) {
 707                 emit_uleb128(DW_TAG_union_type);
 708         } else {
 709                 assert(is_Class_type(type));
 710                 emit_uleb128(DW_TAG_class_type);
 711         }
 712         emit_uleb128(get_type_size_bytes(type));
 713         for (i = 0; i < n_members; ++i) {
 714                 ir_entity *member      = get_compound_member(type, i);
 715                 ir_type   *member_type = get_entity_type(member);
 716                 int        offset      = get_entity_offset(member);
 717                 ir_type   *base;
 718
 719                 if (is_Primitive_type(member_type) &&
 720                     (base = get_primitive_base_type(member_type))) {
 721                     unsigned bit_offset = get_entity_offset_bits_remainder(member);
 722                     unsigned base_size  = get_type_size_bytes(base);
 723                     ir_mode *mode       = get_type_mode(member_type);
 724                     unsigned bit_size   = get_mode_size_bits(mode);
 725
 726                         bit_offset = base_size*8 - bit_offset - bit_size;
 727
 728                         emit_uleb128(abbrev_bitfield_member);
 729                         emit_uleb128(base_size);
 730                         emit_uleb128(bit_size);
 731                         emit_uleb128(bit_offset);
 732                         member_type = base;
 733                 } else {
 734                         emit_uleb128(DW_TAG_member);
 735                 }
 736
 737                 emit_type_address(member_type);
 738                 emit_string(get_entity_name(member));
 739                 emit_dbginfo(get_entity_dbg_info(member));
 740                 assert(offset >= 0);
 741                 emit_int8(1 + get_uleb128_size(offset));
 742                 emit_op_plus_uconst(offset);
 743         }
 744
 745         emit_int8(0);
 746 }
 747
 748 static void emit_subroutine_type_abbrev(void)
 749 {
 750         begin_abbrev(DW_TAG_subroutine_type,
 751                      DW_TAG_subroutine_type, DW_CHILDREN_yes);
 752         register_attribute(DW_AT_prototyped,   DW_FORM_flag);
 753         register_attribute(DW_AT_type,         DW_FORM_ref4);
 754         end_abbrev();
 755
 756         begin_abbrev(abbrev_void_subroutine_type,
 757                      DW_TAG_subroutine_type, DW_CHILDREN_yes);
 758         register_attribute(DW_AT_prototyped,   DW_FORM_flag);
 759         end_abbrev();
 760
 761         begin_abbrev(abbrev_unnamed_formal_parameter,
 762                      DW_TAG_formal_parameter, DW_CHILDREN_no);
 763         register_attribute(DW_AT_type,  DW_FORM_ref4);
 764         end_abbrev();
 765 }
 766
 767 static void emit_subroutine_type(const ir_type *type)
 768 {
 769         size_t n_params = get_method_n_params(type);
 770         size_t n_ress   = get_method_n_ress(type);
 771         size_t i;
 772         for (i = 0; i < n_params; ++i) {
 773                 ir_type *param_type = get_method_param_type(type, i);
 774                 emit_type(param_type);
 775         }
 776         for (i = 0; i < n_ress; ++i) {
 777                 ir_type *res_type = get_method_res_type(type, i);
 778                 emit_type(res_type);
 779         }
 780
 781         emit_type_label(type);
 782         emit_uleb128(n_ress == 0 ? abbrev_void_subroutine_type : DW_TAG_subroutine_type);
 783         emit_int8(1); /* prototyped */
 784         if (n_ress > 0) {
 785                 /* dwarf only supports 1 return type */
 786                 ir_type *res_type = get_method_res_type(type, 0);
 787                 emit_type_address(res_type);
 788         }
 789
 790         for (i = 0; i < n_params; ++i) {
 791                 ir_type *param_type = get_method_param_type(type, i);
 792                 emit_uleb128(abbrev_unnamed_formal_parameter);
 793                 emit_type_address(param_type);
 794         }
 795         emit_int8(0);
 796 }
 797
 798 static void emit_type(ir_type *type)
 799 {
 800         if (pset_new_insert(&env.emitted_types, type))
 801                 return;
 802
 803         switch (get_type_tpop_code(type)) {
 804         case tpo_primitive: emit_base_type(type);       break;
 805         case tpo_pointer:   emit_pointer_type(type);    break;
 806         case tpo_array:     emit_array_type(type);      break;
 807         case tpo_class:
 808         case tpo_struct:
 809         case tpo_union:     emit_compound_type(type);   break;
 810         case tpo_method:    emit_subroutine_type(type); break;
 811         default:
 812                 panic("bedwarf: type %+F not implemented yet", type);
 813         }
 814 }
 815
 816 static void emit_op_addr(const ir_entity *entity)
 817 {
 818         emit_int8(DW_OP_addr);
 819         be_emit_cstring("\t.long ");
 820         be_gas_emit_entity(entity);
 821         be_emit_char('\n');
 822         be_emit_write_line();
 823 }
 824
 825 static void emit_variable_abbrev(void)
 826 {
 827         begin_abbrev(DW_TAG_variable, DW_TAG_variable, DW_CHILDREN_no);
 828         register_attribute(DW_AT_name,      DW_FORM_string);
 829         register_attribute(DW_AT_type,      DW_FORM_ref4);
 830         register_attribute(DW_AT_external,  DW_FORM_flag);
 831         register_dbginfo_attributes();
 832         register_attribute(DW_AT_location,  DW_FORM_block1);
 833         end_abbrev();
 834 }
 835
 836 void be_dwarf_variable(const ir_entity *entity)
 837 {
 838         ir_type *type = get_entity_type(entity);
 839
 840         if (debug_level < LEVEL_BASIC)
 841                 return;
 842         if (get_entity_ld_name(entity)[0] == '\0')
 843                 return;
 844         if (!entity_has_definition(entity))
 845                 return;
 846
 847         be_gas_emit_switch_section(GAS_SECTION_DEBUG_INFO);
 848
 849         emit_type(type);
 850
 851         emit_entity_label(entity);
 852         emit_uleb128(DW_TAG_variable);
 853         emit_string(get_entity_ld_name(entity));
 854         emit_type_address(type);
 855         emit_int8(is_extern_entity(entity));
 856         emit_dbginfo(get_entity_dbg_info(entity));
 857         /* DW_AT_location */
 858         emit_int8(5); /* block length */
 859         emit_op_addr(entity);
 860
 861         ARR_APP1(const ir_entity*, env.pubnames_list, entity);
 862 }
 863
 864 static void emit_compile_unit_abbrev(void)
 865 {
 866         begin_abbrev(DW_TAG_compile_unit, DW_TAG_compile_unit, DW_CHILDREN_yes);
 867         register_attribute(DW_AT_stmt_list, DW_FORM_data4);
 868         register_attribute(DW_AT_producer,  DW_FORM_string);
 869         register_attribute(DW_AT_name,      DW_FORM_string);
 870         if (language != 0)
 871                 register_attribute(DW_AT_language,  DW_FORM_data2);
 872         if (comp_dir != NULL)
 873                 register_attribute(DW_AT_comp_dir,  DW_FORM_string);
 874         end_abbrev();
 875 }
 876
 877 static void emit_abbrev(void)
 878 {
 879         /* create abbreviation for compile_unit */
 880         be_gas_emit_switch_section(GAS_SECTION_DEBUG_ABBREV);
 881
 882         emit_label("abbrev_begin");
 883
 884         emit_compile_unit_abbrev();
 885         emit_variable_abbrev();
 886         emit_subprogram_abbrev();
 887         emit_base_type_abbrev();
 888         emit_pointer_type_abbrev();
 889         emit_array_type_abbrev();
 890         emit_compound_type_abbrev();
 891         emit_subroutine_type_abbrev();
 892         emit_uleb128(0);
 893 }
 894
 895 void be_dwarf_unit_begin(const char *filename)
 896 {
 897         if (debug_level < LEVEL_BASIC)
 898                 return;
 899         emit_abbrev();
 900
 901         be_gas_emit_switch_section(GAS_SECTION_DEBUG_INFO);
 902         emit_label("info_section_begin");
 903         emit_label("info_begin");
 904
 905         /* length of compilation unit info */
 906         emit_size("compile_unit_begin", "compile_unit_end");
 907         emit_label("compile_unit_begin");
 908         emit_int16(3);   /* dwarf version */
 909         emit_address("abbrev_begin");
 910         emit_int8(4);    /* pointer size, TODO: query backend */
 911
 912         /* compile_unit die */
 913         emit_uleb128(DW_TAG_compile_unit);
 914         emit_address("line_section_begin");
 915         emit_string_printf("libFirm (%u.%u %s)", ir_get_version_major(),
 916                            ir_get_version_minor(),
 917                            ir_get_version_revision());
 918         emit_string(filename);
 919         if (language != 0)
 920                 emit_int16(language);
 921         if (comp_dir != NULL)
 922                 emit_string(comp_dir);
 923
 924         /* tell gas to emit cfi in debug_frame
 925          * TODO: if we produce exception handling code then this should be
 926          *       .eh_frame (I also wonder if bad things happen if simply always
 927          *       use eh_frame) */
 928         be_emit_cstring("\t.cfi_sections .debug_frame\n");
 929         be_emit_write_line();
 930 }
 931
 932 void be_dwarf_unit_end(void)
 933 {
 934         if (debug_level < LEVEL_BASIC)
 935                 return;
 936         be_gas_emit_switch_section(GAS_SECTION_TEXT);
 937         emit_label("section_end");
 938
 939         be_gas_emit_switch_section(GAS_SECTION_DEBUG_INFO);
 940         emit_uleb128(0); /* end of compile_unit DIE */
 941
 942         emit_label("compile_unit_end");
 943
 944         emit_line_info();
 945         emit_pubnames();
 946 }
 947
 948 void be_dwarf_close(void)
 949 {
 950         if (debug_level < LEVEL_BASIC)
 951                 return;
 952         pmap_destroy(env.file_map);
 953         DEL_ARR_F(env.file_list);
 954         DEL_ARR_F(env.pubnames_list);
 955         pset_new_destroy(&env.emitted_types);
 956 }
 957
 958 /* Opens a dwarf handler */
 959 void be_dwarf_open(void)
 960 {
 961         if (debug_level < LEVEL_BASIC)
 962                 return;
 963         env.file_map      = pmap_create();
 964         env.file_list     = NEW_ARR_F(const char*, 0);
 965         env.pubnames_list = NEW_ARR_F(const ir_entity*, 0);
 966         pset_new_init(&env.emitted_types);
 967 }
 968
 969 void be_dwarf_set_source_language(dwarf_source_language new_language)
 970 {
 971         language = new_language;
 972 }
 973
 974 void be_dwarf_set_compilation_directory(const char *new_comp_dir)
 975 {
 976         comp_dir = new_comp_dir;
 977 }
 978
 979 BE_REGISTER_MODULE_CONSTRUCTOR(be_init_dwarf)
 980 void be_init_dwarf(void)
 981 {
 982         static const lc_opt_enum_int_items_t level_items[] = {
 983                 { "none",      LEVEL_NONE },
 984                 { "basic",     LEVEL_BASIC },
 985                 { "locations", LEVEL_LOCATIONS },
 986                 { "frameinfo", LEVEL_FRAMEINFO },
 987                 { NULL,        0 }
 988         };
 989         static lc_opt_enum_int_var_t debug_level_opt = {
 990                 &debug_level, level_items
 991         };
 992         static lc_opt_table_entry_t be_main_options[] = {
 993                 LC_OPT_ENT_ENUM_INT("debug", "debug output (dwarf) level",
 994                                     &debug_level_opt),
 995                 LC_OPT_LAST
 996         };
 997         lc_opt_entry_t *be_grp = lc_opt_get_grp(firm_opt_get_root(), "be");
 998         lc_opt_add_table(be_grp, be_main_options);
 999 }