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/FoldingSet.h"
17 #include "llvm/ADT/StringExtras.h"
18 #include "llvm/ADT/UniqueVector.h"
19 #include "llvm/Module.h"
20 #include "llvm/Type.h"
21 #include "llvm/CodeGen/AsmPrinter.h"
22 #include "llvm/CodeGen/MachineDebugInfo.h"
23 #include "llvm/CodeGen/MachineFrameInfo.h"
24 #include "llvm/CodeGen/MachineLocation.h"
25 #include "llvm/Support/Dwarf.h"
26 #include "llvm/Support/CommandLine.h"
27 #include "llvm/Support/DataTypes.h"
28 #include "llvm/Support/Mangler.h"
29 #include "llvm/Target/TargetAsmInfo.h"
30 #include "llvm/Target/MRegisterInfo.h"
31 #include "llvm/Target/TargetData.h"
32 #include "llvm/Target/TargetMachine.h"
33 #include "llvm/Target/TargetFrameInfo.h"
39 using namespace llvm::dwarf;
42 DwarfVerbose("dwarf-verbose", cl::Hidden,
43 cl::desc("Add comments to Dwarf directives."));
47 //===----------------------------------------------------------------------===//
49 /// Configuration values for initial hash set sizes (log2).
51 static const unsigned InitDiesSetSize = 9; // 512
52 static const unsigned InitAbbreviationsSetSize = 9; // 512
53 static const unsigned InitValuesSetSize = 9; // 512
55 //===----------------------------------------------------------------------===//
56 /// Forward declarations.
61 //===----------------------------------------------------------------------===//
62 /// LEB 128 number encoding.
64 /// PrintULEB128 - Print a series of hexidecimal values (separated by commas)
65 /// representing an unsigned leb128 value.
66 static void PrintULEB128(std::ostream &O, unsigned Value) {
68 unsigned Byte = Value & 0x7f;
70 if (Value) Byte |= 0x80;
71 O << "0x" << std::hex << Byte << std::dec;
76 /// SizeULEB128 - Compute the number of bytes required for an unsigned leb128
78 static unsigned SizeULEB128(unsigned Value) {
82 Size += sizeof(int8_t);
87 /// PrintSLEB128 - Print a series of hexidecimal values (separated by commas)
88 /// representing a signed leb128 value.
89 static void PrintSLEB128(std::ostream &O, int Value) {
90 int Sign = Value >> (8 * sizeof(Value) - 1);
94 unsigned Byte = Value & 0x7f;
96 IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
97 if (IsMore) Byte |= 0x80;
98 O << "0x" << std::hex << Byte << std::dec;
99 if (IsMore) O << ", ";
103 /// SizeSLEB128 - Compute the number of bytes required for a signed leb128
105 static unsigned SizeSLEB128(int Value) {
107 int Sign = Value >> (8 * sizeof(Value) - 1);
111 unsigned Byte = Value & 0x7f;
113 IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
114 Size += sizeof(int8_t);
119 //===----------------------------------------------------------------------===//
120 /// DWLabel - Labels are used to track locations in the assembler file.
121 /// Labels appear in the form <prefix>debug_<Tag><Number>, where the tag is a
122 /// category of label (Ex. location) and number is a value unique in that
126 /// Tag - Label category tag. Should always be a staticly declared C string.
130 /// Number - Value to make label unique.
134 DWLabel(const char *T, unsigned N) : Tag(T), Number(N) {}
136 void Profile(FoldingSetNodeID &ID) const {
137 ID.AddString(std::string(Tag));
138 ID.AddInteger(Number);
142 void print(std::ostream &O) const {
143 O << ".debug_" << Tag;
144 if (Number) O << Number;
149 //===----------------------------------------------------------------------===//
150 /// DIEAbbrevData - Dwarf abbreviation data, describes the one attribute of a
151 /// Dwarf abbreviation.
152 class DIEAbbrevData {
154 /// Attribute - Dwarf attribute code.
158 /// Form - Dwarf form code.
163 DIEAbbrevData(unsigned A, unsigned F)
169 unsigned getAttribute() const { return Attribute; }
170 unsigned getForm() const { return Form; }
172 /// Profile - Used to gather unique data for the abbreviation folding set.
174 void Profile(FoldingSetNodeID &ID)const {
175 ID.AddInteger(Attribute);
180 //===----------------------------------------------------------------------===//
181 /// DIEAbbrev - Dwarf abbreviation, describes the organization of a debug
182 /// information object.
183 class DIEAbbrev : public FoldingSetNode {
185 /// Tag - Dwarf tag code.
189 /// Unique number for node.
193 /// ChildrenFlag - Dwarf children flag.
195 unsigned ChildrenFlag;
197 /// Data - Raw data bytes for abbreviation.
199 std::vector<DIEAbbrevData> Data;
203 DIEAbbrev(unsigned T, unsigned C)
211 unsigned getTag() const { return Tag; }
212 unsigned getNumber() const { return Number; }
213 unsigned getChildrenFlag() const { return ChildrenFlag; }
214 const std::vector<DIEAbbrevData> &getData() const { return Data; }
215 void setTag(unsigned T) { Tag = T; }
216 void setChildrenFlag(unsigned CF) { ChildrenFlag = CF; }
217 void setNumber(unsigned N) { Number = N; }
219 /// AddAttribute - Adds another set of attribute information to the
221 void AddAttribute(unsigned Attribute, unsigned Form) {
222 Data.push_back(DIEAbbrevData(Attribute, Form));
225 /// AddFirstAttribute - Adds a set of attribute information to the front
226 /// of the abbreviation.
227 void AddFirstAttribute(unsigned Attribute, unsigned Form) {
228 Data.insert(Data.begin(), DIEAbbrevData(Attribute, Form));
231 /// Profile - Used to gather unique data for the abbreviation folding set.
233 void Profile(FoldingSetNodeID &ID) {
235 ID.AddInteger(ChildrenFlag);
237 // For each attribute description.
238 for (unsigned i = 0, N = Data.size(); i < N; ++i)
242 /// Emit - Print the abbreviation using the specified Dwarf writer.
244 void Emit(const Dwarf &DW) const;
247 void print(std::ostream &O);
252 //===----------------------------------------------------------------------===//
253 /// DIE - A structured debug information entry. Has an abbreviation which
254 /// describes it's organization.
255 class DIE : public FoldingSetNode {
257 /// Abbrev - Buffer for constructing abbreviation.
261 /// Offset - Offset in debug info section.
265 /// Size - Size of instance + children.
271 std::vector<DIE *> Children;
273 /// Attributes values.
275 std::vector<DIEValue *> Values;
279 : Abbrev(Tag, DW_CHILDREN_no)
288 DIEAbbrev &getAbbrev() { return Abbrev; }
289 unsigned getAbbrevNumber() const {
290 return Abbrev.getNumber();
292 unsigned getOffset() const { return Offset; }
293 unsigned getSize() const { return Size; }
294 const std::vector<DIE *> &getChildren() const { return Children; }
295 const std::vector<DIEValue *> &getValues() const { return Values; }
296 void setTag(unsigned Tag) { Abbrev.setTag(Tag); }
297 void setOffset(unsigned O) { Offset = O; }
298 void setSize(unsigned S) { Size = S; }
300 /// AddValue - Add a value and attributes to a DIE.
302 void AddValue(unsigned Attribute, unsigned Form, DIEValue *Value) {
303 Abbrev.AddAttribute(Attribute, Form);
304 Values.push_back(Value);
307 /// SiblingOffset - Return the offset of the debug information entry's
309 unsigned SiblingOffset() const { return Offset + Size; }
311 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
313 void AddSiblingOffset();
315 /// AddChild - Add a child to the DIE.
317 void AddChild(DIE *Child) {
318 Abbrev.setChildrenFlag(DW_CHILDREN_yes);
319 Children.push_back(Child);
322 /// Detach - Detaches objects connected to it after copying.
328 /// Profile - Used to gather unique data for the value folding set.
330 void Profile(FoldingSetNodeID &ID) ;
333 void print(std::ostream &O, unsigned IncIndent = 0);
338 //===----------------------------------------------------------------------===//
339 /// DIEValue - A debug information entry value.
341 class DIEValue : public FoldingSetNode {
353 /// Type - Type of data stored in the value.
357 /// Usage - Number of uses of this value.
365 virtual ~DIEValue() {}
367 unsigned getType() const { return Type; }
368 unsigned getUsage() const { return Usage; }
369 void IncUsage() { ++Usage; }
371 // Implement isa/cast/dyncast.
372 static bool classof(const DIEValue *) { return true; }
374 /// EmitValue - Emit value via the Dwarf writer.
376 virtual void EmitValue(const Dwarf &DW, unsigned Form) const = 0;
378 /// SizeOf - Return the size of a value in bytes.
380 virtual unsigned SizeOf(const Dwarf &DW, unsigned Form) const = 0;
382 /// Profile - Used to gather unique data for the value folding set.
384 virtual void Profile(FoldingSetNodeID &ID) = 0;
387 virtual void print(std::ostream &O) = 0;
392 //===----------------------------------------------------------------------===//
393 /// DWInteger - An integer value DIE.
395 class DIEInteger : public DIEValue {
400 DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
402 // Implement isa/cast/dyncast.
403 static bool classof(const DIEInteger *) { return true; }
404 static bool classof(const DIEValue *I) { return I->Type == isInteger; }
406 /// BestForm - Choose the best form for integer.
408 static unsigned BestForm(bool IsSigned, uint64_t Integer) {
410 if ((char)Integer == (signed)Integer) return DW_FORM_data1;
411 if ((short)Integer == (signed)Integer) return DW_FORM_data2;
412 if ((int)Integer == (signed)Integer) return DW_FORM_data4;
414 if ((unsigned char)Integer == Integer) return DW_FORM_data1;
415 if ((unsigned short)Integer == Integer) return DW_FORM_data2;
416 if ((unsigned int)Integer == Integer) return DW_FORM_data4;
418 return DW_FORM_data8;
421 /// EmitValue - Emit integer of appropriate size.
423 virtual void EmitValue(const Dwarf &DW, unsigned Form) const;
425 /// SizeOf - Determine size of integer value in bytes.
427 virtual unsigned SizeOf(const Dwarf &DW, unsigned Form) const {
429 case DW_FORM_flag: // Fall thru
430 case DW_FORM_ref1: // Fall thru
431 case DW_FORM_data1: return sizeof(int8_t);
432 case DW_FORM_ref2: // Fall thru
433 case DW_FORM_data2: return sizeof(int16_t);
434 case DW_FORM_ref4: // Fall thru
435 case DW_FORM_data4: return sizeof(int32_t);
436 case DW_FORM_ref8: // Fall thru
437 case DW_FORM_data8: return sizeof(int64_t);
438 case DW_FORM_udata: return SizeULEB128(Integer);
439 case DW_FORM_sdata: return SizeSLEB128(Integer);
440 default: assert(0 && "DIE Value form not supported yet"); break;
445 /// Profile - Used to gather unique data for the value folding set.
447 virtual void Profile(FoldingSetNodeID &ID) {
448 ID.AddInteger(Integer);
452 virtual void print(std::ostream &O) {
453 O << "Int: " << (int64_t)Integer
454 << " 0x" << std::hex << Integer << std::dec;
459 //===----------------------------------------------------------------------===//
460 /// DIEString - A string value DIE.
462 class DIEString : public DIEValue {
464 const std::string String;
466 DIEString(const std::string &S) : DIEValue(isString), String(S) {}
468 // Implement isa/cast/dyncast.
469 static bool classof(const DIEString *) { return true; }
470 static bool classof(const DIEValue *S) { return S->Type == isString; }
472 /// EmitValue - Emit string value.
474 virtual void EmitValue(const Dwarf &DW, unsigned Form) const;
476 /// SizeOf - Determine size of string value in bytes.
478 virtual unsigned SizeOf(const Dwarf &DW, unsigned Form) const {
479 return String.size() + sizeof(char); // sizeof('\0');
482 /// Profile - Used to gather unique data for the value folding set.
484 virtual void Profile(FoldingSetNodeID &ID) {
485 ID.AddString(String);
489 virtual void print(std::ostream &O) {
490 O << "Str: \"" << String << "\"";
495 //===----------------------------------------------------------------------===//
496 /// DIEDwarfLabel - A Dwarf internal label expression DIE.
498 class DIEDwarfLabel : public DIEValue {
503 DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {}
505 // Implement isa/cast/dyncast.
506 static bool classof(const DIEDwarfLabel *) { return true; }
507 static bool classof(const DIEValue *L) { return L->Type == isLabel; }
509 /// EmitValue - Emit label value.
511 virtual void EmitValue(const Dwarf &DW, unsigned Form) const;
513 /// SizeOf - Determine size of label value in bytes.
515 virtual unsigned SizeOf(const Dwarf &DW, unsigned Form) const;
517 /// Profile - Used to gather unique data for the value folding set.
519 virtual void Profile(FoldingSetNodeID &ID) {
524 virtual void print(std::ostream &O) {
532 //===----------------------------------------------------------------------===//
533 /// DIEObjectLabel - A label to an object in code or data.
535 class DIEObjectLabel : public DIEValue {
537 const std::string Label;
539 DIEObjectLabel(const std::string &L) : DIEValue(isAsIsLabel), Label(L) {}
541 // Implement isa/cast/dyncast.
542 static bool classof(const DIEObjectLabel *) { return true; }
543 static bool classof(const DIEValue *L) { return L->Type == isAsIsLabel; }
545 /// EmitValue - Emit label value.
547 virtual void EmitValue(const Dwarf &DW, unsigned Form) const;
549 /// SizeOf - Determine size of label value in bytes.
551 virtual unsigned SizeOf(const Dwarf &DW, unsigned Form) const;
553 /// Profile - Used to gather unique data for the value folding set.
555 virtual void Profile(FoldingSetNodeID &ID) {
560 virtual void print(std::ostream &O) {
561 O << "Obj: " << Label;
566 //===----------------------------------------------------------------------===//
567 /// DIEDelta - A simple label difference DIE.
569 class DIEDelta : public DIEValue {
571 const DWLabel LabelHi;
572 const DWLabel LabelLo;
574 DIEDelta(const DWLabel &Hi, const DWLabel &Lo)
575 : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
577 // Implement isa/cast/dyncast.
578 static bool classof(const DIEDelta *) { return true; }
579 static bool classof(const DIEValue *D) { return D->Type == isDelta; }
581 /// EmitValue - Emit delta value.
583 virtual void EmitValue(const Dwarf &DW, unsigned Form) const;
585 /// SizeOf - Determine size of delta value in bytes.
587 virtual unsigned SizeOf(const Dwarf &DW, unsigned Form) const;
589 /// Profile - Used to gather unique data for the value folding set.
591 virtual void Profile(FoldingSetNodeID &ID){
597 virtual void print(std::ostream &O) {
606 //===----------------------------------------------------------------------===//
607 /// DIEntry - A pointer to another debug information entry. An instance of this
608 /// class can also be used as a proxy for a debug information entry not yet
609 /// defined (ie. types.)
610 class DIEntry : public DIEValue {
614 DIEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
616 // Implement isa/cast/dyncast.
617 static bool classof(const DIEntry *) { return true; }
618 static bool classof(const DIEValue *E) { return E->Type == isEntry; }
620 /// EmitValue - Emit debug information entry offset.
622 virtual void EmitValue(const Dwarf &DW, unsigned Form) const;
624 /// SizeOf - Determine size of debug information entry in bytes.
626 virtual unsigned SizeOf(const Dwarf &DW, unsigned Form) const {
627 return sizeof(int32_t);
630 /// Profile - Used to gather unique data for the value folding set.
632 virtual void Profile(FoldingSetNodeID &ID) {
634 ID.AddPointer(Entry);
641 virtual void print(std::ostream &O) {
642 O << "Die: 0x" << std::hex << (intptr_t)Entry << std::dec;
647 //===----------------------------------------------------------------------===//
648 /// DIEBlock - A block of values. Primarily used for location expressions.
650 class DIEBlock : public DIEValue, public DIE {
652 unsigned Size; // Size in bytes excluding size header.
662 // Implement isa/cast/dyncast.
663 static bool classof(const DIEBlock *) { return true; }
664 static bool classof(const DIEValue *E) { return E->Type == isBlock; }
666 /// ComputeSize - calculate the size of the block.
668 unsigned ComputeSize(Dwarf &DW);
670 /// BestForm - Choose the best form for data.
672 unsigned BestForm() const {
673 if ((unsigned char)Size == Size) return DW_FORM_block1;
674 if ((unsigned short)Size == Size) return DW_FORM_block2;
675 if ((unsigned int)Size == Size) return DW_FORM_block4;
676 return DW_FORM_block;
679 /// EmitValue - Emit block data.
681 virtual void EmitValue(const Dwarf &DW, unsigned Form) const;
683 /// SizeOf - Determine size of block data in bytes.
685 virtual unsigned SizeOf(const Dwarf &DW, unsigned Form) const;
688 /// Profile - Used to gather unique data for the value folding set.
690 virtual void DIEBlock::Profile(FoldingSetNodeID &ID) {
695 virtual void print(std::ostream &O) {
702 //===----------------------------------------------------------------------===//
703 /// CompileUnit - This dwarf writer support class manages information associate
704 /// with a source file.
707 /// Desc - Compile unit debug descriptor.
709 CompileUnitDesc *Desc;
711 /// ID - File identifier for source.
715 /// Die - Compile unit debug information entry.
719 /// DescToDieMap - Tracks the mapping of unit level debug informaton
720 /// descriptors to debug information entries.
721 std::map<DebugInfoDesc *, DIE *> DescToDieMap;
723 /// DescToDIEntryMap - Tracks the mapping of unit level debug informaton
724 /// descriptors to debug information entries using a DIEntry proxy.
725 std::map<DebugInfoDesc *, DIEntry *> DescToDIEntryMap;
727 /// Globals - A map of globally visible named entities for this unit.
729 std::map<std::string, DIE *> Globals;
731 /// DiesSet - Used to uniquely define dies within the compile unit.
733 FoldingSet<DIE> DiesSet;
735 /// Dies - List of all dies in the compile unit.
737 std::vector<DIE *> Dies;
740 CompileUnit(CompileUnitDesc *CUD, unsigned I, DIE *D)
747 , DiesSet(InitDiesSetSize)
754 for (unsigned i = 0, N = Dies.size(); i < N; ++i)
759 CompileUnitDesc *getDesc() const { return Desc; }
760 unsigned getID() const { return ID; }
761 DIE* getDie() const { return Die; }
762 std::map<std::string, DIE *> &getGlobals() { return Globals; }
764 /// hasContent - Return true if this compile unit has something to write out.
766 bool hasContent() const {
767 return !Die->getChildren().empty();
770 /// AddGlobal - Add a new global entity to the compile unit.
772 void AddGlobal(const std::string &Name, DIE *Die) {
776 /// getDieMapSlotFor - Returns the debug information entry map slot for the
777 /// specified debug descriptor.
778 DIE *&getDieMapSlotFor(DebugInfoDesc *DD) {
779 return DescToDieMap[DD];
782 /// getDIEntrySlotFor - Returns the debug information entry proxy slot for the
783 /// specified debug descriptor.
784 DIEntry *&getDIEntrySlotFor(DebugInfoDesc *DD) {
785 return DescToDIEntryMap[DD];
788 /// AddDie - Adds or interns the DIE to the compile unit.
790 DIE *AddDie(DIE &Buffer) {
794 DIE *Die = DiesSet.FindNodeOrInsertPos(ID, Where);
797 Die = new DIE(Buffer);
798 DiesSet.InsertNode(Die, Where);
799 this->Die->AddChild(Die);
807 //===----------------------------------------------------------------------===//
808 /// Dwarf - Emits Dwarf debug and exception handling directives.
814 //===--------------------------------------------------------------------===//
815 // Core attributes used by the Dwarf writer.
819 /// O - Stream to .s file.
823 /// Asm - Target of Dwarf emission.
827 /// TAI - Target Asm Printer.
828 const TargetAsmInfo *TAI;
830 /// TD - Target data.
831 const TargetData *TD;
833 /// RI - Register Information.
834 const MRegisterInfo *RI;
836 /// M - Current module.
840 /// MF - Current machine function.
844 /// DebugInfo - Collected debug information.
846 MachineDebugInfo *DebugInfo;
848 /// didInitial - Flag to indicate if initial emission has been done.
852 /// shouldEmit - Flag to indicate if debug information should be emitted.
856 /// SubprogramCount - The running count of functions being compiled.
858 unsigned SubprogramCount;
860 //===--------------------------------------------------------------------===//
861 // Attributes used to construct specific Dwarf sections.
864 /// CompileUnits - All the compile units involved in this build. The index
865 /// of each entry in this vector corresponds to the sources in DebugInfo.
866 std::vector<CompileUnit *> CompileUnits;
868 /// AbbreviationsSet - Used to uniquely define abbreviations.
870 FoldingSet<DIEAbbrev> AbbreviationsSet;
872 /// Abbreviations - A list of all the unique abbreviations in use.
874 std::vector<DIEAbbrev *> Abbreviations;
876 /// ValuesSet - Used to uniquely define values.
878 FoldingSet<DIEValue> ValuesSet;
880 /// Values - A list of all the unique values in use.
882 std::vector<DIEValue *> Values;
884 /// StringPool - A UniqueVector of strings used by indirect references.
886 UniqueVector<std::string> StringPool;
888 /// UnitMap - Map debug information descriptor to compile unit.
890 std::map<DebugInfoDesc *, CompileUnit *> DescToUnitMap;
892 /// SectionMap - Provides a unique id per text section.
894 UniqueVector<std::string> SectionMap;
896 /// SectionSourceLines - Tracks line numbers per text section.
898 std::vector<std::vector<SourceLineInfo> > SectionSourceLines;
903 //===--------------------------------------------------------------------===//
904 // Emission and print routines
907 /// PrintHex - Print a value as a hexidecimal value.
909 void PrintHex(int Value) const {
910 O << "0x" << std::hex << Value << std::dec;
913 /// EOL - Print a newline character to asm stream. If a comment is present
914 /// then it will be printed first. Comments should not contain '\n'.
915 void EOL(const std::string &Comment) const {
916 if (DwarfVerbose && !Comment.empty()) {
918 << TAI->getCommentString()
925 /// EmitAlign - Print a align directive.
927 void EmitAlign(unsigned Alignment) const {
928 O << TAI->getAlignDirective() << Alignment << "\n";
931 /// EmitULEB128Bytes - Emit an assembler byte data directive to compose an
932 /// unsigned leb128 value.
933 void EmitULEB128Bytes(unsigned Value) const {
934 if (TAI->hasLEB128()) {
938 O << TAI->getData8bitsDirective();
939 PrintULEB128(O, Value);
943 /// EmitSLEB128Bytes - print an assembler byte data directive to compose a
944 /// signed leb128 value.
945 void EmitSLEB128Bytes(int Value) const {
946 if (TAI->hasLEB128()) {
950 O << TAI->getData8bitsDirective();
951 PrintSLEB128(O, Value);
955 /// EmitInt8 - Emit a byte directive and value.
957 void EmitInt8(int Value) const {
958 O << TAI->getData8bitsDirective();
959 PrintHex(Value & 0xFF);
962 /// EmitInt16 - Emit a short directive and value.
964 void EmitInt16(int Value) const {
965 O << TAI->getData16bitsDirective();
966 PrintHex(Value & 0xFFFF);
969 /// EmitInt32 - Emit a long directive and value.
971 void EmitInt32(int Value) const {
972 O << TAI->getData32bitsDirective();
976 /// EmitInt64 - Emit a long long directive and value.
978 void EmitInt64(uint64_t Value) const {
979 if (TAI->getData64bitsDirective()) {
980 O << TAI->getData64bitsDirective();
983 if (TD->isBigEndian()) {
984 EmitInt32(unsigned(Value >> 32)); O << "\n";
985 EmitInt32(unsigned(Value));
987 EmitInt32(unsigned(Value)); O << "\n";
988 EmitInt32(unsigned(Value >> 32));
993 /// EmitString - Emit a string with quotes and a null terminator.
994 /// Special characters are emitted properly.
995 /// \literal (Eg. '\t') \endliteral
996 void EmitString(const std::string &String) const {
997 O << TAI->getAsciiDirective()
999 for (unsigned i = 0, N = String.size(); i < N; ++i) {
1000 unsigned char C = String[i];
1002 if (!isascii(C) || iscntrl(C)) {
1004 case '\b': O << "\\b"; break;
1005 case '\f': O << "\\f"; break;
1006 case '\n': O << "\\n"; break;
1007 case '\r': O << "\\r"; break;
1008 case '\t': O << "\\t"; break;
1011 O << char('0' + ((C >> 6) & 7));
1012 O << char('0' + ((C >> 3) & 7));
1013 O << char('0' + ((C >> 0) & 7));
1016 } else if (C == '\"') {
1018 } else if (C == '\'') {
1027 /// PrintLabelName - Print label name in form used by Dwarf writer.
1029 void PrintLabelName(DWLabel Label) const {
1030 PrintLabelName(Label.Tag, Label.Number);
1032 void PrintLabelName(const char *Tag, unsigned Number) const {
1033 O << TAI->getPrivateGlobalPrefix()
1036 if (Number) O << Number;
1039 /// EmitLabel - Emit location label for internal use by Dwarf.
1041 void EmitLabel(DWLabel Label) const {
1042 EmitLabel(Label.Tag, Label.Number);
1044 void EmitLabel(const char *Tag, unsigned Number) const {
1045 PrintLabelName(Tag, Number);
1049 /// EmitReference - Emit a reference to a label.
1051 void EmitReference(DWLabel Label) const {
1052 EmitReference(Label.Tag, Label.Number);
1054 void EmitReference(const char *Tag, unsigned Number) const {
1055 if (TAI->getAddressSize() == 4)
1056 O << TAI->getData32bitsDirective();
1058 O << TAI->getData64bitsDirective();
1060 PrintLabelName(Tag, Number);
1062 void EmitReference(const std::string &Name) const {
1063 if (TAI->getAddressSize() == 4)
1064 O << TAI->getData32bitsDirective();
1066 O << TAI->getData64bitsDirective();
1071 /// EmitDifference - Emit the difference between two labels. Some
1072 /// assemblers do not behave with absolute expressions with data directives,
1073 /// so there is an option (needsSet) to use an intermediary set expression.
1074 void EmitDifference(DWLabel LabelHi, DWLabel LabelLo) const {
1075 EmitDifference(LabelHi.Tag, LabelHi.Number, LabelLo.Tag, LabelLo.Number);
1077 void EmitDifference(const char *TagHi, unsigned NumberHi,
1078 const char *TagLo, unsigned NumberLo) const {
1079 if (TAI->needsSet()) {
1080 static unsigned SetCounter = 0;
1083 PrintLabelName("set", SetCounter);
1085 PrintLabelName(TagHi, NumberHi);
1087 PrintLabelName(TagLo, NumberLo);
1090 if (TAI->getAddressSize() == sizeof(int32_t))
1091 O << TAI->getData32bitsDirective();
1093 O << TAI->getData64bitsDirective();
1095 PrintLabelName("set", SetCounter);
1099 if (TAI->getAddressSize() == sizeof(int32_t))
1100 O << TAI->getData32bitsDirective();
1102 O << TAI->getData64bitsDirective();
1104 PrintLabelName(TagHi, NumberHi);
1106 PrintLabelName(TagLo, NumberLo);
1110 /// AssignAbbrevNumber - Define a unique number for the abbreviation.
1112 void AssignAbbrevNumber(DIEAbbrev &Abbrev) {
1113 // Profile the node so that we can make it unique.
1114 FoldingSetNodeID ID;
1117 // Check the set for priors.
1118 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
1120 // If it's newly added.
1121 if (InSet == &Abbrev) {
1122 // Add to abbreviation list.
1123 Abbreviations.push_back(&Abbrev);
1124 // Assign the vector position + 1 as its number.
1125 Abbrev.setNumber(Abbreviations.size());
1127 // Assign existing abbreviation number.
1128 Abbrev.setNumber(InSet->getNumber());
1132 /// NewString - Add a string to the constant pool and returns a label.
1134 DWLabel NewString(const std::string &String) {
1135 unsigned StringID = StringPool.insert(String);
1136 return DWLabel("string", StringID);
1139 /// NewDIEntry - Creates a new DIEntry to be a proxy for a debug information
1141 DIEntry *NewDIEntry(DIE *Entry = NULL) {
1145 FoldingSetNodeID ID;
1146 ID.AddPointer(Entry);
1148 Value = static_cast<DIEntry *>(ValuesSet.FindNodeOrInsertPos(ID, Where));
1155 Value = new DIEntry(Entry);
1156 ValuesSet.InsertNode(Value, Where);
1158 Value = new DIEntry(Entry);
1161 Values.push_back(Value);
1165 /// SetDIEntry - Set a DIEntry once the debug information entry is defined.
1167 void SetDIEntry(DIEntry *Value, DIE *Entry) {
1168 Value->Entry = Entry;
1169 // Add to values set if not already there. If it is, we merely have a
1170 // duplicate in the values list (no harm.)
1171 ValuesSet.GetOrInsertNode(Value);
1174 /// AddUInt - Add an unsigned integer attribute data and value.
1176 void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer) {
1177 if (!Form) Form = DIEInteger::BestForm(false, Integer);
1179 FoldingSetNodeID ID;
1180 ID.AddInteger(Integer);
1182 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1184 Value = new DIEInteger(Integer);
1185 ValuesSet.InsertNode(Value, Where);
1186 Values.push_back(Value);
1191 Die->AddValue(Attribute, Form, Value);
1194 /// AddSInt - Add an signed integer attribute data and value.
1196 void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer) {
1197 if (!Form) Form = DIEInteger::BestForm(true, Integer);
1199 FoldingSetNodeID ID;
1200 ID.AddInteger((uint64_t)Integer);
1202 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1204 Value = new DIEInteger(Integer);
1205 ValuesSet.InsertNode(Value, Where);
1206 Values.push_back(Value);
1211 Die->AddValue(Attribute, Form, Value);
1214 /// AddString - Add a std::string attribute data and value.
1216 void AddString(DIE *Die, unsigned Attribute, unsigned Form,
1217 const std::string &String) {
1218 FoldingSetNodeID ID;
1219 ID.AddString(String);
1221 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1223 Value = new DIEString(String);
1224 ValuesSet.InsertNode(Value, Where);
1225 Values.push_back(Value);
1230 Die->AddValue(Attribute, Form, Value);
1233 /// AddLabel - Add a Dwarf label attribute data and value.
1235 void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
1236 const DWLabel &Label) {
1237 FoldingSetNodeID ID;
1240 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1242 Value = new DIEDwarfLabel(Label);
1243 ValuesSet.InsertNode(Value, Where);
1244 Values.push_back(Value);
1249 Die->AddValue(Attribute, Form, Value);
1252 /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
1254 void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
1255 const std::string &Label) {
1256 FoldingSetNodeID ID;
1257 ID.AddString(Label);
1259 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1261 Value = new DIEObjectLabel(Label);
1262 ValuesSet.InsertNode(Value, Where);
1263 Values.push_back(Value);
1268 Die->AddValue(Attribute, Form, Value);
1271 /// AddDelta - Add a label delta attribute data and value.
1273 void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
1274 const DWLabel &Hi, const DWLabel &Lo) {
1275 FoldingSetNodeID ID;
1279 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1281 Value = new DIEDelta(Hi, Lo);
1282 ValuesSet.InsertNode(Value, Where);
1283 Values.push_back(Value);
1288 Die->AddValue(Attribute, Form, Value);
1291 /// AddDIEntry - Add a DIE attribute data and value.
1293 void AddDIEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
1294 Die->AddValue(Attribute, Form, NewDIEntry(Entry));
1297 /// AddBlock - Add block data.
1299 void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block) {
1300 Block->ComputeSize(*this);
1301 FoldingSetNodeID ID;
1304 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1307 ValuesSet.InsertNode(Value, Where);
1308 Values.push_back(Value);
1314 Die->AddValue(Attribute, Block->BestForm(), Value);
1319 /// AddSourceLine - Add location information to specified debug information
1321 void AddSourceLine(DIE *Die, CompileUnitDesc *File, unsigned Line) {
1323 CompileUnit *FileUnit = FindCompileUnit(File);
1324 unsigned FileID = FileUnit->getID();
1325 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1326 AddUInt(Die, DW_AT_decl_line, 0, Line);
1330 /// AddAddress - Add an address attribute to a die based on the location
1332 void AddAddress(DIE *Die, unsigned Attribute,
1333 const MachineLocation &Location) {
1334 unsigned Reg = RI->getDwarfRegNum(Location.getRegister());
1335 DIEBlock *Block = new DIEBlock();
1337 if (Location.isRegister()) {
1339 AddUInt(Block, 0, DW_FORM_data1, DW_OP_reg0 + Reg);
1341 AddUInt(Block, 0, DW_FORM_data1, DW_OP_regx);
1342 AddUInt(Block, 0, DW_FORM_udata, Reg);
1346 AddUInt(Block, 0, DW_FORM_data1, DW_OP_breg0 + Reg);
1348 AddUInt(Block, 0, DW_FORM_data1, DW_OP_bregx);
1349 AddUInt(Block, 0, DW_FORM_udata, Reg);
1351 AddUInt(Block, 0, DW_FORM_sdata, Location.getOffset());
1354 AddBlock(Die, Attribute, 0, Block);
1357 /// AddBasicType - Add a new basic type attribute to the specified entity.
1359 void AddBasicType(DIE *Entity, CompileUnit *Unit,
1360 const std::string &Name,
1361 unsigned Encoding, unsigned Size) {
1362 DIE *Die = ConstructBasicType(Unit, Name, Encoding, Size);
1363 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, Die);
1366 /// ConstructBasicType - Construct a new basic type.
1368 DIE *ConstructBasicType(CompileUnit *Unit,
1369 const std::string &Name,
1370 unsigned Encoding, unsigned Size) {
1371 DIE Buffer(DW_TAG_base_type);
1372 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1373 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, Encoding);
1374 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1375 return Unit->AddDie(Buffer);
1378 /// AddPointerType - Add a new pointer type attribute to the specified entity.
1380 void AddPointerType(DIE *Entity, CompileUnit *Unit, const std::string &Name) {
1381 DIE *Die = ConstructPointerType(Unit, Name);
1382 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, Die);
1385 /// ConstructPointerType - Construct a new pointer type.
1387 DIE *ConstructPointerType(CompileUnit *Unit, const std::string &Name) {
1388 DIE Buffer(DW_TAG_pointer_type);
1389 AddUInt(&Buffer, DW_AT_byte_size, 0, TAI->getAddressSize());
1390 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1391 return Unit->AddDie(Buffer);
1394 /// AddType - Add a new type attribute to the specified entity.
1396 void AddType(DIE *Entity, TypeDesc *TyDesc, CompileUnit *Unit) {
1398 AddBasicType(Entity, Unit, "", DW_ATE_signed, 4);
1400 // Check for pre-existence.
1401 DIEntry *&Slot = Unit->getDIEntrySlotFor(TyDesc);
1403 // If it exists then use the existing value.
1406 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1410 if (SubprogramDesc *SubprogramTy = dyn_cast<SubprogramDesc>(TyDesc)) {
1411 // FIXME - Not sure why programs and variables are coming through here.
1412 // Short cut for handling subprogram types (not really a TyDesc.)
1413 AddPointerType(Entity, Unit, SubprogramTy->getName());
1414 } else if (GlobalVariableDesc *GlobalTy =
1415 dyn_cast<GlobalVariableDesc>(TyDesc)) {
1416 // FIXME - Not sure why programs and variables are coming through here.
1417 // Short cut for handling global variable types (not really a TyDesc.)
1418 AddPointerType(Entity, Unit, GlobalTy->getName());
1421 Slot = NewDIEntry();
1424 DIE Buffer(DW_TAG_base_type);
1425 ConstructType(Buffer, TyDesc, Unit);
1427 // Add debug information entry to entity and unit.
1428 DIE *Die = Unit->AddDie(Buffer);
1429 SetDIEntry(Slot, Die);
1430 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1435 /// ConstructType - Adds all the required attributes to the type.
1437 void ConstructType(DIE &Buffer, TypeDesc *TyDesc, CompileUnit *Unit) {
1438 // Get core information.
1439 const std::string &Name = TyDesc->getName();
1440 uint64_t Size = TyDesc->getSize() >> 3;
1442 if (BasicTypeDesc *BasicTy = dyn_cast<BasicTypeDesc>(TyDesc)) {
1443 // Fundamental types like int, float, bool
1444 Buffer.setTag(DW_TAG_base_type);
1445 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, BasicTy->getEncoding());
1446 } else if (DerivedTypeDesc *DerivedTy = dyn_cast<DerivedTypeDesc>(TyDesc)) {
1447 // Pointers, tyepdefs et al.
1448 Buffer.setTag(DerivedTy->getTag());
1449 // Map to main type, void will not have a type.
1450 if (TypeDesc *FromTy = DerivedTy->getFromType())
1451 AddType(&Buffer, FromTy, Unit);
1452 } else if (CompositeTypeDesc *CompTy = dyn_cast<CompositeTypeDesc>(TyDesc)){
1454 unsigned Tag = CompTy->getTag();
1456 // Set tag accordingly.
1457 if (Tag == DW_TAG_vector_type)
1458 Buffer.setTag(DW_TAG_array_type);
1462 std::vector<DebugInfoDesc *> &Elements = CompTy->getElements();
1465 case DW_TAG_vector_type:
1466 AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1468 case DW_TAG_array_type: {
1469 // Add element type.
1470 if (TypeDesc *FromTy = CompTy->getFromType())
1471 AddType(&Buffer, FromTy, Unit);
1473 // Don't emit size attribute.
1476 // Construct an anonymous type for index type.
1477 DIE *IndexTy = ConstructBasicType(Unit, "", DW_ATE_signed, 4);
1479 // Add subranges to array type.
1480 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1481 SubrangeDesc *SRD = cast<SubrangeDesc>(Elements[i]);
1482 int64_t Lo = SRD->getLo();
1483 int64_t Hi = SRD->getHi();
1484 DIE *Subrange = new DIE(DW_TAG_subrange_type);
1486 // If a range is available.
1488 AddDIEntry(Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1489 // Only add low if non-zero.
1490 if (Lo) AddSInt(Subrange, DW_AT_lower_bound, 0, Lo);
1491 AddSInt(Subrange, DW_AT_upper_bound, 0, Hi);
1494 Buffer.AddChild(Subrange);
1498 case DW_TAG_structure_type:
1499 case DW_TAG_union_type: {
1500 // Add elements to structure type.
1501 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1502 DebugInfoDesc *Element = Elements[i];
1504 if (DerivedTypeDesc *MemberDesc = dyn_cast<DerivedTypeDesc>(Element)){
1505 // Add field or base class.
1507 unsigned Tag = MemberDesc->getTag();
1509 // Extract the basic information.
1510 const std::string &Name = MemberDesc->getName();
1511 uint64_t Size = MemberDesc->getSize();
1512 uint64_t Align = MemberDesc->getAlign();
1513 uint64_t Offset = MemberDesc->getOffset();
1515 // Construct member debug information entry.
1516 DIE *Member = new DIE(Tag);
1518 // Add name if not "".
1520 AddString(Member, DW_AT_name, DW_FORM_string, Name);
1521 // Add location if available.
1522 AddSourceLine(Member, MemberDesc->getFile(), MemberDesc->getLine());
1524 // Most of the time the field info is the same as the members.
1525 uint64_t FieldSize = Size;
1526 uint64_t FieldAlign = Align;
1527 uint64_t FieldOffset = Offset;
1529 if (TypeDesc *FromTy = MemberDesc->getFromType()) {
1530 AddType(Member, FromTy, Unit);
1531 FieldSize = FromTy->getSize();
1532 FieldAlign = FromTy->getSize();
1535 // Unless we have a bit field.
1536 if (Tag == DW_TAG_member && FieldSize != Size) {
1537 // Construct the alignment mask.
1538 uint64_t AlignMask = ~(FieldAlign - 1);
1539 // Determine the high bit + 1 of the declared size.
1540 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1541 // Work backwards to determine the base offset of the field.
1542 FieldOffset = HiMark - FieldSize;
1543 // Now normalize offset to the field.
1544 Offset -= FieldOffset;
1546 // Maybe we need to work from the other end.
1547 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
1549 // Add size and offset.
1550 AddUInt(Member, DW_AT_byte_size, 0, FieldSize >> 3);
1551 AddUInt(Member, DW_AT_bit_size, 0, Size);
1552 AddUInt(Member, DW_AT_bit_offset, 0, Offset);
1555 // Add computation for offset.
1556 DIEBlock *Block = new DIEBlock();
1557 AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
1558 AddUInt(Block, 0, DW_FORM_udata, FieldOffset >> 3);
1559 AddBlock(Member, DW_AT_data_member_location, 0, Block);
1561 // Add accessibility (public default unless is base class.
1562 if (MemberDesc->isProtected()) {
1563 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_protected);
1564 } else if (MemberDesc->isPrivate()) {
1565 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_private);
1566 } else if (Tag == DW_TAG_inheritance) {
1567 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_public);
1570 Buffer.AddChild(Member);
1571 } else if (GlobalVariableDesc *StaticDesc =
1572 dyn_cast<GlobalVariableDesc>(Element)) {
1573 // Add static member.
1575 // Construct member debug information entry.
1576 DIE *Static = new DIE(DW_TAG_variable);
1578 // Add name and mangled name.
1579 const std::string &Name = StaticDesc->getDisplayName();
1580 const std::string &MangledName = StaticDesc->getName();
1581 AddString(Static, DW_AT_name, DW_FORM_string, Name);
1582 AddString(Static, DW_AT_MIPS_linkage_name, DW_FORM_string,
1586 AddSourceLine(Static, StaticDesc->getFile(), StaticDesc->getLine());
1589 if (TypeDesc *StaticTy = StaticDesc->getType())
1590 AddType(Static, StaticTy, Unit);
1593 AddUInt(Static, DW_AT_external, DW_FORM_flag, 1);
1594 AddUInt(Static, DW_AT_declaration, DW_FORM_flag, 1);
1596 Buffer.AddChild(Static);
1597 } else if (SubprogramDesc *MethodDesc =
1598 dyn_cast<SubprogramDesc>(Element)) {
1599 // Add member function.
1601 // Construct member debug information entry.
1602 DIE *Method = new DIE(DW_TAG_subprogram);
1604 // Add name and mangled name.
1605 const std::string &Name = MethodDesc->getDisplayName();
1606 const std::string &MangledName = MethodDesc->getName();
1607 bool IsCTor = false;
1610 AddString(Method, DW_AT_name, DW_FORM_string, MangledName);
1611 IsCTor = TyDesc->getName() == MangledName;
1613 AddString(Method, DW_AT_name, DW_FORM_string, Name);
1614 AddString(Method, DW_AT_MIPS_linkage_name, DW_FORM_string,
1619 AddSourceLine(Method, MethodDesc->getFile(), MethodDesc->getLine());
1622 if (CompositeTypeDesc *MethodTy =
1623 dyn_cast_or_null<CompositeTypeDesc>(MethodDesc->getType())) {
1624 // Get argument information.
1625 std::vector<DebugInfoDesc *> &Args = MethodTy->getElements();
1630 AddType(Method, dyn_cast<TypeDesc>(Args[0]), Unit);
1634 for(unsigned i = 1, N = Args.size(); i < N; ++i) {
1635 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1636 AddType(Arg, cast<TypeDesc>(Args[i]), Unit);
1637 AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1);
1638 Method->AddChild(Arg);
1643 AddUInt(Method, DW_AT_external, DW_FORM_flag, 1);
1644 AddUInt(Method, DW_AT_declaration, DW_FORM_flag, 1);
1646 Buffer.AddChild(Method);
1651 case DW_TAG_enumeration_type: {
1652 // Add enumerators to enumeration type.
1653 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1654 EnumeratorDesc *ED = cast<EnumeratorDesc>(Elements[i]);
1655 const std::string &Name = ED->getName();
1656 int64_t Value = ED->getValue();
1657 DIE *Enumerator = new DIE(DW_TAG_enumerator);
1658 AddString(Enumerator, DW_AT_name, DW_FORM_string, Name);
1659 AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
1660 Buffer.AddChild(Enumerator);
1665 case DW_TAG_subroutine_type: {
1666 // Add prototype flag.
1667 AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
1669 AddType(&Buffer, dyn_cast<TypeDesc>(Elements[0]), Unit);
1672 for(unsigned i = 1, N = Elements.size(); i < N; ++i) {
1673 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1674 AddType(Arg, cast<TypeDesc>(Elements[i]), Unit);
1675 Buffer.AddChild(Arg);
1684 // Add size if non-zero (derived types don't have a size.)
1685 if (Size) AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1686 // Add name if not anonymous or intermediate type.
1687 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1688 // Add source line info if available.
1689 AddSourceLine(&Buffer, TyDesc->getFile(), TyDesc->getLine());
1692 /// NewCompileUnit - Create new compile unit and it's debug information entry.
1694 CompileUnit *NewCompileUnit(CompileUnitDesc *UnitDesc, unsigned ID) {
1695 // Construct debug information entry.
1696 DIE *Die = new DIE(DW_TAG_compile_unit);
1697 AddDelta(Die, DW_AT_stmt_list, DW_FORM_data4, DWLabel("section_line", 0),
1698 DWLabel("section_line", 0));
1699 AddString(Die, DW_AT_producer, DW_FORM_string, UnitDesc->getProducer());
1700 AddUInt (Die, DW_AT_language, DW_FORM_data1, UnitDesc->getLanguage());
1701 AddString(Die, DW_AT_name, DW_FORM_string, UnitDesc->getFileName());
1702 AddString(Die, DW_AT_comp_dir, DW_FORM_string, UnitDesc->getDirectory());
1704 // Construct compile unit.
1705 CompileUnit *Unit = new CompileUnit(UnitDesc, ID, Die);
1707 // Add Unit to compile unit map.
1708 DescToUnitMap[UnitDesc] = Unit;
1713 /// FindCompileUnit - Get the compile unit for the given descriptor.
1715 CompileUnit *FindCompileUnit(CompileUnitDesc *UnitDesc) {
1717 // FIXME - Using only one compile unit. Needs to me fixed at the FE.
1718 CompileUnit *Unit = CompileUnits[0];
1720 CompileUnit *Unit = DescToUnitMap[UnitDesc];
1722 assert(Unit && "Missing compile unit.");
1726 /// NewGlobalVariable - Add a new global variable DIE.
1728 DIE *NewGlobalVariable(GlobalVariableDesc *GVD) {
1729 // Get the compile unit context.
1730 CompileUnitDesc *UnitDesc =
1731 static_cast<CompileUnitDesc *>(GVD->getContext());
1732 CompileUnit *Unit = FindCompileUnit(UnitDesc);
1734 // Check for pre-existence.
1735 DIE *&Slot = Unit->getDieMapSlotFor(GVD);
1736 if (Slot) return Slot;
1738 // Get the global variable itself.
1739 GlobalVariable *GV = GVD->getGlobalVariable();
1741 const std::string &Name = GVD->hasMangledName() ? GVD->getDisplayName()
1743 const std::string &MangledName = GVD->hasMangledName() ? GVD->getName()
1745 // Create the global's variable DIE.
1746 DIE *VariableDie = new DIE(DW_TAG_variable);
1747 AddString(VariableDie, DW_AT_name, DW_FORM_string, Name);
1748 if (!MangledName.empty()) {
1749 AddString(VariableDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
1752 AddType(VariableDie, GVD->getType(), Unit);
1753 AddUInt(VariableDie, DW_AT_external, DW_FORM_flag, 1);
1755 // Add source line info if available.
1756 AddSourceLine(VariableDie, UnitDesc, GVD->getLine());
1758 // Work up linkage name.
1759 const std::string LinkageName = Asm->getGlobalLinkName(GV);
1762 DIEBlock *Block = new DIEBlock();
1763 AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
1764 AddObjectLabel(Block, 0, DW_FORM_udata, LinkageName);
1765 AddBlock(VariableDie, DW_AT_location, 0, Block);
1770 // Add to context owner.
1771 Unit->getDie()->AddChild(VariableDie);
1773 // Expose as global.
1774 // FIXME - need to check external flag.
1775 Unit->AddGlobal(Name, VariableDie);
1780 /// NewSubprogram - Add a new subprogram DIE.
1782 DIE *NewSubprogram(SubprogramDesc *SPD) {
1783 // Get the compile unit context.
1784 CompileUnitDesc *UnitDesc =
1785 static_cast<CompileUnitDesc *>(SPD->getContext());
1786 CompileUnit *Unit = FindCompileUnit(UnitDesc);
1788 // Check for pre-existence.
1789 DIE *&Slot = Unit->getDieMapSlotFor(SPD);
1790 if (Slot) return Slot;
1792 // Gather the details (simplify add attribute code.)
1793 const std::string &Name = SPD->hasMangledName() ? SPD->getDisplayName()
1795 const std::string &MangledName = SPD->hasMangledName() ? SPD->getName()
1797 unsigned IsExternal = SPD->isStatic() ? 0 : 1;
1799 DIE *SubprogramDie = new DIE(DW_TAG_subprogram);
1800 AddString(SubprogramDie, DW_AT_name, DW_FORM_string, Name);
1801 if (!MangledName.empty()) {
1802 AddString(SubprogramDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
1805 if (SPD->getType()) AddType(SubprogramDie, SPD->getType(), Unit);
1806 AddUInt(SubprogramDie, DW_AT_external, DW_FORM_flag, IsExternal);
1807 AddUInt(SubprogramDie, DW_AT_prototyped, DW_FORM_flag, 1);
1809 // Add source line info if available.
1810 AddSourceLine(SubprogramDie, UnitDesc, SPD->getLine());
1813 Slot = SubprogramDie;
1815 // Add to context owner.
1816 Unit->getDie()->AddChild(SubprogramDie);
1818 // Expose as global.
1819 Unit->AddGlobal(Name, SubprogramDie);
1821 return SubprogramDie;
1824 /// NewScopeVariable - Create a new scope variable.
1826 DIE *NewScopeVariable(DebugVariable *DV, CompileUnit *Unit) {
1827 // Get the descriptor.
1828 VariableDesc *VD = DV->getDesc();
1830 // Translate tag to proper Dwarf tag. The result variable is dropped for
1833 switch (VD->getTag()) {
1834 case DW_TAG_return_variable: return NULL;
1835 case DW_TAG_arg_variable: Tag = DW_TAG_formal_parameter; break;
1836 case DW_TAG_auto_variable: // fall thru
1837 default: Tag = DW_TAG_variable; break;
1840 // Define variable debug information entry.
1841 DIE *VariableDie = new DIE(Tag);
1842 AddString(VariableDie, DW_AT_name, DW_FORM_string, VD->getName());
1844 // Add source line info if available.
1845 AddSourceLine(VariableDie, VD->getFile(), VD->getLine());
1847 // Add variable type.
1848 AddType(VariableDie, VD->getType(), Unit);
1850 // Add variable address.
1851 MachineLocation Location;
1852 RI->getLocation(*MF, DV->getFrameIndex(), Location);
1853 AddAddress(VariableDie, DW_AT_location, Location);
1858 /// ConstructScope - Construct the components of a scope.
1860 void ConstructScope(DebugScope *ParentScope,
1861 DIE *ParentDie, CompileUnit *Unit) {
1862 // Add variables to scope.
1863 std::vector<DebugVariable *> &Variables = ParentScope->getVariables();
1864 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
1865 DIE *VariableDie = NewScopeVariable(Variables[i], Unit);
1866 if (VariableDie) ParentDie->AddChild(VariableDie);
1869 // Add nested scopes.
1870 std::vector<DebugScope *> &Scopes = ParentScope->getScopes();
1871 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1872 // Define the Scope debug information entry.
1873 DebugScope *Scope = Scopes[j];
1874 // FIXME - Ignore inlined functions for the time being.
1875 if (!Scope->getParent()) continue;
1877 unsigned StartID = Scope->getStartLabelID();
1878 unsigned EndID = Scope->getEndLabelID();
1880 // Throw out scope if block is discarded.
1881 if (StartID && !DebugInfo->isLabelValid(StartID)) continue;
1882 if (EndID && !DebugInfo->isLabelValid(EndID)) continue;
1884 DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
1886 // Add the scope bounds.
1888 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
1889 DWLabel("loc", StartID));
1891 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
1892 DWLabel("func_begin", SubprogramCount));
1895 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
1896 DWLabel("loc", EndID));
1898 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
1899 DWLabel("func_end", SubprogramCount));
1902 // Add the scope contents.
1903 ConstructScope(Scope, ScopeDie, Unit);
1904 ParentDie->AddChild(ScopeDie);
1908 /// ConstructRootScope - Construct the scope for the subprogram.
1910 void ConstructRootScope(DebugScope *RootScope) {
1911 // Exit if there is no root scope.
1912 if (!RootScope) return;
1914 // Get the subprogram debug information entry.
1915 SubprogramDesc *SPD = cast<SubprogramDesc>(RootScope->getDesc());
1917 // Get the compile unit context.
1918 CompileUnitDesc *UnitDesc =
1919 static_cast<CompileUnitDesc *>(SPD->getContext());
1920 CompileUnit *Unit = FindCompileUnit(UnitDesc);
1922 // Get the subprogram die.
1923 DIE *SPDie = Unit->getDieMapSlotFor(SPD);
1924 assert(SPDie && "Missing subprogram descriptor");
1926 // Add the function bounds.
1927 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
1928 DWLabel("func_begin", SubprogramCount));
1929 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
1930 DWLabel("func_end", SubprogramCount));
1931 MachineLocation Location(RI->getFrameRegister(*MF));
1932 AddAddress(SPDie, DW_AT_frame_base, Location);
1934 ConstructScope(RootScope, SPDie, Unit);
1937 /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
1938 /// tools to recognize the object file contains Dwarf information.
1939 void EmitInitial() {
1940 // Check to see if we already emitted intial headers.
1941 if (didInitial) return;
1944 // Dwarf sections base addresses.
1945 if (TAI->getDwarfRequiresFrameSection()) {
1946 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
1947 EmitLabel("section_frame", 0);
1949 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
1950 EmitLabel("section_info", 0);
1951 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
1952 EmitLabel("section_abbrev", 0);
1953 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
1954 EmitLabel("section_aranges", 0);
1955 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
1956 EmitLabel("section_macinfo", 0);
1957 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
1958 EmitLabel("section_line", 0);
1959 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
1960 EmitLabel("section_loc", 0);
1961 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
1962 EmitLabel("section_pubnames", 0);
1963 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
1964 EmitLabel("section_str", 0);
1965 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
1966 EmitLabel("section_ranges", 0);
1968 Asm->SwitchToTextSection(TAI->getTextSection());
1969 EmitLabel("text_begin", 0);
1970 Asm->SwitchToDataSection(TAI->getDataSection());
1971 EmitLabel("data_begin", 0);
1973 // Emit common frame information.
1974 EmitInitialDebugFrame();
1977 /// EmitDIE - Recusively Emits a debug information entry.
1979 void EmitDIE(DIE *Die) const {
1980 // Get the abbreviation for this DIE.
1981 unsigned AbbrevNumber = Die->getAbbrevNumber();
1982 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1986 // Emit the code (index) for the abbreviation.
1987 EmitULEB128Bytes(AbbrevNumber);
1988 EOL(std::string("Abbrev [" +
1989 utostr(AbbrevNumber) +
1990 "] 0x" + utohexstr(Die->getOffset()) +
1991 ":0x" + utohexstr(Die->getSize()) + " " +
1992 TagString(Abbrev->getTag())));
1994 const std::vector<DIEValue *> &Values = Die->getValues();
1995 const std::vector<DIEAbbrevData> &AbbrevData = Abbrev->getData();
1997 // Emit the DIE attribute values.
1998 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1999 unsigned Attr = AbbrevData[i].getAttribute();
2000 unsigned Form = AbbrevData[i].getForm();
2001 assert(Form && "Too many attributes for DIE (check abbreviation)");
2004 case DW_AT_sibling: {
2005 EmitInt32(Die->SiblingOffset());
2009 // Emit an attribute using the defined form.
2010 Values[i]->EmitValue(*this, Form);
2015 EOL(AttributeString(Attr));
2018 // Emit the DIE children if any.
2019 if (Abbrev->getChildrenFlag() == DW_CHILDREN_yes) {
2020 const std::vector<DIE *> &Children = Die->getChildren();
2022 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2023 EmitDIE(Children[j]);
2026 EmitInt8(0); EOL("End Of Children Mark");
2030 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
2032 unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
2033 // Get the children.
2034 const std::vector<DIE *> &Children = Die->getChildren();
2036 // If not last sibling and has children then add sibling offset attribute.
2037 if (!Last && !Children.empty()) Die->AddSiblingOffset();
2039 // Record the abbreviation.
2040 AssignAbbrevNumber(Die->getAbbrev());
2042 // Get the abbreviation for this DIE.
2043 unsigned AbbrevNumber = Die->getAbbrevNumber();
2044 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2047 Die->setOffset(Offset);
2049 // Start the size with the size of abbreviation code.
2050 Offset += SizeULEB128(AbbrevNumber);
2052 const std::vector<DIEValue *> &Values = Die->getValues();
2053 const std::vector<DIEAbbrevData> &AbbrevData = Abbrev->getData();
2055 // Size the DIE attribute values.
2056 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2057 // Size attribute value.
2058 Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
2061 // Size the DIE children if any.
2062 if (!Children.empty()) {
2063 assert(Abbrev->getChildrenFlag() == DW_CHILDREN_yes &&
2064 "Children flag not set");
2066 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2067 Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
2070 // End of children marker.
2071 Offset += sizeof(int8_t);
2074 Die->setSize(Offset - Die->getOffset());
2078 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
2080 void SizeAndOffsets() {
2081 // Process each compile unit.
2082 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) {
2083 CompileUnit *Unit = CompileUnits[i];
2084 if (Unit->hasContent()) {
2085 // Compute size of compile unit header
2086 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2087 sizeof(int16_t) + // DWARF version number
2088 sizeof(int32_t) + // Offset Into Abbrev. Section
2089 sizeof(int8_t); // Pointer Size (in bytes)
2090 SizeAndOffsetDie(Unit->getDie(), Offset, (i + 1) == N);
2095 /// EmitFrameMoves - Emit frame instructions to describe the layout of the
2097 void EmitFrameMoves(const char *BaseLabel, unsigned BaseLabelID,
2098 std::vector<MachineMove *> &Moves) {
2099 for (unsigned i = 0, N = Moves.size(); i < N; ++i) {
2100 MachineMove *Move = Moves[i];
2101 unsigned LabelID = Move->getLabelID();
2103 // Throw out move if the label is invalid.
2104 if (LabelID && !DebugInfo->isLabelValid(LabelID)) continue;
2106 const MachineLocation &Dst = Move->getDestination();
2107 const MachineLocation &Src = Move->getSource();
2109 // Advance row if new location.
2110 if (BaseLabel && LabelID && BaseLabelID != LabelID) {
2111 EmitInt8(DW_CFA_advance_loc4);
2112 EOL("DW_CFA_advance_loc4");
2113 EmitDifference("loc", LabelID, BaseLabel, BaseLabelID);
2116 BaseLabelID = LabelID;
2121 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2122 TargetFrameInfo::StackGrowsUp ?
2123 TAI->getAddressSize() : -TAI->getAddressSize();
2125 // If advancing cfa.
2126 if (Dst.isRegister() && Dst.getRegister() == MachineLocation::VirtualFP) {
2127 if (!Src.isRegister()) {
2128 if (Src.getRegister() == MachineLocation::VirtualFP) {
2129 EmitInt8(DW_CFA_def_cfa_offset);
2130 EOL("DW_CFA_def_cfa_offset");
2132 EmitInt8(DW_CFA_def_cfa);
2133 EOL("DW_CFA_def_cfa");
2134 EmitULEB128Bytes(RI->getDwarfRegNum(Src.getRegister()));
2138 int Offset = Src.getOffset() / stackGrowth;
2140 EmitULEB128Bytes(Offset);
2143 assert(0 && "Machine move no supported yet.");
2146 unsigned Reg = RI->getDwarfRegNum(Src.getRegister());
2147 int Offset = Dst.getOffset() / stackGrowth;
2150 EmitInt8(DW_CFA_offset_extended_sf);
2151 EOL("DW_CFA_offset_extended_sf");
2152 EmitULEB128Bytes(Reg);
2154 EmitSLEB128Bytes(Offset);
2156 } else if (Reg < 64) {
2157 EmitInt8(DW_CFA_offset + Reg);
2158 EOL("DW_CFA_offset + Reg");
2159 EmitULEB128Bytes(Offset);
2162 EmitInt8(DW_CFA_offset_extended);
2163 EOL("DW_CFA_offset_extended");
2164 EmitULEB128Bytes(Reg);
2166 EmitULEB128Bytes(Offset);
2173 /// EmitDebugInfo - Emit the debug info section.
2175 void EmitDebugInfo() const {
2176 // Start debug info section.
2177 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2179 // Process each compile unit.
2180 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) {
2181 CompileUnit *Unit = CompileUnits[i];
2183 if (Unit->hasContent()) {
2184 DIE *Die = Unit->getDie();
2185 // Emit the compile units header.
2186 EmitLabel("info_begin", Unit->getID());
2187 // Emit size of content not including length itself
2188 unsigned ContentSize = Die->getSize() +
2189 sizeof(int16_t) + // DWARF version number
2190 sizeof(int32_t) + // Offset Into Abbrev. Section
2191 sizeof(int8_t); // Pointer Size (in bytes)
2193 EmitInt32(ContentSize); EOL("Length of Compilation Unit Info");
2194 EmitInt16(DWARF_VERSION); EOL("DWARF version number");
2195 EmitDifference("abbrev_begin", 0, "section_abbrev", 0);
2196 EOL("Offset Into Abbrev. Section");
2197 EmitInt8(TAI->getAddressSize()); EOL("Address Size (in bytes)");
2200 EmitLabel("info_end", Unit->getID());
2207 /// EmitAbbreviations - Emit the abbreviation section.
2209 void EmitAbbreviations() const {
2210 // Check to see if it is worth the effort.
2211 if (!Abbreviations.empty()) {
2212 // Start the debug abbrev section.
2213 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2215 EmitLabel("abbrev_begin", 0);
2217 // For each abbrevation.
2218 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2219 // Get abbreviation data
2220 const DIEAbbrev *Abbrev = Abbreviations[i];
2222 // Emit the abbrevations code (base 1 index.)
2223 EmitULEB128Bytes(Abbrev->getNumber()); EOL("Abbreviation Code");
2225 // Emit the abbreviations data.
2226 Abbrev->Emit(*this);
2231 EmitLabel("abbrev_end", 0);
2237 /// EmitDebugLines - Emit source line information.
2239 void EmitDebugLines() const {
2240 // Minimum line delta, thus ranging from -10..(255-10).
2241 const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
2242 // Maximum line delta, thus ranging from -10..(255-10).
2243 const int MaxLineDelta = 255 + MinLineDelta;
2245 // Start the dwarf line section.
2246 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2248 // Construct the section header.
2250 EmitDifference("line_end", 0, "line_begin", 0);
2251 EOL("Length of Source Line Info");
2252 EmitLabel("line_begin", 0);
2254 EmitInt16(DWARF_VERSION); EOL("DWARF version number");
2256 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0);
2257 EOL("Prolog Length");
2258 EmitLabel("line_prolog_begin", 0);
2260 EmitInt8(1); EOL("Minimum Instruction Length");
2262 EmitInt8(1); EOL("Default is_stmt_start flag");
2264 EmitInt8(MinLineDelta); EOL("Line Base Value (Special Opcodes)");
2266 EmitInt8(MaxLineDelta); EOL("Line Range Value (Special Opcodes)");
2268 EmitInt8(-MinLineDelta); EOL("Special Opcode Base");
2270 // Line number standard opcode encodings argument count
2271 EmitInt8(0); EOL("DW_LNS_copy arg count");
2272 EmitInt8(1); EOL("DW_LNS_advance_pc arg count");
2273 EmitInt8(1); EOL("DW_LNS_advance_line arg count");
2274 EmitInt8(1); EOL("DW_LNS_set_file arg count");
2275 EmitInt8(1); EOL("DW_LNS_set_column arg count");
2276 EmitInt8(0); EOL("DW_LNS_negate_stmt arg count");
2277 EmitInt8(0); EOL("DW_LNS_set_basic_block arg count");
2278 EmitInt8(0); EOL("DW_LNS_const_add_pc arg count");
2279 EmitInt8(1); EOL("DW_LNS_fixed_advance_pc arg count");
2281 const UniqueVector<std::string> &Directories = DebugInfo->getDirectories();
2282 const UniqueVector<SourceFileInfo>
2283 &SourceFiles = DebugInfo->getSourceFiles();
2285 // Emit directories.
2286 for (unsigned DirectoryID = 1, NDID = Directories.size();
2287 DirectoryID <= NDID; ++DirectoryID) {
2288 EmitString(Directories[DirectoryID]); EOL("Directory");
2290 EmitInt8(0); EOL("End of directories");
2293 for (unsigned SourceID = 1, NSID = SourceFiles.size();
2294 SourceID <= NSID; ++SourceID) {
2295 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
2296 EmitString(SourceFile.getName()); EOL("Source");
2297 EmitULEB128Bytes(SourceFile.getDirectoryID()); EOL("Directory #");
2298 EmitULEB128Bytes(0); EOL("Mod date");
2299 EmitULEB128Bytes(0); EOL("File size");
2301 EmitInt8(0); EOL("End of files");
2303 EmitLabel("line_prolog_end", 0);
2305 // A sequence for each text section.
2306 for (unsigned j = 0, M = SectionSourceLines.size(); j < M; ++j) {
2307 // Isolate current sections line info.
2308 const std::vector<SourceLineInfo> &LineInfos = SectionSourceLines[j];
2312 << TAI->getCommentString() << " "
2314 << SectionMap[j + 1].c_str() << "\n";
2317 // Dwarf assumes we start with first line of first source file.
2318 unsigned Source = 1;
2321 // Construct rows of the address, source, line, column matrix.
2322 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2323 const SourceLineInfo &LineInfo = LineInfos[i];
2324 unsigned LabelID = LineInfo.getLabelID();
2326 // Source line labels are validated at the MachineDebugInfo level.
2329 unsigned SourceID = LineInfo.getSourceID();
2330 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
2331 unsigned DirectoryID = SourceFile.getDirectoryID();
2333 << TAI->getCommentString() << " "
2334 << Directories[DirectoryID]
2335 << SourceFile.getName() << ":"
2336 << LineInfo.getLine() << "\n";
2339 // Define the line address.
2340 EmitInt8(0); EOL("Extended Op");
2341 EmitInt8(4 + 1); EOL("Op size");
2342 EmitInt8(DW_LNE_set_address); EOL("DW_LNE_set_address");
2343 EmitReference("loc", LabelID); EOL("Location label");
2345 // If change of source, then switch to the new source.
2346 if (Source != LineInfo.getSourceID()) {
2347 Source = LineInfo.getSourceID();
2348 EmitInt8(DW_LNS_set_file); EOL("DW_LNS_set_file");
2349 EmitULEB128Bytes(Source); EOL("New Source");
2352 // If change of line.
2353 if (Line != LineInfo.getLine()) {
2354 // Determine offset.
2355 int Offset = LineInfo.getLine() - Line;
2356 int Delta = Offset - MinLineDelta;
2359 Line = LineInfo.getLine();
2361 // If delta is small enough and in range...
2362 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2363 // ... then use fast opcode.
2364 EmitInt8(Delta - MinLineDelta); EOL("Line Delta");
2366 // ... otherwise use long hand.
2367 EmitInt8(DW_LNS_advance_line); EOL("DW_LNS_advance_line");
2368 EmitSLEB128Bytes(Offset); EOL("Line Offset");
2369 EmitInt8(DW_LNS_copy); EOL("DW_LNS_copy");
2372 // Copy the previous row (different address or source)
2373 EmitInt8(DW_LNS_copy); EOL("DW_LNS_copy");
2377 // Define last address of section.
2378 EmitInt8(0); EOL("Extended Op");
2379 EmitInt8(4 + 1); EOL("Op size");
2380 EmitInt8(DW_LNE_set_address); EOL("DW_LNE_set_address");
2381 EmitReference("section_end", j + 1); EOL("Section end label");
2383 // Mark end of matrix.
2384 EmitInt8(0); EOL("DW_LNE_end_sequence");
2385 EmitULEB128Bytes(1); O << "\n";
2386 EmitInt8(1); O << "\n";
2389 EmitLabel("line_end", 0);
2394 /// EmitInitialDebugFrame - Emit common frame info into a debug frame section.
2396 void EmitInitialDebugFrame() {
2397 if (!TAI->getDwarfRequiresFrameSection())
2401 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2402 TargetFrameInfo::StackGrowsUp ?
2403 TAI->getAddressSize() : -TAI->getAddressSize();
2405 // Start the dwarf frame section.
2406 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2408 EmitLabel("frame_common", 0);
2409 EmitDifference("frame_common_end", 0,
2410 "frame_common_begin", 0);
2411 EOL("Length of Common Information Entry");
2413 EmitLabel("frame_common_begin", 0);
2414 EmitInt32(DW_CIE_ID); EOL("CIE Identifier Tag");
2415 EmitInt8(DW_CIE_VERSION); EOL("CIE Version");
2416 EmitString(""); EOL("CIE Augmentation");
2417 EmitULEB128Bytes(1); EOL("CIE Code Alignment Factor");
2418 EmitSLEB128Bytes(stackGrowth); EOL("CIE Data Alignment Factor");
2419 EmitInt8(RI->getDwarfRegNum(RI->getRARegister())); EOL("CIE RA Column");
2421 std::vector<MachineMove *> Moves;
2422 RI->getInitialFrameState(Moves);
2423 EmitFrameMoves(NULL, 0, Moves);
2424 for (unsigned i = 0, N = Moves.size(); i < N; ++i) delete Moves[i];
2427 EmitLabel("frame_common_end", 0);
2432 /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2434 void EmitFunctionDebugFrame() {
2435 // Start the dwarf frame section.
2436 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2438 EmitDifference("frame_end", SubprogramCount,
2439 "frame_begin", SubprogramCount);
2440 EOL("Length of Frame Information Entry");
2442 EmitLabel("frame_begin", SubprogramCount);
2444 EmitDifference("frame_common", 0, "section_frame", 0);
2445 EOL("FDE CIE offset");
2447 EmitReference("func_begin", SubprogramCount); EOL("FDE initial location");
2448 EmitDifference("func_end", SubprogramCount,
2449 "func_begin", SubprogramCount);
2450 EOL("FDE address range");
2452 std::vector<MachineMove *> &Moves = DebugInfo->getFrameMoves();
2454 EmitFrameMoves("func_begin", SubprogramCount, Moves);
2457 EmitLabel("frame_end", SubprogramCount);
2462 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
2464 void EmitDebugPubNames() {
2465 // Start the dwarf pubnames section.
2466 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2468 // Process each compile unit.
2469 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) {
2470 CompileUnit *Unit = CompileUnits[i];
2472 if (Unit->hasContent()) {
2473 EmitDifference("pubnames_end", Unit->getID(),
2474 "pubnames_begin", Unit->getID());
2475 EOL("Length of Public Names Info");
2477 EmitLabel("pubnames_begin", Unit->getID());
2479 EmitInt16(DWARF_VERSION); EOL("DWARF Version");
2481 EmitDifference("info_begin", Unit->getID(), "section_info", 0);
2482 EOL("Offset of Compilation Unit Info");
2484 EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID());
2485 EOL("Compilation Unit Length");
2487 std::map<std::string, DIE *> &Globals = Unit->getGlobals();
2489 for (std::map<std::string, DIE *>::iterator GI = Globals.begin(),
2492 const std::string &Name = GI->first;
2493 DIE * Entity = GI->second;
2495 EmitInt32(Entity->getOffset()); EOL("DIE offset");
2496 EmitString(Name); EOL("External Name");
2499 EmitInt32(0); EOL("End Mark");
2500 EmitLabel("pubnames_end", Unit->getID());
2507 /// EmitDebugStr - Emit visible names into a debug str section.
2509 void EmitDebugStr() {
2510 // Check to see if it is worth the effort.
2511 if (!StringPool.empty()) {
2512 // Start the dwarf str section.
2513 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2515 // For each of strings in the string pool.
2516 for (unsigned StringID = 1, N = StringPool.size();
2517 StringID <= N; ++StringID) {
2518 // Emit a label for reference from debug information entries.
2519 EmitLabel("string", StringID);
2520 // Emit the string itself.
2521 const std::string &String = StringPool[StringID];
2522 EmitString(String); O << "\n";
2529 /// EmitDebugLoc - Emit visible names into a debug loc section.
2531 void EmitDebugLoc() {
2532 // Start the dwarf loc section.
2533 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2538 /// EmitDebugARanges - Emit visible names into a debug aranges section.
2540 void EmitDebugARanges() {
2541 // Start the dwarf aranges section.
2542 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2546 // Process each compile unit.
2547 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) {
2548 CompileUnit *Unit = CompileUnits[i];
2550 if (Unit->hasContent()) {
2551 // Don't include size of length
2552 EmitInt32(0x1c); EOL("Length of Address Ranges Info");
2554 EmitInt16(DWARF_VERSION); EOL("Dwarf Version");
2556 EmitReference("info_begin", Unit->getID());
2557 EOL("Offset of Compilation Unit Info");
2559 EmitInt8(TAI->getAddressSize()); EOL("Size of Address");
2561 EmitInt8(0); EOL("Size of Segment Descriptor");
2563 EmitInt16(0); EOL("Pad (1)");
2564 EmitInt16(0); EOL("Pad (2)");
2567 EmitReference("text_begin", 0); EOL("Address");
2568 EmitDifference("text_end", 0, "text_begin", 0); EOL("Length");
2570 EmitInt32(0); EOL("EOM (1)");
2571 EmitInt32(0); EOL("EOM (2)");
2579 /// EmitDebugRanges - Emit visible names into a debug ranges section.
2581 void EmitDebugRanges() {
2582 // Start the dwarf ranges section.
2583 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2588 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
2590 void EmitDebugMacInfo() {
2591 // Start the dwarf macinfo section.
2592 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2597 /// ConstructCompileUnitDIEs - Create a compile unit DIE for each source and
2599 void ConstructCompileUnitDIEs() {
2600 const UniqueVector<CompileUnitDesc *> CUW = DebugInfo->getCompileUnits();
2602 for (unsigned i = 1, N = CUW.size(); i <= N; ++i) {
2603 CompileUnit *Unit = NewCompileUnit(CUW[i], i);
2604 CompileUnits.push_back(Unit);
2608 /// ConstructGlobalDIEs - Create DIEs for each of the externally visible
2609 /// global variables.
2610 void ConstructGlobalDIEs() {
2611 std::vector<GlobalVariableDesc *> GlobalVariables =
2612 DebugInfo->getAnchoredDescriptors<GlobalVariableDesc>(*M);
2614 for (unsigned i = 0, N = GlobalVariables.size(); i < N; ++i) {
2615 GlobalVariableDesc *GVD = GlobalVariables[i];
2616 NewGlobalVariable(GVD);
2620 /// ConstructSubprogramDIEs - Create DIEs for each of the externally visible
2622 void ConstructSubprogramDIEs() {
2623 std::vector<SubprogramDesc *> Subprograms =
2624 DebugInfo->getAnchoredDescriptors<SubprogramDesc>(*M);
2626 for (unsigned i = 0, N = Subprograms.size(); i < N; ++i) {
2627 SubprogramDesc *SPD = Subprograms[i];
2632 /// ShouldEmitDwarf - Returns true if Dwarf declarations should be made.
2634 bool ShouldEmitDwarf() const { return shouldEmit; }
2637 //===--------------------------------------------------------------------===//
2638 // Main entry points.
2640 Dwarf(std::ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
2644 , TD(Asm->TM.getTargetData())
2645 , RI(Asm->TM.getRegisterInfo())
2651 , SubprogramCount(0)
2653 , AbbreviationsSet(InitAbbreviationsSetSize)
2655 , ValuesSet(InitValuesSetSize)
2660 , SectionSourceLines()
2664 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i)
2665 delete CompileUnits[i];
2666 for (unsigned j = 0, M = Values.size(); j < M; ++j)
2672 const TargetAsmInfo *getTargetAsmInfo() const { return TAI; }
2674 /// SetDebugInfo - Set DebugInfo when it's known that pass manager has
2675 /// created it. Set by the target AsmPrinter.
2676 void SetDebugInfo(MachineDebugInfo *DI) {
2677 // Make sure initial declarations are made.
2678 if (!DebugInfo && DI->hasInfo()) {
2682 // Emit initial sections
2685 // Create all the compile unit DIEs.
2686 ConstructCompileUnitDIEs();
2688 // Create DIEs for each of the externally visible global variables.
2689 ConstructGlobalDIEs();
2691 // Create DIEs for each of the externally visible subprograms.
2692 ConstructSubprogramDIEs();
2694 // Prime section data.
2695 SectionMap.insert(std::string("\t") + TAI->getTextSection());
2699 /// BeginModule - Emit all Dwarf sections that should come prior to the
2701 void BeginModule(Module *M) {
2704 if (!ShouldEmitDwarf()) return;
2705 EOL("Dwarf Begin Module");
2708 /// EndModule - Emit all Dwarf sections that should come after the content.
2711 if (!ShouldEmitDwarf()) return;
2712 EOL("Dwarf End Module");
2714 // Standard sections final addresses.
2715 Asm->SwitchToTextSection(TAI->getTextSection());
2716 EmitLabel("text_end", 0);
2717 Asm->SwitchToDataSection(TAI->getDataSection());
2718 EmitLabel("data_end", 0);
2720 // End text sections.
2721 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
2722 Asm->SwitchToTextSection(SectionMap[i].c_str());
2723 EmitLabel("section_end", i);
2726 // Compute DIE offsets and sizes.
2729 // Emit all the DIEs into a debug info section
2732 // Corresponding abbreviations into a abbrev section.
2733 EmitAbbreviations();
2735 // Emit source line correspondence into a debug line section.
2738 // Emit info into a debug pubnames section.
2739 EmitDebugPubNames();
2741 // Emit info into a debug str section.
2744 // Emit info into a debug loc section.
2747 // Emit info into a debug aranges section.
2750 // Emit info into a debug ranges section.
2753 // Emit info into a debug macinfo section.
2757 /// BeginFunction - Gather pre-function debug information. Assumes being
2758 /// emitted immediately after the function entry point.
2759 void BeginFunction(MachineFunction *MF) {
2762 if (!ShouldEmitDwarf()) return;
2763 EOL("Dwarf Begin Function");
2765 // Begin accumulating function debug information.
2766 DebugInfo->BeginFunction(MF);
2768 // Assumes in correct section after the entry point.
2769 EmitLabel("func_begin", ++SubprogramCount);
2772 /// EndFunction - Gather and emit post-function debug information.
2774 void EndFunction() {
2775 if (!ShouldEmitDwarf()) return;
2776 EOL("Dwarf End Function");
2778 // Define end label for subprogram.
2779 EmitLabel("func_end", SubprogramCount);
2781 // Get function line info.
2782 const std::vector<SourceLineInfo> &LineInfos = DebugInfo->getSourceLines();
2784 if (!LineInfos.empty()) {
2785 // Get section line info.
2786 unsigned ID = SectionMap.insert(Asm->CurrentSection);
2787 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2788 std::vector<SourceLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2789 // Append the function info to section info.
2790 SectionLineInfos.insert(SectionLineInfos.end(),
2791 LineInfos.begin(), LineInfos.end());
2794 // Construct scopes for subprogram.
2795 ConstructRootScope(DebugInfo->getRootScope());
2797 // Emit function frame information.
2798 EmitFunctionDebugFrame();
2800 // Reset the line numbers for the next function.
2801 DebugInfo->ClearLineInfo();
2803 // Clear function debug information.
2804 DebugInfo->EndFunction();
2808 } // End of namespace llvm
2810 //===----------------------------------------------------------------------===//
2812 /// Emit - Print the abbreviation using the specified Dwarf writer.
2814 void DIEAbbrev::Emit(const Dwarf &DW) const {
2815 // Emit its Dwarf tag type.
2816 DW.EmitULEB128Bytes(Tag);
2817 DW.EOL(TagString(Tag));
2819 // Emit whether it has children DIEs.
2820 DW.EmitULEB128Bytes(ChildrenFlag);
2821 DW.EOL(ChildrenString(ChildrenFlag));
2823 // For each attribute description.
2824 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
2825 const DIEAbbrevData &AttrData = Data[i];
2827 // Emit attribute type.
2828 DW.EmitULEB128Bytes(AttrData.getAttribute());
2829 DW.EOL(AttributeString(AttrData.getAttribute()));
2832 DW.EmitULEB128Bytes(AttrData.getForm());
2833 DW.EOL(FormEncodingString(AttrData.getForm()));
2836 // Mark end of abbreviation.
2837 DW.EmitULEB128Bytes(0); DW.EOL("EOM(1)");
2838 DW.EmitULEB128Bytes(0); DW.EOL("EOM(2)");
2842 void DIEAbbrev::print(std::ostream &O) {
2843 O << "Abbreviation @"
2844 << std::hex << (intptr_t)this << std::dec
2848 << ChildrenString(ChildrenFlag)
2851 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
2853 << AttributeString(Data[i].getAttribute())
2855 << FormEncodingString(Data[i].getForm())
2859 void DIEAbbrev::dump() { print(std::cerr); }
2862 //===----------------------------------------------------------------------===//
2865 void DIEValue::dump() {
2870 //===----------------------------------------------------------------------===//
2872 /// EmitValue - Emit integer of appropriate size.
2874 void DIEInteger::EmitValue(const Dwarf &DW, unsigned Form) const {
2876 case DW_FORM_flag: // Fall thru
2877 case DW_FORM_ref1: // Fall thru
2878 case DW_FORM_data1: DW.EmitInt8(Integer); break;
2879 case DW_FORM_ref2: // Fall thru
2880 case DW_FORM_data2: DW.EmitInt16(Integer); break;
2881 case DW_FORM_ref4: // Fall thru
2882 case DW_FORM_data4: DW.EmitInt32(Integer); break;
2883 case DW_FORM_ref8: // Fall thru
2884 case DW_FORM_data8: DW.EmitInt64(Integer); break;
2885 case DW_FORM_udata: DW.EmitULEB128Bytes(Integer); break;
2886 case DW_FORM_sdata: DW.EmitSLEB128Bytes(Integer); break;
2887 default: assert(0 && "DIE Value form not supported yet"); break;
2891 //===----------------------------------------------------------------------===//
2893 /// EmitValue - Emit string value.
2895 void DIEString::EmitValue(const Dwarf &DW, unsigned Form) const {
2896 DW.EmitString(String);
2899 //===----------------------------------------------------------------------===//
2901 /// EmitValue - Emit label value.
2903 void DIEDwarfLabel::EmitValue(const Dwarf &DW, unsigned Form) const {
2904 DW.EmitReference(Label);
2907 /// SizeOf - Determine size of label value in bytes.
2909 unsigned DIEDwarfLabel::SizeOf(const Dwarf &DW, unsigned Form) const {
2910 return DW.getTargetAsmInfo()->getAddressSize();
2913 //===----------------------------------------------------------------------===//
2915 /// EmitValue - Emit label value.
2917 void DIEObjectLabel::EmitValue(const Dwarf &DW, unsigned Form) const {
2918 DW.EmitReference(Label);
2921 /// SizeOf - Determine size of label value in bytes.
2923 unsigned DIEObjectLabel::SizeOf(const Dwarf &DW, unsigned Form) const {
2924 return DW.getTargetAsmInfo()->getAddressSize();
2927 //===----------------------------------------------------------------------===//
2929 /// EmitValue - Emit delta value.
2931 void DIEDelta::EmitValue(const Dwarf &DW, unsigned Form) const {
2932 DW.EmitDifference(LabelHi, LabelLo);
2935 /// SizeOf - Determine size of delta value in bytes.
2937 unsigned DIEDelta::SizeOf(const Dwarf &DW, unsigned Form) const {
2938 return DW.getTargetAsmInfo()->getAddressSize();
2941 //===----------------------------------------------------------------------===//
2943 /// EmitValue - Emit debug information entry offset.
2945 void DIEntry::EmitValue(const Dwarf &DW, unsigned Form) const {
2946 DW.EmitInt32(Entry->getOffset());
2949 //===----------------------------------------------------------------------===//
2951 /// ComputeSize - calculate the size of the block.
2953 unsigned DIEBlock::ComputeSize(Dwarf &DW) {
2955 const std::vector<DIEAbbrevData> &AbbrevData = Abbrev.getData();
2957 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2958 Size += Values[i]->SizeOf(DW, AbbrevData[i].getForm());
2964 /// EmitValue - Emit block data.
2966 void DIEBlock::EmitValue(const Dwarf &DW, unsigned Form) const {
2968 case DW_FORM_block1: DW.EmitInt8(Size); break;
2969 case DW_FORM_block2: DW.EmitInt16(Size); break;
2970 case DW_FORM_block4: DW.EmitInt32(Size); break;
2971 case DW_FORM_block: DW.EmitULEB128Bytes(Size); break;
2972 default: assert(0 && "Improper form for block"); break;
2975 const std::vector<DIEAbbrevData> &AbbrevData = Abbrev.getData();
2977 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2979 Values[i]->EmitValue(DW, AbbrevData[i].getForm());
2983 /// SizeOf - Determine size of block data in bytes.
2985 unsigned DIEBlock::SizeOf(const Dwarf &DW, unsigned Form) const {
2987 case DW_FORM_block1: return Size + sizeof(int8_t);
2988 case DW_FORM_block2: return Size + sizeof(int16_t);
2989 case DW_FORM_block4: return Size + sizeof(int32_t);
2990 case DW_FORM_block: return Size + SizeULEB128(Size);
2991 default: assert(0 && "Improper form for block"); break;
2996 //===----------------------------------------------------------------------===//
2997 /// DIE Implementation
3000 for (unsigned i = 0, N = Children.size(); i < N; ++i)
3004 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
3006 void DIE::AddSiblingOffset() {
3007 DIEInteger *DI = new DIEInteger(0);
3008 Values.insert(Values.begin(), DI);
3009 Abbrev.AddFirstAttribute(DW_AT_sibling, DW_FORM_ref4);
3012 /// Profile - Used to gather unique data for the value folding set.
3014 void DIE::Profile(FoldingSetNodeID &ID) {
3017 for (unsigned i = 0, N = Children.size(); i < N; ++i)
3018 ID.AddPointer(Children[i]);
3020 for (unsigned j = 0, M = Values.size(); j < M; ++j)
3021 ID.AddPointer(Values[j]);
3025 void DIE::print(std::ostream &O, unsigned IncIndent) {
3026 static unsigned IndentCount = 0;
3027 IndentCount += IncIndent;
3028 const std::string Indent(IndentCount, ' ');
3029 bool isBlock = Abbrev.getTag() == 0;
3034 << "0x" << std::hex << (intptr_t)this << std::dec
3035 << ", Offset: " << Offset
3036 << ", Size: " << Size
3040 << TagString(Abbrev.getTag())
3042 << ChildrenString(Abbrev.getChildrenFlag());
3044 O << "Size: " << Size;
3048 const std::vector<DIEAbbrevData> &Data = Abbrev.getData();
3051 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3054 O << AttributeString(Data[i].getAttribute());
3056 O << "Blk[" << i << "]";
3059 << FormEncodingString(Data[i].getForm())
3061 Values[i]->print(O);
3066 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
3067 Children[j]->print(O, 4);
3070 if (!isBlock) O << "\n";
3071 IndentCount -= IncIndent;
3079 //===----------------------------------------------------------------------===//
3080 /// DwarfWriter Implementation
3083 DwarfWriter::DwarfWriter(std::ostream &OS, AsmPrinter *A,
3084 const TargetAsmInfo *T) {
3085 DW = new Dwarf(OS, A, T);
3088 DwarfWriter::~DwarfWriter() {
3092 /// SetDebugInfo - Set DebugInfo when it's known that pass manager has
3093 /// created it. Set by the target AsmPrinter.
3094 void DwarfWriter::SetDebugInfo(MachineDebugInfo *DI) {
3095 DW->SetDebugInfo(DI);
3098 /// BeginModule - Emit all Dwarf sections that should come prior to the
3100 void DwarfWriter::BeginModule(Module *M) {
3104 /// EndModule - Emit all Dwarf sections that should come after the content.
3106 void DwarfWriter::EndModule() {
3110 /// BeginFunction - Gather pre-function debug information. Assumes being
3111 /// emitted immediately after the function entry point.
3112 void DwarfWriter::BeginFunction(MachineFunction *MF) {
3113 DW->BeginFunction(MF);
3116 /// EndFunction - Gather and emit post-function debug information.
3118 void DwarfWriter::EndFunction() {