include/llvm/CodeGen/DwarfWriter.h

   1 //===-- llvm/CodeGen/DwarfWriter.h - Dwarf Framework ------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by James M. Laskey and is distributed under the
   6 // University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains support for writing Dwarf debug info into asm files.  For
  11 // Details on the Dwarf 3 specfication see DWARF Debugging Information Format
  12 // V.3 reference manual http://dwarf.freestandards.org ,
  13 //
  14 // The role of the Dwarf Writer class is to extract debug information from the
  15 // MachineDebugInfo object, organize it in Dwarf form and then emit it into asm
  16 // the current asm file using data and high level Dwarf directives.
  17 //
  18 //===----------------------------------------------------------------------===//
  19
  20 #ifndef LLVM_CODEGEN_DWARFWRITER_H
  21 #define LLVM_CODEGEN_DWARFWRITER_H
  22
  23 #include "llvm/ADT/UniqueVector.h"
  24
  25 #include <iosfwd>
  26 #include <string>
  27
  28
  29 namespace llvm {
  30
  31   //===--------------------------------------------------------------------===//
  32   // Dwarf constants as gleaned from the DWARF Debugging Information Format V.3
  33   // reference manual http://dwarf.freestandards.org .
  34   //
  35   enum dwarf_constants {
  36     DWARF_VERSION = 2,
  37
  38    // Tags
  39     DW_TAG_array_type = 0x01,
  40     DW_TAG_class_type = 0x02,
  41     DW_TAG_entry_point = 0x03,
  42     DW_TAG_enumeration_type = 0x04,
  43     DW_TAG_formal_parameter = 0x05,
  44     DW_TAG_imported_declaration = 0x08,
  45     DW_TAG_label = 0x0a,
  46     DW_TAG_lexical_block = 0x0b,
  47     DW_TAG_member = 0x0d,
  48     DW_TAG_pointer_type = 0x0f,
  49     DW_TAG_reference_type = 0x10,
  50     DW_TAG_compile_unit = 0x11,
  51     DW_TAG_string_type = 0x12,
  52     DW_TAG_structure_type = 0x13,
  53     DW_TAG_subroutine_type = 0x15,
  54     DW_TAG_typedef = 0x16,
  55     DW_TAG_union_type = 0x17,
  56     DW_TAG_unspecified_parameters = 0x18,
  57     DW_TAG_variant = 0x19,
  58     DW_TAG_common_block = 0x1a,
  59     DW_TAG_common_inclusion = 0x1b,
  60     DW_TAG_inheritance = 0x1c,
  61     DW_TAG_inlined_subroutine = 0x1d,
  62     DW_TAG_module = 0x1e,
  63     DW_TAG_ptr_to_member_type = 0x1f,
  64     DW_TAG_set_type = 0x20,
  65     DW_TAG_subrange_type = 0x21,
  66     DW_TAG_with_stmt = 0x22,
  67     DW_TAG_access_declaration = 0x23,
  68     DW_TAG_base_type = 0x24,
  69     DW_TAG_catch_block = 0x25,
  70     DW_TAG_const_type = 0x26,
  71     DW_TAG_constant = 0x27,
  72     DW_TAG_enumerator = 0x28,
  73     DW_TAG_file_type = 0x29,
  74     DW_TAG_friend = 0x2a,
  75     DW_TAG_namelist = 0x2b,
  76     DW_TAG_namelist_item = 0x2c,
  77     DW_TAG_packed_type = 0x2d,
  78     DW_TAG_subprogram = 0x2e,
  79     DW_TAG_template_type_parameter = 0x2f,
  80     DW_TAG_template_value_parameter = 0x30,
  81     DW_TAG_thrown_type = 0x31,
  82     DW_TAG_try_block = 0x32,
  83     DW_TAG_variant_part = 0x33,
  84     DW_TAG_variable = 0x34,
  85     DW_TAG_volatile_type = 0x35,
  86     DW_TAG_dwarf_procedure = 0x36,
  87     DW_TAG_restrict_type = 0x37,
  88     DW_TAG_interface_type = 0x38,
  89     DW_TAG_namespace = 0x39,
  90     DW_TAG_imported_module = 0x3a,
  91     DW_TAG_unspecified_type = 0x3b,
  92     DW_TAG_partial_unit = 0x3c,
  93     DW_TAG_imported_unit = 0x3d,
  94     DW_TAG_condition = 0x3f,
  95     DW_TAG_shared_type = 0x40,
  96     DW_TAG_lo_user = 0x4080,
  97     DW_TAG_hi_user = 0xffff,
  98
  99     // Children flag
 100     DW_CHILDREN_no = 0x00,
 101     DW_CHILDREN_yes = 0x01,
 102
 103     // Attributes
 104     DW_AT_sibling = 0x01,
 105     DW_AT_location = 0x02,
 106     DW_AT_name = 0x03,
 107     DW_AT_ordering = 0x09,
 108     DW_AT_byte_size = 0x0b,
 109     DW_AT_bit_offset = 0x0c,
 110     DW_AT_bit_size = 0x0d,
 111     DW_AT_stmt_list = 0x10,
 112     DW_AT_low_pc = 0x11,
 113     DW_AT_high_pc = 0x12,
 114     DW_AT_language = 0x13,
 115     DW_AT_discr = 0x15,
 116     DW_AT_discr_value = 0x16,
 117     DW_AT_visibility = 0x17,
 118     DW_AT_import = 0x18,
 119     DW_AT_string_length = 0x19,
 120     DW_AT_common_reference = 0x1a,
 121     DW_AT_comp_dir = 0x1b,
 122     DW_AT_const_value = 0x1c,
 123     DW_AT_containing_type = 0x1d,
 124     DW_AT_default_value = 0x1e,
 125     DW_AT_inline = 0x20,
 126     DW_AT_is_optional = 0x21,
 127     DW_AT_lower_bound = 0x22,
 128     DW_AT_producer = 0x25,
 129     DW_AT_prototyped = 0x27,
 130     DW_AT_return_addr = 0x2a,
 131     DW_AT_start_scope = 0x2c,
 132     DW_AT_bit_stride = 0x2e,
 133     DW_AT_upper_bound = 0x2f,
 134     DW_AT_abstract_origin = 0x31,
 135     DW_AT_accessibility = 0x32,
 136     DW_AT_address_class = 0x33,
 137     DW_AT_artificial = 0x34,
 138     DW_AT_base_types = 0x35,
 139     DW_AT_calling_convention = 0x36,
 140     DW_AT_count = 0x37,
 141     DW_AT_data_member_location = 0x38,
 142     DW_AT_decl_column = 0x39,
 143     DW_AT_decl_file = 0x3a,
 144     DW_AT_decl_line = 0x3b,
 145     DW_AT_declaration = 0x3c,
 146     DW_AT_discr_list = 0x3d,
 147     DW_AT_encoding = 0x3e,
 148     DW_AT_external = 0x3f,
 149     DW_AT_frame_base = 0x40,
 150     DW_AT_friend = 0x41,
 151     DW_AT_identifier_case = 0x42,
 152     DW_AT_macro_info = 0x43,
 153     DW_AT_namelist_item = 0x44,
 154     DW_AT_priority = 0x45,
 155     DW_AT_segment = 0x46,
 156     DW_AT_specification = 0x47,
 157     DW_AT_static_link = 0x48,
 158     DW_AT_type = 0x49,
 159     DW_AT_use_location = 0x4a,
 160     DW_AT_variable_parameter = 0x4b,
 161     DW_AT_virtuality = 0x4c,
 162     DW_AT_vtable_elem_location = 0x4d,
 163     DW_AT_allocated = 0x4e,
 164     DW_AT_associated = 0x4f,
 165     DW_AT_data_location = 0x50,
 166     DW_AT_byte_stride = 0x51,
 167     DW_AT_entry_pc = 0x52,
 168     DW_AT_use_UTF8 = 0x53,
 169     DW_AT_extension = 0x54,
 170     DW_AT_ranges = 0x55,
 171     DW_AT_trampoline = 0x56,
 172     DW_AT_call_column = 0x57,
 173     DW_AT_call_file = 0x58,
 174     DW_AT_call_line = 0x59,
 175     DW_AT_description = 0x5a,
 176     DW_AT_binary_scale = 0x5b,
 177     DW_AT_decimal_scale = 0x5c,
 178     DW_AT_small = 0x5d,
 179     DW_AT_decimal_sign = 0x5e,
 180     DW_AT_digit_count = 0x5f,
 181     DW_AT_picture_string = 0x60,
 182     DW_AT_mutable = 0x61,
 183     DW_AT_threads_scaled = 0x62,
 184     DW_AT_explicit = 0x63,
 185     DW_AT_object_pointer = 0x64,
 186     DW_AT_endianity = 0x65,
 187     DW_AT_elemental = 0x66,
 188     DW_AT_pure = 0x67,
 189     DW_AT_recursive = 0x68,
 190     DW_AT_lo_user = 0x2000,
 191     DW_AT_hi_user = 0x3fff,
 192
 193     // Attribute form encodings
 194     DW_FORM_addr = 0x01,
 195     DW_FORM_block2 = 0x03,
 196     DW_FORM_block4 = 0x04,
 197     DW_FORM_data2 = 0x05,
 198     DW_FORM_data4 = 0x06,
 199     DW_FORM_data8 = 0x07,
 200     DW_FORM_string = 0x08,
 201     DW_FORM_block = 0x09,
 202     DW_FORM_block1 = 0x0a,
 203     DW_FORM_data1 = 0x0b,
 204     DW_FORM_flag = 0x0c,
 205     DW_FORM_sdata = 0x0d,
 206     DW_FORM_strp = 0x0e,
 207     DW_FORM_udata = 0x0f,
 208     DW_FORM_ref_addr = 0x10,
 209     DW_FORM_ref1 = 0x11,
 210     DW_FORM_ref2 = 0x12,
 211     DW_FORM_ref4 = 0x13,
 212     DW_FORM_ref8 = 0x14,
 213     DW_FORM_ref_udata = 0x15,
 214     DW_FORM_indirect = 0x16,
 215
 216     // Operation encodings
 217     DW_OP_addr = 0x03,
 218     DW_OP_deref = 0x06,
 219     DW_OP_const1u = 0x08,
 220     DW_OP_const1s = 0x09,
 221     DW_OP_const2u = 0x0a,
 222     DW_OP_const2s = 0x0b,
 223     DW_OP_const4u = 0x0c,
 224     DW_OP_const4s = 0x0d,
 225     DW_OP_const8u = 0x0e,
 226     DW_OP_const8s = 0x0f,
 227     DW_OP_constu = 0x10,
 228     DW_OP_consts = 0x11,
 229     DW_OP_dup = 0x12,
 230     DW_OP_drop = 0x13,
 231     DW_OP_over = 0x14,
 232     DW_OP_pick = 0x15,
 233     DW_OP_swap = 0x16,
 234     DW_OP_rot = 0x17,
 235     DW_OP_xderef = 0x18,
 236     DW_OP_abs = 0x19,
 237     DW_OP_and = 0x1a,
 238     DW_OP_div = 0x1b,
 239     DW_OP_minus = 0x1c,
 240     DW_OP_mod = 0x1d,
 241     DW_OP_mul = 0x1e,
 242     DW_OP_neg = 0x1f,
 243     DW_OP_not = 0x20,
 244     DW_OP_or = 0x21,
 245     DW_OP_plus = 0x22,
 246     DW_OP_plus_uconst = 0x23,
 247     DW_OP_shl = 0x24,
 248     DW_OP_shr = 0x25,
 249     DW_OP_shra = 0x26,
 250     DW_OP_xor = 0x27,
 251     DW_OP_skip = 0x2f,
 252     DW_OP_bra = 0x28,
 253     DW_OP_eq = 0x29,
 254     DW_OP_ge = 0x2a,
 255     DW_OP_gt = 0x2b,
 256     DW_OP_le = 0x2c,
 257     DW_OP_lt = 0x2d,
 258     DW_OP_ne = 0x2e,
 259     DW_OP_lit0 = 0x30,
 260     DW_OP_lit1 = 0x31,
 261     DW_OP_lit31 = 0x4f,
 262     DW_OP_reg0 = 0x50,
 263     DW_OP_reg1 = 0x51,
 264     DW_OP_reg31 = 0x6f,
 265     DW_OP_breg0 = 0x70,
 266     DW_OP_breg1 = 0x71,
 267     DW_OP_breg31 = 0x8f,
 268     DW_OP_regx = 0x90,
 269     DW_OP_fbreg = 0x91,
 270     DW_OP_bregx = 0x92,
 271     DW_OP_piece = 0x93,
 272     DW_OP_deref_size = 0x94,
 273     DW_OP_xderef_size = 0x95,
 274     DW_OP_nop = 0x96,
 275     DW_OP_push_object_address = 0x97,
 276     DW_OP_call2 = 0x98,
 277     DW_OP_call4 = 0x99,
 278     DW_OP_call_ref = 0x9a,
 279     DW_OP_form_tls_address = 0x9b,
 280     DW_OP_call_frame_cfa = 0x9c,
 281     DW_OP_lo_user = 0xe0,
 282     DW_OP_hi_user = 0xff,
 283
 284     // Encoding attribute values
 285     DW_ATE_address = 0x01,
 286     DW_ATE_boolean = 0x02,
 287     DW_ATE_complex_float = 0x03,
 288     DW_ATE_float = 0x04,
 289     DW_ATE_signed = 0x05,
 290     DW_ATE_signed_char = 0x06,
 291     DW_ATE_unsigned = 0x07,
 292     DW_ATE_unsigned_char = 0x08,
 293     DW_ATE_imaginary_float = 0x09,
 294     DW_ATE_packed_decimal = 0x0a,
 295     DW_ATE_numeric_string = 0x0b,
 296     DW_ATE_edited = 0x0c,
 297     DW_ATE_signed_fixed = 0x0d,
 298     DW_ATE_unsigned_fixed = 0x0e,
 299     DW_ATE_decimal_float = 0x0f,
 300     DW_ATE_lo_user = 0x80,
 301     DW_ATE_hi_user = 0xff,
 302
 303     // Decimal sign attribute values
 304     DW_DS_unsigned = 0x01,
 305     DW_DS_leading_overpunch = 0x02,
 306     DW_DS_trailing_overpunch = 0x03,
 307     DW_DS_leading_separate = 0x04,
 308     DW_DS_trailing_separate = 0x05,
 309
 310     // Endianity attribute values
 311     DW_END_default = 0x00,
 312     DW_END_big = 0x01,
 313     DW_END_little = 0x02,
 314     DW_END_lo_user = 0x40,
 315     DW_END_hi_user = 0xff,
 316
 317     // Accessibility codes
 318     DW_ACCESS_public = 0x01,
 319     DW_ACCESS_protected = 0x02,
 320     DW_ACCESS_private = 0x03,
 321
 322     // Visibility codes
 323     DW_VIS_local = 0x01,
 324     DW_VIS_exported = 0x02,
 325     DW_VIS_qualified = 0x03,
 326
 327     // Virtuality codes
 328     DW_VIRTUALITY_none = 0x00,
 329     DW_VIRTUALITY_virtual = 0x01,
 330     DW_VIRTUALITY_pure_virtual = 0x02,
 331
 332     // Language names
 333     DW_LANG_C89 = 0x0001,
 334     DW_LANG_C = 0x0002,
 335     DW_LANG_Ada83 = 0x0003,
 336     DW_LANG_C_plus_plus = 0x0004,
 337     DW_LANG_Cobol74 = 0x0005,
 338     DW_LANG_Cobol85 = 0x0006,
 339     DW_LANG_Fortran77 = 0x0007,
 340     DW_LANG_Fortran90 = 0x0008,
 341     DW_LANG_Pascal83 = 0x0009,
 342     DW_LANG_Modula2 = 0x000a,
 343     DW_LANG_Java = 0x000b,
 344     DW_LANG_C99 = 0x000c,
 345     DW_LANG_Ada95 = 0x000d,
 346     DW_LANG_Fortran95 = 0x000e,
 347     DW_LANG_PLI = 0x000f,
 348     DW_LANG_ObjC = 0x0010,
 349     DW_LANG_ObjC_plus_plus = 0x0011,
 350     DW_LANG_UPC = 0x0012,
 351     DW_LANG_D = 0x0013,
 352     DW_LANG_lo_user = 0x8000,
 353     DW_LANG_hi_user = 0xffff,
 354
 355     // Identifier case codes
 356     DW_ID_case_sensitive = 0x00,
 357     DW_ID_up_case = 0x01,
 358     DW_ID_down_case = 0x02,
 359     DW_ID_case_insensitive = 0x03,
 360
 361     // Calling convention codes
 362     DW_CC_normal = 0x01,
 363     DW_CC_program = 0x02,
 364     DW_CC_nocall = 0x03,
 365     DW_CC_lo_user = 0x40,
 366     DW_CC_hi_user = 0xff,
 367
 368     // Inline codes
 369     DW_INL_not_inlined = 0x00,
 370     DW_INL_inlined = 0x01,
 371     DW_INL_declared_not_inlined = 0x02,
 372     DW_INL_declared_inlined = 0x03,
 373
 374     // Array ordering
 375     DW_ORD_row_major = 0x00,
 376     DW_ORD_col_major = 0x01,
 377
 378     // Discriminant descriptor values
 379     DW_DSC_label = 0x00,
 380     DW_DSC_range = 0x01,
 381
 382     // Line Number Standard Opcode Encodings
 383     DW_LNS_copy = 0x01,
 384     DW_LNS_advance_pc = 0x02,
 385     DW_LNS_advance_line = 0x03,
 386     DW_LNS_set_file = 0x04,
 387     DW_LNS_set_column = 0x05,
 388     DW_LNS_negate_stmt = 0x06,
 389     DW_LNS_set_basic_block = 0x07,
 390     DW_LNS_const_add_pc = 0x08,
 391     DW_LNS_fixed_advance_pc = 0x09,
 392     DW_LNS_set_prologue_end = 0x0a,
 393     DW_LNS_set_epilogue_begin = 0x0b,
 394     DW_LNS_set_isa = 0x0c,
 395
 396     // Line Number Extended Opcode Encodings
 397     DW_LNE_end_sequence = 0x01,
 398     DW_LNE_set_address = 0x02,
 399     DW_LNE_define_file = 0x03,
 400     DW_LNE_lo_user = 0x80,
 401     DW_LNE_hi_user = 0xff,
 402
 403     // Macinfo Type Encodings
 404     DW_MACINFO_define = 0x01,
 405     DW_MACINFO_undef = 0x02,
 406     DW_MACINFO_start_file = 0x03,
 407     DW_MACINFO_end_file = 0x04,
 408     DW_MACINFO_vendor_ext = 0xff,
 409
 410     // Call frame instruction encodings
 411     DW_CFA_advance_loc = 0x40,
 412     DW_CFA_offset = 0x80,
 413     DW_CFA_restore = 0xc0,
 414     DW_CFA_set_loc = 0x01,
 415     DW_CFA_advance_loc1 = 0x02,
 416     DW_CFA_advance_loc2 = 0x03,
 417     DW_CFA_advance_loc4 = 0x04,
 418     DW_CFA_offset_extended = 0x05,
 419     DW_CFA_restore_extended = 0x06,
 420     DW_CFA_undefined = 0x07,
 421     DW_CFA_same_value = 0x08,
 422     DW_CFA_register = 0x09,
 423     DW_CFA_remember_state = 0x0a,
 424     DW_CFA_restore_state = 0x0b,
 425     DW_CFA_def_cfa = 0x0c,
 426     DW_CFA_def_cfa_register = 0x0d,
 427     DW_CFA_def_cfa_offset = 0x0e,
 428     DW_CFA_def_cfa_expression = 0x0f,
 429     DW_CFA_expression = 0x10,
 430     DW_CFA_offset_extended_sf = 0x11,
 431     DW_CFA_def_cfa_sf = 0x12,
 432     DW_CFA_def_cfa_offset_sf = 0x13,
 433     DW_CFA_val_offset = 0x14,
 434     DW_CFA_val_offset_sf = 0x15,
 435     DW_CFA_val_expression = 0x16,
 436     DW_CFA_lo_user = 0x1c,
 437     DW_CFA_hi_user = 0x3f
 438   };
 439
 440   //===--------------------------------------------------------------------===//
 441   // DWLabel - Labels are used to track locations in the assembler file.
 442   // Labels appear in the form <prefix>debug_<Tag><Number>, where the tag is a
 443   // category of label (Ex. location) and number is a value unique in that
 444   // category.
 445   struct DWLabel {
 446     const char *Tag;                    // Label category tag. Should always be
 447                                         // a staticly declared C string.
 448     unsigned    Number;                 // Unique number
 449
 450     DWLabel() : Tag(NULL), Number(0) {}
 451     DWLabel(const char *T, unsigned N) : Tag(T), Number(N) {}
 452   };
 453
 454   //===--------------------------------------------------------------------===//
 455   // DIEAbbrev - Dwarf abbreviation, describes the organization of a debug
 456   // information object.
 457   //
 458   class DIEAbbrev {
 459   private:
 460     const unsigned char *Data;          // Static array of bytes containing the
 461                                         // image of the raw abbreviation data.
 462
 463   public:
 464
 465     DIEAbbrev(const unsigned char *D)
 466     : Data(D)
 467     {}
 468
 469     /// operator== - Used by UniqueVector to locate entry.
 470     ///
 471     bool operator==(const DIEAbbrev &DA) const {
 472       return Data == DA.Data;
 473     }
 474
 475     /// operator< - Used by UniqueVector to locate entry.
 476     ///
 477     bool operator<(const DIEAbbrev &DA) const {
 478       return Data < DA.Data;
 479     }
 480
 481     // Accessors
 482     unsigned getTag()                 const { return Data[0]; }
 483     unsigned getChildrenFlag()        const { return Data[1]; }
 484     unsigned getAttribute(unsigned i) const { return Data[2 + 2 * i + 0]; }
 485     unsigned getForm(unsigned i)      const { return Data[2 + 2 * i + 1]; }
 486   };
 487
 488   //===--------------------------------------------------------------------===//
 489   // DIEValue - A debug information entry value.
 490   //
 491   class DwarfWriter;
 492   class DIEValue {
 493   public:
 494     enum {
 495       isInteger,
 496       isString,
 497       isLabel,
 498       isDelta
 499     };
 500
 501     unsigned Type;                      // Type of the value
 502
 503     DIEValue(unsigned T) : Type(T) {}
 504     virtual ~DIEValue() {}
 505
 506     // Implement isa/cast/dyncast.
 507     static bool classof(const DIEValue *) { return true; }
 508
 509     /// EmitValue - Emit value via the Dwarf writer.
 510     ///
 511     virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const = 0;
 512
 513     /// SizeOf - Return the size of a value in bytes.
 514     ///
 515     virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const = 0;
 516   };
 517
 518   //===--------------------------------------------------------------------===//
 519   // DWInteger - An integer value DIE.
 520   //
 521   class DIEInteger : public DIEValue {
 522   private:
 523     int Value;
 524
 525   public:
 526     DIEInteger(int V) : DIEValue(isInteger), Value(V) {}
 527
 528     // Implement isa/cast/dyncast.
 529     static bool classof(const DIEInteger *) { return true; }
 530     static bool classof(const DIEValue *V)  { return V->Type == isInteger; }
 531
 532     /// EmitValue - Emit integer of appropriate size.
 533     ///
 534     virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const;
 535
 536     /// SizeOf - Determine size of integer value in bytes.
 537     ///
 538     virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const;
 539   };
 540
 541   //===--------------------------------------------------------------------===//
 542   // DIEString - A string value DIE.
 543   //
 544   struct DIEString : public DIEValue {
 545     const std::string Value;
 546
 547     DIEString(const std::string &V) : DIEValue(isString), Value(V) {}
 548
 549     // Implement isa/cast/dyncast.
 550     static bool classof(const DIEString *) { return true; }
 551     static bool classof(const DIEValue *V) { return V->Type == isString; }
 552
 553     /// EmitValue - Emit string value.
 554     ///
 555     virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const;
 556
 557     /// SizeOf - Determine size of string value in bytes.
 558     ///
 559     virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const;
 560   };
 561
 562   //===--------------------------------------------------------------------===//
 563   // DIELabel - A simple label expression DIE.
 564   //
 565   struct DIELabel : public DIEValue {
 566     const DWLabel Value;
 567
 568     DIELabel(const DWLabel &V) : DIEValue(isLabel), Value(V) {}
 569
 570     // Implement isa/cast/dyncast.
 571     static bool classof(const DWLabel *)   { return true; }
 572     static bool classof(const DIEValue *V) { return V->Type == isLabel; }
 573
 574     /// EmitValue - Emit label value.
 575     ///
 576     virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const;
 577
 578     /// SizeOf - Determine size of label value in bytes.
 579     ///
 580     virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const;
 581   };
 582
 583   //===--------------------------------------------------------------------===//
 584   // DIEDelta - A simple label difference DIE.
 585   //
 586   struct DIEDelta : public DIEValue {
 587     const DWLabel Value1;
 588     const DWLabel Value2;
 589
 590     DIEDelta(const DWLabel &V1, const DWLabel &V2)
 591     : DIEValue(isDelta), Value1(V1), Value2(V2) {}
 592
 593     // Implement isa/cast/dyncast.
 594     static bool classof(const DIEDelta *)  { return true; }
 595     static bool classof(const DIEValue *V) { return V->Type == isDelta; }
 596
 597     /// EmitValue - Emit delta value.
 598     ///
 599     virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const;
 600
 601     /// SizeOf - Determine size of delta value in bytes.
 602     ///
 603     virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const;
 604   };
 605
 606   //===--------------------------------------------------------------------===//
 607   // DIE - A structured debug information entry.  Has an abbreviation which
 608   // describes it's organization.
 609   class DIE {
 610   private:
 611     unsigned AbbrevID;                    // Decribing abbreviation ID.
 612     unsigned Offset;                      // Offset in debug info section
 613     unsigned Size;                        // Size of instance + children
 614     std::vector<DIE *> Children;          // Children DIEs
 615     std::vector<DIEValue *> Values;       // Attributes values
 616
 617   public:
 618     DIE(unsigned AbbrevID)
 619     : AbbrevID(AbbrevID)
 620     , Offset(0)
 621     , Size(0)
 622     , Children()
 623     , Values()
 624     {}
 625     ~DIE() {
 626       for (unsigned i = 0, N = Children.size(); i < N; i++) {
 627         delete Children[i];
 628       }
 629
 630       for (unsigned j = 0, M = Children.size(); j < M; j++) {
 631         delete Children[j];
 632       }
 633     }
 634
 635     // Accessors
 636     unsigned getAbbrevID()                     const { return AbbrevID; }
 637     unsigned getOffset()                       const { return Offset; }
 638     unsigned getSize()                         const { return Size; }
 639     const std::vector<DIE *> &getChildren()    const { return Children; }
 640     const std::vector<DIEValue *> &getValues() const { return Values; }
 641     void setOffset(unsigned O)                 { Offset = O; }
 642     void setSize(unsigned S)                   { Size = S; }
 643
 644     /// AddValue - Add an attribute value of appropriate type.
 645     ///
 646     void AddValue(int Value) {
 647       Values.push_back(new DIEInteger(Value));
 648     }
 649     void AddValue(const std::string &Value) {
 650       Values.push_back(new DIEString(Value));
 651     }
 652     void AddValue(const DWLabel &Value) {
 653       Values.push_back(new DIELabel(Value));
 654     }
 655     void AddValue(const DWLabel &Value1, const DWLabel &Value2) {
 656       Values.push_back(new DIEDelta(Value1, Value2));
 657     }
 658
 659     /// SiblingOffset - Return the offset of the debug information entry's
 660     /// sibling.
 661     unsigned SiblingOffset() const { return Offset + Size; }
 662   };
 663
 664   //===--------------------------------------------------------------------===//
 665   // Forward declarations.
 666   //
 667   class AsmPrinter;
 668   class MachineDebugInfo;
 669
 670   //===--------------------------------------------------------------------===//
 671   // DwarfWriter - emits Dwarf debug and exception handling directives.
 672   //
 673   class DwarfWriter {
 674
 675   protected:
 676
 677     //===------------------------------------------------------------------===//
 678     // Core attributes used by the Dwarf  writer.
 679     //
 680
 681     //
 682     /// O - Stream to .s file.
 683     ///
 684     std::ostream &O;
 685
 686     /// Asm - Target of Dwarf emission.
 687     ///
 688     AsmPrinter *Asm;
 689
 690     /// DebugInfo - Collected debug information.
 691     ///
 692     MachineDebugInfo *DebugInfo;
 693
 694     /// didInitial - Flag to indicate if initial emission has been done.
 695     ///
 696     bool didInitial;
 697
 698     //===------------------------------------------------------------------===//
 699     // Attributes used to construct specific Dwarf sections.
 700     //
 701
 702     /// CompileUnits - All the compile units involved in this build.  The index
 703     /// of each entry in this vector corresponds to the sources in DebugInfo.
 704     std::vector<DIE *> CompileUnits;
 705
 706     /// Abbreviations - A UniqueVector of TAG structure abbreviations.
 707     ///
 708     UniqueVector<DIEAbbrev> Abbreviations;
 709
 710     //===------------------------------------------------------------------===//
 711     // Properties to be set by the derived class ctor, used to configure the
 712     // Dwarf writer.
 713     //
 714
 715     /// AddressSize - Size of addresses used in file.
 716     ///
 717     unsigned AddressSize;
 718
 719     /// hasLEB128 - True if target asm supports leb128 directives.
 720     ///
 721     bool hasLEB128; /// Defaults to false.
 722
 723     /// hasDotLoc - True if target asm supports .loc directives.
 724     ///
 725     bool hasDotLoc; /// Defaults to false.
 726
 727     /// hasDotFile - True if target asm supports .file directives.
 728     ///
 729     bool hasDotFile; /// Defaults to false.
 730
 731     /// needsSet - True if target asm can't compute addresses on data
 732     /// directives.
 733     bool needsSet; /// Defaults to false.
 734
 735     /// DwarfAbbrevSection - Section directive for Dwarf abbrev.
 736     ///
 737     const char *DwarfAbbrevSection; /// Defaults to ".debug_abbrev".
 738
 739     /// DwarfInfoSection - Section directive for Dwarf info.
 740     ///
 741     const char *DwarfInfoSection; /// Defaults to ".debug_info".
 742
 743     /// DwarfLineSection - Section directive for Dwarf info.
 744     ///
 745     const char *DwarfLineSection; /// Defaults to ".debug_line".
 746
 747     /// TextSection - Section directive for standard text.
 748     ///
 749     const char *TextSection; /// Defaults to ".text".
 750
 751     /// DataSection - Section directive for standard data.
 752     ///
 753     const char *DataSection; /// Defaults to ".data".
 754
 755     //===------------------------------------------------------------------===//
 756     // Emission and print routines
 757     //
 758
 759 public:
 760     /// getAddressSize - Return the size of a target address in bytes.
 761     ///
 762     unsigned getAddressSize() const { return AddressSize; }
 763
 764     /// PrintHex - Print a value as a hexidecimal value.
 765     ///
 766     void PrintHex(int Value) const;
 767
 768     /// EOL - Print a newline character to asm stream.  If a comment is present
 769     /// then it will be printed first.  Comments should not contain '\n'.
 770     void EOL(const std::string &Comment) const;
 771
 772     /// EmitULEB128Bytes - Emit an assembler byte data directive to compose an
 773     /// unsigned leb128 value.
 774     void EmitULEB128Bytes(unsigned Value) const;
 775
 776     /// EmitSLEB128Bytes - print an assembler byte data directive to compose a
 777     /// signed leb128 value.
 778     void EmitSLEB128Bytes(int Value) const;
 779
 780     /// PrintULEB128 - Print a series of hexidecimal values (separated by
 781     /// commas) representing an unsigned leb128 value.
 782     void PrintULEB128(unsigned Value) const;
 783
 784     /// SizeULEB128 - Compute the number of bytes required for an unsigned
 785     /// leb128 value.
 786     static unsigned SizeULEB128(unsigned Value);
 787
 788     /// PrintSLEB128 - Print a series of hexidecimal values (separated by
 789     /// commas) representing a signed leb128 value.
 790     void PrintSLEB128(int Value) const;
 791
 792     /// SizeSLEB128 - Compute the number of bytes required for a signed leb128
 793     /// value.
 794     static unsigned SizeSLEB128(int Value);
 795
 796     /// EmitByte - Emit a byte directive and value.
 797     ///
 798     void EmitByte(int Value) const;
 799
 800     /// EmitShort - Emit a short directive and value.
 801     ///
 802     void EmitShort(int Value) const;
 803
 804     /// EmitLong - Emit a long directive and value.
 805     ///
 806     void EmitLong(int Value) const;
 807
 808     /// EmitString - Emit a string with quotes and a null terminator.
 809     /// Special characters are emitted properly. (Eg. '\t')
 810     void DwarfWriter::EmitString(const std::string &String) const;
 811
 812     /// PrintLabelName - Print label name in form used by Dwarf writer.
 813     ///
 814     void PrintLabelName(DWLabel Label) const {
 815       PrintLabelName(Label.Tag, Label.Number);
 816     }
 817     void PrintLabelName(const char *Tag, unsigned Number) const;
 818
 819     /// EmitLabel - Emit location label for internal use by Dwarf.
 820     ///
 821     void EmitLabel(DWLabel Label) const {
 822       EmitLabel(Label.Tag, Label.Number);
 823     }
 824     void EmitLabel(const char *Tag, unsigned Number) const;
 825
 826     /// EmitLabelReference - Emit a reference to a label.
 827     ///
 828     void EmitLabelReference(DWLabel Label) const {
 829       EmitLabelReference(Label.Tag, Label.Number);
 830     }
 831     void EmitLabelReference(const char *Tag, unsigned Number) const;
 832
 833     /// EmitDifference - Emit the difference between two labels.  Some
 834     /// assemblers do not behave with absolute expressions with data directives,
 835     /// so there is an option (needsSet) to use an intermediary set expression.
 836     void EmitDifference(DWLabel Label1, DWLabel Label2) const {
 837       EmitDifference(Label1.Tag, Label1.Number, Label2.Tag, Label2.Number);
 838     }
 839     void EmitDifference(const char *Tag1, unsigned Number1,
 840                         const char *Tag2, unsigned Number2) const;
 841
 842 private:
 843     /// NewDIE - Construct a new structured debug information entry.
 844     ///
 845     DIE *NewDIE(const unsigned char *AbbrevData);
 846
 847     /// NewCompileUnit - Create new compile unit information.
 848     ///
 849     DIE *NewCompileUnit(const std::string &Directory,
 850                         const std::string &SourceName);
 851
 852     /// EmitInitial - Emit initial Dwarf declarations.
 853     ///
 854     void EmitInitial() const;
 855
 856     /// EmitDIE - Recusively Emits a debug information entry.
 857     ///
 858     void EmitDIE(DIE *Die) const;
 859
 860     /// SizeAndOffsetDie - Compute the size and offset of a DIE.
 861     ///
 862     unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset) const;
 863
 864     /// SizeAndOffsets - Compute the size and offset of all the DIEs.
 865     ///
 866     void SizeAndOffsets();
 867
 868     /// EmitDebugInfo - Emit the debug info section.
 869     ///
 870     void EmitDebugInfo() const;
 871
 872     /// EmitAbbreviations - Emit the abbreviation section.
 873     ///
 874     void EmitAbbreviations() const;
 875
 876     /// EmitDebugLines - Emit source line information.
 877     ///
 878     void EmitDebugLines() const;
 879
 880     /// ShouldEmitDwarf - Returns true if Dwarf declarations should be made.
 881     /// When called it also checks to see if debug info is newly available.  if
 882     /// so the initial Dwarf headers are emitted.
 883     bool ShouldEmitDwarf();
 884
 885   public:
 886
 887     DwarfWriter(std::ostream &o, AsmPrinter *ap);
 888     virtual ~DwarfWriter();
 889
 890     /// SetDebugInfo - Set DebugInfo when it's known that pass manager has
 891     /// created it.  Set by the target AsmPrinter.
 892     void SetDebugInfo(MachineDebugInfo *di) { DebugInfo = di; }
 893
 894     //===------------------------------------------------------------------===//
 895     // Main enties.
 896     //
 897
 898     /// BeginModule - Emit all Dwarf sections that should come prior to the
 899     /// content.
 900     void BeginModule();
 901
 902     /// EndModule - Emit all Dwarf sections that should come after the content.
 903     ///
 904     void EndModule();
 905
 906     /// BeginFunction - Emit pre-function debug information.
 907     ///
 908     void BeginFunction();
 909
 910     /// EndFunction - Emit post-function debug information.
 911     ///
 912     void EndFunction();
 913   };
 914
 915 } // end llvm namespace
 916
 917 #endif