blob: 3cfe00e7e07ad6ceea530882ae0fb81fa56a26bd [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"
26#include "llvm/Support/Debug.h"
27#include "llvm/Support/Dwarf.h"
28#include "llvm/Support/CommandLine.h"
29#include "llvm/Support/DataTypes.h"
30#include "llvm/Support/Mangler.h"
Owen Anderson847b99b2008-08-21 00:14:44 +000031#include "llvm/Support/raw_ostream.h"
Dan Gohman80bbde72007-09-24 21:32:18 +000032#include "llvm/System/Path.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000033#include "llvm/Target/TargetAsmInfo.h"
Dan Gohman1e57df32008-02-10 18:45:23 +000034#include "llvm/Target/TargetRegisterInfo.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000035#include "llvm/Target/TargetData.h"
36#include "llvm/Target/TargetFrameInfo.h"
37#include "llvm/Target/TargetInstrInfo.h"
38#include "llvm/Target/TargetMachine.h"
39#include "llvm/Target/TargetOptions.h"
40#include <ostream>
41#include <string>
42using namespace llvm;
43using namespace llvm::dwarf;
44
45namespace llvm {
aslc200b112008-08-16 12:57:46 +000046
Dan Gohmanf17a25c2007-07-18 16:29:46 +000047//===----------------------------------------------------------------------===//
48
49/// Configuration values for initial hash set sizes (log2).
50///
51static const unsigned InitDiesSetSize = 9; // 512
52static const unsigned InitAbbreviationsSetSize = 9; // 512
53static const unsigned InitValuesSetSize = 9; // 512
54
55//===----------------------------------------------------------------------===//
56/// Forward declarations.
57///
58class DIE;
59class DIEValue;
60
61//===----------------------------------------------------------------------===//
62/// DWLabel - Labels are used to track locations in the assembler file.
aslc200b112008-08-16 12:57:46 +000063/// Labels appear in the form @verbatim <prefix><Tag><Number> @endverbatim,
64/// where the tag is a category of label (Ex. location) and number is a value
Reid Spencer37c7cea2007-08-05 20:06:04 +000065/// unique in that category.
Dan Gohmanf17a25c2007-07-18 16:29:46 +000066class DWLabel {
67public:
68 /// Tag - Label category tag. Should always be a staticly declared C string.
69 ///
70 const char *Tag;
aslc200b112008-08-16 12:57:46 +000071
Dan Gohmanf17a25c2007-07-18 16:29:46 +000072 /// Number - Value to make label unique.
73 ///
74 unsigned Number;
75
76 DWLabel(const char *T, unsigned N) : Tag(T), Number(N) {}
aslc200b112008-08-16 12:57:46 +000077
Dan Gohmanf17a25c2007-07-18 16:29:46 +000078 void Profile(FoldingSetNodeID &ID) const {
79 ID.AddString(std::string(Tag));
80 ID.AddInteger(Number);
81 }
aslc200b112008-08-16 12:57:46 +000082
Dan Gohmanf17a25c2007-07-18 16:29:46 +000083#ifndef NDEBUG
84 void print(std::ostream *O) const {
85 if (O) print(*O);
86 }
87 void print(std::ostream &O) const {
88 O << "." << Tag;
89 if (Number) O << Number;
90 }
91#endif
92};
93
94//===----------------------------------------------------------------------===//
95/// DIEAbbrevData - Dwarf abbreviation data, describes the one attribute of a
96/// Dwarf abbreviation.
97class DIEAbbrevData {
98private:
99 /// Attribute - Dwarf attribute code.
100 ///
101 unsigned Attribute;
aslc200b112008-08-16 12:57:46 +0000102
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000103 /// Form - Dwarf form code.
aslc200b112008-08-16 12:57:46 +0000104 ///
105 unsigned Form;
106
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000107public:
108 DIEAbbrevData(unsigned A, unsigned F)
109 : Attribute(A)
110 , Form(F)
111 {}
aslc200b112008-08-16 12:57:46 +0000112
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000113 // Accessors.
114 unsigned getAttribute() const { return Attribute; }
115 unsigned getForm() const { return Form; }
116
117 /// Profile - Used to gather unique data for the abbreviation folding set.
118 ///
119 void Profile(FoldingSetNodeID &ID)const {
120 ID.AddInteger(Attribute);
121 ID.AddInteger(Form);
122 }
123};
124
125//===----------------------------------------------------------------------===//
126/// DIEAbbrev - Dwarf abbreviation, describes the organization of a debug
127/// information object.
128class DIEAbbrev : public FoldingSetNode {
129private:
130 /// Tag - Dwarf tag code.
131 ///
132 unsigned Tag;
aslc200b112008-08-16 12:57:46 +0000133
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000134 /// Unique number for node.
135 ///
136 unsigned Number;
137
138 /// ChildrenFlag - Dwarf children flag.
139 ///
140 unsigned ChildrenFlag;
141
142 /// Data - Raw data bytes for abbreviation.
143 ///
Owen Anderson88dd6232008-06-24 21:44:59 +0000144 SmallVector<DIEAbbrevData, 8> Data;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000145
146public:
147
148 DIEAbbrev(unsigned T, unsigned C)
149 : Tag(T)
150 , ChildrenFlag(C)
151 , Data()
152 {}
153 ~DIEAbbrev() {}
aslc200b112008-08-16 12:57:46 +0000154
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000155 // Accessors.
156 unsigned getTag() const { return Tag; }
157 unsigned getNumber() const { return Number; }
158 unsigned getChildrenFlag() const { return ChildrenFlag; }
Owen Anderson88dd6232008-06-24 21:44:59 +0000159 const SmallVector<DIEAbbrevData, 8> &getData() const { return Data; }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000160 void setTag(unsigned T) { Tag = T; }
161 void setChildrenFlag(unsigned CF) { ChildrenFlag = CF; }
162 void setNumber(unsigned N) { Number = N; }
aslc200b112008-08-16 12:57:46 +0000163
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000164 /// AddAttribute - Adds another set of attribute information to the
165 /// abbreviation.
166 void AddAttribute(unsigned Attribute, unsigned Form) {
167 Data.push_back(DIEAbbrevData(Attribute, Form));
168 }
aslc200b112008-08-16 12:57:46 +0000169
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000170 /// AddFirstAttribute - Adds a set of attribute information to the front
171 /// of the abbreviation.
172 void AddFirstAttribute(unsigned Attribute, unsigned Form) {
173 Data.insert(Data.begin(), DIEAbbrevData(Attribute, Form));
174 }
aslc200b112008-08-16 12:57:46 +0000175
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000176 /// Profile - Used to gather unique data for the abbreviation folding set.
177 ///
178 void Profile(FoldingSetNodeID &ID) {
179 ID.AddInteger(Tag);
180 ID.AddInteger(ChildrenFlag);
aslc200b112008-08-16 12:57:46 +0000181
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000182 // For each attribute description.
183 for (unsigned i = 0, N = Data.size(); i < N; ++i)
184 Data[i].Profile(ID);
185 }
aslc200b112008-08-16 12:57:46 +0000186
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000187 /// Emit - Print the abbreviation using the specified Dwarf writer.
188 ///
aslc200b112008-08-16 12:57:46 +0000189 void Emit(const DwarfDebug &DD) const;
190
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000191#ifndef NDEBUG
192 void print(std::ostream *O) {
193 if (O) print(*O);
194 }
195 void print(std::ostream &O);
196 void dump();
197#endif
198};
199
200//===----------------------------------------------------------------------===//
201/// DIE - A structured debug information entry. Has an abbreviation which
202/// describes it's organization.
203class DIE : public FoldingSetNode {
204protected:
205 /// Abbrev - Buffer for constructing abbreviation.
206 ///
207 DIEAbbrev Abbrev;
aslc200b112008-08-16 12:57:46 +0000208
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000209 /// Offset - Offset in debug info section.
210 ///
211 unsigned Offset;
aslc200b112008-08-16 12:57:46 +0000212
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000213 /// Size - Size of instance + children.
214 ///
215 unsigned Size;
aslc200b112008-08-16 12:57:46 +0000216
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000217 /// Children DIEs.
218 ///
219 std::vector<DIE *> Children;
aslc200b112008-08-16 12:57:46 +0000220
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000221 /// Attributes values.
222 ///
Owen Anderson88dd6232008-06-24 21:44:59 +0000223 SmallVector<DIEValue*, 32> Values;
aslc200b112008-08-16 12:57:46 +0000224
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000225public:
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000226 explicit DIE(unsigned Tag)
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000227 : Abbrev(Tag, DW_CHILDREN_no)
228 , Offset(0)
229 , Size(0)
230 , Children()
231 , Values()
232 {}
233 virtual ~DIE();
aslc200b112008-08-16 12:57:46 +0000234
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000235 // Accessors.
236 DIEAbbrev &getAbbrev() { return Abbrev; }
237 unsigned getAbbrevNumber() const {
238 return Abbrev.getNumber();
239 }
240 unsigned getTag() const { return Abbrev.getTag(); }
241 unsigned getOffset() const { return Offset; }
242 unsigned getSize() const { return Size; }
243 const std::vector<DIE *> &getChildren() const { return Children; }
Owen Anderson88dd6232008-06-24 21:44:59 +0000244 SmallVector<DIEValue*, 32> &getValues() { return Values; }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000245 void setTag(unsigned Tag) { Abbrev.setTag(Tag); }
246 void setOffset(unsigned O) { Offset = O; }
247 void setSize(unsigned S) { Size = S; }
aslc200b112008-08-16 12:57:46 +0000248
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000249 /// AddValue - Add a value and attributes to a DIE.
250 ///
251 void AddValue(unsigned Attribute, unsigned Form, DIEValue *Value) {
252 Abbrev.AddAttribute(Attribute, Form);
253 Values.push_back(Value);
254 }
aslc200b112008-08-16 12:57:46 +0000255
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000256 /// SiblingOffset - Return the offset of the debug information entry's
257 /// sibling.
258 unsigned SiblingOffset() const { return Offset + Size; }
aslc200b112008-08-16 12:57:46 +0000259
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000260 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
261 ///
262 void AddSiblingOffset();
263
264 /// AddChild - Add a child to the DIE.
265 ///
266 void AddChild(DIE *Child) {
267 Abbrev.setChildrenFlag(DW_CHILDREN_yes);
268 Children.push_back(Child);
269 }
aslc200b112008-08-16 12:57:46 +0000270
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000271 /// Detach - Detaches objects connected to it after copying.
272 ///
273 void Detach() {
274 Children.clear();
275 }
aslc200b112008-08-16 12:57:46 +0000276
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000277 /// Profile - Used to gather unique data for the value folding set.
278 ///
279 void Profile(FoldingSetNodeID &ID) ;
aslc200b112008-08-16 12:57:46 +0000280
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000281#ifndef NDEBUG
282 void print(std::ostream *O, unsigned IncIndent = 0) {
283 if (O) print(*O, IncIndent);
284 }
285 void print(std::ostream &O, unsigned IncIndent = 0);
286 void dump();
287#endif
288};
289
290//===----------------------------------------------------------------------===//
291/// DIEValue - A debug information entry value.
292///
293class DIEValue : public FoldingSetNode {
294public:
295 enum {
296 isInteger,
297 isString,
298 isLabel,
299 isAsIsLabel,
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000300 isSectionOffset,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000301 isDelta,
302 isEntry,
303 isBlock
304 };
aslc200b112008-08-16 12:57:46 +0000305
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000306 /// Type - Type of data stored in the value.
307 ///
308 unsigned Type;
aslc200b112008-08-16 12:57:46 +0000309
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000310 explicit DIEValue(unsigned T)
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000311 : Type(T)
312 {}
313 virtual ~DIEValue() {}
aslc200b112008-08-16 12:57:46 +0000314
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000315 // Accessors
316 unsigned getType() const { return Type; }
aslc200b112008-08-16 12:57:46 +0000317
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000318 // Implement isa/cast/dyncast.
319 static bool classof(const DIEValue *) { return true; }
aslc200b112008-08-16 12:57:46 +0000320
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000321 /// EmitValue - Emit value via the Dwarf writer.
322 ///
323 virtual void EmitValue(DwarfDebug &DD, unsigned Form) = 0;
aslc200b112008-08-16 12:57:46 +0000324
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000325 /// SizeOf - Return the size of a value in bytes.
326 ///
327 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const = 0;
aslc200b112008-08-16 12:57:46 +0000328
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000329 /// Profile - Used to gather unique data for the value folding set.
330 ///
331 virtual void Profile(FoldingSetNodeID &ID) = 0;
aslc200b112008-08-16 12:57:46 +0000332
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000333#ifndef NDEBUG
334 void print(std::ostream *O) {
335 if (O) print(*O);
336 }
337 virtual void print(std::ostream &O) = 0;
338 void dump();
339#endif
340};
341
342//===----------------------------------------------------------------------===//
343/// DWInteger - An integer value DIE.
aslc200b112008-08-16 12:57:46 +0000344///
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000345class DIEInteger : public DIEValue {
346private:
347 uint64_t Integer;
aslc200b112008-08-16 12:57:46 +0000348
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000349public:
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000350 explicit DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000351
352 // Implement isa/cast/dyncast.
353 static bool classof(const DIEInteger *) { return true; }
354 static bool classof(const DIEValue *I) { return I->Type == isInteger; }
aslc200b112008-08-16 12:57:46 +0000355
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000356 /// BestForm - Choose the best form for integer.
357 ///
358 static unsigned BestForm(bool IsSigned, uint64_t Integer) {
359 if (IsSigned) {
360 if ((char)Integer == (signed)Integer) return DW_FORM_data1;
361 if ((short)Integer == (signed)Integer) return DW_FORM_data2;
362 if ((int)Integer == (signed)Integer) return DW_FORM_data4;
363 } else {
364 if ((unsigned char)Integer == Integer) return DW_FORM_data1;
365 if ((unsigned short)Integer == Integer) return DW_FORM_data2;
366 if ((unsigned int)Integer == Integer) return DW_FORM_data4;
367 }
368 return DW_FORM_data8;
369 }
aslc200b112008-08-16 12:57:46 +0000370
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000371 /// EmitValue - Emit integer of appropriate size.
372 ///
373 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000374
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000375 /// SizeOf - Determine size of integer value in bytes.
376 ///
377 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000378
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000379 /// Profile - Used to gather unique data for the value folding set.
380 ///
381 static void Profile(FoldingSetNodeID &ID, unsigned Integer) {
382 ID.AddInteger(isInteger);
383 ID.AddInteger(Integer);
384 }
385 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Integer); }
aslc200b112008-08-16 12:57:46 +0000386
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000387#ifndef NDEBUG
388 virtual void print(std::ostream &O) {
389 O << "Int: " << (int64_t)Integer
390 << " 0x" << std::hex << Integer << std::dec;
391 }
392#endif
393};
394
395//===----------------------------------------------------------------------===//
396/// DIEString - A string value DIE.
aslc200b112008-08-16 12:57:46 +0000397///
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000398class DIEString : public DIEValue {
399public:
400 const std::string String;
aslc200b112008-08-16 12:57:46 +0000401
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000402 explicit DIEString(const std::string &S) : DIEValue(isString), String(S) {}
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000403
404 // Implement isa/cast/dyncast.
405 static bool classof(const DIEString *) { return true; }
406 static bool classof(const DIEValue *S) { return S->Type == isString; }
aslc200b112008-08-16 12:57:46 +0000407
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000408 /// EmitValue - Emit string value.
409 ///
410 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000411
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000412 /// SizeOf - Determine size of string value in bytes.
413 ///
414 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
415 return String.size() + sizeof(char); // sizeof('\0');
416 }
aslc200b112008-08-16 12:57:46 +0000417
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000418 /// Profile - Used to gather unique data for the value folding set.
419 ///
420 static void Profile(FoldingSetNodeID &ID, const std::string &String) {
421 ID.AddInteger(isString);
422 ID.AddString(String);
423 }
424 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, String); }
aslc200b112008-08-16 12:57:46 +0000425
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000426#ifndef NDEBUG
427 virtual void print(std::ostream &O) {
428 O << "Str: \"" << String << "\"";
429 }
430#endif
431};
432
433//===----------------------------------------------------------------------===//
434/// DIEDwarfLabel - A Dwarf internal label expression DIE.
435//
436class DIEDwarfLabel : public DIEValue {
437public:
438
439 const DWLabel Label;
aslc200b112008-08-16 12:57:46 +0000440
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000441 explicit DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {}
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000442
443 // Implement isa/cast/dyncast.
444 static bool classof(const DIEDwarfLabel *) { return true; }
445 static bool classof(const DIEValue *L) { return L->Type == isLabel; }
aslc200b112008-08-16 12:57:46 +0000446
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000447 /// EmitValue - Emit label value.
448 ///
449 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000450
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000451 /// SizeOf - Determine size of label value in bytes.
452 ///
453 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000454
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000455 /// Profile - Used to gather unique data for the value folding set.
456 ///
457 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label) {
458 ID.AddInteger(isLabel);
459 Label.Profile(ID);
460 }
461 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
aslc200b112008-08-16 12:57:46 +0000462
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000463#ifndef NDEBUG
464 virtual void print(std::ostream &O) {
465 O << "Lbl: ";
466 Label.print(O);
467 }
468#endif
469};
470
471
472//===----------------------------------------------------------------------===//
473/// DIEObjectLabel - A label to an object in code or data.
474//
475class DIEObjectLabel : public DIEValue {
476public:
477 const std::string Label;
aslc200b112008-08-16 12:57:46 +0000478
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000479 explicit DIEObjectLabel(const std::string &L)
480 : DIEValue(isAsIsLabel), Label(L) {}
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000481
482 // Implement isa/cast/dyncast.
483 static bool classof(const DIEObjectLabel *) { return true; }
484 static bool classof(const DIEValue *L) { return L->Type == isAsIsLabel; }
aslc200b112008-08-16 12:57:46 +0000485
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000486 /// EmitValue - Emit label value.
487 ///
488 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000489
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000490 /// SizeOf - Determine size of label value in bytes.
491 ///
492 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000493
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000494 /// Profile - Used to gather unique data for the value folding set.
495 ///
496 static void Profile(FoldingSetNodeID &ID, const std::string &Label) {
497 ID.AddInteger(isAsIsLabel);
498 ID.AddString(Label);
499 }
500 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
501
502#ifndef NDEBUG
503 virtual void print(std::ostream &O) {
504 O << "Obj: " << Label;
505 }
506#endif
507};
508
509//===----------------------------------------------------------------------===//
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000510/// DIESectionOffset - A section offset DIE.
511//
512class DIESectionOffset : public DIEValue {
513public:
514 const DWLabel Label;
515 const DWLabel Section;
516 bool IsEH : 1;
517 bool UseSet : 1;
aslc200b112008-08-16 12:57:46 +0000518
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000519 DIESectionOffset(const DWLabel &Lab, const DWLabel &Sec,
520 bool isEH = false, bool useSet = true)
521 : DIEValue(isSectionOffset), Label(Lab), Section(Sec),
522 IsEH(isEH), UseSet(useSet) {}
523
524 // Implement isa/cast/dyncast.
525 static bool classof(const DIESectionOffset *) { return true; }
526 static bool classof(const DIEValue *D) { return D->Type == isSectionOffset; }
aslc200b112008-08-16 12:57:46 +0000527
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000528 /// EmitValue - Emit section offset.
529 ///
530 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000531
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000532 /// SizeOf - Determine size of section offset value in bytes.
533 ///
534 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000535
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000536 /// Profile - Used to gather unique data for the value folding set.
537 ///
538 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label,
539 const DWLabel &Section) {
540 ID.AddInteger(isSectionOffset);
541 Label.Profile(ID);
542 Section.Profile(ID);
543 // IsEH and UseSet are specific to the Label/Section that we will emit
544 // the offset for; so Label/Section are enough for uniqueness.
545 }
546 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label, Section); }
547
548#ifndef NDEBUG
549 virtual void print(std::ostream &O) {
550 O << "Off: ";
551 Label.print(O);
552 O << "-";
553 Section.print(O);
554 O << "-" << IsEH << "-" << UseSet;
555 }
556#endif
557};
558
559//===----------------------------------------------------------------------===//
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000560/// DIEDelta - A simple label difference DIE.
aslc200b112008-08-16 12:57:46 +0000561///
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000562class DIEDelta : public DIEValue {
563public:
564 const DWLabel LabelHi;
565 const DWLabel LabelLo;
aslc200b112008-08-16 12:57:46 +0000566
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000567 DIEDelta(const DWLabel &Hi, const DWLabel &Lo)
568 : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
569
570 // Implement isa/cast/dyncast.
571 static bool classof(const DIEDelta *) { return true; }
572 static bool classof(const DIEValue *D) { return D->Type == isDelta; }
aslc200b112008-08-16 12:57:46 +0000573
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000574 /// EmitValue - Emit delta value.
575 ///
576 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000577
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000578 /// SizeOf - Determine size of delta value in bytes.
579 ///
580 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000581
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000582 /// Profile - Used to gather unique data for the value folding set.
583 ///
584 static void Profile(FoldingSetNodeID &ID, const DWLabel &LabelHi,
585 const DWLabel &LabelLo) {
586 ID.AddInteger(isDelta);
587 LabelHi.Profile(ID);
588 LabelLo.Profile(ID);
589 }
590 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, LabelHi, LabelLo); }
591
592#ifndef NDEBUG
593 virtual void print(std::ostream &O) {
594 O << "Del: ";
595 LabelHi.print(O);
596 O << "-";
597 LabelLo.print(O);
598 }
599#endif
600};
601
602//===----------------------------------------------------------------------===//
603/// DIEntry - A pointer to another debug information entry. An instance of this
604/// class can also be used as a proxy for a debug information entry not yet
605/// defined (ie. types.)
606class DIEntry : public DIEValue {
607public:
608 DIE *Entry;
aslc200b112008-08-16 12:57:46 +0000609
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000610 explicit DIEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
aslc200b112008-08-16 12:57:46 +0000611
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000612 // Implement isa/cast/dyncast.
613 static bool classof(const DIEntry *) { return true; }
614 static bool classof(const DIEValue *E) { return E->Type == isEntry; }
aslc200b112008-08-16 12:57:46 +0000615
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000616 /// EmitValue - Emit debug information entry offset.
617 ///
618 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000619
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000620 /// SizeOf - Determine size of debug information entry in bytes.
621 ///
622 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
623 return sizeof(int32_t);
624 }
aslc200b112008-08-16 12:57:46 +0000625
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000626 /// Profile - Used to gather unique data for the value folding set.
627 ///
628 static void Profile(FoldingSetNodeID &ID, DIE *Entry) {
629 ID.AddInteger(isEntry);
630 ID.AddPointer(Entry);
631 }
632 virtual void Profile(FoldingSetNodeID &ID) {
633 ID.AddInteger(isEntry);
aslc200b112008-08-16 12:57:46 +0000634
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000635 if (Entry) {
636 ID.AddPointer(Entry);
637 } else {
638 ID.AddPointer(this);
639 }
640 }
aslc200b112008-08-16 12:57:46 +0000641
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000642#ifndef NDEBUG
643 virtual void print(std::ostream &O) {
644 O << "Die: 0x" << std::hex << (intptr_t)Entry << std::dec;
645 }
646#endif
647};
648
649//===----------------------------------------------------------------------===//
650/// DIEBlock - A block of values. Primarily used for location expressions.
651//
652class DIEBlock : public DIEValue, public DIE {
653public:
654 unsigned Size; // Size in bytes excluding size header.
aslc200b112008-08-16 12:57:46 +0000655
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000656 DIEBlock()
657 : DIEValue(isBlock)
658 , DIE(0)
659 , Size(0)
660 {}
661 ~DIEBlock() {
662 }
aslc200b112008-08-16 12:57:46 +0000663
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000664 // Implement isa/cast/dyncast.
665 static bool classof(const DIEBlock *) { return true; }
666 static bool classof(const DIEValue *E) { return E->Type == isBlock; }
aslc200b112008-08-16 12:57:46 +0000667
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000668 /// ComputeSize - calculate the size of the block.
669 ///
670 unsigned ComputeSize(DwarfDebug &DD);
aslc200b112008-08-16 12:57:46 +0000671
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000672 /// BestForm - Choose the best form for data.
673 ///
674 unsigned BestForm() const {
675 if ((unsigned char)Size == Size) return DW_FORM_block1;
676 if ((unsigned short)Size == Size) return DW_FORM_block2;
677 if ((unsigned int)Size == Size) return DW_FORM_block4;
678 return DW_FORM_block;
679 }
680
681 /// EmitValue - Emit block data.
682 ///
683 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000684
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000685 /// SizeOf - Determine size of block data in bytes.
686 ///
687 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000688
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000689
690 /// Profile - Used to gather unique data for the value folding set.
691 ///
692 virtual void Profile(FoldingSetNodeID &ID) {
693 ID.AddInteger(isBlock);
694 DIE::Profile(ID);
695 }
aslc200b112008-08-16 12:57:46 +0000696
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000697#ifndef NDEBUG
698 virtual void print(std::ostream &O) {
699 O << "Blk: ";
700 DIE::print(O, 5);
701 }
702#endif
703};
704
705//===----------------------------------------------------------------------===//
706/// CompileUnit - This dwarf writer support class manages information associate
707/// with a source file.
708class CompileUnit {
709private:
710 /// Desc - Compile unit debug descriptor.
711 ///
712 CompileUnitDesc *Desc;
aslc200b112008-08-16 12:57:46 +0000713
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000714 /// ID - File identifier for source.
715 ///
716 unsigned ID;
aslc200b112008-08-16 12:57:46 +0000717
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000718 /// Die - Compile unit debug information entry.
719 ///
720 DIE *Die;
aslc200b112008-08-16 12:57:46 +0000721
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000722 /// DescToDieMap - Tracks the mapping of unit level debug informaton
723 /// descriptors to debug information entries.
724 std::map<DebugInfoDesc *, DIE *> DescToDieMap;
725
726 /// DescToDIEntryMap - Tracks the mapping of unit level debug informaton
727 /// descriptors to debug information entries using a DIEntry proxy.
728 std::map<DebugInfoDesc *, DIEntry *> DescToDIEntryMap;
729
730 /// Globals - A map of globally visible named entities for this unit.
731 ///
732 std::map<std::string, DIE *> Globals;
733
734 /// DiesSet - Used to uniquely define dies within the compile unit.
735 ///
736 FoldingSet<DIE> DiesSet;
aslc200b112008-08-16 12:57:46 +0000737
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000738 /// Dies - List of all dies in the compile unit.
739 ///
740 std::vector<DIE *> Dies;
aslc200b112008-08-16 12:57:46 +0000741
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000742public:
743 CompileUnit(CompileUnitDesc *CUD, unsigned I, DIE *D)
744 : Desc(CUD)
745 , ID(I)
746 , Die(D)
747 , DescToDieMap()
748 , DescToDIEntryMap()
749 , Globals()
750 , DiesSet(InitDiesSetSize)
751 , Dies()
752 {}
aslc200b112008-08-16 12:57:46 +0000753
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000754 ~CompileUnit() {
755 delete Die;
aslc200b112008-08-16 12:57:46 +0000756
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000757 for (unsigned i = 0, N = Dies.size(); i < N; ++i)
758 delete Dies[i];
759 }
aslc200b112008-08-16 12:57:46 +0000760
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000761 // Accessors.
762 CompileUnitDesc *getDesc() const { return Desc; }
763 unsigned getID() const { return ID; }
764 DIE* getDie() const { return Die; }
765 std::map<std::string, DIE *> &getGlobals() { return Globals; }
766
767 /// hasContent - Return true if this compile unit has something to write out.
768 ///
769 bool hasContent() const {
770 return !Die->getChildren().empty();
771 }
772
773 /// AddGlobal - Add a new global entity to the compile unit.
774 ///
775 void AddGlobal(const std::string &Name, DIE *Die) {
776 Globals[Name] = Die;
777 }
aslc200b112008-08-16 12:57:46 +0000778
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000779 /// getDieMapSlotFor - Returns the debug information entry map slot for the
780 /// specified debug descriptor.
781 DIE *&getDieMapSlotFor(DebugInfoDesc *DID) {
782 return DescToDieMap[DID];
783 }
aslc200b112008-08-16 12:57:46 +0000784
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000785 /// getDIEntrySlotFor - Returns the debug information entry proxy slot for the
786 /// specified debug descriptor.
787 DIEntry *&getDIEntrySlotFor(DebugInfoDesc *DID) {
788 return DescToDIEntryMap[DID];
789 }
aslc200b112008-08-16 12:57:46 +0000790
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000791 /// AddDie - Adds or interns the DIE to the compile unit.
792 ///
793 DIE *AddDie(DIE &Buffer) {
794 FoldingSetNodeID ID;
795 Buffer.Profile(ID);
796 void *Where;
797 DIE *Die = DiesSet.FindNodeOrInsertPos(ID, Where);
aslc200b112008-08-16 12:57:46 +0000798
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000799 if (!Die) {
800 Die = new DIE(Buffer);
801 DiesSet.InsertNode(Die, Where);
802 this->Die->AddChild(Die);
803 Buffer.Detach();
804 }
aslc200b112008-08-16 12:57:46 +0000805
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000806 return Die;
807 }
808};
809
810//===----------------------------------------------------------------------===//
aslc200b112008-08-16 12:57:46 +0000811/// Dwarf - Emits general Dwarf directives.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000812///
813class Dwarf {
814
815protected:
816
817 //===--------------------------------------------------------------------===//
818 // Core attributes used by the Dwarf writer.
819 //
aslc200b112008-08-16 12:57:46 +0000820
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000821 //
822 /// O - Stream to .s file.
823 ///
Owen Anderson847b99b2008-08-21 00:14:44 +0000824 raw_ostream &O;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000825
826 /// Asm - Target of Dwarf emission.
827 ///
828 AsmPrinter *Asm;
aslc200b112008-08-16 12:57:46 +0000829
Bill Wendlingac9639d2008-07-01 23:34:48 +0000830 /// TAI - Target asm information.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000831 const TargetAsmInfo *TAI;
aslc200b112008-08-16 12:57:46 +0000832
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000833 /// TD - Target data.
834 const TargetData *TD;
aslc200b112008-08-16 12:57:46 +0000835
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000836 /// RI - Register Information.
Dan Gohman1e57df32008-02-10 18:45:23 +0000837 const TargetRegisterInfo *RI;
aslc200b112008-08-16 12:57:46 +0000838
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000839 /// M - Current module.
840 ///
841 Module *M;
aslc200b112008-08-16 12:57:46 +0000842
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000843 /// MF - Current machine function.
844 ///
845 MachineFunction *MF;
aslc200b112008-08-16 12:57:46 +0000846
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000847 /// MMI - Collected machine module information.
848 ///
849 MachineModuleInfo *MMI;
aslc200b112008-08-16 12:57:46 +0000850
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000851 /// SubprogramCount - The running count of functions being compiled.
852 ///
853 unsigned SubprogramCount;
aslc200b112008-08-16 12:57:46 +0000854
Chris Lattnerb3876c72007-09-24 03:35:37 +0000855 /// Flavor - A unique string indicating what dwarf producer this is, used to
856 /// unique labels.
857 const char * const Flavor;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000858
859 unsigned SetCounter;
Owen Anderson847b99b2008-08-21 00:14:44 +0000860 Dwarf(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T,
Chris Lattnerb3876c72007-09-24 03:35:37 +0000861 const char *flavor)
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000862 : O(OS)
863 , Asm(A)
864 , TAI(T)
865 , TD(Asm->TM.getTargetData())
866 , RI(Asm->TM.getRegisterInfo())
867 , M(NULL)
868 , MF(NULL)
869 , MMI(NULL)
870 , SubprogramCount(0)
Chris Lattnerb3876c72007-09-24 03:35:37 +0000871 , Flavor(flavor)
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000872 , SetCounter(1)
873 {
874 }
875
876public:
877
878 //===--------------------------------------------------------------------===//
879 // Accessors.
880 //
881 AsmPrinter *getAsm() const { return Asm; }
882 MachineModuleInfo *getMMI() const { return MMI; }
883 const TargetAsmInfo *getTargetAsmInfo() const { return TAI; }
Dan Gohmancfb72b22007-09-27 23:12:31 +0000884 const TargetData *getTargetData() const { return TD; }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000885
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000886 void PrintRelDirective(bool Force32Bit = false, bool isInSection = false)
887 const {
888 if (isInSection && TAI->getDwarfSectionOffsetDirective())
889 O << TAI->getDwarfSectionOffsetDirective();
Dan Gohmancfb72b22007-09-27 23:12:31 +0000890 else if (Force32Bit || TD->getPointerSize() == sizeof(int32_t))
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000891 O << TAI->getData32bitsDirective();
892 else
893 O << TAI->getData64bitsDirective();
894 }
aslc200b112008-08-16 12:57:46 +0000895
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000896 /// PrintLabelName - Print label name in form used by Dwarf writer.
897 ///
898 void PrintLabelName(DWLabel Label) const {
899 PrintLabelName(Label.Tag, Label.Number);
900 }
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000901 void PrintLabelName(const char *Tag, unsigned Number) const {
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000902 O << TAI->getPrivateGlobalPrefix() << Tag;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000903 if (Number) O << Number;
904 }
aslc200b112008-08-16 12:57:46 +0000905
Chris Lattnerb3876c72007-09-24 03:35:37 +0000906 void PrintLabelName(const char *Tag, unsigned Number,
907 const char *Suffix) const {
908 O << TAI->getPrivateGlobalPrefix() << Tag;
909 if (Number) O << Number;
910 O << Suffix;
911 }
aslc200b112008-08-16 12:57:46 +0000912
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000913 /// EmitLabel - Emit location label for internal use by Dwarf.
914 ///
915 void EmitLabel(DWLabel Label) const {
916 EmitLabel(Label.Tag, Label.Number);
917 }
918 void EmitLabel(const char *Tag, unsigned Number) const {
919 PrintLabelName(Tag, Number);
920 O << ":\n";
921 }
aslc200b112008-08-16 12:57:46 +0000922
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000923 /// EmitReference - Emit a reference to a label.
924 ///
Dan Gohman4fd77742007-09-28 15:43:33 +0000925 void EmitReference(DWLabel Label, bool IsPCRelative = false,
926 bool Force32Bit = false) const {
927 EmitReference(Label.Tag, Label.Number, IsPCRelative, Force32Bit);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000928 }
929 void EmitReference(const char *Tag, unsigned Number,
Dan Gohman4fd77742007-09-28 15:43:33 +0000930 bool IsPCRelative = false, bool Force32Bit = false) const {
931 PrintRelDirective(Force32Bit);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000932 PrintLabelName(Tag, Number);
aslc200b112008-08-16 12:57:46 +0000933
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000934 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
935 }
Dan Gohman4fd77742007-09-28 15:43:33 +0000936 void EmitReference(const std::string &Name, bool IsPCRelative = false,
937 bool Force32Bit = false) const {
938 PrintRelDirective(Force32Bit);
aslc200b112008-08-16 12:57:46 +0000939
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000940 O << Name;
aslc200b112008-08-16 12:57:46 +0000941
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000942 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
943 }
944
945 /// EmitDifference - Emit the difference between two labels. Some
946 /// assemblers do not behave with absolute expressions with data directives,
947 /// so there is an option (needsSet) to use an intermediary set expression.
948 void EmitDifference(DWLabel LabelHi, DWLabel LabelLo,
949 bool IsSmall = false) {
950 EmitDifference(LabelHi.Tag, LabelHi.Number,
951 LabelLo.Tag, LabelLo.Number,
952 IsSmall);
953 }
954 void EmitDifference(const char *TagHi, unsigned NumberHi,
955 const char *TagLo, unsigned NumberLo,
956 bool IsSmall = false) {
957 if (TAI->needsSet()) {
958 O << "\t.set\t";
Chris Lattnerb3876c72007-09-24 03:35:37 +0000959 PrintLabelName("set", SetCounter, Flavor);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000960 O << ",";
961 PrintLabelName(TagHi, NumberHi);
962 O << "-";
963 PrintLabelName(TagLo, NumberLo);
964 O << "\n";
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000965
966 PrintRelDirective(IsSmall);
Chris Lattnerb3876c72007-09-24 03:35:37 +0000967 PrintLabelName("set", SetCounter, Flavor);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000968 ++SetCounter;
969 } else {
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000970 PrintRelDirective(IsSmall);
aslc200b112008-08-16 12:57:46 +0000971
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000972 PrintLabelName(TagHi, NumberHi);
973 O << "-";
974 PrintLabelName(TagLo, NumberLo);
975 }
976 }
977
978 void EmitSectionOffset(const char* Label, const char* Section,
979 unsigned LabelNumber, unsigned SectionNumber,
Dale Johannesen0ebb2432008-03-26 23:31:39 +0000980 bool IsSmall = false, bool isEH = false,
981 bool useSet = true) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000982 bool printAbsolute = false;
Dale Johannesen0ebb2432008-03-26 23:31:39 +0000983 if (isEH)
984 printAbsolute = TAI->isAbsoluteEHSectionOffsets();
985 else
986 printAbsolute = TAI->isAbsoluteDebugSectionOffsets();
987
988 if (TAI->needsSet() && useSet) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000989 O << "\t.set\t";
Chris Lattnerb3876c72007-09-24 03:35:37 +0000990 PrintLabelName("set", SetCounter, Flavor);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000991 O << ",";
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000992 PrintLabelName(Label, LabelNumber);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000993
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000994 if (!printAbsolute) {
995 O << "-";
996 PrintLabelName(Section, SectionNumber);
aslc200b112008-08-16 12:57:46 +0000997 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000998 O << "\n";
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000999
1000 PrintRelDirective(IsSmall);
aslc200b112008-08-16 12:57:46 +00001001
Chris Lattnerb3876c72007-09-24 03:35:37 +00001002 PrintLabelName("set", SetCounter, Flavor);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001003 ++SetCounter;
1004 } else {
Anton Korobeynikov5ef86702007-09-02 22:07:21 +00001005 PrintRelDirective(IsSmall, true);
aslc200b112008-08-16 12:57:46 +00001006
Anton Korobeynikov5ef86702007-09-02 22:07:21 +00001007 PrintLabelName(Label, LabelNumber);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001008
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001009 if (!printAbsolute) {
1010 O << "-";
1011 PrintLabelName(Section, SectionNumber);
1012 }
aslc200b112008-08-16 12:57:46 +00001013 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001014 }
aslc200b112008-08-16 12:57:46 +00001015
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001016 /// EmitFrameMoves - Emit frame instructions to describe the layout of the
1017 /// frame.
1018 void EmitFrameMoves(const char *BaseLabel, unsigned BaseLabelID,
Dale Johannesenf5a11532007-11-13 19:13:01 +00001019 const std::vector<MachineMove> &Moves, bool isEH) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001020 int stackGrowth =
1021 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
1022 TargetFrameInfo::StackGrowsUp ?
Dan Gohmancfb72b22007-09-27 23:12:31 +00001023 TD->getPointerSize() : -TD->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001024 bool IsLocal = BaseLabel && strcmp(BaseLabel, "label") == 0;
1025
1026 for (unsigned i = 0, N = Moves.size(); i < N; ++i) {
1027 const MachineMove &Move = Moves[i];
1028 unsigned LabelID = Move.getLabelID();
aslc200b112008-08-16 12:57:46 +00001029
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001030 if (LabelID) {
1031 LabelID = MMI->MappedLabel(LabelID);
aslc200b112008-08-16 12:57:46 +00001032
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001033 // Throw out move if the label is invalid.
1034 if (!LabelID) continue;
1035 }
aslc200b112008-08-16 12:57:46 +00001036
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001037 const MachineLocation &Dst = Move.getDestination();
1038 const MachineLocation &Src = Move.getSource();
aslc200b112008-08-16 12:57:46 +00001039
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001040 // Advance row if new location.
1041 if (BaseLabel && LabelID && (BaseLabelID != LabelID || !IsLocal)) {
1042 Asm->EmitInt8(DW_CFA_advance_loc4);
1043 Asm->EOL("DW_CFA_advance_loc4");
1044 EmitDifference("label", LabelID, BaseLabel, BaseLabelID, true);
1045 Asm->EOL();
aslc200b112008-08-16 12:57:46 +00001046
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001047 BaseLabelID = LabelID;
1048 BaseLabel = "label";
1049 IsLocal = true;
1050 }
aslc200b112008-08-16 12:57:46 +00001051
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001052 // If advancing cfa.
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001053 if (Dst.isReg() && Dst.getReg() == MachineLocation::VirtualFP) {
1054 if (!Src.isReg()) {
1055 if (Src.getReg() == MachineLocation::VirtualFP) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001056 Asm->EmitInt8(DW_CFA_def_cfa_offset);
1057 Asm->EOL("DW_CFA_def_cfa_offset");
1058 } else {
1059 Asm->EmitInt8(DW_CFA_def_cfa);
1060 Asm->EOL("DW_CFA_def_cfa");
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001061 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Src.getReg(), isEH));
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001062 Asm->EOL("Register");
1063 }
aslc200b112008-08-16 12:57:46 +00001064
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001065 int Offset = -Src.getOffset();
aslc200b112008-08-16 12:57:46 +00001066
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001067 Asm->EmitULEB128Bytes(Offset);
1068 Asm->EOL("Offset");
1069 } else {
1070 assert(0 && "Machine move no supported yet.");
1071 }
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001072 } else if (Src.isReg() &&
1073 Src.getReg() == MachineLocation::VirtualFP) {
1074 if (Dst.isReg()) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001075 Asm->EmitInt8(DW_CFA_def_cfa_register);
1076 Asm->EOL("DW_CFA_def_cfa_register");
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001077 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Dst.getReg(), isEH));
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001078 Asm->EOL("Register");
1079 } else {
1080 assert(0 && "Machine move no supported yet.");
1081 }
1082 } else {
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001083 unsigned Reg = RI->getDwarfRegNum(Src.getReg(), isEH);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001084 int Offset = Dst.getOffset() / stackGrowth;
aslc200b112008-08-16 12:57:46 +00001085
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001086 if (Offset < 0) {
1087 Asm->EmitInt8(DW_CFA_offset_extended_sf);
1088 Asm->EOL("DW_CFA_offset_extended_sf");
1089 Asm->EmitULEB128Bytes(Reg);
1090 Asm->EOL("Reg");
1091 Asm->EmitSLEB128Bytes(Offset);
1092 Asm->EOL("Offset");
1093 } else if (Reg < 64) {
1094 Asm->EmitInt8(DW_CFA_offset + Reg);
Evan Cheng6181e062008-07-09 21:53:02 +00001095 if (VerboseAsm)
1096 Asm->EOL("DW_CFA_offset + Reg (" + utostr(Reg) + ")");
1097 else
1098 Asm->EOL();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001099 Asm->EmitULEB128Bytes(Offset);
1100 Asm->EOL("Offset");
1101 } else {
1102 Asm->EmitInt8(DW_CFA_offset_extended);
1103 Asm->EOL("DW_CFA_offset_extended");
1104 Asm->EmitULEB128Bytes(Reg);
1105 Asm->EOL("Reg");
1106 Asm->EmitULEB128Bytes(Offset);
1107 Asm->EOL("Offset");
1108 }
1109 }
1110 }
1111 }
1112
1113};
1114
1115//===----------------------------------------------------------------------===//
aslc200b112008-08-16 12:57:46 +00001116/// DwarfDebug - Emits Dwarf debug directives.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001117///
1118class DwarfDebug : public Dwarf {
1119
1120private:
1121 //===--------------------------------------------------------------------===//
1122 // Attributes used to construct specific Dwarf sections.
1123 //
aslc200b112008-08-16 12:57:46 +00001124
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001125 /// CompileUnits - All the compile units involved in this build. The index
1126 /// of each entry in this vector corresponds to the sources in MMI.
1127 std::vector<CompileUnit *> CompileUnits;
aslc200b112008-08-16 12:57:46 +00001128
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001129 /// AbbreviationsSet - Used to uniquely define abbreviations.
1130 ///
1131 FoldingSet<DIEAbbrev> AbbreviationsSet;
1132
1133 /// Abbreviations - A list of all the unique abbreviations in use.
1134 ///
1135 std::vector<DIEAbbrev *> Abbreviations;
aslc200b112008-08-16 12:57:46 +00001136
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001137 /// ValuesSet - Used to uniquely define values.
1138 ///
1139 FoldingSet<DIEValue> ValuesSet;
aslc200b112008-08-16 12:57:46 +00001140
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001141 /// Values - A list of all the unique values in use.
1142 ///
1143 std::vector<DIEValue *> Values;
aslc200b112008-08-16 12:57:46 +00001144
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001145 /// StringPool - A UniqueVector of strings used by indirect references.
1146 ///
1147 UniqueVector<std::string> StringPool;
1148
1149 /// UnitMap - Map debug information descriptor to compile unit.
1150 ///
1151 std::map<DebugInfoDesc *, CompileUnit *> DescToUnitMap;
aslc200b112008-08-16 12:57:46 +00001152
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001153 /// SectionMap - Provides a unique id per text section.
1154 ///
Anton Korobeynikov55b94962008-09-24 22:15:21 +00001155 UniqueVector<const Section*> SectionMap;
aslc200b112008-08-16 12:57:46 +00001156
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001157 /// SectionSourceLines - Tracks line numbers per text section.
1158 ///
1159 std::vector<std::vector<SourceLineInfo> > SectionSourceLines;
1160
1161 /// didInitial - Flag to indicate if initial emission has been done.
1162 ///
1163 bool didInitial;
aslc200b112008-08-16 12:57:46 +00001164
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001165 /// shouldEmit - Flag to indicate if debug information should be emitted.
1166 ///
1167 bool shouldEmit;
1168
1169 struct FunctionDebugFrameInfo {
1170 unsigned Number;
1171 std::vector<MachineMove> Moves;
1172
1173 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M):
Dan Gohman9ba5d4d2007-08-27 14:50:10 +00001174 Number(Num), Moves(M) { }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001175 };
1176
1177 std::vector<FunctionDebugFrameInfo> DebugFrames;
aslc200b112008-08-16 12:57:46 +00001178
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001179public:
aslc200b112008-08-16 12:57:46 +00001180
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001181 /// ShouldEmitDwarf - Returns true if Dwarf declarations should be made.
1182 ///
1183 bool ShouldEmitDwarf() const { return shouldEmit; }
1184
1185 /// AssignAbbrevNumber - Define a unique number for the abbreviation.
aslc200b112008-08-16 12:57:46 +00001186 ///
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001187 void AssignAbbrevNumber(DIEAbbrev &Abbrev) {
1188 // Profile the node so that we can make it unique.
1189 FoldingSetNodeID ID;
1190 Abbrev.Profile(ID);
aslc200b112008-08-16 12:57:46 +00001191
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001192 // Check the set for priors.
1193 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
aslc200b112008-08-16 12:57:46 +00001194
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001195 // If it's newly added.
1196 if (InSet == &Abbrev) {
aslc200b112008-08-16 12:57:46 +00001197 // Add to abbreviation list.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001198 Abbreviations.push_back(&Abbrev);
1199 // Assign the vector position + 1 as its number.
1200 Abbrev.setNumber(Abbreviations.size());
1201 } else {
1202 // Assign existing abbreviation number.
1203 Abbrev.setNumber(InSet->getNumber());
1204 }
1205 }
1206
1207 /// NewString - Add a string to the constant pool and returns a label.
1208 ///
1209 DWLabel NewString(const std::string &String) {
1210 unsigned StringID = StringPool.insert(String);
1211 return DWLabel("string", StringID);
1212 }
aslc200b112008-08-16 12:57:46 +00001213
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001214 /// NewDIEntry - Creates a new DIEntry to be a proxy for a debug information
1215 /// entry.
1216 DIEntry *NewDIEntry(DIE *Entry = NULL) {
1217 DIEntry *Value;
aslc200b112008-08-16 12:57:46 +00001218
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001219 if (Entry) {
1220 FoldingSetNodeID ID;
1221 DIEntry::Profile(ID, Entry);
1222 void *Where;
1223 Value = static_cast<DIEntry *>(ValuesSet.FindNodeOrInsertPos(ID, Where));
aslc200b112008-08-16 12:57:46 +00001224
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001225 if (Value) return Value;
aslc200b112008-08-16 12:57:46 +00001226
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001227 Value = new DIEntry(Entry);
1228 ValuesSet.InsertNode(Value, Where);
1229 } else {
1230 Value = new DIEntry(Entry);
1231 }
aslc200b112008-08-16 12:57:46 +00001232
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001233 Values.push_back(Value);
1234 return Value;
1235 }
aslc200b112008-08-16 12:57:46 +00001236
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001237 /// SetDIEntry - Set a DIEntry once the debug information entry is defined.
1238 ///
1239 void SetDIEntry(DIEntry *Value, DIE *Entry) {
1240 Value->Entry = Entry;
1241 // Add to values set if not already there. If it is, we merely have a
1242 // duplicate in the values list (no harm.)
1243 ValuesSet.GetOrInsertNode(Value);
1244 }
1245
1246 /// AddUInt - Add an unsigned integer attribute data and value.
1247 ///
1248 void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer) {
1249 if (!Form) Form = DIEInteger::BestForm(false, Integer);
1250
1251 FoldingSetNodeID ID;
1252 DIEInteger::Profile(ID, Integer);
1253 void *Where;
1254 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1255 if (!Value) {
1256 Value = new DIEInteger(Integer);
1257 ValuesSet.InsertNode(Value, Where);
1258 Values.push_back(Value);
1259 }
aslc200b112008-08-16 12:57:46 +00001260
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001261 Die->AddValue(Attribute, Form, Value);
1262 }
aslc200b112008-08-16 12:57:46 +00001263
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001264 /// AddSInt - Add an signed integer attribute data and value.
1265 ///
1266 void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer) {
1267 if (!Form) Form = DIEInteger::BestForm(true, Integer);
1268
1269 FoldingSetNodeID ID;
1270 DIEInteger::Profile(ID, (uint64_t)Integer);
1271 void *Where;
1272 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1273 if (!Value) {
1274 Value = new DIEInteger(Integer);
1275 ValuesSet.InsertNode(Value, Where);
1276 Values.push_back(Value);
1277 }
aslc200b112008-08-16 12:57:46 +00001278
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001279 Die->AddValue(Attribute, Form, Value);
1280 }
aslc200b112008-08-16 12:57:46 +00001281
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001282 /// AddString - Add a std::string attribute data and value.
1283 ///
1284 void AddString(DIE *Die, unsigned Attribute, unsigned Form,
1285 const std::string &String) {
1286 FoldingSetNodeID ID;
1287 DIEString::Profile(ID, String);
1288 void *Where;
1289 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1290 if (!Value) {
1291 Value = new DIEString(String);
1292 ValuesSet.InsertNode(Value, Where);
1293 Values.push_back(Value);
1294 }
aslc200b112008-08-16 12:57:46 +00001295
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001296 Die->AddValue(Attribute, Form, Value);
1297 }
aslc200b112008-08-16 12:57:46 +00001298
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001299 /// AddLabel - Add a Dwarf label attribute data and value.
1300 ///
1301 void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
1302 const DWLabel &Label) {
1303 FoldingSetNodeID ID;
1304 DIEDwarfLabel::Profile(ID, Label);
1305 void *Where;
1306 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1307 if (!Value) {
1308 Value = new DIEDwarfLabel(Label);
1309 ValuesSet.InsertNode(Value, Where);
1310 Values.push_back(Value);
1311 }
aslc200b112008-08-16 12:57:46 +00001312
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001313 Die->AddValue(Attribute, Form, Value);
1314 }
aslc200b112008-08-16 12:57:46 +00001315
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001316 /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
1317 ///
1318 void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
1319 const std::string &Label) {
1320 FoldingSetNodeID ID;
1321 DIEObjectLabel::Profile(ID, Label);
1322 void *Where;
1323 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1324 if (!Value) {
1325 Value = new DIEObjectLabel(Label);
1326 ValuesSet.InsertNode(Value, Where);
1327 Values.push_back(Value);
1328 }
aslc200b112008-08-16 12:57:46 +00001329
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001330 Die->AddValue(Attribute, Form, Value);
1331 }
aslc200b112008-08-16 12:57:46 +00001332
Argiris Kirtzidis03449652008-06-18 19:27:37 +00001333 /// AddSectionOffset - Add a section offset label attribute data and value.
1334 ///
1335 void AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
1336 const DWLabel &Label, const DWLabel &Section,
1337 bool isEH = false, bool useSet = true) {
1338 FoldingSetNodeID ID;
1339 DIESectionOffset::Profile(ID, Label, Section);
1340 void *Where;
1341 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1342 if (!Value) {
1343 Value = new DIESectionOffset(Label, Section, isEH, useSet);
1344 ValuesSet.InsertNode(Value, Where);
1345 Values.push_back(Value);
1346 }
aslc200b112008-08-16 12:57:46 +00001347
Argiris Kirtzidis03449652008-06-18 19:27:37 +00001348 Die->AddValue(Attribute, Form, Value);
1349 }
aslc200b112008-08-16 12:57:46 +00001350
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001351 /// AddDelta - Add a label delta attribute data and value.
1352 ///
1353 void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
1354 const DWLabel &Hi, const DWLabel &Lo) {
1355 FoldingSetNodeID ID;
1356 DIEDelta::Profile(ID, Hi, Lo);
1357 void *Where;
1358 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1359 if (!Value) {
1360 Value = new DIEDelta(Hi, Lo);
1361 ValuesSet.InsertNode(Value, Where);
1362 Values.push_back(Value);
1363 }
aslc200b112008-08-16 12:57:46 +00001364
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001365 Die->AddValue(Attribute, Form, Value);
1366 }
aslc200b112008-08-16 12:57:46 +00001367
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001368 /// AddDIEntry - Add a DIE attribute data and value.
1369 ///
1370 void AddDIEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
1371 Die->AddValue(Attribute, Form, NewDIEntry(Entry));
1372 }
1373
1374 /// AddBlock - Add block data.
1375 ///
1376 void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block) {
1377 Block->ComputeSize(*this);
1378 FoldingSetNodeID ID;
1379 Block->Profile(ID);
1380 void *Where;
1381 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1382 if (!Value) {
1383 Value = Block;
1384 ValuesSet.InsertNode(Value, Where);
1385 Values.push_back(Value);
1386 } else {
Chris Lattner3de66892007-09-21 18:25:53 +00001387 // Already exists, reuse the previous one.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001388 delete Block;
Chris Lattner3de66892007-09-21 18:25:53 +00001389 Block = cast<DIEBlock>(Value);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001390 }
aslc200b112008-08-16 12:57:46 +00001391
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001392 Die->AddValue(Attribute, Block->BestForm(), Value);
1393 }
1394
1395private:
1396
1397 /// AddSourceLine - Add location information to specified debug information
1398 /// entry.
1399 void AddSourceLine(DIE *Die, CompileUnitDesc *File, unsigned Line) {
1400 if (File && Line) {
1401 CompileUnit *FileUnit = FindCompileUnit(File);
1402 unsigned FileID = FileUnit->getID();
1403 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1404 AddUInt(Die, DW_AT_decl_line, 0, Line);
1405 }
1406 }
1407
1408 /// AddAddress - Add an address attribute to a die based on the location
1409 /// provided.
1410 void AddAddress(DIE *Die, unsigned Attribute,
1411 const MachineLocation &Location) {
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001412 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001413 DIEBlock *Block = new DIEBlock();
aslc200b112008-08-16 12:57:46 +00001414
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001415 if (Location.isReg()) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001416 if (Reg < 32) {
1417 AddUInt(Block, 0, DW_FORM_data1, DW_OP_reg0 + Reg);
1418 } else {
1419 AddUInt(Block, 0, DW_FORM_data1, DW_OP_regx);
1420 AddUInt(Block, 0, DW_FORM_udata, Reg);
1421 }
1422 } else {
1423 if (Reg < 32) {
1424 AddUInt(Block, 0, DW_FORM_data1, DW_OP_breg0 + Reg);
1425 } else {
1426 AddUInt(Block, 0, DW_FORM_data1, DW_OP_bregx);
1427 AddUInt(Block, 0, DW_FORM_udata, Reg);
1428 }
1429 AddUInt(Block, 0, DW_FORM_sdata, Location.getOffset());
1430 }
aslc200b112008-08-16 12:57:46 +00001431
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001432 AddBlock(Die, Attribute, 0, Block);
1433 }
aslc200b112008-08-16 12:57:46 +00001434
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001435 /// AddBasicType - Add a new basic type attribute to the specified entity.
1436 ///
1437 void AddBasicType(DIE *Entity, CompileUnit *Unit,
1438 const std::string &Name,
1439 unsigned Encoding, unsigned Size) {
1440 DIE *Die = ConstructBasicType(Unit, Name, Encoding, Size);
1441 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, Die);
1442 }
aslc200b112008-08-16 12:57:46 +00001443
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001444 /// ConstructBasicType - Construct a new basic type.
1445 ///
1446 DIE *ConstructBasicType(CompileUnit *Unit,
1447 const std::string &Name,
1448 unsigned Encoding, unsigned Size) {
1449 DIE Buffer(DW_TAG_base_type);
1450 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1451 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, Encoding);
1452 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1453 return Unit->AddDie(Buffer);
1454 }
aslc200b112008-08-16 12:57:46 +00001455
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001456 /// AddPointerType - Add a new pointer type attribute to the specified entity.
1457 ///
1458 void AddPointerType(DIE *Entity, CompileUnit *Unit, const std::string &Name) {
1459 DIE *Die = ConstructPointerType(Unit, Name);
1460 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, Die);
1461 }
aslc200b112008-08-16 12:57:46 +00001462
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001463 /// ConstructPointerType - Construct a new pointer type.
1464 ///
1465 DIE *ConstructPointerType(CompileUnit *Unit, const std::string &Name) {
1466 DIE Buffer(DW_TAG_pointer_type);
Dan Gohmancfb72b22007-09-27 23:12:31 +00001467 AddUInt(&Buffer, DW_AT_byte_size, 0, TD->getPointerSize());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001468 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1469 return Unit->AddDie(Buffer);
1470 }
aslc200b112008-08-16 12:57:46 +00001471
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001472 /// AddType - Add a new type attribute to the specified entity.
1473 ///
1474 void AddType(DIE *Entity, TypeDesc *TyDesc, CompileUnit *Unit) {
1475 if (!TyDesc) {
1476 AddBasicType(Entity, Unit, "", DW_ATE_signed, sizeof(int32_t));
1477 } else {
1478 // Check for pre-existence.
1479 DIEntry *&Slot = Unit->getDIEntrySlotFor(TyDesc);
aslc200b112008-08-16 12:57:46 +00001480
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001481 // If it exists then use the existing value.
1482 if (Slot) {
1483 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1484 return;
1485 }
aslc200b112008-08-16 12:57:46 +00001486
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001487 if (SubprogramDesc *SubprogramTy = dyn_cast<SubprogramDesc>(TyDesc)) {
1488 // FIXME - Not sure why programs and variables are coming through here.
1489 // Short cut for handling subprogram types (not really a TyDesc.)
1490 AddPointerType(Entity, Unit, SubprogramTy->getName());
1491 } else if (GlobalVariableDesc *GlobalTy =
1492 dyn_cast<GlobalVariableDesc>(TyDesc)) {
1493 // FIXME - Not sure why programs and variables are coming through here.
1494 // Short cut for handling global variable types (not really a TyDesc.)
1495 AddPointerType(Entity, Unit, GlobalTy->getName());
aslc200b112008-08-16 12:57:46 +00001496 } else {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001497 // Set up proxy.
1498 Slot = NewDIEntry();
aslc200b112008-08-16 12:57:46 +00001499
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001500 // Construct type.
1501 DIE Buffer(DW_TAG_base_type);
1502 ConstructType(Buffer, TyDesc, Unit);
aslc200b112008-08-16 12:57:46 +00001503
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001504 // Add debug information entry to entity and unit.
1505 DIE *Die = Unit->AddDie(Buffer);
1506 SetDIEntry(Slot, Die);
1507 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1508 }
1509 }
1510 }
aslc200b112008-08-16 12:57:46 +00001511
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001512 /// ConstructType - Adds all the required attributes to the type.
1513 ///
1514 void ConstructType(DIE &Buffer, TypeDesc *TyDesc, CompileUnit *Unit) {
1515 // Get core information.
1516 const std::string &Name = TyDesc->getName();
1517 uint64_t Size = TyDesc->getSize() >> 3;
aslc200b112008-08-16 12:57:46 +00001518
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001519 if (BasicTypeDesc *BasicTy = dyn_cast<BasicTypeDesc>(TyDesc)) {
1520 // Fundamental types like int, float, bool
1521 Buffer.setTag(DW_TAG_base_type);
1522 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, BasicTy->getEncoding());
1523 } else if (DerivedTypeDesc *DerivedTy = dyn_cast<DerivedTypeDesc>(TyDesc)) {
1524 // Fetch tag.
1525 unsigned Tag = DerivedTy->getTag();
1526 // FIXME - Workaround for templates.
1527 if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
aslc200b112008-08-16 12:57:46 +00001528 // Pointers, typedefs et al.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001529 Buffer.setTag(Tag);
1530 // Map to main type, void will not have a type.
1531 if (TypeDesc *FromTy = DerivedTy->getFromType())
1532 AddType(&Buffer, FromTy, Unit);
1533 } else if (CompositeTypeDesc *CompTy = dyn_cast<CompositeTypeDesc>(TyDesc)){
1534 // Fetch tag.
1535 unsigned Tag = CompTy->getTag();
aslc200b112008-08-16 12:57:46 +00001536
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001537 // Set tag accordingly.
1538 if (Tag == DW_TAG_vector_type)
1539 Buffer.setTag(DW_TAG_array_type);
aslc200b112008-08-16 12:57:46 +00001540 else
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001541 Buffer.setTag(Tag);
1542
1543 std::vector<DebugInfoDesc *> &Elements = CompTy->getElements();
aslc200b112008-08-16 12:57:46 +00001544
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001545 switch (Tag) {
1546 case DW_TAG_vector_type:
1547 AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1548 // Fall thru
1549 case DW_TAG_array_type: {
1550 // Add element type.
1551 if (TypeDesc *FromTy = CompTy->getFromType())
1552 AddType(&Buffer, FromTy, Unit);
aslc200b112008-08-16 12:57:46 +00001553
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001554 // Don't emit size attribute.
1555 Size = 0;
aslc200b112008-08-16 12:57:46 +00001556
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001557 // Construct an anonymous type for index type.
1558 DIE *IndexTy = ConstructBasicType(Unit, "", DW_ATE_signed,
1559 sizeof(int32_t));
aslc200b112008-08-16 12:57:46 +00001560
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001561 // Add subranges to array type.
1562 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1563 SubrangeDesc *SRD = cast<SubrangeDesc>(Elements[i]);
1564 int64_t Lo = SRD->getLo();
1565 int64_t Hi = SRD->getHi();
1566 DIE *Subrange = new DIE(DW_TAG_subrange_type);
aslc200b112008-08-16 12:57:46 +00001567
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001568 // If a range is available.
1569 if (Lo != Hi) {
1570 AddDIEntry(Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1571 // Only add low if non-zero.
1572 if (Lo) AddSInt(Subrange, DW_AT_lower_bound, 0, Lo);
1573 AddSInt(Subrange, DW_AT_upper_bound, 0, Hi);
1574 }
aslc200b112008-08-16 12:57:46 +00001575
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001576 Buffer.AddChild(Subrange);
1577 }
1578 break;
1579 }
1580 case DW_TAG_structure_type:
1581 case DW_TAG_union_type: {
1582 // Add elements to structure type.
1583 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1584 DebugInfoDesc *Element = Elements[i];
aslc200b112008-08-16 12:57:46 +00001585
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001586 if (DerivedTypeDesc *MemberDesc = dyn_cast<DerivedTypeDesc>(Element)){
1587 // Add field or base class.
aslc200b112008-08-16 12:57:46 +00001588
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001589 unsigned Tag = MemberDesc->getTag();
aslc200b112008-08-16 12:57:46 +00001590
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001591 // Extract the basic information.
1592 const std::string &Name = MemberDesc->getName();
1593 uint64_t Size = MemberDesc->getSize();
1594 uint64_t Align = MemberDesc->getAlign();
1595 uint64_t Offset = MemberDesc->getOffset();
aslc200b112008-08-16 12:57:46 +00001596
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001597 // Construct member debug information entry.
1598 DIE *Member = new DIE(Tag);
aslc200b112008-08-16 12:57:46 +00001599
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001600 // Add name if not "".
1601 if (!Name.empty())
1602 AddString(Member, DW_AT_name, DW_FORM_string, Name);
1603 // Add location if available.
1604 AddSourceLine(Member, MemberDesc->getFile(), MemberDesc->getLine());
aslc200b112008-08-16 12:57:46 +00001605
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001606 // Most of the time the field info is the same as the members.
1607 uint64_t FieldSize = Size;
1608 uint64_t FieldAlign = Align;
1609 uint64_t FieldOffset = Offset;
aslc200b112008-08-16 12:57:46 +00001610
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001611 // Set the member type.
1612 TypeDesc *FromTy = MemberDesc->getFromType();
1613 AddType(Member, FromTy, Unit);
aslc200b112008-08-16 12:57:46 +00001614
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001615 // Walk up typedefs until a real size is found.
1616 while (FromTy) {
1617 if (FromTy->getTag() != DW_TAG_typedef) {
1618 FieldSize = FromTy->getSize();
1619 FieldAlign = FromTy->getSize();
1620 break;
1621 }
aslc200b112008-08-16 12:57:46 +00001622
Dan Gohman53491e92007-07-23 20:24:29 +00001623 FromTy = cast<DerivedTypeDesc>(FromTy)->getFromType();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001624 }
aslc200b112008-08-16 12:57:46 +00001625
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001626 // Unless we have a bit field.
1627 if (Tag == DW_TAG_member && FieldSize != Size) {
1628 // Construct the alignment mask.
1629 uint64_t AlignMask = ~(FieldAlign - 1);
1630 // Determine the high bit + 1 of the declared size.
1631 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1632 // Work backwards to determine the base offset of the field.
1633 FieldOffset = HiMark - FieldSize;
1634 // Now normalize offset to the field.
1635 Offset -= FieldOffset;
aslc200b112008-08-16 12:57:46 +00001636
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001637 // Maybe we need to work from the other end.
1638 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
aslc200b112008-08-16 12:57:46 +00001639
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001640 // Add size and offset.
1641 AddUInt(Member, DW_AT_byte_size, 0, FieldSize >> 3);
1642 AddUInt(Member, DW_AT_bit_size, 0, Size);
1643 AddUInt(Member, DW_AT_bit_offset, 0, Offset);
1644 }
aslc200b112008-08-16 12:57:46 +00001645
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001646 // Add computation for offset.
1647 DIEBlock *Block = new DIEBlock();
1648 AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
1649 AddUInt(Block, 0, DW_FORM_udata, FieldOffset >> 3);
1650 AddBlock(Member, DW_AT_data_member_location, 0, Block);
1651
1652 // Add accessibility (public default unless is base class.
1653 if (MemberDesc->isProtected()) {
1654 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_protected);
1655 } else if (MemberDesc->isPrivate()) {
1656 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_private);
1657 } else if (Tag == DW_TAG_inheritance) {
1658 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_public);
1659 }
aslc200b112008-08-16 12:57:46 +00001660
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001661 Buffer.AddChild(Member);
1662 } else if (GlobalVariableDesc *StaticDesc =
1663 dyn_cast<GlobalVariableDesc>(Element)) {
1664 // Add static member.
aslc200b112008-08-16 12:57:46 +00001665
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001666 // Construct member debug information entry.
1667 DIE *Static = new DIE(DW_TAG_variable);
aslc200b112008-08-16 12:57:46 +00001668
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001669 // Add name and mangled name.
1670 const std::string &Name = StaticDesc->getName();
1671 const std::string &LinkageName = StaticDesc->getLinkageName();
1672 AddString(Static, DW_AT_name, DW_FORM_string, Name);
1673 if (!LinkageName.empty()) {
1674 AddString(Static, DW_AT_MIPS_linkage_name, DW_FORM_string,
1675 LinkageName);
1676 }
aslc200b112008-08-16 12:57:46 +00001677
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001678 // Add location.
1679 AddSourceLine(Static, StaticDesc->getFile(), StaticDesc->getLine());
aslc200b112008-08-16 12:57:46 +00001680
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001681 // Add type.
1682 if (TypeDesc *StaticTy = StaticDesc->getType())
1683 AddType(Static, StaticTy, Unit);
aslc200b112008-08-16 12:57:46 +00001684
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001685 // Add flags.
1686 if (!StaticDesc->isStatic())
1687 AddUInt(Static, DW_AT_external, DW_FORM_flag, 1);
1688 AddUInt(Static, DW_AT_declaration, DW_FORM_flag, 1);
aslc200b112008-08-16 12:57:46 +00001689
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001690 Buffer.AddChild(Static);
1691 } else if (SubprogramDesc *MethodDesc =
1692 dyn_cast<SubprogramDesc>(Element)) {
1693 // Add member function.
aslc200b112008-08-16 12:57:46 +00001694
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001695 // Construct member debug information entry.
1696 DIE *Method = new DIE(DW_TAG_subprogram);
aslc200b112008-08-16 12:57:46 +00001697
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001698 // Add name and mangled name.
1699 const std::string &Name = MethodDesc->getName();
1700 const std::string &LinkageName = MethodDesc->getLinkageName();
aslc200b112008-08-16 12:57:46 +00001701
1702 AddString(Method, DW_AT_name, DW_FORM_string, Name);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001703 bool IsCTor = TyDesc->getName() == Name;
aslc200b112008-08-16 12:57:46 +00001704
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001705 if (!LinkageName.empty()) {
1706 AddString(Method, DW_AT_MIPS_linkage_name, DW_FORM_string,
1707 LinkageName);
1708 }
aslc200b112008-08-16 12:57:46 +00001709
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001710 // Add location.
1711 AddSourceLine(Method, MethodDesc->getFile(), MethodDesc->getLine());
aslc200b112008-08-16 12:57:46 +00001712
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001713 // Add type.
1714 if (CompositeTypeDesc *MethodTy =
1715 dyn_cast_or_null<CompositeTypeDesc>(MethodDesc->getType())) {
1716 // Get argument information.
1717 std::vector<DebugInfoDesc *> &Args = MethodTy->getElements();
aslc200b112008-08-16 12:57:46 +00001718
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001719 // If not a ctor.
1720 if (!IsCTor) {
1721 // Add return type.
1722 AddType(Method, dyn_cast<TypeDesc>(Args[0]), Unit);
1723 }
aslc200b112008-08-16 12:57:46 +00001724
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001725 // Add arguments.
1726 for(unsigned i = 1, N = Args.size(); i < N; ++i) {
1727 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1728 AddType(Arg, cast<TypeDesc>(Args[i]), Unit);
1729 AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1);
1730 Method->AddChild(Arg);
1731 }
1732 }
1733
1734 // Add flags.
1735 if (!MethodDesc->isStatic())
1736 AddUInt(Method, DW_AT_external, DW_FORM_flag, 1);
1737 AddUInt(Method, DW_AT_declaration, DW_FORM_flag, 1);
aslc200b112008-08-16 12:57:46 +00001738
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001739 Buffer.AddChild(Method);
1740 }
1741 }
1742 break;
1743 }
1744 case DW_TAG_enumeration_type: {
1745 // Add enumerators to enumeration type.
1746 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1747 EnumeratorDesc *ED = cast<EnumeratorDesc>(Elements[i]);
1748 const std::string &Name = ED->getName();
1749 int64_t Value = ED->getValue();
1750 DIE *Enumerator = new DIE(DW_TAG_enumerator);
1751 AddString(Enumerator, DW_AT_name, DW_FORM_string, Name);
1752 AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
1753 Buffer.AddChild(Enumerator);
1754 }
1755
1756 break;
1757 }
1758 case DW_TAG_subroutine_type: {
1759 // Add prototype flag.
1760 AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
1761 // Add return type.
1762 AddType(&Buffer, dyn_cast<TypeDesc>(Elements[0]), Unit);
aslc200b112008-08-16 12:57:46 +00001763
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001764 // Add arguments.
1765 for(unsigned i = 1, N = Elements.size(); i < N; ++i) {
1766 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1767 AddType(Arg, cast<TypeDesc>(Elements[i]), Unit);
1768 Buffer.AddChild(Arg);
1769 }
aslc200b112008-08-16 12:57:46 +00001770
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001771 break;
1772 }
1773 default: break;
1774 }
1775 }
aslc200b112008-08-16 12:57:46 +00001776
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001777 // Add size if non-zero (derived types don't have a size.)
1778 if (Size) AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1779 // Add name if not anonymous or intermediate type.
1780 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1781 // Add source line info if available.
1782 AddSourceLine(&Buffer, TyDesc->getFile(), TyDesc->getLine());
1783 }
1784
1785 /// NewCompileUnit - Create new compile unit and it's debug information entry.
1786 ///
1787 CompileUnit *NewCompileUnit(CompileUnitDesc *UnitDesc, unsigned ID) {
1788 // Construct debug information entry.
1789 DIE *Die = new DIE(DW_TAG_compile_unit);
Argiris Kirtzidis03449652008-06-18 19:27:37 +00001790 AddSectionOffset(Die, DW_AT_stmt_list, DW_FORM_data4,
1791 DWLabel("section_line", 0), DWLabel("section_line", 0), false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001792 AddString(Die, DW_AT_producer, DW_FORM_string, UnitDesc->getProducer());
1793 AddUInt (Die, DW_AT_language, DW_FORM_data1, UnitDesc->getLanguage());
1794 AddString(Die, DW_AT_name, DW_FORM_string, UnitDesc->getFileName());
1795 AddString(Die, DW_AT_comp_dir, DW_FORM_string, UnitDesc->getDirectory());
aslc200b112008-08-16 12:57:46 +00001796
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001797 // Construct compile unit.
1798 CompileUnit *Unit = new CompileUnit(UnitDesc, ID, Die);
aslc200b112008-08-16 12:57:46 +00001799
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001800 // Add Unit to compile unit map.
1801 DescToUnitMap[UnitDesc] = Unit;
aslc200b112008-08-16 12:57:46 +00001802
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001803 return Unit;
1804 }
1805
1806 /// GetBaseCompileUnit - Get the main compile unit.
1807 ///
1808 CompileUnit *GetBaseCompileUnit() const {
1809 CompileUnit *Unit = CompileUnits[0];
1810 assert(Unit && "Missing compile unit.");
1811 return Unit;
1812 }
1813
1814 /// FindCompileUnit - Get the compile unit for the given descriptor.
1815 ///
1816 CompileUnit *FindCompileUnit(CompileUnitDesc *UnitDesc) {
1817 CompileUnit *Unit = DescToUnitMap[UnitDesc];
1818 assert(Unit && "Missing compile unit.");
1819 return Unit;
1820 }
1821
1822 /// NewGlobalVariable - Add a new global variable DIE.
1823 ///
1824 DIE *NewGlobalVariable(GlobalVariableDesc *GVD) {
1825 // Get the compile unit context.
1826 CompileUnitDesc *UnitDesc =
1827 static_cast<CompileUnitDesc *>(GVD->getContext());
1828 CompileUnit *Unit = GetBaseCompileUnit();
1829
1830 // Check for pre-existence.
1831 DIE *&Slot = Unit->getDieMapSlotFor(GVD);
1832 if (Slot) return Slot;
aslc200b112008-08-16 12:57:46 +00001833
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001834 // Get the global variable itself.
1835 GlobalVariable *GV = GVD->getGlobalVariable();
1836
1837 const std::string &Name = GVD->getName();
1838 const std::string &FullName = GVD->getFullName();
1839 const std::string &LinkageName = GVD->getLinkageName();
1840 // Create the global's variable DIE.
1841 DIE *VariableDie = new DIE(DW_TAG_variable);
1842 AddString(VariableDie, DW_AT_name, DW_FORM_string, Name);
1843 if (!LinkageName.empty()) {
1844 AddString(VariableDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
1845 LinkageName);
1846 }
1847 AddType(VariableDie, GVD->getType(), Unit);
1848 if (!GVD->isStatic())
1849 AddUInt(VariableDie, DW_AT_external, DW_FORM_flag, 1);
aslc200b112008-08-16 12:57:46 +00001850
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001851 // Add source line info if available.
1852 AddSourceLine(VariableDie, UnitDesc, GVD->getLine());
aslc200b112008-08-16 12:57:46 +00001853
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001854 // Add address.
1855 DIEBlock *Block = new DIEBlock();
1856 AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
1857 AddObjectLabel(Block, 0, DW_FORM_udata, Asm->getGlobalLinkName(GV));
1858 AddBlock(VariableDie, DW_AT_location, 0, Block);
aslc200b112008-08-16 12:57:46 +00001859
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001860 // Add to map.
1861 Slot = VariableDie;
aslc200b112008-08-16 12:57:46 +00001862
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001863 // Add to context owner.
1864 Unit->getDie()->AddChild(VariableDie);
aslc200b112008-08-16 12:57:46 +00001865
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001866 // Expose as global.
1867 // FIXME - need to check external flag.
1868 Unit->AddGlobal(FullName, VariableDie);
aslc200b112008-08-16 12:57:46 +00001869
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001870 return VariableDie;
1871 }
1872
1873 /// NewSubprogram - Add a new subprogram DIE.
1874 ///
1875 DIE *NewSubprogram(SubprogramDesc *SPD) {
1876 // Get the compile unit context.
1877 CompileUnitDesc *UnitDesc =
1878 static_cast<CompileUnitDesc *>(SPD->getContext());
1879 CompileUnit *Unit = GetBaseCompileUnit();
1880
1881 // Check for pre-existence.
1882 DIE *&Slot = Unit->getDieMapSlotFor(SPD);
1883 if (Slot) return Slot;
aslc200b112008-08-16 12:57:46 +00001884
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001885 // Gather the details (simplify add attribute code.)
1886 const std::string &Name = SPD->getName();
1887 const std::string &FullName = SPD->getFullName();
1888 const std::string &LinkageName = SPD->getLinkageName();
aslc200b112008-08-16 12:57:46 +00001889
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001890 DIE *SubprogramDie = new DIE(DW_TAG_subprogram);
1891 AddString(SubprogramDie, DW_AT_name, DW_FORM_string, Name);
1892 if (!LinkageName.empty()) {
1893 AddString(SubprogramDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
1894 LinkageName);
1895 }
1896 if (SPD->getType()) AddType(SubprogramDie, SPD->getType(), Unit);
1897 if (!SPD->isStatic())
1898 AddUInt(SubprogramDie, DW_AT_external, DW_FORM_flag, 1);
1899 AddUInt(SubprogramDie, DW_AT_prototyped, DW_FORM_flag, 1);
aslc200b112008-08-16 12:57:46 +00001900
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001901 // Add source line info if available.
1902 AddSourceLine(SubprogramDie, UnitDesc, SPD->getLine());
1903
1904 // Add to map.
1905 Slot = SubprogramDie;
aslc200b112008-08-16 12:57:46 +00001906
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001907 // Add to context owner.
1908 Unit->getDie()->AddChild(SubprogramDie);
aslc200b112008-08-16 12:57:46 +00001909
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001910 // Expose as global.
1911 Unit->AddGlobal(FullName, SubprogramDie);
aslc200b112008-08-16 12:57:46 +00001912
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001913 return SubprogramDie;
1914 }
1915
1916 /// NewScopeVariable - Create a new scope variable.
1917 ///
1918 DIE *NewScopeVariable(DebugVariable *DV, CompileUnit *Unit) {
1919 // Get the descriptor.
1920 VariableDesc *VD = DV->getDesc();
1921
1922 // Translate tag to proper Dwarf tag. The result variable is dropped for
1923 // now.
1924 unsigned Tag;
1925 switch (VD->getTag()) {
1926 case DW_TAG_return_variable: return NULL;
1927 case DW_TAG_arg_variable: Tag = DW_TAG_formal_parameter; break;
1928 case DW_TAG_auto_variable: // fall thru
1929 default: Tag = DW_TAG_variable; break;
1930 }
1931
1932 // Define variable debug information entry.
1933 DIE *VariableDie = new DIE(Tag);
1934 AddString(VariableDie, DW_AT_name, DW_FORM_string, VD->getName());
1935
1936 // Add source line info if available.
1937 AddSourceLine(VariableDie, VD->getFile(), VD->getLine());
aslc200b112008-08-16 12:57:46 +00001938
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001939 // Add variable type.
aslc200b112008-08-16 12:57:46 +00001940 AddType(VariableDie, VD->getType(), Unit);
1941
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001942 // Add variable address.
1943 MachineLocation Location;
Evan Cheng38948832008-01-31 03:37:28 +00001944 Location.set(RI->getFrameRegister(*MF),
1945 RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001946 AddAddress(VariableDie, DW_AT_location, Location);
1947
1948 return VariableDie;
1949 }
1950
1951 /// ConstructScope - Construct the components of a scope.
1952 ///
1953 void ConstructScope(DebugScope *ParentScope,
1954 unsigned ParentStartID, unsigned ParentEndID,
1955 DIE *ParentDie, CompileUnit *Unit) {
1956 // Add variables to scope.
1957 std::vector<DebugVariable *> &Variables = ParentScope->getVariables();
1958 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
1959 DIE *VariableDie = NewScopeVariable(Variables[i], Unit);
1960 if (VariableDie) ParentDie->AddChild(VariableDie);
1961 }
aslc200b112008-08-16 12:57:46 +00001962
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001963 // Add nested scopes.
1964 std::vector<DebugScope *> &Scopes = ParentScope->getScopes();
1965 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1966 // Define the Scope debug information entry.
1967 DebugScope *Scope = Scopes[j];
1968 // FIXME - Ignore inlined functions for the time being.
1969 if (!Scope->getParent()) continue;
aslc200b112008-08-16 12:57:46 +00001970
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001971 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
1972 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
1973
1974 // Ignore empty scopes.
1975 if (StartID == EndID && StartID != 0) continue;
1976 if (Scope->getScopes().empty() && Scope->getVariables().empty()) continue;
aslc200b112008-08-16 12:57:46 +00001977
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001978 if (StartID == ParentStartID && EndID == ParentEndID) {
1979 // Just add stuff to the parent scope.
1980 ConstructScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
1981 } else {
1982 DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
aslc200b112008-08-16 12:57:46 +00001983
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001984 // Add the scope bounds.
1985 if (StartID) {
1986 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
1987 DWLabel("label", StartID));
1988 } else {
1989 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
1990 DWLabel("func_begin", SubprogramCount));
1991 }
1992 if (EndID) {
1993 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
1994 DWLabel("label", EndID));
1995 } else {
1996 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
1997 DWLabel("func_end", SubprogramCount));
1998 }
aslc200b112008-08-16 12:57:46 +00001999
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002000 // Add the scope contents.
2001 ConstructScope(Scope, StartID, EndID, ScopeDie, Unit);
2002 ParentDie->AddChild(ScopeDie);
2003 }
2004 }
2005 }
2006
2007 /// ConstructRootScope - Construct the scope for the subprogram.
2008 ///
2009 void ConstructRootScope(DebugScope *RootScope) {
2010 // Exit if there is no root scope.
2011 if (!RootScope) return;
aslc200b112008-08-16 12:57:46 +00002012
2013 // Get the subprogram debug information entry.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002014 SubprogramDesc *SPD = cast<SubprogramDesc>(RootScope->getDesc());
aslc200b112008-08-16 12:57:46 +00002015
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002016 // Get the compile unit context.
2017 CompileUnit *Unit = GetBaseCompileUnit();
aslc200b112008-08-16 12:57:46 +00002018
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002019 // Get the subprogram die.
2020 DIE *SPDie = Unit->getDieMapSlotFor(SPD);
2021 assert(SPDie && "Missing subprogram descriptor");
aslc200b112008-08-16 12:57:46 +00002022
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002023 // Add the function bounds.
2024 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2025 DWLabel("func_begin", SubprogramCount));
2026 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2027 DWLabel("func_end", SubprogramCount));
2028 MachineLocation Location(RI->getFrameRegister(*MF));
2029 AddAddress(SPDie, DW_AT_frame_base, Location);
2030
2031 ConstructScope(RootScope, 0, 0, SPDie, Unit);
2032 }
2033
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00002034 /// ConstructDefaultScope - Construct a default scope for the subprogram.
2035 ///
2036 void ConstructDefaultScope(MachineFunction *MF) {
2037 // Find the correct subprogram descriptor.
2038 std::vector<SubprogramDesc *> Subprograms;
2039 MMI->getAnchoredDescriptors<SubprogramDesc>(*M, Subprograms);
2040
2041 for (unsigned i = 0, N = Subprograms.size(); i < N; ++i) {
2042 SubprogramDesc *SPD = Subprograms[i];
2043
2044 if (SPD->getName() == MF->getFunction()->getName()) {
2045 // Get the compile unit context.
2046 CompileUnit *Unit = GetBaseCompileUnit();
2047
2048 // Get the subprogram die.
2049 DIE *SPDie = Unit->getDieMapSlotFor(SPD);
2050 assert(SPDie && "Missing subprogram descriptor");
2051
2052 // Add the function bounds.
2053 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2054 DWLabel("func_begin", SubprogramCount));
2055 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2056 DWLabel("func_end", SubprogramCount));
2057
2058 MachineLocation Location(RI->getFrameRegister(*MF));
2059 AddAddress(SPDie, DW_AT_frame_base, Location);
2060 return;
2061 }
2062 }
2063
2064 assert(0 && "Couldn't find DIE for machine function!");
2065 }
2066
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002067 /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
2068 /// tools to recognize the object file contains Dwarf information.
2069 void EmitInitial() {
2070 // Check to see if we already emitted intial headers.
2071 if (didInitial) return;
2072 didInitial = true;
aslc200b112008-08-16 12:57:46 +00002073
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002074 // Dwarf sections base addresses.
2075 if (TAI->doesDwarfRequireFrameSection()) {
2076 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2077 EmitLabel("section_debug_frame", 0);
2078 }
2079 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2080 EmitLabel("section_info", 0);
2081 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2082 EmitLabel("section_abbrev", 0);
2083 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2084 EmitLabel("section_aranges", 0);
2085 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2086 EmitLabel("section_macinfo", 0);
2087 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2088 EmitLabel("section_line", 0);
2089 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2090 EmitLabel("section_loc", 0);
2091 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2092 EmitLabel("section_pubnames", 0);
2093 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2094 EmitLabel("section_str", 0);
2095 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2096 EmitLabel("section_ranges", 0);
2097
Anton Korobeynikov55b94962008-09-24 22:15:21 +00002098 Asm->SwitchToSection(TAI->getTextSection());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002099 EmitLabel("text_begin", 0);
Anton Korobeynikovcca60fa2008-09-24 22:16:16 +00002100 Asm->SwitchToSection(TAI->getDataSection());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002101 EmitLabel("data_begin", 0);
2102 }
2103
2104 /// EmitDIE - Recusively Emits a debug information entry.
2105 ///
2106 void EmitDIE(DIE *Die) {
2107 // Get the abbreviation for this DIE.
2108 unsigned AbbrevNumber = Die->getAbbrevNumber();
2109 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
aslc200b112008-08-16 12:57:46 +00002110
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002111 Asm->EOL();
2112
2113 // Emit the code (index) for the abbreviation.
2114 Asm->EmitULEB128Bytes(AbbrevNumber);
Evan Cheng0eeed442008-07-01 23:18:29 +00002115
2116 if (VerboseAsm)
2117 Asm->EOL(std::string("Abbrev [" +
2118 utostr(AbbrevNumber) +
2119 "] 0x" + utohexstr(Die->getOffset()) +
2120 ":0x" + utohexstr(Die->getSize()) + " " +
2121 TagString(Abbrev->getTag())));
2122 else
2123 Asm->EOL();
aslc200b112008-08-16 12:57:46 +00002124
Owen Anderson88dd6232008-06-24 21:44:59 +00002125 SmallVector<DIEValue*, 32> &Values = Die->getValues();
2126 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
aslc200b112008-08-16 12:57:46 +00002127
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002128 // Emit the DIE attribute values.
2129 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2130 unsigned Attr = AbbrevData[i].getAttribute();
2131 unsigned Form = AbbrevData[i].getForm();
2132 assert(Form && "Too many attributes for DIE (check abbreviation)");
aslc200b112008-08-16 12:57:46 +00002133
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002134 switch (Attr) {
2135 case DW_AT_sibling: {
2136 Asm->EmitInt32(Die->SiblingOffset());
2137 break;
2138 }
2139 default: {
2140 // Emit an attribute using the defined form.
2141 Values[i]->EmitValue(*this, Form);
2142 break;
2143 }
2144 }
aslc200b112008-08-16 12:57:46 +00002145
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002146 Asm->EOL(AttributeString(Attr));
2147 }
aslc200b112008-08-16 12:57:46 +00002148
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002149 // Emit the DIE children if any.
2150 if (Abbrev->getChildrenFlag() == DW_CHILDREN_yes) {
2151 const std::vector<DIE *> &Children = Die->getChildren();
aslc200b112008-08-16 12:57:46 +00002152
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002153 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2154 EmitDIE(Children[j]);
2155 }
aslc200b112008-08-16 12:57:46 +00002156
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002157 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2158 }
2159 }
2160
2161 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
2162 ///
2163 unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
2164 // Get the children.
2165 const std::vector<DIE *> &Children = Die->getChildren();
aslc200b112008-08-16 12:57:46 +00002166
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002167 // If not last sibling and has children then add sibling offset attribute.
2168 if (!Last && !Children.empty()) Die->AddSiblingOffset();
2169
2170 // Record the abbreviation.
2171 AssignAbbrevNumber(Die->getAbbrev());
aslc200b112008-08-16 12:57:46 +00002172
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002173 // Get the abbreviation for this DIE.
2174 unsigned AbbrevNumber = Die->getAbbrevNumber();
2175 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2176
2177 // Set DIE offset
2178 Die->setOffset(Offset);
aslc200b112008-08-16 12:57:46 +00002179
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002180 // Start the size with the size of abbreviation code.
aslc200b112008-08-16 12:57:46 +00002181 Offset += TargetAsmInfo::getULEB128Size(AbbrevNumber);
2182
Owen Anderson88dd6232008-06-24 21:44:59 +00002183 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2184 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002185
2186 // Size the DIE attribute values.
2187 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2188 // Size attribute value.
2189 Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
2190 }
aslc200b112008-08-16 12:57:46 +00002191
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002192 // Size the DIE children if any.
2193 if (!Children.empty()) {
2194 assert(Abbrev->getChildrenFlag() == DW_CHILDREN_yes &&
2195 "Children flag not set");
aslc200b112008-08-16 12:57:46 +00002196
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002197 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2198 Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
2199 }
aslc200b112008-08-16 12:57:46 +00002200
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002201 // End of children marker.
2202 Offset += sizeof(int8_t);
2203 }
2204
2205 Die->setSize(Offset - Die->getOffset());
2206 return Offset;
2207 }
2208
2209 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
2210 ///
2211 void SizeAndOffsets() {
2212 // Process base compile unit.
2213 CompileUnit *Unit = GetBaseCompileUnit();
2214 // Compute size of compile unit header
2215 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2216 sizeof(int16_t) + // DWARF version number
2217 sizeof(int32_t) + // Offset Into Abbrev. Section
2218 sizeof(int8_t); // Pointer Size (in bytes)
2219 SizeAndOffsetDie(Unit->getDie(), Offset, true);
2220 }
2221
2222 /// EmitDebugInfo - Emit the debug info section.
2223 ///
2224 void EmitDebugInfo() {
2225 // Start debug info section.
2226 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
aslc200b112008-08-16 12:57:46 +00002227
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002228 CompileUnit *Unit = GetBaseCompileUnit();
2229 DIE *Die = Unit->getDie();
2230 // Emit the compile units header.
2231 EmitLabel("info_begin", Unit->getID());
2232 // Emit size of content not including length itself
2233 unsigned ContentSize = Die->getSize() +
2234 sizeof(int16_t) + // DWARF version number
2235 sizeof(int32_t) + // Offset Into Abbrev. Section
2236 sizeof(int8_t) + // Pointer Size (in bytes)
2237 sizeof(int32_t); // FIXME - extra pad for gdb bug.
aslc200b112008-08-16 12:57:46 +00002238
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002239 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2240 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2241 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2242 Asm->EOL("Offset Into Abbrev. Section");
Dan Gohmancfb72b22007-09-27 23:12:31 +00002243 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
aslc200b112008-08-16 12:57:46 +00002244
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002245 EmitDIE(Die);
2246 // FIXME - extra padding for gdb bug.
2247 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2248 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2249 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2250 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2251 EmitLabel("info_end", Unit->getID());
aslc200b112008-08-16 12:57:46 +00002252
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002253 Asm->EOL();
2254 }
2255
2256 /// EmitAbbreviations - Emit the abbreviation section.
2257 ///
2258 void EmitAbbreviations() const {
2259 // Check to see if it is worth the effort.
2260 if (!Abbreviations.empty()) {
2261 // Start the debug abbrev section.
2262 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
aslc200b112008-08-16 12:57:46 +00002263
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002264 EmitLabel("abbrev_begin", 0);
aslc200b112008-08-16 12:57:46 +00002265
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002266 // For each abbrevation.
2267 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2268 // Get abbreviation data
2269 const DIEAbbrev *Abbrev = Abbreviations[i];
aslc200b112008-08-16 12:57:46 +00002270
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002271 // Emit the abbrevations code (base 1 index.)
2272 Asm->EmitULEB128Bytes(Abbrev->getNumber());
2273 Asm->EOL("Abbreviation Code");
aslc200b112008-08-16 12:57:46 +00002274
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002275 // Emit the abbreviations data.
2276 Abbrev->Emit(*this);
aslc200b112008-08-16 12:57:46 +00002277
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002278 Asm->EOL();
2279 }
aslc200b112008-08-16 12:57:46 +00002280
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002281 // Mark end of abbreviations.
2282 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2283
2284 EmitLabel("abbrev_end", 0);
aslc200b112008-08-16 12:57:46 +00002285
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002286 Asm->EOL();
2287 }
2288 }
2289
Bill Wendling1983a2a2008-07-20 00:11:19 +00002290 /// EmitEndOfLineMatrix - Emit the last address of the section and the end of
2291 /// the line matrix.
aslc200b112008-08-16 12:57:46 +00002292 ///
Bill Wendling1983a2a2008-07-20 00:11:19 +00002293 void EmitEndOfLineMatrix(unsigned SectionEnd) {
2294 // Define last address of section.
2295 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2296 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2297 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2298 EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
2299
2300 // Mark end of matrix.
2301 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2302 Asm->EmitULEB128Bytes(1); Asm->EOL();
2303 Asm->EmitInt8(1); Asm->EOL();
2304 }
2305
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002306 /// EmitDebugLines - Emit source line information.
2307 ///
2308 void EmitDebugLines() {
Bill Wendling1983a2a2008-07-20 00:11:19 +00002309 // If the target is using .loc/.file, the assembler will be emitting the
2310 // .debug_line table automatically.
2311 if (TAI->hasDotLocAndDotFile())
Dan Gohmanc55b34a2007-09-24 21:43:52 +00002312 return;
2313
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002314 // Minimum line delta, thus ranging from -10..(255-10).
2315 const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
2316 // Maximum line delta, thus ranging from -10..(255-10).
2317 const int MaxLineDelta = 255 + MinLineDelta;
2318
2319 // Start the dwarf line section.
2320 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
aslc200b112008-08-16 12:57:46 +00002321
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002322 // Construct the section header.
aslc200b112008-08-16 12:57:46 +00002323
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002324 EmitDifference("line_end", 0, "line_begin", 0, true);
2325 Asm->EOL("Length of Source Line Info");
2326 EmitLabel("line_begin", 0);
aslc200b112008-08-16 12:57:46 +00002327
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002328 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
aslc200b112008-08-16 12:57:46 +00002329
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002330 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2331 Asm->EOL("Prolog Length");
2332 EmitLabel("line_prolog_begin", 0);
aslc200b112008-08-16 12:57:46 +00002333
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002334 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2335
2336 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2337
2338 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
aslc200b112008-08-16 12:57:46 +00002339
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002340 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2341
2342 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
aslc200b112008-08-16 12:57:46 +00002343
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002344 // Line number standard opcode encodings argument count
2345 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2346 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2347 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2348 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2349 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2350 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2351 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2352 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2353 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2354
2355 const UniqueVector<std::string> &Directories = MMI->getDirectories();
Evan Cheng0eeed442008-07-01 23:18:29 +00002356 const UniqueVector<SourceFileInfo> &SourceFiles = MMI->getSourceFiles();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002357
2358 // Emit directories.
2359 for (unsigned DirectoryID = 1, NDID = Directories.size();
2360 DirectoryID <= NDID; ++DirectoryID) {
2361 Asm->EmitString(Directories[DirectoryID]); Asm->EOL("Directory");
2362 }
2363 Asm->EmitInt8(0); Asm->EOL("End of directories");
aslc200b112008-08-16 12:57:46 +00002364
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002365 // Emit files.
2366 for (unsigned SourceID = 1, NSID = SourceFiles.size();
2367 SourceID <= NSID; ++SourceID) {
2368 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
2369 Asm->EmitString(SourceFile.getName());
2370 Asm->EOL("Source");
2371 Asm->EmitULEB128Bytes(SourceFile.getDirectoryID());
2372 Asm->EOL("Directory #");
2373 Asm->EmitULEB128Bytes(0);
2374 Asm->EOL("Mod date");
2375 Asm->EmitULEB128Bytes(0);
2376 Asm->EOL("File size");
2377 }
2378 Asm->EmitInt8(0); Asm->EOL("End of files");
aslc200b112008-08-16 12:57:46 +00002379
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002380 EmitLabel("line_prolog_end", 0);
aslc200b112008-08-16 12:57:46 +00002381
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002382 // A sequence for each text section.
Bill Wendling1983a2a2008-07-20 00:11:19 +00002383 unsigned SecSrcLinesSize = SectionSourceLines.size();
2384
2385 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002386 // Isolate current sections line info.
2387 const std::vector<SourceLineInfo> &LineInfos = SectionSourceLines[j];
Evan Cheng0eeed442008-07-01 23:18:29 +00002388
Anton Korobeynikov55b94962008-09-24 22:15:21 +00002389 if (VerboseAsm) {
2390 const Section* S = SectionMap[j + 1];
2391 Asm->EOL(std::string("Section ") + S->getName());
2392 } else
Evan Cheng0eeed442008-07-01 23:18:29 +00002393 Asm->EOL();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002394
2395 // Dwarf assumes we start with first line of first source file.
2396 unsigned Source = 1;
2397 unsigned Line = 1;
aslc200b112008-08-16 12:57:46 +00002398
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002399 // Construct rows of the address, source, line, column matrix.
2400 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2401 const SourceLineInfo &LineInfo = LineInfos[i];
2402 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2403 if (!LabelID) continue;
aslc200b112008-08-16 12:57:46 +00002404
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002405 unsigned SourceID = LineInfo.getSourceID();
2406 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
2407 unsigned DirectoryID = SourceFile.getDirectoryID();
Evan Cheng0eeed442008-07-01 23:18:29 +00002408 if (VerboseAsm)
2409 Asm->EOL(Directories[DirectoryID]
2410 + SourceFile.getName()
2411 + ":"
2412 + utostr_32(LineInfo.getLine()));
2413 else
2414 Asm->EOL();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002415
2416 // Define the line address.
2417 Asm->EmitInt8(0); Asm->EOL("Extended Op");
Dan Gohmancfb72b22007-09-27 23:12:31 +00002418 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002419 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2420 EmitReference("label", LabelID); Asm->EOL("Location label");
aslc200b112008-08-16 12:57:46 +00002421
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002422 // If change of source, then switch to the new source.
2423 if (Source != LineInfo.getSourceID()) {
2424 Source = LineInfo.getSourceID();
2425 Asm->EmitInt8(DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2426 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2427 }
aslc200b112008-08-16 12:57:46 +00002428
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002429 // If change of line.
2430 if (Line != LineInfo.getLine()) {
2431 // Determine offset.
2432 int Offset = LineInfo.getLine() - Line;
2433 int Delta = Offset - MinLineDelta;
aslc200b112008-08-16 12:57:46 +00002434
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002435 // Update line.
2436 Line = LineInfo.getLine();
aslc200b112008-08-16 12:57:46 +00002437
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002438 // If delta is small enough and in range...
2439 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2440 // ... then use fast opcode.
2441 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2442 } else {
2443 // ... otherwise use long hand.
2444 Asm->EmitInt8(DW_LNS_advance_line); Asm->EOL("DW_LNS_advance_line");
2445 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2446 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2447 }
2448 } else {
2449 // Copy the previous row (different address or source)
2450 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2451 }
2452 }
2453
Bill Wendling1983a2a2008-07-20 00:11:19 +00002454 EmitEndOfLineMatrix(j + 1);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002455 }
Bill Wendling1983a2a2008-07-20 00:11:19 +00002456
2457 if (SecSrcLinesSize == 0)
2458 // Because we're emitting a debug_line section, we still need a line
2459 // table. The linker and friends expect it to exist. If there's nothing to
2460 // put into it, emit an empty table.
2461 EmitEndOfLineMatrix(1);
aslc200b112008-08-16 12:57:46 +00002462
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002463 EmitLabel("line_end", 0);
aslc200b112008-08-16 12:57:46 +00002464
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002465 Asm->EOL();
2466 }
aslc200b112008-08-16 12:57:46 +00002467
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002468 /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
2469 ///
2470 void EmitCommonDebugFrame() {
2471 if (!TAI->doesDwarfRequireFrameSection())
2472 return;
2473
2474 int stackGrowth =
2475 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2476 TargetFrameInfo::StackGrowsUp ?
Dan Gohmancfb72b22007-09-27 23:12:31 +00002477 TD->getPointerSize() : -TD->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002478
2479 // Start the dwarf frame section.
2480 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2481
2482 EmitLabel("debug_frame_common", 0);
2483 EmitDifference("debug_frame_common_end", 0,
2484 "debug_frame_common_begin", 0, true);
2485 Asm->EOL("Length of Common Information Entry");
2486
2487 EmitLabel("debug_frame_common_begin", 0);
2488 Asm->EmitInt32((int)DW_CIE_ID);
2489 Asm->EOL("CIE Identifier Tag");
2490 Asm->EmitInt8(DW_CIE_VERSION);
2491 Asm->EOL("CIE Version");
2492 Asm->EmitString("");
2493 Asm->EOL("CIE Augmentation");
2494 Asm->EmitULEB128Bytes(1);
2495 Asm->EOL("CIE Code Alignment Factor");
2496 Asm->EmitSLEB128Bytes(stackGrowth);
aslc200b112008-08-16 12:57:46 +00002497 Asm->EOL("CIE Data Alignment Factor");
Dale Johannesenf5a11532007-11-13 19:13:01 +00002498 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002499 Asm->EOL("CIE RA Column");
aslc200b112008-08-16 12:57:46 +00002500
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002501 std::vector<MachineMove> Moves;
2502 RI->getInitialFrameState(Moves);
2503
Dale Johannesenf5a11532007-11-13 19:13:01 +00002504 EmitFrameMoves(NULL, 0, Moves, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002505
Evan Cheng7e7d1942008-02-29 19:36:59 +00002506 Asm->EmitAlignment(2, 0, 0, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002507 EmitLabel("debug_frame_common_end", 0);
aslc200b112008-08-16 12:57:46 +00002508
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002509 Asm->EOL();
2510 }
2511
2512 /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2513 /// section.
2514 void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
2515 if (!TAI->doesDwarfRequireFrameSection())
2516 return;
aslc200b112008-08-16 12:57:46 +00002517
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002518 // Start the dwarf frame section.
2519 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
aslc200b112008-08-16 12:57:46 +00002520
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002521 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2522 "debug_frame_begin", DebugFrameInfo.Number, true);
2523 Asm->EOL("Length of Frame Information Entry");
aslc200b112008-08-16 12:57:46 +00002524
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002525 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2526
2527 EmitSectionOffset("debug_frame_common", "section_debug_frame",
2528 0, 0, true, false);
2529 Asm->EOL("FDE CIE offset");
2530
2531 EmitReference("func_begin", DebugFrameInfo.Number);
2532 Asm->EOL("FDE initial location");
2533 EmitDifference("func_end", DebugFrameInfo.Number,
2534 "func_begin", DebugFrameInfo.Number);
2535 Asm->EOL("FDE address range");
aslc200b112008-08-16 12:57:46 +00002536
Dale Johannesenf5a11532007-11-13 19:13:01 +00002537 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves, false);
aslc200b112008-08-16 12:57:46 +00002538
Evan Cheng7e7d1942008-02-29 19:36:59 +00002539 Asm->EmitAlignment(2, 0, 0, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002540 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
2541
2542 Asm->EOL();
2543 }
2544
2545 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
2546 ///
2547 void EmitDebugPubNames() {
2548 // Start the dwarf pubnames section.
2549 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
aslc200b112008-08-16 12:57:46 +00002550
2551 CompileUnit *Unit = GetBaseCompileUnit();
2552
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002553 EmitDifference("pubnames_end", Unit->getID(),
2554 "pubnames_begin", Unit->getID(), true);
2555 Asm->EOL("Length of Public Names Info");
aslc200b112008-08-16 12:57:46 +00002556
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002557 EmitLabel("pubnames_begin", Unit->getID());
aslc200b112008-08-16 12:57:46 +00002558
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002559 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF Version");
2560
2561 EmitSectionOffset("info_begin", "section_info",
2562 Unit->getID(), 0, true, false);
2563 Asm->EOL("Offset of Compilation Unit Info");
2564
2565 EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(),true);
2566 Asm->EOL("Compilation Unit Length");
aslc200b112008-08-16 12:57:46 +00002567
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002568 std::map<std::string, DIE *> &Globals = Unit->getGlobals();
aslc200b112008-08-16 12:57:46 +00002569
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002570 for (std::map<std::string, DIE *>::iterator GI = Globals.begin(),
2571 GE = Globals.end();
2572 GI != GE; ++GI) {
2573 const std::string &Name = GI->first;
2574 DIE * Entity = GI->second;
aslc200b112008-08-16 12:57:46 +00002575
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002576 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2577 Asm->EmitString(Name); Asm->EOL("External Name");
2578 }
aslc200b112008-08-16 12:57:46 +00002579
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002580 Asm->EmitInt32(0); Asm->EOL("End Mark");
2581 EmitLabel("pubnames_end", Unit->getID());
aslc200b112008-08-16 12:57:46 +00002582
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002583 Asm->EOL();
2584 }
2585
2586 /// EmitDebugStr - Emit visible names into a debug str section.
2587 ///
2588 void EmitDebugStr() {
2589 // Check to see if it is worth the effort.
2590 if (!StringPool.empty()) {
2591 // Start the dwarf str section.
2592 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
aslc200b112008-08-16 12:57:46 +00002593
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002594 // For each of strings in the string pool.
2595 for (unsigned StringID = 1, N = StringPool.size();
2596 StringID <= N; ++StringID) {
2597 // Emit a label for reference from debug information entries.
2598 EmitLabel("string", StringID);
2599 // Emit the string itself.
2600 const std::string &String = StringPool[StringID];
2601 Asm->EmitString(String); Asm->EOL();
2602 }
aslc200b112008-08-16 12:57:46 +00002603
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002604 Asm->EOL();
2605 }
2606 }
2607
2608 /// EmitDebugLoc - Emit visible names into a debug loc section.
2609 ///
2610 void EmitDebugLoc() {
2611 // Start the dwarf loc section.
2612 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
aslc200b112008-08-16 12:57:46 +00002613
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002614 Asm->EOL();
2615 }
2616
2617 /// EmitDebugARanges - Emit visible names into a debug aranges section.
2618 ///
2619 void EmitDebugARanges() {
2620 // Start the dwarf aranges section.
2621 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
aslc200b112008-08-16 12:57:46 +00002622
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002623 // FIXME - Mock up
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00002624#if 0
aslc200b112008-08-16 12:57:46 +00002625 CompileUnit *Unit = GetBaseCompileUnit();
2626
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002627 // Don't include size of length
2628 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
aslc200b112008-08-16 12:57:46 +00002629
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002630 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("Dwarf Version");
aslc200b112008-08-16 12:57:46 +00002631
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002632 EmitReference("info_begin", Unit->getID());
2633 Asm->EOL("Offset of Compilation Unit Info");
2634
Dan Gohmancfb72b22007-09-27 23:12:31 +00002635 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002636
2637 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
2638
2639 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
2640 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
2641
2642 // Range 1
2643 EmitReference("text_begin", 0); Asm->EOL("Address");
2644 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
2645
2646 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2647 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00002648#endif
aslc200b112008-08-16 12:57:46 +00002649
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002650 Asm->EOL();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002651 }
2652
2653 /// EmitDebugRanges - Emit visible names into a debug ranges section.
2654 ///
2655 void EmitDebugRanges() {
2656 // Start the dwarf ranges section.
2657 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
aslc200b112008-08-16 12:57:46 +00002658
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002659 Asm->EOL();
2660 }
2661
2662 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
2663 ///
2664 void EmitDebugMacInfo() {
2665 // Start the dwarf macinfo section.
2666 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
aslc200b112008-08-16 12:57:46 +00002667
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002668 Asm->EOL();
2669 }
2670
2671 /// ConstructCompileUnitDIEs - Create a compile unit DIE for each source and
2672 /// header file.
2673 void ConstructCompileUnitDIEs() {
2674 const UniqueVector<CompileUnitDesc *> CUW = MMI->getCompileUnits();
aslc200b112008-08-16 12:57:46 +00002675
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002676 for (unsigned i = 1, N = CUW.size(); i <= N; ++i) {
2677 unsigned ID = MMI->RecordSource(CUW[i]);
2678 CompileUnit *Unit = NewCompileUnit(CUW[i], ID);
2679 CompileUnits.push_back(Unit);
2680 }
2681 }
2682
2683 /// ConstructGlobalDIEs - Create DIEs for each of the externally visible
2684 /// global variables.
2685 void ConstructGlobalDIEs() {
Bill Wendling75091f92008-07-03 23:13:02 +00002686 std::vector<GlobalVariableDesc *> GlobalVariables;
2687 MMI->getAnchoredDescriptors<GlobalVariableDesc>(*M, GlobalVariables);
aslc200b112008-08-16 12:57:46 +00002688
Bill Wendling4de8de52008-07-03 22:53:42 +00002689 for (unsigned i = 0, N = GlobalVariables.size(); i < N; ++i) {
2690 GlobalVariableDesc *GVD = GlobalVariables[i];
2691 NewGlobalVariable(GVD);
2692 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002693 }
2694
2695 /// ConstructSubprogramDIEs - Create DIEs for each of the externally visible
2696 /// subprograms.
2697 void ConstructSubprogramDIEs() {
Bill Wendling75091f92008-07-03 23:13:02 +00002698 std::vector<SubprogramDesc *> Subprograms;
2699 MMI->getAnchoredDescriptors<SubprogramDesc>(*M, Subprograms);
aslc200b112008-08-16 12:57:46 +00002700
Bill Wendling4de8de52008-07-03 22:53:42 +00002701 for (unsigned i = 0, N = Subprograms.size(); i < N; ++i) {
2702 SubprogramDesc *SPD = Subprograms[i];
2703 NewSubprogram(SPD);
2704 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002705 }
2706
2707public:
2708 //===--------------------------------------------------------------------===//
2709 // Main entry points.
2710 //
Owen Anderson847b99b2008-08-21 00:14:44 +00002711 DwarfDebug(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
Chris Lattnerb3876c72007-09-24 03:35:37 +00002712 : Dwarf(OS, A, T, "dbg")
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002713 , CompileUnits()
2714 , AbbreviationsSet(InitAbbreviationsSetSize)
2715 , Abbreviations()
2716 , ValuesSet(InitValuesSetSize)
2717 , Values()
2718 , StringPool()
2719 , DescToUnitMap()
2720 , SectionMap()
2721 , SectionSourceLines()
2722 , didInitial(false)
2723 , shouldEmit(false)
2724 {
2725 }
2726 virtual ~DwarfDebug() {
2727 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i)
2728 delete CompileUnits[i];
2729 for (unsigned j = 0, M = Values.size(); j < M; ++j)
2730 delete Values[j];
2731 }
2732
2733 /// SetModuleInfo - Set machine module information when it's known that pass
2734 /// manager has created it. Set by the target AsmPrinter.
2735 void SetModuleInfo(MachineModuleInfo *mmi) {
2736 // Make sure initial declarations are made.
2737 if (!MMI && mmi->hasDebugInfo()) {
2738 MMI = mmi;
2739 shouldEmit = true;
aslc200b112008-08-16 12:57:46 +00002740
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002741 // Create all the compile unit DIEs.
2742 ConstructCompileUnitDIEs();
aslc200b112008-08-16 12:57:46 +00002743
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002744 // Create DIEs for each of the externally visible global variables.
2745 ConstructGlobalDIEs();
2746
2747 // Create DIEs for each of the externally visible subprograms.
2748 ConstructSubprogramDIEs();
aslc200b112008-08-16 12:57:46 +00002749
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002750 // Prime section data.
2751 SectionMap.insert(TAI->getTextSection());
Dan Gohman6d6c2402007-10-01 22:40:20 +00002752
2753 // Print out .file directives to specify files for .loc directives. These
2754 // are printed out early so that they precede any .loc directives.
2755 if (TAI->hasDotLocAndDotFile()) {
2756 const UniqueVector<SourceFileInfo> &SourceFiles = MMI->getSourceFiles();
2757 const UniqueVector<std::string> &Directories = MMI->getDirectories();
2758 for (unsigned i = 1, e = SourceFiles.size(); i <= e; ++i) {
2759 sys::Path FullPath(Directories[SourceFiles[i].getDirectoryID()]);
2760 bool AppendOk = FullPath.appendComponent(SourceFiles[i].getName());
2761 assert(AppendOk && "Could not append filename to directory!");
2762 Asm->EmitFile(i, FullPath.toString());
2763 Asm->EOL();
2764 }
2765 }
2766
2767 // Emit initial sections
2768 EmitInitial();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002769 }
2770 }
2771
2772 /// BeginModule - Emit all Dwarf sections that should come prior to the
2773 /// content.
2774 void BeginModule(Module *M) {
2775 this->M = M;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002776 }
2777
2778 /// EndModule - Emit all Dwarf sections that should come after the content.
2779 ///
2780 void EndModule() {
2781 if (!ShouldEmitDwarf()) return;
aslc200b112008-08-16 12:57:46 +00002782
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002783 // Standard sections final addresses.
Anton Korobeynikov55b94962008-09-24 22:15:21 +00002784 Asm->SwitchToSection(TAI->getTextSection());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002785 EmitLabel("text_end", 0);
Anton Korobeynikovcca60fa2008-09-24 22:16:16 +00002786 Asm->SwitchToSection(TAI->getDataSection());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002787 EmitLabel("data_end", 0);
aslc200b112008-08-16 12:57:46 +00002788
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002789 // End text sections.
2790 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Anton Korobeynikov55b94962008-09-24 22:15:21 +00002791 Asm->SwitchToSection(SectionMap[i]);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002792 EmitLabel("section_end", i);
2793 }
2794
2795 // Emit common frame information.
2796 EmitCommonDebugFrame();
2797
2798 // Emit function debug frame information
2799 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2800 E = DebugFrames.end(); I != E; ++I)
2801 EmitFunctionDebugFrame(*I);
2802
2803 // Compute DIE offsets and sizes.
2804 SizeAndOffsets();
aslc200b112008-08-16 12:57:46 +00002805
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002806 // Emit all the DIEs into a debug info section
2807 EmitDebugInfo();
aslc200b112008-08-16 12:57:46 +00002808
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002809 // Corresponding abbreviations into a abbrev section.
2810 EmitAbbreviations();
aslc200b112008-08-16 12:57:46 +00002811
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002812 // Emit source line correspondence into a debug line section.
2813 EmitDebugLines();
aslc200b112008-08-16 12:57:46 +00002814
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002815 // Emit info into a debug pubnames section.
2816 EmitDebugPubNames();
aslc200b112008-08-16 12:57:46 +00002817
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002818 // Emit info into a debug str section.
2819 EmitDebugStr();
aslc200b112008-08-16 12:57:46 +00002820
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002821 // Emit info into a debug loc section.
2822 EmitDebugLoc();
aslc200b112008-08-16 12:57:46 +00002823
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002824 // Emit info into a debug aranges section.
2825 EmitDebugARanges();
aslc200b112008-08-16 12:57:46 +00002826
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002827 // Emit info into a debug ranges section.
2828 EmitDebugRanges();
aslc200b112008-08-16 12:57:46 +00002829
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002830 // Emit info into a debug macinfo section.
2831 EmitDebugMacInfo();
2832 }
2833
aslc200b112008-08-16 12:57:46 +00002834 /// BeginFunction - Gather pre-function debug information. Assumes being
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002835 /// emitted immediately after the function entry point.
2836 void BeginFunction(MachineFunction *MF) {
2837 this->MF = MF;
aslc200b112008-08-16 12:57:46 +00002838
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002839 if (!ShouldEmitDwarf()) return;
2840
2841 // Begin accumulating function debug information.
2842 MMI->BeginFunction(MF);
aslc200b112008-08-16 12:57:46 +00002843
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002844 // Assumes in correct section after the entry point.
2845 EmitLabel("func_begin", ++SubprogramCount);
Evan Chenga53c40a2008-02-01 09:10:45 +00002846
2847 // Emit label for the implicitly defined dbg.stoppoint at the start of
2848 // the function.
Andrew Lenharth42f91402008-04-03 17:37:43 +00002849 const std::vector<SourceLineInfo> &LineInfos = MMI->getSourceLines();
2850 if (!LineInfos.empty()) {
2851 const SourceLineInfo &LineInfo = LineInfos[0];
2852 Asm->printLabel(LineInfo.getLabelID());
2853 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002854 }
aslc200b112008-08-16 12:57:46 +00002855
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002856 /// EndFunction - Gather and emit post-function debug information.
2857 ///
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00002858 void EndFunction(MachineFunction *MF) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002859 if (!ShouldEmitDwarf()) return;
aslc200b112008-08-16 12:57:46 +00002860
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002861 // Define end label for subprogram.
2862 EmitLabel("func_end", SubprogramCount);
aslc200b112008-08-16 12:57:46 +00002863
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002864 // Get function line info.
2865 const std::vector<SourceLineInfo> &LineInfos = MMI->getSourceLines();
2866
2867 if (!LineInfos.empty()) {
2868 // Get section line info.
Anton Korobeynikov55b94962008-09-24 22:15:21 +00002869 unsigned ID = SectionMap.insert(Asm->CurrentSection_);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002870 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2871 std::vector<SourceLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2872 // Append the function info to section info.
2873 SectionLineInfos.insert(SectionLineInfos.end(),
2874 LineInfos.begin(), LineInfos.end());
2875 }
aslc200b112008-08-16 12:57:46 +00002876
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002877 // Construct scopes for subprogram.
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00002878 if (MMI->getRootScope())
2879 ConstructRootScope(MMI->getRootScope());
2880 else
2881 // FIXME: This is wrong. We are essentially getting past a problem with
2882 // debug information not being able to handle unreachable blocks that have
2883 // debug information in them. In particular, those unreachable blocks that
2884 // have "region end" info in them. That situation results in the "root
2885 // scope" not being created. If that's the case, then emit a "default"
2886 // scope, i.e., one that encompasses the whole function. This isn't
2887 // desirable. And a better way of handling this (and all of the debugging
2888 // information) needs to be explored.
2889 ConstructDefaultScope(MF);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002890
2891 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
2892 MMI->getFrameMoves()));
2893 }
2894};
2895
2896//===----------------------------------------------------------------------===//
aslc200b112008-08-16 12:57:46 +00002897/// DwarfException - Emits Dwarf exception handling directives.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002898///
2899class DwarfException : public Dwarf {
2900
2901private:
2902 struct FunctionEHFrameInfo {
2903 std::string FnName;
2904 unsigned Number;
2905 unsigned PersonalityIndex;
2906 bool hasCalls;
2907 bool hasLandingPads;
2908 std::vector<MachineMove> Moves;
Dale Johannesen3dadeb32008-01-16 19:59:28 +00002909 const Function * function;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002910
2911 FunctionEHFrameInfo(const std::string &FN, unsigned Num, unsigned P,
2912 bool hC, bool hL,
Dale Johannesenfb3ac732007-11-20 23:24:42 +00002913 const std::vector<MachineMove> &M,
Dale Johannesen3dadeb32008-01-16 19:59:28 +00002914 const Function *f):
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002915 FnName(FN), Number(Num), PersonalityIndex(P),
Dale Johannesen3dadeb32008-01-16 19:59:28 +00002916 hasCalls(hC), hasLandingPads(hL), Moves(M), function (f) { }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002917 };
2918
2919 std::vector<FunctionEHFrameInfo> EHFrames;
Dale Johannesen85535762008-04-02 00:25:04 +00002920
2921 /// shouldEmitTable - Per-function flag to indicate if EH tables should
2922 /// be emitted.
2923 bool shouldEmitTable;
2924
2925 /// shouldEmitMoves - Per-function flag to indicate if frame moves info
2926 /// should be emitted.
2927 bool shouldEmitMoves;
2928
2929 /// shouldEmitTableModule - Per-module flag to indicate if EH tables
2930 /// should be emitted.
2931 bool shouldEmitTableModule;
2932
aslc200b112008-08-16 12:57:46 +00002933 /// shouldEmitFrameModule - Per-module flag to indicate if frame moves
Dale Johannesen85535762008-04-02 00:25:04 +00002934 /// should be emitted.
2935 bool shouldEmitMovesModule;
Duncan Sands96144f92008-05-07 19:11:09 +00002936
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002937 /// EmitCommonEHFrame - Emit the common eh unwind frame.
2938 ///
2939 void EmitCommonEHFrame(const Function *Personality, unsigned Index) {
2940 // Size and sign of stack growth.
2941 int stackGrowth =
2942 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2943 TargetFrameInfo::StackGrowsUp ?
Dan Gohmancfb72b22007-09-27 23:12:31 +00002944 TD->getPointerSize() : -TD->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002945
2946 // Begin eh frame section.
2947 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
2948 O << "EH_frame" << Index << ":\n";
2949 EmitLabel("section_eh_frame", Index);
2950
2951 // Define base labels.
2952 EmitLabel("eh_frame_common", Index);
Duncan Sands96144f92008-05-07 19:11:09 +00002953
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002954 // Define the eh frame length.
2955 EmitDifference("eh_frame_common_end", Index,
2956 "eh_frame_common_begin", Index, true);
2957 Asm->EOL("Length of Common Information Entry");
2958
2959 // EH frame header.
2960 EmitLabel("eh_frame_common_begin", Index);
2961 Asm->EmitInt32((int)0);
2962 Asm->EOL("CIE Identifier Tag");
2963 Asm->EmitInt8(DW_CIE_VERSION);
2964 Asm->EOL("CIE Version");
Duncan Sands96144f92008-05-07 19:11:09 +00002965
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002966 // The personality presence indicates that language specific information
2967 // will show up in the eh frame.
2968 Asm->EmitString(Personality ? "zPLR" : "zR");
2969 Asm->EOL("CIE Augmentation");
Duncan Sands96144f92008-05-07 19:11:09 +00002970
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002971 // Round out reader.
2972 Asm->EmitULEB128Bytes(1);
2973 Asm->EOL("CIE Code Alignment Factor");
2974 Asm->EmitSLEB128Bytes(stackGrowth);
Duncan Sands96144f92008-05-07 19:11:09 +00002975 Asm->EOL("CIE Data Alignment Factor");
Dale Johannesenf5a11532007-11-13 19:13:01 +00002976 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), true));
Duncan Sands96144f92008-05-07 19:11:09 +00002977 Asm->EOL("CIE Return Address Column");
2978
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002979 // If there is a personality, we need to indicate the functions location.
2980 if (Personality) {
2981 Asm->EmitULEB128Bytes(7);
2982 Asm->EOL("Augmentation Size");
Bill Wendling2d369922007-09-11 17:20:55 +00002983
Duncan Sands96144f92008-05-07 19:11:09 +00002984 if (TAI->getNeedsIndirectEncoding()) {
Bill Wendling2d369922007-09-11 17:20:55 +00002985 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4 | DW_EH_PE_indirect);
Duncan Sands96144f92008-05-07 19:11:09 +00002986 Asm->EOL("Personality (pcrel sdata4 indirect)");
2987 } else {
Bill Wendling2d369922007-09-11 17:20:55 +00002988 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
Duncan Sands96144f92008-05-07 19:11:09 +00002989 Asm->EOL("Personality (pcrel sdata4)");
2990 }
Bill Wendling2d369922007-09-11 17:20:55 +00002991
Duncan Sands96144f92008-05-07 19:11:09 +00002992 PrintRelDirective(true);
Bill Wendlingd1bda4f2007-09-11 08:27:17 +00002993 O << TAI->getPersonalityPrefix();
2994 Asm->EmitExternalGlobal((const GlobalVariable *)(Personality));
2995 O << TAI->getPersonalitySuffix();
Duncan Sands4cc39532008-05-08 12:33:11 +00002996 if (strcmp(TAI->getPersonalitySuffix(), "+4@GOTPCREL"))
2997 O << "-" << TAI->getPCSymbol();
Bill Wendlingd1bda4f2007-09-11 08:27:17 +00002998 Asm->EOL("Personality");
Bill Wendling38cb7c92007-08-25 00:51:55 +00002999
Duncan Sands96144f92008-05-07 19:11:09 +00003000 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3001 Asm->EOL("LSDA Encoding (pcrel sdata4)");
3002 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3003 Asm->EOL("FDE Encoding (pcrel sdata4)");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003004 } else {
3005 Asm->EmitULEB128Bytes(1);
3006 Asm->EOL("Augmentation Size");
Duncan Sands96144f92008-05-07 19:11:09 +00003007 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3008 Asm->EOL("FDE Encoding (pcrel sdata4)");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003009 }
3010
3011 // Indicate locations of general callee saved registers in frame.
3012 std::vector<MachineMove> Moves;
3013 RI->getInitialFrameState(Moves);
Dale Johannesenf5a11532007-11-13 19:13:01 +00003014 EmitFrameMoves(NULL, 0, Moves, true);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003015
Dale Johannesen388f20f2008-04-30 00:43:29 +00003016 // On Darwin the linker honors the alignment of eh_frame, which means it
3017 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3018 // you get holes which confuse readers of eh_frame.
aslc200b112008-08-16 12:57:46 +00003019 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
Dale Johannesen837d7ab2008-04-29 22:58:20 +00003020 0, 0, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003021 EmitLabel("eh_frame_common_end", Index);
Duncan Sands96144f92008-05-07 19:11:09 +00003022
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003023 Asm->EOL();
3024 }
Duncan Sands96144f92008-05-07 19:11:09 +00003025
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003026 /// EmitEHFrame - Emit function exception frame information.
3027 ///
3028 void EmitEHFrame(const FunctionEHFrameInfo &EHFrameInfo) {
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003029 Function::LinkageTypes linkage = EHFrameInfo.function->getLinkage();
3030
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003031 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3032
3033 // Externally visible entry into the functions eh frame info.
Dale Johannesenfb3ac732007-11-20 23:24:42 +00003034 // If the corresponding function is static, this should not be
3035 // externally visible.
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003036 if (linkage != Function::InternalLinkage) {
Dale Johannesenfb3ac732007-11-20 23:24:42 +00003037 if (const char *GlobalEHDirective = TAI->getGlobalEHDirective())
3038 O << GlobalEHDirective << EHFrameInfo.FnName << "\n";
3039 }
3040
Dale Johannesenf09b5992008-01-10 02:03:30 +00003041 // If corresponding function is weak definition, this should be too.
aslc200b112008-08-16 12:57:46 +00003042 if ((linkage == Function::WeakLinkage ||
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003043 linkage == Function::LinkOnceLinkage) &&
Dale Johannesenf09b5992008-01-10 02:03:30 +00003044 TAI->getWeakDefDirective())
3045 O << TAI->getWeakDefDirective() << EHFrameInfo.FnName << "\n";
3046
3047 // If there are no calls then you can't unwind. This may mean we can
3048 // omit the EH Frame, but some environments do not handle weak absolute
aslc200b112008-08-16 12:57:46 +00003049 // symbols.
Dale Johannesenb369e8d2008-04-14 17:54:17 +00003050 // If UnwindTablesMandatory is set we cannot do this optimization; the
Dale Johannesena9b3e482008-04-08 00:10:24 +00003051 // unwind info is to be available for non-EH uses.
Dale Johannesenf09b5992008-01-10 02:03:30 +00003052 if (!EHFrameInfo.hasCalls &&
Dale Johannesenb369e8d2008-04-14 17:54:17 +00003053 !UnwindTablesMandatory &&
aslc200b112008-08-16 12:57:46 +00003054 ((linkage != Function::WeakLinkage &&
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003055 linkage != Function::LinkOnceLinkage) ||
Dale Johannesenf09b5992008-01-10 02:03:30 +00003056 !TAI->getWeakDefDirective() ||
3057 TAI->getSupportsWeakOmittedEHFrame()))
aslc200b112008-08-16 12:57:46 +00003058 {
Bill Wendlingef9211a2007-09-18 01:47:22 +00003059 O << EHFrameInfo.FnName << " = 0\n";
aslc200b112008-08-16 12:57:46 +00003060 // This name has no connection to the function, so it might get
3061 // dead-stripped when the function is not, erroneously. Prohibit
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003062 // dead-stripping unconditionally.
3063 if (const char *UsedDirective = TAI->getUsedDirective())
3064 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003065 } else {
Bill Wendlingef9211a2007-09-18 01:47:22 +00003066 O << EHFrameInfo.FnName << ":\n";
Dale Johannesenfb3ac732007-11-20 23:24:42 +00003067
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003068 // EH frame header.
3069 EmitDifference("eh_frame_end", EHFrameInfo.Number,
3070 "eh_frame_begin", EHFrameInfo.Number, true);
3071 Asm->EOL("Length of Frame Information Entry");
aslc200b112008-08-16 12:57:46 +00003072
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003073 EmitLabel("eh_frame_begin", EHFrameInfo.Number);
3074
3075 EmitSectionOffset("eh_frame_begin", "eh_frame_common",
3076 EHFrameInfo.Number, EHFrameInfo.PersonalityIndex,
Dale Johannesen0ebb2432008-03-26 23:31:39 +00003077 true, true, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003078 Asm->EOL("FDE CIE offset");
3079
Duncan Sands96144f92008-05-07 19:11:09 +00003080 EmitReference("eh_func_begin", EHFrameInfo.Number, true, true);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003081 Asm->EOL("FDE initial location");
3082 EmitDifference("eh_func_end", EHFrameInfo.Number,
Duncan Sands96144f92008-05-07 19:11:09 +00003083 "eh_func_begin", EHFrameInfo.Number, true);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003084 Asm->EOL("FDE address range");
Duncan Sands96144f92008-05-07 19:11:09 +00003085
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003086 // If there is a personality and landing pads then point to the language
3087 // specific data area in the exception table.
3088 if (EHFrameInfo.PersonalityIndex) {
Duncan Sands96144f92008-05-07 19:11:09 +00003089 Asm->EmitULEB128Bytes(4);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003090 Asm->EOL("Augmentation size");
Duncan Sands96144f92008-05-07 19:11:09 +00003091
3092 if (EHFrameInfo.hasLandingPads)
3093 EmitReference("exception", EHFrameInfo.Number, true, true);
3094 else
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003095 Asm->EmitInt32((int)0);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003096 Asm->EOL("Language Specific Data Area");
3097 } else {
3098 Asm->EmitULEB128Bytes(0);
3099 Asm->EOL("Augmentation size");
3100 }
Duncan Sands96144f92008-05-07 19:11:09 +00003101
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003102 // Indicate locations of function specific callee saved registers in
3103 // frame.
Dale Johannesenf5a11532007-11-13 19:13:01 +00003104 EmitFrameMoves("eh_func_begin", EHFrameInfo.Number, EHFrameInfo.Moves, true);
aslc200b112008-08-16 12:57:46 +00003105
Dale Johannesen388f20f2008-04-30 00:43:29 +00003106 // On Darwin the linker honors the alignment of eh_frame, which means it
3107 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3108 // you get holes which confuse readers of eh_frame.
aslc200b112008-08-16 12:57:46 +00003109 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
Dale Johannesen837d7ab2008-04-29 22:58:20 +00003110 0, 0, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003111 EmitLabel("eh_frame_end", EHFrameInfo.Number);
aslc200b112008-08-16 12:57:46 +00003112
3113 // If the function is marked used, this table should be also. We cannot
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003114 // make the mark unconditional in this case, since retaining the table
aslc200b112008-08-16 12:57:46 +00003115 // also retains the function in this case, and there is code around
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003116 // that depends on unused functions (calling undefined externals) being
3117 // dead-stripped to link correctly. Yes, there really is.
3118 if (MMI->getUsedFunctions().count(EHFrameInfo.function))
3119 if (const char *UsedDirective = TAI->getUsedDirective())
3120 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3121 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003122 }
3123
Duncan Sands241a0c92007-09-05 11:27:52 +00003124 /// EmitExceptionTable - Emit landing pads and actions.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003125 ///
3126 /// The general organization of the table is complex, but the basic concepts
3127 /// are easy. First there is a header which describes the location and
3128 /// organization of the three components that follow.
3129 /// 1. The landing pad site information describes the range of code covered
3130 /// by the try. In our case it's an accumulation of the ranges covered
3131 /// by the invokes in the try. There is also a reference to the landing
3132 /// pad that handles the exception once processed. Finally an index into
3133 /// the actions table.
3134 /// 2. The action table, in our case, is composed of pairs of type ids
3135 /// and next action offset. Starting with the action index from the
3136 /// landing pad site, each type Id is checked for a match to the current
3137 /// exception. If it matches then the exception and type id are passed
3138 /// on to the landing pad. Otherwise the next action is looked up. This
3139 /// chain is terminated with a next action of zero. If no type id is
3140 /// found the the frame is unwound and handling continues.
3141 /// 3. Type id table contains references to all the C++ typeinfo for all
3142 /// catches in the function. This tables is reversed indexed base 1.
3143
3144 /// SharedTypeIds - How many leading type ids two landing pads have in common.
3145 static unsigned SharedTypeIds(const LandingPadInfo *L,
3146 const LandingPadInfo *R) {
3147 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3148 unsigned LSize = LIds.size(), RSize = RIds.size();
3149 unsigned MinSize = LSize < RSize ? LSize : RSize;
3150 unsigned Count = 0;
3151
3152 for (; Count != MinSize; ++Count)
3153 if (LIds[Count] != RIds[Count])
3154 return Count;
3155
3156 return Count;
3157 }
3158
3159 /// PadLT - Order landing pads lexicographically by type id.
3160 static bool PadLT(const LandingPadInfo *L, const LandingPadInfo *R) {
3161 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3162 unsigned LSize = LIds.size(), RSize = RIds.size();
3163 unsigned MinSize = LSize < RSize ? LSize : RSize;
3164
3165 for (unsigned i = 0; i != MinSize; ++i)
3166 if (LIds[i] != RIds[i])
3167 return LIds[i] < RIds[i];
3168
3169 return LSize < RSize;
3170 }
3171
3172 struct KeyInfo {
3173 static inline unsigned getEmptyKey() { return -1U; }
3174 static inline unsigned getTombstoneKey() { return -2U; }
3175 static unsigned getHashValue(const unsigned &Key) { return Key; }
Chris Lattner92eea072007-09-17 18:34:04 +00003176 static bool isEqual(unsigned LHS, unsigned RHS) { return LHS == RHS; }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003177 static bool isPod() { return true; }
3178 };
3179
Duncan Sands241a0c92007-09-05 11:27:52 +00003180 /// ActionEntry - Structure describing an entry in the actions table.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003181 struct ActionEntry {
3182 int ValueForTypeID; // The value to write - may not be equal to the type id.
3183 int NextAction;
3184 struct ActionEntry *Previous;
3185 };
3186
Duncan Sands241a0c92007-09-05 11:27:52 +00003187 /// PadRange - Structure holding a try-range and the associated landing pad.
3188 struct PadRange {
3189 // The index of the landing pad.
3190 unsigned PadIndex;
3191 // The index of the begin and end labels in the landing pad's label lists.
3192 unsigned RangeIndex;
3193 };
3194
3195 typedef DenseMap<unsigned, PadRange, KeyInfo> RangeMapType;
3196
3197 /// CallSiteEntry - Structure describing an entry in the call-site table.
3198 struct CallSiteEntry {
Duncan Sands4ff179f2007-12-19 07:36:31 +00003199 // The 'try-range' is BeginLabel .. EndLabel.
Duncan Sands241a0c92007-09-05 11:27:52 +00003200 unsigned BeginLabel; // zero indicates the start of the function.
3201 unsigned EndLabel; // zero indicates the end of the function.
Duncan Sands4ff179f2007-12-19 07:36:31 +00003202 // The landing pad starts at PadLabel.
Duncan Sands241a0c92007-09-05 11:27:52 +00003203 unsigned PadLabel; // zero indicates that there is no landing pad.
3204 unsigned Action;
3205 };
3206
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003207 void EmitExceptionTable() {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003208 const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
3209 const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
3210 const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
3211 if (PadInfos.empty()) return;
3212
3213 // Sort the landing pads in order of their type ids. This is used to fold
3214 // duplicate actions.
3215 SmallVector<const LandingPadInfo *, 64> LandingPads;
3216 LandingPads.reserve(PadInfos.size());
3217 for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
3218 LandingPads.push_back(&PadInfos[i]);
3219 std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
3220
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003221 // Negative type ids index into FilterIds, positive type ids index into
3222 // TypeInfos. The value written for a positive type id is just the type
3223 // id itself. For a negative type id, however, the value written is the
3224 // (negative) byte offset of the corresponding FilterIds entry. The byte
3225 // offset is usually equal to the type id, because the FilterIds entries
3226 // are written using a variable width encoding which outputs one byte per
3227 // entry as long as the value written is not too large, but can differ.
3228 // This kind of complication does not occur for positive type ids because
3229 // type infos are output using a fixed width encoding.
3230 // FilterOffsets[i] holds the byte offset corresponding to FilterIds[i].
3231 SmallVector<int, 16> FilterOffsets;
3232 FilterOffsets.reserve(FilterIds.size());
3233 int Offset = -1;
3234 for(std::vector<unsigned>::const_iterator I = FilterIds.begin(),
3235 E = FilterIds.end(); I != E; ++I) {
3236 FilterOffsets.push_back(Offset);
aslc200b112008-08-16 12:57:46 +00003237 Offset -= TargetAsmInfo::getULEB128Size(*I);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003238 }
3239
Duncan Sands241a0c92007-09-05 11:27:52 +00003240 // Compute the actions table and gather the first action index for each
3241 // landing pad site.
3242 SmallVector<ActionEntry, 32> Actions;
3243 SmallVector<unsigned, 64> FirstActions;
3244 FirstActions.reserve(LandingPads.size());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003245
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003246 int FirstAction = 0;
Duncan Sands241a0c92007-09-05 11:27:52 +00003247 unsigned SizeActions = 0;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003248 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3249 const LandingPadInfo *LP = LandingPads[i];
3250 const std::vector<int> &TypeIds = LP->TypeIds;
3251 const unsigned NumShared = i ? SharedTypeIds(LP, LandingPads[i-1]) : 0;
3252 unsigned SizeSiteActions = 0;
3253
3254 if (NumShared < TypeIds.size()) {
3255 unsigned SizeAction = 0;
3256 ActionEntry *PrevAction = 0;
3257
3258 if (NumShared) {
3259 const unsigned SizePrevIds = LandingPads[i-1]->TypeIds.size();
3260 assert(Actions.size());
3261 PrevAction = &Actions.back();
aslc200b112008-08-16 12:57:46 +00003262 SizeAction = TargetAsmInfo::getSLEB128Size(PrevAction->NextAction) +
3263 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003264 for (unsigned j = NumShared; j != SizePrevIds; ++j) {
aslc200b112008-08-16 12:57:46 +00003265 SizeAction -=
3266 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003267 SizeAction += -PrevAction->NextAction;
3268 PrevAction = PrevAction->Previous;
3269 }
3270 }
3271
3272 // Compute the actions.
3273 for (unsigned I = NumShared, M = TypeIds.size(); I != M; ++I) {
3274 int TypeID = TypeIds[I];
3275 assert(-1-TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
3276 int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
aslc200b112008-08-16 12:57:46 +00003277 unsigned SizeTypeID = TargetAsmInfo::getSLEB128Size(ValueForTypeID);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003278
3279 int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
aslc200b112008-08-16 12:57:46 +00003280 SizeAction = SizeTypeID + TargetAsmInfo::getSLEB128Size(NextAction);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003281 SizeSiteActions += SizeAction;
3282
3283 ActionEntry Action = {ValueForTypeID, NextAction, PrevAction};
3284 Actions.push_back(Action);
3285
3286 PrevAction = &Actions.back();
3287 }
3288
3289 // Record the first action of the landing pad site.
3290 FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
3291 } // else identical - re-use previous FirstAction
3292
3293 FirstActions.push_back(FirstAction);
3294
3295 // Compute this sites contribution to size.
3296 SizeActions += SizeSiteActions;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003297 }
Duncan Sands241a0c92007-09-05 11:27:52 +00003298
Duncan Sands4ff179f2007-12-19 07:36:31 +00003299 // Compute the call-site table. The entry for an invoke has a try-range
3300 // containing the call, a non-zero landing pad and an appropriate action.
3301 // The entry for an ordinary call has a try-range containing the call and
3302 // zero for the landing pad and the action. Calls marked 'nounwind' have
3303 // no entry and must not be contained in the try-range of any entry - they
3304 // form gaps in the table. Entries must be ordered by try-range address.
Duncan Sands241a0c92007-09-05 11:27:52 +00003305 SmallVector<CallSiteEntry, 64> CallSites;
3306
3307 RangeMapType PadMap;
Duncan Sands4ff179f2007-12-19 07:36:31 +00003308 // Invokes and nounwind calls have entries in PadMap (due to being bracketed
3309 // by try-range labels when lowered). Ordinary calls do not, so appropriate
3310 // try-ranges for them need be deduced.
Duncan Sands241a0c92007-09-05 11:27:52 +00003311 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3312 const LandingPadInfo *LandingPad = LandingPads[i];
Duncan Sands4ff179f2007-12-19 07:36:31 +00003313 for (unsigned j = 0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
Duncan Sands241a0c92007-09-05 11:27:52 +00003314 unsigned BeginLabel = LandingPad->BeginLabels[j];
3315 assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
3316 PadRange P = { i, j };
3317 PadMap[BeginLabel] = P;
3318 }
3319 }
3320
Duncan Sands4ff179f2007-12-19 07:36:31 +00003321 // The end label of the previous invoke or nounwind try-range.
Duncan Sands241a0c92007-09-05 11:27:52 +00003322 unsigned LastLabel = 0;
Duncan Sands4ff179f2007-12-19 07:36:31 +00003323
3324 // Whether there is a potentially throwing instruction (currently this means
3325 // an ordinary call) between the end of the previous try-range and now.
3326 bool SawPotentiallyThrowing = false;
3327
3328 // Whether the last callsite entry was for an invoke.
3329 bool PreviousIsInvoke = false;
3330
Duncan Sands4ff179f2007-12-19 07:36:31 +00003331 // Visit all instructions in order of address.
Duncan Sands241a0c92007-09-05 11:27:52 +00003332 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
3333 I != E; ++I) {
3334 for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
3335 MI != E; ++MI) {
Dan Gohmanfa607c92008-07-01 00:05:16 +00003336 if (!MI->isLabel()) {
Chris Lattner5b930372008-01-07 07:27:27 +00003337 SawPotentiallyThrowing |= MI->getDesc().isCall();
Duncan Sands241a0c92007-09-05 11:27:52 +00003338 continue;
3339 }
3340
Chris Lattnerda4cff12007-12-30 20:50:28 +00003341 unsigned BeginLabel = MI->getOperand(0).getImm();
Duncan Sands241a0c92007-09-05 11:27:52 +00003342 assert(BeginLabel && "Invalid label!");
Duncan Sands89372f62007-09-05 14:12:46 +00003343
Duncan Sands4ff179f2007-12-19 07:36:31 +00003344 // End of the previous try-range?
Duncan Sands89372f62007-09-05 14:12:46 +00003345 if (BeginLabel == LastLabel)
Duncan Sands4ff179f2007-12-19 07:36:31 +00003346 SawPotentiallyThrowing = false;
Duncan Sands241a0c92007-09-05 11:27:52 +00003347
Duncan Sands4ff179f2007-12-19 07:36:31 +00003348 // Beginning of a new try-range?
Duncan Sands241a0c92007-09-05 11:27:52 +00003349 RangeMapType::iterator L = PadMap.find(BeginLabel);
Duncan Sands241a0c92007-09-05 11:27:52 +00003350 if (L == PadMap.end())
Duncan Sands4ff179f2007-12-19 07:36:31 +00003351 // Nope, it was just some random label.
Duncan Sands241a0c92007-09-05 11:27:52 +00003352 continue;
3353
3354 PadRange P = L->second;
3355 const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
3356
3357 assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
3358 "Inconsistent landing pad map!");
3359
3360 // If some instruction between the previous try-range and this one may
3361 // throw, create a call-site entry with no landing pad for the region
3362 // between the try-ranges.
Duncan Sands4ff179f2007-12-19 07:36:31 +00003363 if (SawPotentiallyThrowing) {
Duncan Sands241a0c92007-09-05 11:27:52 +00003364 CallSiteEntry Site = {LastLabel, BeginLabel, 0, 0};
3365 CallSites.push_back(Site);
Duncan Sands4ff179f2007-12-19 07:36:31 +00003366 PreviousIsInvoke = false;
Duncan Sands241a0c92007-09-05 11:27:52 +00003367 }
3368
3369 LastLabel = LandingPad->EndLabels[P.RangeIndex];
Duncan Sands4ff179f2007-12-19 07:36:31 +00003370 assert(BeginLabel && LastLabel && "Invalid landing pad!");
Duncan Sands241a0c92007-09-05 11:27:52 +00003371
Duncan Sands4ff179f2007-12-19 07:36:31 +00003372 if (LandingPad->LandingPadLabel) {
3373 // This try-range is for an invoke.
3374 CallSiteEntry Site = {BeginLabel, LastLabel,
3375 LandingPad->LandingPadLabel, FirstActions[P.PadIndex]};
Duncan Sands241a0c92007-09-05 11:27:52 +00003376
Duncan Sands4ff179f2007-12-19 07:36:31 +00003377 // Try to merge with the previous call-site.
3378 if (PreviousIsInvoke) {
Dan Gohman3d436002008-06-21 22:00:54 +00003379 CallSiteEntry &Prev = CallSites.back();
Duncan Sands4ff179f2007-12-19 07:36:31 +00003380 if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
3381 // Extend the range of the previous entry.
3382 Prev.EndLabel = Site.EndLabel;
3383 continue;
3384 }
Duncan Sands241a0c92007-09-05 11:27:52 +00003385 }
Duncan Sands241a0c92007-09-05 11:27:52 +00003386
Duncan Sands4ff179f2007-12-19 07:36:31 +00003387 // Otherwise, create a new call-site.
3388 CallSites.push_back(Site);
3389 PreviousIsInvoke = true;
3390 } else {
3391 // Create a gap.
3392 PreviousIsInvoke = false;
3393 }
Duncan Sands241a0c92007-09-05 11:27:52 +00003394 }
3395 }
3396 // If some instruction between the previous try-range and the end of the
3397 // function may throw, create a call-site entry with no landing pad for the
3398 // region following the try-range.
Duncan Sands4ff179f2007-12-19 07:36:31 +00003399 if (SawPotentiallyThrowing) {
Duncan Sands241a0c92007-09-05 11:27:52 +00003400 CallSiteEntry Site = {LastLabel, 0, 0, 0};
3401 CallSites.push_back(Site);
3402 }
3403
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003404 // Final tallies.
Duncan Sands96144f92008-05-07 19:11:09 +00003405
3406 // Call sites.
3407 const unsigned SiteStartSize = sizeof(int32_t); // DW_EH_PE_udata4
3408 const unsigned SiteLengthSize = sizeof(int32_t); // DW_EH_PE_udata4
3409 const unsigned LandingPadSize = sizeof(int32_t); // DW_EH_PE_udata4
3410 unsigned SizeSites = CallSites.size() * (SiteStartSize +
3411 SiteLengthSize +
3412 LandingPadSize);
Duncan Sands241a0c92007-09-05 11:27:52 +00003413 for (unsigned i = 0, e = CallSites.size(); i < e; ++i)
aslc200b112008-08-16 12:57:46 +00003414 SizeSites += TargetAsmInfo::getULEB128Size(CallSites[i].Action);
Duncan Sands241a0c92007-09-05 11:27:52 +00003415
Duncan Sands96144f92008-05-07 19:11:09 +00003416 // Type infos.
3417 const unsigned TypeInfoSize = TD->getPointerSize(); // DW_EH_PE_absptr
3418 unsigned SizeTypes = TypeInfos.size() * TypeInfoSize;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003419
3420 unsigned TypeOffset = sizeof(int8_t) + // Call site format
aslc200b112008-08-16 12:57:46 +00003421 TargetAsmInfo::getULEB128Size(SizeSites) + // Call-site table length
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003422 SizeSites + SizeActions + SizeTypes;
3423
3424 unsigned TotalSize = sizeof(int8_t) + // LPStart format
3425 sizeof(int8_t) + // TType format
aslc200b112008-08-16 12:57:46 +00003426 TargetAsmInfo::getULEB128Size(TypeOffset) + // TType base offset
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003427 TypeOffset;
3428
3429 unsigned SizeAlign = (4 - TotalSize) & 3;
3430
3431 // Begin the exception table.
3432 Asm->SwitchToDataSection(TAI->getDwarfExceptionSection());
Evan Cheng7e7d1942008-02-29 19:36:59 +00003433 Asm->EmitAlignment(2, 0, 0, false);
Dale Johannesen841e4982008-10-08 21:50:21 +00003434 O << "GCC_except_table" << SubprogramCount << ":\n";
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003435 for (unsigned i = 0; i != SizeAlign; ++i) {
3436 Asm->EmitInt8(0);
3437 Asm->EOL("Padding");
3438 }
3439 EmitLabel("exception", SubprogramCount);
3440
3441 // Emit the header.
3442 Asm->EmitInt8(DW_EH_PE_omit);
3443 Asm->EOL("LPStart format (DW_EH_PE_omit)");
3444 Asm->EmitInt8(DW_EH_PE_absptr);
3445 Asm->EOL("TType format (DW_EH_PE_absptr)");
3446 Asm->EmitULEB128Bytes(TypeOffset);
3447 Asm->EOL("TType base offset");
3448 Asm->EmitInt8(DW_EH_PE_udata4);
3449 Asm->EOL("Call site format (DW_EH_PE_udata4)");
3450 Asm->EmitULEB128Bytes(SizeSites);
3451 Asm->EOL("Call-site table length");
3452
Duncan Sands241a0c92007-09-05 11:27:52 +00003453 // Emit the landing pad site information.
3454 for (unsigned i = 0; i < CallSites.size(); ++i) {
3455 CallSiteEntry &S = CallSites[i];
3456 const char *BeginTag;
3457 unsigned BeginNumber;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003458
Duncan Sands241a0c92007-09-05 11:27:52 +00003459 if (!S.BeginLabel) {
3460 BeginTag = "eh_func_begin";
3461 BeginNumber = SubprogramCount;
3462 } else {
3463 BeginTag = "label";
3464 BeginNumber = S.BeginLabel;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003465 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003466
Duncan Sands241a0c92007-09-05 11:27:52 +00003467 EmitSectionOffset(BeginTag, "eh_func_begin", BeginNumber, SubprogramCount,
Duncan Sands96144f92008-05-07 19:11:09 +00003468 true, true);
Duncan Sands241a0c92007-09-05 11:27:52 +00003469 Asm->EOL("Region start");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003470
Duncan Sands241a0c92007-09-05 11:27:52 +00003471 if (!S.EndLabel) {
Dale Johannesen4670be42008-01-15 23:24:56 +00003472 EmitDifference("eh_func_end", SubprogramCount, BeginTag, BeginNumber,
Duncan Sands96144f92008-05-07 19:11:09 +00003473 true);
Duncan Sands241a0c92007-09-05 11:27:52 +00003474 } else {
Duncan Sands96144f92008-05-07 19:11:09 +00003475 EmitDifference("label", S.EndLabel, BeginTag, BeginNumber, true);
Duncan Sands241a0c92007-09-05 11:27:52 +00003476 }
3477 Asm->EOL("Region length");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003478
Duncan Sands96144f92008-05-07 19:11:09 +00003479 if (!S.PadLabel)
3480 Asm->EmitInt32(0);
3481 else
Duncan Sands241a0c92007-09-05 11:27:52 +00003482 EmitSectionOffset("label", "eh_func_begin", S.PadLabel, SubprogramCount,
Duncan Sands96144f92008-05-07 19:11:09 +00003483 true, true);
Duncan Sands241a0c92007-09-05 11:27:52 +00003484 Asm->EOL("Landing pad");
3485
3486 Asm->EmitULEB128Bytes(S.Action);
3487 Asm->EOL("Action");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003488 }
3489
3490 // Emit the actions.
3491 for (unsigned I = 0, N = Actions.size(); I != N; ++I) {
3492 ActionEntry &Action = Actions[I];
3493
3494 Asm->EmitSLEB128Bytes(Action.ValueForTypeID);
3495 Asm->EOL("TypeInfo index");
3496 Asm->EmitSLEB128Bytes(Action.NextAction);
3497 Asm->EOL("Next action");
3498 }
3499
3500 // Emit the type ids.
3501 for (unsigned M = TypeInfos.size(); M; --M) {
3502 GlobalVariable *GV = TypeInfos[M - 1];
Anton Korobeynikov5ef86702007-09-02 22:07:21 +00003503
3504 PrintRelDirective();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003505
3506 if (GV)
3507 O << Asm->getGlobalLinkName(GV);
3508 else
3509 O << "0";
Duncan Sands241a0c92007-09-05 11:27:52 +00003510
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003511 Asm->EOL("TypeInfo");
3512 }
3513
3514 // Emit the filter typeids.
3515 for (unsigned j = 0, M = FilterIds.size(); j < M; ++j) {
3516 unsigned TypeID = FilterIds[j];
3517 Asm->EmitULEB128Bytes(TypeID);
3518 Asm->EOL("Filter TypeInfo index");
3519 }
Duncan Sands241a0c92007-09-05 11:27:52 +00003520
Evan Cheng7e7d1942008-02-29 19:36:59 +00003521 Asm->EmitAlignment(2, 0, 0, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003522 }
3523
3524public:
3525 //===--------------------------------------------------------------------===//
3526 // Main entry points.
3527 //
Owen Anderson847b99b2008-08-21 00:14:44 +00003528 DwarfException(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
Chris Lattnerb3876c72007-09-24 03:35:37 +00003529 : Dwarf(OS, A, T, "eh")
Dale Johannesen85535762008-04-02 00:25:04 +00003530 , shouldEmitTable(false)
3531 , shouldEmitMoves(false)
3532 , shouldEmitTableModule(false)
3533 , shouldEmitMovesModule(false)
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003534 {}
aslc200b112008-08-16 12:57:46 +00003535
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003536 virtual ~DwarfException() {}
3537
3538 /// SetModuleInfo - Set machine module information when it's known that pass
3539 /// manager has created it. Set by the target AsmPrinter.
3540 void SetModuleInfo(MachineModuleInfo *mmi) {
3541 MMI = mmi;
3542 }
3543
3544 /// BeginModule - Emit all exception information that should come prior to the
3545 /// content.
3546 void BeginModule(Module *M) {
3547 this->M = M;
3548 }
3549
3550 /// EndModule - Emit all exception information that should come after the
3551 /// content.
3552 void EndModule() {
Dale Johannesen85535762008-04-02 00:25:04 +00003553 if (shouldEmitMovesModule || shouldEmitTableModule) {
3554 const std::vector<Function *> Personalities = MMI->getPersonalities();
3555 for (unsigned i =0; i < Personalities.size(); ++i)
3556 EmitCommonEHFrame(Personalities[i], i);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003557
Dale Johannesen85535762008-04-02 00:25:04 +00003558 for (std::vector<FunctionEHFrameInfo>::iterator I = EHFrames.begin(),
3559 E = EHFrames.end(); I != E; ++I)
3560 EmitEHFrame(*I);
3561 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003562 }
3563
aslc200b112008-08-16 12:57:46 +00003564 /// BeginFunction - Gather pre-function exception information. Assumes being
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003565 /// emitted immediately after the function entry point.
3566 void BeginFunction(MachineFunction *MF) {
3567 this->MF = MF;
Dale Johannesen85535762008-04-02 00:25:04 +00003568 shouldEmitTable = shouldEmitMoves = false;
Dale Johannesen62f0a6d2008-04-02 17:04:45 +00003569 if (MMI && TAI->doesSupportExceptionHandling()) {
Dale Johannesen85535762008-04-02 00:25:04 +00003570
3571 // Map all labels and get rid of any dead landing pads.
3572 MMI->TidyLandingPads();
3573 // If any landing pads survive, we need an EH table.
3574 if (MMI->getLandingPads().size())
3575 shouldEmitTable = true;
3576
3577 // See if we need frame move info.
Duncan Sandscbc28b12008-07-04 09:55:48 +00003578 if (!MF->getFunction()->doesNotThrow() || UnwindTablesMandatory)
Dale Johannesen85535762008-04-02 00:25:04 +00003579 shouldEmitMoves = true;
3580
3581 if (shouldEmitMoves || shouldEmitTable)
3582 // Assumes in correct section after the entry point.
3583 EmitLabel("eh_func_begin", ++SubprogramCount);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003584 }
Dale Johannesen85535762008-04-02 00:25:04 +00003585 shouldEmitTableModule |= shouldEmitTable;
3586 shouldEmitMovesModule |= shouldEmitMoves;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003587 }
3588
3589 /// EndFunction - Gather and emit post-function exception information.
3590 ///
3591 void EndFunction() {
Dale Johannesen85535762008-04-02 00:25:04 +00003592 if (shouldEmitMoves || shouldEmitTable) {
3593 EmitLabel("eh_func_end", SubprogramCount);
3594 EmitExceptionTable();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003595
Dale Johannesen85535762008-04-02 00:25:04 +00003596 // Save EH frame information
3597 EHFrames.
3598 push_back(FunctionEHFrameInfo(getAsm()->getCurrentFunctionEHName(MF),
Bill Wendlingef9211a2007-09-18 01:47:22 +00003599 SubprogramCount,
3600 MMI->getPersonalityIndex(),
3601 MF->getFrameInfo()->hasCalls(),
3602 !MMI->getLandingPads().empty(),
Dale Johannesenfb3ac732007-11-20 23:24:42 +00003603 MMI->getFrameMoves(),
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003604 MF->getFunction()));
Dale Johannesen85535762008-04-02 00:25:04 +00003605 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003606 }
3607};
3608
3609} // End of namespace llvm
3610
3611//===----------------------------------------------------------------------===//
3612
3613/// Emit - Print the abbreviation using the specified Dwarf writer.
3614///
3615void DIEAbbrev::Emit(const DwarfDebug &DD) const {
3616 // Emit its Dwarf tag type.
3617 DD.getAsm()->EmitULEB128Bytes(Tag);
3618 DD.getAsm()->EOL(TagString(Tag));
aslc200b112008-08-16 12:57:46 +00003619
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003620 // Emit whether it has children DIEs.
3621 DD.getAsm()->EmitULEB128Bytes(ChildrenFlag);
3622 DD.getAsm()->EOL(ChildrenString(ChildrenFlag));
aslc200b112008-08-16 12:57:46 +00003623
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003624 // For each attribute description.
3625 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3626 const DIEAbbrevData &AttrData = Data[i];
aslc200b112008-08-16 12:57:46 +00003627
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003628 // Emit attribute type.
3629 DD.getAsm()->EmitULEB128Bytes(AttrData.getAttribute());
3630 DD.getAsm()->EOL(AttributeString(AttrData.getAttribute()));
aslc200b112008-08-16 12:57:46 +00003631
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003632 // Emit form type.
3633 DD.getAsm()->EmitULEB128Bytes(AttrData.getForm());
3634 DD.getAsm()->EOL(FormEncodingString(AttrData.getForm()));
3635 }
3636
3637 // Mark end of abbreviation.
3638 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(1)");
3639 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(2)");
3640}
3641
3642#ifndef NDEBUG
3643void DIEAbbrev::print(std::ostream &O) {
3644 O << "Abbreviation @"
3645 << std::hex << (intptr_t)this << std::dec
3646 << " "
3647 << TagString(Tag)
3648 << " "
3649 << ChildrenString(ChildrenFlag)
3650 << "\n";
aslc200b112008-08-16 12:57:46 +00003651
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003652 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3653 O << " "
3654 << AttributeString(Data[i].getAttribute())
3655 << " "
3656 << FormEncodingString(Data[i].getForm())
3657 << "\n";
3658 }
3659}
3660void DIEAbbrev::dump() { print(cerr); }
3661#endif
3662
3663//===----------------------------------------------------------------------===//
3664
3665#ifndef NDEBUG
3666void DIEValue::dump() {
3667 print(cerr);
3668}
3669#endif
3670
3671//===----------------------------------------------------------------------===//
3672
3673/// EmitValue - Emit integer of appropriate size.
3674///
3675void DIEInteger::EmitValue(DwarfDebug &DD, unsigned Form) {
3676 switch (Form) {
3677 case DW_FORM_flag: // Fall thru
3678 case DW_FORM_ref1: // Fall thru
3679 case DW_FORM_data1: DD.getAsm()->EmitInt8(Integer); break;
3680 case DW_FORM_ref2: // Fall thru
3681 case DW_FORM_data2: DD.getAsm()->EmitInt16(Integer); break;
3682 case DW_FORM_ref4: // Fall thru
3683 case DW_FORM_data4: DD.getAsm()->EmitInt32(Integer); break;
3684 case DW_FORM_ref8: // Fall thru
3685 case DW_FORM_data8: DD.getAsm()->EmitInt64(Integer); break;
3686 case DW_FORM_udata: DD.getAsm()->EmitULEB128Bytes(Integer); break;
3687 case DW_FORM_sdata: DD.getAsm()->EmitSLEB128Bytes(Integer); break;
3688 default: assert(0 && "DIE Value form not supported yet"); break;
3689 }
3690}
3691
3692/// SizeOf - Determine size of integer value in bytes.
3693///
3694unsigned DIEInteger::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3695 switch (Form) {
3696 case DW_FORM_flag: // Fall thru
3697 case DW_FORM_ref1: // Fall thru
3698 case DW_FORM_data1: return sizeof(int8_t);
3699 case DW_FORM_ref2: // Fall thru
3700 case DW_FORM_data2: return sizeof(int16_t);
3701 case DW_FORM_ref4: // Fall thru
3702 case DW_FORM_data4: return sizeof(int32_t);
3703 case DW_FORM_ref8: // Fall thru
3704 case DW_FORM_data8: return sizeof(int64_t);
aslc200b112008-08-16 12:57:46 +00003705 case DW_FORM_udata: return TargetAsmInfo::getULEB128Size(Integer);
3706 case DW_FORM_sdata: return TargetAsmInfo::getSLEB128Size(Integer);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003707 default: assert(0 && "DIE Value form not supported yet"); break;
3708 }
3709 return 0;
3710}
3711
3712//===----------------------------------------------------------------------===//
3713
3714/// EmitValue - Emit string value.
3715///
3716void DIEString::EmitValue(DwarfDebug &DD, unsigned Form) {
3717 DD.getAsm()->EmitString(String);
3718}
3719
3720//===----------------------------------------------------------------------===//
3721
3722/// EmitValue - Emit label value.
3723///
3724void DIEDwarfLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
Dan Gohman597b4842007-09-28 16:50:28 +00003725 bool IsSmall = Form == DW_FORM_data4;
3726 DD.EmitReference(Label, false, IsSmall);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003727}
3728
3729/// SizeOf - Determine size of label value in bytes.
3730///
3731unsigned DIEDwarfLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Dan Gohman597b4842007-09-28 16:50:28 +00003732 if (Form == DW_FORM_data4) return 4;
Dan Gohmancfb72b22007-09-27 23:12:31 +00003733 return DD.getTargetData()->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003734}
3735
3736//===----------------------------------------------------------------------===//
3737
3738/// EmitValue - Emit label value.
3739///
3740void DIEObjectLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
Dan Gohman597b4842007-09-28 16:50:28 +00003741 bool IsSmall = Form == DW_FORM_data4;
3742 DD.EmitReference(Label, false, IsSmall);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003743}
3744
3745/// SizeOf - Determine size of label value in bytes.
3746///
3747unsigned DIEObjectLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Dan Gohman597b4842007-09-28 16:50:28 +00003748 if (Form == DW_FORM_data4) return 4;
Dan Gohmancfb72b22007-09-27 23:12:31 +00003749 return DD.getTargetData()->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003750}
aslc200b112008-08-16 12:57:46 +00003751
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003752//===----------------------------------------------------------------------===//
3753
3754/// EmitValue - Emit delta value.
3755///
Argiris Kirtzidis03449652008-06-18 19:27:37 +00003756void DIESectionOffset::EmitValue(DwarfDebug &DD, unsigned Form) {
3757 bool IsSmall = Form == DW_FORM_data4;
3758 DD.EmitSectionOffset(Label.Tag, Section.Tag,
3759 Label.Number, Section.Number, IsSmall, IsEH, UseSet);
3760}
3761
3762/// SizeOf - Determine size of delta value in bytes.
3763///
3764unsigned DIESectionOffset::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3765 if (Form == DW_FORM_data4) return 4;
3766 return DD.getTargetData()->getPointerSize();
3767}
aslc200b112008-08-16 12:57:46 +00003768
Argiris Kirtzidis03449652008-06-18 19:27:37 +00003769//===----------------------------------------------------------------------===//
3770
3771/// EmitValue - Emit delta value.
3772///
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003773void DIEDelta::EmitValue(DwarfDebug &DD, unsigned Form) {
3774 bool IsSmall = Form == DW_FORM_data4;
3775 DD.EmitDifference(LabelHi, LabelLo, IsSmall);
3776}
3777
3778/// SizeOf - Determine size of delta value in bytes.
3779///
3780unsigned DIEDelta::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3781 if (Form == DW_FORM_data4) return 4;
Dan Gohmancfb72b22007-09-27 23:12:31 +00003782 return DD.getTargetData()->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003783}
3784
3785//===----------------------------------------------------------------------===//
3786
3787/// EmitValue - Emit debug information entry offset.
3788///
3789void DIEntry::EmitValue(DwarfDebug &DD, unsigned Form) {
3790 DD.getAsm()->EmitInt32(Entry->getOffset());
3791}
aslc200b112008-08-16 12:57:46 +00003792
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003793//===----------------------------------------------------------------------===//
3794
3795/// ComputeSize - calculate the size of the block.
3796///
3797unsigned DIEBlock::ComputeSize(DwarfDebug &DD) {
3798 if (!Size) {
Owen Anderson88dd6232008-06-24 21:44:59 +00003799 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
aslc200b112008-08-16 12:57:46 +00003800
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003801 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3802 Size += Values[i]->SizeOf(DD, AbbrevData[i].getForm());
3803 }
3804 }
3805 return Size;
3806}
3807
3808/// EmitValue - Emit block data.
3809///
3810void DIEBlock::EmitValue(DwarfDebug &DD, unsigned Form) {
3811 switch (Form) {
3812 case DW_FORM_block1: DD.getAsm()->EmitInt8(Size); break;
3813 case DW_FORM_block2: DD.getAsm()->EmitInt16(Size); break;
3814 case DW_FORM_block4: DD.getAsm()->EmitInt32(Size); break;
3815 case DW_FORM_block: DD.getAsm()->EmitULEB128Bytes(Size); break;
3816 default: assert(0 && "Improper form for block"); break;
3817 }
aslc200b112008-08-16 12:57:46 +00003818
Owen Anderson88dd6232008-06-24 21:44:59 +00003819 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003820
3821 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
3822 DD.getAsm()->EOL();
3823 Values[i]->EmitValue(DD, AbbrevData[i].getForm());
3824 }
3825}
3826
3827/// SizeOf - Determine size of block data in bytes.
3828///
3829unsigned DIEBlock::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3830 switch (Form) {
3831 case DW_FORM_block1: return Size + sizeof(int8_t);
3832 case DW_FORM_block2: return Size + sizeof(int16_t);
3833 case DW_FORM_block4: return Size + sizeof(int32_t);
aslc200b112008-08-16 12:57:46 +00003834 case DW_FORM_block: return Size + TargetAsmInfo::getULEB128Size(Size);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003835 default: assert(0 && "Improper form for block"); break;
3836 }
3837 return 0;
3838}
3839
3840//===----------------------------------------------------------------------===//
3841/// DIE Implementation
3842
3843DIE::~DIE() {
3844 for (unsigned i = 0, N = Children.size(); i < N; ++i)
3845 delete Children[i];
3846}
aslc200b112008-08-16 12:57:46 +00003847
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003848/// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
3849///
3850void DIE::AddSiblingOffset() {
3851 DIEInteger *DI = new DIEInteger(0);
3852 Values.insert(Values.begin(), DI);
3853 Abbrev.AddFirstAttribute(DW_AT_sibling, DW_FORM_ref4);
3854}
3855
3856/// Profile - Used to gather unique data for the value folding set.
3857///
3858void DIE::Profile(FoldingSetNodeID &ID) {
3859 Abbrev.Profile(ID);
aslc200b112008-08-16 12:57:46 +00003860
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003861 for (unsigned i = 0, N = Children.size(); i < N; ++i)
3862 ID.AddPointer(Children[i]);
3863
3864 for (unsigned j = 0, M = Values.size(); j < M; ++j)
3865 ID.AddPointer(Values[j]);
3866}
3867
3868#ifndef NDEBUG
3869void DIE::print(std::ostream &O, unsigned IncIndent) {
3870 static unsigned IndentCount = 0;
3871 IndentCount += IncIndent;
3872 const std::string Indent(IndentCount, ' ');
3873 bool isBlock = Abbrev.getTag() == 0;
aslc200b112008-08-16 12:57:46 +00003874
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003875 if (!isBlock) {
3876 O << Indent
3877 << "Die: "
3878 << "0x" << std::hex << (intptr_t)this << std::dec
3879 << ", Offset: " << Offset
3880 << ", Size: " << Size
aslc200b112008-08-16 12:57:46 +00003881 << "\n";
3882
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003883 O << Indent
3884 << TagString(Abbrev.getTag())
3885 << " "
3886 << ChildrenString(Abbrev.getChildrenFlag());
3887 } else {
3888 O << "Size: " << Size;
3889 }
3890 O << "\n";
3891
Owen Anderson88dd6232008-06-24 21:44:59 +00003892 const SmallVector<DIEAbbrevData, 8> &Data = Abbrev.getData();
aslc200b112008-08-16 12:57:46 +00003893
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003894 IndentCount += 2;
3895 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3896 O << Indent;
Bill Wendlingdc7b5a52008-07-22 00:28:47 +00003897
3898 if (!isBlock)
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003899 O << AttributeString(Data[i].getAttribute());
Bill Wendlingdc7b5a52008-07-22 00:28:47 +00003900 else
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003901 O << "Blk[" << i << "]";
Bill Wendlingdc7b5a52008-07-22 00:28:47 +00003902
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003903 O << " "
3904 << FormEncodingString(Data[i].getForm())
3905 << " ";
3906 Values[i]->print(O);
3907 O << "\n";
3908 }
3909 IndentCount -= 2;
3910
3911 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
3912 Children[j]->print(O, 4);
3913 }
aslc200b112008-08-16 12:57:46 +00003914
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003915 if (!isBlock) O << "\n";
3916 IndentCount -= IncIndent;
3917}
3918
3919void DIE::dump() {
3920 print(cerr);
3921}
3922#endif
3923
3924//===----------------------------------------------------------------------===//
3925/// DwarfWriter Implementation
3926///
3927
Owen Anderson847b99b2008-08-21 00:14:44 +00003928DwarfWriter::DwarfWriter(raw_ostream &OS, AsmPrinter *A,
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003929 const TargetAsmInfo *T) {
3930 DE = new DwarfException(OS, A, T);
3931 DD = new DwarfDebug(OS, A, T);
3932}
3933
3934DwarfWriter::~DwarfWriter() {
3935 delete DE;
3936 delete DD;
3937}
3938
3939/// SetModuleInfo - Set machine module info when it's known that pass manager
3940/// has created it. Set by the target AsmPrinter.
3941void DwarfWriter::SetModuleInfo(MachineModuleInfo *MMI) {
3942 DD->SetModuleInfo(MMI);
3943 DE->SetModuleInfo(MMI);
3944}
3945
3946/// BeginModule - Emit all Dwarf sections that should come prior to the
3947/// content.
3948void DwarfWriter::BeginModule(Module *M) {
3949 DE->BeginModule(M);
3950 DD->BeginModule(M);
3951}
3952
3953/// EndModule - Emit all Dwarf sections that should come after the content.
3954///
3955void DwarfWriter::EndModule() {
3956 DE->EndModule();
3957 DD->EndModule();
3958}
3959
aslc200b112008-08-16 12:57:46 +00003960/// BeginFunction - Gather pre-function debug information. Assumes being
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003961/// emitted immediately after the function entry point.
3962void DwarfWriter::BeginFunction(MachineFunction *MF) {
3963 DE->BeginFunction(MF);
3964 DD->BeginFunction(MF);
3965}
3966
3967/// EndFunction - Gather and emit post-function debug information.
3968///
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00003969void DwarfWriter::EndFunction(MachineFunction *MF) {
3970 DD->EndFunction(MF);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003971 DE->EndFunction();
aslc200b112008-08-16 12:57:46 +00003972
Bill Wendling5b4796a2008-07-22 00:53:37 +00003973 if (MachineModuleInfo *MMI = DD->getMMI() ? DD->getMMI() : DE->getMMI())
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003974 // Clear function debug information.
3975 MMI->EndFunction();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003976}