LLVM API Documentation

Dwarf.h
Go to the documentation of this file.
00001 //===-- llvm/Support/Dwarf.h ---Dwarf Constants------------------*- C++ -*-===//
00002 //
00003 //                     The LLVM Compiler Infrastructure
00004 //
00005 // This file is distributed under the University of Illinois Open Source
00006 // License. See LICENSE.TXT for details.
00007 //
00008 //===----------------------------------------------------------------------===//
00009 //
00010 // This file contains constants used for implementing Dwarf debug support.  For
00011 // Details on the Dwarf 3 specfication see DWARF Debugging Information Format
00012 // V.3 reference manual http://dwarf.freestandards.org ,
00013 //
00014 //===----------------------------------------------------------------------===//
00015 
00016 #ifndef LLVM_SUPPORT_DWARF_H
00017 #define LLVM_SUPPORT_DWARF_H
00018 
00019 #include "llvm/Support/Compiler.h"
00020 #include "llvm/Support/DataTypes.h"
00021 
00022 namespace llvm {
00023 
00024 namespace dwarf {
00025 
00026 //===----------------------------------------------------------------------===//
00027 // Dwarf constants as gleaned from the DWARF Debugging Information Format V.4
00028 // reference manual http://www.dwarfstd.org/.
00029 //
00030 
00031 // Do not mix the following two enumerations sets.  DW_TAG_invalid changes the
00032 // enumeration base type.
00033 
00034 enum LLVMConstants : uint32_t {
00035   // llvm mock tags
00036   DW_TAG_invalid = ~0U, // Tag for invalid results.
00037 
00038   DW_TAG_auto_variable = 0x100, // Tag for local (auto) variables.
00039   DW_TAG_arg_variable = 0x101,  // Tag for argument variables.
00040   DW_TAG_expression = 0x102,    // Tag for complex address expressions.
00041 
00042   DW_TAG_user_base = 0x1000, // Recommended base for user tags.
00043 
00044   DWARF_VERSION = 4,       // Default dwarf version we output.
00045   DW_PUBTYPES_VERSION = 2, // Section version number for .debug_pubtypes.
00046   DW_PUBNAMES_VERSION = 2, // Section version number for .debug_pubnames.
00047   DW_ARANGES_VERSION = 2   // Section version number for .debug_aranges.
00048 };
00049 
00050 // Special ID values that distinguish a CIE from a FDE in DWARF CFI.
00051 // Not inside an enum because a 64-bit value is needed.
00052 const uint32_t DW_CIE_ID = UINT32_MAX;
00053 const uint64_t DW64_CIE_ID = UINT64_MAX;
00054 
00055 enum Tag : uint16_t {
00056   DW_TAG_array_type = 0x01,
00057   DW_TAG_class_type = 0x02,
00058   DW_TAG_entry_point = 0x03,
00059   DW_TAG_enumeration_type = 0x04,
00060   DW_TAG_formal_parameter = 0x05,
00061   DW_TAG_imported_declaration = 0x08,
00062   DW_TAG_label = 0x0a,
00063   DW_TAG_lexical_block = 0x0b,
00064   DW_TAG_member = 0x0d,
00065   DW_TAG_pointer_type = 0x0f,
00066   DW_TAG_reference_type = 0x10,
00067   DW_TAG_compile_unit = 0x11,
00068   DW_TAG_string_type = 0x12,
00069   DW_TAG_structure_type = 0x13,
00070   DW_TAG_subroutine_type = 0x15,
00071   DW_TAG_typedef = 0x16,
00072   DW_TAG_union_type = 0x17,
00073   DW_TAG_unspecified_parameters = 0x18,
00074   DW_TAG_variant = 0x19,
00075   DW_TAG_common_block = 0x1a,
00076   DW_TAG_common_inclusion = 0x1b,
00077   DW_TAG_inheritance = 0x1c,
00078   DW_TAG_inlined_subroutine = 0x1d,
00079   DW_TAG_module = 0x1e,
00080   DW_TAG_ptr_to_member_type = 0x1f,
00081   DW_TAG_set_type = 0x20,
00082   DW_TAG_subrange_type = 0x21,
00083   DW_TAG_with_stmt = 0x22,
00084   DW_TAG_access_declaration = 0x23,
00085   DW_TAG_base_type = 0x24,
00086   DW_TAG_catch_block = 0x25,
00087   DW_TAG_const_type = 0x26,
00088   DW_TAG_constant = 0x27,
00089   DW_TAG_enumerator = 0x28,
00090   DW_TAG_file_type = 0x29,
00091   DW_TAG_friend = 0x2a,
00092   DW_TAG_namelist = 0x2b,
00093   DW_TAG_namelist_item = 0x2c,
00094   DW_TAG_packed_type = 0x2d,
00095   DW_TAG_subprogram = 0x2e,
00096   DW_TAG_template_type_parameter = 0x2f,
00097   DW_TAG_template_value_parameter = 0x30,
00098   DW_TAG_thrown_type = 0x31,
00099   DW_TAG_try_block = 0x32,
00100   DW_TAG_variant_part = 0x33,
00101   DW_TAG_variable = 0x34,
00102   DW_TAG_volatile_type = 0x35,
00103   DW_TAG_dwarf_procedure = 0x36,
00104   DW_TAG_restrict_type = 0x37,
00105   DW_TAG_interface_type = 0x38,
00106   DW_TAG_namespace = 0x39,
00107   DW_TAG_imported_module = 0x3a,
00108   DW_TAG_unspecified_type = 0x3b,
00109   DW_TAG_partial_unit = 0x3c,
00110   DW_TAG_imported_unit = 0x3d,
00111   DW_TAG_condition = 0x3f,
00112   DW_TAG_shared_type = 0x40,
00113   DW_TAG_type_unit = 0x41,
00114   DW_TAG_rvalue_reference_type = 0x42,
00115   DW_TAG_template_alias = 0x43,
00116 
00117   // New in DWARF 5:
00118   DW_TAG_coarray_type = 0x44,
00119   DW_TAG_generic_subrange = 0x45,
00120   DW_TAG_dynamic_type = 0x46,
00121 
00122   DW_TAG_MIPS_loop = 0x4081,
00123   DW_TAG_format_label = 0x4101,
00124   DW_TAG_function_template = 0x4102,
00125   DW_TAG_class_template = 0x4103,
00126   DW_TAG_GNU_template_template_param = 0x4106,
00127   DW_TAG_GNU_template_parameter_pack = 0x4107,
00128   DW_TAG_GNU_formal_parameter_pack = 0x4108,
00129   DW_TAG_lo_user = 0x4080,
00130   DW_TAG_APPLE_property = 0x4200,
00131   DW_TAG_hi_user = 0xffff
00132 };
00133 
00134 inline bool isType(Tag T) {
00135   switch (T) {
00136   case DW_TAG_array_type:
00137   case DW_TAG_class_type:
00138   case DW_TAG_interface_type:
00139   case DW_TAG_enumeration_type:
00140   case DW_TAG_pointer_type:
00141   case DW_TAG_reference_type:
00142   case DW_TAG_rvalue_reference_type:
00143   case DW_TAG_string_type:
00144   case DW_TAG_structure_type:
00145   case DW_TAG_subroutine_type:
00146   case DW_TAG_union_type:
00147   case DW_TAG_ptr_to_member_type:
00148   case DW_TAG_set_type:
00149   case DW_TAG_subrange_type:
00150   case DW_TAG_base_type:
00151   case DW_TAG_const_type:
00152   case DW_TAG_file_type:
00153   case DW_TAG_packed_type:
00154   case DW_TAG_volatile_type:
00155   case DW_TAG_typedef:
00156     return true;
00157   default:
00158     return false;
00159   }
00160 }
00161 
00162 enum Attribute : uint16_t {
00163   // Attributes
00164   DW_AT_sibling = 0x01,
00165   DW_AT_location = 0x02,
00166   DW_AT_name = 0x03,
00167   DW_AT_ordering = 0x09,
00168   DW_AT_byte_size = 0x0b,
00169   DW_AT_bit_offset = 0x0c,
00170   DW_AT_bit_size = 0x0d,
00171   DW_AT_stmt_list = 0x10,
00172   DW_AT_low_pc = 0x11,
00173   DW_AT_high_pc = 0x12,
00174   DW_AT_language = 0x13,
00175   DW_AT_discr = 0x15,
00176   DW_AT_discr_value = 0x16,
00177   DW_AT_visibility = 0x17,
00178   DW_AT_import = 0x18,
00179   DW_AT_string_length = 0x19,
00180   DW_AT_common_reference = 0x1a,
00181   DW_AT_comp_dir = 0x1b,
00182   DW_AT_const_value = 0x1c,
00183   DW_AT_containing_type = 0x1d,
00184   DW_AT_default_value = 0x1e,
00185   DW_AT_inline = 0x20,
00186   DW_AT_is_optional = 0x21,
00187   DW_AT_lower_bound = 0x22,
00188   DW_AT_producer = 0x25,
00189   DW_AT_prototyped = 0x27,
00190   DW_AT_return_addr = 0x2a,
00191   DW_AT_start_scope = 0x2c,
00192   DW_AT_bit_stride = 0x2e,
00193   DW_AT_upper_bound = 0x2f,
00194   DW_AT_abstract_origin = 0x31,
00195   DW_AT_accessibility = 0x32,
00196   DW_AT_address_class = 0x33,
00197   DW_AT_artificial = 0x34,
00198   DW_AT_base_types = 0x35,
00199   DW_AT_calling_convention = 0x36,
00200   DW_AT_count = 0x37,
00201   DW_AT_data_member_location = 0x38,
00202   DW_AT_decl_column = 0x39,
00203   DW_AT_decl_file = 0x3a,
00204   DW_AT_decl_line = 0x3b,
00205   DW_AT_declaration = 0x3c,
00206   DW_AT_discr_list = 0x3d,
00207   DW_AT_encoding = 0x3e,
00208   DW_AT_external = 0x3f,
00209   DW_AT_frame_base = 0x40,
00210   DW_AT_friend = 0x41,
00211   DW_AT_identifier_case = 0x42,
00212   DW_AT_macro_info = 0x43,
00213   DW_AT_namelist_item = 0x44,
00214   DW_AT_priority = 0x45,
00215   DW_AT_segment = 0x46,
00216   DW_AT_specification = 0x47,
00217   DW_AT_static_link = 0x48,
00218   DW_AT_type = 0x49,
00219   DW_AT_use_location = 0x4a,
00220   DW_AT_variable_parameter = 0x4b,
00221   DW_AT_virtuality = 0x4c,
00222   DW_AT_vtable_elem_location = 0x4d,
00223   DW_AT_allocated = 0x4e,
00224   DW_AT_associated = 0x4f,
00225   DW_AT_data_location = 0x50,
00226   DW_AT_byte_stride = 0x51,
00227   DW_AT_entry_pc = 0x52,
00228   DW_AT_use_UTF8 = 0x53,
00229   DW_AT_extension = 0x54,
00230   DW_AT_ranges = 0x55,
00231   DW_AT_trampoline = 0x56,
00232   DW_AT_call_column = 0x57,
00233   DW_AT_call_file = 0x58,
00234   DW_AT_call_line = 0x59,
00235   DW_AT_description = 0x5a,
00236   DW_AT_binary_scale = 0x5b,
00237   DW_AT_decimal_scale = 0x5c,
00238   DW_AT_small = 0x5d,
00239   DW_AT_decimal_sign = 0x5e,
00240   DW_AT_digit_count = 0x5f,
00241   DW_AT_picture_string = 0x60,
00242   DW_AT_mutable = 0x61,
00243   DW_AT_threads_scaled = 0x62,
00244   DW_AT_explicit = 0x63,
00245   DW_AT_object_pointer = 0x64,
00246   DW_AT_endianity = 0x65,
00247   DW_AT_elemental = 0x66,
00248   DW_AT_pure = 0x67,
00249   DW_AT_recursive = 0x68,
00250   DW_AT_signature = 0x69,
00251   DW_AT_main_subprogram = 0x6a,
00252   DW_AT_data_bit_offset = 0x6b,
00253   DW_AT_const_expr = 0x6c,
00254   DW_AT_enum_class = 0x6d,
00255   DW_AT_linkage_name = 0x6e,
00256 
00257   // New in DWARF 5:
00258   DW_AT_string_length_bit_size = 0x6f,
00259   DW_AT_string_length_byte_size = 0x70,
00260   DW_AT_rank = 0x71,
00261   DW_AT_str_offsets_base = 0x72,
00262   DW_AT_addr_base = 0x73,
00263   DW_AT_ranges_base = 0x74,
00264   DW_AT_dwo_id = 0x75,
00265   DW_AT_dwo_name = 0x76,
00266   DW_AT_reference = 0x77,
00267   DW_AT_rvalue_reference = 0x78,
00268 
00269   DW_AT_lo_user = 0x2000,
00270   DW_AT_hi_user = 0x3fff,
00271 
00272   DW_AT_MIPS_loop_begin = 0x2002,
00273   DW_AT_MIPS_tail_loop_begin = 0x2003,
00274   DW_AT_MIPS_epilog_begin = 0x2004,
00275   DW_AT_MIPS_loop_unroll_factor = 0x2005,
00276   DW_AT_MIPS_software_pipeline_depth = 0x2006,
00277   DW_AT_MIPS_linkage_name = 0x2007,
00278   DW_AT_MIPS_stride = 0x2008,
00279   DW_AT_MIPS_abstract_name = 0x2009,
00280   DW_AT_MIPS_clone_origin = 0x200a,
00281   DW_AT_MIPS_has_inlines = 0x200b,
00282   DW_AT_MIPS_stride_byte = 0x200c,
00283   DW_AT_MIPS_stride_elem = 0x200d,
00284   DW_AT_MIPS_ptr_dopetype = 0x200e,
00285   DW_AT_MIPS_allocatable_dopetype = 0x200f,
00286   DW_AT_MIPS_assumed_shape_dopetype = 0x2010,
00287 
00288   // This one appears to have only been implemented by Open64 for
00289   // fortran and may conflict with other extensions.
00290   DW_AT_MIPS_assumed_size = 0x2011,
00291 
00292   // GNU extensions
00293   DW_AT_sf_names = 0x2101,
00294   DW_AT_src_info = 0x2102,
00295   DW_AT_mac_info = 0x2103,
00296   DW_AT_src_coords = 0x2104,
00297   DW_AT_body_begin = 0x2105,
00298   DW_AT_body_end = 0x2106,
00299   DW_AT_GNU_vector = 0x2107,
00300   DW_AT_GNU_template_name = 0x2110,
00301 
00302   DW_AT_GNU_odr_signature = 0x210f,
00303 
00304   // Extensions for Fission proposal.
00305   DW_AT_GNU_dwo_name = 0x2130,
00306   DW_AT_GNU_dwo_id = 0x2131,
00307   DW_AT_GNU_ranges_base = 0x2132,
00308   DW_AT_GNU_addr_base = 0x2133,
00309   DW_AT_GNU_pubnames = 0x2134,
00310   DW_AT_GNU_pubtypes = 0x2135,
00311 
00312   // Apple extensions.
00313   DW_AT_APPLE_optimized = 0x3fe1,
00314   DW_AT_APPLE_flags = 0x3fe2,
00315   DW_AT_APPLE_isa = 0x3fe3,
00316   DW_AT_APPLE_block = 0x3fe4,
00317   DW_AT_APPLE_major_runtime_vers = 0x3fe5,
00318   DW_AT_APPLE_runtime_class = 0x3fe6,
00319   DW_AT_APPLE_omit_frame_ptr = 0x3fe7,
00320   DW_AT_APPLE_property_name = 0x3fe8,
00321   DW_AT_APPLE_property_getter = 0x3fe9,
00322   DW_AT_APPLE_property_setter = 0x3fea,
00323   DW_AT_APPLE_property_attribute = 0x3feb,
00324   DW_AT_APPLE_objc_complete_type = 0x3fec,
00325   DW_AT_APPLE_property = 0x3fed
00326 };
00327 
00328 enum Form : uint16_t {
00329   // Attribute form encodings
00330   DW_FORM_addr = 0x01,
00331   DW_FORM_block2 = 0x03,
00332   DW_FORM_block4 = 0x04,
00333   DW_FORM_data2 = 0x05,
00334   DW_FORM_data4 = 0x06,
00335   DW_FORM_data8 = 0x07,
00336   DW_FORM_string = 0x08,
00337   DW_FORM_block = 0x09,
00338   DW_FORM_block1 = 0x0a,
00339   DW_FORM_data1 = 0x0b,
00340   DW_FORM_flag = 0x0c,
00341   DW_FORM_sdata = 0x0d,
00342   DW_FORM_strp = 0x0e,
00343   DW_FORM_udata = 0x0f,
00344   DW_FORM_ref_addr = 0x10,
00345   DW_FORM_ref1 = 0x11,
00346   DW_FORM_ref2 = 0x12,
00347   DW_FORM_ref4 = 0x13,
00348   DW_FORM_ref8 = 0x14,
00349   DW_FORM_ref_udata = 0x15,
00350   DW_FORM_indirect = 0x16,
00351   DW_FORM_sec_offset = 0x17,
00352   DW_FORM_exprloc = 0x18,
00353   DW_FORM_flag_present = 0x19,
00354   DW_FORM_ref_sig8 = 0x20,
00355 
00356   // Extensions for Fission proposal
00357   DW_FORM_GNU_addr_index = 0x1f01,
00358   DW_FORM_GNU_str_index = 0x1f02
00359 };
00360 
00361 enum LocationAtom {
00362   // Operation encodings
00363   DW_OP_addr = 0x03,
00364   DW_OP_deref = 0x06,
00365   DW_OP_const1u = 0x08,
00366   DW_OP_const1s = 0x09,
00367   DW_OP_const2u = 0x0a,
00368   DW_OP_const2s = 0x0b,
00369   DW_OP_const4u = 0x0c,
00370   DW_OP_const4s = 0x0d,
00371   DW_OP_const8u = 0x0e,
00372   DW_OP_const8s = 0x0f,
00373   DW_OP_constu = 0x10,
00374   DW_OP_consts = 0x11,
00375   DW_OP_dup = 0x12,
00376   DW_OP_drop = 0x13,
00377   DW_OP_over = 0x14,
00378   DW_OP_pick = 0x15,
00379   DW_OP_swap = 0x16,
00380   DW_OP_rot = 0x17,
00381   DW_OP_xderef = 0x18,
00382   DW_OP_abs = 0x19,
00383   DW_OP_and = 0x1a,
00384   DW_OP_div = 0x1b,
00385   DW_OP_minus = 0x1c,
00386   DW_OP_mod = 0x1d,
00387   DW_OP_mul = 0x1e,
00388   DW_OP_neg = 0x1f,
00389   DW_OP_not = 0x20,
00390   DW_OP_or = 0x21,
00391   DW_OP_plus = 0x22,
00392   DW_OP_plus_uconst = 0x23,
00393   DW_OP_shl = 0x24,
00394   DW_OP_shr = 0x25,
00395   DW_OP_shra = 0x26,
00396   DW_OP_xor = 0x27,
00397   DW_OP_skip = 0x2f,
00398   DW_OP_bra = 0x28,
00399   DW_OP_eq = 0x29,
00400   DW_OP_ge = 0x2a,
00401   DW_OP_gt = 0x2b,
00402   DW_OP_le = 0x2c,
00403   DW_OP_lt = 0x2d,
00404   DW_OP_ne = 0x2e,
00405   DW_OP_lit0 = 0x30,
00406   DW_OP_lit1 = 0x31,
00407   DW_OP_lit2 = 0x32,
00408   DW_OP_lit3 = 0x33,
00409   DW_OP_lit4 = 0x34,
00410   DW_OP_lit5 = 0x35,
00411   DW_OP_lit6 = 0x36,
00412   DW_OP_lit7 = 0x37,
00413   DW_OP_lit8 = 0x38,
00414   DW_OP_lit9 = 0x39,
00415   DW_OP_lit10 = 0x3a,
00416   DW_OP_lit11 = 0x3b,
00417   DW_OP_lit12 = 0x3c,
00418   DW_OP_lit13 = 0x3d,
00419   DW_OP_lit14 = 0x3e,
00420   DW_OP_lit15 = 0x3f,
00421   DW_OP_lit16 = 0x40,
00422   DW_OP_lit17 = 0x41,
00423   DW_OP_lit18 = 0x42,
00424   DW_OP_lit19 = 0x43,
00425   DW_OP_lit20 = 0x44,
00426   DW_OP_lit21 = 0x45,
00427   DW_OP_lit22 = 0x46,
00428   DW_OP_lit23 = 0x47,
00429   DW_OP_lit24 = 0x48,
00430   DW_OP_lit25 = 0x49,
00431   DW_OP_lit26 = 0x4a,
00432   DW_OP_lit27 = 0x4b,
00433   DW_OP_lit28 = 0x4c,
00434   DW_OP_lit29 = 0x4d,
00435   DW_OP_lit30 = 0x4e,
00436   DW_OP_lit31 = 0x4f,
00437   DW_OP_reg0 = 0x50,
00438   DW_OP_reg1 = 0x51,
00439   DW_OP_reg2 = 0x52,
00440   DW_OP_reg3 = 0x53,
00441   DW_OP_reg4 = 0x54,
00442   DW_OP_reg5 = 0x55,
00443   DW_OP_reg6 = 0x56,
00444   DW_OP_reg7 = 0x57,
00445   DW_OP_reg8 = 0x58,
00446   DW_OP_reg9 = 0x59,
00447   DW_OP_reg10 = 0x5a,
00448   DW_OP_reg11 = 0x5b,
00449   DW_OP_reg12 = 0x5c,
00450   DW_OP_reg13 = 0x5d,
00451   DW_OP_reg14 = 0x5e,
00452   DW_OP_reg15 = 0x5f,
00453   DW_OP_reg16 = 0x60,
00454   DW_OP_reg17 = 0x61,
00455   DW_OP_reg18 = 0x62,
00456   DW_OP_reg19 = 0x63,
00457   DW_OP_reg20 = 0x64,
00458   DW_OP_reg21 = 0x65,
00459   DW_OP_reg22 = 0x66,
00460   DW_OP_reg23 = 0x67,
00461   DW_OP_reg24 = 0x68,
00462   DW_OP_reg25 = 0x69,
00463   DW_OP_reg26 = 0x6a,
00464   DW_OP_reg27 = 0x6b,
00465   DW_OP_reg28 = 0x6c,
00466   DW_OP_reg29 = 0x6d,
00467   DW_OP_reg30 = 0x6e,
00468   DW_OP_reg31 = 0x6f,
00469   DW_OP_breg0 = 0x70,
00470   DW_OP_breg1 = 0x71,
00471   DW_OP_breg2 = 0x72,
00472   DW_OP_breg3 = 0x73,
00473   DW_OP_breg4 = 0x74,
00474   DW_OP_breg5 = 0x75,
00475   DW_OP_breg6 = 0x76,
00476   DW_OP_breg7 = 0x77,
00477   DW_OP_breg8 = 0x78,
00478   DW_OP_breg9 = 0x79,
00479   DW_OP_breg10 = 0x7a,
00480   DW_OP_breg11 = 0x7b,
00481   DW_OP_breg12 = 0x7c,
00482   DW_OP_breg13 = 0x7d,
00483   DW_OP_breg14 = 0x7e,
00484   DW_OP_breg15 = 0x7f,
00485   DW_OP_breg16 = 0x80,
00486   DW_OP_breg17 = 0x81,
00487   DW_OP_breg18 = 0x82,
00488   DW_OP_breg19 = 0x83,
00489   DW_OP_breg20 = 0x84,
00490   DW_OP_breg21 = 0x85,
00491   DW_OP_breg22 = 0x86,
00492   DW_OP_breg23 = 0x87,
00493   DW_OP_breg24 = 0x88,
00494   DW_OP_breg25 = 0x89,
00495   DW_OP_breg26 = 0x8a,
00496   DW_OP_breg27 = 0x8b,
00497   DW_OP_breg28 = 0x8c,
00498   DW_OP_breg29 = 0x8d,
00499   DW_OP_breg30 = 0x8e,
00500   DW_OP_breg31 = 0x8f,
00501   DW_OP_regx = 0x90,
00502   DW_OP_fbreg = 0x91,
00503   DW_OP_bregx = 0x92,
00504   DW_OP_piece = 0x93,
00505   DW_OP_deref_size = 0x94,
00506   DW_OP_xderef_size = 0x95,
00507   DW_OP_nop = 0x96,
00508   DW_OP_push_object_address = 0x97,
00509   DW_OP_call2 = 0x98,
00510   DW_OP_call4 = 0x99,
00511   DW_OP_call_ref = 0x9a,
00512   DW_OP_form_tls_address = 0x9b,
00513   DW_OP_call_frame_cfa = 0x9c,
00514   DW_OP_bit_piece = 0x9d,
00515   DW_OP_implicit_value = 0x9e,
00516   DW_OP_stack_value = 0x9f,
00517   DW_OP_lo_user = 0xe0,
00518   DW_OP_hi_user = 0xff,
00519 
00520   // Extensions for GNU-style thread-local storage.
00521   DW_OP_GNU_push_tls_address = 0xe0,
00522 
00523   // Extensions for Fission proposal.
00524   DW_OP_GNU_addr_index = 0xfb,
00525   DW_OP_GNU_const_index = 0xfc
00526 };
00527 
00528 enum TypeKind {
00529   // Encoding attribute values
00530   DW_ATE_address = 0x01,
00531   DW_ATE_boolean = 0x02,
00532   DW_ATE_complex_float = 0x03,
00533   DW_ATE_float = 0x04,
00534   DW_ATE_signed = 0x05,
00535   DW_ATE_signed_char = 0x06,
00536   DW_ATE_unsigned = 0x07,
00537   DW_ATE_unsigned_char = 0x08,
00538   DW_ATE_imaginary_float = 0x09,
00539   DW_ATE_packed_decimal = 0x0a,
00540   DW_ATE_numeric_string = 0x0b,
00541   DW_ATE_edited = 0x0c,
00542   DW_ATE_signed_fixed = 0x0d,
00543   DW_ATE_unsigned_fixed = 0x0e,
00544   DW_ATE_decimal_float = 0x0f,
00545   DW_ATE_UTF = 0x10,
00546   DW_ATE_lo_user = 0x80,
00547   DW_ATE_hi_user = 0xff
00548 };
00549 
00550 enum DecimalSignEncoding {
00551   // Decimal sign attribute values
00552   DW_DS_unsigned = 0x01,
00553   DW_DS_leading_overpunch = 0x02,
00554   DW_DS_trailing_overpunch = 0x03,
00555   DW_DS_leading_separate = 0x04,
00556   DW_DS_trailing_separate = 0x05
00557 };
00558 
00559 enum EndianityEncoding {
00560   // Endianity attribute values
00561   DW_END_default = 0x00,
00562   DW_END_big = 0x01,
00563   DW_END_little = 0x02,
00564   DW_END_lo_user = 0x40,
00565   DW_END_hi_user = 0xff
00566 };
00567 
00568 enum AccessAttribute {
00569   // Accessibility codes
00570   DW_ACCESS_public = 0x01,
00571   DW_ACCESS_protected = 0x02,
00572   DW_ACCESS_private = 0x03
00573 };
00574 
00575 enum VisibilityAttribute {
00576   // Visibility codes
00577   DW_VIS_local = 0x01,
00578   DW_VIS_exported = 0x02,
00579   DW_VIS_qualified = 0x03
00580 };
00581 
00582 enum VirtualityAttribute {
00583   // Virtuality codes
00584   DW_VIRTUALITY_none = 0x00,
00585   DW_VIRTUALITY_virtual = 0x01,
00586   DW_VIRTUALITY_pure_virtual = 0x02
00587 };
00588 
00589 enum SourceLanguage {
00590   // Language names
00591   DW_LANG_C89 = 0x0001,
00592   DW_LANG_C = 0x0002,
00593   DW_LANG_Ada83 = 0x0003,
00594   DW_LANG_C_plus_plus = 0x0004,
00595   DW_LANG_Cobol74 = 0x0005,
00596   DW_LANG_Cobol85 = 0x0006,
00597   DW_LANG_Fortran77 = 0x0007,
00598   DW_LANG_Fortran90 = 0x0008,
00599   DW_LANG_Pascal83 = 0x0009,
00600   DW_LANG_Modula2 = 0x000a,
00601   DW_LANG_Java = 0x000b,
00602   DW_LANG_C99 = 0x000c,
00603   DW_LANG_Ada95 = 0x000d,
00604   DW_LANG_Fortran95 = 0x000e,
00605   DW_LANG_PLI = 0x000f,
00606   DW_LANG_ObjC = 0x0010,
00607   DW_LANG_ObjC_plus_plus = 0x0011,
00608   DW_LANG_UPC = 0x0012,
00609   DW_LANG_D = 0x0013,
00610   // New in DWARF 5:
00611   DW_LANG_Python = 0x0014,
00612   DW_LANG_OpenCL = 0x0015,
00613   DW_LANG_Go = 0x0016,
00614   DW_LANG_Modula3 = 0x0017,
00615   DW_LANG_Haskell = 0x0018,
00616   DW_LANG_C_plus_plus_03 = 0x0019,
00617   DW_LANG_C_plus_plus_11 = 0x001a,
00618   DW_LANG_OCaml = 0x001b,
00619 
00620   DW_LANG_lo_user = 0x8000,
00621   DW_LANG_Mips_Assembler = 0x8001,
00622   DW_LANG_hi_user = 0xffff
00623 };
00624 
00625 enum CaseSensitivity {
00626   // Identifier case codes
00627   DW_ID_case_sensitive = 0x00,
00628   DW_ID_up_case = 0x01,
00629   DW_ID_down_case = 0x02,
00630   DW_ID_case_insensitive = 0x03
00631 };
00632 
00633 enum CallingConvention {
00634   // Calling convention codes
00635   DW_CC_normal = 0x01,
00636   DW_CC_program = 0x02,
00637   DW_CC_nocall = 0x03,
00638   DW_CC_lo_user = 0x40,
00639   DW_CC_hi_user = 0xff
00640 };
00641 
00642 enum InlineAttribute {
00643   // Inline codes
00644   DW_INL_not_inlined = 0x00,
00645   DW_INL_inlined = 0x01,
00646   DW_INL_declared_not_inlined = 0x02,
00647   DW_INL_declared_inlined = 0x03
00648 };
00649 
00650 enum ArrayDimensionOrdering {
00651   // Array ordering
00652   DW_ORD_row_major = 0x00,
00653   DW_ORD_col_major = 0x01
00654 };
00655 
00656 enum DiscriminantList {
00657   // Discriminant descriptor values
00658   DW_DSC_label = 0x00,
00659   DW_DSC_range = 0x01
00660 };
00661 
00662 enum LineNumberOps {
00663   // Line Number Standard Opcode Encodings
00664   DW_LNS_extended_op = 0x00,
00665   DW_LNS_copy = 0x01,
00666   DW_LNS_advance_pc = 0x02,
00667   DW_LNS_advance_line = 0x03,
00668   DW_LNS_set_file = 0x04,
00669   DW_LNS_set_column = 0x05,
00670   DW_LNS_negate_stmt = 0x06,
00671   DW_LNS_set_basic_block = 0x07,
00672   DW_LNS_const_add_pc = 0x08,
00673   DW_LNS_fixed_advance_pc = 0x09,
00674   DW_LNS_set_prologue_end = 0x0a,
00675   DW_LNS_set_epilogue_begin = 0x0b,
00676   DW_LNS_set_isa = 0x0c
00677 };
00678 
00679 enum LineNumberExtendedOps {
00680   // Line Number Extended Opcode Encodings
00681   DW_LNE_end_sequence = 0x01,
00682   DW_LNE_set_address = 0x02,
00683   DW_LNE_define_file = 0x03,
00684   DW_LNE_set_discriminator = 0x04,
00685   DW_LNE_lo_user = 0x80,
00686   DW_LNE_hi_user = 0xff
00687 };
00688 
00689 enum MacinfoRecordType {
00690   // Macinfo Type Encodings
00691   DW_MACINFO_define = 0x01,
00692   DW_MACINFO_undef = 0x02,
00693   DW_MACINFO_start_file = 0x03,
00694   DW_MACINFO_end_file = 0x04,
00695   DW_MACINFO_vendor_ext = 0xff
00696 };
00697 
00698 enum CallFrameInfo {
00699   // Call frame instruction encodings
00700   DW_CFA_extended = 0x00,
00701   DW_CFA_nop = 0x00,
00702   DW_CFA_advance_loc = 0x40,
00703   DW_CFA_offset = 0x80,
00704   DW_CFA_restore = 0xc0,
00705   DW_CFA_set_loc = 0x01,
00706   DW_CFA_advance_loc1 = 0x02,
00707   DW_CFA_advance_loc2 = 0x03,
00708   DW_CFA_advance_loc4 = 0x04,
00709   DW_CFA_offset_extended = 0x05,
00710   DW_CFA_restore_extended = 0x06,
00711   DW_CFA_undefined = 0x07,
00712   DW_CFA_same_value = 0x08,
00713   DW_CFA_register = 0x09,
00714   DW_CFA_remember_state = 0x0a,
00715   DW_CFA_restore_state = 0x0b,
00716   DW_CFA_def_cfa = 0x0c,
00717   DW_CFA_def_cfa_register = 0x0d,
00718   DW_CFA_def_cfa_offset = 0x0e,
00719   DW_CFA_def_cfa_expression = 0x0f,
00720   DW_CFA_expression = 0x10,
00721   DW_CFA_offset_extended_sf = 0x11,
00722   DW_CFA_def_cfa_sf = 0x12,
00723   DW_CFA_def_cfa_offset_sf = 0x13,
00724   DW_CFA_val_offset = 0x14,
00725   DW_CFA_val_offset_sf = 0x15,
00726   DW_CFA_val_expression = 0x16,
00727   DW_CFA_MIPS_advance_loc8 = 0x1d,
00728   DW_CFA_GNU_window_save = 0x2d,
00729   DW_CFA_GNU_args_size = 0x2e,
00730   DW_CFA_lo_user = 0x1c,
00731   DW_CFA_hi_user = 0x3f
00732 };
00733 
00734 enum Constants {
00735   // Children flag
00736   DW_CHILDREN_no = 0x00,
00737   DW_CHILDREN_yes = 0x01,
00738 
00739   DW_EH_PE_absptr = 0x00,
00740   DW_EH_PE_omit = 0xff,
00741   DW_EH_PE_uleb128 = 0x01,
00742   DW_EH_PE_udata2 = 0x02,
00743   DW_EH_PE_udata4 = 0x03,
00744   DW_EH_PE_udata8 = 0x04,
00745   DW_EH_PE_sleb128 = 0x09,
00746   DW_EH_PE_sdata2 = 0x0A,
00747   DW_EH_PE_sdata4 = 0x0B,
00748   DW_EH_PE_sdata8 = 0x0C,
00749   DW_EH_PE_signed = 0x08,
00750   DW_EH_PE_pcrel = 0x10,
00751   DW_EH_PE_textrel = 0x20,
00752   DW_EH_PE_datarel = 0x30,
00753   DW_EH_PE_funcrel = 0x40,
00754   DW_EH_PE_aligned = 0x50,
00755   DW_EH_PE_indirect = 0x80
00756 };
00757 
00758 // Constants for debug_loc.dwo in the DWARF5 Split Debug Info Proposal
00759 enum LocationListEntry : unsigned char {
00760   DW_LLE_end_of_list_entry,
00761   DW_LLE_base_address_selection_entry,
00762   DW_LLE_start_end_entry,
00763   DW_LLE_start_length_entry,
00764   DW_LLE_offset_pair_entry
00765 };
00766 
00767 /// Contstants for the DW_APPLE_PROPERTY_attributes attribute.
00768 /// Keep this list in sync with clang's DeclSpec.h ObjCPropertyAttributeKind.
00769 enum ApplePropertyAttributes {
00770   // Apple Objective-C Property Attributes
00771   DW_APPLE_PROPERTY_readonly = 0x01,
00772   DW_APPLE_PROPERTY_getter = 0x02,
00773   DW_APPLE_PROPERTY_assign = 0x04,
00774   DW_APPLE_PROPERTY_readwrite = 0x08,
00775   DW_APPLE_PROPERTY_retain = 0x10,
00776   DW_APPLE_PROPERTY_copy = 0x20,
00777   DW_APPLE_PROPERTY_nonatomic = 0x40,
00778   DW_APPLE_PROPERTY_setter = 0x80,
00779   DW_APPLE_PROPERTY_atomic = 0x100,
00780   DW_APPLE_PROPERTY_weak =   0x200,
00781   DW_APPLE_PROPERTY_strong = 0x400,
00782   DW_APPLE_PROPERTY_unsafe_unretained = 0x800
00783 };
00784 
00785 /// TagString - Return the string for the specified tag.
00786 ///
00787 const char *TagString(unsigned Tag);
00788 
00789 /// ChildrenString - Return the string for the specified children flag.
00790 ///
00791 const char *ChildrenString(unsigned Children);
00792 
00793 /// AttributeString - Return the string for the specified attribute.
00794 ///
00795 const char *AttributeString(unsigned Attribute);
00796 
00797 /// FormEncodingString - Return the string for the specified form encoding.
00798 ///
00799 const char *FormEncodingString(unsigned Encoding);
00800 
00801 /// OperationEncodingString - Return the string for the specified operation
00802 /// encoding.
00803 const char *OperationEncodingString(unsigned Encoding);
00804 
00805 /// AttributeEncodingString - Return the string for the specified attribute
00806 /// encoding.
00807 const char *AttributeEncodingString(unsigned Encoding);
00808 
00809 /// DecimalSignString - Return the string for the specified decimal sign
00810 /// attribute.
00811 const char *DecimalSignString(unsigned Sign);
00812 
00813 /// EndianityString - Return the string for the specified endianity.
00814 ///
00815 const char *EndianityString(unsigned Endian);
00816 
00817 /// AccessibilityString - Return the string for the specified accessibility.
00818 ///
00819 const char *AccessibilityString(unsigned Access);
00820 
00821 /// VisibilityString - Return the string for the specified visibility.
00822 ///
00823 const char *VisibilityString(unsigned Visibility);
00824 
00825 /// VirtualityString - Return the string for the specified virtuality.
00826 ///
00827 const char *VirtualityString(unsigned Virtuality);
00828 
00829 /// LanguageString - Return the string for the specified language.
00830 ///
00831 const char *LanguageString(unsigned Language);
00832 
00833 /// CaseString - Return the string for the specified identifier case.
00834 ///
00835 const char *CaseString(unsigned Case);
00836 
00837 /// ConventionString - Return the string for the specified calling convention.
00838 ///
00839 const char *ConventionString(unsigned Convention);
00840 
00841 /// InlineCodeString - Return the string for the specified inline code.
00842 ///
00843 const char *InlineCodeString(unsigned Code);
00844 
00845 /// ArrayOrderString - Return the string for the specified array order.
00846 ///
00847 const char *ArrayOrderString(unsigned Order);
00848 
00849 /// DiscriminantString - Return the string for the specified discriminant
00850 /// descriptor.
00851 const char *DiscriminantString(unsigned Discriminant);
00852 
00853 /// LNStandardString - Return the string for the specified line number standard.
00854 ///
00855 const char *LNStandardString(unsigned Standard);
00856 
00857 /// LNExtendedString - Return the string for the specified line number extended
00858 /// opcode encodings.
00859 const char *LNExtendedString(unsigned Encoding);
00860 
00861 /// MacinfoString - Return the string for the specified macinfo type encodings.
00862 ///
00863 const char *MacinfoString(unsigned Encoding);
00864 
00865 /// CallFrameString - Return the string for the specified call frame instruction
00866 /// encodings.
00867 const char *CallFrameString(unsigned Encoding);
00868 
00869 /// ApplePropertyString - Return the string for the specified Apple
00870 /// property bit. This function is meant to return the symbolic name
00871 /// for 1 bit of the DW_AT_APPLE_property attribute, not for the whole attribute.
00872 const char *ApplePropertyString(unsigned);
00873 
00874 // Constants for the DWARF5 Accelerator Table Proposal
00875 enum AcceleratorTable {
00876   // Data layout descriptors.
00877   DW_ATOM_null = 0u,       // Marker as the end of a list of atoms.
00878   DW_ATOM_die_offset = 1u, // DIE offset in the debug_info section.
00879   DW_ATOM_cu_offset = 2u, // Offset of the compile unit header that contains the
00880                           // item in question.
00881   DW_ATOM_die_tag = 3u,   // A tag entry.
00882   DW_ATOM_type_flags = 4u, // Set of flags for a type.
00883 
00884   // DW_ATOM_type_flags values.
00885 
00886   // Always set for C++, only set for ObjC if this is the @implementation for a
00887   // class.
00888   DW_FLAG_type_implementation = 2u,
00889 
00890   // Hash functions.
00891 
00892   // Daniel J. Bernstein hash.
00893   DW_hash_function_djb = 0u
00894 };
00895 
00896 /// AtomTypeString - Return the string for the specified Atom type.
00897 const char *AtomTypeString(unsigned Atom);
00898 
00899 // Constants for the GNU pubnames/pubtypes extensions supporting gdb index.
00900 enum GDBIndexEntryKind {
00901   GIEK_NONE,
00902   GIEK_TYPE,
00903   GIEK_VARIABLE,
00904   GIEK_FUNCTION,
00905   GIEK_OTHER,
00906   GIEK_UNUSED5,
00907   GIEK_UNUSED6,
00908   GIEK_UNUSED7
00909 };
00910 
00911 const char *GDBIndexEntryKindString(GDBIndexEntryKind Kind);
00912 
00913 enum GDBIndexEntryLinkage {
00914   GIEL_EXTERNAL,
00915   GIEL_STATIC
00916 };
00917 
00918 const char *GDBIndexEntryLinkageString(GDBIndexEntryLinkage Linkage);
00919 
00920 /// The gnu_pub* kind looks like:
00921 ///
00922 /// 0-3  reserved
00923 /// 4-6  symbol kind
00924 /// 7    0 == global, 1 == static
00925 ///
00926 /// A gdb_index descriptor includes the above kind, shifted 24 bits up with the
00927 /// offset of the cu within the debug_info section stored in those 24 bits.
00928 struct PubIndexEntryDescriptor {
00929   GDBIndexEntryKind Kind;
00930   GDBIndexEntryLinkage Linkage;
00931   PubIndexEntryDescriptor(GDBIndexEntryKind Kind, GDBIndexEntryLinkage Linkage)
00932       : Kind(Kind), Linkage(Linkage) {}
00933   /* implicit */ PubIndexEntryDescriptor(GDBIndexEntryKind Kind)
00934       : Kind(Kind), Linkage(GIEL_EXTERNAL) {}
00935   explicit PubIndexEntryDescriptor(uint8_t Value)
00936       : Kind(static_cast<GDBIndexEntryKind>((Value & KIND_MASK) >>
00937                                             KIND_OFFSET)),
00938         Linkage(static_cast<GDBIndexEntryLinkage>((Value & LINKAGE_MASK) >>
00939                                                   LINKAGE_OFFSET)) {}
00940   uint8_t toBits() { return Kind << KIND_OFFSET | Linkage << LINKAGE_OFFSET; }
00941 
00942 private:
00943   enum {
00944     KIND_OFFSET = 4,
00945     KIND_MASK = 7 << KIND_OFFSET,
00946     LINKAGE_OFFSET = 7,
00947     LINKAGE_MASK = 1 << LINKAGE_OFFSET
00948   };
00949 };
00950 
00951 /// Returns the symbolic string representing Val when used as a value
00952 /// for attribute Attr.
00953 const char *AttributeValueString(uint16_t Attr, unsigned Val);
00954 
00955 } // End of namespace dwarf
00956 
00957 } // End of namespace llvm
00958 
00959 #endif