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