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/MachineDebugInfoDesc.h"
24 #include "llvm/CodeGen/MachineModuleInfo.h"
25 #include "llvm/CodeGen/MachineFrameInfo.h"
26 #include "llvm/CodeGen/MachineLocation.h"
27 #include "llvm/Support/Debug.h"
28 #include "llvm/Support/Dwarf.h"
29 #include "llvm/Support/CommandLine.h"
30 #include "llvm/Support/DataTypes.h"
31 #include "llvm/Support/Mangler.h"
32 #include "llvm/System/Path.h"
33 #include "llvm/Target/TargetAsmInfo.h"
34 #include "llvm/Target/TargetRegisterInfo.h"
35 #include "llvm/Target/TargetData.h"
36 #include "llvm/Target/TargetFrameInfo.h"
37 #include "llvm/Target/TargetInstrInfo.h"
38 #include "llvm/Target/TargetMachine.h"
39 #include "llvm/Target/TargetOptions.h"
43 using namespace llvm::dwarf;
47 //===----------------------------------------------------------------------===//
49 /// Configuration values for initial hash set sizes (log2).
51 static const unsigned InitDiesSetSize = 9; // 512
52 static const unsigned InitAbbreviationsSetSize = 9; // 512
53 static const unsigned InitValuesSetSize = 9; // 512
55 //===----------------------------------------------------------------------===//
56 /// Forward declarations.
61 //===----------------------------------------------------------------------===//
62 /// DWLabel - Labels are used to track locations in the assembler file.
63 /// Labels appear in the form @verbatim <prefix><Tag><Number> @endverbatim,
64 /// where the tag is a category of label (Ex. location) and number is a value
65 /// unique in that category.
68 /// Tag - Label category tag. Should always be a staticly declared C string.
72 /// Number - Value to make label unique.
76 DWLabel(const char *T, unsigned N) : Tag(T), Number(N) {}
78 void Profile(FoldingSetNodeID &ID) const {
79 ID.AddString(std::string(Tag));
80 ID.AddInteger(Number);
84 void print(std::ostream *O) const {
87 void print(std::ostream &O) const {
89 if (Number) O << Number;
94 //===----------------------------------------------------------------------===//
95 /// DIEAbbrevData - Dwarf abbreviation data, describes the one attribute of a
96 /// Dwarf abbreviation.
99 /// Attribute - Dwarf attribute code.
103 /// Form - Dwarf form code.
108 DIEAbbrevData(unsigned A, unsigned F)
114 unsigned getAttribute() const { return Attribute; }
115 unsigned getForm() const { return Form; }
117 /// Profile - Used to gather unique data for the abbreviation folding set.
119 void Profile(FoldingSetNodeID &ID)const {
120 ID.AddInteger(Attribute);
125 //===----------------------------------------------------------------------===//
126 /// DIEAbbrev - Dwarf abbreviation, describes the organization of a debug
127 /// information object.
128 class DIEAbbrev : public FoldingSetNode {
130 /// Tag - Dwarf tag code.
134 /// Unique number for node.
138 /// ChildrenFlag - Dwarf children flag.
140 unsigned ChildrenFlag;
142 /// Data - Raw data bytes for abbreviation.
144 SmallVector<DIEAbbrevData, 8> Data;
148 DIEAbbrev(unsigned T, unsigned C)
156 unsigned getTag() const { return Tag; }
157 unsigned getNumber() const { return Number; }
158 unsigned getChildrenFlag() const { return ChildrenFlag; }
159 const SmallVector<DIEAbbrevData, 8> &getData() const { return Data; }
160 void setTag(unsigned T) { Tag = T; }
161 void setChildrenFlag(unsigned CF) { ChildrenFlag = CF; }
162 void setNumber(unsigned N) { Number = N; }
164 /// AddAttribute - Adds another set of attribute information to the
166 void AddAttribute(unsigned Attribute, unsigned Form) {
167 Data.push_back(DIEAbbrevData(Attribute, Form));
170 /// AddFirstAttribute - Adds a set of attribute information to the front
171 /// of the abbreviation.
172 void AddFirstAttribute(unsigned Attribute, unsigned Form) {
173 Data.insert(Data.begin(), DIEAbbrevData(Attribute, Form));
176 /// Profile - Used to gather unique data for the abbreviation folding set.
178 void Profile(FoldingSetNodeID &ID) {
180 ID.AddInteger(ChildrenFlag);
182 // For each attribute description.
183 for (unsigned i = 0, N = Data.size(); i < N; ++i)
187 /// Emit - Print the abbreviation using the specified Dwarf writer.
189 void Emit(const DwarfDebug &DD) const;
192 void print(std::ostream *O) {
195 void print(std::ostream &O);
200 //===----------------------------------------------------------------------===//
201 /// DIE - A structured debug information entry. Has an abbreviation which
202 /// describes it's organization.
203 class DIE : public FoldingSetNode {
205 /// Abbrev - Buffer for constructing abbreviation.
209 /// Offset - Offset in debug info section.
213 /// Size - Size of instance + children.
219 std::vector<DIE *> Children;
221 /// Attributes values.
223 SmallVector<DIEValue*, 32> Values;
226 explicit DIE(unsigned Tag)
227 : Abbrev(Tag, DW_CHILDREN_no)
236 DIEAbbrev &getAbbrev() { return Abbrev; }
237 unsigned getAbbrevNumber() const {
238 return Abbrev.getNumber();
240 unsigned getTag() const { return Abbrev.getTag(); }
241 unsigned getOffset() const { return Offset; }
242 unsigned getSize() const { return Size; }
243 const std::vector<DIE *> &getChildren() const { return Children; }
244 SmallVector<DIEValue*, 32> &getValues() { return Values; }
245 void setTag(unsigned Tag) { Abbrev.setTag(Tag); }
246 void setOffset(unsigned O) { Offset = O; }
247 void setSize(unsigned S) { Size = S; }
249 /// AddValue - Add a value and attributes to a DIE.
251 void AddValue(unsigned Attribute, unsigned Form, DIEValue *Value) {
252 Abbrev.AddAttribute(Attribute, Form);
253 Values.push_back(Value);
256 /// SiblingOffset - Return the offset of the debug information entry's
258 unsigned SiblingOffset() const { return Offset + Size; }
260 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
262 void AddSiblingOffset();
264 /// AddChild - Add a child to the DIE.
266 void AddChild(DIE *Child) {
267 Abbrev.setChildrenFlag(DW_CHILDREN_yes);
268 Children.push_back(Child);
271 /// Detach - Detaches objects connected to it after copying.
277 /// Profile - Used to gather unique data for the value folding set.
279 void Profile(FoldingSetNodeID &ID) ;
282 void print(std::ostream *O, unsigned IncIndent = 0) {
283 if (O) print(*O, IncIndent);
285 void print(std::ostream &O, unsigned IncIndent = 0);
290 //===----------------------------------------------------------------------===//
291 /// DIEValue - A debug information entry value.
293 class DIEValue : public FoldingSetNode {
306 /// Type - Type of data stored in the value.
310 explicit DIEValue(unsigned T)
313 virtual ~DIEValue() {}
316 unsigned getType() const { return Type; }
318 // Implement isa/cast/dyncast.
319 static bool classof(const DIEValue *) { return true; }
321 /// EmitValue - Emit value via the Dwarf writer.
323 virtual void EmitValue(DwarfDebug &DD, unsigned Form) = 0;
325 /// SizeOf - Return the size of a value in bytes.
327 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const = 0;
329 /// Profile - Used to gather unique data for the value folding set.
331 virtual void Profile(FoldingSetNodeID &ID) = 0;
334 void print(std::ostream *O) {
337 virtual void print(std::ostream &O) = 0;
342 //===----------------------------------------------------------------------===//
343 /// DWInteger - An integer value DIE.
345 class DIEInteger : public DIEValue {
350 explicit DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
352 // Implement isa/cast/dyncast.
353 static bool classof(const DIEInteger *) { return true; }
354 static bool classof(const DIEValue *I) { return I->Type == isInteger; }
356 /// BestForm - Choose the best form for integer.
358 static unsigned BestForm(bool IsSigned, uint64_t Integer) {
360 if ((char)Integer == (signed)Integer) return DW_FORM_data1;
361 if ((short)Integer == (signed)Integer) return DW_FORM_data2;
362 if ((int)Integer == (signed)Integer) return DW_FORM_data4;
364 if ((unsigned char)Integer == Integer) return DW_FORM_data1;
365 if ((unsigned short)Integer == Integer) return DW_FORM_data2;
366 if ((unsigned int)Integer == Integer) return DW_FORM_data4;
368 return DW_FORM_data8;
371 /// EmitValue - Emit integer of appropriate size.
373 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
375 /// SizeOf - Determine size of integer value in bytes.
377 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
379 /// Profile - Used to gather unique data for the value folding set.
381 static void Profile(FoldingSetNodeID &ID, unsigned Integer) {
382 ID.AddInteger(isInteger);
383 ID.AddInteger(Integer);
385 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Integer); }
388 virtual void print(std::ostream &O) {
389 O << "Int: " << (int64_t)Integer
390 << " 0x" << std::hex << Integer << std::dec;
395 //===----------------------------------------------------------------------===//
396 /// DIEString - A string value DIE.
398 class DIEString : public DIEValue {
400 const std::string String;
402 explicit DIEString(const std::string &S) : DIEValue(isString), String(S) {}
404 // Implement isa/cast/dyncast.
405 static bool classof(const DIEString *) { return true; }
406 static bool classof(const DIEValue *S) { return S->Type == isString; }
408 /// EmitValue - Emit string value.
410 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
412 /// SizeOf - Determine size of string value in bytes.
414 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
415 return String.size() + sizeof(char); // sizeof('\0');
418 /// Profile - Used to gather unique data for the value folding set.
420 static void Profile(FoldingSetNodeID &ID, const std::string &String) {
421 ID.AddInteger(isString);
422 ID.AddString(String);
424 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, String); }
427 virtual void print(std::ostream &O) {
428 O << "Str: \"" << String << "\"";
433 //===----------------------------------------------------------------------===//
434 /// DIEDwarfLabel - A Dwarf internal label expression DIE.
436 class DIEDwarfLabel : public DIEValue {
441 explicit DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {}
443 // Implement isa/cast/dyncast.
444 static bool classof(const DIEDwarfLabel *) { return true; }
445 static bool classof(const DIEValue *L) { return L->Type == isLabel; }
447 /// EmitValue - Emit label value.
449 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
451 /// SizeOf - Determine size of label value in bytes.
453 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
455 /// Profile - Used to gather unique data for the value folding set.
457 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label) {
458 ID.AddInteger(isLabel);
461 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
464 virtual void print(std::ostream &O) {
472 //===----------------------------------------------------------------------===//
473 /// DIEObjectLabel - A label to an object in code or data.
475 class DIEObjectLabel : public DIEValue {
477 const std::string Label;
479 explicit DIEObjectLabel(const std::string &L)
480 : DIEValue(isAsIsLabel), Label(L) {}
482 // Implement isa/cast/dyncast.
483 static bool classof(const DIEObjectLabel *) { return true; }
484 static bool classof(const DIEValue *L) { return L->Type == isAsIsLabel; }
486 /// EmitValue - Emit label value.
488 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
490 /// SizeOf - Determine size of label value in bytes.
492 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
494 /// Profile - Used to gather unique data for the value folding set.
496 static void Profile(FoldingSetNodeID &ID, const std::string &Label) {
497 ID.AddInteger(isAsIsLabel);
500 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
503 virtual void print(std::ostream &O) {
504 O << "Obj: " << Label;
509 //===----------------------------------------------------------------------===//
510 /// DIESectionOffset - A section offset DIE.
512 class DIESectionOffset : public DIEValue {
515 const DWLabel Section;
519 DIESectionOffset(const DWLabel &Lab, const DWLabel &Sec,
520 bool isEH = false, bool useSet = true)
521 : DIEValue(isSectionOffset), Label(Lab), Section(Sec),
522 IsEH(isEH), UseSet(useSet) {}
524 // Implement isa/cast/dyncast.
525 static bool classof(const DIESectionOffset *) { return true; }
526 static bool classof(const DIEValue *D) { return D->Type == isSectionOffset; }
528 /// EmitValue - Emit section offset.
530 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
532 /// SizeOf - Determine size of section offset value in bytes.
534 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
536 /// Profile - Used to gather unique data for the value folding set.
538 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label,
539 const DWLabel &Section) {
540 ID.AddInteger(isSectionOffset);
543 // IsEH and UseSet are specific to the Label/Section that we will emit
544 // the offset for; so Label/Section are enough for uniqueness.
546 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label, Section); }
549 virtual void print(std::ostream &O) {
554 O << "-" << IsEH << "-" << UseSet;
559 //===----------------------------------------------------------------------===//
560 /// DIEDelta - A simple label difference DIE.
562 class DIEDelta : public DIEValue {
564 const DWLabel LabelHi;
565 const DWLabel LabelLo;
567 DIEDelta(const DWLabel &Hi, const DWLabel &Lo)
568 : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
570 // Implement isa/cast/dyncast.
571 static bool classof(const DIEDelta *) { return true; }
572 static bool classof(const DIEValue *D) { return D->Type == isDelta; }
574 /// EmitValue - Emit delta value.
576 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
578 /// SizeOf - Determine size of delta value in bytes.
580 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
582 /// Profile - Used to gather unique data for the value folding set.
584 static void Profile(FoldingSetNodeID &ID, const DWLabel &LabelHi,
585 const DWLabel &LabelLo) {
586 ID.AddInteger(isDelta);
590 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, LabelHi, LabelLo); }
593 virtual void print(std::ostream &O) {
602 //===----------------------------------------------------------------------===//
603 /// DIEntry - A pointer to another debug information entry. An instance of this
604 /// class can also be used as a proxy for a debug information entry not yet
605 /// defined (ie. types.)
606 class DIEntry : public DIEValue {
610 explicit DIEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
612 // Implement isa/cast/dyncast.
613 static bool classof(const DIEntry *) { return true; }
614 static bool classof(const DIEValue *E) { return E->Type == isEntry; }
616 /// EmitValue - Emit debug information entry offset.
618 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
620 /// SizeOf - Determine size of debug information entry in bytes.
622 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
623 return sizeof(int32_t);
626 /// Profile - Used to gather unique data for the value folding set.
628 static void Profile(FoldingSetNodeID &ID, DIE *Entry) {
629 ID.AddInteger(isEntry);
630 ID.AddPointer(Entry);
632 virtual void Profile(FoldingSetNodeID &ID) {
633 ID.AddInteger(isEntry);
636 ID.AddPointer(Entry);
643 virtual void print(std::ostream &O) {
644 O << "Die: 0x" << std::hex << (intptr_t)Entry << std::dec;
649 //===----------------------------------------------------------------------===//
650 /// DIEBlock - A block of values. Primarily used for location expressions.
652 class DIEBlock : public DIEValue, public DIE {
654 unsigned Size; // Size in bytes excluding size header.
664 // Implement isa/cast/dyncast.
665 static bool classof(const DIEBlock *) { return true; }
666 static bool classof(const DIEValue *E) { return E->Type == isBlock; }
668 /// ComputeSize - calculate the size of the block.
670 unsigned ComputeSize(DwarfDebug &DD);
672 /// BestForm - Choose the best form for data.
674 unsigned BestForm() const {
675 if ((unsigned char)Size == Size) return DW_FORM_block1;
676 if ((unsigned short)Size == Size) return DW_FORM_block2;
677 if ((unsigned int)Size == Size) return DW_FORM_block4;
678 return DW_FORM_block;
681 /// EmitValue - Emit block data.
683 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
685 /// SizeOf - Determine size of block data in bytes.
687 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
690 /// Profile - Used to gather unique data for the value folding set.
692 virtual void Profile(FoldingSetNodeID &ID) {
693 ID.AddInteger(isBlock);
698 virtual void print(std::ostream &O) {
705 //===----------------------------------------------------------------------===//
706 /// CompileUnit - This dwarf writer support class manages information associate
707 /// with a source file.
710 /// Desc - Compile unit debug descriptor.
712 CompileUnitDesc *Desc;
714 /// ID - File identifier for source.
718 /// Die - Compile unit debug information entry.
722 /// DescToDieMap - Tracks the mapping of unit level debug informaton
723 /// descriptors to debug information entries.
724 std::map<DebugInfoDesc *, DIE *> DescToDieMap;
726 /// DescToDIEntryMap - Tracks the mapping of unit level debug informaton
727 /// descriptors to debug information entries using a DIEntry proxy.
728 std::map<DebugInfoDesc *, DIEntry *> DescToDIEntryMap;
730 /// Globals - A map of globally visible named entities for this unit.
732 std::map<std::string, DIE *> Globals;
734 /// DiesSet - Used to uniquely define dies within the compile unit.
736 FoldingSet<DIE> DiesSet;
738 /// Dies - List of all dies in the compile unit.
740 std::vector<DIE *> Dies;
743 CompileUnit(CompileUnitDesc *CUD, unsigned I, DIE *D)
750 , DiesSet(InitDiesSetSize)
757 for (unsigned i = 0, N = Dies.size(); i < N; ++i)
762 CompileUnitDesc *getDesc() const { return Desc; }
763 unsigned getID() const { return ID; }
764 DIE* getDie() const { return Die; }
765 std::map<std::string, DIE *> &getGlobals() { return Globals; }
767 /// hasContent - Return true if this compile unit has something to write out.
769 bool hasContent() const {
770 return !Die->getChildren().empty();
773 /// AddGlobal - Add a new global entity to the compile unit.
775 void AddGlobal(const std::string &Name, DIE *Die) {
779 /// getDieMapSlotFor - Returns the debug information entry map slot for the
780 /// specified debug descriptor.
781 DIE *&getDieMapSlotFor(DebugInfoDesc *DID) {
782 return DescToDieMap[DID];
785 /// getDIEntrySlotFor - Returns the debug information entry proxy slot for the
786 /// specified debug descriptor.
787 DIEntry *&getDIEntrySlotFor(DebugInfoDesc *DID) {
788 return DescToDIEntryMap[DID];
791 /// AddDie - Adds or interns the DIE to the compile unit.
793 DIE *AddDie(DIE &Buffer) {
797 DIE *Die = DiesSet.FindNodeOrInsertPos(ID, Where);
800 Die = new DIE(Buffer);
801 DiesSet.InsertNode(Die, Where);
802 this->Die->AddChild(Die);
810 //===----------------------------------------------------------------------===//
811 /// Dwarf - Emits general Dwarf directives.
817 //===--------------------------------------------------------------------===//
818 // Core attributes used by the Dwarf writer.
822 /// O - Stream to .s file.
826 /// Asm - Target of Dwarf emission.
830 /// TAI - Target asm information.
831 const TargetAsmInfo *TAI;
833 /// TD - Target data.
834 const TargetData *TD;
836 /// RI - Register Information.
837 const TargetRegisterInfo *RI;
839 /// M - Current module.
843 /// MF - Current machine function.
847 /// MMI - Collected machine module information.
849 MachineModuleInfo *MMI;
851 /// SubprogramCount - The running count of functions being compiled.
853 unsigned SubprogramCount;
855 /// Flavor - A unique string indicating what dwarf producer this is, used to
857 const char * const Flavor;
860 Dwarf(std::ostream &OS, AsmPrinter *A, const TargetAsmInfo *T,
865 , TD(Asm->TM.getTargetData())
866 , RI(Asm->TM.getRegisterInfo())
878 //===--------------------------------------------------------------------===//
881 AsmPrinter *getAsm() const { return Asm; }
882 MachineModuleInfo *getMMI() const { return MMI; }
883 const TargetAsmInfo *getTargetAsmInfo() const { return TAI; }
884 const TargetData *getTargetData() const { return TD; }
886 void PrintRelDirective(bool Force32Bit = false, bool isInSection = false)
888 if (isInSection && TAI->getDwarfSectionOffsetDirective())
889 O << TAI->getDwarfSectionOffsetDirective();
890 else if (Force32Bit || TD->getPointerSize() == sizeof(int32_t))
891 O << TAI->getData32bitsDirective();
893 O << TAI->getData64bitsDirective();
896 /// PrintLabelName - Print label name in form used by Dwarf writer.
898 void PrintLabelName(DWLabel Label) const {
899 PrintLabelName(Label.Tag, Label.Number);
901 void PrintLabelName(const char *Tag, unsigned Number) const {
902 O << TAI->getPrivateGlobalPrefix() << Tag;
903 if (Number) O << Number;
906 void PrintLabelName(const char *Tag, unsigned Number,
907 const char *Suffix) const {
908 O << TAI->getPrivateGlobalPrefix() << Tag;
909 if (Number) O << Number;
913 /// EmitLabel - Emit location label for internal use by Dwarf.
915 void EmitLabel(DWLabel Label) const {
916 EmitLabel(Label.Tag, Label.Number);
918 void EmitLabel(const char *Tag, unsigned Number) const {
919 PrintLabelName(Tag, Number);
923 /// EmitReference - Emit a reference to a label.
925 void EmitReference(DWLabel Label, bool IsPCRelative = false,
926 bool Force32Bit = false) const {
927 EmitReference(Label.Tag, Label.Number, IsPCRelative, Force32Bit);
929 void EmitReference(const char *Tag, unsigned Number,
930 bool IsPCRelative = false, bool Force32Bit = false) const {
931 PrintRelDirective(Force32Bit);
932 PrintLabelName(Tag, Number);
934 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
936 void EmitReference(const std::string &Name, bool IsPCRelative = false,
937 bool Force32Bit = false) const {
938 PrintRelDirective(Force32Bit);
942 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
945 /// EmitDifference - Emit the difference between two labels. Some
946 /// assemblers do not behave with absolute expressions with data directives,
947 /// so there is an option (needsSet) to use an intermediary set expression.
948 void EmitDifference(DWLabel LabelHi, DWLabel LabelLo,
949 bool IsSmall = false) {
950 EmitDifference(LabelHi.Tag, LabelHi.Number,
951 LabelLo.Tag, LabelLo.Number,
954 void EmitDifference(const char *TagHi, unsigned NumberHi,
955 const char *TagLo, unsigned NumberLo,
956 bool IsSmall = false) {
957 if (TAI->needsSet()) {
959 PrintLabelName("set", SetCounter, Flavor);
961 PrintLabelName(TagHi, NumberHi);
963 PrintLabelName(TagLo, NumberLo);
966 PrintRelDirective(IsSmall);
967 PrintLabelName("set", SetCounter, Flavor);
970 PrintRelDirective(IsSmall);
972 PrintLabelName(TagHi, NumberHi);
974 PrintLabelName(TagLo, NumberLo);
978 void EmitSectionOffset(const char* Label, const char* Section,
979 unsigned LabelNumber, unsigned SectionNumber,
980 bool IsSmall = false, bool isEH = false,
981 bool useSet = true) {
982 bool printAbsolute = false;
984 printAbsolute = TAI->isAbsoluteEHSectionOffsets();
986 printAbsolute = TAI->isAbsoluteDebugSectionOffsets();
988 if (TAI->needsSet() && useSet) {
990 PrintLabelName("set", SetCounter, Flavor);
992 PrintLabelName(Label, LabelNumber);
994 if (!printAbsolute) {
996 PrintLabelName(Section, SectionNumber);
1000 PrintRelDirective(IsSmall);
1002 PrintLabelName("set", SetCounter, Flavor);
1005 PrintRelDirective(IsSmall, true);
1007 PrintLabelName(Label, LabelNumber);
1009 if (!printAbsolute) {
1011 PrintLabelName(Section, SectionNumber);
1016 /// EmitFrameMoves - Emit frame instructions to describe the layout of the
1018 void EmitFrameMoves(const char *BaseLabel, unsigned BaseLabelID,
1019 const std::vector<MachineMove> &Moves, bool isEH) {
1021 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
1022 TargetFrameInfo::StackGrowsUp ?
1023 TD->getPointerSize() : -TD->getPointerSize();
1024 bool IsLocal = BaseLabel && strcmp(BaseLabel, "label") == 0;
1026 for (unsigned i = 0, N = Moves.size(); i < N; ++i) {
1027 const MachineMove &Move = Moves[i];
1028 unsigned LabelID = Move.getLabelID();
1031 LabelID = MMI->MappedLabel(LabelID);
1033 // Throw out move if the label is invalid.
1034 if (!LabelID) continue;
1037 const MachineLocation &Dst = Move.getDestination();
1038 const MachineLocation &Src = Move.getSource();
1040 // Advance row if new location.
1041 if (BaseLabel && LabelID && (BaseLabelID != LabelID || !IsLocal)) {
1042 Asm->EmitInt8(DW_CFA_advance_loc4);
1043 Asm->EOL("DW_CFA_advance_loc4");
1044 EmitDifference("label", LabelID, BaseLabel, BaseLabelID, true);
1047 BaseLabelID = LabelID;
1048 BaseLabel = "label";
1052 // If advancing cfa.
1053 if (Dst.isRegister() && Dst.getRegister() == MachineLocation::VirtualFP) {
1054 if (!Src.isRegister()) {
1055 if (Src.getRegister() == MachineLocation::VirtualFP) {
1056 Asm->EmitInt8(DW_CFA_def_cfa_offset);
1057 Asm->EOL("DW_CFA_def_cfa_offset");
1059 Asm->EmitInt8(DW_CFA_def_cfa);
1060 Asm->EOL("DW_CFA_def_cfa");
1061 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Src.getRegister(), isEH));
1062 Asm->EOL("Register");
1065 int Offset = -Src.getOffset();
1067 Asm->EmitULEB128Bytes(Offset);
1070 assert(0 && "Machine move no supported yet.");
1072 } else if (Src.isRegister() &&
1073 Src.getRegister() == MachineLocation::VirtualFP) {
1074 if (Dst.isRegister()) {
1075 Asm->EmitInt8(DW_CFA_def_cfa_register);
1076 Asm->EOL("DW_CFA_def_cfa_register");
1077 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Dst.getRegister(), isEH));
1078 Asm->EOL("Register");
1080 assert(0 && "Machine move no supported yet.");
1083 unsigned Reg = RI->getDwarfRegNum(Src.getRegister(), isEH);
1084 int Offset = Dst.getOffset() / stackGrowth;
1087 Asm->EmitInt8(DW_CFA_offset_extended_sf);
1088 Asm->EOL("DW_CFA_offset_extended_sf");
1089 Asm->EmitULEB128Bytes(Reg);
1091 Asm->EmitSLEB128Bytes(Offset);
1093 } else if (Reg < 64) {
1094 Asm->EmitInt8(DW_CFA_offset + Reg);
1095 Asm->EOL("DW_CFA_offset + Reg (" + utostr(Reg) + ")");
1096 Asm->EmitULEB128Bytes(Offset);
1099 Asm->EmitInt8(DW_CFA_offset_extended);
1100 Asm->EOL("DW_CFA_offset_extended");
1101 Asm->EmitULEB128Bytes(Reg);
1103 Asm->EmitULEB128Bytes(Offset);
1112 //===----------------------------------------------------------------------===//
1113 /// DwarfDebug - Emits Dwarf debug directives.
1115 class DwarfDebug : public Dwarf {
1118 //===--------------------------------------------------------------------===//
1119 // Attributes used to construct specific Dwarf sections.
1122 /// CompileUnits - All the compile units involved in this build. The index
1123 /// of each entry in this vector corresponds to the sources in MMI.
1124 std::vector<CompileUnit *> CompileUnits;
1126 /// AbbreviationsSet - Used to uniquely define abbreviations.
1128 FoldingSet<DIEAbbrev> AbbreviationsSet;
1130 /// Abbreviations - A list of all the unique abbreviations in use.
1132 std::vector<DIEAbbrev *> Abbreviations;
1134 /// ValuesSet - Used to uniquely define values.
1136 FoldingSet<DIEValue> ValuesSet;
1138 /// Values - A list of all the unique values in use.
1140 std::vector<DIEValue *> Values;
1142 /// StringPool - A UniqueVector of strings used by indirect references.
1144 UniqueVector<std::string> StringPool;
1146 /// UnitMap - Map debug information descriptor to compile unit.
1148 std::map<DebugInfoDesc *, CompileUnit *> DescToUnitMap;
1150 /// SectionMap - Provides a unique id per text section.
1152 UniqueVector<std::string> SectionMap;
1154 /// SectionSourceLines - Tracks line numbers per text section.
1156 std::vector<std::vector<SourceLineInfo> > SectionSourceLines;
1158 /// didInitial - Flag to indicate if initial emission has been done.
1162 /// shouldEmit - Flag to indicate if debug information should be emitted.
1166 struct FunctionDebugFrameInfo {
1168 std::vector<MachineMove> Moves;
1170 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M):
1171 Number(Num), Moves(M) { }
1174 std::vector<FunctionDebugFrameInfo> DebugFrames;
1178 /// ShouldEmitDwarf - Returns true if Dwarf declarations should be made.
1180 bool ShouldEmitDwarf() const { return shouldEmit; }
1182 /// AssignAbbrevNumber - Define a unique number for the abbreviation.
1184 void AssignAbbrevNumber(DIEAbbrev &Abbrev) {
1185 // Profile the node so that we can make it unique.
1186 FoldingSetNodeID ID;
1189 // Check the set for priors.
1190 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
1192 // If it's newly added.
1193 if (InSet == &Abbrev) {
1194 // Add to abbreviation list.
1195 Abbreviations.push_back(&Abbrev);
1196 // Assign the vector position + 1 as its number.
1197 Abbrev.setNumber(Abbreviations.size());
1199 // Assign existing abbreviation number.
1200 Abbrev.setNumber(InSet->getNumber());
1204 /// NewString - Add a string to the constant pool and returns a label.
1206 DWLabel NewString(const std::string &String) {
1207 unsigned StringID = StringPool.insert(String);
1208 return DWLabel("string", StringID);
1211 /// NewDIEntry - Creates a new DIEntry to be a proxy for a debug information
1213 DIEntry *NewDIEntry(DIE *Entry = NULL) {
1217 FoldingSetNodeID ID;
1218 DIEntry::Profile(ID, Entry);
1220 Value = static_cast<DIEntry *>(ValuesSet.FindNodeOrInsertPos(ID, Where));
1222 if (Value) return Value;
1224 Value = new DIEntry(Entry);
1225 ValuesSet.InsertNode(Value, Where);
1227 Value = new DIEntry(Entry);
1230 Values.push_back(Value);
1234 /// SetDIEntry - Set a DIEntry once the debug information entry is defined.
1236 void SetDIEntry(DIEntry *Value, DIE *Entry) {
1237 Value->Entry = Entry;
1238 // Add to values set if not already there. If it is, we merely have a
1239 // duplicate in the values list (no harm.)
1240 ValuesSet.GetOrInsertNode(Value);
1243 /// AddUInt - Add an unsigned integer attribute data and value.
1245 void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer) {
1246 if (!Form) Form = DIEInteger::BestForm(false, Integer);
1248 FoldingSetNodeID ID;
1249 DIEInteger::Profile(ID, Integer);
1251 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1253 Value = new DIEInteger(Integer);
1254 ValuesSet.InsertNode(Value, Where);
1255 Values.push_back(Value);
1258 Die->AddValue(Attribute, Form, Value);
1261 /// AddSInt - Add an signed integer attribute data and value.
1263 void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer) {
1264 if (!Form) Form = DIEInteger::BestForm(true, Integer);
1266 FoldingSetNodeID ID;
1267 DIEInteger::Profile(ID, (uint64_t)Integer);
1269 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1271 Value = new DIEInteger(Integer);
1272 ValuesSet.InsertNode(Value, Where);
1273 Values.push_back(Value);
1276 Die->AddValue(Attribute, Form, Value);
1279 /// AddString - Add a std::string attribute data and value.
1281 void AddString(DIE *Die, unsigned Attribute, unsigned Form,
1282 const std::string &String) {
1283 FoldingSetNodeID ID;
1284 DIEString::Profile(ID, String);
1286 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1288 Value = new DIEString(String);
1289 ValuesSet.InsertNode(Value, Where);
1290 Values.push_back(Value);
1293 Die->AddValue(Attribute, Form, Value);
1296 /// AddLabel - Add a Dwarf label attribute data and value.
1298 void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
1299 const DWLabel &Label) {
1300 FoldingSetNodeID ID;
1301 DIEDwarfLabel::Profile(ID, Label);
1303 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1305 Value = new DIEDwarfLabel(Label);
1306 ValuesSet.InsertNode(Value, Where);
1307 Values.push_back(Value);
1310 Die->AddValue(Attribute, Form, Value);
1313 /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
1315 void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
1316 const std::string &Label) {
1317 FoldingSetNodeID ID;
1318 DIEObjectLabel::Profile(ID, Label);
1320 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1322 Value = new DIEObjectLabel(Label);
1323 ValuesSet.InsertNode(Value, Where);
1324 Values.push_back(Value);
1327 Die->AddValue(Attribute, Form, Value);
1330 /// AddSectionOffset - Add a section offset label attribute data and value.
1332 void AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
1333 const DWLabel &Label, const DWLabel &Section,
1334 bool isEH = false, bool useSet = true) {
1335 FoldingSetNodeID ID;
1336 DIESectionOffset::Profile(ID, Label, Section);
1338 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1340 Value = new DIESectionOffset(Label, Section, isEH, useSet);
1341 ValuesSet.InsertNode(Value, Where);
1342 Values.push_back(Value);
1345 Die->AddValue(Attribute, Form, Value);
1348 /// AddDelta - Add a label delta attribute data and value.
1350 void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
1351 const DWLabel &Hi, const DWLabel &Lo) {
1352 FoldingSetNodeID ID;
1353 DIEDelta::Profile(ID, Hi, Lo);
1355 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1357 Value = new DIEDelta(Hi, Lo);
1358 ValuesSet.InsertNode(Value, Where);
1359 Values.push_back(Value);
1362 Die->AddValue(Attribute, Form, Value);
1365 /// AddDIEntry - Add a DIE attribute data and value.
1367 void AddDIEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
1368 Die->AddValue(Attribute, Form, NewDIEntry(Entry));
1371 /// AddBlock - Add block data.
1373 void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block) {
1374 Block->ComputeSize(*this);
1375 FoldingSetNodeID ID;
1378 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1381 ValuesSet.InsertNode(Value, Where);
1382 Values.push_back(Value);
1384 // Already exists, reuse the previous one.
1386 Block = cast<DIEBlock>(Value);
1389 Die->AddValue(Attribute, Block->BestForm(), Value);
1394 /// AddSourceLine - Add location information to specified debug information
1396 void AddSourceLine(DIE *Die, CompileUnitDesc *File, unsigned Line) {
1398 CompileUnit *FileUnit = FindCompileUnit(File);
1399 unsigned FileID = FileUnit->getID();
1400 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1401 AddUInt(Die, DW_AT_decl_line, 0, Line);
1405 /// AddAddress - Add an address attribute to a die based on the location
1407 void AddAddress(DIE *Die, unsigned Attribute,
1408 const MachineLocation &Location) {
1409 unsigned Reg = RI->getDwarfRegNum(Location.getRegister(), false);
1410 DIEBlock *Block = new DIEBlock();
1412 if (Location.isRegister()) {
1414 AddUInt(Block, 0, DW_FORM_data1, DW_OP_reg0 + Reg);
1416 AddUInt(Block, 0, DW_FORM_data1, DW_OP_regx);
1417 AddUInt(Block, 0, DW_FORM_udata, Reg);
1421 AddUInt(Block, 0, DW_FORM_data1, DW_OP_breg0 + Reg);
1423 AddUInt(Block, 0, DW_FORM_data1, DW_OP_bregx);
1424 AddUInt(Block, 0, DW_FORM_udata, Reg);
1426 AddUInt(Block, 0, DW_FORM_sdata, Location.getOffset());
1429 AddBlock(Die, Attribute, 0, Block);
1432 /// AddBasicType - Add a new basic type attribute to the specified entity.
1434 void AddBasicType(DIE *Entity, CompileUnit *Unit,
1435 const std::string &Name,
1436 unsigned Encoding, unsigned Size) {
1437 DIE *Die = ConstructBasicType(Unit, Name, Encoding, Size);
1438 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, Die);
1441 /// ConstructBasicType - Construct a new basic type.
1443 DIE *ConstructBasicType(CompileUnit *Unit,
1444 const std::string &Name,
1445 unsigned Encoding, unsigned Size) {
1446 DIE Buffer(DW_TAG_base_type);
1447 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1448 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, Encoding);
1449 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1450 return Unit->AddDie(Buffer);
1453 /// AddPointerType - Add a new pointer type attribute to the specified entity.
1455 void AddPointerType(DIE *Entity, CompileUnit *Unit, const std::string &Name) {
1456 DIE *Die = ConstructPointerType(Unit, Name);
1457 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, Die);
1460 /// ConstructPointerType - Construct a new pointer type.
1462 DIE *ConstructPointerType(CompileUnit *Unit, const std::string &Name) {
1463 DIE Buffer(DW_TAG_pointer_type);
1464 AddUInt(&Buffer, DW_AT_byte_size, 0, TD->getPointerSize());
1465 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1466 return Unit->AddDie(Buffer);
1469 /// AddType - Add a new type attribute to the specified entity.
1471 void AddType(DIE *Entity, TypeDesc *TyDesc, CompileUnit *Unit) {
1473 AddBasicType(Entity, Unit, "", DW_ATE_signed, sizeof(int32_t));
1475 // Check for pre-existence.
1476 DIEntry *&Slot = Unit->getDIEntrySlotFor(TyDesc);
1478 // If it exists then use the existing value.
1480 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1484 if (SubprogramDesc *SubprogramTy = dyn_cast<SubprogramDesc>(TyDesc)) {
1485 // FIXME - Not sure why programs and variables are coming through here.
1486 // Short cut for handling subprogram types (not really a TyDesc.)
1487 AddPointerType(Entity, Unit, SubprogramTy->getName());
1488 } else if (GlobalVariableDesc *GlobalTy =
1489 dyn_cast<GlobalVariableDesc>(TyDesc)) {
1490 // FIXME - Not sure why programs and variables are coming through here.
1491 // Short cut for handling global variable types (not really a TyDesc.)
1492 AddPointerType(Entity, Unit, GlobalTy->getName());
1495 Slot = NewDIEntry();
1498 DIE Buffer(DW_TAG_base_type);
1499 ConstructType(Buffer, TyDesc, Unit);
1501 // Add debug information entry to entity and unit.
1502 DIE *Die = Unit->AddDie(Buffer);
1503 SetDIEntry(Slot, Die);
1504 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1509 /// ConstructType - Adds all the required attributes to the type.
1511 void ConstructType(DIE &Buffer, TypeDesc *TyDesc, CompileUnit *Unit) {
1512 // Get core information.
1513 const std::string &Name = TyDesc->getName();
1514 uint64_t Size = TyDesc->getSize() >> 3;
1516 if (BasicTypeDesc *BasicTy = dyn_cast<BasicTypeDesc>(TyDesc)) {
1517 // Fundamental types like int, float, bool
1518 Buffer.setTag(DW_TAG_base_type);
1519 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, BasicTy->getEncoding());
1520 } else if (DerivedTypeDesc *DerivedTy = dyn_cast<DerivedTypeDesc>(TyDesc)) {
1522 unsigned Tag = DerivedTy->getTag();
1523 // FIXME - Workaround for templates.
1524 if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
1525 // Pointers, typedefs et al.
1527 // Map to main type, void will not have a type.
1528 if (TypeDesc *FromTy = DerivedTy->getFromType())
1529 AddType(&Buffer, FromTy, Unit);
1530 } else if (CompositeTypeDesc *CompTy = dyn_cast<CompositeTypeDesc>(TyDesc)){
1532 unsigned Tag = CompTy->getTag();
1534 // Set tag accordingly.
1535 if (Tag == DW_TAG_vector_type)
1536 Buffer.setTag(DW_TAG_array_type);
1540 std::vector<DebugInfoDesc *> &Elements = CompTy->getElements();
1543 case DW_TAG_vector_type:
1544 AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1546 case DW_TAG_array_type: {
1547 // Add element type.
1548 if (TypeDesc *FromTy = CompTy->getFromType())
1549 AddType(&Buffer, FromTy, Unit);
1551 // Don't emit size attribute.
1554 // Construct an anonymous type for index type.
1555 DIE *IndexTy = ConstructBasicType(Unit, "", DW_ATE_signed,
1558 // Add subranges to array type.
1559 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1560 SubrangeDesc *SRD = cast<SubrangeDesc>(Elements[i]);
1561 int64_t Lo = SRD->getLo();
1562 int64_t Hi = SRD->getHi();
1563 DIE *Subrange = new DIE(DW_TAG_subrange_type);
1565 // If a range is available.
1567 AddDIEntry(Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1568 // Only add low if non-zero.
1569 if (Lo) AddSInt(Subrange, DW_AT_lower_bound, 0, Lo);
1570 AddSInt(Subrange, DW_AT_upper_bound, 0, Hi);
1573 Buffer.AddChild(Subrange);
1577 case DW_TAG_structure_type:
1578 case DW_TAG_union_type: {
1579 // Add elements to structure type.
1580 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1581 DebugInfoDesc *Element = Elements[i];
1583 if (DerivedTypeDesc *MemberDesc = dyn_cast<DerivedTypeDesc>(Element)){
1584 // Add field or base class.
1586 unsigned Tag = MemberDesc->getTag();
1588 // Extract the basic information.
1589 const std::string &Name = MemberDesc->getName();
1590 uint64_t Size = MemberDesc->getSize();
1591 uint64_t Align = MemberDesc->getAlign();
1592 uint64_t Offset = MemberDesc->getOffset();
1594 // Construct member debug information entry.
1595 DIE *Member = new DIE(Tag);
1597 // Add name if not "".
1599 AddString(Member, DW_AT_name, DW_FORM_string, Name);
1600 // Add location if available.
1601 AddSourceLine(Member, MemberDesc->getFile(), MemberDesc->getLine());
1603 // Most of the time the field info is the same as the members.
1604 uint64_t FieldSize = Size;
1605 uint64_t FieldAlign = Align;
1606 uint64_t FieldOffset = Offset;
1608 // Set the member type.
1609 TypeDesc *FromTy = MemberDesc->getFromType();
1610 AddType(Member, FromTy, Unit);
1612 // Walk up typedefs until a real size is found.
1614 if (FromTy->getTag() != DW_TAG_typedef) {
1615 FieldSize = FromTy->getSize();
1616 FieldAlign = FromTy->getSize();
1620 FromTy = cast<DerivedTypeDesc>(FromTy)->getFromType();
1623 // Unless we have a bit field.
1624 if (Tag == DW_TAG_member && FieldSize != Size) {
1625 // Construct the alignment mask.
1626 uint64_t AlignMask = ~(FieldAlign - 1);
1627 // Determine the high bit + 1 of the declared size.
1628 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1629 // Work backwards to determine the base offset of the field.
1630 FieldOffset = HiMark - FieldSize;
1631 // Now normalize offset to the field.
1632 Offset -= FieldOffset;
1634 // Maybe we need to work from the other end.
1635 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
1637 // Add size and offset.
1638 AddUInt(Member, DW_AT_byte_size, 0, FieldSize >> 3);
1639 AddUInt(Member, DW_AT_bit_size, 0, Size);
1640 AddUInt(Member, DW_AT_bit_offset, 0, Offset);
1643 // Add computation for offset.
1644 DIEBlock *Block = new DIEBlock();
1645 AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
1646 AddUInt(Block, 0, DW_FORM_udata, FieldOffset >> 3);
1647 AddBlock(Member, DW_AT_data_member_location, 0, Block);
1649 // Add accessibility (public default unless is base class.
1650 if (MemberDesc->isProtected()) {
1651 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_protected);
1652 } else if (MemberDesc->isPrivate()) {
1653 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_private);
1654 } else if (Tag == DW_TAG_inheritance) {
1655 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_public);
1658 Buffer.AddChild(Member);
1659 } else if (GlobalVariableDesc *StaticDesc =
1660 dyn_cast<GlobalVariableDesc>(Element)) {
1661 // Add static member.
1663 // Construct member debug information entry.
1664 DIE *Static = new DIE(DW_TAG_variable);
1666 // Add name and mangled name.
1667 const std::string &Name = StaticDesc->getName();
1668 const std::string &LinkageName = StaticDesc->getLinkageName();
1669 AddString(Static, DW_AT_name, DW_FORM_string, Name);
1670 if (!LinkageName.empty()) {
1671 AddString(Static, DW_AT_MIPS_linkage_name, DW_FORM_string,
1676 AddSourceLine(Static, StaticDesc->getFile(), StaticDesc->getLine());
1679 if (TypeDesc *StaticTy = StaticDesc->getType())
1680 AddType(Static, StaticTy, Unit);
1683 if (!StaticDesc->isStatic())
1684 AddUInt(Static, DW_AT_external, DW_FORM_flag, 1);
1685 AddUInt(Static, DW_AT_declaration, DW_FORM_flag, 1);
1687 Buffer.AddChild(Static);
1688 } else if (SubprogramDesc *MethodDesc =
1689 dyn_cast<SubprogramDesc>(Element)) {
1690 // Add member function.
1692 // Construct member debug information entry.
1693 DIE *Method = new DIE(DW_TAG_subprogram);
1695 // Add name and mangled name.
1696 const std::string &Name = MethodDesc->getName();
1697 const std::string &LinkageName = MethodDesc->getLinkageName();
1699 AddString(Method, DW_AT_name, DW_FORM_string, Name);
1700 bool IsCTor = TyDesc->getName() == Name;
1702 if (!LinkageName.empty()) {
1703 AddString(Method, DW_AT_MIPS_linkage_name, DW_FORM_string,
1708 AddSourceLine(Method, MethodDesc->getFile(), MethodDesc->getLine());
1711 if (CompositeTypeDesc *MethodTy =
1712 dyn_cast_or_null<CompositeTypeDesc>(MethodDesc->getType())) {
1713 // Get argument information.
1714 std::vector<DebugInfoDesc *> &Args = MethodTy->getElements();
1719 AddType(Method, dyn_cast<TypeDesc>(Args[0]), Unit);
1723 for(unsigned i = 1, N = Args.size(); i < N; ++i) {
1724 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1725 AddType(Arg, cast<TypeDesc>(Args[i]), Unit);
1726 AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1);
1727 Method->AddChild(Arg);
1732 if (!MethodDesc->isStatic())
1733 AddUInt(Method, DW_AT_external, DW_FORM_flag, 1);
1734 AddUInt(Method, DW_AT_declaration, DW_FORM_flag, 1);
1736 Buffer.AddChild(Method);
1741 case DW_TAG_enumeration_type: {
1742 // Add enumerators to enumeration type.
1743 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1744 EnumeratorDesc *ED = cast<EnumeratorDesc>(Elements[i]);
1745 const std::string &Name = ED->getName();
1746 int64_t Value = ED->getValue();
1747 DIE *Enumerator = new DIE(DW_TAG_enumerator);
1748 AddString(Enumerator, DW_AT_name, DW_FORM_string, Name);
1749 AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
1750 Buffer.AddChild(Enumerator);
1755 case DW_TAG_subroutine_type: {
1756 // Add prototype flag.
1757 AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
1759 AddType(&Buffer, dyn_cast<TypeDesc>(Elements[0]), Unit);
1762 for(unsigned i = 1, N = Elements.size(); i < N; ++i) {
1763 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1764 AddType(Arg, cast<TypeDesc>(Elements[i]), Unit);
1765 Buffer.AddChild(Arg);
1774 // Add size if non-zero (derived types don't have a size.)
1775 if (Size) AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1776 // Add name if not anonymous or intermediate type.
1777 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1778 // Add source line info if available.
1779 AddSourceLine(&Buffer, TyDesc->getFile(), TyDesc->getLine());
1782 /// NewCompileUnit - Create new compile unit and it's debug information entry.
1784 CompileUnit *NewCompileUnit(CompileUnitDesc *UnitDesc, unsigned ID) {
1785 // Construct debug information entry.
1786 DIE *Die = new DIE(DW_TAG_compile_unit);
1787 AddSectionOffset(Die, DW_AT_stmt_list, DW_FORM_data4,
1788 DWLabel("section_line", 0), DWLabel("section_line", 0), false);
1789 AddString(Die, DW_AT_producer, DW_FORM_string, UnitDesc->getProducer());
1790 AddUInt (Die, DW_AT_language, DW_FORM_data1, UnitDesc->getLanguage());
1791 AddString(Die, DW_AT_name, DW_FORM_string, UnitDesc->getFileName());
1792 AddString(Die, DW_AT_comp_dir, DW_FORM_string, UnitDesc->getDirectory());
1794 // Construct compile unit.
1795 CompileUnit *Unit = new CompileUnit(UnitDesc, ID, Die);
1797 // Add Unit to compile unit map.
1798 DescToUnitMap[UnitDesc] = Unit;
1803 /// GetBaseCompileUnit - Get the main compile unit.
1805 CompileUnit *GetBaseCompileUnit() const {
1806 CompileUnit *Unit = CompileUnits[0];
1807 assert(Unit && "Missing compile unit.");
1811 /// FindCompileUnit - Get the compile unit for the given descriptor.
1813 CompileUnit *FindCompileUnit(CompileUnitDesc *UnitDesc) {
1814 CompileUnit *Unit = DescToUnitMap[UnitDesc];
1815 assert(Unit && "Missing compile unit.");
1819 /// NewGlobalVariable - Add a new global variable DIE.
1821 DIE *NewGlobalVariable(GlobalVariableDesc *GVD) {
1822 // Get the compile unit context.
1823 CompileUnitDesc *UnitDesc =
1824 static_cast<CompileUnitDesc *>(GVD->getContext());
1825 CompileUnit *Unit = GetBaseCompileUnit();
1827 // Check for pre-existence.
1828 DIE *&Slot = Unit->getDieMapSlotFor(GVD);
1829 if (Slot) return Slot;
1831 // Get the global variable itself.
1832 GlobalVariable *GV = GVD->getGlobalVariable();
1834 const std::string &Name = GVD->getName();
1835 const std::string &FullName = GVD->getFullName();
1836 const std::string &LinkageName = GVD->getLinkageName();
1837 // Create the global's variable DIE.
1838 DIE *VariableDie = new DIE(DW_TAG_variable);
1839 AddString(VariableDie, DW_AT_name, DW_FORM_string, Name);
1840 if (!LinkageName.empty()) {
1841 AddString(VariableDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
1844 AddType(VariableDie, GVD->getType(), Unit);
1845 if (!GVD->isStatic())
1846 AddUInt(VariableDie, DW_AT_external, DW_FORM_flag, 1);
1848 // Add source line info if available.
1849 AddSourceLine(VariableDie, UnitDesc, GVD->getLine());
1852 DIEBlock *Block = new DIEBlock();
1853 AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
1854 AddObjectLabel(Block, 0, DW_FORM_udata, Asm->getGlobalLinkName(GV));
1855 AddBlock(VariableDie, DW_AT_location, 0, Block);
1860 // Add to context owner.
1861 Unit->getDie()->AddChild(VariableDie);
1863 // Expose as global.
1864 // FIXME - need to check external flag.
1865 Unit->AddGlobal(FullName, VariableDie);
1870 /// NewSubprogram - Add a new subprogram DIE.
1872 DIE *NewSubprogram(SubprogramDesc *SPD) {
1873 // Get the compile unit context.
1874 CompileUnitDesc *UnitDesc =
1875 static_cast<CompileUnitDesc *>(SPD->getContext());
1876 CompileUnit *Unit = GetBaseCompileUnit();
1878 // Check for pre-existence.
1879 DIE *&Slot = Unit->getDieMapSlotFor(SPD);
1880 if (Slot) return Slot;
1882 // Gather the details (simplify add attribute code.)
1883 const std::string &Name = SPD->getName();
1884 const std::string &FullName = SPD->getFullName();
1885 const std::string &LinkageName = SPD->getLinkageName();
1887 DIE *SubprogramDie = new DIE(DW_TAG_subprogram);
1888 AddString(SubprogramDie, DW_AT_name, DW_FORM_string, Name);
1889 if (!LinkageName.empty()) {
1890 AddString(SubprogramDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
1893 if (SPD->getType()) AddType(SubprogramDie, SPD->getType(), Unit);
1894 if (!SPD->isStatic())
1895 AddUInt(SubprogramDie, DW_AT_external, DW_FORM_flag, 1);
1896 AddUInt(SubprogramDie, DW_AT_prototyped, DW_FORM_flag, 1);
1898 // Add source line info if available.
1899 AddSourceLine(SubprogramDie, UnitDesc, SPD->getLine());
1902 Slot = SubprogramDie;
1904 // Add to context owner.
1905 Unit->getDie()->AddChild(SubprogramDie);
1907 // Expose as global.
1908 Unit->AddGlobal(FullName, SubprogramDie);
1910 return SubprogramDie;
1913 /// NewScopeVariable - Create a new scope variable.
1915 DIE *NewScopeVariable(DebugVariable *DV, CompileUnit *Unit) {
1916 // Get the descriptor.
1917 VariableDesc *VD = DV->getDesc();
1919 // Translate tag to proper Dwarf tag. The result variable is dropped for
1922 switch (VD->getTag()) {
1923 case DW_TAG_return_variable: return NULL;
1924 case DW_TAG_arg_variable: Tag = DW_TAG_formal_parameter; break;
1925 case DW_TAG_auto_variable: // fall thru
1926 default: Tag = DW_TAG_variable; break;
1929 // Define variable debug information entry.
1930 DIE *VariableDie = new DIE(Tag);
1931 AddString(VariableDie, DW_AT_name, DW_FORM_string, VD->getName());
1933 // Add source line info if available.
1934 AddSourceLine(VariableDie, VD->getFile(), VD->getLine());
1936 // Add variable type.
1937 AddType(VariableDie, VD->getType(), Unit);
1939 // Add variable address.
1940 MachineLocation Location;
1941 Location.set(RI->getFrameRegister(*MF),
1942 RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
1943 AddAddress(VariableDie, DW_AT_location, Location);
1948 /// ConstructScope - Construct the components of a scope.
1950 void ConstructScope(DebugScope *ParentScope,
1951 unsigned ParentStartID, unsigned ParentEndID,
1952 DIE *ParentDie, CompileUnit *Unit) {
1953 // Add variables to scope.
1954 std::vector<DebugVariable *> &Variables = ParentScope->getVariables();
1955 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
1956 DIE *VariableDie = NewScopeVariable(Variables[i], Unit);
1957 if (VariableDie) ParentDie->AddChild(VariableDie);
1960 // Add nested scopes.
1961 std::vector<DebugScope *> &Scopes = ParentScope->getScopes();
1962 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1963 // Define the Scope debug information entry.
1964 DebugScope *Scope = Scopes[j];
1965 // FIXME - Ignore inlined functions for the time being.
1966 if (!Scope->getParent()) continue;
1968 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
1969 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
1971 // Ignore empty scopes.
1972 if (StartID == EndID && StartID != 0) continue;
1973 if (Scope->getScopes().empty() && Scope->getVariables().empty()) continue;
1975 if (StartID == ParentStartID && EndID == ParentEndID) {
1976 // Just add stuff to the parent scope.
1977 ConstructScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
1979 DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
1981 // Add the scope bounds.
1983 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
1984 DWLabel("label", StartID));
1986 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
1987 DWLabel("func_begin", SubprogramCount));
1990 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
1991 DWLabel("label", EndID));
1993 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
1994 DWLabel("func_end", SubprogramCount));
1997 // Add the scope contents.
1998 ConstructScope(Scope, StartID, EndID, ScopeDie, Unit);
1999 ParentDie->AddChild(ScopeDie);
2004 /// ConstructRootScope - Construct the scope for the subprogram.
2006 void ConstructRootScope(DebugScope *RootScope) {
2007 // Exit if there is no root scope.
2008 if (!RootScope) return;
2010 // Get the subprogram debug information entry.
2011 SubprogramDesc *SPD = cast<SubprogramDesc>(RootScope->getDesc());
2013 // Get the compile unit context.
2014 CompileUnit *Unit = GetBaseCompileUnit();
2016 // Get the subprogram die.
2017 DIE *SPDie = Unit->getDieMapSlotFor(SPD);
2018 assert(SPDie && "Missing subprogram descriptor");
2020 // Add the function bounds.
2021 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2022 DWLabel("func_begin", SubprogramCount));
2023 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2024 DWLabel("func_end", SubprogramCount));
2025 MachineLocation Location(RI->getFrameRegister(*MF));
2026 AddAddress(SPDie, DW_AT_frame_base, Location);
2028 ConstructScope(RootScope, 0, 0, SPDie, Unit);
2031 /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
2032 /// tools to recognize the object file contains Dwarf information.
2033 void EmitInitial() {
2034 // Check to see if we already emitted intial headers.
2035 if (didInitial) return;
2038 // Dwarf sections base addresses.
2039 if (TAI->doesDwarfRequireFrameSection()) {
2040 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2041 EmitLabel("section_debug_frame", 0);
2043 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2044 EmitLabel("section_info", 0);
2045 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2046 EmitLabel("section_abbrev", 0);
2047 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2048 EmitLabel("section_aranges", 0);
2049 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2050 EmitLabel("section_macinfo", 0);
2051 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2052 EmitLabel("section_line", 0);
2053 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2054 EmitLabel("section_loc", 0);
2055 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2056 EmitLabel("section_pubnames", 0);
2057 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2058 EmitLabel("section_str", 0);
2059 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2060 EmitLabel("section_ranges", 0);
2062 Asm->SwitchToTextSection(TAI->getTextSection());
2063 EmitLabel("text_begin", 0);
2064 Asm->SwitchToDataSection(TAI->getDataSection());
2065 EmitLabel("data_begin", 0);
2068 /// EmitDIE - Recusively Emits a debug information entry.
2070 void EmitDIE(DIE *Die) {
2071 // Get the abbreviation for this DIE.
2072 unsigned AbbrevNumber = Die->getAbbrevNumber();
2073 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2077 // Emit the code (index) for the abbreviation.
2078 Asm->EmitULEB128Bytes(AbbrevNumber);
2081 Asm->EOL(std::string("Abbrev [" +
2082 utostr(AbbrevNumber) +
2083 "] 0x" + utohexstr(Die->getOffset()) +
2084 ":0x" + utohexstr(Die->getSize()) + " " +
2085 TagString(Abbrev->getTag())));
2089 SmallVector<DIEValue*, 32> &Values = Die->getValues();
2090 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2092 // Emit the DIE attribute values.
2093 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2094 unsigned Attr = AbbrevData[i].getAttribute();
2095 unsigned Form = AbbrevData[i].getForm();
2096 assert(Form && "Too many attributes for DIE (check abbreviation)");
2099 case DW_AT_sibling: {
2100 Asm->EmitInt32(Die->SiblingOffset());
2104 // Emit an attribute using the defined form.
2105 Values[i]->EmitValue(*this, Form);
2110 Asm->EOL(AttributeString(Attr));
2113 // Emit the DIE children if any.
2114 if (Abbrev->getChildrenFlag() == DW_CHILDREN_yes) {
2115 const std::vector<DIE *> &Children = Die->getChildren();
2117 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2118 EmitDIE(Children[j]);
2121 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2125 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
2127 unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
2128 // Get the children.
2129 const std::vector<DIE *> &Children = Die->getChildren();
2131 // If not last sibling and has children then add sibling offset attribute.
2132 if (!Last && !Children.empty()) Die->AddSiblingOffset();
2134 // Record the abbreviation.
2135 AssignAbbrevNumber(Die->getAbbrev());
2137 // Get the abbreviation for this DIE.
2138 unsigned AbbrevNumber = Die->getAbbrevNumber();
2139 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2142 Die->setOffset(Offset);
2144 // Start the size with the size of abbreviation code.
2145 Offset += Asm->SizeULEB128(AbbrevNumber);
2147 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2148 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
2150 // Size the DIE attribute values.
2151 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2152 // Size attribute value.
2153 Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
2156 // Size the DIE children if any.
2157 if (!Children.empty()) {
2158 assert(Abbrev->getChildrenFlag() == DW_CHILDREN_yes &&
2159 "Children flag not set");
2161 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2162 Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
2165 // End of children marker.
2166 Offset += sizeof(int8_t);
2169 Die->setSize(Offset - Die->getOffset());
2173 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
2175 void SizeAndOffsets() {
2176 // Process base compile unit.
2177 CompileUnit *Unit = GetBaseCompileUnit();
2178 // Compute size of compile unit header
2179 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2180 sizeof(int16_t) + // DWARF version number
2181 sizeof(int32_t) + // Offset Into Abbrev. Section
2182 sizeof(int8_t); // Pointer Size (in bytes)
2183 SizeAndOffsetDie(Unit->getDie(), Offset, true);
2186 /// EmitDebugInfo - Emit the debug info section.
2188 void EmitDebugInfo() {
2189 // Start debug info section.
2190 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2192 CompileUnit *Unit = GetBaseCompileUnit();
2193 DIE *Die = Unit->getDie();
2194 // Emit the compile units header.
2195 EmitLabel("info_begin", Unit->getID());
2196 // Emit size of content not including length itself
2197 unsigned ContentSize = Die->getSize() +
2198 sizeof(int16_t) + // DWARF version number
2199 sizeof(int32_t) + // Offset Into Abbrev. Section
2200 sizeof(int8_t) + // Pointer Size (in bytes)
2201 sizeof(int32_t); // FIXME - extra pad for gdb bug.
2203 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2204 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2205 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2206 Asm->EOL("Offset Into Abbrev. Section");
2207 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2210 // FIXME - extra padding for gdb bug.
2211 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2212 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2213 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2214 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2215 EmitLabel("info_end", Unit->getID());
2220 /// EmitAbbreviations - Emit the abbreviation section.
2222 void EmitAbbreviations() const {
2223 // Check to see if it is worth the effort.
2224 if (!Abbreviations.empty()) {
2225 // Start the debug abbrev section.
2226 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2228 EmitLabel("abbrev_begin", 0);
2230 // For each abbrevation.
2231 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2232 // Get abbreviation data
2233 const DIEAbbrev *Abbrev = Abbreviations[i];
2235 // Emit the abbrevations code (base 1 index.)
2236 Asm->EmitULEB128Bytes(Abbrev->getNumber());
2237 Asm->EOL("Abbreviation Code");
2239 // Emit the abbreviations data.
2240 Abbrev->Emit(*this);
2245 // Mark end of abbreviations.
2246 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2248 EmitLabel("abbrev_end", 0);
2254 /// EmitDebugLines - Emit source line information.
2256 void EmitDebugLines() {
2257 // If there are no lines to emit (such as when we're using .loc directives
2258 // to emit .debug_line information) don't emit a .debug_line header.
2259 if (SectionSourceLines.empty())
2262 // Minimum line delta, thus ranging from -10..(255-10).
2263 const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
2264 // Maximum line delta, thus ranging from -10..(255-10).
2265 const int MaxLineDelta = 255 + MinLineDelta;
2267 // Start the dwarf line section.
2268 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2270 // Construct the section header.
2272 EmitDifference("line_end", 0, "line_begin", 0, true);
2273 Asm->EOL("Length of Source Line Info");
2274 EmitLabel("line_begin", 0);
2276 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2278 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2279 Asm->EOL("Prolog Length");
2280 EmitLabel("line_prolog_begin", 0);
2282 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2284 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2286 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
2288 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2290 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
2292 // Line number standard opcode encodings argument count
2293 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2294 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2295 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2296 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2297 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2298 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2299 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2300 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2301 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2303 const UniqueVector<std::string> &Directories = MMI->getDirectories();
2304 const UniqueVector<SourceFileInfo> &SourceFiles = MMI->getSourceFiles();
2306 // Emit directories.
2307 for (unsigned DirectoryID = 1, NDID = Directories.size();
2308 DirectoryID <= NDID; ++DirectoryID) {
2309 Asm->EmitString(Directories[DirectoryID]); Asm->EOL("Directory");
2311 Asm->EmitInt8(0); Asm->EOL("End of directories");
2314 for (unsigned SourceID = 1, NSID = SourceFiles.size();
2315 SourceID <= NSID; ++SourceID) {
2316 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
2317 Asm->EmitString(SourceFile.getName());
2319 Asm->EmitULEB128Bytes(SourceFile.getDirectoryID());
2320 Asm->EOL("Directory #");
2321 Asm->EmitULEB128Bytes(0);
2322 Asm->EOL("Mod date");
2323 Asm->EmitULEB128Bytes(0);
2324 Asm->EOL("File size");
2326 Asm->EmitInt8(0); Asm->EOL("End of files");
2328 EmitLabel("line_prolog_end", 0);
2330 // A sequence for each text section.
2331 for (unsigned j = 0, M = SectionSourceLines.size(); j < M; ++j) {
2332 // Isolate current sections line info.
2333 const std::vector<SourceLineInfo> &LineInfos = SectionSourceLines[j];
2336 Asm->EOL(std::string("Section ") + SectionMap[j + 1]);
2340 // Dwarf assumes we start with first line of first source file.
2341 unsigned Source = 1;
2344 // Construct rows of the address, source, line, column matrix.
2345 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2346 const SourceLineInfo &LineInfo = LineInfos[i];
2347 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2348 if (!LabelID) continue;
2350 unsigned SourceID = LineInfo.getSourceID();
2351 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
2352 unsigned DirectoryID = SourceFile.getDirectoryID();
2354 Asm->EOL(Directories[DirectoryID]
2355 + SourceFile.getName()
2357 + utostr_32(LineInfo.getLine()));
2361 // Define the line address.
2362 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2363 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2364 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2365 EmitReference("label", LabelID); Asm->EOL("Location label");
2367 // If change of source, then switch to the new source.
2368 if (Source != LineInfo.getSourceID()) {
2369 Source = LineInfo.getSourceID();
2370 Asm->EmitInt8(DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2371 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2374 // If change of line.
2375 if (Line != LineInfo.getLine()) {
2376 // Determine offset.
2377 int Offset = LineInfo.getLine() - Line;
2378 int Delta = Offset - MinLineDelta;
2381 Line = LineInfo.getLine();
2383 // If delta is small enough and in range...
2384 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2385 // ... then use fast opcode.
2386 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2388 // ... otherwise use long hand.
2389 Asm->EmitInt8(DW_LNS_advance_line); Asm->EOL("DW_LNS_advance_line");
2390 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2391 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2394 // Copy the previous row (different address or source)
2395 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2399 // Define last address of section.
2400 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2401 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2402 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2403 EmitReference("section_end", j + 1); Asm->EOL("Section end label");
2405 // Mark end of matrix.
2406 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2407 Asm->EmitULEB128Bytes(1); Asm->EOL();
2408 Asm->EmitInt8(1); Asm->EOL();
2411 EmitLabel("line_end", 0);
2416 /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
2418 void EmitCommonDebugFrame() {
2419 if (!TAI->doesDwarfRequireFrameSection())
2423 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2424 TargetFrameInfo::StackGrowsUp ?
2425 TD->getPointerSize() : -TD->getPointerSize();
2427 // Start the dwarf frame section.
2428 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2430 EmitLabel("debug_frame_common", 0);
2431 EmitDifference("debug_frame_common_end", 0,
2432 "debug_frame_common_begin", 0, true);
2433 Asm->EOL("Length of Common Information Entry");
2435 EmitLabel("debug_frame_common_begin", 0);
2436 Asm->EmitInt32((int)DW_CIE_ID);
2437 Asm->EOL("CIE Identifier Tag");
2438 Asm->EmitInt8(DW_CIE_VERSION);
2439 Asm->EOL("CIE Version");
2440 Asm->EmitString("");
2441 Asm->EOL("CIE Augmentation");
2442 Asm->EmitULEB128Bytes(1);
2443 Asm->EOL("CIE Code Alignment Factor");
2444 Asm->EmitSLEB128Bytes(stackGrowth);
2445 Asm->EOL("CIE Data Alignment Factor");
2446 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
2447 Asm->EOL("CIE RA Column");
2449 std::vector<MachineMove> Moves;
2450 RI->getInitialFrameState(Moves);
2452 EmitFrameMoves(NULL, 0, Moves, false);
2454 Asm->EmitAlignment(2, 0, 0, false);
2455 EmitLabel("debug_frame_common_end", 0);
2460 /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2462 void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
2463 if (!TAI->doesDwarfRequireFrameSection())
2466 // Start the dwarf frame section.
2467 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2469 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2470 "debug_frame_begin", DebugFrameInfo.Number, true);
2471 Asm->EOL("Length of Frame Information Entry");
2473 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2475 EmitSectionOffset("debug_frame_common", "section_debug_frame",
2477 Asm->EOL("FDE CIE offset");
2479 EmitReference("func_begin", DebugFrameInfo.Number);
2480 Asm->EOL("FDE initial location");
2481 EmitDifference("func_end", DebugFrameInfo.Number,
2482 "func_begin", DebugFrameInfo.Number);
2483 Asm->EOL("FDE address range");
2485 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves, false);
2487 Asm->EmitAlignment(2, 0, 0, false);
2488 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
2493 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
2495 void EmitDebugPubNames() {
2496 // Start the dwarf pubnames section.
2497 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2499 CompileUnit *Unit = GetBaseCompileUnit();
2501 EmitDifference("pubnames_end", Unit->getID(),
2502 "pubnames_begin", Unit->getID(), true);
2503 Asm->EOL("Length of Public Names Info");
2505 EmitLabel("pubnames_begin", Unit->getID());
2507 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF Version");
2509 EmitSectionOffset("info_begin", "section_info",
2510 Unit->getID(), 0, true, false);
2511 Asm->EOL("Offset of Compilation Unit Info");
2513 EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(),true);
2514 Asm->EOL("Compilation Unit Length");
2516 std::map<std::string, DIE *> &Globals = Unit->getGlobals();
2518 for (std::map<std::string, DIE *>::iterator GI = Globals.begin(),
2521 const std::string &Name = GI->first;
2522 DIE * Entity = GI->second;
2524 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2525 Asm->EmitString(Name); Asm->EOL("External Name");
2528 Asm->EmitInt32(0); Asm->EOL("End Mark");
2529 EmitLabel("pubnames_end", Unit->getID());
2534 /// EmitDebugStr - Emit visible names into a debug str section.
2536 void EmitDebugStr() {
2537 // Check to see if it is worth the effort.
2538 if (!StringPool.empty()) {
2539 // Start the dwarf str section.
2540 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2542 // For each of strings in the string pool.
2543 for (unsigned StringID = 1, N = StringPool.size();
2544 StringID <= N; ++StringID) {
2545 // Emit a label for reference from debug information entries.
2546 EmitLabel("string", StringID);
2547 // Emit the string itself.
2548 const std::string &String = StringPool[StringID];
2549 Asm->EmitString(String); Asm->EOL();
2556 /// EmitDebugLoc - Emit visible names into a debug loc section.
2558 void EmitDebugLoc() {
2559 // Start the dwarf loc section.
2560 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2565 /// EmitDebugARanges - Emit visible names into a debug aranges section.
2567 void EmitDebugARanges() {
2568 // Start the dwarf aranges section.
2569 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2573 CompileUnit *Unit = GetBaseCompileUnit();
2575 // Don't include size of length
2576 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
2578 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("Dwarf Version");
2580 EmitReference("info_begin", Unit->getID());
2581 Asm->EOL("Offset of Compilation Unit Info");
2583 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
2585 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
2587 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
2588 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
2591 EmitReference("text_begin", 0); Asm->EOL("Address");
2592 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
2594 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2595 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
2601 /// EmitDebugRanges - Emit visible names into a debug ranges section.
2603 void EmitDebugRanges() {
2604 // Start the dwarf ranges section.
2605 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2610 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
2612 void EmitDebugMacInfo() {
2613 // Start the dwarf macinfo section.
2614 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2619 /// ConstructCompileUnitDIEs - Create a compile unit DIE for each source and
2621 void ConstructCompileUnitDIEs() {
2622 const UniqueVector<CompileUnitDesc *> CUW = MMI->getCompileUnits();
2624 for (unsigned i = 1, N = CUW.size(); i <= N; ++i) {
2625 unsigned ID = MMI->RecordSource(CUW[i]);
2626 CompileUnit *Unit = NewCompileUnit(CUW[i], ID);
2627 CompileUnits.push_back(Unit);
2631 /// ConstructGlobalDIEs - Create DIEs for each of the externally visible
2632 /// global variables.
2633 void ConstructGlobalDIEs() {
2634 std::vector<void*> GlobalVariables;
2635 GlobalVariableDesc GVD;
2636 MMI->getAnchoredDescriptors(*M, &GVD, GlobalVariables);
2638 for (unsigned i = 0, N = GlobalVariables.size(); i < N; ++i)
2639 NewGlobalVariable((GlobalVariableDesc *)GlobalVariables[i]);
2642 /// ConstructSubprogramDIEs - Create DIEs for each of the externally visible
2644 void ConstructSubprogramDIEs() {
2645 std::vector<void*> Subprograms;
2647 MMI->getAnchoredDescriptors(*M, &SPD, Subprograms);
2649 for (unsigned i = 0, N = Subprograms.size(); i < N; ++i)
2650 NewSubprogram((SubprogramDesc*)Subprograms[i]);
2654 //===--------------------------------------------------------------------===//
2655 // Main entry points.
2657 DwarfDebug(std::ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
2658 : Dwarf(OS, A, T, "dbg")
2660 , AbbreviationsSet(InitAbbreviationsSetSize)
2662 , ValuesSet(InitValuesSetSize)
2667 , SectionSourceLines()
2672 virtual ~DwarfDebug() {
2673 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i)
2674 delete CompileUnits[i];
2675 for (unsigned j = 0, M = Values.size(); j < M; ++j)
2679 /// SetModuleInfo - Set machine module information when it's known that pass
2680 /// manager has created it. Set by the target AsmPrinter.
2681 void SetModuleInfo(MachineModuleInfo *mmi) {
2682 // Make sure initial declarations are made.
2683 if (!MMI && mmi->hasDebugInfo()) {
2687 // Create all the compile unit DIEs.
2688 ConstructCompileUnitDIEs();
2690 // Create DIEs for each of the externally visible global variables.
2691 ConstructGlobalDIEs();
2693 // Create DIEs for each of the externally visible subprograms.
2694 ConstructSubprogramDIEs();
2696 // Prime section data.
2697 SectionMap.insert(TAI->getTextSection());
2699 // Print out .file directives to specify files for .loc directives. These
2700 // are printed out early so that they precede any .loc directives.
2701 if (TAI->hasDotLocAndDotFile()) {
2702 const UniqueVector<SourceFileInfo> &SourceFiles = MMI->getSourceFiles();
2703 const UniqueVector<std::string> &Directories = MMI->getDirectories();
2704 for (unsigned i = 1, e = SourceFiles.size(); i <= e; ++i) {
2705 sys::Path FullPath(Directories[SourceFiles[i].getDirectoryID()]);
2706 bool AppendOk = FullPath.appendComponent(SourceFiles[i].getName());
2707 assert(AppendOk && "Could not append filename to directory!");
2708 Asm->EmitFile(i, FullPath.toString());
2713 // Emit initial sections
2718 /// BeginModule - Emit all Dwarf sections that should come prior to the
2720 void BeginModule(Module *M) {
2723 if (!ShouldEmitDwarf()) return;
2726 /// EndModule - Emit all Dwarf sections that should come after the content.
2729 if (!ShouldEmitDwarf()) return;
2731 // Standard sections final addresses.
2732 Asm->SwitchToTextSection(TAI->getTextSection());
2733 EmitLabel("text_end", 0);
2734 Asm->SwitchToDataSection(TAI->getDataSection());
2735 EmitLabel("data_end", 0);
2737 // End text sections.
2738 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
2739 Asm->SwitchToTextSection(SectionMap[i].c_str());
2740 EmitLabel("section_end", i);
2743 // Emit common frame information.
2744 EmitCommonDebugFrame();
2746 // Emit function debug frame information
2747 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2748 E = DebugFrames.end(); I != E; ++I)
2749 EmitFunctionDebugFrame(*I);
2751 // Compute DIE offsets and sizes.
2754 // Emit all the DIEs into a debug info section
2757 // Corresponding abbreviations into a abbrev section.
2758 EmitAbbreviations();
2760 // Emit source line correspondence into a debug line section.
2763 // Emit info into a debug pubnames section.
2764 EmitDebugPubNames();
2766 // Emit info into a debug str section.
2769 // Emit info into a debug loc section.
2772 // Emit info into a debug aranges section.
2775 // Emit info into a debug ranges section.
2778 // Emit info into a debug macinfo section.
2782 /// BeginFunction - Gather pre-function debug information. Assumes being
2783 /// emitted immediately after the function entry point.
2784 void BeginFunction(MachineFunction *MF) {
2787 if (!ShouldEmitDwarf()) return;
2789 // Begin accumulating function debug information.
2790 MMI->BeginFunction(MF);
2792 // Assumes in correct section after the entry point.
2793 EmitLabel("func_begin", ++SubprogramCount);
2795 // Emit label for the implicitly defined dbg.stoppoint at the start of
2797 const std::vector<SourceLineInfo> &LineInfos = MMI->getSourceLines();
2798 if (!LineInfos.empty()) {
2799 const SourceLineInfo &LineInfo = LineInfos[0];
2800 Asm->printLabel(LineInfo.getLabelID());
2804 /// EndFunction - Gather and emit post-function debug information.
2806 void EndFunction() {
2807 if (!ShouldEmitDwarf()) return;
2809 // Define end label for subprogram.
2810 EmitLabel("func_end", SubprogramCount);
2812 // Get function line info.
2813 const std::vector<SourceLineInfo> &LineInfos = MMI->getSourceLines();
2815 if (!LineInfos.empty()) {
2816 // Get section line info.
2817 unsigned ID = SectionMap.insert(Asm->CurrentSection);
2818 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2819 std::vector<SourceLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2820 // Append the function info to section info.
2821 SectionLineInfos.insert(SectionLineInfos.end(),
2822 LineInfos.begin(), LineInfos.end());
2825 // Construct scopes for subprogram.
2826 ConstructRootScope(MMI->getRootScope());
2828 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
2829 MMI->getFrameMoves()));
2833 //===----------------------------------------------------------------------===//
2834 /// DwarfException - Emits Dwarf exception handling directives.
2836 class DwarfException : public Dwarf {
2839 struct FunctionEHFrameInfo {
2842 unsigned PersonalityIndex;
2844 bool hasLandingPads;
2845 std::vector<MachineMove> Moves;
2846 const Function * function;
2848 FunctionEHFrameInfo(const std::string &FN, unsigned Num, unsigned P,
2850 const std::vector<MachineMove> &M,
2852 FnName(FN), Number(Num), PersonalityIndex(P),
2853 hasCalls(hC), hasLandingPads(hL), Moves(M), function (f) { }
2856 std::vector<FunctionEHFrameInfo> EHFrames;
2858 /// shouldEmitTable - Per-function flag to indicate if EH tables should
2860 bool shouldEmitTable;
2862 /// shouldEmitMoves - Per-function flag to indicate if frame moves info
2863 /// should be emitted.
2864 bool shouldEmitMoves;
2866 /// shouldEmitTableModule - Per-module flag to indicate if EH tables
2867 /// should be emitted.
2868 bool shouldEmitTableModule;
2870 /// shouldEmitFrameModule - Per-module flag to indicate if frame moves
2871 /// should be emitted.
2872 bool shouldEmitMovesModule;
2874 /// EmitCommonEHFrame - Emit the common eh unwind frame.
2876 void EmitCommonEHFrame(const Function *Personality, unsigned Index) {
2877 // Size and sign of stack growth.
2879 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2880 TargetFrameInfo::StackGrowsUp ?
2881 TD->getPointerSize() : -TD->getPointerSize();
2883 // Begin eh frame section.
2884 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
2885 O << "EH_frame" << Index << ":\n";
2886 EmitLabel("section_eh_frame", Index);
2888 // Define base labels.
2889 EmitLabel("eh_frame_common", Index);
2891 // Define the eh frame length.
2892 EmitDifference("eh_frame_common_end", Index,
2893 "eh_frame_common_begin", Index, true);
2894 Asm->EOL("Length of Common Information Entry");
2897 EmitLabel("eh_frame_common_begin", Index);
2898 Asm->EmitInt32((int)0);
2899 Asm->EOL("CIE Identifier Tag");
2900 Asm->EmitInt8(DW_CIE_VERSION);
2901 Asm->EOL("CIE Version");
2903 // The personality presence indicates that language specific information
2904 // will show up in the eh frame.
2905 Asm->EmitString(Personality ? "zPLR" : "zR");
2906 Asm->EOL("CIE Augmentation");
2908 // Round out reader.
2909 Asm->EmitULEB128Bytes(1);
2910 Asm->EOL("CIE Code Alignment Factor");
2911 Asm->EmitSLEB128Bytes(stackGrowth);
2912 Asm->EOL("CIE Data Alignment Factor");
2913 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), true));
2914 Asm->EOL("CIE Return Address Column");
2916 // If there is a personality, we need to indicate the functions location.
2918 Asm->EmitULEB128Bytes(7);
2919 Asm->EOL("Augmentation Size");
2921 if (TAI->getNeedsIndirectEncoding()) {
2922 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4 | DW_EH_PE_indirect);
2923 Asm->EOL("Personality (pcrel sdata4 indirect)");
2925 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
2926 Asm->EOL("Personality (pcrel sdata4)");
2929 PrintRelDirective(true);
2930 O << TAI->getPersonalityPrefix();
2931 Asm->EmitExternalGlobal((const GlobalVariable *)(Personality));
2932 O << TAI->getPersonalitySuffix();
2933 if (strcmp(TAI->getPersonalitySuffix(), "+4@GOTPCREL"))
2934 O << "-" << TAI->getPCSymbol();
2935 Asm->EOL("Personality");
2937 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
2938 Asm->EOL("LSDA Encoding (pcrel sdata4)");
2939 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
2940 Asm->EOL("FDE Encoding (pcrel sdata4)");
2942 Asm->EmitULEB128Bytes(1);
2943 Asm->EOL("Augmentation Size");
2944 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
2945 Asm->EOL("FDE Encoding (pcrel sdata4)");
2948 // Indicate locations of general callee saved registers in frame.
2949 std::vector<MachineMove> Moves;
2950 RI->getInitialFrameState(Moves);
2951 EmitFrameMoves(NULL, 0, Moves, true);
2953 // On Darwin the linker honors the alignment of eh_frame, which means it
2954 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
2955 // you get holes which confuse readers of eh_frame.
2956 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
2958 EmitLabel("eh_frame_common_end", Index);
2963 /// EmitEHFrame - Emit function exception frame information.
2965 void EmitEHFrame(const FunctionEHFrameInfo &EHFrameInfo) {
2966 Function::LinkageTypes linkage = EHFrameInfo.function->getLinkage();
2968 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
2970 // Externally visible entry into the functions eh frame info.
2971 // If the corresponding function is static, this should not be
2972 // externally visible.
2973 if (linkage != Function::InternalLinkage) {
2974 if (const char *GlobalEHDirective = TAI->getGlobalEHDirective())
2975 O << GlobalEHDirective << EHFrameInfo.FnName << "\n";
2978 // If corresponding function is weak definition, this should be too.
2979 if ((linkage == Function::WeakLinkage ||
2980 linkage == Function::LinkOnceLinkage) &&
2981 TAI->getWeakDefDirective())
2982 O << TAI->getWeakDefDirective() << EHFrameInfo.FnName << "\n";
2984 // If there are no calls then you can't unwind. This may mean we can
2985 // omit the EH Frame, but some environments do not handle weak absolute
2987 // If UnwindTablesMandatory is set we cannot do this optimization; the
2988 // unwind info is to be available for non-EH uses.
2989 if (!EHFrameInfo.hasCalls &&
2990 !UnwindTablesMandatory &&
2991 ((linkage != Function::WeakLinkage &&
2992 linkage != Function::LinkOnceLinkage) ||
2993 !TAI->getWeakDefDirective() ||
2994 TAI->getSupportsWeakOmittedEHFrame()))
2996 O << EHFrameInfo.FnName << " = 0\n";
2997 // This name has no connection to the function, so it might get
2998 // dead-stripped when the function is not, erroneously. Prohibit
2999 // dead-stripping unconditionally.
3000 if (const char *UsedDirective = TAI->getUsedDirective())
3001 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3003 O << EHFrameInfo.FnName << ":\n";
3006 EmitDifference("eh_frame_end", EHFrameInfo.Number,
3007 "eh_frame_begin", EHFrameInfo.Number, true);
3008 Asm->EOL("Length of Frame Information Entry");
3010 EmitLabel("eh_frame_begin", EHFrameInfo.Number);
3012 EmitSectionOffset("eh_frame_begin", "eh_frame_common",
3013 EHFrameInfo.Number, EHFrameInfo.PersonalityIndex,
3015 Asm->EOL("FDE CIE offset");
3017 EmitReference("eh_func_begin", EHFrameInfo.Number, true, true);
3018 Asm->EOL("FDE initial location");
3019 EmitDifference("eh_func_end", EHFrameInfo.Number,
3020 "eh_func_begin", EHFrameInfo.Number, true);
3021 Asm->EOL("FDE address range");
3023 // If there is a personality and landing pads then point to the language
3024 // specific data area in the exception table.
3025 if (EHFrameInfo.PersonalityIndex) {
3026 Asm->EmitULEB128Bytes(4);
3027 Asm->EOL("Augmentation size");
3029 if (EHFrameInfo.hasLandingPads)
3030 EmitReference("exception", EHFrameInfo.Number, true, true);
3032 Asm->EmitInt32((int)0);
3033 Asm->EOL("Language Specific Data Area");
3035 Asm->EmitULEB128Bytes(0);
3036 Asm->EOL("Augmentation size");
3039 // Indicate locations of function specific callee saved registers in
3041 EmitFrameMoves("eh_func_begin", EHFrameInfo.Number, EHFrameInfo.Moves, true);
3043 // On Darwin the linker honors the alignment of eh_frame, which means it
3044 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3045 // you get holes which confuse readers of eh_frame.
3046 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
3048 EmitLabel("eh_frame_end", EHFrameInfo.Number);
3050 // If the function is marked used, this table should be also. We cannot
3051 // make the mark unconditional in this case, since retaining the table
3052 // also retains the function in this case, and there is code around
3053 // that depends on unused functions (calling undefined externals) being
3054 // dead-stripped to link correctly. Yes, there really is.
3055 if (MMI->getUsedFunctions().count(EHFrameInfo.function))
3056 if (const char *UsedDirective = TAI->getUsedDirective())
3057 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3061 /// EmitExceptionTable - Emit landing pads and actions.
3063 /// The general organization of the table is complex, but the basic concepts
3064 /// are easy. First there is a header which describes the location and
3065 /// organization of the three components that follow.
3066 /// 1. The landing pad site information describes the range of code covered
3067 /// by the try. In our case it's an accumulation of the ranges covered
3068 /// by the invokes in the try. There is also a reference to the landing
3069 /// pad that handles the exception once processed. Finally an index into
3070 /// the actions table.
3071 /// 2. The action table, in our case, is composed of pairs of type ids
3072 /// and next action offset. Starting with the action index from the
3073 /// landing pad site, each type Id is checked for a match to the current
3074 /// exception. If it matches then the exception and type id are passed
3075 /// on to the landing pad. Otherwise the next action is looked up. This
3076 /// chain is terminated with a next action of zero. If no type id is
3077 /// found the the frame is unwound and handling continues.
3078 /// 3. Type id table contains references to all the C++ typeinfo for all
3079 /// catches in the function. This tables is reversed indexed base 1.
3081 /// SharedTypeIds - How many leading type ids two landing pads have in common.
3082 static unsigned SharedTypeIds(const LandingPadInfo *L,
3083 const LandingPadInfo *R) {
3084 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3085 unsigned LSize = LIds.size(), RSize = RIds.size();
3086 unsigned MinSize = LSize < RSize ? LSize : RSize;
3089 for (; Count != MinSize; ++Count)
3090 if (LIds[Count] != RIds[Count])
3096 /// PadLT - Order landing pads lexicographically by type id.
3097 static bool PadLT(const LandingPadInfo *L, const LandingPadInfo *R) {
3098 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3099 unsigned LSize = LIds.size(), RSize = RIds.size();
3100 unsigned MinSize = LSize < RSize ? LSize : RSize;
3102 for (unsigned i = 0; i != MinSize; ++i)
3103 if (LIds[i] != RIds[i])
3104 return LIds[i] < RIds[i];
3106 return LSize < RSize;
3110 static inline unsigned getEmptyKey() { return -1U; }
3111 static inline unsigned getTombstoneKey() { return -2U; }
3112 static unsigned getHashValue(const unsigned &Key) { return Key; }
3113 static bool isEqual(unsigned LHS, unsigned RHS) { return LHS == RHS; }
3114 static bool isPod() { return true; }
3117 /// ActionEntry - Structure describing an entry in the actions table.
3118 struct ActionEntry {
3119 int ValueForTypeID; // The value to write - may not be equal to the type id.
3121 struct ActionEntry *Previous;
3124 /// PadRange - Structure holding a try-range and the associated landing pad.
3126 // The index of the landing pad.
3128 // The index of the begin and end labels in the landing pad's label lists.
3129 unsigned RangeIndex;
3132 typedef DenseMap<unsigned, PadRange, KeyInfo> RangeMapType;
3134 /// CallSiteEntry - Structure describing an entry in the call-site table.
3135 struct CallSiteEntry {
3136 // The 'try-range' is BeginLabel .. EndLabel.
3137 unsigned BeginLabel; // zero indicates the start of the function.
3138 unsigned EndLabel; // zero indicates the end of the function.
3139 // The landing pad starts at PadLabel.
3140 unsigned PadLabel; // zero indicates that there is no landing pad.
3144 void EmitExceptionTable() {
3145 const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
3146 const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
3147 const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
3148 if (PadInfos.empty()) return;
3150 // Sort the landing pads in order of their type ids. This is used to fold
3151 // duplicate actions.
3152 SmallVector<const LandingPadInfo *, 64> LandingPads;
3153 LandingPads.reserve(PadInfos.size());
3154 for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
3155 LandingPads.push_back(&PadInfos[i]);
3156 std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
3158 // Negative type ids index into FilterIds, positive type ids index into
3159 // TypeInfos. The value written for a positive type id is just the type
3160 // id itself. For a negative type id, however, the value written is the
3161 // (negative) byte offset of the corresponding FilterIds entry. The byte
3162 // offset is usually equal to the type id, because the FilterIds entries
3163 // are written using a variable width encoding which outputs one byte per
3164 // entry as long as the value written is not too large, but can differ.
3165 // This kind of complication does not occur for positive type ids because
3166 // type infos are output using a fixed width encoding.
3167 // FilterOffsets[i] holds the byte offset corresponding to FilterIds[i].
3168 SmallVector<int, 16> FilterOffsets;
3169 FilterOffsets.reserve(FilterIds.size());
3171 for(std::vector<unsigned>::const_iterator I = FilterIds.begin(),
3172 E = FilterIds.end(); I != E; ++I) {
3173 FilterOffsets.push_back(Offset);
3174 Offset -= Asm->SizeULEB128(*I);
3177 // Compute the actions table and gather the first action index for each
3178 // landing pad site.
3179 SmallVector<ActionEntry, 32> Actions;
3180 SmallVector<unsigned, 64> FirstActions;
3181 FirstActions.reserve(LandingPads.size());
3183 int FirstAction = 0;
3184 unsigned SizeActions = 0;
3185 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3186 const LandingPadInfo *LP = LandingPads[i];
3187 const std::vector<int> &TypeIds = LP->TypeIds;
3188 const unsigned NumShared = i ? SharedTypeIds(LP, LandingPads[i-1]) : 0;
3189 unsigned SizeSiteActions = 0;
3191 if (NumShared < TypeIds.size()) {
3192 unsigned SizeAction = 0;
3193 ActionEntry *PrevAction = 0;
3196 const unsigned SizePrevIds = LandingPads[i-1]->TypeIds.size();
3197 assert(Actions.size());
3198 PrevAction = &Actions.back();
3199 SizeAction = Asm->SizeSLEB128(PrevAction->NextAction) +
3200 Asm->SizeSLEB128(PrevAction->ValueForTypeID);
3201 for (unsigned j = NumShared; j != SizePrevIds; ++j) {
3202 SizeAction -= Asm->SizeSLEB128(PrevAction->ValueForTypeID);
3203 SizeAction += -PrevAction->NextAction;
3204 PrevAction = PrevAction->Previous;
3208 // Compute the actions.
3209 for (unsigned I = NumShared, M = TypeIds.size(); I != M; ++I) {
3210 int TypeID = TypeIds[I];
3211 assert(-1-TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
3212 int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
3213 unsigned SizeTypeID = Asm->SizeSLEB128(ValueForTypeID);
3215 int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
3216 SizeAction = SizeTypeID + Asm->SizeSLEB128(NextAction);
3217 SizeSiteActions += SizeAction;
3219 ActionEntry Action = {ValueForTypeID, NextAction, PrevAction};
3220 Actions.push_back(Action);
3222 PrevAction = &Actions.back();
3225 // Record the first action of the landing pad site.
3226 FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
3227 } // else identical - re-use previous FirstAction
3229 FirstActions.push_back(FirstAction);
3231 // Compute this sites contribution to size.
3232 SizeActions += SizeSiteActions;
3235 // Compute the call-site table. The entry for an invoke has a try-range
3236 // containing the call, a non-zero landing pad and an appropriate action.
3237 // The entry for an ordinary call has a try-range containing the call and
3238 // zero for the landing pad and the action. Calls marked 'nounwind' have
3239 // no entry and must not be contained in the try-range of any entry - they
3240 // form gaps in the table. Entries must be ordered by try-range address.
3241 SmallVector<CallSiteEntry, 64> CallSites;
3243 RangeMapType PadMap;
3244 // Invokes and nounwind calls have entries in PadMap (due to being bracketed
3245 // by try-range labels when lowered). Ordinary calls do not, so appropriate
3246 // try-ranges for them need be deduced.
3247 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3248 const LandingPadInfo *LandingPad = LandingPads[i];
3249 for (unsigned j = 0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
3250 unsigned BeginLabel = LandingPad->BeginLabels[j];
3251 assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
3252 PadRange P = { i, j };
3253 PadMap[BeginLabel] = P;
3257 // The end label of the previous invoke or nounwind try-range.
3258 unsigned LastLabel = 0;
3260 // Whether there is a potentially throwing instruction (currently this means
3261 // an ordinary call) between the end of the previous try-range and now.
3262 bool SawPotentiallyThrowing = false;
3264 // Whether the last callsite entry was for an invoke.
3265 bool PreviousIsInvoke = false;
3267 // Visit all instructions in order of address.
3268 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
3270 for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
3272 if (!MI->isLabel()) {
3273 SawPotentiallyThrowing |= MI->getDesc().isCall();
3277 unsigned BeginLabel = MI->getOperand(0).getImm();
3278 assert(BeginLabel && "Invalid label!");
3280 // End of the previous try-range?
3281 if (BeginLabel == LastLabel)
3282 SawPotentiallyThrowing = false;
3284 // Beginning of a new try-range?
3285 RangeMapType::iterator L = PadMap.find(BeginLabel);
3286 if (L == PadMap.end())
3287 // Nope, it was just some random label.
3290 PadRange P = L->second;
3291 const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
3293 assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
3294 "Inconsistent landing pad map!");
3296 // If some instruction between the previous try-range and this one may
3297 // throw, create a call-site entry with no landing pad for the region
3298 // between the try-ranges.
3299 if (SawPotentiallyThrowing) {
3300 CallSiteEntry Site = {LastLabel, BeginLabel, 0, 0};
3301 CallSites.push_back(Site);
3302 PreviousIsInvoke = false;
3305 LastLabel = LandingPad->EndLabels[P.RangeIndex];
3306 assert(BeginLabel && LastLabel && "Invalid landing pad!");
3308 if (LandingPad->LandingPadLabel) {
3309 // This try-range is for an invoke.
3310 CallSiteEntry Site = {BeginLabel, LastLabel,
3311 LandingPad->LandingPadLabel, FirstActions[P.PadIndex]};
3313 // Try to merge with the previous call-site.
3314 if (PreviousIsInvoke) {
3315 CallSiteEntry &Prev = CallSites.back();
3316 if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
3317 // Extend the range of the previous entry.
3318 Prev.EndLabel = Site.EndLabel;
3323 // Otherwise, create a new call-site.
3324 CallSites.push_back(Site);
3325 PreviousIsInvoke = true;
3328 PreviousIsInvoke = false;
3332 // If some instruction between the previous try-range and the end of the
3333 // function may throw, create a call-site entry with no landing pad for the
3334 // region following the try-range.
3335 if (SawPotentiallyThrowing) {
3336 CallSiteEntry Site = {LastLabel, 0, 0, 0};
3337 CallSites.push_back(Site);
3343 const unsigned SiteStartSize = sizeof(int32_t); // DW_EH_PE_udata4
3344 const unsigned SiteLengthSize = sizeof(int32_t); // DW_EH_PE_udata4
3345 const unsigned LandingPadSize = sizeof(int32_t); // DW_EH_PE_udata4
3346 unsigned SizeSites = CallSites.size() * (SiteStartSize +
3349 for (unsigned i = 0, e = CallSites.size(); i < e; ++i)
3350 SizeSites += Asm->SizeULEB128(CallSites[i].Action);
3353 const unsigned TypeInfoSize = TD->getPointerSize(); // DW_EH_PE_absptr
3354 unsigned SizeTypes = TypeInfos.size() * TypeInfoSize;
3356 unsigned TypeOffset = sizeof(int8_t) + // Call site format
3357 Asm->SizeULEB128(SizeSites) + // Call-site table length
3358 SizeSites + SizeActions + SizeTypes;
3360 unsigned TotalSize = sizeof(int8_t) + // LPStart format
3361 sizeof(int8_t) + // TType format
3362 Asm->SizeULEB128(TypeOffset) + // TType base offset
3365 unsigned SizeAlign = (4 - TotalSize) & 3;
3367 // Begin the exception table.
3368 Asm->SwitchToDataSection(TAI->getDwarfExceptionSection());
3369 O << "GCC_except_table" << SubprogramCount << ":\n";
3370 Asm->EmitAlignment(2, 0, 0, false);
3371 for (unsigned i = 0; i != SizeAlign; ++i) {
3373 Asm->EOL("Padding");
3375 EmitLabel("exception", SubprogramCount);
3378 Asm->EmitInt8(DW_EH_PE_omit);
3379 Asm->EOL("LPStart format (DW_EH_PE_omit)");
3380 Asm->EmitInt8(DW_EH_PE_absptr);
3381 Asm->EOL("TType format (DW_EH_PE_absptr)");
3382 Asm->EmitULEB128Bytes(TypeOffset);
3383 Asm->EOL("TType base offset");
3384 Asm->EmitInt8(DW_EH_PE_udata4);
3385 Asm->EOL("Call site format (DW_EH_PE_udata4)");
3386 Asm->EmitULEB128Bytes(SizeSites);
3387 Asm->EOL("Call-site table length");
3389 // Emit the landing pad site information.
3390 for (unsigned i = 0; i < CallSites.size(); ++i) {
3391 CallSiteEntry &S = CallSites[i];
3392 const char *BeginTag;
3393 unsigned BeginNumber;
3395 if (!S.BeginLabel) {
3396 BeginTag = "eh_func_begin";
3397 BeginNumber = SubprogramCount;
3400 BeginNumber = S.BeginLabel;
3403 EmitSectionOffset(BeginTag, "eh_func_begin", BeginNumber, SubprogramCount,
3405 Asm->EOL("Region start");
3408 EmitDifference("eh_func_end", SubprogramCount, BeginTag, BeginNumber,
3411 EmitDifference("label", S.EndLabel, BeginTag, BeginNumber, true);
3413 Asm->EOL("Region length");
3418 EmitSectionOffset("label", "eh_func_begin", S.PadLabel, SubprogramCount,
3420 Asm->EOL("Landing pad");
3422 Asm->EmitULEB128Bytes(S.Action);
3426 // Emit the actions.
3427 for (unsigned I = 0, N = Actions.size(); I != N; ++I) {
3428 ActionEntry &Action = Actions[I];
3430 Asm->EmitSLEB128Bytes(Action.ValueForTypeID);
3431 Asm->EOL("TypeInfo index");
3432 Asm->EmitSLEB128Bytes(Action.NextAction);
3433 Asm->EOL("Next action");
3436 // Emit the type ids.
3437 for (unsigned M = TypeInfos.size(); M; --M) {
3438 GlobalVariable *GV = TypeInfos[M - 1];
3440 PrintRelDirective();
3443 O << Asm->getGlobalLinkName(GV);
3447 Asm->EOL("TypeInfo");
3450 // Emit the filter typeids.
3451 for (unsigned j = 0, M = FilterIds.size(); j < M; ++j) {
3452 unsigned TypeID = FilterIds[j];
3453 Asm->EmitULEB128Bytes(TypeID);
3454 Asm->EOL("Filter TypeInfo index");
3457 Asm->EmitAlignment(2, 0, 0, false);
3461 //===--------------------------------------------------------------------===//
3462 // Main entry points.
3464 DwarfException(std::ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
3465 : Dwarf(OS, A, T, "eh")
3466 , shouldEmitTable(false)
3467 , shouldEmitMoves(false)
3468 , shouldEmitTableModule(false)
3469 , shouldEmitMovesModule(false)
3472 virtual ~DwarfException() {}
3474 /// SetModuleInfo - Set machine module information when it's known that pass
3475 /// manager has created it. Set by the target AsmPrinter.
3476 void SetModuleInfo(MachineModuleInfo *mmi) {
3480 /// BeginModule - Emit all exception information that should come prior to the
3482 void BeginModule(Module *M) {
3486 /// EndModule - Emit all exception information that should come after the
3489 if (shouldEmitMovesModule || shouldEmitTableModule) {
3490 const std::vector<Function *> Personalities = MMI->getPersonalities();
3491 for (unsigned i =0; i < Personalities.size(); ++i)
3492 EmitCommonEHFrame(Personalities[i], i);
3494 for (std::vector<FunctionEHFrameInfo>::iterator I = EHFrames.begin(),
3495 E = EHFrames.end(); I != E; ++I)
3500 /// BeginFunction - Gather pre-function exception information. Assumes being
3501 /// emitted immediately after the function entry point.
3502 void BeginFunction(MachineFunction *MF) {
3504 shouldEmitTable = shouldEmitMoves = false;
3505 if (MMI && TAI->doesSupportExceptionHandling()) {
3507 // Map all labels and get rid of any dead landing pads.
3508 MMI->TidyLandingPads();
3509 // If any landing pads survive, we need an EH table.
3510 if (MMI->getLandingPads().size())
3511 shouldEmitTable = true;
3513 // See if we need frame move info.
3514 if ((MMI->hasDebugInfo() && TAI->doesDebugInfoRequireFrameMoveInfo()) ||
3515 !MF->getFunction()->doesNotThrow() ||
3516 UnwindTablesMandatory)
3517 shouldEmitMoves = true;
3519 if (shouldEmitMoves || shouldEmitTable)
3520 // Assumes in correct section after the entry point.
3521 EmitLabel("eh_func_begin", ++SubprogramCount);
3523 shouldEmitTableModule |= shouldEmitTable;
3524 shouldEmitMovesModule |= shouldEmitMoves;
3527 /// EndFunction - Gather and emit post-function exception information.
3529 void EndFunction() {
3530 if (shouldEmitMoves || shouldEmitTable) {
3531 EmitLabel("eh_func_end", SubprogramCount);
3532 EmitExceptionTable();
3534 // Save EH frame information
3536 push_back(FunctionEHFrameInfo(getAsm()->getCurrentFunctionEHName(MF),
3538 MMI->getPersonalityIndex(),
3539 MF->getFrameInfo()->hasCalls(),
3540 !MMI->getLandingPads().empty(),
3541 MMI->getFrameMoves(),
3542 MF->getFunction()));
3547 } // End of namespace llvm
3549 //===----------------------------------------------------------------------===//
3551 /// Emit - Print the abbreviation using the specified Dwarf writer.
3553 void DIEAbbrev::Emit(const DwarfDebug &DD) const {
3554 // Emit its Dwarf tag type.
3555 DD.getAsm()->EmitULEB128Bytes(Tag);
3556 DD.getAsm()->EOL(TagString(Tag));
3558 // Emit whether it has children DIEs.
3559 DD.getAsm()->EmitULEB128Bytes(ChildrenFlag);
3560 DD.getAsm()->EOL(ChildrenString(ChildrenFlag));
3562 // For each attribute description.
3563 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3564 const DIEAbbrevData &AttrData = Data[i];
3566 // Emit attribute type.
3567 DD.getAsm()->EmitULEB128Bytes(AttrData.getAttribute());
3568 DD.getAsm()->EOL(AttributeString(AttrData.getAttribute()));
3571 DD.getAsm()->EmitULEB128Bytes(AttrData.getForm());
3572 DD.getAsm()->EOL(FormEncodingString(AttrData.getForm()));
3575 // Mark end of abbreviation.
3576 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(1)");
3577 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(2)");
3581 void DIEAbbrev::print(std::ostream &O) {
3582 O << "Abbreviation @"
3583 << std::hex << (intptr_t)this << std::dec
3587 << ChildrenString(ChildrenFlag)
3590 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3592 << AttributeString(Data[i].getAttribute())
3594 << FormEncodingString(Data[i].getForm())
3598 void DIEAbbrev::dump() { print(cerr); }
3601 //===----------------------------------------------------------------------===//
3604 void DIEValue::dump() {
3609 //===----------------------------------------------------------------------===//
3611 /// EmitValue - Emit integer of appropriate size.
3613 void DIEInteger::EmitValue(DwarfDebug &DD, unsigned Form) {
3615 case DW_FORM_flag: // Fall thru
3616 case DW_FORM_ref1: // Fall thru
3617 case DW_FORM_data1: DD.getAsm()->EmitInt8(Integer); break;
3618 case DW_FORM_ref2: // Fall thru
3619 case DW_FORM_data2: DD.getAsm()->EmitInt16(Integer); break;
3620 case DW_FORM_ref4: // Fall thru
3621 case DW_FORM_data4: DD.getAsm()->EmitInt32(Integer); break;
3622 case DW_FORM_ref8: // Fall thru
3623 case DW_FORM_data8: DD.getAsm()->EmitInt64(Integer); break;
3624 case DW_FORM_udata: DD.getAsm()->EmitULEB128Bytes(Integer); break;
3625 case DW_FORM_sdata: DD.getAsm()->EmitSLEB128Bytes(Integer); break;
3626 default: assert(0 && "DIE Value form not supported yet"); break;
3630 /// SizeOf - Determine size of integer value in bytes.
3632 unsigned DIEInteger::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3634 case DW_FORM_flag: // Fall thru
3635 case DW_FORM_ref1: // Fall thru
3636 case DW_FORM_data1: return sizeof(int8_t);
3637 case DW_FORM_ref2: // Fall thru
3638 case DW_FORM_data2: return sizeof(int16_t);
3639 case DW_FORM_ref4: // Fall thru
3640 case DW_FORM_data4: return sizeof(int32_t);
3641 case DW_FORM_ref8: // Fall thru
3642 case DW_FORM_data8: return sizeof(int64_t);
3643 case DW_FORM_udata: return DD.getAsm()->SizeULEB128(Integer);
3644 case DW_FORM_sdata: return DD.getAsm()->SizeSLEB128(Integer);
3645 default: assert(0 && "DIE Value form not supported yet"); break;
3650 //===----------------------------------------------------------------------===//
3652 /// EmitValue - Emit string value.
3654 void DIEString::EmitValue(DwarfDebug &DD, unsigned Form) {
3655 DD.getAsm()->EmitString(String);
3658 //===----------------------------------------------------------------------===//
3660 /// EmitValue - Emit label value.
3662 void DIEDwarfLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
3663 bool IsSmall = Form == DW_FORM_data4;
3664 DD.EmitReference(Label, false, IsSmall);
3667 /// SizeOf - Determine size of label value in bytes.
3669 unsigned DIEDwarfLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3670 if (Form == DW_FORM_data4) return 4;
3671 return DD.getTargetData()->getPointerSize();
3674 //===----------------------------------------------------------------------===//
3676 /// EmitValue - Emit label value.
3678 void DIEObjectLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
3679 bool IsSmall = Form == DW_FORM_data4;
3680 DD.EmitReference(Label, false, IsSmall);
3683 /// SizeOf - Determine size of label value in bytes.
3685 unsigned DIEObjectLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3686 if (Form == DW_FORM_data4) return 4;
3687 return DD.getTargetData()->getPointerSize();
3690 //===----------------------------------------------------------------------===//
3692 /// EmitValue - Emit delta value.
3694 void DIESectionOffset::EmitValue(DwarfDebug &DD, unsigned Form) {
3695 bool IsSmall = Form == DW_FORM_data4;
3696 DD.EmitSectionOffset(Label.Tag, Section.Tag,
3697 Label.Number, Section.Number, IsSmall, IsEH, UseSet);
3700 /// SizeOf - Determine size of delta value in bytes.
3702 unsigned DIESectionOffset::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3703 if (Form == DW_FORM_data4) return 4;
3704 return DD.getTargetData()->getPointerSize();
3707 //===----------------------------------------------------------------------===//
3709 /// EmitValue - Emit delta value.
3711 void DIEDelta::EmitValue(DwarfDebug &DD, unsigned Form) {
3712 bool IsSmall = Form == DW_FORM_data4;
3713 DD.EmitDifference(LabelHi, LabelLo, IsSmall);
3716 /// SizeOf - Determine size of delta value in bytes.
3718 unsigned DIEDelta::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3719 if (Form == DW_FORM_data4) return 4;
3720 return DD.getTargetData()->getPointerSize();
3723 //===----------------------------------------------------------------------===//
3725 /// EmitValue - Emit debug information entry offset.
3727 void DIEntry::EmitValue(DwarfDebug &DD, unsigned Form) {
3728 DD.getAsm()->EmitInt32(Entry->getOffset());
3731 //===----------------------------------------------------------------------===//
3733 /// ComputeSize - calculate the size of the block.
3735 unsigned DIEBlock::ComputeSize(DwarfDebug &DD) {
3737 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
3739 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3740 Size += Values[i]->SizeOf(DD, AbbrevData[i].getForm());
3746 /// EmitValue - Emit block data.
3748 void DIEBlock::EmitValue(DwarfDebug &DD, unsigned Form) {
3750 case DW_FORM_block1: DD.getAsm()->EmitInt8(Size); break;
3751 case DW_FORM_block2: DD.getAsm()->EmitInt16(Size); break;
3752 case DW_FORM_block4: DD.getAsm()->EmitInt32(Size); break;
3753 case DW_FORM_block: DD.getAsm()->EmitULEB128Bytes(Size); break;
3754 default: assert(0 && "Improper form for block"); break;
3757 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
3759 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3761 Values[i]->EmitValue(DD, AbbrevData[i].getForm());
3765 /// SizeOf - Determine size of block data in bytes.
3767 unsigned DIEBlock::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3769 case DW_FORM_block1: return Size + sizeof(int8_t);
3770 case DW_FORM_block2: return Size + sizeof(int16_t);
3771 case DW_FORM_block4: return Size + sizeof(int32_t);
3772 case DW_FORM_block: return Size + DD.getAsm()->SizeULEB128(Size);
3773 default: assert(0 && "Improper form for block"); break;
3778 //===----------------------------------------------------------------------===//
3779 /// DIE Implementation
3782 for (unsigned i = 0, N = Children.size(); i < N; ++i)
3786 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
3788 void DIE::AddSiblingOffset() {
3789 DIEInteger *DI = new DIEInteger(0);
3790 Values.insert(Values.begin(), DI);
3791 Abbrev.AddFirstAttribute(DW_AT_sibling, DW_FORM_ref4);
3794 /// Profile - Used to gather unique data for the value folding set.
3796 void DIE::Profile(FoldingSetNodeID &ID) {
3799 for (unsigned i = 0, N = Children.size(); i < N; ++i)
3800 ID.AddPointer(Children[i]);
3802 for (unsigned j = 0, M = Values.size(); j < M; ++j)
3803 ID.AddPointer(Values[j]);
3807 void DIE::print(std::ostream &O, unsigned IncIndent) {
3808 static unsigned IndentCount = 0;
3809 IndentCount += IncIndent;
3810 const std::string Indent(IndentCount, ' ');
3811 bool isBlock = Abbrev.getTag() == 0;
3816 << "0x" << std::hex << (intptr_t)this << std::dec
3817 << ", Offset: " << Offset
3818 << ", Size: " << Size
3822 << TagString(Abbrev.getTag())
3824 << ChildrenString(Abbrev.getChildrenFlag());
3826 O << "Size: " << Size;
3830 const SmallVector<DIEAbbrevData, 8> &Data = Abbrev.getData();
3833 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3836 O << AttributeString(Data[i].getAttribute());
3838 O << "Blk[" << i << "]";
3841 << FormEncodingString(Data[i].getForm())
3843 Values[i]->print(O);
3848 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
3849 Children[j]->print(O, 4);
3852 if (!isBlock) O << "\n";
3853 IndentCount -= IncIndent;
3861 //===----------------------------------------------------------------------===//
3862 /// DwarfWriter Implementation
3865 DwarfWriter::DwarfWriter(std::ostream &OS, AsmPrinter *A,
3866 const TargetAsmInfo *T) {
3867 DE = new DwarfException(OS, A, T);
3868 DD = new DwarfDebug(OS, A, T);
3871 DwarfWriter::~DwarfWriter() {
3876 /// SetModuleInfo - Set machine module info when it's known that pass manager
3877 /// has created it. Set by the target AsmPrinter.
3878 void DwarfWriter::SetModuleInfo(MachineModuleInfo *MMI) {
3879 DD->SetModuleInfo(MMI);
3880 DE->SetModuleInfo(MMI);
3883 /// BeginModule - Emit all Dwarf sections that should come prior to the
3885 void DwarfWriter::BeginModule(Module *M) {
3890 /// EndModule - Emit all Dwarf sections that should come after the content.
3892 void DwarfWriter::EndModule() {
3897 /// BeginFunction - Gather pre-function debug information. Assumes being
3898 /// emitted immediately after the function entry point.
3899 void DwarfWriter::BeginFunction(MachineFunction *MF) {
3900 DE->BeginFunction(MF);
3901 DD->BeginFunction(MF);
3904 /// EndFunction - Gather and emit post-function debug information.
3906 void DwarfWriter::EndFunction() {
3910 if (MachineModuleInfo *MMI = DD->getMMI() ? DD->getMMI() : DE->getMMI()) {
3911 // Clear function debug information.