1 //===-- llvm/CodeGen/DwarfWriter.cpp - Dwarf Framework ----------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains support for writing dwarf info into asm files.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/CodeGen/DwarfWriter.h"
15 #include "llvm/Module.h"
16 #include "llvm/DerivedTypes.h"
17 #include "llvm/Constants.h"
18 #include "llvm/CodeGen/AsmPrinter.h"
19 #include "llvm/CodeGen/MachineModuleInfo.h"
20 #include "llvm/CodeGen/MachineFrameInfo.h"
21 #include "llvm/CodeGen/MachineLocation.h"
22 #include "llvm/Analysis/DebugInfo.h"
23 #include "llvm/Support/Debug.h"
24 #include "llvm/Support/Dwarf.h"
25 #include "llvm/Support/CommandLine.h"
26 #include "llvm/Support/DataTypes.h"
27 #include "llvm/Support/Mangler.h"
28 #include "llvm/Support/Timer.h"
29 #include "llvm/Support/raw_ostream.h"
30 #include "llvm/System/Path.h"
31 #include "llvm/Target/TargetAsmInfo.h"
32 #include "llvm/Target/TargetRegisterInfo.h"
33 #include "llvm/Target/TargetData.h"
34 #include "llvm/Target/TargetFrameInfo.h"
35 #include "llvm/Target/TargetInstrInfo.h"
36 #include "llvm/Target/TargetMachine.h"
37 #include "llvm/Target/TargetOptions.h"
38 #include "llvm/ADT/DenseMap.h"
39 #include "llvm/ADT/FoldingSet.h"
40 #include "llvm/ADT/StringExtras.h"
41 #include "llvm/ADT/StringMap.h"
45 using namespace llvm::dwarf;
47 static RegisterPass<DwarfWriter>
48 X("dwarfwriter", "DWARF Information Writer");
49 char DwarfWriter::ID = 0;
51 static TimerGroup &getDwarfTimerGroup() {
52 static TimerGroup DwarfTimerGroup("Dwarf Exception and Debugging");
53 return DwarfTimerGroup;
58 //===----------------------------------------------------------------------===//
60 /// Configuration values for initial hash set sizes (log2).
62 static const unsigned InitDiesSetSize = 9; // log2(512)
63 static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
64 static const unsigned InitValuesSetSize = 9; // log2(512)
66 //===----------------------------------------------------------------------===//
67 /// Forward declarations.
72 //===----------------------------------------------------------------------===//
75 /// getGlobalVariable - Return either a direct or cast Global value.
77 static GlobalVariable *getGlobalVariable(Value *V) {
78 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
80 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
81 if (CE->getOpcode() == Instruction::BitCast) {
82 return dyn_cast<GlobalVariable>(CE->getOperand(0));
83 } else if (CE->getOpcode() == Instruction::GetElementPtr) {
84 for (unsigned int i=1; i<CE->getNumOperands(); i++) {
85 if (!CE->getOperand(i)->isNullValue())
88 return dyn_cast<GlobalVariable>(CE->getOperand(0));
94 //===----------------------------------------------------------------------===//
95 /// DWLabel - Labels are used to track locations in the assembler file.
96 /// Labels appear in the form @verbatim <prefix><Tag><Number> @endverbatim,
97 /// where the tag is a category of label (Ex. location) and number is a value
98 /// unique in that category.
101 /// Tag - Label category tag. Should always be a staticly declared C string.
105 /// Number - Value to make label unique.
109 DWLabel(const char *T, unsigned N) : Tag(T), Number(N) {}
111 void Profile(FoldingSetNodeID &ID) const {
113 ID.AddInteger(Number);
117 void print(std::ostream *O) const {
120 void print(std::ostream &O) const {
122 if (Number) O << Number;
127 //===----------------------------------------------------------------------===//
128 /// DIEAbbrevData - Dwarf abbreviation data, describes the one attribute of a
129 /// Dwarf abbreviation.
130 class DIEAbbrevData {
131 /// Attribute - Dwarf attribute code.
135 /// Form - Dwarf form code.
139 DIEAbbrevData(unsigned A, unsigned F) : Attribute(A), Form(F) {}
142 unsigned getAttribute() const { return Attribute; }
143 unsigned getForm() const { return Form; }
145 /// Profile - Used to gather unique data for the abbreviation folding set.
147 void Profile(FoldingSetNodeID &ID)const {
148 ID.AddInteger(Attribute);
153 //===----------------------------------------------------------------------===//
154 /// DIEAbbrev - Dwarf abbreviation, describes the organization of a debug
155 /// information object.
156 class DIEAbbrev : public FoldingSetNode {
158 /// Tag - Dwarf tag code.
162 /// Unique number for node.
166 /// ChildrenFlag - Dwarf children flag.
168 unsigned ChildrenFlag;
170 /// Data - Raw data bytes for abbreviation.
172 SmallVector<DIEAbbrevData, 8> Data;
174 DIEAbbrev(unsigned T, unsigned C) : Tag(T), ChildrenFlag(C), Data() {}
175 virtual ~DIEAbbrev() {}
178 unsigned getTag() const { return Tag; }
179 unsigned getNumber() const { return Number; }
180 unsigned getChildrenFlag() const { return ChildrenFlag; }
181 const SmallVector<DIEAbbrevData, 8> &getData() const { return Data; }
182 void setTag(unsigned T) { Tag = T; }
183 void setChildrenFlag(unsigned CF) { ChildrenFlag = CF; }
184 void setNumber(unsigned N) { Number = N; }
186 /// AddAttribute - Adds another set of attribute information to the
188 void AddAttribute(unsigned Attribute, unsigned Form) {
189 Data.push_back(DIEAbbrevData(Attribute, Form));
192 /// AddFirstAttribute - Adds a set of attribute information to the front
193 /// of the abbreviation.
194 void AddFirstAttribute(unsigned Attribute, unsigned Form) {
195 Data.insert(Data.begin(), DIEAbbrevData(Attribute, Form));
198 /// Profile - Used to gather unique data for the abbreviation folding set.
200 void Profile(FoldingSetNodeID &ID) {
202 ID.AddInteger(ChildrenFlag);
204 // For each attribute description.
205 for (unsigned i = 0, N = Data.size(); i < N; ++i)
209 /// Emit - Print the abbreviation using the specified Dwarf writer.
211 void Emit(const DwarfDebug &DD) const;
214 void print(std::ostream *O) {
217 void print(std::ostream &O);
222 //===----------------------------------------------------------------------===//
223 /// DIE - A structured debug information entry. Has an abbreviation which
224 /// describes it's organization.
225 class DIE : public FoldingSetNode {
227 /// Abbrev - Buffer for constructing abbreviation.
231 /// Offset - Offset in debug info section.
235 /// Size - Size of instance + children.
241 std::vector<DIE *> Children;
243 /// Attributes values.
245 SmallVector<DIEValue*, 32> Values;
248 explicit DIE(unsigned Tag)
249 : Abbrev(Tag, DW_CHILDREN_no), Offset(0), Size(0), Children(), Values() {}
253 DIEAbbrev &getAbbrev() { return Abbrev; }
254 unsigned getAbbrevNumber() const {
255 return Abbrev.getNumber();
257 unsigned getTag() const { return Abbrev.getTag(); }
258 unsigned getOffset() const { return Offset; }
259 unsigned getSize() const { return Size; }
260 const std::vector<DIE *> &getChildren() const { return Children; }
261 SmallVector<DIEValue*, 32> &getValues() { return Values; }
262 void setTag(unsigned Tag) { Abbrev.setTag(Tag); }
263 void setOffset(unsigned O) { Offset = O; }
264 void setSize(unsigned S) { Size = S; }
266 /// AddValue - Add a value and attributes to a DIE.
268 void AddValue(unsigned Attribute, unsigned Form, DIEValue *Value) {
269 Abbrev.AddAttribute(Attribute, Form);
270 Values.push_back(Value);
273 /// SiblingOffset - Return the offset of the debug information entry's
275 unsigned SiblingOffset() const { return Offset + Size; }
277 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
279 void AddSiblingOffset();
281 /// AddChild - Add a child to the DIE.
283 void AddChild(DIE *Child) {
284 Abbrev.setChildrenFlag(DW_CHILDREN_yes);
285 Children.push_back(Child);
288 /// Detach - Detaches objects connected to it after copying.
294 /// Profile - Used to gather unique data for the value folding set.
296 void Profile(FoldingSetNodeID &ID) ;
299 void print(std::ostream *O, unsigned IncIndent = 0) {
300 if (O) print(*O, IncIndent);
302 void print(std::ostream &O, unsigned IncIndent = 0);
307 //===----------------------------------------------------------------------===//
308 /// DIEValue - A debug information entry value.
310 class DIEValue : public FoldingSetNode {
323 /// Type - Type of data stored in the value.
327 explicit DIEValue(unsigned T) : Type(T) {}
328 virtual ~DIEValue() {}
331 unsigned getType() const { return Type; }
333 // Implement isa/cast/dyncast.
334 static bool classof(const DIEValue *) { return true; }
336 /// EmitValue - Emit value via the Dwarf writer.
338 virtual void EmitValue(DwarfDebug &DD, unsigned Form) = 0;
340 /// SizeOf - Return the size of a value in bytes.
342 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const = 0;
344 /// Profile - Used to gather unique data for the value folding set.
346 virtual void Profile(FoldingSetNodeID &ID) = 0;
349 void print(std::ostream *O) {
352 virtual void print(std::ostream &O) = 0;
357 //===----------------------------------------------------------------------===//
358 /// DWInteger - An integer value DIE.
360 class DIEInteger : public DIEValue {
365 explicit DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
367 // Implement isa/cast/dyncast.
368 static bool classof(const DIEInteger *) { return true; }
369 static bool classof(const DIEValue *I) { return I->Type == isInteger; }
371 /// BestForm - Choose the best form for integer.
373 static unsigned BestForm(bool IsSigned, uint64_t Integer) {
375 if ((char)Integer == (signed)Integer) return DW_FORM_data1;
376 if ((short)Integer == (signed)Integer) return DW_FORM_data2;
377 if ((int)Integer == (signed)Integer) return DW_FORM_data4;
379 if ((unsigned char)Integer == Integer) return DW_FORM_data1;
380 if ((unsigned short)Integer == Integer) return DW_FORM_data2;
381 if ((unsigned int)Integer == Integer) return DW_FORM_data4;
383 return DW_FORM_data8;
386 /// EmitValue - Emit integer of appropriate size.
388 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
390 /// SizeOf - Determine size of integer value in bytes.
392 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
394 /// Profile - Used to gather unique data for the value folding set.
396 static void Profile(FoldingSetNodeID &ID, unsigned Integer) {
397 ID.AddInteger(isInteger);
398 ID.AddInteger(Integer);
400 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Integer); }
403 virtual void print(std::ostream &O) {
404 O << "Int: " << (int64_t)Integer
405 << " 0x" << std::hex << Integer << std::dec;
410 //===----------------------------------------------------------------------===//
411 /// DIEString - A string value DIE.
413 class DIEString : public DIEValue {
414 const std::string Str;
416 explicit DIEString(const std::string &S) : DIEValue(isString), Str(S) {}
418 // Implement isa/cast/dyncast.
419 static bool classof(const DIEString *) { return true; }
420 static bool classof(const DIEValue *S) { return S->Type == isString; }
422 /// EmitValue - Emit string value.
424 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
426 /// SizeOf - Determine size of string value in bytes.
428 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
429 return Str.size() + sizeof(char); // sizeof('\0');
432 /// Profile - Used to gather unique data for the value folding set.
434 static void Profile(FoldingSetNodeID &ID, const std::string &Str) {
435 ID.AddInteger(isString);
438 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Str); }
441 virtual void print(std::ostream &O) {
442 O << "Str: \"" << Str << "\"";
447 //===----------------------------------------------------------------------===//
448 /// DIEDwarfLabel - A Dwarf internal label expression DIE.
450 class DIEDwarfLabel : public DIEValue {
453 explicit DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {}
455 // Implement isa/cast/dyncast.
456 static bool classof(const DIEDwarfLabel *) { return true; }
457 static bool classof(const DIEValue *L) { return L->Type == isLabel; }
459 /// EmitValue - Emit label value.
461 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
463 /// SizeOf - Determine size of label value in bytes.
465 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
467 /// Profile - Used to gather unique data for the value folding set.
469 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label) {
470 ID.AddInteger(isLabel);
473 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
476 virtual void print(std::ostream &O) {
483 //===----------------------------------------------------------------------===//
484 /// DIEObjectLabel - A label to an object in code or data.
486 class DIEObjectLabel : public DIEValue {
487 const std::string Label;
489 explicit DIEObjectLabel(const std::string &L)
490 : DIEValue(isAsIsLabel), Label(L) {}
492 // Implement isa/cast/dyncast.
493 static bool classof(const DIEObjectLabel *) { return true; }
494 static bool classof(const DIEValue *L) { return L->Type == isAsIsLabel; }
496 /// EmitValue - Emit label value.
498 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
500 /// SizeOf - Determine size of label value in bytes.
502 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
504 /// Profile - Used to gather unique data for the value folding set.
506 static void Profile(FoldingSetNodeID &ID, const std::string &Label) {
507 ID.AddInteger(isAsIsLabel);
510 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label.c_str()); }
513 virtual void print(std::ostream &O) {
514 O << "Obj: " << Label;
519 //===----------------------------------------------------------------------===//
520 /// DIESectionOffset - A section offset DIE.
522 class DIESectionOffset : public DIEValue {
524 const DWLabel Section;
528 DIESectionOffset(const DWLabel &Lab, const DWLabel &Sec,
529 bool isEH = false, bool useSet = true)
530 : DIEValue(isSectionOffset), Label(Lab), Section(Sec),
531 IsEH(isEH), UseSet(useSet) {}
533 // Implement isa/cast/dyncast.
534 static bool classof(const DIESectionOffset *) { return true; }
535 static bool classof(const DIEValue *D) { return D->Type == isSectionOffset; }
537 /// EmitValue - Emit section offset.
539 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
541 /// SizeOf - Determine size of section offset value in bytes.
543 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
545 /// Profile - Used to gather unique data for the value folding set.
547 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label,
548 const DWLabel &Section) {
549 ID.AddInteger(isSectionOffset);
552 // IsEH and UseSet are specific to the Label/Section that we will emit
553 // the offset for; so Label/Section are enough for uniqueness.
555 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label, Section); }
558 virtual void print(std::ostream &O) {
563 O << "-" << IsEH << "-" << UseSet;
568 //===----------------------------------------------------------------------===//
569 /// DIEDelta - A simple label difference DIE.
571 class DIEDelta : public DIEValue {
572 const DWLabel LabelHi;
573 const DWLabel LabelLo;
575 DIEDelta(const DWLabel &Hi, const DWLabel &Lo)
576 : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
578 // Implement isa/cast/dyncast.
579 static bool classof(const DIEDelta *) { return true; }
580 static bool classof(const DIEValue *D) { return D->Type == isDelta; }
582 /// EmitValue - Emit delta value.
584 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
586 /// SizeOf - Determine size of delta value in bytes.
588 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
590 /// Profile - Used to gather unique data for the value folding set.
592 static void Profile(FoldingSetNodeID &ID, const DWLabel &LabelHi,
593 const DWLabel &LabelLo) {
594 ID.AddInteger(isDelta);
598 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, LabelHi, LabelLo); }
601 virtual void print(std::ostream &O) {
610 //===----------------------------------------------------------------------===//
611 /// DIEntry - A pointer to another debug information entry. An instance of this
612 /// class can also be used as a proxy for a debug information entry not yet
613 /// defined (ie. types.)
614 class DIEntry : public DIEValue {
617 explicit DIEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
619 void setEntry(DIE *E) { Entry = E; }
621 // Implement isa/cast/dyncast.
622 static bool classof(const DIEntry *) { return true; }
623 static bool classof(const DIEValue *E) { return E->Type == isEntry; }
625 /// EmitValue - Emit debug information entry offset.
627 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
629 /// SizeOf - Determine size of debug information entry in bytes.
631 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
632 return sizeof(int32_t);
635 /// Profile - Used to gather unique data for the value folding set.
637 static void Profile(FoldingSetNodeID &ID, DIE *Entry) {
638 ID.AddInteger(isEntry);
639 ID.AddPointer(Entry);
641 virtual void Profile(FoldingSetNodeID &ID) {
642 ID.AddInteger(isEntry);
645 ID.AddPointer(Entry);
652 virtual void print(std::ostream &O) {
653 O << "Die: 0x" << std::hex << (intptr_t)Entry << std::dec;
658 //===----------------------------------------------------------------------===//
659 /// DIEBlock - A block of values. Primarily used for location expressions.
661 class DIEBlock : public DIEValue, public DIE {
662 unsigned Size; // Size in bytes excluding size header.
665 : DIEValue(isBlock), DIE(0), Size(0) {}
666 virtual ~DIEBlock() {}
668 // Implement isa/cast/dyncast.
669 static bool classof(const DIEBlock *) { return true; }
670 static bool classof(const DIEValue *E) { return E->Type == isBlock; }
672 /// ComputeSize - calculate the size of the block.
674 unsigned ComputeSize(DwarfDebug &DD);
676 /// BestForm - Choose the best form for data.
678 unsigned BestForm() const {
679 if ((unsigned char)Size == Size) return DW_FORM_block1;
680 if ((unsigned short)Size == Size) return DW_FORM_block2;
681 if ((unsigned int)Size == Size) return DW_FORM_block4;
682 return DW_FORM_block;
685 /// EmitValue - Emit block data.
687 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
689 /// SizeOf - Determine size of block data in bytes.
691 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
693 /// Profile - Used to gather unique data for the value folding set.
695 virtual void Profile(FoldingSetNodeID &ID) {
696 ID.AddInteger(isBlock);
701 virtual void print(std::ostream &O) {
708 //===----------------------------------------------------------------------===//
709 /// CompileUnit - This dwarf writer support class manages information associate
710 /// with a source file.
712 /// ID - File identifier for source.
716 /// Die - Compile unit debug information entry.
720 /// GVToDieMap - Tracks the mapping of unit level debug informaton
721 /// variables to debug information entries.
722 std::map<GlobalVariable *, DIE *> GVToDieMap;
724 /// GVToDIEntryMap - Tracks the mapping of unit level debug informaton
725 /// descriptors to debug information entries using a DIEntry proxy.
726 std::map<GlobalVariable *, DIEntry *> GVToDIEntryMap;
728 /// Globals - A map of globally visible named entities for this unit.
730 StringMap<DIE*> Globals;
732 /// DiesSet - Used to uniquely define dies within the compile unit.
734 FoldingSet<DIE> DiesSet;
736 CompileUnit(unsigned I, DIE *D)
737 : ID(I), Die(D), GVToDieMap(),
738 GVToDIEntryMap(), Globals(), DiesSet(InitDiesSetSize)
746 unsigned getID() const { return ID; }
747 DIE* getDie() const { return Die; }
748 StringMap<DIE*> &getGlobals() { return Globals; }
750 /// hasContent - Return true if this compile unit has something to write out.
752 bool hasContent() const {
753 return !Die->getChildren().empty();
756 /// AddGlobal - Add a new global entity to the compile unit.
758 void AddGlobal(const std::string &Name, DIE *Die) {
762 /// getDieMapSlotFor - Returns the debug information entry map slot for the
763 /// specified debug variable.
764 DIE *&getDieMapSlotFor(GlobalVariable *GV) {
765 return GVToDieMap[GV];
768 /// getDIEntrySlotFor - Returns the debug information entry proxy slot for the
769 /// specified debug variable.
770 DIEntry *&getDIEntrySlotFor(GlobalVariable *GV) {
771 return GVToDIEntryMap[GV];
774 /// AddDie - Adds or interns the DIE to the compile unit.
776 DIE *AddDie(DIE &Buffer) {
780 DIE *Die = DiesSet.FindNodeOrInsertPos(ID, Where);
783 Die = new DIE(Buffer);
784 DiesSet.InsertNode(Die, Where);
785 this->Die->AddChild(Die);
793 //===----------------------------------------------------------------------===//
794 /// Dwarf - Emits general Dwarf directives.
798 //===--------------------------------------------------------------------===//
799 // Core attributes used by the Dwarf writer.
803 /// O - Stream to .s file.
807 /// Asm - Target of Dwarf emission.
811 /// TAI - Target asm information.
812 const TargetAsmInfo *TAI;
814 /// TD - Target data.
815 const TargetData *TD;
817 /// RI - Register Information.
818 const TargetRegisterInfo *RI;
820 /// M - Current module.
824 /// MF - Current machine function.
828 /// MMI - Collected machine module information.
830 MachineModuleInfo *MMI;
832 /// SubprogramCount - The running count of functions being compiled.
834 unsigned SubprogramCount;
836 /// Flavor - A unique string indicating what dwarf producer this is, used to
838 const char * const Flavor;
841 Dwarf(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T,
846 , TD(Asm->TM.getTargetData())
847 , RI(Asm->TM.getRegisterInfo())
858 //===--------------------------------------------------------------------===//
861 AsmPrinter *getAsm() const { return Asm; }
862 MachineModuleInfo *getMMI() const { return MMI; }
863 const TargetAsmInfo *getTargetAsmInfo() const { return TAI; }
864 const TargetData *getTargetData() const { return TD; }
866 void PrintRelDirective(bool Force32Bit = false, bool isInSection = false)
868 if (isInSection && TAI->getDwarfSectionOffsetDirective())
869 O << TAI->getDwarfSectionOffsetDirective();
870 else if (Force32Bit || TD->getPointerSize() == sizeof(int32_t))
871 O << TAI->getData32bitsDirective();
873 O << TAI->getData64bitsDirective();
876 /// PrintLabelName - Print label name in form used by Dwarf writer.
878 void PrintLabelName(DWLabel Label) const {
879 PrintLabelName(Label.Tag, Label.Number);
881 void PrintLabelName(const char *Tag, unsigned Number) const {
882 O << TAI->getPrivateGlobalPrefix() << Tag;
883 if (Number) O << Number;
886 void PrintLabelName(const char *Tag, unsigned Number,
887 const char *Suffix) const {
888 O << TAI->getPrivateGlobalPrefix() << Tag;
889 if (Number) O << Number;
893 /// EmitLabel - Emit location label for internal use by Dwarf.
895 void EmitLabel(DWLabel Label) const {
896 EmitLabel(Label.Tag, Label.Number);
898 void EmitLabel(const char *Tag, unsigned Number) const {
899 PrintLabelName(Tag, Number);
903 /// EmitReference - Emit a reference to a label.
905 void EmitReference(DWLabel Label, bool IsPCRelative = false,
906 bool Force32Bit = false) const {
907 EmitReference(Label.Tag, Label.Number, IsPCRelative, Force32Bit);
909 void EmitReference(const char *Tag, unsigned Number,
910 bool IsPCRelative = false, bool Force32Bit = false) const {
911 PrintRelDirective(Force32Bit);
912 PrintLabelName(Tag, Number);
914 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
916 void EmitReference(const std::string &Name, bool IsPCRelative = false,
917 bool Force32Bit = false) const {
918 PrintRelDirective(Force32Bit);
922 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
925 /// EmitDifference - Emit the difference between two labels. Some
926 /// assemblers do not behave with absolute expressions with data directives,
927 /// so there is an option (needsSet) to use an intermediary set expression.
928 void EmitDifference(DWLabel LabelHi, DWLabel LabelLo,
929 bool IsSmall = false) {
930 EmitDifference(LabelHi.Tag, LabelHi.Number,
931 LabelLo.Tag, LabelLo.Number,
934 void EmitDifference(const char *TagHi, unsigned NumberHi,
935 const char *TagLo, unsigned NumberLo,
936 bool IsSmall = false) {
937 if (TAI->needsSet()) {
939 PrintLabelName("set", SetCounter, Flavor);
941 PrintLabelName(TagHi, NumberHi);
943 PrintLabelName(TagLo, NumberLo);
946 PrintRelDirective(IsSmall);
947 PrintLabelName("set", SetCounter, Flavor);
950 PrintRelDirective(IsSmall);
952 PrintLabelName(TagHi, NumberHi);
954 PrintLabelName(TagLo, NumberLo);
958 void EmitSectionOffset(const char* Label, const char* Section,
959 unsigned LabelNumber, unsigned SectionNumber,
960 bool IsSmall = false, bool isEH = false,
961 bool useSet = true) {
962 bool printAbsolute = false;
964 printAbsolute = TAI->isAbsoluteEHSectionOffsets();
966 printAbsolute = TAI->isAbsoluteDebugSectionOffsets();
968 if (TAI->needsSet() && useSet) {
970 PrintLabelName("set", SetCounter, Flavor);
972 PrintLabelName(Label, LabelNumber);
974 if (!printAbsolute) {
976 PrintLabelName(Section, SectionNumber);
980 PrintRelDirective(IsSmall);
982 PrintLabelName("set", SetCounter, Flavor);
985 PrintRelDirective(IsSmall, true);
987 PrintLabelName(Label, LabelNumber);
989 if (!printAbsolute) {
991 PrintLabelName(Section, SectionNumber);
996 /// EmitFrameMoves - Emit frame instructions to describe the layout of the
998 void EmitFrameMoves(const char *BaseLabel, unsigned BaseLabelID,
999 const std::vector<MachineMove> &Moves, bool isEH) {
1001 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
1002 TargetFrameInfo::StackGrowsUp ?
1003 TD->getPointerSize() : -TD->getPointerSize();
1004 bool IsLocal = BaseLabel && strcmp(BaseLabel, "label") == 0;
1006 for (unsigned i = 0, N = Moves.size(); i < N; ++i) {
1007 const MachineMove &Move = Moves[i];
1008 unsigned LabelID = Move.getLabelID();
1011 LabelID = MMI->MappedLabel(LabelID);
1013 // Throw out move if the label is invalid.
1014 if (!LabelID) continue;
1017 const MachineLocation &Dst = Move.getDestination();
1018 const MachineLocation &Src = Move.getSource();
1020 // Advance row if new location.
1021 if (BaseLabel && LabelID && (BaseLabelID != LabelID || !IsLocal)) {
1022 Asm->EmitInt8(DW_CFA_advance_loc4);
1023 Asm->EOL("DW_CFA_advance_loc4");
1024 EmitDifference("label", LabelID, BaseLabel, BaseLabelID, true);
1027 BaseLabelID = LabelID;
1028 BaseLabel = "label";
1032 // If advancing cfa.
1033 if (Dst.isReg() && Dst.getReg() == MachineLocation::VirtualFP) {
1035 if (Src.getReg() == MachineLocation::VirtualFP) {
1036 Asm->EmitInt8(DW_CFA_def_cfa_offset);
1037 Asm->EOL("DW_CFA_def_cfa_offset");
1039 Asm->EmitInt8(DW_CFA_def_cfa);
1040 Asm->EOL("DW_CFA_def_cfa");
1041 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Src.getReg(), isEH));
1042 Asm->EOL("Register");
1045 int Offset = -Src.getOffset();
1047 Asm->EmitULEB128Bytes(Offset);
1050 assert(0 && "Machine move no supported yet.");
1052 } else if (Src.isReg() &&
1053 Src.getReg() == MachineLocation::VirtualFP) {
1055 Asm->EmitInt8(DW_CFA_def_cfa_register);
1056 Asm->EOL("DW_CFA_def_cfa_register");
1057 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Dst.getReg(), isEH));
1058 Asm->EOL("Register");
1060 assert(0 && "Machine move no supported yet.");
1063 unsigned Reg = RI->getDwarfRegNum(Src.getReg(), isEH);
1064 int Offset = Dst.getOffset() / stackGrowth;
1067 Asm->EmitInt8(DW_CFA_offset_extended_sf);
1068 Asm->EOL("DW_CFA_offset_extended_sf");
1069 Asm->EmitULEB128Bytes(Reg);
1071 Asm->EmitSLEB128Bytes(Offset);
1073 } else if (Reg < 64) {
1074 Asm->EmitInt8(DW_CFA_offset + Reg);
1075 if (Asm->isVerbose())
1076 Asm->EOL("DW_CFA_offset + Reg (" + utostr(Reg) + ")");
1079 Asm->EmitULEB128Bytes(Offset);
1082 Asm->EmitInt8(DW_CFA_offset_extended);
1083 Asm->EOL("DW_CFA_offset_extended");
1084 Asm->EmitULEB128Bytes(Reg);
1086 Asm->EmitULEB128Bytes(Offset);
1095 //===----------------------------------------------------------------------===//
1096 /// SrcLineInfo - This class is used to record source line correspondence.
1099 unsigned Line; // Source line number.
1100 unsigned Column; // Source column.
1101 unsigned SourceID; // Source ID number.
1102 unsigned LabelID; // Label in code ID number.
1104 SrcLineInfo(unsigned L, unsigned C, unsigned S, unsigned I)
1105 : Line(L), Column(C), SourceID(S), LabelID(I) {}
1108 unsigned getLine() const { return Line; }
1109 unsigned getColumn() const { return Column; }
1110 unsigned getSourceID() const { return SourceID; }
1111 unsigned getLabelID() const { return LabelID; }
1114 //===----------------------------------------------------------------------===//
1115 /// DbgVariable - This class is used to track local variable information.
1118 DIVariable Var; // Variable Descriptor.
1119 unsigned FrameIndex; // Variable frame index.
1121 DbgVariable(DIVariable V, unsigned I) : Var(V), FrameIndex(I) {}
1124 DIVariable getVariable() const { return Var; }
1125 unsigned getFrameIndex() const { return FrameIndex; }
1128 //===----------------------------------------------------------------------===//
1129 /// DbgScope - This class is used to track scope information.
1132 DbgScope *Parent; // Parent to this scope.
1133 DIDescriptor Desc; // Debug info descriptor for scope.
1134 // Either subprogram or block.
1135 unsigned StartLabelID; // Label ID of the beginning of scope.
1136 unsigned EndLabelID; // Label ID of the end of scope.
1137 SmallVector<DbgScope *, 4> Scopes; // Scopes defined in scope.
1138 SmallVector<DbgVariable *, 8> Variables;// Variables declared in scope.
1140 DbgScope(DbgScope *P, DIDescriptor D)
1141 : Parent(P), Desc(D), StartLabelID(0), EndLabelID(0), Scopes(), Variables()
1144 for (unsigned i = 0, N = Scopes.size(); i < N; ++i) delete Scopes[i];
1145 for (unsigned j = 0, M = Variables.size(); j < M; ++j) delete Variables[j];
1149 DbgScope *getParent() const { return Parent; }
1150 DIDescriptor getDesc() const { return Desc; }
1151 unsigned getStartLabelID() const { return StartLabelID; }
1152 unsigned getEndLabelID() const { return EndLabelID; }
1153 SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
1154 SmallVector<DbgVariable *, 8> &getVariables() { return Variables; }
1155 void setStartLabelID(unsigned S) { StartLabelID = S; }
1156 void setEndLabelID(unsigned E) { EndLabelID = E; }
1158 /// AddScope - Add a scope to the scope.
1160 void AddScope(DbgScope *S) { Scopes.push_back(S); }
1162 /// AddVariable - Add a variable to the scope.
1164 void AddVariable(DbgVariable *V) { Variables.push_back(V); }
1167 //===----------------------------------------------------------------------===//
1168 /// DwarfDebug - Emits Dwarf debug directives.
1170 class DwarfDebug : public Dwarf {
1171 //===--------------------------------------------------------------------===//
1172 // Attributes used to construct specific Dwarf sections.
1175 /// CompileUnitMap - A map of global variables representing compile units to
1177 DenseMap<Value *, CompileUnit *> CompileUnitMap;
1179 /// CompileUnits - All the compile units in this module.
1181 SmallVector<CompileUnit *, 8> CompileUnits;
1183 /// MainCU - Some platform prefers one compile unit per .o file. In such
1184 /// cases, all dies are inserted in MainCU.
1185 CompileUnit *MainCU;
1187 /// AbbreviationsSet - Used to uniquely define abbreviations.
1189 FoldingSet<DIEAbbrev> AbbreviationsSet;
1191 /// Abbreviations - A list of all the unique abbreviations in use.
1193 std::vector<DIEAbbrev *> Abbreviations;
1195 /// DirectoryIdMap - Directory name to directory id map.
1197 StringMap<unsigned> DirectoryIdMap;
1199 /// DirectoryNames - A list of directory names.
1200 SmallVector<std::string, 8> DirectoryNames;
1202 /// SourceFileIdMap - Source file name to source file id map.
1204 StringMap<unsigned> SourceFileIdMap;
1206 /// SourceFileNames - A list of source file names.
1207 SmallVector<std::string, 8> SourceFileNames;
1209 /// SourceIdMap - Source id map, i.e. pair of directory id and source file
1210 /// id mapped to a unique id.
1211 DenseMap<std::pair<unsigned, unsigned>, unsigned> SourceIdMap;
1213 /// SourceIds - Reverse map from source id to directory id + file id pair.
1215 SmallVector<std::pair<unsigned, unsigned>, 8> SourceIds;
1217 /// Lines - List of of source line correspondence.
1218 std::vector<SrcLineInfo> Lines;
1220 /// ValuesSet - Used to uniquely define values.
1222 FoldingSet<DIEValue> ValuesSet;
1224 /// Values - A list of all the unique values in use.
1226 std::vector<DIEValue *> Values;
1228 /// StringPool - A UniqueVector of strings used by indirect references.
1230 UniqueVector<std::string> StringPool;
1232 /// SectionMap - Provides a unique id per text section.
1234 UniqueVector<const Section*> SectionMap;
1236 /// SectionSourceLines - Tracks line numbers per text section.
1238 std::vector<std::vector<SrcLineInfo> > SectionSourceLines;
1240 /// didInitial - Flag to indicate if initial emission has been done.
1244 /// shouldEmit - Flag to indicate if debug information should be emitted.
1248 // RootDbgScope - Top level scope for the current function.
1250 DbgScope *RootDbgScope;
1252 /// DbgScopeMap - Tracks the scopes in the current function.
1253 DenseMap<GlobalVariable *, DbgScope *> DbgScopeMap;
1255 /// DebugTimer - Timer for the Dwarf debug writer.
1258 struct FunctionDebugFrameInfo {
1260 std::vector<MachineMove> Moves;
1262 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M):
1263 Number(Num), Moves(M) { }
1266 std::vector<FunctionDebugFrameInfo> DebugFrames;
1269 /// getSourceDirectoryAndFileIds - Return the directory and file ids that
1270 /// maps to the source id. Source id starts at 1.
1271 std::pair<unsigned, unsigned>
1272 getSourceDirectoryAndFileIds(unsigned SId) const {
1273 return SourceIds[SId-1];
1276 /// getNumSourceDirectories - Return the number of source directories in the
1278 unsigned getNumSourceDirectories() const {
1279 return DirectoryNames.size();
1282 /// getSourceDirectoryName - Return the name of the directory corresponding
1284 const std::string &getSourceDirectoryName(unsigned Id) const {
1285 return DirectoryNames[Id - 1];
1288 /// getSourceFileName - Return the name of the source file corresponding
1290 const std::string &getSourceFileName(unsigned Id) const {
1291 return SourceFileNames[Id - 1];
1294 /// getNumSourceIds - Return the number of unique source ids.
1295 unsigned getNumSourceIds() const {
1296 return SourceIds.size();
1299 /// AssignAbbrevNumber - Define a unique number for the abbreviation.
1301 void AssignAbbrevNumber(DIEAbbrev &Abbrev) {
1302 // Profile the node so that we can make it unique.
1303 FoldingSetNodeID ID;
1306 // Check the set for priors.
1307 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
1309 // If it's newly added.
1310 if (InSet == &Abbrev) {
1311 // Add to abbreviation list.
1312 Abbreviations.push_back(&Abbrev);
1313 // Assign the vector position + 1 as its number.
1314 Abbrev.setNumber(Abbreviations.size());
1316 // Assign existing abbreviation number.
1317 Abbrev.setNumber(InSet->getNumber());
1321 /// NewString - Add a string to the constant pool and returns a label.
1323 DWLabel NewString(const std::string &String) {
1324 unsigned StringID = StringPool.insert(String);
1325 return DWLabel("string", StringID);
1328 /// NewDIEntry - Creates a new DIEntry to be a proxy for a debug information
1330 DIEntry *NewDIEntry(DIE *Entry = NULL) {
1334 FoldingSetNodeID ID;
1335 DIEntry::Profile(ID, Entry);
1337 Value = static_cast<DIEntry *>(ValuesSet.FindNodeOrInsertPos(ID, Where));
1339 if (Value) return Value;
1341 Value = new DIEntry(Entry);
1342 ValuesSet.InsertNode(Value, Where);
1344 Value = new DIEntry(Entry);
1347 Values.push_back(Value);
1351 /// SetDIEntry - Set a DIEntry once the debug information entry is defined.
1353 void SetDIEntry(DIEntry *Value, DIE *Entry) {
1354 Value->setEntry(Entry);
1355 // Add to values set if not already there. If it is, we merely have a
1356 // duplicate in the values list (no harm.)
1357 ValuesSet.GetOrInsertNode(Value);
1360 /// AddUInt - Add an unsigned integer attribute data and value.
1362 void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer) {
1363 if (!Form) Form = DIEInteger::BestForm(false, Integer);
1365 FoldingSetNodeID ID;
1366 DIEInteger::Profile(ID, Integer);
1368 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1370 Value = new DIEInteger(Integer);
1371 ValuesSet.InsertNode(Value, Where);
1372 Values.push_back(Value);
1375 Die->AddValue(Attribute, Form, Value);
1378 /// AddSInt - Add an signed integer attribute data and value.
1380 void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer) {
1381 if (!Form) Form = DIEInteger::BestForm(true, Integer);
1383 FoldingSetNodeID ID;
1384 DIEInteger::Profile(ID, (uint64_t)Integer);
1386 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1388 Value = new DIEInteger(Integer);
1389 ValuesSet.InsertNode(Value, Where);
1390 Values.push_back(Value);
1393 Die->AddValue(Attribute, Form, Value);
1396 /// AddString - Add a string attribute data and value.
1398 void AddString(DIE *Die, unsigned Attribute, unsigned Form,
1399 const std::string &String) {
1400 FoldingSetNodeID ID;
1401 DIEString::Profile(ID, String);
1403 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1405 Value = new DIEString(String);
1406 ValuesSet.InsertNode(Value, Where);
1407 Values.push_back(Value);
1410 Die->AddValue(Attribute, Form, Value);
1413 /// AddLabel - Add a Dwarf label attribute data and value.
1415 void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
1416 const DWLabel &Label) {
1417 FoldingSetNodeID ID;
1418 DIEDwarfLabel::Profile(ID, Label);
1420 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1422 Value = new DIEDwarfLabel(Label);
1423 ValuesSet.InsertNode(Value, Where);
1424 Values.push_back(Value);
1427 Die->AddValue(Attribute, Form, Value);
1430 /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
1432 void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
1433 const std::string &Label) {
1434 FoldingSetNodeID ID;
1435 DIEObjectLabel::Profile(ID, Label);
1437 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1439 Value = new DIEObjectLabel(Label);
1440 ValuesSet.InsertNode(Value, Where);
1441 Values.push_back(Value);
1444 Die->AddValue(Attribute, Form, Value);
1447 /// AddSectionOffset - Add a section offset label attribute data and value.
1449 void AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
1450 const DWLabel &Label, const DWLabel &Section,
1451 bool isEH = false, bool useSet = true) {
1452 FoldingSetNodeID ID;
1453 DIESectionOffset::Profile(ID, Label, Section);
1455 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1457 Value = new DIESectionOffset(Label, Section, isEH, useSet);
1458 ValuesSet.InsertNode(Value, Where);
1459 Values.push_back(Value);
1462 Die->AddValue(Attribute, Form, Value);
1465 /// AddDelta - Add a label delta attribute data and value.
1467 void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
1468 const DWLabel &Hi, const DWLabel &Lo) {
1469 FoldingSetNodeID ID;
1470 DIEDelta::Profile(ID, Hi, Lo);
1472 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1474 Value = new DIEDelta(Hi, Lo);
1475 ValuesSet.InsertNode(Value, Where);
1476 Values.push_back(Value);
1479 Die->AddValue(Attribute, Form, Value);
1482 /// AddDIEntry - Add a DIE attribute data and value.
1484 void AddDIEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
1485 Die->AddValue(Attribute, Form, NewDIEntry(Entry));
1488 /// AddBlock - Add block data.
1490 void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block) {
1491 Block->ComputeSize(*this);
1492 FoldingSetNodeID ID;
1495 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1498 ValuesSet.InsertNode(Value, Where);
1499 Values.push_back(Value);
1501 // Already exists, reuse the previous one.
1503 Block = cast<DIEBlock>(Value);
1506 Die->AddValue(Attribute, Block->BestForm(), Value);
1509 /// AddSourceLine - Add location information to specified debug information
1511 void AddSourceLine(DIE *Die, const DIVariable *V) {
1512 unsigned FileID = 0;
1513 unsigned Line = V->getLineNumber();
1514 CompileUnit *Unit = FindCompileUnit(V->getCompileUnit());
1515 FileID = Unit->getID();
1516 assert (FileID && "Invalid file id");
1517 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1518 AddUInt(Die, DW_AT_decl_line, 0, Line);
1521 /// AddSourceLine - Add location information to specified debug information
1523 void AddSourceLine(DIE *Die, const DIGlobal *G) {
1524 unsigned FileID = 0;
1525 unsigned Line = G->getLineNumber();
1526 CompileUnit *Unit = FindCompileUnit(G->getCompileUnit());
1527 FileID = Unit->getID();
1528 assert (FileID && "Invalid file id");
1529 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1530 AddUInt(Die, DW_AT_decl_line, 0, Line);
1533 void AddSourceLine(DIE *Die, const DIType *Ty) {
1534 unsigned FileID = 0;
1535 unsigned Line = Ty->getLineNumber();
1536 DICompileUnit CU = Ty->getCompileUnit();
1539 CompileUnit *Unit = FindCompileUnit(CU);
1540 FileID = Unit->getID();
1541 assert (FileID && "Invalid file id");
1542 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1543 AddUInt(Die, DW_AT_decl_line, 0, Line);
1546 /// AddAddress - Add an address attribute to a die based on the location
1548 void AddAddress(DIE *Die, unsigned Attribute,
1549 const MachineLocation &Location) {
1550 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
1551 DIEBlock *Block = new DIEBlock();
1553 if (Location.isReg()) {
1555 AddUInt(Block, 0, DW_FORM_data1, DW_OP_reg0 + Reg);
1557 AddUInt(Block, 0, DW_FORM_data1, DW_OP_regx);
1558 AddUInt(Block, 0, DW_FORM_udata, Reg);
1562 AddUInt(Block, 0, DW_FORM_data1, DW_OP_breg0 + Reg);
1564 AddUInt(Block, 0, DW_FORM_data1, DW_OP_bregx);
1565 AddUInt(Block, 0, DW_FORM_udata, Reg);
1567 AddUInt(Block, 0, DW_FORM_sdata, Location.getOffset());
1570 AddBlock(Die, Attribute, 0, Block);
1573 /// AddType - Add a new type attribute to the specified entity.
1574 void AddType(CompileUnit *DW_Unit, DIE *Entity, DIType Ty) {
1578 // Check for pre-existence.
1579 DIEntry *&Slot = DW_Unit->getDIEntrySlotFor(Ty.getGV());
1580 // If it exists then use the existing value.
1582 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1587 Slot = NewDIEntry();
1590 DIE Buffer(DW_TAG_base_type);
1591 if (Ty.isBasicType(Ty.getTag()))
1592 ConstructTypeDIE(DW_Unit, Buffer, DIBasicType(Ty.getGV()));
1593 else if (Ty.isDerivedType(Ty.getTag()))
1594 ConstructTypeDIE(DW_Unit, Buffer, DIDerivedType(Ty.getGV()));
1596 assert(Ty.isCompositeType(Ty.getTag()) && "Unknown kind of DIType");
1597 ConstructTypeDIE(DW_Unit, Buffer, DICompositeType(Ty.getGV()));
1600 // Add debug information entry to entity and appropriate context.
1602 DIDescriptor Context = Ty.getContext();
1603 if (!Context.isNull())
1604 Die = DW_Unit->getDieMapSlotFor(Context.getGV());
1607 DIE *Child = new DIE(Buffer);
1608 Die->AddChild(Child);
1610 SetDIEntry(Slot, Child);
1612 Die = DW_Unit->AddDie(Buffer);
1613 SetDIEntry(Slot, Die);
1616 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1619 /// ConstructTypeDIE - Construct basic type die from DIBasicType.
1620 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1623 // Get core information.
1626 Buffer.setTag(DW_TAG_base_type);
1627 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, BTy.getEncoding());
1628 // Add name if not anonymous or intermediate type.
1630 AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1631 uint64_t Size = BTy.getSizeInBits() >> 3;
1632 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1635 /// ConstructTypeDIE - Construct derived type die from DIDerivedType.
1636 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1637 DIDerivedType DTy) {
1639 // Get core information.
1642 uint64_t Size = DTy.getSizeInBits() >> 3;
1643 unsigned Tag = DTy.getTag();
1645 // FIXME - Workaround for templates.
1646 if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
1650 // Map to main type, void will not have a type.
1651 DIType FromTy = DTy.getTypeDerivedFrom();
1652 AddType(DW_Unit, &Buffer, FromTy);
1654 // Add name if not anonymous or intermediate type.
1656 AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1658 // Add size if non-zero (derived types might be zero-sized.)
1660 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1662 // Add source line info if available and TyDesc is not a forward
1664 if (!DTy.isForwardDecl())
1665 AddSourceLine(&Buffer, &DTy);
1668 /// ConstructTypeDIE - Construct type DIE from DICompositeType.
1669 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1670 DICompositeType CTy) {
1671 // Get core information.
1675 uint64_t Size = CTy.getSizeInBits() >> 3;
1676 unsigned Tag = CTy.getTag();
1680 case DW_TAG_vector_type:
1681 case DW_TAG_array_type:
1682 ConstructArrayTypeDIE(DW_Unit, Buffer, &CTy);
1684 case DW_TAG_enumeration_type:
1686 DIArray Elements = CTy.getTypeArray();
1687 // Add enumerators to enumeration type.
1688 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1689 DIE *ElemDie = NULL;
1690 DIEnumerator Enum(Elements.getElement(i).getGV());
1691 ElemDie = ConstructEnumTypeDIE(DW_Unit, &Enum);
1692 Buffer.AddChild(ElemDie);
1696 case DW_TAG_subroutine_type:
1698 // Add prototype flag.
1699 AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
1700 DIArray Elements = CTy.getTypeArray();
1702 DIDescriptor RTy = Elements.getElement(0);
1703 AddType(DW_Unit, &Buffer, DIType(RTy.getGV()));
1706 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1707 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1708 DIDescriptor Ty = Elements.getElement(i);
1709 AddType(DW_Unit, Arg, DIType(Ty.getGV()));
1710 Buffer.AddChild(Arg);
1714 case DW_TAG_structure_type:
1715 case DW_TAG_union_type:
1716 case DW_TAG_class_type:
1718 // Add elements to structure type.
1719 DIArray Elements = CTy.getTypeArray();
1721 // A forward struct declared type may not have elements available.
1722 if (Elements.isNull())
1725 // Add elements to structure type.
1726 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1727 DIDescriptor Element = Elements.getElement(i);
1728 DIE *ElemDie = NULL;
1729 if (Element.getTag() == dwarf::DW_TAG_subprogram)
1730 ElemDie = CreateSubprogramDIE(DW_Unit,
1731 DISubprogram(Element.getGV()));
1732 else if (Element.getTag() == dwarf::DW_TAG_variable) // ???
1733 ElemDie = CreateGlobalVariableDIE(DW_Unit,
1734 DIGlobalVariable(Element.getGV()));
1736 ElemDie = CreateMemberDIE(DW_Unit,
1737 DIDerivedType(Element.getGV()));
1738 Buffer.AddChild(ElemDie);
1740 unsigned RLang = CTy.getRunTimeLang();
1742 AddUInt(&Buffer, DW_AT_APPLE_runtime_class, DW_FORM_data1, RLang);
1749 // Add name if not anonymous or intermediate type.
1751 AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1753 if (Tag == DW_TAG_enumeration_type || Tag == DW_TAG_structure_type
1754 || Tag == DW_TAG_union_type) {
1755 // Add size if non-zero (derived types might be zero-sized.)
1757 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1759 // Add zero size if it is not a forward declaration.
1760 if (CTy.isForwardDecl())
1761 AddUInt(&Buffer, DW_AT_declaration, DW_FORM_flag, 1);
1763 AddUInt(&Buffer, DW_AT_byte_size, 0, 0);
1766 // Add source line info if available.
1767 if (!CTy.isForwardDecl())
1768 AddSourceLine(&Buffer, &CTy);
1772 /// ConstructSubrangeDIE - Construct subrange DIE from DISubrange.
1773 void ConstructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy) {
1774 int64_t L = SR.getLo();
1775 int64_t H = SR.getHi();
1776 DIE *DW_Subrange = new DIE(DW_TAG_subrange_type);
1778 AddDIEntry(DW_Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1780 AddSInt(DW_Subrange, DW_AT_lower_bound, 0, L);
1781 AddSInt(DW_Subrange, DW_AT_upper_bound, 0, H);
1783 Buffer.AddChild(DW_Subrange);
1786 /// ConstructArrayTypeDIE - Construct array type DIE from DICompositeType.
1787 void ConstructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1788 DICompositeType *CTy) {
1789 Buffer.setTag(DW_TAG_array_type);
1790 if (CTy->getTag() == DW_TAG_vector_type)
1791 AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1793 // Emit derived type.
1794 AddType(DW_Unit, &Buffer, CTy->getTypeDerivedFrom());
1795 DIArray Elements = CTy->getTypeArray();
1797 // Construct an anonymous type for index type.
1798 DIE IdxBuffer(DW_TAG_base_type);
1799 AddUInt(&IdxBuffer, DW_AT_byte_size, 0, sizeof(int32_t));
1800 AddUInt(&IdxBuffer, DW_AT_encoding, DW_FORM_data1, DW_ATE_signed);
1801 DIE *IndexTy = DW_Unit->AddDie(IdxBuffer);
1803 // Add subranges to array type.
1804 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1805 DIDescriptor Element = Elements.getElement(i);
1806 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
1807 ConstructSubrangeDIE(Buffer, DISubrange(Element.getGV()), IndexTy);
1811 /// ConstructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
1812 DIE *ConstructEnumTypeDIE(CompileUnit *DW_Unit, DIEnumerator *ETy) {
1814 DIE *Enumerator = new DIE(DW_TAG_enumerator);
1817 AddString(Enumerator, DW_AT_name, DW_FORM_string, Name);
1818 int64_t Value = ETy->getEnumValue();
1819 AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
1823 /// CreateGlobalVariableDIE - Create new DIE using GV.
1824 DIE *CreateGlobalVariableDIE(CompileUnit *DW_Unit, const DIGlobalVariable &GV)
1826 DIE *GVDie = new DIE(DW_TAG_variable);
1828 GV.getDisplayName(Name);
1829 AddString(GVDie, DW_AT_name, DW_FORM_string, Name);
1830 std::string LinkageName;
1831 GV.getLinkageName(LinkageName);
1832 if (!LinkageName.empty())
1833 AddString(GVDie, DW_AT_MIPS_linkage_name, DW_FORM_string, LinkageName);
1834 AddType(DW_Unit, GVDie, GV.getType());
1835 if (!GV.isLocalToUnit())
1836 AddUInt(GVDie, DW_AT_external, DW_FORM_flag, 1);
1837 AddSourceLine(GVDie, &GV);
1841 /// CreateMemberDIE - Create new member DIE.
1842 DIE *CreateMemberDIE(CompileUnit *DW_Unit, const DIDerivedType &DT) {
1843 DIE *MemberDie = new DIE(DT.getTag());
1847 AddString(MemberDie, DW_AT_name, DW_FORM_string, Name);
1849 AddType(DW_Unit, MemberDie, DT.getTypeDerivedFrom());
1851 AddSourceLine(MemberDie, &DT);
1853 uint64_t Size = DT.getSizeInBits();
1854 uint64_t FieldSize = DT.getOriginalTypeSize();
1856 if (Size != FieldSize) {
1858 AddUInt(MemberDie, DW_AT_byte_size, 0, DT.getOriginalTypeSize() >> 3);
1859 AddUInt(MemberDie, DW_AT_bit_size, 0, DT.getSizeInBits());
1861 uint64_t Offset = DT.getOffsetInBits();
1862 uint64_t FieldOffset = Offset;
1863 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1864 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1865 FieldOffset = (HiMark - FieldSize);
1866 Offset -= FieldOffset;
1867 // Maybe we need to work from the other end.
1868 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
1869 AddUInt(MemberDie, DW_AT_bit_offset, 0, Offset);
1871 DIEBlock *Block = new DIEBlock();
1872 AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
1873 AddUInt(Block, 0, DW_FORM_udata, DT.getOffsetInBits() >> 3);
1874 AddBlock(MemberDie, DW_AT_data_member_location, 0, Block);
1876 if (DT.isProtected())
1877 AddUInt(MemberDie, DW_AT_accessibility, 0, DW_ACCESS_protected);
1878 else if (DT.isPrivate())
1879 AddUInt(MemberDie, DW_AT_accessibility, 0, DW_ACCESS_private);
1884 /// CreateSubprogramDIE - Create new DIE using SP.
1885 DIE *CreateSubprogramDIE(CompileUnit *DW_Unit,
1886 const DISubprogram &SP,
1887 bool IsConstructor = false) {
1888 DIE *SPDie = new DIE(DW_TAG_subprogram);
1891 AddString(SPDie, DW_AT_name, DW_FORM_string, Name);
1892 std::string LinkageName;
1893 SP.getLinkageName(LinkageName);
1894 if (!LinkageName.empty())
1895 AddString(SPDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
1897 AddSourceLine(SPDie, &SP);
1899 DICompositeType SPTy = SP.getType();
1900 DIArray Args = SPTy.getTypeArray();
1903 unsigned SPTag = SPTy.getTag();
1904 if (!IsConstructor) {
1905 if (Args.isNull() || SPTag != DW_TAG_subroutine_type)
1906 AddType(DW_Unit, SPDie, SPTy);
1908 AddType(DW_Unit, SPDie, DIType(Args.getElement(0).getGV()));
1911 if (!SP.isDefinition()) {
1912 AddUInt(SPDie, DW_AT_declaration, DW_FORM_flag, 1);
1914 // Do not add arguments for subprogram definition. They will be
1915 // handled through RecordVariable.
1916 if (SPTag == DW_TAG_subroutine_type)
1917 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1918 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1919 AddType(DW_Unit, Arg, DIType(Args.getElement(i).getGV()));
1920 AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1); // ???
1921 SPDie->AddChild(Arg);
1925 unsigned Lang = SP.getCompileUnit().getLanguage();
1926 if (Lang == DW_LANG_C99 || Lang == DW_LANG_C89
1927 || Lang == DW_LANG_ObjC)
1928 AddUInt(SPDie, DW_AT_prototyped, DW_FORM_flag, 1);
1930 if (!SP.isLocalToUnit())
1931 AddUInt(SPDie, DW_AT_external, DW_FORM_flag, 1);
1935 /// FindCompileUnit - Get the compile unit for the given descriptor.
1937 CompileUnit *FindCompileUnit(DICompileUnit Unit) {
1938 CompileUnit *DW_Unit = CompileUnitMap[Unit.getGV()];
1939 assert(DW_Unit && "Missing compile unit.");
1943 /// NewDbgScopeVariable - Create a new scope variable.
1945 DIE *NewDbgScopeVariable(DbgVariable *DV, CompileUnit *Unit) {
1946 // Get the descriptor.
1947 const DIVariable &VD = DV->getVariable();
1949 // Translate tag to proper Dwarf tag. The result variable is dropped for
1952 switch (VD.getTag()) {
1953 case DW_TAG_return_variable: return NULL;
1954 case DW_TAG_arg_variable: Tag = DW_TAG_formal_parameter; break;
1955 case DW_TAG_auto_variable: // fall thru
1956 default: Tag = DW_TAG_variable; break;
1959 // Define variable debug information entry.
1960 DIE *VariableDie = new DIE(Tag);
1963 AddString(VariableDie, DW_AT_name, DW_FORM_string, Name);
1965 // Add source line info if available.
1966 AddSourceLine(VariableDie, &VD);
1968 // Add variable type.
1969 AddType(Unit, VariableDie, VD.getType());
1971 // Add variable address.
1972 MachineLocation Location;
1973 Location.set(RI->getFrameRegister(*MF),
1974 RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
1975 AddAddress(VariableDie, DW_AT_location, Location);
1980 /// getOrCreateScope - Returns the scope associated with the given descriptor.
1982 DbgScope *getOrCreateScope(GlobalVariable *V) {
1983 DbgScope *&Slot = DbgScopeMap[V];
1984 if (Slot) return Slot;
1986 // FIXME - breaks down when the context is an inlined function.
1987 DIDescriptor ParentDesc;
1988 DIDescriptor Desc(V);
1990 if (Desc.getTag() == dwarf::DW_TAG_lexical_block) {
1992 ParentDesc = Block.getContext();
1995 DbgScope *Parent = ParentDesc.isNull() ?
1996 NULL : getOrCreateScope(ParentDesc.getGV());
1997 Slot = new DbgScope(Parent, Desc);
2000 Parent->AddScope(Slot);
2001 } else if (RootDbgScope) {
2002 // FIXME - Add inlined function scopes to the root so we can delete them
2003 // later. Long term, handle inlined functions properly.
2004 RootDbgScope->AddScope(Slot);
2006 // First function is top level function.
2007 RootDbgScope = Slot;
2013 /// ConstructDbgScope - Construct the components of a scope.
2015 void ConstructDbgScope(DbgScope *ParentScope,
2016 unsigned ParentStartID, unsigned ParentEndID,
2017 DIE *ParentDie, CompileUnit *Unit) {
2018 // Add variables to scope.
2019 SmallVector<DbgVariable *, 8> &Variables = ParentScope->getVariables();
2020 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2021 DIE *VariableDie = NewDbgScopeVariable(Variables[i], Unit);
2022 if (VariableDie) ParentDie->AddChild(VariableDie);
2025 // Add nested scopes.
2026 SmallVector<DbgScope *, 4> &Scopes = ParentScope->getScopes();
2027 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
2028 // Define the Scope debug information entry.
2029 DbgScope *Scope = Scopes[j];
2030 // FIXME - Ignore inlined functions for the time being.
2031 if (!Scope->getParent()) continue;
2033 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
2034 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
2036 // Ignore empty scopes.
2037 if (StartID == EndID && StartID != 0) continue;
2038 if (Scope->getScopes().empty() && Scope->getVariables().empty()) continue;
2040 if (StartID == ParentStartID && EndID == ParentEndID) {
2041 // Just add stuff to the parent scope.
2042 ConstructDbgScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
2044 DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
2046 // Add the scope bounds.
2048 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2049 DWLabel("label", StartID));
2051 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2052 DWLabel("func_begin", SubprogramCount));
2055 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2056 DWLabel("label", EndID));
2058 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2059 DWLabel("func_end", SubprogramCount));
2062 // Add the scope contents.
2063 ConstructDbgScope(Scope, StartID, EndID, ScopeDie, Unit);
2064 ParentDie->AddChild(ScopeDie);
2069 /// ConstructRootDbgScope - Construct the scope for the subprogram.
2071 void ConstructRootDbgScope(DbgScope *RootScope) {
2072 // Exit if there is no root scope.
2073 if (!RootScope) return;
2074 DIDescriptor Desc = RootScope->getDesc();
2078 // Get the subprogram debug information entry.
2079 DISubprogram SPD(Desc.getGV());
2081 // Get the compile unit context.
2082 CompileUnit *Unit = MainCU;
2084 Unit = FindCompileUnit(SPD.getCompileUnit());
2086 // Get the subprogram die.
2087 DIE *SPDie = Unit->getDieMapSlotFor(SPD.getGV());
2088 assert(SPDie && "Missing subprogram descriptor");
2090 // Add the function bounds.
2091 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2092 DWLabel("func_begin", SubprogramCount));
2093 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2094 DWLabel("func_end", SubprogramCount));
2095 MachineLocation Location(RI->getFrameRegister(*MF));
2096 AddAddress(SPDie, DW_AT_frame_base, Location);
2098 ConstructDbgScope(RootScope, 0, 0, SPDie, Unit);
2101 /// ConstructDefaultDbgScope - Construct a default scope for the subprogram.
2103 void ConstructDefaultDbgScope(MachineFunction *MF) {
2104 const char *FnName = MF->getFunction()->getNameStart();
2106 StringMap<DIE*> &Globals = MainCU->getGlobals();
2107 StringMap<DIE*>::iterator GI = Globals.find(FnName);
2108 if (GI != Globals.end()) {
2109 DIE *SPDie = GI->second;
2111 // Add the function bounds.
2112 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2113 DWLabel("func_begin", SubprogramCount));
2114 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2115 DWLabel("func_end", SubprogramCount));
2117 MachineLocation Location(RI->getFrameRegister(*MF));
2118 AddAddress(SPDie, DW_AT_frame_base, Location);
2122 for (unsigned i = 0, e = CompileUnits.size(); i != e; ++i) {
2123 CompileUnit *Unit = CompileUnits[i];
2124 StringMap<DIE*> &Globals = Unit->getGlobals();
2125 StringMap<DIE*>::iterator GI = Globals.find(FnName);
2126 if (GI != Globals.end()) {
2127 DIE *SPDie = GI->second;
2129 // Add the function bounds.
2130 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2131 DWLabel("func_begin", SubprogramCount));
2132 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2133 DWLabel("func_end", SubprogramCount));
2135 MachineLocation Location(RI->getFrameRegister(*MF));
2136 AddAddress(SPDie, DW_AT_frame_base, Location);
2143 // FIXME: This is causing an abort because C++ mangled names are compared
2144 // with their unmangled counterparts. See PR2885. Don't do this assert.
2145 assert(0 && "Couldn't find DIE for machine function!");
2150 /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
2151 /// tools to recognize the object file contains Dwarf information.
2152 void EmitInitial() {
2153 // Check to see if we already emitted intial headers.
2154 if (didInitial) return;
2157 // Dwarf sections base addresses.
2158 if (TAI->doesDwarfRequireFrameSection()) {
2159 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2160 EmitLabel("section_debug_frame", 0);
2162 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2163 EmitLabel("section_info", 0);
2164 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2165 EmitLabel("section_abbrev", 0);
2166 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2167 EmitLabel("section_aranges", 0);
2168 if (TAI->doesSupportMacInfoSection()) {
2169 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2170 EmitLabel("section_macinfo", 0);
2172 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2173 EmitLabel("section_line", 0);
2174 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2175 EmitLabel("section_loc", 0);
2176 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2177 EmitLabel("section_pubnames", 0);
2178 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2179 EmitLabel("section_str", 0);
2180 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2181 EmitLabel("section_ranges", 0);
2183 Asm->SwitchToSection(TAI->getTextSection());
2184 EmitLabel("text_begin", 0);
2185 Asm->SwitchToSection(TAI->getDataSection());
2186 EmitLabel("data_begin", 0);
2189 /// EmitDIE - Recusively Emits a debug information entry.
2191 void EmitDIE(DIE *Die) {
2192 // Get the abbreviation for this DIE.
2193 unsigned AbbrevNumber = Die->getAbbrevNumber();
2194 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2198 // Emit the code (index) for the abbreviation.
2199 Asm->EmitULEB128Bytes(AbbrevNumber);
2201 if (Asm->isVerbose())
2202 Asm->EOL(std::string("Abbrev [" +
2203 utostr(AbbrevNumber) +
2204 "] 0x" + utohexstr(Die->getOffset()) +
2205 ":0x" + utohexstr(Die->getSize()) + " " +
2206 TagString(Abbrev->getTag())));
2210 SmallVector<DIEValue*, 32> &Values = Die->getValues();
2211 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2213 // Emit the DIE attribute values.
2214 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2215 unsigned Attr = AbbrevData[i].getAttribute();
2216 unsigned Form = AbbrevData[i].getForm();
2217 assert(Form && "Too many attributes for DIE (check abbreviation)");
2220 case DW_AT_sibling: {
2221 Asm->EmitInt32(Die->SiblingOffset());
2225 // Emit an attribute using the defined form.
2226 Values[i]->EmitValue(*this, Form);
2231 Asm->EOL(AttributeString(Attr));
2234 // Emit the DIE children if any.
2235 if (Abbrev->getChildrenFlag() == DW_CHILDREN_yes) {
2236 const std::vector<DIE *> &Children = Die->getChildren();
2238 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2239 EmitDIE(Children[j]);
2242 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2246 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
2248 unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
2249 // Get the children.
2250 const std::vector<DIE *> &Children = Die->getChildren();
2252 // If not last sibling and has children then add sibling offset attribute.
2253 if (!Last && !Children.empty()) Die->AddSiblingOffset();
2255 // Record the abbreviation.
2256 AssignAbbrevNumber(Die->getAbbrev());
2258 // Get the abbreviation for this DIE.
2259 unsigned AbbrevNumber = Die->getAbbrevNumber();
2260 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2263 Die->setOffset(Offset);
2265 // Start the size with the size of abbreviation code.
2266 Offset += TargetAsmInfo::getULEB128Size(AbbrevNumber);
2268 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2269 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2271 // Size the DIE attribute values.
2272 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2273 // Size attribute value.
2274 Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
2277 // Size the DIE children if any.
2278 if (!Children.empty()) {
2279 assert(Abbrev->getChildrenFlag() == DW_CHILDREN_yes &&
2280 "Children flag not set");
2282 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2283 Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
2286 // End of children marker.
2287 Offset += sizeof(int8_t);
2290 Die->setSize(Offset - Die->getOffset());
2294 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
2296 void SizeAndOffsets() {
2297 // Process base compile unit.
2299 // Compute size of compile unit header
2300 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2301 sizeof(int16_t) + // DWARF version number
2302 sizeof(int32_t) + // Offset Into Abbrev. Section
2303 sizeof(int8_t); // Pointer Size (in bytes)
2304 SizeAndOffsetDie(MainCU->getDie(), Offset, true);
2307 for (unsigned i = 0, e = CompileUnits.size(); i != e; ++i) {
2308 CompileUnit *Unit = CompileUnits[i];
2309 // Compute size of compile unit header
2310 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2311 sizeof(int16_t) + // DWARF version number
2312 sizeof(int32_t) + // Offset Into Abbrev. Section
2313 sizeof(int8_t); // Pointer Size (in bytes)
2314 SizeAndOffsetDie(Unit->getDie(), Offset, true);
2318 /// EmitDebugInfo / EmitDebugInfoPerCU - Emit the debug info section.
2320 void EmitDebugInfoPerCU(CompileUnit *Unit) {
2321 DIE *Die = Unit->getDie();
2322 // Emit the compile units header.
2323 EmitLabel("info_begin", Unit->getID());
2324 // Emit size of content not including length itself
2325 unsigned ContentSize = Die->getSize() +
2326 sizeof(int16_t) + // DWARF version number
2327 sizeof(int32_t) + // Offset Into Abbrev. Section
2328 sizeof(int8_t) + // Pointer Size (in bytes)
2329 sizeof(int32_t); // FIXME - extra pad for gdb bug.
2331 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2332 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2333 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2334 Asm->EOL("Offset Into Abbrev. Section");
2335 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2338 // FIXME - extra padding for gdb bug.
2339 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2340 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2341 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2342 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2343 EmitLabel("info_end", Unit->getID());
2348 void EmitDebugInfo() {
2349 // Start debug info section.
2350 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2353 EmitDebugInfoPerCU(MainCU);
2357 for (unsigned i = 0, e = CompileUnits.size(); i != e; ++i)
2358 EmitDebugInfoPerCU(CompileUnits[i]);
2361 /// EmitAbbreviations - Emit the abbreviation section.
2363 void EmitAbbreviations() const {
2364 // Check to see if it is worth the effort.
2365 if (!Abbreviations.empty()) {
2366 // Start the debug abbrev section.
2367 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2369 EmitLabel("abbrev_begin", 0);
2371 // For each abbrevation.
2372 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2373 // Get abbreviation data
2374 const DIEAbbrev *Abbrev = Abbreviations[i];
2376 // Emit the abbrevations code (base 1 index.)
2377 Asm->EmitULEB128Bytes(Abbrev->getNumber());
2378 Asm->EOL("Abbreviation Code");
2380 // Emit the abbreviations data.
2381 Abbrev->Emit(*this);
2386 // Mark end of abbreviations.
2387 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2389 EmitLabel("abbrev_end", 0);
2395 /// EmitEndOfLineMatrix - Emit the last address of the section and the end of
2396 /// the line matrix.
2398 void EmitEndOfLineMatrix(unsigned SectionEnd) {
2399 // Define last address of section.
2400 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2401 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2402 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2403 EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
2405 // Mark end of matrix.
2406 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2407 Asm->EmitULEB128Bytes(1); Asm->EOL();
2408 Asm->EmitInt8(1); Asm->EOL();
2411 /// EmitDebugLines - Emit source line information.
2413 void EmitDebugLines() {
2414 // If the target is using .loc/.file, the assembler will be emitting the
2415 // .debug_line table automatically.
2416 if (TAI->hasDotLocAndDotFile())
2419 // Minimum line delta, thus ranging from -10..(255-10).
2420 const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
2421 // Maximum line delta, thus ranging from -10..(255-10).
2422 const int MaxLineDelta = 255 + MinLineDelta;
2424 // Start the dwarf line section.
2425 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2427 // Construct the section header.
2429 EmitDifference("line_end", 0, "line_begin", 0, true);
2430 Asm->EOL("Length of Source Line Info");
2431 EmitLabel("line_begin", 0);
2433 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2435 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2436 Asm->EOL("Prolog Length");
2437 EmitLabel("line_prolog_begin", 0);
2439 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2441 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2443 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
2445 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2447 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
2449 // Line number standard opcode encodings argument count
2450 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2451 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2452 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2453 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2454 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2455 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2456 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2457 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2458 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2460 // Emit directories.
2461 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
2462 Asm->EmitString(getSourceDirectoryName(DI));
2463 Asm->EOL("Directory");
2465 Asm->EmitInt8(0); Asm->EOL("End of directories");
2468 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
2469 // Remember source id starts at 1.
2470 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(SI);
2471 Asm->EmitString(getSourceFileName(Id.second));
2473 Asm->EmitULEB128Bytes(Id.first);
2474 Asm->EOL("Directory #");
2475 Asm->EmitULEB128Bytes(0);
2476 Asm->EOL("Mod date");
2477 Asm->EmitULEB128Bytes(0);
2478 Asm->EOL("File size");
2480 Asm->EmitInt8(0); Asm->EOL("End of files");
2482 EmitLabel("line_prolog_end", 0);
2484 // A sequence for each text section.
2485 unsigned SecSrcLinesSize = SectionSourceLines.size();
2487 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
2488 // Isolate current sections line info.
2489 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
2491 if (Asm->isVerbose()) {
2492 const Section* S = SectionMap[j + 1];
2493 O << '\t' << TAI->getCommentString() << " Section"
2494 << S->getName() << '\n';
2498 // Dwarf assumes we start with first line of first source file.
2499 unsigned Source = 1;
2502 // Construct rows of the address, source, line, column matrix.
2503 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2504 const SrcLineInfo &LineInfo = LineInfos[i];
2505 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2506 if (!LabelID) continue;
2508 if (!Asm->isVerbose())
2511 std::pair<unsigned, unsigned> SourceID =
2512 getSourceDirectoryAndFileIds(LineInfo.getSourceID());
2513 O << '\t' << TAI->getCommentString() << ' '
2514 << getSourceDirectoryName(SourceID.first) << ' '
2515 << getSourceFileName(SourceID.second)
2516 <<" :" << utostr_32(LineInfo.getLine()) << '\n';
2519 // Define the line address.
2520 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2521 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2522 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2523 EmitReference("label", LabelID); Asm->EOL("Location label");
2525 // If change of source, then switch to the new source.
2526 if (Source != LineInfo.getSourceID()) {
2527 Source = LineInfo.getSourceID();
2528 Asm->EmitInt8(DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2529 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2532 // If change of line.
2533 if (Line != LineInfo.getLine()) {
2534 // Determine offset.
2535 int Offset = LineInfo.getLine() - Line;
2536 int Delta = Offset - MinLineDelta;
2539 Line = LineInfo.getLine();
2541 // If delta is small enough and in range...
2542 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2543 // ... then use fast opcode.
2544 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2546 // ... otherwise use long hand.
2547 Asm->EmitInt8(DW_LNS_advance_line); Asm->EOL("DW_LNS_advance_line");
2548 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2549 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2552 // Copy the previous row (different address or source)
2553 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2557 EmitEndOfLineMatrix(j + 1);
2560 if (SecSrcLinesSize == 0)
2561 // Because we're emitting a debug_line section, we still need a line
2562 // table. The linker and friends expect it to exist. If there's nothing to
2563 // put into it, emit an empty table.
2564 EmitEndOfLineMatrix(1);
2566 EmitLabel("line_end", 0);
2571 /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
2573 void EmitCommonDebugFrame() {
2574 if (!TAI->doesDwarfRequireFrameSection())
2578 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2579 TargetFrameInfo::StackGrowsUp ?
2580 TD->getPointerSize() : -TD->getPointerSize();
2582 // Start the dwarf frame section.
2583 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2585 EmitLabel("debug_frame_common", 0);
2586 EmitDifference("debug_frame_common_end", 0,
2587 "debug_frame_common_begin", 0, true);
2588 Asm->EOL("Length of Common Information Entry");
2590 EmitLabel("debug_frame_common_begin", 0);
2591 Asm->EmitInt32((int)DW_CIE_ID);
2592 Asm->EOL("CIE Identifier Tag");
2593 Asm->EmitInt8(DW_CIE_VERSION);
2594 Asm->EOL("CIE Version");
2595 Asm->EmitString("");
2596 Asm->EOL("CIE Augmentation");
2597 Asm->EmitULEB128Bytes(1);
2598 Asm->EOL("CIE Code Alignment Factor");
2599 Asm->EmitSLEB128Bytes(stackGrowth);
2600 Asm->EOL("CIE Data Alignment Factor");
2601 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
2602 Asm->EOL("CIE RA Column");
2604 std::vector<MachineMove> Moves;
2605 RI->getInitialFrameState(Moves);
2607 EmitFrameMoves(NULL, 0, Moves, false);
2609 Asm->EmitAlignment(2, 0, 0, false);
2610 EmitLabel("debug_frame_common_end", 0);
2615 /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2617 void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
2618 if (!TAI->doesDwarfRequireFrameSection())
2621 // Start the dwarf frame section.
2622 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2624 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2625 "debug_frame_begin", DebugFrameInfo.Number, true);
2626 Asm->EOL("Length of Frame Information Entry");
2628 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2630 EmitSectionOffset("debug_frame_common", "section_debug_frame",
2632 Asm->EOL("FDE CIE offset");
2634 EmitReference("func_begin", DebugFrameInfo.Number);
2635 Asm->EOL("FDE initial location");
2636 EmitDifference("func_end", DebugFrameInfo.Number,
2637 "func_begin", DebugFrameInfo.Number);
2638 Asm->EOL("FDE address range");
2640 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves,
2643 Asm->EmitAlignment(2, 0, 0, false);
2644 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
2649 void EmitDebugPubNamesPerCU(CompileUnit *Unit) {
2650 EmitDifference("pubnames_end", Unit->getID(),
2651 "pubnames_begin", Unit->getID(), true);
2652 Asm->EOL("Length of Public Names Info");
2654 EmitLabel("pubnames_begin", Unit->getID());
2656 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF Version");
2658 EmitSectionOffset("info_begin", "section_info",
2659 Unit->getID(), 0, true, false);
2660 Asm->EOL("Offset of Compilation Unit Info");
2662 EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(),
2664 Asm->EOL("Compilation Unit Length");
2666 StringMap<DIE*> &Globals = Unit->getGlobals();
2667 for (StringMap<DIE*>::iterator
2668 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2669 const std::string &Name = GI->first();
2670 DIE * Entity = GI->second;
2672 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2673 Asm->EmitString(Name); Asm->EOL("External Name");
2676 Asm->EmitInt32(0); Asm->EOL("End Mark");
2677 EmitLabel("pubnames_end", Unit->getID());
2682 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
2684 void EmitDebugPubNames() {
2685 // Start the dwarf pubnames section.
2686 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2689 EmitDebugPubNamesPerCU(MainCU);
2693 for (unsigned i = 0, e = CompileUnits.size(); i != e; ++i)
2694 EmitDebugPubNamesPerCU(CompileUnits[i]);
2697 /// EmitDebugStr - Emit visible names into a debug str section.
2699 void EmitDebugStr() {
2700 // Check to see if it is worth the effort.
2701 if (!StringPool.empty()) {
2702 // Start the dwarf str section.
2703 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2705 // For each of strings in the string pool.
2706 for (unsigned StringID = 1, N = StringPool.size();
2707 StringID <= N; ++StringID) {
2708 // Emit a label for reference from debug information entries.
2709 EmitLabel("string", StringID);
2710 // Emit the string itself.
2711 const std::string &String = StringPool[StringID];
2712 Asm->EmitString(String); Asm->EOL();
2719 /// EmitDebugLoc - Emit visible names into a debug loc section.
2721 void EmitDebugLoc() {
2722 // Start the dwarf loc section.
2723 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2728 /// EmitDebugARanges - Emit visible names into a debug aranges section.
2730 void EmitDebugARanges() {
2731 // Start the dwarf aranges section.
2732 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2736 CompileUnit *Unit = GetBaseCompileUnit();
2738 // Don't include size of length
2739 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
2741 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("Dwarf Version");
2743 EmitReference("info_begin", Unit->getID());
2744 Asm->EOL("Offset of Compilation Unit Info");
2746 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
2748 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
2750 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
2751 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
2754 EmitReference("text_begin", 0); Asm->EOL("Address");
2755 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
2757 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2758 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
2764 /// EmitDebugRanges - Emit visible names into a debug ranges section.
2766 void EmitDebugRanges() {
2767 // Start the dwarf ranges section.
2768 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2773 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
2775 void EmitDebugMacInfo() {
2776 if (TAI->doesSupportMacInfoSection()) {
2777 // Start the dwarf macinfo section.
2778 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2784 /// GetOrCreateSourceID - Look up the source id with the given directory and
2785 /// source file names. If none currently exists, create a new id and insert it
2786 /// in the SourceIds map. This can update DirectoryNames and SourceFileNames maps
2788 unsigned GetOrCreateSourceID(const std::string &DirName,
2789 const std::string &FileName) {
2791 StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
2792 if (DI != DirectoryIdMap.end()) {
2793 DId = DI->getValue();
2795 DId = DirectoryNames.size() + 1;
2796 DirectoryIdMap[DirName] = DId;
2797 DirectoryNames.push_back(DirName);
2801 StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
2802 if (FI != SourceFileIdMap.end()) {
2803 FId = FI->getValue();
2805 FId = SourceFileNames.size() + 1;
2806 SourceFileIdMap[FileName] = FId;
2807 SourceFileNames.push_back(FileName);
2810 DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
2811 SourceIdMap.find(std::make_pair(DId, FId));
2812 if (SI != SourceIdMap.end())
2815 unsigned SrcId = SourceIds.size() + 1; // DW_AT_decl_file cannot be 0.
2816 SourceIdMap[std::make_pair(DId, FId)] = SrcId;
2817 SourceIds.push_back(std::make_pair(DId, FId));
2822 void ConstructCompileUnit(GlobalVariable *GV) {
2823 DICompileUnit DIUnit(GV);
2824 std::string Dir, FN, Prod;
2825 unsigned ID = GetOrCreateSourceID(DIUnit.getDirectory(Dir),
2826 DIUnit.getFilename(FN));
2828 DIE *Die = new DIE(DW_TAG_compile_unit);
2829 AddSectionOffset(Die, DW_AT_stmt_list, DW_FORM_data4,
2830 DWLabel("section_line", 0), DWLabel("section_line", 0),
2832 AddString(Die, DW_AT_producer, DW_FORM_string, DIUnit.getProducer(Prod));
2833 AddUInt(Die, DW_AT_language, DW_FORM_data1, DIUnit.getLanguage());
2834 AddString(Die, DW_AT_name, DW_FORM_string, FN);
2836 AddString(Die, DW_AT_comp_dir, DW_FORM_string, Dir);
2837 if (DIUnit.isOptimized())
2838 AddUInt(Die, DW_AT_APPLE_optimized, DW_FORM_flag, 1);
2840 DIUnit.getFlags(Flags);
2842 AddString(Die, DW_AT_APPLE_flags, DW_FORM_string, Flags);
2843 unsigned RVer = DIUnit.getRunTimeVersion();
2845 AddUInt(Die, DW_AT_APPLE_major_runtime_vers, DW_FORM_data1, RVer);
2847 CompileUnit *Unit = new CompileUnit(ID, Die);
2848 if (DIUnit.isMain()) {
2849 assert(!MainCU && "Multiple main compile units are found!");
2852 CompileUnitMap[DIUnit.getGV()] = Unit;
2853 CompileUnits.push_back(Unit);
2856 /// ConstructCompileUnits - Create a compile unit DIEs.
2857 void ConstructCompileUnits() {
2858 GlobalVariable *Root = M->getGlobalVariable("llvm.dbg.compile_units");
2861 assert(Root->hasLinkOnceLinkage() && Root->hasOneUse() &&
2862 "Malformed compile unit descriptor anchor type");
2863 Constant *RootC = cast<Constant>(*Root->use_begin());
2864 assert(RootC->hasNUsesOrMore(1) &&
2865 "Malformed compile unit descriptor anchor type");
2866 for (Value::use_iterator UI = RootC->use_begin(), UE = Root->use_end();
2868 for (Value::use_iterator UUI = UI->use_begin(), UUE = UI->use_end();
2869 UUI != UUE; ++UUI) {
2870 GlobalVariable *GV = cast<GlobalVariable>(*UUI);
2871 ConstructCompileUnit(GV);
2875 bool ConstructGlobalVariableDIE(GlobalVariable *GV) {
2876 DIGlobalVariable DI_GV(GV);
2877 CompileUnit *DW_Unit = MainCU;
2879 DW_Unit = FindCompileUnit(DI_GV.getCompileUnit());
2881 // Check for pre-existence.
2882 DIE *&Slot = DW_Unit->getDieMapSlotFor(DI_GV.getGV());
2886 DIE *VariableDie = CreateGlobalVariableDIE(DW_Unit, DI_GV);
2889 DIEBlock *Block = new DIEBlock();
2890 AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
2891 AddObjectLabel(Block, 0, DW_FORM_udata,
2892 Asm->getGlobalLinkName(DI_GV.getGlobal()));
2893 AddBlock(VariableDie, DW_AT_location, 0, Block);
2897 // Add to context owner.
2898 DW_Unit->getDie()->AddChild(VariableDie);
2899 // Expose as global. FIXME - need to check external flag.
2901 DW_Unit->AddGlobal(DI_GV.getName(Name), VariableDie);
2905 /// ConstructGlobalVariableDIEs - Create DIEs for each of the externally
2906 /// visible global variables. Return true if at least one global DIE is
2908 bool ConstructGlobalVariableDIEs() {
2909 GlobalVariable *Root = M->getGlobalVariable("llvm.dbg.global_variables");
2913 assert(Root->hasLinkOnceLinkage() && Root->hasOneUse() &&
2914 "Malformed global variable descriptor anchor type");
2915 Constant *RootC = cast<Constant>(*Root->use_begin());
2916 assert(RootC->hasNUsesOrMore(1) &&
2917 "Malformed global variable descriptor anchor type");
2919 bool Result = false;
2920 for (Value::use_iterator UI = RootC->use_begin(), UE = Root->use_end();
2922 for (Value::use_iterator UUI = UI->use_begin(), UUE = UI->use_end();
2923 UUI != UUE; ++UUI) {
2924 GlobalVariable *GV = cast<GlobalVariable>(*UUI);
2925 Result |= ConstructGlobalVariableDIE(GV);
2930 bool ConstructSubprogram(GlobalVariable *GV) {
2931 DISubprogram SP(GV);
2932 CompileUnit *Unit = MainCU;
2934 Unit = FindCompileUnit(SP.getCompileUnit());
2936 // Check for pre-existence.
2937 DIE *&Slot = Unit->getDieMapSlotFor(GV);
2941 if (!SP.isDefinition())
2942 // This is a method declaration which will be handled while
2943 // constructing class type.
2946 DIE *SubprogramDie = CreateSubprogramDIE(Unit, SP);
2949 Slot = SubprogramDie;
2950 // Add to context owner.
2951 Unit->getDie()->AddChild(SubprogramDie);
2952 // Expose as global.
2954 Unit->AddGlobal(SP.getName(Name), SubprogramDie);
2958 /// ConstructSubprograms - Create DIEs for each of the externally visible
2959 /// subprograms. Return true if at least one subprogram DIE is created.
2960 bool ConstructSubprograms() {
2961 GlobalVariable *Root = M->getGlobalVariable("llvm.dbg.subprograms");
2965 assert(Root->hasLinkOnceLinkage() && Root->hasOneUse() &&
2966 "Malformed subprogram descriptor anchor type");
2967 Constant *RootC = cast<Constant>(*Root->use_begin());
2968 assert(RootC->hasNUsesOrMore(1) &&
2969 "Malformed subprogram descriptor anchor type");
2971 bool Result = false;
2972 for (Value::use_iterator UI = RootC->use_begin(), UE = Root->use_end();
2974 for (Value::use_iterator UUI = UI->use_begin(), UUE = UI->use_end();
2975 UUI != UUE; ++UUI) {
2976 GlobalVariable *GV = cast<GlobalVariable>(*UUI);
2977 Result |= ConstructSubprogram(GV);
2983 //===--------------------------------------------------------------------===//
2984 // Main entry points.
2986 DwarfDebug(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
2987 : Dwarf(OS, A, T, "dbg"), MainCU(0),
2988 AbbreviationsSet(InitAbbreviationsSetSize), Abbreviations(),
2989 ValuesSet(InitValuesSetSize), Values(), StringPool(), SectionMap(),
2990 SectionSourceLines(), didInitial(false), shouldEmit(false),
2991 RootDbgScope(0), DebugTimer(0) {
2992 if (TimePassesIsEnabled)
2993 DebugTimer = new Timer("Dwarf Debug Writer",
2994 getDwarfTimerGroup());
2996 virtual ~DwarfDebug() {
2997 for (unsigned j = 0, M = Values.size(); j < M; ++j)
3003 /// ShouldEmitDwarfDebug - Returns true if Dwarf debugging declarations should
3005 bool ShouldEmitDwarfDebug() const { return shouldEmit; }
3007 /// SetDebugInfo - Create global DIEs and emit initial debug info sections.
3008 /// This is inovked by the target AsmPrinter.
3009 void SetDebugInfo(MachineModuleInfo *mmi) {
3010 if (TimePassesIsEnabled)
3011 DebugTimer->startTimer();
3013 // Create all the compile unit DIEs.
3014 ConstructCompileUnits();
3016 if (CompileUnits.empty()) {
3017 if (TimePassesIsEnabled)
3018 DebugTimer->stopTimer();
3023 // Create DIEs for each of the externally visible global variables.
3024 bool globalDIEs = ConstructGlobalVariableDIEs();
3026 // Create DIEs for each of the externally visible subprograms.
3027 bool subprogramDIEs = ConstructSubprograms();
3029 // If there is not any debug info available for any global variables
3030 // and any subprograms then there is not any debug info to emit.
3031 if (!globalDIEs && !subprogramDIEs) {
3032 if (TimePassesIsEnabled)
3033 DebugTimer->stopTimer();
3040 MMI->setDebugInfoAvailability(true);
3042 // Prime section data.
3043 SectionMap.insert(TAI->getTextSection());
3045 // Print out .file directives to specify files for .loc directives. These
3046 // are printed out early so that they precede any .loc directives.
3047 if (TAI->hasDotLocAndDotFile()) {
3048 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
3049 // Remember source id starts at 1.
3050 std::pair<unsigned, unsigned> Id = getSourceDirectoryAndFileIds(i);
3051 sys::Path FullPath(getSourceDirectoryName(Id.first));
3053 FullPath.appendComponent(getSourceFileName(Id.second));
3054 assert(AppendOk && "Could not append filename to directory!");
3056 Asm->EmitFile(i, FullPath.toString());
3061 // Emit initial sections
3064 if (TimePassesIsEnabled)
3065 DebugTimer->stopTimer();
3068 /// BeginModule - Emit all Dwarf sections that should come prior to the
3070 void BeginModule(Module *M) {
3074 /// EndModule - Emit all Dwarf sections that should come after the content.
3077 if (!ShouldEmitDwarfDebug())
3080 if (TimePassesIsEnabled)
3081 DebugTimer->startTimer();
3083 // Standard sections final addresses.
3084 Asm->SwitchToSection(TAI->getTextSection());
3085 EmitLabel("text_end", 0);
3086 Asm->SwitchToSection(TAI->getDataSection());
3087 EmitLabel("data_end", 0);
3089 // End text sections.
3090 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
3091 Asm->SwitchToSection(SectionMap[i]);
3092 EmitLabel("section_end", i);
3095 // Emit common frame information.
3096 EmitCommonDebugFrame();
3098 // Emit function debug frame information
3099 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
3100 E = DebugFrames.end(); I != E; ++I)
3101 EmitFunctionDebugFrame(*I);
3103 // Compute DIE offsets and sizes.
3106 // Emit all the DIEs into a debug info section
3109 // Corresponding abbreviations into a abbrev section.
3110 EmitAbbreviations();
3112 // Emit source line correspondence into a debug line section.
3115 // Emit info into a debug pubnames section.
3116 EmitDebugPubNames();
3118 // Emit info into a debug str section.
3121 // Emit info into a debug loc section.
3124 // Emit info into a debug aranges section.
3127 // Emit info into a debug ranges section.
3130 // Emit info into a debug macinfo section.
3133 if (TimePassesIsEnabled)
3134 DebugTimer->stopTimer();
3137 /// BeginFunction - Gather pre-function debug information. Assumes being
3138 /// emitted immediately after the function entry point.
3139 void BeginFunction(MachineFunction *MF) {
3142 if (!ShouldEmitDwarfDebug()) return;
3144 if (TimePassesIsEnabled)
3145 DebugTimer->startTimer();
3147 // Begin accumulating function debug information.
3148 MMI->BeginFunction(MF);
3150 // Assumes in correct section after the entry point.
3151 EmitLabel("func_begin", ++SubprogramCount);
3153 // Emit label for the implicitly defined dbg.stoppoint at the start of
3155 if (!Lines.empty()) {
3156 const SrcLineInfo &LineInfo = Lines[0];
3157 Asm->printLabel(LineInfo.getLabelID());
3160 if (TimePassesIsEnabled)
3161 DebugTimer->stopTimer();
3164 /// EndFunction - Gather and emit post-function debug information.
3166 void EndFunction(MachineFunction *MF) {
3167 if (!ShouldEmitDwarfDebug()) return;
3169 if (TimePassesIsEnabled)
3170 DebugTimer->startTimer();
3172 // Define end label for subprogram.
3173 EmitLabel("func_end", SubprogramCount);
3175 // Get function line info.
3176 if (!Lines.empty()) {
3177 // Get section line info.
3178 unsigned ID = SectionMap.insert(Asm->CurrentSection_);
3179 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
3180 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
3181 // Append the function info to section info.
3182 SectionLineInfos.insert(SectionLineInfos.end(),
3183 Lines.begin(), Lines.end());
3186 // Construct scopes for subprogram.
3188 ConstructRootDbgScope(RootDbgScope);
3190 // FIXME: This is wrong. We are essentially getting past a problem with
3191 // debug information not being able to handle unreachable blocks that have
3192 // debug information in them. In particular, those unreachable blocks that
3193 // have "region end" info in them. That situation results in the "root
3194 // scope" not being created. If that's the case, then emit a "default"
3195 // scope, i.e., one that encompasses the whole function. This isn't
3196 // desirable. And a better way of handling this (and all of the debugging
3197 // information) needs to be explored.
3198 ConstructDefaultDbgScope(MF);
3200 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
3201 MMI->getFrameMoves()));
3205 delete RootDbgScope;
3206 DbgScopeMap.clear();
3207 RootDbgScope = NULL;
3212 if (TimePassesIsEnabled)
3213 DebugTimer->stopTimer();
3216 /// ValidDebugInfo - Return true if V represents valid debug info value.
3217 bool ValidDebugInfo(Value *V) {
3224 GlobalVariable *GV = getGlobalVariable(V);
3228 if (!GV->hasInternalLinkage () && !GV->hasLinkOnceLinkage())
3231 if (TimePassesIsEnabled)
3232 DebugTimer->startTimer();
3234 DIDescriptor DI(GV);
3236 // Check current version. Allow Version6 for now.
3237 unsigned Version = DI.getVersion();
3238 if (Version != LLVMDebugVersion && Version != LLVMDebugVersion6) {
3239 if (TimePassesIsEnabled)
3240 DebugTimer->stopTimer();
3245 unsigned Tag = DI.getTag();
3247 case DW_TAG_variable:
3248 assert(DIVariable(GV).Verify() && "Invalid DebugInfo value");
3250 case DW_TAG_compile_unit:
3251 assert(DICompileUnit(GV).Verify() && "Invalid DebugInfo value");
3253 case DW_TAG_subprogram:
3254 assert(DISubprogram(GV).Verify() && "Invalid DebugInfo value");
3260 if (TimePassesIsEnabled)
3261 DebugTimer->stopTimer();
3266 /// RecordSourceLine - Records location information and associates it with a
3267 /// label. Returns a unique label ID used to generate a label and provide
3268 /// correspondence to the source line list.
3269 unsigned RecordSourceLine(Value *V, unsigned Line, unsigned Col) {
3270 if (TimePassesIsEnabled)
3271 DebugTimer->startTimer();
3273 CompileUnit *Unit = CompileUnitMap[V];
3274 assert(Unit && "Unable to find CompileUnit");
3275 unsigned ID = MMI->NextLabelID();
3276 Lines.push_back(SrcLineInfo(Line, Col, Unit->getID(), ID));
3278 if (TimePassesIsEnabled)
3279 DebugTimer->stopTimer();
3284 /// RecordSourceLine - Records location information and associates it with a
3285 /// label. Returns a unique label ID used to generate a label and provide
3286 /// correspondence to the source line list.
3287 unsigned RecordSourceLine(unsigned Line, unsigned Col, unsigned Src) {
3288 if (TimePassesIsEnabled)
3289 DebugTimer->startTimer();
3291 unsigned ID = MMI->NextLabelID();
3292 Lines.push_back(SrcLineInfo(Line, Col, Src, ID));
3294 if (TimePassesIsEnabled)
3295 DebugTimer->stopTimer();
3300 /// getRecordSourceLineCount - Return the number of source lines in the debug
3302 unsigned getRecordSourceLineCount() const {
3303 return Lines.size();
3306 /// getOrCreateSourceID - Public version of GetOrCreateSourceID. This can be
3307 /// timed. Look up the source id with the given directory and source file
3308 /// names. If none currently exists, create a new id and insert it in the
3309 /// SourceIds map. This can update DirectoryNames and SourceFileNames maps as
3311 unsigned getOrCreateSourceID(const std::string &DirName,
3312 const std::string &FileName) {
3313 if (TimePassesIsEnabled)
3314 DebugTimer->startTimer();
3316 unsigned SrcId = GetOrCreateSourceID(DirName, FileName);
3318 if (TimePassesIsEnabled)
3319 DebugTimer->stopTimer();
3324 /// RecordRegionStart - Indicate the start of a region.
3325 unsigned RecordRegionStart(GlobalVariable *V) {
3326 if (TimePassesIsEnabled)
3327 DebugTimer->startTimer();
3329 DbgScope *Scope = getOrCreateScope(V);
3330 unsigned ID = MMI->NextLabelID();
3331 if (!Scope->getStartLabelID()) Scope->setStartLabelID(ID);
3333 if (TimePassesIsEnabled)
3334 DebugTimer->stopTimer();
3339 /// RecordRegionEnd - Indicate the end of a region.
3340 unsigned RecordRegionEnd(GlobalVariable *V) {
3341 if (TimePassesIsEnabled)
3342 DebugTimer->startTimer();
3344 DbgScope *Scope = getOrCreateScope(V);
3345 unsigned ID = MMI->NextLabelID();
3346 Scope->setEndLabelID(ID);
3348 if (TimePassesIsEnabled)
3349 DebugTimer->stopTimer();
3354 /// RecordVariable - Indicate the declaration of a local variable.
3355 void RecordVariable(GlobalVariable *GV, unsigned FrameIndex) {
3356 if (TimePassesIsEnabled)
3357 DebugTimer->startTimer();
3359 DIDescriptor Desc(GV);
3360 DbgScope *Scope = NULL;
3362 if (Desc.getTag() == DW_TAG_variable) {
3363 // GV is a global variable.
3364 DIGlobalVariable DG(GV);
3365 Scope = getOrCreateScope(DG.getContext().getGV());
3367 // or GV is a local variable.
3369 Scope = getOrCreateScope(DV.getContext().getGV());
3372 assert(Scope && "Unable to find variable' scope");
3373 DbgVariable *DV = new DbgVariable(DIVariable(GV), FrameIndex);
3374 Scope->AddVariable(DV);
3376 if (TimePassesIsEnabled)
3377 DebugTimer->stopTimer();
3381 //===----------------------------------------------------------------------===//
3382 /// DwarfException - Emits Dwarf exception handling directives.
3384 class DwarfException : public Dwarf {
3385 struct FunctionEHFrameInfo {
3388 unsigned PersonalityIndex;
3390 bool hasLandingPads;
3391 std::vector<MachineMove> Moves;
3392 const Function * function;
3394 FunctionEHFrameInfo(const std::string &FN, unsigned Num, unsigned P,
3396 const std::vector<MachineMove> &M,
3398 FnName(FN), Number(Num), PersonalityIndex(P),
3399 hasCalls(hC), hasLandingPads(hL), Moves(M), function (f) { }
3402 std::vector<FunctionEHFrameInfo> EHFrames;
3404 /// shouldEmitTable - Per-function flag to indicate if EH tables should
3406 bool shouldEmitTable;
3408 /// shouldEmitMoves - Per-function flag to indicate if frame moves info
3409 /// should be emitted.
3410 bool shouldEmitMoves;
3412 /// shouldEmitTableModule - Per-module flag to indicate if EH tables
3413 /// should be emitted.
3414 bool shouldEmitTableModule;
3416 /// shouldEmitFrameModule - Per-module flag to indicate if frame moves
3417 /// should be emitted.
3418 bool shouldEmitMovesModule;
3420 /// ExceptionTimer - Timer for the Dwarf exception writer.
3421 Timer *ExceptionTimer;
3423 /// EmitCommonEHFrame - Emit the common eh unwind frame.
3425 void EmitCommonEHFrame(const Function *Personality, unsigned Index) {
3426 // Size and sign of stack growth.
3428 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3429 TargetFrameInfo::StackGrowsUp ?
3430 TD->getPointerSize() : -TD->getPointerSize();
3432 // Begin eh frame section.
3433 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3435 if (!TAI->doesRequireNonLocalEHFrameLabel())
3436 O << TAI->getEHGlobalPrefix();
3437 O << "EH_frame" << Index << ":\n";
3438 EmitLabel("section_eh_frame", Index);
3440 // Define base labels.
3441 EmitLabel("eh_frame_common", Index);
3443 // Define the eh frame length.
3444 EmitDifference("eh_frame_common_end", Index,
3445 "eh_frame_common_begin", Index, true);
3446 Asm->EOL("Length of Common Information Entry");
3449 EmitLabel("eh_frame_common_begin", Index);
3450 Asm->EmitInt32((int)0);
3451 Asm->EOL("CIE Identifier Tag");
3452 Asm->EmitInt8(DW_CIE_VERSION);
3453 Asm->EOL("CIE Version");
3455 // The personality presence indicates that language specific information
3456 // will show up in the eh frame.
3457 Asm->EmitString(Personality ? "zPLR" : "zR");
3458 Asm->EOL("CIE Augmentation");
3460 // Round out reader.
3461 Asm->EmitULEB128Bytes(1);
3462 Asm->EOL("CIE Code Alignment Factor");
3463 Asm->EmitSLEB128Bytes(stackGrowth);
3464 Asm->EOL("CIE Data Alignment Factor");
3465 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), true));
3466 Asm->EOL("CIE Return Address Column");
3468 // If there is a personality, we need to indicate the functions location.
3470 Asm->EmitULEB128Bytes(7);
3471 Asm->EOL("Augmentation Size");
3473 if (TAI->getNeedsIndirectEncoding()) {
3474 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4 | DW_EH_PE_indirect);
3475 Asm->EOL("Personality (pcrel sdata4 indirect)");
3477 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3478 Asm->EOL("Personality (pcrel sdata4)");
3481 PrintRelDirective(true);
3482 O << TAI->getPersonalityPrefix();
3483 Asm->EmitExternalGlobal((const GlobalVariable *)(Personality));
3484 O << TAI->getPersonalitySuffix();
3485 if (strcmp(TAI->getPersonalitySuffix(), "+4@GOTPCREL"))
3486 O << "-" << TAI->getPCSymbol();
3487 Asm->EOL("Personality");
3489 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3490 Asm->EOL("LSDA Encoding (pcrel sdata4)");
3492 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3493 Asm->EOL("FDE Encoding (pcrel sdata4)");
3495 Asm->EmitULEB128Bytes(1);
3496 Asm->EOL("Augmentation Size");
3498 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3499 Asm->EOL("FDE Encoding (pcrel sdata4)");
3502 // Indicate locations of general callee saved registers in frame.
3503 std::vector<MachineMove> Moves;
3504 RI->getInitialFrameState(Moves);
3505 EmitFrameMoves(NULL, 0, Moves, true);
3507 // On Darwin the linker honors the alignment of eh_frame, which means it
3508 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3509 // you get holes which confuse readers of eh_frame.
3510 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
3512 EmitLabel("eh_frame_common_end", Index);
3517 /// EmitEHFrame - Emit function exception frame information.
3519 void EmitEHFrame(const FunctionEHFrameInfo &EHFrameInfo) {
3520 Function::LinkageTypes linkage = EHFrameInfo.function->getLinkage();
3522 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3524 // Externally visible entry into the functions eh frame info.
3525 // If the corresponding function is static, this should not be
3526 // externally visible.
3527 if (linkage != Function::InternalLinkage &&
3528 linkage != Function::PrivateLinkage) {
3529 if (const char *GlobalEHDirective = TAI->getGlobalEHDirective())
3530 O << GlobalEHDirective << EHFrameInfo.FnName << "\n";
3533 // If corresponding function is weak definition, this should be too.
3534 if ((linkage == Function::WeakAnyLinkage ||
3535 linkage == Function::WeakODRLinkage ||
3536 linkage == Function::LinkOnceAnyLinkage ||
3537 linkage == Function::LinkOnceODRLinkage) &&
3538 TAI->getWeakDefDirective())
3539 O << TAI->getWeakDefDirective() << EHFrameInfo.FnName << "\n";
3541 // If there are no calls then you can't unwind. This may mean we can
3542 // omit the EH Frame, but some environments do not handle weak absolute
3544 // If UnwindTablesMandatory is set we cannot do this optimization; the
3545 // unwind info is to be available for non-EH uses.
3546 if (!EHFrameInfo.hasCalls &&
3547 !UnwindTablesMandatory &&
3548 ((linkage != Function::WeakAnyLinkage &&
3549 linkage != Function::WeakODRLinkage &&
3550 linkage != Function::LinkOnceAnyLinkage &&
3551 linkage != Function::LinkOnceODRLinkage) ||
3552 !TAI->getWeakDefDirective() ||
3553 TAI->getSupportsWeakOmittedEHFrame()))
3555 O << EHFrameInfo.FnName << " = 0\n";
3556 // This name has no connection to the function, so it might get
3557 // dead-stripped when the function is not, erroneously. Prohibit
3558 // dead-stripping unconditionally.
3559 if (const char *UsedDirective = TAI->getUsedDirective())
3560 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3562 O << EHFrameInfo.FnName << ":\n";
3565 EmitDifference("eh_frame_end", EHFrameInfo.Number,
3566 "eh_frame_begin", EHFrameInfo.Number, true);
3567 Asm->EOL("Length of Frame Information Entry");
3569 EmitLabel("eh_frame_begin", EHFrameInfo.Number);
3571 if (TAI->doesRequireNonLocalEHFrameLabel()) {
3572 PrintRelDirective(true, true);
3573 PrintLabelName("eh_frame_begin", EHFrameInfo.Number);
3575 if (!TAI->isAbsoluteEHSectionOffsets())
3576 O << "-EH_frame" << EHFrameInfo.PersonalityIndex;
3578 EmitSectionOffset("eh_frame_begin", "eh_frame_common",
3579 EHFrameInfo.Number, EHFrameInfo.PersonalityIndex,
3583 Asm->EOL("FDE CIE offset");
3585 EmitReference("eh_func_begin", EHFrameInfo.Number, true, true);
3586 Asm->EOL("FDE initial location");
3587 EmitDifference("eh_func_end", EHFrameInfo.Number,
3588 "eh_func_begin", EHFrameInfo.Number, true);
3589 Asm->EOL("FDE address range");
3591 // If there is a personality and landing pads then point to the language
3592 // specific data area in the exception table.
3593 if (EHFrameInfo.PersonalityIndex) {
3594 Asm->EmitULEB128Bytes(4);
3595 Asm->EOL("Augmentation size");
3597 if (EHFrameInfo.hasLandingPads)
3598 EmitReference("exception", EHFrameInfo.Number, true, true);
3600 Asm->EmitInt32((int)0);
3601 Asm->EOL("Language Specific Data Area");
3603 Asm->EmitULEB128Bytes(0);
3604 Asm->EOL("Augmentation size");
3607 // Indicate locations of function specific callee saved registers in
3609 EmitFrameMoves("eh_func_begin", EHFrameInfo.Number, EHFrameInfo.Moves,
3612 // On Darwin the linker honors the alignment of eh_frame, which means it
3613 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3614 // you get holes which confuse readers of eh_frame.
3615 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
3617 EmitLabel("eh_frame_end", EHFrameInfo.Number);
3619 // If the function is marked used, this table should be also. We cannot
3620 // make the mark unconditional in this case, since retaining the table
3621 // also retains the function in this case, and there is code around
3622 // that depends on unused functions (calling undefined externals) being
3623 // dead-stripped to link correctly. Yes, there really is.
3624 if (MMI->getUsedFunctions().count(EHFrameInfo.function))
3625 if (const char *UsedDirective = TAI->getUsedDirective())
3626 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3630 /// EmitExceptionTable - Emit landing pads and actions.
3632 /// The general organization of the table is complex, but the basic concepts
3633 /// are easy. First there is a header which describes the location and
3634 /// organization of the three components that follow.
3635 /// 1. The landing pad site information describes the range of code covered
3636 /// by the try. In our case it's an accumulation of the ranges covered
3637 /// by the invokes in the try. There is also a reference to the landing
3638 /// pad that handles the exception once processed. Finally an index into
3639 /// the actions table.
3640 /// 2. The action table, in our case, is composed of pairs of type ids
3641 /// and next action offset. Starting with the action index from the
3642 /// landing pad site, each type Id is checked for a match to the current
3643 /// exception. If it matches then the exception and type id are passed
3644 /// on to the landing pad. Otherwise the next action is looked up. This
3645 /// chain is terminated with a next action of zero. If no type id is
3646 /// found the the frame is unwound and handling continues.
3647 /// 3. Type id table contains references to all the C++ typeinfo for all
3648 /// catches in the function. This tables is reversed indexed base 1.
3650 /// SharedTypeIds - How many leading type ids two landing pads have in common.
3651 static unsigned SharedTypeIds(const LandingPadInfo *L,
3652 const LandingPadInfo *R) {
3653 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3654 unsigned LSize = LIds.size(), RSize = RIds.size();
3655 unsigned MinSize = LSize < RSize ? LSize : RSize;
3658 for (; Count != MinSize; ++Count)
3659 if (LIds[Count] != RIds[Count])
3665 /// PadLT - Order landing pads lexicographically by type id.
3666 static bool PadLT(const LandingPadInfo *L, const LandingPadInfo *R) {
3667 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3668 unsigned LSize = LIds.size(), RSize = RIds.size();
3669 unsigned MinSize = LSize < RSize ? LSize : RSize;
3671 for (unsigned i = 0; i != MinSize; ++i)
3672 if (LIds[i] != RIds[i])
3673 return LIds[i] < RIds[i];
3675 return LSize < RSize;
3679 static inline unsigned getEmptyKey() { return -1U; }
3680 static inline unsigned getTombstoneKey() { return -2U; }
3681 static unsigned getHashValue(const unsigned &Key) { return Key; }
3682 static bool isEqual(unsigned LHS, unsigned RHS) { return LHS == RHS; }
3683 static bool isPod() { return true; }
3686 /// ActionEntry - Structure describing an entry in the actions table.
3687 struct ActionEntry {
3688 int ValueForTypeID; // The value to write - may not be equal to the type id.
3690 struct ActionEntry *Previous;
3693 /// PadRange - Structure holding a try-range and the associated landing pad.
3695 // The index of the landing pad.
3697 // The index of the begin and end labels in the landing pad's label lists.
3698 unsigned RangeIndex;
3701 typedef DenseMap<unsigned, PadRange, KeyInfo> RangeMapType;
3703 /// CallSiteEntry - Structure describing an entry in the call-site table.
3704 struct CallSiteEntry {
3705 // The 'try-range' is BeginLabel .. EndLabel.
3706 unsigned BeginLabel; // zero indicates the start of the function.
3707 unsigned EndLabel; // zero indicates the end of the function.
3708 // The landing pad starts at PadLabel.
3709 unsigned PadLabel; // zero indicates that there is no landing pad.
3713 void EmitExceptionTable() {
3714 const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
3715 const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
3716 const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
3717 if (PadInfos.empty()) return;
3719 // Sort the landing pads in order of their type ids. This is used to fold
3720 // duplicate actions.
3721 SmallVector<const LandingPadInfo *, 64> LandingPads;
3722 LandingPads.reserve(PadInfos.size());
3723 for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
3724 LandingPads.push_back(&PadInfos[i]);
3725 std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
3727 // Negative type ids index into FilterIds, positive type ids index into
3728 // TypeInfos. The value written for a positive type id is just the type
3729 // id itself. For a negative type id, however, the value written is the
3730 // (negative) byte offset of the corresponding FilterIds entry. The byte
3731 // offset is usually equal to the type id, because the FilterIds entries
3732 // are written using a variable width encoding which outputs one byte per
3733 // entry as long as the value written is not too large, but can differ.
3734 // This kind of complication does not occur for positive type ids because
3735 // type infos are output using a fixed width encoding.
3736 // FilterOffsets[i] holds the byte offset corresponding to FilterIds[i].
3737 SmallVector<int, 16> FilterOffsets;
3738 FilterOffsets.reserve(FilterIds.size());
3740 for(std::vector<unsigned>::const_iterator I = FilterIds.begin(),
3741 E = FilterIds.end(); I != E; ++I) {
3742 FilterOffsets.push_back(Offset);
3743 Offset -= TargetAsmInfo::getULEB128Size(*I);
3746 // Compute the actions table and gather the first action index for each
3747 // landing pad site.
3748 SmallVector<ActionEntry, 32> Actions;
3749 SmallVector<unsigned, 64> FirstActions;
3750 FirstActions.reserve(LandingPads.size());
3752 int FirstAction = 0;
3753 unsigned SizeActions = 0;
3754 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3755 const LandingPadInfo *LP = LandingPads[i];
3756 const std::vector<int> &TypeIds = LP->TypeIds;
3757 const unsigned NumShared = i ? SharedTypeIds(LP, LandingPads[i-1]) : 0;
3758 unsigned SizeSiteActions = 0;
3760 if (NumShared < TypeIds.size()) {
3761 unsigned SizeAction = 0;
3762 ActionEntry *PrevAction = 0;
3765 const unsigned SizePrevIds = LandingPads[i-1]->TypeIds.size();
3766 assert(Actions.size());
3767 PrevAction = &Actions.back();
3768 SizeAction = TargetAsmInfo::getSLEB128Size(PrevAction->NextAction) +
3769 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
3770 for (unsigned j = NumShared; j != SizePrevIds; ++j) {
3772 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
3773 SizeAction += -PrevAction->NextAction;
3774 PrevAction = PrevAction->Previous;
3778 // Compute the actions.
3779 for (unsigned I = NumShared, M = TypeIds.size(); I != M; ++I) {
3780 int TypeID = TypeIds[I];
3781 assert(-1-TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
3782 int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
3783 unsigned SizeTypeID = TargetAsmInfo::getSLEB128Size(ValueForTypeID);
3785 int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
3786 SizeAction = SizeTypeID + TargetAsmInfo::getSLEB128Size(NextAction);
3787 SizeSiteActions += SizeAction;
3789 ActionEntry Action = {ValueForTypeID, NextAction, PrevAction};
3790 Actions.push_back(Action);
3792 PrevAction = &Actions.back();
3795 // Record the first action of the landing pad site.
3796 FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
3797 } // else identical - re-use previous FirstAction
3799 FirstActions.push_back(FirstAction);
3801 // Compute this sites contribution to size.
3802 SizeActions += SizeSiteActions;
3805 // Compute the call-site table. The entry for an invoke has a try-range
3806 // containing the call, a non-zero landing pad and an appropriate action.
3807 // The entry for an ordinary call has a try-range containing the call and
3808 // zero for the landing pad and the action. Calls marked 'nounwind' have
3809 // no entry and must not be contained in the try-range of any entry - they
3810 // form gaps in the table. Entries must be ordered by try-range address.
3811 SmallVector<CallSiteEntry, 64> CallSites;
3813 RangeMapType PadMap;
3814 // Invokes and nounwind calls have entries in PadMap (due to being bracketed
3815 // by try-range labels when lowered). Ordinary calls do not, so appropriate
3816 // try-ranges for them need be deduced.
3817 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3818 const LandingPadInfo *LandingPad = LandingPads[i];
3819 for (unsigned j = 0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
3820 unsigned BeginLabel = LandingPad->BeginLabels[j];
3821 assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
3822 PadRange P = { i, j };
3823 PadMap[BeginLabel] = P;
3827 // The end label of the previous invoke or nounwind try-range.
3828 unsigned LastLabel = 0;
3830 // Whether there is a potentially throwing instruction (currently this means
3831 // an ordinary call) between the end of the previous try-range and now.
3832 bool SawPotentiallyThrowing = false;
3834 // Whether the last callsite entry was for an invoke.
3835 bool PreviousIsInvoke = false;
3837 // Visit all instructions in order of address.
3838 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
3840 for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
3842 if (!MI->isLabel()) {
3843 SawPotentiallyThrowing |= MI->getDesc().isCall();
3847 unsigned BeginLabel = MI->getOperand(0).getImm();
3848 assert(BeginLabel && "Invalid label!");
3850 // End of the previous try-range?
3851 if (BeginLabel == LastLabel)
3852 SawPotentiallyThrowing = false;
3854 // Beginning of a new try-range?
3855 RangeMapType::iterator L = PadMap.find(BeginLabel);
3856 if (L == PadMap.end())
3857 // Nope, it was just some random label.
3860 PadRange P = L->second;
3861 const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
3863 assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
3864 "Inconsistent landing pad map!");
3866 // If some instruction between the previous try-range and this one may
3867 // throw, create a call-site entry with no landing pad for the region
3868 // between the try-ranges.
3869 if (SawPotentiallyThrowing) {
3870 CallSiteEntry Site = {LastLabel, BeginLabel, 0, 0};
3871 CallSites.push_back(Site);
3872 PreviousIsInvoke = false;
3875 LastLabel = LandingPad->EndLabels[P.RangeIndex];
3876 assert(BeginLabel && LastLabel && "Invalid landing pad!");
3878 if (LandingPad->LandingPadLabel) {
3879 // This try-range is for an invoke.
3880 CallSiteEntry Site = {BeginLabel, LastLabel,
3881 LandingPad->LandingPadLabel, FirstActions[P.PadIndex]};
3883 // Try to merge with the previous call-site.
3884 if (PreviousIsInvoke) {
3885 CallSiteEntry &Prev = CallSites.back();
3886 if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
3887 // Extend the range of the previous entry.
3888 Prev.EndLabel = Site.EndLabel;
3893 // Otherwise, create a new call-site.
3894 CallSites.push_back(Site);
3895 PreviousIsInvoke = true;
3898 PreviousIsInvoke = false;
3902 // If some instruction between the previous try-range and the end of the
3903 // function may throw, create a call-site entry with no landing pad for the
3904 // region following the try-range.
3905 if (SawPotentiallyThrowing) {
3906 CallSiteEntry Site = {LastLabel, 0, 0, 0};
3907 CallSites.push_back(Site);
3913 const unsigned SiteStartSize = sizeof(int32_t); // DW_EH_PE_udata4
3914 const unsigned SiteLengthSize = sizeof(int32_t); // DW_EH_PE_udata4
3915 const unsigned LandingPadSize = sizeof(int32_t); // DW_EH_PE_udata4
3916 unsigned SizeSites = CallSites.size() * (SiteStartSize +
3919 for (unsigned i = 0, e = CallSites.size(); i < e; ++i)
3920 SizeSites += TargetAsmInfo::getULEB128Size(CallSites[i].Action);
3923 const unsigned TypeInfoSize = TD->getPointerSize(); // DW_EH_PE_absptr
3924 unsigned SizeTypes = TypeInfos.size() * TypeInfoSize;
3926 unsigned TypeOffset = sizeof(int8_t) + // Call site format
3927 TargetAsmInfo::getULEB128Size(SizeSites) + // Call-site table length
3928 SizeSites + SizeActions + SizeTypes;
3930 unsigned TotalSize = sizeof(int8_t) + // LPStart format
3931 sizeof(int8_t) + // TType format
3932 TargetAsmInfo::getULEB128Size(TypeOffset) + // TType base offset
3935 unsigned SizeAlign = (4 - TotalSize) & 3;
3937 // Begin the exception table.
3938 Asm->SwitchToDataSection(TAI->getDwarfExceptionSection());
3939 Asm->EmitAlignment(2, 0, 0, false);
3940 O << "GCC_except_table" << SubprogramCount << ":\n";
3941 for (unsigned i = 0; i != SizeAlign; ++i) {
3943 Asm->EOL("Padding");
3945 EmitLabel("exception", SubprogramCount);
3948 Asm->EmitInt8(DW_EH_PE_omit);
3949 Asm->EOL("LPStart format (DW_EH_PE_omit)");
3950 Asm->EmitInt8(DW_EH_PE_absptr);
3951 Asm->EOL("TType format (DW_EH_PE_absptr)");
3952 Asm->EmitULEB128Bytes(TypeOffset);
3953 Asm->EOL("TType base offset");
3954 Asm->EmitInt8(DW_EH_PE_udata4);
3955 Asm->EOL("Call site format (DW_EH_PE_udata4)");
3956 Asm->EmitULEB128Bytes(SizeSites);
3957 Asm->EOL("Call-site table length");
3959 // Emit the landing pad site information.
3960 for (unsigned i = 0; i < CallSites.size(); ++i) {
3961 CallSiteEntry &S = CallSites[i];
3962 const char *BeginTag;
3963 unsigned BeginNumber;
3965 if (!S.BeginLabel) {
3966 BeginTag = "eh_func_begin";
3967 BeginNumber = SubprogramCount;
3970 BeginNumber = S.BeginLabel;
3973 EmitSectionOffset(BeginTag, "eh_func_begin", BeginNumber, SubprogramCount,
3975 Asm->EOL("Region start");
3978 EmitDifference("eh_func_end", SubprogramCount, BeginTag, BeginNumber,
3981 EmitDifference("label", S.EndLabel, BeginTag, BeginNumber, true);
3983 Asm->EOL("Region length");
3988 EmitSectionOffset("label", "eh_func_begin", S.PadLabel, SubprogramCount,
3990 Asm->EOL("Landing pad");
3992 Asm->EmitULEB128Bytes(S.Action);
3996 // Emit the actions.
3997 for (unsigned I = 0, N = Actions.size(); I != N; ++I) {
3998 ActionEntry &Action = Actions[I];
4000 Asm->EmitSLEB128Bytes(Action.ValueForTypeID);
4001 Asm->EOL("TypeInfo index");
4002 Asm->EmitSLEB128Bytes(Action.NextAction);
4003 Asm->EOL("Next action");
4006 // Emit the type ids.
4007 for (unsigned M = TypeInfos.size(); M; --M) {
4008 GlobalVariable *GV = TypeInfos[M - 1];
4010 PrintRelDirective();
4013 O << Asm->getGlobalLinkName(GV);
4017 Asm->EOL("TypeInfo");
4020 // Emit the filter typeids.
4021 for (unsigned j = 0, M = FilterIds.size(); j < M; ++j) {
4022 unsigned TypeID = FilterIds[j];
4023 Asm->EmitULEB128Bytes(TypeID);
4024 Asm->EOL("Filter TypeInfo index");
4027 Asm->EmitAlignment(2, 0, 0, false);
4031 //===--------------------------------------------------------------------===//
4032 // Main entry points.
4034 DwarfException(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
4035 : Dwarf(OS, A, T, "eh"), shouldEmitTable(false), shouldEmitMoves(false),
4036 shouldEmitTableModule(false), shouldEmitMovesModule(false),
4038 if (TimePassesIsEnabled)
4039 ExceptionTimer = new Timer("Dwarf Exception Writer",
4040 getDwarfTimerGroup());
4043 virtual ~DwarfException() {
4044 delete ExceptionTimer;
4047 /// SetModuleInfo - Set machine module information when it's known that pass
4048 /// manager has created it. Set by the target AsmPrinter.
4049 void SetModuleInfo(MachineModuleInfo *mmi) {
4053 /// BeginModule - Emit all exception information that should come prior to the
4055 void BeginModule(Module *M) {
4059 /// EndModule - Emit all exception information that should come after the
4062 if (TimePassesIsEnabled)
4063 ExceptionTimer->startTimer();
4065 if (shouldEmitMovesModule || shouldEmitTableModule) {
4066 const std::vector<Function *> Personalities = MMI->getPersonalities();
4067 for (unsigned i = 0; i < Personalities.size(); ++i)
4068 EmitCommonEHFrame(Personalities[i], i);
4070 for (std::vector<FunctionEHFrameInfo>::iterator I = EHFrames.begin(),
4071 E = EHFrames.end(); I != E; ++I)
4075 if (TimePassesIsEnabled)
4076 ExceptionTimer->stopTimer();
4079 /// BeginFunction - Gather pre-function exception information. Assumes being
4080 /// emitted immediately after the function entry point.
4081 void BeginFunction(MachineFunction *MF) {
4082 if (TimePassesIsEnabled)
4083 ExceptionTimer->startTimer();
4086 shouldEmitTable = shouldEmitMoves = false;
4088 if (MMI && TAI->doesSupportExceptionHandling()) {
4089 // Map all labels and get rid of any dead landing pads.
4090 MMI->TidyLandingPads();
4092 // If any landing pads survive, we need an EH table.
4093 if (MMI->getLandingPads().size())
4094 shouldEmitTable = true;
4096 // See if we need frame move info.
4097 if (!MF->getFunction()->doesNotThrow() || UnwindTablesMandatory)
4098 shouldEmitMoves = true;
4100 if (shouldEmitMoves || shouldEmitTable)
4101 // Assumes in correct section after the entry point.
4102 EmitLabel("eh_func_begin", ++SubprogramCount);
4105 shouldEmitTableModule |= shouldEmitTable;
4106 shouldEmitMovesModule |= shouldEmitMoves;
4108 if (TimePassesIsEnabled)
4109 ExceptionTimer->stopTimer();
4112 /// EndFunction - Gather and emit post-function exception information.
4114 void EndFunction() {
4115 if (TimePassesIsEnabled)
4116 ExceptionTimer->startTimer();
4118 if (shouldEmitMoves || shouldEmitTable) {
4119 EmitLabel("eh_func_end", SubprogramCount);
4120 EmitExceptionTable();
4122 // Save EH frame information
4124 push_back(FunctionEHFrameInfo(getAsm()->getCurrentFunctionEHName(MF),
4126 MMI->getPersonalityIndex(),
4127 MF->getFrameInfo()->hasCalls(),
4128 !MMI->getLandingPads().empty(),
4129 MMI->getFrameMoves(),
4130 MF->getFunction()));
4133 if (TimePassesIsEnabled)
4134 ExceptionTimer->stopTimer();
4138 } // End of namespace llvm
4140 //===----------------------------------------------------------------------===//
4142 /// Emit - Print the abbreviation using the specified Dwarf writer.
4144 void DIEAbbrev::Emit(const DwarfDebug &DD) const {
4145 // Emit its Dwarf tag type.
4146 DD.getAsm()->EmitULEB128Bytes(Tag);
4147 DD.getAsm()->EOL(TagString(Tag));
4149 // Emit whether it has children DIEs.
4150 DD.getAsm()->EmitULEB128Bytes(ChildrenFlag);
4151 DD.getAsm()->EOL(ChildrenString(ChildrenFlag));
4153 // For each attribute description.
4154 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4155 const DIEAbbrevData &AttrData = Data[i];
4157 // Emit attribute type.
4158 DD.getAsm()->EmitULEB128Bytes(AttrData.getAttribute());
4159 DD.getAsm()->EOL(AttributeString(AttrData.getAttribute()));
4162 DD.getAsm()->EmitULEB128Bytes(AttrData.getForm());
4163 DD.getAsm()->EOL(FormEncodingString(AttrData.getForm()));
4166 // Mark end of abbreviation.
4167 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(1)");
4168 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(2)");
4172 void DIEAbbrev::print(std::ostream &O) {
4173 O << "Abbreviation @"
4174 << std::hex << (intptr_t)this << std::dec
4178 << ChildrenString(ChildrenFlag)
4181 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4183 << AttributeString(Data[i].getAttribute())
4185 << FormEncodingString(Data[i].getForm())
4189 void DIEAbbrev::dump() { print(cerr); }
4192 //===----------------------------------------------------------------------===//
4195 void DIEValue::dump() {
4200 //===----------------------------------------------------------------------===//
4202 /// EmitValue - Emit integer of appropriate size.
4204 void DIEInteger::EmitValue(DwarfDebug &DD, unsigned Form) {
4206 case DW_FORM_flag: // Fall thru
4207 case DW_FORM_ref1: // Fall thru
4208 case DW_FORM_data1: DD.getAsm()->EmitInt8(Integer); break;
4209 case DW_FORM_ref2: // Fall thru
4210 case DW_FORM_data2: DD.getAsm()->EmitInt16(Integer); break;
4211 case DW_FORM_ref4: // Fall thru
4212 case DW_FORM_data4: DD.getAsm()->EmitInt32(Integer); break;
4213 case DW_FORM_ref8: // Fall thru
4214 case DW_FORM_data8: DD.getAsm()->EmitInt64(Integer); break;
4215 case DW_FORM_udata: DD.getAsm()->EmitULEB128Bytes(Integer); break;
4216 case DW_FORM_sdata: DD.getAsm()->EmitSLEB128Bytes(Integer); break;
4217 default: assert(0 && "DIE Value form not supported yet"); break;
4221 /// SizeOf - Determine size of integer value in bytes.
4223 unsigned DIEInteger::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4225 case DW_FORM_flag: // Fall thru
4226 case DW_FORM_ref1: // Fall thru
4227 case DW_FORM_data1: return sizeof(int8_t);
4228 case DW_FORM_ref2: // Fall thru
4229 case DW_FORM_data2: return sizeof(int16_t);
4230 case DW_FORM_ref4: // Fall thru
4231 case DW_FORM_data4: return sizeof(int32_t);
4232 case DW_FORM_ref8: // Fall thru
4233 case DW_FORM_data8: return sizeof(int64_t);
4234 case DW_FORM_udata: return TargetAsmInfo::getULEB128Size(Integer);
4235 case DW_FORM_sdata: return TargetAsmInfo::getSLEB128Size(Integer);
4236 default: assert(0 && "DIE Value form not supported yet"); break;
4241 //===----------------------------------------------------------------------===//
4243 /// EmitValue - Emit string value.
4245 void DIEString::EmitValue(DwarfDebug &DD, unsigned Form) {
4246 DD.getAsm()->EmitString(Str);
4249 //===----------------------------------------------------------------------===//
4251 /// EmitValue - Emit label value.
4253 void DIEDwarfLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
4254 bool IsSmall = Form == DW_FORM_data4;
4255 DD.EmitReference(Label, false, IsSmall);
4258 /// SizeOf - Determine size of label value in bytes.
4260 unsigned DIEDwarfLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4261 if (Form == DW_FORM_data4) return 4;
4262 return DD.getTargetData()->getPointerSize();
4265 //===----------------------------------------------------------------------===//
4267 /// EmitValue - Emit label value.
4269 void DIEObjectLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
4270 bool IsSmall = Form == DW_FORM_data4;
4271 DD.EmitReference(Label, false, IsSmall);
4274 /// SizeOf - Determine size of label value in bytes.
4276 unsigned DIEObjectLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4277 if (Form == DW_FORM_data4) return 4;
4278 return DD.getTargetData()->getPointerSize();
4281 //===----------------------------------------------------------------------===//
4283 /// EmitValue - Emit delta value.
4285 void DIESectionOffset::EmitValue(DwarfDebug &DD, unsigned Form) {
4286 bool IsSmall = Form == DW_FORM_data4;
4287 DD.EmitSectionOffset(Label.Tag, Section.Tag,
4288 Label.Number, Section.Number, IsSmall, IsEH, UseSet);
4291 /// SizeOf - Determine size of delta value in bytes.
4293 unsigned DIESectionOffset::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4294 if (Form == DW_FORM_data4) return 4;
4295 return DD.getTargetData()->getPointerSize();
4298 //===----------------------------------------------------------------------===//
4300 /// EmitValue - Emit delta value.
4302 void DIEDelta::EmitValue(DwarfDebug &DD, unsigned Form) {
4303 bool IsSmall = Form == DW_FORM_data4;
4304 DD.EmitDifference(LabelHi, LabelLo, IsSmall);
4307 /// SizeOf - Determine size of delta value in bytes.
4309 unsigned DIEDelta::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4310 if (Form == DW_FORM_data4) return 4;
4311 return DD.getTargetData()->getPointerSize();
4314 //===----------------------------------------------------------------------===//
4316 /// EmitValue - Emit debug information entry offset.
4318 void DIEntry::EmitValue(DwarfDebug &DD, unsigned Form) {
4319 DD.getAsm()->EmitInt32(Entry->getOffset());
4322 //===----------------------------------------------------------------------===//
4324 /// ComputeSize - calculate the size of the block.
4326 unsigned DIEBlock::ComputeSize(DwarfDebug &DD) {
4328 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
4330 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4331 Size += Values[i]->SizeOf(DD, AbbrevData[i].getForm());
4337 /// EmitValue - Emit block data.
4339 void DIEBlock::EmitValue(DwarfDebug &DD, unsigned Form) {
4341 case DW_FORM_block1: DD.getAsm()->EmitInt8(Size); break;
4342 case DW_FORM_block2: DD.getAsm()->EmitInt16(Size); break;
4343 case DW_FORM_block4: DD.getAsm()->EmitInt32(Size); break;
4344 case DW_FORM_block: DD.getAsm()->EmitULEB128Bytes(Size); break;
4345 default: assert(0 && "Improper form for block"); break;
4348 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
4350 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4352 Values[i]->EmitValue(DD, AbbrevData[i].getForm());
4356 /// SizeOf - Determine size of block data in bytes.
4358 unsigned DIEBlock::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4360 case DW_FORM_block1: return Size + sizeof(int8_t);
4361 case DW_FORM_block2: return Size + sizeof(int16_t);
4362 case DW_FORM_block4: return Size + sizeof(int32_t);
4363 case DW_FORM_block: return Size + TargetAsmInfo::getULEB128Size(Size);
4364 default: assert(0 && "Improper form for block"); break;
4369 //===----------------------------------------------------------------------===//
4370 /// DIE Implementation
4373 for (unsigned i = 0, N = Children.size(); i < N; ++i)
4377 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
4379 void DIE::AddSiblingOffset() {
4380 DIEInteger *DI = new DIEInteger(0);
4381 Values.insert(Values.begin(), DI);
4382 Abbrev.AddFirstAttribute(DW_AT_sibling, DW_FORM_ref4);
4385 /// Profile - Used to gather unique data for the value folding set.
4387 void DIE::Profile(FoldingSetNodeID &ID) {
4390 for (unsigned i = 0, N = Children.size(); i < N; ++i)
4391 ID.AddPointer(Children[i]);
4393 for (unsigned j = 0, M = Values.size(); j < M; ++j)
4394 ID.AddPointer(Values[j]);
4398 void DIE::print(std::ostream &O, unsigned IncIndent) {
4399 static unsigned IndentCount = 0;
4400 IndentCount += IncIndent;
4401 const std::string Indent(IndentCount, ' ');
4402 bool isBlock = Abbrev.getTag() == 0;
4407 << "0x" << std::hex << (intptr_t)this << std::dec
4408 << ", Offset: " << Offset
4409 << ", Size: " << Size
4413 << TagString(Abbrev.getTag())
4415 << ChildrenString(Abbrev.getChildrenFlag());
4417 O << "Size: " << Size;
4421 const SmallVector<DIEAbbrevData, 8> &Data = Abbrev.getData();
4424 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4428 O << AttributeString(Data[i].getAttribute());
4430 O << "Blk[" << i << "]";
4433 << FormEncodingString(Data[i].getForm())
4435 Values[i]->print(O);
4440 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
4441 Children[j]->print(O, 4);
4444 if (!isBlock) O << "\n";
4445 IndentCount -= IncIndent;
4453 //===----------------------------------------------------------------------===//
4454 /// DwarfWriter Implementation
4457 DwarfWriter::DwarfWriter()
4458 : ImmutablePass(&ID), DD(0), DE(0) {}
4460 DwarfWriter::~DwarfWriter() {
4465 /// BeginModule - Emit all Dwarf sections that should come prior to the
4467 void DwarfWriter::BeginModule(Module *M,
4468 MachineModuleInfo *MMI,
4469 raw_ostream &OS, AsmPrinter *A,
4470 const TargetAsmInfo *T) {
4471 DE = new DwarfException(OS, A, T);
4472 DD = new DwarfDebug(OS, A, T);
4475 DD->SetDebugInfo(MMI);
4476 DE->SetModuleInfo(MMI);
4479 /// EndModule - Emit all Dwarf sections that should come after the content.
4481 void DwarfWriter::EndModule() {
4486 /// BeginFunction - Gather pre-function debug information. Assumes being
4487 /// emitted immediately after the function entry point.
4488 void DwarfWriter::BeginFunction(MachineFunction *MF) {
4489 DE->BeginFunction(MF);
4490 DD->BeginFunction(MF);
4493 /// EndFunction - Gather and emit post-function debug information.
4495 void DwarfWriter::EndFunction(MachineFunction *MF) {
4496 DD->EndFunction(MF);
4499 if (MachineModuleInfo *MMI = DD->getMMI() ? DD->getMMI() : DE->getMMI())
4500 // Clear function debug information.
4504 /// ValidDebugInfo - Return true if V represents valid debug info value.
4505 bool DwarfWriter::ValidDebugInfo(Value *V) {
4506 return DD && DD->ValidDebugInfo(V);
4509 /// RecordSourceLine - Records location information and associates it with a
4510 /// label. Returns a unique label ID used to generate a label and provide
4511 /// correspondence to the source line list.
4512 unsigned DwarfWriter::RecordSourceLine(unsigned Line, unsigned Col,
4514 return DD->RecordSourceLine(Line, Col, Src);
4517 /// getOrCreateSourceID - Look up the source id with the given directory and
4518 /// source file names. If none currently exists, create a new id and insert it
4519 /// in the SourceIds map. This can update DirectoryNames and SourceFileNames maps
4521 unsigned DwarfWriter::getOrCreateSourceID(const std::string &DirName,
4522 const std::string &FileName) {
4523 return DD->getOrCreateSourceID(DirName, FileName);
4526 /// RecordRegionStart - Indicate the start of a region.
4527 unsigned DwarfWriter::RecordRegionStart(GlobalVariable *V) {
4528 return DD->RecordRegionStart(V);
4531 /// RecordRegionEnd - Indicate the end of a region.
4532 unsigned DwarfWriter::RecordRegionEnd(GlobalVariable *V) {
4533 return DD->RecordRegionEnd(V);
4536 /// getRecordSourceLineCount - Count source lines.
4537 unsigned DwarfWriter::getRecordSourceLineCount() {
4538 return DD->getRecordSourceLineCount();
4541 /// RecordVariable - Indicate the declaration of a local variable.
4543 void DwarfWriter::RecordVariable(GlobalVariable *GV, unsigned FrameIndex) {
4544 DD->RecordVariable(GV, FrameIndex);
4547 /// ShouldEmitDwarfDebug - Returns true if Dwarf debugging declarations should
4549 bool DwarfWriter::ShouldEmitDwarfDebug() const {
4550 return DD->ShouldEmitDwarfDebug();