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/CodeGen/AsmPrinter.h"
18 #include "llvm/CodeGen/MachineDebugInfo.h"
19 #include "llvm/Support/CommandLine.h"
26 DwarfVerbose("dwarf-verbose", cl::Hidden,
27 cl::desc("Add comments to Dwarf directives."));
29 //===----------------------------------------------------------------------===//
31 /// TagString - Return the string for the specified tag.
33 static const char *TagString(unsigned Tag) {
35 case DW_TAG_array_type: return "TAG_array_type";
36 case DW_TAG_class_type: return "TAG_class_type";
37 case DW_TAG_entry_point: return "TAG_entry_point";
38 case DW_TAG_enumeration_type: return "TAG_enumeration_type";
39 case DW_TAG_formal_parameter: return "TAG_formal_parameter";
40 case DW_TAG_imported_declaration: return "TAG_imported_declaration";
41 case DW_TAG_label: return "TAG_label";
42 case DW_TAG_lexical_block: return "TAG_lexical_block";
43 case DW_TAG_member: return "TAG_member";
44 case DW_TAG_pointer_type: return "TAG_pointer_type";
45 case DW_TAG_reference_type: return "TAG_reference_type";
46 case DW_TAG_compile_unit: return "TAG_compile_unit";
47 case DW_TAG_string_type: return "TAG_string_type";
48 case DW_TAG_structure_type: return "TAG_structure_type";
49 case DW_TAG_subroutine_type: return "TAG_subroutine_type";
50 case DW_TAG_typedef: return "TAG_typedef";
51 case DW_TAG_union_type: return "TAG_union_type";
52 case DW_TAG_unspecified_parameters: return "TAG_unspecified_parameters";
53 case DW_TAG_variant: return "TAG_variant";
54 case DW_TAG_common_block: return "TAG_common_block";
55 case DW_TAG_common_inclusion: return "TAG_common_inclusion";
56 case DW_TAG_inheritance: return "TAG_inheritance";
57 case DW_TAG_inlined_subroutine: return "TAG_inlined_subroutine";
58 case DW_TAG_module: return "TAG_module";
59 case DW_TAG_ptr_to_member_type: return "TAG_ptr_to_member_type";
60 case DW_TAG_set_type: return "TAG_set_type";
61 case DW_TAG_subrange_type: return "TAG_subrange_type";
62 case DW_TAG_with_stmt: return "TAG_with_stmt";
63 case DW_TAG_access_declaration: return "TAG_access_declaration";
64 case DW_TAG_base_type: return "TAG_base_type";
65 case DW_TAG_catch_block: return "TAG_catch_block";
66 case DW_TAG_const_type: return "TAG_const_type";
67 case DW_TAG_constant: return "TAG_constant";
68 case DW_TAG_enumerator: return "TAG_enumerator";
69 case DW_TAG_file_type: return "TAG_file_type";
70 case DW_TAG_friend: return "TAG_friend";
71 case DW_TAG_namelist: return "TAG_namelist";
72 case DW_TAG_namelist_item: return "TAG_namelist_item";
73 case DW_TAG_packed_type: return "TAG_packed_type";
74 case DW_TAG_subprogram: return "TAG_subprogram";
75 case DW_TAG_template_type_parameter: return "TAG_template_type_parameter";
76 case DW_TAG_template_value_parameter: return "TAG_template_value_parameter";
77 case DW_TAG_thrown_type: return "TAG_thrown_type";
78 case DW_TAG_try_block: return "TAG_try_block";
79 case DW_TAG_variant_part: return "TAG_variant_part";
80 case DW_TAG_variable: return "TAG_variable";
81 case DW_TAG_volatile_type: return "TAG_volatile_type";
82 case DW_TAG_dwarf_procedure: return "TAG_dwarf_procedure";
83 case DW_TAG_restrict_type: return "TAG_restrict_type";
84 case DW_TAG_interface_type: return "TAG_interface_type";
85 case DW_TAG_namespace: return "TAG_namespace";
86 case DW_TAG_imported_module: return "TAG_imported_module";
87 case DW_TAG_unspecified_type: return "TAG_unspecified_type";
88 case DW_TAG_partial_unit: return "TAG_partial_unit";
89 case DW_TAG_imported_unit: return "TAG_imported_unit";
90 case DW_TAG_condition: return "TAG_condition";
91 case DW_TAG_shared_type: return "TAG_shared_type";
92 case DW_TAG_lo_user: return "TAG_lo_user";
93 case DW_TAG_hi_user: return "TAG_hi_user";
95 assert(0 && "Unknown Dwarf Tag");
99 /// ChildrenString - Return the string for the specified children flag.
101 static const char *ChildrenString(unsigned Children) {
103 case DW_CHILDREN_no: return "CHILDREN_no";
104 case DW_CHILDREN_yes: return "CHILDREN_yes";
106 assert(0 && "Unknown Dwarf ChildrenFlag");
110 /// AttributeString - Return the string for the specified attribute.
112 static const char *AttributeString(unsigned Attribute) {
114 case DW_AT_sibling: return "AT_sibling";
115 case DW_AT_location: return "AT_location";
116 case DW_AT_name: return "AT_name";
117 case DW_AT_ordering: return "AT_ordering";
118 case DW_AT_byte_size: return "AT_byte_size";
119 case DW_AT_bit_offset: return "AT_bit_offset";
120 case DW_AT_bit_size: return "AT_bit_size";
121 case DW_AT_stmt_list: return "AT_stmt_list";
122 case DW_AT_low_pc: return "AT_low_pc";
123 case DW_AT_high_pc: return "AT_high_pc";
124 case DW_AT_language: return "AT_language";
125 case DW_AT_discr: return "AT_discr";
126 case DW_AT_discr_value: return "AT_discr_value";
127 case DW_AT_visibility: return "AT_visibility";
128 case DW_AT_import: return "AT_import";
129 case DW_AT_string_length: return "AT_string_length";
130 case DW_AT_common_reference: return "AT_common_reference";
131 case DW_AT_comp_dir: return "AT_comp_dir";
132 case DW_AT_const_value: return "AT_const_value";
133 case DW_AT_containing_type: return "AT_containing_type";
134 case DW_AT_default_value: return "AT_default_value";
135 case DW_AT_inline: return "AT_inline";
136 case DW_AT_is_optional: return "AT_is_optional";
137 case DW_AT_lower_bound: return "AT_lower_bound";
138 case DW_AT_producer: return "AT_producer";
139 case DW_AT_prototyped: return "AT_prototyped";
140 case DW_AT_return_addr: return "AT_return_addr";
141 case DW_AT_start_scope: return "AT_start_scope";
142 case DW_AT_bit_stride: return "AT_bit_stride";
143 case DW_AT_upper_bound: return "AT_upper_bound";
144 case DW_AT_abstract_origin: return "AT_abstract_origin";
145 case DW_AT_accessibility: return "AT_accessibility";
146 case DW_AT_address_class: return "AT_address_class";
147 case DW_AT_artificial: return "AT_artificial";
148 case DW_AT_base_types: return "AT_base_types";
149 case DW_AT_calling_convention: return "AT_calling_convention";
150 case DW_AT_count: return "AT_count";
151 case DW_AT_data_member_location: return "AT_data_member_location";
152 case DW_AT_decl_column: return "AT_decl_column";
153 case DW_AT_decl_file: return "AT_decl_file";
154 case DW_AT_decl_line: return "AT_decl_line";
155 case DW_AT_declaration: return "AT_declaration";
156 case DW_AT_discr_list: return "AT_discr_list";
157 case DW_AT_encoding: return "AT_encoding";
158 case DW_AT_external: return "AT_external";
159 case DW_AT_frame_base: return "AT_frame_base";
160 case DW_AT_friend: return "AT_friend";
161 case DW_AT_identifier_case: return "AT_identifier_case";
162 case DW_AT_macro_info: return "AT_macro_info";
163 case DW_AT_namelist_item: return "AT_namelist_item";
164 case DW_AT_priority: return "AT_priority";
165 case DW_AT_segment: return "AT_segment";
166 case DW_AT_specification: return "AT_specification";
167 case DW_AT_static_link: return "AT_static_link";
168 case DW_AT_type: return "AT_type";
169 case DW_AT_use_location: return "AT_use_location";
170 case DW_AT_variable_parameter: return "AT_variable_parameter";
171 case DW_AT_virtuality: return "AT_virtuality";
172 case DW_AT_vtable_elem_location: return "AT_vtable_elem_location";
173 case DW_AT_allocated: return "AT_allocated";
174 case DW_AT_associated: return "AT_associated";
175 case DW_AT_data_location: return "AT_data_location";
176 case DW_AT_byte_stride: return "AT_byte_stride";
177 case DW_AT_entry_pc: return "AT_entry_pc";
178 case DW_AT_use_UTF8: return "AT_use_UTF8";
179 case DW_AT_extension: return "AT_extension";
180 case DW_AT_ranges: return "AT_ranges";
181 case DW_AT_trampoline: return "AT_trampoline";
182 case DW_AT_call_column: return "AT_call_column";
183 case DW_AT_call_file: return "AT_call_file";
184 case DW_AT_call_line: return "AT_call_line";
185 case DW_AT_description: return "AT_description";
186 case DW_AT_binary_scale: return "AT_binary_scale";
187 case DW_AT_decimal_scale: return "AT_decimal_scale";
188 case DW_AT_small: return "AT_small";
189 case DW_AT_decimal_sign: return "AT_decimal_sign";
190 case DW_AT_digit_count: return "AT_digit_count";
191 case DW_AT_picture_string: return "AT_picture_string";
192 case DW_AT_mutable: return "AT_mutable";
193 case DW_AT_threads_scaled: return "AT_threads_scaled";
194 case DW_AT_explicit: return "AT_explicit";
195 case DW_AT_object_pointer: return "AT_object_pointer";
196 case DW_AT_endianity: return "AT_endianity";
197 case DW_AT_elemental: return "AT_elemental";
198 case DW_AT_pure: return "AT_pure";
199 case DW_AT_recursive: return "AT_recursive";
200 case DW_AT_lo_user: return "AT_lo_user";
201 case DW_AT_hi_user: return "AT_hi_user";
203 assert(0 && "Unknown Dwarf Attribute");
207 /// FormEncodingString - Return the string for the specified form encoding.
209 static const char *FormEncodingString(unsigned Encoding) {
211 case DW_FORM_addr: return "FORM_addr";
212 case DW_FORM_block2: return "FORM_block2";
213 case DW_FORM_block4: return "FORM_block4";
214 case DW_FORM_data2: return "FORM_data2";
215 case DW_FORM_data4: return "FORM_data4";
216 case DW_FORM_data8: return "FORM_data8";
217 case DW_FORM_string: return "FORM_string";
218 case DW_FORM_block: return "FORM_block";
219 case DW_FORM_block1: return "FORM_block1";
220 case DW_FORM_data1: return "FORM_data1";
221 case DW_FORM_flag: return "FORM_flag";
222 case DW_FORM_sdata: return "FORM_sdata";
223 case DW_FORM_strp: return "FORM_strp";
224 case DW_FORM_udata: return "FORM_udata";
225 case DW_FORM_ref_addr: return "FORM_ref_addr";
226 case DW_FORM_ref1: return "FORM_ref1";
227 case DW_FORM_ref2: return "FORM_ref2";
228 case DW_FORM_ref4: return "FORM_ref4";
229 case DW_FORM_ref8: return "FORM_ref8";
230 case DW_FORM_ref_udata: return "FORM_ref_udata";
231 case DW_FORM_indirect: return "FORM_indirect";
233 assert(0 && "Unknown Dwarf Form Encoding");
237 /// OperationEncodingString - Return the string for the specified operation
239 static const char *OperationEncodingString(unsigned Encoding) {
241 case DW_OP_addr: return "OP_addr";
242 case DW_OP_deref: return "OP_deref";
243 case DW_OP_const1u: return "OP_const1u";
244 case DW_OP_const1s: return "OP_const1s";
245 case DW_OP_const2u: return "OP_const2u";
246 case DW_OP_const2s: return "OP_const2s";
247 case DW_OP_const4u: return "OP_const4u";
248 case DW_OP_const4s: return "OP_const4s";
249 case DW_OP_const8u: return "OP_const8u";
250 case DW_OP_const8s: return "OP_const8s";
251 case DW_OP_constu: return "OP_constu";
252 case DW_OP_consts: return "OP_consts";
253 case DW_OP_dup: return "OP_dup";
254 case DW_OP_drop: return "OP_drop";
255 case DW_OP_over: return "OP_over";
256 case DW_OP_pick: return "OP_pick";
257 case DW_OP_swap: return "OP_swap";
258 case DW_OP_rot: return "OP_rot";
259 case DW_OP_xderef: return "OP_xderef";
260 case DW_OP_abs: return "OP_abs";
261 case DW_OP_and: return "OP_and";
262 case DW_OP_div: return "OP_div";
263 case DW_OP_minus: return "OP_minus";
264 case DW_OP_mod: return "OP_mod";
265 case DW_OP_mul: return "OP_mul";
266 case DW_OP_neg: return "OP_neg";
267 case DW_OP_not: return "OP_not";
268 case DW_OP_or: return "OP_or";
269 case DW_OP_plus: return "OP_plus";
270 case DW_OP_plus_uconst: return "OP_plus_uconst";
271 case DW_OP_shl: return "OP_shl";
272 case DW_OP_shr: return "OP_shr";
273 case DW_OP_shra: return "OP_shra";
274 case DW_OP_xor: return "OP_xor";
275 case DW_OP_skip: return "OP_skip";
276 case DW_OP_bra: return "OP_bra";
277 case DW_OP_eq: return "OP_eq";
278 case DW_OP_ge: return "OP_ge";
279 case DW_OP_gt: return "OP_gt";
280 case DW_OP_le: return "OP_le";
281 case DW_OP_lt: return "OP_lt";
282 case DW_OP_ne: return "OP_ne";
283 case DW_OP_lit0: return "OP_lit0";
284 case DW_OP_lit1: return "OP_lit1";
285 case DW_OP_lit31: return "OP_lit31";
286 case DW_OP_reg0: return "OP_reg0";
287 case DW_OP_reg1: return "OP_reg1";
288 case DW_OP_reg31: return "OP_reg31";
289 case DW_OP_breg0: return "OP_breg0";
290 case DW_OP_breg1: return "OP_breg1";
291 case DW_OP_breg31: return "OP_breg31";
292 case DW_OP_regx: return "OP_regx";
293 case DW_OP_fbreg: return "OP_fbreg";
294 case DW_OP_bregx: return "OP_bregx";
295 case DW_OP_piece: return "OP_piece";
296 case DW_OP_deref_size: return "OP_deref_size";
297 case DW_OP_xderef_size: return "OP_xderef_size";
298 case DW_OP_nop: return "OP_nop";
299 case DW_OP_push_object_address: return "OP_push_object_address";
300 case DW_OP_call2: return "OP_call2";
301 case DW_OP_call4: return "OP_call4";
302 case DW_OP_call_ref: return "OP_call_ref";
303 case DW_OP_form_tls_address: return "OP_form_tls_address";
304 case DW_OP_call_frame_cfa: return "OP_call_frame_cfa";
305 case DW_OP_lo_user: return "OP_lo_user";
306 case DW_OP_hi_user: return "OP_hi_user";
308 assert(0 && "Unknown Dwarf Operation Encoding");
312 /// AttributeEncodingString - Return the string for the specified attribute
314 static const char *AttributeEncodingString(unsigned Encoding) {
316 case DW_ATE_address: return "ATE_address";
317 case DW_ATE_boolean: return "ATE_boolean";
318 case DW_ATE_complex_float: return "ATE_complex_float";
319 case DW_ATE_float: return "ATE_float";
320 case DW_ATE_signed: return "ATE_signed";
321 case DW_ATE_signed_char: return "ATE_signed_char";
322 case DW_ATE_unsigned: return "ATE_unsigned";
323 case DW_ATE_unsigned_char: return "ATE_unsigned_char";
324 case DW_ATE_imaginary_float: return "ATE_imaginary_float";
325 case DW_ATE_packed_decimal: return "ATE_packed_decimal";
326 case DW_ATE_numeric_string: return "ATE_numeric_string";
327 case DW_ATE_edited: return "ATE_edited";
328 case DW_ATE_signed_fixed: return "ATE_signed_fixed";
329 case DW_ATE_unsigned_fixed: return "ATE_unsigned_fixed";
330 case DW_ATE_decimal_float: return "ATE_decimal_float";
331 case DW_ATE_lo_user: return "ATE_lo_user";
332 case DW_ATE_hi_user: return "ATE_hi_user";
334 assert(0 && "Unknown Dwarf Attribute Encoding");
338 /// DecimalSignString - Return the string for the specified decimal sign
340 static const char *DecimalSignString(unsigned Sign) {
342 case DW_DS_unsigned: return "DS_unsigned";
343 case DW_DS_leading_overpunch: return "DS_leading_overpunch";
344 case DW_DS_trailing_overpunch: return "DS_trailing_overpunch";
345 case DW_DS_leading_separate: return "DS_leading_separate";
346 case DW_DS_trailing_separate: return "DS_trailing_separate";
348 assert(0 && "Unknown Dwarf Decimal Sign Attribute");
352 /// EndianityString - Return the string for the specified endianity.
354 static const char *EndianityString(unsigned Endian) {
356 case DW_END_default: return "END_default";
357 case DW_END_big: return "END_big";
358 case DW_END_little: return "END_little";
359 case DW_END_lo_user: return "END_lo_user";
360 case DW_END_hi_user: return "END_hi_user";
362 assert(0 && "Unknown Dwarf Endianity");
366 /// AccessibilityString - Return the string for the specified accessibility.
368 static const char *AccessibilityString(unsigned Access) {
370 // Accessibility codes
371 case DW_ACCESS_public: return "ACCESS_public";
372 case DW_ACCESS_protected: return "ACCESS_protected";
373 case DW_ACCESS_private: return "ACCESS_private";
375 assert(0 && "Unknown Dwarf Accessibility");
379 /// VisibilityString - Return the string for the specified visibility.
381 static const char *VisibilityString(unsigned Visibility) {
383 case DW_VIS_local: return "VIS_local";
384 case DW_VIS_exported: return "VIS_exported";
385 case DW_VIS_qualified: return "VIS_qualified";
387 assert(0 && "Unknown Dwarf Visibility");
391 /// VirtualityString - Return the string for the specified virtuality.
393 static const char *VirtualityString(unsigned Virtuality) {
395 case DW_VIRTUALITY_none: return "VIRTUALITY_none";
396 case DW_VIRTUALITY_virtual: return "VIRTUALITY_virtual";
397 case DW_VIRTUALITY_pure_virtual: return "VIRTUALITY_pure_virtual";
399 assert(0 && "Unknown Dwarf Virtuality");
403 /// LanguageString - Return the string for the specified language.
405 static const char *LanguageString(unsigned Language) {
407 case DW_LANG_C89: return "LANG_C89";
408 case DW_LANG_C: return "LANG_C";
409 case DW_LANG_Ada83: return "LANG_Ada83";
410 case DW_LANG_C_plus_plus: return "LANG_C_plus_plus";
411 case DW_LANG_Cobol74: return "LANG_Cobol74";
412 case DW_LANG_Cobol85: return "LANG_Cobol85";
413 case DW_LANG_Fortran77: return "LANG_Fortran77";
414 case DW_LANG_Fortran90: return "LANG_Fortran90";
415 case DW_LANG_Pascal83: return "LANG_Pascal83";
416 case DW_LANG_Modula2: return "LANG_Modula2";
417 case DW_LANG_Java: return "LANG_Java";
418 case DW_LANG_C99: return "LANG_C99";
419 case DW_LANG_Ada95: return "LANG_Ada95";
420 case DW_LANG_Fortran95: return "LANG_Fortran95";
421 case DW_LANG_PLI: return "LANG_PLI";
422 case DW_LANG_ObjC: return "LANG_ObjC";
423 case DW_LANG_ObjC_plus_plus: return "LANG_ObjC_plus_plus";
424 case DW_LANG_UPC: return "LANG_UPC";
425 case DW_LANG_D: return "LANG_D";
426 case DW_LANG_lo_user: return "LANG_lo_user";
427 case DW_LANG_hi_user: return "LANG_hi_user";
429 assert(0 && "Unknown Dwarf Language");
433 /// CaseString - Return the string for the specified identifier case.
435 static const char *CaseString(unsigned Case) {
437 case DW_ID_case_sensitive: return "ID_case_sensitive";
438 case DW_ID_up_case: return "ID_up_case";
439 case DW_ID_down_case: return "ID_down_case";
440 case DW_ID_case_insensitive: return "ID_case_insensitive";
442 assert(0 && "Unknown Dwarf Identifier Case");
446 /// ConventionString - Return the string for the specified calling convention.
448 static const char *ConventionString(unsigned Convention) {
450 case DW_CC_normal: return "CC_normal";
451 case DW_CC_program: return "CC_program";
452 case DW_CC_nocall: return "CC_nocall";
453 case DW_CC_lo_user: return "CC_lo_user";
454 case DW_CC_hi_user: return "CC_hi_user";
456 assert(0 && "Unknown Dwarf Calling Convention");
460 /// InlineCodeString - Return the string for the specified inline code.
462 static const char *InlineCodeString(unsigned Code) {
464 case DW_INL_not_inlined: return "INL_not_inlined";
465 case DW_INL_inlined: return "INL_inlined";
466 case DW_INL_declared_not_inlined: return "INL_declared_not_inlined";
467 case DW_INL_declared_inlined: return "INL_declared_inlined";
469 assert(0 && "Unknown Dwarf Inline Code");
473 /// ArrayOrderString - Return the string for the specified array order.
475 static const char *ArrayOrderString(unsigned Order) {
477 case DW_ORD_row_major: return "ORD_row_major";
478 case DW_ORD_col_major: return "ORD_col_major";
480 assert(0 && "Unknown Dwarf Array Order");
484 /// DiscriminantString - Return the string for the specified discriminant
486 static const char *DiscriminantString(unsigned Discriminant) {
487 switch(Discriminant) {
488 case DW_DSC_label: return "DSC_label";
489 case DW_DSC_range: return "DSC_range";
491 assert(0 && "Unknown Dwarf Discriminant Descriptor");
495 /// LNStandardString - Return the string for the specified line number standard.
497 static const char *LNStandardString(unsigned Standard) {
499 case DW_LNS_copy: return "LNS_copy";
500 case DW_LNS_advance_pc: return "LNS_advance_pc";
501 case DW_LNS_advance_line: return "LNS_advance_line";
502 case DW_LNS_set_file: return "LNS_set_file";
503 case DW_LNS_set_column: return "LNS_set_column";
504 case DW_LNS_negate_stmt: return "LNS_negate_stmt";
505 case DW_LNS_set_basic_block: return "LNS_set_basic_block";
506 case DW_LNS_const_add_pc: return "LNS_const_add_pc";
507 case DW_LNS_fixed_advance_pc: return "LNS_fixed_advance_pc";
508 case DW_LNS_set_prologue_end: return "LNS_set_prologue_end";
509 case DW_LNS_set_epilogue_begin: return "LNS_set_epilogue_begin";
510 case DW_LNS_set_isa: return "LNS_set_isa";
512 assert(0 && "Unknown Dwarf Line Number Standard");
516 /// LNExtendedString - Return the string for the specified line number extended
517 /// opcode encodings.
518 static const char *LNExtendedString(unsigned Encoding) {
520 // Line Number Extended Opcode Encodings
521 case DW_LNE_end_sequence: return "LNE_end_sequence";
522 case DW_LNE_set_address: return "LNE_set_address";
523 case DW_LNE_define_file: return "LNE_define_file";
524 case DW_LNE_lo_user: return "LNE_lo_user";
525 case DW_LNE_hi_user: return "LNE_hi_user";
527 assert(0 && "Unknown Dwarf Line Number Extended Opcode Encoding");
531 /// MacinfoString - Return the string for the specified macinfo type encodings.
533 static const char *MacinfoString(unsigned Encoding) {
535 // Macinfo Type Encodings
536 case DW_MACINFO_define: return "MACINFO_define";
537 case DW_MACINFO_undef: return "MACINFO_undef";
538 case DW_MACINFO_start_file: return "MACINFO_start_file";
539 case DW_MACINFO_end_file: return "MACINFO_end_file";
540 case DW_MACINFO_vendor_ext: return "MACINFO_vendor_ext";
542 assert(0 && "Unknown Dwarf Macinfo Type Encodings");
546 /// CallFrameString - Return the string for the specified call frame instruction
548 static const char *CallFrameString(unsigned Encoding) {
550 case DW_CFA_advance_loc: return "CFA_advance_loc";
551 case DW_CFA_offset: return "CFA_offset";
552 case DW_CFA_restore: return "CFA_restore";
553 case DW_CFA_set_loc: return "CFA_set_loc";
554 case DW_CFA_advance_loc1: return "CFA_advance_loc1";
555 case DW_CFA_advance_loc2: return "CFA_advance_loc2";
556 case DW_CFA_advance_loc4: return "CFA_advance_loc4";
557 case DW_CFA_offset_extended: return "CFA_offset_extended";
558 case DW_CFA_restore_extended: return "CFA_restore_extended";
559 case DW_CFA_undefined: return "CFA_undefined";
560 case DW_CFA_same_value: return "CFA_same_value";
561 case DW_CFA_register: return "CFA_register";
562 case DW_CFA_remember_state: return "CFA_remember_state";
563 case DW_CFA_restore_state: return "CFA_restore_state";
564 case DW_CFA_def_cfa: return "CFA_def_cfa";
565 case DW_CFA_def_cfa_register: return "CFA_def_cfa_register";
566 case DW_CFA_def_cfa_offset: return "CFA_def_cfa_offset";
567 case DW_CFA_def_cfa_expression: return "CFA_def_cfa_expression";
568 case DW_CFA_expression: return "CFA_expression";
569 case DW_CFA_offset_extended_sf: return "CFA_offset_extended_sf";
570 case DW_CFA_def_cfa_sf: return "CFA_def_cfa_sf";
571 case DW_CFA_def_cfa_offset_sf: return "CFA_def_cfa_offset_sf";
572 case DW_CFA_val_offset: return "CFA_val_offset";
573 case DW_CFA_val_offset_sf: return "CFA_val_offset_sf";
574 case DW_CFA_val_expression: return "CFA_val_expression";
575 case DW_CFA_lo_user: return "CFA_lo_user";
576 case DW_CFA_hi_user: return "CFA_hi_user";
578 assert(0 && "Unknown Dwarf Call Frame Instruction Encodings");
582 //===----------------------------------------------------------------------===//
584 /// operator== - Used by UniqueVector to locate entry.
586 bool DIEAbbrev::operator==(const DIEAbbrev &DA) const {
587 if (Tag != DA.Tag) return false;
588 if (ChildrenFlag != DA.ChildrenFlag) return false;
589 if (Data.size() != DA.Data.size()) return false;
591 for (unsigned i = 0, N = Data.size(); i < N; i++) {
592 if (Data[i] != DA.Data[i]) return false;
598 /// operator< - Used by UniqueVector to locate entry.
600 bool DIEAbbrev::operator<(const DIEAbbrev &DA) const {
601 if (Tag != DA.Tag) return Tag < DA.Tag;
602 if (ChildrenFlag != DA.ChildrenFlag) return ChildrenFlag < DA.ChildrenFlag;
603 if (Data.size() != DA.Data.size()) return Data.size() < DA.Data.size();
605 for (unsigned i = 0, N = Data.size(); i < N; i++) {
606 if (Data[i] != DA.Data[i]) return Data[i] < DA.Data[i];
612 /// Emit - Print the abbreviation using the specified Dwarf writer.
614 void DIEAbbrev::Emit(const DwarfWriter &DW) const {
615 // Emit its Dwarf tag type.
616 DW.EmitULEB128Bytes(Tag);
617 DW.EOL(TagString(Tag));
619 // Emit whether it has children DIEs.
620 DW.EmitULEB128Bytes(ChildrenFlag);
621 DW.EOL(ChildrenString(ChildrenFlag));
623 // For each attribute description.
624 for (unsigned i = 0, N = Data.size(); i < N; i++) {
625 const DIEAbbrevData &AttrData = Data[i];
627 // Emit attribute type.
628 DW.EmitULEB128Bytes(AttrData.getAttribute());
629 DW.EOL(AttributeString(AttrData.getAttribute()));
632 DW.EmitULEB128Bytes(AttrData.getForm());
633 DW.EOL(FormEncodingString(AttrData.getForm()));
636 // Mark end of abbreviation.
637 DW.EmitULEB128Bytes(0); DW.EOL("EOM(1)");
638 DW.EmitULEB128Bytes(0); DW.EOL("EOM(2)");
642 void DIEAbbrev::print(std::ostream &O) {
643 O << "Abbreviation @"
644 << std::hex << (unsigned)this << std::dec
648 << ChildrenString(ChildrenFlag)
651 for (unsigned i = 0, N = Data.size(); i < N; i++) {
653 << AttributeString(Data[i].getAttribute())
655 << FormEncodingString(Data[i].getForm())
659 void DIEAbbrev::dump() { print(std::cerr); }
662 //===----------------------------------------------------------------------===//
664 /// EmitValue - Emit integer of appropriate size.
666 void DIEInteger::EmitValue(const DwarfWriter &DW, unsigned Form) const {
668 case DW_FORM_flag: // Fall thru
669 case DW_FORM_data1: DW.EmitByte(Integer); break;
670 case DW_FORM_data2: DW.EmitShort(Integer); break;
671 case DW_FORM_data4: DW.EmitLong(Integer); break;
672 case DW_FORM_udata: DW.EmitULEB128Bytes(Integer); break;
673 case DW_FORM_sdata: DW.EmitSLEB128Bytes(Integer); break;
674 default: assert(0 && "DIE Value form not supported yet"); break;
678 /// SizeOf - Determine size of integer value in bytes.
680 unsigned DIEInteger::SizeOf(const DwarfWriter &DW, unsigned Form) const {
682 case DW_FORM_flag: // Fall thru
683 case DW_FORM_data1: return sizeof(int8_t);
684 case DW_FORM_data2: return sizeof(int16_t);
685 case DW_FORM_data4: return sizeof(int32_t);
686 case DW_FORM_udata: return DW.SizeULEB128(Integer);
687 case DW_FORM_sdata: return DW.SizeSLEB128(Integer);
688 default: assert(0 && "DIE Value form not supported yet"); break;
693 //===----------------------------------------------------------------------===//
695 /// EmitValue - Emit string value.
697 void DIEString::EmitValue(const DwarfWriter &DW, unsigned Form) const {
698 DW.EmitString(String);
701 /// SizeOf - Determine size of string value in bytes.
703 unsigned DIEString::SizeOf(const DwarfWriter &DW, unsigned Form) const {
704 return String.size() + sizeof(char); // sizeof('\0');
707 //===----------------------------------------------------------------------===//
709 /// EmitValue - Emit label value.
711 void DIELabel::EmitValue(const DwarfWriter &DW, unsigned Form) const {
712 DW.EmitReference(Label);
715 /// SizeOf - Determine size of label value in bytes.
717 unsigned DIELabel::SizeOf(const DwarfWriter &DW, unsigned Form) const {
718 return DW.getAddressSize();
721 //===----------------------------------------------------------------------===//
723 /// EmitValue - Emit label value.
725 void DIEAsIsLabel::EmitValue(const DwarfWriter &DW, unsigned Form) const {
726 DW.EmitReference(Label);
729 /// SizeOf - Determine size of label value in bytes.
731 unsigned DIEAsIsLabel::SizeOf(const DwarfWriter &DW, unsigned Form) const {
732 return DW.getAddressSize();
735 //===----------------------------------------------------------------------===//
737 /// EmitValue - Emit delta value.
739 void DIEDelta::EmitValue(const DwarfWriter &DW, unsigned Form) const {
740 DW.EmitDifference(LabelHi, LabelLo);
743 /// SizeOf - Determine size of delta value in bytes.
745 unsigned DIEDelta::SizeOf(const DwarfWriter &DW, unsigned Form) const {
746 return DW.getAddressSize();
749 //===----------------------------------------------------------------------===//
750 /// EmitValue - Emit extry offset.
752 void DIEntry::EmitValue(const DwarfWriter &DW, unsigned Form) const {
753 DW.EmitLong(Entry->getOffset());
756 /// SizeOf - Determine size of label value in bytes.
758 unsigned DIEntry::SizeOf(const DwarfWriter &DW, unsigned Form) const {
759 return sizeof(int32_t);
762 //===----------------------------------------------------------------------===//
764 DIE::DIE(unsigned Tag, unsigned ChildrenFlag)
765 : Abbrev(new DIEAbbrev(Tag, ChildrenFlag))
775 if (Abbrev) delete Abbrev;
777 for (unsigned i = 0, N = Children.size(); i < N; i++) {
781 for (unsigned j = 0, M = Values.size(); j < M; j++) {
785 if (Context) delete Context;
788 /// AddInt - Add a simple integer attribute data and value.
790 void DIE::AddInt(unsigned Attribute, unsigned Form,
791 int Integer, bool IsSigned) {
794 if ((char)Integer == Integer) Form = DW_FORM_data1;
795 else if ((short)Integer == Integer) Form = DW_FORM_data2;
796 else Form = DW_FORM_data4;
798 if ((unsigned char)Integer == Integer) Form = DW_FORM_data1;
799 else if ((unsigned short)Integer == Integer) Form = DW_FORM_data2;
800 else Form = DW_FORM_data4;
803 Abbrev->AddAttribute(Attribute, Form);
804 Values.push_back(new DIEInteger(Integer));
807 /// AddString - Add a std::string attribute data and value.
809 void DIE::AddString(unsigned Attribute, unsigned Form,
810 const std::string &String) {
811 Abbrev->AddAttribute(Attribute, Form);
812 Values.push_back(new DIEString(String));
815 /// AddLabel - Add a Dwarf label attribute data and value.
817 void DIE::AddLabel(unsigned Attribute, unsigned Form,
818 const DWLabel &Label) {
819 Abbrev->AddAttribute(Attribute, Form);
820 Values.push_back(new DIELabel(Label));
823 /// AddAsIsLabel - Add an non-Dwarf label attribute data and value.
825 void DIE::AddAsIsLabel(unsigned Attribute, unsigned Form,
826 const std::string &Label) {
827 Abbrev->AddAttribute(Attribute, Form);
828 Values.push_back(new DIEAsIsLabel(Label));
831 /// AddDelta - Add a label delta attribute data and value.
833 void DIE::AddDelta(unsigned Attribute, unsigned Form,
834 const DWLabel &Hi, const DWLabel &Lo) {
835 Abbrev->AddAttribute(Attribute, Form);
836 Values.push_back(new DIEDelta(Hi, Lo));
839 /// AddDIEntry - Add a DIE attribute data and value.
841 void DIE::AddDIEntry(unsigned Attribute,
842 unsigned Form, DIE *Entry) {
843 Abbrev->AddAttribute(Attribute, Form);
844 Values.push_back(new DIEntry(Entry));
847 /// Complete - Indicate that all attributes have been added and ready to get an
849 void DIE::Complete(DwarfWriter &DW) {
850 AbbrevID = DW.NewAbbreviation(Abbrev);
855 /// AddChild - Add a child to the DIE.
857 void DIE::AddChild(DIE *Child) {
858 Children.push_back(Child);
861 //===----------------------------------------------------------------------===//
863 /// NewBasicType - Creates a new basic type if necessary, then adds in the
864 /// context and owner.
865 DIE *DWContext::NewBasicType(const std::string &Name, unsigned Size,
867 // FIXME - Just a prototype.
868 DIE *Type = Types[Name];
870 // If first occurance of type.
872 // construct the type DIE.
873 Type = new DIE(DW_TAG_base_type, DW_CHILDREN_no);
874 Type->AddString(DW_AT_name, DW_FORM_string, Name);
875 Type->AddInt (DW_AT_byte_size, DW_FORM_data1, Size);
876 Type->AddInt (DW_AT_encoding, DW_FORM_data1, Encoding);
879 // Add to context owner.
880 Owner->AddChild(Type);
889 /// NewVariable - Creates a basic variable, if necessary, then adds in the
890 /// context and owner.
891 DIE *DWContext::NewVariable(const std::string &Name,
892 unsigned SourceFileID, unsigned Line,
893 DIE *Type, bool IsExternal) {
894 // FIXME - Just a prototype.
895 DIE *Variable = Variables[Name];
897 // If first occurance of variable.
899 assert(IsExternal && "Internal variables not handled yet");
900 Variable = new DIE(DW_TAG_variable, DW_CHILDREN_no);
901 Variable->AddString (DW_AT_name, DW_FORM_string, Name);
902 Variable->AddInt (DW_AT_decl_file, 0, SourceFileID);
903 Variable->AddInt (DW_AT_decl_line, 0, Line);
904 Variable->AddDIEntry (DW_AT_type, DW_FORM_ref4, Type);
905 Variable->AddInt (DW_AT_external, DW_FORM_flag, (int)IsExternal);
906 // FIXME - needs to be an expression.
907 Variable->AddAsIsLabel(DW_AT_location, DW_FORM_block1,
908 std::string("_")+Name+".b");
909 Variable->Complete(DW);
911 // Add to context owner.
912 Owner->AddChild(Variable);
915 Variables[Name] = Variable;
917 // If external add to visible names.
919 DW.NewGlobalEntity(Name, Variable);
926 //===----------------------------------------------------------------------===//
928 /// PrintHex - Print a value as a hexidecimal value.
930 void DwarfWriter::PrintHex(int Value) const {
931 O << "0x" << std::hex << Value << std::dec;
934 /// EOL - Print a newline character to asm stream. If a comment is present
935 /// then it will be printed first. Comments should not contain '\n'.
936 void DwarfWriter::EOL(const std::string &Comment) const {
939 << Asm->CommentString
946 /// EmitULEB128Bytes - Emit an assembler byte data directive to compose an
947 /// unsigned leb128 value.
948 void DwarfWriter::EmitULEB128Bytes(unsigned Value) const {
953 O << Asm->Data8bitsDirective;
958 /// EmitSLEB128Bytes - Emit an assembler byte data directive to compose a
959 /// signed leb128 value.
960 void DwarfWriter::EmitSLEB128Bytes(int Value) const {
965 O << Asm->Data8bitsDirective;
970 /// PrintULEB128 - Print a series of hexidecimal values (separated by commas)
971 /// representing an unsigned leb128 value.
972 void DwarfWriter::PrintULEB128(unsigned Value) const {
974 unsigned Byte = Value & 0x7f;
976 if (Value) Byte |= 0x80;
978 if (Value) O << ", ";
982 /// SizeULEB128 - Compute the number of bytes required for an unsigned leb128
984 unsigned DwarfWriter::SizeULEB128(unsigned Value) {
988 Size += sizeof(int8_t);
993 /// PrintSLEB128 - Print a series of hexidecimal values (separated by commas)
994 /// representing a signed leb128 value.
995 void DwarfWriter::PrintSLEB128(int Value) const {
996 int Sign = Value >> (8 * sizeof(Value) - 1);
1000 unsigned Byte = Value & 0x7f;
1002 IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
1003 if (IsMore) Byte |= 0x80;
1005 if (IsMore) O << ", ";
1009 /// SizeSLEB128 - Compute the number of bytes required for a signed leb128
1011 unsigned DwarfWriter::SizeSLEB128(int Value) {
1013 int Sign = Value >> (8 * sizeof(Value) - 1);
1017 unsigned Byte = Value & 0x7f;
1019 IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
1020 Size += sizeof(int8_t);
1025 /// EmitByte - Emit a byte directive and value.
1027 void DwarfWriter::EmitByte(int Value) const {
1028 O << Asm->Data8bitsDirective;
1032 /// EmitShort - Emit a short directive and value.
1034 void DwarfWriter::EmitShort(int Value) const {
1035 O << Asm->Data16bitsDirective;
1039 /// EmitLong - Emit a long directive and value.
1041 void DwarfWriter::EmitLong(int Value) const {
1042 O << Asm->Data32bitsDirective;
1046 /// EmitString - Emit a string with quotes and a null terminator.
1047 /// Special characters are emitted properly. (Eg. '\t')
1048 void DwarfWriter::EmitString(const std::string &String) const {
1049 O << Asm->AsciiDirective
1051 for (unsigned i = 0, N = String.size(); i < N; i++) {
1052 unsigned char C = String[i];
1054 if (!isascii(C) || iscntrl(C)) {
1056 case '\b': O << "\\b"; break;
1057 case '\f': O << "\\f"; break;
1058 case '\n': O << "\\n"; break;
1059 case '\r': O << "\\r"; break;
1060 case '\t': O << "\\t"; break;
1063 O << char('0' + (C >> 6));
1064 O << char('0' + (C >> 3));
1065 O << char('0' + (C >> 0));
1068 } else if (C == '\"') {
1070 } else if (C == '\'') {
1079 /// PrintLabelName - Print label name in form used by Dwarf writer.
1081 void DwarfWriter::PrintLabelName(const char *Tag, unsigned Number) const {
1082 O << Asm->PrivateGlobalPrefix
1088 /// EmitLabel - Emit location label for internal use by Dwarf.
1090 void DwarfWriter::EmitLabel(const char *Tag, unsigned Number) const {
1091 PrintLabelName(Tag, Number);
1095 /// EmitReference - Emit a reference to a label.
1097 void DwarfWriter::EmitReference(const char *Tag, unsigned Number) const {
1098 if (AddressSize == 4)
1099 O << Asm->Data32bitsDirective;
1101 O << Asm->Data64bitsDirective;
1103 PrintLabelName(Tag, Number);
1105 void DwarfWriter::EmitReference(const std::string &Name) const {
1106 if (AddressSize == 4)
1107 O << Asm->Data32bitsDirective;
1109 O << Asm->Data64bitsDirective;
1114 /// EmitDifference - Emit an label difference as sizeof(pointer) value. Some
1115 /// assemblers do not accept absolute expressions with data directives, so there
1116 /// is an option (needsSet) to use an intermediary 'set' expression.
1117 void DwarfWriter::EmitDifference(const char *TagHi, unsigned NumberHi,
1118 const char *TagLo, unsigned NumberLo) const {
1120 static unsigned SetCounter = 0;
1123 PrintLabelName("set", SetCounter);
1125 PrintLabelName(TagHi, NumberHi);
1127 PrintLabelName(TagLo, NumberLo);
1130 if (AddressSize == sizeof(int32_t))
1131 O << Asm->Data32bitsDirective;
1133 O << Asm->Data64bitsDirective;
1135 PrintLabelName("set", SetCounter);
1139 if (AddressSize == sizeof(int32_t))
1140 O << Asm->Data32bitsDirective;
1142 O << Asm->Data64bitsDirective;
1144 PrintLabelName(TagHi, NumberHi);
1146 PrintLabelName(TagLo, NumberLo);
1150 /// NewAbbreviation - Add the abbreviation to the Abbreviation vector.
1152 unsigned DwarfWriter::NewAbbreviation(DIEAbbrev *Abbrev) {
1153 return Abbreviations.insert(*Abbrev);
1156 /// NewString - Add a string to the constant pool and returns a label.
1158 DWLabel DwarfWriter::NewString(const std::string &String) {
1159 unsigned StringID = StringPool.insert(String);
1160 return DWLabel("string", StringID);
1163 /// NewGlobalType - Make the type visible globally using the given name.
1165 void DwarfWriter::NewGlobalType(const std::string &Name, DIE *Type) {
1166 // FIXME - check for duplication.
1167 GlobalTypes[Name] = Type;
1170 /// NewGlobalEntity - Make the entity visible globally using the given name.
1172 void DwarfWriter::NewGlobalEntity(const std::string &Name, DIE *Entity) {
1173 // FIXME - check for duplication.
1174 GlobalEntities[Name] = Entity;
1177 /// NewCompileUnit - Create new compile unit information.
1179 DIE *DwarfWriter::NewCompileUnit(const std::string &Directory,
1180 const std::string &SourceName) {
1181 DIE *Unit = new DIE(DW_TAG_compile_unit, DW_CHILDREN_yes);
1182 // FIXME - use the correct line set.
1183 Unit->AddLabel (DW_AT_stmt_list, DW_FORM_data4, DWLabel("line", 0));
1184 Unit->AddLabel (DW_AT_high_pc, DW_FORM_addr, DWLabel("text_end", 0));
1185 Unit->AddLabel (DW_AT_low_pc, DW_FORM_addr, DWLabel("text_begin", 0));
1186 // FIXME - The producer needs to be in this form, but should come from
1187 // an appropriate source.
1188 Unit->AddString(DW_AT_producer, DW_FORM_string,
1189 "llvm 3.4.x (LLVM Research Group)");
1190 Unit->AddInt (DW_AT_language, DW_FORM_data1, DW_LANG_C89);
1191 Unit->AddString(DW_AT_name, DW_FORM_string, SourceName);
1192 Unit->AddString(DW_AT_comp_dir, DW_FORM_string, Directory);
1193 Unit->Complete(*this);
1198 /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
1199 /// tools to recognize the object file contains Dwarf information.
1201 void DwarfWriter::EmitInitial() const {
1202 // Dwarf sections base addresses.
1203 Asm->SwitchSection(DwarfAbbrevSection, 0);
1204 EmitLabel("abbrev", 0);
1205 Asm->SwitchSection(DwarfInfoSection, 0);
1206 EmitLabel("info", 0);
1207 Asm->SwitchSection(DwarfLineSection, 0);
1208 EmitLabel("line", 0);
1210 // Standard sections base addresses.
1211 Asm->SwitchSection(TextSection, 0);
1212 EmitLabel("text_begin", 0);
1213 Asm->SwitchSection(DataSection, 0);
1214 EmitLabel("data_begin", 0);
1217 /// EmitDIE - Recusively Emits a debug information entry.
1219 void DwarfWriter::EmitDIE(DIE *Die) const {
1220 // Get the abbreviation for this DIE.
1221 unsigned AbbrevID = Die->getAbbrevID();
1222 const DIEAbbrev &Abbrev = Abbreviations[AbbrevID];
1224 // Emit the code (index) for the abbreviation.
1225 EmitULEB128Bytes(AbbrevID);
1226 EOL(std::string("Abbrev [" +
1228 TagString(Abbrev.getTag())) +
1231 const std::vector<DIEValue *> &Values = Die->getValues();
1232 const std::vector<DIEAbbrevData> &AbbrevData = Abbrev.getData();
1234 // Emit the DIE attribute values.
1235 for (unsigned i = 0, N = Values.size(); i < N; i++) {
1236 unsigned Attr = AbbrevData[i].getAttribute();
1237 unsigned Form = AbbrevData[i].getForm();
1238 assert(Form && "Too many attributes for DIE (check abbreviation)");
1241 case DW_AT_sibling: {
1242 EmitLong(Die->SiblingOffset());
1246 // Emit an attribute using the defined form.
1247 Values[i]->EmitValue(*this, Form);
1252 EOL(AttributeString(Attr));
1255 // Emit the DIE children if any.
1256 if (Abbrev.getChildrenFlag() == DW_CHILDREN_yes) {
1257 const std::vector<DIE *> &Children = Die->getChildren();
1259 for (unsigned j = 0, M = Children.size(); j < M; j++) {
1260 // FIXME - handle sibling offsets.
1261 // FIXME - handle all DIE types.
1262 EmitDIE(Children[j]);
1265 EmitByte(0); EOL("End Of Children Mark");
1269 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
1271 unsigned DwarfWriter::SizeAndOffsetDie(DIE *Die, unsigned Offset) const {
1272 // Get the abbreviation for this DIE.
1273 unsigned AbbrevID = Die->getAbbrevID();
1274 const DIEAbbrev &Abbrev = Abbreviations[AbbrevID];
1277 Die->setOffset(Offset);
1279 // Start the size with the size of abbreviation code.
1280 Offset += SizeULEB128(AbbrevID);
1282 const std::vector<DIEValue *> &Values = Die->getValues();
1283 const std::vector<DIEAbbrevData> &AbbrevData = Abbrev.getData();
1285 // Emit the DIE attribute values.
1286 for (unsigned i = 0, N = Values.size(); i < N; i++) {
1287 // Size attribute value.
1288 Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
1291 // Emit the DIE children if any.
1292 if (Abbrev.getChildrenFlag() == DW_CHILDREN_yes) {
1293 const std::vector<DIE *> &Children = Die->getChildren();
1295 for (unsigned j = 0, M = Children.size(); j < M; j++) {
1296 // FIXME - handle sibling offsets.
1297 // FIXME - handle all DIE types.
1298 Offset = SizeAndOffsetDie(Children[j], Offset);
1301 // End of children marker.
1302 Offset += sizeof(int8_t);
1305 Die->setSize(Offset - Die->getOffset());
1309 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
1311 void DwarfWriter::SizeAndOffsets() {
1312 // Compute size of debug unit header
1313 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
1314 sizeof(int16_t) + // DWARF version number
1315 sizeof(int32_t) + // Offset Into Abbrev. Section
1316 sizeof(int8_t); // Pointer Size (in bytes)
1318 // Process each compile unit.
1319 for (unsigned i = 0, N = CompileUnits.size(); i < N; i++) {
1320 Offset = SizeAndOffsetDie(CompileUnits[i], Offset);
1324 /// EmitDebugInfo - Emit the debug info section.
1326 void DwarfWriter::EmitDebugInfo() const {
1327 // Start debug info section.
1328 Asm->SwitchSection(DwarfInfoSection, 0);
1330 // Get the number of compile units.
1331 unsigned N = CompileUnits.size();
1333 // If there are any compile units.
1335 EmitLabel("info_begin", 0);
1337 // Emit the compile units header.
1339 // Emit size of content not including length itself
1340 unsigned ContentSize = CompileUnits[N - 1]->SiblingOffset();
1341 EmitLong(ContentSize - sizeof(int32_t));
1342 EOL("Length of Compilation Unit Info");
1344 EmitShort(DWARF_VERSION); EOL("DWARF version number");
1346 EmitReference("abbrev_begin", 0); EOL("Offset Into Abbrev. Section");
1348 EmitByte(AddressSize); EOL("Address Size (in bytes)");
1350 // Process each compile unit.
1351 for (unsigned i = 0; i < N; i++) {
1352 EmitDIE(CompileUnits[i]);
1355 EmitLabel("info_end", 0);
1359 /// EmitAbbreviations - Emit the abbreviation section.
1361 void DwarfWriter::EmitAbbreviations() const {
1362 // Check to see if it is worth the effort.
1363 if (!Abbreviations.empty()) {
1364 // Start the debug abbrev section.
1365 Asm->SwitchSection(DwarfAbbrevSection, 0);
1367 EmitLabel("abbrev_begin", 0);
1369 // For each abbrevation.
1370 for (unsigned AbbrevID = 1, NAID = Abbreviations.size();
1371 AbbrevID <= NAID; AbbrevID++) {
1372 // Get abbreviation data
1373 const DIEAbbrev &Abbrev = Abbreviations[AbbrevID];
1375 // Emit the abbrevations code (base 1 index.)
1376 EmitULEB128Bytes(AbbrevID); EOL("Abbreviation Code");
1378 // Emit the abbreviations data.
1382 EmitLabel("abbrev_end", 0);
1386 /// EmitDebugLines - Emit source line information.
1388 void DwarfWriter::EmitDebugLines() const {
1389 // Minimum line delta, thus ranging from -10..(255-10).
1390 const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
1391 // Maximum line delta, thus ranging from -10..(255-10).
1392 const int MaxLineDelta = 255 + MinLineDelta;
1394 // Start the dwarf line section.
1395 Asm->SwitchSection(DwarfLineSection, 0);
1397 // Construct the section header.
1399 EmitDifference("line_end", 0, "line_begin", 0);
1400 EOL("Length of Source Line Info");
1401 EmitLabel("line_begin", 0);
1403 EmitShort(DWARF_VERSION); EOL("DWARF version number");
1405 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0);
1406 EOL("Prolog Length");
1407 EmitLabel("line_prolog_begin", 0);
1409 EmitByte(1); EOL("Minimum Instruction Length");
1411 EmitByte(1); EOL("Default is_stmt_start flag");
1413 EmitByte(MinLineDelta); EOL("Line Base Value (Special Opcodes)");
1415 EmitByte(MaxLineDelta); EOL("Line Range Value (Special Opcodes)");
1417 EmitByte(-MinLineDelta); EOL("Special Opcode Base");
1419 // Line number standard opcode encodings argument count
1420 EmitByte(0); EOL("DW_LNS_copy arg count");
1421 EmitByte(1); EOL("DW_LNS_advance_pc arg count");
1422 EmitByte(1); EOL("DW_LNS_advance_line arg count");
1423 EmitByte(1); EOL("DW_LNS_set_file arg count");
1424 EmitByte(1); EOL("DW_LNS_set_column arg count");
1425 EmitByte(0); EOL("DW_LNS_negate_stmt arg count");
1426 EmitByte(0); EOL("DW_LNS_set_basic_block arg count");
1427 EmitByte(0); EOL("DW_LNS_const_add_pc arg count");
1428 EmitByte(1); EOL("DW_LNS_fixed_advance_pc arg count");
1430 const UniqueVector<std::string> &Directories = DebugInfo->getDirectories();
1431 const UniqueVector<SourceFileInfo> &SourceFiles = DebugInfo->getSourceFiles();
1433 // Emit directories.
1434 for (unsigned DirectoryID = 1, NDID = Directories.size();
1435 DirectoryID <= NDID; DirectoryID++) {
1436 EmitString(Directories[DirectoryID]); EOL("Directory");
1438 EmitByte(0); EOL("End of directories");
1441 for (unsigned SourceID = 1, NSID = SourceFiles.size();
1442 SourceID <= NSID; SourceID++) {
1443 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
1444 EmitString(SourceFile.getName()); EOL("Source");
1445 EmitULEB128Bytes(SourceFile.getDirectoryID()); EOL("Directory #");
1446 EmitULEB128Bytes(0); EOL("Mod date");
1447 EmitULEB128Bytes(0); EOL("File size");
1449 EmitByte(0); EOL("End of files");
1451 EmitLabel("line_prolog_end", 0);
1453 // Emit line information
1454 const std::vector<SourceLineInfo *> &LineInfos = DebugInfo->getSourceLines();
1456 // Dwarf assumes we start with first line of first source file.
1457 unsigned Source = 1;
1460 // Construct rows of the address, source, line, column matrix.
1461 for (unsigned i = 0, N = LineInfos.size(); i < N; i++) {
1462 SourceLineInfo *LineInfo = LineInfos[i];
1464 // Define the line address.
1465 EmitByte(0); EOL("Extended Op");
1466 EmitByte(4 + 1); EOL("Op size");
1467 EmitByte(DW_LNE_set_address); EOL("DW_LNE_set_address");
1468 EmitReference("loc", i + 1); EOL("Location label");
1470 // If change of source, then switch to the new source.
1471 if (Source != LineInfo->getSourceID()) {
1472 Source = LineInfo->getSourceID();
1473 EmitByte(DW_LNS_set_file); EOL("DW_LNS_set_file");
1474 EmitULEB128Bytes(0); EOL("New Source");
1477 // If change of line.
1478 if (Line != LineInfo->getLine()) {
1479 // Determine offset.
1480 int Offset = LineInfo->getLine() - Line;
1481 int Delta = Offset - MinLineDelta;
1484 Line = LineInfo->getLine();
1486 // If delta is small enough and in range...
1487 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
1488 // ... then use fast opcode.
1489 EmitByte(Delta - MinLineDelta); EOL("Line Delta");
1491 // ... otherwise use long hand.
1492 EmitByte(DW_LNS_advance_line); EOL("DW_LNS_advance_line");
1493 EmitSLEB128Bytes(Offset); EOL("Line Offset");
1494 EmitByte(DW_LNS_copy); EOL("DW_LNS_copy");
1497 // Copy the previous row (different address or source)
1498 EmitByte(DW_LNS_copy); EOL("DW_LNS_copy");
1502 // Mark end of matrix.
1503 EmitByte(0); EOL("DW_LNE_end_sequence");
1504 EmitULEB128Bytes(1); O << "\n";
1505 EmitByte(1); O << "\n";
1507 EmitLabel("line_end", 0);
1510 /// EmitDebugFrame - Emit visible names into a debug frame section.
1512 void DwarfWriter::EmitDebugFrame() {
1513 // FIXME - Should be per frame
1516 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
1518 void DwarfWriter::EmitDebugPubNames() {
1519 // Check to see if it is worth the effort.
1520 if (!GlobalEntities.empty()) {
1521 // Start the dwarf pubnames section.
1522 Asm->SwitchSection(DwarfPubNamesSection, 0);
1524 EmitDifference("pubnames_end", 0, "pubnames_begin", 0);
1525 EOL("Length of Public Names Info");
1527 EmitLabel("pubnames_begin", 0);
1529 EmitShort(DWARF_VERSION); EOL("DWARF Version");
1531 EmitReference("info_begin", 0); EOL("Offset of Compilation Unit Info");
1533 EmitDifference("info_end", 0, "info_begin", 0);
1534 EOL("Compilation Unit Length");
1536 for (std::map<std::string, DIE *>::iterator G = GlobalTypes.begin(),
1537 GE = GlobalTypes.begin();
1539 const std::string &Name = (*G).first;
1540 DIE * Entity = (*G).second;
1542 EmitLong(Entity->getOffset()); EOL("DIE offset");
1543 EmitString(Name); EOL("External Name");
1547 EmitLong(0); EOL("End Mark");
1548 EmitLabel("pubnames_end", 0);
1552 /// EmitDebugPubTypes - Emit visible names into a debug pubtypes section.
1554 void DwarfWriter::EmitDebugPubTypes() {
1555 // Check to see if it is worth the effort.
1556 if (!GlobalTypes.empty()) {
1557 // Start the dwarf pubtypes section.
1558 Asm->SwitchSection(DwarfPubTypesSection, 0);
1562 /// EmitDebugStr - Emit visible names into a debug str section.
1564 void DwarfWriter::EmitDebugStr() {
1565 // Check to see if it is worth the effort.
1566 if (!StringPool.empty()) {
1567 // Start the dwarf str section.
1568 Asm->SwitchSection(DwarfStrSection, 0);
1570 // For each of strings in teh string pool.
1571 for (unsigned StringID = 1, N = StringPool.size();
1572 StringID <= N; StringID++) {
1573 // Emit a label for reference from debug information entries.
1574 EmitLabel("string", StringID);
1575 // Emit the string itself.
1576 const std::string &String = StringPool[StringID];
1577 EmitString(String); O << "\n";
1582 /// EmitDebugLoc - Emit visible names into a debug loc section.
1584 void DwarfWriter::EmitDebugLoc() {
1585 // Start the dwarf loc section.
1586 Asm->SwitchSection(DwarfLocSection, 0);
1589 /// EmitDebugARanges - Emit visible names into a debug aranges section.
1591 void DwarfWriter::EmitDebugARanges() {
1592 // Start the dwarf aranges section.
1593 Asm->SwitchSection(DwarfARangesSection, 0);
1597 // Don't include size of length
1598 EmitLong(0x1c); EOL("Length of Address Ranges Info");
1600 EmitShort(DWARF_VERSION); EOL("Dwarf Version");
1602 EmitReference("info_begin", 0); EOL("Offset of Compilation Unit Info");
1604 EmitByte(AddressSize); EOL("Size of Address");
1606 EmitByte(0); EOL("Size of Segment Descriptor");
1608 EmitShort(0); EOL("Pad (1)");
1609 EmitShort(0); EOL("Pad (2)");
1612 EmitReference("text_begin", 0); EOL("Address");
1613 EmitDifference("text_end", 0, "text_begin", 0); EOL("Length");
1615 EmitLong(0); EOL("EOM (1)");
1616 EmitLong(0); EOL("EOM (2)");
1619 /// EmitDebugRanges - Emit visible names into a debug ranges section.
1621 void DwarfWriter::EmitDebugRanges() {
1622 // Start the dwarf ranges section.
1623 Asm->SwitchSection(DwarfRangesSection, 0);
1626 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
1628 void DwarfWriter::EmitDebugMacInfo() {
1629 // Start the dwarf macinfo section.
1630 Asm->SwitchSection(DwarfMacInfoSection, 0);
1633 /// ShouldEmitDwarf - Determine if Dwarf declarations should be made.
1635 bool DwarfWriter::ShouldEmitDwarf() {
1636 // Check if debug info is present.
1637 if (!DebugInfo || !DebugInfo->hasInfo()) return false;
1639 // Make sure initial declarations are made.
1649 //===----------------------------------------------------------------------===//
1650 // Main entry points.
1653 DwarfWriter::DwarfWriter(std::ostream &o, AsmPrinter *ap)
1663 , AddressSize(sizeof(int32_t))
1668 , DwarfAbbrevSection(".debug_abbrev")
1669 , DwarfInfoSection(".debug_info")
1670 , DwarfLineSection(".debug_line")
1671 , DwarfFrameSection(".debug_frame")
1672 , DwarfPubNamesSection(".debug_pubnames")
1673 , DwarfPubTypesSection(".debug_pubtypes")
1674 , DwarfStrSection(".debug_str")
1675 , DwarfLocSection(".debug_loc")
1676 , DwarfARangesSection(".debug_aranges")
1677 , DwarfRangesSection(".debug_ranges")
1678 , DwarfMacInfoSection(".debug_macinfo")
1679 , TextSection(".text")
1680 , DataSection(".data")
1682 DwarfWriter::~DwarfWriter() {
1683 for (unsigned i = 0, N = CompileUnits.size(); i < N; i++) {
1684 delete CompileUnits[i];
1688 /// BeginModule - Emit all Dwarf sections that should come prior to the content.
1690 void DwarfWriter::BeginModule() {
1691 if (!ShouldEmitDwarf()) return;
1692 EOL("Dwarf Begin Module");
1695 /// EndModule - Emit all Dwarf sections that should come after the content.
1697 void DwarfWriter::EndModule() {
1698 if (!ShouldEmitDwarf()) return;
1699 EOL("Dwarf End Module");
1701 // Standard sections final addresses.
1702 Asm->SwitchSection(TextSection, 0);
1703 EmitLabel("text_end", 0);
1704 Asm->SwitchSection(DataSection, 0);
1705 EmitLabel("data_end", 0);
1707 // Get directory and source information.
1708 const UniqueVector<std::string> &Directories = DebugInfo->getDirectories();
1709 const UniqueVector<SourceFileInfo> &SourceFiles = DebugInfo->getSourceFiles();
1711 // Construct compile unit DIEs for each source.
1712 for (unsigned SourceID = 1, NSID = SourceFiles.size();
1713 SourceID <= NSID; SourceID++) {
1714 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
1715 const std::string &Directory = Directories[SourceFile.getDirectoryID()];
1716 const std::string &SourceName = SourceFile.getName();
1717 DIE *Unit = NewCompileUnit(Directory, SourceName);
1720 // FIXME - just testing.
1721 DWContext *Context = new DWContext(*this, Unit);
1722 DIE *TypeInt = Context->NewBasicType("int", sizeof(int32_t), DW_ATE_signed);
1723 Context->NewVariable("MyGlobal", SourceID, 1, TypeInt, true);
1726 CompileUnits.push_back(Unit);
1729 // Compute DIE offsets and sizes.
1732 // Emit all the DIEs into a debug info section
1735 // Corresponding abbreviations into a abbrev section.
1736 EmitAbbreviations();
1738 // Emit source line correspondence into a debug line section.
1741 // Emit info into a debug frame section.
1744 // Emit info into a debug pubnames section.
1745 EmitDebugPubNames();
1747 // Emit info into a debug pubtypes section.
1748 EmitDebugPubTypes();
1750 // Emit info into a debug str section.
1753 // Emit info into a debug loc section.
1756 // Emit info into a debug aranges section.
1759 // Emit info into a debug ranges section.
1762 // Emit info into a debug macinfo section.
1766 /// BeginFunction - Gather pre-function debug information.
1768 void DwarfWriter::BeginFunction() {
1769 if (!ShouldEmitDwarf()) return;
1770 EOL("Dwarf Begin Function");
1773 /// EndFunction - Gather and emit post-function debug information.
1775 void DwarfWriter::EndFunction() {
1776 if (!ShouldEmitDwarf()) return;
1777 EOL("Dwarf End Function");