//===-- llvm/CodeGen/DwarfWriter.cpp - Dwarf Framework ----------*- C++ -*-===// // // The LLVM Compiler Infrastructure // // This file was developed by James M. Laskey and is distributed under the // University of Illinois Open Source License. See LICENSE.TXT for details. // //===----------------------------------------------------------------------===// // // This file contains support for writing dwarf debug info into asm files. // //===----------------------------------------------------------------------===// #include "llvm/CodeGen/DwarfWriter.h" #include "llvm/ADT/StringExtras.h" #include "llvm/Module.h" #include "llvm/Type.h" #include "llvm/CodeGen/AsmPrinter.h" #include "llvm/CodeGen/MachineDebugInfo.h" #include "llvm/Support/Dwarf.h" #include "llvm/Support/CommandLine.h" #include "llvm/Support/Mangler.h" #include "llvm/Target/TargetMachine.h" #include using namespace llvm; using namespace llvm::dwarf; static cl::opt DwarfVerbose("dwarf-verbose", cl::Hidden, cl::desc("Add comments to Dwarf directives.")); namespace llvm { //===----------------------------------------------------------------------===// // Forward declarations. // class CompileUnit; class DIE; //===----------------------------------------------------------------------===// // CompileUnit - This dwarf writer support class manages information associate // with a source file. class CompileUnit { private: CompileUnitDesc *Desc; // Compile unit debug descriptor. unsigned ID; // File ID for source. DIE *Die; // Compile unit die. std::map Globals; // A map of globally visible named // entities for this unit. public: CompileUnit(CompileUnitDesc *CUD, unsigned I, DIE *D) : Desc(CUD) , ID(I) , Die(D) , Globals() {} ~CompileUnit(); // Accessors. CompileUnitDesc *getDesc() const { return Desc; } unsigned getID() const { return ID; } DIE* getDie() const { return Die; } std::map &getGlobals() { return Globals; } /// hasContent - Return true if this compile unit has something to write out. /// bool hasContent() const; /// AddGlobal - Add a new global entity to the compile unit. /// void AddGlobal(const std::string &Name, DIE *Die); }; //===----------------------------------------------------------------------===// // DIEAbbrevData - Dwarf abbreviation data, describes the one attribute of a // Dwarf abbreviation. class DIEAbbrevData { private: unsigned Attribute; // Dwarf attribute code. unsigned Form; // Dwarf form code. public: DIEAbbrevData(unsigned A, unsigned F) : Attribute(A) , Form(F) {} // Accessors. unsigned getAttribute() const { return Attribute; } unsigned getForm() const { return Form; } /// operator== - Used by DIEAbbrev to locate entry. /// bool operator==(const DIEAbbrevData &DAD) const { return Attribute == DAD.Attribute && Form == DAD.Form; } /// operator!= - Used by DIEAbbrev to locate entry. /// bool operator!=(const DIEAbbrevData &DAD) const { return Attribute != DAD.Attribute || Form != DAD.Form; } /// operator< - Used by DIEAbbrev to locate entry. /// bool operator<(const DIEAbbrevData &DAD) const { return Attribute < DAD.Attribute || (Attribute == DAD.Attribute && Form < DAD.Form); } }; //===----------------------------------------------------------------------===// // DIEAbbrev - Dwarf abbreviation, describes the organization of a debug // information object. class DIEAbbrev { private: unsigned Tag; // Dwarf tag code. unsigned ChildrenFlag; // Dwarf children flag. std::vector Data; // Raw data bytes for abbreviation. public: DIEAbbrev(unsigned T, unsigned C) : Tag(T) , ChildrenFlag(C) , Data() {} ~DIEAbbrev() {} // Accessors. unsigned getTag() const { return Tag; } unsigned getChildrenFlag() const { return ChildrenFlag; } const std::vector &getData() const { return Data; } void setChildrenFlag(unsigned CF) { ChildrenFlag = CF; } /// operator== - Used by UniqueVector to locate entry. /// bool operator==(const DIEAbbrev &DA) const; /// operator< - Used by UniqueVector to locate entry. /// bool operator<(const DIEAbbrev &DA) const; /// AddAttribute - Adds another set of attribute information to the /// abbreviation. void AddAttribute(unsigned Attribute, unsigned Form) { Data.push_back(DIEAbbrevData(Attribute, Form)); } /// Emit - Print the abbreviation using the specified Dwarf writer. /// void Emit(const DwarfWriter &DW) const; #ifndef NDEBUG void print(std::ostream &O); void dump(); #endif }; //===----------------------------------------------------------------------===// // DIEValue - A debug information entry value. // class DIEValue { public: enum { isInteger, isString, isLabel, isAsIsLabel, isDelta, isEntry, isBlock }; unsigned Type; // Type of the value DIEValue(unsigned T) : Type(T) {} virtual ~DIEValue() {} // Implement isa/cast/dyncast. static bool classof(const DIEValue *) { return true; } /// EmitValue - Emit value via the Dwarf writer. /// virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const = 0; /// SizeOf - Return the size of a value in bytes. /// virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const = 0; }; //===----------------------------------------------------------------------===// // DWInteger - An integer value DIE. // class DIEInteger : public DIEValue { private: uint64_t Integer; public: DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {} // Implement isa/cast/dyncast. static bool classof(const DIEInteger *) { return true; } static bool classof(const DIEValue *I) { return I->Type == isInteger; } /// BestForm - Choose the best form for integer. /// unsigned BestForm(bool IsSigned); /// EmitValue - Emit integer of appropriate size. /// virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const; /// SizeOf - Determine size of integer value in bytes. /// virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const; }; //===----------------------------------------------------------------------===// // DIEString - A string value DIE. // struct DIEString : public DIEValue { const std::string String; DIEString(const std::string &S) : DIEValue(isString), String(S) {} // Implement isa/cast/dyncast. static bool classof(const DIEString *) { return true; } static bool classof(const DIEValue *S) { return S->Type == isString; } /// EmitValue - Emit string value. /// virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const; /// SizeOf - Determine size of string value in bytes. /// virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const; }; //===----------------------------------------------------------------------===// // DIEDwarfLabel - A Dwarf internal label expression DIE. // struct DIEDwarfLabel : public DIEValue { const DWLabel Label; DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {} // Implement isa/cast/dyncast. static bool classof(const DIEDwarfLabel *) { return true; } static bool classof(const DIEValue *L) { return L->Type == isLabel; } /// EmitValue - Emit label value. /// virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const; /// SizeOf - Determine size of label value in bytes. /// virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const; }; //===----------------------------------------------------------------------===// // DIEObjectLabel - A label to an object in code or data. // struct DIEObjectLabel : public DIEValue { const std::string Label; DIEObjectLabel(const std::string &L) : DIEValue(isAsIsLabel), Label(L) {} // Implement isa/cast/dyncast. static bool classof(const DIEObjectLabel *) { return true; } static bool classof(const DIEValue *L) { return L->Type == isAsIsLabel; } /// EmitValue - Emit label value. /// virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const; /// SizeOf - Determine size of label value in bytes. /// virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const; }; //===----------------------------------------------------------------------===// // DIEDelta - A simple label difference DIE. // struct DIEDelta : public DIEValue { const DWLabel LabelHi; const DWLabel LabelLo; DIEDelta(const DWLabel &Hi, const DWLabel &Lo) : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {} // Implement isa/cast/dyncast. static bool classof(const DIEDelta *) { return true; } static bool classof(const DIEValue *D) { return D->Type == isDelta; } /// EmitValue - Emit delta value. /// virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const; /// SizeOf - Determine size of delta value in bytes. /// virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const; }; //===----------------------------------------------------------------------===// // DIEntry - A pointer to a debug information entry. // struct DIEntry : public DIEValue { DIE *Entry; DIEntry(DIE *E) : DIEValue(isEntry), Entry(E) {} // Implement isa/cast/dyncast. static bool classof(const DIEntry *) { return true; } static bool classof(const DIEValue *E) { return E->Type == isEntry; } /// EmitValue - Emit die entry offset. /// virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const; /// SizeOf - Determine size of die entry in bytes. /// virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const; }; //===----------------------------------------------------------------------===// // DIEBlock - A block of values. Primarily used for location expressions. // struct DIEBlock : public DIEValue { unsigned Size; // Size in bytes excluding size header. std::vector Forms; // Data forms. std::vector Values; // Block values. DIEBlock() : DIEValue(isBlock) , Size(0) , Forms() , Values() {} ~DIEBlock(); // Implement isa/cast/dyncast. static bool classof(const DIEBlock *) { return true; } static bool classof(const DIEValue *E) { return E->Type == isBlock; } /// ComputeSize - calculate the size of the block. /// unsigned ComputeSize(DwarfWriter &DW); /// BestForm - Choose the best form for data. /// unsigned BestForm(); /// EmitValue - Emit block data. /// virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const; /// SizeOf - Determine size of block data in bytes. /// virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const; /// AddUInt - Add an unsigned integer value. /// void AddUInt(unsigned Form, uint64_t Integer); /// AddSInt - Add an signed integer value. /// void AddSInt(unsigned Form, int64_t Integer); /// AddString - Add a std::string value. /// void AddString(unsigned Form, const std::string &String); /// AddLabel - Add a Dwarf label value. /// void AddLabel(unsigned Form, const DWLabel &Label); /// AddObjectLabel - Add a non-Dwarf label value. /// void AddObjectLabel(unsigned Form, const std::string &Label); /// AddDelta - Add a label delta value. /// void AddDelta(unsigned Form, const DWLabel &Hi, const DWLabel &Lo); /// AddDIEntry - Add a DIE value. /// void AddDIEntry(unsigned Form, DIE *Entry); }; //===----------------------------------------------------------------------===// // DIE - A structured debug information entry. Has an abbreviation which // describes it's organization. class DIE { private: DIEAbbrev *Abbrev; // Temporary buffer for abbreviation. unsigned AbbrevID; // Decribing abbreviation ID. unsigned Offset; // Offset in debug info section. unsigned Size; // Size of instance + children. std::vector Children; // Children DIEs. std::vector Values; // Attributes values. public: DIE(unsigned Tag); ~DIE(); // Accessors. unsigned getAbbrevID() const { return AbbrevID; } unsigned getOffset() const { return Offset; } unsigned getSize() const { return Size; } const std::vector &getChildren() const { return Children; } const std::vector &getValues() const { return Values; } void setOffset(unsigned O) { Offset = O; } void setSize(unsigned S) { Size = S; } /// SiblingOffset - Return the offset of the debug information entry's /// sibling. unsigned SiblingOffset() const { return Offset + Size; } /// AddUInt - Add an unsigned integer attribute data and value. /// void AddUInt(unsigned Attribute, unsigned Form, uint64_t Integer); /// AddSInt - Add an signed integer attribute data and value. /// void AddSInt(unsigned Attribute, unsigned Form, int64_t Integer); /// AddString - Add a std::string attribute data and value. /// void AddString(unsigned Attribute, unsigned Form, const std::string &String); /// AddLabel - Add a Dwarf label attribute data and value. /// void AddLabel(unsigned Attribute, unsigned Form, const DWLabel &Label); /// AddObjectLabel - Add a non-Dwarf label attribute data and value. /// void AddObjectLabel(unsigned Attribute, unsigned Form, const std::string &Label); /// AddDelta - Add a label delta attribute data and value. /// void AddDelta(unsigned Attribute, unsigned Form, const DWLabel &Hi, const DWLabel &Lo); /// AddDIEntry - Add a DIE attribute data and value. /// void AddDIEntry(unsigned Attribute, unsigned Form, DIE *Entry); /// AddBlock - Add block data. /// void AddBlock(unsigned Attribute, unsigned Form, DIEBlock *Block); /// Complete - Indicate that all attributes have been added and /// ready to get an abbreviation ID. /// void Complete(DwarfWriter &DW); /// AddChild - Add a child to the DIE. void AddChild(DIE *Child); }; } // End of namespace llvm //===----------------------------------------------------------------------===// CompileUnit::~CompileUnit() { delete Die; } /// hasContent - Return true if this compile unit has something to write out. /// bool CompileUnit::hasContent() const { return !Die->getChildren().empty(); } /// AddGlobal - Add a new global entity to the compile unit. /// void CompileUnit::AddGlobal(const std::string &Name, DIE *Die) { Globals[Name] = Die; } //===----------------------------------------------------------------------===// /// operator== - Used by UniqueVector to locate entry. /// bool DIEAbbrev::operator==(const DIEAbbrev &DA) const { if (Tag != DA.Tag) return false; if (ChildrenFlag != DA.ChildrenFlag) return false; if (Data.size() != DA.Data.size()) return false; for (unsigned i = 0, N = Data.size(); i < N; ++i) { if (Data[i] != DA.Data[i]) return false; } return true; } /// operator< - Used by UniqueVector to locate entry. /// bool DIEAbbrev::operator<(const DIEAbbrev &DA) const { if (Tag != DA.Tag) return Tag < DA.Tag; if (ChildrenFlag != DA.ChildrenFlag) return ChildrenFlag < DA.ChildrenFlag; if (Data.size() != DA.Data.size()) return Data.size() < DA.Data.size(); for (unsigned i = 0, N = Data.size(); i < N; ++i) { if (Data[i] != DA.Data[i]) return Data[i] < DA.Data[i]; } return false; } /// Emit - Print the abbreviation using the specified Dwarf writer. /// void DIEAbbrev::Emit(const DwarfWriter &DW) const { // Emit its Dwarf tag type. DW.EmitULEB128Bytes(Tag); DW.EOL(TagString(Tag)); // Emit whether it has children DIEs. DW.EmitULEB128Bytes(ChildrenFlag); DW.EOL(ChildrenString(ChildrenFlag)); // For each attribute description. for (unsigned i = 0, N = Data.size(); i < N; ++i) { const DIEAbbrevData &AttrData = Data[i]; // Emit attribute type. DW.EmitULEB128Bytes(AttrData.getAttribute()); DW.EOL(AttributeString(AttrData.getAttribute())); // Emit form type. DW.EmitULEB128Bytes(AttrData.getForm()); DW.EOL(FormEncodingString(AttrData.getForm())); } // Mark end of abbreviation. DW.EmitULEB128Bytes(0); DW.EOL("EOM(1)"); DW.EmitULEB128Bytes(0); DW.EOL("EOM(2)"); } #ifndef NDEBUG void DIEAbbrev::print(std::ostream &O) { O << "Abbreviation @" << std::hex << (intptr_t)this << std::dec << " " << TagString(Tag) << " " << ChildrenString(ChildrenFlag) << "\n"; for (unsigned i = 0, N = Data.size(); i < N; ++i) { O << " " << AttributeString(Data[i].getAttribute()) << " " << FormEncodingString(Data[i].getForm()) << "\n"; } } void DIEAbbrev::dump() { print(std::cerr); } #endif //===----------------------------------------------------------------------===// /// BestForm - Choose the best form for integer. /// unsigned DIEInteger::BestForm(bool IsSigned) { if (IsSigned) { if ((char)Integer == (signed)Integer) return DW_FORM_data1; if ((short)Integer == (signed)Integer) return DW_FORM_data2; if ((int)Integer == (signed)Integer) return DW_FORM_data4; } else { if ((unsigned char)Integer == Integer) return DW_FORM_data1; if ((unsigned short)Integer == Integer) return DW_FORM_data2; if ((unsigned int)Integer == Integer) return DW_FORM_data4; } return DW_FORM_data8; } /// EmitValue - Emit integer of appropriate size. /// void DIEInteger::EmitValue(const DwarfWriter &DW, unsigned Form) const { switch (Form) { case DW_FORM_flag: // Fall thru case DW_FORM_data1: DW.EmitInt8(Integer); break; case DW_FORM_data2: DW.EmitInt16(Integer); break; case DW_FORM_data4: DW.EmitInt32(Integer); break; case DW_FORM_data8: DW.EmitInt64(Integer); break; case DW_FORM_udata: DW.EmitULEB128Bytes(Integer); break; case DW_FORM_sdata: DW.EmitSLEB128Bytes(Integer); break; default: assert(0 && "DIE Value form not supported yet"); break; } } /// SizeOf - Determine size of integer value in bytes. /// unsigned DIEInteger::SizeOf(const DwarfWriter &DW, unsigned Form) const { switch (Form) { case DW_FORM_flag: // Fall thru case DW_FORM_data1: return sizeof(int8_t); case DW_FORM_data2: return sizeof(int16_t); case DW_FORM_data4: return sizeof(int32_t); case DW_FORM_data8: return sizeof(int64_t); case DW_FORM_udata: return DW.SizeULEB128(Integer); case DW_FORM_sdata: return DW.SizeSLEB128(Integer); default: assert(0 && "DIE Value form not supported yet"); break; } return 0; } //===----------------------------------------------------------------------===// /// EmitValue - Emit string value. /// void DIEString::EmitValue(const DwarfWriter &DW, unsigned Form) const { DW.EmitString(String); } /// SizeOf - Determine size of string value in bytes. /// unsigned DIEString::SizeOf(const DwarfWriter &DW, unsigned Form) const { return String.size() + sizeof(char); // sizeof('\0'); } //===----------------------------------------------------------------------===// /// EmitValue - Emit label value. /// void DIEDwarfLabel::EmitValue(const DwarfWriter &DW, unsigned Form) const { DW.EmitReference(Label); } /// SizeOf - Determine size of label value in bytes. /// unsigned DIEDwarfLabel::SizeOf(const DwarfWriter &DW, unsigned Form) const { return DW.getAddressSize(); } //===----------------------------------------------------------------------===// /// EmitValue - Emit label value. /// void DIEObjectLabel::EmitValue(const DwarfWriter &DW, unsigned Form) const { DW.EmitReference(Label); } /// SizeOf - Determine size of label value in bytes. /// unsigned DIEObjectLabel::SizeOf(const DwarfWriter &DW, unsigned Form) const { return DW.getAddressSize(); } //===----------------------------------------------------------------------===// /// EmitValue - Emit delta value. /// void DIEDelta::EmitValue(const DwarfWriter &DW, unsigned Form) const { DW.EmitDifference(LabelHi, LabelLo); } /// SizeOf - Determine size of delta value in bytes. /// unsigned DIEDelta::SizeOf(const DwarfWriter &DW, unsigned Form) const { return DW.getAddressSize(); } //===----------------------------------------------------------------------===// /// EmitValue - Emit die entry offset. /// void DIEntry::EmitValue(const DwarfWriter &DW, unsigned Form) const { DW.EmitInt32(Entry->getOffset()); } /// SizeOf - Determine size of die value in bytes. /// unsigned DIEntry::SizeOf(const DwarfWriter &DW, unsigned Form) const { return sizeof(int32_t); } //===----------------------------------------------------------------------===// DIEBlock::~DIEBlock() { for (unsigned i = 0, N = Values.size(); i < N; ++i) { delete Values[i]; } } /// ComputeSize - calculate the size of the block. /// unsigned DIEBlock::ComputeSize(DwarfWriter &DW) { Size = 0; for (unsigned i = 0, N = Values.size(); i < N; ++i) { Size += Values[i]->SizeOf(DW, Forms[i]); } return Size; } /// BestForm - Choose the best form for data. /// unsigned DIEBlock::BestForm() { if ((unsigned char)Size == Size) return DW_FORM_block1; if ((unsigned short)Size == Size) return DW_FORM_block2; if ((unsigned int)Size == Size) return DW_FORM_block4; return DW_FORM_block; } /// EmitValue - Emit block data. /// void DIEBlock::EmitValue(const DwarfWriter &DW, unsigned Form) const { switch (Form) { case DW_FORM_block1: DW.EmitInt8(Size); break; case DW_FORM_block2: DW.EmitInt16(Size); break; case DW_FORM_block4: DW.EmitInt32(Size); break; case DW_FORM_block: DW.EmitULEB128Bytes(Size); break; default: assert(0 && "Improper form for block"); break; } for (unsigned i = 0, N = Values.size(); i < N; ++i) { DW.EOL(""); Values[i]->EmitValue(DW, Forms[i]); } } /// SizeOf - Determine size of block data in bytes. /// unsigned DIEBlock::SizeOf(const DwarfWriter &DW, unsigned Form) const { switch (Form) { case DW_FORM_block1: return Size + sizeof(int8_t); case DW_FORM_block2: return Size + sizeof(int16_t); case DW_FORM_block4: return Size + sizeof(int32_t); case DW_FORM_block: return Size + DW.SizeULEB128(Size); default: assert(0 && "Improper form for block"); break; } return 0; } /// AddUInt - Add an unsigned integer value. /// void DIEBlock::AddUInt(unsigned Form, uint64_t Integer) { DIEInteger *DI = new DIEInteger(Integer); Values.push_back(DI); if (Form == 0) Form = DI->BestForm(false); Forms.push_back(Form); } /// AddSInt - Add an signed integer value. /// void DIEBlock::AddSInt(unsigned Form, int64_t Integer) { DIEInteger *DI = new DIEInteger(Integer); Values.push_back(DI); if (Form == 0) Form = DI->BestForm(true); Forms.push_back(Form); } /// AddString - Add a std::string value. /// void DIEBlock::AddString(unsigned Form, const std::string &String) { Values.push_back(new DIEString(String)); Forms.push_back(Form); } /// AddLabel - Add a Dwarf label value. /// void DIEBlock::AddLabel(unsigned Form, const DWLabel &Label) { Values.push_back(new DIEDwarfLabel(Label)); Forms.push_back(Form); } /// AddObjectLabel - Add a non-Dwarf label value. /// void DIEBlock::AddObjectLabel(unsigned Form, const std::string &Label) { Values.push_back(new DIEObjectLabel(Label)); Forms.push_back(Form); } /// AddDelta - Add a label delta value. /// void DIEBlock::AddDelta(unsigned Form, const DWLabel &Hi, const DWLabel &Lo) { Values.push_back(new DIEDelta(Hi, Lo)); Forms.push_back(Form); } /// AddDIEntry - Add a DIE value. /// void DIEBlock::AddDIEntry(unsigned Form, DIE *Entry) { Values.push_back(new DIEntry(Entry)); Forms.push_back(Form); } //===----------------------------------------------------------------------===// DIE::DIE(unsigned Tag) : Abbrev(new DIEAbbrev(Tag, DW_CHILDREN_no)) , AbbrevID(0) , Offset(0) , Size(0) , Children() , Values() {} DIE::~DIE() { if (Abbrev) delete Abbrev; for (unsigned i = 0, N = Children.size(); i < N; ++i) { delete Children[i]; } for (unsigned j = 0, M = Values.size(); j < M; ++j) { delete Values[j]; } } /// AddUInt - Add an unsigned integer attribute data and value. /// void DIE::AddUInt(unsigned Attribute, unsigned Form, uint64_t Integer) { DIEInteger *DI = new DIEInteger(Integer); Values.push_back(DI); if (!Form) Form = DI->BestForm(false); Abbrev->AddAttribute(Attribute, Form); } /// AddSInt - Add an signed integer attribute data and value. /// void DIE::AddSInt(unsigned Attribute, unsigned Form, int64_t Integer) { DIEInteger *DI = new DIEInteger(Integer); Values.push_back(DI); if (!Form) Form = DI->BestForm(true); Abbrev->AddAttribute(Attribute, Form); } /// AddString - Add a std::string attribute data and value. /// void DIE::AddString(unsigned Attribute, unsigned Form, const std::string &String) { Values.push_back(new DIEString(String)); Abbrev->AddAttribute(Attribute, Form); } /// AddLabel - Add a Dwarf label attribute data and value. /// void DIE::AddLabel(unsigned Attribute, unsigned Form, const DWLabel &Label) { Values.push_back(new DIEDwarfLabel(Label)); Abbrev->AddAttribute(Attribute, Form); } /// AddObjectLabel - Add an non-Dwarf label attribute data and value. /// void DIE::AddObjectLabel(unsigned Attribute, unsigned Form, const std::string &Label) { Values.push_back(new DIEObjectLabel(Label)); Abbrev->AddAttribute(Attribute, Form); } /// AddDelta - Add a label delta attribute data and value. /// void DIE::AddDelta(unsigned Attribute, unsigned Form, const DWLabel &Hi, const DWLabel &Lo) { Values.push_back(new DIEDelta(Hi, Lo)); Abbrev->AddAttribute(Attribute, Form); } /// AddDIEntry - Add a DIE attribute data and value. /// void DIE::AddDIEntry(unsigned Attribute, unsigned Form, DIE *Entry) { Values.push_back(new DIEntry(Entry)); Abbrev->AddAttribute(Attribute, Form); } /// AddBlock - Add block data. /// void DIE::AddBlock(unsigned Attribute, unsigned Form, DIEBlock *Block) { assert(Block->Size && "Block size has not been computed"); Values.push_back(Block); if (!Form) Form = Block->BestForm(); Abbrev->AddAttribute(Attribute, Form); } /// Complete - Indicate that all attributes have been added and ready to get an /// abbreviation ID. void DIE::Complete(DwarfWriter &DW) { AbbrevID = DW.NewAbbreviation(Abbrev); delete Abbrev; Abbrev = NULL; } /// AddChild - Add a child to the DIE. /// void DIE::AddChild(DIE *Child) { assert(Abbrev && "Adding children without an abbreviation"); Abbrev->setChildrenFlag(DW_CHILDREN_yes); Children.push_back(Child); } //===----------------------------------------------------------------------===// /// DWContext //===----------------------------------------------------------------------===// /// PrintHex - Print a value as a hexidecimal value. /// void DwarfWriter::PrintHex(int Value) const { O << "0x" << std::hex << Value << std::dec; } /// EOL - Print a newline character to asm stream. If a comment is present /// then it will be printed first. Comments should not contain '\n'. void DwarfWriter::EOL(const std::string &Comment) const { if (DwarfVerbose && !Comment.empty()) { O << "\t" << Asm->CommentString << " " << Comment; } O << "\n"; } /// EmitULEB128Bytes - Emit an assembler byte data directive to compose an /// unsigned leb128 value. void DwarfWriter::EmitULEB128Bytes(unsigned Value) const { if (hasLEB128) { O << "\t.uleb128\t" << Value; } else { O << Asm->Data8bitsDirective; PrintULEB128(Value); } } /// EmitSLEB128Bytes - Emit an assembler byte data directive to compose a /// signed leb128 value. void DwarfWriter::EmitSLEB128Bytes(int Value) const { if (hasLEB128) { O << "\t.sleb128\t" << Value; } else { O << Asm->Data8bitsDirective; PrintSLEB128(Value); } } /// PrintULEB128 - Print a series of hexidecimal values (separated by commas) /// representing an unsigned leb128 value. void DwarfWriter::PrintULEB128(unsigned Value) const { do { unsigned Byte = Value & 0x7f; Value >>= 7; if (Value) Byte |= 0x80; PrintHex(Byte); if (Value) O << ", "; } while (Value); } /// SizeULEB128 - Compute the number of bytes required for an unsigned leb128 /// value. unsigned DwarfWriter::SizeULEB128(unsigned Value) { unsigned Size = 0; do { Value >>= 7; Size += sizeof(int8_t); } while (Value); return Size; } /// PrintSLEB128 - Print a series of hexidecimal values (separated by commas) /// representing a signed leb128 value. void DwarfWriter::PrintSLEB128(int Value) const { int Sign = Value >> (8 * sizeof(Value) - 1); bool IsMore; do { unsigned Byte = Value & 0x7f; Value >>= 7; IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0; if (IsMore) Byte |= 0x80; PrintHex(Byte); if (IsMore) O << ", "; } while (IsMore); } /// SizeSLEB128 - Compute the number of bytes required for a signed leb128 /// value. unsigned DwarfWriter::SizeSLEB128(int Value) { unsigned Size = 0; int Sign = Value >> (8 * sizeof(Value) - 1); bool IsMore; do { unsigned Byte = Value & 0x7f; Value >>= 7; IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0; Size += sizeof(int8_t); } while (IsMore); return Size; } /// EmitInt8 - Emit a byte directive and value. /// void DwarfWriter::EmitInt8(int Value) const { O << Asm->Data8bitsDirective; PrintHex(Value & 0xFF); } /// EmitInt16 - Emit a short directive and value. /// void DwarfWriter::EmitInt16(int Value) const { O << Asm->Data16bitsDirective; PrintHex(Value & 0xFFFF); } /// EmitInt32 - Emit a long directive and value. /// void DwarfWriter::EmitInt32(int Value) const { O << Asm->Data32bitsDirective; PrintHex(Value); } /// EmitInt64 - Emit a long long directive and value. /// void DwarfWriter::EmitInt64(uint64_t Value) const { if (Asm->Data64bitsDirective) { O << Asm->Data64bitsDirective << "0x" << std::hex << Value << std::dec; } else { const TargetData &TD = Asm->TM.getTargetData(); if (TD.isBigEndian()) { EmitInt32(unsigned(Value >> 32)); O << "\n"; EmitInt32(unsigned(Value)); } else { EmitInt32(unsigned(Value)); O << "\n"; EmitInt32(unsigned(Value >> 32)); } } } /// EmitString - Emit a string with quotes and a null terminator. /// Special characters are emitted properly. (Eg. '\t') void DwarfWriter::EmitString(const std::string &String) const { O << Asm->AsciiDirective << "\""; for (unsigned i = 0, N = String.size(); i < N; ++i) { unsigned char C = String[i]; if (!isascii(C) || iscntrl(C)) { switch(C) { case '\b': O << "\\b"; break; case '\f': O << "\\f"; break; case '\n': O << "\\n"; break; case '\r': O << "\\r"; break; case '\t': O << "\\t"; break; default: O << '\\'; O << char('0' + (C >> 6)); O << char('0' + (C >> 3)); O << char('0' + (C >> 0)); break; } } else if (C == '\"') { O << "\\\""; } else if (C == '\'') { O << "\\\'"; } else { O << C; } } O << "\\0\""; } /// PrintLabelName - Print label name in form used by Dwarf writer. /// void DwarfWriter::PrintLabelName(const char *Tag, unsigned Number) const { O << Asm->PrivateGlobalPrefix << "debug_" << Tag; if (Number) O << Number; } /// EmitLabel - Emit location label for internal use by Dwarf. /// void DwarfWriter::EmitLabel(const char *Tag, unsigned Number) const { PrintLabelName(Tag, Number); O << ":\n"; } /// EmitReference - Emit a reference to a label. /// void DwarfWriter::EmitReference(const char *Tag, unsigned Number) const { if (AddressSize == 4) O << Asm->Data32bitsDirective; else O << Asm->Data64bitsDirective; PrintLabelName(Tag, Number); } void DwarfWriter::EmitReference(const std::string &Name) const { if (AddressSize == 4) O << Asm->Data32bitsDirective; else O << Asm->Data64bitsDirective; O << Name; } /// EmitDifference - Emit an label difference as sizeof(pointer) value. Some /// assemblers do not accept absolute expressions with data directives, so there /// is an option (needsSet) to use an intermediary 'set' expression. void DwarfWriter::EmitDifference(const char *TagHi, unsigned NumberHi, const char *TagLo, unsigned NumberLo) const { if (needsSet) { static unsigned SetCounter = 0; O << "\t.set\t"; PrintLabelName("set", SetCounter); O << ","; PrintLabelName(TagHi, NumberHi); O << "-"; PrintLabelName(TagLo, NumberLo); O << "\n"; if (AddressSize == sizeof(int32_t)) O << Asm->Data32bitsDirective; else O << Asm->Data64bitsDirective; PrintLabelName("set", SetCounter); ++SetCounter; } else { if (AddressSize == sizeof(int32_t)) O << Asm->Data32bitsDirective; else O << Asm->Data64bitsDirective; PrintLabelName(TagHi, NumberHi); O << "-"; PrintLabelName(TagLo, NumberLo); } } /// NewAbbreviation - Add the abbreviation to the Abbreviation vector. /// unsigned DwarfWriter::NewAbbreviation(DIEAbbrev *Abbrev) { return Abbreviations.insert(*Abbrev); } /// NewString - Add a string to the constant pool and returns a label. /// DWLabel DwarfWriter::NewString(const std::string &String) { unsigned StringID = StringPool.insert(String); return DWLabel("string", StringID); } /// NewBasicType - Creates a new basic type if necessary, then adds to the /// owner. /// FIXME - Should never be needed. DIE *DwarfWriter::NewBasicType(DIE *Context, Type *Ty) { DIE *&Slot = TypeToDieMap[Ty]; if (Slot) return Slot; const char *Name; unsigned Size; unsigned Encoding = 0; switch (Ty->getTypeID()) { case Type::UByteTyID: Name = "unsigned char"; Size = 1; Encoding = DW_ATE_unsigned_char; break; case Type::SByteTyID: Name = "char"; Size = 1; Encoding = DW_ATE_signed_char; break; case Type::UShortTyID: Name = "unsigned short"; Size = 2; Encoding = DW_ATE_unsigned; break; case Type::ShortTyID: Name = "short"; Size = 2; Encoding = DW_ATE_signed; break; case Type::UIntTyID: Name = "unsigned int"; Size = 4; Encoding = DW_ATE_unsigned; break; case Type::IntTyID: Name = "int"; Size = 4; Encoding = DW_ATE_signed; break; case Type::ULongTyID: Name = "unsigned long long"; Size = 7; Encoding = DW_ATE_unsigned; break; case Type::LongTyID: Name = "long long"; Size = 7; Encoding = DW_ATE_signed; break; case Type::FloatTyID: Name = "float"; Size = 4; Encoding = DW_ATE_float; break; case Type::DoubleTyID: Name = "double"; Size = 8; Encoding = DW_ATE_float; break; default: // FIXME - handle more complex types. Name = "unknown"; Size = 1; Encoding = DW_ATE_address; break; } // construct the type DIE. Slot = new DIE(DW_TAG_base_type); Slot->AddString(DW_AT_name, DW_FORM_string, Name); Slot->AddUInt (DW_AT_byte_size, 0, Size); Slot->AddUInt (DW_AT_encoding, DW_FORM_data1, Encoding); // Add to context. Context->AddChild(Slot); return Slot; } /// NewType - Create a new type DIE. /// DIE *DwarfWriter::NewType(DIE *Context, TypeDesc *TyDesc) { // FIXME - hack to get around NULL types short term. if (!TyDesc) return NewBasicType(Context, Type::IntTy); // FIXME - Should handle other contexts that compile units. // Check for pre-existence. DIE *&Slot = DescToDieMap[TyDesc]; if (Slot) return Slot; // Get core information. const std::string &Name = TyDesc->getName(); uint64_t Size = TyDesc->getSize() >> 3; DIE *Ty = NULL; if (BasicTypeDesc *BasicTy = dyn_cast(TyDesc)) { // Fundamental types like int, float, bool Slot = Ty = new DIE(DW_TAG_base_type); unsigned Encoding = BasicTy->getEncoding(); Ty->AddUInt (DW_AT_encoding, DW_FORM_data1, Encoding); } else if (DerivedTypeDesc *DerivedTy = dyn_cast(TyDesc)) { // Create specific DIE. Slot = Ty = new DIE(DerivedTy->getTag()); // Map to main type, void will not have a type. if (TypeDesc *FromTy = DerivedTy->getFromType()) { Ty->AddDIEntry(DW_AT_type, DW_FORM_ref4, NewType(Context, FromTy)); } } else if (CompositeTypeDesc *CompTy = dyn_cast(TyDesc)) { // Create specific DIE. Slot = Ty = new DIE(CompTy->getTag()); std::vector &Elements = CompTy->getElements(); switch (CompTy->getTag()) { case DW_TAG_array_type: { // Add element type. if (TypeDesc *FromTy = CompTy->getFromType()) { Ty->AddDIEntry(DW_AT_type, DW_FORM_ref4, NewType(Context, FromTy)); } // Don't emit size attribute. Size = 0; // Construct an anonymous type for index type. DIE *IndexTy = new DIE(DW_TAG_base_type); IndexTy->AddUInt(DW_AT_byte_size, 0, 4); IndexTy->AddUInt(DW_AT_encoding, DW_FORM_data1, DW_ATE_signed); // Add to context. Context->AddChild(IndexTy); // Add subranges to array type. for(unsigned i = 0, N = Elements.size(); i < N; ++i) { SubrangeDesc *SRD = cast(Elements[i]); int64_t Lo = SRD->getLo(); int64_t Hi = SRD->getHi(); DIE *Subrange = new DIE(DW_TAG_subrange_type); // If a range is available. if (Lo != Hi) { Subrange->AddDIEntry(DW_AT_type, DW_FORM_ref4, IndexTy); // Only add low if non-zero. if (Lo) Subrange->AddSInt(DW_AT_lower_bound, 0, Lo); Subrange->AddSInt(DW_AT_upper_bound, 0, Hi); } Ty->AddChild(Subrange); } break; } case DW_TAG_structure_type: case DW_TAG_union_type: { // FIXME - this is just the basics. // Add elements to structure type. for(unsigned i = 0, N = Elements.size(); i < N; ++i) { DerivedTypeDesc *MemberDesc = cast(Elements[i]); // Extract the basic information. const std::string &Name = MemberDesc->getName(); unsigned Line = MemberDesc->getLine(); TypeDesc *MemTy = MemberDesc->getFromType(); uint64_t Size = MemberDesc->getSize(); uint64_t Offset = MemberDesc->getOffset(); // Construct member die. DIE *Member = new DIE(DW_TAG_member); // Add details. if (!Name.empty()) Member->AddString(DW_AT_name, DW_FORM_string, Name); if (CompileUnitDesc *File = MemberDesc->getFile()) { CompileUnit *FileUnit = FindCompileUnit(File); unsigned FileID = FileUnit->getID(); int Line = TyDesc->getLine(); Member->AddUInt(DW_AT_decl_file, 0, FileID); Member->AddUInt(DW_AT_decl_line, 0, Line); } if (TypeDesc *FromTy = MemberDesc->getFromType()) { Member->AddDIEntry(DW_AT_type, DW_FORM_ref4, NewType(Context, FromTy)); } // Add computation for offset. DIEBlock *Block = new DIEBlock(); Block->AddUInt(DW_FORM_data1, DW_OP_plus_uconst); Block->AddUInt(DW_FORM_udata, Offset >> 3); Block->ComputeSize(*this); Member->AddBlock(DW_AT_data_member_location, 0, Block); Ty->AddChild(Member); } break; } case DW_TAG_enumeration_type: { // Add enumerators to enumeration type. for(unsigned i = 0, N = Elements.size(); i < N; ++i) { EnumeratorDesc *ED = cast(Elements[i]); const std::string &Name = ED->getName(); int64_t Value = ED->getValue(); DIE *Enumerator = new DIE(DW_TAG_enumerator); Enumerator->AddString(DW_AT_name, DW_FORM_string, Name); Enumerator->AddSInt(DW_AT_const_value, DW_FORM_sdata, Value); Ty->AddChild(Enumerator); } break; } default: break; } } assert(Ty && "Type not supported yet"); // Add size if non-zero (derived types don't have a size.) if (Size) Ty->AddUInt(DW_AT_byte_size, 0, Size); // Add name if not anonymous or intermediate type. if (!Name.empty()) Ty->AddString(DW_AT_name, DW_FORM_string, Name); // Add source line info if present. if (CompileUnitDesc *File = TyDesc->getFile()) { CompileUnit *FileUnit = FindCompileUnit(File); unsigned FileID = FileUnit->getID(); int Line = TyDesc->getLine(); Ty->AddUInt(DW_AT_decl_file, 0, FileID); Ty->AddUInt(DW_AT_decl_line, 0, Line); } // Add to context owner. Context->AddChild(Ty); return Slot; } /// NewCompileUnit - Create new compile unit and it's die. /// CompileUnit *DwarfWriter::NewCompileUnit(CompileUnitDesc *UnitDesc, unsigned ID) { // Construct debug information entry. DIE *Die = new DIE(DW_TAG_compile_unit); Die->AddLabel (DW_AT_stmt_list, DW_FORM_data4, DWLabel("line", 0)); Die->AddLabel (DW_AT_high_pc, DW_FORM_addr, DWLabel("text_end", 0)); Die->AddLabel (DW_AT_low_pc, DW_FORM_addr, DWLabel("text_begin", 0)); Die->AddString(DW_AT_producer, DW_FORM_string, UnitDesc->getProducer()); Die->AddUInt (DW_AT_language, DW_FORM_data1, UnitDesc->getLanguage()); Die->AddString(DW_AT_name, DW_FORM_string, UnitDesc->getFileName()); Die->AddString(DW_AT_comp_dir, DW_FORM_string, UnitDesc->getDirectory()); // Add die to descriptor map. DescToDieMap[UnitDesc] = Die; // Construct compile unit. CompileUnit *Unit = new CompileUnit(UnitDesc, ID, Die); // Add Unit to compile unit map. DescToUnitMap[UnitDesc] = Unit; return Unit; } /// FindCompileUnit - Get the compile unit for the given descriptor. /// CompileUnit *DwarfWriter::FindCompileUnit(CompileUnitDesc *UnitDesc) { CompileUnit *Unit = DescToUnitMap[UnitDesc]; assert(Unit && "Missing compile unit."); return Unit; } /// NewGlobalVariable - Add a new global variable DIE. /// DIE *DwarfWriter::NewGlobalVariable(GlobalVariableDesc *GVD) { // Check for pre-existence. DIE *&Slot = DescToDieMap[GVD]; if (Slot) return Slot; // Get the compile unit context. CompileUnitDesc *UnitDesc = static_cast(GVD->getContext()); CompileUnit *Unit = FindCompileUnit(UnitDesc); // Get the global variable itself. GlobalVariable *GV = GVD->getGlobalVariable(); // Generate the mangled name. std::string MangledName = Asm->Mang->getValueName(GV); // Gather the details (simplify add attribute code.) const std::string &Name = GVD->getName(); unsigned FileID = Unit->getID(); unsigned Line = GVD->getLine(); // Get the global's type. DIE *Type = NewType(Unit->getDie(), GVD->getTypeDesc()); // Create the globale variable DIE. DIE *VariableDie = new DIE(DW_TAG_variable); VariableDie->AddString (DW_AT_name, DW_FORM_string, Name); VariableDie->AddUInt (DW_AT_decl_file, 0, FileID); VariableDie->AddUInt (DW_AT_decl_line, 0, Line); VariableDie->AddDIEntry (DW_AT_type, DW_FORM_ref4, Type); VariableDie->AddUInt (DW_AT_external, DW_FORM_flag, 1); DIEBlock *Block = new DIEBlock(); Block->AddUInt(DW_FORM_data1, DW_OP_addr); Block->AddObjectLabel(DW_FORM_udata, MangledName); Block->ComputeSize(*this); VariableDie->AddBlock(DW_AT_location, 0, Block); // Add to map. Slot = VariableDie; // Add to context owner. Unit->getDie()->AddChild(VariableDie); // Expose as global. // FIXME - need to check external flag. Unit->AddGlobal(Name, VariableDie); return VariableDie; } /// NewSubprogram - Add a new subprogram DIE. /// DIE *DwarfWriter::NewSubprogram(SubprogramDesc *SPD) { // Check for pre-existence. DIE *&Slot = DescToDieMap[SPD]; if (Slot) return Slot; // Get the compile unit context. CompileUnitDesc *UnitDesc = static_cast(SPD->getContext()); CompileUnit *Unit = FindCompileUnit(UnitDesc); // Gather the details (simplify add attribute code.) const std::string &Name = SPD->getName(); unsigned FileID = Unit->getID(); // FIXME - faking the line for the time being. unsigned Line = 1; // FIXME - faking the type for the time being. DIE *Type = NewBasicType(Unit->getDie(), Type::IntTy); DIE *SubprogramDie = new DIE(DW_TAG_subprogram); SubprogramDie->AddString (DW_AT_name, DW_FORM_string, Name); SubprogramDie->AddUInt (DW_AT_decl_file, 0, FileID); SubprogramDie->AddUInt (DW_AT_decl_line, 0, Line); SubprogramDie->AddDIEntry (DW_AT_type, DW_FORM_ref4, Type); SubprogramDie->AddUInt (DW_AT_external, DW_FORM_flag, 1); // Add to map. Slot = SubprogramDie; // Add to context owner. Unit->getDie()->AddChild(SubprogramDie); // Expose as global. Unit->AddGlobal(Name, SubprogramDie); return SubprogramDie; } /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc /// tools to recognize the object file contains Dwarf information. /// void DwarfWriter::EmitInitial() const { // Dwarf sections base addresses. Asm->SwitchSection(DwarfFrameSection, 0); EmitLabel("section_frame", 0); Asm->SwitchSection(DwarfInfoSection, 0); EmitLabel("section_info", 0); EmitLabel("info", 0); Asm->SwitchSection(DwarfAbbrevSection, 0); EmitLabel("section_abbrev", 0); EmitLabel("abbrev", 0); Asm->SwitchSection(DwarfARangesSection, 0); EmitLabel("section_aranges", 0); Asm->SwitchSection(DwarfMacInfoSection, 0); EmitLabel("section_macinfo", 0); Asm->SwitchSection(DwarfLineSection, 0); EmitLabel("section_line", 0); EmitLabel("line", 0); Asm->SwitchSection(DwarfLocSection, 0); EmitLabel("section_loc", 0); Asm->SwitchSection(DwarfPubNamesSection, 0); EmitLabel("section_pubnames", 0); Asm->SwitchSection(DwarfStrSection, 0); EmitLabel("section_str", 0); Asm->SwitchSection(DwarfRangesSection, 0); EmitLabel("section_ranges", 0); Asm->SwitchSection(TextSection, 0); EmitLabel("text_begin", 0); Asm->SwitchSection(DataSection, 0); EmitLabel("data_begin", 0); } /// EmitDIE - Recusively Emits a debug information entry. /// void DwarfWriter::EmitDIE(DIE *Die) const { // Get the abbreviation for this DIE. unsigned AbbrevID = Die->getAbbrevID(); const DIEAbbrev &Abbrev = Abbreviations[AbbrevID]; O << "\n"; // Emit the code (index) for the abbreviation. EmitULEB128Bytes(AbbrevID); EOL(std::string("Abbrev [" + utostr(AbbrevID) + "] 0x" + utohexstr(Die->getOffset()) + ":0x" + utohexstr(Die->getSize()) + " " + TagString(Abbrev.getTag()))); const std::vector &Values = Die->getValues(); const std::vector &AbbrevData = Abbrev.getData(); // Emit the DIE attribute values. for (unsigned i = 0, N = Values.size(); i < N; ++i) { unsigned Attr = AbbrevData[i].getAttribute(); unsigned Form = AbbrevData[i].getForm(); assert(Form && "Too many attributes for DIE (check abbreviation)"); switch (Attr) { case DW_AT_sibling: { EmitInt32(Die->SiblingOffset()); break; } default: { // Emit an attribute using the defined form. Values[i]->EmitValue(*this, Form); break; } } EOL(AttributeString(Attr)); } // Emit the DIE children if any. if (Abbrev.getChildrenFlag() == DW_CHILDREN_yes) { const std::vector &Children = Die->getChildren(); for (unsigned j = 0, M = Children.size(); j < M; ++j) { // FIXME - handle sibling offsets. // FIXME - handle all DIE types. EmitDIE(Children[j]); } EmitInt8(0); EOL("End Of Children Mark"); } } /// SizeAndOffsetDie - Compute the size and offset of a DIE. /// unsigned DwarfWriter::SizeAndOffsetDie(DIE *Die, unsigned Offset) { // Record the abbreviation. Die->Complete(*this); // Get the abbreviation for this DIE. unsigned AbbrevID = Die->getAbbrevID(); const DIEAbbrev &Abbrev = Abbreviations[AbbrevID]; // Set DIE offset Die->setOffset(Offset); // Start the size with the size of abbreviation code. Offset += SizeULEB128(AbbrevID); const std::vector &Values = Die->getValues(); const std::vector &AbbrevData = Abbrev.getData(); // Emit the DIE attribute values. for (unsigned i = 0, N = Values.size(); i < N; ++i) { // Size attribute value. Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm()); } // Emit the DIE children if any. if (Abbrev.getChildrenFlag() == DW_CHILDREN_yes) { const std::vector &Children = Die->getChildren(); for (unsigned j = 0, M = Children.size(); j < M; ++j) { // FIXME - handle sibling offsets. // FIXME - handle all DIE types. Offset = SizeAndOffsetDie(Children[j], Offset); } // End of children marker. Offset += sizeof(int8_t); } Die->setSize(Offset - Die->getOffset()); return Offset; } /// SizeAndOffsets - Compute the size and offset of all the DIEs. /// void DwarfWriter::SizeAndOffsets() { // Process each compile unit. for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) { CompileUnit *Unit = CompileUnits[i]; if (Unit->hasContent()) { // Compute size of compile unit header unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info sizeof(int16_t) + // DWARF version number sizeof(int32_t) + // Offset Into Abbrev. Section sizeof(int8_t); // Pointer Size (in bytes) SizeAndOffsetDie(Unit->getDie(), Offset); } } } /// EmitDebugInfo - Emit the debug info section. /// void DwarfWriter::EmitDebugInfo() const { // Start debug info section. Asm->SwitchSection(DwarfInfoSection, 0); // Process each compile unit. for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) { CompileUnit *Unit = CompileUnits[i]; if (Unit->hasContent()) { DIE *Die = Unit->getDie(); // Emit the compile units header. EmitLabel("info_begin", Unit->getID()); // Emit size of content not including length itself unsigned ContentSize = Die->getSize() + sizeof(int16_t) + // DWARF version number sizeof(int32_t) + // Offset Into Abbrev. Section sizeof(int8_t); // Pointer Size (in bytes) EmitInt32(ContentSize); EOL("Length of Compilation Unit Info"); EmitInt16(DWARF_VERSION); EOL("DWARF version number"); EmitReference("abbrev_begin", 0); EOL("Offset Into Abbrev. Section"); EmitInt8(AddressSize); EOL("Address Size (in bytes)"); EmitDIE(Die); EmitLabel("info_end", Unit->getID()); } O << "\n"; } } /// EmitAbbreviations - Emit the abbreviation section. /// void DwarfWriter::EmitAbbreviations() const { // Check to see if it is worth the effort. if (!Abbreviations.empty()) { // Start the debug abbrev section. Asm->SwitchSection(DwarfAbbrevSection, 0); EmitLabel("abbrev_begin", 0); // For each abbrevation. for (unsigned AbbrevID = 1, NAID = Abbreviations.size(); AbbrevID <= NAID; ++AbbrevID) { // Get abbreviation data const DIEAbbrev &Abbrev = Abbreviations[AbbrevID]; // Emit the abbrevations code (base 1 index.) EmitULEB128Bytes(AbbrevID); EOL("Abbreviation Code"); // Emit the abbreviations data. Abbrev.Emit(*this); O << "\n"; } EmitLabel("abbrev_end", 0); O << "\n"; } } /// EmitDebugLines - Emit source line information. /// void DwarfWriter::EmitDebugLines() const { // Minimum line delta, thus ranging from -10..(255-10). const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1); // Maximum line delta, thus ranging from -10..(255-10). const int MaxLineDelta = 255 + MinLineDelta; // Start the dwarf line section. Asm->SwitchSection(DwarfLineSection, 0); // Construct the section header. EmitDifference("line_end", 0, "line_begin", 0); EOL("Length of Source Line Info"); EmitLabel("line_begin", 0); EmitInt16(DWARF_VERSION); EOL("DWARF version number"); EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0); EOL("Prolog Length"); EmitLabel("line_prolog_begin", 0); EmitInt8(1); EOL("Minimum Instruction Length"); EmitInt8(1); EOL("Default is_stmt_start flag"); EmitInt8(MinLineDelta); EOL("Line Base Value (Special Opcodes)"); EmitInt8(MaxLineDelta); EOL("Line Range Value (Special Opcodes)"); EmitInt8(-MinLineDelta); EOL("Special Opcode Base"); // Line number standard opcode encodings argument count EmitInt8(0); EOL("DW_LNS_copy arg count"); EmitInt8(1); EOL("DW_LNS_advance_pc arg count"); EmitInt8(1); EOL("DW_LNS_advance_line arg count"); EmitInt8(1); EOL("DW_LNS_set_file arg count"); EmitInt8(1); EOL("DW_LNS_set_column arg count"); EmitInt8(0); EOL("DW_LNS_negate_stmt arg count"); EmitInt8(0); EOL("DW_LNS_set_basic_block arg count"); EmitInt8(0); EOL("DW_LNS_const_add_pc arg count"); EmitInt8(1); EOL("DW_LNS_fixed_advance_pc arg count"); const UniqueVector &Directories = DebugInfo->getDirectories(); const UniqueVector &SourceFiles = DebugInfo->getSourceFiles(); // Emit directories. for (unsigned DirectoryID = 1, NDID = Directories.size(); DirectoryID <= NDID; ++DirectoryID) { EmitString(Directories[DirectoryID]); EOL("Directory"); } EmitInt8(0); EOL("End of directories"); // Emit files. for (unsigned SourceID = 1, NSID = SourceFiles.size(); SourceID <= NSID; ++SourceID) { const SourceFileInfo &SourceFile = SourceFiles[SourceID]; EmitString(SourceFile.getName()); EOL("Source"); EmitULEB128Bytes(SourceFile.getDirectoryID()); EOL("Directory #"); EmitULEB128Bytes(0); EOL("Mod date"); EmitULEB128Bytes(0); EOL("File size"); } EmitInt8(0); EOL("End of files"); EmitLabel("line_prolog_end", 0); // Emit line information const std::vector &LineInfos = DebugInfo->getSourceLines(); // Dwarf assumes we start with first line of first source file. unsigned Source = 1; unsigned Line = 1; // Construct rows of the address, source, line, column matrix. for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) { SourceLineInfo *LineInfo = LineInfos[i]; if (DwarfVerbose) { unsigned SourceID = LineInfo->getSourceID(); const SourceFileInfo &SourceFile = SourceFiles[SourceID]; unsigned DirectoryID = SourceFile.getDirectoryID(); O << "\t" << Asm->CommentString << " " << Directories[DirectoryID] << SourceFile.getName() << ":" << LineInfo->getLine() << "\n"; } // Define the line address. EmitInt8(0); EOL("Extended Op"); EmitInt8(4 + 1); EOL("Op size"); EmitInt8(DW_LNE_set_address); EOL("DW_LNE_set_address"); EmitReference("loc", i + 1); EOL("Location label"); // If change of source, then switch to the new source. if (Source != LineInfo->getSourceID()) { Source = LineInfo->getSourceID(); EmitInt8(DW_LNS_set_file); EOL("DW_LNS_set_file"); EmitULEB128Bytes(Source); EOL("New Source"); } // If change of line. if (Line != LineInfo->getLine()) { // Determine offset. int Offset = LineInfo->getLine() - Line; int Delta = Offset - MinLineDelta; // Update line. Line = LineInfo->getLine(); // If delta is small enough and in range... if (Delta >= 0 && Delta < (MaxLineDelta - 1)) { // ... then use fast opcode. EmitInt8(Delta - MinLineDelta); EOL("Line Delta"); } else { // ... otherwise use long hand. EmitInt8(DW_LNS_advance_line); EOL("DW_LNS_advance_line"); EmitSLEB128Bytes(Offset); EOL("Line Offset"); EmitInt8(DW_LNS_copy); EOL("DW_LNS_copy"); } } else { // Copy the previous row (different address or source) EmitInt8(DW_LNS_copy); EOL("DW_LNS_copy"); } } // Define last address. EmitInt8(0); EOL("Extended Op"); EmitInt8(4 + 1); EOL("Op size"); EmitInt8(DW_LNE_set_address); EOL("DW_LNE_set_address"); EmitReference("text_end", 0); EOL("Location label"); // Mark end of matrix. EmitInt8(0); EOL("DW_LNE_end_sequence"); EmitULEB128Bytes(1); O << "\n"; EmitInt8(1); O << "\n"; EmitLabel("line_end", 0); O << "\n"; } /// EmitDebugFrame - Emit visible names into a debug frame section. /// void DwarfWriter::EmitDebugFrame() { // FIXME - Should be per frame } /// EmitDebugPubNames - Emit visible names into a debug pubnames section. /// void DwarfWriter::EmitDebugPubNames() { // Start the dwarf pubnames section. Asm->SwitchSection(DwarfPubNamesSection, 0); // Process each compile unit. for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) { CompileUnit *Unit = CompileUnits[i]; if (Unit->hasContent()) { EmitDifference("pubnames_end", Unit->getID(), "pubnames_begin", Unit->getID()); EOL("Length of Public Names Info"); EmitLabel("pubnames_begin", Unit->getID()); EmitInt16(DWARF_VERSION); EOL("DWARF Version"); EmitReference("info_begin", Unit->getID()); EOL("Offset of Compilation Unit Info"); EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID()); EOL("Compilation Unit Length"); std::map &Globals = Unit->getGlobals(); for (std::map::iterator GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) { const std::string &Name = GI->first; DIE * Entity = GI->second; EmitInt32(Entity->getOffset()); EOL("DIE offset"); EmitString(Name); EOL("External Name"); } EmitInt32(0); EOL("End Mark"); EmitLabel("pubnames_end", Unit->getID()); O << "\n"; } } } /// EmitDebugStr - Emit visible names into a debug str section. /// void DwarfWriter::EmitDebugStr() { // Check to see if it is worth the effort. if (!StringPool.empty()) { // Start the dwarf str section. Asm->SwitchSection(DwarfStrSection, 0); // For each of strings in teh string pool. for (unsigned StringID = 1, N = StringPool.size(); StringID <= N; ++StringID) { // Emit a label for reference from debug information entries. EmitLabel("string", StringID); // Emit the string itself. const std::string &String = StringPool[StringID]; EmitString(String); O << "\n"; } O << "\n"; } } /// EmitDebugLoc - Emit visible names into a debug loc section. /// void DwarfWriter::EmitDebugLoc() { // Start the dwarf loc section. Asm->SwitchSection(DwarfLocSection, 0); O << "\n"; } /// EmitDebugARanges - Emit visible names into a debug aranges section. /// void DwarfWriter::EmitDebugARanges() { // Start the dwarf aranges section. Asm->SwitchSection(DwarfARangesSection, 0); // FIXME - Mock up #if 0 // Process each compile unit. for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) { CompileUnit *Unit = CompileUnits[i]; if (Unit->hasContent()) { // Don't include size of length EmitInt32(0x1c); EOL("Length of Address Ranges Info"); EmitInt16(DWARF_VERSION); EOL("Dwarf Version"); EmitReference("info_begin", Unit->getID()); EOL("Offset of Compilation Unit Info"); EmitInt8(AddressSize); EOL("Size of Address"); EmitInt8(0); EOL("Size of Segment Descriptor"); EmitInt16(0); EOL("Pad (1)"); EmitInt16(0); EOL("Pad (2)"); // Range 1 EmitReference("text_begin", 0); EOL("Address"); EmitDifference("text_end", 0, "text_begin", 0); EOL("Length"); EmitInt32(0); EOL("EOM (1)"); EmitInt32(0); EOL("EOM (2)"); O << "\n"; } } #endif } /// EmitDebugRanges - Emit visible names into a debug ranges section. /// void DwarfWriter::EmitDebugRanges() { // Start the dwarf ranges section. Asm->SwitchSection(DwarfRangesSection, 0); O << "\n"; } /// EmitDebugMacInfo - Emit visible names into a debug macinfo section. /// void DwarfWriter::EmitDebugMacInfo() { // Start the dwarf macinfo section. Asm->SwitchSection(DwarfMacInfoSection, 0); O << "\n"; } /// ConstructCompileUnitDIEs - Create a compile unit DIE for each source and /// header file. void DwarfWriter::ConstructCompileUnitDIEs() { const UniqueVector CUW = DebugInfo->getCompileUnits(); for (unsigned i = 1, N = CUW.size(); i <= N; ++i) { CompileUnit *Unit = NewCompileUnit(CUW[i], i); CompileUnits.push_back(Unit); } } /// ConstructGlobalDIEs - Create DIEs for each of the externally visible global /// variables. void DwarfWriter::ConstructGlobalDIEs(Module &M) { std::vector GlobalVariables = DebugInfo->getAnchoredDescriptors(M); for (unsigned i = 0, N = GlobalVariables.size(); i < N; ++i) { GlobalVariableDesc *GVD = GlobalVariables[i]; NewGlobalVariable(GVD); } } /// ConstructSubprogramDIEs - Create DIEs for each of the externally visible /// subprograms. void DwarfWriter::ConstructSubprogramDIEs(Module &M) { std::vector Subprograms = DebugInfo->getAnchoredDescriptors(M); for (unsigned i = 0, N = Subprograms.size(); i < N; ++i) { SubprogramDesc *SPD = Subprograms[i]; NewSubprogram(SPD); } } /// ShouldEmitDwarf - Determine if Dwarf declarations should be made. /// bool DwarfWriter::ShouldEmitDwarf() { // Check if debug info is present. if (!DebugInfo || !DebugInfo->hasInfo()) return false; // Make sure initial declarations are made. if (!didInitial) { EmitInitial(); didInitial = true; } // Okay to emit. return true; } //===----------------------------------------------------------------------===// // Main entry points. // DwarfWriter::DwarfWriter(std::ostream &OS, AsmPrinter *A) : O(OS) , Asm(A) , DebugInfo(NULL) , didInitial(false) , CompileUnits() , Abbreviations() , StringPool() , DescToUnitMap() , DescToDieMap() , TypeToDieMap() , AddressSize(sizeof(int32_t)) , hasLEB128(false) , hasDotLoc(false) , hasDotFile(false) , needsSet(false) , DwarfAbbrevSection(".debug_abbrev") , DwarfInfoSection(".debug_info") , DwarfLineSection(".debug_line") , DwarfFrameSection(".debug_frame") , DwarfPubNamesSection(".debug_pubnames") , DwarfPubTypesSection(".debug_pubtypes") , DwarfStrSection(".debug_str") , DwarfLocSection(".debug_loc") , DwarfARangesSection(".debug_aranges") , DwarfRangesSection(".debug_ranges") , DwarfMacInfoSection(".debug_macinfo") , TextSection(".text") , DataSection(".data") {} DwarfWriter::~DwarfWriter() { for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) { delete CompileUnits[i]; } } /// BeginModule - Emit all Dwarf sections that should come prior to the content. /// void DwarfWriter::BeginModule(Module &M) { if (!ShouldEmitDwarf()) return; EOL("Dwarf Begin Module"); } /// EndModule - Emit all Dwarf sections that should come after the content. /// void DwarfWriter::EndModule(Module &M) { if (!ShouldEmitDwarf()) return; EOL("Dwarf End Module"); // Standard sections final addresses. Asm->SwitchSection(TextSection, 0); EmitLabel("text_end", 0); Asm->SwitchSection(DataSection, 0); EmitLabel("data_end", 0); // Create all the compile unit DIEs. ConstructCompileUnitDIEs(); // Create DIEs for each of the externally visible global variables. ConstructGlobalDIEs(M); // Create DIEs for each of the externally visible subprograms. ConstructSubprogramDIEs(M); // Compute DIE offsets and sizes. SizeAndOffsets(); // Emit all the DIEs into a debug info section EmitDebugInfo(); // Corresponding abbreviations into a abbrev section. EmitAbbreviations(); // Emit source line correspondence into a debug line section. EmitDebugLines(); // Emit info into a debug frame section. // EmitDebugFrame(); // Emit info into a debug pubnames section. EmitDebugPubNames(); // Emit info into a debug str section. EmitDebugStr(); // Emit info into a debug loc section. EmitDebugLoc(); // Emit info into a debug aranges section. EmitDebugARanges(); // Emit info into a debug ranges section. EmitDebugRanges(); // Emit info into a debug macinfo section. EmitDebugMacInfo(); } /// BeginFunction - Gather pre-function debug information. /// void DwarfWriter::BeginFunction(MachineFunction &MF) { if (!ShouldEmitDwarf()) return; EOL("Dwarf Begin Function"); } /// EndFunction - Gather and emit post-function debug information. /// void DwarfWriter::EndFunction(MachineFunction &MF) { if (!ShouldEmitDwarf()) return; EOL("Dwarf End Function"); }