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/Type.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/Support/Debug.h"
27 #include "llvm/Support/Dwarf.h"
28 #include "llvm/Support/CommandLine.h"
29 #include "llvm/Support/DataTypes.h"
30 #include "llvm/Support/Mangler.h"
31 #include "llvm/System/Path.h"
32 #include "llvm/Target/TargetAsmInfo.h"
33 #include "llvm/Target/TargetRegisterInfo.h"
34 #include "llvm/Target/TargetData.h"
35 #include "llvm/Target/TargetFrameInfo.h"
36 #include "llvm/Target/TargetInstrInfo.h"
37 #include "llvm/Target/TargetMachine.h"
38 #include "llvm/Target/TargetOptions.h"
42 using namespace llvm::dwarf;
46 //===----------------------------------------------------------------------===//
48 /// Configuration values for initial hash set sizes (log2).
50 static const unsigned InitDiesSetSize = 9; // 512
51 static const unsigned InitAbbreviationsSetSize = 9; // 512
52 static const unsigned InitValuesSetSize = 9; // 512
54 //===----------------------------------------------------------------------===//
55 /// Forward declarations.
60 //===----------------------------------------------------------------------===//
61 /// DWLabel - Labels are used to track locations in the assembler file.
62 /// Labels appear in the form @verbatim <prefix><Tag><Number> @endverbatim,
63 /// where the tag is a category of label (Ex. location) and number is a value
64 /// unique in that category.
67 /// Tag - Label category tag. Should always be a staticly declared C string.
71 /// Number - Value to make label unique.
75 DWLabel(const char *T, unsigned N) : Tag(T), Number(N) {}
77 void Profile(FoldingSetNodeID &ID) const {
78 ID.AddString(std::string(Tag));
79 ID.AddInteger(Number);
83 void print(std::ostream *O) const {
86 void print(std::ostream &O) const {
88 if (Number) O << Number;
93 //===----------------------------------------------------------------------===//
94 /// DIEAbbrevData - Dwarf abbreviation data, describes the one attribute of a
95 /// Dwarf abbreviation.
98 /// Attribute - Dwarf attribute code.
102 /// Form - Dwarf form code.
107 DIEAbbrevData(unsigned A, unsigned F)
113 unsigned getAttribute() const { return Attribute; }
114 unsigned getForm() const { return Form; }
116 /// Profile - Used to gather unique data for the abbreviation folding set.
118 void Profile(FoldingSetNodeID &ID)const {
119 ID.AddInteger(Attribute);
124 //===----------------------------------------------------------------------===//
125 /// DIEAbbrev - Dwarf abbreviation, describes the organization of a debug
126 /// information object.
127 class DIEAbbrev : public FoldingSetNode {
129 /// Tag - Dwarf tag code.
133 /// Unique number for node.
137 /// ChildrenFlag - Dwarf children flag.
139 unsigned ChildrenFlag;
141 /// Data - Raw data bytes for abbreviation.
143 std::vector<DIEAbbrevData> Data;
147 DIEAbbrev(unsigned T, unsigned C)
155 unsigned getTag() const { return Tag; }
156 unsigned getNumber() const { return Number; }
157 unsigned getChildrenFlag() const { return ChildrenFlag; }
158 const std::vector<DIEAbbrevData> &getData() const { return Data; }
159 void setTag(unsigned T) { Tag = T; }
160 void setChildrenFlag(unsigned CF) { ChildrenFlag = CF; }
161 void setNumber(unsigned N) { Number = N; }
163 /// AddAttribute - Adds another set of attribute information to the
165 void AddAttribute(unsigned Attribute, unsigned Form) {
166 Data.push_back(DIEAbbrevData(Attribute, Form));
169 /// AddFirstAttribute - Adds a set of attribute information to the front
170 /// of the abbreviation.
171 void AddFirstAttribute(unsigned Attribute, unsigned Form) {
172 Data.insert(Data.begin(), DIEAbbrevData(Attribute, Form));
175 /// Profile - Used to gather unique data for the abbreviation folding set.
177 void Profile(FoldingSetNodeID &ID) {
179 ID.AddInteger(ChildrenFlag);
181 // For each attribute description.
182 for (unsigned i = 0, N = Data.size(); i < N; ++i)
186 /// Emit - Print the abbreviation using the specified Dwarf writer.
188 void Emit(const DwarfDebug &DD) const;
191 void print(std::ostream *O) {
194 void print(std::ostream &O);
199 //===----------------------------------------------------------------------===//
200 /// DIE - A structured debug information entry. Has an abbreviation which
201 /// describes it's organization.
202 class DIE : public FoldingSetNode {
204 /// Abbrev - Buffer for constructing abbreviation.
208 /// Offset - Offset in debug info section.
212 /// Size - Size of instance + children.
218 std::vector<DIE *> Children;
220 /// Attributes values.
222 std::vector<DIEValue *> Values;
225 explicit DIE(unsigned Tag)
226 : Abbrev(Tag, DW_CHILDREN_no)
235 DIEAbbrev &getAbbrev() { return Abbrev; }
236 unsigned getAbbrevNumber() const {
237 return Abbrev.getNumber();
239 unsigned getTag() const { return Abbrev.getTag(); }
240 unsigned getOffset() const { return Offset; }
241 unsigned getSize() const { return Size; }
242 const std::vector<DIE *> &getChildren() const { return Children; }
243 std::vector<DIEValue *> &getValues() { return Values; }
244 void setTag(unsigned Tag) { Abbrev.setTag(Tag); }
245 void setOffset(unsigned O) { Offset = O; }
246 void setSize(unsigned S) { Size = S; }
248 /// AddValue - Add a value and attributes to a DIE.
250 void AddValue(unsigned Attribute, unsigned Form, DIEValue *Value) {
251 Abbrev.AddAttribute(Attribute, Form);
252 Values.push_back(Value);
255 /// SiblingOffset - Return the offset of the debug information entry's
257 unsigned SiblingOffset() const { return Offset + Size; }
259 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
261 void AddSiblingOffset();
263 /// AddChild - Add a child to the DIE.
265 void AddChild(DIE *Child) {
266 Abbrev.setChildrenFlag(DW_CHILDREN_yes);
267 Children.push_back(Child);
270 /// Detach - Detaches objects connected to it after copying.
276 /// Profile - Used to gather unique data for the value folding set.
278 void Profile(FoldingSetNodeID &ID) ;
281 void print(std::ostream *O, unsigned IncIndent = 0) {
282 if (O) print(*O, IncIndent);
284 void print(std::ostream &O, unsigned IncIndent = 0);
289 //===----------------------------------------------------------------------===//
290 /// DIEValue - A debug information entry value.
292 class DIEValue : public FoldingSetNode {
305 /// Type - Type of data stored in the value.
309 explicit DIEValue(unsigned T)
312 virtual ~DIEValue() {}
315 unsigned getType() const { return Type; }
317 // Implement isa/cast/dyncast.
318 static bool classof(const DIEValue *) { return true; }
320 /// EmitValue - Emit value via the Dwarf writer.
322 virtual void EmitValue(DwarfDebug &DD, unsigned Form) = 0;
324 /// SizeOf - Return the size of a value in bytes.
326 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const = 0;
328 /// Profile - Used to gather unique data for the value folding set.
330 virtual void Profile(FoldingSetNodeID &ID) = 0;
333 void print(std::ostream *O) {
336 virtual void print(std::ostream &O) = 0;
341 //===----------------------------------------------------------------------===//
342 /// DWInteger - An integer value DIE.
344 class DIEInteger : public DIEValue {
349 explicit DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
351 // Implement isa/cast/dyncast.
352 static bool classof(const DIEInteger *) { return true; }
353 static bool classof(const DIEValue *I) { return I->Type == isInteger; }
355 /// BestForm - Choose the best form for integer.
357 static unsigned BestForm(bool IsSigned, uint64_t Integer) {
359 if ((char)Integer == (signed)Integer) return DW_FORM_data1;
360 if ((short)Integer == (signed)Integer) return DW_FORM_data2;
361 if ((int)Integer == (signed)Integer) return DW_FORM_data4;
363 if ((unsigned char)Integer == Integer) return DW_FORM_data1;
364 if ((unsigned short)Integer == Integer) return DW_FORM_data2;
365 if ((unsigned int)Integer == Integer) return DW_FORM_data4;
367 return DW_FORM_data8;
370 /// EmitValue - Emit integer of appropriate size.
372 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
374 /// SizeOf - Determine size of integer value in bytes.
376 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
378 /// Profile - Used to gather unique data for the value folding set.
380 static void Profile(FoldingSetNodeID &ID, unsigned Integer) {
381 ID.AddInteger(isInteger);
382 ID.AddInteger(Integer);
384 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Integer); }
387 virtual void print(std::ostream &O) {
388 O << "Int: " << (int64_t)Integer
389 << " 0x" << std::hex << Integer << std::dec;
394 //===----------------------------------------------------------------------===//
395 /// DIEString - A string value DIE.
397 class DIEString : public DIEValue {
399 const std::string String;
401 explicit DIEString(const std::string &S) : DIEValue(isString), String(S) {}
403 // Implement isa/cast/dyncast.
404 static bool classof(const DIEString *) { return true; }
405 static bool classof(const DIEValue *S) { return S->Type == isString; }
407 /// EmitValue - Emit string value.
409 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
411 /// SizeOf - Determine size of string value in bytes.
413 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
414 return String.size() + sizeof(char); // sizeof('\0');
417 /// Profile - Used to gather unique data for the value folding set.
419 static void Profile(FoldingSetNodeID &ID, const std::string &String) {
420 ID.AddInteger(isString);
421 ID.AddString(String);
423 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, String); }
426 virtual void print(std::ostream &O) {
427 O << "Str: \"" << String << "\"";
432 //===----------------------------------------------------------------------===//
433 /// DIEDwarfLabel - A Dwarf internal label expression DIE.
435 class DIEDwarfLabel : public DIEValue {
440 explicit DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {}
442 // Implement isa/cast/dyncast.
443 static bool classof(const DIEDwarfLabel *) { return true; }
444 static bool classof(const DIEValue *L) { return L->Type == isLabel; }
446 /// EmitValue - Emit label value.
448 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
450 /// SizeOf - Determine size of label value in bytes.
452 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
454 /// Profile - Used to gather unique data for the value folding set.
456 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label) {
457 ID.AddInteger(isLabel);
460 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
463 virtual void print(std::ostream &O) {
471 //===----------------------------------------------------------------------===//
472 /// DIEObjectLabel - A label to an object in code or data.
474 class DIEObjectLabel : public DIEValue {
476 const std::string Label;
478 explicit DIEObjectLabel(const std::string &L)
479 : DIEValue(isAsIsLabel), Label(L) {}
481 // Implement isa/cast/dyncast.
482 static bool classof(const DIEObjectLabel *) { return true; }
483 static bool classof(const DIEValue *L) { return L->Type == isAsIsLabel; }
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 std::string &Label) {
496 ID.AddInteger(isAsIsLabel);
499 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
502 virtual void print(std::ostream &O) {
503 O << "Obj: " << Label;
508 //===----------------------------------------------------------------------===//
509 /// DIESectionOffset - A section offset DIE.
511 class DIESectionOffset : public DIEValue {
514 const DWLabel Section;
518 DIESectionOffset(const DWLabel &Lab, const DWLabel &Sec,
519 bool isEH = false, bool useSet = true)
520 : DIEValue(isSectionOffset), Label(Lab), Section(Sec),
521 IsEH(isEH), UseSet(useSet) {}
523 // Implement isa/cast/dyncast.
524 static bool classof(const DIESectionOffset *) { return true; }
525 static bool classof(const DIEValue *D) { return D->Type == isSectionOffset; }
527 /// EmitValue - Emit section offset.
529 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
531 /// SizeOf - Determine size of section offset value in bytes.
533 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
535 /// Profile - Used to gather unique data for the value folding set.
537 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label,
538 const DWLabel &Section) {
539 ID.AddInteger(isSectionOffset);
542 // IsEH and UseSet are specific to the Label/Section that we will emit
543 // the offset for; so Label/Section are enough for uniqueness.
545 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label, Section); }
548 virtual void print(std::ostream &O) {
553 O << "-" << IsEH << "-" << UseSet;
558 //===----------------------------------------------------------------------===//
559 /// DIEDelta - A simple label difference DIE.
561 class DIEDelta : public DIEValue {
563 const DWLabel LabelHi;
564 const DWLabel LabelLo;
566 DIEDelta(const DWLabel &Hi, const DWLabel &Lo)
567 : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
569 // Implement isa/cast/dyncast.
570 static bool classof(const DIEDelta *) { return true; }
571 static bool classof(const DIEValue *D) { return D->Type == isDelta; }
573 /// EmitValue - Emit delta value.
575 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
577 /// SizeOf - Determine size of delta value in bytes.
579 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
581 /// Profile - Used to gather unique data for the value folding set.
583 static void Profile(FoldingSetNodeID &ID, const DWLabel &LabelHi,
584 const DWLabel &LabelLo) {
585 ID.AddInteger(isDelta);
589 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, LabelHi, LabelLo); }
592 virtual void print(std::ostream &O) {
601 //===----------------------------------------------------------------------===//
602 /// DIEntry - A pointer to another debug information entry. An instance of this
603 /// class can also be used as a proxy for a debug information entry not yet
604 /// defined (ie. types.)
605 class DIEntry : public DIEValue {
609 explicit DIEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
611 // Implement isa/cast/dyncast.
612 static bool classof(const DIEntry *) { return true; }
613 static bool classof(const DIEValue *E) { return E->Type == isEntry; }
615 /// EmitValue - Emit debug information entry offset.
617 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
619 /// SizeOf - Determine size of debug information entry in bytes.
621 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
622 return sizeof(int32_t);
625 /// Profile - Used to gather unique data for the value folding set.
627 static void Profile(FoldingSetNodeID &ID, DIE *Entry) {
628 ID.AddInteger(isEntry);
629 ID.AddPointer(Entry);
631 virtual void Profile(FoldingSetNodeID &ID) {
632 ID.AddInteger(isEntry);
635 ID.AddPointer(Entry);
642 virtual void print(std::ostream &O) {
643 O << "Die: 0x" << std::hex << (intptr_t)Entry << std::dec;
648 //===----------------------------------------------------------------------===//
649 /// DIEBlock - A block of values. Primarily used for location expressions.
651 class DIEBlock : public DIEValue, public DIE {
653 unsigned Size; // Size in bytes excluding size header.
663 // Implement isa/cast/dyncast.
664 static bool classof(const DIEBlock *) { return true; }
665 static bool classof(const DIEValue *E) { return E->Type == isBlock; }
667 /// ComputeSize - calculate the size of the block.
669 unsigned ComputeSize(DwarfDebug &DD);
671 /// BestForm - Choose the best form for data.
673 unsigned BestForm() const {
674 if ((unsigned char)Size == Size) return DW_FORM_block1;
675 if ((unsigned short)Size == Size) return DW_FORM_block2;
676 if ((unsigned int)Size == Size) return DW_FORM_block4;
677 return DW_FORM_block;
680 /// EmitValue - Emit block data.
682 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
684 /// SizeOf - Determine size of block data in bytes.
686 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
689 /// Profile - Used to gather unique data for the value folding set.
691 virtual void Profile(FoldingSetNodeID &ID) {
692 ID.AddInteger(isBlock);
697 virtual void print(std::ostream &O) {
704 //===----------------------------------------------------------------------===//
705 /// CompileUnit - This dwarf writer support class manages information associate
706 /// with a source file.
709 /// Desc - Compile unit debug descriptor.
711 CompileUnitDesc *Desc;
713 /// ID - File identifier for source.
717 /// Die - Compile unit debug information entry.
721 /// DescToDieMap - Tracks the mapping of unit level debug informaton
722 /// descriptors to debug information entries.
723 std::map<DebugInfoDesc *, DIE *> DescToDieMap;
725 /// DescToDIEntryMap - Tracks the mapping of unit level debug informaton
726 /// descriptors to debug information entries using a DIEntry proxy.
727 std::map<DebugInfoDesc *, DIEntry *> DescToDIEntryMap;
729 /// Globals - A map of globally visible named entities for this unit.
731 std::map<std::string, DIE *> Globals;
733 /// DiesSet - Used to uniquely define dies within the compile unit.
735 FoldingSet<DIE> DiesSet;
737 /// Dies - List of all dies in the compile unit.
739 std::vector<DIE *> Dies;
742 CompileUnit(CompileUnitDesc *CUD, unsigned I, DIE *D)
749 , DiesSet(InitDiesSetSize)
756 for (unsigned i = 0, N = Dies.size(); i < N; ++i)
761 CompileUnitDesc *getDesc() const { return Desc; }
762 unsigned getID() const { return ID; }
763 DIE* getDie() const { return Die; }
764 std::map<std::string, DIE *> &getGlobals() { return Globals; }
766 /// hasContent - Return true if this compile unit has something to write out.
768 bool hasContent() const {
769 return !Die->getChildren().empty();
772 /// AddGlobal - Add a new global entity to the compile unit.
774 void AddGlobal(const std::string &Name, DIE *Die) {
778 /// getDieMapSlotFor - Returns the debug information entry map slot for the
779 /// specified debug descriptor.
780 DIE *&getDieMapSlotFor(DebugInfoDesc *DID) {
781 return DescToDieMap[DID];
784 /// getDIEntrySlotFor - Returns the debug information entry proxy slot for the
785 /// specified debug descriptor.
786 DIEntry *&getDIEntrySlotFor(DebugInfoDesc *DID) {
787 return DescToDIEntryMap[DID];
790 /// AddDie - Adds or interns the DIE to the compile unit.
792 DIE *AddDie(DIE &Buffer) {
796 DIE *Die = DiesSet.FindNodeOrInsertPos(ID, Where);
799 Die = new DIE(Buffer);
800 DiesSet.InsertNode(Die, Where);
801 this->Die->AddChild(Die);
809 //===----------------------------------------------------------------------===//
810 /// Dwarf - Emits general Dwarf directives.
816 //===--------------------------------------------------------------------===//
817 // Core attributes used by the Dwarf writer.
821 /// O - Stream to .s file.
825 /// Asm - Target of Dwarf emission.
829 /// TAI - Target Asm Printer.
830 const TargetAsmInfo *TAI;
832 /// TD - Target data.
833 const TargetData *TD;
835 /// RI - Register Information.
836 const TargetRegisterInfo *RI;
838 /// M - Current module.
842 /// MF - Current machine function.
846 /// MMI - Collected machine module information.
848 MachineModuleInfo *MMI;
850 /// SubprogramCount - The running count of functions being compiled.
852 unsigned SubprogramCount;
854 /// Flavor - A unique string indicating what dwarf producer this is, used to
856 const char * const Flavor;
859 Dwarf(std::ostream &OS, AsmPrinter *A, const TargetAsmInfo *T,
864 , TD(Asm->TM.getTargetData())
865 , RI(Asm->TM.getRegisterInfo())
877 //===--------------------------------------------------------------------===//
880 AsmPrinter *getAsm() const { return Asm; }
881 MachineModuleInfo *getMMI() const { return MMI; }
882 const TargetAsmInfo *getTargetAsmInfo() const { return TAI; }
883 const TargetData *getTargetData() const { return TD; }
885 void PrintRelDirective(bool Force32Bit = false, bool isInSection = false)
887 if (isInSection && TAI->getDwarfSectionOffsetDirective())
888 O << TAI->getDwarfSectionOffsetDirective();
889 else if (Force32Bit || TD->getPointerSize() == sizeof(int32_t))
890 O << TAI->getData32bitsDirective();
892 O << TAI->getData64bitsDirective();
895 /// PrintLabelName - Print label name in form used by Dwarf writer.
897 void PrintLabelName(DWLabel Label) const {
898 PrintLabelName(Label.Tag, Label.Number);
900 void PrintLabelName(const char *Tag, unsigned Number) const {
901 O << TAI->getPrivateGlobalPrefix() << Tag;
902 if (Number) O << Number;
905 void PrintLabelName(const char *Tag, unsigned Number,
906 const char *Suffix) const {
907 O << TAI->getPrivateGlobalPrefix() << Tag;
908 if (Number) O << Number;
912 /// EmitLabel - Emit location label for internal use by Dwarf.
914 void EmitLabel(DWLabel Label) const {
915 EmitLabel(Label.Tag, Label.Number);
917 void EmitLabel(const char *Tag, unsigned Number) const {
918 PrintLabelName(Tag, Number);
922 /// EmitReference - Emit a reference to a label.
924 void EmitReference(DWLabel Label, bool IsPCRelative = false,
925 bool Force32Bit = false) const {
926 EmitReference(Label.Tag, Label.Number, IsPCRelative, Force32Bit);
928 void EmitReference(const char *Tag, unsigned Number,
929 bool IsPCRelative = false, bool Force32Bit = false) const {
930 PrintRelDirective(Force32Bit);
931 PrintLabelName(Tag, Number);
933 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
935 void EmitReference(const std::string &Name, bool IsPCRelative = false,
936 bool Force32Bit = false) const {
937 PrintRelDirective(Force32Bit);
941 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
944 /// EmitDifference - Emit the difference between two labels. Some
945 /// assemblers do not behave with absolute expressions with data directives,
946 /// so there is an option (needsSet) to use an intermediary set expression.
947 void EmitDifference(DWLabel LabelHi, DWLabel LabelLo,
948 bool IsSmall = false) {
949 EmitDifference(LabelHi.Tag, LabelHi.Number,
950 LabelLo.Tag, LabelLo.Number,
953 void EmitDifference(const char *TagHi, unsigned NumberHi,
954 const char *TagLo, unsigned NumberLo,
955 bool IsSmall = false) {
956 if (TAI->needsSet()) {
958 PrintLabelName("set", SetCounter, Flavor);
960 PrintLabelName(TagHi, NumberHi);
962 PrintLabelName(TagLo, NumberLo);
965 PrintRelDirective(IsSmall);
966 PrintLabelName("set", SetCounter, Flavor);
969 PrintRelDirective(IsSmall);
971 PrintLabelName(TagHi, NumberHi);
973 PrintLabelName(TagLo, NumberLo);
977 void EmitSectionOffset(const char* Label, const char* Section,
978 unsigned LabelNumber, unsigned SectionNumber,
979 bool IsSmall = false, bool isEH = false,
980 bool useSet = true) {
981 bool printAbsolute = false;
983 printAbsolute = TAI->isAbsoluteEHSectionOffsets();
985 printAbsolute = TAI->isAbsoluteDebugSectionOffsets();
987 if (TAI->needsSet() && useSet) {
989 PrintLabelName("set", SetCounter, Flavor);
991 PrintLabelName(Label, LabelNumber);
993 if (!printAbsolute) {
995 PrintLabelName(Section, SectionNumber);
999 PrintRelDirective(IsSmall);
1001 PrintLabelName("set", SetCounter, Flavor);
1004 PrintRelDirective(IsSmall, true);
1006 PrintLabelName(Label, LabelNumber);
1008 if (!printAbsolute) {
1010 PrintLabelName(Section, SectionNumber);
1015 /// EmitFrameMoves - Emit frame instructions to describe the layout of the
1017 void EmitFrameMoves(const char *BaseLabel, unsigned BaseLabelID,
1018 const std::vector<MachineMove> &Moves, bool isEH) {
1020 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
1021 TargetFrameInfo::StackGrowsUp ?
1022 TD->getPointerSize() : -TD->getPointerSize();
1023 bool IsLocal = BaseLabel && strcmp(BaseLabel, "label") == 0;
1025 for (unsigned i = 0, N = Moves.size(); i < N; ++i) {
1026 const MachineMove &Move = Moves[i];
1027 unsigned LabelID = Move.getLabelID();
1030 LabelID = MMI->MappedLabel(LabelID);
1032 // Throw out move if the label is invalid.
1033 if (!LabelID) continue;
1036 const MachineLocation &Dst = Move.getDestination();
1037 const MachineLocation &Src = Move.getSource();
1039 // Advance row if new location.
1040 if (BaseLabel && LabelID && (BaseLabelID != LabelID || !IsLocal)) {
1041 Asm->EmitInt8(DW_CFA_advance_loc4);
1042 Asm->EOL("DW_CFA_advance_loc4");
1043 EmitDifference("label", LabelID, BaseLabel, BaseLabelID, true);
1046 BaseLabelID = LabelID;
1047 BaseLabel = "label";
1051 // If advancing cfa.
1052 if (Dst.isRegister() && Dst.getRegister() == MachineLocation::VirtualFP) {
1053 if (!Src.isRegister()) {
1054 if (Src.getRegister() == MachineLocation::VirtualFP) {
1055 Asm->EmitInt8(DW_CFA_def_cfa_offset);
1056 Asm->EOL("DW_CFA_def_cfa_offset");
1058 Asm->EmitInt8(DW_CFA_def_cfa);
1059 Asm->EOL("DW_CFA_def_cfa");
1060 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Src.getRegister(), isEH));
1061 Asm->EOL("Register");
1064 int Offset = -Src.getOffset();
1066 Asm->EmitULEB128Bytes(Offset);
1069 assert(0 && "Machine move no supported yet.");
1071 } else if (Src.isRegister() &&
1072 Src.getRegister() == MachineLocation::VirtualFP) {
1073 if (Dst.isRegister()) {
1074 Asm->EmitInt8(DW_CFA_def_cfa_register);
1075 Asm->EOL("DW_CFA_def_cfa_register");
1076 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Dst.getRegister(), isEH));
1077 Asm->EOL("Register");
1079 assert(0 && "Machine move no supported yet.");
1082 unsigned Reg = RI->getDwarfRegNum(Src.getRegister(), isEH);
1083 int Offset = Dst.getOffset() / stackGrowth;
1086 Asm->EmitInt8(DW_CFA_offset_extended_sf);
1087 Asm->EOL("DW_CFA_offset_extended_sf");
1088 Asm->EmitULEB128Bytes(Reg);
1090 Asm->EmitSLEB128Bytes(Offset);
1092 } else if (Reg < 64) {
1093 Asm->EmitInt8(DW_CFA_offset + Reg);
1094 Asm->EOL("DW_CFA_offset + Reg (" + utostr(Reg) + ")");
1095 Asm->EmitULEB128Bytes(Offset);
1098 Asm->EmitInt8(DW_CFA_offset_extended);
1099 Asm->EOL("DW_CFA_offset_extended");
1100 Asm->EmitULEB128Bytes(Reg);
1102 Asm->EmitULEB128Bytes(Offset);
1111 //===----------------------------------------------------------------------===//
1112 /// DwarfDebug - Emits Dwarf debug directives.
1114 class DwarfDebug : public Dwarf {
1117 //===--------------------------------------------------------------------===//
1118 // Attributes used to construct specific Dwarf sections.
1121 /// CompileUnits - All the compile units involved in this build. The index
1122 /// of each entry in this vector corresponds to the sources in MMI.
1123 std::vector<CompileUnit *> CompileUnits;
1125 /// AbbreviationsSet - Used to uniquely define abbreviations.
1127 FoldingSet<DIEAbbrev> AbbreviationsSet;
1129 /// Abbreviations - A list of all the unique abbreviations in use.
1131 std::vector<DIEAbbrev *> Abbreviations;
1133 /// ValuesSet - Used to uniquely define values.
1135 FoldingSet<DIEValue> ValuesSet;
1137 /// Values - A list of all the unique values in use.
1139 std::vector<DIEValue *> Values;
1141 /// StringPool - A UniqueVector of strings used by indirect references.
1143 UniqueVector<std::string> StringPool;
1145 /// UnitMap - Map debug information descriptor to compile unit.
1147 std::map<DebugInfoDesc *, CompileUnit *> DescToUnitMap;
1149 /// SectionMap - Provides a unique id per text section.
1151 UniqueVector<std::string> SectionMap;
1153 /// SectionSourceLines - Tracks line numbers per text section.
1155 std::vector<std::vector<SourceLineInfo> > SectionSourceLines;
1157 /// didInitial - Flag to indicate if initial emission has been done.
1161 /// shouldEmit - Flag to indicate if debug information should be emitted.
1165 struct FunctionDebugFrameInfo {
1167 std::vector<MachineMove> Moves;
1169 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M):
1170 Number(Num), Moves(M) { }
1173 std::vector<FunctionDebugFrameInfo> DebugFrames;
1177 /// ShouldEmitDwarf - Returns true if Dwarf declarations should be made.
1179 bool ShouldEmitDwarf() const { return shouldEmit; }
1181 /// AssignAbbrevNumber - Define a unique number for the abbreviation.
1183 void AssignAbbrevNumber(DIEAbbrev &Abbrev) {
1184 // Profile the node so that we can make it unique.
1185 FoldingSetNodeID ID;
1188 // Check the set for priors.
1189 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
1191 // If it's newly added.
1192 if (InSet == &Abbrev) {
1193 // Add to abbreviation list.
1194 Abbreviations.push_back(&Abbrev);
1195 // Assign the vector position + 1 as its number.
1196 Abbrev.setNumber(Abbreviations.size());
1198 // Assign existing abbreviation number.
1199 Abbrev.setNumber(InSet->getNumber());
1203 /// NewString - Add a string to the constant pool and returns a label.
1205 DWLabel NewString(const std::string &String) {
1206 unsigned StringID = StringPool.insert(String);
1207 return DWLabel("string", StringID);
1210 /// NewDIEntry - Creates a new DIEntry to be a proxy for a debug information
1212 DIEntry *NewDIEntry(DIE *Entry = NULL) {
1216 FoldingSetNodeID ID;
1217 DIEntry::Profile(ID, Entry);
1219 Value = static_cast<DIEntry *>(ValuesSet.FindNodeOrInsertPos(ID, Where));
1221 if (Value) return Value;
1223 Value = new DIEntry(Entry);
1224 ValuesSet.InsertNode(Value, Where);
1226 Value = new DIEntry(Entry);
1229 Values.push_back(Value);
1233 /// SetDIEntry - Set a DIEntry once the debug information entry is defined.
1235 void SetDIEntry(DIEntry *Value, DIE *Entry) {
1236 Value->Entry = Entry;
1237 // Add to values set if not already there. If it is, we merely have a
1238 // duplicate in the values list (no harm.)
1239 ValuesSet.GetOrInsertNode(Value);
1242 /// AddUInt - Add an unsigned integer attribute data and value.
1244 void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer) {
1245 if (!Form) Form = DIEInteger::BestForm(false, Integer);
1247 FoldingSetNodeID ID;
1248 DIEInteger::Profile(ID, Integer);
1250 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1252 Value = new DIEInteger(Integer);
1253 ValuesSet.InsertNode(Value, Where);
1254 Values.push_back(Value);
1257 Die->AddValue(Attribute, Form, Value);
1260 /// AddSInt - Add an signed integer attribute data and value.
1262 void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer) {
1263 if (!Form) Form = DIEInteger::BestForm(true, Integer);
1265 FoldingSetNodeID ID;
1266 DIEInteger::Profile(ID, (uint64_t)Integer);
1268 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1270 Value = new DIEInteger(Integer);
1271 ValuesSet.InsertNode(Value, Where);
1272 Values.push_back(Value);
1275 Die->AddValue(Attribute, Form, Value);
1278 /// AddString - Add a std::string attribute data and value.
1280 void AddString(DIE *Die, unsigned Attribute, unsigned Form,
1281 const std::string &String) {
1282 FoldingSetNodeID ID;
1283 DIEString::Profile(ID, String);
1285 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1287 Value = new DIEString(String);
1288 ValuesSet.InsertNode(Value, Where);
1289 Values.push_back(Value);
1292 Die->AddValue(Attribute, Form, Value);
1295 /// AddLabel - Add a Dwarf label attribute data and value.
1297 void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
1298 const DWLabel &Label) {
1299 FoldingSetNodeID ID;
1300 DIEDwarfLabel::Profile(ID, Label);
1302 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1304 Value = new DIEDwarfLabel(Label);
1305 ValuesSet.InsertNode(Value, Where);
1306 Values.push_back(Value);
1309 Die->AddValue(Attribute, Form, Value);
1312 /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
1314 void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
1315 const std::string &Label) {
1316 FoldingSetNodeID ID;
1317 DIEObjectLabel::Profile(ID, Label);
1319 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1321 Value = new DIEObjectLabel(Label);
1322 ValuesSet.InsertNode(Value, Where);
1323 Values.push_back(Value);
1326 Die->AddValue(Attribute, Form, Value);
1329 /// AddSectionOffset - Add a section offset label attribute data and value.
1331 void AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
1332 const DWLabel &Label, const DWLabel &Section,
1333 bool isEH = false, bool useSet = true) {
1334 FoldingSetNodeID ID;
1335 DIESectionOffset::Profile(ID, Label, Section);
1337 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1339 Value = new DIESectionOffset(Label, Section, isEH, useSet);
1340 ValuesSet.InsertNode(Value, Where);
1341 Values.push_back(Value);
1344 Die->AddValue(Attribute, Form, Value);
1347 /// AddDelta - Add a label delta attribute data and value.
1349 void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
1350 const DWLabel &Hi, const DWLabel &Lo) {
1351 FoldingSetNodeID ID;
1352 DIEDelta::Profile(ID, Hi, Lo);
1354 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1356 Value = new DIEDelta(Hi, Lo);
1357 ValuesSet.InsertNode(Value, Where);
1358 Values.push_back(Value);
1361 Die->AddValue(Attribute, Form, Value);
1364 /// AddDIEntry - Add a DIE attribute data and value.
1366 void AddDIEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
1367 Die->AddValue(Attribute, Form, NewDIEntry(Entry));
1370 /// AddBlock - Add block data.
1372 void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block) {
1373 Block->ComputeSize(*this);
1374 FoldingSetNodeID ID;
1377 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1380 ValuesSet.InsertNode(Value, Where);
1381 Values.push_back(Value);
1383 // Already exists, reuse the previous one.
1385 Block = cast<DIEBlock>(Value);
1388 Die->AddValue(Attribute, Block->BestForm(), Value);
1393 /// AddSourceLine - Add location information to specified debug information
1395 void AddSourceLine(DIE *Die, CompileUnitDesc *File, unsigned Line) {
1397 CompileUnit *FileUnit = FindCompileUnit(File);
1398 unsigned FileID = FileUnit->getID();
1399 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1400 AddUInt(Die, DW_AT_decl_line, 0, Line);
1404 /// AddAddress - Add an address attribute to a die based on the location
1406 void AddAddress(DIE *Die, unsigned Attribute,
1407 const MachineLocation &Location) {
1408 unsigned Reg = RI->getDwarfRegNum(Location.getRegister(), false);
1409 DIEBlock *Block = new DIEBlock();
1411 if (Location.isRegister()) {
1413 AddUInt(Block, 0, DW_FORM_data1, DW_OP_reg0 + Reg);
1415 AddUInt(Block, 0, DW_FORM_data1, DW_OP_regx);
1416 AddUInt(Block, 0, DW_FORM_udata, Reg);
1420 AddUInt(Block, 0, DW_FORM_data1, DW_OP_breg0 + Reg);
1422 AddUInt(Block, 0, DW_FORM_data1, DW_OP_bregx);
1423 AddUInt(Block, 0, DW_FORM_udata, Reg);
1425 AddUInt(Block, 0, DW_FORM_sdata, Location.getOffset());
1428 AddBlock(Die, Attribute, 0, Block);
1431 /// AddBasicType - Add a new basic type attribute to the specified entity.
1433 void AddBasicType(DIE *Entity, CompileUnit *Unit,
1434 const std::string &Name,
1435 unsigned Encoding, unsigned Size) {
1436 DIE *Die = ConstructBasicType(Unit, Name, Encoding, Size);
1437 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, Die);
1440 /// ConstructBasicType - Construct a new basic type.
1442 DIE *ConstructBasicType(CompileUnit *Unit,
1443 const std::string &Name,
1444 unsigned Encoding, unsigned Size) {
1445 DIE Buffer(DW_TAG_base_type);
1446 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1447 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, Encoding);
1448 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1449 return Unit->AddDie(Buffer);
1452 /// AddPointerType - Add a new pointer type attribute to the specified entity.
1454 void AddPointerType(DIE *Entity, CompileUnit *Unit, const std::string &Name) {
1455 DIE *Die = ConstructPointerType(Unit, Name);
1456 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, Die);
1459 /// ConstructPointerType - Construct a new pointer type.
1461 DIE *ConstructPointerType(CompileUnit *Unit, const std::string &Name) {
1462 DIE Buffer(DW_TAG_pointer_type);
1463 AddUInt(&Buffer, DW_AT_byte_size, 0, TD->getPointerSize());
1464 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1465 return Unit->AddDie(Buffer);
1468 /// AddType - Add a new type attribute to the specified entity.
1470 void AddType(DIE *Entity, TypeDesc *TyDesc, CompileUnit *Unit) {
1472 AddBasicType(Entity, Unit, "", DW_ATE_signed, sizeof(int32_t));
1474 // Check for pre-existence.
1475 DIEntry *&Slot = Unit->getDIEntrySlotFor(TyDesc);
1477 // If it exists then use the existing value.
1479 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1483 if (SubprogramDesc *SubprogramTy = dyn_cast<SubprogramDesc>(TyDesc)) {
1484 // FIXME - Not sure why programs and variables are coming through here.
1485 // Short cut for handling subprogram types (not really a TyDesc.)
1486 AddPointerType(Entity, Unit, SubprogramTy->getName());
1487 } else if (GlobalVariableDesc *GlobalTy =
1488 dyn_cast<GlobalVariableDesc>(TyDesc)) {
1489 // FIXME - Not sure why programs and variables are coming through here.
1490 // Short cut for handling global variable types (not really a TyDesc.)
1491 AddPointerType(Entity, Unit, GlobalTy->getName());
1494 Slot = NewDIEntry();
1497 DIE Buffer(DW_TAG_base_type);
1498 ConstructType(Buffer, TyDesc, Unit);
1500 // Add debug information entry to entity and unit.
1501 DIE *Die = Unit->AddDie(Buffer);
1502 SetDIEntry(Slot, Die);
1503 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1508 /// ConstructType - Adds all the required attributes to the type.
1510 void ConstructType(DIE &Buffer, TypeDesc *TyDesc, CompileUnit *Unit) {
1511 // Get core information.
1512 const std::string &Name = TyDesc->getName();
1513 uint64_t Size = TyDesc->getSize() >> 3;
1515 if (BasicTypeDesc *BasicTy = dyn_cast<BasicTypeDesc>(TyDesc)) {
1516 // Fundamental types like int, float, bool
1517 Buffer.setTag(DW_TAG_base_type);
1518 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, BasicTy->getEncoding());
1519 } else if (DerivedTypeDesc *DerivedTy = dyn_cast<DerivedTypeDesc>(TyDesc)) {
1521 unsigned Tag = DerivedTy->getTag();
1522 // FIXME - Workaround for templates.
1523 if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
1524 // Pointers, typedefs et al.
1526 // Map to main type, void will not have a type.
1527 if (TypeDesc *FromTy = DerivedTy->getFromType())
1528 AddType(&Buffer, FromTy, Unit);
1529 } else if (CompositeTypeDesc *CompTy = dyn_cast<CompositeTypeDesc>(TyDesc)){
1531 unsigned Tag = CompTy->getTag();
1533 // Set tag accordingly.
1534 if (Tag == DW_TAG_vector_type)
1535 Buffer.setTag(DW_TAG_array_type);
1539 std::vector<DebugInfoDesc *> &Elements = CompTy->getElements();
1542 case DW_TAG_vector_type:
1543 AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1545 case DW_TAG_array_type: {
1546 // Add element type.
1547 if (TypeDesc *FromTy = CompTy->getFromType())
1548 AddType(&Buffer, FromTy, Unit);
1550 // Don't emit size attribute.
1553 // Construct an anonymous type for index type.
1554 DIE *IndexTy = ConstructBasicType(Unit, "", DW_ATE_signed,
1557 // Add subranges to array type.
1558 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1559 SubrangeDesc *SRD = cast<SubrangeDesc>(Elements[i]);
1560 int64_t Lo = SRD->getLo();
1561 int64_t Hi = SRD->getHi();
1562 DIE *Subrange = new DIE(DW_TAG_subrange_type);
1564 // If a range is available.
1566 AddDIEntry(Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1567 // Only add low if non-zero.
1568 if (Lo) AddSInt(Subrange, DW_AT_lower_bound, 0, Lo);
1569 AddSInt(Subrange, DW_AT_upper_bound, 0, Hi);
1572 Buffer.AddChild(Subrange);
1576 case DW_TAG_structure_type:
1577 case DW_TAG_union_type: {
1578 // Add elements to structure type.
1579 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1580 DebugInfoDesc *Element = Elements[i];
1582 if (DerivedTypeDesc *MemberDesc = dyn_cast<DerivedTypeDesc>(Element)){
1583 // Add field or base class.
1585 unsigned Tag = MemberDesc->getTag();
1587 // Extract the basic information.
1588 const std::string &Name = MemberDesc->getName();
1589 uint64_t Size = MemberDesc->getSize();
1590 uint64_t Align = MemberDesc->getAlign();
1591 uint64_t Offset = MemberDesc->getOffset();
1593 // Construct member debug information entry.
1594 DIE *Member = new DIE(Tag);
1596 // Add name if not "".
1598 AddString(Member, DW_AT_name, DW_FORM_string, Name);
1599 // Add location if available.
1600 AddSourceLine(Member, MemberDesc->getFile(), MemberDesc->getLine());
1602 // Most of the time the field info is the same as the members.
1603 uint64_t FieldSize = Size;
1604 uint64_t FieldAlign = Align;
1605 uint64_t FieldOffset = Offset;
1607 // Set the member type.
1608 TypeDesc *FromTy = MemberDesc->getFromType();
1609 AddType(Member, FromTy, Unit);
1611 // Walk up typedefs until a real size is found.
1613 if (FromTy->getTag() != DW_TAG_typedef) {
1614 FieldSize = FromTy->getSize();
1615 FieldAlign = FromTy->getSize();
1619 FromTy = cast<DerivedTypeDesc>(FromTy)->getFromType();
1622 // Unless we have a bit field.
1623 if (Tag == DW_TAG_member && FieldSize != Size) {
1624 // Construct the alignment mask.
1625 uint64_t AlignMask = ~(FieldAlign - 1);
1626 // Determine the high bit + 1 of the declared size.
1627 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1628 // Work backwards to determine the base offset of the field.
1629 FieldOffset = HiMark - FieldSize;
1630 // Now normalize offset to the field.
1631 Offset -= FieldOffset;
1633 // Maybe we need to work from the other end.
1634 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
1636 // Add size and offset.
1637 AddUInt(Member, DW_AT_byte_size, 0, FieldSize >> 3);
1638 AddUInt(Member, DW_AT_bit_size, 0, Size);
1639 AddUInt(Member, DW_AT_bit_offset, 0, Offset);
1642 // Add computation for offset.
1643 DIEBlock *Block = new DIEBlock();
1644 AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
1645 AddUInt(Block, 0, DW_FORM_udata, FieldOffset >> 3);
1646 AddBlock(Member, DW_AT_data_member_location, 0, Block);
1648 // Add accessibility (public default unless is base class.
1649 if (MemberDesc->isProtected()) {
1650 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_protected);
1651 } else if (MemberDesc->isPrivate()) {
1652 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_private);
1653 } else if (Tag == DW_TAG_inheritance) {
1654 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_public);
1657 Buffer.AddChild(Member);
1658 } else if (GlobalVariableDesc *StaticDesc =
1659 dyn_cast<GlobalVariableDesc>(Element)) {
1660 // Add static member.
1662 // Construct member debug information entry.
1663 DIE *Static = new DIE(DW_TAG_variable);
1665 // Add name and mangled name.
1666 const std::string &Name = StaticDesc->getName();
1667 const std::string &LinkageName = StaticDesc->getLinkageName();
1668 AddString(Static, DW_AT_name, DW_FORM_string, Name);
1669 if (!LinkageName.empty()) {
1670 AddString(Static, DW_AT_MIPS_linkage_name, DW_FORM_string,
1675 AddSourceLine(Static, StaticDesc->getFile(), StaticDesc->getLine());
1678 if (TypeDesc *StaticTy = StaticDesc->getType())
1679 AddType(Static, StaticTy, Unit);
1682 if (!StaticDesc->isStatic())
1683 AddUInt(Static, DW_AT_external, DW_FORM_flag, 1);
1684 AddUInt(Static, DW_AT_declaration, DW_FORM_flag, 1);
1686 Buffer.AddChild(Static);
1687 } else if (SubprogramDesc *MethodDesc =
1688 dyn_cast<SubprogramDesc>(Element)) {
1689 // Add member function.
1691 // Construct member debug information entry.
1692 DIE *Method = new DIE(DW_TAG_subprogram);
1694 // Add name and mangled name.
1695 const std::string &Name = MethodDesc->getName();
1696 const std::string &LinkageName = MethodDesc->getLinkageName();
1698 AddString(Method, DW_AT_name, DW_FORM_string, Name);
1699 bool IsCTor = TyDesc->getName() == Name;
1701 if (!LinkageName.empty()) {
1702 AddString(Method, DW_AT_MIPS_linkage_name, DW_FORM_string,
1707 AddSourceLine(Method, MethodDesc->getFile(), MethodDesc->getLine());
1710 if (CompositeTypeDesc *MethodTy =
1711 dyn_cast_or_null<CompositeTypeDesc>(MethodDesc->getType())) {
1712 // Get argument information.
1713 std::vector<DebugInfoDesc *> &Args = MethodTy->getElements();
1718 AddType(Method, dyn_cast<TypeDesc>(Args[0]), Unit);
1722 for(unsigned i = 1, N = Args.size(); i < N; ++i) {
1723 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1724 AddType(Arg, cast<TypeDesc>(Args[i]), Unit);
1725 AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1);
1726 Method->AddChild(Arg);
1731 if (!MethodDesc->isStatic())
1732 AddUInt(Method, DW_AT_external, DW_FORM_flag, 1);
1733 AddUInt(Method, DW_AT_declaration, DW_FORM_flag, 1);
1735 Buffer.AddChild(Method);
1740 case DW_TAG_enumeration_type: {
1741 // Add enumerators to enumeration type.
1742 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1743 EnumeratorDesc *ED = cast<EnumeratorDesc>(Elements[i]);
1744 const std::string &Name = ED->getName();
1745 int64_t Value = ED->getValue();
1746 DIE *Enumerator = new DIE(DW_TAG_enumerator);
1747 AddString(Enumerator, DW_AT_name, DW_FORM_string, Name);
1748 AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
1749 Buffer.AddChild(Enumerator);
1754 case DW_TAG_subroutine_type: {
1755 // Add prototype flag.
1756 AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
1758 AddType(&Buffer, dyn_cast<TypeDesc>(Elements[0]), Unit);
1761 for(unsigned i = 1, N = Elements.size(); i < N; ++i) {
1762 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1763 AddType(Arg, cast<TypeDesc>(Elements[i]), Unit);
1764 Buffer.AddChild(Arg);
1773 // Add size if non-zero (derived types don't have a size.)
1774 if (Size) AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1775 // Add name if not anonymous or intermediate type.
1776 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1777 // Add source line info if available.
1778 AddSourceLine(&Buffer, TyDesc->getFile(), TyDesc->getLine());
1781 /// NewCompileUnit - Create new compile unit and it's debug information entry.
1783 CompileUnit *NewCompileUnit(CompileUnitDesc *UnitDesc, unsigned ID) {
1784 // Construct debug information entry.
1785 DIE *Die = new DIE(DW_TAG_compile_unit);
1786 AddSectionOffset(Die, DW_AT_stmt_list, DW_FORM_data4,
1787 DWLabel("section_line", 0), DWLabel("section_line", 0), false);
1788 AddString(Die, DW_AT_producer, DW_FORM_string, UnitDesc->getProducer());
1789 AddUInt (Die, DW_AT_language, DW_FORM_data1, UnitDesc->getLanguage());
1790 AddString(Die, DW_AT_name, DW_FORM_string, UnitDesc->getFileName());
1791 AddString(Die, DW_AT_comp_dir, DW_FORM_string, UnitDesc->getDirectory());
1793 // Construct compile unit.
1794 CompileUnit *Unit = new CompileUnit(UnitDesc, ID, Die);
1796 // Add Unit to compile unit map.
1797 DescToUnitMap[UnitDesc] = Unit;
1802 /// GetBaseCompileUnit - Get the main compile unit.
1804 CompileUnit *GetBaseCompileUnit() const {
1805 CompileUnit *Unit = CompileUnits[0];
1806 assert(Unit && "Missing compile unit.");
1810 /// FindCompileUnit - Get the compile unit for the given descriptor.
1812 CompileUnit *FindCompileUnit(CompileUnitDesc *UnitDesc) {
1813 CompileUnit *Unit = DescToUnitMap[UnitDesc];
1814 assert(Unit && "Missing compile unit.");
1818 /// NewGlobalVariable - Add a new global variable DIE.
1820 DIE *NewGlobalVariable(GlobalVariableDesc *GVD) {
1821 // Get the compile unit context.
1822 CompileUnitDesc *UnitDesc =
1823 static_cast<CompileUnitDesc *>(GVD->getContext());
1824 CompileUnit *Unit = GetBaseCompileUnit();
1826 // Check for pre-existence.
1827 DIE *&Slot = Unit->getDieMapSlotFor(GVD);
1828 if (Slot) return Slot;
1830 // Get the global variable itself.
1831 GlobalVariable *GV = GVD->getGlobalVariable();
1833 const std::string &Name = GVD->getName();
1834 const std::string &FullName = GVD->getFullName();
1835 const std::string &LinkageName = GVD->getLinkageName();
1836 // Create the global's variable DIE.
1837 DIE *VariableDie = new DIE(DW_TAG_variable);
1838 AddString(VariableDie, DW_AT_name, DW_FORM_string, Name);
1839 if (!LinkageName.empty()) {
1840 AddString(VariableDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
1843 AddType(VariableDie, GVD->getType(), Unit);
1844 if (!GVD->isStatic())
1845 AddUInt(VariableDie, DW_AT_external, DW_FORM_flag, 1);
1847 // Add source line info if available.
1848 AddSourceLine(VariableDie, UnitDesc, GVD->getLine());
1851 DIEBlock *Block = new DIEBlock();
1852 AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
1853 AddObjectLabel(Block, 0, DW_FORM_udata, Asm->getGlobalLinkName(GV));
1854 AddBlock(VariableDie, DW_AT_location, 0, Block);
1859 // Add to context owner.
1860 Unit->getDie()->AddChild(VariableDie);
1862 // Expose as global.
1863 // FIXME - need to check external flag.
1864 Unit->AddGlobal(FullName, VariableDie);
1869 /// NewSubprogram - Add a new subprogram DIE.
1871 DIE *NewSubprogram(SubprogramDesc *SPD) {
1872 // Get the compile unit context.
1873 CompileUnitDesc *UnitDesc =
1874 static_cast<CompileUnitDesc *>(SPD->getContext());
1875 CompileUnit *Unit = GetBaseCompileUnit();
1877 // Check for pre-existence.
1878 DIE *&Slot = Unit->getDieMapSlotFor(SPD);
1879 if (Slot) return Slot;
1881 // Gather the details (simplify add attribute code.)
1882 const std::string &Name = SPD->getName();
1883 const std::string &FullName = SPD->getFullName();
1884 const std::string &LinkageName = SPD->getLinkageName();
1886 DIE *SubprogramDie = new DIE(DW_TAG_subprogram);
1887 AddString(SubprogramDie, DW_AT_name, DW_FORM_string, Name);
1888 if (!LinkageName.empty()) {
1889 AddString(SubprogramDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
1892 if (SPD->getType()) AddType(SubprogramDie, SPD->getType(), Unit);
1893 if (!SPD->isStatic())
1894 AddUInt(SubprogramDie, DW_AT_external, DW_FORM_flag, 1);
1895 AddUInt(SubprogramDie, DW_AT_prototyped, DW_FORM_flag, 1);
1897 // Add source line info if available.
1898 AddSourceLine(SubprogramDie, UnitDesc, SPD->getLine());
1901 Slot = SubprogramDie;
1903 // Add to context owner.
1904 Unit->getDie()->AddChild(SubprogramDie);
1906 // Expose as global.
1907 Unit->AddGlobal(FullName, SubprogramDie);
1909 return SubprogramDie;
1912 /// NewScopeVariable - Create a new scope variable.
1914 DIE *NewScopeVariable(DebugVariable *DV, CompileUnit *Unit) {
1915 // Get the descriptor.
1916 VariableDesc *VD = DV->getDesc();
1918 // Translate tag to proper Dwarf tag. The result variable is dropped for
1921 switch (VD->getTag()) {
1922 case DW_TAG_return_variable: return NULL;
1923 case DW_TAG_arg_variable: Tag = DW_TAG_formal_parameter; break;
1924 case DW_TAG_auto_variable: // fall thru
1925 default: Tag = DW_TAG_variable; break;
1928 // Define variable debug information entry.
1929 DIE *VariableDie = new DIE(Tag);
1930 AddString(VariableDie, DW_AT_name, DW_FORM_string, VD->getName());
1932 // Add source line info if available.
1933 AddSourceLine(VariableDie, VD->getFile(), VD->getLine());
1935 // Add variable type.
1936 AddType(VariableDie, VD->getType(), Unit);
1938 // Add variable address.
1939 MachineLocation Location;
1940 Location.set(RI->getFrameRegister(*MF),
1941 RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
1942 AddAddress(VariableDie, DW_AT_location, Location);
1947 /// ConstructScope - Construct the components of a scope.
1949 void ConstructScope(DebugScope *ParentScope,
1950 unsigned ParentStartID, unsigned ParentEndID,
1951 DIE *ParentDie, CompileUnit *Unit) {
1952 // Add variables to scope.
1953 std::vector<DebugVariable *> &Variables = ParentScope->getVariables();
1954 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
1955 DIE *VariableDie = NewScopeVariable(Variables[i], Unit);
1956 if (VariableDie) ParentDie->AddChild(VariableDie);
1959 // Add nested scopes.
1960 std::vector<DebugScope *> &Scopes = ParentScope->getScopes();
1961 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1962 // Define the Scope debug information entry.
1963 DebugScope *Scope = Scopes[j];
1964 // FIXME - Ignore inlined functions for the time being.
1965 if (!Scope->getParent()) continue;
1967 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
1968 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
1970 // Ignore empty scopes.
1971 if (StartID == EndID && StartID != 0) continue;
1972 if (Scope->getScopes().empty() && Scope->getVariables().empty()) continue;
1974 if (StartID == ParentStartID && EndID == ParentEndID) {
1975 // Just add stuff to the parent scope.
1976 ConstructScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
1978 DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
1980 // Add the scope bounds.
1982 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
1983 DWLabel("label", StartID));
1985 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
1986 DWLabel("func_begin", SubprogramCount));
1989 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
1990 DWLabel("label", EndID));
1992 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
1993 DWLabel("func_end", SubprogramCount));
1996 // Add the scope contents.
1997 ConstructScope(Scope, StartID, EndID, ScopeDie, Unit);
1998 ParentDie->AddChild(ScopeDie);
2003 /// ConstructRootScope - Construct the scope for the subprogram.
2005 void ConstructRootScope(DebugScope *RootScope) {
2006 // Exit if there is no root scope.
2007 if (!RootScope) return;
2009 // Get the subprogram debug information entry.
2010 SubprogramDesc *SPD = cast<SubprogramDesc>(RootScope->getDesc());
2012 // Get the compile unit context.
2013 CompileUnit *Unit = GetBaseCompileUnit();
2015 // Get the subprogram die.
2016 DIE *SPDie = Unit->getDieMapSlotFor(SPD);
2017 assert(SPDie && "Missing subprogram descriptor");
2019 // Add the function bounds.
2020 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2021 DWLabel("func_begin", SubprogramCount));
2022 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2023 DWLabel("func_end", SubprogramCount));
2024 MachineLocation Location(RI->getFrameRegister(*MF));
2025 AddAddress(SPDie, DW_AT_frame_base, Location);
2027 ConstructScope(RootScope, 0, 0, SPDie, Unit);
2030 /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
2031 /// tools to recognize the object file contains Dwarf information.
2032 void EmitInitial() {
2033 // Check to see if we already emitted intial headers.
2034 if (didInitial) return;
2037 // Dwarf sections base addresses.
2038 if (TAI->doesDwarfRequireFrameSection()) {
2039 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2040 EmitLabel("section_debug_frame", 0);
2042 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2043 EmitLabel("section_info", 0);
2044 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2045 EmitLabel("section_abbrev", 0);
2046 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2047 EmitLabel("section_aranges", 0);
2048 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2049 EmitLabel("section_macinfo", 0);
2050 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2051 EmitLabel("section_line", 0);
2052 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2053 EmitLabel("section_loc", 0);
2054 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2055 EmitLabel("section_pubnames", 0);
2056 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2057 EmitLabel("section_str", 0);
2058 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2059 EmitLabel("section_ranges", 0);
2061 Asm->SwitchToTextSection(TAI->getTextSection());
2062 EmitLabel("text_begin", 0);
2063 Asm->SwitchToDataSection(TAI->getDataSection());
2064 EmitLabel("data_begin", 0);
2067 /// EmitDIE - Recusively Emits a debug information entry.
2069 void EmitDIE(DIE *Die) {
2070 // Get the abbreviation for this DIE.
2071 unsigned AbbrevNumber = Die->getAbbrevNumber();
2072 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2076 // Emit the code (index) for the abbreviation.
2077 Asm->EmitULEB128Bytes(AbbrevNumber);
2078 Asm->EOL(std::string("Abbrev [" +
2079 utostr(AbbrevNumber) +
2080 "] 0x" + utohexstr(Die->getOffset()) +
2081 ":0x" + utohexstr(Die->getSize()) + " " +
2082 TagString(Abbrev->getTag())));
2084 std::vector<DIEValue *> &Values = Die->getValues();
2085 const std::vector<DIEAbbrevData> &AbbrevData = Abbrev->getData();
2087 // Emit the DIE attribute values.
2088 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2089 unsigned Attr = AbbrevData[i].getAttribute();
2090 unsigned Form = AbbrevData[i].getForm();
2091 assert(Form && "Too many attributes for DIE (check abbreviation)");
2094 case DW_AT_sibling: {
2095 Asm->EmitInt32(Die->SiblingOffset());
2099 // Emit an attribute using the defined form.
2100 Values[i]->EmitValue(*this, Form);
2105 Asm->EOL(AttributeString(Attr));
2108 // Emit the DIE children if any.
2109 if (Abbrev->getChildrenFlag() == DW_CHILDREN_yes) {
2110 const std::vector<DIE *> &Children = Die->getChildren();
2112 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2113 EmitDIE(Children[j]);
2116 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2120 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
2122 unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
2123 // Get the children.
2124 const std::vector<DIE *> &Children = Die->getChildren();
2126 // If not last sibling and has children then add sibling offset attribute.
2127 if (!Last && !Children.empty()) Die->AddSiblingOffset();
2129 // Record the abbreviation.
2130 AssignAbbrevNumber(Die->getAbbrev());
2132 // Get the abbreviation for this DIE.
2133 unsigned AbbrevNumber = Die->getAbbrevNumber();
2134 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2137 Die->setOffset(Offset);
2139 // Start the size with the size of abbreviation code.
2140 Offset += Asm->SizeULEB128(AbbrevNumber);
2142 const std::vector<DIEValue *> &Values = Die->getValues();
2143 const std::vector<DIEAbbrevData> &AbbrevData = Abbrev->getData();
2145 // Size the DIE attribute values.
2146 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2147 // Size attribute value.
2148 Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
2151 // Size the DIE children if any.
2152 if (!Children.empty()) {
2153 assert(Abbrev->getChildrenFlag() == DW_CHILDREN_yes &&
2154 "Children flag not set");
2156 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2157 Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
2160 // End of children marker.
2161 Offset += sizeof(int8_t);
2164 Die->setSize(Offset - Die->getOffset());
2168 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
2170 void SizeAndOffsets() {
2171 // Process base compile unit.
2172 CompileUnit *Unit = GetBaseCompileUnit();
2173 // Compute size of compile unit header
2174 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2175 sizeof(int16_t) + // DWARF version number
2176 sizeof(int32_t) + // Offset Into Abbrev. Section
2177 sizeof(int8_t); // Pointer Size (in bytes)
2178 SizeAndOffsetDie(Unit->getDie(), Offset, true);
2181 /// EmitDebugInfo - Emit the debug info section.
2183 void EmitDebugInfo() {
2184 // Start debug info section.
2185 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2187 CompileUnit *Unit = GetBaseCompileUnit();
2188 DIE *Die = Unit->getDie();
2189 // Emit the compile units header.
2190 EmitLabel("info_begin", Unit->getID());
2191 // Emit size of content not including length itself
2192 unsigned ContentSize = Die->getSize() +
2193 sizeof(int16_t) + // DWARF version number
2194 sizeof(int32_t) + // Offset Into Abbrev. Section
2195 sizeof(int8_t) + // Pointer Size (in bytes)
2196 sizeof(int32_t); // FIXME - extra pad for gdb bug.
2198 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2199 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2200 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2201 Asm->EOL("Offset Into Abbrev. Section");
2202 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2205 // FIXME - extra padding for gdb bug.
2206 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2207 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2208 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2209 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2210 EmitLabel("info_end", Unit->getID());
2215 /// EmitAbbreviations - Emit the abbreviation section.
2217 void EmitAbbreviations() const {
2218 // Check to see if it is worth the effort.
2219 if (!Abbreviations.empty()) {
2220 // Start the debug abbrev section.
2221 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2223 EmitLabel("abbrev_begin", 0);
2225 // For each abbrevation.
2226 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2227 // Get abbreviation data
2228 const DIEAbbrev *Abbrev = Abbreviations[i];
2230 // Emit the abbrevations code (base 1 index.)
2231 Asm->EmitULEB128Bytes(Abbrev->getNumber());
2232 Asm->EOL("Abbreviation Code");
2234 // Emit the abbreviations data.
2235 Abbrev->Emit(*this);
2240 // Mark end of abbreviations.
2241 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2243 EmitLabel("abbrev_end", 0);
2249 /// EmitDebugLines - Emit source line information.
2251 void EmitDebugLines() {
2252 // If there are no lines to emit (such as when we're using .loc directives
2253 // to emit .debug_line information) don't emit a .debug_line header.
2254 if (SectionSourceLines.empty())
2257 // Minimum line delta, thus ranging from -10..(255-10).
2258 const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
2259 // Maximum line delta, thus ranging from -10..(255-10).
2260 const int MaxLineDelta = 255 + MinLineDelta;
2262 // Start the dwarf line section.
2263 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2265 // Construct the section header.
2267 EmitDifference("line_end", 0, "line_begin", 0, true);
2268 Asm->EOL("Length of Source Line Info");
2269 EmitLabel("line_begin", 0);
2271 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2273 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2274 Asm->EOL("Prolog Length");
2275 EmitLabel("line_prolog_begin", 0);
2277 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2279 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2281 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
2283 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2285 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
2287 // Line number standard opcode encodings argument count
2288 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2289 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2290 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2291 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2292 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2293 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2294 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2295 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2296 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2298 const UniqueVector<std::string> &Directories = MMI->getDirectories();
2299 const UniqueVector<SourceFileInfo>
2300 &SourceFiles = MMI->getSourceFiles();
2302 // Emit directories.
2303 for (unsigned DirectoryID = 1, NDID = Directories.size();
2304 DirectoryID <= NDID; ++DirectoryID) {
2305 Asm->EmitString(Directories[DirectoryID]); Asm->EOL("Directory");
2307 Asm->EmitInt8(0); Asm->EOL("End of directories");
2310 for (unsigned SourceID = 1, NSID = SourceFiles.size();
2311 SourceID <= NSID; ++SourceID) {
2312 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
2313 Asm->EmitString(SourceFile.getName());
2315 Asm->EmitULEB128Bytes(SourceFile.getDirectoryID());
2316 Asm->EOL("Directory #");
2317 Asm->EmitULEB128Bytes(0);
2318 Asm->EOL("Mod date");
2319 Asm->EmitULEB128Bytes(0);
2320 Asm->EOL("File size");
2322 Asm->EmitInt8(0); Asm->EOL("End of files");
2324 EmitLabel("line_prolog_end", 0);
2326 // A sequence for each text section.
2327 for (unsigned j = 0, M = SectionSourceLines.size(); j < M; ++j) {
2328 // Isolate current sections line info.
2329 const std::vector<SourceLineInfo> &LineInfos = SectionSourceLines[j];
2331 Asm->EOL(std::string("Section ") + SectionMap[j + 1]);
2333 // Dwarf assumes we start with first line of first source file.
2334 unsigned Source = 1;
2337 // Construct rows of the address, source, line, column matrix.
2338 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2339 const SourceLineInfo &LineInfo = LineInfos[i];
2340 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2341 if (!LabelID) continue;
2343 unsigned SourceID = LineInfo.getSourceID();
2344 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
2345 unsigned DirectoryID = SourceFile.getDirectoryID();
2346 Asm->EOL(Directories[DirectoryID]
2347 + SourceFile.getName()
2349 + utostr_32(LineInfo.getLine()));
2351 // Define the line address.
2352 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2353 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2354 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2355 EmitReference("label", LabelID); Asm->EOL("Location label");
2357 // If change of source, then switch to the new source.
2358 if (Source != LineInfo.getSourceID()) {
2359 Source = LineInfo.getSourceID();
2360 Asm->EmitInt8(DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2361 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2364 // If change of line.
2365 if (Line != LineInfo.getLine()) {
2366 // Determine offset.
2367 int Offset = LineInfo.getLine() - Line;
2368 int Delta = Offset - MinLineDelta;
2371 Line = LineInfo.getLine();
2373 // If delta is small enough and in range...
2374 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2375 // ... then use fast opcode.
2376 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2378 // ... otherwise use long hand.
2379 Asm->EmitInt8(DW_LNS_advance_line); Asm->EOL("DW_LNS_advance_line");
2380 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2381 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2384 // Copy the previous row (different address or source)
2385 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2389 // Define last address of section.
2390 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2391 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2392 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2393 EmitReference("section_end", j + 1); Asm->EOL("Section end label");
2395 // Mark end of matrix.
2396 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2397 Asm->EmitULEB128Bytes(1); Asm->EOL();
2398 Asm->EmitInt8(1); Asm->EOL();
2401 EmitLabel("line_end", 0);
2406 /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
2408 void EmitCommonDebugFrame() {
2409 if (!TAI->doesDwarfRequireFrameSection())
2413 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2414 TargetFrameInfo::StackGrowsUp ?
2415 TD->getPointerSize() : -TD->getPointerSize();
2417 // Start the dwarf frame section.
2418 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2420 EmitLabel("debug_frame_common", 0);
2421 EmitDifference("debug_frame_common_end", 0,
2422 "debug_frame_common_begin", 0, true);
2423 Asm->EOL("Length of Common Information Entry");
2425 EmitLabel("debug_frame_common_begin", 0);
2426 Asm->EmitInt32((int)DW_CIE_ID);
2427 Asm->EOL("CIE Identifier Tag");
2428 Asm->EmitInt8(DW_CIE_VERSION);
2429 Asm->EOL("CIE Version");
2430 Asm->EmitString("");
2431 Asm->EOL("CIE Augmentation");
2432 Asm->EmitULEB128Bytes(1);
2433 Asm->EOL("CIE Code Alignment Factor");
2434 Asm->EmitSLEB128Bytes(stackGrowth);
2435 Asm->EOL("CIE Data Alignment Factor");
2436 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
2437 Asm->EOL("CIE RA Column");
2439 std::vector<MachineMove> Moves;
2440 RI->getInitialFrameState(Moves);
2442 EmitFrameMoves(NULL, 0, Moves, false);
2444 Asm->EmitAlignment(2, 0, 0, false);
2445 EmitLabel("debug_frame_common_end", 0);
2450 /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2452 void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
2453 if (!TAI->doesDwarfRequireFrameSection())
2456 // Start the dwarf frame section.
2457 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2459 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2460 "debug_frame_begin", DebugFrameInfo.Number, true);
2461 Asm->EOL("Length of Frame Information Entry");
2463 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2465 EmitSectionOffset("debug_frame_common", "section_debug_frame",
2467 Asm->EOL("FDE CIE offset");
2469 EmitReference("func_begin", DebugFrameInfo.Number);
2470 Asm->EOL("FDE initial location");
2471 EmitDifference("func_end", DebugFrameInfo.Number,
2472 "func_begin", DebugFrameInfo.Number);
2473 Asm->EOL("FDE address range");
2475 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves, false);
2477 Asm->EmitAlignment(2, 0, 0, false);
2478 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
2483 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
2485 void EmitDebugPubNames() {
2486 // Start the dwarf pubnames section.
2487 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2489 CompileUnit *Unit = GetBaseCompileUnit();
2491 EmitDifference("pubnames_end", Unit->getID(),
2492 "pubnames_begin", Unit->getID(), true);
2493 Asm->EOL("Length of Public Names Info");
2495 EmitLabel("pubnames_begin", Unit->getID());
2497 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF Version");
2499 EmitSectionOffset("info_begin", "section_info",
2500 Unit->getID(), 0, true, false);
2501 Asm->EOL("Offset of Compilation Unit Info");
2503 EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(),true);
2504 Asm->EOL("Compilation Unit Length");
2506 std::map<std::string, DIE *> &Globals = Unit->getGlobals();
2508 for (std::map<std::string, DIE *>::iterator GI = Globals.begin(),
2511 const std::string &Name = GI->first;
2512 DIE * Entity = GI->second;
2514 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2515 Asm->EmitString(Name); Asm->EOL("External Name");
2518 Asm->EmitInt32(0); Asm->EOL("End Mark");
2519 EmitLabel("pubnames_end", Unit->getID());
2524 /// EmitDebugStr - Emit visible names into a debug str section.
2526 void EmitDebugStr() {
2527 // Check to see if it is worth the effort.
2528 if (!StringPool.empty()) {
2529 // Start the dwarf str section.
2530 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2532 // For each of strings in the string pool.
2533 for (unsigned StringID = 1, N = StringPool.size();
2534 StringID <= N; ++StringID) {
2535 // Emit a label for reference from debug information entries.
2536 EmitLabel("string", StringID);
2537 // Emit the string itself.
2538 const std::string &String = StringPool[StringID];
2539 Asm->EmitString(String); Asm->EOL();
2546 /// EmitDebugLoc - Emit visible names into a debug loc section.
2548 void EmitDebugLoc() {
2549 // Start the dwarf loc section.
2550 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2555 /// EmitDebugARanges - Emit visible names into a debug aranges section.
2557 void EmitDebugARanges() {
2558 // Start the dwarf aranges section.
2559 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2563 CompileUnit *Unit = GetBaseCompileUnit();
2565 // Don't include size of length
2566 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
2568 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("Dwarf Version");
2570 EmitReference("info_begin", Unit->getID());
2571 Asm->EOL("Offset of Compilation Unit Info");
2573 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
2575 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
2577 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
2578 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
2581 EmitReference("text_begin", 0); Asm->EOL("Address");
2582 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
2584 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2585 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
2591 /// EmitDebugRanges - Emit visible names into a debug ranges section.
2593 void EmitDebugRanges() {
2594 // Start the dwarf ranges section.
2595 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2600 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
2602 void EmitDebugMacInfo() {
2603 // Start the dwarf macinfo section.
2604 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2609 /// ConstructCompileUnitDIEs - Create a compile unit DIE for each source and
2611 void ConstructCompileUnitDIEs() {
2612 const UniqueVector<CompileUnitDesc *> CUW = MMI->getCompileUnits();
2614 for (unsigned i = 1, N = CUW.size(); i <= N; ++i) {
2615 unsigned ID = MMI->RecordSource(CUW[i]);
2616 CompileUnit *Unit = NewCompileUnit(CUW[i], ID);
2617 CompileUnits.push_back(Unit);
2621 /// ConstructGlobalDIEs - Create DIEs for each of the externally visible
2622 /// global variables.
2623 void ConstructGlobalDIEs() {
2624 std::vector<GlobalVariableDesc *> GlobalVariables =
2625 MMI->getAnchoredDescriptors<GlobalVariableDesc>(*M);
2627 for (unsigned i = 0, N = GlobalVariables.size(); i < N; ++i) {
2628 GlobalVariableDesc *GVD = GlobalVariables[i];
2629 NewGlobalVariable(GVD);
2633 /// ConstructSubprogramDIEs - Create DIEs for each of the externally visible
2635 void ConstructSubprogramDIEs() {
2636 std::vector<SubprogramDesc *> Subprograms =
2637 MMI->getAnchoredDescriptors<SubprogramDesc>(*M);
2639 for (unsigned i = 0, N = Subprograms.size(); i < N; ++i) {
2640 SubprogramDesc *SPD = Subprograms[i];
2646 //===--------------------------------------------------------------------===//
2647 // Main entry points.
2649 DwarfDebug(std::ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
2650 : Dwarf(OS, A, T, "dbg")
2652 , AbbreviationsSet(InitAbbreviationsSetSize)
2654 , ValuesSet(InitValuesSetSize)
2659 , SectionSourceLines()
2664 virtual ~DwarfDebug() {
2665 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i)
2666 delete CompileUnits[i];
2667 for (unsigned j = 0, M = Values.size(); j < M; ++j)
2671 /// SetModuleInfo - Set machine module information when it's known that pass
2672 /// manager has created it. Set by the target AsmPrinter.
2673 void SetModuleInfo(MachineModuleInfo *mmi) {
2674 // Make sure initial declarations are made.
2675 if (!MMI && mmi->hasDebugInfo()) {
2679 // Create all the compile unit DIEs.
2680 ConstructCompileUnitDIEs();
2682 // Create DIEs for each of the externally visible global variables.
2683 ConstructGlobalDIEs();
2685 // Create DIEs for each of the externally visible subprograms.
2686 ConstructSubprogramDIEs();
2688 // Prime section data.
2689 SectionMap.insert(TAI->getTextSection());
2691 // Print out .file directives to specify files for .loc directives. These
2692 // are printed out early so that they precede any .loc directives.
2693 if (TAI->hasDotLocAndDotFile()) {
2694 const UniqueVector<SourceFileInfo> &SourceFiles = MMI->getSourceFiles();
2695 const UniqueVector<std::string> &Directories = MMI->getDirectories();
2696 for (unsigned i = 1, e = SourceFiles.size(); i <= e; ++i) {
2697 sys::Path FullPath(Directories[SourceFiles[i].getDirectoryID()]);
2698 bool AppendOk = FullPath.appendComponent(SourceFiles[i].getName());
2699 assert(AppendOk && "Could not append filename to directory!");
2700 Asm->EmitFile(i, FullPath.toString());
2705 // Emit initial sections
2710 /// BeginModule - Emit all Dwarf sections that should come prior to the
2712 void BeginModule(Module *M) {
2715 if (!ShouldEmitDwarf()) return;
2718 /// EndModule - Emit all Dwarf sections that should come after the content.
2721 if (!ShouldEmitDwarf()) return;
2723 // Standard sections final addresses.
2724 Asm->SwitchToTextSection(TAI->getTextSection());
2725 EmitLabel("text_end", 0);
2726 Asm->SwitchToDataSection(TAI->getDataSection());
2727 EmitLabel("data_end", 0);
2729 // End text sections.
2730 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
2731 Asm->SwitchToTextSection(SectionMap[i].c_str());
2732 EmitLabel("section_end", i);
2735 // Emit common frame information.
2736 EmitCommonDebugFrame();
2738 // Emit function debug frame information
2739 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2740 E = DebugFrames.end(); I != E; ++I)
2741 EmitFunctionDebugFrame(*I);
2743 // Compute DIE offsets and sizes.
2746 // Emit all the DIEs into a debug info section
2749 // Corresponding abbreviations into a abbrev section.
2750 EmitAbbreviations();
2752 // Emit source line correspondence into a debug line section.
2755 // Emit info into a debug pubnames section.
2756 EmitDebugPubNames();
2758 // Emit info into a debug str section.
2761 // Emit info into a debug loc section.
2764 // Emit info into a debug aranges section.
2767 // Emit info into a debug ranges section.
2770 // Emit info into a debug macinfo section.
2774 /// BeginFunction - Gather pre-function debug information. Assumes being
2775 /// emitted immediately after the function entry point.
2776 void BeginFunction(MachineFunction *MF) {
2779 if (!ShouldEmitDwarf()) return;
2781 // Begin accumulating function debug information.
2782 MMI->BeginFunction(MF);
2784 // Assumes in correct section after the entry point.
2785 EmitLabel("func_begin", ++SubprogramCount);
2787 // Emit label for the implicitly defined dbg.stoppoint at the start of
2789 const std::vector<SourceLineInfo> &LineInfos = MMI->getSourceLines();
2790 if (!LineInfos.empty()) {
2791 const SourceLineInfo &LineInfo = LineInfos[0];
2792 Asm->printLabel(LineInfo.getLabelID());
2796 /// EndFunction - Gather and emit post-function debug information.
2798 void EndFunction() {
2799 if (!ShouldEmitDwarf()) return;
2801 // Define end label for subprogram.
2802 EmitLabel("func_end", SubprogramCount);
2804 // Get function line info.
2805 const std::vector<SourceLineInfo> &LineInfos = MMI->getSourceLines();
2807 if (!LineInfos.empty()) {
2808 // Get section line info.
2809 unsigned ID = SectionMap.insert(Asm->CurrentSection);
2810 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2811 std::vector<SourceLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2812 // Append the function info to section info.
2813 SectionLineInfos.insert(SectionLineInfos.end(),
2814 LineInfos.begin(), LineInfos.end());
2817 // Construct scopes for subprogram.
2818 ConstructRootScope(MMI->getRootScope());
2820 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
2821 MMI->getFrameMoves()));
2825 //===----------------------------------------------------------------------===//
2826 /// DwarfException - Emits Dwarf exception handling directives.
2828 class DwarfException : public Dwarf {
2831 struct FunctionEHFrameInfo {
2834 unsigned PersonalityIndex;
2836 bool hasLandingPads;
2837 std::vector<MachineMove> Moves;
2838 const Function * function;
2840 FunctionEHFrameInfo(const std::string &FN, unsigned Num, unsigned P,
2842 const std::vector<MachineMove> &M,
2844 FnName(FN), Number(Num), PersonalityIndex(P),
2845 hasCalls(hC), hasLandingPads(hL), Moves(M), function (f) { }
2848 std::vector<FunctionEHFrameInfo> EHFrames;
2850 /// shouldEmitTable - Per-function flag to indicate if EH tables should
2852 bool shouldEmitTable;
2854 /// shouldEmitMoves - Per-function flag to indicate if frame moves info
2855 /// should be emitted.
2856 bool shouldEmitMoves;
2858 /// shouldEmitTableModule - Per-module flag to indicate if EH tables
2859 /// should be emitted.
2860 bool shouldEmitTableModule;
2862 /// shouldEmitFrameModule - Per-module flag to indicate if frame moves
2863 /// should be emitted.
2864 bool shouldEmitMovesModule;
2866 /// EmitCommonEHFrame - Emit the common eh unwind frame.
2868 void EmitCommonEHFrame(const Function *Personality, unsigned Index) {
2869 // Size and sign of stack growth.
2871 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2872 TargetFrameInfo::StackGrowsUp ?
2873 TD->getPointerSize() : -TD->getPointerSize();
2875 // Begin eh frame section.
2876 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
2877 O << "EH_frame" << Index << ":\n";
2878 EmitLabel("section_eh_frame", Index);
2880 // Define base labels.
2881 EmitLabel("eh_frame_common", Index);
2883 // Define the eh frame length.
2884 EmitDifference("eh_frame_common_end", Index,
2885 "eh_frame_common_begin", Index, true);
2886 Asm->EOL("Length of Common Information Entry");
2889 EmitLabel("eh_frame_common_begin", Index);
2890 Asm->EmitInt32((int)0);
2891 Asm->EOL("CIE Identifier Tag");
2892 Asm->EmitInt8(DW_CIE_VERSION);
2893 Asm->EOL("CIE Version");
2895 // The personality presence indicates that language specific information
2896 // will show up in the eh frame.
2897 Asm->EmitString(Personality ? "zPLR" : "zR");
2898 Asm->EOL("CIE Augmentation");
2900 // Round out reader.
2901 Asm->EmitULEB128Bytes(1);
2902 Asm->EOL("CIE Code Alignment Factor");
2903 Asm->EmitSLEB128Bytes(stackGrowth);
2904 Asm->EOL("CIE Data Alignment Factor");
2905 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), true));
2906 Asm->EOL("CIE Return Address Column");
2908 // If there is a personality, we need to indicate the functions location.
2910 Asm->EmitULEB128Bytes(7);
2911 Asm->EOL("Augmentation Size");
2913 if (TAI->getNeedsIndirectEncoding()) {
2914 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4 | DW_EH_PE_indirect);
2915 Asm->EOL("Personality (pcrel sdata4 indirect)");
2917 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
2918 Asm->EOL("Personality (pcrel sdata4)");
2921 PrintRelDirective(true);
2922 O << TAI->getPersonalityPrefix();
2923 Asm->EmitExternalGlobal((const GlobalVariable *)(Personality));
2924 O << TAI->getPersonalitySuffix();
2925 if (strcmp(TAI->getPersonalitySuffix(), "+4@GOTPCREL"))
2926 O << "-" << TAI->getPCSymbol();
2927 Asm->EOL("Personality");
2929 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
2930 Asm->EOL("LSDA Encoding (pcrel sdata4)");
2931 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
2932 Asm->EOL("FDE Encoding (pcrel sdata4)");
2934 Asm->EmitULEB128Bytes(1);
2935 Asm->EOL("Augmentation Size");
2936 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
2937 Asm->EOL("FDE Encoding (pcrel sdata4)");
2940 // Indicate locations of general callee saved registers in frame.
2941 std::vector<MachineMove> Moves;
2942 RI->getInitialFrameState(Moves);
2943 EmitFrameMoves(NULL, 0, Moves, true);
2945 // On Darwin the linker honors the alignment of eh_frame, which means it
2946 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
2947 // you get holes which confuse readers of eh_frame.
2948 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
2950 EmitLabel("eh_frame_common_end", Index);
2955 /// EmitEHFrame - Emit function exception frame information.
2957 void EmitEHFrame(const FunctionEHFrameInfo &EHFrameInfo) {
2958 Function::LinkageTypes linkage = EHFrameInfo.function->getLinkage();
2960 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
2962 // Externally visible entry into the functions eh frame info.
2963 // If the corresponding function is static, this should not be
2964 // externally visible.
2965 if (linkage != Function::InternalLinkage) {
2966 if (const char *GlobalEHDirective = TAI->getGlobalEHDirective())
2967 O << GlobalEHDirective << EHFrameInfo.FnName << "\n";
2970 // If corresponding function is weak definition, this should be too.
2971 if ((linkage == Function::WeakLinkage ||
2972 linkage == Function::LinkOnceLinkage) &&
2973 TAI->getWeakDefDirective())
2974 O << TAI->getWeakDefDirective() << EHFrameInfo.FnName << "\n";
2976 // If there are no calls then you can't unwind. This may mean we can
2977 // omit the EH Frame, but some environments do not handle weak absolute
2979 // If UnwindTablesMandatory is set we cannot do this optimization; the
2980 // unwind info is to be available for non-EH uses.
2981 if (!EHFrameInfo.hasCalls &&
2982 !UnwindTablesMandatory &&
2983 ((linkage != Function::WeakLinkage &&
2984 linkage != Function::LinkOnceLinkage) ||
2985 !TAI->getWeakDefDirective() ||
2986 TAI->getSupportsWeakOmittedEHFrame()))
2988 O << EHFrameInfo.FnName << " = 0\n";
2989 // This name has no connection to the function, so it might get
2990 // dead-stripped when the function is not, erroneously. Prohibit
2991 // dead-stripping unconditionally.
2992 if (const char *UsedDirective = TAI->getUsedDirective())
2993 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
2995 O << EHFrameInfo.FnName << ":\n";
2998 EmitDifference("eh_frame_end", EHFrameInfo.Number,
2999 "eh_frame_begin", EHFrameInfo.Number, true);
3000 Asm->EOL("Length of Frame Information Entry");
3002 EmitLabel("eh_frame_begin", EHFrameInfo.Number);
3004 EmitSectionOffset("eh_frame_begin", "eh_frame_common",
3005 EHFrameInfo.Number, EHFrameInfo.PersonalityIndex,
3007 Asm->EOL("FDE CIE offset");
3009 EmitReference("eh_func_begin", EHFrameInfo.Number, true, true);
3010 Asm->EOL("FDE initial location");
3011 EmitDifference("eh_func_end", EHFrameInfo.Number,
3012 "eh_func_begin", EHFrameInfo.Number, true);
3013 Asm->EOL("FDE address range");
3015 // If there is a personality and landing pads then point to the language
3016 // specific data area in the exception table.
3017 if (EHFrameInfo.PersonalityIndex) {
3018 Asm->EmitULEB128Bytes(4);
3019 Asm->EOL("Augmentation size");
3021 if (EHFrameInfo.hasLandingPads)
3022 EmitReference("exception", EHFrameInfo.Number, true, true);
3024 Asm->EmitInt32((int)0);
3025 Asm->EOL("Language Specific Data Area");
3027 Asm->EmitULEB128Bytes(0);
3028 Asm->EOL("Augmentation size");
3031 // Indicate locations of function specific callee saved registers in
3033 EmitFrameMoves("eh_func_begin", EHFrameInfo.Number, EHFrameInfo.Moves, true);
3035 // On Darwin the linker honors the alignment of eh_frame, which means it
3036 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3037 // you get holes which confuse readers of eh_frame.
3038 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
3040 EmitLabel("eh_frame_end", EHFrameInfo.Number);
3042 // If the function is marked used, this table should be also. We cannot
3043 // make the mark unconditional in this case, since retaining the table
3044 // also retains the function in this case, and there is code around
3045 // that depends on unused functions (calling undefined externals) being
3046 // dead-stripped to link correctly. Yes, there really is.
3047 if (MMI->getUsedFunctions().count(EHFrameInfo.function))
3048 if (const char *UsedDirective = TAI->getUsedDirective())
3049 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3053 /// EmitExceptionTable - Emit landing pads and actions.
3055 /// The general organization of the table is complex, but the basic concepts
3056 /// are easy. First there is a header which describes the location and
3057 /// organization of the three components that follow.
3058 /// 1. The landing pad site information describes the range of code covered
3059 /// by the try. In our case it's an accumulation of the ranges covered
3060 /// by the invokes in the try. There is also a reference to the landing
3061 /// pad that handles the exception once processed. Finally an index into
3062 /// the actions table.
3063 /// 2. The action table, in our case, is composed of pairs of type ids
3064 /// and next action offset. Starting with the action index from the
3065 /// landing pad site, each type Id is checked for a match to the current
3066 /// exception. If it matches then the exception and type id are passed
3067 /// on to the landing pad. Otherwise the next action is looked up. This
3068 /// chain is terminated with a next action of zero. If no type id is
3069 /// found the the frame is unwound and handling continues.
3070 /// 3. Type id table contains references to all the C++ typeinfo for all
3071 /// catches in the function. This tables is reversed indexed base 1.
3073 /// SharedTypeIds - How many leading type ids two landing pads have in common.
3074 static unsigned SharedTypeIds(const LandingPadInfo *L,
3075 const LandingPadInfo *R) {
3076 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3077 unsigned LSize = LIds.size(), RSize = RIds.size();
3078 unsigned MinSize = LSize < RSize ? LSize : RSize;
3081 for (; Count != MinSize; ++Count)
3082 if (LIds[Count] != RIds[Count])
3088 /// PadLT - Order landing pads lexicographically by type id.
3089 static bool PadLT(const LandingPadInfo *L, const LandingPadInfo *R) {
3090 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3091 unsigned LSize = LIds.size(), RSize = RIds.size();
3092 unsigned MinSize = LSize < RSize ? LSize : RSize;
3094 for (unsigned i = 0; i != MinSize; ++i)
3095 if (LIds[i] != RIds[i])
3096 return LIds[i] < RIds[i];
3098 return LSize < RSize;
3102 static inline unsigned getEmptyKey() { return -1U; }
3103 static inline unsigned getTombstoneKey() { return -2U; }
3104 static unsigned getHashValue(const unsigned &Key) { return Key; }
3105 static bool isEqual(unsigned LHS, unsigned RHS) { return LHS == RHS; }
3106 static bool isPod() { return true; }
3109 /// ActionEntry - Structure describing an entry in the actions table.
3110 struct ActionEntry {
3111 int ValueForTypeID; // The value to write - may not be equal to the type id.
3113 struct ActionEntry *Previous;
3116 /// PadRange - Structure holding a try-range and the associated landing pad.
3118 // The index of the landing pad.
3120 // The index of the begin and end labels in the landing pad's label lists.
3121 unsigned RangeIndex;
3124 typedef DenseMap<unsigned, PadRange, KeyInfo> RangeMapType;
3126 /// CallSiteEntry - Structure describing an entry in the call-site table.
3127 struct CallSiteEntry {
3128 // The 'try-range' is BeginLabel .. EndLabel.
3129 unsigned BeginLabel; // zero indicates the start of the function.
3130 unsigned EndLabel; // zero indicates the end of the function.
3131 // The landing pad starts at PadLabel.
3132 unsigned PadLabel; // zero indicates that there is no landing pad.
3136 void EmitExceptionTable() {
3137 const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
3138 const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
3139 const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
3140 if (PadInfos.empty()) return;
3142 // Sort the landing pads in order of their type ids. This is used to fold
3143 // duplicate actions.
3144 SmallVector<const LandingPadInfo *, 64> LandingPads;
3145 LandingPads.reserve(PadInfos.size());
3146 for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
3147 LandingPads.push_back(&PadInfos[i]);
3148 std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
3150 // Negative type ids index into FilterIds, positive type ids index into
3151 // TypeInfos. The value written for a positive type id is just the type
3152 // id itself. For a negative type id, however, the value written is the
3153 // (negative) byte offset of the corresponding FilterIds entry. The byte
3154 // offset is usually equal to the type id, because the FilterIds entries
3155 // are written using a variable width encoding which outputs one byte per
3156 // entry as long as the value written is not too large, but can differ.
3157 // This kind of complication does not occur for positive type ids because
3158 // type infos are output using a fixed width encoding.
3159 // FilterOffsets[i] holds the byte offset corresponding to FilterIds[i].
3160 SmallVector<int, 16> FilterOffsets;
3161 FilterOffsets.reserve(FilterIds.size());
3163 for(std::vector<unsigned>::const_iterator I = FilterIds.begin(),
3164 E = FilterIds.end(); I != E; ++I) {
3165 FilterOffsets.push_back(Offset);
3166 Offset -= Asm->SizeULEB128(*I);
3169 // Compute the actions table and gather the first action index for each
3170 // landing pad site.
3171 SmallVector<ActionEntry, 32> Actions;
3172 SmallVector<unsigned, 64> FirstActions;
3173 FirstActions.reserve(LandingPads.size());
3175 int FirstAction = 0;
3176 unsigned SizeActions = 0;
3177 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3178 const LandingPadInfo *LP = LandingPads[i];
3179 const std::vector<int> &TypeIds = LP->TypeIds;
3180 const unsigned NumShared = i ? SharedTypeIds(LP, LandingPads[i-1]) : 0;
3181 unsigned SizeSiteActions = 0;
3183 if (NumShared < TypeIds.size()) {
3184 unsigned SizeAction = 0;
3185 ActionEntry *PrevAction = 0;
3188 const unsigned SizePrevIds = LandingPads[i-1]->TypeIds.size();
3189 assert(Actions.size());
3190 PrevAction = &Actions.back();
3191 SizeAction = Asm->SizeSLEB128(PrevAction->NextAction) +
3192 Asm->SizeSLEB128(PrevAction->ValueForTypeID);
3193 for (unsigned j = NumShared; j != SizePrevIds; ++j) {
3194 SizeAction -= Asm->SizeSLEB128(PrevAction->ValueForTypeID);
3195 SizeAction += -PrevAction->NextAction;
3196 PrevAction = PrevAction->Previous;
3200 // Compute the actions.
3201 for (unsigned I = NumShared, M = TypeIds.size(); I != M; ++I) {
3202 int TypeID = TypeIds[I];
3203 assert(-1-TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
3204 int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
3205 unsigned SizeTypeID = Asm->SizeSLEB128(ValueForTypeID);
3207 int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
3208 SizeAction = SizeTypeID + Asm->SizeSLEB128(NextAction);
3209 SizeSiteActions += SizeAction;
3211 ActionEntry Action = {ValueForTypeID, NextAction, PrevAction};
3212 Actions.push_back(Action);
3214 PrevAction = &Actions.back();
3217 // Record the first action of the landing pad site.
3218 FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
3219 } // else identical - re-use previous FirstAction
3221 FirstActions.push_back(FirstAction);
3223 // Compute this sites contribution to size.
3224 SizeActions += SizeSiteActions;
3227 // Compute the call-site table. The entry for an invoke has a try-range
3228 // containing the call, a non-zero landing pad and an appropriate action.
3229 // The entry for an ordinary call has a try-range containing the call and
3230 // zero for the landing pad and the action. Calls marked 'nounwind' have
3231 // no entry and must not be contained in the try-range of any entry - they
3232 // form gaps in the table. Entries must be ordered by try-range address.
3233 SmallVector<CallSiteEntry, 64> CallSites;
3235 RangeMapType PadMap;
3236 // Invokes and nounwind calls have entries in PadMap (due to being bracketed
3237 // by try-range labels when lowered). Ordinary calls do not, so appropriate
3238 // try-ranges for them need be deduced.
3239 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3240 const LandingPadInfo *LandingPad = LandingPads[i];
3241 for (unsigned j = 0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
3242 unsigned BeginLabel = LandingPad->BeginLabels[j];
3243 assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
3244 PadRange P = { i, j };
3245 PadMap[BeginLabel] = P;
3249 // The end label of the previous invoke or nounwind try-range.
3250 unsigned LastLabel = 0;
3252 // Whether there is a potentially throwing instruction (currently this means
3253 // an ordinary call) between the end of the previous try-range and now.
3254 bool SawPotentiallyThrowing = false;
3256 // Whether the last callsite entry was for an invoke.
3257 bool PreviousIsInvoke = false;
3259 // Visit all instructions in order of address.
3260 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
3262 for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
3264 if (MI->getOpcode() != TargetInstrInfo::LABEL) {
3265 SawPotentiallyThrowing |= MI->getDesc().isCall();
3269 unsigned BeginLabel = MI->getOperand(0).getImm();
3270 assert(BeginLabel && "Invalid label!");
3272 // End of the previous try-range?
3273 if (BeginLabel == LastLabel)
3274 SawPotentiallyThrowing = false;
3276 // Beginning of a new try-range?
3277 RangeMapType::iterator L = PadMap.find(BeginLabel);
3278 if (L == PadMap.end())
3279 // Nope, it was just some random label.
3282 PadRange P = L->second;
3283 const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
3285 assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
3286 "Inconsistent landing pad map!");
3288 // If some instruction between the previous try-range and this one may
3289 // throw, create a call-site entry with no landing pad for the region
3290 // between the try-ranges.
3291 if (SawPotentiallyThrowing) {
3292 CallSiteEntry Site = {LastLabel, BeginLabel, 0, 0};
3293 CallSites.push_back(Site);
3294 PreviousIsInvoke = false;
3297 LastLabel = LandingPad->EndLabels[P.RangeIndex];
3298 assert(BeginLabel && LastLabel && "Invalid landing pad!");
3300 if (LandingPad->LandingPadLabel) {
3301 // This try-range is for an invoke.
3302 CallSiteEntry Site = {BeginLabel, LastLabel,
3303 LandingPad->LandingPadLabel, FirstActions[P.PadIndex]};
3305 // Try to merge with the previous call-site.
3306 if (PreviousIsInvoke) {
3307 CallSiteEntry &Prev = CallSites[CallSites.size()-1];
3308 if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
3309 // Extend the range of the previous entry.
3310 Prev.EndLabel = Site.EndLabel;
3315 // Otherwise, create a new call-site.
3316 CallSites.push_back(Site);
3317 PreviousIsInvoke = true;
3320 PreviousIsInvoke = false;
3324 // If some instruction between the previous try-range and the end of the
3325 // function may throw, create a call-site entry with no landing pad for the
3326 // region following the try-range.
3327 if (SawPotentiallyThrowing) {
3328 CallSiteEntry Site = {LastLabel, 0, 0, 0};
3329 CallSites.push_back(Site);
3335 const unsigned SiteStartSize = sizeof(int32_t); // DW_EH_PE_udata4
3336 const unsigned SiteLengthSize = sizeof(int32_t); // DW_EH_PE_udata4
3337 const unsigned LandingPadSize = sizeof(int32_t); // DW_EH_PE_udata4
3338 unsigned SizeSites = CallSites.size() * (SiteStartSize +
3341 for (unsigned i = 0, e = CallSites.size(); i < e; ++i)
3342 SizeSites += Asm->SizeULEB128(CallSites[i].Action);
3345 const unsigned TypeInfoSize = TD->getPointerSize(); // DW_EH_PE_absptr
3346 unsigned SizeTypes = TypeInfos.size() * TypeInfoSize;
3348 unsigned TypeOffset = sizeof(int8_t) + // Call site format
3349 Asm->SizeULEB128(SizeSites) + // Call-site table length
3350 SizeSites + SizeActions + SizeTypes;
3352 unsigned TotalSize = sizeof(int8_t) + // LPStart format
3353 sizeof(int8_t) + // TType format
3354 Asm->SizeULEB128(TypeOffset) + // TType base offset
3357 unsigned SizeAlign = (4 - TotalSize) & 3;
3359 // Begin the exception table.
3360 Asm->SwitchToDataSection(TAI->getDwarfExceptionSection());
3361 O << "GCC_except_table" << SubprogramCount << ":\n";
3362 Asm->EmitAlignment(2, 0, 0, false);
3363 for (unsigned i = 0; i != SizeAlign; ++i) {
3365 Asm->EOL("Padding");
3367 EmitLabel("exception", SubprogramCount);
3370 Asm->EmitInt8(DW_EH_PE_omit);
3371 Asm->EOL("LPStart format (DW_EH_PE_omit)");
3372 Asm->EmitInt8(DW_EH_PE_absptr);
3373 Asm->EOL("TType format (DW_EH_PE_absptr)");
3374 Asm->EmitULEB128Bytes(TypeOffset);
3375 Asm->EOL("TType base offset");
3376 Asm->EmitInt8(DW_EH_PE_udata4);
3377 Asm->EOL("Call site format (DW_EH_PE_udata4)");
3378 Asm->EmitULEB128Bytes(SizeSites);
3379 Asm->EOL("Call-site table length");
3381 // Emit the landing pad site information.
3382 for (unsigned i = 0; i < CallSites.size(); ++i) {
3383 CallSiteEntry &S = CallSites[i];
3384 const char *BeginTag;
3385 unsigned BeginNumber;
3387 if (!S.BeginLabel) {
3388 BeginTag = "eh_func_begin";
3389 BeginNumber = SubprogramCount;
3392 BeginNumber = S.BeginLabel;
3395 EmitSectionOffset(BeginTag, "eh_func_begin", BeginNumber, SubprogramCount,
3397 Asm->EOL("Region start");
3400 EmitDifference("eh_func_end", SubprogramCount, BeginTag, BeginNumber,
3403 EmitDifference("label", S.EndLabel, BeginTag, BeginNumber, true);
3405 Asm->EOL("Region length");
3410 EmitSectionOffset("label", "eh_func_begin", S.PadLabel, SubprogramCount,
3412 Asm->EOL("Landing pad");
3414 Asm->EmitULEB128Bytes(S.Action);
3418 // Emit the actions.
3419 for (unsigned I = 0, N = Actions.size(); I != N; ++I) {
3420 ActionEntry &Action = Actions[I];
3422 Asm->EmitSLEB128Bytes(Action.ValueForTypeID);
3423 Asm->EOL("TypeInfo index");
3424 Asm->EmitSLEB128Bytes(Action.NextAction);
3425 Asm->EOL("Next action");
3428 // Emit the type ids.
3429 for (unsigned M = TypeInfos.size(); M; --M) {
3430 GlobalVariable *GV = TypeInfos[M - 1];
3432 PrintRelDirective();
3435 O << Asm->getGlobalLinkName(GV);
3439 Asm->EOL("TypeInfo");
3442 // Emit the filter typeids.
3443 for (unsigned j = 0, M = FilterIds.size(); j < M; ++j) {
3444 unsigned TypeID = FilterIds[j];
3445 Asm->EmitULEB128Bytes(TypeID);
3446 Asm->EOL("Filter TypeInfo index");
3449 Asm->EmitAlignment(2, 0, 0, false);
3453 //===--------------------------------------------------------------------===//
3454 // Main entry points.
3456 DwarfException(std::ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
3457 : Dwarf(OS, A, T, "eh")
3458 , shouldEmitTable(false)
3459 , shouldEmitMoves(false)
3460 , shouldEmitTableModule(false)
3461 , shouldEmitMovesModule(false)
3464 virtual ~DwarfException() {}
3466 /// SetModuleInfo - Set machine module information when it's known that pass
3467 /// manager has created it. Set by the target AsmPrinter.
3468 void SetModuleInfo(MachineModuleInfo *mmi) {
3472 /// BeginModule - Emit all exception information that should come prior to the
3474 void BeginModule(Module *M) {
3478 /// EndModule - Emit all exception information that should come after the
3481 if (shouldEmitMovesModule || shouldEmitTableModule) {
3482 const std::vector<Function *> Personalities = MMI->getPersonalities();
3483 for (unsigned i =0; i < Personalities.size(); ++i)
3484 EmitCommonEHFrame(Personalities[i], i);
3486 for (std::vector<FunctionEHFrameInfo>::iterator I = EHFrames.begin(),
3487 E = EHFrames.end(); I != E; ++I)
3492 /// BeginFunction - Gather pre-function exception information. Assumes being
3493 /// emitted immediately after the function entry point.
3494 void BeginFunction(MachineFunction *MF) {
3496 shouldEmitTable = shouldEmitMoves = false;
3497 if (MMI && TAI->doesSupportExceptionHandling()) {
3499 // Map all labels and get rid of any dead landing pads.
3500 MMI->TidyLandingPads();
3501 // If any landing pads survive, we need an EH table.
3502 if (MMI->getLandingPads().size())
3503 shouldEmitTable = true;
3505 // See if we need frame move info.
3506 if (MMI->hasDebugInfo() ||
3507 !MF->getFunction()->doesNotThrow() ||
3508 UnwindTablesMandatory)
3509 shouldEmitMoves = true;
3511 if (shouldEmitMoves || shouldEmitTable)
3512 // Assumes in correct section after the entry point.
3513 EmitLabel("eh_func_begin", ++SubprogramCount);
3515 shouldEmitTableModule |= shouldEmitTable;
3516 shouldEmitMovesModule |= shouldEmitMoves;
3519 /// EndFunction - Gather and emit post-function exception information.
3521 void EndFunction() {
3522 if (shouldEmitMoves || shouldEmitTable) {
3523 EmitLabel("eh_func_end", SubprogramCount);
3524 EmitExceptionTable();
3526 // Save EH frame information
3528 push_back(FunctionEHFrameInfo(getAsm()->getCurrentFunctionEHName(MF),
3530 MMI->getPersonalityIndex(),
3531 MF->getFrameInfo()->hasCalls(),
3532 !MMI->getLandingPads().empty(),
3533 MMI->getFrameMoves(),
3534 MF->getFunction()));
3539 } // End of namespace llvm
3541 //===----------------------------------------------------------------------===//
3543 /// Emit - Print the abbreviation using the specified Dwarf writer.
3545 void DIEAbbrev::Emit(const DwarfDebug &DD) const {
3546 // Emit its Dwarf tag type.
3547 DD.getAsm()->EmitULEB128Bytes(Tag);
3548 DD.getAsm()->EOL(TagString(Tag));
3550 // Emit whether it has children DIEs.
3551 DD.getAsm()->EmitULEB128Bytes(ChildrenFlag);
3552 DD.getAsm()->EOL(ChildrenString(ChildrenFlag));
3554 // For each attribute description.
3555 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3556 const DIEAbbrevData &AttrData = Data[i];
3558 // Emit attribute type.
3559 DD.getAsm()->EmitULEB128Bytes(AttrData.getAttribute());
3560 DD.getAsm()->EOL(AttributeString(AttrData.getAttribute()));
3563 DD.getAsm()->EmitULEB128Bytes(AttrData.getForm());
3564 DD.getAsm()->EOL(FormEncodingString(AttrData.getForm()));
3567 // Mark end of abbreviation.
3568 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(1)");
3569 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(2)");
3573 void DIEAbbrev::print(std::ostream &O) {
3574 O << "Abbreviation @"
3575 << std::hex << (intptr_t)this << std::dec
3579 << ChildrenString(ChildrenFlag)
3582 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3584 << AttributeString(Data[i].getAttribute())
3586 << FormEncodingString(Data[i].getForm())
3590 void DIEAbbrev::dump() { print(cerr); }
3593 //===----------------------------------------------------------------------===//
3596 void DIEValue::dump() {
3601 //===----------------------------------------------------------------------===//
3603 /// EmitValue - Emit integer of appropriate size.
3605 void DIEInteger::EmitValue(DwarfDebug &DD, unsigned Form) {
3607 case DW_FORM_flag: // Fall thru
3608 case DW_FORM_ref1: // Fall thru
3609 case DW_FORM_data1: DD.getAsm()->EmitInt8(Integer); break;
3610 case DW_FORM_ref2: // Fall thru
3611 case DW_FORM_data2: DD.getAsm()->EmitInt16(Integer); break;
3612 case DW_FORM_ref4: // Fall thru
3613 case DW_FORM_data4: DD.getAsm()->EmitInt32(Integer); break;
3614 case DW_FORM_ref8: // Fall thru
3615 case DW_FORM_data8: DD.getAsm()->EmitInt64(Integer); break;
3616 case DW_FORM_udata: DD.getAsm()->EmitULEB128Bytes(Integer); break;
3617 case DW_FORM_sdata: DD.getAsm()->EmitSLEB128Bytes(Integer); break;
3618 default: assert(0 && "DIE Value form not supported yet"); break;
3622 /// SizeOf - Determine size of integer value in bytes.
3624 unsigned DIEInteger::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3626 case DW_FORM_flag: // Fall thru
3627 case DW_FORM_ref1: // Fall thru
3628 case DW_FORM_data1: return sizeof(int8_t);
3629 case DW_FORM_ref2: // Fall thru
3630 case DW_FORM_data2: return sizeof(int16_t);
3631 case DW_FORM_ref4: // Fall thru
3632 case DW_FORM_data4: return sizeof(int32_t);
3633 case DW_FORM_ref8: // Fall thru
3634 case DW_FORM_data8: return sizeof(int64_t);
3635 case DW_FORM_udata: return DD.getAsm()->SizeULEB128(Integer);
3636 case DW_FORM_sdata: return DD.getAsm()->SizeSLEB128(Integer);
3637 default: assert(0 && "DIE Value form not supported yet"); break;
3642 //===----------------------------------------------------------------------===//
3644 /// EmitValue - Emit string value.
3646 void DIEString::EmitValue(DwarfDebug &DD, unsigned Form) {
3647 DD.getAsm()->EmitString(String);
3650 //===----------------------------------------------------------------------===//
3652 /// EmitValue - Emit label value.
3654 void DIEDwarfLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
3655 bool IsSmall = Form == DW_FORM_data4;
3656 DD.EmitReference(Label, false, IsSmall);
3659 /// SizeOf - Determine size of label value in bytes.
3661 unsigned DIEDwarfLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3662 if (Form == DW_FORM_data4) return 4;
3663 return DD.getTargetData()->getPointerSize();
3666 //===----------------------------------------------------------------------===//
3668 /// EmitValue - Emit label value.
3670 void DIEObjectLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
3671 bool IsSmall = Form == DW_FORM_data4;
3672 DD.EmitReference(Label, false, IsSmall);
3675 /// SizeOf - Determine size of label value in bytes.
3677 unsigned DIEObjectLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3678 if (Form == DW_FORM_data4) return 4;
3679 return DD.getTargetData()->getPointerSize();
3682 //===----------------------------------------------------------------------===//
3684 /// EmitValue - Emit delta value.
3686 void DIESectionOffset::EmitValue(DwarfDebug &DD, unsigned Form) {
3687 bool IsSmall = Form == DW_FORM_data4;
3688 DD.EmitSectionOffset(Label.Tag, Section.Tag,
3689 Label.Number, Section.Number, IsSmall, IsEH, UseSet);
3692 /// SizeOf - Determine size of delta value in bytes.
3694 unsigned DIESectionOffset::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3695 if (Form == DW_FORM_data4) return 4;
3696 return DD.getTargetData()->getPointerSize();
3699 //===----------------------------------------------------------------------===//
3701 /// EmitValue - Emit delta value.
3703 void DIEDelta::EmitValue(DwarfDebug &DD, unsigned Form) {
3704 bool IsSmall = Form == DW_FORM_data4;
3705 DD.EmitDifference(LabelHi, LabelLo, IsSmall);
3708 /// SizeOf - Determine size of delta value in bytes.
3710 unsigned DIEDelta::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3711 if (Form == DW_FORM_data4) return 4;
3712 return DD.getTargetData()->getPointerSize();
3715 //===----------------------------------------------------------------------===//
3717 /// EmitValue - Emit debug information entry offset.
3719 void DIEntry::EmitValue(DwarfDebug &DD, unsigned Form) {
3720 DD.getAsm()->EmitInt32(Entry->getOffset());
3723 //===----------------------------------------------------------------------===//
3725 /// ComputeSize - calculate the size of the block.
3727 unsigned DIEBlock::ComputeSize(DwarfDebug &DD) {
3729 const std::vector<DIEAbbrevData> &AbbrevData = Abbrev.getData();
3731 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3732 Size += Values[i]->SizeOf(DD, AbbrevData[i].getForm());
3738 /// EmitValue - Emit block data.
3740 void DIEBlock::EmitValue(DwarfDebug &DD, unsigned Form) {
3742 case DW_FORM_block1: DD.getAsm()->EmitInt8(Size); break;
3743 case DW_FORM_block2: DD.getAsm()->EmitInt16(Size); break;
3744 case DW_FORM_block4: DD.getAsm()->EmitInt32(Size); break;
3745 case DW_FORM_block: DD.getAsm()->EmitULEB128Bytes(Size); break;
3746 default: assert(0 && "Improper form for block"); break;
3749 const std::vector<DIEAbbrevData> &AbbrevData = Abbrev.getData();
3751 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3753 Values[i]->EmitValue(DD, AbbrevData[i].getForm());
3757 /// SizeOf - Determine size of block data in bytes.
3759 unsigned DIEBlock::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3761 case DW_FORM_block1: return Size + sizeof(int8_t);
3762 case DW_FORM_block2: return Size + sizeof(int16_t);
3763 case DW_FORM_block4: return Size + sizeof(int32_t);
3764 case DW_FORM_block: return Size + DD.getAsm()->SizeULEB128(Size);
3765 default: assert(0 && "Improper form for block"); break;
3770 //===----------------------------------------------------------------------===//
3771 /// DIE Implementation
3774 for (unsigned i = 0, N = Children.size(); i < N; ++i)
3778 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
3780 void DIE::AddSiblingOffset() {
3781 DIEInteger *DI = new DIEInteger(0);
3782 Values.insert(Values.begin(), DI);
3783 Abbrev.AddFirstAttribute(DW_AT_sibling, DW_FORM_ref4);
3786 /// Profile - Used to gather unique data for the value folding set.
3788 void DIE::Profile(FoldingSetNodeID &ID) {
3791 for (unsigned i = 0, N = Children.size(); i < N; ++i)
3792 ID.AddPointer(Children[i]);
3794 for (unsigned j = 0, M = Values.size(); j < M; ++j)
3795 ID.AddPointer(Values[j]);
3799 void DIE::print(std::ostream &O, unsigned IncIndent) {
3800 static unsigned IndentCount = 0;
3801 IndentCount += IncIndent;
3802 const std::string Indent(IndentCount, ' ');
3803 bool isBlock = Abbrev.getTag() == 0;
3808 << "0x" << std::hex << (intptr_t)this << std::dec
3809 << ", Offset: " << Offset
3810 << ", Size: " << Size
3814 << TagString(Abbrev.getTag())
3816 << ChildrenString(Abbrev.getChildrenFlag());
3818 O << "Size: " << Size;
3822 const std::vector<DIEAbbrevData> &Data = Abbrev.getData();
3825 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3828 O << AttributeString(Data[i].getAttribute());
3830 O << "Blk[" << i << "]";
3833 << FormEncodingString(Data[i].getForm())
3835 Values[i]->print(O);
3840 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
3841 Children[j]->print(O, 4);
3844 if (!isBlock) O << "\n";
3845 IndentCount -= IncIndent;
3853 //===----------------------------------------------------------------------===//
3854 /// DwarfWriter Implementation
3857 DwarfWriter::DwarfWriter(std::ostream &OS, AsmPrinter *A,
3858 const TargetAsmInfo *T) {
3859 DE = new DwarfException(OS, A, T);
3860 DD = new DwarfDebug(OS, A, T);
3863 DwarfWriter::~DwarfWriter() {
3868 /// SetModuleInfo - Set machine module info when it's known that pass manager
3869 /// has created it. Set by the target AsmPrinter.
3870 void DwarfWriter::SetModuleInfo(MachineModuleInfo *MMI) {
3871 DD->SetModuleInfo(MMI);
3872 DE->SetModuleInfo(MMI);
3875 /// BeginModule - Emit all Dwarf sections that should come prior to the
3877 void DwarfWriter::BeginModule(Module *M) {
3882 /// EndModule - Emit all Dwarf sections that should come after the content.
3884 void DwarfWriter::EndModule() {
3889 /// BeginFunction - Gather pre-function debug information. Assumes being
3890 /// emitted immediately after the function entry point.
3891 void DwarfWriter::BeginFunction(MachineFunction *MF) {
3892 DE->BeginFunction(MF);
3893 DD->BeginFunction(MF);
3896 /// EndFunction - Gather and emit post-function debug information.
3898 void DwarfWriter::EndFunction() {
3902 if (MachineModuleInfo *MMI = DD->getMMI() ? DD->getMMI() : DE->getMMI()) {
3903 // Clear function debug information.