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