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