blob: acbec3c66cda8120ba92f38a503f85d6d3eb00f0 [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"
Devang Patelb3907da2009-01-05 23:03:32 +000021#include "llvm/DerivedTypes.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000022#include "llvm/CodeGen/AsmPrinter.h"
23#include "llvm/CodeGen/MachineModuleInfo.h"
24#include "llvm/CodeGen/MachineFrameInfo.h"
25#include "llvm/CodeGen/MachineLocation.h"
Devang Patelfc187162009-01-05 17:57:47 +000026#include "llvm/Analysis/DebugInfo.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000027#include "llvm/Support/Debug.h"
28#include "llvm/Support/Dwarf.h"
29#include "llvm/Support/CommandLine.h"
30#include "llvm/Support/DataTypes.h"
31#include "llvm/Support/Mangler.h"
Owen Anderson847b99b2008-08-21 00:14:44 +000032#include "llvm/Support/raw_ostream.h"
Dan Gohman80bbde72007-09-24 21:32:18 +000033#include "llvm/System/Path.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000034#include "llvm/Target/TargetAsmInfo.h"
Dan Gohman1e57df32008-02-10 18:45:23 +000035#include "llvm/Target/TargetRegisterInfo.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000036#include "llvm/Target/TargetData.h"
37#include "llvm/Target/TargetFrameInfo.h"
38#include "llvm/Target/TargetInstrInfo.h"
39#include "llvm/Target/TargetMachine.h"
40#include "llvm/Target/TargetOptions.h"
41#include <ostream>
42#include <string>
43using namespace llvm;
44using namespace llvm::dwarf;
45
Devang Patelaa1e8432009-01-08 23:40:34 +000046static RegisterPass<DwarfWriter>
47X("dwarfwriter", "DWARF Information Writer");
48char DwarfWriter::ID = 0;
49
Dan Gohmanf17a25c2007-07-18 16:29:46 +000050namespace llvm {
aslc200b112008-08-16 12:57:46 +000051
Dan Gohmanf17a25c2007-07-18 16:29:46 +000052//===----------------------------------------------------------------------===//
53
54/// Configuration values for initial hash set sizes (log2).
55///
56static const unsigned InitDiesSetSize = 9; // 512
57static const unsigned InitAbbreviationsSetSize = 9; // 512
58static const unsigned InitValuesSetSize = 9; // 512
59
60//===----------------------------------------------------------------------===//
61/// Forward declarations.
62///
63class DIE;
64class DIEValue;
65
66//===----------------------------------------------------------------------===//
Devang Patelb3907da2009-01-05 23:03:32 +000067/// Utility routines.
68///
69/// getGlobalVariablesUsing - Return all of the GlobalVariables which have the
70/// specified value in their initializer somewhere.
71static void
72getGlobalVariablesUsing(Value *V, std::vector<GlobalVariable*> &Result) {
73 // Scan though value users.
74 for (Value::use_iterator I = V->use_begin(), E = V->use_end(); I != E; ++I) {
75 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(*I)) {
76 // If the user is a GlobalVariable then add to result.
77 Result.push_back(GV);
78 } else if (Constant *C = dyn_cast<Constant>(*I)) {
79 // If the user is a constant variable then scan its users
80 getGlobalVariablesUsing(C, Result);
81 }
82 }
83}
84
85/// getGlobalVariablesUsing - Return all of the GlobalVariables that use the
86/// named GlobalVariable.
87static void
88getGlobalVariablesUsing(Module &M, const std::string &RootName,
89 std::vector<GlobalVariable*> &Result) {
90 std::vector<const Type*> FieldTypes;
91 FieldTypes.push_back(Type::Int32Ty);
92 FieldTypes.push_back(Type::Int32Ty);
93
94 // Get the GlobalVariable root.
95 GlobalVariable *UseRoot = M.getGlobalVariable(RootName,
96 StructType::get(FieldTypes));
97
98 // If present and linkonce then scan for users.
99 if (UseRoot && UseRoot->hasLinkOnceLinkage())
100 getGlobalVariablesUsing(UseRoot, Result);
101}
102
103//===----------------------------------------------------------------------===//
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000104/// DWLabel - Labels are used to track locations in the assembler file.
aslc200b112008-08-16 12:57:46 +0000105/// Labels appear in the form @verbatim <prefix><Tag><Number> @endverbatim,
106/// where the tag is a category of label (Ex. location) and number is a value
Reid Spencer37c7cea2007-08-05 20:06:04 +0000107/// unique in that category.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000108class DWLabel {
109public:
110 /// Tag - Label category tag. Should always be a staticly declared C string.
111 ///
112 const char *Tag;
aslc200b112008-08-16 12:57:46 +0000113
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000114 /// Number - Value to make label unique.
115 ///
116 unsigned Number;
117
118 DWLabel(const char *T, unsigned N) : Tag(T), Number(N) {}
aslc200b112008-08-16 12:57:46 +0000119
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000120 void Profile(FoldingSetNodeID &ID) const {
121 ID.AddString(std::string(Tag));
122 ID.AddInteger(Number);
123 }
aslc200b112008-08-16 12:57:46 +0000124
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000125#ifndef NDEBUG
126 void print(std::ostream *O) const {
127 if (O) print(*O);
128 }
129 void print(std::ostream &O) const {
130 O << "." << Tag;
131 if (Number) O << Number;
132 }
133#endif
134};
135
136//===----------------------------------------------------------------------===//
137/// DIEAbbrevData - Dwarf abbreviation data, describes the one attribute of a
138/// Dwarf abbreviation.
139class DIEAbbrevData {
140private:
141 /// Attribute - Dwarf attribute code.
142 ///
143 unsigned Attribute;
aslc200b112008-08-16 12:57:46 +0000144
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000145 /// Form - Dwarf form code.
aslc200b112008-08-16 12:57:46 +0000146 ///
147 unsigned Form;
148
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000149public:
150 DIEAbbrevData(unsigned A, unsigned F)
151 : Attribute(A)
152 , Form(F)
153 {}
aslc200b112008-08-16 12:57:46 +0000154
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000155 // Accessors.
156 unsigned getAttribute() const { return Attribute; }
157 unsigned getForm() const { return Form; }
158
159 /// Profile - Used to gather unique data for the abbreviation folding set.
160 ///
161 void Profile(FoldingSetNodeID &ID)const {
162 ID.AddInteger(Attribute);
163 ID.AddInteger(Form);
164 }
165};
166
167//===----------------------------------------------------------------------===//
168/// DIEAbbrev - Dwarf abbreviation, describes the organization of a debug
169/// information object.
170class DIEAbbrev : public FoldingSetNode {
171private:
172 /// Tag - Dwarf tag code.
173 ///
174 unsigned Tag;
aslc200b112008-08-16 12:57:46 +0000175
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000176 /// Unique number for node.
177 ///
178 unsigned Number;
179
180 /// ChildrenFlag - Dwarf children flag.
181 ///
182 unsigned ChildrenFlag;
183
184 /// Data - Raw data bytes for abbreviation.
185 ///
Owen Anderson88dd6232008-06-24 21:44:59 +0000186 SmallVector<DIEAbbrevData, 8> Data;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000187
188public:
189
190 DIEAbbrev(unsigned T, unsigned C)
191 : Tag(T)
192 , ChildrenFlag(C)
193 , Data()
194 {}
195 ~DIEAbbrev() {}
aslc200b112008-08-16 12:57:46 +0000196
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000197 // Accessors.
198 unsigned getTag() const { return Tag; }
199 unsigned getNumber() const { return Number; }
200 unsigned getChildrenFlag() const { return ChildrenFlag; }
Owen Anderson88dd6232008-06-24 21:44:59 +0000201 const SmallVector<DIEAbbrevData, 8> &getData() const { return Data; }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000202 void setTag(unsigned T) { Tag = T; }
203 void setChildrenFlag(unsigned CF) { ChildrenFlag = CF; }
204 void setNumber(unsigned N) { Number = N; }
aslc200b112008-08-16 12:57:46 +0000205
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000206 /// AddAttribute - Adds another set of attribute information to the
207 /// abbreviation.
208 void AddAttribute(unsigned Attribute, unsigned Form) {
209 Data.push_back(DIEAbbrevData(Attribute, Form));
210 }
aslc200b112008-08-16 12:57:46 +0000211
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000212 /// AddFirstAttribute - Adds a set of attribute information to the front
213 /// of the abbreviation.
214 void AddFirstAttribute(unsigned Attribute, unsigned Form) {
215 Data.insert(Data.begin(), DIEAbbrevData(Attribute, Form));
216 }
aslc200b112008-08-16 12:57:46 +0000217
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000218 /// Profile - Used to gather unique data for the abbreviation folding set.
219 ///
220 void Profile(FoldingSetNodeID &ID) {
221 ID.AddInteger(Tag);
222 ID.AddInteger(ChildrenFlag);
aslc200b112008-08-16 12:57:46 +0000223
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000224 // For each attribute description.
225 for (unsigned i = 0, N = Data.size(); i < N; ++i)
226 Data[i].Profile(ID);
227 }
aslc200b112008-08-16 12:57:46 +0000228
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000229 /// Emit - Print the abbreviation using the specified Dwarf writer.
230 ///
aslc200b112008-08-16 12:57:46 +0000231 void Emit(const DwarfDebug &DD) const;
232
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000233#ifndef NDEBUG
234 void print(std::ostream *O) {
235 if (O) print(*O);
236 }
237 void print(std::ostream &O);
238 void dump();
239#endif
240};
241
242//===----------------------------------------------------------------------===//
243/// DIE - A structured debug information entry. Has an abbreviation which
244/// describes it's organization.
245class DIE : public FoldingSetNode {
246protected:
247 /// Abbrev - Buffer for constructing abbreviation.
248 ///
249 DIEAbbrev Abbrev;
aslc200b112008-08-16 12:57:46 +0000250
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000251 /// Offset - Offset in debug info section.
252 ///
253 unsigned Offset;
aslc200b112008-08-16 12:57:46 +0000254
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000255 /// Size - Size of instance + children.
256 ///
257 unsigned Size;
aslc200b112008-08-16 12:57:46 +0000258
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000259 /// Children DIEs.
260 ///
261 std::vector<DIE *> Children;
aslc200b112008-08-16 12:57:46 +0000262
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000263 /// Attributes values.
264 ///
Owen Anderson88dd6232008-06-24 21:44:59 +0000265 SmallVector<DIEValue*, 32> Values;
aslc200b112008-08-16 12:57:46 +0000266
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000267public:
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000268 explicit DIE(unsigned Tag)
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000269 : Abbrev(Tag, DW_CHILDREN_no)
270 , Offset(0)
271 , Size(0)
272 , Children()
273 , Values()
274 {}
275 virtual ~DIE();
aslc200b112008-08-16 12:57:46 +0000276
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000277 // Accessors.
278 DIEAbbrev &getAbbrev() { return Abbrev; }
279 unsigned getAbbrevNumber() const {
280 return Abbrev.getNumber();
281 }
282 unsigned getTag() const { return Abbrev.getTag(); }
283 unsigned getOffset() const { return Offset; }
284 unsigned getSize() const { return Size; }
285 const std::vector<DIE *> &getChildren() const { return Children; }
Owen Anderson88dd6232008-06-24 21:44:59 +0000286 SmallVector<DIEValue*, 32> &getValues() { return Values; }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000287 void setTag(unsigned Tag) { Abbrev.setTag(Tag); }
288 void setOffset(unsigned O) { Offset = O; }
289 void setSize(unsigned S) { Size = S; }
aslc200b112008-08-16 12:57:46 +0000290
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000291 /// AddValue - Add a value and attributes to a DIE.
292 ///
293 void AddValue(unsigned Attribute, unsigned Form, DIEValue *Value) {
294 Abbrev.AddAttribute(Attribute, Form);
295 Values.push_back(Value);
296 }
aslc200b112008-08-16 12:57:46 +0000297
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000298 /// SiblingOffset - Return the offset of the debug information entry's
299 /// sibling.
300 unsigned SiblingOffset() const { return Offset + Size; }
aslc200b112008-08-16 12:57:46 +0000301
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000302 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
303 ///
304 void AddSiblingOffset();
305
306 /// AddChild - Add a child to the DIE.
307 ///
308 void AddChild(DIE *Child) {
309 Abbrev.setChildrenFlag(DW_CHILDREN_yes);
310 Children.push_back(Child);
311 }
aslc200b112008-08-16 12:57:46 +0000312
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000313 /// Detach - Detaches objects connected to it after copying.
314 ///
315 void Detach() {
316 Children.clear();
317 }
aslc200b112008-08-16 12:57:46 +0000318
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000319 /// Profile - Used to gather unique data for the value folding set.
320 ///
321 void Profile(FoldingSetNodeID &ID) ;
aslc200b112008-08-16 12:57:46 +0000322
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000323#ifndef NDEBUG
324 void print(std::ostream *O, unsigned IncIndent = 0) {
325 if (O) print(*O, IncIndent);
326 }
327 void print(std::ostream &O, unsigned IncIndent = 0);
328 void dump();
329#endif
330};
331
332//===----------------------------------------------------------------------===//
333/// DIEValue - A debug information entry value.
334///
335class DIEValue : public FoldingSetNode {
336public:
337 enum {
338 isInteger,
339 isString,
340 isLabel,
341 isAsIsLabel,
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000342 isSectionOffset,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000343 isDelta,
344 isEntry,
345 isBlock
346 };
aslc200b112008-08-16 12:57:46 +0000347
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000348 /// Type - Type of data stored in the value.
349 ///
350 unsigned Type;
aslc200b112008-08-16 12:57:46 +0000351
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000352 explicit DIEValue(unsigned T)
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000353 : Type(T)
354 {}
355 virtual ~DIEValue() {}
aslc200b112008-08-16 12:57:46 +0000356
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000357 // Accessors
358 unsigned getType() const { return Type; }
aslc200b112008-08-16 12:57:46 +0000359
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000360 // Implement isa/cast/dyncast.
361 static bool classof(const DIEValue *) { return true; }
aslc200b112008-08-16 12:57:46 +0000362
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000363 /// EmitValue - Emit value via the Dwarf writer.
364 ///
365 virtual void EmitValue(DwarfDebug &DD, unsigned Form) = 0;
aslc200b112008-08-16 12:57:46 +0000366
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000367 /// SizeOf - Return the size of a value in bytes.
368 ///
369 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const = 0;
aslc200b112008-08-16 12:57:46 +0000370
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000371 /// Profile - Used to gather unique data for the value folding set.
372 ///
373 virtual void Profile(FoldingSetNodeID &ID) = 0;
aslc200b112008-08-16 12:57:46 +0000374
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000375#ifndef NDEBUG
376 void print(std::ostream *O) {
377 if (O) print(*O);
378 }
379 virtual void print(std::ostream &O) = 0;
380 void dump();
381#endif
382};
383
384//===----------------------------------------------------------------------===//
385/// DWInteger - An integer value DIE.
aslc200b112008-08-16 12:57:46 +0000386///
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000387class DIEInteger : public DIEValue {
388private:
389 uint64_t Integer;
aslc200b112008-08-16 12:57:46 +0000390
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000391public:
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000392 explicit DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000393
394 // Implement isa/cast/dyncast.
395 static bool classof(const DIEInteger *) { return true; }
396 static bool classof(const DIEValue *I) { return I->Type == isInteger; }
aslc200b112008-08-16 12:57:46 +0000397
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000398 /// BestForm - Choose the best form for integer.
399 ///
400 static unsigned BestForm(bool IsSigned, uint64_t Integer) {
401 if (IsSigned) {
402 if ((char)Integer == (signed)Integer) return DW_FORM_data1;
403 if ((short)Integer == (signed)Integer) return DW_FORM_data2;
404 if ((int)Integer == (signed)Integer) return DW_FORM_data4;
405 } else {
406 if ((unsigned char)Integer == Integer) return DW_FORM_data1;
407 if ((unsigned short)Integer == Integer) return DW_FORM_data2;
408 if ((unsigned int)Integer == Integer) return DW_FORM_data4;
409 }
410 return DW_FORM_data8;
411 }
aslc200b112008-08-16 12:57:46 +0000412
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000413 /// EmitValue - Emit integer of appropriate size.
414 ///
415 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000416
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000417 /// SizeOf - Determine size of integer value in bytes.
418 ///
419 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000420
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000421 /// Profile - Used to gather unique data for the value folding set.
422 ///
423 static void Profile(FoldingSetNodeID &ID, unsigned Integer) {
424 ID.AddInteger(isInteger);
425 ID.AddInteger(Integer);
426 }
427 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Integer); }
aslc200b112008-08-16 12:57:46 +0000428
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000429#ifndef NDEBUG
430 virtual void print(std::ostream &O) {
431 O << "Int: " << (int64_t)Integer
432 << " 0x" << std::hex << Integer << std::dec;
433 }
434#endif
435};
436
437//===----------------------------------------------------------------------===//
438/// DIEString - A string value DIE.
aslc200b112008-08-16 12:57:46 +0000439///
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000440class DIEString : public DIEValue {
441public:
442 const std::string String;
aslc200b112008-08-16 12:57:46 +0000443
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000444 explicit DIEString(const std::string &S) : DIEValue(isString), String(S) {}
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000445
446 // Implement isa/cast/dyncast.
447 static bool classof(const DIEString *) { return true; }
448 static bool classof(const DIEValue *S) { return S->Type == isString; }
aslc200b112008-08-16 12:57:46 +0000449
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000450 /// EmitValue - Emit string value.
451 ///
452 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000453
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000454 /// SizeOf - Determine size of string value in bytes.
455 ///
456 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
457 return String.size() + sizeof(char); // sizeof('\0');
458 }
aslc200b112008-08-16 12:57:46 +0000459
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000460 /// Profile - Used to gather unique data for the value folding set.
461 ///
462 static void Profile(FoldingSetNodeID &ID, const std::string &String) {
463 ID.AddInteger(isString);
464 ID.AddString(String);
465 }
466 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, String); }
aslc200b112008-08-16 12:57:46 +0000467
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000468#ifndef NDEBUG
469 virtual void print(std::ostream &O) {
470 O << "Str: \"" << String << "\"";
471 }
472#endif
473};
474
475//===----------------------------------------------------------------------===//
476/// DIEDwarfLabel - A Dwarf internal label expression DIE.
477//
478class DIEDwarfLabel : public DIEValue {
479public:
480
481 const DWLabel Label;
aslc200b112008-08-16 12:57:46 +0000482
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000483 explicit DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {}
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000484
485 // Implement isa/cast/dyncast.
486 static bool classof(const DIEDwarfLabel *) { return true; }
487 static bool classof(const DIEValue *L) { return L->Type == isLabel; }
aslc200b112008-08-16 12:57:46 +0000488
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000489 /// EmitValue - Emit label value.
490 ///
491 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000492
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000493 /// SizeOf - Determine size of label value in bytes.
494 ///
495 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000496
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000497 /// Profile - Used to gather unique data for the value folding set.
498 ///
499 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label) {
500 ID.AddInteger(isLabel);
501 Label.Profile(ID);
502 }
503 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
aslc200b112008-08-16 12:57:46 +0000504
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000505#ifndef NDEBUG
506 virtual void print(std::ostream &O) {
507 O << "Lbl: ";
508 Label.print(O);
509 }
510#endif
511};
512
513
514//===----------------------------------------------------------------------===//
515/// DIEObjectLabel - A label to an object in code or data.
516//
517class DIEObjectLabel : public DIEValue {
518public:
519 const std::string Label;
aslc200b112008-08-16 12:57:46 +0000520
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000521 explicit DIEObjectLabel(const std::string &L)
522 : DIEValue(isAsIsLabel), Label(L) {}
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000523
524 // Implement isa/cast/dyncast.
525 static bool classof(const DIEObjectLabel *) { return true; }
526 static bool classof(const DIEValue *L) { return L->Type == isAsIsLabel; }
aslc200b112008-08-16 12:57:46 +0000527
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000528 /// EmitValue - Emit label value.
529 ///
530 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000531
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000532 /// SizeOf - Determine size of label value in bytes.
533 ///
534 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000535
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000536 /// Profile - Used to gather unique data for the value folding set.
537 ///
538 static void Profile(FoldingSetNodeID &ID, const std::string &Label) {
539 ID.AddInteger(isAsIsLabel);
540 ID.AddString(Label);
541 }
542 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
543
544#ifndef NDEBUG
545 virtual void print(std::ostream &O) {
546 O << "Obj: " << Label;
547 }
548#endif
549};
550
551//===----------------------------------------------------------------------===//
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000552/// DIESectionOffset - A section offset DIE.
553//
554class DIESectionOffset : public DIEValue {
555public:
556 const DWLabel Label;
557 const DWLabel Section;
558 bool IsEH : 1;
559 bool UseSet : 1;
aslc200b112008-08-16 12:57:46 +0000560
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000561 DIESectionOffset(const DWLabel &Lab, const DWLabel &Sec,
562 bool isEH = false, bool useSet = true)
563 : DIEValue(isSectionOffset), Label(Lab), Section(Sec),
564 IsEH(isEH), UseSet(useSet) {}
565
566 // Implement isa/cast/dyncast.
567 static bool classof(const DIESectionOffset *) { return true; }
568 static bool classof(const DIEValue *D) { return D->Type == isSectionOffset; }
aslc200b112008-08-16 12:57:46 +0000569
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000570 /// EmitValue - Emit section offset.
571 ///
572 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000573
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000574 /// SizeOf - Determine size of section offset value in bytes.
575 ///
576 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000577
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000578 /// Profile - Used to gather unique data for the value folding set.
579 ///
580 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label,
581 const DWLabel &Section) {
582 ID.AddInteger(isSectionOffset);
583 Label.Profile(ID);
584 Section.Profile(ID);
585 // IsEH and UseSet are specific to the Label/Section that we will emit
586 // the offset for; so Label/Section are enough for uniqueness.
587 }
588 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label, Section); }
589
590#ifndef NDEBUG
591 virtual void print(std::ostream &O) {
592 O << "Off: ";
593 Label.print(O);
594 O << "-";
595 Section.print(O);
596 O << "-" << IsEH << "-" << UseSet;
597 }
598#endif
599};
600
601//===----------------------------------------------------------------------===//
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000602/// DIEDelta - A simple label difference DIE.
aslc200b112008-08-16 12:57:46 +0000603///
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000604class DIEDelta : public DIEValue {
605public:
606 const DWLabel LabelHi;
607 const DWLabel LabelLo;
aslc200b112008-08-16 12:57:46 +0000608
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000609 DIEDelta(const DWLabel &Hi, const DWLabel &Lo)
610 : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
611
612 // Implement isa/cast/dyncast.
613 static bool classof(const DIEDelta *) { return true; }
614 static bool classof(const DIEValue *D) { return D->Type == isDelta; }
aslc200b112008-08-16 12:57:46 +0000615
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000616 /// EmitValue - Emit delta value.
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 delta value in bytes.
621 ///
622 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000623
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000624 /// Profile - Used to gather unique data for the value folding set.
625 ///
626 static void Profile(FoldingSetNodeID &ID, const DWLabel &LabelHi,
627 const DWLabel &LabelLo) {
628 ID.AddInteger(isDelta);
629 LabelHi.Profile(ID);
630 LabelLo.Profile(ID);
631 }
632 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, LabelHi, LabelLo); }
633
634#ifndef NDEBUG
635 virtual void print(std::ostream &O) {
636 O << "Del: ";
637 LabelHi.print(O);
638 O << "-";
639 LabelLo.print(O);
640 }
641#endif
642};
643
644//===----------------------------------------------------------------------===//
645/// DIEntry - A pointer to another debug information entry. An instance of this
646/// class can also be used as a proxy for a debug information entry not yet
647/// defined (ie. types.)
648class DIEntry : public DIEValue {
649public:
650 DIE *Entry;
aslc200b112008-08-16 12:57:46 +0000651
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000652 explicit DIEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
aslc200b112008-08-16 12:57:46 +0000653
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000654 // Implement isa/cast/dyncast.
655 static bool classof(const DIEntry *) { return true; }
656 static bool classof(const DIEValue *E) { return E->Type == isEntry; }
aslc200b112008-08-16 12:57:46 +0000657
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000658 /// EmitValue - Emit debug information entry offset.
659 ///
660 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000661
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000662 /// SizeOf - Determine size of debug information entry in bytes.
663 ///
664 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
665 return sizeof(int32_t);
666 }
aslc200b112008-08-16 12:57:46 +0000667
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000668 /// Profile - Used to gather unique data for the value folding set.
669 ///
670 static void Profile(FoldingSetNodeID &ID, DIE *Entry) {
671 ID.AddInteger(isEntry);
672 ID.AddPointer(Entry);
673 }
674 virtual void Profile(FoldingSetNodeID &ID) {
675 ID.AddInteger(isEntry);
aslc200b112008-08-16 12:57:46 +0000676
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000677 if (Entry) {
678 ID.AddPointer(Entry);
679 } else {
680 ID.AddPointer(this);
681 }
682 }
aslc200b112008-08-16 12:57:46 +0000683
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000684#ifndef NDEBUG
685 virtual void print(std::ostream &O) {
686 O << "Die: 0x" << std::hex << (intptr_t)Entry << std::dec;
687 }
688#endif
689};
690
691//===----------------------------------------------------------------------===//
692/// DIEBlock - A block of values. Primarily used for location expressions.
693//
694class DIEBlock : public DIEValue, public DIE {
695public:
696 unsigned Size; // Size in bytes excluding size header.
aslc200b112008-08-16 12:57:46 +0000697
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000698 DIEBlock()
699 : DIEValue(isBlock)
700 , DIE(0)
701 , Size(0)
702 {}
703 ~DIEBlock() {
704 }
aslc200b112008-08-16 12:57:46 +0000705
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000706 // Implement isa/cast/dyncast.
707 static bool classof(const DIEBlock *) { return true; }
708 static bool classof(const DIEValue *E) { return E->Type == isBlock; }
aslc200b112008-08-16 12:57:46 +0000709
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000710 /// ComputeSize - calculate the size of the block.
711 ///
712 unsigned ComputeSize(DwarfDebug &DD);
aslc200b112008-08-16 12:57:46 +0000713
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000714 /// BestForm - Choose the best form for data.
715 ///
716 unsigned BestForm() const {
717 if ((unsigned char)Size == Size) return DW_FORM_block1;
718 if ((unsigned short)Size == Size) return DW_FORM_block2;
719 if ((unsigned int)Size == Size) return DW_FORM_block4;
720 return DW_FORM_block;
721 }
722
723 /// EmitValue - Emit block data.
724 ///
725 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000726
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000727 /// SizeOf - Determine size of block data in bytes.
728 ///
729 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000730
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000731
732 /// Profile - Used to gather unique data for the value folding set.
733 ///
734 virtual void Profile(FoldingSetNodeID &ID) {
735 ID.AddInteger(isBlock);
736 DIE::Profile(ID);
737 }
aslc200b112008-08-16 12:57:46 +0000738
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000739#ifndef NDEBUG
740 virtual void print(std::ostream &O) {
741 O << "Blk: ";
742 DIE::print(O, 5);
743 }
744#endif
745};
746
747//===----------------------------------------------------------------------===//
748/// CompileUnit - This dwarf writer support class manages information associate
749/// with a source file.
750class CompileUnit {
751private:
752 /// Desc - Compile unit debug descriptor.
753 ///
754 CompileUnitDesc *Desc;
aslc200b112008-08-16 12:57:46 +0000755
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000756 /// ID - File identifier for source.
757 ///
758 unsigned ID;
aslc200b112008-08-16 12:57:46 +0000759
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000760 /// Die - Compile unit debug information entry.
761 ///
762 DIE *Die;
aslc200b112008-08-16 12:57:46 +0000763
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000764 /// DescToDieMap - Tracks the mapping of unit level debug informaton
765 /// descriptors to debug information entries.
766 std::map<DebugInfoDesc *, DIE *> DescToDieMap;
Devang Patel4a4cbe72009-01-05 21:47:57 +0000767 DenseMap<GlobalVariable *, DIE *> GVToDieMap;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000768
769 /// DescToDIEntryMap - Tracks the mapping of unit level debug informaton
770 /// descriptors to debug information entries using a DIEntry proxy.
771 std::map<DebugInfoDesc *, DIEntry *> DescToDIEntryMap;
Devang Patel4a4cbe72009-01-05 21:47:57 +0000772 DenseMap<GlobalVariable *, DIEntry *> GVToDIEntryMap;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000773
774 /// Globals - A map of globally visible named entities for this unit.
775 ///
776 std::map<std::string, DIE *> Globals;
777
778 /// DiesSet - Used to uniquely define dies within the compile unit.
779 ///
780 FoldingSet<DIE> DiesSet;
aslc200b112008-08-16 12:57:46 +0000781
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000782 /// Dies - List of all dies in the compile unit.
783 ///
784 std::vector<DIE *> Dies;
aslc200b112008-08-16 12:57:46 +0000785
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000786public:
Devang Patelb3907da2009-01-05 23:03:32 +0000787 CompileUnit(unsigned I, DIE *D)
788 : ID(I), Die(D), DescToDieMap(), GVToDieMap(), DescToDIEntryMap(),
789 GVToDIEntryMap(), Globals(), DiesSet(InitDiesSetSize), Dies()
790 {}
791
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000792 CompileUnit(CompileUnitDesc *CUD, unsigned I, DIE *D)
793 : Desc(CUD)
794 , ID(I)
795 , Die(D)
796 , DescToDieMap()
Devang Patel4a4cbe72009-01-05 21:47:57 +0000797 , GVToDieMap()
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000798 , DescToDIEntryMap()
Devang Patel4a4cbe72009-01-05 21:47:57 +0000799 , GVToDIEntryMap()
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000800 , Globals()
801 , DiesSet(InitDiesSetSize)
802 , Dies()
803 {}
aslc200b112008-08-16 12:57:46 +0000804
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000805 ~CompileUnit() {
806 delete Die;
aslc200b112008-08-16 12:57:46 +0000807
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000808 for (unsigned i = 0, N = Dies.size(); i < N; ++i)
809 delete Dies[i];
810 }
aslc200b112008-08-16 12:57:46 +0000811
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000812 // Accessors.
813 CompileUnitDesc *getDesc() const { return Desc; }
814 unsigned getID() const { return ID; }
815 DIE* getDie() const { return Die; }
816 std::map<std::string, DIE *> &getGlobals() { return Globals; }
817
818 /// hasContent - Return true if this compile unit has something to write out.
819 ///
820 bool hasContent() const {
821 return !Die->getChildren().empty();
822 }
823
824 /// AddGlobal - Add a new global entity to the compile unit.
825 ///
826 void AddGlobal(const std::string &Name, DIE *Die) {
827 Globals[Name] = Die;
828 }
aslc200b112008-08-16 12:57:46 +0000829
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000830 /// getDieMapSlotFor - Returns the debug information entry map slot for the
831 /// specified debug descriptor.
832 DIE *&getDieMapSlotFor(DebugInfoDesc *DID) {
833 return DescToDieMap[DID];
834 }
Devang Patel4a4cbe72009-01-05 21:47:57 +0000835 DIE *&getDieMapSlotFor(GlobalVariable *GV) {
836 return GVToDieMap[GV];
837 }
aslc200b112008-08-16 12:57:46 +0000838
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000839 /// getDIEntrySlotFor - Returns the debug information entry proxy slot for the
840 /// specified debug descriptor.
841 DIEntry *&getDIEntrySlotFor(DebugInfoDesc *DID) {
842 return DescToDIEntryMap[DID];
843 }
Devang Patel4a4cbe72009-01-05 21:47:57 +0000844 DIEntry *&getDIEntrySlotFor(GlobalVariable *GV) {
845 return GVToDIEntryMap[GV];
846 }
aslc200b112008-08-16 12:57:46 +0000847
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000848 /// AddDie - Adds or interns the DIE to the compile unit.
849 ///
850 DIE *AddDie(DIE &Buffer) {
851 FoldingSetNodeID ID;
852 Buffer.Profile(ID);
853 void *Where;
854 DIE *Die = DiesSet.FindNodeOrInsertPos(ID, Where);
aslc200b112008-08-16 12:57:46 +0000855
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000856 if (!Die) {
857 Die = new DIE(Buffer);
858 DiesSet.InsertNode(Die, Where);
859 this->Die->AddChild(Die);
860 Buffer.Detach();
861 }
aslc200b112008-08-16 12:57:46 +0000862
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000863 return Die;
864 }
865};
866
867//===----------------------------------------------------------------------===//
aslc200b112008-08-16 12:57:46 +0000868/// Dwarf - Emits general Dwarf directives.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000869///
870class Dwarf {
871
872protected:
873
874 //===--------------------------------------------------------------------===//
875 // Core attributes used by the Dwarf writer.
876 //
aslc200b112008-08-16 12:57:46 +0000877
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000878 //
879 /// O - Stream to .s file.
880 ///
Owen Anderson847b99b2008-08-21 00:14:44 +0000881 raw_ostream &O;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000882
883 /// Asm - Target of Dwarf emission.
884 ///
885 AsmPrinter *Asm;
aslc200b112008-08-16 12:57:46 +0000886
Bill Wendlingac9639d2008-07-01 23:34:48 +0000887 /// TAI - Target asm information.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000888 const TargetAsmInfo *TAI;
aslc200b112008-08-16 12:57:46 +0000889
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000890 /// TD - Target data.
891 const TargetData *TD;
aslc200b112008-08-16 12:57:46 +0000892
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000893 /// RI - Register Information.
Dan Gohman1e57df32008-02-10 18:45:23 +0000894 const TargetRegisterInfo *RI;
aslc200b112008-08-16 12:57:46 +0000895
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000896 /// M - Current module.
897 ///
898 Module *M;
aslc200b112008-08-16 12:57:46 +0000899
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000900 /// MF - Current machine function.
901 ///
902 MachineFunction *MF;
aslc200b112008-08-16 12:57:46 +0000903
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000904 /// MMI - Collected machine module information.
905 ///
906 MachineModuleInfo *MMI;
aslc200b112008-08-16 12:57:46 +0000907
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000908 /// SubprogramCount - The running count of functions being compiled.
909 ///
910 unsigned SubprogramCount;
aslc200b112008-08-16 12:57:46 +0000911
Chris Lattnerb3876c72007-09-24 03:35:37 +0000912 /// Flavor - A unique string indicating what dwarf producer this is, used to
913 /// unique labels.
914 const char * const Flavor;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000915
916 unsigned SetCounter;
Owen Anderson847b99b2008-08-21 00:14:44 +0000917 Dwarf(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T,
Chris Lattnerb3876c72007-09-24 03:35:37 +0000918 const char *flavor)
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000919 : O(OS)
920 , Asm(A)
921 , TAI(T)
922 , TD(Asm->TM.getTargetData())
923 , RI(Asm->TM.getRegisterInfo())
924 , M(NULL)
925 , MF(NULL)
926 , MMI(NULL)
927 , SubprogramCount(0)
Chris Lattnerb3876c72007-09-24 03:35:37 +0000928 , Flavor(flavor)
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000929 , SetCounter(1)
930 {
931 }
932
933public:
934
935 //===--------------------------------------------------------------------===//
936 // Accessors.
937 //
938 AsmPrinter *getAsm() const { return Asm; }
939 MachineModuleInfo *getMMI() const { return MMI; }
940 const TargetAsmInfo *getTargetAsmInfo() const { return TAI; }
Dan Gohmancfb72b22007-09-27 23:12:31 +0000941 const TargetData *getTargetData() const { return TD; }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000942
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000943 void PrintRelDirective(bool Force32Bit = false, bool isInSection = false)
944 const {
945 if (isInSection && TAI->getDwarfSectionOffsetDirective())
946 O << TAI->getDwarfSectionOffsetDirective();
Dan Gohmancfb72b22007-09-27 23:12:31 +0000947 else if (Force32Bit || TD->getPointerSize() == sizeof(int32_t))
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000948 O << TAI->getData32bitsDirective();
949 else
950 O << TAI->getData64bitsDirective();
951 }
aslc200b112008-08-16 12:57:46 +0000952
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000953 /// PrintLabelName - Print label name in form used by Dwarf writer.
954 ///
955 void PrintLabelName(DWLabel Label) const {
956 PrintLabelName(Label.Tag, Label.Number);
957 }
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000958 void PrintLabelName(const char *Tag, unsigned Number) const {
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000959 O << TAI->getPrivateGlobalPrefix() << Tag;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000960 if (Number) O << Number;
961 }
aslc200b112008-08-16 12:57:46 +0000962
Chris Lattnerb3876c72007-09-24 03:35:37 +0000963 void PrintLabelName(const char *Tag, unsigned Number,
964 const char *Suffix) const {
965 O << TAI->getPrivateGlobalPrefix() << Tag;
966 if (Number) O << Number;
967 O << Suffix;
968 }
aslc200b112008-08-16 12:57:46 +0000969
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000970 /// EmitLabel - Emit location label for internal use by Dwarf.
971 ///
972 void EmitLabel(DWLabel Label) const {
973 EmitLabel(Label.Tag, Label.Number);
974 }
975 void EmitLabel(const char *Tag, unsigned Number) const {
976 PrintLabelName(Tag, Number);
977 O << ":\n";
978 }
aslc200b112008-08-16 12:57:46 +0000979
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000980 /// EmitReference - Emit a reference to a label.
981 ///
Dan Gohman4fd77742007-09-28 15:43:33 +0000982 void EmitReference(DWLabel Label, bool IsPCRelative = false,
983 bool Force32Bit = false) const {
984 EmitReference(Label.Tag, Label.Number, IsPCRelative, Force32Bit);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000985 }
986 void EmitReference(const char *Tag, unsigned Number,
Dan Gohman4fd77742007-09-28 15:43:33 +0000987 bool IsPCRelative = false, bool Force32Bit = false) const {
988 PrintRelDirective(Force32Bit);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000989 PrintLabelName(Tag, Number);
aslc200b112008-08-16 12:57:46 +0000990
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000991 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
992 }
Dan Gohman4fd77742007-09-28 15:43:33 +0000993 void EmitReference(const std::string &Name, bool IsPCRelative = false,
994 bool Force32Bit = false) const {
995 PrintRelDirective(Force32Bit);
aslc200b112008-08-16 12:57:46 +0000996
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000997 O << Name;
aslc200b112008-08-16 12:57:46 +0000998
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000999 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
1000 }
1001
1002 /// EmitDifference - Emit the difference between two labels. Some
1003 /// assemblers do not behave with absolute expressions with data directives,
1004 /// so there is an option (needsSet) to use an intermediary set expression.
1005 void EmitDifference(DWLabel LabelHi, DWLabel LabelLo,
1006 bool IsSmall = false) {
1007 EmitDifference(LabelHi.Tag, LabelHi.Number,
1008 LabelLo.Tag, LabelLo.Number,
1009 IsSmall);
1010 }
1011 void EmitDifference(const char *TagHi, unsigned NumberHi,
1012 const char *TagLo, unsigned NumberLo,
1013 bool IsSmall = false) {
1014 if (TAI->needsSet()) {
1015 O << "\t.set\t";
Chris Lattnerb3876c72007-09-24 03:35:37 +00001016 PrintLabelName("set", SetCounter, Flavor);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001017 O << ",";
1018 PrintLabelName(TagHi, NumberHi);
1019 O << "-";
1020 PrintLabelName(TagLo, NumberLo);
1021 O << "\n";
Anton Korobeynikov5ef86702007-09-02 22:07:21 +00001022
1023 PrintRelDirective(IsSmall);
Chris Lattnerb3876c72007-09-24 03:35:37 +00001024 PrintLabelName("set", SetCounter, Flavor);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001025 ++SetCounter;
1026 } else {
Anton Korobeynikov5ef86702007-09-02 22:07:21 +00001027 PrintRelDirective(IsSmall);
aslc200b112008-08-16 12:57:46 +00001028
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001029 PrintLabelName(TagHi, NumberHi);
1030 O << "-";
1031 PrintLabelName(TagLo, NumberLo);
1032 }
1033 }
1034
1035 void EmitSectionOffset(const char* Label, const char* Section,
1036 unsigned LabelNumber, unsigned SectionNumber,
Dale Johannesen0ebb2432008-03-26 23:31:39 +00001037 bool IsSmall = false, bool isEH = false,
1038 bool useSet = true) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001039 bool printAbsolute = false;
Dale Johannesen0ebb2432008-03-26 23:31:39 +00001040 if (isEH)
1041 printAbsolute = TAI->isAbsoluteEHSectionOffsets();
1042 else
1043 printAbsolute = TAI->isAbsoluteDebugSectionOffsets();
1044
1045 if (TAI->needsSet() && useSet) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001046 O << "\t.set\t";
Chris Lattnerb3876c72007-09-24 03:35:37 +00001047 PrintLabelName("set", SetCounter, Flavor);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001048 O << ",";
Anton Korobeynikov5ef86702007-09-02 22:07:21 +00001049 PrintLabelName(Label, LabelNumber);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001050
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001051 if (!printAbsolute) {
1052 O << "-";
1053 PrintLabelName(Section, SectionNumber);
aslc200b112008-08-16 12:57:46 +00001054 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001055 O << "\n";
Anton Korobeynikov5ef86702007-09-02 22:07:21 +00001056
1057 PrintRelDirective(IsSmall);
aslc200b112008-08-16 12:57:46 +00001058
Chris Lattnerb3876c72007-09-24 03:35:37 +00001059 PrintLabelName("set", SetCounter, Flavor);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001060 ++SetCounter;
1061 } else {
Anton Korobeynikov5ef86702007-09-02 22:07:21 +00001062 PrintRelDirective(IsSmall, true);
aslc200b112008-08-16 12:57:46 +00001063
Anton Korobeynikov5ef86702007-09-02 22:07:21 +00001064 PrintLabelName(Label, LabelNumber);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001065
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001066 if (!printAbsolute) {
1067 O << "-";
1068 PrintLabelName(Section, SectionNumber);
1069 }
aslc200b112008-08-16 12:57:46 +00001070 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001071 }
aslc200b112008-08-16 12:57:46 +00001072
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001073 /// EmitFrameMoves - Emit frame instructions to describe the layout of the
1074 /// frame.
1075 void EmitFrameMoves(const char *BaseLabel, unsigned BaseLabelID,
Dale Johannesenf5a11532007-11-13 19:13:01 +00001076 const std::vector<MachineMove> &Moves, bool isEH) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001077 int stackGrowth =
1078 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
1079 TargetFrameInfo::StackGrowsUp ?
Dan Gohmancfb72b22007-09-27 23:12:31 +00001080 TD->getPointerSize() : -TD->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001081 bool IsLocal = BaseLabel && strcmp(BaseLabel, "label") == 0;
1082
1083 for (unsigned i = 0, N = Moves.size(); i < N; ++i) {
1084 const MachineMove &Move = Moves[i];
1085 unsigned LabelID = Move.getLabelID();
aslc200b112008-08-16 12:57:46 +00001086
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001087 if (LabelID) {
1088 LabelID = MMI->MappedLabel(LabelID);
aslc200b112008-08-16 12:57:46 +00001089
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001090 // Throw out move if the label is invalid.
1091 if (!LabelID) continue;
1092 }
aslc200b112008-08-16 12:57:46 +00001093
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001094 const MachineLocation &Dst = Move.getDestination();
1095 const MachineLocation &Src = Move.getSource();
aslc200b112008-08-16 12:57:46 +00001096
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001097 // Advance row if new location.
1098 if (BaseLabel && LabelID && (BaseLabelID != LabelID || !IsLocal)) {
1099 Asm->EmitInt8(DW_CFA_advance_loc4);
1100 Asm->EOL("DW_CFA_advance_loc4");
1101 EmitDifference("label", LabelID, BaseLabel, BaseLabelID, true);
1102 Asm->EOL();
aslc200b112008-08-16 12:57:46 +00001103
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001104 BaseLabelID = LabelID;
1105 BaseLabel = "label";
1106 IsLocal = true;
1107 }
aslc200b112008-08-16 12:57:46 +00001108
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001109 // If advancing cfa.
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001110 if (Dst.isReg() && Dst.getReg() == MachineLocation::VirtualFP) {
1111 if (!Src.isReg()) {
1112 if (Src.getReg() == MachineLocation::VirtualFP) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001113 Asm->EmitInt8(DW_CFA_def_cfa_offset);
1114 Asm->EOL("DW_CFA_def_cfa_offset");
1115 } else {
1116 Asm->EmitInt8(DW_CFA_def_cfa);
1117 Asm->EOL("DW_CFA_def_cfa");
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001118 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Src.getReg(), isEH));
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001119 Asm->EOL("Register");
1120 }
aslc200b112008-08-16 12:57:46 +00001121
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001122 int Offset = -Src.getOffset();
aslc200b112008-08-16 12:57:46 +00001123
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001124 Asm->EmitULEB128Bytes(Offset);
1125 Asm->EOL("Offset");
1126 } else {
1127 assert(0 && "Machine move no supported yet.");
1128 }
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001129 } else if (Src.isReg() &&
1130 Src.getReg() == MachineLocation::VirtualFP) {
1131 if (Dst.isReg()) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001132 Asm->EmitInt8(DW_CFA_def_cfa_register);
1133 Asm->EOL("DW_CFA_def_cfa_register");
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001134 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Dst.getReg(), isEH));
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001135 Asm->EOL("Register");
1136 } else {
1137 assert(0 && "Machine move no supported yet.");
1138 }
1139 } else {
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001140 unsigned Reg = RI->getDwarfRegNum(Src.getReg(), isEH);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001141 int Offset = Dst.getOffset() / stackGrowth;
aslc200b112008-08-16 12:57:46 +00001142
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001143 if (Offset < 0) {
1144 Asm->EmitInt8(DW_CFA_offset_extended_sf);
1145 Asm->EOL("DW_CFA_offset_extended_sf");
1146 Asm->EmitULEB128Bytes(Reg);
1147 Asm->EOL("Reg");
1148 Asm->EmitSLEB128Bytes(Offset);
1149 Asm->EOL("Offset");
1150 } else if (Reg < 64) {
1151 Asm->EmitInt8(DW_CFA_offset + Reg);
Evan Cheng6181e062008-07-09 21:53:02 +00001152 if (VerboseAsm)
1153 Asm->EOL("DW_CFA_offset + Reg (" + utostr(Reg) + ")");
1154 else
1155 Asm->EOL();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001156 Asm->EmitULEB128Bytes(Offset);
1157 Asm->EOL("Offset");
1158 } else {
1159 Asm->EmitInt8(DW_CFA_offset_extended);
1160 Asm->EOL("DW_CFA_offset_extended");
1161 Asm->EmitULEB128Bytes(Reg);
1162 Asm->EOL("Reg");
1163 Asm->EmitULEB128Bytes(Offset);
1164 Asm->EOL("Offset");
1165 }
1166 }
1167 }
1168 }
1169
1170};
1171
1172//===----------------------------------------------------------------------===//
Devang Patel35a078f2009-01-12 22:54:42 +00001173/// SrcLineInfo - This class is used to record source line correspondence.
Devang Patel7dd15a92009-01-08 17:19:22 +00001174///
1175class SrcLineInfo {
1176 unsigned Line; // Source line number.
1177 unsigned Column; // Source column.
1178 unsigned SourceID; // Source ID number.
1179 unsigned LabelID; // Label in code ID number.
1180public:
1181 SrcLineInfo(unsigned L, unsigned C, unsigned S, unsigned I)
1182 : Line(L), Column(C), SourceID(S), LabelID(I) {}
1183
1184 // Accessors
1185 unsigned getLine() const { return Line; }
1186 unsigned getColumn() const { return Column; }
1187 unsigned getSourceID() const { return SourceID; }
1188 unsigned getLabelID() const { return LabelID; }
1189};
1190
1191
1192//===----------------------------------------------------------------------===//
Devang Patel5f244e32009-01-05 22:35:52 +00001193/// SrcFileInfo - This class is used to track source information.
1194///
1195class SrcFileInfo {
1196 unsigned DirectoryID; // Directory ID number.
1197 std::string Name; // File name (not including directory.)
1198public:
1199 SrcFileInfo(unsigned D, const std::string &N) : DirectoryID(D), Name(N) {}
1200
1201 // Accessors
1202 unsigned getDirectoryID() const { return DirectoryID; }
1203 const std::string &getName() const { return Name; }
1204
1205 /// operator== - Used by UniqueVector to locate entry.
1206 ///
1207 bool operator==(const SourceFileInfo &SI) const {
1208 return getDirectoryID() == SI.getDirectoryID() && getName() == SI.getName();
1209 }
1210
1211 /// operator< - Used by UniqueVector to locate entry.
1212 ///
1213 bool operator<(const SrcFileInfo &SI) const {
1214 return getDirectoryID() < SI.getDirectoryID() ||
1215 (getDirectoryID() == SI.getDirectoryID() && getName() < SI.getName());
1216 }
1217};
1218
1219//===----------------------------------------------------------------------===//
Devang Patel4d1709e2009-01-08 02:33:41 +00001220/// DbgVariable - This class is used to track local variable information.
1221///
1222class DbgVariable {
1223private:
1224 DIVariable *Var; // Variable Descriptor.
1225 unsigned FrameIndex; // Variable frame index.
1226
1227public:
1228 DbgVariable(DIVariable *V, unsigned I) : Var(V), FrameIndex(I) {}
1229
1230 // Accessors.
1231 DIVariable *getVariable() const { return Var; }
1232 unsigned getFrameIndex() const { return FrameIndex; }
1233};
1234
1235//===----------------------------------------------------------------------===//
1236/// DbgScope - This class is used to track scope information.
1237///
1238class DbgScope {
1239private:
1240 DbgScope *Parent; // Parent to this scope.
1241 DIDescriptor *Desc; // Debug info descriptor for scope.
1242 // Either subprogram or block.
1243 unsigned StartLabelID; // Label ID of the beginning of scope.
1244 unsigned EndLabelID; // Label ID of the end of scope.
Devang Patel63c22f42009-01-10 02:42:49 +00001245 SmallVector<DbgScope *, 4> Scopes; // Scopes defined in scope.
1246 SmallVector<DbgVariable *, 8> Variables;// Variables declared in scope.
Devang Patel4d1709e2009-01-08 02:33:41 +00001247
1248public:
1249 DbgScope(DbgScope *P, DIDescriptor *D)
1250 : Parent(P), Desc(D), StartLabelID(0), EndLabelID(0), Scopes(), Variables()
1251 {}
Devang Patela4162952009-01-12 18:48:36 +00001252 ~DbgScope() {
1253 for (unsigned i = 0, N = Scopes.size(); i < N; ++i) delete Scopes[i];
1254 for (unsigned j = 0, M = Variables.size(); j < M; ++j) delete Variables[j];
1255 }
Devang Patel4d1709e2009-01-08 02:33:41 +00001256
1257 // Accessors.
1258 DbgScope *getParent() const { return Parent; }
1259 DIDescriptor *getDesc() const { return Desc; }
1260 unsigned getStartLabelID() const { return StartLabelID; }
1261 unsigned getEndLabelID() const { return EndLabelID; }
Devang Patel63c22f42009-01-10 02:42:49 +00001262 SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
1263 SmallVector<DbgVariable *, 8> &getVariables() { return Variables; }
Devang Patel4d1709e2009-01-08 02:33:41 +00001264 void setStartLabelID(unsigned S) { StartLabelID = S; }
1265 void setEndLabelID(unsigned E) { EndLabelID = E; }
1266
1267 /// AddScope - Add a scope to the scope.
1268 ///
1269 void AddScope(DbgScope *S) { Scopes.push_back(S); }
1270
1271 /// AddVariable - Add a variable to the scope.
1272 ///
1273 void AddVariable(DbgVariable *V) { Variables.push_back(V); }
1274};
1275
1276//===----------------------------------------------------------------------===//
aslc200b112008-08-16 12:57:46 +00001277/// DwarfDebug - Emits Dwarf debug directives.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001278///
1279class DwarfDebug : public Dwarf {
1280
1281private:
1282 //===--------------------------------------------------------------------===//
1283 // Attributes used to construct specific Dwarf sections.
1284 //
aslc200b112008-08-16 12:57:46 +00001285
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001286 /// CompileUnits - All the compile units involved in this build. The index
1287 /// of each entry in this vector corresponds to the sources in MMI.
1288 std::vector<CompileUnit *> CompileUnits;
Devang Patel7dd15a92009-01-08 17:19:22 +00001289 DenseMap<Value *, CompileUnit *> DW_CUs;
aslc200b112008-08-16 12:57:46 +00001290
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001291 /// AbbreviationsSet - Used to uniquely define abbreviations.
1292 ///
1293 FoldingSet<DIEAbbrev> AbbreviationsSet;
1294
1295 /// Abbreviations - A list of all the unique abbreviations in use.
1296 ///
1297 std::vector<DIEAbbrev *> Abbreviations;
aslc200b112008-08-16 12:57:46 +00001298
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001299 /// ValuesSet - Used to uniquely define values.
1300 ///
Devang Patel5f244e32009-01-05 22:35:52 +00001301 // Directories - Uniquing vector for directories.
1302 UniqueVector<std::string> Directories;
1303
1304 // SourceFiles - Uniquing vector for source files.
1305 UniqueVector<SrcFileInfo> SrcFiles;
1306
Devang Patel7dd15a92009-01-08 17:19:22 +00001307 // Lines - List of of source line correspondence.
1308 std::vector<SrcLineInfo> Lines;
1309
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001310 FoldingSet<DIEValue> ValuesSet;
aslc200b112008-08-16 12:57:46 +00001311
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001312 /// Values - A list of all the unique values in use.
1313 ///
1314 std::vector<DIEValue *> Values;
aslc200b112008-08-16 12:57:46 +00001315
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001316 /// StringPool - A UniqueVector of strings used by indirect references.
1317 ///
1318 UniqueVector<std::string> StringPool;
1319
1320 /// UnitMap - Map debug information descriptor to compile unit.
1321 ///
1322 std::map<DebugInfoDesc *, CompileUnit *> DescToUnitMap;
aslc200b112008-08-16 12:57:46 +00001323
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001324 /// SectionMap - Provides a unique id per text section.
1325 ///
Anton Korobeynikov55b94962008-09-24 22:15:21 +00001326 UniqueVector<const Section*> SectionMap;
aslc200b112008-08-16 12:57:46 +00001327
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001328 /// SectionSourceLines - Tracks line numbers per text section.
1329 ///
Devang Patel35a078f2009-01-12 22:54:42 +00001330 std::vector<std::vector<SrcLineInfo> > SectionSourceLines;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001331
1332 /// didInitial - Flag to indicate if initial emission has been done.
1333 ///
1334 bool didInitial;
aslc200b112008-08-16 12:57:46 +00001335
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001336 /// shouldEmit - Flag to indicate if debug information should be emitted.
1337 ///
1338 bool shouldEmit;
1339
Devang Patel4d1709e2009-01-08 02:33:41 +00001340 // RootScope - Top level scope for the current function.
1341 //
1342 DbgScope *RootDbgScope;
1343
1344 // DbgScopeMap - Tracks the scopes in the current function.
1345 DenseMap<GlobalVariable *, DbgScope *> DbgScopeMap;
1346
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001347 struct FunctionDebugFrameInfo {
1348 unsigned Number;
1349 std::vector<MachineMove> Moves;
1350
1351 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M):
Dan Gohman9ba5d4d2007-08-27 14:50:10 +00001352 Number(Num), Moves(M) { }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001353 };
1354
1355 std::vector<FunctionDebugFrameInfo> DebugFrames;
aslc200b112008-08-16 12:57:46 +00001356
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001357public:
aslc200b112008-08-16 12:57:46 +00001358
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001359 /// ShouldEmitDwarf - Returns true if Dwarf declarations should be made.
1360 ///
1361 bool ShouldEmitDwarf() const { return shouldEmit; }
1362
1363 /// AssignAbbrevNumber - Define a unique number for the abbreviation.
aslc200b112008-08-16 12:57:46 +00001364 ///
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001365 void AssignAbbrevNumber(DIEAbbrev &Abbrev) {
1366 // Profile the node so that we can make it unique.
1367 FoldingSetNodeID ID;
1368 Abbrev.Profile(ID);
aslc200b112008-08-16 12:57:46 +00001369
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001370 // Check the set for priors.
1371 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
aslc200b112008-08-16 12:57:46 +00001372
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001373 // If it's newly added.
1374 if (InSet == &Abbrev) {
aslc200b112008-08-16 12:57:46 +00001375 // Add to abbreviation list.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001376 Abbreviations.push_back(&Abbrev);
1377 // Assign the vector position + 1 as its number.
1378 Abbrev.setNumber(Abbreviations.size());
1379 } else {
1380 // Assign existing abbreviation number.
1381 Abbrev.setNumber(InSet->getNumber());
1382 }
1383 }
1384
1385 /// NewString - Add a string to the constant pool and returns a label.
1386 ///
1387 DWLabel NewString(const std::string &String) {
1388 unsigned StringID = StringPool.insert(String);
1389 return DWLabel("string", StringID);
1390 }
aslc200b112008-08-16 12:57:46 +00001391
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001392 /// NewDIEntry - Creates a new DIEntry to be a proxy for a debug information
1393 /// entry.
1394 DIEntry *NewDIEntry(DIE *Entry = NULL) {
1395 DIEntry *Value;
aslc200b112008-08-16 12:57:46 +00001396
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001397 if (Entry) {
1398 FoldingSetNodeID ID;
1399 DIEntry::Profile(ID, Entry);
1400 void *Where;
1401 Value = static_cast<DIEntry *>(ValuesSet.FindNodeOrInsertPos(ID, Where));
aslc200b112008-08-16 12:57:46 +00001402
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001403 if (Value) return Value;
aslc200b112008-08-16 12:57:46 +00001404
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001405 Value = new DIEntry(Entry);
1406 ValuesSet.InsertNode(Value, Where);
1407 } else {
1408 Value = new DIEntry(Entry);
1409 }
aslc200b112008-08-16 12:57:46 +00001410
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001411 Values.push_back(Value);
1412 return Value;
1413 }
aslc200b112008-08-16 12:57:46 +00001414
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001415 /// SetDIEntry - Set a DIEntry once the debug information entry is defined.
1416 ///
1417 void SetDIEntry(DIEntry *Value, DIE *Entry) {
1418 Value->Entry = Entry;
1419 // Add to values set if not already there. If it is, we merely have a
1420 // duplicate in the values list (no harm.)
1421 ValuesSet.GetOrInsertNode(Value);
1422 }
1423
1424 /// AddUInt - Add an unsigned integer attribute data and value.
1425 ///
1426 void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer) {
1427 if (!Form) Form = DIEInteger::BestForm(false, Integer);
1428
1429 FoldingSetNodeID ID;
1430 DIEInteger::Profile(ID, Integer);
1431 void *Where;
1432 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1433 if (!Value) {
1434 Value = new DIEInteger(Integer);
1435 ValuesSet.InsertNode(Value, Where);
1436 Values.push_back(Value);
1437 }
aslc200b112008-08-16 12:57:46 +00001438
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001439 Die->AddValue(Attribute, Form, Value);
1440 }
aslc200b112008-08-16 12:57:46 +00001441
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001442 /// AddSInt - Add an signed integer attribute data and value.
1443 ///
1444 void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer) {
1445 if (!Form) Form = DIEInteger::BestForm(true, Integer);
1446
1447 FoldingSetNodeID ID;
1448 DIEInteger::Profile(ID, (uint64_t)Integer);
1449 void *Where;
1450 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1451 if (!Value) {
1452 Value = new DIEInteger(Integer);
1453 ValuesSet.InsertNode(Value, Where);
1454 Values.push_back(Value);
1455 }
aslc200b112008-08-16 12:57:46 +00001456
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001457 Die->AddValue(Attribute, Form, Value);
1458 }
aslc200b112008-08-16 12:57:46 +00001459
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001460 /// AddString - Add a std::string attribute data and value.
1461 ///
1462 void AddString(DIE *Die, unsigned Attribute, unsigned Form,
1463 const std::string &String) {
1464 FoldingSetNodeID ID;
1465 DIEString::Profile(ID, String);
1466 void *Where;
1467 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1468 if (!Value) {
1469 Value = new DIEString(String);
1470 ValuesSet.InsertNode(Value, Where);
1471 Values.push_back(Value);
1472 }
aslc200b112008-08-16 12:57:46 +00001473
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001474 Die->AddValue(Attribute, Form, Value);
1475 }
aslc200b112008-08-16 12:57:46 +00001476
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001477 /// AddLabel - Add a Dwarf label attribute data and value.
1478 ///
1479 void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
1480 const DWLabel &Label) {
1481 FoldingSetNodeID ID;
1482 DIEDwarfLabel::Profile(ID, Label);
1483 void *Where;
1484 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1485 if (!Value) {
1486 Value = new DIEDwarfLabel(Label);
1487 ValuesSet.InsertNode(Value, Where);
1488 Values.push_back(Value);
1489 }
aslc200b112008-08-16 12:57:46 +00001490
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001491 Die->AddValue(Attribute, Form, Value);
1492 }
aslc200b112008-08-16 12:57:46 +00001493
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001494 /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
1495 ///
1496 void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
1497 const std::string &Label) {
1498 FoldingSetNodeID ID;
1499 DIEObjectLabel::Profile(ID, Label);
1500 void *Where;
1501 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1502 if (!Value) {
1503 Value = new DIEObjectLabel(Label);
1504 ValuesSet.InsertNode(Value, Where);
1505 Values.push_back(Value);
1506 }
aslc200b112008-08-16 12:57:46 +00001507
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001508 Die->AddValue(Attribute, Form, Value);
1509 }
aslc200b112008-08-16 12:57:46 +00001510
Argiris Kirtzidis03449652008-06-18 19:27:37 +00001511 /// AddSectionOffset - Add a section offset label attribute data and value.
1512 ///
1513 void AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
1514 const DWLabel &Label, const DWLabel &Section,
1515 bool isEH = false, bool useSet = true) {
1516 FoldingSetNodeID ID;
1517 DIESectionOffset::Profile(ID, Label, Section);
1518 void *Where;
1519 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1520 if (!Value) {
1521 Value = new DIESectionOffset(Label, Section, isEH, useSet);
1522 ValuesSet.InsertNode(Value, Where);
1523 Values.push_back(Value);
1524 }
aslc200b112008-08-16 12:57:46 +00001525
Argiris Kirtzidis03449652008-06-18 19:27:37 +00001526 Die->AddValue(Attribute, Form, Value);
1527 }
aslc200b112008-08-16 12:57:46 +00001528
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001529 /// AddDelta - Add a label delta attribute data and value.
1530 ///
1531 void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
1532 const DWLabel &Hi, const DWLabel &Lo) {
1533 FoldingSetNodeID ID;
1534 DIEDelta::Profile(ID, Hi, Lo);
1535 void *Where;
1536 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1537 if (!Value) {
1538 Value = new DIEDelta(Hi, Lo);
1539 ValuesSet.InsertNode(Value, Where);
1540 Values.push_back(Value);
1541 }
aslc200b112008-08-16 12:57:46 +00001542
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001543 Die->AddValue(Attribute, Form, Value);
1544 }
aslc200b112008-08-16 12:57:46 +00001545
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001546 /// AddDIEntry - Add a DIE attribute data and value.
1547 ///
1548 void AddDIEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
1549 Die->AddValue(Attribute, Form, NewDIEntry(Entry));
1550 }
1551
1552 /// AddBlock - Add block data.
1553 ///
1554 void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block) {
1555 Block->ComputeSize(*this);
1556 FoldingSetNodeID ID;
1557 Block->Profile(ID);
1558 void *Where;
1559 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1560 if (!Value) {
1561 Value = Block;
1562 ValuesSet.InsertNode(Value, Where);
1563 Values.push_back(Value);
1564 } else {
Chris Lattner3de66892007-09-21 18:25:53 +00001565 // Already exists, reuse the previous one.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001566 delete Block;
Chris Lattner3de66892007-09-21 18:25:53 +00001567 Block = cast<DIEBlock>(Value);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001568 }
aslc200b112008-08-16 12:57:46 +00001569
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001570 Die->AddValue(Attribute, Block->BestForm(), Value);
1571 }
1572
1573private:
1574
1575 /// AddSourceLine - Add location information to specified debug information
1576 /// entry.
1577 void AddSourceLine(DIE *Die, CompileUnitDesc *File, unsigned Line) {
1578 if (File && Line) {
1579 CompileUnit *FileUnit = FindCompileUnit(File);
1580 unsigned FileID = FileUnit->getID();
1581 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1582 AddUInt(Die, DW_AT_decl_line, 0, Line);
1583 }
1584 }
1585
Devang Patel5f244e32009-01-05 22:35:52 +00001586 /// AddSourceLine - Add location information to specified debug information
1587 /// entry.
Devang Patel4d1709e2009-01-08 02:33:41 +00001588 void AddSourceLine(DIE *Die, DIVariable *V) {
1589 unsigned FileID = 0;
1590 unsigned Line = V->getLineNumber();
1591 if (V->getVersion() < DIDescriptor::Version7) {
1592 // Version6 or earlier. Use compile unit info to get file id.
1593 CompileUnit *Unit = FindCompileUnit(V->getCompileUnit());
1594 FileID = Unit->getID();
1595 } else {
1596 // Version7 or newer, use filename and directory info from DIVariable
1597 // directly.
1598 unsigned DID = Directories.idFor(V->getDirectory());
1599 FileID = SrcFiles.idFor(SrcFileInfo(DID, V->getFilename()));
1600 }
1601 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1602 AddUInt(Die, DW_AT_decl_line, 0, Line);
1603 }
1604
1605 /// AddSourceLine - Add location information to specified debug information
1606 /// entry.
Devang Patel5f244e32009-01-05 22:35:52 +00001607 void AddSourceLine(DIE *Die, DIGlobal *G) {
1608 unsigned FileID = 0;
1609 unsigned Line = G->getLineNumber();
1610 if (G->getVersion() < DIDescriptor::Version7) {
1611 // Version6 or earlier. Use compile unit info to get file id.
1612 CompileUnit *Unit = FindCompileUnit(G->getCompileUnit());
1613 FileID = Unit->getID();
1614 } else {
1615 // Version7 or newer, use filename and directory info from DIGlobal
1616 // directly.
1617 unsigned DID = Directories.idFor(G->getDirectory());
1618 FileID = SrcFiles.idFor(SrcFileInfo(DID, G->getFilename()));
1619 }
1620 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1621 AddUInt(Die, DW_AT_decl_line, 0, Line);
1622 }
1623
1624 void AddSourceLine(DIE *Die, DIType *G) {
1625 unsigned FileID = 0;
1626 unsigned Line = G->getLineNumber();
1627 if (G->getVersion() < DIDescriptor::Version7) {
1628 // Version6 or earlier. Use compile unit info to get file id.
1629 CompileUnit *Unit = FindCompileUnit(G->getCompileUnit());
1630 FileID = Unit->getID();
1631 } else {
1632 // Version7 or newer, use filename and directory info from DIGlobal
1633 // directly.
1634 unsigned DID = Directories.idFor(G->getDirectory());
1635 FileID = SrcFiles.idFor(SrcFileInfo(DID, G->getFilename()));
1636 }
1637 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1638 AddUInt(Die, DW_AT_decl_line, 0, Line);
1639 }
1640
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001641 /// AddAddress - Add an address attribute to a die based on the location
1642 /// provided.
1643 void AddAddress(DIE *Die, unsigned Attribute,
1644 const MachineLocation &Location) {
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001645 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001646 DIEBlock *Block = new DIEBlock();
aslc200b112008-08-16 12:57:46 +00001647
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001648 if (Location.isReg()) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001649 if (Reg < 32) {
1650 AddUInt(Block, 0, DW_FORM_data1, DW_OP_reg0 + Reg);
1651 } else {
1652 AddUInt(Block, 0, DW_FORM_data1, DW_OP_regx);
1653 AddUInt(Block, 0, DW_FORM_udata, Reg);
1654 }
1655 } else {
1656 if (Reg < 32) {
1657 AddUInt(Block, 0, DW_FORM_data1, DW_OP_breg0 + Reg);
1658 } else {
1659 AddUInt(Block, 0, DW_FORM_data1, DW_OP_bregx);
1660 AddUInt(Block, 0, DW_FORM_udata, Reg);
1661 }
1662 AddUInt(Block, 0, DW_FORM_sdata, Location.getOffset());
1663 }
aslc200b112008-08-16 12:57:46 +00001664
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001665 AddBlock(Die, Attribute, 0, Block);
1666 }
aslc200b112008-08-16 12:57:46 +00001667
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001668 /// AddBasicType - Add a new basic type attribute to the specified entity.
1669 ///
1670 void AddBasicType(DIE *Entity, CompileUnit *Unit,
1671 const std::string &Name,
1672 unsigned Encoding, unsigned Size) {
aslc200b112008-08-16 12:57:46 +00001673
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001674 DIE Buffer(DW_TAG_base_type);
1675 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1676 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, Encoding);
1677 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
Devang Patelf49e13d2009-01-05 17:44:11 +00001678 DIE *BasicTypeDie = Unit->AddDie(Buffer);
1679 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, BasicTypeDie);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001680 }
aslc200b112008-08-16 12:57:46 +00001681
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001682 /// AddPointerType - Add a new pointer type attribute to the specified entity.
1683 ///
1684 void AddPointerType(DIE *Entity, CompileUnit *Unit, const std::string &Name) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001685 DIE Buffer(DW_TAG_pointer_type);
Dan Gohmancfb72b22007-09-27 23:12:31 +00001686 AddUInt(&Buffer, DW_AT_byte_size, 0, TD->getPointerSize());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001687 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
Devang Patelbbca50b2009-01-05 17:45:59 +00001688 DIE *PointerTypeDie = Unit->AddDie(Buffer);
1689 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, PointerTypeDie);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001690 }
aslc200b112008-08-16 12:57:46 +00001691
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001692 /// AddType - Add a new type attribute to the specified entity.
1693 ///
1694 void AddType(DIE *Entity, TypeDesc *TyDesc, CompileUnit *Unit) {
1695 if (!TyDesc) {
1696 AddBasicType(Entity, Unit, "", DW_ATE_signed, sizeof(int32_t));
1697 } else {
1698 // Check for pre-existence.
1699 DIEntry *&Slot = Unit->getDIEntrySlotFor(TyDesc);
aslc200b112008-08-16 12:57:46 +00001700
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001701 // If it exists then use the existing value.
1702 if (Slot) {
1703 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1704 return;
1705 }
aslc200b112008-08-16 12:57:46 +00001706
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001707 if (SubprogramDesc *SubprogramTy = dyn_cast<SubprogramDesc>(TyDesc)) {
1708 // FIXME - Not sure why programs and variables are coming through here.
1709 // Short cut for handling subprogram types (not really a TyDesc.)
1710 AddPointerType(Entity, Unit, SubprogramTy->getName());
1711 } else if (GlobalVariableDesc *GlobalTy =
1712 dyn_cast<GlobalVariableDesc>(TyDesc)) {
1713 // FIXME - Not sure why programs and variables are coming through here.
1714 // Short cut for handling global variable types (not really a TyDesc.)
1715 AddPointerType(Entity, Unit, GlobalTy->getName());
aslc200b112008-08-16 12:57:46 +00001716 } else {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001717 // Set up proxy.
1718 Slot = NewDIEntry();
aslc200b112008-08-16 12:57:46 +00001719
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001720 // Construct type.
1721 DIE Buffer(DW_TAG_base_type);
1722 ConstructType(Buffer, TyDesc, Unit);
aslc200b112008-08-16 12:57:46 +00001723
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001724 // Add debug information entry to entity and unit.
1725 DIE *Die = Unit->AddDie(Buffer);
1726 SetDIEntry(Slot, Die);
1727 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1728 }
1729 }
1730 }
aslc200b112008-08-16 12:57:46 +00001731
Devang Patel4a4cbe72009-01-05 21:47:57 +00001732 /// AddType - Add a new type attribute to the specified entity.
1733 void AddType(CompileUnit *DW_Unit, DIE *Entity, DIType Ty) {
1734 if (Ty.isNull()) {
1735 AddBasicType(Entity, DW_Unit, "", DW_ATE_signed, sizeof(int32_t));
1736 return;
1737 }
1738
1739 // Check for pre-existence.
1740 DIEntry *&Slot = DW_Unit->getDIEntrySlotFor(Ty.getGV());
1741 // If it exists then use the existing value.
1742 if (Slot) {
1743 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1744 return;
1745 }
1746
1747 // Set up proxy.
1748 Slot = NewDIEntry();
1749
1750 // Construct type.
1751 DIE Buffer(DW_TAG_base_type);
1752 if (DIBasicType *BT = dyn_cast<DIBasicType>(&Ty))
1753 ConstructTypeDIE(DW_Unit, Buffer, BT);
1754 else if (DIDerivedType *DT = dyn_cast<DIDerivedType>(&Ty))
1755 ConstructTypeDIE(DW_Unit, Buffer, DT);
1756 else if (DICompositeType *CT = dyn_cast<DICompositeType>(&Ty))
1757 ConstructTypeDIE(DW_Unit, Buffer, CT);
1758
1759 // Add debug information entry to entity and unit.
1760 DIE *Die = DW_Unit->AddDie(Buffer);
1761 SetDIEntry(Slot, Die);
1762 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1763 }
1764
Devang Patel46d13752009-01-05 19:07:53 +00001765 /// ConstructTypeDIE - Construct basic type die from DIBasicType.
1766 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1767 DIBasicType *BTy) {
Devang Patelfc187162009-01-05 17:57:47 +00001768
1769 // Get core information.
1770 const std::string &Name = BTy->getName();
1771 Buffer.setTag(DW_TAG_base_type);
1772 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, BTy->getEncoding());
1773 // Add name if not anonymous or intermediate type.
1774 if (!Name.empty())
1775 AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1776 uint64_t Size = BTy->getSizeInBits() >> 3;
1777 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1778 }
1779
Devang Patel46d13752009-01-05 19:07:53 +00001780 /// ConstructTypeDIE - Construct derived type die from DIDerivedType.
1781 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1782 DIDerivedType *DTy) {
Devang Patelfc187162009-01-05 17:57:47 +00001783
1784 // Get core information.
1785 const std::string &Name = DTy->getName();
1786 uint64_t Size = DTy->getSizeInBits() >> 3;
1787 unsigned Tag = DTy->getTag();
1788 // FIXME - Workaround for templates.
1789 if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
1790
1791 Buffer.setTag(Tag);
1792 // Map to main type, void will not have a type.
1793 DIType FromTy = DTy->getTypeDerivedFrom();
Devang Patel4a4cbe72009-01-05 21:47:57 +00001794 AddType(DW_Unit, &Buffer, FromTy);
Devang Patelfc187162009-01-05 17:57:47 +00001795
1796 // Add name if not anonymous or intermediate type.
1797 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1798
1799 // Add size if non-zero (derived types might be zero-sized.)
1800 if (Size)
1801 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1802
1803 // Add source line info if available and TyDesc is not a forward
1804 // declaration.
1805 // FIXME - Enable this. if (!DTy->isForwardDecl())
1806 // FIXME - Enable this. AddSourceLine(&Buffer, *DTy);
1807 }
1808
Devang Patel30c01372009-01-05 19:55:51 +00001809 /// ConstructTypeDIE - Construct type DIE from DICompositeType.
1810 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1811 DICompositeType *CTy) {
1812
1813 // Get core information.
1814 const std::string &Name = CTy->getName();
1815 uint64_t Size = CTy->getSizeInBits() >> 3;
1816 unsigned Tag = CTy->getTag();
1817 switch (Tag) {
1818 case DW_TAG_vector_type:
1819 case DW_TAG_array_type:
1820 ConstructArrayTypeDIE(DW_Unit, Buffer, CTy);
1821 break;
1822 //FIXME - Enable this.
1823 // case DW_TAG_enumeration_type:
1824 // DIArray Elements = CTy->getTypeArray();
1825 // // Add enumerators to enumeration type.
1826 // for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i)
1827 // ConstructEnumTypeDIE(Buffer, &Elements.getElement(i));
1828 // break;
1829 case DW_TAG_subroutine_type:
1830 {
1831 // Add prototype flag.
1832 AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
1833 DIArray Elements = CTy->getTypeArray();
1834 // Add return type.
Devang Patel4a4cbe72009-01-05 21:47:57 +00001835 DIDescriptor RTy = Elements.getElement(0);
1836 if (DIBasicType *BT = dyn_cast<DIBasicType>(&RTy))
1837 AddType(DW_Unit, &Buffer, *BT);
1838 else if (DIDerivedType *DT = dyn_cast<DIDerivedType>(&RTy))
1839 AddType(DW_Unit, &Buffer, *DT);
1840 else if (DICompositeType *CT = dyn_cast<DICompositeType>(&RTy))
1841 AddType(DW_Unit, &Buffer, *CT);
1842
1843 //AddType(DW_Unit, &Buffer, Elements.getElement(0));
Devang Patel30c01372009-01-05 19:55:51 +00001844 // Add arguments.
1845 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1846 DIE *Arg = new DIE(DW_TAG_formal_parameter);
Devang Patel4a4cbe72009-01-05 21:47:57 +00001847 DIDescriptor Ty = Elements.getElement(i);
1848 if (DIBasicType *BT = dyn_cast<DIBasicType>(&Ty))
1849 AddType(DW_Unit, &Buffer, *BT);
1850 else if (DIDerivedType *DT = dyn_cast<DIDerivedType>(&Ty))
1851 AddType(DW_Unit, &Buffer, *DT);
1852 else if (DICompositeType *CT = dyn_cast<DICompositeType>(&Ty))
1853 AddType(DW_Unit, &Buffer, *CT);
Devang Patel30c01372009-01-05 19:55:51 +00001854 Buffer.AddChild(Arg);
1855 }
1856 }
1857 break;
1858 case DW_TAG_structure_type:
1859 case DW_TAG_union_type:
1860 {
1861 // Add elements to structure type.
1862 DIArray Elements = CTy->getTypeArray();
1863 // Add elements to structure type.
1864 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1865 DIDescriptor Element = Elements.getElement(i);
1866 if (DISubprogram *SP = dyn_cast<DISubprogram>(&Element))
1867 ConstructFieldTypeDIE(DW_Unit, Buffer, SP);
1868 else if (DIDerivedType *DT = dyn_cast<DIDerivedType>(&Element))
1869 ConstructFieldTypeDIE(DW_Unit, Buffer, DT);
1870 else if (DIGlobalVariable *GV = dyn_cast<DIGlobalVariable>(&Element))
1871 ConstructFieldTypeDIE(DW_Unit, Buffer, GV);
1872 }
1873 }
1874 break;
1875 default:
1876 break;
1877 }
1878
1879 // Add name if not anonymous or intermediate type.
1880 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1881
1882 // Add size if non-zero (derived types might be zero-sized.)
1883 if (Size)
1884 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1885 else {
1886 // Add zero size even if it is not a forward declaration.
1887 // FIXME - Enable this.
1888 // if (!CTy->isDefinition())
1889 // AddUInt(&Buffer, DW_AT_declaration, DW_FORM_flag, 1);
1890 // else
1891 // AddUInt(&Buffer, DW_AT_byte_size, 0, 0);
1892 }
1893
1894 // Add source line info if available and TyDesc is not a forward
1895 // declaration.
1896 // FIXME - Enable this.
1897 // if (CTy->isForwardDecl())
1898 // AddSourceLine(&Buffer, *CTy);
1899 }
1900
Devang Patel6fb54132009-01-05 18:33:01 +00001901 // ConstructSubrangeDIE - Construct subrange DIE from DISubrange.
1902 void ConstructSubrangeDIE (DIE &Buffer, DISubrange *SR, DIE *IndexTy) {
1903 int64_t L = SR->getLo();
1904 int64_t H = SR->getHi();
1905 DIE *DW_Subrange = new DIE(DW_TAG_subrange_type);
1906 if (L != H) {
1907 AddDIEntry(DW_Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1908 if (L)
1909 AddSInt(DW_Subrange, DW_AT_lower_bound, 0, L);
1910 AddSInt(DW_Subrange, DW_AT_upper_bound, 0, H);
1911 }
1912 Buffer.AddChild(DW_Subrange);
1913 }
1914
1915 /// ConstructArrayTypeDIE - Construct array type DIE from DICompositeType.
1916 void ConstructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1917 DICompositeType *CTy) {
1918 Buffer.setTag(DW_TAG_array_type);
1919 if (CTy->getTag() == DW_TAG_vector_type)
1920 AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1921
1922 DIArray Elements = CTy->getTypeArray();
1923 // FIXME - Enable this.
Devang Patel4a4cbe72009-01-05 21:47:57 +00001924 AddType(DW_Unit, &Buffer, CTy->getTypeDerivedFrom());
Devang Patel6fb54132009-01-05 18:33:01 +00001925
1926 // Construct an anonymous type for index type.
1927 DIE IdxBuffer(DW_TAG_base_type);
1928 AddUInt(&IdxBuffer, DW_AT_byte_size, 0, sizeof(int32_t));
1929 AddUInt(&IdxBuffer, DW_AT_encoding, DW_FORM_data1, DW_ATE_signed);
1930 DIE *IndexTy = DW_Unit->AddDie(IdxBuffer);
1931
1932 // Add subranges to array type.
1933 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
Devang Patel30c01372009-01-05 19:55:51 +00001934 DIDescriptor Element = Elements.getElement(i);
1935 if (DISubrange *SR = dyn_cast<DISubrange>(&Element))
1936 ConstructSubrangeDIE(Buffer, SR, IndexTy);
Devang Patel6fb54132009-01-05 18:33:01 +00001937 }
1938 }
1939
Devang Patela566e812009-01-05 18:38:38 +00001940 /// ConstructEnumTypeDIE - Construct enum type DIE from
1941 /// DIEnumerator.
Devang Patel30c01372009-01-05 19:55:51 +00001942 void ConstructEnumTypeDIE(CompileUnit *DW_Unit,
1943 DIE &Buffer, DIEnumerator *ETy) {
Devang Patela566e812009-01-05 18:38:38 +00001944
1945 DIE *Enumerator = new DIE(DW_TAG_enumerator);
1946 AddString(Enumerator, DW_AT_name, DW_FORM_string, ETy->getName());
1947 int64_t Value = ETy->getEnumValue();
1948 AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
1949 Buffer.AddChild(Enumerator);
1950 }
Devang Patel6fb54132009-01-05 18:33:01 +00001951
Devang Patel526b01d2009-01-05 18:59:44 +00001952 /// ConstructFieldTypeDIE - Construct variable DIE for a struct field.
1953 void ConstructFieldTypeDIE(CompileUnit *DW_Unit,
1954 DIE &Buffer, DIGlobalVariable *V) {
1955
1956 DIE *VariableDie = new DIE(DW_TAG_variable);
1957 const std::string &LinkageName = V->getLinkageName();
1958 if (!LinkageName.empty())
1959 AddString(VariableDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
1960 LinkageName);
1961 // FIXME - Enable this. AddSourceLine(VariableDie, V);
Devang Patel4a4cbe72009-01-05 21:47:57 +00001962 AddType(DW_Unit, VariableDie, V->getType());
Devang Patel526b01d2009-01-05 18:59:44 +00001963 if (!V->isLocalToUnit())
1964 AddUInt(VariableDie, DW_AT_external, DW_FORM_flag, 1);
1965 AddUInt(VariableDie, DW_AT_declaration, DW_FORM_flag, 1);
1966 Buffer.AddChild(VariableDie);
1967 }
1968
1969 /// ConstructFieldTypeDIE - Construct subprogram DIE for a struct field.
1970 void ConstructFieldTypeDIE(CompileUnit *DW_Unit,
1971 DIE &Buffer, DISubprogram *SP,
1972 bool IsConstructor = false) {
1973 DIE *Method = new DIE(DW_TAG_subprogram);
1974 AddString(Method, DW_AT_name, DW_FORM_string, SP->getName());
1975 const std::string &LinkageName = SP->getLinkageName();
1976 if (!LinkageName.empty())
1977 AddString(Method, DW_AT_MIPS_linkage_name, DW_FORM_string, LinkageName);
1978 // FIXME - Enable this. AddSourceLine(Method, SP);
1979
1980 DICompositeType MTy = SP->getType();
1981 DIArray Args = MTy.getTypeArray();
1982
1983 // Add Return Type.
Devang Patel4a4cbe72009-01-05 21:47:57 +00001984 if (!IsConstructor) {
1985 DIDescriptor Ty = Args.getElement(0);
1986 if (DIBasicType *BT = dyn_cast<DIBasicType>(&Ty))
1987 AddType(DW_Unit, Method, *BT);
1988 else if (DIDerivedType *DT = dyn_cast<DIDerivedType>(&Ty))
1989 AddType(DW_Unit, Method, *DT);
1990 else if (DICompositeType *CT = dyn_cast<DICompositeType>(&Ty))
1991 AddType(DW_Unit, Method, *CT);
1992 }
Devang Patel526b01d2009-01-05 18:59:44 +00001993
1994 // Add arguments.
1995 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1996 DIE *Arg = new DIE(DW_TAG_formal_parameter);
Devang Patel4a4cbe72009-01-05 21:47:57 +00001997 DIDescriptor Ty = Args.getElement(i);
1998 if (DIBasicType *BT = dyn_cast<DIBasicType>(&Ty))
1999 AddType(DW_Unit, Method, *BT);
2000 else if (DIDerivedType *DT = dyn_cast<DIDerivedType>(&Ty))
2001 AddType(DW_Unit, Method, *DT);
2002 else if (DICompositeType *CT = dyn_cast<DICompositeType>(&Ty))
2003 AddType(DW_Unit, Method, *CT);
Devang Patel526b01d2009-01-05 18:59:44 +00002004 AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1); // ???
2005 Method->AddChild(Arg);
2006 }
2007
2008 if (!SP->isLocalToUnit())
2009 AddUInt(Method, DW_AT_external, DW_FORM_flag, 1);
2010 Buffer.AddChild(Method);
2011 }
2012
2013 /// COnstructFieldTypeDIE - Construct derived type DIE for a struct field.
2014 void ConstructFieldTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
2015 DIDerivedType *DTy) {
2016 unsigned Tag = DTy->getTag();
2017 DIE *MemberDie = new DIE(Tag);
2018 if (!DTy->getName().empty())
2019 AddString(MemberDie, DW_AT_name, DW_FORM_string, DTy->getName());
2020 // FIXME - Enable this. AddSourceLine(MemberDie, DTy);
2021
2022 DIType FromTy = DTy->getTypeDerivedFrom();
Devang Patel4a4cbe72009-01-05 21:47:57 +00002023 AddType(DW_Unit, MemberDie, FromTy);
Devang Patel526b01d2009-01-05 18:59:44 +00002024
2025 uint64_t Size = DTy->getSizeInBits();
2026 uint64_t Offset = DTy->getOffsetInBits();
2027
2028 // FIXME Handle bitfields
2029
2030 // Add size.
2031 AddUInt(MemberDie, DW_AT_bit_size, 0, Size);
2032 // Add computation for offset.
2033 DIEBlock *Block = new DIEBlock();
2034 AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
2035 AddUInt(Block, 0, DW_FORM_udata, Offset >> 3);
2036 AddBlock(MemberDie, DW_AT_data_member_location, 0, Block);
2037
2038 // FIXME Handle DW_AT_accessibility.
2039
2040 Buffer.AddChild(MemberDie);
2041 }
2042
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002043 /// ConstructType - Adds all the required attributes to the type.
2044 ///
2045 void ConstructType(DIE &Buffer, TypeDesc *TyDesc, CompileUnit *Unit) {
2046 // Get core information.
2047 const std::string &Name = TyDesc->getName();
2048 uint64_t Size = TyDesc->getSize() >> 3;
aslc200b112008-08-16 12:57:46 +00002049
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002050 if (BasicTypeDesc *BasicTy = dyn_cast<BasicTypeDesc>(TyDesc)) {
2051 // Fundamental types like int, float, bool
2052 Buffer.setTag(DW_TAG_base_type);
2053 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, BasicTy->getEncoding());
2054 } else if (DerivedTypeDesc *DerivedTy = dyn_cast<DerivedTypeDesc>(TyDesc)) {
2055 // Fetch tag.
2056 unsigned Tag = DerivedTy->getTag();
2057 // FIXME - Workaround for templates.
2058 if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
aslc200b112008-08-16 12:57:46 +00002059 // Pointers, typedefs et al.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002060 Buffer.setTag(Tag);
2061 // Map to main type, void will not have a type.
2062 if (TypeDesc *FromTy = DerivedTy->getFromType())
2063 AddType(&Buffer, FromTy, Unit);
2064 } else if (CompositeTypeDesc *CompTy = dyn_cast<CompositeTypeDesc>(TyDesc)){
2065 // Fetch tag.
2066 unsigned Tag = CompTy->getTag();
aslc200b112008-08-16 12:57:46 +00002067
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002068 // Set tag accordingly.
2069 if (Tag == DW_TAG_vector_type)
2070 Buffer.setTag(DW_TAG_array_type);
aslc200b112008-08-16 12:57:46 +00002071 else
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002072 Buffer.setTag(Tag);
2073
2074 std::vector<DebugInfoDesc *> &Elements = CompTy->getElements();
aslc200b112008-08-16 12:57:46 +00002075
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002076 switch (Tag) {
2077 case DW_TAG_vector_type:
2078 AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
2079 // Fall thru
2080 case DW_TAG_array_type: {
2081 // Add element type.
2082 if (TypeDesc *FromTy = CompTy->getFromType())
2083 AddType(&Buffer, FromTy, Unit);
aslc200b112008-08-16 12:57:46 +00002084
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002085 // Don't emit size attribute.
2086 Size = 0;
aslc200b112008-08-16 12:57:46 +00002087
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002088 // Construct an anonymous type for index type.
Devang Patelf49e13d2009-01-05 17:44:11 +00002089 DIE Buffer(DW_TAG_base_type);
2090 AddUInt(&Buffer, DW_AT_byte_size, 0, sizeof(int32_t));
2091 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, DW_ATE_signed);
2092 DIE *IndexTy = Unit->AddDie(Buffer);
aslc200b112008-08-16 12:57:46 +00002093
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002094 // Add subranges to array type.
Evan Chengc7efea32008-12-09 17:56:30 +00002095 for (unsigned i = 0, N = Elements.size(); i < N; ++i) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002096 SubrangeDesc *SRD = cast<SubrangeDesc>(Elements[i]);
2097 int64_t Lo = SRD->getLo();
2098 int64_t Hi = SRD->getHi();
2099 DIE *Subrange = new DIE(DW_TAG_subrange_type);
aslc200b112008-08-16 12:57:46 +00002100
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002101 // If a range is available.
2102 if (Lo != Hi) {
2103 AddDIEntry(Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
2104 // Only add low if non-zero.
2105 if (Lo) AddSInt(Subrange, DW_AT_lower_bound, 0, Lo);
2106 AddSInt(Subrange, DW_AT_upper_bound, 0, Hi);
2107 }
aslc200b112008-08-16 12:57:46 +00002108
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002109 Buffer.AddChild(Subrange);
2110 }
2111 break;
2112 }
2113 case DW_TAG_structure_type:
2114 case DW_TAG_union_type: {
2115 // Add elements to structure type.
Evan Chengc7efea32008-12-09 17:56:30 +00002116 for (unsigned i = 0, N = Elements.size(); i < N; ++i) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002117 DebugInfoDesc *Element = Elements[i];
aslc200b112008-08-16 12:57:46 +00002118
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002119 if (DerivedTypeDesc *MemberDesc = dyn_cast<DerivedTypeDesc>(Element)){
2120 // Add field or base class.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002121 unsigned Tag = MemberDesc->getTag();
aslc200b112008-08-16 12:57:46 +00002122
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002123 // Extract the basic information.
2124 const std::string &Name = MemberDesc->getName();
2125 uint64_t Size = MemberDesc->getSize();
2126 uint64_t Align = MemberDesc->getAlign();
2127 uint64_t Offset = MemberDesc->getOffset();
aslc200b112008-08-16 12:57:46 +00002128
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002129 // Construct member debug information entry.
2130 DIE *Member = new DIE(Tag);
aslc200b112008-08-16 12:57:46 +00002131
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002132 // Add name if not "".
2133 if (!Name.empty())
2134 AddString(Member, DW_AT_name, DW_FORM_string, Name);
Evan Chengc7efea32008-12-09 17:56:30 +00002135
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002136 // Add location if available.
2137 AddSourceLine(Member, MemberDesc->getFile(), MemberDesc->getLine());
aslc200b112008-08-16 12:57:46 +00002138
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002139 // Most of the time the field info is the same as the members.
2140 uint64_t FieldSize = Size;
2141 uint64_t FieldAlign = Align;
2142 uint64_t FieldOffset = Offset;
aslc200b112008-08-16 12:57:46 +00002143
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002144 // Set the member type.
2145 TypeDesc *FromTy = MemberDesc->getFromType();
2146 AddType(Member, FromTy, Unit);
aslc200b112008-08-16 12:57:46 +00002147
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002148 // Walk up typedefs until a real size is found.
2149 while (FromTy) {
2150 if (FromTy->getTag() != DW_TAG_typedef) {
2151 FieldSize = FromTy->getSize();
Devang Patel105a08a2008-12-23 21:55:38 +00002152 FieldAlign = FromTy->getAlign();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002153 break;
2154 }
aslc200b112008-08-16 12:57:46 +00002155
Dan Gohman53491e92007-07-23 20:24:29 +00002156 FromTy = cast<DerivedTypeDesc>(FromTy)->getFromType();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002157 }
aslc200b112008-08-16 12:57:46 +00002158
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002159 // Unless we have a bit field.
2160 if (Tag == DW_TAG_member && FieldSize != Size) {
2161 // Construct the alignment mask.
2162 uint64_t AlignMask = ~(FieldAlign - 1);
2163 // Determine the high bit + 1 of the declared size.
2164 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
2165 // Work backwards to determine the base offset of the field.
2166 FieldOffset = HiMark - FieldSize;
2167 // Now normalize offset to the field.
2168 Offset -= FieldOffset;
aslc200b112008-08-16 12:57:46 +00002169
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002170 // Maybe we need to work from the other end.
2171 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
aslc200b112008-08-16 12:57:46 +00002172
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002173 // Add size and offset.
2174 AddUInt(Member, DW_AT_byte_size, 0, FieldSize >> 3);
2175 AddUInt(Member, DW_AT_bit_size, 0, Size);
2176 AddUInt(Member, DW_AT_bit_offset, 0, Offset);
2177 }
aslc200b112008-08-16 12:57:46 +00002178
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002179 // Add computation for offset.
2180 DIEBlock *Block = new DIEBlock();
2181 AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
2182 AddUInt(Block, 0, DW_FORM_udata, FieldOffset >> 3);
2183 AddBlock(Member, DW_AT_data_member_location, 0, Block);
2184
2185 // Add accessibility (public default unless is base class.
2186 if (MemberDesc->isProtected()) {
2187 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_protected);
2188 } else if (MemberDesc->isPrivate()) {
2189 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_private);
2190 } else if (Tag == DW_TAG_inheritance) {
2191 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_public);
2192 }
aslc200b112008-08-16 12:57:46 +00002193
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002194 Buffer.AddChild(Member);
2195 } else if (GlobalVariableDesc *StaticDesc =
2196 dyn_cast<GlobalVariableDesc>(Element)) {
2197 // Add static member.
aslc200b112008-08-16 12:57:46 +00002198
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002199 // Construct member debug information entry.
2200 DIE *Static = new DIE(DW_TAG_variable);
aslc200b112008-08-16 12:57:46 +00002201
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002202 // Add name and mangled name.
2203 const std::string &Name = StaticDesc->getName();
2204 const std::string &LinkageName = StaticDesc->getLinkageName();
2205 AddString(Static, DW_AT_name, DW_FORM_string, Name);
2206 if (!LinkageName.empty()) {
2207 AddString(Static, DW_AT_MIPS_linkage_name, DW_FORM_string,
2208 LinkageName);
2209 }
aslc200b112008-08-16 12:57:46 +00002210
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002211 // Add location.
2212 AddSourceLine(Static, StaticDesc->getFile(), StaticDesc->getLine());
aslc200b112008-08-16 12:57:46 +00002213
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002214 // Add type.
2215 if (TypeDesc *StaticTy = StaticDesc->getType())
2216 AddType(Static, StaticTy, Unit);
aslc200b112008-08-16 12:57:46 +00002217
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002218 // Add flags.
2219 if (!StaticDesc->isStatic())
2220 AddUInt(Static, DW_AT_external, DW_FORM_flag, 1);
2221 AddUInt(Static, DW_AT_declaration, DW_FORM_flag, 1);
aslc200b112008-08-16 12:57:46 +00002222
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002223 Buffer.AddChild(Static);
2224 } else if (SubprogramDesc *MethodDesc =
2225 dyn_cast<SubprogramDesc>(Element)) {
2226 // Add member function.
aslc200b112008-08-16 12:57:46 +00002227
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002228 // Construct member debug information entry.
2229 DIE *Method = new DIE(DW_TAG_subprogram);
aslc200b112008-08-16 12:57:46 +00002230
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002231 // Add name and mangled name.
2232 const std::string &Name = MethodDesc->getName();
2233 const std::string &LinkageName = MethodDesc->getLinkageName();
aslc200b112008-08-16 12:57:46 +00002234
2235 AddString(Method, DW_AT_name, DW_FORM_string, Name);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002236 bool IsCTor = TyDesc->getName() == Name;
aslc200b112008-08-16 12:57:46 +00002237
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002238 if (!LinkageName.empty()) {
2239 AddString(Method, DW_AT_MIPS_linkage_name, DW_FORM_string,
2240 LinkageName);
2241 }
aslc200b112008-08-16 12:57:46 +00002242
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002243 // Add location.
2244 AddSourceLine(Method, MethodDesc->getFile(), MethodDesc->getLine());
aslc200b112008-08-16 12:57:46 +00002245
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002246 // Add type.
2247 if (CompositeTypeDesc *MethodTy =
2248 dyn_cast_or_null<CompositeTypeDesc>(MethodDesc->getType())) {
2249 // Get argument information.
2250 std::vector<DebugInfoDesc *> &Args = MethodTy->getElements();
aslc200b112008-08-16 12:57:46 +00002251
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002252 // If not a ctor.
2253 if (!IsCTor) {
2254 // Add return type.
2255 AddType(Method, dyn_cast<TypeDesc>(Args[0]), Unit);
2256 }
aslc200b112008-08-16 12:57:46 +00002257
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002258 // Add arguments.
Evan Chengc7efea32008-12-09 17:56:30 +00002259 for (unsigned i = 1, N = Args.size(); i < N; ++i) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002260 DIE *Arg = new DIE(DW_TAG_formal_parameter);
2261 AddType(Arg, cast<TypeDesc>(Args[i]), Unit);
2262 AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1);
2263 Method->AddChild(Arg);
2264 }
2265 }
2266
2267 // Add flags.
2268 if (!MethodDesc->isStatic())
2269 AddUInt(Method, DW_AT_external, DW_FORM_flag, 1);
2270 AddUInt(Method, DW_AT_declaration, DW_FORM_flag, 1);
aslc200b112008-08-16 12:57:46 +00002271
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002272 Buffer.AddChild(Method);
2273 }
2274 }
2275 break;
2276 }
2277 case DW_TAG_enumeration_type: {
2278 // Add enumerators to enumeration type.
Evan Chengc7efea32008-12-09 17:56:30 +00002279 for (unsigned i = 0, N = Elements.size(); i < N; ++i) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002280 EnumeratorDesc *ED = cast<EnumeratorDesc>(Elements[i]);
2281 const std::string &Name = ED->getName();
2282 int64_t Value = ED->getValue();
2283 DIE *Enumerator = new DIE(DW_TAG_enumerator);
2284 AddString(Enumerator, DW_AT_name, DW_FORM_string, Name);
2285 AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
2286 Buffer.AddChild(Enumerator);
2287 }
2288
2289 break;
2290 }
2291 case DW_TAG_subroutine_type: {
2292 // Add prototype flag.
2293 AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
2294 // Add return type.
2295 AddType(&Buffer, dyn_cast<TypeDesc>(Elements[0]), Unit);
aslc200b112008-08-16 12:57:46 +00002296
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002297 // Add arguments.
Evan Chengc7efea32008-12-09 17:56:30 +00002298 for (unsigned i = 1, N = Elements.size(); i < N; ++i) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002299 DIE *Arg = new DIE(DW_TAG_formal_parameter);
2300 AddType(Arg, cast<TypeDesc>(Elements[i]), Unit);
2301 Buffer.AddChild(Arg);
2302 }
aslc200b112008-08-16 12:57:46 +00002303
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002304 break;
2305 }
2306 default: break;
2307 }
2308 }
aslc200b112008-08-16 12:57:46 +00002309
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002310 // Add name if not anonymous or intermediate type.
2311 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
Evan Chengc7efea32008-12-09 17:56:30 +00002312
Evan Chengb2fc7112008-12-10 00:15:44 +00002313 // Add size if non-zero (derived types might be zero-sized.)
2314 if (Size)
2315 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
2316 else if (isa<CompositeTypeDesc>(TyDesc)) {
2317 // If TyDesc is a composite type, then add size even if it's zero unless
2318 // it's a forward declaration.
2319 if (TyDesc->isForwardDecl())
2320 AddUInt(&Buffer, DW_AT_declaration, DW_FORM_flag, 1);
2321 else
2322 AddUInt(&Buffer, DW_AT_byte_size, 0, 0);
2323 }
2324
2325 // Add source line info if available and TyDesc is not a forward
2326 // declaration.
2327 if (!TyDesc->isForwardDecl())
2328 AddSourceLine(&Buffer, TyDesc->getFile(), TyDesc->getLine());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002329 }
2330
2331 /// NewCompileUnit - Create new compile unit and it's debug information entry.
2332 ///
2333 CompileUnit *NewCompileUnit(CompileUnitDesc *UnitDesc, unsigned ID) {
2334 // Construct debug information entry.
2335 DIE *Die = new DIE(DW_TAG_compile_unit);
Argiris Kirtzidis03449652008-06-18 19:27:37 +00002336 AddSectionOffset(Die, DW_AT_stmt_list, DW_FORM_data4,
2337 DWLabel("section_line", 0), DWLabel("section_line", 0), false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002338 AddString(Die, DW_AT_producer, DW_FORM_string, UnitDesc->getProducer());
2339 AddUInt (Die, DW_AT_language, DW_FORM_data1, UnitDesc->getLanguage());
2340 AddString(Die, DW_AT_name, DW_FORM_string, UnitDesc->getFileName());
Devang Patel6bcf9822008-12-12 21:57:54 +00002341 if (!UnitDesc->getDirectory().empty())
2342 AddString(Die, DW_AT_comp_dir, DW_FORM_string, UnitDesc->getDirectory());
aslc200b112008-08-16 12:57:46 +00002343
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002344 // Construct compile unit.
2345 CompileUnit *Unit = new CompileUnit(UnitDesc, ID, Die);
aslc200b112008-08-16 12:57:46 +00002346
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002347 // Add Unit to compile unit map.
2348 DescToUnitMap[UnitDesc] = Unit;
aslc200b112008-08-16 12:57:46 +00002349
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002350 return Unit;
2351 }
2352
2353 /// GetBaseCompileUnit - Get the main compile unit.
2354 ///
2355 CompileUnit *GetBaseCompileUnit() const {
2356 CompileUnit *Unit = CompileUnits[0];
2357 assert(Unit && "Missing compile unit.");
2358 return Unit;
2359 }
2360
2361 /// FindCompileUnit - Get the compile unit for the given descriptor.
2362 ///
2363 CompileUnit *FindCompileUnit(CompileUnitDesc *UnitDesc) {
2364 CompileUnit *Unit = DescToUnitMap[UnitDesc];
2365 assert(Unit && "Missing compile unit.");
2366 return Unit;
2367 }
2368
Devang Patel5f244e32009-01-05 22:35:52 +00002369 /// FindCompileUnit - Get the compile unit for the given descriptor.
2370 ///
2371 CompileUnit *FindCompileUnit(DICompileUnit Unit) {
2372 CompileUnit *DW_Unit = DW_CUs[Unit.getGV()];
2373 assert(DW_Unit && "Missing compile unit.");
2374 return DW_Unit;
2375 }
2376
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002377 /// NewGlobalVariable - Add a new global variable DIE.
2378 ///
2379 DIE *NewGlobalVariable(GlobalVariableDesc *GVD) {
2380 // Get the compile unit context.
2381 CompileUnitDesc *UnitDesc =
2382 static_cast<CompileUnitDesc *>(GVD->getContext());
2383 CompileUnit *Unit = GetBaseCompileUnit();
2384
2385 // Check for pre-existence.
2386 DIE *&Slot = Unit->getDieMapSlotFor(GVD);
2387 if (Slot) return Slot;
aslc200b112008-08-16 12:57:46 +00002388
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002389 // Get the global variable itself.
2390 GlobalVariable *GV = GVD->getGlobalVariable();
2391
2392 const std::string &Name = GVD->getName();
2393 const std::string &FullName = GVD->getFullName();
2394 const std::string &LinkageName = GVD->getLinkageName();
2395 // Create the global's variable DIE.
2396 DIE *VariableDie = new DIE(DW_TAG_variable);
2397 AddString(VariableDie, DW_AT_name, DW_FORM_string, Name);
2398 if (!LinkageName.empty()) {
2399 AddString(VariableDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
2400 LinkageName);
2401 }
2402 AddType(VariableDie, GVD->getType(), Unit);
2403 if (!GVD->isStatic())
2404 AddUInt(VariableDie, DW_AT_external, DW_FORM_flag, 1);
aslc200b112008-08-16 12:57:46 +00002405
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002406 // Add source line info if available.
2407 AddSourceLine(VariableDie, UnitDesc, GVD->getLine());
aslc200b112008-08-16 12:57:46 +00002408
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002409 // Add address.
2410 DIEBlock *Block = new DIEBlock();
2411 AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
2412 AddObjectLabel(Block, 0, DW_FORM_udata, Asm->getGlobalLinkName(GV));
2413 AddBlock(VariableDie, DW_AT_location, 0, Block);
aslc200b112008-08-16 12:57:46 +00002414
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002415 // Add to map.
2416 Slot = VariableDie;
aslc200b112008-08-16 12:57:46 +00002417
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002418 // Add to context owner.
2419 Unit->getDie()->AddChild(VariableDie);
aslc200b112008-08-16 12:57:46 +00002420
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002421 // Expose as global.
2422 // FIXME - need to check external flag.
2423 Unit->AddGlobal(FullName, VariableDie);
aslc200b112008-08-16 12:57:46 +00002424
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002425 return VariableDie;
2426 }
2427
2428 /// NewSubprogram - Add a new subprogram DIE.
2429 ///
2430 DIE *NewSubprogram(SubprogramDesc *SPD) {
2431 // Get the compile unit context.
2432 CompileUnitDesc *UnitDesc =
2433 static_cast<CompileUnitDesc *>(SPD->getContext());
2434 CompileUnit *Unit = GetBaseCompileUnit();
2435
2436 // Check for pre-existence.
2437 DIE *&Slot = Unit->getDieMapSlotFor(SPD);
2438 if (Slot) return Slot;
aslc200b112008-08-16 12:57:46 +00002439
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002440 // Gather the details (simplify add attribute code.)
2441 const std::string &Name = SPD->getName();
2442 const std::string &FullName = SPD->getFullName();
2443 const std::string &LinkageName = SPD->getLinkageName();
aslc200b112008-08-16 12:57:46 +00002444
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002445 DIE *SubprogramDie = new DIE(DW_TAG_subprogram);
2446 AddString(SubprogramDie, DW_AT_name, DW_FORM_string, Name);
2447 if (!LinkageName.empty()) {
2448 AddString(SubprogramDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
2449 LinkageName);
2450 }
2451 if (SPD->getType()) AddType(SubprogramDie, SPD->getType(), Unit);
2452 if (!SPD->isStatic())
2453 AddUInt(SubprogramDie, DW_AT_external, DW_FORM_flag, 1);
2454 AddUInt(SubprogramDie, DW_AT_prototyped, DW_FORM_flag, 1);
aslc200b112008-08-16 12:57:46 +00002455
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002456 // Add source line info if available.
2457 AddSourceLine(SubprogramDie, UnitDesc, SPD->getLine());
2458
2459 // Add to map.
2460 Slot = SubprogramDie;
aslc200b112008-08-16 12:57:46 +00002461
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002462 // Add to context owner.
2463 Unit->getDie()->AddChild(SubprogramDie);
aslc200b112008-08-16 12:57:46 +00002464
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002465 // Expose as global.
2466 Unit->AddGlobal(FullName, SubprogramDie);
aslc200b112008-08-16 12:57:46 +00002467
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002468 return SubprogramDie;
2469 }
2470
2471 /// NewScopeVariable - Create a new scope variable.
2472 ///
2473 DIE *NewScopeVariable(DebugVariable *DV, CompileUnit *Unit) {
2474 // Get the descriptor.
2475 VariableDesc *VD = DV->getDesc();
2476
2477 // Translate tag to proper Dwarf tag. The result variable is dropped for
2478 // now.
2479 unsigned Tag;
2480 switch (VD->getTag()) {
2481 case DW_TAG_return_variable: return NULL;
2482 case DW_TAG_arg_variable: Tag = DW_TAG_formal_parameter; break;
2483 case DW_TAG_auto_variable: // fall thru
2484 default: Tag = DW_TAG_variable; break;
2485 }
2486
2487 // Define variable debug information entry.
2488 DIE *VariableDie = new DIE(Tag);
2489 AddString(VariableDie, DW_AT_name, DW_FORM_string, VD->getName());
2490
2491 // Add source line info if available.
2492 AddSourceLine(VariableDie, VD->getFile(), VD->getLine());
aslc200b112008-08-16 12:57:46 +00002493
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002494 // Add variable type.
aslc200b112008-08-16 12:57:46 +00002495 AddType(VariableDie, VD->getType(), Unit);
2496
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002497 // Add variable address.
2498 MachineLocation Location;
Evan Cheng38948832008-01-31 03:37:28 +00002499 Location.set(RI->getFrameRegister(*MF),
2500 RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002501 AddAddress(VariableDie, DW_AT_location, Location);
2502
2503 return VariableDie;
2504 }
2505
Devang Patel4d1709e2009-01-08 02:33:41 +00002506 /// NewScopeVariable - Create a new scope variable.
2507 ///
2508 DIE *NewDbgScopeVariable(DbgVariable *DV, CompileUnit *Unit) {
2509 // Get the descriptor.
2510 DIVariable *VD = DV->getVariable();
2511
2512 // Translate tag to proper Dwarf tag. The result variable is dropped for
2513 // now.
2514 unsigned Tag;
2515 switch (VD->getTag()) {
2516 case DW_TAG_return_variable: return NULL;
2517 case DW_TAG_arg_variable: Tag = DW_TAG_formal_parameter; break;
2518 case DW_TAG_auto_variable: // fall thru
2519 default: Tag = DW_TAG_variable; break;
2520 }
2521
2522 // Define variable debug information entry.
2523 DIE *VariableDie = new DIE(Tag);
2524 AddString(VariableDie, DW_AT_name, DW_FORM_string, VD->getName());
2525
2526 // Add source line info if available.
2527 AddSourceLine(VariableDie, VD);
2528
2529 // Add variable type.
2530 AddType(Unit, VariableDie, VD->getType());
2531
2532 // Add variable address.
2533 MachineLocation Location;
2534 Location.set(RI->getFrameRegister(*MF),
2535 RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
2536 AddAddress(VariableDie, DW_AT_location, Location);
2537
2538 return VariableDie;
2539 }
2540
Devang Patel4d1709e2009-01-08 02:33:41 +00002541 /// getOrCreateScope - Returns the scope associated with the given descriptor.
2542 ///
2543 DbgScope *getOrCreateScope(GlobalVariable *V) {
2544 DbgScope *&Slot = DbgScopeMap[V];
2545 if (!Slot) {
2546 // FIXME - breaks down when the context is an inlined function.
2547 DIDescriptor ParentDesc;
Devang Pateldd49fbb2009-01-10 02:34:18 +00002548 DIDescriptor *DB = new DIBlock(V);
Devang Patel4d1709e2009-01-08 02:33:41 +00002549 if (DIBlock *Block = dyn_cast<DIBlock>(DB)) {
2550 ParentDesc = Block->getContext();
2551 }
2552 DbgScope *Parent = ParentDesc.isNull() ?
Devang Pateldd49fbb2009-01-10 02:34:18 +00002553 NULL : getOrCreateScope(ParentDesc.getGV());
Devang Patel4d1709e2009-01-08 02:33:41 +00002554 Slot = new DbgScope(Parent, DB);
2555 if (Parent) {
2556 Parent->AddScope(Slot);
2557 } else if (RootDbgScope) {
2558 // FIXME - Add inlined function scopes to the root so we can delete
2559 // them later. Long term, handle inlined functions properly.
2560 RootDbgScope->AddScope(Slot);
2561 } else {
2562 // First function is top level function.
2563 RootDbgScope = Slot;
2564 }
2565 }
2566 return Slot;
2567 }
2568
2569 /// ConstructDbgScope - Construct the components of a scope.
2570 ///
2571 void ConstructDbgScope(DbgScope *ParentScope,
2572 unsigned ParentStartID, unsigned ParentEndID,
2573 DIE *ParentDie, CompileUnit *Unit) {
2574 // Add variables to scope.
Devang Patel63c22f42009-01-10 02:42:49 +00002575 SmallVector<DbgVariable *, 8> &Variables = ParentScope->getVariables();
Devang Patel4d1709e2009-01-08 02:33:41 +00002576 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2577 DIE *VariableDie = NewDbgScopeVariable(Variables[i], Unit);
2578 if (VariableDie) ParentDie->AddChild(VariableDie);
2579 }
2580
2581 // Add nested scopes.
Devang Patel63c22f42009-01-10 02:42:49 +00002582 SmallVector<DbgScope *, 4> &Scopes = ParentScope->getScopes();
Devang Patel4d1709e2009-01-08 02:33:41 +00002583 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
2584 // Define the Scope debug information entry.
2585 DbgScope *Scope = Scopes[j];
2586 // FIXME - Ignore inlined functions for the time being.
2587 if (!Scope->getParent()) continue;
2588
Devang Patelb9224922009-01-12 18:41:00 +00002589 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
2590 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
Devang Patel4d1709e2009-01-08 02:33:41 +00002591
2592 // Ignore empty scopes.
2593 if (StartID == EndID && StartID != 0) continue;
2594 if (Scope->getScopes().empty() && Scope->getVariables().empty()) continue;
2595
2596 if (StartID == ParentStartID && EndID == ParentEndID) {
2597 // Just add stuff to the parent scope.
2598 ConstructDbgScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
2599 } else {
2600 DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
2601
2602 // Add the scope bounds.
2603 if (StartID) {
2604 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2605 DWLabel("label", StartID));
2606 } else {
2607 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2608 DWLabel("func_begin", SubprogramCount));
2609 }
2610 if (EndID) {
2611 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2612 DWLabel("label", EndID));
2613 } else {
2614 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2615 DWLabel("func_end", SubprogramCount));
2616 }
2617
2618 // Add the scope contents.
2619 ConstructDbgScope(Scope, StartID, EndID, ScopeDie, Unit);
2620 ParentDie->AddChild(ScopeDie);
2621 }
2622 }
2623 }
2624
2625 /// ConstructRootDbgScope - Construct the scope for the subprogram.
2626 ///
2627 void ConstructRootDbgScope(DbgScope *RootScope) {
2628 // Exit if there is no root scope.
2629 if (!RootScope) return;
2630
2631 // Get the subprogram debug information entry.
Devang Patel57ec9ac2009-01-12 22:58:14 +00002632 DISubprogram SPD(RootScope->getDesc()->getGV());
Devang Patel4d1709e2009-01-08 02:33:41 +00002633
2634 // Get the compile unit context.
Devang Patel57ec9ac2009-01-12 22:58:14 +00002635 CompileUnit *Unit = FindCompileUnit(SPD.getCompileUnit());
Devang Patel4d1709e2009-01-08 02:33:41 +00002636
2637 // Get the subprogram die.
Devang Patel57ec9ac2009-01-12 22:58:14 +00002638 DIE *SPDie = Unit->getDieMapSlotFor(SPD.getGV());
Devang Patel4d1709e2009-01-08 02:33:41 +00002639 assert(SPDie && "Missing subprogram descriptor");
2640
2641 // Add the function bounds.
2642 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2643 DWLabel("func_begin", SubprogramCount));
2644 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2645 DWLabel("func_end", SubprogramCount));
2646 MachineLocation Location(RI->getFrameRegister(*MF));
2647 AddAddress(SPDie, DW_AT_frame_base, Location);
2648
2649 ConstructDbgScope(RootScope, 0, 0, SPDie, Unit);
2650 }
2651
2652 /// ConstructDefaultDbgScope - Construct a default scope for the subprogram.
2653 ///
2654 void ConstructDefaultDbgScope(MachineFunction *MF) {
2655 // Find the correct subprogram descriptor.
2656 std::string SPName = "llvm.dbg.subprograms";
2657 std::vector<GlobalVariable*> Result;
2658 getGlobalVariablesUsing(*M, SPName, Result);
2659 for (std::vector<GlobalVariable *>::iterator I = Result.begin(),
2660 E = Result.end(); I != E; ++I) {
2661
2662 DISubprogram *SPD = new DISubprogram(*I);
2663
2664 if (SPD->getName() == MF->getFunction()->getName()) {
2665 // Get the compile unit context.
2666 CompileUnit *Unit = FindCompileUnit(SPD->getCompileUnit());
2667
2668 // Get the subprogram die.
2669 DIE *SPDie = Unit->getDieMapSlotFor(SPD->getGV());
2670 assert(SPDie && "Missing subprogram descriptor");
2671
2672 // Add the function bounds.
2673 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2674 DWLabel("func_begin", SubprogramCount));
2675 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2676 DWLabel("func_end", SubprogramCount));
2677
2678 MachineLocation Location(RI->getFrameRegister(*MF));
2679 AddAddress(SPDie, DW_AT_frame_base, Location);
2680 return;
2681 }
2682 }
2683#if 0
2684 // FIXME: This is causing an abort because C++ mangled names are compared
2685 // with their unmangled counterparts. See PR2885. Don't do this assert.
2686 assert(0 && "Couldn't find DIE for machine function!");
2687#endif
2688 }
2689
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002690 /// ConstructScope - Construct the components of a scope.
2691 ///
2692 void ConstructScope(DebugScope *ParentScope,
2693 unsigned ParentStartID, unsigned ParentEndID,
2694 DIE *ParentDie, CompileUnit *Unit) {
2695 // Add variables to scope.
2696 std::vector<DebugVariable *> &Variables = ParentScope->getVariables();
2697 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2698 DIE *VariableDie = NewScopeVariable(Variables[i], Unit);
2699 if (VariableDie) ParentDie->AddChild(VariableDie);
2700 }
aslc200b112008-08-16 12:57:46 +00002701
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002702 // Add nested scopes.
2703 std::vector<DebugScope *> &Scopes = ParentScope->getScopes();
2704 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
2705 // Define the Scope debug information entry.
2706 DebugScope *Scope = Scopes[j];
2707 // FIXME - Ignore inlined functions for the time being.
2708 if (!Scope->getParent()) continue;
aslc200b112008-08-16 12:57:46 +00002709
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002710 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
2711 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
2712
2713 // Ignore empty scopes.
2714 if (StartID == EndID && StartID != 0) continue;
2715 if (Scope->getScopes().empty() && Scope->getVariables().empty()) continue;
aslc200b112008-08-16 12:57:46 +00002716
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002717 if (StartID == ParentStartID && EndID == ParentEndID) {
2718 // Just add stuff to the parent scope.
2719 ConstructScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
2720 } else {
2721 DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
aslc200b112008-08-16 12:57:46 +00002722
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002723 // Add the scope bounds.
2724 if (StartID) {
2725 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2726 DWLabel("label", StartID));
2727 } else {
2728 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2729 DWLabel("func_begin", SubprogramCount));
2730 }
2731 if (EndID) {
2732 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2733 DWLabel("label", EndID));
2734 } else {
2735 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2736 DWLabel("func_end", SubprogramCount));
2737 }
aslc200b112008-08-16 12:57:46 +00002738
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002739 // Add the scope contents.
2740 ConstructScope(Scope, StartID, EndID, ScopeDie, Unit);
2741 ParentDie->AddChild(ScopeDie);
2742 }
2743 }
2744 }
2745
2746 /// ConstructRootScope - Construct the scope for the subprogram.
2747 ///
2748 void ConstructRootScope(DebugScope *RootScope) {
2749 // Exit if there is no root scope.
2750 if (!RootScope) return;
aslc200b112008-08-16 12:57:46 +00002751
2752 // Get the subprogram debug information entry.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002753 SubprogramDesc *SPD = cast<SubprogramDesc>(RootScope->getDesc());
aslc200b112008-08-16 12:57:46 +00002754
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002755 // Get the compile unit context.
2756 CompileUnit *Unit = GetBaseCompileUnit();
aslc200b112008-08-16 12:57:46 +00002757
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002758 // Get the subprogram die.
2759 DIE *SPDie = Unit->getDieMapSlotFor(SPD);
2760 assert(SPDie && "Missing subprogram descriptor");
aslc200b112008-08-16 12:57:46 +00002761
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002762 // Add the function bounds.
2763 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2764 DWLabel("func_begin", SubprogramCount));
2765 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2766 DWLabel("func_end", SubprogramCount));
2767 MachineLocation Location(RI->getFrameRegister(*MF));
2768 AddAddress(SPDie, DW_AT_frame_base, Location);
2769
2770 ConstructScope(RootScope, 0, 0, SPDie, Unit);
2771 }
2772
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00002773 /// ConstructDefaultScope - Construct a default scope for the subprogram.
2774 ///
2775 void ConstructDefaultScope(MachineFunction *MF) {
2776 // Find the correct subprogram descriptor.
2777 std::vector<SubprogramDesc *> Subprograms;
2778 MMI->getAnchoredDescriptors<SubprogramDesc>(*M, Subprograms);
2779
2780 for (unsigned i = 0, N = Subprograms.size(); i < N; ++i) {
2781 SubprogramDesc *SPD = Subprograms[i];
2782
2783 if (SPD->getName() == MF->getFunction()->getName()) {
2784 // Get the compile unit context.
2785 CompileUnit *Unit = GetBaseCompileUnit();
2786
2787 // Get the subprogram die.
2788 DIE *SPDie = Unit->getDieMapSlotFor(SPD);
2789 assert(SPDie && "Missing subprogram descriptor");
2790
2791 // Add the function bounds.
2792 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2793 DWLabel("func_begin", SubprogramCount));
2794 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2795 DWLabel("func_end", SubprogramCount));
2796
2797 MachineLocation Location(RI->getFrameRegister(*MF));
2798 AddAddress(SPDie, DW_AT_frame_base, Location);
2799 return;
2800 }
2801 }
Bill Wendlingae6b98c2008-10-17 18:48:57 +00002802#if 0
2803 // FIXME: This is causing an abort because C++ mangled names are compared
2804 // with their unmangled counterparts. See PR2885. Don't do this assert.
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00002805 assert(0 && "Couldn't find DIE for machine function!");
Bill Wendlingae6b98c2008-10-17 18:48:57 +00002806#endif
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00002807 }
2808
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002809 /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
2810 /// tools to recognize the object file contains Dwarf information.
2811 void EmitInitial() {
2812 // Check to see if we already emitted intial headers.
2813 if (didInitial) return;
2814 didInitial = true;
aslc200b112008-08-16 12:57:46 +00002815
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002816 // Dwarf sections base addresses.
2817 if (TAI->doesDwarfRequireFrameSection()) {
2818 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2819 EmitLabel("section_debug_frame", 0);
2820 }
2821 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2822 EmitLabel("section_info", 0);
2823 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2824 EmitLabel("section_abbrev", 0);
2825 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2826 EmitLabel("section_aranges", 0);
2827 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2828 EmitLabel("section_macinfo", 0);
2829 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2830 EmitLabel("section_line", 0);
2831 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2832 EmitLabel("section_loc", 0);
2833 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2834 EmitLabel("section_pubnames", 0);
2835 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2836 EmitLabel("section_str", 0);
2837 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2838 EmitLabel("section_ranges", 0);
2839
Anton Korobeynikov55b94962008-09-24 22:15:21 +00002840 Asm->SwitchToSection(TAI->getTextSection());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002841 EmitLabel("text_begin", 0);
Anton Korobeynikovcca60fa2008-09-24 22:16:16 +00002842 Asm->SwitchToSection(TAI->getDataSection());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002843 EmitLabel("data_begin", 0);
2844 }
2845
2846 /// EmitDIE - Recusively Emits a debug information entry.
2847 ///
2848 void EmitDIE(DIE *Die) {
2849 // Get the abbreviation for this DIE.
2850 unsigned AbbrevNumber = Die->getAbbrevNumber();
2851 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
aslc200b112008-08-16 12:57:46 +00002852
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002853 Asm->EOL();
2854
2855 // Emit the code (index) for the abbreviation.
2856 Asm->EmitULEB128Bytes(AbbrevNumber);
Evan Cheng0eeed442008-07-01 23:18:29 +00002857
2858 if (VerboseAsm)
2859 Asm->EOL(std::string("Abbrev [" +
2860 utostr(AbbrevNumber) +
2861 "] 0x" + utohexstr(Die->getOffset()) +
2862 ":0x" + utohexstr(Die->getSize()) + " " +
2863 TagString(Abbrev->getTag())));
2864 else
2865 Asm->EOL();
aslc200b112008-08-16 12:57:46 +00002866
Owen Anderson88dd6232008-06-24 21:44:59 +00002867 SmallVector<DIEValue*, 32> &Values = Die->getValues();
2868 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
aslc200b112008-08-16 12:57:46 +00002869
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002870 // Emit the DIE attribute values.
2871 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2872 unsigned Attr = AbbrevData[i].getAttribute();
2873 unsigned Form = AbbrevData[i].getForm();
2874 assert(Form && "Too many attributes for DIE (check abbreviation)");
aslc200b112008-08-16 12:57:46 +00002875
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002876 switch (Attr) {
2877 case DW_AT_sibling: {
2878 Asm->EmitInt32(Die->SiblingOffset());
2879 break;
2880 }
2881 default: {
2882 // Emit an attribute using the defined form.
2883 Values[i]->EmitValue(*this, Form);
2884 break;
2885 }
2886 }
aslc200b112008-08-16 12:57:46 +00002887
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002888 Asm->EOL(AttributeString(Attr));
2889 }
aslc200b112008-08-16 12:57:46 +00002890
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002891 // Emit the DIE children if any.
2892 if (Abbrev->getChildrenFlag() == DW_CHILDREN_yes) {
2893 const std::vector<DIE *> &Children = Die->getChildren();
aslc200b112008-08-16 12:57:46 +00002894
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002895 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2896 EmitDIE(Children[j]);
2897 }
aslc200b112008-08-16 12:57:46 +00002898
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002899 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2900 }
2901 }
2902
2903 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
2904 ///
2905 unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
2906 // Get the children.
2907 const std::vector<DIE *> &Children = Die->getChildren();
aslc200b112008-08-16 12:57:46 +00002908
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002909 // If not last sibling and has children then add sibling offset attribute.
2910 if (!Last && !Children.empty()) Die->AddSiblingOffset();
2911
2912 // Record the abbreviation.
2913 AssignAbbrevNumber(Die->getAbbrev());
aslc200b112008-08-16 12:57:46 +00002914
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002915 // Get the abbreviation for this DIE.
2916 unsigned AbbrevNumber = Die->getAbbrevNumber();
2917 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2918
2919 // Set DIE offset
2920 Die->setOffset(Offset);
aslc200b112008-08-16 12:57:46 +00002921
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002922 // Start the size with the size of abbreviation code.
aslc200b112008-08-16 12:57:46 +00002923 Offset += TargetAsmInfo::getULEB128Size(AbbrevNumber);
2924
Owen Anderson88dd6232008-06-24 21:44:59 +00002925 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2926 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002927
2928 // Size the DIE attribute values.
2929 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2930 // Size attribute value.
2931 Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
2932 }
aslc200b112008-08-16 12:57:46 +00002933
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002934 // Size the DIE children if any.
2935 if (!Children.empty()) {
2936 assert(Abbrev->getChildrenFlag() == DW_CHILDREN_yes &&
2937 "Children flag not set");
aslc200b112008-08-16 12:57:46 +00002938
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002939 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2940 Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
2941 }
aslc200b112008-08-16 12:57:46 +00002942
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002943 // End of children marker.
2944 Offset += sizeof(int8_t);
2945 }
2946
2947 Die->setSize(Offset - Die->getOffset());
2948 return Offset;
2949 }
2950
2951 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
2952 ///
2953 void SizeAndOffsets() {
2954 // Process base compile unit.
Devang Patel6eae2832009-01-12 23:05:55 +00002955 for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
2956 CE = DW_CUs.end(); CI != CE; ++CI) {
2957 CompileUnit *Unit = CI->second;
2958 // Compute size of compile unit header
2959 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2960 sizeof(int16_t) + // DWARF version number
2961 sizeof(int32_t) + // Offset Into Abbrev. Section
2962 sizeof(int8_t); // Pointer Size (in bytes)
2963 SizeAndOffsetDie(Unit->getDie(), Offset, true);
2964 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002965 }
2966
2967 /// EmitDebugInfo - Emit the debug info section.
2968 ///
2969 void EmitDebugInfo() {
2970 // Start debug info section.
2971 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
aslc200b112008-08-16 12:57:46 +00002972
Devang Patel6eae2832009-01-12 23:05:55 +00002973 for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
2974 CE = DW_CUs.end(); CI != CE; ++CI) {
2975 CompileUnit *Unit = CI->second;
2976 DIE *Die = Unit->getDie();
2977 // Emit the compile units header.
2978 EmitLabel("info_begin", Unit->getID());
2979 // Emit size of content not including length itself
2980 unsigned ContentSize = Die->getSize() +
2981 sizeof(int16_t) + // DWARF version number
2982 sizeof(int32_t) + // Offset Into Abbrev. Section
2983 sizeof(int8_t) + // Pointer Size (in bytes)
2984 sizeof(int32_t); // FIXME - extra pad for gdb bug.
2985
2986 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2987 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2988 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2989 Asm->EOL("Offset Into Abbrev. Section");
2990 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2991
2992 EmitDIE(Die);
2993 // FIXME - extra padding for gdb bug.
2994 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2995 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2996 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2997 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2998 EmitLabel("info_end", Unit->getID());
2999
3000 Asm->EOL();
3001 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003002 }
3003
3004 /// EmitAbbreviations - Emit the abbreviation section.
3005 ///
3006 void EmitAbbreviations() const {
3007 // Check to see if it is worth the effort.
3008 if (!Abbreviations.empty()) {
3009 // Start the debug abbrev section.
3010 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
aslc200b112008-08-16 12:57:46 +00003011
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003012 EmitLabel("abbrev_begin", 0);
aslc200b112008-08-16 12:57:46 +00003013
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003014 // For each abbrevation.
3015 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
3016 // Get abbreviation data
3017 const DIEAbbrev *Abbrev = Abbreviations[i];
aslc200b112008-08-16 12:57:46 +00003018
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003019 // Emit the abbrevations code (base 1 index.)
3020 Asm->EmitULEB128Bytes(Abbrev->getNumber());
3021 Asm->EOL("Abbreviation Code");
aslc200b112008-08-16 12:57:46 +00003022
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003023 // Emit the abbreviations data.
3024 Abbrev->Emit(*this);
aslc200b112008-08-16 12:57:46 +00003025
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003026 Asm->EOL();
3027 }
aslc200b112008-08-16 12:57:46 +00003028
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003029 // Mark end of abbreviations.
3030 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
3031
3032 EmitLabel("abbrev_end", 0);
aslc200b112008-08-16 12:57:46 +00003033
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003034 Asm->EOL();
3035 }
3036 }
3037
Bill Wendling1983a2a2008-07-20 00:11:19 +00003038 /// EmitEndOfLineMatrix - Emit the last address of the section and the end of
3039 /// the line matrix.
aslc200b112008-08-16 12:57:46 +00003040 ///
Bill Wendling1983a2a2008-07-20 00:11:19 +00003041 void EmitEndOfLineMatrix(unsigned SectionEnd) {
3042 // Define last address of section.
3043 Asm->EmitInt8(0); Asm->EOL("Extended Op");
3044 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
3045 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
3046 EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
3047
3048 // Mark end of matrix.
3049 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
3050 Asm->EmitULEB128Bytes(1); Asm->EOL();
3051 Asm->EmitInt8(1); Asm->EOL();
3052 }
3053
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003054 /// EmitDebugLines - Emit source line information.
3055 ///
3056 void EmitDebugLines() {
Bill Wendling1983a2a2008-07-20 00:11:19 +00003057 // If the target is using .loc/.file, the assembler will be emitting the
3058 // .debug_line table automatically.
3059 if (TAI->hasDotLocAndDotFile())
Dan Gohmanc55b34a2007-09-24 21:43:52 +00003060 return;
3061
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003062 // Minimum line delta, thus ranging from -10..(255-10).
3063 const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
3064 // Maximum line delta, thus ranging from -10..(255-10).
3065 const int MaxLineDelta = 255 + MinLineDelta;
3066
3067 // Start the dwarf line section.
3068 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
aslc200b112008-08-16 12:57:46 +00003069
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003070 // Construct the section header.
aslc200b112008-08-16 12:57:46 +00003071
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003072 EmitDifference("line_end", 0, "line_begin", 0, true);
3073 Asm->EOL("Length of Source Line Info");
3074 EmitLabel("line_begin", 0);
aslc200b112008-08-16 12:57:46 +00003075
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003076 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
aslc200b112008-08-16 12:57:46 +00003077
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003078 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
3079 Asm->EOL("Prolog Length");
3080 EmitLabel("line_prolog_begin", 0);
aslc200b112008-08-16 12:57:46 +00003081
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003082 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
3083
3084 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
3085
3086 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
aslc200b112008-08-16 12:57:46 +00003087
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003088 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
3089
3090 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
aslc200b112008-08-16 12:57:46 +00003091
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003092 // Line number standard opcode encodings argument count
3093 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
3094 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
3095 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
3096 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
3097 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
3098 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
3099 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
3100 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
3101 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
3102
3103 const UniqueVector<std::string> &Directories = MMI->getDirectories();
Evan Cheng0eeed442008-07-01 23:18:29 +00003104 const UniqueVector<SourceFileInfo> &SourceFiles = MMI->getSourceFiles();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003105
3106 // Emit directories.
3107 for (unsigned DirectoryID = 1, NDID = Directories.size();
3108 DirectoryID <= NDID; ++DirectoryID) {
3109 Asm->EmitString(Directories[DirectoryID]); Asm->EOL("Directory");
3110 }
3111 Asm->EmitInt8(0); Asm->EOL("End of directories");
aslc200b112008-08-16 12:57:46 +00003112
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003113 // Emit files.
3114 for (unsigned SourceID = 1, NSID = SourceFiles.size();
3115 SourceID <= NSID; ++SourceID) {
3116 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
3117 Asm->EmitString(SourceFile.getName());
3118 Asm->EOL("Source");
3119 Asm->EmitULEB128Bytes(SourceFile.getDirectoryID());
3120 Asm->EOL("Directory #");
3121 Asm->EmitULEB128Bytes(0);
3122 Asm->EOL("Mod date");
3123 Asm->EmitULEB128Bytes(0);
3124 Asm->EOL("File size");
3125 }
3126 Asm->EmitInt8(0); Asm->EOL("End of files");
aslc200b112008-08-16 12:57:46 +00003127
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003128 EmitLabel("line_prolog_end", 0);
aslc200b112008-08-16 12:57:46 +00003129
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003130 // A sequence for each text section.
Bill Wendling1983a2a2008-07-20 00:11:19 +00003131 unsigned SecSrcLinesSize = SectionSourceLines.size();
3132
3133 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003134 // Isolate current sections line info.
Devang Patel35a078f2009-01-12 22:54:42 +00003135 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
Evan Cheng0eeed442008-07-01 23:18:29 +00003136
Anton Korobeynikov55b94962008-09-24 22:15:21 +00003137 if (VerboseAsm) {
3138 const Section* S = SectionMap[j + 1];
3139 Asm->EOL(std::string("Section ") + S->getName());
3140 } else
Evan Cheng0eeed442008-07-01 23:18:29 +00003141 Asm->EOL();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003142
3143 // Dwarf assumes we start with first line of first source file.
3144 unsigned Source = 1;
3145 unsigned Line = 1;
aslc200b112008-08-16 12:57:46 +00003146
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003147 // Construct rows of the address, source, line, column matrix.
3148 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
Devang Patel35a078f2009-01-12 22:54:42 +00003149 const SrcLineInfo &LineInfo = LineInfos[i];
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003150 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
3151 if (!LabelID) continue;
aslc200b112008-08-16 12:57:46 +00003152
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003153 unsigned SourceID = LineInfo.getSourceID();
3154 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
3155 unsigned DirectoryID = SourceFile.getDirectoryID();
Evan Cheng0eeed442008-07-01 23:18:29 +00003156 if (VerboseAsm)
3157 Asm->EOL(Directories[DirectoryID]
3158 + SourceFile.getName()
3159 + ":"
3160 + utostr_32(LineInfo.getLine()));
3161 else
3162 Asm->EOL();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003163
3164 // Define the line address.
3165 Asm->EmitInt8(0); Asm->EOL("Extended Op");
Dan Gohmancfb72b22007-09-27 23:12:31 +00003166 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003167 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
3168 EmitReference("label", LabelID); Asm->EOL("Location label");
aslc200b112008-08-16 12:57:46 +00003169
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003170 // If change of source, then switch to the new source.
3171 if (Source != LineInfo.getSourceID()) {
3172 Source = LineInfo.getSourceID();
3173 Asm->EmitInt8(DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
3174 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
3175 }
aslc200b112008-08-16 12:57:46 +00003176
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003177 // If change of line.
3178 if (Line != LineInfo.getLine()) {
3179 // Determine offset.
3180 int Offset = LineInfo.getLine() - Line;
3181 int Delta = Offset - MinLineDelta;
aslc200b112008-08-16 12:57:46 +00003182
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003183 // Update line.
3184 Line = LineInfo.getLine();
aslc200b112008-08-16 12:57:46 +00003185
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003186 // If delta is small enough and in range...
3187 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
3188 // ... then use fast opcode.
3189 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
3190 } else {
3191 // ... otherwise use long hand.
3192 Asm->EmitInt8(DW_LNS_advance_line); Asm->EOL("DW_LNS_advance_line");
3193 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
3194 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
3195 }
3196 } else {
3197 // Copy the previous row (different address or source)
3198 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
3199 }
3200 }
3201
Bill Wendling1983a2a2008-07-20 00:11:19 +00003202 EmitEndOfLineMatrix(j + 1);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003203 }
Bill Wendling1983a2a2008-07-20 00:11:19 +00003204
3205 if (SecSrcLinesSize == 0)
3206 // Because we're emitting a debug_line section, we still need a line
3207 // table. The linker and friends expect it to exist. If there's nothing to
3208 // put into it, emit an empty table.
3209 EmitEndOfLineMatrix(1);
aslc200b112008-08-16 12:57:46 +00003210
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003211 EmitLabel("line_end", 0);
aslc200b112008-08-16 12:57:46 +00003212
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003213 Asm->EOL();
3214 }
aslc200b112008-08-16 12:57:46 +00003215
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003216 /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
3217 ///
3218 void EmitCommonDebugFrame() {
3219 if (!TAI->doesDwarfRequireFrameSection())
3220 return;
3221
3222 int stackGrowth =
3223 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3224 TargetFrameInfo::StackGrowsUp ?
Dan Gohmancfb72b22007-09-27 23:12:31 +00003225 TD->getPointerSize() : -TD->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003226
3227 // Start the dwarf frame section.
3228 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
3229
3230 EmitLabel("debug_frame_common", 0);
3231 EmitDifference("debug_frame_common_end", 0,
3232 "debug_frame_common_begin", 0, true);
3233 Asm->EOL("Length of Common Information Entry");
3234
3235 EmitLabel("debug_frame_common_begin", 0);
3236 Asm->EmitInt32((int)DW_CIE_ID);
3237 Asm->EOL("CIE Identifier Tag");
3238 Asm->EmitInt8(DW_CIE_VERSION);
3239 Asm->EOL("CIE Version");
3240 Asm->EmitString("");
3241 Asm->EOL("CIE Augmentation");
3242 Asm->EmitULEB128Bytes(1);
3243 Asm->EOL("CIE Code Alignment Factor");
3244 Asm->EmitSLEB128Bytes(stackGrowth);
aslc200b112008-08-16 12:57:46 +00003245 Asm->EOL("CIE Data Alignment Factor");
Dale Johannesenf5a11532007-11-13 19:13:01 +00003246 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003247 Asm->EOL("CIE RA Column");
aslc200b112008-08-16 12:57:46 +00003248
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003249 std::vector<MachineMove> Moves;
3250 RI->getInitialFrameState(Moves);
3251
Dale Johannesenf5a11532007-11-13 19:13:01 +00003252 EmitFrameMoves(NULL, 0, Moves, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003253
Evan Cheng7e7d1942008-02-29 19:36:59 +00003254 Asm->EmitAlignment(2, 0, 0, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003255 EmitLabel("debug_frame_common_end", 0);
aslc200b112008-08-16 12:57:46 +00003256
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003257 Asm->EOL();
3258 }
3259
3260 /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
3261 /// section.
3262 void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
3263 if (!TAI->doesDwarfRequireFrameSection())
3264 return;
aslc200b112008-08-16 12:57:46 +00003265
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003266 // Start the dwarf frame section.
3267 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
aslc200b112008-08-16 12:57:46 +00003268
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003269 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
3270 "debug_frame_begin", DebugFrameInfo.Number, true);
3271 Asm->EOL("Length of Frame Information Entry");
aslc200b112008-08-16 12:57:46 +00003272
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003273 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
3274
3275 EmitSectionOffset("debug_frame_common", "section_debug_frame",
3276 0, 0, true, false);
3277 Asm->EOL("FDE CIE offset");
3278
3279 EmitReference("func_begin", DebugFrameInfo.Number);
3280 Asm->EOL("FDE initial location");
3281 EmitDifference("func_end", DebugFrameInfo.Number,
3282 "func_begin", DebugFrameInfo.Number);
3283 Asm->EOL("FDE address range");
aslc200b112008-08-16 12:57:46 +00003284
Dale Johannesenf5a11532007-11-13 19:13:01 +00003285 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves, false);
aslc200b112008-08-16 12:57:46 +00003286
Evan Cheng7e7d1942008-02-29 19:36:59 +00003287 Asm->EmitAlignment(2, 0, 0, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003288 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
3289
3290 Asm->EOL();
3291 }
3292
3293 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
3294 ///
3295 void EmitDebugPubNames() {
3296 // Start the dwarf pubnames section.
3297 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
aslc200b112008-08-16 12:57:46 +00003298
Devang Patel6eae2832009-01-12 23:05:55 +00003299 for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
3300 CE = DW_CUs.end(); CI != CE; ++CI) {
3301 CompileUnit *Unit = CI->second;
aslc200b112008-08-16 12:57:46 +00003302
Devang Patel6eae2832009-01-12 23:05:55 +00003303 EmitDifference("pubnames_end", Unit->getID(),
3304 "pubnames_begin", Unit->getID(), true);
3305 Asm->EOL("Length of Public Names Info");
3306
3307 EmitLabel("pubnames_begin", Unit->getID());
3308
3309 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF Version");
3310
3311 EmitSectionOffset("info_begin", "section_info",
3312 Unit->getID(), 0, true, false);
3313 Asm->EOL("Offset of Compilation Unit Info");
3314
3315 EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(),true);
3316 Asm->EOL("Compilation Unit Length");
3317
3318 std::map<std::string, DIE *> &Globals = Unit->getGlobals();
3319
3320 for (std::map<std::string, DIE *>::iterator GI = Globals.begin(),
3321 GE = Globals.end();
3322 GI != GE; ++GI) {
3323 const std::string &Name = GI->first;
3324 DIE * Entity = GI->second;
3325
3326 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
3327 Asm->EmitString(Name); Asm->EOL("External Name");
3328 }
3329
3330 Asm->EmitInt32(0); Asm->EOL("End Mark");
3331 EmitLabel("pubnames_end", Unit->getID());
3332
3333 Asm->EOL();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003334 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003335 }
3336
3337 /// EmitDebugStr - Emit visible names into a debug str section.
3338 ///
3339 void EmitDebugStr() {
3340 // Check to see if it is worth the effort.
3341 if (!StringPool.empty()) {
3342 // Start the dwarf str section.
3343 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
aslc200b112008-08-16 12:57:46 +00003344
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003345 // For each of strings in the string pool.
3346 for (unsigned StringID = 1, N = StringPool.size();
3347 StringID <= N; ++StringID) {
3348 // Emit a label for reference from debug information entries.
3349 EmitLabel("string", StringID);
3350 // Emit the string itself.
3351 const std::string &String = StringPool[StringID];
3352 Asm->EmitString(String); Asm->EOL();
3353 }
aslc200b112008-08-16 12:57:46 +00003354
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003355 Asm->EOL();
3356 }
3357 }
3358
3359 /// EmitDebugLoc - Emit visible names into a debug loc section.
3360 ///
3361 void EmitDebugLoc() {
3362 // Start the dwarf loc section.
3363 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
aslc200b112008-08-16 12:57:46 +00003364
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003365 Asm->EOL();
3366 }
3367
3368 /// EmitDebugARanges - Emit visible names into a debug aranges section.
3369 ///
3370 void EmitDebugARanges() {
3371 // Start the dwarf aranges section.
3372 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
aslc200b112008-08-16 12:57:46 +00003373
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003374 // FIXME - Mock up
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00003375#if 0
aslc200b112008-08-16 12:57:46 +00003376 CompileUnit *Unit = GetBaseCompileUnit();
3377
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003378 // Don't include size of length
3379 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
aslc200b112008-08-16 12:57:46 +00003380
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003381 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("Dwarf Version");
aslc200b112008-08-16 12:57:46 +00003382
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003383 EmitReference("info_begin", Unit->getID());
3384 Asm->EOL("Offset of Compilation Unit Info");
3385
Dan Gohmancfb72b22007-09-27 23:12:31 +00003386 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003387
3388 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
3389
3390 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
3391 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
3392
3393 // Range 1
3394 EmitReference("text_begin", 0); Asm->EOL("Address");
3395 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
3396
3397 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
3398 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00003399#endif
aslc200b112008-08-16 12:57:46 +00003400
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003401 Asm->EOL();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003402 }
3403
3404 /// EmitDebugRanges - Emit visible names into a debug ranges section.
3405 ///
3406 void EmitDebugRanges() {
3407 // Start the dwarf ranges section.
3408 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
aslc200b112008-08-16 12:57:46 +00003409
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003410 Asm->EOL();
3411 }
3412
3413 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
3414 ///
3415 void EmitDebugMacInfo() {
3416 // Start the dwarf macinfo section.
3417 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
aslc200b112008-08-16 12:57:46 +00003418
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003419 Asm->EOL();
3420 }
3421
Devang Patel289f2362009-01-05 23:11:11 +00003422 /// ConstructCompileUnits - Create a compile unit DIEs.
Devang Patelb3907da2009-01-05 23:03:32 +00003423 void ConstructCompileUnits() {
3424 std::string CUName = "llvm.dbg.compile_units";
3425 std::vector<GlobalVariable*> Result;
3426 getGlobalVariablesUsing(*M, CUName, Result);
3427 for (std::vector<GlobalVariable *>::iterator RI = Result.begin(),
3428 RE = Result.end(); RI != RE; ++RI) {
3429 DICompileUnit *DIUnit = new DICompileUnit(*RI);
Devang Patel7dd15a92009-01-08 17:19:22 +00003430 unsigned ID = RecordSource(DIUnit->getDirectory(),
3431 DIUnit->getFilename());
Devang Patelb3907da2009-01-05 23:03:32 +00003432
3433 DIE *Die = new DIE(DW_TAG_compile_unit);
3434 AddSectionOffset(Die, DW_AT_stmt_list, DW_FORM_data4,
3435 DWLabel("section_line", 0), DWLabel("section_line", 0),
3436 false);
3437 AddString(Die, DW_AT_producer, DW_FORM_string, DIUnit->getProducer());
3438 AddUInt(Die, DW_AT_language, DW_FORM_data1, DIUnit->getLanguage());
3439 AddString(Die, DW_AT_name, DW_FORM_string, DIUnit->getFilename());
3440 if (!DIUnit->getDirectory().empty())
3441 AddString(Die, DW_AT_comp_dir, DW_FORM_string, DIUnit->getDirectory());
3442
3443 CompileUnit *Unit = new CompileUnit(ID, Die);
3444 DW_CUs[DIUnit->getGV()] = Unit;
3445 }
3446 }
3447
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003448 /// ConstructCompileUnitDIEs - Create a compile unit DIE for each source and
3449 /// header file.
3450 void ConstructCompileUnitDIEs() {
3451 const UniqueVector<CompileUnitDesc *> CUW = MMI->getCompileUnits();
aslc200b112008-08-16 12:57:46 +00003452
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003453 for (unsigned i = 1, N = CUW.size(); i <= N; ++i) {
3454 unsigned ID = MMI->RecordSource(CUW[i]);
3455 CompileUnit *Unit = NewCompileUnit(CUW[i], ID);
3456 CompileUnits.push_back(Unit);
3457 }
3458 }
3459
Devang Patel289f2362009-01-05 23:11:11 +00003460 /// ConstructGlobalVariableDIEs - Create DIEs for each of the externally
3461 /// visible global variables.
3462 void ConstructGlobalVariableDIEs() {
3463 std::string GVName = "llvm.dbg.global_variables";
3464 std::vector<GlobalVariable*> Result;
3465 getGlobalVariablesUsing(*M, GVName, Result);
3466 for (std::vector<GlobalVariable *>::iterator GVI = Result.begin(),
3467 GVE = Result.end(); GVI != GVE; ++GVI) {
3468 DIGlobalVariable *DI_GV = new DIGlobalVariable(*GVI);
3469 CompileUnit *DW_Unit = FindCompileUnit(DI_GV->getCompileUnit());
3470
3471 // Check for pre-existence.
3472 DIE *&Slot = DW_Unit->getDieMapSlotFor(DI_GV->getGV());
3473 if (Slot) continue;
3474
3475 DIE *VariableDie = new DIE(DW_TAG_variable);
3476 AddString(VariableDie, DW_AT_name, DW_FORM_string, DI_GV->getName());
3477 const std::string &LinkageName = DI_GV->getLinkageName();
3478 if (!LinkageName.empty())
3479 AddString(VariableDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
3480 LinkageName);
3481 AddType(DW_Unit, VariableDie, DI_GV->getType());
3482
3483 if (!DI_GV->isLocalToUnit())
3484 AddUInt(VariableDie, DW_AT_external, DW_FORM_flag, 1);
3485
3486 // Add source line info, if available.
3487 AddSourceLine(VariableDie, DI_GV);
3488
3489 // Add address.
3490 DIEBlock *Block = new DIEBlock();
3491 AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
3492 AddObjectLabel(Block, 0, DW_FORM_udata,
3493 Asm->getGlobalLinkName(DI_GV->getGV()));
3494 AddBlock(VariableDie, DW_AT_location, 0, Block);
3495
3496 //Add to map.
3497 Slot = VariableDie;
3498
3499 //Add to context owner.
3500 DW_Unit->getDie()->AddChild(VariableDie);
3501
3502 //Expose as global. FIXME - need to check external flag.
3503 DW_Unit->AddGlobal(DI_GV->getName(), VariableDie);
3504 }
3505 }
3506
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003507 /// ConstructGlobalDIEs - Create DIEs for each of the externally visible
3508 /// global variables.
3509 void ConstructGlobalDIEs() {
Bill Wendling75091f92008-07-03 23:13:02 +00003510 std::vector<GlobalVariableDesc *> GlobalVariables;
3511 MMI->getAnchoredDescriptors<GlobalVariableDesc>(*M, GlobalVariables);
aslc200b112008-08-16 12:57:46 +00003512
Bill Wendling4de8de52008-07-03 22:53:42 +00003513 for (unsigned i = 0, N = GlobalVariables.size(); i < N; ++i) {
3514 GlobalVariableDesc *GVD = GlobalVariables[i];
3515 NewGlobalVariable(GVD);
3516 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003517 }
3518
Devang Patele6caf012009-01-05 23:21:35 +00003519 /// ConstructSubprograms - Create DIEs for each of the externally visible
3520 /// subprograms.
3521 void ConstructSubprograms() {
3522
3523 std::string SPName = "llvm.dbg.subprograms";
3524 std::vector<GlobalVariable*> Result;
3525 getGlobalVariablesUsing(*M, SPName, Result);
3526 for (std::vector<GlobalVariable *>::iterator RI = Result.begin(),
3527 RE = Result.end(); RI != RE; ++RI) {
3528
3529 DISubprogram *SP = new DISubprogram(*RI);
3530 CompileUnit *Unit = FindCompileUnit(SP->getCompileUnit());
3531
3532 // Check for pre-existence.
3533 DIE *&Slot = Unit->getDieMapSlotFor(SP->getGV());
3534 if (Slot) continue;
3535
3536 DIE *SubprogramDie = new DIE(DW_TAG_subprogram);
3537 AddString(SubprogramDie, DW_AT_name, DW_FORM_string, SP->getName());
3538 const std::string &LinkageName = SP->getLinkageName();
3539 if (!LinkageName.empty())
3540 AddString(SubprogramDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
3541 LinkageName);
3542 DIType SPTy = SP->getType();
3543 AddType(Unit, SubprogramDie, SPTy);
3544 if (!SP->isLocalToUnit())
3545 AddUInt(SubprogramDie, DW_AT_external, DW_FORM_flag, 1);
3546 AddUInt(SubprogramDie, DW_AT_prototyped, DW_FORM_flag, 1);
3547
3548 AddSourceLine(SubprogramDie, SP);
3549 //Add to map.
3550 Slot = SubprogramDie;
3551 //Add to context owner.
3552 Unit->getDie()->AddChild(SubprogramDie);
3553 //Expose as global.
3554 Unit->AddGlobal(SP->getName(), SubprogramDie);
3555 }
3556 }
3557
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003558 /// ConstructSubprogramDIEs - Create DIEs for each of the externally visible
3559 /// subprograms.
3560 void ConstructSubprogramDIEs() {
Bill Wendling75091f92008-07-03 23:13:02 +00003561 std::vector<SubprogramDesc *> Subprograms;
3562 MMI->getAnchoredDescriptors<SubprogramDesc>(*M, Subprograms);
aslc200b112008-08-16 12:57:46 +00003563
Bill Wendling4de8de52008-07-03 22:53:42 +00003564 for (unsigned i = 0, N = Subprograms.size(); i < N; ++i) {
3565 SubprogramDesc *SPD = Subprograms[i];
3566 NewSubprogram(SPD);
3567 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003568 }
3569
3570public:
3571 //===--------------------------------------------------------------------===//
3572 // Main entry points.
3573 //
Owen Anderson847b99b2008-08-21 00:14:44 +00003574 DwarfDebug(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
Chris Lattnerb3876c72007-09-24 03:35:37 +00003575 : Dwarf(OS, A, T, "dbg")
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003576 , CompileUnits()
3577 , AbbreviationsSet(InitAbbreviationsSetSize)
3578 , Abbreviations()
3579 , ValuesSet(InitValuesSetSize)
3580 , Values()
3581 , StringPool()
3582 , DescToUnitMap()
3583 , SectionMap()
3584 , SectionSourceLines()
3585 , didInitial(false)
3586 , shouldEmit(false)
Devang Patel4d1709e2009-01-08 02:33:41 +00003587 , RootDbgScope(NULL)
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003588 {
3589 }
3590 virtual ~DwarfDebug() {
3591 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i)
3592 delete CompileUnits[i];
3593 for (unsigned j = 0, M = Values.size(); j < M; ++j)
3594 delete Values[j];
3595 }
3596
Devang Patel9304b382009-01-06 21:07:30 +00003597 /// SetDebugInfo - Create global DIEs and emit initial debug info sections.
3598 /// This is inovked by the target AsmPrinter.
3599 void SetDebugInfo() {
3600 // FIXME - Check if the module has debug info or not.
3601 // Create all the compile unit DIEs.
3602 ConstructCompileUnits();
3603
3604 // Create DIEs for each of the externally visible global variables.
3605 ConstructGlobalVariableDIEs();
3606
3607 // Create DIEs for each of the externally visible subprograms.
3608 ConstructSubprograms();
3609
3610 // Prime section data.
3611 SectionMap.insert(TAI->getTextSection());
3612
3613 // Print out .file directives to specify files for .loc directives. These
3614 // are printed out early so that they precede any .loc directives.
3615 if (TAI->hasDotLocAndDotFile()) {
3616 for (unsigned i = 1, e = SrcFiles.size(); i <= e; ++i) {
3617 sys::Path FullPath(Directories[SrcFiles[i].getDirectoryID()]);
3618 bool AppendOk = FullPath.appendComponent(SrcFiles[i].getName());
3619 assert(AppendOk && "Could not append filename to directory!");
3620 AppendOk = false;
3621 Asm->EmitFile(i, FullPath.toString());
3622 Asm->EOL();
3623 }
3624 }
3625
3626 // Emit initial sections
3627 EmitInitial();
3628 }
3629
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003630 /// SetModuleInfo - Set machine module information when it's known that pass
3631 /// manager has created it. Set by the target AsmPrinter.
3632 void SetModuleInfo(MachineModuleInfo *mmi) {
3633 // Make sure initial declarations are made.
3634 if (!MMI && mmi->hasDebugInfo()) {
3635 MMI = mmi;
3636 shouldEmit = true;
aslc200b112008-08-16 12:57:46 +00003637
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003638 // Create all the compile unit DIEs.
3639 ConstructCompileUnitDIEs();
aslc200b112008-08-16 12:57:46 +00003640
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003641 // Create DIEs for each of the externally visible global variables.
3642 ConstructGlobalDIEs();
3643
3644 // Create DIEs for each of the externally visible subprograms.
3645 ConstructSubprogramDIEs();
aslc200b112008-08-16 12:57:46 +00003646
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003647 // Prime section data.
3648 SectionMap.insert(TAI->getTextSection());
Dan Gohman6d6c2402007-10-01 22:40:20 +00003649
3650 // Print out .file directives to specify files for .loc directives. These
3651 // are printed out early so that they precede any .loc directives.
3652 if (TAI->hasDotLocAndDotFile()) {
3653 const UniqueVector<SourceFileInfo> &SourceFiles = MMI->getSourceFiles();
3654 const UniqueVector<std::string> &Directories = MMI->getDirectories();
3655 for (unsigned i = 1, e = SourceFiles.size(); i <= e; ++i) {
3656 sys::Path FullPath(Directories[SourceFiles[i].getDirectoryID()]);
3657 bool AppendOk = FullPath.appendComponent(SourceFiles[i].getName());
3658 assert(AppendOk && "Could not append filename to directory!");
Devang Patel105a08a2008-12-23 21:55:38 +00003659 AppendOk = false;
Dan Gohman6d6c2402007-10-01 22:40:20 +00003660 Asm->EmitFile(i, FullPath.toString());
3661 Asm->EOL();
3662 }
3663 }
3664
3665 // Emit initial sections
3666 EmitInitial();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003667 }
3668 }
3669
3670 /// BeginModule - Emit all Dwarf sections that should come prior to the
3671 /// content.
3672 void BeginModule(Module *M) {
3673 this->M = M;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003674 }
3675
3676 /// EndModule - Emit all Dwarf sections that should come after the content.
3677 ///
3678 void EndModule() {
3679 if (!ShouldEmitDwarf()) return;
aslc200b112008-08-16 12:57:46 +00003680
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003681 // Standard sections final addresses.
Anton Korobeynikov55b94962008-09-24 22:15:21 +00003682 Asm->SwitchToSection(TAI->getTextSection());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003683 EmitLabel("text_end", 0);
Anton Korobeynikovcca60fa2008-09-24 22:16:16 +00003684 Asm->SwitchToSection(TAI->getDataSection());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003685 EmitLabel("data_end", 0);
aslc200b112008-08-16 12:57:46 +00003686
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003687 // End text sections.
3688 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Anton Korobeynikov55b94962008-09-24 22:15:21 +00003689 Asm->SwitchToSection(SectionMap[i]);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003690 EmitLabel("section_end", i);
3691 }
3692
3693 // Emit common frame information.
3694 EmitCommonDebugFrame();
3695
3696 // Emit function debug frame information
3697 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
3698 E = DebugFrames.end(); I != E; ++I)
3699 EmitFunctionDebugFrame(*I);
3700
3701 // Compute DIE offsets and sizes.
3702 SizeAndOffsets();
aslc200b112008-08-16 12:57:46 +00003703
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003704 // Emit all the DIEs into a debug info section
3705 EmitDebugInfo();
aslc200b112008-08-16 12:57:46 +00003706
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003707 // Corresponding abbreviations into a abbrev section.
3708 EmitAbbreviations();
aslc200b112008-08-16 12:57:46 +00003709
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003710 // Emit source line correspondence into a debug line section.
3711 EmitDebugLines();
aslc200b112008-08-16 12:57:46 +00003712
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003713 // Emit info into a debug pubnames section.
3714 EmitDebugPubNames();
aslc200b112008-08-16 12:57:46 +00003715
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003716 // Emit info into a debug str section.
3717 EmitDebugStr();
aslc200b112008-08-16 12:57:46 +00003718
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003719 // Emit info into a debug loc section.
3720 EmitDebugLoc();
aslc200b112008-08-16 12:57:46 +00003721
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003722 // Emit info into a debug aranges section.
3723 EmitDebugARanges();
aslc200b112008-08-16 12:57:46 +00003724
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003725 // Emit info into a debug ranges section.
3726 EmitDebugRanges();
aslc200b112008-08-16 12:57:46 +00003727
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003728 // Emit info into a debug macinfo section.
3729 EmitDebugMacInfo();
3730 }
3731
aslc200b112008-08-16 12:57:46 +00003732 /// BeginFunction - Gather pre-function debug information. Assumes being
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003733 /// emitted immediately after the function entry point.
3734 void BeginFunction(MachineFunction *MF) {
3735 this->MF = MF;
aslc200b112008-08-16 12:57:46 +00003736
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003737 if (!ShouldEmitDwarf()) return;
3738
3739 // Begin accumulating function debug information.
3740 MMI->BeginFunction(MF);
aslc200b112008-08-16 12:57:46 +00003741
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003742 // Assumes in correct section after the entry point.
3743 EmitLabel("func_begin", ++SubprogramCount);
Evan Chenga53c40a2008-02-01 09:10:45 +00003744
3745 // Emit label for the implicitly defined dbg.stoppoint at the start of
3746 // the function.
Devang Patel35a078f2009-01-12 22:54:42 +00003747 if (!Lines.empty()) {
3748 const SrcLineInfo &LineInfo = Lines[0];
Andrew Lenharth42f91402008-04-03 17:37:43 +00003749 Asm->printLabel(LineInfo.getLabelID());
3750 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003751 }
aslc200b112008-08-16 12:57:46 +00003752
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003753 /// EndFunction - Gather and emit post-function debug information.
3754 ///
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00003755 void EndFunction(MachineFunction *MF) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003756 if (!ShouldEmitDwarf()) return;
aslc200b112008-08-16 12:57:46 +00003757
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003758 // Define end label for subprogram.
3759 EmitLabel("func_end", SubprogramCount);
aslc200b112008-08-16 12:57:46 +00003760
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003761 // Get function line info.
Devang Patel35a078f2009-01-12 22:54:42 +00003762 if (!Lines.empty()) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003763 // Get section line info.
Anton Korobeynikov55b94962008-09-24 22:15:21 +00003764 unsigned ID = SectionMap.insert(Asm->CurrentSection_);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003765 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
Devang Patel35a078f2009-01-12 22:54:42 +00003766 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003767 // Append the function info to section info.
3768 SectionLineInfos.insert(SectionLineInfos.end(),
Devang Patel35a078f2009-01-12 22:54:42 +00003769 Lines.begin(), Lines.end());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003770 }
aslc200b112008-08-16 12:57:46 +00003771
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003772 // Construct scopes for subprogram.
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00003773 if (MMI->getRootScope())
3774 ConstructRootScope(MMI->getRootScope());
3775 else
3776 // FIXME: This is wrong. We are essentially getting past a problem with
3777 // debug information not being able to handle unreachable blocks that have
3778 // debug information in them. In particular, those unreachable blocks that
3779 // have "region end" info in them. That situation results in the "root
3780 // scope" not being created. If that's the case, then emit a "default"
3781 // scope, i.e., one that encompasses the whole function. This isn't
3782 // desirable. And a better way of handling this (and all of the debugging
3783 // information) needs to be explored.
3784 ConstructDefaultScope(MF);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003785
3786 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
3787 MMI->getFrameMoves()));
Devang Patela4162952009-01-12 18:48:36 +00003788
3789 // Clear debug info
3790 if (RootDbgScope) {
3791 delete RootDbgScope;
3792 DbgScopeMap.clear();
3793 RootDbgScope = NULL;
3794 }
3795 Lines.clear();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003796 }
Devang Patelcb59fd42009-01-12 19:17:34 +00003797
3798public:
3799
3800 /// RecordSourceLine - Records location information and associates it with a
3801 /// label. Returns a unique label ID used to generate a label and provide
3802 /// correspondence to the source line list.
3803 unsigned RecordSourceLine(Value *V, unsigned Line, unsigned Col) {
3804 CompileUnit *Unit = DW_CUs[V];
3805 assert (Unit && "Unable to find CompileUnit");
3806 unsigned ID = MMI->NextLabelID();
3807 Lines.push_back(SrcLineInfo(Line, Col, Unit->getID(), ID));
3808 return ID;
3809 }
3810
3811 /// RecordSourceLine - Records location information and associates it with a
3812 /// label. Returns a unique label ID used to generate a label and provide
3813 /// correspondence to the source line list.
3814 unsigned RecordSourceLine(unsigned Line, unsigned Col, unsigned Src) {
3815 unsigned ID = MMI->NextLabelID();
3816 Lines.push_back(SrcLineInfo(Line, Col, Src, ID));
3817 return ID;
3818 }
3819
3820 unsigned getRecordSourceLineCount() {
3821 return Lines.size();
3822 }
3823
3824 /// RecordSource - Register a source file with debug info. Returns an source
3825 /// ID.
3826 unsigned RecordSource(const std::string &Directory,
3827 const std::string &File) {
3828 unsigned DID = Directories.insert(Directory);
3829 return SrcFiles.insert(SrcFileInfo(DID,File));
3830 }
3831
3832 /// RecordRegionStart - Indicate the start of a region.
3833 ///
3834 unsigned RecordRegionStart(GlobalVariable *V) {
3835 DbgScope *Scope = getOrCreateScope(V);
3836 unsigned ID = MMI->NextLabelID();
3837 if (!Scope->getStartLabelID()) Scope->setStartLabelID(ID);
3838 return ID;
3839 }
3840
3841 /// RecordRegionEnd - Indicate the end of a region.
3842 ///
3843 unsigned RecordRegionEnd(GlobalVariable *V) {
3844 DbgScope *Scope = getOrCreateScope(V);
3845 unsigned ID = MMI->NextLabelID();
3846 Scope->setEndLabelID(ID);
3847 return ID;
3848 }
3849
3850 /// RecordVariable - Indicate the declaration of a local variable.
3851 ///
3852 void RecordVariable(GlobalVariable *GV, unsigned FrameIndex) {
3853 DbgScope *Scope = getOrCreateScope(GV);
3854 DIVariable *VD = new DIVariable(GV);
3855 DbgVariable *DV = new DbgVariable(VD, FrameIndex);
3856 Scope->AddVariable(DV);
3857 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003858};
3859
3860//===----------------------------------------------------------------------===//
aslc200b112008-08-16 12:57:46 +00003861/// DwarfException - Emits Dwarf exception handling directives.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003862///
3863class DwarfException : public Dwarf {
3864
3865private:
3866 struct FunctionEHFrameInfo {
3867 std::string FnName;
3868 unsigned Number;
3869 unsigned PersonalityIndex;
3870 bool hasCalls;
3871 bool hasLandingPads;
3872 std::vector<MachineMove> Moves;
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003873 const Function * function;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003874
3875 FunctionEHFrameInfo(const std::string &FN, unsigned Num, unsigned P,
3876 bool hC, bool hL,
Dale Johannesenfb3ac732007-11-20 23:24:42 +00003877 const std::vector<MachineMove> &M,
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003878 const Function *f):
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003879 FnName(FN), Number(Num), PersonalityIndex(P),
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003880 hasCalls(hC), hasLandingPads(hL), Moves(M), function (f) { }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003881 };
3882
3883 std::vector<FunctionEHFrameInfo> EHFrames;
Dale Johannesen85535762008-04-02 00:25:04 +00003884
3885 /// shouldEmitTable - Per-function flag to indicate if EH tables should
3886 /// be emitted.
3887 bool shouldEmitTable;
3888
3889 /// shouldEmitMoves - Per-function flag to indicate if frame moves info
3890 /// should be emitted.
3891 bool shouldEmitMoves;
3892
3893 /// shouldEmitTableModule - Per-module flag to indicate if EH tables
3894 /// should be emitted.
3895 bool shouldEmitTableModule;
3896
aslc200b112008-08-16 12:57:46 +00003897 /// shouldEmitFrameModule - Per-module flag to indicate if frame moves
Dale Johannesen85535762008-04-02 00:25:04 +00003898 /// should be emitted.
3899 bool shouldEmitMovesModule;
Duncan Sands96144f92008-05-07 19:11:09 +00003900
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003901 /// EmitCommonEHFrame - Emit the common eh unwind frame.
3902 ///
3903 void EmitCommonEHFrame(const Function *Personality, unsigned Index) {
3904 // Size and sign of stack growth.
3905 int stackGrowth =
3906 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3907 TargetFrameInfo::StackGrowsUp ?
Dan Gohmancfb72b22007-09-27 23:12:31 +00003908 TD->getPointerSize() : -TD->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003909
3910 // Begin eh frame section.
3911 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
Bill Wendling189bde72008-12-24 08:05:17 +00003912
3913 if (!TAI->doesRequireNonLocalEHFrameLabel())
3914 O << TAI->getEHGlobalPrefix();
3915 O << "EH_frame" << Index << ":\n";
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003916 EmitLabel("section_eh_frame", Index);
3917
3918 // Define base labels.
3919 EmitLabel("eh_frame_common", Index);
Duncan Sands96144f92008-05-07 19:11:09 +00003920
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003921 // Define the eh frame length.
3922 EmitDifference("eh_frame_common_end", Index,
3923 "eh_frame_common_begin", Index, true);
3924 Asm->EOL("Length of Common Information Entry");
3925
3926 // EH frame header.
3927 EmitLabel("eh_frame_common_begin", Index);
3928 Asm->EmitInt32((int)0);
3929 Asm->EOL("CIE Identifier Tag");
3930 Asm->EmitInt8(DW_CIE_VERSION);
3931 Asm->EOL("CIE Version");
Duncan Sands96144f92008-05-07 19:11:09 +00003932
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003933 // The personality presence indicates that language specific information
3934 // will show up in the eh frame.
3935 Asm->EmitString(Personality ? "zPLR" : "zR");
3936 Asm->EOL("CIE Augmentation");
Duncan Sands96144f92008-05-07 19:11:09 +00003937
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003938 // Round out reader.
3939 Asm->EmitULEB128Bytes(1);
3940 Asm->EOL("CIE Code Alignment Factor");
3941 Asm->EmitSLEB128Bytes(stackGrowth);
Duncan Sands96144f92008-05-07 19:11:09 +00003942 Asm->EOL("CIE Data Alignment Factor");
Dale Johannesenf5a11532007-11-13 19:13:01 +00003943 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), true));
Duncan Sands96144f92008-05-07 19:11:09 +00003944 Asm->EOL("CIE Return Address Column");
3945
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003946 // If there is a personality, we need to indicate the functions location.
3947 if (Personality) {
3948 Asm->EmitULEB128Bytes(7);
3949 Asm->EOL("Augmentation Size");
Bill Wendling2d369922007-09-11 17:20:55 +00003950
Duncan Sands96144f92008-05-07 19:11:09 +00003951 if (TAI->getNeedsIndirectEncoding()) {
Bill Wendling2d369922007-09-11 17:20:55 +00003952 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4 | DW_EH_PE_indirect);
Duncan Sands96144f92008-05-07 19:11:09 +00003953 Asm->EOL("Personality (pcrel sdata4 indirect)");
3954 } else {
Bill Wendling2d369922007-09-11 17:20:55 +00003955 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
Duncan Sands96144f92008-05-07 19:11:09 +00003956 Asm->EOL("Personality (pcrel sdata4)");
3957 }
Bill Wendling2d369922007-09-11 17:20:55 +00003958
Duncan Sands96144f92008-05-07 19:11:09 +00003959 PrintRelDirective(true);
Bill Wendlingd1bda4f2007-09-11 08:27:17 +00003960 O << TAI->getPersonalityPrefix();
3961 Asm->EmitExternalGlobal((const GlobalVariable *)(Personality));
3962 O << TAI->getPersonalitySuffix();
Duncan Sands4cc39532008-05-08 12:33:11 +00003963 if (strcmp(TAI->getPersonalitySuffix(), "+4@GOTPCREL"))
3964 O << "-" << TAI->getPCSymbol();
Bill Wendlingd1bda4f2007-09-11 08:27:17 +00003965 Asm->EOL("Personality");
Bill Wendling38cb7c92007-08-25 00:51:55 +00003966
Duncan Sands96144f92008-05-07 19:11:09 +00003967 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3968 Asm->EOL("LSDA Encoding (pcrel sdata4)");
Bill Wendling6bd1b792008-12-24 05:25:49 +00003969
Bill Wendlingedc2dbe2009-01-05 22:53:45 +00003970 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3971 Asm->EOL("FDE Encoding (pcrel sdata4)");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003972 } else {
3973 Asm->EmitULEB128Bytes(1);
3974 Asm->EOL("Augmentation Size");
Bill Wendling6bd1b792008-12-24 05:25:49 +00003975
Bill Wendlingedc2dbe2009-01-05 22:53:45 +00003976 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3977 Asm->EOL("FDE Encoding (pcrel sdata4)");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003978 }
3979
3980 // Indicate locations of general callee saved registers in frame.
3981 std::vector<MachineMove> Moves;
3982 RI->getInitialFrameState(Moves);
Dale Johannesenf5a11532007-11-13 19:13:01 +00003983 EmitFrameMoves(NULL, 0, Moves, true);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003984
Dale Johannesen388f20f2008-04-30 00:43:29 +00003985 // On Darwin the linker honors the alignment of eh_frame, which means it
3986 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3987 // you get holes which confuse readers of eh_frame.
aslc200b112008-08-16 12:57:46 +00003988 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
Dale Johannesen837d7ab2008-04-29 22:58:20 +00003989 0, 0, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003990 EmitLabel("eh_frame_common_end", Index);
Duncan Sands96144f92008-05-07 19:11:09 +00003991
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003992 Asm->EOL();
3993 }
Duncan Sands96144f92008-05-07 19:11:09 +00003994
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003995 /// EmitEHFrame - Emit function exception frame information.
3996 ///
3997 void EmitEHFrame(const FunctionEHFrameInfo &EHFrameInfo) {
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003998 Function::LinkageTypes linkage = EHFrameInfo.function->getLinkage();
3999
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004000 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
4001
4002 // Externally visible entry into the functions eh frame info.
Dale Johannesenfb3ac732007-11-20 23:24:42 +00004003 // If the corresponding function is static, this should not be
4004 // externally visible.
Dale Johannesen3dadeb32008-01-16 19:59:28 +00004005 if (linkage != Function::InternalLinkage) {
Dale Johannesenfb3ac732007-11-20 23:24:42 +00004006 if (const char *GlobalEHDirective = TAI->getGlobalEHDirective())
4007 O << GlobalEHDirective << EHFrameInfo.FnName << "\n";
4008 }
4009
Dale Johannesenf09b5992008-01-10 02:03:30 +00004010 // If corresponding function is weak definition, this should be too.
aslc200b112008-08-16 12:57:46 +00004011 if ((linkage == Function::WeakLinkage ||
Dale Johannesen3dadeb32008-01-16 19:59:28 +00004012 linkage == Function::LinkOnceLinkage) &&
Dale Johannesenf09b5992008-01-10 02:03:30 +00004013 TAI->getWeakDefDirective())
4014 O << TAI->getWeakDefDirective() << EHFrameInfo.FnName << "\n";
4015
4016 // If there are no calls then you can't unwind. This may mean we can
4017 // omit the EH Frame, but some environments do not handle weak absolute
aslc200b112008-08-16 12:57:46 +00004018 // symbols.
Dale Johannesenb369e8d2008-04-14 17:54:17 +00004019 // If UnwindTablesMandatory is set we cannot do this optimization; the
Dale Johannesena9b3e482008-04-08 00:10:24 +00004020 // unwind info is to be available for non-EH uses.
Dale Johannesenf09b5992008-01-10 02:03:30 +00004021 if (!EHFrameInfo.hasCalls &&
Dale Johannesenb369e8d2008-04-14 17:54:17 +00004022 !UnwindTablesMandatory &&
aslc200b112008-08-16 12:57:46 +00004023 ((linkage != Function::WeakLinkage &&
Dale Johannesen3dadeb32008-01-16 19:59:28 +00004024 linkage != Function::LinkOnceLinkage) ||
Dale Johannesenf09b5992008-01-10 02:03:30 +00004025 !TAI->getWeakDefDirective() ||
4026 TAI->getSupportsWeakOmittedEHFrame()))
aslc200b112008-08-16 12:57:46 +00004027 {
Bill Wendlingef9211a2007-09-18 01:47:22 +00004028 O << EHFrameInfo.FnName << " = 0\n";
aslc200b112008-08-16 12:57:46 +00004029 // This name has no connection to the function, so it might get
4030 // dead-stripped when the function is not, erroneously. Prohibit
Dale Johannesen3dadeb32008-01-16 19:59:28 +00004031 // dead-stripping unconditionally.
4032 if (const char *UsedDirective = TAI->getUsedDirective())
4033 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004034 } else {
Bill Wendlingef9211a2007-09-18 01:47:22 +00004035 O << EHFrameInfo.FnName << ":\n";
Dale Johannesenfb3ac732007-11-20 23:24:42 +00004036
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004037 // EH frame header.
4038 EmitDifference("eh_frame_end", EHFrameInfo.Number,
4039 "eh_frame_begin", EHFrameInfo.Number, true);
4040 Asm->EOL("Length of Frame Information Entry");
aslc200b112008-08-16 12:57:46 +00004041
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004042 EmitLabel("eh_frame_begin", EHFrameInfo.Number);
4043
Bill Wendling189bde72008-12-24 08:05:17 +00004044 if (TAI->doesRequireNonLocalEHFrameLabel()) {
4045 PrintRelDirective(true, true);
4046 PrintLabelName("eh_frame_begin", EHFrameInfo.Number);
4047
4048 if (!TAI->isAbsoluteEHSectionOffsets())
4049 O << "-EH_frame" << EHFrameInfo.PersonalityIndex;
4050 } else {
4051 EmitSectionOffset("eh_frame_begin", "eh_frame_common",
4052 EHFrameInfo.Number, EHFrameInfo.PersonalityIndex,
4053 true, true, false);
4054 }
4055
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004056 Asm->EOL("FDE CIE offset");
4057
Bill Wendlingdd9127d2009-01-06 19:13:55 +00004058 EmitReference("eh_func_begin", EHFrameInfo.Number, true, true);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004059 Asm->EOL("FDE initial location");
4060 EmitDifference("eh_func_end", EHFrameInfo.Number,
Bill Wendlingdd9127d2009-01-06 19:13:55 +00004061 "eh_func_begin", EHFrameInfo.Number, true);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004062 Asm->EOL("FDE address range");
Duncan Sands96144f92008-05-07 19:11:09 +00004063
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004064 // If there is a personality and landing pads then point to the language
4065 // specific data area in the exception table.
4066 if (EHFrameInfo.PersonalityIndex) {
Duncan Sands96144f92008-05-07 19:11:09 +00004067 Asm->EmitULEB128Bytes(4);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004068 Asm->EOL("Augmentation size");
Duncan Sands96144f92008-05-07 19:11:09 +00004069
4070 if (EHFrameInfo.hasLandingPads)
4071 EmitReference("exception", EHFrameInfo.Number, true, true);
4072 else
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004073 Asm->EmitInt32((int)0);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004074 Asm->EOL("Language Specific Data Area");
4075 } else {
4076 Asm->EmitULEB128Bytes(0);
4077 Asm->EOL("Augmentation size");
4078 }
Duncan Sands96144f92008-05-07 19:11:09 +00004079
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004080 // Indicate locations of function specific callee saved registers in
4081 // frame.
Dale Johannesenf5a11532007-11-13 19:13:01 +00004082 EmitFrameMoves("eh_func_begin", EHFrameInfo.Number, EHFrameInfo.Moves, true);
aslc200b112008-08-16 12:57:46 +00004083
Dale Johannesen388f20f2008-04-30 00:43:29 +00004084 // On Darwin the linker honors the alignment of eh_frame, which means it
4085 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
4086 // you get holes which confuse readers of eh_frame.
aslc200b112008-08-16 12:57:46 +00004087 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
Dale Johannesen837d7ab2008-04-29 22:58:20 +00004088 0, 0, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004089 EmitLabel("eh_frame_end", EHFrameInfo.Number);
aslc200b112008-08-16 12:57:46 +00004090
4091 // If the function is marked used, this table should be also. We cannot
Dale Johannesen3dadeb32008-01-16 19:59:28 +00004092 // make the mark unconditional in this case, since retaining the table
aslc200b112008-08-16 12:57:46 +00004093 // also retains the function in this case, and there is code around
Dale Johannesen3dadeb32008-01-16 19:59:28 +00004094 // that depends on unused functions (calling undefined externals) being
4095 // dead-stripped to link correctly. Yes, there really is.
4096 if (MMI->getUsedFunctions().count(EHFrameInfo.function))
4097 if (const char *UsedDirective = TAI->getUsedDirective())
4098 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
4099 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004100 }
4101
Duncan Sands241a0c92007-09-05 11:27:52 +00004102 /// EmitExceptionTable - Emit landing pads and actions.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004103 ///
4104 /// The general organization of the table is complex, but the basic concepts
4105 /// are easy. First there is a header which describes the location and
4106 /// organization of the three components that follow.
4107 /// 1. The landing pad site information describes the range of code covered
4108 /// by the try. In our case it's an accumulation of the ranges covered
4109 /// by the invokes in the try. There is also a reference to the landing
4110 /// pad that handles the exception once processed. Finally an index into
4111 /// the actions table.
4112 /// 2. The action table, in our case, is composed of pairs of type ids
4113 /// and next action offset. Starting with the action index from the
4114 /// landing pad site, each type Id is checked for a match to the current
4115 /// exception. If it matches then the exception and type id are passed
4116 /// on to the landing pad. Otherwise the next action is looked up. This
4117 /// chain is terminated with a next action of zero. If no type id is
4118 /// found the the frame is unwound and handling continues.
4119 /// 3. Type id table contains references to all the C++ typeinfo for all
4120 /// catches in the function. This tables is reversed indexed base 1.
4121
4122 /// SharedTypeIds - How many leading type ids two landing pads have in common.
4123 static unsigned SharedTypeIds(const LandingPadInfo *L,
4124 const LandingPadInfo *R) {
4125 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
4126 unsigned LSize = LIds.size(), RSize = RIds.size();
4127 unsigned MinSize = LSize < RSize ? LSize : RSize;
4128 unsigned Count = 0;
4129
4130 for (; Count != MinSize; ++Count)
4131 if (LIds[Count] != RIds[Count])
4132 return Count;
4133
4134 return Count;
4135 }
4136
4137 /// PadLT - Order landing pads lexicographically by type id.
4138 static bool PadLT(const LandingPadInfo *L, const LandingPadInfo *R) {
4139 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
4140 unsigned LSize = LIds.size(), RSize = RIds.size();
4141 unsigned MinSize = LSize < RSize ? LSize : RSize;
4142
4143 for (unsigned i = 0; i != MinSize; ++i)
4144 if (LIds[i] != RIds[i])
4145 return LIds[i] < RIds[i];
4146
4147 return LSize < RSize;
4148 }
4149
4150 struct KeyInfo {
4151 static inline unsigned getEmptyKey() { return -1U; }
4152 static inline unsigned getTombstoneKey() { return -2U; }
4153 static unsigned getHashValue(const unsigned &Key) { return Key; }
Chris Lattner92eea072007-09-17 18:34:04 +00004154 static bool isEqual(unsigned LHS, unsigned RHS) { return LHS == RHS; }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004155 static bool isPod() { return true; }
4156 };
4157
Duncan Sands241a0c92007-09-05 11:27:52 +00004158 /// ActionEntry - Structure describing an entry in the actions table.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004159 struct ActionEntry {
4160 int ValueForTypeID; // The value to write - may not be equal to the type id.
4161 int NextAction;
4162 struct ActionEntry *Previous;
4163 };
4164
Duncan Sands241a0c92007-09-05 11:27:52 +00004165 /// PadRange - Structure holding a try-range and the associated landing pad.
4166 struct PadRange {
4167 // The index of the landing pad.
4168 unsigned PadIndex;
4169 // The index of the begin and end labels in the landing pad's label lists.
4170 unsigned RangeIndex;
4171 };
4172
4173 typedef DenseMap<unsigned, PadRange, KeyInfo> RangeMapType;
4174
4175 /// CallSiteEntry - Structure describing an entry in the call-site table.
4176 struct CallSiteEntry {
Duncan Sands4ff179f2007-12-19 07:36:31 +00004177 // The 'try-range' is BeginLabel .. EndLabel.
Duncan Sands241a0c92007-09-05 11:27:52 +00004178 unsigned BeginLabel; // zero indicates the start of the function.
4179 unsigned EndLabel; // zero indicates the end of the function.
Duncan Sands4ff179f2007-12-19 07:36:31 +00004180 // The landing pad starts at PadLabel.
Duncan Sands241a0c92007-09-05 11:27:52 +00004181 unsigned PadLabel; // zero indicates that there is no landing pad.
4182 unsigned Action;
4183 };
4184
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004185 void EmitExceptionTable() {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004186 const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
4187 const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
4188 const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
4189 if (PadInfos.empty()) return;
4190
4191 // Sort the landing pads in order of their type ids. This is used to fold
4192 // duplicate actions.
4193 SmallVector<const LandingPadInfo *, 64> LandingPads;
4194 LandingPads.reserve(PadInfos.size());
4195 for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
4196 LandingPads.push_back(&PadInfos[i]);
4197 std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
4198
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004199 // Negative type ids index into FilterIds, positive type ids index into
4200 // TypeInfos. The value written for a positive type id is just the type
4201 // id itself. For a negative type id, however, the value written is the
4202 // (negative) byte offset of the corresponding FilterIds entry. The byte
4203 // offset is usually equal to the type id, because the FilterIds entries
4204 // are written using a variable width encoding which outputs one byte per
4205 // entry as long as the value written is not too large, but can differ.
4206 // This kind of complication does not occur for positive type ids because
4207 // type infos are output using a fixed width encoding.
4208 // FilterOffsets[i] holds the byte offset corresponding to FilterIds[i].
4209 SmallVector<int, 16> FilterOffsets;
4210 FilterOffsets.reserve(FilterIds.size());
4211 int Offset = -1;
4212 for(std::vector<unsigned>::const_iterator I = FilterIds.begin(),
4213 E = FilterIds.end(); I != E; ++I) {
4214 FilterOffsets.push_back(Offset);
aslc200b112008-08-16 12:57:46 +00004215 Offset -= TargetAsmInfo::getULEB128Size(*I);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004216 }
4217
Duncan Sands241a0c92007-09-05 11:27:52 +00004218 // Compute the actions table and gather the first action index for each
4219 // landing pad site.
4220 SmallVector<ActionEntry, 32> Actions;
4221 SmallVector<unsigned, 64> FirstActions;
4222 FirstActions.reserve(LandingPads.size());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004223
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004224 int FirstAction = 0;
Duncan Sands241a0c92007-09-05 11:27:52 +00004225 unsigned SizeActions = 0;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004226 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
4227 const LandingPadInfo *LP = LandingPads[i];
4228 const std::vector<int> &TypeIds = LP->TypeIds;
4229 const unsigned NumShared = i ? SharedTypeIds(LP, LandingPads[i-1]) : 0;
4230 unsigned SizeSiteActions = 0;
4231
4232 if (NumShared < TypeIds.size()) {
4233 unsigned SizeAction = 0;
4234 ActionEntry *PrevAction = 0;
4235
4236 if (NumShared) {
4237 const unsigned SizePrevIds = LandingPads[i-1]->TypeIds.size();
4238 assert(Actions.size());
4239 PrevAction = &Actions.back();
aslc200b112008-08-16 12:57:46 +00004240 SizeAction = TargetAsmInfo::getSLEB128Size(PrevAction->NextAction) +
4241 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004242 for (unsigned j = NumShared; j != SizePrevIds; ++j) {
aslc200b112008-08-16 12:57:46 +00004243 SizeAction -=
4244 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004245 SizeAction += -PrevAction->NextAction;
4246 PrevAction = PrevAction->Previous;
4247 }
4248 }
4249
4250 // Compute the actions.
4251 for (unsigned I = NumShared, M = TypeIds.size(); I != M; ++I) {
4252 int TypeID = TypeIds[I];
4253 assert(-1-TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
4254 int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
aslc200b112008-08-16 12:57:46 +00004255 unsigned SizeTypeID = TargetAsmInfo::getSLEB128Size(ValueForTypeID);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004256
4257 int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
aslc200b112008-08-16 12:57:46 +00004258 SizeAction = SizeTypeID + TargetAsmInfo::getSLEB128Size(NextAction);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004259 SizeSiteActions += SizeAction;
4260
4261 ActionEntry Action = {ValueForTypeID, NextAction, PrevAction};
4262 Actions.push_back(Action);
4263
4264 PrevAction = &Actions.back();
4265 }
4266
4267 // Record the first action of the landing pad site.
4268 FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
4269 } // else identical - re-use previous FirstAction
4270
4271 FirstActions.push_back(FirstAction);
4272
4273 // Compute this sites contribution to size.
4274 SizeActions += SizeSiteActions;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004275 }
Duncan Sands241a0c92007-09-05 11:27:52 +00004276
Duncan Sands4ff179f2007-12-19 07:36:31 +00004277 // Compute the call-site table. The entry for an invoke has a try-range
4278 // containing the call, a non-zero landing pad and an appropriate action.
4279 // The entry for an ordinary call has a try-range containing the call and
4280 // zero for the landing pad and the action. Calls marked 'nounwind' have
4281 // no entry and must not be contained in the try-range of any entry - they
4282 // form gaps in the table. Entries must be ordered by try-range address.
Duncan Sands241a0c92007-09-05 11:27:52 +00004283 SmallVector<CallSiteEntry, 64> CallSites;
4284
4285 RangeMapType PadMap;
Duncan Sands4ff179f2007-12-19 07:36:31 +00004286 // Invokes and nounwind calls have entries in PadMap (due to being bracketed
4287 // by try-range labels when lowered). Ordinary calls do not, so appropriate
4288 // try-ranges for them need be deduced.
Duncan Sands241a0c92007-09-05 11:27:52 +00004289 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
4290 const LandingPadInfo *LandingPad = LandingPads[i];
Duncan Sands4ff179f2007-12-19 07:36:31 +00004291 for (unsigned j = 0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
Duncan Sands241a0c92007-09-05 11:27:52 +00004292 unsigned BeginLabel = LandingPad->BeginLabels[j];
4293 assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
4294 PadRange P = { i, j };
4295 PadMap[BeginLabel] = P;
4296 }
4297 }
4298
Duncan Sands4ff179f2007-12-19 07:36:31 +00004299 // The end label of the previous invoke or nounwind try-range.
Duncan Sands241a0c92007-09-05 11:27:52 +00004300 unsigned LastLabel = 0;
Duncan Sands4ff179f2007-12-19 07:36:31 +00004301
4302 // Whether there is a potentially throwing instruction (currently this means
4303 // an ordinary call) between the end of the previous try-range and now.
4304 bool SawPotentiallyThrowing = false;
4305
4306 // Whether the last callsite entry was for an invoke.
4307 bool PreviousIsInvoke = false;
4308
Duncan Sands4ff179f2007-12-19 07:36:31 +00004309 // Visit all instructions in order of address.
Duncan Sands241a0c92007-09-05 11:27:52 +00004310 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
4311 I != E; ++I) {
4312 for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
4313 MI != E; ++MI) {
Dan Gohmanfa607c92008-07-01 00:05:16 +00004314 if (!MI->isLabel()) {
Chris Lattner5b930372008-01-07 07:27:27 +00004315 SawPotentiallyThrowing |= MI->getDesc().isCall();
Duncan Sands241a0c92007-09-05 11:27:52 +00004316 continue;
4317 }
4318
Chris Lattnerda4cff12007-12-30 20:50:28 +00004319 unsigned BeginLabel = MI->getOperand(0).getImm();
Duncan Sands241a0c92007-09-05 11:27:52 +00004320 assert(BeginLabel && "Invalid label!");
Duncan Sands89372f62007-09-05 14:12:46 +00004321
Duncan Sands4ff179f2007-12-19 07:36:31 +00004322 // End of the previous try-range?
Duncan Sands89372f62007-09-05 14:12:46 +00004323 if (BeginLabel == LastLabel)
Duncan Sands4ff179f2007-12-19 07:36:31 +00004324 SawPotentiallyThrowing = false;
Duncan Sands241a0c92007-09-05 11:27:52 +00004325
Duncan Sands4ff179f2007-12-19 07:36:31 +00004326 // Beginning of a new try-range?
Duncan Sands241a0c92007-09-05 11:27:52 +00004327 RangeMapType::iterator L = PadMap.find(BeginLabel);
Duncan Sands241a0c92007-09-05 11:27:52 +00004328 if (L == PadMap.end())
Duncan Sands4ff179f2007-12-19 07:36:31 +00004329 // Nope, it was just some random label.
Duncan Sands241a0c92007-09-05 11:27:52 +00004330 continue;
4331
4332 PadRange P = L->second;
4333 const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
4334
4335 assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
4336 "Inconsistent landing pad map!");
4337
4338 // If some instruction between the previous try-range and this one may
4339 // throw, create a call-site entry with no landing pad for the region
4340 // between the try-ranges.
Duncan Sands4ff179f2007-12-19 07:36:31 +00004341 if (SawPotentiallyThrowing) {
Duncan Sands241a0c92007-09-05 11:27:52 +00004342 CallSiteEntry Site = {LastLabel, BeginLabel, 0, 0};
4343 CallSites.push_back(Site);
Duncan Sands4ff179f2007-12-19 07:36:31 +00004344 PreviousIsInvoke = false;
Duncan Sands241a0c92007-09-05 11:27:52 +00004345 }
4346
4347 LastLabel = LandingPad->EndLabels[P.RangeIndex];
Duncan Sands4ff179f2007-12-19 07:36:31 +00004348 assert(BeginLabel && LastLabel && "Invalid landing pad!");
Duncan Sands241a0c92007-09-05 11:27:52 +00004349
Duncan Sands4ff179f2007-12-19 07:36:31 +00004350 if (LandingPad->LandingPadLabel) {
4351 // This try-range is for an invoke.
4352 CallSiteEntry Site = {BeginLabel, LastLabel,
4353 LandingPad->LandingPadLabel, FirstActions[P.PadIndex]};
Duncan Sands241a0c92007-09-05 11:27:52 +00004354
Duncan Sands4ff179f2007-12-19 07:36:31 +00004355 // Try to merge with the previous call-site.
4356 if (PreviousIsInvoke) {
Dan Gohman3d436002008-06-21 22:00:54 +00004357 CallSiteEntry &Prev = CallSites.back();
Duncan Sands4ff179f2007-12-19 07:36:31 +00004358 if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
4359 // Extend the range of the previous entry.
4360 Prev.EndLabel = Site.EndLabel;
4361 continue;
4362 }
Duncan Sands241a0c92007-09-05 11:27:52 +00004363 }
Duncan Sands241a0c92007-09-05 11:27:52 +00004364
Duncan Sands4ff179f2007-12-19 07:36:31 +00004365 // Otherwise, create a new call-site.
4366 CallSites.push_back(Site);
4367 PreviousIsInvoke = true;
4368 } else {
4369 // Create a gap.
4370 PreviousIsInvoke = false;
4371 }
Duncan Sands241a0c92007-09-05 11:27:52 +00004372 }
4373 }
4374 // If some instruction between the previous try-range and the end of the
4375 // function may throw, create a call-site entry with no landing pad for the
4376 // region following the try-range.
Duncan Sands4ff179f2007-12-19 07:36:31 +00004377 if (SawPotentiallyThrowing) {
Duncan Sands241a0c92007-09-05 11:27:52 +00004378 CallSiteEntry Site = {LastLabel, 0, 0, 0};
4379 CallSites.push_back(Site);
4380 }
4381
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004382 // Final tallies.
Duncan Sands96144f92008-05-07 19:11:09 +00004383
4384 // Call sites.
4385 const unsigned SiteStartSize = sizeof(int32_t); // DW_EH_PE_udata4
4386 const unsigned SiteLengthSize = sizeof(int32_t); // DW_EH_PE_udata4
4387 const unsigned LandingPadSize = sizeof(int32_t); // DW_EH_PE_udata4
4388 unsigned SizeSites = CallSites.size() * (SiteStartSize +
4389 SiteLengthSize +
4390 LandingPadSize);
Duncan Sands241a0c92007-09-05 11:27:52 +00004391 for (unsigned i = 0, e = CallSites.size(); i < e; ++i)
aslc200b112008-08-16 12:57:46 +00004392 SizeSites += TargetAsmInfo::getULEB128Size(CallSites[i].Action);
Duncan Sands241a0c92007-09-05 11:27:52 +00004393
Duncan Sands96144f92008-05-07 19:11:09 +00004394 // Type infos.
4395 const unsigned TypeInfoSize = TD->getPointerSize(); // DW_EH_PE_absptr
4396 unsigned SizeTypes = TypeInfos.size() * TypeInfoSize;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004397
4398 unsigned TypeOffset = sizeof(int8_t) + // Call site format
aslc200b112008-08-16 12:57:46 +00004399 TargetAsmInfo::getULEB128Size(SizeSites) + // Call-site table length
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004400 SizeSites + SizeActions + SizeTypes;
4401
4402 unsigned TotalSize = sizeof(int8_t) + // LPStart format
4403 sizeof(int8_t) + // TType format
aslc200b112008-08-16 12:57:46 +00004404 TargetAsmInfo::getULEB128Size(TypeOffset) + // TType base offset
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004405 TypeOffset;
4406
4407 unsigned SizeAlign = (4 - TotalSize) & 3;
4408
4409 // Begin the exception table.
4410 Asm->SwitchToDataSection(TAI->getDwarfExceptionSection());
Evan Cheng7e7d1942008-02-29 19:36:59 +00004411 Asm->EmitAlignment(2, 0, 0, false);
Dale Johannesen841e4982008-10-08 21:50:21 +00004412 O << "GCC_except_table" << SubprogramCount << ":\n";
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004413 for (unsigned i = 0; i != SizeAlign; ++i) {
4414 Asm->EmitInt8(0);
4415 Asm->EOL("Padding");
4416 }
4417 EmitLabel("exception", SubprogramCount);
4418
4419 // Emit the header.
4420 Asm->EmitInt8(DW_EH_PE_omit);
4421 Asm->EOL("LPStart format (DW_EH_PE_omit)");
4422 Asm->EmitInt8(DW_EH_PE_absptr);
4423 Asm->EOL("TType format (DW_EH_PE_absptr)");
4424 Asm->EmitULEB128Bytes(TypeOffset);
4425 Asm->EOL("TType base offset");
4426 Asm->EmitInt8(DW_EH_PE_udata4);
4427 Asm->EOL("Call site format (DW_EH_PE_udata4)");
4428 Asm->EmitULEB128Bytes(SizeSites);
4429 Asm->EOL("Call-site table length");
4430
Duncan Sands241a0c92007-09-05 11:27:52 +00004431 // Emit the landing pad site information.
4432 for (unsigned i = 0; i < CallSites.size(); ++i) {
4433 CallSiteEntry &S = CallSites[i];
4434 const char *BeginTag;
4435 unsigned BeginNumber;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004436
Duncan Sands241a0c92007-09-05 11:27:52 +00004437 if (!S.BeginLabel) {
4438 BeginTag = "eh_func_begin";
4439 BeginNumber = SubprogramCount;
4440 } else {
4441 BeginTag = "label";
4442 BeginNumber = S.BeginLabel;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004443 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004444
Duncan Sands241a0c92007-09-05 11:27:52 +00004445 EmitSectionOffset(BeginTag, "eh_func_begin", BeginNumber, SubprogramCount,
Duncan Sands96144f92008-05-07 19:11:09 +00004446 true, true);
Duncan Sands241a0c92007-09-05 11:27:52 +00004447 Asm->EOL("Region start");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004448
Duncan Sands241a0c92007-09-05 11:27:52 +00004449 if (!S.EndLabel) {
Dale Johannesen4670be42008-01-15 23:24:56 +00004450 EmitDifference("eh_func_end", SubprogramCount, BeginTag, BeginNumber,
Duncan Sands96144f92008-05-07 19:11:09 +00004451 true);
Duncan Sands241a0c92007-09-05 11:27:52 +00004452 } else {
Duncan Sands96144f92008-05-07 19:11:09 +00004453 EmitDifference("label", S.EndLabel, BeginTag, BeginNumber, true);
Duncan Sands241a0c92007-09-05 11:27:52 +00004454 }
4455 Asm->EOL("Region length");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004456
Duncan Sands96144f92008-05-07 19:11:09 +00004457 if (!S.PadLabel)
4458 Asm->EmitInt32(0);
4459 else
Duncan Sands241a0c92007-09-05 11:27:52 +00004460 EmitSectionOffset("label", "eh_func_begin", S.PadLabel, SubprogramCount,
Duncan Sands96144f92008-05-07 19:11:09 +00004461 true, true);
Duncan Sands241a0c92007-09-05 11:27:52 +00004462 Asm->EOL("Landing pad");
4463
4464 Asm->EmitULEB128Bytes(S.Action);
4465 Asm->EOL("Action");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004466 }
4467
4468 // Emit the actions.
4469 for (unsigned I = 0, N = Actions.size(); I != N; ++I) {
4470 ActionEntry &Action = Actions[I];
4471
4472 Asm->EmitSLEB128Bytes(Action.ValueForTypeID);
4473 Asm->EOL("TypeInfo index");
4474 Asm->EmitSLEB128Bytes(Action.NextAction);
4475 Asm->EOL("Next action");
4476 }
4477
4478 // Emit the type ids.
4479 for (unsigned M = TypeInfos.size(); M; --M) {
4480 GlobalVariable *GV = TypeInfos[M - 1];
Anton Korobeynikov5ef86702007-09-02 22:07:21 +00004481
4482 PrintRelDirective();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004483
4484 if (GV)
4485 O << Asm->getGlobalLinkName(GV);
4486 else
4487 O << "0";
Duncan Sands241a0c92007-09-05 11:27:52 +00004488
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004489 Asm->EOL("TypeInfo");
4490 }
4491
4492 // Emit the filter typeids.
4493 for (unsigned j = 0, M = FilterIds.size(); j < M; ++j) {
4494 unsigned TypeID = FilterIds[j];
4495 Asm->EmitULEB128Bytes(TypeID);
4496 Asm->EOL("Filter TypeInfo index");
4497 }
Duncan Sands241a0c92007-09-05 11:27:52 +00004498
Evan Cheng7e7d1942008-02-29 19:36:59 +00004499 Asm->EmitAlignment(2, 0, 0, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004500 }
4501
4502public:
4503 //===--------------------------------------------------------------------===//
4504 // Main entry points.
4505 //
Owen Anderson847b99b2008-08-21 00:14:44 +00004506 DwarfException(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
Chris Lattnerb3876c72007-09-24 03:35:37 +00004507 : Dwarf(OS, A, T, "eh")
Dale Johannesen85535762008-04-02 00:25:04 +00004508 , shouldEmitTable(false)
4509 , shouldEmitMoves(false)
4510 , shouldEmitTableModule(false)
4511 , shouldEmitMovesModule(false)
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004512 {}
aslc200b112008-08-16 12:57:46 +00004513
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004514 virtual ~DwarfException() {}
4515
4516 /// SetModuleInfo - Set machine module information when it's known that pass
4517 /// manager has created it. Set by the target AsmPrinter.
4518 void SetModuleInfo(MachineModuleInfo *mmi) {
4519 MMI = mmi;
4520 }
4521
4522 /// BeginModule - Emit all exception information that should come prior to the
4523 /// content.
4524 void BeginModule(Module *M) {
4525 this->M = M;
4526 }
4527
4528 /// EndModule - Emit all exception information that should come after the
4529 /// content.
4530 void EndModule() {
Dale Johannesen85535762008-04-02 00:25:04 +00004531 if (shouldEmitMovesModule || shouldEmitTableModule) {
4532 const std::vector<Function *> Personalities = MMI->getPersonalities();
4533 for (unsigned i =0; i < Personalities.size(); ++i)
4534 EmitCommonEHFrame(Personalities[i], i);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004535
Dale Johannesen85535762008-04-02 00:25:04 +00004536 for (std::vector<FunctionEHFrameInfo>::iterator I = EHFrames.begin(),
4537 E = EHFrames.end(); I != E; ++I)
4538 EmitEHFrame(*I);
4539 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004540 }
4541
aslc200b112008-08-16 12:57:46 +00004542 /// BeginFunction - Gather pre-function exception information. Assumes being
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004543 /// emitted immediately after the function entry point.
4544 void BeginFunction(MachineFunction *MF) {
4545 this->MF = MF;
Dale Johannesen85535762008-04-02 00:25:04 +00004546 shouldEmitTable = shouldEmitMoves = false;
Dale Johannesen62f0a6d2008-04-02 17:04:45 +00004547 if (MMI && TAI->doesSupportExceptionHandling()) {
Dale Johannesen85535762008-04-02 00:25:04 +00004548
4549 // Map all labels and get rid of any dead landing pads.
4550 MMI->TidyLandingPads();
4551 // If any landing pads survive, we need an EH table.
4552 if (MMI->getLandingPads().size())
4553 shouldEmitTable = true;
4554
4555 // See if we need frame move info.
Duncan Sandscbc28b12008-07-04 09:55:48 +00004556 if (!MF->getFunction()->doesNotThrow() || UnwindTablesMandatory)
Dale Johannesen85535762008-04-02 00:25:04 +00004557 shouldEmitMoves = true;
4558
4559 if (shouldEmitMoves || shouldEmitTable)
4560 // Assumes in correct section after the entry point.
4561 EmitLabel("eh_func_begin", ++SubprogramCount);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004562 }
Dale Johannesen85535762008-04-02 00:25:04 +00004563 shouldEmitTableModule |= shouldEmitTable;
4564 shouldEmitMovesModule |= shouldEmitMoves;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004565 }
4566
4567 /// EndFunction - Gather and emit post-function exception information.
4568 ///
4569 void EndFunction() {
Dale Johannesen85535762008-04-02 00:25:04 +00004570 if (shouldEmitMoves || shouldEmitTable) {
4571 EmitLabel("eh_func_end", SubprogramCount);
4572 EmitExceptionTable();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004573
Dale Johannesen85535762008-04-02 00:25:04 +00004574 // Save EH frame information
4575 EHFrames.
4576 push_back(FunctionEHFrameInfo(getAsm()->getCurrentFunctionEHName(MF),
Bill Wendlingef9211a2007-09-18 01:47:22 +00004577 SubprogramCount,
4578 MMI->getPersonalityIndex(),
4579 MF->getFrameInfo()->hasCalls(),
4580 !MMI->getLandingPads().empty(),
Dale Johannesenfb3ac732007-11-20 23:24:42 +00004581 MMI->getFrameMoves(),
Dale Johannesen3dadeb32008-01-16 19:59:28 +00004582 MF->getFunction()));
Dale Johannesen85535762008-04-02 00:25:04 +00004583 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004584 }
4585};
4586
4587} // End of namespace llvm
4588
4589//===----------------------------------------------------------------------===//
4590
4591/// Emit - Print the abbreviation using the specified Dwarf writer.
4592///
4593void DIEAbbrev::Emit(const DwarfDebug &DD) const {
4594 // Emit its Dwarf tag type.
4595 DD.getAsm()->EmitULEB128Bytes(Tag);
4596 DD.getAsm()->EOL(TagString(Tag));
aslc200b112008-08-16 12:57:46 +00004597
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004598 // Emit whether it has children DIEs.
4599 DD.getAsm()->EmitULEB128Bytes(ChildrenFlag);
4600 DD.getAsm()->EOL(ChildrenString(ChildrenFlag));
aslc200b112008-08-16 12:57:46 +00004601
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004602 // For each attribute description.
4603 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4604 const DIEAbbrevData &AttrData = Data[i];
aslc200b112008-08-16 12:57:46 +00004605
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004606 // Emit attribute type.
4607 DD.getAsm()->EmitULEB128Bytes(AttrData.getAttribute());
4608 DD.getAsm()->EOL(AttributeString(AttrData.getAttribute()));
aslc200b112008-08-16 12:57:46 +00004609
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004610 // Emit form type.
4611 DD.getAsm()->EmitULEB128Bytes(AttrData.getForm());
4612 DD.getAsm()->EOL(FormEncodingString(AttrData.getForm()));
4613 }
4614
4615 // Mark end of abbreviation.
4616 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(1)");
4617 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(2)");
4618}
4619
4620#ifndef NDEBUG
4621void DIEAbbrev::print(std::ostream &O) {
4622 O << "Abbreviation @"
4623 << std::hex << (intptr_t)this << std::dec
4624 << " "
4625 << TagString(Tag)
4626 << " "
4627 << ChildrenString(ChildrenFlag)
4628 << "\n";
aslc200b112008-08-16 12:57:46 +00004629
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004630 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4631 O << " "
4632 << AttributeString(Data[i].getAttribute())
4633 << " "
4634 << FormEncodingString(Data[i].getForm())
4635 << "\n";
4636 }
4637}
4638void DIEAbbrev::dump() { print(cerr); }
4639#endif
4640
4641//===----------------------------------------------------------------------===//
4642
4643#ifndef NDEBUG
4644void DIEValue::dump() {
4645 print(cerr);
4646}
4647#endif
4648
4649//===----------------------------------------------------------------------===//
4650
4651/// EmitValue - Emit integer of appropriate size.
4652///
4653void DIEInteger::EmitValue(DwarfDebug &DD, unsigned Form) {
4654 switch (Form) {
4655 case DW_FORM_flag: // Fall thru
4656 case DW_FORM_ref1: // Fall thru
4657 case DW_FORM_data1: DD.getAsm()->EmitInt8(Integer); break;
4658 case DW_FORM_ref2: // Fall thru
4659 case DW_FORM_data2: DD.getAsm()->EmitInt16(Integer); break;
4660 case DW_FORM_ref4: // Fall thru
4661 case DW_FORM_data4: DD.getAsm()->EmitInt32(Integer); break;
4662 case DW_FORM_ref8: // Fall thru
4663 case DW_FORM_data8: DD.getAsm()->EmitInt64(Integer); break;
4664 case DW_FORM_udata: DD.getAsm()->EmitULEB128Bytes(Integer); break;
4665 case DW_FORM_sdata: DD.getAsm()->EmitSLEB128Bytes(Integer); break;
4666 default: assert(0 && "DIE Value form not supported yet"); break;
4667 }
4668}
4669
4670/// SizeOf - Determine size of integer value in bytes.
4671///
4672unsigned DIEInteger::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4673 switch (Form) {
4674 case DW_FORM_flag: // Fall thru
4675 case DW_FORM_ref1: // Fall thru
4676 case DW_FORM_data1: return sizeof(int8_t);
4677 case DW_FORM_ref2: // Fall thru
4678 case DW_FORM_data2: return sizeof(int16_t);
4679 case DW_FORM_ref4: // Fall thru
4680 case DW_FORM_data4: return sizeof(int32_t);
4681 case DW_FORM_ref8: // Fall thru
4682 case DW_FORM_data8: return sizeof(int64_t);
aslc200b112008-08-16 12:57:46 +00004683 case DW_FORM_udata: return TargetAsmInfo::getULEB128Size(Integer);
4684 case DW_FORM_sdata: return TargetAsmInfo::getSLEB128Size(Integer);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004685 default: assert(0 && "DIE Value form not supported yet"); break;
4686 }
4687 return 0;
4688}
4689
4690//===----------------------------------------------------------------------===//
4691
4692/// EmitValue - Emit string value.
4693///
4694void DIEString::EmitValue(DwarfDebug &DD, unsigned Form) {
4695 DD.getAsm()->EmitString(String);
4696}
4697
4698//===----------------------------------------------------------------------===//
4699
4700/// EmitValue - Emit label value.
4701///
4702void DIEDwarfLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
Dan Gohman597b4842007-09-28 16:50:28 +00004703 bool IsSmall = Form == DW_FORM_data4;
4704 DD.EmitReference(Label, false, IsSmall);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004705}
4706
4707/// SizeOf - Determine size of label value in bytes.
4708///
4709unsigned DIEDwarfLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Dan Gohman597b4842007-09-28 16:50:28 +00004710 if (Form == DW_FORM_data4) return 4;
Dan Gohmancfb72b22007-09-27 23:12:31 +00004711 return DD.getTargetData()->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004712}
4713
4714//===----------------------------------------------------------------------===//
4715
4716/// EmitValue - Emit label value.
4717///
4718void DIEObjectLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
Dan Gohman597b4842007-09-28 16:50:28 +00004719 bool IsSmall = Form == DW_FORM_data4;
4720 DD.EmitReference(Label, false, IsSmall);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004721}
4722
4723/// SizeOf - Determine size of label value in bytes.
4724///
4725unsigned DIEObjectLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Dan Gohman597b4842007-09-28 16:50:28 +00004726 if (Form == DW_FORM_data4) return 4;
Dan Gohmancfb72b22007-09-27 23:12:31 +00004727 return DD.getTargetData()->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004728}
aslc200b112008-08-16 12:57:46 +00004729
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004730//===----------------------------------------------------------------------===//
4731
4732/// EmitValue - Emit delta value.
4733///
Argiris Kirtzidis03449652008-06-18 19:27:37 +00004734void DIESectionOffset::EmitValue(DwarfDebug &DD, unsigned Form) {
4735 bool IsSmall = Form == DW_FORM_data4;
4736 DD.EmitSectionOffset(Label.Tag, Section.Tag,
4737 Label.Number, Section.Number, IsSmall, IsEH, UseSet);
4738}
4739
4740/// SizeOf - Determine size of delta value in bytes.
4741///
4742unsigned DIESectionOffset::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4743 if (Form == DW_FORM_data4) return 4;
4744 return DD.getTargetData()->getPointerSize();
4745}
aslc200b112008-08-16 12:57:46 +00004746
Argiris Kirtzidis03449652008-06-18 19:27:37 +00004747//===----------------------------------------------------------------------===//
4748
4749/// EmitValue - Emit delta value.
4750///
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004751void DIEDelta::EmitValue(DwarfDebug &DD, unsigned Form) {
4752 bool IsSmall = Form == DW_FORM_data4;
4753 DD.EmitDifference(LabelHi, LabelLo, IsSmall);
4754}
4755
4756/// SizeOf - Determine size of delta value in bytes.
4757///
4758unsigned DIEDelta::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4759 if (Form == DW_FORM_data4) return 4;
Dan Gohmancfb72b22007-09-27 23:12:31 +00004760 return DD.getTargetData()->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004761}
4762
4763//===----------------------------------------------------------------------===//
4764
4765/// EmitValue - Emit debug information entry offset.
4766///
4767void DIEntry::EmitValue(DwarfDebug &DD, unsigned Form) {
4768 DD.getAsm()->EmitInt32(Entry->getOffset());
4769}
aslc200b112008-08-16 12:57:46 +00004770
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004771//===----------------------------------------------------------------------===//
4772
4773/// ComputeSize - calculate the size of the block.
4774///
4775unsigned DIEBlock::ComputeSize(DwarfDebug &DD) {
4776 if (!Size) {
Owen Anderson88dd6232008-06-24 21:44:59 +00004777 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
aslc200b112008-08-16 12:57:46 +00004778
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004779 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4780 Size += Values[i]->SizeOf(DD, AbbrevData[i].getForm());
4781 }
4782 }
4783 return Size;
4784}
4785
4786/// EmitValue - Emit block data.
4787///
4788void DIEBlock::EmitValue(DwarfDebug &DD, unsigned Form) {
4789 switch (Form) {
4790 case DW_FORM_block1: DD.getAsm()->EmitInt8(Size); break;
4791 case DW_FORM_block2: DD.getAsm()->EmitInt16(Size); break;
4792 case DW_FORM_block4: DD.getAsm()->EmitInt32(Size); break;
4793 case DW_FORM_block: DD.getAsm()->EmitULEB128Bytes(Size); break;
4794 default: assert(0 && "Improper form for block"); break;
4795 }
aslc200b112008-08-16 12:57:46 +00004796
Owen Anderson88dd6232008-06-24 21:44:59 +00004797 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004798
4799 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4800 DD.getAsm()->EOL();
4801 Values[i]->EmitValue(DD, AbbrevData[i].getForm());
4802 }
4803}
4804
4805/// SizeOf - Determine size of block data in bytes.
4806///
4807unsigned DIEBlock::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4808 switch (Form) {
4809 case DW_FORM_block1: return Size + sizeof(int8_t);
4810 case DW_FORM_block2: return Size + sizeof(int16_t);
4811 case DW_FORM_block4: return Size + sizeof(int32_t);
aslc200b112008-08-16 12:57:46 +00004812 case DW_FORM_block: return Size + TargetAsmInfo::getULEB128Size(Size);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004813 default: assert(0 && "Improper form for block"); break;
4814 }
4815 return 0;
4816}
4817
4818//===----------------------------------------------------------------------===//
4819/// DIE Implementation
4820
4821DIE::~DIE() {
4822 for (unsigned i = 0, N = Children.size(); i < N; ++i)
4823 delete Children[i];
4824}
aslc200b112008-08-16 12:57:46 +00004825
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004826/// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
4827///
4828void DIE::AddSiblingOffset() {
4829 DIEInteger *DI = new DIEInteger(0);
4830 Values.insert(Values.begin(), DI);
4831 Abbrev.AddFirstAttribute(DW_AT_sibling, DW_FORM_ref4);
4832}
4833
4834/// Profile - Used to gather unique data for the value folding set.
4835///
4836void DIE::Profile(FoldingSetNodeID &ID) {
4837 Abbrev.Profile(ID);
aslc200b112008-08-16 12:57:46 +00004838
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004839 for (unsigned i = 0, N = Children.size(); i < N; ++i)
4840 ID.AddPointer(Children[i]);
4841
4842 for (unsigned j = 0, M = Values.size(); j < M; ++j)
4843 ID.AddPointer(Values[j]);
4844}
4845
4846#ifndef NDEBUG
4847void DIE::print(std::ostream &O, unsigned IncIndent) {
4848 static unsigned IndentCount = 0;
4849 IndentCount += IncIndent;
4850 const std::string Indent(IndentCount, ' ');
4851 bool isBlock = Abbrev.getTag() == 0;
aslc200b112008-08-16 12:57:46 +00004852
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004853 if (!isBlock) {
4854 O << Indent
4855 << "Die: "
4856 << "0x" << std::hex << (intptr_t)this << std::dec
4857 << ", Offset: " << Offset
4858 << ", Size: " << Size
aslc200b112008-08-16 12:57:46 +00004859 << "\n";
4860
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004861 O << Indent
4862 << TagString(Abbrev.getTag())
4863 << " "
4864 << ChildrenString(Abbrev.getChildrenFlag());
4865 } else {
4866 O << "Size: " << Size;
4867 }
4868 O << "\n";
4869
Owen Anderson88dd6232008-06-24 21:44:59 +00004870 const SmallVector<DIEAbbrevData, 8> &Data = Abbrev.getData();
aslc200b112008-08-16 12:57:46 +00004871
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004872 IndentCount += 2;
4873 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4874 O << Indent;
Bill Wendlingdc7b5a52008-07-22 00:28:47 +00004875
4876 if (!isBlock)
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004877 O << AttributeString(Data[i].getAttribute());
Bill Wendlingdc7b5a52008-07-22 00:28:47 +00004878 else
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004879 O << "Blk[" << i << "]";
Bill Wendlingdc7b5a52008-07-22 00:28:47 +00004880
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004881 O << " "
4882 << FormEncodingString(Data[i].getForm())
4883 << " ";
4884 Values[i]->print(O);
4885 O << "\n";
4886 }
4887 IndentCount -= 2;
4888
4889 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
4890 Children[j]->print(O, 4);
4891 }
aslc200b112008-08-16 12:57:46 +00004892
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004893 if (!isBlock) O << "\n";
4894 IndentCount -= IncIndent;
4895}
4896
4897void DIE::dump() {
4898 print(cerr);
4899}
4900#endif
4901
4902//===----------------------------------------------------------------------===//
4903/// DwarfWriter Implementation
4904///
4905
Devang Patelaa1e8432009-01-08 23:40:34 +00004906DwarfWriter::DwarfWriter() : ImmutablePass(&ID), DD(NULL), DE(NULL) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004907}
4908
4909DwarfWriter::~DwarfWriter() {
4910 delete DE;
4911 delete DD;
4912}
4913
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004914/// BeginModule - Emit all Dwarf sections that should come prior to the
4915/// content.
Devang Patelaa1e8432009-01-08 23:40:34 +00004916void DwarfWriter::BeginModule(Module *M,
4917 MachineModuleInfo *MMI,
4918 raw_ostream &OS, AsmPrinter *A,
4919 const TargetAsmInfo *T) {
4920 DE = new DwarfException(OS, A, T);
4921 DD = new DwarfDebug(OS, A, T);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004922 DE->BeginModule(M);
4923 DD->BeginModule(M);
Devang Patelaa1e8432009-01-08 23:40:34 +00004924 DD->SetModuleInfo(MMI);
4925 DE->SetModuleInfo(MMI);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004926}
4927
4928/// EndModule - Emit all Dwarf sections that should come after the content.
4929///
4930void DwarfWriter::EndModule() {
4931 DE->EndModule();
4932 DD->EndModule();
4933}
4934
aslc200b112008-08-16 12:57:46 +00004935/// BeginFunction - Gather pre-function debug information. Assumes being
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004936/// emitted immediately after the function entry point.
4937void DwarfWriter::BeginFunction(MachineFunction *MF) {
4938 DE->BeginFunction(MF);
4939 DD->BeginFunction(MF);
4940}
4941
4942/// EndFunction - Gather and emit post-function debug information.
4943///
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00004944void DwarfWriter::EndFunction(MachineFunction *MF) {
4945 DD->EndFunction(MF);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004946 DE->EndFunction();
aslc200b112008-08-16 12:57:46 +00004947
Bill Wendling5b4796a2008-07-22 00:53:37 +00004948 if (MachineModuleInfo *MMI = DD->getMMI() ? DD->getMMI() : DE->getMMI())
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004949 // Clear function debug information.
4950 MMI->EndFunction();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004951}
Devang Patelcb59fd42009-01-12 19:17:34 +00004952
4953/// RecordSourceLine - Records location information and associates it with a
4954/// label. Returns a unique label ID used to generate a label and provide
4955/// correspondence to the source line list.
4956unsigned DwarfWriter::RecordSourceLine(unsigned Line, unsigned Col,
4957 unsigned Src) {
4958 return DD->RecordSourceLine(Line, Col, Src);
4959}
4960
4961/// RecordSource - Register a source file with debug info. Returns an source
4962/// ID.
4963unsigned DwarfWriter::RecordSource(const std::string &Dir,
4964 const std::string &File) {
4965 return DD->RecordSource(Dir, File);
4966}
4967
4968/// RecordRegionStart - Indicate the start of a region.
4969unsigned DwarfWriter::RecordRegionStart(GlobalVariable *V) {
4970 return DD->RecordRegionStart(V);
4971}
4972
4973/// RecordRegionEnd - Indicate the end of a region.
4974unsigned DwarfWriter::RecordRegionEnd(GlobalVariable *V) {
4975 return DD->RecordRegionEnd(V);
4976}
4977
4978/// getRecordSourceLineCount - Count source lines.
4979unsigned DwarfWriter::getRecordSourceLineCount() {
4980 return DD->getRecordSourceLineCount();
4981}