Grammer correction.
[oota-llvm.git] / include / llvm / CodeGen / DwarfWriter.h
1 //===-- llvm/CodeGen/DwarfWriter.h - Dwarf Framework ------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file was developed by James M. Laskey and is distributed under the
6 // University of Illinois Open Source License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file contains support for writing dwarf debug info into asm files.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef LLVM_CODEGEN_DWARFPRINTER_H
15 #define LLVM_CODEGEN_DWARFPRINTER_H
16
17 #include <iosfwd>
18
19 namespace llvm {
20
21   //===--------------------------------------------------------------------===//
22   // Dwarf constants as gleaned from the DWARF Debugging Information Format V.3
23   // reference manual http://dwarf.freestandards.org .
24   //
25   enum dwarf_constants {
26    // Tags
27     DW_TAG_array_type = 0x01,
28     DW_TAG_class_type = 0x02,
29     DW_TAG_entry_point = 0x03,
30     DW_TAG_enumeration_type = 0x04,
31     DW_TAG_formal_parameter = 0x05,
32     DW_TAG_imported_declaration = 0x08,
33     DW_TAG_label = 0x0a,
34     DW_TAG_lexical_block = 0x0b,
35     DW_TAG_member = 0x0d,
36     DW_TAG_pointer_type = 0x0f,
37     DW_TAG_reference_type = 0x10,
38     DW_TAG_compile_unit = 0x11,
39     DW_TAG_string_type = 0x12,
40     DW_TAG_structure_type = 0x13,
41     DW_TAG_subroutine_type = 0x15,
42     DW_TAG_typedef = 0x16,
43     DW_TAG_union_type = 0x17,
44     DW_TAG_unspecified_parameters = 0x18,
45     DW_TAG_variant = 0x19,
46     DW_TAG_common_block = 0x1a,
47     DW_TAG_common_inclusion = 0x1b,
48     DW_TAG_inheritance = 0x1c,
49     DW_TAG_inlined_subroutine = 0x1d,
50     DW_TAG_module = 0x1e,
51     DW_TAG_ptr_to_member_type = 0x1f,
52     DW_TAG_set_type = 0x20,
53     DW_TAG_subrange_type = 0x21,
54     DW_TAG_with_stmt = 0x22,
55     DW_TAG_access_declaration = 0x23,
56     DW_TAG_base_type = 0x24,
57     DW_TAG_catch_block = 0x25,
58     DW_TAG_const_type = 0x26,
59     DW_TAG_constant = 0x27,
60     DW_TAG_enumerator = 0x28,
61     DW_TAG_file_type = 0x29,
62     DW_TAG_friend = 0x2a,
63     DW_TAG_namelist = 0x2b,
64     DW_TAG_namelist_item = 0x2c,
65     DW_TAG_packed_type = 0x2d,
66     DW_TAG_subprogram = 0x2e,
67     DW_TAG_template_type_parameter = 0x2f,
68     DW_TAG_template_value_parameter = 0x30,
69     DW_TAG_thrown_type = 0x31,
70     DW_TAG_try_block = 0x32,
71     DW_TAG_variant_part = 0x33,
72     DW_TAG_variable = 0x34,
73     DW_TAG_volatile_type = 0x35,
74     DW_TAG_dwarf_procedure = 0x36,
75     DW_TAG_restrict_type = 0x37,
76     DW_TAG_interface_type = 0x38,
77     DW_TAG_namespace = 0x39,
78     DW_TAG_imported_module = 0x3a,
79     DW_TAG_unspecified_type = 0x3b,
80     DW_TAG_partial_unit = 0x3c,
81     DW_TAG_imported_unit = 0x3d,
82     DW_TAG_condition = 0x3f,
83     DW_TAG_shared_type = 0x40,
84     DW_TAG_lo_user = 0x4080,
85     DW_TAG_hi_user = 0xffff,
86
87     // Children flag
88     DW_CHILDREN_no = 0x00,
89     DW_CHILDREN_yes = 0x01,
90
91     // Attributes
92     DW_AT_sibling = 0x01,
93     DW_AT_location = 0x02,
94     DW_AT_name = 0x03,
95     DW_AT_ordering = 0x09,
96     DW_AT_byte_size = 0x0b,
97     DW_AT_bit_offset = 0x0c,
98     DW_AT_bit_size = 0x0d,
99     DW_AT_stmt_list = 0x10,
100     DW_AT_low_pc = 0x11,
101     DW_AT_high_pc = 0x12,
102     DW_AT_language = 0x13,
103     DW_AT_discr = 0x15,
104     DW_AT_discr_value = 0x16,
105     DW_AT_visibility = 0x17,
106     DW_AT_import = 0x18,
107     DW_AT_string_length = 0x19,
108     DW_AT_common_reference = 0x1a,
109     DW_AT_comp_dir = 0x1b,
110     DW_AT_const_value = 0x1c,
111     DW_AT_containing_type = 0x1d,
112     DW_AT_default_value = 0x1e,
113     DW_AT_inline = 0x20,
114     DW_AT_is_optional = 0x21,
115     DW_AT_lower_bound = 0x22,
116     DW_AT_producer = 0x25,
117     DW_AT_prototyped = 0x27,
118     DW_AT_return_addr = 0x2a,
119     DW_AT_start_scope = 0x2c,
120     DW_AT_bit_stride = 0x2e,
121     DW_AT_upper_bound = 0x2f,
122     DW_AT_abstract_origin = 0x31,
123     DW_AT_accessibility = 0x32,
124     DW_AT_address_class = 0x33,
125     DW_AT_artificial = 0x34,
126     DW_AT_base_types = 0x35,
127     DW_AT_calling_convention = 0x36,
128     DW_AT_count = 0x37,
129     DW_AT_data_member_location = 0x38,
130     DW_AT_decl_column = 0x39,
131     DW_AT_decl_file = 0x3a,
132     DW_AT_decl_line = 0x3b,
133     DW_AT_declaration = 0x3c,
134     DW_AT_discr_list = 0x3d,
135     DW_AT_encoding = 0x3e,
136     DW_AT_external = 0x3f,
137     DW_AT_frame_base = 0x40,
138     DW_AT_friend = 0x41,
139     DW_AT_identifier_case = 0x42,
140     DW_AT_macro_info = 0x43,
141     DW_AT_namelist_item = 0x44,
142     DW_AT_priority = 0x45,
143     DW_AT_segment = 0x46,
144     DW_AT_specification = 0x47,
145     DW_AT_static_link = 0x48,
146     DW_AT_type = 0x49,
147     DW_AT_use_location = 0x4a,
148     DW_AT_variable_parameter = 0x4b,
149     DW_AT_virtuality = 0x4c,
150     DW_AT_vtable_elem_location = 0x4d,
151     DW_AT_allocated = 0x4e,
152     DW_AT_associated = 0x4f,
153     DW_AT_data_location = 0x50,
154     DW_AT_byte_stride = 0x51,
155     DW_AT_entry_pc = 0x52,
156     DW_AT_use_UTF8 = 0x53,
157     DW_AT_extension = 0x54,
158     DW_AT_ranges = 0x55,
159     DW_AT_trampoline = 0x56,
160     DW_AT_call_column = 0x57,
161     DW_AT_call_file = 0x58,
162     DW_AT_call_line = 0x59,
163     DW_AT_description = 0x5a,
164     DW_AT_binary_scale = 0x5b,
165     DW_AT_decimal_scale = 0x5c,
166     DW_AT_small = 0x5d,
167     DW_AT_decimal_sign = 0x5e,
168     DW_AT_digit_count = 0x5f,
169     DW_AT_picture_string = 0x60,
170     DW_AT_mutable = 0x61,
171     DW_AT_threads_scaled = 0x62,
172     DW_AT_explicit = 0x63,
173     DW_AT_object_pointer = 0x64,
174     DW_AT_endianity = 0x65,
175     DW_AT_elemental = 0x66,
176     DW_AT_pure = 0x67,
177     DW_AT_recursive = 0x68,
178     DW_AT_lo_user = 0x2000,
179     DW_AT_hi_user = 0x3fff,
180
181     // Attribute form encodings
182     DW_FORM_addr = 0x01,
183     DW_FORM_block2 = 0x03,
184     DW_FORM_block4 = 0x04,
185     DW_FORM_data2 = 0x05,
186     DW_FORM_data4 = 0x06,
187     DW_FORM_data8 = 0x07,
188     DW_FORM_string = 0x08,
189     DW_FORM_block = 0x09,
190     DW_FORM_block1 = 0x0a,
191     DW_FORM_data1 = 0x0b,
192     DW_FORM_flag = 0x0c,
193     DW_FORM_sdata = 0x0d,
194     DW_FORM_strp = 0x0e,
195     DW_FORM_udata = 0x0f,
196     DW_FORM_ref_addr = 0x10,
197     DW_FORM_ref1 = 0x11,
198     DW_FORM_ref2 = 0x12,
199     DW_FORM_ref4 = 0x13,
200     DW_FORM_ref8 = 0x14,
201     DW_FORM_ref_udata = 0x15,
202     DW_FORM_indirect = 0x16,
203
204     // Operation encodings
205     DW_OP_addr = 0x03,
206     DW_OP_deref = 0x06,
207     DW_OP_const1u = 0x08,
208     DW_OP_const1s = 0x09,
209     DW_OP_const2u = 0x0a,
210     DW_OP_const2s = 0x0b,
211     DW_OP_const4u = 0x0c,
212     DW_OP_const4s = 0x0d,
213     DW_OP_const8u = 0x0e,
214     DW_OP_const8s = 0x0f,
215     DW_OP_constu = 0x10,
216     DW_OP_consts = 0x11,
217     DW_OP_dup = 0x12,
218     DW_OP_drop = 0x13,
219     DW_OP_over = 0x14,
220     DW_OP_pick = 0x15,
221     DW_OP_swap = 0x16,
222     DW_OP_rot = 0x17,
223     DW_OP_xderef = 0x18,
224     DW_OP_abs = 0x19,
225     DW_OP_and = 0x1a,
226     DW_OP_div = 0x1b,
227     DW_OP_minus = 0x1c,
228     DW_OP_mod = 0x1d,
229     DW_OP_mul = 0x1e,
230     DW_OP_neg = 0x1f,
231     DW_OP_not = 0x20,
232     DW_OP_or = 0x21,
233     DW_OP_plus = 0x22,
234     DW_OP_plus_uconst = 0x23,
235     DW_OP_shl = 0x24,
236     DW_OP_shr = 0x25,
237     DW_OP_shra = 0x26,
238     DW_OP_xor = 0x27,
239     DW_OP_skip = 0x2f,
240     DW_OP_bra = 0x28,
241     DW_OP_eq = 0x29,
242     DW_OP_ge = 0x2a,
243     DW_OP_gt = 0x2b,
244     DW_OP_le = 0x2c,
245     DW_OP_lt = 0x2d,
246     DW_OP_ne = 0x2e,
247     DW_OP_lit0 = 0x30,
248     DW_OP_lit1 = 0x31,
249     DW_OP_lit31 = 0x4f,
250     DW_OP_reg0 = 0x50,
251     DW_OP_reg1 = 0x51,
252     DW_OP_reg31 = 0x6f,
253     DW_OP_breg0 = 0x70,
254     DW_OP_breg1 = 0x71,
255     DW_OP_breg31 = 0x8f,
256     DW_OP_regx = 0x90,
257     DW_OP_fbreg = 0x91,
258     DW_OP_bregx = 0x92,
259     DW_OP_piece = 0x93,
260     DW_OP_deref_size = 0x94,
261     DW_OP_xderef_size = 0x95,
262     DW_OP_nop = 0x96,
263     DW_OP_push_object_address = 0x97,
264     DW_OP_call2 = 0x98,
265     DW_OP_call4 = 0x99,
266     DW_OP_call_ref = 0x9a,
267     DW_OP_form_tls_address = 0x9b,
268     DW_OP_call_frame_cfa = 0x9c,
269     DW_OP_lo_user = 0xe0,
270     DW_OP_hi_user = 0xff,
271
272     // Encoding attribute values
273     DW_ATE_address = 0x01,
274     DW_ATE_boolean = 0x02,
275     DW_ATE_complex_float = 0x03,
276     DW_ATE_float = 0x04,
277     DW_ATE_signed = 0x05,
278     DW_ATE_signed_char = 0x06,
279     DW_ATE_unsigned = 0x07,
280     DW_ATE_unsigned_char = 0x08,
281     DW_ATE_imaginary_float = 0x09,
282     DW_ATE_packed_decimal = 0x0a,
283     DW_ATE_numeric_string = 0x0b,
284     DW_ATE_edited = 0x0c,
285     DW_ATE_signed_fixed = 0x0d,
286     DW_ATE_unsigned_fixed = 0x0e,
287     DW_ATE_decimal_float = 0x0f,
288     DW_ATE_lo_user = 0x80,
289     DW_ATE_hi_user = 0xff,
290
291     // Decimal sign attribute values
292     DW_DS_unsigned = 0x01,
293     DW_DS_leading_overpunch = 0x02,
294     DW_DS_trailing_overpunch = 0x03,
295     DW_DS_leading_separate = 0x04,
296     DW_DS_trailing_separate = 0x05,
297
298     // Endianity attribute values
299     DW_END_default = 0x00,
300     DW_END_big = 0x01,
301     DW_END_little = 0x02,
302     DW_END_lo_user = 0x40,
303     DW_END_hi_user = 0xff,
304
305     // Accessibility codes
306     DW_ACCESS_public = 0x01,
307     DW_ACCESS_protected = 0x02,
308     DW_ACCESS_private = 0x03,
309
310     // Visibility codes 
311     DW_VIS_local = 0x01,
312     DW_VIS_exported = 0x02,
313     DW_VIS_qualified = 0x03,
314
315     // Virtuality codes
316     DW_VIRTUALITY_none = 0x00,
317     DW_VIRTUALITY_virtual = 0x01,
318     DW_VIRTUALITY_pure_virtual = 0x02,
319     
320     // Language names
321     DW_LANG_C89 = 0x0001,
322     DW_LANG_C = 0x0002,
323     DW_LANG_Ada83 = 0x0003,
324     DW_LANG_C_plus_plus = 0x0004,
325     DW_LANG_Cobol74 = 0x0005,
326     DW_LANG_Cobol85 = 0x0006,
327     DW_LANG_Fortran77 = 0x0007,
328     DW_LANG_Fortran90 = 0x0008,
329     DW_LANG_Pascal83 = 0x0009,
330     DW_LANG_Modula2 = 0x000a,
331     DW_LANG_Java = 0x000b,
332     DW_LANG_C99 = 0x000c,
333     DW_LANG_Ada95 = 0x000d,
334     DW_LANG_Fortran95 = 0x000e,
335     DW_LANG_PLI = 0x000f,
336     DW_LANG_ObjC = 0x0010,
337     DW_LANG_ObjC_plus_plus = 0x0011,
338     DW_LANG_UPC = 0x0012,
339     DW_LANG_D = 0x0013,
340     DW_LANG_lo_user = 0x8000,
341     DW_LANG_hi_user = 0xffff,
342     
343     // Identifier case codes
344     DW_ID_case_sensitive = 0x00,
345     DW_ID_up_case = 0x01,
346     DW_ID_down_case = 0x02,
347     DW_ID_case_insensitive = 0x03,
348
349     // Calling convention codes
350     DW_CC_normal = 0x01,
351     DW_CC_program = 0x02,
352     DW_CC_nocall = 0x03,
353     DW_CC_lo_user = 0x40,
354     DW_CC_hi_user = 0xff,
355
356     // Inline codes
357     DW_INL_not_inlined = 0x00,
358     DW_INL_inlined = 0x01,
359     DW_INL_declared_not_inlined = 0x02,
360     DW_INL_declared_inlined = 0x03,
361
362     // Array ordering 
363     DW_ORD_row_major = 0x00,
364     DW_ORD_col_major = 0x01,
365
366     // Discriminant descriptor values
367     DW_DSC_label = 0x00,
368     DW_DSC_range = 0x01,
369
370     // Line Number Standard Opcode Encodings
371     DW_LNS_copy = 0x01,
372     DW_LNS_advance_pc = 0x02,
373     DW_LNS_advance_line = 0x03,
374     DW_LNS_set_file = 0x04,
375     DW_LNS_set_column = 0x05,
376     DW_LNS_negate_stmt = 0x06,
377     DW_LNS_set_basic_block = 0x07,
378     DW_LNS_const_add_pc = 0x08,
379     DW_LNS_fixed_advance_pc = 0x09,
380     DW_LNS_set_prologue_end = 0x0a,
381     DW_LNS_set_epilogue_begin = 0x0b,
382     DW_LNS_set_isa = 0x0c,
383
384     // Line Number Extended Opcode Encodings
385     DW_LNE_end_sequence = 0x01,
386     DW_LNE_set_address = 0x02,
387     DW_LNE_define_file = 0x03,
388     DW_LNE_lo_user = 0x80,
389     DW_LNE_hi_user = 0xff,
390
391     // Macinfo Type Encodings
392     DW_MACINFO_define = 0x01,
393     DW_MACINFO_undef = 0x02,
394     DW_MACINFO_start_file = 0x03,
395     DW_MACINFO_end_file = 0x04,
396     DW_MACINFO_vendor_ext = 0xff,
397
398     // Call frame instruction encodings
399     DW_CFA_advance_loc = 0x40,
400     DW_CFA_offset = 0x80,
401     DW_CFA_restore = 0xc0,
402     DW_CFA_set_loc = 0x01,
403     DW_CFA_advance_loc1 = 0x02,
404     DW_CFA_advance_loc2 = 0x03,
405     DW_CFA_advance_loc4 = 0x04,
406     DW_CFA_offset_extended = 0x05,
407     DW_CFA_restore_extended = 0x06,
408     DW_CFA_undefined = 0x07,
409     DW_CFA_same_value = 0x08,
410     DW_CFA_register = 0x09,
411     DW_CFA_remember_state = 0x0a,
412     DW_CFA_restore_state = 0x0b,
413     DW_CFA_def_cfa = 0x0c,
414     DW_CFA_def_cfa_register = 0x0d,
415     DW_CFA_def_cfa_offset = 0x0e,
416     DW_CFA_def_cfa_expression = 0x0f,
417     DW_CFA_expression = 0x10,
418     DW_CFA_offset_extended_sf = 0x11,
419     DW_CFA_def_cfa_sf = 0x12,
420     DW_CFA_def_cfa_offset_sf = 0x13,
421     DW_CFA_val_offset = 0x14,
422     DW_CFA_val_offset_sf = 0x15,
423     DW_CFA_val_expression = 0x16,
424     DW_CFA_lo_user = 0x1c,
425     DW_CFA_hi_user = 0x3f
426   };
427   
428   // Forward declarations.
429   //
430   class AsmPrinter;
431   class MachineDebugInfo;
432   
433   //===--------------------------------------------------------------------===//
434   // DwarfWriter - emits dwarf debug and exception handling directives.
435   //
436   class DwarfWriter {
437   
438   protected:
439   
440     /// O - Stream to .s file.
441     ///
442     std::ostream &O;
443
444     /// Asm - Target of dwarf emission.
445     ///
446     AsmPrinter *Asm;
447     
448     /// DebugInfo - Collected debug information.
449     ///
450     MachineDebugInfo *DebugInfo;
451     
452     /// didInitial - Flag to indicate if initial emission has been done.
453     ///
454     bool didInitial;
455     
456     //===------------------------------------------------------------------===//
457     // Properties to be set by the derived class ctor, used to configure the
458     // dwarf writer.
459
460     /// hasLEB128 - True if target asm supports leb128 directives.
461     ///
462     bool hasLEB128; /// Defaults to false.
463     
464     /// hasDotLoc - True if target asm supports .loc directives.
465     ///
466     bool hasDotLoc; /// Defaults to false.
467     
468     /// hasDotFile - True if target asm supports .file directives.
469     ///
470     bool hasDotFile; /// Defaults to false.
471     
472     /// needsSet - True if target asm can't compute addresses on data
473     /// directives.
474     bool needsSet; /// Defaults to false.
475     
476     /// DwarfAbbrevSection - section directive arg for dwarf abbrev.
477     ///
478     const char *DwarfAbbrevSection; /// Defaults to ".debug_abbrev".
479
480     /// DwarfInfoSection - section directive arg for dwarf info.
481     ///
482     const char *DwarfInfoSection; /// Defaults to ".debug_info".
483
484     /// DwarfLineSection - section directive arg for dwarf info.
485     ///
486     const char *DwarfLineSection; /// Defaults to ".debug_line".
487
488     //===------------------------------------------------------------------===//
489
490   public:
491     
492     // Ctor.
493     DwarfWriter(std::ostream &o, AsmPrinter *ap)
494     : O(o)
495     , Asm(ap)
496     , DebugInfo(NULL)
497     , didInitial(false)
498     , hasLEB128(false)
499     , hasDotLoc(false)
500     , hasDotFile(false)
501     , needsSet(false)
502     , DwarfAbbrevSection(".debug_abbrev")
503     , DwarfInfoSection(".debug_info")
504     , DwarfLineSection(".debug_line")
505     {}
506     
507     /// SetDebugInfo - Set DebugInfo at when it's know that pass manager
508     /// has created it.
509     void SetDebugInfo(MachineDebugInfo *di) { DebugInfo = di; }
510     
511     /// EmitHex - Emit a hexidecimal string to the output stream.
512     ///
513     void EmitHex(unsigned Value) const;
514     
515     /// EmitComment - Emit a simple string comment.
516     ///
517     void EmitComment(const char *Comment) const;
518
519     /// EmitULEB128 - Emit a series of hexidecimal values (separated by commas)
520     /// representing an unsigned leb128 value.
521     ///
522     void EmitULEB128(unsigned Value) const;
523
524     /// EmitSLEB128 - Emit a series of hexidecimal values (separated by commas)
525     /// representing a signed leb128 value.
526     ///
527     void EmitSLEB128(int Value) const;
528     
529     /// EmitLabelName - Emit label name for internal use by dwarf.
530     ///
531     void EmitLabelName(const char *Tag, int Num) const;
532     
533     /// EmitLabel - Emit location label for internal use by dwarf.
534     ///
535     void EmitLabel(const char *Tag, int Num) const;
536     
537     /// EmitULEB128Bytes - Emit an assembler byte data directive to compose an
538     /// unsigned leb128 value.  Comment is added to the end of the directive if
539     /// DwarfVerbose is true (should not contain any newlines.)
540     ///
541     void EmitULEB128Bytes(unsigned Value, const char *Comment) const;
542     
543     /// EmitSLEB128Bytes - Emit an assembler byte data directive to compose a
544     /// signed leb128 value.  Comment is added to the end of the directive if
545     /// DwarfVerbose is true (should not contain any newlines.)
546     ///
547     void EmitSLEB128Bytes(int Value, const char *Comment) const;
548     
549     /// EmitInitial - Emit initial dwarf declarations.
550     ///
551     void EmitInitial() const;
552     
553     /// ShouldEmitDwarf - Returns true if dwarf declarations should be made.
554     /// When called it also checks to see if debug info is newly available.  if
555     /// so the initial dwarf headers are emitted.
556     bool ShouldEmitDwarf();
557
558     /// BeginModule - Emit all dwarf sections that should come prior to the
559     /// content.
560     void BeginModule();
561     
562     /// EndModule - Emit all dwarf sections that should come after the content.
563     ///
564     void EndModule();
565     
566     /// BeginFunction - Emit pre-function debug information.
567     ///
568     void BeginFunction();
569     
570     /// EndFunction - Emit post-function debug information.
571     ///
572     void EndFunction();
573   };
574   
575
576 } // end llvm namespace
577
578 #endif