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