blob: c27bdf1ac64b6087a96e7cc90b7fca6e349ba46b [file] [log] [blame]
Jim Laskeye5032892005-12-21 19:48:16 +00001//===-- llvm/CodeGen/DwarfWriter.cpp - Dwarf Framework ----------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Jim Laskeye5032892005-12-21 19:48:16 +00007//
8//===----------------------------------------------------------------------===//
9//
Jim Laskey072200c2007-01-29 18:51:14 +000010// This file contains support for writing dwarf info into asm files.
Jim Laskeye5032892005-12-21 19:48:16 +000011//
12//===----------------------------------------------------------------------===//
Jim Laskey3ea0e0e2006-01-27 18:32:41 +000013
Jim Laskeyb2efb852006-01-04 22:28:25 +000014#include "llvm/CodeGen/DwarfWriter.h"
Jim Laskey52060a02006-01-24 00:49:18 +000015#include "llvm/Module.h"
Devang Pateld1ca9252009-01-05 23:03:32 +000016#include "llvm/DerivedTypes.h"
Devang Patelcf3a4482009-01-15 23:41:32 +000017#include "llvm/Constants.h"
Jim Laskeya7cea6f2006-01-04 13:52:30 +000018#include "llvm/CodeGen/AsmPrinter.h"
Jim Laskey44c3b9f2007-01-26 21:22:28 +000019#include "llvm/CodeGen/MachineModuleInfo.h"
Jim Laskey41886992006-04-07 16:34:46 +000020#include "llvm/CodeGen/MachineFrameInfo.h"
Jim Laskeyb8509c52006-03-23 18:07:55 +000021#include "llvm/CodeGen/MachineLocation.h"
Devang Patel08f053f2009-01-05 17:57:47 +000022#include "llvm/Analysis/DebugInfo.h"
Jim Laskey3f09fc22007-02-28 18:38:31 +000023#include "llvm/Support/Debug.h"
Jim Laskeyb3e789a2006-01-26 20:21:46 +000024#include "llvm/Support/Dwarf.h"
Jim Laskeya7cea6f2006-01-04 13:52:30 +000025#include "llvm/Support/CommandLine.h"
Jim Laskey65195462006-10-30 13:35:07 +000026#include "llvm/Support/DataTypes.h"
Jim Laskey52060a02006-01-24 00:49:18 +000027#include "llvm/Support/Mangler.h"
Bill Wendling91b8b802009-03-10 20:41:52 +000028#include "llvm/Support/Timer.h"
Owen Andersoncb371882008-08-21 00:14:44 +000029#include "llvm/Support/raw_ostream.h"
Dan Gohman85496362007-09-24 21:32:18 +000030#include "llvm/System/Path.h"
Jim Laskey563321a2006-09-06 18:34:40 +000031#include "llvm/Target/TargetAsmInfo.h"
Dan Gohman6f0d0242008-02-10 18:45:23 +000032#include "llvm/Target/TargetRegisterInfo.h"
Owen Anderson07000c62006-05-12 06:33:49 +000033#include "llvm/Target/TargetData.h"
Jim Laskey1069fbd2006-04-10 23:09:19 +000034#include "llvm/Target/TargetFrameInfo.h"
Duncan Sands53c3a332007-05-16 12:12:23 +000035#include "llvm/Target/TargetInstrInfo.h"
Jim Laskey1b340dc2007-01-29 20:48:32 +000036#include "llvm/Target/TargetMachine.h"
Jim Laskeyc1c47c32007-01-29 23:40:33 +000037#include "llvm/Target/TargetOptions.h"
Evan Chenge3d42322009-02-25 07:04:34 +000038#include "llvm/ADT/DenseMap.h"
39#include "llvm/ADT/FoldingSet.h"
40#include "llvm/ADT/StringExtras.h"
41#include "llvm/ADT/StringMap.h"
Bill Wendlingbdc679d2006-11-29 00:39:47 +000042#include <ostream>
Jim Laskey65195462006-10-30 13:35:07 +000043#include <string>
Jim Laskeyb2efb852006-01-04 22:28:25 +000044using namespace llvm;
Jim Laskey9a777a32006-02-27 22:37:23 +000045using namespace llvm::dwarf;
Jim Laskeya7cea6f2006-01-04 13:52:30 +000046
Devang Pateleb3fc282009-01-08 23:40:34 +000047static RegisterPass<DwarfWriter>
48X("dwarfwriter", "DWARF Information Writer");
49char DwarfWriter::ID = 0;
50
Bill Wendling91b8b802009-03-10 20:41:52 +000051namespace {
52
53static TimerGroup *DwarfTimerGroup = 0;
54static TimerGroup *getDwarfTimerGroup() {
55 if (DwarfTimerGroup) return DwarfTimerGroup;
56 return DwarfTimerGroup = new TimerGroup("Dwarf Exception and Debugging");
57}
58
59} // end anonymous namespace
60
Jim Laskey0d086af2006-02-27 12:43:29 +000061namespace llvm {
Anton Korobeynikovffe31d72008-08-16 12:57:46 +000062
Jim Laskey65195462006-10-30 13:35:07 +000063//===----------------------------------------------------------------------===//
Jim Laskeyef42a012006-11-02 20:12:39 +000064
65/// Configuration values for initial hash set sizes (log2).
66///
Bill Wendlingb9dcef22009-02-03 21:17:20 +000067static const unsigned InitDiesSetSize = 9; // log2(512)
68static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
69static const unsigned InitValuesSetSize = 9; // log2(512)
Jim Laskeyef42a012006-11-02 20:12:39 +000070
71//===----------------------------------------------------------------------===//
72/// Forward declarations.
73///
74class DIE;
75class DIEValue;
76
77//===----------------------------------------------------------------------===//
Devang Pateld1ca9252009-01-05 23:03:32 +000078/// Utility routines.
79///
Devang Patelcf3a4482009-01-15 23:41:32 +000080/// getGlobalVariable - Return either a direct or cast Global value.
81///
82static GlobalVariable *getGlobalVariable(Value *V) {
83 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
84 return GV;
85 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
86 if (CE->getOpcode() == Instruction::BitCast) {
87 return dyn_cast<GlobalVariable>(CE->getOperand(0));
88 } else if (CE->getOpcode() == Instruction::GetElementPtr) {
89 for (unsigned int i=1; i<CE->getNumOperands(); i++) {
90 if (!CE->getOperand(i)->isNullValue())
91 return NULL;
92 }
93 return dyn_cast<GlobalVariable>(CE->getOperand(0));
94 }
95 }
96 return NULL;
97}
98
Devang Pateld1ca9252009-01-05 23:03:32 +000099//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000100/// DWLabel - Labels are used to track locations in the assembler file.
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000101/// Labels appear in the form @verbatim <prefix><Tag><Number> @endverbatim,
102/// where the tag is a category of label (Ex. location) and number is a value
Reid Spencer181b6c92007-08-05 20:06:04 +0000103/// unique in that category.
Jim Laskey65195462006-10-30 13:35:07 +0000104class DWLabel {
105public:
Jim Laskeyef42a012006-11-02 20:12:39 +0000106 /// Tag - Label category tag. Should always be a staticly declared C string.
107 ///
108 const char *Tag;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000109
Jim Laskeyef42a012006-11-02 20:12:39 +0000110 /// Number - Value to make label unique.
111 ///
112 unsigned Number;
Jim Laskey65195462006-10-30 13:35:07 +0000113
114 DWLabel(const char *T, unsigned N) : Tag(T), Number(N) {}
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000115
Jim Laskeyef42a012006-11-02 20:12:39 +0000116 void Profile(FoldingSetNodeID &ID) const {
Evan Chenge3d42322009-02-25 07:04:34 +0000117 ID.AddString(Tag);
Jim Laskeyef42a012006-11-02 20:12:39 +0000118 ID.AddInteger(Number);
Jim Laskey90c79d72006-03-23 23:02:34 +0000119 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000120
Jim Laskeyef42a012006-11-02 20:12:39 +0000121#ifndef NDEBUG
Bill Wendling5c7e3262006-12-17 05:15:13 +0000122 void print(std::ostream *O) const {
123 if (O) print(*O);
Bill Wendlingbdc679d2006-11-29 00:39:47 +0000124 }
Jim Laskeyef42a012006-11-02 20:12:39 +0000125 void print(std::ostream &O) const {
Jim Laskeybacd3042007-02-21 22:48:45 +0000126 O << "." << Tag;
Jim Laskeyef42a012006-11-02 20:12:39 +0000127 if (Number) O << Number;
128 }
129#endif
Jim Laskeybd761842006-02-27 17:27:12 +0000130};
131
132//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000133/// DIEAbbrevData - Dwarf abbreviation data, describes the one attribute of a
134/// Dwarf abbreviation.
Jim Laskey0d086af2006-02-27 12:43:29 +0000135class DIEAbbrevData {
136private:
Jim Laskeyef42a012006-11-02 20:12:39 +0000137 /// Attribute - Dwarf attribute code.
138 ///
139 unsigned Attribute;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000140
Jim Laskeyef42a012006-11-02 20:12:39 +0000141 /// Form - Dwarf form code.
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000142 ///
143 unsigned Form;
144
Jim Laskey0d086af2006-02-27 12:43:29 +0000145public:
146 DIEAbbrevData(unsigned A, unsigned F)
147 : Attribute(A)
148 , Form(F)
149 {}
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000150
Jim Laskeybd761842006-02-27 17:27:12 +0000151 // Accessors.
Jim Laskey0d086af2006-02-27 12:43:29 +0000152 unsigned getAttribute() const { return Attribute; }
153 unsigned getForm() const { return Form; }
Jim Laskey063e7652006-01-17 17:31:53 +0000154
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000155 /// Profile - Used to gather unique data for the abbreviation folding set.
Jim Laskey0d086af2006-02-27 12:43:29 +0000156 ///
Jim Laskeyef42a012006-11-02 20:12:39 +0000157 void Profile(FoldingSetNodeID &ID)const {
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000158 ID.AddInteger(Attribute);
159 ID.AddInteger(Form);
Jim Laskey0d086af2006-02-27 12:43:29 +0000160 }
161};
Jim Laskey063e7652006-01-17 17:31:53 +0000162
Jim Laskey0d086af2006-02-27 12:43:29 +0000163//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000164/// DIEAbbrev - Dwarf abbreviation, describes the organization of a debug
165/// information object.
166class DIEAbbrev : public FoldingSetNode {
Jim Laskey0d086af2006-02-27 12:43:29 +0000167private:
Jim Laskeyef42a012006-11-02 20:12:39 +0000168 /// Tag - Dwarf tag code.
169 ///
170 unsigned Tag;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000171
Jim Laskeyef42a012006-11-02 20:12:39 +0000172 /// Unique number for node.
173 ///
174 unsigned Number;
175
176 /// ChildrenFlag - Dwarf children flag.
177 ///
178 unsigned ChildrenFlag;
179
180 /// Data - Raw data bytes for abbreviation.
181 ///
Owen Anderson873e1b52008-06-24 21:44:59 +0000182 SmallVector<DIEAbbrevData, 8> Data;
Jim Laskey063e7652006-01-17 17:31:53 +0000183
Jim Laskey0d086af2006-02-27 12:43:29 +0000184public:
Jim Laskey063e7652006-01-17 17:31:53 +0000185
Jim Laskey0d086af2006-02-27 12:43:29 +0000186 DIEAbbrev(unsigned T, unsigned C)
Jim Laskeyef42a012006-11-02 20:12:39 +0000187 : Tag(T)
Jim Laskey0d086af2006-02-27 12:43:29 +0000188 , ChildrenFlag(C)
189 , Data()
190 {}
191 ~DIEAbbrev() {}
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000192
Jim Laskeybd761842006-02-27 17:27:12 +0000193 // Accessors.
Jim Laskey0d086af2006-02-27 12:43:29 +0000194 unsigned getTag() const { return Tag; }
Jim Laskeyef42a012006-11-02 20:12:39 +0000195 unsigned getNumber() const { return Number; }
Jim Laskey0d086af2006-02-27 12:43:29 +0000196 unsigned getChildrenFlag() const { return ChildrenFlag; }
Owen Anderson873e1b52008-06-24 21:44:59 +0000197 const SmallVector<DIEAbbrevData, 8> &getData() const { return Data; }
Jim Laskeyef42a012006-11-02 20:12:39 +0000198 void setTag(unsigned T) { Tag = T; }
Jim Laskey0d086af2006-02-27 12:43:29 +0000199 void setChildrenFlag(unsigned CF) { ChildrenFlag = CF; }
Jim Laskeyef42a012006-11-02 20:12:39 +0000200 void setNumber(unsigned N) { Number = N; }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000201
Jim Laskey0d086af2006-02-27 12:43:29 +0000202 /// AddAttribute - Adds another set of attribute information to the
203 /// abbreviation.
204 void AddAttribute(unsigned Attribute, unsigned Form) {
205 Data.push_back(DIEAbbrevData(Attribute, Form));
Jim Laskey063e7652006-01-17 17:31:53 +0000206 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000207
Jim Laskeyb8509c52006-03-23 18:07:55 +0000208 /// AddFirstAttribute - Adds a set of attribute information to the front
209 /// of the abbreviation.
210 void AddFirstAttribute(unsigned Attribute, unsigned Form) {
211 Data.insert(Data.begin(), DIEAbbrevData(Attribute, Form));
212 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000213
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000214 /// Profile - Used to gather unique data for the abbreviation folding set.
215 ///
216 void Profile(FoldingSetNodeID &ID) {
217 ID.AddInteger(Tag);
218 ID.AddInteger(ChildrenFlag);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000219
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000220 // For each attribute description.
221 for (unsigned i = 0, N = Data.size(); i < N; ++i)
222 Data[i].Profile(ID);
223 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000224
Jim Laskey0d086af2006-02-27 12:43:29 +0000225 /// Emit - Print the abbreviation using the specified Dwarf writer.
226 ///
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000227 void Emit(const DwarfDebug &DD) const;
228
Jim Laskey0d086af2006-02-27 12:43:29 +0000229#ifndef NDEBUG
Bill Wendling5c7e3262006-12-17 05:15:13 +0000230 void print(std::ostream *O) {
231 if (O) print(*O);
Bill Wendlingbdc679d2006-11-29 00:39:47 +0000232 }
Jim Laskey0d086af2006-02-27 12:43:29 +0000233 void print(std::ostream &O);
234 void dump();
235#endif
236};
Jim Laskey063e7652006-01-17 17:31:53 +0000237
Jim Laskey0d086af2006-02-27 12:43:29 +0000238//===----------------------------------------------------------------------===//
Jim Laskeyef42a012006-11-02 20:12:39 +0000239/// DIE - A structured debug information entry. Has an abbreviation which
240/// describes it's organization.
241class DIE : public FoldingSetNode {
242protected:
243 /// Abbrev - Buffer for constructing abbreviation.
244 ///
245 DIEAbbrev Abbrev;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000246
Jim Laskeyef42a012006-11-02 20:12:39 +0000247 /// Offset - Offset in debug info section.
248 ///
249 unsigned Offset;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000250
Jim Laskeyef42a012006-11-02 20:12:39 +0000251 /// Size - Size of instance + children.
252 ///
253 unsigned Size;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000254
Jim Laskeyef42a012006-11-02 20:12:39 +0000255 /// Children DIEs.
256 ///
257 std::vector<DIE *> Children;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000258
Jim Laskeyef42a012006-11-02 20:12:39 +0000259 /// Attributes values.
260 ///
Owen Anderson873e1b52008-06-24 21:44:59 +0000261 SmallVector<DIEValue*, 32> Values;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000262
Jim Laskeyef42a012006-11-02 20:12:39 +0000263public:
Dan Gohman81975f62007-08-27 14:50:10 +0000264 explicit DIE(unsigned Tag)
Jim Laskeyef42a012006-11-02 20:12:39 +0000265 : Abbrev(Tag, DW_CHILDREN_no)
266 , Offset(0)
267 , Size(0)
268 , Children()
269 , Values()
270 {}
271 virtual ~DIE();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000272
Jim Laskeyef42a012006-11-02 20:12:39 +0000273 // Accessors.
274 DIEAbbrev &getAbbrev() { return Abbrev; }
275 unsigned getAbbrevNumber() const {
276 return Abbrev.getNumber();
277 }
Jim Laskey85f419b2006-11-09 16:32:26 +0000278 unsigned getTag() const { return Abbrev.getTag(); }
Jim Laskeyef42a012006-11-02 20:12:39 +0000279 unsigned getOffset() const { return Offset; }
280 unsigned getSize() const { return Size; }
281 const std::vector<DIE *> &getChildren() const { return Children; }
Owen Anderson873e1b52008-06-24 21:44:59 +0000282 SmallVector<DIEValue*, 32> &getValues() { return Values; }
Jim Laskeyef42a012006-11-02 20:12:39 +0000283 void setTag(unsigned Tag) { Abbrev.setTag(Tag); }
284 void setOffset(unsigned O) { Offset = O; }
285 void setSize(unsigned S) { Size = S; }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000286
Jim Laskeyef42a012006-11-02 20:12:39 +0000287 /// AddValue - Add a value and attributes to a DIE.
288 ///
289 void AddValue(unsigned Attribute, unsigned Form, DIEValue *Value) {
290 Abbrev.AddAttribute(Attribute, Form);
291 Values.push_back(Value);
292 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000293
Jim Laskeyef42a012006-11-02 20:12:39 +0000294 /// SiblingOffset - Return the offset of the debug information entry's
295 /// sibling.
296 unsigned SiblingOffset() const { return Offset + Size; }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000297
Jim Laskeyef42a012006-11-02 20:12:39 +0000298 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
299 ///
300 void AddSiblingOffset();
301
302 /// AddChild - Add a child to the DIE.
303 ///
304 void AddChild(DIE *Child) {
305 Abbrev.setChildrenFlag(DW_CHILDREN_yes);
306 Children.push_back(Child);
307 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000308
Jim Laskeyef42a012006-11-02 20:12:39 +0000309 /// Detach - Detaches objects connected to it after copying.
310 ///
311 void Detach() {
312 Children.clear();
313 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000314
Jim Laskeyef42a012006-11-02 20:12:39 +0000315 /// Profile - Used to gather unique data for the value folding set.
316 ///
317 void Profile(FoldingSetNodeID &ID) ;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000318
Jim Laskeyef42a012006-11-02 20:12:39 +0000319#ifndef NDEBUG
Bill Wendling5c7e3262006-12-17 05:15:13 +0000320 void print(std::ostream *O, unsigned IncIndent = 0) {
321 if (O) print(*O, IncIndent);
Bill Wendlingbdc679d2006-11-29 00:39:47 +0000322 }
Jim Laskeyef42a012006-11-02 20:12:39 +0000323 void print(std::ostream &O, unsigned IncIndent = 0);
324 void dump();
325#endif
326};
327
328//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000329/// DIEValue - A debug information entry value.
Jim Laskeyef42a012006-11-02 20:12:39 +0000330///
331class DIEValue : public FoldingSetNode {
Jim Laskey0d086af2006-02-27 12:43:29 +0000332public:
333 enum {
334 isInteger,
335 isString,
336 isLabel,
337 isAsIsLabel,
Argyrios Kyrtzidisf7acf8f2008-06-18 19:27:37 +0000338 isSectionOffset,
Jim Laskey0d086af2006-02-27 12:43:29 +0000339 isDelta,
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000340 isEntry,
341 isBlock
Jim Laskey0d086af2006-02-27 12:43:29 +0000342 };
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000343
Jim Laskeyef42a012006-11-02 20:12:39 +0000344 /// Type - Type of data stored in the value.
345 ///
346 unsigned Type;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000347
Dan Gohman81975f62007-08-27 14:50:10 +0000348 explicit DIEValue(unsigned T)
Jim Laskeyef42a012006-11-02 20:12:39 +0000349 : Type(T)
Jim Laskeyef42a012006-11-02 20:12:39 +0000350 {}
Jim Laskey0d086af2006-02-27 12:43:29 +0000351 virtual ~DIEValue() {}
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000352
Jim Laskeyf6733882006-11-02 21:48:18 +0000353 // Accessors
Jim Laskeyef42a012006-11-02 20:12:39 +0000354 unsigned getType() const { return Type; }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000355
Jim Laskey0d086af2006-02-27 12:43:29 +0000356 // Implement isa/cast/dyncast.
357 static bool classof(const DIEValue *) { return true; }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000358
Jim Laskey0d086af2006-02-27 12:43:29 +0000359 /// EmitValue - Emit value via the Dwarf writer.
360 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000361 virtual void EmitValue(DwarfDebug &DD, unsigned Form) = 0;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000362
Jim Laskey0d086af2006-02-27 12:43:29 +0000363 /// SizeOf - Return the size of a value in bytes.
364 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000365 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const = 0;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000366
Jim Laskeyef42a012006-11-02 20:12:39 +0000367 /// Profile - Used to gather unique data for the value folding set.
368 ///
369 virtual void Profile(FoldingSetNodeID &ID) = 0;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000370
Jim Laskeyef42a012006-11-02 20:12:39 +0000371#ifndef NDEBUG
Bill Wendling5c7e3262006-12-17 05:15:13 +0000372 void print(std::ostream *O) {
373 if (O) print(*O);
Bill Wendlingbdc679d2006-11-29 00:39:47 +0000374 }
Jim Laskeyef42a012006-11-02 20:12:39 +0000375 virtual void print(std::ostream &O) = 0;
376 void dump();
377#endif
Jim Laskey0d086af2006-02-27 12:43:29 +0000378};
Jim Laskey063e7652006-01-17 17:31:53 +0000379
Jim Laskey0d086af2006-02-27 12:43:29 +0000380//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000381/// DWInteger - An integer value DIE.
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000382///
Jim Laskey0d086af2006-02-27 12:43:29 +0000383class DIEInteger : public DIEValue {
384private:
385 uint64_t Integer;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000386
Jim Laskey0d086af2006-02-27 12:43:29 +0000387public:
Dan Gohman81975f62007-08-27 14:50:10 +0000388 explicit DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
Jim Laskey063e7652006-01-17 17:31:53 +0000389
Jim Laskey0d086af2006-02-27 12:43:29 +0000390 // Implement isa/cast/dyncast.
391 static bool classof(const DIEInteger *) { return true; }
392 static bool classof(const DIEValue *I) { return I->Type == isInteger; }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000393
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000394 /// BestForm - Choose the best form for integer.
395 ///
Jim Laskeyef42a012006-11-02 20:12:39 +0000396 static unsigned BestForm(bool IsSigned, uint64_t Integer) {
397 if (IsSigned) {
398 if ((char)Integer == (signed)Integer) return DW_FORM_data1;
399 if ((short)Integer == (signed)Integer) return DW_FORM_data2;
400 if ((int)Integer == (signed)Integer) return DW_FORM_data4;
401 } else {
402 if ((unsigned char)Integer == Integer) return DW_FORM_data1;
403 if ((unsigned short)Integer == Integer) return DW_FORM_data2;
404 if ((unsigned int)Integer == Integer) return DW_FORM_data4;
405 }
406 return DW_FORM_data8;
407 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000408
Jim Laskey0d086af2006-02-27 12:43:29 +0000409 /// EmitValue - Emit integer of appropriate size.
410 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000411 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000412
Jim Laskey0d086af2006-02-27 12:43:29 +0000413 /// SizeOf - Determine size of integer value in bytes.
414 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000415 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000416
Jim Laskeyef42a012006-11-02 20:12:39 +0000417 /// Profile - Used to gather unique data for the value folding set.
418 ///
Jim Laskey5496f012006-11-09 14:52:14 +0000419 static void Profile(FoldingSetNodeID &ID, unsigned Integer) {
Jim Laskeyf6733882006-11-02 21:48:18 +0000420 ID.AddInteger(isInteger);
Jim Laskeyef42a012006-11-02 20:12:39 +0000421 ID.AddInteger(Integer);
422 }
Jim Laskey5496f012006-11-09 14:52:14 +0000423 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Integer); }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000424
Jim Laskeyef42a012006-11-02 20:12:39 +0000425#ifndef NDEBUG
426 virtual void print(std::ostream &O) {
427 O << "Int: " << (int64_t)Integer
428 << " 0x" << std::hex << Integer << std::dec;
429 }
430#endif
Jim Laskey0d086af2006-02-27 12:43:29 +0000431};
Jim Laskey063e7652006-01-17 17:31:53 +0000432
Jim Laskey0d086af2006-02-27 12:43:29 +0000433//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000434/// DIEString - A string value DIE.
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000435///
Jim Laskeyef42a012006-11-02 20:12:39 +0000436class DIEString : public DIEValue {
437public:
Jim Laskey0d086af2006-02-27 12:43:29 +0000438 const std::string String;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000439
Dan Gohman81975f62007-08-27 14:50:10 +0000440 explicit DIEString(const std::string &S) : DIEValue(isString), String(S) {}
Jim Laskey063e7652006-01-17 17:31:53 +0000441
Jim Laskey0d086af2006-02-27 12:43:29 +0000442 // Implement isa/cast/dyncast.
443 static bool classof(const DIEString *) { return true; }
444 static bool classof(const DIEValue *S) { return S->Type == isString; }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000445
Jim Laskey0d086af2006-02-27 12:43:29 +0000446 /// EmitValue - Emit string value.
447 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000448 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000449
Jim Laskey0d086af2006-02-27 12:43:29 +0000450 /// SizeOf - Determine size of string value in bytes.
451 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000452 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
Jim Laskeyef42a012006-11-02 20:12:39 +0000453 return String.size() + sizeof(char); // sizeof('\0');
454 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000455
Jim Laskeyef42a012006-11-02 20:12:39 +0000456 /// Profile - Used to gather unique data for the value folding set.
457 ///
Jim Laskey5496f012006-11-09 14:52:14 +0000458 static void Profile(FoldingSetNodeID &ID, const std::string &String) {
Jim Laskeyf6733882006-11-02 21:48:18 +0000459 ID.AddInteger(isString);
Jim Laskeyef42a012006-11-02 20:12:39 +0000460 ID.AddString(String);
461 }
Jim Laskey5496f012006-11-09 14:52:14 +0000462 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, String); }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000463
Jim Laskeyef42a012006-11-02 20:12:39 +0000464#ifndef NDEBUG
465 virtual void print(std::ostream &O) {
466 O << "Str: \"" << String << "\"";
467 }
468#endif
Jim Laskey0d086af2006-02-27 12:43:29 +0000469};
Jim Laskey063e7652006-01-17 17:31:53 +0000470
Jim Laskey0d086af2006-02-27 12:43:29 +0000471//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000472/// DIEDwarfLabel - A Dwarf internal label expression DIE.
Jim Laskey0d086af2006-02-27 12:43:29 +0000473//
Jim Laskeyef42a012006-11-02 20:12:39 +0000474class DIEDwarfLabel : public DIEValue {
475public:
476
Jim Laskey0d086af2006-02-27 12:43:29 +0000477 const DWLabel Label;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000478
Dan Gohman81975f62007-08-27 14:50:10 +0000479 explicit DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {}
Jim Laskey063e7652006-01-17 17:31:53 +0000480
Jim Laskey0d086af2006-02-27 12:43:29 +0000481 // Implement isa/cast/dyncast.
482 static bool classof(const DIEDwarfLabel *) { return true; }
483 static bool classof(const DIEValue *L) { return L->Type == isLabel; }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000484
Jim Laskey0d086af2006-02-27 12:43:29 +0000485 /// EmitValue - Emit label value.
486 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000487 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000488
Jim Laskey0d086af2006-02-27 12:43:29 +0000489 /// SizeOf - Determine size of label value in bytes.
490 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000491 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000492
Jim Laskeyef42a012006-11-02 20:12:39 +0000493 /// Profile - Used to gather unique data for the value folding set.
494 ///
Jim Laskey5496f012006-11-09 14:52:14 +0000495 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label) {
Jim Laskeyf6733882006-11-02 21:48:18 +0000496 ID.AddInteger(isLabel);
Jim Laskeyef42a012006-11-02 20:12:39 +0000497 Label.Profile(ID);
498 }
Jim Laskey5496f012006-11-09 14:52:14 +0000499 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000500
Jim Laskeyef42a012006-11-02 20:12:39 +0000501#ifndef NDEBUG
502 virtual void print(std::ostream &O) {
503 O << "Lbl: ";
504 Label.print(O);
505 }
506#endif
Jim Laskey0d086af2006-02-27 12:43:29 +0000507};
Jim Laskey063e7652006-01-17 17:31:53 +0000508
Jim Laskey063e7652006-01-17 17:31:53 +0000509
Jim Laskey0d086af2006-02-27 12:43:29 +0000510//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000511/// DIEObjectLabel - A label to an object in code or data.
Jim Laskey0d086af2006-02-27 12:43:29 +0000512//
Jim Laskeyef42a012006-11-02 20:12:39 +0000513class DIEObjectLabel : public DIEValue {
514public:
Jim Laskey0d086af2006-02-27 12:43:29 +0000515 const std::string Label;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000516
Dan Gohman81975f62007-08-27 14:50:10 +0000517 explicit DIEObjectLabel(const std::string &L)
518 : DIEValue(isAsIsLabel), Label(L) {}
Jim Laskey063e7652006-01-17 17:31:53 +0000519
Jim Laskey0d086af2006-02-27 12:43:29 +0000520 // Implement isa/cast/dyncast.
521 static bool classof(const DIEObjectLabel *) { return true; }
522 static bool classof(const DIEValue *L) { return L->Type == isAsIsLabel; }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000523
Jim Laskey0d086af2006-02-27 12:43:29 +0000524 /// EmitValue - Emit label value.
525 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000526 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000527
Jim Laskey0d086af2006-02-27 12:43:29 +0000528 /// SizeOf - Determine size of label value in bytes.
529 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000530 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000531
Jim Laskeyef42a012006-11-02 20:12:39 +0000532 /// Profile - Used to gather unique data for the value folding set.
533 ///
Jim Laskey5496f012006-11-09 14:52:14 +0000534 static void Profile(FoldingSetNodeID &ID, const std::string &Label) {
Jim Laskeyf6733882006-11-02 21:48:18 +0000535 ID.AddInteger(isAsIsLabel);
Jim Laskeyef42a012006-11-02 20:12:39 +0000536 ID.AddString(Label);
537 }
Evan Chenge3d42322009-02-25 07:04:34 +0000538 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label.c_str()); }
Jim Laskeyef42a012006-11-02 20:12:39 +0000539
540#ifndef NDEBUG
541 virtual void print(std::ostream &O) {
542 O << "Obj: " << Label;
543 }
544#endif
Jim Laskey0d086af2006-02-27 12:43:29 +0000545};
Jim Laskey063e7652006-01-17 17:31:53 +0000546
Jim Laskey0d086af2006-02-27 12:43:29 +0000547//===----------------------------------------------------------------------===//
Argyrios Kyrtzidisf7acf8f2008-06-18 19:27:37 +0000548/// DIESectionOffset - A section offset DIE.
549//
550class DIESectionOffset : public DIEValue {
551public:
552 const DWLabel Label;
553 const DWLabel Section;
554 bool IsEH : 1;
555 bool UseSet : 1;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000556
Argyrios Kyrtzidisf7acf8f2008-06-18 19:27:37 +0000557 DIESectionOffset(const DWLabel &Lab, const DWLabel &Sec,
558 bool isEH = false, bool useSet = true)
559 : DIEValue(isSectionOffset), Label(Lab), Section(Sec),
560 IsEH(isEH), UseSet(useSet) {}
561
562 // Implement isa/cast/dyncast.
563 static bool classof(const DIESectionOffset *) { return true; }
564 static bool classof(const DIEValue *D) { return D->Type == isSectionOffset; }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000565
Argyrios Kyrtzidisf7acf8f2008-06-18 19:27:37 +0000566 /// EmitValue - Emit section offset.
567 ///
568 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000569
Argyrios Kyrtzidisf7acf8f2008-06-18 19:27:37 +0000570 /// SizeOf - Determine size of section offset value in bytes.
571 ///
572 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000573
Argyrios Kyrtzidisf7acf8f2008-06-18 19:27:37 +0000574 /// Profile - Used to gather unique data for the value folding set.
575 ///
576 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label,
577 const DWLabel &Section) {
578 ID.AddInteger(isSectionOffset);
579 Label.Profile(ID);
580 Section.Profile(ID);
581 // IsEH and UseSet are specific to the Label/Section that we will emit
582 // the offset for; so Label/Section are enough for uniqueness.
583 }
584 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label, Section); }
585
586#ifndef NDEBUG
587 virtual void print(std::ostream &O) {
588 O << "Off: ";
589 Label.print(O);
590 O << "-";
591 Section.print(O);
592 O << "-" << IsEH << "-" << UseSet;
593 }
594#endif
595};
596
597//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000598/// DIEDelta - A simple label difference DIE.
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000599///
Jim Laskeyef42a012006-11-02 20:12:39 +0000600class DIEDelta : public DIEValue {
601public:
Jim Laskey0d086af2006-02-27 12:43:29 +0000602 const DWLabel LabelHi;
603 const DWLabel LabelLo;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000604
Jim Laskey0d086af2006-02-27 12:43:29 +0000605 DIEDelta(const DWLabel &Hi, const DWLabel &Lo)
606 : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
Jim Laskey063e7652006-01-17 17:31:53 +0000607
Jim Laskey0d086af2006-02-27 12:43:29 +0000608 // Implement isa/cast/dyncast.
609 static bool classof(const DIEDelta *) { return true; }
610 static bool classof(const DIEValue *D) { return D->Type == isDelta; }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000611
Jim Laskey0d086af2006-02-27 12:43:29 +0000612 /// EmitValue - Emit delta value.
613 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000614 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000615
Jim Laskey0d086af2006-02-27 12:43:29 +0000616 /// SizeOf - Determine size of delta value in bytes.
617 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000618 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000619
Jim Laskeyef42a012006-11-02 20:12:39 +0000620 /// Profile - Used to gather unique data for the value folding set.
621 ///
Jim Laskey5496f012006-11-09 14:52:14 +0000622 static void Profile(FoldingSetNodeID &ID, const DWLabel &LabelHi,
623 const DWLabel &LabelLo) {
Jim Laskeyf6733882006-11-02 21:48:18 +0000624 ID.AddInteger(isDelta);
Jim Laskeyef42a012006-11-02 20:12:39 +0000625 LabelHi.Profile(ID);
626 LabelLo.Profile(ID);
627 }
Jim Laskey5496f012006-11-09 14:52:14 +0000628 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, LabelHi, LabelLo); }
Jim Laskeyef42a012006-11-02 20:12:39 +0000629
630#ifndef NDEBUG
631 virtual void print(std::ostream &O) {
632 O << "Del: ";
633 LabelHi.print(O);
634 O << "-";
635 LabelLo.print(O);
636 }
637#endif
Jim Laskey0d086af2006-02-27 12:43:29 +0000638};
Jim Laskey063e7652006-01-17 17:31:53 +0000639
Jim Laskey0d086af2006-02-27 12:43:29 +0000640//===----------------------------------------------------------------------===//
Jim Laskeyef42a012006-11-02 20:12:39 +0000641/// DIEntry - A pointer to another debug information entry. An instance of this
642/// class can also be used as a proxy for a debug information entry not yet
643/// defined (ie. types.)
644class DIEntry : public DIEValue {
645public:
Jim Laskey0d086af2006-02-27 12:43:29 +0000646 DIE *Entry;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000647
Dan Gohman81975f62007-08-27 14:50:10 +0000648 explicit DIEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000649
Jim Laskey0d086af2006-02-27 12:43:29 +0000650 // Implement isa/cast/dyncast.
651 static bool classof(const DIEntry *) { return true; }
652 static bool classof(const DIEValue *E) { return E->Type == isEntry; }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000653
Jim Laskeyb8509c52006-03-23 18:07:55 +0000654 /// EmitValue - Emit debug information entry offset.
Jim Laskey0d086af2006-02-27 12:43:29 +0000655 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000656 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000657
Jim Laskeyb8509c52006-03-23 18:07:55 +0000658 /// SizeOf - Determine size of debug information entry in bytes.
Jim Laskey0d086af2006-02-27 12:43:29 +0000659 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000660 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
Jim Laskeyef42a012006-11-02 20:12:39 +0000661 return sizeof(int32_t);
662 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000663
Jim Laskeyef42a012006-11-02 20:12:39 +0000664 /// Profile - Used to gather unique data for the value folding set.
665 ///
Jim Laskey5496f012006-11-09 14:52:14 +0000666 static void Profile(FoldingSetNodeID &ID, DIE *Entry) {
667 ID.AddInteger(isEntry);
668 ID.AddPointer(Entry);
669 }
Jim Laskeyef42a012006-11-02 20:12:39 +0000670 virtual void Profile(FoldingSetNodeID &ID) {
Jim Laskeyf6733882006-11-02 21:48:18 +0000671 ID.AddInteger(isEntry);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000672
Jim Laskeyef42a012006-11-02 20:12:39 +0000673 if (Entry) {
674 ID.AddPointer(Entry);
675 } else {
676 ID.AddPointer(this);
677 }
678 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000679
Jim Laskeyef42a012006-11-02 20:12:39 +0000680#ifndef NDEBUG
681 virtual void print(std::ostream &O) {
682 O << "Die: 0x" << std::hex << (intptr_t)Entry << std::dec;
683 }
684#endif
Jim Laskey0d086af2006-02-27 12:43:29 +0000685};
686
687//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000688/// DIEBlock - A block of values. Primarily used for location expressions.
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000689//
Jim Laskeyef42a012006-11-02 20:12:39 +0000690class DIEBlock : public DIEValue, public DIE {
691public:
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000692 unsigned Size; // Size in bytes excluding size header.
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000693
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000694 DIEBlock()
695 : DIEValue(isBlock)
Jim Laskeyef42a012006-11-02 20:12:39 +0000696 , DIE(0)
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000697 , Size(0)
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000698 {}
Jim Laskeyef42a012006-11-02 20:12:39 +0000699 ~DIEBlock() {
700 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000701
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000702 // Implement isa/cast/dyncast.
703 static bool classof(const DIEBlock *) { return true; }
704 static bool classof(const DIEValue *E) { return E->Type == isBlock; }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000705
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000706 /// ComputeSize - calculate the size of the block.
707 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000708 unsigned ComputeSize(DwarfDebug &DD);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000709
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000710 /// BestForm - Choose the best form for data.
711 ///
Jim Laskeyef42a012006-11-02 20:12:39 +0000712 unsigned BestForm() const {
713 if ((unsigned char)Size == Size) return DW_FORM_block1;
714 if ((unsigned short)Size == Size) return DW_FORM_block2;
715 if ((unsigned int)Size == Size) return DW_FORM_block4;
716 return DW_FORM_block;
717 }
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000718
719 /// EmitValue - Emit block data.
720 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000721 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000722
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000723 /// SizeOf - Determine size of block data in bytes.
724 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000725 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000726
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000727
Jim Laskeyef42a012006-11-02 20:12:39 +0000728 /// Profile - Used to gather unique data for the value folding set.
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000729 ///
Reid Spencer97821312006-11-02 23:56:21 +0000730 virtual void Profile(FoldingSetNodeID &ID) {
Jim Laskeyf6733882006-11-02 21:48:18 +0000731 ID.AddInteger(isBlock);
Jim Laskeyef42a012006-11-02 20:12:39 +0000732 DIE::Profile(ID);
733 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000734
Jim Laskeyef42a012006-11-02 20:12:39 +0000735#ifndef NDEBUG
736 virtual void print(std::ostream &O) {
737 O << "Blk: ";
738 DIE::print(O, 5);
739 }
740#endif
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000741};
742
743//===----------------------------------------------------------------------===//
Jim Laskeyef42a012006-11-02 20:12:39 +0000744/// CompileUnit - This dwarf writer support class manages information associate
745/// with a source file.
746class CompileUnit {
Jim Laskey0d086af2006-02-27 12:43:29 +0000747private:
Jim Laskeyef42a012006-11-02 20:12:39 +0000748 /// ID - File identifier for source.
749 ///
750 unsigned ID;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000751
Jim Laskeyef42a012006-11-02 20:12:39 +0000752 /// Die - Compile unit debug information entry.
753 ///
754 DIE *Die;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000755
Devang Patelbbdc8202009-01-13 23:54:55 +0000756 /// GVToDieMap - Tracks the mapping of unit level debug informaton
757 /// variables to debug information entries.
Devang Patelc2997f42009-01-20 00:58:55 +0000758 std::map<GlobalVariable *, DIE *> GVToDieMap;
Jim Laskeyef42a012006-11-02 20:12:39 +0000759
Devang Patelbbdc8202009-01-13 23:54:55 +0000760 /// GVToDIEntryMap - Tracks the mapping of unit level debug informaton
Jim Laskeyef42a012006-11-02 20:12:39 +0000761 /// descriptors to debug information entries using a DIEntry proxy.
Devang Patelc2997f42009-01-20 00:58:55 +0000762 std::map<GlobalVariable *, DIEntry *> GVToDIEntryMap;
Jim Laskeyef42a012006-11-02 20:12:39 +0000763
764 /// Globals - A map of globally visible named entities for this unit.
765 ///
766 std::map<std::string, DIE *> Globals;
767
768 /// DiesSet - Used to uniquely define dies within the compile unit.
769 ///
770 FoldingSet<DIE> DiesSet;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000771
Jim Laskey0d086af2006-02-27 12:43:29 +0000772public:
Devang Pateld1ca9252009-01-05 23:03:32 +0000773 CompileUnit(unsigned I, DIE *D)
Devang Patelbbdc8202009-01-13 23:54:55 +0000774 : ID(I), Die(D), GVToDieMap(),
Devang Patel7e55b3a2009-01-17 06:51:37 +0000775 GVToDIEntryMap(), Globals(), DiesSet(InitDiesSetSize)
Devang Pateld1ca9252009-01-05 23:03:32 +0000776 {}
777
Jim Laskeyef42a012006-11-02 20:12:39 +0000778 ~CompileUnit() {
779 delete Die;
Jim Laskeyef42a012006-11-02 20:12:39 +0000780 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000781
Jim Laskeybd761842006-02-27 17:27:12 +0000782 // Accessors.
Jim Laskeyef42a012006-11-02 20:12:39 +0000783 unsigned getID() const { return ID; }
784 DIE* getDie() const { return Die; }
785 std::map<std::string, DIE *> &getGlobals() { return Globals; }
786
787 /// hasContent - Return true if this compile unit has something to write out.
788 ///
789 bool hasContent() const {
790 return !Die->getChildren().empty();
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000791 }
Jim Laskeyef42a012006-11-02 20:12:39 +0000792
793 /// AddGlobal - Add a new global entity to the compile unit.
794 ///
795 void AddGlobal(const std::string &Name, DIE *Die) {
796 Globals[Name] = Die;
797 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000798
Jim Laskeyef42a012006-11-02 20:12:39 +0000799 /// getDieMapSlotFor - Returns the debug information entry map slot for the
Devang Patelbbdc8202009-01-13 23:54:55 +0000800 /// specified debug variable.
Devang Patel48d190f2009-01-05 21:47:57 +0000801 DIE *&getDieMapSlotFor(GlobalVariable *GV) {
802 return GVToDieMap[GV];
803 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000804
Jim Laskeyef42a012006-11-02 20:12:39 +0000805 /// getDIEntrySlotFor - Returns the debug information entry proxy slot for the
Devang Patelbbdc8202009-01-13 23:54:55 +0000806 /// specified debug variable.
Devang Patel48d190f2009-01-05 21:47:57 +0000807 DIEntry *&getDIEntrySlotFor(GlobalVariable *GV) {
808 return GVToDIEntryMap[GV];
809 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000810
Jim Laskeyef42a012006-11-02 20:12:39 +0000811 /// AddDie - Adds or interns the DIE to the compile unit.
812 ///
813 DIE *AddDie(DIE &Buffer) {
814 FoldingSetNodeID ID;
815 Buffer.Profile(ID);
816 void *Where;
817 DIE *Die = DiesSet.FindNodeOrInsertPos(ID, Where);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000818
Jim Laskeyef42a012006-11-02 20:12:39 +0000819 if (!Die) {
820 Die = new DIE(Buffer);
821 DiesSet.InsertNode(Die, Where);
822 this->Die->AddChild(Die);
823 Buffer.Detach();
824 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000825
Jim Laskeyef42a012006-11-02 20:12:39 +0000826 return Die;
827 }
Jim Laskey0d086af2006-02-27 12:43:29 +0000828};
829
Jim Laskey65195462006-10-30 13:35:07 +0000830//===----------------------------------------------------------------------===//
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000831/// Dwarf - Emits general Dwarf directives.
Jim Laskeyef42a012006-11-02 20:12:39 +0000832///
Jim Laskey65195462006-10-30 13:35:07 +0000833class Dwarf {
Jim Laskey072200c2007-01-29 18:51:14 +0000834protected:
Jim Laskey65195462006-10-30 13:35:07 +0000835 //===--------------------------------------------------------------------===//
Jim Laskey072200c2007-01-29 18:51:14 +0000836 // Core attributes used by the Dwarf writer.
Jim Laskey65195462006-10-30 13:35:07 +0000837 //
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000838
Jim Laskey65195462006-10-30 13:35:07 +0000839 //
840 /// O - Stream to .s file.
841 ///
Owen Andersoncb371882008-08-21 00:14:44 +0000842 raw_ostream &O;
Jim Laskey65195462006-10-30 13:35:07 +0000843
844 /// Asm - Target of Dwarf emission.
845 ///
846 AsmPrinter *Asm;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000847
Bill Wendlingaa8f8882008-07-01 23:34:48 +0000848 /// TAI - Target asm information.
Jim Laskey65195462006-10-30 13:35:07 +0000849 const TargetAsmInfo *TAI;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000850
Jim Laskey65195462006-10-30 13:35:07 +0000851 /// TD - Target data.
852 const TargetData *TD;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000853
Jim Laskey65195462006-10-30 13:35:07 +0000854 /// RI - Register Information.
Dan Gohman6f0d0242008-02-10 18:45:23 +0000855 const TargetRegisterInfo *RI;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000856
Jim Laskey65195462006-10-30 13:35:07 +0000857 /// M - Current module.
858 ///
859 Module *M;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000860
Jim Laskey65195462006-10-30 13:35:07 +0000861 /// MF - Current machine function.
862 ///
863 MachineFunction *MF;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000864
Jim Laskey44c3b9f2007-01-26 21:22:28 +0000865 /// MMI - Collected machine module information.
Jim Laskey65195462006-10-30 13:35:07 +0000866 ///
Jim Laskey44c3b9f2007-01-26 21:22:28 +0000867 MachineModuleInfo *MMI;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000868
Jim Laskey65195462006-10-30 13:35:07 +0000869 /// SubprogramCount - The running count of functions being compiled.
870 ///
871 unsigned SubprogramCount;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000872
Chris Lattner9251f132007-09-24 03:35:37 +0000873 /// Flavor - A unique string indicating what dwarf producer this is, used to
874 /// unique labels.
875 const char * const Flavor;
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000876
877 unsigned SetCounter;
Owen Andersoncb371882008-08-21 00:14:44 +0000878 Dwarf(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T,
Chris Lattner9251f132007-09-24 03:35:37 +0000879 const char *flavor)
Jim Laskey072200c2007-01-29 18:51:14 +0000880 : O(OS)
881 , Asm(A)
882 , TAI(T)
883 , TD(Asm->TM.getTargetData())
884 , RI(Asm->TM.getRegisterInfo())
885 , M(NULL)
886 , MF(NULL)
887 , MMI(NULL)
Jim Laskey072200c2007-01-29 18:51:14 +0000888 , SubprogramCount(0)
Chris Lattner9251f132007-09-24 03:35:37 +0000889 , Flavor(flavor)
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000890 , SetCounter(1)
Jim Laskey072200c2007-01-29 18:51:14 +0000891 {
892 }
893
894public:
Jim Laskey072200c2007-01-29 18:51:14 +0000895 //===--------------------------------------------------------------------===//
896 // Accessors.
897 //
898 AsmPrinter *getAsm() const { return Asm; }
Jim Laskeyb82313f2007-02-01 16:31:34 +0000899 MachineModuleInfo *getMMI() const { return MMI; }
Jim Laskey072200c2007-01-29 18:51:14 +0000900 const TargetAsmInfo *getTargetAsmInfo() const { return TAI; }
Dan Gohman82482942007-09-27 23:12:31 +0000901 const TargetData *getTargetData() const { return TD; }
Jim Laskey072200c2007-01-29 18:51:14 +0000902
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000903 void PrintRelDirective(bool Force32Bit = false, bool isInSection = false)
904 const {
905 if (isInSection && TAI->getDwarfSectionOffsetDirective())
906 O << TAI->getDwarfSectionOffsetDirective();
Dan Gohman82482942007-09-27 23:12:31 +0000907 else if (Force32Bit || TD->getPointerSize() == sizeof(int32_t))
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000908 O << TAI->getData32bitsDirective();
909 else
910 O << TAI->getData64bitsDirective();
911 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000912
Jim Laskeyb82313f2007-02-01 16:31:34 +0000913 /// PrintLabelName - Print label name in form used by Dwarf writer.
914 ///
915 void PrintLabelName(DWLabel Label) const {
916 PrintLabelName(Label.Tag, Label.Number);
917 }
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000918 void PrintLabelName(const char *Tag, unsigned Number) const {
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000919 O << TAI->getPrivateGlobalPrefix() << Tag;
Jim Laskeyb82313f2007-02-01 16:31:34 +0000920 if (Number) O << Number;
921 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000922
Chris Lattner9251f132007-09-24 03:35:37 +0000923 void PrintLabelName(const char *Tag, unsigned Number,
924 const char *Suffix) const {
925 O << TAI->getPrivateGlobalPrefix() << Tag;
926 if (Number) O << Number;
927 O << Suffix;
928 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000929
Jim Laskeyb82313f2007-02-01 16:31:34 +0000930 /// EmitLabel - Emit location label for internal use by Dwarf.
931 ///
932 void EmitLabel(DWLabel Label) const {
933 EmitLabel(Label.Tag, Label.Number);
934 }
935 void EmitLabel(const char *Tag, unsigned Number) const {
936 PrintLabelName(Tag, Number);
937 O << ":\n";
938 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000939
Jim Laskeyb82313f2007-02-01 16:31:34 +0000940 /// EmitReference - Emit a reference to a label.
941 ///
Dan Gohman06ff4e62007-09-28 15:43:33 +0000942 void EmitReference(DWLabel Label, bool IsPCRelative = false,
943 bool Force32Bit = false) const {
944 EmitReference(Label.Tag, Label.Number, IsPCRelative, Force32Bit);
Jim Laskeyb82313f2007-02-01 16:31:34 +0000945 }
946 void EmitReference(const char *Tag, unsigned Number,
Dan Gohman06ff4e62007-09-28 15:43:33 +0000947 bool IsPCRelative = false, bool Force32Bit = false) const {
948 PrintRelDirective(Force32Bit);
Jim Laskeyb82313f2007-02-01 16:31:34 +0000949 PrintLabelName(Tag, Number);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000950
Jim Laskeyb82313f2007-02-01 16:31:34 +0000951 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
952 }
Dan Gohman06ff4e62007-09-28 15:43:33 +0000953 void EmitReference(const std::string &Name, bool IsPCRelative = false,
954 bool Force32Bit = false) const {
955 PrintRelDirective(Force32Bit);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000956
Jim Laskeyb82313f2007-02-01 16:31:34 +0000957 O << Name;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000958
Jim Laskeyb82313f2007-02-01 16:31:34 +0000959 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
960 }
961
962 /// EmitDifference - Emit the difference between two labels. Some
963 /// assemblers do not behave with absolute expressions with data directives,
964 /// so there is an option (needsSet) to use an intermediary set expression.
965 void EmitDifference(DWLabel LabelHi, DWLabel LabelLo,
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000966 bool IsSmall = false) {
Jim Laskeyb82313f2007-02-01 16:31:34 +0000967 EmitDifference(LabelHi.Tag, LabelHi.Number,
968 LabelLo.Tag, LabelLo.Number,
969 IsSmall);
970 }
971 void EmitDifference(const char *TagHi, unsigned NumberHi,
972 const char *TagLo, unsigned NumberLo,
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000973 bool IsSmall = false) {
Jim Laskeyb82313f2007-02-01 16:31:34 +0000974 if (TAI->needsSet()) {
Jim Laskeyb82313f2007-02-01 16:31:34 +0000975 O << "\t.set\t";
Chris Lattner9251f132007-09-24 03:35:37 +0000976 PrintLabelName("set", SetCounter, Flavor);
Jim Laskeyb82313f2007-02-01 16:31:34 +0000977 O << ",";
978 PrintLabelName(TagHi, NumberHi);
979 O << "-";
980 PrintLabelName(TagLo, NumberLo);
981 O << "\n";
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000982
983 PrintRelDirective(IsSmall);
Chris Lattner9251f132007-09-24 03:35:37 +0000984 PrintLabelName("set", SetCounter, Flavor);
Jim Laskeyb82313f2007-02-01 16:31:34 +0000985 ++SetCounter;
986 } else {
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000987 PrintRelDirective(IsSmall);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +0000988
Jim Laskeyb82313f2007-02-01 16:31:34 +0000989 PrintLabelName(TagHi, NumberHi);
990 O << "-";
991 PrintLabelName(TagLo, NumberLo);
992 }
993 }
Anton Korobeynikova6199c82007-03-07 02:47:57 +0000994
995 void EmitSectionOffset(const char* Label, const char* Section,
996 unsigned LabelNumber, unsigned SectionNumber,
Dale Johannesend9ffd4c2008-03-26 23:31:39 +0000997 bool IsSmall = false, bool isEH = false,
998 bool useSet = true) {
Anton Korobeynikov79dda2b2007-05-01 22:23:12 +0000999 bool printAbsolute = false;
Dale Johannesend9ffd4c2008-03-26 23:31:39 +00001000 if (isEH)
1001 printAbsolute = TAI->isAbsoluteEHSectionOffsets();
1002 else
1003 printAbsolute = TAI->isAbsoluteDebugSectionOffsets();
1004
1005 if (TAI->needsSet() && useSet) {
Anton Korobeynikova6199c82007-03-07 02:47:57 +00001006 O << "\t.set\t";
Chris Lattner9251f132007-09-24 03:35:37 +00001007 PrintLabelName("set", SetCounter, Flavor);
Anton Korobeynikova6199c82007-03-07 02:47:57 +00001008 O << ",";
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +00001009 PrintLabelName(Label, LabelNumber);
Anton Korobeynikov79dda2b2007-05-01 22:23:12 +00001010
Anton Korobeynikov79dda2b2007-05-01 22:23:12 +00001011 if (!printAbsolute) {
Anton Korobeynikova6199c82007-03-07 02:47:57 +00001012 O << "-";
1013 PrintLabelName(Section, SectionNumber);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001014 }
Anton Korobeynikova6199c82007-03-07 02:47:57 +00001015 O << "\n";
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +00001016
1017 PrintRelDirective(IsSmall);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001018
Chris Lattner9251f132007-09-24 03:35:37 +00001019 PrintLabelName("set", SetCounter, Flavor);
Anton Korobeynikova6199c82007-03-07 02:47:57 +00001020 ++SetCounter;
1021 } else {
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +00001022 PrintRelDirective(IsSmall, true);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001023
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +00001024 PrintLabelName(Label, LabelNumber);
Anton Korobeynikov79dda2b2007-05-01 22:23:12 +00001025
Anton Korobeynikov79dda2b2007-05-01 22:23:12 +00001026 if (!printAbsolute) {
Anton Korobeynikova6199c82007-03-07 02:47:57 +00001027 O << "-";
1028 PrintLabelName(Section, SectionNumber);
1029 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001030 }
Anton Korobeynikova6199c82007-03-07 02:47:57 +00001031 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001032
Jim Laskeyb82313f2007-02-01 16:31:34 +00001033 /// EmitFrameMoves - Emit frame instructions to describe the layout of the
1034 /// frame.
1035 void EmitFrameMoves(const char *BaseLabel, unsigned BaseLabelID,
Dale Johannesenb97aec62007-11-13 19:13:01 +00001036 const std::vector<MachineMove> &Moves, bool isEH) {
Jim Laskeyb82313f2007-02-01 16:31:34 +00001037 int stackGrowth =
1038 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
1039 TargetFrameInfo::StackGrowsUp ?
Dan Gohman82482942007-09-27 23:12:31 +00001040 TD->getPointerSize() : -TD->getPointerSize();
Jim Laskeybacd3042007-02-21 22:48:45 +00001041 bool IsLocal = BaseLabel && strcmp(BaseLabel, "label") == 0;
Jim Laskeyb82313f2007-02-01 16:31:34 +00001042
1043 for (unsigned i = 0, N = Moves.size(); i < N; ++i) {
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00001044 const MachineMove &Move = Moves[i];
Jim Laskeyb82313f2007-02-01 16:31:34 +00001045 unsigned LabelID = Move.getLabelID();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001046
Jim Laskeyb82313f2007-02-01 16:31:34 +00001047 if (LabelID) {
1048 LabelID = MMI->MappedLabel(LabelID);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001049
Jim Laskeyb82313f2007-02-01 16:31:34 +00001050 // Throw out move if the label is invalid.
1051 if (!LabelID) continue;
1052 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001053
Jim Laskeyb82313f2007-02-01 16:31:34 +00001054 const MachineLocation &Dst = Move.getDestination();
1055 const MachineLocation &Src = Move.getSource();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001056
Jim Laskeyb82313f2007-02-01 16:31:34 +00001057 // Advance row if new location.
1058 if (BaseLabel && LabelID && (BaseLabelID != LabelID || !IsLocal)) {
1059 Asm->EmitInt8(DW_CFA_advance_loc4);
1060 Asm->EOL("DW_CFA_advance_loc4");
Jim Laskeybacd3042007-02-21 22:48:45 +00001061 EmitDifference("label", LabelID, BaseLabel, BaseLabelID, true);
1062 Asm->EOL();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001063
Jim Laskeyb82313f2007-02-01 16:31:34 +00001064 BaseLabelID = LabelID;
Jim Laskeybacd3042007-02-21 22:48:45 +00001065 BaseLabel = "label";
Jim Laskeyb82313f2007-02-01 16:31:34 +00001066 IsLocal = true;
1067 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001068
Jim Laskeyb82313f2007-02-01 16:31:34 +00001069 // If advancing cfa.
Dan Gohmand735b802008-10-03 15:45:36 +00001070 if (Dst.isReg() && Dst.getReg() == MachineLocation::VirtualFP) {
1071 if (!Src.isReg()) {
1072 if (Src.getReg() == MachineLocation::VirtualFP) {
Jim Laskeyb82313f2007-02-01 16:31:34 +00001073 Asm->EmitInt8(DW_CFA_def_cfa_offset);
1074 Asm->EOL("DW_CFA_def_cfa_offset");
1075 } else {
1076 Asm->EmitInt8(DW_CFA_def_cfa);
1077 Asm->EOL("DW_CFA_def_cfa");
Dan Gohmand735b802008-10-03 15:45:36 +00001078 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Src.getReg(), isEH));
Jim Laskeyb82313f2007-02-01 16:31:34 +00001079 Asm->EOL("Register");
1080 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001081
Jim Laskeyb82313f2007-02-01 16:31:34 +00001082 int Offset = -Src.getOffset();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001083
Jim Laskeyb82313f2007-02-01 16:31:34 +00001084 Asm->EmitULEB128Bytes(Offset);
1085 Asm->EOL("Offset");
1086 } else {
1087 assert(0 && "Machine move no supported yet.");
1088 }
Dan Gohmand735b802008-10-03 15:45:36 +00001089 } else if (Src.isReg() &&
1090 Src.getReg() == MachineLocation::VirtualFP) {
1091 if (Dst.isReg()) {
Jim Laskeyb82313f2007-02-01 16:31:34 +00001092 Asm->EmitInt8(DW_CFA_def_cfa_register);
1093 Asm->EOL("DW_CFA_def_cfa_register");
Dan Gohmand735b802008-10-03 15:45:36 +00001094 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Dst.getReg(), isEH));
Jim Laskeyb82313f2007-02-01 16:31:34 +00001095 Asm->EOL("Register");
1096 } else {
1097 assert(0 && "Machine move no supported yet.");
1098 }
1099 } else {
Dan Gohmand735b802008-10-03 15:45:36 +00001100 unsigned Reg = RI->getDwarfRegNum(Src.getReg(), isEH);
Jim Laskeyb82313f2007-02-01 16:31:34 +00001101 int Offset = Dst.getOffset() / stackGrowth;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001102
Jim Laskeyb82313f2007-02-01 16:31:34 +00001103 if (Offset < 0) {
1104 Asm->EmitInt8(DW_CFA_offset_extended_sf);
1105 Asm->EOL("DW_CFA_offset_extended_sf");
1106 Asm->EmitULEB128Bytes(Reg);
1107 Asm->EOL("Reg");
1108 Asm->EmitSLEB128Bytes(Offset);
1109 Asm->EOL("Offset");
1110 } else if (Reg < 64) {
1111 Asm->EmitInt8(DW_CFA_offset + Reg);
Evan Chengd4114192008-07-09 21:53:02 +00001112 if (VerboseAsm)
1113 Asm->EOL("DW_CFA_offset + Reg (" + utostr(Reg) + ")");
1114 else
1115 Asm->EOL();
Jim Laskeyb82313f2007-02-01 16:31:34 +00001116 Asm->EmitULEB128Bytes(Offset);
1117 Asm->EOL("Offset");
1118 } else {
1119 Asm->EmitInt8(DW_CFA_offset_extended);
1120 Asm->EOL("DW_CFA_offset_extended");
1121 Asm->EmitULEB128Bytes(Reg);
1122 Asm->EOL("Reg");
1123 Asm->EmitULEB128Bytes(Offset);
1124 Asm->EOL("Offset");
1125 }
1126 }
1127 }
1128 }
1129
Jim Laskey072200c2007-01-29 18:51:14 +00001130};
1131
1132//===----------------------------------------------------------------------===//
Devang Patelf3ee5142009-01-12 22:54:42 +00001133/// SrcLineInfo - This class is used to record source line correspondence.
Devang Patel9f8fcfc2009-01-08 17:19:22 +00001134///
1135class SrcLineInfo {
1136 unsigned Line; // Source line number.
1137 unsigned Column; // Source column.
1138 unsigned SourceID; // Source ID number.
1139 unsigned LabelID; // Label in code ID number.
1140public:
1141 SrcLineInfo(unsigned L, unsigned C, unsigned S, unsigned I)
Bill Wendlingb9dcef22009-02-03 21:17:20 +00001142 : Line(L), Column(C), SourceID(S), LabelID(I) {}
Devang Patel9f8fcfc2009-01-08 17:19:22 +00001143
1144 // Accessors
1145 unsigned getLine() const { return Line; }
1146 unsigned getColumn() const { return Column; }
1147 unsigned getSourceID() const { return SourceID; }
1148 unsigned getLabelID() const { return LabelID; }
1149};
1150
Devang Patel9f8fcfc2009-01-08 17:19:22 +00001151//===----------------------------------------------------------------------===//
Devang Patel7a6e5a32009-01-08 02:33:41 +00001152/// DbgVariable - This class is used to track local variable information.
1153///
1154class DbgVariable {
Devang Patel99ec3532009-01-16 19:28:14 +00001155 DIVariable Var; // Variable Descriptor.
Devang Patel7a6e5a32009-01-08 02:33:41 +00001156 unsigned FrameIndex; // Variable frame index.
Devang Patel7a6e5a32009-01-08 02:33:41 +00001157public:
Devang Patel99ec3532009-01-16 19:28:14 +00001158 DbgVariable(DIVariable V, unsigned I) : Var(V), FrameIndex(I) {}
Devang Patel7a6e5a32009-01-08 02:33:41 +00001159
1160 // Accessors.
Devang Patel99ec3532009-01-16 19:28:14 +00001161 DIVariable getVariable() const { return Var; }
Devang Patel7a6e5a32009-01-08 02:33:41 +00001162 unsigned getFrameIndex() const { return FrameIndex; }
1163};
1164
1165//===----------------------------------------------------------------------===//
1166/// DbgScope - This class is used to track scope information.
1167///
1168class DbgScope {
Devang Patel7a6e5a32009-01-08 02:33:41 +00001169 DbgScope *Parent; // Parent to this scope.
Devang Patel7103c6a2009-01-16 18:01:58 +00001170 DIDescriptor Desc; // Debug info descriptor for scope.
Devang Patel7a6e5a32009-01-08 02:33:41 +00001171 // Either subprogram or block.
1172 unsigned StartLabelID; // Label ID of the beginning of scope.
1173 unsigned EndLabelID; // Label ID of the end of scope.
Devang Patel7103c6a2009-01-16 18:01:58 +00001174 SmallVector<DbgScope *, 4> Scopes; // Scopes defined in scope.
Devang Patel9795da52009-01-10 02:42:49 +00001175 SmallVector<DbgVariable *, 8> Variables;// Variables declared in scope.
Devang Patel7a6e5a32009-01-08 02:33:41 +00001176public:
Devang Patel0e5200f2009-01-15 18:25:17 +00001177 DbgScope(DbgScope *P, DIDescriptor D)
Devang Patel7a6e5a32009-01-08 02:33:41 +00001178 : Parent(P), Desc(D), StartLabelID(0), EndLabelID(0), Scopes(), Variables()
1179 {}
Devang Patel481ff5b2009-01-12 18:48:36 +00001180 ~DbgScope() {
1181 for (unsigned i = 0, N = Scopes.size(); i < N; ++i) delete Scopes[i];
1182 for (unsigned j = 0, M = Variables.size(); j < M; ++j) delete Variables[j];
1183 }
Devang Patel7a6e5a32009-01-08 02:33:41 +00001184
1185 // Accessors.
Devang Patel7103c6a2009-01-16 18:01:58 +00001186 DbgScope *getParent() const { return Parent; }
1187 DIDescriptor getDesc() const { return Desc; }
Devang Patel7a6e5a32009-01-08 02:33:41 +00001188 unsigned getStartLabelID() const { return StartLabelID; }
1189 unsigned getEndLabelID() const { return EndLabelID; }
Devang Patel9795da52009-01-10 02:42:49 +00001190 SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
1191 SmallVector<DbgVariable *, 8> &getVariables() { return Variables; }
Devang Patel7a6e5a32009-01-08 02:33:41 +00001192 void setStartLabelID(unsigned S) { StartLabelID = S; }
1193 void setEndLabelID(unsigned E) { EndLabelID = E; }
1194
1195 /// AddScope - Add a scope to the scope.
1196 ///
1197 void AddScope(DbgScope *S) { Scopes.push_back(S); }
1198
1199 /// AddVariable - Add a variable to the scope.
1200 ///
1201 void AddVariable(DbgVariable *V) { Variables.push_back(V); }
1202};
1203
1204//===----------------------------------------------------------------------===//
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001205/// DwarfDebug - Emits Dwarf debug directives.
Jim Laskey072200c2007-01-29 18:51:14 +00001206///
1207class DwarfDebug : public Dwarf {
Jim Laskey65195462006-10-30 13:35:07 +00001208 //===--------------------------------------------------------------------===//
1209 // Attributes used to construct specific Dwarf sections.
1210 //
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001211
Evan Chenge3d42322009-02-25 07:04:34 +00001212 /// CompileUnitMap - A map of global variables representing compile units to
1213 /// compile units.
1214 DenseMap<Value *, CompileUnit *> CompileUnitMap;
1215
1216 /// CompileUnits - All the compile units in this module.
1217 ///
1218 SmallVector<CompileUnit *, 8> CompileUnits;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001219
Devang Pateldd9db662009-01-30 18:20:31 +00001220 /// MainCU - Some platform prefers one compile unit per .o file. In such
1221 /// cases, all dies are inserted in MainCU.
1222 CompileUnit *MainCU;
Bill Wendling9a65cfe2009-02-20 20:40:28 +00001223
Jim Laskeyef42a012006-11-02 20:12:39 +00001224 /// AbbreviationsSet - Used to uniquely define abbreviations.
Jim Laskey65195462006-10-30 13:35:07 +00001225 ///
Jim Laskeya9c83fe2006-10-30 15:59:54 +00001226 FoldingSet<DIEAbbrev> AbbreviationsSet;
1227
1228 /// Abbreviations - A list of all the unique abbreviations in use.
1229 ///
1230 std::vector<DIEAbbrev *> Abbreviations;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001231
Evan Chenge3d42322009-02-25 07:04:34 +00001232 /// DirectoryIdMap - Directory name to directory id map.
1233 ///
1234 StringMap<unsigned> DirectoryIdMap;
Devang Patel8526cc02009-01-05 22:35:52 +00001235
Evan Chenge3d42322009-02-25 07:04:34 +00001236 /// DirectoryNames - A list of directory names.
1237 SmallVector<std::string, 8> DirectoryNames;
1238
1239 /// SourceFileIdMap - Source file name to source file id map.
1240 ///
1241 StringMap<unsigned> SourceFileIdMap;
1242
1243 /// SourceFileNames - A list of source file names.
1244 SmallVector<std::string, 8> SourceFileNames;
1245
1246 /// SourceIdMap - Source id map, i.e. pair of directory id and source file
1247 /// id mapped to a unique id.
1248 DenseMap<std::pair<unsigned, unsigned>, unsigned> SourceIdMap;
1249
1250 /// SourceIds - Reverse map from source id to directory id + file id pair.
1251 ///
1252 SmallVector<std::pair<unsigned, unsigned>, 8> SourceIds;
Devang Patel8526cc02009-01-05 22:35:52 +00001253
Devang Patel07354e52009-01-16 21:07:53 +00001254 /// Lines - List of of source line correspondence.
Devang Patel9f8fcfc2009-01-08 17:19:22 +00001255 std::vector<SrcLineInfo> Lines;
1256
Devang Patel07354e52009-01-16 21:07:53 +00001257 /// ValuesSet - Used to uniquely define values.
1258 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00001259 FoldingSet<DIEValue> ValuesSet;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001260
Jim Laskeyef42a012006-11-02 20:12:39 +00001261 /// Values - A list of all the unique values in use.
1262 ///
1263 std::vector<DIEValue *> Values;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001264
Jim Laskey65195462006-10-30 13:35:07 +00001265 /// StringPool - A UniqueVector of strings used by indirect references.
Jim Laskeyef42a012006-11-02 20:12:39 +00001266 ///
Jim Laskey65195462006-10-30 13:35:07 +00001267 UniqueVector<std::string> StringPool;
1268
Jim Laskey65195462006-10-30 13:35:07 +00001269 /// SectionMap - Provides a unique id per text section.
1270 ///
Anton Korobeynikovd7ca4162008-09-24 22:15:21 +00001271 UniqueVector<const Section*> SectionMap;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001272
Jim Laskey65195462006-10-30 13:35:07 +00001273 /// SectionSourceLines - Tracks line numbers per text section.
1274 ///
Devang Patelf3ee5142009-01-12 22:54:42 +00001275 std::vector<std::vector<SrcLineInfo> > SectionSourceLines;
Jim Laskey65195462006-10-30 13:35:07 +00001276
Jim Laskeybacd3042007-02-21 22:48:45 +00001277 /// didInitial - Flag to indicate if initial emission has been done.
1278 ///
1279 bool didInitial;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001280
Jim Laskeybacd3042007-02-21 22:48:45 +00001281 /// shouldEmit - Flag to indicate if debug information should be emitted.
1282 ///
1283 bool shouldEmit;
Jim Laskey65195462006-10-30 13:35:07 +00001284
Devang Patel0e5200f2009-01-15 18:25:17 +00001285 // RootDbgScope - Top level scope for the current function.
Devang Patel7a6e5a32009-01-08 02:33:41 +00001286 //
1287 DbgScope *RootDbgScope;
1288
Bill Wendling163ba3f2009-03-10 21:23:25 +00001289 /// DbgScopeMap - Tracks the scopes in the current function.
Devang Patel7a6e5a32009-01-08 02:33:41 +00001290 DenseMap<GlobalVariable *, DbgScope *> DbgScopeMap;
Bill Wendling163ba3f2009-03-10 21:23:25 +00001291
1292 /// DebugTimer - Timer for the Dwarf debug writer.
1293 Timer *DebugTimer;
Devang Patel7a6e5a32009-01-08 02:33:41 +00001294
Anton Korobeynikov185bc892007-05-13 17:30:11 +00001295 struct FunctionDebugFrameInfo {
1296 unsigned Number;
1297 std::vector<MachineMove> Moves;
1298
1299 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M):
Dan Gohman81975f62007-08-27 14:50:10 +00001300 Number(Num), Moves(M) { }
Anton Korobeynikov185bc892007-05-13 17:30:11 +00001301 };
1302
1303 std::vector<FunctionDebugFrameInfo> DebugFrames;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001304
Jim Laskey65195462006-10-30 13:35:07 +00001305public:
Bill Wendling4ed0c5f2009-02-20 00:44:43 +00001306 /// ShouldEmitDwarfDebug - Returns true if Dwarf debugging declarations should
1307 /// be emitted.
Jim Laskeybacd3042007-02-21 22:48:45 +00001308 ///
Bill Wendling4ed0c5f2009-02-20 00:44:43 +00001309 bool ShouldEmitDwarfDebug() const { return shouldEmit; }
Jim Laskey65195462006-10-30 13:35:07 +00001310
Bill Wendling163ba3f2009-03-10 21:23:25 +00001311private:
Jim Laskeya9c83fe2006-10-30 15:59:54 +00001312 /// AssignAbbrevNumber - Define a unique number for the abbreviation.
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001313 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00001314 void AssignAbbrevNumber(DIEAbbrev &Abbrev) {
1315 // Profile the node so that we can make it unique.
1316 FoldingSetNodeID ID;
1317 Abbrev.Profile(ID);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001318
Jim Laskeyef42a012006-11-02 20:12:39 +00001319 // Check the set for priors.
1320 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001321
Jim Laskeyef42a012006-11-02 20:12:39 +00001322 // If it's newly added.
1323 if (InSet == &Abbrev) {
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001324 // Add to abbreviation list.
Jim Laskeyef42a012006-11-02 20:12:39 +00001325 Abbreviations.push_back(&Abbrev);
1326 // Assign the vector position + 1 as its number.
1327 Abbrev.setNumber(Abbreviations.size());
1328 } else {
1329 // Assign existing abbreviation number.
1330 Abbrev.setNumber(InSet->getNumber());
1331 }
1332 }
1333
Jim Laskey65195462006-10-30 13:35:07 +00001334 /// NewString - Add a string to the constant pool and returns a label.
1335 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00001336 DWLabel NewString(const std::string &String) {
1337 unsigned StringID = StringPool.insert(String);
1338 return DWLabel("string", StringID);
1339 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001340
Jim Laskeyef42a012006-11-02 20:12:39 +00001341 /// NewDIEntry - Creates a new DIEntry to be a proxy for a debug information
1342 /// entry.
1343 DIEntry *NewDIEntry(DIE *Entry = NULL) {
1344 DIEntry *Value;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001345
Jim Laskeyef42a012006-11-02 20:12:39 +00001346 if (Entry) {
1347 FoldingSetNodeID ID;
Jim Laskey5496f012006-11-09 14:52:14 +00001348 DIEntry::Profile(ID, Entry);
Jim Laskeyef42a012006-11-02 20:12:39 +00001349 void *Where;
1350 Value = static_cast<DIEntry *>(ValuesSet.FindNodeOrInsertPos(ID, Where));
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001351
Jim Laskeyf6733882006-11-02 21:48:18 +00001352 if (Value) return Value;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001353
Jim Laskeyef42a012006-11-02 20:12:39 +00001354 Value = new DIEntry(Entry);
1355 ValuesSet.InsertNode(Value, Where);
1356 } else {
1357 Value = new DIEntry(Entry);
1358 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001359
Jim Laskeyef42a012006-11-02 20:12:39 +00001360 Values.push_back(Value);
1361 return Value;
1362 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001363
Jim Laskeyef42a012006-11-02 20:12:39 +00001364 /// SetDIEntry - Set a DIEntry once the debug information entry is defined.
1365 ///
1366 void SetDIEntry(DIEntry *Value, DIE *Entry) {
1367 Value->Entry = Entry;
1368 // Add to values set if not already there. If it is, we merely have a
1369 // duplicate in the values list (no harm.)
1370 ValuesSet.GetOrInsertNode(Value);
1371 }
1372
1373 /// AddUInt - Add an unsigned integer attribute data and value.
1374 ///
1375 void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer) {
1376 if (!Form) Form = DIEInteger::BestForm(false, Integer);
1377
1378 FoldingSetNodeID ID;
Jim Laskey5496f012006-11-09 14:52:14 +00001379 DIEInteger::Profile(ID, Integer);
Jim Laskeyef42a012006-11-02 20:12:39 +00001380 void *Where;
1381 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1382 if (!Value) {
1383 Value = new DIEInteger(Integer);
1384 ValuesSet.InsertNode(Value, Where);
1385 Values.push_back(Value);
Jim Laskeyef42a012006-11-02 20:12:39 +00001386 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001387
Jim Laskeyef42a012006-11-02 20:12:39 +00001388 Die->AddValue(Attribute, Form, Value);
1389 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001390
Jim Laskeyef42a012006-11-02 20:12:39 +00001391 /// AddSInt - Add an signed integer attribute data and value.
1392 ///
1393 void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer) {
1394 if (!Form) Form = DIEInteger::BestForm(true, Integer);
1395
1396 FoldingSetNodeID ID;
Jim Laskey5496f012006-11-09 14:52:14 +00001397 DIEInteger::Profile(ID, (uint64_t)Integer);
Jim Laskeyef42a012006-11-02 20:12:39 +00001398 void *Where;
1399 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1400 if (!Value) {
1401 Value = new DIEInteger(Integer);
1402 ValuesSet.InsertNode(Value, Where);
1403 Values.push_back(Value);
Jim Laskeyef42a012006-11-02 20:12:39 +00001404 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001405
Jim Laskeyef42a012006-11-02 20:12:39 +00001406 Die->AddValue(Attribute, Form, Value);
1407 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001408
Evan Chenge3d42322009-02-25 07:04:34 +00001409 /// AddString - Add a string attribute data and value.
Jim Laskeyef42a012006-11-02 20:12:39 +00001410 ///
1411 void AddString(DIE *Die, unsigned Attribute, unsigned Form,
1412 const std::string &String) {
1413 FoldingSetNodeID ID;
Jim Laskey5496f012006-11-09 14:52:14 +00001414 DIEString::Profile(ID, String);
Jim Laskeyef42a012006-11-02 20:12:39 +00001415 void *Where;
1416 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1417 if (!Value) {
1418 Value = new DIEString(String);
1419 ValuesSet.InsertNode(Value, Where);
1420 Values.push_back(Value);
Jim Laskeyef42a012006-11-02 20:12:39 +00001421 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001422
Jim Laskeyef42a012006-11-02 20:12:39 +00001423 Die->AddValue(Attribute, Form, Value);
1424 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001425
Jim Laskeyef42a012006-11-02 20:12:39 +00001426 /// AddLabel - Add a Dwarf label attribute data and value.
1427 ///
1428 void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
1429 const DWLabel &Label) {
1430 FoldingSetNodeID ID;
Jim Laskey5496f012006-11-09 14:52:14 +00001431 DIEDwarfLabel::Profile(ID, Label);
Jim Laskeyef42a012006-11-02 20:12:39 +00001432 void *Where;
1433 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1434 if (!Value) {
1435 Value = new DIEDwarfLabel(Label);
1436 ValuesSet.InsertNode(Value, Where);
1437 Values.push_back(Value);
Jim Laskeyef42a012006-11-02 20:12:39 +00001438 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001439
Jim Laskeyef42a012006-11-02 20:12:39 +00001440 Die->AddValue(Attribute, Form, Value);
1441 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001442
Jim Laskeyef42a012006-11-02 20:12:39 +00001443 /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
1444 ///
1445 void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
1446 const std::string &Label) {
1447 FoldingSetNodeID ID;
Jim Laskey5496f012006-11-09 14:52:14 +00001448 DIEObjectLabel::Profile(ID, Label);
Jim Laskeyef42a012006-11-02 20:12:39 +00001449 void *Where;
1450 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1451 if (!Value) {
1452 Value = new DIEObjectLabel(Label);
1453 ValuesSet.InsertNode(Value, Where);
1454 Values.push_back(Value);
Jim Laskeyef42a012006-11-02 20:12:39 +00001455 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001456
Jim Laskeyef42a012006-11-02 20:12:39 +00001457 Die->AddValue(Attribute, Form, Value);
1458 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001459
Argyrios Kyrtzidisf7acf8f2008-06-18 19:27:37 +00001460 /// AddSectionOffset - Add a section offset label attribute data and value.
1461 ///
1462 void AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
1463 const DWLabel &Label, const DWLabel &Section,
1464 bool isEH = false, bool useSet = true) {
1465 FoldingSetNodeID ID;
1466 DIESectionOffset::Profile(ID, Label, Section);
1467 void *Where;
1468 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1469 if (!Value) {
1470 Value = new DIESectionOffset(Label, Section, isEH, useSet);
1471 ValuesSet.InsertNode(Value, Where);
1472 Values.push_back(Value);
1473 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001474
Argyrios Kyrtzidisf7acf8f2008-06-18 19:27:37 +00001475 Die->AddValue(Attribute, Form, Value);
1476 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001477
Jim Laskeyef42a012006-11-02 20:12:39 +00001478 /// AddDelta - Add a label delta attribute data and value.
1479 ///
1480 void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
1481 const DWLabel &Hi, const DWLabel &Lo) {
1482 FoldingSetNodeID ID;
Jim Laskey5496f012006-11-09 14:52:14 +00001483 DIEDelta::Profile(ID, Hi, Lo);
Jim Laskeyef42a012006-11-02 20:12:39 +00001484 void *Where;
1485 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1486 if (!Value) {
1487 Value = new DIEDelta(Hi, Lo);
1488 ValuesSet.InsertNode(Value, Where);
1489 Values.push_back(Value);
Jim Laskeyef42a012006-11-02 20:12:39 +00001490 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001491
Jim Laskeyef42a012006-11-02 20:12:39 +00001492 Die->AddValue(Attribute, Form, Value);
1493 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001494
Jim Laskeyef42a012006-11-02 20:12:39 +00001495 /// AddDIEntry - Add a DIE attribute data and value.
1496 ///
1497 void AddDIEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
1498 Die->AddValue(Attribute, Form, NewDIEntry(Entry));
1499 }
1500
1501 /// AddBlock - Add block data.
1502 ///
1503 void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block) {
1504 Block->ComputeSize(*this);
1505 FoldingSetNodeID ID;
1506 Block->Profile(ID);
1507 void *Where;
1508 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1509 if (!Value) {
1510 Value = Block;
1511 ValuesSet.InsertNode(Value, Where);
1512 Values.push_back(Value);
1513 } else {
Chris Lattnerc369bd72007-09-21 18:25:53 +00001514 // Already exists, reuse the previous one.
Jim Laskeyef42a012006-11-02 20:12:39 +00001515 delete Block;
Chris Lattnerc369bd72007-09-21 18:25:53 +00001516 Block = cast<DIEBlock>(Value);
Jim Laskeyef42a012006-11-02 20:12:39 +00001517 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001518
Jim Laskeyef42a012006-11-02 20:12:39 +00001519 Die->AddValue(Attribute, Block->BestForm(), Value);
1520 }
1521
Jim Laskey65195462006-10-30 13:35:07 +00001522 /// AddSourceLine - Add location information to specified debug information
Jim Laskeyef42a012006-11-02 20:12:39 +00001523 /// entry.
Devang Patel99ec3532009-01-16 19:28:14 +00001524 void AddSourceLine(DIE *Die, const DIVariable *V) {
Devang Patel7a6e5a32009-01-08 02:33:41 +00001525 unsigned FileID = 0;
1526 unsigned Line = V->getLineNumber();
Devang Pateldd9db662009-01-30 18:20:31 +00001527 CompileUnit *Unit = FindCompileUnit(V->getCompileUnit());
1528 FileID = Unit->getID();
Devang Patel2303df92009-02-10 06:04:08 +00001529 assert (FileID && "Invalid file id");
Devang Patel7a6e5a32009-01-08 02:33:41 +00001530 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1531 AddUInt(Die, DW_AT_decl_line, 0, Line);
1532 }
1533
1534 /// AddSourceLine - Add location information to specified debug information
1535 /// entry.
Devang Patel99ec3532009-01-16 19:28:14 +00001536 void AddSourceLine(DIE *Die, const DIGlobal *G) {
Devang Patel8526cc02009-01-05 22:35:52 +00001537 unsigned FileID = 0;
1538 unsigned Line = G->getLineNumber();
Devang Pateldd9db662009-01-30 18:20:31 +00001539 CompileUnit *Unit = FindCompileUnit(G->getCompileUnit());
1540 FileID = Unit->getID();
Devang Patel2303df92009-02-10 06:04:08 +00001541 assert (FileID && "Invalid file id");
Devang Patel8526cc02009-01-05 22:35:52 +00001542 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1543 AddUInt(Die, DW_AT_decl_line, 0, Line);
1544 }
1545
Devang Patel99ec3532009-01-16 19:28:14 +00001546 void AddSourceLine(DIE *Die, const DIType *Ty) {
Devang Patel8526cc02009-01-05 22:35:52 +00001547 unsigned FileID = 0;
Devang Patel99ec3532009-01-16 19:28:14 +00001548 unsigned Line = Ty->getLineNumber();
Devang Pateldd9db662009-01-30 18:20:31 +00001549 DICompileUnit CU = Ty->getCompileUnit();
1550 if (CU.isNull())
1551 return;
1552 CompileUnit *Unit = FindCompileUnit(CU);
1553 FileID = Unit->getID();
Devang Patel2303df92009-02-10 06:04:08 +00001554 assert (FileID && "Invalid file id");
Devang Patel8526cc02009-01-05 22:35:52 +00001555 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1556 AddUInt(Die, DW_AT_decl_line, 0, Line);
1557 }
1558
Jim Laskey65195462006-10-30 13:35:07 +00001559 /// AddAddress - Add an address attribute to a die based on the location
1560 /// provided.
1561 void AddAddress(DIE *Die, unsigned Attribute,
Jim Laskeyef42a012006-11-02 20:12:39 +00001562 const MachineLocation &Location) {
Dan Gohmand735b802008-10-03 15:45:36 +00001563 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Jim Laskeyef42a012006-11-02 20:12:39 +00001564 DIEBlock *Block = new DIEBlock();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001565
Dan Gohmand735b802008-10-03 15:45:36 +00001566 if (Location.isReg()) {
Jim Laskeyef42a012006-11-02 20:12:39 +00001567 if (Reg < 32) {
1568 AddUInt(Block, 0, DW_FORM_data1, DW_OP_reg0 + Reg);
1569 } else {
1570 AddUInt(Block, 0, DW_FORM_data1, DW_OP_regx);
1571 AddUInt(Block, 0, DW_FORM_udata, Reg);
1572 }
1573 } else {
1574 if (Reg < 32) {
1575 AddUInt(Block, 0, DW_FORM_data1, DW_OP_breg0 + Reg);
1576 } else {
1577 AddUInt(Block, 0, DW_FORM_data1, DW_OP_bregx);
1578 AddUInt(Block, 0, DW_FORM_udata, Reg);
1579 }
1580 AddUInt(Block, 0, DW_FORM_sdata, Location.getOffset());
1581 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001582
Jim Laskeyef42a012006-11-02 20:12:39 +00001583 AddBlock(Die, Attribute, 0, Block);
1584 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00001585
Jim Laskeyef42a012006-11-02 20:12:39 +00001586 /// AddType - Add a new type attribute to the specified entity.
Devang Patel48d190f2009-01-05 21:47:57 +00001587 void AddType(CompileUnit *DW_Unit, DIE *Entity, DIType Ty) {
Devang Patel80303aa2009-01-23 19:13:31 +00001588 if (Ty.isNull())
Devang Patel48d190f2009-01-05 21:47:57 +00001589 return;
Devang Patel48d190f2009-01-05 21:47:57 +00001590
1591 // Check for pre-existence.
1592 DIEntry *&Slot = DW_Unit->getDIEntrySlotFor(Ty.getGV());
1593 // If it exists then use the existing value.
1594 if (Slot) {
1595 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1596 return;
1597 }
1598
1599 // Set up proxy.
1600 Slot = NewDIEntry();
1601
1602 // Construct type.
1603 DIE Buffer(DW_TAG_base_type);
Devang Patelf193ff02009-01-15 19:26:23 +00001604 if (Ty.isBasicType(Ty.getTag()))
1605 ConstructTypeDIE(DW_Unit, Buffer, DIBasicType(Ty.getGV()));
1606 else if (Ty.isDerivedType(Ty.getTag()))
1607 ConstructTypeDIE(DW_Unit, Buffer, DIDerivedType(Ty.getGV()));
1608 else {
Bill Wendlingb9dcef22009-02-03 21:17:20 +00001609 assert(Ty.isCompositeType(Ty.getTag()) && "Unknown kind of DIType");
Devang Patelf193ff02009-01-15 19:26:23 +00001610 ConstructTypeDIE(DW_Unit, Buffer, DICompositeType(Ty.getGV()));
1611 }
1612
Devang Patel7009d242009-01-27 23:22:55 +00001613 // Add debug information entry to entity and appropriate context.
1614 DIE *Die = NULL;
1615 DIDescriptor Context = Ty.getContext();
1616 if (!Context.isNull())
1617 Die = DW_Unit->getDieMapSlotFor(Context.getGV());
1618
1619 if (Die) {
1620 DIE *Child = new DIE(Buffer);
1621 Die->AddChild(Child);
1622 Buffer.Detach();
1623 SetDIEntry(Slot, Child);
Bill Wendlingb9dcef22009-02-03 21:17:20 +00001624 } else {
Devang Patel7009d242009-01-27 23:22:55 +00001625 Die = DW_Unit->AddDie(Buffer);
1626 SetDIEntry(Slot, Die);
1627 }
1628
Devang Patel48d190f2009-01-05 21:47:57 +00001629 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1630 }
1631
Devang Patele5202732009-01-05 19:07:53 +00001632 /// ConstructTypeDIE - Construct basic type die from DIBasicType.
1633 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
Devang Patelf193ff02009-01-15 19:26:23 +00001634 DIBasicType BTy) {
Devang Patel08f053f2009-01-05 17:57:47 +00001635
1636 // Get core information.
Bill Wendlingccbdc7a2009-03-09 05:04:40 +00001637 std::string Name;
1638 BTy.getName(Name);
Devang Patel08f053f2009-01-05 17:57:47 +00001639 Buffer.setTag(DW_TAG_base_type);
Devang Patelf193ff02009-01-15 19:26:23 +00001640 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, BTy.getEncoding());
Devang Patel08f053f2009-01-05 17:57:47 +00001641 // Add name if not anonymous or intermediate type.
1642 if (!Name.empty())
1643 AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
Devang Patelf193ff02009-01-15 19:26:23 +00001644 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patel08f053f2009-01-05 17:57:47 +00001645 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1646 }
1647
Devang Patele5202732009-01-05 19:07:53 +00001648 /// ConstructTypeDIE - Construct derived type die from DIDerivedType.
1649 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
Devang Patelf193ff02009-01-15 19:26:23 +00001650 DIDerivedType DTy) {
Devang Patel08f053f2009-01-05 17:57:47 +00001651
1652 // Get core information.
Bill Wendlingccbdc7a2009-03-09 05:04:40 +00001653 std::string Name;
1654 DTy.getName(Name);
Devang Patelf193ff02009-01-15 19:26:23 +00001655 uint64_t Size = DTy.getSizeInBits() >> 3;
1656 unsigned Tag = DTy.getTag();
Bill Wendlingccbdc7a2009-03-09 05:04:40 +00001657
Devang Patel08f053f2009-01-05 17:57:47 +00001658 // FIXME - Workaround for templates.
1659 if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
1660
1661 Buffer.setTag(Tag);
Bill Wendlingccbdc7a2009-03-09 05:04:40 +00001662
Devang Patel08f053f2009-01-05 17:57:47 +00001663 // Map to main type, void will not have a type.
Devang Patelf193ff02009-01-15 19:26:23 +00001664 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel48d190f2009-01-05 21:47:57 +00001665 AddType(DW_Unit, &Buffer, FromTy);
Devang Patel08f053f2009-01-05 17:57:47 +00001666
1667 // Add name if not anonymous or intermediate type.
Evan Chenge3d42322009-02-25 07:04:34 +00001668 if (!Name.empty())
1669 AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
Devang Patel08f053f2009-01-05 17:57:47 +00001670
1671 // Add size if non-zero (derived types might be zero-sized.)
1672 if (Size)
1673 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1674
1675 // Add source line info if available and TyDesc is not a forward
1676 // declaration.
Devang Patelad165be2009-01-27 00:45:04 +00001677 if (!DTy.isForwardDecl())
1678 AddSourceLine(&Buffer, &DTy);
Devang Patel08f053f2009-01-05 17:57:47 +00001679 }
1680
Devang Patelf4215332009-01-05 19:55:51 +00001681 /// ConstructTypeDIE - Construct type DIE from DICompositeType.
1682 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
Devang Patelf193ff02009-01-15 19:26:23 +00001683 DICompositeType CTy) {
Devang Patel5aac3d32009-01-17 08:01:33 +00001684 // Get core information.
Bill Wendlingccbdc7a2009-03-09 05:04:40 +00001685 std::string Name;
1686 CTy.getName(Name);
1687
Devang Patelf193ff02009-01-15 19:26:23 +00001688 uint64_t Size = CTy.getSizeInBits() >> 3;
1689 unsigned Tag = CTy.getTag();
Devang Patel49f38cb2009-01-23 01:19:09 +00001690 Buffer.setTag(Tag);
Bill Wendlingccbdc7a2009-03-09 05:04:40 +00001691
Devang Patelf4215332009-01-05 19:55:51 +00001692 switch (Tag) {
1693 case DW_TAG_vector_type:
1694 case DW_TAG_array_type:
Devang Patelf193ff02009-01-15 19:26:23 +00001695 ConstructArrayTypeDIE(DW_Unit, Buffer, &CTy);
Devang Patelf4215332009-01-05 19:55:51 +00001696 break;
Devang Pateleab4a2e2009-01-20 18:35:14 +00001697 case DW_TAG_enumeration_type:
1698 {
1699 DIArray Elements = CTy.getTypeArray();
1700 // Add enumerators to enumeration type.
1701 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1702 DIE *ElemDie = NULL;
1703 DIEnumerator Enum(Elements.getElement(i).getGV());
1704 ElemDie = ConstructEnumTypeDIE(DW_Unit, &Enum);
1705 Buffer.AddChild(ElemDie);
1706 }
1707 }
1708 break;
Devang Patelf4215332009-01-05 19:55:51 +00001709 case DW_TAG_subroutine_type:
1710 {
1711 // Add prototype flag.
1712 AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
Devang Patelf193ff02009-01-15 19:26:23 +00001713 DIArray Elements = CTy.getTypeArray();
Devang Patelf4215332009-01-05 19:55:51 +00001714 // Add return type.
Devang Patel48d190f2009-01-05 21:47:57 +00001715 DIDescriptor RTy = Elements.getElement(0);
Devang Patelf193ff02009-01-15 19:26:23 +00001716 AddType(DW_Unit, &Buffer, DIType(RTy.getGV()));
Devang Patel48d190f2009-01-05 21:47:57 +00001717
Devang Patelf4215332009-01-05 19:55:51 +00001718 // Add arguments.
1719 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1720 DIE *Arg = new DIE(DW_TAG_formal_parameter);
Devang Patel48d190f2009-01-05 21:47:57 +00001721 DIDescriptor Ty = Elements.getElement(i);
Devang Patel7ab24502009-01-17 06:57:25 +00001722 AddType(DW_Unit, Arg, DIType(Ty.getGV()));
Devang Patelf4215332009-01-05 19:55:51 +00001723 Buffer.AddChild(Arg);
1724 }
1725 }
1726 break;
1727 case DW_TAG_structure_type:
1728 case DW_TAG_union_type:
1729 {
1730 // Add elements to structure type.
Devang Patelf193ff02009-01-15 19:26:23 +00001731 DIArray Elements = CTy.getTypeArray();
Devang Patel153745c2009-01-16 00:50:53 +00001732
1733 // A forward struct declared type may not have elements available.
1734 if (Elements.isNull())
1735 break;
1736
Devang Patelf4215332009-01-05 19:55:51 +00001737 // Add elements to structure type.
1738 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1739 DIDescriptor Element = Elements.getElement(i);
Devang Patel5aac3d32009-01-17 08:01:33 +00001740 DIE *ElemDie = NULL;
Devang Patelf193ff02009-01-15 19:26:23 +00001741 if (Element.getTag() == dwarf::DW_TAG_subprogram)
Devang Patel2d1768c2009-01-17 08:05:14 +00001742 ElemDie = CreateSubprogramDIE(DW_Unit,
1743 DISubprogram(Element.getGV()));
Devang Patel5aac3d32009-01-17 08:01:33 +00001744 else if (Element.getTag() == dwarf::DW_TAG_variable) // ???
1745 ElemDie = CreateGlobalVariableDIE(DW_Unit,
1746 DIGlobalVariable(Element.getGV()));
Devang Patel2be58932009-01-20 21:02:02 +00001747 else
1748 ElemDie = CreateMemberDIE(DW_Unit,
1749 DIDerivedType(Element.getGV()));
Devang Patel2d1768c2009-01-17 08:05:14 +00001750 Buffer.AddChild(ElemDie);
Devang Patelf4215332009-01-05 19:55:51 +00001751 }
Devang Patel13319ce2009-02-17 22:43:44 +00001752 unsigned RLang = CTy.getRunTimeLang();
1753 if (RLang)
1754 AddUInt(&Buffer, DW_AT_APPLE_runtime_class, DW_FORM_data1, RLang);
Devang Patelf4215332009-01-05 19:55:51 +00001755 }
1756 break;
1757 default:
1758 break;
1759 }
1760
1761 // Add name if not anonymous or intermediate type.
Evan Chenge3d42322009-02-25 07:04:34 +00001762 if (!Name.empty())
1763 AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
Devang Patelf4215332009-01-05 19:55:51 +00001764
Devang Patelad165be2009-01-27 00:45:04 +00001765 if (Tag == DW_TAG_enumeration_type || Tag == DW_TAG_structure_type
1766 || Tag == DW_TAG_union_type) {
1767 // Add size if non-zero (derived types might be zero-sized.)
1768 if (Size)
1769 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1770 else {
1771 // Add zero size if it is not a forward declaration.
1772 if (CTy.isForwardDecl())
1773 AddUInt(&Buffer, DW_AT_declaration, DW_FORM_flag, 1);
1774 else
1775 AddUInt(&Buffer, DW_AT_byte_size, 0, 0);
1776 }
1777
1778 // Add source line info if available.
1779 if (!CTy.isForwardDecl())
1780 AddSourceLine(&Buffer, &CTy);
Devang Patelf4215332009-01-05 19:55:51 +00001781 }
Devang Patelf4215332009-01-05 19:55:51 +00001782 }
1783
Bill Wendlingb9dcef22009-02-03 21:17:20 +00001784 /// ConstructSubrangeDIE - Construct subrange DIE from DISubrange.
1785 void ConstructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy) {
Devang Patelf193ff02009-01-15 19:26:23 +00001786 int64_t L = SR.getLo();
1787 int64_t H = SR.getHi();
Devang Patel68afdc32009-01-05 18:33:01 +00001788 DIE *DW_Subrange = new DIE(DW_TAG_subrange_type);
1789 if (L != H) {
1790 AddDIEntry(DW_Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1791 if (L)
Devang Patel2d1768c2009-01-17 08:05:14 +00001792 AddSInt(DW_Subrange, DW_AT_lower_bound, 0, L);
1793 AddSInt(DW_Subrange, DW_AT_upper_bound, 0, H);
Devang Patel68afdc32009-01-05 18:33:01 +00001794 }
1795 Buffer.AddChild(DW_Subrange);
1796 }
1797
1798 /// ConstructArrayTypeDIE - Construct array type DIE from DICompositeType.
1799 void ConstructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1800 DICompositeType *CTy) {
1801 Buffer.setTag(DW_TAG_array_type);
1802 if (CTy->getTag() == DW_TAG_vector_type)
1803 AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1804
Devang Patelf9235742009-01-28 21:08:20 +00001805 // Emit derived type.
1806 AddType(DW_Unit, &Buffer, CTy->getTypeDerivedFrom());
Devang Patel68afdc32009-01-05 18:33:01 +00001807 DIArray Elements = CTy->getTypeArray();
Devang Patel68afdc32009-01-05 18:33:01 +00001808
1809 // Construct an anonymous type for index type.
1810 DIE IdxBuffer(DW_TAG_base_type);
1811 AddUInt(&IdxBuffer, DW_AT_byte_size, 0, sizeof(int32_t));
1812 AddUInt(&IdxBuffer, DW_AT_encoding, DW_FORM_data1, DW_ATE_signed);
1813 DIE *IndexTy = DW_Unit->AddDie(IdxBuffer);
1814
1815 // Add subranges to array type.
1816 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
Devang Patelf4215332009-01-05 19:55:51 +00001817 DIDescriptor Element = Elements.getElement(i);
Devang Patelf193ff02009-01-15 19:26:23 +00001818 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
1819 ConstructSubrangeDIE(Buffer, DISubrange(Element.getGV()), IndexTy);
Devang Patel68afdc32009-01-05 18:33:01 +00001820 }
1821 }
1822
Bill Wendlingb9dcef22009-02-03 21:17:20 +00001823 /// ConstructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
Devang Pateleab4a2e2009-01-20 18:35:14 +00001824 DIE *ConstructEnumTypeDIE(CompileUnit *DW_Unit, DIEnumerator *ETy) {
Devang Patelc69bf2c2009-01-05 18:38:38 +00001825
1826 DIE *Enumerator = new DIE(DW_TAG_enumerator);
Bill Wendlingccbdc7a2009-03-09 05:04:40 +00001827 std::string Name;
1828 ETy->getName(Name);
Evan Chenge3d42322009-02-25 07:04:34 +00001829 AddString(Enumerator, DW_AT_name, DW_FORM_string, Name);
Devang Patelc69bf2c2009-01-05 18:38:38 +00001830 int64_t Value = ETy->getEnumValue();
1831 AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
Devang Pateleab4a2e2009-01-20 18:35:14 +00001832 return Enumerator;
Devang Patelc69bf2c2009-01-05 18:38:38 +00001833 }
Devang Patel68afdc32009-01-05 18:33:01 +00001834
Devang Patel5aac3d32009-01-17 08:01:33 +00001835 /// CreateGlobalVariableDIE - Create new DIE using GV.
Bill Wendlingb9dcef22009-02-03 21:17:20 +00001836 DIE *CreateGlobalVariableDIE(CompileUnit *DW_Unit, const DIGlobalVariable &GV)
Devang Patel5aac3d32009-01-17 08:01:33 +00001837 {
1838 DIE *GVDie = new DIE(DW_TAG_variable);
Bill Wendlingccbdc7a2009-03-09 05:04:40 +00001839 std::string Name;
1840 GV.getDisplayName(Name);
Evan Chenge3d42322009-02-25 07:04:34 +00001841 AddString(GVDie, DW_AT_name, DW_FORM_string, Name);
Bill Wendlingccbdc7a2009-03-09 05:04:40 +00001842 std::string LinkageName;
1843 GV.getLinkageName(LinkageName);
Devang Patel86ae1422009-01-05 18:59:44 +00001844 if (!LinkageName.empty())
Devang Patel5aac3d32009-01-17 08:01:33 +00001845 AddString(GVDie, DW_AT_MIPS_linkage_name, DW_FORM_string, LinkageName);
1846 AddType(DW_Unit, GVDie, GV.getType());
1847 if (!GV.isLocalToUnit())
1848 AddUInt(GVDie, DW_AT_external, DW_FORM_flag, 1);
1849 AddSourceLine(GVDie, &GV);
1850 return GVDie;
Devang Patel86ae1422009-01-05 18:59:44 +00001851 }
1852
Devang Patel2be58932009-01-20 21:02:02 +00001853 /// CreateMemberDIE - Create new member DIE.
1854 DIE *CreateMemberDIE(CompileUnit *DW_Unit, const DIDerivedType &DT) {
1855 DIE *MemberDie = new DIE(DT.getTag());
Bill Wendlingccbdc7a2009-03-09 05:04:40 +00001856 std::string Name;
1857 DT.getName(Name);
Devang Patel2be58932009-01-20 21:02:02 +00001858 if (!Name.empty())
1859 AddString(MemberDie, DW_AT_name, DW_FORM_string, Name);
1860
1861 AddType(DW_Unit, MemberDie, DT.getTypeDerivedFrom());
1862
1863 AddSourceLine(MemberDie, &DT);
1864
Devang Patel36375ee2009-02-17 21:23:59 +00001865 uint64_t Size = DT.getSizeInBits();
1866 uint64_t FieldSize = DT.getOriginalTypeSize();
1867
1868 if (Size != FieldSize) {
1869 // Handle bitfield.
1870 AddUInt(MemberDie, DW_AT_byte_size, 0, DT.getOriginalTypeSize() >> 3);
1871 AddUInt(MemberDie, DW_AT_bit_size, 0, DT.getSizeInBits());
1872
1873 uint64_t Offset = DT.getOffsetInBits();
1874 uint64_t FieldOffset = Offset;
1875 uint64_t AlignMask = ~(DT.getAlignInBits() - 1);
1876 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1877 FieldOffset = (HiMark - FieldSize);
1878 Offset -= FieldOffset;
1879 // Maybe we need to work from the other end.
1880 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
1881 AddUInt(MemberDie, DW_AT_bit_offset, 0, Offset);
1882 }
Devang Patel2be58932009-01-20 21:02:02 +00001883 DIEBlock *Block = new DIEBlock();
1884 AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
1885 AddUInt(Block, 0, DW_FORM_udata, DT.getOffsetInBits() >> 3);
1886 AddBlock(MemberDie, DW_AT_data_member_location, 0, Block);
1887
Devang Patel47661592009-01-21 00:08:04 +00001888 if (DT.isProtected())
1889 AddUInt(MemberDie, DW_AT_accessibility, 0, DW_ACCESS_protected);
1890 else if (DT.isPrivate())
1891 AddUInt(MemberDie, DW_AT_accessibility, 0, DW_ACCESS_private);
1892
Devang Patel2be58932009-01-20 21:02:02 +00001893 return MemberDie;
1894 }
1895
Devang Patel5aac3d32009-01-17 08:01:33 +00001896 /// CreateSubprogramDIE - Create new DIE using SP.
1897 DIE *CreateSubprogramDIE(CompileUnit *DW_Unit,
Devang Patel2d1768c2009-01-17 08:05:14 +00001898 const DISubprogram &SP,
1899 bool IsConstructor = false) {
Devang Patel5aac3d32009-01-17 08:01:33 +00001900 DIE *SPDie = new DIE(DW_TAG_subprogram);
Bill Wendlingccbdc7a2009-03-09 05:04:40 +00001901 std::string Name;
1902 SP.getName(Name);
Evan Chenge3d42322009-02-25 07:04:34 +00001903 AddString(SPDie, DW_AT_name, DW_FORM_string, Name);
Bill Wendlingccbdc7a2009-03-09 05:04:40 +00001904 std::string LinkageName;
1905 SP.getLinkageName(LinkageName);
Devang Patel86ae1422009-01-05 18:59:44 +00001906 if (!LinkageName.empty())
Devang Patel5aac3d32009-01-17 08:01:33 +00001907 AddString(SPDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
Devang Patel2d1768c2009-01-17 08:05:14 +00001908 LinkageName);
Devang Patel5aac3d32009-01-17 08:01:33 +00001909 AddSourceLine(SPDie, &SP);
Devang Patel86ae1422009-01-05 18:59:44 +00001910
Devang Patel5aac3d32009-01-17 08:01:33 +00001911 DICompositeType SPTy = SP.getType();
1912 DIArray Args = SPTy.getTypeArray();
1913
Devang Patel86ae1422009-01-05 18:59:44 +00001914 // Add Return Type.
Devang Patel9ac08d62009-02-27 18:05:21 +00001915 if (!IsConstructor) {
1916 if (Args.isNull())
1917 AddType(DW_Unit, SPDie, SPTy);
1918 else
1919 AddType(DW_Unit, SPDie, DIType(Args.getElement(0).getGV()));
1920 }
Devang Pateld234e592009-01-30 01:21:46 +00001921
Devang Pateld5863dd2009-02-02 17:51:41 +00001922 if (!SP.isDefinition()) {
1923 AddUInt(SPDie, DW_AT_declaration, DW_FORM_flag, 1);
1924 // Add arguments.
1925 // Do not add arguments for subprogram definition. They will be
1926 // handled through RecordVariable.
1927 if (!Args.isNull())
1928 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
1929 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1930 AddType(DW_Unit, Arg, DIType(Args.getElement(i).getGV()));
1931 AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1); // ???
1932 SPDie->AddChild(Arg);
1933 }
1934 }
Devang Pateld234e592009-01-30 01:21:46 +00001935
Devang Patel002ec142009-02-24 00:52:19 +00001936 unsigned Lang = SP.getCompileUnit().getLanguage();
1937 if (Lang == DW_LANG_C99 || Lang == DW_LANG_C89
1938 || Lang == DW_LANG_ObjC)
1939 AddUInt(SPDie, DW_AT_prototyped, DW_FORM_flag, 1);
1940
Devang Patelf193ff02009-01-15 19:26:23 +00001941 if (!SP.isLocalToUnit())
Devang Pateld234e592009-01-30 01:21:46 +00001942 AddUInt(SPDie, DW_AT_external, DW_FORM_flag, 1);
Devang Patel5aac3d32009-01-17 08:01:33 +00001943 return SPDie;
Devang Patel86ae1422009-01-05 18:59:44 +00001944 }
1945
Devang Patel5aac3d32009-01-17 08:01:33 +00001946 /// FindCompileUnit - Get the compile unit for the given descriptor.
1947 ///
Devang Patel8526cc02009-01-05 22:35:52 +00001948 CompileUnit *FindCompileUnit(DICompileUnit Unit) {
Evan Chenge3d42322009-02-25 07:04:34 +00001949 CompileUnit *DW_Unit = CompileUnitMap[Unit.getGV()];
Devang Patel8526cc02009-01-05 22:35:52 +00001950 assert(DW_Unit && "Missing compile unit.");
1951 return DW_Unit;
1952 }
1953
Devang Patelbbdc8202009-01-13 23:54:55 +00001954 /// NewDbgScopeVariable - Create a new scope variable.
Devang Patel7a6e5a32009-01-08 02:33:41 +00001955 ///
1956 DIE *NewDbgScopeVariable(DbgVariable *DV, CompileUnit *Unit) {
1957 // Get the descriptor.
Devang Patel99ec3532009-01-16 19:28:14 +00001958 const DIVariable &VD = DV->getVariable();
Devang Patel7a6e5a32009-01-08 02:33:41 +00001959
1960 // Translate tag to proper Dwarf tag. The result variable is dropped for
1961 // now.
1962 unsigned Tag;
Devang Patel99ec3532009-01-16 19:28:14 +00001963 switch (VD.getTag()) {
Devang Patel7a6e5a32009-01-08 02:33:41 +00001964 case DW_TAG_return_variable: return NULL;
1965 case DW_TAG_arg_variable: Tag = DW_TAG_formal_parameter; break;
1966 case DW_TAG_auto_variable: // fall thru
1967 default: Tag = DW_TAG_variable; break;
1968 }
1969
1970 // Define variable debug information entry.
1971 DIE *VariableDie = new DIE(Tag);
Bill Wendlingccbdc7a2009-03-09 05:04:40 +00001972 std::string Name;
1973 VD.getName(Name);
Evan Chenge3d42322009-02-25 07:04:34 +00001974 AddString(VariableDie, DW_AT_name, DW_FORM_string, Name);
Devang Patel7a6e5a32009-01-08 02:33:41 +00001975
1976 // Add source line info if available.
Devang Patel99ec3532009-01-16 19:28:14 +00001977 AddSourceLine(VariableDie, &VD);
Devang Patel7a6e5a32009-01-08 02:33:41 +00001978
1979 // Add variable type.
Devang Patel99ec3532009-01-16 19:28:14 +00001980 AddType(Unit, VariableDie, VD.getType());
Devang Patel7a6e5a32009-01-08 02:33:41 +00001981
1982 // Add variable address.
1983 MachineLocation Location;
1984 Location.set(RI->getFrameRegister(*MF),
1985 RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
1986 AddAddress(VariableDie, DW_AT_location, Location);
1987
1988 return VariableDie;
1989 }
1990
Devang Patel7a6e5a32009-01-08 02:33:41 +00001991 /// getOrCreateScope - Returns the scope associated with the given descriptor.
1992 ///
1993 DbgScope *getOrCreateScope(GlobalVariable *V) {
1994 DbgScope *&Slot = DbgScopeMap[V];
Bill Wendling9a65cfe2009-02-20 20:40:28 +00001995 if (Slot) return Slot;
1996
1997 // FIXME - breaks down when the context is an inlined function.
1998 DIDescriptor ParentDesc;
1999 DIDescriptor Desc(V);
2000
2001 if (Desc.getTag() == dwarf::DW_TAG_lexical_block) {
2002 DIBlock Block(V);
2003 ParentDesc = Block.getContext();
Devang Patel7a6e5a32009-01-08 02:33:41 +00002004 }
Bill Wendling9a65cfe2009-02-20 20:40:28 +00002005
2006 DbgScope *Parent = ParentDesc.isNull() ?
2007 NULL : getOrCreateScope(ParentDesc.getGV());
2008 Slot = new DbgScope(Parent, Desc);
2009
2010 if (Parent) {
2011 Parent->AddScope(Slot);
2012 } else if (RootDbgScope) {
2013 // FIXME - Add inlined function scopes to the root so we can delete them
2014 // later. Long term, handle inlined functions properly.
2015 RootDbgScope->AddScope(Slot);
2016 } else {
2017 // First function is top level function.
2018 RootDbgScope = Slot;
2019 }
2020
Devang Patel7a6e5a32009-01-08 02:33:41 +00002021 return Slot;
2022 }
2023
2024 /// ConstructDbgScope - Construct the components of a scope.
2025 ///
2026 void ConstructDbgScope(DbgScope *ParentScope,
2027 unsigned ParentStartID, unsigned ParentEndID,
2028 DIE *ParentDie, CompileUnit *Unit) {
2029 // Add variables to scope.
Devang Patel9795da52009-01-10 02:42:49 +00002030 SmallVector<DbgVariable *, 8> &Variables = ParentScope->getVariables();
Devang Patel7a6e5a32009-01-08 02:33:41 +00002031 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2032 DIE *VariableDie = NewDbgScopeVariable(Variables[i], Unit);
2033 if (VariableDie) ParentDie->AddChild(VariableDie);
2034 }
2035
2036 // Add nested scopes.
Devang Patel9795da52009-01-10 02:42:49 +00002037 SmallVector<DbgScope *, 4> &Scopes = ParentScope->getScopes();
Devang Patel7a6e5a32009-01-08 02:33:41 +00002038 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
2039 // Define the Scope debug information entry.
2040 DbgScope *Scope = Scopes[j];
2041 // FIXME - Ignore inlined functions for the time being.
2042 if (!Scope->getParent()) continue;
2043
Devang Patele9bfb0f2009-01-12 18:41:00 +00002044 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
2045 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
Devang Patel7a6e5a32009-01-08 02:33:41 +00002046
2047 // Ignore empty scopes.
2048 if (StartID == EndID && StartID != 0) continue;
2049 if (Scope->getScopes().empty() && Scope->getVariables().empty()) continue;
2050
2051 if (StartID == ParentStartID && EndID == ParentEndID) {
2052 // Just add stuff to the parent scope.
2053 ConstructDbgScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
2054 } else {
2055 DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
2056
2057 // Add the scope bounds.
2058 if (StartID) {
2059 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2060 DWLabel("label", StartID));
2061 } else {
2062 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2063 DWLabel("func_begin", SubprogramCount));
2064 }
2065 if (EndID) {
2066 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2067 DWLabel("label", EndID));
2068 } else {
2069 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2070 DWLabel("func_end", SubprogramCount));
2071 }
2072
2073 // Add the scope contents.
2074 ConstructDbgScope(Scope, StartID, EndID, ScopeDie, Unit);
2075 ParentDie->AddChild(ScopeDie);
2076 }
2077 }
2078 }
2079
2080 /// ConstructRootDbgScope - Construct the scope for the subprogram.
2081 ///
2082 void ConstructRootDbgScope(DbgScope *RootScope) {
2083 // Exit if there is no root scope.
2084 if (!RootScope) return;
Devang Patel0e5200f2009-01-15 18:25:17 +00002085 DIDescriptor Desc = RootScope->getDesc();
2086 if (Desc.isNull())
2087 return;
Devang Patel7a6e5a32009-01-08 02:33:41 +00002088
2089 // Get the subprogram debug information entry.
Devang Patel0e5200f2009-01-15 18:25:17 +00002090 DISubprogram SPD(Desc.getGV());
Devang Patel7a6e5a32009-01-08 02:33:41 +00002091
2092 // Get the compile unit context.
Devang Pateldd9db662009-01-30 18:20:31 +00002093 CompileUnit *Unit = MainCU;
2094 if (!Unit)
2095 Unit = FindCompileUnit(SPD.getCompileUnit());
Devang Patel7a6e5a32009-01-08 02:33:41 +00002096
2097 // Get the subprogram die.
Devang Patelf6bac3e2009-01-12 22:58:14 +00002098 DIE *SPDie = Unit->getDieMapSlotFor(SPD.getGV());
Devang Patel7a6e5a32009-01-08 02:33:41 +00002099 assert(SPDie && "Missing subprogram descriptor");
2100
2101 // Add the function bounds.
2102 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2103 DWLabel("func_begin", SubprogramCount));
2104 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2105 DWLabel("func_end", SubprogramCount));
2106 MachineLocation Location(RI->getFrameRegister(*MF));
2107 AddAddress(SPDie, DW_AT_frame_base, Location);
2108
2109 ConstructDbgScope(RootScope, 0, 0, SPDie, Unit);
2110 }
2111
2112 /// ConstructDefaultDbgScope - Construct a default scope for the subprogram.
2113 ///
2114 void ConstructDefaultDbgScope(MachineFunction *MF) {
Evan Chenge3d42322009-02-25 07:04:34 +00002115 const char *FnName = MF->getFunction()->getNameStart();
2116 if (MainCU) {
2117 std::map<std::string, DIE*> &Globals = MainCU->getGlobals();
2118 std::map<std::string, DIE*>::iterator GI = Globals.find(FnName);
2119 if (GI != Globals.end()) {
2120 DIE *SPDie = GI->second;
Devang Patel7a6e5a32009-01-08 02:33:41 +00002121
2122 // Add the function bounds.
2123 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2124 DWLabel("func_begin", SubprogramCount));
2125 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2126 DWLabel("func_end", SubprogramCount));
2127
2128 MachineLocation Location(RI->getFrameRegister(*MF));
2129 AddAddress(SPDie, DW_AT_frame_base, Location);
2130 return;
2131 }
Evan Chenge3d42322009-02-25 07:04:34 +00002132 } else {
2133 for (unsigned i = 0, e = CompileUnits.size(); i != e; ++i) {
2134 CompileUnit *Unit = CompileUnits[i];
2135 std::map<std::string, DIE*> &Globals = Unit->getGlobals();
2136 std::map<std::string, DIE*>::iterator GI = Globals.find(FnName);
2137 if (GI != Globals.end()) {
2138 DIE *SPDie = GI->second;
2139
2140 // Add the function bounds.
2141 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2142 DWLabel("func_begin", SubprogramCount));
2143 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2144 DWLabel("func_end", SubprogramCount));
2145
2146 MachineLocation Location(RI->getFrameRegister(*MF));
2147 AddAddress(SPDie, DW_AT_frame_base, Location);
2148 return;
2149 }
2150 }
Devang Patel7a6e5a32009-01-08 02:33:41 +00002151 }
Evan Chenge3d42322009-02-25 07:04:34 +00002152
Devang Patel7a6e5a32009-01-08 02:33:41 +00002153#if 0
2154 // FIXME: This is causing an abort because C++ mangled names are compared
2155 // with their unmangled counterparts. See PR2885. Don't do this assert.
2156 assert(0 && "Couldn't find DIE for machine function!");
2157#endif
Evan Chenge3d42322009-02-25 07:04:34 +00002158 return;
Devang Patel7a6e5a32009-01-08 02:33:41 +00002159 }
2160
Jim Laskeyef42a012006-11-02 20:12:39 +00002161 /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
2162 /// tools to recognize the object file contains Dwarf information.
2163 void EmitInitial() {
2164 // Check to see if we already emitted intial headers.
2165 if (didInitial) return;
2166 didInitial = true;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002167
Jim Laskeyef42a012006-11-02 20:12:39 +00002168 // Dwarf sections base addresses.
Anton Korobeynikov2a07e2f2007-05-05 09:04:50 +00002169 if (TAI->doesDwarfRequireFrameSection()) {
Jim Laskeyef42a012006-11-02 20:12:39 +00002170 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002171 EmitLabel("section_debug_frame", 0);
Jim Laskeyef42a012006-11-02 20:12:39 +00002172 }
2173 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2174 EmitLabel("section_info", 0);
2175 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2176 EmitLabel("section_abbrev", 0);
2177 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2178 EmitLabel("section_aranges", 0);
Scott Michel210de722009-01-26 22:32:51 +00002179 if (TAI->doesSupportMacInfoSection()) {
2180 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2181 EmitLabel("section_macinfo", 0);
2182 }
Jim Laskeyef42a012006-11-02 20:12:39 +00002183 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2184 EmitLabel("section_line", 0);
2185 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2186 EmitLabel("section_loc", 0);
2187 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2188 EmitLabel("section_pubnames", 0);
2189 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2190 EmitLabel("section_str", 0);
2191 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2192 EmitLabel("section_ranges", 0);
2193
Anton Korobeynikovd7ca4162008-09-24 22:15:21 +00002194 Asm->SwitchToSection(TAI->getTextSection());
Jim Laskeyef42a012006-11-02 20:12:39 +00002195 EmitLabel("text_begin", 0);
Anton Korobeynikov315690e2008-09-24 22:16:16 +00002196 Asm->SwitchToSection(TAI->getDataSection());
Jim Laskeyef42a012006-11-02 20:12:39 +00002197 EmitLabel("data_begin", 0);
Jim Laskeyef42a012006-11-02 20:12:39 +00002198 }
2199
Jim Laskey65195462006-10-30 13:35:07 +00002200 /// EmitDIE - Recusively Emits a debug information entry.
2201 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00002202 void EmitDIE(DIE *Die) {
Jim Laskeyef42a012006-11-02 20:12:39 +00002203 // Get the abbreviation for this DIE.
2204 unsigned AbbrevNumber = Die->getAbbrevNumber();
2205 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002206
Jim Laskeybacd3042007-02-21 22:48:45 +00002207 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002208
2209 // Emit the code (index) for the abbreviation.
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002210 Asm->EmitULEB128Bytes(AbbrevNumber);
Evan Cheng6547e402008-07-01 23:18:29 +00002211
2212 if (VerboseAsm)
2213 Asm->EOL(std::string("Abbrev [" +
2214 utostr(AbbrevNumber) +
2215 "] 0x" + utohexstr(Die->getOffset()) +
2216 ":0x" + utohexstr(Die->getSize()) + " " +
2217 TagString(Abbrev->getTag())));
2218 else
2219 Asm->EOL();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002220
Owen Anderson873e1b52008-06-24 21:44:59 +00002221 SmallVector<DIEValue*, 32> &Values = Die->getValues();
2222 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002223
Jim Laskeyef42a012006-11-02 20:12:39 +00002224 // Emit the DIE attribute values.
2225 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2226 unsigned Attr = AbbrevData[i].getAttribute();
2227 unsigned Form = AbbrevData[i].getForm();
2228 assert(Form && "Too many attributes for DIE (check abbreviation)");
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002229
Jim Laskeyef42a012006-11-02 20:12:39 +00002230 switch (Attr) {
2231 case DW_AT_sibling: {
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002232 Asm->EmitInt32(Die->SiblingOffset());
Jim Laskeyef42a012006-11-02 20:12:39 +00002233 break;
2234 }
2235 default: {
2236 // Emit an attribute using the defined form.
2237 Values[i]->EmitValue(*this, Form);
2238 break;
2239 }
2240 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002241
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002242 Asm->EOL(AttributeString(Attr));
Jim Laskeyef42a012006-11-02 20:12:39 +00002243 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002244
Jim Laskeyef42a012006-11-02 20:12:39 +00002245 // Emit the DIE children if any.
2246 if (Abbrev->getChildrenFlag() == DW_CHILDREN_yes) {
2247 const std::vector<DIE *> &Children = Die->getChildren();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002248
Jim Laskeyef42a012006-11-02 20:12:39 +00002249 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2250 EmitDIE(Children[j]);
2251 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002252
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002253 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
Jim Laskeyef42a012006-11-02 20:12:39 +00002254 }
2255 }
2256
Jim Laskey65195462006-10-30 13:35:07 +00002257 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
2258 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002259 unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
2260 // Get the children.
2261 const std::vector<DIE *> &Children = Die->getChildren();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002262
Jim Laskeyef42a012006-11-02 20:12:39 +00002263 // If not last sibling and has children then add sibling offset attribute.
2264 if (!Last && !Children.empty()) Die->AddSiblingOffset();
2265
2266 // Record the abbreviation.
2267 AssignAbbrevNumber(Die->getAbbrev());
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002268
Jim Laskeyef42a012006-11-02 20:12:39 +00002269 // Get the abbreviation for this DIE.
2270 unsigned AbbrevNumber = Die->getAbbrevNumber();
2271 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2272
2273 // Set DIE offset
2274 Die->setOffset(Offset);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002275
Jim Laskeyef42a012006-11-02 20:12:39 +00002276 // Start the size with the size of abbreviation code.
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002277 Offset += TargetAsmInfo::getULEB128Size(AbbrevNumber);
2278
Owen Anderson873e1b52008-06-24 21:44:59 +00002279 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2280 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
Jim Laskeyef42a012006-11-02 20:12:39 +00002281
2282 // Size the DIE attribute values.
2283 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2284 // Size attribute value.
2285 Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
2286 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002287
Jim Laskeyef42a012006-11-02 20:12:39 +00002288 // Size the DIE children if any.
2289 if (!Children.empty()) {
2290 assert(Abbrev->getChildrenFlag() == DW_CHILDREN_yes &&
2291 "Children flag not set");
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002292
Jim Laskeyef42a012006-11-02 20:12:39 +00002293 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2294 Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
2295 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002296
Jim Laskeyef42a012006-11-02 20:12:39 +00002297 // End of children marker.
2298 Offset += sizeof(int8_t);
2299 }
2300
2301 Die->setSize(Offset - Die->getOffset());
2302 return Offset;
2303 }
Jim Laskey65195462006-10-30 13:35:07 +00002304
2305 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
2306 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002307 void SizeAndOffsets() {
Jim Laskey5496f012006-11-09 14:52:14 +00002308 // Process base compile unit.
Devang Pateldd9db662009-01-30 18:20:31 +00002309 if (MainCU) {
2310 // Compute size of compile unit header
2311 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2312 sizeof(int16_t) + // DWARF version number
2313 sizeof(int32_t) + // Offset Into Abbrev. Section
2314 sizeof(int8_t); // Pointer Size (in bytes)
2315 SizeAndOffsetDie(MainCU->getDie(), Offset, true);
2316 return;
2317 }
Evan Chenge3d42322009-02-25 07:04:34 +00002318 for (unsigned i = 0, e = CompileUnits.size(); i != e; ++i) {
2319 CompileUnit *Unit = CompileUnits[i];
Devang Patel72b66352009-01-12 23:05:55 +00002320 // Compute size of compile unit header
2321 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2322 sizeof(int16_t) + // DWARF version number
2323 sizeof(int32_t) + // Offset Into Abbrev. Section
2324 sizeof(int8_t); // Pointer Size (in bytes)
2325 SizeAndOffsetDie(Unit->getDie(), Offset, true);
2326 }
Jim Laskeyef42a012006-11-02 20:12:39 +00002327 }
2328
Evan Chenge3d42322009-02-25 07:04:34 +00002329 /// EmitDebugInfo / EmitDebugInfoPerCU - Emit the debug info section.
Jim Laskey65195462006-10-30 13:35:07 +00002330 ///
Evan Chenge3d42322009-02-25 07:04:34 +00002331 void EmitDebugInfoPerCU(CompileUnit *Unit) {
2332 DIE *Die = Unit->getDie();
2333 // Emit the compile units header.
2334 EmitLabel("info_begin", Unit->getID());
2335 // Emit size of content not including length itself
2336 unsigned ContentSize = Die->getSize() +
2337 sizeof(int16_t) + // DWARF version number
2338 sizeof(int32_t) + // Offset Into Abbrev. Section
2339 sizeof(int8_t) + // Pointer Size (in bytes)
2340 sizeof(int32_t); // FIXME - extra pad for gdb bug.
2341
2342 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2343 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2344 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2345 Asm->EOL("Offset Into Abbrev. Section");
2346 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2347
2348 EmitDIE(Die);
2349 // FIXME - extra padding for gdb bug.
2350 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2351 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2352 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2353 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2354 EmitLabel("info_end", Unit->getID());
2355
2356 Asm->EOL();
2357 }
2358
Anton Korobeynikov6a143592007-03-07 08:25:02 +00002359 void EmitDebugInfo() {
Jim Laskeyef42a012006-11-02 20:12:39 +00002360 // Start debug info section.
2361 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002362
Evan Chenge3d42322009-02-25 07:04:34 +00002363 if (MainCU) {
2364 EmitDebugInfoPerCU(MainCU);
2365 return;
Devang Patel72b66352009-01-12 23:05:55 +00002366 }
Evan Chenge3d42322009-02-25 07:04:34 +00002367
2368 for (unsigned i = 0, e = CompileUnits.size(); i != e; ++i)
2369 EmitDebugInfoPerCU(CompileUnits[i]);
Jim Laskeyef42a012006-11-02 20:12:39 +00002370 }
2371
Jim Laskey65195462006-10-30 13:35:07 +00002372 /// EmitAbbreviations - Emit the abbreviation section.
2373 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002374 void EmitAbbreviations() const {
2375 // Check to see if it is worth the effort.
2376 if (!Abbreviations.empty()) {
2377 // Start the debug abbrev section.
2378 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002379
Jim Laskeyef42a012006-11-02 20:12:39 +00002380 EmitLabel("abbrev_begin", 0);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002381
Jim Laskeyef42a012006-11-02 20:12:39 +00002382 // For each abbrevation.
2383 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2384 // Get abbreviation data
2385 const DIEAbbrev *Abbrev = Abbreviations[i];
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002386
Jim Laskeyef42a012006-11-02 20:12:39 +00002387 // Emit the abbrevations code (base 1 index.)
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002388 Asm->EmitULEB128Bytes(Abbrev->getNumber());
2389 Asm->EOL("Abbreviation Code");
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002390
Jim Laskeyef42a012006-11-02 20:12:39 +00002391 // Emit the abbreviations data.
2392 Abbrev->Emit(*this);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002393
Jim Laskeybacd3042007-02-21 22:48:45 +00002394 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002395 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002396
Jim Laskey7b1b39d2007-02-22 18:22:42 +00002397 // Mark end of abbreviations.
Jim Laskey5df3ad82007-02-22 18:48:52 +00002398 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
Jim Laskey7b1b39d2007-02-22 18:22:42 +00002399
Jim Laskeyef42a012006-11-02 20:12:39 +00002400 EmitLabel("abbrev_end", 0);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002401
Jim Laskeybacd3042007-02-21 22:48:45 +00002402 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002403 }
2404 }
2405
Bill Wendlingfbbd7012008-07-20 00:11:19 +00002406 /// EmitEndOfLineMatrix - Emit the last address of the section and the end of
2407 /// the line matrix.
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002408 ///
Bill Wendlingfbbd7012008-07-20 00:11:19 +00002409 void EmitEndOfLineMatrix(unsigned SectionEnd) {
2410 // Define last address of section.
2411 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2412 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2413 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2414 EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
2415
2416 // Mark end of matrix.
2417 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2418 Asm->EmitULEB128Bytes(1); Asm->EOL();
2419 Asm->EmitInt8(1); Asm->EOL();
2420 }
2421
Jim Laskey65195462006-10-30 13:35:07 +00002422 /// EmitDebugLines - Emit source line information.
2423 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00002424 void EmitDebugLines() {
Bill Wendlingfbbd7012008-07-20 00:11:19 +00002425 // If the target is using .loc/.file, the assembler will be emitting the
2426 // .debug_line table automatically.
2427 if (TAI->hasDotLocAndDotFile())
Dan Gohman81a148b2007-09-24 21:43:52 +00002428 return;
2429
Jim Laskeyef42a012006-11-02 20:12:39 +00002430 // Minimum line delta, thus ranging from -10..(255-10).
2431 const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
2432 // Maximum line delta, thus ranging from -10..(255-10).
2433 const int MaxLineDelta = 255 + MinLineDelta;
Jim Laskey65195462006-10-30 13:35:07 +00002434
Jim Laskeyef42a012006-11-02 20:12:39 +00002435 // Start the dwarf line section.
2436 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002437
Jim Laskeyef42a012006-11-02 20:12:39 +00002438 // Construct the section header.
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002439
Jim Laskey2b4e98c2006-12-06 17:43:18 +00002440 EmitDifference("line_end", 0, "line_begin", 0, true);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002441 Asm->EOL("Length of Source Line Info");
Jim Laskeyef42a012006-11-02 20:12:39 +00002442 EmitLabel("line_begin", 0);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002443
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002444 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002445
Jim Laskey2b4e98c2006-12-06 17:43:18 +00002446 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002447 Asm->EOL("Prolog Length");
Jim Laskeyef42a012006-11-02 20:12:39 +00002448 EmitLabel("line_prolog_begin", 0);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002449
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002450 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
Jim Laskeyef42a012006-11-02 20:12:39 +00002451
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002452 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
Jim Laskeyef42a012006-11-02 20:12:39 +00002453
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002454 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002455
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002456 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
Jim Laskeyef42a012006-11-02 20:12:39 +00002457
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002458 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002459
Jim Laskeyef42a012006-11-02 20:12:39 +00002460 // Line number standard opcode encodings argument count
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002461 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2462 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2463 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2464 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2465 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2466 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2467 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2468 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2469 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
Jim Laskeyef42a012006-11-02 20:12:39 +00002470
Jim Laskeyef42a012006-11-02 20:12:39 +00002471 // Emit directories.
Evan Chenge3d42322009-02-25 07:04:34 +00002472 for (unsigned DI = 1, DE = getNumSourceDirectories()+1; DI != DE; ++DI) {
2473 Asm->EmitString(getSourceDirectoryName(DI));
2474 Asm->EOL("Directory");
Jim Laskeyef42a012006-11-02 20:12:39 +00002475 }
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002476 Asm->EmitInt8(0); Asm->EOL("End of directories");
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002477
Jim Laskeyef42a012006-11-02 20:12:39 +00002478 // Emit files.
Evan Chenge3d42322009-02-25 07:04:34 +00002479 for (unsigned SI = 1, SE = getNumSourceIds()+1; SI != SE; ++SI) {
2480 // Remember source id starts at 1.
2481 std::pair<unsigned, unsigned> Id = getSourceDirsectoryAndFileIds(SI);
2482 Asm->EmitString(getSourceFileName(Id.second));
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002483 Asm->EOL("Source");
Evan Chenge3d42322009-02-25 07:04:34 +00002484 Asm->EmitULEB128Bytes(Id.first);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002485 Asm->EOL("Directory #");
2486 Asm->EmitULEB128Bytes(0);
2487 Asm->EOL("Mod date");
2488 Asm->EmitULEB128Bytes(0);
2489 Asm->EOL("File size");
Jim Laskeyef42a012006-11-02 20:12:39 +00002490 }
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002491 Asm->EmitInt8(0); Asm->EOL("End of files");
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002492
Jim Laskeyef42a012006-11-02 20:12:39 +00002493 EmitLabel("line_prolog_end", 0);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002494
Jim Laskeyef42a012006-11-02 20:12:39 +00002495 // A sequence for each text section.
Bill Wendlingfbbd7012008-07-20 00:11:19 +00002496 unsigned SecSrcLinesSize = SectionSourceLines.size();
2497
2498 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
Jim Laskeyef42a012006-11-02 20:12:39 +00002499 // Isolate current sections line info.
Devang Patelf3ee5142009-01-12 22:54:42 +00002500 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
Evan Cheng6547e402008-07-01 23:18:29 +00002501
Anton Korobeynikovd7ca4162008-09-24 22:15:21 +00002502 if (VerboseAsm) {
2503 const Section* S = SectionMap[j + 1];
Evan Chenge3d42322009-02-25 07:04:34 +00002504 O << '\t' << TAI->getCommentString() << " Section"
2505 << S->getName() << '\n';
Anton Korobeynikovd7ca4162008-09-24 22:15:21 +00002506 } else
Evan Cheng6547e402008-07-01 23:18:29 +00002507 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002508
2509 // Dwarf assumes we start with first line of first source file.
2510 unsigned Source = 1;
2511 unsigned Line = 1;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002512
Jim Laskeyef42a012006-11-02 20:12:39 +00002513 // Construct rows of the address, source, line, column matrix.
2514 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
Devang Patelf3ee5142009-01-12 22:54:42 +00002515 const SrcLineInfo &LineInfo = LineInfos[i];
Jim Laskey44c3b9f2007-01-26 21:22:28 +00002516 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
Jim Laskey9d4209f2006-11-07 19:33:46 +00002517 if (!LabelID) continue;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002518
Evan Chenge3d42322009-02-25 07:04:34 +00002519 if (!VerboseAsm)
Evan Cheng6547e402008-07-01 23:18:29 +00002520 Asm->EOL();
Evan Chenge3d42322009-02-25 07:04:34 +00002521 else {
2522 std::pair<unsigned, unsigned> SourceID =
2523 getSourceDirsectoryAndFileIds(LineInfo.getSourceID());
2524 O << '\t' << TAI->getCommentString() << ' '
2525 << getSourceDirectoryName(SourceID.first) << ' '
2526 << getSourceFileName(SourceID.second)
2527 <<" :" << utostr_32(LineInfo.getLine()) << '\n';
2528 }
Jim Laskeyef42a012006-11-02 20:12:39 +00002529
2530 // Define the line address.
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002531 Asm->EmitInt8(0); Asm->EOL("Extended Op");
Dan Gohman82482942007-09-27 23:12:31 +00002532 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002533 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
Jim Laskeybacd3042007-02-21 22:48:45 +00002534 EmitReference("label", LabelID); Asm->EOL("Location label");
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002535
Jim Laskeyef42a012006-11-02 20:12:39 +00002536 // If change of source, then switch to the new source.
2537 if (Source != LineInfo.getSourceID()) {
2538 Source = LineInfo.getSourceID();
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002539 Asm->EmitInt8(DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2540 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
Jim Laskeyef42a012006-11-02 20:12:39 +00002541 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002542
Jim Laskeyef42a012006-11-02 20:12:39 +00002543 // If change of line.
2544 if (Line != LineInfo.getLine()) {
2545 // Determine offset.
2546 int Offset = LineInfo.getLine() - Line;
2547 int Delta = Offset - MinLineDelta;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002548
Jim Laskeyef42a012006-11-02 20:12:39 +00002549 // Update line.
2550 Line = LineInfo.getLine();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002551
Jim Laskeyef42a012006-11-02 20:12:39 +00002552 // If delta is small enough and in range...
2553 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2554 // ... then use fast opcode.
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002555 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
Jim Laskeyef42a012006-11-02 20:12:39 +00002556 } else {
2557 // ... otherwise use long hand.
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002558 Asm->EmitInt8(DW_LNS_advance_line); Asm->EOL("DW_LNS_advance_line");
2559 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2560 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
Jim Laskeyef42a012006-11-02 20:12:39 +00002561 }
2562 } else {
2563 // Copy the previous row (different address or source)
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002564 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
Jim Laskeyef42a012006-11-02 20:12:39 +00002565 }
2566 }
2567
Bill Wendlingfbbd7012008-07-20 00:11:19 +00002568 EmitEndOfLineMatrix(j + 1);
Jim Laskeyef42a012006-11-02 20:12:39 +00002569 }
Bill Wendlingfbbd7012008-07-20 00:11:19 +00002570
2571 if (SecSrcLinesSize == 0)
2572 // Because we're emitting a debug_line section, we still need a line
2573 // table. The linker and friends expect it to exist. If there's nothing to
2574 // put into it, emit an empty table.
2575 EmitEndOfLineMatrix(1);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002576
Jim Laskeyef42a012006-11-02 20:12:39 +00002577 EmitLabel("line_end", 0);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002578
Jim Laskeybacd3042007-02-21 22:48:45 +00002579 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002580 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002581
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002582 /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
Jim Laskey65195462006-10-30 13:35:07 +00002583 ///
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002584 void EmitCommonDebugFrame() {
Anton Korobeynikov2a07e2f2007-05-05 09:04:50 +00002585 if (!TAI->doesDwarfRequireFrameSection())
Jim Laskeyef42a012006-11-02 20:12:39 +00002586 return;
2587
2588 int stackGrowth =
2589 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2590 TargetFrameInfo::StackGrowsUp ?
Dan Gohman82482942007-09-27 23:12:31 +00002591 TD->getPointerSize() : -TD->getPointerSize();
Jim Laskeyef42a012006-11-02 20:12:39 +00002592
2593 // Start the dwarf frame section.
2594 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2595
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002596 EmitLabel("debug_frame_common", 0);
2597 EmitDifference("debug_frame_common_end", 0,
2598 "debug_frame_common_begin", 0, true);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002599 Asm->EOL("Length of Common Information Entry");
Jim Laskeyef42a012006-11-02 20:12:39 +00002600
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002601 EmitLabel("debug_frame_common_begin", 0);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002602 Asm->EmitInt32((int)DW_CIE_ID);
2603 Asm->EOL("CIE Identifier Tag");
2604 Asm->EmitInt8(DW_CIE_VERSION);
2605 Asm->EOL("CIE Version");
2606 Asm->EmitString("");
2607 Asm->EOL("CIE Augmentation");
2608 Asm->EmitULEB128Bytes(1);
2609 Asm->EOL("CIE Code Alignment Factor");
2610 Asm->EmitSLEB128Bytes(stackGrowth);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002611 Asm->EOL("CIE Data Alignment Factor");
Dale Johannesenb97aec62007-11-13 19:13:01 +00002612 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002613 Asm->EOL("CIE RA Column");
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002614
Jim Laskey5e73d5b2007-01-24 18:45:13 +00002615 std::vector<MachineMove> Moves;
Jim Laskeyef42a012006-11-02 20:12:39 +00002616 RI->getInitialFrameState(Moves);
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00002617
Dale Johannesenb97aec62007-11-13 19:13:01 +00002618 EmitFrameMoves(NULL, 0, Moves, false);
Jim Laskeyef42a012006-11-02 20:12:39 +00002619
Evan Cheng05548eb2008-02-29 19:36:59 +00002620 Asm->EmitAlignment(2, 0, 0, false);
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002621 EmitLabel("debug_frame_common_end", 0);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002622
Jim Laskeybacd3042007-02-21 22:48:45 +00002623 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002624 }
2625
Jim Laskey65195462006-10-30 13:35:07 +00002626 /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2627 /// section.
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002628 void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Anton Korobeynikov2a07e2f2007-05-05 09:04:50 +00002629 if (!TAI->doesDwarfRequireFrameSection())
Reid Spencer5a4951e2006-11-07 06:36:36 +00002630 return;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002631
Jim Laskeyef42a012006-11-02 20:12:39 +00002632 // Start the dwarf frame section.
2633 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002634
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002635 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2636 "debug_frame_begin", DebugFrameInfo.Number, true);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002637 Asm->EOL("Length of Frame Information Entry");
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002638
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002639 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
Anton Korobeynikova6199c82007-03-07 02:47:57 +00002640
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002641 EmitSectionOffset("debug_frame_common", "section_debug_frame",
2642 0, 0, true, false);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002643 Asm->EOL("FDE CIE offset");
Jim Laskey65195462006-10-30 13:35:07 +00002644
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002645 EmitReference("func_begin", DebugFrameInfo.Number);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002646 Asm->EOL("FDE initial location");
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002647 EmitDifference("func_end", DebugFrameInfo.Number,
2648 "func_begin", DebugFrameInfo.Number);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002649 Asm->EOL("FDE address range");
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002650
Devang Patel5aac3d32009-01-17 08:01:33 +00002651 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves,
Devang Patel2d1768c2009-01-17 08:05:14 +00002652 false);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002653
Evan Cheng05548eb2008-02-29 19:36:59 +00002654 Asm->EmitAlignment(2, 0, 0, false);
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002655 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
Jim Laskeyef42a012006-11-02 20:12:39 +00002656
Jim Laskeybacd3042007-02-21 22:48:45 +00002657 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002658 }
2659
Evan Chenge3d42322009-02-25 07:04:34 +00002660 void EmitDebugPubNamesPerCU(CompileUnit *Unit) {
2661 EmitDifference("pubnames_end", Unit->getID(),
2662 "pubnames_begin", Unit->getID(), true);
2663 Asm->EOL("Length of Public Names Info");
2664
2665 EmitLabel("pubnames_begin", Unit->getID());
2666
2667 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF Version");
2668
2669 EmitSectionOffset("info_begin", "section_info",
2670 Unit->getID(), 0, true, false);
2671 Asm->EOL("Offset of Compilation Unit Info");
2672
2673 EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(),
2674 true);
2675 Asm->EOL("Compilation Unit Length");
2676
2677 std::map<std::string, DIE *> &Globals = Unit->getGlobals();
2678 for (std::map<std::string, DIE *>::iterator GI = Globals.begin(),
2679 GE = Globals.end(); GI != GE; ++GI) {
2680 const std::string &Name = GI->first;
2681 DIE * Entity = GI->second;
2682
2683 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2684 Asm->EmitString(Name); Asm->EOL("External Name");
2685 }
2686
2687 Asm->EmitInt32(0); Asm->EOL("End Mark");
2688 EmitLabel("pubnames_end", Unit->getID());
2689
2690 Asm->EOL();
2691 }
2692
Jim Laskeyef42a012006-11-02 20:12:39 +00002693 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
Jim Laskey65195462006-10-30 13:35:07 +00002694 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002695 void EmitDebugPubNames() {
2696 // Start the dwarf pubnames section.
2697 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002698
Evan Chenge3d42322009-02-25 07:04:34 +00002699 if (MainCU) {
2700 EmitDebugPubNamesPerCU(MainCU);
2701 return;
Jim Laskeyef42a012006-11-02 20:12:39 +00002702 }
Evan Chenge3d42322009-02-25 07:04:34 +00002703
2704 for (unsigned i = 0, e = CompileUnits.size(); i != e; ++i)
2705 EmitDebugPubNamesPerCU(CompileUnits[i]);
Jim Laskeyef42a012006-11-02 20:12:39 +00002706 }
2707
2708 /// EmitDebugStr - Emit visible names into a debug str section.
Jim Laskey65195462006-10-30 13:35:07 +00002709 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002710 void EmitDebugStr() {
2711 // Check to see if it is worth the effort.
2712 if (!StringPool.empty()) {
2713 // Start the dwarf str section.
2714 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002715
Jim Laskeyef42a012006-11-02 20:12:39 +00002716 // For each of strings in the string pool.
2717 for (unsigned StringID = 1, N = StringPool.size();
2718 StringID <= N; ++StringID) {
2719 // Emit a label for reference from debug information entries.
2720 EmitLabel("string", StringID);
2721 // Emit the string itself.
2722 const std::string &String = StringPool[StringID];
Jim Laskeybacd3042007-02-21 22:48:45 +00002723 Asm->EmitString(String); Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002724 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002725
Jim Laskeybacd3042007-02-21 22:48:45 +00002726 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002727 }
2728 }
2729
2730 /// EmitDebugLoc - Emit visible names into a debug loc section.
Jim Laskey65195462006-10-30 13:35:07 +00002731 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002732 void EmitDebugLoc() {
2733 // Start the dwarf loc section.
2734 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002735
Jim Laskeybacd3042007-02-21 22:48:45 +00002736 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002737 }
2738
2739 /// EmitDebugARanges - Emit visible names into a debug aranges section.
Jim Laskey65195462006-10-30 13:35:07 +00002740 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002741 void EmitDebugARanges() {
2742 // Start the dwarf aranges section.
2743 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002744
Jim Laskeyef42a012006-11-02 20:12:39 +00002745 // FIXME - Mock up
Bill Wendlingd751c642008-09-26 00:28:12 +00002746#if 0
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002747 CompileUnit *Unit = GetBaseCompileUnit();
2748
Jim Laskey5496f012006-11-09 14:52:14 +00002749 // Don't include size of length
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002750 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002751
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002752 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("Dwarf Version");
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002753
Jim Laskey5496f012006-11-09 14:52:14 +00002754 EmitReference("info_begin", Unit->getID());
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002755 Asm->EOL("Offset of Compilation Unit Info");
Jim Laskeyef42a012006-11-02 20:12:39 +00002756
Dan Gohman82482942007-09-27 23:12:31 +00002757 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
Jim Laskeyef42a012006-11-02 20:12:39 +00002758
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002759 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
Jim Laskeyef42a012006-11-02 20:12:39 +00002760
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002761 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
2762 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
Jim Laskeyef42a012006-11-02 20:12:39 +00002763
Jim Laskey5496f012006-11-09 14:52:14 +00002764 // Range 1
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002765 EmitReference("text_begin", 0); Asm->EOL("Address");
2766 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
Jim Laskeyef42a012006-11-02 20:12:39 +00002767
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002768 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2769 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
Bill Wendlingd751c642008-09-26 00:28:12 +00002770#endif
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002771
Jim Laskeybacd3042007-02-21 22:48:45 +00002772 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002773 }
2774
2775 /// EmitDebugRanges - Emit visible names into a debug ranges section.
Jim Laskey65195462006-10-30 13:35:07 +00002776 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002777 void EmitDebugRanges() {
2778 // Start the dwarf ranges section.
2779 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002780
Jim Laskeybacd3042007-02-21 22:48:45 +00002781 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002782 }
2783
2784 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
Jim Laskey65195462006-10-30 13:35:07 +00002785 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002786 void EmitDebugMacInfo() {
Scott Michel210de722009-01-26 22:32:51 +00002787 if (TAI->doesSupportMacInfoSection()) {
2788 // Start the dwarf macinfo section.
2789 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00002790
Scott Michel210de722009-01-26 22:32:51 +00002791 Asm->EOL();
2792 }
Jim Laskeyef42a012006-11-02 20:12:39 +00002793 }
2794
Evan Chenge3d42322009-02-25 07:04:34 +00002795 void ConstructCompileUnit(GlobalVariable *GV) {
2796 DICompileUnit DIUnit(GV);
Bill Wendlingccbdc7a2009-03-09 05:04:40 +00002797 std::string Dir, FN, Prod;
2798 unsigned ID = getOrCreateSourceID(DIUnit.getDirectory(Dir),
2799 DIUnit.getFilename(FN));
Evan Chenge3d42322009-02-25 07:04:34 +00002800
2801 DIE *Die = new DIE(DW_TAG_compile_unit);
2802 AddSectionOffset(Die, DW_AT_stmt_list, DW_FORM_data4,
2803 DWLabel("section_line", 0), DWLabel("section_line", 0),
2804 false);
Bill Wendlingccbdc7a2009-03-09 05:04:40 +00002805 AddString(Die, DW_AT_producer, DW_FORM_string, DIUnit.getProducer(Prod));
Evan Chenge3d42322009-02-25 07:04:34 +00002806 AddUInt(Die, DW_AT_language, DW_FORM_data1, DIUnit.getLanguage());
Bill Wendlingccbdc7a2009-03-09 05:04:40 +00002807 AddString(Die, DW_AT_name, DW_FORM_string, FN);
2808 if (!Dir.empty())
2809 AddString(Die, DW_AT_comp_dir, DW_FORM_string, Dir);
Evan Chenge3d42322009-02-25 07:04:34 +00002810 if (DIUnit.isOptimized())
2811 AddUInt(Die, DW_AT_APPLE_optimized, DW_FORM_flag, 1);
Bill Wendlingccbdc7a2009-03-09 05:04:40 +00002812 std::string Flags;
2813 DIUnit.getFlags(Flags);
Evan Chenge3d42322009-02-25 07:04:34 +00002814 if (!Flags.empty())
2815 AddString(Die, DW_AT_APPLE_flags, DW_FORM_string, Flags);
2816 unsigned RVer = DIUnit.getRunTimeVersion();
2817 if (RVer)
2818 AddUInt(Die, DW_AT_APPLE_major_runtime_vers, DW_FORM_data1, RVer);
2819
2820 CompileUnit *Unit = new CompileUnit(ID, Die);
2821 if (DIUnit.isMain()) {
2822 assert(!MainCU && "Multiple main compile units are found!");
2823 MainCU = Unit;
2824 }
2825 CompileUnitMap[DIUnit.getGV()] = Unit;
2826 CompileUnits.push_back(Unit);
2827 }
2828
Devang Patelc4523242009-01-05 23:11:11 +00002829 /// ConstructCompileUnits - Create a compile unit DIEs.
Devang Pateld1ca9252009-01-05 23:03:32 +00002830 void ConstructCompileUnits() {
Evan Chenge3d42322009-02-25 07:04:34 +00002831 GlobalVariable *Root = M->getGlobalVariable("llvm.dbg.compile_units");
2832 if (!Root)
2833 return;
2834 assert(Root->hasLinkOnceLinkage() && Root->hasOneUse() &&
2835 "Malformed compile unit descriptor anchor type");
2836 Constant *RootC = cast<Constant>(*Root->use_begin());
2837 assert(RootC->hasNUsesOrMore(1) &&
2838 "Malformed compile unit descriptor anchor type");
2839 for (Value::use_iterator UI = RootC->use_begin(), UE = Root->use_end();
2840 UI != UE; ++UI)
2841 for (Value::use_iterator UUI = UI->use_begin(), UUE = UI->use_end();
2842 UUI != UUE; ++UUI) {
2843 GlobalVariable *GV = cast<GlobalVariable>(*UUI);
2844 ConstructCompileUnit(GV);
Devang Pateldd9db662009-01-30 18:20:31 +00002845 }
Evan Chenge3d42322009-02-25 07:04:34 +00002846 }
2847
2848 bool ConstructGlobalVariableDIE(GlobalVariable *GV) {
2849 DIGlobalVariable DI_GV(GV);
2850 CompileUnit *DW_Unit = MainCU;
2851 if (!DW_Unit)
2852 DW_Unit = FindCompileUnit(DI_GV.getCompileUnit());
2853
2854 // Check for pre-existence.
2855 DIE *&Slot = DW_Unit->getDieMapSlotFor(DI_GV.getGV());
2856 if (Slot)
2857 return false;
2858
2859 DIE *VariableDie = CreateGlobalVariableDIE(DW_Unit, DI_GV);
2860
2861 // Add address.
2862 DIEBlock *Block = new DIEBlock();
2863 AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
2864 AddObjectLabel(Block, 0, DW_FORM_udata,
2865 Asm->getGlobalLinkName(DI_GV.getGlobal()));
2866 AddBlock(VariableDie, DW_AT_location, 0, Block);
2867
2868 // Add to map.
2869 Slot = VariableDie;
2870 // Add to context owner.
2871 DW_Unit->getDie()->AddChild(VariableDie);
2872 // Expose as global. FIXME - need to check external flag.
Bill Wendlingccbdc7a2009-03-09 05:04:40 +00002873 std::string Name;
2874 DW_Unit->AddGlobal(DI_GV.getName(Name), VariableDie);
Evan Chenge3d42322009-02-25 07:04:34 +00002875 return true;
Devang Pateld1ca9252009-01-05 23:03:32 +00002876 }
2877
Devang Patelc4523242009-01-05 23:11:11 +00002878 /// ConstructGlobalVariableDIEs - Create DIEs for each of the externally
Devang Patel53cac182009-02-24 00:02:15 +00002879 /// visible global variables. Return true if at least one global DIE is
2880 /// created.
2881 bool ConstructGlobalVariableDIEs() {
Evan Chenge3d42322009-02-25 07:04:34 +00002882 GlobalVariable *Root = M->getGlobalVariable("llvm.dbg.global_variables");
2883 if (!Root)
2884 return false;
Devang Patelc4523242009-01-05 23:11:11 +00002885
Evan Chenge3d42322009-02-25 07:04:34 +00002886 assert(Root->hasLinkOnceLinkage() && Root->hasOneUse() &&
2887 "Malformed global variable descriptor anchor type");
2888 Constant *RootC = cast<Constant>(*Root->use_begin());
2889 assert(RootC->hasNUsesOrMore(1) &&
2890 "Malformed global variable descriptor anchor type");
Devang Patelc4523242009-01-05 23:11:11 +00002891
Evan Chenge3d42322009-02-25 07:04:34 +00002892 bool Result = false;
2893 for (Value::use_iterator UI = RootC->use_begin(), UE = Root->use_end();
2894 UI != UE; ++UI)
2895 for (Value::use_iterator UUI = UI->use_begin(), UUE = UI->use_end();
2896 UUI != UUE; ++UUI) {
2897 GlobalVariable *GV = cast<GlobalVariable>(*UUI);
2898 Result |= ConstructGlobalVariableDIE(GV);
2899 }
2900 return Result;
2901 }
Devang Patelc4523242009-01-05 23:11:11 +00002902
Evan Chenge3d42322009-02-25 07:04:34 +00002903 bool ConstructSubprogram(GlobalVariable *GV) {
2904 DISubprogram SP(GV);
2905 CompileUnit *Unit = MainCU;
2906 if (!Unit)
2907 Unit = FindCompileUnit(SP.getCompileUnit());
Devang Patelc4523242009-01-05 23:11:11 +00002908
Evan Chenge3d42322009-02-25 07:04:34 +00002909 // Check for pre-existence.
2910 DIE *&Slot = Unit->getDieMapSlotFor(GV);
2911 if (Slot)
2912 return false;
2913
2914 if (!SP.isDefinition())
2915 // This is a method declaration which will be handled while
2916 // constructing class type.
2917 return false;
2918
2919 DIE *SubprogramDie = CreateSubprogramDIE(Unit, SP);
2920
2921 // Add to map.
2922 Slot = SubprogramDie;
2923 // Add to context owner.
2924 Unit->getDie()->AddChild(SubprogramDie);
2925 // Expose as global.
Bill Wendlingccbdc7a2009-03-09 05:04:40 +00002926 std::string Name;
2927 Unit->AddGlobal(SP.getName(Name), SubprogramDie);
Evan Chenge3d42322009-02-25 07:04:34 +00002928 return true;
Devang Patelc4523242009-01-05 23:11:11 +00002929 }
2930
Devang Patel78eb6ad2009-01-05 23:21:35 +00002931 /// ConstructSubprograms - Create DIEs for each of the externally visible
Devang Patel53cac182009-02-24 00:02:15 +00002932 /// subprograms. Return true if at least one subprogram DIE is created.
2933 bool ConstructSubprograms() {
Evan Chenge3d42322009-02-25 07:04:34 +00002934 GlobalVariable *Root = M->getGlobalVariable("llvm.dbg.subprograms");
2935 if (!Root)
2936 return false;
Devang Patel78eb6ad2009-01-05 23:21:35 +00002937
Evan Chenge3d42322009-02-25 07:04:34 +00002938 assert(Root->hasLinkOnceLinkage() && Root->hasOneUse() &&
2939 "Malformed subprogram descriptor anchor type");
2940 Constant *RootC = cast<Constant>(*Root->use_begin());
2941 assert(RootC->hasNUsesOrMore(1) &&
2942 "Malformed subprogram descriptor anchor type");
Devang Patel78eb6ad2009-01-05 23:21:35 +00002943
Evan Chenge3d42322009-02-25 07:04:34 +00002944 bool Result = false;
2945 for (Value::use_iterator UI = RootC->use_begin(), UE = Root->use_end();
2946 UI != UE; ++UI)
2947 for (Value::use_iterator UUI = UI->use_begin(), UUE = UI->use_end();
2948 UUI != UUE; ++UUI) {
2949 GlobalVariable *GV = cast<GlobalVariable>(*UUI);
2950 Result |= ConstructSubprogram(GV);
2951 }
2952 return Result;
Devang Patel78eb6ad2009-01-05 23:21:35 +00002953 }
2954
Jim Laskey65195462006-10-30 13:35:07 +00002955public:
Jim Laskeyef42a012006-11-02 20:12:39 +00002956 //===--------------------------------------------------------------------===//
2957 // Main entry points.
2958 //
Owen Andersoncb371882008-08-21 00:14:44 +00002959 DwarfDebug(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
Bill Wendling163ba3f2009-03-10 21:23:25 +00002960 : Dwarf(OS, A, T, "dbg"), MainCU(0),
2961 AbbreviationsSet(InitAbbreviationsSetSize), Abbreviations(),
2962 ValuesSet(InitValuesSetSize), Values(), StringPool(), SectionMap(),
2963 SectionSourceLines(), didInitial(false), shouldEmit(false),
2964 RootDbgScope(0), DebugTimer(0) {
2965 if (TimePassesIsEnabled)
2966 DebugTimer = new Timer("Dwarf Debug Writer",
2967 *getDwarfTimerGroup());
Jim Laskeyef42a012006-11-02 20:12:39 +00002968 }
Jim Laskey072200c2007-01-29 18:51:14 +00002969 virtual ~DwarfDebug() {
Jim Laskeyef42a012006-11-02 20:12:39 +00002970 for (unsigned j = 0, M = Values.size(); j < M; ++j)
2971 delete Values[j];
Bill Wendling163ba3f2009-03-10 21:23:25 +00002972
2973 delete DebugTimer;
Jim Laskeyef42a012006-11-02 20:12:39 +00002974 }
2975
Devang Patel5d315982009-01-06 21:07:30 +00002976 /// SetDebugInfo - Create global DIEs and emit initial debug info sections.
2977 /// This is inovked by the target AsmPrinter.
Devang Patel3f7833a2009-01-12 23:09:42 +00002978 void SetDebugInfo(MachineModuleInfo *mmi) {
Bill Wendling163ba3f2009-03-10 21:23:25 +00002979 if (TimePassesIsEnabled)
2980 DebugTimer->startTimer();
2981
Bill Wendlingef7e18e2009-02-03 21:38:21 +00002982 // Create all the compile unit DIEs.
2983 ConstructCompileUnits();
Devang Patel3f7833a2009-01-12 23:09:42 +00002984
Bill Wendling163ba3f2009-03-10 21:23:25 +00002985 if (CompileUnits.empty()) {
2986 if (TimePassesIsEnabled)
2987 DebugTimer->startTimer();
2988
Bill Wendlingef7e18e2009-02-03 21:38:21 +00002989 return;
Bill Wendling163ba3f2009-03-10 21:23:25 +00002990 }
Devang Patel3f7833a2009-01-12 23:09:42 +00002991
Devang Patel53cac182009-02-24 00:02:15 +00002992 // Create DIEs for each of the externally visible global variables.
2993 bool globalDIEs = ConstructGlobalVariableDIEs();
2994
2995 // Create DIEs for each of the externally visible subprograms.
2996 bool subprogramDIEs = ConstructSubprograms();
2997
2998 // If there is not any debug info available for any global variables
2999 // and any subprograms then there is not any debug info to emit.
Bill Wendling163ba3f2009-03-10 21:23:25 +00003000 if (!globalDIEs && !subprogramDIEs) {
3001 if (TimePassesIsEnabled)
3002 DebugTimer->startTimer();
3003
Devang Patel53cac182009-02-24 00:02:15 +00003004 return;
Bill Wendling163ba3f2009-03-10 21:23:25 +00003005 }
Devang Patel53cac182009-02-24 00:02:15 +00003006
Bill Wendlingef7e18e2009-02-03 21:38:21 +00003007 MMI = mmi;
3008 shouldEmit = true;
3009 MMI->setDebugInfoAvailability(true);
Devang Patel5d315982009-01-06 21:07:30 +00003010
Bill Wendlingef7e18e2009-02-03 21:38:21 +00003011 // Prime section data.
3012 SectionMap.insert(TAI->getTextSection());
Devang Patel5d315982009-01-06 21:07:30 +00003013
Bill Wendlingef7e18e2009-02-03 21:38:21 +00003014 // Print out .file directives to specify files for .loc directives. These
3015 // are printed out early so that they precede any .loc directives.
3016 if (TAI->hasDotLocAndDotFile()) {
Evan Chenge3d42322009-02-25 07:04:34 +00003017 for (unsigned i = 1, e = getNumSourceIds()+1; i != e; ++i) {
3018 // Remember source id starts at 1.
3019 std::pair<unsigned, unsigned> Id = getSourceDirsectoryAndFileIds(i);
3020 sys::Path FullPath(getSourceDirectoryName(Id.first));
3021 bool AppendOk =
3022 FullPath.appendComponent(getSourceFileName(Id.second));
Bill Wendlingef7e18e2009-02-03 21:38:21 +00003023 assert(AppendOk && "Could not append filename to directory!");
3024 AppendOk = false;
3025 Asm->EmitFile(i, FullPath.toString());
3026 Asm->EOL();
Devang Patel5d315982009-01-06 21:07:30 +00003027 }
Bill Wendlingef7e18e2009-02-03 21:38:21 +00003028 }
Devang Patel5d315982009-01-06 21:07:30 +00003029
Bill Wendlingef7e18e2009-02-03 21:38:21 +00003030 // Emit initial sections
3031 EmitInitial();
Bill Wendling163ba3f2009-03-10 21:23:25 +00003032
3033 if (TimePassesIsEnabled)
3034 DebugTimer->stopTimer();
Devang Patel5d315982009-01-06 21:07:30 +00003035 }
3036
Jim Laskey65195462006-10-30 13:35:07 +00003037 /// BeginModule - Emit all Dwarf sections that should come prior to the
3038 /// content.
Jim Laskeyef42a012006-11-02 20:12:39 +00003039 void BeginModule(Module *M) {
3040 this->M = M;
Jim Laskeyef42a012006-11-02 20:12:39 +00003041 }
3042
Jim Laskey65195462006-10-30 13:35:07 +00003043 /// EndModule - Emit all Dwarf sections that should come after the content.
3044 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00003045 void EndModule() {
Bill Wendling163ba3f2009-03-10 21:23:25 +00003046 if (!ShouldEmitDwarfDebug())
3047 return;
3048
3049 if (TimePassesIsEnabled)
3050 DebugTimer->startTimer();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003051
Jim Laskeyef42a012006-11-02 20:12:39 +00003052 // Standard sections final addresses.
Anton Korobeynikovd7ca4162008-09-24 22:15:21 +00003053 Asm->SwitchToSection(TAI->getTextSection());
Jim Laskeyef42a012006-11-02 20:12:39 +00003054 EmitLabel("text_end", 0);
Anton Korobeynikov315690e2008-09-24 22:16:16 +00003055 Asm->SwitchToSection(TAI->getDataSection());
Jim Laskeyef42a012006-11-02 20:12:39 +00003056 EmitLabel("data_end", 0);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003057
Jim Laskeyef42a012006-11-02 20:12:39 +00003058 // End text sections.
3059 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Anton Korobeynikovd7ca4162008-09-24 22:15:21 +00003060 Asm->SwitchToSection(SectionMap[i]);
Jim Laskeyef42a012006-11-02 20:12:39 +00003061 EmitLabel("section_end", i);
3062 }
Anton Korobeynikov185bc892007-05-13 17:30:11 +00003063
3064 // Emit common frame information.
3065 EmitCommonDebugFrame();
3066
3067 // Emit function debug frame information
3068 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
3069 E = DebugFrames.end(); I != E; ++I)
3070 EmitFunctionDebugFrame(*I);
3071
Jim Laskeyef42a012006-11-02 20:12:39 +00003072 // Compute DIE offsets and sizes.
3073 SizeAndOffsets();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003074
Jim Laskeyef42a012006-11-02 20:12:39 +00003075 // Emit all the DIEs into a debug info section
3076 EmitDebugInfo();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003077
Jim Laskeyef42a012006-11-02 20:12:39 +00003078 // Corresponding abbreviations into a abbrev section.
3079 EmitAbbreviations();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003080
Jim Laskeyef42a012006-11-02 20:12:39 +00003081 // Emit source line correspondence into a debug line section.
3082 EmitDebugLines();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003083
Jim Laskeyef42a012006-11-02 20:12:39 +00003084 // Emit info into a debug pubnames section.
3085 EmitDebugPubNames();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003086
Jim Laskeyef42a012006-11-02 20:12:39 +00003087 // Emit info into a debug str section.
3088 EmitDebugStr();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003089
Jim Laskeyef42a012006-11-02 20:12:39 +00003090 // Emit info into a debug loc section.
3091 EmitDebugLoc();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003092
Jim Laskeyef42a012006-11-02 20:12:39 +00003093 // Emit info into a debug aranges section.
3094 EmitDebugARanges();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003095
Jim Laskeyef42a012006-11-02 20:12:39 +00003096 // Emit info into a debug ranges section.
3097 EmitDebugRanges();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003098
Jim Laskeyef42a012006-11-02 20:12:39 +00003099 // Emit info into a debug macinfo section.
3100 EmitDebugMacInfo();
Bill Wendling163ba3f2009-03-10 21:23:25 +00003101
3102 if (TimePassesIsEnabled)
3103 DebugTimer->stopTimer();
Jim Laskeyef42a012006-11-02 20:12:39 +00003104 }
3105
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003106 /// BeginFunction - Gather pre-function debug information. Assumes being
Jim Laskey65195462006-10-30 13:35:07 +00003107 /// emitted immediately after the function entry point.
Jim Laskeyef42a012006-11-02 20:12:39 +00003108 void BeginFunction(MachineFunction *MF) {
Bill Wendling4ed0c5f2009-02-20 00:44:43 +00003109 if (!ShouldEmitDwarfDebug()) return;
Jim Laskeyef42a012006-11-02 20:12:39 +00003110
Bill Wendling163ba3f2009-03-10 21:23:25 +00003111 if (TimePassesIsEnabled)
3112 DebugTimer->startTimer();
3113
3114 this->MF = MF;
3115
Jim Laskeyef42a012006-11-02 20:12:39 +00003116 // Begin accumulating function debug information.
Jim Laskey44c3b9f2007-01-26 21:22:28 +00003117 MMI->BeginFunction(MF);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003118
Jim Laskeyef42a012006-11-02 20:12:39 +00003119 // Assumes in correct section after the entry point.
3120 EmitLabel("func_begin", ++SubprogramCount);
Evan Cheng1b08bbc2008-02-01 09:10:45 +00003121
3122 // Emit label for the implicitly defined dbg.stoppoint at the start of
3123 // the function.
Devang Patelf3ee5142009-01-12 22:54:42 +00003124 if (!Lines.empty()) {
3125 const SrcLineInfo &LineInfo = Lines[0];
Andrew Lenharth51dd8c92008-04-03 17:37:43 +00003126 Asm->printLabel(LineInfo.getLabelID());
3127 }
Bill Wendling163ba3f2009-03-10 21:23:25 +00003128
3129 if (TimePassesIsEnabled)
3130 DebugTimer->stopTimer();
Jim Laskeyef42a012006-11-02 20:12:39 +00003131 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003132
Jim Laskey65195462006-10-30 13:35:07 +00003133 /// EndFunction - Gather and emit post-function debug information.
3134 ///
Bill Wendlingd751c642008-09-26 00:28:12 +00003135 void EndFunction(MachineFunction *MF) {
Bill Wendling4ed0c5f2009-02-20 00:44:43 +00003136 if (!ShouldEmitDwarfDebug()) return;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003137
Bill Wendling163ba3f2009-03-10 21:23:25 +00003138 if (TimePassesIsEnabled)
3139 DebugTimer->startTimer();
3140
Jim Laskeyb82313f2007-02-01 16:31:34 +00003141 // Define end label for subprogram.
3142 EmitLabel("func_end", SubprogramCount);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003143
Jim Laskeyef42a012006-11-02 20:12:39 +00003144 // Get function line info.
Devang Patelf3ee5142009-01-12 22:54:42 +00003145 if (!Lines.empty()) {
Jim Laskeyef42a012006-11-02 20:12:39 +00003146 // Get section line info.
Anton Korobeynikovd7ca4162008-09-24 22:15:21 +00003147 unsigned ID = SectionMap.insert(Asm->CurrentSection_);
Jim Laskeyef42a012006-11-02 20:12:39 +00003148 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
Devang Patelf3ee5142009-01-12 22:54:42 +00003149 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
Jim Laskeyef42a012006-11-02 20:12:39 +00003150 // Append the function info to section info.
3151 SectionLineInfos.insert(SectionLineInfos.end(),
Devang Patelf3ee5142009-01-12 22:54:42 +00003152 Lines.begin(), Lines.end());
Jim Laskeyef42a012006-11-02 20:12:39 +00003153 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003154
Jim Laskeyef42a012006-11-02 20:12:39 +00003155 // Construct scopes for subprogram.
Devang Patel7bb89ed2009-01-13 00:20:51 +00003156 if (RootDbgScope)
3157 ConstructRootDbgScope(RootDbgScope);
Bill Wendlingd751c642008-09-26 00:28:12 +00003158 else
3159 // FIXME: This is wrong. We are essentially getting past a problem with
3160 // debug information not being able to handle unreachable blocks that have
3161 // debug information in them. In particular, those unreachable blocks that
3162 // have "region end" info in them. That situation results in the "root
3163 // scope" not being created. If that's the case, then emit a "default"
3164 // scope, i.e., one that encompasses the whole function. This isn't
3165 // desirable. And a better way of handling this (and all of the debugging
3166 // information) needs to be explored.
Devang Patel7bb89ed2009-01-13 00:20:51 +00003167 ConstructDefaultDbgScope(MF);
Anton Korobeynikov185bc892007-05-13 17:30:11 +00003168
3169 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
3170 MMI->getFrameMoves()));
Devang Patel481ff5b2009-01-12 18:48:36 +00003171
3172 // Clear debug info
3173 if (RootDbgScope) {
3174 delete RootDbgScope;
3175 DbgScopeMap.clear();
3176 RootDbgScope = NULL;
3177 }
Devang Patelccca7fe2009-01-12 19:17:34 +00003178
Bill Wendling163ba3f2009-03-10 21:23:25 +00003179 Lines.clear();
3180
3181 if (TimePassesIsEnabled)
3182 DebugTimer->stopTimer();
3183 }
Devang Patelccca7fe2009-01-12 19:17:34 +00003184
Devang Patelcf3a4482009-01-15 23:41:32 +00003185 /// ValidDebugInfo - Return true if V represents valid debug info value.
3186 bool ValidDebugInfo(Value *V) {
Devang Patelb79b5352009-01-19 23:21:49 +00003187 if (!V)
3188 return false;
3189
Devang Patel61c6bf32009-01-16 01:49:46 +00003190 if (!shouldEmit)
3191 return false;
3192
Devang Patelcf3a4482009-01-15 23:41:32 +00003193 GlobalVariable *GV = getGlobalVariable(V);
3194 if (!GV)
3195 return false;
Duncan Sands667d4b82009-03-07 15:45:40 +00003196
3197 if (!GV->hasInternalLinkage () && !GV->hasLinkOnceLinkage())
Devang Patelcf3a4482009-01-15 23:41:32 +00003198 return false;
3199
Bill Wendling163ba3f2009-03-10 21:23:25 +00003200 if (TimePassesIsEnabled)
3201 DebugTimer->startTimer();
3202
Devang Patelcf3a4482009-01-15 23:41:32 +00003203 DIDescriptor DI(GV);
Bill Wendling163ba3f2009-03-10 21:23:25 +00003204
Devang Patelcf3a4482009-01-15 23:41:32 +00003205 // Check current version. Allow Version6 for now.
3206 unsigned Version = DI.getVersion();
Bill Wendling163ba3f2009-03-10 21:23:25 +00003207 if (Version != LLVMDebugVersion && Version != LLVMDebugVersion6) {
3208 if (TimePassesIsEnabled)
3209 DebugTimer->stopTimer();
3210
Devang Patelcf3a4482009-01-15 23:41:32 +00003211 return false;
Bill Wendling163ba3f2009-03-10 21:23:25 +00003212 }
Devang Patelcf3a4482009-01-15 23:41:32 +00003213
Devang Patelb79b5352009-01-19 23:21:49 +00003214 unsigned Tag = DI.getTag();
3215 switch (Tag) {
3216 case DW_TAG_variable:
Bill Wendlingef7e18e2009-02-03 21:38:21 +00003217 assert(DIVariable(GV).Verify() && "Invalid DebugInfo value");
Devang Patelb79b5352009-01-19 23:21:49 +00003218 break;
3219 case DW_TAG_compile_unit:
Bill Wendlingef7e18e2009-02-03 21:38:21 +00003220 assert(DICompileUnit(GV).Verify() && "Invalid DebugInfo value");
Devang Patelb79b5352009-01-19 23:21:49 +00003221 break;
3222 case DW_TAG_subprogram:
Bill Wendlingef7e18e2009-02-03 21:38:21 +00003223 assert(DISubprogram(GV).Verify() && "Invalid DebugInfo value");
Devang Patelb79b5352009-01-19 23:21:49 +00003224 break;
3225 default:
3226 break;
3227 }
3228
Bill Wendling163ba3f2009-03-10 21:23:25 +00003229 if (TimePassesIsEnabled)
3230 DebugTimer->stopTimer();
3231
Devang Patelcf3a4482009-01-15 23:41:32 +00003232 return true;
3233 }
3234
Devang Patelccca7fe2009-01-12 19:17:34 +00003235 /// RecordSourceLine - Records location information and associates it with a
3236 /// label. Returns a unique label ID used to generate a label and provide
3237 /// correspondence to the source line list.
3238 unsigned RecordSourceLine(Value *V, unsigned Line, unsigned Col) {
Bill Wendling163ba3f2009-03-10 21:23:25 +00003239 if (TimePassesIsEnabled)
3240 DebugTimer->startTimer();
3241
Evan Chenge3d42322009-02-25 07:04:34 +00003242 CompileUnit *Unit = CompileUnitMap[V];
Bill Wendlingef7e18e2009-02-03 21:38:21 +00003243 assert(Unit && "Unable to find CompileUnit");
Devang Patelccca7fe2009-01-12 19:17:34 +00003244 unsigned ID = MMI->NextLabelID();
3245 Lines.push_back(SrcLineInfo(Line, Col, Unit->getID(), ID));
Bill Wendling163ba3f2009-03-10 21:23:25 +00003246
3247 if (TimePassesIsEnabled)
3248 DebugTimer->stopTimer();
3249
Devang Patelccca7fe2009-01-12 19:17:34 +00003250 return ID;
3251 }
3252
3253 /// RecordSourceLine - Records location information and associates it with a
3254 /// label. Returns a unique label ID used to generate a label and provide
3255 /// correspondence to the source line list.
3256 unsigned RecordSourceLine(unsigned Line, unsigned Col, unsigned Src) {
Bill Wendling163ba3f2009-03-10 21:23:25 +00003257 if (TimePassesIsEnabled)
3258 DebugTimer->startTimer();
3259
Devang Patelccca7fe2009-01-12 19:17:34 +00003260 unsigned ID = MMI->NextLabelID();
3261 Lines.push_back(SrcLineInfo(Line, Col, Src, ID));
Bill Wendling163ba3f2009-03-10 21:23:25 +00003262
3263 if (TimePassesIsEnabled)
3264 DebugTimer->stopTimer();
3265
Devang Patelccca7fe2009-01-12 19:17:34 +00003266 return ID;
3267 }
3268
3269 unsigned getRecordSourceLineCount() {
3270 return Lines.size();
3271 }
3272
Evan Chenge3d42322009-02-25 07:04:34 +00003273 /// getNumSourceDirectories - Return the number of source directories in the
3274 /// debug info.
3275 unsigned getNumSourceDirectories() const {
3276 return DirectoryNames.size();
3277 }
3278
3279 /// getSourceDirectoryName - Return the name of the directory corresponding
3280 /// to the id.
3281 const std::string &getSourceDirectoryName(unsigned Id) const {
3282 return DirectoryNames[Id - 1];
3283 }
3284
3285 /// getNumSourceFiles - Return the number of source files in the debug info.
3286 ///
3287 unsigned getNumSourceFiles() const {
3288 return SourceFileNames.size();
3289 }
3290
3291 /// getSourceFileName - Return the name of the source file corresponding
3292 /// to the id.
3293 const std::string &getSourceFileName(unsigned Id) const {
3294 return SourceFileNames[Id - 1];
3295 }
3296
3297 /// getNumSourceIds - Return the number of unique source ids.
3298 ///
3299 unsigned getNumSourceIds() const {
3300 return SourceIds.size();
3301 }
3302
3303 /// getSourceDirsectoryAndFileIds - Return the directory and file ids that
3304 /// maps to the source id. Source id starts at 1.
3305 std::pair<unsigned, unsigned>
3306 getSourceDirsectoryAndFileIds(unsigned SId) const {
3307 return SourceIds[SId-1];
3308 }
3309
3310 /// getOrCreateSourceID - Look up the source id with the given directory and
3311 /// source file names. If none currently exists, create a new id and insert it
3312 /// in the SourceIds map. This can update DirectoryNames and SourceFileNames maps
3313 /// as well.
3314 unsigned getOrCreateSourceID(const std::string &DirName,
3315 const std::string &FileName) {
Bill Wendling163ba3f2009-03-10 21:23:25 +00003316 if (TimePassesIsEnabled)
3317 DebugTimer->startTimer();
3318
Evan Chenge3d42322009-02-25 07:04:34 +00003319 unsigned DId;
3320 StringMap<unsigned>::iterator DI = DirectoryIdMap.find(DirName);
Bill Wendling163ba3f2009-03-10 21:23:25 +00003321 if (DI != DirectoryIdMap.end()) {
Evan Chenge3d42322009-02-25 07:04:34 +00003322 DId = DI->getValue();
Bill Wendling163ba3f2009-03-10 21:23:25 +00003323 } else {
Evan Chenge3d42322009-02-25 07:04:34 +00003324 DId = DirectoryNames.size() + 1;
3325 DirectoryIdMap[DirName] = DId;
3326 DirectoryNames.push_back(DirName);
3327 }
3328
3329 unsigned FId;
3330 StringMap<unsigned>::iterator FI = SourceFileIdMap.find(FileName);
Bill Wendling163ba3f2009-03-10 21:23:25 +00003331 if (FI != SourceFileIdMap.end()) {
Evan Chenge3d42322009-02-25 07:04:34 +00003332 FId = FI->getValue();
Bill Wendling163ba3f2009-03-10 21:23:25 +00003333 } else {
Evan Chenge3d42322009-02-25 07:04:34 +00003334 FId = SourceFileNames.size() + 1;
3335 SourceFileIdMap[FileName] = FId;
3336 SourceFileNames.push_back(FileName);
3337 }
3338
3339 DenseMap<std::pair<unsigned, unsigned>, unsigned>::iterator SI =
3340 SourceIdMap.find(std::make_pair(DId, FId));
Bill Wendling163ba3f2009-03-10 21:23:25 +00003341
3342 if (SI != SourceIdMap.end()) {
3343 if (TimePassesIsEnabled)
3344 DebugTimer->stopTimer();
3345
Evan Chenge3d42322009-02-25 07:04:34 +00003346 return SI->second;
Bill Wendling163ba3f2009-03-10 21:23:25 +00003347 }
3348
Evan Chenge3d42322009-02-25 07:04:34 +00003349 unsigned SrcId = SourceIds.size() + 1; // DW_AT_decl_file cannot be 0.
3350 SourceIdMap[std::make_pair(DId, FId)] = SrcId;
3351 SourceIds.push_back(std::make_pair(DId, FId));
Bill Wendling163ba3f2009-03-10 21:23:25 +00003352
3353 if (TimePassesIsEnabled)
3354 DebugTimer->stopTimer();
3355
Evan Chenge3d42322009-02-25 07:04:34 +00003356 return SrcId;
Devang Patelccca7fe2009-01-12 19:17:34 +00003357 }
3358
3359 /// RecordRegionStart - Indicate the start of a region.
3360 ///
3361 unsigned RecordRegionStart(GlobalVariable *V) {
Bill Wendling163ba3f2009-03-10 21:23:25 +00003362 if (TimePassesIsEnabled)
3363 DebugTimer->startTimer();
3364
Devang Patelccca7fe2009-01-12 19:17:34 +00003365 DbgScope *Scope = getOrCreateScope(V);
3366 unsigned ID = MMI->NextLabelID();
3367 if (!Scope->getStartLabelID()) Scope->setStartLabelID(ID);
Bill Wendling163ba3f2009-03-10 21:23:25 +00003368
3369 if (TimePassesIsEnabled)
3370 DebugTimer->stopTimer();
3371
Devang Patelccca7fe2009-01-12 19:17:34 +00003372 return ID;
3373 }
3374
3375 /// RecordRegionEnd - Indicate the end of a region.
3376 ///
3377 unsigned RecordRegionEnd(GlobalVariable *V) {
Bill Wendling163ba3f2009-03-10 21:23:25 +00003378 if (TimePassesIsEnabled)
3379 DebugTimer->startTimer();
3380
Devang Patelccca7fe2009-01-12 19:17:34 +00003381 DbgScope *Scope = getOrCreateScope(V);
3382 unsigned ID = MMI->NextLabelID();
3383 Scope->setEndLabelID(ID);
Bill Wendling163ba3f2009-03-10 21:23:25 +00003384
3385 if (TimePassesIsEnabled)
3386 DebugTimer->stopTimer();
3387
Devang Patelccca7fe2009-01-12 19:17:34 +00003388 return ID;
3389 }
3390
3391 /// RecordVariable - Indicate the declaration of a local variable.
3392 ///
3393 void RecordVariable(GlobalVariable *GV, unsigned FrameIndex) {
Bill Wendling163ba3f2009-03-10 21:23:25 +00003394 if (TimePassesIsEnabled)
3395 DebugTimer->startTimer();
3396
Devang Patel0e5200f2009-01-15 18:25:17 +00003397 DIDescriptor Desc(GV);
3398 DbgScope *Scope = NULL;
Bill Wendling163ba3f2009-03-10 21:23:25 +00003399
Devang Patel0e5200f2009-01-15 18:25:17 +00003400 if (Desc.getTag() == DW_TAG_variable) {
3401 // GV is a global variable.
3402 DIGlobalVariable DG(GV);
3403 Scope = getOrCreateScope(DG.getContext().getGV());
3404 } else {
3405 // or GV is a local variable.
3406 DIVariable DV(GV);
3407 Scope = getOrCreateScope(DV.getContext().getGV());
3408 }
Bill Wendling163ba3f2009-03-10 21:23:25 +00003409
Bill Wendlingef7e18e2009-02-03 21:38:21 +00003410 assert(Scope && "Unable to find variable' scope");
Devang Patel99ec3532009-01-16 19:28:14 +00003411 DbgVariable *DV = new DbgVariable(DIVariable(GV), FrameIndex);
Devang Patelccca7fe2009-01-12 19:17:34 +00003412 Scope->AddVariable(DV);
Bill Wendling163ba3f2009-03-10 21:23:25 +00003413
3414 if (TimePassesIsEnabled)
3415 DebugTimer->stopTimer();
Devang Patelccca7fe2009-01-12 19:17:34 +00003416 }
Jim Laskey65195462006-10-30 13:35:07 +00003417};
3418
Jim Laskey072200c2007-01-29 18:51:14 +00003419//===----------------------------------------------------------------------===//
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003420/// DwarfException - Emits Dwarf exception handling directives.
Jim Laskey072200c2007-01-29 18:51:14 +00003421///
3422class DwarfException : public Dwarf {
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003423 struct FunctionEHFrameInfo {
3424 std::string FnName;
3425 unsigned Number;
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00003426 unsigned PersonalityIndex;
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003427 bool hasCalls;
3428 bool hasLandingPads;
3429 std::vector<MachineMove> Moves;
Dale Johannesen48ae02f2008-01-16 19:59:28 +00003430 const Function * function;
Jim Laskeyb82313f2007-02-01 16:31:34 +00003431
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00003432 FunctionEHFrameInfo(const std::string &FN, unsigned Num, unsigned P,
3433 bool hC, bool hL,
Dale Johannesen1d4ce2a2007-11-20 23:24:42 +00003434 const std::vector<MachineMove> &M,
Dale Johannesen48ae02f2008-01-16 19:59:28 +00003435 const Function *f):
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00003436 FnName(FN), Number(Num), PersonalityIndex(P),
Dale Johannesen48ae02f2008-01-16 19:59:28 +00003437 hasCalls(hC), hasLandingPads(hL), Moves(M), function (f) { }
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003438 };
3439
3440 std::vector<FunctionEHFrameInfo> EHFrames;
Dale Johannesen1532f3d2008-04-02 00:25:04 +00003441
3442 /// shouldEmitTable - Per-function flag to indicate if EH tables should
3443 /// be emitted.
3444 bool shouldEmitTable;
3445
3446 /// shouldEmitMoves - Per-function flag to indicate if frame moves info
3447 /// should be emitted.
3448 bool shouldEmitMoves;
3449
3450 /// shouldEmitTableModule - Per-module flag to indicate if EH tables
3451 /// should be emitted.
3452 bool shouldEmitTableModule;
3453
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003454 /// shouldEmitFrameModule - Per-module flag to indicate if frame moves
Dale Johannesen1532f3d2008-04-02 00:25:04 +00003455 /// should be emitted.
3456 bool shouldEmitMovesModule;
Duncan Sands671fa972008-05-07 19:11:09 +00003457
Bill Wendling163ba3f2009-03-10 21:23:25 +00003458 /// ExceptionTimer - Timer for the Dwarf exception writer.
3459 Timer *ExceptionTimer;
3460
Jim Laskey3f09fc22007-02-28 18:38:31 +00003461 /// EmitCommonEHFrame - Emit the common eh unwind frame.
3462 ///
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00003463 void EmitCommonEHFrame(const Function *Personality, unsigned Index) {
Jim Laskeybacd3042007-02-21 22:48:45 +00003464 // Size and sign of stack growth.
Jim Laskeyb82313f2007-02-01 16:31:34 +00003465 int stackGrowth =
3466 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3467 TargetFrameInfo::StackGrowsUp ?
Dan Gohman82482942007-09-27 23:12:31 +00003468 TD->getPointerSize() : -TD->getPointerSize();
Jim Laskeyb82313f2007-02-01 16:31:34 +00003469
Jim Laskeybacd3042007-02-21 22:48:45 +00003470 // Begin eh frame section.
Jim Laskeyb82313f2007-02-01 16:31:34 +00003471 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
Bill Wendling722f5f12008-12-24 08:05:17 +00003472
3473 if (!TAI->doesRequireNonLocalEHFrameLabel())
3474 O << TAI->getEHGlobalPrefix();
3475 O << "EH_frame" << Index << ":\n";
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00003476 EmitLabel("section_eh_frame", Index);
Jim Laskeyb82313f2007-02-01 16:31:34 +00003477
Jim Laskeybacd3042007-02-21 22:48:45 +00003478 // Define base labels.
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00003479 EmitLabel("eh_frame_common", Index);
Duncan Sands671fa972008-05-07 19:11:09 +00003480
Jim Laskeybacd3042007-02-21 22:48:45 +00003481 // Define the eh frame length.
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00003482 EmitDifference("eh_frame_common_end", Index,
3483 "eh_frame_common_begin", Index, true);
Jim Laskeyb82313f2007-02-01 16:31:34 +00003484 Asm->EOL("Length of Common Information Entry");
3485
Jim Laskeybacd3042007-02-21 22:48:45 +00003486 // EH frame header.
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00003487 EmitLabel("eh_frame_common_begin", Index);
Jim Laskeyb82313f2007-02-01 16:31:34 +00003488 Asm->EmitInt32((int)0);
3489 Asm->EOL("CIE Identifier Tag");
3490 Asm->EmitInt8(DW_CIE_VERSION);
3491 Asm->EOL("CIE Version");
Duncan Sands671fa972008-05-07 19:11:09 +00003492
Jim Laskeybacd3042007-02-21 22:48:45 +00003493 // The personality presence indicates that language specific information
3494 // will show up in the eh frame.
3495 Asm->EmitString(Personality ? "zPLR" : "zR");
Jim Laskeyb82313f2007-02-01 16:31:34 +00003496 Asm->EOL("CIE Augmentation");
Duncan Sands671fa972008-05-07 19:11:09 +00003497
Jim Laskeybacd3042007-02-21 22:48:45 +00003498 // Round out reader.
Jim Laskeyb82313f2007-02-01 16:31:34 +00003499 Asm->EmitULEB128Bytes(1);
3500 Asm->EOL("CIE Code Alignment Factor");
3501 Asm->EmitSLEB128Bytes(stackGrowth);
Duncan Sands671fa972008-05-07 19:11:09 +00003502 Asm->EOL("CIE Data Alignment Factor");
Dale Johannesenb97aec62007-11-13 19:13:01 +00003503 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), true));
Duncan Sands671fa972008-05-07 19:11:09 +00003504 Asm->EOL("CIE Return Address Column");
3505
Jim Laskeybacd3042007-02-21 22:48:45 +00003506 // If there is a personality, we need to indicate the functions location.
3507 if (Personality) {
3508 Asm->EmitULEB128Bytes(7);
3509 Asm->EOL("Augmentation Size");
Bill Wendlingef4a6612007-09-11 17:20:55 +00003510
Duncan Sands671fa972008-05-07 19:11:09 +00003511 if (TAI->getNeedsIndirectEncoding()) {
Bill Wendlingef4a6612007-09-11 17:20:55 +00003512 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4 | DW_EH_PE_indirect);
Duncan Sands671fa972008-05-07 19:11:09 +00003513 Asm->EOL("Personality (pcrel sdata4 indirect)");
3514 } else {
Bill Wendlingef4a6612007-09-11 17:20:55 +00003515 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
Duncan Sands671fa972008-05-07 19:11:09 +00003516 Asm->EOL("Personality (pcrel sdata4)");
3517 }
Bill Wendlingef4a6612007-09-11 17:20:55 +00003518
Duncan Sands671fa972008-05-07 19:11:09 +00003519 PrintRelDirective(true);
Bill Wendlingd60da492007-09-11 08:27:17 +00003520 O << TAI->getPersonalityPrefix();
3521 Asm->EmitExternalGlobal((const GlobalVariable *)(Personality));
3522 O << TAI->getPersonalitySuffix();
Duncan Sands43b30a82008-05-08 12:33:11 +00003523 if (strcmp(TAI->getPersonalitySuffix(), "+4@GOTPCREL"))
3524 O << "-" << TAI->getPCSymbol();
Bill Wendlingd60da492007-09-11 08:27:17 +00003525 Asm->EOL("Personality");
Bill Wendlingcf4bb312007-08-25 00:51:55 +00003526
Duncan Sands671fa972008-05-07 19:11:09 +00003527 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3528 Asm->EOL("LSDA Encoding (pcrel sdata4)");
Bill Wendlingd4121be2008-12-24 05:25:49 +00003529
Bill Wendlingd60de512009-01-05 22:53:45 +00003530 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3531 Asm->EOL("FDE Encoding (pcrel sdata4)");
Jim Laskeybacd3042007-02-21 22:48:45 +00003532 } else {
3533 Asm->EmitULEB128Bytes(1);
3534 Asm->EOL("Augmentation Size");
Bill Wendlingd4121be2008-12-24 05:25:49 +00003535
Bill Wendlingd60de512009-01-05 22:53:45 +00003536 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3537 Asm->EOL("FDE Encoding (pcrel sdata4)");
Jim Laskeybacd3042007-02-21 22:48:45 +00003538 }
3539
3540 // Indicate locations of general callee saved registers in frame.
Jim Laskeyb82313f2007-02-01 16:31:34 +00003541 std::vector<MachineMove> Moves;
3542 RI->getInitialFrameState(Moves);
Dale Johannesenb97aec62007-11-13 19:13:01 +00003543 EmitFrameMoves(NULL, 0, Moves, true);
Jim Laskeyb82313f2007-02-01 16:31:34 +00003544
Dale Johannesen21d972a2008-04-30 00:43:29 +00003545 // On Darwin the linker honors the alignment of eh_frame, which means it
3546 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3547 // you get holes which confuse readers of eh_frame.
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003548 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
Dale Johannesen7b251e02008-04-29 22:58:20 +00003549 0, 0, false);
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00003550 EmitLabel("eh_frame_common_end", Index);
Duncan Sands671fa972008-05-07 19:11:09 +00003551
Jim Laskeybacd3042007-02-21 22:48:45 +00003552 Asm->EOL();
Jim Laskeyb82313f2007-02-01 16:31:34 +00003553 }
Duncan Sands671fa972008-05-07 19:11:09 +00003554
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003555 /// EmitEHFrame - Emit function exception frame information.
Jim Laskeyb82313f2007-02-01 16:31:34 +00003556 ///
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003557 void EmitEHFrame(const FunctionEHFrameInfo &EHFrameInfo) {
Dale Johannesen48ae02f2008-01-16 19:59:28 +00003558 Function::LinkageTypes linkage = EHFrameInfo.function->getLinkage();
3559
Jim Laskeybacd3042007-02-21 22:48:45 +00003560 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3561
3562 // Externally visible entry into the functions eh frame info.
Dale Johannesen1d4ce2a2007-11-20 23:24:42 +00003563 // If the corresponding function is static, this should not be
3564 // externally visible.
Rafael Espindolabb46f522009-01-15 20:18:42 +00003565 if (linkage != Function::InternalLinkage &&
Devang Patel2d1768c2009-01-17 08:05:14 +00003566 linkage != Function::PrivateLinkage) {
Dale Johannesen1d4ce2a2007-11-20 23:24:42 +00003567 if (const char *GlobalEHDirective = TAI->getGlobalEHDirective())
3568 O << GlobalEHDirective << EHFrameInfo.FnName << "\n";
3569 }
3570
Dale Johannesen038129d2008-01-10 02:03:30 +00003571 // If corresponding function is weak definition, this should be too.
Duncan Sands667d4b82009-03-07 15:45:40 +00003572 if ((linkage == Function::WeakAnyLinkage ||
3573 linkage == Function::WeakODRLinkage ||
3574 linkage == Function::LinkOnceAnyLinkage ||
3575 linkage == Function::LinkOnceODRLinkage) &&
Dale Johannesen038129d2008-01-10 02:03:30 +00003576 TAI->getWeakDefDirective())
3577 O << TAI->getWeakDefDirective() << EHFrameInfo.FnName << "\n";
3578
3579 // If there are no calls then you can't unwind. This may mean we can
3580 // omit the EH Frame, but some environments do not handle weak absolute
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003581 // symbols.
Dale Johannesen3541af72008-04-14 17:54:17 +00003582 // If UnwindTablesMandatory is set we cannot do this optimization; the
Dale Johannesen4e1b7942008-04-08 00:10:24 +00003583 // unwind info is to be available for non-EH uses.
Dale Johannesen038129d2008-01-10 02:03:30 +00003584 if (!EHFrameInfo.hasCalls &&
Dale Johannesen3541af72008-04-14 17:54:17 +00003585 !UnwindTablesMandatory &&
Duncan Sands667d4b82009-03-07 15:45:40 +00003586 ((linkage != Function::WeakAnyLinkage &&
3587 linkage != Function::WeakODRLinkage &&
3588 linkage != Function::LinkOnceAnyLinkage &&
3589 linkage != Function::LinkOnceODRLinkage) ||
Dale Johannesen038129d2008-01-10 02:03:30 +00003590 !TAI->getWeakDefDirective() ||
3591 TAI->getSupportsWeakOmittedEHFrame()))
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003592 {
Bill Wendling6e198962007-09-18 01:47:22 +00003593 O << EHFrameInfo.FnName << " = 0\n";
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003594 // This name has no connection to the function, so it might get
3595 // dead-stripped when the function is not, erroneously. Prohibit
Dale Johannesen48ae02f2008-01-16 19:59:28 +00003596 // dead-stripping unconditionally.
3597 if (const char *UsedDirective = TAI->getUsedDirective())
3598 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
Jim Laskeybacd3042007-02-21 22:48:45 +00003599 } else {
Bill Wendling6e198962007-09-18 01:47:22 +00003600 O << EHFrameInfo.FnName << ":\n";
Dale Johannesen1d4ce2a2007-11-20 23:24:42 +00003601
Jim Laskeybacd3042007-02-21 22:48:45 +00003602 // EH frame header.
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003603 EmitDifference("eh_frame_end", EHFrameInfo.Number,
3604 "eh_frame_begin", EHFrameInfo.Number, true);
Jim Laskeybacd3042007-02-21 22:48:45 +00003605 Asm->EOL("Length of Frame Information Entry");
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003606
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003607 EmitLabel("eh_frame_begin", EHFrameInfo.Number);
Anton Korobeynikova6199c82007-03-07 02:47:57 +00003608
Bill Wendling722f5f12008-12-24 08:05:17 +00003609 if (TAI->doesRequireNonLocalEHFrameLabel()) {
3610 PrintRelDirective(true, true);
3611 PrintLabelName("eh_frame_begin", EHFrameInfo.Number);
3612
3613 if (!TAI->isAbsoluteEHSectionOffsets())
3614 O << "-EH_frame" << EHFrameInfo.PersonalityIndex;
3615 } else {
3616 EmitSectionOffset("eh_frame_begin", "eh_frame_common",
3617 EHFrameInfo.Number, EHFrameInfo.PersonalityIndex,
3618 true, true, false);
3619 }
3620
Jim Laskeybacd3042007-02-21 22:48:45 +00003621 Asm->EOL("FDE CIE offset");
3622
Bill Wendling5fe1fac2009-01-06 19:13:55 +00003623 EmitReference("eh_func_begin", EHFrameInfo.Number, true, true);
Jim Laskeybacd3042007-02-21 22:48:45 +00003624 Asm->EOL("FDE initial location");
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003625 EmitDifference("eh_func_end", EHFrameInfo.Number,
Bill Wendling5fe1fac2009-01-06 19:13:55 +00003626 "eh_func_begin", EHFrameInfo.Number, true);
Jim Laskeybacd3042007-02-21 22:48:45 +00003627 Asm->EOL("FDE address range");
Duncan Sands671fa972008-05-07 19:11:09 +00003628
Jim Laskey3f09fc22007-02-28 18:38:31 +00003629 // If there is a personality and landing pads then point to the language
3630 // specific data area in the exception table.
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00003631 if (EHFrameInfo.PersonalityIndex) {
Duncan Sands671fa972008-05-07 19:11:09 +00003632 Asm->EmitULEB128Bytes(4);
Jim Laskeybacd3042007-02-21 22:48:45 +00003633 Asm->EOL("Augmentation size");
Duncan Sands671fa972008-05-07 19:11:09 +00003634
3635 if (EHFrameInfo.hasLandingPads)
3636 EmitReference("exception", EHFrameInfo.Number, true, true);
3637 else
Jim Laskey3f09fc22007-02-28 18:38:31 +00003638 Asm->EmitInt32((int)0);
Jim Laskeybacd3042007-02-21 22:48:45 +00003639 Asm->EOL("Language Specific Data Area");
3640 } else {
3641 Asm->EmitULEB128Bytes(0);
3642 Asm->EOL("Augmentation size");
3643 }
Duncan Sands671fa972008-05-07 19:11:09 +00003644
Jim Laskeybacd3042007-02-21 22:48:45 +00003645 // Indicate locations of function specific callee saved registers in
3646 // frame.
Devang Patel5aac3d32009-01-17 08:01:33 +00003647 EmitFrameMoves("eh_func_begin", EHFrameInfo.Number, EHFrameInfo.Moves,
Devang Patel2d1768c2009-01-17 08:05:14 +00003648 true);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003649
Dale Johannesen21d972a2008-04-30 00:43:29 +00003650 // On Darwin the linker honors the alignment of eh_frame, which means it
3651 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3652 // you get holes which confuse readers of eh_frame.
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003653 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
Dale Johannesen7b251e02008-04-29 22:58:20 +00003654 0, 0, false);
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003655 EmitLabel("eh_frame_end", EHFrameInfo.Number);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003656
3657 // If the function is marked used, this table should be also. We cannot
Dale Johannesen48ae02f2008-01-16 19:59:28 +00003658 // make the mark unconditional in this case, since retaining the table
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003659 // also retains the function in this case, and there is code around
Dale Johannesen48ae02f2008-01-16 19:59:28 +00003660 // that depends on unused functions (calling undefined externals) being
3661 // dead-stripped to link correctly. Yes, there really is.
3662 if (MMI->getUsedFunctions().count(EHFrameInfo.function))
3663 if (const char *UsedDirective = TAI->getUsedDirective())
3664 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3665 }
Jim Laskeybacd3042007-02-21 22:48:45 +00003666 }
Duncan Sands7bf7a442007-05-21 18:50:28 +00003667
Duncan Sands57810cd2007-09-05 11:27:52 +00003668 /// EmitExceptionTable - Emit landing pads and actions.
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003669 ///
3670 /// The general organization of the table is complex, but the basic concepts
3671 /// are easy. First there is a header which describes the location and
3672 /// organization of the three components that follow.
3673 /// 1. The landing pad site information describes the range of code covered
3674 /// by the try. In our case it's an accumulation of the ranges covered
3675 /// by the invokes in the try. There is also a reference to the landing
3676 /// pad that handles the exception once processed. Finally an index into
3677 /// the actions table.
3678 /// 2. The action table, in our case, is composed of pairs of type ids
3679 /// and next action offset. Starting with the action index from the
3680 /// landing pad site, each type Id is checked for a match to the current
3681 /// exception. If it matches then the exception and type id are passed
3682 /// on to the landing pad. Otherwise the next action is looked up. This
3683 /// chain is terminated with a next action of zero. If no type id is
3684 /// found the the frame is unwound and handling continues.
3685 /// 3. Type id table contains references to all the C++ typeinfo for all
3686 /// catches in the function. This tables is reversed indexed base 1.
3687
Duncan Sandsb32edb42007-06-06 15:37:31 +00003688 /// SharedTypeIds - How many leading type ids two landing pads have in common.
3689 static unsigned SharedTypeIds(const LandingPadInfo *L,
3690 const LandingPadInfo *R) {
3691 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003692 unsigned LSize = LIds.size(), RSize = RIds.size();
Duncan Sandsb32edb42007-06-06 15:37:31 +00003693 unsigned MinSize = LSize < RSize ? LSize : RSize;
3694 unsigned Count = 0;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003695
Duncan Sandsb32edb42007-06-06 15:37:31 +00003696 for (; Count != MinSize; ++Count)
3697 if (LIds[Count] != RIds[Count])
3698 return Count;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003699
Duncan Sandsb32edb42007-06-06 15:37:31 +00003700 return Count;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003701 }
3702
Duncan Sandsb32edb42007-06-06 15:37:31 +00003703 /// PadLT - Order landing pads lexicographically by type id.
Duncan Sands7bf7a442007-05-21 18:50:28 +00003704 static bool PadLT(const LandingPadInfo *L, const LandingPadInfo *R) {
Duncan Sandsb32edb42007-06-06 15:37:31 +00003705 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003706 unsigned LSize = LIds.size(), RSize = RIds.size();
Duncan Sandsb32edb42007-06-06 15:37:31 +00003707 unsigned MinSize = LSize < RSize ? LSize : RSize;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003708
Duncan Sandsb32edb42007-06-06 15:37:31 +00003709 for (unsigned i = 0; i != MinSize; ++i)
Duncan Sands7bf7a442007-05-21 18:50:28 +00003710 if (LIds[i] != RIds[i])
3711 return LIds[i] < RIds[i];
3712
Duncan Sandsb32edb42007-06-06 15:37:31 +00003713 return LSize < RSize;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003714 }
3715
Duncan Sands53c3a332007-05-16 12:12:23 +00003716 struct KeyInfo {
3717 static inline unsigned getEmptyKey() { return -1U; }
3718 static inline unsigned getTombstoneKey() { return -2U; }
3719 static unsigned getHashValue(const unsigned &Key) { return Key; }
Chris Lattner76c1b972007-09-17 18:34:04 +00003720 static bool isEqual(unsigned LHS, unsigned RHS) { return LHS == RHS; }
Duncan Sands53c3a332007-05-16 12:12:23 +00003721 static bool isPod() { return true; }
3722 };
3723
Duncan Sands57810cd2007-09-05 11:27:52 +00003724 /// ActionEntry - Structure describing an entry in the actions table.
Duncan Sandsb32edb42007-06-06 15:37:31 +00003725 struct ActionEntry {
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003726 int ValueForTypeID; // The value to write - may not be equal to the type id.
Duncan Sandsb32edb42007-06-06 15:37:31 +00003727 int NextAction;
3728 struct ActionEntry *Previous;
3729 };
3730
Duncan Sands57810cd2007-09-05 11:27:52 +00003731 /// PadRange - Structure holding a try-range and the associated landing pad.
3732 struct PadRange {
3733 // The index of the landing pad.
3734 unsigned PadIndex;
3735 // The index of the begin and end labels in the landing pad's label lists.
3736 unsigned RangeIndex;
3737 };
3738
3739 typedef DenseMap<unsigned, PadRange, KeyInfo> RangeMapType;
3740
3741 /// CallSiteEntry - Structure describing an entry in the call-site table.
3742 struct CallSiteEntry {
Duncan Sands481dc722007-12-19 07:36:31 +00003743 // The 'try-range' is BeginLabel .. EndLabel.
Duncan Sands57810cd2007-09-05 11:27:52 +00003744 unsigned BeginLabel; // zero indicates the start of the function.
3745 unsigned EndLabel; // zero indicates the end of the function.
Duncan Sands481dc722007-12-19 07:36:31 +00003746 // The landing pad starts at PadLabel.
Duncan Sands57810cd2007-09-05 11:27:52 +00003747 unsigned PadLabel; // zero indicates that there is no landing pad.
3748 unsigned Action;
3749 };
3750
Jim Laskeybacd3042007-02-21 22:48:45 +00003751 void EmitExceptionTable() {
Jim Laskeybacd3042007-02-21 22:48:45 +00003752 const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
Duncan Sands73ef58a2007-06-02 16:53:42 +00003753 const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
Duncan Sands7bf7a442007-05-21 18:50:28 +00003754 const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
3755 if (PadInfos.empty()) return;
3756
3757 // Sort the landing pads in order of their type ids. This is used to fold
3758 // duplicate actions.
Duncan Sands6cc76082007-06-08 08:59:11 +00003759 SmallVector<const LandingPadInfo *, 64> LandingPads;
Duncan Sands6cc76082007-06-08 08:59:11 +00003760 LandingPads.reserve(PadInfos.size());
Duncan Sands7bf7a442007-05-21 18:50:28 +00003761 for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
Duncan Sands6cc76082007-06-08 08:59:11 +00003762 LandingPads.push_back(&PadInfos[i]);
Duncan Sands7bf7a442007-05-21 18:50:28 +00003763 std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
3764
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003765 // Negative type ids index into FilterIds, positive type ids index into
3766 // TypeInfos. The value written for a positive type id is just the type
3767 // id itself. For a negative type id, however, the value written is the
3768 // (negative) byte offset of the corresponding FilterIds entry. The byte
3769 // offset is usually equal to the type id, because the FilterIds entries
3770 // are written using a variable width encoding which outputs one byte per
3771 // entry as long as the value written is not too large, but can differ.
3772 // This kind of complication does not occur for positive type ids because
3773 // type infos are output using a fixed width encoding.
3774 // FilterOffsets[i] holds the byte offset corresponding to FilterIds[i].
3775 SmallVector<int, 16> FilterOffsets;
3776 FilterOffsets.reserve(FilterIds.size());
3777 int Offset = -1;
3778 for(std::vector<unsigned>::const_iterator I = FilterIds.begin(),
3779 E = FilterIds.end(); I != E; ++I) {
3780 FilterOffsets.push_back(Offset);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003781 Offset -= TargetAsmInfo::getULEB128Size(*I);
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003782 }
3783
Duncan Sands57810cd2007-09-05 11:27:52 +00003784 // Compute the actions table and gather the first action index for each
3785 // landing pad site.
3786 SmallVector<ActionEntry, 32> Actions;
3787 SmallVector<unsigned, 64> FirstActions;
3788 FirstActions.reserve(LandingPads.size());
Jim Laskeybacd3042007-02-21 22:48:45 +00003789
Duncan Sandsb32edb42007-06-06 15:37:31 +00003790 int FirstAction = 0;
Duncan Sands57810cd2007-09-05 11:27:52 +00003791 unsigned SizeActions = 0;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003792 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
Duncan Sandsb32edb42007-06-06 15:37:31 +00003793 const LandingPadInfo *LP = LandingPads[i];
3794 const std::vector<int> &TypeIds = LP->TypeIds;
3795 const unsigned NumShared = i ? SharedTypeIds(LP, LandingPads[i-1]) : 0;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003796 unsigned SizeSiteActions = 0;
3797
Duncan Sandsb32edb42007-06-06 15:37:31 +00003798 if (NumShared < TypeIds.size()) {
Duncan Sands7bf7a442007-05-21 18:50:28 +00003799 unsigned SizeAction = 0;
Duncan Sandsb32edb42007-06-06 15:37:31 +00003800 ActionEntry *PrevAction = 0;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003801
Duncan Sandsb32edb42007-06-06 15:37:31 +00003802 if (NumShared) {
3803 const unsigned SizePrevIds = LandingPads[i-1]->TypeIds.size();
3804 assert(Actions.size());
3805 PrevAction = &Actions.back();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003806 SizeAction = TargetAsmInfo::getSLEB128Size(PrevAction->NextAction) +
3807 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
Duncan Sandsb32edb42007-06-06 15:37:31 +00003808 for (unsigned j = NumShared; j != SizePrevIds; ++j) {
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003809 SizeAction -=
3810 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
Duncan Sandsb32edb42007-06-06 15:37:31 +00003811 SizeAction += -PrevAction->NextAction;
3812 PrevAction = PrevAction->Previous;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003813 }
Anton Korobeynikoveeb37e02007-05-10 22:34:59 +00003814 }
Duncan Sands7bf7a442007-05-21 18:50:28 +00003815
Duncan Sandsb32edb42007-06-06 15:37:31 +00003816 // Compute the actions.
3817 for (unsigned I = NumShared, M = TypeIds.size(); I != M; ++I) {
3818 int TypeID = TypeIds[I];
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003819 assert(-1-TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
3820 int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003821 unsigned SizeTypeID = TargetAsmInfo::getSLEB128Size(ValueForTypeID);
Duncan Sandsb32edb42007-06-06 15:37:31 +00003822
3823 int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003824 SizeAction = SizeTypeID + TargetAsmInfo::getSLEB128Size(NextAction);
Duncan Sandsb32edb42007-06-06 15:37:31 +00003825 SizeSiteActions += SizeAction;
3826
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003827 ActionEntry Action = {ValueForTypeID, NextAction, PrevAction};
Duncan Sandsb32edb42007-06-06 15:37:31 +00003828 Actions.push_back(Action);
3829
3830 PrevAction = &Actions.back();
3831 }
3832
3833 // Record the first action of the landing pad site.
3834 FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
3835 } // else identical - re-use previous FirstAction
3836
3837 FirstActions.push_back(FirstAction);
Duncan Sands7bf7a442007-05-21 18:50:28 +00003838
Anton Korobeynikov29c9caf2007-05-11 08:23:57 +00003839 // Compute this sites contribution to size.
Anton Korobeynikov22d5c372007-05-11 08:47:35 +00003840 SizeActions += SizeSiteActions;
Jim Laskeybacd3042007-02-21 22:48:45 +00003841 }
Duncan Sands57810cd2007-09-05 11:27:52 +00003842
Duncan Sands481dc722007-12-19 07:36:31 +00003843 // Compute the call-site table. The entry for an invoke has a try-range
3844 // containing the call, a non-zero landing pad and an appropriate action.
3845 // The entry for an ordinary call has a try-range containing the call and
3846 // zero for the landing pad and the action. Calls marked 'nounwind' have
3847 // no entry and must not be contained in the try-range of any entry - they
3848 // form gaps in the table. Entries must be ordered by try-range address.
Duncan Sands57810cd2007-09-05 11:27:52 +00003849 SmallVector<CallSiteEntry, 64> CallSites;
3850
3851 RangeMapType PadMap;
Duncan Sands481dc722007-12-19 07:36:31 +00003852 // Invokes and nounwind calls have entries in PadMap (due to being bracketed
3853 // by try-range labels when lowered). Ordinary calls do not, so appropriate
3854 // try-ranges for them need be deduced.
Duncan Sands57810cd2007-09-05 11:27:52 +00003855 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3856 const LandingPadInfo *LandingPad = LandingPads[i];
Duncan Sands481dc722007-12-19 07:36:31 +00003857 for (unsigned j = 0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
Duncan Sands57810cd2007-09-05 11:27:52 +00003858 unsigned BeginLabel = LandingPad->BeginLabels[j];
3859 assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
3860 PadRange P = { i, j };
3861 PadMap[BeginLabel] = P;
3862 }
3863 }
3864
Duncan Sands481dc722007-12-19 07:36:31 +00003865 // The end label of the previous invoke or nounwind try-range.
Duncan Sands57810cd2007-09-05 11:27:52 +00003866 unsigned LastLabel = 0;
Duncan Sands481dc722007-12-19 07:36:31 +00003867
3868 // Whether there is a potentially throwing instruction (currently this means
3869 // an ordinary call) between the end of the previous try-range and now.
3870 bool SawPotentiallyThrowing = false;
3871
3872 // Whether the last callsite entry was for an invoke.
3873 bool PreviousIsInvoke = false;
3874
Duncan Sands481dc722007-12-19 07:36:31 +00003875 // Visit all instructions in order of address.
Duncan Sands57810cd2007-09-05 11:27:52 +00003876 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
3877 I != E; ++I) {
3878 for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
3879 MI != E; ++MI) {
Dan Gohman44066042008-07-01 00:05:16 +00003880 if (!MI->isLabel()) {
Chris Lattner749c6f62008-01-07 07:27:27 +00003881 SawPotentiallyThrowing |= MI->getDesc().isCall();
Duncan Sands57810cd2007-09-05 11:27:52 +00003882 continue;
3883 }
3884
Chris Lattner9e330492007-12-30 20:50:28 +00003885 unsigned BeginLabel = MI->getOperand(0).getImm();
Duncan Sands57810cd2007-09-05 11:27:52 +00003886 assert(BeginLabel && "Invalid label!");
Duncan Sands98865042007-09-05 14:12:46 +00003887
Duncan Sands481dc722007-12-19 07:36:31 +00003888 // End of the previous try-range?
Duncan Sands98865042007-09-05 14:12:46 +00003889 if (BeginLabel == LastLabel)
Duncan Sands481dc722007-12-19 07:36:31 +00003890 SawPotentiallyThrowing = false;
Duncan Sands57810cd2007-09-05 11:27:52 +00003891
Duncan Sands481dc722007-12-19 07:36:31 +00003892 // Beginning of a new try-range?
Duncan Sands57810cd2007-09-05 11:27:52 +00003893 RangeMapType::iterator L = PadMap.find(BeginLabel);
Duncan Sands57810cd2007-09-05 11:27:52 +00003894 if (L == PadMap.end())
Duncan Sands481dc722007-12-19 07:36:31 +00003895 // Nope, it was just some random label.
Duncan Sands57810cd2007-09-05 11:27:52 +00003896 continue;
3897
3898 PadRange P = L->second;
3899 const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
3900
3901 assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
3902 "Inconsistent landing pad map!");
3903
3904 // If some instruction between the previous try-range and this one may
3905 // throw, create a call-site entry with no landing pad for the region
3906 // between the try-ranges.
Duncan Sands481dc722007-12-19 07:36:31 +00003907 if (SawPotentiallyThrowing) {
Duncan Sands57810cd2007-09-05 11:27:52 +00003908 CallSiteEntry Site = {LastLabel, BeginLabel, 0, 0};
3909 CallSites.push_back(Site);
Duncan Sands481dc722007-12-19 07:36:31 +00003910 PreviousIsInvoke = false;
Duncan Sands57810cd2007-09-05 11:27:52 +00003911 }
3912
3913 LastLabel = LandingPad->EndLabels[P.RangeIndex];
Duncan Sands481dc722007-12-19 07:36:31 +00003914 assert(BeginLabel && LastLabel && "Invalid landing pad!");
Duncan Sands57810cd2007-09-05 11:27:52 +00003915
Duncan Sands481dc722007-12-19 07:36:31 +00003916 if (LandingPad->LandingPadLabel) {
3917 // This try-range is for an invoke.
3918 CallSiteEntry Site = {BeginLabel, LastLabel,
3919 LandingPad->LandingPadLabel, FirstActions[P.PadIndex]};
Duncan Sands57810cd2007-09-05 11:27:52 +00003920
Duncan Sands481dc722007-12-19 07:36:31 +00003921 // Try to merge with the previous call-site.
3922 if (PreviousIsInvoke) {
Dan Gohman719de532008-06-21 22:00:54 +00003923 CallSiteEntry &Prev = CallSites.back();
Duncan Sands481dc722007-12-19 07:36:31 +00003924 if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
3925 // Extend the range of the previous entry.
3926 Prev.EndLabel = Site.EndLabel;
3927 continue;
3928 }
Duncan Sands57810cd2007-09-05 11:27:52 +00003929 }
Duncan Sands57810cd2007-09-05 11:27:52 +00003930
Duncan Sands481dc722007-12-19 07:36:31 +00003931 // Otherwise, create a new call-site.
3932 CallSites.push_back(Site);
3933 PreviousIsInvoke = true;
3934 } else {
3935 // Create a gap.
3936 PreviousIsInvoke = false;
3937 }
Duncan Sands57810cd2007-09-05 11:27:52 +00003938 }
3939 }
3940 // If some instruction between the previous try-range and the end of the
3941 // function may throw, create a call-site entry with no landing pad for the
3942 // region following the try-range.
Duncan Sands481dc722007-12-19 07:36:31 +00003943 if (SawPotentiallyThrowing) {
Duncan Sands57810cd2007-09-05 11:27:52 +00003944 CallSiteEntry Site = {LastLabel, 0, 0, 0};
3945 CallSites.push_back(Site);
3946 }
3947
Jim Laskeybacd3042007-02-21 22:48:45 +00003948 // Final tallies.
Duncan Sands671fa972008-05-07 19:11:09 +00003949
3950 // Call sites.
3951 const unsigned SiteStartSize = sizeof(int32_t); // DW_EH_PE_udata4
3952 const unsigned SiteLengthSize = sizeof(int32_t); // DW_EH_PE_udata4
3953 const unsigned LandingPadSize = sizeof(int32_t); // DW_EH_PE_udata4
3954 unsigned SizeSites = CallSites.size() * (SiteStartSize +
3955 SiteLengthSize +
3956 LandingPadSize);
Duncan Sands57810cd2007-09-05 11:27:52 +00003957 for (unsigned i = 0, e = CallSites.size(); i < e; ++i)
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003958 SizeSites += TargetAsmInfo::getULEB128Size(CallSites[i].Action);
Duncan Sands57810cd2007-09-05 11:27:52 +00003959
Duncan Sands671fa972008-05-07 19:11:09 +00003960 // Type infos.
3961 const unsigned TypeInfoSize = TD->getPointerSize(); // DW_EH_PE_absptr
3962 unsigned SizeTypes = TypeInfos.size() * TypeInfoSize;
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003963
3964 unsigned TypeOffset = sizeof(int8_t) + // Call site format
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003965 TargetAsmInfo::getULEB128Size(SizeSites) + // Call-site table length
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003966 SizeSites + SizeActions + SizeTypes;
3967
3968 unsigned TotalSize = sizeof(int8_t) + // LPStart format
3969 sizeof(int8_t) + // TType format
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00003970 TargetAsmInfo::getULEB128Size(TypeOffset) + // TType base offset
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003971 TypeOffset;
3972
3973 unsigned SizeAlign = (4 - TotalSize) & 3;
Duncan Sandsc1fe1662007-05-10 18:40:24 +00003974
Jim Laskeybacd3042007-02-21 22:48:45 +00003975 // Begin the exception table.
3976 Asm->SwitchToDataSection(TAI->getDwarfExceptionSection());
Evan Cheng05548eb2008-02-29 19:36:59 +00003977 Asm->EmitAlignment(2, 0, 0, false);
Dale Johannesend65b2642008-10-08 21:50:21 +00003978 O << "GCC_except_table" << SubprogramCount << ":\n";
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003979 for (unsigned i = 0; i != SizeAlign; ++i) {
3980 Asm->EmitInt8(0);
3981 Asm->EOL("Padding");
3982 }
Jim Laskeybacd3042007-02-21 22:48:45 +00003983 EmitLabel("exception", SubprogramCount);
Duncan Sandsc1fe1662007-05-10 18:40:24 +00003984
Jim Laskeybacd3042007-02-21 22:48:45 +00003985 // Emit the header.
3986 Asm->EmitInt8(DW_EH_PE_omit);
3987 Asm->EOL("LPStart format (DW_EH_PE_omit)");
3988 Asm->EmitInt8(DW_EH_PE_absptr);
3989 Asm->EOL("TType format (DW_EH_PE_absptr)");
3990 Asm->EmitULEB128Bytes(TypeOffset);
3991 Asm->EOL("TType base offset");
3992 Asm->EmitInt8(DW_EH_PE_udata4);
3993 Asm->EOL("Call site format (DW_EH_PE_udata4)");
3994 Asm->EmitULEB128Bytes(SizeSites);
3995 Asm->EOL("Call-site table length");
Duncan Sands53c3a332007-05-16 12:12:23 +00003996
Duncan Sands57810cd2007-09-05 11:27:52 +00003997 // Emit the landing pad site information.
3998 for (unsigned i = 0; i < CallSites.size(); ++i) {
3999 CallSiteEntry &S = CallSites[i];
4000 const char *BeginTag;
4001 unsigned BeginNumber;
Duncan Sands53c3a332007-05-16 12:12:23 +00004002
Duncan Sands57810cd2007-09-05 11:27:52 +00004003 if (!S.BeginLabel) {
4004 BeginTag = "eh_func_begin";
4005 BeginNumber = SubprogramCount;
4006 } else {
4007 BeginTag = "label";
4008 BeginNumber = S.BeginLabel;
Duncan Sands53c3a332007-05-16 12:12:23 +00004009 }
Duncan Sands53c3a332007-05-16 12:12:23 +00004010
Duncan Sands57810cd2007-09-05 11:27:52 +00004011 EmitSectionOffset(BeginTag, "eh_func_begin", BeginNumber, SubprogramCount,
Duncan Sands671fa972008-05-07 19:11:09 +00004012 true, true);
Duncan Sands57810cd2007-09-05 11:27:52 +00004013 Asm->EOL("Region start");
Duncan Sands53c3a332007-05-16 12:12:23 +00004014
Duncan Sands57810cd2007-09-05 11:27:52 +00004015 if (!S.EndLabel) {
Dale Johannesen4af34942008-01-15 23:24:56 +00004016 EmitDifference("eh_func_end", SubprogramCount, BeginTag, BeginNumber,
Duncan Sands671fa972008-05-07 19:11:09 +00004017 true);
Duncan Sands57810cd2007-09-05 11:27:52 +00004018 } else {
Duncan Sands671fa972008-05-07 19:11:09 +00004019 EmitDifference("label", S.EndLabel, BeginTag, BeginNumber, true);
Duncan Sands57810cd2007-09-05 11:27:52 +00004020 }
4021 Asm->EOL("Region length");
Duncan Sands53c3a332007-05-16 12:12:23 +00004022
Duncan Sands671fa972008-05-07 19:11:09 +00004023 if (!S.PadLabel)
4024 Asm->EmitInt32(0);
4025 else
Duncan Sands57810cd2007-09-05 11:27:52 +00004026 EmitSectionOffset("label", "eh_func_begin", S.PadLabel, SubprogramCount,
Duncan Sands671fa972008-05-07 19:11:09 +00004027 true, true);
Duncan Sands57810cd2007-09-05 11:27:52 +00004028 Asm->EOL("Landing pad");
4029
4030 Asm->EmitULEB128Bytes(S.Action);
4031 Asm->EOL("Action");
Jim Laskeybacd3042007-02-21 22:48:45 +00004032 }
Duncan Sands53c3a332007-05-16 12:12:23 +00004033
Jim Laskeybacd3042007-02-21 22:48:45 +00004034 // Emit the actions.
Duncan Sandsb32edb42007-06-06 15:37:31 +00004035 for (unsigned I = 0, N = Actions.size(); I != N; ++I) {
4036 ActionEntry &Action = Actions[I];
Duncan Sands7bf7a442007-05-21 18:50:28 +00004037
Duncan Sandsfccf0a22007-07-06 12:46:24 +00004038 Asm->EmitSLEB128Bytes(Action.ValueForTypeID);
Duncan Sandsb32edb42007-06-06 15:37:31 +00004039 Asm->EOL("TypeInfo index");
4040 Asm->EmitSLEB128Bytes(Action.NextAction);
4041 Asm->EOL("Next action");
Jim Laskeybacd3042007-02-21 22:48:45 +00004042 }
4043
4044 // Emit the type ids.
Jim Laskeybacd3042007-02-21 22:48:45 +00004045 for (unsigned M = TypeInfos.size(); M; --M) {
4046 GlobalVariable *GV = TypeInfos[M - 1];
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +00004047
4048 PrintRelDirective();
Jim Laskeybacd3042007-02-21 22:48:45 +00004049
4050 if (GV)
4051 O << Asm->getGlobalLinkName(GV);
4052 else
4053 O << "0";
Duncan Sands57810cd2007-09-05 11:27:52 +00004054
Jim Laskeybacd3042007-02-21 22:48:45 +00004055 Asm->EOL("TypeInfo");
4056 }
4057
Duncan Sands73ef58a2007-06-02 16:53:42 +00004058 // Emit the filter typeids.
4059 for (unsigned j = 0, M = FilterIds.size(); j < M; ++j) {
4060 unsigned TypeID = FilterIds[j];
Duncan Sandsbb821dd2007-07-12 13:51:39 +00004061 Asm->EmitULEB128Bytes(TypeID);
Duncan Sands73ef58a2007-06-02 16:53:42 +00004062 Asm->EOL("Filter TypeInfo index");
Jim Laskey0102ca82007-03-01 20:26:43 +00004063 }
Duncan Sands57810cd2007-09-05 11:27:52 +00004064
Evan Cheng05548eb2008-02-29 19:36:59 +00004065 Asm->EmitAlignment(2, 0, 0, false);
Jim Laskeyb82313f2007-02-01 16:31:34 +00004066 }
4067
Jim Laskey072200c2007-01-29 18:51:14 +00004068public:
4069 //===--------------------------------------------------------------------===//
4070 // Main entry points.
4071 //
Owen Andersoncb371882008-08-21 00:14:44 +00004072 DwarfException(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
Bill Wendling163ba3f2009-03-10 21:23:25 +00004073 : Dwarf(OS, A, T, "eh"), shouldEmitTable(false), shouldEmitMoves(false),
4074 shouldEmitTableModule(false), shouldEmitMovesModule(false),
4075 ExceptionTimer(0) {
4076 if (TimePassesIsEnabled)
4077 ExceptionTimer = new Timer("Dwarf Exception Writer",
4078 *getDwarfTimerGroup());
4079 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00004080
Bill Wendling163ba3f2009-03-10 21:23:25 +00004081 virtual ~DwarfException() {
4082 delete ExceptionTimer;
4083 }
Jim Laskey072200c2007-01-29 18:51:14 +00004084
4085 /// SetModuleInfo - Set machine module information when it's known that pass
4086 /// manager has created it. Set by the target AsmPrinter.
4087 void SetModuleInfo(MachineModuleInfo *mmi) {
Jim Laskey3f09fc22007-02-28 18:38:31 +00004088 MMI = mmi;
Jim Laskey072200c2007-01-29 18:51:14 +00004089 }
4090
4091 /// BeginModule - Emit all exception information that should come prior to the
4092 /// content.
4093 void BeginModule(Module *M) {
4094 this->M = M;
Jim Laskey072200c2007-01-29 18:51:14 +00004095 }
4096
4097 /// EndModule - Emit all exception information that should come after the
4098 /// content.
4099 void EndModule() {
Bill Wendling163ba3f2009-03-10 21:23:25 +00004100 if (TimePassesIsEnabled)
4101 ExceptionTimer->startTimer();
4102
Dale Johannesen1532f3d2008-04-02 00:25:04 +00004103 if (shouldEmitMovesModule || shouldEmitTableModule) {
4104 const std::vector<Function *> Personalities = MMI->getPersonalities();
Evan Chenge3d42322009-02-25 07:04:34 +00004105 for (unsigned i = 0; i < Personalities.size(); ++i)
Dale Johannesen1532f3d2008-04-02 00:25:04 +00004106 EmitCommonEHFrame(Personalities[i], i);
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00004107
Dale Johannesen1532f3d2008-04-02 00:25:04 +00004108 for (std::vector<FunctionEHFrameInfo>::iterator I = EHFrames.begin(),
4109 E = EHFrames.end(); I != E; ++I)
4110 EmitEHFrame(*I);
4111 }
Bill Wendling163ba3f2009-03-10 21:23:25 +00004112
4113 if (TimePassesIsEnabled)
4114 ExceptionTimer->stopTimer();
Jim Laskey072200c2007-01-29 18:51:14 +00004115 }
4116
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00004117 /// BeginFunction - Gather pre-function exception information. Assumes being
Jim Laskey072200c2007-01-29 18:51:14 +00004118 /// emitted immediately after the function entry point.
4119 void BeginFunction(MachineFunction *MF) {
Bill Wendling163ba3f2009-03-10 21:23:25 +00004120 if (TimePassesIsEnabled)
4121 ExceptionTimer->startTimer();
4122
Jim Laskey072200c2007-01-29 18:51:14 +00004123 this->MF = MF;
Dale Johannesen1532f3d2008-04-02 00:25:04 +00004124 shouldEmitTable = shouldEmitMoves = false;
Dale Johannesen1532f3d2008-04-02 00:25:04 +00004125
Bill Wendling163ba3f2009-03-10 21:23:25 +00004126 if (MMI && TAI->doesSupportExceptionHandling()) {
Dale Johannesen1532f3d2008-04-02 00:25:04 +00004127 // Map all labels and get rid of any dead landing pads.
4128 MMI->TidyLandingPads();
Bill Wendling163ba3f2009-03-10 21:23:25 +00004129
Dale Johannesen1532f3d2008-04-02 00:25:04 +00004130 // If any landing pads survive, we need an EH table.
4131 if (MMI->getLandingPads().size())
4132 shouldEmitTable = true;
4133
4134 // See if we need frame move info.
Duncan Sandsececf992008-07-04 09:55:48 +00004135 if (!MF->getFunction()->doesNotThrow() || UnwindTablesMandatory)
Dale Johannesen1532f3d2008-04-02 00:25:04 +00004136 shouldEmitMoves = true;
4137
4138 if (shouldEmitMoves || shouldEmitTable)
4139 // Assumes in correct section after the entry point.
4140 EmitLabel("eh_func_begin", ++SubprogramCount);
Jim Laskey3f09fc22007-02-28 18:38:31 +00004141 }
Bill Wendling163ba3f2009-03-10 21:23:25 +00004142
Dale Johannesen1532f3d2008-04-02 00:25:04 +00004143 shouldEmitTableModule |= shouldEmitTable;
4144 shouldEmitMovesModule |= shouldEmitMoves;
Bill Wendling163ba3f2009-03-10 21:23:25 +00004145
4146 if (TimePassesIsEnabled)
4147 ExceptionTimer->stopTimer();
Jim Laskey072200c2007-01-29 18:51:14 +00004148 }
4149
4150 /// EndFunction - Gather and emit post-function exception information.
4151 ///
4152 void EndFunction() {
Bill Wendling163ba3f2009-03-10 21:23:25 +00004153 if (TimePassesIsEnabled)
4154 ExceptionTimer->startTimer();
4155
Dale Johannesen1532f3d2008-04-02 00:25:04 +00004156 if (shouldEmitMoves || shouldEmitTable) {
4157 EmitLabel("eh_func_end", SubprogramCount);
4158 EmitExceptionTable();
Jim Laskeyb82313f2007-02-01 16:31:34 +00004159
Dale Johannesen1532f3d2008-04-02 00:25:04 +00004160 // Save EH frame information
4161 EHFrames.
4162 push_back(FunctionEHFrameInfo(getAsm()->getCurrentFunctionEHName(MF),
Bill Wendling163ba3f2009-03-10 21:23:25 +00004163 SubprogramCount,
4164 MMI->getPersonalityIndex(),
4165 MF->getFrameInfo()->hasCalls(),
4166 !MMI->getLandingPads().empty(),
4167 MMI->getFrameMoves(),
4168 MF->getFunction()));
4169 }
4170
4171 if (TimePassesIsEnabled)
4172 ExceptionTimer->stopTimer();
Jim Laskey072200c2007-01-29 18:51:14 +00004173 }
4174};
4175
Jim Laskey0d086af2006-02-27 12:43:29 +00004176} // End of namespace llvm
Jim Laskey063e7652006-01-17 17:31:53 +00004177
4178//===----------------------------------------------------------------------===//
4179
Jim Laskeyd18e2892006-01-20 20:34:06 +00004180/// Emit - Print the abbreviation using the specified Dwarf writer.
4181///
Jim Laskey072200c2007-01-29 18:51:14 +00004182void DIEAbbrev::Emit(const DwarfDebug &DD) const {
Jim Laskeyd18e2892006-01-20 20:34:06 +00004183 // Emit its Dwarf tag type.
Jim Laskey072200c2007-01-29 18:51:14 +00004184 DD.getAsm()->EmitULEB128Bytes(Tag);
4185 DD.getAsm()->EOL(TagString(Tag));
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00004186
Jim Laskeyd18e2892006-01-20 20:34:06 +00004187 // Emit whether it has children DIEs.
Jim Laskey072200c2007-01-29 18:51:14 +00004188 DD.getAsm()->EmitULEB128Bytes(ChildrenFlag);
4189 DD.getAsm()->EOL(ChildrenString(ChildrenFlag));
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00004190
Jim Laskeyd18e2892006-01-20 20:34:06 +00004191 // For each attribute description.
Jim Laskey52060a02006-01-24 00:49:18 +00004192 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
Jim Laskeyd18e2892006-01-20 20:34:06 +00004193 const DIEAbbrevData &AttrData = Data[i];
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00004194
Jim Laskeyd18e2892006-01-20 20:34:06 +00004195 // Emit attribute type.
Jim Laskey072200c2007-01-29 18:51:14 +00004196 DD.getAsm()->EmitULEB128Bytes(AttrData.getAttribute());
4197 DD.getAsm()->EOL(AttributeString(AttrData.getAttribute()));
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00004198
Jim Laskeyd18e2892006-01-20 20:34:06 +00004199 // Emit form type.
Jim Laskey072200c2007-01-29 18:51:14 +00004200 DD.getAsm()->EmitULEB128Bytes(AttrData.getForm());
4201 DD.getAsm()->EOL(FormEncodingString(AttrData.getForm()));
Jim Laskeyd18e2892006-01-20 20:34:06 +00004202 }
4203
4204 // Mark end of abbreviation.
Jim Laskey072200c2007-01-29 18:51:14 +00004205 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(1)");
4206 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(2)");
Jim Laskeyd18e2892006-01-20 20:34:06 +00004207}
4208
4209#ifndef NDEBUG
Jim Laskeya0f3d172006-09-07 22:06:40 +00004210void DIEAbbrev::print(std::ostream &O) {
4211 O << "Abbreviation @"
4212 << std::hex << (intptr_t)this << std::dec
4213 << " "
4214 << TagString(Tag)
4215 << " "
4216 << ChildrenString(ChildrenFlag)
4217 << "\n";
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00004218
Jim Laskeya0f3d172006-09-07 22:06:40 +00004219 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4220 O << " "
4221 << AttributeString(Data[i].getAttribute())
Jim Laskeyd18e2892006-01-20 20:34:06 +00004222 << " "
Jim Laskeya0f3d172006-09-07 22:06:40 +00004223 << FormEncodingString(Data[i].getForm())
Jim Laskeyd18e2892006-01-20 20:34:06 +00004224 << "\n";
Jim Laskeyd18e2892006-01-20 20:34:06 +00004225 }
Jim Laskeya0f3d172006-09-07 22:06:40 +00004226}
Bill Wendlinge8156192006-12-07 01:30:32 +00004227void DIEAbbrev::dump() { print(cerr); }
Jim Laskeyd18e2892006-01-20 20:34:06 +00004228#endif
4229
4230//===----------------------------------------------------------------------===//
4231
Jim Laskeyef42a012006-11-02 20:12:39 +00004232#ifndef NDEBUG
4233void DIEValue::dump() {
Bill Wendlinge8156192006-12-07 01:30:32 +00004234 print(cerr);
Jim Laskeyb80af6f2006-03-03 21:00:14 +00004235}
Jim Laskeyef42a012006-11-02 20:12:39 +00004236#endif
4237
4238//===----------------------------------------------------------------------===//
4239
Jim Laskey063e7652006-01-17 17:31:53 +00004240/// EmitValue - Emit integer of appropriate size.
4241///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00004242void DIEInteger::EmitValue(DwarfDebug &DD, unsigned Form) {
Jim Laskey063e7652006-01-17 17:31:53 +00004243 switch (Form) {
Jim Laskey40020172006-01-20 21:02:36 +00004244 case DW_FORM_flag: // Fall thru
Jim Laskeyb8509c52006-03-23 18:07:55 +00004245 case DW_FORM_ref1: // Fall thru
Jim Laskey072200c2007-01-29 18:51:14 +00004246 case DW_FORM_data1: DD.getAsm()->EmitInt8(Integer); break;
Jim Laskeyb8509c52006-03-23 18:07:55 +00004247 case DW_FORM_ref2: // Fall thru
Jim Laskey072200c2007-01-29 18:51:14 +00004248 case DW_FORM_data2: DD.getAsm()->EmitInt16(Integer); break;
Jim Laskeyb8509c52006-03-23 18:07:55 +00004249 case DW_FORM_ref4: // Fall thru
Jim Laskey072200c2007-01-29 18:51:14 +00004250 case DW_FORM_data4: DD.getAsm()->EmitInt32(Integer); break;
Jim Laskeyb8509c52006-03-23 18:07:55 +00004251 case DW_FORM_ref8: // Fall thru
Jim Laskey072200c2007-01-29 18:51:14 +00004252 case DW_FORM_data8: DD.getAsm()->EmitInt64(Integer); break;
4253 case DW_FORM_udata: DD.getAsm()->EmitULEB128Bytes(Integer); break;
4254 case DW_FORM_sdata: DD.getAsm()->EmitSLEB128Bytes(Integer); break;
Jim Laskeyf1cdea12007-01-25 15:12:02 +00004255 default: assert(0 && "DIE Value form not supported yet"); break;
4256 }
4257}
4258
4259/// SizeOf - Determine size of integer value in bytes.
4260///
Jim Laskey072200c2007-01-29 18:51:14 +00004261unsigned DIEInteger::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Jim Laskeyf1cdea12007-01-25 15:12:02 +00004262 switch (Form) {
4263 case DW_FORM_flag: // Fall thru
4264 case DW_FORM_ref1: // Fall thru
4265 case DW_FORM_data1: return sizeof(int8_t);
4266 case DW_FORM_ref2: // Fall thru
4267 case DW_FORM_data2: return sizeof(int16_t);
4268 case DW_FORM_ref4: // Fall thru
4269 case DW_FORM_data4: return sizeof(int32_t);
4270 case DW_FORM_ref8: // Fall thru
4271 case DW_FORM_data8: return sizeof(int64_t);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00004272 case DW_FORM_udata: return TargetAsmInfo::getULEB128Size(Integer);
4273 case DW_FORM_sdata: return TargetAsmInfo::getSLEB128Size(Integer);
Jim Laskey063e7652006-01-17 17:31:53 +00004274 default: assert(0 && "DIE Value form not supported yet"); break;
4275 }
Jim Laskeyf1cdea12007-01-25 15:12:02 +00004276 return 0;
Jim Laskey063e7652006-01-17 17:31:53 +00004277}
4278
Jim Laskey063e7652006-01-17 17:31:53 +00004279//===----------------------------------------------------------------------===//
4280
4281/// EmitValue - Emit string value.
4282///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00004283void DIEString::EmitValue(DwarfDebug &DD, unsigned Form) {
Jim Laskey072200c2007-01-29 18:51:14 +00004284 DD.getAsm()->EmitString(String);
Jim Laskey063e7652006-01-17 17:31:53 +00004285}
4286
Jim Laskey063e7652006-01-17 17:31:53 +00004287//===----------------------------------------------------------------------===//
4288
4289/// EmitValue - Emit label value.
4290///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00004291void DIEDwarfLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
Dan Gohman9fda5be2007-09-28 16:50:28 +00004292 bool IsSmall = Form == DW_FORM_data4;
4293 DD.EmitReference(Label, false, IsSmall);
Jim Laskey063e7652006-01-17 17:31:53 +00004294}
4295
4296/// SizeOf - Determine size of label value in bytes.
4297///
Jim Laskey072200c2007-01-29 18:51:14 +00004298unsigned DIEDwarfLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Dan Gohman9fda5be2007-09-28 16:50:28 +00004299 if (Form == DW_FORM_data4) return 4;
Dan Gohman82482942007-09-27 23:12:31 +00004300 return DD.getTargetData()->getPointerSize();
Jim Laskey063e7652006-01-17 17:31:53 +00004301}
Jim Laskeyef42a012006-11-02 20:12:39 +00004302
Jim Laskey063e7652006-01-17 17:31:53 +00004303//===----------------------------------------------------------------------===//
4304
Jim Laskeyd18e2892006-01-20 20:34:06 +00004305/// EmitValue - Emit label value.
4306///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00004307void DIEObjectLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
Dan Gohman9fda5be2007-09-28 16:50:28 +00004308 bool IsSmall = Form == DW_FORM_data4;
4309 DD.EmitReference(Label, false, IsSmall);
Jim Laskeyd18e2892006-01-20 20:34:06 +00004310}
4311
4312/// SizeOf - Determine size of label value in bytes.
4313///
Jim Laskey072200c2007-01-29 18:51:14 +00004314unsigned DIEObjectLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Dan Gohman9fda5be2007-09-28 16:50:28 +00004315 if (Form == DW_FORM_data4) return 4;
Dan Gohman82482942007-09-27 23:12:31 +00004316 return DD.getTargetData()->getPointerSize();
Jim Laskeyd18e2892006-01-20 20:34:06 +00004317}
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00004318
Jim Laskeyd18e2892006-01-20 20:34:06 +00004319//===----------------------------------------------------------------------===//
4320
Jim Laskey063e7652006-01-17 17:31:53 +00004321/// EmitValue - Emit delta value.
4322///
Argyrios Kyrtzidisf7acf8f2008-06-18 19:27:37 +00004323void DIESectionOffset::EmitValue(DwarfDebug &DD, unsigned Form) {
4324 bool IsSmall = Form == DW_FORM_data4;
4325 DD.EmitSectionOffset(Label.Tag, Section.Tag,
4326 Label.Number, Section.Number, IsSmall, IsEH, UseSet);
4327}
4328
4329/// SizeOf - Determine size of delta value in bytes.
4330///
4331unsigned DIESectionOffset::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4332 if (Form == DW_FORM_data4) return 4;
4333 return DD.getTargetData()->getPointerSize();
4334}
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00004335
Argyrios Kyrtzidisf7acf8f2008-06-18 19:27:37 +00004336//===----------------------------------------------------------------------===//
4337
4338/// EmitValue - Emit delta value.
4339///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00004340void DIEDelta::EmitValue(DwarfDebug &DD, unsigned Form) {
Jim Laskey2b4e98c2006-12-06 17:43:18 +00004341 bool IsSmall = Form == DW_FORM_data4;
Jim Laskey072200c2007-01-29 18:51:14 +00004342 DD.EmitDifference(LabelHi, LabelLo, IsSmall);
Jim Laskey063e7652006-01-17 17:31:53 +00004343}
4344
4345/// SizeOf - Determine size of delta value in bytes.
4346///
Jim Laskey072200c2007-01-29 18:51:14 +00004347unsigned DIEDelta::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Jim Laskey2b4e98c2006-12-06 17:43:18 +00004348 if (Form == DW_FORM_data4) return 4;
Dan Gohman82482942007-09-27 23:12:31 +00004349 return DD.getTargetData()->getPointerSize();
Jim Laskey063e7652006-01-17 17:31:53 +00004350}
4351
4352//===----------------------------------------------------------------------===//
Jim Laskeyef42a012006-11-02 20:12:39 +00004353
Jim Laskeyb8509c52006-03-23 18:07:55 +00004354/// EmitValue - Emit debug information entry offset.
Jim Laskeyd18e2892006-01-20 20:34:06 +00004355///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00004356void DIEntry::EmitValue(DwarfDebug &DD, unsigned Form) {
Jim Laskey072200c2007-01-29 18:51:14 +00004357 DD.getAsm()->EmitInt32(Entry->getOffset());
Jim Laskeyd18e2892006-01-20 20:34:06 +00004358}
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00004359
Jim Laskeyd18e2892006-01-20 20:34:06 +00004360//===----------------------------------------------------------------------===//
4361
Jim Laskeyb80af6f2006-03-03 21:00:14 +00004362/// ComputeSize - calculate the size of the block.
4363///
Jim Laskey072200c2007-01-29 18:51:14 +00004364unsigned DIEBlock::ComputeSize(DwarfDebug &DD) {
Jim Laskeyef42a012006-11-02 20:12:39 +00004365 if (!Size) {
Owen Anderson873e1b52008-06-24 21:44:59 +00004366 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00004367
Jim Laskeyef42a012006-11-02 20:12:39 +00004368 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
Jim Laskey072200c2007-01-29 18:51:14 +00004369 Size += Values[i]->SizeOf(DD, AbbrevData[i].getForm());
Jim Laskeyef42a012006-11-02 20:12:39 +00004370 }
Jim Laskeyb80af6f2006-03-03 21:00:14 +00004371 }
4372 return Size;
4373}
4374
Jim Laskeyb80af6f2006-03-03 21:00:14 +00004375/// EmitValue - Emit block data.
4376///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00004377void DIEBlock::EmitValue(DwarfDebug &DD, unsigned Form) {
Jim Laskeyb80af6f2006-03-03 21:00:14 +00004378 switch (Form) {
Jim Laskey072200c2007-01-29 18:51:14 +00004379 case DW_FORM_block1: DD.getAsm()->EmitInt8(Size); break;
4380 case DW_FORM_block2: DD.getAsm()->EmitInt16(Size); break;
4381 case DW_FORM_block4: DD.getAsm()->EmitInt32(Size); break;
4382 case DW_FORM_block: DD.getAsm()->EmitULEB128Bytes(Size); break;
Jim Laskeyf1cdea12007-01-25 15:12:02 +00004383 default: assert(0 && "Improper form for block"); break;
Jim Laskeyb80af6f2006-03-03 21:00:14 +00004384 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00004385
Owen Anderson873e1b52008-06-24 21:44:59 +00004386 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
Jim Laskeyef42a012006-11-02 20:12:39 +00004387
Jim Laskeyb80af6f2006-03-03 21:00:14 +00004388 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
Jim Laskeybacd3042007-02-21 22:48:45 +00004389 DD.getAsm()->EOL();
Jim Laskey072200c2007-01-29 18:51:14 +00004390 Values[i]->EmitValue(DD, AbbrevData[i].getForm());
Jim Laskeyb80af6f2006-03-03 21:00:14 +00004391 }
4392}
4393
4394/// SizeOf - Determine size of block data in bytes.
4395///
Jim Laskey072200c2007-01-29 18:51:14 +00004396unsigned DIEBlock::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Jim Laskeyb80af6f2006-03-03 21:00:14 +00004397 switch (Form) {
4398 case DW_FORM_block1: return Size + sizeof(int8_t);
4399 case DW_FORM_block2: return Size + sizeof(int16_t);
4400 case DW_FORM_block4: return Size + sizeof(int32_t);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00004401 case DW_FORM_block: return Size + TargetAsmInfo::getULEB128Size(Size);
Jim Laskeyb80af6f2006-03-03 21:00:14 +00004402 default: assert(0 && "Improper form for block"); break;
4403 }
4404 return 0;
4405}
4406
Jim Laskeyb80af6f2006-03-03 21:00:14 +00004407//===----------------------------------------------------------------------===//
Jim Laskeyef42a012006-11-02 20:12:39 +00004408/// DIE Implementation
Jim Laskeyd18e2892006-01-20 20:34:06 +00004409
4410DIE::~DIE() {
Jim Laskeyef42a012006-11-02 20:12:39 +00004411 for (unsigned i = 0, N = Children.size(); i < N; ++i)
Jim Laskeyd18e2892006-01-20 20:34:06 +00004412 delete Children[i];
Jim Laskeyd18e2892006-01-20 20:34:06 +00004413}
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00004414
Jim Laskeyb8509c52006-03-23 18:07:55 +00004415/// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
4416///
4417void DIE::AddSiblingOffset() {
4418 DIEInteger *DI = new DIEInteger(0);
4419 Values.insert(Values.begin(), DI);
Jim Laskeya9c83fe2006-10-30 15:59:54 +00004420 Abbrev.AddFirstAttribute(DW_AT_sibling, DW_FORM_ref4);
Jim Laskeyb8509c52006-03-23 18:07:55 +00004421}
4422
Jim Laskeyef42a012006-11-02 20:12:39 +00004423/// Profile - Used to gather unique data for the value folding set.
Jim Laskeyd18e2892006-01-20 20:34:06 +00004424///
Jim Laskeyef42a012006-11-02 20:12:39 +00004425void DIE::Profile(FoldingSetNodeID &ID) {
4426 Abbrev.Profile(ID);
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00004427
Jim Laskeyef42a012006-11-02 20:12:39 +00004428 for (unsigned i = 0, N = Children.size(); i < N; ++i)
4429 ID.AddPointer(Children[i]);
4430
4431 for (unsigned j = 0, M = Values.size(); j < M; ++j)
4432 ID.AddPointer(Values[j]);
Jim Laskeyd8f77ba2006-01-27 15:20:54 +00004433}
Jim Laskeyef42a012006-11-02 20:12:39 +00004434
4435#ifndef NDEBUG
4436void DIE::print(std::ostream &O, unsigned IncIndent) {
4437 static unsigned IndentCount = 0;
4438 IndentCount += IncIndent;
4439 const std::string Indent(IndentCount, ' ');
4440 bool isBlock = Abbrev.getTag() == 0;
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00004441
Jim Laskeyef42a012006-11-02 20:12:39 +00004442 if (!isBlock) {
4443 O << Indent
4444 << "Die: "
4445 << "0x" << std::hex << (intptr_t)this << std::dec
4446 << ", Offset: " << Offset
4447 << ", Size: " << Size
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00004448 << "\n";
4449
Jim Laskeyef42a012006-11-02 20:12:39 +00004450 O << Indent
4451 << TagString(Abbrev.getTag())
Jim Laskey063e7652006-01-17 17:31:53 +00004452 << " "
Jim Laskeyef42a012006-11-02 20:12:39 +00004453 << ChildrenString(Abbrev.getChildrenFlag());
4454 } else {
4455 O << "Size: " << Size;
Jim Laskey063e7652006-01-17 17:31:53 +00004456 }
4457 O << "\n";
Jim Laskeya7cea6f2006-01-04 13:52:30 +00004458
Owen Anderson873e1b52008-06-24 21:44:59 +00004459 const SmallVector<DIEAbbrevData, 8> &Data = Abbrev.getData();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00004460
Jim Laskeyef42a012006-11-02 20:12:39 +00004461 IndentCount += 2;
4462 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4463 O << Indent;
Bill Wendling4e974012008-07-22 00:28:47 +00004464
4465 if (!isBlock)
Jim Laskeyef42a012006-11-02 20:12:39 +00004466 O << AttributeString(Data[i].getAttribute());
Bill Wendling4e974012008-07-22 00:28:47 +00004467 else
Jim Laskeyef42a012006-11-02 20:12:39 +00004468 O << "Blk[" << i << "]";
Bill Wendling4e974012008-07-22 00:28:47 +00004469
Jim Laskeyef42a012006-11-02 20:12:39 +00004470 O << " "
4471 << FormEncodingString(Data[i].getForm())
4472 << " ";
4473 Values[i]->print(O);
Jim Laskey0d086af2006-02-27 12:43:29 +00004474 O << "\n";
Jim Laskey063e7652006-01-17 17:31:53 +00004475 }
Jim Laskeyef42a012006-11-02 20:12:39 +00004476 IndentCount -= 2;
Jim Laskey063e7652006-01-17 17:31:53 +00004477
Jim Laskeyef42a012006-11-02 20:12:39 +00004478 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
4479 Children[j]->print(O, 4);
Jim Laskey063e7652006-01-17 17:31:53 +00004480 }
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00004481
Jim Laskeyef42a012006-11-02 20:12:39 +00004482 if (!isBlock) O << "\n";
4483 IndentCount -= IncIndent;
Jim Laskey19ef4ef2006-01-17 20:41:40 +00004484}
4485
Jim Laskeyef42a012006-11-02 20:12:39 +00004486void DIE::dump() {
Bill Wendlinge8156192006-12-07 01:30:32 +00004487 print(cerr);
Jim Laskey41886992006-04-07 16:34:46 +00004488}
Jim Laskeybd761842006-02-27 17:27:12 +00004489#endif
Jim Laskey65195462006-10-30 13:35:07 +00004490
4491//===----------------------------------------------------------------------===//
4492/// DwarfWriter Implementation
Jim Laskeyef42a012006-11-02 20:12:39 +00004493///
Jim Laskey65195462006-10-30 13:35:07 +00004494
Bill Wendling91b8b802009-03-10 20:41:52 +00004495DwarfWriter::DwarfWriter()
Bill Wendling163ba3f2009-03-10 21:23:25 +00004496 : ImmutablePass(&ID), DD(0), DE(0) {}
Jim Laskey65195462006-10-30 13:35:07 +00004497
4498DwarfWriter::~DwarfWriter() {
Jim Laskey072200c2007-01-29 18:51:14 +00004499 delete DE;
4500 delete DD;
Bill Wendling91b8b802009-03-10 20:41:52 +00004501 delete DwarfTimerGroup; DwarfTimerGroup = 0;
Jim Laskey65195462006-10-30 13:35:07 +00004502}
4503
Jim Laskey65195462006-10-30 13:35:07 +00004504/// BeginModule - Emit all Dwarf sections that should come prior to the
4505/// content.
Devang Pateleb3fc282009-01-08 23:40:34 +00004506void DwarfWriter::BeginModule(Module *M,
4507 MachineModuleInfo *MMI,
4508 raw_ostream &OS, AsmPrinter *A,
4509 const TargetAsmInfo *T) {
4510 DE = new DwarfException(OS, A, T);
4511 DD = new DwarfDebug(OS, A, T);
Jim Laskey072200c2007-01-29 18:51:14 +00004512 DE->BeginModule(M);
4513 DD->BeginModule(M);
Devang Patel7bb89ed2009-01-13 00:20:51 +00004514 DD->SetDebugInfo(MMI);
Devang Pateleb3fc282009-01-08 23:40:34 +00004515 DE->SetModuleInfo(MMI);
Jim Laskey65195462006-10-30 13:35:07 +00004516}
4517
4518/// EndModule - Emit all Dwarf sections that should come after the content.
4519///
4520void DwarfWriter::EndModule() {
Jim Laskey072200c2007-01-29 18:51:14 +00004521 DE->EndModule();
4522 DD->EndModule();
Jim Laskey65195462006-10-30 13:35:07 +00004523}
4524
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00004525/// BeginFunction - Gather pre-function debug information. Assumes being
Jim Laskey65195462006-10-30 13:35:07 +00004526/// emitted immediately after the function entry point.
4527void DwarfWriter::BeginFunction(MachineFunction *MF) {
Jim Laskey072200c2007-01-29 18:51:14 +00004528 DE->BeginFunction(MF);
4529 DD->BeginFunction(MF);
Jim Laskey65195462006-10-30 13:35:07 +00004530}
4531
4532/// EndFunction - Gather and emit post-function debug information.
4533///
Bill Wendlingd751c642008-09-26 00:28:12 +00004534void DwarfWriter::EndFunction(MachineFunction *MF) {
4535 DD->EndFunction(MF);
Jim Laskeyb82313f2007-02-01 16:31:34 +00004536 DE->EndFunction();
Anton Korobeynikovffe31d72008-08-16 12:57:46 +00004537
Bill Wendlingc91d0b92008-07-22 00:53:37 +00004538 if (MachineModuleInfo *MMI = DD->getMMI() ? DD->getMMI() : DE->getMMI())
Jim Laskeyb82313f2007-02-01 16:31:34 +00004539 // Clear function debug information.
4540 MMI->EndFunction();
Jim Laskey65195462006-10-30 13:35:07 +00004541}
Devang Patelccca7fe2009-01-12 19:17:34 +00004542
Devang Patelcf3a4482009-01-15 23:41:32 +00004543/// ValidDebugInfo - Return true if V represents valid debug info value.
4544bool DwarfWriter::ValidDebugInfo(Value *V) {
Bill Wendling163ba3f2009-03-10 21:23:25 +00004545 return DD && DD->ValidDebugInfo(V);
Devang Patelcf3a4482009-01-15 23:41:32 +00004546}
4547
Devang Patelccca7fe2009-01-12 19:17:34 +00004548/// RecordSourceLine - Records location information and associates it with a
4549/// label. Returns a unique label ID used to generate a label and provide
4550/// correspondence to the source line list.
4551unsigned DwarfWriter::RecordSourceLine(unsigned Line, unsigned Col,
4552 unsigned Src) {
Bill Wendling163ba3f2009-03-10 21:23:25 +00004553 return DD->RecordSourceLine(Line, Col, Src);
Devang Patelccca7fe2009-01-12 19:17:34 +00004554}
4555
Evan Chenge3d42322009-02-25 07:04:34 +00004556/// getOrCreateSourceID - Look up the source id with the given directory and
4557/// source file names. If none currently exists, create a new id and insert it
4558/// in the SourceIds map. This can update DirectoryNames and SourceFileNames maps
4559/// as well.
4560unsigned DwarfWriter::getOrCreateSourceID(const std::string &DirName,
4561 const std::string &FileName) {
Bill Wendling163ba3f2009-03-10 21:23:25 +00004562 return DD->getOrCreateSourceID(DirName, FileName);
Devang Patelccca7fe2009-01-12 19:17:34 +00004563}
4564
4565/// RecordRegionStart - Indicate the start of a region.
4566unsigned DwarfWriter::RecordRegionStart(GlobalVariable *V) {
Bill Wendling163ba3f2009-03-10 21:23:25 +00004567 return DD->RecordRegionStart(V);
Devang Patelccca7fe2009-01-12 19:17:34 +00004568}
4569
4570/// RecordRegionEnd - Indicate the end of a region.
4571unsigned DwarfWriter::RecordRegionEnd(GlobalVariable *V) {
Bill Wendling163ba3f2009-03-10 21:23:25 +00004572 return DD->RecordRegionEnd(V);
Devang Patelccca7fe2009-01-12 19:17:34 +00004573}
4574
4575/// getRecordSourceLineCount - Count source lines.
4576unsigned DwarfWriter::getRecordSourceLineCount() {
Bill Wendling163ba3f2009-03-10 21:23:25 +00004577 return DD->getRecordSourceLineCount();
Devang Patelccca7fe2009-01-12 19:17:34 +00004578}
Devang Patelbb8c5952009-01-13 21:25:00 +00004579
Devang Patelc48c5502009-01-13 21:44:10 +00004580/// RecordVariable - Indicate the declaration of a local variable.
4581///
4582void DwarfWriter::RecordVariable(GlobalVariable *GV, unsigned FrameIndex) {
4583 DD->RecordVariable(GV, FrameIndex);
4584}
Devang Patelbbdc8202009-01-13 23:54:55 +00004585
Bill Wendling4ed0c5f2009-02-20 00:44:43 +00004586/// ShouldEmitDwarfDebug - Returns true if Dwarf debugging declarations should
4587/// be emitted.
4588bool DwarfWriter::ShouldEmitDwarfDebug() const {
Bill Wendling163ba3f2009-03-10 21:23:25 +00004589 return DD->ShouldEmitDwarfDebug();
Bill Wendling4ed0c5f2009-02-20 00:44:43 +00004590}