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