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; // 512
58 static const unsigned InitAbbreviationsSetSize = 9; // 512
59 static const unsigned InitValuesSetSize = 9; // 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.
861 //===--------------------------------------------------------------------===//
862 // Core attributes used by the Dwarf writer.
866 /// O - Stream to .s file.
870 /// Asm - Target of Dwarf emission.
874 /// TAI - Target asm information.
875 const TargetAsmInfo *TAI;
877 /// TD - Target data.
878 const TargetData *TD;
880 /// RI - Register Information.
881 const TargetRegisterInfo *RI;
883 /// M - Current module.
887 /// MF - Current machine function.
891 /// MMI - Collected machine module information.
893 MachineModuleInfo *MMI;
895 /// SubprogramCount - The running count of functions being compiled.
897 unsigned SubprogramCount;
899 /// Flavor - A unique string indicating what dwarf producer this is, used to
901 const char * const Flavor;
904 Dwarf(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T,
909 , TD(Asm->TM.getTargetData())
910 , RI(Asm->TM.getRegisterInfo())
922 //===--------------------------------------------------------------------===//
925 AsmPrinter *getAsm() const { return Asm; }
926 MachineModuleInfo *getMMI() const { return MMI; }
927 const TargetAsmInfo *getTargetAsmInfo() const { return TAI; }
928 const TargetData *getTargetData() const { return TD; }
930 void PrintRelDirective(bool Force32Bit = false, bool isInSection = false)
932 if (isInSection && TAI->getDwarfSectionOffsetDirective())
933 O << TAI->getDwarfSectionOffsetDirective();
934 else if (Force32Bit || TD->getPointerSize() == sizeof(int32_t))
935 O << TAI->getData32bitsDirective();
937 O << TAI->getData64bitsDirective();
940 /// PrintLabelName - Print label name in form used by Dwarf writer.
942 void PrintLabelName(DWLabel Label) const {
943 PrintLabelName(Label.Tag, Label.Number);
945 void PrintLabelName(const char *Tag, unsigned Number) const {
946 O << TAI->getPrivateGlobalPrefix() << Tag;
947 if (Number) O << Number;
950 void PrintLabelName(const char *Tag, unsigned Number,
951 const char *Suffix) const {
952 O << TAI->getPrivateGlobalPrefix() << Tag;
953 if (Number) O << Number;
957 /// EmitLabel - Emit location label for internal use by Dwarf.
959 void EmitLabel(DWLabel Label) const {
960 EmitLabel(Label.Tag, Label.Number);
962 void EmitLabel(const char *Tag, unsigned Number) const {
963 PrintLabelName(Tag, Number);
967 /// EmitReference - Emit a reference to a label.
969 void EmitReference(DWLabel Label, bool IsPCRelative = false,
970 bool Force32Bit = false) const {
971 EmitReference(Label.Tag, Label.Number, IsPCRelative, Force32Bit);
973 void EmitReference(const char *Tag, unsigned Number,
974 bool IsPCRelative = false, bool Force32Bit = false) const {
975 PrintRelDirective(Force32Bit);
976 PrintLabelName(Tag, Number);
978 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
980 void EmitReference(const std::string &Name, bool IsPCRelative = false,
981 bool Force32Bit = false) const {
982 PrintRelDirective(Force32Bit);
986 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
989 /// EmitDifference - Emit the difference between two labels. Some
990 /// assemblers do not behave with absolute expressions with data directives,
991 /// so there is an option (needsSet) to use an intermediary set expression.
992 void EmitDifference(DWLabel LabelHi, DWLabel LabelLo,
993 bool IsSmall = false) {
994 EmitDifference(LabelHi.Tag, LabelHi.Number,
995 LabelLo.Tag, LabelLo.Number,
998 void EmitDifference(const char *TagHi, unsigned NumberHi,
999 const char *TagLo, unsigned NumberLo,
1000 bool IsSmall = false) {
1001 if (TAI->needsSet()) {
1003 PrintLabelName("set", SetCounter, Flavor);
1005 PrintLabelName(TagHi, NumberHi);
1007 PrintLabelName(TagLo, NumberLo);
1010 PrintRelDirective(IsSmall);
1011 PrintLabelName("set", SetCounter, Flavor);
1014 PrintRelDirective(IsSmall);
1016 PrintLabelName(TagHi, NumberHi);
1018 PrintLabelName(TagLo, NumberLo);
1022 void EmitSectionOffset(const char* Label, const char* Section,
1023 unsigned LabelNumber, unsigned SectionNumber,
1024 bool IsSmall = false, bool isEH = false,
1025 bool useSet = true) {
1026 bool printAbsolute = false;
1028 printAbsolute = TAI->isAbsoluteEHSectionOffsets();
1030 printAbsolute = TAI->isAbsoluteDebugSectionOffsets();
1032 if (TAI->needsSet() && useSet) {
1034 PrintLabelName("set", SetCounter, Flavor);
1036 PrintLabelName(Label, LabelNumber);
1038 if (!printAbsolute) {
1040 PrintLabelName(Section, SectionNumber);
1044 PrintRelDirective(IsSmall);
1046 PrintLabelName("set", SetCounter, Flavor);
1049 PrintRelDirective(IsSmall, true);
1051 PrintLabelName(Label, LabelNumber);
1053 if (!printAbsolute) {
1055 PrintLabelName(Section, SectionNumber);
1060 /// EmitFrameMoves - Emit frame instructions to describe the layout of the
1062 void EmitFrameMoves(const char *BaseLabel, unsigned BaseLabelID,
1063 const std::vector<MachineMove> &Moves, bool isEH) {
1065 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
1066 TargetFrameInfo::StackGrowsUp ?
1067 TD->getPointerSize() : -TD->getPointerSize();
1068 bool IsLocal = BaseLabel && strcmp(BaseLabel, "label") == 0;
1070 for (unsigned i = 0, N = Moves.size(); i < N; ++i) {
1071 const MachineMove &Move = Moves[i];
1072 unsigned LabelID = Move.getLabelID();
1075 LabelID = MMI->MappedLabel(LabelID);
1077 // Throw out move if the label is invalid.
1078 if (!LabelID) continue;
1081 const MachineLocation &Dst = Move.getDestination();
1082 const MachineLocation &Src = Move.getSource();
1084 // Advance row if new location.
1085 if (BaseLabel && LabelID && (BaseLabelID != LabelID || !IsLocal)) {
1086 Asm->EmitInt8(DW_CFA_advance_loc4);
1087 Asm->EOL("DW_CFA_advance_loc4");
1088 EmitDifference("label", LabelID, BaseLabel, BaseLabelID, true);
1091 BaseLabelID = LabelID;
1092 BaseLabel = "label";
1096 // If advancing cfa.
1097 if (Dst.isReg() && Dst.getReg() == MachineLocation::VirtualFP) {
1099 if (Src.getReg() == MachineLocation::VirtualFP) {
1100 Asm->EmitInt8(DW_CFA_def_cfa_offset);
1101 Asm->EOL("DW_CFA_def_cfa_offset");
1103 Asm->EmitInt8(DW_CFA_def_cfa);
1104 Asm->EOL("DW_CFA_def_cfa");
1105 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Src.getReg(), isEH));
1106 Asm->EOL("Register");
1109 int Offset = -Src.getOffset();
1111 Asm->EmitULEB128Bytes(Offset);
1114 assert(0 && "Machine move no supported yet.");
1116 } else if (Src.isReg() &&
1117 Src.getReg() == MachineLocation::VirtualFP) {
1119 Asm->EmitInt8(DW_CFA_def_cfa_register);
1120 Asm->EOL("DW_CFA_def_cfa_register");
1121 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Dst.getReg(), isEH));
1122 Asm->EOL("Register");
1124 assert(0 && "Machine move no supported yet.");
1127 unsigned Reg = RI->getDwarfRegNum(Src.getReg(), isEH);
1128 int Offset = Dst.getOffset() / stackGrowth;
1131 Asm->EmitInt8(DW_CFA_offset_extended_sf);
1132 Asm->EOL("DW_CFA_offset_extended_sf");
1133 Asm->EmitULEB128Bytes(Reg);
1135 Asm->EmitSLEB128Bytes(Offset);
1137 } else if (Reg < 64) {
1138 Asm->EmitInt8(DW_CFA_offset + Reg);
1140 Asm->EOL("DW_CFA_offset + Reg (" + utostr(Reg) + ")");
1143 Asm->EmitULEB128Bytes(Offset);
1146 Asm->EmitInt8(DW_CFA_offset_extended);
1147 Asm->EOL("DW_CFA_offset_extended");
1148 Asm->EmitULEB128Bytes(Reg);
1150 Asm->EmitULEB128Bytes(Offset);
1159 //===----------------------------------------------------------------------===//
1160 /// SrcLineInfo - This class is used to record source line correspondence.
1163 unsigned Line; // Source line number.
1164 unsigned Column; // Source column.
1165 unsigned SourceID; // Source ID number.
1166 unsigned LabelID; // Label in code ID number.
1168 SrcLineInfo(unsigned L, unsigned C, unsigned S, unsigned I)
1169 : Line(L), Column(C), SourceID(S), LabelID(I) {}
1172 unsigned getLine() const { return Line; }
1173 unsigned getColumn() const { return Column; }
1174 unsigned getSourceID() const { return SourceID; }
1175 unsigned getLabelID() const { return LabelID; }
1179 //===----------------------------------------------------------------------===//
1180 /// SrcFileInfo - This class is used to track source information.
1183 unsigned DirectoryID; // Directory ID number.
1184 std::string Name; // File name (not including directory.)
1186 SrcFileInfo(unsigned D, const std::string &N) : DirectoryID(D), Name(N) {}
1189 unsigned getDirectoryID() const { return DirectoryID; }
1190 const std::string &getName() const { return Name; }
1192 /// operator== - Used by UniqueVector to locate entry.
1194 bool operator==(const SrcFileInfo &SI) const {
1195 return getDirectoryID() == SI.getDirectoryID() && getName() == SI.getName();
1198 /// operator< - Used by UniqueVector to locate entry.
1200 bool operator<(const SrcFileInfo &SI) const {
1201 return getDirectoryID() < SI.getDirectoryID() ||
1202 (getDirectoryID() == SI.getDirectoryID() && getName() < SI.getName());
1206 //===----------------------------------------------------------------------===//
1207 /// DbgVariable - This class is used to track local variable information.
1211 DIVariable Var; // Variable Descriptor.
1212 unsigned FrameIndex; // Variable frame index.
1215 DbgVariable(DIVariable V, unsigned I) : Var(V), FrameIndex(I) {}
1218 DIVariable getVariable() const { return Var; }
1219 unsigned getFrameIndex() const { return FrameIndex; }
1222 //===----------------------------------------------------------------------===//
1223 /// DbgScope - This class is used to track scope information.
1227 DbgScope *Parent; // Parent to this scope.
1228 DIDescriptor Desc; // Debug info descriptor for scope.
1229 // Either subprogram or block.
1230 unsigned StartLabelID; // Label ID of the beginning of scope.
1231 unsigned EndLabelID; // Label ID of the end of scope.
1232 SmallVector<DbgScope *, 4> Scopes; // Scopes defined in scope.
1233 SmallVector<DbgVariable *, 8> Variables;// Variables declared in scope.
1236 DbgScope(DbgScope *P, DIDescriptor D)
1237 : Parent(P), Desc(D), StartLabelID(0), EndLabelID(0), Scopes(), Variables()
1240 for (unsigned i = 0, N = Scopes.size(); i < N; ++i) delete Scopes[i];
1241 for (unsigned j = 0, M = Variables.size(); j < M; ++j) delete Variables[j];
1245 DbgScope *getParent() const { return Parent; }
1246 DIDescriptor getDesc() const { return Desc; }
1247 unsigned getStartLabelID() const { return StartLabelID; }
1248 unsigned getEndLabelID() const { return EndLabelID; }
1249 SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
1250 SmallVector<DbgVariable *, 8> &getVariables() { return Variables; }
1251 void setStartLabelID(unsigned S) { StartLabelID = S; }
1252 void setEndLabelID(unsigned E) { EndLabelID = E; }
1254 /// AddScope - Add a scope to the scope.
1256 void AddScope(DbgScope *S) { Scopes.push_back(S); }
1258 /// AddVariable - Add a variable to the scope.
1260 void AddVariable(DbgVariable *V) { Variables.push_back(V); }
1263 //===----------------------------------------------------------------------===//
1264 /// DwarfDebug - Emits Dwarf debug directives.
1266 class DwarfDebug : public Dwarf {
1269 //===--------------------------------------------------------------------===//
1270 // Attributes used to construct specific Dwarf sections.
1273 /// DW_CUs - All the compile units involved in this build. The index
1274 /// of each entry in this vector corresponds to the sources in MMI.
1275 DenseMap<Value *, CompileUnit *> DW_CUs;
1277 /// AbbreviationsSet - Used to uniquely define abbreviations.
1279 FoldingSet<DIEAbbrev> AbbreviationsSet;
1281 /// Abbreviations - A list of all the unique abbreviations in use.
1283 std::vector<DIEAbbrev *> Abbreviations;
1285 /// Directories - Uniquing vector for directories.
1286 UniqueVector<std::string> Directories;
1288 /// SourceFiles - Uniquing vector for source files.
1289 UniqueVector<SrcFileInfo> SrcFiles;
1291 /// Lines - List of of source line correspondence.
1292 std::vector<SrcLineInfo> Lines;
1294 /// ValuesSet - Used to uniquely define values.
1296 FoldingSet<DIEValue> ValuesSet;
1298 /// Values - A list of all the unique values in use.
1300 std::vector<DIEValue *> Values;
1302 /// StringPool - A UniqueVector of strings used by indirect references.
1304 UniqueVector<std::string> StringPool;
1306 /// SectionMap - Provides a unique id per text section.
1308 UniqueVector<const Section*> SectionMap;
1310 /// SectionSourceLines - Tracks line numbers per text section.
1312 std::vector<std::vector<SrcLineInfo> > SectionSourceLines;
1314 /// didInitial - Flag to indicate if initial emission has been done.
1318 /// shouldEmit - Flag to indicate if debug information should be emitted.
1322 // RootDbgScope - Top level scope for the current function.
1324 DbgScope *RootDbgScope;
1326 // DbgScopeMap - Tracks the scopes in the current function.
1327 DenseMap<GlobalVariable *, DbgScope *> DbgScopeMap;
1329 struct FunctionDebugFrameInfo {
1331 std::vector<MachineMove> Moves;
1333 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M):
1334 Number(Num), Moves(M) { }
1337 std::vector<FunctionDebugFrameInfo> DebugFrames;
1341 /// ShouldEmitDwarf - Returns true if Dwarf declarations should be made.
1343 bool ShouldEmitDwarf() const { return shouldEmit; }
1345 /// AssignAbbrevNumber - Define a unique number for the abbreviation.
1347 void AssignAbbrevNumber(DIEAbbrev &Abbrev) {
1348 // Profile the node so that we can make it unique.
1349 FoldingSetNodeID ID;
1352 // Check the set for priors.
1353 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
1355 // If it's newly added.
1356 if (InSet == &Abbrev) {
1357 // Add to abbreviation list.
1358 Abbreviations.push_back(&Abbrev);
1359 // Assign the vector position + 1 as its number.
1360 Abbrev.setNumber(Abbreviations.size());
1362 // Assign existing abbreviation number.
1363 Abbrev.setNumber(InSet->getNumber());
1367 /// NewString - Add a string to the constant pool and returns a label.
1369 DWLabel NewString(const std::string &String) {
1370 unsigned StringID = StringPool.insert(String);
1371 return DWLabel("string", StringID);
1374 /// NewDIEntry - Creates a new DIEntry to be a proxy for a debug information
1376 DIEntry *NewDIEntry(DIE *Entry = NULL) {
1380 FoldingSetNodeID ID;
1381 DIEntry::Profile(ID, Entry);
1383 Value = static_cast<DIEntry *>(ValuesSet.FindNodeOrInsertPos(ID, Where));
1385 if (Value) return Value;
1387 Value = new DIEntry(Entry);
1388 ValuesSet.InsertNode(Value, Where);
1390 Value = new DIEntry(Entry);
1393 Values.push_back(Value);
1397 /// SetDIEntry - Set a DIEntry once the debug information entry is defined.
1399 void SetDIEntry(DIEntry *Value, DIE *Entry) {
1400 Value->Entry = Entry;
1401 // Add to values set if not already there. If it is, we merely have a
1402 // duplicate in the values list (no harm.)
1403 ValuesSet.GetOrInsertNode(Value);
1406 /// AddUInt - Add an unsigned integer attribute data and value.
1408 void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer) {
1409 if (!Form) Form = DIEInteger::BestForm(false, Integer);
1411 FoldingSetNodeID ID;
1412 DIEInteger::Profile(ID, Integer);
1414 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1416 Value = new DIEInteger(Integer);
1417 ValuesSet.InsertNode(Value, Where);
1418 Values.push_back(Value);
1421 Die->AddValue(Attribute, Form, Value);
1424 /// AddSInt - Add an signed integer attribute data and value.
1426 void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer) {
1427 if (!Form) Form = DIEInteger::BestForm(true, Integer);
1429 FoldingSetNodeID ID;
1430 DIEInteger::Profile(ID, (uint64_t)Integer);
1432 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1434 Value = new DIEInteger(Integer);
1435 ValuesSet.InsertNode(Value, Where);
1436 Values.push_back(Value);
1439 Die->AddValue(Attribute, Form, Value);
1442 /// AddString - Add a std::string attribute data and value.
1444 void AddString(DIE *Die, unsigned Attribute, unsigned Form,
1445 const std::string &String) {
1446 FoldingSetNodeID ID;
1447 DIEString::Profile(ID, String);
1449 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1451 Value = new DIEString(String);
1452 ValuesSet.InsertNode(Value, Where);
1453 Values.push_back(Value);
1456 Die->AddValue(Attribute, Form, Value);
1459 /// AddLabel - Add a Dwarf label attribute data and value.
1461 void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
1462 const DWLabel &Label) {
1463 FoldingSetNodeID ID;
1464 DIEDwarfLabel::Profile(ID, Label);
1466 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1468 Value = new DIEDwarfLabel(Label);
1469 ValuesSet.InsertNode(Value, Where);
1470 Values.push_back(Value);
1473 Die->AddValue(Attribute, Form, Value);
1476 /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
1478 void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
1479 const std::string &Label) {
1480 FoldingSetNodeID ID;
1481 DIEObjectLabel::Profile(ID, Label);
1483 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1485 Value = new DIEObjectLabel(Label);
1486 ValuesSet.InsertNode(Value, Where);
1487 Values.push_back(Value);
1490 Die->AddValue(Attribute, Form, Value);
1493 /// AddSectionOffset - Add a section offset label attribute data and value.
1495 void AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
1496 const DWLabel &Label, const DWLabel &Section,
1497 bool isEH = false, bool useSet = true) {
1498 FoldingSetNodeID ID;
1499 DIESectionOffset::Profile(ID, Label, Section);
1501 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1503 Value = new DIESectionOffset(Label, Section, isEH, useSet);
1504 ValuesSet.InsertNode(Value, Where);
1505 Values.push_back(Value);
1508 Die->AddValue(Attribute, Form, Value);
1511 /// AddDelta - Add a label delta attribute data and value.
1513 void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
1514 const DWLabel &Hi, const DWLabel &Lo) {
1515 FoldingSetNodeID ID;
1516 DIEDelta::Profile(ID, Hi, Lo);
1518 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1520 Value = new DIEDelta(Hi, Lo);
1521 ValuesSet.InsertNode(Value, Where);
1522 Values.push_back(Value);
1525 Die->AddValue(Attribute, Form, Value);
1528 /// AddDIEntry - Add a DIE attribute data and value.
1530 void AddDIEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
1531 Die->AddValue(Attribute, Form, NewDIEntry(Entry));
1534 /// AddBlock - Add block data.
1536 void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block) {
1537 Block->ComputeSize(*this);
1538 FoldingSetNodeID ID;
1541 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1544 ValuesSet.InsertNode(Value, Where);
1545 Values.push_back(Value);
1547 // Already exists, reuse the previous one.
1549 Block = cast<DIEBlock>(Value);
1552 Die->AddValue(Attribute, Block->BestForm(), Value);
1557 /// AddSourceLine - Add location information to specified debug information
1559 void AddSourceLine(DIE *Die, const DIVariable *V) {
1560 unsigned FileID = 0;
1561 unsigned Line = V->getLineNumber();
1562 if (V->getVersion() <= LLVMDebugVersion6) {
1563 // Version6 or earlier. Use compile unit info to get file id.
1564 CompileUnit *Unit = FindCompileUnit(V->getCompileUnit());
1565 FileID = Unit->getID();
1567 // Version7 or newer, use filename and directory info from DIVariable
1569 unsigned DID = Directories.idFor(V->getDirectory());
1570 FileID = SrcFiles.idFor(SrcFileInfo(DID, V->getFilename()));
1572 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1573 AddUInt(Die, DW_AT_decl_line, 0, Line);
1576 /// AddSourceLine - Add location information to specified debug information
1578 void AddSourceLine(DIE *Die, const DIGlobal *G) {
1579 unsigned FileID = 0;
1580 unsigned Line = G->getLineNumber();
1581 if (G->getVersion() <= LLVMDebugVersion6) {
1582 // Version6 or earlier. Use compile unit info to get file id.
1583 CompileUnit *Unit = FindCompileUnit(G->getCompileUnit());
1584 FileID = Unit->getID();
1586 // Version7 or newer, use filename and directory info from DIGlobal
1588 unsigned DID = Directories.idFor(G->getDirectory());
1589 FileID = SrcFiles.idFor(SrcFileInfo(DID, G->getFilename()));
1591 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1592 AddUInt(Die, DW_AT_decl_line, 0, Line);
1595 void AddSourceLine(DIE *Die, const DIType *Ty) {
1596 unsigned FileID = 0;
1597 unsigned Line = Ty->getLineNumber();
1598 if (Ty->getVersion() <= LLVMDebugVersion6) {
1599 // Version6 or earlier. Use compile unit info to get file id.
1600 CompileUnit *Unit = FindCompileUnit(Ty->getCompileUnit());
1601 FileID = Unit->getID();
1603 // Version7 or newer, use filename and directory info from DIType
1605 unsigned DID = Directories.idFor(Ty->getDirectory());
1606 FileID = SrcFiles.idFor(SrcFileInfo(DID, Ty->getFilename()));
1608 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1609 AddUInt(Die, DW_AT_decl_line, 0, Line);
1612 /// AddAddress - Add an address attribute to a die based on the location
1614 void AddAddress(DIE *Die, unsigned Attribute,
1615 const MachineLocation &Location) {
1616 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
1617 DIEBlock *Block = new DIEBlock();
1619 if (Location.isReg()) {
1621 AddUInt(Block, 0, DW_FORM_data1, DW_OP_reg0 + Reg);
1623 AddUInt(Block, 0, DW_FORM_data1, DW_OP_regx);
1624 AddUInt(Block, 0, DW_FORM_udata, Reg);
1628 AddUInt(Block, 0, DW_FORM_data1, DW_OP_breg0 + Reg);
1630 AddUInt(Block, 0, DW_FORM_data1, DW_OP_bregx);
1631 AddUInt(Block, 0, DW_FORM_udata, Reg);
1633 AddUInt(Block, 0, DW_FORM_sdata, Location.getOffset());
1636 AddBlock(Die, Attribute, 0, Block);
1639 /// AddBasicType - Add a new basic type attribute to the specified entity.
1641 void AddBasicType(DIE *Entity, CompileUnit *Unit,
1642 const std::string &Name,
1643 unsigned Encoding, unsigned Size) {
1645 DIE Buffer(DW_TAG_base_type);
1646 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1647 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, Encoding);
1648 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1649 DIE *BasicTypeDie = Unit->AddDie(Buffer);
1650 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, BasicTypeDie);
1653 /// AddPointerType - Add a new pointer type attribute to the specified entity.
1655 void AddPointerType(DIE *Entity, CompileUnit *Unit, const std::string &Name) {
1656 DIE Buffer(DW_TAG_pointer_type);
1657 AddUInt(&Buffer, DW_AT_byte_size, 0, TD->getPointerSize());
1658 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1659 DIE *PointerTypeDie = Unit->AddDie(Buffer);
1660 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, PointerTypeDie);
1663 /// AddType - Add a new type attribute to the specified entity.
1664 void AddType(CompileUnit *DW_Unit, DIE *Entity, DIType Ty) {
1668 // Check for pre-existence.
1669 DIEntry *&Slot = DW_Unit->getDIEntrySlotFor(Ty.getGV());
1670 // If it exists then use the existing value.
1672 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1677 Slot = NewDIEntry();
1680 DIE Buffer(DW_TAG_base_type);
1681 if (Ty.isBasicType(Ty.getTag()))
1682 ConstructTypeDIE(DW_Unit, Buffer, DIBasicType(Ty.getGV()));
1683 else if (Ty.isDerivedType(Ty.getTag()))
1684 ConstructTypeDIE(DW_Unit, Buffer, DIDerivedType(Ty.getGV()));
1686 assert (Ty.isCompositeType(Ty.getTag()) && "Unknown kind of DIType");
1687 ConstructTypeDIE(DW_Unit, Buffer, DICompositeType(Ty.getGV()));
1690 // Add debug information entry to entity and unit.
1691 DIE *Die = DW_Unit->AddDie(Buffer);
1692 SetDIEntry(Slot, Die);
1693 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1696 /// ConstructTypeDIE - Construct basic type die from DIBasicType.
1697 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1700 // Get core information.
1701 const std::string &Name = BTy.getName();
1702 Buffer.setTag(DW_TAG_base_type);
1703 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, BTy.getEncoding());
1704 // Add name if not anonymous or intermediate type.
1706 AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1707 uint64_t Size = BTy.getSizeInBits() >> 3;
1708 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1711 /// ConstructTypeDIE - Construct derived type die from DIDerivedType.
1712 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1713 DIDerivedType DTy) {
1715 // Get core information.
1716 const std::string &Name = DTy.getName();
1717 uint64_t Size = DTy.getSizeInBits() >> 3;
1718 unsigned Tag = DTy.getTag();
1719 // FIXME - Workaround for templates.
1720 if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
1723 // Map to main type, void will not have a type.
1724 DIType FromTy = DTy.getTypeDerivedFrom();
1725 AddType(DW_Unit, &Buffer, FromTy);
1727 // Add name if not anonymous or intermediate type.
1728 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1730 // Add size if non-zero (derived types might be zero-sized.)
1732 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1734 // Add source line info if available and TyDesc is not a forward
1736 // FIXME - Enable this. if (!DTy.isForwardDecl())
1737 // FIXME - Enable this. AddSourceLine(&Buffer, *DTy);
1740 /// ConstructTypeDIE - Construct type DIE from DICompositeType.
1741 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1742 DICompositeType CTy) {
1744 // Get core information.
1745 const std::string &Name = CTy.getName();
1746 uint64_t Size = CTy.getSizeInBits() >> 3;
1747 unsigned Tag = CTy.getTag();
1750 case DW_TAG_vector_type:
1751 case DW_TAG_array_type:
1752 ConstructArrayTypeDIE(DW_Unit, Buffer, &CTy);
1754 case DW_TAG_enumeration_type:
1756 DIArray Elements = CTy.getTypeArray();
1757 // Add enumerators to enumeration type.
1758 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1759 DIE *ElemDie = NULL;
1760 DIEnumerator Enum(Elements.getElement(i).getGV());
1761 ElemDie = ConstructEnumTypeDIE(DW_Unit, &Enum);
1762 Buffer.AddChild(ElemDie);
1766 case DW_TAG_subroutine_type:
1768 // Add prototype flag.
1769 AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
1770 DIArray Elements = CTy.getTypeArray();
1772 DIDescriptor RTy = Elements.getElement(0);
1773 AddType(DW_Unit, &Buffer, DIType(RTy.getGV()));
1776 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1777 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1778 DIDescriptor Ty = Elements.getElement(i);
1779 AddType(DW_Unit, Arg, DIType(Ty.getGV()));
1780 Buffer.AddChild(Arg);
1784 case DW_TAG_structure_type:
1785 case DW_TAG_union_type:
1787 // Add elements to structure type.
1788 DIArray Elements = CTy.getTypeArray();
1790 // A forward struct declared type may not have elements available.
1791 if (Elements.isNull())
1794 // Add elements to structure type.
1795 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1796 DIDescriptor Element = Elements.getElement(i);
1797 DIE *ElemDie = NULL;
1798 if (Element.getTag() == dwarf::DW_TAG_subprogram)
1799 ElemDie = CreateSubprogramDIE(DW_Unit,
1800 DISubprogram(Element.getGV()));
1801 else if (Element.getTag() == dwarf::DW_TAG_variable) // ???
1802 ElemDie = CreateGlobalVariableDIE(DW_Unit,
1803 DIGlobalVariable(Element.getGV()));
1805 ElemDie = CreateMemberDIE(DW_Unit,
1806 DIDerivedType(Element.getGV()));
1807 Buffer.AddChild(ElemDie);
1815 // Add name if not anonymous or intermediate type.
1816 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1818 // Add size if non-zero (derived types might be zero-sized.)
1820 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1822 // Add zero size if it is not a forward declaration.
1823 if (CTy.isForwardDecl())
1824 AddUInt(&Buffer, DW_AT_declaration, DW_FORM_flag, 1);
1826 AddUInt(&Buffer, DW_AT_byte_size, 0, 0);
1829 // Add source line info if available.
1830 if (!CTy.isForwardDecl())
1831 AddSourceLine(&Buffer, &CTy);
1834 // ConstructSubrangeDIE - Construct subrange DIE from DISubrange.
1835 void ConstructSubrangeDIE (DIE &Buffer, DISubrange SR, DIE *IndexTy) {
1836 int64_t L = SR.getLo();
1837 int64_t H = SR.getHi();
1838 DIE *DW_Subrange = new DIE(DW_TAG_subrange_type);
1840 AddDIEntry(DW_Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1842 AddSInt(DW_Subrange, DW_AT_lower_bound, 0, L);
1843 AddSInt(DW_Subrange, DW_AT_upper_bound, 0, H);
1845 Buffer.AddChild(DW_Subrange);
1848 /// ConstructArrayTypeDIE - Construct array type DIE from DICompositeType.
1849 void ConstructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1850 DICompositeType *CTy) {
1851 Buffer.setTag(DW_TAG_array_type);
1852 if (CTy->getTag() == DW_TAG_vector_type)
1853 AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1855 DIArray Elements = CTy->getTypeArray();
1856 AddType(DW_Unit, &Buffer, CTy->getTypeDerivedFrom());
1858 // Construct an anonymous type for index type.
1859 DIE IdxBuffer(DW_TAG_base_type);
1860 AddUInt(&IdxBuffer, DW_AT_byte_size, 0, sizeof(int32_t));
1861 AddUInt(&IdxBuffer, DW_AT_encoding, DW_FORM_data1, DW_ATE_signed);
1862 DIE *IndexTy = DW_Unit->AddDie(IdxBuffer);
1864 // Add subranges to array type.
1865 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1866 DIDescriptor Element = Elements.getElement(i);
1867 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
1868 ConstructSubrangeDIE(Buffer, DISubrange(Element.getGV()), IndexTy);
1872 /// ConstructEnumTypeDIE - Construct enum type DIE from
1874 DIE *ConstructEnumTypeDIE(CompileUnit *DW_Unit, DIEnumerator *ETy) {
1876 DIE *Enumerator = new DIE(DW_TAG_enumerator);
1877 AddString(Enumerator, DW_AT_name, DW_FORM_string, ETy->getName());
1878 int64_t Value = ETy->getEnumValue();
1879 AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
1883 /// CreateGlobalVariableDIE - Create new DIE using GV.
1884 DIE *CreateGlobalVariableDIE(CompileUnit *DW_Unit, const DIGlobalVariable &GV)
1886 DIE *GVDie = new DIE(DW_TAG_variable);
1887 AddString(GVDie, DW_AT_name, DW_FORM_string, GV.getName());
1888 const std::string &LinkageName = GV.getLinkageName();
1889 if (!LinkageName.empty())
1890 AddString(GVDie, DW_AT_MIPS_linkage_name, DW_FORM_string, LinkageName);
1891 AddType(DW_Unit, GVDie, GV.getType());
1892 if (!GV.isLocalToUnit())
1893 AddUInt(GVDie, DW_AT_external, DW_FORM_flag, 1);
1894 AddSourceLine(GVDie, &GV);
1898 /// CreateMemberDIE - Create new member DIE.
1899 DIE *CreateMemberDIE(CompileUnit *DW_Unit, const DIDerivedType &DT) {
1900 DIE *MemberDie = new DIE(DT.getTag());
1901 std::string Name = DT.getName();
1903 AddString(MemberDie, DW_AT_name, DW_FORM_string, Name);
1905 AddType(DW_Unit, MemberDie, DT.getTypeDerivedFrom());
1907 AddSourceLine(MemberDie, &DT);
1909 AddUInt(MemberDie, DW_AT_bit_size, 0, DT.getSizeInBits());
1910 DIEBlock *Block = new DIEBlock();
1911 AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
1912 AddUInt(Block, 0, DW_FORM_udata, DT.getOffsetInBits() >> 3);
1913 AddBlock(MemberDie, DW_AT_data_member_location, 0, Block);
1915 if (DT.isProtected())
1916 AddUInt(MemberDie, DW_AT_accessibility, 0, DW_ACCESS_protected);
1917 else if (DT.isPrivate())
1918 AddUInt(MemberDie, DW_AT_accessibility, 0, DW_ACCESS_private);
1923 /// CreateSubprogramDIE - Create new DIE using SP.
1924 DIE *CreateSubprogramDIE(CompileUnit *DW_Unit,
1925 const DISubprogram &SP,
1926 bool IsConstructor = false) {
1927 DIE *SPDie = new DIE(DW_TAG_subprogram);
1928 AddString(SPDie, DW_AT_name, DW_FORM_string, SP.getName());
1929 const std::string &LinkageName = SP.getLinkageName();
1930 if (!LinkageName.empty())
1931 AddString(SPDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
1933 AddSourceLine(SPDie, &SP);
1935 DICompositeType SPTy = SP.getType();
1936 DIArray Args = SPTy.getTypeArray();
1940 AddType(DW_Unit, SPDie, DIType(Args.getElement(0).getGV()));
1944 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1945 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1946 AddType(DW_Unit, Arg, DIType(Args.getElement(i).getGV()));
1947 AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1); // ???
1948 SPDie->AddChild(Arg);
1951 if (!SP.isLocalToUnit())
1952 AddUInt(SPDie, DW_AT_external, DW_FORM_flag, 1);
1956 /// FindCompileUnit - Get the compile unit for the given descriptor.
1958 CompileUnit *FindCompileUnit(DICompileUnit Unit) {
1959 CompileUnit *DW_Unit = DW_CUs[Unit.getGV()];
1960 assert(DW_Unit && "Missing compile unit.");
1964 /// NewDbgScopeVariable - Create a new scope variable.
1966 DIE *NewDbgScopeVariable(DbgVariable *DV, CompileUnit *Unit) {
1967 // Get the descriptor.
1968 const DIVariable &VD = DV->getVariable();
1970 // Translate tag to proper Dwarf tag. The result variable is dropped for
1973 switch (VD.getTag()) {
1974 case DW_TAG_return_variable: return NULL;
1975 case DW_TAG_arg_variable: Tag = DW_TAG_formal_parameter; break;
1976 case DW_TAG_auto_variable: // fall thru
1977 default: Tag = DW_TAG_variable; break;
1980 // Define variable debug information entry.
1981 DIE *VariableDie = new DIE(Tag);
1982 AddString(VariableDie, DW_AT_name, DW_FORM_string, VD.getName());
1984 // Add source line info if available.
1985 AddSourceLine(VariableDie, &VD);
1987 // Add variable type.
1988 AddType(Unit, VariableDie, VD.getType());
1990 // Add variable address.
1991 MachineLocation Location;
1992 Location.set(RI->getFrameRegister(*MF),
1993 RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
1994 AddAddress(VariableDie, DW_AT_location, Location);
1999 /// getOrCreateScope - Returns the scope associated with the given descriptor.
2001 DbgScope *getOrCreateScope(GlobalVariable *V) {
2002 DbgScope *&Slot = DbgScopeMap[V];
2004 // FIXME - breaks down when the context is an inlined function.
2005 DIDescriptor ParentDesc;
2006 DIDescriptor Desc(V);
2007 if (Desc.getTag() == dwarf::DW_TAG_lexical_block) {
2009 ParentDesc = Block.getContext();
2011 DbgScope *Parent = ParentDesc.isNull() ?
2012 NULL : getOrCreateScope(ParentDesc.getGV());
2013 Slot = new DbgScope(Parent, Desc);
2015 Parent->AddScope(Slot);
2016 } else if (RootDbgScope) {
2017 // FIXME - Add inlined function scopes to the root so we can delete
2018 // them later. Long term, handle inlined functions properly.
2019 RootDbgScope->AddScope(Slot);
2021 // First function is top level function.
2022 RootDbgScope = Slot;
2028 /// ConstructDbgScope - Construct the components of a scope.
2030 void ConstructDbgScope(DbgScope *ParentScope,
2031 unsigned ParentStartID, unsigned ParentEndID,
2032 DIE *ParentDie, CompileUnit *Unit) {
2033 // Add variables to scope.
2034 SmallVector<DbgVariable *, 8> &Variables = ParentScope->getVariables();
2035 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2036 DIE *VariableDie = NewDbgScopeVariable(Variables[i], Unit);
2037 if (VariableDie) ParentDie->AddChild(VariableDie);
2040 // Add nested scopes.
2041 SmallVector<DbgScope *, 4> &Scopes = ParentScope->getScopes();
2042 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
2043 // Define the Scope debug information entry.
2044 DbgScope *Scope = Scopes[j];
2045 // FIXME - Ignore inlined functions for the time being.
2046 if (!Scope->getParent()) continue;
2048 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
2049 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
2051 // Ignore empty scopes.
2052 if (StartID == EndID && StartID != 0) continue;
2053 if (Scope->getScopes().empty() && Scope->getVariables().empty()) continue;
2055 if (StartID == ParentStartID && EndID == ParentEndID) {
2056 // Just add stuff to the parent scope.
2057 ConstructDbgScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
2059 DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
2061 // Add the scope bounds.
2063 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2064 DWLabel("label", StartID));
2066 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2067 DWLabel("func_begin", SubprogramCount));
2070 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2071 DWLabel("label", EndID));
2073 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2074 DWLabel("func_end", SubprogramCount));
2077 // Add the scope contents.
2078 ConstructDbgScope(Scope, StartID, EndID, ScopeDie, Unit);
2079 ParentDie->AddChild(ScopeDie);
2084 /// ConstructRootDbgScope - Construct the scope for the subprogram.
2086 void ConstructRootDbgScope(DbgScope *RootScope) {
2087 // Exit if there is no root scope.
2088 if (!RootScope) return;
2089 DIDescriptor Desc = RootScope->getDesc();
2093 // Get the subprogram debug information entry.
2094 DISubprogram SPD(Desc.getGV());
2096 // Get the compile unit context.
2097 CompileUnit *Unit = FindCompileUnit(SPD.getCompileUnit());
2099 // Get the subprogram die.
2100 DIE *SPDie = Unit->getDieMapSlotFor(SPD.getGV());
2101 assert(SPDie && "Missing subprogram descriptor");
2103 // Add the function bounds.
2104 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2105 DWLabel("func_begin", SubprogramCount));
2106 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2107 DWLabel("func_end", SubprogramCount));
2108 MachineLocation Location(RI->getFrameRegister(*MF));
2109 AddAddress(SPDie, DW_AT_frame_base, Location);
2111 ConstructDbgScope(RootScope, 0, 0, SPDie, Unit);
2114 /// ConstructDefaultDbgScope - Construct a default scope for the subprogram.
2116 void ConstructDefaultDbgScope(MachineFunction *MF) {
2117 // Find the correct subprogram descriptor.
2118 std::string SPName = "llvm.dbg.subprograms";
2119 std::vector<GlobalVariable*> Result;
2120 getGlobalVariablesUsing(*M, SPName, Result);
2121 for (std::vector<GlobalVariable *>::iterator I = Result.begin(),
2122 E = Result.end(); I != E; ++I) {
2124 DISubprogram SPD(*I);
2126 if (SPD.getName() == MF->getFunction()->getName()) {
2127 // Get the compile unit context.
2128 CompileUnit *Unit = FindCompileUnit(SPD.getCompileUnit());
2130 // Get the subprogram die.
2131 DIE *SPDie = Unit->getDieMapSlotFor(SPD.getGV());
2132 assert(SPDie && "Missing subprogram descriptor");
2134 // Add the function bounds.
2135 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2136 DWLabel("func_begin", SubprogramCount));
2137 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2138 DWLabel("func_end", SubprogramCount));
2140 MachineLocation Location(RI->getFrameRegister(*MF));
2141 AddAddress(SPDie, DW_AT_frame_base, Location);
2146 // FIXME: This is causing an abort because C++ mangled names are compared
2147 // with their unmangled counterparts. See PR2885. Don't do this assert.
2148 assert(0 && "Couldn't find DIE for machine function!");
2152 /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
2153 /// tools to recognize the object file contains Dwarf information.
2154 void EmitInitial() {
2155 // Check to see if we already emitted intial headers.
2156 if (didInitial) return;
2159 // Dwarf sections base addresses.
2160 if (TAI->doesDwarfRequireFrameSection()) {
2161 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2162 EmitLabel("section_debug_frame", 0);
2164 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2165 EmitLabel("section_info", 0);
2166 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2167 EmitLabel("section_abbrev", 0);
2168 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2169 EmitLabel("section_aranges", 0);
2170 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2171 EmitLabel("section_macinfo", 0);
2172 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2173 EmitLabel("section_line", 0);
2174 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2175 EmitLabel("section_loc", 0);
2176 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2177 EmitLabel("section_pubnames", 0);
2178 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2179 EmitLabel("section_str", 0);
2180 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2181 EmitLabel("section_ranges", 0);
2183 Asm->SwitchToSection(TAI->getTextSection());
2184 EmitLabel("text_begin", 0);
2185 Asm->SwitchToSection(TAI->getDataSection());
2186 EmitLabel("data_begin", 0);
2189 /// EmitDIE - Recusively Emits a debug information entry.
2191 void EmitDIE(DIE *Die) {
2192 // Get the abbreviation for this DIE.
2193 unsigned AbbrevNumber = Die->getAbbrevNumber();
2194 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2198 // Emit the code (index) for the abbreviation.
2199 Asm->EmitULEB128Bytes(AbbrevNumber);
2202 Asm->EOL(std::string("Abbrev [" +
2203 utostr(AbbrevNumber) +
2204 "] 0x" + utohexstr(Die->getOffset()) +
2205 ":0x" + utohexstr(Die->getSize()) + " " +
2206 TagString(Abbrev->getTag())));
2210 SmallVector<DIEValue*, 32> &Values = Die->getValues();
2211 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2213 // Emit the DIE attribute values.
2214 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2215 unsigned Attr = AbbrevData[i].getAttribute();
2216 unsigned Form = AbbrevData[i].getForm();
2217 assert(Form && "Too many attributes for DIE (check abbreviation)");
2220 case DW_AT_sibling: {
2221 Asm->EmitInt32(Die->SiblingOffset());
2225 // Emit an attribute using the defined form.
2226 Values[i]->EmitValue(*this, Form);
2231 Asm->EOL(AttributeString(Attr));
2234 // Emit the DIE children if any.
2235 if (Abbrev->getChildrenFlag() == DW_CHILDREN_yes) {
2236 const std::vector<DIE *> &Children = Die->getChildren();
2238 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2239 EmitDIE(Children[j]);
2242 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2246 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
2248 unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
2249 // Get the children.
2250 const std::vector<DIE *> &Children = Die->getChildren();
2252 // If not last sibling and has children then add sibling offset attribute.
2253 if (!Last && !Children.empty()) Die->AddSiblingOffset();
2255 // Record the abbreviation.
2256 AssignAbbrevNumber(Die->getAbbrev());
2258 // Get the abbreviation for this DIE.
2259 unsigned AbbrevNumber = Die->getAbbrevNumber();
2260 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2263 Die->setOffset(Offset);
2265 // Start the size with the size of abbreviation code.
2266 Offset += TargetAsmInfo::getULEB128Size(AbbrevNumber);
2268 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2269 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2271 // Size the DIE attribute values.
2272 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2273 // Size attribute value.
2274 Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
2277 // Size the DIE children if any.
2278 if (!Children.empty()) {
2279 assert(Abbrev->getChildrenFlag() == DW_CHILDREN_yes &&
2280 "Children flag not set");
2282 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2283 Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
2286 // End of children marker.
2287 Offset += sizeof(int8_t);
2290 Die->setSize(Offset - Die->getOffset());
2294 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
2296 void SizeAndOffsets() {
2297 // Process base compile unit.
2298 for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
2299 CE = DW_CUs.end(); CI != CE; ++CI) {
2300 CompileUnit *Unit = CI->second;
2301 // Compute size of compile unit header
2302 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2303 sizeof(int16_t) + // DWARF version number
2304 sizeof(int32_t) + // Offset Into Abbrev. Section
2305 sizeof(int8_t); // Pointer Size (in bytes)
2306 SizeAndOffsetDie(Unit->getDie(), Offset, true);
2310 /// EmitDebugInfo - Emit the debug info section.
2312 void EmitDebugInfo() {
2313 // Start debug info section.
2314 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2316 for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
2317 CE = DW_CUs.end(); CI != CE; ++CI) {
2318 CompileUnit *Unit = CI->second;
2319 DIE *Die = Unit->getDie();
2320 // Emit the compile units header.
2321 EmitLabel("info_begin", Unit->getID());
2322 // Emit size of content not including length itself
2323 unsigned ContentSize = Die->getSize() +
2324 sizeof(int16_t) + // DWARF version number
2325 sizeof(int32_t) + // Offset Into Abbrev. Section
2326 sizeof(int8_t) + // Pointer Size (in bytes)
2327 sizeof(int32_t); // FIXME - extra pad for gdb bug.
2329 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2330 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2331 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2332 Asm->EOL("Offset Into Abbrev. Section");
2333 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2336 // FIXME - extra padding for gdb bug.
2337 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2338 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2339 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2340 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2341 EmitLabel("info_end", Unit->getID());
2347 /// EmitAbbreviations - Emit the abbreviation section.
2349 void EmitAbbreviations() const {
2350 // Check to see if it is worth the effort.
2351 if (!Abbreviations.empty()) {
2352 // Start the debug abbrev section.
2353 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2355 EmitLabel("abbrev_begin", 0);
2357 // For each abbrevation.
2358 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2359 // Get abbreviation data
2360 const DIEAbbrev *Abbrev = Abbreviations[i];
2362 // Emit the abbrevations code (base 1 index.)
2363 Asm->EmitULEB128Bytes(Abbrev->getNumber());
2364 Asm->EOL("Abbreviation Code");
2366 // Emit the abbreviations data.
2367 Abbrev->Emit(*this);
2372 // Mark end of abbreviations.
2373 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2375 EmitLabel("abbrev_end", 0);
2381 /// EmitEndOfLineMatrix - Emit the last address of the section and the end of
2382 /// the line matrix.
2384 void EmitEndOfLineMatrix(unsigned SectionEnd) {
2385 // Define last address of section.
2386 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2387 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2388 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2389 EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
2391 // Mark end of matrix.
2392 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2393 Asm->EmitULEB128Bytes(1); Asm->EOL();
2394 Asm->EmitInt8(1); Asm->EOL();
2397 /// EmitDebugLines - Emit source line information.
2399 void EmitDebugLines() {
2400 // If the target is using .loc/.file, the assembler will be emitting the
2401 // .debug_line table automatically.
2402 if (TAI->hasDotLocAndDotFile())
2405 // Minimum line delta, thus ranging from -10..(255-10).
2406 const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
2407 // Maximum line delta, thus ranging from -10..(255-10).
2408 const int MaxLineDelta = 255 + MinLineDelta;
2410 // Start the dwarf line section.
2411 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2413 // Construct the section header.
2415 EmitDifference("line_end", 0, "line_begin", 0, true);
2416 Asm->EOL("Length of Source Line Info");
2417 EmitLabel("line_begin", 0);
2419 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2421 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2422 Asm->EOL("Prolog Length");
2423 EmitLabel("line_prolog_begin", 0);
2425 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2427 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2429 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
2431 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2433 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
2435 // Line number standard opcode encodings argument count
2436 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2437 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2438 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2439 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2440 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2441 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2442 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2443 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2444 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2446 // Emit directories.
2447 for (unsigned DirectoryID = 1, NDID = Directories.size();
2448 DirectoryID <= NDID; ++DirectoryID) {
2449 Asm->EmitString(Directories[DirectoryID]); Asm->EOL("Directory");
2451 Asm->EmitInt8(0); Asm->EOL("End of directories");
2454 for (unsigned SourceID = 1, NSID = SrcFiles.size();
2455 SourceID <= NSID; ++SourceID) {
2456 const SrcFileInfo &SourceFile = SrcFiles[SourceID];
2457 Asm->EmitString(SourceFile.getName());
2459 Asm->EmitULEB128Bytes(SourceFile.getDirectoryID());
2460 Asm->EOL("Directory #");
2461 Asm->EmitULEB128Bytes(0);
2462 Asm->EOL("Mod date");
2463 Asm->EmitULEB128Bytes(0);
2464 Asm->EOL("File size");
2466 Asm->EmitInt8(0); Asm->EOL("End of files");
2468 EmitLabel("line_prolog_end", 0);
2470 // A sequence for each text section.
2471 unsigned SecSrcLinesSize = SectionSourceLines.size();
2473 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
2474 // Isolate current sections line info.
2475 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
2478 const Section* S = SectionMap[j + 1];
2479 Asm->EOL(std::string("Section ") + S->getName());
2483 // Dwarf assumes we start with first line of first source file.
2484 unsigned Source = 1;
2487 // Construct rows of the address, source, line, column matrix.
2488 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2489 const SrcLineInfo &LineInfo = LineInfos[i];
2490 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2491 if (!LabelID) continue;
2493 unsigned SourceID = LineInfo.getSourceID();
2494 const SrcFileInfo &SourceFile = SrcFiles[SourceID];
2495 unsigned DirectoryID = SourceFile.getDirectoryID();
2497 Asm->EOL(Directories[DirectoryID]
2498 + SourceFile.getName()
2500 + utostr_32(LineInfo.getLine()));
2504 // Define the line address.
2505 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2506 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2507 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2508 EmitReference("label", LabelID); Asm->EOL("Location label");
2510 // If change of source, then switch to the new source.
2511 if (Source != LineInfo.getSourceID()) {
2512 Source = LineInfo.getSourceID();
2513 Asm->EmitInt8(DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2514 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2517 // If change of line.
2518 if (Line != LineInfo.getLine()) {
2519 // Determine offset.
2520 int Offset = LineInfo.getLine() - Line;
2521 int Delta = Offset - MinLineDelta;
2524 Line = LineInfo.getLine();
2526 // If delta is small enough and in range...
2527 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2528 // ... then use fast opcode.
2529 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2531 // ... otherwise use long hand.
2532 Asm->EmitInt8(DW_LNS_advance_line); Asm->EOL("DW_LNS_advance_line");
2533 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2534 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2537 // Copy the previous row (different address or source)
2538 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2542 EmitEndOfLineMatrix(j + 1);
2545 if (SecSrcLinesSize == 0)
2546 // Because we're emitting a debug_line section, we still need a line
2547 // table. The linker and friends expect it to exist. If there's nothing to
2548 // put into it, emit an empty table.
2549 EmitEndOfLineMatrix(1);
2551 EmitLabel("line_end", 0);
2556 /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
2558 void EmitCommonDebugFrame() {
2559 if (!TAI->doesDwarfRequireFrameSection())
2563 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2564 TargetFrameInfo::StackGrowsUp ?
2565 TD->getPointerSize() : -TD->getPointerSize();
2567 // Start the dwarf frame section.
2568 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2570 EmitLabel("debug_frame_common", 0);
2571 EmitDifference("debug_frame_common_end", 0,
2572 "debug_frame_common_begin", 0, true);
2573 Asm->EOL("Length of Common Information Entry");
2575 EmitLabel("debug_frame_common_begin", 0);
2576 Asm->EmitInt32((int)DW_CIE_ID);
2577 Asm->EOL("CIE Identifier Tag");
2578 Asm->EmitInt8(DW_CIE_VERSION);
2579 Asm->EOL("CIE Version");
2580 Asm->EmitString("");
2581 Asm->EOL("CIE Augmentation");
2582 Asm->EmitULEB128Bytes(1);
2583 Asm->EOL("CIE Code Alignment Factor");
2584 Asm->EmitSLEB128Bytes(stackGrowth);
2585 Asm->EOL("CIE Data Alignment Factor");
2586 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
2587 Asm->EOL("CIE RA Column");
2589 std::vector<MachineMove> Moves;
2590 RI->getInitialFrameState(Moves);
2592 EmitFrameMoves(NULL, 0, Moves, false);
2594 Asm->EmitAlignment(2, 0, 0, false);
2595 EmitLabel("debug_frame_common_end", 0);
2600 /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2602 void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
2603 if (!TAI->doesDwarfRequireFrameSection())
2606 // Start the dwarf frame section.
2607 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2609 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2610 "debug_frame_begin", DebugFrameInfo.Number, true);
2611 Asm->EOL("Length of Frame Information Entry");
2613 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2615 EmitSectionOffset("debug_frame_common", "section_debug_frame",
2617 Asm->EOL("FDE CIE offset");
2619 EmitReference("func_begin", DebugFrameInfo.Number);
2620 Asm->EOL("FDE initial location");
2621 EmitDifference("func_end", DebugFrameInfo.Number,
2622 "func_begin", DebugFrameInfo.Number);
2623 Asm->EOL("FDE address range");
2625 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves,
2628 Asm->EmitAlignment(2, 0, 0, false);
2629 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
2634 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
2636 void EmitDebugPubNames() {
2637 // Start the dwarf pubnames section.
2638 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2640 for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
2641 CE = DW_CUs.end(); CI != CE; ++CI) {
2642 CompileUnit *Unit = CI->second;
2644 EmitDifference("pubnames_end", Unit->getID(),
2645 "pubnames_begin", Unit->getID(), true);
2646 Asm->EOL("Length of Public Names Info");
2648 EmitLabel("pubnames_begin", Unit->getID());
2650 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF Version");
2652 EmitSectionOffset("info_begin", "section_info",
2653 Unit->getID(), 0, true, false);
2654 Asm->EOL("Offset of Compilation Unit Info");
2656 EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(),
2658 Asm->EOL("Compilation Unit Length");
2660 std::map<std::string, DIE *> &Globals = Unit->getGlobals();
2662 for (std::map<std::string, DIE *>::iterator GI = Globals.begin(),
2665 const std::string &Name = GI->first;
2666 DIE * Entity = GI->second;
2668 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2669 Asm->EmitString(Name); Asm->EOL("External Name");
2672 Asm->EmitInt32(0); Asm->EOL("End Mark");
2673 EmitLabel("pubnames_end", Unit->getID());
2679 /// EmitDebugStr - Emit visible names into a debug str section.
2681 void EmitDebugStr() {
2682 // Check to see if it is worth the effort.
2683 if (!StringPool.empty()) {
2684 // Start the dwarf str section.
2685 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2687 // For each of strings in the string pool.
2688 for (unsigned StringID = 1, N = StringPool.size();
2689 StringID <= N; ++StringID) {
2690 // Emit a label for reference from debug information entries.
2691 EmitLabel("string", StringID);
2692 // Emit the string itself.
2693 const std::string &String = StringPool[StringID];
2694 Asm->EmitString(String); Asm->EOL();
2701 /// EmitDebugLoc - Emit visible names into a debug loc section.
2703 void EmitDebugLoc() {
2704 // Start the dwarf loc section.
2705 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2710 /// EmitDebugARanges - Emit visible names into a debug aranges section.
2712 void EmitDebugARanges() {
2713 // Start the dwarf aranges section.
2714 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2718 CompileUnit *Unit = GetBaseCompileUnit();
2720 // Don't include size of length
2721 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
2723 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("Dwarf Version");
2725 EmitReference("info_begin", Unit->getID());
2726 Asm->EOL("Offset of Compilation Unit Info");
2728 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
2730 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
2732 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
2733 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
2736 EmitReference("text_begin", 0); Asm->EOL("Address");
2737 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
2739 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2740 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
2746 /// EmitDebugRanges - Emit visible names into a debug ranges section.
2748 void EmitDebugRanges() {
2749 // Start the dwarf ranges section.
2750 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2755 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
2757 void EmitDebugMacInfo() {
2758 // Start the dwarf macinfo section.
2759 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2764 /// ConstructCompileUnits - Create a compile unit DIEs.
2765 void ConstructCompileUnits() {
2766 std::string CUName = "llvm.dbg.compile_units";
2767 std::vector<GlobalVariable*> Result;
2768 getGlobalVariablesUsing(*M, CUName, Result);
2769 for (std::vector<GlobalVariable *>::iterator RI = Result.begin(),
2770 RE = Result.end(); RI != RE; ++RI) {
2771 DICompileUnit DIUnit(*RI);
2772 unsigned ID = RecordSource(DIUnit.getDirectory(),
2773 DIUnit.getFilename());
2775 DIE *Die = new DIE(DW_TAG_compile_unit);
2776 AddSectionOffset(Die, DW_AT_stmt_list, DW_FORM_data4,
2777 DWLabel("section_line", 0), DWLabel("section_line", 0),
2779 AddString(Die, DW_AT_producer, DW_FORM_string, DIUnit.getProducer());
2780 AddUInt(Die, DW_AT_language, DW_FORM_data1, DIUnit.getLanguage());
2781 AddString(Die, DW_AT_name, DW_FORM_string, DIUnit.getFilename());
2782 if (!DIUnit.getDirectory().empty())
2783 AddString(Die, DW_AT_comp_dir, DW_FORM_string, DIUnit.getDirectory());
2784 if (DIUnit.isOptimized())
2785 AddUInt(Die, DW_AT_APPLE_optimized, DW_FORM_flag, 1);
2786 const std::string &Flags = DIUnit.getFlags();
2788 AddString(Die, DW_AT_APPLE_flags, DW_FORM_string, Flags);
2790 CompileUnit *Unit = new CompileUnit(ID, Die);
2791 DW_CUs[DIUnit.getGV()] = Unit;
2795 /// ConstructGlobalVariableDIEs - Create DIEs for each of the externally
2796 /// visible global variables.
2797 void ConstructGlobalVariableDIEs() {
2798 std::string GVName = "llvm.dbg.global_variables";
2799 std::vector<GlobalVariable*> Result;
2800 getGlobalVariablesUsing(*M, GVName, Result);
2801 for (std::vector<GlobalVariable *>::iterator GVI = Result.begin(),
2802 GVE = Result.end(); GVI != GVE; ++GVI) {
2803 DIGlobalVariable DI_GV(*GVI);
2804 CompileUnit *DW_Unit = FindCompileUnit(DI_GV.getCompileUnit());
2806 // Check for pre-existence.
2807 DIE *&Slot = DW_Unit->getDieMapSlotFor(DI_GV.getGV());
2810 DIE *VariableDie = CreateGlobalVariableDIE(DW_Unit, DI_GV);
2813 DIEBlock *Block = new DIEBlock();
2814 AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
2815 AddObjectLabel(Block, 0, DW_FORM_udata,
2816 Asm->getGlobalLinkName(DI_GV.getGlobal()));
2817 AddBlock(VariableDie, DW_AT_location, 0, Block);
2822 //Add to context owner.
2823 DW_Unit->getDie()->AddChild(VariableDie);
2825 //Expose as global. FIXME - need to check external flag.
2826 DW_Unit->AddGlobal(DI_GV.getName(), VariableDie);
2830 /// ConstructSubprograms - Create DIEs for each of the externally visible
2832 void ConstructSubprograms() {
2834 std::string SPName = "llvm.dbg.subprograms";
2835 std::vector<GlobalVariable*> Result;
2836 getGlobalVariablesUsing(*M, SPName, Result);
2837 for (std::vector<GlobalVariable *>::iterator RI = Result.begin(),
2838 RE = Result.end(); RI != RE; ++RI) {
2840 DISubprogram SP(*RI);
2841 CompileUnit *Unit = FindCompileUnit(SP.getCompileUnit());
2843 // Check for pre-existence.
2844 DIE *&Slot = Unit->getDieMapSlotFor(SP.getGV());
2847 DIE *SubprogramDie = CreateSubprogramDIE(Unit, SP);
2850 Slot = SubprogramDie;
2851 //Add to context owner.
2852 Unit->getDie()->AddChild(SubprogramDie);
2854 Unit->AddGlobal(SP.getName(), SubprogramDie);
2859 //===--------------------------------------------------------------------===//
2860 // Main entry points.
2862 DwarfDebug(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
2863 : Dwarf(OS, A, T, "dbg")
2864 , AbbreviationsSet(InitAbbreviationsSetSize)
2866 , ValuesSet(InitValuesSetSize)
2870 , SectionSourceLines()
2873 , RootDbgScope(NULL)
2876 virtual ~DwarfDebug() {
2877 for (unsigned j = 0, M = Values.size(); j < M; ++j)
2881 /// SetDebugInfo - Create global DIEs and emit initial debug info sections.
2882 /// This is inovked by the target AsmPrinter.
2883 void SetDebugInfo(MachineModuleInfo *mmi) {
2885 // Create all the compile unit DIEs.
2886 ConstructCompileUnits();
2893 MMI->setDebugInfoAvailability(true);
2895 // Create DIEs for each of the externally visible global variables.
2896 ConstructGlobalVariableDIEs();
2898 // Create DIEs for each of the externally visible subprograms.
2899 ConstructSubprograms();
2901 // Prime section data.
2902 SectionMap.insert(TAI->getTextSection());
2904 // Print out .file directives to specify files for .loc directives. These
2905 // are printed out early so that they precede any .loc directives.
2906 if (TAI->hasDotLocAndDotFile()) {
2907 for (unsigned i = 1, e = SrcFiles.size(); i <= e; ++i) {
2908 sys::Path FullPath(Directories[SrcFiles[i].getDirectoryID()]);
2909 bool AppendOk = FullPath.appendComponent(SrcFiles[i].getName());
2910 assert(AppendOk && "Could not append filename to directory!");
2912 Asm->EmitFile(i, FullPath.toString());
2917 // Emit initial sections
2921 /// BeginModule - Emit all Dwarf sections that should come prior to the
2923 void BeginModule(Module *M) {
2927 /// EndModule - Emit all Dwarf sections that should come after the content.
2930 if (!ShouldEmitDwarf()) return;
2932 // Standard sections final addresses.
2933 Asm->SwitchToSection(TAI->getTextSection());
2934 EmitLabel("text_end", 0);
2935 Asm->SwitchToSection(TAI->getDataSection());
2936 EmitLabel("data_end", 0);
2938 // End text sections.
2939 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
2940 Asm->SwitchToSection(SectionMap[i]);
2941 EmitLabel("section_end", i);
2944 // Emit common frame information.
2945 EmitCommonDebugFrame();
2947 // Emit function debug frame information
2948 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2949 E = DebugFrames.end(); I != E; ++I)
2950 EmitFunctionDebugFrame(*I);
2952 // Compute DIE offsets and sizes.
2955 // Emit all the DIEs into a debug info section
2958 // Corresponding abbreviations into a abbrev section.
2959 EmitAbbreviations();
2961 // Emit source line correspondence into a debug line section.
2964 // Emit info into a debug pubnames section.
2965 EmitDebugPubNames();
2967 // Emit info into a debug str section.
2970 // Emit info into a debug loc section.
2973 // Emit info into a debug aranges section.
2976 // Emit info into a debug ranges section.
2979 // Emit info into a debug macinfo section.
2983 /// BeginFunction - Gather pre-function debug information. Assumes being
2984 /// emitted immediately after the function entry point.
2985 void BeginFunction(MachineFunction *MF) {
2988 if (!ShouldEmitDwarf()) return;
2990 // Begin accumulating function debug information.
2991 MMI->BeginFunction(MF);
2993 // Assumes in correct section after the entry point.
2994 EmitLabel("func_begin", ++SubprogramCount);
2996 // Emit label for the implicitly defined dbg.stoppoint at the start of
2998 if (!Lines.empty()) {
2999 const SrcLineInfo &LineInfo = Lines[0];
3000 Asm->printLabel(LineInfo.getLabelID());
3004 /// EndFunction - Gather and emit post-function debug information.
3006 void EndFunction(MachineFunction *MF) {
3007 if (!ShouldEmitDwarf()) return;
3009 // Define end label for subprogram.
3010 EmitLabel("func_end", SubprogramCount);
3012 // Get function line info.
3013 if (!Lines.empty()) {
3014 // Get section line info.
3015 unsigned ID = SectionMap.insert(Asm->CurrentSection_);
3016 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
3017 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
3018 // Append the function info to section info.
3019 SectionLineInfos.insert(SectionLineInfos.end(),
3020 Lines.begin(), Lines.end());
3023 // Construct scopes for subprogram.
3025 ConstructRootDbgScope(RootDbgScope);
3027 // FIXME: This is wrong. We are essentially getting past a problem with
3028 // debug information not being able to handle unreachable blocks that have
3029 // debug information in them. In particular, those unreachable blocks that
3030 // have "region end" info in them. That situation results in the "root
3031 // scope" not being created. If that's the case, then emit a "default"
3032 // scope, i.e., one that encompasses the whole function. This isn't
3033 // desirable. And a better way of handling this (and all of the debugging
3034 // information) needs to be explored.
3035 ConstructDefaultDbgScope(MF);
3037 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
3038 MMI->getFrameMoves()));
3042 delete RootDbgScope;
3043 DbgScopeMap.clear();
3044 RootDbgScope = NULL;
3051 /// ValidDebugInfo - Return true if V represents valid debug info value.
3052 bool ValidDebugInfo(Value *V) {
3060 GlobalVariable *GV = getGlobalVariable(V);
3064 if (GV->getLinkage() != GlobalValue::InternalLinkage
3065 && GV->getLinkage() != GlobalValue::LinkOnceLinkage)
3068 DIDescriptor DI(GV);
3069 // Check current version. Allow Version6 for now.
3070 unsigned Version = DI.getVersion();
3071 if (Version != LLVMDebugVersion && Version != LLVMDebugVersion6)
3074 unsigned Tag = DI.getTag();
3076 case DW_TAG_variable:
3077 assert (DIVariable(GV).Verify() && "Invalid DebugInfo value");
3079 case DW_TAG_compile_unit:
3080 assert (DICompileUnit(GV).Verify() && "Invalid DebugInfo value");
3082 case DW_TAG_subprogram:
3083 assert (DISubprogram(GV).Verify() && "Invalid DebugInfo value");
3092 /// RecordSourceLine - Records location information and associates it with a
3093 /// label. Returns a unique label ID used to generate a label and provide
3094 /// correspondence to the source line list.
3095 unsigned RecordSourceLine(Value *V, unsigned Line, unsigned Col) {
3096 CompileUnit *Unit = DW_CUs[V];
3097 assert (Unit && "Unable to find CompileUnit");
3098 unsigned ID = MMI->NextLabelID();
3099 Lines.push_back(SrcLineInfo(Line, Col, Unit->getID(), ID));
3103 /// RecordSourceLine - Records location information and associates it with a
3104 /// label. Returns a unique label ID used to generate a label and provide
3105 /// correspondence to the source line list.
3106 unsigned RecordSourceLine(unsigned Line, unsigned Col, unsigned Src) {
3107 unsigned ID = MMI->NextLabelID();
3108 Lines.push_back(SrcLineInfo(Line, Col, Src, ID));
3112 unsigned getRecordSourceLineCount() {
3113 return Lines.size();
3116 /// RecordSource - Register a source file with debug info. Returns an source
3118 unsigned RecordSource(const std::string &Directory,
3119 const std::string &File) {
3120 unsigned DID = Directories.insert(Directory);
3121 return SrcFiles.insert(SrcFileInfo(DID,File));
3124 /// RecordRegionStart - Indicate the start of a region.
3126 unsigned RecordRegionStart(GlobalVariable *V) {
3127 DbgScope *Scope = getOrCreateScope(V);
3128 unsigned ID = MMI->NextLabelID();
3129 if (!Scope->getStartLabelID()) Scope->setStartLabelID(ID);
3133 /// RecordRegionEnd - Indicate the end of a region.
3135 unsigned RecordRegionEnd(GlobalVariable *V) {
3136 DbgScope *Scope = getOrCreateScope(V);
3137 unsigned ID = MMI->NextLabelID();
3138 Scope->setEndLabelID(ID);
3142 /// RecordVariable - Indicate the declaration of a local variable.
3144 void RecordVariable(GlobalVariable *GV, unsigned FrameIndex) {
3145 DIDescriptor Desc(GV);
3146 DbgScope *Scope = NULL;
3147 if (Desc.getTag() == DW_TAG_variable) {
3148 // GV is a global variable.
3149 DIGlobalVariable DG(GV);
3150 Scope = getOrCreateScope(DG.getContext().getGV());
3152 // or GV is a local variable.
3154 Scope = getOrCreateScope(DV.getContext().getGV());
3156 assert (Scope && "Unable to find variable' scope");
3157 DbgVariable *DV = new DbgVariable(DIVariable(GV), FrameIndex);
3158 Scope->AddVariable(DV);
3162 //===----------------------------------------------------------------------===//
3163 /// DwarfException - Emits Dwarf exception handling directives.
3165 class DwarfException : public Dwarf {
3168 struct FunctionEHFrameInfo {
3171 unsigned PersonalityIndex;
3173 bool hasLandingPads;
3174 std::vector<MachineMove> Moves;
3175 const Function * function;
3177 FunctionEHFrameInfo(const std::string &FN, unsigned Num, unsigned P,
3179 const std::vector<MachineMove> &M,
3181 FnName(FN), Number(Num), PersonalityIndex(P),
3182 hasCalls(hC), hasLandingPads(hL), Moves(M), function (f) { }
3185 std::vector<FunctionEHFrameInfo> EHFrames;
3187 /// shouldEmitTable - Per-function flag to indicate if EH tables should
3189 bool shouldEmitTable;
3191 /// shouldEmitMoves - Per-function flag to indicate if frame moves info
3192 /// should be emitted.
3193 bool shouldEmitMoves;
3195 /// shouldEmitTableModule - Per-module flag to indicate if EH tables
3196 /// should be emitted.
3197 bool shouldEmitTableModule;
3199 /// shouldEmitFrameModule - Per-module flag to indicate if frame moves
3200 /// should be emitted.
3201 bool shouldEmitMovesModule;
3203 /// EmitCommonEHFrame - Emit the common eh unwind frame.
3205 void EmitCommonEHFrame(const Function *Personality, unsigned Index) {
3206 // Size and sign of stack growth.
3208 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3209 TargetFrameInfo::StackGrowsUp ?
3210 TD->getPointerSize() : -TD->getPointerSize();
3212 // Begin eh frame section.
3213 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3215 if (!TAI->doesRequireNonLocalEHFrameLabel())
3216 O << TAI->getEHGlobalPrefix();
3217 O << "EH_frame" << Index << ":\n";
3218 EmitLabel("section_eh_frame", Index);
3220 // Define base labels.
3221 EmitLabel("eh_frame_common", Index);
3223 // Define the eh frame length.
3224 EmitDifference("eh_frame_common_end", Index,
3225 "eh_frame_common_begin", Index, true);
3226 Asm->EOL("Length of Common Information Entry");
3229 EmitLabel("eh_frame_common_begin", Index);
3230 Asm->EmitInt32((int)0);
3231 Asm->EOL("CIE Identifier Tag");
3232 Asm->EmitInt8(DW_CIE_VERSION);
3233 Asm->EOL("CIE Version");
3235 // The personality presence indicates that language specific information
3236 // will show up in the eh frame.
3237 Asm->EmitString(Personality ? "zPLR" : "zR");
3238 Asm->EOL("CIE Augmentation");
3240 // Round out reader.
3241 Asm->EmitULEB128Bytes(1);
3242 Asm->EOL("CIE Code Alignment Factor");
3243 Asm->EmitSLEB128Bytes(stackGrowth);
3244 Asm->EOL("CIE Data Alignment Factor");
3245 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), true));
3246 Asm->EOL("CIE Return Address Column");
3248 // If there is a personality, we need to indicate the functions location.
3250 Asm->EmitULEB128Bytes(7);
3251 Asm->EOL("Augmentation Size");
3253 if (TAI->getNeedsIndirectEncoding()) {
3254 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4 | DW_EH_PE_indirect);
3255 Asm->EOL("Personality (pcrel sdata4 indirect)");
3257 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3258 Asm->EOL("Personality (pcrel sdata4)");
3261 PrintRelDirective(true);
3262 O << TAI->getPersonalityPrefix();
3263 Asm->EmitExternalGlobal((const GlobalVariable *)(Personality));
3264 O << TAI->getPersonalitySuffix();
3265 if (strcmp(TAI->getPersonalitySuffix(), "+4@GOTPCREL"))
3266 O << "-" << TAI->getPCSymbol();
3267 Asm->EOL("Personality");
3269 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3270 Asm->EOL("LSDA Encoding (pcrel sdata4)");
3272 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3273 Asm->EOL("FDE Encoding (pcrel sdata4)");
3275 Asm->EmitULEB128Bytes(1);
3276 Asm->EOL("Augmentation Size");
3278 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3279 Asm->EOL("FDE Encoding (pcrel sdata4)");
3282 // Indicate locations of general callee saved registers in frame.
3283 std::vector<MachineMove> Moves;
3284 RI->getInitialFrameState(Moves);
3285 EmitFrameMoves(NULL, 0, Moves, true);
3287 // On Darwin the linker honors the alignment of eh_frame, which means it
3288 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3289 // you get holes which confuse readers of eh_frame.
3290 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
3292 EmitLabel("eh_frame_common_end", Index);
3297 /// EmitEHFrame - Emit function exception frame information.
3299 void EmitEHFrame(const FunctionEHFrameInfo &EHFrameInfo) {
3300 Function::LinkageTypes linkage = EHFrameInfo.function->getLinkage();
3302 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3304 // Externally visible entry into the functions eh frame info.
3305 // If the corresponding function is static, this should not be
3306 // externally visible.
3307 if (linkage != Function::InternalLinkage &&
3308 linkage != Function::PrivateLinkage) {
3309 if (const char *GlobalEHDirective = TAI->getGlobalEHDirective())
3310 O << GlobalEHDirective << EHFrameInfo.FnName << "\n";
3313 // If corresponding function is weak definition, this should be too.
3314 if ((linkage == Function::WeakLinkage ||
3315 linkage == Function::LinkOnceLinkage) &&
3316 TAI->getWeakDefDirective())
3317 O << TAI->getWeakDefDirective() << EHFrameInfo.FnName << "\n";
3319 // If there are no calls then you can't unwind. This may mean we can
3320 // omit the EH Frame, but some environments do not handle weak absolute
3322 // If UnwindTablesMandatory is set we cannot do this optimization; the
3323 // unwind info is to be available for non-EH uses.
3324 if (!EHFrameInfo.hasCalls &&
3325 !UnwindTablesMandatory &&
3326 ((linkage != Function::WeakLinkage &&
3327 linkage != Function::LinkOnceLinkage) ||
3328 !TAI->getWeakDefDirective() ||
3329 TAI->getSupportsWeakOmittedEHFrame()))
3331 O << EHFrameInfo.FnName << " = 0\n";
3332 // This name has no connection to the function, so it might get
3333 // dead-stripped when the function is not, erroneously. Prohibit
3334 // dead-stripping unconditionally.
3335 if (const char *UsedDirective = TAI->getUsedDirective())
3336 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3338 O << EHFrameInfo.FnName << ":\n";
3341 EmitDifference("eh_frame_end", EHFrameInfo.Number,
3342 "eh_frame_begin", EHFrameInfo.Number, true);
3343 Asm->EOL("Length of Frame Information Entry");
3345 EmitLabel("eh_frame_begin", EHFrameInfo.Number);
3347 if (TAI->doesRequireNonLocalEHFrameLabel()) {
3348 PrintRelDirective(true, true);
3349 PrintLabelName("eh_frame_begin", EHFrameInfo.Number);
3351 if (!TAI->isAbsoluteEHSectionOffsets())
3352 O << "-EH_frame" << EHFrameInfo.PersonalityIndex;
3354 EmitSectionOffset("eh_frame_begin", "eh_frame_common",
3355 EHFrameInfo.Number, EHFrameInfo.PersonalityIndex,
3359 Asm->EOL("FDE CIE offset");
3361 EmitReference("eh_func_begin", EHFrameInfo.Number, true, true);
3362 Asm->EOL("FDE initial location");
3363 EmitDifference("eh_func_end", EHFrameInfo.Number,
3364 "eh_func_begin", EHFrameInfo.Number, true);
3365 Asm->EOL("FDE address range");
3367 // If there is a personality and landing pads then point to the language
3368 // specific data area in the exception table.
3369 if (EHFrameInfo.PersonalityIndex) {
3370 Asm->EmitULEB128Bytes(4);
3371 Asm->EOL("Augmentation size");
3373 if (EHFrameInfo.hasLandingPads)
3374 EmitReference("exception", EHFrameInfo.Number, true, true);
3376 Asm->EmitInt32((int)0);
3377 Asm->EOL("Language Specific Data Area");
3379 Asm->EmitULEB128Bytes(0);
3380 Asm->EOL("Augmentation size");
3383 // Indicate locations of function specific callee saved registers in
3385 EmitFrameMoves("eh_func_begin", EHFrameInfo.Number, EHFrameInfo.Moves,
3388 // On Darwin the linker honors the alignment of eh_frame, which means it
3389 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3390 // you get holes which confuse readers of eh_frame.
3391 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
3393 EmitLabel("eh_frame_end", EHFrameInfo.Number);
3395 // If the function is marked used, this table should be also. We cannot
3396 // make the mark unconditional in this case, since retaining the table
3397 // also retains the function in this case, and there is code around
3398 // that depends on unused functions (calling undefined externals) being
3399 // dead-stripped to link correctly. Yes, there really is.
3400 if (MMI->getUsedFunctions().count(EHFrameInfo.function))
3401 if (const char *UsedDirective = TAI->getUsedDirective())
3402 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3406 /// EmitExceptionTable - Emit landing pads and actions.
3408 /// The general organization of the table is complex, but the basic concepts
3409 /// are easy. First there is a header which describes the location and
3410 /// organization of the three components that follow.
3411 /// 1. The landing pad site information describes the range of code covered
3412 /// by the try. In our case it's an accumulation of the ranges covered
3413 /// by the invokes in the try. There is also a reference to the landing
3414 /// pad that handles the exception once processed. Finally an index into
3415 /// the actions table.
3416 /// 2. The action table, in our case, is composed of pairs of type ids
3417 /// and next action offset. Starting with the action index from the
3418 /// landing pad site, each type Id is checked for a match to the current
3419 /// exception. If it matches then the exception and type id are passed
3420 /// on to the landing pad. Otherwise the next action is looked up. This
3421 /// chain is terminated with a next action of zero. If no type id is
3422 /// found the the frame is unwound and handling continues.
3423 /// 3. Type id table contains references to all the C++ typeinfo for all
3424 /// catches in the function. This tables is reversed indexed base 1.
3426 /// SharedTypeIds - How many leading type ids two landing pads have in common.
3427 static unsigned SharedTypeIds(const LandingPadInfo *L,
3428 const LandingPadInfo *R) {
3429 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3430 unsigned LSize = LIds.size(), RSize = RIds.size();
3431 unsigned MinSize = LSize < RSize ? LSize : RSize;
3434 for (; Count != MinSize; ++Count)
3435 if (LIds[Count] != RIds[Count])
3441 /// PadLT - Order landing pads lexicographically by type id.
3442 static bool PadLT(const LandingPadInfo *L, const LandingPadInfo *R) {
3443 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3444 unsigned LSize = LIds.size(), RSize = RIds.size();
3445 unsigned MinSize = LSize < RSize ? LSize : RSize;
3447 for (unsigned i = 0; i != MinSize; ++i)
3448 if (LIds[i] != RIds[i])
3449 return LIds[i] < RIds[i];
3451 return LSize < RSize;
3455 static inline unsigned getEmptyKey() { return -1U; }
3456 static inline unsigned getTombstoneKey() { return -2U; }
3457 static unsigned getHashValue(const unsigned &Key) { return Key; }
3458 static bool isEqual(unsigned LHS, unsigned RHS) { return LHS == RHS; }
3459 static bool isPod() { return true; }
3462 /// ActionEntry - Structure describing an entry in the actions table.
3463 struct ActionEntry {
3464 int ValueForTypeID; // The value to write - may not be equal to the type id.
3466 struct ActionEntry *Previous;
3469 /// PadRange - Structure holding a try-range and the associated landing pad.
3471 // The index of the landing pad.
3473 // The index of the begin and end labels in the landing pad's label lists.
3474 unsigned RangeIndex;
3477 typedef DenseMap<unsigned, PadRange, KeyInfo> RangeMapType;
3479 /// CallSiteEntry - Structure describing an entry in the call-site table.
3480 struct CallSiteEntry {
3481 // The 'try-range' is BeginLabel .. EndLabel.
3482 unsigned BeginLabel; // zero indicates the start of the function.
3483 unsigned EndLabel; // zero indicates the end of the function.
3484 // The landing pad starts at PadLabel.
3485 unsigned PadLabel; // zero indicates that there is no landing pad.
3489 void EmitExceptionTable() {
3490 const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
3491 const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
3492 const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
3493 if (PadInfos.empty()) return;
3495 // Sort the landing pads in order of their type ids. This is used to fold
3496 // duplicate actions.
3497 SmallVector<const LandingPadInfo *, 64> LandingPads;
3498 LandingPads.reserve(PadInfos.size());
3499 for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
3500 LandingPads.push_back(&PadInfos[i]);
3501 std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
3503 // Negative type ids index into FilterIds, positive type ids index into
3504 // TypeInfos. The value written for a positive type id is just the type
3505 // id itself. For a negative type id, however, the value written is the
3506 // (negative) byte offset of the corresponding FilterIds entry. The byte
3507 // offset is usually equal to the type id, because the FilterIds entries
3508 // are written using a variable width encoding which outputs one byte per
3509 // entry as long as the value written is not too large, but can differ.
3510 // This kind of complication does not occur for positive type ids because
3511 // type infos are output using a fixed width encoding.
3512 // FilterOffsets[i] holds the byte offset corresponding to FilterIds[i].
3513 SmallVector<int, 16> FilterOffsets;
3514 FilterOffsets.reserve(FilterIds.size());
3516 for(std::vector<unsigned>::const_iterator I = FilterIds.begin(),
3517 E = FilterIds.end(); I != E; ++I) {
3518 FilterOffsets.push_back(Offset);
3519 Offset -= TargetAsmInfo::getULEB128Size(*I);
3522 // Compute the actions table and gather the first action index for each
3523 // landing pad site.
3524 SmallVector<ActionEntry, 32> Actions;
3525 SmallVector<unsigned, 64> FirstActions;
3526 FirstActions.reserve(LandingPads.size());
3528 int FirstAction = 0;
3529 unsigned SizeActions = 0;
3530 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3531 const LandingPadInfo *LP = LandingPads[i];
3532 const std::vector<int> &TypeIds = LP->TypeIds;
3533 const unsigned NumShared = i ? SharedTypeIds(LP, LandingPads[i-1]) : 0;
3534 unsigned SizeSiteActions = 0;
3536 if (NumShared < TypeIds.size()) {
3537 unsigned SizeAction = 0;
3538 ActionEntry *PrevAction = 0;
3541 const unsigned SizePrevIds = LandingPads[i-1]->TypeIds.size();
3542 assert(Actions.size());
3543 PrevAction = &Actions.back();
3544 SizeAction = TargetAsmInfo::getSLEB128Size(PrevAction->NextAction) +
3545 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
3546 for (unsigned j = NumShared; j != SizePrevIds; ++j) {
3548 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
3549 SizeAction += -PrevAction->NextAction;
3550 PrevAction = PrevAction->Previous;
3554 // Compute the actions.
3555 for (unsigned I = NumShared, M = TypeIds.size(); I != M; ++I) {
3556 int TypeID = TypeIds[I];
3557 assert(-1-TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
3558 int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
3559 unsigned SizeTypeID = TargetAsmInfo::getSLEB128Size(ValueForTypeID);
3561 int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
3562 SizeAction = SizeTypeID + TargetAsmInfo::getSLEB128Size(NextAction);
3563 SizeSiteActions += SizeAction;
3565 ActionEntry Action = {ValueForTypeID, NextAction, PrevAction};
3566 Actions.push_back(Action);
3568 PrevAction = &Actions.back();
3571 // Record the first action of the landing pad site.
3572 FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
3573 } // else identical - re-use previous FirstAction
3575 FirstActions.push_back(FirstAction);
3577 // Compute this sites contribution to size.
3578 SizeActions += SizeSiteActions;
3581 // Compute the call-site table. The entry for an invoke has a try-range
3582 // containing the call, a non-zero landing pad and an appropriate action.
3583 // The entry for an ordinary call has a try-range containing the call and
3584 // zero for the landing pad and the action. Calls marked 'nounwind' have
3585 // no entry and must not be contained in the try-range of any entry - they
3586 // form gaps in the table. Entries must be ordered by try-range address.
3587 SmallVector<CallSiteEntry, 64> CallSites;
3589 RangeMapType PadMap;
3590 // Invokes and nounwind calls have entries in PadMap (due to being bracketed
3591 // by try-range labels when lowered). Ordinary calls do not, so appropriate
3592 // try-ranges for them need be deduced.
3593 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3594 const LandingPadInfo *LandingPad = LandingPads[i];
3595 for (unsigned j = 0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
3596 unsigned BeginLabel = LandingPad->BeginLabels[j];
3597 assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
3598 PadRange P = { i, j };
3599 PadMap[BeginLabel] = P;
3603 // The end label of the previous invoke or nounwind try-range.
3604 unsigned LastLabel = 0;
3606 // Whether there is a potentially throwing instruction (currently this means
3607 // an ordinary call) between the end of the previous try-range and now.
3608 bool SawPotentiallyThrowing = false;
3610 // Whether the last callsite entry was for an invoke.
3611 bool PreviousIsInvoke = false;
3613 // Visit all instructions in order of address.
3614 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
3616 for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
3618 if (!MI->isLabel()) {
3619 SawPotentiallyThrowing |= MI->getDesc().isCall();
3623 unsigned BeginLabel = MI->getOperand(0).getImm();
3624 assert(BeginLabel && "Invalid label!");
3626 // End of the previous try-range?
3627 if (BeginLabel == LastLabel)
3628 SawPotentiallyThrowing = false;
3630 // Beginning of a new try-range?
3631 RangeMapType::iterator L = PadMap.find(BeginLabel);
3632 if (L == PadMap.end())
3633 // Nope, it was just some random label.
3636 PadRange P = L->second;
3637 const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
3639 assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
3640 "Inconsistent landing pad map!");
3642 // If some instruction between the previous try-range and this one may
3643 // throw, create a call-site entry with no landing pad for the region
3644 // between the try-ranges.
3645 if (SawPotentiallyThrowing) {
3646 CallSiteEntry Site = {LastLabel, BeginLabel, 0, 0};
3647 CallSites.push_back(Site);
3648 PreviousIsInvoke = false;
3651 LastLabel = LandingPad->EndLabels[P.RangeIndex];
3652 assert(BeginLabel && LastLabel && "Invalid landing pad!");
3654 if (LandingPad->LandingPadLabel) {
3655 // This try-range is for an invoke.
3656 CallSiteEntry Site = {BeginLabel, LastLabel,
3657 LandingPad->LandingPadLabel, FirstActions[P.PadIndex]};
3659 // Try to merge with the previous call-site.
3660 if (PreviousIsInvoke) {
3661 CallSiteEntry &Prev = CallSites.back();
3662 if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
3663 // Extend the range of the previous entry.
3664 Prev.EndLabel = Site.EndLabel;
3669 // Otherwise, create a new call-site.
3670 CallSites.push_back(Site);
3671 PreviousIsInvoke = true;
3674 PreviousIsInvoke = false;
3678 // If some instruction between the previous try-range and the end of the
3679 // function may throw, create a call-site entry with no landing pad for the
3680 // region following the try-range.
3681 if (SawPotentiallyThrowing) {
3682 CallSiteEntry Site = {LastLabel, 0, 0, 0};
3683 CallSites.push_back(Site);
3689 const unsigned SiteStartSize = sizeof(int32_t); // DW_EH_PE_udata4
3690 const unsigned SiteLengthSize = sizeof(int32_t); // DW_EH_PE_udata4
3691 const unsigned LandingPadSize = sizeof(int32_t); // DW_EH_PE_udata4
3692 unsigned SizeSites = CallSites.size() * (SiteStartSize +
3695 for (unsigned i = 0, e = CallSites.size(); i < e; ++i)
3696 SizeSites += TargetAsmInfo::getULEB128Size(CallSites[i].Action);
3699 const unsigned TypeInfoSize = TD->getPointerSize(); // DW_EH_PE_absptr
3700 unsigned SizeTypes = TypeInfos.size() * TypeInfoSize;
3702 unsigned TypeOffset = sizeof(int8_t) + // Call site format
3703 TargetAsmInfo::getULEB128Size(SizeSites) + // Call-site table length
3704 SizeSites + SizeActions + SizeTypes;
3706 unsigned TotalSize = sizeof(int8_t) + // LPStart format
3707 sizeof(int8_t) + // TType format
3708 TargetAsmInfo::getULEB128Size(TypeOffset) + // TType base offset
3711 unsigned SizeAlign = (4 - TotalSize) & 3;
3713 // Begin the exception table.
3714 Asm->SwitchToDataSection(TAI->getDwarfExceptionSection());
3715 Asm->EmitAlignment(2, 0, 0, false);
3716 O << "GCC_except_table" << SubprogramCount << ":\n";
3717 for (unsigned i = 0; i != SizeAlign; ++i) {
3719 Asm->EOL("Padding");
3721 EmitLabel("exception", SubprogramCount);
3724 Asm->EmitInt8(DW_EH_PE_omit);
3725 Asm->EOL("LPStart format (DW_EH_PE_omit)");
3726 Asm->EmitInt8(DW_EH_PE_absptr);
3727 Asm->EOL("TType format (DW_EH_PE_absptr)");
3728 Asm->EmitULEB128Bytes(TypeOffset);
3729 Asm->EOL("TType base offset");
3730 Asm->EmitInt8(DW_EH_PE_udata4);
3731 Asm->EOL("Call site format (DW_EH_PE_udata4)");
3732 Asm->EmitULEB128Bytes(SizeSites);
3733 Asm->EOL("Call-site table length");
3735 // Emit the landing pad site information.
3736 for (unsigned i = 0; i < CallSites.size(); ++i) {
3737 CallSiteEntry &S = CallSites[i];
3738 const char *BeginTag;
3739 unsigned BeginNumber;
3741 if (!S.BeginLabel) {
3742 BeginTag = "eh_func_begin";
3743 BeginNumber = SubprogramCount;
3746 BeginNumber = S.BeginLabel;
3749 EmitSectionOffset(BeginTag, "eh_func_begin", BeginNumber, SubprogramCount,
3751 Asm->EOL("Region start");
3754 EmitDifference("eh_func_end", SubprogramCount, BeginTag, BeginNumber,
3757 EmitDifference("label", S.EndLabel, BeginTag, BeginNumber, true);
3759 Asm->EOL("Region length");
3764 EmitSectionOffset("label", "eh_func_begin", S.PadLabel, SubprogramCount,
3766 Asm->EOL("Landing pad");
3768 Asm->EmitULEB128Bytes(S.Action);
3772 // Emit the actions.
3773 for (unsigned I = 0, N = Actions.size(); I != N; ++I) {
3774 ActionEntry &Action = Actions[I];
3776 Asm->EmitSLEB128Bytes(Action.ValueForTypeID);
3777 Asm->EOL("TypeInfo index");
3778 Asm->EmitSLEB128Bytes(Action.NextAction);
3779 Asm->EOL("Next action");
3782 // Emit the type ids.
3783 for (unsigned M = TypeInfos.size(); M; --M) {
3784 GlobalVariable *GV = TypeInfos[M - 1];
3786 PrintRelDirective();
3789 O << Asm->getGlobalLinkName(GV);
3793 Asm->EOL("TypeInfo");
3796 // Emit the filter typeids.
3797 for (unsigned j = 0, M = FilterIds.size(); j < M; ++j) {
3798 unsigned TypeID = FilterIds[j];
3799 Asm->EmitULEB128Bytes(TypeID);
3800 Asm->EOL("Filter TypeInfo index");
3803 Asm->EmitAlignment(2, 0, 0, false);
3807 //===--------------------------------------------------------------------===//
3808 // Main entry points.
3810 DwarfException(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
3811 : Dwarf(OS, A, T, "eh")
3812 , shouldEmitTable(false)
3813 , shouldEmitMoves(false)
3814 , shouldEmitTableModule(false)
3815 , shouldEmitMovesModule(false)
3818 virtual ~DwarfException() {}
3820 /// SetModuleInfo - Set machine module information when it's known that pass
3821 /// manager has created it. Set by the target AsmPrinter.
3822 void SetModuleInfo(MachineModuleInfo *mmi) {
3826 /// BeginModule - Emit all exception information that should come prior to the
3828 void BeginModule(Module *M) {
3832 /// EndModule - Emit all exception information that should come after the
3835 if (shouldEmitMovesModule || shouldEmitTableModule) {
3836 const std::vector<Function *> Personalities = MMI->getPersonalities();
3837 for (unsigned i =0; i < Personalities.size(); ++i)
3838 EmitCommonEHFrame(Personalities[i], i);
3840 for (std::vector<FunctionEHFrameInfo>::iterator I = EHFrames.begin(),
3841 E = EHFrames.end(); I != E; ++I)
3846 /// BeginFunction - Gather pre-function exception information. Assumes being
3847 /// emitted immediately after the function entry point.
3848 void BeginFunction(MachineFunction *MF) {
3850 shouldEmitTable = shouldEmitMoves = false;
3851 if (MMI && TAI->doesSupportExceptionHandling()) {
3853 // Map all labels and get rid of any dead landing pads.
3854 MMI->TidyLandingPads();
3855 // If any landing pads survive, we need an EH table.
3856 if (MMI->getLandingPads().size())
3857 shouldEmitTable = true;
3859 // See if we need frame move info.
3860 if (!MF->getFunction()->doesNotThrow() || UnwindTablesMandatory)
3861 shouldEmitMoves = true;
3863 if (shouldEmitMoves || shouldEmitTable)
3864 // Assumes in correct section after the entry point.
3865 EmitLabel("eh_func_begin", ++SubprogramCount);
3867 shouldEmitTableModule |= shouldEmitTable;
3868 shouldEmitMovesModule |= shouldEmitMoves;
3871 /// EndFunction - Gather and emit post-function exception information.
3873 void EndFunction() {
3874 if (shouldEmitMoves || shouldEmitTable) {
3875 EmitLabel("eh_func_end", SubprogramCount);
3876 EmitExceptionTable();
3878 // Save EH frame information
3880 push_back(FunctionEHFrameInfo(getAsm()->getCurrentFunctionEHName(MF),
3882 MMI->getPersonalityIndex(),
3883 MF->getFrameInfo()->hasCalls(),
3884 !MMI->getLandingPads().empty(),
3885 MMI->getFrameMoves(),
3886 MF->getFunction()));
3891 } // End of namespace llvm
3893 //===----------------------------------------------------------------------===//
3895 /// Emit - Print the abbreviation using the specified Dwarf writer.
3897 void DIEAbbrev::Emit(const DwarfDebug &DD) const {
3898 // Emit its Dwarf tag type.
3899 DD.getAsm()->EmitULEB128Bytes(Tag);
3900 DD.getAsm()->EOL(TagString(Tag));
3902 // Emit whether it has children DIEs.
3903 DD.getAsm()->EmitULEB128Bytes(ChildrenFlag);
3904 DD.getAsm()->EOL(ChildrenString(ChildrenFlag));
3906 // For each attribute description.
3907 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3908 const DIEAbbrevData &AttrData = Data[i];
3910 // Emit attribute type.
3911 DD.getAsm()->EmitULEB128Bytes(AttrData.getAttribute());
3912 DD.getAsm()->EOL(AttributeString(AttrData.getAttribute()));
3915 DD.getAsm()->EmitULEB128Bytes(AttrData.getForm());
3916 DD.getAsm()->EOL(FormEncodingString(AttrData.getForm()));
3919 // Mark end of abbreviation.
3920 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(1)");
3921 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(2)");
3925 void DIEAbbrev::print(std::ostream &O) {
3926 O << "Abbreviation @"
3927 << std::hex << (intptr_t)this << std::dec
3931 << ChildrenString(ChildrenFlag)
3934 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3936 << AttributeString(Data[i].getAttribute())
3938 << FormEncodingString(Data[i].getForm())
3942 void DIEAbbrev::dump() { print(cerr); }
3945 //===----------------------------------------------------------------------===//
3948 void DIEValue::dump() {
3953 //===----------------------------------------------------------------------===//
3955 /// EmitValue - Emit integer of appropriate size.
3957 void DIEInteger::EmitValue(DwarfDebug &DD, unsigned Form) {
3959 case DW_FORM_flag: // Fall thru
3960 case DW_FORM_ref1: // Fall thru
3961 case DW_FORM_data1: DD.getAsm()->EmitInt8(Integer); break;
3962 case DW_FORM_ref2: // Fall thru
3963 case DW_FORM_data2: DD.getAsm()->EmitInt16(Integer); break;
3964 case DW_FORM_ref4: // Fall thru
3965 case DW_FORM_data4: DD.getAsm()->EmitInt32(Integer); break;
3966 case DW_FORM_ref8: // Fall thru
3967 case DW_FORM_data8: DD.getAsm()->EmitInt64(Integer); break;
3968 case DW_FORM_udata: DD.getAsm()->EmitULEB128Bytes(Integer); break;
3969 case DW_FORM_sdata: DD.getAsm()->EmitSLEB128Bytes(Integer); break;
3970 default: assert(0 && "DIE Value form not supported yet"); break;
3974 /// SizeOf - Determine size of integer value in bytes.
3976 unsigned DIEInteger::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3978 case DW_FORM_flag: // Fall thru
3979 case DW_FORM_ref1: // Fall thru
3980 case DW_FORM_data1: return sizeof(int8_t);
3981 case DW_FORM_ref2: // Fall thru
3982 case DW_FORM_data2: return sizeof(int16_t);
3983 case DW_FORM_ref4: // Fall thru
3984 case DW_FORM_data4: return sizeof(int32_t);
3985 case DW_FORM_ref8: // Fall thru
3986 case DW_FORM_data8: return sizeof(int64_t);
3987 case DW_FORM_udata: return TargetAsmInfo::getULEB128Size(Integer);
3988 case DW_FORM_sdata: return TargetAsmInfo::getSLEB128Size(Integer);
3989 default: assert(0 && "DIE Value form not supported yet"); break;
3994 //===----------------------------------------------------------------------===//
3996 /// EmitValue - Emit string value.
3998 void DIEString::EmitValue(DwarfDebug &DD, unsigned Form) {
3999 DD.getAsm()->EmitString(String);
4002 //===----------------------------------------------------------------------===//
4004 /// EmitValue - Emit label value.
4006 void DIEDwarfLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
4007 bool IsSmall = Form == DW_FORM_data4;
4008 DD.EmitReference(Label, false, IsSmall);
4011 /// SizeOf - Determine size of label value in bytes.
4013 unsigned DIEDwarfLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4014 if (Form == DW_FORM_data4) return 4;
4015 return DD.getTargetData()->getPointerSize();
4018 //===----------------------------------------------------------------------===//
4020 /// EmitValue - Emit label value.
4022 void DIEObjectLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
4023 bool IsSmall = Form == DW_FORM_data4;
4024 DD.EmitReference(Label, false, IsSmall);
4027 /// SizeOf - Determine size of label value in bytes.
4029 unsigned DIEObjectLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4030 if (Form == DW_FORM_data4) return 4;
4031 return DD.getTargetData()->getPointerSize();
4034 //===----------------------------------------------------------------------===//
4036 /// EmitValue - Emit delta value.
4038 void DIESectionOffset::EmitValue(DwarfDebug &DD, unsigned Form) {
4039 bool IsSmall = Form == DW_FORM_data4;
4040 DD.EmitSectionOffset(Label.Tag, Section.Tag,
4041 Label.Number, Section.Number, IsSmall, IsEH, UseSet);
4044 /// SizeOf - Determine size of delta value in bytes.
4046 unsigned DIESectionOffset::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4047 if (Form == DW_FORM_data4) return 4;
4048 return DD.getTargetData()->getPointerSize();
4051 //===----------------------------------------------------------------------===//
4053 /// EmitValue - Emit delta value.
4055 void DIEDelta::EmitValue(DwarfDebug &DD, unsigned Form) {
4056 bool IsSmall = Form == DW_FORM_data4;
4057 DD.EmitDifference(LabelHi, LabelLo, IsSmall);
4060 /// SizeOf - Determine size of delta value in bytes.
4062 unsigned DIEDelta::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4063 if (Form == DW_FORM_data4) return 4;
4064 return DD.getTargetData()->getPointerSize();
4067 //===----------------------------------------------------------------------===//
4069 /// EmitValue - Emit debug information entry offset.
4071 void DIEntry::EmitValue(DwarfDebug &DD, unsigned Form) {
4072 DD.getAsm()->EmitInt32(Entry->getOffset());
4075 //===----------------------------------------------------------------------===//
4077 /// ComputeSize - calculate the size of the block.
4079 unsigned DIEBlock::ComputeSize(DwarfDebug &DD) {
4081 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
4083 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4084 Size += Values[i]->SizeOf(DD, AbbrevData[i].getForm());
4090 /// EmitValue - Emit block data.
4092 void DIEBlock::EmitValue(DwarfDebug &DD, unsigned Form) {
4094 case DW_FORM_block1: DD.getAsm()->EmitInt8(Size); break;
4095 case DW_FORM_block2: DD.getAsm()->EmitInt16(Size); break;
4096 case DW_FORM_block4: DD.getAsm()->EmitInt32(Size); break;
4097 case DW_FORM_block: DD.getAsm()->EmitULEB128Bytes(Size); break;
4098 default: assert(0 && "Improper form for block"); break;
4101 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
4103 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4105 Values[i]->EmitValue(DD, AbbrevData[i].getForm());
4109 /// SizeOf - Determine size of block data in bytes.
4111 unsigned DIEBlock::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4113 case DW_FORM_block1: return Size + sizeof(int8_t);
4114 case DW_FORM_block2: return Size + sizeof(int16_t);
4115 case DW_FORM_block4: return Size + sizeof(int32_t);
4116 case DW_FORM_block: return Size + TargetAsmInfo::getULEB128Size(Size);
4117 default: assert(0 && "Improper form for block"); break;
4122 //===----------------------------------------------------------------------===//
4123 /// DIE Implementation
4126 for (unsigned i = 0, N = Children.size(); i < N; ++i)
4130 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
4132 void DIE::AddSiblingOffset() {
4133 DIEInteger *DI = new DIEInteger(0);
4134 Values.insert(Values.begin(), DI);
4135 Abbrev.AddFirstAttribute(DW_AT_sibling, DW_FORM_ref4);
4138 /// Profile - Used to gather unique data for the value folding set.
4140 void DIE::Profile(FoldingSetNodeID &ID) {
4143 for (unsigned i = 0, N = Children.size(); i < N; ++i)
4144 ID.AddPointer(Children[i]);
4146 for (unsigned j = 0, M = Values.size(); j < M; ++j)
4147 ID.AddPointer(Values[j]);
4151 void DIE::print(std::ostream &O, unsigned IncIndent) {
4152 static unsigned IndentCount = 0;
4153 IndentCount += IncIndent;
4154 const std::string Indent(IndentCount, ' ');
4155 bool isBlock = Abbrev.getTag() == 0;
4160 << "0x" << std::hex << (intptr_t)this << std::dec
4161 << ", Offset: " << Offset
4162 << ", Size: " << Size
4166 << TagString(Abbrev.getTag())
4168 << ChildrenString(Abbrev.getChildrenFlag());
4170 O << "Size: " << Size;
4174 const SmallVector<DIEAbbrevData, 8> &Data = Abbrev.getData();
4177 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4181 O << AttributeString(Data[i].getAttribute());
4183 O << "Blk[" << i << "]";
4186 << FormEncodingString(Data[i].getForm())
4188 Values[i]->print(O);
4193 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
4194 Children[j]->print(O, 4);
4197 if (!isBlock) O << "\n";
4198 IndentCount -= IncIndent;
4206 //===----------------------------------------------------------------------===//
4207 /// DwarfWriter Implementation
4210 DwarfWriter::DwarfWriter() : ImmutablePass(&ID), DD(NULL), DE(NULL) {
4213 DwarfWriter::~DwarfWriter() {
4218 /// BeginModule - Emit all Dwarf sections that should come prior to the
4220 void DwarfWriter::BeginModule(Module *M,
4221 MachineModuleInfo *MMI,
4222 raw_ostream &OS, AsmPrinter *A,
4223 const TargetAsmInfo *T) {
4224 DE = new DwarfException(OS, A, T);
4225 DD = new DwarfDebug(OS, A, T);
4228 DD->SetDebugInfo(MMI);
4229 DE->SetModuleInfo(MMI);
4232 /// EndModule - Emit all Dwarf sections that should come after the content.
4234 void DwarfWriter::EndModule() {
4239 /// BeginFunction - Gather pre-function debug information. Assumes being
4240 /// emitted immediately after the function entry point.
4241 void DwarfWriter::BeginFunction(MachineFunction *MF) {
4242 DE->BeginFunction(MF);
4243 DD->BeginFunction(MF);
4246 /// EndFunction - Gather and emit post-function debug information.
4248 void DwarfWriter::EndFunction(MachineFunction *MF) {
4249 DD->EndFunction(MF);
4252 if (MachineModuleInfo *MMI = DD->getMMI() ? DD->getMMI() : DE->getMMI())
4253 // Clear function debug information.
4257 /// ValidDebugInfo - Return true if V represents valid debug info value.
4258 bool DwarfWriter::ValidDebugInfo(Value *V) {
4259 return DD && DD->ValidDebugInfo(V);
4262 /// RecordSourceLine - Records location information and associates it with a
4263 /// label. Returns a unique label ID used to generate a label and provide
4264 /// correspondence to the source line list.
4265 unsigned DwarfWriter::RecordSourceLine(unsigned Line, unsigned Col,
4267 return DD->RecordSourceLine(Line, Col, Src);
4270 /// RecordSource - Register a source file with debug info. Returns an source
4272 unsigned DwarfWriter::RecordSource(const std::string &Dir,
4273 const std::string &File) {
4274 return DD->RecordSource(Dir, File);
4277 /// RecordRegionStart - Indicate the start of a region.
4278 unsigned DwarfWriter::RecordRegionStart(GlobalVariable *V) {
4279 return DD->RecordRegionStart(V);
4282 /// RecordRegionEnd - Indicate the end of a region.
4283 unsigned DwarfWriter::RecordRegionEnd(GlobalVariable *V) {
4284 return DD->RecordRegionEnd(V);
4287 /// getRecordSourceLineCount - Count source lines.
4288 unsigned DwarfWriter::getRecordSourceLineCount() {
4289 return DD->getRecordSourceLineCount();
4292 /// RecordVariable - Indicate the declaration of a local variable.
4294 void DwarfWriter::RecordVariable(GlobalVariable *GV, unsigned FrameIndex) {
4295 DD->RecordVariable(GV, FrameIndex);