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 DenseMap<GlobalVariable *, DIE *> GVToDieMap;
784 /// GVToDIEntryMap - Tracks the mapping of unit level debug informaton
785 /// descriptors to debug information entries using a DIEntry proxy.
786 DenseMap<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;
796 /// Dies - List of all dies in the compile unit.
798 std::vector<DIE *> Dies;
801 CompileUnit(unsigned I, DIE *D)
802 : ID(I), Die(D), GVToDieMap(),
803 GVToDIEntryMap(), Globals(), DiesSet(InitDiesSetSize), Dies()
809 for (unsigned i = 0, N = Dies.size(); i < N; ++i)
814 unsigned getID() const { return ID; }
815 DIE* getDie() const { return Die; }
816 std::map<std::string, DIE *> &getGlobals() { return Globals; }
818 /// hasContent - Return true if this compile unit has something to write out.
820 bool hasContent() const {
821 return !Die->getChildren().empty();
824 /// AddGlobal - Add a new global entity to the compile unit.
826 void AddGlobal(const std::string &Name, DIE *Die) {
830 /// getDieMapSlotFor - Returns the debug information entry map slot for the
831 /// specified debug variable.
832 DIE *&getDieMapSlotFor(GlobalVariable *GV) {
833 return GVToDieMap[GV];
836 /// getDIEntrySlotFor - Returns the debug information entry proxy slot for the
837 /// specified debug variable.
838 DIEntry *&getDIEntrySlotFor(GlobalVariable *GV) {
839 return GVToDIEntryMap[GV];
842 /// AddDie - Adds or interns the DIE to the compile unit.
844 DIE *AddDie(DIE &Buffer) {
848 DIE *Die = DiesSet.FindNodeOrInsertPos(ID, Where);
851 Die = new DIE(Buffer);
852 DiesSet.InsertNode(Die, Where);
853 this->Die->AddChild(Die);
861 //===----------------------------------------------------------------------===//
862 /// Dwarf - Emits general Dwarf directives.
868 //===--------------------------------------------------------------------===//
869 // Core attributes used by the Dwarf writer.
873 /// O - Stream to .s file.
877 /// Asm - Target of Dwarf emission.
881 /// TAI - Target asm information.
882 const TargetAsmInfo *TAI;
884 /// TD - Target data.
885 const TargetData *TD;
887 /// RI - Register Information.
888 const TargetRegisterInfo *RI;
890 /// M - Current module.
894 /// MF - Current machine function.
898 /// MMI - Collected machine module information.
900 MachineModuleInfo *MMI;
902 /// SubprogramCount - The running count of functions being compiled.
904 unsigned SubprogramCount;
906 /// Flavor - A unique string indicating what dwarf producer this is, used to
908 const char * const Flavor;
911 Dwarf(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T,
916 , TD(Asm->TM.getTargetData())
917 , RI(Asm->TM.getRegisterInfo())
929 //===--------------------------------------------------------------------===//
932 AsmPrinter *getAsm() const { return Asm; }
933 MachineModuleInfo *getMMI() const { return MMI; }
934 const TargetAsmInfo *getTargetAsmInfo() const { return TAI; }
935 const TargetData *getTargetData() const { return TD; }
937 void PrintRelDirective(bool Force32Bit = false, bool isInSection = false)
939 if (isInSection && TAI->getDwarfSectionOffsetDirective())
940 O << TAI->getDwarfSectionOffsetDirective();
941 else if (Force32Bit || TD->getPointerSize() == sizeof(int32_t))
942 O << TAI->getData32bitsDirective();
944 O << TAI->getData64bitsDirective();
947 /// PrintLabelName - Print label name in form used by Dwarf writer.
949 void PrintLabelName(DWLabel Label) const {
950 PrintLabelName(Label.Tag, Label.Number);
952 void PrintLabelName(const char *Tag, unsigned Number) const {
953 O << TAI->getPrivateGlobalPrefix() << Tag;
954 if (Number) O << Number;
957 void PrintLabelName(const char *Tag, unsigned Number,
958 const char *Suffix) const {
959 O << TAI->getPrivateGlobalPrefix() << Tag;
960 if (Number) O << Number;
964 /// EmitLabel - Emit location label for internal use by Dwarf.
966 void EmitLabel(DWLabel Label) const {
967 EmitLabel(Label.Tag, Label.Number);
969 void EmitLabel(const char *Tag, unsigned Number) const {
970 PrintLabelName(Tag, Number);
974 /// EmitReference - Emit a reference to a label.
976 void EmitReference(DWLabel Label, bool IsPCRelative = false,
977 bool Force32Bit = false) const {
978 EmitReference(Label.Tag, Label.Number, IsPCRelative, Force32Bit);
980 void EmitReference(const char *Tag, unsigned Number,
981 bool IsPCRelative = false, bool Force32Bit = false) const {
982 PrintRelDirective(Force32Bit);
983 PrintLabelName(Tag, Number);
985 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
987 void EmitReference(const std::string &Name, bool IsPCRelative = false,
988 bool Force32Bit = false) const {
989 PrintRelDirective(Force32Bit);
993 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
996 /// EmitDifference - Emit the difference between two labels. Some
997 /// assemblers do not behave with absolute expressions with data directives,
998 /// so there is an option (needsSet) to use an intermediary set expression.
999 void EmitDifference(DWLabel LabelHi, DWLabel LabelLo,
1000 bool IsSmall = false) {
1001 EmitDifference(LabelHi.Tag, LabelHi.Number,
1002 LabelLo.Tag, LabelLo.Number,
1005 void EmitDifference(const char *TagHi, unsigned NumberHi,
1006 const char *TagLo, unsigned NumberLo,
1007 bool IsSmall = false) {
1008 if (TAI->needsSet()) {
1010 PrintLabelName("set", SetCounter, Flavor);
1012 PrintLabelName(TagHi, NumberHi);
1014 PrintLabelName(TagLo, NumberLo);
1017 PrintRelDirective(IsSmall);
1018 PrintLabelName("set", SetCounter, Flavor);
1021 PrintRelDirective(IsSmall);
1023 PrintLabelName(TagHi, NumberHi);
1025 PrintLabelName(TagLo, NumberLo);
1029 void EmitSectionOffset(const char* Label, const char* Section,
1030 unsigned LabelNumber, unsigned SectionNumber,
1031 bool IsSmall = false, bool isEH = false,
1032 bool useSet = true) {
1033 bool printAbsolute = false;
1035 printAbsolute = TAI->isAbsoluteEHSectionOffsets();
1037 printAbsolute = TAI->isAbsoluteDebugSectionOffsets();
1039 if (TAI->needsSet() && useSet) {
1041 PrintLabelName("set", SetCounter, Flavor);
1043 PrintLabelName(Label, LabelNumber);
1045 if (!printAbsolute) {
1047 PrintLabelName(Section, SectionNumber);
1051 PrintRelDirective(IsSmall);
1053 PrintLabelName("set", SetCounter, Flavor);
1056 PrintRelDirective(IsSmall, true);
1058 PrintLabelName(Label, LabelNumber);
1060 if (!printAbsolute) {
1062 PrintLabelName(Section, SectionNumber);
1067 /// EmitFrameMoves - Emit frame instructions to describe the layout of the
1069 void EmitFrameMoves(const char *BaseLabel, unsigned BaseLabelID,
1070 const std::vector<MachineMove> &Moves, bool isEH) {
1072 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
1073 TargetFrameInfo::StackGrowsUp ?
1074 TD->getPointerSize() : -TD->getPointerSize();
1075 bool IsLocal = BaseLabel && strcmp(BaseLabel, "label") == 0;
1077 for (unsigned i = 0, N = Moves.size(); i < N; ++i) {
1078 const MachineMove &Move = Moves[i];
1079 unsigned LabelID = Move.getLabelID();
1082 LabelID = MMI->MappedLabel(LabelID);
1084 // Throw out move if the label is invalid.
1085 if (!LabelID) continue;
1088 const MachineLocation &Dst = Move.getDestination();
1089 const MachineLocation &Src = Move.getSource();
1091 // Advance row if new location.
1092 if (BaseLabel && LabelID && (BaseLabelID != LabelID || !IsLocal)) {
1093 Asm->EmitInt8(DW_CFA_advance_loc4);
1094 Asm->EOL("DW_CFA_advance_loc4");
1095 EmitDifference("label", LabelID, BaseLabel, BaseLabelID, true);
1098 BaseLabelID = LabelID;
1099 BaseLabel = "label";
1103 // If advancing cfa.
1104 if (Dst.isReg() && Dst.getReg() == MachineLocation::VirtualFP) {
1106 if (Src.getReg() == MachineLocation::VirtualFP) {
1107 Asm->EmitInt8(DW_CFA_def_cfa_offset);
1108 Asm->EOL("DW_CFA_def_cfa_offset");
1110 Asm->EmitInt8(DW_CFA_def_cfa);
1111 Asm->EOL("DW_CFA_def_cfa");
1112 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Src.getReg(), isEH));
1113 Asm->EOL("Register");
1116 int Offset = -Src.getOffset();
1118 Asm->EmitULEB128Bytes(Offset);
1121 assert(0 && "Machine move no supported yet.");
1123 } else if (Src.isReg() &&
1124 Src.getReg() == MachineLocation::VirtualFP) {
1126 Asm->EmitInt8(DW_CFA_def_cfa_register);
1127 Asm->EOL("DW_CFA_def_cfa_register");
1128 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Dst.getReg(), isEH));
1129 Asm->EOL("Register");
1131 assert(0 && "Machine move no supported yet.");
1134 unsigned Reg = RI->getDwarfRegNum(Src.getReg(), isEH);
1135 int Offset = Dst.getOffset() / stackGrowth;
1138 Asm->EmitInt8(DW_CFA_offset_extended_sf);
1139 Asm->EOL("DW_CFA_offset_extended_sf");
1140 Asm->EmitULEB128Bytes(Reg);
1142 Asm->EmitSLEB128Bytes(Offset);
1144 } else if (Reg < 64) {
1145 Asm->EmitInt8(DW_CFA_offset + Reg);
1147 Asm->EOL("DW_CFA_offset + Reg (" + utostr(Reg) + ")");
1150 Asm->EmitULEB128Bytes(Offset);
1153 Asm->EmitInt8(DW_CFA_offset_extended);
1154 Asm->EOL("DW_CFA_offset_extended");
1155 Asm->EmitULEB128Bytes(Reg);
1157 Asm->EmitULEB128Bytes(Offset);
1166 //===----------------------------------------------------------------------===//
1167 /// SrcLineInfo - This class is used to record source line correspondence.
1170 unsigned Line; // Source line number.
1171 unsigned Column; // Source column.
1172 unsigned SourceID; // Source ID number.
1173 unsigned LabelID; // Label in code ID number.
1175 SrcLineInfo(unsigned L, unsigned C, unsigned S, unsigned I)
1176 : Line(L), Column(C), SourceID(S), LabelID(I) {}
1179 unsigned getLine() const { return Line; }
1180 unsigned getColumn() const { return Column; }
1181 unsigned getSourceID() const { return SourceID; }
1182 unsigned getLabelID() const { return LabelID; }
1186 //===----------------------------------------------------------------------===//
1187 /// SrcFileInfo - This class is used to track source information.
1190 unsigned DirectoryID; // Directory ID number.
1191 std::string Name; // File name (not including directory.)
1193 SrcFileInfo(unsigned D, const std::string &N) : DirectoryID(D), Name(N) {}
1196 unsigned getDirectoryID() const { return DirectoryID; }
1197 const std::string &getName() const { return Name; }
1199 /// operator== - Used by UniqueVector to locate entry.
1201 bool operator==(const SrcFileInfo &SI) const {
1202 return getDirectoryID() == SI.getDirectoryID() && getName() == SI.getName();
1205 /// operator< - Used by UniqueVector to locate entry.
1207 bool operator<(const SrcFileInfo &SI) const {
1208 return getDirectoryID() < SI.getDirectoryID() ||
1209 (getDirectoryID() == SI.getDirectoryID() && getName() < SI.getName());
1213 //===----------------------------------------------------------------------===//
1214 /// DbgVariable - This class is used to track local variable information.
1218 DIVariable *Var; // Variable Descriptor.
1219 unsigned FrameIndex; // Variable frame index.
1222 DbgVariable(DIVariable *V, unsigned I) : Var(V), FrameIndex(I) {}
1225 DIVariable *getVariable() const { return Var; }
1226 unsigned getFrameIndex() const { return FrameIndex; }
1229 //===----------------------------------------------------------------------===//
1230 /// DbgScope - This class is used to track scope information.
1234 DbgScope *Parent; // Parent to this scope.
1235 DIDescriptor Desc; // Debug info descriptor for scope.
1236 // Either subprogram or block.
1237 unsigned StartLabelID; // Label ID of the beginning of scope.
1238 unsigned EndLabelID; // Label ID of the end of scope.
1239 SmallVector<DbgScope *, 4> Scopes; // Scopes defined in scope.
1240 SmallVector<DbgVariable *, 8> Variables;// Variables declared in scope.
1243 DbgScope(DbgScope *P, DIDescriptor D)
1244 : Parent(P), Desc(D), StartLabelID(0), EndLabelID(0), Scopes(), Variables()
1247 for (unsigned i = 0, N = Scopes.size(); i < N; ++i) delete Scopes[i];
1248 for (unsigned j = 0, M = Variables.size(); j < M; ++j) delete Variables[j];
1252 DbgScope *getParent() const { return Parent; }
1253 DIDescriptor getDesc() const { return Desc; }
1254 unsigned getStartLabelID() const { return StartLabelID; }
1255 unsigned getEndLabelID() const { return EndLabelID; }
1256 SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
1257 SmallVector<DbgVariable *, 8> &getVariables() { return Variables; }
1258 void setStartLabelID(unsigned S) { StartLabelID = S; }
1259 void setEndLabelID(unsigned E) { EndLabelID = E; }
1261 /// AddScope - Add a scope to the scope.
1263 void AddScope(DbgScope *S) { Scopes.push_back(S); }
1265 /// AddVariable - Add a variable to the scope.
1267 void AddVariable(DbgVariable *V) { Variables.push_back(V); }
1270 //===----------------------------------------------------------------------===//
1271 /// DwarfDebug - Emits Dwarf debug directives.
1273 class DwarfDebug : public Dwarf {
1276 //===--------------------------------------------------------------------===//
1277 // Attributes used to construct specific Dwarf sections.
1280 /// CompileUnits - All the compile units involved in this build. The index
1281 /// of each entry in this vector corresponds to the sources in MMI.
1282 std::vector<CompileUnit *> CompileUnits;
1283 DenseMap<Value *, CompileUnit *> DW_CUs;
1285 /// AbbreviationsSet - Used to uniquely define abbreviations.
1287 FoldingSet<DIEAbbrev> AbbreviationsSet;
1289 /// Abbreviations - A list of all the unique abbreviations in use.
1291 std::vector<DIEAbbrev *> Abbreviations;
1293 /// ValuesSet - Used to uniquely define values.
1295 // Directories - Uniquing vector for directories.
1296 UniqueVector<std::string> Directories;
1298 // SourceFiles - Uniquing vector for source files.
1299 UniqueVector<SrcFileInfo> SrcFiles;
1301 // Lines - List of of source line correspondence.
1302 std::vector<SrcLineInfo> Lines;
1304 FoldingSet<DIEValue> ValuesSet;
1306 /// Values - A list of all the unique values in use.
1308 std::vector<DIEValue *> Values;
1310 /// StringPool - A UniqueVector of strings used by indirect references.
1312 UniqueVector<std::string> StringPool;
1314 /// SectionMap - Provides a unique id per text section.
1316 UniqueVector<const Section*> SectionMap;
1318 /// SectionSourceLines - Tracks line numbers per text section.
1320 std::vector<std::vector<SrcLineInfo> > SectionSourceLines;
1322 /// didInitial - Flag to indicate if initial emission has been done.
1326 /// shouldEmit - Flag to indicate if debug information should be emitted.
1330 // RootDbgScope - Top level scope for the current function.
1332 DbgScope *RootDbgScope;
1334 // DbgScopeMap - Tracks the scopes in the current function.
1335 DenseMap<GlobalVariable *, DbgScope *> DbgScopeMap;
1337 struct FunctionDebugFrameInfo {
1339 std::vector<MachineMove> Moves;
1341 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M):
1342 Number(Num), Moves(M) { }
1345 std::vector<FunctionDebugFrameInfo> DebugFrames;
1349 /// ShouldEmitDwarf - Returns true if Dwarf declarations should be made.
1351 bool ShouldEmitDwarf() const { return shouldEmit; }
1353 /// AssignAbbrevNumber - Define a unique number for the abbreviation.
1355 void AssignAbbrevNumber(DIEAbbrev &Abbrev) {
1356 // Profile the node so that we can make it unique.
1357 FoldingSetNodeID ID;
1360 // Check the set for priors.
1361 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
1363 // If it's newly added.
1364 if (InSet == &Abbrev) {
1365 // Add to abbreviation list.
1366 Abbreviations.push_back(&Abbrev);
1367 // Assign the vector position + 1 as its number.
1368 Abbrev.setNumber(Abbreviations.size());
1370 // Assign existing abbreviation number.
1371 Abbrev.setNumber(InSet->getNumber());
1375 /// NewString - Add a string to the constant pool and returns a label.
1377 DWLabel NewString(const std::string &String) {
1378 unsigned StringID = StringPool.insert(String);
1379 return DWLabel("string", StringID);
1382 /// NewDIEntry - Creates a new DIEntry to be a proxy for a debug information
1384 DIEntry *NewDIEntry(DIE *Entry = NULL) {
1388 FoldingSetNodeID ID;
1389 DIEntry::Profile(ID, Entry);
1391 Value = static_cast<DIEntry *>(ValuesSet.FindNodeOrInsertPos(ID, Where));
1393 if (Value) return Value;
1395 Value = new DIEntry(Entry);
1396 ValuesSet.InsertNode(Value, Where);
1398 Value = new DIEntry(Entry);
1401 Values.push_back(Value);
1405 /// SetDIEntry - Set a DIEntry once the debug information entry is defined.
1407 void SetDIEntry(DIEntry *Value, DIE *Entry) {
1408 Value->Entry = Entry;
1409 // Add to values set if not already there. If it is, we merely have a
1410 // duplicate in the values list (no harm.)
1411 ValuesSet.GetOrInsertNode(Value);
1414 /// AddUInt - Add an unsigned integer attribute data and value.
1416 void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer) {
1417 if (!Form) Form = DIEInteger::BestForm(false, Integer);
1419 FoldingSetNodeID ID;
1420 DIEInteger::Profile(ID, Integer);
1422 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1424 Value = new DIEInteger(Integer);
1425 ValuesSet.InsertNode(Value, Where);
1426 Values.push_back(Value);
1429 Die->AddValue(Attribute, Form, Value);
1432 /// AddSInt - Add an signed integer attribute data and value.
1434 void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer) {
1435 if (!Form) Form = DIEInteger::BestForm(true, Integer);
1437 FoldingSetNodeID ID;
1438 DIEInteger::Profile(ID, (uint64_t)Integer);
1440 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1442 Value = new DIEInteger(Integer);
1443 ValuesSet.InsertNode(Value, Where);
1444 Values.push_back(Value);
1447 Die->AddValue(Attribute, Form, Value);
1450 /// AddString - Add a std::string attribute data and value.
1452 void AddString(DIE *Die, unsigned Attribute, unsigned Form,
1453 const std::string &String) {
1454 FoldingSetNodeID ID;
1455 DIEString::Profile(ID, String);
1457 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1459 Value = new DIEString(String);
1460 ValuesSet.InsertNode(Value, Where);
1461 Values.push_back(Value);
1464 Die->AddValue(Attribute, Form, Value);
1467 /// AddLabel - Add a Dwarf label attribute data and value.
1469 void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
1470 const DWLabel &Label) {
1471 FoldingSetNodeID ID;
1472 DIEDwarfLabel::Profile(ID, Label);
1474 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1476 Value = new DIEDwarfLabel(Label);
1477 ValuesSet.InsertNode(Value, Where);
1478 Values.push_back(Value);
1481 Die->AddValue(Attribute, Form, Value);
1484 /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
1486 void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
1487 const std::string &Label) {
1488 FoldingSetNodeID ID;
1489 DIEObjectLabel::Profile(ID, Label);
1491 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1493 Value = new DIEObjectLabel(Label);
1494 ValuesSet.InsertNode(Value, Where);
1495 Values.push_back(Value);
1498 Die->AddValue(Attribute, Form, Value);
1501 /// AddSectionOffset - Add a section offset label attribute data and value.
1503 void AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
1504 const DWLabel &Label, const DWLabel &Section,
1505 bool isEH = false, bool useSet = true) {
1506 FoldingSetNodeID ID;
1507 DIESectionOffset::Profile(ID, Label, Section);
1509 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1511 Value = new DIESectionOffset(Label, Section, isEH, useSet);
1512 ValuesSet.InsertNode(Value, Where);
1513 Values.push_back(Value);
1516 Die->AddValue(Attribute, Form, Value);
1519 /// AddDelta - Add a label delta attribute data and value.
1521 void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
1522 const DWLabel &Hi, const DWLabel &Lo) {
1523 FoldingSetNodeID ID;
1524 DIEDelta::Profile(ID, Hi, Lo);
1526 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1528 Value = new DIEDelta(Hi, Lo);
1529 ValuesSet.InsertNode(Value, Where);
1530 Values.push_back(Value);
1533 Die->AddValue(Attribute, Form, Value);
1536 /// AddDIEntry - Add a DIE attribute data and value.
1538 void AddDIEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
1539 Die->AddValue(Attribute, Form, NewDIEntry(Entry));
1542 /// AddBlock - Add block data.
1544 void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block) {
1545 Block->ComputeSize(*this);
1546 FoldingSetNodeID ID;
1549 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1552 ValuesSet.InsertNode(Value, Where);
1553 Values.push_back(Value);
1555 // Already exists, reuse the previous one.
1557 Block = cast<DIEBlock>(Value);
1560 Die->AddValue(Attribute, Block->BestForm(), Value);
1565 /// AddSourceLine - Add location information to specified debug information
1567 void AddSourceLine(DIE *Die, DIVariable *V) {
1568 unsigned FileID = 0;
1569 unsigned Line = V->getLineNumber();
1570 if (V->getVersion() < DIDescriptor::Version7) {
1571 // Version6 or earlier. Use compile unit info to get file id.
1572 CompileUnit *Unit = FindCompileUnit(V->getCompileUnit());
1573 FileID = Unit->getID();
1575 // Version7 or newer, use filename and directory info from DIVariable
1577 unsigned DID = Directories.idFor(V->getDirectory());
1578 FileID = SrcFiles.idFor(SrcFileInfo(DID, V->getFilename()));
1580 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1581 AddUInt(Die, DW_AT_decl_line, 0, Line);
1584 /// AddSourceLine - Add location information to specified debug information
1586 void AddSourceLine(DIE *Die, DIGlobal *G) {
1587 unsigned FileID = 0;
1588 unsigned Line = G->getLineNumber();
1589 if (G->getVersion() < DIDescriptor::Version7) {
1590 // Version6 or earlier. Use compile unit info to get file id.
1591 CompileUnit *Unit = FindCompileUnit(G->getCompileUnit());
1592 FileID = Unit->getID();
1594 // Version7 or newer, use filename and directory info from DIGlobal
1596 unsigned DID = Directories.idFor(G->getDirectory());
1597 FileID = SrcFiles.idFor(SrcFileInfo(DID, G->getFilename()));
1599 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1600 AddUInt(Die, DW_AT_decl_line, 0, Line);
1603 void AddSourceLine(DIE *Die, DIType *G) {
1604 unsigned FileID = 0;
1605 unsigned Line = G->getLineNumber();
1606 if (G->getVersion() < DIDescriptor::Version7) {
1607 // Version6 or earlier. Use compile unit info to get file id.
1608 CompileUnit *Unit = FindCompileUnit(G->getCompileUnit());
1609 FileID = Unit->getID();
1611 // Version7 or newer, use filename and directory info from DIGlobal
1613 unsigned DID = Directories.idFor(G->getDirectory());
1614 FileID = SrcFiles.idFor(SrcFileInfo(DID, G->getFilename()));
1616 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1617 AddUInt(Die, DW_AT_decl_line, 0, Line);
1620 /// AddAddress - Add an address attribute to a die based on the location
1622 void AddAddress(DIE *Die, unsigned Attribute,
1623 const MachineLocation &Location) {
1624 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
1625 DIEBlock *Block = new DIEBlock();
1627 if (Location.isReg()) {
1629 AddUInt(Block, 0, DW_FORM_data1, DW_OP_reg0 + Reg);
1631 AddUInt(Block, 0, DW_FORM_data1, DW_OP_regx);
1632 AddUInt(Block, 0, DW_FORM_udata, Reg);
1636 AddUInt(Block, 0, DW_FORM_data1, DW_OP_breg0 + Reg);
1638 AddUInt(Block, 0, DW_FORM_data1, DW_OP_bregx);
1639 AddUInt(Block, 0, DW_FORM_udata, Reg);
1641 AddUInt(Block, 0, DW_FORM_sdata, Location.getOffset());
1644 AddBlock(Die, Attribute, 0, Block);
1647 /// AddBasicType - Add a new basic type attribute to the specified entity.
1649 void AddBasicType(DIE *Entity, CompileUnit *Unit,
1650 const std::string &Name,
1651 unsigned Encoding, unsigned Size) {
1653 DIE Buffer(DW_TAG_base_type);
1654 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1655 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, Encoding);
1656 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1657 DIE *BasicTypeDie = Unit->AddDie(Buffer);
1658 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, BasicTypeDie);
1661 /// AddPointerType - Add a new pointer type attribute to the specified entity.
1663 void AddPointerType(DIE *Entity, CompileUnit *Unit, const std::string &Name) {
1664 DIE Buffer(DW_TAG_pointer_type);
1665 AddUInt(&Buffer, DW_AT_byte_size, 0, TD->getPointerSize());
1666 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1667 DIE *PointerTypeDie = Unit->AddDie(Buffer);
1668 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, PointerTypeDie);
1671 /// AddType - Add a new type attribute to the specified entity.
1672 void AddType(CompileUnit *DW_Unit, DIE *Entity, DIType Ty) {
1674 AddBasicType(Entity, DW_Unit, "", DW_ATE_signed, sizeof(int32_t));
1678 // Check for pre-existence.
1679 DIEntry *&Slot = DW_Unit->getDIEntrySlotFor(Ty.getGV());
1680 // If it exists then use the existing value.
1682 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1687 Slot = NewDIEntry();
1690 DIE Buffer(DW_TAG_base_type);
1691 if (Ty.isBasicType(Ty.getTag()))
1692 ConstructTypeDIE(DW_Unit, Buffer, DIBasicType(Ty.getGV()));
1693 else if (Ty.isDerivedType(Ty.getTag()))
1694 ConstructTypeDIE(DW_Unit, Buffer, DIDerivedType(Ty.getGV()));
1696 assert (Ty.isCompositeType(Ty.getTag()) && "Unknown kind of DIType");
1697 ConstructTypeDIE(DW_Unit, Buffer, DICompositeType(Ty.getGV()));
1700 // Add debug information entry to entity and unit.
1701 DIE *Die = DW_Unit->AddDie(Buffer);
1702 SetDIEntry(Slot, Die);
1703 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1706 /// ConstructTypeDIE - Construct basic type die from DIBasicType.
1707 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1710 // Get core information.
1711 const std::string &Name = BTy.getName();
1712 Buffer.setTag(DW_TAG_base_type);
1713 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, BTy.getEncoding());
1714 // Add name if not anonymous or intermediate type.
1716 AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1717 uint64_t Size = BTy.getSizeInBits() >> 3;
1718 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1721 /// ConstructTypeDIE - Construct derived type die from DIDerivedType.
1722 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1723 DIDerivedType DTy) {
1725 // Get core information.
1726 const std::string &Name = DTy.getName();
1727 uint64_t Size = DTy.getSizeInBits() >> 3;
1728 unsigned Tag = DTy.getTag();
1729 // FIXME - Workaround for templates.
1730 if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
1733 // Map to main type, void will not have a type.
1734 DIType FromTy = DTy.getTypeDerivedFrom();
1735 AddType(DW_Unit, &Buffer, FromTy);
1737 // Add name if not anonymous or intermediate type.
1738 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1740 // Add size if non-zero (derived types might be zero-sized.)
1742 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1744 // Add source line info if available and TyDesc is not a forward
1746 // FIXME - Enable this. if (!DTy.isForwardDecl())
1747 // FIXME - Enable this. AddSourceLine(&Buffer, *DTy);
1750 /// ConstructTypeDIE - Construct type DIE from DICompositeType.
1751 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1752 DICompositeType CTy) {
1754 // Get core information.
1755 const std::string &Name = CTy.getName();
1756 uint64_t Size = CTy.getSizeInBits() >> 3;
1757 unsigned Tag = CTy.getTag();
1759 case DW_TAG_vector_type:
1760 case DW_TAG_array_type:
1761 ConstructArrayTypeDIE(DW_Unit, Buffer, &CTy);
1763 //FIXME - Enable this.
1764 // case DW_TAG_enumeration_type:
1765 // DIArray Elements = CTy.getTypeArray();
1766 // // Add enumerators to enumeration type.
1767 // for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i)
1768 // ConstructEnumTypeDIE(Buffer, &Elements.getElement(i));
1770 case DW_TAG_subroutine_type:
1772 // Add prototype flag.
1773 AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
1774 DIArray Elements = CTy.getTypeArray();
1776 DIDescriptor RTy = Elements.getElement(0);
1777 AddType(DW_Unit, &Buffer, DIType(RTy.getGV()));
1779 //AddType(DW_Unit, &Buffer, Elements.getElement(0));
1781 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1782 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1783 DIDescriptor Ty = Elements.getElement(i);
1784 AddType(DW_Unit, &Buffer, DIType(Ty.getGV()));
1785 Buffer.AddChild(Arg);
1789 case DW_TAG_structure_type:
1790 case DW_TAG_union_type:
1792 // Add elements to structure type.
1793 DIArray Elements = CTy.getTypeArray();
1795 // A forward struct declared type may not have elements available.
1796 if (Elements.isNull())
1799 // Add elements to structure type.
1800 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1801 DIDescriptor Element = Elements.getElement(i);
1802 if (Element.getTag() == dwarf::DW_TAG_subprogram)
1803 ConstructFieldTypeDIE(DW_Unit, Buffer, DISubprogram(Element.getGV()));
1804 else if (Element.getTag() == dwarf::DW_TAG_variable)
1805 ConstructFieldTypeDIE(DW_Unit, Buffer,
1806 DIGlobalVariable(Element.getGV()));
1808 DIDerivedType DT = DIDerivedType(Element.getGV());
1809 assert (DT.isDerivedType(DT.getTag()) && "Unexpected strcut element");
1810 ConstructFieldTypeDIE(DW_Unit, Buffer, DT);
1819 // Add name if not anonymous or intermediate type.
1820 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1822 // Add size if non-zero (derived types might be zero-sized.)
1824 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1826 // Add zero size even if it is not a forward declaration.
1827 // FIXME - Enable this.
1828 // if (!CTy.isDefinition())
1829 // AddUInt(&Buffer, DW_AT_declaration, DW_FORM_flag, 1);
1831 // AddUInt(&Buffer, DW_AT_byte_size, 0, 0);
1834 // Add source line info if available and TyDesc is not a forward
1836 // FIXME - Enable this.
1837 // if (CTy.isForwardDecl())
1838 // AddSourceLine(&Buffer, *CTy);
1841 // ConstructSubrangeDIE - Construct subrange DIE from DISubrange.
1842 void ConstructSubrangeDIE (DIE &Buffer, DISubrange SR, DIE *IndexTy) {
1843 int64_t L = SR.getLo();
1844 int64_t H = SR.getHi();
1845 DIE *DW_Subrange = new DIE(DW_TAG_subrange_type);
1847 AddDIEntry(DW_Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1849 AddSInt(DW_Subrange, DW_AT_lower_bound, 0, L);
1850 AddSInt(DW_Subrange, DW_AT_upper_bound, 0, H);
1852 Buffer.AddChild(DW_Subrange);
1855 /// ConstructArrayTypeDIE - Construct array type DIE from DICompositeType.
1856 void ConstructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1857 DICompositeType *CTy) {
1858 Buffer.setTag(DW_TAG_array_type);
1859 if (CTy->getTag() == DW_TAG_vector_type)
1860 AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1862 DIArray Elements = CTy->getTypeArray();
1863 // FIXME - Enable this.
1864 AddType(DW_Unit, &Buffer, CTy->getTypeDerivedFrom());
1866 // Construct an anonymous type for index type.
1867 DIE IdxBuffer(DW_TAG_base_type);
1868 AddUInt(&IdxBuffer, DW_AT_byte_size, 0, sizeof(int32_t));
1869 AddUInt(&IdxBuffer, DW_AT_encoding, DW_FORM_data1, DW_ATE_signed);
1870 DIE *IndexTy = DW_Unit->AddDie(IdxBuffer);
1872 // Add subranges to array type.
1873 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1874 DIDescriptor Element = Elements.getElement(i);
1875 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
1876 ConstructSubrangeDIE(Buffer, DISubrange(Element.getGV()), IndexTy);
1880 /// ConstructEnumTypeDIE - Construct enum type DIE from
1882 void ConstructEnumTypeDIE(CompileUnit *DW_Unit,
1883 DIE &Buffer, DIEnumerator *ETy) {
1885 DIE *Enumerator = new DIE(DW_TAG_enumerator);
1886 AddString(Enumerator, DW_AT_name, DW_FORM_string, ETy->getName());
1887 int64_t Value = ETy->getEnumValue();
1888 AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
1889 Buffer.AddChild(Enumerator);
1892 /// ConstructFieldTypeDIE - Construct variable DIE for a struct field.
1893 void ConstructFieldTypeDIE(CompileUnit *DW_Unit,
1894 DIE &Buffer, DIGlobalVariable V) {
1896 DIE *VariableDie = new DIE(DW_TAG_variable);
1897 const std::string &LinkageName = V.getLinkageName();
1898 if (!LinkageName.empty())
1899 AddString(VariableDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
1901 // FIXME - Enable this. AddSourceLine(VariableDie, V);
1902 AddType(DW_Unit, VariableDie, V.getType());
1903 if (!V.isLocalToUnit())
1904 AddUInt(VariableDie, DW_AT_external, DW_FORM_flag, 1);
1905 AddUInt(VariableDie, DW_AT_declaration, DW_FORM_flag, 1);
1906 Buffer.AddChild(VariableDie);
1909 /// ConstructFieldTypeDIE - Construct subprogram DIE for a struct field.
1910 void ConstructFieldTypeDIE(CompileUnit *DW_Unit,
1911 DIE &Buffer, DISubprogram SP,
1912 bool IsConstructor = false) {
1913 DIE *Method = new DIE(DW_TAG_subprogram);
1914 AddString(Method, DW_AT_name, DW_FORM_string, SP.getName());
1915 const std::string &LinkageName = SP.getLinkageName();
1916 if (!LinkageName.empty())
1917 AddString(Method, DW_AT_MIPS_linkage_name, DW_FORM_string, LinkageName);
1918 // FIXME - Enable this. AddSourceLine(Method, SP);
1920 DICompositeType MTy = SP.getType();
1921 DIArray Args = MTy.getTypeArray();
1925 AddType(DW_Unit, Method, DIType(Args.getElement(0).getGV()));
1928 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1929 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1930 AddType(DW_Unit, Method, DIType(Args.getElement(i).getGV()));
1931 AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1); // ???
1932 Method->AddChild(Arg);
1935 if (!SP.isLocalToUnit())
1936 AddUInt(Method, DW_AT_external, DW_FORM_flag, 1);
1937 Buffer.AddChild(Method);
1940 /// ConstructFieldTypeDIE - Construct derived type DIE for a struct field.
1941 void ConstructFieldTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1942 DIDerivedType DTy) {
1943 unsigned Tag = DTy.getTag();
1944 DIE *MemberDie = new DIE(Tag);
1945 if (!DTy.getName().empty())
1946 AddString(MemberDie, DW_AT_name, DW_FORM_string, DTy.getName());
1947 // FIXME - Enable this. AddSourceLine(MemberDie, DTy);
1949 DIType FromTy = DTy.getTypeDerivedFrom();
1950 AddType(DW_Unit, MemberDie, FromTy);
1952 uint64_t Size = DTy.getSizeInBits();
1953 uint64_t Offset = DTy.getOffsetInBits();
1955 // FIXME Handle bitfields
1958 AddUInt(MemberDie, DW_AT_bit_size, 0, Size);
1959 // Add computation for offset.
1960 DIEBlock *Block = new DIEBlock();
1961 AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
1962 AddUInt(Block, 0, DW_FORM_udata, Offset >> 3);
1963 AddBlock(MemberDie, DW_AT_data_member_location, 0, Block);
1965 // FIXME Handle DW_AT_accessibility.
1967 Buffer.AddChild(MemberDie);
1970 /// FindCompileUnit - Get the compile unit for the given descriptor.
1972 CompileUnit *FindCompileUnit(DICompileUnit Unit) {
1973 CompileUnit *DW_Unit = DW_CUs[Unit.getGV()];
1974 assert(DW_Unit && "Missing compile unit.");
1978 /// NewDbgScopeVariable - Create a new scope variable.
1980 DIE *NewDbgScopeVariable(DbgVariable *DV, CompileUnit *Unit) {
1981 // Get the descriptor.
1982 DIVariable *VD = DV->getVariable();
1984 // Translate tag to proper Dwarf tag. The result variable is dropped for
1987 switch (VD->getTag()) {
1988 case DW_TAG_return_variable: return NULL;
1989 case DW_TAG_arg_variable: Tag = DW_TAG_formal_parameter; break;
1990 case DW_TAG_auto_variable: // fall thru
1991 default: Tag = DW_TAG_variable; break;
1994 // Define variable debug information entry.
1995 DIE *VariableDie = new DIE(Tag);
1996 AddString(VariableDie, DW_AT_name, DW_FORM_string, VD->getName());
1998 // Add source line info if available.
1999 AddSourceLine(VariableDie, VD);
2001 // Add variable type.
2002 AddType(Unit, VariableDie, VD->getType());
2004 // Add variable address.
2005 MachineLocation Location;
2006 Location.set(RI->getFrameRegister(*MF),
2007 RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
2008 AddAddress(VariableDie, DW_AT_location, Location);
2013 /// getOrCreateScope - Returns the scope associated with the given descriptor.
2015 DbgScope *getOrCreateScope(GlobalVariable *V) {
2016 DbgScope *&Slot = DbgScopeMap[V];
2018 // FIXME - breaks down when the context is an inlined function.
2019 DIDescriptor ParentDesc;
2020 DIDescriptor Desc(V);
2021 if (Desc.getTag() == dwarf::DW_TAG_lexical_block) {
2023 ParentDesc = Block.getContext();
2025 DbgScope *Parent = ParentDesc.isNull() ?
2026 NULL : getOrCreateScope(ParentDesc.getGV());
2027 Slot = new DbgScope(Parent, Desc);
2029 Parent->AddScope(Slot);
2030 } else if (RootDbgScope) {
2031 // FIXME - Add inlined function scopes to the root so we can delete
2032 // them later. Long term, handle inlined functions properly.
2033 RootDbgScope->AddScope(Slot);
2035 // First function is top level function.
2036 RootDbgScope = Slot;
2042 /// ConstructDbgScope - Construct the components of a scope.
2044 void ConstructDbgScope(DbgScope *ParentScope,
2045 unsigned ParentStartID, unsigned ParentEndID,
2046 DIE *ParentDie, CompileUnit *Unit) {
2047 // Add variables to scope.
2048 SmallVector<DbgVariable *, 8> &Variables = ParentScope->getVariables();
2049 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2050 DIE *VariableDie = NewDbgScopeVariable(Variables[i], Unit);
2051 if (VariableDie) ParentDie->AddChild(VariableDie);
2054 // Add nested scopes.
2055 SmallVector<DbgScope *, 4> &Scopes = ParentScope->getScopes();
2056 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
2057 // Define the Scope debug information entry.
2058 DbgScope *Scope = Scopes[j];
2059 // FIXME - Ignore inlined functions for the time being.
2060 if (!Scope->getParent()) continue;
2062 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
2063 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
2065 // Ignore empty scopes.
2066 if (StartID == EndID && StartID != 0) continue;
2067 if (Scope->getScopes().empty() && Scope->getVariables().empty()) continue;
2069 if (StartID == ParentStartID && EndID == ParentEndID) {
2070 // Just add stuff to the parent scope.
2071 ConstructDbgScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
2073 DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
2075 // Add the scope bounds.
2077 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2078 DWLabel("label", StartID));
2080 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2081 DWLabel("func_begin", SubprogramCount));
2084 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2085 DWLabel("label", EndID));
2087 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2088 DWLabel("func_end", SubprogramCount));
2091 // Add the scope contents.
2092 ConstructDbgScope(Scope, StartID, EndID, ScopeDie, Unit);
2093 ParentDie->AddChild(ScopeDie);
2098 /// ConstructRootDbgScope - Construct the scope for the subprogram.
2100 void ConstructRootDbgScope(DbgScope *RootScope) {
2101 // Exit if there is no root scope.
2102 if (!RootScope) return;
2103 DIDescriptor Desc = RootScope->getDesc();
2107 // Get the subprogram debug information entry.
2108 DISubprogram SPD(Desc.getGV());
2110 // Get the compile unit context.
2111 CompileUnit *Unit = FindCompileUnit(SPD.getCompileUnit());
2113 // Get the subprogram die.
2114 DIE *SPDie = Unit->getDieMapSlotFor(SPD.getGV());
2115 assert(SPDie && "Missing subprogram descriptor");
2117 // Add the function bounds.
2118 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2119 DWLabel("func_begin", SubprogramCount));
2120 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2121 DWLabel("func_end", SubprogramCount));
2122 MachineLocation Location(RI->getFrameRegister(*MF));
2123 AddAddress(SPDie, DW_AT_frame_base, Location);
2125 ConstructDbgScope(RootScope, 0, 0, SPDie, Unit);
2128 /// ConstructDefaultDbgScope - Construct a default scope for the subprogram.
2130 void ConstructDefaultDbgScope(MachineFunction *MF) {
2131 // Find the correct subprogram descriptor.
2132 std::string SPName = "llvm.dbg.subprograms";
2133 std::vector<GlobalVariable*> Result;
2134 getGlobalVariablesUsing(*M, SPName, Result);
2135 for (std::vector<GlobalVariable *>::iterator I = Result.begin(),
2136 E = Result.end(); I != E; ++I) {
2138 DISubprogram *SPD = new DISubprogram(*I);
2140 if (SPD->getName() == MF->getFunction()->getName()) {
2141 // Get the compile unit context.
2142 CompileUnit *Unit = FindCompileUnit(SPD->getCompileUnit());
2144 // Get the subprogram die.
2145 DIE *SPDie = Unit->getDieMapSlotFor(SPD->getGV());
2146 assert(SPDie && "Missing subprogram descriptor");
2148 // Add the function bounds.
2149 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2150 DWLabel("func_begin", SubprogramCount));
2151 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2152 DWLabel("func_end", SubprogramCount));
2154 MachineLocation Location(RI->getFrameRegister(*MF));
2155 AddAddress(SPDie, DW_AT_frame_base, Location);
2160 // FIXME: This is causing an abort because C++ mangled names are compared
2161 // with their unmangled counterparts. See PR2885. Don't do this assert.
2162 assert(0 && "Couldn't find DIE for machine function!");
2166 /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
2167 /// tools to recognize the object file contains Dwarf information.
2168 void EmitInitial() {
2169 // Check to see if we already emitted intial headers.
2170 if (didInitial) return;
2173 // Dwarf sections base addresses.
2174 if (TAI->doesDwarfRequireFrameSection()) {
2175 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2176 EmitLabel("section_debug_frame", 0);
2178 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2179 EmitLabel("section_info", 0);
2180 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2181 EmitLabel("section_abbrev", 0);
2182 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2183 EmitLabel("section_aranges", 0);
2184 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2185 EmitLabel("section_macinfo", 0);
2186 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2187 EmitLabel("section_line", 0);
2188 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2189 EmitLabel("section_loc", 0);
2190 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2191 EmitLabel("section_pubnames", 0);
2192 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2193 EmitLabel("section_str", 0);
2194 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2195 EmitLabel("section_ranges", 0);
2197 Asm->SwitchToSection(TAI->getTextSection());
2198 EmitLabel("text_begin", 0);
2199 Asm->SwitchToSection(TAI->getDataSection());
2200 EmitLabel("data_begin", 0);
2203 /// EmitDIE - Recusively Emits a debug information entry.
2205 void EmitDIE(DIE *Die) {
2206 // Get the abbreviation for this DIE.
2207 unsigned AbbrevNumber = Die->getAbbrevNumber();
2208 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2212 // Emit the code (index) for the abbreviation.
2213 Asm->EmitULEB128Bytes(AbbrevNumber);
2216 Asm->EOL(std::string("Abbrev [" +
2217 utostr(AbbrevNumber) +
2218 "] 0x" + utohexstr(Die->getOffset()) +
2219 ":0x" + utohexstr(Die->getSize()) + " " +
2220 TagString(Abbrev->getTag())));
2224 SmallVector<DIEValue*, 32> &Values = Die->getValues();
2225 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2227 // Emit the DIE attribute values.
2228 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2229 unsigned Attr = AbbrevData[i].getAttribute();
2230 unsigned Form = AbbrevData[i].getForm();
2231 assert(Form && "Too many attributes for DIE (check abbreviation)");
2234 case DW_AT_sibling: {
2235 Asm->EmitInt32(Die->SiblingOffset());
2239 // Emit an attribute using the defined form.
2240 Values[i]->EmitValue(*this, Form);
2245 Asm->EOL(AttributeString(Attr));
2248 // Emit the DIE children if any.
2249 if (Abbrev->getChildrenFlag() == DW_CHILDREN_yes) {
2250 const std::vector<DIE *> &Children = Die->getChildren();
2252 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2253 EmitDIE(Children[j]);
2256 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2260 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
2262 unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
2263 // Get the children.
2264 const std::vector<DIE *> &Children = Die->getChildren();
2266 // If not last sibling and has children then add sibling offset attribute.
2267 if (!Last && !Children.empty()) Die->AddSiblingOffset();
2269 // Record the abbreviation.
2270 AssignAbbrevNumber(Die->getAbbrev());
2272 // Get the abbreviation for this DIE.
2273 unsigned AbbrevNumber = Die->getAbbrevNumber();
2274 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2277 Die->setOffset(Offset);
2279 // Start the size with the size of abbreviation code.
2280 Offset += TargetAsmInfo::getULEB128Size(AbbrevNumber);
2282 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2283 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2285 // Size the DIE attribute values.
2286 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2287 // Size attribute value.
2288 Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
2291 // Size the DIE children if any.
2292 if (!Children.empty()) {
2293 assert(Abbrev->getChildrenFlag() == DW_CHILDREN_yes &&
2294 "Children flag not set");
2296 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2297 Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
2300 // End of children marker.
2301 Offset += sizeof(int8_t);
2304 Die->setSize(Offset - Die->getOffset());
2308 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
2310 void SizeAndOffsets() {
2311 // Process base compile unit.
2312 for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
2313 CE = DW_CUs.end(); CI != CE; ++CI) {
2314 CompileUnit *Unit = CI->second;
2315 // Compute size of compile unit header
2316 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2317 sizeof(int16_t) + // DWARF version number
2318 sizeof(int32_t) + // Offset Into Abbrev. Section
2319 sizeof(int8_t); // Pointer Size (in bytes)
2320 SizeAndOffsetDie(Unit->getDie(), Offset, true);
2324 /// EmitDebugInfo - Emit the debug info section.
2326 void EmitDebugInfo() {
2327 // Start debug info section.
2328 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2330 for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
2331 CE = DW_CUs.end(); CI != CE; ++CI) {
2332 CompileUnit *Unit = CI->second;
2333 DIE *Die = Unit->getDie();
2334 // Emit the compile units header.
2335 EmitLabel("info_begin", Unit->getID());
2336 // Emit size of content not including length itself
2337 unsigned ContentSize = Die->getSize() +
2338 sizeof(int16_t) + // DWARF version number
2339 sizeof(int32_t) + // Offset Into Abbrev. Section
2340 sizeof(int8_t) + // Pointer Size (in bytes)
2341 sizeof(int32_t); // FIXME - extra pad for gdb bug.
2343 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2344 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2345 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2346 Asm->EOL("Offset Into Abbrev. Section");
2347 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2350 // FIXME - extra padding for gdb bug.
2351 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2352 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2353 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2354 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2355 EmitLabel("info_end", Unit->getID());
2361 /// EmitAbbreviations - Emit the abbreviation section.
2363 void EmitAbbreviations() const {
2364 // Check to see if it is worth the effort.
2365 if (!Abbreviations.empty()) {
2366 // Start the debug abbrev section.
2367 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2369 EmitLabel("abbrev_begin", 0);
2371 // For each abbrevation.
2372 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2373 // Get abbreviation data
2374 const DIEAbbrev *Abbrev = Abbreviations[i];
2376 // Emit the abbrevations code (base 1 index.)
2377 Asm->EmitULEB128Bytes(Abbrev->getNumber());
2378 Asm->EOL("Abbreviation Code");
2380 // Emit the abbreviations data.
2381 Abbrev->Emit(*this);
2386 // Mark end of abbreviations.
2387 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2389 EmitLabel("abbrev_end", 0);
2395 /// EmitEndOfLineMatrix - Emit the last address of the section and the end of
2396 /// the line matrix.
2398 void EmitEndOfLineMatrix(unsigned SectionEnd) {
2399 // Define last address of section.
2400 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2401 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2402 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2403 EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
2405 // Mark end of matrix.
2406 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2407 Asm->EmitULEB128Bytes(1); Asm->EOL();
2408 Asm->EmitInt8(1); Asm->EOL();
2411 /// EmitDebugLines - Emit source line information.
2413 void EmitDebugLines() {
2414 // If the target is using .loc/.file, the assembler will be emitting the
2415 // .debug_line table automatically.
2416 if (TAI->hasDotLocAndDotFile())
2419 // Minimum line delta, thus ranging from -10..(255-10).
2420 const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
2421 // Maximum line delta, thus ranging from -10..(255-10).
2422 const int MaxLineDelta = 255 + MinLineDelta;
2424 // Start the dwarf line section.
2425 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2427 // Construct the section header.
2429 EmitDifference("line_end", 0, "line_begin", 0, true);
2430 Asm->EOL("Length of Source Line Info");
2431 EmitLabel("line_begin", 0);
2433 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2435 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2436 Asm->EOL("Prolog Length");
2437 EmitLabel("line_prolog_begin", 0);
2439 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2441 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2443 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
2445 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2447 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
2449 // Line number standard opcode encodings argument count
2450 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2451 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2452 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2453 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2454 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2455 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2456 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2457 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2458 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2460 // Emit directories.
2461 for (unsigned DirectoryID = 1, NDID = Directories.size();
2462 DirectoryID <= NDID; ++DirectoryID) {
2463 Asm->EmitString(Directories[DirectoryID]); Asm->EOL("Directory");
2465 Asm->EmitInt8(0); Asm->EOL("End of directories");
2468 for (unsigned SourceID = 1, NSID = SrcFiles.size();
2469 SourceID <= NSID; ++SourceID) {
2470 const SrcFileInfo &SourceFile = SrcFiles[SourceID];
2471 Asm->EmitString(SourceFile.getName());
2473 Asm->EmitULEB128Bytes(SourceFile.getDirectoryID());
2474 Asm->EOL("Directory #");
2475 Asm->EmitULEB128Bytes(0);
2476 Asm->EOL("Mod date");
2477 Asm->EmitULEB128Bytes(0);
2478 Asm->EOL("File size");
2480 Asm->EmitInt8(0); Asm->EOL("End of files");
2482 EmitLabel("line_prolog_end", 0);
2484 // A sequence for each text section.
2485 unsigned SecSrcLinesSize = SectionSourceLines.size();
2487 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
2488 // Isolate current sections line info.
2489 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
2492 const Section* S = SectionMap[j + 1];
2493 Asm->EOL(std::string("Section ") + S->getName());
2497 // Dwarf assumes we start with first line of first source file.
2498 unsigned Source = 1;
2501 // Construct rows of the address, source, line, column matrix.
2502 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2503 const SrcLineInfo &LineInfo = LineInfos[i];
2504 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2505 if (!LabelID) continue;
2507 unsigned SourceID = LineInfo.getSourceID();
2508 const SrcFileInfo &SourceFile = SrcFiles[SourceID];
2509 unsigned DirectoryID = SourceFile.getDirectoryID();
2511 Asm->EOL(Directories[DirectoryID]
2512 + SourceFile.getName()
2514 + utostr_32(LineInfo.getLine()));
2518 // Define the line address.
2519 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2520 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2521 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2522 EmitReference("label", LabelID); Asm->EOL("Location label");
2524 // If change of source, then switch to the new source.
2525 if (Source != LineInfo.getSourceID()) {
2526 Source = LineInfo.getSourceID();
2527 Asm->EmitInt8(DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2528 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2531 // If change of line.
2532 if (Line != LineInfo.getLine()) {
2533 // Determine offset.
2534 int Offset = LineInfo.getLine() - Line;
2535 int Delta = Offset - MinLineDelta;
2538 Line = LineInfo.getLine();
2540 // If delta is small enough and in range...
2541 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2542 // ... then use fast opcode.
2543 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2545 // ... otherwise use long hand.
2546 Asm->EmitInt8(DW_LNS_advance_line); Asm->EOL("DW_LNS_advance_line");
2547 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2548 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2551 // Copy the previous row (different address or source)
2552 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2556 EmitEndOfLineMatrix(j + 1);
2559 if (SecSrcLinesSize == 0)
2560 // Because we're emitting a debug_line section, we still need a line
2561 // table. The linker and friends expect it to exist. If there's nothing to
2562 // put into it, emit an empty table.
2563 EmitEndOfLineMatrix(1);
2565 EmitLabel("line_end", 0);
2570 /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
2572 void EmitCommonDebugFrame() {
2573 if (!TAI->doesDwarfRequireFrameSection())
2577 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2578 TargetFrameInfo::StackGrowsUp ?
2579 TD->getPointerSize() : -TD->getPointerSize();
2581 // Start the dwarf frame section.
2582 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2584 EmitLabel("debug_frame_common", 0);
2585 EmitDifference("debug_frame_common_end", 0,
2586 "debug_frame_common_begin", 0, true);
2587 Asm->EOL("Length of Common Information Entry");
2589 EmitLabel("debug_frame_common_begin", 0);
2590 Asm->EmitInt32((int)DW_CIE_ID);
2591 Asm->EOL("CIE Identifier Tag");
2592 Asm->EmitInt8(DW_CIE_VERSION);
2593 Asm->EOL("CIE Version");
2594 Asm->EmitString("");
2595 Asm->EOL("CIE Augmentation");
2596 Asm->EmitULEB128Bytes(1);
2597 Asm->EOL("CIE Code Alignment Factor");
2598 Asm->EmitSLEB128Bytes(stackGrowth);
2599 Asm->EOL("CIE Data Alignment Factor");
2600 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
2601 Asm->EOL("CIE RA Column");
2603 std::vector<MachineMove> Moves;
2604 RI->getInitialFrameState(Moves);
2606 EmitFrameMoves(NULL, 0, Moves, false);
2608 Asm->EmitAlignment(2, 0, 0, false);
2609 EmitLabel("debug_frame_common_end", 0);
2614 /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2616 void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
2617 if (!TAI->doesDwarfRequireFrameSection())
2620 // Start the dwarf frame section.
2621 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2623 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2624 "debug_frame_begin", DebugFrameInfo.Number, true);
2625 Asm->EOL("Length of Frame Information Entry");
2627 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2629 EmitSectionOffset("debug_frame_common", "section_debug_frame",
2631 Asm->EOL("FDE CIE offset");
2633 EmitReference("func_begin", DebugFrameInfo.Number);
2634 Asm->EOL("FDE initial location");
2635 EmitDifference("func_end", DebugFrameInfo.Number,
2636 "func_begin", DebugFrameInfo.Number);
2637 Asm->EOL("FDE address range");
2639 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves, false);
2641 Asm->EmitAlignment(2, 0, 0, false);
2642 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
2647 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
2649 void EmitDebugPubNames() {
2650 // Start the dwarf pubnames section.
2651 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2653 for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
2654 CE = DW_CUs.end(); CI != CE; ++CI) {
2655 CompileUnit *Unit = CI->second;
2657 EmitDifference("pubnames_end", Unit->getID(),
2658 "pubnames_begin", Unit->getID(), true);
2659 Asm->EOL("Length of Public Names Info");
2661 EmitLabel("pubnames_begin", Unit->getID());
2663 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF Version");
2665 EmitSectionOffset("info_begin", "section_info",
2666 Unit->getID(), 0, true, false);
2667 Asm->EOL("Offset of Compilation Unit Info");
2669 EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(),true);
2670 Asm->EOL("Compilation Unit Length");
2672 std::map<std::string, DIE *> &Globals = Unit->getGlobals();
2674 for (std::map<std::string, DIE *>::iterator GI = Globals.begin(),
2677 const std::string &Name = GI->first;
2678 DIE * Entity = GI->second;
2680 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2681 Asm->EmitString(Name); Asm->EOL("External Name");
2684 Asm->EmitInt32(0); Asm->EOL("End Mark");
2685 EmitLabel("pubnames_end", Unit->getID());
2691 /// EmitDebugStr - Emit visible names into a debug str section.
2693 void EmitDebugStr() {
2694 // Check to see if it is worth the effort.
2695 if (!StringPool.empty()) {
2696 // Start the dwarf str section.
2697 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2699 // For each of strings in the string pool.
2700 for (unsigned StringID = 1, N = StringPool.size();
2701 StringID <= N; ++StringID) {
2702 // Emit a label for reference from debug information entries.
2703 EmitLabel("string", StringID);
2704 // Emit the string itself.
2705 const std::string &String = StringPool[StringID];
2706 Asm->EmitString(String); Asm->EOL();
2713 /// EmitDebugLoc - Emit visible names into a debug loc section.
2715 void EmitDebugLoc() {
2716 // Start the dwarf loc section.
2717 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2722 /// EmitDebugARanges - Emit visible names into a debug aranges section.
2724 void EmitDebugARanges() {
2725 // Start the dwarf aranges section.
2726 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2730 CompileUnit *Unit = GetBaseCompileUnit();
2732 // Don't include size of length
2733 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
2735 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("Dwarf Version");
2737 EmitReference("info_begin", Unit->getID());
2738 Asm->EOL("Offset of Compilation Unit Info");
2740 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
2742 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
2744 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
2745 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
2748 EmitReference("text_begin", 0); Asm->EOL("Address");
2749 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
2751 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2752 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
2758 /// EmitDebugRanges - Emit visible names into a debug ranges section.
2760 void EmitDebugRanges() {
2761 // Start the dwarf ranges section.
2762 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2767 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
2769 void EmitDebugMacInfo() {
2770 // Start the dwarf macinfo section.
2771 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2776 /// ConstructCompileUnits - Create a compile unit DIEs.
2777 void ConstructCompileUnits() {
2778 std::string CUName = "llvm.dbg.compile_units";
2779 std::vector<GlobalVariable*> Result;
2780 getGlobalVariablesUsing(*M, CUName, Result);
2781 for (std::vector<GlobalVariable *>::iterator RI = Result.begin(),
2782 RE = Result.end(); RI != RE; ++RI) {
2783 DICompileUnit *DIUnit = new DICompileUnit(*RI);
2784 unsigned ID = RecordSource(DIUnit->getDirectory(),
2785 DIUnit->getFilename());
2787 DIE *Die = new DIE(DW_TAG_compile_unit);
2788 AddSectionOffset(Die, DW_AT_stmt_list, DW_FORM_data4,
2789 DWLabel("section_line", 0), DWLabel("section_line", 0),
2791 AddString(Die, DW_AT_producer, DW_FORM_string, DIUnit->getProducer());
2792 AddUInt(Die, DW_AT_language, DW_FORM_data1, DIUnit->getLanguage());
2793 AddString(Die, DW_AT_name, DW_FORM_string, DIUnit->getFilename());
2794 if (!DIUnit->getDirectory().empty())
2795 AddString(Die, DW_AT_comp_dir, DW_FORM_string, DIUnit->getDirectory());
2797 CompileUnit *Unit = new CompileUnit(ID, Die);
2798 DW_CUs[DIUnit->getGV()] = Unit;
2802 /// ConstructGlobalVariableDIEs - Create DIEs for each of the externally
2803 /// visible global variables.
2804 void ConstructGlobalVariableDIEs() {
2805 std::string GVName = "llvm.dbg.global_variables";
2806 std::vector<GlobalVariable*> Result;
2807 getGlobalVariablesUsing(*M, GVName, Result);
2808 for (std::vector<GlobalVariable *>::iterator GVI = Result.begin(),
2809 GVE = Result.end(); GVI != GVE; ++GVI) {
2810 DIGlobalVariable *DI_GV = new DIGlobalVariable(*GVI);
2811 CompileUnit *DW_Unit = FindCompileUnit(DI_GV->getCompileUnit());
2813 // Check for pre-existence.
2814 DIE *&Slot = DW_Unit->getDieMapSlotFor(DI_GV->getGV());
2817 DIE *VariableDie = new DIE(DW_TAG_variable);
2818 AddString(VariableDie, DW_AT_name, DW_FORM_string, DI_GV->getName());
2819 const std::string &LinkageName = DI_GV->getLinkageName();
2820 if (!LinkageName.empty())
2821 AddString(VariableDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
2823 AddType(DW_Unit, VariableDie, DI_GV->getType());
2825 if (!DI_GV->isLocalToUnit())
2826 AddUInt(VariableDie, DW_AT_external, DW_FORM_flag, 1);
2828 // Add source line info, if available.
2829 AddSourceLine(VariableDie, DI_GV);
2832 DIEBlock *Block = new DIEBlock();
2833 AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
2834 AddObjectLabel(Block, 0, DW_FORM_udata,
2835 Asm->getGlobalLinkName(DI_GV->getGV()));
2836 AddBlock(VariableDie, DW_AT_location, 0, Block);
2841 //Add to context owner.
2842 DW_Unit->getDie()->AddChild(VariableDie);
2844 //Expose as global. FIXME - need to check external flag.
2845 DW_Unit->AddGlobal(DI_GV->getName(), VariableDie);
2849 /// ConstructSubprograms - Create DIEs for each of the externally visible
2851 void ConstructSubprograms() {
2853 std::string SPName = "llvm.dbg.subprograms";
2854 std::vector<GlobalVariable*> Result;
2855 getGlobalVariablesUsing(*M, SPName, Result);
2856 for (std::vector<GlobalVariable *>::iterator RI = Result.begin(),
2857 RE = Result.end(); RI != RE; ++RI) {
2859 DISubprogram *SP = new DISubprogram(*RI);
2860 CompileUnit *Unit = FindCompileUnit(SP->getCompileUnit());
2862 // Check for pre-existence.
2863 DIE *&Slot = Unit->getDieMapSlotFor(SP->getGV());
2866 DIE *SubprogramDie = new DIE(DW_TAG_subprogram);
2867 AddString(SubprogramDie, DW_AT_name, DW_FORM_string, SP->getName());
2868 const std::string &LinkageName = SP->getLinkageName();
2869 if (!LinkageName.empty())
2870 AddString(SubprogramDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
2872 DIType SPTy = SP->getType();
2873 AddType(Unit, SubprogramDie, SPTy);
2874 if (!SP->isLocalToUnit())
2875 AddUInt(SubprogramDie, DW_AT_external, DW_FORM_flag, 1);
2876 AddUInt(SubprogramDie, DW_AT_prototyped, DW_FORM_flag, 1);
2878 AddSourceLine(SubprogramDie, SP);
2880 Slot = SubprogramDie;
2881 //Add to context owner.
2882 Unit->getDie()->AddChild(SubprogramDie);
2884 Unit->AddGlobal(SP->getName(), SubprogramDie);
2889 //===--------------------------------------------------------------------===//
2890 // Main entry points.
2892 DwarfDebug(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
2893 : Dwarf(OS, A, T, "dbg")
2895 , AbbreviationsSet(InitAbbreviationsSetSize)
2897 , ValuesSet(InitValuesSetSize)
2901 , SectionSourceLines()
2904 , RootDbgScope(NULL)
2907 virtual ~DwarfDebug() {
2908 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i)
2909 delete CompileUnits[i];
2910 for (unsigned j = 0, M = Values.size(); j < M; ++j)
2914 /// SetDebugInfo - Create global DIEs and emit initial debug info sections.
2915 /// This is inovked by the target AsmPrinter.
2916 void SetDebugInfo(MachineModuleInfo *mmi) {
2918 // Create all the compile unit DIEs.
2919 ConstructCompileUnits();
2926 MMI->setDebugInfoAvailability(true);
2928 // Create DIEs for each of the externally visible global variables.
2929 ConstructGlobalVariableDIEs();
2931 // Create DIEs for each of the externally visible subprograms.
2932 ConstructSubprograms();
2934 // Prime section data.
2935 SectionMap.insert(TAI->getTextSection());
2937 // Print out .file directives to specify files for .loc directives. These
2938 // are printed out early so that they precede any .loc directives.
2939 if (TAI->hasDotLocAndDotFile()) {
2940 for (unsigned i = 1, e = SrcFiles.size(); i <= e; ++i) {
2941 sys::Path FullPath(Directories[SrcFiles[i].getDirectoryID()]);
2942 bool AppendOk = FullPath.appendComponent(SrcFiles[i].getName());
2943 assert(AppendOk && "Could not append filename to directory!");
2945 Asm->EmitFile(i, FullPath.toString());
2950 // Emit initial sections
2954 /// BeginModule - Emit all Dwarf sections that should come prior to the
2956 void BeginModule(Module *M) {
2960 /// EndModule - Emit all Dwarf sections that should come after the content.
2963 if (!ShouldEmitDwarf()) return;
2965 // Standard sections final addresses.
2966 Asm->SwitchToSection(TAI->getTextSection());
2967 EmitLabel("text_end", 0);
2968 Asm->SwitchToSection(TAI->getDataSection());
2969 EmitLabel("data_end", 0);
2971 // End text sections.
2972 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
2973 Asm->SwitchToSection(SectionMap[i]);
2974 EmitLabel("section_end", i);
2977 // Emit common frame information.
2978 EmitCommonDebugFrame();
2980 // Emit function debug frame information
2981 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2982 E = DebugFrames.end(); I != E; ++I)
2983 EmitFunctionDebugFrame(*I);
2985 // Compute DIE offsets and sizes.
2988 // Emit all the DIEs into a debug info section
2991 // Corresponding abbreviations into a abbrev section.
2992 EmitAbbreviations();
2994 // Emit source line correspondence into a debug line section.
2997 // Emit info into a debug pubnames section.
2998 EmitDebugPubNames();
3000 // Emit info into a debug str section.
3003 // Emit info into a debug loc section.
3006 // Emit info into a debug aranges section.
3009 // Emit info into a debug ranges section.
3012 // Emit info into a debug macinfo section.
3016 /// BeginFunction - Gather pre-function debug information. Assumes being
3017 /// emitted immediately after the function entry point.
3018 void BeginFunction(MachineFunction *MF) {
3021 if (!ShouldEmitDwarf()) return;
3023 // Begin accumulating function debug information.
3024 MMI->BeginFunction(MF);
3026 // Assumes in correct section after the entry point.
3027 EmitLabel("func_begin", ++SubprogramCount);
3029 // Emit label for the implicitly defined dbg.stoppoint at the start of
3031 if (!Lines.empty()) {
3032 const SrcLineInfo &LineInfo = Lines[0];
3033 Asm->printLabel(LineInfo.getLabelID());
3037 /// EndFunction - Gather and emit post-function debug information.
3039 void EndFunction(MachineFunction *MF) {
3040 if (!ShouldEmitDwarf()) return;
3042 // Define end label for subprogram.
3043 EmitLabel("func_end", SubprogramCount);
3045 // Get function line info.
3046 if (!Lines.empty()) {
3047 // Get section line info.
3048 unsigned ID = SectionMap.insert(Asm->CurrentSection_);
3049 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
3050 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
3051 // Append the function info to section info.
3052 SectionLineInfos.insert(SectionLineInfos.end(),
3053 Lines.begin(), Lines.end());
3056 // Construct scopes for subprogram.
3058 ConstructRootDbgScope(RootDbgScope);
3060 // FIXME: This is wrong. We are essentially getting past a problem with
3061 // debug information not being able to handle unreachable blocks that have
3062 // debug information in them. In particular, those unreachable blocks that
3063 // have "region end" info in them. That situation results in the "root
3064 // scope" not being created. If that's the case, then emit a "default"
3065 // scope, i.e., one that encompasses the whole function. This isn't
3066 // desirable. And a better way of handling this (and all of the debugging
3067 // information) needs to be explored.
3068 ConstructDefaultDbgScope(MF);
3070 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
3071 MMI->getFrameMoves()));
3075 delete RootDbgScope;
3076 DbgScopeMap.clear();
3077 RootDbgScope = NULL;
3084 /// ValidDebugInfo - Return true if V represents valid debug info value.
3085 bool ValidDebugInfo(Value *V) {
3090 GlobalVariable *GV = getGlobalVariable(V);
3094 if (GV->getLinkage() != GlobalValue::InternalLinkage
3095 && GV->getLinkage() != GlobalValue::LinkOnceLinkage)
3098 DIDescriptor DI(GV);
3099 // Check current version. Allow Version6 for now.
3100 unsigned Version = DI.getVersion();
3101 if (Version != DIDescriptor::Version7 && Version != DIDescriptor::Version6)
3104 //FIXME - Check individual descriptors.
3108 /// RecordSourceLine - Records location information and associates it with a
3109 /// label. Returns a unique label ID used to generate a label and provide
3110 /// correspondence to the source line list.
3111 unsigned RecordSourceLine(Value *V, unsigned Line, unsigned Col) {
3112 CompileUnit *Unit = DW_CUs[V];
3113 assert (Unit && "Unable to find CompileUnit");
3114 unsigned ID = MMI->NextLabelID();
3115 Lines.push_back(SrcLineInfo(Line, Col, Unit->getID(), ID));
3119 /// RecordSourceLine - Records location information and associates it with a
3120 /// label. Returns a unique label ID used to generate a label and provide
3121 /// correspondence to the source line list.
3122 unsigned RecordSourceLine(unsigned Line, unsigned Col, unsigned Src) {
3123 unsigned ID = MMI->NextLabelID();
3124 Lines.push_back(SrcLineInfo(Line, Col, Src, ID));
3128 unsigned getRecordSourceLineCount() {
3129 return Lines.size();
3132 /// RecordSource - Register a source file with debug info. Returns an source
3134 unsigned RecordSource(const std::string &Directory,
3135 const std::string &File) {
3136 unsigned DID = Directories.insert(Directory);
3137 return SrcFiles.insert(SrcFileInfo(DID,File));
3140 /// RecordRegionStart - Indicate the start of a region.
3142 unsigned RecordRegionStart(GlobalVariable *V) {
3143 DbgScope *Scope = getOrCreateScope(V);
3144 unsigned ID = MMI->NextLabelID();
3145 if (!Scope->getStartLabelID()) Scope->setStartLabelID(ID);
3149 /// RecordRegionEnd - Indicate the end of a region.
3151 unsigned RecordRegionEnd(GlobalVariable *V) {
3152 DbgScope *Scope = getOrCreateScope(V);
3153 unsigned ID = MMI->NextLabelID();
3154 Scope->setEndLabelID(ID);
3158 /// RecordVariable - Indicate the declaration of a local variable.
3160 void RecordVariable(GlobalVariable *GV, unsigned FrameIndex) {
3161 DIDescriptor Desc(GV);
3162 DbgScope *Scope = NULL;
3163 if (Desc.getTag() == DW_TAG_variable) {
3164 // GV is a global variable.
3165 DIGlobalVariable DG(GV);
3166 Scope = getOrCreateScope(DG.getContext().getGV());
3168 // or GV is a local variable.
3170 Scope = getOrCreateScope(DV.getContext().getGV());
3172 assert (Scope && "Unable to find variable' scope");
3173 DIVariable *VD = new DIVariable(GV);
3174 DbgVariable *DV = new DbgVariable(VD, FrameIndex);
3175 Scope->AddVariable(DV);
3179 //===----------------------------------------------------------------------===//
3180 /// DwarfException - Emits Dwarf exception handling directives.
3182 class DwarfException : public Dwarf {
3185 struct FunctionEHFrameInfo {
3188 unsigned PersonalityIndex;
3190 bool hasLandingPads;
3191 std::vector<MachineMove> Moves;
3192 const Function * function;
3194 FunctionEHFrameInfo(const std::string &FN, unsigned Num, unsigned P,
3196 const std::vector<MachineMove> &M,
3198 FnName(FN), Number(Num), PersonalityIndex(P),
3199 hasCalls(hC), hasLandingPads(hL), Moves(M), function (f) { }
3202 std::vector<FunctionEHFrameInfo> EHFrames;
3204 /// shouldEmitTable - Per-function flag to indicate if EH tables should
3206 bool shouldEmitTable;
3208 /// shouldEmitMoves - Per-function flag to indicate if frame moves info
3209 /// should be emitted.
3210 bool shouldEmitMoves;
3212 /// shouldEmitTableModule - Per-module flag to indicate if EH tables
3213 /// should be emitted.
3214 bool shouldEmitTableModule;
3216 /// shouldEmitFrameModule - Per-module flag to indicate if frame moves
3217 /// should be emitted.
3218 bool shouldEmitMovesModule;
3220 /// EmitCommonEHFrame - Emit the common eh unwind frame.
3222 void EmitCommonEHFrame(const Function *Personality, unsigned Index) {
3223 // Size and sign of stack growth.
3225 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3226 TargetFrameInfo::StackGrowsUp ?
3227 TD->getPointerSize() : -TD->getPointerSize();
3229 // Begin eh frame section.
3230 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3232 if (!TAI->doesRequireNonLocalEHFrameLabel())
3233 O << TAI->getEHGlobalPrefix();
3234 O << "EH_frame" << Index << ":\n";
3235 EmitLabel("section_eh_frame", Index);
3237 // Define base labels.
3238 EmitLabel("eh_frame_common", Index);
3240 // Define the eh frame length.
3241 EmitDifference("eh_frame_common_end", Index,
3242 "eh_frame_common_begin", Index, true);
3243 Asm->EOL("Length of Common Information Entry");
3246 EmitLabel("eh_frame_common_begin", Index);
3247 Asm->EmitInt32((int)0);
3248 Asm->EOL("CIE Identifier Tag");
3249 Asm->EmitInt8(DW_CIE_VERSION);
3250 Asm->EOL("CIE Version");
3252 // The personality presence indicates that language specific information
3253 // will show up in the eh frame.
3254 Asm->EmitString(Personality ? "zPLR" : "zR");
3255 Asm->EOL("CIE Augmentation");
3257 // Round out reader.
3258 Asm->EmitULEB128Bytes(1);
3259 Asm->EOL("CIE Code Alignment Factor");
3260 Asm->EmitSLEB128Bytes(stackGrowth);
3261 Asm->EOL("CIE Data Alignment Factor");
3262 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), true));
3263 Asm->EOL("CIE Return Address Column");
3265 // If there is a personality, we need to indicate the functions location.
3267 Asm->EmitULEB128Bytes(7);
3268 Asm->EOL("Augmentation Size");
3270 if (TAI->getNeedsIndirectEncoding()) {
3271 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4 | DW_EH_PE_indirect);
3272 Asm->EOL("Personality (pcrel sdata4 indirect)");
3274 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3275 Asm->EOL("Personality (pcrel sdata4)");
3278 PrintRelDirective(true);
3279 O << TAI->getPersonalityPrefix();
3280 Asm->EmitExternalGlobal((const GlobalVariable *)(Personality));
3281 O << TAI->getPersonalitySuffix();
3282 if (strcmp(TAI->getPersonalitySuffix(), "+4@GOTPCREL"))
3283 O << "-" << TAI->getPCSymbol();
3284 Asm->EOL("Personality");
3286 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3287 Asm->EOL("LSDA Encoding (pcrel sdata4)");
3289 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3290 Asm->EOL("FDE Encoding (pcrel sdata4)");
3292 Asm->EmitULEB128Bytes(1);
3293 Asm->EOL("Augmentation Size");
3295 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3296 Asm->EOL("FDE Encoding (pcrel sdata4)");
3299 // Indicate locations of general callee saved registers in frame.
3300 std::vector<MachineMove> Moves;
3301 RI->getInitialFrameState(Moves);
3302 EmitFrameMoves(NULL, 0, Moves, true);
3304 // On Darwin the linker honors the alignment of eh_frame, which means it
3305 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3306 // you get holes which confuse readers of eh_frame.
3307 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
3309 EmitLabel("eh_frame_common_end", Index);
3314 /// EmitEHFrame - Emit function exception frame information.
3316 void EmitEHFrame(const FunctionEHFrameInfo &EHFrameInfo) {
3317 Function::LinkageTypes linkage = EHFrameInfo.function->getLinkage();
3319 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3321 // Externally visible entry into the functions eh frame info.
3322 // If the corresponding function is static, this should not be
3323 // externally visible.
3324 if (linkage != Function::InternalLinkage &&
3325 linkage != Function::PrivateLinkage) {
3326 if (const char *GlobalEHDirective = TAI->getGlobalEHDirective())
3327 O << GlobalEHDirective << EHFrameInfo.FnName << "\n";
3330 // If corresponding function is weak definition, this should be too.
3331 if ((linkage == Function::WeakLinkage ||
3332 linkage == Function::LinkOnceLinkage) &&
3333 TAI->getWeakDefDirective())
3334 O << TAI->getWeakDefDirective() << EHFrameInfo.FnName << "\n";
3336 // If there are no calls then you can't unwind. This may mean we can
3337 // omit the EH Frame, but some environments do not handle weak absolute
3339 // If UnwindTablesMandatory is set we cannot do this optimization; the
3340 // unwind info is to be available for non-EH uses.
3341 if (!EHFrameInfo.hasCalls &&
3342 !UnwindTablesMandatory &&
3343 ((linkage != Function::WeakLinkage &&
3344 linkage != Function::LinkOnceLinkage) ||
3345 !TAI->getWeakDefDirective() ||
3346 TAI->getSupportsWeakOmittedEHFrame()))
3348 O << EHFrameInfo.FnName << " = 0\n";
3349 // This name has no connection to the function, so it might get
3350 // dead-stripped when the function is not, erroneously. Prohibit
3351 // dead-stripping unconditionally.
3352 if (const char *UsedDirective = TAI->getUsedDirective())
3353 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3355 O << EHFrameInfo.FnName << ":\n";
3358 EmitDifference("eh_frame_end", EHFrameInfo.Number,
3359 "eh_frame_begin", EHFrameInfo.Number, true);
3360 Asm->EOL("Length of Frame Information Entry");
3362 EmitLabel("eh_frame_begin", EHFrameInfo.Number);
3364 if (TAI->doesRequireNonLocalEHFrameLabel()) {
3365 PrintRelDirective(true, true);
3366 PrintLabelName("eh_frame_begin", EHFrameInfo.Number);
3368 if (!TAI->isAbsoluteEHSectionOffsets())
3369 O << "-EH_frame" << EHFrameInfo.PersonalityIndex;
3371 EmitSectionOffset("eh_frame_begin", "eh_frame_common",
3372 EHFrameInfo.Number, EHFrameInfo.PersonalityIndex,
3376 Asm->EOL("FDE CIE offset");
3378 EmitReference("eh_func_begin", EHFrameInfo.Number, true, true);
3379 Asm->EOL("FDE initial location");
3380 EmitDifference("eh_func_end", EHFrameInfo.Number,
3381 "eh_func_begin", EHFrameInfo.Number, true);
3382 Asm->EOL("FDE address range");
3384 // If there is a personality and landing pads then point to the language
3385 // specific data area in the exception table.
3386 if (EHFrameInfo.PersonalityIndex) {
3387 Asm->EmitULEB128Bytes(4);
3388 Asm->EOL("Augmentation size");
3390 if (EHFrameInfo.hasLandingPads)
3391 EmitReference("exception", EHFrameInfo.Number, true, true);
3393 Asm->EmitInt32((int)0);
3394 Asm->EOL("Language Specific Data Area");
3396 Asm->EmitULEB128Bytes(0);
3397 Asm->EOL("Augmentation size");
3400 // Indicate locations of function specific callee saved registers in
3402 EmitFrameMoves("eh_func_begin", EHFrameInfo.Number, EHFrameInfo.Moves, true);
3404 // On Darwin the linker honors the alignment of eh_frame, which means it
3405 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3406 // you get holes which confuse readers of eh_frame.
3407 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
3409 EmitLabel("eh_frame_end", EHFrameInfo.Number);
3411 // If the function is marked used, this table should be also. We cannot
3412 // make the mark unconditional in this case, since retaining the table
3413 // also retains the function in this case, and there is code around
3414 // that depends on unused functions (calling undefined externals) being
3415 // dead-stripped to link correctly. Yes, there really is.
3416 if (MMI->getUsedFunctions().count(EHFrameInfo.function))
3417 if (const char *UsedDirective = TAI->getUsedDirective())
3418 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3422 /// EmitExceptionTable - Emit landing pads and actions.
3424 /// The general organization of the table is complex, but the basic concepts
3425 /// are easy. First there is a header which describes the location and
3426 /// organization of the three components that follow.
3427 /// 1. The landing pad site information describes the range of code covered
3428 /// by the try. In our case it's an accumulation of the ranges covered
3429 /// by the invokes in the try. There is also a reference to the landing
3430 /// pad that handles the exception once processed. Finally an index into
3431 /// the actions table.
3432 /// 2. The action table, in our case, is composed of pairs of type ids
3433 /// and next action offset. Starting with the action index from the
3434 /// landing pad site, each type Id is checked for a match to the current
3435 /// exception. If it matches then the exception and type id are passed
3436 /// on to the landing pad. Otherwise the next action is looked up. This
3437 /// chain is terminated with a next action of zero. If no type id is
3438 /// found the the frame is unwound and handling continues.
3439 /// 3. Type id table contains references to all the C++ typeinfo for all
3440 /// catches in the function. This tables is reversed indexed base 1.
3442 /// SharedTypeIds - How many leading type ids two landing pads have in common.
3443 static unsigned SharedTypeIds(const LandingPadInfo *L,
3444 const LandingPadInfo *R) {
3445 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3446 unsigned LSize = LIds.size(), RSize = RIds.size();
3447 unsigned MinSize = LSize < RSize ? LSize : RSize;
3450 for (; Count != MinSize; ++Count)
3451 if (LIds[Count] != RIds[Count])
3457 /// PadLT - Order landing pads lexicographically by type id.
3458 static bool PadLT(const LandingPadInfo *L, const LandingPadInfo *R) {
3459 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3460 unsigned LSize = LIds.size(), RSize = RIds.size();
3461 unsigned MinSize = LSize < RSize ? LSize : RSize;
3463 for (unsigned i = 0; i != MinSize; ++i)
3464 if (LIds[i] != RIds[i])
3465 return LIds[i] < RIds[i];
3467 return LSize < RSize;
3471 static inline unsigned getEmptyKey() { return -1U; }
3472 static inline unsigned getTombstoneKey() { return -2U; }
3473 static unsigned getHashValue(const unsigned &Key) { return Key; }
3474 static bool isEqual(unsigned LHS, unsigned RHS) { return LHS == RHS; }
3475 static bool isPod() { return true; }
3478 /// ActionEntry - Structure describing an entry in the actions table.
3479 struct ActionEntry {
3480 int ValueForTypeID; // The value to write - may not be equal to the type id.
3482 struct ActionEntry *Previous;
3485 /// PadRange - Structure holding a try-range and the associated landing pad.
3487 // The index of the landing pad.
3489 // The index of the begin and end labels in the landing pad's label lists.
3490 unsigned RangeIndex;
3493 typedef DenseMap<unsigned, PadRange, KeyInfo> RangeMapType;
3495 /// CallSiteEntry - Structure describing an entry in the call-site table.
3496 struct CallSiteEntry {
3497 // The 'try-range' is BeginLabel .. EndLabel.
3498 unsigned BeginLabel; // zero indicates the start of the function.
3499 unsigned EndLabel; // zero indicates the end of the function.
3500 // The landing pad starts at PadLabel.
3501 unsigned PadLabel; // zero indicates that there is no landing pad.
3505 void EmitExceptionTable() {
3506 const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
3507 const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
3508 const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
3509 if (PadInfos.empty()) return;
3511 // Sort the landing pads in order of their type ids. This is used to fold
3512 // duplicate actions.
3513 SmallVector<const LandingPadInfo *, 64> LandingPads;
3514 LandingPads.reserve(PadInfos.size());
3515 for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
3516 LandingPads.push_back(&PadInfos[i]);
3517 std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
3519 // Negative type ids index into FilterIds, positive type ids index into
3520 // TypeInfos. The value written for a positive type id is just the type
3521 // id itself. For a negative type id, however, the value written is the
3522 // (negative) byte offset of the corresponding FilterIds entry. The byte
3523 // offset is usually equal to the type id, because the FilterIds entries
3524 // are written using a variable width encoding which outputs one byte per
3525 // entry as long as the value written is not too large, but can differ.
3526 // This kind of complication does not occur for positive type ids because
3527 // type infos are output using a fixed width encoding.
3528 // FilterOffsets[i] holds the byte offset corresponding to FilterIds[i].
3529 SmallVector<int, 16> FilterOffsets;
3530 FilterOffsets.reserve(FilterIds.size());
3532 for(std::vector<unsigned>::const_iterator I = FilterIds.begin(),
3533 E = FilterIds.end(); I != E; ++I) {
3534 FilterOffsets.push_back(Offset);
3535 Offset -= TargetAsmInfo::getULEB128Size(*I);
3538 // Compute the actions table and gather the first action index for each
3539 // landing pad site.
3540 SmallVector<ActionEntry, 32> Actions;
3541 SmallVector<unsigned, 64> FirstActions;
3542 FirstActions.reserve(LandingPads.size());
3544 int FirstAction = 0;
3545 unsigned SizeActions = 0;
3546 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3547 const LandingPadInfo *LP = LandingPads[i];
3548 const std::vector<int> &TypeIds = LP->TypeIds;
3549 const unsigned NumShared = i ? SharedTypeIds(LP, LandingPads[i-1]) : 0;
3550 unsigned SizeSiteActions = 0;
3552 if (NumShared < TypeIds.size()) {
3553 unsigned SizeAction = 0;
3554 ActionEntry *PrevAction = 0;
3557 const unsigned SizePrevIds = LandingPads[i-1]->TypeIds.size();
3558 assert(Actions.size());
3559 PrevAction = &Actions.back();
3560 SizeAction = TargetAsmInfo::getSLEB128Size(PrevAction->NextAction) +
3561 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
3562 for (unsigned j = NumShared; j != SizePrevIds; ++j) {
3564 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
3565 SizeAction += -PrevAction->NextAction;
3566 PrevAction = PrevAction->Previous;
3570 // Compute the actions.
3571 for (unsigned I = NumShared, M = TypeIds.size(); I != M; ++I) {
3572 int TypeID = TypeIds[I];
3573 assert(-1-TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
3574 int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
3575 unsigned SizeTypeID = TargetAsmInfo::getSLEB128Size(ValueForTypeID);
3577 int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
3578 SizeAction = SizeTypeID + TargetAsmInfo::getSLEB128Size(NextAction);
3579 SizeSiteActions += SizeAction;
3581 ActionEntry Action = {ValueForTypeID, NextAction, PrevAction};
3582 Actions.push_back(Action);
3584 PrevAction = &Actions.back();
3587 // Record the first action of the landing pad site.
3588 FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
3589 } // else identical - re-use previous FirstAction
3591 FirstActions.push_back(FirstAction);
3593 // Compute this sites contribution to size.
3594 SizeActions += SizeSiteActions;
3597 // Compute the call-site table. The entry for an invoke has a try-range
3598 // containing the call, a non-zero landing pad and an appropriate action.
3599 // The entry for an ordinary call has a try-range containing the call and
3600 // zero for the landing pad and the action. Calls marked 'nounwind' have
3601 // no entry and must not be contained in the try-range of any entry - they
3602 // form gaps in the table. Entries must be ordered by try-range address.
3603 SmallVector<CallSiteEntry, 64> CallSites;
3605 RangeMapType PadMap;
3606 // Invokes and nounwind calls have entries in PadMap (due to being bracketed
3607 // by try-range labels when lowered). Ordinary calls do not, so appropriate
3608 // try-ranges for them need be deduced.
3609 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3610 const LandingPadInfo *LandingPad = LandingPads[i];
3611 for (unsigned j = 0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
3612 unsigned BeginLabel = LandingPad->BeginLabels[j];
3613 assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
3614 PadRange P = { i, j };
3615 PadMap[BeginLabel] = P;
3619 // The end label of the previous invoke or nounwind try-range.
3620 unsigned LastLabel = 0;
3622 // Whether there is a potentially throwing instruction (currently this means
3623 // an ordinary call) between the end of the previous try-range and now.
3624 bool SawPotentiallyThrowing = false;
3626 // Whether the last callsite entry was for an invoke.
3627 bool PreviousIsInvoke = false;
3629 // Visit all instructions in order of address.
3630 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
3632 for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
3634 if (!MI->isLabel()) {
3635 SawPotentiallyThrowing |= MI->getDesc().isCall();
3639 unsigned BeginLabel = MI->getOperand(0).getImm();
3640 assert(BeginLabel && "Invalid label!");
3642 // End of the previous try-range?
3643 if (BeginLabel == LastLabel)
3644 SawPotentiallyThrowing = false;
3646 // Beginning of a new try-range?
3647 RangeMapType::iterator L = PadMap.find(BeginLabel);
3648 if (L == PadMap.end())
3649 // Nope, it was just some random label.
3652 PadRange P = L->second;
3653 const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
3655 assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
3656 "Inconsistent landing pad map!");
3658 // If some instruction between the previous try-range and this one may
3659 // throw, create a call-site entry with no landing pad for the region
3660 // between the try-ranges.
3661 if (SawPotentiallyThrowing) {
3662 CallSiteEntry Site = {LastLabel, BeginLabel, 0, 0};
3663 CallSites.push_back(Site);
3664 PreviousIsInvoke = false;
3667 LastLabel = LandingPad->EndLabels[P.RangeIndex];
3668 assert(BeginLabel && LastLabel && "Invalid landing pad!");
3670 if (LandingPad->LandingPadLabel) {
3671 // This try-range is for an invoke.
3672 CallSiteEntry Site = {BeginLabel, LastLabel,
3673 LandingPad->LandingPadLabel, FirstActions[P.PadIndex]};
3675 // Try to merge with the previous call-site.
3676 if (PreviousIsInvoke) {
3677 CallSiteEntry &Prev = CallSites.back();
3678 if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
3679 // Extend the range of the previous entry.
3680 Prev.EndLabel = Site.EndLabel;
3685 // Otherwise, create a new call-site.
3686 CallSites.push_back(Site);
3687 PreviousIsInvoke = true;
3690 PreviousIsInvoke = false;
3694 // If some instruction between the previous try-range and the end of the
3695 // function may throw, create a call-site entry with no landing pad for the
3696 // region following the try-range.
3697 if (SawPotentiallyThrowing) {
3698 CallSiteEntry Site = {LastLabel, 0, 0, 0};
3699 CallSites.push_back(Site);
3705 const unsigned SiteStartSize = sizeof(int32_t); // DW_EH_PE_udata4
3706 const unsigned SiteLengthSize = sizeof(int32_t); // DW_EH_PE_udata4
3707 const unsigned LandingPadSize = sizeof(int32_t); // DW_EH_PE_udata4
3708 unsigned SizeSites = CallSites.size() * (SiteStartSize +
3711 for (unsigned i = 0, e = CallSites.size(); i < e; ++i)
3712 SizeSites += TargetAsmInfo::getULEB128Size(CallSites[i].Action);
3715 const unsigned TypeInfoSize = TD->getPointerSize(); // DW_EH_PE_absptr
3716 unsigned SizeTypes = TypeInfos.size() * TypeInfoSize;
3718 unsigned TypeOffset = sizeof(int8_t) + // Call site format
3719 TargetAsmInfo::getULEB128Size(SizeSites) + // Call-site table length
3720 SizeSites + SizeActions + SizeTypes;
3722 unsigned TotalSize = sizeof(int8_t) + // LPStart format
3723 sizeof(int8_t) + // TType format
3724 TargetAsmInfo::getULEB128Size(TypeOffset) + // TType base offset
3727 unsigned SizeAlign = (4 - TotalSize) & 3;
3729 // Begin the exception table.
3730 Asm->SwitchToDataSection(TAI->getDwarfExceptionSection());
3731 Asm->EmitAlignment(2, 0, 0, false);
3732 O << "GCC_except_table" << SubprogramCount << ":\n";
3733 for (unsigned i = 0; i != SizeAlign; ++i) {
3735 Asm->EOL("Padding");
3737 EmitLabel("exception", SubprogramCount);
3740 Asm->EmitInt8(DW_EH_PE_omit);
3741 Asm->EOL("LPStart format (DW_EH_PE_omit)");
3742 Asm->EmitInt8(DW_EH_PE_absptr);
3743 Asm->EOL("TType format (DW_EH_PE_absptr)");
3744 Asm->EmitULEB128Bytes(TypeOffset);
3745 Asm->EOL("TType base offset");
3746 Asm->EmitInt8(DW_EH_PE_udata4);
3747 Asm->EOL("Call site format (DW_EH_PE_udata4)");
3748 Asm->EmitULEB128Bytes(SizeSites);
3749 Asm->EOL("Call-site table length");
3751 // Emit the landing pad site information.
3752 for (unsigned i = 0; i < CallSites.size(); ++i) {
3753 CallSiteEntry &S = CallSites[i];
3754 const char *BeginTag;
3755 unsigned BeginNumber;
3757 if (!S.BeginLabel) {
3758 BeginTag = "eh_func_begin";
3759 BeginNumber = SubprogramCount;
3762 BeginNumber = S.BeginLabel;
3765 EmitSectionOffset(BeginTag, "eh_func_begin", BeginNumber, SubprogramCount,
3767 Asm->EOL("Region start");
3770 EmitDifference("eh_func_end", SubprogramCount, BeginTag, BeginNumber,
3773 EmitDifference("label", S.EndLabel, BeginTag, BeginNumber, true);
3775 Asm->EOL("Region length");
3780 EmitSectionOffset("label", "eh_func_begin", S.PadLabel, SubprogramCount,
3782 Asm->EOL("Landing pad");
3784 Asm->EmitULEB128Bytes(S.Action);
3788 // Emit the actions.
3789 for (unsigned I = 0, N = Actions.size(); I != N; ++I) {
3790 ActionEntry &Action = Actions[I];
3792 Asm->EmitSLEB128Bytes(Action.ValueForTypeID);
3793 Asm->EOL("TypeInfo index");
3794 Asm->EmitSLEB128Bytes(Action.NextAction);
3795 Asm->EOL("Next action");
3798 // Emit the type ids.
3799 for (unsigned M = TypeInfos.size(); M; --M) {
3800 GlobalVariable *GV = TypeInfos[M - 1];
3802 PrintRelDirective();
3805 O << Asm->getGlobalLinkName(GV);
3809 Asm->EOL("TypeInfo");
3812 // Emit the filter typeids.
3813 for (unsigned j = 0, M = FilterIds.size(); j < M; ++j) {
3814 unsigned TypeID = FilterIds[j];
3815 Asm->EmitULEB128Bytes(TypeID);
3816 Asm->EOL("Filter TypeInfo index");
3819 Asm->EmitAlignment(2, 0, 0, false);
3823 //===--------------------------------------------------------------------===//
3824 // Main entry points.
3826 DwarfException(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
3827 : Dwarf(OS, A, T, "eh")
3828 , shouldEmitTable(false)
3829 , shouldEmitMoves(false)
3830 , shouldEmitTableModule(false)
3831 , shouldEmitMovesModule(false)
3834 virtual ~DwarfException() {}
3836 /// SetModuleInfo - Set machine module information when it's known that pass
3837 /// manager has created it. Set by the target AsmPrinter.
3838 void SetModuleInfo(MachineModuleInfo *mmi) {
3842 /// BeginModule - Emit all exception information that should come prior to the
3844 void BeginModule(Module *M) {
3848 /// EndModule - Emit all exception information that should come after the
3851 if (shouldEmitMovesModule || shouldEmitTableModule) {
3852 const std::vector<Function *> Personalities = MMI->getPersonalities();
3853 for (unsigned i =0; i < Personalities.size(); ++i)
3854 EmitCommonEHFrame(Personalities[i], i);
3856 for (std::vector<FunctionEHFrameInfo>::iterator I = EHFrames.begin(),
3857 E = EHFrames.end(); I != E; ++I)
3862 /// BeginFunction - Gather pre-function exception information. Assumes being
3863 /// emitted immediately after the function entry point.
3864 void BeginFunction(MachineFunction *MF) {
3866 shouldEmitTable = shouldEmitMoves = false;
3867 if (MMI && TAI->doesSupportExceptionHandling()) {
3869 // Map all labels and get rid of any dead landing pads.
3870 MMI->TidyLandingPads();
3871 // If any landing pads survive, we need an EH table.
3872 if (MMI->getLandingPads().size())
3873 shouldEmitTable = true;
3875 // See if we need frame move info.
3876 if (!MF->getFunction()->doesNotThrow() || UnwindTablesMandatory)
3877 shouldEmitMoves = true;
3879 if (shouldEmitMoves || shouldEmitTable)
3880 // Assumes in correct section after the entry point.
3881 EmitLabel("eh_func_begin", ++SubprogramCount);
3883 shouldEmitTableModule |= shouldEmitTable;
3884 shouldEmitMovesModule |= shouldEmitMoves;
3887 /// EndFunction - Gather and emit post-function exception information.
3889 void EndFunction() {
3890 if (shouldEmitMoves || shouldEmitTable) {
3891 EmitLabel("eh_func_end", SubprogramCount);
3892 EmitExceptionTable();
3894 // Save EH frame information
3896 push_back(FunctionEHFrameInfo(getAsm()->getCurrentFunctionEHName(MF),
3898 MMI->getPersonalityIndex(),
3899 MF->getFrameInfo()->hasCalls(),
3900 !MMI->getLandingPads().empty(),
3901 MMI->getFrameMoves(),
3902 MF->getFunction()));
3907 } // End of namespace llvm
3909 //===----------------------------------------------------------------------===//
3911 /// Emit - Print the abbreviation using the specified Dwarf writer.
3913 void DIEAbbrev::Emit(const DwarfDebug &DD) const {
3914 // Emit its Dwarf tag type.
3915 DD.getAsm()->EmitULEB128Bytes(Tag);
3916 DD.getAsm()->EOL(TagString(Tag));
3918 // Emit whether it has children DIEs.
3919 DD.getAsm()->EmitULEB128Bytes(ChildrenFlag);
3920 DD.getAsm()->EOL(ChildrenString(ChildrenFlag));
3922 // For each attribute description.
3923 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3924 const DIEAbbrevData &AttrData = Data[i];
3926 // Emit attribute type.
3927 DD.getAsm()->EmitULEB128Bytes(AttrData.getAttribute());
3928 DD.getAsm()->EOL(AttributeString(AttrData.getAttribute()));
3931 DD.getAsm()->EmitULEB128Bytes(AttrData.getForm());
3932 DD.getAsm()->EOL(FormEncodingString(AttrData.getForm()));
3935 // Mark end of abbreviation.
3936 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(1)");
3937 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(2)");
3941 void DIEAbbrev::print(std::ostream &O) {
3942 O << "Abbreviation @"
3943 << std::hex << (intptr_t)this << std::dec
3947 << ChildrenString(ChildrenFlag)
3950 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3952 << AttributeString(Data[i].getAttribute())
3954 << FormEncodingString(Data[i].getForm())
3958 void DIEAbbrev::dump() { print(cerr); }
3961 //===----------------------------------------------------------------------===//
3964 void DIEValue::dump() {
3969 //===----------------------------------------------------------------------===//
3971 /// EmitValue - Emit integer of appropriate size.
3973 void DIEInteger::EmitValue(DwarfDebug &DD, unsigned Form) {
3975 case DW_FORM_flag: // Fall thru
3976 case DW_FORM_ref1: // Fall thru
3977 case DW_FORM_data1: DD.getAsm()->EmitInt8(Integer); break;
3978 case DW_FORM_ref2: // Fall thru
3979 case DW_FORM_data2: DD.getAsm()->EmitInt16(Integer); break;
3980 case DW_FORM_ref4: // Fall thru
3981 case DW_FORM_data4: DD.getAsm()->EmitInt32(Integer); break;
3982 case DW_FORM_ref8: // Fall thru
3983 case DW_FORM_data8: DD.getAsm()->EmitInt64(Integer); break;
3984 case DW_FORM_udata: DD.getAsm()->EmitULEB128Bytes(Integer); break;
3985 case DW_FORM_sdata: DD.getAsm()->EmitSLEB128Bytes(Integer); break;
3986 default: assert(0 && "DIE Value form not supported yet"); break;
3990 /// SizeOf - Determine size of integer value in bytes.
3992 unsigned DIEInteger::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3994 case DW_FORM_flag: // Fall thru
3995 case DW_FORM_ref1: // Fall thru
3996 case DW_FORM_data1: return sizeof(int8_t);
3997 case DW_FORM_ref2: // Fall thru
3998 case DW_FORM_data2: return sizeof(int16_t);
3999 case DW_FORM_ref4: // Fall thru
4000 case DW_FORM_data4: return sizeof(int32_t);
4001 case DW_FORM_ref8: // Fall thru
4002 case DW_FORM_data8: return sizeof(int64_t);
4003 case DW_FORM_udata: return TargetAsmInfo::getULEB128Size(Integer);
4004 case DW_FORM_sdata: return TargetAsmInfo::getSLEB128Size(Integer);
4005 default: assert(0 && "DIE Value form not supported yet"); break;
4010 //===----------------------------------------------------------------------===//
4012 /// EmitValue - Emit string value.
4014 void DIEString::EmitValue(DwarfDebug &DD, unsigned Form) {
4015 DD.getAsm()->EmitString(String);
4018 //===----------------------------------------------------------------------===//
4020 /// EmitValue - Emit label value.
4022 void DIEDwarfLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
4023 bool IsSmall = Form == DW_FORM_data4;
4024 DD.EmitReference(Label, false, IsSmall);
4027 /// SizeOf - Determine size of label value in bytes.
4029 unsigned DIEDwarfLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4030 if (Form == DW_FORM_data4) return 4;
4031 return DD.getTargetData()->getPointerSize();
4034 //===----------------------------------------------------------------------===//
4036 /// EmitValue - Emit label value.
4038 void DIEObjectLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
4039 bool IsSmall = Form == DW_FORM_data4;
4040 DD.EmitReference(Label, false, IsSmall);
4043 /// SizeOf - Determine size of label value in bytes.
4045 unsigned DIEObjectLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4046 if (Form == DW_FORM_data4) return 4;
4047 return DD.getTargetData()->getPointerSize();
4050 //===----------------------------------------------------------------------===//
4052 /// EmitValue - Emit delta value.
4054 void DIESectionOffset::EmitValue(DwarfDebug &DD, unsigned Form) {
4055 bool IsSmall = Form == DW_FORM_data4;
4056 DD.EmitSectionOffset(Label.Tag, Section.Tag,
4057 Label.Number, Section.Number, IsSmall, IsEH, UseSet);
4060 /// SizeOf - Determine size of delta value in bytes.
4062 unsigned DIESectionOffset::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4063 if (Form == DW_FORM_data4) return 4;
4064 return DD.getTargetData()->getPointerSize();
4067 //===----------------------------------------------------------------------===//
4069 /// EmitValue - Emit delta value.
4071 void DIEDelta::EmitValue(DwarfDebug &DD, unsigned Form) {
4072 bool IsSmall = Form == DW_FORM_data4;
4073 DD.EmitDifference(LabelHi, LabelLo, IsSmall);
4076 /// SizeOf - Determine size of delta value in bytes.
4078 unsigned DIEDelta::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4079 if (Form == DW_FORM_data4) return 4;
4080 return DD.getTargetData()->getPointerSize();
4083 //===----------------------------------------------------------------------===//
4085 /// EmitValue - Emit debug information entry offset.
4087 void DIEntry::EmitValue(DwarfDebug &DD, unsigned Form) {
4088 DD.getAsm()->EmitInt32(Entry->getOffset());
4091 //===----------------------------------------------------------------------===//
4093 /// ComputeSize - calculate the size of the block.
4095 unsigned DIEBlock::ComputeSize(DwarfDebug &DD) {
4097 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
4099 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4100 Size += Values[i]->SizeOf(DD, AbbrevData[i].getForm());
4106 /// EmitValue - Emit block data.
4108 void DIEBlock::EmitValue(DwarfDebug &DD, unsigned Form) {
4110 case DW_FORM_block1: DD.getAsm()->EmitInt8(Size); break;
4111 case DW_FORM_block2: DD.getAsm()->EmitInt16(Size); break;
4112 case DW_FORM_block4: DD.getAsm()->EmitInt32(Size); break;
4113 case DW_FORM_block: DD.getAsm()->EmitULEB128Bytes(Size); break;
4114 default: assert(0 && "Improper form for block"); break;
4117 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
4119 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4121 Values[i]->EmitValue(DD, AbbrevData[i].getForm());
4125 /// SizeOf - Determine size of block data in bytes.
4127 unsigned DIEBlock::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4129 case DW_FORM_block1: return Size + sizeof(int8_t);
4130 case DW_FORM_block2: return Size + sizeof(int16_t);
4131 case DW_FORM_block4: return Size + sizeof(int32_t);
4132 case DW_FORM_block: return Size + TargetAsmInfo::getULEB128Size(Size);
4133 default: assert(0 && "Improper form for block"); break;
4138 //===----------------------------------------------------------------------===//
4139 /// DIE Implementation
4142 for (unsigned i = 0, N = Children.size(); i < N; ++i)
4146 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
4148 void DIE::AddSiblingOffset() {
4149 DIEInteger *DI = new DIEInteger(0);
4150 Values.insert(Values.begin(), DI);
4151 Abbrev.AddFirstAttribute(DW_AT_sibling, DW_FORM_ref4);
4154 /// Profile - Used to gather unique data for the value folding set.
4156 void DIE::Profile(FoldingSetNodeID &ID) {
4159 for (unsigned i = 0, N = Children.size(); i < N; ++i)
4160 ID.AddPointer(Children[i]);
4162 for (unsigned j = 0, M = Values.size(); j < M; ++j)
4163 ID.AddPointer(Values[j]);
4167 void DIE::print(std::ostream &O, unsigned IncIndent) {
4168 static unsigned IndentCount = 0;
4169 IndentCount += IncIndent;
4170 const std::string Indent(IndentCount, ' ');
4171 bool isBlock = Abbrev.getTag() == 0;
4176 << "0x" << std::hex << (intptr_t)this << std::dec
4177 << ", Offset: " << Offset
4178 << ", Size: " << Size
4182 << TagString(Abbrev.getTag())
4184 << ChildrenString(Abbrev.getChildrenFlag());
4186 O << "Size: " << Size;
4190 const SmallVector<DIEAbbrevData, 8> &Data = Abbrev.getData();
4193 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4197 O << AttributeString(Data[i].getAttribute());
4199 O << "Blk[" << i << "]";
4202 << FormEncodingString(Data[i].getForm())
4204 Values[i]->print(O);
4209 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
4210 Children[j]->print(O, 4);
4213 if (!isBlock) O << "\n";
4214 IndentCount -= IncIndent;
4222 //===----------------------------------------------------------------------===//
4223 /// DwarfWriter Implementation
4226 DwarfWriter::DwarfWriter() : ImmutablePass(&ID), DD(NULL), DE(NULL) {
4229 DwarfWriter::~DwarfWriter() {
4234 /// BeginModule - Emit all Dwarf sections that should come prior to the
4236 void DwarfWriter::BeginModule(Module *M,
4237 MachineModuleInfo *MMI,
4238 raw_ostream &OS, AsmPrinter *A,
4239 const TargetAsmInfo *T) {
4240 DE = new DwarfException(OS, A, T);
4241 DD = new DwarfDebug(OS, A, T);
4244 DD->SetDebugInfo(MMI);
4245 DE->SetModuleInfo(MMI);
4248 /// EndModule - Emit all Dwarf sections that should come after the content.
4250 void DwarfWriter::EndModule() {
4255 /// BeginFunction - Gather pre-function debug information. Assumes being
4256 /// emitted immediately after the function entry point.
4257 void DwarfWriter::BeginFunction(MachineFunction *MF) {
4258 DE->BeginFunction(MF);
4259 DD->BeginFunction(MF);
4262 /// EndFunction - Gather and emit post-function debug information.
4264 void DwarfWriter::EndFunction(MachineFunction *MF) {
4265 DD->EndFunction(MF);
4268 if (MachineModuleInfo *MMI = DD->getMMI() ? DD->getMMI() : DE->getMMI())
4269 // Clear function debug information.
4273 /// ValidDebugInfo - Return true if V represents valid debug info value.
4274 bool DwarfWriter::ValidDebugInfo(Value *V) {
4275 return DD->ValidDebugInfo(V);
4278 /// RecordSourceLine - Records location information and associates it with a
4279 /// label. Returns a unique label ID used to generate a label and provide
4280 /// correspondence to the source line list.
4281 unsigned DwarfWriter::RecordSourceLine(unsigned Line, unsigned Col,
4283 return DD->RecordSourceLine(Line, Col, Src);
4286 /// RecordSource - Register a source file with debug info. Returns an source
4288 unsigned DwarfWriter::RecordSource(const std::string &Dir,
4289 const std::string &File) {
4290 return DD->RecordSource(Dir, File);
4293 /// RecordRegionStart - Indicate the start of a region.
4294 unsigned DwarfWriter::RecordRegionStart(GlobalVariable *V) {
4295 return DD->RecordRegionStart(V);
4298 /// RecordRegionEnd - Indicate the end of a region.
4299 unsigned DwarfWriter::RecordRegionEnd(GlobalVariable *V) {
4300 return DD->RecordRegionEnd(V);
4303 /// getRecordSourceLineCount - Count source lines.
4304 unsigned DwarfWriter::getRecordSourceLineCount() {
4305 return DD->getRecordSourceLineCount();
4308 /// RecordVariable - Indicate the declaration of a local variable.
4310 void DwarfWriter::RecordVariable(GlobalVariable *GV, unsigned FrameIndex) {
4311 DD->RecordVariable(GV, FrameIndex);