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 //===----------------------------------------------------------------------===//
11 // \brief This file contains constants used for implementing Dwarf
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.
18 //===----------------------------------------------------------------------===//
20 #ifndef LLVM_SUPPORT_DWARF_H
21 #define LLVM_SUPPORT_DWARF_H
23 #include "llvm/ADT/StringRef.h"
24 #include "llvm/Support/Compiler.h"
25 #include "llvm/Support/DataTypes.h"
31 //===----------------------------------------------------------------------===//
32 // Dwarf constants as gleaned from the DWARF Debugging Information Format V.4
33 // reference manual http://www.dwarfstd.org/.
36 // Do not mix the following two enumerations sets. DW_TAG_invalid changes the
37 // enumeration base type.
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.
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.
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;
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.
64 inline bool isType(Tag 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:
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:
92 enum Attribute : uint16_t {
95 DW_AT_location = 0x02,
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,
103 DW_AT_high_pc = 0x12,
104 DW_AT_language = 0x13,
106 DW_AT_discr_value = 0x16,
107 DW_AT_visibility = 0x17,
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,
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,
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,
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,
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,
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,
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,
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,
188 DW_AT_string_length_bit_size = 0x6f,
189 DW_AT_string_length_byte_size = 0x70,
191 DW_AT_str_offsets_base = 0x72,
192 DW_AT_addr_base = 0x73,
193 DW_AT_ranges_base = 0x74,
195 DW_AT_dwo_name = 0x76,
196 DW_AT_reference = 0x77,
197 DW_AT_rvalue_reference = 0x78,
199 DW_AT_lo_user = 0x2000,
200 DW_AT_hi_user = 0x3fff,
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,
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,
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,
232 DW_AT_GNU_odr_signature = 0x210f,
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,
242 // LLVM project extensions.
243 DW_AT_LLVM_include_path = 0x3e00,
244 DW_AT_LLVM_config_macros = 0x3e01,
245 DW_AT_LLVM_isysroot = 0x3e02,
248 DW_AT_APPLE_optimized = 0x3fe1,
249 DW_AT_APPLE_flags = 0x3fe2,
250 DW_AT_APPLE_isa = 0x3fe3,
251 DW_AT_APPLE_block = 0x3fe4,
252 DW_AT_APPLE_major_runtime_vers = 0x3fe5,
253 DW_AT_APPLE_runtime_class = 0x3fe6,
254 DW_AT_APPLE_omit_frame_ptr = 0x3fe7,
255 DW_AT_APPLE_property_name = 0x3fe8,
256 DW_AT_APPLE_property_getter = 0x3fe9,
257 DW_AT_APPLE_property_setter = 0x3fea,
258 DW_AT_APPLE_property_attribute = 0x3feb,
259 DW_AT_APPLE_objc_complete_type = 0x3fec,
260 DW_AT_APPLE_property = 0x3fed
263 enum Form : uint16_t {
264 // Attribute form encodings
266 DW_FORM_block2 = 0x03,
267 DW_FORM_block4 = 0x04,
268 DW_FORM_data2 = 0x05,
269 DW_FORM_data4 = 0x06,
270 DW_FORM_data8 = 0x07,
271 DW_FORM_string = 0x08,
272 DW_FORM_block = 0x09,
273 DW_FORM_block1 = 0x0a,
274 DW_FORM_data1 = 0x0b,
276 DW_FORM_sdata = 0x0d,
278 DW_FORM_udata = 0x0f,
279 DW_FORM_ref_addr = 0x10,
284 DW_FORM_ref_udata = 0x15,
285 DW_FORM_indirect = 0x16,
286 DW_FORM_sec_offset = 0x17,
287 DW_FORM_exprloc = 0x18,
288 DW_FORM_flag_present = 0x19,
289 DW_FORM_ref_sig8 = 0x20,
291 // Extensions for Fission proposal
292 DW_FORM_GNU_addr_index = 0x1f01,
293 DW_FORM_GNU_str_index = 0x1f02,
295 // Alternate debug sections proposal (output of "dwz" tool).
296 DW_FORM_GNU_ref_alt = 0x1f20,
297 DW_FORM_GNU_strp_alt = 0x1f21
301 #define HANDLE_DW_OP(ID, NAME) DW_OP_##NAME = ID,
302 #include "llvm/Support/Dwarf.def"
303 DW_OP_lo_user = 0xe0,
308 #define HANDLE_DW_ATE(ID, NAME) DW_ATE_##NAME = ID,
309 #include "llvm/Support/Dwarf.def"
310 DW_ATE_lo_user = 0x80,
311 DW_ATE_hi_user = 0xff
314 enum DecimalSignEncoding {
315 // Decimal sign attribute values
316 DW_DS_unsigned = 0x01,
317 DW_DS_leading_overpunch = 0x02,
318 DW_DS_trailing_overpunch = 0x03,
319 DW_DS_leading_separate = 0x04,
320 DW_DS_trailing_separate = 0x05
323 enum EndianityEncoding {
324 // Endianity attribute values
325 DW_END_default = 0x00,
327 DW_END_little = 0x02,
328 DW_END_lo_user = 0x40,
329 DW_END_hi_user = 0xff
332 enum AccessAttribute {
333 // Accessibility codes
334 DW_ACCESS_public = 0x01,
335 DW_ACCESS_protected = 0x02,
336 DW_ACCESS_private = 0x03
339 enum VisibilityAttribute {
342 DW_VIS_exported = 0x02,
343 DW_VIS_qualified = 0x03
346 enum VirtualityAttribute {
347 #define HANDLE_DW_VIRTUALITY(ID, NAME) DW_VIRTUALITY_##NAME = ID,
348 #include "llvm/Support/Dwarf.def"
349 DW_VIRTUALITY_max = 0x02
352 enum SourceLanguage {
353 #define HANDLE_DW_LANG(ID, NAME) DW_LANG_##NAME = ID,
354 #include "llvm/Support/Dwarf.def"
355 DW_LANG_lo_user = 0x8000,
356 DW_LANG_hi_user = 0xffff
359 enum CaseSensitivity {
360 // Identifier case codes
361 DW_ID_case_sensitive = 0x00,
362 DW_ID_up_case = 0x01,
363 DW_ID_down_case = 0x02,
364 DW_ID_case_insensitive = 0x03
367 enum CallingConvention {
368 // Calling convention codes
370 DW_CC_program = 0x02,
372 DW_CC_lo_user = 0x40,
376 enum InlineAttribute {
378 DW_INL_not_inlined = 0x00,
379 DW_INL_inlined = 0x01,
380 DW_INL_declared_not_inlined = 0x02,
381 DW_INL_declared_inlined = 0x03
384 enum ArrayDimensionOrdering {
386 DW_ORD_row_major = 0x00,
387 DW_ORD_col_major = 0x01
390 enum DiscriminantList {
391 // Discriminant descriptor values
397 // Line Number Standard Opcode Encodings
398 DW_LNS_extended_op = 0x00,
400 DW_LNS_advance_pc = 0x02,
401 DW_LNS_advance_line = 0x03,
402 DW_LNS_set_file = 0x04,
403 DW_LNS_set_column = 0x05,
404 DW_LNS_negate_stmt = 0x06,
405 DW_LNS_set_basic_block = 0x07,
406 DW_LNS_const_add_pc = 0x08,
407 DW_LNS_fixed_advance_pc = 0x09,
408 DW_LNS_set_prologue_end = 0x0a,
409 DW_LNS_set_epilogue_begin = 0x0b,
410 DW_LNS_set_isa = 0x0c
413 enum LineNumberExtendedOps {
414 // Line Number Extended Opcode Encodings
415 DW_LNE_end_sequence = 0x01,
416 DW_LNE_set_address = 0x02,
417 DW_LNE_define_file = 0x03,
418 DW_LNE_set_discriminator = 0x04,
419 DW_LNE_lo_user = 0x80,
420 DW_LNE_hi_user = 0xff
423 enum MacinfoRecordType {
424 // Macinfo Type Encodings
425 DW_MACINFO_define = 0x01,
426 DW_MACINFO_undef = 0x02,
427 DW_MACINFO_start_file = 0x03,
428 DW_MACINFO_end_file = 0x04,
429 DW_MACINFO_vendor_ext = 0xff
433 // Call frame instruction encodings
434 DW_CFA_extended = 0x00,
436 DW_CFA_advance_loc = 0x40,
437 DW_CFA_offset = 0x80,
438 DW_CFA_restore = 0xc0,
439 DW_CFA_set_loc = 0x01,
440 DW_CFA_advance_loc1 = 0x02,
441 DW_CFA_advance_loc2 = 0x03,
442 DW_CFA_advance_loc4 = 0x04,
443 DW_CFA_offset_extended = 0x05,
444 DW_CFA_restore_extended = 0x06,
445 DW_CFA_undefined = 0x07,
446 DW_CFA_same_value = 0x08,
447 DW_CFA_register = 0x09,
448 DW_CFA_remember_state = 0x0a,
449 DW_CFA_restore_state = 0x0b,
450 DW_CFA_def_cfa = 0x0c,
451 DW_CFA_def_cfa_register = 0x0d,
452 DW_CFA_def_cfa_offset = 0x0e,
453 DW_CFA_def_cfa_expression = 0x0f,
454 DW_CFA_expression = 0x10,
455 DW_CFA_offset_extended_sf = 0x11,
456 DW_CFA_def_cfa_sf = 0x12,
457 DW_CFA_def_cfa_offset_sf = 0x13,
458 DW_CFA_val_offset = 0x14,
459 DW_CFA_val_offset_sf = 0x15,
460 DW_CFA_val_expression = 0x16,
461 DW_CFA_MIPS_advance_loc8 = 0x1d,
462 DW_CFA_GNU_window_save = 0x2d,
463 DW_CFA_GNU_args_size = 0x2e,
464 DW_CFA_lo_user = 0x1c,
465 DW_CFA_hi_user = 0x3f
470 DW_CHILDREN_no = 0x00,
471 DW_CHILDREN_yes = 0x01,
473 DW_EH_PE_absptr = 0x00,
474 DW_EH_PE_omit = 0xff,
475 DW_EH_PE_uleb128 = 0x01,
476 DW_EH_PE_udata2 = 0x02,
477 DW_EH_PE_udata4 = 0x03,
478 DW_EH_PE_udata8 = 0x04,
479 DW_EH_PE_sleb128 = 0x09,
480 DW_EH_PE_sdata2 = 0x0A,
481 DW_EH_PE_sdata4 = 0x0B,
482 DW_EH_PE_sdata8 = 0x0C,
483 DW_EH_PE_signed = 0x08,
484 DW_EH_PE_pcrel = 0x10,
485 DW_EH_PE_textrel = 0x20,
486 DW_EH_PE_datarel = 0x30,
487 DW_EH_PE_funcrel = 0x40,
488 DW_EH_PE_aligned = 0x50,
489 DW_EH_PE_indirect = 0x80
492 // Constants for debug_loc.dwo in the DWARF5 Split Debug Info Proposal
493 enum LocationListEntry : unsigned char {
494 DW_LLE_end_of_list_entry,
495 DW_LLE_base_address_selection_entry,
496 DW_LLE_start_end_entry,
497 DW_LLE_start_length_entry,
498 DW_LLE_offset_pair_entry
501 /// Contstants for the DW_APPLE_PROPERTY_attributes attribute.
502 /// Keep this list in sync with clang's DeclSpec.h ObjCPropertyAttributeKind.
503 enum ApplePropertyAttributes {
504 // Apple Objective-C Property Attributes
505 DW_APPLE_PROPERTY_readonly = 0x01,
506 DW_APPLE_PROPERTY_getter = 0x02,
507 DW_APPLE_PROPERTY_assign = 0x04,
508 DW_APPLE_PROPERTY_readwrite = 0x08,
509 DW_APPLE_PROPERTY_retain = 0x10,
510 DW_APPLE_PROPERTY_copy = 0x20,
511 DW_APPLE_PROPERTY_nonatomic = 0x40,
512 DW_APPLE_PROPERTY_setter = 0x80,
513 DW_APPLE_PROPERTY_atomic = 0x100,
514 DW_APPLE_PROPERTY_weak = 0x200,
515 DW_APPLE_PROPERTY_strong = 0x400,
516 DW_APPLE_PROPERTY_unsafe_unretained = 0x800
519 // Constants for the DWARF5 Accelerator Table Proposal
520 enum AcceleratorTable {
521 // Data layout descriptors.
522 DW_ATOM_null = 0u, // Marker as the end of a list of atoms.
523 DW_ATOM_die_offset = 1u, // DIE offset in the debug_info section.
524 DW_ATOM_cu_offset = 2u, // Offset of the compile unit header that contains the
526 DW_ATOM_die_tag = 3u, // A tag entry.
527 DW_ATOM_type_flags = 4u, // Set of flags for a type.
529 // DW_ATOM_type_flags values.
531 // Always set for C++, only set for ObjC if this is the @implementation for a
533 DW_FLAG_type_implementation = 2u,
537 // Daniel J. Bernstein hash.
538 DW_hash_function_djb = 0u
541 // Constants for the GNU pubnames/pubtypes extensions supporting gdb index.
542 enum GDBIndexEntryKind {
553 enum GDBIndexEntryLinkage {
558 /// \defgroup DwarfConstantsDumping Dwarf constants dumping functions
560 /// All these functions map their argument's value back to the
561 /// corresponding enumerator name or return nullptr if the value isn't
565 const char *TagString(unsigned Tag);
566 const char *ChildrenString(unsigned Children);
567 const char *AttributeString(unsigned Attribute);
568 const char *FormEncodingString(unsigned Encoding);
569 const char *OperationEncodingString(unsigned Encoding);
570 const char *AttributeEncodingString(unsigned Encoding);
571 const char *DecimalSignString(unsigned Sign);
572 const char *EndianityString(unsigned Endian);
573 const char *AccessibilityString(unsigned Access);
574 const char *VisibilityString(unsigned Visibility);
575 const char *VirtualityString(unsigned Virtuality);
576 const char *LanguageString(unsigned Language);
577 const char *CaseString(unsigned Case);
578 const char *ConventionString(unsigned Convention);
579 const char *InlineCodeString(unsigned Code);
580 const char *ArrayOrderString(unsigned Order);
581 const char *DiscriminantString(unsigned Discriminant);
582 const char *LNStandardString(unsigned Standard);
583 const char *LNExtendedString(unsigned Encoding);
584 const char *MacinfoString(unsigned Encoding);
585 const char *CallFrameString(unsigned Encoding);
586 const char *ApplePropertyString(unsigned);
587 const char *AtomTypeString(unsigned Atom);
588 const char *GDBIndexEntryKindString(GDBIndexEntryKind Kind);
589 const char *GDBIndexEntryLinkageString(GDBIndexEntryLinkage Linkage);
592 /// \defgroup DwarfConstantsParsing Dwarf constants parsing functions
594 /// These functions map their strings back to the corresponding enumeration
595 /// value or return 0 if there is none, except for these exceptions:
597 /// \li \a getTag() returns \a DW_TAG_invalid on invalid input.
598 /// \li \a getVirtuality() returns \a DW_VIRTUALITY_invalid on invalid input.
601 unsigned getTag(StringRef TagString);
602 unsigned getOperationEncoding(StringRef OperationEncodingString);
603 unsigned getVirtuality(StringRef VirtualityString);
604 unsigned getLanguage(StringRef LanguageString);
605 unsigned getAttributeEncoding(StringRef EncodingString);
608 /// \brief Returns the symbolic string representing Val when used as a value
609 /// for attribute Attr.
610 const char *AttributeValueString(uint16_t Attr, unsigned Val);
612 /// \brief Decsribes an entry of the various gnu_pub* debug sections.
614 /// The gnu_pub* kind looks like:
618 /// 7 0 == global, 1 == static
620 /// A gdb_index descriptor includes the above kind, shifted 24 bits up with the
621 /// offset of the cu within the debug_info section stored in those 24 bits.
622 struct PubIndexEntryDescriptor {
623 GDBIndexEntryKind Kind;
624 GDBIndexEntryLinkage Linkage;
625 PubIndexEntryDescriptor(GDBIndexEntryKind Kind, GDBIndexEntryLinkage Linkage)
626 : Kind(Kind), Linkage(Linkage) {}
627 /* implicit */ PubIndexEntryDescriptor(GDBIndexEntryKind Kind)
628 : Kind(Kind), Linkage(GIEL_EXTERNAL) {}
629 explicit PubIndexEntryDescriptor(uint8_t Value)
630 : Kind(static_cast<GDBIndexEntryKind>((Value & KIND_MASK) >>
632 Linkage(static_cast<GDBIndexEntryLinkage>((Value & LINKAGE_MASK) >>
634 uint8_t toBits() { return Kind << KIND_OFFSET | Linkage << LINKAGE_OFFSET; }
639 KIND_MASK = 7 << KIND_OFFSET,
641 LINKAGE_MASK = 1 << LINKAGE_OFFSET
645 } // End of namespace dwarf
647 } // End of namespace llvm