lib/CodeGen/DwarfWriter.cpp

   1 //===-- llvm/CodeGen/DwarfWriter.cpp - 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.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/CodeGen/DwarfWriter.h"
  15
  16 #include "llvm/ADT/StringExtras.h"
  17 #include "llvm/Module.h"
  18 #include "llvm/Type.h"
  19 #include "llvm/CodeGen/AsmPrinter.h"
  20 #include "llvm/CodeGen/MachineDebugInfo.h"
  21 #include "llvm/Support/CommandLine.h"
  22 #include "llvm/Support/Mangler.h"
  23 #include "llvm/Target/TargetMachine.h"
  24
  25 #include <iostream>
  26
  27 using namespace llvm;
  28
  29 static cl::opt<bool>
  30 DwarfVerbose("dwarf-verbose", cl::Hidden,
  31                                 cl::desc("Add comments to Dwarf directives."));
  32
  33 //===----------------------------------------------------------------------===//
  34
  35 /// TagString - Return the string for the specified tag.
  36 ///
  37 static const char *TagString(unsigned Tag) {
  38   switch(Tag) {
  39     case DW_TAG_array_type:                return "TAG_array_type";
  40     case DW_TAG_class_type:                return "TAG_class_type";
  41     case DW_TAG_entry_point:               return "TAG_entry_point";
  42     case DW_TAG_enumeration_type:          return "TAG_enumeration_type";
  43     case DW_TAG_formal_parameter:          return "TAG_formal_parameter";
  44     case DW_TAG_imported_declaration:      return "TAG_imported_declaration";
  45     case DW_TAG_label:                     return "TAG_label";
  46     case DW_TAG_lexical_block:             return "TAG_lexical_block";
  47     case DW_TAG_member:                    return "TAG_member";
  48     case DW_TAG_pointer_type:              return "TAG_pointer_type";
  49     case DW_TAG_reference_type:            return "TAG_reference_type";
  50     case DW_TAG_compile_unit:              return "TAG_compile_unit";
  51     case DW_TAG_string_type:               return "TAG_string_type";
  52     case DW_TAG_structure_type:            return "TAG_structure_type";
  53     case DW_TAG_subroutine_type:           return "TAG_subroutine_type";
  54     case DW_TAG_typedef:                   return "TAG_typedef";
  55     case DW_TAG_union_type:                return "TAG_union_type";
  56     case DW_TAG_unspecified_parameters:    return "TAG_unspecified_parameters";
  57     case DW_TAG_variant:                   return "TAG_variant";
  58     case DW_TAG_common_block:              return "TAG_common_block";
  59     case DW_TAG_common_inclusion:          return "TAG_common_inclusion";
  60     case DW_TAG_inheritance:               return "TAG_inheritance";
  61     case DW_TAG_inlined_subroutine:        return "TAG_inlined_subroutine";
  62     case DW_TAG_module:                    return "TAG_module";
  63     case DW_TAG_ptr_to_member_type:        return "TAG_ptr_to_member_type";
  64     case DW_TAG_set_type:                  return "TAG_set_type";
  65     case DW_TAG_subrange_type:             return "TAG_subrange_type";
  66     case DW_TAG_with_stmt:                 return "TAG_with_stmt";
  67     case DW_TAG_access_declaration:        return "TAG_access_declaration";
  68     case DW_TAG_base_type:                 return "TAG_base_type";
  69     case DW_TAG_catch_block:               return "TAG_catch_block";
  70     case DW_TAG_const_type:                return "TAG_const_type";
  71     case DW_TAG_constant:                  return "TAG_constant";
  72     case DW_TAG_enumerator:                return "TAG_enumerator";
  73     case DW_TAG_file_type:                 return "TAG_file_type";
  74     case DW_TAG_friend:                    return "TAG_friend";
  75     case DW_TAG_namelist:                  return "TAG_namelist";
  76     case DW_TAG_namelist_item:             return "TAG_namelist_item";
  77     case DW_TAG_packed_type:               return "TAG_packed_type";
  78     case DW_TAG_subprogram:                return "TAG_subprogram";
  79     case DW_TAG_template_type_parameter:   return "TAG_template_type_parameter";
  80     case DW_TAG_template_value_parameter: return "TAG_template_value_parameter";
  81     case DW_TAG_thrown_type:               return "TAG_thrown_type";
  82     case DW_TAG_try_block:                 return "TAG_try_block";
  83     case DW_TAG_variant_part:              return "TAG_variant_part";
  84     case DW_TAG_variable:                  return "TAG_variable";
  85     case DW_TAG_volatile_type:             return "TAG_volatile_type";
  86     case DW_TAG_dwarf_procedure:           return "TAG_dwarf_procedure";
  87     case DW_TAG_restrict_type:             return "TAG_restrict_type";
  88     case DW_TAG_interface_type:            return "TAG_interface_type";
  89     case DW_TAG_namespace:                 return "TAG_namespace";
  90     case DW_TAG_imported_module:           return "TAG_imported_module";
  91     case DW_TAG_unspecified_type:          return "TAG_unspecified_type";
  92     case DW_TAG_partial_unit:              return "TAG_partial_unit";
  93     case DW_TAG_imported_unit:             return "TAG_imported_unit";
  94     case DW_TAG_condition:                 return "TAG_condition";
  95     case DW_TAG_shared_type:               return "TAG_shared_type";
  96     case DW_TAG_lo_user:                   return "TAG_lo_user";
  97     case DW_TAG_hi_user:                   return "TAG_hi_user";
  98   }
  99   assert(0 && "Unknown Dwarf Tag");
 100   return "";
 101 }
 102
 103 /// ChildrenString - Return the string for the specified children flag.
 104 ///
 105 static const char *ChildrenString(unsigned Children) {
 106   switch(Children) {
 107     case DW_CHILDREN_no:                   return "CHILDREN_no";
 108     case DW_CHILDREN_yes:                  return "CHILDREN_yes";
 109   }
 110   assert(0 && "Unknown Dwarf ChildrenFlag");
 111   return "";
 112 }
 113
 114 /// AttributeString - Return the string for the specified attribute.
 115 ///
 116 static const char *AttributeString(unsigned Attribute) {
 117   switch(Attribute) {
 118     case DW_AT_sibling:                    return "AT_sibling";
 119     case DW_AT_location:                   return "AT_location";
 120     case DW_AT_name:                       return "AT_name";
 121     case DW_AT_ordering:                   return "AT_ordering";
 122     case DW_AT_byte_size:                  return "AT_byte_size";
 123     case DW_AT_bit_offset:                 return "AT_bit_offset";
 124     case DW_AT_bit_size:                   return "AT_bit_size";
 125     case DW_AT_stmt_list:                  return "AT_stmt_list";
 126     case DW_AT_low_pc:                     return "AT_low_pc";
 127     case DW_AT_high_pc:                    return "AT_high_pc";
 128     case DW_AT_language:                   return "AT_language";
 129     case DW_AT_discr:                      return "AT_discr";
 130     case DW_AT_discr_value:                return "AT_discr_value";
 131     case DW_AT_visibility:                 return "AT_visibility";
 132     case DW_AT_import:                     return "AT_import";
 133     case DW_AT_string_length:              return "AT_string_length";
 134     case DW_AT_common_reference:           return "AT_common_reference";
 135     case DW_AT_comp_dir:                   return "AT_comp_dir";
 136     case DW_AT_const_value:                return "AT_const_value";
 137     case DW_AT_containing_type:            return "AT_containing_type";
 138     case DW_AT_default_value:              return "AT_default_value";
 139     case DW_AT_inline:                     return "AT_inline";
 140     case DW_AT_is_optional:                return "AT_is_optional";
 141     case DW_AT_lower_bound:                return "AT_lower_bound";
 142     case DW_AT_producer:                   return "AT_producer";
 143     case DW_AT_prototyped:                 return "AT_prototyped";
 144     case DW_AT_return_addr:                return "AT_return_addr";
 145     case DW_AT_start_scope:                return "AT_start_scope";
 146     case DW_AT_bit_stride:                 return "AT_bit_stride";
 147     case DW_AT_upper_bound:                return "AT_upper_bound";
 148     case DW_AT_abstract_origin:            return "AT_abstract_origin";
 149     case DW_AT_accessibility:              return "AT_accessibility";
 150     case DW_AT_address_class:              return "AT_address_class";
 151     case DW_AT_artificial:                 return "AT_artificial";
 152     case DW_AT_base_types:                 return "AT_base_types";
 153     case DW_AT_calling_convention:         return "AT_calling_convention";
 154     case DW_AT_count:                      return "AT_count";
 155     case DW_AT_data_member_location:       return "AT_data_member_location";
 156     case DW_AT_decl_column:                return "AT_decl_column";
 157     case DW_AT_decl_file:                  return "AT_decl_file";
 158     case DW_AT_decl_line:                  return "AT_decl_line";
 159     case DW_AT_declaration:                return "AT_declaration";
 160     case DW_AT_discr_list:                 return "AT_discr_list";
 161     case DW_AT_encoding:                   return "AT_encoding";
 162     case DW_AT_external:                   return "AT_external";
 163     case DW_AT_frame_base:                 return "AT_frame_base";
 164     case DW_AT_friend:                     return "AT_friend";
 165     case DW_AT_identifier_case:            return "AT_identifier_case";
 166     case DW_AT_macro_info:                 return "AT_macro_info";
 167     case DW_AT_namelist_item:              return "AT_namelist_item";
 168     case DW_AT_priority:                   return "AT_priority";
 169     case DW_AT_segment:                    return "AT_segment";
 170     case DW_AT_specification:              return "AT_specification";
 171     case DW_AT_static_link:                return "AT_static_link";
 172     case DW_AT_type:                       return "AT_type";
 173     case DW_AT_use_location:               return "AT_use_location";
 174     case DW_AT_variable_parameter:         return "AT_variable_parameter";
 175     case DW_AT_virtuality:                 return "AT_virtuality";
 176     case DW_AT_vtable_elem_location:       return "AT_vtable_elem_location";
 177     case DW_AT_allocated:                  return "AT_allocated";
 178     case DW_AT_associated:                 return "AT_associated";
 179     case DW_AT_data_location:              return "AT_data_location";
 180     case DW_AT_byte_stride:                return "AT_byte_stride";
 181     case DW_AT_entry_pc:                   return "AT_entry_pc";
 182     case DW_AT_use_UTF8:                   return "AT_use_UTF8";
 183     case DW_AT_extension:                  return "AT_extension";
 184     case DW_AT_ranges:                     return "AT_ranges";
 185     case DW_AT_trampoline:                 return "AT_trampoline";
 186     case DW_AT_call_column:                return "AT_call_column";
 187     case DW_AT_call_file:                  return "AT_call_file";
 188     case DW_AT_call_line:                  return "AT_call_line";
 189     case DW_AT_description:                return "AT_description";
 190     case DW_AT_binary_scale:               return "AT_binary_scale";
 191     case DW_AT_decimal_scale:              return "AT_decimal_scale";
 192     case DW_AT_small:                      return "AT_small";
 193     case DW_AT_decimal_sign:               return "AT_decimal_sign";
 194     case DW_AT_digit_count:                return "AT_digit_count";
 195     case DW_AT_picture_string:             return "AT_picture_string";
 196     case DW_AT_mutable:                    return "AT_mutable";
 197     case DW_AT_threads_scaled:             return "AT_threads_scaled";
 198     case DW_AT_explicit:                   return "AT_explicit";
 199     case DW_AT_object_pointer:             return "AT_object_pointer";
 200     case DW_AT_endianity:                  return "AT_endianity";
 201     case DW_AT_elemental:                  return "AT_elemental";
 202     case DW_AT_pure:                       return "AT_pure";
 203     case DW_AT_recursive:                  return "AT_recursive";
 204     case DW_AT_lo_user:                    return "AT_lo_user";
 205     case DW_AT_hi_user:                    return "AT_hi_user";
 206   }
 207   assert(0 && "Unknown Dwarf Attribute");
 208   return "";
 209 }
 210
 211 /// FormEncodingString - Return the string for the specified form encoding.
 212 ///
 213 static const char *FormEncodingString(unsigned Encoding) {
 214   switch(Encoding) {
 215     case DW_FORM_addr:                     return "FORM_addr";
 216     case DW_FORM_block2:                   return "FORM_block2";
 217     case DW_FORM_block4:                   return "FORM_block4";
 218     case DW_FORM_data2:                    return "FORM_data2";
 219     case DW_FORM_data4:                    return "FORM_data4";
 220     case DW_FORM_data8:                    return "FORM_data8";
 221     case DW_FORM_string:                   return "FORM_string";
 222     case DW_FORM_block:                    return "FORM_block";
 223     case DW_FORM_block1:                   return "FORM_block1";
 224     case DW_FORM_data1:                    return "FORM_data1";
 225     case DW_FORM_flag:                     return "FORM_flag";
 226     case DW_FORM_sdata:                    return "FORM_sdata";
 227     case DW_FORM_strp:                     return "FORM_strp";
 228     case DW_FORM_udata:                    return "FORM_udata";
 229     case DW_FORM_ref_addr:                 return "FORM_ref_addr";
 230     case DW_FORM_ref1:                     return "FORM_ref1";
 231     case DW_FORM_ref2:                     return "FORM_ref2";
 232     case DW_FORM_ref4:                     return "FORM_ref4";
 233     case DW_FORM_ref8:                     return "FORM_ref8";
 234     case DW_FORM_ref_udata:                return "FORM_ref_udata";
 235     case DW_FORM_indirect:                 return "FORM_indirect";
 236   }
 237   assert(0 && "Unknown Dwarf Form Encoding");
 238   return "";
 239 }
 240
 241 /// OperationEncodingString - Return the string for the specified operation
 242 /// encoding.
 243 static const char *OperationEncodingString(unsigned Encoding) {
 244   switch(Encoding) {
 245     case DW_OP_addr:                       return "OP_addr";
 246     case DW_OP_deref:                      return "OP_deref";
 247     case DW_OP_const1u:                    return "OP_const1u";
 248     case DW_OP_const1s:                    return "OP_const1s";
 249     case DW_OP_const2u:                    return "OP_const2u";
 250     case DW_OP_const2s:                    return "OP_const2s";
 251     case DW_OP_const4u:                    return "OP_const4u";
 252     case DW_OP_const4s:                    return "OP_const4s";
 253     case DW_OP_const8u:                    return "OP_const8u";
 254     case DW_OP_const8s:                    return "OP_const8s";
 255     case DW_OP_constu:                     return "OP_constu";
 256     case DW_OP_consts:                     return "OP_consts";
 257     case DW_OP_dup:                        return "OP_dup";
 258     case DW_OP_drop:                       return "OP_drop";
 259     case DW_OP_over:                       return "OP_over";
 260     case DW_OP_pick:                       return "OP_pick";
 261     case DW_OP_swap:                       return "OP_swap";
 262     case DW_OP_rot:                        return "OP_rot";
 263     case DW_OP_xderef:                     return "OP_xderef";
 264     case DW_OP_abs:                        return "OP_abs";
 265     case DW_OP_and:                        return "OP_and";
 266     case DW_OP_div:                        return "OP_div";
 267     case DW_OP_minus:                      return "OP_minus";
 268     case DW_OP_mod:                        return "OP_mod";
 269     case DW_OP_mul:                        return "OP_mul";
 270     case DW_OP_neg:                        return "OP_neg";
 271     case DW_OP_not:                        return "OP_not";
 272     case DW_OP_or:                         return "OP_or";
 273     case DW_OP_plus:                       return "OP_plus";
 274     case DW_OP_plus_uconst:                return "OP_plus_uconst";
 275     case DW_OP_shl:                        return "OP_shl";
 276     case DW_OP_shr:                        return "OP_shr";
 277     case DW_OP_shra:                       return "OP_shra";
 278     case DW_OP_xor:                        return "OP_xor";
 279     case DW_OP_skip:                       return "OP_skip";
 280     case DW_OP_bra:                        return "OP_bra";
 281     case DW_OP_eq:                         return "OP_eq";
 282     case DW_OP_ge:                         return "OP_ge";
 283     case DW_OP_gt:                         return "OP_gt";
 284     case DW_OP_le:                         return "OP_le";
 285     case DW_OP_lt:                         return "OP_lt";
 286     case DW_OP_ne:                         return "OP_ne";
 287     case DW_OP_lit0:                       return "OP_lit0";
 288     case DW_OP_lit1:                       return "OP_lit1";
 289     case DW_OP_lit31:                      return "OP_lit31";
 290     case DW_OP_reg0:                       return "OP_reg0";
 291     case DW_OP_reg1:                       return "OP_reg1";
 292     case DW_OP_reg31:                      return "OP_reg31";
 293     case DW_OP_breg0:                      return "OP_breg0";
 294     case DW_OP_breg1:                      return "OP_breg1";
 295     case DW_OP_breg31:                     return "OP_breg31";
 296     case DW_OP_regx:                       return "OP_regx";
 297     case DW_OP_fbreg:                      return "OP_fbreg";
 298     case DW_OP_bregx:                      return "OP_bregx";
 299     case DW_OP_piece:                      return "OP_piece";
 300     case DW_OP_deref_size:                 return "OP_deref_size";
 301     case DW_OP_xderef_size:                return "OP_xderef_size";
 302     case DW_OP_nop:                        return "OP_nop";
 303     case DW_OP_push_object_address:        return "OP_push_object_address";
 304     case DW_OP_call2:                      return "OP_call2";
 305     case DW_OP_call4:                      return "OP_call4";
 306     case DW_OP_call_ref:                   return "OP_call_ref";
 307     case DW_OP_form_tls_address:           return "OP_form_tls_address";
 308     case DW_OP_call_frame_cfa:             return "OP_call_frame_cfa";
 309     case DW_OP_lo_user:                    return "OP_lo_user";
 310     case DW_OP_hi_user:                    return "OP_hi_user";
 311   }
 312   assert(0 && "Unknown Dwarf Operation Encoding");
 313   return "";
 314 }
 315
 316 /// AttributeEncodingString - Return the string for the specified attribute
 317 /// encoding.
 318 static const char *AttributeEncodingString(unsigned Encoding) {
 319   switch(Encoding) {
 320     case DW_ATE_address:                   return "ATE_address";
 321     case DW_ATE_boolean:                   return "ATE_boolean";
 322     case DW_ATE_complex_float:             return "ATE_complex_float";
 323     case DW_ATE_float:                     return "ATE_float";
 324     case DW_ATE_signed:                    return "ATE_signed";
 325     case DW_ATE_signed_char:               return "ATE_signed_char";
 326     case DW_ATE_unsigned:                  return "ATE_unsigned";
 327     case DW_ATE_unsigned_char:             return "ATE_unsigned_char";
 328     case DW_ATE_imaginary_float:           return "ATE_imaginary_float";
 329     case DW_ATE_packed_decimal:            return "ATE_packed_decimal";
 330     case DW_ATE_numeric_string:            return "ATE_numeric_string";
 331     case DW_ATE_edited:                    return "ATE_edited";
 332     case DW_ATE_signed_fixed:              return "ATE_signed_fixed";
 333     case DW_ATE_unsigned_fixed:            return "ATE_unsigned_fixed";
 334     case DW_ATE_decimal_float:             return "ATE_decimal_float";
 335     case DW_ATE_lo_user:                   return "ATE_lo_user";
 336     case DW_ATE_hi_user:                   return "ATE_hi_user";
 337   }
 338   assert(0 && "Unknown Dwarf Attribute Encoding");
 339   return "";
 340 }
 341
 342 /// DecimalSignString - Return the string for the specified decimal sign
 343 /// attribute.
 344 static const char *DecimalSignString(unsigned Sign) {
 345   switch(Sign) {
 346     case DW_DS_unsigned:                   return "DS_unsigned";
 347     case DW_DS_leading_overpunch:          return "DS_leading_overpunch";
 348     case DW_DS_trailing_overpunch:         return "DS_trailing_overpunch";
 349     case DW_DS_leading_separate:           return "DS_leading_separate";
 350     case DW_DS_trailing_separate:          return "DS_trailing_separate";
 351   }
 352   assert(0 && "Unknown Dwarf Decimal Sign Attribute");
 353   return "";
 354 }
 355
 356 /// EndianityString - Return the string for the specified endianity.
 357 ///
 358 static const char *EndianityString(unsigned Endian) {
 359   switch(Endian) {
 360     case DW_END_default:                   return "END_default";
 361     case DW_END_big:                       return "END_big";
 362     case DW_END_little:                    return "END_little";
 363     case DW_END_lo_user:                   return "END_lo_user";
 364     case DW_END_hi_user:                   return "END_hi_user";
 365   }
 366   assert(0 && "Unknown Dwarf Endianity");
 367   return "";
 368 }
 369
 370 /// AccessibilityString - Return the string for the specified accessibility.
 371 ///
 372 static const char *AccessibilityString(unsigned Access) {
 373   switch(Access) {
 374     // Accessibility codes
 375     case DW_ACCESS_public:                 return "ACCESS_public";
 376     case DW_ACCESS_protected:              return "ACCESS_protected";
 377     case DW_ACCESS_private:                return "ACCESS_private";
 378   }
 379   assert(0 && "Unknown Dwarf Accessibility");
 380   return "";
 381 }
 382
 383 /// VisibilityString - Return the string for the specified visibility.
 384 ///
 385 static const char *VisibilityString(unsigned Visibility) {
 386   switch(Visibility) {
 387     case DW_VIS_local:                     return "VIS_local";
 388     case DW_VIS_exported:                  return "VIS_exported";
 389     case DW_VIS_qualified:                 return "VIS_qualified";
 390   }
 391   assert(0 && "Unknown Dwarf Visibility");
 392   return "";
 393 }
 394
 395 /// VirtualityString - Return the string for the specified virtuality.
 396 ///
 397 static const char *VirtualityString(unsigned Virtuality) {
 398   switch(Virtuality) {
 399     case DW_VIRTUALITY_none:               return "VIRTUALITY_none";
 400     case DW_VIRTUALITY_virtual:            return "VIRTUALITY_virtual";
 401     case DW_VIRTUALITY_pure_virtual:       return "VIRTUALITY_pure_virtual";
 402   }
 403   assert(0 && "Unknown Dwarf Virtuality");
 404   return "";
 405 }
 406
 407 /// LanguageString - Return the string for the specified language.
 408 ///
 409 static const char *LanguageString(unsigned Language) {
 410   switch(Language) {
 411     case DW_LANG_C89:                      return "LANG_C89";
 412     case DW_LANG_C:                        return "LANG_C";
 413     case DW_LANG_Ada83:                    return "LANG_Ada83";
 414     case DW_LANG_C_plus_plus:              return "LANG_C_plus_plus";
 415     case DW_LANG_Cobol74:                  return "LANG_Cobol74";
 416     case DW_LANG_Cobol85:                  return "LANG_Cobol85";
 417     case DW_LANG_Fortran77:                return "LANG_Fortran77";
 418     case DW_LANG_Fortran90:                return "LANG_Fortran90";
 419     case DW_LANG_Pascal83:                 return "LANG_Pascal83";
 420     case DW_LANG_Modula2:                  return "LANG_Modula2";
 421     case DW_LANG_Java:                     return "LANG_Java";
 422     case DW_LANG_C99:                      return "LANG_C99";
 423     case DW_LANG_Ada95:                    return "LANG_Ada95";
 424     case DW_LANG_Fortran95:                return "LANG_Fortran95";
 425     case DW_LANG_PLI:                      return "LANG_PLI";
 426     case DW_LANG_ObjC:                     return "LANG_ObjC";
 427     case DW_LANG_ObjC_plus_plus:           return "LANG_ObjC_plus_plus";
 428     case DW_LANG_UPC:                      return "LANG_UPC";
 429     case DW_LANG_D:                        return "LANG_D";
 430     case DW_LANG_lo_user:                  return "LANG_lo_user";
 431     case DW_LANG_hi_user:                  return "LANG_hi_user";
 432   }
 433   assert(0 && "Unknown Dwarf Language");
 434   return "";
 435 }
 436
 437 /// CaseString - Return the string for the specified identifier case.
 438 ///
 439 static const char *CaseString(unsigned Case) {
 440    switch(Case) {
 441     case DW_ID_case_sensitive:             return "ID_case_sensitive";
 442     case DW_ID_up_case:                    return "ID_up_case";
 443     case DW_ID_down_case:                  return "ID_down_case";
 444     case DW_ID_case_insensitive:           return "ID_case_insensitive";
 445   }
 446   assert(0 && "Unknown Dwarf Identifier Case");
 447   return "";
 448 }
 449
 450 /// ConventionString - Return the string for the specified calling convention.
 451 ///
 452 static const char *ConventionString(unsigned Convention) {
 453    switch(Convention) {
 454     case DW_CC_normal:                     return "CC_normal";
 455     case DW_CC_program:                    return "CC_program";
 456     case DW_CC_nocall:                     return "CC_nocall";
 457     case DW_CC_lo_user:                    return "CC_lo_user";
 458     case DW_CC_hi_user:                    return "CC_hi_user";
 459   }
 460   assert(0 && "Unknown Dwarf Calling Convention");
 461   return "";
 462 }
 463
 464 /// InlineCodeString - Return the string for the specified inline code.
 465 ///
 466 static const char *InlineCodeString(unsigned Code) {
 467    switch(Code) {
 468     case DW_INL_not_inlined:               return "INL_not_inlined";
 469     case DW_INL_inlined:                   return "INL_inlined";
 470     case DW_INL_declared_not_inlined:      return "INL_declared_not_inlined";
 471     case DW_INL_declared_inlined:          return "INL_declared_inlined";
 472   }
 473   assert(0 && "Unknown Dwarf Inline Code");
 474   return "";
 475 }
 476
 477 /// ArrayOrderString - Return the string for the specified array order.
 478 ///
 479 static const char *ArrayOrderString(unsigned Order) {
 480    switch(Order) {
 481     case DW_ORD_row_major:                 return "ORD_row_major";
 482     case DW_ORD_col_major:                 return "ORD_col_major";
 483   }
 484   assert(0 && "Unknown Dwarf Array Order");
 485   return "";
 486 }
 487
 488 /// DiscriminantString - Return the string for the specified discriminant
 489 /// descriptor.
 490 static const char *DiscriminantString(unsigned Discriminant) {
 491    switch(Discriminant) {
 492     case DW_DSC_label:                     return "DSC_label";
 493     case DW_DSC_range:                     return "DSC_range";
 494   }
 495   assert(0 && "Unknown Dwarf Discriminant Descriptor");
 496   return "";
 497 }
 498
 499 /// LNStandardString - Return the string for the specified line number standard.
 500 ///
 501 static const char *LNStandardString(unsigned Standard) {
 502    switch(Standard) {
 503     case DW_LNS_copy:                      return "LNS_copy";
 504     case DW_LNS_advance_pc:                return "LNS_advance_pc";
 505     case DW_LNS_advance_line:              return "LNS_advance_line";
 506     case DW_LNS_set_file:                  return "LNS_set_file";
 507     case DW_LNS_set_column:                return "LNS_set_column";
 508     case DW_LNS_negate_stmt:               return "LNS_negate_stmt";
 509     case DW_LNS_set_basic_block:           return "LNS_set_basic_block";
 510     case DW_LNS_const_add_pc:              return "LNS_const_add_pc";
 511     case DW_LNS_fixed_advance_pc:          return "LNS_fixed_advance_pc";
 512     case DW_LNS_set_prologue_end:          return "LNS_set_prologue_end";
 513     case DW_LNS_set_epilogue_begin:        return "LNS_set_epilogue_begin";
 514     case DW_LNS_set_isa:                   return "LNS_set_isa";
 515   }
 516   assert(0 && "Unknown Dwarf Line Number Standard");
 517   return "";
 518 }
 519
 520 /// LNExtendedString - Return the string for the specified line number extended
 521 /// opcode encodings.
 522 static const char *LNExtendedString(unsigned Encoding) {
 523    switch(Encoding) {
 524     // Line Number Extended Opcode Encodings
 525     case DW_LNE_end_sequence:              return "LNE_end_sequence";
 526     case DW_LNE_set_address:               return "LNE_set_address";
 527     case DW_LNE_define_file:               return "LNE_define_file";
 528     case DW_LNE_lo_user:                   return "LNE_lo_user";
 529     case DW_LNE_hi_user:                   return "LNE_hi_user";
 530   }
 531   assert(0 && "Unknown Dwarf Line Number Extended Opcode Encoding");
 532   return "";
 533 }
 534
 535 /// MacinfoString - Return the string for the specified macinfo type encodings.
 536 ///
 537 static const char *MacinfoString(unsigned Encoding) {
 538    switch(Encoding) {
 539     // Macinfo Type Encodings
 540     case DW_MACINFO_define:                return "MACINFO_define";
 541     case DW_MACINFO_undef:                 return "MACINFO_undef";
 542     case DW_MACINFO_start_file:            return "MACINFO_start_file";
 543     case DW_MACINFO_end_file:              return "MACINFO_end_file";
 544     case DW_MACINFO_vendor_ext:            return "MACINFO_vendor_ext";
 545   }
 546   assert(0 && "Unknown Dwarf Macinfo Type Encodings");
 547   return "";
 548 }
 549
 550 /// CallFrameString - Return the string for the specified call frame instruction
 551 /// encodings.
 552 static const char *CallFrameString(unsigned Encoding) {
 553    switch(Encoding) {
 554     case DW_CFA_advance_loc:               return "CFA_advance_loc";
 555     case DW_CFA_offset:                    return "CFA_offset";
 556     case DW_CFA_restore:                   return "CFA_restore";
 557     case DW_CFA_set_loc:                   return "CFA_set_loc";
 558     case DW_CFA_advance_loc1:              return "CFA_advance_loc1";
 559     case DW_CFA_advance_loc2:              return "CFA_advance_loc2";
 560     case DW_CFA_advance_loc4:              return "CFA_advance_loc4";
 561     case DW_CFA_offset_extended:           return "CFA_offset_extended";
 562     case DW_CFA_restore_extended:          return "CFA_restore_extended";
 563     case DW_CFA_undefined:                 return "CFA_undefined";
 564     case DW_CFA_same_value:                return "CFA_same_value";
 565     case DW_CFA_register:                  return "CFA_register";
 566     case DW_CFA_remember_state:            return "CFA_remember_state";
 567     case DW_CFA_restore_state:             return "CFA_restore_state";
 568     case DW_CFA_def_cfa:                   return "CFA_def_cfa";
 569     case DW_CFA_def_cfa_register:          return "CFA_def_cfa_register";
 570     case DW_CFA_def_cfa_offset:            return "CFA_def_cfa_offset";
 571     case DW_CFA_def_cfa_expression:        return "CFA_def_cfa_expression";
 572     case DW_CFA_expression:                return "CFA_expression";
 573     case DW_CFA_offset_extended_sf:        return "CFA_offset_extended_sf";
 574     case DW_CFA_def_cfa_sf:                return "CFA_def_cfa_sf";
 575     case DW_CFA_def_cfa_offset_sf:         return "CFA_def_cfa_offset_sf";
 576     case DW_CFA_val_offset:                return "CFA_val_offset";
 577     case DW_CFA_val_offset_sf:             return "CFA_val_offset_sf";
 578     case DW_CFA_val_expression:            return "CFA_val_expression";
 579     case DW_CFA_lo_user:                   return "CFA_lo_user";
 580     case DW_CFA_hi_user:                   return "CFA_hi_user";
 581   }
 582   assert(0 && "Unknown Dwarf Call Frame Instruction Encodings");
 583   return "";
 584 }
 585
 586 //===----------------------------------------------------------------------===//
 587
 588 /// operator== - Used by UniqueVector to locate entry.
 589 ///
 590 bool DIEAbbrev::operator==(const DIEAbbrev &DA) const {
 591   if (Tag != DA.Tag) return false;
 592   if (ChildrenFlag != DA.ChildrenFlag) return false;
 593   if (Data.size() != DA.Data.size()) return false;
 594
 595   for (unsigned i = 0, N = Data.size(); i < N; ++i) {
 596     if (Data[i] != DA.Data[i]) return false;
 597   }
 598
 599   return true;
 600 }
 601
 602 /// operator< - Used by UniqueVector to locate entry.
 603 ///
 604 bool DIEAbbrev::operator<(const DIEAbbrev &DA) const {
 605   if (Tag != DA.Tag) return Tag < DA.Tag;
 606   if (ChildrenFlag != DA.ChildrenFlag) return ChildrenFlag < DA.ChildrenFlag;
 607   if (Data.size() != DA.Data.size()) return Data.size() < DA.Data.size();
 608
 609   for (unsigned i = 0, N = Data.size(); i < N; ++i) {
 610     if (Data[i] != DA.Data[i]) return Data[i] < DA.Data[i];
 611   }
 612
 613   return false;
 614 }
 615
 616 /// Emit - Print the abbreviation using the specified Dwarf writer.
 617 ///
 618 void DIEAbbrev::Emit(const DwarfWriter &DW) const {
 619   // Emit its Dwarf tag type.
 620   DW.EmitULEB128Bytes(Tag);
 621   DW.EOL(TagString(Tag));
 622
 623   // Emit whether it has children DIEs.
 624   DW.EmitULEB128Bytes(ChildrenFlag);
 625   DW.EOL(ChildrenString(ChildrenFlag));
 626
 627   // For each attribute description.
 628   for (unsigned i = 0, N = Data.size(); i < N; ++i) {
 629     const DIEAbbrevData &AttrData = Data[i];
 630
 631     // Emit attribute type.
 632     DW.EmitULEB128Bytes(AttrData.getAttribute());
 633     DW.EOL(AttributeString(AttrData.getAttribute()));
 634
 635     // Emit form type.
 636     DW.EmitULEB128Bytes(AttrData.getForm());
 637     DW.EOL(FormEncodingString(AttrData.getForm()));
 638   }
 639
 640   // Mark end of abbreviation.
 641   DW.EmitULEB128Bytes(0); DW.EOL("EOM(1)");
 642   DW.EmitULEB128Bytes(0); DW.EOL("EOM(2)");
 643 }
 644
 645 #ifndef NDEBUG
 646   void DIEAbbrev::print(std::ostream &O) {
 647     O << "Abbreviation @"
 648       << std::hex << (unsigned long)this << std::dec
 649       << "  "
 650       << TagString(Tag)
 651       << " "
 652       << ChildrenString(ChildrenFlag)
 653       << "\n";
 654
 655     for (unsigned i = 0, N = Data.size(); i < N; ++i) {
 656       O << "  "
 657         << AttributeString(Data[i].getAttribute())
 658         << "  "
 659         << FormEncodingString(Data[i].getForm())
 660         << "\n";
 661     }
 662   }
 663   void DIEAbbrev::dump() { print(std::cerr); }
 664 #endif
 665
 666 //===----------------------------------------------------------------------===//
 667
 668 /// EmitValue - Emit integer of appropriate size.
 669 ///
 670 void DIEInteger::EmitValue(const DwarfWriter &DW, unsigned Form) const {
 671   switch (Form) {
 672   case DW_FORM_flag:  // Fall thru
 673   case DW_FORM_data1: DW.EmitByte(Integer);         break;
 674   case DW_FORM_data2: DW.EmitShort(Integer);        break;
 675   case DW_FORM_data4: DW.EmitLong(Integer);         break;
 676   case DW_FORM_udata: DW.EmitULEB128Bytes(Integer); break;
 677   case DW_FORM_sdata: DW.EmitSLEB128Bytes(Integer); break;
 678   default: assert(0 && "DIE Value form not supported yet"); break;
 679   }
 680 }
 681
 682 /// SizeOf - Determine size of integer value in bytes.
 683 ///
 684 unsigned DIEInteger::SizeOf(const DwarfWriter &DW, unsigned Form) const {
 685   switch (Form) {
 686   case DW_FORM_flag:  // Fall thru
 687   case DW_FORM_data1: return sizeof(int8_t);
 688   case DW_FORM_data2: return sizeof(int16_t);
 689   case DW_FORM_data4: return sizeof(int32_t);
 690   case DW_FORM_udata: return DW.SizeULEB128(Integer);
 691   case DW_FORM_sdata: return DW.SizeSLEB128(Integer);
 692   default: assert(0 && "DIE Value form not supported yet"); break;
 693   }
 694   return 0;
 695 }
 696
 697 //===----------------------------------------------------------------------===//
 698
 699 /// EmitValue - Emit string value.
 700 ///
 701 void DIEString::EmitValue(const DwarfWriter &DW, unsigned Form) const {
 702   DW.EmitString(String);
 703 }
 704
 705 /// SizeOf - Determine size of string value in bytes.
 706 ///
 707 unsigned DIEString::SizeOf(const DwarfWriter &DW, unsigned Form) const {
 708   return String.size() + sizeof(char); // sizeof('\0');
 709 }
 710
 711 //===----------------------------------------------------------------------===//
 712
 713 /// EmitValue - Emit label value.
 714 ///
 715 void DIEDwarfLabel::EmitValue(const DwarfWriter &DW, unsigned Form) const {
 716   DW.EmitReference(Label);
 717 }
 718
 719 /// SizeOf - Determine size of label value in bytes.
 720 ///
 721 unsigned DIEDwarfLabel::SizeOf(const DwarfWriter &DW, unsigned Form) const {
 722   return DW.getAddressSize();
 723 }
 724
 725 //===----------------------------------------------------------------------===//
 726
 727 /// EmitValue - Emit label value.
 728 ///
 729 void DIEObjectLabel::EmitValue(const DwarfWriter &DW, unsigned Form) const {
 730   DW.EmitByte(sizeof(int8_t) + DW.getAddressSize());
 731   DW.EOL("DW_FORM_block1 length");
 732
 733   DW.EmitByte(DW_OP_addr);
 734   DW.EOL("DW_OP_addr");
 735
 736   DW.EmitReference(Label);
 737 }
 738
 739 /// SizeOf - Determine size of label value in bytes.
 740 ///
 741 unsigned DIEObjectLabel::SizeOf(const DwarfWriter &DW, unsigned Form) const {
 742   return sizeof(int8_t) + sizeof(int8_t) + DW.getAddressSize();
 743 }
 744
 745 //===----------------------------------------------------------------------===//
 746
 747 /// EmitValue - Emit delta value.
 748 ///
 749 void DIEDelta::EmitValue(const DwarfWriter &DW, unsigned Form) const {
 750   DW.EmitDifference(LabelHi, LabelLo);
 751 }
 752
 753 /// SizeOf - Determine size of delta value in bytes.
 754 ///
 755 unsigned DIEDelta::SizeOf(const DwarfWriter &DW, unsigned Form) const {
 756   return DW.getAddressSize();
 757 }
 758
 759 //===----------------------------------------------------------------------===//
 760 /// EmitValue - Emit extry offset.
 761 ///
 762 void DIEntry::EmitValue(const DwarfWriter &DW, unsigned Form) const {
 763   DW.EmitLong(Entry->getOffset());
 764 }
 765
 766 /// SizeOf - Determine size of label value in bytes.
 767 ///
 768 unsigned DIEntry::SizeOf(const DwarfWriter &DW, unsigned Form) const {
 769   return sizeof(int32_t);
 770 }
 771
 772 //===----------------------------------------------------------------------===//
 773
 774 DIE::DIE(unsigned Tag, unsigned ChildrenFlag)
 775 : Abbrev(new DIEAbbrev(Tag, ChildrenFlag))
 776 , AbbrevID(0)
 777 , Offset(0)
 778 , Size(0)
 779 , Context(NULL)
 780 , Children()
 781 , Values()
 782 {}
 783
 784 DIE::~DIE() {
 785   if (Abbrev) delete Abbrev;
 786
 787   for (unsigned i = 0, N = Children.size(); i < N; ++i) {
 788     delete Children[i];
 789   }
 790
 791   for (unsigned j = 0, M = Values.size(); j < M; ++j) {
 792     delete Values[j];
 793   }
 794
 795   if (Context) delete Context;
 796 }
 797
 798 /// AddInt - Add a simple integer attribute data and value.
 799 ///
 800 void DIE::AddInt(unsigned Attribute, unsigned Form,
 801                  int Integer, bool IsSigned) {
 802   if (Form == 0) {
 803     if (IsSigned) {
 804       if ((char)Integer == Integer)       Form = DW_FORM_data1;
 805       else if ((short)Integer == Integer) Form = DW_FORM_data2;
 806       else                                Form = DW_FORM_data4;
 807     } else {
 808       if ((unsigned char)Integer == Integer)       Form = DW_FORM_data1;
 809       else if ((unsigned short)Integer == Integer) Form = DW_FORM_data2;
 810       else                                         Form = DW_FORM_data4;
 811     }
 812   }
 813   Abbrev->AddAttribute(Attribute, Form);
 814   Values.push_back(new DIEInteger(Integer));
 815 }
 816
 817 /// AddString - Add a std::string attribute data and value.
 818 ///
 819 void DIE::AddString(unsigned Attribute, unsigned Form,
 820                     const std::string &String) {
 821   Abbrev->AddAttribute(Attribute, Form);
 822   Values.push_back(new DIEString(String));
 823 }
 824
 825 /// AddLabel - Add a Dwarf label attribute data and value.
 826 ///
 827 void DIE::AddLabel(unsigned Attribute, unsigned Form,
 828                    const DWLabel &Label) {
 829   Abbrev->AddAttribute(Attribute, Form);
 830   Values.push_back(new DIEDwarfLabel(Label));
 831 }
 832
 833 /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
 834 ///
 835 void DIE::AddObjectLabel(unsigned Attribute, unsigned Form,
 836                          const std::string &Label) {
 837   Abbrev->AddAttribute(Attribute, Form);
 838   Values.push_back(new DIEObjectLabel(Label));
 839 }
 840
 841 /// AddDelta - Add a label delta attribute data and value.
 842 ///
 843 void DIE::AddDelta(unsigned Attribute, unsigned Form,
 844                    const DWLabel &Hi, const DWLabel &Lo) {
 845   Abbrev->AddAttribute(Attribute, Form);
 846   Values.push_back(new DIEDelta(Hi, Lo));
 847 }
 848
 849 /// AddDIEntry - Add a DIE attribute data and value.
 850 ///
 851 void DIE::AddDIEntry(unsigned Attribute,
 852                      unsigned Form, DIE *Entry) {
 853   Abbrev->AddAttribute(Attribute, Form);
 854   Values.push_back(new DIEntry(Entry));
 855 }
 856
 857 /// Complete - Indicate that all attributes have been added and ready to get an
 858 /// abbreviation ID.
 859 void DIE::Complete(DwarfWriter &DW) {
 860   AbbrevID = DW.NewAbbreviation(Abbrev);
 861   delete Abbrev;
 862   Abbrev = NULL;
 863 }
 864
 865 /// AddChild - Add a child to the DIE.
 866 ///
 867 void DIE::AddChild(DIE *Child) {
 868   Children.push_back(Child);
 869 }
 870
 871 //===----------------------------------------------------------------------===//
 872
 873 /// NewBasicType - Creates a new basic type if necessary, then adds to the
 874 /// context and owner.
 875 DIE *DWContext::NewBasicType(const Type *Ty, unsigned Size, unsigned Align) {
 876   DIE *TypeDie = Types[Ty];
 877
 878   // If first occurance of type.
 879   if (!TypeDie) {
 880     const char *Name;
 881     unsigned Encoding = 0;
 882
 883     switch (Ty->getTypeID()) {
 884     case Type::UByteTyID:
 885       Name = "unsigned char";
 886       Encoding = DW_ATE_unsigned_char;
 887       break;
 888     case Type::SByteTyID:
 889       Name = "char";
 890       Encoding = DW_ATE_signed_char;
 891       break;
 892     case Type::UShortTyID:
 893       Name = "unsigned short";
 894       Encoding = DW_ATE_unsigned;
 895       break;
 896     case Type::ShortTyID:
 897       Name = "short";
 898       Encoding = DW_ATE_signed;
 899       break;
 900     case Type::UIntTyID:
 901       Name = "unsigned int";
 902       Encoding = DW_ATE_unsigned;
 903       break;
 904     case Type::IntTyID:
 905       Name = "int";
 906       Encoding = DW_ATE_signed;
 907       break;
 908     case Type::ULongTyID:
 909       Name = "unsigned long long";
 910       Encoding = DW_ATE_unsigned;
 911       break;
 912     case Type::LongTyID:
 913       Name = "long long";
 914       Encoding = DW_ATE_signed;
 915       break;
 916     case Type::FloatTyID:
 917       Name = "float";
 918       Encoding = DW_ATE_float;
 919       break;
 920     case Type::DoubleTyID:
 921       Name = "float";
 922       Encoding = DW_ATE_float;
 923       break;
 924     default:
 925     // FIXME - handle more complex types.
 926       Name = "unknown";
 927       Encoding = DW_ATE_address;
 928       break;
 929     }
 930
 931     // construct the type DIE.
 932     TypeDie = new DIE(DW_TAG_base_type, DW_CHILDREN_no);
 933     TypeDie->AddString(DW_AT_name,      DW_FORM_string, Name);
 934     TypeDie->AddInt   (DW_AT_byte_size, DW_FORM_data1,  Size);
 935     TypeDie->AddInt   (DW_AT_encoding,  DW_FORM_data1,  Encoding);
 936     TypeDie->Complete(DW);
 937
 938     // Add to context owner.
 939     Owner->AddChild(TypeDie);
 940
 941     // Add to map.
 942     Types[Ty] = TypeDie;
 943   }
 944
 945   return TypeDie;
 946 }
 947
 948 /// NewGlobalVariable - Creates a global variable, if necessary, then adds in
 949 /// the context and owner.
 950 DIE *DWContext::NewGlobalVariable(const std::string &Name,
 951                                   const std::string &MangledName,
 952                                   DIE *Type) {
 953   DIE *VariableDie = Variables[MangledName];
 954
 955   // If first occurance of variable.
 956   if (!VariableDie) {
 957     // FIXME - need source file name line number.
 958     VariableDie = new DIE(DW_TAG_variable, DW_CHILDREN_no);
 959     VariableDie->AddString     (DW_AT_name,      DW_FORM_string, Name);
 960     VariableDie->AddInt        (DW_AT_decl_file, 0,              0);
 961     VariableDie->AddInt        (DW_AT_decl_line, 0,              0);
 962     VariableDie->AddDIEntry    (DW_AT_type,      DW_FORM_ref4,   Type);
 963     VariableDie->AddInt        (DW_AT_external,  DW_FORM_flag,   1);
 964     // FIXME - needs to be a proper expression.
 965     VariableDie->AddObjectLabel(DW_AT_location,  DW_FORM_block1, MangledName);
 966     VariableDie->Complete(DW);
 967
 968     // Add to context owner.
 969     Owner->AddChild(VariableDie);
 970
 971     // Add to map.
 972     Variables[MangledName] = VariableDie;
 973   }
 974
 975   return VariableDie;
 976 }
 977
 978 //===----------------------------------------------------------------------===//
 979
 980 /// PrintHex - Print a value as a hexidecimal value.
 981 ///
 982 void DwarfWriter::PrintHex(int Value) const {
 983   O << "0x" << std::hex << Value << std::dec;
 984 }
 985
 986 /// EOL - Print a newline character to asm stream.  If a comment is present
 987 /// then it will be printed first.  Comments should not contain '\n'.
 988 void DwarfWriter::EOL(const std::string &Comment) const {
 989   if (DwarfVerbose) {
 990     O << "\t"
 991       << Asm->CommentString
 992       << " "
 993       << Comment;
 994   }
 995   O << "\n";
 996 }
 997
 998 /// EmitULEB128Bytes - Emit an assembler byte data directive to compose an
 999 /// unsigned leb128 value.
1000 void DwarfWriter::EmitULEB128Bytes(unsigned Value) const {
1001   if (hasLEB128) {
1002     O << "\t.uleb128\t"
1003       << Value;
1004   } else {
1005     O << Asm->Data8bitsDirective;
1006     PrintULEB128(Value);
1007   }
1008 }
1009
1010 /// EmitSLEB128Bytes - Emit an assembler byte data directive to compose a
1011 /// signed leb128 value.
1012 void DwarfWriter::EmitSLEB128Bytes(int Value) const {
1013   if (hasLEB128) {
1014     O << "\t.sleb128\t"
1015       << Value;
1016   } else {
1017     O << Asm->Data8bitsDirective;
1018     PrintSLEB128(Value);
1019   }
1020 }
1021
1022 /// PrintULEB128 - Print a series of hexidecimal values (separated by commas)
1023 /// representing an unsigned leb128 value.
1024 void DwarfWriter::PrintULEB128(unsigned Value) const {
1025   do {
1026     unsigned Byte = Value & 0x7f;
1027     Value >>= 7;
1028     if (Value) Byte |= 0x80;
1029     PrintHex(Byte);
1030     if (Value) O << ", ";
1031   } while (Value);
1032 }
1033
1034 /// SizeULEB128 - Compute the number of bytes required for an unsigned leb128
1035 /// value.
1036 unsigned DwarfWriter::SizeULEB128(unsigned Value) {
1037   unsigned Size = 0;
1038   do {
1039     Value >>= 7;
1040     Size += sizeof(int8_t);
1041   } while (Value);
1042   return Size;
1043 }
1044
1045 /// PrintSLEB128 - Print a series of hexidecimal values (separated by commas)
1046 /// representing a signed leb128 value.
1047 void DwarfWriter::PrintSLEB128(int Value) const {
1048   int Sign = Value >> (8 * sizeof(Value) - 1);
1049   bool IsMore;
1050
1051   do {
1052     unsigned Byte = Value & 0x7f;
1053     Value >>= 7;
1054     IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
1055     if (IsMore) Byte |= 0x80;
1056     PrintHex(Byte);
1057     if (IsMore) O << ", ";
1058   } while (IsMore);
1059 }
1060
1061 /// SizeSLEB128 - Compute the number of bytes required for a signed leb128
1062 /// value.
1063 unsigned DwarfWriter::SizeSLEB128(int Value) {
1064   unsigned Size = 0;
1065   int Sign = Value >> (8 * sizeof(Value) - 1);
1066   bool IsMore;
1067
1068   do {
1069     unsigned Byte = Value & 0x7f;
1070     Value >>= 7;
1071     IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
1072     Size += sizeof(int8_t);
1073   } while (IsMore);
1074   return Size;
1075 }
1076
1077 /// EmitByte - Emit a byte directive and value.
1078 ///
1079 void DwarfWriter::EmitByte(int Value) const {
1080   O << Asm->Data8bitsDirective;
1081   PrintHex(Value);
1082 }
1083
1084 /// EmitShort - Emit a short directive and value.
1085 ///
1086 void DwarfWriter::EmitShort(int Value) const {
1087   O << Asm->Data16bitsDirective;
1088   PrintHex(Value);
1089 }
1090
1091 /// EmitLong - Emit a long directive and value.
1092 ///
1093 void DwarfWriter::EmitLong(int Value) const {
1094   O << Asm->Data32bitsDirective;
1095   PrintHex(Value);
1096 }
1097
1098 /// EmitString - Emit a string with quotes and a null terminator.
1099 /// Special characters are emitted properly. (Eg. '\t')
1100 void DwarfWriter::EmitString(const std::string &String) const {
1101   O << Asm->AsciiDirective
1102     << "\"";
1103   for (unsigned i = 0, N = String.size(); i < N; ++i) {
1104     unsigned char C = String[i];
1105
1106     if (!isascii(C) || iscntrl(C)) {
1107       switch(C) {
1108       case '\b': O << "\\b"; break;
1109       case '\f': O << "\\f"; break;
1110       case '\n': O << "\\n"; break;
1111       case '\r': O << "\\r"; break;
1112       case '\t': O << "\\t"; break;
1113       default:
1114         O << '\\';
1115         O << char('0' + (C >> 6));
1116         O << char('0' + (C >> 3));
1117         O << char('0' + (C >> 0));
1118         break;
1119       }
1120     } else if (C == '\"') {
1121       O << "\\\"";
1122     } else if (C == '\'') {
1123       O << "\\\'";
1124     } else {
1125      O << C;
1126     }
1127   }
1128   O << "\\0\"";
1129 }
1130
1131 /// PrintLabelName - Print label name in form used by Dwarf writer.
1132 ///
1133 void DwarfWriter::PrintLabelName(const char *Tag, unsigned Number) const {
1134   O << Asm->PrivateGlobalPrefix
1135     << "debug_"
1136     << Tag
1137     << Number;
1138 }
1139
1140 /// EmitLabel - Emit location label for internal use by Dwarf.
1141 ///
1142 void DwarfWriter::EmitLabel(const char *Tag, unsigned Number) const {
1143   PrintLabelName(Tag, Number);
1144   O << ":\n";
1145 }
1146
1147 /// EmitReference - Emit a reference to a label.
1148 ///
1149 void DwarfWriter::EmitReference(const char *Tag, unsigned Number) const {
1150   if (AddressSize == 4)
1151     O << Asm->Data32bitsDirective;
1152   else
1153     O << Asm->Data64bitsDirective;
1154
1155   PrintLabelName(Tag, Number);
1156 }
1157 void DwarfWriter::EmitReference(const std::string &Name) const {
1158   if (AddressSize == 4)
1159     O << Asm->Data32bitsDirective;
1160   else
1161     O << Asm->Data64bitsDirective;
1162
1163   O << Name;
1164 }
1165
1166 /// EmitDifference - Emit an label difference as sizeof(pointer) value.  Some
1167 /// assemblers do not accept absolute expressions with data directives, so there
1168 /// is an option (needsSet) to use an intermediary 'set' expression.
1169 void DwarfWriter::EmitDifference(const char *TagHi, unsigned NumberHi,
1170                                  const char *TagLo, unsigned NumberLo) const {
1171   if (needsSet) {
1172     static unsigned SetCounter = 0;
1173
1174     O << "\t.set\t";
1175     PrintLabelName("set", SetCounter);
1176     O << ",";
1177     PrintLabelName(TagHi, NumberHi);
1178     O << "-";
1179     PrintLabelName(TagLo, NumberLo);
1180     O << "\n";
1181
1182     if (AddressSize == sizeof(int32_t))
1183       O << Asm->Data32bitsDirective;
1184     else
1185       O << Asm->Data64bitsDirective;
1186
1187     PrintLabelName("set", SetCounter);
1188
1189     ++SetCounter;
1190   } else {
1191     if (AddressSize == sizeof(int32_t))
1192       O << Asm->Data32bitsDirective;
1193     else
1194       O << Asm->Data64bitsDirective;
1195
1196     PrintLabelName(TagHi, NumberHi);
1197     O << "-";
1198     PrintLabelName(TagLo, NumberLo);
1199   }
1200 }
1201
1202 /// NewAbbreviation - Add the abbreviation to the Abbreviation vector.
1203 ///
1204 unsigned DwarfWriter::NewAbbreviation(DIEAbbrev *Abbrev) {
1205   return Abbreviations.insert(*Abbrev);
1206 }
1207
1208 /// NewString - Add a string to the constant pool and returns a label.
1209 ///
1210 DWLabel DwarfWriter::NewString(const std::string &String) {
1211   unsigned StringID = StringPool.insert(String);
1212   return DWLabel("string", StringID);
1213 }
1214
1215 /// NewGlobalType - Make the type visible globally using the given name.
1216 ///
1217 void DwarfWriter::NewGlobalType(const std::string &Name, DIE *Type) {
1218   assert(!GlobalTypes[Name] && "Duplicate global type");
1219   GlobalTypes[Name] = Type;
1220 }
1221
1222 /// NewGlobalEntity - Make the entity visible globally using the given name.
1223 ///
1224 void DwarfWriter::NewGlobalEntity(const std::string &Name, DIE *Entity) {
1225   assert(!GlobalEntities[Name] && "Duplicate global variable or function");
1226   GlobalEntities[Name] = Entity;
1227 }
1228
1229 /// NewGlobalVariable - Add a new global variable DIE to the context.
1230 ///
1231 void DwarfWriter::NewGlobalVariable(DWContext *Context,
1232                                     const std::string &Name,
1233                                     const std::string &MangledName,
1234                                     const Type *Ty,
1235                                     unsigned Size, unsigned Align) {
1236   // Get the DIE type for the global.
1237   DIE *Type = Context->NewBasicType(Ty, Size, Align);
1238   DIE *Variable = Context->NewGlobalVariable(Name, MangledName, Type);
1239   NewGlobalEntity(Name, Variable);
1240 }
1241
1242 /// NewCompileUnit - Create new compile unit information.
1243 ///
1244 DIE *DwarfWriter::NewCompileUnit(const std::string &Directory,
1245                                  const std::string &SourceName) {
1246   DIE *Unit = new DIE(DW_TAG_compile_unit, DW_CHILDREN_yes);
1247   // FIXME - use the correct line set.
1248   Unit->AddLabel (DW_AT_stmt_list, DW_FORM_data4,  DWLabel("line", 0));
1249   Unit->AddLabel (DW_AT_high_pc,   DW_FORM_addr,   DWLabel("text_end", 0));
1250   Unit->AddLabel (DW_AT_low_pc,    DW_FORM_addr,   DWLabel("text_begin", 0));
1251   // FIXME - The producer needs to be in this form, but should come from
1252   // an appropriate source.
1253   Unit->AddString(DW_AT_producer,  DW_FORM_string,
1254                   "llvm 3.4.x (LLVM Research Group)");
1255   Unit->AddInt   (DW_AT_language,  DW_FORM_data1,  DW_LANG_C89);
1256   Unit->AddString(DW_AT_name,      DW_FORM_string, SourceName);
1257   Unit->AddString(DW_AT_comp_dir,  DW_FORM_string, Directory);
1258   Unit->Complete(*this);
1259
1260   return Unit;
1261 }
1262
1263 /// EmitInitial - Emit initial Dwarf declarations.  This is necessary for cc
1264 /// tools to recognize the object file contains Dwarf information.
1265 ///
1266 void DwarfWriter::EmitInitial() const {
1267   // Dwarf sections base addresses.
1268   Asm->SwitchSection(DwarfAbbrevSection, 0);
1269   EmitLabel("abbrev", 0);
1270   Asm->SwitchSection(DwarfInfoSection, 0);
1271   EmitLabel("info", 0);
1272   Asm->SwitchSection(DwarfLineSection, 0);
1273   EmitLabel("line", 0);
1274
1275   // Standard sections base addresses.
1276   Asm->SwitchSection(TextSection, 0);
1277   EmitLabel("text_begin", 0);
1278   Asm->SwitchSection(DataSection, 0);
1279   EmitLabel("data_begin", 0);
1280 }
1281
1282 /// EmitDIE - Recusively Emits a debug information entry.
1283 ///
1284 void DwarfWriter::EmitDIE(DIE *Die) const {
1285   // Get the abbreviation for this DIE.
1286   unsigned AbbrevID = Die->getAbbrevID();
1287   const DIEAbbrev &Abbrev = Abbreviations[AbbrevID];
1288
1289   // Emit the code (index) for the abbreviation.
1290   EmitULEB128Bytes(AbbrevID);
1291   EOL(std::string("Abbrev [" +
1292       utostr(AbbrevID) +
1293       "] " +
1294       TagString(Abbrev.getTag())) +
1295       " ");
1296
1297   const std::vector<DIEValue *> &Values = Die->getValues();
1298   const std::vector<DIEAbbrevData> &AbbrevData = Abbrev.getData();
1299
1300   // Emit the DIE attribute values.
1301   for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1302     unsigned Attr = AbbrevData[i].getAttribute();
1303     unsigned Form = AbbrevData[i].getForm();
1304     assert(Form && "Too many attributes for DIE (check abbreviation)");
1305
1306     switch (Attr) {
1307     case DW_AT_sibling: {
1308       EmitLong(Die->SiblingOffset());
1309       break;
1310     }
1311     default: {
1312       // Emit an attribute using the defined form.
1313       Values[i]->EmitValue(*this, Form);
1314       break;
1315     }
1316     }
1317
1318     EOL(AttributeString(Attr));
1319   }
1320
1321   // Emit the DIE children if any.
1322   if (Abbrev.getChildrenFlag() == DW_CHILDREN_yes) {
1323     const std::vector<DIE *> &Children = Die->getChildren();
1324
1325     for (unsigned j = 0, M = Children.size(); j < M; ++j) {
1326       // FIXME - handle sibling offsets.
1327       // FIXME - handle all DIE types.
1328       EmitDIE(Children[j]);
1329     }
1330
1331     EmitByte(0); EOL("End Of Children Mark");
1332   }
1333 }
1334
1335 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
1336 ///
1337 unsigned DwarfWriter::SizeAndOffsetDie(DIE *Die, unsigned Offset) const {
1338   // Get the abbreviation for this DIE.
1339   unsigned AbbrevID = Die->getAbbrevID();
1340   const DIEAbbrev &Abbrev = Abbreviations[AbbrevID];
1341
1342   // Set DIE offset
1343   Die->setOffset(Offset);
1344
1345   // Start the size with the size of abbreviation code.
1346   Offset += SizeULEB128(AbbrevID);
1347
1348   const std::vector<DIEValue *> &Values = Die->getValues();
1349   const std::vector<DIEAbbrevData> &AbbrevData = Abbrev.getData();
1350
1351   // Emit the DIE attribute values.
1352   for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1353     // Size attribute value.
1354     Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
1355   }
1356
1357   // Emit the DIE children if any.
1358   if (Abbrev.getChildrenFlag() == DW_CHILDREN_yes) {
1359     const std::vector<DIE *> &Children = Die->getChildren();
1360
1361     for (unsigned j = 0, M = Children.size(); j < M; ++j) {
1362       // FIXME - handle sibling offsets.
1363       // FIXME - handle all DIE types.
1364       Offset = SizeAndOffsetDie(Children[j], Offset);
1365     }
1366
1367     // End of children marker.
1368     Offset += sizeof(int8_t);
1369   }
1370
1371   Die->setSize(Offset - Die->getOffset());
1372   return Offset;
1373 }
1374
1375 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
1376 ///
1377 void DwarfWriter::SizeAndOffsets() {
1378   // Compute size of debug unit header
1379   unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
1380                     sizeof(int16_t) + // DWARF version number
1381                     sizeof(int32_t) + // Offset Into Abbrev. Section
1382                     sizeof(int8_t);   // Pointer Size (in bytes)
1383
1384   // Process each compile unit.
1385   for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) {
1386     Offset = SizeAndOffsetDie(CompileUnits[i], Offset);
1387   }
1388 }
1389
1390 /// EmitDebugInfo - Emit the debug info section.
1391 ///
1392 void DwarfWriter::EmitDebugInfo() const {
1393   // Start debug info section.
1394   Asm->SwitchSection(DwarfInfoSection, 0);
1395
1396   // Get the number of compile units.
1397   unsigned N = CompileUnits.size();
1398
1399   // If there are any compile units.
1400   if (N) {
1401     EmitLabel("info_begin", 0);
1402
1403     // Emit the compile units header.
1404
1405     // Emit size of content not including length itself
1406     unsigned ContentSize = CompileUnits[N - 1]->SiblingOffset();
1407     EmitLong(ContentSize - sizeof(int32_t));
1408     EOL("Length of Compilation Unit Info");
1409
1410     EmitShort(DWARF_VERSION); EOL("DWARF version number");
1411
1412     EmitReference("abbrev_begin", 0); EOL("Offset Into Abbrev. Section");
1413
1414     EmitByte(AddressSize); EOL("Address Size (in bytes)");
1415
1416     // Process each compile unit.
1417     for (unsigned i = 0; i < N; ++i) {
1418       EmitDIE(CompileUnits[i]);
1419     }
1420
1421     EmitLabel("info_end", 0);
1422   }
1423 }
1424
1425 /// EmitAbbreviations - Emit the abbreviation section.
1426 ///
1427 void DwarfWriter::EmitAbbreviations() const {
1428   // Check to see if it is worth the effort.
1429   if (!Abbreviations.empty()) {
1430     // Start the debug abbrev section.
1431     Asm->SwitchSection(DwarfAbbrevSection, 0);
1432
1433     EmitLabel("abbrev_begin", 0);
1434
1435     // For each abbrevation.
1436     for (unsigned AbbrevID = 1, NAID = Abbreviations.size();
1437                   AbbrevID <= NAID; ++AbbrevID) {
1438       // Get abbreviation data
1439       const DIEAbbrev &Abbrev = Abbreviations[AbbrevID];
1440
1441       // Emit the abbrevations code (base 1 index.)
1442       EmitULEB128Bytes(AbbrevID); EOL("Abbreviation Code");
1443
1444       // Emit the abbreviations data.
1445       Abbrev.Emit(*this);
1446     }
1447
1448     EmitLabel("abbrev_end", 0);
1449   }
1450 }
1451
1452 /// EmitDebugLines - Emit source line information.
1453 ///
1454 void DwarfWriter::EmitDebugLines() const {
1455   // Minimum line delta, thus ranging from -10..(255-10).
1456   const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
1457   // Maximum line delta, thus ranging from -10..(255-10).
1458   const int MaxLineDelta = 255 + MinLineDelta;
1459
1460   // Start the dwarf line section.
1461   Asm->SwitchSection(DwarfLineSection, 0);
1462
1463   // Construct the section header.
1464
1465   EmitDifference("line_end", 0, "line_begin", 0);
1466   EOL("Length of Source Line Info");
1467   EmitLabel("line_begin", 0);
1468
1469   EmitShort(DWARF_VERSION); EOL("DWARF version number");
1470
1471   EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0);
1472   EOL("Prolog Length");
1473   EmitLabel("line_prolog_begin", 0);
1474
1475   EmitByte(1); EOL("Minimum Instruction Length");
1476
1477   EmitByte(1); EOL("Default is_stmt_start flag");
1478
1479   EmitByte(MinLineDelta);  EOL("Line Base Value (Special Opcodes)");
1480
1481   EmitByte(MaxLineDelta); EOL("Line Range Value (Special Opcodes)");
1482
1483   EmitByte(-MinLineDelta); EOL("Special Opcode Base");
1484
1485   // Line number standard opcode encodings argument count
1486   EmitByte(0); EOL("DW_LNS_copy arg count");
1487   EmitByte(1); EOL("DW_LNS_advance_pc arg count");
1488   EmitByte(1); EOL("DW_LNS_advance_line arg count");
1489   EmitByte(1); EOL("DW_LNS_set_file arg count");
1490   EmitByte(1); EOL("DW_LNS_set_column arg count");
1491   EmitByte(0); EOL("DW_LNS_negate_stmt arg count");
1492   EmitByte(0); EOL("DW_LNS_set_basic_block arg count");
1493   EmitByte(0); EOL("DW_LNS_const_add_pc arg count");
1494   EmitByte(1); EOL("DW_LNS_fixed_advance_pc arg count");
1495
1496   const UniqueVector<std::string> &Directories = DebugInfo->getDirectories();
1497   const UniqueVector<SourceFileInfo> &SourceFiles = DebugInfo->getSourceFiles();
1498
1499   // Emit directories.
1500   for (unsigned DirectoryID = 1, NDID = Directories.size();
1501                 DirectoryID <= NDID; ++DirectoryID) {
1502     EmitString(Directories[DirectoryID]); EOL("Directory");
1503   }
1504   EmitByte(0); EOL("End of directories");
1505
1506   // Emit files.
1507   for (unsigned SourceID = 1, NSID = SourceFiles.size();
1508                SourceID <= NSID; ++SourceID) {
1509     const SourceFileInfo &SourceFile = SourceFiles[SourceID];
1510     EmitString(SourceFile.getName()); EOL("Source");
1511     EmitULEB128Bytes(SourceFile.getDirectoryID());  EOL("Directory #");
1512     EmitULEB128Bytes(0);  EOL("Mod date");
1513     EmitULEB128Bytes(0);  EOL("File size");
1514   }
1515   EmitByte(0); EOL("End of files");
1516
1517   EmitLabel("line_prolog_end", 0);
1518
1519   // Emit line information
1520   const std::vector<SourceLineInfo *> &LineInfos = DebugInfo->getSourceLines();
1521
1522   // Dwarf assumes we start with first line of first source file.
1523   unsigned Source = 1;
1524   unsigned Line = 1;
1525
1526   // Construct rows of the address, source, line, column matrix.
1527   for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
1528     SourceLineInfo *LineInfo = LineInfos[i];
1529
1530     // Define the line address.
1531     EmitByte(0); EOL("Extended Op");
1532     EmitByte(4 + 1); EOL("Op size");
1533     EmitByte(DW_LNE_set_address); EOL("DW_LNE_set_address");
1534     EmitReference("loc", i + 1); EOL("Location label");
1535
1536     // If change of source, then switch to the new source.
1537     if (Source != LineInfo->getSourceID()) {
1538       Source = LineInfo->getSourceID();
1539       EmitByte(DW_LNS_set_file); EOL("DW_LNS_set_file");
1540       EmitULEB128Bytes(0); EOL("New Source");
1541     }
1542
1543     // If change of line.
1544     if (Line != LineInfo->getLine()) {
1545       // Determine offset.
1546       int Offset = LineInfo->getLine() - Line;
1547       int Delta = Offset - MinLineDelta;
1548
1549       // Update line.
1550       Line = LineInfo->getLine();
1551
1552       // If delta is small enough and in range...
1553       if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
1554         // ... then use fast opcode.
1555         EmitByte(Delta - MinLineDelta); EOL("Line Delta");
1556       } else {
1557         // ... otherwise use long hand.
1558         EmitByte(DW_LNS_advance_line); EOL("DW_LNS_advance_line");
1559         EmitSLEB128Bytes(Offset); EOL("Line Offset");
1560         EmitByte(DW_LNS_copy); EOL("DW_LNS_copy");
1561       }
1562     } else {
1563       // Copy the previous row (different address or source)
1564       EmitByte(DW_LNS_copy); EOL("DW_LNS_copy");
1565     }
1566   }
1567
1568   // Mark end of matrix.
1569   EmitByte(0); EOL("DW_LNE_end_sequence");
1570   EmitULEB128Bytes(1);  O << "\n";
1571   EmitByte(1); O << "\n";
1572
1573   EmitLabel("line_end", 0);
1574 }
1575
1576 /// EmitDebugFrame - Emit visible names into a debug frame section.
1577 ///
1578 void DwarfWriter::EmitDebugFrame() {
1579   // FIXME - Should be per frame
1580 }
1581
1582 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
1583 ///
1584 void DwarfWriter::EmitDebugPubNames() {
1585   // Check to see if it is worth the effort.
1586   if (!GlobalEntities.empty()) {
1587     // Start the dwarf pubnames section.
1588     Asm->SwitchSection(DwarfPubNamesSection, 0);
1589
1590     EmitDifference("pubnames_end", 0, "pubnames_begin", 0);
1591     EOL("Length of Public Names Info");
1592
1593     EmitLabel("pubnames_begin", 0);
1594
1595     EmitShort(DWARF_VERSION); EOL("DWARF Version");
1596
1597     EmitReference("info_begin", 0); EOL("Offset of Compilation Unit Info");
1598
1599     EmitDifference("info_end", 0, "info_begin", 0);
1600     EOL("Compilation Unit Length");
1601
1602     for (std::map<std::string, DIE *>::iterator GI = GlobalEntities.begin(),
1603                                                 GE = GlobalEntities.end();
1604          GI != GE; ++GI) {
1605       const std::string &Name = GI->first;
1606       DIE * Entity = GI->second;
1607
1608       EmitLong(Entity->getOffset()); EOL("DIE offset");
1609       EmitString(Name); EOL("External Name");
1610
1611     }
1612
1613     EmitLong(0); EOL("End Mark");
1614     EmitLabel("pubnames_end", 0);
1615   }
1616 }
1617
1618 /// EmitDebugPubTypes - Emit visible names into a debug pubtypes section.
1619 ///
1620 void DwarfWriter::EmitDebugPubTypes() {
1621   // Check to see if it is worth the effort.
1622   if (!GlobalTypes.empty()) {
1623     // Start the dwarf pubtypes section.
1624     Asm->SwitchSection(DwarfPubTypesSection, 0);
1625   }
1626 }
1627
1628 /// EmitDebugStr - Emit visible names into a debug str section.
1629 ///
1630 void DwarfWriter::EmitDebugStr() {
1631   // Check to see if it is worth the effort.
1632   if (!StringPool.empty()) {
1633     // Start the dwarf str section.
1634     Asm->SwitchSection(DwarfStrSection, 0);
1635
1636     // For each of strings in teh string pool.
1637     for (unsigned StringID = 1, N = StringPool.size();
1638          StringID <= N; ++StringID) {
1639       // Emit a label for reference from debug information entries.
1640       EmitLabel("string", StringID);
1641       // Emit the string itself.
1642       const std::string &String = StringPool[StringID];
1643       EmitString(String); O << "\n";
1644     }
1645   }
1646 }
1647
1648 /// EmitDebugLoc - Emit visible names into a debug loc section.
1649 ///
1650 void DwarfWriter::EmitDebugLoc() {
1651   // Start the dwarf loc section.
1652   Asm->SwitchSection(DwarfLocSection, 0);
1653 }
1654
1655 /// EmitDebugARanges - Emit visible names into a debug aranges section.
1656 ///
1657 void DwarfWriter::EmitDebugARanges() {
1658   // Start the dwarf aranges section.
1659   Asm->SwitchSection(DwarfARangesSection, 0);
1660
1661   // FIXME - Mock up
1662
1663   // Don't include size of length
1664   EmitLong(0x1c); EOL("Length of Address Ranges Info");
1665
1666   EmitShort(DWARF_VERSION); EOL("Dwarf Version");
1667
1668   EmitReference("info_begin", 0); EOL("Offset of Compilation Unit Info");
1669
1670   EmitByte(AddressSize); EOL("Size of Address");
1671
1672   EmitByte(0); EOL("Size of Segment Descriptor");
1673
1674   EmitShort(0);  EOL("Pad (1)");
1675   EmitShort(0);  EOL("Pad (2)");
1676
1677   // Range 1
1678   EmitReference("text_begin", 0); EOL("Address");
1679   EmitDifference("text_end", 0, "text_begin", 0); EOL("Length");
1680
1681   EmitLong(0); EOL("EOM (1)");
1682   EmitLong(0); EOL("EOM (2)");
1683 }
1684
1685 /// EmitDebugRanges - Emit visible names into a debug ranges section.
1686 ///
1687 void DwarfWriter::EmitDebugRanges() {
1688   // Start the dwarf ranges section.
1689   Asm->SwitchSection(DwarfRangesSection, 0);
1690 }
1691
1692 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
1693 ///
1694 void DwarfWriter::EmitDebugMacInfo() {
1695   // Start the dwarf macinfo section.
1696   Asm->SwitchSection(DwarfMacInfoSection, 0);
1697 }
1698
1699 /// ConstructCompileUnitDIEs - Create a compile unit DIE for each source and
1700 /// header file.
1701 void DwarfWriter::ConstructCompileUnitDIEs() {
1702   // Get directory and source information.
1703   const UniqueVector<std::string> &Directories = DebugInfo->getDirectories();
1704   const UniqueVector<SourceFileInfo> &SourceFiles = DebugInfo->getSourceFiles();
1705
1706   // Construct compile unit DIEs for each source.
1707   for (unsigned SourceID = 1, NSID = SourceFiles.size();
1708                 SourceID <=  NSID; ++SourceID) {
1709     const SourceFileInfo &SourceFile = SourceFiles[SourceID];
1710     const std::string &Directory = Directories[SourceFile.getDirectoryID()];
1711     const std::string &SourceName = SourceFile.getName();
1712     DIE *Unit = NewCompileUnit(Directory, SourceName);
1713     DWContext *Context = new DWContext(*this, NULL, Unit);
1714     CompileUnits.push_back(Unit);
1715   }
1716 }
1717
1718 /// ConstructGlobalDIEs - Create DIEs for each of the externally visible global
1719 /// variables.
1720 void DwarfWriter::ConstructGlobalDIEs(Module &M) {
1721   const TargetData &TD = Asm->TM.getTargetData();
1722
1723   // Iterate throu each of the globals.
1724   for (Module::const_global_iterator GI = M.global_begin(), GE = M.global_end();
1725        GI != GE; ++GI) {
1726     if (!GI->hasInitializer()) continue;   // External global require no code
1727
1728     // Check to see if this is a special global used by LLVM, if so, emit it.
1729     if (GI->hasAppendingLinkage() && (GI->getName() == "llvm.global_ctors" ||
1730                                       GI->getName() == "llvm.global_dtors"))
1731       continue;
1732
1733     std::string Name = Asm->Mang->getValueName(GI);
1734     Constant *C = GI->getInitializer();
1735     const Type *Ty = C->getType();
1736     unsigned Size = TD.getTypeSize(Ty);
1737     unsigned Align = TD.getTypeAlignmentShift(Ty);
1738
1739     if (C->isNullValue() && /* FIXME: Verify correct */
1740         (GI->hasInternalLinkage() || GI->hasWeakLinkage() ||
1741          GI->hasLinkOnceLinkage())) {
1742       if (Size == 0) Size = 1;   // .comm Foo, 0 is undefined, avoid it.
1743
1744     }
1745
1746     /// FIXME - Get correct compile unit context.
1747     assert(CompileUnits.size() && "No compile units");
1748     DWContext *Context = CompileUnits[0]->getContext();
1749
1750     /// Create new global.
1751     NewGlobalVariable(Context, GI->getName(), Name, Ty, Size, Align);
1752   }
1753 }
1754
1755
1756 /// ShouldEmitDwarf - Determine if Dwarf declarations should be made.
1757 ///
1758 bool DwarfWriter::ShouldEmitDwarf() {
1759   // Check if debug info is present.
1760   if (!DebugInfo || !DebugInfo->hasInfo()) return false;
1761
1762   // Make sure initial declarations are made.
1763   if (!didInitial) {
1764     EmitInitial();
1765     didInitial = true;
1766   }
1767
1768   // Okay to emit.
1769   return true;
1770 }
1771
1772 //===----------------------------------------------------------------------===//
1773 // Main entry points.
1774 //
1775
1776 DwarfWriter::DwarfWriter(std::ostream &OS, AsmPrinter *A)
1777 : O(OS)
1778 , Asm(A)
1779 , DebugInfo(NULL)
1780 , didInitial(false)
1781 , CompileUnits()
1782 , Abbreviations()
1783 , GlobalTypes()
1784 , GlobalEntities()
1785 , StringPool()
1786 , AddressSize(sizeof(int32_t))
1787 , hasLEB128(false)
1788 , hasDotLoc(false)
1789 , hasDotFile(false)
1790 , needsSet(false)
1791 , DwarfAbbrevSection(".debug_abbrev")
1792 , DwarfInfoSection(".debug_info")
1793 , DwarfLineSection(".debug_line")
1794 , DwarfFrameSection(".debug_frame")
1795 , DwarfPubNamesSection(".debug_pubnames")
1796 , DwarfPubTypesSection(".debug_pubtypes")
1797 , DwarfStrSection(".debug_str")
1798 , DwarfLocSection(".debug_loc")
1799 , DwarfARangesSection(".debug_aranges")
1800 , DwarfRangesSection(".debug_ranges")
1801 , DwarfMacInfoSection(".debug_macinfo")
1802 , TextSection(".text")
1803 , DataSection(".data")
1804 {}
1805 DwarfWriter::~DwarfWriter() {
1806   for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) {
1807     delete CompileUnits[i];
1808   }
1809 }
1810
1811 /// BeginModule - Emit all Dwarf sections that should come prior to the content.
1812 ///
1813 void DwarfWriter::BeginModule(Module &M) {
1814   if (!ShouldEmitDwarf()) return;
1815   EOL("Dwarf Begin Module");
1816 }
1817
1818 /// EndModule - Emit all Dwarf sections that should come after the content.
1819 ///
1820 void DwarfWriter::EndModule(Module &M) {
1821   if (!ShouldEmitDwarf()) return;
1822   EOL("Dwarf End Module");
1823
1824   // Standard sections final addresses.
1825   Asm->SwitchSection(TextSection, 0);
1826   EmitLabel("text_end", 0);
1827   Asm->SwitchSection(DataSection, 0);
1828   EmitLabel("data_end", 0);
1829
1830   // Create all the compile unit DIEs.
1831   ConstructCompileUnitDIEs();
1832
1833   // Create DIEs for each of the externally visible global variables.
1834   ConstructGlobalDIEs(M);
1835
1836   // Compute DIE offsets and sizes.
1837   SizeAndOffsets();
1838
1839   // Emit all the DIEs into a debug info section
1840   EmitDebugInfo();
1841
1842   // Corresponding abbreviations into a abbrev section.
1843   EmitAbbreviations();
1844
1845   // Emit source line correspondence into a debug line section.
1846   EmitDebugLines();
1847
1848   // Emit info into a debug frame section.
1849   EmitDebugFrame();
1850
1851   // Emit info into a debug pubnames section.
1852   EmitDebugPubNames();
1853
1854   // Emit info into a debug pubtypes section.
1855   EmitDebugPubTypes();
1856
1857   // Emit info into a debug str section.
1858   EmitDebugStr();
1859
1860   // Emit info into a debug loc section.
1861   EmitDebugLoc();
1862
1863   // Emit info into a debug aranges section.
1864   EmitDebugARanges();
1865
1866   // Emit info into a debug ranges section.
1867   EmitDebugRanges();
1868
1869   // Emit info into a debug macinfo section.
1870   EmitDebugMacInfo();
1871 }
1872
1873 /// BeginFunction - Gather pre-function debug information.
1874 ///
1875 void DwarfWriter::BeginFunction(MachineFunction &MF) {
1876   if (!ShouldEmitDwarf()) return;
1877   EOL("Dwarf Begin Function");
1878 }
1879
1880 /// EndFunction - Gather and emit post-function debug information.
1881 ///
1882 void DwarfWriter::EndFunction(MachineFunction &MF) {
1883   if (!ShouldEmitDwarf()) return;
1884   EOL("Dwarf End Function");
1885 }