Dwarf.h revision 6906ba52f050a6608502987e754a622f5c5111a6 
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
19namespace llvm {
20
21//===----------------------------------------------------------------------===//
22// Debug info constants.
23
24enum {
25LLVMDebugVersion = (7 << 16),         // Current version of debug information.
26LLVMDebugVersion6 = (6 << 16),        // Constant for version 6.
27LLVMDebugVersion5 = (5 << 16),        // Constant for version 5.
28LLVMDebugVersion4 = (4 << 16),        // Constant for version 4.
29LLVMDebugVersionMask = 0xffff0000     // Mask for version number.
30};
31
32namespace dwarf {
33
34//===----------------------------------------------------------------------===//
35// Dwarf constants as gleaned from the DWARF Debugging Information Format V.3
36// reference manual http://dwarf.freestandards.org .
37//
38
39// Do not mix the following two enumerations sets.  DW_TAG_invalid changes the
40// enumeration base type.
41
42enum llvm_dwarf_constants {
43  // llvm mock tags
44  DW_TAG_invalid = ~0U,                 // Tag for invalid results.
45
46  DW_TAG_anchor = 0,                    // Tag for descriptor anchors.
47  DW_TAG_auto_variable = 0x100,         // Tag for local (auto) variables.
48  DW_TAG_arg_variable = 0x101,          // Tag for argument variables.
49  DW_TAG_return_variable = 0x102,       // Tag for return variables.
50
51  DW_TAG_vector_type = 0x103,           // Tag for vector types.
52
53  DW_TAG_user_base = 0x1000,            // Recommended base for user tags.
54
55  DW_CIE_VERSION = 1,                   // Common frame information version.
56  DW_CIE_ID       = 0xffffffff          // Common frame information mark.
57};
58
59enum dwarf_constants {
60  DWARF_VERSION = 2,
61
62  // Tags
63  DW_TAG_array_type = 0x01,
64  DW_TAG_class_type = 0x02,
65  DW_TAG_entry_point = 0x03,
66  DW_TAG_enumeration_type = 0x04,
67  DW_TAG_formal_parameter = 0x05,
68  DW_TAG_imported_declaration = 0x08,
69  DW_TAG_label = 0x0a,
70  DW_TAG_lexical_block = 0x0b,
71  DW_TAG_member = 0x0d,
72  DW_TAG_pointer_type = 0x0f,
73  DW_TAG_reference_type = 0x10,
74  DW_TAG_compile_unit = 0x11,
75  DW_TAG_string_type = 0x12,
76  DW_TAG_structure_type = 0x13,
77  DW_TAG_subroutine_type = 0x15,
78  DW_TAG_typedef = 0x16,
79  DW_TAG_union_type = 0x17,
80  DW_TAG_unspecified_parameters = 0x18,
81  DW_TAG_variant = 0x19,
82  DW_TAG_common_block = 0x1a,
83  DW_TAG_common_inclusion = 0x1b,
84  DW_TAG_inheritance = 0x1c,
85  DW_TAG_inlined_subroutine = 0x1d,
86  DW_TAG_module = 0x1e,
87  DW_TAG_ptr_to_member_type = 0x1f,
88  DW_TAG_set_type = 0x20,
89  DW_TAG_subrange_type = 0x21,
90  DW_TAG_with_stmt = 0x22,
91  DW_TAG_access_declaration = 0x23,
92  DW_TAG_base_type = 0x24,
93  DW_TAG_catch_block = 0x25,
94  DW_TAG_const_type = 0x26,
95  DW_TAG_constant = 0x27,
96  DW_TAG_enumerator = 0x28,
97  DW_TAG_file_type = 0x29,
98  DW_TAG_friend = 0x2a,
99  DW_TAG_namelist = 0x2b,
100  DW_TAG_namelist_item = 0x2c,
101  DW_TAG_packed_type = 0x2d,
102  DW_TAG_subprogram = 0x2e,
103  DW_TAG_template_type_parameter = 0x2f,
104  DW_TAG_template_value_parameter = 0x30,
105  DW_TAG_thrown_type = 0x31,
106  DW_TAG_try_block = 0x32,
107  DW_TAG_variant_part = 0x33,
108  DW_TAG_variable = 0x34,
109  DW_TAG_volatile_type = 0x35,
110  DW_TAG_dwarf_procedure = 0x36,
111  DW_TAG_restrict_type = 0x37,
112  DW_TAG_interface_type = 0x38,
113  DW_TAG_namespace = 0x39,
114  DW_TAG_imported_module = 0x3a,
115  DW_TAG_unspecified_type = 0x3b,
116  DW_TAG_partial_unit = 0x3c,
117  DW_TAG_imported_unit = 0x3d,
118  DW_TAG_condition = 0x3f,
119  DW_TAG_shared_type = 0x40,
120  DW_TAG_lo_user = 0x4080,
121  DW_TAG_hi_user = 0xffff,
122
123  // Children flag
124  DW_CHILDREN_no = 0x00,
125  DW_CHILDREN_yes = 0x01,
126
127  // Attributes
128  DW_AT_sibling = 0x01,
129  DW_AT_location = 0x02,
130  DW_AT_name = 0x03,
131  DW_AT_ordering = 0x09,
132  DW_AT_byte_size = 0x0b,
133  DW_AT_bit_offset = 0x0c,
134  DW_AT_bit_size = 0x0d,
135  DW_AT_stmt_list = 0x10,
136  DW_AT_low_pc = 0x11,
137  DW_AT_high_pc = 0x12,
138  DW_AT_language = 0x13,
139  DW_AT_discr = 0x15,
140  DW_AT_discr_value = 0x16,
141  DW_AT_visibility = 0x17,
142  DW_AT_import = 0x18,
143  DW_AT_string_length = 0x19,
144  DW_AT_common_reference = 0x1a,
145  DW_AT_comp_dir = 0x1b,
146  DW_AT_const_value = 0x1c,
147  DW_AT_containing_type = 0x1d,
148  DW_AT_default_value = 0x1e,
149  DW_AT_inline = 0x20,
150  DW_AT_is_optional = 0x21,
151  DW_AT_lower_bound = 0x22,
152  DW_AT_producer = 0x25,
153  DW_AT_prototyped = 0x27,
154  DW_AT_return_addr = 0x2a,
155  DW_AT_start_scope = 0x2c,
156  DW_AT_bit_stride = 0x2e,
157  DW_AT_upper_bound = 0x2f,
158  DW_AT_abstract_origin = 0x31,
159  DW_AT_accessibility = 0x32,
160  DW_AT_address_class = 0x33,
161  DW_AT_artificial = 0x34,
162  DW_AT_base_types = 0x35,
163  DW_AT_calling_convention = 0x36,
164  DW_AT_count = 0x37,
165  DW_AT_data_member_location = 0x38,
166  DW_AT_decl_column = 0x39,
167  DW_AT_decl_file = 0x3a,
168  DW_AT_decl_line = 0x3b,
169  DW_AT_declaration = 0x3c,
170  DW_AT_discr_list = 0x3d,
171  DW_AT_encoding = 0x3e,
172  DW_AT_external = 0x3f,
173  DW_AT_frame_base = 0x40,
174  DW_AT_friend = 0x41,
175  DW_AT_identifier_case = 0x42,
176  DW_AT_macro_info = 0x43,
177  DW_AT_namelist_item = 0x44,
178  DW_AT_priority = 0x45,
179  DW_AT_segment = 0x46,
180  DW_AT_specification = 0x47,
181  DW_AT_static_link = 0x48,
182  DW_AT_type = 0x49,
183  DW_AT_use_location = 0x4a,
184  DW_AT_variable_parameter = 0x4b,
185  DW_AT_virtuality = 0x4c,
186  DW_AT_vtable_elem_location = 0x4d,
187  DW_AT_allocated = 0x4e,
188  DW_AT_associated = 0x4f,
189  DW_AT_data_location = 0x50,
190  DW_AT_byte_stride = 0x51,
191  DW_AT_entry_pc = 0x52,
192  DW_AT_use_UTF8 = 0x53,
193  DW_AT_extension = 0x54,
194  DW_AT_ranges = 0x55,
195  DW_AT_trampoline = 0x56,
196  DW_AT_call_column = 0x57,
197  DW_AT_call_file = 0x58,
198  DW_AT_call_line = 0x59,
199  DW_AT_description = 0x5a,
200  DW_AT_binary_scale = 0x5b,
201  DW_AT_decimal_scale = 0x5c,
202  DW_AT_small = 0x5d,
203  DW_AT_decimal_sign = 0x5e,
204  DW_AT_digit_count = 0x5f,
205  DW_AT_picture_string = 0x60,
206  DW_AT_mutable = 0x61,
207  DW_AT_threads_scaled = 0x62,
208  DW_AT_explicit = 0x63,
209  DW_AT_object_pointer = 0x64,
210  DW_AT_endianity = 0x65,
211  DW_AT_elemental = 0x66,
212  DW_AT_pure = 0x67,
213  DW_AT_recursive = 0x68,
214  DW_AT_MIPS_linkage_name = 0x2007,
215  DW_AT_sf_names   = 0x2101,
216  DW_AT_src_info = 0x2102,
217  DW_AT_mac_info = 0x2103,
218  DW_AT_src_coords = 0x2104,
219  DW_AT_body_begin = 0x2105,
220  DW_AT_body_end = 0x2106,
221  DW_AT_GNU_vector = 0x2107,
222  DW_AT_lo_user = 0x2000,
223  DW_AT_hi_user = 0x3fff,
224
225  // Attribute form encodings
226  DW_FORM_addr = 0x01,
227  DW_FORM_block2 = 0x03,
228  DW_FORM_block4 = 0x04,
229  DW_FORM_data2 = 0x05,
230  DW_FORM_data4 = 0x06,
231  DW_FORM_data8 = 0x07,
232  DW_FORM_string = 0x08,
233  DW_FORM_block = 0x09,
234  DW_FORM_block1 = 0x0a,
235  DW_FORM_data1 = 0x0b,
236  DW_FORM_flag = 0x0c,
237  DW_FORM_sdata = 0x0d,
238  DW_FORM_strp = 0x0e,
239  DW_FORM_udata = 0x0f,
240  DW_FORM_ref_addr = 0x10,
241  DW_FORM_ref1 = 0x11,
242  DW_FORM_ref2 = 0x12,
243  DW_FORM_ref4 = 0x13,
244  DW_FORM_ref8 = 0x14,
245  DW_FORM_ref_udata = 0x15,
246  DW_FORM_indirect = 0x16,
247
248  // Operation encodings
249  DW_OP_addr = 0x03,
250  DW_OP_deref = 0x06,
251  DW_OP_const1u = 0x08,
252  DW_OP_const1s = 0x09,
253  DW_OP_const2u = 0x0a,
254  DW_OP_const2s = 0x0b,
255  DW_OP_const4u = 0x0c,
256  DW_OP_const4s = 0x0d,
257  DW_OP_const8u = 0x0e,
258  DW_OP_const8s = 0x0f,
259  DW_OP_constu = 0x10,
260  DW_OP_consts = 0x11,
261  DW_OP_dup = 0x12,
262  DW_OP_drop = 0x13,
263  DW_OP_over = 0x14,
264  DW_OP_pick = 0x15,
265  DW_OP_swap = 0x16,
266  DW_OP_rot = 0x17,
267  DW_OP_xderef = 0x18,
268  DW_OP_abs = 0x19,
269  DW_OP_and = 0x1a,
270  DW_OP_div = 0x1b,
271  DW_OP_minus = 0x1c,
272  DW_OP_mod = 0x1d,
273  DW_OP_mul = 0x1e,
274  DW_OP_neg = 0x1f,
275  DW_OP_not = 0x20,
276  DW_OP_or = 0x21,
277  DW_OP_plus = 0x22,
278  DW_OP_plus_uconst = 0x23,
279  DW_OP_shl = 0x24,
280  DW_OP_shr = 0x25,
281  DW_OP_shra = 0x26,
282  DW_OP_xor = 0x27,
283  DW_OP_skip = 0x2f,
284  DW_OP_bra = 0x28,
285  DW_OP_eq = 0x29,
286  DW_OP_ge = 0x2a,
287  DW_OP_gt = 0x2b,
288  DW_OP_le = 0x2c,
289  DW_OP_lt = 0x2d,
290  DW_OP_ne = 0x2e,
291  DW_OP_lit0 = 0x30,
292  DW_OP_lit1 = 0x31,
293  DW_OP_lit31 = 0x4f,
294  DW_OP_reg0 = 0x50,
295  DW_OP_reg1 = 0x51,
296  DW_OP_reg31 = 0x6f,
297  DW_OP_breg0 = 0x70,
298  DW_OP_breg1 = 0x71,
299  DW_OP_breg31 = 0x8f,
300  DW_OP_regx = 0x90,
301  DW_OP_fbreg = 0x91,
302  DW_OP_bregx = 0x92,
303  DW_OP_piece = 0x93,
304  DW_OP_deref_size = 0x94,
305  DW_OP_xderef_size = 0x95,
306  DW_OP_nop = 0x96,
307  DW_OP_push_object_address = 0x97,
308  DW_OP_call2 = 0x98,
309  DW_OP_call4 = 0x99,
310  DW_OP_call_ref = 0x9a,
311  DW_OP_form_tls_address = 0x9b,
312  DW_OP_call_frame_cfa = 0x9c,
313  DW_OP_lo_user = 0xe0,
314  DW_OP_hi_user = 0xff,
315
316  // Encoding attribute values
317  DW_ATE_address = 0x01,
318  DW_ATE_boolean = 0x02,
319  DW_ATE_complex_float = 0x03,
320  DW_ATE_float = 0x04,
321  DW_ATE_signed = 0x05,
322  DW_ATE_signed_char = 0x06,
323  DW_ATE_unsigned = 0x07,
324  DW_ATE_unsigned_char = 0x08,
325  DW_ATE_imaginary_float = 0x09,
326  DW_ATE_packed_decimal = 0x0a,
327  DW_ATE_numeric_string = 0x0b,
328  DW_ATE_edited = 0x0c,
329  DW_ATE_signed_fixed = 0x0d,
330  DW_ATE_unsigned_fixed = 0x0e,
331  DW_ATE_decimal_float = 0x0f,
332  DW_ATE_lo_user = 0x80,
333  DW_ATE_hi_user = 0xff,
334
335  // Decimal sign attribute values
336  DW_DS_unsigned = 0x01,
337  DW_DS_leading_overpunch = 0x02,
338  DW_DS_trailing_overpunch = 0x03,
339  DW_DS_leading_separate = 0x04,
340  DW_DS_trailing_separate = 0x05,
341
342  // Endianity attribute values
343  DW_END_default = 0x00,
344  DW_END_big = 0x01,
345  DW_END_little = 0x02,
346  DW_END_lo_user = 0x40,
347  DW_END_hi_user = 0xff,
348
349  // Accessibility codes
350  DW_ACCESS_public = 0x01,
351  DW_ACCESS_protected = 0x02,
352  DW_ACCESS_private = 0x03,
353
354  // Visibility codes
355  DW_VIS_local = 0x01,
356  DW_VIS_exported = 0x02,
357  DW_VIS_qualified = 0x03,
358
359  // Virtuality codes
360  DW_VIRTUALITY_none = 0x00,
361  DW_VIRTUALITY_virtual = 0x01,
362  DW_VIRTUALITY_pure_virtual = 0x02,
363
364  // Language names
365  DW_LANG_C89 = 0x0001,
366  DW_LANG_C = 0x0002,
367  DW_LANG_Ada83 = 0x0003,
368  DW_LANG_C_plus_plus = 0x0004,
369  DW_LANG_Cobol74 = 0x0005,
370  DW_LANG_Cobol85 = 0x0006,
371  DW_LANG_Fortran77 = 0x0007,
372  DW_LANG_Fortran90 = 0x0008,
373  DW_LANG_Pascal83 = 0x0009,
374  DW_LANG_Modula2 = 0x000a,
375  DW_LANG_Java = 0x000b,
376  DW_LANG_C99 = 0x000c,
377  DW_LANG_Ada95 = 0x000d,
378  DW_LANG_Fortran95 = 0x000e,
379  DW_LANG_PLI = 0x000f,
380  DW_LANG_ObjC = 0x0010,
381  DW_LANG_ObjC_plus_plus = 0x0011,
382  DW_LANG_UPC = 0x0012,
383  DW_LANG_D = 0x0013,
384  DW_LANG_lo_user = 0x8000,
385  DW_LANG_hi_user = 0xffff,
386
387  // Identifier case codes
388  DW_ID_case_sensitive = 0x00,
389  DW_ID_up_case = 0x01,
390  DW_ID_down_case = 0x02,
391  DW_ID_case_insensitive = 0x03,
392
393  // Calling convention codes
394  DW_CC_normal = 0x01,
395  DW_CC_program = 0x02,
396  DW_CC_nocall = 0x03,
397  DW_CC_lo_user = 0x40,
398  DW_CC_hi_user = 0xff,
399
400  // Inline codes
401  DW_INL_not_inlined = 0x00,
402  DW_INL_inlined = 0x01,
403  DW_INL_declared_not_inlined = 0x02,
404  DW_INL_declared_inlined = 0x03,
405
406  // Array ordering
407  DW_ORD_row_major = 0x00,
408  DW_ORD_col_major = 0x01,
409
410  // Discriminant descriptor values
411  DW_DSC_label = 0x00,
412  DW_DSC_range = 0x01,
413
414  // Line Number Standard Opcode Encodings
415  DW_LNS_copy = 0x01,
416  DW_LNS_advance_pc = 0x02,
417  DW_LNS_advance_line = 0x03,
418  DW_LNS_set_file = 0x04,
419  DW_LNS_set_column = 0x05,
420  DW_LNS_negate_stmt = 0x06,
421  DW_LNS_set_basic_block = 0x07,
422  DW_LNS_const_add_pc = 0x08,
423  DW_LNS_fixed_advance_pc = 0x09,
424  DW_LNS_set_prologue_end = 0x0a,
425  DW_LNS_set_epilogue_begin = 0x0b,
426  DW_LNS_set_isa = 0x0c,
427
428  // Line Number Extended Opcode Encodings
429  DW_LNE_end_sequence = 0x01,
430  DW_LNE_set_address = 0x02,
431  DW_LNE_define_file = 0x03,
432  DW_LNE_lo_user = 0x80,
433  DW_LNE_hi_user = 0xff,
434
435  // Macinfo Type Encodings
436  DW_MACINFO_define = 0x01,
437  DW_MACINFO_undef = 0x02,
438  DW_MACINFO_start_file = 0x03,
439  DW_MACINFO_end_file = 0x04,
440  DW_MACINFO_vendor_ext = 0xff,
441
442  // Call frame instruction encodings
443  DW_CFA_extended = 0x00,
444  DW_CFA_advance_loc = 0x40,
445  DW_CFA_offset = 0x80,
446  DW_CFA_restore = 0xc0,
447  DW_CFA_set_loc = 0x01,
448  DW_CFA_advance_loc1 = 0x02,
449  DW_CFA_advance_loc2 = 0x03,
450  DW_CFA_advance_loc4 = 0x04,
451  DW_CFA_offset_extended = 0x05,
452  DW_CFA_restore_extended = 0x06,
453  DW_CFA_undefined = 0x07,
454  DW_CFA_same_value = 0x08,
455  DW_CFA_register = 0x09,
456  DW_CFA_remember_state = 0x0a,
457  DW_CFA_restore_state = 0x0b,
458  DW_CFA_def_cfa = 0x0c,
459  DW_CFA_def_cfa_register = 0x0d,
460  DW_CFA_def_cfa_offset = 0x0e,
461  DW_CFA_def_cfa_expression = 0x0f,
462  DW_CFA_expression = 0x10,
463  DW_CFA_offset_extended_sf = 0x11,
464  DW_CFA_def_cfa_sf = 0x12,
465  DW_CFA_def_cfa_offset_sf = 0x13,
466  DW_CFA_val_offset = 0x14,
467  DW_CFA_val_offset_sf = 0x15,
468  DW_CFA_val_expression = 0x16,
469  DW_CFA_lo_user = 0x1c,
470  DW_CFA_hi_user = 0x3f,
471
472  DW_EH_PE_absptr = 0x00,
473  DW_EH_PE_omit = 0xff,
474  DW_EH_PE_uleb128 = 0x01,
475  DW_EH_PE_udata2 = 0x02,
476  DW_EH_PE_udata4 = 0x03,
477  DW_EH_PE_udata8 = 0x04,
478  DW_EH_PE_sleb128 = 0x09,
479  DW_EH_PE_sdata2 = 0x0A,
480  DW_EH_PE_sdata4 = 0x0B,
481  DW_EH_PE_sdata8 = 0x0C,
482  DW_EH_PE_signed = 0x08,
483  DW_EH_PE_pcrel = 0x10,
484  DW_EH_PE_textrel = 0x20,
485  DW_EH_PE_datarel = 0x30,
486  DW_EH_PE_funcrel = 0x40,
487  DW_EH_PE_aligned = 0x50,
488  DW_EH_PE_indirect = 0x80
489};
490
491/// TagString - Return the string for the specified tag.
492///
493const char *TagString(unsigned Tag);
494
495/// ChildrenString - Return the string for the specified children flag.
496///
497const char *ChildrenString(unsigned Children);
498
499/// AttributeString - Return the string for the specified attribute.
500///
501const char *AttributeString(unsigned Attribute);
502
503/// FormEncodingString - Return the string for the specified form encoding.
504///
505const char *FormEncodingString(unsigned Encoding);
506
507/// OperationEncodingString - Return the string for the specified operation
508/// encoding.
509const char *OperationEncodingString(unsigned Encoding);
510
511/// AttributeEncodingString - Return the string for the specified attribute
512/// encoding.
513const char *AttributeEncodingString(unsigned Encoding);
514
515/// DecimalSignString - Return the string for the specified decimal sign
516/// attribute.
517const char *DecimalSignString(unsigned Sign);
518
519/// EndianityString - Return the string for the specified endianity.
520///
521const char *EndianityString(unsigned Endian);
522
523/// AccessibilityString - Return the string for the specified accessibility.
524///
525const char *AccessibilityString(unsigned Access);
526
527/// VisibilityString - Return the string for the specified visibility.
528///
529const char *VisibilityString(unsigned Visibility);
530
531/// VirtualityString - Return the string for the specified virtuality.
532///
533const char *VirtualityString(unsigned Virtuality);
534
535/// LanguageString - Return the string for the specified language.
536///
537const char *LanguageString(unsigned Language);
538
539/// CaseString - Return the string for the specified identifier case.
540///
541const char *CaseString(unsigned Case);
542
543/// ConventionString - Return the string for the specified calling convention.
544///
545const char *ConventionString(unsigned Convention);
546
547/// InlineCodeString - Return the string for the specified inline code.
548///
549const char *InlineCodeString(unsigned Code);
550
551/// ArrayOrderString - Return the string for the specified array order.
552///
553const char *ArrayOrderString(unsigned Order);
554
555/// DiscriminantString - Return the string for the specified discriminant
556/// descriptor.
557const char *DiscriminantString(unsigned Discriminant);
558
559/// LNStandardString - Return the string for the specified line number standard.
560///
561const char *LNStandardString(unsigned Standard);
562
563/// LNExtendedString - Return the string for the specified line number extended
564/// opcode encodings.
565const char *LNExtendedString(unsigned Encoding);
566
567/// MacinfoString - Return the string for the specified macinfo type encodings.
568///
569const char *MacinfoString(unsigned Encoding);
570
571/// CallFrameString - Return the string for the specified call frame instruction
572/// encodings.
573const char *CallFrameString(unsigned Encoding);
574
575} // End of namespace dwarf
576
577} // End of namespace llvm
578
579#endif
580