blob: a5862c9e872b9d2c39428c605adccb28dfa659bb [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 Laskeye5032892005-12-21 19:48:16 +000015
Duncan Sands53c3a332007-05-16 12:12:23 +000016#include "llvm/ADT/DenseMap.h"
Jim Laskeya9c83fe2006-10-30 15:59:54 +000017#include "llvm/ADT/FoldingSet.h"
Jim Laskey063e7652006-01-17 17:31:53 +000018#include "llvm/ADT/StringExtras.h"
Jim Laskey65195462006-10-30 13:35:07 +000019#include "llvm/ADT/UniqueVector.h"
Jim Laskey52060a02006-01-24 00:49:18 +000020#include "llvm/Module.h"
21#include "llvm/Type.h"
Jim Laskeya7cea6f2006-01-04 13:52:30 +000022#include "llvm/CodeGen/AsmPrinter.h"
Jim Laskey44c3b9f2007-01-26 21:22:28 +000023#include "llvm/CodeGen/MachineModuleInfo.h"
Jim Laskey41886992006-04-07 16:34:46 +000024#include "llvm/CodeGen/MachineFrameInfo.h"
Jim Laskeyb8509c52006-03-23 18:07:55 +000025#include "llvm/CodeGen/MachineLocation.h"
Jim Laskey3f09fc22007-02-28 18:38:31 +000026#include "llvm/Support/Debug.h"
Jim Laskeyb3e789a2006-01-26 20:21:46 +000027#include "llvm/Support/Dwarf.h"
Jim Laskeya7cea6f2006-01-04 13:52:30 +000028#include "llvm/Support/CommandLine.h"
Jim Laskey65195462006-10-30 13:35:07 +000029#include "llvm/Support/DataTypes.h"
Jim Laskey52060a02006-01-24 00:49:18 +000030#include "llvm/Support/Mangler.h"
Dan Gohman85496362007-09-24 21:32:18 +000031#include "llvm/System/Path.h"
Jim Laskey563321a2006-09-06 18:34:40 +000032#include "llvm/Target/TargetAsmInfo.h"
Dan Gohman6f0d0242008-02-10 18:45:23 +000033#include "llvm/Target/TargetRegisterInfo.h"
Owen Anderson07000c62006-05-12 06:33:49 +000034#include "llvm/Target/TargetData.h"
Jim Laskey1069fbd2006-04-10 23:09:19 +000035#include "llvm/Target/TargetFrameInfo.h"
Duncan Sands53c3a332007-05-16 12:12:23 +000036#include "llvm/Target/TargetInstrInfo.h"
Jim Laskey1b340dc2007-01-29 20:48:32 +000037#include "llvm/Target/TargetMachine.h"
Jim Laskeyc1c47c32007-01-29 23:40:33 +000038#include "llvm/Target/TargetOptions.h"
Bill Wendlingbdc679d2006-11-29 00:39:47 +000039#include <ostream>
Jim Laskey65195462006-10-30 13:35:07 +000040#include <string>
Jim Laskeyb2efb852006-01-04 22:28:25 +000041using namespace llvm;
Jim Laskey9a777a32006-02-27 22:37:23 +000042using namespace llvm::dwarf;
Jim Laskeya7cea6f2006-01-04 13:52:30 +000043
Jim Laskey0d086af2006-02-27 12:43:29 +000044namespace llvm {
Jim Laskey65195462006-10-30 13:35:07 +000045
46//===----------------------------------------------------------------------===//
Jim Laskeyef42a012006-11-02 20:12:39 +000047
48/// Configuration values for initial hash set sizes (log2).
49///
50static const unsigned InitDiesSetSize = 9; // 512
51static const unsigned InitAbbreviationsSetSize = 9; // 512
52static const unsigned InitValuesSetSize = 9; // 512
53
54//===----------------------------------------------------------------------===//
55/// Forward declarations.
56///
57class DIE;
58class DIEValue;
59
60//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +000061/// DWLabel - Labels are used to track locations in the assembler file.
Reid Spencer181b6c92007-08-05 20:06:04 +000062/// Labels appear in the form @verbatim <prefix><Tag><Number> @endverbatim,
63/// where the tag is a category of label (Ex. location) and number is a value
64/// unique in that category.
Jim Laskey65195462006-10-30 13:35:07 +000065class DWLabel {
66public:
Jim Laskeyef42a012006-11-02 20:12:39 +000067 /// Tag - Label category tag. Should always be a staticly declared C string.
68 ///
69 const char *Tag;
70
71 /// Number - Value to make label unique.
72 ///
73 unsigned Number;
Jim Laskey65195462006-10-30 13:35:07 +000074
75 DWLabel(const char *T, unsigned N) : Tag(T), Number(N) {}
Jim Laskeybd761842006-02-27 17:27:12 +000076
Jim Laskeyef42a012006-11-02 20:12:39 +000077 void Profile(FoldingSetNodeID &ID) const {
78 ID.AddString(std::string(Tag));
79 ID.AddInteger(Number);
Jim Laskey90c79d72006-03-23 23:02:34 +000080 }
Jim Laskeyef42a012006-11-02 20:12:39 +000081
82#ifndef NDEBUG
Bill Wendling5c7e3262006-12-17 05:15:13 +000083 void print(std::ostream *O) const {
84 if (O) print(*O);
Bill Wendlingbdc679d2006-11-29 00:39:47 +000085 }
Jim Laskeyef42a012006-11-02 20:12:39 +000086 void print(std::ostream &O) const {
Jim Laskeybacd3042007-02-21 22:48:45 +000087 O << "." << Tag;
Jim Laskeyef42a012006-11-02 20:12:39 +000088 if (Number) O << Number;
89 }
90#endif
Jim Laskeybd761842006-02-27 17:27:12 +000091};
92
93//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +000094/// DIEAbbrevData - Dwarf abbreviation data, describes the one attribute of a
95/// Dwarf abbreviation.
Jim Laskey0d086af2006-02-27 12:43:29 +000096class DIEAbbrevData {
97private:
Jim Laskeyef42a012006-11-02 20:12:39 +000098 /// Attribute - Dwarf attribute code.
99 ///
100 unsigned Attribute;
101
102 /// Form - Dwarf form code.
103 ///
104 unsigned Form;
Jim Laskey0d086af2006-02-27 12:43:29 +0000105
106public:
107 DIEAbbrevData(unsigned A, unsigned F)
108 : Attribute(A)
109 , Form(F)
110 {}
111
Jim Laskeybd761842006-02-27 17:27:12 +0000112 // Accessors.
Jim Laskey0d086af2006-02-27 12:43:29 +0000113 unsigned getAttribute() const { return Attribute; }
114 unsigned getForm() const { return Form; }
Jim Laskey063e7652006-01-17 17:31:53 +0000115
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000116 /// Profile - Used to gather unique data for the abbreviation folding set.
Jim Laskey0d086af2006-02-27 12:43:29 +0000117 ///
Jim Laskeyef42a012006-11-02 20:12:39 +0000118 void Profile(FoldingSetNodeID &ID)const {
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000119 ID.AddInteger(Attribute);
120 ID.AddInteger(Form);
Jim Laskey0d086af2006-02-27 12:43:29 +0000121 }
122};
Jim Laskey063e7652006-01-17 17:31:53 +0000123
Jim Laskey0d086af2006-02-27 12:43:29 +0000124//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000125/// DIEAbbrev - Dwarf abbreviation, describes the organization of a debug
126/// information object.
127class DIEAbbrev : public FoldingSetNode {
Jim Laskey0d086af2006-02-27 12:43:29 +0000128private:
Jim Laskeyef42a012006-11-02 20:12:39 +0000129 /// Tag - Dwarf tag code.
130 ///
131 unsigned Tag;
132
133 /// Unique number for node.
134 ///
135 unsigned Number;
136
137 /// ChildrenFlag - Dwarf children flag.
138 ///
139 unsigned ChildrenFlag;
140
141 /// Data - Raw data bytes for abbreviation.
142 ///
Owen Anderson873e1b52008-06-24 21:44:59 +0000143 SmallVector<DIEAbbrevData, 8> Data;
Jim Laskey063e7652006-01-17 17:31:53 +0000144
Jim Laskey0d086af2006-02-27 12:43:29 +0000145public:
Jim Laskey063e7652006-01-17 17:31:53 +0000146
Jim Laskey0d086af2006-02-27 12:43:29 +0000147 DIEAbbrev(unsigned T, unsigned C)
Jim Laskeyef42a012006-11-02 20:12:39 +0000148 : Tag(T)
Jim Laskey0d086af2006-02-27 12:43:29 +0000149 , ChildrenFlag(C)
150 , Data()
151 {}
152 ~DIEAbbrev() {}
153
Jim Laskeybd761842006-02-27 17:27:12 +0000154 // Accessors.
Jim Laskey0d086af2006-02-27 12:43:29 +0000155 unsigned getTag() const { return Tag; }
Jim Laskeyef42a012006-11-02 20:12:39 +0000156 unsigned getNumber() const { return Number; }
Jim Laskey0d086af2006-02-27 12:43:29 +0000157 unsigned getChildrenFlag() const { return ChildrenFlag; }
Owen Anderson873e1b52008-06-24 21:44:59 +0000158 const SmallVector<DIEAbbrevData, 8> &getData() const { return Data; }
Jim Laskeyef42a012006-11-02 20:12:39 +0000159 void setTag(unsigned T) { Tag = T; }
Jim Laskey0d086af2006-02-27 12:43:29 +0000160 void setChildrenFlag(unsigned CF) { ChildrenFlag = CF; }
Jim Laskeyef42a012006-11-02 20:12:39 +0000161 void setNumber(unsigned N) { Number = N; }
162
Jim Laskey0d086af2006-02-27 12:43:29 +0000163 /// AddAttribute - Adds another set of attribute information to the
164 /// abbreviation.
165 void AddAttribute(unsigned Attribute, unsigned Form) {
166 Data.push_back(DIEAbbrevData(Attribute, Form));
Jim Laskey063e7652006-01-17 17:31:53 +0000167 }
Jim Laskey0d086af2006-02-27 12:43:29 +0000168
Jim Laskeyb8509c52006-03-23 18:07:55 +0000169 /// AddFirstAttribute - Adds a set of attribute information to the front
170 /// of the abbreviation.
171 void AddFirstAttribute(unsigned Attribute, unsigned Form) {
172 Data.insert(Data.begin(), DIEAbbrevData(Attribute, Form));
173 }
174
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000175 /// Profile - Used to gather unique data for the abbreviation folding set.
176 ///
177 void Profile(FoldingSetNodeID &ID) {
178 ID.AddInteger(Tag);
179 ID.AddInteger(ChildrenFlag);
180
181 // For each attribute description.
182 for (unsigned i = 0, N = Data.size(); i < N; ++i)
183 Data[i].Profile(ID);
184 }
185
Jim Laskey0d086af2006-02-27 12:43:29 +0000186 /// Emit - Print the abbreviation using the specified Dwarf writer.
187 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000188 void Emit(const DwarfDebug &DD) const;
Jim Laskey0d086af2006-02-27 12:43:29 +0000189
190#ifndef NDEBUG
Bill Wendling5c7e3262006-12-17 05:15:13 +0000191 void print(std::ostream *O) {
192 if (O) print(*O);
Bill Wendlingbdc679d2006-11-29 00:39:47 +0000193 }
Jim Laskey0d086af2006-02-27 12:43:29 +0000194 void print(std::ostream &O);
195 void dump();
196#endif
197};
Jim Laskey063e7652006-01-17 17:31:53 +0000198
Jim Laskey0d086af2006-02-27 12:43:29 +0000199//===----------------------------------------------------------------------===//
Jim Laskeyef42a012006-11-02 20:12:39 +0000200/// DIE - A structured debug information entry. Has an abbreviation which
201/// describes it's organization.
202class DIE : public FoldingSetNode {
203protected:
204 /// Abbrev - Buffer for constructing abbreviation.
205 ///
206 DIEAbbrev Abbrev;
207
208 /// Offset - Offset in debug info section.
209 ///
210 unsigned Offset;
211
212 /// Size - Size of instance + children.
213 ///
214 unsigned Size;
215
216 /// Children DIEs.
217 ///
218 std::vector<DIE *> Children;
219
220 /// Attributes values.
221 ///
Owen Anderson873e1b52008-06-24 21:44:59 +0000222 SmallVector<DIEValue*, 32> Values;
Jim Laskeyef42a012006-11-02 20:12:39 +0000223
224public:
Dan Gohman81975f62007-08-27 14:50:10 +0000225 explicit DIE(unsigned Tag)
Jim Laskeyef42a012006-11-02 20:12:39 +0000226 : Abbrev(Tag, DW_CHILDREN_no)
227 , Offset(0)
228 , Size(0)
229 , Children()
230 , Values()
231 {}
232 virtual ~DIE();
233
234 // Accessors.
235 DIEAbbrev &getAbbrev() { return Abbrev; }
236 unsigned getAbbrevNumber() const {
237 return Abbrev.getNumber();
238 }
Jim Laskey85f419b2006-11-09 16:32:26 +0000239 unsigned getTag() const { return Abbrev.getTag(); }
Jim Laskeyef42a012006-11-02 20:12:39 +0000240 unsigned getOffset() const { return Offset; }
241 unsigned getSize() const { return Size; }
242 const std::vector<DIE *> &getChildren() const { return Children; }
Owen Anderson873e1b52008-06-24 21:44:59 +0000243 SmallVector<DIEValue*, 32> &getValues() { return Values; }
Jim Laskeyef42a012006-11-02 20:12:39 +0000244 void setTag(unsigned Tag) { Abbrev.setTag(Tag); }
245 void setOffset(unsigned O) { Offset = O; }
246 void setSize(unsigned S) { Size = S; }
247
248 /// AddValue - Add a value and attributes to a DIE.
249 ///
250 void AddValue(unsigned Attribute, unsigned Form, DIEValue *Value) {
251 Abbrev.AddAttribute(Attribute, Form);
252 Values.push_back(Value);
253 }
254
255 /// SiblingOffset - Return the offset of the debug information entry's
256 /// sibling.
257 unsigned SiblingOffset() const { return Offset + Size; }
258
259 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
260 ///
261 void AddSiblingOffset();
262
263 /// AddChild - Add a child to the DIE.
264 ///
265 void AddChild(DIE *Child) {
266 Abbrev.setChildrenFlag(DW_CHILDREN_yes);
267 Children.push_back(Child);
268 }
269
270 /// Detach - Detaches objects connected to it after copying.
271 ///
272 void Detach() {
273 Children.clear();
274 }
275
276 /// Profile - Used to gather unique data for the value folding set.
277 ///
278 void Profile(FoldingSetNodeID &ID) ;
279
280#ifndef NDEBUG
Bill Wendling5c7e3262006-12-17 05:15:13 +0000281 void print(std::ostream *O, unsigned IncIndent = 0) {
282 if (O) print(*O, IncIndent);
Bill Wendlingbdc679d2006-11-29 00:39:47 +0000283 }
Jim Laskeyef42a012006-11-02 20:12:39 +0000284 void print(std::ostream &O, unsigned IncIndent = 0);
285 void dump();
286#endif
287};
288
289//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000290/// DIEValue - A debug information entry value.
Jim Laskeyef42a012006-11-02 20:12:39 +0000291///
292class DIEValue : public FoldingSetNode {
Jim Laskey0d086af2006-02-27 12:43:29 +0000293public:
294 enum {
295 isInteger,
296 isString,
297 isLabel,
298 isAsIsLabel,
Argyrios Kyrtzidisf7acf8f2008-06-18 19:27:37 +0000299 isSectionOffset,
Jim Laskey0d086af2006-02-27 12:43:29 +0000300 isDelta,
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000301 isEntry,
302 isBlock
Jim Laskey0d086af2006-02-27 12:43:29 +0000303 };
304
Jim Laskeyef42a012006-11-02 20:12:39 +0000305 /// Type - Type of data stored in the value.
306 ///
307 unsigned Type;
Jim Laskey0d086af2006-02-27 12:43:29 +0000308
Dan Gohman81975f62007-08-27 14:50:10 +0000309 explicit DIEValue(unsigned T)
Jim Laskeyef42a012006-11-02 20:12:39 +0000310 : Type(T)
Jim Laskeyef42a012006-11-02 20:12:39 +0000311 {}
Jim Laskey0d086af2006-02-27 12:43:29 +0000312 virtual ~DIEValue() {}
313
Jim Laskeyf6733882006-11-02 21:48:18 +0000314 // Accessors
Jim Laskeyef42a012006-11-02 20:12:39 +0000315 unsigned getType() const { return Type; }
Jim Laskeyef42a012006-11-02 20:12:39 +0000316
Jim Laskey0d086af2006-02-27 12:43:29 +0000317 // Implement isa/cast/dyncast.
318 static bool classof(const DIEValue *) { return true; }
319
320 /// EmitValue - Emit value via the Dwarf writer.
321 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000322 virtual void EmitValue(DwarfDebug &DD, unsigned Form) = 0;
Jim Laskey0d086af2006-02-27 12:43:29 +0000323
324 /// SizeOf - Return the size of a value in bytes.
325 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000326 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const = 0;
Jim Laskeyef42a012006-11-02 20:12:39 +0000327
328 /// Profile - Used to gather unique data for the value folding set.
329 ///
330 virtual void Profile(FoldingSetNodeID &ID) = 0;
331
332#ifndef NDEBUG
Bill Wendling5c7e3262006-12-17 05:15:13 +0000333 void print(std::ostream *O) {
334 if (O) print(*O);
Bill Wendlingbdc679d2006-11-29 00:39:47 +0000335 }
Jim Laskeyef42a012006-11-02 20:12:39 +0000336 virtual void print(std::ostream &O) = 0;
337 void dump();
338#endif
Jim Laskey0d086af2006-02-27 12:43:29 +0000339};
Jim Laskey063e7652006-01-17 17:31:53 +0000340
Jim Laskey0d086af2006-02-27 12:43:29 +0000341//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000342/// DWInteger - An integer value DIE.
343///
Jim Laskey0d086af2006-02-27 12:43:29 +0000344class DIEInteger : public DIEValue {
345private:
346 uint64_t Integer;
347
348public:
Dan Gohman81975f62007-08-27 14:50:10 +0000349 explicit DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
Jim Laskey063e7652006-01-17 17:31:53 +0000350
Jim Laskey0d086af2006-02-27 12:43:29 +0000351 // Implement isa/cast/dyncast.
352 static bool classof(const DIEInteger *) { return true; }
353 static bool classof(const DIEValue *I) { return I->Type == isInteger; }
354
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000355 /// BestForm - Choose the best form for integer.
356 ///
Jim Laskeyef42a012006-11-02 20:12:39 +0000357 static unsigned BestForm(bool IsSigned, uint64_t Integer) {
358 if (IsSigned) {
359 if ((char)Integer == (signed)Integer) return DW_FORM_data1;
360 if ((short)Integer == (signed)Integer) return DW_FORM_data2;
361 if ((int)Integer == (signed)Integer) return DW_FORM_data4;
362 } else {
363 if ((unsigned char)Integer == Integer) return DW_FORM_data1;
364 if ((unsigned short)Integer == Integer) return DW_FORM_data2;
365 if ((unsigned int)Integer == Integer) return DW_FORM_data4;
366 }
367 return DW_FORM_data8;
368 }
369
Jim Laskey0d086af2006-02-27 12:43:29 +0000370 /// EmitValue - Emit integer of appropriate size.
371 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000372 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
Jim Laskey0d086af2006-02-27 12:43:29 +0000373
374 /// SizeOf - Determine size of integer value in bytes.
375 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000376 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
Jim Laskeyef42a012006-11-02 20:12:39 +0000377
378 /// Profile - Used to gather unique data for the value folding set.
379 ///
Jim Laskey5496f012006-11-09 14:52:14 +0000380 static void Profile(FoldingSetNodeID &ID, unsigned Integer) {
Jim Laskeyf6733882006-11-02 21:48:18 +0000381 ID.AddInteger(isInteger);
Jim Laskeyef42a012006-11-02 20:12:39 +0000382 ID.AddInteger(Integer);
383 }
Jim Laskey5496f012006-11-09 14:52:14 +0000384 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Integer); }
Jim Laskeyef42a012006-11-02 20:12:39 +0000385
386#ifndef NDEBUG
387 virtual void print(std::ostream &O) {
388 O << "Int: " << (int64_t)Integer
389 << " 0x" << std::hex << Integer << std::dec;
390 }
391#endif
Jim Laskey0d086af2006-02-27 12:43:29 +0000392};
Jim Laskey063e7652006-01-17 17:31:53 +0000393
Jim Laskey0d086af2006-02-27 12:43:29 +0000394//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000395/// DIEString - A string value DIE.
396///
Jim Laskeyef42a012006-11-02 20:12:39 +0000397class DIEString : public DIEValue {
398public:
Jim Laskey0d086af2006-02-27 12:43:29 +0000399 const std::string String;
400
Dan Gohman81975f62007-08-27 14:50:10 +0000401 explicit DIEString(const std::string &S) : DIEValue(isString), String(S) {}
Jim Laskey063e7652006-01-17 17:31:53 +0000402
Jim Laskey0d086af2006-02-27 12:43:29 +0000403 // Implement isa/cast/dyncast.
404 static bool classof(const DIEString *) { return true; }
405 static bool classof(const DIEValue *S) { return S->Type == isString; }
406
407 /// EmitValue - Emit string value.
408 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000409 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
Jim Laskey0d086af2006-02-27 12:43:29 +0000410
411 /// SizeOf - Determine size of string value in bytes.
412 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000413 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
Jim Laskeyef42a012006-11-02 20:12:39 +0000414 return String.size() + sizeof(char); // sizeof('\0');
415 }
416
417 /// 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, const std::string &String) {
Jim Laskeyf6733882006-11-02 21:48:18 +0000420 ID.AddInteger(isString);
Jim Laskeyef42a012006-11-02 20:12:39 +0000421 ID.AddString(String);
422 }
Jim Laskey5496f012006-11-09 14:52:14 +0000423 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, String); }
Jim Laskeyef42a012006-11-02 20:12:39 +0000424
425#ifndef NDEBUG
426 virtual void print(std::ostream &O) {
427 O << "Str: \"" << String << "\"";
428 }
429#endif
Jim Laskey0d086af2006-02-27 12:43:29 +0000430};
Jim Laskey063e7652006-01-17 17:31:53 +0000431
Jim Laskey0d086af2006-02-27 12:43:29 +0000432//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000433/// DIEDwarfLabel - A Dwarf internal label expression DIE.
Jim Laskey0d086af2006-02-27 12:43:29 +0000434//
Jim Laskeyef42a012006-11-02 20:12:39 +0000435class DIEDwarfLabel : public DIEValue {
436public:
437
Jim Laskey0d086af2006-02-27 12:43:29 +0000438 const DWLabel Label;
439
Dan Gohman81975f62007-08-27 14:50:10 +0000440 explicit DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {}
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 DIEDwarfLabel *) { return true; }
444 static bool classof(const DIEValue *L) { return L->Type == isLabel; }
445
446 /// EmitValue - Emit label value.
447 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000448 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
Jim Laskey0d086af2006-02-27 12:43:29 +0000449
450 /// SizeOf - Determine size of label 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
454 /// Profile - Used to gather unique data for the value folding set.
455 ///
Jim Laskey5496f012006-11-09 14:52:14 +0000456 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label) {
Jim Laskeyf6733882006-11-02 21:48:18 +0000457 ID.AddInteger(isLabel);
Jim Laskeyef42a012006-11-02 20:12:39 +0000458 Label.Profile(ID);
459 }
Jim Laskey5496f012006-11-09 14:52:14 +0000460 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
Jim Laskeyef42a012006-11-02 20:12:39 +0000461
462#ifndef NDEBUG
463 virtual void print(std::ostream &O) {
464 O << "Lbl: ";
465 Label.print(O);
466 }
467#endif
Jim Laskey0d086af2006-02-27 12:43:29 +0000468};
Jim Laskey063e7652006-01-17 17:31:53 +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/// DIEObjectLabel - A label to an object in code or data.
Jim Laskey0d086af2006-02-27 12:43:29 +0000473//
Jim Laskeyef42a012006-11-02 20:12:39 +0000474class DIEObjectLabel : public DIEValue {
475public:
Jim Laskey0d086af2006-02-27 12:43:29 +0000476 const std::string Label;
477
Dan Gohman81975f62007-08-27 14:50:10 +0000478 explicit DIEObjectLabel(const std::string &L)
479 : DIEValue(isAsIsLabel), 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 DIEObjectLabel *) { return true; }
483 static bool classof(const DIEValue *L) { return L->Type == isAsIsLabel; }
484
485 /// EmitValue - Emit label value.
486 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000487 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
Jim Laskey0d086af2006-02-27 12:43:29 +0000488
489 /// 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;
Jim Laskeyef42a012006-11-02 20:12:39 +0000492
493 /// 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 std::string &Label) {
Jim Laskeyf6733882006-11-02 21:48:18 +0000496 ID.AddInteger(isAsIsLabel);
Jim Laskeyef42a012006-11-02 20:12:39 +0000497 ID.AddString(Label);
498 }
Jim Laskey5496f012006-11-09 14:52:14 +0000499 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
Jim Laskeyef42a012006-11-02 20:12:39 +0000500
501#ifndef NDEBUG
502 virtual void print(std::ostream &O) {
503 O << "Obj: " << Label;
504 }
505#endif
Jim Laskey0d086af2006-02-27 12:43:29 +0000506};
Jim Laskey063e7652006-01-17 17:31:53 +0000507
Jim Laskey0d086af2006-02-27 12:43:29 +0000508//===----------------------------------------------------------------------===//
Argyrios Kyrtzidisf7acf8f2008-06-18 19:27:37 +0000509/// DIESectionOffset - A section offset DIE.
510//
511class DIESectionOffset : public DIEValue {
512public:
513 const DWLabel Label;
514 const DWLabel Section;
515 bool IsEH : 1;
516 bool UseSet : 1;
517
518 DIESectionOffset(const DWLabel &Lab, const DWLabel &Sec,
519 bool isEH = false, bool useSet = true)
520 : DIEValue(isSectionOffset), Label(Lab), Section(Sec),
521 IsEH(isEH), UseSet(useSet) {}
522
523 // Implement isa/cast/dyncast.
524 static bool classof(const DIESectionOffset *) { return true; }
525 static bool classof(const DIEValue *D) { return D->Type == isSectionOffset; }
526
527 /// EmitValue - Emit section offset.
528 ///
529 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
530
531 /// SizeOf - Determine size of section offset value in bytes.
532 ///
533 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
534
535 /// Profile - Used to gather unique data for the value folding set.
536 ///
537 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label,
538 const DWLabel &Section) {
539 ID.AddInteger(isSectionOffset);
540 Label.Profile(ID);
541 Section.Profile(ID);
542 // IsEH and UseSet are specific to the Label/Section that we will emit
543 // the offset for; so Label/Section are enough for uniqueness.
544 }
545 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label, Section); }
546
547#ifndef NDEBUG
548 virtual void print(std::ostream &O) {
549 O << "Off: ";
550 Label.print(O);
551 O << "-";
552 Section.print(O);
553 O << "-" << IsEH << "-" << UseSet;
554 }
555#endif
556};
557
558//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000559/// DIEDelta - A simple label difference DIE.
560///
Jim Laskeyef42a012006-11-02 20:12:39 +0000561class DIEDelta : public DIEValue {
562public:
Jim Laskey0d086af2006-02-27 12:43:29 +0000563 const DWLabel LabelHi;
564 const DWLabel LabelLo;
565
566 DIEDelta(const DWLabel &Hi, const DWLabel &Lo)
567 : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
Jim Laskey063e7652006-01-17 17:31:53 +0000568
Jim Laskey0d086af2006-02-27 12:43:29 +0000569 // Implement isa/cast/dyncast.
570 static bool classof(const DIEDelta *) { return true; }
571 static bool classof(const DIEValue *D) { return D->Type == isDelta; }
572
573 /// EmitValue - Emit delta value.
574 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000575 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
Jim Laskey0d086af2006-02-27 12:43:29 +0000576
577 /// SizeOf - Determine size of delta value in bytes.
578 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000579 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
Jim Laskeyef42a012006-11-02 20:12:39 +0000580
581 /// Profile - Used to gather unique data for the value folding set.
582 ///
Jim Laskey5496f012006-11-09 14:52:14 +0000583 static void Profile(FoldingSetNodeID &ID, const DWLabel &LabelHi,
584 const DWLabel &LabelLo) {
Jim Laskeyf6733882006-11-02 21:48:18 +0000585 ID.AddInteger(isDelta);
Jim Laskeyef42a012006-11-02 20:12:39 +0000586 LabelHi.Profile(ID);
587 LabelLo.Profile(ID);
588 }
Jim Laskey5496f012006-11-09 14:52:14 +0000589 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, LabelHi, LabelLo); }
Jim Laskeyef42a012006-11-02 20:12:39 +0000590
591#ifndef NDEBUG
592 virtual void print(std::ostream &O) {
593 O << "Del: ";
594 LabelHi.print(O);
595 O << "-";
596 LabelLo.print(O);
597 }
598#endif
Jim Laskey0d086af2006-02-27 12:43:29 +0000599};
Jim Laskey063e7652006-01-17 17:31:53 +0000600
Jim Laskey0d086af2006-02-27 12:43:29 +0000601//===----------------------------------------------------------------------===//
Jim Laskeyef42a012006-11-02 20:12:39 +0000602/// DIEntry - A pointer to another debug information entry. An instance of this
603/// class can also be used as a proxy for a debug information entry not yet
604/// defined (ie. types.)
605class DIEntry : public DIEValue {
606public:
Jim Laskey0d086af2006-02-27 12:43:29 +0000607 DIE *Entry;
608
Dan Gohman81975f62007-08-27 14:50:10 +0000609 explicit DIEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
Jim Laskeyef42a012006-11-02 20:12:39 +0000610
Jim Laskey0d086af2006-02-27 12:43:29 +0000611 // Implement isa/cast/dyncast.
612 static bool classof(const DIEntry *) { return true; }
613 static bool classof(const DIEValue *E) { return E->Type == isEntry; }
614
Jim Laskeyb8509c52006-03-23 18:07:55 +0000615 /// EmitValue - Emit debug information entry offset.
Jim Laskey0d086af2006-02-27 12:43:29 +0000616 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000617 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
Jim Laskey0d086af2006-02-27 12:43:29 +0000618
Jim Laskeyb8509c52006-03-23 18:07:55 +0000619 /// SizeOf - Determine size of debug information entry in bytes.
Jim Laskey0d086af2006-02-27 12:43:29 +0000620 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000621 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
Jim Laskeyef42a012006-11-02 20:12:39 +0000622 return sizeof(int32_t);
623 }
624
625 /// Profile - Used to gather unique data for the value folding set.
626 ///
Jim Laskey5496f012006-11-09 14:52:14 +0000627 static void Profile(FoldingSetNodeID &ID, DIE *Entry) {
628 ID.AddInteger(isEntry);
629 ID.AddPointer(Entry);
630 }
Jim Laskeyef42a012006-11-02 20:12:39 +0000631 virtual void Profile(FoldingSetNodeID &ID) {
Jim Laskeyf6733882006-11-02 21:48:18 +0000632 ID.AddInteger(isEntry);
633
Jim Laskeyef42a012006-11-02 20:12:39 +0000634 if (Entry) {
635 ID.AddPointer(Entry);
636 } else {
637 ID.AddPointer(this);
638 }
639 }
640
641#ifndef NDEBUG
642 virtual void print(std::ostream &O) {
643 O << "Die: 0x" << std::hex << (intptr_t)Entry << std::dec;
644 }
645#endif
Jim Laskey0d086af2006-02-27 12:43:29 +0000646};
647
648//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000649/// DIEBlock - A block of values. Primarily used for location expressions.
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000650//
Jim Laskeyef42a012006-11-02 20:12:39 +0000651class DIEBlock : public DIEValue, public DIE {
652public:
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000653 unsigned Size; // Size in bytes excluding size header.
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000654
655 DIEBlock()
656 : DIEValue(isBlock)
Jim Laskeyef42a012006-11-02 20:12:39 +0000657 , DIE(0)
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000658 , Size(0)
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000659 {}
Jim Laskeyef42a012006-11-02 20:12:39 +0000660 ~DIEBlock() {
661 }
662
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000663 // Implement isa/cast/dyncast.
664 static bool classof(const DIEBlock *) { return true; }
665 static bool classof(const DIEValue *E) { return E->Type == isBlock; }
666
667 /// ComputeSize - calculate the size of the block.
668 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000669 unsigned ComputeSize(DwarfDebug &DD);
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000670
671 /// BestForm - Choose the best form for data.
672 ///
Jim Laskeyef42a012006-11-02 20:12:39 +0000673 unsigned BestForm() const {
674 if ((unsigned char)Size == Size) return DW_FORM_block1;
675 if ((unsigned short)Size == Size) return DW_FORM_block2;
676 if ((unsigned int)Size == Size) return DW_FORM_block4;
677 return DW_FORM_block;
678 }
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000679
680 /// EmitValue - Emit block data.
681 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000682 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000683
684 /// SizeOf - Determine size of block data in bytes.
685 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000686 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
Jim Laskeyef42a012006-11-02 20:12:39 +0000687
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000688
Jim Laskeyef42a012006-11-02 20:12:39 +0000689 /// Profile - Used to gather unique data for the value folding set.
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000690 ///
Reid Spencer97821312006-11-02 23:56:21 +0000691 virtual void Profile(FoldingSetNodeID &ID) {
Jim Laskeyf6733882006-11-02 21:48:18 +0000692 ID.AddInteger(isBlock);
Jim Laskeyef42a012006-11-02 20:12:39 +0000693 DIE::Profile(ID);
694 }
695
696#ifndef NDEBUG
697 virtual void print(std::ostream &O) {
698 O << "Blk: ";
699 DIE::print(O, 5);
700 }
701#endif
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000702};
703
704//===----------------------------------------------------------------------===//
Jim Laskeyef42a012006-11-02 20:12:39 +0000705/// CompileUnit - This dwarf writer support class manages information associate
706/// with a source file.
707class CompileUnit {
Jim Laskey0d086af2006-02-27 12:43:29 +0000708private:
Jim Laskeyef42a012006-11-02 20:12:39 +0000709 /// Desc - Compile unit debug descriptor.
710 ///
711 CompileUnitDesc *Desc;
712
713 /// ID - File identifier for source.
714 ///
715 unsigned ID;
716
717 /// Die - Compile unit debug information entry.
718 ///
719 DIE *Die;
720
721 /// DescToDieMap - Tracks the mapping of unit level debug informaton
722 /// descriptors to debug information entries.
723 std::map<DebugInfoDesc *, DIE *> DescToDieMap;
724
725 /// DescToDIEntryMap - Tracks the mapping of unit level debug informaton
726 /// descriptors to debug information entries using a DIEntry proxy.
727 std::map<DebugInfoDesc *, DIEntry *> DescToDIEntryMap;
728
729 /// Globals - A map of globally visible named entities for this unit.
730 ///
731 std::map<std::string, DIE *> Globals;
732
733 /// DiesSet - Used to uniquely define dies within the compile unit.
734 ///
735 FoldingSet<DIE> DiesSet;
736
737 /// Dies - List of all dies in the compile unit.
738 ///
739 std::vector<DIE *> Dies;
Jim Laskey0d086af2006-02-27 12:43:29 +0000740
741public:
Jim Laskeyef42a012006-11-02 20:12:39 +0000742 CompileUnit(CompileUnitDesc *CUD, unsigned I, DIE *D)
743 : Desc(CUD)
744 , ID(I)
745 , Die(D)
746 , DescToDieMap()
747 , DescToDIEntryMap()
748 , Globals()
749 , DiesSet(InitDiesSetSize)
750 , Dies()
751 {}
752
753 ~CompileUnit() {
754 delete Die;
755
756 for (unsigned i = 0, N = Dies.size(); i < N; ++i)
757 delete Dies[i];
758 }
Jim Laskey0d086af2006-02-27 12:43:29 +0000759
Jim Laskeybd761842006-02-27 17:27:12 +0000760 // Accessors.
Jim Laskeyef42a012006-11-02 20:12:39 +0000761 CompileUnitDesc *getDesc() const { return Desc; }
762 unsigned getID() const { return ID; }
763 DIE* getDie() const { return Die; }
764 std::map<std::string, DIE *> &getGlobals() { return Globals; }
765
766 /// hasContent - Return true if this compile unit has something to write out.
767 ///
768 bool hasContent() const {
769 return !Die->getChildren().empty();
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000770 }
Jim Laskeyef42a012006-11-02 20:12:39 +0000771
772 /// AddGlobal - Add a new global entity to the compile unit.
773 ///
774 void AddGlobal(const std::string &Name, DIE *Die) {
775 Globals[Name] = Die;
776 }
Jim Laskey0d086af2006-02-27 12:43:29 +0000777
Jim Laskeyef42a012006-11-02 20:12:39 +0000778 /// getDieMapSlotFor - Returns the debug information entry map slot for the
779 /// specified debug descriptor.
Jim Laskey072200c2007-01-29 18:51:14 +0000780 DIE *&getDieMapSlotFor(DebugInfoDesc *DID) {
781 return DescToDieMap[DID];
Jim Laskeyef42a012006-11-02 20:12:39 +0000782 }
Jim Laskeyb8509c52006-03-23 18:07:55 +0000783
Jim Laskeyef42a012006-11-02 20:12:39 +0000784 /// getDIEntrySlotFor - Returns the debug information entry proxy slot for the
785 /// specified debug descriptor.
Jim Laskey072200c2007-01-29 18:51:14 +0000786 DIEntry *&getDIEntrySlotFor(DebugInfoDesc *DID) {
787 return DescToDIEntryMap[DID];
Jim Laskeyef42a012006-11-02 20:12:39 +0000788 }
Jim Laskey0d086af2006-02-27 12:43:29 +0000789
Jim Laskeyef42a012006-11-02 20:12:39 +0000790 /// AddDie - Adds or interns the DIE to the compile unit.
791 ///
792 DIE *AddDie(DIE &Buffer) {
793 FoldingSetNodeID ID;
794 Buffer.Profile(ID);
795 void *Where;
796 DIE *Die = DiesSet.FindNodeOrInsertPos(ID, Where);
797
798 if (!Die) {
799 Die = new DIE(Buffer);
800 DiesSet.InsertNode(Die, Where);
801 this->Die->AddChild(Die);
802 Buffer.Detach();
803 }
804
805 return Die;
806 }
Jim Laskey0d086af2006-02-27 12:43:29 +0000807};
808
Jim Laskey65195462006-10-30 13:35:07 +0000809//===----------------------------------------------------------------------===//
Jim Laskey072200c2007-01-29 18:51:14 +0000810/// Dwarf - Emits general Dwarf directives.
Jim Laskeyef42a012006-11-02 20:12:39 +0000811///
Jim Laskey65195462006-10-30 13:35:07 +0000812class Dwarf {
813
Jim Laskey072200c2007-01-29 18:51:14 +0000814protected:
Jim Laskey65195462006-10-30 13:35:07 +0000815
816 //===--------------------------------------------------------------------===//
Jim Laskey072200c2007-01-29 18:51:14 +0000817 // Core attributes used by the Dwarf writer.
Jim Laskey65195462006-10-30 13:35:07 +0000818 //
819
820 //
821 /// O - Stream to .s file.
822 ///
823 std::ostream &O;
824
825 /// Asm - Target of Dwarf emission.
826 ///
827 AsmPrinter *Asm;
828
Bill Wendlingaa8f8882008-07-01 23:34:48 +0000829 /// TAI - Target asm information.
Jim Laskey65195462006-10-30 13:35:07 +0000830 const TargetAsmInfo *TAI;
831
832 /// TD - Target data.
833 const TargetData *TD;
834
835 /// RI - Register Information.
Dan Gohman6f0d0242008-02-10 18:45:23 +0000836 const TargetRegisterInfo *RI;
Jim Laskey65195462006-10-30 13:35:07 +0000837
838 /// M - Current module.
839 ///
840 Module *M;
841
842 /// MF - Current machine function.
843 ///
844 MachineFunction *MF;
845
Jim Laskey44c3b9f2007-01-26 21:22:28 +0000846 /// MMI - Collected machine module information.
Jim Laskey65195462006-10-30 13:35:07 +0000847 ///
Jim Laskey44c3b9f2007-01-26 21:22:28 +0000848 MachineModuleInfo *MMI;
Jim Laskey65195462006-10-30 13:35:07 +0000849
Jim Laskey65195462006-10-30 13:35:07 +0000850 /// SubprogramCount - The running count of functions being compiled.
851 ///
852 unsigned SubprogramCount;
Chris Lattner9251f132007-09-24 03:35:37 +0000853
854 /// Flavor - A unique string indicating what dwarf producer this is, used to
855 /// unique labels.
856 const char * const Flavor;
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000857
858 unsigned SetCounter;
Chris Lattner9251f132007-09-24 03:35:37 +0000859 Dwarf(std::ostream &OS, AsmPrinter *A, const TargetAsmInfo *T,
860 const char *flavor)
Jim Laskey072200c2007-01-29 18:51:14 +0000861 : O(OS)
862 , Asm(A)
863 , TAI(T)
864 , TD(Asm->TM.getTargetData())
865 , RI(Asm->TM.getRegisterInfo())
866 , M(NULL)
867 , MF(NULL)
868 , MMI(NULL)
Jim Laskey072200c2007-01-29 18:51:14 +0000869 , SubprogramCount(0)
Chris Lattner9251f132007-09-24 03:35:37 +0000870 , Flavor(flavor)
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000871 , SetCounter(1)
Jim Laskey072200c2007-01-29 18:51:14 +0000872 {
873 }
874
875public:
876
877 //===--------------------------------------------------------------------===//
878 // Accessors.
879 //
880 AsmPrinter *getAsm() const { return Asm; }
Jim Laskeyb82313f2007-02-01 16:31:34 +0000881 MachineModuleInfo *getMMI() const { return MMI; }
Jim Laskey072200c2007-01-29 18:51:14 +0000882 const TargetAsmInfo *getTargetAsmInfo() const { return TAI; }
Dan Gohman82482942007-09-27 23:12:31 +0000883 const TargetData *getTargetData() const { return TD; }
Jim Laskey072200c2007-01-29 18:51:14 +0000884
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000885 void PrintRelDirective(bool Force32Bit = false, bool isInSection = false)
886 const {
887 if (isInSection && TAI->getDwarfSectionOffsetDirective())
888 O << TAI->getDwarfSectionOffsetDirective();
Dan Gohman82482942007-09-27 23:12:31 +0000889 else if (Force32Bit || TD->getPointerSize() == sizeof(int32_t))
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000890 O << TAI->getData32bitsDirective();
891 else
892 O << TAI->getData64bitsDirective();
893 }
894
Jim Laskeyb82313f2007-02-01 16:31:34 +0000895 /// PrintLabelName - Print label name in form used by Dwarf writer.
896 ///
897 void PrintLabelName(DWLabel Label) const {
898 PrintLabelName(Label.Tag, Label.Number);
899 }
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000900 void PrintLabelName(const char *Tag, unsigned Number) const {
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000901 O << TAI->getPrivateGlobalPrefix() << Tag;
Jim Laskeyb82313f2007-02-01 16:31:34 +0000902 if (Number) O << Number;
903 }
904
Chris Lattner9251f132007-09-24 03:35:37 +0000905 void PrintLabelName(const char *Tag, unsigned Number,
906 const char *Suffix) const {
907 O << TAI->getPrivateGlobalPrefix() << Tag;
908 if (Number) O << Number;
909 O << Suffix;
910 }
911
Jim Laskeyb82313f2007-02-01 16:31:34 +0000912 /// EmitLabel - Emit location label for internal use by Dwarf.
913 ///
914 void EmitLabel(DWLabel Label) const {
915 EmitLabel(Label.Tag, Label.Number);
916 }
917 void EmitLabel(const char *Tag, unsigned Number) const {
918 PrintLabelName(Tag, Number);
919 O << ":\n";
920 }
921
922 /// EmitReference - Emit a reference to a label.
923 ///
Dan Gohman06ff4e62007-09-28 15:43:33 +0000924 void EmitReference(DWLabel Label, bool IsPCRelative = false,
925 bool Force32Bit = false) const {
926 EmitReference(Label.Tag, Label.Number, IsPCRelative, Force32Bit);
Jim Laskeyb82313f2007-02-01 16:31:34 +0000927 }
928 void EmitReference(const char *Tag, unsigned Number,
Dan Gohman06ff4e62007-09-28 15:43:33 +0000929 bool IsPCRelative = false, bool Force32Bit = false) const {
930 PrintRelDirective(Force32Bit);
Jim Laskeyb82313f2007-02-01 16:31:34 +0000931 PrintLabelName(Tag, Number);
932
933 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
934 }
Dan Gohman06ff4e62007-09-28 15:43:33 +0000935 void EmitReference(const std::string &Name, bool IsPCRelative = false,
936 bool Force32Bit = false) const {
937 PrintRelDirective(Force32Bit);
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000938
Jim Laskeyb82313f2007-02-01 16:31:34 +0000939 O << Name;
940
941 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
942 }
943
944 /// EmitDifference - Emit the difference between two labels. Some
945 /// assemblers do not behave with absolute expressions with data directives,
946 /// so there is an option (needsSet) to use an intermediary set expression.
947 void EmitDifference(DWLabel LabelHi, DWLabel LabelLo,
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000948 bool IsSmall = false) {
Jim Laskeyb82313f2007-02-01 16:31:34 +0000949 EmitDifference(LabelHi.Tag, LabelHi.Number,
950 LabelLo.Tag, LabelLo.Number,
951 IsSmall);
952 }
953 void EmitDifference(const char *TagHi, unsigned NumberHi,
954 const char *TagLo, unsigned NumberLo,
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000955 bool IsSmall = false) {
Jim Laskeyb82313f2007-02-01 16:31:34 +0000956 if (TAI->needsSet()) {
Jim Laskeyb82313f2007-02-01 16:31:34 +0000957 O << "\t.set\t";
Chris Lattner9251f132007-09-24 03:35:37 +0000958 PrintLabelName("set", SetCounter, Flavor);
Jim Laskeyb82313f2007-02-01 16:31:34 +0000959 O << ",";
960 PrintLabelName(TagHi, NumberHi);
961 O << "-";
962 PrintLabelName(TagLo, NumberLo);
963 O << "\n";
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000964
965 PrintRelDirective(IsSmall);
Chris Lattner9251f132007-09-24 03:35:37 +0000966 PrintLabelName("set", SetCounter, Flavor);
Jim Laskeyb82313f2007-02-01 16:31:34 +0000967 ++SetCounter;
968 } else {
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000969 PrintRelDirective(IsSmall);
Jim Laskeyb82313f2007-02-01 16:31:34 +0000970
971 PrintLabelName(TagHi, NumberHi);
972 O << "-";
973 PrintLabelName(TagLo, NumberLo);
974 }
975 }
Anton Korobeynikova6199c82007-03-07 02:47:57 +0000976
977 void EmitSectionOffset(const char* Label, const char* Section,
978 unsigned LabelNumber, unsigned SectionNumber,
Dale Johannesend9ffd4c2008-03-26 23:31:39 +0000979 bool IsSmall = false, bool isEH = false,
980 bool useSet = true) {
Anton Korobeynikov79dda2b2007-05-01 22:23:12 +0000981 bool printAbsolute = false;
Dale Johannesend9ffd4c2008-03-26 23:31:39 +0000982 if (isEH)
983 printAbsolute = TAI->isAbsoluteEHSectionOffsets();
984 else
985 printAbsolute = TAI->isAbsoluteDebugSectionOffsets();
986
987 if (TAI->needsSet() && useSet) {
Anton Korobeynikova6199c82007-03-07 02:47:57 +0000988 O << "\t.set\t";
Chris Lattner9251f132007-09-24 03:35:37 +0000989 PrintLabelName("set", SetCounter, Flavor);
Anton Korobeynikova6199c82007-03-07 02:47:57 +0000990 O << ",";
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000991 PrintLabelName(Label, LabelNumber);
Anton Korobeynikov79dda2b2007-05-01 22:23:12 +0000992
Anton Korobeynikov79dda2b2007-05-01 22:23:12 +0000993 if (!printAbsolute) {
Anton Korobeynikova6199c82007-03-07 02:47:57 +0000994 O << "-";
995 PrintLabelName(Section, SectionNumber);
996 }
997 O << "\n";
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000998
999 PrintRelDirective(IsSmall);
Anton Korobeynikova6199c82007-03-07 02:47:57 +00001000
Chris Lattner9251f132007-09-24 03:35:37 +00001001 PrintLabelName("set", SetCounter, Flavor);
Anton Korobeynikova6199c82007-03-07 02:47:57 +00001002 ++SetCounter;
1003 } else {
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +00001004 PrintRelDirective(IsSmall, true);
Anton Korobeynikova6199c82007-03-07 02:47:57 +00001005
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +00001006 PrintLabelName(Label, LabelNumber);
Anton Korobeynikov79dda2b2007-05-01 22:23:12 +00001007
Anton Korobeynikov79dda2b2007-05-01 22:23:12 +00001008 if (!printAbsolute) {
Anton Korobeynikova6199c82007-03-07 02:47:57 +00001009 O << "-";
1010 PrintLabelName(Section, SectionNumber);
1011 }
1012 }
1013 }
1014
Jim Laskeyb82313f2007-02-01 16:31:34 +00001015 /// EmitFrameMoves - Emit frame instructions to describe the layout of the
1016 /// frame.
1017 void EmitFrameMoves(const char *BaseLabel, unsigned BaseLabelID,
Dale Johannesenb97aec62007-11-13 19:13:01 +00001018 const std::vector<MachineMove> &Moves, bool isEH) {
Jim Laskeyb82313f2007-02-01 16:31:34 +00001019 int stackGrowth =
1020 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
1021 TargetFrameInfo::StackGrowsUp ?
Dan Gohman82482942007-09-27 23:12:31 +00001022 TD->getPointerSize() : -TD->getPointerSize();
Jim Laskeybacd3042007-02-21 22:48:45 +00001023 bool IsLocal = BaseLabel && strcmp(BaseLabel, "label") == 0;
Jim Laskeyb82313f2007-02-01 16:31:34 +00001024
1025 for (unsigned i = 0, N = Moves.size(); i < N; ++i) {
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00001026 const MachineMove &Move = Moves[i];
Jim Laskeyb82313f2007-02-01 16:31:34 +00001027 unsigned LabelID = Move.getLabelID();
1028
1029 if (LabelID) {
1030 LabelID = MMI->MappedLabel(LabelID);
1031
1032 // Throw out move if the label is invalid.
1033 if (!LabelID) continue;
1034 }
1035
1036 const MachineLocation &Dst = Move.getDestination();
1037 const MachineLocation &Src = Move.getSource();
1038
1039 // Advance row if new location.
1040 if (BaseLabel && LabelID && (BaseLabelID != LabelID || !IsLocal)) {
1041 Asm->EmitInt8(DW_CFA_advance_loc4);
1042 Asm->EOL("DW_CFA_advance_loc4");
Jim Laskeybacd3042007-02-21 22:48:45 +00001043 EmitDifference("label", LabelID, BaseLabel, BaseLabelID, true);
1044 Asm->EOL();
Jim Laskeyb82313f2007-02-01 16:31:34 +00001045
1046 BaseLabelID = LabelID;
Jim Laskeybacd3042007-02-21 22:48:45 +00001047 BaseLabel = "label";
Jim Laskeyb82313f2007-02-01 16:31:34 +00001048 IsLocal = true;
1049 }
1050
1051 // If advancing cfa.
1052 if (Dst.isRegister() && Dst.getRegister() == MachineLocation::VirtualFP) {
1053 if (!Src.isRegister()) {
1054 if (Src.getRegister() == MachineLocation::VirtualFP) {
1055 Asm->EmitInt8(DW_CFA_def_cfa_offset);
1056 Asm->EOL("DW_CFA_def_cfa_offset");
1057 } else {
1058 Asm->EmitInt8(DW_CFA_def_cfa);
1059 Asm->EOL("DW_CFA_def_cfa");
Dale Johannesenb97aec62007-11-13 19:13:01 +00001060 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Src.getRegister(), isEH));
Jim Laskeyb82313f2007-02-01 16:31:34 +00001061 Asm->EOL("Register");
1062 }
1063
1064 int Offset = -Src.getOffset();
1065
1066 Asm->EmitULEB128Bytes(Offset);
1067 Asm->EOL("Offset");
1068 } else {
1069 assert(0 && "Machine move no supported yet.");
1070 }
1071 } else if (Src.isRegister() &&
1072 Src.getRegister() == MachineLocation::VirtualFP) {
1073 if (Dst.isRegister()) {
1074 Asm->EmitInt8(DW_CFA_def_cfa_register);
1075 Asm->EOL("DW_CFA_def_cfa_register");
Dale Johannesenb97aec62007-11-13 19:13:01 +00001076 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Dst.getRegister(), isEH));
Jim Laskeyb82313f2007-02-01 16:31:34 +00001077 Asm->EOL("Register");
1078 } else {
1079 assert(0 && "Machine move no supported yet.");
1080 }
1081 } else {
Dale Johannesenb97aec62007-11-13 19:13:01 +00001082 unsigned Reg = RI->getDwarfRegNum(Src.getRegister(), isEH);
Jim Laskeyb82313f2007-02-01 16:31:34 +00001083 int Offset = Dst.getOffset() / stackGrowth;
1084
1085 if (Offset < 0) {
1086 Asm->EmitInt8(DW_CFA_offset_extended_sf);
1087 Asm->EOL("DW_CFA_offset_extended_sf");
1088 Asm->EmitULEB128Bytes(Reg);
1089 Asm->EOL("Reg");
1090 Asm->EmitSLEB128Bytes(Offset);
1091 Asm->EOL("Offset");
1092 } else if (Reg < 64) {
1093 Asm->EmitInt8(DW_CFA_offset + Reg);
Evan Chengd4114192008-07-09 21:53:02 +00001094 if (VerboseAsm)
1095 Asm->EOL("DW_CFA_offset + Reg (" + utostr(Reg) + ")");
1096 else
1097 Asm->EOL();
Jim Laskeyb82313f2007-02-01 16:31:34 +00001098 Asm->EmitULEB128Bytes(Offset);
1099 Asm->EOL("Offset");
1100 } else {
1101 Asm->EmitInt8(DW_CFA_offset_extended);
1102 Asm->EOL("DW_CFA_offset_extended");
1103 Asm->EmitULEB128Bytes(Reg);
1104 Asm->EOL("Reg");
1105 Asm->EmitULEB128Bytes(Offset);
1106 Asm->EOL("Offset");
1107 }
1108 }
1109 }
1110 }
1111
Jim Laskey072200c2007-01-29 18:51:14 +00001112};
1113
1114//===----------------------------------------------------------------------===//
1115/// DwarfDebug - Emits Dwarf debug directives.
1116///
1117class DwarfDebug : public Dwarf {
1118
1119private:
Jim Laskey65195462006-10-30 13:35:07 +00001120 //===--------------------------------------------------------------------===//
1121 // Attributes used to construct specific Dwarf sections.
1122 //
1123
1124 /// CompileUnits - All the compile units involved in this build. The index
Jim Laskey44c3b9f2007-01-26 21:22:28 +00001125 /// of each entry in this vector corresponds to the sources in MMI.
Jim Laskey65195462006-10-30 13:35:07 +00001126 std::vector<CompileUnit *> CompileUnits;
Jim Laskeya9c83fe2006-10-30 15:59:54 +00001127
Jim Laskeyef42a012006-11-02 20:12:39 +00001128 /// AbbreviationsSet - Used to uniquely define abbreviations.
Jim Laskey65195462006-10-30 13:35:07 +00001129 ///
Jim Laskeya9c83fe2006-10-30 15:59:54 +00001130 FoldingSet<DIEAbbrev> AbbreviationsSet;
1131
1132 /// Abbreviations - A list of all the unique abbreviations in use.
1133 ///
1134 std::vector<DIEAbbrev *> Abbreviations;
Jim Laskey65195462006-10-30 13:35:07 +00001135
Jim Laskeyef42a012006-11-02 20:12:39 +00001136 /// ValuesSet - Used to uniquely define values.
1137 ///
1138 FoldingSet<DIEValue> ValuesSet;
1139
1140 /// Values - A list of all the unique values in use.
1141 ///
1142 std::vector<DIEValue *> Values;
1143
Jim Laskey65195462006-10-30 13:35:07 +00001144 /// StringPool - A UniqueVector of strings used by indirect references.
Jim Laskeyef42a012006-11-02 20:12:39 +00001145 ///
Jim Laskey65195462006-10-30 13:35:07 +00001146 UniqueVector<std::string> StringPool;
1147
1148 /// UnitMap - Map debug information descriptor to compile unit.
1149 ///
1150 std::map<DebugInfoDesc *, CompileUnit *> DescToUnitMap;
1151
Jim Laskey65195462006-10-30 13:35:07 +00001152 /// SectionMap - Provides a unique id per text section.
1153 ///
1154 UniqueVector<std::string> SectionMap;
1155
1156 /// SectionSourceLines - Tracks line numbers per text section.
1157 ///
1158 std::vector<std::vector<SourceLineInfo> > SectionSourceLines;
1159
Jim Laskeybacd3042007-02-21 22:48:45 +00001160 /// didInitial - Flag to indicate if initial emission has been done.
1161 ///
1162 bool didInitial;
1163
1164 /// shouldEmit - Flag to indicate if debug information should be emitted.
1165 ///
1166 bool shouldEmit;
Jim Laskey65195462006-10-30 13:35:07 +00001167
Anton Korobeynikov185bc892007-05-13 17:30:11 +00001168 struct FunctionDebugFrameInfo {
1169 unsigned Number;
1170 std::vector<MachineMove> Moves;
1171
1172 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M):
Dan Gohman81975f62007-08-27 14:50:10 +00001173 Number(Num), Moves(M) { }
Anton Korobeynikov185bc892007-05-13 17:30:11 +00001174 };
1175
1176 std::vector<FunctionDebugFrameInfo> DebugFrames;
1177
Jim Laskey65195462006-10-30 13:35:07 +00001178public:
Jim Laskeybacd3042007-02-21 22:48:45 +00001179
1180 /// ShouldEmitDwarf - Returns true if Dwarf declarations should be made.
1181 ///
1182 bool ShouldEmitDwarf() const { return shouldEmit; }
Jim Laskey65195462006-10-30 13:35:07 +00001183
Jim Laskeya9c83fe2006-10-30 15:59:54 +00001184 /// AssignAbbrevNumber - Define a unique number for the abbreviation.
Jim Laskey65195462006-10-30 13:35:07 +00001185 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00001186 void AssignAbbrevNumber(DIEAbbrev &Abbrev) {
1187 // Profile the node so that we can make it unique.
1188 FoldingSetNodeID ID;
1189 Abbrev.Profile(ID);
1190
1191 // Check the set for priors.
1192 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
1193
1194 // If it's newly added.
1195 if (InSet == &Abbrev) {
1196 // Add to abbreviation list.
1197 Abbreviations.push_back(&Abbrev);
1198 // Assign the vector position + 1 as its number.
1199 Abbrev.setNumber(Abbreviations.size());
1200 } else {
1201 // Assign existing abbreviation number.
1202 Abbrev.setNumber(InSet->getNumber());
1203 }
1204 }
1205
Jim Laskey65195462006-10-30 13:35:07 +00001206 /// NewString - Add a string to the constant pool and returns a label.
1207 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00001208 DWLabel NewString(const std::string &String) {
1209 unsigned StringID = StringPool.insert(String);
1210 return DWLabel("string", StringID);
1211 }
Jim Laskey65195462006-10-30 13:35:07 +00001212
Jim Laskeyef42a012006-11-02 20:12:39 +00001213 /// NewDIEntry - Creates a new DIEntry to be a proxy for a debug information
1214 /// entry.
1215 DIEntry *NewDIEntry(DIE *Entry = NULL) {
1216 DIEntry *Value;
1217
1218 if (Entry) {
1219 FoldingSetNodeID ID;
Jim Laskey5496f012006-11-09 14:52:14 +00001220 DIEntry::Profile(ID, Entry);
Jim Laskeyef42a012006-11-02 20:12:39 +00001221 void *Where;
1222 Value = static_cast<DIEntry *>(ValuesSet.FindNodeOrInsertPos(ID, Where));
1223
Jim Laskeyf6733882006-11-02 21:48:18 +00001224 if (Value) return Value;
Jim Laskeyef42a012006-11-02 20:12:39 +00001225
1226 Value = new DIEntry(Entry);
1227 ValuesSet.InsertNode(Value, Where);
1228 } else {
1229 Value = new DIEntry(Entry);
1230 }
1231
1232 Values.push_back(Value);
1233 return Value;
1234 }
1235
1236 /// SetDIEntry - Set a DIEntry once the debug information entry is defined.
1237 ///
1238 void SetDIEntry(DIEntry *Value, DIE *Entry) {
1239 Value->Entry = Entry;
1240 // Add to values set if not already there. If it is, we merely have a
1241 // duplicate in the values list (no harm.)
1242 ValuesSet.GetOrInsertNode(Value);
1243 }
1244
1245 /// AddUInt - Add an unsigned integer attribute data and value.
1246 ///
1247 void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer) {
1248 if (!Form) Form = DIEInteger::BestForm(false, Integer);
1249
1250 FoldingSetNodeID ID;
Jim Laskey5496f012006-11-09 14:52:14 +00001251 DIEInteger::Profile(ID, Integer);
Jim Laskeyef42a012006-11-02 20:12:39 +00001252 void *Where;
1253 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1254 if (!Value) {
1255 Value = new DIEInteger(Integer);
1256 ValuesSet.InsertNode(Value, Where);
1257 Values.push_back(Value);
Jim Laskeyef42a012006-11-02 20:12:39 +00001258 }
1259
1260 Die->AddValue(Attribute, Form, Value);
1261 }
1262
1263 /// AddSInt - Add an signed integer attribute data and value.
1264 ///
1265 void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer) {
1266 if (!Form) Form = DIEInteger::BestForm(true, Integer);
1267
1268 FoldingSetNodeID ID;
Jim Laskey5496f012006-11-09 14:52:14 +00001269 DIEInteger::Profile(ID, (uint64_t)Integer);
Jim Laskeyef42a012006-11-02 20:12:39 +00001270 void *Where;
1271 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1272 if (!Value) {
1273 Value = new DIEInteger(Integer);
1274 ValuesSet.InsertNode(Value, Where);
1275 Values.push_back(Value);
Jim Laskeyef42a012006-11-02 20:12:39 +00001276 }
1277
1278 Die->AddValue(Attribute, Form, Value);
1279 }
1280
1281 /// AddString - Add a std::string attribute data and value.
1282 ///
1283 void AddString(DIE *Die, unsigned Attribute, unsigned Form,
1284 const std::string &String) {
1285 FoldingSetNodeID ID;
Jim Laskey5496f012006-11-09 14:52:14 +00001286 DIEString::Profile(ID, String);
Jim Laskeyef42a012006-11-02 20:12:39 +00001287 void *Where;
1288 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1289 if (!Value) {
1290 Value = new DIEString(String);
1291 ValuesSet.InsertNode(Value, Where);
1292 Values.push_back(Value);
Jim Laskeyef42a012006-11-02 20:12:39 +00001293 }
1294
1295 Die->AddValue(Attribute, Form, Value);
1296 }
1297
1298 /// AddLabel - Add a Dwarf label attribute data and value.
1299 ///
1300 void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
1301 const DWLabel &Label) {
1302 FoldingSetNodeID ID;
Jim Laskey5496f012006-11-09 14:52:14 +00001303 DIEDwarfLabel::Profile(ID, Label);
Jim Laskeyef42a012006-11-02 20:12:39 +00001304 void *Where;
1305 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1306 if (!Value) {
1307 Value = new DIEDwarfLabel(Label);
1308 ValuesSet.InsertNode(Value, Where);
1309 Values.push_back(Value);
Jim Laskeyef42a012006-11-02 20:12:39 +00001310 }
1311
1312 Die->AddValue(Attribute, Form, Value);
1313 }
1314
1315 /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
1316 ///
1317 void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
1318 const std::string &Label) {
1319 FoldingSetNodeID ID;
Jim Laskey5496f012006-11-09 14:52:14 +00001320 DIEObjectLabel::Profile(ID, Label);
Jim Laskeyef42a012006-11-02 20:12:39 +00001321 void *Where;
1322 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1323 if (!Value) {
1324 Value = new DIEObjectLabel(Label);
1325 ValuesSet.InsertNode(Value, Where);
1326 Values.push_back(Value);
Jim Laskeyef42a012006-11-02 20:12:39 +00001327 }
1328
1329 Die->AddValue(Attribute, Form, Value);
1330 }
1331
Argyrios Kyrtzidisf7acf8f2008-06-18 19:27:37 +00001332 /// AddSectionOffset - Add a section offset label attribute data and value.
1333 ///
1334 void AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
1335 const DWLabel &Label, const DWLabel &Section,
1336 bool isEH = false, bool useSet = true) {
1337 FoldingSetNodeID ID;
1338 DIESectionOffset::Profile(ID, Label, Section);
1339 void *Where;
1340 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1341 if (!Value) {
1342 Value = new DIESectionOffset(Label, Section, isEH, useSet);
1343 ValuesSet.InsertNode(Value, Where);
1344 Values.push_back(Value);
1345 }
1346
1347 Die->AddValue(Attribute, Form, Value);
1348 }
1349
Jim Laskeyef42a012006-11-02 20:12:39 +00001350 /// AddDelta - Add a label delta attribute data and value.
1351 ///
1352 void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
1353 const DWLabel &Hi, const DWLabel &Lo) {
1354 FoldingSetNodeID ID;
Jim Laskey5496f012006-11-09 14:52:14 +00001355 DIEDelta::Profile(ID, Hi, Lo);
Jim Laskeyef42a012006-11-02 20:12:39 +00001356 void *Where;
1357 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1358 if (!Value) {
1359 Value = new DIEDelta(Hi, Lo);
1360 ValuesSet.InsertNode(Value, Where);
1361 Values.push_back(Value);
Jim Laskeyef42a012006-11-02 20:12:39 +00001362 }
1363
1364 Die->AddValue(Attribute, Form, Value);
1365 }
1366
1367 /// AddDIEntry - Add a DIE attribute data and value.
1368 ///
1369 void AddDIEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
1370 Die->AddValue(Attribute, Form, NewDIEntry(Entry));
1371 }
1372
1373 /// AddBlock - Add block data.
1374 ///
1375 void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block) {
1376 Block->ComputeSize(*this);
1377 FoldingSetNodeID ID;
1378 Block->Profile(ID);
1379 void *Where;
1380 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1381 if (!Value) {
1382 Value = Block;
1383 ValuesSet.InsertNode(Value, Where);
1384 Values.push_back(Value);
1385 } else {
Chris Lattnerc369bd72007-09-21 18:25:53 +00001386 // Already exists, reuse the previous one.
Jim Laskeyef42a012006-11-02 20:12:39 +00001387 delete Block;
Chris Lattnerc369bd72007-09-21 18:25:53 +00001388 Block = cast<DIEBlock>(Value);
Jim Laskeyef42a012006-11-02 20:12:39 +00001389 }
1390
1391 Die->AddValue(Attribute, Block->BestForm(), Value);
1392 }
1393
Jim Laskey65195462006-10-30 13:35:07 +00001394private:
1395
1396 /// AddSourceLine - Add location information to specified debug information
Jim Laskeyef42a012006-11-02 20:12:39 +00001397 /// entry.
1398 void AddSourceLine(DIE *Die, CompileUnitDesc *File, unsigned Line) {
1399 if (File && Line) {
1400 CompileUnit *FileUnit = FindCompileUnit(File);
1401 unsigned FileID = FileUnit->getID();
1402 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1403 AddUInt(Die, DW_AT_decl_line, 0, Line);
1404 }
1405 }
Jim Laskey65195462006-10-30 13:35:07 +00001406
1407 /// AddAddress - Add an address attribute to a die based on the location
1408 /// provided.
1409 void AddAddress(DIE *Die, unsigned Attribute,
Jim Laskeyef42a012006-11-02 20:12:39 +00001410 const MachineLocation &Location) {
Dale Johannesenb97aec62007-11-13 19:13:01 +00001411 unsigned Reg = RI->getDwarfRegNum(Location.getRegister(), false);
Jim Laskeyef42a012006-11-02 20:12:39 +00001412 DIEBlock *Block = new DIEBlock();
1413
1414 if (Location.isRegister()) {
1415 if (Reg < 32) {
1416 AddUInt(Block, 0, DW_FORM_data1, DW_OP_reg0 + Reg);
1417 } else {
1418 AddUInt(Block, 0, DW_FORM_data1, DW_OP_regx);
1419 AddUInt(Block, 0, DW_FORM_udata, Reg);
1420 }
1421 } else {
1422 if (Reg < 32) {
1423 AddUInt(Block, 0, DW_FORM_data1, DW_OP_breg0 + Reg);
1424 } else {
1425 AddUInt(Block, 0, DW_FORM_data1, DW_OP_bregx);
1426 AddUInt(Block, 0, DW_FORM_udata, Reg);
1427 }
1428 AddUInt(Block, 0, DW_FORM_sdata, Location.getOffset());
1429 }
1430
1431 AddBlock(Die, Attribute, 0, Block);
1432 }
1433
1434 /// AddBasicType - Add a new basic type attribute to the specified entity.
1435 ///
1436 void AddBasicType(DIE *Entity, CompileUnit *Unit,
1437 const std::string &Name,
1438 unsigned Encoding, unsigned Size) {
1439 DIE *Die = ConstructBasicType(Unit, Name, Encoding, Size);
1440 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, Die);
1441 }
1442
1443 /// ConstructBasicType - Construct a new basic type.
1444 ///
1445 DIE *ConstructBasicType(CompileUnit *Unit,
1446 const std::string &Name,
1447 unsigned Encoding, unsigned Size) {
1448 DIE Buffer(DW_TAG_base_type);
1449 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1450 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, Encoding);
1451 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1452 return Unit->AddDie(Buffer);
1453 }
1454
1455 /// AddPointerType - Add a new pointer type attribute to the specified entity.
1456 ///
1457 void AddPointerType(DIE *Entity, CompileUnit *Unit, const std::string &Name) {
1458 DIE *Die = ConstructPointerType(Unit, Name);
1459 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, Die);
1460 }
1461
1462 /// ConstructPointerType - Construct a new pointer type.
1463 ///
1464 DIE *ConstructPointerType(CompileUnit *Unit, const std::string &Name) {
1465 DIE Buffer(DW_TAG_pointer_type);
Dan Gohman82482942007-09-27 23:12:31 +00001466 AddUInt(&Buffer, DW_AT_byte_size, 0, TD->getPointerSize());
Jim Laskeyef42a012006-11-02 20:12:39 +00001467 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1468 return Unit->AddDie(Buffer);
1469 }
1470
1471 /// AddType - Add a new type attribute to the specified entity.
1472 ///
1473 void AddType(DIE *Entity, TypeDesc *TyDesc, CompileUnit *Unit) {
1474 if (!TyDesc) {
Jim Laskey2b935d52007-01-26 14:19:17 +00001475 AddBasicType(Entity, Unit, "", DW_ATE_signed, sizeof(int32_t));
Jim Laskeyef42a012006-11-02 20:12:39 +00001476 } else {
1477 // Check for pre-existence.
1478 DIEntry *&Slot = Unit->getDIEntrySlotFor(TyDesc);
1479
1480 // If it exists then use the existing value.
1481 if (Slot) {
Jim Laskeyef42a012006-11-02 20:12:39 +00001482 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1483 return;
1484 }
1485
1486 if (SubprogramDesc *SubprogramTy = dyn_cast<SubprogramDesc>(TyDesc)) {
1487 // FIXME - Not sure why programs and variables are coming through here.
1488 // Short cut for handling subprogram types (not really a TyDesc.)
1489 AddPointerType(Entity, Unit, SubprogramTy->getName());
1490 } else if (GlobalVariableDesc *GlobalTy =
1491 dyn_cast<GlobalVariableDesc>(TyDesc)) {
1492 // FIXME - Not sure why programs and variables are coming through here.
1493 // Short cut for handling global variable types (not really a TyDesc.)
1494 AddPointerType(Entity, Unit, GlobalTy->getName());
1495 } else {
1496 // Set up proxy.
1497 Slot = NewDIEntry();
1498
1499 // Construct type.
1500 DIE Buffer(DW_TAG_base_type);
1501 ConstructType(Buffer, TyDesc, Unit);
1502
1503 // Add debug information entry to entity and unit.
1504 DIE *Die = Unit->AddDie(Buffer);
1505 SetDIEntry(Slot, Die);
1506 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1507 }
1508 }
1509 }
1510
1511 /// ConstructType - Adds all the required attributes to the type.
1512 ///
1513 void ConstructType(DIE &Buffer, TypeDesc *TyDesc, CompileUnit *Unit) {
1514 // Get core information.
1515 const std::string &Name = TyDesc->getName();
1516 uint64_t Size = TyDesc->getSize() >> 3;
1517
1518 if (BasicTypeDesc *BasicTy = dyn_cast<BasicTypeDesc>(TyDesc)) {
1519 // Fundamental types like int, float, bool
1520 Buffer.setTag(DW_TAG_base_type);
1521 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, BasicTy->getEncoding());
1522 } else if (DerivedTypeDesc *DerivedTy = dyn_cast<DerivedTypeDesc>(TyDesc)) {
Jim Laskey85f419b2006-11-09 16:32:26 +00001523 // Fetch tag.
1524 unsigned Tag = DerivedTy->getTag();
1525 // FIXME - Workaround for templates.
1526 if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
1527 // Pointers, typedefs et al.
1528 Buffer.setTag(Tag);
Jim Laskeyef42a012006-11-02 20:12:39 +00001529 // Map to main type, void will not have a type.
1530 if (TypeDesc *FromTy = DerivedTy->getFromType())
1531 AddType(&Buffer, FromTy, Unit);
1532 } else if (CompositeTypeDesc *CompTy = dyn_cast<CompositeTypeDesc>(TyDesc)){
1533 // Fetch tag.
1534 unsigned Tag = CompTy->getTag();
1535
1536 // Set tag accordingly.
1537 if (Tag == DW_TAG_vector_type)
1538 Buffer.setTag(DW_TAG_array_type);
1539 else
1540 Buffer.setTag(Tag);
Jim Laskey65195462006-10-30 13:35:07 +00001541
Jim Laskeyef42a012006-11-02 20:12:39 +00001542 std::vector<DebugInfoDesc *> &Elements = CompTy->getElements();
1543
1544 switch (Tag) {
1545 case DW_TAG_vector_type:
1546 AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1547 // Fall thru
1548 case DW_TAG_array_type: {
1549 // Add element type.
1550 if (TypeDesc *FromTy = CompTy->getFromType())
1551 AddType(&Buffer, FromTy, Unit);
1552
1553 // Don't emit size attribute.
1554 Size = 0;
1555
1556 // Construct an anonymous type for index type.
Jim Laskey2b935d52007-01-26 14:19:17 +00001557 DIE *IndexTy = ConstructBasicType(Unit, "", DW_ATE_signed,
1558 sizeof(int32_t));
Jim Laskeyef42a012006-11-02 20:12:39 +00001559
1560 // Add subranges to array type.
1561 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1562 SubrangeDesc *SRD = cast<SubrangeDesc>(Elements[i]);
1563 int64_t Lo = SRD->getLo();
1564 int64_t Hi = SRD->getHi();
1565 DIE *Subrange = new DIE(DW_TAG_subrange_type);
1566
1567 // If a range is available.
1568 if (Lo != Hi) {
1569 AddDIEntry(Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1570 // Only add low if non-zero.
1571 if (Lo) AddSInt(Subrange, DW_AT_lower_bound, 0, Lo);
1572 AddSInt(Subrange, DW_AT_upper_bound, 0, Hi);
1573 }
1574
1575 Buffer.AddChild(Subrange);
1576 }
1577 break;
1578 }
1579 case DW_TAG_structure_type:
1580 case DW_TAG_union_type: {
1581 // Add elements to structure type.
1582 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1583 DebugInfoDesc *Element = Elements[i];
1584
1585 if (DerivedTypeDesc *MemberDesc = dyn_cast<DerivedTypeDesc>(Element)){
1586 // Add field or base class.
1587
1588 unsigned Tag = MemberDesc->getTag();
1589
1590 // Extract the basic information.
1591 const std::string &Name = MemberDesc->getName();
Jim Laskeyef42a012006-11-02 20:12:39 +00001592 uint64_t Size = MemberDesc->getSize();
1593 uint64_t Align = MemberDesc->getAlign();
1594 uint64_t Offset = MemberDesc->getOffset();
1595
1596 // Construct member debug information entry.
1597 DIE *Member = new DIE(Tag);
1598
1599 // Add name if not "".
1600 if (!Name.empty())
1601 AddString(Member, DW_AT_name, DW_FORM_string, Name);
1602 // Add location if available.
1603 AddSourceLine(Member, MemberDesc->getFile(), MemberDesc->getLine());
1604
1605 // Most of the time the field info is the same as the members.
1606 uint64_t FieldSize = Size;
1607 uint64_t FieldAlign = Align;
1608 uint64_t FieldOffset = Offset;
1609
Jim Laskeyee5f9272006-12-22 20:03:42 +00001610 // Set the member type.
1611 TypeDesc *FromTy = MemberDesc->getFromType();
1612 AddType(Member, FromTy, Unit);
1613
1614 // Walk up typedefs until a real size is found.
1615 while (FromTy) {
1616 if (FromTy->getTag() != DW_TAG_typedef) {
1617 FieldSize = FromTy->getSize();
1618 FieldAlign = FromTy->getSize();
1619 break;
1620 }
1621
Dan Gohman275769a2007-07-23 20:24:29 +00001622 FromTy = cast<DerivedTypeDesc>(FromTy)->getFromType();
Jim Laskeyef42a012006-11-02 20:12:39 +00001623 }
1624
1625 // Unless we have a bit field.
1626 if (Tag == DW_TAG_member && FieldSize != Size) {
1627 // Construct the alignment mask.
1628 uint64_t AlignMask = ~(FieldAlign - 1);
1629 // Determine the high bit + 1 of the declared size.
1630 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1631 // Work backwards to determine the base offset of the field.
1632 FieldOffset = HiMark - FieldSize;
1633 // Now normalize offset to the field.
1634 Offset -= FieldOffset;
1635
1636 // Maybe we need to work from the other end.
1637 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
1638
1639 // Add size and offset.
1640 AddUInt(Member, DW_AT_byte_size, 0, FieldSize >> 3);
1641 AddUInt(Member, DW_AT_bit_size, 0, Size);
1642 AddUInt(Member, DW_AT_bit_offset, 0, Offset);
1643 }
1644
1645 // Add computation for offset.
1646 DIEBlock *Block = new DIEBlock();
1647 AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
1648 AddUInt(Block, 0, DW_FORM_udata, FieldOffset >> 3);
1649 AddBlock(Member, DW_AT_data_member_location, 0, Block);
1650
1651 // Add accessibility (public default unless is base class.
1652 if (MemberDesc->isProtected()) {
1653 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_protected);
1654 } else if (MemberDesc->isPrivate()) {
1655 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_private);
1656 } else if (Tag == DW_TAG_inheritance) {
1657 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_public);
1658 }
1659
1660 Buffer.AddChild(Member);
1661 } else if (GlobalVariableDesc *StaticDesc =
1662 dyn_cast<GlobalVariableDesc>(Element)) {
1663 // Add static member.
1664
1665 // Construct member debug information entry.
1666 DIE *Static = new DIE(DW_TAG_variable);
1667
1668 // Add name and mangled name.
Jim Laskey2172f962006-11-30 14:35:45 +00001669 const std::string &Name = StaticDesc->getName();
1670 const std::string &LinkageName = StaticDesc->getLinkageName();
Jim Laskeyef42a012006-11-02 20:12:39 +00001671 AddString(Static, DW_AT_name, DW_FORM_string, Name);
Jim Laskey2172f962006-11-30 14:35:45 +00001672 if (!LinkageName.empty()) {
1673 AddString(Static, DW_AT_MIPS_linkage_name, DW_FORM_string,
1674 LinkageName);
1675 }
Jim Laskeyef42a012006-11-02 20:12:39 +00001676
1677 // Add location.
1678 AddSourceLine(Static, StaticDesc->getFile(), StaticDesc->getLine());
1679
1680 // Add type.
1681 if (TypeDesc *StaticTy = StaticDesc->getType())
1682 AddType(Static, StaticTy, Unit);
1683
1684 // Add flags.
Jim Laskey6488a072007-01-08 22:15:18 +00001685 if (!StaticDesc->isStatic())
1686 AddUInt(Static, DW_AT_external, DW_FORM_flag, 1);
Jim Laskeyef42a012006-11-02 20:12:39 +00001687 AddUInt(Static, DW_AT_declaration, DW_FORM_flag, 1);
1688
1689 Buffer.AddChild(Static);
1690 } else if (SubprogramDesc *MethodDesc =
1691 dyn_cast<SubprogramDesc>(Element)) {
1692 // Add member function.
1693
1694 // Construct member debug information entry.
1695 DIE *Method = new DIE(DW_TAG_subprogram);
1696
1697 // Add name and mangled name.
Jim Laskey2172f962006-11-30 14:35:45 +00001698 const std::string &Name = MethodDesc->getName();
1699 const std::string &LinkageName = MethodDesc->getLinkageName();
Jim Laskeyef42a012006-11-02 20:12:39 +00001700
Jim Laskey2172f962006-11-30 14:35:45 +00001701 AddString(Method, DW_AT_name, DW_FORM_string, Name);
1702 bool IsCTor = TyDesc->getName() == Name;
1703
1704 if (!LinkageName.empty()) {
Jim Laskeyef42a012006-11-02 20:12:39 +00001705 AddString(Method, DW_AT_MIPS_linkage_name, DW_FORM_string,
Jim Laskey2172f962006-11-30 14:35:45 +00001706 LinkageName);
Jim Laskeyef42a012006-11-02 20:12:39 +00001707 }
1708
1709 // Add location.
1710 AddSourceLine(Method, MethodDesc->getFile(), MethodDesc->getLine());
1711
1712 // Add type.
1713 if (CompositeTypeDesc *MethodTy =
1714 dyn_cast_or_null<CompositeTypeDesc>(MethodDesc->getType())) {
1715 // Get argument information.
1716 std::vector<DebugInfoDesc *> &Args = MethodTy->getElements();
1717
1718 // If not a ctor.
1719 if (!IsCTor) {
1720 // Add return type.
1721 AddType(Method, dyn_cast<TypeDesc>(Args[0]), Unit);
1722 }
1723
1724 // Add arguments.
1725 for(unsigned i = 1, N = Args.size(); i < N; ++i) {
1726 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1727 AddType(Arg, cast<TypeDesc>(Args[i]), Unit);
1728 AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1);
1729 Method->AddChild(Arg);
1730 }
1731 }
1732
1733 // Add flags.
Jim Laskey6488a072007-01-08 22:15:18 +00001734 if (!MethodDesc->isStatic())
1735 AddUInt(Method, DW_AT_external, DW_FORM_flag, 1);
Jim Laskeyef42a012006-11-02 20:12:39 +00001736 AddUInt(Method, DW_AT_declaration, DW_FORM_flag, 1);
1737
1738 Buffer.AddChild(Method);
1739 }
1740 }
1741 break;
1742 }
1743 case DW_TAG_enumeration_type: {
1744 // Add enumerators to enumeration type.
1745 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1746 EnumeratorDesc *ED = cast<EnumeratorDesc>(Elements[i]);
1747 const std::string &Name = ED->getName();
1748 int64_t Value = ED->getValue();
1749 DIE *Enumerator = new DIE(DW_TAG_enumerator);
1750 AddString(Enumerator, DW_AT_name, DW_FORM_string, Name);
1751 AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
1752 Buffer.AddChild(Enumerator);
1753 }
1754
1755 break;
1756 }
1757 case DW_TAG_subroutine_type: {
1758 // Add prototype flag.
1759 AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
1760 // Add return type.
1761 AddType(&Buffer, dyn_cast<TypeDesc>(Elements[0]), Unit);
1762
1763 // Add arguments.
1764 for(unsigned i = 1, N = Elements.size(); i < N; ++i) {
1765 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1766 AddType(Arg, cast<TypeDesc>(Elements[i]), Unit);
1767 Buffer.AddChild(Arg);
1768 }
1769
1770 break;
1771 }
1772 default: break;
1773 }
1774 }
1775
1776 // Add size if non-zero (derived types don't have a size.)
1777 if (Size) AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1778 // Add name if not anonymous or intermediate type.
1779 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1780 // Add source line info if available.
1781 AddSourceLine(&Buffer, TyDesc->getFile(), TyDesc->getLine());
1782 }
1783
1784 /// NewCompileUnit - Create new compile unit and it's debug information entry.
Jim Laskey65195462006-10-30 13:35:07 +00001785 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00001786 CompileUnit *NewCompileUnit(CompileUnitDesc *UnitDesc, unsigned ID) {
1787 // Construct debug information entry.
1788 DIE *Die = new DIE(DW_TAG_compile_unit);
Argyrios Kyrtzidisf7acf8f2008-06-18 19:27:37 +00001789 AddSectionOffset(Die, DW_AT_stmt_list, DW_FORM_data4,
1790 DWLabel("section_line", 0), DWLabel("section_line", 0), false);
Jim Laskeyef42a012006-11-02 20:12:39 +00001791 AddString(Die, DW_AT_producer, DW_FORM_string, UnitDesc->getProducer());
1792 AddUInt (Die, DW_AT_language, DW_FORM_data1, UnitDesc->getLanguage());
1793 AddString(Die, DW_AT_name, DW_FORM_string, UnitDesc->getFileName());
1794 AddString(Die, DW_AT_comp_dir, DW_FORM_string, UnitDesc->getDirectory());
1795
1796 // Construct compile unit.
1797 CompileUnit *Unit = new CompileUnit(UnitDesc, ID, Die);
1798
1799 // Add Unit to compile unit map.
1800 DescToUnitMap[UnitDesc] = Unit;
1801
1802 return Unit;
1803 }
1804
Jim Laskey9d4209f2006-11-07 19:33:46 +00001805 /// GetBaseCompileUnit - Get the main compile unit.
1806 ///
1807 CompileUnit *GetBaseCompileUnit() const {
1808 CompileUnit *Unit = CompileUnits[0];
1809 assert(Unit && "Missing compile unit.");
1810 return Unit;
1811 }
1812
Jim Laskey65195462006-10-30 13:35:07 +00001813 /// FindCompileUnit - Get the compile unit for the given descriptor.
1814 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00001815 CompileUnit *FindCompileUnit(CompileUnitDesc *UnitDesc) {
Jim Laskeyef42a012006-11-02 20:12:39 +00001816 CompileUnit *Unit = DescToUnitMap[UnitDesc];
Jim Laskeyef42a012006-11-02 20:12:39 +00001817 assert(Unit && "Missing compile unit.");
1818 return Unit;
1819 }
1820
1821 /// NewGlobalVariable - Add a new global variable DIE.
Jim Laskey65195462006-10-30 13:35:07 +00001822 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00001823 DIE *NewGlobalVariable(GlobalVariableDesc *GVD) {
1824 // Get the compile unit context.
1825 CompileUnitDesc *UnitDesc =
1826 static_cast<CompileUnitDesc *>(GVD->getContext());
Jim Laskey5496f012006-11-09 14:52:14 +00001827 CompileUnit *Unit = GetBaseCompileUnit();
Jim Laskeyef42a012006-11-02 20:12:39 +00001828
1829 // Check for pre-existence.
1830 DIE *&Slot = Unit->getDieMapSlotFor(GVD);
1831 if (Slot) return Slot;
1832
1833 // Get the global variable itself.
1834 GlobalVariable *GV = GVD->getGlobalVariable();
1835
Jim Laskey2172f962006-11-30 14:35:45 +00001836 const std::string &Name = GVD->getName();
1837 const std::string &FullName = GVD->getFullName();
1838 const std::string &LinkageName = GVD->getLinkageName();
Jim Laskeyef42a012006-11-02 20:12:39 +00001839 // Create the global's variable DIE.
1840 DIE *VariableDie = new DIE(DW_TAG_variable);
1841 AddString(VariableDie, DW_AT_name, DW_FORM_string, Name);
Jim Laskey2172f962006-11-30 14:35:45 +00001842 if (!LinkageName.empty()) {
Jim Laskeyef42a012006-11-02 20:12:39 +00001843 AddString(VariableDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
Jim Laskey2172f962006-11-30 14:35:45 +00001844 LinkageName);
Jim Laskeyef42a012006-11-02 20:12:39 +00001845 }
Jim Laskey6488a072007-01-08 22:15:18 +00001846 AddType(VariableDie, GVD->getType(), Unit);
1847 if (!GVD->isStatic())
1848 AddUInt(VariableDie, DW_AT_external, DW_FORM_flag, 1);
Jim Laskeyef42a012006-11-02 20:12:39 +00001849
1850 // Add source line info if available.
1851 AddSourceLine(VariableDie, UnitDesc, GVD->getLine());
1852
Jim Laskeyef42a012006-11-02 20:12:39 +00001853 // Add address.
1854 DIEBlock *Block = new DIEBlock();
1855 AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
Jim Laskey2172f962006-11-30 14:35:45 +00001856 AddObjectLabel(Block, 0, DW_FORM_udata, Asm->getGlobalLinkName(GV));
1857 AddBlock(VariableDie, DW_AT_location, 0, Block);
Jim Laskeyef42a012006-11-02 20:12:39 +00001858
1859 // Add to map.
1860 Slot = VariableDie;
1861
1862 // Add to context owner.
1863 Unit->getDie()->AddChild(VariableDie);
1864
1865 // Expose as global.
1866 // FIXME - need to check external flag.
Jim Laskey2172f962006-11-30 14:35:45 +00001867 Unit->AddGlobal(FullName, VariableDie);
Jim Laskeyef42a012006-11-02 20:12:39 +00001868
1869 return VariableDie;
1870 }
Jim Laskey65195462006-10-30 13:35:07 +00001871
1872 /// NewSubprogram - Add a new subprogram DIE.
1873 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00001874 DIE *NewSubprogram(SubprogramDesc *SPD) {
1875 // Get the compile unit context.
1876 CompileUnitDesc *UnitDesc =
1877 static_cast<CompileUnitDesc *>(SPD->getContext());
Jim Laskey5496f012006-11-09 14:52:14 +00001878 CompileUnit *Unit = GetBaseCompileUnit();
Jim Laskeyef42a012006-11-02 20:12:39 +00001879
1880 // Check for pre-existence.
1881 DIE *&Slot = Unit->getDieMapSlotFor(SPD);
1882 if (Slot) return Slot;
1883
1884 // Gather the details (simplify add attribute code.)
Jim Laskey2172f962006-11-30 14:35:45 +00001885 const std::string &Name = SPD->getName();
1886 const std::string &FullName = SPD->getFullName();
1887 const std::string &LinkageName = SPD->getLinkageName();
Jim Laskeyef42a012006-11-02 20:12:39 +00001888
1889 DIE *SubprogramDie = new DIE(DW_TAG_subprogram);
1890 AddString(SubprogramDie, DW_AT_name, DW_FORM_string, Name);
Jim Laskey2172f962006-11-30 14:35:45 +00001891 if (!LinkageName.empty()) {
Jim Laskeyef42a012006-11-02 20:12:39 +00001892 AddString(SubprogramDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
Jim Laskey2172f962006-11-30 14:35:45 +00001893 LinkageName);
Jim Laskeyef42a012006-11-02 20:12:39 +00001894 }
1895 if (SPD->getType()) AddType(SubprogramDie, SPD->getType(), Unit);
Jim Laskey6488a072007-01-08 22:15:18 +00001896 if (!SPD->isStatic())
1897 AddUInt(SubprogramDie, DW_AT_external, DW_FORM_flag, 1);
Jim Laskeyef42a012006-11-02 20:12:39 +00001898 AddUInt(SubprogramDie, DW_AT_prototyped, DW_FORM_flag, 1);
1899
1900 // Add source line info if available.
1901 AddSourceLine(SubprogramDie, UnitDesc, SPD->getLine());
1902
1903 // Add to map.
1904 Slot = SubprogramDie;
1905
1906 // Add to context owner.
1907 Unit->getDie()->AddChild(SubprogramDie);
1908
1909 // Expose as global.
Jim Laskey2172f962006-11-30 14:35:45 +00001910 Unit->AddGlobal(FullName, SubprogramDie);
Jim Laskeyef42a012006-11-02 20:12:39 +00001911
1912 return SubprogramDie;
1913 }
Jim Laskey65195462006-10-30 13:35:07 +00001914
1915 /// NewScopeVariable - Create a new scope variable.
1916 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00001917 DIE *NewScopeVariable(DebugVariable *DV, CompileUnit *Unit) {
1918 // Get the descriptor.
1919 VariableDesc *VD = DV->getDesc();
1920
1921 // Translate tag to proper Dwarf tag. The result variable is dropped for
1922 // now.
1923 unsigned Tag;
1924 switch (VD->getTag()) {
1925 case DW_TAG_return_variable: return NULL;
1926 case DW_TAG_arg_variable: Tag = DW_TAG_formal_parameter; break;
1927 case DW_TAG_auto_variable: // fall thru
1928 default: Tag = DW_TAG_variable; break;
1929 }
1930
1931 // Define variable debug information entry.
1932 DIE *VariableDie = new DIE(Tag);
1933 AddString(VariableDie, DW_AT_name, DW_FORM_string, VD->getName());
1934
1935 // Add source line info if available.
1936 AddSourceLine(VariableDie, VD->getFile(), VD->getLine());
1937
1938 // Add variable type.
1939 AddType(VariableDie, VD->getType(), Unit);
1940
1941 // Add variable address.
1942 MachineLocation Location;
Evan Cheng72bebb92008-01-31 03:37:28 +00001943 Location.set(RI->getFrameRegister(*MF),
1944 RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
Jim Laskeyef42a012006-11-02 20:12:39 +00001945 AddAddress(VariableDie, DW_AT_location, Location);
Jim Laskey5496f012006-11-09 14:52:14 +00001946
Jim Laskeyef42a012006-11-02 20:12:39 +00001947 return VariableDie;
1948 }
Jim Laskey65195462006-10-30 13:35:07 +00001949
1950 /// ConstructScope - Construct the components of a scope.
1951 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00001952 void ConstructScope(DebugScope *ParentScope,
Jim Laskey36729dd2006-11-29 16:55:57 +00001953 unsigned ParentStartID, unsigned ParentEndID,
1954 DIE *ParentDie, CompileUnit *Unit) {
Jim Laskeyef42a012006-11-02 20:12:39 +00001955 // Add variables to scope.
1956 std::vector<DebugVariable *> &Variables = ParentScope->getVariables();
1957 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
1958 DIE *VariableDie = NewScopeVariable(Variables[i], Unit);
1959 if (VariableDie) ParentDie->AddChild(VariableDie);
1960 }
1961
1962 // Add nested scopes.
1963 std::vector<DebugScope *> &Scopes = ParentScope->getScopes();
1964 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1965 // Define the Scope debug information entry.
1966 DebugScope *Scope = Scopes[j];
1967 // FIXME - Ignore inlined functions for the time being.
1968 if (!Scope->getParent()) continue;
1969
Jim Laskey44c3b9f2007-01-26 21:22:28 +00001970 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
1971 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
Jim Laskey5496f012006-11-09 14:52:14 +00001972
Jim Laskey9d4209f2006-11-07 19:33:46 +00001973 // Ignore empty scopes.
1974 if (StartID == EndID && StartID != 0) continue;
1975 if (Scope->getScopes().empty() && Scope->getVariables().empty()) continue;
Jim Laskeyef42a012006-11-02 20:12:39 +00001976
Jim Laskey36729dd2006-11-29 16:55:57 +00001977 if (StartID == ParentStartID && EndID == ParentEndID) {
1978 // Just add stuff to the parent scope.
1979 ConstructScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
Jim Laskeyef42a012006-11-02 20:12:39 +00001980 } else {
Jim Laskey36729dd2006-11-29 16:55:57 +00001981 DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
1982
1983 // Add the scope bounds.
1984 if (StartID) {
1985 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
Jim Laskeybacd3042007-02-21 22:48:45 +00001986 DWLabel("label", StartID));
Jim Laskey36729dd2006-11-29 16:55:57 +00001987 } else {
1988 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
1989 DWLabel("func_begin", SubprogramCount));
1990 }
1991 if (EndID) {
1992 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
Jim Laskeybacd3042007-02-21 22:48:45 +00001993 DWLabel("label", EndID));
Jim Laskey36729dd2006-11-29 16:55:57 +00001994 } else {
1995 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
1996 DWLabel("func_end", SubprogramCount));
1997 }
1998
1999 // Add the scope contents.
2000 ConstructScope(Scope, StartID, EndID, ScopeDie, Unit);
2001 ParentDie->AddChild(ScopeDie);
Jim Laskeyef42a012006-11-02 20:12:39 +00002002 }
Jim Laskeyef42a012006-11-02 20:12:39 +00002003 }
2004 }
Jim Laskey65195462006-10-30 13:35:07 +00002005
2006 /// ConstructRootScope - Construct the scope for the subprogram.
2007 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002008 void ConstructRootScope(DebugScope *RootScope) {
2009 // Exit if there is no root scope.
2010 if (!RootScope) return;
2011
2012 // Get the subprogram debug information entry.
2013 SubprogramDesc *SPD = cast<SubprogramDesc>(RootScope->getDesc());
2014
2015 // Get the compile unit context.
Jim Laskey5496f012006-11-09 14:52:14 +00002016 CompileUnit *Unit = GetBaseCompileUnit();
Jim Laskeyef42a012006-11-02 20:12:39 +00002017
2018 // Get the subprogram die.
2019 DIE *SPDie = Unit->getDieMapSlotFor(SPD);
2020 assert(SPDie && "Missing subprogram descriptor");
2021
2022 // Add the function bounds.
2023 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2024 DWLabel("func_begin", SubprogramCount));
2025 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2026 DWLabel("func_end", SubprogramCount));
2027 MachineLocation Location(RI->getFrameRegister(*MF));
2028 AddAddress(SPDie, DW_AT_frame_base, Location);
Jim Laskey5496f012006-11-09 14:52:14 +00002029
Jim Laskey36729dd2006-11-29 16:55:57 +00002030 ConstructScope(RootScope, 0, 0, SPDie, Unit);
Jim Laskeyef42a012006-11-02 20:12:39 +00002031 }
Jim Laskey65195462006-10-30 13:35:07 +00002032
Jim Laskeyef42a012006-11-02 20:12:39 +00002033 /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
2034 /// tools to recognize the object file contains Dwarf information.
2035 void EmitInitial() {
2036 // Check to see if we already emitted intial headers.
2037 if (didInitial) return;
2038 didInitial = true;
2039
2040 // Dwarf sections base addresses.
Anton Korobeynikov2a07e2f2007-05-05 09:04:50 +00002041 if (TAI->doesDwarfRequireFrameSection()) {
Jim Laskeyef42a012006-11-02 20:12:39 +00002042 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002043 EmitLabel("section_debug_frame", 0);
Jim Laskeyef42a012006-11-02 20:12:39 +00002044 }
2045 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2046 EmitLabel("section_info", 0);
2047 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2048 EmitLabel("section_abbrev", 0);
2049 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2050 EmitLabel("section_aranges", 0);
2051 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2052 EmitLabel("section_macinfo", 0);
2053 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2054 EmitLabel("section_line", 0);
2055 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2056 EmitLabel("section_loc", 0);
2057 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2058 EmitLabel("section_pubnames", 0);
2059 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2060 EmitLabel("section_str", 0);
2061 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2062 EmitLabel("section_ranges", 0);
2063
2064 Asm->SwitchToTextSection(TAI->getTextSection());
2065 EmitLabel("text_begin", 0);
2066 Asm->SwitchToDataSection(TAI->getDataSection());
2067 EmitLabel("data_begin", 0);
Jim Laskeyef42a012006-11-02 20:12:39 +00002068 }
2069
Jim Laskey65195462006-10-30 13:35:07 +00002070 /// EmitDIE - Recusively Emits a debug information entry.
2071 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00002072 void EmitDIE(DIE *Die) {
Jim Laskeyef42a012006-11-02 20:12:39 +00002073 // Get the abbreviation for this DIE.
2074 unsigned AbbrevNumber = Die->getAbbrevNumber();
2075 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2076
Jim Laskeybacd3042007-02-21 22:48:45 +00002077 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002078
2079 // Emit the code (index) for the abbreviation.
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002080 Asm->EmitULEB128Bytes(AbbrevNumber);
Evan Cheng6547e402008-07-01 23:18:29 +00002081
2082 if (VerboseAsm)
2083 Asm->EOL(std::string("Abbrev [" +
2084 utostr(AbbrevNumber) +
2085 "] 0x" + utohexstr(Die->getOffset()) +
2086 ":0x" + utohexstr(Die->getSize()) + " " +
2087 TagString(Abbrev->getTag())));
2088 else
2089 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002090
Owen Anderson873e1b52008-06-24 21:44:59 +00002091 SmallVector<DIEValue*, 32> &Values = Die->getValues();
2092 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
Jim Laskeyef42a012006-11-02 20:12:39 +00002093
2094 // Emit the DIE attribute values.
2095 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2096 unsigned Attr = AbbrevData[i].getAttribute();
2097 unsigned Form = AbbrevData[i].getForm();
2098 assert(Form && "Too many attributes for DIE (check abbreviation)");
2099
2100 switch (Attr) {
2101 case DW_AT_sibling: {
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002102 Asm->EmitInt32(Die->SiblingOffset());
Jim Laskeyef42a012006-11-02 20:12:39 +00002103 break;
2104 }
2105 default: {
2106 // Emit an attribute using the defined form.
2107 Values[i]->EmitValue(*this, Form);
2108 break;
2109 }
2110 }
2111
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002112 Asm->EOL(AttributeString(Attr));
Jim Laskeyef42a012006-11-02 20:12:39 +00002113 }
2114
2115 // Emit the DIE children if any.
2116 if (Abbrev->getChildrenFlag() == DW_CHILDREN_yes) {
2117 const std::vector<DIE *> &Children = Die->getChildren();
2118
2119 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2120 EmitDIE(Children[j]);
2121 }
2122
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002123 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
Jim Laskeyef42a012006-11-02 20:12:39 +00002124 }
2125 }
2126
Jim Laskey65195462006-10-30 13:35:07 +00002127 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
2128 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002129 unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
2130 // Get the children.
2131 const std::vector<DIE *> &Children = Die->getChildren();
2132
2133 // If not last sibling and has children then add sibling offset attribute.
2134 if (!Last && !Children.empty()) Die->AddSiblingOffset();
2135
2136 // Record the abbreviation.
2137 AssignAbbrevNumber(Die->getAbbrev());
2138
2139 // Get the abbreviation for this DIE.
2140 unsigned AbbrevNumber = Die->getAbbrevNumber();
2141 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2142
2143 // Set DIE offset
2144 Die->setOffset(Offset);
2145
2146 // Start the size with the size of abbreviation code.
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002147 Offset += Asm->SizeULEB128(AbbrevNumber);
Jim Laskeyef42a012006-11-02 20:12:39 +00002148
Owen Anderson873e1b52008-06-24 21:44:59 +00002149 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2150 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
Jim Laskeyef42a012006-11-02 20:12:39 +00002151
2152 // Size the DIE attribute values.
2153 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2154 // Size attribute value.
2155 Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
2156 }
2157
2158 // Size the DIE children if any.
2159 if (!Children.empty()) {
2160 assert(Abbrev->getChildrenFlag() == DW_CHILDREN_yes &&
2161 "Children flag not set");
2162
2163 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2164 Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
2165 }
2166
2167 // End of children marker.
2168 Offset += sizeof(int8_t);
2169 }
2170
2171 Die->setSize(Offset - Die->getOffset());
2172 return Offset;
2173 }
Jim Laskey65195462006-10-30 13:35:07 +00002174
2175 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
2176 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002177 void SizeAndOffsets() {
Jim Laskey5496f012006-11-09 14:52:14 +00002178 // Process base compile unit.
2179 CompileUnit *Unit = GetBaseCompileUnit();
2180 // Compute size of compile unit header
2181 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2182 sizeof(int16_t) + // DWARF version number
2183 sizeof(int32_t) + // Offset Into Abbrev. Section
2184 sizeof(int8_t); // Pointer Size (in bytes)
2185 SizeAndOffsetDie(Unit->getDie(), Offset, true);
Jim Laskeyef42a012006-11-02 20:12:39 +00002186 }
2187
Jim Laskey65195462006-10-30 13:35:07 +00002188 /// EmitDebugInfo - Emit the debug info section.
2189 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00002190 void EmitDebugInfo() {
Jim Laskeyef42a012006-11-02 20:12:39 +00002191 // Start debug info section.
2192 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2193
Jim Laskey5496f012006-11-09 14:52:14 +00002194 CompileUnit *Unit = GetBaseCompileUnit();
2195 DIE *Die = Unit->getDie();
2196 // Emit the compile units header.
2197 EmitLabel("info_begin", Unit->getID());
2198 // Emit size of content not including length itself
2199 unsigned ContentSize = Die->getSize() +
2200 sizeof(int16_t) + // DWARF version number
2201 sizeof(int32_t) + // Offset Into Abbrev. Section
Jim Laskey749b01d2006-11-30 11:09:42 +00002202 sizeof(int8_t) + // Pointer Size (in bytes)
2203 sizeof(int32_t); // FIXME - extra pad for gdb bug.
Jim Laskey5496f012006-11-09 14:52:14 +00002204
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002205 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2206 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
Anton Korobeynikov79dda2b2007-05-01 22:23:12 +00002207 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002208 Asm->EOL("Offset Into Abbrev. Section");
Dan Gohman82482942007-09-27 23:12:31 +00002209 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
Jim Laskey5496f012006-11-09 14:52:14 +00002210
2211 EmitDIE(Die);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002212 // FIXME - extra padding for gdb bug.
2213 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2214 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2215 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2216 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
Jim Laskey5496f012006-11-09 14:52:14 +00002217 EmitLabel("info_end", Unit->getID());
2218
Jim Laskeybacd3042007-02-21 22:48:45 +00002219 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002220 }
2221
Jim Laskey65195462006-10-30 13:35:07 +00002222 /// EmitAbbreviations - Emit the abbreviation section.
2223 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002224 void EmitAbbreviations() const {
2225 // Check to see if it is worth the effort.
2226 if (!Abbreviations.empty()) {
2227 // Start the debug abbrev section.
2228 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2229
2230 EmitLabel("abbrev_begin", 0);
2231
2232 // For each abbrevation.
2233 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2234 // Get abbreviation data
2235 const DIEAbbrev *Abbrev = Abbreviations[i];
2236
2237 // Emit the abbrevations code (base 1 index.)
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002238 Asm->EmitULEB128Bytes(Abbrev->getNumber());
2239 Asm->EOL("Abbreviation Code");
Jim Laskeyef42a012006-11-02 20:12:39 +00002240
2241 // Emit the abbreviations data.
2242 Abbrev->Emit(*this);
2243
Jim Laskeybacd3042007-02-21 22:48:45 +00002244 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002245 }
2246
Jim Laskey7b1b39d2007-02-22 18:22:42 +00002247 // Mark end of abbreviations.
Jim Laskey5df3ad82007-02-22 18:48:52 +00002248 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
Jim Laskey7b1b39d2007-02-22 18:22:42 +00002249
Jim Laskeyef42a012006-11-02 20:12:39 +00002250 EmitLabel("abbrev_end", 0);
2251
Jim Laskeybacd3042007-02-21 22:48:45 +00002252 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002253 }
2254 }
2255
Jim Laskey65195462006-10-30 13:35:07 +00002256 /// EmitDebugLines - Emit source line information.
2257 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00002258 void EmitDebugLines() {
Dan Gohman81a148b2007-09-24 21:43:52 +00002259 // If there are no lines to emit (such as when we're using .loc directives
2260 // to emit .debug_line information) don't emit a .debug_line header.
2261 if (SectionSourceLines.empty())
2262 return;
2263
Jim Laskeyef42a012006-11-02 20:12:39 +00002264 // Minimum line delta, thus ranging from -10..(255-10).
2265 const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
2266 // Maximum line delta, thus ranging from -10..(255-10).
2267 const int MaxLineDelta = 255 + MinLineDelta;
Jim Laskey65195462006-10-30 13:35:07 +00002268
Jim Laskeyef42a012006-11-02 20:12:39 +00002269 // Start the dwarf line section.
2270 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2271
2272 // Construct the section header.
2273
Jim Laskey2b4e98c2006-12-06 17:43:18 +00002274 EmitDifference("line_end", 0, "line_begin", 0, true);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002275 Asm->EOL("Length of Source Line Info");
Jim Laskeyef42a012006-11-02 20:12:39 +00002276 EmitLabel("line_begin", 0);
2277
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002278 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
Jim Laskeyef42a012006-11-02 20:12:39 +00002279
Jim Laskey2b4e98c2006-12-06 17:43:18 +00002280 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002281 Asm->EOL("Prolog Length");
Jim Laskeyef42a012006-11-02 20:12:39 +00002282 EmitLabel("line_prolog_begin", 0);
2283
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002284 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
Jim Laskeyef42a012006-11-02 20:12:39 +00002285
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002286 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
Jim Laskeyef42a012006-11-02 20:12:39 +00002287
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002288 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
Jim Laskeyef42a012006-11-02 20:12:39 +00002289
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002290 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
Jim Laskeyef42a012006-11-02 20:12:39 +00002291
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002292 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
Jim Laskeyef42a012006-11-02 20:12:39 +00002293
2294 // Line number standard opcode encodings argument count
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002295 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2296 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2297 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2298 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2299 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2300 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2301 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2302 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2303 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
Jim Laskeyef42a012006-11-02 20:12:39 +00002304
Jim Laskey44c3b9f2007-01-26 21:22:28 +00002305 const UniqueVector<std::string> &Directories = MMI->getDirectories();
Evan Cheng6547e402008-07-01 23:18:29 +00002306 const UniqueVector<SourceFileInfo> &SourceFiles = MMI->getSourceFiles();
Jim Laskeyef42a012006-11-02 20:12:39 +00002307
2308 // Emit directories.
2309 for (unsigned DirectoryID = 1, NDID = Directories.size();
2310 DirectoryID <= NDID; ++DirectoryID) {
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002311 Asm->EmitString(Directories[DirectoryID]); Asm->EOL("Directory");
Jim Laskeyef42a012006-11-02 20:12:39 +00002312 }
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002313 Asm->EmitInt8(0); Asm->EOL("End of directories");
Jim Laskeyef42a012006-11-02 20:12:39 +00002314
2315 // Emit files.
2316 for (unsigned SourceID = 1, NSID = SourceFiles.size();
2317 SourceID <= NSID; ++SourceID) {
2318 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002319 Asm->EmitString(SourceFile.getName());
2320 Asm->EOL("Source");
2321 Asm->EmitULEB128Bytes(SourceFile.getDirectoryID());
2322 Asm->EOL("Directory #");
2323 Asm->EmitULEB128Bytes(0);
2324 Asm->EOL("Mod date");
2325 Asm->EmitULEB128Bytes(0);
2326 Asm->EOL("File size");
Jim Laskeyef42a012006-11-02 20:12:39 +00002327 }
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002328 Asm->EmitInt8(0); Asm->EOL("End of files");
Jim Laskeyef42a012006-11-02 20:12:39 +00002329
2330 EmitLabel("line_prolog_end", 0);
2331
2332 // A sequence for each text section.
2333 for (unsigned j = 0, M = SectionSourceLines.size(); j < M; ++j) {
2334 // Isolate current sections line info.
2335 const std::vector<SourceLineInfo> &LineInfos = SectionSourceLines[j];
Evan Cheng6547e402008-07-01 23:18:29 +00002336
2337 if (VerboseAsm)
2338 Asm->EOL(std::string("Section ") + SectionMap[j + 1]);
2339 else
2340 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002341
2342 // Dwarf assumes we start with first line of first source file.
2343 unsigned Source = 1;
2344 unsigned Line = 1;
2345
2346 // Construct rows of the address, source, line, column matrix.
2347 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2348 const SourceLineInfo &LineInfo = LineInfos[i];
Jim Laskey44c3b9f2007-01-26 21:22:28 +00002349 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
Jim Laskey9d4209f2006-11-07 19:33:46 +00002350 if (!LabelID) continue;
Jim Laskeyef42a012006-11-02 20:12:39 +00002351
Jim Laskey1a4a83c2007-01-25 15:45:58 +00002352 unsigned SourceID = LineInfo.getSourceID();
2353 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
2354 unsigned DirectoryID = SourceFile.getDirectoryID();
Evan Cheng6547e402008-07-01 23:18:29 +00002355 if (VerboseAsm)
2356 Asm->EOL(Directories[DirectoryID]
2357 + SourceFile.getName()
2358 + ":"
2359 + utostr_32(LineInfo.getLine()));
2360 else
2361 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002362
2363 // Define the line address.
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002364 Asm->EmitInt8(0); Asm->EOL("Extended Op");
Dan Gohman82482942007-09-27 23:12:31 +00002365 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002366 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
Jim Laskeybacd3042007-02-21 22:48:45 +00002367 EmitReference("label", LabelID); Asm->EOL("Location label");
Jim Laskeyef42a012006-11-02 20:12:39 +00002368
2369 // If change of source, then switch to the new source.
2370 if (Source != LineInfo.getSourceID()) {
2371 Source = LineInfo.getSourceID();
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002372 Asm->EmitInt8(DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2373 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
Jim Laskeyef42a012006-11-02 20:12:39 +00002374 }
2375
2376 // If change of line.
2377 if (Line != LineInfo.getLine()) {
2378 // Determine offset.
2379 int Offset = LineInfo.getLine() - Line;
2380 int Delta = Offset - MinLineDelta;
2381
2382 // Update line.
2383 Line = LineInfo.getLine();
2384
2385 // If delta is small enough and in range...
2386 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2387 // ... then use fast opcode.
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002388 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
Jim Laskeyef42a012006-11-02 20:12:39 +00002389 } else {
2390 // ... otherwise use long hand.
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002391 Asm->EmitInt8(DW_LNS_advance_line); Asm->EOL("DW_LNS_advance_line");
2392 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2393 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
Jim Laskeyef42a012006-11-02 20:12:39 +00002394 }
2395 } else {
2396 // Copy the previous row (different address or source)
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002397 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
Jim Laskeyef42a012006-11-02 20:12:39 +00002398 }
2399 }
2400
2401 // Define last address of section.
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002402 Asm->EmitInt8(0); Asm->EOL("Extended Op");
Dan Gohman82482942007-09-27 23:12:31 +00002403 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002404 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2405 EmitReference("section_end", j + 1); Asm->EOL("Section end label");
Jim Laskeyef42a012006-11-02 20:12:39 +00002406
2407 // Mark end of matrix.
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002408 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
Jim Laskeybacd3042007-02-21 22:48:45 +00002409 Asm->EmitULEB128Bytes(1); Asm->EOL();
2410 Asm->EmitInt8(1); Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002411 }
2412
2413 EmitLabel("line_end", 0);
2414
Jim Laskeybacd3042007-02-21 22:48:45 +00002415 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002416 }
2417
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002418 /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
Jim Laskey65195462006-10-30 13:35:07 +00002419 ///
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002420 void EmitCommonDebugFrame() {
Anton Korobeynikov2a07e2f2007-05-05 09:04:50 +00002421 if (!TAI->doesDwarfRequireFrameSection())
Jim Laskeyef42a012006-11-02 20:12:39 +00002422 return;
2423
2424 int stackGrowth =
2425 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2426 TargetFrameInfo::StackGrowsUp ?
Dan Gohman82482942007-09-27 23:12:31 +00002427 TD->getPointerSize() : -TD->getPointerSize();
Jim Laskeyef42a012006-11-02 20:12:39 +00002428
2429 // Start the dwarf frame section.
2430 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2431
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002432 EmitLabel("debug_frame_common", 0);
2433 EmitDifference("debug_frame_common_end", 0,
2434 "debug_frame_common_begin", 0, true);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002435 Asm->EOL("Length of Common Information Entry");
Jim Laskeyef42a012006-11-02 20:12:39 +00002436
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002437 EmitLabel("debug_frame_common_begin", 0);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002438 Asm->EmitInt32((int)DW_CIE_ID);
2439 Asm->EOL("CIE Identifier Tag");
2440 Asm->EmitInt8(DW_CIE_VERSION);
2441 Asm->EOL("CIE Version");
2442 Asm->EmitString("");
2443 Asm->EOL("CIE Augmentation");
2444 Asm->EmitULEB128Bytes(1);
2445 Asm->EOL("CIE Code Alignment Factor");
2446 Asm->EmitSLEB128Bytes(stackGrowth);
2447 Asm->EOL("CIE Data Alignment Factor");
Dale Johannesenb97aec62007-11-13 19:13:01 +00002448 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002449 Asm->EOL("CIE RA Column");
Jim Laskey65195462006-10-30 13:35:07 +00002450
Jim Laskey5e73d5b2007-01-24 18:45:13 +00002451 std::vector<MachineMove> Moves;
Jim Laskeyef42a012006-11-02 20:12:39 +00002452 RI->getInitialFrameState(Moves);
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00002453
Dale Johannesenb97aec62007-11-13 19:13:01 +00002454 EmitFrameMoves(NULL, 0, Moves, false);
Jim Laskeyef42a012006-11-02 20:12:39 +00002455
Evan Cheng05548eb2008-02-29 19:36:59 +00002456 Asm->EmitAlignment(2, 0, 0, false);
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002457 EmitLabel("debug_frame_common_end", 0);
Jim Laskeyef42a012006-11-02 20:12:39 +00002458
Jim Laskeybacd3042007-02-21 22:48:45 +00002459 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002460 }
2461
Jim Laskey65195462006-10-30 13:35:07 +00002462 /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2463 /// section.
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002464 void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Anton Korobeynikov2a07e2f2007-05-05 09:04:50 +00002465 if (!TAI->doesDwarfRequireFrameSection())
Reid Spencer5a4951e2006-11-07 06:36:36 +00002466 return;
Jim Laskey9d4209f2006-11-07 19:33:46 +00002467
Jim Laskeyef42a012006-11-02 20:12:39 +00002468 // Start the dwarf frame section.
2469 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2470
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002471 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2472 "debug_frame_begin", DebugFrameInfo.Number, true);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002473 Asm->EOL("Length of Frame Information Entry");
Jim Laskeyef42a012006-11-02 20:12:39 +00002474
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002475 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
Anton Korobeynikova6199c82007-03-07 02:47:57 +00002476
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002477 EmitSectionOffset("debug_frame_common", "section_debug_frame",
2478 0, 0, true, false);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002479 Asm->EOL("FDE CIE offset");
Jim Laskey65195462006-10-30 13:35:07 +00002480
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002481 EmitReference("func_begin", DebugFrameInfo.Number);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002482 Asm->EOL("FDE initial location");
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002483 EmitDifference("func_end", DebugFrameInfo.Number,
2484 "func_begin", DebugFrameInfo.Number);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002485 Asm->EOL("FDE address range");
Jim Laskeyef42a012006-11-02 20:12:39 +00002486
Dale Johannesenb97aec62007-11-13 19:13:01 +00002487 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves, false);
Jim Laskeyef42a012006-11-02 20:12:39 +00002488
Evan Cheng05548eb2008-02-29 19:36:59 +00002489 Asm->EmitAlignment(2, 0, 0, false);
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002490 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
Jim Laskeyef42a012006-11-02 20:12:39 +00002491
Jim Laskeybacd3042007-02-21 22:48:45 +00002492 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002493 }
2494
2495 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
Jim Laskey65195462006-10-30 13:35:07 +00002496 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002497 void EmitDebugPubNames() {
2498 // Start the dwarf pubnames section.
2499 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2500
Jim Laskey5496f012006-11-09 14:52:14 +00002501 CompileUnit *Unit = GetBaseCompileUnit();
2502
2503 EmitDifference("pubnames_end", Unit->getID(),
Jim Laskey2b4e98c2006-12-06 17:43:18 +00002504 "pubnames_begin", Unit->getID(), true);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002505 Asm->EOL("Length of Public Names Info");
Jim Laskey5496f012006-11-09 14:52:14 +00002506
2507 EmitLabel("pubnames_begin", Unit->getID());
2508
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002509 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF Version");
Anton Korobeynikova6199c82007-03-07 02:47:57 +00002510
Anton Korobeynikov79dda2b2007-05-01 22:23:12 +00002511 EmitSectionOffset("info_begin", "section_info",
2512 Unit->getID(), 0, true, false);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002513 Asm->EOL("Offset of Compilation Unit Info");
Jim Laskeyef42a012006-11-02 20:12:39 +00002514
Jim Laskey2b4e98c2006-12-06 17:43:18 +00002515 EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(),true);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002516 Asm->EOL("Compilation Unit Length");
Jim Laskey5496f012006-11-09 14:52:14 +00002517
2518 std::map<std::string, DIE *> &Globals = Unit->getGlobals();
2519
2520 for (std::map<std::string, DIE *>::iterator GI = Globals.begin(),
2521 GE = Globals.end();
2522 GI != GE; ++GI) {
2523 const std::string &Name = GI->first;
2524 DIE * Entity = GI->second;
Jim Laskeyef42a012006-11-02 20:12:39 +00002525
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002526 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2527 Asm->EmitString(Name); Asm->EOL("External Name");
Jim Laskeyef42a012006-11-02 20:12:39 +00002528 }
Jim Laskey5496f012006-11-09 14:52:14 +00002529
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002530 Asm->EmitInt32(0); Asm->EOL("End Mark");
Jim Laskey5496f012006-11-09 14:52:14 +00002531 EmitLabel("pubnames_end", Unit->getID());
2532
Jim Laskeybacd3042007-02-21 22:48:45 +00002533 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002534 }
2535
2536 /// EmitDebugStr - Emit visible names into a debug str section.
Jim Laskey65195462006-10-30 13:35:07 +00002537 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002538 void EmitDebugStr() {
2539 // Check to see if it is worth the effort.
2540 if (!StringPool.empty()) {
2541 // Start the dwarf str section.
2542 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2543
2544 // For each of strings in the string pool.
2545 for (unsigned StringID = 1, N = StringPool.size();
2546 StringID <= N; ++StringID) {
2547 // Emit a label for reference from debug information entries.
2548 EmitLabel("string", StringID);
2549 // Emit the string itself.
2550 const std::string &String = StringPool[StringID];
Jim Laskeybacd3042007-02-21 22:48:45 +00002551 Asm->EmitString(String); Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002552 }
2553
Jim Laskeybacd3042007-02-21 22:48:45 +00002554 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002555 }
2556 }
2557
2558 /// EmitDebugLoc - Emit visible names into a debug loc section.
Jim Laskey65195462006-10-30 13:35:07 +00002559 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002560 void EmitDebugLoc() {
2561 // Start the dwarf loc section.
2562 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2563
Jim Laskeybacd3042007-02-21 22:48:45 +00002564 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002565 }
2566
2567 /// EmitDebugARanges - Emit visible names into a debug aranges section.
Jim Laskey65195462006-10-30 13:35:07 +00002568 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002569 void EmitDebugARanges() {
2570 // Start the dwarf aranges section.
2571 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2572
2573 // FIXME - Mock up
2574 #if 0
Jim Laskey5496f012006-11-09 14:52:14 +00002575 CompileUnit *Unit = GetBaseCompileUnit();
Jim Laskeyef42a012006-11-02 20:12:39 +00002576
Jim Laskey5496f012006-11-09 14:52:14 +00002577 // Don't include size of length
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002578 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
Jim Laskey5496f012006-11-09 14:52:14 +00002579
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002580 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("Dwarf Version");
Jim Laskey5496f012006-11-09 14:52:14 +00002581
2582 EmitReference("info_begin", Unit->getID());
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002583 Asm->EOL("Offset of Compilation Unit Info");
Jim Laskeyef42a012006-11-02 20:12:39 +00002584
Dan Gohman82482942007-09-27 23:12:31 +00002585 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
Jim Laskeyef42a012006-11-02 20:12:39 +00002586
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002587 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
Jim Laskeyef42a012006-11-02 20:12:39 +00002588
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002589 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
2590 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
Jim Laskeyef42a012006-11-02 20:12:39 +00002591
Jim Laskey5496f012006-11-09 14:52:14 +00002592 // Range 1
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002593 EmitReference("text_begin", 0); Asm->EOL("Address");
2594 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
Jim Laskeyef42a012006-11-02 20:12:39 +00002595
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002596 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2597 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
Dan Gohman44de9262007-09-24 21:36:21 +00002598 #endif
Jim Laskey5496f012006-11-09 14:52:14 +00002599
Jim Laskeybacd3042007-02-21 22:48:45 +00002600 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002601 }
2602
2603 /// EmitDebugRanges - Emit visible names into a debug ranges section.
Jim Laskey65195462006-10-30 13:35:07 +00002604 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002605 void EmitDebugRanges() {
2606 // Start the dwarf ranges section.
2607 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2608
Jim Laskeybacd3042007-02-21 22:48:45 +00002609 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002610 }
2611
2612 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
Jim Laskey65195462006-10-30 13:35:07 +00002613 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002614 void EmitDebugMacInfo() {
2615 // Start the dwarf macinfo section.
2616 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2617
Jim Laskeybacd3042007-02-21 22:48:45 +00002618 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002619 }
2620
Jim Laskey65195462006-10-30 13:35:07 +00002621 /// ConstructCompileUnitDIEs - Create a compile unit DIE for each source and
2622 /// header file.
Jim Laskeyef42a012006-11-02 20:12:39 +00002623 void ConstructCompileUnitDIEs() {
Jim Laskey44c3b9f2007-01-26 21:22:28 +00002624 const UniqueVector<CompileUnitDesc *> CUW = MMI->getCompileUnits();
Jim Laskeyef42a012006-11-02 20:12:39 +00002625
2626 for (unsigned i = 1, N = CUW.size(); i <= N; ++i) {
Jim Laskey44c3b9f2007-01-26 21:22:28 +00002627 unsigned ID = MMI->RecordSource(CUW[i]);
Jim Laskey9d4209f2006-11-07 19:33:46 +00002628 CompileUnit *Unit = NewCompileUnit(CUW[i], ID);
Jim Laskeyef42a012006-11-02 20:12:39 +00002629 CompileUnits.push_back(Unit);
2630 }
2631 }
2632
Jim Laskey65195462006-10-30 13:35:07 +00002633 /// ConstructGlobalDIEs - Create DIEs for each of the externally visible
2634 /// global variables.
Jim Laskeyef42a012006-11-02 20:12:39 +00002635 void ConstructGlobalDIEs() {
Bill Wendlingc04f4652008-07-03 23:13:02 +00002636 std::vector<GlobalVariableDesc *> GlobalVariables;
2637 MMI->getAnchoredDescriptors<GlobalVariableDesc>(*M, GlobalVariables);
Jim Laskeyef42a012006-11-02 20:12:39 +00002638
Bill Wendling10fff602008-07-03 22:53:42 +00002639 for (unsigned i = 0, N = GlobalVariables.size(); i < N; ++i) {
2640 GlobalVariableDesc *GVD = GlobalVariables[i];
2641 NewGlobalVariable(GVD);
2642 }
Jim Laskeyef42a012006-11-02 20:12:39 +00002643 }
Jim Laskey65195462006-10-30 13:35:07 +00002644
2645 /// ConstructSubprogramDIEs - Create DIEs for each of the externally visible
2646 /// subprograms.
Jim Laskeyef42a012006-11-02 20:12:39 +00002647 void ConstructSubprogramDIEs() {
Bill Wendlingc04f4652008-07-03 23:13:02 +00002648 std::vector<SubprogramDesc *> Subprograms;
2649 MMI->getAnchoredDescriptors<SubprogramDesc>(*M, Subprograms);
Jim Laskeyef42a012006-11-02 20:12:39 +00002650
Bill Wendling10fff602008-07-03 22:53:42 +00002651 for (unsigned i = 0, N = Subprograms.size(); i < N; ++i) {
2652 SubprogramDesc *SPD = Subprograms[i];
2653 NewSubprogram(SPD);
2654 }
Jim Laskeyef42a012006-11-02 20:12:39 +00002655 }
Jim Laskey65195462006-10-30 13:35:07 +00002656
Jim Laskey65195462006-10-30 13:35:07 +00002657public:
Jim Laskeyef42a012006-11-02 20:12:39 +00002658 //===--------------------------------------------------------------------===//
2659 // Main entry points.
2660 //
Jim Laskey072200c2007-01-29 18:51:14 +00002661 DwarfDebug(std::ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
Chris Lattner9251f132007-09-24 03:35:37 +00002662 : Dwarf(OS, A, T, "dbg")
Jim Laskeyef42a012006-11-02 20:12:39 +00002663 , CompileUnits()
2664 , AbbreviationsSet(InitAbbreviationsSetSize)
2665 , Abbreviations()
2666 , ValuesSet(InitValuesSetSize)
2667 , Values()
2668 , StringPool()
2669 , DescToUnitMap()
2670 , SectionMap()
2671 , SectionSourceLines()
Jim Laskeybacd3042007-02-21 22:48:45 +00002672 , didInitial(false)
2673 , shouldEmit(false)
Jim Laskeyef42a012006-11-02 20:12:39 +00002674 {
2675 }
Jim Laskey072200c2007-01-29 18:51:14 +00002676 virtual ~DwarfDebug() {
Jim Laskeyef42a012006-11-02 20:12:39 +00002677 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i)
2678 delete CompileUnits[i];
2679 for (unsigned j = 0, M = Values.size(); j < M; ++j)
2680 delete Values[j];
2681 }
2682
Jim Laskey44c3b9f2007-01-26 21:22:28 +00002683 /// SetModuleInfo - Set machine module information when it's known that pass
2684 /// manager has created it. Set by the target AsmPrinter.
2685 void SetModuleInfo(MachineModuleInfo *mmi) {
Jim Laskeyef42a012006-11-02 20:12:39 +00002686 // Make sure initial declarations are made.
Jim Laskey44c3b9f2007-01-26 21:22:28 +00002687 if (!MMI && mmi->hasDebugInfo()) {
2688 MMI = mmi;
Jim Laskeyef42a012006-11-02 20:12:39 +00002689 shouldEmit = true;
2690
Jim Laskeyef42a012006-11-02 20:12:39 +00002691 // Create all the compile unit DIEs.
2692 ConstructCompileUnitDIEs();
2693
2694 // Create DIEs for each of the externally visible global variables.
2695 ConstructGlobalDIEs();
Jim Laskey65195462006-10-30 13:35:07 +00002696
Jim Laskeyef42a012006-11-02 20:12:39 +00002697 // Create DIEs for each of the externally visible subprograms.
2698 ConstructSubprogramDIEs();
2699
2700 // Prime section data.
Jim Laskeyf910a3f2006-11-06 16:23:59 +00002701 SectionMap.insert(TAI->getTextSection());
Dan Gohmand57c3882007-10-01 22:40:20 +00002702
2703 // Print out .file directives to specify files for .loc directives. These
2704 // are printed out early so that they precede any .loc directives.
2705 if (TAI->hasDotLocAndDotFile()) {
2706 const UniqueVector<SourceFileInfo> &SourceFiles = MMI->getSourceFiles();
2707 const UniqueVector<std::string> &Directories = MMI->getDirectories();
2708 for (unsigned i = 1, e = SourceFiles.size(); i <= e; ++i) {
2709 sys::Path FullPath(Directories[SourceFiles[i].getDirectoryID()]);
2710 bool AppendOk = FullPath.appendComponent(SourceFiles[i].getName());
2711 assert(AppendOk && "Could not append filename to directory!");
2712 Asm->EmitFile(i, FullPath.toString());
2713 Asm->EOL();
2714 }
2715 }
2716
2717 // Emit initial sections
2718 EmitInitial();
Jim Laskeyef42a012006-11-02 20:12:39 +00002719 }
2720 }
2721
Jim Laskey65195462006-10-30 13:35:07 +00002722 /// BeginModule - Emit all Dwarf sections that should come prior to the
2723 /// content.
Jim Laskeyef42a012006-11-02 20:12:39 +00002724 void BeginModule(Module *M) {
2725 this->M = M;
Jim Laskeyef42a012006-11-02 20:12:39 +00002726 }
2727
Jim Laskey65195462006-10-30 13:35:07 +00002728 /// EndModule - Emit all Dwarf sections that should come after the content.
2729 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002730 void EndModule() {
2731 if (!ShouldEmitDwarf()) return;
Jim Laskeyef42a012006-11-02 20:12:39 +00002732
2733 // Standard sections final addresses.
2734 Asm->SwitchToTextSection(TAI->getTextSection());
2735 EmitLabel("text_end", 0);
2736 Asm->SwitchToDataSection(TAI->getDataSection());
2737 EmitLabel("data_end", 0);
2738
2739 // End text sections.
2740 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
2741 Asm->SwitchToTextSection(SectionMap[i].c_str());
2742 EmitLabel("section_end", i);
2743 }
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002744
2745 // Emit common frame information.
2746 EmitCommonDebugFrame();
2747
2748 // Emit function debug frame information
2749 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2750 E = DebugFrames.end(); I != E; ++I)
2751 EmitFunctionDebugFrame(*I);
2752
Jim Laskeyef42a012006-11-02 20:12:39 +00002753 // Compute DIE offsets and sizes.
2754 SizeAndOffsets();
2755
2756 // Emit all the DIEs into a debug info section
2757 EmitDebugInfo();
2758
2759 // Corresponding abbreviations into a abbrev section.
2760 EmitAbbreviations();
2761
2762 // Emit source line correspondence into a debug line section.
2763 EmitDebugLines();
2764
2765 // Emit info into a debug pubnames section.
2766 EmitDebugPubNames();
2767
2768 // Emit info into a debug str section.
2769 EmitDebugStr();
2770
2771 // Emit info into a debug loc section.
2772 EmitDebugLoc();
2773
2774 // Emit info into a debug aranges section.
2775 EmitDebugARanges();
2776
2777 // Emit info into a debug ranges section.
2778 EmitDebugRanges();
2779
2780 // Emit info into a debug macinfo section.
2781 EmitDebugMacInfo();
2782 }
2783
Jim Laskey65195462006-10-30 13:35:07 +00002784 /// BeginFunction - Gather pre-function debug information. Assumes being
2785 /// emitted immediately after the function entry point.
Jim Laskeyef42a012006-11-02 20:12:39 +00002786 void BeginFunction(MachineFunction *MF) {
2787 this->MF = MF;
2788
2789 if (!ShouldEmitDwarf()) return;
Jim Laskeyef42a012006-11-02 20:12:39 +00002790
2791 // Begin accumulating function debug information.
Jim Laskey44c3b9f2007-01-26 21:22:28 +00002792 MMI->BeginFunction(MF);
Jim Laskeyef42a012006-11-02 20:12:39 +00002793
2794 // Assumes in correct section after the entry point.
2795 EmitLabel("func_begin", ++SubprogramCount);
Evan Cheng1b08bbc2008-02-01 09:10:45 +00002796
2797 // Emit label for the implicitly defined dbg.stoppoint at the start of
2798 // the function.
Andrew Lenharth51dd8c92008-04-03 17:37:43 +00002799 const std::vector<SourceLineInfo> &LineInfos = MMI->getSourceLines();
2800 if (!LineInfos.empty()) {
2801 const SourceLineInfo &LineInfo = LineInfos[0];
2802 Asm->printLabel(LineInfo.getLabelID());
2803 }
Jim Laskeyef42a012006-11-02 20:12:39 +00002804 }
Jim Laskey072200c2007-01-29 18:51:14 +00002805
Jim Laskey65195462006-10-30 13:35:07 +00002806 /// EndFunction - Gather and emit post-function debug information.
2807 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002808 void EndFunction() {
2809 if (!ShouldEmitDwarf()) return;
Jim Laskeyb82313f2007-02-01 16:31:34 +00002810
2811 // Define end label for subprogram.
2812 EmitLabel("func_end", SubprogramCount);
Jim Laskeyef42a012006-11-02 20:12:39 +00002813
2814 // Get function line info.
Jim Laskey44c3b9f2007-01-26 21:22:28 +00002815 const std::vector<SourceLineInfo> &LineInfos = MMI->getSourceLines();
Jim Laskeyef42a012006-11-02 20:12:39 +00002816
2817 if (!LineInfos.empty()) {
2818 // Get section line info.
2819 unsigned ID = SectionMap.insert(Asm->CurrentSection);
2820 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2821 std::vector<SourceLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2822 // Append the function info to section info.
2823 SectionLineInfos.insert(SectionLineInfos.end(),
2824 LineInfos.begin(), LineInfos.end());
2825 }
2826
2827 // Construct scopes for subprogram.
Jim Laskey44c3b9f2007-01-26 21:22:28 +00002828 ConstructRootScope(MMI->getRootScope());
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002829
2830 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
2831 MMI->getFrameMoves()));
Jim Laskeyef42a012006-11-02 20:12:39 +00002832 }
Jim Laskey65195462006-10-30 13:35:07 +00002833};
2834
Jim Laskey072200c2007-01-29 18:51:14 +00002835//===----------------------------------------------------------------------===//
2836/// DwarfException - Emits Dwarf exception handling directives.
2837///
2838class DwarfException : public Dwarf {
2839
Jim Laskeyb82313f2007-02-01 16:31:34 +00002840private:
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00002841 struct FunctionEHFrameInfo {
2842 std::string FnName;
2843 unsigned Number;
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00002844 unsigned PersonalityIndex;
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00002845 bool hasCalls;
2846 bool hasLandingPads;
2847 std::vector<MachineMove> Moves;
Dale Johannesen48ae02f2008-01-16 19:59:28 +00002848 const Function * function;
Jim Laskeyb82313f2007-02-01 16:31:34 +00002849
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00002850 FunctionEHFrameInfo(const std::string &FN, unsigned Num, unsigned P,
2851 bool hC, bool hL,
Dale Johannesen1d4ce2a2007-11-20 23:24:42 +00002852 const std::vector<MachineMove> &M,
Dale Johannesen48ae02f2008-01-16 19:59:28 +00002853 const Function *f):
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00002854 FnName(FN), Number(Num), PersonalityIndex(P),
Dale Johannesen48ae02f2008-01-16 19:59:28 +00002855 hasCalls(hC), hasLandingPads(hL), Moves(M), function (f) { }
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00002856 };
2857
2858 std::vector<FunctionEHFrameInfo> EHFrames;
Dale Johannesen1532f3d2008-04-02 00:25:04 +00002859
2860 /// shouldEmitTable - Per-function flag to indicate if EH tables should
2861 /// be emitted.
2862 bool shouldEmitTable;
2863
2864 /// shouldEmitMoves - Per-function flag to indicate if frame moves info
2865 /// should be emitted.
2866 bool shouldEmitMoves;
2867
2868 /// shouldEmitTableModule - Per-module flag to indicate if EH tables
2869 /// should be emitted.
2870 bool shouldEmitTableModule;
2871
2872 /// shouldEmitFrameModule - Per-module flag to indicate if frame moves
2873 /// should be emitted.
2874 bool shouldEmitMovesModule;
Duncan Sands671fa972008-05-07 19:11:09 +00002875
Jim Laskey3f09fc22007-02-28 18:38:31 +00002876 /// EmitCommonEHFrame - Emit the common eh unwind frame.
2877 ///
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00002878 void EmitCommonEHFrame(const Function *Personality, unsigned Index) {
Jim Laskeybacd3042007-02-21 22:48:45 +00002879 // Size and sign of stack growth.
Jim Laskeyb82313f2007-02-01 16:31:34 +00002880 int stackGrowth =
2881 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2882 TargetFrameInfo::StackGrowsUp ?
Dan Gohman82482942007-09-27 23:12:31 +00002883 TD->getPointerSize() : -TD->getPointerSize();
Jim Laskeyb82313f2007-02-01 16:31:34 +00002884
Jim Laskeybacd3042007-02-21 22:48:45 +00002885 // Begin eh frame section.
Jim Laskeyb82313f2007-02-01 16:31:34 +00002886 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00002887 O << "EH_frame" << Index << ":\n";
2888 EmitLabel("section_eh_frame", Index);
Jim Laskeyb82313f2007-02-01 16:31:34 +00002889
Jim Laskeybacd3042007-02-21 22:48:45 +00002890 // Define base labels.
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00002891 EmitLabel("eh_frame_common", Index);
Duncan Sands671fa972008-05-07 19:11:09 +00002892
Jim Laskeybacd3042007-02-21 22:48:45 +00002893 // Define the eh frame length.
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00002894 EmitDifference("eh_frame_common_end", Index,
2895 "eh_frame_common_begin", Index, true);
Jim Laskeyb82313f2007-02-01 16:31:34 +00002896 Asm->EOL("Length of Common Information Entry");
2897
Jim Laskeybacd3042007-02-21 22:48:45 +00002898 // EH frame header.
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00002899 EmitLabel("eh_frame_common_begin", Index);
Jim Laskeyb82313f2007-02-01 16:31:34 +00002900 Asm->EmitInt32((int)0);
2901 Asm->EOL("CIE Identifier Tag");
2902 Asm->EmitInt8(DW_CIE_VERSION);
2903 Asm->EOL("CIE Version");
Duncan Sands671fa972008-05-07 19:11:09 +00002904
Jim Laskeybacd3042007-02-21 22:48:45 +00002905 // The personality presence indicates that language specific information
2906 // will show up in the eh frame.
2907 Asm->EmitString(Personality ? "zPLR" : "zR");
Jim Laskeyb82313f2007-02-01 16:31:34 +00002908 Asm->EOL("CIE Augmentation");
Duncan Sands671fa972008-05-07 19:11:09 +00002909
Jim Laskeybacd3042007-02-21 22:48:45 +00002910 // Round out reader.
Jim Laskeyb82313f2007-02-01 16:31:34 +00002911 Asm->EmitULEB128Bytes(1);
2912 Asm->EOL("CIE Code Alignment Factor");
2913 Asm->EmitSLEB128Bytes(stackGrowth);
Duncan Sands671fa972008-05-07 19:11:09 +00002914 Asm->EOL("CIE Data Alignment Factor");
Dale Johannesenb97aec62007-11-13 19:13:01 +00002915 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), true));
Duncan Sands671fa972008-05-07 19:11:09 +00002916 Asm->EOL("CIE Return Address Column");
2917
Jim Laskeybacd3042007-02-21 22:48:45 +00002918 // If there is a personality, we need to indicate the functions location.
2919 if (Personality) {
2920 Asm->EmitULEB128Bytes(7);
2921 Asm->EOL("Augmentation Size");
Bill Wendlingef4a6612007-09-11 17:20:55 +00002922
Duncan Sands671fa972008-05-07 19:11:09 +00002923 if (TAI->getNeedsIndirectEncoding()) {
Bill Wendlingef4a6612007-09-11 17:20:55 +00002924 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4 | DW_EH_PE_indirect);
Duncan Sands671fa972008-05-07 19:11:09 +00002925 Asm->EOL("Personality (pcrel sdata4 indirect)");
2926 } else {
Bill Wendlingef4a6612007-09-11 17:20:55 +00002927 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
Duncan Sands671fa972008-05-07 19:11:09 +00002928 Asm->EOL("Personality (pcrel sdata4)");
2929 }
Bill Wendlingef4a6612007-09-11 17:20:55 +00002930
Duncan Sands671fa972008-05-07 19:11:09 +00002931 PrintRelDirective(true);
Bill Wendlingd60da492007-09-11 08:27:17 +00002932 O << TAI->getPersonalityPrefix();
2933 Asm->EmitExternalGlobal((const GlobalVariable *)(Personality));
2934 O << TAI->getPersonalitySuffix();
Duncan Sands43b30a82008-05-08 12:33:11 +00002935 if (strcmp(TAI->getPersonalitySuffix(), "+4@GOTPCREL"))
2936 O << "-" << TAI->getPCSymbol();
Bill Wendlingd60da492007-09-11 08:27:17 +00002937 Asm->EOL("Personality");
Bill Wendlingcf4bb312007-08-25 00:51:55 +00002938
Duncan Sands671fa972008-05-07 19:11:09 +00002939 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
2940 Asm->EOL("LSDA Encoding (pcrel sdata4)");
2941 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
2942 Asm->EOL("FDE Encoding (pcrel sdata4)");
Jim Laskeybacd3042007-02-21 22:48:45 +00002943 } else {
2944 Asm->EmitULEB128Bytes(1);
2945 Asm->EOL("Augmentation Size");
Duncan Sands671fa972008-05-07 19:11:09 +00002946 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
2947 Asm->EOL("FDE Encoding (pcrel sdata4)");
Jim Laskeybacd3042007-02-21 22:48:45 +00002948 }
2949
2950 // Indicate locations of general callee saved registers in frame.
Jim Laskeyb82313f2007-02-01 16:31:34 +00002951 std::vector<MachineMove> Moves;
2952 RI->getInitialFrameState(Moves);
Dale Johannesenb97aec62007-11-13 19:13:01 +00002953 EmitFrameMoves(NULL, 0, Moves, true);
Jim Laskeyb82313f2007-02-01 16:31:34 +00002954
Dale Johannesen21d972a2008-04-30 00:43:29 +00002955 // On Darwin the linker honors the alignment of eh_frame, which means it
2956 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
2957 // you get holes which confuse readers of eh_frame.
Dale Johannesen7b251e02008-04-29 22:58:20 +00002958 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
2959 0, 0, false);
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00002960 EmitLabel("eh_frame_common_end", Index);
Duncan Sands671fa972008-05-07 19:11:09 +00002961
Jim Laskeybacd3042007-02-21 22:48:45 +00002962 Asm->EOL();
Jim Laskeyb82313f2007-02-01 16:31:34 +00002963 }
Duncan Sands671fa972008-05-07 19:11:09 +00002964
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00002965 /// EmitEHFrame - Emit function exception frame information.
Jim Laskeyb82313f2007-02-01 16:31:34 +00002966 ///
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00002967 void EmitEHFrame(const FunctionEHFrameInfo &EHFrameInfo) {
Dale Johannesen48ae02f2008-01-16 19:59:28 +00002968 Function::LinkageTypes linkage = EHFrameInfo.function->getLinkage();
2969
Jim Laskeybacd3042007-02-21 22:48:45 +00002970 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
2971
2972 // Externally visible entry into the functions eh frame info.
Dale Johannesen1d4ce2a2007-11-20 23:24:42 +00002973 // If the corresponding function is static, this should not be
2974 // externally visible.
Dale Johannesen48ae02f2008-01-16 19:59:28 +00002975 if (linkage != Function::InternalLinkage) {
Dale Johannesen1d4ce2a2007-11-20 23:24:42 +00002976 if (const char *GlobalEHDirective = TAI->getGlobalEHDirective())
2977 O << GlobalEHDirective << EHFrameInfo.FnName << "\n";
2978 }
2979
Dale Johannesen038129d2008-01-10 02:03:30 +00002980 // If corresponding function is weak definition, this should be too.
Dale Johannesen48ae02f2008-01-16 19:59:28 +00002981 if ((linkage == Function::WeakLinkage ||
2982 linkage == Function::LinkOnceLinkage) &&
Dale Johannesen038129d2008-01-10 02:03:30 +00002983 TAI->getWeakDefDirective())
2984 O << TAI->getWeakDefDirective() << EHFrameInfo.FnName << "\n";
2985
2986 // If there are no calls then you can't unwind. This may mean we can
2987 // omit the EH Frame, but some environments do not handle weak absolute
Dale Johannesen4e1b7942008-04-08 00:10:24 +00002988 // symbols.
Dale Johannesen3541af72008-04-14 17:54:17 +00002989 // If UnwindTablesMandatory is set we cannot do this optimization; the
Dale Johannesen4e1b7942008-04-08 00:10:24 +00002990 // unwind info is to be available for non-EH uses.
Dale Johannesen038129d2008-01-10 02:03:30 +00002991 if (!EHFrameInfo.hasCalls &&
Dale Johannesen3541af72008-04-14 17:54:17 +00002992 !UnwindTablesMandatory &&
Dale Johannesen48ae02f2008-01-16 19:59:28 +00002993 ((linkage != Function::WeakLinkage &&
2994 linkage != Function::LinkOnceLinkage) ||
Dale Johannesen038129d2008-01-10 02:03:30 +00002995 !TAI->getWeakDefDirective() ||
2996 TAI->getSupportsWeakOmittedEHFrame()))
2997 {
Bill Wendling6e198962007-09-18 01:47:22 +00002998 O << EHFrameInfo.FnName << " = 0\n";
Dale Johannesen48ae02f2008-01-16 19:59:28 +00002999 // This name has no connection to the function, so it might get
3000 // dead-stripped when the function is not, erroneously. Prohibit
3001 // dead-stripping unconditionally.
3002 if (const char *UsedDirective = TAI->getUsedDirective())
3003 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
Jim Laskeybacd3042007-02-21 22:48:45 +00003004 } else {
Bill Wendling6e198962007-09-18 01:47:22 +00003005 O << EHFrameInfo.FnName << ":\n";
Dale Johannesen1d4ce2a2007-11-20 23:24:42 +00003006
Jim Laskeybacd3042007-02-21 22:48:45 +00003007 // EH frame header.
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003008 EmitDifference("eh_frame_end", EHFrameInfo.Number,
3009 "eh_frame_begin", EHFrameInfo.Number, true);
Jim Laskeybacd3042007-02-21 22:48:45 +00003010 Asm->EOL("Length of Frame Information Entry");
3011
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003012 EmitLabel("eh_frame_begin", EHFrameInfo.Number);
Anton Korobeynikova6199c82007-03-07 02:47:57 +00003013
Anton Korobeynikov070280e2007-05-23 11:08:31 +00003014 EmitSectionOffset("eh_frame_begin", "eh_frame_common",
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00003015 EHFrameInfo.Number, EHFrameInfo.PersonalityIndex,
Dale Johannesend9ffd4c2008-03-26 23:31:39 +00003016 true, true, false);
Jim Laskeybacd3042007-02-21 22:48:45 +00003017 Asm->EOL("FDE CIE offset");
3018
Duncan Sands671fa972008-05-07 19:11:09 +00003019 EmitReference("eh_func_begin", EHFrameInfo.Number, true, true);
Jim Laskeybacd3042007-02-21 22:48:45 +00003020 Asm->EOL("FDE initial location");
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003021 EmitDifference("eh_func_end", EHFrameInfo.Number,
Duncan Sands671fa972008-05-07 19:11:09 +00003022 "eh_func_begin", EHFrameInfo.Number, true);
Jim Laskeybacd3042007-02-21 22:48:45 +00003023 Asm->EOL("FDE address range");
Duncan Sands671fa972008-05-07 19:11:09 +00003024
Jim Laskey3f09fc22007-02-28 18:38:31 +00003025 // If there is a personality and landing pads then point to the language
3026 // specific data area in the exception table.
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00003027 if (EHFrameInfo.PersonalityIndex) {
Duncan Sands671fa972008-05-07 19:11:09 +00003028 Asm->EmitULEB128Bytes(4);
Jim Laskeybacd3042007-02-21 22:48:45 +00003029 Asm->EOL("Augmentation size");
Duncan Sands671fa972008-05-07 19:11:09 +00003030
3031 if (EHFrameInfo.hasLandingPads)
3032 EmitReference("exception", EHFrameInfo.Number, true, true);
3033 else
Jim Laskey3f09fc22007-02-28 18:38:31 +00003034 Asm->EmitInt32((int)0);
Jim Laskeybacd3042007-02-21 22:48:45 +00003035 Asm->EOL("Language Specific Data Area");
3036 } else {
3037 Asm->EmitULEB128Bytes(0);
3038 Asm->EOL("Augmentation size");
3039 }
Duncan Sands671fa972008-05-07 19:11:09 +00003040
Jim Laskeybacd3042007-02-21 22:48:45 +00003041 // Indicate locations of function specific callee saved registers in
3042 // frame.
Dale Johannesenb97aec62007-11-13 19:13:01 +00003043 EmitFrameMoves("eh_func_begin", EHFrameInfo.Number, EHFrameInfo.Moves, true);
Jim Laskeybacd3042007-02-21 22:48:45 +00003044
Dale Johannesen21d972a2008-04-30 00:43:29 +00003045 // On Darwin the linker honors the alignment of eh_frame, which means it
3046 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3047 // you get holes which confuse readers of eh_frame.
Dale Johannesen7b251e02008-04-29 22:58:20 +00003048 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
3049 0, 0, false);
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003050 EmitLabel("eh_frame_end", EHFrameInfo.Number);
Jim Laskeyb82313f2007-02-01 16:31:34 +00003051
Dale Johannesen48ae02f2008-01-16 19:59:28 +00003052 // If the function is marked used, this table should be also. We cannot
3053 // make the mark unconditional in this case, since retaining the table
3054 // also retains the function in this case, and there is code around
3055 // that depends on unused functions (calling undefined externals) being
3056 // dead-stripped to link correctly. Yes, there really is.
3057 if (MMI->getUsedFunctions().count(EHFrameInfo.function))
3058 if (const char *UsedDirective = TAI->getUsedDirective())
3059 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3060 }
Jim Laskeybacd3042007-02-21 22:48:45 +00003061 }
Duncan Sands7bf7a442007-05-21 18:50:28 +00003062
Duncan Sands57810cd2007-09-05 11:27:52 +00003063 /// EmitExceptionTable - Emit landing pads and actions.
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003064 ///
3065 /// The general organization of the table is complex, but the basic concepts
3066 /// are easy. First there is a header which describes the location and
3067 /// organization of the three components that follow.
3068 /// 1. The landing pad site information describes the range of code covered
3069 /// by the try. In our case it's an accumulation of the ranges covered
3070 /// by the invokes in the try. There is also a reference to the landing
3071 /// pad that handles the exception once processed. Finally an index into
3072 /// the actions table.
3073 /// 2. The action table, in our case, is composed of pairs of type ids
3074 /// and next action offset. Starting with the action index from the
3075 /// landing pad site, each type Id is checked for a match to the current
3076 /// exception. If it matches then the exception and type id are passed
3077 /// on to the landing pad. Otherwise the next action is looked up. This
3078 /// chain is terminated with a next action of zero. If no type id is
3079 /// found the the frame is unwound and handling continues.
3080 /// 3. Type id table contains references to all the C++ typeinfo for all
3081 /// catches in the function. This tables is reversed indexed base 1.
3082
Duncan Sandsb32edb42007-06-06 15:37:31 +00003083 /// SharedTypeIds - How many leading type ids two landing pads have in common.
3084 static unsigned SharedTypeIds(const LandingPadInfo *L,
3085 const LandingPadInfo *R) {
3086 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003087 unsigned LSize = LIds.size(), RSize = RIds.size();
Duncan Sandsb32edb42007-06-06 15:37:31 +00003088 unsigned MinSize = LSize < RSize ? LSize : RSize;
3089 unsigned Count = 0;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003090
Duncan Sandsb32edb42007-06-06 15:37:31 +00003091 for (; Count != MinSize; ++Count)
3092 if (LIds[Count] != RIds[Count])
3093 return Count;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003094
Duncan Sandsb32edb42007-06-06 15:37:31 +00003095 return Count;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003096 }
3097
Duncan Sandsb32edb42007-06-06 15:37:31 +00003098 /// PadLT - Order landing pads lexicographically by type id.
Duncan Sands7bf7a442007-05-21 18:50:28 +00003099 static bool PadLT(const LandingPadInfo *L, const LandingPadInfo *R) {
Duncan Sandsb32edb42007-06-06 15:37:31 +00003100 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003101 unsigned LSize = LIds.size(), RSize = RIds.size();
Duncan Sandsb32edb42007-06-06 15:37:31 +00003102 unsigned MinSize = LSize < RSize ? LSize : RSize;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003103
Duncan Sandsb32edb42007-06-06 15:37:31 +00003104 for (unsigned i = 0; i != MinSize; ++i)
Duncan Sands7bf7a442007-05-21 18:50:28 +00003105 if (LIds[i] != RIds[i])
3106 return LIds[i] < RIds[i];
3107
Duncan Sandsb32edb42007-06-06 15:37:31 +00003108 return LSize < RSize;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003109 }
3110
Duncan Sands53c3a332007-05-16 12:12:23 +00003111 struct KeyInfo {
3112 static inline unsigned getEmptyKey() { return -1U; }
3113 static inline unsigned getTombstoneKey() { return -2U; }
3114 static unsigned getHashValue(const unsigned &Key) { return Key; }
Chris Lattner76c1b972007-09-17 18:34:04 +00003115 static bool isEqual(unsigned LHS, unsigned RHS) { return LHS == RHS; }
Duncan Sands53c3a332007-05-16 12:12:23 +00003116 static bool isPod() { return true; }
3117 };
3118
Duncan Sands57810cd2007-09-05 11:27:52 +00003119 /// ActionEntry - Structure describing an entry in the actions table.
Duncan Sandsb32edb42007-06-06 15:37:31 +00003120 struct ActionEntry {
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003121 int ValueForTypeID; // The value to write - may not be equal to the type id.
Duncan Sandsb32edb42007-06-06 15:37:31 +00003122 int NextAction;
3123 struct ActionEntry *Previous;
3124 };
3125
Duncan Sands57810cd2007-09-05 11:27:52 +00003126 /// PadRange - Structure holding a try-range and the associated landing pad.
3127 struct PadRange {
3128 // The index of the landing pad.
3129 unsigned PadIndex;
3130 // The index of the begin and end labels in the landing pad's label lists.
3131 unsigned RangeIndex;
3132 };
3133
3134 typedef DenseMap<unsigned, PadRange, KeyInfo> RangeMapType;
3135
3136 /// CallSiteEntry - Structure describing an entry in the call-site table.
3137 struct CallSiteEntry {
Duncan Sands481dc722007-12-19 07:36:31 +00003138 // The 'try-range' is BeginLabel .. EndLabel.
Duncan Sands57810cd2007-09-05 11:27:52 +00003139 unsigned BeginLabel; // zero indicates the start of the function.
3140 unsigned EndLabel; // zero indicates the end of the function.
Duncan Sands481dc722007-12-19 07:36:31 +00003141 // The landing pad starts at PadLabel.
Duncan Sands57810cd2007-09-05 11:27:52 +00003142 unsigned PadLabel; // zero indicates that there is no landing pad.
3143 unsigned Action;
3144 };
3145
Jim Laskeybacd3042007-02-21 22:48:45 +00003146 void EmitExceptionTable() {
Jim Laskeybacd3042007-02-21 22:48:45 +00003147 const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
Duncan Sands73ef58a2007-06-02 16:53:42 +00003148 const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
Duncan Sands7bf7a442007-05-21 18:50:28 +00003149 const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
3150 if (PadInfos.empty()) return;
3151
3152 // Sort the landing pads in order of their type ids. This is used to fold
3153 // duplicate actions.
Duncan Sands6cc76082007-06-08 08:59:11 +00003154 SmallVector<const LandingPadInfo *, 64> LandingPads;
Duncan Sands6cc76082007-06-08 08:59:11 +00003155 LandingPads.reserve(PadInfos.size());
Duncan Sands7bf7a442007-05-21 18:50:28 +00003156 for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
Duncan Sands6cc76082007-06-08 08:59:11 +00003157 LandingPads.push_back(&PadInfos[i]);
Duncan Sands7bf7a442007-05-21 18:50:28 +00003158 std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
3159
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003160 // Negative type ids index into FilterIds, positive type ids index into
3161 // TypeInfos. The value written for a positive type id is just the type
3162 // id itself. For a negative type id, however, the value written is the
3163 // (negative) byte offset of the corresponding FilterIds entry. The byte
3164 // offset is usually equal to the type id, because the FilterIds entries
3165 // are written using a variable width encoding which outputs one byte per
3166 // entry as long as the value written is not too large, but can differ.
3167 // This kind of complication does not occur for positive type ids because
3168 // type infos are output using a fixed width encoding.
3169 // FilterOffsets[i] holds the byte offset corresponding to FilterIds[i].
3170 SmallVector<int, 16> FilterOffsets;
3171 FilterOffsets.reserve(FilterIds.size());
3172 int Offset = -1;
3173 for(std::vector<unsigned>::const_iterator I = FilterIds.begin(),
3174 E = FilterIds.end(); I != E; ++I) {
3175 FilterOffsets.push_back(Offset);
Duncan Sandsbb821dd2007-07-12 13:51:39 +00003176 Offset -= Asm->SizeULEB128(*I);
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003177 }
3178
Duncan Sands57810cd2007-09-05 11:27:52 +00003179 // Compute the actions table and gather the first action index for each
3180 // landing pad site.
3181 SmallVector<ActionEntry, 32> Actions;
3182 SmallVector<unsigned, 64> FirstActions;
3183 FirstActions.reserve(LandingPads.size());
Jim Laskeybacd3042007-02-21 22:48:45 +00003184
Duncan Sandsb32edb42007-06-06 15:37:31 +00003185 int FirstAction = 0;
Duncan Sands57810cd2007-09-05 11:27:52 +00003186 unsigned SizeActions = 0;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003187 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
Duncan Sandsb32edb42007-06-06 15:37:31 +00003188 const LandingPadInfo *LP = LandingPads[i];
3189 const std::vector<int> &TypeIds = LP->TypeIds;
3190 const unsigned NumShared = i ? SharedTypeIds(LP, LandingPads[i-1]) : 0;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003191 unsigned SizeSiteActions = 0;
3192
Duncan Sandsb32edb42007-06-06 15:37:31 +00003193 if (NumShared < TypeIds.size()) {
Duncan Sands7bf7a442007-05-21 18:50:28 +00003194 unsigned SizeAction = 0;
Duncan Sandsb32edb42007-06-06 15:37:31 +00003195 ActionEntry *PrevAction = 0;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003196
Duncan Sandsb32edb42007-06-06 15:37:31 +00003197 if (NumShared) {
3198 const unsigned SizePrevIds = LandingPads[i-1]->TypeIds.size();
3199 assert(Actions.size());
3200 PrevAction = &Actions.back();
3201 SizeAction = Asm->SizeSLEB128(PrevAction->NextAction) +
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003202 Asm->SizeSLEB128(PrevAction->ValueForTypeID);
Duncan Sandsb32edb42007-06-06 15:37:31 +00003203 for (unsigned j = NumShared; j != SizePrevIds; ++j) {
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003204 SizeAction -= Asm->SizeSLEB128(PrevAction->ValueForTypeID);
Duncan Sandsb32edb42007-06-06 15:37:31 +00003205 SizeAction += -PrevAction->NextAction;
3206 PrevAction = PrevAction->Previous;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003207 }
Anton Korobeynikoveeb37e02007-05-10 22:34:59 +00003208 }
Duncan Sands7bf7a442007-05-21 18:50:28 +00003209
Duncan Sandsb32edb42007-06-06 15:37:31 +00003210 // Compute the actions.
3211 for (unsigned I = NumShared, M = TypeIds.size(); I != M; ++I) {
3212 int TypeID = TypeIds[I];
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003213 assert(-1-TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
3214 int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
3215 unsigned SizeTypeID = Asm->SizeSLEB128(ValueForTypeID);
Duncan Sandsb32edb42007-06-06 15:37:31 +00003216
3217 int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
3218 SizeAction = SizeTypeID + Asm->SizeSLEB128(NextAction);
3219 SizeSiteActions += SizeAction;
3220
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003221 ActionEntry Action = {ValueForTypeID, NextAction, PrevAction};
Duncan Sandsb32edb42007-06-06 15:37:31 +00003222 Actions.push_back(Action);
3223
3224 PrevAction = &Actions.back();
3225 }
3226
3227 // Record the first action of the landing pad site.
3228 FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
3229 } // else identical - re-use previous FirstAction
3230
3231 FirstActions.push_back(FirstAction);
Duncan Sands7bf7a442007-05-21 18:50:28 +00003232
Anton Korobeynikov29c9caf2007-05-11 08:23:57 +00003233 // Compute this sites contribution to size.
Anton Korobeynikov22d5c372007-05-11 08:47:35 +00003234 SizeActions += SizeSiteActions;
Jim Laskeybacd3042007-02-21 22:48:45 +00003235 }
Duncan Sands57810cd2007-09-05 11:27:52 +00003236
Duncan Sands481dc722007-12-19 07:36:31 +00003237 // Compute the call-site table. The entry for an invoke has a try-range
3238 // containing the call, a non-zero landing pad and an appropriate action.
3239 // The entry for an ordinary call has a try-range containing the call and
3240 // zero for the landing pad and the action. Calls marked 'nounwind' have
3241 // no entry and must not be contained in the try-range of any entry - they
3242 // form gaps in the table. Entries must be ordered by try-range address.
Duncan Sands57810cd2007-09-05 11:27:52 +00003243 SmallVector<CallSiteEntry, 64> CallSites;
3244
3245 RangeMapType PadMap;
Duncan Sands481dc722007-12-19 07:36:31 +00003246 // Invokes and nounwind calls have entries in PadMap (due to being bracketed
3247 // by try-range labels when lowered). Ordinary calls do not, so appropriate
3248 // try-ranges for them need be deduced.
Duncan Sands57810cd2007-09-05 11:27:52 +00003249 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3250 const LandingPadInfo *LandingPad = LandingPads[i];
Duncan Sands481dc722007-12-19 07:36:31 +00003251 for (unsigned j = 0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
Duncan Sands57810cd2007-09-05 11:27:52 +00003252 unsigned BeginLabel = LandingPad->BeginLabels[j];
3253 assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
3254 PadRange P = { i, j };
3255 PadMap[BeginLabel] = P;
3256 }
3257 }
3258
Duncan Sands481dc722007-12-19 07:36:31 +00003259 // The end label of the previous invoke or nounwind try-range.
Duncan Sands57810cd2007-09-05 11:27:52 +00003260 unsigned LastLabel = 0;
Duncan Sands481dc722007-12-19 07:36:31 +00003261
3262 // Whether there is a potentially throwing instruction (currently this means
3263 // an ordinary call) between the end of the previous try-range and now.
3264 bool SawPotentiallyThrowing = false;
3265
3266 // Whether the last callsite entry was for an invoke.
3267 bool PreviousIsInvoke = false;
3268
Duncan Sands481dc722007-12-19 07:36:31 +00003269 // Visit all instructions in order of address.
Duncan Sands57810cd2007-09-05 11:27:52 +00003270 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
3271 I != E; ++I) {
3272 for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
3273 MI != E; ++MI) {
Dan Gohman44066042008-07-01 00:05:16 +00003274 if (!MI->isLabel()) {
Chris Lattner749c6f62008-01-07 07:27:27 +00003275 SawPotentiallyThrowing |= MI->getDesc().isCall();
Duncan Sands57810cd2007-09-05 11:27:52 +00003276 continue;
3277 }
3278
Chris Lattner9e330492007-12-30 20:50:28 +00003279 unsigned BeginLabel = MI->getOperand(0).getImm();
Duncan Sands57810cd2007-09-05 11:27:52 +00003280 assert(BeginLabel && "Invalid label!");
Duncan Sands98865042007-09-05 14:12:46 +00003281
Duncan Sands481dc722007-12-19 07:36:31 +00003282 // End of the previous try-range?
Duncan Sands98865042007-09-05 14:12:46 +00003283 if (BeginLabel == LastLabel)
Duncan Sands481dc722007-12-19 07:36:31 +00003284 SawPotentiallyThrowing = false;
Duncan Sands57810cd2007-09-05 11:27:52 +00003285
Duncan Sands481dc722007-12-19 07:36:31 +00003286 // Beginning of a new try-range?
Duncan Sands57810cd2007-09-05 11:27:52 +00003287 RangeMapType::iterator L = PadMap.find(BeginLabel);
Duncan Sands57810cd2007-09-05 11:27:52 +00003288 if (L == PadMap.end())
Duncan Sands481dc722007-12-19 07:36:31 +00003289 // Nope, it was just some random label.
Duncan Sands57810cd2007-09-05 11:27:52 +00003290 continue;
3291
3292 PadRange P = L->second;
3293 const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
3294
3295 assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
3296 "Inconsistent landing pad map!");
3297
3298 // If some instruction between the previous try-range and this one may
3299 // throw, create a call-site entry with no landing pad for the region
3300 // between the try-ranges.
Duncan Sands481dc722007-12-19 07:36:31 +00003301 if (SawPotentiallyThrowing) {
Duncan Sands57810cd2007-09-05 11:27:52 +00003302 CallSiteEntry Site = {LastLabel, BeginLabel, 0, 0};
3303 CallSites.push_back(Site);
Duncan Sands481dc722007-12-19 07:36:31 +00003304 PreviousIsInvoke = false;
Duncan Sands57810cd2007-09-05 11:27:52 +00003305 }
3306
3307 LastLabel = LandingPad->EndLabels[P.RangeIndex];
Duncan Sands481dc722007-12-19 07:36:31 +00003308 assert(BeginLabel && LastLabel && "Invalid landing pad!");
Duncan Sands57810cd2007-09-05 11:27:52 +00003309
Duncan Sands481dc722007-12-19 07:36:31 +00003310 if (LandingPad->LandingPadLabel) {
3311 // This try-range is for an invoke.
3312 CallSiteEntry Site = {BeginLabel, LastLabel,
3313 LandingPad->LandingPadLabel, FirstActions[P.PadIndex]};
Duncan Sands57810cd2007-09-05 11:27:52 +00003314
Duncan Sands481dc722007-12-19 07:36:31 +00003315 // Try to merge with the previous call-site.
3316 if (PreviousIsInvoke) {
Dan Gohman719de532008-06-21 22:00:54 +00003317 CallSiteEntry &Prev = CallSites.back();
Duncan Sands481dc722007-12-19 07:36:31 +00003318 if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
3319 // Extend the range of the previous entry.
3320 Prev.EndLabel = Site.EndLabel;
3321 continue;
3322 }
Duncan Sands57810cd2007-09-05 11:27:52 +00003323 }
Duncan Sands57810cd2007-09-05 11:27:52 +00003324
Duncan Sands481dc722007-12-19 07:36:31 +00003325 // Otherwise, create a new call-site.
3326 CallSites.push_back(Site);
3327 PreviousIsInvoke = true;
3328 } else {
3329 // Create a gap.
3330 PreviousIsInvoke = false;
3331 }
Duncan Sands57810cd2007-09-05 11:27:52 +00003332 }
3333 }
3334 // If some instruction between the previous try-range and the end of the
3335 // function may throw, create a call-site entry with no landing pad for the
3336 // region following the try-range.
Duncan Sands481dc722007-12-19 07:36:31 +00003337 if (SawPotentiallyThrowing) {
Duncan Sands57810cd2007-09-05 11:27:52 +00003338 CallSiteEntry Site = {LastLabel, 0, 0, 0};
3339 CallSites.push_back(Site);
3340 }
3341
Jim Laskeybacd3042007-02-21 22:48:45 +00003342 // Final tallies.
Duncan Sands671fa972008-05-07 19:11:09 +00003343
3344 // Call sites.
3345 const unsigned SiteStartSize = sizeof(int32_t); // DW_EH_PE_udata4
3346 const unsigned SiteLengthSize = sizeof(int32_t); // DW_EH_PE_udata4
3347 const unsigned LandingPadSize = sizeof(int32_t); // DW_EH_PE_udata4
3348 unsigned SizeSites = CallSites.size() * (SiteStartSize +
3349 SiteLengthSize +
3350 LandingPadSize);
Duncan Sands57810cd2007-09-05 11:27:52 +00003351 for (unsigned i = 0, e = CallSites.size(); i < e; ++i)
3352 SizeSites += Asm->SizeULEB128(CallSites[i].Action);
3353
Duncan Sands671fa972008-05-07 19:11:09 +00003354 // Type infos.
3355 const unsigned TypeInfoSize = TD->getPointerSize(); // DW_EH_PE_absptr
3356 unsigned SizeTypes = TypeInfos.size() * TypeInfoSize;
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003357
3358 unsigned TypeOffset = sizeof(int8_t) + // Call site format
3359 Asm->SizeULEB128(SizeSites) + // Call-site table length
3360 SizeSites + SizeActions + SizeTypes;
3361
3362 unsigned TotalSize = sizeof(int8_t) + // LPStart format
3363 sizeof(int8_t) + // TType format
3364 Asm->SizeULEB128(TypeOffset) + // TType base offset
3365 TypeOffset;
3366
3367 unsigned SizeAlign = (4 - TotalSize) & 3;
Duncan Sandsc1fe1662007-05-10 18:40:24 +00003368
Jim Laskeybacd3042007-02-21 22:48:45 +00003369 // Begin the exception table.
3370 Asm->SwitchToDataSection(TAI->getDwarfExceptionSection());
3371 O << "GCC_except_table" << SubprogramCount << ":\n";
Evan Cheng05548eb2008-02-29 19:36:59 +00003372 Asm->EmitAlignment(2, 0, 0, false);
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003373 for (unsigned i = 0; i != SizeAlign; ++i) {
3374 Asm->EmitInt8(0);
3375 Asm->EOL("Padding");
3376 }
Jim Laskeybacd3042007-02-21 22:48:45 +00003377 EmitLabel("exception", SubprogramCount);
Duncan Sandsc1fe1662007-05-10 18:40:24 +00003378
Jim Laskeybacd3042007-02-21 22:48:45 +00003379 // Emit the header.
3380 Asm->EmitInt8(DW_EH_PE_omit);
3381 Asm->EOL("LPStart format (DW_EH_PE_omit)");
3382 Asm->EmitInt8(DW_EH_PE_absptr);
3383 Asm->EOL("TType format (DW_EH_PE_absptr)");
3384 Asm->EmitULEB128Bytes(TypeOffset);
3385 Asm->EOL("TType base offset");
3386 Asm->EmitInt8(DW_EH_PE_udata4);
3387 Asm->EOL("Call site format (DW_EH_PE_udata4)");
3388 Asm->EmitULEB128Bytes(SizeSites);
3389 Asm->EOL("Call-site table length");
Duncan Sands53c3a332007-05-16 12:12:23 +00003390
Duncan Sands57810cd2007-09-05 11:27:52 +00003391 // Emit the landing pad site information.
3392 for (unsigned i = 0; i < CallSites.size(); ++i) {
3393 CallSiteEntry &S = CallSites[i];
3394 const char *BeginTag;
3395 unsigned BeginNumber;
Duncan Sands53c3a332007-05-16 12:12:23 +00003396
Duncan Sands57810cd2007-09-05 11:27:52 +00003397 if (!S.BeginLabel) {
3398 BeginTag = "eh_func_begin";
3399 BeginNumber = SubprogramCount;
3400 } else {
3401 BeginTag = "label";
3402 BeginNumber = S.BeginLabel;
Duncan Sands53c3a332007-05-16 12:12:23 +00003403 }
Duncan Sands53c3a332007-05-16 12:12:23 +00003404
Duncan Sands57810cd2007-09-05 11:27:52 +00003405 EmitSectionOffset(BeginTag, "eh_func_begin", BeginNumber, SubprogramCount,
Duncan Sands671fa972008-05-07 19:11:09 +00003406 true, true);
Duncan Sands57810cd2007-09-05 11:27:52 +00003407 Asm->EOL("Region start");
Duncan Sands53c3a332007-05-16 12:12:23 +00003408
Duncan Sands57810cd2007-09-05 11:27:52 +00003409 if (!S.EndLabel) {
Dale Johannesen4af34942008-01-15 23:24:56 +00003410 EmitDifference("eh_func_end", SubprogramCount, BeginTag, BeginNumber,
Duncan Sands671fa972008-05-07 19:11:09 +00003411 true);
Duncan Sands57810cd2007-09-05 11:27:52 +00003412 } else {
Duncan Sands671fa972008-05-07 19:11:09 +00003413 EmitDifference("label", S.EndLabel, BeginTag, BeginNumber, true);
Duncan Sands57810cd2007-09-05 11:27:52 +00003414 }
3415 Asm->EOL("Region length");
Duncan Sands53c3a332007-05-16 12:12:23 +00003416
Duncan Sands671fa972008-05-07 19:11:09 +00003417 if (!S.PadLabel)
3418 Asm->EmitInt32(0);
3419 else
Duncan Sands57810cd2007-09-05 11:27:52 +00003420 EmitSectionOffset("label", "eh_func_begin", S.PadLabel, SubprogramCount,
Duncan Sands671fa972008-05-07 19:11:09 +00003421 true, true);
Duncan Sands57810cd2007-09-05 11:27:52 +00003422 Asm->EOL("Landing pad");
3423
3424 Asm->EmitULEB128Bytes(S.Action);
3425 Asm->EOL("Action");
Jim Laskeybacd3042007-02-21 22:48:45 +00003426 }
Duncan Sands53c3a332007-05-16 12:12:23 +00003427
Jim Laskeybacd3042007-02-21 22:48:45 +00003428 // Emit the actions.
Duncan Sandsb32edb42007-06-06 15:37:31 +00003429 for (unsigned I = 0, N = Actions.size(); I != N; ++I) {
3430 ActionEntry &Action = Actions[I];
Duncan Sands7bf7a442007-05-21 18:50:28 +00003431
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003432 Asm->EmitSLEB128Bytes(Action.ValueForTypeID);
Duncan Sandsb32edb42007-06-06 15:37:31 +00003433 Asm->EOL("TypeInfo index");
3434 Asm->EmitSLEB128Bytes(Action.NextAction);
3435 Asm->EOL("Next action");
Jim Laskeybacd3042007-02-21 22:48:45 +00003436 }
3437
3438 // Emit the type ids.
Jim Laskeybacd3042007-02-21 22:48:45 +00003439 for (unsigned M = TypeInfos.size(); M; --M) {
3440 GlobalVariable *GV = TypeInfos[M - 1];
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +00003441
3442 PrintRelDirective();
Jim Laskeybacd3042007-02-21 22:48:45 +00003443
3444 if (GV)
3445 O << Asm->getGlobalLinkName(GV);
3446 else
3447 O << "0";
Duncan Sands57810cd2007-09-05 11:27:52 +00003448
Jim Laskeybacd3042007-02-21 22:48:45 +00003449 Asm->EOL("TypeInfo");
3450 }
3451
Duncan Sands73ef58a2007-06-02 16:53:42 +00003452 // Emit the filter typeids.
3453 for (unsigned j = 0, M = FilterIds.size(); j < M; ++j) {
3454 unsigned TypeID = FilterIds[j];
Duncan Sandsbb821dd2007-07-12 13:51:39 +00003455 Asm->EmitULEB128Bytes(TypeID);
Duncan Sands73ef58a2007-06-02 16:53:42 +00003456 Asm->EOL("Filter TypeInfo index");
Jim Laskey0102ca82007-03-01 20:26:43 +00003457 }
Duncan Sands57810cd2007-09-05 11:27:52 +00003458
Evan Cheng05548eb2008-02-29 19:36:59 +00003459 Asm->EmitAlignment(2, 0, 0, false);
Jim Laskeyb82313f2007-02-01 16:31:34 +00003460 }
3461
Jim Laskey072200c2007-01-29 18:51:14 +00003462public:
3463 //===--------------------------------------------------------------------===//
3464 // Main entry points.
3465 //
3466 DwarfException(std::ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
Chris Lattner9251f132007-09-24 03:35:37 +00003467 : Dwarf(OS, A, T, "eh")
Dale Johannesen1532f3d2008-04-02 00:25:04 +00003468 , shouldEmitTable(false)
3469 , shouldEmitMoves(false)
3470 , shouldEmitTableModule(false)
3471 , shouldEmitMovesModule(false)
Jim Laskey072200c2007-01-29 18:51:14 +00003472 {}
3473
3474 virtual ~DwarfException() {}
3475
3476 /// SetModuleInfo - Set machine module information when it's known that pass
3477 /// manager has created it. Set by the target AsmPrinter.
3478 void SetModuleInfo(MachineModuleInfo *mmi) {
Jim Laskey3f09fc22007-02-28 18:38:31 +00003479 MMI = mmi;
Jim Laskey072200c2007-01-29 18:51:14 +00003480 }
3481
3482 /// BeginModule - Emit all exception information that should come prior to the
3483 /// content.
3484 void BeginModule(Module *M) {
3485 this->M = M;
Jim Laskey072200c2007-01-29 18:51:14 +00003486 }
3487
3488 /// EndModule - Emit all exception information that should come after the
3489 /// content.
3490 void EndModule() {
Dale Johannesen1532f3d2008-04-02 00:25:04 +00003491 if (shouldEmitMovesModule || shouldEmitTableModule) {
3492 const std::vector<Function *> Personalities = MMI->getPersonalities();
3493 for (unsigned i =0; i < Personalities.size(); ++i)
3494 EmitCommonEHFrame(Personalities[i], i);
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00003495
Dale Johannesen1532f3d2008-04-02 00:25:04 +00003496 for (std::vector<FunctionEHFrameInfo>::iterator I = EHFrames.begin(),
3497 E = EHFrames.end(); I != E; ++I)
3498 EmitEHFrame(*I);
3499 }
Jim Laskey072200c2007-01-29 18:51:14 +00003500 }
3501
3502 /// BeginFunction - Gather pre-function exception information. Assumes being
3503 /// emitted immediately after the function entry point.
3504 void BeginFunction(MachineFunction *MF) {
3505 this->MF = MF;
Dale Johannesen1532f3d2008-04-02 00:25:04 +00003506 shouldEmitTable = shouldEmitMoves = false;
Dale Johannesene0040622008-04-02 17:04:45 +00003507 if (MMI && TAI->doesSupportExceptionHandling()) {
Dale Johannesen1532f3d2008-04-02 00:25:04 +00003508
3509 // Map all labels and get rid of any dead landing pads.
3510 MMI->TidyLandingPads();
3511 // If any landing pads survive, we need an EH table.
3512 if (MMI->getLandingPads().size())
3513 shouldEmitTable = true;
3514
3515 // See if we need frame move info.
Duncan Sandsececf992008-07-04 09:55:48 +00003516 if (!MF->getFunction()->doesNotThrow() || UnwindTablesMandatory)
Dale Johannesen1532f3d2008-04-02 00:25:04 +00003517 shouldEmitMoves = true;
3518
3519 if (shouldEmitMoves || shouldEmitTable)
3520 // Assumes in correct section after the entry point.
3521 EmitLabel("eh_func_begin", ++SubprogramCount);
Jim Laskey3f09fc22007-02-28 18:38:31 +00003522 }
Dale Johannesen1532f3d2008-04-02 00:25:04 +00003523 shouldEmitTableModule |= shouldEmitTable;
3524 shouldEmitMovesModule |= shouldEmitMoves;
Jim Laskey072200c2007-01-29 18:51:14 +00003525 }
3526
3527 /// EndFunction - Gather and emit post-function exception information.
3528 ///
3529 void EndFunction() {
Dale Johannesen1532f3d2008-04-02 00:25:04 +00003530 if (shouldEmitMoves || shouldEmitTable) {
3531 EmitLabel("eh_func_end", SubprogramCount);
3532 EmitExceptionTable();
Jim Laskeyb82313f2007-02-01 16:31:34 +00003533
Dale Johannesen1532f3d2008-04-02 00:25:04 +00003534 // Save EH frame information
3535 EHFrames.
3536 push_back(FunctionEHFrameInfo(getAsm()->getCurrentFunctionEHName(MF),
Bill Wendling6e198962007-09-18 01:47:22 +00003537 SubprogramCount,
3538 MMI->getPersonalityIndex(),
3539 MF->getFrameInfo()->hasCalls(),
3540 !MMI->getLandingPads().empty(),
Dale Johannesen1d4ce2a2007-11-20 23:24:42 +00003541 MMI->getFrameMoves(),
Dale Johannesen48ae02f2008-01-16 19:59:28 +00003542 MF->getFunction()));
Dale Johannesen1532f3d2008-04-02 00:25:04 +00003543 }
Jim Laskey072200c2007-01-29 18:51:14 +00003544 }
3545};
3546
Jim Laskey0d086af2006-02-27 12:43:29 +00003547} // End of namespace llvm
Jim Laskey063e7652006-01-17 17:31:53 +00003548
3549//===----------------------------------------------------------------------===//
3550
Jim Laskeyd18e2892006-01-20 20:34:06 +00003551/// Emit - Print the abbreviation using the specified Dwarf writer.
3552///
Jim Laskey072200c2007-01-29 18:51:14 +00003553void DIEAbbrev::Emit(const DwarfDebug &DD) const {
Jim Laskeyd18e2892006-01-20 20:34:06 +00003554 // Emit its Dwarf tag type.
Jim Laskey072200c2007-01-29 18:51:14 +00003555 DD.getAsm()->EmitULEB128Bytes(Tag);
3556 DD.getAsm()->EOL(TagString(Tag));
Jim Laskeyd18e2892006-01-20 20:34:06 +00003557
3558 // Emit whether it has children DIEs.
Jim Laskey072200c2007-01-29 18:51:14 +00003559 DD.getAsm()->EmitULEB128Bytes(ChildrenFlag);
3560 DD.getAsm()->EOL(ChildrenString(ChildrenFlag));
Jim Laskeyd18e2892006-01-20 20:34:06 +00003561
3562 // For each attribute description.
Jim Laskey52060a02006-01-24 00:49:18 +00003563 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
Jim Laskeyd18e2892006-01-20 20:34:06 +00003564 const DIEAbbrevData &AttrData = Data[i];
3565
3566 // Emit attribute type.
Jim Laskey072200c2007-01-29 18:51:14 +00003567 DD.getAsm()->EmitULEB128Bytes(AttrData.getAttribute());
3568 DD.getAsm()->EOL(AttributeString(AttrData.getAttribute()));
Jim Laskeyd18e2892006-01-20 20:34:06 +00003569
3570 // Emit form type.
Jim Laskey072200c2007-01-29 18:51:14 +00003571 DD.getAsm()->EmitULEB128Bytes(AttrData.getForm());
3572 DD.getAsm()->EOL(FormEncodingString(AttrData.getForm()));
Jim Laskeyd18e2892006-01-20 20:34:06 +00003573 }
3574
3575 // Mark end of abbreviation.
Jim Laskey072200c2007-01-29 18:51:14 +00003576 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(1)");
3577 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(2)");
Jim Laskeyd18e2892006-01-20 20:34:06 +00003578}
3579
3580#ifndef NDEBUG
Jim Laskeya0f3d172006-09-07 22:06:40 +00003581void DIEAbbrev::print(std::ostream &O) {
3582 O << "Abbreviation @"
3583 << std::hex << (intptr_t)this << std::dec
3584 << " "
3585 << TagString(Tag)
3586 << " "
3587 << ChildrenString(ChildrenFlag)
3588 << "\n";
3589
3590 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3591 O << " "
3592 << AttributeString(Data[i].getAttribute())
Jim Laskeyd18e2892006-01-20 20:34:06 +00003593 << " "
Jim Laskeya0f3d172006-09-07 22:06:40 +00003594 << FormEncodingString(Data[i].getForm())
Jim Laskeyd18e2892006-01-20 20:34:06 +00003595 << "\n";
Jim Laskeyd18e2892006-01-20 20:34:06 +00003596 }
Jim Laskeya0f3d172006-09-07 22:06:40 +00003597}
Bill Wendlinge8156192006-12-07 01:30:32 +00003598void DIEAbbrev::dump() { print(cerr); }
Jim Laskeyd18e2892006-01-20 20:34:06 +00003599#endif
3600
3601//===----------------------------------------------------------------------===//
3602
Jim Laskeyef42a012006-11-02 20:12:39 +00003603#ifndef NDEBUG
3604void DIEValue::dump() {
Bill Wendlinge8156192006-12-07 01:30:32 +00003605 print(cerr);
Jim Laskeyb80af6f2006-03-03 21:00:14 +00003606}
Jim Laskeyef42a012006-11-02 20:12:39 +00003607#endif
3608
3609//===----------------------------------------------------------------------===//
3610
Jim Laskey063e7652006-01-17 17:31:53 +00003611/// EmitValue - Emit integer of appropriate size.
3612///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00003613void DIEInteger::EmitValue(DwarfDebug &DD, unsigned Form) {
Jim Laskey063e7652006-01-17 17:31:53 +00003614 switch (Form) {
Jim Laskey40020172006-01-20 21:02:36 +00003615 case DW_FORM_flag: // Fall thru
Jim Laskeyb8509c52006-03-23 18:07:55 +00003616 case DW_FORM_ref1: // Fall thru
Jim Laskey072200c2007-01-29 18:51:14 +00003617 case DW_FORM_data1: DD.getAsm()->EmitInt8(Integer); break;
Jim Laskeyb8509c52006-03-23 18:07:55 +00003618 case DW_FORM_ref2: // Fall thru
Jim Laskey072200c2007-01-29 18:51:14 +00003619 case DW_FORM_data2: DD.getAsm()->EmitInt16(Integer); break;
Jim Laskeyb8509c52006-03-23 18:07:55 +00003620 case DW_FORM_ref4: // Fall thru
Jim Laskey072200c2007-01-29 18:51:14 +00003621 case DW_FORM_data4: DD.getAsm()->EmitInt32(Integer); break;
Jim Laskeyb8509c52006-03-23 18:07:55 +00003622 case DW_FORM_ref8: // Fall thru
Jim Laskey072200c2007-01-29 18:51:14 +00003623 case DW_FORM_data8: DD.getAsm()->EmitInt64(Integer); break;
3624 case DW_FORM_udata: DD.getAsm()->EmitULEB128Bytes(Integer); break;
3625 case DW_FORM_sdata: DD.getAsm()->EmitSLEB128Bytes(Integer); break;
Jim Laskeyf1cdea12007-01-25 15:12:02 +00003626 default: assert(0 && "DIE Value form not supported yet"); break;
3627 }
3628}
3629
3630/// SizeOf - Determine size of integer value in bytes.
3631///
Jim Laskey072200c2007-01-29 18:51:14 +00003632unsigned DIEInteger::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Jim Laskeyf1cdea12007-01-25 15:12:02 +00003633 switch (Form) {
3634 case DW_FORM_flag: // Fall thru
3635 case DW_FORM_ref1: // Fall thru
3636 case DW_FORM_data1: return sizeof(int8_t);
3637 case DW_FORM_ref2: // Fall thru
3638 case DW_FORM_data2: return sizeof(int16_t);
3639 case DW_FORM_ref4: // Fall thru
3640 case DW_FORM_data4: return sizeof(int32_t);
3641 case DW_FORM_ref8: // Fall thru
3642 case DW_FORM_data8: return sizeof(int64_t);
Jim Laskey072200c2007-01-29 18:51:14 +00003643 case DW_FORM_udata: return DD.getAsm()->SizeULEB128(Integer);
3644 case DW_FORM_sdata: return DD.getAsm()->SizeSLEB128(Integer);
Jim Laskey063e7652006-01-17 17:31:53 +00003645 default: assert(0 && "DIE Value form not supported yet"); break;
3646 }
Jim Laskeyf1cdea12007-01-25 15:12:02 +00003647 return 0;
Jim Laskey063e7652006-01-17 17:31:53 +00003648}
3649
Jim Laskey063e7652006-01-17 17:31:53 +00003650//===----------------------------------------------------------------------===//
3651
3652/// EmitValue - Emit string value.
3653///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00003654void DIEString::EmitValue(DwarfDebug &DD, unsigned Form) {
Jim Laskey072200c2007-01-29 18:51:14 +00003655 DD.getAsm()->EmitString(String);
Jim Laskey063e7652006-01-17 17:31:53 +00003656}
3657
Jim Laskey063e7652006-01-17 17:31:53 +00003658//===----------------------------------------------------------------------===//
3659
3660/// EmitValue - Emit label value.
3661///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00003662void DIEDwarfLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
Dan Gohman9fda5be2007-09-28 16:50:28 +00003663 bool IsSmall = Form == DW_FORM_data4;
3664 DD.EmitReference(Label, false, IsSmall);
Jim Laskey063e7652006-01-17 17:31:53 +00003665}
3666
3667/// SizeOf - Determine size of label value in bytes.
3668///
Jim Laskey072200c2007-01-29 18:51:14 +00003669unsigned DIEDwarfLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Dan Gohman9fda5be2007-09-28 16:50:28 +00003670 if (Form == DW_FORM_data4) return 4;
Dan Gohman82482942007-09-27 23:12:31 +00003671 return DD.getTargetData()->getPointerSize();
Jim Laskey063e7652006-01-17 17:31:53 +00003672}
Jim Laskeyef42a012006-11-02 20:12:39 +00003673
Jim Laskey063e7652006-01-17 17:31:53 +00003674//===----------------------------------------------------------------------===//
3675
Jim Laskeyd18e2892006-01-20 20:34:06 +00003676/// EmitValue - Emit label value.
3677///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00003678void DIEObjectLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
Dan Gohman9fda5be2007-09-28 16:50:28 +00003679 bool IsSmall = Form == DW_FORM_data4;
3680 DD.EmitReference(Label, false, IsSmall);
Jim Laskeyd18e2892006-01-20 20:34:06 +00003681}
3682
3683/// SizeOf - Determine size of label value in bytes.
3684///
Jim Laskey072200c2007-01-29 18:51:14 +00003685unsigned DIEObjectLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Dan Gohman9fda5be2007-09-28 16:50:28 +00003686 if (Form == DW_FORM_data4) return 4;
Dan Gohman82482942007-09-27 23:12:31 +00003687 return DD.getTargetData()->getPointerSize();
Jim Laskeyd18e2892006-01-20 20:34:06 +00003688}
3689
3690//===----------------------------------------------------------------------===//
3691
Jim Laskey063e7652006-01-17 17:31:53 +00003692/// EmitValue - Emit delta value.
3693///
Argyrios Kyrtzidisf7acf8f2008-06-18 19:27:37 +00003694void DIESectionOffset::EmitValue(DwarfDebug &DD, unsigned Form) {
3695 bool IsSmall = Form == DW_FORM_data4;
3696 DD.EmitSectionOffset(Label.Tag, Section.Tag,
3697 Label.Number, Section.Number, IsSmall, IsEH, UseSet);
3698}
3699
3700/// SizeOf - Determine size of delta value in bytes.
3701///
3702unsigned DIESectionOffset::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3703 if (Form == DW_FORM_data4) return 4;
3704 return DD.getTargetData()->getPointerSize();
3705}
3706
3707//===----------------------------------------------------------------------===//
3708
3709/// EmitValue - Emit delta value.
3710///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00003711void DIEDelta::EmitValue(DwarfDebug &DD, unsigned Form) {
Jim Laskey2b4e98c2006-12-06 17:43:18 +00003712 bool IsSmall = Form == DW_FORM_data4;
Jim Laskey072200c2007-01-29 18:51:14 +00003713 DD.EmitDifference(LabelHi, LabelLo, IsSmall);
Jim Laskey063e7652006-01-17 17:31:53 +00003714}
3715
3716/// SizeOf - Determine size of delta value in bytes.
3717///
Jim Laskey072200c2007-01-29 18:51:14 +00003718unsigned DIEDelta::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Jim Laskey2b4e98c2006-12-06 17:43:18 +00003719 if (Form == DW_FORM_data4) return 4;
Dan Gohman82482942007-09-27 23:12:31 +00003720 return DD.getTargetData()->getPointerSize();
Jim Laskey063e7652006-01-17 17:31:53 +00003721}
3722
3723//===----------------------------------------------------------------------===//
Jim Laskeyef42a012006-11-02 20:12:39 +00003724
Jim Laskeyb8509c52006-03-23 18:07:55 +00003725/// EmitValue - Emit debug information entry offset.
Jim Laskeyd18e2892006-01-20 20:34:06 +00003726///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00003727void DIEntry::EmitValue(DwarfDebug &DD, unsigned Form) {
Jim Laskey072200c2007-01-29 18:51:14 +00003728 DD.getAsm()->EmitInt32(Entry->getOffset());
Jim Laskeyd18e2892006-01-20 20:34:06 +00003729}
Jim Laskeyd18e2892006-01-20 20:34:06 +00003730
3731//===----------------------------------------------------------------------===//
3732
Jim Laskeyb80af6f2006-03-03 21:00:14 +00003733/// ComputeSize - calculate the size of the block.
3734///
Jim Laskey072200c2007-01-29 18:51:14 +00003735unsigned DIEBlock::ComputeSize(DwarfDebug &DD) {
Jim Laskeyef42a012006-11-02 20:12:39 +00003736 if (!Size) {
Owen Anderson873e1b52008-06-24 21:44:59 +00003737 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
Jim Laskeyef42a012006-11-02 20:12:39 +00003738
3739 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
Jim Laskey072200c2007-01-29 18:51:14 +00003740 Size += Values[i]->SizeOf(DD, AbbrevData[i].getForm());
Jim Laskeyef42a012006-11-02 20:12:39 +00003741 }
Jim Laskeyb80af6f2006-03-03 21:00:14 +00003742 }
3743 return Size;
3744}
3745
Jim Laskeyb80af6f2006-03-03 21:00:14 +00003746/// EmitValue - Emit block data.
3747///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00003748void DIEBlock::EmitValue(DwarfDebug &DD, unsigned Form) {
Jim Laskeyb80af6f2006-03-03 21:00:14 +00003749 switch (Form) {
Jim Laskey072200c2007-01-29 18:51:14 +00003750 case DW_FORM_block1: DD.getAsm()->EmitInt8(Size); break;
3751 case DW_FORM_block2: DD.getAsm()->EmitInt16(Size); break;
3752 case DW_FORM_block4: DD.getAsm()->EmitInt32(Size); break;
3753 case DW_FORM_block: DD.getAsm()->EmitULEB128Bytes(Size); break;
Jim Laskeyf1cdea12007-01-25 15:12:02 +00003754 default: assert(0 && "Improper form for block"); break;
Jim Laskeyb80af6f2006-03-03 21:00:14 +00003755 }
Jim Laskeyef42a012006-11-02 20:12:39 +00003756
Owen Anderson873e1b52008-06-24 21:44:59 +00003757 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
Jim Laskeyef42a012006-11-02 20:12:39 +00003758
Jim Laskeyb80af6f2006-03-03 21:00:14 +00003759 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
Jim Laskeybacd3042007-02-21 22:48:45 +00003760 DD.getAsm()->EOL();
Jim Laskey072200c2007-01-29 18:51:14 +00003761 Values[i]->EmitValue(DD, AbbrevData[i].getForm());
Jim Laskeyb80af6f2006-03-03 21:00:14 +00003762 }
3763}
3764
3765/// SizeOf - Determine size of block data in bytes.
3766///
Jim Laskey072200c2007-01-29 18:51:14 +00003767unsigned DIEBlock::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Jim Laskeyb80af6f2006-03-03 21:00:14 +00003768 switch (Form) {
3769 case DW_FORM_block1: return Size + sizeof(int8_t);
3770 case DW_FORM_block2: return Size + sizeof(int16_t);
3771 case DW_FORM_block4: return Size + sizeof(int32_t);
Jim Laskey072200c2007-01-29 18:51:14 +00003772 case DW_FORM_block: return Size + DD.getAsm()->SizeULEB128(Size);
Jim Laskeyb80af6f2006-03-03 21:00:14 +00003773 default: assert(0 && "Improper form for block"); break;
3774 }
3775 return 0;
3776}
3777
Jim Laskeyb80af6f2006-03-03 21:00:14 +00003778//===----------------------------------------------------------------------===//
Jim Laskeyef42a012006-11-02 20:12:39 +00003779/// DIE Implementation
Jim Laskeyd18e2892006-01-20 20:34:06 +00003780
3781DIE::~DIE() {
Jim Laskeyef42a012006-11-02 20:12:39 +00003782 for (unsigned i = 0, N = Children.size(); i < N; ++i)
Jim Laskeyd18e2892006-01-20 20:34:06 +00003783 delete Children[i];
Jim Laskeyd18e2892006-01-20 20:34:06 +00003784}
Jim Laskeyef42a012006-11-02 20:12:39 +00003785
Jim Laskeyb8509c52006-03-23 18:07:55 +00003786/// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
3787///
3788void DIE::AddSiblingOffset() {
3789 DIEInteger *DI = new DIEInteger(0);
3790 Values.insert(Values.begin(), DI);
Jim Laskeya9c83fe2006-10-30 15:59:54 +00003791 Abbrev.AddFirstAttribute(DW_AT_sibling, DW_FORM_ref4);
Jim Laskeyb8509c52006-03-23 18:07:55 +00003792}
3793
Jim Laskeyef42a012006-11-02 20:12:39 +00003794/// Profile - Used to gather unique data for the value folding set.
Jim Laskeyd18e2892006-01-20 20:34:06 +00003795///
Jim Laskeyef42a012006-11-02 20:12:39 +00003796void DIE::Profile(FoldingSetNodeID &ID) {
3797 Abbrev.Profile(ID);
3798
3799 for (unsigned i = 0, N = Children.size(); i < N; ++i)
3800 ID.AddPointer(Children[i]);
3801
3802 for (unsigned j = 0, M = Values.size(); j < M; ++j)
3803 ID.AddPointer(Values[j]);
Jim Laskeyd8f77ba2006-01-27 15:20:54 +00003804}
Jim Laskeyef42a012006-11-02 20:12:39 +00003805
3806#ifndef NDEBUG
3807void DIE::print(std::ostream &O, unsigned IncIndent) {
3808 static unsigned IndentCount = 0;
3809 IndentCount += IncIndent;
3810 const std::string Indent(IndentCount, ' ');
3811 bool isBlock = Abbrev.getTag() == 0;
3812
3813 if (!isBlock) {
3814 O << Indent
3815 << "Die: "
3816 << "0x" << std::hex << (intptr_t)this << std::dec
3817 << ", Offset: " << Offset
3818 << ", Size: " << Size
3819 << "\n";
Jim Laskeyd8f77ba2006-01-27 15:20:54 +00003820
Jim Laskeyef42a012006-11-02 20:12:39 +00003821 O << Indent
3822 << TagString(Abbrev.getTag())
Jim Laskey063e7652006-01-17 17:31:53 +00003823 << " "
Jim Laskeyef42a012006-11-02 20:12:39 +00003824 << ChildrenString(Abbrev.getChildrenFlag());
3825 } else {
3826 O << "Size: " << Size;
Jim Laskey063e7652006-01-17 17:31:53 +00003827 }
3828 O << "\n";
Jim Laskeya7cea6f2006-01-04 13:52:30 +00003829
Owen Anderson873e1b52008-06-24 21:44:59 +00003830 const SmallVector<DIEAbbrevData, 8> &Data = Abbrev.getData();
Jim Laskeya7cea6f2006-01-04 13:52:30 +00003831
Jim Laskeyef42a012006-11-02 20:12:39 +00003832 IndentCount += 2;
3833 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3834 O << Indent;
3835 if (!isBlock) {
3836 O << AttributeString(Data[i].getAttribute());
Jim Laskeyd8f77ba2006-01-27 15:20:54 +00003837 } else {
Jim Laskeyef42a012006-11-02 20:12:39 +00003838 O << "Blk[" << i << "]";
Jim Laskeyd8f77ba2006-01-27 15:20:54 +00003839 }
Jim Laskeyef42a012006-11-02 20:12:39 +00003840 O << " "
3841 << FormEncodingString(Data[i].getForm())
3842 << " ";
3843 Values[i]->print(O);
Jim Laskey0d086af2006-02-27 12:43:29 +00003844 O << "\n";
Jim Laskey063e7652006-01-17 17:31:53 +00003845 }
Jim Laskeyef42a012006-11-02 20:12:39 +00003846 IndentCount -= 2;
Jim Laskey063e7652006-01-17 17:31:53 +00003847
Jim Laskeyef42a012006-11-02 20:12:39 +00003848 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
3849 Children[j]->print(O, 4);
Jim Laskey063e7652006-01-17 17:31:53 +00003850 }
Jim Laskey063e7652006-01-17 17:31:53 +00003851
Jim Laskeyef42a012006-11-02 20:12:39 +00003852 if (!isBlock) O << "\n";
3853 IndentCount -= IncIndent;
Jim Laskey19ef4ef2006-01-17 20:41:40 +00003854}
3855
Jim Laskeyef42a012006-11-02 20:12:39 +00003856void DIE::dump() {
Bill Wendlinge8156192006-12-07 01:30:32 +00003857 print(cerr);
Jim Laskey41886992006-04-07 16:34:46 +00003858}
Jim Laskeybd761842006-02-27 17:27:12 +00003859#endif
Jim Laskey65195462006-10-30 13:35:07 +00003860
3861//===----------------------------------------------------------------------===//
3862/// DwarfWriter Implementation
Jim Laskeyef42a012006-11-02 20:12:39 +00003863///
Jim Laskey65195462006-10-30 13:35:07 +00003864
3865DwarfWriter::DwarfWriter(std::ostream &OS, AsmPrinter *A,
3866 const TargetAsmInfo *T) {
Jim Laskey072200c2007-01-29 18:51:14 +00003867 DE = new DwarfException(OS, A, T);
3868 DD = new DwarfDebug(OS, A, T);
Jim Laskey65195462006-10-30 13:35:07 +00003869}
3870
3871DwarfWriter::~DwarfWriter() {
Jim Laskey072200c2007-01-29 18:51:14 +00003872 delete DE;
3873 delete DD;
Jim Laskey65195462006-10-30 13:35:07 +00003874}
3875
Jim Laskey44c3b9f2007-01-26 21:22:28 +00003876/// SetModuleInfo - Set machine module info when it's known that pass manager
3877/// has created it. Set by the target AsmPrinter.
3878void DwarfWriter::SetModuleInfo(MachineModuleInfo *MMI) {
Jim Laskey072200c2007-01-29 18:51:14 +00003879 DD->SetModuleInfo(MMI);
Jim Laskeyb82313f2007-02-01 16:31:34 +00003880 DE->SetModuleInfo(MMI);
Jim Laskey65195462006-10-30 13:35:07 +00003881}
3882
3883/// BeginModule - Emit all Dwarf sections that should come prior to the
3884/// content.
3885void DwarfWriter::BeginModule(Module *M) {
Jim Laskey072200c2007-01-29 18:51:14 +00003886 DE->BeginModule(M);
3887 DD->BeginModule(M);
Jim Laskey65195462006-10-30 13:35:07 +00003888}
3889
3890/// EndModule - Emit all Dwarf sections that should come after the content.
3891///
3892void DwarfWriter::EndModule() {
Jim Laskey072200c2007-01-29 18:51:14 +00003893 DE->EndModule();
3894 DD->EndModule();
Jim Laskey65195462006-10-30 13:35:07 +00003895}
3896
3897/// BeginFunction - Gather pre-function debug information. Assumes being
3898/// emitted immediately after the function entry point.
3899void DwarfWriter::BeginFunction(MachineFunction *MF) {
Jim Laskey072200c2007-01-29 18:51:14 +00003900 DE->BeginFunction(MF);
3901 DD->BeginFunction(MF);
Jim Laskey65195462006-10-30 13:35:07 +00003902}
3903
3904/// EndFunction - Gather and emit post-function debug information.
3905///
3906void DwarfWriter::EndFunction() {
Jim Laskey072200c2007-01-29 18:51:14 +00003907 DD->EndFunction();
Jim Laskeyb82313f2007-02-01 16:31:34 +00003908 DE->EndFunction();
3909
Jim Laskey3f09fc22007-02-28 18:38:31 +00003910 if (MachineModuleInfo *MMI = DD->getMMI() ? DD->getMMI() : DE->getMMI()) {
Jim Laskeyb82313f2007-02-01 16:31:34 +00003911 // Clear function debug information.
3912 MMI->EndFunction();
3913 }
Jim Laskey65195462006-10-30 13:35:07 +00003914}