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 appropriate context.
1692 DIDescriptor Context = Ty.getContext();
1693 if (!Context.isNull())
1694 Die = DW_Unit->getDieMapSlotFor(Context.getGV());
1697 DIE *Child = new DIE(Buffer);
1698 Die->AddChild(Child);
1700 SetDIEntry(Slot, Child);
1703 Die = DW_Unit->AddDie(Buffer);
1704 SetDIEntry(Slot, Die);
1707 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1710 /// ConstructTypeDIE - Construct basic type die from DIBasicType.
1711 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1714 // Get core information.
1715 const std::string &Name = BTy.getName();
1716 Buffer.setTag(DW_TAG_base_type);
1717 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, BTy.getEncoding());
1718 // Add name if not anonymous or intermediate type.
1720 AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1721 uint64_t Size = BTy.getSizeInBits() >> 3;
1722 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1725 /// ConstructTypeDIE - Construct derived type die from DIDerivedType.
1726 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1727 DIDerivedType DTy) {
1729 // Get core information.
1730 const std::string &Name = DTy.getName();
1731 uint64_t Size = DTy.getSizeInBits() >> 3;
1732 unsigned Tag = DTy.getTag();
1733 // FIXME - Workaround for templates.
1734 if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
1737 // Map to main type, void will not have a type.
1738 DIType FromTy = DTy.getTypeDerivedFrom();
1739 AddType(DW_Unit, &Buffer, FromTy);
1741 // Add name if not anonymous or intermediate type.
1742 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1744 // Add size if non-zero (derived types might be zero-sized.)
1746 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1748 // Add source line info if available and TyDesc is not a forward
1750 if (!DTy.isForwardDecl())
1751 AddSourceLine(&Buffer, &DTy);
1754 /// ConstructTypeDIE - Construct type DIE from DICompositeType.
1755 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1756 DICompositeType CTy) {
1758 // Get core information.
1759 const std::string &Name = CTy.getName();
1760 uint64_t Size = CTy.getSizeInBits() >> 3;
1761 unsigned Tag = CTy.getTag();
1764 case DW_TAG_vector_type:
1765 case DW_TAG_array_type:
1766 ConstructArrayTypeDIE(DW_Unit, Buffer, &CTy);
1768 case DW_TAG_enumeration_type:
1770 DIArray Elements = CTy.getTypeArray();
1771 // Add enumerators to enumeration type.
1772 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1773 DIE *ElemDie = NULL;
1774 DIEnumerator Enum(Elements.getElement(i).getGV());
1775 ElemDie = ConstructEnumTypeDIE(DW_Unit, &Enum);
1776 Buffer.AddChild(ElemDie);
1780 case DW_TAG_subroutine_type:
1782 // Add prototype flag.
1783 AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
1784 DIArray Elements = CTy.getTypeArray();
1786 DIDescriptor RTy = Elements.getElement(0);
1787 AddType(DW_Unit, &Buffer, DIType(RTy.getGV()));
1790 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1791 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1792 DIDescriptor Ty = Elements.getElement(i);
1793 AddType(DW_Unit, Arg, DIType(Ty.getGV()));
1794 Buffer.AddChild(Arg);
1798 case DW_TAG_structure_type:
1799 case DW_TAG_union_type:
1801 // Add elements to structure type.
1802 DIArray Elements = CTy.getTypeArray();
1804 // A forward struct declared type may not have elements available.
1805 if (Elements.isNull())
1808 // Add elements to structure type.
1809 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1810 DIDescriptor Element = Elements.getElement(i);
1811 DIE *ElemDie = NULL;
1812 if (Element.getTag() == dwarf::DW_TAG_subprogram)
1813 ElemDie = CreateSubprogramDIE(DW_Unit,
1814 DISubprogram(Element.getGV()));
1815 else if (Element.getTag() == dwarf::DW_TAG_variable) // ???
1816 ElemDie = CreateGlobalVariableDIE(DW_Unit,
1817 DIGlobalVariable(Element.getGV()));
1819 ElemDie = CreateMemberDIE(DW_Unit,
1820 DIDerivedType(Element.getGV()));
1821 Buffer.AddChild(ElemDie);
1829 // Add name if not anonymous or intermediate type.
1830 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1832 if (Tag == DW_TAG_enumeration_type || Tag == DW_TAG_structure_type
1833 || Tag == DW_TAG_union_type) {
1834 // Add size if non-zero (derived types might be zero-sized.)
1836 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1838 // Add zero size if it is not a forward declaration.
1839 if (CTy.isForwardDecl())
1840 AddUInt(&Buffer, DW_AT_declaration, DW_FORM_flag, 1);
1842 AddUInt(&Buffer, DW_AT_byte_size, 0, 0);
1845 // Add source line info if available.
1846 if (!CTy.isForwardDecl())
1847 AddSourceLine(&Buffer, &CTy);
1851 // ConstructSubrangeDIE - Construct subrange DIE from DISubrange.
1852 void ConstructSubrangeDIE (DIE &Buffer, DISubrange SR, DIE *IndexTy) {
1853 int64_t L = SR.getLo();
1854 int64_t H = SR.getHi();
1855 DIE *DW_Subrange = new DIE(DW_TAG_subrange_type);
1857 AddDIEntry(DW_Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1859 AddSInt(DW_Subrange, DW_AT_lower_bound, 0, L);
1860 AddSInt(DW_Subrange, DW_AT_upper_bound, 0, H);
1862 Buffer.AddChild(DW_Subrange);
1865 /// ConstructArrayTypeDIE - Construct array type DIE from DICompositeType.
1866 void ConstructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1867 DICompositeType *CTy) {
1868 Buffer.setTag(DW_TAG_array_type);
1869 if (CTy->getTag() == DW_TAG_vector_type)
1870 AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1872 // Emit derived type.
1873 AddType(DW_Unit, &Buffer, CTy->getTypeDerivedFrom());
1874 DIArray Elements = CTy->getTypeArray();
1876 // Construct an anonymous type for index type.
1877 DIE IdxBuffer(DW_TAG_base_type);
1878 AddUInt(&IdxBuffer, DW_AT_byte_size, 0, sizeof(int32_t));
1879 AddUInt(&IdxBuffer, DW_AT_encoding, DW_FORM_data1, DW_ATE_signed);
1880 DIE *IndexTy = DW_Unit->AddDie(IdxBuffer);
1882 // Add subranges to array type.
1883 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1884 DIDescriptor Element = Elements.getElement(i);
1885 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
1886 ConstructSubrangeDIE(Buffer, DISubrange(Element.getGV()), IndexTy);
1890 /// ConstructEnumTypeDIE - Construct enum type DIE from
1892 DIE *ConstructEnumTypeDIE(CompileUnit *DW_Unit, DIEnumerator *ETy) {
1894 DIE *Enumerator = new DIE(DW_TAG_enumerator);
1895 AddString(Enumerator, DW_AT_name, DW_FORM_string, ETy->getName());
1896 int64_t Value = ETy->getEnumValue();
1897 AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
1901 /// CreateGlobalVariableDIE - Create new DIE using GV.
1902 DIE *CreateGlobalVariableDIE(CompileUnit *DW_Unit, const DIGlobalVariable &GV)
1904 DIE *GVDie = new DIE(DW_TAG_variable);
1905 AddString(GVDie, DW_AT_name, DW_FORM_string, GV.getName());
1906 const std::string &LinkageName = GV.getLinkageName();
1907 if (!LinkageName.empty())
1908 AddString(GVDie, DW_AT_MIPS_linkage_name, DW_FORM_string, LinkageName);
1909 AddType(DW_Unit, GVDie, GV.getType());
1910 if (!GV.isLocalToUnit())
1911 AddUInt(GVDie, DW_AT_external, DW_FORM_flag, 1);
1912 AddSourceLine(GVDie, &GV);
1916 /// CreateMemberDIE - Create new member DIE.
1917 DIE *CreateMemberDIE(CompileUnit *DW_Unit, const DIDerivedType &DT) {
1918 DIE *MemberDie = new DIE(DT.getTag());
1919 std::string Name = DT.getName();
1921 AddString(MemberDie, DW_AT_name, DW_FORM_string, Name);
1923 AddType(DW_Unit, MemberDie, DT.getTypeDerivedFrom());
1925 AddSourceLine(MemberDie, &DT);
1927 // FIXME _ Handle bitfields
1928 DIEBlock *Block = new DIEBlock();
1929 AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
1930 AddUInt(Block, 0, DW_FORM_udata, DT.getOffsetInBits() >> 3);
1931 AddBlock(MemberDie, DW_AT_data_member_location, 0, Block);
1933 if (DT.isProtected())
1934 AddUInt(MemberDie, DW_AT_accessibility, 0, DW_ACCESS_protected);
1935 else if (DT.isPrivate())
1936 AddUInt(MemberDie, DW_AT_accessibility, 0, DW_ACCESS_private);
1941 /// CreateSubprogramDIE - Create new DIE using SP.
1942 DIE *CreateSubprogramDIE(CompileUnit *DW_Unit,
1943 const DISubprogram &SP,
1944 bool IsConstructor = false) {
1945 DIE *SPDie = new DIE(DW_TAG_subprogram);
1946 AddString(SPDie, DW_AT_name, DW_FORM_string, SP.getName());
1947 const std::string &LinkageName = SP.getLinkageName();
1948 if (!LinkageName.empty())
1949 AddString(SPDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
1951 AddSourceLine(SPDie, &SP);
1953 DICompositeType SPTy = SP.getType();
1954 DIArray Args = SPTy.getTypeArray();
1958 AddType(DW_Unit, SPDie, DIType(Args.getElement(0).getGV()));
1962 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1963 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1964 AddType(DW_Unit, Arg, DIType(Args.getElement(i).getGV()));
1965 AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1); // ???
1966 SPDie->AddChild(Arg);
1969 if (!SP.isLocalToUnit())
1970 AddUInt(SPDie, DW_AT_external, DW_FORM_flag, 1);
1974 /// FindCompileUnit - Get the compile unit for the given descriptor.
1976 CompileUnit *FindCompileUnit(DICompileUnit Unit) {
1977 CompileUnit *DW_Unit = DW_CUs[Unit.getGV()];
1978 assert(DW_Unit && "Missing compile unit.");
1982 /// NewDbgScopeVariable - Create a new scope variable.
1984 DIE *NewDbgScopeVariable(DbgVariable *DV, CompileUnit *Unit) {
1985 // Get the descriptor.
1986 const DIVariable &VD = DV->getVariable();
1988 // Translate tag to proper Dwarf tag. The result variable is dropped for
1991 switch (VD.getTag()) {
1992 case DW_TAG_return_variable: return NULL;
1993 case DW_TAG_arg_variable: Tag = DW_TAG_formal_parameter; break;
1994 case DW_TAG_auto_variable: // fall thru
1995 default: Tag = DW_TAG_variable; break;
1998 // Define variable debug information entry.
1999 DIE *VariableDie = new DIE(Tag);
2000 AddString(VariableDie, DW_AT_name, DW_FORM_string, VD.getName());
2002 // Add source line info if available.
2003 AddSourceLine(VariableDie, &VD);
2005 // Add variable type.
2006 AddType(Unit, VariableDie, VD.getType());
2008 // Add variable address.
2009 MachineLocation Location;
2010 Location.set(RI->getFrameRegister(*MF),
2011 RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
2012 AddAddress(VariableDie, DW_AT_location, Location);
2017 /// getOrCreateScope - Returns the scope associated with the given descriptor.
2019 DbgScope *getOrCreateScope(GlobalVariable *V) {
2020 DbgScope *&Slot = DbgScopeMap[V];
2022 // FIXME - breaks down when the context is an inlined function.
2023 DIDescriptor ParentDesc;
2024 DIDescriptor Desc(V);
2025 if (Desc.getTag() == dwarf::DW_TAG_lexical_block) {
2027 ParentDesc = Block.getContext();
2029 DbgScope *Parent = ParentDesc.isNull() ?
2030 NULL : getOrCreateScope(ParentDesc.getGV());
2031 Slot = new DbgScope(Parent, Desc);
2033 Parent->AddScope(Slot);
2034 } else if (RootDbgScope) {
2035 // FIXME - Add inlined function scopes to the root so we can delete
2036 // them later. Long term, handle inlined functions properly.
2037 RootDbgScope->AddScope(Slot);
2039 // First function is top level function.
2040 RootDbgScope = Slot;
2046 /// ConstructDbgScope - Construct the components of a scope.
2048 void ConstructDbgScope(DbgScope *ParentScope,
2049 unsigned ParentStartID, unsigned ParentEndID,
2050 DIE *ParentDie, CompileUnit *Unit) {
2051 // Add variables to scope.
2052 SmallVector<DbgVariable *, 8> &Variables = ParentScope->getVariables();
2053 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2054 DIE *VariableDie = NewDbgScopeVariable(Variables[i], Unit);
2055 if (VariableDie) ParentDie->AddChild(VariableDie);
2058 // Add nested scopes.
2059 SmallVector<DbgScope *, 4> &Scopes = ParentScope->getScopes();
2060 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
2061 // Define the Scope debug information entry.
2062 DbgScope *Scope = Scopes[j];
2063 // FIXME - Ignore inlined functions for the time being.
2064 if (!Scope->getParent()) continue;
2066 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
2067 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
2069 // Ignore empty scopes.
2070 if (StartID == EndID && StartID != 0) continue;
2071 if (Scope->getScopes().empty() && Scope->getVariables().empty()) continue;
2073 if (StartID == ParentStartID && EndID == ParentEndID) {
2074 // Just add stuff to the parent scope.
2075 ConstructDbgScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
2077 DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
2079 // Add the scope bounds.
2081 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2082 DWLabel("label", StartID));
2084 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2085 DWLabel("func_begin", SubprogramCount));
2088 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2089 DWLabel("label", EndID));
2091 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2092 DWLabel("func_end", SubprogramCount));
2095 // Add the scope contents.
2096 ConstructDbgScope(Scope, StartID, EndID, ScopeDie, Unit);
2097 ParentDie->AddChild(ScopeDie);
2102 /// ConstructRootDbgScope - Construct the scope for the subprogram.
2104 void ConstructRootDbgScope(DbgScope *RootScope) {
2105 // Exit if there is no root scope.
2106 if (!RootScope) return;
2107 DIDescriptor Desc = RootScope->getDesc();
2111 // Get the subprogram debug information entry.
2112 DISubprogram SPD(Desc.getGV());
2114 // Get the compile unit context.
2115 CompileUnit *Unit = FindCompileUnit(SPD.getCompileUnit());
2117 // Get the subprogram die.
2118 DIE *SPDie = Unit->getDieMapSlotFor(SPD.getGV());
2119 assert(SPDie && "Missing subprogram descriptor");
2121 // Add the function bounds.
2122 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2123 DWLabel("func_begin", SubprogramCount));
2124 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2125 DWLabel("func_end", SubprogramCount));
2126 MachineLocation Location(RI->getFrameRegister(*MF));
2127 AddAddress(SPDie, DW_AT_frame_base, Location);
2129 ConstructDbgScope(RootScope, 0, 0, SPDie, Unit);
2132 /// ConstructDefaultDbgScope - Construct a default scope for the subprogram.
2134 void ConstructDefaultDbgScope(MachineFunction *MF) {
2135 // Find the correct subprogram descriptor.
2136 std::string SPName = "llvm.dbg.subprograms";
2137 std::vector<GlobalVariable*> Result;
2138 getGlobalVariablesUsing(*M, SPName, Result);
2139 for (std::vector<GlobalVariable *>::iterator I = Result.begin(),
2140 E = Result.end(); I != E; ++I) {
2142 DISubprogram SPD(*I);
2144 if (SPD.getName() == MF->getFunction()->getName()) {
2145 // Get the compile unit context.
2146 CompileUnit *Unit = FindCompileUnit(SPD.getCompileUnit());
2148 // Get the subprogram die.
2149 DIE *SPDie = Unit->getDieMapSlotFor(SPD.getGV());
2150 assert(SPDie && "Missing subprogram descriptor");
2152 // Add the function bounds.
2153 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2154 DWLabel("func_begin", SubprogramCount));
2155 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2156 DWLabel("func_end", SubprogramCount));
2158 MachineLocation Location(RI->getFrameRegister(*MF));
2159 AddAddress(SPDie, DW_AT_frame_base, Location);
2164 // FIXME: This is causing an abort because C++ mangled names are compared
2165 // with their unmangled counterparts. See PR2885. Don't do this assert.
2166 assert(0 && "Couldn't find DIE for machine function!");
2170 /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
2171 /// tools to recognize the object file contains Dwarf information.
2172 void EmitInitial() {
2173 // Check to see if we already emitted intial headers.
2174 if (didInitial) return;
2177 // Dwarf sections base addresses.
2178 if (TAI->doesDwarfRequireFrameSection()) {
2179 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2180 EmitLabel("section_debug_frame", 0);
2182 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2183 EmitLabel("section_info", 0);
2184 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2185 EmitLabel("section_abbrev", 0);
2186 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2187 EmitLabel("section_aranges", 0);
2188 if (TAI->doesSupportMacInfoSection()) {
2189 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2190 EmitLabel("section_macinfo", 0);
2192 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2193 EmitLabel("section_line", 0);
2194 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2195 EmitLabel("section_loc", 0);
2196 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2197 EmitLabel("section_pubnames", 0);
2198 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2199 EmitLabel("section_str", 0);
2200 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2201 EmitLabel("section_ranges", 0);
2203 Asm->SwitchToSection(TAI->getTextSection());
2204 EmitLabel("text_begin", 0);
2205 Asm->SwitchToSection(TAI->getDataSection());
2206 EmitLabel("data_begin", 0);
2209 /// EmitDIE - Recusively Emits a debug information entry.
2211 void EmitDIE(DIE *Die) {
2212 // Get the abbreviation for this DIE.
2213 unsigned AbbrevNumber = Die->getAbbrevNumber();
2214 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2218 // Emit the code (index) for the abbreviation.
2219 Asm->EmitULEB128Bytes(AbbrevNumber);
2222 Asm->EOL(std::string("Abbrev [" +
2223 utostr(AbbrevNumber) +
2224 "] 0x" + utohexstr(Die->getOffset()) +
2225 ":0x" + utohexstr(Die->getSize()) + " " +
2226 TagString(Abbrev->getTag())));
2230 SmallVector<DIEValue*, 32> &Values = Die->getValues();
2231 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2233 // Emit the DIE attribute values.
2234 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2235 unsigned Attr = AbbrevData[i].getAttribute();
2236 unsigned Form = AbbrevData[i].getForm();
2237 assert(Form && "Too many attributes for DIE (check abbreviation)");
2240 case DW_AT_sibling: {
2241 Asm->EmitInt32(Die->SiblingOffset());
2245 // Emit an attribute using the defined form.
2246 Values[i]->EmitValue(*this, Form);
2251 Asm->EOL(AttributeString(Attr));
2254 // Emit the DIE children if any.
2255 if (Abbrev->getChildrenFlag() == DW_CHILDREN_yes) {
2256 const std::vector<DIE *> &Children = Die->getChildren();
2258 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2259 EmitDIE(Children[j]);
2262 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2266 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
2268 unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
2269 // Get the children.
2270 const std::vector<DIE *> &Children = Die->getChildren();
2272 // If not last sibling and has children then add sibling offset attribute.
2273 if (!Last && !Children.empty()) Die->AddSiblingOffset();
2275 // Record the abbreviation.
2276 AssignAbbrevNumber(Die->getAbbrev());
2278 // Get the abbreviation for this DIE.
2279 unsigned AbbrevNumber = Die->getAbbrevNumber();
2280 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2283 Die->setOffset(Offset);
2285 // Start the size with the size of abbreviation code.
2286 Offset += TargetAsmInfo::getULEB128Size(AbbrevNumber);
2288 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2289 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2291 // Size the DIE attribute values.
2292 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2293 // Size attribute value.
2294 Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
2297 // Size the DIE children if any.
2298 if (!Children.empty()) {
2299 assert(Abbrev->getChildrenFlag() == DW_CHILDREN_yes &&
2300 "Children flag not set");
2302 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2303 Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
2306 // End of children marker.
2307 Offset += sizeof(int8_t);
2310 Die->setSize(Offset - Die->getOffset());
2314 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
2316 void SizeAndOffsets() {
2317 // Process base compile unit.
2318 for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
2319 CE = DW_CUs.end(); CI != CE; ++CI) {
2320 CompileUnit *Unit = CI->second;
2321 // Compute size of compile unit header
2322 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2323 sizeof(int16_t) + // DWARF version number
2324 sizeof(int32_t) + // Offset Into Abbrev. Section
2325 sizeof(int8_t); // Pointer Size (in bytes)
2326 SizeAndOffsetDie(Unit->getDie(), Offset, true);
2330 /// EmitDebugInfo - Emit the debug info section.
2332 void EmitDebugInfo() {
2333 // Start debug info section.
2334 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2336 for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
2337 CE = DW_CUs.end(); CI != CE; ++CI) {
2338 CompileUnit *Unit = CI->second;
2339 DIE *Die = Unit->getDie();
2340 // Emit the compile units header.
2341 EmitLabel("info_begin", Unit->getID());
2342 // Emit size of content not including length itself
2343 unsigned ContentSize = Die->getSize() +
2344 sizeof(int16_t) + // DWARF version number
2345 sizeof(int32_t) + // Offset Into Abbrev. Section
2346 sizeof(int8_t) + // Pointer Size (in bytes)
2347 sizeof(int32_t); // FIXME - extra pad for gdb bug.
2349 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2350 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2351 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2352 Asm->EOL("Offset Into Abbrev. Section");
2353 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2356 // FIXME - extra padding for gdb bug.
2357 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2358 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2359 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2360 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2361 EmitLabel("info_end", Unit->getID());
2367 /// EmitAbbreviations - Emit the abbreviation section.
2369 void EmitAbbreviations() const {
2370 // Check to see if it is worth the effort.
2371 if (!Abbreviations.empty()) {
2372 // Start the debug abbrev section.
2373 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2375 EmitLabel("abbrev_begin", 0);
2377 // For each abbrevation.
2378 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2379 // Get abbreviation data
2380 const DIEAbbrev *Abbrev = Abbreviations[i];
2382 // Emit the abbrevations code (base 1 index.)
2383 Asm->EmitULEB128Bytes(Abbrev->getNumber());
2384 Asm->EOL("Abbreviation Code");
2386 // Emit the abbreviations data.
2387 Abbrev->Emit(*this);
2392 // Mark end of abbreviations.
2393 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2395 EmitLabel("abbrev_end", 0);
2401 /// EmitEndOfLineMatrix - Emit the last address of the section and the end of
2402 /// the line matrix.
2404 void EmitEndOfLineMatrix(unsigned SectionEnd) {
2405 // Define last address of section.
2406 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2407 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2408 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2409 EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
2411 // Mark end of matrix.
2412 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2413 Asm->EmitULEB128Bytes(1); Asm->EOL();
2414 Asm->EmitInt8(1); Asm->EOL();
2417 /// EmitDebugLines - Emit source line information.
2419 void EmitDebugLines() {
2420 // If the target is using .loc/.file, the assembler will be emitting the
2421 // .debug_line table automatically.
2422 if (TAI->hasDotLocAndDotFile())
2425 // Minimum line delta, thus ranging from -10..(255-10).
2426 const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
2427 // Maximum line delta, thus ranging from -10..(255-10).
2428 const int MaxLineDelta = 255 + MinLineDelta;
2430 // Start the dwarf line section.
2431 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2433 // Construct the section header.
2435 EmitDifference("line_end", 0, "line_begin", 0, true);
2436 Asm->EOL("Length of Source Line Info");
2437 EmitLabel("line_begin", 0);
2439 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2441 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2442 Asm->EOL("Prolog Length");
2443 EmitLabel("line_prolog_begin", 0);
2445 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2447 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2449 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
2451 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2453 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
2455 // Line number standard opcode encodings argument count
2456 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2457 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2458 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2459 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2460 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2461 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2462 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2463 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2464 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2466 // Emit directories.
2467 for (unsigned DirectoryID = 1, NDID = Directories.size();
2468 DirectoryID <= NDID; ++DirectoryID) {
2469 Asm->EmitString(Directories[DirectoryID]); Asm->EOL("Directory");
2471 Asm->EmitInt8(0); Asm->EOL("End of directories");
2474 for (unsigned SourceID = 1, NSID = SrcFiles.size();
2475 SourceID <= NSID; ++SourceID) {
2476 const SrcFileInfo &SourceFile = SrcFiles[SourceID];
2477 Asm->EmitString(SourceFile.getName());
2479 Asm->EmitULEB128Bytes(SourceFile.getDirectoryID());
2480 Asm->EOL("Directory #");
2481 Asm->EmitULEB128Bytes(0);
2482 Asm->EOL("Mod date");
2483 Asm->EmitULEB128Bytes(0);
2484 Asm->EOL("File size");
2486 Asm->EmitInt8(0); Asm->EOL("End of files");
2488 EmitLabel("line_prolog_end", 0);
2490 // A sequence for each text section.
2491 unsigned SecSrcLinesSize = SectionSourceLines.size();
2493 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
2494 // Isolate current sections line info.
2495 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
2498 const Section* S = SectionMap[j + 1];
2499 Asm->EOL(std::string("Section ") + S->getName());
2503 // Dwarf assumes we start with first line of first source file.
2504 unsigned Source = 1;
2507 // Construct rows of the address, source, line, column matrix.
2508 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2509 const SrcLineInfo &LineInfo = LineInfos[i];
2510 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2511 if (!LabelID) continue;
2513 unsigned SourceID = LineInfo.getSourceID();
2514 const SrcFileInfo &SourceFile = SrcFiles[SourceID];
2515 unsigned DirectoryID = SourceFile.getDirectoryID();
2517 Asm->EOL(Directories[DirectoryID]
2518 + SourceFile.getName()
2520 + utostr_32(LineInfo.getLine()));
2524 // Define the line address.
2525 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2526 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2527 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2528 EmitReference("label", LabelID); Asm->EOL("Location label");
2530 // If change of source, then switch to the new source.
2531 if (Source != LineInfo.getSourceID()) {
2532 Source = LineInfo.getSourceID();
2533 Asm->EmitInt8(DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2534 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2537 // If change of line.
2538 if (Line != LineInfo.getLine()) {
2539 // Determine offset.
2540 int Offset = LineInfo.getLine() - Line;
2541 int Delta = Offset - MinLineDelta;
2544 Line = LineInfo.getLine();
2546 // If delta is small enough and in range...
2547 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2548 // ... then use fast opcode.
2549 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2551 // ... otherwise use long hand.
2552 Asm->EmitInt8(DW_LNS_advance_line); Asm->EOL("DW_LNS_advance_line");
2553 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2554 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2557 // Copy the previous row (different address or source)
2558 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2562 EmitEndOfLineMatrix(j + 1);
2565 if (SecSrcLinesSize == 0)
2566 // Because we're emitting a debug_line section, we still need a line
2567 // table. The linker and friends expect it to exist. If there's nothing to
2568 // put into it, emit an empty table.
2569 EmitEndOfLineMatrix(1);
2571 EmitLabel("line_end", 0);
2576 /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
2578 void EmitCommonDebugFrame() {
2579 if (!TAI->doesDwarfRequireFrameSection())
2583 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2584 TargetFrameInfo::StackGrowsUp ?
2585 TD->getPointerSize() : -TD->getPointerSize();
2587 // Start the dwarf frame section.
2588 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2590 EmitLabel("debug_frame_common", 0);
2591 EmitDifference("debug_frame_common_end", 0,
2592 "debug_frame_common_begin", 0, true);
2593 Asm->EOL("Length of Common Information Entry");
2595 EmitLabel("debug_frame_common_begin", 0);
2596 Asm->EmitInt32((int)DW_CIE_ID);
2597 Asm->EOL("CIE Identifier Tag");
2598 Asm->EmitInt8(DW_CIE_VERSION);
2599 Asm->EOL("CIE Version");
2600 Asm->EmitString("");
2601 Asm->EOL("CIE Augmentation");
2602 Asm->EmitULEB128Bytes(1);
2603 Asm->EOL("CIE Code Alignment Factor");
2604 Asm->EmitSLEB128Bytes(stackGrowth);
2605 Asm->EOL("CIE Data Alignment Factor");
2606 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
2607 Asm->EOL("CIE RA Column");
2609 std::vector<MachineMove> Moves;
2610 RI->getInitialFrameState(Moves);
2612 EmitFrameMoves(NULL, 0, Moves, false);
2614 Asm->EmitAlignment(2, 0, 0, false);
2615 EmitLabel("debug_frame_common_end", 0);
2620 /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2622 void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
2623 if (!TAI->doesDwarfRequireFrameSection())
2626 // Start the dwarf frame section.
2627 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2629 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2630 "debug_frame_begin", DebugFrameInfo.Number, true);
2631 Asm->EOL("Length of Frame Information Entry");
2633 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2635 EmitSectionOffset("debug_frame_common", "section_debug_frame",
2637 Asm->EOL("FDE CIE offset");
2639 EmitReference("func_begin", DebugFrameInfo.Number);
2640 Asm->EOL("FDE initial location");
2641 EmitDifference("func_end", DebugFrameInfo.Number,
2642 "func_begin", DebugFrameInfo.Number);
2643 Asm->EOL("FDE address range");
2645 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves,
2648 Asm->EmitAlignment(2, 0, 0, false);
2649 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
2654 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
2656 void EmitDebugPubNames() {
2657 // Start the dwarf pubnames section.
2658 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2660 for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
2661 CE = DW_CUs.end(); CI != CE; ++CI) {
2662 CompileUnit *Unit = CI->second;
2664 EmitDifference("pubnames_end", Unit->getID(),
2665 "pubnames_begin", Unit->getID(), true);
2666 Asm->EOL("Length of Public Names Info");
2668 EmitLabel("pubnames_begin", Unit->getID());
2670 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF Version");
2672 EmitSectionOffset("info_begin", "section_info",
2673 Unit->getID(), 0, true, false);
2674 Asm->EOL("Offset of Compilation Unit Info");
2676 EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(),
2678 Asm->EOL("Compilation Unit Length");
2680 std::map<std::string, DIE *> &Globals = Unit->getGlobals();
2682 for (std::map<std::string, DIE *>::iterator GI = Globals.begin(),
2685 const std::string &Name = GI->first;
2686 DIE * Entity = GI->second;
2688 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2689 Asm->EmitString(Name); Asm->EOL("External Name");
2692 Asm->EmitInt32(0); Asm->EOL("End Mark");
2693 EmitLabel("pubnames_end", Unit->getID());
2699 /// EmitDebugStr - Emit visible names into a debug str section.
2701 void EmitDebugStr() {
2702 // Check to see if it is worth the effort.
2703 if (!StringPool.empty()) {
2704 // Start the dwarf str section.
2705 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2707 // For each of strings in the string pool.
2708 for (unsigned StringID = 1, N = StringPool.size();
2709 StringID <= N; ++StringID) {
2710 // Emit a label for reference from debug information entries.
2711 EmitLabel("string", StringID);
2712 // Emit the string itself.
2713 const std::string &String = StringPool[StringID];
2714 Asm->EmitString(String); Asm->EOL();
2721 /// EmitDebugLoc - Emit visible names into a debug loc section.
2723 void EmitDebugLoc() {
2724 // Start the dwarf loc section.
2725 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2730 /// EmitDebugARanges - Emit visible names into a debug aranges section.
2732 void EmitDebugARanges() {
2733 // Start the dwarf aranges section.
2734 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2738 CompileUnit *Unit = GetBaseCompileUnit();
2740 // Don't include size of length
2741 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
2743 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("Dwarf Version");
2745 EmitReference("info_begin", Unit->getID());
2746 Asm->EOL("Offset of Compilation Unit Info");
2748 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
2750 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
2752 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
2753 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
2756 EmitReference("text_begin", 0); Asm->EOL("Address");
2757 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
2759 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2760 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
2766 /// EmitDebugRanges - Emit visible names into a debug ranges section.
2768 void EmitDebugRanges() {
2769 // Start the dwarf ranges section.
2770 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2775 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
2777 void EmitDebugMacInfo() {
2778 if (TAI->doesSupportMacInfoSection()) {
2779 // Start the dwarf macinfo section.
2780 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2786 /// ConstructCompileUnits - Create a compile unit DIEs.
2787 void ConstructCompileUnits() {
2788 std::string CUName = "llvm.dbg.compile_units";
2789 std::vector<GlobalVariable*> Result;
2790 getGlobalVariablesUsing(*M, CUName, Result);
2791 for (std::vector<GlobalVariable *>::iterator RI = Result.begin(),
2792 RE = Result.end(); RI != RE; ++RI) {
2793 DICompileUnit DIUnit(*RI);
2794 unsigned ID = RecordSource(DIUnit.getDirectory(),
2795 DIUnit.getFilename());
2797 DIE *Die = new DIE(DW_TAG_compile_unit);
2798 AddSectionOffset(Die, DW_AT_stmt_list, DW_FORM_data4,
2799 DWLabel("section_line", 0), DWLabel("section_line", 0),
2801 AddString(Die, DW_AT_producer, DW_FORM_string, DIUnit.getProducer());
2802 AddUInt(Die, DW_AT_language, DW_FORM_data1, DIUnit.getLanguage());
2803 AddString(Die, DW_AT_name, DW_FORM_string, DIUnit.getFilename());
2804 if (!DIUnit.getDirectory().empty())
2805 AddString(Die, DW_AT_comp_dir, DW_FORM_string, DIUnit.getDirectory());
2806 if (DIUnit.isOptimized())
2807 AddUInt(Die, DW_AT_APPLE_optimized, DW_FORM_flag, 1);
2808 const std::string &Flags = DIUnit.getFlags();
2810 AddString(Die, DW_AT_APPLE_flags, DW_FORM_string, Flags);
2812 CompileUnit *Unit = new CompileUnit(ID, Die);
2813 DW_CUs[DIUnit.getGV()] = Unit;
2817 /// ConstructGlobalVariableDIEs - Create DIEs for each of the externally
2818 /// visible global variables.
2819 void ConstructGlobalVariableDIEs() {
2820 std::string GVName = "llvm.dbg.global_variables";
2821 std::vector<GlobalVariable*> Result;
2822 getGlobalVariablesUsing(*M, GVName, Result);
2823 for (std::vector<GlobalVariable *>::iterator GVI = Result.begin(),
2824 GVE = Result.end(); GVI != GVE; ++GVI) {
2825 DIGlobalVariable DI_GV(*GVI);
2826 CompileUnit *DW_Unit = FindCompileUnit(DI_GV.getCompileUnit());
2828 // Check for pre-existence.
2829 DIE *&Slot = DW_Unit->getDieMapSlotFor(DI_GV.getGV());
2832 DIE *VariableDie = CreateGlobalVariableDIE(DW_Unit, DI_GV);
2835 DIEBlock *Block = new DIEBlock();
2836 AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
2837 AddObjectLabel(Block, 0, DW_FORM_udata,
2838 Asm->getGlobalLinkName(DI_GV.getGlobal()));
2839 AddBlock(VariableDie, DW_AT_location, 0, Block);
2844 //Add to context owner.
2845 DW_Unit->getDie()->AddChild(VariableDie);
2847 //Expose as global. FIXME - need to check external flag.
2848 DW_Unit->AddGlobal(DI_GV.getName(), VariableDie);
2852 /// ConstructSubprograms - Create DIEs for each of the externally visible
2854 void ConstructSubprograms() {
2856 std::string SPName = "llvm.dbg.subprograms";
2857 std::vector<GlobalVariable*> Result;
2858 getGlobalVariablesUsing(*M, SPName, Result);
2859 for (std::vector<GlobalVariable *>::iterator RI = Result.begin(),
2860 RE = Result.end(); RI != RE; ++RI) {
2862 DISubprogram SP(*RI);
2863 CompileUnit *Unit = FindCompileUnit(SP.getCompileUnit());
2865 // Check for pre-existence.
2866 DIE *&Slot = Unit->getDieMapSlotFor(SP.getGV());
2869 DIE *SubprogramDie = CreateSubprogramDIE(Unit, SP);
2872 Slot = SubprogramDie;
2873 //Add to context owner.
2874 Unit->getDie()->AddChild(SubprogramDie);
2876 Unit->AddGlobal(SP.getName(), SubprogramDie);
2881 //===--------------------------------------------------------------------===//
2882 // Main entry points.
2884 DwarfDebug(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
2885 : Dwarf(OS, A, T, "dbg")
2886 , AbbreviationsSet(InitAbbreviationsSetSize)
2888 , ValuesSet(InitValuesSetSize)
2892 , SectionSourceLines()
2895 , RootDbgScope(NULL)
2898 virtual ~DwarfDebug() {
2899 for (unsigned j = 0, M = Values.size(); j < M; ++j)
2903 /// SetDebugInfo - Create global DIEs and emit initial debug info sections.
2904 /// This is inovked by the target AsmPrinter.
2905 void SetDebugInfo(MachineModuleInfo *mmi) {
2907 // Create all the compile unit DIEs.
2908 ConstructCompileUnits();
2915 MMI->setDebugInfoAvailability(true);
2917 // Create DIEs for each of the externally visible global variables.
2918 ConstructGlobalVariableDIEs();
2920 // Create DIEs for each of the externally visible subprograms.
2921 ConstructSubprograms();
2923 // Prime section data.
2924 SectionMap.insert(TAI->getTextSection());
2926 // Print out .file directives to specify files for .loc directives. These
2927 // are printed out early so that they precede any .loc directives.
2928 if (TAI->hasDotLocAndDotFile()) {
2929 for (unsigned i = 1, e = SrcFiles.size(); i <= e; ++i) {
2930 sys::Path FullPath(Directories[SrcFiles[i].getDirectoryID()]);
2931 bool AppendOk = FullPath.appendComponent(SrcFiles[i].getName());
2932 assert(AppendOk && "Could not append filename to directory!");
2934 Asm->EmitFile(i, FullPath.toString());
2939 // Emit initial sections
2943 /// BeginModule - Emit all Dwarf sections that should come prior to the
2945 void BeginModule(Module *M) {
2949 /// EndModule - Emit all Dwarf sections that should come after the content.
2952 if (!ShouldEmitDwarf()) return;
2954 // Standard sections final addresses.
2955 Asm->SwitchToSection(TAI->getTextSection());
2956 EmitLabel("text_end", 0);
2957 Asm->SwitchToSection(TAI->getDataSection());
2958 EmitLabel("data_end", 0);
2960 // End text sections.
2961 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
2962 Asm->SwitchToSection(SectionMap[i]);
2963 EmitLabel("section_end", i);
2966 // Emit common frame information.
2967 EmitCommonDebugFrame();
2969 // Emit function debug frame information
2970 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2971 E = DebugFrames.end(); I != E; ++I)
2972 EmitFunctionDebugFrame(*I);
2974 // Compute DIE offsets and sizes.
2977 // Emit all the DIEs into a debug info section
2980 // Corresponding abbreviations into a abbrev section.
2981 EmitAbbreviations();
2983 // Emit source line correspondence into a debug line section.
2986 // Emit info into a debug pubnames section.
2987 EmitDebugPubNames();
2989 // Emit info into a debug str section.
2992 // Emit info into a debug loc section.
2995 // Emit info into a debug aranges section.
2998 // Emit info into a debug ranges section.
3001 // Emit info into a debug macinfo section.
3005 /// BeginFunction - Gather pre-function debug information. Assumes being
3006 /// emitted immediately after the function entry point.
3007 void BeginFunction(MachineFunction *MF) {
3010 if (!ShouldEmitDwarf()) return;
3012 // Begin accumulating function debug information.
3013 MMI->BeginFunction(MF);
3015 // Assumes in correct section after the entry point.
3016 EmitLabel("func_begin", ++SubprogramCount);
3018 // Emit label for the implicitly defined dbg.stoppoint at the start of
3020 if (!Lines.empty()) {
3021 const SrcLineInfo &LineInfo = Lines[0];
3022 Asm->printLabel(LineInfo.getLabelID());
3026 /// EndFunction - Gather and emit post-function debug information.
3028 void EndFunction(MachineFunction *MF) {
3029 if (!ShouldEmitDwarf()) return;
3031 // Define end label for subprogram.
3032 EmitLabel("func_end", SubprogramCount);
3034 // Get function line info.
3035 if (!Lines.empty()) {
3036 // Get section line info.
3037 unsigned ID = SectionMap.insert(Asm->CurrentSection_);
3038 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
3039 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
3040 // Append the function info to section info.
3041 SectionLineInfos.insert(SectionLineInfos.end(),
3042 Lines.begin(), Lines.end());
3045 // Construct scopes for subprogram.
3047 ConstructRootDbgScope(RootDbgScope);
3049 // FIXME: This is wrong. We are essentially getting past a problem with
3050 // debug information not being able to handle unreachable blocks that have
3051 // debug information in them. In particular, those unreachable blocks that
3052 // have "region end" info in them. That situation results in the "root
3053 // scope" not being created. If that's the case, then emit a "default"
3054 // scope, i.e., one that encompasses the whole function. This isn't
3055 // desirable. And a better way of handling this (and all of the debugging
3056 // information) needs to be explored.
3057 ConstructDefaultDbgScope(MF);
3059 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
3060 MMI->getFrameMoves()));
3064 delete RootDbgScope;
3065 DbgScopeMap.clear();
3066 RootDbgScope = NULL;
3073 /// ValidDebugInfo - Return true if V represents valid debug info value.
3074 bool ValidDebugInfo(Value *V) {
3082 GlobalVariable *GV = getGlobalVariable(V);
3086 if (GV->getLinkage() != GlobalValue::InternalLinkage
3087 && GV->getLinkage() != GlobalValue::LinkOnceLinkage)
3090 DIDescriptor DI(GV);
3091 // Check current version. Allow Version6 for now.
3092 unsigned Version = DI.getVersion();
3093 if (Version != LLVMDebugVersion && Version != LLVMDebugVersion6)
3096 unsigned Tag = DI.getTag();
3098 case DW_TAG_variable:
3099 assert (DIVariable(GV).Verify() && "Invalid DebugInfo value");
3101 case DW_TAG_compile_unit:
3102 assert (DICompileUnit(GV).Verify() && "Invalid DebugInfo value");
3104 case DW_TAG_subprogram:
3105 assert (DISubprogram(GV).Verify() && "Invalid DebugInfo value");
3114 /// RecordSourceLine - Records location information and associates it with a
3115 /// label. Returns a unique label ID used to generate a label and provide
3116 /// correspondence to the source line list.
3117 unsigned RecordSourceLine(Value *V, unsigned Line, unsigned Col) {
3118 CompileUnit *Unit = DW_CUs[V];
3119 assert (Unit && "Unable to find CompileUnit");
3120 unsigned ID = MMI->NextLabelID();
3121 Lines.push_back(SrcLineInfo(Line, Col, Unit->getID(), ID));
3125 /// RecordSourceLine - Records location information and associates it with a
3126 /// label. Returns a unique label ID used to generate a label and provide
3127 /// correspondence to the source line list.
3128 unsigned RecordSourceLine(unsigned Line, unsigned Col, unsigned Src) {
3129 unsigned ID = MMI->NextLabelID();
3130 Lines.push_back(SrcLineInfo(Line, Col, Src, ID));
3134 unsigned getRecordSourceLineCount() {
3135 return Lines.size();
3138 /// RecordSource - Register a source file with debug info. Returns an source
3140 unsigned RecordSource(const std::string &Directory,
3141 const std::string &File) {
3142 unsigned DID = Directories.insert(Directory);
3143 return SrcFiles.insert(SrcFileInfo(DID,File));
3146 /// RecordRegionStart - Indicate the start of a region.
3148 unsigned RecordRegionStart(GlobalVariable *V) {
3149 DbgScope *Scope = getOrCreateScope(V);
3150 unsigned ID = MMI->NextLabelID();
3151 if (!Scope->getStartLabelID()) Scope->setStartLabelID(ID);
3155 /// RecordRegionEnd - Indicate the end of a region.
3157 unsigned RecordRegionEnd(GlobalVariable *V) {
3158 DbgScope *Scope = getOrCreateScope(V);
3159 unsigned ID = MMI->NextLabelID();
3160 Scope->setEndLabelID(ID);
3164 /// RecordVariable - Indicate the declaration of a local variable.
3166 void RecordVariable(GlobalVariable *GV, unsigned FrameIndex) {
3167 DIDescriptor Desc(GV);
3168 DbgScope *Scope = NULL;
3169 if (Desc.getTag() == DW_TAG_variable) {
3170 // GV is a global variable.
3171 DIGlobalVariable DG(GV);
3172 Scope = getOrCreateScope(DG.getContext().getGV());
3174 // or GV is a local variable.
3176 Scope = getOrCreateScope(DV.getContext().getGV());
3178 assert (Scope && "Unable to find variable' scope");
3179 DbgVariable *DV = new DbgVariable(DIVariable(GV), FrameIndex);
3180 Scope->AddVariable(DV);
3184 //===----------------------------------------------------------------------===//
3185 /// DwarfException - Emits Dwarf exception handling directives.
3187 class DwarfException : public Dwarf {
3190 struct FunctionEHFrameInfo {
3193 unsigned PersonalityIndex;
3195 bool hasLandingPads;
3196 std::vector<MachineMove> Moves;
3197 const Function * function;
3199 FunctionEHFrameInfo(const std::string &FN, unsigned Num, unsigned P,
3201 const std::vector<MachineMove> &M,
3203 FnName(FN), Number(Num), PersonalityIndex(P),
3204 hasCalls(hC), hasLandingPads(hL), Moves(M), function (f) { }
3207 std::vector<FunctionEHFrameInfo> EHFrames;
3209 /// shouldEmitTable - Per-function flag to indicate if EH tables should
3211 bool shouldEmitTable;
3213 /// shouldEmitMoves - Per-function flag to indicate if frame moves info
3214 /// should be emitted.
3215 bool shouldEmitMoves;
3217 /// shouldEmitTableModule - Per-module flag to indicate if EH tables
3218 /// should be emitted.
3219 bool shouldEmitTableModule;
3221 /// shouldEmitFrameModule - Per-module flag to indicate if frame moves
3222 /// should be emitted.
3223 bool shouldEmitMovesModule;
3225 /// EmitCommonEHFrame - Emit the common eh unwind frame.
3227 void EmitCommonEHFrame(const Function *Personality, unsigned Index) {
3228 // Size and sign of stack growth.
3230 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3231 TargetFrameInfo::StackGrowsUp ?
3232 TD->getPointerSize() : -TD->getPointerSize();
3234 // Begin eh frame section.
3235 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3237 if (!TAI->doesRequireNonLocalEHFrameLabel())
3238 O << TAI->getEHGlobalPrefix();
3239 O << "EH_frame" << Index << ":\n";
3240 EmitLabel("section_eh_frame", Index);
3242 // Define base labels.
3243 EmitLabel("eh_frame_common", Index);
3245 // Define the eh frame length.
3246 EmitDifference("eh_frame_common_end", Index,
3247 "eh_frame_common_begin", Index, true);
3248 Asm->EOL("Length of Common Information Entry");
3251 EmitLabel("eh_frame_common_begin", Index);
3252 Asm->EmitInt32((int)0);
3253 Asm->EOL("CIE Identifier Tag");
3254 Asm->EmitInt8(DW_CIE_VERSION);
3255 Asm->EOL("CIE Version");
3257 // The personality presence indicates that language specific information
3258 // will show up in the eh frame.
3259 Asm->EmitString(Personality ? "zPLR" : "zR");
3260 Asm->EOL("CIE Augmentation");
3262 // Round out reader.
3263 Asm->EmitULEB128Bytes(1);
3264 Asm->EOL("CIE Code Alignment Factor");
3265 Asm->EmitSLEB128Bytes(stackGrowth);
3266 Asm->EOL("CIE Data Alignment Factor");
3267 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), true));
3268 Asm->EOL("CIE Return Address Column");
3270 // If there is a personality, we need to indicate the functions location.
3272 Asm->EmitULEB128Bytes(7);
3273 Asm->EOL("Augmentation Size");
3275 if (TAI->getNeedsIndirectEncoding()) {
3276 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4 | DW_EH_PE_indirect);
3277 Asm->EOL("Personality (pcrel sdata4 indirect)");
3279 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3280 Asm->EOL("Personality (pcrel sdata4)");
3283 PrintRelDirective(true);
3284 O << TAI->getPersonalityPrefix();
3285 Asm->EmitExternalGlobal((const GlobalVariable *)(Personality));
3286 O << TAI->getPersonalitySuffix();
3287 if (strcmp(TAI->getPersonalitySuffix(), "+4@GOTPCREL"))
3288 O << "-" << TAI->getPCSymbol();
3289 Asm->EOL("Personality");
3291 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3292 Asm->EOL("LSDA Encoding (pcrel sdata4)");
3294 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3295 Asm->EOL("FDE Encoding (pcrel sdata4)");
3297 Asm->EmitULEB128Bytes(1);
3298 Asm->EOL("Augmentation Size");
3300 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3301 Asm->EOL("FDE Encoding (pcrel sdata4)");
3304 // Indicate locations of general callee saved registers in frame.
3305 std::vector<MachineMove> Moves;
3306 RI->getInitialFrameState(Moves);
3307 EmitFrameMoves(NULL, 0, Moves, true);
3309 // On Darwin the linker honors the alignment of eh_frame, which means it
3310 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3311 // you get holes which confuse readers of eh_frame.
3312 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
3314 EmitLabel("eh_frame_common_end", Index);
3319 /// EmitEHFrame - Emit function exception frame information.
3321 void EmitEHFrame(const FunctionEHFrameInfo &EHFrameInfo) {
3322 Function::LinkageTypes linkage = EHFrameInfo.function->getLinkage();
3324 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3326 // Externally visible entry into the functions eh frame info.
3327 // If the corresponding function is static, this should not be
3328 // externally visible.
3329 if (linkage != Function::InternalLinkage &&
3330 linkage != Function::PrivateLinkage) {
3331 if (const char *GlobalEHDirective = TAI->getGlobalEHDirective())
3332 O << GlobalEHDirective << EHFrameInfo.FnName << "\n";
3335 // If corresponding function is weak definition, this should be too.
3336 if ((linkage == Function::WeakLinkage ||
3337 linkage == Function::LinkOnceLinkage) &&
3338 TAI->getWeakDefDirective())
3339 O << TAI->getWeakDefDirective() << EHFrameInfo.FnName << "\n";
3341 // If there are no calls then you can't unwind. This may mean we can
3342 // omit the EH Frame, but some environments do not handle weak absolute
3344 // If UnwindTablesMandatory is set we cannot do this optimization; the
3345 // unwind info is to be available for non-EH uses.
3346 if (!EHFrameInfo.hasCalls &&
3347 !UnwindTablesMandatory &&
3348 ((linkage != Function::WeakLinkage &&
3349 linkage != Function::LinkOnceLinkage) ||
3350 !TAI->getWeakDefDirective() ||
3351 TAI->getSupportsWeakOmittedEHFrame()))
3353 O << EHFrameInfo.FnName << " = 0\n";
3354 // This name has no connection to the function, so it might get
3355 // dead-stripped when the function is not, erroneously. Prohibit
3356 // dead-stripping unconditionally.
3357 if (const char *UsedDirective = TAI->getUsedDirective())
3358 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3360 O << EHFrameInfo.FnName << ":\n";
3363 EmitDifference("eh_frame_end", EHFrameInfo.Number,
3364 "eh_frame_begin", EHFrameInfo.Number, true);
3365 Asm->EOL("Length of Frame Information Entry");
3367 EmitLabel("eh_frame_begin", EHFrameInfo.Number);
3369 if (TAI->doesRequireNonLocalEHFrameLabel()) {
3370 PrintRelDirective(true, true);
3371 PrintLabelName("eh_frame_begin", EHFrameInfo.Number);
3373 if (!TAI->isAbsoluteEHSectionOffsets())
3374 O << "-EH_frame" << EHFrameInfo.PersonalityIndex;
3376 EmitSectionOffset("eh_frame_begin", "eh_frame_common",
3377 EHFrameInfo.Number, EHFrameInfo.PersonalityIndex,
3381 Asm->EOL("FDE CIE offset");
3383 EmitReference("eh_func_begin", EHFrameInfo.Number, true, true);
3384 Asm->EOL("FDE initial location");
3385 EmitDifference("eh_func_end", EHFrameInfo.Number,
3386 "eh_func_begin", EHFrameInfo.Number, true);
3387 Asm->EOL("FDE address range");
3389 // If there is a personality and landing pads then point to the language
3390 // specific data area in the exception table.
3391 if (EHFrameInfo.PersonalityIndex) {
3392 Asm->EmitULEB128Bytes(4);
3393 Asm->EOL("Augmentation size");
3395 if (EHFrameInfo.hasLandingPads)
3396 EmitReference("exception", EHFrameInfo.Number, true, true);
3398 Asm->EmitInt32((int)0);
3399 Asm->EOL("Language Specific Data Area");
3401 Asm->EmitULEB128Bytes(0);
3402 Asm->EOL("Augmentation size");
3405 // Indicate locations of function specific callee saved registers in
3407 EmitFrameMoves("eh_func_begin", EHFrameInfo.Number, EHFrameInfo.Moves,
3410 // On Darwin the linker honors the alignment of eh_frame, which means it
3411 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3412 // you get holes which confuse readers of eh_frame.
3413 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
3415 EmitLabel("eh_frame_end", EHFrameInfo.Number);
3417 // If the function is marked used, this table should be also. We cannot
3418 // make the mark unconditional in this case, since retaining the table
3419 // also retains the function in this case, and there is code around
3420 // that depends on unused functions (calling undefined externals) being
3421 // dead-stripped to link correctly. Yes, there really is.
3422 if (MMI->getUsedFunctions().count(EHFrameInfo.function))
3423 if (const char *UsedDirective = TAI->getUsedDirective())
3424 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3428 /// EmitExceptionTable - Emit landing pads and actions.
3430 /// The general organization of the table is complex, but the basic concepts
3431 /// are easy. First there is a header which describes the location and
3432 /// organization of the three components that follow.
3433 /// 1. The landing pad site information describes the range of code covered
3434 /// by the try. In our case it's an accumulation of the ranges covered
3435 /// by the invokes in the try. There is also a reference to the landing
3436 /// pad that handles the exception once processed. Finally an index into
3437 /// the actions table.
3438 /// 2. The action table, in our case, is composed of pairs of type ids
3439 /// and next action offset. Starting with the action index from the
3440 /// landing pad site, each type Id is checked for a match to the current
3441 /// exception. If it matches then the exception and type id are passed
3442 /// on to the landing pad. Otherwise the next action is looked up. This
3443 /// chain is terminated with a next action of zero. If no type id is
3444 /// found the the frame is unwound and handling continues.
3445 /// 3. Type id table contains references to all the C++ typeinfo for all
3446 /// catches in the function. This tables is reversed indexed base 1.
3448 /// SharedTypeIds - How many leading type ids two landing pads have in common.
3449 static unsigned SharedTypeIds(const LandingPadInfo *L,
3450 const LandingPadInfo *R) {
3451 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3452 unsigned LSize = LIds.size(), RSize = RIds.size();
3453 unsigned MinSize = LSize < RSize ? LSize : RSize;
3456 for (; Count != MinSize; ++Count)
3457 if (LIds[Count] != RIds[Count])
3463 /// PadLT - Order landing pads lexicographically by type id.
3464 static bool PadLT(const LandingPadInfo *L, const LandingPadInfo *R) {
3465 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3466 unsigned LSize = LIds.size(), RSize = RIds.size();
3467 unsigned MinSize = LSize < RSize ? LSize : RSize;
3469 for (unsigned i = 0; i != MinSize; ++i)
3470 if (LIds[i] != RIds[i])
3471 return LIds[i] < RIds[i];
3473 return LSize < RSize;
3477 static inline unsigned getEmptyKey() { return -1U; }
3478 static inline unsigned getTombstoneKey() { return -2U; }
3479 static unsigned getHashValue(const unsigned &Key) { return Key; }
3480 static bool isEqual(unsigned LHS, unsigned RHS) { return LHS == RHS; }
3481 static bool isPod() { return true; }
3484 /// ActionEntry - Structure describing an entry in the actions table.
3485 struct ActionEntry {
3486 int ValueForTypeID; // The value to write - may not be equal to the type id.
3488 struct ActionEntry *Previous;
3491 /// PadRange - Structure holding a try-range and the associated landing pad.
3493 // The index of the landing pad.
3495 // The index of the begin and end labels in the landing pad's label lists.
3496 unsigned RangeIndex;
3499 typedef DenseMap<unsigned, PadRange, KeyInfo> RangeMapType;
3501 /// CallSiteEntry - Structure describing an entry in the call-site table.
3502 struct CallSiteEntry {
3503 // The 'try-range' is BeginLabel .. EndLabel.
3504 unsigned BeginLabel; // zero indicates the start of the function.
3505 unsigned EndLabel; // zero indicates the end of the function.
3506 // The landing pad starts at PadLabel.
3507 unsigned PadLabel; // zero indicates that there is no landing pad.
3511 void EmitExceptionTable() {
3512 const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
3513 const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
3514 const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
3515 if (PadInfos.empty()) return;
3517 // Sort the landing pads in order of their type ids. This is used to fold
3518 // duplicate actions.
3519 SmallVector<const LandingPadInfo *, 64> LandingPads;
3520 LandingPads.reserve(PadInfos.size());
3521 for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
3522 LandingPads.push_back(&PadInfos[i]);
3523 std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
3525 // Negative type ids index into FilterIds, positive type ids index into
3526 // TypeInfos. The value written for a positive type id is just the type
3527 // id itself. For a negative type id, however, the value written is the
3528 // (negative) byte offset of the corresponding FilterIds entry. The byte
3529 // offset is usually equal to the type id, because the FilterIds entries
3530 // are written using a variable width encoding which outputs one byte per
3531 // entry as long as the value written is not too large, but can differ.
3532 // This kind of complication does not occur for positive type ids because
3533 // type infos are output using a fixed width encoding.
3534 // FilterOffsets[i] holds the byte offset corresponding to FilterIds[i].
3535 SmallVector<int, 16> FilterOffsets;
3536 FilterOffsets.reserve(FilterIds.size());
3538 for(std::vector<unsigned>::const_iterator I = FilterIds.begin(),
3539 E = FilterIds.end(); I != E; ++I) {
3540 FilterOffsets.push_back(Offset);
3541 Offset -= TargetAsmInfo::getULEB128Size(*I);
3544 // Compute the actions table and gather the first action index for each
3545 // landing pad site.
3546 SmallVector<ActionEntry, 32> Actions;
3547 SmallVector<unsigned, 64> FirstActions;
3548 FirstActions.reserve(LandingPads.size());
3550 int FirstAction = 0;
3551 unsigned SizeActions = 0;
3552 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3553 const LandingPadInfo *LP = LandingPads[i];
3554 const std::vector<int> &TypeIds = LP->TypeIds;
3555 const unsigned NumShared = i ? SharedTypeIds(LP, LandingPads[i-1]) : 0;
3556 unsigned SizeSiteActions = 0;
3558 if (NumShared < TypeIds.size()) {
3559 unsigned SizeAction = 0;
3560 ActionEntry *PrevAction = 0;
3563 const unsigned SizePrevIds = LandingPads[i-1]->TypeIds.size();
3564 assert(Actions.size());
3565 PrevAction = &Actions.back();
3566 SizeAction = TargetAsmInfo::getSLEB128Size(PrevAction->NextAction) +
3567 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
3568 for (unsigned j = NumShared; j != SizePrevIds; ++j) {
3570 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
3571 SizeAction += -PrevAction->NextAction;
3572 PrevAction = PrevAction->Previous;
3576 // Compute the actions.
3577 for (unsigned I = NumShared, M = TypeIds.size(); I != M; ++I) {
3578 int TypeID = TypeIds[I];
3579 assert(-1-TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
3580 int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
3581 unsigned SizeTypeID = TargetAsmInfo::getSLEB128Size(ValueForTypeID);
3583 int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
3584 SizeAction = SizeTypeID + TargetAsmInfo::getSLEB128Size(NextAction);
3585 SizeSiteActions += SizeAction;
3587 ActionEntry Action = {ValueForTypeID, NextAction, PrevAction};
3588 Actions.push_back(Action);
3590 PrevAction = &Actions.back();
3593 // Record the first action of the landing pad site.
3594 FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
3595 } // else identical - re-use previous FirstAction
3597 FirstActions.push_back(FirstAction);
3599 // Compute this sites contribution to size.
3600 SizeActions += SizeSiteActions;
3603 // Compute the call-site table. The entry for an invoke has a try-range
3604 // containing the call, a non-zero landing pad and an appropriate action.
3605 // The entry for an ordinary call has a try-range containing the call and
3606 // zero for the landing pad and the action. Calls marked 'nounwind' have
3607 // no entry and must not be contained in the try-range of any entry - they
3608 // form gaps in the table. Entries must be ordered by try-range address.
3609 SmallVector<CallSiteEntry, 64> CallSites;
3611 RangeMapType PadMap;
3612 // Invokes and nounwind calls have entries in PadMap (due to being bracketed
3613 // by try-range labels when lowered). Ordinary calls do not, so appropriate
3614 // try-ranges for them need be deduced.
3615 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3616 const LandingPadInfo *LandingPad = LandingPads[i];
3617 for (unsigned j = 0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
3618 unsigned BeginLabel = LandingPad->BeginLabels[j];
3619 assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
3620 PadRange P = { i, j };
3621 PadMap[BeginLabel] = P;
3625 // The end label of the previous invoke or nounwind try-range.
3626 unsigned LastLabel = 0;
3628 // Whether there is a potentially throwing instruction (currently this means
3629 // an ordinary call) between the end of the previous try-range and now.
3630 bool SawPotentiallyThrowing = false;
3632 // Whether the last callsite entry was for an invoke.
3633 bool PreviousIsInvoke = false;
3635 // Visit all instructions in order of address.
3636 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
3638 for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
3640 if (!MI->isLabel()) {
3641 SawPotentiallyThrowing |= MI->getDesc().isCall();
3645 unsigned BeginLabel = MI->getOperand(0).getImm();
3646 assert(BeginLabel && "Invalid label!");
3648 // End of the previous try-range?
3649 if (BeginLabel == LastLabel)
3650 SawPotentiallyThrowing = false;
3652 // Beginning of a new try-range?
3653 RangeMapType::iterator L = PadMap.find(BeginLabel);
3654 if (L == PadMap.end())
3655 // Nope, it was just some random label.
3658 PadRange P = L->second;
3659 const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
3661 assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
3662 "Inconsistent landing pad map!");
3664 // If some instruction between the previous try-range and this one may
3665 // throw, create a call-site entry with no landing pad for the region
3666 // between the try-ranges.
3667 if (SawPotentiallyThrowing) {
3668 CallSiteEntry Site = {LastLabel, BeginLabel, 0, 0};
3669 CallSites.push_back(Site);
3670 PreviousIsInvoke = false;
3673 LastLabel = LandingPad->EndLabels[P.RangeIndex];
3674 assert(BeginLabel && LastLabel && "Invalid landing pad!");
3676 if (LandingPad->LandingPadLabel) {
3677 // This try-range is for an invoke.
3678 CallSiteEntry Site = {BeginLabel, LastLabel,
3679 LandingPad->LandingPadLabel, FirstActions[P.PadIndex]};
3681 // Try to merge with the previous call-site.
3682 if (PreviousIsInvoke) {
3683 CallSiteEntry &Prev = CallSites.back();
3684 if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
3685 // Extend the range of the previous entry.
3686 Prev.EndLabel = Site.EndLabel;
3691 // Otherwise, create a new call-site.
3692 CallSites.push_back(Site);
3693 PreviousIsInvoke = true;
3696 PreviousIsInvoke = false;
3700 // If some instruction between the previous try-range and the end of the
3701 // function may throw, create a call-site entry with no landing pad for the
3702 // region following the try-range.
3703 if (SawPotentiallyThrowing) {
3704 CallSiteEntry Site = {LastLabel, 0, 0, 0};
3705 CallSites.push_back(Site);
3711 const unsigned SiteStartSize = sizeof(int32_t); // DW_EH_PE_udata4
3712 const unsigned SiteLengthSize = sizeof(int32_t); // DW_EH_PE_udata4
3713 const unsigned LandingPadSize = sizeof(int32_t); // DW_EH_PE_udata4
3714 unsigned SizeSites = CallSites.size() * (SiteStartSize +
3717 for (unsigned i = 0, e = CallSites.size(); i < e; ++i)
3718 SizeSites += TargetAsmInfo::getULEB128Size(CallSites[i].Action);
3721 const unsigned TypeInfoSize = TD->getPointerSize(); // DW_EH_PE_absptr
3722 unsigned SizeTypes = TypeInfos.size() * TypeInfoSize;
3724 unsigned TypeOffset = sizeof(int8_t) + // Call site format
3725 TargetAsmInfo::getULEB128Size(SizeSites) + // Call-site table length
3726 SizeSites + SizeActions + SizeTypes;
3728 unsigned TotalSize = sizeof(int8_t) + // LPStart format
3729 sizeof(int8_t) + // TType format
3730 TargetAsmInfo::getULEB128Size(TypeOffset) + // TType base offset
3733 unsigned SizeAlign = (4 - TotalSize) & 3;
3735 // Begin the exception table.
3736 Asm->SwitchToDataSection(TAI->getDwarfExceptionSection());
3737 Asm->EmitAlignment(2, 0, 0, false);
3738 O << "GCC_except_table" << SubprogramCount << ":\n";
3739 for (unsigned i = 0; i != SizeAlign; ++i) {
3741 Asm->EOL("Padding");
3743 EmitLabel("exception", SubprogramCount);
3746 Asm->EmitInt8(DW_EH_PE_omit);
3747 Asm->EOL("LPStart format (DW_EH_PE_omit)");
3748 Asm->EmitInt8(DW_EH_PE_absptr);
3749 Asm->EOL("TType format (DW_EH_PE_absptr)");
3750 Asm->EmitULEB128Bytes(TypeOffset);
3751 Asm->EOL("TType base offset");
3752 Asm->EmitInt8(DW_EH_PE_udata4);
3753 Asm->EOL("Call site format (DW_EH_PE_udata4)");
3754 Asm->EmitULEB128Bytes(SizeSites);
3755 Asm->EOL("Call-site table length");
3757 // Emit the landing pad site information.
3758 for (unsigned i = 0; i < CallSites.size(); ++i) {
3759 CallSiteEntry &S = CallSites[i];
3760 const char *BeginTag;
3761 unsigned BeginNumber;
3763 if (!S.BeginLabel) {
3764 BeginTag = "eh_func_begin";
3765 BeginNumber = SubprogramCount;
3768 BeginNumber = S.BeginLabel;
3771 EmitSectionOffset(BeginTag, "eh_func_begin", BeginNumber, SubprogramCount,
3773 Asm->EOL("Region start");
3776 EmitDifference("eh_func_end", SubprogramCount, BeginTag, BeginNumber,
3779 EmitDifference("label", S.EndLabel, BeginTag, BeginNumber, true);
3781 Asm->EOL("Region length");
3786 EmitSectionOffset("label", "eh_func_begin", S.PadLabel, SubprogramCount,
3788 Asm->EOL("Landing pad");
3790 Asm->EmitULEB128Bytes(S.Action);
3794 // Emit the actions.
3795 for (unsigned I = 0, N = Actions.size(); I != N; ++I) {
3796 ActionEntry &Action = Actions[I];
3798 Asm->EmitSLEB128Bytes(Action.ValueForTypeID);
3799 Asm->EOL("TypeInfo index");
3800 Asm->EmitSLEB128Bytes(Action.NextAction);
3801 Asm->EOL("Next action");
3804 // Emit the type ids.
3805 for (unsigned M = TypeInfos.size(); M; --M) {
3806 GlobalVariable *GV = TypeInfos[M - 1];
3808 PrintRelDirective();
3811 O << Asm->getGlobalLinkName(GV);
3815 Asm->EOL("TypeInfo");
3818 // Emit the filter typeids.
3819 for (unsigned j = 0, M = FilterIds.size(); j < M; ++j) {
3820 unsigned TypeID = FilterIds[j];
3821 Asm->EmitULEB128Bytes(TypeID);
3822 Asm->EOL("Filter TypeInfo index");
3825 Asm->EmitAlignment(2, 0, 0, false);
3829 //===--------------------------------------------------------------------===//
3830 // Main entry points.
3832 DwarfException(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
3833 : Dwarf(OS, A, T, "eh")
3834 , shouldEmitTable(false)
3835 , shouldEmitMoves(false)
3836 , shouldEmitTableModule(false)
3837 , shouldEmitMovesModule(false)
3840 virtual ~DwarfException() {}
3842 /// SetModuleInfo - Set machine module information when it's known that pass
3843 /// manager has created it. Set by the target AsmPrinter.
3844 void SetModuleInfo(MachineModuleInfo *mmi) {
3848 /// BeginModule - Emit all exception information that should come prior to the
3850 void BeginModule(Module *M) {
3854 /// EndModule - Emit all exception information that should come after the
3857 if (shouldEmitMovesModule || shouldEmitTableModule) {
3858 const std::vector<Function *> Personalities = MMI->getPersonalities();
3859 for (unsigned i =0; i < Personalities.size(); ++i)
3860 EmitCommonEHFrame(Personalities[i], i);
3862 for (std::vector<FunctionEHFrameInfo>::iterator I = EHFrames.begin(),
3863 E = EHFrames.end(); I != E; ++I)
3868 /// BeginFunction - Gather pre-function exception information. Assumes being
3869 /// emitted immediately after the function entry point.
3870 void BeginFunction(MachineFunction *MF) {
3872 shouldEmitTable = shouldEmitMoves = false;
3873 if (MMI && TAI->doesSupportExceptionHandling()) {
3875 // Map all labels and get rid of any dead landing pads.
3876 MMI->TidyLandingPads();
3877 // If any landing pads survive, we need an EH table.
3878 if (MMI->getLandingPads().size())
3879 shouldEmitTable = true;
3881 // See if we need frame move info.
3882 if (!MF->getFunction()->doesNotThrow() || UnwindTablesMandatory)
3883 shouldEmitMoves = true;
3885 if (shouldEmitMoves || shouldEmitTable)
3886 // Assumes in correct section after the entry point.
3887 EmitLabel("eh_func_begin", ++SubprogramCount);
3889 shouldEmitTableModule |= shouldEmitTable;
3890 shouldEmitMovesModule |= shouldEmitMoves;
3893 /// EndFunction - Gather and emit post-function exception information.
3895 void EndFunction() {
3896 if (shouldEmitMoves || shouldEmitTable) {
3897 EmitLabel("eh_func_end", SubprogramCount);
3898 EmitExceptionTable();
3900 // Save EH frame information
3902 push_back(FunctionEHFrameInfo(getAsm()->getCurrentFunctionEHName(MF),
3904 MMI->getPersonalityIndex(),
3905 MF->getFrameInfo()->hasCalls(),
3906 !MMI->getLandingPads().empty(),
3907 MMI->getFrameMoves(),
3908 MF->getFunction()));
3913 } // End of namespace llvm
3915 //===----------------------------------------------------------------------===//
3917 /// Emit - Print the abbreviation using the specified Dwarf writer.
3919 void DIEAbbrev::Emit(const DwarfDebug &DD) const {
3920 // Emit its Dwarf tag type.
3921 DD.getAsm()->EmitULEB128Bytes(Tag);
3922 DD.getAsm()->EOL(TagString(Tag));
3924 // Emit whether it has children DIEs.
3925 DD.getAsm()->EmitULEB128Bytes(ChildrenFlag);
3926 DD.getAsm()->EOL(ChildrenString(ChildrenFlag));
3928 // For each attribute description.
3929 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3930 const DIEAbbrevData &AttrData = Data[i];
3932 // Emit attribute type.
3933 DD.getAsm()->EmitULEB128Bytes(AttrData.getAttribute());
3934 DD.getAsm()->EOL(AttributeString(AttrData.getAttribute()));
3937 DD.getAsm()->EmitULEB128Bytes(AttrData.getForm());
3938 DD.getAsm()->EOL(FormEncodingString(AttrData.getForm()));
3941 // Mark end of abbreviation.
3942 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(1)");
3943 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(2)");
3947 void DIEAbbrev::print(std::ostream &O) {
3948 O << "Abbreviation @"
3949 << std::hex << (intptr_t)this << std::dec
3953 << ChildrenString(ChildrenFlag)
3956 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3958 << AttributeString(Data[i].getAttribute())
3960 << FormEncodingString(Data[i].getForm())
3964 void DIEAbbrev::dump() { print(cerr); }
3967 //===----------------------------------------------------------------------===//
3970 void DIEValue::dump() {
3975 //===----------------------------------------------------------------------===//
3977 /// EmitValue - Emit integer of appropriate size.
3979 void DIEInteger::EmitValue(DwarfDebug &DD, unsigned Form) {
3981 case DW_FORM_flag: // Fall thru
3982 case DW_FORM_ref1: // Fall thru
3983 case DW_FORM_data1: DD.getAsm()->EmitInt8(Integer); break;
3984 case DW_FORM_ref2: // Fall thru
3985 case DW_FORM_data2: DD.getAsm()->EmitInt16(Integer); break;
3986 case DW_FORM_ref4: // Fall thru
3987 case DW_FORM_data4: DD.getAsm()->EmitInt32(Integer); break;
3988 case DW_FORM_ref8: // Fall thru
3989 case DW_FORM_data8: DD.getAsm()->EmitInt64(Integer); break;
3990 case DW_FORM_udata: DD.getAsm()->EmitULEB128Bytes(Integer); break;
3991 case DW_FORM_sdata: DD.getAsm()->EmitSLEB128Bytes(Integer); break;
3992 default: assert(0 && "DIE Value form not supported yet"); break;
3996 /// SizeOf - Determine size of integer value in bytes.
3998 unsigned DIEInteger::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4000 case DW_FORM_flag: // Fall thru
4001 case DW_FORM_ref1: // Fall thru
4002 case DW_FORM_data1: return sizeof(int8_t);
4003 case DW_FORM_ref2: // Fall thru
4004 case DW_FORM_data2: return sizeof(int16_t);
4005 case DW_FORM_ref4: // Fall thru
4006 case DW_FORM_data4: return sizeof(int32_t);
4007 case DW_FORM_ref8: // Fall thru
4008 case DW_FORM_data8: return sizeof(int64_t);
4009 case DW_FORM_udata: return TargetAsmInfo::getULEB128Size(Integer);
4010 case DW_FORM_sdata: return TargetAsmInfo::getSLEB128Size(Integer);
4011 default: assert(0 && "DIE Value form not supported yet"); break;
4016 //===----------------------------------------------------------------------===//
4018 /// EmitValue - Emit string value.
4020 void DIEString::EmitValue(DwarfDebug &DD, unsigned Form) {
4021 DD.getAsm()->EmitString(String);
4024 //===----------------------------------------------------------------------===//
4026 /// EmitValue - Emit label value.
4028 void DIEDwarfLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
4029 bool IsSmall = Form == DW_FORM_data4;
4030 DD.EmitReference(Label, false, IsSmall);
4033 /// SizeOf - Determine size of label value in bytes.
4035 unsigned DIEDwarfLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4036 if (Form == DW_FORM_data4) return 4;
4037 return DD.getTargetData()->getPointerSize();
4040 //===----------------------------------------------------------------------===//
4042 /// EmitValue - Emit label value.
4044 void DIEObjectLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
4045 bool IsSmall = Form == DW_FORM_data4;
4046 DD.EmitReference(Label, false, IsSmall);
4049 /// SizeOf - Determine size of label value in bytes.
4051 unsigned DIEObjectLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4052 if (Form == DW_FORM_data4) return 4;
4053 return DD.getTargetData()->getPointerSize();
4056 //===----------------------------------------------------------------------===//
4058 /// EmitValue - Emit delta value.
4060 void DIESectionOffset::EmitValue(DwarfDebug &DD, unsigned Form) {
4061 bool IsSmall = Form == DW_FORM_data4;
4062 DD.EmitSectionOffset(Label.Tag, Section.Tag,
4063 Label.Number, Section.Number, IsSmall, IsEH, UseSet);
4066 /// SizeOf - Determine size of delta value in bytes.
4068 unsigned DIESectionOffset::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4069 if (Form == DW_FORM_data4) return 4;
4070 return DD.getTargetData()->getPointerSize();
4073 //===----------------------------------------------------------------------===//
4075 /// EmitValue - Emit delta value.
4077 void DIEDelta::EmitValue(DwarfDebug &DD, unsigned Form) {
4078 bool IsSmall = Form == DW_FORM_data4;
4079 DD.EmitDifference(LabelHi, LabelLo, IsSmall);
4082 /// SizeOf - Determine size of delta value in bytes.
4084 unsigned DIEDelta::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4085 if (Form == DW_FORM_data4) return 4;
4086 return DD.getTargetData()->getPointerSize();
4089 //===----------------------------------------------------------------------===//
4091 /// EmitValue - Emit debug information entry offset.
4093 void DIEntry::EmitValue(DwarfDebug &DD, unsigned Form) {
4094 DD.getAsm()->EmitInt32(Entry->getOffset());
4097 //===----------------------------------------------------------------------===//
4099 /// ComputeSize - calculate the size of the block.
4101 unsigned DIEBlock::ComputeSize(DwarfDebug &DD) {
4103 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
4105 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4106 Size += Values[i]->SizeOf(DD, AbbrevData[i].getForm());
4112 /// EmitValue - Emit block data.
4114 void DIEBlock::EmitValue(DwarfDebug &DD, unsigned Form) {
4116 case DW_FORM_block1: DD.getAsm()->EmitInt8(Size); break;
4117 case DW_FORM_block2: DD.getAsm()->EmitInt16(Size); break;
4118 case DW_FORM_block4: DD.getAsm()->EmitInt32(Size); break;
4119 case DW_FORM_block: DD.getAsm()->EmitULEB128Bytes(Size); break;
4120 default: assert(0 && "Improper form for block"); break;
4123 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
4125 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4127 Values[i]->EmitValue(DD, AbbrevData[i].getForm());
4131 /// SizeOf - Determine size of block data in bytes.
4133 unsigned DIEBlock::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4135 case DW_FORM_block1: return Size + sizeof(int8_t);
4136 case DW_FORM_block2: return Size + sizeof(int16_t);
4137 case DW_FORM_block4: return Size + sizeof(int32_t);
4138 case DW_FORM_block: return Size + TargetAsmInfo::getULEB128Size(Size);
4139 default: assert(0 && "Improper form for block"); break;
4144 //===----------------------------------------------------------------------===//
4145 /// DIE Implementation
4148 for (unsigned i = 0, N = Children.size(); i < N; ++i)
4152 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
4154 void DIE::AddSiblingOffset() {
4155 DIEInteger *DI = new DIEInteger(0);
4156 Values.insert(Values.begin(), DI);
4157 Abbrev.AddFirstAttribute(DW_AT_sibling, DW_FORM_ref4);
4160 /// Profile - Used to gather unique data for the value folding set.
4162 void DIE::Profile(FoldingSetNodeID &ID) {
4165 for (unsigned i = 0, N = Children.size(); i < N; ++i)
4166 ID.AddPointer(Children[i]);
4168 for (unsigned j = 0, M = Values.size(); j < M; ++j)
4169 ID.AddPointer(Values[j]);
4173 void DIE::print(std::ostream &O, unsigned IncIndent) {
4174 static unsigned IndentCount = 0;
4175 IndentCount += IncIndent;
4176 const std::string Indent(IndentCount, ' ');
4177 bool isBlock = Abbrev.getTag() == 0;
4182 << "0x" << std::hex << (intptr_t)this << std::dec
4183 << ", Offset: " << Offset
4184 << ", Size: " << Size
4188 << TagString(Abbrev.getTag())
4190 << ChildrenString(Abbrev.getChildrenFlag());
4192 O << "Size: " << Size;
4196 const SmallVector<DIEAbbrevData, 8> &Data = Abbrev.getData();
4199 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4203 O << AttributeString(Data[i].getAttribute());
4205 O << "Blk[" << i << "]";
4208 << FormEncodingString(Data[i].getForm())
4210 Values[i]->print(O);
4215 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
4216 Children[j]->print(O, 4);
4219 if (!isBlock) O << "\n";
4220 IndentCount -= IncIndent;
4228 //===----------------------------------------------------------------------===//
4229 /// DwarfWriter Implementation
4232 DwarfWriter::DwarfWriter() : ImmutablePass(&ID), DD(NULL), DE(NULL) {
4235 DwarfWriter::~DwarfWriter() {
4240 /// BeginModule - Emit all Dwarf sections that should come prior to the
4242 void DwarfWriter::BeginModule(Module *M,
4243 MachineModuleInfo *MMI,
4244 raw_ostream &OS, AsmPrinter *A,
4245 const TargetAsmInfo *T) {
4246 DE = new DwarfException(OS, A, T);
4247 DD = new DwarfDebug(OS, A, T);
4250 DD->SetDebugInfo(MMI);
4251 DE->SetModuleInfo(MMI);
4254 /// EndModule - Emit all Dwarf sections that should come after the content.
4256 void DwarfWriter::EndModule() {
4261 /// BeginFunction - Gather pre-function debug information. Assumes being
4262 /// emitted immediately after the function entry point.
4263 void DwarfWriter::BeginFunction(MachineFunction *MF) {
4264 DE->BeginFunction(MF);
4265 DD->BeginFunction(MF);
4268 /// EndFunction - Gather and emit post-function debug information.
4270 void DwarfWriter::EndFunction(MachineFunction *MF) {
4271 DD->EndFunction(MF);
4274 if (MachineModuleInfo *MMI = DD->getMMI() ? DD->getMMI() : DE->getMMI())
4275 // Clear function debug information.
4279 /// ValidDebugInfo - Return true if V represents valid debug info value.
4280 bool DwarfWriter::ValidDebugInfo(Value *V) {
4281 return DD && DD->ValidDebugInfo(V);
4284 /// RecordSourceLine - Records location information and associates it with a
4285 /// label. Returns a unique label ID used to generate a label and provide
4286 /// correspondence to the source line list.
4287 unsigned DwarfWriter::RecordSourceLine(unsigned Line, unsigned Col,
4289 return DD->RecordSourceLine(Line, Col, Src);
4292 /// RecordSource - Register a source file with debug info. Returns an source
4294 unsigned DwarfWriter::RecordSource(const std::string &Dir,
4295 const std::string &File) {
4296 return DD->RecordSource(Dir, File);
4299 /// RecordRegionStart - Indicate the start of a region.
4300 unsigned DwarfWriter::RecordRegionStart(GlobalVariable *V) {
4301 return DD->RecordRegionStart(V);
4304 /// RecordRegionEnd - Indicate the end of a region.
4305 unsigned DwarfWriter::RecordRegionEnd(GlobalVariable *V) {
4306 return DD->RecordRegionEnd(V);
4309 /// getRecordSourceLineCount - Count source lines.
4310 unsigned DwarfWriter::getRecordSourceLineCount() {
4311 return DD->getRecordSourceLineCount();
4314 /// RecordVariable - Indicate the declaration of a local variable.
4316 void DwarfWriter::RecordVariable(GlobalVariable *GV, unsigned FrameIndex) {
4317 DD->RecordVariable(GV, FrameIndex);