1 //===-- llvm/CodeGen/DwarfWriter.cpp - Dwarf Framework ----------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains support for writing dwarf info into asm files.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/CodeGen/DwarfWriter.h"
16 #include "llvm/ADT/DenseMap.h"
17 #include "llvm/ADT/FoldingSet.h"
18 #include "llvm/ADT/StringExtras.h"
19 #include "llvm/ADT/UniqueVector.h"
20 #include "llvm/Module.h"
21 #include "llvm/DerivedTypes.h"
22 #include "llvm/CodeGen/AsmPrinter.h"
23 #include "llvm/CodeGen/MachineModuleInfo.h"
24 #include "llvm/CodeGen/MachineFrameInfo.h"
25 #include "llvm/CodeGen/MachineLocation.h"
26 #include "llvm/Analysis/DebugInfo.h"
27 #include "llvm/Support/Debug.h"
28 #include "llvm/Support/Dwarf.h"
29 #include "llvm/Support/CommandLine.h"
30 #include "llvm/Support/DataTypes.h"
31 #include "llvm/Support/Mangler.h"
32 #include "llvm/Support/raw_ostream.h"
33 #include "llvm/System/Path.h"
34 #include "llvm/Target/TargetAsmInfo.h"
35 #include "llvm/Target/TargetRegisterInfo.h"
36 #include "llvm/Target/TargetData.h"
37 #include "llvm/Target/TargetFrameInfo.h"
38 #include "llvm/Target/TargetInstrInfo.h"
39 #include "llvm/Target/TargetMachine.h"
40 #include "llvm/Target/TargetOptions.h"
44 using namespace llvm::dwarf;
48 //===----------------------------------------------------------------------===//
50 /// Configuration values for initial hash set sizes (log2).
52 static const unsigned InitDiesSetSize = 9; // 512
53 static const unsigned InitAbbreviationsSetSize = 9; // 512
54 static const unsigned InitValuesSetSize = 9; // 512
56 //===----------------------------------------------------------------------===//
57 /// Forward declarations.
62 //===----------------------------------------------------------------------===//
65 /// getGlobalVariablesUsing - Return all of the GlobalVariables which have the
66 /// specified value in their initializer somewhere.
68 getGlobalVariablesUsing(Value *V, std::vector<GlobalVariable*> &Result) {
69 // Scan though value users.
70 for (Value::use_iterator I = V->use_begin(), E = V->use_end(); I != E; ++I) {
71 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(*I)) {
72 // If the user is a GlobalVariable then add to result.
74 } else if (Constant *C = dyn_cast<Constant>(*I)) {
75 // If the user is a constant variable then scan its users
76 getGlobalVariablesUsing(C, Result);
81 /// getGlobalVariablesUsing - Return all of the GlobalVariables that use the
82 /// named GlobalVariable.
84 getGlobalVariablesUsing(Module &M, const std::string &RootName,
85 std::vector<GlobalVariable*> &Result) {
86 std::vector<const Type*> FieldTypes;
87 FieldTypes.push_back(Type::Int32Ty);
88 FieldTypes.push_back(Type::Int32Ty);
90 // Get the GlobalVariable root.
91 GlobalVariable *UseRoot = M.getGlobalVariable(RootName,
92 StructType::get(FieldTypes));
94 // If present and linkonce then scan for users.
95 if (UseRoot && UseRoot->hasLinkOnceLinkage())
96 getGlobalVariablesUsing(UseRoot, Result);
99 //===----------------------------------------------------------------------===//
100 /// DWLabel - Labels are used to track locations in the assembler file.
101 /// Labels appear in the form @verbatim <prefix><Tag><Number> @endverbatim,
102 /// where the tag is a category of label (Ex. location) and number is a value
103 /// unique in that category.
106 /// Tag - Label category tag. Should always be a staticly declared C string.
110 /// Number - Value to make label unique.
114 DWLabel(const char *T, unsigned N) : Tag(T), Number(N) {}
116 void Profile(FoldingSetNodeID &ID) const {
117 ID.AddString(std::string(Tag));
118 ID.AddInteger(Number);
122 void print(std::ostream *O) const {
125 void print(std::ostream &O) const {
127 if (Number) O << Number;
132 //===----------------------------------------------------------------------===//
133 /// DIEAbbrevData - Dwarf abbreviation data, describes the one attribute of a
134 /// Dwarf abbreviation.
135 class DIEAbbrevData {
137 /// Attribute - Dwarf attribute code.
141 /// Form - Dwarf form code.
146 DIEAbbrevData(unsigned A, unsigned F)
152 unsigned getAttribute() const { return Attribute; }
153 unsigned getForm() const { return Form; }
155 /// Profile - Used to gather unique data for the abbreviation folding set.
157 void Profile(FoldingSetNodeID &ID)const {
158 ID.AddInteger(Attribute);
163 //===----------------------------------------------------------------------===//
164 /// DIEAbbrev - Dwarf abbreviation, describes the organization of a debug
165 /// information object.
166 class DIEAbbrev : public FoldingSetNode {
168 /// Tag - Dwarf tag code.
172 /// Unique number for node.
176 /// ChildrenFlag - Dwarf children flag.
178 unsigned ChildrenFlag;
180 /// Data - Raw data bytes for abbreviation.
182 SmallVector<DIEAbbrevData, 8> Data;
186 DIEAbbrev(unsigned T, unsigned C)
194 unsigned getTag() const { return Tag; }
195 unsigned getNumber() const { return Number; }
196 unsigned getChildrenFlag() const { return ChildrenFlag; }
197 const SmallVector<DIEAbbrevData, 8> &getData() const { return Data; }
198 void setTag(unsigned T) { Tag = T; }
199 void setChildrenFlag(unsigned CF) { ChildrenFlag = CF; }
200 void setNumber(unsigned N) { Number = N; }
202 /// AddAttribute - Adds another set of attribute information to the
204 void AddAttribute(unsigned Attribute, unsigned Form) {
205 Data.push_back(DIEAbbrevData(Attribute, Form));
208 /// AddFirstAttribute - Adds a set of attribute information to the front
209 /// of the abbreviation.
210 void AddFirstAttribute(unsigned Attribute, unsigned Form) {
211 Data.insert(Data.begin(), DIEAbbrevData(Attribute, Form));
214 /// Profile - Used to gather unique data for the abbreviation folding set.
216 void Profile(FoldingSetNodeID &ID) {
218 ID.AddInteger(ChildrenFlag);
220 // For each attribute description.
221 for (unsigned i = 0, N = Data.size(); i < N; ++i)
225 /// Emit - Print the abbreviation using the specified Dwarf writer.
227 void Emit(const DwarfDebug &DD) const;
230 void print(std::ostream *O) {
233 void print(std::ostream &O);
238 //===----------------------------------------------------------------------===//
239 /// DIE - A structured debug information entry. Has an abbreviation which
240 /// describes it's organization.
241 class DIE : public FoldingSetNode {
243 /// Abbrev - Buffer for constructing abbreviation.
247 /// Offset - Offset in debug info section.
251 /// Size - Size of instance + children.
257 std::vector<DIE *> Children;
259 /// Attributes values.
261 SmallVector<DIEValue*, 32> Values;
264 explicit DIE(unsigned Tag)
265 : Abbrev(Tag, DW_CHILDREN_no)
274 DIEAbbrev &getAbbrev() { return Abbrev; }
275 unsigned getAbbrevNumber() const {
276 return Abbrev.getNumber();
278 unsigned getTag() const { return Abbrev.getTag(); }
279 unsigned getOffset() const { return Offset; }
280 unsigned getSize() const { return Size; }
281 const std::vector<DIE *> &getChildren() const { return Children; }
282 SmallVector<DIEValue*, 32> &getValues() { return Values; }
283 void setTag(unsigned Tag) { Abbrev.setTag(Tag); }
284 void setOffset(unsigned O) { Offset = O; }
285 void setSize(unsigned S) { Size = S; }
287 /// AddValue - Add a value and attributes to a DIE.
289 void AddValue(unsigned Attribute, unsigned Form, DIEValue *Value) {
290 Abbrev.AddAttribute(Attribute, Form);
291 Values.push_back(Value);
294 /// SiblingOffset - Return the offset of the debug information entry's
296 unsigned SiblingOffset() const { return Offset + Size; }
298 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
300 void AddSiblingOffset();
302 /// AddChild - Add a child to the DIE.
304 void AddChild(DIE *Child) {
305 Abbrev.setChildrenFlag(DW_CHILDREN_yes);
306 Children.push_back(Child);
309 /// Detach - Detaches objects connected to it after copying.
315 /// Profile - Used to gather unique data for the value folding set.
317 void Profile(FoldingSetNodeID &ID) ;
320 void print(std::ostream *O, unsigned IncIndent = 0) {
321 if (O) print(*O, IncIndent);
323 void print(std::ostream &O, unsigned IncIndent = 0);
328 //===----------------------------------------------------------------------===//
329 /// DIEValue - A debug information entry value.
331 class DIEValue : public FoldingSetNode {
344 /// Type - Type of data stored in the value.
348 explicit DIEValue(unsigned T)
351 virtual ~DIEValue() {}
354 unsigned getType() const { return Type; }
356 // Implement isa/cast/dyncast.
357 static bool classof(const DIEValue *) { return true; }
359 /// EmitValue - Emit value via the Dwarf writer.
361 virtual void EmitValue(DwarfDebug &DD, unsigned Form) = 0;
363 /// SizeOf - Return the size of a value in bytes.
365 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const = 0;
367 /// Profile - Used to gather unique data for the value folding set.
369 virtual void Profile(FoldingSetNodeID &ID) = 0;
372 void print(std::ostream *O) {
375 virtual void print(std::ostream &O) = 0;
380 //===----------------------------------------------------------------------===//
381 /// DWInteger - An integer value DIE.
383 class DIEInteger : public DIEValue {
388 explicit DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
390 // Implement isa/cast/dyncast.
391 static bool classof(const DIEInteger *) { return true; }
392 static bool classof(const DIEValue *I) { return I->Type == isInteger; }
394 /// BestForm - Choose the best form for integer.
396 static unsigned BestForm(bool IsSigned, uint64_t Integer) {
398 if ((char)Integer == (signed)Integer) return DW_FORM_data1;
399 if ((short)Integer == (signed)Integer) return DW_FORM_data2;
400 if ((int)Integer == (signed)Integer) return DW_FORM_data4;
402 if ((unsigned char)Integer == Integer) return DW_FORM_data1;
403 if ((unsigned short)Integer == Integer) return DW_FORM_data2;
404 if ((unsigned int)Integer == Integer) return DW_FORM_data4;
406 return DW_FORM_data8;
409 /// EmitValue - Emit integer of appropriate size.
411 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
413 /// SizeOf - Determine size of integer value in bytes.
415 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
417 /// Profile - Used to gather unique data for the value folding set.
419 static void Profile(FoldingSetNodeID &ID, unsigned Integer) {
420 ID.AddInteger(isInteger);
421 ID.AddInteger(Integer);
423 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Integer); }
426 virtual void print(std::ostream &O) {
427 O << "Int: " << (int64_t)Integer
428 << " 0x" << std::hex << Integer << std::dec;
433 //===----------------------------------------------------------------------===//
434 /// DIEString - A string value DIE.
436 class DIEString : public DIEValue {
438 const std::string String;
440 explicit DIEString(const std::string &S) : DIEValue(isString), String(S) {}
442 // Implement isa/cast/dyncast.
443 static bool classof(const DIEString *) { return true; }
444 static bool classof(const DIEValue *S) { return S->Type == isString; }
446 /// EmitValue - Emit string value.
448 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
450 /// SizeOf - Determine size of string value in bytes.
452 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
453 return String.size() + sizeof(char); // sizeof('\0');
456 /// Profile - Used to gather unique data for the value folding set.
458 static void Profile(FoldingSetNodeID &ID, const std::string &String) {
459 ID.AddInteger(isString);
460 ID.AddString(String);
462 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, String); }
465 virtual void print(std::ostream &O) {
466 O << "Str: \"" << String << "\"";
471 //===----------------------------------------------------------------------===//
472 /// DIEDwarfLabel - A Dwarf internal label expression DIE.
474 class DIEDwarfLabel : public DIEValue {
479 explicit DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {}
481 // Implement isa/cast/dyncast.
482 static bool classof(const DIEDwarfLabel *) { return true; }
483 static bool classof(const DIEValue *L) { return L->Type == isLabel; }
485 /// EmitValue - Emit label value.
487 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
489 /// SizeOf - Determine size of label value in bytes.
491 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
493 /// Profile - Used to gather unique data for the value folding set.
495 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label) {
496 ID.AddInteger(isLabel);
499 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
502 virtual void print(std::ostream &O) {
510 //===----------------------------------------------------------------------===//
511 /// DIEObjectLabel - A label to an object in code or data.
513 class DIEObjectLabel : public DIEValue {
515 const std::string Label;
517 explicit DIEObjectLabel(const std::string &L)
518 : DIEValue(isAsIsLabel), Label(L) {}
520 // Implement isa/cast/dyncast.
521 static bool classof(const DIEObjectLabel *) { return true; }
522 static bool classof(const DIEValue *L) { return L->Type == isAsIsLabel; }
524 /// EmitValue - Emit label value.
526 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
528 /// SizeOf - Determine size of label value in bytes.
530 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
532 /// Profile - Used to gather unique data for the value folding set.
534 static void Profile(FoldingSetNodeID &ID, const std::string &Label) {
535 ID.AddInteger(isAsIsLabel);
538 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
541 virtual void print(std::ostream &O) {
542 O << "Obj: " << Label;
547 //===----------------------------------------------------------------------===//
548 /// DIESectionOffset - A section offset DIE.
550 class DIESectionOffset : public DIEValue {
553 const DWLabel Section;
557 DIESectionOffset(const DWLabel &Lab, const DWLabel &Sec,
558 bool isEH = false, bool useSet = true)
559 : DIEValue(isSectionOffset), Label(Lab), Section(Sec),
560 IsEH(isEH), UseSet(useSet) {}
562 // Implement isa/cast/dyncast.
563 static bool classof(const DIESectionOffset *) { return true; }
564 static bool classof(const DIEValue *D) { return D->Type == isSectionOffset; }
566 /// EmitValue - Emit section offset.
568 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
570 /// SizeOf - Determine size of section offset value in bytes.
572 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
574 /// Profile - Used to gather unique data for the value folding set.
576 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label,
577 const DWLabel &Section) {
578 ID.AddInteger(isSectionOffset);
581 // IsEH and UseSet are specific to the Label/Section that we will emit
582 // the offset for; so Label/Section are enough for uniqueness.
584 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label, Section); }
587 virtual void print(std::ostream &O) {
592 O << "-" << IsEH << "-" << UseSet;
597 //===----------------------------------------------------------------------===//
598 /// DIEDelta - A simple label difference DIE.
600 class DIEDelta : public DIEValue {
602 const DWLabel LabelHi;
603 const DWLabel LabelLo;
605 DIEDelta(const DWLabel &Hi, const DWLabel &Lo)
606 : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
608 // Implement isa/cast/dyncast.
609 static bool classof(const DIEDelta *) { return true; }
610 static bool classof(const DIEValue *D) { return D->Type == isDelta; }
612 /// EmitValue - Emit delta value.
614 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
616 /// SizeOf - Determine size of delta value in bytes.
618 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
620 /// Profile - Used to gather unique data for the value folding set.
622 static void Profile(FoldingSetNodeID &ID, const DWLabel &LabelHi,
623 const DWLabel &LabelLo) {
624 ID.AddInteger(isDelta);
628 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, LabelHi, LabelLo); }
631 virtual void print(std::ostream &O) {
640 //===----------------------------------------------------------------------===//
641 /// DIEntry - A pointer to another debug information entry. An instance of this
642 /// class can also be used as a proxy for a debug information entry not yet
643 /// defined (ie. types.)
644 class DIEntry : public DIEValue {
648 explicit DIEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
650 // Implement isa/cast/dyncast.
651 static bool classof(const DIEntry *) { return true; }
652 static bool classof(const DIEValue *E) { return E->Type == isEntry; }
654 /// EmitValue - Emit debug information entry offset.
656 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
658 /// SizeOf - Determine size of debug information entry in bytes.
660 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
661 return sizeof(int32_t);
664 /// Profile - Used to gather unique data for the value folding set.
666 static void Profile(FoldingSetNodeID &ID, DIE *Entry) {
667 ID.AddInteger(isEntry);
668 ID.AddPointer(Entry);
670 virtual void Profile(FoldingSetNodeID &ID) {
671 ID.AddInteger(isEntry);
674 ID.AddPointer(Entry);
681 virtual void print(std::ostream &O) {
682 O << "Die: 0x" << std::hex << (intptr_t)Entry << std::dec;
687 //===----------------------------------------------------------------------===//
688 /// DIEBlock - A block of values. Primarily used for location expressions.
690 class DIEBlock : public DIEValue, public DIE {
692 unsigned Size; // Size in bytes excluding size header.
702 // Implement isa/cast/dyncast.
703 static bool classof(const DIEBlock *) { return true; }
704 static bool classof(const DIEValue *E) { return E->Type == isBlock; }
706 /// ComputeSize - calculate the size of the block.
708 unsigned ComputeSize(DwarfDebug &DD);
710 /// BestForm - Choose the best form for data.
712 unsigned BestForm() const {
713 if ((unsigned char)Size == Size) return DW_FORM_block1;
714 if ((unsigned short)Size == Size) return DW_FORM_block2;
715 if ((unsigned int)Size == Size) return DW_FORM_block4;
716 return DW_FORM_block;
719 /// EmitValue - Emit block data.
721 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
723 /// SizeOf - Determine size of block data in bytes.
725 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
728 /// Profile - Used to gather unique data for the value folding set.
730 virtual void Profile(FoldingSetNodeID &ID) {
731 ID.AddInteger(isBlock);
736 virtual void print(std::ostream &O) {
743 //===----------------------------------------------------------------------===//
744 /// CompileUnit - This dwarf writer support class manages information associate
745 /// with a source file.
748 /// Desc - Compile unit debug descriptor.
750 CompileUnitDesc *Desc;
752 /// ID - File identifier for source.
756 /// Die - Compile unit debug information entry.
760 /// DescToDieMap - Tracks the mapping of unit level debug informaton
761 /// descriptors to debug information entries.
762 std::map<DebugInfoDesc *, DIE *> DescToDieMap;
763 DenseMap<GlobalVariable *, DIE *> GVToDieMap;
765 /// DescToDIEntryMap - Tracks the mapping of unit level debug informaton
766 /// descriptors to debug information entries using a DIEntry proxy.
767 std::map<DebugInfoDesc *, DIEntry *> DescToDIEntryMap;
768 DenseMap<GlobalVariable *, DIEntry *> GVToDIEntryMap;
770 /// Globals - A map of globally visible named entities for this unit.
772 std::map<std::string, DIE *> Globals;
774 /// DiesSet - Used to uniquely define dies within the compile unit.
776 FoldingSet<DIE> DiesSet;
778 /// Dies - List of all dies in the compile unit.
780 std::vector<DIE *> Dies;
783 CompileUnit(unsigned I, DIE *D)
784 : ID(I), Die(D), DescToDieMap(), GVToDieMap(), DescToDIEntryMap(),
785 GVToDIEntryMap(), Globals(), DiesSet(InitDiesSetSize), Dies()
788 CompileUnit(CompileUnitDesc *CUD, unsigned I, DIE *D)
797 , DiesSet(InitDiesSetSize)
804 for (unsigned i = 0, N = Dies.size(); i < N; ++i)
809 CompileUnitDesc *getDesc() const { return Desc; }
810 unsigned getID() const { return ID; }
811 DIE* getDie() const { return Die; }
812 std::map<std::string, DIE *> &getGlobals() { return Globals; }
814 /// hasContent - Return true if this compile unit has something to write out.
816 bool hasContent() const {
817 return !Die->getChildren().empty();
820 /// AddGlobal - Add a new global entity to the compile unit.
822 void AddGlobal(const std::string &Name, DIE *Die) {
826 /// getDieMapSlotFor - Returns the debug information entry map slot for the
827 /// specified debug descriptor.
828 DIE *&getDieMapSlotFor(DebugInfoDesc *DID) {
829 return DescToDieMap[DID];
831 DIE *&getDieMapSlotFor(GlobalVariable *GV) {
832 return GVToDieMap[GV];
835 /// getDIEntrySlotFor - Returns the debug information entry proxy slot for the
836 /// specified debug descriptor.
837 DIEntry *&getDIEntrySlotFor(DebugInfoDesc *DID) {
838 return DescToDIEntryMap[DID];
840 DIEntry *&getDIEntrySlotFor(GlobalVariable *GV) {
841 return GVToDIEntryMap[GV];
844 /// AddDie - Adds or interns the DIE to the compile unit.
846 DIE *AddDie(DIE &Buffer) {
850 DIE *Die = DiesSet.FindNodeOrInsertPos(ID, Where);
853 Die = new DIE(Buffer);
854 DiesSet.InsertNode(Die, Where);
855 this->Die->AddChild(Die);
863 //===----------------------------------------------------------------------===//
864 /// Dwarf - Emits general Dwarf directives.
870 //===--------------------------------------------------------------------===//
871 // Core attributes used by the Dwarf writer.
875 /// O - Stream to .s file.
879 /// Asm - Target of Dwarf emission.
883 /// TAI - Target asm information.
884 const TargetAsmInfo *TAI;
886 /// TD - Target data.
887 const TargetData *TD;
889 /// RI - Register Information.
890 const TargetRegisterInfo *RI;
892 /// M - Current module.
896 /// MF - Current machine function.
900 /// MMI - Collected machine module information.
902 MachineModuleInfo *MMI;
904 /// SubprogramCount - The running count of functions being compiled.
906 unsigned SubprogramCount;
908 /// Flavor - A unique string indicating what dwarf producer this is, used to
910 const char * const Flavor;
913 Dwarf(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T,
918 , TD(Asm->TM.getTargetData())
919 , RI(Asm->TM.getRegisterInfo())
931 //===--------------------------------------------------------------------===//
934 AsmPrinter *getAsm() const { return Asm; }
935 MachineModuleInfo *getMMI() const { return MMI; }
936 const TargetAsmInfo *getTargetAsmInfo() const { return TAI; }
937 const TargetData *getTargetData() const { return TD; }
939 void PrintRelDirective(bool Force32Bit = false, bool isInSection = false)
941 if (isInSection && TAI->getDwarfSectionOffsetDirective())
942 O << TAI->getDwarfSectionOffsetDirective();
943 else if (Force32Bit || TD->getPointerSize() == sizeof(int32_t))
944 O << TAI->getData32bitsDirective();
946 O << TAI->getData64bitsDirective();
949 /// PrintLabelName - Print label name in form used by Dwarf writer.
951 void PrintLabelName(DWLabel Label) const {
952 PrintLabelName(Label.Tag, Label.Number);
954 void PrintLabelName(const char *Tag, unsigned Number) const {
955 O << TAI->getPrivateGlobalPrefix() << Tag;
956 if (Number) O << Number;
959 void PrintLabelName(const char *Tag, unsigned Number,
960 const char *Suffix) const {
961 O << TAI->getPrivateGlobalPrefix() << Tag;
962 if (Number) O << Number;
966 /// EmitLabel - Emit location label for internal use by Dwarf.
968 void EmitLabel(DWLabel Label) const {
969 EmitLabel(Label.Tag, Label.Number);
971 void EmitLabel(const char *Tag, unsigned Number) const {
972 PrintLabelName(Tag, Number);
976 /// EmitReference - Emit a reference to a label.
978 void EmitReference(DWLabel Label, bool IsPCRelative = false,
979 bool Force32Bit = false) const {
980 EmitReference(Label.Tag, Label.Number, IsPCRelative, Force32Bit);
982 void EmitReference(const char *Tag, unsigned Number,
983 bool IsPCRelative = false, bool Force32Bit = false) const {
984 PrintRelDirective(Force32Bit);
985 PrintLabelName(Tag, Number);
987 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
989 void EmitReference(const std::string &Name, bool IsPCRelative = false,
990 bool Force32Bit = false) const {
991 PrintRelDirective(Force32Bit);
995 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
998 /// EmitDifference - Emit the difference between two labels. Some
999 /// assemblers do not behave with absolute expressions with data directives,
1000 /// so there is an option (needsSet) to use an intermediary set expression.
1001 void EmitDifference(DWLabel LabelHi, DWLabel LabelLo,
1002 bool IsSmall = false) {
1003 EmitDifference(LabelHi.Tag, LabelHi.Number,
1004 LabelLo.Tag, LabelLo.Number,
1007 void EmitDifference(const char *TagHi, unsigned NumberHi,
1008 const char *TagLo, unsigned NumberLo,
1009 bool IsSmall = false) {
1010 if (TAI->needsSet()) {
1012 PrintLabelName("set", SetCounter, Flavor);
1014 PrintLabelName(TagHi, NumberHi);
1016 PrintLabelName(TagLo, NumberLo);
1019 PrintRelDirective(IsSmall);
1020 PrintLabelName("set", SetCounter, Flavor);
1023 PrintRelDirective(IsSmall);
1025 PrintLabelName(TagHi, NumberHi);
1027 PrintLabelName(TagLo, NumberLo);
1031 void EmitSectionOffset(const char* Label, const char* Section,
1032 unsigned LabelNumber, unsigned SectionNumber,
1033 bool IsSmall = false, bool isEH = false,
1034 bool useSet = true) {
1035 bool printAbsolute = false;
1037 printAbsolute = TAI->isAbsoluteEHSectionOffsets();
1039 printAbsolute = TAI->isAbsoluteDebugSectionOffsets();
1041 if (TAI->needsSet() && useSet) {
1043 PrintLabelName("set", SetCounter, Flavor);
1045 PrintLabelName(Label, LabelNumber);
1047 if (!printAbsolute) {
1049 PrintLabelName(Section, SectionNumber);
1053 PrintRelDirective(IsSmall);
1055 PrintLabelName("set", SetCounter, Flavor);
1058 PrintRelDirective(IsSmall, true);
1060 PrintLabelName(Label, LabelNumber);
1062 if (!printAbsolute) {
1064 PrintLabelName(Section, SectionNumber);
1069 /// EmitFrameMoves - Emit frame instructions to describe the layout of the
1071 void EmitFrameMoves(const char *BaseLabel, unsigned BaseLabelID,
1072 const std::vector<MachineMove> &Moves, bool isEH) {
1074 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
1075 TargetFrameInfo::StackGrowsUp ?
1076 TD->getPointerSize() : -TD->getPointerSize();
1077 bool IsLocal = BaseLabel && strcmp(BaseLabel, "label") == 0;
1079 for (unsigned i = 0, N = Moves.size(); i < N; ++i) {
1080 const MachineMove &Move = Moves[i];
1081 unsigned LabelID = Move.getLabelID();
1084 LabelID = MMI->MappedLabel(LabelID);
1086 // Throw out move if the label is invalid.
1087 if (!LabelID) continue;
1090 const MachineLocation &Dst = Move.getDestination();
1091 const MachineLocation &Src = Move.getSource();
1093 // Advance row if new location.
1094 if (BaseLabel && LabelID && (BaseLabelID != LabelID || !IsLocal)) {
1095 Asm->EmitInt8(DW_CFA_advance_loc4);
1096 Asm->EOL("DW_CFA_advance_loc4");
1097 EmitDifference("label", LabelID, BaseLabel, BaseLabelID, true);
1100 BaseLabelID = LabelID;
1101 BaseLabel = "label";
1105 // If advancing cfa.
1106 if (Dst.isReg() && Dst.getReg() == MachineLocation::VirtualFP) {
1108 if (Src.getReg() == MachineLocation::VirtualFP) {
1109 Asm->EmitInt8(DW_CFA_def_cfa_offset);
1110 Asm->EOL("DW_CFA_def_cfa_offset");
1112 Asm->EmitInt8(DW_CFA_def_cfa);
1113 Asm->EOL("DW_CFA_def_cfa");
1114 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Src.getReg(), isEH));
1115 Asm->EOL("Register");
1118 int Offset = -Src.getOffset();
1120 Asm->EmitULEB128Bytes(Offset);
1123 assert(0 && "Machine move no supported yet.");
1125 } else if (Src.isReg() &&
1126 Src.getReg() == MachineLocation::VirtualFP) {
1128 Asm->EmitInt8(DW_CFA_def_cfa_register);
1129 Asm->EOL("DW_CFA_def_cfa_register");
1130 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Dst.getReg(), isEH));
1131 Asm->EOL("Register");
1133 assert(0 && "Machine move no supported yet.");
1136 unsigned Reg = RI->getDwarfRegNum(Src.getReg(), isEH);
1137 int Offset = Dst.getOffset() / stackGrowth;
1140 Asm->EmitInt8(DW_CFA_offset_extended_sf);
1141 Asm->EOL("DW_CFA_offset_extended_sf");
1142 Asm->EmitULEB128Bytes(Reg);
1144 Asm->EmitSLEB128Bytes(Offset);
1146 } else if (Reg < 64) {
1147 Asm->EmitInt8(DW_CFA_offset + Reg);
1149 Asm->EOL("DW_CFA_offset + Reg (" + utostr(Reg) + ")");
1152 Asm->EmitULEB128Bytes(Offset);
1155 Asm->EmitInt8(DW_CFA_offset_extended);
1156 Asm->EOL("DW_CFA_offset_extended");
1157 Asm->EmitULEB128Bytes(Reg);
1159 Asm->EmitULEB128Bytes(Offset);
1168 //===----------------------------------------------------------------------===//
1169 /// SrcFileInfo - This class is used to track source information.
1172 unsigned DirectoryID; // Directory ID number.
1173 std::string Name; // File name (not including directory.)
1175 SrcFileInfo(unsigned D, const std::string &N) : DirectoryID(D), Name(N) {}
1178 unsigned getDirectoryID() const { return DirectoryID; }
1179 const std::string &getName() const { return Name; }
1181 /// operator== - Used by UniqueVector to locate entry.
1183 bool operator==(const SourceFileInfo &SI) const {
1184 return getDirectoryID() == SI.getDirectoryID() && getName() == SI.getName();
1187 /// operator< - Used by UniqueVector to locate entry.
1189 bool operator<(const SrcFileInfo &SI) const {
1190 return getDirectoryID() < SI.getDirectoryID() ||
1191 (getDirectoryID() == SI.getDirectoryID() && getName() < SI.getName());
1195 //===----------------------------------------------------------------------===//
1196 /// DwarfDebug - Emits Dwarf debug directives.
1198 class DwarfDebug : public Dwarf {
1201 //===--------------------------------------------------------------------===//
1202 // Attributes used to construct specific Dwarf sections.
1205 /// CompileUnits - All the compile units involved in this build. The index
1206 /// of each entry in this vector corresponds to the sources in MMI.
1207 std::vector<CompileUnit *> CompileUnits;
1208 DenseMap<GlobalVariable *, CompileUnit *> DW_CUs;
1210 /// AbbreviationsSet - Used to uniquely define abbreviations.
1212 FoldingSet<DIEAbbrev> AbbreviationsSet;
1214 /// Abbreviations - A list of all the unique abbreviations in use.
1216 std::vector<DIEAbbrev *> Abbreviations;
1218 /// ValuesSet - Used to uniquely define values.
1220 // Directories - Uniquing vector for directories.
1221 UniqueVector<std::string> Directories;
1223 // SourceFiles - Uniquing vector for source files.
1224 UniqueVector<SrcFileInfo> SrcFiles;
1226 FoldingSet<DIEValue> ValuesSet;
1228 /// Values - A list of all the unique values in use.
1230 std::vector<DIEValue *> Values;
1232 /// StringPool - A UniqueVector of strings used by indirect references.
1234 UniqueVector<std::string> StringPool;
1236 /// UnitMap - Map debug information descriptor to compile unit.
1238 std::map<DebugInfoDesc *, CompileUnit *> DescToUnitMap;
1240 /// SectionMap - Provides a unique id per text section.
1242 UniqueVector<const Section*> SectionMap;
1244 /// SectionSourceLines - Tracks line numbers per text section.
1246 std::vector<std::vector<SourceLineInfo> > SectionSourceLines;
1248 /// didInitial - Flag to indicate if initial emission has been done.
1252 /// shouldEmit - Flag to indicate if debug information should be emitted.
1256 struct FunctionDebugFrameInfo {
1258 std::vector<MachineMove> Moves;
1260 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M):
1261 Number(Num), Moves(M) { }
1264 std::vector<FunctionDebugFrameInfo> DebugFrames;
1268 /// ShouldEmitDwarf - Returns true if Dwarf declarations should be made.
1270 bool ShouldEmitDwarf() const { return shouldEmit; }
1272 /// AssignAbbrevNumber - Define a unique number for the abbreviation.
1274 void AssignAbbrevNumber(DIEAbbrev &Abbrev) {
1275 // Profile the node so that we can make it unique.
1276 FoldingSetNodeID ID;
1279 // Check the set for priors.
1280 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
1282 // If it's newly added.
1283 if (InSet == &Abbrev) {
1284 // Add to abbreviation list.
1285 Abbreviations.push_back(&Abbrev);
1286 // Assign the vector position + 1 as its number.
1287 Abbrev.setNumber(Abbreviations.size());
1289 // Assign existing abbreviation number.
1290 Abbrev.setNumber(InSet->getNumber());
1294 /// NewString - Add a string to the constant pool and returns a label.
1296 DWLabel NewString(const std::string &String) {
1297 unsigned StringID = StringPool.insert(String);
1298 return DWLabel("string", StringID);
1301 /// NewDIEntry - Creates a new DIEntry to be a proxy for a debug information
1303 DIEntry *NewDIEntry(DIE *Entry = NULL) {
1307 FoldingSetNodeID ID;
1308 DIEntry::Profile(ID, Entry);
1310 Value = static_cast<DIEntry *>(ValuesSet.FindNodeOrInsertPos(ID, Where));
1312 if (Value) return Value;
1314 Value = new DIEntry(Entry);
1315 ValuesSet.InsertNode(Value, Where);
1317 Value = new DIEntry(Entry);
1320 Values.push_back(Value);
1324 /// SetDIEntry - Set a DIEntry once the debug information entry is defined.
1326 void SetDIEntry(DIEntry *Value, DIE *Entry) {
1327 Value->Entry = Entry;
1328 // Add to values set if not already there. If it is, we merely have a
1329 // duplicate in the values list (no harm.)
1330 ValuesSet.GetOrInsertNode(Value);
1333 /// AddUInt - Add an unsigned integer attribute data and value.
1335 void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer) {
1336 if (!Form) Form = DIEInteger::BestForm(false, Integer);
1338 FoldingSetNodeID ID;
1339 DIEInteger::Profile(ID, Integer);
1341 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1343 Value = new DIEInteger(Integer);
1344 ValuesSet.InsertNode(Value, Where);
1345 Values.push_back(Value);
1348 Die->AddValue(Attribute, Form, Value);
1351 /// AddSInt - Add an signed integer attribute data and value.
1353 void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer) {
1354 if (!Form) Form = DIEInteger::BestForm(true, Integer);
1356 FoldingSetNodeID ID;
1357 DIEInteger::Profile(ID, (uint64_t)Integer);
1359 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1361 Value = new DIEInteger(Integer);
1362 ValuesSet.InsertNode(Value, Where);
1363 Values.push_back(Value);
1366 Die->AddValue(Attribute, Form, Value);
1369 /// AddString - Add a std::string attribute data and value.
1371 void AddString(DIE *Die, unsigned Attribute, unsigned Form,
1372 const std::string &String) {
1373 FoldingSetNodeID ID;
1374 DIEString::Profile(ID, String);
1376 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1378 Value = new DIEString(String);
1379 ValuesSet.InsertNode(Value, Where);
1380 Values.push_back(Value);
1383 Die->AddValue(Attribute, Form, Value);
1386 /// AddLabel - Add a Dwarf label attribute data and value.
1388 void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
1389 const DWLabel &Label) {
1390 FoldingSetNodeID ID;
1391 DIEDwarfLabel::Profile(ID, Label);
1393 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1395 Value = new DIEDwarfLabel(Label);
1396 ValuesSet.InsertNode(Value, Where);
1397 Values.push_back(Value);
1400 Die->AddValue(Attribute, Form, Value);
1403 /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
1405 void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
1406 const std::string &Label) {
1407 FoldingSetNodeID ID;
1408 DIEObjectLabel::Profile(ID, Label);
1410 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1412 Value = new DIEObjectLabel(Label);
1413 ValuesSet.InsertNode(Value, Where);
1414 Values.push_back(Value);
1417 Die->AddValue(Attribute, Form, Value);
1420 /// AddSectionOffset - Add a section offset label attribute data and value.
1422 void AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
1423 const DWLabel &Label, const DWLabel &Section,
1424 bool isEH = false, bool useSet = true) {
1425 FoldingSetNodeID ID;
1426 DIESectionOffset::Profile(ID, Label, Section);
1428 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1430 Value = new DIESectionOffset(Label, Section, isEH, useSet);
1431 ValuesSet.InsertNode(Value, Where);
1432 Values.push_back(Value);
1435 Die->AddValue(Attribute, Form, Value);
1438 /// AddDelta - Add a label delta attribute data and value.
1440 void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
1441 const DWLabel &Hi, const DWLabel &Lo) {
1442 FoldingSetNodeID ID;
1443 DIEDelta::Profile(ID, Hi, Lo);
1445 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1447 Value = new DIEDelta(Hi, Lo);
1448 ValuesSet.InsertNode(Value, Where);
1449 Values.push_back(Value);
1452 Die->AddValue(Attribute, Form, Value);
1455 /// AddDIEntry - Add a DIE attribute data and value.
1457 void AddDIEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
1458 Die->AddValue(Attribute, Form, NewDIEntry(Entry));
1461 /// AddBlock - Add block data.
1463 void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block) {
1464 Block->ComputeSize(*this);
1465 FoldingSetNodeID ID;
1468 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1471 ValuesSet.InsertNode(Value, Where);
1472 Values.push_back(Value);
1474 // Already exists, reuse the previous one.
1476 Block = cast<DIEBlock>(Value);
1479 Die->AddValue(Attribute, Block->BestForm(), Value);
1484 /// AddSourceLine - Add location information to specified debug information
1486 void AddSourceLine(DIE *Die, CompileUnitDesc *File, unsigned Line) {
1488 CompileUnit *FileUnit = FindCompileUnit(File);
1489 unsigned FileID = FileUnit->getID();
1490 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1491 AddUInt(Die, DW_AT_decl_line, 0, Line);
1495 /// AddSourceLine - Add location information to specified debug information
1497 void AddSourceLine(DIE *Die, DIGlobal *G) {
1498 unsigned FileID = 0;
1499 unsigned Line = G->getLineNumber();
1500 if (G->getVersion() < DIDescriptor::Version7) {
1501 // Version6 or earlier. Use compile unit info to get file id.
1502 CompileUnit *Unit = FindCompileUnit(G->getCompileUnit());
1503 FileID = Unit->getID();
1505 // Version7 or newer, use filename and directory info from DIGlobal
1507 unsigned DID = Directories.idFor(G->getDirectory());
1508 FileID = SrcFiles.idFor(SrcFileInfo(DID, G->getFilename()));
1510 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1511 AddUInt(Die, DW_AT_decl_line, 0, Line);
1514 void AddSourceLine(DIE *Die, DIType *G) {
1515 unsigned FileID = 0;
1516 unsigned Line = G->getLineNumber();
1517 if (G->getVersion() < DIDescriptor::Version7) {
1518 // Version6 or earlier. Use compile unit info to get file id.
1519 CompileUnit *Unit = FindCompileUnit(G->getCompileUnit());
1520 FileID = Unit->getID();
1522 // Version7 or newer, use filename and directory info from DIGlobal
1524 unsigned DID = Directories.idFor(G->getDirectory());
1525 FileID = SrcFiles.idFor(SrcFileInfo(DID, G->getFilename()));
1527 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1528 AddUInt(Die, DW_AT_decl_line, 0, Line);
1531 /// AddAddress - Add an address attribute to a die based on the location
1533 void AddAddress(DIE *Die, unsigned Attribute,
1534 const MachineLocation &Location) {
1535 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
1536 DIEBlock *Block = new DIEBlock();
1538 if (Location.isReg()) {
1540 AddUInt(Block, 0, DW_FORM_data1, DW_OP_reg0 + Reg);
1542 AddUInt(Block, 0, DW_FORM_data1, DW_OP_regx);
1543 AddUInt(Block, 0, DW_FORM_udata, Reg);
1547 AddUInt(Block, 0, DW_FORM_data1, DW_OP_breg0 + Reg);
1549 AddUInt(Block, 0, DW_FORM_data1, DW_OP_bregx);
1550 AddUInt(Block, 0, DW_FORM_udata, Reg);
1552 AddUInt(Block, 0, DW_FORM_sdata, Location.getOffset());
1555 AddBlock(Die, Attribute, 0, Block);
1558 /// AddBasicType - Add a new basic type attribute to the specified entity.
1560 void AddBasicType(DIE *Entity, CompileUnit *Unit,
1561 const std::string &Name,
1562 unsigned Encoding, unsigned Size) {
1564 DIE Buffer(DW_TAG_base_type);
1565 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1566 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, Encoding);
1567 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1568 DIE *BasicTypeDie = Unit->AddDie(Buffer);
1569 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, BasicTypeDie);
1572 /// AddPointerType - Add a new pointer type attribute to the specified entity.
1574 void AddPointerType(DIE *Entity, CompileUnit *Unit, const std::string &Name) {
1575 DIE Buffer(DW_TAG_pointer_type);
1576 AddUInt(&Buffer, DW_AT_byte_size, 0, TD->getPointerSize());
1577 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1578 DIE *PointerTypeDie = Unit->AddDie(Buffer);
1579 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, PointerTypeDie);
1582 /// AddType - Add a new type attribute to the specified entity.
1584 void AddType(DIE *Entity, TypeDesc *TyDesc, CompileUnit *Unit) {
1586 AddBasicType(Entity, Unit, "", DW_ATE_signed, sizeof(int32_t));
1588 // Check for pre-existence.
1589 DIEntry *&Slot = Unit->getDIEntrySlotFor(TyDesc);
1591 // If it exists then use the existing value.
1593 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1597 if (SubprogramDesc *SubprogramTy = dyn_cast<SubprogramDesc>(TyDesc)) {
1598 // FIXME - Not sure why programs and variables are coming through here.
1599 // Short cut for handling subprogram types (not really a TyDesc.)
1600 AddPointerType(Entity, Unit, SubprogramTy->getName());
1601 } else if (GlobalVariableDesc *GlobalTy =
1602 dyn_cast<GlobalVariableDesc>(TyDesc)) {
1603 // FIXME - Not sure why programs and variables are coming through here.
1604 // Short cut for handling global variable types (not really a TyDesc.)
1605 AddPointerType(Entity, Unit, GlobalTy->getName());
1608 Slot = NewDIEntry();
1611 DIE Buffer(DW_TAG_base_type);
1612 ConstructType(Buffer, TyDesc, Unit);
1614 // Add debug information entry to entity and unit.
1615 DIE *Die = Unit->AddDie(Buffer);
1616 SetDIEntry(Slot, Die);
1617 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1622 /// AddType - Add a new type attribute to the specified entity.
1623 void AddType(CompileUnit *DW_Unit, DIE *Entity, DIType Ty) {
1625 AddBasicType(Entity, DW_Unit, "", DW_ATE_signed, sizeof(int32_t));
1629 // Check for pre-existence.
1630 DIEntry *&Slot = DW_Unit->getDIEntrySlotFor(Ty.getGV());
1631 // If it exists then use the existing value.
1633 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1638 Slot = NewDIEntry();
1641 DIE Buffer(DW_TAG_base_type);
1642 if (DIBasicType *BT = dyn_cast<DIBasicType>(&Ty))
1643 ConstructTypeDIE(DW_Unit, Buffer, BT);
1644 else if (DIDerivedType *DT = dyn_cast<DIDerivedType>(&Ty))
1645 ConstructTypeDIE(DW_Unit, Buffer, DT);
1646 else if (DICompositeType *CT = dyn_cast<DICompositeType>(&Ty))
1647 ConstructTypeDIE(DW_Unit, Buffer, CT);
1649 // Add debug information entry to entity and unit.
1650 DIE *Die = DW_Unit->AddDie(Buffer);
1651 SetDIEntry(Slot, Die);
1652 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1655 /// ConstructTypeDIE - Construct basic type die from DIBasicType.
1656 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1659 // Get core information.
1660 const std::string &Name = BTy->getName();
1661 Buffer.setTag(DW_TAG_base_type);
1662 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, BTy->getEncoding());
1663 // Add name if not anonymous or intermediate type.
1665 AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1666 uint64_t Size = BTy->getSizeInBits() >> 3;
1667 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1670 /// ConstructTypeDIE - Construct derived type die from DIDerivedType.
1671 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1672 DIDerivedType *DTy) {
1674 // Get core information.
1675 const std::string &Name = DTy->getName();
1676 uint64_t Size = DTy->getSizeInBits() >> 3;
1677 unsigned Tag = DTy->getTag();
1678 // FIXME - Workaround for templates.
1679 if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
1682 // Map to main type, void will not have a type.
1683 DIType FromTy = DTy->getTypeDerivedFrom();
1684 AddType(DW_Unit, &Buffer, FromTy);
1686 // Add name if not anonymous or intermediate type.
1687 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1689 // Add size if non-zero (derived types might be zero-sized.)
1691 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1693 // Add source line info if available and TyDesc is not a forward
1695 // FIXME - Enable this. if (!DTy->isForwardDecl())
1696 // FIXME - Enable this. AddSourceLine(&Buffer, *DTy);
1699 /// ConstructTypeDIE - Construct type DIE from DICompositeType.
1700 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1701 DICompositeType *CTy) {
1703 // Get core information.
1704 const std::string &Name = CTy->getName();
1705 uint64_t Size = CTy->getSizeInBits() >> 3;
1706 unsigned Tag = CTy->getTag();
1708 case DW_TAG_vector_type:
1709 case DW_TAG_array_type:
1710 ConstructArrayTypeDIE(DW_Unit, Buffer, CTy);
1712 //FIXME - Enable this.
1713 // case DW_TAG_enumeration_type:
1714 // DIArray Elements = CTy->getTypeArray();
1715 // // Add enumerators to enumeration type.
1716 // for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i)
1717 // ConstructEnumTypeDIE(Buffer, &Elements.getElement(i));
1719 case DW_TAG_subroutine_type:
1721 // Add prototype flag.
1722 AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
1723 DIArray Elements = CTy->getTypeArray();
1725 DIDescriptor RTy = Elements.getElement(0);
1726 if (DIBasicType *BT = dyn_cast<DIBasicType>(&RTy))
1727 AddType(DW_Unit, &Buffer, *BT);
1728 else if (DIDerivedType *DT = dyn_cast<DIDerivedType>(&RTy))
1729 AddType(DW_Unit, &Buffer, *DT);
1730 else if (DICompositeType *CT = dyn_cast<DICompositeType>(&RTy))
1731 AddType(DW_Unit, &Buffer, *CT);
1733 //AddType(DW_Unit, &Buffer, Elements.getElement(0));
1735 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1736 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1737 DIDescriptor Ty = Elements.getElement(i);
1738 if (DIBasicType *BT = dyn_cast<DIBasicType>(&Ty))
1739 AddType(DW_Unit, &Buffer, *BT);
1740 else if (DIDerivedType *DT = dyn_cast<DIDerivedType>(&Ty))
1741 AddType(DW_Unit, &Buffer, *DT);
1742 else if (DICompositeType *CT = dyn_cast<DICompositeType>(&Ty))
1743 AddType(DW_Unit, &Buffer, *CT);
1744 Buffer.AddChild(Arg);
1748 case DW_TAG_structure_type:
1749 case DW_TAG_union_type:
1751 // Add elements to structure type.
1752 DIArray Elements = CTy->getTypeArray();
1753 // Add elements to structure type.
1754 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1755 DIDescriptor Element = Elements.getElement(i);
1756 if (DISubprogram *SP = dyn_cast<DISubprogram>(&Element))
1757 ConstructFieldTypeDIE(DW_Unit, Buffer, SP);
1758 else if (DIDerivedType *DT = dyn_cast<DIDerivedType>(&Element))
1759 ConstructFieldTypeDIE(DW_Unit, Buffer, DT);
1760 else if (DIGlobalVariable *GV = dyn_cast<DIGlobalVariable>(&Element))
1761 ConstructFieldTypeDIE(DW_Unit, Buffer, GV);
1769 // Add name if not anonymous or intermediate type.
1770 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1772 // Add size if non-zero (derived types might be zero-sized.)
1774 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1776 // Add zero size even if it is not a forward declaration.
1777 // FIXME - Enable this.
1778 // if (!CTy->isDefinition())
1779 // AddUInt(&Buffer, DW_AT_declaration, DW_FORM_flag, 1);
1781 // AddUInt(&Buffer, DW_AT_byte_size, 0, 0);
1784 // Add source line info if available and TyDesc is not a forward
1786 // FIXME - Enable this.
1787 // if (CTy->isForwardDecl())
1788 // AddSourceLine(&Buffer, *CTy);
1791 // ConstructSubrangeDIE - Construct subrange DIE from DISubrange.
1792 void ConstructSubrangeDIE (DIE &Buffer, DISubrange *SR, DIE *IndexTy) {
1793 int64_t L = SR->getLo();
1794 int64_t H = SR->getHi();
1795 DIE *DW_Subrange = new DIE(DW_TAG_subrange_type);
1797 AddDIEntry(DW_Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1799 AddSInt(DW_Subrange, DW_AT_lower_bound, 0, L);
1800 AddSInt(DW_Subrange, DW_AT_upper_bound, 0, H);
1802 Buffer.AddChild(DW_Subrange);
1805 /// ConstructArrayTypeDIE - Construct array type DIE from DICompositeType.
1806 void ConstructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1807 DICompositeType *CTy) {
1808 Buffer.setTag(DW_TAG_array_type);
1809 if (CTy->getTag() == DW_TAG_vector_type)
1810 AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1812 DIArray Elements = CTy->getTypeArray();
1813 // FIXME - Enable this.
1814 AddType(DW_Unit, &Buffer, CTy->getTypeDerivedFrom());
1816 // Construct an anonymous type for index type.
1817 DIE IdxBuffer(DW_TAG_base_type);
1818 AddUInt(&IdxBuffer, DW_AT_byte_size, 0, sizeof(int32_t));
1819 AddUInt(&IdxBuffer, DW_AT_encoding, DW_FORM_data1, DW_ATE_signed);
1820 DIE *IndexTy = DW_Unit->AddDie(IdxBuffer);
1822 // Add subranges to array type.
1823 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1824 DIDescriptor Element = Elements.getElement(i);
1825 if (DISubrange *SR = dyn_cast<DISubrange>(&Element))
1826 ConstructSubrangeDIE(Buffer, SR, IndexTy);
1830 /// ConstructEnumTypeDIE - Construct enum type DIE from
1832 void ConstructEnumTypeDIE(CompileUnit *DW_Unit,
1833 DIE &Buffer, DIEnumerator *ETy) {
1835 DIE *Enumerator = new DIE(DW_TAG_enumerator);
1836 AddString(Enumerator, DW_AT_name, DW_FORM_string, ETy->getName());
1837 int64_t Value = ETy->getEnumValue();
1838 AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
1839 Buffer.AddChild(Enumerator);
1842 /// ConstructFieldTypeDIE - Construct variable DIE for a struct field.
1843 void ConstructFieldTypeDIE(CompileUnit *DW_Unit,
1844 DIE &Buffer, DIGlobalVariable *V) {
1846 DIE *VariableDie = new DIE(DW_TAG_variable);
1847 const std::string &LinkageName = V->getLinkageName();
1848 if (!LinkageName.empty())
1849 AddString(VariableDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
1851 // FIXME - Enable this. AddSourceLine(VariableDie, V);
1852 AddType(DW_Unit, VariableDie, V->getType());
1853 if (!V->isLocalToUnit())
1854 AddUInt(VariableDie, DW_AT_external, DW_FORM_flag, 1);
1855 AddUInt(VariableDie, DW_AT_declaration, DW_FORM_flag, 1);
1856 Buffer.AddChild(VariableDie);
1859 /// ConstructFieldTypeDIE - Construct subprogram DIE for a struct field.
1860 void ConstructFieldTypeDIE(CompileUnit *DW_Unit,
1861 DIE &Buffer, DISubprogram *SP,
1862 bool IsConstructor = false) {
1863 DIE *Method = new DIE(DW_TAG_subprogram);
1864 AddString(Method, DW_AT_name, DW_FORM_string, SP->getName());
1865 const std::string &LinkageName = SP->getLinkageName();
1866 if (!LinkageName.empty())
1867 AddString(Method, DW_AT_MIPS_linkage_name, DW_FORM_string, LinkageName);
1868 // FIXME - Enable this. AddSourceLine(Method, SP);
1870 DICompositeType MTy = SP->getType();
1871 DIArray Args = MTy.getTypeArray();
1874 if (!IsConstructor) {
1875 DIDescriptor Ty = Args.getElement(0);
1876 if (DIBasicType *BT = dyn_cast<DIBasicType>(&Ty))
1877 AddType(DW_Unit, Method, *BT);
1878 else if (DIDerivedType *DT = dyn_cast<DIDerivedType>(&Ty))
1879 AddType(DW_Unit, Method, *DT);
1880 else if (DICompositeType *CT = dyn_cast<DICompositeType>(&Ty))
1881 AddType(DW_Unit, Method, *CT);
1885 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1886 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1887 DIDescriptor Ty = Args.getElement(i);
1888 if (DIBasicType *BT = dyn_cast<DIBasicType>(&Ty))
1889 AddType(DW_Unit, Method, *BT);
1890 else if (DIDerivedType *DT = dyn_cast<DIDerivedType>(&Ty))
1891 AddType(DW_Unit, Method, *DT);
1892 else if (DICompositeType *CT = dyn_cast<DICompositeType>(&Ty))
1893 AddType(DW_Unit, Method, *CT);
1894 AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1); // ???
1895 Method->AddChild(Arg);
1898 if (!SP->isLocalToUnit())
1899 AddUInt(Method, DW_AT_external, DW_FORM_flag, 1);
1900 Buffer.AddChild(Method);
1903 /// COnstructFieldTypeDIE - Construct derived type DIE for a struct field.
1904 void ConstructFieldTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1905 DIDerivedType *DTy) {
1906 unsigned Tag = DTy->getTag();
1907 DIE *MemberDie = new DIE(Tag);
1908 if (!DTy->getName().empty())
1909 AddString(MemberDie, DW_AT_name, DW_FORM_string, DTy->getName());
1910 // FIXME - Enable this. AddSourceLine(MemberDie, DTy);
1912 DIType FromTy = DTy->getTypeDerivedFrom();
1913 AddType(DW_Unit, MemberDie, FromTy);
1915 uint64_t Size = DTy->getSizeInBits();
1916 uint64_t Offset = DTy->getOffsetInBits();
1918 // FIXME Handle bitfields
1921 AddUInt(MemberDie, DW_AT_bit_size, 0, Size);
1922 // Add computation for offset.
1923 DIEBlock *Block = new DIEBlock();
1924 AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
1925 AddUInt(Block, 0, DW_FORM_udata, Offset >> 3);
1926 AddBlock(MemberDie, DW_AT_data_member_location, 0, Block);
1928 // FIXME Handle DW_AT_accessibility.
1930 Buffer.AddChild(MemberDie);
1933 /// ConstructType - Adds all the required attributes to the type.
1935 void ConstructType(DIE &Buffer, TypeDesc *TyDesc, CompileUnit *Unit) {
1936 // Get core information.
1937 const std::string &Name = TyDesc->getName();
1938 uint64_t Size = TyDesc->getSize() >> 3;
1940 if (BasicTypeDesc *BasicTy = dyn_cast<BasicTypeDesc>(TyDesc)) {
1941 // Fundamental types like int, float, bool
1942 Buffer.setTag(DW_TAG_base_type);
1943 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, BasicTy->getEncoding());
1944 } else if (DerivedTypeDesc *DerivedTy = dyn_cast<DerivedTypeDesc>(TyDesc)) {
1946 unsigned Tag = DerivedTy->getTag();
1947 // FIXME - Workaround for templates.
1948 if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
1949 // Pointers, typedefs et al.
1951 // Map to main type, void will not have a type.
1952 if (TypeDesc *FromTy = DerivedTy->getFromType())
1953 AddType(&Buffer, FromTy, Unit);
1954 } else if (CompositeTypeDesc *CompTy = dyn_cast<CompositeTypeDesc>(TyDesc)){
1956 unsigned Tag = CompTy->getTag();
1958 // Set tag accordingly.
1959 if (Tag == DW_TAG_vector_type)
1960 Buffer.setTag(DW_TAG_array_type);
1964 std::vector<DebugInfoDesc *> &Elements = CompTy->getElements();
1967 case DW_TAG_vector_type:
1968 AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1970 case DW_TAG_array_type: {
1971 // Add element type.
1972 if (TypeDesc *FromTy = CompTy->getFromType())
1973 AddType(&Buffer, FromTy, Unit);
1975 // Don't emit size attribute.
1978 // Construct an anonymous type for index type.
1979 DIE Buffer(DW_TAG_base_type);
1980 AddUInt(&Buffer, DW_AT_byte_size, 0, sizeof(int32_t));
1981 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, DW_ATE_signed);
1982 DIE *IndexTy = Unit->AddDie(Buffer);
1984 // Add subranges to array type.
1985 for (unsigned i = 0, N = Elements.size(); i < N; ++i) {
1986 SubrangeDesc *SRD = cast<SubrangeDesc>(Elements[i]);
1987 int64_t Lo = SRD->getLo();
1988 int64_t Hi = SRD->getHi();
1989 DIE *Subrange = new DIE(DW_TAG_subrange_type);
1991 // If a range is available.
1993 AddDIEntry(Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1994 // Only add low if non-zero.
1995 if (Lo) AddSInt(Subrange, DW_AT_lower_bound, 0, Lo);
1996 AddSInt(Subrange, DW_AT_upper_bound, 0, Hi);
1999 Buffer.AddChild(Subrange);
2003 case DW_TAG_structure_type:
2004 case DW_TAG_union_type: {
2005 // Add elements to structure type.
2006 for (unsigned i = 0, N = Elements.size(); i < N; ++i) {
2007 DebugInfoDesc *Element = Elements[i];
2009 if (DerivedTypeDesc *MemberDesc = dyn_cast<DerivedTypeDesc>(Element)){
2010 // Add field or base class.
2011 unsigned Tag = MemberDesc->getTag();
2013 // Extract the basic information.
2014 const std::string &Name = MemberDesc->getName();
2015 uint64_t Size = MemberDesc->getSize();
2016 uint64_t Align = MemberDesc->getAlign();
2017 uint64_t Offset = MemberDesc->getOffset();
2019 // Construct member debug information entry.
2020 DIE *Member = new DIE(Tag);
2022 // Add name if not "".
2024 AddString(Member, DW_AT_name, DW_FORM_string, Name);
2026 // Add location if available.
2027 AddSourceLine(Member, MemberDesc->getFile(), MemberDesc->getLine());
2029 // Most of the time the field info is the same as the members.
2030 uint64_t FieldSize = Size;
2031 uint64_t FieldAlign = Align;
2032 uint64_t FieldOffset = Offset;
2034 // Set the member type.
2035 TypeDesc *FromTy = MemberDesc->getFromType();
2036 AddType(Member, FromTy, Unit);
2038 // Walk up typedefs until a real size is found.
2040 if (FromTy->getTag() != DW_TAG_typedef) {
2041 FieldSize = FromTy->getSize();
2042 FieldAlign = FromTy->getAlign();
2046 FromTy = cast<DerivedTypeDesc>(FromTy)->getFromType();
2049 // Unless we have a bit field.
2050 if (Tag == DW_TAG_member && FieldSize != Size) {
2051 // Construct the alignment mask.
2052 uint64_t AlignMask = ~(FieldAlign - 1);
2053 // Determine the high bit + 1 of the declared size.
2054 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
2055 // Work backwards to determine the base offset of the field.
2056 FieldOffset = HiMark - FieldSize;
2057 // Now normalize offset to the field.
2058 Offset -= FieldOffset;
2060 // Maybe we need to work from the other end.
2061 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
2063 // Add size and offset.
2064 AddUInt(Member, DW_AT_byte_size, 0, FieldSize >> 3);
2065 AddUInt(Member, DW_AT_bit_size, 0, Size);
2066 AddUInt(Member, DW_AT_bit_offset, 0, Offset);
2069 // Add computation for offset.
2070 DIEBlock *Block = new DIEBlock();
2071 AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
2072 AddUInt(Block, 0, DW_FORM_udata, FieldOffset >> 3);
2073 AddBlock(Member, DW_AT_data_member_location, 0, Block);
2075 // Add accessibility (public default unless is base class.
2076 if (MemberDesc->isProtected()) {
2077 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_protected);
2078 } else if (MemberDesc->isPrivate()) {
2079 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_private);
2080 } else if (Tag == DW_TAG_inheritance) {
2081 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_public);
2084 Buffer.AddChild(Member);
2085 } else if (GlobalVariableDesc *StaticDesc =
2086 dyn_cast<GlobalVariableDesc>(Element)) {
2087 // Add static member.
2089 // Construct member debug information entry.
2090 DIE *Static = new DIE(DW_TAG_variable);
2092 // Add name and mangled name.
2093 const std::string &Name = StaticDesc->getName();
2094 const std::string &LinkageName = StaticDesc->getLinkageName();
2095 AddString(Static, DW_AT_name, DW_FORM_string, Name);
2096 if (!LinkageName.empty()) {
2097 AddString(Static, DW_AT_MIPS_linkage_name, DW_FORM_string,
2102 AddSourceLine(Static, StaticDesc->getFile(), StaticDesc->getLine());
2105 if (TypeDesc *StaticTy = StaticDesc->getType())
2106 AddType(Static, StaticTy, Unit);
2109 if (!StaticDesc->isStatic())
2110 AddUInt(Static, DW_AT_external, DW_FORM_flag, 1);
2111 AddUInt(Static, DW_AT_declaration, DW_FORM_flag, 1);
2113 Buffer.AddChild(Static);
2114 } else if (SubprogramDesc *MethodDesc =
2115 dyn_cast<SubprogramDesc>(Element)) {
2116 // Add member function.
2118 // Construct member debug information entry.
2119 DIE *Method = new DIE(DW_TAG_subprogram);
2121 // Add name and mangled name.
2122 const std::string &Name = MethodDesc->getName();
2123 const std::string &LinkageName = MethodDesc->getLinkageName();
2125 AddString(Method, DW_AT_name, DW_FORM_string, Name);
2126 bool IsCTor = TyDesc->getName() == Name;
2128 if (!LinkageName.empty()) {
2129 AddString(Method, DW_AT_MIPS_linkage_name, DW_FORM_string,
2134 AddSourceLine(Method, MethodDesc->getFile(), MethodDesc->getLine());
2137 if (CompositeTypeDesc *MethodTy =
2138 dyn_cast_or_null<CompositeTypeDesc>(MethodDesc->getType())) {
2139 // Get argument information.
2140 std::vector<DebugInfoDesc *> &Args = MethodTy->getElements();
2145 AddType(Method, dyn_cast<TypeDesc>(Args[0]), Unit);
2149 for (unsigned i = 1, N = Args.size(); i < N; ++i) {
2150 DIE *Arg = new DIE(DW_TAG_formal_parameter);
2151 AddType(Arg, cast<TypeDesc>(Args[i]), Unit);
2152 AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1);
2153 Method->AddChild(Arg);
2158 if (!MethodDesc->isStatic())
2159 AddUInt(Method, DW_AT_external, DW_FORM_flag, 1);
2160 AddUInt(Method, DW_AT_declaration, DW_FORM_flag, 1);
2162 Buffer.AddChild(Method);
2167 case DW_TAG_enumeration_type: {
2168 // Add enumerators to enumeration type.
2169 for (unsigned i = 0, N = Elements.size(); i < N; ++i) {
2170 EnumeratorDesc *ED = cast<EnumeratorDesc>(Elements[i]);
2171 const std::string &Name = ED->getName();
2172 int64_t Value = ED->getValue();
2173 DIE *Enumerator = new DIE(DW_TAG_enumerator);
2174 AddString(Enumerator, DW_AT_name, DW_FORM_string, Name);
2175 AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
2176 Buffer.AddChild(Enumerator);
2181 case DW_TAG_subroutine_type: {
2182 // Add prototype flag.
2183 AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
2185 AddType(&Buffer, dyn_cast<TypeDesc>(Elements[0]), Unit);
2188 for (unsigned i = 1, N = Elements.size(); i < N; ++i) {
2189 DIE *Arg = new DIE(DW_TAG_formal_parameter);
2190 AddType(Arg, cast<TypeDesc>(Elements[i]), Unit);
2191 Buffer.AddChild(Arg);
2200 // Add name if not anonymous or intermediate type.
2201 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
2203 // Add size if non-zero (derived types might be zero-sized.)
2205 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
2206 else if (isa<CompositeTypeDesc>(TyDesc)) {
2207 // If TyDesc is a composite type, then add size even if it's zero unless
2208 // it's a forward declaration.
2209 if (TyDesc->isForwardDecl())
2210 AddUInt(&Buffer, DW_AT_declaration, DW_FORM_flag, 1);
2212 AddUInt(&Buffer, DW_AT_byte_size, 0, 0);
2215 // Add source line info if available and TyDesc is not a forward
2217 if (!TyDesc->isForwardDecl())
2218 AddSourceLine(&Buffer, TyDesc->getFile(), TyDesc->getLine());
2221 /// NewCompileUnit - Create new compile unit and it's debug information entry.
2223 CompileUnit *NewCompileUnit(CompileUnitDesc *UnitDesc, unsigned ID) {
2224 // Construct debug information entry.
2225 DIE *Die = new DIE(DW_TAG_compile_unit);
2226 AddSectionOffset(Die, DW_AT_stmt_list, DW_FORM_data4,
2227 DWLabel("section_line", 0), DWLabel("section_line", 0), false);
2228 AddString(Die, DW_AT_producer, DW_FORM_string, UnitDesc->getProducer());
2229 AddUInt (Die, DW_AT_language, DW_FORM_data1, UnitDesc->getLanguage());
2230 AddString(Die, DW_AT_name, DW_FORM_string, UnitDesc->getFileName());
2231 if (!UnitDesc->getDirectory().empty())
2232 AddString(Die, DW_AT_comp_dir, DW_FORM_string, UnitDesc->getDirectory());
2234 // Construct compile unit.
2235 CompileUnit *Unit = new CompileUnit(UnitDesc, ID, Die);
2237 // Add Unit to compile unit map.
2238 DescToUnitMap[UnitDesc] = Unit;
2243 /// GetBaseCompileUnit - Get the main compile unit.
2245 CompileUnit *GetBaseCompileUnit() const {
2246 CompileUnit *Unit = CompileUnits[0];
2247 assert(Unit && "Missing compile unit.");
2251 /// FindCompileUnit - Get the compile unit for the given descriptor.
2253 CompileUnit *FindCompileUnit(CompileUnitDesc *UnitDesc) {
2254 CompileUnit *Unit = DescToUnitMap[UnitDesc];
2255 assert(Unit && "Missing compile unit.");
2259 /// FindCompileUnit - Get the compile unit for the given descriptor.
2261 CompileUnit *FindCompileUnit(DICompileUnit Unit) {
2262 CompileUnit *DW_Unit = DW_CUs[Unit.getGV()];
2263 assert(DW_Unit && "Missing compile unit.");
2267 /// NewGlobalVariable - Add a new global variable DIE.
2269 DIE *NewGlobalVariable(GlobalVariableDesc *GVD) {
2270 // Get the compile unit context.
2271 CompileUnitDesc *UnitDesc =
2272 static_cast<CompileUnitDesc *>(GVD->getContext());
2273 CompileUnit *Unit = GetBaseCompileUnit();
2275 // Check for pre-existence.
2276 DIE *&Slot = Unit->getDieMapSlotFor(GVD);
2277 if (Slot) return Slot;
2279 // Get the global variable itself.
2280 GlobalVariable *GV = GVD->getGlobalVariable();
2282 const std::string &Name = GVD->getName();
2283 const std::string &FullName = GVD->getFullName();
2284 const std::string &LinkageName = GVD->getLinkageName();
2285 // Create the global's variable DIE.
2286 DIE *VariableDie = new DIE(DW_TAG_variable);
2287 AddString(VariableDie, DW_AT_name, DW_FORM_string, Name);
2288 if (!LinkageName.empty()) {
2289 AddString(VariableDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
2292 AddType(VariableDie, GVD->getType(), Unit);
2293 if (!GVD->isStatic())
2294 AddUInt(VariableDie, DW_AT_external, DW_FORM_flag, 1);
2296 // Add source line info if available.
2297 AddSourceLine(VariableDie, UnitDesc, GVD->getLine());
2300 DIEBlock *Block = new DIEBlock();
2301 AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
2302 AddObjectLabel(Block, 0, DW_FORM_udata, Asm->getGlobalLinkName(GV));
2303 AddBlock(VariableDie, DW_AT_location, 0, Block);
2308 // Add to context owner.
2309 Unit->getDie()->AddChild(VariableDie);
2311 // Expose as global.
2312 // FIXME - need to check external flag.
2313 Unit->AddGlobal(FullName, VariableDie);
2318 /// NewSubprogram - Add a new subprogram DIE.
2320 DIE *NewSubprogram(SubprogramDesc *SPD) {
2321 // Get the compile unit context.
2322 CompileUnitDesc *UnitDesc =
2323 static_cast<CompileUnitDesc *>(SPD->getContext());
2324 CompileUnit *Unit = GetBaseCompileUnit();
2326 // Check for pre-existence.
2327 DIE *&Slot = Unit->getDieMapSlotFor(SPD);
2328 if (Slot) return Slot;
2330 // Gather the details (simplify add attribute code.)
2331 const std::string &Name = SPD->getName();
2332 const std::string &FullName = SPD->getFullName();
2333 const std::string &LinkageName = SPD->getLinkageName();
2335 DIE *SubprogramDie = new DIE(DW_TAG_subprogram);
2336 AddString(SubprogramDie, DW_AT_name, DW_FORM_string, Name);
2337 if (!LinkageName.empty()) {
2338 AddString(SubprogramDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
2341 if (SPD->getType()) AddType(SubprogramDie, SPD->getType(), Unit);
2342 if (!SPD->isStatic())
2343 AddUInt(SubprogramDie, DW_AT_external, DW_FORM_flag, 1);
2344 AddUInt(SubprogramDie, DW_AT_prototyped, DW_FORM_flag, 1);
2346 // Add source line info if available.
2347 AddSourceLine(SubprogramDie, UnitDesc, SPD->getLine());
2350 Slot = SubprogramDie;
2352 // Add to context owner.
2353 Unit->getDie()->AddChild(SubprogramDie);
2355 // Expose as global.
2356 Unit->AddGlobal(FullName, SubprogramDie);
2358 return SubprogramDie;
2361 /// NewScopeVariable - Create a new scope variable.
2363 DIE *NewScopeVariable(DebugVariable *DV, CompileUnit *Unit) {
2364 // Get the descriptor.
2365 VariableDesc *VD = DV->getDesc();
2367 // Translate tag to proper Dwarf tag. The result variable is dropped for
2370 switch (VD->getTag()) {
2371 case DW_TAG_return_variable: return NULL;
2372 case DW_TAG_arg_variable: Tag = DW_TAG_formal_parameter; break;
2373 case DW_TAG_auto_variable: // fall thru
2374 default: Tag = DW_TAG_variable; break;
2377 // Define variable debug information entry.
2378 DIE *VariableDie = new DIE(Tag);
2379 AddString(VariableDie, DW_AT_name, DW_FORM_string, VD->getName());
2381 // Add source line info if available.
2382 AddSourceLine(VariableDie, VD->getFile(), VD->getLine());
2384 // Add variable type.
2385 AddType(VariableDie, VD->getType(), Unit);
2387 // Add variable address.
2388 MachineLocation Location;
2389 Location.set(RI->getFrameRegister(*MF),
2390 RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
2391 AddAddress(VariableDie, DW_AT_location, Location);
2396 /// ConstructScope - Construct the components of a scope.
2398 void ConstructScope(DebugScope *ParentScope,
2399 unsigned ParentStartID, unsigned ParentEndID,
2400 DIE *ParentDie, CompileUnit *Unit) {
2401 // Add variables to scope.
2402 std::vector<DebugVariable *> &Variables = ParentScope->getVariables();
2403 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2404 DIE *VariableDie = NewScopeVariable(Variables[i], Unit);
2405 if (VariableDie) ParentDie->AddChild(VariableDie);
2408 // Add nested scopes.
2409 std::vector<DebugScope *> &Scopes = ParentScope->getScopes();
2410 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
2411 // Define the Scope debug information entry.
2412 DebugScope *Scope = Scopes[j];
2413 // FIXME - Ignore inlined functions for the time being.
2414 if (!Scope->getParent()) continue;
2416 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
2417 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
2419 // Ignore empty scopes.
2420 if (StartID == EndID && StartID != 0) continue;
2421 if (Scope->getScopes().empty() && Scope->getVariables().empty()) continue;
2423 if (StartID == ParentStartID && EndID == ParentEndID) {
2424 // Just add stuff to the parent scope.
2425 ConstructScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
2427 DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
2429 // Add the scope bounds.
2431 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2432 DWLabel("label", StartID));
2434 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2435 DWLabel("func_begin", SubprogramCount));
2438 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2439 DWLabel("label", EndID));
2441 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2442 DWLabel("func_end", SubprogramCount));
2445 // Add the scope contents.
2446 ConstructScope(Scope, StartID, EndID, ScopeDie, Unit);
2447 ParentDie->AddChild(ScopeDie);
2452 /// ConstructRootScope - Construct the scope for the subprogram.
2454 void ConstructRootScope(DebugScope *RootScope) {
2455 // Exit if there is no root scope.
2456 if (!RootScope) return;
2458 // Get the subprogram debug information entry.
2459 SubprogramDesc *SPD = cast<SubprogramDesc>(RootScope->getDesc());
2461 // Get the compile unit context.
2462 CompileUnit *Unit = GetBaseCompileUnit();
2464 // Get the subprogram die.
2465 DIE *SPDie = Unit->getDieMapSlotFor(SPD);
2466 assert(SPDie && "Missing subprogram descriptor");
2468 // Add the function bounds.
2469 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2470 DWLabel("func_begin", SubprogramCount));
2471 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2472 DWLabel("func_end", SubprogramCount));
2473 MachineLocation Location(RI->getFrameRegister(*MF));
2474 AddAddress(SPDie, DW_AT_frame_base, Location);
2476 ConstructScope(RootScope, 0, 0, SPDie, Unit);
2479 /// ConstructDefaultScope - Construct a default scope for the subprogram.
2481 void ConstructDefaultScope(MachineFunction *MF) {
2482 // Find the correct subprogram descriptor.
2483 std::vector<SubprogramDesc *> Subprograms;
2484 MMI->getAnchoredDescriptors<SubprogramDesc>(*M, Subprograms);
2486 for (unsigned i = 0, N = Subprograms.size(); i < N; ++i) {
2487 SubprogramDesc *SPD = Subprograms[i];
2489 if (SPD->getName() == MF->getFunction()->getName()) {
2490 // Get the compile unit context.
2491 CompileUnit *Unit = GetBaseCompileUnit();
2493 // Get the subprogram die.
2494 DIE *SPDie = Unit->getDieMapSlotFor(SPD);
2495 assert(SPDie && "Missing subprogram descriptor");
2497 // Add the function bounds.
2498 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2499 DWLabel("func_begin", SubprogramCount));
2500 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2501 DWLabel("func_end", SubprogramCount));
2503 MachineLocation Location(RI->getFrameRegister(*MF));
2504 AddAddress(SPDie, DW_AT_frame_base, Location);
2509 // FIXME: This is causing an abort because C++ mangled names are compared
2510 // with their unmangled counterparts. See PR2885. Don't do this assert.
2511 assert(0 && "Couldn't find DIE for machine function!");
2515 /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
2516 /// tools to recognize the object file contains Dwarf information.
2517 void EmitInitial() {
2518 // Check to see if we already emitted intial headers.
2519 if (didInitial) return;
2522 // Dwarf sections base addresses.
2523 if (TAI->doesDwarfRequireFrameSection()) {
2524 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2525 EmitLabel("section_debug_frame", 0);
2527 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2528 EmitLabel("section_info", 0);
2529 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2530 EmitLabel("section_abbrev", 0);
2531 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2532 EmitLabel("section_aranges", 0);
2533 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2534 EmitLabel("section_macinfo", 0);
2535 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2536 EmitLabel("section_line", 0);
2537 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2538 EmitLabel("section_loc", 0);
2539 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2540 EmitLabel("section_pubnames", 0);
2541 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2542 EmitLabel("section_str", 0);
2543 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2544 EmitLabel("section_ranges", 0);
2546 Asm->SwitchToSection(TAI->getTextSection());
2547 EmitLabel("text_begin", 0);
2548 Asm->SwitchToSection(TAI->getDataSection());
2549 EmitLabel("data_begin", 0);
2552 /// EmitDIE - Recusively Emits a debug information entry.
2554 void EmitDIE(DIE *Die) {
2555 // Get the abbreviation for this DIE.
2556 unsigned AbbrevNumber = Die->getAbbrevNumber();
2557 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2561 // Emit the code (index) for the abbreviation.
2562 Asm->EmitULEB128Bytes(AbbrevNumber);
2565 Asm->EOL(std::string("Abbrev [" +
2566 utostr(AbbrevNumber) +
2567 "] 0x" + utohexstr(Die->getOffset()) +
2568 ":0x" + utohexstr(Die->getSize()) + " " +
2569 TagString(Abbrev->getTag())));
2573 SmallVector<DIEValue*, 32> &Values = Die->getValues();
2574 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2576 // Emit the DIE attribute values.
2577 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2578 unsigned Attr = AbbrevData[i].getAttribute();
2579 unsigned Form = AbbrevData[i].getForm();
2580 assert(Form && "Too many attributes for DIE (check abbreviation)");
2583 case DW_AT_sibling: {
2584 Asm->EmitInt32(Die->SiblingOffset());
2588 // Emit an attribute using the defined form.
2589 Values[i]->EmitValue(*this, Form);
2594 Asm->EOL(AttributeString(Attr));
2597 // Emit the DIE children if any.
2598 if (Abbrev->getChildrenFlag() == DW_CHILDREN_yes) {
2599 const std::vector<DIE *> &Children = Die->getChildren();
2601 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2602 EmitDIE(Children[j]);
2605 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2609 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
2611 unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
2612 // Get the children.
2613 const std::vector<DIE *> &Children = Die->getChildren();
2615 // If not last sibling and has children then add sibling offset attribute.
2616 if (!Last && !Children.empty()) Die->AddSiblingOffset();
2618 // Record the abbreviation.
2619 AssignAbbrevNumber(Die->getAbbrev());
2621 // Get the abbreviation for this DIE.
2622 unsigned AbbrevNumber = Die->getAbbrevNumber();
2623 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2626 Die->setOffset(Offset);
2628 // Start the size with the size of abbreviation code.
2629 Offset += TargetAsmInfo::getULEB128Size(AbbrevNumber);
2631 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2632 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2634 // Size the DIE attribute values.
2635 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2636 // Size attribute value.
2637 Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
2640 // Size the DIE children if any.
2641 if (!Children.empty()) {
2642 assert(Abbrev->getChildrenFlag() == DW_CHILDREN_yes &&
2643 "Children flag not set");
2645 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2646 Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
2649 // End of children marker.
2650 Offset += sizeof(int8_t);
2653 Die->setSize(Offset - Die->getOffset());
2657 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
2659 void SizeAndOffsets() {
2660 // Process base compile unit.
2661 CompileUnit *Unit = GetBaseCompileUnit();
2662 // Compute size of compile unit header
2663 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2664 sizeof(int16_t) + // DWARF version number
2665 sizeof(int32_t) + // Offset Into Abbrev. Section
2666 sizeof(int8_t); // Pointer Size (in bytes)
2667 SizeAndOffsetDie(Unit->getDie(), Offset, true);
2670 /// EmitDebugInfo - Emit the debug info section.
2672 void EmitDebugInfo() {
2673 // Start debug info section.
2674 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2676 CompileUnit *Unit = GetBaseCompileUnit();
2677 DIE *Die = Unit->getDie();
2678 // Emit the compile units header.
2679 EmitLabel("info_begin", Unit->getID());
2680 // Emit size of content not including length itself
2681 unsigned ContentSize = Die->getSize() +
2682 sizeof(int16_t) + // DWARF version number
2683 sizeof(int32_t) + // Offset Into Abbrev. Section
2684 sizeof(int8_t) + // Pointer Size (in bytes)
2685 sizeof(int32_t); // FIXME - extra pad for gdb bug.
2687 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2688 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2689 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2690 Asm->EOL("Offset Into Abbrev. Section");
2691 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2694 // FIXME - extra padding for gdb bug.
2695 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2696 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2697 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2698 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2699 EmitLabel("info_end", Unit->getID());
2704 /// EmitAbbreviations - Emit the abbreviation section.
2706 void EmitAbbreviations() const {
2707 // Check to see if it is worth the effort.
2708 if (!Abbreviations.empty()) {
2709 // Start the debug abbrev section.
2710 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2712 EmitLabel("abbrev_begin", 0);
2714 // For each abbrevation.
2715 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2716 // Get abbreviation data
2717 const DIEAbbrev *Abbrev = Abbreviations[i];
2719 // Emit the abbrevations code (base 1 index.)
2720 Asm->EmitULEB128Bytes(Abbrev->getNumber());
2721 Asm->EOL("Abbreviation Code");
2723 // Emit the abbreviations data.
2724 Abbrev->Emit(*this);
2729 // Mark end of abbreviations.
2730 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2732 EmitLabel("abbrev_end", 0);
2738 /// EmitEndOfLineMatrix - Emit the last address of the section and the end of
2739 /// the line matrix.
2741 void EmitEndOfLineMatrix(unsigned SectionEnd) {
2742 // Define last address of section.
2743 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2744 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2745 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2746 EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
2748 // Mark end of matrix.
2749 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2750 Asm->EmitULEB128Bytes(1); Asm->EOL();
2751 Asm->EmitInt8(1); Asm->EOL();
2754 /// EmitDebugLines - Emit source line information.
2756 void EmitDebugLines() {
2757 // If the target is using .loc/.file, the assembler will be emitting the
2758 // .debug_line table automatically.
2759 if (TAI->hasDotLocAndDotFile())
2762 // Minimum line delta, thus ranging from -10..(255-10).
2763 const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
2764 // Maximum line delta, thus ranging from -10..(255-10).
2765 const int MaxLineDelta = 255 + MinLineDelta;
2767 // Start the dwarf line section.
2768 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2770 // Construct the section header.
2772 EmitDifference("line_end", 0, "line_begin", 0, true);
2773 Asm->EOL("Length of Source Line Info");
2774 EmitLabel("line_begin", 0);
2776 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2778 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2779 Asm->EOL("Prolog Length");
2780 EmitLabel("line_prolog_begin", 0);
2782 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2784 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2786 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
2788 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2790 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
2792 // Line number standard opcode encodings argument count
2793 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2794 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2795 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2796 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2797 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2798 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2799 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2800 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2801 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2803 const UniqueVector<std::string> &Directories = MMI->getDirectories();
2804 const UniqueVector<SourceFileInfo> &SourceFiles = MMI->getSourceFiles();
2806 // Emit directories.
2807 for (unsigned DirectoryID = 1, NDID = Directories.size();
2808 DirectoryID <= NDID; ++DirectoryID) {
2809 Asm->EmitString(Directories[DirectoryID]); Asm->EOL("Directory");
2811 Asm->EmitInt8(0); Asm->EOL("End of directories");
2814 for (unsigned SourceID = 1, NSID = SourceFiles.size();
2815 SourceID <= NSID; ++SourceID) {
2816 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
2817 Asm->EmitString(SourceFile.getName());
2819 Asm->EmitULEB128Bytes(SourceFile.getDirectoryID());
2820 Asm->EOL("Directory #");
2821 Asm->EmitULEB128Bytes(0);
2822 Asm->EOL("Mod date");
2823 Asm->EmitULEB128Bytes(0);
2824 Asm->EOL("File size");
2826 Asm->EmitInt8(0); Asm->EOL("End of files");
2828 EmitLabel("line_prolog_end", 0);
2830 // A sequence for each text section.
2831 unsigned SecSrcLinesSize = SectionSourceLines.size();
2833 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
2834 // Isolate current sections line info.
2835 const std::vector<SourceLineInfo> &LineInfos = SectionSourceLines[j];
2838 const Section* S = SectionMap[j + 1];
2839 Asm->EOL(std::string("Section ") + S->getName());
2843 // Dwarf assumes we start with first line of first source file.
2844 unsigned Source = 1;
2847 // Construct rows of the address, source, line, column matrix.
2848 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2849 const SourceLineInfo &LineInfo = LineInfos[i];
2850 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2851 if (!LabelID) continue;
2853 unsigned SourceID = LineInfo.getSourceID();
2854 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
2855 unsigned DirectoryID = SourceFile.getDirectoryID();
2857 Asm->EOL(Directories[DirectoryID]
2858 + SourceFile.getName()
2860 + utostr_32(LineInfo.getLine()));
2864 // Define the line address.
2865 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2866 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2867 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2868 EmitReference("label", LabelID); Asm->EOL("Location label");
2870 // If change of source, then switch to the new source.
2871 if (Source != LineInfo.getSourceID()) {
2872 Source = LineInfo.getSourceID();
2873 Asm->EmitInt8(DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2874 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2877 // If change of line.
2878 if (Line != LineInfo.getLine()) {
2879 // Determine offset.
2880 int Offset = LineInfo.getLine() - Line;
2881 int Delta = Offset - MinLineDelta;
2884 Line = LineInfo.getLine();
2886 // If delta is small enough and in range...
2887 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2888 // ... then use fast opcode.
2889 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2891 // ... otherwise use long hand.
2892 Asm->EmitInt8(DW_LNS_advance_line); Asm->EOL("DW_LNS_advance_line");
2893 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2894 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2897 // Copy the previous row (different address or source)
2898 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2902 EmitEndOfLineMatrix(j + 1);
2905 if (SecSrcLinesSize == 0)
2906 // Because we're emitting a debug_line section, we still need a line
2907 // table. The linker and friends expect it to exist. If there's nothing to
2908 // put into it, emit an empty table.
2909 EmitEndOfLineMatrix(1);
2911 EmitLabel("line_end", 0);
2916 /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
2918 void EmitCommonDebugFrame() {
2919 if (!TAI->doesDwarfRequireFrameSection())
2923 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2924 TargetFrameInfo::StackGrowsUp ?
2925 TD->getPointerSize() : -TD->getPointerSize();
2927 // Start the dwarf frame section.
2928 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2930 EmitLabel("debug_frame_common", 0);
2931 EmitDifference("debug_frame_common_end", 0,
2932 "debug_frame_common_begin", 0, true);
2933 Asm->EOL("Length of Common Information Entry");
2935 EmitLabel("debug_frame_common_begin", 0);
2936 Asm->EmitInt32((int)DW_CIE_ID);
2937 Asm->EOL("CIE Identifier Tag");
2938 Asm->EmitInt8(DW_CIE_VERSION);
2939 Asm->EOL("CIE Version");
2940 Asm->EmitString("");
2941 Asm->EOL("CIE Augmentation");
2942 Asm->EmitULEB128Bytes(1);
2943 Asm->EOL("CIE Code Alignment Factor");
2944 Asm->EmitSLEB128Bytes(stackGrowth);
2945 Asm->EOL("CIE Data Alignment Factor");
2946 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
2947 Asm->EOL("CIE RA Column");
2949 std::vector<MachineMove> Moves;
2950 RI->getInitialFrameState(Moves);
2952 EmitFrameMoves(NULL, 0, Moves, false);
2954 Asm->EmitAlignment(2, 0, 0, false);
2955 EmitLabel("debug_frame_common_end", 0);
2960 /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2962 void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
2963 if (!TAI->doesDwarfRequireFrameSection())
2966 // Start the dwarf frame section.
2967 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2969 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2970 "debug_frame_begin", DebugFrameInfo.Number, true);
2971 Asm->EOL("Length of Frame Information Entry");
2973 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2975 EmitSectionOffset("debug_frame_common", "section_debug_frame",
2977 Asm->EOL("FDE CIE offset");
2979 EmitReference("func_begin", DebugFrameInfo.Number);
2980 Asm->EOL("FDE initial location");
2981 EmitDifference("func_end", DebugFrameInfo.Number,
2982 "func_begin", DebugFrameInfo.Number);
2983 Asm->EOL("FDE address range");
2985 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves, false);
2987 Asm->EmitAlignment(2, 0, 0, false);
2988 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
2993 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
2995 void EmitDebugPubNames() {
2996 // Start the dwarf pubnames section.
2997 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2999 CompileUnit *Unit = GetBaseCompileUnit();
3001 EmitDifference("pubnames_end", Unit->getID(),
3002 "pubnames_begin", Unit->getID(), true);
3003 Asm->EOL("Length of Public Names Info");
3005 EmitLabel("pubnames_begin", Unit->getID());
3007 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF Version");
3009 EmitSectionOffset("info_begin", "section_info",
3010 Unit->getID(), 0, true, false);
3011 Asm->EOL("Offset of Compilation Unit Info");
3013 EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(),true);
3014 Asm->EOL("Compilation Unit Length");
3016 std::map<std::string, DIE *> &Globals = Unit->getGlobals();
3018 for (std::map<std::string, DIE *>::iterator GI = Globals.begin(),
3021 const std::string &Name = GI->first;
3022 DIE * Entity = GI->second;
3024 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
3025 Asm->EmitString(Name); Asm->EOL("External Name");
3028 Asm->EmitInt32(0); Asm->EOL("End Mark");
3029 EmitLabel("pubnames_end", Unit->getID());
3034 /// EmitDebugStr - Emit visible names into a debug str section.
3036 void EmitDebugStr() {
3037 // Check to see if it is worth the effort.
3038 if (!StringPool.empty()) {
3039 // Start the dwarf str section.
3040 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
3042 // For each of strings in the string pool.
3043 for (unsigned StringID = 1, N = StringPool.size();
3044 StringID <= N; ++StringID) {
3045 // Emit a label for reference from debug information entries.
3046 EmitLabel("string", StringID);
3047 // Emit the string itself.
3048 const std::string &String = StringPool[StringID];
3049 Asm->EmitString(String); Asm->EOL();
3056 /// EmitDebugLoc - Emit visible names into a debug loc section.
3058 void EmitDebugLoc() {
3059 // Start the dwarf loc section.
3060 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
3065 /// EmitDebugARanges - Emit visible names into a debug aranges section.
3067 void EmitDebugARanges() {
3068 // Start the dwarf aranges section.
3069 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
3073 CompileUnit *Unit = GetBaseCompileUnit();
3075 // Don't include size of length
3076 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
3078 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("Dwarf Version");
3080 EmitReference("info_begin", Unit->getID());
3081 Asm->EOL("Offset of Compilation Unit Info");
3083 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
3085 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
3087 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
3088 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
3091 EmitReference("text_begin", 0); Asm->EOL("Address");
3092 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
3094 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
3095 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
3101 /// EmitDebugRanges - Emit visible names into a debug ranges section.
3103 void EmitDebugRanges() {
3104 // Start the dwarf ranges section.
3105 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
3110 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
3112 void EmitDebugMacInfo() {
3113 // Start the dwarf macinfo section.
3114 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
3119 /// ConstructCompileUnits - Create a compile unit DIEs.
3120 void ConstructCompileUnits() {
3121 std::string CUName = "llvm.dbg.compile_units";
3122 std::vector<GlobalVariable*> Result;
3123 getGlobalVariablesUsing(*M, CUName, Result);
3124 for (std::vector<GlobalVariable *>::iterator RI = Result.begin(),
3125 RE = Result.end(); RI != RE; ++RI) {
3126 DICompileUnit *DIUnit = new DICompileUnit(*RI);
3127 unsigned DID = Directories.insert(DIUnit->getDirectory());
3128 unsigned ID = SrcFiles.insert(SrcFileInfo(DID,
3129 DIUnit->getFilename()));
3131 DIE *Die = new DIE(DW_TAG_compile_unit);
3132 AddSectionOffset(Die, DW_AT_stmt_list, DW_FORM_data4,
3133 DWLabel("section_line", 0), DWLabel("section_line", 0),
3135 AddString(Die, DW_AT_producer, DW_FORM_string, DIUnit->getProducer());
3136 AddUInt(Die, DW_AT_language, DW_FORM_data1, DIUnit->getLanguage());
3137 AddString(Die, DW_AT_name, DW_FORM_string, DIUnit->getFilename());
3138 if (!DIUnit->getDirectory().empty())
3139 AddString(Die, DW_AT_comp_dir, DW_FORM_string, DIUnit->getDirectory());
3141 CompileUnit *Unit = new CompileUnit(ID, Die);
3142 DW_CUs[DIUnit->getGV()] = Unit;
3146 /// ConstructCompileUnitDIEs - Create a compile unit DIE for each source and
3148 void ConstructCompileUnitDIEs() {
3149 const UniqueVector<CompileUnitDesc *> CUW = MMI->getCompileUnits();
3151 for (unsigned i = 1, N = CUW.size(); i <= N; ++i) {
3152 unsigned ID = MMI->RecordSource(CUW[i]);
3153 CompileUnit *Unit = NewCompileUnit(CUW[i], ID);
3154 CompileUnits.push_back(Unit);
3158 /// ConstructGlobalVariableDIEs - Create DIEs for each of the externally
3159 /// visible global variables.
3160 void ConstructGlobalVariableDIEs() {
3161 std::string GVName = "llvm.dbg.global_variables";
3162 std::vector<GlobalVariable*> Result;
3163 getGlobalVariablesUsing(*M, GVName, Result);
3164 for (std::vector<GlobalVariable *>::iterator GVI = Result.begin(),
3165 GVE = Result.end(); GVI != GVE; ++GVI) {
3166 DIGlobalVariable *DI_GV = new DIGlobalVariable(*GVI);
3167 CompileUnit *DW_Unit = FindCompileUnit(DI_GV->getCompileUnit());
3169 // Check for pre-existence.
3170 DIE *&Slot = DW_Unit->getDieMapSlotFor(DI_GV->getGV());
3173 DIE *VariableDie = new DIE(DW_TAG_variable);
3174 AddString(VariableDie, DW_AT_name, DW_FORM_string, DI_GV->getName());
3175 const std::string &LinkageName = DI_GV->getLinkageName();
3176 if (!LinkageName.empty())
3177 AddString(VariableDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
3179 AddType(DW_Unit, VariableDie, DI_GV->getType());
3181 if (!DI_GV->isLocalToUnit())
3182 AddUInt(VariableDie, DW_AT_external, DW_FORM_flag, 1);
3184 // Add source line info, if available.
3185 AddSourceLine(VariableDie, DI_GV);
3188 DIEBlock *Block = new DIEBlock();
3189 AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
3190 AddObjectLabel(Block, 0, DW_FORM_udata,
3191 Asm->getGlobalLinkName(DI_GV->getGV()));
3192 AddBlock(VariableDie, DW_AT_location, 0, Block);
3197 //Add to context owner.
3198 DW_Unit->getDie()->AddChild(VariableDie);
3200 //Expose as global. FIXME - need to check external flag.
3201 DW_Unit->AddGlobal(DI_GV->getName(), VariableDie);
3205 /// ConstructGlobalDIEs - Create DIEs for each of the externally visible
3206 /// global variables.
3207 void ConstructGlobalDIEs() {
3208 std::vector<GlobalVariableDesc *> GlobalVariables;
3209 MMI->getAnchoredDescriptors<GlobalVariableDesc>(*M, GlobalVariables);
3211 for (unsigned i = 0, N = GlobalVariables.size(); i < N; ++i) {
3212 GlobalVariableDesc *GVD = GlobalVariables[i];
3213 NewGlobalVariable(GVD);
3217 /// ConstructSubprograms - Create DIEs for each of the externally visible
3219 void ConstructSubprograms() {
3221 std::string SPName = "llvm.dbg.subprograms";
3222 std::vector<GlobalVariable*> Result;
3223 getGlobalVariablesUsing(*M, SPName, Result);
3224 for (std::vector<GlobalVariable *>::iterator RI = Result.begin(),
3225 RE = Result.end(); RI != RE; ++RI) {
3227 DISubprogram *SP = new DISubprogram(*RI);
3228 CompileUnit *Unit = FindCompileUnit(SP->getCompileUnit());
3230 // Check for pre-existence.
3231 DIE *&Slot = Unit->getDieMapSlotFor(SP->getGV());
3234 DIE *SubprogramDie = new DIE(DW_TAG_subprogram);
3235 AddString(SubprogramDie, DW_AT_name, DW_FORM_string, SP->getName());
3236 const std::string &LinkageName = SP->getLinkageName();
3237 if (!LinkageName.empty())
3238 AddString(SubprogramDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
3240 DIType SPTy = SP->getType();
3241 AddType(Unit, SubprogramDie, SPTy);
3242 if (!SP->isLocalToUnit())
3243 AddUInt(SubprogramDie, DW_AT_external, DW_FORM_flag, 1);
3244 AddUInt(SubprogramDie, DW_AT_prototyped, DW_FORM_flag, 1);
3246 AddSourceLine(SubprogramDie, SP);
3248 Slot = SubprogramDie;
3249 //Add to context owner.
3250 Unit->getDie()->AddChild(SubprogramDie);
3252 Unit->AddGlobal(SP->getName(), SubprogramDie);
3256 /// ConstructSubprogramDIEs - Create DIEs for each of the externally visible
3258 void ConstructSubprogramDIEs() {
3259 std::vector<SubprogramDesc *> Subprograms;
3260 MMI->getAnchoredDescriptors<SubprogramDesc>(*M, Subprograms);
3262 for (unsigned i = 0, N = Subprograms.size(); i < N; ++i) {
3263 SubprogramDesc *SPD = Subprograms[i];
3269 //===--------------------------------------------------------------------===//
3270 // Main entry points.
3272 DwarfDebug(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
3273 : Dwarf(OS, A, T, "dbg")
3275 , AbbreviationsSet(InitAbbreviationsSetSize)
3277 , ValuesSet(InitValuesSetSize)
3282 , SectionSourceLines()
3287 virtual ~DwarfDebug() {
3288 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i)
3289 delete CompileUnits[i];
3290 for (unsigned j = 0, M = Values.size(); j < M; ++j)
3294 /// SetDebugInfo - Create global DIEs and emit initial debug info sections.
3295 /// This is inovked by the target AsmPrinter.
3296 void SetDebugInfo() {
3297 // FIXME - Check if the module has debug info or not.
3298 // Create all the compile unit DIEs.
3299 ConstructCompileUnits();
3301 // Create DIEs for each of the externally visible global variables.
3302 ConstructGlobalVariableDIEs();
3304 // Create DIEs for each of the externally visible subprograms.
3305 ConstructSubprograms();
3307 // Prime section data.
3308 SectionMap.insert(TAI->getTextSection());
3310 // Print out .file directives to specify files for .loc directives. These
3311 // are printed out early so that they precede any .loc directives.
3312 if (TAI->hasDotLocAndDotFile()) {
3313 for (unsigned i = 1, e = SrcFiles.size(); i <= e; ++i) {
3314 sys::Path FullPath(Directories[SrcFiles[i].getDirectoryID()]);
3315 bool AppendOk = FullPath.appendComponent(SrcFiles[i].getName());
3316 assert(AppendOk && "Could not append filename to directory!");
3318 Asm->EmitFile(i, FullPath.toString());
3323 // Emit initial sections
3327 /// SetModuleInfo - Set machine module information when it's known that pass
3328 /// manager has created it. Set by the target AsmPrinter.
3329 void SetModuleInfo(MachineModuleInfo *mmi) {
3330 // Make sure initial declarations are made.
3331 if (!MMI && mmi->hasDebugInfo()) {
3335 // Create all the compile unit DIEs.
3336 ConstructCompileUnitDIEs();
3338 // Create DIEs for each of the externally visible global variables.
3339 ConstructGlobalDIEs();
3341 // Create DIEs for each of the externally visible subprograms.
3342 ConstructSubprogramDIEs();
3344 // Prime section data.
3345 SectionMap.insert(TAI->getTextSection());
3347 // Print out .file directives to specify files for .loc directives. These
3348 // are printed out early so that they precede any .loc directives.
3349 if (TAI->hasDotLocAndDotFile()) {
3350 const UniqueVector<SourceFileInfo> &SourceFiles = MMI->getSourceFiles();
3351 const UniqueVector<std::string> &Directories = MMI->getDirectories();
3352 for (unsigned i = 1, e = SourceFiles.size(); i <= e; ++i) {
3353 sys::Path FullPath(Directories[SourceFiles[i].getDirectoryID()]);
3354 bool AppendOk = FullPath.appendComponent(SourceFiles[i].getName());
3355 assert(AppendOk && "Could not append filename to directory!");
3357 Asm->EmitFile(i, FullPath.toString());
3362 // Emit initial sections
3367 /// BeginModule - Emit all Dwarf sections that should come prior to the
3369 void BeginModule(Module *M) {
3373 /// EndModule - Emit all Dwarf sections that should come after the content.
3376 if (!ShouldEmitDwarf()) return;
3378 // Standard sections final addresses.
3379 Asm->SwitchToSection(TAI->getTextSection());
3380 EmitLabel("text_end", 0);
3381 Asm->SwitchToSection(TAI->getDataSection());
3382 EmitLabel("data_end", 0);
3384 // End text sections.
3385 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
3386 Asm->SwitchToSection(SectionMap[i]);
3387 EmitLabel("section_end", i);
3390 // Emit common frame information.
3391 EmitCommonDebugFrame();
3393 // Emit function debug frame information
3394 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
3395 E = DebugFrames.end(); I != E; ++I)
3396 EmitFunctionDebugFrame(*I);
3398 // Compute DIE offsets and sizes.
3401 // Emit all the DIEs into a debug info section
3404 // Corresponding abbreviations into a abbrev section.
3405 EmitAbbreviations();
3407 // Emit source line correspondence into a debug line section.
3410 // Emit info into a debug pubnames section.
3411 EmitDebugPubNames();
3413 // Emit info into a debug str section.
3416 // Emit info into a debug loc section.
3419 // Emit info into a debug aranges section.
3422 // Emit info into a debug ranges section.
3425 // Emit info into a debug macinfo section.
3429 /// BeginFunction - Gather pre-function debug information. Assumes being
3430 /// emitted immediately after the function entry point.
3431 void BeginFunction(MachineFunction *MF) {
3434 if (!ShouldEmitDwarf()) return;
3436 // Begin accumulating function debug information.
3437 MMI->BeginFunction(MF);
3439 // Assumes in correct section after the entry point.
3440 EmitLabel("func_begin", ++SubprogramCount);
3442 // Emit label for the implicitly defined dbg.stoppoint at the start of
3444 const std::vector<SourceLineInfo> &LineInfos = MMI->getSourceLines();
3445 if (!LineInfos.empty()) {
3446 const SourceLineInfo &LineInfo = LineInfos[0];
3447 Asm->printLabel(LineInfo.getLabelID());
3451 /// EndFunction - Gather and emit post-function debug information.
3453 void EndFunction(MachineFunction *MF) {
3454 if (!ShouldEmitDwarf()) return;
3456 // Define end label for subprogram.
3457 EmitLabel("func_end", SubprogramCount);
3459 // Get function line info.
3460 const std::vector<SourceLineInfo> &LineInfos = MMI->getSourceLines();
3462 if (!LineInfos.empty()) {
3463 // Get section line info.
3464 unsigned ID = SectionMap.insert(Asm->CurrentSection_);
3465 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
3466 std::vector<SourceLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
3467 // Append the function info to section info.
3468 SectionLineInfos.insert(SectionLineInfos.end(),
3469 LineInfos.begin(), LineInfos.end());
3472 // Construct scopes for subprogram.
3473 if (MMI->getRootScope())
3474 ConstructRootScope(MMI->getRootScope());
3476 // FIXME: This is wrong. We are essentially getting past a problem with
3477 // debug information not being able to handle unreachable blocks that have
3478 // debug information in them. In particular, those unreachable blocks that
3479 // have "region end" info in them. That situation results in the "root
3480 // scope" not being created. If that's the case, then emit a "default"
3481 // scope, i.e., one that encompasses the whole function. This isn't
3482 // desirable. And a better way of handling this (and all of the debugging
3483 // information) needs to be explored.
3484 ConstructDefaultScope(MF);
3486 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
3487 MMI->getFrameMoves()));
3491 //===----------------------------------------------------------------------===//
3492 /// DwarfException - Emits Dwarf exception handling directives.
3494 class DwarfException : public Dwarf {
3497 struct FunctionEHFrameInfo {
3500 unsigned PersonalityIndex;
3502 bool hasLandingPads;
3503 std::vector<MachineMove> Moves;
3504 const Function * function;
3506 FunctionEHFrameInfo(const std::string &FN, unsigned Num, unsigned P,
3508 const std::vector<MachineMove> &M,
3510 FnName(FN), Number(Num), PersonalityIndex(P),
3511 hasCalls(hC), hasLandingPads(hL), Moves(M), function (f) { }
3514 std::vector<FunctionEHFrameInfo> EHFrames;
3516 /// shouldEmitTable - Per-function flag to indicate if EH tables should
3518 bool shouldEmitTable;
3520 /// shouldEmitMoves - Per-function flag to indicate if frame moves info
3521 /// should be emitted.
3522 bool shouldEmitMoves;
3524 /// shouldEmitTableModule - Per-module flag to indicate if EH tables
3525 /// should be emitted.
3526 bool shouldEmitTableModule;
3528 /// shouldEmitFrameModule - Per-module flag to indicate if frame moves
3529 /// should be emitted.
3530 bool shouldEmitMovesModule;
3532 /// EmitCommonEHFrame - Emit the common eh unwind frame.
3534 void EmitCommonEHFrame(const Function *Personality, unsigned Index) {
3535 // Size and sign of stack growth.
3537 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3538 TargetFrameInfo::StackGrowsUp ?
3539 TD->getPointerSize() : -TD->getPointerSize();
3541 // Begin eh frame section.
3542 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3544 if (!TAI->doesRequireNonLocalEHFrameLabel())
3545 O << TAI->getEHGlobalPrefix();
3546 O << "EH_frame" << Index << ":\n";
3547 EmitLabel("section_eh_frame", Index);
3549 // Define base labels.
3550 EmitLabel("eh_frame_common", Index);
3552 // Define the eh frame length.
3553 EmitDifference("eh_frame_common_end", Index,
3554 "eh_frame_common_begin", Index, true);
3555 Asm->EOL("Length of Common Information Entry");
3558 EmitLabel("eh_frame_common_begin", Index);
3559 Asm->EmitInt32((int)0);
3560 Asm->EOL("CIE Identifier Tag");
3561 Asm->EmitInt8(DW_CIE_VERSION);
3562 Asm->EOL("CIE Version");
3564 // The personality presence indicates that language specific information
3565 // will show up in the eh frame.
3566 Asm->EmitString(Personality ? "zPLR" : "zR");
3567 Asm->EOL("CIE Augmentation");
3569 // Round out reader.
3570 Asm->EmitULEB128Bytes(1);
3571 Asm->EOL("CIE Code Alignment Factor");
3572 Asm->EmitSLEB128Bytes(stackGrowth);
3573 Asm->EOL("CIE Data Alignment Factor");
3574 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), true));
3575 Asm->EOL("CIE Return Address Column");
3577 // If there is a personality, we need to indicate the functions location.
3579 Asm->EmitULEB128Bytes(7);
3580 Asm->EOL("Augmentation Size");
3582 if (TAI->getNeedsIndirectEncoding()) {
3583 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4 | DW_EH_PE_indirect);
3584 Asm->EOL("Personality (pcrel sdata4 indirect)");
3586 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3587 Asm->EOL("Personality (pcrel sdata4)");
3590 PrintRelDirective(true);
3591 O << TAI->getPersonalityPrefix();
3592 Asm->EmitExternalGlobal((const GlobalVariable *)(Personality));
3593 O << TAI->getPersonalitySuffix();
3594 if (strcmp(TAI->getPersonalitySuffix(), "+4@GOTPCREL"))
3595 O << "-" << TAI->getPCSymbol();
3596 Asm->EOL("Personality");
3598 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3599 Asm->EOL("LSDA Encoding (pcrel sdata4)");
3601 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3602 Asm->EOL("FDE Encoding (pcrel sdata4)");
3604 Asm->EmitULEB128Bytes(1);
3605 Asm->EOL("Augmentation Size");
3607 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3608 Asm->EOL("FDE Encoding (pcrel sdata4)");
3611 // Indicate locations of general callee saved registers in frame.
3612 std::vector<MachineMove> Moves;
3613 RI->getInitialFrameState(Moves);
3614 EmitFrameMoves(NULL, 0, Moves, true);
3616 // On Darwin the linker honors the alignment of eh_frame, which means it
3617 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3618 // you get holes which confuse readers of eh_frame.
3619 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
3621 EmitLabel("eh_frame_common_end", Index);
3626 /// EmitEHFrame - Emit function exception frame information.
3628 void EmitEHFrame(const FunctionEHFrameInfo &EHFrameInfo) {
3629 Function::LinkageTypes linkage = EHFrameInfo.function->getLinkage();
3631 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3633 // Externally visible entry into the functions eh frame info.
3634 // If the corresponding function is static, this should not be
3635 // externally visible.
3636 if (linkage != Function::InternalLinkage) {
3637 if (const char *GlobalEHDirective = TAI->getGlobalEHDirective())
3638 O << GlobalEHDirective << EHFrameInfo.FnName << "\n";
3641 // If corresponding function is weak definition, this should be too.
3642 if ((linkage == Function::WeakLinkage ||
3643 linkage == Function::LinkOnceLinkage) &&
3644 TAI->getWeakDefDirective())
3645 O << TAI->getWeakDefDirective() << EHFrameInfo.FnName << "\n";
3647 // If there are no calls then you can't unwind. This may mean we can
3648 // omit the EH Frame, but some environments do not handle weak absolute
3650 // If UnwindTablesMandatory is set we cannot do this optimization; the
3651 // unwind info is to be available for non-EH uses.
3652 if (!EHFrameInfo.hasCalls &&
3653 !UnwindTablesMandatory &&
3654 ((linkage != Function::WeakLinkage &&
3655 linkage != Function::LinkOnceLinkage) ||
3656 !TAI->getWeakDefDirective() ||
3657 TAI->getSupportsWeakOmittedEHFrame()))
3659 O << EHFrameInfo.FnName << " = 0\n";
3660 // This name has no connection to the function, so it might get
3661 // dead-stripped when the function is not, erroneously. Prohibit
3662 // dead-stripping unconditionally.
3663 if (const char *UsedDirective = TAI->getUsedDirective())
3664 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3666 O << EHFrameInfo.FnName << ":\n";
3669 EmitDifference("eh_frame_end", EHFrameInfo.Number,
3670 "eh_frame_begin", EHFrameInfo.Number, true);
3671 Asm->EOL("Length of Frame Information Entry");
3673 EmitLabel("eh_frame_begin", EHFrameInfo.Number);
3675 if (TAI->doesRequireNonLocalEHFrameLabel()) {
3676 PrintRelDirective(true, true);
3677 PrintLabelName("eh_frame_begin", EHFrameInfo.Number);
3679 if (!TAI->isAbsoluteEHSectionOffsets())
3680 O << "-EH_frame" << EHFrameInfo.PersonalityIndex;
3682 EmitSectionOffset("eh_frame_begin", "eh_frame_common",
3683 EHFrameInfo.Number, EHFrameInfo.PersonalityIndex,
3687 Asm->EOL("FDE CIE offset");
3689 EmitReference("eh_func_begin", EHFrameInfo.Number, true, true);
3690 Asm->EOL("FDE initial location");
3691 EmitDifference("eh_func_end", EHFrameInfo.Number,
3692 "eh_func_begin", EHFrameInfo.Number, true);
3693 Asm->EOL("FDE address range");
3695 // If there is a personality and landing pads then point to the language
3696 // specific data area in the exception table.
3697 if (EHFrameInfo.PersonalityIndex) {
3698 Asm->EmitULEB128Bytes(4);
3699 Asm->EOL("Augmentation size");
3701 if (EHFrameInfo.hasLandingPads)
3702 EmitReference("exception", EHFrameInfo.Number, true, true);
3704 Asm->EmitInt32((int)0);
3705 Asm->EOL("Language Specific Data Area");
3707 Asm->EmitULEB128Bytes(0);
3708 Asm->EOL("Augmentation size");
3711 // Indicate locations of function specific callee saved registers in
3713 EmitFrameMoves("eh_func_begin", EHFrameInfo.Number, EHFrameInfo.Moves, true);
3715 // On Darwin the linker honors the alignment of eh_frame, which means it
3716 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3717 // you get holes which confuse readers of eh_frame.
3718 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
3720 EmitLabel("eh_frame_end", EHFrameInfo.Number);
3722 // If the function is marked used, this table should be also. We cannot
3723 // make the mark unconditional in this case, since retaining the table
3724 // also retains the function in this case, and there is code around
3725 // that depends on unused functions (calling undefined externals) being
3726 // dead-stripped to link correctly. Yes, there really is.
3727 if (MMI->getUsedFunctions().count(EHFrameInfo.function))
3728 if (const char *UsedDirective = TAI->getUsedDirective())
3729 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3733 /// EmitExceptionTable - Emit landing pads and actions.
3735 /// The general organization of the table is complex, but the basic concepts
3736 /// are easy. First there is a header which describes the location and
3737 /// organization of the three components that follow.
3738 /// 1. The landing pad site information describes the range of code covered
3739 /// by the try. In our case it's an accumulation of the ranges covered
3740 /// by the invokes in the try. There is also a reference to the landing
3741 /// pad that handles the exception once processed. Finally an index into
3742 /// the actions table.
3743 /// 2. The action table, in our case, is composed of pairs of type ids
3744 /// and next action offset. Starting with the action index from the
3745 /// landing pad site, each type Id is checked for a match to the current
3746 /// exception. If it matches then the exception and type id are passed
3747 /// on to the landing pad. Otherwise the next action is looked up. This
3748 /// chain is terminated with a next action of zero. If no type id is
3749 /// found the the frame is unwound and handling continues.
3750 /// 3. Type id table contains references to all the C++ typeinfo for all
3751 /// catches in the function. This tables is reversed indexed base 1.
3753 /// SharedTypeIds - How many leading type ids two landing pads have in common.
3754 static unsigned SharedTypeIds(const LandingPadInfo *L,
3755 const LandingPadInfo *R) {
3756 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3757 unsigned LSize = LIds.size(), RSize = RIds.size();
3758 unsigned MinSize = LSize < RSize ? LSize : RSize;
3761 for (; Count != MinSize; ++Count)
3762 if (LIds[Count] != RIds[Count])
3768 /// PadLT - Order landing pads lexicographically by type id.
3769 static bool PadLT(const LandingPadInfo *L, const LandingPadInfo *R) {
3770 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3771 unsigned LSize = LIds.size(), RSize = RIds.size();
3772 unsigned MinSize = LSize < RSize ? LSize : RSize;
3774 for (unsigned i = 0; i != MinSize; ++i)
3775 if (LIds[i] != RIds[i])
3776 return LIds[i] < RIds[i];
3778 return LSize < RSize;
3782 static inline unsigned getEmptyKey() { return -1U; }
3783 static inline unsigned getTombstoneKey() { return -2U; }
3784 static unsigned getHashValue(const unsigned &Key) { return Key; }
3785 static bool isEqual(unsigned LHS, unsigned RHS) { return LHS == RHS; }
3786 static bool isPod() { return true; }
3789 /// ActionEntry - Structure describing an entry in the actions table.
3790 struct ActionEntry {
3791 int ValueForTypeID; // The value to write - may not be equal to the type id.
3793 struct ActionEntry *Previous;
3796 /// PadRange - Structure holding a try-range and the associated landing pad.
3798 // The index of the landing pad.
3800 // The index of the begin and end labels in the landing pad's label lists.
3801 unsigned RangeIndex;
3804 typedef DenseMap<unsigned, PadRange, KeyInfo> RangeMapType;
3806 /// CallSiteEntry - Structure describing an entry in the call-site table.
3807 struct CallSiteEntry {
3808 // The 'try-range' is BeginLabel .. EndLabel.
3809 unsigned BeginLabel; // zero indicates the start of the function.
3810 unsigned EndLabel; // zero indicates the end of the function.
3811 // The landing pad starts at PadLabel.
3812 unsigned PadLabel; // zero indicates that there is no landing pad.
3816 void EmitExceptionTable() {
3817 const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
3818 const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
3819 const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
3820 if (PadInfos.empty()) return;
3822 // Sort the landing pads in order of their type ids. This is used to fold
3823 // duplicate actions.
3824 SmallVector<const LandingPadInfo *, 64> LandingPads;
3825 LandingPads.reserve(PadInfos.size());
3826 for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
3827 LandingPads.push_back(&PadInfos[i]);
3828 std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
3830 // Negative type ids index into FilterIds, positive type ids index into
3831 // TypeInfos. The value written for a positive type id is just the type
3832 // id itself. For a negative type id, however, the value written is the
3833 // (negative) byte offset of the corresponding FilterIds entry. The byte
3834 // offset is usually equal to the type id, because the FilterIds entries
3835 // are written using a variable width encoding which outputs one byte per
3836 // entry as long as the value written is not too large, but can differ.
3837 // This kind of complication does not occur for positive type ids because
3838 // type infos are output using a fixed width encoding.
3839 // FilterOffsets[i] holds the byte offset corresponding to FilterIds[i].
3840 SmallVector<int, 16> FilterOffsets;
3841 FilterOffsets.reserve(FilterIds.size());
3843 for(std::vector<unsigned>::const_iterator I = FilterIds.begin(),
3844 E = FilterIds.end(); I != E; ++I) {
3845 FilterOffsets.push_back(Offset);
3846 Offset -= TargetAsmInfo::getULEB128Size(*I);
3849 // Compute the actions table and gather the first action index for each
3850 // landing pad site.
3851 SmallVector<ActionEntry, 32> Actions;
3852 SmallVector<unsigned, 64> FirstActions;
3853 FirstActions.reserve(LandingPads.size());
3855 int FirstAction = 0;
3856 unsigned SizeActions = 0;
3857 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3858 const LandingPadInfo *LP = LandingPads[i];
3859 const std::vector<int> &TypeIds = LP->TypeIds;
3860 const unsigned NumShared = i ? SharedTypeIds(LP, LandingPads[i-1]) : 0;
3861 unsigned SizeSiteActions = 0;
3863 if (NumShared < TypeIds.size()) {
3864 unsigned SizeAction = 0;
3865 ActionEntry *PrevAction = 0;
3868 const unsigned SizePrevIds = LandingPads[i-1]->TypeIds.size();
3869 assert(Actions.size());
3870 PrevAction = &Actions.back();
3871 SizeAction = TargetAsmInfo::getSLEB128Size(PrevAction->NextAction) +
3872 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
3873 for (unsigned j = NumShared; j != SizePrevIds; ++j) {
3875 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
3876 SizeAction += -PrevAction->NextAction;
3877 PrevAction = PrevAction->Previous;
3881 // Compute the actions.
3882 for (unsigned I = NumShared, M = TypeIds.size(); I != M; ++I) {
3883 int TypeID = TypeIds[I];
3884 assert(-1-TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
3885 int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
3886 unsigned SizeTypeID = TargetAsmInfo::getSLEB128Size(ValueForTypeID);
3888 int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
3889 SizeAction = SizeTypeID + TargetAsmInfo::getSLEB128Size(NextAction);
3890 SizeSiteActions += SizeAction;
3892 ActionEntry Action = {ValueForTypeID, NextAction, PrevAction};
3893 Actions.push_back(Action);
3895 PrevAction = &Actions.back();
3898 // Record the first action of the landing pad site.
3899 FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
3900 } // else identical - re-use previous FirstAction
3902 FirstActions.push_back(FirstAction);
3904 // Compute this sites contribution to size.
3905 SizeActions += SizeSiteActions;
3908 // Compute the call-site table. The entry for an invoke has a try-range
3909 // containing the call, a non-zero landing pad and an appropriate action.
3910 // The entry for an ordinary call has a try-range containing the call and
3911 // zero for the landing pad and the action. Calls marked 'nounwind' have
3912 // no entry and must not be contained in the try-range of any entry - they
3913 // form gaps in the table. Entries must be ordered by try-range address.
3914 SmallVector<CallSiteEntry, 64> CallSites;
3916 RangeMapType PadMap;
3917 // Invokes and nounwind calls have entries in PadMap (due to being bracketed
3918 // by try-range labels when lowered). Ordinary calls do not, so appropriate
3919 // try-ranges for them need be deduced.
3920 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3921 const LandingPadInfo *LandingPad = LandingPads[i];
3922 for (unsigned j = 0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
3923 unsigned BeginLabel = LandingPad->BeginLabels[j];
3924 assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
3925 PadRange P = { i, j };
3926 PadMap[BeginLabel] = P;
3930 // The end label of the previous invoke or nounwind try-range.
3931 unsigned LastLabel = 0;
3933 // Whether there is a potentially throwing instruction (currently this means
3934 // an ordinary call) between the end of the previous try-range and now.
3935 bool SawPotentiallyThrowing = false;
3937 // Whether the last callsite entry was for an invoke.
3938 bool PreviousIsInvoke = false;
3940 // Visit all instructions in order of address.
3941 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
3943 for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
3945 if (!MI->isLabel()) {
3946 SawPotentiallyThrowing |= MI->getDesc().isCall();
3950 unsigned BeginLabel = MI->getOperand(0).getImm();
3951 assert(BeginLabel && "Invalid label!");
3953 // End of the previous try-range?
3954 if (BeginLabel == LastLabel)
3955 SawPotentiallyThrowing = false;
3957 // Beginning of a new try-range?
3958 RangeMapType::iterator L = PadMap.find(BeginLabel);
3959 if (L == PadMap.end())
3960 // Nope, it was just some random label.
3963 PadRange P = L->second;
3964 const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
3966 assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
3967 "Inconsistent landing pad map!");
3969 // If some instruction between the previous try-range and this one may
3970 // throw, create a call-site entry with no landing pad for the region
3971 // between the try-ranges.
3972 if (SawPotentiallyThrowing) {
3973 CallSiteEntry Site = {LastLabel, BeginLabel, 0, 0};
3974 CallSites.push_back(Site);
3975 PreviousIsInvoke = false;
3978 LastLabel = LandingPad->EndLabels[P.RangeIndex];
3979 assert(BeginLabel && LastLabel && "Invalid landing pad!");
3981 if (LandingPad->LandingPadLabel) {
3982 // This try-range is for an invoke.
3983 CallSiteEntry Site = {BeginLabel, LastLabel,
3984 LandingPad->LandingPadLabel, FirstActions[P.PadIndex]};
3986 // Try to merge with the previous call-site.
3987 if (PreviousIsInvoke) {
3988 CallSiteEntry &Prev = CallSites.back();
3989 if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
3990 // Extend the range of the previous entry.
3991 Prev.EndLabel = Site.EndLabel;
3996 // Otherwise, create a new call-site.
3997 CallSites.push_back(Site);
3998 PreviousIsInvoke = true;
4001 PreviousIsInvoke = false;
4005 // If some instruction between the previous try-range and the end of the
4006 // function may throw, create a call-site entry with no landing pad for the
4007 // region following the try-range.
4008 if (SawPotentiallyThrowing) {
4009 CallSiteEntry Site = {LastLabel, 0, 0, 0};
4010 CallSites.push_back(Site);
4016 const unsigned SiteStartSize = sizeof(int32_t); // DW_EH_PE_udata4
4017 const unsigned SiteLengthSize = sizeof(int32_t); // DW_EH_PE_udata4
4018 const unsigned LandingPadSize = sizeof(int32_t); // DW_EH_PE_udata4
4019 unsigned SizeSites = CallSites.size() * (SiteStartSize +
4022 for (unsigned i = 0, e = CallSites.size(); i < e; ++i)
4023 SizeSites += TargetAsmInfo::getULEB128Size(CallSites[i].Action);
4026 const unsigned TypeInfoSize = TD->getPointerSize(); // DW_EH_PE_absptr
4027 unsigned SizeTypes = TypeInfos.size() * TypeInfoSize;
4029 unsigned TypeOffset = sizeof(int8_t) + // Call site format
4030 TargetAsmInfo::getULEB128Size(SizeSites) + // Call-site table length
4031 SizeSites + SizeActions + SizeTypes;
4033 unsigned TotalSize = sizeof(int8_t) + // LPStart format
4034 sizeof(int8_t) + // TType format
4035 TargetAsmInfo::getULEB128Size(TypeOffset) + // TType base offset
4038 unsigned SizeAlign = (4 - TotalSize) & 3;
4040 // Begin the exception table.
4041 Asm->SwitchToDataSection(TAI->getDwarfExceptionSection());
4042 Asm->EmitAlignment(2, 0, 0, false);
4043 O << "GCC_except_table" << SubprogramCount << ":\n";
4044 for (unsigned i = 0; i != SizeAlign; ++i) {
4046 Asm->EOL("Padding");
4048 EmitLabel("exception", SubprogramCount);
4051 Asm->EmitInt8(DW_EH_PE_omit);
4052 Asm->EOL("LPStart format (DW_EH_PE_omit)");
4053 Asm->EmitInt8(DW_EH_PE_absptr);
4054 Asm->EOL("TType format (DW_EH_PE_absptr)");
4055 Asm->EmitULEB128Bytes(TypeOffset);
4056 Asm->EOL("TType base offset");
4057 Asm->EmitInt8(DW_EH_PE_udata4);
4058 Asm->EOL("Call site format (DW_EH_PE_udata4)");
4059 Asm->EmitULEB128Bytes(SizeSites);
4060 Asm->EOL("Call-site table length");
4062 // Emit the landing pad site information.
4063 for (unsigned i = 0; i < CallSites.size(); ++i) {
4064 CallSiteEntry &S = CallSites[i];
4065 const char *BeginTag;
4066 unsigned BeginNumber;
4068 if (!S.BeginLabel) {
4069 BeginTag = "eh_func_begin";
4070 BeginNumber = SubprogramCount;
4073 BeginNumber = S.BeginLabel;
4076 EmitSectionOffset(BeginTag, "eh_func_begin", BeginNumber, SubprogramCount,
4078 Asm->EOL("Region start");
4081 EmitDifference("eh_func_end", SubprogramCount, BeginTag, BeginNumber,
4084 EmitDifference("label", S.EndLabel, BeginTag, BeginNumber, true);
4086 Asm->EOL("Region length");
4091 EmitSectionOffset("label", "eh_func_begin", S.PadLabel, SubprogramCount,
4093 Asm->EOL("Landing pad");
4095 Asm->EmitULEB128Bytes(S.Action);
4099 // Emit the actions.
4100 for (unsigned I = 0, N = Actions.size(); I != N; ++I) {
4101 ActionEntry &Action = Actions[I];
4103 Asm->EmitSLEB128Bytes(Action.ValueForTypeID);
4104 Asm->EOL("TypeInfo index");
4105 Asm->EmitSLEB128Bytes(Action.NextAction);
4106 Asm->EOL("Next action");
4109 // Emit the type ids.
4110 for (unsigned M = TypeInfos.size(); M; --M) {
4111 GlobalVariable *GV = TypeInfos[M - 1];
4113 PrintRelDirective();
4116 O << Asm->getGlobalLinkName(GV);
4120 Asm->EOL("TypeInfo");
4123 // Emit the filter typeids.
4124 for (unsigned j = 0, M = FilterIds.size(); j < M; ++j) {
4125 unsigned TypeID = FilterIds[j];
4126 Asm->EmitULEB128Bytes(TypeID);
4127 Asm->EOL("Filter TypeInfo index");
4130 Asm->EmitAlignment(2, 0, 0, false);
4134 //===--------------------------------------------------------------------===//
4135 // Main entry points.
4137 DwarfException(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
4138 : Dwarf(OS, A, T, "eh")
4139 , shouldEmitTable(false)
4140 , shouldEmitMoves(false)
4141 , shouldEmitTableModule(false)
4142 , shouldEmitMovesModule(false)
4145 virtual ~DwarfException() {}
4147 /// SetModuleInfo - Set machine module information when it's known that pass
4148 /// manager has created it. Set by the target AsmPrinter.
4149 void SetModuleInfo(MachineModuleInfo *mmi) {
4153 /// BeginModule - Emit all exception information that should come prior to the
4155 void BeginModule(Module *M) {
4159 /// EndModule - Emit all exception information that should come after the
4162 if (shouldEmitMovesModule || shouldEmitTableModule) {
4163 const std::vector<Function *> Personalities = MMI->getPersonalities();
4164 for (unsigned i =0; i < Personalities.size(); ++i)
4165 EmitCommonEHFrame(Personalities[i], i);
4167 for (std::vector<FunctionEHFrameInfo>::iterator I = EHFrames.begin(),
4168 E = EHFrames.end(); I != E; ++I)
4173 /// BeginFunction - Gather pre-function exception information. Assumes being
4174 /// emitted immediately after the function entry point.
4175 void BeginFunction(MachineFunction *MF) {
4177 shouldEmitTable = shouldEmitMoves = false;
4178 if (MMI && TAI->doesSupportExceptionHandling()) {
4180 // Map all labels and get rid of any dead landing pads.
4181 MMI->TidyLandingPads();
4182 // If any landing pads survive, we need an EH table.
4183 if (MMI->getLandingPads().size())
4184 shouldEmitTable = true;
4186 // See if we need frame move info.
4187 if (!MF->getFunction()->doesNotThrow() || UnwindTablesMandatory)
4188 shouldEmitMoves = true;
4190 if (shouldEmitMoves || shouldEmitTable)
4191 // Assumes in correct section after the entry point.
4192 EmitLabel("eh_func_begin", ++SubprogramCount);
4194 shouldEmitTableModule |= shouldEmitTable;
4195 shouldEmitMovesModule |= shouldEmitMoves;
4198 /// EndFunction - Gather and emit post-function exception information.
4200 void EndFunction() {
4201 if (shouldEmitMoves || shouldEmitTable) {
4202 EmitLabel("eh_func_end", SubprogramCount);
4203 EmitExceptionTable();
4205 // Save EH frame information
4207 push_back(FunctionEHFrameInfo(getAsm()->getCurrentFunctionEHName(MF),
4209 MMI->getPersonalityIndex(),
4210 MF->getFrameInfo()->hasCalls(),
4211 !MMI->getLandingPads().empty(),
4212 MMI->getFrameMoves(),
4213 MF->getFunction()));
4218 } // End of namespace llvm
4220 //===----------------------------------------------------------------------===//
4222 /// Emit - Print the abbreviation using the specified Dwarf writer.
4224 void DIEAbbrev::Emit(const DwarfDebug &DD) const {
4225 // Emit its Dwarf tag type.
4226 DD.getAsm()->EmitULEB128Bytes(Tag);
4227 DD.getAsm()->EOL(TagString(Tag));
4229 // Emit whether it has children DIEs.
4230 DD.getAsm()->EmitULEB128Bytes(ChildrenFlag);
4231 DD.getAsm()->EOL(ChildrenString(ChildrenFlag));
4233 // For each attribute description.
4234 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4235 const DIEAbbrevData &AttrData = Data[i];
4237 // Emit attribute type.
4238 DD.getAsm()->EmitULEB128Bytes(AttrData.getAttribute());
4239 DD.getAsm()->EOL(AttributeString(AttrData.getAttribute()));
4242 DD.getAsm()->EmitULEB128Bytes(AttrData.getForm());
4243 DD.getAsm()->EOL(FormEncodingString(AttrData.getForm()));
4246 // Mark end of abbreviation.
4247 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(1)");
4248 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(2)");
4252 void DIEAbbrev::print(std::ostream &O) {
4253 O << "Abbreviation @"
4254 << std::hex << (intptr_t)this << std::dec
4258 << ChildrenString(ChildrenFlag)
4261 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4263 << AttributeString(Data[i].getAttribute())
4265 << FormEncodingString(Data[i].getForm())
4269 void DIEAbbrev::dump() { print(cerr); }
4272 //===----------------------------------------------------------------------===//
4275 void DIEValue::dump() {
4280 //===----------------------------------------------------------------------===//
4282 /// EmitValue - Emit integer of appropriate size.
4284 void DIEInteger::EmitValue(DwarfDebug &DD, unsigned Form) {
4286 case DW_FORM_flag: // Fall thru
4287 case DW_FORM_ref1: // Fall thru
4288 case DW_FORM_data1: DD.getAsm()->EmitInt8(Integer); break;
4289 case DW_FORM_ref2: // Fall thru
4290 case DW_FORM_data2: DD.getAsm()->EmitInt16(Integer); break;
4291 case DW_FORM_ref4: // Fall thru
4292 case DW_FORM_data4: DD.getAsm()->EmitInt32(Integer); break;
4293 case DW_FORM_ref8: // Fall thru
4294 case DW_FORM_data8: DD.getAsm()->EmitInt64(Integer); break;
4295 case DW_FORM_udata: DD.getAsm()->EmitULEB128Bytes(Integer); break;
4296 case DW_FORM_sdata: DD.getAsm()->EmitSLEB128Bytes(Integer); break;
4297 default: assert(0 && "DIE Value form not supported yet"); break;
4301 /// SizeOf - Determine size of integer value in bytes.
4303 unsigned DIEInteger::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4305 case DW_FORM_flag: // Fall thru
4306 case DW_FORM_ref1: // Fall thru
4307 case DW_FORM_data1: return sizeof(int8_t);
4308 case DW_FORM_ref2: // Fall thru
4309 case DW_FORM_data2: return sizeof(int16_t);
4310 case DW_FORM_ref4: // Fall thru
4311 case DW_FORM_data4: return sizeof(int32_t);
4312 case DW_FORM_ref8: // Fall thru
4313 case DW_FORM_data8: return sizeof(int64_t);
4314 case DW_FORM_udata: return TargetAsmInfo::getULEB128Size(Integer);
4315 case DW_FORM_sdata: return TargetAsmInfo::getSLEB128Size(Integer);
4316 default: assert(0 && "DIE Value form not supported yet"); break;
4321 //===----------------------------------------------------------------------===//
4323 /// EmitValue - Emit string value.
4325 void DIEString::EmitValue(DwarfDebug &DD, unsigned Form) {
4326 DD.getAsm()->EmitString(String);
4329 //===----------------------------------------------------------------------===//
4331 /// EmitValue - Emit label value.
4333 void DIEDwarfLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
4334 bool IsSmall = Form == DW_FORM_data4;
4335 DD.EmitReference(Label, false, IsSmall);
4338 /// SizeOf - Determine size of label value in bytes.
4340 unsigned DIEDwarfLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4341 if (Form == DW_FORM_data4) return 4;
4342 return DD.getTargetData()->getPointerSize();
4345 //===----------------------------------------------------------------------===//
4347 /// EmitValue - Emit label value.
4349 void DIEObjectLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
4350 bool IsSmall = Form == DW_FORM_data4;
4351 DD.EmitReference(Label, false, IsSmall);
4354 /// SizeOf - Determine size of label value in bytes.
4356 unsigned DIEObjectLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4357 if (Form == DW_FORM_data4) return 4;
4358 return DD.getTargetData()->getPointerSize();
4361 //===----------------------------------------------------------------------===//
4363 /// EmitValue - Emit delta value.
4365 void DIESectionOffset::EmitValue(DwarfDebug &DD, unsigned Form) {
4366 bool IsSmall = Form == DW_FORM_data4;
4367 DD.EmitSectionOffset(Label.Tag, Section.Tag,
4368 Label.Number, Section.Number, IsSmall, IsEH, UseSet);
4371 /// SizeOf - Determine size of delta value in bytes.
4373 unsigned DIESectionOffset::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4374 if (Form == DW_FORM_data4) return 4;
4375 return DD.getTargetData()->getPointerSize();
4378 //===----------------------------------------------------------------------===//
4380 /// EmitValue - Emit delta value.
4382 void DIEDelta::EmitValue(DwarfDebug &DD, unsigned Form) {
4383 bool IsSmall = Form == DW_FORM_data4;
4384 DD.EmitDifference(LabelHi, LabelLo, IsSmall);
4387 /// SizeOf - Determine size of delta value in bytes.
4389 unsigned DIEDelta::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4390 if (Form == DW_FORM_data4) return 4;
4391 return DD.getTargetData()->getPointerSize();
4394 //===----------------------------------------------------------------------===//
4396 /// EmitValue - Emit debug information entry offset.
4398 void DIEntry::EmitValue(DwarfDebug &DD, unsigned Form) {
4399 DD.getAsm()->EmitInt32(Entry->getOffset());
4402 //===----------------------------------------------------------------------===//
4404 /// ComputeSize - calculate the size of the block.
4406 unsigned DIEBlock::ComputeSize(DwarfDebug &DD) {
4408 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
4410 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4411 Size += Values[i]->SizeOf(DD, AbbrevData[i].getForm());
4417 /// EmitValue - Emit block data.
4419 void DIEBlock::EmitValue(DwarfDebug &DD, unsigned Form) {
4421 case DW_FORM_block1: DD.getAsm()->EmitInt8(Size); break;
4422 case DW_FORM_block2: DD.getAsm()->EmitInt16(Size); break;
4423 case DW_FORM_block4: DD.getAsm()->EmitInt32(Size); break;
4424 case DW_FORM_block: DD.getAsm()->EmitULEB128Bytes(Size); break;
4425 default: assert(0 && "Improper form for block"); break;
4428 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
4430 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4432 Values[i]->EmitValue(DD, AbbrevData[i].getForm());
4436 /// SizeOf - Determine size of block data in bytes.
4438 unsigned DIEBlock::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4440 case DW_FORM_block1: return Size + sizeof(int8_t);
4441 case DW_FORM_block2: return Size + sizeof(int16_t);
4442 case DW_FORM_block4: return Size + sizeof(int32_t);
4443 case DW_FORM_block: return Size + TargetAsmInfo::getULEB128Size(Size);
4444 default: assert(0 && "Improper form for block"); break;
4449 //===----------------------------------------------------------------------===//
4450 /// DIE Implementation
4453 for (unsigned i = 0, N = Children.size(); i < N; ++i)
4457 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
4459 void DIE::AddSiblingOffset() {
4460 DIEInteger *DI = new DIEInteger(0);
4461 Values.insert(Values.begin(), DI);
4462 Abbrev.AddFirstAttribute(DW_AT_sibling, DW_FORM_ref4);
4465 /// Profile - Used to gather unique data for the value folding set.
4467 void DIE::Profile(FoldingSetNodeID &ID) {
4470 for (unsigned i = 0, N = Children.size(); i < N; ++i)
4471 ID.AddPointer(Children[i]);
4473 for (unsigned j = 0, M = Values.size(); j < M; ++j)
4474 ID.AddPointer(Values[j]);
4478 void DIE::print(std::ostream &O, unsigned IncIndent) {
4479 static unsigned IndentCount = 0;
4480 IndentCount += IncIndent;
4481 const std::string Indent(IndentCount, ' ');
4482 bool isBlock = Abbrev.getTag() == 0;
4487 << "0x" << std::hex << (intptr_t)this << std::dec
4488 << ", Offset: " << Offset
4489 << ", Size: " << Size
4493 << TagString(Abbrev.getTag())
4495 << ChildrenString(Abbrev.getChildrenFlag());
4497 O << "Size: " << Size;
4501 const SmallVector<DIEAbbrevData, 8> &Data = Abbrev.getData();
4504 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4508 O << AttributeString(Data[i].getAttribute());
4510 O << "Blk[" << i << "]";
4513 << FormEncodingString(Data[i].getForm())
4515 Values[i]->print(O);
4520 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
4521 Children[j]->print(O, 4);
4524 if (!isBlock) O << "\n";
4525 IndentCount -= IncIndent;
4533 //===----------------------------------------------------------------------===//
4534 /// DwarfWriter Implementation
4537 DwarfWriter::DwarfWriter(raw_ostream &OS, AsmPrinter *A,
4538 const TargetAsmInfo *T) {
4539 DE = new DwarfException(OS, A, T);
4540 DD = new DwarfDebug(OS, A, T);
4543 DwarfWriter::~DwarfWriter() {
4548 /// SetModuleInfo - Set machine module info when it's known that pass manager
4549 /// has created it. Set by the target AsmPrinter.
4550 void DwarfWriter::SetModuleInfo(MachineModuleInfo *MMI) {
4551 DD->SetModuleInfo(MMI);
4552 DE->SetModuleInfo(MMI);
4555 /// BeginModule - Emit all Dwarf sections that should come prior to the
4557 void DwarfWriter::BeginModule(Module *M) {
4562 /// EndModule - Emit all Dwarf sections that should come after the content.
4564 void DwarfWriter::EndModule() {
4569 /// BeginFunction - Gather pre-function debug information. Assumes being
4570 /// emitted immediately after the function entry point.
4571 void DwarfWriter::BeginFunction(MachineFunction *MF) {
4572 DE->BeginFunction(MF);
4573 DD->BeginFunction(MF);
4576 /// EndFunction - Gather and emit post-function debug information.
4578 void DwarfWriter::EndFunction(MachineFunction *MF) {
4579 DD->EndFunction(MF);
4582 if (MachineModuleInfo *MMI = DD->getMMI() ? DD->getMMI() : DE->getMMI())
4583 // Clear function debug information.