1 //===-- llvm/CodeGen/DwarfWriter.cpp - Dwarf Framework ----------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
10 // This file contains support for writing dwarf debug info into asm files.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/CodeGen/DwarfWriter.h"
16 #include "llvm/ADT/StringExtras.h"
17 #include "llvm/Module.h"
18 #include "llvm/Type.h"
19 #include "llvm/CodeGen/AsmPrinter.h"
20 #include "llvm/CodeGen/MachineDebugInfo.h"
21 #include "llvm/Support/Dwarf.h"
22 #include "llvm/Support/CommandLine.h"
23 #include "llvm/Support/Mangler.h"
24 #include "llvm/Target/TargetMachine.h"
31 DwarfVerbose("dwarf-verbose", cl::Hidden,
32 cl::desc("Add comments to Dwarf directives."));
34 //===----------------------------------------------------------------------===//
36 /// TagString - Return the string for the specified tag.
38 static const char *TagString(unsigned Tag) {
40 case DW_TAG_array_type: return "TAG_array_type";
41 case DW_TAG_class_type: return "TAG_class_type";
42 case DW_TAG_entry_point: return "TAG_entry_point";
43 case DW_TAG_enumeration_type: return "TAG_enumeration_type";
44 case DW_TAG_formal_parameter: return "TAG_formal_parameter";
45 case DW_TAG_imported_declaration: return "TAG_imported_declaration";
46 case DW_TAG_label: return "TAG_label";
47 case DW_TAG_lexical_block: return "TAG_lexical_block";
48 case DW_TAG_member: return "TAG_member";
49 case DW_TAG_pointer_type: return "TAG_pointer_type";
50 case DW_TAG_reference_type: return "TAG_reference_type";
51 case DW_TAG_compile_unit: return "TAG_compile_unit";
52 case DW_TAG_string_type: return "TAG_string_type";
53 case DW_TAG_structure_type: return "TAG_structure_type";
54 case DW_TAG_subroutine_type: return "TAG_subroutine_type";
55 case DW_TAG_typedef: return "TAG_typedef";
56 case DW_TAG_union_type: return "TAG_union_type";
57 case DW_TAG_unspecified_parameters: return "TAG_unspecified_parameters";
58 case DW_TAG_variant: return "TAG_variant";
59 case DW_TAG_common_block: return "TAG_common_block";
60 case DW_TAG_common_inclusion: return "TAG_common_inclusion";
61 case DW_TAG_inheritance: return "TAG_inheritance";
62 case DW_TAG_inlined_subroutine: return "TAG_inlined_subroutine";
63 case DW_TAG_module: return "TAG_module";
64 case DW_TAG_ptr_to_member_type: return "TAG_ptr_to_member_type";
65 case DW_TAG_set_type: return "TAG_set_type";
66 case DW_TAG_subrange_type: return "TAG_subrange_type";
67 case DW_TAG_with_stmt: return "TAG_with_stmt";
68 case DW_TAG_access_declaration: return "TAG_access_declaration";
69 case DW_TAG_base_type: return "TAG_base_type";
70 case DW_TAG_catch_block: return "TAG_catch_block";
71 case DW_TAG_const_type: return "TAG_const_type";
72 case DW_TAG_constant: return "TAG_constant";
73 case DW_TAG_enumerator: return "TAG_enumerator";
74 case DW_TAG_file_type: return "TAG_file_type";
75 case DW_TAG_friend: return "TAG_friend";
76 case DW_TAG_namelist: return "TAG_namelist";
77 case DW_TAG_namelist_item: return "TAG_namelist_item";
78 case DW_TAG_packed_type: return "TAG_packed_type";
79 case DW_TAG_subprogram: return "TAG_subprogram";
80 case DW_TAG_template_type_parameter: return "TAG_template_type_parameter";
81 case DW_TAG_template_value_parameter: return "TAG_template_value_parameter";
82 case DW_TAG_thrown_type: return "TAG_thrown_type";
83 case DW_TAG_try_block: return "TAG_try_block";
84 case DW_TAG_variant_part: return "TAG_variant_part";
85 case DW_TAG_variable: return "TAG_variable";
86 case DW_TAG_volatile_type: return "TAG_volatile_type";
87 case DW_TAG_dwarf_procedure: return "TAG_dwarf_procedure";
88 case DW_TAG_restrict_type: return "TAG_restrict_type";
89 case DW_TAG_interface_type: return "TAG_interface_type";
90 case DW_TAG_namespace: return "TAG_namespace";
91 case DW_TAG_imported_module: return "TAG_imported_module";
92 case DW_TAG_unspecified_type: return "TAG_unspecified_type";
93 case DW_TAG_partial_unit: return "TAG_partial_unit";
94 case DW_TAG_imported_unit: return "TAG_imported_unit";
95 case DW_TAG_condition: return "TAG_condition";
96 case DW_TAG_shared_type: return "TAG_shared_type";
97 case DW_TAG_lo_user: return "TAG_lo_user";
98 case DW_TAG_hi_user: return "TAG_hi_user";
100 assert(0 && "Unknown Dwarf Tag");
104 /// ChildrenString - Return the string for the specified children flag.
106 static const char *ChildrenString(unsigned Children) {
108 case DW_CHILDREN_no: return "CHILDREN_no";
109 case DW_CHILDREN_yes: return "CHILDREN_yes";
111 assert(0 && "Unknown Dwarf ChildrenFlag");
115 /// AttributeString - Return the string for the specified attribute.
117 static const char *AttributeString(unsigned Attribute) {
119 case DW_AT_sibling: return "AT_sibling";
120 case DW_AT_location: return "AT_location";
121 case DW_AT_name: return "AT_name";
122 case DW_AT_ordering: return "AT_ordering";
123 case DW_AT_byte_size: return "AT_byte_size";
124 case DW_AT_bit_offset: return "AT_bit_offset";
125 case DW_AT_bit_size: return "AT_bit_size";
126 case DW_AT_stmt_list: return "AT_stmt_list";
127 case DW_AT_low_pc: return "AT_low_pc";
128 case DW_AT_high_pc: return "AT_high_pc";
129 case DW_AT_language: return "AT_language";
130 case DW_AT_discr: return "AT_discr";
131 case DW_AT_discr_value: return "AT_discr_value";
132 case DW_AT_visibility: return "AT_visibility";
133 case DW_AT_import: return "AT_import";
134 case DW_AT_string_length: return "AT_string_length";
135 case DW_AT_common_reference: return "AT_common_reference";
136 case DW_AT_comp_dir: return "AT_comp_dir";
137 case DW_AT_const_value: return "AT_const_value";
138 case DW_AT_containing_type: return "AT_containing_type";
139 case DW_AT_default_value: return "AT_default_value";
140 case DW_AT_inline: return "AT_inline";
141 case DW_AT_is_optional: return "AT_is_optional";
142 case DW_AT_lower_bound: return "AT_lower_bound";
143 case DW_AT_producer: return "AT_producer";
144 case DW_AT_prototyped: return "AT_prototyped";
145 case DW_AT_return_addr: return "AT_return_addr";
146 case DW_AT_start_scope: return "AT_start_scope";
147 case DW_AT_bit_stride: return "AT_bit_stride";
148 case DW_AT_upper_bound: return "AT_upper_bound";
149 case DW_AT_abstract_origin: return "AT_abstract_origin";
150 case DW_AT_accessibility: return "AT_accessibility";
151 case DW_AT_address_class: return "AT_address_class";
152 case DW_AT_artificial: return "AT_artificial";
153 case DW_AT_base_types: return "AT_base_types";
154 case DW_AT_calling_convention: return "AT_calling_convention";
155 case DW_AT_count: return "AT_count";
156 case DW_AT_data_member_location: return "AT_data_member_location";
157 case DW_AT_decl_column: return "AT_decl_column";
158 case DW_AT_decl_file: return "AT_decl_file";
159 case DW_AT_decl_line: return "AT_decl_line";
160 case DW_AT_declaration: return "AT_declaration";
161 case DW_AT_discr_list: return "AT_discr_list";
162 case DW_AT_encoding: return "AT_encoding";
163 case DW_AT_external: return "AT_external";
164 case DW_AT_frame_base: return "AT_frame_base";
165 case DW_AT_friend: return "AT_friend";
166 case DW_AT_identifier_case: return "AT_identifier_case";
167 case DW_AT_macro_info: return "AT_macro_info";
168 case DW_AT_namelist_item: return "AT_namelist_item";
169 case DW_AT_priority: return "AT_priority";
170 case DW_AT_segment: return "AT_segment";
171 case DW_AT_specification: return "AT_specification";
172 case DW_AT_static_link: return "AT_static_link";
173 case DW_AT_type: return "AT_type";
174 case DW_AT_use_location: return "AT_use_location";
175 case DW_AT_variable_parameter: return "AT_variable_parameter";
176 case DW_AT_virtuality: return "AT_virtuality";
177 case DW_AT_vtable_elem_location: return "AT_vtable_elem_location";
178 case DW_AT_allocated: return "AT_allocated";
179 case DW_AT_associated: return "AT_associated";
180 case DW_AT_data_location: return "AT_data_location";
181 case DW_AT_byte_stride: return "AT_byte_stride";
182 case DW_AT_entry_pc: return "AT_entry_pc";
183 case DW_AT_use_UTF8: return "AT_use_UTF8";
184 case DW_AT_extension: return "AT_extension";
185 case DW_AT_ranges: return "AT_ranges";
186 case DW_AT_trampoline: return "AT_trampoline";
187 case DW_AT_call_column: return "AT_call_column";
188 case DW_AT_call_file: return "AT_call_file";
189 case DW_AT_call_line: return "AT_call_line";
190 case DW_AT_description: return "AT_description";
191 case DW_AT_binary_scale: return "AT_binary_scale";
192 case DW_AT_decimal_scale: return "AT_decimal_scale";
193 case DW_AT_small: return "AT_small";
194 case DW_AT_decimal_sign: return "AT_decimal_sign";
195 case DW_AT_digit_count: return "AT_digit_count";
196 case DW_AT_picture_string: return "AT_picture_string";
197 case DW_AT_mutable: return "AT_mutable";
198 case DW_AT_threads_scaled: return "AT_threads_scaled";
199 case DW_AT_explicit: return "AT_explicit";
200 case DW_AT_object_pointer: return "AT_object_pointer";
201 case DW_AT_endianity: return "AT_endianity";
202 case DW_AT_elemental: return "AT_elemental";
203 case DW_AT_pure: return "AT_pure";
204 case DW_AT_recursive: return "AT_recursive";
205 case DW_AT_lo_user: return "AT_lo_user";
206 case DW_AT_hi_user: return "AT_hi_user";
208 assert(0 && "Unknown Dwarf Attribute");
212 /// FormEncodingString - Return the string for the specified form encoding.
214 static const char *FormEncodingString(unsigned Encoding) {
216 case DW_FORM_addr: return "FORM_addr";
217 case DW_FORM_block2: return "FORM_block2";
218 case DW_FORM_block4: return "FORM_block4";
219 case DW_FORM_data2: return "FORM_data2";
220 case DW_FORM_data4: return "FORM_data4";
221 case DW_FORM_data8: return "FORM_data8";
222 case DW_FORM_string: return "FORM_string";
223 case DW_FORM_block: return "FORM_block";
224 case DW_FORM_block1: return "FORM_block1";
225 case DW_FORM_data1: return "FORM_data1";
226 case DW_FORM_flag: return "FORM_flag";
227 case DW_FORM_sdata: return "FORM_sdata";
228 case DW_FORM_strp: return "FORM_strp";
229 case DW_FORM_udata: return "FORM_udata";
230 case DW_FORM_ref_addr: return "FORM_ref_addr";
231 case DW_FORM_ref1: return "FORM_ref1";
232 case DW_FORM_ref2: return "FORM_ref2";
233 case DW_FORM_ref4: return "FORM_ref4";
234 case DW_FORM_ref8: return "FORM_ref8";
235 case DW_FORM_ref_udata: return "FORM_ref_udata";
236 case DW_FORM_indirect: return "FORM_indirect";
238 assert(0 && "Unknown Dwarf Form Encoding");
242 /// OperationEncodingString - Return the string for the specified operation
244 static const char *OperationEncodingString(unsigned Encoding) {
246 case DW_OP_addr: return "OP_addr";
247 case DW_OP_deref: return "OP_deref";
248 case DW_OP_const1u: return "OP_const1u";
249 case DW_OP_const1s: return "OP_const1s";
250 case DW_OP_const2u: return "OP_const2u";
251 case DW_OP_const2s: return "OP_const2s";
252 case DW_OP_const4u: return "OP_const4u";
253 case DW_OP_const4s: return "OP_const4s";
254 case DW_OP_const8u: return "OP_const8u";
255 case DW_OP_const8s: return "OP_const8s";
256 case DW_OP_constu: return "OP_constu";
257 case DW_OP_consts: return "OP_consts";
258 case DW_OP_dup: return "OP_dup";
259 case DW_OP_drop: return "OP_drop";
260 case DW_OP_over: return "OP_over";
261 case DW_OP_pick: return "OP_pick";
262 case DW_OP_swap: return "OP_swap";
263 case DW_OP_rot: return "OP_rot";
264 case DW_OP_xderef: return "OP_xderef";
265 case DW_OP_abs: return "OP_abs";
266 case DW_OP_and: return "OP_and";
267 case DW_OP_div: return "OP_div";
268 case DW_OP_minus: return "OP_minus";
269 case DW_OP_mod: return "OP_mod";
270 case DW_OP_mul: return "OP_mul";
271 case DW_OP_neg: return "OP_neg";
272 case DW_OP_not: return "OP_not";
273 case DW_OP_or: return "OP_or";
274 case DW_OP_plus: return "OP_plus";
275 case DW_OP_plus_uconst: return "OP_plus_uconst";
276 case DW_OP_shl: return "OP_shl";
277 case DW_OP_shr: return "OP_shr";
278 case DW_OP_shra: return "OP_shra";
279 case DW_OP_xor: return "OP_xor";
280 case DW_OP_skip: return "OP_skip";
281 case DW_OP_bra: return "OP_bra";
282 case DW_OP_eq: return "OP_eq";
283 case DW_OP_ge: return "OP_ge";
284 case DW_OP_gt: return "OP_gt";
285 case DW_OP_le: return "OP_le";
286 case DW_OP_lt: return "OP_lt";
287 case DW_OP_ne: return "OP_ne";
288 case DW_OP_lit0: return "OP_lit0";
289 case DW_OP_lit1: return "OP_lit1";
290 case DW_OP_lit31: return "OP_lit31";
291 case DW_OP_reg0: return "OP_reg0";
292 case DW_OP_reg1: return "OP_reg1";
293 case DW_OP_reg31: return "OP_reg31";
294 case DW_OP_breg0: return "OP_breg0";
295 case DW_OP_breg1: return "OP_breg1";
296 case DW_OP_breg31: return "OP_breg31";
297 case DW_OP_regx: return "OP_regx";
298 case DW_OP_fbreg: return "OP_fbreg";
299 case DW_OP_bregx: return "OP_bregx";
300 case DW_OP_piece: return "OP_piece";
301 case DW_OP_deref_size: return "OP_deref_size";
302 case DW_OP_xderef_size: return "OP_xderef_size";
303 case DW_OP_nop: return "OP_nop";
304 case DW_OP_push_object_address: return "OP_push_object_address";
305 case DW_OP_call2: return "OP_call2";
306 case DW_OP_call4: return "OP_call4";
307 case DW_OP_call_ref: return "OP_call_ref";
308 case DW_OP_form_tls_address: return "OP_form_tls_address";
309 case DW_OP_call_frame_cfa: return "OP_call_frame_cfa";
310 case DW_OP_lo_user: return "OP_lo_user";
311 case DW_OP_hi_user: return "OP_hi_user";
313 assert(0 && "Unknown Dwarf Operation Encoding");
317 /// AttributeEncodingString - Return the string for the specified attribute
319 static const char *AttributeEncodingString(unsigned Encoding) {
321 case DW_ATE_address: return "ATE_address";
322 case DW_ATE_boolean: return "ATE_boolean";
323 case DW_ATE_complex_float: return "ATE_complex_float";
324 case DW_ATE_float: return "ATE_float";
325 case DW_ATE_signed: return "ATE_signed";
326 case DW_ATE_signed_char: return "ATE_signed_char";
327 case DW_ATE_unsigned: return "ATE_unsigned";
328 case DW_ATE_unsigned_char: return "ATE_unsigned_char";
329 case DW_ATE_imaginary_float: return "ATE_imaginary_float";
330 case DW_ATE_packed_decimal: return "ATE_packed_decimal";
331 case DW_ATE_numeric_string: return "ATE_numeric_string";
332 case DW_ATE_edited: return "ATE_edited";
333 case DW_ATE_signed_fixed: return "ATE_signed_fixed";
334 case DW_ATE_unsigned_fixed: return "ATE_unsigned_fixed";
335 case DW_ATE_decimal_float: return "ATE_decimal_float";
336 case DW_ATE_lo_user: return "ATE_lo_user";
337 case DW_ATE_hi_user: return "ATE_hi_user";
339 assert(0 && "Unknown Dwarf Attribute Encoding");
343 /// DecimalSignString - Return the string for the specified decimal sign
345 static const char *DecimalSignString(unsigned Sign) {
347 case DW_DS_unsigned: return "DS_unsigned";
348 case DW_DS_leading_overpunch: return "DS_leading_overpunch";
349 case DW_DS_trailing_overpunch: return "DS_trailing_overpunch";
350 case DW_DS_leading_separate: return "DS_leading_separate";
351 case DW_DS_trailing_separate: return "DS_trailing_separate";
353 assert(0 && "Unknown Dwarf Decimal Sign Attribute");
357 /// EndianityString - Return the string for the specified endianity.
359 static const char *EndianityString(unsigned Endian) {
361 case DW_END_default: return "END_default";
362 case DW_END_big: return "END_big";
363 case DW_END_little: return "END_little";
364 case DW_END_lo_user: return "END_lo_user";
365 case DW_END_hi_user: return "END_hi_user";
367 assert(0 && "Unknown Dwarf Endianity");
371 /// AccessibilityString - Return the string for the specified accessibility.
373 static const char *AccessibilityString(unsigned Access) {
375 // Accessibility codes
376 case DW_ACCESS_public: return "ACCESS_public";
377 case DW_ACCESS_protected: return "ACCESS_protected";
378 case DW_ACCESS_private: return "ACCESS_private";
380 assert(0 && "Unknown Dwarf Accessibility");
384 /// VisibilityString - Return the string for the specified visibility.
386 static const char *VisibilityString(unsigned Visibility) {
388 case DW_VIS_local: return "VIS_local";
389 case DW_VIS_exported: return "VIS_exported";
390 case DW_VIS_qualified: return "VIS_qualified";
392 assert(0 && "Unknown Dwarf Visibility");
396 /// VirtualityString - Return the string for the specified virtuality.
398 static const char *VirtualityString(unsigned Virtuality) {
400 case DW_VIRTUALITY_none: return "VIRTUALITY_none";
401 case DW_VIRTUALITY_virtual: return "VIRTUALITY_virtual";
402 case DW_VIRTUALITY_pure_virtual: return "VIRTUALITY_pure_virtual";
404 assert(0 && "Unknown Dwarf Virtuality");
408 /// LanguageString - Return the string for the specified language.
410 static const char *LanguageString(unsigned Language) {
412 case DW_LANG_C89: return "LANG_C89";
413 case DW_LANG_C: return "LANG_C";
414 case DW_LANG_Ada83: return "LANG_Ada83";
415 case DW_LANG_C_plus_plus: return "LANG_C_plus_plus";
416 case DW_LANG_Cobol74: return "LANG_Cobol74";
417 case DW_LANG_Cobol85: return "LANG_Cobol85";
418 case DW_LANG_Fortran77: return "LANG_Fortran77";
419 case DW_LANG_Fortran90: return "LANG_Fortran90";
420 case DW_LANG_Pascal83: return "LANG_Pascal83";
421 case DW_LANG_Modula2: return "LANG_Modula2";
422 case DW_LANG_Java: return "LANG_Java";
423 case DW_LANG_C99: return "LANG_C99";
424 case DW_LANG_Ada95: return "LANG_Ada95";
425 case DW_LANG_Fortran95: return "LANG_Fortran95";
426 case DW_LANG_PLI: return "LANG_PLI";
427 case DW_LANG_ObjC: return "LANG_ObjC";
428 case DW_LANG_ObjC_plus_plus: return "LANG_ObjC_plus_plus";
429 case DW_LANG_UPC: return "LANG_UPC";
430 case DW_LANG_D: return "LANG_D";
431 case DW_LANG_lo_user: return "LANG_lo_user";
432 case DW_LANG_hi_user: return "LANG_hi_user";
434 assert(0 && "Unknown Dwarf Language");
438 /// CaseString - Return the string for the specified identifier case.
440 static const char *CaseString(unsigned Case) {
442 case DW_ID_case_sensitive: return "ID_case_sensitive";
443 case DW_ID_up_case: return "ID_up_case";
444 case DW_ID_down_case: return "ID_down_case";
445 case DW_ID_case_insensitive: return "ID_case_insensitive";
447 assert(0 && "Unknown Dwarf Identifier Case");
451 /// ConventionString - Return the string for the specified calling convention.
453 static const char *ConventionString(unsigned Convention) {
455 case DW_CC_normal: return "CC_normal";
456 case DW_CC_program: return "CC_program";
457 case DW_CC_nocall: return "CC_nocall";
458 case DW_CC_lo_user: return "CC_lo_user";
459 case DW_CC_hi_user: return "CC_hi_user";
461 assert(0 && "Unknown Dwarf Calling Convention");
465 /// InlineCodeString - Return the string for the specified inline code.
467 static const char *InlineCodeString(unsigned Code) {
469 case DW_INL_not_inlined: return "INL_not_inlined";
470 case DW_INL_inlined: return "INL_inlined";
471 case DW_INL_declared_not_inlined: return "INL_declared_not_inlined";
472 case DW_INL_declared_inlined: return "INL_declared_inlined";
474 assert(0 && "Unknown Dwarf Inline Code");
478 /// ArrayOrderString - Return the string for the specified array order.
480 static const char *ArrayOrderString(unsigned Order) {
482 case DW_ORD_row_major: return "ORD_row_major";
483 case DW_ORD_col_major: return "ORD_col_major";
485 assert(0 && "Unknown Dwarf Array Order");
489 /// DiscriminantString - Return the string for the specified discriminant
491 static const char *DiscriminantString(unsigned Discriminant) {
492 switch(Discriminant) {
493 case DW_DSC_label: return "DSC_label";
494 case DW_DSC_range: return "DSC_range";
496 assert(0 && "Unknown Dwarf Discriminant Descriptor");
500 /// LNStandardString - Return the string for the specified line number standard.
502 static const char *LNStandardString(unsigned Standard) {
504 case DW_LNS_copy: return "LNS_copy";
505 case DW_LNS_advance_pc: return "LNS_advance_pc";
506 case DW_LNS_advance_line: return "LNS_advance_line";
507 case DW_LNS_set_file: return "LNS_set_file";
508 case DW_LNS_set_column: return "LNS_set_column";
509 case DW_LNS_negate_stmt: return "LNS_negate_stmt";
510 case DW_LNS_set_basic_block: return "LNS_set_basic_block";
511 case DW_LNS_const_add_pc: return "LNS_const_add_pc";
512 case DW_LNS_fixed_advance_pc: return "LNS_fixed_advance_pc";
513 case DW_LNS_set_prologue_end: return "LNS_set_prologue_end";
514 case DW_LNS_set_epilogue_begin: return "LNS_set_epilogue_begin";
515 case DW_LNS_set_isa: return "LNS_set_isa";
517 assert(0 && "Unknown Dwarf Line Number Standard");
521 /// LNExtendedString - Return the string for the specified line number extended
522 /// opcode encodings.
523 static const char *LNExtendedString(unsigned Encoding) {
525 // Line Number Extended Opcode Encodings
526 case DW_LNE_end_sequence: return "LNE_end_sequence";
527 case DW_LNE_set_address: return "LNE_set_address";
528 case DW_LNE_define_file: return "LNE_define_file";
529 case DW_LNE_lo_user: return "LNE_lo_user";
530 case DW_LNE_hi_user: return "LNE_hi_user";
532 assert(0 && "Unknown Dwarf Line Number Extended Opcode Encoding");
536 /// MacinfoString - Return the string for the specified macinfo type encodings.
538 static const char *MacinfoString(unsigned Encoding) {
540 // Macinfo Type Encodings
541 case DW_MACINFO_define: return "MACINFO_define";
542 case DW_MACINFO_undef: return "MACINFO_undef";
543 case DW_MACINFO_start_file: return "MACINFO_start_file";
544 case DW_MACINFO_end_file: return "MACINFO_end_file";
545 case DW_MACINFO_vendor_ext: return "MACINFO_vendor_ext";
547 assert(0 && "Unknown Dwarf Macinfo Type Encodings");
551 /// CallFrameString - Return the string for the specified call frame instruction
553 static const char *CallFrameString(unsigned Encoding) {
555 case DW_CFA_advance_loc: return "CFA_advance_loc";
556 case DW_CFA_offset: return "CFA_offset";
557 case DW_CFA_restore: return "CFA_restore";
558 case DW_CFA_set_loc: return "CFA_set_loc";
559 case DW_CFA_advance_loc1: return "CFA_advance_loc1";
560 case DW_CFA_advance_loc2: return "CFA_advance_loc2";
561 case DW_CFA_advance_loc4: return "CFA_advance_loc4";
562 case DW_CFA_offset_extended: return "CFA_offset_extended";
563 case DW_CFA_restore_extended: return "CFA_restore_extended";
564 case DW_CFA_undefined: return "CFA_undefined";
565 case DW_CFA_same_value: return "CFA_same_value";
566 case DW_CFA_register: return "CFA_register";
567 case DW_CFA_remember_state: return "CFA_remember_state";
568 case DW_CFA_restore_state: return "CFA_restore_state";
569 case DW_CFA_def_cfa: return "CFA_def_cfa";
570 case DW_CFA_def_cfa_register: return "CFA_def_cfa_register";
571 case DW_CFA_def_cfa_offset: return "CFA_def_cfa_offset";
572 case DW_CFA_def_cfa_expression: return "CFA_def_cfa_expression";
573 case DW_CFA_expression: return "CFA_expression";
574 case DW_CFA_offset_extended_sf: return "CFA_offset_extended_sf";
575 case DW_CFA_def_cfa_sf: return "CFA_def_cfa_sf";
576 case DW_CFA_def_cfa_offset_sf: return "CFA_def_cfa_offset_sf";
577 case DW_CFA_val_offset: return "CFA_val_offset";
578 case DW_CFA_val_offset_sf: return "CFA_val_offset_sf";
579 case DW_CFA_val_expression: return "CFA_val_expression";
580 case DW_CFA_lo_user: return "CFA_lo_user";
581 case DW_CFA_hi_user: return "CFA_hi_user";
583 assert(0 && "Unknown Dwarf Call Frame Instruction Encodings");
587 //===----------------------------------------------------------------------===//
589 /// operator== - Used by UniqueVector to locate entry.
591 bool DIEAbbrev::operator==(const DIEAbbrev &DA) const {
592 if (Tag != DA.Tag) return false;
593 if (ChildrenFlag != DA.ChildrenFlag) return false;
594 if (Data.size() != DA.Data.size()) return false;
596 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
597 if (Data[i] != DA.Data[i]) return false;
603 /// operator< - Used by UniqueVector to locate entry.
605 bool DIEAbbrev::operator<(const DIEAbbrev &DA) const {
606 if (Tag != DA.Tag) return Tag < DA.Tag;
607 if (ChildrenFlag != DA.ChildrenFlag) return ChildrenFlag < DA.ChildrenFlag;
608 if (Data.size() != DA.Data.size()) return Data.size() < DA.Data.size();
610 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
611 if (Data[i] != DA.Data[i]) return Data[i] < DA.Data[i];
617 /// Emit - Print the abbreviation using the specified Dwarf writer.
619 void DIEAbbrev::Emit(const DwarfWriter &DW) const {
620 // Emit its Dwarf tag type.
621 DW.EmitULEB128Bytes(Tag);
622 DW.EOL(TagString(Tag));
624 // Emit whether it has children DIEs.
625 DW.EmitULEB128Bytes(ChildrenFlag);
626 DW.EOL(ChildrenString(ChildrenFlag));
628 // For each attribute description.
629 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
630 const DIEAbbrevData &AttrData = Data[i];
632 // Emit attribute type.
633 DW.EmitULEB128Bytes(AttrData.getAttribute());
634 DW.EOL(AttributeString(AttrData.getAttribute()));
637 DW.EmitULEB128Bytes(AttrData.getForm());
638 DW.EOL(FormEncodingString(AttrData.getForm()));
641 // Mark end of abbreviation.
642 DW.EmitULEB128Bytes(0); DW.EOL("EOM(1)");
643 DW.EmitULEB128Bytes(0); DW.EOL("EOM(2)");
647 void DIEAbbrev::print(std::ostream &O) {
648 O << "Abbreviation @"
649 << std::hex << (intptr_t)this << std::dec
653 << ChildrenString(ChildrenFlag)
656 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
658 << AttributeString(Data[i].getAttribute())
660 << FormEncodingString(Data[i].getForm())
664 void DIEAbbrev::dump() { print(std::cerr); }
667 //===----------------------------------------------------------------------===//
669 /// EmitValue - Emit integer of appropriate size.
671 void DIEInteger::EmitValue(const DwarfWriter &DW, unsigned Form) const {
673 case DW_FORM_flag: // Fall thru
674 case DW_FORM_data1: DW.EmitInt8(Integer); break;
675 case DW_FORM_data2: DW.EmitInt16(Integer); break;
676 case DW_FORM_data4: DW.EmitInt32(Integer); break;
677 case DW_FORM_data8: DW.EmitInt64(Integer); break;
678 case DW_FORM_udata: DW.EmitULEB128Bytes(Integer); break;
679 case DW_FORM_sdata: DW.EmitSLEB128Bytes(Integer); break;
680 default: assert(0 && "DIE Value form not supported yet"); break;
684 /// SizeOf - Determine size of integer value in bytes.
686 unsigned DIEInteger::SizeOf(const DwarfWriter &DW, unsigned Form) const {
688 case DW_FORM_flag: // Fall thru
689 case DW_FORM_data1: return sizeof(int8_t);
690 case DW_FORM_data2: return sizeof(int16_t);
691 case DW_FORM_data4: return sizeof(int32_t);
692 case DW_FORM_data8: return sizeof(int64_t);
693 case DW_FORM_udata: return DW.SizeULEB128(Integer);
694 case DW_FORM_sdata: return DW.SizeSLEB128(Integer);
695 default: assert(0 && "DIE Value form not supported yet"); break;
700 //===----------------------------------------------------------------------===//
702 /// EmitValue - Emit string value.
704 void DIEString::EmitValue(const DwarfWriter &DW, unsigned Form) const {
705 DW.EmitString(String);
708 /// SizeOf - Determine size of string value in bytes.
710 unsigned DIEString::SizeOf(const DwarfWriter &DW, unsigned Form) const {
711 return String.size() + sizeof(char); // sizeof('\0');
714 //===----------------------------------------------------------------------===//
716 /// EmitValue - Emit label value.
718 void DIEDwarfLabel::EmitValue(const DwarfWriter &DW, unsigned Form) const {
719 DW.EmitReference(Label);
722 /// SizeOf - Determine size of label value in bytes.
724 unsigned DIEDwarfLabel::SizeOf(const DwarfWriter &DW, unsigned Form) const {
725 return DW.getAddressSize();
728 //===----------------------------------------------------------------------===//
730 /// EmitValue - Emit label value.
732 void DIEObjectLabel::EmitValue(const DwarfWriter &DW, unsigned Form) const {
733 DW.EmitInt8(sizeof(int8_t) + DW.getAddressSize());
734 DW.EOL("DW_FORM_block1 length");
736 DW.EmitInt8(DW_OP_addr);
737 DW.EOL("DW_OP_addr");
739 DW.EmitReference(Label);
742 /// SizeOf - Determine size of label value in bytes.
744 unsigned DIEObjectLabel::SizeOf(const DwarfWriter &DW, unsigned Form) const {
745 return sizeof(int8_t) + sizeof(int8_t) + DW.getAddressSize();
748 //===----------------------------------------------------------------------===//
750 /// EmitValue - Emit delta value.
752 void DIEDelta::EmitValue(const DwarfWriter &DW, unsigned Form) const {
753 DW.EmitDifference(LabelHi, LabelLo);
756 /// SizeOf - Determine size of delta value in bytes.
758 unsigned DIEDelta::SizeOf(const DwarfWriter &DW, unsigned Form) const {
759 return DW.getAddressSize();
762 //===----------------------------------------------------------------------===//
763 /// EmitValue - Emit extry offset.
765 void DIEntry::EmitValue(const DwarfWriter &DW, unsigned Form) const {
766 DW.EmitInt32(Entry->getOffset());
769 /// SizeOf - Determine size of label value in bytes.
771 unsigned DIEntry::SizeOf(const DwarfWriter &DW, unsigned Form) const {
772 return sizeof(int32_t);
775 //===----------------------------------------------------------------------===//
777 DIE::DIE(unsigned Tag)
778 : Abbrev(new DIEAbbrev(Tag, DW_CHILDREN_no))
787 if (Abbrev) delete Abbrev;
789 for (unsigned i = 0, N = Children.size(); i < N; ++i) {
793 for (unsigned j = 0, M = Values.size(); j < M; ++j) {
798 /// AddUInt - Add an unsigned integer attribute data and value.
800 void DIE::AddUInt(unsigned Attribute, unsigned Form, uint64_t Integer) {
802 if ((unsigned char)Integer == Integer) Form = DW_FORM_data1;
803 else if ((unsigned short)Integer == Integer) Form = DW_FORM_data2;
804 else if ((unsigned int)Integer == Integer) Form = DW_FORM_data4;
805 else Form = DW_FORM_data8;
807 Abbrev->AddAttribute(Attribute, Form);
808 Values.push_back(new DIEInteger(Integer));
811 /// AddSInt - Add an signed integer attribute data and value.
813 void DIE::AddSInt(unsigned Attribute, unsigned Form, int64_t Integer) {
815 if ((char)Integer == Integer) Form = DW_FORM_data1;
816 else if ((short)Integer == Integer) Form = DW_FORM_data2;
817 else if ((int)Integer == Integer) Form = DW_FORM_data4;
818 else Form = DW_FORM_data8;
820 Abbrev->AddAttribute(Attribute, Form);
821 Values.push_back(new DIEInteger(Integer));
824 /// AddString - Add a std::string attribute data and value.
826 void DIE::AddString(unsigned Attribute, unsigned Form,
827 const std::string &String) {
828 Abbrev->AddAttribute(Attribute, Form);
829 Values.push_back(new DIEString(String));
832 /// AddLabel - Add a Dwarf label attribute data and value.
834 void DIE::AddLabel(unsigned Attribute, unsigned Form,
835 const DWLabel &Label) {
836 Abbrev->AddAttribute(Attribute, Form);
837 Values.push_back(new DIEDwarfLabel(Label));
840 /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
842 void DIE::AddObjectLabel(unsigned Attribute, unsigned Form,
843 const std::string &Label) {
844 Abbrev->AddAttribute(Attribute, Form);
845 Values.push_back(new DIEObjectLabel(Label));
848 /// AddDelta - Add a label delta attribute data and value.
850 void DIE::AddDelta(unsigned Attribute, unsigned Form,
851 const DWLabel &Hi, const DWLabel &Lo) {
852 Abbrev->AddAttribute(Attribute, Form);
853 Values.push_back(new DIEDelta(Hi, Lo));
856 /// AddDIEntry - Add a DIE attribute data and value.
858 void DIE::AddDIEntry(unsigned Attribute,
859 unsigned Form, DIE *Entry) {
860 Abbrev->AddAttribute(Attribute, Form);
861 Values.push_back(new DIEntry(Entry));
864 /// Complete - Indicate that all attributes have been added and ready to get an
866 void DIE::Complete(DwarfWriter &DW) {
867 AbbrevID = DW.NewAbbreviation(Abbrev);
872 /// AddChild - Add a child to the DIE.
874 void DIE::AddChild(DIE *Child) {
875 assert(Abbrev && "Adding children without an abbreviation");
876 Abbrev->setChildrenFlag(DW_CHILDREN_yes);
877 Children.push_back(Child);
880 //===----------------------------------------------------------------------===//
884 //===----------------------------------------------------------------------===//
886 /// PrintHex - Print a value as a hexidecimal value.
888 void DwarfWriter::PrintHex(int Value) const {
889 O << "0x" << std::hex << Value << std::dec;
892 /// EOL - Print a newline character to asm stream. If a comment is present
893 /// then it will be printed first. Comments should not contain '\n'.
894 void DwarfWriter::EOL(const std::string &Comment) const {
897 << Asm->CommentString
904 /// EmitULEB128Bytes - Emit an assembler byte data directive to compose an
905 /// unsigned leb128 value.
906 void DwarfWriter::EmitULEB128Bytes(unsigned Value) const {
911 O << Asm->Data8bitsDirective;
916 /// EmitSLEB128Bytes - Emit an assembler byte data directive to compose a
917 /// signed leb128 value.
918 void DwarfWriter::EmitSLEB128Bytes(int Value) const {
923 O << Asm->Data8bitsDirective;
928 /// PrintULEB128 - Print a series of hexidecimal values (separated by commas)
929 /// representing an unsigned leb128 value.
930 void DwarfWriter::PrintULEB128(unsigned Value) const {
932 unsigned Byte = Value & 0x7f;
934 if (Value) Byte |= 0x80;
936 if (Value) O << ", ";
940 /// SizeULEB128 - Compute the number of bytes required for an unsigned leb128
942 unsigned DwarfWriter::SizeULEB128(unsigned Value) {
946 Size += sizeof(int8_t);
951 /// PrintSLEB128 - Print a series of hexidecimal values (separated by commas)
952 /// representing a signed leb128 value.
953 void DwarfWriter::PrintSLEB128(int Value) const {
954 int Sign = Value >> (8 * sizeof(Value) - 1);
958 unsigned Byte = Value & 0x7f;
960 IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
961 if (IsMore) Byte |= 0x80;
963 if (IsMore) O << ", ";
967 /// SizeSLEB128 - Compute the number of bytes required for a signed leb128
969 unsigned DwarfWriter::SizeSLEB128(int Value) {
971 int Sign = Value >> (8 * sizeof(Value) - 1);
975 unsigned Byte = Value & 0x7f;
977 IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
978 Size += sizeof(int8_t);
983 /// EmitInt8 - Emit a byte directive and value.
985 void DwarfWriter::EmitInt8(int Value) const {
986 O << Asm->Data8bitsDirective;
987 PrintHex(Value & 0xFF);
990 /// EmitInt16 - Emit a short directive and value.
992 void DwarfWriter::EmitInt16(int Value) const {
993 O << Asm->Data16bitsDirective;
994 PrintHex(Value & 0xFFFF);
997 /// EmitInt32 - Emit a long directive and value.
999 void DwarfWriter::EmitInt32(int Value) const {
1000 O << Asm->Data32bitsDirective;
1004 /// EmitInt64 - Emit a long long directive and value.
1006 void DwarfWriter::EmitInt64(uint64_t Value) const {
1007 if (Asm->Data64bitsDirective) {
1008 O << Asm->Data64bitsDirective << "0x" << std::hex << Value << std::dec;
1010 const TargetData &TD = Asm->TM.getTargetData();
1012 if (TD.isBigEndian()) {
1013 EmitInt32(unsigned(Value >> 32)); O << "\n";
1014 EmitInt32(unsigned(Value));
1016 EmitInt32(unsigned(Value)); O << "\n";
1017 EmitInt32(unsigned(Value >> 32));
1022 /// EmitString - Emit a string with quotes and a null terminator.
1023 /// Special characters are emitted properly. (Eg. '\t')
1024 void DwarfWriter::EmitString(const std::string &String) const {
1025 O << Asm->AsciiDirective
1027 for (unsigned i = 0, N = String.size(); i < N; ++i) {
1028 unsigned char C = String[i];
1030 if (!isascii(C) || iscntrl(C)) {
1032 case '\b': O << "\\b"; break;
1033 case '\f': O << "\\f"; break;
1034 case '\n': O << "\\n"; break;
1035 case '\r': O << "\\r"; break;
1036 case '\t': O << "\\t"; break;
1039 O << char('0' + (C >> 6));
1040 O << char('0' + (C >> 3));
1041 O << char('0' + (C >> 0));
1044 } else if (C == '\"') {
1046 } else if (C == '\'') {
1055 /// PrintLabelName - Print label name in form used by Dwarf writer.
1057 void DwarfWriter::PrintLabelName(const char *Tag, unsigned Number) const {
1058 O << Asm->PrivateGlobalPrefix
1061 if (Number) O << Number;
1064 /// EmitLabel - Emit location label for internal use by Dwarf.
1066 void DwarfWriter::EmitLabel(const char *Tag, unsigned Number) const {
1067 PrintLabelName(Tag, Number);
1071 /// EmitReference - Emit a reference to a label.
1073 void DwarfWriter::EmitReference(const char *Tag, unsigned Number) const {
1074 if (AddressSize == 4)
1075 O << Asm->Data32bitsDirective;
1077 O << Asm->Data64bitsDirective;
1079 PrintLabelName(Tag, Number);
1081 void DwarfWriter::EmitReference(const std::string &Name) const {
1082 if (AddressSize == 4)
1083 O << Asm->Data32bitsDirective;
1085 O << Asm->Data64bitsDirective;
1090 /// EmitDifference - Emit an label difference as sizeof(pointer) value. Some
1091 /// assemblers do not accept absolute expressions with data directives, so there
1092 /// is an option (needsSet) to use an intermediary 'set' expression.
1093 void DwarfWriter::EmitDifference(const char *TagHi, unsigned NumberHi,
1094 const char *TagLo, unsigned NumberLo) const {
1096 static unsigned SetCounter = 0;
1099 PrintLabelName("set", SetCounter);
1101 PrintLabelName(TagHi, NumberHi);
1103 PrintLabelName(TagLo, NumberLo);
1106 if (AddressSize == sizeof(int32_t))
1107 O << Asm->Data32bitsDirective;
1109 O << Asm->Data64bitsDirective;
1111 PrintLabelName("set", SetCounter);
1115 if (AddressSize == sizeof(int32_t))
1116 O << Asm->Data32bitsDirective;
1118 O << Asm->Data64bitsDirective;
1120 PrintLabelName(TagHi, NumberHi);
1122 PrintLabelName(TagLo, NumberLo);
1126 /// NewAbbreviation - Add the abbreviation to the Abbreviation vector.
1128 unsigned DwarfWriter::NewAbbreviation(DIEAbbrev *Abbrev) {
1129 return Abbreviations.insert(*Abbrev);
1132 /// NewString - Add a string to the constant pool and returns a label.
1134 DWLabel DwarfWriter::NewString(const std::string &String) {
1135 unsigned StringID = StringPool.insert(String);
1136 return DWLabel("string", StringID);
1139 /// NewBasicType - Creates a new basic type if necessary, then adds to the
1141 /// FIXME - Should never be needed.
1142 DIE *DwarfWriter::NewBasicType(DIE *Owner, Type *Ty) {
1143 DIE *&Slot = TypeToDieMap[Ty];
1144 if (Slot) return Slot;
1148 unsigned Encoding = 0;
1150 switch (Ty->getTypeID()) {
1151 case Type::UByteTyID:
1152 Name = "unsigned char";
1154 Encoding = DW_ATE_unsigned_char;
1156 case Type::SByteTyID:
1159 Encoding = DW_ATE_signed_char;
1161 case Type::UShortTyID:
1162 Name = "unsigned short";
1164 Encoding = DW_ATE_unsigned;
1166 case Type::ShortTyID:
1169 Encoding = DW_ATE_signed;
1171 case Type::UIntTyID:
1172 Name = "unsigned int";
1174 Encoding = DW_ATE_unsigned;
1179 Encoding = DW_ATE_signed;
1181 case Type::ULongTyID:
1182 Name = "unsigned long long";
1184 Encoding = DW_ATE_unsigned;
1186 case Type::LongTyID:
1189 Encoding = DW_ATE_signed;
1191 case Type::FloatTyID:
1194 Encoding = DW_ATE_float;
1196 case Type::DoubleTyID:
1199 Encoding = DW_ATE_float;
1202 // FIXME - handle more complex types.
1205 Encoding = DW_ATE_address;
1209 // construct the type DIE.
1210 Slot = new DIE(DW_TAG_base_type);
1211 Slot->AddString(DW_AT_name, DW_FORM_string, Name);
1212 Slot->AddUInt (DW_AT_byte_size, 0, Size);
1213 Slot->AddUInt (DW_AT_encoding, DW_FORM_data1, Encoding);
1215 // Add to context owner.
1216 Owner->AddChild(Slot);
1221 /// NewGlobalType - Make the type visible globally using the given name.
1223 void DwarfWriter::NewGlobalType(const std::string &Name, DIE *Type) {
1224 assert(!GlobalTypes[Name] && "Duplicate global type");
1225 GlobalTypes[Name] = Type;
1228 /// NewGlobalEntity - Make the entity visible globally using the given name.
1230 void DwarfWriter::NewGlobalEntity(const std::string &Name, DIE *Entity) {
1231 assert(!GlobalEntities[Name] && "Duplicate global variable or function");
1232 GlobalEntities[Name] = Entity;
1235 /// NewCompileUnit - Create new compile unit information.
1237 DIE *DwarfWriter::NewCompileUnit(CompileUnitDesc *CompileUnit) {
1238 // Check for pre-existence.
1239 DIE *&Slot = DescToDieMap[CompileUnit];
1240 if (Slot) return Slot;
1242 DIE *Unit = new DIE(DW_TAG_compile_unit);
1243 // FIXME - use the correct line set.
1244 Unit->AddLabel (DW_AT_stmt_list, DW_FORM_data4, DWLabel("section_line", 0));
1245 Unit->AddLabel (DW_AT_high_pc, DW_FORM_addr, DWLabel("text_end", 0));
1246 Unit->AddLabel (DW_AT_low_pc, DW_FORM_addr, DWLabel("text_begin", 0));
1247 Unit->AddString(DW_AT_producer, DW_FORM_string, CompileUnit->getProducer());
1248 Unit->AddUInt (DW_AT_language, DW_FORM_data1, CompileUnit->getLanguage());
1249 Unit->AddString(DW_AT_name, DW_FORM_string, CompileUnit->getFileName());
1250 Unit->AddString(DW_AT_comp_dir, DW_FORM_string, CompileUnit->getDirectory());
1257 /// NewGlobalVariable - Add a new global variable DIE.
1259 DIE *DwarfWriter::NewGlobalVariable(GlobalVariableDesc *GVD) {
1260 // Check for pre-existence.
1261 DIE *&Slot = DescToDieMap[GVD];
1262 if (Slot) return Slot;
1264 // Get the compile unit context.
1265 CompileUnitDesc *CompileUnit =
1266 static_cast<CompileUnitDesc *>(GVD->getContext());
1267 DIE *Unit = NewCompileUnit(CompileUnit);
1268 // Get the global variable itself.
1269 GlobalVariable *GV = GVD->getGlobalVariable();
1270 // Generate the mangled name.
1271 std::string MangledName = Asm->Mang->getValueName(GV);
1273 // Gather the details (simplify add attribute code.)
1274 const std::string &Name = GVD->getName();
1275 unsigned FileID = DebugInfo->RecordSource(CompileUnit);
1276 unsigned Line = GVD->getLine();
1278 // FIXME - faking the type for the time being.
1279 DIE *Type = NewBasicType(Unit, Type::IntTy);
1281 DIE *VariableDie = new DIE(DW_TAG_variable);
1282 VariableDie->AddString (DW_AT_name, DW_FORM_string, Name);
1283 VariableDie->AddUInt (DW_AT_decl_file, 0, FileID);
1284 VariableDie->AddUInt (DW_AT_decl_line, 0, Line);
1285 VariableDie->AddDIEntry (DW_AT_type, DW_FORM_ref4, Type);
1286 VariableDie->AddUInt (DW_AT_external, DW_FORM_flag, 1);
1287 // FIXME - needs to be a proper expression.
1288 VariableDie->AddObjectLabel(DW_AT_location, DW_FORM_block1, MangledName);
1293 // Add to context owner.
1294 Unit->AddChild(VariableDie);
1296 // Expose as global.
1297 NewGlobalEntity(Name, VariableDie);
1302 /// NewSubprogram - Add a new subprogram DIE.
1304 DIE *DwarfWriter::NewSubprogram(SubprogramDesc *SPD) {
1305 // Check for pre-existence.
1306 DIE *&Slot = DescToDieMap[SPD];
1307 if (Slot) return Slot;
1309 // Get the compile unit context.
1310 CompileUnitDesc *CompileUnit =
1311 static_cast<CompileUnitDesc *>(SPD->getContext());
1312 DIE *Unit = NewCompileUnit(CompileUnit);
1314 // Gather the details (simplify add attribute code.)
1315 const std::string &Name = SPD->getName();
1316 unsigned FileID = DebugInfo->RecordSource(CompileUnit);
1317 // FIXME - faking the line for the time being.
1320 // FIXME - faking the type for the time being.
1321 DIE *Type = NewBasicType(Unit, Type::IntTy);
1323 DIE *SubprogramDie = new DIE(DW_TAG_variable);
1324 SubprogramDie->AddString (DW_AT_name, DW_FORM_string, Name);
1325 SubprogramDie->AddUInt (DW_AT_decl_file, 0, FileID);
1326 SubprogramDie->AddUInt (DW_AT_decl_line, 0, Line);
1327 SubprogramDie->AddDIEntry (DW_AT_type, DW_FORM_ref4, Type);
1328 SubprogramDie->AddUInt (DW_AT_external, DW_FORM_flag, 1);
1331 Slot = SubprogramDie;
1333 // Add to context owner.
1334 Unit->AddChild(SubprogramDie);
1336 // Expose as global.
1337 NewGlobalEntity(Name, SubprogramDie);
1339 return SubprogramDie;
1342 /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
1343 /// tools to recognize the object file contains Dwarf information.
1345 void DwarfWriter::EmitInitial() const {
1346 // Dwarf sections base addresses.
1347 Asm->SwitchSection(DwarfFrameSection, 0);
1348 EmitLabel("section_frame", 0);
1349 Asm->SwitchSection(DwarfInfoSection, 0);
1350 EmitLabel("section_info", 0);
1351 EmitLabel("info", 0);
1352 Asm->SwitchSection(DwarfAbbrevSection, 0);
1353 EmitLabel("section_abbrev", 0);
1354 EmitLabel("abbrev", 0);
1355 Asm->SwitchSection(DwarfARangesSection, 0);
1356 EmitLabel("section_aranges", 0);
1357 Asm->SwitchSection(DwarfMacInfoSection, 0);
1358 EmitLabel("section_macinfo", 0);
1359 Asm->SwitchSection(DwarfLineSection, 0);
1360 EmitLabel("section_line", 0);
1361 EmitLabel("line", 0);
1362 Asm->SwitchSection(DwarfLocSection, 0);
1363 EmitLabel("section_loc", 0);
1364 Asm->SwitchSection(DwarfPubNamesSection, 0);
1365 EmitLabel("section_pubnames", 0);
1366 Asm->SwitchSection(DwarfStrSection, 0);
1367 EmitLabel("section_str", 0);
1368 Asm->SwitchSection(DwarfRangesSection, 0);
1369 EmitLabel("section_ranges", 0);
1371 Asm->SwitchSection(TextSection, 0);
1372 EmitLabel("text_begin", 0);
1373 Asm->SwitchSection(DataSection, 0);
1374 EmitLabel("data_begin", 0);
1377 /// EmitDIE - Recusively Emits a debug information entry.
1379 void DwarfWriter::EmitDIE(DIE *Die) const {
1380 // Get the abbreviation for this DIE.
1381 unsigned AbbrevID = Die->getAbbrevID();
1382 const DIEAbbrev &Abbrev = Abbreviations[AbbrevID];
1384 // Emit the code (index) for the abbreviation.
1385 EmitULEB128Bytes(AbbrevID);
1386 EOL(std::string("Abbrev [" +
1389 TagString(Abbrev.getTag())) +
1392 const std::vector<DIEValue *> &Values = Die->getValues();
1393 const std::vector<DIEAbbrevData> &AbbrevData = Abbrev.getData();
1395 // Emit the DIE attribute values.
1396 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1397 unsigned Attr = AbbrevData[i].getAttribute();
1398 unsigned Form = AbbrevData[i].getForm();
1399 assert(Form && "Too many attributes for DIE (check abbreviation)");
1402 case DW_AT_sibling: {
1403 EmitInt32(Die->SiblingOffset());
1407 // Emit an attribute using the defined form.
1408 Values[i]->EmitValue(*this, Form);
1413 EOL(AttributeString(Attr));
1416 // Emit the DIE children if any.
1417 if (Abbrev.getChildrenFlag() == DW_CHILDREN_yes) {
1418 const std::vector<DIE *> &Children = Die->getChildren();
1420 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
1421 // FIXME - handle sibling offsets.
1422 // FIXME - handle all DIE types.
1423 EmitDIE(Children[j]);
1426 EmitInt8(0); EOL("End Of Children Mark");
1430 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
1432 unsigned DwarfWriter::SizeAndOffsetDie(DIE *Die, unsigned Offset) {
1433 // Record the abbreviation.
1434 Die->Complete(*this);
1436 // Get the abbreviation for this DIE.
1437 unsigned AbbrevID = Die->getAbbrevID();
1438 const DIEAbbrev &Abbrev = Abbreviations[AbbrevID];
1441 Die->setOffset(Offset);
1443 // Start the size with the size of abbreviation code.
1444 Offset += SizeULEB128(AbbrevID);
1446 const std::vector<DIEValue *> &Values = Die->getValues();
1447 const std::vector<DIEAbbrevData> &AbbrevData = Abbrev.getData();
1449 // Emit the DIE attribute values.
1450 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1451 // Size attribute value.
1452 Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
1455 // Emit the DIE children if any.
1456 if (Abbrev.getChildrenFlag() == DW_CHILDREN_yes) {
1457 const std::vector<DIE *> &Children = Die->getChildren();
1459 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
1460 // FIXME - handle sibling offsets.
1461 // FIXME - handle all DIE types.
1462 Offset = SizeAndOffsetDie(Children[j], Offset);
1465 // End of children marker.
1466 Offset += sizeof(int8_t);
1469 Die->setSize(Offset - Die->getOffset());
1473 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
1475 void DwarfWriter::SizeAndOffsets() {
1476 // Compute size of debug unit header
1477 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
1478 sizeof(int16_t) + // DWARF version number
1479 sizeof(int32_t) + // Offset Into Abbrev. Section
1480 sizeof(int8_t); // Pointer Size (in bytes)
1482 // Process each compile unit.
1483 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) {
1484 Offset = SizeAndOffsetDie(CompileUnits[i], Offset);
1488 /// EmitDebugInfo - Emit the debug info section.
1490 void DwarfWriter::EmitDebugInfo() const {
1491 // Start debug info section.
1492 Asm->SwitchSection(DwarfInfoSection, 0);
1494 // Get the number of compile units.
1495 unsigned N = CompileUnits.size();
1497 // If there are any compile units.
1499 EmitLabel("info_begin", 0);
1501 // Emit the compile units header.
1503 // Emit size of content not including length itself
1504 unsigned ContentSize = CompileUnits[N - 1]->SiblingOffset();
1505 EmitInt32(ContentSize - sizeof(int32_t));
1506 EOL("Length of Compilation Unit Info");
1508 EmitInt16(DWARF_VERSION); EOL("DWARF version number");
1510 EmitReference("abbrev_begin", 0); EOL("Offset Into Abbrev. Section");
1512 EmitInt8(AddressSize); EOL("Address Size (in bytes)");
1514 // Process each compile unit.
1515 for (unsigned i = 0; i < N; ++i) {
1516 EmitDIE(CompileUnits[i]);
1519 EmitLabel("info_end", 0);
1523 /// EmitAbbreviations - Emit the abbreviation section.
1525 void DwarfWriter::EmitAbbreviations() const {
1526 // Check to see if it is worth the effort.
1527 if (!Abbreviations.empty()) {
1528 // Start the debug abbrev section.
1529 Asm->SwitchSection(DwarfAbbrevSection, 0);
1531 EmitLabel("abbrev_begin", 0);
1533 // For each abbrevation.
1534 for (unsigned AbbrevID = 1, NAID = Abbreviations.size();
1535 AbbrevID <= NAID; ++AbbrevID) {
1536 // Get abbreviation data
1537 const DIEAbbrev &Abbrev = Abbreviations[AbbrevID];
1539 // Emit the abbrevations code (base 1 index.)
1540 EmitULEB128Bytes(AbbrevID); EOL("Abbreviation Code");
1542 // Emit the abbreviations data.
1546 EmitLabel("abbrev_end", 0);
1550 /// EmitDebugLines - Emit source line information.
1552 void DwarfWriter::EmitDebugLines() const {
1553 // Minimum line delta, thus ranging from -10..(255-10).
1554 const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
1555 // Maximum line delta, thus ranging from -10..(255-10).
1556 const int MaxLineDelta = 255 + MinLineDelta;
1558 // Start the dwarf line section.
1559 Asm->SwitchSection(DwarfLineSection, 0);
1561 // Construct the section header.
1563 EmitDifference("line_end", 0, "line_begin", 0);
1564 EOL("Length of Source Line Info");
1565 EmitLabel("line_begin", 0);
1567 EmitInt16(DWARF_VERSION); EOL("DWARF version number");
1569 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0);
1570 EOL("Prolog Length");
1571 EmitLabel("line_prolog_begin", 0);
1573 EmitInt8(1); EOL("Minimum Instruction Length");
1575 EmitInt8(1); EOL("Default is_stmt_start flag");
1577 EmitInt8(MinLineDelta); EOL("Line Base Value (Special Opcodes)");
1579 EmitInt8(MaxLineDelta); EOL("Line Range Value (Special Opcodes)");
1581 EmitInt8(-MinLineDelta); EOL("Special Opcode Base");
1583 // Line number standard opcode encodings argument count
1584 EmitInt8(0); EOL("DW_LNS_copy arg count");
1585 EmitInt8(1); EOL("DW_LNS_advance_pc arg count");
1586 EmitInt8(1); EOL("DW_LNS_advance_line arg count");
1587 EmitInt8(1); EOL("DW_LNS_set_file arg count");
1588 EmitInt8(1); EOL("DW_LNS_set_column arg count");
1589 EmitInt8(0); EOL("DW_LNS_negate_stmt arg count");
1590 EmitInt8(0); EOL("DW_LNS_set_basic_block arg count");
1591 EmitInt8(0); EOL("DW_LNS_const_add_pc arg count");
1592 EmitInt8(1); EOL("DW_LNS_fixed_advance_pc arg count");
1594 const UniqueVector<std::string> &Directories = DebugInfo->getDirectories();
1595 const UniqueVector<SourceFileInfo> &SourceFiles = DebugInfo->getSourceFiles();
1597 // Emit directories.
1598 for (unsigned DirectoryID = 1, NDID = Directories.size();
1599 DirectoryID <= NDID; ++DirectoryID) {
1600 EmitString(Directories[DirectoryID]); EOL("Directory");
1602 EmitInt8(0); EOL("End of directories");
1605 for (unsigned SourceID = 1, NSID = SourceFiles.size();
1606 SourceID <= NSID; ++SourceID) {
1607 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
1608 EmitString(SourceFile.getName()); EOL("Source");
1609 EmitULEB128Bytes(SourceFile.getDirectoryID()); EOL("Directory #");
1610 EmitULEB128Bytes(0); EOL("Mod date");
1611 EmitULEB128Bytes(0); EOL("File size");
1613 EmitInt8(0); EOL("End of files");
1615 EmitLabel("line_prolog_end", 0);
1617 // Emit line information
1618 const std::vector<SourceLineInfo *> &LineInfos = DebugInfo->getSourceLines();
1620 // Dwarf assumes we start with first line of first source file.
1621 unsigned Source = 1;
1624 // Construct rows of the address, source, line, column matrix.
1625 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
1626 SourceLineInfo *LineInfo = LineInfos[i];
1629 unsigned SourceID = LineInfo->getSourceID();
1630 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
1631 unsigned DirectoryID = SourceFile.getDirectoryID();
1633 << Asm->CommentString << " "
1634 << Directories[DirectoryID]
1635 << SourceFile.getName() << ":"
1636 << LineInfo->getLine() << "\n";
1639 // Define the line address.
1640 EmitInt8(0); EOL("Extended Op");
1641 EmitInt8(4 + 1); EOL("Op size");
1642 EmitInt8(DW_LNE_set_address); EOL("DW_LNE_set_address");
1643 EmitReference("loc", i + 1); EOL("Location label");
1645 // If change of source, then switch to the new source.
1646 if (Source != LineInfo->getSourceID()) {
1647 Source = LineInfo->getSourceID();
1648 EmitInt8(DW_LNS_set_file); EOL("DW_LNS_set_file");
1649 EmitULEB128Bytes(0); EOL("New Source");
1652 // If change of line.
1653 if (Line != LineInfo->getLine()) {
1654 // Determine offset.
1655 int Offset = LineInfo->getLine() - Line;
1656 int Delta = Offset - MinLineDelta;
1659 Line = LineInfo->getLine();
1661 // If delta is small enough and in range...
1662 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
1663 // ... then use fast opcode.
1664 EmitInt8(Delta - MinLineDelta); EOL("Line Delta");
1666 // ... otherwise use long hand.
1667 EmitInt8(DW_LNS_advance_line); EOL("DW_LNS_advance_line");
1668 EmitSLEB128Bytes(Offset); EOL("Line Offset");
1669 EmitInt8(DW_LNS_copy); EOL("DW_LNS_copy");
1672 // Copy the previous row (different address or source)
1673 EmitInt8(DW_LNS_copy); EOL("DW_LNS_copy");
1677 // Define last address.
1678 EmitInt8(0); EOL("Extended Op");
1679 EmitInt8(4 + 1); EOL("Op size");
1680 EmitInt8(DW_LNE_set_address); EOL("DW_LNE_set_address");
1681 EmitReference("text_end", 0); EOL("Location label");
1683 // Mark end of matrix.
1684 EmitInt8(0); EOL("DW_LNE_end_sequence");
1685 EmitULEB128Bytes(1); O << "\n";
1686 EmitInt8(1); O << "\n";
1688 EmitLabel("line_end", 0);
1691 /// EmitDebugFrame - Emit visible names into a debug frame section.
1693 void DwarfWriter::EmitDebugFrame() {
1694 // FIXME - Should be per frame
1697 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
1699 void DwarfWriter::EmitDebugPubNames() {
1700 // Check to see if it is worth the effort.
1701 if (!GlobalEntities.empty()) {
1702 // Start the dwarf pubnames section.
1703 Asm->SwitchSection(DwarfPubNamesSection, 0);
1705 EmitDifference("pubnames_end", 0, "pubnames_begin", 0);
1706 EOL("Length of Public Names Info");
1708 EmitLabel("pubnames_begin", 0);
1710 EmitInt16(DWARF_VERSION); EOL("DWARF Version");
1712 EmitReference("info_begin", 0); EOL("Offset of Compilation Unit Info");
1714 EmitDifference("info_end", 0, "info_begin", 0);
1715 EOL("Compilation Unit Length");
1717 for (std::map<std::string, DIE *>::iterator GI = GlobalEntities.begin(),
1718 GE = GlobalEntities.end();
1720 const std::string &Name = GI->first;
1721 DIE * Entity = GI->second;
1723 EmitInt32(Entity->getOffset()); EOL("DIE offset");
1724 EmitString(Name); EOL("External Name");
1728 EmitInt32(0); EOL("End Mark");
1729 EmitLabel("pubnames_end", 0);
1733 /// EmitDebugPubTypes - Emit visible names into a debug pubtypes section.
1735 void DwarfWriter::EmitDebugPubTypes() {
1736 // Check to see if it is worth the effort.
1737 if (!GlobalTypes.empty()) {
1738 // Start the dwarf pubtypes section.
1739 Asm->SwitchSection(DwarfPubTypesSection, 0);
1743 /// EmitDebugStr - Emit visible names into a debug str section.
1745 void DwarfWriter::EmitDebugStr() {
1746 // Check to see if it is worth the effort.
1747 if (!StringPool.empty()) {
1748 // Start the dwarf str section.
1749 Asm->SwitchSection(DwarfStrSection, 0);
1751 // For each of strings in teh string pool.
1752 for (unsigned StringID = 1, N = StringPool.size();
1753 StringID <= N; ++StringID) {
1754 // Emit a label for reference from debug information entries.
1755 EmitLabel("string", StringID);
1756 // Emit the string itself.
1757 const std::string &String = StringPool[StringID];
1758 EmitString(String); O << "\n";
1763 /// EmitDebugLoc - Emit visible names into a debug loc section.
1765 void DwarfWriter::EmitDebugLoc() {
1766 // Start the dwarf loc section.
1767 Asm->SwitchSection(DwarfLocSection, 0);
1770 /// EmitDebugARanges - Emit visible names into a debug aranges section.
1772 void DwarfWriter::EmitDebugARanges() {
1773 // Start the dwarf aranges section.
1774 Asm->SwitchSection(DwarfARangesSection, 0);
1778 // Don't include size of length
1779 EmitInt32(0x1c); EOL("Length of Address Ranges Info");
1781 EmitInt16(DWARF_VERSION); EOL("Dwarf Version");
1783 EmitReference("info_begin", 0); EOL("Offset of Compilation Unit Info");
1785 EmitInt8(AddressSize); EOL("Size of Address");
1787 EmitInt8(0); EOL("Size of Segment Descriptor");
1789 EmitInt16(0); EOL("Pad (1)");
1790 EmitInt16(0); EOL("Pad (2)");
1793 EmitReference("text_begin", 0); EOL("Address");
1794 EmitDifference("text_end", 0, "text_begin", 0); EOL("Length");
1796 EmitInt32(0); EOL("EOM (1)");
1797 EmitInt32(0); EOL("EOM (2)");
1800 /// EmitDebugRanges - Emit visible names into a debug ranges section.
1802 void DwarfWriter::EmitDebugRanges() {
1803 // Start the dwarf ranges section.
1804 Asm->SwitchSection(DwarfRangesSection, 0);
1807 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
1809 void DwarfWriter::EmitDebugMacInfo() {
1810 // Start the dwarf macinfo section.
1811 Asm->SwitchSection(DwarfMacInfoSection, 0);
1814 /// ConstructCompileUnitDIEs - Create a compile unit DIE for each source and
1816 void DwarfWriter::ConstructCompileUnitDIEs() {
1817 const UniqueVector<CompileUnitDesc *> CUW = DebugInfo->getCompileUnits();
1819 for (unsigned i = 1, N = CUW.size(); i <= N; ++i) {
1820 DIE *Unit = NewCompileUnit(CUW[i]);
1821 CompileUnits.push_back(Unit);
1825 /// ConstructGlobalDIEs - Create DIEs for each of the externally visible global
1827 void DwarfWriter::ConstructGlobalDIEs(Module &M) {
1828 std::vector<GlobalVariableDesc *> GlobalVariables =
1829 DebugInfo->getAnchoredDescriptors<GlobalVariableDesc>(M);
1831 for (unsigned i = 0, N = GlobalVariables.size(); i < N; ++i) {
1832 GlobalVariableDesc *GVD = GlobalVariables[i];
1833 NewGlobalVariable(GVD);
1837 /// ConstructSubprogramDIEs - Create DIEs for each of the externally visible
1839 void DwarfWriter::ConstructSubprogramDIEs(Module &M) {
1840 std::vector<SubprogramDesc *> Subprograms =
1841 DebugInfo->getAnchoredDescriptors<SubprogramDesc>(M);
1843 for (unsigned i = 0, N = Subprograms.size(); i < N; ++i) {
1844 SubprogramDesc *SPD = Subprograms[i];
1849 /// ShouldEmitDwarf - Determine if Dwarf declarations should be made.
1851 bool DwarfWriter::ShouldEmitDwarf() {
1852 // Check if debug info is present.
1853 if (!DebugInfo || !DebugInfo->hasInfo()) return false;
1855 // Make sure initial declarations are made.
1865 //===----------------------------------------------------------------------===//
1866 // Main entry points.
1869 DwarfWriter::DwarfWriter(std::ostream &OS, AsmPrinter *A)
1881 , AddressSize(sizeof(int32_t))
1886 , DwarfAbbrevSection(".debug_abbrev")
1887 , DwarfInfoSection(".debug_info")
1888 , DwarfLineSection(".debug_line")
1889 , DwarfFrameSection(".debug_frame")
1890 , DwarfPubNamesSection(".debug_pubnames")
1891 , DwarfPubTypesSection(".debug_pubtypes")
1892 , DwarfStrSection(".debug_str")
1893 , DwarfLocSection(".debug_loc")
1894 , DwarfARangesSection(".debug_aranges")
1895 , DwarfRangesSection(".debug_ranges")
1896 , DwarfMacInfoSection(".debug_macinfo")
1897 , TextSection(".text")
1898 , DataSection(".data")
1900 DwarfWriter::~DwarfWriter() {
1901 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) {
1902 delete CompileUnits[i];
1906 /// BeginModule - Emit all Dwarf sections that should come prior to the content.
1908 void DwarfWriter::BeginModule(Module &M) {
1909 if (!ShouldEmitDwarf()) return;
1910 EOL("Dwarf Begin Module");
1913 /// EndModule - Emit all Dwarf sections that should come after the content.
1915 void DwarfWriter::EndModule(Module &M) {
1916 if (!ShouldEmitDwarf()) return;
1917 EOL("Dwarf End Module");
1919 // Standard sections final addresses.
1920 Asm->SwitchSection(TextSection, 0);
1921 EmitLabel("text_end", 0);
1922 Asm->SwitchSection(DataSection, 0);
1923 EmitLabel("data_end", 0);
1925 // Create all the compile unit DIEs.
1926 ConstructCompileUnitDIEs();
1928 // Create DIEs for each of the externally visible global variables.
1929 ConstructGlobalDIEs(M);
1931 // Create DIEs for each of the externally visible subprograms.
1932 ConstructSubprogramDIEs(M);
1934 // Compute DIE offsets and sizes.
1937 // Emit all the DIEs into a debug info section
1940 // Corresponding abbreviations into a abbrev section.
1941 EmitAbbreviations();
1943 // Emit source line correspondence into a debug line section.
1946 // Emit info into a debug frame section.
1949 // Emit info into a debug pubnames section.
1950 EmitDebugPubNames();
1952 // Emit info into a debug pubtypes section.
1953 EmitDebugPubTypes();
1955 // Emit info into a debug str section.
1958 // Emit info into a debug loc section.
1961 // Emit info into a debug aranges section.
1964 // Emit info into a debug ranges section.
1967 // Emit info into a debug macinfo section.
1971 /// BeginFunction - Gather pre-function debug information.
1973 void DwarfWriter::BeginFunction(MachineFunction &MF) {
1974 if (!ShouldEmitDwarf()) return;
1975 EOL("Dwarf Begin Function");
1978 /// EndFunction - Gather and emit post-function debug information.
1980 void DwarfWriter::EndFunction(MachineFunction &MF) {
1981 if (!ShouldEmitDwarf()) return;
1982 EOL("Dwarf End Function");