1 //===-- llvm/Support/Dwarf.h ---Dwarf Constants------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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 ,
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_SUPPORT_DWARF_H
17 #define LLVM_SUPPORT_DWARF_H
19 #include "llvm/Support/Compiler.h"
20 #include "llvm/Support/DataTypes.h"
24 //===----------------------------------------------------------------------===//
25 // Debug info constants.
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.
42 //===----------------------------------------------------------------------===//
43 // Dwarf constants as gleaned from the DWARF Debugging Information Format V.4
44 // reference manual http://www.dwarfstd.org/.
47 // Do not mix the following two enumerations sets. DW_TAG_invalid changes the
48 // enumeration base type.
50 enum LLVMConstants : uint32_t {
52 DW_TAG_invalid = ~0U, // Tag for invalid results.
54 DW_TAG_auto_variable = 0x100, // Tag for local (auto) variables.
55 DW_TAG_arg_variable = 0x101, // Tag for argument variables.
56 DW_TAG_expression = 0x102, // Tag for complex address expressions.
58 DW_TAG_user_base = 0x1000, // Recommended base for user tags.
60 DWARF_VERSION = 4, // Default dwarf version we output.
61 DW_PUBTYPES_VERSION = 2, // Section version number for .debug_pubtypes.
62 DW_PUBNAMES_VERSION = 2, // Section version number for .debug_pubnames.
63 DW_ARANGES_VERSION = 2 // Section version number for .debug_aranges.
66 // Special ID values that distinguish a CIE from a FDE in DWARF CFI.
67 // Not inside an enum because a 64-bit value is needed.
68 const uint32_t DW_CIE_ID = UINT32_MAX;
69 const uint64_t DW64_CIE_ID = UINT64_MAX;
72 DW_TAG_array_type = 0x01,
73 DW_TAG_class_type = 0x02,
74 DW_TAG_entry_point = 0x03,
75 DW_TAG_enumeration_type = 0x04,
76 DW_TAG_formal_parameter = 0x05,
77 DW_TAG_imported_declaration = 0x08,
79 DW_TAG_lexical_block = 0x0b,
81 DW_TAG_pointer_type = 0x0f,
82 DW_TAG_reference_type = 0x10,
83 DW_TAG_compile_unit = 0x11,
84 DW_TAG_string_type = 0x12,
85 DW_TAG_structure_type = 0x13,
86 DW_TAG_subroutine_type = 0x15,
87 DW_TAG_typedef = 0x16,
88 DW_TAG_union_type = 0x17,
89 DW_TAG_unspecified_parameters = 0x18,
90 DW_TAG_variant = 0x19,
91 DW_TAG_common_block = 0x1a,
92 DW_TAG_common_inclusion = 0x1b,
93 DW_TAG_inheritance = 0x1c,
94 DW_TAG_inlined_subroutine = 0x1d,
96 DW_TAG_ptr_to_member_type = 0x1f,
97 DW_TAG_set_type = 0x20,
98 DW_TAG_subrange_type = 0x21,
99 DW_TAG_with_stmt = 0x22,
100 DW_TAG_access_declaration = 0x23,
101 DW_TAG_base_type = 0x24,
102 DW_TAG_catch_block = 0x25,
103 DW_TAG_const_type = 0x26,
104 DW_TAG_constant = 0x27,
105 DW_TAG_enumerator = 0x28,
106 DW_TAG_file_type = 0x29,
107 DW_TAG_friend = 0x2a,
108 DW_TAG_namelist = 0x2b,
109 DW_TAG_namelist_item = 0x2c,
110 DW_TAG_packed_type = 0x2d,
111 DW_TAG_subprogram = 0x2e,
112 DW_TAG_template_type_parameter = 0x2f,
113 DW_TAG_template_value_parameter = 0x30,
114 DW_TAG_thrown_type = 0x31,
115 DW_TAG_try_block = 0x32,
116 DW_TAG_variant_part = 0x33,
117 DW_TAG_variable = 0x34,
118 DW_TAG_volatile_type = 0x35,
119 DW_TAG_dwarf_procedure = 0x36,
120 DW_TAG_restrict_type = 0x37,
121 DW_TAG_interface_type = 0x38,
122 DW_TAG_namespace = 0x39,
123 DW_TAG_imported_module = 0x3a,
124 DW_TAG_unspecified_type = 0x3b,
125 DW_TAG_partial_unit = 0x3c,
126 DW_TAG_imported_unit = 0x3d,
127 DW_TAG_condition = 0x3f,
128 DW_TAG_shared_type = 0x40,
129 DW_TAG_type_unit = 0x41,
130 DW_TAG_rvalue_reference_type = 0x42,
131 DW_TAG_template_alias = 0x43,
134 DW_TAG_coarray_type = 0x44,
135 DW_TAG_generic_subrange = 0x45,
136 DW_TAG_dynamic_type = 0x46,
138 DW_TAG_MIPS_loop = 0x4081,
139 DW_TAG_format_label = 0x4101,
140 DW_TAG_function_template = 0x4102,
141 DW_TAG_class_template = 0x4103,
142 DW_TAG_GNU_template_template_param = 0x4106,
143 DW_TAG_GNU_template_parameter_pack = 0x4107,
144 DW_TAG_GNU_formal_parameter_pack = 0x4108,
145 DW_TAG_lo_user = 0x4080,
146 DW_TAG_APPLE_property = 0x4200,
147 DW_TAG_hi_user = 0xffff
150 inline bool isType(Tag T) {
152 case DW_TAG_array_type:
153 case DW_TAG_class_type:
154 case DW_TAG_interface_type:
155 case DW_TAG_enumeration_type:
156 case DW_TAG_pointer_type:
157 case DW_TAG_reference_type:
158 case DW_TAG_rvalue_reference_type:
159 case DW_TAG_string_type:
160 case DW_TAG_structure_type:
161 case DW_TAG_subroutine_type:
162 case DW_TAG_union_type:
163 case DW_TAG_ptr_to_member_type:
164 case DW_TAG_set_type:
165 case DW_TAG_subrange_type:
166 case DW_TAG_base_type:
167 case DW_TAG_const_type:
168 case DW_TAG_file_type:
169 case DW_TAG_packed_type:
170 case DW_TAG_volatile_type:
178 enum Attribute : uint16_t {
180 DW_AT_sibling = 0x01,
181 DW_AT_location = 0x02,
183 DW_AT_ordering = 0x09,
184 DW_AT_byte_size = 0x0b,
185 DW_AT_bit_offset = 0x0c,
186 DW_AT_bit_size = 0x0d,
187 DW_AT_stmt_list = 0x10,
189 DW_AT_high_pc = 0x12,
190 DW_AT_language = 0x13,
192 DW_AT_discr_value = 0x16,
193 DW_AT_visibility = 0x17,
195 DW_AT_string_length = 0x19,
196 DW_AT_common_reference = 0x1a,
197 DW_AT_comp_dir = 0x1b,
198 DW_AT_const_value = 0x1c,
199 DW_AT_containing_type = 0x1d,
200 DW_AT_default_value = 0x1e,
202 DW_AT_is_optional = 0x21,
203 DW_AT_lower_bound = 0x22,
204 DW_AT_producer = 0x25,
205 DW_AT_prototyped = 0x27,
206 DW_AT_return_addr = 0x2a,
207 DW_AT_start_scope = 0x2c,
208 DW_AT_bit_stride = 0x2e,
209 DW_AT_upper_bound = 0x2f,
210 DW_AT_abstract_origin = 0x31,
211 DW_AT_accessibility = 0x32,
212 DW_AT_address_class = 0x33,
213 DW_AT_artificial = 0x34,
214 DW_AT_base_types = 0x35,
215 DW_AT_calling_convention = 0x36,
217 DW_AT_data_member_location = 0x38,
218 DW_AT_decl_column = 0x39,
219 DW_AT_decl_file = 0x3a,
220 DW_AT_decl_line = 0x3b,
221 DW_AT_declaration = 0x3c,
222 DW_AT_discr_list = 0x3d,
223 DW_AT_encoding = 0x3e,
224 DW_AT_external = 0x3f,
225 DW_AT_frame_base = 0x40,
227 DW_AT_identifier_case = 0x42,
228 DW_AT_macro_info = 0x43,
229 DW_AT_namelist_item = 0x44,
230 DW_AT_priority = 0x45,
231 DW_AT_segment = 0x46,
232 DW_AT_specification = 0x47,
233 DW_AT_static_link = 0x48,
235 DW_AT_use_location = 0x4a,
236 DW_AT_variable_parameter = 0x4b,
237 DW_AT_virtuality = 0x4c,
238 DW_AT_vtable_elem_location = 0x4d,
239 DW_AT_allocated = 0x4e,
240 DW_AT_associated = 0x4f,
241 DW_AT_data_location = 0x50,
242 DW_AT_byte_stride = 0x51,
243 DW_AT_entry_pc = 0x52,
244 DW_AT_use_UTF8 = 0x53,
245 DW_AT_extension = 0x54,
247 DW_AT_trampoline = 0x56,
248 DW_AT_call_column = 0x57,
249 DW_AT_call_file = 0x58,
250 DW_AT_call_line = 0x59,
251 DW_AT_description = 0x5a,
252 DW_AT_binary_scale = 0x5b,
253 DW_AT_decimal_scale = 0x5c,
255 DW_AT_decimal_sign = 0x5e,
256 DW_AT_digit_count = 0x5f,
257 DW_AT_picture_string = 0x60,
258 DW_AT_mutable = 0x61,
259 DW_AT_threads_scaled = 0x62,
260 DW_AT_explicit = 0x63,
261 DW_AT_object_pointer = 0x64,
262 DW_AT_endianity = 0x65,
263 DW_AT_elemental = 0x66,
265 DW_AT_recursive = 0x68,
266 DW_AT_signature = 0x69,
267 DW_AT_main_subprogram = 0x6a,
268 DW_AT_data_bit_offset = 0x6b,
269 DW_AT_const_expr = 0x6c,
270 DW_AT_enum_class = 0x6d,
271 DW_AT_linkage_name = 0x6e,
274 DW_AT_string_length_bit_size = 0x6f,
275 DW_AT_string_length_byte_size = 0x70,
277 DW_AT_str_offsets_base = 0x72,
278 DW_AT_addr_base = 0x73,
279 DW_AT_ranges_base = 0x74,
281 DW_AT_dwo_name = 0x76,
282 DW_AT_reference = 0x77,
283 DW_AT_rvalue_reference = 0x78,
285 DW_AT_lo_user = 0x2000,
286 DW_AT_hi_user = 0x3fff,
288 DW_AT_MIPS_loop_begin = 0x2002,
289 DW_AT_MIPS_tail_loop_begin = 0x2003,
290 DW_AT_MIPS_epilog_begin = 0x2004,
291 DW_AT_MIPS_loop_unroll_factor = 0x2005,
292 DW_AT_MIPS_software_pipeline_depth = 0x2006,
293 DW_AT_MIPS_linkage_name = 0x2007,
294 DW_AT_MIPS_stride = 0x2008,
295 DW_AT_MIPS_abstract_name = 0x2009,
296 DW_AT_MIPS_clone_origin = 0x200a,
297 DW_AT_MIPS_has_inlines = 0x200b,
298 DW_AT_MIPS_stride_byte = 0x200c,
299 DW_AT_MIPS_stride_elem = 0x200d,
300 DW_AT_MIPS_ptr_dopetype = 0x200e,
301 DW_AT_MIPS_allocatable_dopetype = 0x200f,
302 DW_AT_MIPS_assumed_shape_dopetype = 0x2010,
304 // This one appears to have only been implemented by Open64 for
305 // fortran and may conflict with other extensions.
306 DW_AT_MIPS_assumed_size = 0x2011,
309 DW_AT_sf_names = 0x2101,
310 DW_AT_src_info = 0x2102,
311 DW_AT_mac_info = 0x2103,
312 DW_AT_src_coords = 0x2104,
313 DW_AT_body_begin = 0x2105,
314 DW_AT_body_end = 0x2106,
315 DW_AT_GNU_vector = 0x2107,
316 DW_AT_GNU_template_name = 0x2110,
318 DW_AT_GNU_odr_signature = 0x210f,
320 // Extensions for Fission proposal.
321 DW_AT_GNU_dwo_name = 0x2130,
322 DW_AT_GNU_dwo_id = 0x2131,
323 DW_AT_GNU_ranges_base = 0x2132,
324 DW_AT_GNU_addr_base = 0x2133,
325 DW_AT_GNU_pubnames = 0x2134,
326 DW_AT_GNU_pubtypes = 0x2135,
329 DW_AT_APPLE_optimized = 0x3fe1,
330 DW_AT_APPLE_flags = 0x3fe2,
331 DW_AT_APPLE_isa = 0x3fe3,
332 DW_AT_APPLE_block = 0x3fe4,
333 DW_AT_APPLE_major_runtime_vers = 0x3fe5,
334 DW_AT_APPLE_runtime_class = 0x3fe6,
335 DW_AT_APPLE_omit_frame_ptr = 0x3fe7,
336 DW_AT_APPLE_property_name = 0x3fe8,
337 DW_AT_APPLE_property_getter = 0x3fe9,
338 DW_AT_APPLE_property_setter = 0x3fea,
339 DW_AT_APPLE_property_attribute = 0x3feb,
340 DW_AT_APPLE_objc_complete_type = 0x3fec,
341 DW_AT_APPLE_property = 0x3fed
344 enum Form : uint16_t {
345 // Attribute form encodings
347 DW_FORM_block2 = 0x03,
348 DW_FORM_block4 = 0x04,
349 DW_FORM_data2 = 0x05,
350 DW_FORM_data4 = 0x06,
351 DW_FORM_data8 = 0x07,
352 DW_FORM_string = 0x08,
353 DW_FORM_block = 0x09,
354 DW_FORM_block1 = 0x0a,
355 DW_FORM_data1 = 0x0b,
357 DW_FORM_sdata = 0x0d,
359 DW_FORM_udata = 0x0f,
360 DW_FORM_ref_addr = 0x10,
365 DW_FORM_ref_udata = 0x15,
366 DW_FORM_indirect = 0x16,
367 DW_FORM_sec_offset = 0x17,
368 DW_FORM_exprloc = 0x18,
369 DW_FORM_flag_present = 0x19,
370 DW_FORM_ref_sig8 = 0x20,
372 // Extensions for Fission proposal
373 DW_FORM_GNU_addr_index = 0x1f01,
374 DW_FORM_GNU_str_index = 0x1f02
378 // Operation encodings
381 DW_OP_const1u = 0x08,
382 DW_OP_const1s = 0x09,
383 DW_OP_const2u = 0x0a,
384 DW_OP_const2s = 0x0b,
385 DW_OP_const4u = 0x0c,
386 DW_OP_const4s = 0x0d,
387 DW_OP_const8u = 0x0e,
388 DW_OP_const8s = 0x0f,
408 DW_OP_plus_uconst = 0x23,
521 DW_OP_deref_size = 0x94,
522 DW_OP_xderef_size = 0x95,
524 DW_OP_push_object_address = 0x97,
527 DW_OP_call_ref = 0x9a,
528 DW_OP_form_tls_address = 0x9b,
529 DW_OP_call_frame_cfa = 0x9c,
530 DW_OP_bit_piece = 0x9d,
531 DW_OP_implicit_value = 0x9e,
532 DW_OP_stack_value = 0x9f,
533 DW_OP_lo_user = 0xe0,
534 DW_OP_hi_user = 0xff,
536 // Extensions for GNU-style thread-local storage.
537 DW_OP_GNU_push_tls_address = 0xe0,
539 // Extensions for Fission proposal.
540 DW_OP_GNU_addr_index = 0xfb,
541 DW_OP_GNU_const_index = 0xfc
545 // Encoding attribute values
546 DW_ATE_address = 0x01,
547 DW_ATE_boolean = 0x02,
548 DW_ATE_complex_float = 0x03,
550 DW_ATE_signed = 0x05,
551 DW_ATE_signed_char = 0x06,
552 DW_ATE_unsigned = 0x07,
553 DW_ATE_unsigned_char = 0x08,
554 DW_ATE_imaginary_float = 0x09,
555 DW_ATE_packed_decimal = 0x0a,
556 DW_ATE_numeric_string = 0x0b,
557 DW_ATE_edited = 0x0c,
558 DW_ATE_signed_fixed = 0x0d,
559 DW_ATE_unsigned_fixed = 0x0e,
560 DW_ATE_decimal_float = 0x0f,
562 DW_ATE_lo_user = 0x80,
563 DW_ATE_hi_user = 0xff
566 enum DecimalSignEncoding {
567 // Decimal sign attribute values
568 DW_DS_unsigned = 0x01,
569 DW_DS_leading_overpunch = 0x02,
570 DW_DS_trailing_overpunch = 0x03,
571 DW_DS_leading_separate = 0x04,
572 DW_DS_trailing_separate = 0x05
575 enum EndianityEncoding {
576 // Endianity attribute values
577 DW_END_default = 0x00,
579 DW_END_little = 0x02,
580 DW_END_lo_user = 0x40,
581 DW_END_hi_user = 0xff
584 enum AccessAttribute {
585 // Accessibility codes
586 DW_ACCESS_public = 0x01,
587 DW_ACCESS_protected = 0x02,
588 DW_ACCESS_private = 0x03
591 enum VisibilityAttribute {
594 DW_VIS_exported = 0x02,
595 DW_VIS_qualified = 0x03
598 enum VirtualityAttribute {
600 DW_VIRTUALITY_none = 0x00,
601 DW_VIRTUALITY_virtual = 0x01,
602 DW_VIRTUALITY_pure_virtual = 0x02
605 enum SourceLanguage {
607 DW_LANG_C89 = 0x0001,
609 DW_LANG_Ada83 = 0x0003,
610 DW_LANG_C_plus_plus = 0x0004,
611 DW_LANG_Cobol74 = 0x0005,
612 DW_LANG_Cobol85 = 0x0006,
613 DW_LANG_Fortran77 = 0x0007,
614 DW_LANG_Fortran90 = 0x0008,
615 DW_LANG_Pascal83 = 0x0009,
616 DW_LANG_Modula2 = 0x000a,
617 DW_LANG_Java = 0x000b,
618 DW_LANG_C99 = 0x000c,
619 DW_LANG_Ada95 = 0x000d,
620 DW_LANG_Fortran95 = 0x000e,
621 DW_LANG_PLI = 0x000f,
622 DW_LANG_ObjC = 0x0010,
623 DW_LANG_ObjC_plus_plus = 0x0011,
624 DW_LANG_UPC = 0x0012,
627 DW_LANG_Python = 0x0014,
628 DW_LANG_OpenCL = 0x0015,
630 DW_LANG_Modula3 = 0x0017,
631 DW_LANG_Haskell = 0x0018,
632 DW_LANG_C_plus_plus_03 = 0x0019,
633 DW_LANG_C_plus_plus_11 = 0x001a,
634 DW_LANG_OCaml = 0x001b,
636 DW_LANG_lo_user = 0x8000,
637 DW_LANG_Mips_Assembler = 0x8001,
638 DW_LANG_hi_user = 0xffff
641 enum CaseSensitivity {
642 // Identifier case codes
643 DW_ID_case_sensitive = 0x00,
644 DW_ID_up_case = 0x01,
645 DW_ID_down_case = 0x02,
646 DW_ID_case_insensitive = 0x03
649 enum CallingConvention {
650 // Calling convention codes
652 DW_CC_program = 0x02,
654 DW_CC_lo_user = 0x40,
658 enum InlineAttribute {
660 DW_INL_not_inlined = 0x00,
661 DW_INL_inlined = 0x01,
662 DW_INL_declared_not_inlined = 0x02,
663 DW_INL_declared_inlined = 0x03
666 enum ArrayDimensionOrdering {
668 DW_ORD_row_major = 0x00,
669 DW_ORD_col_major = 0x01
672 enum DiscriminantList {
673 // Discriminant descriptor values
679 // Line Number Standard Opcode Encodings
680 DW_LNS_extended_op = 0x00,
682 DW_LNS_advance_pc = 0x02,
683 DW_LNS_advance_line = 0x03,
684 DW_LNS_set_file = 0x04,
685 DW_LNS_set_column = 0x05,
686 DW_LNS_negate_stmt = 0x06,
687 DW_LNS_set_basic_block = 0x07,
688 DW_LNS_const_add_pc = 0x08,
689 DW_LNS_fixed_advance_pc = 0x09,
690 DW_LNS_set_prologue_end = 0x0a,
691 DW_LNS_set_epilogue_begin = 0x0b,
692 DW_LNS_set_isa = 0x0c
695 enum LineNumberExtendedOps {
696 // Line Number Extended Opcode Encodings
697 DW_LNE_end_sequence = 0x01,
698 DW_LNE_set_address = 0x02,
699 DW_LNE_define_file = 0x03,
700 DW_LNE_set_discriminator = 0x04,
701 DW_LNE_lo_user = 0x80,
702 DW_LNE_hi_user = 0xff
705 enum MacinfoRecordType {
706 // Macinfo Type Encodings
707 DW_MACINFO_define = 0x01,
708 DW_MACINFO_undef = 0x02,
709 DW_MACINFO_start_file = 0x03,
710 DW_MACINFO_end_file = 0x04,
711 DW_MACINFO_vendor_ext = 0xff
715 // Call frame instruction encodings
716 DW_CFA_extended = 0x00,
718 DW_CFA_advance_loc = 0x40,
719 DW_CFA_offset = 0x80,
720 DW_CFA_restore = 0xc0,
721 DW_CFA_set_loc = 0x01,
722 DW_CFA_advance_loc1 = 0x02,
723 DW_CFA_advance_loc2 = 0x03,
724 DW_CFA_advance_loc4 = 0x04,
725 DW_CFA_offset_extended = 0x05,
726 DW_CFA_restore_extended = 0x06,
727 DW_CFA_undefined = 0x07,
728 DW_CFA_same_value = 0x08,
729 DW_CFA_register = 0x09,
730 DW_CFA_remember_state = 0x0a,
731 DW_CFA_restore_state = 0x0b,
732 DW_CFA_def_cfa = 0x0c,
733 DW_CFA_def_cfa_register = 0x0d,
734 DW_CFA_def_cfa_offset = 0x0e,
735 DW_CFA_def_cfa_expression = 0x0f,
736 DW_CFA_expression = 0x10,
737 DW_CFA_offset_extended_sf = 0x11,
738 DW_CFA_def_cfa_sf = 0x12,
739 DW_CFA_def_cfa_offset_sf = 0x13,
740 DW_CFA_val_offset = 0x14,
741 DW_CFA_val_offset_sf = 0x15,
742 DW_CFA_val_expression = 0x16,
743 DW_CFA_MIPS_advance_loc8 = 0x1d,
744 DW_CFA_GNU_window_save = 0x2d,
745 DW_CFA_GNU_args_size = 0x2e,
746 DW_CFA_lo_user = 0x1c,
747 DW_CFA_hi_user = 0x3f
752 DW_CHILDREN_no = 0x00,
753 DW_CHILDREN_yes = 0x01,
755 DW_EH_PE_absptr = 0x00,
756 DW_EH_PE_omit = 0xff,
757 DW_EH_PE_uleb128 = 0x01,
758 DW_EH_PE_udata2 = 0x02,
759 DW_EH_PE_udata4 = 0x03,
760 DW_EH_PE_udata8 = 0x04,
761 DW_EH_PE_sleb128 = 0x09,
762 DW_EH_PE_sdata2 = 0x0A,
763 DW_EH_PE_sdata4 = 0x0B,
764 DW_EH_PE_sdata8 = 0x0C,
765 DW_EH_PE_signed = 0x08,
766 DW_EH_PE_pcrel = 0x10,
767 DW_EH_PE_textrel = 0x20,
768 DW_EH_PE_datarel = 0x30,
769 DW_EH_PE_funcrel = 0x40,
770 DW_EH_PE_aligned = 0x50,
771 DW_EH_PE_indirect = 0x80
774 // Constants for debug_loc.dwo in the DWARF5 Split Debug Info Proposal
775 enum LocationListEntry : unsigned char {
776 DW_LLE_end_of_list_entry,
777 DW_LLE_base_address_selection_entry,
778 DW_LLE_start_end_entry,
779 DW_LLE_start_length_entry,
780 DW_LLE_offset_pair_entry
783 /// Contstants for the DW_APPLE_PROPERTY_attributes attribute.
784 /// Keep this list in sync with clang's DeclSpec.h ObjCPropertyAttributeKind.
785 enum ApplePropertyAttributes {
786 // Apple Objective-C Property Attributes
787 DW_APPLE_PROPERTY_readonly = 0x01,
788 DW_APPLE_PROPERTY_getter = 0x02,
789 DW_APPLE_PROPERTY_assign = 0x04,
790 DW_APPLE_PROPERTY_readwrite = 0x08,
791 DW_APPLE_PROPERTY_retain = 0x10,
792 DW_APPLE_PROPERTY_copy = 0x20,
793 DW_APPLE_PROPERTY_nonatomic = 0x40,
794 DW_APPLE_PROPERTY_setter = 0x80,
795 DW_APPLE_PROPERTY_atomic = 0x100,
796 DW_APPLE_PROPERTY_weak = 0x200,
797 DW_APPLE_PROPERTY_strong = 0x400,
798 DW_APPLE_PROPERTY_unsafe_unretained = 0x800
801 /// TagString - Return the string for the specified tag.
803 const char *TagString(unsigned Tag);
805 /// ChildrenString - Return the string for the specified children flag.
807 const char *ChildrenString(unsigned Children);
809 /// AttributeString - Return the string for the specified attribute.
811 const char *AttributeString(unsigned Attribute);
813 /// FormEncodingString - Return the string for the specified form encoding.
815 const char *FormEncodingString(unsigned Encoding);
817 /// OperationEncodingString - Return the string for the specified operation
819 const char *OperationEncodingString(unsigned Encoding);
821 /// AttributeEncodingString - Return the string for the specified attribute
823 const char *AttributeEncodingString(unsigned Encoding);
825 /// DecimalSignString - Return the string for the specified decimal sign
827 const char *DecimalSignString(unsigned Sign);
829 /// EndianityString - Return the string for the specified endianity.
831 const char *EndianityString(unsigned Endian);
833 /// AccessibilityString - Return the string for the specified accessibility.
835 const char *AccessibilityString(unsigned Access);
837 /// VisibilityString - Return the string for the specified visibility.
839 const char *VisibilityString(unsigned Visibility);
841 /// VirtualityString - Return the string for the specified virtuality.
843 const char *VirtualityString(unsigned Virtuality);
845 /// LanguageString - Return the string for the specified language.
847 const char *LanguageString(unsigned Language);
849 /// CaseString - Return the string for the specified identifier case.
851 const char *CaseString(unsigned Case);
853 /// ConventionString - Return the string for the specified calling convention.
855 const char *ConventionString(unsigned Convention);
857 /// InlineCodeString - Return the string for the specified inline code.
859 const char *InlineCodeString(unsigned Code);
861 /// ArrayOrderString - Return the string for the specified array order.
863 const char *ArrayOrderString(unsigned Order);
865 /// DiscriminantString - Return the string for the specified discriminant
867 const char *DiscriminantString(unsigned Discriminant);
869 /// LNStandardString - Return the string for the specified line number standard.
871 const char *LNStandardString(unsigned Standard);
873 /// LNExtendedString - Return the string for the specified line number extended
874 /// opcode encodings.
875 const char *LNExtendedString(unsigned Encoding);
877 /// MacinfoString - Return the string for the specified macinfo type encodings.
879 const char *MacinfoString(unsigned Encoding);
881 /// CallFrameString - Return the string for the specified call frame instruction
883 const char *CallFrameString(unsigned Encoding);
885 /// ApplePropertyString - Return the string for the specified Apple
886 /// property bit. This function is meant to return the symbolic name
887 /// for 1 bit of the DW_AT_APPLE_property attribute, not for the whole attribute.
888 const char *ApplePropertyString(unsigned);
890 // Constants for the DWARF5 Accelerator Table Proposal
891 enum AcceleratorTable {
892 // Data layout descriptors.
893 DW_ATOM_null = 0u, // Marker as the end of a list of atoms.
894 DW_ATOM_die_offset = 1u, // DIE offset in the debug_info section.
895 DW_ATOM_cu_offset = 2u, // Offset of the compile unit header that contains the
897 DW_ATOM_die_tag = 3u, // A tag entry.
898 DW_ATOM_type_flags = 4u, // Set of flags for a type.
900 // DW_ATOM_type_flags values.
902 // Always set for C++, only set for ObjC if this is the @implementation for a
904 DW_FLAG_type_implementation = 2u,
908 // Daniel J. Bernstein hash.
909 DW_hash_function_djb = 0u
912 /// AtomTypeString - Return the string for the specified Atom type.
913 const char *AtomTypeString(unsigned Atom);
915 // Constants for the GNU pubnames/pubtypes extensions supporting gdb index.
916 enum GDBIndexEntryKind {
927 const char *GDBIndexEntryKindString(GDBIndexEntryKind Kind);
929 enum GDBIndexEntryLinkage {
934 const char *GDBIndexEntryLinkageString(GDBIndexEntryLinkage Linkage);
936 /// The gnu_pub* kind looks like:
940 /// 7 0 == global, 1 == static
942 /// A gdb_index descriptor includes the above kind, shifted 24 bits up with the
943 /// offset of the cu within the debug_info section stored in those 24 bits.
944 struct PubIndexEntryDescriptor {
945 GDBIndexEntryKind Kind;
946 GDBIndexEntryLinkage Linkage;
947 PubIndexEntryDescriptor(GDBIndexEntryKind Kind, GDBIndexEntryLinkage Linkage)
948 : Kind(Kind), Linkage(Linkage) {}
949 /* implicit */ PubIndexEntryDescriptor(GDBIndexEntryKind Kind)
950 : Kind(Kind), Linkage(GIEL_EXTERNAL) {}
951 explicit PubIndexEntryDescriptor(uint8_t Value)
952 : Kind(static_cast<GDBIndexEntryKind>((Value & KIND_MASK) >>
954 Linkage(static_cast<GDBIndexEntryLinkage>((Value & LINKAGE_MASK) >>
956 uint8_t toBits() { return Kind << KIND_OFFSET | Linkage << LINKAGE_OFFSET; }
961 KIND_MASK = 7 << KIND_OFFSET,
963 LINKAGE_MASK = 1 << LINKAGE_OFFSET
967 /// Returns the symbolic string representing Val when used as a value
968 /// for attribute Attr.
969 const char *AttributeValueString(uint16_t Attr, unsigned Val);
971 } // End of namespace dwarf
973 } // End of namespace llvm