include/llvm/Support/Dwarf.h

   1 //===-- llvm/Support/Dwarf.h ---Dwarf Constants------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains constants used for implementing Dwarf debug support.  For
  11 // Details on the Dwarf 3 specfication see DWARF Debugging Information Format
  12 // V.3 reference manual http://dwarf.freestandards.org ,
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_SUPPORT_DWARF_H
  17 #define LLVM_SUPPORT_DWARF_H
  18
  19 #include "llvm/Support/Compiler.h"
  20 #include "llvm/Support/DataTypes.h"
  21
  22 namespace llvm {
  23
  24 //===----------------------------------------------------------------------===//
  25 // Debug info constants.
  26
  27 enum : uint32_t {
  28   LLVMDebugVersion = (12 << 16),    // Current version of debug information.
  29   LLVMDebugVersion11 = (11 << 16),  // Constant for version 11.
  30   LLVMDebugVersion10 = (10 << 16),  // Constant for version 10.
  31   LLVMDebugVersion9 = (9 << 16),    // Constant for version 9.
  32   LLVMDebugVersion8 = (8 << 16),    // Constant for version 8.
  33   LLVMDebugVersion7 = (7 << 16),    // Constant for version 7.
  34   LLVMDebugVersion6 = (6 << 16),    // Constant for version 6.
  35   LLVMDebugVersion5 = (5 << 16),    // Constant for version 5.
  36   LLVMDebugVersion4 = (4 << 16),    // Constant for version 4.
  37   LLVMDebugVersionMask = 0xffff0000 // Mask for version number.
  38 };
  39
  40 namespace dwarf {
  41
  42 //===----------------------------------------------------------------------===//
  43 // Dwarf constants as gleaned from the DWARF Debugging Information Format V.4
  44 // reference manual http://www.dwarfstd.org/.
  45 //
  46
  47 // Do not mix the following two enumerations sets.  DW_TAG_invalid changes the
  48 // enumeration base type.
  49
  50 enum LLVMConstants : uint32_t {
  51   // llvm mock tags
  52   DW_TAG_invalid = ~0U, // Tag for invalid results.
  53
  54   DW_TAG_auto_variable = 0x100, // Tag for local (auto) variables.
  55   DW_TAG_arg_variable = 0x101,  // Tag for argument variables.
  56
  57   DW_TAG_user_base = 0x1000, // Recommended base for user tags.
  58
  59   DWARF_VERSION = 4,       // Default dwarf version we output.
  60   DW_PUBTYPES_VERSION = 2, // Section version number for .debug_pubtypes.
  61   DW_PUBNAMES_VERSION = 2, // Section version number for .debug_pubnames.
  62   DW_ARANGES_VERSION = 2   // Section version number for .debug_aranges.
  63 };
  64
  65 // Special ID values that distinguish a CIE from a FDE in DWARF CFI.
  66 // Not inside an enum because a 64-bit value is needed.
  67 const uint32_t DW_CIE_ID = UINT32_MAX;
  68 const uint64_t DW64_CIE_ID = UINT64_MAX;
  69
  70 enum Tag : uint16_t {
  71   DW_TAG_array_type = 0x01,
  72   DW_TAG_class_type = 0x02,
  73   DW_TAG_entry_point = 0x03,
  74   DW_TAG_enumeration_type = 0x04,
  75   DW_TAG_formal_parameter = 0x05,
  76   DW_TAG_imported_declaration = 0x08,
  77   DW_TAG_label = 0x0a,
  78   DW_TAG_lexical_block = 0x0b,
  79   DW_TAG_member = 0x0d,
  80   DW_TAG_pointer_type = 0x0f,
  81   DW_TAG_reference_type = 0x10,
  82   DW_TAG_compile_unit = 0x11,
  83   DW_TAG_string_type = 0x12,
  84   DW_TAG_structure_type = 0x13,
  85   DW_TAG_subroutine_type = 0x15,
  86   DW_TAG_typedef = 0x16,
  87   DW_TAG_union_type = 0x17,
  88   DW_TAG_unspecified_parameters = 0x18,
  89   DW_TAG_variant = 0x19,
  90   DW_TAG_common_block = 0x1a,
  91   DW_TAG_common_inclusion = 0x1b,
  92   DW_TAG_inheritance = 0x1c,
  93   DW_TAG_inlined_subroutine = 0x1d,
  94   DW_TAG_module = 0x1e,
  95   DW_TAG_ptr_to_member_type = 0x1f,
  96   DW_TAG_set_type = 0x20,
  97   DW_TAG_subrange_type = 0x21,
  98   DW_TAG_with_stmt = 0x22,
  99   DW_TAG_access_declaration = 0x23,
 100   DW_TAG_base_type = 0x24,
 101   DW_TAG_catch_block = 0x25,
 102   DW_TAG_const_type = 0x26,
 103   DW_TAG_constant = 0x27,
 104   DW_TAG_enumerator = 0x28,
 105   DW_TAG_file_type = 0x29,
 106   DW_TAG_friend = 0x2a,
 107   DW_TAG_namelist = 0x2b,
 108   DW_TAG_namelist_item = 0x2c,
 109   DW_TAG_packed_type = 0x2d,
 110   DW_TAG_subprogram = 0x2e,
 111   DW_TAG_template_type_parameter = 0x2f,
 112   DW_TAG_template_value_parameter = 0x30,
 113   DW_TAG_thrown_type = 0x31,
 114   DW_TAG_try_block = 0x32,
 115   DW_TAG_variant_part = 0x33,
 116   DW_TAG_variable = 0x34,
 117   DW_TAG_volatile_type = 0x35,
 118   DW_TAG_dwarf_procedure = 0x36,
 119   DW_TAG_restrict_type = 0x37,
 120   DW_TAG_interface_type = 0x38,
 121   DW_TAG_namespace = 0x39,
 122   DW_TAG_imported_module = 0x3a,
 123   DW_TAG_unspecified_type = 0x3b,
 124   DW_TAG_partial_unit = 0x3c,
 125   DW_TAG_imported_unit = 0x3d,
 126   DW_TAG_condition = 0x3f,
 127   DW_TAG_shared_type = 0x40,
 128   DW_TAG_type_unit = 0x41,
 129   DW_TAG_rvalue_reference_type = 0x42,
 130   DW_TAG_template_alias = 0x43,
 131
 132   // New in DWARF 5:
 133   DW_TAG_coarray_type = 0x44,
 134   DW_TAG_generic_subrange = 0x45,
 135   DW_TAG_dynamic_type = 0x46,
 136
 137   DW_TAG_MIPS_loop = 0x4081,
 138   DW_TAG_format_label = 0x4101,
 139   DW_TAG_function_template = 0x4102,
 140   DW_TAG_class_template = 0x4103,
 141   DW_TAG_GNU_template_template_param = 0x4106,
 142   DW_TAG_GNU_template_parameter_pack = 0x4107,
 143   DW_TAG_GNU_formal_parameter_pack = 0x4108,
 144   DW_TAG_lo_user = 0x4080,
 145   DW_TAG_APPLE_property = 0x4200,
 146   DW_TAG_hi_user = 0xffff
 147 };
 148
 149 inline bool isType(Tag T) {
 150   switch (T) {
 151   case DW_TAG_array_type:
 152   case DW_TAG_class_type:
 153   case DW_TAG_interface_type:
 154   case DW_TAG_enumeration_type:
 155   case DW_TAG_pointer_type:
 156   case DW_TAG_reference_type:
 157   case DW_TAG_rvalue_reference_type:
 158   case DW_TAG_string_type:
 159   case DW_TAG_structure_type:
 160   case DW_TAG_subroutine_type:
 161   case DW_TAG_union_type:
 162   case DW_TAG_ptr_to_member_type:
 163   case DW_TAG_set_type:
 164   case DW_TAG_subrange_type:
 165   case DW_TAG_base_type:
 166   case DW_TAG_const_type:
 167   case DW_TAG_file_type:
 168   case DW_TAG_packed_type:
 169   case DW_TAG_volatile_type:
 170   case DW_TAG_typedef:
 171     return true;
 172   default:
 173     return false;
 174   }
 175 }
 176
 177 enum Attribute : uint16_t {
 178   // Attributes
 179   DW_AT_sibling = 0x01,
 180   DW_AT_location = 0x02,
 181   DW_AT_name = 0x03,
 182   DW_AT_ordering = 0x09,
 183   DW_AT_byte_size = 0x0b,
 184   DW_AT_bit_offset = 0x0c,
 185   DW_AT_bit_size = 0x0d,
 186   DW_AT_stmt_list = 0x10,
 187   DW_AT_low_pc = 0x11,
 188   DW_AT_high_pc = 0x12,
 189   DW_AT_language = 0x13,
 190   DW_AT_discr = 0x15,
 191   DW_AT_discr_value = 0x16,
 192   DW_AT_visibility = 0x17,
 193   DW_AT_import = 0x18,
 194   DW_AT_string_length = 0x19,
 195   DW_AT_common_reference = 0x1a,
 196   DW_AT_comp_dir = 0x1b,
 197   DW_AT_const_value = 0x1c,
 198   DW_AT_containing_type = 0x1d,
 199   DW_AT_default_value = 0x1e,
 200   DW_AT_inline = 0x20,
 201   DW_AT_is_optional = 0x21,
 202   DW_AT_lower_bound = 0x22,
 203   DW_AT_producer = 0x25,
 204   DW_AT_prototyped = 0x27,
 205   DW_AT_return_addr = 0x2a,
 206   DW_AT_start_scope = 0x2c,
 207   DW_AT_bit_stride = 0x2e,
 208   DW_AT_upper_bound = 0x2f,
 209   DW_AT_abstract_origin = 0x31,
 210   DW_AT_accessibility = 0x32,
 211   DW_AT_address_class = 0x33,
 212   DW_AT_artificial = 0x34,
 213   DW_AT_base_types = 0x35,
 214   DW_AT_calling_convention = 0x36,
 215   DW_AT_count = 0x37,
 216   DW_AT_data_member_location = 0x38,
 217   DW_AT_decl_column = 0x39,
 218   DW_AT_decl_file = 0x3a,
 219   DW_AT_decl_line = 0x3b,
 220   DW_AT_declaration = 0x3c,
 221   DW_AT_discr_list = 0x3d,
 222   DW_AT_encoding = 0x3e,
 223   DW_AT_external = 0x3f,
 224   DW_AT_frame_base = 0x40,
 225   DW_AT_friend = 0x41,
 226   DW_AT_identifier_case = 0x42,
 227   DW_AT_macro_info = 0x43,
 228   DW_AT_namelist_item = 0x44,
 229   DW_AT_priority = 0x45,
 230   DW_AT_segment = 0x46,
 231   DW_AT_specification = 0x47,
 232   DW_AT_static_link = 0x48,
 233   DW_AT_type = 0x49,
 234   DW_AT_use_location = 0x4a,
 235   DW_AT_variable_parameter = 0x4b,
 236   DW_AT_virtuality = 0x4c,
 237   DW_AT_vtable_elem_location = 0x4d,
 238   DW_AT_allocated = 0x4e,
 239   DW_AT_associated = 0x4f,
 240   DW_AT_data_location = 0x50,
 241   DW_AT_byte_stride = 0x51,
 242   DW_AT_entry_pc = 0x52,
 243   DW_AT_use_UTF8 = 0x53,
 244   DW_AT_extension = 0x54,
 245   DW_AT_ranges = 0x55,
 246   DW_AT_trampoline = 0x56,
 247   DW_AT_call_column = 0x57,
 248   DW_AT_call_file = 0x58,
 249   DW_AT_call_line = 0x59,
 250   DW_AT_description = 0x5a,
 251   DW_AT_binary_scale = 0x5b,
 252   DW_AT_decimal_scale = 0x5c,
 253   DW_AT_small = 0x5d,
 254   DW_AT_decimal_sign = 0x5e,
 255   DW_AT_digit_count = 0x5f,
 256   DW_AT_picture_string = 0x60,
 257   DW_AT_mutable = 0x61,
 258   DW_AT_threads_scaled = 0x62,
 259   DW_AT_explicit = 0x63,
 260   DW_AT_object_pointer = 0x64,
 261   DW_AT_endianity = 0x65,
 262   DW_AT_elemental = 0x66,
 263   DW_AT_pure = 0x67,
 264   DW_AT_recursive = 0x68,
 265   DW_AT_signature = 0x69,
 266   DW_AT_main_subprogram = 0x6a,
 267   DW_AT_data_bit_offset = 0x6b,
 268   DW_AT_const_expr = 0x6c,
 269   DW_AT_enum_class = 0x6d,
 270   DW_AT_linkage_name = 0x6e,
 271
 272   // New in DWARF 5:
 273   DW_AT_string_length_bit_size = 0x6f,
 274   DW_AT_string_length_byte_size = 0x70,
 275   DW_AT_rank = 0x71,
 276   DW_AT_str_offsets_base = 0x72,
 277   DW_AT_addr_base = 0x73,
 278   DW_AT_ranges_base = 0x74,
 279   DW_AT_dwo_id = 0x75,
 280   DW_AT_dwo_name = 0x76,
 281   DW_AT_reference = 0x77,
 282   DW_AT_rvalue_reference = 0x78,
 283
 284   DW_AT_lo_user = 0x2000,
 285   DW_AT_hi_user = 0x3fff,
 286
 287   DW_AT_MIPS_loop_begin = 0x2002,
 288   DW_AT_MIPS_tail_loop_begin = 0x2003,
 289   DW_AT_MIPS_epilog_begin = 0x2004,
 290   DW_AT_MIPS_loop_unroll_factor = 0x2005,
 291   DW_AT_MIPS_software_pipeline_depth = 0x2006,
 292   DW_AT_MIPS_linkage_name = 0x2007,
 293   DW_AT_MIPS_stride = 0x2008,
 294   DW_AT_MIPS_abstract_name = 0x2009,
 295   DW_AT_MIPS_clone_origin = 0x200a,
 296   DW_AT_MIPS_has_inlines = 0x200b,
 297   DW_AT_MIPS_stride_byte = 0x200c,
 298   DW_AT_MIPS_stride_elem = 0x200d,
 299   DW_AT_MIPS_ptr_dopetype = 0x200e,
 300   DW_AT_MIPS_allocatable_dopetype = 0x200f,
 301   DW_AT_MIPS_assumed_shape_dopetype = 0x2010,
 302
 303   // This one appears to have only been implemented by Open64 for
 304   // fortran and may conflict with other extensions.
 305   DW_AT_MIPS_assumed_size = 0x2011,
 306
 307   // GNU extensions
 308   DW_AT_sf_names = 0x2101,
 309   DW_AT_src_info = 0x2102,
 310   DW_AT_mac_info = 0x2103,
 311   DW_AT_src_coords = 0x2104,
 312   DW_AT_body_begin = 0x2105,
 313   DW_AT_body_end = 0x2106,
 314   DW_AT_GNU_vector = 0x2107,
 315   DW_AT_GNU_template_name = 0x2110,
 316
 317   DW_AT_GNU_odr_signature = 0x210f,
 318
 319   // Extensions for Fission proposal.
 320   DW_AT_GNU_dwo_name = 0x2130,
 321   DW_AT_GNU_dwo_id = 0x2131,
 322   DW_AT_GNU_ranges_base = 0x2132,
 323   DW_AT_GNU_addr_base = 0x2133,
 324   DW_AT_GNU_pubnames = 0x2134,
 325   DW_AT_GNU_pubtypes = 0x2135,
 326
 327   // Apple extensions.
 328   DW_AT_APPLE_optimized = 0x3fe1,
 329   DW_AT_APPLE_flags = 0x3fe2,
 330   DW_AT_APPLE_isa = 0x3fe3,
 331   DW_AT_APPLE_block = 0x3fe4,
 332   DW_AT_APPLE_major_runtime_vers = 0x3fe5,
 333   DW_AT_APPLE_runtime_class = 0x3fe6,
 334   DW_AT_APPLE_omit_frame_ptr = 0x3fe7,
 335   DW_AT_APPLE_property_name = 0x3fe8,
 336   DW_AT_APPLE_property_getter = 0x3fe9,
 337   DW_AT_APPLE_property_setter = 0x3fea,
 338   DW_AT_APPLE_property_attribute = 0x3feb,
 339   DW_AT_APPLE_objc_complete_type = 0x3fec,
 340   DW_AT_APPLE_property = 0x3fed
 341 };
 342
 343 enum Form : uint16_t {
 344   // Attribute form encodings
 345   DW_FORM_addr = 0x01,
 346   DW_FORM_block2 = 0x03,
 347   DW_FORM_block4 = 0x04,
 348   DW_FORM_data2 = 0x05,
 349   DW_FORM_data4 = 0x06,
 350   DW_FORM_data8 = 0x07,
 351   DW_FORM_string = 0x08,
 352   DW_FORM_block = 0x09,
 353   DW_FORM_block1 = 0x0a,
 354   DW_FORM_data1 = 0x0b,
 355   DW_FORM_flag = 0x0c,
 356   DW_FORM_sdata = 0x0d,
 357   DW_FORM_strp = 0x0e,
 358   DW_FORM_udata = 0x0f,
 359   DW_FORM_ref_addr = 0x10,
 360   DW_FORM_ref1 = 0x11,
 361   DW_FORM_ref2 = 0x12,
 362   DW_FORM_ref4 = 0x13,
 363   DW_FORM_ref8 = 0x14,
 364   DW_FORM_ref_udata = 0x15,
 365   DW_FORM_indirect = 0x16,
 366   DW_FORM_sec_offset = 0x17,
 367   DW_FORM_exprloc = 0x18,
 368   DW_FORM_flag_present = 0x19,
 369   DW_FORM_ref_sig8 = 0x20,
 370
 371   // Extensions for Fission proposal
 372   DW_FORM_GNU_addr_index = 0x1f01,
 373   DW_FORM_GNU_str_index = 0x1f02
 374 };
 375
 376 enum LocationAtom {
 377   // Operation encodings
 378   DW_OP_addr = 0x03,
 379   DW_OP_deref = 0x06,
 380   DW_OP_const1u = 0x08,
 381   DW_OP_const1s = 0x09,
 382   DW_OP_const2u = 0x0a,
 383   DW_OP_const2s = 0x0b,
 384   DW_OP_const4u = 0x0c,
 385   DW_OP_const4s = 0x0d,
 386   DW_OP_const8u = 0x0e,
 387   DW_OP_const8s = 0x0f,
 388   DW_OP_constu = 0x10,
 389   DW_OP_consts = 0x11,
 390   DW_OP_dup = 0x12,
 391   DW_OP_drop = 0x13,
 392   DW_OP_over = 0x14,
 393   DW_OP_pick = 0x15,
 394   DW_OP_swap = 0x16,
 395   DW_OP_rot = 0x17,
 396   DW_OP_xderef = 0x18,
 397   DW_OP_abs = 0x19,
 398   DW_OP_and = 0x1a,
 399   DW_OP_div = 0x1b,
 400   DW_OP_minus = 0x1c,
 401   DW_OP_mod = 0x1d,
 402   DW_OP_mul = 0x1e,
 403   DW_OP_neg = 0x1f,
 404   DW_OP_not = 0x20,
 405   DW_OP_or = 0x21,
 406   DW_OP_plus = 0x22,
 407   DW_OP_plus_uconst = 0x23,
 408   DW_OP_shl = 0x24,
 409   DW_OP_shr = 0x25,
 410   DW_OP_shra = 0x26,
 411   DW_OP_xor = 0x27,
 412   DW_OP_skip = 0x2f,
 413   DW_OP_bra = 0x28,
 414   DW_OP_eq = 0x29,
 415   DW_OP_ge = 0x2a,
 416   DW_OP_gt = 0x2b,
 417   DW_OP_le = 0x2c,
 418   DW_OP_lt = 0x2d,
 419   DW_OP_ne = 0x2e,
 420   DW_OP_lit0 = 0x30,
 421   DW_OP_lit1 = 0x31,
 422   DW_OP_lit2 = 0x32,
 423   DW_OP_lit3 = 0x33,
 424   DW_OP_lit4 = 0x34,
 425   DW_OP_lit5 = 0x35,
 426   DW_OP_lit6 = 0x36,
 427   DW_OP_lit7 = 0x37,
 428   DW_OP_lit8 = 0x38,
 429   DW_OP_lit9 = 0x39,
 430   DW_OP_lit10 = 0x3a,
 431   DW_OP_lit11 = 0x3b,
 432   DW_OP_lit12 = 0x3c,
 433   DW_OP_lit13 = 0x3d,
 434   DW_OP_lit14 = 0x3e,
 435   DW_OP_lit15 = 0x3f,
 436   DW_OP_lit16 = 0x40,
 437   DW_OP_lit17 = 0x41,
 438   DW_OP_lit18 = 0x42,
 439   DW_OP_lit19 = 0x43,
 440   DW_OP_lit20 = 0x44,
 441   DW_OP_lit21 = 0x45,
 442   DW_OP_lit22 = 0x46,
 443   DW_OP_lit23 = 0x47,
 444   DW_OP_lit24 = 0x48,
 445   DW_OP_lit25 = 0x49,
 446   DW_OP_lit26 = 0x4a,
 447   DW_OP_lit27 = 0x4b,
 448   DW_OP_lit28 = 0x4c,
 449   DW_OP_lit29 = 0x4d,
 450   DW_OP_lit30 = 0x4e,
 451   DW_OP_lit31 = 0x4f,
 452   DW_OP_reg0 = 0x50,
 453   DW_OP_reg1 = 0x51,
 454   DW_OP_reg2 = 0x52,
 455   DW_OP_reg3 = 0x53,
 456   DW_OP_reg4 = 0x54,
 457   DW_OP_reg5 = 0x55,
 458   DW_OP_reg6 = 0x56,
 459   DW_OP_reg7 = 0x57,
 460   DW_OP_reg8 = 0x58,
 461   DW_OP_reg9 = 0x59,
 462   DW_OP_reg10 = 0x5a,
 463   DW_OP_reg11 = 0x5b,
 464   DW_OP_reg12 = 0x5c,
 465   DW_OP_reg13 = 0x5d,
 466   DW_OP_reg14 = 0x5e,
 467   DW_OP_reg15 = 0x5f,
 468   DW_OP_reg16 = 0x60,
 469   DW_OP_reg17 = 0x61,
 470   DW_OP_reg18 = 0x62,
 471   DW_OP_reg19 = 0x63,
 472   DW_OP_reg20 = 0x64,
 473   DW_OP_reg21 = 0x65,
 474   DW_OP_reg22 = 0x66,
 475   DW_OP_reg23 = 0x67,
 476   DW_OP_reg24 = 0x68,
 477   DW_OP_reg25 = 0x69,
 478   DW_OP_reg26 = 0x6a,
 479   DW_OP_reg27 = 0x6b,
 480   DW_OP_reg28 = 0x6c,
 481   DW_OP_reg29 = 0x6d,
 482   DW_OP_reg30 = 0x6e,
 483   DW_OP_reg31 = 0x6f,
 484   DW_OP_breg0 = 0x70,
 485   DW_OP_breg1 = 0x71,
 486   DW_OP_breg2 = 0x72,
 487   DW_OP_breg3 = 0x73,
 488   DW_OP_breg4 = 0x74,
 489   DW_OP_breg5 = 0x75,
 490   DW_OP_breg6 = 0x76,
 491   DW_OP_breg7 = 0x77,
 492   DW_OP_breg8 = 0x78,
 493   DW_OP_breg9 = 0x79,
 494   DW_OP_breg10 = 0x7a,
 495   DW_OP_breg11 = 0x7b,
 496   DW_OP_breg12 = 0x7c,
 497   DW_OP_breg13 = 0x7d,
 498   DW_OP_breg14 = 0x7e,
 499   DW_OP_breg15 = 0x7f,
 500   DW_OP_breg16 = 0x80,
 501   DW_OP_breg17 = 0x81,
 502   DW_OP_breg18 = 0x82,
 503   DW_OP_breg19 = 0x83,
 504   DW_OP_breg20 = 0x84,
 505   DW_OP_breg21 = 0x85,
 506   DW_OP_breg22 = 0x86,
 507   DW_OP_breg23 = 0x87,
 508   DW_OP_breg24 = 0x88,
 509   DW_OP_breg25 = 0x89,
 510   DW_OP_breg26 = 0x8a,
 511   DW_OP_breg27 = 0x8b,
 512   DW_OP_breg28 = 0x8c,
 513   DW_OP_breg29 = 0x8d,
 514   DW_OP_breg30 = 0x8e,
 515   DW_OP_breg31 = 0x8f,
 516   DW_OP_regx = 0x90,
 517   DW_OP_fbreg = 0x91,
 518   DW_OP_bregx = 0x92,
 519   DW_OP_piece = 0x93,
 520   DW_OP_deref_size = 0x94,
 521   DW_OP_xderef_size = 0x95,
 522   DW_OP_nop = 0x96,
 523   DW_OP_push_object_address = 0x97,
 524   DW_OP_call2 = 0x98,
 525   DW_OP_call4 = 0x99,
 526   DW_OP_call_ref = 0x9a,
 527   DW_OP_form_tls_address = 0x9b,
 528   DW_OP_call_frame_cfa = 0x9c,
 529   DW_OP_bit_piece = 0x9d,
 530   DW_OP_implicit_value = 0x9e,
 531   DW_OP_stack_value = 0x9f,
 532   DW_OP_lo_user = 0xe0,
 533   DW_OP_hi_user = 0xff,
 534
 535   // Extensions for GNU-style thread-local storage.
 536   DW_OP_GNU_push_tls_address = 0xe0,
 537
 538   // Extensions for Fission proposal.
 539   DW_OP_GNU_addr_index = 0xfb,
 540   DW_OP_GNU_const_index = 0xfc
 541 };
 542
 543 enum TypeKind {
 544   // Encoding attribute values
 545   DW_ATE_address = 0x01,
 546   DW_ATE_boolean = 0x02,
 547   DW_ATE_complex_float = 0x03,
 548   DW_ATE_float = 0x04,
 549   DW_ATE_signed = 0x05,
 550   DW_ATE_signed_char = 0x06,
 551   DW_ATE_unsigned = 0x07,
 552   DW_ATE_unsigned_char = 0x08,
 553   DW_ATE_imaginary_float = 0x09,
 554   DW_ATE_packed_decimal = 0x0a,
 555   DW_ATE_numeric_string = 0x0b,
 556   DW_ATE_edited = 0x0c,
 557   DW_ATE_signed_fixed = 0x0d,
 558   DW_ATE_unsigned_fixed = 0x0e,
 559   DW_ATE_decimal_float = 0x0f,
 560   DW_ATE_UTF = 0x10,
 561   DW_ATE_lo_user = 0x80,
 562   DW_ATE_hi_user = 0xff
 563 };
 564
 565 enum DecimalSignEncoding {
 566   // Decimal sign attribute values
 567   DW_DS_unsigned = 0x01,
 568   DW_DS_leading_overpunch = 0x02,
 569   DW_DS_trailing_overpunch = 0x03,
 570   DW_DS_leading_separate = 0x04,
 571   DW_DS_trailing_separate = 0x05
 572 };
 573
 574 enum EndianityEncoding {
 575   // Endianity attribute values
 576   DW_END_default = 0x00,
 577   DW_END_big = 0x01,
 578   DW_END_little = 0x02,
 579   DW_END_lo_user = 0x40,
 580   DW_END_hi_user = 0xff
 581 };
 582
 583 enum AccessAttribute {
 584   // Accessibility codes
 585   DW_ACCESS_public = 0x01,
 586   DW_ACCESS_protected = 0x02,
 587   DW_ACCESS_private = 0x03
 588 };
 589
 590 enum VisibilityAttribute {
 591   // Visibility codes
 592   DW_VIS_local = 0x01,
 593   DW_VIS_exported = 0x02,
 594   DW_VIS_qualified = 0x03
 595 };
 596
 597 enum VirtualityAttribute {
 598   // Virtuality codes
 599   DW_VIRTUALITY_none = 0x00,
 600   DW_VIRTUALITY_virtual = 0x01,
 601   DW_VIRTUALITY_pure_virtual = 0x02
 602 };
 603
 604 enum SourceLanguage {
 605   // Language names
 606   DW_LANG_C89 = 0x0001,
 607   DW_LANG_C = 0x0002,
 608   DW_LANG_Ada83 = 0x0003,
 609   DW_LANG_C_plus_plus = 0x0004,
 610   DW_LANG_Cobol74 = 0x0005,
 611   DW_LANG_Cobol85 = 0x0006,
 612   DW_LANG_Fortran77 = 0x0007,
 613   DW_LANG_Fortran90 = 0x0008,
 614   DW_LANG_Pascal83 = 0x0009,
 615   DW_LANG_Modula2 = 0x000a,
 616   DW_LANG_Java = 0x000b,
 617   DW_LANG_C99 = 0x000c,
 618   DW_LANG_Ada95 = 0x000d,
 619   DW_LANG_Fortran95 = 0x000e,
 620   DW_LANG_PLI = 0x000f,
 621   DW_LANG_ObjC = 0x0010,
 622   DW_LANG_ObjC_plus_plus = 0x0011,
 623   DW_LANG_UPC = 0x0012,
 624   DW_LANG_D = 0x0013,
 625   // New in DWARF 5:
 626   DW_LANG_Python = 0x0014,
 627   DW_LANG_OpenCL = 0x0015,
 628   DW_LANG_Go = 0x0016,
 629   DW_LANG_Modula3 = 0x0017,
 630   DW_LANG_Haskell = 0x0018,
 631   DW_LANG_C_plus_plus_03 = 0x0019,
 632   DW_LANG_C_plus_plus_11 = 0x001a,
 633   DW_LANG_OCaml = 0x001b,
 634
 635   DW_LANG_lo_user = 0x8000,
 636   DW_LANG_Mips_Assembler = 0x8001,
 637   DW_LANG_hi_user = 0xffff
 638 };
 639
 640 enum CaseSensitivity {
 641   // Identifier case codes
 642   DW_ID_case_sensitive = 0x00,
 643   DW_ID_up_case = 0x01,
 644   DW_ID_down_case = 0x02,
 645   DW_ID_case_insensitive = 0x03
 646 };
 647
 648 enum CallingConvention {
 649   // Calling convention codes
 650   DW_CC_normal = 0x01,
 651   DW_CC_program = 0x02,
 652   DW_CC_nocall = 0x03,
 653   DW_CC_lo_user = 0x40,
 654   DW_CC_hi_user = 0xff
 655 };
 656
 657 enum InlineAttribute {
 658   // Inline codes
 659   DW_INL_not_inlined = 0x00,
 660   DW_INL_inlined = 0x01,
 661   DW_INL_declared_not_inlined = 0x02,
 662   DW_INL_declared_inlined = 0x03
 663 };
 664
 665 enum ArrayDimensionOrdering {
 666   // Array ordering
 667   DW_ORD_row_major = 0x00,
 668   DW_ORD_col_major = 0x01
 669 };
 670
 671 enum DiscriminantList {
 672   // Discriminant descriptor values
 673   DW_DSC_label = 0x00,
 674   DW_DSC_range = 0x01
 675 };
 676
 677 enum LineNumberOps {
 678   // Line Number Standard Opcode Encodings
 679   DW_LNS_extended_op = 0x00,
 680   DW_LNS_copy = 0x01,
 681   DW_LNS_advance_pc = 0x02,
 682   DW_LNS_advance_line = 0x03,
 683   DW_LNS_set_file = 0x04,
 684   DW_LNS_set_column = 0x05,
 685   DW_LNS_negate_stmt = 0x06,
 686   DW_LNS_set_basic_block = 0x07,
 687   DW_LNS_const_add_pc = 0x08,
 688   DW_LNS_fixed_advance_pc = 0x09,
 689   DW_LNS_set_prologue_end = 0x0a,
 690   DW_LNS_set_epilogue_begin = 0x0b,
 691   DW_LNS_set_isa = 0x0c
 692 };
 693
 694 enum LineNumberExtendedOps {
 695   // Line Number Extended Opcode Encodings
 696   DW_LNE_end_sequence = 0x01,
 697   DW_LNE_set_address = 0x02,
 698   DW_LNE_define_file = 0x03,
 699   DW_LNE_set_discriminator = 0x04,
 700   DW_LNE_lo_user = 0x80,
 701   DW_LNE_hi_user = 0xff
 702 };
 703
 704 enum MacinfoRecordType {
 705   // Macinfo Type Encodings
 706   DW_MACINFO_define = 0x01,
 707   DW_MACINFO_undef = 0x02,
 708   DW_MACINFO_start_file = 0x03,
 709   DW_MACINFO_end_file = 0x04,
 710   DW_MACINFO_vendor_ext = 0xff
 711 };
 712
 713 enum CallFrameInfo {
 714   // Call frame instruction encodings
 715   DW_CFA_extended = 0x00,
 716   DW_CFA_nop = 0x00,
 717   DW_CFA_advance_loc = 0x40,
 718   DW_CFA_offset = 0x80,
 719   DW_CFA_restore = 0xc0,
 720   DW_CFA_set_loc = 0x01,
 721   DW_CFA_advance_loc1 = 0x02,
 722   DW_CFA_advance_loc2 = 0x03,
 723   DW_CFA_advance_loc4 = 0x04,
 724   DW_CFA_offset_extended = 0x05,
 725   DW_CFA_restore_extended = 0x06,
 726   DW_CFA_undefined = 0x07,
 727   DW_CFA_same_value = 0x08,
 728   DW_CFA_register = 0x09,
 729   DW_CFA_remember_state = 0x0a,
 730   DW_CFA_restore_state = 0x0b,
 731   DW_CFA_def_cfa = 0x0c,
 732   DW_CFA_def_cfa_register = 0x0d,
 733   DW_CFA_def_cfa_offset = 0x0e,
 734   DW_CFA_def_cfa_expression = 0x0f,
 735   DW_CFA_expression = 0x10,
 736   DW_CFA_offset_extended_sf = 0x11,
 737   DW_CFA_def_cfa_sf = 0x12,
 738   DW_CFA_def_cfa_offset_sf = 0x13,
 739   DW_CFA_val_offset = 0x14,
 740   DW_CFA_val_offset_sf = 0x15,
 741   DW_CFA_val_expression = 0x16,
 742   DW_CFA_MIPS_advance_loc8 = 0x1d,
 743   DW_CFA_GNU_window_save = 0x2d,
 744   DW_CFA_GNU_args_size = 0x2e,
 745   DW_CFA_lo_user = 0x1c,
 746   DW_CFA_hi_user = 0x3f
 747 };
 748
 749 enum Constants {
 750   // Children flag
 751   DW_CHILDREN_no = 0x00,
 752   DW_CHILDREN_yes = 0x01,
 753
 754   DW_EH_PE_absptr = 0x00,
 755   DW_EH_PE_omit = 0xff,
 756   DW_EH_PE_uleb128 = 0x01,
 757   DW_EH_PE_udata2 = 0x02,
 758   DW_EH_PE_udata4 = 0x03,
 759   DW_EH_PE_udata8 = 0x04,
 760   DW_EH_PE_sleb128 = 0x09,
 761   DW_EH_PE_sdata2 = 0x0A,
 762   DW_EH_PE_sdata4 = 0x0B,
 763   DW_EH_PE_sdata8 = 0x0C,
 764   DW_EH_PE_signed = 0x08,
 765   DW_EH_PE_pcrel = 0x10,
 766   DW_EH_PE_textrel = 0x20,
 767   DW_EH_PE_datarel = 0x30,
 768   DW_EH_PE_funcrel = 0x40,
 769   DW_EH_PE_aligned = 0x50,
 770   DW_EH_PE_indirect = 0x80
 771 };
 772
 773 // Constants for debug_loc.dwo in the DWARF5 Split Debug Info Proposal
 774 enum LocationListEntry : unsigned char {
 775   DW_LLE_end_of_list_entry,
 776   DW_LLE_base_address_selection_entry,
 777   DW_LLE_start_end_entry,
 778   DW_LLE_start_length_entry,
 779   DW_LLE_offset_pair_entry
 780 };
 781
 782 enum ApplePropertyAttributes {
 783   // Apple Objective-C Property Attributes
 784   DW_APPLE_PROPERTY_readonly = 0x01,
 785   DW_APPLE_PROPERTY_readwrite = 0x02,
 786   DW_APPLE_PROPERTY_assign = 0x04,
 787   DW_APPLE_PROPERTY_retain = 0x08,
 788   DW_APPLE_PROPERTY_copy = 0x10,
 789   DW_APPLE_PROPERTY_nonatomic = 0x20
 790 };
 791
 792 /// TagString - Return the string for the specified tag.
 793 ///
 794 const char *TagString(unsigned Tag);
 795
 796 /// ChildrenString - Return the string for the specified children flag.
 797 ///
 798 const char *ChildrenString(unsigned Children);
 799
 800 /// AttributeString - Return the string for the specified attribute.
 801 ///
 802 const char *AttributeString(unsigned Attribute);
 803
 804 /// FormEncodingString - Return the string for the specified form encoding.
 805 ///
 806 const char *FormEncodingString(unsigned Encoding);
 807
 808 /// OperationEncodingString - Return the string for the specified operation
 809 /// encoding.
 810 const char *OperationEncodingString(unsigned Encoding);
 811
 812 /// AttributeEncodingString - Return the string for the specified attribute
 813 /// encoding.
 814 const char *AttributeEncodingString(unsigned Encoding);
 815
 816 /// DecimalSignString - Return the string for the specified decimal sign
 817 /// attribute.
 818 const char *DecimalSignString(unsigned Sign);
 819
 820 /// EndianityString - Return the string for the specified endianity.
 821 ///
 822 const char *EndianityString(unsigned Endian);
 823
 824 /// AccessibilityString - Return the string for the specified accessibility.
 825 ///
 826 const char *AccessibilityString(unsigned Access);
 827
 828 /// VisibilityString - Return the string for the specified visibility.
 829 ///
 830 const char *VisibilityString(unsigned Visibility);
 831
 832 /// VirtualityString - Return the string for the specified virtuality.
 833 ///
 834 const char *VirtualityString(unsigned Virtuality);
 835
 836 /// LanguageString - Return the string for the specified language.
 837 ///
 838 const char *LanguageString(unsigned Language);
 839
 840 /// CaseString - Return the string for the specified identifier case.
 841 ///
 842 const char *CaseString(unsigned Case);
 843
 844 /// ConventionString - Return the string for the specified calling convention.
 845 ///
 846 const char *ConventionString(unsigned Convention);
 847
 848 /// InlineCodeString - Return the string for the specified inline code.
 849 ///
 850 const char *InlineCodeString(unsigned Code);
 851
 852 /// ArrayOrderString - Return the string for the specified array order.
 853 ///
 854 const char *ArrayOrderString(unsigned Order);
 855
 856 /// DiscriminantString - Return the string for the specified discriminant
 857 /// descriptor.
 858 const char *DiscriminantString(unsigned Discriminant);
 859
 860 /// LNStandardString - Return the string for the specified line number standard.
 861 ///
 862 const char *LNStandardString(unsigned Standard);
 863
 864 /// LNExtendedString - Return the string for the specified line number extended
 865 /// opcode encodings.
 866 const char *LNExtendedString(unsigned Encoding);
 867
 868 /// MacinfoString - Return the string for the specified macinfo type encodings.
 869 ///
 870 const char *MacinfoString(unsigned Encoding);
 871
 872 /// CallFrameString - Return the string for the specified call frame instruction
 873 /// encodings.
 874 const char *CallFrameString(unsigned Encoding);
 875
 876 // Constants for the DWARF5 Accelerator Table Proposal
 877 enum AcceleratorTable {
 878   // Data layout descriptors.
 879   DW_ATOM_null = 0u,       // Marker as the end of a list of atoms.
 880   DW_ATOM_die_offset = 1u, // DIE offset in the debug_info section.
 881   DW_ATOM_cu_offset = 2u, // Offset of the compile unit header that contains the
 882                           // item in question.
 883   DW_ATOM_die_tag = 3u,   // A tag entry.
 884   DW_ATOM_type_flags = 4u, // Set of flags for a type.
 885
 886   // DW_ATOM_type_flags values.
 887
 888   // Always set for C++, only set for ObjC if this is the @implementation for a
 889   // class.
 890   DW_FLAG_type_implementation = 2u,
 891
 892   // Hash functions.
 893
 894   // Daniel J. Bernstein hash.
 895   DW_hash_function_djb = 0u
 896 };
 897
 898 /// AtomTypeString - Return the string for the specified Atom type.
 899 const char *AtomTypeString(unsigned Atom);
 900
 901 // Constants for the GNU pubnames/pubtypes extensions supporting gdb index.
 902 enum GDBIndexEntryKind {
 903   GIEK_NONE,
 904   GIEK_TYPE,
 905   GIEK_VARIABLE,
 906   GIEK_FUNCTION,
 907   GIEK_OTHER,
 908   GIEK_UNUSED5,
 909   GIEK_UNUSED6,
 910   GIEK_UNUSED7
 911 };
 912
 913 const char *GDBIndexEntryKindString(GDBIndexEntryKind Kind);
 914
 915 enum GDBIndexEntryLinkage {
 916   GIEL_EXTERNAL,
 917   GIEL_STATIC
 918 };
 919
 920 const char *GDBIndexEntryLinkageString(GDBIndexEntryLinkage Linkage);
 921
 922 /// The gnu_pub* kind looks like:
 923 ///
 924 /// 0-3  reserved
 925 /// 4-6  symbol kind
 926 /// 7    0 == global, 1 == static
 927 ///
 928 /// A gdb_index descriptor includes the above kind, shifted 24 bits up with the
 929 /// offset of the cu within the debug_info section stored in those 24 bits.
 930 struct PubIndexEntryDescriptor {
 931   GDBIndexEntryKind Kind;
 932   GDBIndexEntryLinkage Linkage;
 933   PubIndexEntryDescriptor(GDBIndexEntryKind Kind, GDBIndexEntryLinkage Linkage)
 934       : Kind(Kind), Linkage(Linkage) {}
 935   /* implicit */ PubIndexEntryDescriptor(GDBIndexEntryKind Kind)
 936       : Kind(Kind), Linkage(GIEL_EXTERNAL) {}
 937   explicit PubIndexEntryDescriptor(uint8_t Value)
 938       : Kind(static_cast<GDBIndexEntryKind>((Value & KIND_MASK) >>
 939                                             KIND_OFFSET)),
 940         Linkage(static_cast<GDBIndexEntryLinkage>((Value & LINKAGE_MASK) >>
 941                                                   LINKAGE_OFFSET)) {}
 942   uint8_t toBits() { return Kind << KIND_OFFSET | Linkage << LINKAGE_OFFSET; }
 943
 944 private:
 945   enum {
 946     KIND_OFFSET = 4,
 947     KIND_MASK = 7 << KIND_OFFSET,
 948     LINKAGE_OFFSET = 7,
 949     LINKAGE_MASK = 1 << LINKAGE_OFFSET
 950   };
 951 };
 952
 953 /// Returns the symbolic string representing Val when used as a value
 954 /// for attribute Attr.
 955 const char *AttributeValueString(uint16_t Attr, unsigned Val);
 956
 957 } // End of namespace dwarf
 958
 959 } // End of namespace llvm
 960
 961 #endif