1 //===-- llvm/CodeGen/DwarfWriter.cpp - Dwarf Framework ----------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by James M. Laskey and is distributed under the
6 // University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains support for writing dwarf debug info into asm files.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/CodeGen/DwarfWriter.h"
16 #include "llvm/ADT/StringExtras.h"
17 #include "llvm/Module.h"
18 #include "llvm/Type.h"
19 #include "llvm/CodeGen/AsmPrinter.h"
20 #include "llvm/CodeGen/MachineDebugInfo.h"
21 #include "llvm/CodeGen/MachineFrameInfo.h"
22 #include "llvm/CodeGen/MachineLocation.h"
23 #include "llvm/Support/Dwarf.h"
24 #include "llvm/Support/CommandLine.h"
25 #include "llvm/Support/Mangler.h"
26 #include "llvm/Target/MRegisterInfo.h"
27 #include "llvm/Target/TargetData.h"
28 #include "llvm/Target/TargetMachine.h"
29 #include "llvm/Target/TargetFrameInfo.h"
34 using namespace llvm::dwarf;
37 DwarfVerbose("dwarf-verbose", cl::Hidden,
38 cl::desc("Add comments to Dwarf directives."));
42 //===----------------------------------------------------------------------===//
43 // Forward declarations.
47 //===----------------------------------------------------------------------===//
48 // CompileUnit - This dwarf writer support class manages information associate
49 // with a source file.
52 CompileUnitDesc *Desc; // Compile unit debug descriptor.
53 unsigned ID; // File ID for source.
54 DIE *Die; // Compile unit debug information entry.
55 std::map<std::string, DIE *> Globals; // A map of globally visible named
56 // entities for this unit.
57 std::map<DebugInfoDesc *, DIE *> DescToDieMap;
58 // Tracks the mapping of unit level
59 // debug informaton descriptors to debug
60 // information entries.
63 CompileUnit(CompileUnitDesc *CUD, unsigned I, DIE *D)
74 CompileUnitDesc *getDesc() const { return Desc; }
75 unsigned getID() const { return ID; }
76 DIE* getDie() const { return Die; }
77 std::map<std::string, DIE *> &getGlobals() { return Globals; }
79 /// hasContent - Return true if this compile unit has something to write out.
81 bool hasContent() const;
83 /// AddGlobal - Add a new global entity to the compile unit.
85 void AddGlobal(const std::string &Name, DIE *Die);
87 /// getDieMapSlotFor - Returns the debug information entry map slot for the
88 /// specified debug descriptor.
89 DIE *&getDieMapSlotFor(DebugInfoDesc *DD) {
90 return DescToDieMap[DD];
94 //===----------------------------------------------------------------------===//
95 // DIEAbbrevData - Dwarf abbreviation data, describes the one attribute of a
96 // Dwarf abbreviation.
99 unsigned Attribute; // Dwarf attribute code.
100 unsigned Form; // Dwarf form code.
103 DIEAbbrevData(unsigned A, unsigned F)
109 unsigned getAttribute() const { return Attribute; }
110 unsigned getForm() const { return Form; }
112 /// operator== - Used by DIEAbbrev to locate entry.
114 bool operator==(const DIEAbbrevData &DAD) const {
115 return Attribute == DAD.Attribute && Form == DAD.Form;
118 /// operator!= - Used by DIEAbbrev to locate entry.
120 bool operator!=(const DIEAbbrevData &DAD) const {
121 return Attribute != DAD.Attribute || Form != DAD.Form;
124 /// operator< - Used by DIEAbbrev to locate entry.
126 bool operator<(const DIEAbbrevData &DAD) const {
127 return Attribute < DAD.Attribute ||
128 (Attribute == DAD.Attribute && Form < DAD.Form);
132 //===----------------------------------------------------------------------===//
133 // DIEAbbrev - Dwarf abbreviation, describes the organization of a debug
134 // information object.
137 unsigned Tag; // Dwarf tag code.
138 unsigned ChildrenFlag; // Dwarf children flag.
139 std::vector<DIEAbbrevData> Data; // Raw data bytes for abbreviation.
143 DIEAbbrev(unsigned T, unsigned C)
151 unsigned getTag() const { return Tag; }
152 unsigned getChildrenFlag() const { return ChildrenFlag; }
153 const std::vector<DIEAbbrevData> &getData() const { return Data; }
154 void setChildrenFlag(unsigned CF) { ChildrenFlag = CF; }
156 /// operator== - Used by UniqueVector to locate entry.
158 bool operator==(const DIEAbbrev &DA) const;
160 /// operator< - Used by UniqueVector to locate entry.
162 bool operator<(const DIEAbbrev &DA) const;
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 /// Emit - Print the abbreviation using the specified Dwarf writer.
178 void Emit(const DwarfWriter &DW) const;
181 void print(std::ostream &O);
186 //===----------------------------------------------------------------------===//
187 // DIEValue - A debug information entry value.
201 unsigned Type; // Type of the value
203 DIEValue(unsigned T) : Type(T) {}
204 virtual ~DIEValue() {}
206 // Implement isa/cast/dyncast.
207 static bool classof(const DIEValue *) { return true; }
209 /// EmitValue - Emit value via the Dwarf writer.
211 virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const = 0;
213 /// SizeOf - Return the size of a value in bytes.
215 virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const = 0;
218 //===----------------------------------------------------------------------===//
219 // DWInteger - An integer value DIE.
221 class DIEInteger : public DIEValue {
226 DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
228 // Implement isa/cast/dyncast.
229 static bool classof(const DIEInteger *) { return true; }
230 static bool classof(const DIEValue *I) { return I->Type == isInteger; }
232 /// BestForm - Choose the best form for integer.
234 unsigned BestForm(bool IsSigned);
236 /// EmitValue - Emit integer of appropriate size.
238 virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const;
240 /// SizeOf - Determine size of integer value in bytes.
242 virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const;
245 //===----------------------------------------------------------------------===//
246 // DIEString - A string value DIE.
248 struct DIEString : public DIEValue {
249 const std::string String;
251 DIEString(const std::string &S) : DIEValue(isString), String(S) {}
253 // Implement isa/cast/dyncast.
254 static bool classof(const DIEString *) { return true; }
255 static bool classof(const DIEValue *S) { return S->Type == isString; }
257 /// EmitValue - Emit string value.
259 virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const;
261 /// SizeOf - Determine size of string value in bytes.
263 virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const;
266 //===----------------------------------------------------------------------===//
267 // DIEDwarfLabel - A Dwarf internal label expression DIE.
269 struct DIEDwarfLabel : public DIEValue {
272 DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {}
274 // Implement isa/cast/dyncast.
275 static bool classof(const DIEDwarfLabel *) { return true; }
276 static bool classof(const DIEValue *L) { return L->Type == isLabel; }
278 /// EmitValue - Emit label value.
280 virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const;
282 /// SizeOf - Determine size of label value in bytes.
284 virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const;
288 //===----------------------------------------------------------------------===//
289 // DIEObjectLabel - A label to an object in code or data.
291 struct DIEObjectLabel : public DIEValue {
292 const std::string Label;
294 DIEObjectLabel(const std::string &L) : DIEValue(isAsIsLabel), Label(L) {}
296 // Implement isa/cast/dyncast.
297 static bool classof(const DIEObjectLabel *) { return true; }
298 static bool classof(const DIEValue *L) { return L->Type == isAsIsLabel; }
300 /// EmitValue - Emit label value.
302 virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const;
304 /// SizeOf - Determine size of label value in bytes.
306 virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const;
309 //===----------------------------------------------------------------------===//
310 // DIEDelta - A simple label difference DIE.
312 struct DIEDelta : public DIEValue {
313 const DWLabel LabelHi;
314 const DWLabel LabelLo;
316 DIEDelta(const DWLabel &Hi, const DWLabel &Lo)
317 : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
319 // Implement isa/cast/dyncast.
320 static bool classof(const DIEDelta *) { return true; }
321 static bool classof(const DIEValue *D) { return D->Type == isDelta; }
323 /// EmitValue - Emit delta value.
325 virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const;
327 /// SizeOf - Determine size of delta value in bytes.
329 virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const;
332 //===----------------------------------------------------------------------===//
333 // DIEntry - A pointer to a debug information entry.
335 struct DIEntry : public DIEValue {
338 DIEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
340 // Implement isa/cast/dyncast.
341 static bool classof(const DIEntry *) { return true; }
342 static bool classof(const DIEValue *E) { return E->Type == isEntry; }
344 /// EmitValue - Emit debug information entry offset.
346 virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const;
348 /// SizeOf - Determine size of debug information entry in bytes.
350 virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const;
353 //===----------------------------------------------------------------------===//
354 // DIEBlock - A block of values. Primarily used for location expressions.
356 struct DIEBlock : public DIEValue {
357 unsigned Size; // Size in bytes excluding size header.
358 std::vector<unsigned> Forms; // Data forms.
359 std::vector<DIEValue *> Values; // Block values.
369 // Implement isa/cast/dyncast.
370 static bool classof(const DIEBlock *) { return true; }
371 static bool classof(const DIEValue *E) { return E->Type == isBlock; }
373 /// ComputeSize - calculate the size of the block.
375 unsigned ComputeSize(DwarfWriter &DW);
377 /// BestForm - Choose the best form for data.
381 /// EmitValue - Emit block data.
383 virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const;
385 /// SizeOf - Determine size of block data in bytes.
387 virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const;
389 /// AddUInt - Add an unsigned integer value.
391 void AddUInt(unsigned Form, uint64_t Integer);
393 /// AddSInt - Add an signed integer value.
395 void AddSInt(unsigned Form, int64_t Integer);
397 /// AddString - Add a std::string value.
399 void AddString(unsigned Form, const std::string &String);
401 /// AddLabel - Add a Dwarf label value.
403 void AddLabel(unsigned Form, const DWLabel &Label);
405 /// AddObjectLabel - Add a non-Dwarf label value.
407 void AddObjectLabel(unsigned Form, const std::string &Label);
409 /// AddDelta - Add a label delta value.
411 void AddDelta(unsigned Form, const DWLabel &Hi, const DWLabel &Lo);
413 /// AddDIEntry - Add a DIE value.
415 void AddDIEntry(unsigned Form, DIE *Entry);
419 //===----------------------------------------------------------------------===//
420 // DIE - A structured debug information entry. Has an abbreviation which
421 // describes it's organization.
424 DIEAbbrev *Abbrev; // Temporary buffer for abbreviation.
425 unsigned AbbrevID; // Decribing abbreviation ID.
426 unsigned Offset; // Offset in debug info section.
427 unsigned Size; // Size of instance + children.
428 std::vector<DIE *> Children; // Children DIEs.
429 std::vector<DIEValue *> Values; // Attributes values.
436 unsigned getAbbrevID() const { return AbbrevID; }
437 unsigned getOffset() const { return Offset; }
438 unsigned getSize() const { return Size; }
439 const std::vector<DIE *> &getChildren() const { return Children; }
440 const std::vector<DIEValue *> &getValues() const { return Values; }
441 void setOffset(unsigned O) { Offset = O; }
442 void setSize(unsigned S) { Size = S; }
444 /// SiblingOffset - Return the offset of the debug information entry's
446 unsigned SiblingOffset() const { return Offset + Size; }
448 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
450 void AddSiblingOffset();
452 /// AddUInt - Add an unsigned integer attribute data and value.
454 void AddUInt(unsigned Attribute, unsigned Form, uint64_t Integer);
456 /// AddSInt - Add an signed integer attribute data and value.
458 void AddSInt(unsigned Attribute, unsigned Form, int64_t Integer);
460 /// AddString - Add a std::string attribute data and value.
462 void AddString(unsigned Attribute, unsigned Form,
463 const std::string &String);
465 /// AddLabel - Add a Dwarf label attribute data and value.
467 void AddLabel(unsigned Attribute, unsigned Form, const DWLabel &Label);
469 /// AddObjectLabel - Add a non-Dwarf label attribute data and value.
471 void AddObjectLabel(unsigned Attribute, unsigned Form,
472 const std::string &Label);
474 /// AddDelta - Add a label delta attribute data and value.
476 void AddDelta(unsigned Attribute, unsigned Form,
477 const DWLabel &Hi, const DWLabel &Lo);
479 /// AddDIEntry - Add a DIE attribute data and value.
481 void AddDIEntry(unsigned Attribute, unsigned Form, DIE *Entry);
483 /// AddBlock - Add block data.
485 void AddBlock(unsigned Attribute, unsigned Form, DIEBlock *Block);
487 /// Complete - Indicate that all attributes have been added and
488 /// ready to get an abbreviation ID.
490 void Complete(DwarfWriter &DW);
492 /// AddChild - Add a child to the DIE.
493 void AddChild(DIE *Child);
496 } // End of namespace llvm
498 //===----------------------------------------------------------------------===//
500 CompileUnit::~CompileUnit() {
504 /// hasContent - Return true if this compile unit has something to write out.
506 bool CompileUnit::hasContent() const {
507 return !Die->getChildren().empty();
510 /// AddGlobal - Add a new global entity to the compile unit.
512 void CompileUnit::AddGlobal(const std::string &Name, DIE *Die) {
516 //===----------------------------------------------------------------------===//
518 /// operator== - Used by UniqueVector to locate entry.
520 bool DIEAbbrev::operator==(const DIEAbbrev &DA) const {
521 if (Tag != DA.Tag) return false;
522 if (ChildrenFlag != DA.ChildrenFlag) return false;
523 if (Data.size() != DA.Data.size()) return false;
525 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
526 if (Data[i] != DA.Data[i]) return false;
532 /// operator< - Used by UniqueVector to locate entry.
534 bool DIEAbbrev::operator<(const DIEAbbrev &DA) const {
535 if (Tag != DA.Tag) return Tag < DA.Tag;
536 if (ChildrenFlag != DA.ChildrenFlag) return ChildrenFlag < DA.ChildrenFlag;
537 if (Data.size() != DA.Data.size()) return Data.size() < DA.Data.size();
539 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
540 if (Data[i] != DA.Data[i]) return Data[i] < DA.Data[i];
546 /// Emit - Print the abbreviation using the specified Dwarf writer.
548 void DIEAbbrev::Emit(const DwarfWriter &DW) const {
549 // Emit its Dwarf tag type.
550 DW.EmitULEB128Bytes(Tag);
551 DW.EOL(TagString(Tag));
553 // Emit whether it has children DIEs.
554 DW.EmitULEB128Bytes(ChildrenFlag);
555 DW.EOL(ChildrenString(ChildrenFlag));
557 // For each attribute description.
558 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
559 const DIEAbbrevData &AttrData = Data[i];
561 // Emit attribute type.
562 DW.EmitULEB128Bytes(AttrData.getAttribute());
563 DW.EOL(AttributeString(AttrData.getAttribute()));
566 DW.EmitULEB128Bytes(AttrData.getForm());
567 DW.EOL(FormEncodingString(AttrData.getForm()));
570 // Mark end of abbreviation.
571 DW.EmitULEB128Bytes(0); DW.EOL("EOM(1)");
572 DW.EmitULEB128Bytes(0); DW.EOL("EOM(2)");
576 void DIEAbbrev::print(std::ostream &O) {
577 O << "Abbreviation @"
578 << std::hex << (intptr_t)this << std::dec
582 << ChildrenString(ChildrenFlag)
585 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
587 << AttributeString(Data[i].getAttribute())
589 << FormEncodingString(Data[i].getForm())
593 void DIEAbbrev::dump() { print(std::cerr); }
596 //===----------------------------------------------------------------------===//
598 /// BestForm - Choose the best form for integer.
600 unsigned DIEInteger::BestForm(bool IsSigned) {
602 if ((char)Integer == (signed)Integer) return DW_FORM_data1;
603 if ((short)Integer == (signed)Integer) return DW_FORM_data2;
604 if ((int)Integer == (signed)Integer) return DW_FORM_data4;
606 if ((unsigned char)Integer == Integer) return DW_FORM_data1;
607 if ((unsigned short)Integer == Integer) return DW_FORM_data2;
608 if ((unsigned int)Integer == Integer) return DW_FORM_data4;
610 return DW_FORM_data8;
613 /// EmitValue - Emit integer of appropriate size.
615 void DIEInteger::EmitValue(const DwarfWriter &DW, unsigned Form) const {
617 case DW_FORM_flag: // Fall thru
618 case DW_FORM_ref1: // Fall thru
619 case DW_FORM_data1: DW.EmitInt8(Integer); break;
620 case DW_FORM_ref2: // Fall thru
621 case DW_FORM_data2: DW.EmitInt16(Integer); break;
622 case DW_FORM_ref4: // Fall thru
623 case DW_FORM_data4: DW.EmitInt32(Integer); break;
624 case DW_FORM_ref8: // Fall thru
625 case DW_FORM_data8: DW.EmitInt64(Integer); break;
626 case DW_FORM_udata: DW.EmitULEB128Bytes(Integer); break;
627 case DW_FORM_sdata: DW.EmitSLEB128Bytes(Integer); break;
628 default: assert(0 && "DIE Value form not supported yet"); break;
632 /// SizeOf - Determine size of integer value in bytes.
634 unsigned DIEInteger::SizeOf(const DwarfWriter &DW, unsigned Form) const {
636 case DW_FORM_flag: // Fall thru
637 case DW_FORM_ref1: // Fall thru
638 case DW_FORM_data1: return sizeof(int8_t);
639 case DW_FORM_ref2: // Fall thru
640 case DW_FORM_data2: return sizeof(int16_t);
641 case DW_FORM_ref4: // Fall thru
642 case DW_FORM_data4: return sizeof(int32_t);
643 case DW_FORM_ref8: // Fall thru
644 case DW_FORM_data8: return sizeof(int64_t);
645 case DW_FORM_udata: return DW.SizeULEB128(Integer);
646 case DW_FORM_sdata: return DW.SizeSLEB128(Integer);
647 default: assert(0 && "DIE Value form not supported yet"); break;
652 //===----------------------------------------------------------------------===//
654 /// EmitValue - Emit string value.
656 void DIEString::EmitValue(const DwarfWriter &DW, unsigned Form) const {
657 DW.EmitString(String);
660 /// SizeOf - Determine size of string value in bytes.
662 unsigned DIEString::SizeOf(const DwarfWriter &DW, unsigned Form) const {
663 return String.size() + sizeof(char); // sizeof('\0');
666 //===----------------------------------------------------------------------===//
668 /// EmitValue - Emit label value.
670 void DIEDwarfLabel::EmitValue(const DwarfWriter &DW, unsigned Form) const {
671 DW.EmitReference(Label);
674 /// SizeOf - Determine size of label value in bytes.
676 unsigned DIEDwarfLabel::SizeOf(const DwarfWriter &DW, unsigned Form) const {
677 return DW.getAddressSize();
680 //===----------------------------------------------------------------------===//
682 /// EmitValue - Emit label value.
684 void DIEObjectLabel::EmitValue(const DwarfWriter &DW, unsigned Form) const {
685 DW.EmitReference(Label);
688 /// SizeOf - Determine size of label value in bytes.
690 unsigned DIEObjectLabel::SizeOf(const DwarfWriter &DW, unsigned Form) const {
691 return DW.getAddressSize();
694 //===----------------------------------------------------------------------===//
696 /// EmitValue - Emit delta value.
698 void DIEDelta::EmitValue(const DwarfWriter &DW, unsigned Form) const {
699 DW.EmitDifference(LabelHi, LabelLo);
702 /// SizeOf - Determine size of delta value in bytes.
704 unsigned DIEDelta::SizeOf(const DwarfWriter &DW, unsigned Form) const {
705 return DW.getAddressSize();
708 //===----------------------------------------------------------------------===//
709 /// EmitValue - Emit debug information entry offset.
711 void DIEntry::EmitValue(const DwarfWriter &DW, unsigned Form) const {
712 DW.EmitInt32(Entry->getOffset());
715 /// SizeOf - Determine size of debug information entry value in bytes.
717 unsigned DIEntry::SizeOf(const DwarfWriter &DW, unsigned Form) const {
718 return sizeof(int32_t);
721 //===----------------------------------------------------------------------===//
723 DIEBlock::~DIEBlock() {
724 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
729 /// ComputeSize - calculate the size of the block.
731 unsigned DIEBlock::ComputeSize(DwarfWriter &DW) {
733 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
734 Size += Values[i]->SizeOf(DW, Forms[i]);
739 /// BestForm - Choose the best form for data.
741 unsigned DIEBlock::BestForm() {
742 if ((unsigned char)Size == Size) return DW_FORM_block1;
743 if ((unsigned short)Size == Size) return DW_FORM_block2;
744 if ((unsigned int)Size == Size) return DW_FORM_block4;
745 return DW_FORM_block;
748 /// EmitValue - Emit block data.
750 void DIEBlock::EmitValue(const DwarfWriter &DW, unsigned Form) const {
752 case DW_FORM_block1: DW.EmitInt8(Size); break;
753 case DW_FORM_block2: DW.EmitInt16(Size); break;
754 case DW_FORM_block4: DW.EmitInt32(Size); break;
755 case DW_FORM_block: DW.EmitULEB128Bytes(Size); break;
756 default: assert(0 && "Improper form for block"); break;
758 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
760 Values[i]->EmitValue(DW, Forms[i]);
764 /// SizeOf - Determine size of block data in bytes.
766 unsigned DIEBlock::SizeOf(const DwarfWriter &DW, unsigned Form) const {
768 case DW_FORM_block1: return Size + sizeof(int8_t);
769 case DW_FORM_block2: return Size + sizeof(int16_t);
770 case DW_FORM_block4: return Size + sizeof(int32_t);
771 case DW_FORM_block: return Size + DW.SizeULEB128(Size);
772 default: assert(0 && "Improper form for block"); break;
777 /// AddUInt - Add an unsigned integer value.
779 void DIEBlock::AddUInt(unsigned Form, uint64_t Integer) {
780 DIEInteger *DI = new DIEInteger(Integer);
781 Values.push_back(DI);
782 if (Form == 0) Form = DI->BestForm(false);
783 Forms.push_back(Form);
786 /// AddSInt - Add an signed integer value.
788 void DIEBlock::AddSInt(unsigned Form, int64_t Integer) {
789 DIEInteger *DI = new DIEInteger(Integer);
790 Values.push_back(DI);
791 if (Form == 0) Form = DI->BestForm(true);
792 Forms.push_back(Form);
795 /// AddString - Add a std::string value.
797 void DIEBlock::AddString(unsigned Form, const std::string &String) {
798 Values.push_back(new DIEString(String));
799 Forms.push_back(Form);
802 /// AddLabel - Add a Dwarf label value.
804 void DIEBlock::AddLabel(unsigned Form, const DWLabel &Label) {
805 Values.push_back(new DIEDwarfLabel(Label));
806 Forms.push_back(Form);
809 /// AddObjectLabel - Add a non-Dwarf label value.
811 void DIEBlock::AddObjectLabel(unsigned Form, const std::string &Label) {
812 Values.push_back(new DIEObjectLabel(Label));
813 Forms.push_back(Form);
816 /// AddDelta - Add a label delta value.
818 void DIEBlock::AddDelta(unsigned Form, const DWLabel &Hi, const DWLabel &Lo) {
819 Values.push_back(new DIEDelta(Hi, Lo));
820 Forms.push_back(Form);
823 /// AddDIEntry - Add a DIE value.
825 void DIEBlock::AddDIEntry(unsigned Form, DIE *Entry) {
826 Values.push_back(new DIEntry(Entry));
827 Forms.push_back(Form);
830 //===----------------------------------------------------------------------===//
832 DIE::DIE(unsigned Tag)
833 : Abbrev(new DIEAbbrev(Tag, DW_CHILDREN_no))
842 if (Abbrev) delete Abbrev;
844 for (unsigned i = 0, N = Children.size(); i < N; ++i) {
848 for (unsigned j = 0, M = Values.size(); j < M; ++j) {
853 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
855 void DIE::AddSiblingOffset() {
856 DIEInteger *DI = new DIEInteger(0);
857 Values.insert(Values.begin(), DI);
858 Abbrev->AddFirstAttribute(DW_AT_sibling, DW_FORM_ref4);
861 /// AddUInt - Add an unsigned integer attribute data and value.
863 void DIE::AddUInt(unsigned Attribute, unsigned Form, uint64_t Integer) {
864 DIEInteger *DI = new DIEInteger(Integer);
865 Values.push_back(DI);
866 if (!Form) Form = DI->BestForm(false);
867 Abbrev->AddAttribute(Attribute, Form);
870 /// AddSInt - Add an signed integer attribute data and value.
872 void DIE::AddSInt(unsigned Attribute, unsigned Form, int64_t Integer) {
873 DIEInteger *DI = new DIEInteger(Integer);
874 Values.push_back(DI);
875 if (!Form) Form = DI->BestForm(true);
876 Abbrev->AddAttribute(Attribute, Form);
879 /// AddString - Add a std::string attribute data and value.
881 void DIE::AddString(unsigned Attribute, unsigned Form,
882 const std::string &String) {
883 Values.push_back(new DIEString(String));
884 Abbrev->AddAttribute(Attribute, Form);
887 /// AddLabel - Add a Dwarf label attribute data and value.
889 void DIE::AddLabel(unsigned Attribute, unsigned Form,
890 const DWLabel &Label) {
891 Values.push_back(new DIEDwarfLabel(Label));
892 Abbrev->AddAttribute(Attribute, Form);
895 /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
897 void DIE::AddObjectLabel(unsigned Attribute, unsigned Form,
898 const std::string &Label) {
899 Values.push_back(new DIEObjectLabel(Label));
900 Abbrev->AddAttribute(Attribute, Form);
903 /// AddDelta - Add a label delta attribute data and value.
905 void DIE::AddDelta(unsigned Attribute, unsigned Form,
906 const DWLabel &Hi, const DWLabel &Lo) {
907 Values.push_back(new DIEDelta(Hi, Lo));
908 Abbrev->AddAttribute(Attribute, Form);
911 /// AddDIEntry - Add a DIE attribute data and value.
913 void DIE::AddDIEntry(unsigned Attribute, unsigned Form, DIE *Entry) {
914 Values.push_back(new DIEntry(Entry));
915 Abbrev->AddAttribute(Attribute, Form);
918 /// AddBlock - Add block data.
920 void DIE::AddBlock(unsigned Attribute, unsigned Form, DIEBlock *Block) {
921 assert(Block->Size && "Block size has not been computed");
922 Values.push_back(Block);
923 if (!Form) Form = Block->BestForm();
924 Abbrev->AddAttribute(Attribute, Form);
927 /// Complete - Indicate that all attributes have been added and ready to get an
929 void DIE::Complete(DwarfWriter &DW) {
930 AbbrevID = DW.NewAbbreviation(Abbrev);
935 /// AddChild - Add a child to the DIE.
937 void DIE::AddChild(DIE *Child) {
938 assert(Abbrev && "Adding children without an abbreviation");
939 Abbrev->setChildrenFlag(DW_CHILDREN_yes);
940 Children.push_back(Child);
943 //===----------------------------------------------------------------------===//
947 //===----------------------------------------------------------------------===//
949 /// PrintHex - Print a value as a hexidecimal value.
951 void DwarfWriter::PrintHex(int Value) const {
952 O << "0x" << std::hex << Value << std::dec;
955 /// EOL - Print a newline character to asm stream. If a comment is present
956 /// then it will be printed first. Comments should not contain '\n'.
957 void DwarfWriter::EOL(const std::string &Comment) const {
958 if (DwarfVerbose && !Comment.empty()) {
960 << Asm->CommentString
967 /// EmitAlign - Print a align directive.
969 void DwarfWriter::EmitAlign(unsigned Alignment) const {
970 O << Asm->AlignDirective << Alignment << "\n";
973 /// EmitULEB128Bytes - Emit an assembler byte data directive to compose an
974 /// unsigned leb128 value.
975 void DwarfWriter::EmitULEB128Bytes(unsigned Value) const {
980 O << Asm->Data8bitsDirective;
985 /// EmitSLEB128Bytes - Emit an assembler byte data directive to compose a
986 /// signed leb128 value.
987 void DwarfWriter::EmitSLEB128Bytes(int Value) const {
992 O << Asm->Data8bitsDirective;
997 /// PrintULEB128 - Print a series of hexidecimal values (separated by commas)
998 /// representing an unsigned leb128 value.
999 void DwarfWriter::PrintULEB128(unsigned Value) const {
1001 unsigned Byte = Value & 0x7f;
1003 if (Value) Byte |= 0x80;
1005 if (Value) O << ", ";
1009 /// SizeULEB128 - Compute the number of bytes required for an unsigned leb128
1011 unsigned DwarfWriter::SizeULEB128(unsigned Value) {
1015 Size += sizeof(int8_t);
1020 /// PrintSLEB128 - Print a series of hexidecimal values (separated by commas)
1021 /// representing a signed leb128 value.
1022 void DwarfWriter::PrintSLEB128(int Value) const {
1023 int Sign = Value >> (8 * sizeof(Value) - 1);
1027 unsigned Byte = Value & 0x7f;
1029 IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
1030 if (IsMore) Byte |= 0x80;
1032 if (IsMore) O << ", ";
1036 /// SizeSLEB128 - Compute the number of bytes required for a signed leb128
1038 unsigned DwarfWriter::SizeSLEB128(int Value) {
1040 int Sign = Value >> (8 * sizeof(Value) - 1);
1044 unsigned Byte = Value & 0x7f;
1046 IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
1047 Size += sizeof(int8_t);
1052 /// EmitInt8 - Emit a byte directive and value.
1054 void DwarfWriter::EmitInt8(int Value) const {
1055 O << Asm->Data8bitsDirective;
1056 PrintHex(Value & 0xFF);
1059 /// EmitInt16 - Emit a short directive and value.
1061 void DwarfWriter::EmitInt16(int Value) const {
1062 O << Asm->Data16bitsDirective;
1063 PrintHex(Value & 0xFFFF);
1066 /// EmitInt32 - Emit a long directive and value.
1068 void DwarfWriter::EmitInt32(int Value) const {
1069 O << Asm->Data32bitsDirective;
1073 /// EmitInt64 - Emit a long long directive and value.
1075 void DwarfWriter::EmitInt64(uint64_t Value) const {
1076 if (Asm->Data64bitsDirective) {
1077 O << Asm->Data64bitsDirective << "0x" << std::hex << Value << std::dec;
1079 if (TD->isBigEndian()) {
1080 EmitInt32(unsigned(Value >> 32)); O << "\n";
1081 EmitInt32(unsigned(Value));
1083 EmitInt32(unsigned(Value)); O << "\n";
1084 EmitInt32(unsigned(Value >> 32));
1089 /// EmitString - Emit a string with quotes and a null terminator.
1090 /// Special characters are emitted properly. (Eg. '\t')
1091 void DwarfWriter::EmitString(const std::string &String) const {
1092 O << Asm->AsciiDirective
1094 for (unsigned i = 0, N = String.size(); i < N; ++i) {
1095 unsigned char C = String[i];
1097 if (!isascii(C) || iscntrl(C)) {
1099 case '\b': O << "\\b"; break;
1100 case '\f': O << "\\f"; break;
1101 case '\n': O << "\\n"; break;
1102 case '\r': O << "\\r"; break;
1103 case '\t': O << "\\t"; break;
1106 O << char('0' + (C >> 6));
1107 O << char('0' + (C >> 3));
1108 O << char('0' + (C >> 0));
1111 } else if (C == '\"') {
1113 } else if (C == '\'') {
1122 /// PrintLabelName - Print label name in form used by Dwarf writer.
1124 void DwarfWriter::PrintLabelName(const char *Tag, unsigned Number) const {
1125 O << Asm->PrivateGlobalPrefix
1128 if (Number) O << Number;
1131 /// EmitLabel - Emit location label for internal use by Dwarf.
1133 void DwarfWriter::EmitLabel(const char *Tag, unsigned Number) const {
1134 PrintLabelName(Tag, Number);
1138 /// EmitReference - Emit a reference to a label.
1140 void DwarfWriter::EmitReference(const char *Tag, unsigned Number) const {
1141 if (AddressSize == 4)
1142 O << Asm->Data32bitsDirective;
1144 O << Asm->Data64bitsDirective;
1146 PrintLabelName(Tag, Number);
1148 void DwarfWriter::EmitReference(const std::string &Name) const {
1149 if (AddressSize == 4)
1150 O << Asm->Data32bitsDirective;
1152 O << Asm->Data64bitsDirective;
1157 /// EmitDifference - Emit an label difference as sizeof(pointer) value. Some
1158 /// assemblers do not accept absolute expressions with data directives, so there
1159 /// is an option (needsSet) to use an intermediary 'set' expression.
1160 void DwarfWriter::EmitDifference(const char *TagHi, unsigned NumberHi,
1161 const char *TagLo, unsigned NumberLo) const {
1163 static unsigned SetCounter = 0;
1166 PrintLabelName("set", SetCounter);
1168 PrintLabelName(TagHi, NumberHi);
1170 PrintLabelName(TagLo, NumberLo);
1173 if (AddressSize == sizeof(int32_t))
1174 O << Asm->Data32bitsDirective;
1176 O << Asm->Data64bitsDirective;
1178 PrintLabelName("set", SetCounter);
1182 if (AddressSize == sizeof(int32_t))
1183 O << Asm->Data32bitsDirective;
1185 O << Asm->Data64bitsDirective;
1187 PrintLabelName(TagHi, NumberHi);
1189 PrintLabelName(TagLo, NumberLo);
1193 /// NewAbbreviation - Add the abbreviation to the Abbreviation vector.
1195 unsigned DwarfWriter::NewAbbreviation(DIEAbbrev *Abbrev) {
1196 return Abbreviations.insert(*Abbrev);
1199 /// NewString - Add a string to the constant pool and returns a label.
1201 DWLabel DwarfWriter::NewString(const std::string &String) {
1202 unsigned StringID = StringPool.insert(String);
1203 return DWLabel("string", StringID);
1206 /// AddSourceLine - Add location information to specified debug information
1208 void DwarfWriter::AddSourceLine(DIE *Die, CompileUnitDesc *File, unsigned Line) {
1210 CompileUnit *FileUnit = FindCompileUnit(File);
1211 unsigned FileID = FileUnit->getID();
1212 Die->AddUInt(DW_AT_decl_file, 0, FileID);
1213 Die->AddUInt(DW_AT_decl_line, 0, Line);
1217 /// AddAddress - Add an address attribute to a die based on the location
1219 void DwarfWriter::AddAddress(DIE *Die, unsigned Attribute,
1220 const MachineLocation &Location) {
1221 DIEBlock *Block = new DIEBlock();
1222 if (Location.isRegister()) {
1223 Block->AddUInt(DW_FORM_data1,
1224 DW_OP_reg0 + RI->getDwarfRegNum(Location.getRegister()));
1226 Block->AddUInt(DW_FORM_data1,
1227 DW_OP_breg0 + RI->getDwarfRegNum(Location.getRegister()));
1228 Block->AddUInt(DW_FORM_sdata, Location.getOffset());
1230 Block->ComputeSize(*this);
1231 Die->AddBlock(Attribute, 0, Block);
1234 /// getDieMapSlotFor - Returns the debug information entry map slot for the
1235 /// specified debug descriptor.
1236 DIE *&DwarfWriter::getDieMapSlotFor(DebugInfoDesc *DD) {
1237 return DescToDieMap[DD];
1240 /// NewType - Create a new type DIE.
1242 DIE *DwarfWriter::NewType(DIE *Context, TypeDesc *TyDesc, CompileUnit *Unit) {
1244 // FIXME - Hack for missing types
1245 DIE *Die = new DIE(DW_TAG_base_type);
1246 Die->AddUInt(DW_AT_byte_size, 0, 4);
1247 Die->AddUInt(DW_AT_encoding, DW_FORM_data1, DW_ATE_signed);
1248 Unit->getDie()->AddChild(Die);
1252 // FIXME - Should handle other contexts that compile units.
1254 // Check for pre-existence.
1255 DIE *&Slot = Unit->getDieMapSlotFor(TyDesc);
1256 if (Slot) return Slot;
1258 // Get core information.
1259 const std::string &Name = TyDesc->getName();
1260 uint64_t Size = TyDesc->getSize() >> 3;
1264 if (BasicTypeDesc *BasicTy = dyn_cast<BasicTypeDesc>(TyDesc)) {
1265 // Fundamental types like int, float, bool
1266 Slot = Ty = new DIE(DW_TAG_base_type);
1267 unsigned Encoding = BasicTy->getEncoding();
1268 Ty->AddUInt(DW_AT_encoding, DW_FORM_data1, Encoding);
1269 } else if (DerivedTypeDesc *DerivedTy = dyn_cast<DerivedTypeDesc>(TyDesc)) {
1270 // Create specific DIE.
1271 Slot = Ty = new DIE(DerivedTy->getTag());
1273 // Map to main type, void will not have a type.
1274 if (TypeDesc *FromTy = DerivedTy->getFromType()) {
1275 Ty->AddDIEntry(DW_AT_type, DW_FORM_ref4,
1276 NewType(Context, FromTy, Unit));
1278 } else if (CompositeTypeDesc *CompTy = dyn_cast<CompositeTypeDesc>(TyDesc)) {
1279 // Create specific DIE.
1280 Slot = Ty = new DIE(CompTy->getTag());
1281 std::vector<DebugInfoDesc *> &Elements = CompTy->getElements();
1283 switch (CompTy->getTag()) {
1284 case DW_TAG_array_type: {
1285 // Add element type.
1286 if (TypeDesc *FromTy = CompTy->getFromType()) {
1287 Ty->AddDIEntry(DW_AT_type, DW_FORM_ref4,
1288 NewType(Context, FromTy, Unit));
1291 // check for vector type
1292 if (CompTy->isVector()) {
1293 Ty->AddUInt(DW_AT_GNU_vector, DW_FORM_flag, 1);
1296 // Don't emit size attribute.
1299 // Construct an anonymous type for index type.
1300 DIE *IndexTy = new DIE(DW_TAG_base_type);
1301 IndexTy->AddUInt(DW_AT_byte_size, 0, 4);
1302 IndexTy->AddUInt(DW_AT_encoding, DW_FORM_data1, DW_ATE_signed);
1304 Context->AddChild(IndexTy);
1306 // Add subranges to array type.
1307 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1308 SubrangeDesc *SRD = cast<SubrangeDesc>(Elements[i]);
1309 int64_t Lo = SRD->getLo();
1310 int64_t Hi = SRD->getHi();
1311 DIE *Subrange = new DIE(DW_TAG_subrange_type);
1313 // If a range is available.
1315 Subrange->AddDIEntry(DW_AT_type, DW_FORM_ref4, IndexTy);
1316 // Only add low if non-zero.
1317 if (Lo) Subrange->AddSInt(DW_AT_lower_bound, 0, Lo);
1318 Subrange->AddSInt(DW_AT_upper_bound, 0, Hi);
1320 Ty->AddChild(Subrange);
1325 case DW_TAG_structure_type:
1326 case DW_TAG_union_type: {
1327 // FIXME - this is just the basics.
1328 // Add elements to structure type.
1329 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1330 DerivedTypeDesc *MemberDesc = cast<DerivedTypeDesc>(Elements[i]);
1332 // Extract the basic information.
1333 const std::string &Name = MemberDesc->getName();
1334 TypeDesc *MemTy = MemberDesc->getFromType();
1335 uint64_t Size = MemberDesc->getSize();
1336 uint64_t Align = MemberDesc->getAlign();
1337 uint64_t Offset = MemberDesc->getOffset();
1339 // Construct member debug information entry.
1340 DIE *Member = new DIE(DW_TAG_member);
1342 // Add name if not "".
1343 if (!Name.empty()) Member->AddString(DW_AT_name, DW_FORM_string, Name);
1344 // Add location if available.
1345 AddSourceLine(Member, MemberDesc->getFile(), MemberDesc->getLine());
1347 // Most of the time the field info is the same as the members.
1348 uint64_t FieldSize = Size;
1349 uint64_t FieldAlign = Align;
1350 uint64_t FieldOffset = Offset;
1352 if (TypeDesc *FromTy = MemberDesc->getFromType()) {
1353 Member->AddDIEntry(DW_AT_type, DW_FORM_ref4,
1354 NewType(Context, FromTy, Unit));
1355 FieldSize = FromTy->getSize();
1356 FieldAlign = FromTy->getSize();
1359 // Unless we have a bit field.
1360 if (FieldSize != Size) {
1361 // Construct the alignment mask.
1362 uint64_t AlignMask = ~(FieldAlign - 1);
1363 // Determine the high bit + 1 of the declared size.
1364 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1365 // Work backwards to determine the base offset of the field.
1366 FieldOffset = HiMark - FieldSize;
1367 // Now normalize offset to the field.
1368 Offset -= FieldOffset;
1370 // Maybe we need to work from the other end.
1371 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
1373 Member->AddUInt(DW_AT_byte_size, 0, FieldSize >> 3);
1374 Member->AddUInt(DW_AT_bit_size, 0, Size);
1375 Member->AddUInt(DW_AT_bit_offset, 0, Offset);
1378 // Add computation for offset.
1379 DIEBlock *Block = new DIEBlock();
1380 Block->AddUInt(DW_FORM_data1, DW_OP_plus_uconst);
1381 Block->AddUInt(DW_FORM_udata, FieldOffset >> 3);
1382 Block->ComputeSize(*this);
1383 Member->AddBlock(DW_AT_data_member_location, 0, Block);
1385 Ty->AddChild(Member);
1389 case DW_TAG_enumeration_type: {
1390 // Add enumerators to enumeration type.
1391 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1392 EnumeratorDesc *ED = cast<EnumeratorDesc>(Elements[i]);
1393 const std::string &Name = ED->getName();
1394 int64_t Value = ED->getValue();
1395 DIE *Enumerator = new DIE(DW_TAG_enumerator);
1396 Enumerator->AddString(DW_AT_name, DW_FORM_string, Name);
1397 Enumerator->AddSInt(DW_AT_const_value, DW_FORM_sdata, Value);
1398 Ty->AddChild(Enumerator);
1407 assert(Ty && "Type not supported yet");
1409 // Add size if non-zero (derived types don't have a size.)
1410 if (Size) Ty->AddUInt(DW_AT_byte_size, 0, Size);
1411 // Add name if not anonymous or intermediate type.
1412 if (!Name.empty()) Ty->AddString(DW_AT_name, DW_FORM_string, Name);
1413 // Add source line info if available.
1414 AddSourceLine(Ty, TyDesc->getFile(), TyDesc->getLine());
1416 // Add to context owner.
1417 Context->AddChild(Ty);
1422 /// NewCompileUnit - Create new compile unit and it's debug information entry.
1424 CompileUnit *DwarfWriter::NewCompileUnit(CompileUnitDesc *UnitDesc,
1426 // Construct debug information entry.
1427 DIE *Die = new DIE(DW_TAG_compile_unit);
1428 Die->AddDelta (DW_AT_stmt_list, DW_FORM_data4, DWLabel("line", 0),
1429 DWLabel("section_line", 0));
1430 Die->AddLabel (DW_AT_high_pc, DW_FORM_addr, DWLabel("text_end", 0));
1431 Die->AddLabel (DW_AT_low_pc, DW_FORM_addr, DWLabel("text_begin", 0));
1432 Die->AddString(DW_AT_producer, DW_FORM_string, UnitDesc->getProducer());
1433 Die->AddUInt (DW_AT_language, DW_FORM_data1, UnitDesc->getLanguage());
1434 Die->AddString(DW_AT_name, DW_FORM_string, UnitDesc->getFileName());
1435 Die->AddString(DW_AT_comp_dir, DW_FORM_string, UnitDesc->getDirectory());
1437 // Add debug information entry to descriptor map.
1438 DIE *&Slot = getDieMapSlotFor(UnitDesc);
1441 // Construct compile unit.
1442 CompileUnit *Unit = new CompileUnit(UnitDesc, ID, Die);
1444 // Add Unit to compile unit map.
1445 DescToUnitMap[UnitDesc] = Unit;
1450 /// FindCompileUnit - Get the compile unit for the given descriptor.
1452 CompileUnit *DwarfWriter::FindCompileUnit(CompileUnitDesc *UnitDesc) {
1453 CompileUnit *Unit = DescToUnitMap[UnitDesc];
1454 assert(Unit && "Missing compile unit.");
1458 /// NewGlobalVariable - Add a new global variable DIE.
1460 DIE *DwarfWriter::NewGlobalVariable(GlobalVariableDesc *GVD) {
1461 // Get the compile unit context.
1462 CompileUnitDesc *UnitDesc = static_cast<CompileUnitDesc *>(GVD->getContext());
1463 CompileUnit *Unit = FindCompileUnit(UnitDesc);
1465 // Check for pre-existence.
1466 DIE *&Slot = Unit->getDieMapSlotFor(GVD);
1467 if (Slot) return Slot;
1469 // Get the global variable itself.
1470 GlobalVariable *GV = GVD->getGlobalVariable();
1471 // Generate the mangled name.
1472 std::string MangledName = Asm->Mang->getValueName(GV);
1474 // Gather the details (simplify add attribute code.)
1475 const std::string &Name = GVD->getName();
1477 // Get the global's type.
1478 DIE *Type = NewType(Unit->getDie(), GVD->getType(), Unit);
1480 // Create the globale variable DIE.
1481 DIE *VariableDie = new DIE(DW_TAG_variable);
1482 VariableDie->AddString (DW_AT_name, DW_FORM_string, Name);
1483 VariableDie->AddDIEntry (DW_AT_type, DW_FORM_ref4, Type);
1484 VariableDie->AddUInt (DW_AT_external, DW_FORM_flag, 1);
1486 // Add source line info if available.
1487 AddSourceLine(VariableDie, UnitDesc, GVD->getLine());
1490 DIEBlock *Block = new DIEBlock();
1491 Block->AddUInt(DW_FORM_data1, DW_OP_addr);
1492 Block->AddObjectLabel(DW_FORM_udata, MangledName);
1493 Block->ComputeSize(*this);
1494 VariableDie->AddBlock(DW_AT_location, 0, Block);
1499 // Add to context owner.
1500 Unit->getDie()->AddChild(VariableDie);
1502 // Expose as global.
1503 // FIXME - need to check external flag.
1504 Unit->AddGlobal(Name, VariableDie);
1509 /// NewSubprogram - Add a new subprogram DIE.
1511 DIE *DwarfWriter::NewSubprogram(SubprogramDesc *SPD) {
1512 // Get the compile unit context.
1513 CompileUnitDesc *UnitDesc = static_cast<CompileUnitDesc *>(SPD->getContext());
1514 CompileUnit *Unit = FindCompileUnit(UnitDesc);
1516 // Check for pre-existence.
1517 DIE *&Slot = Unit->getDieMapSlotFor(SPD);
1518 if (Slot) return Slot;
1520 // Gather the details (simplify add attribute code.)
1521 const std::string &Name = SPD->getName();
1522 DIE *Type = NewType(Unit->getDie(), SPD->getType(), Unit);
1523 unsigned IsExternal = SPD->isStatic() ? 0 : 1;
1525 DIE *SubprogramDie = new DIE(DW_TAG_subprogram);
1526 SubprogramDie->AddString (DW_AT_name, DW_FORM_string, Name);
1528 SubprogramDie->AddDIEntry (DW_AT_type, DW_FORM_ref4, Type);
1530 SubprogramDie->AddUInt (DW_AT_external, DW_FORM_flag, IsExternal);
1531 SubprogramDie->AddUInt (DW_AT_prototyped, DW_FORM_flag, 1);
1533 // Add source line info if available.
1534 AddSourceLine(SubprogramDie, UnitDesc, SPD->getLine());
1537 Slot = SubprogramDie;
1539 // Add to context owner.
1540 Unit->getDie()->AddChild(SubprogramDie);
1542 // Expose as global.
1543 Unit->AddGlobal(Name, SubprogramDie);
1545 return SubprogramDie;
1548 /// NewScopeVariable - Create a new scope variable.
1550 DIE *DwarfWriter::NewScopeVariable(DebugVariable *DV, CompileUnit *Unit) {
1551 // Get the descriptor.
1552 VariableDesc *VD = DV->getDesc();
1554 // Translate tag to proper Dwarf tag. The result variable is dropped for now.
1556 switch (VD->getTag()) {
1557 case DW_TAG_return_variable: return NULL;
1558 case DW_TAG_arg_variable: Tag = DW_TAG_formal_parameter; break;
1559 case DW_TAG_auto_variable: // fall thru
1560 default: Tag = DW_TAG_variable; break;
1563 // Define variable debug information entry.
1564 DIE *VariableDie = new DIE(Tag);
1565 VariableDie->AddString(DW_AT_name, DW_FORM_string, VD->getName());
1567 // Add source line info if available.
1568 AddSourceLine(VariableDie, VD->getFile(), VD->getLine());
1570 // Add variable type.
1571 DIE *Type = NewType(Unit->getDie(), VD->getType(), Unit);
1572 VariableDie->AddDIEntry(DW_AT_type, DW_FORM_ref4, Type);
1574 // Add variable address.
1575 MachineLocation Location;
1576 RI->getLocation(*MF, DV->getFrameIndex(), Location);
1577 AddAddress(VariableDie, DW_AT_location, Location);
1582 /// ConstructScope - Construct the components of a scope.
1584 void DwarfWriter::ConstructScope(DebugScope *ParentScope,
1585 DIE *ParentDie, CompileUnit *Unit) {
1586 // Add variables to scope.
1587 std::vector<DebugVariable *> &Variables = ParentScope->getVariables();
1588 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
1589 DIE *VariableDie = NewScopeVariable(Variables[i], Unit);
1590 if (VariableDie) ParentDie->AddChild(VariableDie);
1593 // Add nested scopes.
1594 std::vector<DebugScope *> &Scopes = ParentScope->getScopes();
1595 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1596 // Define the Scope debug information entry.
1597 DebugScope *Scope = Scopes[j];
1598 // FIXME - Ignore inlined functions for the time being.
1599 if (Scope->getParent()) continue;
1601 DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
1603 // Add the scope bounds.
1604 if (unsigned StartID = Scope->getStartLabelID()) {
1605 ScopeDie->AddLabel(DW_AT_low_pc, DW_FORM_addr,
1606 DWLabel("loc", StartID));
1608 ScopeDie->AddLabel(DW_AT_low_pc, DW_FORM_addr,
1609 DWLabel("func_begin", SubprogramCount));
1611 if (unsigned EndID = Scope->getEndLabelID()) {
1612 ScopeDie->AddLabel(DW_AT_high_pc, DW_FORM_addr,
1613 DWLabel("loc", EndID));
1615 ScopeDie->AddLabel(DW_AT_high_pc, DW_FORM_addr,
1616 DWLabel("func_end", SubprogramCount));
1619 // Add the scope contents.
1620 ConstructScope(Scope, ScopeDie, Unit);
1621 ParentDie->AddChild(ScopeDie);
1625 /// ConstructRootScope - Construct the scope for the subprogram.
1627 void DwarfWriter::ConstructRootScope(DebugScope *RootScope) {
1628 // Exit if there is no root scope.
1629 if (!RootScope) return;
1631 // Get the subprogram debug information entry.
1632 SubprogramDesc *SPD = cast<SubprogramDesc>(RootScope->getDesc());
1634 // Get the compile unit context.
1635 CompileUnitDesc *UnitDesc = static_cast<CompileUnitDesc *>(SPD->getContext());
1636 CompileUnit *Unit = FindCompileUnit(UnitDesc);
1638 // Get the subprogram die.
1639 DIE *SPDie = Unit->getDieMapSlotFor(SPD);
1640 assert(SPDie && "Missing subprogram descriptor");
1642 // Add the function bounds.
1643 SPDie->AddLabel(DW_AT_low_pc, DW_FORM_addr,
1644 DWLabel("func_begin", SubprogramCount));
1645 SPDie->AddLabel(DW_AT_high_pc, DW_FORM_addr,
1646 DWLabel("func_end", SubprogramCount));
1647 MachineLocation Location(RI->getFrameRegister(*MF));
1648 AddAddress(SPDie, DW_AT_frame_base, Location);
1650 ConstructScope(RootScope, SPDie, Unit);
1653 /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
1654 /// tools to recognize the object file contains Dwarf information.
1656 void DwarfWriter::EmitInitial() {
1657 // Check to see if we already emitted intial headers.
1658 if (didInitial) return;
1661 // Dwarf sections base addresses.
1662 Asm->SwitchToDataSection(DwarfFrameSection, 0);
1663 EmitLabel("section_frame", 0);
1664 Asm->SwitchToDataSection(DwarfInfoSection, 0);
1665 EmitLabel("section_info", 0);
1666 EmitLabel("info", 0);
1667 Asm->SwitchToDataSection(DwarfAbbrevSection, 0);
1668 EmitLabel("section_abbrev", 0);
1669 EmitLabel("abbrev", 0);
1670 Asm->SwitchToDataSection(DwarfARangesSection, 0);
1671 EmitLabel("section_aranges", 0);
1672 Asm->SwitchToDataSection(DwarfMacInfoSection, 0);
1673 EmitLabel("section_macinfo", 0);
1674 Asm->SwitchToDataSection(DwarfLineSection, 0);
1675 EmitLabel("section_line", 0);
1676 EmitLabel("line", 0);
1677 Asm->SwitchToDataSection(DwarfLocSection, 0);
1678 EmitLabel("section_loc", 0);
1679 Asm->SwitchToDataSection(DwarfPubNamesSection, 0);
1680 EmitLabel("section_pubnames", 0);
1681 Asm->SwitchToDataSection(DwarfStrSection, 0);
1682 EmitLabel("section_str", 0);
1683 Asm->SwitchToDataSection(DwarfRangesSection, 0);
1684 EmitLabel("section_ranges", 0);
1686 Asm->SwitchToDataSection(TextSection, 0);
1687 EmitLabel("text_begin", 0);
1688 Asm->SwitchToDataSection(DataSection, 0);
1689 EmitLabel("data_begin", 0);
1691 // Emit common frame information.
1692 EmitInitialDebugFrame();
1695 /// EmitDIE - Recusively Emits a debug information entry.
1697 void DwarfWriter::EmitDIE(DIE *Die) const {
1698 // Get the abbreviation for this DIE.
1699 unsigned AbbrevID = Die->getAbbrevID();
1700 const DIEAbbrev &Abbrev = Abbreviations[AbbrevID];
1704 // Emit the code (index) for the abbreviation.
1705 EmitULEB128Bytes(AbbrevID);
1706 EOL(std::string("Abbrev [" +
1708 "] 0x" + utohexstr(Die->getOffset()) +
1709 ":0x" + utohexstr(Die->getSize()) + " " +
1710 TagString(Abbrev.getTag())));
1712 const std::vector<DIEValue *> &Values = Die->getValues();
1713 const std::vector<DIEAbbrevData> &AbbrevData = Abbrev.getData();
1715 // Emit the DIE attribute values.
1716 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1717 unsigned Attr = AbbrevData[i].getAttribute();
1718 unsigned Form = AbbrevData[i].getForm();
1719 assert(Form && "Too many attributes for DIE (check abbreviation)");
1722 case DW_AT_sibling: {
1723 EmitInt32(Die->SiblingOffset());
1727 // Emit an attribute using the defined form.
1728 Values[i]->EmitValue(*this, Form);
1733 EOL(AttributeString(Attr));
1736 // Emit the DIE children if any.
1737 if (Abbrev.getChildrenFlag() == DW_CHILDREN_yes) {
1738 const std::vector<DIE *> &Children = Die->getChildren();
1740 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
1741 EmitDIE(Children[j]);
1744 EmitInt8(0); EOL("End Of Children Mark");
1748 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
1750 unsigned DwarfWriter::SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
1751 // Get the children.
1752 const std::vector<DIE *> &Children = Die->getChildren();
1754 // If not last sibling and has children then add sibling offset attribute.
1755 if (!Last && !Children.empty()) Die->AddSiblingOffset();
1757 // Record the abbreviation.
1758 Die->Complete(*this);
1760 // Get the abbreviation for this DIE.
1761 unsigned AbbrevID = Die->getAbbrevID();
1762 const DIEAbbrev &Abbrev = Abbreviations[AbbrevID];
1765 Die->setOffset(Offset);
1767 // Start the size with the size of abbreviation code.
1768 Offset += SizeULEB128(AbbrevID);
1770 const std::vector<DIEValue *> &Values = Die->getValues();
1771 const std::vector<DIEAbbrevData> &AbbrevData = Abbrev.getData();
1773 // Emit the DIE attribute values.
1774 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1775 // Size attribute value.
1776 Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
1779 // Emit the DIE children if any.
1780 if (!Children.empty()) {
1781 assert(Abbrev.getChildrenFlag() == DW_CHILDREN_yes &&
1782 "Children flag not set");
1784 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
1785 Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
1788 // End of children marker.
1789 Offset += sizeof(int8_t);
1792 Die->setSize(Offset - Die->getOffset());
1796 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
1798 void DwarfWriter::SizeAndOffsets() {
1800 // Process each compile unit.
1801 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) {
1802 CompileUnit *Unit = CompileUnits[i];
1803 if (Unit->hasContent()) {
1804 // Compute size of compile unit header
1805 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
1806 sizeof(int16_t) + // DWARF version number
1807 sizeof(int32_t) + // Offset Into Abbrev. Section
1808 sizeof(int8_t); // Pointer Size (in bytes)
1809 SizeAndOffsetDie(Unit->getDie(), Offset, (i + 1) == N);
1814 /// EmitFrameMoves - Emit frame instructions to describe the layout of the
1816 void DwarfWriter::EmitFrameMoves(const char *BaseLabel, unsigned BaseLabelID,
1817 std::vector<MachineMove *> &Moves) {
1818 for (unsigned i = 0, N = Moves.size(); i < N; ++i) {
1819 MachineMove *Move = Moves[i];
1820 unsigned LabelID = Move->getLabelID();
1821 const MachineLocation &Dst = Move->getDestination();
1822 const MachineLocation &Src = Move->getSource();
1824 // Advance row if new location.
1825 if (BaseLabel && LabelID && BaseLabelID != LabelID) {
1826 EmitULEB128Bytes(DW_CFA_advance_loc4);
1827 EOL("DW_CFA_advance_loc4");
1828 EmitDifference("loc", LabelID, BaseLabel, BaseLabelID);
1831 BaseLabelID = LabelID;
1835 // If advancing cfa.
1836 if (Dst.isRegister() && Dst.getRegister() == MachineLocation::VirtualFP) {
1837 if (!Src.isRegister()) {
1838 if (Src.getRegister() == MachineLocation::VirtualFP) {
1839 EmitULEB128Bytes(DW_CFA_def_cfa_offset);
1840 EOL("DW_CFA_def_cfa_offset");
1842 EmitULEB128Bytes(DW_CFA_def_cfa);
1843 EOL("DW_CFA_def_cfa");
1845 EmitULEB128Bytes(RI->getDwarfRegNum(Src.getRegister()));
1850 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
1851 TargetFrameInfo::StackGrowsUp ?
1852 AddressSize : -AddressSize;
1854 EmitULEB128Bytes(Src.getOffset() / stackGrowth);
1863 /// EmitDebugInfo - Emit the debug info section.
1865 void DwarfWriter::EmitDebugInfo() const {
1866 // Start debug info section.
1867 Asm->SwitchToDataSection(DwarfInfoSection, 0);
1869 // Process each compile unit.
1870 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) {
1871 CompileUnit *Unit = CompileUnits[i];
1873 if (Unit->hasContent()) {
1874 DIE *Die = Unit->getDie();
1875 // Emit the compile units header.
1876 EmitLabel("info_begin", Unit->getID());
1877 // Emit size of content not including length itself
1878 unsigned ContentSize = Die->getSize() +
1879 sizeof(int16_t) + // DWARF version number
1880 sizeof(int32_t) + // Offset Into Abbrev. Section
1881 sizeof(int8_t); // Pointer Size (in bytes)
1883 EmitInt32(ContentSize); EOL("Length of Compilation Unit Info");
1884 EmitInt16(DWARF_VERSION); EOL("DWARF version number");
1885 EmitDifference("abbrev_begin", 0, "section_abbrev", 0);
1886 EOL("Offset Into Abbrev. Section");
1887 EmitInt8(AddressSize); EOL("Address Size (in bytes)");
1890 EmitLabel("info_end", Unit->getID());
1897 /// EmitAbbreviations - Emit the abbreviation section.
1899 void DwarfWriter::EmitAbbreviations() const {
1900 // Check to see if it is worth the effort.
1901 if (!Abbreviations.empty()) {
1902 // Start the debug abbrev section.
1903 Asm->SwitchToDataSection(DwarfAbbrevSection, 0);
1905 EmitLabel("abbrev_begin", 0);
1907 // For each abbrevation.
1908 for (unsigned AbbrevID = 1, NAID = Abbreviations.size();
1909 AbbrevID <= NAID; ++AbbrevID) {
1910 // Get abbreviation data
1911 const DIEAbbrev &Abbrev = Abbreviations[AbbrevID];
1913 // Emit the abbrevations code (base 1 index.)
1914 EmitULEB128Bytes(AbbrevID); EOL("Abbreviation Code");
1916 // Emit the abbreviations data.
1922 EmitLabel("abbrev_end", 0);
1928 /// EmitDebugLines - Emit source line information.
1930 void DwarfWriter::EmitDebugLines() const {
1931 // Minimum line delta, thus ranging from -10..(255-10).
1932 const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
1933 // Maximum line delta, thus ranging from -10..(255-10).
1934 const int MaxLineDelta = 255 + MinLineDelta;
1936 // Start the dwarf line section.
1937 Asm->SwitchToDataSection(DwarfLineSection, 0);
1939 // Construct the section header.
1941 EmitDifference("line_end", 0, "line_begin", 0);
1942 EOL("Length of Source Line Info");
1943 EmitLabel("line_begin", 0);
1945 EmitInt16(DWARF_VERSION); EOL("DWARF version number");
1947 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0);
1948 EOL("Prolog Length");
1949 EmitLabel("line_prolog_begin", 0);
1951 EmitInt8(1); EOL("Minimum Instruction Length");
1953 EmitInt8(1); EOL("Default is_stmt_start flag");
1955 EmitInt8(MinLineDelta); EOL("Line Base Value (Special Opcodes)");
1957 EmitInt8(MaxLineDelta); EOL("Line Range Value (Special Opcodes)");
1959 EmitInt8(-MinLineDelta); EOL("Special Opcode Base");
1961 // Line number standard opcode encodings argument count
1962 EmitInt8(0); EOL("DW_LNS_copy arg count");
1963 EmitInt8(1); EOL("DW_LNS_advance_pc arg count");
1964 EmitInt8(1); EOL("DW_LNS_advance_line arg count");
1965 EmitInt8(1); EOL("DW_LNS_set_file arg count");
1966 EmitInt8(1); EOL("DW_LNS_set_column arg count");
1967 EmitInt8(0); EOL("DW_LNS_negate_stmt arg count");
1968 EmitInt8(0); EOL("DW_LNS_set_basic_block arg count");
1969 EmitInt8(0); EOL("DW_LNS_const_add_pc arg count");
1970 EmitInt8(1); EOL("DW_LNS_fixed_advance_pc arg count");
1972 const UniqueVector<std::string> &Directories = DebugInfo->getDirectories();
1973 const UniqueVector<SourceFileInfo> &SourceFiles = DebugInfo->getSourceFiles();
1975 // Emit directories.
1976 for (unsigned DirectoryID = 1, NDID = Directories.size();
1977 DirectoryID <= NDID; ++DirectoryID) {
1978 EmitString(Directories[DirectoryID]); EOL("Directory");
1980 EmitInt8(0); EOL("End of directories");
1983 for (unsigned SourceID = 1, NSID = SourceFiles.size();
1984 SourceID <= NSID; ++SourceID) {
1985 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
1986 EmitString(SourceFile.getName()); EOL("Source");
1987 EmitULEB128Bytes(SourceFile.getDirectoryID()); EOL("Directory #");
1988 EmitULEB128Bytes(0); EOL("Mod date");
1989 EmitULEB128Bytes(0); EOL("File size");
1991 EmitInt8(0); EOL("End of files");
1993 EmitLabel("line_prolog_end", 0);
1995 // Emit line information
1996 const std::vector<SourceLineInfo *> &LineInfos = DebugInfo->getSourceLines();
1998 // Dwarf assumes we start with first line of first source file.
1999 unsigned Source = 1;
2002 // Construct rows of the address, source, line, column matrix.
2003 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2004 SourceLineInfo *LineInfo = LineInfos[i];
2007 unsigned SourceID = LineInfo->getSourceID();
2008 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
2009 unsigned DirectoryID = SourceFile.getDirectoryID();
2011 << Asm->CommentString << " "
2012 << Directories[DirectoryID]
2013 << SourceFile.getName() << ":"
2014 << LineInfo->getLine() << "\n";
2017 // Define the line address.
2018 EmitInt8(0); EOL("Extended Op");
2019 EmitInt8(4 + 1); EOL("Op size");
2020 EmitInt8(DW_LNE_set_address); EOL("DW_LNE_set_address");
2021 EmitReference("loc", LineInfo->getLabelID()); EOL("Location label");
2023 // If change of source, then switch to the new source.
2024 if (Source != LineInfo->getSourceID()) {
2025 Source = LineInfo->getSourceID();
2026 EmitInt8(DW_LNS_set_file); EOL("DW_LNS_set_file");
2027 EmitULEB128Bytes(Source); EOL("New Source");
2030 // If change of line.
2031 if (Line != LineInfo->getLine()) {
2032 // Determine offset.
2033 int Offset = LineInfo->getLine() - Line;
2034 int Delta = Offset - MinLineDelta;
2037 Line = LineInfo->getLine();
2039 // If delta is small enough and in range...
2040 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2041 // ... then use fast opcode.
2042 EmitInt8(Delta - MinLineDelta); EOL("Line Delta");
2044 // ... otherwise use long hand.
2045 EmitInt8(DW_LNS_advance_line); EOL("DW_LNS_advance_line");
2046 EmitSLEB128Bytes(Offset); EOL("Line Offset");
2047 EmitInt8(DW_LNS_copy); EOL("DW_LNS_copy");
2050 // Copy the previous row (different address or source)
2051 EmitInt8(DW_LNS_copy); EOL("DW_LNS_copy");
2055 // Define last address.
2056 EmitInt8(0); EOL("Extended Op");
2057 EmitInt8(4 + 1); EOL("Op size");
2058 EmitInt8(DW_LNE_set_address); EOL("DW_LNE_set_address");
2059 EmitReference("text_end", 0); EOL("Location label");
2061 // Mark end of matrix.
2062 EmitInt8(0); EOL("DW_LNE_end_sequence");
2063 EmitULEB128Bytes(1); O << "\n";
2064 EmitInt8(1); O << "\n";
2066 EmitLabel("line_end", 0);
2071 /// EmitInitialDebugFrame - Emit common frame info into a debug frame section.
2073 void DwarfWriter::EmitInitialDebugFrame() {
2075 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2076 TargetFrameInfo::StackGrowsUp ?
2077 AddressSize : -AddressSize;
2079 // Start the dwarf frame section.
2080 Asm->SwitchToDataSection(DwarfFrameSection, 0);
2082 EmitDifference("frame_common_end", 0,
2083 "frame_common_begin", 0);
2084 EOL("Length of Common Information Entry");
2086 EmitLabel("frame_common_begin", 0);
2087 EmitInt32(DW_CIE_ID); EOL("CIE Identifier Tag");
2088 EmitInt8(DW_CIE_VERSION); EOL("CIE Version");
2089 EmitString(""); EOL("CIE Augmentation");
2090 EmitULEB128Bytes(1); EOL("CIE Code Alignment Factor");
2091 EmitSLEB128Bytes(stackGrowth); EOL("CIE Data Alignment Factor");
2092 EmitInt8(RI->getDwarfRegNum(RI->getRARegister())); EOL("CIE RA Column");
2094 std::vector<MachineMove *> Moves;
2095 RI->getInitialFrameState(Moves);
2096 EmitFrameMoves(NULL, 0, Moves);
2097 for (unsigned i = 0, N = Moves.size(); i < N; ++i) delete Moves[i];
2100 EmitLabel("frame_common_end", 0);
2105 /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2107 void DwarfWriter::EmitFunctionDebugFrame() {
2108 // Start the dwarf frame section.
2109 Asm->SwitchToDataSection(DwarfFrameSection, 0);
2111 EmitDifference("frame_end", SubprogramCount,
2112 "frame_begin", SubprogramCount);
2113 EOL("Length of Frame Information Entry");
2115 EmitLabel("frame_begin", SubprogramCount);
2117 EmitReference("section_frame", 0); EOL("FDE CIE offset");
2119 EmitReference("func_begin", SubprogramCount); EOL("FDE initial location");
2120 EmitDifference("func_end", SubprogramCount,
2121 "func_begin", SubprogramCount);
2122 EOL("FDE address range");
2124 std::vector<MachineMove *> &Moves = DebugInfo->getFrameMoves();
2126 EmitFrameMoves("func_begin", SubprogramCount, Moves);
2129 EmitLabel("frame_end", SubprogramCount);
2134 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
2136 void DwarfWriter::EmitDebugPubNames() {
2137 // Start the dwarf pubnames section.
2138 Asm->SwitchToDataSection(DwarfPubNamesSection, 0);
2140 // Process each compile unit.
2141 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) {
2142 CompileUnit *Unit = CompileUnits[i];
2144 if (Unit->hasContent()) {
2145 EmitDifference("pubnames_end", Unit->getID(),
2146 "pubnames_begin", Unit->getID());
2147 EOL("Length of Public Names Info");
2149 EmitLabel("pubnames_begin", Unit->getID());
2151 EmitInt16(DWARF_VERSION); EOL("DWARF Version");
2153 EmitReference("info_begin", Unit->getID());
2154 EOL("Offset of Compilation Unit Info");
2156 EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID());
2157 EOL("Compilation Unit Length");
2159 std::map<std::string, DIE *> &Globals = Unit->getGlobals();
2161 for (std::map<std::string, DIE *>::iterator GI = Globals.begin(),
2164 const std::string &Name = GI->first;
2165 DIE * Entity = GI->second;
2167 EmitInt32(Entity->getOffset()); EOL("DIE offset");
2168 EmitString(Name); EOL("External Name");
2171 EmitInt32(0); EOL("End Mark");
2172 EmitLabel("pubnames_end", Unit->getID());
2179 /// EmitDebugStr - Emit visible names into a debug str section.
2181 void DwarfWriter::EmitDebugStr() {
2182 // Check to see if it is worth the effort.
2183 if (!StringPool.empty()) {
2184 // Start the dwarf str section.
2185 Asm->SwitchToDataSection(DwarfStrSection, 0);
2187 // For each of strings in the string pool.
2188 for (unsigned StringID = 1, N = StringPool.size();
2189 StringID <= N; ++StringID) {
2190 // Emit a label for reference from debug information entries.
2191 EmitLabel("string", StringID);
2192 // Emit the string itself.
2193 const std::string &String = StringPool[StringID];
2194 EmitString(String); O << "\n";
2201 /// EmitDebugLoc - Emit visible names into a debug loc section.
2203 void DwarfWriter::EmitDebugLoc() {
2204 // Start the dwarf loc section.
2205 Asm->SwitchToDataSection(DwarfLocSection, 0);
2210 /// EmitDebugARanges - Emit visible names into a debug aranges section.
2212 void DwarfWriter::EmitDebugARanges() {
2213 // Start the dwarf aranges section.
2214 Asm->SwitchToDataSection(DwarfARangesSection, 0);
2218 // Process each compile unit.
2219 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) {
2220 CompileUnit *Unit = CompileUnits[i];
2222 if (Unit->hasContent()) {
2223 // Don't include size of length
2224 EmitInt32(0x1c); EOL("Length of Address Ranges Info");
2226 EmitInt16(DWARF_VERSION); EOL("Dwarf Version");
2228 EmitReference("info_begin", Unit->getID());
2229 EOL("Offset of Compilation Unit Info");
2231 EmitInt8(AddressSize); EOL("Size of Address");
2233 EmitInt8(0); EOL("Size of Segment Descriptor");
2235 EmitInt16(0); EOL("Pad (1)");
2236 EmitInt16(0); EOL("Pad (2)");
2239 EmitReference("text_begin", 0); EOL("Address");
2240 EmitDifference("text_end", 0, "text_begin", 0); EOL("Length");
2242 EmitInt32(0); EOL("EOM (1)");
2243 EmitInt32(0); EOL("EOM (2)");
2251 /// EmitDebugRanges - Emit visible names into a debug ranges section.
2253 void DwarfWriter::EmitDebugRanges() {
2254 // Start the dwarf ranges section.
2255 Asm->SwitchToDataSection(DwarfRangesSection, 0);
2260 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
2262 void DwarfWriter::EmitDebugMacInfo() {
2263 // Start the dwarf macinfo section.
2264 Asm->SwitchToDataSection(DwarfMacInfoSection, 0);
2269 /// ConstructCompileUnitDIEs - Create a compile unit DIE for each source and
2271 void DwarfWriter::ConstructCompileUnitDIEs() {
2272 const UniqueVector<CompileUnitDesc *> CUW = DebugInfo->getCompileUnits();
2274 for (unsigned i = 1, N = CUW.size(); i <= N; ++i) {
2275 CompileUnit *Unit = NewCompileUnit(CUW[i], i);
2276 CompileUnits.push_back(Unit);
2280 /// ConstructGlobalDIEs - Create DIEs for each of the externally visible global
2282 void DwarfWriter::ConstructGlobalDIEs() {
2283 std::vector<GlobalVariableDesc *> GlobalVariables =
2284 DebugInfo->getAnchoredDescriptors<GlobalVariableDesc>(*M);
2286 for (unsigned i = 0, N = GlobalVariables.size(); i < N; ++i) {
2287 GlobalVariableDesc *GVD = GlobalVariables[i];
2288 NewGlobalVariable(GVD);
2292 /// ConstructSubprogramDIEs - Create DIEs for each of the externally visible
2294 void DwarfWriter::ConstructSubprogramDIEs() {
2295 std::vector<SubprogramDesc *> Subprograms =
2296 DebugInfo->getAnchoredDescriptors<SubprogramDesc>(*M);
2298 for (unsigned i = 0, N = Subprograms.size(); i < N; ++i) {
2299 SubprogramDesc *SPD = Subprograms[i];
2304 //===----------------------------------------------------------------------===//
2305 // Main entry points.
2308 DwarfWriter::DwarfWriter(std::ostream &OS, AsmPrinter *A)
2311 , TD(Asm->TM.getTargetData())
2312 , RI(Asm->TM.getRegisterInfo())
2318 , IsNormalText(false)
2319 , SubprogramCount(0)
2326 , AddressSize(sizeof(int32_t))
2331 , DwarfAbbrevSection(".debug_abbrev")
2332 , DwarfInfoSection(".debug_info")
2333 , DwarfLineSection(".debug_line")
2334 , DwarfFrameSection(".debug_frame")
2335 , DwarfPubNamesSection(".debug_pubnames")
2336 , DwarfPubTypesSection(".debug_pubtypes")
2337 , DwarfStrSection(".debug_str")
2338 , DwarfLocSection(".debug_loc")
2339 , DwarfARangesSection(".debug_aranges")
2340 , DwarfRangesSection(".debug_ranges")
2341 , DwarfMacInfoSection(".debug_macinfo")
2342 , TextSection(".text")
2343 , DataSection(".data")
2345 DwarfWriter::~DwarfWriter() {
2346 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) {
2347 delete CompileUnits[i];
2351 /// SetDebugInfo - Set DebugInfo when it's known that pass manager has
2352 /// created it. Set by the target AsmPrinter.
2353 void DwarfWriter::SetDebugInfo(MachineDebugInfo *DI) {
2354 // Make sure initial declarations are made.
2355 if (!DebugInfo && DI->hasInfo()) {
2359 // Emit initial sections
2362 // Create all the compile unit DIEs.
2363 ConstructCompileUnitDIEs();
2365 // Create DIEs for each of the externally visible global variables.
2366 ConstructGlobalDIEs();
2368 // Create DIEs for each of the externally visible subprograms.
2369 ConstructSubprogramDIEs();
2373 /// BeginModule - Emit all Dwarf sections that should come prior to the content.
2375 void DwarfWriter::BeginModule(Module *M) {
2378 if (!ShouldEmitDwarf()) return;
2379 EOL("Dwarf Begin Module");
2382 /// EndModule - Emit all Dwarf sections that should come after the content.
2384 void DwarfWriter::EndModule() {
2385 if (!ShouldEmitDwarf()) return;
2386 EOL("Dwarf End Module");
2388 // Standard sections final addresses.
2389 Asm->SwitchToTextSection(TextSection, 0);
2390 EmitLabel("text_end", 0);
2391 Asm->SwitchToDataSection(DataSection, 0);
2392 EmitLabel("data_end", 0);
2394 // Compute DIE offsets and sizes.
2397 // Emit all the DIEs into a debug info section
2400 // Corresponding abbreviations into a abbrev section.
2401 EmitAbbreviations();
2403 // Emit source line correspondence into a debug line section.
2406 // Emit info into a debug pubnames section.
2407 EmitDebugPubNames();
2409 // Emit info into a debug str section.
2412 // Emit info into a debug loc section.
2415 // Emit info into a debug aranges section.
2418 // Emit info into a debug ranges section.
2421 // Emit info into a debug macinfo section.
2425 /// BeginFunction - Gather pre-function debug information. Assumes being
2426 /// emitted immediately after the function entry point.
2427 void DwarfWriter::BeginFunction(MachineFunction *MF, bool IsNormalText) {
2429 // FIXME - should be able to debug coalesced functions.
2430 this->IsNormalText = IsNormalText;
2432 // FIXME - should be able to debug coalesced functions.
2434 // Begin accumulating function debug information.
2435 DebugInfo->BeginFunction(MF);
2437 if (!ShouldEmitDwarf()) return;
2438 EOL("Dwarf Begin Function");
2440 // Assumes in correct section after the entry point.
2441 EmitLabel("func_begin", ++SubprogramCount);
2447 /// EndFunction - Gather and emit post-function debug information.
2449 void DwarfWriter::EndFunction() {
2450 if (!ShouldEmitDwarf()) return;
2451 EOL("Dwarf End Function");
2453 // FIXME - should be able to debug coalesced functions.
2455 // Define end label for subprogram.
2456 EmitLabel("func_end", SubprogramCount);
2458 // Construct scopes for subprogram.
2459 ConstructRootScope(DebugInfo->getRootScope());
2461 // Emit function frame information.
2462 EmitFunctionDebugFrame();
2465 // Clear function debug information.
2466 DebugInfo->EndFunction();