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