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"
16 #include "llvm/ADT/DenseMap.h"
17 #include "llvm/ADT/FoldingSet.h"
18 #include "llvm/ADT/StringExtras.h"
19 #include "llvm/ADT/UniqueVector.h"
20 #include "llvm/Module.h"
21 #include "llvm/DerivedTypes.h"
22 #include "llvm/CodeGen/AsmPrinter.h"
23 #include "llvm/CodeGen/MachineModuleInfo.h"
24 #include "llvm/CodeGen/MachineFrameInfo.h"
25 #include "llvm/CodeGen/MachineLocation.h"
26 #include "llvm/Analysis/DebugInfo.h"
27 #include "llvm/Support/Debug.h"
28 #include "llvm/Support/Dwarf.h"
29 #include "llvm/Support/CommandLine.h"
30 #include "llvm/Support/DataTypes.h"
31 #include "llvm/Support/Mangler.h"
32 #include "llvm/Support/raw_ostream.h"
33 #include "llvm/System/Path.h"
34 #include "llvm/Target/TargetAsmInfo.h"
35 #include "llvm/Target/TargetRegisterInfo.h"
36 #include "llvm/Target/TargetData.h"
37 #include "llvm/Target/TargetFrameInfo.h"
38 #include "llvm/Target/TargetInstrInfo.h"
39 #include "llvm/Target/TargetMachine.h"
40 #include "llvm/Target/TargetOptions.h"
44 using namespace llvm::dwarf;
46 static RegisterPass<DwarfWriter>
47 X("dwarfwriter", "DWARF Information Writer");
48 char DwarfWriter::ID = 0;
52 //===----------------------------------------------------------------------===//
54 /// Configuration values for initial hash set sizes (log2).
56 static const unsigned InitDiesSetSize = 9; // 512
57 static const unsigned InitAbbreviationsSetSize = 9; // 512
58 static const unsigned InitValuesSetSize = 9; // 512
60 //===----------------------------------------------------------------------===//
61 /// Forward declarations.
66 //===----------------------------------------------------------------------===//
69 /// getGlobalVariablesUsing - Return all of the GlobalVariables which have the
70 /// specified value in their initializer somewhere.
72 getGlobalVariablesUsing(Value *V, std::vector<GlobalVariable*> &Result) {
73 // Scan though value users.
74 for (Value::use_iterator I = V->use_begin(), E = V->use_end(); I != E; ++I) {
75 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(*I)) {
76 // If the user is a GlobalVariable then add to result.
78 } else if (Constant *C = dyn_cast<Constant>(*I)) {
79 // If the user is a constant variable then scan its users
80 getGlobalVariablesUsing(C, Result);
85 /// getGlobalVariablesUsing - Return all of the GlobalVariables that use the
86 /// named GlobalVariable.
88 getGlobalVariablesUsing(Module &M, const std::string &RootName,
89 std::vector<GlobalVariable*> &Result) {
90 std::vector<const Type*> FieldTypes;
91 FieldTypes.push_back(Type::Int32Ty);
92 FieldTypes.push_back(Type::Int32Ty);
94 // Get the GlobalVariable root.
95 GlobalVariable *UseRoot = M.getGlobalVariable(RootName,
96 StructType::get(FieldTypes));
98 // If present and linkonce then scan for users.
99 if (UseRoot && UseRoot->hasLinkOnceLinkage())
100 getGlobalVariablesUsing(UseRoot, Result);
103 //===----------------------------------------------------------------------===//
104 /// DWLabel - Labels are used to track locations in the assembler file.
105 /// Labels appear in the form @verbatim <prefix><Tag><Number> @endverbatim,
106 /// where the tag is a category of label (Ex. location) and number is a value
107 /// unique in that category.
110 /// Tag - Label category tag. Should always be a staticly declared C string.
114 /// Number - Value to make label unique.
118 DWLabel(const char *T, unsigned N) : Tag(T), Number(N) {}
120 void Profile(FoldingSetNodeID &ID) const {
121 ID.AddString(std::string(Tag));
122 ID.AddInteger(Number);
126 void print(std::ostream *O) const {
129 void print(std::ostream &O) const {
131 if (Number) O << Number;
136 //===----------------------------------------------------------------------===//
137 /// DIEAbbrevData - Dwarf abbreviation data, describes the one attribute of a
138 /// Dwarf abbreviation.
139 class DIEAbbrevData {
141 /// Attribute - Dwarf attribute code.
145 /// Form - Dwarf form code.
150 DIEAbbrevData(unsigned A, unsigned F)
156 unsigned getAttribute() const { return Attribute; }
157 unsigned getForm() const { return Form; }
159 /// Profile - Used to gather unique data for the abbreviation folding set.
161 void Profile(FoldingSetNodeID &ID)const {
162 ID.AddInteger(Attribute);
167 //===----------------------------------------------------------------------===//
168 /// DIEAbbrev - Dwarf abbreviation, describes the organization of a debug
169 /// information object.
170 class DIEAbbrev : public FoldingSetNode {
172 /// Tag - Dwarf tag code.
176 /// Unique number for node.
180 /// ChildrenFlag - Dwarf children flag.
182 unsigned ChildrenFlag;
184 /// Data - Raw data bytes for abbreviation.
186 SmallVector<DIEAbbrevData, 8> Data;
190 DIEAbbrev(unsigned T, unsigned C)
198 unsigned getTag() const { return Tag; }
199 unsigned getNumber() const { return Number; }
200 unsigned getChildrenFlag() const { return ChildrenFlag; }
201 const SmallVector<DIEAbbrevData, 8> &getData() const { return Data; }
202 void setTag(unsigned T) { Tag = T; }
203 void setChildrenFlag(unsigned CF) { ChildrenFlag = CF; }
204 void setNumber(unsigned N) { Number = N; }
206 /// AddAttribute - Adds another set of attribute information to the
208 void AddAttribute(unsigned Attribute, unsigned Form) {
209 Data.push_back(DIEAbbrevData(Attribute, Form));
212 /// AddFirstAttribute - Adds a set of attribute information to the front
213 /// of the abbreviation.
214 void AddFirstAttribute(unsigned Attribute, unsigned Form) {
215 Data.insert(Data.begin(), DIEAbbrevData(Attribute, Form));
218 /// Profile - Used to gather unique data for the abbreviation folding set.
220 void Profile(FoldingSetNodeID &ID) {
222 ID.AddInteger(ChildrenFlag);
224 // For each attribute description.
225 for (unsigned i = 0, N = Data.size(); i < N; ++i)
229 /// Emit - Print the abbreviation using the specified Dwarf writer.
231 void Emit(const DwarfDebug &DD) const;
234 void print(std::ostream *O) {
237 void print(std::ostream &O);
242 //===----------------------------------------------------------------------===//
243 /// DIE - A structured debug information entry. Has an abbreviation which
244 /// describes it's organization.
245 class DIE : public FoldingSetNode {
247 /// Abbrev - Buffer for constructing abbreviation.
251 /// Offset - Offset in debug info section.
255 /// Size - Size of instance + children.
261 std::vector<DIE *> Children;
263 /// Attributes values.
265 SmallVector<DIEValue*, 32> Values;
268 explicit DIE(unsigned Tag)
269 : Abbrev(Tag, DW_CHILDREN_no)
278 DIEAbbrev &getAbbrev() { return Abbrev; }
279 unsigned getAbbrevNumber() const {
280 return Abbrev.getNumber();
282 unsigned getTag() const { return Abbrev.getTag(); }
283 unsigned getOffset() const { return Offset; }
284 unsigned getSize() const { return Size; }
285 const std::vector<DIE *> &getChildren() const { return Children; }
286 SmallVector<DIEValue*, 32> &getValues() { return Values; }
287 void setTag(unsigned Tag) { Abbrev.setTag(Tag); }
288 void setOffset(unsigned O) { Offset = O; }
289 void setSize(unsigned S) { Size = S; }
291 /// AddValue - Add a value and attributes to a DIE.
293 void AddValue(unsigned Attribute, unsigned Form, DIEValue *Value) {
294 Abbrev.AddAttribute(Attribute, Form);
295 Values.push_back(Value);
298 /// SiblingOffset - Return the offset of the debug information entry's
300 unsigned SiblingOffset() const { return Offset + Size; }
302 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
304 void AddSiblingOffset();
306 /// AddChild - Add a child to the DIE.
308 void AddChild(DIE *Child) {
309 Abbrev.setChildrenFlag(DW_CHILDREN_yes);
310 Children.push_back(Child);
313 /// Detach - Detaches objects connected to it after copying.
319 /// Profile - Used to gather unique data for the value folding set.
321 void Profile(FoldingSetNodeID &ID) ;
324 void print(std::ostream *O, unsigned IncIndent = 0) {
325 if (O) print(*O, IncIndent);
327 void print(std::ostream &O, unsigned IncIndent = 0);
332 //===----------------------------------------------------------------------===//
333 /// DIEValue - A debug information entry value.
335 class DIEValue : public FoldingSetNode {
348 /// Type - Type of data stored in the value.
352 explicit DIEValue(unsigned T)
355 virtual ~DIEValue() {}
358 unsigned getType() const { return Type; }
360 // Implement isa/cast/dyncast.
361 static bool classof(const DIEValue *) { return true; }
363 /// EmitValue - Emit value via the Dwarf writer.
365 virtual void EmitValue(DwarfDebug &DD, unsigned Form) = 0;
367 /// SizeOf - Return the size of a value in bytes.
369 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const = 0;
371 /// Profile - Used to gather unique data for the value folding set.
373 virtual void Profile(FoldingSetNodeID &ID) = 0;
376 void print(std::ostream *O) {
379 virtual void print(std::ostream &O) = 0;
384 //===----------------------------------------------------------------------===//
385 /// DWInteger - An integer value DIE.
387 class DIEInteger : public DIEValue {
392 explicit DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
394 // Implement isa/cast/dyncast.
395 static bool classof(const DIEInteger *) { return true; }
396 static bool classof(const DIEValue *I) { return I->Type == isInteger; }
398 /// BestForm - Choose the best form for integer.
400 static unsigned BestForm(bool IsSigned, uint64_t Integer) {
402 if ((char)Integer == (signed)Integer) return DW_FORM_data1;
403 if ((short)Integer == (signed)Integer) return DW_FORM_data2;
404 if ((int)Integer == (signed)Integer) return DW_FORM_data4;
406 if ((unsigned char)Integer == Integer) return DW_FORM_data1;
407 if ((unsigned short)Integer == Integer) return DW_FORM_data2;
408 if ((unsigned int)Integer == Integer) return DW_FORM_data4;
410 return DW_FORM_data8;
413 /// EmitValue - Emit integer of appropriate size.
415 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
417 /// SizeOf - Determine size of integer value in bytes.
419 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
421 /// Profile - Used to gather unique data for the value folding set.
423 static void Profile(FoldingSetNodeID &ID, unsigned Integer) {
424 ID.AddInteger(isInteger);
425 ID.AddInteger(Integer);
427 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Integer); }
430 virtual void print(std::ostream &O) {
431 O << "Int: " << (int64_t)Integer
432 << " 0x" << std::hex << Integer << std::dec;
437 //===----------------------------------------------------------------------===//
438 /// DIEString - A string value DIE.
440 class DIEString : public DIEValue {
442 const std::string String;
444 explicit DIEString(const std::string &S) : DIEValue(isString), String(S) {}
446 // Implement isa/cast/dyncast.
447 static bool classof(const DIEString *) { return true; }
448 static bool classof(const DIEValue *S) { return S->Type == isString; }
450 /// EmitValue - Emit string value.
452 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
454 /// SizeOf - Determine size of string value in bytes.
456 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
457 return String.size() + sizeof(char); // sizeof('\0');
460 /// Profile - Used to gather unique data for the value folding set.
462 static void Profile(FoldingSetNodeID &ID, const std::string &String) {
463 ID.AddInteger(isString);
464 ID.AddString(String);
466 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, String); }
469 virtual void print(std::ostream &O) {
470 O << "Str: \"" << String << "\"";
475 //===----------------------------------------------------------------------===//
476 /// DIEDwarfLabel - A Dwarf internal label expression DIE.
478 class DIEDwarfLabel : public DIEValue {
483 explicit DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {}
485 // Implement isa/cast/dyncast.
486 static bool classof(const DIEDwarfLabel *) { return true; }
487 static bool classof(const DIEValue *L) { return L->Type == isLabel; }
489 /// EmitValue - Emit label value.
491 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
493 /// SizeOf - Determine size of label value in bytes.
495 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
497 /// Profile - Used to gather unique data for the value folding set.
499 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label) {
500 ID.AddInteger(isLabel);
503 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
506 virtual void print(std::ostream &O) {
514 //===----------------------------------------------------------------------===//
515 /// DIEObjectLabel - A label to an object in code or data.
517 class DIEObjectLabel : public DIEValue {
519 const std::string Label;
521 explicit DIEObjectLabel(const std::string &L)
522 : DIEValue(isAsIsLabel), Label(L) {}
524 // Implement isa/cast/dyncast.
525 static bool classof(const DIEObjectLabel *) { return true; }
526 static bool classof(const DIEValue *L) { return L->Type == isAsIsLabel; }
528 /// EmitValue - Emit label value.
530 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
532 /// SizeOf - Determine size of label value in bytes.
534 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
536 /// Profile - Used to gather unique data for the value folding set.
538 static void Profile(FoldingSetNodeID &ID, const std::string &Label) {
539 ID.AddInteger(isAsIsLabel);
542 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
545 virtual void print(std::ostream &O) {
546 O << "Obj: " << Label;
551 //===----------------------------------------------------------------------===//
552 /// DIESectionOffset - A section offset DIE.
554 class DIESectionOffset : public DIEValue {
557 const DWLabel Section;
561 DIESectionOffset(const DWLabel &Lab, const DWLabel &Sec,
562 bool isEH = false, bool useSet = true)
563 : DIEValue(isSectionOffset), Label(Lab), Section(Sec),
564 IsEH(isEH), UseSet(useSet) {}
566 // Implement isa/cast/dyncast.
567 static bool classof(const DIESectionOffset *) { return true; }
568 static bool classof(const DIEValue *D) { return D->Type == isSectionOffset; }
570 /// EmitValue - Emit section offset.
572 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
574 /// SizeOf - Determine size of section offset value in bytes.
576 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
578 /// Profile - Used to gather unique data for the value folding set.
580 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label,
581 const DWLabel &Section) {
582 ID.AddInteger(isSectionOffset);
585 // IsEH and UseSet are specific to the Label/Section that we will emit
586 // the offset for; so Label/Section are enough for uniqueness.
588 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label, Section); }
591 virtual void print(std::ostream &O) {
596 O << "-" << IsEH << "-" << UseSet;
601 //===----------------------------------------------------------------------===//
602 /// DIEDelta - A simple label difference DIE.
604 class DIEDelta : public DIEValue {
606 const DWLabel LabelHi;
607 const DWLabel LabelLo;
609 DIEDelta(const DWLabel &Hi, const DWLabel &Lo)
610 : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
612 // Implement isa/cast/dyncast.
613 static bool classof(const DIEDelta *) { return true; }
614 static bool classof(const DIEValue *D) { return D->Type == isDelta; }
616 /// EmitValue - Emit delta value.
618 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
620 /// SizeOf - Determine size of delta value in bytes.
622 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
624 /// Profile - Used to gather unique data for the value folding set.
626 static void Profile(FoldingSetNodeID &ID, const DWLabel &LabelHi,
627 const DWLabel &LabelLo) {
628 ID.AddInteger(isDelta);
632 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, LabelHi, LabelLo); }
635 virtual void print(std::ostream &O) {
644 //===----------------------------------------------------------------------===//
645 /// DIEntry - A pointer to another debug information entry. An instance of this
646 /// class can also be used as a proxy for a debug information entry not yet
647 /// defined (ie. types.)
648 class DIEntry : public DIEValue {
652 explicit DIEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
654 // Implement isa/cast/dyncast.
655 static bool classof(const DIEntry *) { return true; }
656 static bool classof(const DIEValue *E) { return E->Type == isEntry; }
658 /// EmitValue - Emit debug information entry offset.
660 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
662 /// SizeOf - Determine size of debug information entry in bytes.
664 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
665 return sizeof(int32_t);
668 /// Profile - Used to gather unique data for the value folding set.
670 static void Profile(FoldingSetNodeID &ID, DIE *Entry) {
671 ID.AddInteger(isEntry);
672 ID.AddPointer(Entry);
674 virtual void Profile(FoldingSetNodeID &ID) {
675 ID.AddInteger(isEntry);
678 ID.AddPointer(Entry);
685 virtual void print(std::ostream &O) {
686 O << "Die: 0x" << std::hex << (intptr_t)Entry << std::dec;
691 //===----------------------------------------------------------------------===//
692 /// DIEBlock - A block of values. Primarily used for location expressions.
694 class DIEBlock : public DIEValue, public DIE {
696 unsigned Size; // Size in bytes excluding size header.
706 // Implement isa/cast/dyncast.
707 static bool classof(const DIEBlock *) { return true; }
708 static bool classof(const DIEValue *E) { return E->Type == isBlock; }
710 /// ComputeSize - calculate the size of the block.
712 unsigned ComputeSize(DwarfDebug &DD);
714 /// BestForm - Choose the best form for data.
716 unsigned BestForm() const {
717 if ((unsigned char)Size == Size) return DW_FORM_block1;
718 if ((unsigned short)Size == Size) return DW_FORM_block2;
719 if ((unsigned int)Size == Size) return DW_FORM_block4;
720 return DW_FORM_block;
723 /// EmitValue - Emit block data.
725 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
727 /// SizeOf - Determine size of block data in bytes.
729 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
732 /// Profile - Used to gather unique data for the value folding set.
734 virtual void Profile(FoldingSetNodeID &ID) {
735 ID.AddInteger(isBlock);
740 virtual void print(std::ostream &O) {
747 //===----------------------------------------------------------------------===//
748 /// CompileUnit - This dwarf writer support class manages information associate
749 /// with a source file.
752 /// Desc - Compile unit debug descriptor.
754 CompileUnitDesc *Desc;
756 /// ID - File identifier for source.
760 /// Die - Compile unit debug information entry.
764 /// DescToDieMap - Tracks the mapping of unit level debug informaton
765 /// descriptors to debug information entries.
766 std::map<DebugInfoDesc *, DIE *> DescToDieMap;
767 DenseMap<GlobalVariable *, DIE *> GVToDieMap;
769 /// DescToDIEntryMap - Tracks the mapping of unit level debug informaton
770 /// descriptors to debug information entries using a DIEntry proxy.
771 std::map<DebugInfoDesc *, DIEntry *> DescToDIEntryMap;
772 DenseMap<GlobalVariable *, DIEntry *> GVToDIEntryMap;
774 /// Globals - A map of globally visible named entities for this unit.
776 std::map<std::string, DIE *> Globals;
778 /// DiesSet - Used to uniquely define dies within the compile unit.
780 FoldingSet<DIE> DiesSet;
782 /// Dies - List of all dies in the compile unit.
784 std::vector<DIE *> Dies;
787 CompileUnit(unsigned I, DIE *D)
788 : ID(I), Die(D), DescToDieMap(), GVToDieMap(), DescToDIEntryMap(),
789 GVToDIEntryMap(), Globals(), DiesSet(InitDiesSetSize), Dies()
792 CompileUnit(CompileUnitDesc *CUD, unsigned I, DIE *D)
801 , DiesSet(InitDiesSetSize)
808 for (unsigned i = 0, N = Dies.size(); i < N; ++i)
813 CompileUnitDesc *getDesc() const { return Desc; }
814 unsigned getID() const { return ID; }
815 DIE* getDie() const { return Die; }
816 std::map<std::string, DIE *> &getGlobals() { return Globals; }
818 /// hasContent - Return true if this compile unit has something to write out.
820 bool hasContent() const {
821 return !Die->getChildren().empty();
824 /// AddGlobal - Add a new global entity to the compile unit.
826 void AddGlobal(const std::string &Name, DIE *Die) {
830 /// getDieMapSlotFor - Returns the debug information entry map slot for the
831 /// specified debug descriptor.
832 DIE *&getDieMapSlotFor(DebugInfoDesc *DID) {
833 return DescToDieMap[DID];
835 DIE *&getDieMapSlotFor(GlobalVariable *GV) {
836 return GVToDieMap[GV];
839 /// getDIEntrySlotFor - Returns the debug information entry proxy slot for the
840 /// specified debug descriptor.
841 DIEntry *&getDIEntrySlotFor(DebugInfoDesc *DID) {
842 return DescToDIEntryMap[DID];
844 DIEntry *&getDIEntrySlotFor(GlobalVariable *GV) {
845 return GVToDIEntryMap[GV];
848 /// AddDie - Adds or interns the DIE to the compile unit.
850 DIE *AddDie(DIE &Buffer) {
854 DIE *Die = DiesSet.FindNodeOrInsertPos(ID, Where);
857 Die = new DIE(Buffer);
858 DiesSet.InsertNode(Die, Where);
859 this->Die->AddChild(Die);
867 //===----------------------------------------------------------------------===//
868 /// Dwarf - Emits general Dwarf directives.
874 //===--------------------------------------------------------------------===//
875 // Core attributes used by the Dwarf writer.
879 /// O - Stream to .s file.
883 /// Asm - Target of Dwarf emission.
887 /// TAI - Target asm information.
888 const TargetAsmInfo *TAI;
890 /// TD - Target data.
891 const TargetData *TD;
893 /// RI - Register Information.
894 const TargetRegisterInfo *RI;
896 /// M - Current module.
900 /// MF - Current machine function.
904 /// MMI - Collected machine module information.
906 MachineModuleInfo *MMI;
908 /// SubprogramCount - The running count of functions being compiled.
910 unsigned SubprogramCount;
912 /// Flavor - A unique string indicating what dwarf producer this is, used to
914 const char * const Flavor;
917 Dwarf(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T,
922 , TD(Asm->TM.getTargetData())
923 , RI(Asm->TM.getRegisterInfo())
935 //===--------------------------------------------------------------------===//
938 AsmPrinter *getAsm() const { return Asm; }
939 MachineModuleInfo *getMMI() const { return MMI; }
940 const TargetAsmInfo *getTargetAsmInfo() const { return TAI; }
941 const TargetData *getTargetData() const { return TD; }
943 void PrintRelDirective(bool Force32Bit = false, bool isInSection = false)
945 if (isInSection && TAI->getDwarfSectionOffsetDirective())
946 O << TAI->getDwarfSectionOffsetDirective();
947 else if (Force32Bit || TD->getPointerSize() == sizeof(int32_t))
948 O << TAI->getData32bitsDirective();
950 O << TAI->getData64bitsDirective();
953 /// PrintLabelName - Print label name in form used by Dwarf writer.
955 void PrintLabelName(DWLabel Label) const {
956 PrintLabelName(Label.Tag, Label.Number);
958 void PrintLabelName(const char *Tag, unsigned Number) const {
959 O << TAI->getPrivateGlobalPrefix() << Tag;
960 if (Number) O << Number;
963 void PrintLabelName(const char *Tag, unsigned Number,
964 const char *Suffix) const {
965 O << TAI->getPrivateGlobalPrefix() << Tag;
966 if (Number) O << Number;
970 /// EmitLabel - Emit location label for internal use by Dwarf.
972 void EmitLabel(DWLabel Label) const {
973 EmitLabel(Label.Tag, Label.Number);
975 void EmitLabel(const char *Tag, unsigned Number) const {
976 PrintLabelName(Tag, Number);
980 /// EmitReference - Emit a reference to a label.
982 void EmitReference(DWLabel Label, bool IsPCRelative = false,
983 bool Force32Bit = false) const {
984 EmitReference(Label.Tag, Label.Number, IsPCRelative, Force32Bit);
986 void EmitReference(const char *Tag, unsigned Number,
987 bool IsPCRelative = false, bool Force32Bit = false) const {
988 PrintRelDirective(Force32Bit);
989 PrintLabelName(Tag, Number);
991 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
993 void EmitReference(const std::string &Name, bool IsPCRelative = false,
994 bool Force32Bit = false) const {
995 PrintRelDirective(Force32Bit);
999 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
1002 /// EmitDifference - Emit the difference between two labels. Some
1003 /// assemblers do not behave with absolute expressions with data directives,
1004 /// so there is an option (needsSet) to use an intermediary set expression.
1005 void EmitDifference(DWLabel LabelHi, DWLabel LabelLo,
1006 bool IsSmall = false) {
1007 EmitDifference(LabelHi.Tag, LabelHi.Number,
1008 LabelLo.Tag, LabelLo.Number,
1011 void EmitDifference(const char *TagHi, unsigned NumberHi,
1012 const char *TagLo, unsigned NumberLo,
1013 bool IsSmall = false) {
1014 if (TAI->needsSet()) {
1016 PrintLabelName("set", SetCounter, Flavor);
1018 PrintLabelName(TagHi, NumberHi);
1020 PrintLabelName(TagLo, NumberLo);
1023 PrintRelDirective(IsSmall);
1024 PrintLabelName("set", SetCounter, Flavor);
1027 PrintRelDirective(IsSmall);
1029 PrintLabelName(TagHi, NumberHi);
1031 PrintLabelName(TagLo, NumberLo);
1035 void EmitSectionOffset(const char* Label, const char* Section,
1036 unsigned LabelNumber, unsigned SectionNumber,
1037 bool IsSmall = false, bool isEH = false,
1038 bool useSet = true) {
1039 bool printAbsolute = false;
1041 printAbsolute = TAI->isAbsoluteEHSectionOffsets();
1043 printAbsolute = TAI->isAbsoluteDebugSectionOffsets();
1045 if (TAI->needsSet() && useSet) {
1047 PrintLabelName("set", SetCounter, Flavor);
1049 PrintLabelName(Label, LabelNumber);
1051 if (!printAbsolute) {
1053 PrintLabelName(Section, SectionNumber);
1057 PrintRelDirective(IsSmall);
1059 PrintLabelName("set", SetCounter, Flavor);
1062 PrintRelDirective(IsSmall, true);
1064 PrintLabelName(Label, LabelNumber);
1066 if (!printAbsolute) {
1068 PrintLabelName(Section, SectionNumber);
1073 /// EmitFrameMoves - Emit frame instructions to describe the layout of the
1075 void EmitFrameMoves(const char *BaseLabel, unsigned BaseLabelID,
1076 const std::vector<MachineMove> &Moves, bool isEH) {
1078 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
1079 TargetFrameInfo::StackGrowsUp ?
1080 TD->getPointerSize() : -TD->getPointerSize();
1081 bool IsLocal = BaseLabel && strcmp(BaseLabel, "label") == 0;
1083 for (unsigned i = 0, N = Moves.size(); i < N; ++i) {
1084 const MachineMove &Move = Moves[i];
1085 unsigned LabelID = Move.getLabelID();
1088 LabelID = MMI->MappedLabel(LabelID);
1090 // Throw out move if the label is invalid.
1091 if (!LabelID) continue;
1094 const MachineLocation &Dst = Move.getDestination();
1095 const MachineLocation &Src = Move.getSource();
1097 // Advance row if new location.
1098 if (BaseLabel && LabelID && (BaseLabelID != LabelID || !IsLocal)) {
1099 Asm->EmitInt8(DW_CFA_advance_loc4);
1100 Asm->EOL("DW_CFA_advance_loc4");
1101 EmitDifference("label", LabelID, BaseLabel, BaseLabelID, true);
1104 BaseLabelID = LabelID;
1105 BaseLabel = "label";
1109 // If advancing cfa.
1110 if (Dst.isReg() && Dst.getReg() == MachineLocation::VirtualFP) {
1112 if (Src.getReg() == MachineLocation::VirtualFP) {
1113 Asm->EmitInt8(DW_CFA_def_cfa_offset);
1114 Asm->EOL("DW_CFA_def_cfa_offset");
1116 Asm->EmitInt8(DW_CFA_def_cfa);
1117 Asm->EOL("DW_CFA_def_cfa");
1118 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Src.getReg(), isEH));
1119 Asm->EOL("Register");
1122 int Offset = -Src.getOffset();
1124 Asm->EmitULEB128Bytes(Offset);
1127 assert(0 && "Machine move no supported yet.");
1129 } else if (Src.isReg() &&
1130 Src.getReg() == MachineLocation::VirtualFP) {
1132 Asm->EmitInt8(DW_CFA_def_cfa_register);
1133 Asm->EOL("DW_CFA_def_cfa_register");
1134 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Dst.getReg(), isEH));
1135 Asm->EOL("Register");
1137 assert(0 && "Machine move no supported yet.");
1140 unsigned Reg = RI->getDwarfRegNum(Src.getReg(), isEH);
1141 int Offset = Dst.getOffset() / stackGrowth;
1144 Asm->EmitInt8(DW_CFA_offset_extended_sf);
1145 Asm->EOL("DW_CFA_offset_extended_sf");
1146 Asm->EmitULEB128Bytes(Reg);
1148 Asm->EmitSLEB128Bytes(Offset);
1150 } else if (Reg < 64) {
1151 Asm->EmitInt8(DW_CFA_offset + Reg);
1153 Asm->EOL("DW_CFA_offset + Reg (" + utostr(Reg) + ")");
1156 Asm->EmitULEB128Bytes(Offset);
1159 Asm->EmitInt8(DW_CFA_offset_extended);
1160 Asm->EOL("DW_CFA_offset_extended");
1161 Asm->EmitULEB128Bytes(Reg);
1163 Asm->EmitULEB128Bytes(Offset);
1172 //===----------------------------------------------------------------------===//
1173 /// SrcLineInfo - This class is used to record source line correspondence.
1176 unsigned Line; // Source line number.
1177 unsigned Column; // Source column.
1178 unsigned SourceID; // Source ID number.
1179 unsigned LabelID; // Label in code ID number.
1181 SrcLineInfo(unsigned L, unsigned C, unsigned S, unsigned I)
1182 : Line(L), Column(C), SourceID(S), LabelID(I) {}
1185 unsigned getLine() const { return Line; }
1186 unsigned getColumn() const { return Column; }
1187 unsigned getSourceID() const { return SourceID; }
1188 unsigned getLabelID() const { return LabelID; }
1192 //===----------------------------------------------------------------------===//
1193 /// SrcFileInfo - This class is used to track source information.
1196 unsigned DirectoryID; // Directory ID number.
1197 std::string Name; // File name (not including directory.)
1199 SrcFileInfo(unsigned D, const std::string &N) : DirectoryID(D), Name(N) {}
1202 unsigned getDirectoryID() const { return DirectoryID; }
1203 const std::string &getName() const { return Name; }
1205 /// operator== - Used by UniqueVector to locate entry.
1207 bool operator==(const SourceFileInfo &SI) const {
1208 return getDirectoryID() == SI.getDirectoryID() && getName() == SI.getName();
1211 /// operator< - Used by UniqueVector to locate entry.
1213 bool operator<(const SrcFileInfo &SI) const {
1214 return getDirectoryID() < SI.getDirectoryID() ||
1215 (getDirectoryID() == SI.getDirectoryID() && getName() < SI.getName());
1219 //===----------------------------------------------------------------------===//
1220 /// DbgVariable - This class is used to track local variable information.
1224 DIVariable *Var; // Variable Descriptor.
1225 unsigned FrameIndex; // Variable frame index.
1228 DbgVariable(DIVariable *V, unsigned I) : Var(V), FrameIndex(I) {}
1231 DIVariable *getVariable() const { return Var; }
1232 unsigned getFrameIndex() const { return FrameIndex; }
1235 //===----------------------------------------------------------------------===//
1236 /// DbgScope - This class is used to track scope information.
1240 DbgScope *Parent; // Parent to this scope.
1241 DIDescriptor *Desc; // Debug info descriptor for scope.
1242 // Either subprogram or block.
1243 unsigned StartLabelID; // Label ID of the beginning of scope.
1244 unsigned EndLabelID; // Label ID of the end of scope.
1245 SmallVector<DbgScope *, 4> Scopes; // Scopes defined in scope.
1246 SmallVector<DbgVariable *, 8> Variables;// Variables declared in scope.
1249 DbgScope(DbgScope *P, DIDescriptor *D)
1250 : Parent(P), Desc(D), StartLabelID(0), EndLabelID(0), Scopes(), Variables()
1253 for (unsigned i = 0, N = Scopes.size(); i < N; ++i) delete Scopes[i];
1254 for (unsigned j = 0, M = Variables.size(); j < M; ++j) delete Variables[j];
1258 DbgScope *getParent() const { return Parent; }
1259 DIDescriptor *getDesc() const { return Desc; }
1260 unsigned getStartLabelID() const { return StartLabelID; }
1261 unsigned getEndLabelID() const { return EndLabelID; }
1262 SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
1263 SmallVector<DbgVariable *, 8> &getVariables() { return Variables; }
1264 void setStartLabelID(unsigned S) { StartLabelID = S; }
1265 void setEndLabelID(unsigned E) { EndLabelID = E; }
1267 /// AddScope - Add a scope to the scope.
1269 void AddScope(DbgScope *S) { Scopes.push_back(S); }
1271 /// AddVariable - Add a variable to the scope.
1273 void AddVariable(DbgVariable *V) { Variables.push_back(V); }
1276 //===----------------------------------------------------------------------===//
1277 /// DwarfDebug - Emits Dwarf debug directives.
1279 class DwarfDebug : public Dwarf {
1282 //===--------------------------------------------------------------------===//
1283 // Attributes used to construct specific Dwarf sections.
1286 /// CompileUnits - All the compile units involved in this build. The index
1287 /// of each entry in this vector corresponds to the sources in MMI.
1288 std::vector<CompileUnit *> CompileUnits;
1289 DenseMap<Value *, CompileUnit *> DW_CUs;
1291 /// AbbreviationsSet - Used to uniquely define abbreviations.
1293 FoldingSet<DIEAbbrev> AbbreviationsSet;
1295 /// Abbreviations - A list of all the unique abbreviations in use.
1297 std::vector<DIEAbbrev *> Abbreviations;
1299 /// ValuesSet - Used to uniquely define values.
1301 // Directories - Uniquing vector for directories.
1302 UniqueVector<std::string> Directories;
1304 // SourceFiles - Uniquing vector for source files.
1305 UniqueVector<SrcFileInfo> SrcFiles;
1307 // Lines - List of of source line correspondence.
1308 std::vector<SrcLineInfo> Lines;
1310 FoldingSet<DIEValue> ValuesSet;
1312 /// Values - A list of all the unique values in use.
1314 std::vector<DIEValue *> Values;
1316 /// StringPool - A UniqueVector of strings used by indirect references.
1318 UniqueVector<std::string> StringPool;
1320 /// UnitMap - Map debug information descriptor to compile unit.
1322 std::map<DebugInfoDesc *, CompileUnit *> DescToUnitMap;
1324 /// SectionMap - Provides a unique id per text section.
1326 UniqueVector<const Section*> SectionMap;
1328 /// SectionSourceLines - Tracks line numbers per text section.
1330 std::vector<std::vector<SrcLineInfo> > SectionSourceLines;
1332 /// didInitial - Flag to indicate if initial emission has been done.
1336 /// shouldEmit - Flag to indicate if debug information should be emitted.
1340 // RootScope - Top level scope for the current function.
1342 DbgScope *RootDbgScope;
1344 // DbgScopeMap - Tracks the scopes in the current function.
1345 DenseMap<GlobalVariable *, DbgScope *> DbgScopeMap;
1347 struct FunctionDebugFrameInfo {
1349 std::vector<MachineMove> Moves;
1351 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M):
1352 Number(Num), Moves(M) { }
1355 std::vector<FunctionDebugFrameInfo> DebugFrames;
1359 /// ShouldEmitDwarf - Returns true if Dwarf declarations should be made.
1361 bool ShouldEmitDwarf() const { return shouldEmit; }
1363 /// AssignAbbrevNumber - Define a unique number for the abbreviation.
1365 void AssignAbbrevNumber(DIEAbbrev &Abbrev) {
1366 // Profile the node so that we can make it unique.
1367 FoldingSetNodeID ID;
1370 // Check the set for priors.
1371 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
1373 // If it's newly added.
1374 if (InSet == &Abbrev) {
1375 // Add to abbreviation list.
1376 Abbreviations.push_back(&Abbrev);
1377 // Assign the vector position + 1 as its number.
1378 Abbrev.setNumber(Abbreviations.size());
1380 // Assign existing abbreviation number.
1381 Abbrev.setNumber(InSet->getNumber());
1385 /// NewString - Add a string to the constant pool and returns a label.
1387 DWLabel NewString(const std::string &String) {
1388 unsigned StringID = StringPool.insert(String);
1389 return DWLabel("string", StringID);
1392 /// NewDIEntry - Creates a new DIEntry to be a proxy for a debug information
1394 DIEntry *NewDIEntry(DIE *Entry = NULL) {
1398 FoldingSetNodeID ID;
1399 DIEntry::Profile(ID, Entry);
1401 Value = static_cast<DIEntry *>(ValuesSet.FindNodeOrInsertPos(ID, Where));
1403 if (Value) return Value;
1405 Value = new DIEntry(Entry);
1406 ValuesSet.InsertNode(Value, Where);
1408 Value = new DIEntry(Entry);
1411 Values.push_back(Value);
1415 /// SetDIEntry - Set a DIEntry once the debug information entry is defined.
1417 void SetDIEntry(DIEntry *Value, DIE *Entry) {
1418 Value->Entry = Entry;
1419 // Add to values set if not already there. If it is, we merely have a
1420 // duplicate in the values list (no harm.)
1421 ValuesSet.GetOrInsertNode(Value);
1424 /// AddUInt - Add an unsigned integer attribute data and value.
1426 void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer) {
1427 if (!Form) Form = DIEInteger::BestForm(false, Integer);
1429 FoldingSetNodeID ID;
1430 DIEInteger::Profile(ID, Integer);
1432 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1434 Value = new DIEInteger(Integer);
1435 ValuesSet.InsertNode(Value, Where);
1436 Values.push_back(Value);
1439 Die->AddValue(Attribute, Form, Value);
1442 /// AddSInt - Add an signed integer attribute data and value.
1444 void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer) {
1445 if (!Form) Form = DIEInteger::BestForm(true, Integer);
1447 FoldingSetNodeID ID;
1448 DIEInteger::Profile(ID, (uint64_t)Integer);
1450 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1452 Value = new DIEInteger(Integer);
1453 ValuesSet.InsertNode(Value, Where);
1454 Values.push_back(Value);
1457 Die->AddValue(Attribute, Form, Value);
1460 /// AddString - Add a std::string attribute data and value.
1462 void AddString(DIE *Die, unsigned Attribute, unsigned Form,
1463 const std::string &String) {
1464 FoldingSetNodeID ID;
1465 DIEString::Profile(ID, String);
1467 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1469 Value = new DIEString(String);
1470 ValuesSet.InsertNode(Value, Where);
1471 Values.push_back(Value);
1474 Die->AddValue(Attribute, Form, Value);
1477 /// AddLabel - Add a Dwarf label attribute data and value.
1479 void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
1480 const DWLabel &Label) {
1481 FoldingSetNodeID ID;
1482 DIEDwarfLabel::Profile(ID, Label);
1484 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1486 Value = new DIEDwarfLabel(Label);
1487 ValuesSet.InsertNode(Value, Where);
1488 Values.push_back(Value);
1491 Die->AddValue(Attribute, Form, Value);
1494 /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
1496 void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
1497 const std::string &Label) {
1498 FoldingSetNodeID ID;
1499 DIEObjectLabel::Profile(ID, Label);
1501 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1503 Value = new DIEObjectLabel(Label);
1504 ValuesSet.InsertNode(Value, Where);
1505 Values.push_back(Value);
1508 Die->AddValue(Attribute, Form, Value);
1511 /// AddSectionOffset - Add a section offset label attribute data and value.
1513 void AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
1514 const DWLabel &Label, const DWLabel &Section,
1515 bool isEH = false, bool useSet = true) {
1516 FoldingSetNodeID ID;
1517 DIESectionOffset::Profile(ID, Label, Section);
1519 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1521 Value = new DIESectionOffset(Label, Section, isEH, useSet);
1522 ValuesSet.InsertNode(Value, Where);
1523 Values.push_back(Value);
1526 Die->AddValue(Attribute, Form, Value);
1529 /// AddDelta - Add a label delta attribute data and value.
1531 void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
1532 const DWLabel &Hi, const DWLabel &Lo) {
1533 FoldingSetNodeID ID;
1534 DIEDelta::Profile(ID, Hi, Lo);
1536 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1538 Value = new DIEDelta(Hi, Lo);
1539 ValuesSet.InsertNode(Value, Where);
1540 Values.push_back(Value);
1543 Die->AddValue(Attribute, Form, Value);
1546 /// AddDIEntry - Add a DIE attribute data and value.
1548 void AddDIEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
1549 Die->AddValue(Attribute, Form, NewDIEntry(Entry));
1552 /// AddBlock - Add block data.
1554 void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block) {
1555 Block->ComputeSize(*this);
1556 FoldingSetNodeID ID;
1559 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1562 ValuesSet.InsertNode(Value, Where);
1563 Values.push_back(Value);
1565 // Already exists, reuse the previous one.
1567 Block = cast<DIEBlock>(Value);
1570 Die->AddValue(Attribute, Block->BestForm(), Value);
1575 /// AddSourceLine - Add location information to specified debug information
1577 void AddSourceLine(DIE *Die, CompileUnitDesc *File, unsigned Line) {
1579 CompileUnit *FileUnit = FindCompileUnit(File);
1580 unsigned FileID = FileUnit->getID();
1581 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1582 AddUInt(Die, DW_AT_decl_line, 0, Line);
1586 /// AddSourceLine - Add location information to specified debug information
1588 void AddSourceLine(DIE *Die, DIVariable *V) {
1589 unsigned FileID = 0;
1590 unsigned Line = V->getLineNumber();
1591 if (V->getVersion() < DIDescriptor::Version7) {
1592 // Version6 or earlier. Use compile unit info to get file id.
1593 CompileUnit *Unit = FindCompileUnit(V->getCompileUnit());
1594 FileID = Unit->getID();
1596 // Version7 or newer, use filename and directory info from DIVariable
1598 unsigned DID = Directories.idFor(V->getDirectory());
1599 FileID = SrcFiles.idFor(SrcFileInfo(DID, V->getFilename()));
1601 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1602 AddUInt(Die, DW_AT_decl_line, 0, Line);
1605 /// AddSourceLine - Add location information to specified debug information
1607 void AddSourceLine(DIE *Die, DIGlobal *G) {
1608 unsigned FileID = 0;
1609 unsigned Line = G->getLineNumber();
1610 if (G->getVersion() < DIDescriptor::Version7) {
1611 // Version6 or earlier. Use compile unit info to get file id.
1612 CompileUnit *Unit = FindCompileUnit(G->getCompileUnit());
1613 FileID = Unit->getID();
1615 // Version7 or newer, use filename and directory info from DIGlobal
1617 unsigned DID = Directories.idFor(G->getDirectory());
1618 FileID = SrcFiles.idFor(SrcFileInfo(DID, G->getFilename()));
1620 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1621 AddUInt(Die, DW_AT_decl_line, 0, Line);
1624 void AddSourceLine(DIE *Die, DIType *G) {
1625 unsigned FileID = 0;
1626 unsigned Line = G->getLineNumber();
1627 if (G->getVersion() < DIDescriptor::Version7) {
1628 // Version6 or earlier. Use compile unit info to get file id.
1629 CompileUnit *Unit = FindCompileUnit(G->getCompileUnit());
1630 FileID = Unit->getID();
1632 // Version7 or newer, use filename and directory info from DIGlobal
1634 unsigned DID = Directories.idFor(G->getDirectory());
1635 FileID = SrcFiles.idFor(SrcFileInfo(DID, G->getFilename()));
1637 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1638 AddUInt(Die, DW_AT_decl_line, 0, Line);
1641 /// AddAddress - Add an address attribute to a die based on the location
1643 void AddAddress(DIE *Die, unsigned Attribute,
1644 const MachineLocation &Location) {
1645 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
1646 DIEBlock *Block = new DIEBlock();
1648 if (Location.isReg()) {
1650 AddUInt(Block, 0, DW_FORM_data1, DW_OP_reg0 + Reg);
1652 AddUInt(Block, 0, DW_FORM_data1, DW_OP_regx);
1653 AddUInt(Block, 0, DW_FORM_udata, Reg);
1657 AddUInt(Block, 0, DW_FORM_data1, DW_OP_breg0 + Reg);
1659 AddUInt(Block, 0, DW_FORM_data1, DW_OP_bregx);
1660 AddUInt(Block, 0, DW_FORM_udata, Reg);
1662 AddUInt(Block, 0, DW_FORM_sdata, Location.getOffset());
1665 AddBlock(Die, Attribute, 0, Block);
1668 /// AddBasicType - Add a new basic type attribute to the specified entity.
1670 void AddBasicType(DIE *Entity, CompileUnit *Unit,
1671 const std::string &Name,
1672 unsigned Encoding, unsigned Size) {
1674 DIE Buffer(DW_TAG_base_type);
1675 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1676 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, Encoding);
1677 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1678 DIE *BasicTypeDie = Unit->AddDie(Buffer);
1679 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, BasicTypeDie);
1682 /// AddPointerType - Add a new pointer type attribute to the specified entity.
1684 void AddPointerType(DIE *Entity, CompileUnit *Unit, const std::string &Name) {
1685 DIE Buffer(DW_TAG_pointer_type);
1686 AddUInt(&Buffer, DW_AT_byte_size, 0, TD->getPointerSize());
1687 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1688 DIE *PointerTypeDie = Unit->AddDie(Buffer);
1689 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, PointerTypeDie);
1692 /// AddType - Add a new type attribute to the specified entity.
1694 void AddType(DIE *Entity, TypeDesc *TyDesc, CompileUnit *Unit) {
1696 AddBasicType(Entity, Unit, "", DW_ATE_signed, sizeof(int32_t));
1698 // Check for pre-existence.
1699 DIEntry *&Slot = Unit->getDIEntrySlotFor(TyDesc);
1701 // If it exists then use the existing value.
1703 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1707 if (SubprogramDesc *SubprogramTy = dyn_cast<SubprogramDesc>(TyDesc)) {
1708 // FIXME - Not sure why programs and variables are coming through here.
1709 // Short cut for handling subprogram types (not really a TyDesc.)
1710 AddPointerType(Entity, Unit, SubprogramTy->getName());
1711 } else if (GlobalVariableDesc *GlobalTy =
1712 dyn_cast<GlobalVariableDesc>(TyDesc)) {
1713 // FIXME - Not sure why programs and variables are coming through here.
1714 // Short cut for handling global variable types (not really a TyDesc.)
1715 AddPointerType(Entity, Unit, GlobalTy->getName());
1718 Slot = NewDIEntry();
1721 DIE Buffer(DW_TAG_base_type);
1722 ConstructType(Buffer, TyDesc, Unit);
1724 // Add debug information entry to entity and unit.
1725 DIE *Die = Unit->AddDie(Buffer);
1726 SetDIEntry(Slot, Die);
1727 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1732 /// AddType - Add a new type attribute to the specified entity.
1733 void AddType(CompileUnit *DW_Unit, DIE *Entity, DIType Ty) {
1735 AddBasicType(Entity, DW_Unit, "", DW_ATE_signed, sizeof(int32_t));
1739 // Check for pre-existence.
1740 DIEntry *&Slot = DW_Unit->getDIEntrySlotFor(Ty.getGV());
1741 // If it exists then use the existing value.
1743 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1748 Slot = NewDIEntry();
1751 DIE Buffer(DW_TAG_base_type);
1752 if (DIBasicType *BT = dyn_cast<DIBasicType>(&Ty))
1753 ConstructTypeDIE(DW_Unit, Buffer, BT);
1754 else if (DIDerivedType *DT = dyn_cast<DIDerivedType>(&Ty))
1755 ConstructTypeDIE(DW_Unit, Buffer, DT);
1756 else if (DICompositeType *CT = dyn_cast<DICompositeType>(&Ty))
1757 ConstructTypeDIE(DW_Unit, Buffer, CT);
1759 // Add debug information entry to entity and unit.
1760 DIE *Die = DW_Unit->AddDie(Buffer);
1761 SetDIEntry(Slot, Die);
1762 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1765 /// ConstructTypeDIE - Construct basic type die from DIBasicType.
1766 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1769 // Get core information.
1770 const std::string &Name = BTy->getName();
1771 Buffer.setTag(DW_TAG_base_type);
1772 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, BTy->getEncoding());
1773 // Add name if not anonymous or intermediate type.
1775 AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1776 uint64_t Size = BTy->getSizeInBits() >> 3;
1777 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1780 /// ConstructTypeDIE - Construct derived type die from DIDerivedType.
1781 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1782 DIDerivedType *DTy) {
1784 // Get core information.
1785 const std::string &Name = DTy->getName();
1786 uint64_t Size = DTy->getSizeInBits() >> 3;
1787 unsigned Tag = DTy->getTag();
1788 // FIXME - Workaround for templates.
1789 if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
1792 // Map to main type, void will not have a type.
1793 DIType FromTy = DTy->getTypeDerivedFrom();
1794 AddType(DW_Unit, &Buffer, FromTy);
1796 // Add name if not anonymous or intermediate type.
1797 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1799 // Add size if non-zero (derived types might be zero-sized.)
1801 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1803 // Add source line info if available and TyDesc is not a forward
1805 // FIXME - Enable this. if (!DTy->isForwardDecl())
1806 // FIXME - Enable this. AddSourceLine(&Buffer, *DTy);
1809 /// ConstructTypeDIE - Construct type DIE from DICompositeType.
1810 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1811 DICompositeType *CTy) {
1813 // Get core information.
1814 const std::string &Name = CTy->getName();
1815 uint64_t Size = CTy->getSizeInBits() >> 3;
1816 unsigned Tag = CTy->getTag();
1818 case DW_TAG_vector_type:
1819 case DW_TAG_array_type:
1820 ConstructArrayTypeDIE(DW_Unit, Buffer, CTy);
1822 //FIXME - Enable this.
1823 // case DW_TAG_enumeration_type:
1824 // DIArray Elements = CTy->getTypeArray();
1825 // // Add enumerators to enumeration type.
1826 // for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i)
1827 // ConstructEnumTypeDIE(Buffer, &Elements.getElement(i));
1829 case DW_TAG_subroutine_type:
1831 // Add prototype flag.
1832 AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
1833 DIArray Elements = CTy->getTypeArray();
1835 DIDescriptor RTy = Elements.getElement(0);
1836 if (DIBasicType *BT = dyn_cast<DIBasicType>(&RTy))
1837 AddType(DW_Unit, &Buffer, *BT);
1838 else if (DIDerivedType *DT = dyn_cast<DIDerivedType>(&RTy))
1839 AddType(DW_Unit, &Buffer, *DT);
1840 else if (DICompositeType *CT = dyn_cast<DICompositeType>(&RTy))
1841 AddType(DW_Unit, &Buffer, *CT);
1843 //AddType(DW_Unit, &Buffer, Elements.getElement(0));
1845 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1846 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1847 DIDescriptor Ty = Elements.getElement(i);
1848 if (DIBasicType *BT = dyn_cast<DIBasicType>(&Ty))
1849 AddType(DW_Unit, &Buffer, *BT);
1850 else if (DIDerivedType *DT = dyn_cast<DIDerivedType>(&Ty))
1851 AddType(DW_Unit, &Buffer, *DT);
1852 else if (DICompositeType *CT = dyn_cast<DICompositeType>(&Ty))
1853 AddType(DW_Unit, &Buffer, *CT);
1854 Buffer.AddChild(Arg);
1858 case DW_TAG_structure_type:
1859 case DW_TAG_union_type:
1861 // Add elements to structure type.
1862 DIArray Elements = CTy->getTypeArray();
1863 // Add elements to structure type.
1864 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1865 DIDescriptor Element = Elements.getElement(i);
1866 if (DISubprogram *SP = dyn_cast<DISubprogram>(&Element))
1867 ConstructFieldTypeDIE(DW_Unit, Buffer, SP);
1868 else if (DIDerivedType *DT = dyn_cast<DIDerivedType>(&Element))
1869 ConstructFieldTypeDIE(DW_Unit, Buffer, DT);
1870 else if (DIGlobalVariable *GV = dyn_cast<DIGlobalVariable>(&Element))
1871 ConstructFieldTypeDIE(DW_Unit, Buffer, GV);
1879 // Add name if not anonymous or intermediate type.
1880 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1882 // Add size if non-zero (derived types might be zero-sized.)
1884 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1886 // Add zero size even if it is not a forward declaration.
1887 // FIXME - Enable this.
1888 // if (!CTy->isDefinition())
1889 // AddUInt(&Buffer, DW_AT_declaration, DW_FORM_flag, 1);
1891 // AddUInt(&Buffer, DW_AT_byte_size, 0, 0);
1894 // Add source line info if available and TyDesc is not a forward
1896 // FIXME - Enable this.
1897 // if (CTy->isForwardDecl())
1898 // AddSourceLine(&Buffer, *CTy);
1901 // ConstructSubrangeDIE - Construct subrange DIE from DISubrange.
1902 void ConstructSubrangeDIE (DIE &Buffer, DISubrange *SR, DIE *IndexTy) {
1903 int64_t L = SR->getLo();
1904 int64_t H = SR->getHi();
1905 DIE *DW_Subrange = new DIE(DW_TAG_subrange_type);
1907 AddDIEntry(DW_Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1909 AddSInt(DW_Subrange, DW_AT_lower_bound, 0, L);
1910 AddSInt(DW_Subrange, DW_AT_upper_bound, 0, H);
1912 Buffer.AddChild(DW_Subrange);
1915 /// ConstructArrayTypeDIE - Construct array type DIE from DICompositeType.
1916 void ConstructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1917 DICompositeType *CTy) {
1918 Buffer.setTag(DW_TAG_array_type);
1919 if (CTy->getTag() == DW_TAG_vector_type)
1920 AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1922 DIArray Elements = CTy->getTypeArray();
1923 // FIXME - Enable this.
1924 AddType(DW_Unit, &Buffer, CTy->getTypeDerivedFrom());
1926 // Construct an anonymous type for index type.
1927 DIE IdxBuffer(DW_TAG_base_type);
1928 AddUInt(&IdxBuffer, DW_AT_byte_size, 0, sizeof(int32_t));
1929 AddUInt(&IdxBuffer, DW_AT_encoding, DW_FORM_data1, DW_ATE_signed);
1930 DIE *IndexTy = DW_Unit->AddDie(IdxBuffer);
1932 // Add subranges to array type.
1933 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1934 DIDescriptor Element = Elements.getElement(i);
1935 if (DISubrange *SR = dyn_cast<DISubrange>(&Element))
1936 ConstructSubrangeDIE(Buffer, SR, IndexTy);
1940 /// ConstructEnumTypeDIE - Construct enum type DIE from
1942 void ConstructEnumTypeDIE(CompileUnit *DW_Unit,
1943 DIE &Buffer, DIEnumerator *ETy) {
1945 DIE *Enumerator = new DIE(DW_TAG_enumerator);
1946 AddString(Enumerator, DW_AT_name, DW_FORM_string, ETy->getName());
1947 int64_t Value = ETy->getEnumValue();
1948 AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
1949 Buffer.AddChild(Enumerator);
1952 /// ConstructFieldTypeDIE - Construct variable DIE for a struct field.
1953 void ConstructFieldTypeDIE(CompileUnit *DW_Unit,
1954 DIE &Buffer, DIGlobalVariable *V) {
1956 DIE *VariableDie = new DIE(DW_TAG_variable);
1957 const std::string &LinkageName = V->getLinkageName();
1958 if (!LinkageName.empty())
1959 AddString(VariableDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
1961 // FIXME - Enable this. AddSourceLine(VariableDie, V);
1962 AddType(DW_Unit, VariableDie, V->getType());
1963 if (!V->isLocalToUnit())
1964 AddUInt(VariableDie, DW_AT_external, DW_FORM_flag, 1);
1965 AddUInt(VariableDie, DW_AT_declaration, DW_FORM_flag, 1);
1966 Buffer.AddChild(VariableDie);
1969 /// ConstructFieldTypeDIE - Construct subprogram DIE for a struct field.
1970 void ConstructFieldTypeDIE(CompileUnit *DW_Unit,
1971 DIE &Buffer, DISubprogram *SP,
1972 bool IsConstructor = false) {
1973 DIE *Method = new DIE(DW_TAG_subprogram);
1974 AddString(Method, DW_AT_name, DW_FORM_string, SP->getName());
1975 const std::string &LinkageName = SP->getLinkageName();
1976 if (!LinkageName.empty())
1977 AddString(Method, DW_AT_MIPS_linkage_name, DW_FORM_string, LinkageName);
1978 // FIXME - Enable this. AddSourceLine(Method, SP);
1980 DICompositeType MTy = SP->getType();
1981 DIArray Args = MTy.getTypeArray();
1984 if (!IsConstructor) {
1985 DIDescriptor Ty = Args.getElement(0);
1986 if (DIBasicType *BT = dyn_cast<DIBasicType>(&Ty))
1987 AddType(DW_Unit, Method, *BT);
1988 else if (DIDerivedType *DT = dyn_cast<DIDerivedType>(&Ty))
1989 AddType(DW_Unit, Method, *DT);
1990 else if (DICompositeType *CT = dyn_cast<DICompositeType>(&Ty))
1991 AddType(DW_Unit, Method, *CT);
1995 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1996 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1997 DIDescriptor Ty = Args.getElement(i);
1998 if (DIBasicType *BT = dyn_cast<DIBasicType>(&Ty))
1999 AddType(DW_Unit, Method, *BT);
2000 else if (DIDerivedType *DT = dyn_cast<DIDerivedType>(&Ty))
2001 AddType(DW_Unit, Method, *DT);
2002 else if (DICompositeType *CT = dyn_cast<DICompositeType>(&Ty))
2003 AddType(DW_Unit, Method, *CT);
2004 AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1); // ???
2005 Method->AddChild(Arg);
2008 if (!SP->isLocalToUnit())
2009 AddUInt(Method, DW_AT_external, DW_FORM_flag, 1);
2010 Buffer.AddChild(Method);
2013 /// COnstructFieldTypeDIE - Construct derived type DIE for a struct field.
2014 void ConstructFieldTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
2015 DIDerivedType *DTy) {
2016 unsigned Tag = DTy->getTag();
2017 DIE *MemberDie = new DIE(Tag);
2018 if (!DTy->getName().empty())
2019 AddString(MemberDie, DW_AT_name, DW_FORM_string, DTy->getName());
2020 // FIXME - Enable this. AddSourceLine(MemberDie, DTy);
2022 DIType FromTy = DTy->getTypeDerivedFrom();
2023 AddType(DW_Unit, MemberDie, FromTy);
2025 uint64_t Size = DTy->getSizeInBits();
2026 uint64_t Offset = DTy->getOffsetInBits();
2028 // FIXME Handle bitfields
2031 AddUInt(MemberDie, DW_AT_bit_size, 0, Size);
2032 // Add computation for offset.
2033 DIEBlock *Block = new DIEBlock();
2034 AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
2035 AddUInt(Block, 0, DW_FORM_udata, Offset >> 3);
2036 AddBlock(MemberDie, DW_AT_data_member_location, 0, Block);
2038 // FIXME Handle DW_AT_accessibility.
2040 Buffer.AddChild(MemberDie);
2043 /// ConstructType - Adds all the required attributes to the type.
2045 void ConstructType(DIE &Buffer, TypeDesc *TyDesc, CompileUnit *Unit) {
2046 // Get core information.
2047 const std::string &Name = TyDesc->getName();
2048 uint64_t Size = TyDesc->getSize() >> 3;
2050 if (BasicTypeDesc *BasicTy = dyn_cast<BasicTypeDesc>(TyDesc)) {
2051 // Fundamental types like int, float, bool
2052 Buffer.setTag(DW_TAG_base_type);
2053 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, BasicTy->getEncoding());
2054 } else if (DerivedTypeDesc *DerivedTy = dyn_cast<DerivedTypeDesc>(TyDesc)) {
2056 unsigned Tag = DerivedTy->getTag();
2057 // FIXME - Workaround for templates.
2058 if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
2059 // Pointers, typedefs et al.
2061 // Map to main type, void will not have a type.
2062 if (TypeDesc *FromTy = DerivedTy->getFromType())
2063 AddType(&Buffer, FromTy, Unit);
2064 } else if (CompositeTypeDesc *CompTy = dyn_cast<CompositeTypeDesc>(TyDesc)){
2066 unsigned Tag = CompTy->getTag();
2068 // Set tag accordingly.
2069 if (Tag == DW_TAG_vector_type)
2070 Buffer.setTag(DW_TAG_array_type);
2074 std::vector<DebugInfoDesc *> &Elements = CompTy->getElements();
2077 case DW_TAG_vector_type:
2078 AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
2080 case DW_TAG_array_type: {
2081 // Add element type.
2082 if (TypeDesc *FromTy = CompTy->getFromType())
2083 AddType(&Buffer, FromTy, Unit);
2085 // Don't emit size attribute.
2088 // Construct an anonymous type for index type.
2089 DIE Buffer(DW_TAG_base_type);
2090 AddUInt(&Buffer, DW_AT_byte_size, 0, sizeof(int32_t));
2091 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, DW_ATE_signed);
2092 DIE *IndexTy = Unit->AddDie(Buffer);
2094 // Add subranges to array type.
2095 for (unsigned i = 0, N = Elements.size(); i < N; ++i) {
2096 SubrangeDesc *SRD = cast<SubrangeDesc>(Elements[i]);
2097 int64_t Lo = SRD->getLo();
2098 int64_t Hi = SRD->getHi();
2099 DIE *Subrange = new DIE(DW_TAG_subrange_type);
2101 // If a range is available.
2103 AddDIEntry(Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
2104 // Only add low if non-zero.
2105 if (Lo) AddSInt(Subrange, DW_AT_lower_bound, 0, Lo);
2106 AddSInt(Subrange, DW_AT_upper_bound, 0, Hi);
2109 Buffer.AddChild(Subrange);
2113 case DW_TAG_structure_type:
2114 case DW_TAG_union_type: {
2115 // Add elements to structure type.
2116 for (unsigned i = 0, N = Elements.size(); i < N; ++i) {
2117 DebugInfoDesc *Element = Elements[i];
2119 if (DerivedTypeDesc *MemberDesc = dyn_cast<DerivedTypeDesc>(Element)){
2120 // Add field or base class.
2121 unsigned Tag = MemberDesc->getTag();
2123 // Extract the basic information.
2124 const std::string &Name = MemberDesc->getName();
2125 uint64_t Size = MemberDesc->getSize();
2126 uint64_t Align = MemberDesc->getAlign();
2127 uint64_t Offset = MemberDesc->getOffset();
2129 // Construct member debug information entry.
2130 DIE *Member = new DIE(Tag);
2132 // Add name if not "".
2134 AddString(Member, DW_AT_name, DW_FORM_string, Name);
2136 // Add location if available.
2137 AddSourceLine(Member, MemberDesc->getFile(), MemberDesc->getLine());
2139 // Most of the time the field info is the same as the members.
2140 uint64_t FieldSize = Size;
2141 uint64_t FieldAlign = Align;
2142 uint64_t FieldOffset = Offset;
2144 // Set the member type.
2145 TypeDesc *FromTy = MemberDesc->getFromType();
2146 AddType(Member, FromTy, Unit);
2148 // Walk up typedefs until a real size is found.
2150 if (FromTy->getTag() != DW_TAG_typedef) {
2151 FieldSize = FromTy->getSize();
2152 FieldAlign = FromTy->getAlign();
2156 FromTy = cast<DerivedTypeDesc>(FromTy)->getFromType();
2159 // Unless we have a bit field.
2160 if (Tag == DW_TAG_member && FieldSize != Size) {
2161 // Construct the alignment mask.
2162 uint64_t AlignMask = ~(FieldAlign - 1);
2163 // Determine the high bit + 1 of the declared size.
2164 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
2165 // Work backwards to determine the base offset of the field.
2166 FieldOffset = HiMark - FieldSize;
2167 // Now normalize offset to the field.
2168 Offset -= FieldOffset;
2170 // Maybe we need to work from the other end.
2171 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
2173 // Add size and offset.
2174 AddUInt(Member, DW_AT_byte_size, 0, FieldSize >> 3);
2175 AddUInt(Member, DW_AT_bit_size, 0, Size);
2176 AddUInt(Member, DW_AT_bit_offset, 0, Offset);
2179 // Add computation for offset.
2180 DIEBlock *Block = new DIEBlock();
2181 AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
2182 AddUInt(Block, 0, DW_FORM_udata, FieldOffset >> 3);
2183 AddBlock(Member, DW_AT_data_member_location, 0, Block);
2185 // Add accessibility (public default unless is base class.
2186 if (MemberDesc->isProtected()) {
2187 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_protected);
2188 } else if (MemberDesc->isPrivate()) {
2189 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_private);
2190 } else if (Tag == DW_TAG_inheritance) {
2191 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_public);
2194 Buffer.AddChild(Member);
2195 } else if (GlobalVariableDesc *StaticDesc =
2196 dyn_cast<GlobalVariableDesc>(Element)) {
2197 // Add static member.
2199 // Construct member debug information entry.
2200 DIE *Static = new DIE(DW_TAG_variable);
2202 // Add name and mangled name.
2203 const std::string &Name = StaticDesc->getName();
2204 const std::string &LinkageName = StaticDesc->getLinkageName();
2205 AddString(Static, DW_AT_name, DW_FORM_string, Name);
2206 if (!LinkageName.empty()) {
2207 AddString(Static, DW_AT_MIPS_linkage_name, DW_FORM_string,
2212 AddSourceLine(Static, StaticDesc->getFile(), StaticDesc->getLine());
2215 if (TypeDesc *StaticTy = StaticDesc->getType())
2216 AddType(Static, StaticTy, Unit);
2219 if (!StaticDesc->isStatic())
2220 AddUInt(Static, DW_AT_external, DW_FORM_flag, 1);
2221 AddUInt(Static, DW_AT_declaration, DW_FORM_flag, 1);
2223 Buffer.AddChild(Static);
2224 } else if (SubprogramDesc *MethodDesc =
2225 dyn_cast<SubprogramDesc>(Element)) {
2226 // Add member function.
2228 // Construct member debug information entry.
2229 DIE *Method = new DIE(DW_TAG_subprogram);
2231 // Add name and mangled name.
2232 const std::string &Name = MethodDesc->getName();
2233 const std::string &LinkageName = MethodDesc->getLinkageName();
2235 AddString(Method, DW_AT_name, DW_FORM_string, Name);
2236 bool IsCTor = TyDesc->getName() == Name;
2238 if (!LinkageName.empty()) {
2239 AddString(Method, DW_AT_MIPS_linkage_name, DW_FORM_string,
2244 AddSourceLine(Method, MethodDesc->getFile(), MethodDesc->getLine());
2247 if (CompositeTypeDesc *MethodTy =
2248 dyn_cast_or_null<CompositeTypeDesc>(MethodDesc->getType())) {
2249 // Get argument information.
2250 std::vector<DebugInfoDesc *> &Args = MethodTy->getElements();
2255 AddType(Method, dyn_cast<TypeDesc>(Args[0]), Unit);
2259 for (unsigned i = 1, N = Args.size(); i < N; ++i) {
2260 DIE *Arg = new DIE(DW_TAG_formal_parameter);
2261 AddType(Arg, cast<TypeDesc>(Args[i]), Unit);
2262 AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1);
2263 Method->AddChild(Arg);
2268 if (!MethodDesc->isStatic())
2269 AddUInt(Method, DW_AT_external, DW_FORM_flag, 1);
2270 AddUInt(Method, DW_AT_declaration, DW_FORM_flag, 1);
2272 Buffer.AddChild(Method);
2277 case DW_TAG_enumeration_type: {
2278 // Add enumerators to enumeration type.
2279 for (unsigned i = 0, N = Elements.size(); i < N; ++i) {
2280 EnumeratorDesc *ED = cast<EnumeratorDesc>(Elements[i]);
2281 const std::string &Name = ED->getName();
2282 int64_t Value = ED->getValue();
2283 DIE *Enumerator = new DIE(DW_TAG_enumerator);
2284 AddString(Enumerator, DW_AT_name, DW_FORM_string, Name);
2285 AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
2286 Buffer.AddChild(Enumerator);
2291 case DW_TAG_subroutine_type: {
2292 // Add prototype flag.
2293 AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
2295 AddType(&Buffer, dyn_cast<TypeDesc>(Elements[0]), Unit);
2298 for (unsigned i = 1, N = Elements.size(); i < N; ++i) {
2299 DIE *Arg = new DIE(DW_TAG_formal_parameter);
2300 AddType(Arg, cast<TypeDesc>(Elements[i]), Unit);
2301 Buffer.AddChild(Arg);
2310 // Add name if not anonymous or intermediate type.
2311 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
2313 // Add size if non-zero (derived types might be zero-sized.)
2315 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
2316 else if (isa<CompositeTypeDesc>(TyDesc)) {
2317 // If TyDesc is a composite type, then add size even if it's zero unless
2318 // it's a forward declaration.
2319 if (TyDesc->isForwardDecl())
2320 AddUInt(&Buffer, DW_AT_declaration, DW_FORM_flag, 1);
2322 AddUInt(&Buffer, DW_AT_byte_size, 0, 0);
2325 // Add source line info if available and TyDesc is not a forward
2327 if (!TyDesc->isForwardDecl())
2328 AddSourceLine(&Buffer, TyDesc->getFile(), TyDesc->getLine());
2331 /// NewCompileUnit - Create new compile unit and it's debug information entry.
2333 CompileUnit *NewCompileUnit(CompileUnitDesc *UnitDesc, unsigned ID) {
2334 // Construct debug information entry.
2335 DIE *Die = new DIE(DW_TAG_compile_unit);
2336 AddSectionOffset(Die, DW_AT_stmt_list, DW_FORM_data4,
2337 DWLabel("section_line", 0), DWLabel("section_line", 0), false);
2338 AddString(Die, DW_AT_producer, DW_FORM_string, UnitDesc->getProducer());
2339 AddUInt (Die, DW_AT_language, DW_FORM_data1, UnitDesc->getLanguage());
2340 AddString(Die, DW_AT_name, DW_FORM_string, UnitDesc->getFileName());
2341 if (!UnitDesc->getDirectory().empty())
2342 AddString(Die, DW_AT_comp_dir, DW_FORM_string, UnitDesc->getDirectory());
2344 // Construct compile unit.
2345 CompileUnit *Unit = new CompileUnit(UnitDesc, ID, Die);
2347 // Add Unit to compile unit map.
2348 DescToUnitMap[UnitDesc] = Unit;
2353 /// GetBaseCompileUnit - Get the main compile unit.
2355 CompileUnit *GetBaseCompileUnit() const {
2356 CompileUnit *Unit = CompileUnits[0];
2357 assert(Unit && "Missing compile unit.");
2361 /// FindCompileUnit - Get the compile unit for the given descriptor.
2363 CompileUnit *FindCompileUnit(CompileUnitDesc *UnitDesc) {
2364 CompileUnit *Unit = DescToUnitMap[UnitDesc];
2365 assert(Unit && "Missing compile unit.");
2369 /// FindCompileUnit - Get the compile unit for the given descriptor.
2371 CompileUnit *FindCompileUnit(DICompileUnit Unit) {
2372 CompileUnit *DW_Unit = DW_CUs[Unit.getGV()];
2373 assert(DW_Unit && "Missing compile unit.");
2377 /// NewGlobalVariable - Add a new global variable DIE.
2379 DIE *NewGlobalVariable(GlobalVariableDesc *GVD) {
2380 // Get the compile unit context.
2381 CompileUnitDesc *UnitDesc =
2382 static_cast<CompileUnitDesc *>(GVD->getContext());
2383 CompileUnit *Unit = GetBaseCompileUnit();
2385 // Check for pre-existence.
2386 DIE *&Slot = Unit->getDieMapSlotFor(GVD);
2387 if (Slot) return Slot;
2389 // Get the global variable itself.
2390 GlobalVariable *GV = GVD->getGlobalVariable();
2392 const std::string &Name = GVD->getName();
2393 const std::string &FullName = GVD->getFullName();
2394 const std::string &LinkageName = GVD->getLinkageName();
2395 // Create the global's variable DIE.
2396 DIE *VariableDie = new DIE(DW_TAG_variable);
2397 AddString(VariableDie, DW_AT_name, DW_FORM_string, Name);
2398 if (!LinkageName.empty()) {
2399 AddString(VariableDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
2402 AddType(VariableDie, GVD->getType(), Unit);
2403 if (!GVD->isStatic())
2404 AddUInt(VariableDie, DW_AT_external, DW_FORM_flag, 1);
2406 // Add source line info if available.
2407 AddSourceLine(VariableDie, UnitDesc, GVD->getLine());
2410 DIEBlock *Block = new DIEBlock();
2411 AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
2412 AddObjectLabel(Block, 0, DW_FORM_udata, Asm->getGlobalLinkName(GV));
2413 AddBlock(VariableDie, DW_AT_location, 0, Block);
2418 // Add to context owner.
2419 Unit->getDie()->AddChild(VariableDie);
2421 // Expose as global.
2422 // FIXME - need to check external flag.
2423 Unit->AddGlobal(FullName, VariableDie);
2428 /// NewSubprogram - Add a new subprogram DIE.
2430 DIE *NewSubprogram(SubprogramDesc *SPD) {
2431 // Get the compile unit context.
2432 CompileUnitDesc *UnitDesc =
2433 static_cast<CompileUnitDesc *>(SPD->getContext());
2434 CompileUnit *Unit = GetBaseCompileUnit();
2436 // Check for pre-existence.
2437 DIE *&Slot = Unit->getDieMapSlotFor(SPD);
2438 if (Slot) return Slot;
2440 // Gather the details (simplify add attribute code.)
2441 const std::string &Name = SPD->getName();
2442 const std::string &FullName = SPD->getFullName();
2443 const std::string &LinkageName = SPD->getLinkageName();
2445 DIE *SubprogramDie = new DIE(DW_TAG_subprogram);
2446 AddString(SubprogramDie, DW_AT_name, DW_FORM_string, Name);
2447 if (!LinkageName.empty()) {
2448 AddString(SubprogramDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
2451 if (SPD->getType()) AddType(SubprogramDie, SPD->getType(), Unit);
2452 if (!SPD->isStatic())
2453 AddUInt(SubprogramDie, DW_AT_external, DW_FORM_flag, 1);
2454 AddUInt(SubprogramDie, DW_AT_prototyped, DW_FORM_flag, 1);
2456 // Add source line info if available.
2457 AddSourceLine(SubprogramDie, UnitDesc, SPD->getLine());
2460 Slot = SubprogramDie;
2462 // Add to context owner.
2463 Unit->getDie()->AddChild(SubprogramDie);
2465 // Expose as global.
2466 Unit->AddGlobal(FullName, SubprogramDie);
2468 return SubprogramDie;
2471 /// NewScopeVariable - Create a new scope variable.
2473 DIE *NewScopeVariable(DebugVariable *DV, CompileUnit *Unit) {
2474 // Get the descriptor.
2475 VariableDesc *VD = DV->getDesc();
2477 // Translate tag to proper Dwarf tag. The result variable is dropped for
2480 switch (VD->getTag()) {
2481 case DW_TAG_return_variable: return NULL;
2482 case DW_TAG_arg_variable: Tag = DW_TAG_formal_parameter; break;
2483 case DW_TAG_auto_variable: // fall thru
2484 default: Tag = DW_TAG_variable; break;
2487 // Define variable debug information entry.
2488 DIE *VariableDie = new DIE(Tag);
2489 AddString(VariableDie, DW_AT_name, DW_FORM_string, VD->getName());
2491 // Add source line info if available.
2492 AddSourceLine(VariableDie, VD->getFile(), VD->getLine());
2494 // Add variable type.
2495 AddType(VariableDie, VD->getType(), Unit);
2497 // Add variable address.
2498 MachineLocation Location;
2499 Location.set(RI->getFrameRegister(*MF),
2500 RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
2501 AddAddress(VariableDie, DW_AT_location, Location);
2506 /// NewScopeVariable - Create a new scope variable.
2508 DIE *NewDbgScopeVariable(DbgVariable *DV, CompileUnit *Unit) {
2509 // Get the descriptor.
2510 DIVariable *VD = DV->getVariable();
2512 // Translate tag to proper Dwarf tag. The result variable is dropped for
2515 switch (VD->getTag()) {
2516 case DW_TAG_return_variable: return NULL;
2517 case DW_TAG_arg_variable: Tag = DW_TAG_formal_parameter; break;
2518 case DW_TAG_auto_variable: // fall thru
2519 default: Tag = DW_TAG_variable; break;
2522 // Define variable debug information entry.
2523 DIE *VariableDie = new DIE(Tag);
2524 AddString(VariableDie, DW_AT_name, DW_FORM_string, VD->getName());
2526 // Add source line info if available.
2527 AddSourceLine(VariableDie, VD);
2529 // Add variable type.
2530 AddType(Unit, VariableDie, VD->getType());
2532 // Add variable address.
2533 MachineLocation Location;
2534 Location.set(RI->getFrameRegister(*MF),
2535 RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
2536 AddAddress(VariableDie, DW_AT_location, Location);
2541 /// getOrCreateScope - Returns the scope associated with the given descriptor.
2543 DbgScope *getOrCreateScope(GlobalVariable *V) {
2544 DbgScope *&Slot = DbgScopeMap[V];
2546 // FIXME - breaks down when the context is an inlined function.
2547 DIDescriptor ParentDesc;
2548 DIDescriptor *DB = new DIDescriptor(V);
2549 if (DIBlock *Block = dyn_cast<DIBlock>(DB)) {
2550 ParentDesc = Block->getContext();
2552 DbgScope *Parent = ParentDesc.isNull() ?
2553 NULL : getOrCreateScope(ParentDesc.getGV());
2554 Slot = new DbgScope(Parent, DB);
2556 Parent->AddScope(Slot);
2557 } else if (RootDbgScope) {
2558 // FIXME - Add inlined function scopes to the root so we can delete
2559 // them later. Long term, handle inlined functions properly.
2560 RootDbgScope->AddScope(Slot);
2562 // First function is top level function.
2563 RootDbgScope = Slot;
2569 /// ConstructDbgScope - Construct the components of a scope.
2571 void ConstructDbgScope(DbgScope *ParentScope,
2572 unsigned ParentStartID, unsigned ParentEndID,
2573 DIE *ParentDie, CompileUnit *Unit) {
2574 // Add variables to scope.
2575 SmallVector<DbgVariable *, 8> &Variables = ParentScope->getVariables();
2576 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2577 DIE *VariableDie = NewDbgScopeVariable(Variables[i], Unit);
2578 if (VariableDie) ParentDie->AddChild(VariableDie);
2581 // Add nested scopes.
2582 SmallVector<DbgScope *, 4> &Scopes = ParentScope->getScopes();
2583 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
2584 // Define the Scope debug information entry.
2585 DbgScope *Scope = Scopes[j];
2586 // FIXME - Ignore inlined functions for the time being.
2587 if (!Scope->getParent()) continue;
2589 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
2590 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
2592 // Ignore empty scopes.
2593 if (StartID == EndID && StartID != 0) continue;
2594 if (Scope->getScopes().empty() && Scope->getVariables().empty()) continue;
2596 if (StartID == ParentStartID && EndID == ParentEndID) {
2597 // Just add stuff to the parent scope.
2598 ConstructDbgScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
2600 DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
2602 // Add the scope bounds.
2604 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2605 DWLabel("label", StartID));
2607 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2608 DWLabel("func_begin", SubprogramCount));
2611 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2612 DWLabel("label", EndID));
2614 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2615 DWLabel("func_end", SubprogramCount));
2618 // Add the scope contents.
2619 ConstructDbgScope(Scope, StartID, EndID, ScopeDie, Unit);
2620 ParentDie->AddChild(ScopeDie);
2625 /// ConstructRootDbgScope - Construct the scope for the subprogram.
2627 void ConstructRootDbgScope(DbgScope *RootScope) {
2628 // Exit if there is no root scope.
2629 if (!RootScope) return;
2630 if (!RootScope->getDesc()->isNull()) return;
2632 // Get the subprogram debug information entry.
2633 DISubprogram SPD(RootScope->getDesc()->getGV());
2635 // Get the compile unit context.
2636 CompileUnit *Unit = FindCompileUnit(SPD.getCompileUnit());
2638 // Get the subprogram die.
2639 DIE *SPDie = Unit->getDieMapSlotFor(SPD.getGV());
2640 assert(SPDie && "Missing subprogram descriptor");
2642 // Add the function bounds.
2643 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2644 DWLabel("func_begin", SubprogramCount));
2645 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2646 DWLabel("func_end", SubprogramCount));
2647 MachineLocation Location(RI->getFrameRegister(*MF));
2648 AddAddress(SPDie, DW_AT_frame_base, Location);
2650 ConstructDbgScope(RootScope, 0, 0, SPDie, Unit);
2653 /// ConstructDefaultDbgScope - Construct a default scope for the subprogram.
2655 void ConstructDefaultDbgScope(MachineFunction *MF) {
2656 // Find the correct subprogram descriptor.
2657 std::string SPName = "llvm.dbg.subprograms";
2658 std::vector<GlobalVariable*> Result;
2659 getGlobalVariablesUsing(*M, SPName, Result);
2660 for (std::vector<GlobalVariable *>::iterator I = Result.begin(),
2661 E = Result.end(); I != E; ++I) {
2663 DISubprogram *SPD = new DISubprogram(*I);
2665 if (SPD->getName() == MF->getFunction()->getName()) {
2666 // Get the compile unit context.
2667 CompileUnit *Unit = FindCompileUnit(SPD->getCompileUnit());
2669 // Get the subprogram die.
2670 DIE *SPDie = Unit->getDieMapSlotFor(SPD->getGV());
2671 assert(SPDie && "Missing subprogram descriptor");
2673 // Add the function bounds.
2674 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2675 DWLabel("func_begin", SubprogramCount));
2676 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2677 DWLabel("func_end", SubprogramCount));
2679 MachineLocation Location(RI->getFrameRegister(*MF));
2680 AddAddress(SPDie, DW_AT_frame_base, Location);
2685 // FIXME: This is causing an abort because C++ mangled names are compared
2686 // with their unmangled counterparts. See PR2885. Don't do this assert.
2687 assert(0 && "Couldn't find DIE for machine function!");
2691 /// ConstructScope - Construct the components of a scope.
2693 void ConstructScope(DebugScope *ParentScope,
2694 unsigned ParentStartID, unsigned ParentEndID,
2695 DIE *ParentDie, CompileUnit *Unit) {
2696 // Add variables to scope.
2697 std::vector<DebugVariable *> &Variables = ParentScope->getVariables();
2698 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2699 DIE *VariableDie = NewScopeVariable(Variables[i], Unit);
2700 if (VariableDie) ParentDie->AddChild(VariableDie);
2703 // Add nested scopes.
2704 std::vector<DebugScope *> &Scopes = ParentScope->getScopes();
2705 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
2706 // Define the Scope debug information entry.
2707 DebugScope *Scope = Scopes[j];
2708 // FIXME - Ignore inlined functions for the time being.
2709 if (!Scope->getParent()) continue;
2711 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
2712 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
2714 // Ignore empty scopes.
2715 if (StartID == EndID && StartID != 0) continue;
2716 if (Scope->getScopes().empty() && Scope->getVariables().empty()) continue;
2718 if (StartID == ParentStartID && EndID == ParentEndID) {
2719 // Just add stuff to the parent scope.
2720 ConstructScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
2722 DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
2724 // Add the scope bounds.
2726 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2727 DWLabel("label", StartID));
2729 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2730 DWLabel("func_begin", SubprogramCount));
2733 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2734 DWLabel("label", EndID));
2736 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2737 DWLabel("func_end", SubprogramCount));
2740 // Add the scope contents.
2741 ConstructScope(Scope, StartID, EndID, ScopeDie, Unit);
2742 ParentDie->AddChild(ScopeDie);
2747 /// ConstructRootScope - Construct the scope for the subprogram.
2749 void ConstructRootScope(DebugScope *RootScope) {
2750 // Exit if there is no root scope.
2751 if (!RootScope) return;
2753 // Get the subprogram debug information entry.
2754 SubprogramDesc *SPD = cast<SubprogramDesc>(RootScope->getDesc());
2756 // Get the compile unit context.
2757 CompileUnit *Unit = GetBaseCompileUnit();
2759 // Get the subprogram die.
2760 DIE *SPDie = Unit->getDieMapSlotFor(SPD);
2761 assert(SPDie && "Missing subprogram descriptor");
2763 // Add the function bounds.
2764 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2765 DWLabel("func_begin", SubprogramCount));
2766 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2767 DWLabel("func_end", SubprogramCount));
2768 MachineLocation Location(RI->getFrameRegister(*MF));
2769 AddAddress(SPDie, DW_AT_frame_base, Location);
2771 ConstructScope(RootScope, 0, 0, SPDie, Unit);
2774 /// ConstructDefaultScope - Construct a default scope for the subprogram.
2776 void ConstructDefaultScope(MachineFunction *MF) {
2777 // Find the correct subprogram descriptor.
2778 std::vector<SubprogramDesc *> Subprograms;
2779 MMI->getAnchoredDescriptors<SubprogramDesc>(*M, Subprograms);
2781 for (unsigned i = 0, N = Subprograms.size(); i < N; ++i) {
2782 SubprogramDesc *SPD = Subprograms[i];
2784 if (SPD->getName() == MF->getFunction()->getName()) {
2785 // Get the compile unit context.
2786 CompileUnit *Unit = GetBaseCompileUnit();
2788 // Get the subprogram die.
2789 DIE *SPDie = Unit->getDieMapSlotFor(SPD);
2790 assert(SPDie && "Missing subprogram descriptor");
2792 // Add the function bounds.
2793 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2794 DWLabel("func_begin", SubprogramCount));
2795 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2796 DWLabel("func_end", SubprogramCount));
2798 MachineLocation Location(RI->getFrameRegister(*MF));
2799 AddAddress(SPDie, DW_AT_frame_base, Location);
2804 // FIXME: This is causing an abort because C++ mangled names are compared
2805 // with their unmangled counterparts. See PR2885. Don't do this assert.
2806 assert(0 && "Couldn't find DIE for machine function!");
2810 /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
2811 /// tools to recognize the object file contains Dwarf information.
2812 void EmitInitial() {
2813 // Check to see if we already emitted intial headers.
2814 if (didInitial) return;
2817 // Dwarf sections base addresses.
2818 if (TAI->doesDwarfRequireFrameSection()) {
2819 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2820 EmitLabel("section_debug_frame", 0);
2822 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2823 EmitLabel("section_info", 0);
2824 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2825 EmitLabel("section_abbrev", 0);
2826 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2827 EmitLabel("section_aranges", 0);
2828 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2829 EmitLabel("section_macinfo", 0);
2830 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2831 EmitLabel("section_line", 0);
2832 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2833 EmitLabel("section_loc", 0);
2834 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2835 EmitLabel("section_pubnames", 0);
2836 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2837 EmitLabel("section_str", 0);
2838 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2839 EmitLabel("section_ranges", 0);
2841 Asm->SwitchToSection(TAI->getTextSection());
2842 EmitLabel("text_begin", 0);
2843 Asm->SwitchToSection(TAI->getDataSection());
2844 EmitLabel("data_begin", 0);
2847 /// EmitDIE - Recusively Emits a debug information entry.
2849 void EmitDIE(DIE *Die) {
2850 // Get the abbreviation for this DIE.
2851 unsigned AbbrevNumber = Die->getAbbrevNumber();
2852 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2856 // Emit the code (index) for the abbreviation.
2857 Asm->EmitULEB128Bytes(AbbrevNumber);
2860 Asm->EOL(std::string("Abbrev [" +
2861 utostr(AbbrevNumber) +
2862 "] 0x" + utohexstr(Die->getOffset()) +
2863 ":0x" + utohexstr(Die->getSize()) + " " +
2864 TagString(Abbrev->getTag())));
2868 SmallVector<DIEValue*, 32> &Values = Die->getValues();
2869 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2871 // Emit the DIE attribute values.
2872 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2873 unsigned Attr = AbbrevData[i].getAttribute();
2874 unsigned Form = AbbrevData[i].getForm();
2875 assert(Form && "Too many attributes for DIE (check abbreviation)");
2878 case DW_AT_sibling: {
2879 Asm->EmitInt32(Die->SiblingOffset());
2883 // Emit an attribute using the defined form.
2884 Values[i]->EmitValue(*this, Form);
2889 Asm->EOL(AttributeString(Attr));
2892 // Emit the DIE children if any.
2893 if (Abbrev->getChildrenFlag() == DW_CHILDREN_yes) {
2894 const std::vector<DIE *> &Children = Die->getChildren();
2896 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2897 EmitDIE(Children[j]);
2900 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2904 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
2906 unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
2907 // Get the children.
2908 const std::vector<DIE *> &Children = Die->getChildren();
2910 // If not last sibling and has children then add sibling offset attribute.
2911 if (!Last && !Children.empty()) Die->AddSiblingOffset();
2913 // Record the abbreviation.
2914 AssignAbbrevNumber(Die->getAbbrev());
2916 // Get the abbreviation for this DIE.
2917 unsigned AbbrevNumber = Die->getAbbrevNumber();
2918 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2921 Die->setOffset(Offset);
2923 // Start the size with the size of abbreviation code.
2924 Offset += TargetAsmInfo::getULEB128Size(AbbrevNumber);
2926 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2927 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2929 // Size the DIE attribute values.
2930 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2931 // Size attribute value.
2932 Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
2935 // Size the DIE children if any.
2936 if (!Children.empty()) {
2937 assert(Abbrev->getChildrenFlag() == DW_CHILDREN_yes &&
2938 "Children flag not set");
2940 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2941 Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
2944 // End of children marker.
2945 Offset += sizeof(int8_t);
2948 Die->setSize(Offset - Die->getOffset());
2952 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
2954 void SizeAndOffsets() {
2955 // Process base compile unit.
2956 for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
2957 CE = DW_CUs.end(); CI != CE; ++CI) {
2958 CompileUnit *Unit = CI->second;
2959 // Compute size of compile unit header
2960 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2961 sizeof(int16_t) + // DWARF version number
2962 sizeof(int32_t) + // Offset Into Abbrev. Section
2963 sizeof(int8_t); // Pointer Size (in bytes)
2964 SizeAndOffsetDie(Unit->getDie(), Offset, true);
2968 /// EmitDebugInfo - Emit the debug info section.
2970 void EmitDebugInfo() {
2971 // Start debug info section.
2972 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2974 for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
2975 CE = DW_CUs.end(); CI != CE; ++CI) {
2976 CompileUnit *Unit = CI->second;
2977 DIE *Die = Unit->getDie();
2978 // Emit the compile units header.
2979 EmitLabel("info_begin", Unit->getID());
2980 // Emit size of content not including length itself
2981 unsigned ContentSize = Die->getSize() +
2982 sizeof(int16_t) + // DWARF version number
2983 sizeof(int32_t) + // Offset Into Abbrev. Section
2984 sizeof(int8_t) + // Pointer Size (in bytes)
2985 sizeof(int32_t); // FIXME - extra pad for gdb bug.
2987 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2988 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2989 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2990 Asm->EOL("Offset Into Abbrev. Section");
2991 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2994 // FIXME - extra padding for gdb bug.
2995 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2996 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2997 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2998 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2999 EmitLabel("info_end", Unit->getID());
3005 /// EmitAbbreviations - Emit the abbreviation section.
3007 void EmitAbbreviations() const {
3008 // Check to see if it is worth the effort.
3009 if (!Abbreviations.empty()) {
3010 // Start the debug abbrev section.
3011 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
3013 EmitLabel("abbrev_begin", 0);
3015 // For each abbrevation.
3016 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
3017 // Get abbreviation data
3018 const DIEAbbrev *Abbrev = Abbreviations[i];
3020 // Emit the abbrevations code (base 1 index.)
3021 Asm->EmitULEB128Bytes(Abbrev->getNumber());
3022 Asm->EOL("Abbreviation Code");
3024 // Emit the abbreviations data.
3025 Abbrev->Emit(*this);
3030 // Mark end of abbreviations.
3031 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
3033 EmitLabel("abbrev_end", 0);
3039 /// EmitEndOfLineMatrix - Emit the last address of the section and the end of
3040 /// the line matrix.
3042 void EmitEndOfLineMatrix(unsigned SectionEnd) {
3043 // Define last address of section.
3044 Asm->EmitInt8(0); Asm->EOL("Extended Op");
3045 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
3046 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
3047 EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
3049 // Mark end of matrix.
3050 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
3051 Asm->EmitULEB128Bytes(1); Asm->EOL();
3052 Asm->EmitInt8(1); Asm->EOL();
3055 /// EmitDebugLines - Emit source line information.
3057 void EmitDebugLines() {
3058 // If the target is using .loc/.file, the assembler will be emitting the
3059 // .debug_line table automatically.
3060 if (TAI->hasDotLocAndDotFile())
3063 // Minimum line delta, thus ranging from -10..(255-10).
3064 const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
3065 // Maximum line delta, thus ranging from -10..(255-10).
3066 const int MaxLineDelta = 255 + MinLineDelta;
3068 // Start the dwarf line section.
3069 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
3071 // Construct the section header.
3073 EmitDifference("line_end", 0, "line_begin", 0, true);
3074 Asm->EOL("Length of Source Line Info");
3075 EmitLabel("line_begin", 0);
3077 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
3079 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
3080 Asm->EOL("Prolog Length");
3081 EmitLabel("line_prolog_begin", 0);
3083 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
3085 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
3087 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
3089 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
3091 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
3093 // Line number standard opcode encodings argument count
3094 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
3095 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
3096 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
3097 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
3098 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
3099 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
3100 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
3101 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
3102 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
3104 // Emit directories.
3105 for (unsigned DirectoryID = 1, NDID = Directories.size();
3106 DirectoryID <= NDID; ++DirectoryID) {
3107 Asm->EmitString(Directories[DirectoryID]); Asm->EOL("Directory");
3109 Asm->EmitInt8(0); Asm->EOL("End of directories");
3112 for (unsigned SourceID = 1, NSID = SrcFiles.size();
3113 SourceID <= NSID; ++SourceID) {
3114 const SrcFileInfo &SourceFile = SrcFiles[SourceID];
3115 Asm->EmitString(SourceFile.getName());
3117 Asm->EmitULEB128Bytes(SourceFile.getDirectoryID());
3118 Asm->EOL("Directory #");
3119 Asm->EmitULEB128Bytes(0);
3120 Asm->EOL("Mod date");
3121 Asm->EmitULEB128Bytes(0);
3122 Asm->EOL("File size");
3124 Asm->EmitInt8(0); Asm->EOL("End of files");
3126 EmitLabel("line_prolog_end", 0);
3128 // A sequence for each text section.
3129 unsigned SecSrcLinesSize = SectionSourceLines.size();
3131 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
3132 // Isolate current sections line info.
3133 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
3136 const Section* S = SectionMap[j + 1];
3137 Asm->EOL(std::string("Section ") + S->getName());
3141 // Dwarf assumes we start with first line of first source file.
3142 unsigned Source = 1;
3145 // Construct rows of the address, source, line, column matrix.
3146 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
3147 const SrcLineInfo &LineInfo = LineInfos[i];
3148 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
3149 if (!LabelID) continue;
3151 unsigned SourceID = LineInfo.getSourceID();
3152 const SrcFileInfo &SourceFile = SrcFiles[SourceID];
3153 unsigned DirectoryID = SourceFile.getDirectoryID();
3155 Asm->EOL(Directories[DirectoryID]
3156 + SourceFile.getName()
3158 + utostr_32(LineInfo.getLine()));
3162 // Define the line address.
3163 Asm->EmitInt8(0); Asm->EOL("Extended Op");
3164 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
3165 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
3166 EmitReference("label", LabelID); Asm->EOL("Location label");
3168 // If change of source, then switch to the new source.
3169 if (Source != LineInfo.getSourceID()) {
3170 Source = LineInfo.getSourceID();
3171 Asm->EmitInt8(DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
3172 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
3175 // If change of line.
3176 if (Line != LineInfo.getLine()) {
3177 // Determine offset.
3178 int Offset = LineInfo.getLine() - Line;
3179 int Delta = Offset - MinLineDelta;
3182 Line = LineInfo.getLine();
3184 // If delta is small enough and in range...
3185 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
3186 // ... then use fast opcode.
3187 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
3189 // ... otherwise use long hand.
3190 Asm->EmitInt8(DW_LNS_advance_line); Asm->EOL("DW_LNS_advance_line");
3191 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
3192 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
3195 // Copy the previous row (different address or source)
3196 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
3200 EmitEndOfLineMatrix(j + 1);
3203 if (SecSrcLinesSize == 0)
3204 // Because we're emitting a debug_line section, we still need a line
3205 // table. The linker and friends expect it to exist. If there's nothing to
3206 // put into it, emit an empty table.
3207 EmitEndOfLineMatrix(1);
3209 EmitLabel("line_end", 0);
3214 /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
3216 void EmitCommonDebugFrame() {
3217 if (!TAI->doesDwarfRequireFrameSection())
3221 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3222 TargetFrameInfo::StackGrowsUp ?
3223 TD->getPointerSize() : -TD->getPointerSize();
3225 // Start the dwarf frame section.
3226 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
3228 EmitLabel("debug_frame_common", 0);
3229 EmitDifference("debug_frame_common_end", 0,
3230 "debug_frame_common_begin", 0, true);
3231 Asm->EOL("Length of Common Information Entry");
3233 EmitLabel("debug_frame_common_begin", 0);
3234 Asm->EmitInt32((int)DW_CIE_ID);
3235 Asm->EOL("CIE Identifier Tag");
3236 Asm->EmitInt8(DW_CIE_VERSION);
3237 Asm->EOL("CIE Version");
3238 Asm->EmitString("");
3239 Asm->EOL("CIE Augmentation");
3240 Asm->EmitULEB128Bytes(1);
3241 Asm->EOL("CIE Code Alignment Factor");
3242 Asm->EmitSLEB128Bytes(stackGrowth);
3243 Asm->EOL("CIE Data Alignment Factor");
3244 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
3245 Asm->EOL("CIE RA Column");
3247 std::vector<MachineMove> Moves;
3248 RI->getInitialFrameState(Moves);
3250 EmitFrameMoves(NULL, 0, Moves, false);
3252 Asm->EmitAlignment(2, 0, 0, false);
3253 EmitLabel("debug_frame_common_end", 0);
3258 /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
3260 void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
3261 if (!TAI->doesDwarfRequireFrameSection())
3264 // Start the dwarf frame section.
3265 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
3267 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
3268 "debug_frame_begin", DebugFrameInfo.Number, true);
3269 Asm->EOL("Length of Frame Information Entry");
3271 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
3273 EmitSectionOffset("debug_frame_common", "section_debug_frame",
3275 Asm->EOL("FDE CIE offset");
3277 EmitReference("func_begin", DebugFrameInfo.Number);
3278 Asm->EOL("FDE initial location");
3279 EmitDifference("func_end", DebugFrameInfo.Number,
3280 "func_begin", DebugFrameInfo.Number);
3281 Asm->EOL("FDE address range");
3283 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves, false);
3285 Asm->EmitAlignment(2, 0, 0, false);
3286 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
3291 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
3293 void EmitDebugPubNames() {
3294 // Start the dwarf pubnames section.
3295 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
3297 for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
3298 CE = DW_CUs.end(); CI != CE; ++CI) {
3299 CompileUnit *Unit = CI->second;
3301 EmitDifference("pubnames_end", Unit->getID(),
3302 "pubnames_begin", Unit->getID(), true);
3303 Asm->EOL("Length of Public Names Info");
3305 EmitLabel("pubnames_begin", Unit->getID());
3307 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF Version");
3309 EmitSectionOffset("info_begin", "section_info",
3310 Unit->getID(), 0, true, false);
3311 Asm->EOL("Offset of Compilation Unit Info");
3313 EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(),true);
3314 Asm->EOL("Compilation Unit Length");
3316 std::map<std::string, DIE *> &Globals = Unit->getGlobals();
3318 for (std::map<std::string, DIE *>::iterator GI = Globals.begin(),
3321 const std::string &Name = GI->first;
3322 DIE * Entity = GI->second;
3324 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
3325 Asm->EmitString(Name); Asm->EOL("External Name");
3328 Asm->EmitInt32(0); Asm->EOL("End Mark");
3329 EmitLabel("pubnames_end", Unit->getID());
3335 /// EmitDebugStr - Emit visible names into a debug str section.
3337 void EmitDebugStr() {
3338 // Check to see if it is worth the effort.
3339 if (!StringPool.empty()) {
3340 // Start the dwarf str section.
3341 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
3343 // For each of strings in the string pool.
3344 for (unsigned StringID = 1, N = StringPool.size();
3345 StringID <= N; ++StringID) {
3346 // Emit a label for reference from debug information entries.
3347 EmitLabel("string", StringID);
3348 // Emit the string itself.
3349 const std::string &String = StringPool[StringID];
3350 Asm->EmitString(String); Asm->EOL();
3357 /// EmitDebugLoc - Emit visible names into a debug loc section.
3359 void EmitDebugLoc() {
3360 // Start the dwarf loc section.
3361 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
3366 /// EmitDebugARanges - Emit visible names into a debug aranges section.
3368 void EmitDebugARanges() {
3369 // Start the dwarf aranges section.
3370 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
3374 CompileUnit *Unit = GetBaseCompileUnit();
3376 // Don't include size of length
3377 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
3379 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("Dwarf Version");
3381 EmitReference("info_begin", Unit->getID());
3382 Asm->EOL("Offset of Compilation Unit Info");
3384 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
3386 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
3388 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
3389 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
3392 EmitReference("text_begin", 0); Asm->EOL("Address");
3393 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
3395 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
3396 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
3402 /// EmitDebugRanges - Emit visible names into a debug ranges section.
3404 void EmitDebugRanges() {
3405 // Start the dwarf ranges section.
3406 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
3411 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
3413 void EmitDebugMacInfo() {
3414 // Start the dwarf macinfo section.
3415 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
3420 /// ConstructCompileUnits - Create a compile unit DIEs.
3421 void ConstructCompileUnits() {
3422 std::string CUName = "llvm.dbg.compile_units";
3423 std::vector<GlobalVariable*> Result;
3424 getGlobalVariablesUsing(*M, CUName, Result);
3425 for (std::vector<GlobalVariable *>::iterator RI = Result.begin(),
3426 RE = Result.end(); RI != RE; ++RI) {
3427 DICompileUnit *DIUnit = new DICompileUnit(*RI);
3428 unsigned ID = RecordSource(DIUnit->getDirectory(),
3429 DIUnit->getFilename());
3431 DIE *Die = new DIE(DW_TAG_compile_unit);
3432 AddSectionOffset(Die, DW_AT_stmt_list, DW_FORM_data4,
3433 DWLabel("section_line", 0), DWLabel("section_line", 0),
3435 AddString(Die, DW_AT_producer, DW_FORM_string, DIUnit->getProducer());
3436 AddUInt(Die, DW_AT_language, DW_FORM_data1, DIUnit->getLanguage());
3437 AddString(Die, DW_AT_name, DW_FORM_string, DIUnit->getFilename());
3438 if (!DIUnit->getDirectory().empty())
3439 AddString(Die, DW_AT_comp_dir, DW_FORM_string, DIUnit->getDirectory());
3441 CompileUnit *Unit = new CompileUnit(ID, Die);
3442 DW_CUs[DIUnit->getGV()] = Unit;
3446 /// ConstructCompileUnitDIEs - Create a compile unit DIE for each source and
3448 void ConstructCompileUnitDIEs() {
3449 const UniqueVector<CompileUnitDesc *> CUW = MMI->getCompileUnits();
3451 for (unsigned i = 1, N = CUW.size(); i <= N; ++i) {
3452 unsigned ID = MMI->RecordSource(CUW[i]);
3453 CompileUnit *Unit = NewCompileUnit(CUW[i], ID);
3454 CompileUnits.push_back(Unit);
3458 /// ConstructGlobalVariableDIEs - Create DIEs for each of the externally
3459 /// visible global variables.
3460 void ConstructGlobalVariableDIEs() {
3461 std::string GVName = "llvm.dbg.global_variables";
3462 std::vector<GlobalVariable*> Result;
3463 getGlobalVariablesUsing(*M, GVName, Result);
3464 for (std::vector<GlobalVariable *>::iterator GVI = Result.begin(),
3465 GVE = Result.end(); GVI != GVE; ++GVI) {
3466 DIGlobalVariable *DI_GV = new DIGlobalVariable(*GVI);
3467 CompileUnit *DW_Unit = FindCompileUnit(DI_GV->getCompileUnit());
3469 // Check for pre-existence.
3470 DIE *&Slot = DW_Unit->getDieMapSlotFor(DI_GV->getGV());
3473 DIE *VariableDie = new DIE(DW_TAG_variable);
3474 AddString(VariableDie, DW_AT_name, DW_FORM_string, DI_GV->getName());
3475 const std::string &LinkageName = DI_GV->getLinkageName();
3476 if (!LinkageName.empty())
3477 AddString(VariableDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
3479 AddType(DW_Unit, VariableDie, DI_GV->getType());
3481 if (!DI_GV->isLocalToUnit())
3482 AddUInt(VariableDie, DW_AT_external, DW_FORM_flag, 1);
3484 // Add source line info, if available.
3485 AddSourceLine(VariableDie, DI_GV);
3488 DIEBlock *Block = new DIEBlock();
3489 AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
3490 AddObjectLabel(Block, 0, DW_FORM_udata,
3491 Asm->getGlobalLinkName(DI_GV->getGV()));
3492 AddBlock(VariableDie, DW_AT_location, 0, Block);
3497 //Add to context owner.
3498 DW_Unit->getDie()->AddChild(VariableDie);
3500 //Expose as global. FIXME - need to check external flag.
3501 DW_Unit->AddGlobal(DI_GV->getName(), VariableDie);
3505 /// ConstructGlobalDIEs - Create DIEs for each of the externally visible
3506 /// global variables.
3507 void ConstructGlobalDIEs() {
3508 std::vector<GlobalVariableDesc *> GlobalVariables;
3509 MMI->getAnchoredDescriptors<GlobalVariableDesc>(*M, GlobalVariables);
3511 for (unsigned i = 0, N = GlobalVariables.size(); i < N; ++i) {
3512 GlobalVariableDesc *GVD = GlobalVariables[i];
3513 NewGlobalVariable(GVD);
3517 /// ConstructSubprograms - Create DIEs for each of the externally visible
3519 void ConstructSubprograms() {
3521 std::string SPName = "llvm.dbg.subprograms";
3522 std::vector<GlobalVariable*> Result;
3523 getGlobalVariablesUsing(*M, SPName, Result);
3524 for (std::vector<GlobalVariable *>::iterator RI = Result.begin(),
3525 RE = Result.end(); RI != RE; ++RI) {
3527 DISubprogram *SP = new DISubprogram(*RI);
3528 CompileUnit *Unit = FindCompileUnit(SP->getCompileUnit());
3530 // Check for pre-existence.
3531 DIE *&Slot = Unit->getDieMapSlotFor(SP->getGV());
3534 DIE *SubprogramDie = new DIE(DW_TAG_subprogram);
3535 AddString(SubprogramDie, DW_AT_name, DW_FORM_string, SP->getName());
3536 const std::string &LinkageName = SP->getLinkageName();
3537 if (!LinkageName.empty())
3538 AddString(SubprogramDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
3540 DIType SPTy = SP->getType();
3541 AddType(Unit, SubprogramDie, SPTy);
3542 if (!SP->isLocalToUnit())
3543 AddUInt(SubprogramDie, DW_AT_external, DW_FORM_flag, 1);
3544 AddUInt(SubprogramDie, DW_AT_prototyped, DW_FORM_flag, 1);
3546 AddSourceLine(SubprogramDie, SP);
3548 Slot = SubprogramDie;
3549 //Add to context owner.
3550 Unit->getDie()->AddChild(SubprogramDie);
3552 Unit->AddGlobal(SP->getName(), SubprogramDie);
3556 /// ConstructSubprogramDIEs - Create DIEs for each of the externally visible
3558 void ConstructSubprogramDIEs() {
3559 std::vector<SubprogramDesc *> Subprograms;
3560 MMI->getAnchoredDescriptors<SubprogramDesc>(*M, Subprograms);
3562 for (unsigned i = 0, N = Subprograms.size(); i < N; ++i) {
3563 SubprogramDesc *SPD = Subprograms[i];
3569 //===--------------------------------------------------------------------===//
3570 // Main entry points.
3572 DwarfDebug(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
3573 : Dwarf(OS, A, T, "dbg")
3575 , AbbreviationsSet(InitAbbreviationsSetSize)
3577 , ValuesSet(InitValuesSetSize)
3582 , SectionSourceLines()
3585 , RootDbgScope(NULL)
3588 virtual ~DwarfDebug() {
3589 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i)
3590 delete CompileUnits[i];
3591 for (unsigned j = 0, M = Values.size(); j < M; ++j)
3595 /// SetDebugInfo - Create global DIEs and emit initial debug info sections.
3596 /// This is inovked by the target AsmPrinter.
3597 void SetDebugInfo(MachineModuleInfo *mmi) {
3599 // Create all the compile unit DIEs.
3600 ConstructCompileUnits();
3608 // Create DIEs for each of the externally visible global variables.
3609 ConstructGlobalVariableDIEs();
3611 // Create DIEs for each of the externally visible subprograms.
3612 ConstructSubprograms();
3614 // Prime section data.
3615 SectionMap.insert(TAI->getTextSection());
3617 // Print out .file directives to specify files for .loc directives. These
3618 // are printed out early so that they precede any .loc directives.
3619 if (TAI->hasDotLocAndDotFile()) {
3620 for (unsigned i = 1, e = SrcFiles.size(); i <= e; ++i) {
3621 sys::Path FullPath(Directories[SrcFiles[i].getDirectoryID()]);
3622 bool AppendOk = FullPath.appendComponent(SrcFiles[i].getName());
3623 assert(AppendOk && "Could not append filename to directory!");
3625 Asm->EmitFile(i, FullPath.toString());
3630 // Emit initial sections
3634 /// SetModuleInfo - Set machine module information when it's known that pass
3635 /// manager has created it. Set by the target AsmPrinter.
3636 void SetModuleInfo(MachineModuleInfo *mmi) {
3637 assert (0 && "Who is this?");
3638 // Make sure initial declarations are made.
3639 if (!MMI && mmi->hasDebugInfo()) {
3643 // Create all the compile unit DIEs.
3644 ConstructCompileUnitDIEs();
3646 // Create DIEs for each of the externally visible global variables.
3647 ConstructGlobalDIEs();
3649 // Create DIEs for each of the externally visible subprograms.
3650 ConstructSubprogramDIEs();
3652 // Prime section data.
3653 SectionMap.insert(TAI->getTextSection());
3655 // Print out .file directives to specify files for .loc directives. These
3656 // are printed out early so that they precede any .loc directives.
3657 if (TAI->hasDotLocAndDotFile()) {
3658 const UniqueVector<SourceFileInfo> &SourceFiles = MMI->getSourceFiles();
3659 const UniqueVector<std::string> &Directories = MMI->getDirectories();
3660 for (unsigned i = 1, e = SourceFiles.size(); i <= e; ++i) {
3661 sys::Path FullPath(Directories[SourceFiles[i].getDirectoryID()]);
3662 bool AppendOk = FullPath.appendComponent(SourceFiles[i].getName());
3663 assert(AppendOk && "Could not append filename to directory!");
3665 Asm->EmitFile(i, FullPath.toString());
3670 // Emit initial sections
3675 /// BeginModule - Emit all Dwarf sections that should come prior to the
3677 void BeginModule(Module *M) {
3681 /// EndModule - Emit all Dwarf sections that should come after the content.
3684 if (!ShouldEmitDwarf()) return;
3686 // Standard sections final addresses.
3687 Asm->SwitchToSection(TAI->getTextSection());
3688 EmitLabel("text_end", 0);
3689 Asm->SwitchToSection(TAI->getDataSection());
3690 EmitLabel("data_end", 0);
3692 // End text sections.
3693 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
3694 Asm->SwitchToSection(SectionMap[i]);
3695 EmitLabel("section_end", i);
3698 // Emit common frame information.
3699 EmitCommonDebugFrame();
3701 // Emit function debug frame information
3702 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
3703 E = DebugFrames.end(); I != E; ++I)
3704 EmitFunctionDebugFrame(*I);
3706 // Compute DIE offsets and sizes.
3709 // Emit all the DIEs into a debug info section
3712 // Corresponding abbreviations into a abbrev section.
3713 EmitAbbreviations();
3715 // Emit source line correspondence into a debug line section.
3718 // Emit info into a debug pubnames section.
3719 EmitDebugPubNames();
3721 // Emit info into a debug str section.
3724 // Emit info into a debug loc section.
3727 // Emit info into a debug aranges section.
3730 // Emit info into a debug ranges section.
3733 // Emit info into a debug macinfo section.
3737 /// BeginFunction - Gather pre-function debug information. Assumes being
3738 /// emitted immediately after the function entry point.
3739 void BeginFunction(MachineFunction *MF) {
3742 if (!ShouldEmitDwarf()) return;
3744 // Begin accumulating function debug information.
3745 MMI->BeginFunction(MF);
3747 // Assumes in correct section after the entry point.
3748 EmitLabel("func_begin", ++SubprogramCount);
3750 // Emit label for the implicitly defined dbg.stoppoint at the start of
3752 if (!Lines.empty()) {
3753 const SrcLineInfo &LineInfo = Lines[0];
3754 Asm->printLabel(LineInfo.getLabelID());
3758 /// EndFunction - Gather and emit post-function debug information.
3760 void EndFunction(MachineFunction *MF) {
3761 if (!ShouldEmitDwarf()) return;
3763 // Define end label for subprogram.
3764 EmitLabel("func_end", SubprogramCount);
3766 // Get function line info.
3767 if (!Lines.empty()) {
3768 // Get section line info.
3769 unsigned ID = SectionMap.insert(Asm->CurrentSection_);
3770 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
3771 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
3772 // Append the function info to section info.
3773 SectionLineInfos.insert(SectionLineInfos.end(),
3774 Lines.begin(), Lines.end());
3777 // Construct scopes for subprogram.
3779 ConstructRootDbgScope(RootDbgScope);
3781 // FIXME: This is wrong. We are essentially getting past a problem with
3782 // debug information not being able to handle unreachable blocks that have
3783 // debug information in them. In particular, those unreachable blocks that
3784 // have "region end" info in them. That situation results in the "root
3785 // scope" not being created. If that's the case, then emit a "default"
3786 // scope, i.e., one that encompasses the whole function. This isn't
3787 // desirable. And a better way of handling this (and all of the debugging
3788 // information) needs to be explored.
3789 ConstructDefaultDbgScope(MF);
3791 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
3792 MMI->getFrameMoves()));
3796 delete RootDbgScope;
3797 DbgScopeMap.clear();
3798 RootDbgScope = NULL;
3805 /// RecordSourceLine - Records location information and associates it with a
3806 /// label. Returns a unique label ID used to generate a label and provide
3807 /// correspondence to the source line list.
3808 unsigned RecordSourceLine(Value *V, unsigned Line, unsigned Col) {
3809 CompileUnit *Unit = DW_CUs[V];
3810 assert (Unit && "Unable to find CompileUnit");
3811 unsigned ID = MMI->NextLabelID();
3812 Lines.push_back(SrcLineInfo(Line, Col, Unit->getID(), ID));
3816 /// RecordSourceLine - Records location information and associates it with a
3817 /// label. Returns a unique label ID used to generate a label and provide
3818 /// correspondence to the source line list.
3819 unsigned RecordSourceLine(unsigned Line, unsigned Col, unsigned Src) {
3820 unsigned ID = MMI->NextLabelID();
3821 Lines.push_back(SrcLineInfo(Line, Col, Src, ID));
3825 unsigned getRecordSourceLineCount() {
3826 return Lines.size();
3829 /// RecordSource - Register a source file with debug info. Returns an source
3831 unsigned RecordSource(const std::string &Directory,
3832 const std::string &File) {
3833 unsigned DID = Directories.insert(Directory);
3834 return SrcFiles.insert(SrcFileInfo(DID,File));
3837 /// RecordRegionStart - Indicate the start of a region.
3839 unsigned RecordRegionStart(GlobalVariable *V) {
3840 DbgScope *Scope = getOrCreateScope(V);
3841 unsigned ID = MMI->NextLabelID();
3842 if (!Scope->getStartLabelID()) Scope->setStartLabelID(ID);
3846 /// RecordRegionEnd - Indicate the end of a region.
3848 unsigned RecordRegionEnd(GlobalVariable *V) {
3849 DbgScope *Scope = getOrCreateScope(V);
3850 unsigned ID = MMI->NextLabelID();
3851 Scope->setEndLabelID(ID);
3855 /// RecordVariable - Indicate the declaration of a local variable.
3857 void RecordVariable(GlobalVariable *GV, unsigned FrameIndex) {
3858 DbgScope *Scope = getOrCreateScope(GV);
3859 DIVariable *VD = new DIVariable(GV);
3860 DbgVariable *DV = new DbgVariable(VD, FrameIndex);
3861 Scope->AddVariable(DV);
3865 //===----------------------------------------------------------------------===//
3866 /// DwarfException - Emits Dwarf exception handling directives.
3868 class DwarfException : public Dwarf {
3871 struct FunctionEHFrameInfo {
3874 unsigned PersonalityIndex;
3876 bool hasLandingPads;
3877 std::vector<MachineMove> Moves;
3878 const Function * function;
3880 FunctionEHFrameInfo(const std::string &FN, unsigned Num, unsigned P,
3882 const std::vector<MachineMove> &M,
3884 FnName(FN), Number(Num), PersonalityIndex(P),
3885 hasCalls(hC), hasLandingPads(hL), Moves(M), function (f) { }
3888 std::vector<FunctionEHFrameInfo> EHFrames;
3890 /// shouldEmitTable - Per-function flag to indicate if EH tables should
3892 bool shouldEmitTable;
3894 /// shouldEmitMoves - Per-function flag to indicate if frame moves info
3895 /// should be emitted.
3896 bool shouldEmitMoves;
3898 /// shouldEmitTableModule - Per-module flag to indicate if EH tables
3899 /// should be emitted.
3900 bool shouldEmitTableModule;
3902 /// shouldEmitFrameModule - Per-module flag to indicate if frame moves
3903 /// should be emitted.
3904 bool shouldEmitMovesModule;
3906 /// EmitCommonEHFrame - Emit the common eh unwind frame.
3908 void EmitCommonEHFrame(const Function *Personality, unsigned Index) {
3909 // Size and sign of stack growth.
3911 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3912 TargetFrameInfo::StackGrowsUp ?
3913 TD->getPointerSize() : -TD->getPointerSize();
3915 // Begin eh frame section.
3916 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3918 if (!TAI->doesRequireNonLocalEHFrameLabel())
3919 O << TAI->getEHGlobalPrefix();
3920 O << "EH_frame" << Index << ":\n";
3921 EmitLabel("section_eh_frame", Index);
3923 // Define base labels.
3924 EmitLabel("eh_frame_common", Index);
3926 // Define the eh frame length.
3927 EmitDifference("eh_frame_common_end", Index,
3928 "eh_frame_common_begin", Index, true);
3929 Asm->EOL("Length of Common Information Entry");
3932 EmitLabel("eh_frame_common_begin", Index);
3933 Asm->EmitInt32((int)0);
3934 Asm->EOL("CIE Identifier Tag");
3935 Asm->EmitInt8(DW_CIE_VERSION);
3936 Asm->EOL("CIE Version");
3938 // The personality presence indicates that language specific information
3939 // will show up in the eh frame.
3940 Asm->EmitString(Personality ? "zPLR" : "zR");
3941 Asm->EOL("CIE Augmentation");
3943 // Round out reader.
3944 Asm->EmitULEB128Bytes(1);
3945 Asm->EOL("CIE Code Alignment Factor");
3946 Asm->EmitSLEB128Bytes(stackGrowth);
3947 Asm->EOL("CIE Data Alignment Factor");
3948 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), true));
3949 Asm->EOL("CIE Return Address Column");
3951 // If there is a personality, we need to indicate the functions location.
3953 Asm->EmitULEB128Bytes(7);
3954 Asm->EOL("Augmentation Size");
3956 if (TAI->getNeedsIndirectEncoding()) {
3957 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4 | DW_EH_PE_indirect);
3958 Asm->EOL("Personality (pcrel sdata4 indirect)");
3960 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3961 Asm->EOL("Personality (pcrel sdata4)");
3964 PrintRelDirective(true);
3965 O << TAI->getPersonalityPrefix();
3966 Asm->EmitExternalGlobal((const GlobalVariable *)(Personality));
3967 O << TAI->getPersonalitySuffix();
3968 if (strcmp(TAI->getPersonalitySuffix(), "+4@GOTPCREL"))
3969 O << "-" << TAI->getPCSymbol();
3970 Asm->EOL("Personality");
3972 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3973 Asm->EOL("LSDA Encoding (pcrel sdata4)");
3975 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3976 Asm->EOL("FDE Encoding (pcrel sdata4)");
3978 Asm->EmitULEB128Bytes(1);
3979 Asm->EOL("Augmentation Size");
3981 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3982 Asm->EOL("FDE Encoding (pcrel sdata4)");
3985 // Indicate locations of general callee saved registers in frame.
3986 std::vector<MachineMove> Moves;
3987 RI->getInitialFrameState(Moves);
3988 EmitFrameMoves(NULL, 0, Moves, true);
3990 // On Darwin the linker honors the alignment of eh_frame, which means it
3991 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3992 // you get holes which confuse readers of eh_frame.
3993 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
3995 EmitLabel("eh_frame_common_end", Index);
4000 /// EmitEHFrame - Emit function exception frame information.
4002 void EmitEHFrame(const FunctionEHFrameInfo &EHFrameInfo) {
4003 Function::LinkageTypes linkage = EHFrameInfo.function->getLinkage();
4005 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
4007 // Externally visible entry into the functions eh frame info.
4008 // If the corresponding function is static, this should not be
4009 // externally visible.
4010 if (linkage != Function::InternalLinkage) {
4011 if (const char *GlobalEHDirective = TAI->getGlobalEHDirective())
4012 O << GlobalEHDirective << EHFrameInfo.FnName << "\n";
4015 // If corresponding function is weak definition, this should be too.
4016 if ((linkage == Function::WeakLinkage ||
4017 linkage == Function::LinkOnceLinkage) &&
4018 TAI->getWeakDefDirective())
4019 O << TAI->getWeakDefDirective() << EHFrameInfo.FnName << "\n";
4021 // If there are no calls then you can't unwind. This may mean we can
4022 // omit the EH Frame, but some environments do not handle weak absolute
4024 // If UnwindTablesMandatory is set we cannot do this optimization; the
4025 // unwind info is to be available for non-EH uses.
4026 if (!EHFrameInfo.hasCalls &&
4027 !UnwindTablesMandatory &&
4028 ((linkage != Function::WeakLinkage &&
4029 linkage != Function::LinkOnceLinkage) ||
4030 !TAI->getWeakDefDirective() ||
4031 TAI->getSupportsWeakOmittedEHFrame()))
4033 O << EHFrameInfo.FnName << " = 0\n";
4034 // This name has no connection to the function, so it might get
4035 // dead-stripped when the function is not, erroneously. Prohibit
4036 // dead-stripping unconditionally.
4037 if (const char *UsedDirective = TAI->getUsedDirective())
4038 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
4040 O << EHFrameInfo.FnName << ":\n";
4043 EmitDifference("eh_frame_end", EHFrameInfo.Number,
4044 "eh_frame_begin", EHFrameInfo.Number, true);
4045 Asm->EOL("Length of Frame Information Entry");
4047 EmitLabel("eh_frame_begin", EHFrameInfo.Number);
4049 if (TAI->doesRequireNonLocalEHFrameLabel()) {
4050 PrintRelDirective(true, true);
4051 PrintLabelName("eh_frame_begin", EHFrameInfo.Number);
4053 if (!TAI->isAbsoluteEHSectionOffsets())
4054 O << "-EH_frame" << EHFrameInfo.PersonalityIndex;
4056 EmitSectionOffset("eh_frame_begin", "eh_frame_common",
4057 EHFrameInfo.Number, EHFrameInfo.PersonalityIndex,
4061 Asm->EOL("FDE CIE offset");
4063 EmitReference("eh_func_begin", EHFrameInfo.Number, true, true);
4064 Asm->EOL("FDE initial location");
4065 EmitDifference("eh_func_end", EHFrameInfo.Number,
4066 "eh_func_begin", EHFrameInfo.Number, true);
4067 Asm->EOL("FDE address range");
4069 // If there is a personality and landing pads then point to the language
4070 // specific data area in the exception table.
4071 if (EHFrameInfo.PersonalityIndex) {
4072 Asm->EmitULEB128Bytes(4);
4073 Asm->EOL("Augmentation size");
4075 if (EHFrameInfo.hasLandingPads)
4076 EmitReference("exception", EHFrameInfo.Number, true, true);
4078 Asm->EmitInt32((int)0);
4079 Asm->EOL("Language Specific Data Area");
4081 Asm->EmitULEB128Bytes(0);
4082 Asm->EOL("Augmentation size");
4085 // Indicate locations of function specific callee saved registers in
4087 EmitFrameMoves("eh_func_begin", EHFrameInfo.Number, EHFrameInfo.Moves, true);
4089 // On Darwin the linker honors the alignment of eh_frame, which means it
4090 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
4091 // you get holes which confuse readers of eh_frame.
4092 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
4094 EmitLabel("eh_frame_end", EHFrameInfo.Number);
4096 // If the function is marked used, this table should be also. We cannot
4097 // make the mark unconditional in this case, since retaining the table
4098 // also retains the function in this case, and there is code around
4099 // that depends on unused functions (calling undefined externals) being
4100 // dead-stripped to link correctly. Yes, there really is.
4101 if (MMI->getUsedFunctions().count(EHFrameInfo.function))
4102 if (const char *UsedDirective = TAI->getUsedDirective())
4103 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
4107 /// EmitExceptionTable - Emit landing pads and actions.
4109 /// The general organization of the table is complex, but the basic concepts
4110 /// are easy. First there is a header which describes the location and
4111 /// organization of the three components that follow.
4112 /// 1. The landing pad site information describes the range of code covered
4113 /// by the try. In our case it's an accumulation of the ranges covered
4114 /// by the invokes in the try. There is also a reference to the landing
4115 /// pad that handles the exception once processed. Finally an index into
4116 /// the actions table.
4117 /// 2. The action table, in our case, is composed of pairs of type ids
4118 /// and next action offset. Starting with the action index from the
4119 /// landing pad site, each type Id is checked for a match to the current
4120 /// exception. If it matches then the exception and type id are passed
4121 /// on to the landing pad. Otherwise the next action is looked up. This
4122 /// chain is terminated with a next action of zero. If no type id is
4123 /// found the the frame is unwound and handling continues.
4124 /// 3. Type id table contains references to all the C++ typeinfo for all
4125 /// catches in the function. This tables is reversed indexed base 1.
4127 /// SharedTypeIds - How many leading type ids two landing pads have in common.
4128 static unsigned SharedTypeIds(const LandingPadInfo *L,
4129 const LandingPadInfo *R) {
4130 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
4131 unsigned LSize = LIds.size(), RSize = RIds.size();
4132 unsigned MinSize = LSize < RSize ? LSize : RSize;
4135 for (; Count != MinSize; ++Count)
4136 if (LIds[Count] != RIds[Count])
4142 /// PadLT - Order landing pads lexicographically by type id.
4143 static bool PadLT(const LandingPadInfo *L, const LandingPadInfo *R) {
4144 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
4145 unsigned LSize = LIds.size(), RSize = RIds.size();
4146 unsigned MinSize = LSize < RSize ? LSize : RSize;
4148 for (unsigned i = 0; i != MinSize; ++i)
4149 if (LIds[i] != RIds[i])
4150 return LIds[i] < RIds[i];
4152 return LSize < RSize;
4156 static inline unsigned getEmptyKey() { return -1U; }
4157 static inline unsigned getTombstoneKey() { return -2U; }
4158 static unsigned getHashValue(const unsigned &Key) { return Key; }
4159 static bool isEqual(unsigned LHS, unsigned RHS) { return LHS == RHS; }
4160 static bool isPod() { return true; }
4163 /// ActionEntry - Structure describing an entry in the actions table.
4164 struct ActionEntry {
4165 int ValueForTypeID; // The value to write - may not be equal to the type id.
4167 struct ActionEntry *Previous;
4170 /// PadRange - Structure holding a try-range and the associated landing pad.
4172 // The index of the landing pad.
4174 // The index of the begin and end labels in the landing pad's label lists.
4175 unsigned RangeIndex;
4178 typedef DenseMap<unsigned, PadRange, KeyInfo> RangeMapType;
4180 /// CallSiteEntry - Structure describing an entry in the call-site table.
4181 struct CallSiteEntry {
4182 // The 'try-range' is BeginLabel .. EndLabel.
4183 unsigned BeginLabel; // zero indicates the start of the function.
4184 unsigned EndLabel; // zero indicates the end of the function.
4185 // The landing pad starts at PadLabel.
4186 unsigned PadLabel; // zero indicates that there is no landing pad.
4190 void EmitExceptionTable() {
4191 const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
4192 const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
4193 const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
4194 if (PadInfos.empty()) return;
4196 // Sort the landing pads in order of their type ids. This is used to fold
4197 // duplicate actions.
4198 SmallVector<const LandingPadInfo *, 64> LandingPads;
4199 LandingPads.reserve(PadInfos.size());
4200 for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
4201 LandingPads.push_back(&PadInfos[i]);
4202 std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
4204 // Negative type ids index into FilterIds, positive type ids index into
4205 // TypeInfos. The value written for a positive type id is just the type
4206 // id itself. For a negative type id, however, the value written is the
4207 // (negative) byte offset of the corresponding FilterIds entry. The byte
4208 // offset is usually equal to the type id, because the FilterIds entries
4209 // are written using a variable width encoding which outputs one byte per
4210 // entry as long as the value written is not too large, but can differ.
4211 // This kind of complication does not occur for positive type ids because
4212 // type infos are output using a fixed width encoding.
4213 // FilterOffsets[i] holds the byte offset corresponding to FilterIds[i].
4214 SmallVector<int, 16> FilterOffsets;
4215 FilterOffsets.reserve(FilterIds.size());
4217 for(std::vector<unsigned>::const_iterator I = FilterIds.begin(),
4218 E = FilterIds.end(); I != E; ++I) {
4219 FilterOffsets.push_back(Offset);
4220 Offset -= TargetAsmInfo::getULEB128Size(*I);
4223 // Compute the actions table and gather the first action index for each
4224 // landing pad site.
4225 SmallVector<ActionEntry, 32> Actions;
4226 SmallVector<unsigned, 64> FirstActions;
4227 FirstActions.reserve(LandingPads.size());
4229 int FirstAction = 0;
4230 unsigned SizeActions = 0;
4231 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
4232 const LandingPadInfo *LP = LandingPads[i];
4233 const std::vector<int> &TypeIds = LP->TypeIds;
4234 const unsigned NumShared = i ? SharedTypeIds(LP, LandingPads[i-1]) : 0;
4235 unsigned SizeSiteActions = 0;
4237 if (NumShared < TypeIds.size()) {
4238 unsigned SizeAction = 0;
4239 ActionEntry *PrevAction = 0;
4242 const unsigned SizePrevIds = LandingPads[i-1]->TypeIds.size();
4243 assert(Actions.size());
4244 PrevAction = &Actions.back();
4245 SizeAction = TargetAsmInfo::getSLEB128Size(PrevAction->NextAction) +
4246 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
4247 for (unsigned j = NumShared; j != SizePrevIds; ++j) {
4249 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
4250 SizeAction += -PrevAction->NextAction;
4251 PrevAction = PrevAction->Previous;
4255 // Compute the actions.
4256 for (unsigned I = NumShared, M = TypeIds.size(); I != M; ++I) {
4257 int TypeID = TypeIds[I];
4258 assert(-1-TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
4259 int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
4260 unsigned SizeTypeID = TargetAsmInfo::getSLEB128Size(ValueForTypeID);
4262 int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
4263 SizeAction = SizeTypeID + TargetAsmInfo::getSLEB128Size(NextAction);
4264 SizeSiteActions += SizeAction;
4266 ActionEntry Action = {ValueForTypeID, NextAction, PrevAction};
4267 Actions.push_back(Action);
4269 PrevAction = &Actions.back();
4272 // Record the first action of the landing pad site.
4273 FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
4274 } // else identical - re-use previous FirstAction
4276 FirstActions.push_back(FirstAction);
4278 // Compute this sites contribution to size.
4279 SizeActions += SizeSiteActions;
4282 // Compute the call-site table. The entry for an invoke has a try-range
4283 // containing the call, a non-zero landing pad and an appropriate action.
4284 // The entry for an ordinary call has a try-range containing the call and
4285 // zero for the landing pad and the action. Calls marked 'nounwind' have
4286 // no entry and must not be contained in the try-range of any entry - they
4287 // form gaps in the table. Entries must be ordered by try-range address.
4288 SmallVector<CallSiteEntry, 64> CallSites;
4290 RangeMapType PadMap;
4291 // Invokes and nounwind calls have entries in PadMap (due to being bracketed
4292 // by try-range labels when lowered). Ordinary calls do not, so appropriate
4293 // try-ranges for them need be deduced.
4294 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
4295 const LandingPadInfo *LandingPad = LandingPads[i];
4296 for (unsigned j = 0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
4297 unsigned BeginLabel = LandingPad->BeginLabels[j];
4298 assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
4299 PadRange P = { i, j };
4300 PadMap[BeginLabel] = P;
4304 // The end label of the previous invoke or nounwind try-range.
4305 unsigned LastLabel = 0;
4307 // Whether there is a potentially throwing instruction (currently this means
4308 // an ordinary call) between the end of the previous try-range and now.
4309 bool SawPotentiallyThrowing = false;
4311 // Whether the last callsite entry was for an invoke.
4312 bool PreviousIsInvoke = false;
4314 // Visit all instructions in order of address.
4315 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
4317 for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
4319 if (!MI->isLabel()) {
4320 SawPotentiallyThrowing |= MI->getDesc().isCall();
4324 unsigned BeginLabel = MI->getOperand(0).getImm();
4325 assert(BeginLabel && "Invalid label!");
4327 // End of the previous try-range?
4328 if (BeginLabel == LastLabel)
4329 SawPotentiallyThrowing = false;
4331 // Beginning of a new try-range?
4332 RangeMapType::iterator L = PadMap.find(BeginLabel);
4333 if (L == PadMap.end())
4334 // Nope, it was just some random label.
4337 PadRange P = L->second;
4338 const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
4340 assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
4341 "Inconsistent landing pad map!");
4343 // If some instruction between the previous try-range and this one may
4344 // throw, create a call-site entry with no landing pad for the region
4345 // between the try-ranges.
4346 if (SawPotentiallyThrowing) {
4347 CallSiteEntry Site = {LastLabel, BeginLabel, 0, 0};
4348 CallSites.push_back(Site);
4349 PreviousIsInvoke = false;
4352 LastLabel = LandingPad->EndLabels[P.RangeIndex];
4353 assert(BeginLabel && LastLabel && "Invalid landing pad!");
4355 if (LandingPad->LandingPadLabel) {
4356 // This try-range is for an invoke.
4357 CallSiteEntry Site = {BeginLabel, LastLabel,
4358 LandingPad->LandingPadLabel, FirstActions[P.PadIndex]};
4360 // Try to merge with the previous call-site.
4361 if (PreviousIsInvoke) {
4362 CallSiteEntry &Prev = CallSites.back();
4363 if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
4364 // Extend the range of the previous entry.
4365 Prev.EndLabel = Site.EndLabel;
4370 // Otherwise, create a new call-site.
4371 CallSites.push_back(Site);
4372 PreviousIsInvoke = true;
4375 PreviousIsInvoke = false;
4379 // If some instruction between the previous try-range and the end of the
4380 // function may throw, create a call-site entry with no landing pad for the
4381 // region following the try-range.
4382 if (SawPotentiallyThrowing) {
4383 CallSiteEntry Site = {LastLabel, 0, 0, 0};
4384 CallSites.push_back(Site);
4390 const unsigned SiteStartSize = sizeof(int32_t); // DW_EH_PE_udata4
4391 const unsigned SiteLengthSize = sizeof(int32_t); // DW_EH_PE_udata4
4392 const unsigned LandingPadSize = sizeof(int32_t); // DW_EH_PE_udata4
4393 unsigned SizeSites = CallSites.size() * (SiteStartSize +
4396 for (unsigned i = 0, e = CallSites.size(); i < e; ++i)
4397 SizeSites += TargetAsmInfo::getULEB128Size(CallSites[i].Action);
4400 const unsigned TypeInfoSize = TD->getPointerSize(); // DW_EH_PE_absptr
4401 unsigned SizeTypes = TypeInfos.size() * TypeInfoSize;
4403 unsigned TypeOffset = sizeof(int8_t) + // Call site format
4404 TargetAsmInfo::getULEB128Size(SizeSites) + // Call-site table length
4405 SizeSites + SizeActions + SizeTypes;
4407 unsigned TotalSize = sizeof(int8_t) + // LPStart format
4408 sizeof(int8_t) + // TType format
4409 TargetAsmInfo::getULEB128Size(TypeOffset) + // TType base offset
4412 unsigned SizeAlign = (4 - TotalSize) & 3;
4414 // Begin the exception table.
4415 Asm->SwitchToDataSection(TAI->getDwarfExceptionSection());
4416 Asm->EmitAlignment(2, 0, 0, false);
4417 O << "GCC_except_table" << SubprogramCount << ":\n";
4418 for (unsigned i = 0; i != SizeAlign; ++i) {
4420 Asm->EOL("Padding");
4422 EmitLabel("exception", SubprogramCount);
4425 Asm->EmitInt8(DW_EH_PE_omit);
4426 Asm->EOL("LPStart format (DW_EH_PE_omit)");
4427 Asm->EmitInt8(DW_EH_PE_absptr);
4428 Asm->EOL("TType format (DW_EH_PE_absptr)");
4429 Asm->EmitULEB128Bytes(TypeOffset);
4430 Asm->EOL("TType base offset");
4431 Asm->EmitInt8(DW_EH_PE_udata4);
4432 Asm->EOL("Call site format (DW_EH_PE_udata4)");
4433 Asm->EmitULEB128Bytes(SizeSites);
4434 Asm->EOL("Call-site table length");
4436 // Emit the landing pad site information.
4437 for (unsigned i = 0; i < CallSites.size(); ++i) {
4438 CallSiteEntry &S = CallSites[i];
4439 const char *BeginTag;
4440 unsigned BeginNumber;
4442 if (!S.BeginLabel) {
4443 BeginTag = "eh_func_begin";
4444 BeginNumber = SubprogramCount;
4447 BeginNumber = S.BeginLabel;
4450 EmitSectionOffset(BeginTag, "eh_func_begin", BeginNumber, SubprogramCount,
4452 Asm->EOL("Region start");
4455 EmitDifference("eh_func_end", SubprogramCount, BeginTag, BeginNumber,
4458 EmitDifference("label", S.EndLabel, BeginTag, BeginNumber, true);
4460 Asm->EOL("Region length");
4465 EmitSectionOffset("label", "eh_func_begin", S.PadLabel, SubprogramCount,
4467 Asm->EOL("Landing pad");
4469 Asm->EmitULEB128Bytes(S.Action);
4473 // Emit the actions.
4474 for (unsigned I = 0, N = Actions.size(); I != N; ++I) {
4475 ActionEntry &Action = Actions[I];
4477 Asm->EmitSLEB128Bytes(Action.ValueForTypeID);
4478 Asm->EOL("TypeInfo index");
4479 Asm->EmitSLEB128Bytes(Action.NextAction);
4480 Asm->EOL("Next action");
4483 // Emit the type ids.
4484 for (unsigned M = TypeInfos.size(); M; --M) {
4485 GlobalVariable *GV = TypeInfos[M - 1];
4487 PrintRelDirective();
4490 O << Asm->getGlobalLinkName(GV);
4494 Asm->EOL("TypeInfo");
4497 // Emit the filter typeids.
4498 for (unsigned j = 0, M = FilterIds.size(); j < M; ++j) {
4499 unsigned TypeID = FilterIds[j];
4500 Asm->EmitULEB128Bytes(TypeID);
4501 Asm->EOL("Filter TypeInfo index");
4504 Asm->EmitAlignment(2, 0, 0, false);
4508 //===--------------------------------------------------------------------===//
4509 // Main entry points.
4511 DwarfException(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
4512 : Dwarf(OS, A, T, "eh")
4513 , shouldEmitTable(false)
4514 , shouldEmitMoves(false)
4515 , shouldEmitTableModule(false)
4516 , shouldEmitMovesModule(false)
4519 virtual ~DwarfException() {}
4521 /// SetModuleInfo - Set machine module information when it's known that pass
4522 /// manager has created it. Set by the target AsmPrinter.
4523 void SetModuleInfo(MachineModuleInfo *mmi) {
4527 /// BeginModule - Emit all exception information that should come prior to the
4529 void BeginModule(Module *M) {
4533 /// EndModule - Emit all exception information that should come after the
4536 if (shouldEmitMovesModule || shouldEmitTableModule) {
4537 const std::vector<Function *> Personalities = MMI->getPersonalities();
4538 for (unsigned i =0; i < Personalities.size(); ++i)
4539 EmitCommonEHFrame(Personalities[i], i);
4541 for (std::vector<FunctionEHFrameInfo>::iterator I = EHFrames.begin(),
4542 E = EHFrames.end(); I != E; ++I)
4547 /// BeginFunction - Gather pre-function exception information. Assumes being
4548 /// emitted immediately after the function entry point.
4549 void BeginFunction(MachineFunction *MF) {
4551 shouldEmitTable = shouldEmitMoves = false;
4552 if (MMI && TAI->doesSupportExceptionHandling()) {
4554 // Map all labels and get rid of any dead landing pads.
4555 MMI->TidyLandingPads();
4556 // If any landing pads survive, we need an EH table.
4557 if (MMI->getLandingPads().size())
4558 shouldEmitTable = true;
4560 // See if we need frame move info.
4561 if (!MF->getFunction()->doesNotThrow() || UnwindTablesMandatory)
4562 shouldEmitMoves = true;
4564 if (shouldEmitMoves || shouldEmitTable)
4565 // Assumes in correct section after the entry point.
4566 EmitLabel("eh_func_begin", ++SubprogramCount);
4568 shouldEmitTableModule |= shouldEmitTable;
4569 shouldEmitMovesModule |= shouldEmitMoves;
4572 /// EndFunction - Gather and emit post-function exception information.
4574 void EndFunction() {
4575 if (shouldEmitMoves || shouldEmitTable) {
4576 EmitLabel("eh_func_end", SubprogramCount);
4577 EmitExceptionTable();
4579 // Save EH frame information
4581 push_back(FunctionEHFrameInfo(getAsm()->getCurrentFunctionEHName(MF),
4583 MMI->getPersonalityIndex(),
4584 MF->getFrameInfo()->hasCalls(),
4585 !MMI->getLandingPads().empty(),
4586 MMI->getFrameMoves(),
4587 MF->getFunction()));
4592 } // End of namespace llvm
4594 //===----------------------------------------------------------------------===//
4596 /// Emit - Print the abbreviation using the specified Dwarf writer.
4598 void DIEAbbrev::Emit(const DwarfDebug &DD) const {
4599 // Emit its Dwarf tag type.
4600 DD.getAsm()->EmitULEB128Bytes(Tag);
4601 DD.getAsm()->EOL(TagString(Tag));
4603 // Emit whether it has children DIEs.
4604 DD.getAsm()->EmitULEB128Bytes(ChildrenFlag);
4605 DD.getAsm()->EOL(ChildrenString(ChildrenFlag));
4607 // For each attribute description.
4608 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4609 const DIEAbbrevData &AttrData = Data[i];
4611 // Emit attribute type.
4612 DD.getAsm()->EmitULEB128Bytes(AttrData.getAttribute());
4613 DD.getAsm()->EOL(AttributeString(AttrData.getAttribute()));
4616 DD.getAsm()->EmitULEB128Bytes(AttrData.getForm());
4617 DD.getAsm()->EOL(FormEncodingString(AttrData.getForm()));
4620 // Mark end of abbreviation.
4621 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(1)");
4622 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(2)");
4626 void DIEAbbrev::print(std::ostream &O) {
4627 O << "Abbreviation @"
4628 << std::hex << (intptr_t)this << std::dec
4632 << ChildrenString(ChildrenFlag)
4635 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4637 << AttributeString(Data[i].getAttribute())
4639 << FormEncodingString(Data[i].getForm())
4643 void DIEAbbrev::dump() { print(cerr); }
4646 //===----------------------------------------------------------------------===//
4649 void DIEValue::dump() {
4654 //===----------------------------------------------------------------------===//
4656 /// EmitValue - Emit integer of appropriate size.
4658 void DIEInteger::EmitValue(DwarfDebug &DD, unsigned Form) {
4660 case DW_FORM_flag: // Fall thru
4661 case DW_FORM_ref1: // Fall thru
4662 case DW_FORM_data1: DD.getAsm()->EmitInt8(Integer); break;
4663 case DW_FORM_ref2: // Fall thru
4664 case DW_FORM_data2: DD.getAsm()->EmitInt16(Integer); break;
4665 case DW_FORM_ref4: // Fall thru
4666 case DW_FORM_data4: DD.getAsm()->EmitInt32(Integer); break;
4667 case DW_FORM_ref8: // Fall thru
4668 case DW_FORM_data8: DD.getAsm()->EmitInt64(Integer); break;
4669 case DW_FORM_udata: DD.getAsm()->EmitULEB128Bytes(Integer); break;
4670 case DW_FORM_sdata: DD.getAsm()->EmitSLEB128Bytes(Integer); break;
4671 default: assert(0 && "DIE Value form not supported yet"); break;
4675 /// SizeOf - Determine size of integer value in bytes.
4677 unsigned DIEInteger::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4679 case DW_FORM_flag: // Fall thru
4680 case DW_FORM_ref1: // Fall thru
4681 case DW_FORM_data1: return sizeof(int8_t);
4682 case DW_FORM_ref2: // Fall thru
4683 case DW_FORM_data2: return sizeof(int16_t);
4684 case DW_FORM_ref4: // Fall thru
4685 case DW_FORM_data4: return sizeof(int32_t);
4686 case DW_FORM_ref8: // Fall thru
4687 case DW_FORM_data8: return sizeof(int64_t);
4688 case DW_FORM_udata: return TargetAsmInfo::getULEB128Size(Integer);
4689 case DW_FORM_sdata: return TargetAsmInfo::getSLEB128Size(Integer);
4690 default: assert(0 && "DIE Value form not supported yet"); break;
4695 //===----------------------------------------------------------------------===//
4697 /// EmitValue - Emit string value.
4699 void DIEString::EmitValue(DwarfDebug &DD, unsigned Form) {
4700 DD.getAsm()->EmitString(String);
4703 //===----------------------------------------------------------------------===//
4705 /// EmitValue - Emit label value.
4707 void DIEDwarfLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
4708 bool IsSmall = Form == DW_FORM_data4;
4709 DD.EmitReference(Label, false, IsSmall);
4712 /// SizeOf - Determine size of label value in bytes.
4714 unsigned DIEDwarfLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4715 if (Form == DW_FORM_data4) return 4;
4716 return DD.getTargetData()->getPointerSize();
4719 //===----------------------------------------------------------------------===//
4721 /// EmitValue - Emit label value.
4723 void DIEObjectLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
4724 bool IsSmall = Form == DW_FORM_data4;
4725 DD.EmitReference(Label, false, IsSmall);
4728 /// SizeOf - Determine size of label value in bytes.
4730 unsigned DIEObjectLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4731 if (Form == DW_FORM_data4) return 4;
4732 return DD.getTargetData()->getPointerSize();
4735 //===----------------------------------------------------------------------===//
4737 /// EmitValue - Emit delta value.
4739 void DIESectionOffset::EmitValue(DwarfDebug &DD, unsigned Form) {
4740 bool IsSmall = Form == DW_FORM_data4;
4741 DD.EmitSectionOffset(Label.Tag, Section.Tag,
4742 Label.Number, Section.Number, IsSmall, IsEH, UseSet);
4745 /// SizeOf - Determine size of delta value in bytes.
4747 unsigned DIESectionOffset::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4748 if (Form == DW_FORM_data4) return 4;
4749 return DD.getTargetData()->getPointerSize();
4752 //===----------------------------------------------------------------------===//
4754 /// EmitValue - Emit delta value.
4756 void DIEDelta::EmitValue(DwarfDebug &DD, unsigned Form) {
4757 bool IsSmall = Form == DW_FORM_data4;
4758 DD.EmitDifference(LabelHi, LabelLo, IsSmall);
4761 /// SizeOf - Determine size of delta value in bytes.
4763 unsigned DIEDelta::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4764 if (Form == DW_FORM_data4) return 4;
4765 return DD.getTargetData()->getPointerSize();
4768 //===----------------------------------------------------------------------===//
4770 /// EmitValue - Emit debug information entry offset.
4772 void DIEntry::EmitValue(DwarfDebug &DD, unsigned Form) {
4773 DD.getAsm()->EmitInt32(Entry->getOffset());
4776 //===----------------------------------------------------------------------===//
4778 /// ComputeSize - calculate the size of the block.
4780 unsigned DIEBlock::ComputeSize(DwarfDebug &DD) {
4782 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
4784 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4785 Size += Values[i]->SizeOf(DD, AbbrevData[i].getForm());
4791 /// EmitValue - Emit block data.
4793 void DIEBlock::EmitValue(DwarfDebug &DD, unsigned Form) {
4795 case DW_FORM_block1: DD.getAsm()->EmitInt8(Size); break;
4796 case DW_FORM_block2: DD.getAsm()->EmitInt16(Size); break;
4797 case DW_FORM_block4: DD.getAsm()->EmitInt32(Size); break;
4798 case DW_FORM_block: DD.getAsm()->EmitULEB128Bytes(Size); break;
4799 default: assert(0 && "Improper form for block"); break;
4802 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
4804 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4806 Values[i]->EmitValue(DD, AbbrevData[i].getForm());
4810 /// SizeOf - Determine size of block data in bytes.
4812 unsigned DIEBlock::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4814 case DW_FORM_block1: return Size + sizeof(int8_t);
4815 case DW_FORM_block2: return Size + sizeof(int16_t);
4816 case DW_FORM_block4: return Size + sizeof(int32_t);
4817 case DW_FORM_block: return Size + TargetAsmInfo::getULEB128Size(Size);
4818 default: assert(0 && "Improper form for block"); break;
4823 //===----------------------------------------------------------------------===//
4824 /// DIE Implementation
4827 for (unsigned i = 0, N = Children.size(); i < N; ++i)
4831 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
4833 void DIE::AddSiblingOffset() {
4834 DIEInteger *DI = new DIEInteger(0);
4835 Values.insert(Values.begin(), DI);
4836 Abbrev.AddFirstAttribute(DW_AT_sibling, DW_FORM_ref4);
4839 /// Profile - Used to gather unique data for the value folding set.
4841 void DIE::Profile(FoldingSetNodeID &ID) {
4844 for (unsigned i = 0, N = Children.size(); i < N; ++i)
4845 ID.AddPointer(Children[i]);
4847 for (unsigned j = 0, M = Values.size(); j < M; ++j)
4848 ID.AddPointer(Values[j]);
4852 void DIE::print(std::ostream &O, unsigned IncIndent) {
4853 static unsigned IndentCount = 0;
4854 IndentCount += IncIndent;
4855 const std::string Indent(IndentCount, ' ');
4856 bool isBlock = Abbrev.getTag() == 0;
4861 << "0x" << std::hex << (intptr_t)this << std::dec
4862 << ", Offset: " << Offset
4863 << ", Size: " << Size
4867 << TagString(Abbrev.getTag())
4869 << ChildrenString(Abbrev.getChildrenFlag());
4871 O << "Size: " << Size;
4875 const SmallVector<DIEAbbrevData, 8> &Data = Abbrev.getData();
4878 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4882 O << AttributeString(Data[i].getAttribute());
4884 O << "Blk[" << i << "]";
4887 << FormEncodingString(Data[i].getForm())
4889 Values[i]->print(O);
4894 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
4895 Children[j]->print(O, 4);
4898 if (!isBlock) O << "\n";
4899 IndentCount -= IncIndent;
4907 //===----------------------------------------------------------------------===//
4908 /// DwarfWriter Implementation
4911 DwarfWriter::DwarfWriter() : ImmutablePass(&ID), DD(NULL), DE(NULL) {
4914 DwarfWriter::~DwarfWriter() {
4919 /// BeginModule - Emit all Dwarf sections that should come prior to the
4921 void DwarfWriter::BeginModule(Module *M,
4922 MachineModuleInfo *MMI,
4923 raw_ostream &OS, AsmPrinter *A,
4924 const TargetAsmInfo *T) {
4925 DE = new DwarfException(OS, A, T);
4926 DD = new DwarfDebug(OS, A, T);
4929 DD->SetDebugInfo(MMI);
4930 DE->SetModuleInfo(MMI);
4933 /// EndModule - Emit all Dwarf sections that should come after the content.
4935 void DwarfWriter::EndModule() {
4940 /// BeginFunction - Gather pre-function debug information. Assumes being
4941 /// emitted immediately after the function entry point.
4942 void DwarfWriter::BeginFunction(MachineFunction *MF) {
4943 DE->BeginFunction(MF);
4944 DD->BeginFunction(MF);
4947 /// EndFunction - Gather and emit post-function debug information.
4949 void DwarfWriter::EndFunction(MachineFunction *MF) {
4950 DD->EndFunction(MF);
4953 if (MachineModuleInfo *MMI = DD->getMMI() ? DD->getMMI() : DE->getMMI())
4954 // Clear function debug information.
4958 /// RecordSourceLine - Records location information and associates it with a
4959 /// label. Returns a unique label ID used to generate a label and provide
4960 /// correspondence to the source line list.
4961 unsigned DwarfWriter::RecordSourceLine(unsigned Line, unsigned Col,
4963 return DD->RecordSourceLine(Line, Col, Src);
4966 /// RecordSource - Register a source file with debug info. Returns an source
4968 unsigned DwarfWriter::RecordSource(const std::string &Dir,
4969 const std::string &File) {
4970 return DD->RecordSource(Dir, File);
4973 /// RecordRegionStart - Indicate the start of a region.
4974 unsigned DwarfWriter::RecordRegionStart(GlobalVariable *V) {
4975 return DD->RecordRegionStart(V);
4978 /// RecordRegionEnd - Indicate the end of a region.
4979 unsigned DwarfWriter::RecordRegionEnd(GlobalVariable *V) {
4980 return DD->RecordRegionEnd(V);
4983 /// getRecordSourceLineCount - Count source lines.
4984 unsigned DwarfWriter::getRecordSourceLineCount() {
4985 return DD->getRecordSourceLineCount();