blob: 8739c3137923662a9ff361900acd30b27b4b6653 [file] [log] [blame]
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001//===-- llvm/CodeGen/DwarfWriter.cpp - Dwarf Framework ----------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner081ce942007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file contains support for writing dwarf info into asm files.
11//
12//===----------------------------------------------------------------------===//
13
14#include "llvm/CodeGen/DwarfWriter.h"
15
16#include "llvm/ADT/DenseMap.h"
17#include "llvm/ADT/FoldingSet.h"
18#include "llvm/ADT/StringExtras.h"
19#include "llvm/ADT/UniqueVector.h"
20#include "llvm/Module.h"
21#include "llvm/Type.h"
22#include "llvm/CodeGen/AsmPrinter.h"
23#include "llvm/CodeGen/MachineModuleInfo.h"
24#include "llvm/CodeGen/MachineFrameInfo.h"
25#include "llvm/CodeGen/MachineLocation.h"
Devang Patelfc187162009-01-05 17:57:47 +000026#include "llvm/Analysis/DebugInfo.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000027#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"
Owen Anderson847b99b2008-08-21 00:14:44 +000032#include "llvm/Support/raw_ostream.h"
Dan Gohman80bbde72007-09-24 21:32:18 +000033#include "llvm/System/Path.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000034#include "llvm/Target/TargetAsmInfo.h"
Dan Gohman1e57df32008-02-10 18:45:23 +000035#include "llvm/Target/TargetRegisterInfo.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000036#include "llvm/Target/TargetData.h"
37#include "llvm/Target/TargetFrameInfo.h"
38#include "llvm/Target/TargetInstrInfo.h"
39#include "llvm/Target/TargetMachine.h"
40#include "llvm/Target/TargetOptions.h"
41#include <ostream>
42#include <string>
43using namespace llvm;
44using namespace llvm::dwarf;
45
46namespace llvm {
aslc200b112008-08-16 12:57:46 +000047
Dan Gohmanf17a25c2007-07-18 16:29:46 +000048//===----------------------------------------------------------------------===//
49
50/// Configuration values for initial hash set sizes (log2).
51///
52static const unsigned InitDiesSetSize = 9; // 512
53static const unsigned InitAbbreviationsSetSize = 9; // 512
54static const unsigned InitValuesSetSize = 9; // 512
55
56//===----------------------------------------------------------------------===//
57/// Forward declarations.
58///
59class DIE;
60class DIEValue;
61
62//===----------------------------------------------------------------------===//
63/// DWLabel - Labels are used to track locations in the assembler file.
aslc200b112008-08-16 12:57:46 +000064/// Labels appear in the form @verbatim <prefix><Tag><Number> @endverbatim,
65/// where the tag is a category of label (Ex. location) and number is a value
Reid Spencer37c7cea2007-08-05 20:06:04 +000066/// unique in that category.
Dan Gohmanf17a25c2007-07-18 16:29:46 +000067class DWLabel {
68public:
69 /// Tag - Label category tag. Should always be a staticly declared C string.
70 ///
71 const char *Tag;
aslc200b112008-08-16 12:57:46 +000072
Dan Gohmanf17a25c2007-07-18 16:29:46 +000073 /// Number - Value to make label unique.
74 ///
75 unsigned Number;
76
77 DWLabel(const char *T, unsigned N) : Tag(T), Number(N) {}
aslc200b112008-08-16 12:57:46 +000078
Dan Gohmanf17a25c2007-07-18 16:29:46 +000079 void Profile(FoldingSetNodeID &ID) const {
80 ID.AddString(std::string(Tag));
81 ID.AddInteger(Number);
82 }
aslc200b112008-08-16 12:57:46 +000083
Dan Gohmanf17a25c2007-07-18 16:29:46 +000084#ifndef NDEBUG
85 void print(std::ostream *O) const {
86 if (O) print(*O);
87 }
88 void print(std::ostream &O) const {
89 O << "." << Tag;
90 if (Number) O << Number;
91 }
92#endif
93};
94
95//===----------------------------------------------------------------------===//
96/// DIEAbbrevData - Dwarf abbreviation data, describes the one attribute of a
97/// Dwarf abbreviation.
98class DIEAbbrevData {
99private:
100 /// Attribute - Dwarf attribute code.
101 ///
102 unsigned Attribute;
aslc200b112008-08-16 12:57:46 +0000103
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000104 /// Form - Dwarf form code.
aslc200b112008-08-16 12:57:46 +0000105 ///
106 unsigned Form;
107
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000108public:
109 DIEAbbrevData(unsigned A, unsigned F)
110 : Attribute(A)
111 , Form(F)
112 {}
aslc200b112008-08-16 12:57:46 +0000113
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000114 // Accessors.
115 unsigned getAttribute() const { return Attribute; }
116 unsigned getForm() const { return Form; }
117
118 /// Profile - Used to gather unique data for the abbreviation folding set.
119 ///
120 void Profile(FoldingSetNodeID &ID)const {
121 ID.AddInteger(Attribute);
122 ID.AddInteger(Form);
123 }
124};
125
126//===----------------------------------------------------------------------===//
127/// DIEAbbrev - Dwarf abbreviation, describes the organization of a debug
128/// information object.
129class DIEAbbrev : public FoldingSetNode {
130private:
131 /// Tag - Dwarf tag code.
132 ///
133 unsigned Tag;
aslc200b112008-08-16 12:57:46 +0000134
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000135 /// Unique number for node.
136 ///
137 unsigned Number;
138
139 /// ChildrenFlag - Dwarf children flag.
140 ///
141 unsigned ChildrenFlag;
142
143 /// Data - Raw data bytes for abbreviation.
144 ///
Owen Anderson88dd6232008-06-24 21:44:59 +0000145 SmallVector<DIEAbbrevData, 8> Data;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000146
147public:
148
149 DIEAbbrev(unsigned T, unsigned C)
150 : Tag(T)
151 , ChildrenFlag(C)
152 , Data()
153 {}
154 ~DIEAbbrev() {}
aslc200b112008-08-16 12:57:46 +0000155
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000156 // Accessors.
157 unsigned getTag() const { return Tag; }
158 unsigned getNumber() const { return Number; }
159 unsigned getChildrenFlag() const { return ChildrenFlag; }
Owen Anderson88dd6232008-06-24 21:44:59 +0000160 const SmallVector<DIEAbbrevData, 8> &getData() const { return Data; }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000161 void setTag(unsigned T) { Tag = T; }
162 void setChildrenFlag(unsigned CF) { ChildrenFlag = CF; }
163 void setNumber(unsigned N) { Number = N; }
aslc200b112008-08-16 12:57:46 +0000164
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000165 /// AddAttribute - Adds another set of attribute information to the
166 /// abbreviation.
167 void AddAttribute(unsigned Attribute, unsigned Form) {
168 Data.push_back(DIEAbbrevData(Attribute, Form));
169 }
aslc200b112008-08-16 12:57:46 +0000170
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000171 /// AddFirstAttribute - Adds a set of attribute information to the front
172 /// of the abbreviation.
173 void AddFirstAttribute(unsigned Attribute, unsigned Form) {
174 Data.insert(Data.begin(), DIEAbbrevData(Attribute, Form));
175 }
aslc200b112008-08-16 12:57:46 +0000176
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000177 /// Profile - Used to gather unique data for the abbreviation folding set.
178 ///
179 void Profile(FoldingSetNodeID &ID) {
180 ID.AddInteger(Tag);
181 ID.AddInteger(ChildrenFlag);
aslc200b112008-08-16 12:57:46 +0000182
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000183 // For each attribute description.
184 for (unsigned i = 0, N = Data.size(); i < N; ++i)
185 Data[i].Profile(ID);
186 }
aslc200b112008-08-16 12:57:46 +0000187
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000188 /// Emit - Print the abbreviation using the specified Dwarf writer.
189 ///
aslc200b112008-08-16 12:57:46 +0000190 void Emit(const DwarfDebug &DD) const;
191
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000192#ifndef NDEBUG
193 void print(std::ostream *O) {
194 if (O) print(*O);
195 }
196 void print(std::ostream &O);
197 void dump();
198#endif
199};
200
201//===----------------------------------------------------------------------===//
202/// DIE - A structured debug information entry. Has an abbreviation which
203/// describes it's organization.
204class DIE : public FoldingSetNode {
205protected:
206 /// Abbrev - Buffer for constructing abbreviation.
207 ///
208 DIEAbbrev Abbrev;
aslc200b112008-08-16 12:57:46 +0000209
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000210 /// Offset - Offset in debug info section.
211 ///
212 unsigned Offset;
aslc200b112008-08-16 12:57:46 +0000213
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000214 /// Size - Size of instance + children.
215 ///
216 unsigned Size;
aslc200b112008-08-16 12:57:46 +0000217
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000218 /// Children DIEs.
219 ///
220 std::vector<DIE *> Children;
aslc200b112008-08-16 12:57:46 +0000221
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000222 /// Attributes values.
223 ///
Owen Anderson88dd6232008-06-24 21:44:59 +0000224 SmallVector<DIEValue*, 32> Values;
aslc200b112008-08-16 12:57:46 +0000225
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000226public:
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000227 explicit DIE(unsigned Tag)
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000228 : Abbrev(Tag, DW_CHILDREN_no)
229 , Offset(0)
230 , Size(0)
231 , Children()
232 , Values()
233 {}
234 virtual ~DIE();
aslc200b112008-08-16 12:57:46 +0000235
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000236 // Accessors.
237 DIEAbbrev &getAbbrev() { return Abbrev; }
238 unsigned getAbbrevNumber() const {
239 return Abbrev.getNumber();
240 }
241 unsigned getTag() const { return Abbrev.getTag(); }
242 unsigned getOffset() const { return Offset; }
243 unsigned getSize() const { return Size; }
244 const std::vector<DIE *> &getChildren() const { return Children; }
Owen Anderson88dd6232008-06-24 21:44:59 +0000245 SmallVector<DIEValue*, 32> &getValues() { return Values; }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000246 void setTag(unsigned Tag) { Abbrev.setTag(Tag); }
247 void setOffset(unsigned O) { Offset = O; }
248 void setSize(unsigned S) { Size = S; }
aslc200b112008-08-16 12:57:46 +0000249
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000250 /// AddValue - Add a value and attributes to a DIE.
251 ///
252 void AddValue(unsigned Attribute, unsigned Form, DIEValue *Value) {
253 Abbrev.AddAttribute(Attribute, Form);
254 Values.push_back(Value);
255 }
aslc200b112008-08-16 12:57:46 +0000256
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000257 /// SiblingOffset - Return the offset of the debug information entry's
258 /// sibling.
259 unsigned SiblingOffset() const { return Offset + Size; }
aslc200b112008-08-16 12:57:46 +0000260
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000261 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
262 ///
263 void AddSiblingOffset();
264
265 /// AddChild - Add a child to the DIE.
266 ///
267 void AddChild(DIE *Child) {
268 Abbrev.setChildrenFlag(DW_CHILDREN_yes);
269 Children.push_back(Child);
270 }
aslc200b112008-08-16 12:57:46 +0000271
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000272 /// Detach - Detaches objects connected to it after copying.
273 ///
274 void Detach() {
275 Children.clear();
276 }
aslc200b112008-08-16 12:57:46 +0000277
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000278 /// Profile - Used to gather unique data for the value folding set.
279 ///
280 void Profile(FoldingSetNodeID &ID) ;
aslc200b112008-08-16 12:57:46 +0000281
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000282#ifndef NDEBUG
283 void print(std::ostream *O, unsigned IncIndent = 0) {
284 if (O) print(*O, IncIndent);
285 }
286 void print(std::ostream &O, unsigned IncIndent = 0);
287 void dump();
288#endif
289};
290
291//===----------------------------------------------------------------------===//
292/// DIEValue - A debug information entry value.
293///
294class DIEValue : public FoldingSetNode {
295public:
296 enum {
297 isInteger,
298 isString,
299 isLabel,
300 isAsIsLabel,
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000301 isSectionOffset,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000302 isDelta,
303 isEntry,
304 isBlock
305 };
aslc200b112008-08-16 12:57:46 +0000306
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000307 /// Type - Type of data stored in the value.
308 ///
309 unsigned Type;
aslc200b112008-08-16 12:57:46 +0000310
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000311 explicit DIEValue(unsigned T)
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000312 : Type(T)
313 {}
314 virtual ~DIEValue() {}
aslc200b112008-08-16 12:57:46 +0000315
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000316 // Accessors
317 unsigned getType() const { return Type; }
aslc200b112008-08-16 12:57:46 +0000318
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000319 // Implement isa/cast/dyncast.
320 static bool classof(const DIEValue *) { return true; }
aslc200b112008-08-16 12:57:46 +0000321
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000322 /// EmitValue - Emit value via the Dwarf writer.
323 ///
324 virtual void EmitValue(DwarfDebug &DD, unsigned Form) = 0;
aslc200b112008-08-16 12:57:46 +0000325
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000326 /// SizeOf - Return the size of a value in bytes.
327 ///
328 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const = 0;
aslc200b112008-08-16 12:57:46 +0000329
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000330 /// Profile - Used to gather unique data for the value folding set.
331 ///
332 virtual void Profile(FoldingSetNodeID &ID) = 0;
aslc200b112008-08-16 12:57:46 +0000333
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000334#ifndef NDEBUG
335 void print(std::ostream *O) {
336 if (O) print(*O);
337 }
338 virtual void print(std::ostream &O) = 0;
339 void dump();
340#endif
341};
342
343//===----------------------------------------------------------------------===//
344/// DWInteger - An integer value DIE.
aslc200b112008-08-16 12:57:46 +0000345///
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000346class DIEInteger : public DIEValue {
347private:
348 uint64_t Integer;
aslc200b112008-08-16 12:57:46 +0000349
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000350public:
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000351 explicit DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000352
353 // Implement isa/cast/dyncast.
354 static bool classof(const DIEInteger *) { return true; }
355 static bool classof(const DIEValue *I) { return I->Type == isInteger; }
aslc200b112008-08-16 12:57:46 +0000356
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000357 /// BestForm - Choose the best form for integer.
358 ///
359 static unsigned BestForm(bool IsSigned, uint64_t Integer) {
360 if (IsSigned) {
361 if ((char)Integer == (signed)Integer) return DW_FORM_data1;
362 if ((short)Integer == (signed)Integer) return DW_FORM_data2;
363 if ((int)Integer == (signed)Integer) return DW_FORM_data4;
364 } else {
365 if ((unsigned char)Integer == Integer) return DW_FORM_data1;
366 if ((unsigned short)Integer == Integer) return DW_FORM_data2;
367 if ((unsigned int)Integer == Integer) return DW_FORM_data4;
368 }
369 return DW_FORM_data8;
370 }
aslc200b112008-08-16 12:57:46 +0000371
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000372 /// EmitValue - Emit integer of appropriate size.
373 ///
374 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000375
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000376 /// SizeOf - Determine size of integer value in bytes.
377 ///
378 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000379
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000380 /// Profile - Used to gather unique data for the value folding set.
381 ///
382 static void Profile(FoldingSetNodeID &ID, unsigned Integer) {
383 ID.AddInteger(isInteger);
384 ID.AddInteger(Integer);
385 }
386 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Integer); }
aslc200b112008-08-16 12:57:46 +0000387
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000388#ifndef NDEBUG
389 virtual void print(std::ostream &O) {
390 O << "Int: " << (int64_t)Integer
391 << " 0x" << std::hex << Integer << std::dec;
392 }
393#endif
394};
395
396//===----------------------------------------------------------------------===//
397/// DIEString - A string value DIE.
aslc200b112008-08-16 12:57:46 +0000398///
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000399class DIEString : public DIEValue {
400public:
401 const std::string String;
aslc200b112008-08-16 12:57:46 +0000402
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000403 explicit DIEString(const std::string &S) : DIEValue(isString), String(S) {}
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000404
405 // Implement isa/cast/dyncast.
406 static bool classof(const DIEString *) { return true; }
407 static bool classof(const DIEValue *S) { return S->Type == isString; }
aslc200b112008-08-16 12:57:46 +0000408
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000409 /// EmitValue - Emit string value.
410 ///
411 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000412
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000413 /// SizeOf - Determine size of string value in bytes.
414 ///
415 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
416 return String.size() + sizeof(char); // sizeof('\0');
417 }
aslc200b112008-08-16 12:57:46 +0000418
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000419 /// Profile - Used to gather unique data for the value folding set.
420 ///
421 static void Profile(FoldingSetNodeID &ID, const std::string &String) {
422 ID.AddInteger(isString);
423 ID.AddString(String);
424 }
425 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, String); }
aslc200b112008-08-16 12:57:46 +0000426
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000427#ifndef NDEBUG
428 virtual void print(std::ostream &O) {
429 O << "Str: \"" << String << "\"";
430 }
431#endif
432};
433
434//===----------------------------------------------------------------------===//
435/// DIEDwarfLabel - A Dwarf internal label expression DIE.
436//
437class DIEDwarfLabel : public DIEValue {
438public:
439
440 const DWLabel Label;
aslc200b112008-08-16 12:57:46 +0000441
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000442 explicit DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {}
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000443
444 // Implement isa/cast/dyncast.
445 static bool classof(const DIEDwarfLabel *) { return true; }
446 static bool classof(const DIEValue *L) { return L->Type == isLabel; }
aslc200b112008-08-16 12:57:46 +0000447
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000448 /// EmitValue - Emit label value.
449 ///
450 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000451
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000452 /// SizeOf - Determine size of label value in bytes.
453 ///
454 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000455
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000456 /// Profile - Used to gather unique data for the value folding set.
457 ///
458 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label) {
459 ID.AddInteger(isLabel);
460 Label.Profile(ID);
461 }
462 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
aslc200b112008-08-16 12:57:46 +0000463
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000464#ifndef NDEBUG
465 virtual void print(std::ostream &O) {
466 O << "Lbl: ";
467 Label.print(O);
468 }
469#endif
470};
471
472
473//===----------------------------------------------------------------------===//
474/// DIEObjectLabel - A label to an object in code or data.
475//
476class DIEObjectLabel : public DIEValue {
477public:
478 const std::string Label;
aslc200b112008-08-16 12:57:46 +0000479
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000480 explicit DIEObjectLabel(const std::string &L)
481 : DIEValue(isAsIsLabel), Label(L) {}
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000482
483 // Implement isa/cast/dyncast.
484 static bool classof(const DIEObjectLabel *) { return true; }
485 static bool classof(const DIEValue *L) { return L->Type == isAsIsLabel; }
aslc200b112008-08-16 12:57:46 +0000486
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000487 /// EmitValue - Emit label value.
488 ///
489 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000490
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000491 /// SizeOf - Determine size of label value in bytes.
492 ///
493 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000494
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000495 /// Profile - Used to gather unique data for the value folding set.
496 ///
497 static void Profile(FoldingSetNodeID &ID, const std::string &Label) {
498 ID.AddInteger(isAsIsLabel);
499 ID.AddString(Label);
500 }
501 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
502
503#ifndef NDEBUG
504 virtual void print(std::ostream &O) {
505 O << "Obj: " << Label;
506 }
507#endif
508};
509
510//===----------------------------------------------------------------------===//
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000511/// DIESectionOffset - A section offset DIE.
512//
513class DIESectionOffset : public DIEValue {
514public:
515 const DWLabel Label;
516 const DWLabel Section;
517 bool IsEH : 1;
518 bool UseSet : 1;
aslc200b112008-08-16 12:57:46 +0000519
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000520 DIESectionOffset(const DWLabel &Lab, const DWLabel &Sec,
521 bool isEH = false, bool useSet = true)
522 : DIEValue(isSectionOffset), Label(Lab), Section(Sec),
523 IsEH(isEH), UseSet(useSet) {}
524
525 // Implement isa/cast/dyncast.
526 static bool classof(const DIESectionOffset *) { return true; }
527 static bool classof(const DIEValue *D) { return D->Type == isSectionOffset; }
aslc200b112008-08-16 12:57:46 +0000528
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000529 /// EmitValue - Emit section offset.
530 ///
531 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000532
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000533 /// SizeOf - Determine size of section offset value in bytes.
534 ///
535 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000536
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000537 /// Profile - Used to gather unique data for the value folding set.
538 ///
539 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label,
540 const DWLabel &Section) {
541 ID.AddInteger(isSectionOffset);
542 Label.Profile(ID);
543 Section.Profile(ID);
544 // IsEH and UseSet are specific to the Label/Section that we will emit
545 // the offset for; so Label/Section are enough for uniqueness.
546 }
547 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label, Section); }
548
549#ifndef NDEBUG
550 virtual void print(std::ostream &O) {
551 O << "Off: ";
552 Label.print(O);
553 O << "-";
554 Section.print(O);
555 O << "-" << IsEH << "-" << UseSet;
556 }
557#endif
558};
559
560//===----------------------------------------------------------------------===//
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000561/// DIEDelta - A simple label difference DIE.
aslc200b112008-08-16 12:57:46 +0000562///
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000563class DIEDelta : public DIEValue {
564public:
565 const DWLabel LabelHi;
566 const DWLabel LabelLo;
aslc200b112008-08-16 12:57:46 +0000567
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000568 DIEDelta(const DWLabel &Hi, const DWLabel &Lo)
569 : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
570
571 // Implement isa/cast/dyncast.
572 static bool classof(const DIEDelta *) { return true; }
573 static bool classof(const DIEValue *D) { return D->Type == isDelta; }
aslc200b112008-08-16 12:57:46 +0000574
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000575 /// EmitValue - Emit delta value.
576 ///
577 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000578
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000579 /// SizeOf - Determine size of delta value in bytes.
580 ///
581 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000582
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000583 /// Profile - Used to gather unique data for the value folding set.
584 ///
585 static void Profile(FoldingSetNodeID &ID, const DWLabel &LabelHi,
586 const DWLabel &LabelLo) {
587 ID.AddInteger(isDelta);
588 LabelHi.Profile(ID);
589 LabelLo.Profile(ID);
590 }
591 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, LabelHi, LabelLo); }
592
593#ifndef NDEBUG
594 virtual void print(std::ostream &O) {
595 O << "Del: ";
596 LabelHi.print(O);
597 O << "-";
598 LabelLo.print(O);
599 }
600#endif
601};
602
603//===----------------------------------------------------------------------===//
604/// DIEntry - A pointer to another debug information entry. An instance of this
605/// class can also be used as a proxy for a debug information entry not yet
606/// defined (ie. types.)
607class DIEntry : public DIEValue {
608public:
609 DIE *Entry;
aslc200b112008-08-16 12:57:46 +0000610
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000611 explicit DIEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
aslc200b112008-08-16 12:57:46 +0000612
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000613 // Implement isa/cast/dyncast.
614 static bool classof(const DIEntry *) { return true; }
615 static bool classof(const DIEValue *E) { return E->Type == isEntry; }
aslc200b112008-08-16 12:57:46 +0000616
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000617 /// EmitValue - Emit debug information entry offset.
618 ///
619 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000620
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000621 /// SizeOf - Determine size of debug information entry in bytes.
622 ///
623 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
624 return sizeof(int32_t);
625 }
aslc200b112008-08-16 12:57:46 +0000626
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000627 /// Profile - Used to gather unique data for the value folding set.
628 ///
629 static void Profile(FoldingSetNodeID &ID, DIE *Entry) {
630 ID.AddInteger(isEntry);
631 ID.AddPointer(Entry);
632 }
633 virtual void Profile(FoldingSetNodeID &ID) {
634 ID.AddInteger(isEntry);
aslc200b112008-08-16 12:57:46 +0000635
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000636 if (Entry) {
637 ID.AddPointer(Entry);
638 } else {
639 ID.AddPointer(this);
640 }
641 }
aslc200b112008-08-16 12:57:46 +0000642
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000643#ifndef NDEBUG
644 virtual void print(std::ostream &O) {
645 O << "Die: 0x" << std::hex << (intptr_t)Entry << std::dec;
646 }
647#endif
648};
649
650//===----------------------------------------------------------------------===//
651/// DIEBlock - A block of values. Primarily used for location expressions.
652//
653class DIEBlock : public DIEValue, public DIE {
654public:
655 unsigned Size; // Size in bytes excluding size header.
aslc200b112008-08-16 12:57:46 +0000656
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000657 DIEBlock()
658 : DIEValue(isBlock)
659 , DIE(0)
660 , Size(0)
661 {}
662 ~DIEBlock() {
663 }
aslc200b112008-08-16 12:57:46 +0000664
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000665 // Implement isa/cast/dyncast.
666 static bool classof(const DIEBlock *) { return true; }
667 static bool classof(const DIEValue *E) { return E->Type == isBlock; }
aslc200b112008-08-16 12:57:46 +0000668
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000669 /// ComputeSize - calculate the size of the block.
670 ///
671 unsigned ComputeSize(DwarfDebug &DD);
aslc200b112008-08-16 12:57:46 +0000672
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000673 /// BestForm - Choose the best form for data.
674 ///
675 unsigned BestForm() const {
676 if ((unsigned char)Size == Size) return DW_FORM_block1;
677 if ((unsigned short)Size == Size) return DW_FORM_block2;
678 if ((unsigned int)Size == Size) return DW_FORM_block4;
679 return DW_FORM_block;
680 }
681
682 /// EmitValue - Emit block data.
683 ///
684 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000685
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000686 /// SizeOf - Determine size of block data in bytes.
687 ///
688 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000689
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000690
691 /// Profile - Used to gather unique data for the value folding set.
692 ///
693 virtual void Profile(FoldingSetNodeID &ID) {
694 ID.AddInteger(isBlock);
695 DIE::Profile(ID);
696 }
aslc200b112008-08-16 12:57:46 +0000697
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000698#ifndef NDEBUG
699 virtual void print(std::ostream &O) {
700 O << "Blk: ";
701 DIE::print(O, 5);
702 }
703#endif
704};
705
706//===----------------------------------------------------------------------===//
707/// CompileUnit - This dwarf writer support class manages information associate
708/// with a source file.
709class CompileUnit {
710private:
711 /// Desc - Compile unit debug descriptor.
712 ///
713 CompileUnitDesc *Desc;
aslc200b112008-08-16 12:57:46 +0000714
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000715 /// ID - File identifier for source.
716 ///
717 unsigned ID;
aslc200b112008-08-16 12:57:46 +0000718
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000719 /// Die - Compile unit debug information entry.
720 ///
721 DIE *Die;
aslc200b112008-08-16 12:57:46 +0000722
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000723 /// DescToDieMap - Tracks the mapping of unit level debug informaton
724 /// descriptors to debug information entries.
725 std::map<DebugInfoDesc *, DIE *> DescToDieMap;
726
727 /// DescToDIEntryMap - Tracks the mapping of unit level debug informaton
728 /// descriptors to debug information entries using a DIEntry proxy.
729 std::map<DebugInfoDesc *, DIEntry *> DescToDIEntryMap;
730
731 /// Globals - A map of globally visible named entities for this unit.
732 ///
733 std::map<std::string, DIE *> Globals;
734
735 /// DiesSet - Used to uniquely define dies within the compile unit.
736 ///
737 FoldingSet<DIE> DiesSet;
aslc200b112008-08-16 12:57:46 +0000738
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000739 /// Dies - List of all dies in the compile unit.
740 ///
741 std::vector<DIE *> Dies;
aslc200b112008-08-16 12:57:46 +0000742
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000743public:
744 CompileUnit(CompileUnitDesc *CUD, unsigned I, DIE *D)
745 : Desc(CUD)
746 , ID(I)
747 , Die(D)
748 , DescToDieMap()
749 , DescToDIEntryMap()
750 , Globals()
751 , DiesSet(InitDiesSetSize)
752 , Dies()
753 {}
aslc200b112008-08-16 12:57:46 +0000754
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000755 ~CompileUnit() {
756 delete Die;
aslc200b112008-08-16 12:57:46 +0000757
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000758 for (unsigned i = 0, N = Dies.size(); i < N; ++i)
759 delete Dies[i];
760 }
aslc200b112008-08-16 12:57:46 +0000761
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000762 // Accessors.
763 CompileUnitDesc *getDesc() const { return Desc; }
764 unsigned getID() const { return ID; }
765 DIE* getDie() const { return Die; }
766 std::map<std::string, DIE *> &getGlobals() { return Globals; }
767
768 /// hasContent - Return true if this compile unit has something to write out.
769 ///
770 bool hasContent() const {
771 return !Die->getChildren().empty();
772 }
773
774 /// AddGlobal - Add a new global entity to the compile unit.
775 ///
776 void AddGlobal(const std::string &Name, DIE *Die) {
777 Globals[Name] = Die;
778 }
aslc200b112008-08-16 12:57:46 +0000779
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000780 /// getDieMapSlotFor - Returns the debug information entry map slot for the
781 /// specified debug descriptor.
782 DIE *&getDieMapSlotFor(DebugInfoDesc *DID) {
783 return DescToDieMap[DID];
784 }
aslc200b112008-08-16 12:57:46 +0000785
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000786 /// getDIEntrySlotFor - Returns the debug information entry proxy slot for the
787 /// specified debug descriptor.
788 DIEntry *&getDIEntrySlotFor(DebugInfoDesc *DID) {
789 return DescToDIEntryMap[DID];
790 }
aslc200b112008-08-16 12:57:46 +0000791
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000792 /// AddDie - Adds or interns the DIE to the compile unit.
793 ///
794 DIE *AddDie(DIE &Buffer) {
795 FoldingSetNodeID ID;
796 Buffer.Profile(ID);
797 void *Where;
798 DIE *Die = DiesSet.FindNodeOrInsertPos(ID, Where);
aslc200b112008-08-16 12:57:46 +0000799
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000800 if (!Die) {
801 Die = new DIE(Buffer);
802 DiesSet.InsertNode(Die, Where);
803 this->Die->AddChild(Die);
804 Buffer.Detach();
805 }
aslc200b112008-08-16 12:57:46 +0000806
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000807 return Die;
808 }
809};
810
811//===----------------------------------------------------------------------===//
aslc200b112008-08-16 12:57:46 +0000812/// Dwarf - Emits general Dwarf directives.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000813///
814class Dwarf {
815
816protected:
817
818 //===--------------------------------------------------------------------===//
819 // Core attributes used by the Dwarf writer.
820 //
aslc200b112008-08-16 12:57:46 +0000821
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000822 //
823 /// O - Stream to .s file.
824 ///
Owen Anderson847b99b2008-08-21 00:14:44 +0000825 raw_ostream &O;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000826
827 /// Asm - Target of Dwarf emission.
828 ///
829 AsmPrinter *Asm;
aslc200b112008-08-16 12:57:46 +0000830
Bill Wendlingac9639d2008-07-01 23:34:48 +0000831 /// TAI - Target asm information.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000832 const TargetAsmInfo *TAI;
aslc200b112008-08-16 12:57:46 +0000833
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000834 /// TD - Target data.
835 const TargetData *TD;
aslc200b112008-08-16 12:57:46 +0000836
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000837 /// RI - Register Information.
Dan Gohman1e57df32008-02-10 18:45:23 +0000838 const TargetRegisterInfo *RI;
aslc200b112008-08-16 12:57:46 +0000839
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000840 /// M - Current module.
841 ///
842 Module *M;
aslc200b112008-08-16 12:57:46 +0000843
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000844 /// MF - Current machine function.
845 ///
846 MachineFunction *MF;
aslc200b112008-08-16 12:57:46 +0000847
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000848 /// MMI - Collected machine module information.
849 ///
850 MachineModuleInfo *MMI;
aslc200b112008-08-16 12:57:46 +0000851
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000852 /// SubprogramCount - The running count of functions being compiled.
853 ///
854 unsigned SubprogramCount;
aslc200b112008-08-16 12:57:46 +0000855
Chris Lattnerb3876c72007-09-24 03:35:37 +0000856 /// Flavor - A unique string indicating what dwarf producer this is, used to
857 /// unique labels.
858 const char * const Flavor;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000859
860 unsigned SetCounter;
Owen Anderson847b99b2008-08-21 00:14:44 +0000861 Dwarf(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T,
Chris Lattnerb3876c72007-09-24 03:35:37 +0000862 const char *flavor)
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000863 : O(OS)
864 , Asm(A)
865 , TAI(T)
866 , TD(Asm->TM.getTargetData())
867 , RI(Asm->TM.getRegisterInfo())
868 , M(NULL)
869 , MF(NULL)
870 , MMI(NULL)
871 , SubprogramCount(0)
Chris Lattnerb3876c72007-09-24 03:35:37 +0000872 , Flavor(flavor)
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000873 , SetCounter(1)
874 {
875 }
876
877public:
878
879 //===--------------------------------------------------------------------===//
880 // Accessors.
881 //
882 AsmPrinter *getAsm() const { return Asm; }
883 MachineModuleInfo *getMMI() const { return MMI; }
884 const TargetAsmInfo *getTargetAsmInfo() const { return TAI; }
Dan Gohmancfb72b22007-09-27 23:12:31 +0000885 const TargetData *getTargetData() const { return TD; }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000886
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000887 void PrintRelDirective(bool Force32Bit = false, bool isInSection = false)
888 const {
889 if (isInSection && TAI->getDwarfSectionOffsetDirective())
890 O << TAI->getDwarfSectionOffsetDirective();
Dan Gohmancfb72b22007-09-27 23:12:31 +0000891 else if (Force32Bit || TD->getPointerSize() == sizeof(int32_t))
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000892 O << TAI->getData32bitsDirective();
893 else
894 O << TAI->getData64bitsDirective();
895 }
aslc200b112008-08-16 12:57:46 +0000896
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000897 /// PrintLabelName - Print label name in form used by Dwarf writer.
898 ///
899 void PrintLabelName(DWLabel Label) const {
900 PrintLabelName(Label.Tag, Label.Number);
901 }
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000902 void PrintLabelName(const char *Tag, unsigned Number) const {
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000903 O << TAI->getPrivateGlobalPrefix() << Tag;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000904 if (Number) O << Number;
905 }
aslc200b112008-08-16 12:57:46 +0000906
Chris Lattnerb3876c72007-09-24 03:35:37 +0000907 void PrintLabelName(const char *Tag, unsigned Number,
908 const char *Suffix) const {
909 O << TAI->getPrivateGlobalPrefix() << Tag;
910 if (Number) O << Number;
911 O << Suffix;
912 }
aslc200b112008-08-16 12:57:46 +0000913
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000914 /// EmitLabel - Emit location label for internal use by Dwarf.
915 ///
916 void EmitLabel(DWLabel Label) const {
917 EmitLabel(Label.Tag, Label.Number);
918 }
919 void EmitLabel(const char *Tag, unsigned Number) const {
920 PrintLabelName(Tag, Number);
921 O << ":\n";
922 }
aslc200b112008-08-16 12:57:46 +0000923
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000924 /// EmitReference - Emit a reference to a label.
925 ///
Dan Gohman4fd77742007-09-28 15:43:33 +0000926 void EmitReference(DWLabel Label, bool IsPCRelative = false,
927 bool Force32Bit = false) const {
928 EmitReference(Label.Tag, Label.Number, IsPCRelative, Force32Bit);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000929 }
930 void EmitReference(const char *Tag, unsigned Number,
Dan Gohman4fd77742007-09-28 15:43:33 +0000931 bool IsPCRelative = false, bool Force32Bit = false) const {
932 PrintRelDirective(Force32Bit);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000933 PrintLabelName(Tag, Number);
aslc200b112008-08-16 12:57:46 +0000934
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000935 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
936 }
Dan Gohman4fd77742007-09-28 15:43:33 +0000937 void EmitReference(const std::string &Name, bool IsPCRelative = false,
938 bool Force32Bit = false) const {
939 PrintRelDirective(Force32Bit);
aslc200b112008-08-16 12:57:46 +0000940
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000941 O << Name;
aslc200b112008-08-16 12:57:46 +0000942
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000943 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
944 }
945
946 /// EmitDifference - Emit the difference between two labels. Some
947 /// assemblers do not behave with absolute expressions with data directives,
948 /// so there is an option (needsSet) to use an intermediary set expression.
949 void EmitDifference(DWLabel LabelHi, DWLabel LabelLo,
950 bool IsSmall = false) {
951 EmitDifference(LabelHi.Tag, LabelHi.Number,
952 LabelLo.Tag, LabelLo.Number,
953 IsSmall);
954 }
955 void EmitDifference(const char *TagHi, unsigned NumberHi,
956 const char *TagLo, unsigned NumberLo,
957 bool IsSmall = false) {
958 if (TAI->needsSet()) {
959 O << "\t.set\t";
Chris Lattnerb3876c72007-09-24 03:35:37 +0000960 PrintLabelName("set", SetCounter, Flavor);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000961 O << ",";
962 PrintLabelName(TagHi, NumberHi);
963 O << "-";
964 PrintLabelName(TagLo, NumberLo);
965 O << "\n";
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000966
967 PrintRelDirective(IsSmall);
Chris Lattnerb3876c72007-09-24 03:35:37 +0000968 PrintLabelName("set", SetCounter, Flavor);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000969 ++SetCounter;
970 } else {
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000971 PrintRelDirective(IsSmall);
aslc200b112008-08-16 12:57:46 +0000972
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000973 PrintLabelName(TagHi, NumberHi);
974 O << "-";
975 PrintLabelName(TagLo, NumberLo);
976 }
977 }
978
979 void EmitSectionOffset(const char* Label, const char* Section,
980 unsigned LabelNumber, unsigned SectionNumber,
Dale Johannesen0ebb2432008-03-26 23:31:39 +0000981 bool IsSmall = false, bool isEH = false,
982 bool useSet = true) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000983 bool printAbsolute = false;
Dale Johannesen0ebb2432008-03-26 23:31:39 +0000984 if (isEH)
985 printAbsolute = TAI->isAbsoluteEHSectionOffsets();
986 else
987 printAbsolute = TAI->isAbsoluteDebugSectionOffsets();
988
989 if (TAI->needsSet() && useSet) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000990 O << "\t.set\t";
Chris Lattnerb3876c72007-09-24 03:35:37 +0000991 PrintLabelName("set", SetCounter, Flavor);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000992 O << ",";
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000993 PrintLabelName(Label, LabelNumber);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000994
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000995 if (!printAbsolute) {
996 O << "-";
997 PrintLabelName(Section, SectionNumber);
aslc200b112008-08-16 12:57:46 +0000998 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000999 O << "\n";
Anton Korobeynikov5ef86702007-09-02 22:07:21 +00001000
1001 PrintRelDirective(IsSmall);
aslc200b112008-08-16 12:57:46 +00001002
Chris Lattnerb3876c72007-09-24 03:35:37 +00001003 PrintLabelName("set", SetCounter, Flavor);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001004 ++SetCounter;
1005 } else {
Anton Korobeynikov5ef86702007-09-02 22:07:21 +00001006 PrintRelDirective(IsSmall, true);
aslc200b112008-08-16 12:57:46 +00001007
Anton Korobeynikov5ef86702007-09-02 22:07:21 +00001008 PrintLabelName(Label, LabelNumber);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001009
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001010 if (!printAbsolute) {
1011 O << "-";
1012 PrintLabelName(Section, SectionNumber);
1013 }
aslc200b112008-08-16 12:57:46 +00001014 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001015 }
aslc200b112008-08-16 12:57:46 +00001016
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001017 /// EmitFrameMoves - Emit frame instructions to describe the layout of the
1018 /// frame.
1019 void EmitFrameMoves(const char *BaseLabel, unsigned BaseLabelID,
Dale Johannesenf5a11532007-11-13 19:13:01 +00001020 const std::vector<MachineMove> &Moves, bool isEH) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001021 int stackGrowth =
1022 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
1023 TargetFrameInfo::StackGrowsUp ?
Dan Gohmancfb72b22007-09-27 23:12:31 +00001024 TD->getPointerSize() : -TD->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001025 bool IsLocal = BaseLabel && strcmp(BaseLabel, "label") == 0;
1026
1027 for (unsigned i = 0, N = Moves.size(); i < N; ++i) {
1028 const MachineMove &Move = Moves[i];
1029 unsigned LabelID = Move.getLabelID();
aslc200b112008-08-16 12:57:46 +00001030
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001031 if (LabelID) {
1032 LabelID = MMI->MappedLabel(LabelID);
aslc200b112008-08-16 12:57:46 +00001033
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001034 // Throw out move if the label is invalid.
1035 if (!LabelID) continue;
1036 }
aslc200b112008-08-16 12:57:46 +00001037
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001038 const MachineLocation &Dst = Move.getDestination();
1039 const MachineLocation &Src = Move.getSource();
aslc200b112008-08-16 12:57:46 +00001040
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001041 // Advance row if new location.
1042 if (BaseLabel && LabelID && (BaseLabelID != LabelID || !IsLocal)) {
1043 Asm->EmitInt8(DW_CFA_advance_loc4);
1044 Asm->EOL("DW_CFA_advance_loc4");
1045 EmitDifference("label", LabelID, BaseLabel, BaseLabelID, true);
1046 Asm->EOL();
aslc200b112008-08-16 12:57:46 +00001047
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001048 BaseLabelID = LabelID;
1049 BaseLabel = "label";
1050 IsLocal = true;
1051 }
aslc200b112008-08-16 12:57:46 +00001052
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001053 // If advancing cfa.
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001054 if (Dst.isReg() && Dst.getReg() == MachineLocation::VirtualFP) {
1055 if (!Src.isReg()) {
1056 if (Src.getReg() == MachineLocation::VirtualFP) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001057 Asm->EmitInt8(DW_CFA_def_cfa_offset);
1058 Asm->EOL("DW_CFA_def_cfa_offset");
1059 } else {
1060 Asm->EmitInt8(DW_CFA_def_cfa);
1061 Asm->EOL("DW_CFA_def_cfa");
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001062 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Src.getReg(), isEH));
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001063 Asm->EOL("Register");
1064 }
aslc200b112008-08-16 12:57:46 +00001065
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001066 int Offset = -Src.getOffset();
aslc200b112008-08-16 12:57:46 +00001067
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001068 Asm->EmitULEB128Bytes(Offset);
1069 Asm->EOL("Offset");
1070 } else {
1071 assert(0 && "Machine move no supported yet.");
1072 }
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001073 } else if (Src.isReg() &&
1074 Src.getReg() == MachineLocation::VirtualFP) {
1075 if (Dst.isReg()) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001076 Asm->EmitInt8(DW_CFA_def_cfa_register);
1077 Asm->EOL("DW_CFA_def_cfa_register");
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001078 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Dst.getReg(), isEH));
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001079 Asm->EOL("Register");
1080 } else {
1081 assert(0 && "Machine move no supported yet.");
1082 }
1083 } else {
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001084 unsigned Reg = RI->getDwarfRegNum(Src.getReg(), isEH);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001085 int Offset = Dst.getOffset() / stackGrowth;
aslc200b112008-08-16 12:57:46 +00001086
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001087 if (Offset < 0) {
1088 Asm->EmitInt8(DW_CFA_offset_extended_sf);
1089 Asm->EOL("DW_CFA_offset_extended_sf");
1090 Asm->EmitULEB128Bytes(Reg);
1091 Asm->EOL("Reg");
1092 Asm->EmitSLEB128Bytes(Offset);
1093 Asm->EOL("Offset");
1094 } else if (Reg < 64) {
1095 Asm->EmitInt8(DW_CFA_offset + Reg);
Evan Cheng6181e062008-07-09 21:53:02 +00001096 if (VerboseAsm)
1097 Asm->EOL("DW_CFA_offset + Reg (" + utostr(Reg) + ")");
1098 else
1099 Asm->EOL();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001100 Asm->EmitULEB128Bytes(Offset);
1101 Asm->EOL("Offset");
1102 } else {
1103 Asm->EmitInt8(DW_CFA_offset_extended);
1104 Asm->EOL("DW_CFA_offset_extended");
1105 Asm->EmitULEB128Bytes(Reg);
1106 Asm->EOL("Reg");
1107 Asm->EmitULEB128Bytes(Offset);
1108 Asm->EOL("Offset");
1109 }
1110 }
1111 }
1112 }
1113
1114};
1115
1116//===----------------------------------------------------------------------===//
aslc200b112008-08-16 12:57:46 +00001117/// DwarfDebug - Emits Dwarf debug directives.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001118///
1119class DwarfDebug : public Dwarf {
1120
1121private:
1122 //===--------------------------------------------------------------------===//
1123 // Attributes used to construct specific Dwarf sections.
1124 //
aslc200b112008-08-16 12:57:46 +00001125
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001126 /// CompileUnits - All the compile units involved in this build. The index
1127 /// of each entry in this vector corresponds to the sources in MMI.
1128 std::vector<CompileUnit *> CompileUnits;
aslc200b112008-08-16 12:57:46 +00001129
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001130 /// AbbreviationsSet - Used to uniquely define abbreviations.
1131 ///
1132 FoldingSet<DIEAbbrev> AbbreviationsSet;
1133
1134 /// Abbreviations - A list of all the unique abbreviations in use.
1135 ///
1136 std::vector<DIEAbbrev *> Abbreviations;
aslc200b112008-08-16 12:57:46 +00001137
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001138 /// ValuesSet - Used to uniquely define values.
1139 ///
1140 FoldingSet<DIEValue> ValuesSet;
aslc200b112008-08-16 12:57:46 +00001141
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001142 /// Values - A list of all the unique values in use.
1143 ///
1144 std::vector<DIEValue *> Values;
aslc200b112008-08-16 12:57:46 +00001145
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001146 /// StringPool - A UniqueVector of strings used by indirect references.
1147 ///
1148 UniqueVector<std::string> StringPool;
1149
1150 /// UnitMap - Map debug information descriptor to compile unit.
1151 ///
1152 std::map<DebugInfoDesc *, CompileUnit *> DescToUnitMap;
aslc200b112008-08-16 12:57:46 +00001153
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001154 /// SectionMap - Provides a unique id per text section.
1155 ///
Anton Korobeynikov55b94962008-09-24 22:15:21 +00001156 UniqueVector<const Section*> SectionMap;
aslc200b112008-08-16 12:57:46 +00001157
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001158 /// SectionSourceLines - Tracks line numbers per text section.
1159 ///
1160 std::vector<std::vector<SourceLineInfo> > SectionSourceLines;
1161
1162 /// didInitial - Flag to indicate if initial emission has been done.
1163 ///
1164 bool didInitial;
aslc200b112008-08-16 12:57:46 +00001165
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001166 /// shouldEmit - Flag to indicate if debug information should be emitted.
1167 ///
1168 bool shouldEmit;
1169
1170 struct FunctionDebugFrameInfo {
1171 unsigned Number;
1172 std::vector<MachineMove> Moves;
1173
1174 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M):
Dan Gohman9ba5d4d2007-08-27 14:50:10 +00001175 Number(Num), Moves(M) { }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001176 };
1177
1178 std::vector<FunctionDebugFrameInfo> DebugFrames;
aslc200b112008-08-16 12:57:46 +00001179
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001180public:
aslc200b112008-08-16 12:57:46 +00001181
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001182 /// ShouldEmitDwarf - Returns true if Dwarf declarations should be made.
1183 ///
1184 bool ShouldEmitDwarf() const { return shouldEmit; }
1185
1186 /// AssignAbbrevNumber - Define a unique number for the abbreviation.
aslc200b112008-08-16 12:57:46 +00001187 ///
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001188 void AssignAbbrevNumber(DIEAbbrev &Abbrev) {
1189 // Profile the node so that we can make it unique.
1190 FoldingSetNodeID ID;
1191 Abbrev.Profile(ID);
aslc200b112008-08-16 12:57:46 +00001192
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001193 // Check the set for priors.
1194 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
aslc200b112008-08-16 12:57:46 +00001195
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001196 // If it's newly added.
1197 if (InSet == &Abbrev) {
aslc200b112008-08-16 12:57:46 +00001198 // Add to abbreviation list.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001199 Abbreviations.push_back(&Abbrev);
1200 // Assign the vector position + 1 as its number.
1201 Abbrev.setNumber(Abbreviations.size());
1202 } else {
1203 // Assign existing abbreviation number.
1204 Abbrev.setNumber(InSet->getNumber());
1205 }
1206 }
1207
1208 /// NewString - Add a string to the constant pool and returns a label.
1209 ///
1210 DWLabel NewString(const std::string &String) {
1211 unsigned StringID = StringPool.insert(String);
1212 return DWLabel("string", StringID);
1213 }
aslc200b112008-08-16 12:57:46 +00001214
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001215 /// NewDIEntry - Creates a new DIEntry to be a proxy for a debug information
1216 /// entry.
1217 DIEntry *NewDIEntry(DIE *Entry = NULL) {
1218 DIEntry *Value;
aslc200b112008-08-16 12:57:46 +00001219
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001220 if (Entry) {
1221 FoldingSetNodeID ID;
1222 DIEntry::Profile(ID, Entry);
1223 void *Where;
1224 Value = static_cast<DIEntry *>(ValuesSet.FindNodeOrInsertPos(ID, Where));
aslc200b112008-08-16 12:57:46 +00001225
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001226 if (Value) return Value;
aslc200b112008-08-16 12:57:46 +00001227
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001228 Value = new DIEntry(Entry);
1229 ValuesSet.InsertNode(Value, Where);
1230 } else {
1231 Value = new DIEntry(Entry);
1232 }
aslc200b112008-08-16 12:57:46 +00001233
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001234 Values.push_back(Value);
1235 return Value;
1236 }
aslc200b112008-08-16 12:57:46 +00001237
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001238 /// SetDIEntry - Set a DIEntry once the debug information entry is defined.
1239 ///
1240 void SetDIEntry(DIEntry *Value, DIE *Entry) {
1241 Value->Entry = Entry;
1242 // Add to values set if not already there. If it is, we merely have a
1243 // duplicate in the values list (no harm.)
1244 ValuesSet.GetOrInsertNode(Value);
1245 }
1246
1247 /// AddUInt - Add an unsigned integer attribute data and value.
1248 ///
1249 void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer) {
1250 if (!Form) Form = DIEInteger::BestForm(false, Integer);
1251
1252 FoldingSetNodeID ID;
1253 DIEInteger::Profile(ID, Integer);
1254 void *Where;
1255 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1256 if (!Value) {
1257 Value = new DIEInteger(Integer);
1258 ValuesSet.InsertNode(Value, Where);
1259 Values.push_back(Value);
1260 }
aslc200b112008-08-16 12:57:46 +00001261
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001262 Die->AddValue(Attribute, Form, Value);
1263 }
aslc200b112008-08-16 12:57:46 +00001264
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001265 /// AddSInt - Add an signed integer attribute data and value.
1266 ///
1267 void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer) {
1268 if (!Form) Form = DIEInteger::BestForm(true, Integer);
1269
1270 FoldingSetNodeID ID;
1271 DIEInteger::Profile(ID, (uint64_t)Integer);
1272 void *Where;
1273 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1274 if (!Value) {
1275 Value = new DIEInteger(Integer);
1276 ValuesSet.InsertNode(Value, Where);
1277 Values.push_back(Value);
1278 }
aslc200b112008-08-16 12:57:46 +00001279
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001280 Die->AddValue(Attribute, Form, Value);
1281 }
aslc200b112008-08-16 12:57:46 +00001282
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001283 /// AddString - Add a std::string attribute data and value.
1284 ///
1285 void AddString(DIE *Die, unsigned Attribute, unsigned Form,
1286 const std::string &String) {
1287 FoldingSetNodeID ID;
1288 DIEString::Profile(ID, String);
1289 void *Where;
1290 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1291 if (!Value) {
1292 Value = new DIEString(String);
1293 ValuesSet.InsertNode(Value, Where);
1294 Values.push_back(Value);
1295 }
aslc200b112008-08-16 12:57:46 +00001296
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001297 Die->AddValue(Attribute, Form, Value);
1298 }
aslc200b112008-08-16 12:57:46 +00001299
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001300 /// AddLabel - Add a Dwarf label attribute data and value.
1301 ///
1302 void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
1303 const DWLabel &Label) {
1304 FoldingSetNodeID ID;
1305 DIEDwarfLabel::Profile(ID, Label);
1306 void *Where;
1307 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1308 if (!Value) {
1309 Value = new DIEDwarfLabel(Label);
1310 ValuesSet.InsertNode(Value, Where);
1311 Values.push_back(Value);
1312 }
aslc200b112008-08-16 12:57:46 +00001313
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001314 Die->AddValue(Attribute, Form, Value);
1315 }
aslc200b112008-08-16 12:57:46 +00001316
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001317 /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
1318 ///
1319 void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
1320 const std::string &Label) {
1321 FoldingSetNodeID ID;
1322 DIEObjectLabel::Profile(ID, Label);
1323 void *Where;
1324 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1325 if (!Value) {
1326 Value = new DIEObjectLabel(Label);
1327 ValuesSet.InsertNode(Value, Where);
1328 Values.push_back(Value);
1329 }
aslc200b112008-08-16 12:57:46 +00001330
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001331 Die->AddValue(Attribute, Form, Value);
1332 }
aslc200b112008-08-16 12:57:46 +00001333
Argiris Kirtzidis03449652008-06-18 19:27:37 +00001334 /// AddSectionOffset - Add a section offset label attribute data and value.
1335 ///
1336 void AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
1337 const DWLabel &Label, const DWLabel &Section,
1338 bool isEH = false, bool useSet = true) {
1339 FoldingSetNodeID ID;
1340 DIESectionOffset::Profile(ID, Label, Section);
1341 void *Where;
1342 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1343 if (!Value) {
1344 Value = new DIESectionOffset(Label, Section, isEH, useSet);
1345 ValuesSet.InsertNode(Value, Where);
1346 Values.push_back(Value);
1347 }
aslc200b112008-08-16 12:57:46 +00001348
Argiris Kirtzidis03449652008-06-18 19:27:37 +00001349 Die->AddValue(Attribute, Form, Value);
1350 }
aslc200b112008-08-16 12:57:46 +00001351
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001352 /// AddDelta - Add a label delta attribute data and value.
1353 ///
1354 void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
1355 const DWLabel &Hi, const DWLabel &Lo) {
1356 FoldingSetNodeID ID;
1357 DIEDelta::Profile(ID, Hi, Lo);
1358 void *Where;
1359 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1360 if (!Value) {
1361 Value = new DIEDelta(Hi, Lo);
1362 ValuesSet.InsertNode(Value, Where);
1363 Values.push_back(Value);
1364 }
aslc200b112008-08-16 12:57:46 +00001365
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001366 Die->AddValue(Attribute, Form, Value);
1367 }
aslc200b112008-08-16 12:57:46 +00001368
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001369 /// AddDIEntry - Add a DIE attribute data and value.
1370 ///
1371 void AddDIEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
1372 Die->AddValue(Attribute, Form, NewDIEntry(Entry));
1373 }
1374
1375 /// AddBlock - Add block data.
1376 ///
1377 void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block) {
1378 Block->ComputeSize(*this);
1379 FoldingSetNodeID ID;
1380 Block->Profile(ID);
1381 void *Where;
1382 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1383 if (!Value) {
1384 Value = Block;
1385 ValuesSet.InsertNode(Value, Where);
1386 Values.push_back(Value);
1387 } else {
Chris Lattner3de66892007-09-21 18:25:53 +00001388 // Already exists, reuse the previous one.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001389 delete Block;
Chris Lattner3de66892007-09-21 18:25:53 +00001390 Block = cast<DIEBlock>(Value);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001391 }
aslc200b112008-08-16 12:57:46 +00001392
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001393 Die->AddValue(Attribute, Block->BestForm(), Value);
1394 }
1395
1396private:
1397
1398 /// AddSourceLine - Add location information to specified debug information
1399 /// entry.
1400 void AddSourceLine(DIE *Die, CompileUnitDesc *File, unsigned Line) {
1401 if (File && Line) {
1402 CompileUnit *FileUnit = FindCompileUnit(File);
1403 unsigned FileID = FileUnit->getID();
1404 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1405 AddUInt(Die, DW_AT_decl_line, 0, Line);
1406 }
1407 }
1408
1409 /// AddAddress - Add an address attribute to a die based on the location
1410 /// provided.
1411 void AddAddress(DIE *Die, unsigned Attribute,
1412 const MachineLocation &Location) {
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001413 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001414 DIEBlock *Block = new DIEBlock();
aslc200b112008-08-16 12:57:46 +00001415
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001416 if (Location.isReg()) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001417 if (Reg < 32) {
1418 AddUInt(Block, 0, DW_FORM_data1, DW_OP_reg0 + Reg);
1419 } else {
1420 AddUInt(Block, 0, DW_FORM_data1, DW_OP_regx);
1421 AddUInt(Block, 0, DW_FORM_udata, Reg);
1422 }
1423 } else {
1424 if (Reg < 32) {
1425 AddUInt(Block, 0, DW_FORM_data1, DW_OP_breg0 + Reg);
1426 } else {
1427 AddUInt(Block, 0, DW_FORM_data1, DW_OP_bregx);
1428 AddUInt(Block, 0, DW_FORM_udata, Reg);
1429 }
1430 AddUInt(Block, 0, DW_FORM_sdata, Location.getOffset());
1431 }
aslc200b112008-08-16 12:57:46 +00001432
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001433 AddBlock(Die, Attribute, 0, Block);
1434 }
aslc200b112008-08-16 12:57:46 +00001435
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001436 /// AddBasicType - Add a new basic type attribute to the specified entity.
1437 ///
1438 void AddBasicType(DIE *Entity, CompileUnit *Unit,
1439 const std::string &Name,
1440 unsigned Encoding, unsigned Size) {
aslc200b112008-08-16 12:57:46 +00001441
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001442 DIE Buffer(DW_TAG_base_type);
1443 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1444 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, Encoding);
1445 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
Devang Patelf49e13d2009-01-05 17:44:11 +00001446 DIE *BasicTypeDie = Unit->AddDie(Buffer);
1447 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, BasicTypeDie);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001448 }
aslc200b112008-08-16 12:57:46 +00001449
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001450 /// AddPointerType - Add a new pointer type attribute to the specified entity.
1451 ///
1452 void AddPointerType(DIE *Entity, CompileUnit *Unit, const std::string &Name) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001453 DIE Buffer(DW_TAG_pointer_type);
Dan Gohmancfb72b22007-09-27 23:12:31 +00001454 AddUInt(&Buffer, DW_AT_byte_size, 0, TD->getPointerSize());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001455 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
Devang Patelbbca50b2009-01-05 17:45:59 +00001456 DIE *PointerTypeDie = Unit->AddDie(Buffer);
1457 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, PointerTypeDie);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001458 }
aslc200b112008-08-16 12:57:46 +00001459
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001460 /// AddType - Add a new type attribute to the specified entity.
1461 ///
1462 void AddType(DIE *Entity, TypeDesc *TyDesc, CompileUnit *Unit) {
1463 if (!TyDesc) {
1464 AddBasicType(Entity, Unit, "", DW_ATE_signed, sizeof(int32_t));
1465 } else {
1466 // Check for pre-existence.
1467 DIEntry *&Slot = Unit->getDIEntrySlotFor(TyDesc);
aslc200b112008-08-16 12:57:46 +00001468
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001469 // If it exists then use the existing value.
1470 if (Slot) {
1471 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1472 return;
1473 }
aslc200b112008-08-16 12:57:46 +00001474
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001475 if (SubprogramDesc *SubprogramTy = dyn_cast<SubprogramDesc>(TyDesc)) {
1476 // FIXME - Not sure why programs and variables are coming through here.
1477 // Short cut for handling subprogram types (not really a TyDesc.)
1478 AddPointerType(Entity, Unit, SubprogramTy->getName());
1479 } else if (GlobalVariableDesc *GlobalTy =
1480 dyn_cast<GlobalVariableDesc>(TyDesc)) {
1481 // FIXME - Not sure why programs and variables are coming through here.
1482 // Short cut for handling global variable types (not really a TyDesc.)
1483 AddPointerType(Entity, Unit, GlobalTy->getName());
aslc200b112008-08-16 12:57:46 +00001484 } else {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001485 // Set up proxy.
1486 Slot = NewDIEntry();
aslc200b112008-08-16 12:57:46 +00001487
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001488 // Construct type.
1489 DIE Buffer(DW_TAG_base_type);
1490 ConstructType(Buffer, TyDesc, Unit);
aslc200b112008-08-16 12:57:46 +00001491
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001492 // Add debug information entry to entity and unit.
1493 DIE *Die = Unit->AddDie(Buffer);
1494 SetDIEntry(Slot, Die);
1495 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1496 }
1497 }
1498 }
aslc200b112008-08-16 12:57:46 +00001499
Devang Patel46d13752009-01-05 19:07:53 +00001500 /// ConstructTypeDIE - Construct basic type die from DIBasicType.
1501 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1502 DIBasicType *BTy) {
Devang Patelfc187162009-01-05 17:57:47 +00001503
1504 // Get core information.
1505 const std::string &Name = BTy->getName();
1506 Buffer.setTag(DW_TAG_base_type);
1507 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, BTy->getEncoding());
1508 // Add name if not anonymous or intermediate type.
1509 if (!Name.empty())
1510 AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1511 uint64_t Size = BTy->getSizeInBits() >> 3;
1512 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1513 }
1514
Devang Patel46d13752009-01-05 19:07:53 +00001515 /// ConstructTypeDIE - Construct derived type die from DIDerivedType.
1516 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1517 DIDerivedType *DTy) {
Devang Patelfc187162009-01-05 17:57:47 +00001518
1519 // Get core information.
1520 const std::string &Name = DTy->getName();
1521 uint64_t Size = DTy->getSizeInBits() >> 3;
1522 unsigned Tag = DTy->getTag();
1523 // FIXME - Workaround for templates.
1524 if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
1525
1526 Buffer.setTag(Tag);
1527 // Map to main type, void will not have a type.
1528 DIType FromTy = DTy->getTypeDerivedFrom();
1529 // FIXME - Enable this. AddType(&Buffer, FromTy, DW_Unit);
1530
1531 // Add name if not anonymous or intermediate type.
1532 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1533
1534 // Add size if non-zero (derived types might be zero-sized.)
1535 if (Size)
1536 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1537
1538 // Add source line info if available and TyDesc is not a forward
1539 // declaration.
1540 // FIXME - Enable this. if (!DTy->isForwardDecl())
1541 // FIXME - Enable this. AddSourceLine(&Buffer, *DTy);
1542 }
1543
Devang Patel6fb54132009-01-05 18:33:01 +00001544 // ConstructSubrangeDIE - Construct subrange DIE from DISubrange.
1545 void ConstructSubrangeDIE (DIE &Buffer, DISubrange *SR, DIE *IndexTy) {
1546 int64_t L = SR->getLo();
1547 int64_t H = SR->getHi();
1548 DIE *DW_Subrange = new DIE(DW_TAG_subrange_type);
1549 if (L != H) {
1550 AddDIEntry(DW_Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1551 if (L)
1552 AddSInt(DW_Subrange, DW_AT_lower_bound, 0, L);
1553 AddSInt(DW_Subrange, DW_AT_upper_bound, 0, H);
1554 }
1555 Buffer.AddChild(DW_Subrange);
1556 }
1557
1558 /// ConstructArrayTypeDIE - Construct array type DIE from DICompositeType.
1559 void ConstructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1560 DICompositeType *CTy) {
1561 Buffer.setTag(DW_TAG_array_type);
1562 if (CTy->getTag() == DW_TAG_vector_type)
1563 AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1564
1565 DIArray Elements = CTy->getTypeArray();
1566 // FIXME - Enable this.
1567 // AddType(&Buffer, CTy->getTypeDerivedFrom(), DW_Unit);
1568
1569 // Construct an anonymous type for index type.
1570 DIE IdxBuffer(DW_TAG_base_type);
1571 AddUInt(&IdxBuffer, DW_AT_byte_size, 0, sizeof(int32_t));
1572 AddUInt(&IdxBuffer, DW_AT_encoding, DW_FORM_data1, DW_ATE_signed);
1573 DIE *IndexTy = DW_Unit->AddDie(IdxBuffer);
1574
1575 // Add subranges to array type.
1576 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1577 DISubrange Element = Elements.getElement(i);
1578 ConstructSubrangeDIE(Buffer, &Element, IndexTy);
1579 }
1580 }
1581
Devang Patela566e812009-01-05 18:38:38 +00001582 /// ConstructEnumTypeDIE - Construct enum type DIE from
1583 /// DIEnumerator.
1584 void ConstructEnumType(CompileUnit *DW_Unit,
1585 DIE &Buffer, DIEnumerator *ETy) {
1586
1587 DIE *Enumerator = new DIE(DW_TAG_enumerator);
1588 AddString(Enumerator, DW_AT_name, DW_FORM_string, ETy->getName());
1589 int64_t Value = ETy->getEnumValue();
1590 AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
1591 Buffer.AddChild(Enumerator);
1592 }
Devang Patel6fb54132009-01-05 18:33:01 +00001593
Devang Patel526b01d2009-01-05 18:59:44 +00001594 /// ConstructFieldTypeDIE - Construct variable DIE for a struct field.
1595 void ConstructFieldTypeDIE(CompileUnit *DW_Unit,
1596 DIE &Buffer, DIGlobalVariable *V) {
1597
1598 DIE *VariableDie = new DIE(DW_TAG_variable);
1599 const std::string &LinkageName = V->getLinkageName();
1600 if (!LinkageName.empty())
1601 AddString(VariableDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
1602 LinkageName);
1603 // FIXME - Enable this. AddSourceLine(VariableDie, V);
1604 // FIXME - Enable this. AddType(VariableDie, V->getType(), DW_Unit);
1605 if (!V->isLocalToUnit())
1606 AddUInt(VariableDie, DW_AT_external, DW_FORM_flag, 1);
1607 AddUInt(VariableDie, DW_AT_declaration, DW_FORM_flag, 1);
1608 Buffer.AddChild(VariableDie);
1609 }
1610
1611 /// ConstructFieldTypeDIE - Construct subprogram DIE for a struct field.
1612 void ConstructFieldTypeDIE(CompileUnit *DW_Unit,
1613 DIE &Buffer, DISubprogram *SP,
1614 bool IsConstructor = false) {
1615 DIE *Method = new DIE(DW_TAG_subprogram);
1616 AddString(Method, DW_AT_name, DW_FORM_string, SP->getName());
1617 const std::string &LinkageName = SP->getLinkageName();
1618 if (!LinkageName.empty())
1619 AddString(Method, DW_AT_MIPS_linkage_name, DW_FORM_string, LinkageName);
1620 // FIXME - Enable this. AddSourceLine(Method, SP);
1621
1622 DICompositeType MTy = SP->getType();
1623 DIArray Args = MTy.getTypeArray();
1624
1625 // Add Return Type.
1626 // FIXME - Enable this. if (!IsConstructor)
1627 // Fixme - Enable this. AddType(Method, Args.getElement(0), DW_Unit);
1628
1629 // Add arguments.
1630 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1631 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1632 // FIXME - Enable this. AddType(Arg, Args.getElement(i), DW_Unit);
1633 AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1); // ???
1634 Method->AddChild(Arg);
1635 }
1636
1637 if (!SP->isLocalToUnit())
1638 AddUInt(Method, DW_AT_external, DW_FORM_flag, 1);
1639 Buffer.AddChild(Method);
1640 }
1641
1642 /// COnstructFieldTypeDIE - Construct derived type DIE for a struct field.
1643 void ConstructFieldTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1644 DIDerivedType *DTy) {
1645 unsigned Tag = DTy->getTag();
1646 DIE *MemberDie = new DIE(Tag);
1647 if (!DTy->getName().empty())
1648 AddString(MemberDie, DW_AT_name, DW_FORM_string, DTy->getName());
1649 // FIXME - Enable this. AddSourceLine(MemberDie, DTy);
1650
1651 DIType FromTy = DTy->getTypeDerivedFrom();
1652 // FIXME - Enable this. AddType(MemberDie, FromTy, DW_Unit);
1653
1654 uint64_t Size = DTy->getSizeInBits();
1655 uint64_t Offset = DTy->getOffsetInBits();
1656
1657 // FIXME Handle bitfields
1658
1659 // Add size.
1660 AddUInt(MemberDie, DW_AT_bit_size, 0, Size);
1661 // Add computation for offset.
1662 DIEBlock *Block = new DIEBlock();
1663 AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
1664 AddUInt(Block, 0, DW_FORM_udata, Offset >> 3);
1665 AddBlock(MemberDie, DW_AT_data_member_location, 0, Block);
1666
1667 // FIXME Handle DW_AT_accessibility.
1668
1669 Buffer.AddChild(MemberDie);
1670 }
1671
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001672 /// ConstructType - Adds all the required attributes to the type.
1673 ///
1674 void ConstructType(DIE &Buffer, TypeDesc *TyDesc, CompileUnit *Unit) {
1675 // Get core information.
1676 const std::string &Name = TyDesc->getName();
1677 uint64_t Size = TyDesc->getSize() >> 3;
aslc200b112008-08-16 12:57:46 +00001678
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001679 if (BasicTypeDesc *BasicTy = dyn_cast<BasicTypeDesc>(TyDesc)) {
1680 // Fundamental types like int, float, bool
1681 Buffer.setTag(DW_TAG_base_type);
1682 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, BasicTy->getEncoding());
1683 } else if (DerivedTypeDesc *DerivedTy = dyn_cast<DerivedTypeDesc>(TyDesc)) {
1684 // Fetch tag.
1685 unsigned Tag = DerivedTy->getTag();
1686 // FIXME - Workaround for templates.
1687 if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
aslc200b112008-08-16 12:57:46 +00001688 // Pointers, typedefs et al.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001689 Buffer.setTag(Tag);
1690 // Map to main type, void will not have a type.
1691 if (TypeDesc *FromTy = DerivedTy->getFromType())
1692 AddType(&Buffer, FromTy, Unit);
1693 } else if (CompositeTypeDesc *CompTy = dyn_cast<CompositeTypeDesc>(TyDesc)){
1694 // Fetch tag.
1695 unsigned Tag = CompTy->getTag();
aslc200b112008-08-16 12:57:46 +00001696
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001697 // Set tag accordingly.
1698 if (Tag == DW_TAG_vector_type)
1699 Buffer.setTag(DW_TAG_array_type);
aslc200b112008-08-16 12:57:46 +00001700 else
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001701 Buffer.setTag(Tag);
1702
1703 std::vector<DebugInfoDesc *> &Elements = CompTy->getElements();
aslc200b112008-08-16 12:57:46 +00001704
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001705 switch (Tag) {
1706 case DW_TAG_vector_type:
1707 AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1708 // Fall thru
1709 case DW_TAG_array_type: {
1710 // Add element type.
1711 if (TypeDesc *FromTy = CompTy->getFromType())
1712 AddType(&Buffer, FromTy, Unit);
aslc200b112008-08-16 12:57:46 +00001713
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001714 // Don't emit size attribute.
1715 Size = 0;
aslc200b112008-08-16 12:57:46 +00001716
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001717 // Construct an anonymous type for index type.
Devang Patelf49e13d2009-01-05 17:44:11 +00001718 DIE Buffer(DW_TAG_base_type);
1719 AddUInt(&Buffer, DW_AT_byte_size, 0, sizeof(int32_t));
1720 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, DW_ATE_signed);
1721 DIE *IndexTy = Unit->AddDie(Buffer);
aslc200b112008-08-16 12:57:46 +00001722
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001723 // Add subranges to array type.
Evan Chengc7efea32008-12-09 17:56:30 +00001724 for (unsigned i = 0, N = Elements.size(); i < N; ++i) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001725 SubrangeDesc *SRD = cast<SubrangeDesc>(Elements[i]);
1726 int64_t Lo = SRD->getLo();
1727 int64_t Hi = SRD->getHi();
1728 DIE *Subrange = new DIE(DW_TAG_subrange_type);
aslc200b112008-08-16 12:57:46 +00001729
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001730 // If a range is available.
1731 if (Lo != Hi) {
1732 AddDIEntry(Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1733 // Only add low if non-zero.
1734 if (Lo) AddSInt(Subrange, DW_AT_lower_bound, 0, Lo);
1735 AddSInt(Subrange, DW_AT_upper_bound, 0, Hi);
1736 }
aslc200b112008-08-16 12:57:46 +00001737
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001738 Buffer.AddChild(Subrange);
1739 }
1740 break;
1741 }
1742 case DW_TAG_structure_type:
1743 case DW_TAG_union_type: {
1744 // Add elements to structure type.
Evan Chengc7efea32008-12-09 17:56:30 +00001745 for (unsigned i = 0, N = Elements.size(); i < N; ++i) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001746 DebugInfoDesc *Element = Elements[i];
aslc200b112008-08-16 12:57:46 +00001747
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001748 if (DerivedTypeDesc *MemberDesc = dyn_cast<DerivedTypeDesc>(Element)){
1749 // Add field or base class.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001750 unsigned Tag = MemberDesc->getTag();
aslc200b112008-08-16 12:57:46 +00001751
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001752 // Extract the basic information.
1753 const std::string &Name = MemberDesc->getName();
1754 uint64_t Size = MemberDesc->getSize();
1755 uint64_t Align = MemberDesc->getAlign();
1756 uint64_t Offset = MemberDesc->getOffset();
aslc200b112008-08-16 12:57:46 +00001757
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001758 // Construct member debug information entry.
1759 DIE *Member = new DIE(Tag);
aslc200b112008-08-16 12:57:46 +00001760
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001761 // Add name if not "".
1762 if (!Name.empty())
1763 AddString(Member, DW_AT_name, DW_FORM_string, Name);
Evan Chengc7efea32008-12-09 17:56:30 +00001764
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001765 // Add location if available.
1766 AddSourceLine(Member, MemberDesc->getFile(), MemberDesc->getLine());
aslc200b112008-08-16 12:57:46 +00001767
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001768 // Most of the time the field info is the same as the members.
1769 uint64_t FieldSize = Size;
1770 uint64_t FieldAlign = Align;
1771 uint64_t FieldOffset = Offset;
aslc200b112008-08-16 12:57:46 +00001772
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001773 // Set the member type.
1774 TypeDesc *FromTy = MemberDesc->getFromType();
1775 AddType(Member, FromTy, Unit);
aslc200b112008-08-16 12:57:46 +00001776
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001777 // Walk up typedefs until a real size is found.
1778 while (FromTy) {
1779 if (FromTy->getTag() != DW_TAG_typedef) {
1780 FieldSize = FromTy->getSize();
Devang Patel105a08a2008-12-23 21:55:38 +00001781 FieldAlign = FromTy->getAlign();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001782 break;
1783 }
aslc200b112008-08-16 12:57:46 +00001784
Dan Gohman53491e92007-07-23 20:24:29 +00001785 FromTy = cast<DerivedTypeDesc>(FromTy)->getFromType();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001786 }
aslc200b112008-08-16 12:57:46 +00001787
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001788 // Unless we have a bit field.
1789 if (Tag == DW_TAG_member && FieldSize != Size) {
1790 // Construct the alignment mask.
1791 uint64_t AlignMask = ~(FieldAlign - 1);
1792 // Determine the high bit + 1 of the declared size.
1793 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1794 // Work backwards to determine the base offset of the field.
1795 FieldOffset = HiMark - FieldSize;
1796 // Now normalize offset to the field.
1797 Offset -= FieldOffset;
aslc200b112008-08-16 12:57:46 +00001798
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001799 // Maybe we need to work from the other end.
1800 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
aslc200b112008-08-16 12:57:46 +00001801
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001802 // Add size and offset.
1803 AddUInt(Member, DW_AT_byte_size, 0, FieldSize >> 3);
1804 AddUInt(Member, DW_AT_bit_size, 0, Size);
1805 AddUInt(Member, DW_AT_bit_offset, 0, Offset);
1806 }
aslc200b112008-08-16 12:57:46 +00001807
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001808 // Add computation for offset.
1809 DIEBlock *Block = new DIEBlock();
1810 AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
1811 AddUInt(Block, 0, DW_FORM_udata, FieldOffset >> 3);
1812 AddBlock(Member, DW_AT_data_member_location, 0, Block);
1813
1814 // Add accessibility (public default unless is base class.
1815 if (MemberDesc->isProtected()) {
1816 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_protected);
1817 } else if (MemberDesc->isPrivate()) {
1818 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_private);
1819 } else if (Tag == DW_TAG_inheritance) {
1820 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_public);
1821 }
aslc200b112008-08-16 12:57:46 +00001822
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001823 Buffer.AddChild(Member);
1824 } else if (GlobalVariableDesc *StaticDesc =
1825 dyn_cast<GlobalVariableDesc>(Element)) {
1826 // Add static member.
aslc200b112008-08-16 12:57:46 +00001827
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001828 // Construct member debug information entry.
1829 DIE *Static = new DIE(DW_TAG_variable);
aslc200b112008-08-16 12:57:46 +00001830
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001831 // Add name and mangled name.
1832 const std::string &Name = StaticDesc->getName();
1833 const std::string &LinkageName = StaticDesc->getLinkageName();
1834 AddString(Static, DW_AT_name, DW_FORM_string, Name);
1835 if (!LinkageName.empty()) {
1836 AddString(Static, DW_AT_MIPS_linkage_name, DW_FORM_string,
1837 LinkageName);
1838 }
aslc200b112008-08-16 12:57:46 +00001839
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001840 // Add location.
1841 AddSourceLine(Static, StaticDesc->getFile(), StaticDesc->getLine());
aslc200b112008-08-16 12:57:46 +00001842
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001843 // Add type.
1844 if (TypeDesc *StaticTy = StaticDesc->getType())
1845 AddType(Static, StaticTy, Unit);
aslc200b112008-08-16 12:57:46 +00001846
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001847 // Add flags.
1848 if (!StaticDesc->isStatic())
1849 AddUInt(Static, DW_AT_external, DW_FORM_flag, 1);
1850 AddUInt(Static, DW_AT_declaration, DW_FORM_flag, 1);
aslc200b112008-08-16 12:57:46 +00001851
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001852 Buffer.AddChild(Static);
1853 } else if (SubprogramDesc *MethodDesc =
1854 dyn_cast<SubprogramDesc>(Element)) {
1855 // Add member function.
aslc200b112008-08-16 12:57:46 +00001856
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001857 // Construct member debug information entry.
1858 DIE *Method = new DIE(DW_TAG_subprogram);
aslc200b112008-08-16 12:57:46 +00001859
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001860 // Add name and mangled name.
1861 const std::string &Name = MethodDesc->getName();
1862 const std::string &LinkageName = MethodDesc->getLinkageName();
aslc200b112008-08-16 12:57:46 +00001863
1864 AddString(Method, DW_AT_name, DW_FORM_string, Name);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001865 bool IsCTor = TyDesc->getName() == Name;
aslc200b112008-08-16 12:57:46 +00001866
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001867 if (!LinkageName.empty()) {
1868 AddString(Method, DW_AT_MIPS_linkage_name, DW_FORM_string,
1869 LinkageName);
1870 }
aslc200b112008-08-16 12:57:46 +00001871
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001872 // Add location.
1873 AddSourceLine(Method, MethodDesc->getFile(), MethodDesc->getLine());
aslc200b112008-08-16 12:57:46 +00001874
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001875 // Add type.
1876 if (CompositeTypeDesc *MethodTy =
1877 dyn_cast_or_null<CompositeTypeDesc>(MethodDesc->getType())) {
1878 // Get argument information.
1879 std::vector<DebugInfoDesc *> &Args = MethodTy->getElements();
aslc200b112008-08-16 12:57:46 +00001880
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001881 // If not a ctor.
1882 if (!IsCTor) {
1883 // Add return type.
1884 AddType(Method, dyn_cast<TypeDesc>(Args[0]), Unit);
1885 }
aslc200b112008-08-16 12:57:46 +00001886
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001887 // Add arguments.
Evan Chengc7efea32008-12-09 17:56:30 +00001888 for (unsigned i = 1, N = Args.size(); i < N; ++i) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001889 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1890 AddType(Arg, cast<TypeDesc>(Args[i]), Unit);
1891 AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1);
1892 Method->AddChild(Arg);
1893 }
1894 }
1895
1896 // Add flags.
1897 if (!MethodDesc->isStatic())
1898 AddUInt(Method, DW_AT_external, DW_FORM_flag, 1);
1899 AddUInt(Method, DW_AT_declaration, DW_FORM_flag, 1);
aslc200b112008-08-16 12:57:46 +00001900
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001901 Buffer.AddChild(Method);
1902 }
1903 }
1904 break;
1905 }
1906 case DW_TAG_enumeration_type: {
1907 // Add enumerators to enumeration type.
Evan Chengc7efea32008-12-09 17:56:30 +00001908 for (unsigned i = 0, N = Elements.size(); i < N; ++i) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001909 EnumeratorDesc *ED = cast<EnumeratorDesc>(Elements[i]);
1910 const std::string &Name = ED->getName();
1911 int64_t Value = ED->getValue();
1912 DIE *Enumerator = new DIE(DW_TAG_enumerator);
1913 AddString(Enumerator, DW_AT_name, DW_FORM_string, Name);
1914 AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
1915 Buffer.AddChild(Enumerator);
1916 }
1917
1918 break;
1919 }
1920 case DW_TAG_subroutine_type: {
1921 // Add prototype flag.
1922 AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
1923 // Add return type.
1924 AddType(&Buffer, dyn_cast<TypeDesc>(Elements[0]), Unit);
aslc200b112008-08-16 12:57:46 +00001925
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001926 // Add arguments.
Evan Chengc7efea32008-12-09 17:56:30 +00001927 for (unsigned i = 1, N = Elements.size(); i < N; ++i) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001928 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1929 AddType(Arg, cast<TypeDesc>(Elements[i]), Unit);
1930 Buffer.AddChild(Arg);
1931 }
aslc200b112008-08-16 12:57:46 +00001932
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001933 break;
1934 }
1935 default: break;
1936 }
1937 }
aslc200b112008-08-16 12:57:46 +00001938
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001939 // Add name if not anonymous or intermediate type.
1940 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
Evan Chengc7efea32008-12-09 17:56:30 +00001941
Evan Chengb2fc7112008-12-10 00:15:44 +00001942 // Add size if non-zero (derived types might be zero-sized.)
1943 if (Size)
1944 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1945 else if (isa<CompositeTypeDesc>(TyDesc)) {
1946 // If TyDesc is a composite type, then add size even if it's zero unless
1947 // it's a forward declaration.
1948 if (TyDesc->isForwardDecl())
1949 AddUInt(&Buffer, DW_AT_declaration, DW_FORM_flag, 1);
1950 else
1951 AddUInt(&Buffer, DW_AT_byte_size, 0, 0);
1952 }
1953
1954 // Add source line info if available and TyDesc is not a forward
1955 // declaration.
1956 if (!TyDesc->isForwardDecl())
1957 AddSourceLine(&Buffer, TyDesc->getFile(), TyDesc->getLine());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001958 }
1959
1960 /// NewCompileUnit - Create new compile unit and it's debug information entry.
1961 ///
1962 CompileUnit *NewCompileUnit(CompileUnitDesc *UnitDesc, unsigned ID) {
1963 // Construct debug information entry.
1964 DIE *Die = new DIE(DW_TAG_compile_unit);
Argiris Kirtzidis03449652008-06-18 19:27:37 +00001965 AddSectionOffset(Die, DW_AT_stmt_list, DW_FORM_data4,
1966 DWLabel("section_line", 0), DWLabel("section_line", 0), false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001967 AddString(Die, DW_AT_producer, DW_FORM_string, UnitDesc->getProducer());
1968 AddUInt (Die, DW_AT_language, DW_FORM_data1, UnitDesc->getLanguage());
1969 AddString(Die, DW_AT_name, DW_FORM_string, UnitDesc->getFileName());
Devang Patel6bcf9822008-12-12 21:57:54 +00001970 if (!UnitDesc->getDirectory().empty())
1971 AddString(Die, DW_AT_comp_dir, DW_FORM_string, UnitDesc->getDirectory());
aslc200b112008-08-16 12:57:46 +00001972
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001973 // Construct compile unit.
1974 CompileUnit *Unit = new CompileUnit(UnitDesc, ID, Die);
aslc200b112008-08-16 12:57:46 +00001975
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001976 // Add Unit to compile unit map.
1977 DescToUnitMap[UnitDesc] = Unit;
aslc200b112008-08-16 12:57:46 +00001978
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001979 return Unit;
1980 }
1981
1982 /// GetBaseCompileUnit - Get the main compile unit.
1983 ///
1984 CompileUnit *GetBaseCompileUnit() const {
1985 CompileUnit *Unit = CompileUnits[0];
1986 assert(Unit && "Missing compile unit.");
1987 return Unit;
1988 }
1989
1990 /// FindCompileUnit - Get the compile unit for the given descriptor.
1991 ///
1992 CompileUnit *FindCompileUnit(CompileUnitDesc *UnitDesc) {
1993 CompileUnit *Unit = DescToUnitMap[UnitDesc];
1994 assert(Unit && "Missing compile unit.");
1995 return Unit;
1996 }
1997
1998 /// NewGlobalVariable - Add a new global variable DIE.
1999 ///
2000 DIE *NewGlobalVariable(GlobalVariableDesc *GVD) {
2001 // Get the compile unit context.
2002 CompileUnitDesc *UnitDesc =
2003 static_cast<CompileUnitDesc *>(GVD->getContext());
2004 CompileUnit *Unit = GetBaseCompileUnit();
2005
2006 // Check for pre-existence.
2007 DIE *&Slot = Unit->getDieMapSlotFor(GVD);
2008 if (Slot) return Slot;
aslc200b112008-08-16 12:57:46 +00002009
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002010 // Get the global variable itself.
2011 GlobalVariable *GV = GVD->getGlobalVariable();
2012
2013 const std::string &Name = GVD->getName();
2014 const std::string &FullName = GVD->getFullName();
2015 const std::string &LinkageName = GVD->getLinkageName();
2016 // Create the global's variable DIE.
2017 DIE *VariableDie = new DIE(DW_TAG_variable);
2018 AddString(VariableDie, DW_AT_name, DW_FORM_string, Name);
2019 if (!LinkageName.empty()) {
2020 AddString(VariableDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
2021 LinkageName);
2022 }
2023 AddType(VariableDie, GVD->getType(), Unit);
2024 if (!GVD->isStatic())
2025 AddUInt(VariableDie, DW_AT_external, DW_FORM_flag, 1);
aslc200b112008-08-16 12:57:46 +00002026
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002027 // Add source line info if available.
2028 AddSourceLine(VariableDie, UnitDesc, GVD->getLine());
aslc200b112008-08-16 12:57:46 +00002029
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002030 // Add address.
2031 DIEBlock *Block = new DIEBlock();
2032 AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
2033 AddObjectLabel(Block, 0, DW_FORM_udata, Asm->getGlobalLinkName(GV));
2034 AddBlock(VariableDie, DW_AT_location, 0, Block);
aslc200b112008-08-16 12:57:46 +00002035
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002036 // Add to map.
2037 Slot = VariableDie;
aslc200b112008-08-16 12:57:46 +00002038
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002039 // Add to context owner.
2040 Unit->getDie()->AddChild(VariableDie);
aslc200b112008-08-16 12:57:46 +00002041
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002042 // Expose as global.
2043 // FIXME - need to check external flag.
2044 Unit->AddGlobal(FullName, VariableDie);
aslc200b112008-08-16 12:57:46 +00002045
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002046 return VariableDie;
2047 }
2048
2049 /// NewSubprogram - Add a new subprogram DIE.
2050 ///
2051 DIE *NewSubprogram(SubprogramDesc *SPD) {
2052 // Get the compile unit context.
2053 CompileUnitDesc *UnitDesc =
2054 static_cast<CompileUnitDesc *>(SPD->getContext());
2055 CompileUnit *Unit = GetBaseCompileUnit();
2056
2057 // Check for pre-existence.
2058 DIE *&Slot = Unit->getDieMapSlotFor(SPD);
2059 if (Slot) return Slot;
aslc200b112008-08-16 12:57:46 +00002060
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002061 // Gather the details (simplify add attribute code.)
2062 const std::string &Name = SPD->getName();
2063 const std::string &FullName = SPD->getFullName();
2064 const std::string &LinkageName = SPD->getLinkageName();
aslc200b112008-08-16 12:57:46 +00002065
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002066 DIE *SubprogramDie = new DIE(DW_TAG_subprogram);
2067 AddString(SubprogramDie, DW_AT_name, DW_FORM_string, Name);
2068 if (!LinkageName.empty()) {
2069 AddString(SubprogramDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
2070 LinkageName);
2071 }
2072 if (SPD->getType()) AddType(SubprogramDie, SPD->getType(), Unit);
2073 if (!SPD->isStatic())
2074 AddUInt(SubprogramDie, DW_AT_external, DW_FORM_flag, 1);
2075 AddUInt(SubprogramDie, DW_AT_prototyped, DW_FORM_flag, 1);
aslc200b112008-08-16 12:57:46 +00002076
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002077 // Add source line info if available.
2078 AddSourceLine(SubprogramDie, UnitDesc, SPD->getLine());
2079
2080 // Add to map.
2081 Slot = SubprogramDie;
aslc200b112008-08-16 12:57:46 +00002082
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002083 // Add to context owner.
2084 Unit->getDie()->AddChild(SubprogramDie);
aslc200b112008-08-16 12:57:46 +00002085
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002086 // Expose as global.
2087 Unit->AddGlobal(FullName, SubprogramDie);
aslc200b112008-08-16 12:57:46 +00002088
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002089 return SubprogramDie;
2090 }
2091
2092 /// NewScopeVariable - Create a new scope variable.
2093 ///
2094 DIE *NewScopeVariable(DebugVariable *DV, CompileUnit *Unit) {
2095 // Get the descriptor.
2096 VariableDesc *VD = DV->getDesc();
2097
2098 // Translate tag to proper Dwarf tag. The result variable is dropped for
2099 // now.
2100 unsigned Tag;
2101 switch (VD->getTag()) {
2102 case DW_TAG_return_variable: return NULL;
2103 case DW_TAG_arg_variable: Tag = DW_TAG_formal_parameter; break;
2104 case DW_TAG_auto_variable: // fall thru
2105 default: Tag = DW_TAG_variable; break;
2106 }
2107
2108 // Define variable debug information entry.
2109 DIE *VariableDie = new DIE(Tag);
2110 AddString(VariableDie, DW_AT_name, DW_FORM_string, VD->getName());
2111
2112 // Add source line info if available.
2113 AddSourceLine(VariableDie, VD->getFile(), VD->getLine());
aslc200b112008-08-16 12:57:46 +00002114
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002115 // Add variable type.
aslc200b112008-08-16 12:57:46 +00002116 AddType(VariableDie, VD->getType(), Unit);
2117
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002118 // Add variable address.
2119 MachineLocation Location;
Evan Cheng38948832008-01-31 03:37:28 +00002120 Location.set(RI->getFrameRegister(*MF),
2121 RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002122 AddAddress(VariableDie, DW_AT_location, Location);
2123
2124 return VariableDie;
2125 }
2126
2127 /// ConstructScope - Construct the components of a scope.
2128 ///
2129 void ConstructScope(DebugScope *ParentScope,
2130 unsigned ParentStartID, unsigned ParentEndID,
2131 DIE *ParentDie, CompileUnit *Unit) {
2132 // Add variables to scope.
2133 std::vector<DebugVariable *> &Variables = ParentScope->getVariables();
2134 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2135 DIE *VariableDie = NewScopeVariable(Variables[i], Unit);
2136 if (VariableDie) ParentDie->AddChild(VariableDie);
2137 }
aslc200b112008-08-16 12:57:46 +00002138
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002139 // Add nested scopes.
2140 std::vector<DebugScope *> &Scopes = ParentScope->getScopes();
2141 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
2142 // Define the Scope debug information entry.
2143 DebugScope *Scope = Scopes[j];
2144 // FIXME - Ignore inlined functions for the time being.
2145 if (!Scope->getParent()) continue;
aslc200b112008-08-16 12:57:46 +00002146
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002147 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
2148 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
2149
2150 // Ignore empty scopes.
2151 if (StartID == EndID && StartID != 0) continue;
2152 if (Scope->getScopes().empty() && Scope->getVariables().empty()) continue;
aslc200b112008-08-16 12:57:46 +00002153
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002154 if (StartID == ParentStartID && EndID == ParentEndID) {
2155 // Just add stuff to the parent scope.
2156 ConstructScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
2157 } else {
2158 DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
aslc200b112008-08-16 12:57:46 +00002159
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002160 // Add the scope bounds.
2161 if (StartID) {
2162 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2163 DWLabel("label", StartID));
2164 } else {
2165 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2166 DWLabel("func_begin", SubprogramCount));
2167 }
2168 if (EndID) {
2169 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2170 DWLabel("label", EndID));
2171 } else {
2172 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2173 DWLabel("func_end", SubprogramCount));
2174 }
aslc200b112008-08-16 12:57:46 +00002175
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002176 // Add the scope contents.
2177 ConstructScope(Scope, StartID, EndID, ScopeDie, Unit);
2178 ParentDie->AddChild(ScopeDie);
2179 }
2180 }
2181 }
2182
2183 /// ConstructRootScope - Construct the scope for the subprogram.
2184 ///
2185 void ConstructRootScope(DebugScope *RootScope) {
2186 // Exit if there is no root scope.
2187 if (!RootScope) return;
aslc200b112008-08-16 12:57:46 +00002188
2189 // Get the subprogram debug information entry.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002190 SubprogramDesc *SPD = cast<SubprogramDesc>(RootScope->getDesc());
aslc200b112008-08-16 12:57:46 +00002191
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002192 // Get the compile unit context.
2193 CompileUnit *Unit = GetBaseCompileUnit();
aslc200b112008-08-16 12:57:46 +00002194
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002195 // Get the subprogram die.
2196 DIE *SPDie = Unit->getDieMapSlotFor(SPD);
2197 assert(SPDie && "Missing subprogram descriptor");
aslc200b112008-08-16 12:57:46 +00002198
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002199 // Add the function bounds.
2200 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2201 DWLabel("func_begin", SubprogramCount));
2202 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2203 DWLabel("func_end", SubprogramCount));
2204 MachineLocation Location(RI->getFrameRegister(*MF));
2205 AddAddress(SPDie, DW_AT_frame_base, Location);
2206
2207 ConstructScope(RootScope, 0, 0, SPDie, Unit);
2208 }
2209
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00002210 /// ConstructDefaultScope - Construct a default scope for the subprogram.
2211 ///
2212 void ConstructDefaultScope(MachineFunction *MF) {
2213 // Find the correct subprogram descriptor.
2214 std::vector<SubprogramDesc *> Subprograms;
2215 MMI->getAnchoredDescriptors<SubprogramDesc>(*M, Subprograms);
2216
2217 for (unsigned i = 0, N = Subprograms.size(); i < N; ++i) {
2218 SubprogramDesc *SPD = Subprograms[i];
2219
2220 if (SPD->getName() == MF->getFunction()->getName()) {
2221 // Get the compile unit context.
2222 CompileUnit *Unit = GetBaseCompileUnit();
2223
2224 // Get the subprogram die.
2225 DIE *SPDie = Unit->getDieMapSlotFor(SPD);
2226 assert(SPDie && "Missing subprogram descriptor");
2227
2228 // Add the function bounds.
2229 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2230 DWLabel("func_begin", SubprogramCount));
2231 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2232 DWLabel("func_end", SubprogramCount));
2233
2234 MachineLocation Location(RI->getFrameRegister(*MF));
2235 AddAddress(SPDie, DW_AT_frame_base, Location);
2236 return;
2237 }
2238 }
Bill Wendlingae6b98c2008-10-17 18:48:57 +00002239#if 0
2240 // FIXME: This is causing an abort because C++ mangled names are compared
2241 // with their unmangled counterparts. See PR2885. Don't do this assert.
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00002242 assert(0 && "Couldn't find DIE for machine function!");
Bill Wendlingae6b98c2008-10-17 18:48:57 +00002243#endif
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00002244 }
2245
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002246 /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
2247 /// tools to recognize the object file contains Dwarf information.
2248 void EmitInitial() {
2249 // Check to see if we already emitted intial headers.
2250 if (didInitial) return;
2251 didInitial = true;
aslc200b112008-08-16 12:57:46 +00002252
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002253 // Dwarf sections base addresses.
2254 if (TAI->doesDwarfRequireFrameSection()) {
2255 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2256 EmitLabel("section_debug_frame", 0);
2257 }
2258 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2259 EmitLabel("section_info", 0);
2260 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2261 EmitLabel("section_abbrev", 0);
2262 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2263 EmitLabel("section_aranges", 0);
2264 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2265 EmitLabel("section_macinfo", 0);
2266 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2267 EmitLabel("section_line", 0);
2268 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2269 EmitLabel("section_loc", 0);
2270 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2271 EmitLabel("section_pubnames", 0);
2272 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2273 EmitLabel("section_str", 0);
2274 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2275 EmitLabel("section_ranges", 0);
2276
Anton Korobeynikov55b94962008-09-24 22:15:21 +00002277 Asm->SwitchToSection(TAI->getTextSection());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002278 EmitLabel("text_begin", 0);
Anton Korobeynikovcca60fa2008-09-24 22:16:16 +00002279 Asm->SwitchToSection(TAI->getDataSection());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002280 EmitLabel("data_begin", 0);
2281 }
2282
2283 /// EmitDIE - Recusively Emits a debug information entry.
2284 ///
2285 void EmitDIE(DIE *Die) {
2286 // Get the abbreviation for this DIE.
2287 unsigned AbbrevNumber = Die->getAbbrevNumber();
2288 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
aslc200b112008-08-16 12:57:46 +00002289
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002290 Asm->EOL();
2291
2292 // Emit the code (index) for the abbreviation.
2293 Asm->EmitULEB128Bytes(AbbrevNumber);
Evan Cheng0eeed442008-07-01 23:18:29 +00002294
2295 if (VerboseAsm)
2296 Asm->EOL(std::string("Abbrev [" +
2297 utostr(AbbrevNumber) +
2298 "] 0x" + utohexstr(Die->getOffset()) +
2299 ":0x" + utohexstr(Die->getSize()) + " " +
2300 TagString(Abbrev->getTag())));
2301 else
2302 Asm->EOL();
aslc200b112008-08-16 12:57:46 +00002303
Owen Anderson88dd6232008-06-24 21:44:59 +00002304 SmallVector<DIEValue*, 32> &Values = Die->getValues();
2305 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
aslc200b112008-08-16 12:57:46 +00002306
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002307 // Emit the DIE attribute values.
2308 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2309 unsigned Attr = AbbrevData[i].getAttribute();
2310 unsigned Form = AbbrevData[i].getForm();
2311 assert(Form && "Too many attributes for DIE (check abbreviation)");
aslc200b112008-08-16 12:57:46 +00002312
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002313 switch (Attr) {
2314 case DW_AT_sibling: {
2315 Asm->EmitInt32(Die->SiblingOffset());
2316 break;
2317 }
2318 default: {
2319 // Emit an attribute using the defined form.
2320 Values[i]->EmitValue(*this, Form);
2321 break;
2322 }
2323 }
aslc200b112008-08-16 12:57:46 +00002324
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002325 Asm->EOL(AttributeString(Attr));
2326 }
aslc200b112008-08-16 12:57:46 +00002327
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002328 // Emit the DIE children if any.
2329 if (Abbrev->getChildrenFlag() == DW_CHILDREN_yes) {
2330 const std::vector<DIE *> &Children = Die->getChildren();
aslc200b112008-08-16 12:57:46 +00002331
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002332 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2333 EmitDIE(Children[j]);
2334 }
aslc200b112008-08-16 12:57:46 +00002335
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002336 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2337 }
2338 }
2339
2340 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
2341 ///
2342 unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
2343 // Get the children.
2344 const std::vector<DIE *> &Children = Die->getChildren();
aslc200b112008-08-16 12:57:46 +00002345
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002346 // If not last sibling and has children then add sibling offset attribute.
2347 if (!Last && !Children.empty()) Die->AddSiblingOffset();
2348
2349 // Record the abbreviation.
2350 AssignAbbrevNumber(Die->getAbbrev());
aslc200b112008-08-16 12:57:46 +00002351
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002352 // Get the abbreviation for this DIE.
2353 unsigned AbbrevNumber = Die->getAbbrevNumber();
2354 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2355
2356 // Set DIE offset
2357 Die->setOffset(Offset);
aslc200b112008-08-16 12:57:46 +00002358
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002359 // Start the size with the size of abbreviation code.
aslc200b112008-08-16 12:57:46 +00002360 Offset += TargetAsmInfo::getULEB128Size(AbbrevNumber);
2361
Owen Anderson88dd6232008-06-24 21:44:59 +00002362 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2363 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002364
2365 // Size the DIE attribute values.
2366 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2367 // Size attribute value.
2368 Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
2369 }
aslc200b112008-08-16 12:57:46 +00002370
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002371 // Size the DIE children if any.
2372 if (!Children.empty()) {
2373 assert(Abbrev->getChildrenFlag() == DW_CHILDREN_yes &&
2374 "Children flag not set");
aslc200b112008-08-16 12:57:46 +00002375
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002376 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2377 Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
2378 }
aslc200b112008-08-16 12:57:46 +00002379
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002380 // End of children marker.
2381 Offset += sizeof(int8_t);
2382 }
2383
2384 Die->setSize(Offset - Die->getOffset());
2385 return Offset;
2386 }
2387
2388 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
2389 ///
2390 void SizeAndOffsets() {
2391 // Process base compile unit.
2392 CompileUnit *Unit = GetBaseCompileUnit();
2393 // Compute size of compile unit header
2394 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2395 sizeof(int16_t) + // DWARF version number
2396 sizeof(int32_t) + // Offset Into Abbrev. Section
2397 sizeof(int8_t); // Pointer Size (in bytes)
2398 SizeAndOffsetDie(Unit->getDie(), Offset, true);
2399 }
2400
2401 /// EmitDebugInfo - Emit the debug info section.
2402 ///
2403 void EmitDebugInfo() {
2404 // Start debug info section.
2405 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
aslc200b112008-08-16 12:57:46 +00002406
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002407 CompileUnit *Unit = GetBaseCompileUnit();
2408 DIE *Die = Unit->getDie();
2409 // Emit the compile units header.
2410 EmitLabel("info_begin", Unit->getID());
2411 // Emit size of content not including length itself
2412 unsigned ContentSize = Die->getSize() +
2413 sizeof(int16_t) + // DWARF version number
2414 sizeof(int32_t) + // Offset Into Abbrev. Section
2415 sizeof(int8_t) + // Pointer Size (in bytes)
2416 sizeof(int32_t); // FIXME - extra pad for gdb bug.
aslc200b112008-08-16 12:57:46 +00002417
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002418 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2419 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2420 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2421 Asm->EOL("Offset Into Abbrev. Section");
Dan Gohmancfb72b22007-09-27 23:12:31 +00002422 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
aslc200b112008-08-16 12:57:46 +00002423
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002424 EmitDIE(Die);
2425 // FIXME - extra padding for gdb bug.
2426 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2427 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2428 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2429 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2430 EmitLabel("info_end", Unit->getID());
aslc200b112008-08-16 12:57:46 +00002431
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002432 Asm->EOL();
2433 }
2434
2435 /// EmitAbbreviations - Emit the abbreviation section.
2436 ///
2437 void EmitAbbreviations() const {
2438 // Check to see if it is worth the effort.
2439 if (!Abbreviations.empty()) {
2440 // Start the debug abbrev section.
2441 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
aslc200b112008-08-16 12:57:46 +00002442
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002443 EmitLabel("abbrev_begin", 0);
aslc200b112008-08-16 12:57:46 +00002444
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002445 // For each abbrevation.
2446 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2447 // Get abbreviation data
2448 const DIEAbbrev *Abbrev = Abbreviations[i];
aslc200b112008-08-16 12:57:46 +00002449
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002450 // Emit the abbrevations code (base 1 index.)
2451 Asm->EmitULEB128Bytes(Abbrev->getNumber());
2452 Asm->EOL("Abbreviation Code");
aslc200b112008-08-16 12:57:46 +00002453
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002454 // Emit the abbreviations data.
2455 Abbrev->Emit(*this);
aslc200b112008-08-16 12:57:46 +00002456
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002457 Asm->EOL();
2458 }
aslc200b112008-08-16 12:57:46 +00002459
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002460 // Mark end of abbreviations.
2461 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2462
2463 EmitLabel("abbrev_end", 0);
aslc200b112008-08-16 12:57:46 +00002464
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002465 Asm->EOL();
2466 }
2467 }
2468
Bill Wendling1983a2a2008-07-20 00:11:19 +00002469 /// EmitEndOfLineMatrix - Emit the last address of the section and the end of
2470 /// the line matrix.
aslc200b112008-08-16 12:57:46 +00002471 ///
Bill Wendling1983a2a2008-07-20 00:11:19 +00002472 void EmitEndOfLineMatrix(unsigned SectionEnd) {
2473 // Define last address of section.
2474 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2475 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2476 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2477 EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
2478
2479 // Mark end of matrix.
2480 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2481 Asm->EmitULEB128Bytes(1); Asm->EOL();
2482 Asm->EmitInt8(1); Asm->EOL();
2483 }
2484
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002485 /// EmitDebugLines - Emit source line information.
2486 ///
2487 void EmitDebugLines() {
Bill Wendling1983a2a2008-07-20 00:11:19 +00002488 // If the target is using .loc/.file, the assembler will be emitting the
2489 // .debug_line table automatically.
2490 if (TAI->hasDotLocAndDotFile())
Dan Gohmanc55b34a2007-09-24 21:43:52 +00002491 return;
2492
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002493 // Minimum line delta, thus ranging from -10..(255-10).
2494 const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
2495 // Maximum line delta, thus ranging from -10..(255-10).
2496 const int MaxLineDelta = 255 + MinLineDelta;
2497
2498 // Start the dwarf line section.
2499 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
aslc200b112008-08-16 12:57:46 +00002500
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002501 // Construct the section header.
aslc200b112008-08-16 12:57:46 +00002502
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002503 EmitDifference("line_end", 0, "line_begin", 0, true);
2504 Asm->EOL("Length of Source Line Info");
2505 EmitLabel("line_begin", 0);
aslc200b112008-08-16 12:57:46 +00002506
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002507 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
aslc200b112008-08-16 12:57:46 +00002508
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002509 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2510 Asm->EOL("Prolog Length");
2511 EmitLabel("line_prolog_begin", 0);
aslc200b112008-08-16 12:57:46 +00002512
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002513 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2514
2515 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2516
2517 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
aslc200b112008-08-16 12:57:46 +00002518
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002519 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2520
2521 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
aslc200b112008-08-16 12:57:46 +00002522
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002523 // Line number standard opcode encodings argument count
2524 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2525 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2526 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2527 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2528 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2529 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2530 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2531 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2532 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2533
2534 const UniqueVector<std::string> &Directories = MMI->getDirectories();
Evan Cheng0eeed442008-07-01 23:18:29 +00002535 const UniqueVector<SourceFileInfo> &SourceFiles = MMI->getSourceFiles();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002536
2537 // Emit directories.
2538 for (unsigned DirectoryID = 1, NDID = Directories.size();
2539 DirectoryID <= NDID; ++DirectoryID) {
2540 Asm->EmitString(Directories[DirectoryID]); Asm->EOL("Directory");
2541 }
2542 Asm->EmitInt8(0); Asm->EOL("End of directories");
aslc200b112008-08-16 12:57:46 +00002543
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002544 // Emit files.
2545 for (unsigned SourceID = 1, NSID = SourceFiles.size();
2546 SourceID <= NSID; ++SourceID) {
2547 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
2548 Asm->EmitString(SourceFile.getName());
2549 Asm->EOL("Source");
2550 Asm->EmitULEB128Bytes(SourceFile.getDirectoryID());
2551 Asm->EOL("Directory #");
2552 Asm->EmitULEB128Bytes(0);
2553 Asm->EOL("Mod date");
2554 Asm->EmitULEB128Bytes(0);
2555 Asm->EOL("File size");
2556 }
2557 Asm->EmitInt8(0); Asm->EOL("End of files");
aslc200b112008-08-16 12:57:46 +00002558
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002559 EmitLabel("line_prolog_end", 0);
aslc200b112008-08-16 12:57:46 +00002560
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002561 // A sequence for each text section.
Bill Wendling1983a2a2008-07-20 00:11:19 +00002562 unsigned SecSrcLinesSize = SectionSourceLines.size();
2563
2564 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002565 // Isolate current sections line info.
2566 const std::vector<SourceLineInfo> &LineInfos = SectionSourceLines[j];
Evan Cheng0eeed442008-07-01 23:18:29 +00002567
Anton Korobeynikov55b94962008-09-24 22:15:21 +00002568 if (VerboseAsm) {
2569 const Section* S = SectionMap[j + 1];
2570 Asm->EOL(std::string("Section ") + S->getName());
2571 } else
Evan Cheng0eeed442008-07-01 23:18:29 +00002572 Asm->EOL();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002573
2574 // Dwarf assumes we start with first line of first source file.
2575 unsigned Source = 1;
2576 unsigned Line = 1;
aslc200b112008-08-16 12:57:46 +00002577
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002578 // Construct rows of the address, source, line, column matrix.
2579 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2580 const SourceLineInfo &LineInfo = LineInfos[i];
2581 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2582 if (!LabelID) continue;
aslc200b112008-08-16 12:57:46 +00002583
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002584 unsigned SourceID = LineInfo.getSourceID();
2585 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
2586 unsigned DirectoryID = SourceFile.getDirectoryID();
Evan Cheng0eeed442008-07-01 23:18:29 +00002587 if (VerboseAsm)
2588 Asm->EOL(Directories[DirectoryID]
2589 + SourceFile.getName()
2590 + ":"
2591 + utostr_32(LineInfo.getLine()));
2592 else
2593 Asm->EOL();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002594
2595 // Define the line address.
2596 Asm->EmitInt8(0); Asm->EOL("Extended Op");
Dan Gohmancfb72b22007-09-27 23:12:31 +00002597 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002598 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2599 EmitReference("label", LabelID); Asm->EOL("Location label");
aslc200b112008-08-16 12:57:46 +00002600
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002601 // If change of source, then switch to the new source.
2602 if (Source != LineInfo.getSourceID()) {
2603 Source = LineInfo.getSourceID();
2604 Asm->EmitInt8(DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2605 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2606 }
aslc200b112008-08-16 12:57:46 +00002607
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002608 // If change of line.
2609 if (Line != LineInfo.getLine()) {
2610 // Determine offset.
2611 int Offset = LineInfo.getLine() - Line;
2612 int Delta = Offset - MinLineDelta;
aslc200b112008-08-16 12:57:46 +00002613
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002614 // Update line.
2615 Line = LineInfo.getLine();
aslc200b112008-08-16 12:57:46 +00002616
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002617 // If delta is small enough and in range...
2618 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2619 // ... then use fast opcode.
2620 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2621 } else {
2622 // ... otherwise use long hand.
2623 Asm->EmitInt8(DW_LNS_advance_line); Asm->EOL("DW_LNS_advance_line");
2624 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2625 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2626 }
2627 } else {
2628 // Copy the previous row (different address or source)
2629 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2630 }
2631 }
2632
Bill Wendling1983a2a2008-07-20 00:11:19 +00002633 EmitEndOfLineMatrix(j + 1);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002634 }
Bill Wendling1983a2a2008-07-20 00:11:19 +00002635
2636 if (SecSrcLinesSize == 0)
2637 // Because we're emitting a debug_line section, we still need a line
2638 // table. The linker and friends expect it to exist. If there's nothing to
2639 // put into it, emit an empty table.
2640 EmitEndOfLineMatrix(1);
aslc200b112008-08-16 12:57:46 +00002641
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002642 EmitLabel("line_end", 0);
aslc200b112008-08-16 12:57:46 +00002643
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002644 Asm->EOL();
2645 }
aslc200b112008-08-16 12:57:46 +00002646
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002647 /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
2648 ///
2649 void EmitCommonDebugFrame() {
2650 if (!TAI->doesDwarfRequireFrameSection())
2651 return;
2652
2653 int stackGrowth =
2654 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2655 TargetFrameInfo::StackGrowsUp ?
Dan Gohmancfb72b22007-09-27 23:12:31 +00002656 TD->getPointerSize() : -TD->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002657
2658 // Start the dwarf frame section.
2659 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2660
2661 EmitLabel("debug_frame_common", 0);
2662 EmitDifference("debug_frame_common_end", 0,
2663 "debug_frame_common_begin", 0, true);
2664 Asm->EOL("Length of Common Information Entry");
2665
2666 EmitLabel("debug_frame_common_begin", 0);
2667 Asm->EmitInt32((int)DW_CIE_ID);
2668 Asm->EOL("CIE Identifier Tag");
2669 Asm->EmitInt8(DW_CIE_VERSION);
2670 Asm->EOL("CIE Version");
2671 Asm->EmitString("");
2672 Asm->EOL("CIE Augmentation");
2673 Asm->EmitULEB128Bytes(1);
2674 Asm->EOL("CIE Code Alignment Factor");
2675 Asm->EmitSLEB128Bytes(stackGrowth);
aslc200b112008-08-16 12:57:46 +00002676 Asm->EOL("CIE Data Alignment Factor");
Dale Johannesenf5a11532007-11-13 19:13:01 +00002677 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002678 Asm->EOL("CIE RA Column");
aslc200b112008-08-16 12:57:46 +00002679
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002680 std::vector<MachineMove> Moves;
2681 RI->getInitialFrameState(Moves);
2682
Dale Johannesenf5a11532007-11-13 19:13:01 +00002683 EmitFrameMoves(NULL, 0, Moves, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002684
Evan Cheng7e7d1942008-02-29 19:36:59 +00002685 Asm->EmitAlignment(2, 0, 0, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002686 EmitLabel("debug_frame_common_end", 0);
aslc200b112008-08-16 12:57:46 +00002687
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002688 Asm->EOL();
2689 }
2690
2691 /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2692 /// section.
2693 void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
2694 if (!TAI->doesDwarfRequireFrameSection())
2695 return;
aslc200b112008-08-16 12:57:46 +00002696
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002697 // Start the dwarf frame section.
2698 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
aslc200b112008-08-16 12:57:46 +00002699
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002700 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2701 "debug_frame_begin", DebugFrameInfo.Number, true);
2702 Asm->EOL("Length of Frame Information Entry");
aslc200b112008-08-16 12:57:46 +00002703
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002704 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2705
2706 EmitSectionOffset("debug_frame_common", "section_debug_frame",
2707 0, 0, true, false);
2708 Asm->EOL("FDE CIE offset");
2709
2710 EmitReference("func_begin", DebugFrameInfo.Number);
2711 Asm->EOL("FDE initial location");
2712 EmitDifference("func_end", DebugFrameInfo.Number,
2713 "func_begin", DebugFrameInfo.Number);
2714 Asm->EOL("FDE address range");
aslc200b112008-08-16 12:57:46 +00002715
Dale Johannesenf5a11532007-11-13 19:13:01 +00002716 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves, false);
aslc200b112008-08-16 12:57:46 +00002717
Evan Cheng7e7d1942008-02-29 19:36:59 +00002718 Asm->EmitAlignment(2, 0, 0, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002719 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
2720
2721 Asm->EOL();
2722 }
2723
2724 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
2725 ///
2726 void EmitDebugPubNames() {
2727 // Start the dwarf pubnames section.
2728 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
aslc200b112008-08-16 12:57:46 +00002729
2730 CompileUnit *Unit = GetBaseCompileUnit();
2731
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002732 EmitDifference("pubnames_end", Unit->getID(),
2733 "pubnames_begin", Unit->getID(), true);
2734 Asm->EOL("Length of Public Names Info");
aslc200b112008-08-16 12:57:46 +00002735
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002736 EmitLabel("pubnames_begin", Unit->getID());
aslc200b112008-08-16 12:57:46 +00002737
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002738 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF Version");
2739
2740 EmitSectionOffset("info_begin", "section_info",
2741 Unit->getID(), 0, true, false);
2742 Asm->EOL("Offset of Compilation Unit Info");
2743
2744 EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(),true);
2745 Asm->EOL("Compilation Unit Length");
aslc200b112008-08-16 12:57:46 +00002746
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002747 std::map<std::string, DIE *> &Globals = Unit->getGlobals();
aslc200b112008-08-16 12:57:46 +00002748
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002749 for (std::map<std::string, DIE *>::iterator GI = Globals.begin(),
2750 GE = Globals.end();
2751 GI != GE; ++GI) {
2752 const std::string &Name = GI->first;
2753 DIE * Entity = GI->second;
aslc200b112008-08-16 12:57:46 +00002754
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002755 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2756 Asm->EmitString(Name); Asm->EOL("External Name");
2757 }
aslc200b112008-08-16 12:57:46 +00002758
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002759 Asm->EmitInt32(0); Asm->EOL("End Mark");
2760 EmitLabel("pubnames_end", Unit->getID());
aslc200b112008-08-16 12:57:46 +00002761
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002762 Asm->EOL();
2763 }
2764
2765 /// EmitDebugStr - Emit visible names into a debug str section.
2766 ///
2767 void EmitDebugStr() {
2768 // Check to see if it is worth the effort.
2769 if (!StringPool.empty()) {
2770 // Start the dwarf str section.
2771 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
aslc200b112008-08-16 12:57:46 +00002772
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002773 // For each of strings in the string pool.
2774 for (unsigned StringID = 1, N = StringPool.size();
2775 StringID <= N; ++StringID) {
2776 // Emit a label for reference from debug information entries.
2777 EmitLabel("string", StringID);
2778 // Emit the string itself.
2779 const std::string &String = StringPool[StringID];
2780 Asm->EmitString(String); Asm->EOL();
2781 }
aslc200b112008-08-16 12:57:46 +00002782
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002783 Asm->EOL();
2784 }
2785 }
2786
2787 /// EmitDebugLoc - Emit visible names into a debug loc section.
2788 ///
2789 void EmitDebugLoc() {
2790 // Start the dwarf loc section.
2791 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
aslc200b112008-08-16 12:57:46 +00002792
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002793 Asm->EOL();
2794 }
2795
2796 /// EmitDebugARanges - Emit visible names into a debug aranges section.
2797 ///
2798 void EmitDebugARanges() {
2799 // Start the dwarf aranges section.
2800 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
aslc200b112008-08-16 12:57:46 +00002801
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002802 // FIXME - Mock up
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00002803#if 0
aslc200b112008-08-16 12:57:46 +00002804 CompileUnit *Unit = GetBaseCompileUnit();
2805
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002806 // Don't include size of length
2807 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
aslc200b112008-08-16 12:57:46 +00002808
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002809 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("Dwarf Version");
aslc200b112008-08-16 12:57:46 +00002810
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002811 EmitReference("info_begin", Unit->getID());
2812 Asm->EOL("Offset of Compilation Unit Info");
2813
Dan Gohmancfb72b22007-09-27 23:12:31 +00002814 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002815
2816 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
2817
2818 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
2819 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
2820
2821 // Range 1
2822 EmitReference("text_begin", 0); Asm->EOL("Address");
2823 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
2824
2825 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2826 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00002827#endif
aslc200b112008-08-16 12:57:46 +00002828
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002829 Asm->EOL();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002830 }
2831
2832 /// EmitDebugRanges - Emit visible names into a debug ranges section.
2833 ///
2834 void EmitDebugRanges() {
2835 // Start the dwarf ranges section.
2836 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
aslc200b112008-08-16 12:57:46 +00002837
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002838 Asm->EOL();
2839 }
2840
2841 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
2842 ///
2843 void EmitDebugMacInfo() {
2844 // Start the dwarf macinfo section.
2845 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
aslc200b112008-08-16 12:57:46 +00002846
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002847 Asm->EOL();
2848 }
2849
2850 /// ConstructCompileUnitDIEs - Create a compile unit DIE for each source and
2851 /// header file.
2852 void ConstructCompileUnitDIEs() {
2853 const UniqueVector<CompileUnitDesc *> CUW = MMI->getCompileUnits();
aslc200b112008-08-16 12:57:46 +00002854
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002855 for (unsigned i = 1, N = CUW.size(); i <= N; ++i) {
2856 unsigned ID = MMI->RecordSource(CUW[i]);
2857 CompileUnit *Unit = NewCompileUnit(CUW[i], ID);
2858 CompileUnits.push_back(Unit);
2859 }
2860 }
2861
2862 /// ConstructGlobalDIEs - Create DIEs for each of the externally visible
2863 /// global variables.
2864 void ConstructGlobalDIEs() {
Bill Wendling75091f92008-07-03 23:13:02 +00002865 std::vector<GlobalVariableDesc *> GlobalVariables;
2866 MMI->getAnchoredDescriptors<GlobalVariableDesc>(*M, GlobalVariables);
aslc200b112008-08-16 12:57:46 +00002867
Bill Wendling4de8de52008-07-03 22:53:42 +00002868 for (unsigned i = 0, N = GlobalVariables.size(); i < N; ++i) {
2869 GlobalVariableDesc *GVD = GlobalVariables[i];
2870 NewGlobalVariable(GVD);
2871 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002872 }
2873
2874 /// ConstructSubprogramDIEs - Create DIEs for each of the externally visible
2875 /// subprograms.
2876 void ConstructSubprogramDIEs() {
Bill Wendling75091f92008-07-03 23:13:02 +00002877 std::vector<SubprogramDesc *> Subprograms;
2878 MMI->getAnchoredDescriptors<SubprogramDesc>(*M, Subprograms);
aslc200b112008-08-16 12:57:46 +00002879
Bill Wendling4de8de52008-07-03 22:53:42 +00002880 for (unsigned i = 0, N = Subprograms.size(); i < N; ++i) {
2881 SubprogramDesc *SPD = Subprograms[i];
2882 NewSubprogram(SPD);
2883 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002884 }
2885
2886public:
2887 //===--------------------------------------------------------------------===//
2888 // Main entry points.
2889 //
Owen Anderson847b99b2008-08-21 00:14:44 +00002890 DwarfDebug(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
Chris Lattnerb3876c72007-09-24 03:35:37 +00002891 : Dwarf(OS, A, T, "dbg")
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002892 , CompileUnits()
2893 , AbbreviationsSet(InitAbbreviationsSetSize)
2894 , Abbreviations()
2895 , ValuesSet(InitValuesSetSize)
2896 , Values()
2897 , StringPool()
2898 , DescToUnitMap()
2899 , SectionMap()
2900 , SectionSourceLines()
2901 , didInitial(false)
2902 , shouldEmit(false)
2903 {
2904 }
2905 virtual ~DwarfDebug() {
2906 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i)
2907 delete CompileUnits[i];
2908 for (unsigned j = 0, M = Values.size(); j < M; ++j)
2909 delete Values[j];
2910 }
2911
2912 /// SetModuleInfo - Set machine module information when it's known that pass
2913 /// manager has created it. Set by the target AsmPrinter.
2914 void SetModuleInfo(MachineModuleInfo *mmi) {
2915 // Make sure initial declarations are made.
2916 if (!MMI && mmi->hasDebugInfo()) {
2917 MMI = mmi;
2918 shouldEmit = true;
aslc200b112008-08-16 12:57:46 +00002919
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002920 // Create all the compile unit DIEs.
2921 ConstructCompileUnitDIEs();
aslc200b112008-08-16 12:57:46 +00002922
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002923 // Create DIEs for each of the externally visible global variables.
2924 ConstructGlobalDIEs();
2925
2926 // Create DIEs for each of the externally visible subprograms.
2927 ConstructSubprogramDIEs();
aslc200b112008-08-16 12:57:46 +00002928
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002929 // Prime section data.
2930 SectionMap.insert(TAI->getTextSection());
Dan Gohman6d6c2402007-10-01 22:40:20 +00002931
2932 // Print out .file directives to specify files for .loc directives. These
2933 // are printed out early so that they precede any .loc directives.
2934 if (TAI->hasDotLocAndDotFile()) {
2935 const UniqueVector<SourceFileInfo> &SourceFiles = MMI->getSourceFiles();
2936 const UniqueVector<std::string> &Directories = MMI->getDirectories();
2937 for (unsigned i = 1, e = SourceFiles.size(); i <= e; ++i) {
2938 sys::Path FullPath(Directories[SourceFiles[i].getDirectoryID()]);
2939 bool AppendOk = FullPath.appendComponent(SourceFiles[i].getName());
2940 assert(AppendOk && "Could not append filename to directory!");
Devang Patel105a08a2008-12-23 21:55:38 +00002941 AppendOk = false;
Dan Gohman6d6c2402007-10-01 22:40:20 +00002942 Asm->EmitFile(i, FullPath.toString());
2943 Asm->EOL();
2944 }
2945 }
2946
2947 // Emit initial sections
2948 EmitInitial();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002949 }
2950 }
2951
2952 /// BeginModule - Emit all Dwarf sections that should come prior to the
2953 /// content.
2954 void BeginModule(Module *M) {
2955 this->M = M;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002956 }
2957
2958 /// EndModule - Emit all Dwarf sections that should come after the content.
2959 ///
2960 void EndModule() {
2961 if (!ShouldEmitDwarf()) return;
aslc200b112008-08-16 12:57:46 +00002962
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002963 // Standard sections final addresses.
Anton Korobeynikov55b94962008-09-24 22:15:21 +00002964 Asm->SwitchToSection(TAI->getTextSection());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002965 EmitLabel("text_end", 0);
Anton Korobeynikovcca60fa2008-09-24 22:16:16 +00002966 Asm->SwitchToSection(TAI->getDataSection());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002967 EmitLabel("data_end", 0);
aslc200b112008-08-16 12:57:46 +00002968
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002969 // End text sections.
2970 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Anton Korobeynikov55b94962008-09-24 22:15:21 +00002971 Asm->SwitchToSection(SectionMap[i]);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002972 EmitLabel("section_end", i);
2973 }
2974
2975 // Emit common frame information.
2976 EmitCommonDebugFrame();
2977
2978 // Emit function debug frame information
2979 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2980 E = DebugFrames.end(); I != E; ++I)
2981 EmitFunctionDebugFrame(*I);
2982
2983 // Compute DIE offsets and sizes.
2984 SizeAndOffsets();
aslc200b112008-08-16 12:57:46 +00002985
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002986 // Emit all the DIEs into a debug info section
2987 EmitDebugInfo();
aslc200b112008-08-16 12:57:46 +00002988
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002989 // Corresponding abbreviations into a abbrev section.
2990 EmitAbbreviations();
aslc200b112008-08-16 12:57:46 +00002991
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002992 // Emit source line correspondence into a debug line section.
2993 EmitDebugLines();
aslc200b112008-08-16 12:57:46 +00002994
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002995 // Emit info into a debug pubnames section.
2996 EmitDebugPubNames();
aslc200b112008-08-16 12:57:46 +00002997
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002998 // Emit info into a debug str section.
2999 EmitDebugStr();
aslc200b112008-08-16 12:57:46 +00003000
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003001 // Emit info into a debug loc section.
3002 EmitDebugLoc();
aslc200b112008-08-16 12:57:46 +00003003
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003004 // Emit info into a debug aranges section.
3005 EmitDebugARanges();
aslc200b112008-08-16 12:57:46 +00003006
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003007 // Emit info into a debug ranges section.
3008 EmitDebugRanges();
aslc200b112008-08-16 12:57:46 +00003009
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003010 // Emit info into a debug macinfo section.
3011 EmitDebugMacInfo();
3012 }
3013
aslc200b112008-08-16 12:57:46 +00003014 /// BeginFunction - Gather pre-function debug information. Assumes being
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003015 /// emitted immediately after the function entry point.
3016 void BeginFunction(MachineFunction *MF) {
3017 this->MF = MF;
aslc200b112008-08-16 12:57:46 +00003018
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003019 if (!ShouldEmitDwarf()) return;
3020
3021 // Begin accumulating function debug information.
3022 MMI->BeginFunction(MF);
aslc200b112008-08-16 12:57:46 +00003023
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003024 // Assumes in correct section after the entry point.
3025 EmitLabel("func_begin", ++SubprogramCount);
Evan Chenga53c40a2008-02-01 09:10:45 +00003026
3027 // Emit label for the implicitly defined dbg.stoppoint at the start of
3028 // the function.
Andrew Lenharth42f91402008-04-03 17:37:43 +00003029 const std::vector<SourceLineInfo> &LineInfos = MMI->getSourceLines();
3030 if (!LineInfos.empty()) {
3031 const SourceLineInfo &LineInfo = LineInfos[0];
3032 Asm->printLabel(LineInfo.getLabelID());
3033 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003034 }
aslc200b112008-08-16 12:57:46 +00003035
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003036 /// EndFunction - Gather and emit post-function debug information.
3037 ///
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00003038 void EndFunction(MachineFunction *MF) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003039 if (!ShouldEmitDwarf()) return;
aslc200b112008-08-16 12:57:46 +00003040
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003041 // Define end label for subprogram.
3042 EmitLabel("func_end", SubprogramCount);
aslc200b112008-08-16 12:57:46 +00003043
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003044 // Get function line info.
3045 const std::vector<SourceLineInfo> &LineInfos = MMI->getSourceLines();
3046
3047 if (!LineInfos.empty()) {
3048 // Get section line info.
Anton Korobeynikov55b94962008-09-24 22:15:21 +00003049 unsigned ID = SectionMap.insert(Asm->CurrentSection_);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003050 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
3051 std::vector<SourceLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
3052 // Append the function info to section info.
3053 SectionLineInfos.insert(SectionLineInfos.end(),
3054 LineInfos.begin(), LineInfos.end());
3055 }
aslc200b112008-08-16 12:57:46 +00003056
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003057 // Construct scopes for subprogram.
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00003058 if (MMI->getRootScope())
3059 ConstructRootScope(MMI->getRootScope());
3060 else
3061 // FIXME: This is wrong. We are essentially getting past a problem with
3062 // debug information not being able to handle unreachable blocks that have
3063 // debug information in them. In particular, those unreachable blocks that
3064 // have "region end" info in them. That situation results in the "root
3065 // scope" not being created. If that's the case, then emit a "default"
3066 // scope, i.e., one that encompasses the whole function. This isn't
3067 // desirable. And a better way of handling this (and all of the debugging
3068 // information) needs to be explored.
3069 ConstructDefaultScope(MF);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003070
3071 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
3072 MMI->getFrameMoves()));
3073 }
3074};
3075
3076//===----------------------------------------------------------------------===//
aslc200b112008-08-16 12:57:46 +00003077/// DwarfException - Emits Dwarf exception handling directives.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003078///
3079class DwarfException : public Dwarf {
3080
3081private:
3082 struct FunctionEHFrameInfo {
3083 std::string FnName;
3084 unsigned Number;
3085 unsigned PersonalityIndex;
3086 bool hasCalls;
3087 bool hasLandingPads;
3088 std::vector<MachineMove> Moves;
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003089 const Function * function;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003090
3091 FunctionEHFrameInfo(const std::string &FN, unsigned Num, unsigned P,
3092 bool hC, bool hL,
Dale Johannesenfb3ac732007-11-20 23:24:42 +00003093 const std::vector<MachineMove> &M,
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003094 const Function *f):
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003095 FnName(FN), Number(Num), PersonalityIndex(P),
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003096 hasCalls(hC), hasLandingPads(hL), Moves(M), function (f) { }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003097 };
3098
3099 std::vector<FunctionEHFrameInfo> EHFrames;
Dale Johannesen85535762008-04-02 00:25:04 +00003100
3101 /// shouldEmitTable - Per-function flag to indicate if EH tables should
3102 /// be emitted.
3103 bool shouldEmitTable;
3104
3105 /// shouldEmitMoves - Per-function flag to indicate if frame moves info
3106 /// should be emitted.
3107 bool shouldEmitMoves;
3108
3109 /// shouldEmitTableModule - Per-module flag to indicate if EH tables
3110 /// should be emitted.
3111 bool shouldEmitTableModule;
3112
aslc200b112008-08-16 12:57:46 +00003113 /// shouldEmitFrameModule - Per-module flag to indicate if frame moves
Dale Johannesen85535762008-04-02 00:25:04 +00003114 /// should be emitted.
3115 bool shouldEmitMovesModule;
Duncan Sands96144f92008-05-07 19:11:09 +00003116
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003117 /// EmitCommonEHFrame - Emit the common eh unwind frame.
3118 ///
3119 void EmitCommonEHFrame(const Function *Personality, unsigned Index) {
3120 // Size and sign of stack growth.
3121 int stackGrowth =
3122 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3123 TargetFrameInfo::StackGrowsUp ?
Dan Gohmancfb72b22007-09-27 23:12:31 +00003124 TD->getPointerSize() : -TD->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003125
3126 // Begin eh frame section.
3127 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
Bill Wendling189bde72008-12-24 08:05:17 +00003128
3129 if (!TAI->doesRequireNonLocalEHFrameLabel())
3130 O << TAI->getEHGlobalPrefix();
3131 O << "EH_frame" << Index << ":\n";
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003132 EmitLabel("section_eh_frame", Index);
3133
3134 // Define base labels.
3135 EmitLabel("eh_frame_common", Index);
Duncan Sands96144f92008-05-07 19:11:09 +00003136
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003137 // Define the eh frame length.
3138 EmitDifference("eh_frame_common_end", Index,
3139 "eh_frame_common_begin", Index, true);
3140 Asm->EOL("Length of Common Information Entry");
3141
3142 // EH frame header.
3143 EmitLabel("eh_frame_common_begin", Index);
3144 Asm->EmitInt32((int)0);
3145 Asm->EOL("CIE Identifier Tag");
3146 Asm->EmitInt8(DW_CIE_VERSION);
3147 Asm->EOL("CIE Version");
Duncan Sands96144f92008-05-07 19:11:09 +00003148
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003149 // The personality presence indicates that language specific information
3150 // will show up in the eh frame.
3151 Asm->EmitString(Personality ? "zPLR" : "zR");
3152 Asm->EOL("CIE Augmentation");
Duncan Sands96144f92008-05-07 19:11:09 +00003153
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003154 // Round out reader.
3155 Asm->EmitULEB128Bytes(1);
3156 Asm->EOL("CIE Code Alignment Factor");
3157 Asm->EmitSLEB128Bytes(stackGrowth);
Duncan Sands96144f92008-05-07 19:11:09 +00003158 Asm->EOL("CIE Data Alignment Factor");
Dale Johannesenf5a11532007-11-13 19:13:01 +00003159 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), true));
Duncan Sands96144f92008-05-07 19:11:09 +00003160 Asm->EOL("CIE Return Address Column");
3161
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003162 // If there is a personality, we need to indicate the functions location.
3163 if (Personality) {
3164 Asm->EmitULEB128Bytes(7);
3165 Asm->EOL("Augmentation Size");
Bill Wendling2d369922007-09-11 17:20:55 +00003166
Duncan Sands96144f92008-05-07 19:11:09 +00003167 if (TAI->getNeedsIndirectEncoding()) {
Bill Wendling2d369922007-09-11 17:20:55 +00003168 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4 | DW_EH_PE_indirect);
Duncan Sands96144f92008-05-07 19:11:09 +00003169 Asm->EOL("Personality (pcrel sdata4 indirect)");
3170 } else {
Bill Wendling2d369922007-09-11 17:20:55 +00003171 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
Duncan Sands96144f92008-05-07 19:11:09 +00003172 Asm->EOL("Personality (pcrel sdata4)");
3173 }
Bill Wendling2d369922007-09-11 17:20:55 +00003174
Duncan Sands96144f92008-05-07 19:11:09 +00003175 PrintRelDirective(true);
Bill Wendlingd1bda4f2007-09-11 08:27:17 +00003176 O << TAI->getPersonalityPrefix();
3177 Asm->EmitExternalGlobal((const GlobalVariable *)(Personality));
3178 O << TAI->getPersonalitySuffix();
Duncan Sands4cc39532008-05-08 12:33:11 +00003179 if (strcmp(TAI->getPersonalitySuffix(), "+4@GOTPCREL"))
3180 O << "-" << TAI->getPCSymbol();
Bill Wendlingd1bda4f2007-09-11 08:27:17 +00003181 Asm->EOL("Personality");
Bill Wendling38cb7c92007-08-25 00:51:55 +00003182
Duncan Sands96144f92008-05-07 19:11:09 +00003183 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3184 Asm->EOL("LSDA Encoding (pcrel sdata4)");
Bill Wendling6bd1b792008-12-24 05:25:49 +00003185
3186 if (TAI->doesFDEEncodingRequireSData4()) {
3187 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3188 Asm->EOL("FDE Encoding (pcrel sdata4)");
3189 } else {
3190 Asm->EmitInt8(DW_EH_PE_pcrel);
3191 Asm->EOL("FDE Encoding (pcrel)");
3192 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003193 } else {
3194 Asm->EmitULEB128Bytes(1);
3195 Asm->EOL("Augmentation Size");
Bill Wendling6bd1b792008-12-24 05:25:49 +00003196
3197 if (TAI->doesFDEEncodingRequireSData4()) {
3198 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3199 Asm->EOL("FDE Encoding (pcrel sdata4)");
3200 } else {
3201 Asm->EmitInt8(DW_EH_PE_pcrel);
3202 Asm->EOL("FDE Encoding (pcrel)");
3203 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003204 }
3205
3206 // Indicate locations of general callee saved registers in frame.
3207 std::vector<MachineMove> Moves;
3208 RI->getInitialFrameState(Moves);
Dale Johannesenf5a11532007-11-13 19:13:01 +00003209 EmitFrameMoves(NULL, 0, Moves, true);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003210
Dale Johannesen388f20f2008-04-30 00:43:29 +00003211 // On Darwin the linker honors the alignment of eh_frame, which means it
3212 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3213 // you get holes which confuse readers of eh_frame.
aslc200b112008-08-16 12:57:46 +00003214 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
Dale Johannesen837d7ab2008-04-29 22:58:20 +00003215 0, 0, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003216 EmitLabel("eh_frame_common_end", Index);
Duncan Sands96144f92008-05-07 19:11:09 +00003217
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003218 Asm->EOL();
3219 }
Duncan Sands96144f92008-05-07 19:11:09 +00003220
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003221 /// EmitEHFrame - Emit function exception frame information.
3222 ///
3223 void EmitEHFrame(const FunctionEHFrameInfo &EHFrameInfo) {
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003224 Function::LinkageTypes linkage = EHFrameInfo.function->getLinkage();
3225
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003226 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3227
3228 // Externally visible entry into the functions eh frame info.
Dale Johannesenfb3ac732007-11-20 23:24:42 +00003229 // If the corresponding function is static, this should not be
3230 // externally visible.
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003231 if (linkage != Function::InternalLinkage) {
Dale Johannesenfb3ac732007-11-20 23:24:42 +00003232 if (const char *GlobalEHDirective = TAI->getGlobalEHDirective())
3233 O << GlobalEHDirective << EHFrameInfo.FnName << "\n";
3234 }
3235
Dale Johannesenf09b5992008-01-10 02:03:30 +00003236 // If corresponding function is weak definition, this should be too.
aslc200b112008-08-16 12:57:46 +00003237 if ((linkage == Function::WeakLinkage ||
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003238 linkage == Function::LinkOnceLinkage) &&
Dale Johannesenf09b5992008-01-10 02:03:30 +00003239 TAI->getWeakDefDirective())
3240 O << TAI->getWeakDefDirective() << EHFrameInfo.FnName << "\n";
3241
3242 // If there are no calls then you can't unwind. This may mean we can
3243 // omit the EH Frame, but some environments do not handle weak absolute
aslc200b112008-08-16 12:57:46 +00003244 // symbols.
Dale Johannesenb369e8d2008-04-14 17:54:17 +00003245 // If UnwindTablesMandatory is set we cannot do this optimization; the
Dale Johannesena9b3e482008-04-08 00:10:24 +00003246 // unwind info is to be available for non-EH uses.
Dale Johannesenf09b5992008-01-10 02:03:30 +00003247 if (!EHFrameInfo.hasCalls &&
Dale Johannesenb369e8d2008-04-14 17:54:17 +00003248 !UnwindTablesMandatory &&
aslc200b112008-08-16 12:57:46 +00003249 ((linkage != Function::WeakLinkage &&
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003250 linkage != Function::LinkOnceLinkage) ||
Dale Johannesenf09b5992008-01-10 02:03:30 +00003251 !TAI->getWeakDefDirective() ||
3252 TAI->getSupportsWeakOmittedEHFrame()))
aslc200b112008-08-16 12:57:46 +00003253 {
Bill Wendlingef9211a2007-09-18 01:47:22 +00003254 O << EHFrameInfo.FnName << " = 0\n";
aslc200b112008-08-16 12:57:46 +00003255 // This name has no connection to the function, so it might get
3256 // dead-stripped when the function is not, erroneously. Prohibit
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003257 // dead-stripping unconditionally.
3258 if (const char *UsedDirective = TAI->getUsedDirective())
3259 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003260 } else {
Bill Wendlingef9211a2007-09-18 01:47:22 +00003261 O << EHFrameInfo.FnName << ":\n";
Dale Johannesenfb3ac732007-11-20 23:24:42 +00003262
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003263 // EH frame header.
3264 EmitDifference("eh_frame_end", EHFrameInfo.Number,
3265 "eh_frame_begin", EHFrameInfo.Number, true);
3266 Asm->EOL("Length of Frame Information Entry");
aslc200b112008-08-16 12:57:46 +00003267
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003268 EmitLabel("eh_frame_begin", EHFrameInfo.Number);
3269
Bill Wendling189bde72008-12-24 08:05:17 +00003270 if (TAI->doesRequireNonLocalEHFrameLabel()) {
3271 PrintRelDirective(true, true);
3272 PrintLabelName("eh_frame_begin", EHFrameInfo.Number);
3273
3274 if (!TAI->isAbsoluteEHSectionOffsets())
3275 O << "-EH_frame" << EHFrameInfo.PersonalityIndex;
3276 } else {
3277 EmitSectionOffset("eh_frame_begin", "eh_frame_common",
3278 EHFrameInfo.Number, EHFrameInfo.PersonalityIndex,
3279 true, true, false);
3280 }
3281
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003282 Asm->EOL("FDE CIE offset");
3283
Bill Wendlingeeef8b22008-12-29 22:12:11 +00003284 EmitReference("eh_func_begin", EHFrameInfo.Number, true,
3285 TAI->doesRequire32BitFDEReference());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003286 Asm->EOL("FDE initial location");
3287 EmitDifference("eh_func_end", EHFrameInfo.Number,
Bill Wendlingeeef8b22008-12-29 22:12:11 +00003288 "eh_func_begin", EHFrameInfo.Number,
3289 TAI->doesRequire32BitFDEReference());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003290 Asm->EOL("FDE address range");
Duncan Sands96144f92008-05-07 19:11:09 +00003291
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003292 // If there is a personality and landing pads then point to the language
3293 // specific data area in the exception table.
3294 if (EHFrameInfo.PersonalityIndex) {
Duncan Sands96144f92008-05-07 19:11:09 +00003295 Asm->EmitULEB128Bytes(4);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003296 Asm->EOL("Augmentation size");
Duncan Sands96144f92008-05-07 19:11:09 +00003297
3298 if (EHFrameInfo.hasLandingPads)
3299 EmitReference("exception", EHFrameInfo.Number, true, true);
3300 else
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003301 Asm->EmitInt32((int)0);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003302 Asm->EOL("Language Specific Data Area");
3303 } else {
3304 Asm->EmitULEB128Bytes(0);
3305 Asm->EOL("Augmentation size");
3306 }
Duncan Sands96144f92008-05-07 19:11:09 +00003307
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003308 // Indicate locations of function specific callee saved registers in
3309 // frame.
Dale Johannesenf5a11532007-11-13 19:13:01 +00003310 EmitFrameMoves("eh_func_begin", EHFrameInfo.Number, EHFrameInfo.Moves, true);
aslc200b112008-08-16 12:57:46 +00003311
Dale Johannesen388f20f2008-04-30 00:43:29 +00003312 // On Darwin the linker honors the alignment of eh_frame, which means it
3313 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3314 // you get holes which confuse readers of eh_frame.
aslc200b112008-08-16 12:57:46 +00003315 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
Dale Johannesen837d7ab2008-04-29 22:58:20 +00003316 0, 0, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003317 EmitLabel("eh_frame_end", EHFrameInfo.Number);
aslc200b112008-08-16 12:57:46 +00003318
3319 // If the function is marked used, this table should be also. We cannot
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003320 // make the mark unconditional in this case, since retaining the table
aslc200b112008-08-16 12:57:46 +00003321 // also retains the function in this case, and there is code around
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003322 // that depends on unused functions (calling undefined externals) being
3323 // dead-stripped to link correctly. Yes, there really is.
3324 if (MMI->getUsedFunctions().count(EHFrameInfo.function))
3325 if (const char *UsedDirective = TAI->getUsedDirective())
3326 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3327 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003328 }
3329
Duncan Sands241a0c92007-09-05 11:27:52 +00003330 /// EmitExceptionTable - Emit landing pads and actions.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003331 ///
3332 /// The general organization of the table is complex, but the basic concepts
3333 /// are easy. First there is a header which describes the location and
3334 /// organization of the three components that follow.
3335 /// 1. The landing pad site information describes the range of code covered
3336 /// by the try. In our case it's an accumulation of the ranges covered
3337 /// by the invokes in the try. There is also a reference to the landing
3338 /// pad that handles the exception once processed. Finally an index into
3339 /// the actions table.
3340 /// 2. The action table, in our case, is composed of pairs of type ids
3341 /// and next action offset. Starting with the action index from the
3342 /// landing pad site, each type Id is checked for a match to the current
3343 /// exception. If it matches then the exception and type id are passed
3344 /// on to the landing pad. Otherwise the next action is looked up. This
3345 /// chain is terminated with a next action of zero. If no type id is
3346 /// found the the frame is unwound and handling continues.
3347 /// 3. Type id table contains references to all the C++ typeinfo for all
3348 /// catches in the function. This tables is reversed indexed base 1.
3349
3350 /// SharedTypeIds - How many leading type ids two landing pads have in common.
3351 static unsigned SharedTypeIds(const LandingPadInfo *L,
3352 const LandingPadInfo *R) {
3353 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3354 unsigned LSize = LIds.size(), RSize = RIds.size();
3355 unsigned MinSize = LSize < RSize ? LSize : RSize;
3356 unsigned Count = 0;
3357
3358 for (; Count != MinSize; ++Count)
3359 if (LIds[Count] != RIds[Count])
3360 return Count;
3361
3362 return Count;
3363 }
3364
3365 /// PadLT - Order landing pads lexicographically by type id.
3366 static bool PadLT(const LandingPadInfo *L, const LandingPadInfo *R) {
3367 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3368 unsigned LSize = LIds.size(), RSize = RIds.size();
3369 unsigned MinSize = LSize < RSize ? LSize : RSize;
3370
3371 for (unsigned i = 0; i != MinSize; ++i)
3372 if (LIds[i] != RIds[i])
3373 return LIds[i] < RIds[i];
3374
3375 return LSize < RSize;
3376 }
3377
3378 struct KeyInfo {
3379 static inline unsigned getEmptyKey() { return -1U; }
3380 static inline unsigned getTombstoneKey() { return -2U; }
3381 static unsigned getHashValue(const unsigned &Key) { return Key; }
Chris Lattner92eea072007-09-17 18:34:04 +00003382 static bool isEqual(unsigned LHS, unsigned RHS) { return LHS == RHS; }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003383 static bool isPod() { return true; }
3384 };
3385
Duncan Sands241a0c92007-09-05 11:27:52 +00003386 /// ActionEntry - Structure describing an entry in the actions table.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003387 struct ActionEntry {
3388 int ValueForTypeID; // The value to write - may not be equal to the type id.
3389 int NextAction;
3390 struct ActionEntry *Previous;
3391 };
3392
Duncan Sands241a0c92007-09-05 11:27:52 +00003393 /// PadRange - Structure holding a try-range and the associated landing pad.
3394 struct PadRange {
3395 // The index of the landing pad.
3396 unsigned PadIndex;
3397 // The index of the begin and end labels in the landing pad's label lists.
3398 unsigned RangeIndex;
3399 };
3400
3401 typedef DenseMap<unsigned, PadRange, KeyInfo> RangeMapType;
3402
3403 /// CallSiteEntry - Structure describing an entry in the call-site table.
3404 struct CallSiteEntry {
Duncan Sands4ff179f2007-12-19 07:36:31 +00003405 // The 'try-range' is BeginLabel .. EndLabel.
Duncan Sands241a0c92007-09-05 11:27:52 +00003406 unsigned BeginLabel; // zero indicates the start of the function.
3407 unsigned EndLabel; // zero indicates the end of the function.
Duncan Sands4ff179f2007-12-19 07:36:31 +00003408 // The landing pad starts at PadLabel.
Duncan Sands241a0c92007-09-05 11:27:52 +00003409 unsigned PadLabel; // zero indicates that there is no landing pad.
3410 unsigned Action;
3411 };
3412
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003413 void EmitExceptionTable() {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003414 const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
3415 const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
3416 const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
3417 if (PadInfos.empty()) return;
3418
3419 // Sort the landing pads in order of their type ids. This is used to fold
3420 // duplicate actions.
3421 SmallVector<const LandingPadInfo *, 64> LandingPads;
3422 LandingPads.reserve(PadInfos.size());
3423 for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
3424 LandingPads.push_back(&PadInfos[i]);
3425 std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
3426
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003427 // Negative type ids index into FilterIds, positive type ids index into
3428 // TypeInfos. The value written for a positive type id is just the type
3429 // id itself. For a negative type id, however, the value written is the
3430 // (negative) byte offset of the corresponding FilterIds entry. The byte
3431 // offset is usually equal to the type id, because the FilterIds entries
3432 // are written using a variable width encoding which outputs one byte per
3433 // entry as long as the value written is not too large, but can differ.
3434 // This kind of complication does not occur for positive type ids because
3435 // type infos are output using a fixed width encoding.
3436 // FilterOffsets[i] holds the byte offset corresponding to FilterIds[i].
3437 SmallVector<int, 16> FilterOffsets;
3438 FilterOffsets.reserve(FilterIds.size());
3439 int Offset = -1;
3440 for(std::vector<unsigned>::const_iterator I = FilterIds.begin(),
3441 E = FilterIds.end(); I != E; ++I) {
3442 FilterOffsets.push_back(Offset);
aslc200b112008-08-16 12:57:46 +00003443 Offset -= TargetAsmInfo::getULEB128Size(*I);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003444 }
3445
Duncan Sands241a0c92007-09-05 11:27:52 +00003446 // Compute the actions table and gather the first action index for each
3447 // landing pad site.
3448 SmallVector<ActionEntry, 32> Actions;
3449 SmallVector<unsigned, 64> FirstActions;
3450 FirstActions.reserve(LandingPads.size());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003451
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003452 int FirstAction = 0;
Duncan Sands241a0c92007-09-05 11:27:52 +00003453 unsigned SizeActions = 0;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003454 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3455 const LandingPadInfo *LP = LandingPads[i];
3456 const std::vector<int> &TypeIds = LP->TypeIds;
3457 const unsigned NumShared = i ? SharedTypeIds(LP, LandingPads[i-1]) : 0;
3458 unsigned SizeSiteActions = 0;
3459
3460 if (NumShared < TypeIds.size()) {
3461 unsigned SizeAction = 0;
3462 ActionEntry *PrevAction = 0;
3463
3464 if (NumShared) {
3465 const unsigned SizePrevIds = LandingPads[i-1]->TypeIds.size();
3466 assert(Actions.size());
3467 PrevAction = &Actions.back();
aslc200b112008-08-16 12:57:46 +00003468 SizeAction = TargetAsmInfo::getSLEB128Size(PrevAction->NextAction) +
3469 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003470 for (unsigned j = NumShared; j != SizePrevIds; ++j) {
aslc200b112008-08-16 12:57:46 +00003471 SizeAction -=
3472 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003473 SizeAction += -PrevAction->NextAction;
3474 PrevAction = PrevAction->Previous;
3475 }
3476 }
3477
3478 // Compute the actions.
3479 for (unsigned I = NumShared, M = TypeIds.size(); I != M; ++I) {
3480 int TypeID = TypeIds[I];
3481 assert(-1-TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
3482 int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
aslc200b112008-08-16 12:57:46 +00003483 unsigned SizeTypeID = TargetAsmInfo::getSLEB128Size(ValueForTypeID);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003484
3485 int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
aslc200b112008-08-16 12:57:46 +00003486 SizeAction = SizeTypeID + TargetAsmInfo::getSLEB128Size(NextAction);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003487 SizeSiteActions += SizeAction;
3488
3489 ActionEntry Action = {ValueForTypeID, NextAction, PrevAction};
3490 Actions.push_back(Action);
3491
3492 PrevAction = &Actions.back();
3493 }
3494
3495 // Record the first action of the landing pad site.
3496 FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
3497 } // else identical - re-use previous FirstAction
3498
3499 FirstActions.push_back(FirstAction);
3500
3501 // Compute this sites contribution to size.
3502 SizeActions += SizeSiteActions;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003503 }
Duncan Sands241a0c92007-09-05 11:27:52 +00003504
Duncan Sands4ff179f2007-12-19 07:36:31 +00003505 // Compute the call-site table. The entry for an invoke has a try-range
3506 // containing the call, a non-zero landing pad and an appropriate action.
3507 // The entry for an ordinary call has a try-range containing the call and
3508 // zero for the landing pad and the action. Calls marked 'nounwind' have
3509 // no entry and must not be contained in the try-range of any entry - they
3510 // form gaps in the table. Entries must be ordered by try-range address.
Duncan Sands241a0c92007-09-05 11:27:52 +00003511 SmallVector<CallSiteEntry, 64> CallSites;
3512
3513 RangeMapType PadMap;
Duncan Sands4ff179f2007-12-19 07:36:31 +00003514 // Invokes and nounwind calls have entries in PadMap (due to being bracketed
3515 // by try-range labels when lowered). Ordinary calls do not, so appropriate
3516 // try-ranges for them need be deduced.
Duncan Sands241a0c92007-09-05 11:27:52 +00003517 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3518 const LandingPadInfo *LandingPad = LandingPads[i];
Duncan Sands4ff179f2007-12-19 07:36:31 +00003519 for (unsigned j = 0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
Duncan Sands241a0c92007-09-05 11:27:52 +00003520 unsigned BeginLabel = LandingPad->BeginLabels[j];
3521 assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
3522 PadRange P = { i, j };
3523 PadMap[BeginLabel] = P;
3524 }
3525 }
3526
Duncan Sands4ff179f2007-12-19 07:36:31 +00003527 // The end label of the previous invoke or nounwind try-range.
Duncan Sands241a0c92007-09-05 11:27:52 +00003528 unsigned LastLabel = 0;
Duncan Sands4ff179f2007-12-19 07:36:31 +00003529
3530 // Whether there is a potentially throwing instruction (currently this means
3531 // an ordinary call) between the end of the previous try-range and now.
3532 bool SawPotentiallyThrowing = false;
3533
3534 // Whether the last callsite entry was for an invoke.
3535 bool PreviousIsInvoke = false;
3536
Duncan Sands4ff179f2007-12-19 07:36:31 +00003537 // Visit all instructions in order of address.
Duncan Sands241a0c92007-09-05 11:27:52 +00003538 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
3539 I != E; ++I) {
3540 for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
3541 MI != E; ++MI) {
Dan Gohmanfa607c92008-07-01 00:05:16 +00003542 if (!MI->isLabel()) {
Chris Lattner5b930372008-01-07 07:27:27 +00003543 SawPotentiallyThrowing |= MI->getDesc().isCall();
Duncan Sands241a0c92007-09-05 11:27:52 +00003544 continue;
3545 }
3546
Chris Lattnerda4cff12007-12-30 20:50:28 +00003547 unsigned BeginLabel = MI->getOperand(0).getImm();
Duncan Sands241a0c92007-09-05 11:27:52 +00003548 assert(BeginLabel && "Invalid label!");
Duncan Sands89372f62007-09-05 14:12:46 +00003549
Duncan Sands4ff179f2007-12-19 07:36:31 +00003550 // End of the previous try-range?
Duncan Sands89372f62007-09-05 14:12:46 +00003551 if (BeginLabel == LastLabel)
Duncan Sands4ff179f2007-12-19 07:36:31 +00003552 SawPotentiallyThrowing = false;
Duncan Sands241a0c92007-09-05 11:27:52 +00003553
Duncan Sands4ff179f2007-12-19 07:36:31 +00003554 // Beginning of a new try-range?
Duncan Sands241a0c92007-09-05 11:27:52 +00003555 RangeMapType::iterator L = PadMap.find(BeginLabel);
Duncan Sands241a0c92007-09-05 11:27:52 +00003556 if (L == PadMap.end())
Duncan Sands4ff179f2007-12-19 07:36:31 +00003557 // Nope, it was just some random label.
Duncan Sands241a0c92007-09-05 11:27:52 +00003558 continue;
3559
3560 PadRange P = L->second;
3561 const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
3562
3563 assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
3564 "Inconsistent landing pad map!");
3565
3566 // If some instruction between the previous try-range and this one may
3567 // throw, create a call-site entry with no landing pad for the region
3568 // between the try-ranges.
Duncan Sands4ff179f2007-12-19 07:36:31 +00003569 if (SawPotentiallyThrowing) {
Duncan Sands241a0c92007-09-05 11:27:52 +00003570 CallSiteEntry Site = {LastLabel, BeginLabel, 0, 0};
3571 CallSites.push_back(Site);
Duncan Sands4ff179f2007-12-19 07:36:31 +00003572 PreviousIsInvoke = false;
Duncan Sands241a0c92007-09-05 11:27:52 +00003573 }
3574
3575 LastLabel = LandingPad->EndLabels[P.RangeIndex];
Duncan Sands4ff179f2007-12-19 07:36:31 +00003576 assert(BeginLabel && LastLabel && "Invalid landing pad!");
Duncan Sands241a0c92007-09-05 11:27:52 +00003577
Duncan Sands4ff179f2007-12-19 07:36:31 +00003578 if (LandingPad->LandingPadLabel) {
3579 // This try-range is for an invoke.
3580 CallSiteEntry Site = {BeginLabel, LastLabel,
3581 LandingPad->LandingPadLabel, FirstActions[P.PadIndex]};
Duncan Sands241a0c92007-09-05 11:27:52 +00003582
Duncan Sands4ff179f2007-12-19 07:36:31 +00003583 // Try to merge with the previous call-site.
3584 if (PreviousIsInvoke) {
Dan Gohman3d436002008-06-21 22:00:54 +00003585 CallSiteEntry &Prev = CallSites.back();
Duncan Sands4ff179f2007-12-19 07:36:31 +00003586 if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
3587 // Extend the range of the previous entry.
3588 Prev.EndLabel = Site.EndLabel;
3589 continue;
3590 }
Duncan Sands241a0c92007-09-05 11:27:52 +00003591 }
Duncan Sands241a0c92007-09-05 11:27:52 +00003592
Duncan Sands4ff179f2007-12-19 07:36:31 +00003593 // Otherwise, create a new call-site.
3594 CallSites.push_back(Site);
3595 PreviousIsInvoke = true;
3596 } else {
3597 // Create a gap.
3598 PreviousIsInvoke = false;
3599 }
Duncan Sands241a0c92007-09-05 11:27:52 +00003600 }
3601 }
3602 // If some instruction between the previous try-range and the end of the
3603 // function may throw, create a call-site entry with no landing pad for the
3604 // region following the try-range.
Duncan Sands4ff179f2007-12-19 07:36:31 +00003605 if (SawPotentiallyThrowing) {
Duncan Sands241a0c92007-09-05 11:27:52 +00003606 CallSiteEntry Site = {LastLabel, 0, 0, 0};
3607 CallSites.push_back(Site);
3608 }
3609
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003610 // Final tallies.
Duncan Sands96144f92008-05-07 19:11:09 +00003611
3612 // Call sites.
3613 const unsigned SiteStartSize = sizeof(int32_t); // DW_EH_PE_udata4
3614 const unsigned SiteLengthSize = sizeof(int32_t); // DW_EH_PE_udata4
3615 const unsigned LandingPadSize = sizeof(int32_t); // DW_EH_PE_udata4
3616 unsigned SizeSites = CallSites.size() * (SiteStartSize +
3617 SiteLengthSize +
3618 LandingPadSize);
Duncan Sands241a0c92007-09-05 11:27:52 +00003619 for (unsigned i = 0, e = CallSites.size(); i < e; ++i)
aslc200b112008-08-16 12:57:46 +00003620 SizeSites += TargetAsmInfo::getULEB128Size(CallSites[i].Action);
Duncan Sands241a0c92007-09-05 11:27:52 +00003621
Duncan Sands96144f92008-05-07 19:11:09 +00003622 // Type infos.
3623 const unsigned TypeInfoSize = TD->getPointerSize(); // DW_EH_PE_absptr
3624 unsigned SizeTypes = TypeInfos.size() * TypeInfoSize;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003625
3626 unsigned TypeOffset = sizeof(int8_t) + // Call site format
aslc200b112008-08-16 12:57:46 +00003627 TargetAsmInfo::getULEB128Size(SizeSites) + // Call-site table length
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003628 SizeSites + SizeActions + SizeTypes;
3629
3630 unsigned TotalSize = sizeof(int8_t) + // LPStart format
3631 sizeof(int8_t) + // TType format
aslc200b112008-08-16 12:57:46 +00003632 TargetAsmInfo::getULEB128Size(TypeOffset) + // TType base offset
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003633 TypeOffset;
3634
3635 unsigned SizeAlign = (4 - TotalSize) & 3;
3636
3637 // Begin the exception table.
3638 Asm->SwitchToDataSection(TAI->getDwarfExceptionSection());
Evan Cheng7e7d1942008-02-29 19:36:59 +00003639 Asm->EmitAlignment(2, 0, 0, false);
Dale Johannesen841e4982008-10-08 21:50:21 +00003640 O << "GCC_except_table" << SubprogramCount << ":\n";
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003641 for (unsigned i = 0; i != SizeAlign; ++i) {
3642 Asm->EmitInt8(0);
3643 Asm->EOL("Padding");
3644 }
3645 EmitLabel("exception", SubprogramCount);
3646
3647 // Emit the header.
3648 Asm->EmitInt8(DW_EH_PE_omit);
3649 Asm->EOL("LPStart format (DW_EH_PE_omit)");
3650 Asm->EmitInt8(DW_EH_PE_absptr);
3651 Asm->EOL("TType format (DW_EH_PE_absptr)");
3652 Asm->EmitULEB128Bytes(TypeOffset);
3653 Asm->EOL("TType base offset");
3654 Asm->EmitInt8(DW_EH_PE_udata4);
3655 Asm->EOL("Call site format (DW_EH_PE_udata4)");
3656 Asm->EmitULEB128Bytes(SizeSites);
3657 Asm->EOL("Call-site table length");
3658
Duncan Sands241a0c92007-09-05 11:27:52 +00003659 // Emit the landing pad site information.
3660 for (unsigned i = 0; i < CallSites.size(); ++i) {
3661 CallSiteEntry &S = CallSites[i];
3662 const char *BeginTag;
3663 unsigned BeginNumber;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003664
Duncan Sands241a0c92007-09-05 11:27:52 +00003665 if (!S.BeginLabel) {
3666 BeginTag = "eh_func_begin";
3667 BeginNumber = SubprogramCount;
3668 } else {
3669 BeginTag = "label";
3670 BeginNumber = S.BeginLabel;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003671 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003672
Duncan Sands241a0c92007-09-05 11:27:52 +00003673 EmitSectionOffset(BeginTag, "eh_func_begin", BeginNumber, SubprogramCount,
Duncan Sands96144f92008-05-07 19:11:09 +00003674 true, true);
Duncan Sands241a0c92007-09-05 11:27:52 +00003675 Asm->EOL("Region start");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003676
Duncan Sands241a0c92007-09-05 11:27:52 +00003677 if (!S.EndLabel) {
Dale Johannesen4670be42008-01-15 23:24:56 +00003678 EmitDifference("eh_func_end", SubprogramCount, BeginTag, BeginNumber,
Duncan Sands96144f92008-05-07 19:11:09 +00003679 true);
Duncan Sands241a0c92007-09-05 11:27:52 +00003680 } else {
Duncan Sands96144f92008-05-07 19:11:09 +00003681 EmitDifference("label", S.EndLabel, BeginTag, BeginNumber, true);
Duncan Sands241a0c92007-09-05 11:27:52 +00003682 }
3683 Asm->EOL("Region length");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003684
Duncan Sands96144f92008-05-07 19:11:09 +00003685 if (!S.PadLabel)
3686 Asm->EmitInt32(0);
3687 else
Duncan Sands241a0c92007-09-05 11:27:52 +00003688 EmitSectionOffset("label", "eh_func_begin", S.PadLabel, SubprogramCount,
Duncan Sands96144f92008-05-07 19:11:09 +00003689 true, true);
Duncan Sands241a0c92007-09-05 11:27:52 +00003690 Asm->EOL("Landing pad");
3691
3692 Asm->EmitULEB128Bytes(S.Action);
3693 Asm->EOL("Action");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003694 }
3695
3696 // Emit the actions.
3697 for (unsigned I = 0, N = Actions.size(); I != N; ++I) {
3698 ActionEntry &Action = Actions[I];
3699
3700 Asm->EmitSLEB128Bytes(Action.ValueForTypeID);
3701 Asm->EOL("TypeInfo index");
3702 Asm->EmitSLEB128Bytes(Action.NextAction);
3703 Asm->EOL("Next action");
3704 }
3705
3706 // Emit the type ids.
3707 for (unsigned M = TypeInfos.size(); M; --M) {
3708 GlobalVariable *GV = TypeInfos[M - 1];
Anton Korobeynikov5ef86702007-09-02 22:07:21 +00003709
3710 PrintRelDirective();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003711
3712 if (GV)
3713 O << Asm->getGlobalLinkName(GV);
3714 else
3715 O << "0";
Duncan Sands241a0c92007-09-05 11:27:52 +00003716
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003717 Asm->EOL("TypeInfo");
3718 }
3719
3720 // Emit the filter typeids.
3721 for (unsigned j = 0, M = FilterIds.size(); j < M; ++j) {
3722 unsigned TypeID = FilterIds[j];
3723 Asm->EmitULEB128Bytes(TypeID);
3724 Asm->EOL("Filter TypeInfo index");
3725 }
Duncan Sands241a0c92007-09-05 11:27:52 +00003726
Evan Cheng7e7d1942008-02-29 19:36:59 +00003727 Asm->EmitAlignment(2, 0, 0, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003728 }
3729
3730public:
3731 //===--------------------------------------------------------------------===//
3732 // Main entry points.
3733 //
Owen Anderson847b99b2008-08-21 00:14:44 +00003734 DwarfException(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
Chris Lattnerb3876c72007-09-24 03:35:37 +00003735 : Dwarf(OS, A, T, "eh")
Dale Johannesen85535762008-04-02 00:25:04 +00003736 , shouldEmitTable(false)
3737 , shouldEmitMoves(false)
3738 , shouldEmitTableModule(false)
3739 , shouldEmitMovesModule(false)
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003740 {}
aslc200b112008-08-16 12:57:46 +00003741
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003742 virtual ~DwarfException() {}
3743
3744 /// SetModuleInfo - Set machine module information when it's known that pass
3745 /// manager has created it. Set by the target AsmPrinter.
3746 void SetModuleInfo(MachineModuleInfo *mmi) {
3747 MMI = mmi;
3748 }
3749
3750 /// BeginModule - Emit all exception information that should come prior to the
3751 /// content.
3752 void BeginModule(Module *M) {
3753 this->M = M;
3754 }
3755
3756 /// EndModule - Emit all exception information that should come after the
3757 /// content.
3758 void EndModule() {
Dale Johannesen85535762008-04-02 00:25:04 +00003759 if (shouldEmitMovesModule || shouldEmitTableModule) {
3760 const std::vector<Function *> Personalities = MMI->getPersonalities();
3761 for (unsigned i =0; i < Personalities.size(); ++i)
3762 EmitCommonEHFrame(Personalities[i], i);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003763
Dale Johannesen85535762008-04-02 00:25:04 +00003764 for (std::vector<FunctionEHFrameInfo>::iterator I = EHFrames.begin(),
3765 E = EHFrames.end(); I != E; ++I)
3766 EmitEHFrame(*I);
3767 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003768 }
3769
aslc200b112008-08-16 12:57:46 +00003770 /// BeginFunction - Gather pre-function exception information. Assumes being
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003771 /// emitted immediately after the function entry point.
3772 void BeginFunction(MachineFunction *MF) {
3773 this->MF = MF;
Dale Johannesen85535762008-04-02 00:25:04 +00003774 shouldEmitTable = shouldEmitMoves = false;
Dale Johannesen62f0a6d2008-04-02 17:04:45 +00003775 if (MMI && TAI->doesSupportExceptionHandling()) {
Dale Johannesen85535762008-04-02 00:25:04 +00003776
3777 // Map all labels and get rid of any dead landing pads.
3778 MMI->TidyLandingPads();
3779 // If any landing pads survive, we need an EH table.
3780 if (MMI->getLandingPads().size())
3781 shouldEmitTable = true;
3782
3783 // See if we need frame move info.
Duncan Sandscbc28b12008-07-04 09:55:48 +00003784 if (!MF->getFunction()->doesNotThrow() || UnwindTablesMandatory)
Dale Johannesen85535762008-04-02 00:25:04 +00003785 shouldEmitMoves = true;
3786
3787 if (shouldEmitMoves || shouldEmitTable)
3788 // Assumes in correct section after the entry point.
3789 EmitLabel("eh_func_begin", ++SubprogramCount);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003790 }
Dale Johannesen85535762008-04-02 00:25:04 +00003791 shouldEmitTableModule |= shouldEmitTable;
3792 shouldEmitMovesModule |= shouldEmitMoves;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003793 }
3794
3795 /// EndFunction - Gather and emit post-function exception information.
3796 ///
3797 void EndFunction() {
Dale Johannesen85535762008-04-02 00:25:04 +00003798 if (shouldEmitMoves || shouldEmitTable) {
3799 EmitLabel("eh_func_end", SubprogramCount);
3800 EmitExceptionTable();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003801
Dale Johannesen85535762008-04-02 00:25:04 +00003802 // Save EH frame information
3803 EHFrames.
3804 push_back(FunctionEHFrameInfo(getAsm()->getCurrentFunctionEHName(MF),
Bill Wendlingef9211a2007-09-18 01:47:22 +00003805 SubprogramCount,
3806 MMI->getPersonalityIndex(),
3807 MF->getFrameInfo()->hasCalls(),
3808 !MMI->getLandingPads().empty(),
Dale Johannesenfb3ac732007-11-20 23:24:42 +00003809 MMI->getFrameMoves(),
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003810 MF->getFunction()));
Dale Johannesen85535762008-04-02 00:25:04 +00003811 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003812 }
3813};
3814
3815} // End of namespace llvm
3816
3817//===----------------------------------------------------------------------===//
3818
3819/// Emit - Print the abbreviation using the specified Dwarf writer.
3820///
3821void DIEAbbrev::Emit(const DwarfDebug &DD) const {
3822 // Emit its Dwarf tag type.
3823 DD.getAsm()->EmitULEB128Bytes(Tag);
3824 DD.getAsm()->EOL(TagString(Tag));
aslc200b112008-08-16 12:57:46 +00003825
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003826 // Emit whether it has children DIEs.
3827 DD.getAsm()->EmitULEB128Bytes(ChildrenFlag);
3828 DD.getAsm()->EOL(ChildrenString(ChildrenFlag));
aslc200b112008-08-16 12:57:46 +00003829
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003830 // For each attribute description.
3831 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3832 const DIEAbbrevData &AttrData = Data[i];
aslc200b112008-08-16 12:57:46 +00003833
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003834 // Emit attribute type.
3835 DD.getAsm()->EmitULEB128Bytes(AttrData.getAttribute());
3836 DD.getAsm()->EOL(AttributeString(AttrData.getAttribute()));
aslc200b112008-08-16 12:57:46 +00003837
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003838 // Emit form type.
3839 DD.getAsm()->EmitULEB128Bytes(AttrData.getForm());
3840 DD.getAsm()->EOL(FormEncodingString(AttrData.getForm()));
3841 }
3842
3843 // Mark end of abbreviation.
3844 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(1)");
3845 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(2)");
3846}
3847
3848#ifndef NDEBUG
3849void DIEAbbrev::print(std::ostream &O) {
3850 O << "Abbreviation @"
3851 << std::hex << (intptr_t)this << std::dec
3852 << " "
3853 << TagString(Tag)
3854 << " "
3855 << ChildrenString(ChildrenFlag)
3856 << "\n";
aslc200b112008-08-16 12:57:46 +00003857
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003858 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3859 O << " "
3860 << AttributeString(Data[i].getAttribute())
3861 << " "
3862 << FormEncodingString(Data[i].getForm())
3863 << "\n";
3864 }
3865}
3866void DIEAbbrev::dump() { print(cerr); }
3867#endif
3868
3869//===----------------------------------------------------------------------===//
3870
3871#ifndef NDEBUG
3872void DIEValue::dump() {
3873 print(cerr);
3874}
3875#endif
3876
3877//===----------------------------------------------------------------------===//
3878
3879/// EmitValue - Emit integer of appropriate size.
3880///
3881void DIEInteger::EmitValue(DwarfDebug &DD, unsigned Form) {
3882 switch (Form) {
3883 case DW_FORM_flag: // Fall thru
3884 case DW_FORM_ref1: // Fall thru
3885 case DW_FORM_data1: DD.getAsm()->EmitInt8(Integer); break;
3886 case DW_FORM_ref2: // Fall thru
3887 case DW_FORM_data2: DD.getAsm()->EmitInt16(Integer); break;
3888 case DW_FORM_ref4: // Fall thru
3889 case DW_FORM_data4: DD.getAsm()->EmitInt32(Integer); break;
3890 case DW_FORM_ref8: // Fall thru
3891 case DW_FORM_data8: DD.getAsm()->EmitInt64(Integer); break;
3892 case DW_FORM_udata: DD.getAsm()->EmitULEB128Bytes(Integer); break;
3893 case DW_FORM_sdata: DD.getAsm()->EmitSLEB128Bytes(Integer); break;
3894 default: assert(0 && "DIE Value form not supported yet"); break;
3895 }
3896}
3897
3898/// SizeOf - Determine size of integer value in bytes.
3899///
3900unsigned DIEInteger::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3901 switch (Form) {
3902 case DW_FORM_flag: // Fall thru
3903 case DW_FORM_ref1: // Fall thru
3904 case DW_FORM_data1: return sizeof(int8_t);
3905 case DW_FORM_ref2: // Fall thru
3906 case DW_FORM_data2: return sizeof(int16_t);
3907 case DW_FORM_ref4: // Fall thru
3908 case DW_FORM_data4: return sizeof(int32_t);
3909 case DW_FORM_ref8: // Fall thru
3910 case DW_FORM_data8: return sizeof(int64_t);
aslc200b112008-08-16 12:57:46 +00003911 case DW_FORM_udata: return TargetAsmInfo::getULEB128Size(Integer);
3912 case DW_FORM_sdata: return TargetAsmInfo::getSLEB128Size(Integer);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003913 default: assert(0 && "DIE Value form not supported yet"); break;
3914 }
3915 return 0;
3916}
3917
3918//===----------------------------------------------------------------------===//
3919
3920/// EmitValue - Emit string value.
3921///
3922void DIEString::EmitValue(DwarfDebug &DD, unsigned Form) {
3923 DD.getAsm()->EmitString(String);
3924}
3925
3926//===----------------------------------------------------------------------===//
3927
3928/// EmitValue - Emit label value.
3929///
3930void DIEDwarfLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
Dan Gohman597b4842007-09-28 16:50:28 +00003931 bool IsSmall = Form == DW_FORM_data4;
3932 DD.EmitReference(Label, false, IsSmall);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003933}
3934
3935/// SizeOf - Determine size of label value in bytes.
3936///
3937unsigned DIEDwarfLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Dan Gohman597b4842007-09-28 16:50:28 +00003938 if (Form == DW_FORM_data4) return 4;
Dan Gohmancfb72b22007-09-27 23:12:31 +00003939 return DD.getTargetData()->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003940}
3941
3942//===----------------------------------------------------------------------===//
3943
3944/// EmitValue - Emit label value.
3945///
3946void DIEObjectLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
Dan Gohman597b4842007-09-28 16:50:28 +00003947 bool IsSmall = Form == DW_FORM_data4;
3948 DD.EmitReference(Label, false, IsSmall);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003949}
3950
3951/// SizeOf - Determine size of label value in bytes.
3952///
3953unsigned DIEObjectLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Dan Gohman597b4842007-09-28 16:50:28 +00003954 if (Form == DW_FORM_data4) return 4;
Dan Gohmancfb72b22007-09-27 23:12:31 +00003955 return DD.getTargetData()->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003956}
aslc200b112008-08-16 12:57:46 +00003957
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003958//===----------------------------------------------------------------------===//
3959
3960/// EmitValue - Emit delta value.
3961///
Argiris Kirtzidis03449652008-06-18 19:27:37 +00003962void DIESectionOffset::EmitValue(DwarfDebug &DD, unsigned Form) {
3963 bool IsSmall = Form == DW_FORM_data4;
3964 DD.EmitSectionOffset(Label.Tag, Section.Tag,
3965 Label.Number, Section.Number, IsSmall, IsEH, UseSet);
3966}
3967
3968/// SizeOf - Determine size of delta value in bytes.
3969///
3970unsigned DIESectionOffset::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3971 if (Form == DW_FORM_data4) return 4;
3972 return DD.getTargetData()->getPointerSize();
3973}
aslc200b112008-08-16 12:57:46 +00003974
Argiris Kirtzidis03449652008-06-18 19:27:37 +00003975//===----------------------------------------------------------------------===//
3976
3977/// EmitValue - Emit delta value.
3978///
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003979void DIEDelta::EmitValue(DwarfDebug &DD, unsigned Form) {
3980 bool IsSmall = Form == DW_FORM_data4;
3981 DD.EmitDifference(LabelHi, LabelLo, IsSmall);
3982}
3983
3984/// SizeOf - Determine size of delta value in bytes.
3985///
3986unsigned DIEDelta::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3987 if (Form == DW_FORM_data4) return 4;
Dan Gohmancfb72b22007-09-27 23:12:31 +00003988 return DD.getTargetData()->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003989}
3990
3991//===----------------------------------------------------------------------===//
3992
3993/// EmitValue - Emit debug information entry offset.
3994///
3995void DIEntry::EmitValue(DwarfDebug &DD, unsigned Form) {
3996 DD.getAsm()->EmitInt32(Entry->getOffset());
3997}
aslc200b112008-08-16 12:57:46 +00003998
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003999//===----------------------------------------------------------------------===//
4000
4001/// ComputeSize - calculate the size of the block.
4002///
4003unsigned DIEBlock::ComputeSize(DwarfDebug &DD) {
4004 if (!Size) {
Owen Anderson88dd6232008-06-24 21:44:59 +00004005 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
aslc200b112008-08-16 12:57:46 +00004006
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004007 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4008 Size += Values[i]->SizeOf(DD, AbbrevData[i].getForm());
4009 }
4010 }
4011 return Size;
4012}
4013
4014/// EmitValue - Emit block data.
4015///
4016void DIEBlock::EmitValue(DwarfDebug &DD, unsigned Form) {
4017 switch (Form) {
4018 case DW_FORM_block1: DD.getAsm()->EmitInt8(Size); break;
4019 case DW_FORM_block2: DD.getAsm()->EmitInt16(Size); break;
4020 case DW_FORM_block4: DD.getAsm()->EmitInt32(Size); break;
4021 case DW_FORM_block: DD.getAsm()->EmitULEB128Bytes(Size); break;
4022 default: assert(0 && "Improper form for block"); break;
4023 }
aslc200b112008-08-16 12:57:46 +00004024
Owen Anderson88dd6232008-06-24 21:44:59 +00004025 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004026
4027 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4028 DD.getAsm()->EOL();
4029 Values[i]->EmitValue(DD, AbbrevData[i].getForm());
4030 }
4031}
4032
4033/// SizeOf - Determine size of block data in bytes.
4034///
4035unsigned DIEBlock::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4036 switch (Form) {
4037 case DW_FORM_block1: return Size + sizeof(int8_t);
4038 case DW_FORM_block2: return Size + sizeof(int16_t);
4039 case DW_FORM_block4: return Size + sizeof(int32_t);
aslc200b112008-08-16 12:57:46 +00004040 case DW_FORM_block: return Size + TargetAsmInfo::getULEB128Size(Size);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004041 default: assert(0 && "Improper form for block"); break;
4042 }
4043 return 0;
4044}
4045
4046//===----------------------------------------------------------------------===//
4047/// DIE Implementation
4048
4049DIE::~DIE() {
4050 for (unsigned i = 0, N = Children.size(); i < N; ++i)
4051 delete Children[i];
4052}
aslc200b112008-08-16 12:57:46 +00004053
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004054/// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
4055///
4056void DIE::AddSiblingOffset() {
4057 DIEInteger *DI = new DIEInteger(0);
4058 Values.insert(Values.begin(), DI);
4059 Abbrev.AddFirstAttribute(DW_AT_sibling, DW_FORM_ref4);
4060}
4061
4062/// Profile - Used to gather unique data for the value folding set.
4063///
4064void DIE::Profile(FoldingSetNodeID &ID) {
4065 Abbrev.Profile(ID);
aslc200b112008-08-16 12:57:46 +00004066
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004067 for (unsigned i = 0, N = Children.size(); i < N; ++i)
4068 ID.AddPointer(Children[i]);
4069
4070 for (unsigned j = 0, M = Values.size(); j < M; ++j)
4071 ID.AddPointer(Values[j]);
4072}
4073
4074#ifndef NDEBUG
4075void DIE::print(std::ostream &O, unsigned IncIndent) {
4076 static unsigned IndentCount = 0;
4077 IndentCount += IncIndent;
4078 const std::string Indent(IndentCount, ' ');
4079 bool isBlock = Abbrev.getTag() == 0;
aslc200b112008-08-16 12:57:46 +00004080
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004081 if (!isBlock) {
4082 O << Indent
4083 << "Die: "
4084 << "0x" << std::hex << (intptr_t)this << std::dec
4085 << ", Offset: " << Offset
4086 << ", Size: " << Size
aslc200b112008-08-16 12:57:46 +00004087 << "\n";
4088
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004089 O << Indent
4090 << TagString(Abbrev.getTag())
4091 << " "
4092 << ChildrenString(Abbrev.getChildrenFlag());
4093 } else {
4094 O << "Size: " << Size;
4095 }
4096 O << "\n";
4097
Owen Anderson88dd6232008-06-24 21:44:59 +00004098 const SmallVector<DIEAbbrevData, 8> &Data = Abbrev.getData();
aslc200b112008-08-16 12:57:46 +00004099
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004100 IndentCount += 2;
4101 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4102 O << Indent;
Bill Wendlingdc7b5a52008-07-22 00:28:47 +00004103
4104 if (!isBlock)
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004105 O << AttributeString(Data[i].getAttribute());
Bill Wendlingdc7b5a52008-07-22 00:28:47 +00004106 else
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004107 O << "Blk[" << i << "]";
Bill Wendlingdc7b5a52008-07-22 00:28:47 +00004108
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004109 O << " "
4110 << FormEncodingString(Data[i].getForm())
4111 << " ";
4112 Values[i]->print(O);
4113 O << "\n";
4114 }
4115 IndentCount -= 2;
4116
4117 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
4118 Children[j]->print(O, 4);
4119 }
aslc200b112008-08-16 12:57:46 +00004120
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004121 if (!isBlock) O << "\n";
4122 IndentCount -= IncIndent;
4123}
4124
4125void DIE::dump() {
4126 print(cerr);
4127}
4128#endif
4129
4130//===----------------------------------------------------------------------===//
4131/// DwarfWriter Implementation
4132///
4133
Owen Anderson847b99b2008-08-21 00:14:44 +00004134DwarfWriter::DwarfWriter(raw_ostream &OS, AsmPrinter *A,
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004135 const TargetAsmInfo *T) {
4136 DE = new DwarfException(OS, A, T);
4137 DD = new DwarfDebug(OS, A, T);
4138}
4139
4140DwarfWriter::~DwarfWriter() {
4141 delete DE;
4142 delete DD;
4143}
4144
4145/// SetModuleInfo - Set machine module info when it's known that pass manager
4146/// has created it. Set by the target AsmPrinter.
4147void DwarfWriter::SetModuleInfo(MachineModuleInfo *MMI) {
4148 DD->SetModuleInfo(MMI);
4149 DE->SetModuleInfo(MMI);
4150}
4151
4152/// BeginModule - Emit all Dwarf sections that should come prior to the
4153/// content.
4154void DwarfWriter::BeginModule(Module *M) {
4155 DE->BeginModule(M);
4156 DD->BeginModule(M);
4157}
4158
4159/// EndModule - Emit all Dwarf sections that should come after the content.
4160///
4161void DwarfWriter::EndModule() {
4162 DE->EndModule();
4163 DD->EndModule();
4164}
4165
aslc200b112008-08-16 12:57:46 +00004166/// BeginFunction - Gather pre-function debug information. Assumes being
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004167/// emitted immediately after the function entry point.
4168void DwarfWriter::BeginFunction(MachineFunction *MF) {
4169 DE->BeginFunction(MF);
4170 DD->BeginFunction(MF);
4171}
4172
4173/// EndFunction - Gather and emit post-function debug information.
4174///
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00004175void DwarfWriter::EndFunction(MachineFunction *MF) {
4176 DD->EndFunction(MF);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004177 DE->EndFunction();
aslc200b112008-08-16 12:57:46 +00004178
Bill Wendling5b4796a2008-07-22 00:53:37 +00004179 if (MachineModuleInfo *MMI = DD->getMMI() ? DD->getMMI() : DE->getMMI())
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004180 // Clear function debug information.
4181 MMI->EndFunction();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004182}