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/Constants.h"
23 #include "llvm/CodeGen/AsmPrinter.h"
24 #include "llvm/CodeGen/MachineModuleInfo.h"
25 #include "llvm/CodeGen/MachineFrameInfo.h"
26 #include "llvm/CodeGen/MachineLocation.h"
27 #include "llvm/Analysis/DebugInfo.h"
28 #include "llvm/Support/Debug.h"
29 #include "llvm/Support/Dwarf.h"
30 #include "llvm/Support/CommandLine.h"
31 #include "llvm/Support/DataTypes.h"
32 #include "llvm/Support/Mangler.h"
33 #include "llvm/Support/raw_ostream.h"
34 #include "llvm/System/Path.h"
35 #include "llvm/Target/TargetAsmInfo.h"
36 #include "llvm/Target/TargetRegisterInfo.h"
37 #include "llvm/Target/TargetData.h"
38 #include "llvm/Target/TargetFrameInfo.h"
39 #include "llvm/Target/TargetInstrInfo.h"
40 #include "llvm/Target/TargetMachine.h"
41 #include "llvm/Target/TargetOptions.h"
45 using namespace llvm::dwarf;
47 static RegisterPass<DwarfWriter>
48 X("dwarfwriter", "DWARF Information Writer");
49 char DwarfWriter::ID = 0;
53 //===----------------------------------------------------------------------===//
55 /// Configuration values for initial hash set sizes (log2).
57 static const unsigned InitDiesSetSize = 9; // log2(512)
58 static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
59 static const unsigned InitValuesSetSize = 9; // log2(512)
61 //===----------------------------------------------------------------------===//
62 /// Forward declarations.
67 //===----------------------------------------------------------------------===//
70 /// getGlobalVariablesUsing - Return all of the GlobalVariables which have the
71 /// specified value in their initializer somewhere.
73 getGlobalVariablesUsing(Value *V, std::vector<GlobalVariable*> &Result) {
74 // Scan though value users.
75 for (Value::use_iterator I = V->use_begin(), E = V->use_end(); I != E; ++I) {
76 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(*I)) {
77 // If the user is a GlobalVariable then add to result.
79 } else if (Constant *C = dyn_cast<Constant>(*I)) {
80 // If the user is a constant variable then scan its users.
81 getGlobalVariablesUsing(C, Result);
86 /// getGlobalVariablesUsing - Return all of the GlobalVariables that use the
87 /// named GlobalVariable.
89 getGlobalVariablesUsing(Module &M, const std::string &RootName,
90 std::vector<GlobalVariable*> &Result) {
91 std::vector<const Type*> FieldTypes;
92 FieldTypes.push_back(Type::Int32Ty);
93 FieldTypes.push_back(Type::Int32Ty);
95 // Get the GlobalVariable root.
96 GlobalVariable *UseRoot = M.getGlobalVariable(RootName,
97 StructType::get(FieldTypes));
99 // If present and linkonce then scan for users.
100 if (UseRoot && UseRoot->hasLinkOnceLinkage())
101 getGlobalVariablesUsing(UseRoot, Result);
104 /// getGlobalVariable - Return either a direct or cast Global value.
106 static GlobalVariable *getGlobalVariable(Value *V) {
107 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
109 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
110 if (CE->getOpcode() == Instruction::BitCast) {
111 return dyn_cast<GlobalVariable>(CE->getOperand(0));
112 } else if (CE->getOpcode() == Instruction::GetElementPtr) {
113 for (unsigned int i=1; i<CE->getNumOperands(); i++) {
114 if (!CE->getOperand(i)->isNullValue())
117 return dyn_cast<GlobalVariable>(CE->getOperand(0));
123 //===----------------------------------------------------------------------===//
124 /// DWLabel - Labels are used to track locations in the assembler file.
125 /// Labels appear in the form @verbatim <prefix><Tag><Number> @endverbatim,
126 /// where the tag is a category of label (Ex. location) and number is a value
127 /// unique in that category.
130 /// Tag - Label category tag. Should always be a staticly declared C string.
134 /// Number - Value to make label unique.
138 DWLabel(const char *T, unsigned N) : Tag(T), Number(N) {}
140 void Profile(FoldingSetNodeID &ID) const {
141 ID.AddString(std::string(Tag));
142 ID.AddInteger(Number);
146 void print(std::ostream *O) const {
149 void print(std::ostream &O) const {
151 if (Number) O << Number;
156 //===----------------------------------------------------------------------===//
157 /// DIEAbbrevData - Dwarf abbreviation data, describes the one attribute of a
158 /// Dwarf abbreviation.
159 class DIEAbbrevData {
161 /// Attribute - Dwarf attribute code.
165 /// Form - Dwarf form code.
170 DIEAbbrevData(unsigned A, unsigned F)
176 unsigned getAttribute() const { return Attribute; }
177 unsigned getForm() const { return Form; }
179 /// Profile - Used to gather unique data for the abbreviation folding set.
181 void Profile(FoldingSetNodeID &ID)const {
182 ID.AddInteger(Attribute);
187 //===----------------------------------------------------------------------===//
188 /// DIEAbbrev - Dwarf abbreviation, describes the organization of a debug
189 /// information object.
190 class DIEAbbrev : public FoldingSetNode {
192 /// Tag - Dwarf tag code.
196 /// Unique number for node.
200 /// ChildrenFlag - Dwarf children flag.
202 unsigned ChildrenFlag;
204 /// Data - Raw data bytes for abbreviation.
206 SmallVector<DIEAbbrevData, 8> Data;
210 DIEAbbrev(unsigned T, unsigned C)
218 unsigned getTag() const { return Tag; }
219 unsigned getNumber() const { return Number; }
220 unsigned getChildrenFlag() const { return ChildrenFlag; }
221 const SmallVector<DIEAbbrevData, 8> &getData() const { return Data; }
222 void setTag(unsigned T) { Tag = T; }
223 void setChildrenFlag(unsigned CF) { ChildrenFlag = CF; }
224 void setNumber(unsigned N) { Number = N; }
226 /// AddAttribute - Adds another set of attribute information to the
228 void AddAttribute(unsigned Attribute, unsigned Form) {
229 Data.push_back(DIEAbbrevData(Attribute, Form));
232 /// AddFirstAttribute - Adds a set of attribute information to the front
233 /// of the abbreviation.
234 void AddFirstAttribute(unsigned Attribute, unsigned Form) {
235 Data.insert(Data.begin(), DIEAbbrevData(Attribute, Form));
238 /// Profile - Used to gather unique data for the abbreviation folding set.
240 void Profile(FoldingSetNodeID &ID) {
242 ID.AddInteger(ChildrenFlag);
244 // For each attribute description.
245 for (unsigned i = 0, N = Data.size(); i < N; ++i)
249 /// Emit - Print the abbreviation using the specified Dwarf writer.
251 void Emit(const DwarfDebug &DD) const;
254 void print(std::ostream *O) {
257 void print(std::ostream &O);
262 //===----------------------------------------------------------------------===//
263 /// DIE - A structured debug information entry. Has an abbreviation which
264 /// describes it's organization.
265 class DIE : public FoldingSetNode {
267 /// Abbrev - Buffer for constructing abbreviation.
271 /// Offset - Offset in debug info section.
275 /// Size - Size of instance + children.
281 std::vector<DIE *> Children;
283 /// Attributes values.
285 SmallVector<DIEValue*, 32> Values;
288 explicit DIE(unsigned Tag)
289 : Abbrev(Tag, DW_CHILDREN_no)
298 DIEAbbrev &getAbbrev() { return Abbrev; }
299 unsigned getAbbrevNumber() const {
300 return Abbrev.getNumber();
302 unsigned getTag() const { return Abbrev.getTag(); }
303 unsigned getOffset() const { return Offset; }
304 unsigned getSize() const { return Size; }
305 const std::vector<DIE *> &getChildren() const { return Children; }
306 SmallVector<DIEValue*, 32> &getValues() { return Values; }
307 void setTag(unsigned Tag) { Abbrev.setTag(Tag); }
308 void setOffset(unsigned O) { Offset = O; }
309 void setSize(unsigned S) { Size = S; }
311 /// AddValue - Add a value and attributes to a DIE.
313 void AddValue(unsigned Attribute, unsigned Form, DIEValue *Value) {
314 Abbrev.AddAttribute(Attribute, Form);
315 Values.push_back(Value);
318 /// SiblingOffset - Return the offset of the debug information entry's
320 unsigned SiblingOffset() const { return Offset + Size; }
322 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
324 void AddSiblingOffset();
326 /// AddChild - Add a child to the DIE.
328 void AddChild(DIE *Child) {
329 Abbrev.setChildrenFlag(DW_CHILDREN_yes);
330 Children.push_back(Child);
333 /// Detach - Detaches objects connected to it after copying.
339 /// Profile - Used to gather unique data for the value folding set.
341 void Profile(FoldingSetNodeID &ID) ;
344 void print(std::ostream *O, unsigned IncIndent = 0) {
345 if (O) print(*O, IncIndent);
347 void print(std::ostream &O, unsigned IncIndent = 0);
352 //===----------------------------------------------------------------------===//
353 /// DIEValue - A debug information entry value.
355 class DIEValue : public FoldingSetNode {
368 /// Type - Type of data stored in the value.
372 explicit DIEValue(unsigned T)
375 virtual ~DIEValue() {}
378 unsigned getType() const { return Type; }
380 // Implement isa/cast/dyncast.
381 static bool classof(const DIEValue *) { return true; }
383 /// EmitValue - Emit value via the Dwarf writer.
385 virtual void EmitValue(DwarfDebug &DD, unsigned Form) = 0;
387 /// SizeOf - Return the size of a value in bytes.
389 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const = 0;
391 /// Profile - Used to gather unique data for the value folding set.
393 virtual void Profile(FoldingSetNodeID &ID) = 0;
396 void print(std::ostream *O) {
399 virtual void print(std::ostream &O) = 0;
404 //===----------------------------------------------------------------------===//
405 /// DWInteger - An integer value DIE.
407 class DIEInteger : public DIEValue {
412 explicit DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
414 // Implement isa/cast/dyncast.
415 static bool classof(const DIEInteger *) { return true; }
416 static bool classof(const DIEValue *I) { return I->Type == isInteger; }
418 /// BestForm - Choose the best form for integer.
420 static unsigned BestForm(bool IsSigned, uint64_t Integer) {
422 if ((char)Integer == (signed)Integer) return DW_FORM_data1;
423 if ((short)Integer == (signed)Integer) return DW_FORM_data2;
424 if ((int)Integer == (signed)Integer) return DW_FORM_data4;
426 if ((unsigned char)Integer == Integer) return DW_FORM_data1;
427 if ((unsigned short)Integer == Integer) return DW_FORM_data2;
428 if ((unsigned int)Integer == Integer) return DW_FORM_data4;
430 return DW_FORM_data8;
433 /// EmitValue - Emit integer of appropriate size.
435 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
437 /// SizeOf - Determine size of integer value in bytes.
439 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
441 /// Profile - Used to gather unique data for the value folding set.
443 static void Profile(FoldingSetNodeID &ID, unsigned Integer) {
444 ID.AddInteger(isInteger);
445 ID.AddInteger(Integer);
447 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Integer); }
450 virtual void print(std::ostream &O) {
451 O << "Int: " << (int64_t)Integer
452 << " 0x" << std::hex << Integer << std::dec;
457 //===----------------------------------------------------------------------===//
458 /// DIEString - A string value DIE.
460 class DIEString : public DIEValue {
462 const std::string String;
464 explicit DIEString(const std::string &S) : DIEValue(isString), String(S) {}
466 // Implement isa/cast/dyncast.
467 static bool classof(const DIEString *) { return true; }
468 static bool classof(const DIEValue *S) { return S->Type == isString; }
470 /// EmitValue - Emit string value.
472 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
474 /// SizeOf - Determine size of string value in bytes.
476 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
477 return String.size() + sizeof(char); // sizeof('\0');
480 /// Profile - Used to gather unique data for the value folding set.
482 static void Profile(FoldingSetNodeID &ID, const std::string &String) {
483 ID.AddInteger(isString);
484 ID.AddString(String);
486 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, String); }
489 virtual void print(std::ostream &O) {
490 O << "Str: \"" << String << "\"";
495 //===----------------------------------------------------------------------===//
496 /// DIEDwarfLabel - A Dwarf internal label expression DIE.
498 class DIEDwarfLabel : public DIEValue {
503 explicit DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {}
505 // Implement isa/cast/dyncast.
506 static bool classof(const DIEDwarfLabel *) { return true; }
507 static bool classof(const DIEValue *L) { return L->Type == isLabel; }
509 /// EmitValue - Emit label value.
511 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
513 /// SizeOf - Determine size of label value in bytes.
515 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
517 /// Profile - Used to gather unique data for the value folding set.
519 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label) {
520 ID.AddInteger(isLabel);
523 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
526 virtual void print(std::ostream &O) {
534 //===----------------------------------------------------------------------===//
535 /// DIEObjectLabel - A label to an object in code or data.
537 class DIEObjectLabel : public DIEValue {
539 const std::string Label;
541 explicit DIEObjectLabel(const std::string &L)
542 : DIEValue(isAsIsLabel), Label(L) {}
544 // Implement isa/cast/dyncast.
545 static bool classof(const DIEObjectLabel *) { return true; }
546 static bool classof(const DIEValue *L) { return L->Type == isAsIsLabel; }
548 /// EmitValue - Emit label value.
550 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
552 /// SizeOf - Determine size of label value in bytes.
554 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
556 /// Profile - Used to gather unique data for the value folding set.
558 static void Profile(FoldingSetNodeID &ID, const std::string &Label) {
559 ID.AddInteger(isAsIsLabel);
562 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
565 virtual void print(std::ostream &O) {
566 O << "Obj: " << Label;
571 //===----------------------------------------------------------------------===//
572 /// DIESectionOffset - A section offset DIE.
574 class DIESectionOffset : public DIEValue {
577 const DWLabel Section;
581 DIESectionOffset(const DWLabel &Lab, const DWLabel &Sec,
582 bool isEH = false, bool useSet = true)
583 : DIEValue(isSectionOffset), Label(Lab), Section(Sec),
584 IsEH(isEH), UseSet(useSet) {}
586 // Implement isa/cast/dyncast.
587 static bool classof(const DIESectionOffset *) { return true; }
588 static bool classof(const DIEValue *D) { return D->Type == isSectionOffset; }
590 /// EmitValue - Emit section offset.
592 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
594 /// SizeOf - Determine size of section offset value in bytes.
596 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
598 /// Profile - Used to gather unique data for the value folding set.
600 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label,
601 const DWLabel &Section) {
602 ID.AddInteger(isSectionOffset);
605 // IsEH and UseSet are specific to the Label/Section that we will emit
606 // the offset for; so Label/Section are enough for uniqueness.
608 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label, Section); }
611 virtual void print(std::ostream &O) {
616 O << "-" << IsEH << "-" << UseSet;
621 //===----------------------------------------------------------------------===//
622 /// DIEDelta - A simple label difference DIE.
624 class DIEDelta : public DIEValue {
626 const DWLabel LabelHi;
627 const DWLabel LabelLo;
629 DIEDelta(const DWLabel &Hi, const DWLabel &Lo)
630 : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
632 // Implement isa/cast/dyncast.
633 static bool classof(const DIEDelta *) { return true; }
634 static bool classof(const DIEValue *D) { return D->Type == isDelta; }
636 /// EmitValue - Emit delta value.
638 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
640 /// SizeOf - Determine size of delta value in bytes.
642 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
644 /// Profile - Used to gather unique data for the value folding set.
646 static void Profile(FoldingSetNodeID &ID, const DWLabel &LabelHi,
647 const DWLabel &LabelLo) {
648 ID.AddInteger(isDelta);
652 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, LabelHi, LabelLo); }
655 virtual void print(std::ostream &O) {
664 //===----------------------------------------------------------------------===//
665 /// DIEntry - A pointer to another debug information entry. An instance of this
666 /// class can also be used as a proxy for a debug information entry not yet
667 /// defined (ie. types.)
668 class DIEntry : public DIEValue {
672 explicit DIEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
674 // Implement isa/cast/dyncast.
675 static bool classof(const DIEntry *) { return true; }
676 static bool classof(const DIEValue *E) { return E->Type == isEntry; }
678 /// EmitValue - Emit debug information entry offset.
680 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
682 /// SizeOf - Determine size of debug information entry in bytes.
684 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
685 return sizeof(int32_t);
688 /// Profile - Used to gather unique data for the value folding set.
690 static void Profile(FoldingSetNodeID &ID, DIE *Entry) {
691 ID.AddInteger(isEntry);
692 ID.AddPointer(Entry);
694 virtual void Profile(FoldingSetNodeID &ID) {
695 ID.AddInteger(isEntry);
698 ID.AddPointer(Entry);
705 virtual void print(std::ostream &O) {
706 O << "Die: 0x" << std::hex << (intptr_t)Entry << std::dec;
711 //===----------------------------------------------------------------------===//
712 /// DIEBlock - A block of values. Primarily used for location expressions.
714 class DIEBlock : public DIEValue, public DIE {
716 unsigned Size; // Size in bytes excluding size header.
726 // Implement isa/cast/dyncast.
727 static bool classof(const DIEBlock *) { return true; }
728 static bool classof(const DIEValue *E) { return E->Type == isBlock; }
730 /// ComputeSize - calculate the size of the block.
732 unsigned ComputeSize(DwarfDebug &DD);
734 /// BestForm - Choose the best form for data.
736 unsigned BestForm() const {
737 if ((unsigned char)Size == Size) return DW_FORM_block1;
738 if ((unsigned short)Size == Size) return DW_FORM_block2;
739 if ((unsigned int)Size == Size) return DW_FORM_block4;
740 return DW_FORM_block;
743 /// EmitValue - Emit block data.
745 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
747 /// SizeOf - Determine size of block data in bytes.
749 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
752 /// Profile - Used to gather unique data for the value folding set.
754 virtual void Profile(FoldingSetNodeID &ID) {
755 ID.AddInteger(isBlock);
760 virtual void print(std::ostream &O) {
767 //===----------------------------------------------------------------------===//
768 /// CompileUnit - This dwarf writer support class manages information associate
769 /// with a source file.
772 /// ID - File identifier for source.
776 /// Die - Compile unit debug information entry.
780 /// GVToDieMap - Tracks the mapping of unit level debug informaton
781 /// variables to debug information entries.
782 std::map<GlobalVariable *, DIE *> GVToDieMap;
784 /// GVToDIEntryMap - Tracks the mapping of unit level debug informaton
785 /// descriptors to debug information entries using a DIEntry proxy.
786 std::map<GlobalVariable *, DIEntry *> GVToDIEntryMap;
788 /// Globals - A map of globally visible named entities for this unit.
790 std::map<std::string, DIE *> Globals;
792 /// DiesSet - Used to uniquely define dies within the compile unit.
794 FoldingSet<DIE> DiesSet;
797 CompileUnit(unsigned I, DIE *D)
798 : ID(I), Die(D), GVToDieMap(),
799 GVToDIEntryMap(), Globals(), DiesSet(InitDiesSetSize)
807 unsigned getID() const { return ID; }
808 DIE* getDie() const { return Die; }
809 std::map<std::string, DIE *> &getGlobals() { return Globals; }
811 /// hasContent - Return true if this compile unit has something to write out.
813 bool hasContent() const {
814 return !Die->getChildren().empty();
817 /// AddGlobal - Add a new global entity to the compile unit.
819 void AddGlobal(const std::string &Name, DIE *Die) {
823 /// getDieMapSlotFor - Returns the debug information entry map slot for the
824 /// specified debug variable.
825 DIE *&getDieMapSlotFor(GlobalVariable *GV) {
826 return GVToDieMap[GV];
829 /// getDIEntrySlotFor - Returns the debug information entry proxy slot for the
830 /// specified debug variable.
831 DIEntry *&getDIEntrySlotFor(GlobalVariable *GV) {
832 return GVToDIEntryMap[GV];
835 /// AddDie - Adds or interns the DIE to the compile unit.
837 DIE *AddDie(DIE &Buffer) {
841 DIE *Die = DiesSet.FindNodeOrInsertPos(ID, Where);
844 Die = new DIE(Buffer);
845 DiesSet.InsertNode(Die, Where);
846 this->Die->AddChild(Die);
854 //===----------------------------------------------------------------------===//
855 /// Dwarf - Emits general Dwarf directives.
859 //===--------------------------------------------------------------------===//
860 // Core attributes used by the Dwarf writer.
864 /// O - Stream to .s file.
868 /// Asm - Target of Dwarf emission.
872 /// TAI - Target asm information.
873 const TargetAsmInfo *TAI;
875 /// TD - Target data.
876 const TargetData *TD;
878 /// RI - Register Information.
879 const TargetRegisterInfo *RI;
881 /// M - Current module.
885 /// MF - Current machine function.
889 /// MMI - Collected machine module information.
891 MachineModuleInfo *MMI;
893 /// SubprogramCount - The running count of functions being compiled.
895 unsigned SubprogramCount;
897 /// Flavor - A unique string indicating what dwarf producer this is, used to
899 const char * const Flavor;
902 Dwarf(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T,
907 , TD(Asm->TM.getTargetData())
908 , RI(Asm->TM.getRegisterInfo())
919 //===--------------------------------------------------------------------===//
922 AsmPrinter *getAsm() const { return Asm; }
923 MachineModuleInfo *getMMI() const { return MMI; }
924 const TargetAsmInfo *getTargetAsmInfo() const { return TAI; }
925 const TargetData *getTargetData() const { return TD; }
927 void PrintRelDirective(bool Force32Bit = false, bool isInSection = false)
929 if (isInSection && TAI->getDwarfSectionOffsetDirective())
930 O << TAI->getDwarfSectionOffsetDirective();
931 else if (Force32Bit || TD->getPointerSize() == sizeof(int32_t))
932 O << TAI->getData32bitsDirective();
934 O << TAI->getData64bitsDirective();
937 /// PrintLabelName - Print label name in form used by Dwarf writer.
939 void PrintLabelName(DWLabel Label) const {
940 PrintLabelName(Label.Tag, Label.Number);
942 void PrintLabelName(const char *Tag, unsigned Number) const {
943 O << TAI->getPrivateGlobalPrefix() << Tag;
944 if (Number) O << Number;
947 void PrintLabelName(const char *Tag, unsigned Number,
948 const char *Suffix) const {
949 O << TAI->getPrivateGlobalPrefix() << Tag;
950 if (Number) O << Number;
954 /// EmitLabel - Emit location label for internal use by Dwarf.
956 void EmitLabel(DWLabel Label) const {
957 EmitLabel(Label.Tag, Label.Number);
959 void EmitLabel(const char *Tag, unsigned Number) const {
960 PrintLabelName(Tag, Number);
964 /// EmitReference - Emit a reference to a label.
966 void EmitReference(DWLabel Label, bool IsPCRelative = false,
967 bool Force32Bit = false) const {
968 EmitReference(Label.Tag, Label.Number, IsPCRelative, Force32Bit);
970 void EmitReference(const char *Tag, unsigned Number,
971 bool IsPCRelative = false, bool Force32Bit = false) const {
972 PrintRelDirective(Force32Bit);
973 PrintLabelName(Tag, Number);
975 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
977 void EmitReference(const std::string &Name, bool IsPCRelative = false,
978 bool Force32Bit = false) const {
979 PrintRelDirective(Force32Bit);
983 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
986 /// EmitDifference - Emit the difference between two labels. Some
987 /// assemblers do not behave with absolute expressions with data directives,
988 /// so there is an option (needsSet) to use an intermediary set expression.
989 void EmitDifference(DWLabel LabelHi, DWLabel LabelLo,
990 bool IsSmall = false) {
991 EmitDifference(LabelHi.Tag, LabelHi.Number,
992 LabelLo.Tag, LabelLo.Number,
995 void EmitDifference(const char *TagHi, unsigned NumberHi,
996 const char *TagLo, unsigned NumberLo,
997 bool IsSmall = false) {
998 if (TAI->needsSet()) {
1000 PrintLabelName("set", SetCounter, Flavor);
1002 PrintLabelName(TagHi, NumberHi);
1004 PrintLabelName(TagLo, NumberLo);
1007 PrintRelDirective(IsSmall);
1008 PrintLabelName("set", SetCounter, Flavor);
1011 PrintRelDirective(IsSmall);
1013 PrintLabelName(TagHi, NumberHi);
1015 PrintLabelName(TagLo, NumberLo);
1019 void EmitSectionOffset(const char* Label, const char* Section,
1020 unsigned LabelNumber, unsigned SectionNumber,
1021 bool IsSmall = false, bool isEH = false,
1022 bool useSet = true) {
1023 bool printAbsolute = false;
1025 printAbsolute = TAI->isAbsoluteEHSectionOffsets();
1027 printAbsolute = TAI->isAbsoluteDebugSectionOffsets();
1029 if (TAI->needsSet() && useSet) {
1031 PrintLabelName("set", SetCounter, Flavor);
1033 PrintLabelName(Label, LabelNumber);
1035 if (!printAbsolute) {
1037 PrintLabelName(Section, SectionNumber);
1041 PrintRelDirective(IsSmall);
1043 PrintLabelName("set", SetCounter, Flavor);
1046 PrintRelDirective(IsSmall, true);
1048 PrintLabelName(Label, LabelNumber);
1050 if (!printAbsolute) {
1052 PrintLabelName(Section, SectionNumber);
1057 /// EmitFrameMoves - Emit frame instructions to describe the layout of the
1059 void EmitFrameMoves(const char *BaseLabel, unsigned BaseLabelID,
1060 const std::vector<MachineMove> &Moves, bool isEH) {
1062 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
1063 TargetFrameInfo::StackGrowsUp ?
1064 TD->getPointerSize() : -TD->getPointerSize();
1065 bool IsLocal = BaseLabel && strcmp(BaseLabel, "label") == 0;
1067 for (unsigned i = 0, N = Moves.size(); i < N; ++i) {
1068 const MachineMove &Move = Moves[i];
1069 unsigned LabelID = Move.getLabelID();
1072 LabelID = MMI->MappedLabel(LabelID);
1074 // Throw out move if the label is invalid.
1075 if (!LabelID) continue;
1078 const MachineLocation &Dst = Move.getDestination();
1079 const MachineLocation &Src = Move.getSource();
1081 // Advance row if new location.
1082 if (BaseLabel && LabelID && (BaseLabelID != LabelID || !IsLocal)) {
1083 Asm->EmitInt8(DW_CFA_advance_loc4);
1084 Asm->EOL("DW_CFA_advance_loc4");
1085 EmitDifference("label", LabelID, BaseLabel, BaseLabelID, true);
1088 BaseLabelID = LabelID;
1089 BaseLabel = "label";
1093 // If advancing cfa.
1094 if (Dst.isReg() && Dst.getReg() == MachineLocation::VirtualFP) {
1096 if (Src.getReg() == MachineLocation::VirtualFP) {
1097 Asm->EmitInt8(DW_CFA_def_cfa_offset);
1098 Asm->EOL("DW_CFA_def_cfa_offset");
1100 Asm->EmitInt8(DW_CFA_def_cfa);
1101 Asm->EOL("DW_CFA_def_cfa");
1102 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Src.getReg(), isEH));
1103 Asm->EOL("Register");
1106 int Offset = -Src.getOffset();
1108 Asm->EmitULEB128Bytes(Offset);
1111 assert(0 && "Machine move no supported yet.");
1113 } else if (Src.isReg() &&
1114 Src.getReg() == MachineLocation::VirtualFP) {
1116 Asm->EmitInt8(DW_CFA_def_cfa_register);
1117 Asm->EOL("DW_CFA_def_cfa_register");
1118 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Dst.getReg(), isEH));
1119 Asm->EOL("Register");
1121 assert(0 && "Machine move no supported yet.");
1124 unsigned Reg = RI->getDwarfRegNum(Src.getReg(), isEH);
1125 int Offset = Dst.getOffset() / stackGrowth;
1128 Asm->EmitInt8(DW_CFA_offset_extended_sf);
1129 Asm->EOL("DW_CFA_offset_extended_sf");
1130 Asm->EmitULEB128Bytes(Reg);
1132 Asm->EmitSLEB128Bytes(Offset);
1134 } else if (Reg < 64) {
1135 Asm->EmitInt8(DW_CFA_offset + Reg);
1137 Asm->EOL("DW_CFA_offset + Reg (" + utostr(Reg) + ")");
1140 Asm->EmitULEB128Bytes(Offset);
1143 Asm->EmitInt8(DW_CFA_offset_extended);
1144 Asm->EOL("DW_CFA_offset_extended");
1145 Asm->EmitULEB128Bytes(Reg);
1147 Asm->EmitULEB128Bytes(Offset);
1156 //===----------------------------------------------------------------------===//
1157 /// SrcLineInfo - This class is used to record source line correspondence.
1160 unsigned Line; // Source line number.
1161 unsigned Column; // Source column.
1162 unsigned SourceID; // Source ID number.
1163 unsigned LabelID; // Label in code ID number.
1165 SrcLineInfo(unsigned L, unsigned C, unsigned S, unsigned I)
1166 : Line(L), Column(C), SourceID(S), LabelID(I) {}
1169 unsigned getLine() const { return Line; }
1170 unsigned getColumn() const { return Column; }
1171 unsigned getSourceID() const { return SourceID; }
1172 unsigned getLabelID() const { return LabelID; }
1175 //===----------------------------------------------------------------------===//
1176 /// SrcFileInfo - This class is used to track source information.
1179 unsigned DirectoryID; // Directory ID number.
1180 std::string Name; // File name (not including directory.)
1182 SrcFileInfo(unsigned D, const std::string &N) : DirectoryID(D), Name(N) {}
1185 unsigned getDirectoryID() const { return DirectoryID; }
1186 const std::string &getName() const { return Name; }
1188 /// operator== - Used by UniqueVector to locate entry.
1190 bool operator==(const SrcFileInfo &SI) const {
1191 return getDirectoryID() == SI.getDirectoryID() && getName() == SI.getName();
1194 /// operator< - Used by UniqueVector to locate entry.
1196 bool operator<(const SrcFileInfo &SI) const {
1197 return getDirectoryID() < SI.getDirectoryID() ||
1198 (getDirectoryID() == SI.getDirectoryID() && getName() < SI.getName());
1202 //===----------------------------------------------------------------------===//
1203 /// DbgVariable - This class is used to track local variable information.
1206 DIVariable Var; // Variable Descriptor.
1207 unsigned FrameIndex; // Variable frame index.
1209 DbgVariable(DIVariable V, unsigned I) : Var(V), FrameIndex(I) {}
1212 DIVariable getVariable() const { return Var; }
1213 unsigned getFrameIndex() const { return FrameIndex; }
1216 //===----------------------------------------------------------------------===//
1217 /// DbgScope - This class is used to track scope information.
1220 DbgScope *Parent; // Parent to this scope.
1221 DIDescriptor Desc; // Debug info descriptor for scope.
1222 // Either subprogram or block.
1223 unsigned StartLabelID; // Label ID of the beginning of scope.
1224 unsigned EndLabelID; // Label ID of the end of scope.
1225 SmallVector<DbgScope *, 4> Scopes; // Scopes defined in scope.
1226 SmallVector<DbgVariable *, 8> Variables;// Variables declared in scope.
1228 DbgScope(DbgScope *P, DIDescriptor D)
1229 : Parent(P), Desc(D), StartLabelID(0), EndLabelID(0), Scopes(), Variables()
1232 for (unsigned i = 0, N = Scopes.size(); i < N; ++i) delete Scopes[i];
1233 for (unsigned j = 0, M = Variables.size(); j < M; ++j) delete Variables[j];
1237 DbgScope *getParent() const { return Parent; }
1238 DIDescriptor getDesc() const { return Desc; }
1239 unsigned getStartLabelID() const { return StartLabelID; }
1240 unsigned getEndLabelID() const { return EndLabelID; }
1241 SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
1242 SmallVector<DbgVariable *, 8> &getVariables() { return Variables; }
1243 void setStartLabelID(unsigned S) { StartLabelID = S; }
1244 void setEndLabelID(unsigned E) { EndLabelID = E; }
1246 /// AddScope - Add a scope to the scope.
1248 void AddScope(DbgScope *S) { Scopes.push_back(S); }
1250 /// AddVariable - Add a variable to the scope.
1252 void AddVariable(DbgVariable *V) { Variables.push_back(V); }
1255 //===----------------------------------------------------------------------===//
1256 /// DwarfDebug - Emits Dwarf debug directives.
1258 class DwarfDebug : public Dwarf {
1259 //===--------------------------------------------------------------------===//
1260 // Attributes used to construct specific Dwarf sections.
1263 /// DW_CUs - All the compile units involved in this build. The index
1264 /// of each entry in this vector corresponds to the sources in MMI.
1265 DenseMap<Value *, CompileUnit *> DW_CUs;
1267 /// MainCU - Some platform prefers one compile unit per .o file. In such
1268 /// cases, all dies are inserted in MainCU.
1269 CompileUnit *MainCU;
1270 /// AbbreviationsSet - Used to uniquely define abbreviations.
1272 FoldingSet<DIEAbbrev> AbbreviationsSet;
1274 /// Abbreviations - A list of all the unique abbreviations in use.
1276 std::vector<DIEAbbrev *> Abbreviations;
1278 /// Directories - Uniquing vector for directories.
1279 UniqueVector<std::string> Directories;
1281 /// SourceFiles - Uniquing vector for source files.
1282 UniqueVector<SrcFileInfo> SrcFiles;
1284 /// Lines - List of of source line correspondence.
1285 std::vector<SrcLineInfo> Lines;
1287 /// ValuesSet - Used to uniquely define values.
1289 FoldingSet<DIEValue> ValuesSet;
1291 /// Values - A list of all the unique values in use.
1293 std::vector<DIEValue *> Values;
1295 /// StringPool - A UniqueVector of strings used by indirect references.
1297 UniqueVector<std::string> StringPool;
1299 /// SectionMap - Provides a unique id per text section.
1301 UniqueVector<const Section*> SectionMap;
1303 /// SectionSourceLines - Tracks line numbers per text section.
1305 std::vector<std::vector<SrcLineInfo> > SectionSourceLines;
1307 /// didInitial - Flag to indicate if initial emission has been done.
1311 /// shouldEmit - Flag to indicate if debug information should be emitted.
1315 // RootDbgScope - Top level scope for the current function.
1317 DbgScope *RootDbgScope;
1319 // DbgScopeMap - Tracks the scopes in the current function.
1320 DenseMap<GlobalVariable *, DbgScope *> DbgScopeMap;
1322 struct FunctionDebugFrameInfo {
1324 std::vector<MachineMove> Moves;
1326 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M):
1327 Number(Num), Moves(M) { }
1330 std::vector<FunctionDebugFrameInfo> DebugFrames;
1334 /// ShouldEmitDwarf - Returns true if Dwarf declarations should be made.
1336 bool ShouldEmitDwarf() const { return shouldEmit; }
1338 /// AssignAbbrevNumber - Define a unique number for the abbreviation.
1340 void AssignAbbrevNumber(DIEAbbrev &Abbrev) {
1341 // Profile the node so that we can make it unique.
1342 FoldingSetNodeID ID;
1345 // Check the set for priors.
1346 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
1348 // If it's newly added.
1349 if (InSet == &Abbrev) {
1350 // Add to abbreviation list.
1351 Abbreviations.push_back(&Abbrev);
1352 // Assign the vector position + 1 as its number.
1353 Abbrev.setNumber(Abbreviations.size());
1355 // Assign existing abbreviation number.
1356 Abbrev.setNumber(InSet->getNumber());
1360 /// NewString - Add a string to the constant pool and returns a label.
1362 DWLabel NewString(const std::string &String) {
1363 unsigned StringID = StringPool.insert(String);
1364 return DWLabel("string", StringID);
1367 /// NewDIEntry - Creates a new DIEntry to be a proxy for a debug information
1369 DIEntry *NewDIEntry(DIE *Entry = NULL) {
1373 FoldingSetNodeID ID;
1374 DIEntry::Profile(ID, Entry);
1376 Value = static_cast<DIEntry *>(ValuesSet.FindNodeOrInsertPos(ID, Where));
1378 if (Value) return Value;
1380 Value = new DIEntry(Entry);
1381 ValuesSet.InsertNode(Value, Where);
1383 Value = new DIEntry(Entry);
1386 Values.push_back(Value);
1390 /// SetDIEntry - Set a DIEntry once the debug information entry is defined.
1392 void SetDIEntry(DIEntry *Value, DIE *Entry) {
1393 Value->Entry = Entry;
1394 // Add to values set if not already there. If it is, we merely have a
1395 // duplicate in the values list (no harm.)
1396 ValuesSet.GetOrInsertNode(Value);
1399 /// AddUInt - Add an unsigned integer attribute data and value.
1401 void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer) {
1402 if (!Form) Form = DIEInteger::BestForm(false, Integer);
1404 FoldingSetNodeID ID;
1405 DIEInteger::Profile(ID, Integer);
1407 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1409 Value = new DIEInteger(Integer);
1410 ValuesSet.InsertNode(Value, Where);
1411 Values.push_back(Value);
1414 Die->AddValue(Attribute, Form, Value);
1417 /// AddSInt - Add an signed integer attribute data and value.
1419 void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer) {
1420 if (!Form) Form = DIEInteger::BestForm(true, Integer);
1422 FoldingSetNodeID ID;
1423 DIEInteger::Profile(ID, (uint64_t)Integer);
1425 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1427 Value = new DIEInteger(Integer);
1428 ValuesSet.InsertNode(Value, Where);
1429 Values.push_back(Value);
1432 Die->AddValue(Attribute, Form, Value);
1435 /// AddString - Add a std::string attribute data and value.
1437 void AddString(DIE *Die, unsigned Attribute, unsigned Form,
1438 const std::string &String) {
1439 FoldingSetNodeID ID;
1440 DIEString::Profile(ID, String);
1442 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1444 Value = new DIEString(String);
1445 ValuesSet.InsertNode(Value, Where);
1446 Values.push_back(Value);
1449 Die->AddValue(Attribute, Form, Value);
1452 /// AddLabel - Add a Dwarf label attribute data and value.
1454 void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
1455 const DWLabel &Label) {
1456 FoldingSetNodeID ID;
1457 DIEDwarfLabel::Profile(ID, Label);
1459 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1461 Value = new DIEDwarfLabel(Label);
1462 ValuesSet.InsertNode(Value, Where);
1463 Values.push_back(Value);
1466 Die->AddValue(Attribute, Form, Value);
1469 /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
1471 void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
1472 const std::string &Label) {
1473 FoldingSetNodeID ID;
1474 DIEObjectLabel::Profile(ID, Label);
1476 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1478 Value = new DIEObjectLabel(Label);
1479 ValuesSet.InsertNode(Value, Where);
1480 Values.push_back(Value);
1483 Die->AddValue(Attribute, Form, Value);
1486 /// AddSectionOffset - Add a section offset label attribute data and value.
1488 void AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
1489 const DWLabel &Label, const DWLabel &Section,
1490 bool isEH = false, bool useSet = true) {
1491 FoldingSetNodeID ID;
1492 DIESectionOffset::Profile(ID, Label, Section);
1494 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1496 Value = new DIESectionOffset(Label, Section, isEH, useSet);
1497 ValuesSet.InsertNode(Value, Where);
1498 Values.push_back(Value);
1501 Die->AddValue(Attribute, Form, Value);
1504 /// AddDelta - Add a label delta attribute data and value.
1506 void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
1507 const DWLabel &Hi, const DWLabel &Lo) {
1508 FoldingSetNodeID ID;
1509 DIEDelta::Profile(ID, Hi, Lo);
1511 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1513 Value = new DIEDelta(Hi, Lo);
1514 ValuesSet.InsertNode(Value, Where);
1515 Values.push_back(Value);
1518 Die->AddValue(Attribute, Form, Value);
1521 /// AddDIEntry - Add a DIE attribute data and value.
1523 void AddDIEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
1524 Die->AddValue(Attribute, Form, NewDIEntry(Entry));
1527 /// AddBlock - Add block data.
1529 void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block) {
1530 Block->ComputeSize(*this);
1531 FoldingSetNodeID ID;
1534 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1537 ValuesSet.InsertNode(Value, Where);
1538 Values.push_back(Value);
1540 // Already exists, reuse the previous one.
1542 Block = cast<DIEBlock>(Value);
1545 Die->AddValue(Attribute, Block->BestForm(), Value);
1550 /// AddSourceLine - Add location information to specified debug information
1552 void AddSourceLine(DIE *Die, const DIVariable *V) {
1553 unsigned FileID = 0;
1554 unsigned Line = V->getLineNumber();
1555 CompileUnit *Unit = FindCompileUnit(V->getCompileUnit());
1556 FileID = Unit->getID();
1557 assert (FileID && "Invalid file id");
1558 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1559 AddUInt(Die, DW_AT_decl_line, 0, Line);
1562 /// AddSourceLine - Add location information to specified debug information
1564 void AddSourceLine(DIE *Die, const DIGlobal *G) {
1565 unsigned FileID = 0;
1566 unsigned Line = G->getLineNumber();
1567 CompileUnit *Unit = FindCompileUnit(G->getCompileUnit());
1568 FileID = Unit->getID();
1569 assert (FileID && "Invalid file id");
1570 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1571 AddUInt(Die, DW_AT_decl_line, 0, Line);
1574 void AddSourceLine(DIE *Die, const DIType *Ty) {
1575 unsigned FileID = 0;
1576 unsigned Line = Ty->getLineNumber();
1577 DICompileUnit CU = Ty->getCompileUnit();
1580 CompileUnit *Unit = FindCompileUnit(CU);
1581 FileID = Unit->getID();
1582 assert (FileID && "Invalid file id");
1583 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1584 AddUInt(Die, DW_AT_decl_line, 0, Line);
1587 /// AddAddress - Add an address attribute to a die based on the location
1589 void AddAddress(DIE *Die, unsigned Attribute,
1590 const MachineLocation &Location) {
1591 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
1592 DIEBlock *Block = new DIEBlock();
1594 if (Location.isReg()) {
1596 AddUInt(Block, 0, DW_FORM_data1, DW_OP_reg0 + Reg);
1598 AddUInt(Block, 0, DW_FORM_data1, DW_OP_regx);
1599 AddUInt(Block, 0, DW_FORM_udata, Reg);
1603 AddUInt(Block, 0, DW_FORM_data1, DW_OP_breg0 + Reg);
1605 AddUInt(Block, 0, DW_FORM_data1, DW_OP_bregx);
1606 AddUInt(Block, 0, DW_FORM_udata, Reg);
1608 AddUInt(Block, 0, DW_FORM_sdata, Location.getOffset());
1611 AddBlock(Die, Attribute, 0, Block);
1614 /// AddType - Add a new type attribute to the specified entity.
1615 void AddType(CompileUnit *DW_Unit, DIE *Entity, DIType Ty) {
1619 // Check for pre-existence.
1620 DIEntry *&Slot = DW_Unit->getDIEntrySlotFor(Ty.getGV());
1621 // If it exists then use the existing value.
1623 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1628 Slot = NewDIEntry();
1631 DIE Buffer(DW_TAG_base_type);
1632 if (Ty.isBasicType(Ty.getTag()))
1633 ConstructTypeDIE(DW_Unit, Buffer, DIBasicType(Ty.getGV()));
1634 else if (Ty.isDerivedType(Ty.getTag()))
1635 ConstructTypeDIE(DW_Unit, Buffer, DIDerivedType(Ty.getGV()));
1637 assert(Ty.isCompositeType(Ty.getTag()) && "Unknown kind of DIType");
1638 ConstructTypeDIE(DW_Unit, Buffer, DICompositeType(Ty.getGV()));
1641 // Add debug information entry to entity and appropriate context.
1643 DIDescriptor Context = Ty.getContext();
1644 if (!Context.isNull())
1645 Die = DW_Unit->getDieMapSlotFor(Context.getGV());
1648 DIE *Child = new DIE(Buffer);
1649 Die->AddChild(Child);
1651 SetDIEntry(Slot, Child);
1653 Die = DW_Unit->AddDie(Buffer);
1654 SetDIEntry(Slot, Die);
1657 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1660 /// ConstructTypeDIE - Construct basic type die from DIBasicType.
1661 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1664 // Get core information.
1665 const std::string &Name = BTy.getName();
1666 Buffer.setTag(DW_TAG_base_type);
1667 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, BTy.getEncoding());
1668 // Add name if not anonymous or intermediate type.
1670 AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1671 uint64_t Size = BTy.getSizeInBits() >> 3;
1672 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1675 /// ConstructTypeDIE - Construct derived type die from DIDerivedType.
1676 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1677 DIDerivedType DTy) {
1679 // Get core information.
1680 const std::string &Name = DTy.getName();
1681 uint64_t Size = DTy.getSizeInBits() >> 3;
1682 unsigned Tag = DTy.getTag();
1683 // FIXME - Workaround for templates.
1684 if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
1687 // Map to main type, void will not have a type.
1688 DIType FromTy = DTy.getTypeDerivedFrom();
1689 AddType(DW_Unit, &Buffer, FromTy);
1691 // Add name if not anonymous or intermediate type.
1692 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1694 // Add size if non-zero (derived types might be zero-sized.)
1696 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1698 // Add source line info if available and TyDesc is not a forward
1700 if (!DTy.isForwardDecl())
1701 AddSourceLine(&Buffer, &DTy);
1704 /// ConstructTypeDIE - Construct type DIE from DICompositeType.
1705 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1706 DICompositeType CTy) {
1708 // Get core information.
1709 const std::string &Name = CTy.getName();
1710 uint64_t Size = CTy.getSizeInBits() >> 3;
1711 unsigned Tag = CTy.getTag();
1714 case DW_TAG_vector_type:
1715 case DW_TAG_array_type:
1716 ConstructArrayTypeDIE(DW_Unit, Buffer, &CTy);
1718 case DW_TAG_enumeration_type:
1720 DIArray Elements = CTy.getTypeArray();
1721 // Add enumerators to enumeration type.
1722 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1723 DIE *ElemDie = NULL;
1724 DIEnumerator Enum(Elements.getElement(i).getGV());
1725 ElemDie = ConstructEnumTypeDIE(DW_Unit, &Enum);
1726 Buffer.AddChild(ElemDie);
1730 case DW_TAG_subroutine_type:
1732 // Add prototype flag.
1733 AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
1734 DIArray Elements = CTy.getTypeArray();
1736 DIDescriptor RTy = Elements.getElement(0);
1737 AddType(DW_Unit, &Buffer, DIType(RTy.getGV()));
1740 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1741 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1742 DIDescriptor Ty = Elements.getElement(i);
1743 AddType(DW_Unit, Arg, DIType(Ty.getGV()));
1744 Buffer.AddChild(Arg);
1748 case DW_TAG_structure_type:
1749 case DW_TAG_union_type:
1751 // Add elements to structure type.
1752 DIArray Elements = CTy.getTypeArray();
1754 // A forward struct declared type may not have elements available.
1755 if (Elements.isNull())
1758 // Add elements to structure type.
1759 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1760 DIDescriptor Element = Elements.getElement(i);
1761 DIE *ElemDie = NULL;
1762 if (Element.getTag() == dwarf::DW_TAG_subprogram)
1763 ElemDie = CreateSubprogramDIE(DW_Unit,
1764 DISubprogram(Element.getGV()));
1765 else if (Element.getTag() == dwarf::DW_TAG_variable) // ???
1766 ElemDie = CreateGlobalVariableDIE(DW_Unit,
1767 DIGlobalVariable(Element.getGV()));
1769 ElemDie = CreateMemberDIE(DW_Unit,
1770 DIDerivedType(Element.getGV()));
1771 Buffer.AddChild(ElemDie);
1779 // Add name if not anonymous or intermediate type.
1780 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1782 if (Tag == DW_TAG_enumeration_type || Tag == DW_TAG_structure_type
1783 || Tag == DW_TAG_union_type) {
1784 // Add size if non-zero (derived types might be zero-sized.)
1786 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1788 // Add zero size if it is not a forward declaration.
1789 if (CTy.isForwardDecl())
1790 AddUInt(&Buffer, DW_AT_declaration, DW_FORM_flag, 1);
1792 AddUInt(&Buffer, DW_AT_byte_size, 0, 0);
1795 // Add source line info if available.
1796 if (!CTy.isForwardDecl())
1797 AddSourceLine(&Buffer, &CTy);
1801 /// ConstructSubrangeDIE - Construct subrange DIE from DISubrange.
1802 void ConstructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy) {
1803 int64_t L = SR.getLo();
1804 int64_t H = SR.getHi();
1805 DIE *DW_Subrange = new DIE(DW_TAG_subrange_type);
1807 AddDIEntry(DW_Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1809 AddSInt(DW_Subrange, DW_AT_lower_bound, 0, L);
1810 AddSInt(DW_Subrange, DW_AT_upper_bound, 0, H);
1812 Buffer.AddChild(DW_Subrange);
1815 /// ConstructArrayTypeDIE - Construct array type DIE from DICompositeType.
1816 void ConstructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1817 DICompositeType *CTy) {
1818 Buffer.setTag(DW_TAG_array_type);
1819 if (CTy->getTag() == DW_TAG_vector_type)
1820 AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1822 // Emit derived type.
1823 AddType(DW_Unit, &Buffer, CTy->getTypeDerivedFrom());
1824 DIArray Elements = CTy->getTypeArray();
1826 // Construct an anonymous type for index type.
1827 DIE IdxBuffer(DW_TAG_base_type);
1828 AddUInt(&IdxBuffer, DW_AT_byte_size, 0, sizeof(int32_t));
1829 AddUInt(&IdxBuffer, DW_AT_encoding, DW_FORM_data1, DW_ATE_signed);
1830 DIE *IndexTy = DW_Unit->AddDie(IdxBuffer);
1832 // Add subranges to array type.
1833 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1834 DIDescriptor Element = Elements.getElement(i);
1835 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
1836 ConstructSubrangeDIE(Buffer, DISubrange(Element.getGV()), IndexTy);
1840 /// ConstructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
1841 DIE *ConstructEnumTypeDIE(CompileUnit *DW_Unit, DIEnumerator *ETy) {
1843 DIE *Enumerator = new DIE(DW_TAG_enumerator);
1844 AddString(Enumerator, DW_AT_name, DW_FORM_string, ETy->getName());
1845 int64_t Value = ETy->getEnumValue();
1846 AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
1850 /// CreateGlobalVariableDIE - Create new DIE using GV.
1851 DIE *CreateGlobalVariableDIE(CompileUnit *DW_Unit, const DIGlobalVariable &GV)
1853 DIE *GVDie = new DIE(DW_TAG_variable);
1854 AddString(GVDie, DW_AT_name, DW_FORM_string, GV.getName());
1855 const std::string &LinkageName = GV.getLinkageName();
1856 if (!LinkageName.empty())
1857 AddString(GVDie, DW_AT_MIPS_linkage_name, DW_FORM_string, LinkageName);
1858 AddType(DW_Unit, GVDie, GV.getType());
1859 if (!GV.isLocalToUnit())
1860 AddUInt(GVDie, DW_AT_external, DW_FORM_flag, 1);
1861 AddSourceLine(GVDie, &GV);
1865 /// CreateMemberDIE - Create new member DIE.
1866 DIE *CreateMemberDIE(CompileUnit *DW_Unit, const DIDerivedType &DT) {
1867 DIE *MemberDie = new DIE(DT.getTag());
1868 std::string Name = DT.getName();
1870 AddString(MemberDie, DW_AT_name, DW_FORM_string, Name);
1872 AddType(DW_Unit, MemberDie, DT.getTypeDerivedFrom());
1874 AddSourceLine(MemberDie, &DT);
1876 uint64_t Size = DT.getSizeInBits();
1877 uint64_t FieldSize = DT.getOriginalTypeSize();
1879 if (Size != FieldSize) {
1881 AddUInt(MemberDie, DW_AT_byte_size, 0, DT.getOriginalTypeSize() >> 3);
1882 AddUInt(MemberDie, DW_AT_bit_size, 0, DT.getSizeInBits());
1884 uint64_t Offset = DT.getOffsetInBits();
1885 uint64_t FieldOffset = Offset;
1886 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1887 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1888 FieldOffset = (HiMark - FieldSize);
1889 Offset -= FieldOffset;
1890 // Maybe we need to work from the other end.
1891 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
1892 AddUInt(MemberDie, DW_AT_bit_offset, 0, Offset);
1894 DIEBlock *Block = new DIEBlock();
1895 AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
1896 AddUInt(Block, 0, DW_FORM_udata, DT.getOffsetInBits() >> 3);
1897 AddBlock(MemberDie, DW_AT_data_member_location, 0, Block);
1899 if (DT.isProtected())
1900 AddUInt(MemberDie, DW_AT_accessibility, 0, DW_ACCESS_protected);
1901 else if (DT.isPrivate())
1902 AddUInt(MemberDie, DW_AT_accessibility, 0, DW_ACCESS_private);
1907 /// CreateSubprogramDIE - Create new DIE using SP.
1908 DIE *CreateSubprogramDIE(CompileUnit *DW_Unit,
1909 const DISubprogram &SP,
1910 bool IsConstructor = false) {
1911 DIE *SPDie = new DIE(DW_TAG_subprogram);
1912 AddString(SPDie, DW_AT_name, DW_FORM_string, SP.getName());
1913 const std::string &LinkageName = SP.getLinkageName();
1914 if (!LinkageName.empty())
1915 AddString(SPDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
1917 AddSourceLine(SPDie, &SP);
1919 DICompositeType SPTy = SP.getType();
1920 DIArray Args = SPTy.getTypeArray();
1924 AddType(DW_Unit, SPDie, DIType(Args.getElement(0).getGV()));
1926 if (!SP.isDefinition()) {
1927 AddUInt(SPDie, DW_AT_declaration, DW_FORM_flag, 1);
1929 // Do not add arguments for subprogram definition. They will be
1930 // handled through RecordVariable.
1932 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1933 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1934 AddType(DW_Unit, Arg, DIType(Args.getElement(i).getGV()));
1935 AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1); // ???
1936 SPDie->AddChild(Arg);
1940 if (!SP.isLocalToUnit())
1941 AddUInt(SPDie, DW_AT_external, DW_FORM_flag, 1);
1945 /// FindCompileUnit - Get the compile unit for the given descriptor.
1947 CompileUnit *FindCompileUnit(DICompileUnit Unit) {
1948 CompileUnit *DW_Unit = DW_CUs[Unit.getGV()];
1949 assert(DW_Unit && "Missing compile unit.");
1953 /// NewDbgScopeVariable - Create a new scope variable.
1955 DIE *NewDbgScopeVariable(DbgVariable *DV, CompileUnit *Unit) {
1956 // Get the descriptor.
1957 const DIVariable &VD = DV->getVariable();
1959 // Translate tag to proper Dwarf tag. The result variable is dropped for
1962 switch (VD.getTag()) {
1963 case DW_TAG_return_variable: return NULL;
1964 case DW_TAG_arg_variable: Tag = DW_TAG_formal_parameter; break;
1965 case DW_TAG_auto_variable: // fall thru
1966 default: Tag = DW_TAG_variable; break;
1969 // Define variable debug information entry.
1970 DIE *VariableDie = new DIE(Tag);
1971 AddString(VariableDie, DW_AT_name, DW_FORM_string, VD.getName());
1973 // Add source line info if available.
1974 AddSourceLine(VariableDie, &VD);
1976 // Add variable type.
1977 AddType(Unit, VariableDie, VD.getType());
1979 // Add variable address.
1980 MachineLocation Location;
1981 Location.set(RI->getFrameRegister(*MF),
1982 RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
1983 AddAddress(VariableDie, DW_AT_location, Location);
1988 /// getOrCreateScope - Returns the scope associated with the given descriptor.
1990 DbgScope *getOrCreateScope(GlobalVariable *V) {
1991 DbgScope *&Slot = DbgScopeMap[V];
1993 // FIXME - breaks down when the context is an inlined function.
1994 DIDescriptor ParentDesc;
1995 DIDescriptor Desc(V);
1996 if (Desc.getTag() == dwarf::DW_TAG_lexical_block) {
1998 ParentDesc = Block.getContext();
2000 DbgScope *Parent = ParentDesc.isNull() ?
2001 NULL : getOrCreateScope(ParentDesc.getGV());
2002 Slot = new DbgScope(Parent, Desc);
2004 Parent->AddScope(Slot);
2005 } else if (RootDbgScope) {
2006 // FIXME - Add inlined function scopes to the root so we can delete
2007 // them later. Long term, handle inlined functions properly.
2008 RootDbgScope->AddScope(Slot);
2010 // First function is top level function.
2011 RootDbgScope = Slot;
2017 /// ConstructDbgScope - Construct the components of a scope.
2019 void ConstructDbgScope(DbgScope *ParentScope,
2020 unsigned ParentStartID, unsigned ParentEndID,
2021 DIE *ParentDie, CompileUnit *Unit) {
2022 // Add variables to scope.
2023 SmallVector<DbgVariable *, 8> &Variables = ParentScope->getVariables();
2024 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2025 DIE *VariableDie = NewDbgScopeVariable(Variables[i], Unit);
2026 if (VariableDie) ParentDie->AddChild(VariableDie);
2029 // Add nested scopes.
2030 SmallVector<DbgScope *, 4> &Scopes = ParentScope->getScopes();
2031 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
2032 // Define the Scope debug information entry.
2033 DbgScope *Scope = Scopes[j];
2034 // FIXME - Ignore inlined functions for the time being.
2035 if (!Scope->getParent()) continue;
2037 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
2038 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
2040 // Ignore empty scopes.
2041 if (StartID == EndID && StartID != 0) continue;
2042 if (Scope->getScopes().empty() && Scope->getVariables().empty()) continue;
2044 if (StartID == ParentStartID && EndID == ParentEndID) {
2045 // Just add stuff to the parent scope.
2046 ConstructDbgScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
2048 DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
2050 // Add the scope bounds.
2052 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2053 DWLabel("label", StartID));
2055 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2056 DWLabel("func_begin", SubprogramCount));
2059 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2060 DWLabel("label", EndID));
2062 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2063 DWLabel("func_end", SubprogramCount));
2066 // Add the scope contents.
2067 ConstructDbgScope(Scope, StartID, EndID, ScopeDie, Unit);
2068 ParentDie->AddChild(ScopeDie);
2073 /// ConstructRootDbgScope - Construct the scope for the subprogram.
2075 void ConstructRootDbgScope(DbgScope *RootScope) {
2076 // Exit if there is no root scope.
2077 if (!RootScope) return;
2078 DIDescriptor Desc = RootScope->getDesc();
2082 // Get the subprogram debug information entry.
2083 DISubprogram SPD(Desc.getGV());
2085 // Get the compile unit context.
2086 CompileUnit *Unit = MainCU;
2088 Unit = FindCompileUnit(SPD.getCompileUnit());
2090 // Get the subprogram die.
2091 DIE *SPDie = Unit->getDieMapSlotFor(SPD.getGV());
2092 assert(SPDie && "Missing subprogram descriptor");
2094 // Add the function bounds.
2095 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2096 DWLabel("func_begin", SubprogramCount));
2097 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2098 DWLabel("func_end", SubprogramCount));
2099 MachineLocation Location(RI->getFrameRegister(*MF));
2100 AddAddress(SPDie, DW_AT_frame_base, Location);
2102 ConstructDbgScope(RootScope, 0, 0, SPDie, Unit);
2105 /// ConstructDefaultDbgScope - Construct a default scope for the subprogram.
2107 void ConstructDefaultDbgScope(MachineFunction *MF) {
2108 // Find the correct subprogram descriptor.
2109 std::string SPName = "llvm.dbg.subprograms";
2110 std::vector<GlobalVariable*> Result;
2111 getGlobalVariablesUsing(*M, SPName, Result);
2113 for (std::vector<GlobalVariable *>::iterator I = Result.begin(),
2114 E = Result.end(); I != E; ++I) {
2115 DISubprogram SPD(*I);
2117 if (SPD.getName() == MF->getFunction()->getName()) {
2118 // Get the compile unit context.
2119 CompileUnit *Unit = MainCU;
2121 Unit = FindCompileUnit(SPD.getCompileUnit());
2123 // Get the subprogram die.
2124 DIE *SPDie = Unit->getDieMapSlotFor(SPD.getGV());
2125 assert(SPDie && "Missing subprogram descriptor");
2127 // Add the function bounds.
2128 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2129 DWLabel("func_begin", SubprogramCount));
2130 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2131 DWLabel("func_end", SubprogramCount));
2133 MachineLocation Location(RI->getFrameRegister(*MF));
2134 AddAddress(SPDie, DW_AT_frame_base, Location);
2139 // FIXME: This is causing an abort because C++ mangled names are compared
2140 // with their unmangled counterparts. See PR2885. Don't do this assert.
2141 assert(0 && "Couldn't find DIE for machine function!");
2145 /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
2146 /// tools to recognize the object file contains Dwarf information.
2147 void EmitInitial() {
2148 // Check to see if we already emitted intial headers.
2149 if (didInitial) return;
2152 // Dwarf sections base addresses.
2153 if (TAI->doesDwarfRequireFrameSection()) {
2154 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2155 EmitLabel("section_debug_frame", 0);
2157 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2158 EmitLabel("section_info", 0);
2159 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2160 EmitLabel("section_abbrev", 0);
2161 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2162 EmitLabel("section_aranges", 0);
2163 if (TAI->doesSupportMacInfoSection()) {
2164 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2165 EmitLabel("section_macinfo", 0);
2167 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2168 EmitLabel("section_line", 0);
2169 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2170 EmitLabel("section_loc", 0);
2171 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2172 EmitLabel("section_pubnames", 0);
2173 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2174 EmitLabel("section_str", 0);
2175 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2176 EmitLabel("section_ranges", 0);
2178 Asm->SwitchToSection(TAI->getTextSection());
2179 EmitLabel("text_begin", 0);
2180 Asm->SwitchToSection(TAI->getDataSection());
2181 EmitLabel("data_begin", 0);
2184 /// EmitDIE - Recusively Emits a debug information entry.
2186 void EmitDIE(DIE *Die) {
2187 // Get the abbreviation for this DIE.
2188 unsigned AbbrevNumber = Die->getAbbrevNumber();
2189 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2193 // Emit the code (index) for the abbreviation.
2194 Asm->EmitULEB128Bytes(AbbrevNumber);
2197 Asm->EOL(std::string("Abbrev [" +
2198 utostr(AbbrevNumber) +
2199 "] 0x" + utohexstr(Die->getOffset()) +
2200 ":0x" + utohexstr(Die->getSize()) + " " +
2201 TagString(Abbrev->getTag())));
2205 SmallVector<DIEValue*, 32> &Values = Die->getValues();
2206 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2208 // Emit the DIE attribute values.
2209 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2210 unsigned Attr = AbbrevData[i].getAttribute();
2211 unsigned Form = AbbrevData[i].getForm();
2212 assert(Form && "Too many attributes for DIE (check abbreviation)");
2215 case DW_AT_sibling: {
2216 Asm->EmitInt32(Die->SiblingOffset());
2220 // Emit an attribute using the defined form.
2221 Values[i]->EmitValue(*this, Form);
2226 Asm->EOL(AttributeString(Attr));
2229 // Emit the DIE children if any.
2230 if (Abbrev->getChildrenFlag() == DW_CHILDREN_yes) {
2231 const std::vector<DIE *> &Children = Die->getChildren();
2233 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2234 EmitDIE(Children[j]);
2237 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2241 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
2243 unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
2244 // Get the children.
2245 const std::vector<DIE *> &Children = Die->getChildren();
2247 // If not last sibling and has children then add sibling offset attribute.
2248 if (!Last && !Children.empty()) Die->AddSiblingOffset();
2250 // Record the abbreviation.
2251 AssignAbbrevNumber(Die->getAbbrev());
2253 // Get the abbreviation for this DIE.
2254 unsigned AbbrevNumber = Die->getAbbrevNumber();
2255 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2258 Die->setOffset(Offset);
2260 // Start the size with the size of abbreviation code.
2261 Offset += TargetAsmInfo::getULEB128Size(AbbrevNumber);
2263 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2264 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2266 // Size the DIE attribute values.
2267 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2268 // Size attribute value.
2269 Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
2272 // Size the DIE children if any.
2273 if (!Children.empty()) {
2274 assert(Abbrev->getChildrenFlag() == DW_CHILDREN_yes &&
2275 "Children flag not set");
2277 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2278 Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
2281 // End of children marker.
2282 Offset += sizeof(int8_t);
2285 Die->setSize(Offset - Die->getOffset());
2289 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
2291 void SizeAndOffsets() {
2292 // Process base compile unit.
2294 // Compute size of compile unit header
2295 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2296 sizeof(int16_t) + // DWARF version number
2297 sizeof(int32_t) + // Offset Into Abbrev. Section
2298 sizeof(int8_t); // Pointer Size (in bytes)
2299 SizeAndOffsetDie(MainCU->getDie(), Offset, true);
2302 for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
2303 CE = DW_CUs.end(); CI != CE; ++CI) {
2304 CompileUnit *Unit = CI->second;
2305 // Compute size of compile unit header
2306 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2307 sizeof(int16_t) + // DWARF version number
2308 sizeof(int32_t) + // Offset Into Abbrev. Section
2309 sizeof(int8_t); // Pointer Size (in bytes)
2310 SizeAndOffsetDie(Unit->getDie(), Offset, true);
2314 /// EmitDebugInfo - Emit the debug info section.
2316 void EmitDebugInfo() {
2317 // Start debug info section.
2318 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2320 for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
2321 CE = DW_CUs.end(); CI != CE; ++CI) {
2322 CompileUnit *Unit = CI->second;
2325 DIE *Die = Unit->getDie();
2326 // Emit the compile units header.
2327 EmitLabel("info_begin", Unit->getID());
2328 // Emit size of content not including length itself
2329 unsigned ContentSize = Die->getSize() +
2330 sizeof(int16_t) + // DWARF version number
2331 sizeof(int32_t) + // Offset Into Abbrev. Section
2332 sizeof(int8_t) + // Pointer Size (in bytes)
2333 sizeof(int32_t); // FIXME - extra pad for gdb bug.
2335 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2336 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2337 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2338 Asm->EOL("Offset Into Abbrev. Section");
2339 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2342 // FIXME - extra padding for gdb bug.
2343 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2344 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2345 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2346 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2347 EmitLabel("info_end", Unit->getID());
2355 /// EmitAbbreviations - Emit the abbreviation section.
2357 void EmitAbbreviations() const {
2358 // Check to see if it is worth the effort.
2359 if (!Abbreviations.empty()) {
2360 // Start the debug abbrev section.
2361 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2363 EmitLabel("abbrev_begin", 0);
2365 // For each abbrevation.
2366 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2367 // Get abbreviation data
2368 const DIEAbbrev *Abbrev = Abbreviations[i];
2370 // Emit the abbrevations code (base 1 index.)
2371 Asm->EmitULEB128Bytes(Abbrev->getNumber());
2372 Asm->EOL("Abbreviation Code");
2374 // Emit the abbreviations data.
2375 Abbrev->Emit(*this);
2380 // Mark end of abbreviations.
2381 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2383 EmitLabel("abbrev_end", 0);
2389 /// EmitEndOfLineMatrix - Emit the last address of the section and the end of
2390 /// the line matrix.
2392 void EmitEndOfLineMatrix(unsigned SectionEnd) {
2393 // Define last address of section.
2394 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2395 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2396 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2397 EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
2399 // Mark end of matrix.
2400 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2401 Asm->EmitULEB128Bytes(1); Asm->EOL();
2402 Asm->EmitInt8(1); Asm->EOL();
2405 /// EmitDebugLines - Emit source line information.
2407 void EmitDebugLines() {
2408 // If the target is using .loc/.file, the assembler will be emitting the
2409 // .debug_line table automatically.
2410 if (TAI->hasDotLocAndDotFile())
2413 // Minimum line delta, thus ranging from -10..(255-10).
2414 const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
2415 // Maximum line delta, thus ranging from -10..(255-10).
2416 const int MaxLineDelta = 255 + MinLineDelta;
2418 // Start the dwarf line section.
2419 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2421 // Construct the section header.
2423 EmitDifference("line_end", 0, "line_begin", 0, true);
2424 Asm->EOL("Length of Source Line Info");
2425 EmitLabel("line_begin", 0);
2427 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2429 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2430 Asm->EOL("Prolog Length");
2431 EmitLabel("line_prolog_begin", 0);
2433 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2435 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2437 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
2439 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2441 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
2443 // Line number standard opcode encodings argument count
2444 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2445 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2446 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2447 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2448 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2449 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2450 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2451 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2452 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2454 // Emit directories.
2455 for (unsigned DirectoryID = 1, NDID = Directories.size();
2456 DirectoryID <= NDID; ++DirectoryID) {
2457 Asm->EmitString(Directories[DirectoryID]); Asm->EOL("Directory");
2459 Asm->EmitInt8(0); Asm->EOL("End of directories");
2462 for (unsigned SourceID = 1, NSID = SrcFiles.size();
2463 SourceID <= NSID; ++SourceID) {
2464 const SrcFileInfo &SourceFile = SrcFiles[SourceID];
2465 Asm->EmitString(SourceFile.getName());
2467 Asm->EmitULEB128Bytes(SourceFile.getDirectoryID());
2468 Asm->EOL("Directory #");
2469 Asm->EmitULEB128Bytes(0);
2470 Asm->EOL("Mod date");
2471 Asm->EmitULEB128Bytes(0);
2472 Asm->EOL("File size");
2474 Asm->EmitInt8(0); Asm->EOL("End of files");
2476 EmitLabel("line_prolog_end", 0);
2478 // A sequence for each text section.
2479 unsigned SecSrcLinesSize = SectionSourceLines.size();
2481 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
2482 // Isolate current sections line info.
2483 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
2486 const Section* S = SectionMap[j + 1];
2487 Asm->EOL(std::string("Section ") + S->getName());
2491 // Dwarf assumes we start with first line of first source file.
2492 unsigned Source = 1;
2495 // Construct rows of the address, source, line, column matrix.
2496 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2497 const SrcLineInfo &LineInfo = LineInfos[i];
2498 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2499 if (!LabelID) continue;
2501 unsigned SourceID = LineInfo.getSourceID();
2502 const SrcFileInfo &SourceFile = SrcFiles[SourceID];
2503 unsigned DirectoryID = SourceFile.getDirectoryID();
2505 Asm->EOL(Directories[DirectoryID]
2506 + SourceFile.getName()
2508 + utostr_32(LineInfo.getLine()));
2512 // Define the line address.
2513 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2514 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2515 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2516 EmitReference("label", LabelID); Asm->EOL("Location label");
2518 // If change of source, then switch to the new source.
2519 if (Source != LineInfo.getSourceID()) {
2520 Source = LineInfo.getSourceID();
2521 Asm->EmitInt8(DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2522 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2525 // If change of line.
2526 if (Line != LineInfo.getLine()) {
2527 // Determine offset.
2528 int Offset = LineInfo.getLine() - Line;
2529 int Delta = Offset - MinLineDelta;
2532 Line = LineInfo.getLine();
2534 // If delta is small enough and in range...
2535 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2536 // ... then use fast opcode.
2537 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2539 // ... otherwise use long hand.
2540 Asm->EmitInt8(DW_LNS_advance_line); Asm->EOL("DW_LNS_advance_line");
2541 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2542 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2545 // Copy the previous row (different address or source)
2546 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2550 EmitEndOfLineMatrix(j + 1);
2553 if (SecSrcLinesSize == 0)
2554 // Because we're emitting a debug_line section, we still need a line
2555 // table. The linker and friends expect it to exist. If there's nothing to
2556 // put into it, emit an empty table.
2557 EmitEndOfLineMatrix(1);
2559 EmitLabel("line_end", 0);
2564 /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
2566 void EmitCommonDebugFrame() {
2567 if (!TAI->doesDwarfRequireFrameSection())
2571 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2572 TargetFrameInfo::StackGrowsUp ?
2573 TD->getPointerSize() : -TD->getPointerSize();
2575 // Start the dwarf frame section.
2576 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2578 EmitLabel("debug_frame_common", 0);
2579 EmitDifference("debug_frame_common_end", 0,
2580 "debug_frame_common_begin", 0, true);
2581 Asm->EOL("Length of Common Information Entry");
2583 EmitLabel("debug_frame_common_begin", 0);
2584 Asm->EmitInt32((int)DW_CIE_ID);
2585 Asm->EOL("CIE Identifier Tag");
2586 Asm->EmitInt8(DW_CIE_VERSION);
2587 Asm->EOL("CIE Version");
2588 Asm->EmitString("");
2589 Asm->EOL("CIE Augmentation");
2590 Asm->EmitULEB128Bytes(1);
2591 Asm->EOL("CIE Code Alignment Factor");
2592 Asm->EmitSLEB128Bytes(stackGrowth);
2593 Asm->EOL("CIE Data Alignment Factor");
2594 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
2595 Asm->EOL("CIE RA Column");
2597 std::vector<MachineMove> Moves;
2598 RI->getInitialFrameState(Moves);
2600 EmitFrameMoves(NULL, 0, Moves, false);
2602 Asm->EmitAlignment(2, 0, 0, false);
2603 EmitLabel("debug_frame_common_end", 0);
2608 /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2610 void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
2611 if (!TAI->doesDwarfRequireFrameSection())
2614 // Start the dwarf frame section.
2615 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2617 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2618 "debug_frame_begin", DebugFrameInfo.Number, true);
2619 Asm->EOL("Length of Frame Information Entry");
2621 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2623 EmitSectionOffset("debug_frame_common", "section_debug_frame",
2625 Asm->EOL("FDE CIE offset");
2627 EmitReference("func_begin", DebugFrameInfo.Number);
2628 Asm->EOL("FDE initial location");
2629 EmitDifference("func_end", DebugFrameInfo.Number,
2630 "func_begin", DebugFrameInfo.Number);
2631 Asm->EOL("FDE address range");
2633 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves,
2636 Asm->EmitAlignment(2, 0, 0, false);
2637 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
2642 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
2644 void EmitDebugPubNames() {
2645 // Start the dwarf pubnames section.
2646 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2648 for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
2649 CE = DW_CUs.end(); CI != CE; ++CI) {
2650 CompileUnit *Unit = CI->second;
2654 EmitDifference("pubnames_end", Unit->getID(),
2655 "pubnames_begin", Unit->getID(), true);
2656 Asm->EOL("Length of Public Names Info");
2658 EmitLabel("pubnames_begin", Unit->getID());
2660 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF Version");
2662 EmitSectionOffset("info_begin", "section_info",
2663 Unit->getID(), 0, true, false);
2664 Asm->EOL("Offset of Compilation Unit Info");
2666 EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(),
2668 Asm->EOL("Compilation Unit Length");
2670 std::map<std::string, DIE *> &Globals = Unit->getGlobals();
2672 for (std::map<std::string, DIE *>::iterator GI = Globals.begin(),
2675 const std::string &Name = GI->first;
2676 DIE * Entity = GI->second;
2678 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2679 Asm->EmitString(Name); Asm->EOL("External Name");
2682 Asm->EmitInt32(0); Asm->EOL("End Mark");
2683 EmitLabel("pubnames_end", Unit->getID());
2691 /// EmitDebugStr - Emit visible names into a debug str section.
2693 void EmitDebugStr() {
2694 // Check to see if it is worth the effort.
2695 if (!StringPool.empty()) {
2696 // Start the dwarf str section.
2697 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2699 // For each of strings in the string pool.
2700 for (unsigned StringID = 1, N = StringPool.size();
2701 StringID <= N; ++StringID) {
2702 // Emit a label for reference from debug information entries.
2703 EmitLabel("string", StringID);
2704 // Emit the string itself.
2705 const std::string &String = StringPool[StringID];
2706 Asm->EmitString(String); Asm->EOL();
2713 /// EmitDebugLoc - Emit visible names into a debug loc section.
2715 void EmitDebugLoc() {
2716 // Start the dwarf loc section.
2717 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2722 /// EmitDebugARanges - Emit visible names into a debug aranges section.
2724 void EmitDebugARanges() {
2725 // Start the dwarf aranges section.
2726 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2730 CompileUnit *Unit = GetBaseCompileUnit();
2732 // Don't include size of length
2733 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
2735 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("Dwarf Version");
2737 EmitReference("info_begin", Unit->getID());
2738 Asm->EOL("Offset of Compilation Unit Info");
2740 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
2742 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
2744 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
2745 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
2748 EmitReference("text_begin", 0); Asm->EOL("Address");
2749 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
2751 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2752 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
2758 /// EmitDebugRanges - Emit visible names into a debug ranges section.
2760 void EmitDebugRanges() {
2761 // Start the dwarf ranges section.
2762 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2767 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
2769 void EmitDebugMacInfo() {
2770 if (TAI->doesSupportMacInfoSection()) {
2771 // Start the dwarf macinfo section.
2772 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2778 /// ConstructCompileUnits - Create a compile unit DIEs.
2779 void ConstructCompileUnits() {
2780 std::string CUName = "llvm.dbg.compile_units";
2781 std::vector<GlobalVariable*> Result;
2782 getGlobalVariablesUsing(*M, CUName, Result);
2783 for (std::vector<GlobalVariable *>::iterator RI = Result.begin(),
2784 RE = Result.end(); RI != RE; ++RI) {
2785 DICompileUnit DIUnit(*RI);
2786 unsigned ID = RecordSource(DIUnit.getDirectory(),
2787 DIUnit.getFilename());
2789 DIE *Die = new DIE(DW_TAG_compile_unit);
2790 AddSectionOffset(Die, DW_AT_stmt_list, DW_FORM_data4,
2791 DWLabel("section_line", 0), DWLabel("section_line", 0),
2793 AddString(Die, DW_AT_producer, DW_FORM_string, DIUnit.getProducer());
2794 AddUInt(Die, DW_AT_language, DW_FORM_data1, DIUnit.getLanguage());
2795 AddString(Die, DW_AT_name, DW_FORM_string, DIUnit.getFilename());
2796 if (!DIUnit.getDirectory().empty())
2797 AddString(Die, DW_AT_comp_dir, DW_FORM_string, DIUnit.getDirectory());
2798 if (DIUnit.isOptimized())
2799 AddUInt(Die, DW_AT_APPLE_optimized, DW_FORM_flag, 1);
2800 const std::string &Flags = DIUnit.getFlags();
2802 AddString(Die, DW_AT_APPLE_flags, DW_FORM_string, Flags);
2804 CompileUnit *Unit = new CompileUnit(ID, Die);
2805 if (DIUnit.isMain()) {
2806 assert(!MainCU && "Multiple main compile units are found!");
2809 DW_CUs[DIUnit.getGV()] = Unit;
2813 /// ConstructGlobalVariableDIEs - Create DIEs for each of the externally
2814 /// visible global variables.
2815 void ConstructGlobalVariableDIEs() {
2816 std::string GVName = "llvm.dbg.global_variables";
2817 std::vector<GlobalVariable*> Result;
2818 getGlobalVariablesUsing(*M, GVName, Result);
2819 for (std::vector<GlobalVariable *>::iterator GVI = Result.begin(),
2820 GVE = Result.end(); GVI != GVE; ++GVI) {
2821 DIGlobalVariable DI_GV(*GVI);
2822 CompileUnit *DW_Unit = MainCU;
2824 DW_Unit = FindCompileUnit(DI_GV.getCompileUnit());
2826 // Check for pre-existence.
2827 DIE *&Slot = DW_Unit->getDieMapSlotFor(DI_GV.getGV());
2830 DIE *VariableDie = CreateGlobalVariableDIE(DW_Unit, DI_GV);
2833 DIEBlock *Block = new DIEBlock();
2834 AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
2835 AddObjectLabel(Block, 0, DW_FORM_udata,
2836 Asm->getGlobalLinkName(DI_GV.getGlobal()));
2837 AddBlock(VariableDie, DW_AT_location, 0, Block);
2842 //Add to context owner.
2843 DW_Unit->getDie()->AddChild(VariableDie);
2845 //Expose as global. FIXME - need to check external flag.
2846 DW_Unit->AddGlobal(DI_GV.getName(), VariableDie);
2850 /// ConstructSubprograms - Create DIEs for each of the externally visible
2852 void ConstructSubprograms() {
2854 std::string SPName = "llvm.dbg.subprograms";
2855 std::vector<GlobalVariable*> Result;
2856 getGlobalVariablesUsing(*M, SPName, Result);
2857 for (std::vector<GlobalVariable *>::iterator RI = Result.begin(),
2858 RE = Result.end(); RI != RE; ++RI) {
2860 DISubprogram SP(*RI);
2861 CompileUnit *Unit = MainCU;
2863 Unit = FindCompileUnit(SP.getCompileUnit());
2865 // Check for pre-existence.
2866 DIE *&Slot = Unit->getDieMapSlotFor(SP.getGV());
2869 if (!SP.isDefinition())
2870 // This is a method declaration which will be handled while
2871 // constructing class type.
2874 DIE *SubprogramDie = CreateSubprogramDIE(Unit, SP);
2877 Slot = SubprogramDie;
2878 //Add to context owner.
2879 Unit->getDie()->AddChild(SubprogramDie);
2881 Unit->AddGlobal(SP.getName(), SubprogramDie);
2886 //===--------------------------------------------------------------------===//
2887 // Main entry points.
2889 DwarfDebug(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
2890 : Dwarf(OS, A, T, "dbg")
2892 , AbbreviationsSet(InitAbbreviationsSetSize)
2894 , ValuesSet(InitValuesSetSize)
2898 , SectionSourceLines()
2901 , RootDbgScope(NULL)
2904 virtual ~DwarfDebug() {
2905 for (unsigned j = 0, M = Values.size(); j < M; ++j)
2909 /// SetDebugInfo - Create global DIEs and emit initial debug info sections.
2910 /// This is inovked by the target AsmPrinter.
2911 void SetDebugInfo(MachineModuleInfo *mmi) {
2912 // Create all the compile unit DIEs.
2913 ConstructCompileUnits();
2920 MMI->setDebugInfoAvailability(true);
2922 // Create DIEs for each of the externally visible global variables.
2923 ConstructGlobalVariableDIEs();
2925 // Create DIEs for each of the externally visible subprograms.
2926 ConstructSubprograms();
2928 // Prime section data.
2929 SectionMap.insert(TAI->getTextSection());
2931 // Print out .file directives to specify files for .loc directives. These
2932 // are printed out early so that they precede any .loc directives.
2933 if (TAI->hasDotLocAndDotFile()) {
2934 for (unsigned i = 1, e = SrcFiles.size(); i <= e; ++i) {
2935 sys::Path FullPath(Directories[SrcFiles[i].getDirectoryID()]);
2936 bool AppendOk = FullPath.appendComponent(SrcFiles[i].getName());
2937 assert(AppendOk && "Could not append filename to directory!");
2939 Asm->EmitFile(i, FullPath.toString());
2944 // Emit initial sections
2948 /// BeginModule - Emit all Dwarf sections that should come prior to the
2950 void BeginModule(Module *M) {
2954 /// EndModule - Emit all Dwarf sections that should come after the content.
2957 if (!ShouldEmitDwarf()) return;
2959 // Standard sections final addresses.
2960 Asm->SwitchToSection(TAI->getTextSection());
2961 EmitLabel("text_end", 0);
2962 Asm->SwitchToSection(TAI->getDataSection());
2963 EmitLabel("data_end", 0);
2965 // End text sections.
2966 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
2967 Asm->SwitchToSection(SectionMap[i]);
2968 EmitLabel("section_end", i);
2971 // Emit common frame information.
2972 EmitCommonDebugFrame();
2974 // Emit function debug frame information
2975 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2976 E = DebugFrames.end(); I != E; ++I)
2977 EmitFunctionDebugFrame(*I);
2979 // Compute DIE offsets and sizes.
2982 // Emit all the DIEs into a debug info section
2985 // Corresponding abbreviations into a abbrev section.
2986 EmitAbbreviations();
2988 // Emit source line correspondence into a debug line section.
2991 // Emit info into a debug pubnames section.
2992 EmitDebugPubNames();
2994 // Emit info into a debug str section.
2997 // Emit info into a debug loc section.
3000 // Emit info into a debug aranges section.
3003 // Emit info into a debug ranges section.
3006 // Emit info into a debug macinfo section.
3010 /// BeginFunction - Gather pre-function debug information. Assumes being
3011 /// emitted immediately after the function entry point.
3012 void BeginFunction(MachineFunction *MF) {
3015 if (!ShouldEmitDwarf()) return;
3017 // Begin accumulating function debug information.
3018 MMI->BeginFunction(MF);
3020 // Assumes in correct section after the entry point.
3021 EmitLabel("func_begin", ++SubprogramCount);
3023 // Emit label for the implicitly defined dbg.stoppoint at the start of
3025 if (!Lines.empty()) {
3026 const SrcLineInfo &LineInfo = Lines[0];
3027 Asm->printLabel(LineInfo.getLabelID());
3031 /// EndFunction - Gather and emit post-function debug information.
3033 void EndFunction(MachineFunction *MF) {
3034 if (!ShouldEmitDwarf()) return;
3036 // Define end label for subprogram.
3037 EmitLabel("func_end", SubprogramCount);
3039 // Get function line info.
3040 if (!Lines.empty()) {
3041 // Get section line info.
3042 unsigned ID = SectionMap.insert(Asm->CurrentSection_);
3043 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
3044 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
3045 // Append the function info to section info.
3046 SectionLineInfos.insert(SectionLineInfos.end(),
3047 Lines.begin(), Lines.end());
3050 // Construct scopes for subprogram.
3052 ConstructRootDbgScope(RootDbgScope);
3054 // FIXME: This is wrong. We are essentially getting past a problem with
3055 // debug information not being able to handle unreachable blocks that have
3056 // debug information in them. In particular, those unreachable blocks that
3057 // have "region end" info in them. That situation results in the "root
3058 // scope" not being created. If that's the case, then emit a "default"
3059 // scope, i.e., one that encompasses the whole function. This isn't
3060 // desirable. And a better way of handling this (and all of the debugging
3061 // information) needs to be explored.
3062 ConstructDefaultDbgScope(MF);
3064 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
3065 MMI->getFrameMoves()));
3069 delete RootDbgScope;
3070 DbgScopeMap.clear();
3071 RootDbgScope = NULL;
3078 /// ValidDebugInfo - Return true if V represents valid debug info value.
3079 bool ValidDebugInfo(Value *V) {
3087 GlobalVariable *GV = getGlobalVariable(V);
3091 if (GV->getLinkage() != GlobalValue::InternalLinkage
3092 && GV->getLinkage() != GlobalValue::LinkOnceLinkage)
3095 DIDescriptor DI(GV);
3096 // Check current version. Allow Version6 for now.
3097 unsigned Version = DI.getVersion();
3098 if (Version != LLVMDebugVersion && Version != LLVMDebugVersion6)
3101 unsigned Tag = DI.getTag();
3103 case DW_TAG_variable:
3104 assert(DIVariable(GV).Verify() && "Invalid DebugInfo value");
3106 case DW_TAG_compile_unit:
3107 assert(DICompileUnit(GV).Verify() && "Invalid DebugInfo value");
3109 case DW_TAG_subprogram:
3110 assert(DISubprogram(GV).Verify() && "Invalid DebugInfo value");
3119 /// RecordSourceLine - Records location information and associates it with a
3120 /// label. Returns a unique label ID used to generate a label and provide
3121 /// correspondence to the source line list.
3122 unsigned RecordSourceLine(Value *V, unsigned Line, unsigned Col) {
3123 CompileUnit *Unit = DW_CUs[V];
3124 assert(Unit && "Unable to find CompileUnit");
3125 unsigned ID = MMI->NextLabelID();
3126 Lines.push_back(SrcLineInfo(Line, Col, Unit->getID(), ID));
3130 /// RecordSourceLine - Records location information and associates it with a
3131 /// label. Returns a unique label ID used to generate a label and provide
3132 /// correspondence to the source line list.
3133 unsigned RecordSourceLine(unsigned Line, unsigned Col, unsigned Src) {
3134 unsigned ID = MMI->NextLabelID();
3135 Lines.push_back(SrcLineInfo(Line, Col, Src, ID));
3139 unsigned getRecordSourceLineCount() {
3140 return Lines.size();
3143 /// RecordSource - Register a source file with debug info. Returns an source
3145 unsigned RecordSource(const std::string &Directory,
3146 const std::string &File) {
3147 unsigned DID = Directories.insert(Directory);
3148 return SrcFiles.insert(SrcFileInfo(DID,File));
3151 /// RecordRegionStart - Indicate the start of a region.
3153 unsigned RecordRegionStart(GlobalVariable *V) {
3154 DbgScope *Scope = getOrCreateScope(V);
3155 unsigned ID = MMI->NextLabelID();
3156 if (!Scope->getStartLabelID()) Scope->setStartLabelID(ID);
3160 /// RecordRegionEnd - Indicate the end of a region.
3162 unsigned RecordRegionEnd(GlobalVariable *V) {
3163 DbgScope *Scope = getOrCreateScope(V);
3164 unsigned ID = MMI->NextLabelID();
3165 Scope->setEndLabelID(ID);
3169 /// RecordVariable - Indicate the declaration of a local variable.
3171 void RecordVariable(GlobalVariable *GV, unsigned FrameIndex) {
3172 DIDescriptor Desc(GV);
3173 DbgScope *Scope = NULL;
3174 if (Desc.getTag() == DW_TAG_variable) {
3175 // GV is a global variable.
3176 DIGlobalVariable DG(GV);
3177 Scope = getOrCreateScope(DG.getContext().getGV());
3179 // or GV is a local variable.
3181 Scope = getOrCreateScope(DV.getContext().getGV());
3183 assert(Scope && "Unable to find variable' scope");
3184 DbgVariable *DV = new DbgVariable(DIVariable(GV), FrameIndex);
3185 Scope->AddVariable(DV);
3189 //===----------------------------------------------------------------------===//
3190 /// DwarfException - Emits Dwarf exception handling directives.
3192 class DwarfException : public Dwarf {
3193 struct FunctionEHFrameInfo {
3196 unsigned PersonalityIndex;
3198 bool hasLandingPads;
3199 std::vector<MachineMove> Moves;
3200 const Function * function;
3202 FunctionEHFrameInfo(const std::string &FN, unsigned Num, unsigned P,
3204 const std::vector<MachineMove> &M,
3206 FnName(FN), Number(Num), PersonalityIndex(P),
3207 hasCalls(hC), hasLandingPads(hL), Moves(M), function (f) { }
3210 std::vector<FunctionEHFrameInfo> EHFrames;
3212 /// shouldEmitTable - Per-function flag to indicate if EH tables should
3214 bool shouldEmitTable;
3216 /// shouldEmitMoves - Per-function flag to indicate if frame moves info
3217 /// should be emitted.
3218 bool shouldEmitMoves;
3220 /// shouldEmitTableModule - Per-module flag to indicate if EH tables
3221 /// should be emitted.
3222 bool shouldEmitTableModule;
3224 /// shouldEmitFrameModule - Per-module flag to indicate if frame moves
3225 /// should be emitted.
3226 bool shouldEmitMovesModule;
3228 /// EmitCommonEHFrame - Emit the common eh unwind frame.
3230 void EmitCommonEHFrame(const Function *Personality, unsigned Index) {
3231 // Size and sign of stack growth.
3233 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3234 TargetFrameInfo::StackGrowsUp ?
3235 TD->getPointerSize() : -TD->getPointerSize();
3237 // Begin eh frame section.
3238 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3240 if (!TAI->doesRequireNonLocalEHFrameLabel())
3241 O << TAI->getEHGlobalPrefix();
3242 O << "EH_frame" << Index << ":\n";
3243 EmitLabel("section_eh_frame", Index);
3245 // Define base labels.
3246 EmitLabel("eh_frame_common", Index);
3248 // Define the eh frame length.
3249 EmitDifference("eh_frame_common_end", Index,
3250 "eh_frame_common_begin", Index, true);
3251 Asm->EOL("Length of Common Information Entry");
3254 EmitLabel("eh_frame_common_begin", Index);
3255 Asm->EmitInt32((int)0);
3256 Asm->EOL("CIE Identifier Tag");
3257 Asm->EmitInt8(DW_CIE_VERSION);
3258 Asm->EOL("CIE Version");
3260 // The personality presence indicates that language specific information
3261 // will show up in the eh frame.
3262 Asm->EmitString(Personality ? "zPLR" : "zR");
3263 Asm->EOL("CIE Augmentation");
3265 // Round out reader.
3266 Asm->EmitULEB128Bytes(1);
3267 Asm->EOL("CIE Code Alignment Factor");
3268 Asm->EmitSLEB128Bytes(stackGrowth);
3269 Asm->EOL("CIE Data Alignment Factor");
3270 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), true));
3271 Asm->EOL("CIE Return Address Column");
3273 // If there is a personality, we need to indicate the functions location.
3275 Asm->EmitULEB128Bytes(7);
3276 Asm->EOL("Augmentation Size");
3278 if (TAI->getNeedsIndirectEncoding()) {
3279 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4 | DW_EH_PE_indirect);
3280 Asm->EOL("Personality (pcrel sdata4 indirect)");
3282 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3283 Asm->EOL("Personality (pcrel sdata4)");
3286 PrintRelDirective(true);
3287 O << TAI->getPersonalityPrefix();
3288 Asm->EmitExternalGlobal((const GlobalVariable *)(Personality));
3289 O << TAI->getPersonalitySuffix();
3290 if (strcmp(TAI->getPersonalitySuffix(), "+4@GOTPCREL"))
3291 O << "-" << TAI->getPCSymbol();
3292 Asm->EOL("Personality");
3294 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3295 Asm->EOL("LSDA Encoding (pcrel sdata4)");
3297 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3298 Asm->EOL("FDE Encoding (pcrel sdata4)");
3300 Asm->EmitULEB128Bytes(1);
3301 Asm->EOL("Augmentation Size");
3303 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3304 Asm->EOL("FDE Encoding (pcrel sdata4)");
3307 // Indicate locations of general callee saved registers in frame.
3308 std::vector<MachineMove> Moves;
3309 RI->getInitialFrameState(Moves);
3310 EmitFrameMoves(NULL, 0, Moves, true);
3312 // On Darwin the linker honors the alignment of eh_frame, which means it
3313 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3314 // you get holes which confuse readers of eh_frame.
3315 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
3317 EmitLabel("eh_frame_common_end", Index);
3322 /// EmitEHFrame - Emit function exception frame information.
3324 void EmitEHFrame(const FunctionEHFrameInfo &EHFrameInfo) {
3325 Function::LinkageTypes linkage = EHFrameInfo.function->getLinkage();
3327 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3329 // Externally visible entry into the functions eh frame info.
3330 // If the corresponding function is static, this should not be
3331 // externally visible.
3332 if (linkage != Function::InternalLinkage &&
3333 linkage != Function::PrivateLinkage) {
3334 if (const char *GlobalEHDirective = TAI->getGlobalEHDirective())
3335 O << GlobalEHDirective << EHFrameInfo.FnName << "\n";
3338 // If corresponding function is weak definition, this should be too.
3339 if ((linkage == Function::WeakLinkage ||
3340 linkage == Function::LinkOnceLinkage) &&
3341 TAI->getWeakDefDirective())
3342 O << TAI->getWeakDefDirective() << EHFrameInfo.FnName << "\n";
3344 // If there are no calls then you can't unwind. This may mean we can
3345 // omit the EH Frame, but some environments do not handle weak absolute
3347 // If UnwindTablesMandatory is set we cannot do this optimization; the
3348 // unwind info is to be available for non-EH uses.
3349 if (!EHFrameInfo.hasCalls &&
3350 !UnwindTablesMandatory &&
3351 ((linkage != Function::WeakLinkage &&
3352 linkage != Function::LinkOnceLinkage) ||
3353 !TAI->getWeakDefDirective() ||
3354 TAI->getSupportsWeakOmittedEHFrame()))
3356 O << EHFrameInfo.FnName << " = 0\n";
3357 // This name has no connection to the function, so it might get
3358 // dead-stripped when the function is not, erroneously. Prohibit
3359 // dead-stripping unconditionally.
3360 if (const char *UsedDirective = TAI->getUsedDirective())
3361 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3363 O << EHFrameInfo.FnName << ":\n";
3366 EmitDifference("eh_frame_end", EHFrameInfo.Number,
3367 "eh_frame_begin", EHFrameInfo.Number, true);
3368 Asm->EOL("Length of Frame Information Entry");
3370 EmitLabel("eh_frame_begin", EHFrameInfo.Number);
3372 if (TAI->doesRequireNonLocalEHFrameLabel()) {
3373 PrintRelDirective(true, true);
3374 PrintLabelName("eh_frame_begin", EHFrameInfo.Number);
3376 if (!TAI->isAbsoluteEHSectionOffsets())
3377 O << "-EH_frame" << EHFrameInfo.PersonalityIndex;
3379 EmitSectionOffset("eh_frame_begin", "eh_frame_common",
3380 EHFrameInfo.Number, EHFrameInfo.PersonalityIndex,
3384 Asm->EOL("FDE CIE offset");
3386 EmitReference("eh_func_begin", EHFrameInfo.Number, true, true);
3387 Asm->EOL("FDE initial location");
3388 EmitDifference("eh_func_end", EHFrameInfo.Number,
3389 "eh_func_begin", EHFrameInfo.Number, true);
3390 Asm->EOL("FDE address range");
3392 // If there is a personality and landing pads then point to the language
3393 // specific data area in the exception table.
3394 if (EHFrameInfo.PersonalityIndex) {
3395 Asm->EmitULEB128Bytes(4);
3396 Asm->EOL("Augmentation size");
3398 if (EHFrameInfo.hasLandingPads)
3399 EmitReference("exception", EHFrameInfo.Number, true, true);
3401 Asm->EmitInt32((int)0);
3402 Asm->EOL("Language Specific Data Area");
3404 Asm->EmitULEB128Bytes(0);
3405 Asm->EOL("Augmentation size");
3408 // Indicate locations of function specific callee saved registers in
3410 EmitFrameMoves("eh_func_begin", EHFrameInfo.Number, EHFrameInfo.Moves,
3413 // On Darwin the linker honors the alignment of eh_frame, which means it
3414 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3415 // you get holes which confuse readers of eh_frame.
3416 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
3418 EmitLabel("eh_frame_end", EHFrameInfo.Number);
3420 // If the function is marked used, this table should be also. We cannot
3421 // make the mark unconditional in this case, since retaining the table
3422 // also retains the function in this case, and there is code around
3423 // that depends on unused functions (calling undefined externals) being
3424 // dead-stripped to link correctly. Yes, there really is.
3425 if (MMI->getUsedFunctions().count(EHFrameInfo.function))
3426 if (const char *UsedDirective = TAI->getUsedDirective())
3427 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3431 /// EmitExceptionTable - Emit landing pads and actions.
3433 /// The general organization of the table is complex, but the basic concepts
3434 /// are easy. First there is a header which describes the location and
3435 /// organization of the three components that follow.
3436 /// 1. The landing pad site information describes the range of code covered
3437 /// by the try. In our case it's an accumulation of the ranges covered
3438 /// by the invokes in the try. There is also a reference to the landing
3439 /// pad that handles the exception once processed. Finally an index into
3440 /// the actions table.
3441 /// 2. The action table, in our case, is composed of pairs of type ids
3442 /// and next action offset. Starting with the action index from the
3443 /// landing pad site, each type Id is checked for a match to the current
3444 /// exception. If it matches then the exception and type id are passed
3445 /// on to the landing pad. Otherwise the next action is looked up. This
3446 /// chain is terminated with a next action of zero. If no type id is
3447 /// found the the frame is unwound and handling continues.
3448 /// 3. Type id table contains references to all the C++ typeinfo for all
3449 /// catches in the function. This tables is reversed indexed base 1.
3451 /// SharedTypeIds - How many leading type ids two landing pads have in common.
3452 static unsigned SharedTypeIds(const LandingPadInfo *L,
3453 const LandingPadInfo *R) {
3454 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3455 unsigned LSize = LIds.size(), RSize = RIds.size();
3456 unsigned MinSize = LSize < RSize ? LSize : RSize;
3459 for (; Count != MinSize; ++Count)
3460 if (LIds[Count] != RIds[Count])
3466 /// PadLT - Order landing pads lexicographically by type id.
3467 static bool PadLT(const LandingPadInfo *L, const LandingPadInfo *R) {
3468 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3469 unsigned LSize = LIds.size(), RSize = RIds.size();
3470 unsigned MinSize = LSize < RSize ? LSize : RSize;
3472 for (unsigned i = 0; i != MinSize; ++i)
3473 if (LIds[i] != RIds[i])
3474 return LIds[i] < RIds[i];
3476 return LSize < RSize;
3480 static inline unsigned getEmptyKey() { return -1U; }
3481 static inline unsigned getTombstoneKey() { return -2U; }
3482 static unsigned getHashValue(const unsigned &Key) { return Key; }
3483 static bool isEqual(unsigned LHS, unsigned RHS) { return LHS == RHS; }
3484 static bool isPod() { return true; }
3487 /// ActionEntry - Structure describing an entry in the actions table.
3488 struct ActionEntry {
3489 int ValueForTypeID; // The value to write - may not be equal to the type id.
3491 struct ActionEntry *Previous;
3494 /// PadRange - Structure holding a try-range and the associated landing pad.
3496 // The index of the landing pad.
3498 // The index of the begin and end labels in the landing pad's label lists.
3499 unsigned RangeIndex;
3502 typedef DenseMap<unsigned, PadRange, KeyInfo> RangeMapType;
3504 /// CallSiteEntry - Structure describing an entry in the call-site table.
3505 struct CallSiteEntry {
3506 // The 'try-range' is BeginLabel .. EndLabel.
3507 unsigned BeginLabel; // zero indicates the start of the function.
3508 unsigned EndLabel; // zero indicates the end of the function.
3509 // The landing pad starts at PadLabel.
3510 unsigned PadLabel; // zero indicates that there is no landing pad.
3514 void EmitExceptionTable() {
3515 const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
3516 const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
3517 const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
3518 if (PadInfos.empty()) return;
3520 // Sort the landing pads in order of their type ids. This is used to fold
3521 // duplicate actions.
3522 SmallVector<const LandingPadInfo *, 64> LandingPads;
3523 LandingPads.reserve(PadInfos.size());
3524 for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
3525 LandingPads.push_back(&PadInfos[i]);
3526 std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
3528 // Negative type ids index into FilterIds, positive type ids index into
3529 // TypeInfos. The value written for a positive type id is just the type
3530 // id itself. For a negative type id, however, the value written is the
3531 // (negative) byte offset of the corresponding FilterIds entry. The byte
3532 // offset is usually equal to the type id, because the FilterIds entries
3533 // are written using a variable width encoding which outputs one byte per
3534 // entry as long as the value written is not too large, but can differ.
3535 // This kind of complication does not occur for positive type ids because
3536 // type infos are output using a fixed width encoding.
3537 // FilterOffsets[i] holds the byte offset corresponding to FilterIds[i].
3538 SmallVector<int, 16> FilterOffsets;
3539 FilterOffsets.reserve(FilterIds.size());
3541 for(std::vector<unsigned>::const_iterator I = FilterIds.begin(),
3542 E = FilterIds.end(); I != E; ++I) {
3543 FilterOffsets.push_back(Offset);
3544 Offset -= TargetAsmInfo::getULEB128Size(*I);
3547 // Compute the actions table and gather the first action index for each
3548 // landing pad site.
3549 SmallVector<ActionEntry, 32> Actions;
3550 SmallVector<unsigned, 64> FirstActions;
3551 FirstActions.reserve(LandingPads.size());
3553 int FirstAction = 0;
3554 unsigned SizeActions = 0;
3555 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3556 const LandingPadInfo *LP = LandingPads[i];
3557 const std::vector<int> &TypeIds = LP->TypeIds;
3558 const unsigned NumShared = i ? SharedTypeIds(LP, LandingPads[i-1]) : 0;
3559 unsigned SizeSiteActions = 0;
3561 if (NumShared < TypeIds.size()) {
3562 unsigned SizeAction = 0;
3563 ActionEntry *PrevAction = 0;
3566 const unsigned SizePrevIds = LandingPads[i-1]->TypeIds.size();
3567 assert(Actions.size());
3568 PrevAction = &Actions.back();
3569 SizeAction = TargetAsmInfo::getSLEB128Size(PrevAction->NextAction) +
3570 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
3571 for (unsigned j = NumShared; j != SizePrevIds; ++j) {
3573 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
3574 SizeAction += -PrevAction->NextAction;
3575 PrevAction = PrevAction->Previous;
3579 // Compute the actions.
3580 for (unsigned I = NumShared, M = TypeIds.size(); I != M; ++I) {
3581 int TypeID = TypeIds[I];
3582 assert(-1-TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
3583 int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
3584 unsigned SizeTypeID = TargetAsmInfo::getSLEB128Size(ValueForTypeID);
3586 int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
3587 SizeAction = SizeTypeID + TargetAsmInfo::getSLEB128Size(NextAction);
3588 SizeSiteActions += SizeAction;
3590 ActionEntry Action = {ValueForTypeID, NextAction, PrevAction};
3591 Actions.push_back(Action);
3593 PrevAction = &Actions.back();
3596 // Record the first action of the landing pad site.
3597 FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
3598 } // else identical - re-use previous FirstAction
3600 FirstActions.push_back(FirstAction);
3602 // Compute this sites contribution to size.
3603 SizeActions += SizeSiteActions;
3606 // Compute the call-site table. The entry for an invoke has a try-range
3607 // containing the call, a non-zero landing pad and an appropriate action.
3608 // The entry for an ordinary call has a try-range containing the call and
3609 // zero for the landing pad and the action. Calls marked 'nounwind' have
3610 // no entry and must not be contained in the try-range of any entry - they
3611 // form gaps in the table. Entries must be ordered by try-range address.
3612 SmallVector<CallSiteEntry, 64> CallSites;
3614 RangeMapType PadMap;
3615 // Invokes and nounwind calls have entries in PadMap (due to being bracketed
3616 // by try-range labels when lowered). Ordinary calls do not, so appropriate
3617 // try-ranges for them need be deduced.
3618 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3619 const LandingPadInfo *LandingPad = LandingPads[i];
3620 for (unsigned j = 0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
3621 unsigned BeginLabel = LandingPad->BeginLabels[j];
3622 assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
3623 PadRange P = { i, j };
3624 PadMap[BeginLabel] = P;
3628 // The end label of the previous invoke or nounwind try-range.
3629 unsigned LastLabel = 0;
3631 // Whether there is a potentially throwing instruction (currently this means
3632 // an ordinary call) between the end of the previous try-range and now.
3633 bool SawPotentiallyThrowing = false;
3635 // Whether the last callsite entry was for an invoke.
3636 bool PreviousIsInvoke = false;
3638 // Visit all instructions in order of address.
3639 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
3641 for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
3643 if (!MI->isLabel()) {
3644 SawPotentiallyThrowing |= MI->getDesc().isCall();
3648 unsigned BeginLabel = MI->getOperand(0).getImm();
3649 assert(BeginLabel && "Invalid label!");
3651 // End of the previous try-range?
3652 if (BeginLabel == LastLabel)
3653 SawPotentiallyThrowing = false;
3655 // Beginning of a new try-range?
3656 RangeMapType::iterator L = PadMap.find(BeginLabel);
3657 if (L == PadMap.end())
3658 // Nope, it was just some random label.
3661 PadRange P = L->second;
3662 const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
3664 assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
3665 "Inconsistent landing pad map!");
3667 // If some instruction between the previous try-range and this one may
3668 // throw, create a call-site entry with no landing pad for the region
3669 // between the try-ranges.
3670 if (SawPotentiallyThrowing) {
3671 CallSiteEntry Site = {LastLabel, BeginLabel, 0, 0};
3672 CallSites.push_back(Site);
3673 PreviousIsInvoke = false;
3676 LastLabel = LandingPad->EndLabels[P.RangeIndex];
3677 assert(BeginLabel && LastLabel && "Invalid landing pad!");
3679 if (LandingPad->LandingPadLabel) {
3680 // This try-range is for an invoke.
3681 CallSiteEntry Site = {BeginLabel, LastLabel,
3682 LandingPad->LandingPadLabel, FirstActions[P.PadIndex]};
3684 // Try to merge with the previous call-site.
3685 if (PreviousIsInvoke) {
3686 CallSiteEntry &Prev = CallSites.back();
3687 if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
3688 // Extend the range of the previous entry.
3689 Prev.EndLabel = Site.EndLabel;
3694 // Otherwise, create a new call-site.
3695 CallSites.push_back(Site);
3696 PreviousIsInvoke = true;
3699 PreviousIsInvoke = false;
3703 // If some instruction between the previous try-range and the end of the
3704 // function may throw, create a call-site entry with no landing pad for the
3705 // region following the try-range.
3706 if (SawPotentiallyThrowing) {
3707 CallSiteEntry Site = {LastLabel, 0, 0, 0};
3708 CallSites.push_back(Site);
3714 const unsigned SiteStartSize = sizeof(int32_t); // DW_EH_PE_udata4
3715 const unsigned SiteLengthSize = sizeof(int32_t); // DW_EH_PE_udata4
3716 const unsigned LandingPadSize = sizeof(int32_t); // DW_EH_PE_udata4
3717 unsigned SizeSites = CallSites.size() * (SiteStartSize +
3720 for (unsigned i = 0, e = CallSites.size(); i < e; ++i)
3721 SizeSites += TargetAsmInfo::getULEB128Size(CallSites[i].Action);
3724 const unsigned TypeInfoSize = TD->getPointerSize(); // DW_EH_PE_absptr
3725 unsigned SizeTypes = TypeInfos.size() * TypeInfoSize;
3727 unsigned TypeOffset = sizeof(int8_t) + // Call site format
3728 TargetAsmInfo::getULEB128Size(SizeSites) + // Call-site table length
3729 SizeSites + SizeActions + SizeTypes;
3731 unsigned TotalSize = sizeof(int8_t) + // LPStart format
3732 sizeof(int8_t) + // TType format
3733 TargetAsmInfo::getULEB128Size(TypeOffset) + // TType base offset
3736 unsigned SizeAlign = (4 - TotalSize) & 3;
3738 // Begin the exception table.
3739 Asm->SwitchToDataSection(TAI->getDwarfExceptionSection());
3740 Asm->EmitAlignment(2, 0, 0, false);
3741 O << "GCC_except_table" << SubprogramCount << ":\n";
3742 for (unsigned i = 0; i != SizeAlign; ++i) {
3744 Asm->EOL("Padding");
3746 EmitLabel("exception", SubprogramCount);
3749 Asm->EmitInt8(DW_EH_PE_omit);
3750 Asm->EOL("LPStart format (DW_EH_PE_omit)");
3751 Asm->EmitInt8(DW_EH_PE_absptr);
3752 Asm->EOL("TType format (DW_EH_PE_absptr)");
3753 Asm->EmitULEB128Bytes(TypeOffset);
3754 Asm->EOL("TType base offset");
3755 Asm->EmitInt8(DW_EH_PE_udata4);
3756 Asm->EOL("Call site format (DW_EH_PE_udata4)");
3757 Asm->EmitULEB128Bytes(SizeSites);
3758 Asm->EOL("Call-site table length");
3760 // Emit the landing pad site information.
3761 for (unsigned i = 0; i < CallSites.size(); ++i) {
3762 CallSiteEntry &S = CallSites[i];
3763 const char *BeginTag;
3764 unsigned BeginNumber;
3766 if (!S.BeginLabel) {
3767 BeginTag = "eh_func_begin";
3768 BeginNumber = SubprogramCount;
3771 BeginNumber = S.BeginLabel;
3774 EmitSectionOffset(BeginTag, "eh_func_begin", BeginNumber, SubprogramCount,
3776 Asm->EOL("Region start");
3779 EmitDifference("eh_func_end", SubprogramCount, BeginTag, BeginNumber,
3782 EmitDifference("label", S.EndLabel, BeginTag, BeginNumber, true);
3784 Asm->EOL("Region length");
3789 EmitSectionOffset("label", "eh_func_begin", S.PadLabel, SubprogramCount,
3791 Asm->EOL("Landing pad");
3793 Asm->EmitULEB128Bytes(S.Action);
3797 // Emit the actions.
3798 for (unsigned I = 0, N = Actions.size(); I != N; ++I) {
3799 ActionEntry &Action = Actions[I];
3801 Asm->EmitSLEB128Bytes(Action.ValueForTypeID);
3802 Asm->EOL("TypeInfo index");
3803 Asm->EmitSLEB128Bytes(Action.NextAction);
3804 Asm->EOL("Next action");
3807 // Emit the type ids.
3808 for (unsigned M = TypeInfos.size(); M; --M) {
3809 GlobalVariable *GV = TypeInfos[M - 1];
3811 PrintRelDirective();
3814 O << Asm->getGlobalLinkName(GV);
3818 Asm->EOL("TypeInfo");
3821 // Emit the filter typeids.
3822 for (unsigned j = 0, M = FilterIds.size(); j < M; ++j) {
3823 unsigned TypeID = FilterIds[j];
3824 Asm->EmitULEB128Bytes(TypeID);
3825 Asm->EOL("Filter TypeInfo index");
3828 Asm->EmitAlignment(2, 0, 0, false);
3832 //===--------------------------------------------------------------------===//
3833 // Main entry points.
3835 DwarfException(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
3836 : Dwarf(OS, A, T, "eh")
3837 , shouldEmitTable(false)
3838 , shouldEmitMoves(false)
3839 , shouldEmitTableModule(false)
3840 , shouldEmitMovesModule(false)
3843 virtual ~DwarfException() {}
3845 /// SetModuleInfo - Set machine module information when it's known that pass
3846 /// manager has created it. Set by the target AsmPrinter.
3847 void SetModuleInfo(MachineModuleInfo *mmi) {
3851 /// BeginModule - Emit all exception information that should come prior to the
3853 void BeginModule(Module *M) {
3857 /// EndModule - Emit all exception information that should come after the
3860 if (shouldEmitMovesModule || shouldEmitTableModule) {
3861 const std::vector<Function *> Personalities = MMI->getPersonalities();
3862 for (unsigned i =0; i < Personalities.size(); ++i)
3863 EmitCommonEHFrame(Personalities[i], i);
3865 for (std::vector<FunctionEHFrameInfo>::iterator I = EHFrames.begin(),
3866 E = EHFrames.end(); I != E; ++I)
3871 /// BeginFunction - Gather pre-function exception information. Assumes being
3872 /// emitted immediately after the function entry point.
3873 void BeginFunction(MachineFunction *MF) {
3875 shouldEmitTable = shouldEmitMoves = false;
3876 if (MMI && TAI->doesSupportExceptionHandling()) {
3878 // Map all labels and get rid of any dead landing pads.
3879 MMI->TidyLandingPads();
3880 // If any landing pads survive, we need an EH table.
3881 if (MMI->getLandingPads().size())
3882 shouldEmitTable = true;
3884 // See if we need frame move info.
3885 if (!MF->getFunction()->doesNotThrow() || UnwindTablesMandatory)
3886 shouldEmitMoves = true;
3888 if (shouldEmitMoves || shouldEmitTable)
3889 // Assumes in correct section after the entry point.
3890 EmitLabel("eh_func_begin", ++SubprogramCount);
3892 shouldEmitTableModule |= shouldEmitTable;
3893 shouldEmitMovesModule |= shouldEmitMoves;
3896 /// EndFunction - Gather and emit post-function exception information.
3898 void EndFunction() {
3899 if (shouldEmitMoves || shouldEmitTable) {
3900 EmitLabel("eh_func_end", SubprogramCount);
3901 EmitExceptionTable();
3903 // Save EH frame information
3905 push_back(FunctionEHFrameInfo(getAsm()->getCurrentFunctionEHName(MF),
3907 MMI->getPersonalityIndex(),
3908 MF->getFrameInfo()->hasCalls(),
3909 !MMI->getLandingPads().empty(),
3910 MMI->getFrameMoves(),
3911 MF->getFunction()));
3916 } // End of namespace llvm
3918 //===----------------------------------------------------------------------===//
3920 /// Emit - Print the abbreviation using the specified Dwarf writer.
3922 void DIEAbbrev::Emit(const DwarfDebug &DD) const {
3923 // Emit its Dwarf tag type.
3924 DD.getAsm()->EmitULEB128Bytes(Tag);
3925 DD.getAsm()->EOL(TagString(Tag));
3927 // Emit whether it has children DIEs.
3928 DD.getAsm()->EmitULEB128Bytes(ChildrenFlag);
3929 DD.getAsm()->EOL(ChildrenString(ChildrenFlag));
3931 // For each attribute description.
3932 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3933 const DIEAbbrevData &AttrData = Data[i];
3935 // Emit attribute type.
3936 DD.getAsm()->EmitULEB128Bytes(AttrData.getAttribute());
3937 DD.getAsm()->EOL(AttributeString(AttrData.getAttribute()));
3940 DD.getAsm()->EmitULEB128Bytes(AttrData.getForm());
3941 DD.getAsm()->EOL(FormEncodingString(AttrData.getForm()));
3944 // Mark end of abbreviation.
3945 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(1)");
3946 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(2)");
3950 void DIEAbbrev::print(std::ostream &O) {
3951 O << "Abbreviation @"
3952 << std::hex << (intptr_t)this << std::dec
3956 << ChildrenString(ChildrenFlag)
3959 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3961 << AttributeString(Data[i].getAttribute())
3963 << FormEncodingString(Data[i].getForm())
3967 void DIEAbbrev::dump() { print(cerr); }
3970 //===----------------------------------------------------------------------===//
3973 void DIEValue::dump() {
3978 //===----------------------------------------------------------------------===//
3980 /// EmitValue - Emit integer of appropriate size.
3982 void DIEInteger::EmitValue(DwarfDebug &DD, unsigned Form) {
3984 case DW_FORM_flag: // Fall thru
3985 case DW_FORM_ref1: // Fall thru
3986 case DW_FORM_data1: DD.getAsm()->EmitInt8(Integer); break;
3987 case DW_FORM_ref2: // Fall thru
3988 case DW_FORM_data2: DD.getAsm()->EmitInt16(Integer); break;
3989 case DW_FORM_ref4: // Fall thru
3990 case DW_FORM_data4: DD.getAsm()->EmitInt32(Integer); break;
3991 case DW_FORM_ref8: // Fall thru
3992 case DW_FORM_data8: DD.getAsm()->EmitInt64(Integer); break;
3993 case DW_FORM_udata: DD.getAsm()->EmitULEB128Bytes(Integer); break;
3994 case DW_FORM_sdata: DD.getAsm()->EmitSLEB128Bytes(Integer); break;
3995 default: assert(0 && "DIE Value form not supported yet"); break;
3999 /// SizeOf - Determine size of integer value in bytes.
4001 unsigned DIEInteger::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4003 case DW_FORM_flag: // Fall thru
4004 case DW_FORM_ref1: // Fall thru
4005 case DW_FORM_data1: return sizeof(int8_t);
4006 case DW_FORM_ref2: // Fall thru
4007 case DW_FORM_data2: return sizeof(int16_t);
4008 case DW_FORM_ref4: // Fall thru
4009 case DW_FORM_data4: return sizeof(int32_t);
4010 case DW_FORM_ref8: // Fall thru
4011 case DW_FORM_data8: return sizeof(int64_t);
4012 case DW_FORM_udata: return TargetAsmInfo::getULEB128Size(Integer);
4013 case DW_FORM_sdata: return TargetAsmInfo::getSLEB128Size(Integer);
4014 default: assert(0 && "DIE Value form not supported yet"); break;
4019 //===----------------------------------------------------------------------===//
4021 /// EmitValue - Emit string value.
4023 void DIEString::EmitValue(DwarfDebug &DD, unsigned Form) {
4024 DD.getAsm()->EmitString(String);
4027 //===----------------------------------------------------------------------===//
4029 /// EmitValue - Emit label value.
4031 void DIEDwarfLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
4032 bool IsSmall = Form == DW_FORM_data4;
4033 DD.EmitReference(Label, false, IsSmall);
4036 /// SizeOf - Determine size of label value in bytes.
4038 unsigned DIEDwarfLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4039 if (Form == DW_FORM_data4) return 4;
4040 return DD.getTargetData()->getPointerSize();
4043 //===----------------------------------------------------------------------===//
4045 /// EmitValue - Emit label value.
4047 void DIEObjectLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
4048 bool IsSmall = Form == DW_FORM_data4;
4049 DD.EmitReference(Label, false, IsSmall);
4052 /// SizeOf - Determine size of label value in bytes.
4054 unsigned DIEObjectLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4055 if (Form == DW_FORM_data4) return 4;
4056 return DD.getTargetData()->getPointerSize();
4059 //===----------------------------------------------------------------------===//
4061 /// EmitValue - Emit delta value.
4063 void DIESectionOffset::EmitValue(DwarfDebug &DD, unsigned Form) {
4064 bool IsSmall = Form == DW_FORM_data4;
4065 DD.EmitSectionOffset(Label.Tag, Section.Tag,
4066 Label.Number, Section.Number, IsSmall, IsEH, UseSet);
4069 /// SizeOf - Determine size of delta value in bytes.
4071 unsigned DIESectionOffset::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4072 if (Form == DW_FORM_data4) return 4;
4073 return DD.getTargetData()->getPointerSize();
4076 //===----------------------------------------------------------------------===//
4078 /// EmitValue - Emit delta value.
4080 void DIEDelta::EmitValue(DwarfDebug &DD, unsigned Form) {
4081 bool IsSmall = Form == DW_FORM_data4;
4082 DD.EmitDifference(LabelHi, LabelLo, IsSmall);
4085 /// SizeOf - Determine size of delta value in bytes.
4087 unsigned DIEDelta::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4088 if (Form == DW_FORM_data4) return 4;
4089 return DD.getTargetData()->getPointerSize();
4092 //===----------------------------------------------------------------------===//
4094 /// EmitValue - Emit debug information entry offset.
4096 void DIEntry::EmitValue(DwarfDebug &DD, unsigned Form) {
4097 DD.getAsm()->EmitInt32(Entry->getOffset());
4100 //===----------------------------------------------------------------------===//
4102 /// ComputeSize - calculate the size of the block.
4104 unsigned DIEBlock::ComputeSize(DwarfDebug &DD) {
4106 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
4108 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4109 Size += Values[i]->SizeOf(DD, AbbrevData[i].getForm());
4115 /// EmitValue - Emit block data.
4117 void DIEBlock::EmitValue(DwarfDebug &DD, unsigned Form) {
4119 case DW_FORM_block1: DD.getAsm()->EmitInt8(Size); break;
4120 case DW_FORM_block2: DD.getAsm()->EmitInt16(Size); break;
4121 case DW_FORM_block4: DD.getAsm()->EmitInt32(Size); break;
4122 case DW_FORM_block: DD.getAsm()->EmitULEB128Bytes(Size); break;
4123 default: assert(0 && "Improper form for block"); break;
4126 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
4128 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4130 Values[i]->EmitValue(DD, AbbrevData[i].getForm());
4134 /// SizeOf - Determine size of block data in bytes.
4136 unsigned DIEBlock::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4138 case DW_FORM_block1: return Size + sizeof(int8_t);
4139 case DW_FORM_block2: return Size + sizeof(int16_t);
4140 case DW_FORM_block4: return Size + sizeof(int32_t);
4141 case DW_FORM_block: return Size + TargetAsmInfo::getULEB128Size(Size);
4142 default: assert(0 && "Improper form for block"); break;
4147 //===----------------------------------------------------------------------===//
4148 /// DIE Implementation
4151 for (unsigned i = 0, N = Children.size(); i < N; ++i)
4155 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
4157 void DIE::AddSiblingOffset() {
4158 DIEInteger *DI = new DIEInteger(0);
4159 Values.insert(Values.begin(), DI);
4160 Abbrev.AddFirstAttribute(DW_AT_sibling, DW_FORM_ref4);
4163 /// Profile - Used to gather unique data for the value folding set.
4165 void DIE::Profile(FoldingSetNodeID &ID) {
4168 for (unsigned i = 0, N = Children.size(); i < N; ++i)
4169 ID.AddPointer(Children[i]);
4171 for (unsigned j = 0, M = Values.size(); j < M; ++j)
4172 ID.AddPointer(Values[j]);
4176 void DIE::print(std::ostream &O, unsigned IncIndent) {
4177 static unsigned IndentCount = 0;
4178 IndentCount += IncIndent;
4179 const std::string Indent(IndentCount, ' ');
4180 bool isBlock = Abbrev.getTag() == 0;
4185 << "0x" << std::hex << (intptr_t)this << std::dec
4186 << ", Offset: " << Offset
4187 << ", Size: " << Size
4191 << TagString(Abbrev.getTag())
4193 << ChildrenString(Abbrev.getChildrenFlag());
4195 O << "Size: " << Size;
4199 const SmallVector<DIEAbbrevData, 8> &Data = Abbrev.getData();
4202 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4206 O << AttributeString(Data[i].getAttribute());
4208 O << "Blk[" << i << "]";
4211 << FormEncodingString(Data[i].getForm())
4213 Values[i]->print(O);
4218 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
4219 Children[j]->print(O, 4);
4222 if (!isBlock) O << "\n";
4223 IndentCount -= IncIndent;
4231 //===----------------------------------------------------------------------===//
4232 /// DwarfWriter Implementation
4235 DwarfWriter::DwarfWriter() : ImmutablePass(&ID), DD(NULL), DE(NULL) {
4238 DwarfWriter::~DwarfWriter() {
4243 /// BeginModule - Emit all Dwarf sections that should come prior to the
4245 void DwarfWriter::BeginModule(Module *M,
4246 MachineModuleInfo *MMI,
4247 raw_ostream &OS, AsmPrinter *A,
4248 const TargetAsmInfo *T) {
4249 DE = new DwarfException(OS, A, T);
4250 DD = new DwarfDebug(OS, A, T);
4253 DD->SetDebugInfo(MMI);
4254 DE->SetModuleInfo(MMI);
4257 /// EndModule - Emit all Dwarf sections that should come after the content.
4259 void DwarfWriter::EndModule() {
4264 /// BeginFunction - Gather pre-function debug information. Assumes being
4265 /// emitted immediately after the function entry point.
4266 void DwarfWriter::BeginFunction(MachineFunction *MF) {
4267 DE->BeginFunction(MF);
4268 DD->BeginFunction(MF);
4271 /// EndFunction - Gather and emit post-function debug information.
4273 void DwarfWriter::EndFunction(MachineFunction *MF) {
4274 DD->EndFunction(MF);
4277 if (MachineModuleInfo *MMI = DD->getMMI() ? DD->getMMI() : DE->getMMI())
4278 // Clear function debug information.
4282 /// ValidDebugInfo - Return true if V represents valid debug info value.
4283 bool DwarfWriter::ValidDebugInfo(Value *V) {
4284 return DD && DD->ValidDebugInfo(V);
4287 /// RecordSourceLine - Records location information and associates it with a
4288 /// label. Returns a unique label ID used to generate a label and provide
4289 /// correspondence to the source line list.
4290 unsigned DwarfWriter::RecordSourceLine(unsigned Line, unsigned Col,
4292 return DD->RecordSourceLine(Line, Col, Src);
4295 /// RecordSource - Register a source file with debug info. Returns an source
4297 unsigned DwarfWriter::RecordSource(const std::string &Dir,
4298 const std::string &File) {
4299 return DD->RecordSource(Dir, File);
4302 /// RecordRegionStart - Indicate the start of a region.
4303 unsigned DwarfWriter::RecordRegionStart(GlobalVariable *V) {
4304 return DD->RecordRegionStart(V);
4307 /// RecordRegionEnd - Indicate the end of a region.
4308 unsigned DwarfWriter::RecordRegionEnd(GlobalVariable *V) {
4309 return DD->RecordRegionEnd(V);
4312 /// getRecordSourceLineCount - Count source lines.
4313 unsigned DwarfWriter::getRecordSourceLineCount() {
4314 return DD->getRecordSourceLineCount();
4317 /// RecordVariable - Indicate the declaration of a local variable.
4319 void DwarfWriter::RecordVariable(GlobalVariable *GV, unsigned FrameIndex) {
4320 DD->RecordVariable(GV, FrameIndex);