blob: e72ff07a9d704299b36a67d4e0afc11ac0b3cf44 [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 ///
143 std::vector<DIEAbbrevData> 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; }
158 const std::vector<DIEAbbrevData> &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 ///
222 std::vector<DIEValue *> Values;
223
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; }
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000243 std::vector<DIEValue *> &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,
299 isDelta,
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000300 isEntry,
301 isBlock
Jim Laskey0d086af2006-02-27 12:43:29 +0000302 };
303
Jim Laskeyef42a012006-11-02 20:12:39 +0000304 /// Type - Type of data stored in the value.
305 ///
306 unsigned Type;
Jim Laskey0d086af2006-02-27 12:43:29 +0000307
Dan Gohman81975f62007-08-27 14:50:10 +0000308 explicit DIEValue(unsigned T)
Jim Laskeyef42a012006-11-02 20:12:39 +0000309 : Type(T)
Jim Laskeyef42a012006-11-02 20:12:39 +0000310 {}
Jim Laskey0d086af2006-02-27 12:43:29 +0000311 virtual ~DIEValue() {}
312
Jim Laskeyf6733882006-11-02 21:48:18 +0000313 // Accessors
Jim Laskeyef42a012006-11-02 20:12:39 +0000314 unsigned getType() const { return Type; }
Jim Laskeyef42a012006-11-02 20:12:39 +0000315
Jim Laskey0d086af2006-02-27 12:43:29 +0000316 // Implement isa/cast/dyncast.
317 static bool classof(const DIEValue *) { return true; }
318
319 /// EmitValue - Emit value via the Dwarf writer.
320 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000321 virtual void EmitValue(DwarfDebug &DD, unsigned Form) = 0;
Jim Laskey0d086af2006-02-27 12:43:29 +0000322
323 /// SizeOf - Return the size of a value in bytes.
324 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000325 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const = 0;
Jim Laskeyef42a012006-11-02 20:12:39 +0000326
327 /// Profile - Used to gather unique data for the value folding set.
328 ///
329 virtual void Profile(FoldingSetNodeID &ID) = 0;
330
331#ifndef NDEBUG
Bill Wendling5c7e3262006-12-17 05:15:13 +0000332 void print(std::ostream *O) {
333 if (O) print(*O);
Bill Wendlingbdc679d2006-11-29 00:39:47 +0000334 }
Jim Laskeyef42a012006-11-02 20:12:39 +0000335 virtual void print(std::ostream &O) = 0;
336 void dump();
337#endif
Jim Laskey0d086af2006-02-27 12:43:29 +0000338};
Jim Laskey063e7652006-01-17 17:31:53 +0000339
Jim Laskey0d086af2006-02-27 12:43:29 +0000340//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000341/// DWInteger - An integer value DIE.
342///
Jim Laskey0d086af2006-02-27 12:43:29 +0000343class DIEInteger : public DIEValue {
344private:
345 uint64_t Integer;
346
347public:
Dan Gohman81975f62007-08-27 14:50:10 +0000348 explicit DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
Jim Laskey063e7652006-01-17 17:31:53 +0000349
Jim Laskey0d086af2006-02-27 12:43:29 +0000350 // Implement isa/cast/dyncast.
351 static bool classof(const DIEInteger *) { return true; }
352 static bool classof(const DIEValue *I) { return I->Type == isInteger; }
353
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000354 /// BestForm - Choose the best form for integer.
355 ///
Jim Laskeyef42a012006-11-02 20:12:39 +0000356 static unsigned BestForm(bool IsSigned, uint64_t Integer) {
357 if (IsSigned) {
358 if ((char)Integer == (signed)Integer) return DW_FORM_data1;
359 if ((short)Integer == (signed)Integer) return DW_FORM_data2;
360 if ((int)Integer == (signed)Integer) return DW_FORM_data4;
361 } else {
362 if ((unsigned char)Integer == Integer) return DW_FORM_data1;
363 if ((unsigned short)Integer == Integer) return DW_FORM_data2;
364 if ((unsigned int)Integer == Integer) return DW_FORM_data4;
365 }
366 return DW_FORM_data8;
367 }
368
Jim Laskey0d086af2006-02-27 12:43:29 +0000369 /// EmitValue - Emit integer of appropriate size.
370 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000371 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
Jim Laskey0d086af2006-02-27 12:43:29 +0000372
373 /// SizeOf - Determine size of integer value in bytes.
374 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000375 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
Jim Laskeyef42a012006-11-02 20:12:39 +0000376
377 /// Profile - Used to gather unique data for the value folding set.
378 ///
Jim Laskey5496f012006-11-09 14:52:14 +0000379 static void Profile(FoldingSetNodeID &ID, unsigned Integer) {
Jim Laskeyf6733882006-11-02 21:48:18 +0000380 ID.AddInteger(isInteger);
Jim Laskeyef42a012006-11-02 20:12:39 +0000381 ID.AddInteger(Integer);
382 }
Jim Laskey5496f012006-11-09 14:52:14 +0000383 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Integer); }
Jim Laskeyef42a012006-11-02 20:12:39 +0000384
385#ifndef NDEBUG
386 virtual void print(std::ostream &O) {
387 O << "Int: " << (int64_t)Integer
388 << " 0x" << std::hex << Integer << std::dec;
389 }
390#endif
Jim Laskey0d086af2006-02-27 12:43:29 +0000391};
Jim Laskey063e7652006-01-17 17:31:53 +0000392
Jim Laskey0d086af2006-02-27 12:43:29 +0000393//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000394/// DIEString - A string value DIE.
395///
Jim Laskeyef42a012006-11-02 20:12:39 +0000396class DIEString : public DIEValue {
397public:
Jim Laskey0d086af2006-02-27 12:43:29 +0000398 const std::string String;
399
Dan Gohman81975f62007-08-27 14:50:10 +0000400 explicit DIEString(const std::string &S) : DIEValue(isString), String(S) {}
Jim Laskey063e7652006-01-17 17:31:53 +0000401
Jim Laskey0d086af2006-02-27 12:43:29 +0000402 // Implement isa/cast/dyncast.
403 static bool classof(const DIEString *) { return true; }
404 static bool classof(const DIEValue *S) { return S->Type == isString; }
405
406 /// EmitValue - Emit string value.
407 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000408 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
Jim Laskey0d086af2006-02-27 12:43:29 +0000409
410 /// SizeOf - Determine size of string value in bytes.
411 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000412 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
Jim Laskeyef42a012006-11-02 20:12:39 +0000413 return String.size() + sizeof(char); // sizeof('\0');
414 }
415
416 /// Profile - Used to gather unique data for the value folding set.
417 ///
Jim Laskey5496f012006-11-09 14:52:14 +0000418 static void Profile(FoldingSetNodeID &ID, const std::string &String) {
Jim Laskeyf6733882006-11-02 21:48:18 +0000419 ID.AddInteger(isString);
Jim Laskeyef42a012006-11-02 20:12:39 +0000420 ID.AddString(String);
421 }
Jim Laskey5496f012006-11-09 14:52:14 +0000422 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, String); }
Jim Laskeyef42a012006-11-02 20:12:39 +0000423
424#ifndef NDEBUG
425 virtual void print(std::ostream &O) {
426 O << "Str: \"" << String << "\"";
427 }
428#endif
Jim Laskey0d086af2006-02-27 12:43:29 +0000429};
Jim Laskey063e7652006-01-17 17:31:53 +0000430
Jim Laskey0d086af2006-02-27 12:43:29 +0000431//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000432/// DIEDwarfLabel - A Dwarf internal label expression DIE.
Jim Laskey0d086af2006-02-27 12:43:29 +0000433//
Jim Laskeyef42a012006-11-02 20:12:39 +0000434class DIEDwarfLabel : public DIEValue {
435public:
436
Jim Laskey0d086af2006-02-27 12:43:29 +0000437 const DWLabel Label;
438
Dan Gohman81975f62007-08-27 14:50:10 +0000439 explicit DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {}
Jim Laskey063e7652006-01-17 17:31:53 +0000440
Jim Laskey0d086af2006-02-27 12:43:29 +0000441 // Implement isa/cast/dyncast.
442 static bool classof(const DIEDwarfLabel *) { return true; }
443 static bool classof(const DIEValue *L) { return L->Type == isLabel; }
444
445 /// EmitValue - Emit label value.
446 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000447 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
Jim Laskey0d086af2006-02-27 12:43:29 +0000448
449 /// SizeOf - Determine size of label value in bytes.
450 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000451 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
Jim Laskeyef42a012006-11-02 20:12:39 +0000452
453 /// Profile - Used to gather unique data for the value folding set.
454 ///
Jim Laskey5496f012006-11-09 14:52:14 +0000455 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label) {
Jim Laskeyf6733882006-11-02 21:48:18 +0000456 ID.AddInteger(isLabel);
Jim Laskeyef42a012006-11-02 20:12:39 +0000457 Label.Profile(ID);
458 }
Jim Laskey5496f012006-11-09 14:52:14 +0000459 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
Jim Laskeyef42a012006-11-02 20:12:39 +0000460
461#ifndef NDEBUG
462 virtual void print(std::ostream &O) {
463 O << "Lbl: ";
464 Label.print(O);
465 }
466#endif
Jim Laskey0d086af2006-02-27 12:43:29 +0000467};
Jim Laskey063e7652006-01-17 17:31:53 +0000468
Jim Laskey063e7652006-01-17 17:31:53 +0000469
Jim Laskey0d086af2006-02-27 12:43:29 +0000470//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000471/// DIEObjectLabel - A label to an object in code or data.
Jim Laskey0d086af2006-02-27 12:43:29 +0000472//
Jim Laskeyef42a012006-11-02 20:12:39 +0000473class DIEObjectLabel : public DIEValue {
474public:
Jim Laskey0d086af2006-02-27 12:43:29 +0000475 const std::string Label;
476
Dan Gohman81975f62007-08-27 14:50:10 +0000477 explicit DIEObjectLabel(const std::string &L)
478 : DIEValue(isAsIsLabel), Label(L) {}
Jim Laskey063e7652006-01-17 17:31:53 +0000479
Jim Laskey0d086af2006-02-27 12:43:29 +0000480 // Implement isa/cast/dyncast.
481 static bool classof(const DIEObjectLabel *) { return true; }
482 static bool classof(const DIEValue *L) { return L->Type == isAsIsLabel; }
483
484 /// EmitValue - Emit label value.
485 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000486 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
Jim Laskey0d086af2006-02-27 12:43:29 +0000487
488 /// SizeOf - Determine size of label value in bytes.
489 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000490 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
Jim Laskeyef42a012006-11-02 20:12:39 +0000491
492 /// Profile - Used to gather unique data for the value folding set.
493 ///
Jim Laskey5496f012006-11-09 14:52:14 +0000494 static void Profile(FoldingSetNodeID &ID, const std::string &Label) {
Jim Laskeyf6733882006-11-02 21:48:18 +0000495 ID.AddInteger(isAsIsLabel);
Jim Laskeyef42a012006-11-02 20:12:39 +0000496 ID.AddString(Label);
497 }
Jim Laskey5496f012006-11-09 14:52:14 +0000498 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
Jim Laskeyef42a012006-11-02 20:12:39 +0000499
500#ifndef NDEBUG
501 virtual void print(std::ostream &O) {
502 O << "Obj: " << Label;
503 }
504#endif
Jim Laskey0d086af2006-02-27 12:43:29 +0000505};
Jim Laskey063e7652006-01-17 17:31:53 +0000506
Jim Laskey0d086af2006-02-27 12:43:29 +0000507//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000508/// DIEDelta - A simple label difference DIE.
509///
Jim Laskeyef42a012006-11-02 20:12:39 +0000510class DIEDelta : public DIEValue {
511public:
Jim Laskey0d086af2006-02-27 12:43:29 +0000512 const DWLabel LabelHi;
513 const DWLabel LabelLo;
514
515 DIEDelta(const DWLabel &Hi, const DWLabel &Lo)
516 : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
Jim Laskey063e7652006-01-17 17:31:53 +0000517
Jim Laskey0d086af2006-02-27 12:43:29 +0000518 // Implement isa/cast/dyncast.
519 static bool classof(const DIEDelta *) { return true; }
520 static bool classof(const DIEValue *D) { return D->Type == isDelta; }
521
522 /// EmitValue - Emit delta value.
523 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000524 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
Jim Laskey0d086af2006-02-27 12:43:29 +0000525
526 /// SizeOf - Determine size of delta value in bytes.
527 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000528 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
Jim Laskeyef42a012006-11-02 20:12:39 +0000529
530 /// Profile - Used to gather unique data for the value folding set.
531 ///
Jim Laskey5496f012006-11-09 14:52:14 +0000532 static void Profile(FoldingSetNodeID &ID, const DWLabel &LabelHi,
533 const DWLabel &LabelLo) {
Jim Laskeyf6733882006-11-02 21:48:18 +0000534 ID.AddInteger(isDelta);
Jim Laskeyef42a012006-11-02 20:12:39 +0000535 LabelHi.Profile(ID);
536 LabelLo.Profile(ID);
537 }
Jim Laskey5496f012006-11-09 14:52:14 +0000538 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, LabelHi, LabelLo); }
Jim Laskeyef42a012006-11-02 20:12:39 +0000539
540#ifndef NDEBUG
541 virtual void print(std::ostream &O) {
542 O << "Del: ";
543 LabelHi.print(O);
544 O << "-";
545 LabelLo.print(O);
546 }
547#endif
Jim Laskey0d086af2006-02-27 12:43:29 +0000548};
Jim Laskey063e7652006-01-17 17:31:53 +0000549
Jim Laskey0d086af2006-02-27 12:43:29 +0000550//===----------------------------------------------------------------------===//
Jim Laskeyef42a012006-11-02 20:12:39 +0000551/// DIEntry - A pointer to another debug information entry. An instance of this
552/// class can also be used as a proxy for a debug information entry not yet
553/// defined (ie. types.)
554class DIEntry : public DIEValue {
555public:
Jim Laskey0d086af2006-02-27 12:43:29 +0000556 DIE *Entry;
557
Dan Gohman81975f62007-08-27 14:50:10 +0000558 explicit DIEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
Jim Laskeyef42a012006-11-02 20:12:39 +0000559
Jim Laskey0d086af2006-02-27 12:43:29 +0000560 // Implement isa/cast/dyncast.
561 static bool classof(const DIEntry *) { return true; }
562 static bool classof(const DIEValue *E) { return E->Type == isEntry; }
563
Jim Laskeyb8509c52006-03-23 18:07:55 +0000564 /// EmitValue - Emit debug information entry offset.
Jim Laskey0d086af2006-02-27 12:43:29 +0000565 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000566 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
Jim Laskey0d086af2006-02-27 12:43:29 +0000567
Jim Laskeyb8509c52006-03-23 18:07:55 +0000568 /// SizeOf - Determine size of debug information entry in bytes.
Jim Laskey0d086af2006-02-27 12:43:29 +0000569 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000570 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
Jim Laskeyef42a012006-11-02 20:12:39 +0000571 return sizeof(int32_t);
572 }
573
574 /// Profile - Used to gather unique data for the value folding set.
575 ///
Jim Laskey5496f012006-11-09 14:52:14 +0000576 static void Profile(FoldingSetNodeID &ID, DIE *Entry) {
577 ID.AddInteger(isEntry);
578 ID.AddPointer(Entry);
579 }
Jim Laskeyef42a012006-11-02 20:12:39 +0000580 virtual void Profile(FoldingSetNodeID &ID) {
Jim Laskeyf6733882006-11-02 21:48:18 +0000581 ID.AddInteger(isEntry);
582
Jim Laskeyef42a012006-11-02 20:12:39 +0000583 if (Entry) {
584 ID.AddPointer(Entry);
585 } else {
586 ID.AddPointer(this);
587 }
588 }
589
590#ifndef NDEBUG
591 virtual void print(std::ostream &O) {
592 O << "Die: 0x" << std::hex << (intptr_t)Entry << std::dec;
593 }
594#endif
Jim Laskey0d086af2006-02-27 12:43:29 +0000595};
596
597//===----------------------------------------------------------------------===//
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000598/// DIEBlock - A block of values. Primarily used for location expressions.
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000599//
Jim Laskeyef42a012006-11-02 20:12:39 +0000600class DIEBlock : public DIEValue, public DIE {
601public:
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000602 unsigned Size; // Size in bytes excluding size header.
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000603
604 DIEBlock()
605 : DIEValue(isBlock)
Jim Laskeyef42a012006-11-02 20:12:39 +0000606 , DIE(0)
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000607 , Size(0)
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000608 {}
Jim Laskeyef42a012006-11-02 20:12:39 +0000609 ~DIEBlock() {
610 }
611
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000612 // Implement isa/cast/dyncast.
613 static bool classof(const DIEBlock *) { return true; }
614 static bool classof(const DIEValue *E) { return E->Type == isBlock; }
615
616 /// ComputeSize - calculate the size of the block.
617 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000618 unsigned ComputeSize(DwarfDebug &DD);
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000619
620 /// BestForm - Choose the best form for data.
621 ///
Jim Laskeyef42a012006-11-02 20:12:39 +0000622 unsigned BestForm() const {
623 if ((unsigned char)Size == Size) return DW_FORM_block1;
624 if ((unsigned short)Size == Size) return DW_FORM_block2;
625 if ((unsigned int)Size == Size) return DW_FORM_block4;
626 return DW_FORM_block;
627 }
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000628
629 /// EmitValue - Emit block data.
630 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000631 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000632
633 /// SizeOf - Determine size of block data in bytes.
634 ///
Jim Laskey072200c2007-01-29 18:51:14 +0000635 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
Jim Laskeyef42a012006-11-02 20:12:39 +0000636
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000637
Jim Laskeyef42a012006-11-02 20:12:39 +0000638 /// Profile - Used to gather unique data for the value folding set.
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000639 ///
Reid Spencer97821312006-11-02 23:56:21 +0000640 virtual void Profile(FoldingSetNodeID &ID) {
Jim Laskeyf6733882006-11-02 21:48:18 +0000641 ID.AddInteger(isBlock);
Jim Laskeyef42a012006-11-02 20:12:39 +0000642 DIE::Profile(ID);
643 }
644
645#ifndef NDEBUG
646 virtual void print(std::ostream &O) {
647 O << "Blk: ";
648 DIE::print(O, 5);
649 }
650#endif
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000651};
652
653//===----------------------------------------------------------------------===//
Jim Laskeyef42a012006-11-02 20:12:39 +0000654/// CompileUnit - This dwarf writer support class manages information associate
655/// with a source file.
656class CompileUnit {
Jim Laskey0d086af2006-02-27 12:43:29 +0000657private:
Jim Laskeyef42a012006-11-02 20:12:39 +0000658 /// Desc - Compile unit debug descriptor.
659 ///
660 CompileUnitDesc *Desc;
661
662 /// ID - File identifier for source.
663 ///
664 unsigned ID;
665
666 /// Die - Compile unit debug information entry.
667 ///
668 DIE *Die;
669
670 /// DescToDieMap - Tracks the mapping of unit level debug informaton
671 /// descriptors to debug information entries.
672 std::map<DebugInfoDesc *, DIE *> DescToDieMap;
673
674 /// DescToDIEntryMap - Tracks the mapping of unit level debug informaton
675 /// descriptors to debug information entries using a DIEntry proxy.
676 std::map<DebugInfoDesc *, DIEntry *> DescToDIEntryMap;
677
678 /// Globals - A map of globally visible named entities for this unit.
679 ///
680 std::map<std::string, DIE *> Globals;
681
682 /// DiesSet - Used to uniquely define dies within the compile unit.
683 ///
684 FoldingSet<DIE> DiesSet;
685
686 /// Dies - List of all dies in the compile unit.
687 ///
688 std::vector<DIE *> Dies;
Jim Laskey0d086af2006-02-27 12:43:29 +0000689
690public:
Jim Laskeyef42a012006-11-02 20:12:39 +0000691 CompileUnit(CompileUnitDesc *CUD, unsigned I, DIE *D)
692 : Desc(CUD)
693 , ID(I)
694 , Die(D)
695 , DescToDieMap()
696 , DescToDIEntryMap()
697 , Globals()
698 , DiesSet(InitDiesSetSize)
699 , Dies()
700 {}
701
702 ~CompileUnit() {
703 delete Die;
704
705 for (unsigned i = 0, N = Dies.size(); i < N; ++i)
706 delete Dies[i];
707 }
Jim Laskey0d086af2006-02-27 12:43:29 +0000708
Jim Laskeybd761842006-02-27 17:27:12 +0000709 // Accessors.
Jim Laskeyef42a012006-11-02 20:12:39 +0000710 CompileUnitDesc *getDesc() const { return Desc; }
711 unsigned getID() const { return ID; }
712 DIE* getDie() const { return Die; }
713 std::map<std::string, DIE *> &getGlobals() { return Globals; }
714
715 /// hasContent - Return true if this compile unit has something to write out.
716 ///
717 bool hasContent() const {
718 return !Die->getChildren().empty();
Jim Laskeya9c83fe2006-10-30 15:59:54 +0000719 }
Jim Laskeyef42a012006-11-02 20:12:39 +0000720
721 /// AddGlobal - Add a new global entity to the compile unit.
722 ///
723 void AddGlobal(const std::string &Name, DIE *Die) {
724 Globals[Name] = Die;
725 }
Jim Laskey0d086af2006-02-27 12:43:29 +0000726
Jim Laskeyef42a012006-11-02 20:12:39 +0000727 /// getDieMapSlotFor - Returns the debug information entry map slot for the
728 /// specified debug descriptor.
Jim Laskey072200c2007-01-29 18:51:14 +0000729 DIE *&getDieMapSlotFor(DebugInfoDesc *DID) {
730 return DescToDieMap[DID];
Jim Laskeyef42a012006-11-02 20:12:39 +0000731 }
Jim Laskeyb8509c52006-03-23 18:07:55 +0000732
Jim Laskeyef42a012006-11-02 20:12:39 +0000733 /// getDIEntrySlotFor - Returns the debug information entry proxy slot for the
734 /// specified debug descriptor.
Jim Laskey072200c2007-01-29 18:51:14 +0000735 DIEntry *&getDIEntrySlotFor(DebugInfoDesc *DID) {
736 return DescToDIEntryMap[DID];
Jim Laskeyef42a012006-11-02 20:12:39 +0000737 }
Jim Laskey0d086af2006-02-27 12:43:29 +0000738
Jim Laskeyef42a012006-11-02 20:12:39 +0000739 /// AddDie - Adds or interns the DIE to the compile unit.
740 ///
741 DIE *AddDie(DIE &Buffer) {
742 FoldingSetNodeID ID;
743 Buffer.Profile(ID);
744 void *Where;
745 DIE *Die = DiesSet.FindNodeOrInsertPos(ID, Where);
746
747 if (!Die) {
748 Die = new DIE(Buffer);
749 DiesSet.InsertNode(Die, Where);
750 this->Die->AddChild(Die);
751 Buffer.Detach();
752 }
753
754 return Die;
755 }
Jim Laskey0d086af2006-02-27 12:43:29 +0000756};
757
Jim Laskey65195462006-10-30 13:35:07 +0000758//===----------------------------------------------------------------------===//
Jim Laskey072200c2007-01-29 18:51:14 +0000759/// Dwarf - Emits general Dwarf directives.
Jim Laskeyef42a012006-11-02 20:12:39 +0000760///
Jim Laskey65195462006-10-30 13:35:07 +0000761class Dwarf {
762
Jim Laskey072200c2007-01-29 18:51:14 +0000763protected:
Jim Laskey65195462006-10-30 13:35:07 +0000764
765 //===--------------------------------------------------------------------===//
Jim Laskey072200c2007-01-29 18:51:14 +0000766 // Core attributes used by the Dwarf writer.
Jim Laskey65195462006-10-30 13:35:07 +0000767 //
768
769 //
770 /// O - Stream to .s file.
771 ///
772 std::ostream &O;
773
774 /// Asm - Target of Dwarf emission.
775 ///
776 AsmPrinter *Asm;
777
778 /// TAI - Target Asm Printer.
779 const TargetAsmInfo *TAI;
780
781 /// TD - Target data.
782 const TargetData *TD;
783
784 /// RI - Register Information.
Dan Gohman6f0d0242008-02-10 18:45:23 +0000785 const TargetRegisterInfo *RI;
Jim Laskey65195462006-10-30 13:35:07 +0000786
787 /// M - Current module.
788 ///
789 Module *M;
790
791 /// MF - Current machine function.
792 ///
793 MachineFunction *MF;
794
Jim Laskey44c3b9f2007-01-26 21:22:28 +0000795 /// MMI - Collected machine module information.
Jim Laskey65195462006-10-30 13:35:07 +0000796 ///
Jim Laskey44c3b9f2007-01-26 21:22:28 +0000797 MachineModuleInfo *MMI;
Jim Laskey65195462006-10-30 13:35:07 +0000798
Jim Laskey65195462006-10-30 13:35:07 +0000799 /// SubprogramCount - The running count of functions being compiled.
800 ///
801 unsigned SubprogramCount;
Chris Lattner9251f132007-09-24 03:35:37 +0000802
803 /// Flavor - A unique string indicating what dwarf producer this is, used to
804 /// unique labels.
805 const char * const Flavor;
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000806
807 unsigned SetCounter;
Chris Lattner9251f132007-09-24 03:35:37 +0000808 Dwarf(std::ostream &OS, AsmPrinter *A, const TargetAsmInfo *T,
809 const char *flavor)
Jim Laskey072200c2007-01-29 18:51:14 +0000810 : O(OS)
811 , Asm(A)
812 , TAI(T)
813 , TD(Asm->TM.getTargetData())
814 , RI(Asm->TM.getRegisterInfo())
815 , M(NULL)
816 , MF(NULL)
817 , MMI(NULL)
Jim Laskey072200c2007-01-29 18:51:14 +0000818 , SubprogramCount(0)
Chris Lattner9251f132007-09-24 03:35:37 +0000819 , Flavor(flavor)
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000820 , SetCounter(1)
Jim Laskey072200c2007-01-29 18:51:14 +0000821 {
822 }
823
824public:
825
826 //===--------------------------------------------------------------------===//
827 // Accessors.
828 //
829 AsmPrinter *getAsm() const { return Asm; }
Jim Laskeyb82313f2007-02-01 16:31:34 +0000830 MachineModuleInfo *getMMI() const { return MMI; }
Jim Laskey072200c2007-01-29 18:51:14 +0000831 const TargetAsmInfo *getTargetAsmInfo() const { return TAI; }
Dan Gohman82482942007-09-27 23:12:31 +0000832 const TargetData *getTargetData() const { return TD; }
Jim Laskey072200c2007-01-29 18:51:14 +0000833
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000834 void PrintRelDirective(bool Force32Bit = false, bool isInSection = false)
835 const {
836 if (isInSection && TAI->getDwarfSectionOffsetDirective())
837 O << TAI->getDwarfSectionOffsetDirective();
Dan Gohman82482942007-09-27 23:12:31 +0000838 else if (Force32Bit || TD->getPointerSize() == sizeof(int32_t))
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000839 O << TAI->getData32bitsDirective();
840 else
841 O << TAI->getData64bitsDirective();
842 }
843
Jim Laskeyb82313f2007-02-01 16:31:34 +0000844 /// PrintLabelName - Print label name in form used by Dwarf writer.
845 ///
846 void PrintLabelName(DWLabel Label) const {
847 PrintLabelName(Label.Tag, Label.Number);
848 }
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000849 void PrintLabelName(const char *Tag, unsigned Number) const {
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000850 O << TAI->getPrivateGlobalPrefix() << Tag;
Jim Laskeyb82313f2007-02-01 16:31:34 +0000851 if (Number) O << Number;
852 }
853
Chris Lattner9251f132007-09-24 03:35:37 +0000854 void PrintLabelName(const char *Tag, unsigned Number,
855 const char *Suffix) const {
856 O << TAI->getPrivateGlobalPrefix() << Tag;
857 if (Number) O << Number;
858 O << Suffix;
859 }
860
Jim Laskeyb82313f2007-02-01 16:31:34 +0000861 /// EmitLabel - Emit location label for internal use by Dwarf.
862 ///
863 void EmitLabel(DWLabel Label) const {
864 EmitLabel(Label.Tag, Label.Number);
865 }
866 void EmitLabel(const char *Tag, unsigned Number) const {
867 PrintLabelName(Tag, Number);
868 O << ":\n";
869 }
870
871 /// EmitReference - Emit a reference to a label.
872 ///
Dan Gohman06ff4e62007-09-28 15:43:33 +0000873 void EmitReference(DWLabel Label, bool IsPCRelative = false,
874 bool Force32Bit = false) const {
875 EmitReference(Label.Tag, Label.Number, IsPCRelative, Force32Bit);
Jim Laskeyb82313f2007-02-01 16:31:34 +0000876 }
877 void EmitReference(const char *Tag, unsigned Number,
Dan Gohman06ff4e62007-09-28 15:43:33 +0000878 bool IsPCRelative = false, bool Force32Bit = false) const {
879 PrintRelDirective(Force32Bit);
Jim Laskeyb82313f2007-02-01 16:31:34 +0000880 PrintLabelName(Tag, Number);
881
882 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
883 }
Dan Gohman06ff4e62007-09-28 15:43:33 +0000884 void EmitReference(const std::string &Name, bool IsPCRelative = false,
885 bool Force32Bit = false) const {
886 PrintRelDirective(Force32Bit);
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000887
Jim Laskeyb82313f2007-02-01 16:31:34 +0000888 O << Name;
889
890 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
891 }
892
893 /// EmitDifference - Emit the difference between two labels. Some
894 /// assemblers do not behave with absolute expressions with data directives,
895 /// so there is an option (needsSet) to use an intermediary set expression.
896 void EmitDifference(DWLabel LabelHi, DWLabel LabelLo,
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000897 bool IsSmall = false) {
Jim Laskeyb82313f2007-02-01 16:31:34 +0000898 EmitDifference(LabelHi.Tag, LabelHi.Number,
899 LabelLo.Tag, LabelLo.Number,
900 IsSmall);
901 }
902 void EmitDifference(const char *TagHi, unsigned NumberHi,
903 const char *TagLo, unsigned NumberLo,
Anton Korobeynikov6a143592007-03-07 08:25:02 +0000904 bool IsSmall = false) {
Jim Laskeyb82313f2007-02-01 16:31:34 +0000905 if (TAI->needsSet()) {
Jim Laskeyb82313f2007-02-01 16:31:34 +0000906 O << "\t.set\t";
Chris Lattner9251f132007-09-24 03:35:37 +0000907 PrintLabelName("set", SetCounter, Flavor);
Jim Laskeyb82313f2007-02-01 16:31:34 +0000908 O << ",";
909 PrintLabelName(TagHi, NumberHi);
910 O << "-";
911 PrintLabelName(TagLo, NumberLo);
912 O << "\n";
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000913
914 PrintRelDirective(IsSmall);
Chris Lattner9251f132007-09-24 03:35:37 +0000915 PrintLabelName("set", SetCounter, Flavor);
Jim Laskeyb82313f2007-02-01 16:31:34 +0000916 ++SetCounter;
917 } else {
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000918 PrintRelDirective(IsSmall);
Jim Laskeyb82313f2007-02-01 16:31:34 +0000919
920 PrintLabelName(TagHi, NumberHi);
921 O << "-";
922 PrintLabelName(TagLo, NumberLo);
923 }
924 }
Anton Korobeynikova6199c82007-03-07 02:47:57 +0000925
926 void EmitSectionOffset(const char* Label, const char* Section,
927 unsigned LabelNumber, unsigned SectionNumber,
Dale Johannesend9ffd4c2008-03-26 23:31:39 +0000928 bool IsSmall = false, bool isEH = false,
929 bool useSet = true) {
Anton Korobeynikov79dda2b2007-05-01 22:23:12 +0000930 bool printAbsolute = false;
Dale Johannesend9ffd4c2008-03-26 23:31:39 +0000931 if (isEH)
932 printAbsolute = TAI->isAbsoluteEHSectionOffsets();
933 else
934 printAbsolute = TAI->isAbsoluteDebugSectionOffsets();
935
936 if (TAI->needsSet() && useSet) {
Anton Korobeynikova6199c82007-03-07 02:47:57 +0000937 O << "\t.set\t";
Chris Lattner9251f132007-09-24 03:35:37 +0000938 PrintLabelName("set", SetCounter, Flavor);
Anton Korobeynikova6199c82007-03-07 02:47:57 +0000939 O << ",";
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000940 PrintLabelName(Label, LabelNumber);
Anton Korobeynikov79dda2b2007-05-01 22:23:12 +0000941
Anton Korobeynikov79dda2b2007-05-01 22:23:12 +0000942 if (!printAbsolute) {
Anton Korobeynikova6199c82007-03-07 02:47:57 +0000943 O << "-";
944 PrintLabelName(Section, SectionNumber);
945 }
946 O << "\n";
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000947
948 PrintRelDirective(IsSmall);
Anton Korobeynikova6199c82007-03-07 02:47:57 +0000949
Chris Lattner9251f132007-09-24 03:35:37 +0000950 PrintLabelName("set", SetCounter, Flavor);
Anton Korobeynikova6199c82007-03-07 02:47:57 +0000951 ++SetCounter;
952 } else {
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000953 PrintRelDirective(IsSmall, true);
Anton Korobeynikova6199c82007-03-07 02:47:57 +0000954
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +0000955 PrintLabelName(Label, LabelNumber);
Anton Korobeynikov79dda2b2007-05-01 22:23:12 +0000956
Anton Korobeynikov79dda2b2007-05-01 22:23:12 +0000957 if (!printAbsolute) {
Anton Korobeynikova6199c82007-03-07 02:47:57 +0000958 O << "-";
959 PrintLabelName(Section, SectionNumber);
960 }
961 }
962 }
963
Jim Laskeyb82313f2007-02-01 16:31:34 +0000964 /// EmitFrameMoves - Emit frame instructions to describe the layout of the
965 /// frame.
966 void EmitFrameMoves(const char *BaseLabel, unsigned BaseLabelID,
Dale Johannesenb97aec62007-11-13 19:13:01 +0000967 const std::vector<MachineMove> &Moves, bool isEH) {
Jim Laskeyb82313f2007-02-01 16:31:34 +0000968 int stackGrowth =
969 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
970 TargetFrameInfo::StackGrowsUp ?
Dan Gohman82482942007-09-27 23:12:31 +0000971 TD->getPointerSize() : -TD->getPointerSize();
Jim Laskeybacd3042007-02-21 22:48:45 +0000972 bool IsLocal = BaseLabel && strcmp(BaseLabel, "label") == 0;
Jim Laskeyb82313f2007-02-01 16:31:34 +0000973
974 for (unsigned i = 0, N = Moves.size(); i < N; ++i) {
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +0000975 const MachineMove &Move = Moves[i];
Jim Laskeyb82313f2007-02-01 16:31:34 +0000976 unsigned LabelID = Move.getLabelID();
977
978 if (LabelID) {
979 LabelID = MMI->MappedLabel(LabelID);
980
981 // Throw out move if the label is invalid.
982 if (!LabelID) continue;
983 }
984
985 const MachineLocation &Dst = Move.getDestination();
986 const MachineLocation &Src = Move.getSource();
987
988 // Advance row if new location.
989 if (BaseLabel && LabelID && (BaseLabelID != LabelID || !IsLocal)) {
990 Asm->EmitInt8(DW_CFA_advance_loc4);
991 Asm->EOL("DW_CFA_advance_loc4");
Jim Laskeybacd3042007-02-21 22:48:45 +0000992 EmitDifference("label", LabelID, BaseLabel, BaseLabelID, true);
993 Asm->EOL();
Jim Laskeyb82313f2007-02-01 16:31:34 +0000994
995 BaseLabelID = LabelID;
Jim Laskeybacd3042007-02-21 22:48:45 +0000996 BaseLabel = "label";
Jim Laskeyb82313f2007-02-01 16:31:34 +0000997 IsLocal = true;
998 }
999
1000 // If advancing cfa.
1001 if (Dst.isRegister() && Dst.getRegister() == MachineLocation::VirtualFP) {
1002 if (!Src.isRegister()) {
1003 if (Src.getRegister() == MachineLocation::VirtualFP) {
1004 Asm->EmitInt8(DW_CFA_def_cfa_offset);
1005 Asm->EOL("DW_CFA_def_cfa_offset");
1006 } else {
1007 Asm->EmitInt8(DW_CFA_def_cfa);
1008 Asm->EOL("DW_CFA_def_cfa");
Dale Johannesenb97aec62007-11-13 19:13:01 +00001009 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Src.getRegister(), isEH));
Jim Laskeyb82313f2007-02-01 16:31:34 +00001010 Asm->EOL("Register");
1011 }
1012
1013 int Offset = -Src.getOffset();
1014
1015 Asm->EmitULEB128Bytes(Offset);
1016 Asm->EOL("Offset");
1017 } else {
1018 assert(0 && "Machine move no supported yet.");
1019 }
1020 } else if (Src.isRegister() &&
1021 Src.getRegister() == MachineLocation::VirtualFP) {
1022 if (Dst.isRegister()) {
1023 Asm->EmitInt8(DW_CFA_def_cfa_register);
1024 Asm->EOL("DW_CFA_def_cfa_register");
Dale Johannesenb97aec62007-11-13 19:13:01 +00001025 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Dst.getRegister(), isEH));
Jim Laskeyb82313f2007-02-01 16:31:34 +00001026 Asm->EOL("Register");
1027 } else {
1028 assert(0 && "Machine move no supported yet.");
1029 }
1030 } else {
Dale Johannesenb97aec62007-11-13 19:13:01 +00001031 unsigned Reg = RI->getDwarfRegNum(Src.getRegister(), isEH);
Jim Laskeyb82313f2007-02-01 16:31:34 +00001032 int Offset = Dst.getOffset() / stackGrowth;
1033
1034 if (Offset < 0) {
1035 Asm->EmitInt8(DW_CFA_offset_extended_sf);
1036 Asm->EOL("DW_CFA_offset_extended_sf");
1037 Asm->EmitULEB128Bytes(Reg);
1038 Asm->EOL("Reg");
1039 Asm->EmitSLEB128Bytes(Offset);
1040 Asm->EOL("Offset");
1041 } else if (Reg < 64) {
1042 Asm->EmitInt8(DW_CFA_offset + Reg);
Anton Korobeynikov59db3ec2007-07-25 00:06:28 +00001043 Asm->EOL("DW_CFA_offset + Reg (" + utostr(Reg) + ")");
Jim Laskeyb82313f2007-02-01 16:31:34 +00001044 Asm->EmitULEB128Bytes(Offset);
1045 Asm->EOL("Offset");
1046 } else {
1047 Asm->EmitInt8(DW_CFA_offset_extended);
1048 Asm->EOL("DW_CFA_offset_extended");
1049 Asm->EmitULEB128Bytes(Reg);
1050 Asm->EOL("Reg");
1051 Asm->EmitULEB128Bytes(Offset);
1052 Asm->EOL("Offset");
1053 }
1054 }
1055 }
1056 }
1057
Jim Laskey072200c2007-01-29 18:51:14 +00001058};
1059
1060//===----------------------------------------------------------------------===//
1061/// DwarfDebug - Emits Dwarf debug directives.
1062///
1063class DwarfDebug : public Dwarf {
1064
1065private:
Jim Laskey65195462006-10-30 13:35:07 +00001066 //===--------------------------------------------------------------------===//
1067 // Attributes used to construct specific Dwarf sections.
1068 //
1069
1070 /// CompileUnits - All the compile units involved in this build. The index
Jim Laskey44c3b9f2007-01-26 21:22:28 +00001071 /// of each entry in this vector corresponds to the sources in MMI.
Jim Laskey65195462006-10-30 13:35:07 +00001072 std::vector<CompileUnit *> CompileUnits;
Jim Laskeya9c83fe2006-10-30 15:59:54 +00001073
Jim Laskeyef42a012006-11-02 20:12:39 +00001074 /// AbbreviationsSet - Used to uniquely define abbreviations.
Jim Laskey65195462006-10-30 13:35:07 +00001075 ///
Jim Laskeya9c83fe2006-10-30 15:59:54 +00001076 FoldingSet<DIEAbbrev> AbbreviationsSet;
1077
1078 /// Abbreviations - A list of all the unique abbreviations in use.
1079 ///
1080 std::vector<DIEAbbrev *> Abbreviations;
Jim Laskey65195462006-10-30 13:35:07 +00001081
Jim Laskeyef42a012006-11-02 20:12:39 +00001082 /// ValuesSet - Used to uniquely define values.
1083 ///
1084 FoldingSet<DIEValue> ValuesSet;
1085
1086 /// Values - A list of all the unique values in use.
1087 ///
1088 std::vector<DIEValue *> Values;
1089
Jim Laskey65195462006-10-30 13:35:07 +00001090 /// StringPool - A UniqueVector of strings used by indirect references.
Jim Laskeyef42a012006-11-02 20:12:39 +00001091 ///
Jim Laskey65195462006-10-30 13:35:07 +00001092 UniqueVector<std::string> StringPool;
1093
1094 /// UnitMap - Map debug information descriptor to compile unit.
1095 ///
1096 std::map<DebugInfoDesc *, CompileUnit *> DescToUnitMap;
1097
Jim Laskey65195462006-10-30 13:35:07 +00001098 /// SectionMap - Provides a unique id per text section.
1099 ///
1100 UniqueVector<std::string> SectionMap;
1101
1102 /// SectionSourceLines - Tracks line numbers per text section.
1103 ///
1104 std::vector<std::vector<SourceLineInfo> > SectionSourceLines;
1105
Jim Laskeybacd3042007-02-21 22:48:45 +00001106 /// didInitial - Flag to indicate if initial emission has been done.
1107 ///
1108 bool didInitial;
1109
1110 /// shouldEmit - Flag to indicate if debug information should be emitted.
1111 ///
1112 bool shouldEmit;
Jim Laskey65195462006-10-30 13:35:07 +00001113
Anton Korobeynikov185bc892007-05-13 17:30:11 +00001114 struct FunctionDebugFrameInfo {
1115 unsigned Number;
1116 std::vector<MachineMove> Moves;
1117
1118 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M):
Dan Gohman81975f62007-08-27 14:50:10 +00001119 Number(Num), Moves(M) { }
Anton Korobeynikov185bc892007-05-13 17:30:11 +00001120 };
1121
1122 std::vector<FunctionDebugFrameInfo> DebugFrames;
1123
Jim Laskey65195462006-10-30 13:35:07 +00001124public:
Jim Laskeybacd3042007-02-21 22:48:45 +00001125
1126 /// ShouldEmitDwarf - Returns true if Dwarf declarations should be made.
1127 ///
1128 bool ShouldEmitDwarf() const { return shouldEmit; }
Jim Laskey65195462006-10-30 13:35:07 +00001129
Jim Laskeya9c83fe2006-10-30 15:59:54 +00001130 /// AssignAbbrevNumber - Define a unique number for the abbreviation.
Jim Laskey65195462006-10-30 13:35:07 +00001131 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00001132 void AssignAbbrevNumber(DIEAbbrev &Abbrev) {
1133 // Profile the node so that we can make it unique.
1134 FoldingSetNodeID ID;
1135 Abbrev.Profile(ID);
1136
1137 // Check the set for priors.
1138 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
1139
1140 // If it's newly added.
1141 if (InSet == &Abbrev) {
1142 // Add to abbreviation list.
1143 Abbreviations.push_back(&Abbrev);
1144 // Assign the vector position + 1 as its number.
1145 Abbrev.setNumber(Abbreviations.size());
1146 } else {
1147 // Assign existing abbreviation number.
1148 Abbrev.setNumber(InSet->getNumber());
1149 }
1150 }
1151
Jim Laskey65195462006-10-30 13:35:07 +00001152 /// NewString - Add a string to the constant pool and returns a label.
1153 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00001154 DWLabel NewString(const std::string &String) {
1155 unsigned StringID = StringPool.insert(String);
1156 return DWLabel("string", StringID);
1157 }
Jim Laskey65195462006-10-30 13:35:07 +00001158
Jim Laskeyef42a012006-11-02 20:12:39 +00001159 /// NewDIEntry - Creates a new DIEntry to be a proxy for a debug information
1160 /// entry.
1161 DIEntry *NewDIEntry(DIE *Entry = NULL) {
1162 DIEntry *Value;
1163
1164 if (Entry) {
1165 FoldingSetNodeID ID;
Jim Laskey5496f012006-11-09 14:52:14 +00001166 DIEntry::Profile(ID, Entry);
Jim Laskeyef42a012006-11-02 20:12:39 +00001167 void *Where;
1168 Value = static_cast<DIEntry *>(ValuesSet.FindNodeOrInsertPos(ID, Where));
1169
Jim Laskeyf6733882006-11-02 21:48:18 +00001170 if (Value) return Value;
Jim Laskeyef42a012006-11-02 20:12:39 +00001171
1172 Value = new DIEntry(Entry);
1173 ValuesSet.InsertNode(Value, Where);
1174 } else {
1175 Value = new DIEntry(Entry);
1176 }
1177
1178 Values.push_back(Value);
1179 return Value;
1180 }
1181
1182 /// SetDIEntry - Set a DIEntry once the debug information entry is defined.
1183 ///
1184 void SetDIEntry(DIEntry *Value, DIE *Entry) {
1185 Value->Entry = Entry;
1186 // Add to values set if not already there. If it is, we merely have a
1187 // duplicate in the values list (no harm.)
1188 ValuesSet.GetOrInsertNode(Value);
1189 }
1190
1191 /// AddUInt - Add an unsigned integer attribute data and value.
1192 ///
1193 void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer) {
1194 if (!Form) Form = DIEInteger::BestForm(false, Integer);
1195
1196 FoldingSetNodeID ID;
Jim Laskey5496f012006-11-09 14:52:14 +00001197 DIEInteger::Profile(ID, Integer);
Jim Laskeyef42a012006-11-02 20:12:39 +00001198 void *Where;
1199 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1200 if (!Value) {
1201 Value = new DIEInteger(Integer);
1202 ValuesSet.InsertNode(Value, Where);
1203 Values.push_back(Value);
Jim Laskeyef42a012006-11-02 20:12:39 +00001204 }
1205
1206 Die->AddValue(Attribute, Form, Value);
1207 }
1208
1209 /// AddSInt - Add an signed integer attribute data and value.
1210 ///
1211 void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer) {
1212 if (!Form) Form = DIEInteger::BestForm(true, Integer);
1213
1214 FoldingSetNodeID ID;
Jim Laskey5496f012006-11-09 14:52:14 +00001215 DIEInteger::Profile(ID, (uint64_t)Integer);
Jim Laskeyef42a012006-11-02 20:12:39 +00001216 void *Where;
1217 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1218 if (!Value) {
1219 Value = new DIEInteger(Integer);
1220 ValuesSet.InsertNode(Value, Where);
1221 Values.push_back(Value);
Jim Laskeyef42a012006-11-02 20:12:39 +00001222 }
1223
1224 Die->AddValue(Attribute, Form, Value);
1225 }
1226
1227 /// AddString - Add a std::string attribute data and value.
1228 ///
1229 void AddString(DIE *Die, unsigned Attribute, unsigned Form,
1230 const std::string &String) {
1231 FoldingSetNodeID ID;
Jim Laskey5496f012006-11-09 14:52:14 +00001232 DIEString::Profile(ID, String);
Jim Laskeyef42a012006-11-02 20:12:39 +00001233 void *Where;
1234 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1235 if (!Value) {
1236 Value = new DIEString(String);
1237 ValuesSet.InsertNode(Value, Where);
1238 Values.push_back(Value);
Jim Laskeyef42a012006-11-02 20:12:39 +00001239 }
1240
1241 Die->AddValue(Attribute, Form, Value);
1242 }
1243
1244 /// AddLabel - Add a Dwarf label attribute data and value.
1245 ///
1246 void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
1247 const DWLabel &Label) {
1248 FoldingSetNodeID ID;
Jim Laskey5496f012006-11-09 14:52:14 +00001249 DIEDwarfLabel::Profile(ID, Label);
Jim Laskeyef42a012006-11-02 20:12:39 +00001250 void *Where;
1251 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1252 if (!Value) {
1253 Value = new DIEDwarfLabel(Label);
1254 ValuesSet.InsertNode(Value, Where);
1255 Values.push_back(Value);
Jim Laskeyef42a012006-11-02 20:12:39 +00001256 }
1257
1258 Die->AddValue(Attribute, Form, Value);
1259 }
1260
1261 /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
1262 ///
1263 void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
1264 const std::string &Label) {
1265 FoldingSetNodeID ID;
Jim Laskey5496f012006-11-09 14:52:14 +00001266 DIEObjectLabel::Profile(ID, Label);
Jim Laskeyef42a012006-11-02 20:12:39 +00001267 void *Where;
1268 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1269 if (!Value) {
1270 Value = new DIEObjectLabel(Label);
1271 ValuesSet.InsertNode(Value, Where);
1272 Values.push_back(Value);
Jim Laskeyef42a012006-11-02 20:12:39 +00001273 }
1274
1275 Die->AddValue(Attribute, Form, Value);
1276 }
1277
1278 /// AddDelta - Add a label delta attribute data and value.
1279 ///
1280 void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
1281 const DWLabel &Hi, const DWLabel &Lo) {
1282 FoldingSetNodeID ID;
Jim Laskey5496f012006-11-09 14:52:14 +00001283 DIEDelta::Profile(ID, Hi, Lo);
Jim Laskeyef42a012006-11-02 20:12:39 +00001284 void *Where;
1285 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1286 if (!Value) {
1287 Value = new DIEDelta(Hi, Lo);
1288 ValuesSet.InsertNode(Value, Where);
1289 Values.push_back(Value);
Jim Laskeyef42a012006-11-02 20:12:39 +00001290 }
1291
1292 Die->AddValue(Attribute, Form, Value);
1293 }
1294
1295 /// AddDIEntry - Add a DIE attribute data and value.
1296 ///
1297 void AddDIEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
1298 Die->AddValue(Attribute, Form, NewDIEntry(Entry));
1299 }
1300
1301 /// AddBlock - Add block data.
1302 ///
1303 void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block) {
1304 Block->ComputeSize(*this);
1305 FoldingSetNodeID ID;
1306 Block->Profile(ID);
1307 void *Where;
1308 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1309 if (!Value) {
1310 Value = Block;
1311 ValuesSet.InsertNode(Value, Where);
1312 Values.push_back(Value);
1313 } else {
Chris Lattnerc369bd72007-09-21 18:25:53 +00001314 // Already exists, reuse the previous one.
Jim Laskeyef42a012006-11-02 20:12:39 +00001315 delete Block;
Chris Lattnerc369bd72007-09-21 18:25:53 +00001316 Block = cast<DIEBlock>(Value);
Jim Laskeyef42a012006-11-02 20:12:39 +00001317 }
1318
1319 Die->AddValue(Attribute, Block->BestForm(), Value);
1320 }
1321
Jim Laskey65195462006-10-30 13:35:07 +00001322private:
1323
1324 /// AddSourceLine - Add location information to specified debug information
Jim Laskeyef42a012006-11-02 20:12:39 +00001325 /// entry.
1326 void AddSourceLine(DIE *Die, CompileUnitDesc *File, unsigned Line) {
1327 if (File && Line) {
1328 CompileUnit *FileUnit = FindCompileUnit(File);
1329 unsigned FileID = FileUnit->getID();
1330 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1331 AddUInt(Die, DW_AT_decl_line, 0, Line);
1332 }
1333 }
Jim Laskey65195462006-10-30 13:35:07 +00001334
1335 /// AddAddress - Add an address attribute to a die based on the location
1336 /// provided.
1337 void AddAddress(DIE *Die, unsigned Attribute,
Jim Laskeyef42a012006-11-02 20:12:39 +00001338 const MachineLocation &Location) {
Dale Johannesenb97aec62007-11-13 19:13:01 +00001339 unsigned Reg = RI->getDwarfRegNum(Location.getRegister(), false);
Jim Laskeyef42a012006-11-02 20:12:39 +00001340 DIEBlock *Block = new DIEBlock();
1341
1342 if (Location.isRegister()) {
1343 if (Reg < 32) {
1344 AddUInt(Block, 0, DW_FORM_data1, DW_OP_reg0 + Reg);
1345 } else {
1346 AddUInt(Block, 0, DW_FORM_data1, DW_OP_regx);
1347 AddUInt(Block, 0, DW_FORM_udata, Reg);
1348 }
1349 } else {
1350 if (Reg < 32) {
1351 AddUInt(Block, 0, DW_FORM_data1, DW_OP_breg0 + Reg);
1352 } else {
1353 AddUInt(Block, 0, DW_FORM_data1, DW_OP_bregx);
1354 AddUInt(Block, 0, DW_FORM_udata, Reg);
1355 }
1356 AddUInt(Block, 0, DW_FORM_sdata, Location.getOffset());
1357 }
1358
1359 AddBlock(Die, Attribute, 0, Block);
1360 }
1361
1362 /// AddBasicType - Add a new basic type attribute to the specified entity.
1363 ///
1364 void AddBasicType(DIE *Entity, CompileUnit *Unit,
1365 const std::string &Name,
1366 unsigned Encoding, unsigned Size) {
1367 DIE *Die = ConstructBasicType(Unit, Name, Encoding, Size);
1368 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, Die);
1369 }
1370
1371 /// ConstructBasicType - Construct a new basic type.
1372 ///
1373 DIE *ConstructBasicType(CompileUnit *Unit,
1374 const std::string &Name,
1375 unsigned Encoding, unsigned Size) {
1376 DIE Buffer(DW_TAG_base_type);
1377 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1378 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, Encoding);
1379 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1380 return Unit->AddDie(Buffer);
1381 }
1382
1383 /// AddPointerType - Add a new pointer type attribute to the specified entity.
1384 ///
1385 void AddPointerType(DIE *Entity, CompileUnit *Unit, const std::string &Name) {
1386 DIE *Die = ConstructPointerType(Unit, Name);
1387 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, Die);
1388 }
1389
1390 /// ConstructPointerType - Construct a new pointer type.
1391 ///
1392 DIE *ConstructPointerType(CompileUnit *Unit, const std::string &Name) {
1393 DIE Buffer(DW_TAG_pointer_type);
Dan Gohman82482942007-09-27 23:12:31 +00001394 AddUInt(&Buffer, DW_AT_byte_size, 0, TD->getPointerSize());
Jim Laskeyef42a012006-11-02 20:12:39 +00001395 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1396 return Unit->AddDie(Buffer);
1397 }
1398
1399 /// AddType - Add a new type attribute to the specified entity.
1400 ///
1401 void AddType(DIE *Entity, TypeDesc *TyDesc, CompileUnit *Unit) {
1402 if (!TyDesc) {
Jim Laskey2b935d52007-01-26 14:19:17 +00001403 AddBasicType(Entity, Unit, "", DW_ATE_signed, sizeof(int32_t));
Jim Laskeyef42a012006-11-02 20:12:39 +00001404 } else {
1405 // Check for pre-existence.
1406 DIEntry *&Slot = Unit->getDIEntrySlotFor(TyDesc);
1407
1408 // If it exists then use the existing value.
1409 if (Slot) {
Jim Laskeyef42a012006-11-02 20:12:39 +00001410 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1411 return;
1412 }
1413
1414 if (SubprogramDesc *SubprogramTy = dyn_cast<SubprogramDesc>(TyDesc)) {
1415 // FIXME - Not sure why programs and variables are coming through here.
1416 // Short cut for handling subprogram types (not really a TyDesc.)
1417 AddPointerType(Entity, Unit, SubprogramTy->getName());
1418 } else if (GlobalVariableDesc *GlobalTy =
1419 dyn_cast<GlobalVariableDesc>(TyDesc)) {
1420 // FIXME - Not sure why programs and variables are coming through here.
1421 // Short cut for handling global variable types (not really a TyDesc.)
1422 AddPointerType(Entity, Unit, GlobalTy->getName());
1423 } else {
1424 // Set up proxy.
1425 Slot = NewDIEntry();
1426
1427 // Construct type.
1428 DIE Buffer(DW_TAG_base_type);
1429 ConstructType(Buffer, TyDesc, Unit);
1430
1431 // Add debug information entry to entity and unit.
1432 DIE *Die = Unit->AddDie(Buffer);
1433 SetDIEntry(Slot, Die);
1434 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1435 }
1436 }
1437 }
1438
1439 /// ConstructType - Adds all the required attributes to the type.
1440 ///
1441 void ConstructType(DIE &Buffer, TypeDesc *TyDesc, CompileUnit *Unit) {
1442 // Get core information.
1443 const std::string &Name = TyDesc->getName();
1444 uint64_t Size = TyDesc->getSize() >> 3;
1445
1446 if (BasicTypeDesc *BasicTy = dyn_cast<BasicTypeDesc>(TyDesc)) {
1447 // Fundamental types like int, float, bool
1448 Buffer.setTag(DW_TAG_base_type);
1449 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, BasicTy->getEncoding());
1450 } else if (DerivedTypeDesc *DerivedTy = dyn_cast<DerivedTypeDesc>(TyDesc)) {
Jim Laskey85f419b2006-11-09 16:32:26 +00001451 // Fetch tag.
1452 unsigned Tag = DerivedTy->getTag();
1453 // FIXME - Workaround for templates.
1454 if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
1455 // Pointers, typedefs et al.
1456 Buffer.setTag(Tag);
Jim Laskeyef42a012006-11-02 20:12:39 +00001457 // Map to main type, void will not have a type.
1458 if (TypeDesc *FromTy = DerivedTy->getFromType())
1459 AddType(&Buffer, FromTy, Unit);
1460 } else if (CompositeTypeDesc *CompTy = dyn_cast<CompositeTypeDesc>(TyDesc)){
1461 // Fetch tag.
1462 unsigned Tag = CompTy->getTag();
1463
1464 // Set tag accordingly.
1465 if (Tag == DW_TAG_vector_type)
1466 Buffer.setTag(DW_TAG_array_type);
1467 else
1468 Buffer.setTag(Tag);
Jim Laskey65195462006-10-30 13:35:07 +00001469
Jim Laskeyef42a012006-11-02 20:12:39 +00001470 std::vector<DebugInfoDesc *> &Elements = CompTy->getElements();
1471
1472 switch (Tag) {
1473 case DW_TAG_vector_type:
1474 AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1475 // Fall thru
1476 case DW_TAG_array_type: {
1477 // Add element type.
1478 if (TypeDesc *FromTy = CompTy->getFromType())
1479 AddType(&Buffer, FromTy, Unit);
1480
1481 // Don't emit size attribute.
1482 Size = 0;
1483
1484 // Construct an anonymous type for index type.
Jim Laskey2b935d52007-01-26 14:19:17 +00001485 DIE *IndexTy = ConstructBasicType(Unit, "", DW_ATE_signed,
1486 sizeof(int32_t));
Jim Laskeyef42a012006-11-02 20:12:39 +00001487
1488 // Add subranges to array type.
1489 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1490 SubrangeDesc *SRD = cast<SubrangeDesc>(Elements[i]);
1491 int64_t Lo = SRD->getLo();
1492 int64_t Hi = SRD->getHi();
1493 DIE *Subrange = new DIE(DW_TAG_subrange_type);
1494
1495 // If a range is available.
1496 if (Lo != Hi) {
1497 AddDIEntry(Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1498 // Only add low if non-zero.
1499 if (Lo) AddSInt(Subrange, DW_AT_lower_bound, 0, Lo);
1500 AddSInt(Subrange, DW_AT_upper_bound, 0, Hi);
1501 }
1502
1503 Buffer.AddChild(Subrange);
1504 }
1505 break;
1506 }
1507 case DW_TAG_structure_type:
1508 case DW_TAG_union_type: {
1509 // Add elements to structure type.
1510 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1511 DebugInfoDesc *Element = Elements[i];
1512
1513 if (DerivedTypeDesc *MemberDesc = dyn_cast<DerivedTypeDesc>(Element)){
1514 // Add field or base class.
1515
1516 unsigned Tag = MemberDesc->getTag();
1517
1518 // Extract the basic information.
1519 const std::string &Name = MemberDesc->getName();
Jim Laskeyef42a012006-11-02 20:12:39 +00001520 uint64_t Size = MemberDesc->getSize();
1521 uint64_t Align = MemberDesc->getAlign();
1522 uint64_t Offset = MemberDesc->getOffset();
1523
1524 // Construct member debug information entry.
1525 DIE *Member = new DIE(Tag);
1526
1527 // Add name if not "".
1528 if (!Name.empty())
1529 AddString(Member, DW_AT_name, DW_FORM_string, Name);
1530 // Add location if available.
1531 AddSourceLine(Member, MemberDesc->getFile(), MemberDesc->getLine());
1532
1533 // Most of the time the field info is the same as the members.
1534 uint64_t FieldSize = Size;
1535 uint64_t FieldAlign = Align;
1536 uint64_t FieldOffset = Offset;
1537
Jim Laskeyee5f9272006-12-22 20:03:42 +00001538 // Set the member type.
1539 TypeDesc *FromTy = MemberDesc->getFromType();
1540 AddType(Member, FromTy, Unit);
1541
1542 // Walk up typedefs until a real size is found.
1543 while (FromTy) {
1544 if (FromTy->getTag() != DW_TAG_typedef) {
1545 FieldSize = FromTy->getSize();
1546 FieldAlign = FromTy->getSize();
1547 break;
1548 }
1549
Dan Gohman275769a2007-07-23 20:24:29 +00001550 FromTy = cast<DerivedTypeDesc>(FromTy)->getFromType();
Jim Laskeyef42a012006-11-02 20:12:39 +00001551 }
1552
1553 // Unless we have a bit field.
1554 if (Tag == DW_TAG_member && FieldSize != Size) {
1555 // Construct the alignment mask.
1556 uint64_t AlignMask = ~(FieldAlign - 1);
1557 // Determine the high bit + 1 of the declared size.
1558 uint64_t HiMark = (Offset + FieldSize) & AlignMask;
1559 // Work backwards to determine the base offset of the field.
1560 FieldOffset = HiMark - FieldSize;
1561 // Now normalize offset to the field.
1562 Offset -= FieldOffset;
1563
1564 // Maybe we need to work from the other end.
1565 if (TD->isLittleEndian()) Offset = FieldSize - (Offset + Size);
1566
1567 // Add size and offset.
1568 AddUInt(Member, DW_AT_byte_size, 0, FieldSize >> 3);
1569 AddUInt(Member, DW_AT_bit_size, 0, Size);
1570 AddUInt(Member, DW_AT_bit_offset, 0, Offset);
1571 }
1572
1573 // Add computation for offset.
1574 DIEBlock *Block = new DIEBlock();
1575 AddUInt(Block, 0, DW_FORM_data1, DW_OP_plus_uconst);
1576 AddUInt(Block, 0, DW_FORM_udata, FieldOffset >> 3);
1577 AddBlock(Member, DW_AT_data_member_location, 0, Block);
1578
1579 // Add accessibility (public default unless is base class.
1580 if (MemberDesc->isProtected()) {
1581 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_protected);
1582 } else if (MemberDesc->isPrivate()) {
1583 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_private);
1584 } else if (Tag == DW_TAG_inheritance) {
1585 AddUInt(Member, DW_AT_accessibility, 0, DW_ACCESS_public);
1586 }
1587
1588 Buffer.AddChild(Member);
1589 } else if (GlobalVariableDesc *StaticDesc =
1590 dyn_cast<GlobalVariableDesc>(Element)) {
1591 // Add static member.
1592
1593 // Construct member debug information entry.
1594 DIE *Static = new DIE(DW_TAG_variable);
1595
1596 // Add name and mangled name.
Jim Laskey2172f962006-11-30 14:35:45 +00001597 const std::string &Name = StaticDesc->getName();
1598 const std::string &LinkageName = StaticDesc->getLinkageName();
Jim Laskeyef42a012006-11-02 20:12:39 +00001599 AddString(Static, DW_AT_name, DW_FORM_string, Name);
Jim Laskey2172f962006-11-30 14:35:45 +00001600 if (!LinkageName.empty()) {
1601 AddString(Static, DW_AT_MIPS_linkage_name, DW_FORM_string,
1602 LinkageName);
1603 }
Jim Laskeyef42a012006-11-02 20:12:39 +00001604
1605 // Add location.
1606 AddSourceLine(Static, StaticDesc->getFile(), StaticDesc->getLine());
1607
1608 // Add type.
1609 if (TypeDesc *StaticTy = StaticDesc->getType())
1610 AddType(Static, StaticTy, Unit);
1611
1612 // Add flags.
Jim Laskey6488a072007-01-08 22:15:18 +00001613 if (!StaticDesc->isStatic())
1614 AddUInt(Static, DW_AT_external, DW_FORM_flag, 1);
Jim Laskeyef42a012006-11-02 20:12:39 +00001615 AddUInt(Static, DW_AT_declaration, DW_FORM_flag, 1);
1616
1617 Buffer.AddChild(Static);
1618 } else if (SubprogramDesc *MethodDesc =
1619 dyn_cast<SubprogramDesc>(Element)) {
1620 // Add member function.
1621
1622 // Construct member debug information entry.
1623 DIE *Method = new DIE(DW_TAG_subprogram);
1624
1625 // Add name and mangled name.
Jim Laskey2172f962006-11-30 14:35:45 +00001626 const std::string &Name = MethodDesc->getName();
1627 const std::string &LinkageName = MethodDesc->getLinkageName();
Jim Laskeyef42a012006-11-02 20:12:39 +00001628
Jim Laskey2172f962006-11-30 14:35:45 +00001629 AddString(Method, DW_AT_name, DW_FORM_string, Name);
1630 bool IsCTor = TyDesc->getName() == Name;
1631
1632 if (!LinkageName.empty()) {
Jim Laskeyef42a012006-11-02 20:12:39 +00001633 AddString(Method, DW_AT_MIPS_linkage_name, DW_FORM_string,
Jim Laskey2172f962006-11-30 14:35:45 +00001634 LinkageName);
Jim Laskeyef42a012006-11-02 20:12:39 +00001635 }
1636
1637 // Add location.
1638 AddSourceLine(Method, MethodDesc->getFile(), MethodDesc->getLine());
1639
1640 // Add type.
1641 if (CompositeTypeDesc *MethodTy =
1642 dyn_cast_or_null<CompositeTypeDesc>(MethodDesc->getType())) {
1643 // Get argument information.
1644 std::vector<DebugInfoDesc *> &Args = MethodTy->getElements();
1645
1646 // If not a ctor.
1647 if (!IsCTor) {
1648 // Add return type.
1649 AddType(Method, dyn_cast<TypeDesc>(Args[0]), Unit);
1650 }
1651
1652 // Add arguments.
1653 for(unsigned i = 1, N = Args.size(); i < N; ++i) {
1654 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1655 AddType(Arg, cast<TypeDesc>(Args[i]), Unit);
1656 AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1);
1657 Method->AddChild(Arg);
1658 }
1659 }
1660
1661 // Add flags.
Jim Laskey6488a072007-01-08 22:15:18 +00001662 if (!MethodDesc->isStatic())
1663 AddUInt(Method, DW_AT_external, DW_FORM_flag, 1);
Jim Laskeyef42a012006-11-02 20:12:39 +00001664 AddUInt(Method, DW_AT_declaration, DW_FORM_flag, 1);
1665
1666 Buffer.AddChild(Method);
1667 }
1668 }
1669 break;
1670 }
1671 case DW_TAG_enumeration_type: {
1672 // Add enumerators to enumeration type.
1673 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1674 EnumeratorDesc *ED = cast<EnumeratorDesc>(Elements[i]);
1675 const std::string &Name = ED->getName();
1676 int64_t Value = ED->getValue();
1677 DIE *Enumerator = new DIE(DW_TAG_enumerator);
1678 AddString(Enumerator, DW_AT_name, DW_FORM_string, Name);
1679 AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
1680 Buffer.AddChild(Enumerator);
1681 }
1682
1683 break;
1684 }
1685 case DW_TAG_subroutine_type: {
1686 // Add prototype flag.
1687 AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
1688 // Add return type.
1689 AddType(&Buffer, dyn_cast<TypeDesc>(Elements[0]), Unit);
1690
1691 // Add arguments.
1692 for(unsigned i = 1, N = Elements.size(); i < N; ++i) {
1693 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1694 AddType(Arg, cast<TypeDesc>(Elements[i]), Unit);
1695 Buffer.AddChild(Arg);
1696 }
1697
1698 break;
1699 }
1700 default: break;
1701 }
1702 }
1703
1704 // Add size if non-zero (derived types don't have a size.)
1705 if (Size) AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1706 // Add name if not anonymous or intermediate type.
1707 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1708 // Add source line info if available.
1709 AddSourceLine(&Buffer, TyDesc->getFile(), TyDesc->getLine());
1710 }
1711
1712 /// NewCompileUnit - Create new compile unit and it's debug information entry.
Jim Laskey65195462006-10-30 13:35:07 +00001713 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00001714 CompileUnit *NewCompileUnit(CompileUnitDesc *UnitDesc, unsigned ID) {
1715 // Construct debug information entry.
1716 DIE *Die = new DIE(DW_TAG_compile_unit);
Anton Korobeynikov79dda2b2007-05-01 22:23:12 +00001717 if (TAI->isAbsoluteDebugSectionOffsets())
Anton Korobeynikova6199c82007-03-07 02:47:57 +00001718 AddLabel(Die, DW_AT_stmt_list, DW_FORM_data4, DWLabel("section_line", 0));
1719 else
1720 AddDelta(Die, DW_AT_stmt_list, DW_FORM_data4, DWLabel("section_line", 0),
1721 DWLabel("section_line", 0));
Jim Laskeyef42a012006-11-02 20:12:39 +00001722 AddString(Die, DW_AT_producer, DW_FORM_string, UnitDesc->getProducer());
1723 AddUInt (Die, DW_AT_language, DW_FORM_data1, UnitDesc->getLanguage());
1724 AddString(Die, DW_AT_name, DW_FORM_string, UnitDesc->getFileName());
1725 AddString(Die, DW_AT_comp_dir, DW_FORM_string, UnitDesc->getDirectory());
1726
1727 // Construct compile unit.
1728 CompileUnit *Unit = new CompileUnit(UnitDesc, ID, Die);
1729
1730 // Add Unit to compile unit map.
1731 DescToUnitMap[UnitDesc] = Unit;
1732
1733 return Unit;
1734 }
1735
Jim Laskey9d4209f2006-11-07 19:33:46 +00001736 /// GetBaseCompileUnit - Get the main compile unit.
1737 ///
1738 CompileUnit *GetBaseCompileUnit() const {
1739 CompileUnit *Unit = CompileUnits[0];
1740 assert(Unit && "Missing compile unit.");
1741 return Unit;
1742 }
1743
Jim Laskey65195462006-10-30 13:35:07 +00001744 /// FindCompileUnit - Get the compile unit for the given descriptor.
1745 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00001746 CompileUnit *FindCompileUnit(CompileUnitDesc *UnitDesc) {
Jim Laskeyef42a012006-11-02 20:12:39 +00001747 CompileUnit *Unit = DescToUnitMap[UnitDesc];
Jim Laskeyef42a012006-11-02 20:12:39 +00001748 assert(Unit && "Missing compile unit.");
1749 return Unit;
1750 }
1751
1752 /// NewGlobalVariable - Add a new global variable DIE.
Jim Laskey65195462006-10-30 13:35:07 +00001753 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00001754 DIE *NewGlobalVariable(GlobalVariableDesc *GVD) {
1755 // Get the compile unit context.
1756 CompileUnitDesc *UnitDesc =
1757 static_cast<CompileUnitDesc *>(GVD->getContext());
Jim Laskey5496f012006-11-09 14:52:14 +00001758 CompileUnit *Unit = GetBaseCompileUnit();
Jim Laskeyef42a012006-11-02 20:12:39 +00001759
1760 // Check for pre-existence.
1761 DIE *&Slot = Unit->getDieMapSlotFor(GVD);
1762 if (Slot) return Slot;
1763
1764 // Get the global variable itself.
1765 GlobalVariable *GV = GVD->getGlobalVariable();
1766
Jim Laskey2172f962006-11-30 14:35:45 +00001767 const std::string &Name = GVD->getName();
1768 const std::string &FullName = GVD->getFullName();
1769 const std::string &LinkageName = GVD->getLinkageName();
Jim Laskeyef42a012006-11-02 20:12:39 +00001770 // Create the global's variable DIE.
1771 DIE *VariableDie = new DIE(DW_TAG_variable);
1772 AddString(VariableDie, DW_AT_name, DW_FORM_string, Name);
Jim Laskey2172f962006-11-30 14:35:45 +00001773 if (!LinkageName.empty()) {
Jim Laskeyef42a012006-11-02 20:12:39 +00001774 AddString(VariableDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
Jim Laskey2172f962006-11-30 14:35:45 +00001775 LinkageName);
Jim Laskeyef42a012006-11-02 20:12:39 +00001776 }
Jim Laskey6488a072007-01-08 22:15:18 +00001777 AddType(VariableDie, GVD->getType(), Unit);
1778 if (!GVD->isStatic())
1779 AddUInt(VariableDie, DW_AT_external, DW_FORM_flag, 1);
Jim Laskeyef42a012006-11-02 20:12:39 +00001780
1781 // Add source line info if available.
1782 AddSourceLine(VariableDie, UnitDesc, GVD->getLine());
1783
Jim Laskeyef42a012006-11-02 20:12:39 +00001784 // Add address.
1785 DIEBlock *Block = new DIEBlock();
1786 AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
Jim Laskey2172f962006-11-30 14:35:45 +00001787 AddObjectLabel(Block, 0, DW_FORM_udata, Asm->getGlobalLinkName(GV));
1788 AddBlock(VariableDie, DW_AT_location, 0, Block);
Jim Laskeyef42a012006-11-02 20:12:39 +00001789
1790 // Add to map.
1791 Slot = VariableDie;
1792
1793 // Add to context owner.
1794 Unit->getDie()->AddChild(VariableDie);
1795
1796 // Expose as global.
1797 // FIXME - need to check external flag.
Jim Laskey2172f962006-11-30 14:35:45 +00001798 Unit->AddGlobal(FullName, VariableDie);
Jim Laskeyef42a012006-11-02 20:12:39 +00001799
1800 return VariableDie;
1801 }
Jim Laskey65195462006-10-30 13:35:07 +00001802
1803 /// NewSubprogram - Add a new subprogram DIE.
1804 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00001805 DIE *NewSubprogram(SubprogramDesc *SPD) {
1806 // Get the compile unit context.
1807 CompileUnitDesc *UnitDesc =
1808 static_cast<CompileUnitDesc *>(SPD->getContext());
Jim Laskey5496f012006-11-09 14:52:14 +00001809 CompileUnit *Unit = GetBaseCompileUnit();
Jim Laskeyef42a012006-11-02 20:12:39 +00001810
1811 // Check for pre-existence.
1812 DIE *&Slot = Unit->getDieMapSlotFor(SPD);
1813 if (Slot) return Slot;
1814
1815 // Gather the details (simplify add attribute code.)
Jim Laskey2172f962006-11-30 14:35:45 +00001816 const std::string &Name = SPD->getName();
1817 const std::string &FullName = SPD->getFullName();
1818 const std::string &LinkageName = SPD->getLinkageName();
Jim Laskeyef42a012006-11-02 20:12:39 +00001819
1820 DIE *SubprogramDie = new DIE(DW_TAG_subprogram);
1821 AddString(SubprogramDie, DW_AT_name, DW_FORM_string, Name);
Jim Laskey2172f962006-11-30 14:35:45 +00001822 if (!LinkageName.empty()) {
Jim Laskeyef42a012006-11-02 20:12:39 +00001823 AddString(SubprogramDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
Jim Laskey2172f962006-11-30 14:35:45 +00001824 LinkageName);
Jim Laskeyef42a012006-11-02 20:12:39 +00001825 }
1826 if (SPD->getType()) AddType(SubprogramDie, SPD->getType(), Unit);
Jim Laskey6488a072007-01-08 22:15:18 +00001827 if (!SPD->isStatic())
1828 AddUInt(SubprogramDie, DW_AT_external, DW_FORM_flag, 1);
Jim Laskeyef42a012006-11-02 20:12:39 +00001829 AddUInt(SubprogramDie, DW_AT_prototyped, DW_FORM_flag, 1);
1830
1831 // Add source line info if available.
1832 AddSourceLine(SubprogramDie, UnitDesc, SPD->getLine());
1833
1834 // Add to map.
1835 Slot = SubprogramDie;
1836
1837 // Add to context owner.
1838 Unit->getDie()->AddChild(SubprogramDie);
1839
1840 // Expose as global.
Jim Laskey2172f962006-11-30 14:35:45 +00001841 Unit->AddGlobal(FullName, SubprogramDie);
Jim Laskeyef42a012006-11-02 20:12:39 +00001842
1843 return SubprogramDie;
1844 }
Jim Laskey65195462006-10-30 13:35:07 +00001845
1846 /// NewScopeVariable - Create a new scope variable.
1847 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00001848 DIE *NewScopeVariable(DebugVariable *DV, CompileUnit *Unit) {
1849 // Get the descriptor.
1850 VariableDesc *VD = DV->getDesc();
1851
1852 // Translate tag to proper Dwarf tag. The result variable is dropped for
1853 // now.
1854 unsigned Tag;
1855 switch (VD->getTag()) {
1856 case DW_TAG_return_variable: return NULL;
1857 case DW_TAG_arg_variable: Tag = DW_TAG_formal_parameter; break;
1858 case DW_TAG_auto_variable: // fall thru
1859 default: Tag = DW_TAG_variable; break;
1860 }
1861
1862 // Define variable debug information entry.
1863 DIE *VariableDie = new DIE(Tag);
1864 AddString(VariableDie, DW_AT_name, DW_FORM_string, VD->getName());
1865
1866 // Add source line info if available.
1867 AddSourceLine(VariableDie, VD->getFile(), VD->getLine());
1868
1869 // Add variable type.
1870 AddType(VariableDie, VD->getType(), Unit);
1871
1872 // Add variable address.
1873 MachineLocation Location;
Evan Cheng72bebb92008-01-31 03:37:28 +00001874 Location.set(RI->getFrameRegister(*MF),
1875 RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
Jim Laskeyef42a012006-11-02 20:12:39 +00001876 AddAddress(VariableDie, DW_AT_location, Location);
Jim Laskey5496f012006-11-09 14:52:14 +00001877
Jim Laskeyef42a012006-11-02 20:12:39 +00001878 return VariableDie;
1879 }
Jim Laskey65195462006-10-30 13:35:07 +00001880
1881 /// ConstructScope - Construct the components of a scope.
1882 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00001883 void ConstructScope(DebugScope *ParentScope,
Jim Laskey36729dd2006-11-29 16:55:57 +00001884 unsigned ParentStartID, unsigned ParentEndID,
1885 DIE *ParentDie, CompileUnit *Unit) {
Jim Laskeyef42a012006-11-02 20:12:39 +00001886 // Add variables to scope.
1887 std::vector<DebugVariable *> &Variables = ParentScope->getVariables();
1888 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
1889 DIE *VariableDie = NewScopeVariable(Variables[i], Unit);
1890 if (VariableDie) ParentDie->AddChild(VariableDie);
1891 }
1892
1893 // Add nested scopes.
1894 std::vector<DebugScope *> &Scopes = ParentScope->getScopes();
1895 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
1896 // Define the Scope debug information entry.
1897 DebugScope *Scope = Scopes[j];
1898 // FIXME - Ignore inlined functions for the time being.
1899 if (!Scope->getParent()) continue;
1900
Jim Laskey44c3b9f2007-01-26 21:22:28 +00001901 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
1902 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
Jim Laskey5496f012006-11-09 14:52:14 +00001903
Jim Laskey9d4209f2006-11-07 19:33:46 +00001904 // Ignore empty scopes.
1905 if (StartID == EndID && StartID != 0) continue;
1906 if (Scope->getScopes().empty() && Scope->getVariables().empty()) continue;
Jim Laskeyef42a012006-11-02 20:12:39 +00001907
Jim Laskey36729dd2006-11-29 16:55:57 +00001908 if (StartID == ParentStartID && EndID == ParentEndID) {
1909 // Just add stuff to the parent scope.
1910 ConstructScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
Jim Laskeyef42a012006-11-02 20:12:39 +00001911 } else {
Jim Laskey36729dd2006-11-29 16:55:57 +00001912 DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
1913
1914 // Add the scope bounds.
1915 if (StartID) {
1916 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
Jim Laskeybacd3042007-02-21 22:48:45 +00001917 DWLabel("label", StartID));
Jim Laskey36729dd2006-11-29 16:55:57 +00001918 } else {
1919 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
1920 DWLabel("func_begin", SubprogramCount));
1921 }
1922 if (EndID) {
1923 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
Jim Laskeybacd3042007-02-21 22:48:45 +00001924 DWLabel("label", EndID));
Jim Laskey36729dd2006-11-29 16:55:57 +00001925 } else {
1926 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
1927 DWLabel("func_end", SubprogramCount));
1928 }
1929
1930 // Add the scope contents.
1931 ConstructScope(Scope, StartID, EndID, ScopeDie, Unit);
1932 ParentDie->AddChild(ScopeDie);
Jim Laskeyef42a012006-11-02 20:12:39 +00001933 }
Jim Laskeyef42a012006-11-02 20:12:39 +00001934 }
1935 }
Jim Laskey65195462006-10-30 13:35:07 +00001936
1937 /// ConstructRootScope - Construct the scope for the subprogram.
1938 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00001939 void ConstructRootScope(DebugScope *RootScope) {
1940 // Exit if there is no root scope.
1941 if (!RootScope) return;
1942
1943 // Get the subprogram debug information entry.
1944 SubprogramDesc *SPD = cast<SubprogramDesc>(RootScope->getDesc());
1945
1946 // Get the compile unit context.
Jim Laskey5496f012006-11-09 14:52:14 +00001947 CompileUnit *Unit = GetBaseCompileUnit();
Jim Laskeyef42a012006-11-02 20:12:39 +00001948
1949 // Get the subprogram die.
1950 DIE *SPDie = Unit->getDieMapSlotFor(SPD);
1951 assert(SPDie && "Missing subprogram descriptor");
1952
1953 // Add the function bounds.
1954 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
1955 DWLabel("func_begin", SubprogramCount));
1956 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
1957 DWLabel("func_end", SubprogramCount));
1958 MachineLocation Location(RI->getFrameRegister(*MF));
1959 AddAddress(SPDie, DW_AT_frame_base, Location);
Jim Laskey5496f012006-11-09 14:52:14 +00001960
Jim Laskey36729dd2006-11-29 16:55:57 +00001961 ConstructScope(RootScope, 0, 0, SPDie, Unit);
Jim Laskeyef42a012006-11-02 20:12:39 +00001962 }
Jim Laskey65195462006-10-30 13:35:07 +00001963
Jim Laskeyef42a012006-11-02 20:12:39 +00001964 /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
1965 /// tools to recognize the object file contains Dwarf information.
1966 void EmitInitial() {
1967 // Check to see if we already emitted intial headers.
1968 if (didInitial) return;
1969 didInitial = true;
1970
1971 // Dwarf sections base addresses.
Anton Korobeynikov2a07e2f2007-05-05 09:04:50 +00001972 if (TAI->doesDwarfRequireFrameSection()) {
Jim Laskeyef42a012006-11-02 20:12:39 +00001973 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
Anton Korobeynikov185bc892007-05-13 17:30:11 +00001974 EmitLabel("section_debug_frame", 0);
Jim Laskeyef42a012006-11-02 20:12:39 +00001975 }
1976 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
1977 EmitLabel("section_info", 0);
1978 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
1979 EmitLabel("section_abbrev", 0);
1980 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
1981 EmitLabel("section_aranges", 0);
1982 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
1983 EmitLabel("section_macinfo", 0);
1984 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
1985 EmitLabel("section_line", 0);
1986 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
1987 EmitLabel("section_loc", 0);
1988 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
1989 EmitLabel("section_pubnames", 0);
1990 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
1991 EmitLabel("section_str", 0);
1992 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
1993 EmitLabel("section_ranges", 0);
1994
1995 Asm->SwitchToTextSection(TAI->getTextSection());
1996 EmitLabel("text_begin", 0);
1997 Asm->SwitchToDataSection(TAI->getDataSection());
1998 EmitLabel("data_begin", 0);
Jim Laskeyef42a012006-11-02 20:12:39 +00001999 }
2000
Jim Laskey65195462006-10-30 13:35:07 +00002001 /// EmitDIE - Recusively Emits a debug information entry.
2002 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00002003 void EmitDIE(DIE *Die) {
Jim Laskeyef42a012006-11-02 20:12:39 +00002004 // Get the abbreviation for this DIE.
2005 unsigned AbbrevNumber = Die->getAbbrevNumber();
2006 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2007
Jim Laskeybacd3042007-02-21 22:48:45 +00002008 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002009
2010 // Emit the code (index) for the abbreviation.
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002011 Asm->EmitULEB128Bytes(AbbrevNumber);
2012 Asm->EOL(std::string("Abbrev [" +
2013 utostr(AbbrevNumber) +
2014 "] 0x" + utohexstr(Die->getOffset()) +
2015 ":0x" + utohexstr(Die->getSize()) + " " +
2016 TagString(Abbrev->getTag())));
Jim Laskeyef42a012006-11-02 20:12:39 +00002017
Anton Korobeynikov6a143592007-03-07 08:25:02 +00002018 std::vector<DIEValue *> &Values = Die->getValues();
Jim Laskeyef42a012006-11-02 20:12:39 +00002019 const std::vector<DIEAbbrevData> &AbbrevData = Abbrev->getData();
2020
2021 // Emit the DIE attribute values.
2022 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2023 unsigned Attr = AbbrevData[i].getAttribute();
2024 unsigned Form = AbbrevData[i].getForm();
2025 assert(Form && "Too many attributes for DIE (check abbreviation)");
2026
2027 switch (Attr) {
2028 case DW_AT_sibling: {
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002029 Asm->EmitInt32(Die->SiblingOffset());
Jim Laskeyef42a012006-11-02 20:12:39 +00002030 break;
2031 }
2032 default: {
2033 // Emit an attribute using the defined form.
2034 Values[i]->EmitValue(*this, Form);
2035 break;
2036 }
2037 }
2038
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002039 Asm->EOL(AttributeString(Attr));
Jim Laskeyef42a012006-11-02 20:12:39 +00002040 }
2041
2042 // Emit the DIE children if any.
2043 if (Abbrev->getChildrenFlag() == DW_CHILDREN_yes) {
2044 const std::vector<DIE *> &Children = Die->getChildren();
2045
2046 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2047 EmitDIE(Children[j]);
2048 }
2049
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002050 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
Jim Laskeyef42a012006-11-02 20:12:39 +00002051 }
2052 }
2053
Jim Laskey65195462006-10-30 13:35:07 +00002054 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
2055 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002056 unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
2057 // Get the children.
2058 const std::vector<DIE *> &Children = Die->getChildren();
2059
2060 // If not last sibling and has children then add sibling offset attribute.
2061 if (!Last && !Children.empty()) Die->AddSiblingOffset();
2062
2063 // Record the abbreviation.
2064 AssignAbbrevNumber(Die->getAbbrev());
2065
2066 // Get the abbreviation for this DIE.
2067 unsigned AbbrevNumber = Die->getAbbrevNumber();
2068 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2069
2070 // Set DIE offset
2071 Die->setOffset(Offset);
2072
2073 // Start the size with the size of abbreviation code.
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002074 Offset += Asm->SizeULEB128(AbbrevNumber);
Jim Laskeyef42a012006-11-02 20:12:39 +00002075
2076 const std::vector<DIEValue *> &Values = Die->getValues();
2077 const std::vector<DIEAbbrevData> &AbbrevData = Abbrev->getData();
2078
2079 // Size the DIE attribute values.
2080 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2081 // Size attribute value.
2082 Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
2083 }
2084
2085 // Size the DIE children if any.
2086 if (!Children.empty()) {
2087 assert(Abbrev->getChildrenFlag() == DW_CHILDREN_yes &&
2088 "Children flag not set");
2089
2090 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2091 Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
2092 }
2093
2094 // End of children marker.
2095 Offset += sizeof(int8_t);
2096 }
2097
2098 Die->setSize(Offset - Die->getOffset());
2099 return Offset;
2100 }
Jim Laskey65195462006-10-30 13:35:07 +00002101
2102 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
2103 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002104 void SizeAndOffsets() {
Jim Laskey5496f012006-11-09 14:52:14 +00002105 // Process base compile unit.
2106 CompileUnit *Unit = GetBaseCompileUnit();
2107 // Compute size of compile unit header
2108 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2109 sizeof(int16_t) + // DWARF version number
2110 sizeof(int32_t) + // Offset Into Abbrev. Section
2111 sizeof(int8_t); // Pointer Size (in bytes)
2112 SizeAndOffsetDie(Unit->getDie(), Offset, true);
Jim Laskeyef42a012006-11-02 20:12:39 +00002113 }
2114
Jim Laskey65195462006-10-30 13:35:07 +00002115 /// EmitDebugInfo - Emit the debug info section.
2116 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00002117 void EmitDebugInfo() {
Jim Laskeyef42a012006-11-02 20:12:39 +00002118 // Start debug info section.
2119 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2120
Jim Laskey5496f012006-11-09 14:52:14 +00002121 CompileUnit *Unit = GetBaseCompileUnit();
2122 DIE *Die = Unit->getDie();
2123 // Emit the compile units header.
2124 EmitLabel("info_begin", Unit->getID());
2125 // Emit size of content not including length itself
2126 unsigned ContentSize = Die->getSize() +
2127 sizeof(int16_t) + // DWARF version number
2128 sizeof(int32_t) + // Offset Into Abbrev. Section
Jim Laskey749b01d2006-11-30 11:09:42 +00002129 sizeof(int8_t) + // Pointer Size (in bytes)
2130 sizeof(int32_t); // FIXME - extra pad for gdb bug.
Jim Laskey5496f012006-11-09 14:52:14 +00002131
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002132 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2133 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
Anton Korobeynikov79dda2b2007-05-01 22:23:12 +00002134 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002135 Asm->EOL("Offset Into Abbrev. Section");
Dan Gohman82482942007-09-27 23:12:31 +00002136 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
Jim Laskey5496f012006-11-09 14:52:14 +00002137
2138 EmitDIE(Die);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002139 // FIXME - extra padding for gdb bug.
2140 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2141 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2142 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2143 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
Jim Laskey5496f012006-11-09 14:52:14 +00002144 EmitLabel("info_end", Unit->getID());
2145
Jim Laskeybacd3042007-02-21 22:48:45 +00002146 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002147 }
2148
Jim Laskey65195462006-10-30 13:35:07 +00002149 /// EmitAbbreviations - Emit the abbreviation section.
2150 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002151 void EmitAbbreviations() const {
2152 // Check to see if it is worth the effort.
2153 if (!Abbreviations.empty()) {
2154 // Start the debug abbrev section.
2155 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2156
2157 EmitLabel("abbrev_begin", 0);
2158
2159 // For each abbrevation.
2160 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2161 // Get abbreviation data
2162 const DIEAbbrev *Abbrev = Abbreviations[i];
2163
2164 // Emit the abbrevations code (base 1 index.)
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002165 Asm->EmitULEB128Bytes(Abbrev->getNumber());
2166 Asm->EOL("Abbreviation Code");
Jim Laskeyef42a012006-11-02 20:12:39 +00002167
2168 // Emit the abbreviations data.
2169 Abbrev->Emit(*this);
2170
Jim Laskeybacd3042007-02-21 22:48:45 +00002171 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002172 }
2173
Jim Laskey7b1b39d2007-02-22 18:22:42 +00002174 // Mark end of abbreviations.
Jim Laskey5df3ad82007-02-22 18:48:52 +00002175 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
Jim Laskey7b1b39d2007-02-22 18:22:42 +00002176
Jim Laskeyef42a012006-11-02 20:12:39 +00002177 EmitLabel("abbrev_end", 0);
2178
Jim Laskeybacd3042007-02-21 22:48:45 +00002179 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002180 }
2181 }
2182
Jim Laskey65195462006-10-30 13:35:07 +00002183 /// EmitDebugLines - Emit source line information.
2184 ///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00002185 void EmitDebugLines() {
Dan Gohman81a148b2007-09-24 21:43:52 +00002186 // If there are no lines to emit (such as when we're using .loc directives
2187 // to emit .debug_line information) don't emit a .debug_line header.
2188 if (SectionSourceLines.empty())
2189 return;
2190
Jim Laskeyef42a012006-11-02 20:12:39 +00002191 // Minimum line delta, thus ranging from -10..(255-10).
2192 const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
2193 // Maximum line delta, thus ranging from -10..(255-10).
2194 const int MaxLineDelta = 255 + MinLineDelta;
Jim Laskey65195462006-10-30 13:35:07 +00002195
Jim Laskeyef42a012006-11-02 20:12:39 +00002196 // Start the dwarf line section.
2197 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2198
2199 // Construct the section header.
2200
Jim Laskey2b4e98c2006-12-06 17:43:18 +00002201 EmitDifference("line_end", 0, "line_begin", 0, true);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002202 Asm->EOL("Length of Source Line Info");
Jim Laskeyef42a012006-11-02 20:12:39 +00002203 EmitLabel("line_begin", 0);
2204
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002205 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
Jim Laskeyef42a012006-11-02 20:12:39 +00002206
Jim Laskey2b4e98c2006-12-06 17:43:18 +00002207 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002208 Asm->EOL("Prolog Length");
Jim Laskeyef42a012006-11-02 20:12:39 +00002209 EmitLabel("line_prolog_begin", 0);
2210
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002211 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
Jim Laskeyef42a012006-11-02 20:12:39 +00002212
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002213 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
Jim Laskeyef42a012006-11-02 20:12:39 +00002214
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002215 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
Jim Laskeyef42a012006-11-02 20:12:39 +00002216
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002217 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
Jim Laskeyef42a012006-11-02 20:12:39 +00002218
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002219 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
Jim Laskeyef42a012006-11-02 20:12:39 +00002220
2221 // Line number standard opcode encodings argument count
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002222 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2223 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2224 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2225 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2226 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2227 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2228 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2229 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2230 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
Jim Laskeyef42a012006-11-02 20:12:39 +00002231
Jim Laskey44c3b9f2007-01-26 21:22:28 +00002232 const UniqueVector<std::string> &Directories = MMI->getDirectories();
Jim Laskeyef42a012006-11-02 20:12:39 +00002233 const UniqueVector<SourceFileInfo>
Jim Laskey44c3b9f2007-01-26 21:22:28 +00002234 &SourceFiles = MMI->getSourceFiles();
Jim Laskeyef42a012006-11-02 20:12:39 +00002235
2236 // Emit directories.
2237 for (unsigned DirectoryID = 1, NDID = Directories.size();
2238 DirectoryID <= NDID; ++DirectoryID) {
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002239 Asm->EmitString(Directories[DirectoryID]); Asm->EOL("Directory");
Jim Laskeyef42a012006-11-02 20:12:39 +00002240 }
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002241 Asm->EmitInt8(0); Asm->EOL("End of directories");
Jim Laskeyef42a012006-11-02 20:12:39 +00002242
2243 // Emit files.
2244 for (unsigned SourceID = 1, NSID = SourceFiles.size();
2245 SourceID <= NSID; ++SourceID) {
2246 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002247 Asm->EmitString(SourceFile.getName());
2248 Asm->EOL("Source");
2249 Asm->EmitULEB128Bytes(SourceFile.getDirectoryID());
2250 Asm->EOL("Directory #");
2251 Asm->EmitULEB128Bytes(0);
2252 Asm->EOL("Mod date");
2253 Asm->EmitULEB128Bytes(0);
2254 Asm->EOL("File size");
Jim Laskeyef42a012006-11-02 20:12:39 +00002255 }
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002256 Asm->EmitInt8(0); Asm->EOL("End of files");
Jim Laskeyef42a012006-11-02 20:12:39 +00002257
2258 EmitLabel("line_prolog_end", 0);
2259
2260 // A sequence for each text section.
2261 for (unsigned j = 0, M = SectionSourceLines.size(); j < M; ++j) {
2262 // Isolate current sections line info.
2263 const std::vector<SourceLineInfo> &LineInfos = SectionSourceLines[j];
2264
Jim Laskey1a4a83c2007-01-25 15:45:58 +00002265 Asm->EOL(std::string("Section ") + SectionMap[j + 1]);
Jim Laskeyef42a012006-11-02 20:12:39 +00002266
2267 // Dwarf assumes we start with first line of first source file.
2268 unsigned Source = 1;
2269 unsigned Line = 1;
2270
2271 // Construct rows of the address, source, line, column matrix.
2272 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
2273 const SourceLineInfo &LineInfo = LineInfos[i];
Jim Laskey44c3b9f2007-01-26 21:22:28 +00002274 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
Jim Laskey9d4209f2006-11-07 19:33:46 +00002275 if (!LabelID) continue;
Jim Laskeyef42a012006-11-02 20:12:39 +00002276
Jim Laskey1a4a83c2007-01-25 15:45:58 +00002277 unsigned SourceID = LineInfo.getSourceID();
2278 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
2279 unsigned DirectoryID = SourceFile.getDirectoryID();
2280 Asm->EOL(Directories[DirectoryID]
2281 + SourceFile.getName()
2282 + ":"
2283 + utostr_32(LineInfo.getLine()));
Jim Laskeyef42a012006-11-02 20:12:39 +00002284
2285 // Define the line address.
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002286 Asm->EmitInt8(0); Asm->EOL("Extended Op");
Dan Gohman82482942007-09-27 23:12:31 +00002287 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002288 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
Jim Laskeybacd3042007-02-21 22:48:45 +00002289 EmitReference("label", LabelID); Asm->EOL("Location label");
Jim Laskeyef42a012006-11-02 20:12:39 +00002290
2291 // If change of source, then switch to the new source.
2292 if (Source != LineInfo.getSourceID()) {
2293 Source = LineInfo.getSourceID();
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002294 Asm->EmitInt8(DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2295 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
Jim Laskeyef42a012006-11-02 20:12:39 +00002296 }
2297
2298 // If change of line.
2299 if (Line != LineInfo.getLine()) {
2300 // Determine offset.
2301 int Offset = LineInfo.getLine() - Line;
2302 int Delta = Offset - MinLineDelta;
2303
2304 // Update line.
2305 Line = LineInfo.getLine();
2306
2307 // If delta is small enough and in range...
2308 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2309 // ... then use fast opcode.
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002310 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
Jim Laskeyef42a012006-11-02 20:12:39 +00002311 } else {
2312 // ... otherwise use long hand.
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002313 Asm->EmitInt8(DW_LNS_advance_line); Asm->EOL("DW_LNS_advance_line");
2314 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2315 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
Jim Laskeyef42a012006-11-02 20:12:39 +00002316 }
2317 } else {
2318 // Copy the previous row (different address or source)
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002319 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
Jim Laskeyef42a012006-11-02 20:12:39 +00002320 }
2321 }
2322
2323 // Define last address of section.
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002324 Asm->EmitInt8(0); Asm->EOL("Extended Op");
Dan Gohman82482942007-09-27 23:12:31 +00002325 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002326 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2327 EmitReference("section_end", j + 1); Asm->EOL("Section end label");
Jim Laskeyef42a012006-11-02 20:12:39 +00002328
2329 // Mark end of matrix.
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002330 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
Jim Laskeybacd3042007-02-21 22:48:45 +00002331 Asm->EmitULEB128Bytes(1); Asm->EOL();
2332 Asm->EmitInt8(1); Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002333 }
2334
2335 EmitLabel("line_end", 0);
2336
Jim Laskeybacd3042007-02-21 22:48:45 +00002337 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002338 }
2339
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002340 /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
Jim Laskey65195462006-10-30 13:35:07 +00002341 ///
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002342 void EmitCommonDebugFrame() {
Anton Korobeynikov2a07e2f2007-05-05 09:04:50 +00002343 if (!TAI->doesDwarfRequireFrameSection())
Jim Laskeyef42a012006-11-02 20:12:39 +00002344 return;
2345
2346 int stackGrowth =
2347 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2348 TargetFrameInfo::StackGrowsUp ?
Dan Gohman82482942007-09-27 23:12:31 +00002349 TD->getPointerSize() : -TD->getPointerSize();
Jim Laskeyef42a012006-11-02 20:12:39 +00002350
2351 // Start the dwarf frame section.
2352 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2353
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002354 EmitLabel("debug_frame_common", 0);
2355 EmitDifference("debug_frame_common_end", 0,
2356 "debug_frame_common_begin", 0, true);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002357 Asm->EOL("Length of Common Information Entry");
Jim Laskeyef42a012006-11-02 20:12:39 +00002358
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002359 EmitLabel("debug_frame_common_begin", 0);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002360 Asm->EmitInt32((int)DW_CIE_ID);
2361 Asm->EOL("CIE Identifier Tag");
2362 Asm->EmitInt8(DW_CIE_VERSION);
2363 Asm->EOL("CIE Version");
2364 Asm->EmitString("");
2365 Asm->EOL("CIE Augmentation");
2366 Asm->EmitULEB128Bytes(1);
2367 Asm->EOL("CIE Code Alignment Factor");
2368 Asm->EmitSLEB128Bytes(stackGrowth);
2369 Asm->EOL("CIE Data Alignment Factor");
Dale Johannesenb97aec62007-11-13 19:13:01 +00002370 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002371 Asm->EOL("CIE RA Column");
Jim Laskey65195462006-10-30 13:35:07 +00002372
Jim Laskey5e73d5b2007-01-24 18:45:13 +00002373 std::vector<MachineMove> Moves;
Jim Laskeyef42a012006-11-02 20:12:39 +00002374 RI->getInitialFrameState(Moves);
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00002375
Dale Johannesenb97aec62007-11-13 19:13:01 +00002376 EmitFrameMoves(NULL, 0, Moves, false);
Jim Laskeyef42a012006-11-02 20:12:39 +00002377
Evan Cheng05548eb2008-02-29 19:36:59 +00002378 Asm->EmitAlignment(2, 0, 0, false);
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002379 EmitLabel("debug_frame_common_end", 0);
Jim Laskeyef42a012006-11-02 20:12:39 +00002380
Jim Laskeybacd3042007-02-21 22:48:45 +00002381 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002382 }
2383
Jim Laskey65195462006-10-30 13:35:07 +00002384 /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2385 /// section.
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002386 void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
Anton Korobeynikov2a07e2f2007-05-05 09:04:50 +00002387 if (!TAI->doesDwarfRequireFrameSection())
Reid Spencer5a4951e2006-11-07 06:36:36 +00002388 return;
Jim Laskey9d4209f2006-11-07 19:33:46 +00002389
Jim Laskeyef42a012006-11-02 20:12:39 +00002390 // Start the dwarf frame section.
2391 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2392
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002393 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2394 "debug_frame_begin", DebugFrameInfo.Number, true);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002395 Asm->EOL("Length of Frame Information Entry");
Jim Laskeyef42a012006-11-02 20:12:39 +00002396
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002397 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
Anton Korobeynikova6199c82007-03-07 02:47:57 +00002398
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002399 EmitSectionOffset("debug_frame_common", "section_debug_frame",
2400 0, 0, true, false);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002401 Asm->EOL("FDE CIE offset");
Jim Laskey65195462006-10-30 13:35:07 +00002402
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002403 EmitReference("func_begin", DebugFrameInfo.Number);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002404 Asm->EOL("FDE initial location");
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002405 EmitDifference("func_end", DebugFrameInfo.Number,
2406 "func_begin", DebugFrameInfo.Number);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002407 Asm->EOL("FDE address range");
Jim Laskeyef42a012006-11-02 20:12:39 +00002408
Dale Johannesenb97aec62007-11-13 19:13:01 +00002409 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves, false);
Jim Laskeyef42a012006-11-02 20:12:39 +00002410
Evan Cheng05548eb2008-02-29 19:36:59 +00002411 Asm->EmitAlignment(2, 0, 0, false);
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002412 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
Jim Laskeyef42a012006-11-02 20:12:39 +00002413
Jim Laskeybacd3042007-02-21 22:48:45 +00002414 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002415 }
2416
2417 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
Jim Laskey65195462006-10-30 13:35:07 +00002418 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002419 void EmitDebugPubNames() {
2420 // Start the dwarf pubnames section.
2421 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2422
Jim Laskey5496f012006-11-09 14:52:14 +00002423 CompileUnit *Unit = GetBaseCompileUnit();
2424
2425 EmitDifference("pubnames_end", Unit->getID(),
Jim Laskey2b4e98c2006-12-06 17:43:18 +00002426 "pubnames_begin", Unit->getID(), true);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002427 Asm->EOL("Length of Public Names Info");
Jim Laskey5496f012006-11-09 14:52:14 +00002428
2429 EmitLabel("pubnames_begin", Unit->getID());
2430
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002431 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF Version");
Anton Korobeynikova6199c82007-03-07 02:47:57 +00002432
Anton Korobeynikov79dda2b2007-05-01 22:23:12 +00002433 EmitSectionOffset("info_begin", "section_info",
2434 Unit->getID(), 0, true, false);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002435 Asm->EOL("Offset of Compilation Unit Info");
Jim Laskeyef42a012006-11-02 20:12:39 +00002436
Jim Laskey2b4e98c2006-12-06 17:43:18 +00002437 EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(),true);
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002438 Asm->EOL("Compilation Unit Length");
Jim Laskey5496f012006-11-09 14:52:14 +00002439
2440 std::map<std::string, DIE *> &Globals = Unit->getGlobals();
2441
2442 for (std::map<std::string, DIE *>::iterator GI = Globals.begin(),
2443 GE = Globals.end();
2444 GI != GE; ++GI) {
2445 const std::string &Name = GI->first;
2446 DIE * Entity = GI->second;
Jim Laskeyef42a012006-11-02 20:12:39 +00002447
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002448 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2449 Asm->EmitString(Name); Asm->EOL("External Name");
Jim Laskeyef42a012006-11-02 20:12:39 +00002450 }
Jim Laskey5496f012006-11-09 14:52:14 +00002451
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002452 Asm->EmitInt32(0); Asm->EOL("End Mark");
Jim Laskey5496f012006-11-09 14:52:14 +00002453 EmitLabel("pubnames_end", Unit->getID());
2454
Jim Laskeybacd3042007-02-21 22:48:45 +00002455 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002456 }
2457
2458 /// EmitDebugStr - Emit visible names into a debug str section.
Jim Laskey65195462006-10-30 13:35:07 +00002459 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002460 void EmitDebugStr() {
2461 // Check to see if it is worth the effort.
2462 if (!StringPool.empty()) {
2463 // Start the dwarf str section.
2464 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2465
2466 // For each of strings in the string pool.
2467 for (unsigned StringID = 1, N = StringPool.size();
2468 StringID <= N; ++StringID) {
2469 // Emit a label for reference from debug information entries.
2470 EmitLabel("string", StringID);
2471 // Emit the string itself.
2472 const std::string &String = StringPool[StringID];
Jim Laskeybacd3042007-02-21 22:48:45 +00002473 Asm->EmitString(String); Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002474 }
2475
Jim Laskeybacd3042007-02-21 22:48:45 +00002476 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002477 }
2478 }
2479
2480 /// EmitDebugLoc - Emit visible names into a debug loc section.
Jim Laskey65195462006-10-30 13:35:07 +00002481 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002482 void EmitDebugLoc() {
2483 // Start the dwarf loc section.
2484 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2485
Jim Laskeybacd3042007-02-21 22:48:45 +00002486 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002487 }
2488
2489 /// EmitDebugARanges - Emit visible names into a debug aranges section.
Jim Laskey65195462006-10-30 13:35:07 +00002490 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002491 void EmitDebugARanges() {
2492 // Start the dwarf aranges section.
2493 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2494
2495 // FIXME - Mock up
2496 #if 0
Jim Laskey5496f012006-11-09 14:52:14 +00002497 CompileUnit *Unit = GetBaseCompileUnit();
Jim Laskeyef42a012006-11-02 20:12:39 +00002498
Jim Laskey5496f012006-11-09 14:52:14 +00002499 // Don't include size of length
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002500 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
Jim Laskey5496f012006-11-09 14:52:14 +00002501
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002502 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("Dwarf Version");
Jim Laskey5496f012006-11-09 14:52:14 +00002503
2504 EmitReference("info_begin", Unit->getID());
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002505 Asm->EOL("Offset of Compilation Unit Info");
Jim Laskeyef42a012006-11-02 20:12:39 +00002506
Dan Gohman82482942007-09-27 23:12:31 +00002507 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
Jim Laskeyef42a012006-11-02 20:12:39 +00002508
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002509 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
Jim Laskeyef42a012006-11-02 20:12:39 +00002510
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002511 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
2512 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
Jim Laskeyef42a012006-11-02 20:12:39 +00002513
Jim Laskey5496f012006-11-09 14:52:14 +00002514 // Range 1
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002515 EmitReference("text_begin", 0); Asm->EOL("Address");
2516 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
Jim Laskeyef42a012006-11-02 20:12:39 +00002517
Jim Laskeyf1cdea12007-01-25 15:12:02 +00002518 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2519 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
Dan Gohman44de9262007-09-24 21:36:21 +00002520 #endif
Jim Laskey5496f012006-11-09 14:52:14 +00002521
Jim Laskeybacd3042007-02-21 22:48:45 +00002522 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002523 }
2524
2525 /// EmitDebugRanges - Emit visible names into a debug ranges section.
Jim Laskey65195462006-10-30 13:35:07 +00002526 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002527 void EmitDebugRanges() {
2528 // Start the dwarf ranges section.
2529 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2530
Jim Laskeybacd3042007-02-21 22:48:45 +00002531 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002532 }
2533
2534 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
Jim Laskey65195462006-10-30 13:35:07 +00002535 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002536 void EmitDebugMacInfo() {
2537 // Start the dwarf macinfo section.
2538 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2539
Jim Laskeybacd3042007-02-21 22:48:45 +00002540 Asm->EOL();
Jim Laskeyef42a012006-11-02 20:12:39 +00002541 }
2542
Jim Laskey65195462006-10-30 13:35:07 +00002543 /// ConstructCompileUnitDIEs - Create a compile unit DIE for each source and
2544 /// header file.
Jim Laskeyef42a012006-11-02 20:12:39 +00002545 void ConstructCompileUnitDIEs() {
Jim Laskey44c3b9f2007-01-26 21:22:28 +00002546 const UniqueVector<CompileUnitDesc *> CUW = MMI->getCompileUnits();
Jim Laskeyef42a012006-11-02 20:12:39 +00002547
2548 for (unsigned i = 1, N = CUW.size(); i <= N; ++i) {
Jim Laskey44c3b9f2007-01-26 21:22:28 +00002549 unsigned ID = MMI->RecordSource(CUW[i]);
Jim Laskey9d4209f2006-11-07 19:33:46 +00002550 CompileUnit *Unit = NewCompileUnit(CUW[i], ID);
Jim Laskeyef42a012006-11-02 20:12:39 +00002551 CompileUnits.push_back(Unit);
2552 }
2553 }
2554
Jim Laskey65195462006-10-30 13:35:07 +00002555 /// ConstructGlobalDIEs - Create DIEs for each of the externally visible
2556 /// global variables.
Jim Laskeyef42a012006-11-02 20:12:39 +00002557 void ConstructGlobalDIEs() {
2558 std::vector<GlobalVariableDesc *> GlobalVariables =
Jim Laskey44c3b9f2007-01-26 21:22:28 +00002559 MMI->getAnchoredDescriptors<GlobalVariableDesc>(*M);
Jim Laskeyef42a012006-11-02 20:12:39 +00002560
2561 for (unsigned i = 0, N = GlobalVariables.size(); i < N; ++i) {
2562 GlobalVariableDesc *GVD = GlobalVariables[i];
2563 NewGlobalVariable(GVD);
2564 }
2565 }
Jim Laskey65195462006-10-30 13:35:07 +00002566
2567 /// ConstructSubprogramDIEs - Create DIEs for each of the externally visible
2568 /// subprograms.
Jim Laskeyef42a012006-11-02 20:12:39 +00002569 void ConstructSubprogramDIEs() {
2570 std::vector<SubprogramDesc *> Subprograms =
Jim Laskey44c3b9f2007-01-26 21:22:28 +00002571 MMI->getAnchoredDescriptors<SubprogramDesc>(*M);
Jim Laskeyef42a012006-11-02 20:12:39 +00002572
2573 for (unsigned i = 0, N = Subprograms.size(); i < N; ++i) {
2574 SubprogramDesc *SPD = Subprograms[i];
2575 NewSubprogram(SPD);
2576 }
2577 }
Jim Laskey65195462006-10-30 13:35:07 +00002578
Jim Laskey65195462006-10-30 13:35:07 +00002579public:
Jim Laskeyef42a012006-11-02 20:12:39 +00002580 //===--------------------------------------------------------------------===//
2581 // Main entry points.
2582 //
Jim Laskey072200c2007-01-29 18:51:14 +00002583 DwarfDebug(std::ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
Chris Lattner9251f132007-09-24 03:35:37 +00002584 : Dwarf(OS, A, T, "dbg")
Jim Laskeyef42a012006-11-02 20:12:39 +00002585 , CompileUnits()
2586 , AbbreviationsSet(InitAbbreviationsSetSize)
2587 , Abbreviations()
2588 , ValuesSet(InitValuesSetSize)
2589 , Values()
2590 , StringPool()
2591 , DescToUnitMap()
2592 , SectionMap()
2593 , SectionSourceLines()
Jim Laskeybacd3042007-02-21 22:48:45 +00002594 , didInitial(false)
2595 , shouldEmit(false)
Jim Laskeyef42a012006-11-02 20:12:39 +00002596 {
2597 }
Jim Laskey072200c2007-01-29 18:51:14 +00002598 virtual ~DwarfDebug() {
Jim Laskeyef42a012006-11-02 20:12:39 +00002599 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i)
2600 delete CompileUnits[i];
2601 for (unsigned j = 0, M = Values.size(); j < M; ++j)
2602 delete Values[j];
2603 }
2604
Jim Laskey44c3b9f2007-01-26 21:22:28 +00002605 /// SetModuleInfo - Set machine module information when it's known that pass
2606 /// manager has created it. Set by the target AsmPrinter.
2607 void SetModuleInfo(MachineModuleInfo *mmi) {
Jim Laskeyef42a012006-11-02 20:12:39 +00002608 // Make sure initial declarations are made.
Jim Laskey44c3b9f2007-01-26 21:22:28 +00002609 if (!MMI && mmi->hasDebugInfo()) {
2610 MMI = mmi;
Jim Laskeyef42a012006-11-02 20:12:39 +00002611 shouldEmit = true;
2612
Jim Laskeyef42a012006-11-02 20:12:39 +00002613 // Create all the compile unit DIEs.
2614 ConstructCompileUnitDIEs();
2615
2616 // Create DIEs for each of the externally visible global variables.
2617 ConstructGlobalDIEs();
Jim Laskey65195462006-10-30 13:35:07 +00002618
Jim Laskeyef42a012006-11-02 20:12:39 +00002619 // Create DIEs for each of the externally visible subprograms.
2620 ConstructSubprogramDIEs();
2621
2622 // Prime section data.
Jim Laskeyf910a3f2006-11-06 16:23:59 +00002623 SectionMap.insert(TAI->getTextSection());
Dan Gohmand57c3882007-10-01 22:40:20 +00002624
2625 // Print out .file directives to specify files for .loc directives. These
2626 // are printed out early so that they precede any .loc directives.
2627 if (TAI->hasDotLocAndDotFile()) {
2628 const UniqueVector<SourceFileInfo> &SourceFiles = MMI->getSourceFiles();
2629 const UniqueVector<std::string> &Directories = MMI->getDirectories();
2630 for (unsigned i = 1, e = SourceFiles.size(); i <= e; ++i) {
2631 sys::Path FullPath(Directories[SourceFiles[i].getDirectoryID()]);
2632 bool AppendOk = FullPath.appendComponent(SourceFiles[i].getName());
2633 assert(AppendOk && "Could not append filename to directory!");
2634 Asm->EmitFile(i, FullPath.toString());
2635 Asm->EOL();
2636 }
2637 }
2638
2639 // Emit initial sections
2640 EmitInitial();
Jim Laskeyef42a012006-11-02 20:12:39 +00002641 }
2642 }
2643
Jim Laskey65195462006-10-30 13:35:07 +00002644 /// BeginModule - Emit all Dwarf sections that should come prior to the
2645 /// content.
Jim Laskeyef42a012006-11-02 20:12:39 +00002646 void BeginModule(Module *M) {
2647 this->M = M;
2648
2649 if (!ShouldEmitDwarf()) return;
Jim Laskeyef42a012006-11-02 20:12:39 +00002650 }
2651
Jim Laskey65195462006-10-30 13:35:07 +00002652 /// EndModule - Emit all Dwarf sections that should come after the content.
2653 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002654 void EndModule() {
2655 if (!ShouldEmitDwarf()) return;
Jim Laskeyef42a012006-11-02 20:12:39 +00002656
2657 // Standard sections final addresses.
2658 Asm->SwitchToTextSection(TAI->getTextSection());
2659 EmitLabel("text_end", 0);
2660 Asm->SwitchToDataSection(TAI->getDataSection());
2661 EmitLabel("data_end", 0);
2662
2663 // End text sections.
2664 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
2665 Asm->SwitchToTextSection(SectionMap[i].c_str());
2666 EmitLabel("section_end", i);
2667 }
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002668
2669 // Emit common frame information.
2670 EmitCommonDebugFrame();
2671
2672 // Emit function debug frame information
2673 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2674 E = DebugFrames.end(); I != E; ++I)
2675 EmitFunctionDebugFrame(*I);
2676
Jim Laskeyef42a012006-11-02 20:12:39 +00002677 // Compute DIE offsets and sizes.
2678 SizeAndOffsets();
2679
2680 // Emit all the DIEs into a debug info section
2681 EmitDebugInfo();
2682
2683 // Corresponding abbreviations into a abbrev section.
2684 EmitAbbreviations();
2685
2686 // Emit source line correspondence into a debug line section.
2687 EmitDebugLines();
2688
2689 // Emit info into a debug pubnames section.
2690 EmitDebugPubNames();
2691
2692 // Emit info into a debug str section.
2693 EmitDebugStr();
2694
2695 // Emit info into a debug loc section.
2696 EmitDebugLoc();
2697
2698 // Emit info into a debug aranges section.
2699 EmitDebugARanges();
2700
2701 // Emit info into a debug ranges section.
2702 EmitDebugRanges();
2703
2704 // Emit info into a debug macinfo section.
2705 EmitDebugMacInfo();
2706 }
2707
Jim Laskey65195462006-10-30 13:35:07 +00002708 /// BeginFunction - Gather pre-function debug information. Assumes being
2709 /// emitted immediately after the function entry point.
Jim Laskeyef42a012006-11-02 20:12:39 +00002710 void BeginFunction(MachineFunction *MF) {
2711 this->MF = MF;
2712
2713 if (!ShouldEmitDwarf()) return;
Jim Laskeyef42a012006-11-02 20:12:39 +00002714
2715 // Begin accumulating function debug information.
Jim Laskey44c3b9f2007-01-26 21:22:28 +00002716 MMI->BeginFunction(MF);
Jim Laskeyef42a012006-11-02 20:12:39 +00002717
2718 // Assumes in correct section after the entry point.
2719 EmitLabel("func_begin", ++SubprogramCount);
Evan Cheng1b08bbc2008-02-01 09:10:45 +00002720
2721 // Emit label for the implicitly defined dbg.stoppoint at the start of
2722 // the function.
2723 const SourceLineInfo &LineInfo = MMI->getSourceLines()[0];
2724 Asm->printLabel(LineInfo.getLabelID());
Jim Laskeyef42a012006-11-02 20:12:39 +00002725 }
Jim Laskey072200c2007-01-29 18:51:14 +00002726
Jim Laskey65195462006-10-30 13:35:07 +00002727 /// EndFunction - Gather and emit post-function debug information.
2728 ///
Jim Laskeyef42a012006-11-02 20:12:39 +00002729 void EndFunction() {
2730 if (!ShouldEmitDwarf()) return;
Jim Laskeyb82313f2007-02-01 16:31:34 +00002731
2732 // Define end label for subprogram.
2733 EmitLabel("func_end", SubprogramCount);
Jim Laskeyef42a012006-11-02 20:12:39 +00002734
2735 // Get function line info.
Jim Laskey44c3b9f2007-01-26 21:22:28 +00002736 const std::vector<SourceLineInfo> &LineInfos = MMI->getSourceLines();
Jim Laskeyef42a012006-11-02 20:12:39 +00002737
2738 if (!LineInfos.empty()) {
2739 // Get section line info.
2740 unsigned ID = SectionMap.insert(Asm->CurrentSection);
2741 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
2742 std::vector<SourceLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
2743 // Append the function info to section info.
2744 SectionLineInfos.insert(SectionLineInfos.end(),
2745 LineInfos.begin(), LineInfos.end());
2746 }
2747
2748 // Construct scopes for subprogram.
Jim Laskey44c3b9f2007-01-26 21:22:28 +00002749 ConstructRootScope(MMI->getRootScope());
Anton Korobeynikov185bc892007-05-13 17:30:11 +00002750
2751 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
2752 MMI->getFrameMoves()));
Jim Laskeyef42a012006-11-02 20:12:39 +00002753 }
Jim Laskey65195462006-10-30 13:35:07 +00002754};
2755
Jim Laskey072200c2007-01-29 18:51:14 +00002756//===----------------------------------------------------------------------===//
2757/// DwarfException - Emits Dwarf exception handling directives.
2758///
2759class DwarfException : public Dwarf {
2760
Jim Laskeyb82313f2007-02-01 16:31:34 +00002761private:
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00002762 struct FunctionEHFrameInfo {
2763 std::string FnName;
2764 unsigned Number;
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00002765 unsigned PersonalityIndex;
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00002766 bool hasCalls;
2767 bool hasLandingPads;
2768 std::vector<MachineMove> Moves;
Dale Johannesen48ae02f2008-01-16 19:59:28 +00002769 const Function * function;
Jim Laskeyb82313f2007-02-01 16:31:34 +00002770
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00002771 FunctionEHFrameInfo(const std::string &FN, unsigned Num, unsigned P,
2772 bool hC, bool hL,
Dale Johannesen1d4ce2a2007-11-20 23:24:42 +00002773 const std::vector<MachineMove> &M,
Dale Johannesen48ae02f2008-01-16 19:59:28 +00002774 const Function *f):
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00002775 FnName(FN), Number(Num), PersonalityIndex(P),
Dale Johannesen48ae02f2008-01-16 19:59:28 +00002776 hasCalls(hC), hasLandingPads(hL), Moves(M), function (f) { }
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00002777 };
2778
2779 std::vector<FunctionEHFrameInfo> EHFrames;
2780
Jim Laskeybacd3042007-02-21 22:48:45 +00002781 /// shouldEmit - Flag to indicate if debug information should be emitted.
2782 ///
2783 bool shouldEmit;
Jim Laskey3f09fc22007-02-28 18:38:31 +00002784
Jim Laskey3f09fc22007-02-28 18:38:31 +00002785 /// EmitCommonEHFrame - Emit the common eh unwind frame.
2786 ///
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00002787 void EmitCommonEHFrame(const Function *Personality, unsigned Index) {
Jim Laskeybacd3042007-02-21 22:48:45 +00002788 // Size and sign of stack growth.
Jim Laskeyb82313f2007-02-01 16:31:34 +00002789 int stackGrowth =
2790 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2791 TargetFrameInfo::StackGrowsUp ?
Dan Gohman82482942007-09-27 23:12:31 +00002792 TD->getPointerSize() : -TD->getPointerSize();
Jim Laskeyb82313f2007-02-01 16:31:34 +00002793
Jim Laskeybacd3042007-02-21 22:48:45 +00002794 // Begin eh frame section.
Jim Laskeyb82313f2007-02-01 16:31:34 +00002795 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00002796 O << "EH_frame" << Index << ":\n";
2797 EmitLabel("section_eh_frame", Index);
Jim Laskeyb82313f2007-02-01 16:31:34 +00002798
Jim Laskeybacd3042007-02-21 22:48:45 +00002799 // Define base labels.
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00002800 EmitLabel("eh_frame_common", Index);
Jim Laskeybacd3042007-02-21 22:48:45 +00002801
2802 // Define the eh frame length.
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00002803 EmitDifference("eh_frame_common_end", Index,
2804 "eh_frame_common_begin", Index, true);
Jim Laskeyb82313f2007-02-01 16:31:34 +00002805 Asm->EOL("Length of Common Information Entry");
2806
Jim Laskeybacd3042007-02-21 22:48:45 +00002807 // EH frame header.
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00002808 EmitLabel("eh_frame_common_begin", Index);
Jim Laskeyb82313f2007-02-01 16:31:34 +00002809 Asm->EmitInt32((int)0);
2810 Asm->EOL("CIE Identifier Tag");
2811 Asm->EmitInt8(DW_CIE_VERSION);
2812 Asm->EOL("CIE Version");
Jim Laskeybacd3042007-02-21 22:48:45 +00002813
2814 // The personality presence indicates that language specific information
2815 // will show up in the eh frame.
2816 Asm->EmitString(Personality ? "zPLR" : "zR");
Jim Laskeyb82313f2007-02-01 16:31:34 +00002817 Asm->EOL("CIE Augmentation");
Jim Laskeybacd3042007-02-21 22:48:45 +00002818
2819 // Round out reader.
Jim Laskeyb82313f2007-02-01 16:31:34 +00002820 Asm->EmitULEB128Bytes(1);
2821 Asm->EOL("CIE Code Alignment Factor");
2822 Asm->EmitSLEB128Bytes(stackGrowth);
2823 Asm->EOL("CIE Data Alignment Factor");
Dale Johannesenb97aec62007-11-13 19:13:01 +00002824 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), true));
Jim Laskeyb82313f2007-02-01 16:31:34 +00002825 Asm->EOL("CIE RA Column");
Jim Laskeyb82313f2007-02-01 16:31:34 +00002826
Jim Laskeybacd3042007-02-21 22:48:45 +00002827 // If there is a personality, we need to indicate the functions location.
2828 if (Personality) {
2829 Asm->EmitULEB128Bytes(7);
2830 Asm->EOL("Augmentation Size");
Bill Wendlingef4a6612007-09-11 17:20:55 +00002831
2832 if (TAI->getNeedsIndirectEncoding())
2833 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4 | DW_EH_PE_indirect);
2834 else
2835 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
2836
Bill Wendlingd60da492007-09-11 08:27:17 +00002837 Asm->EOL("Personality (pcrel sdata4 indirect)");
Jim Laskeybacd3042007-02-21 22:48:45 +00002838
Dale Johannesen4af34942008-01-15 23:24:56 +00002839 PrintRelDirective(TAI->getShortenEHDataOn64Bit());
Bill Wendlingd60da492007-09-11 08:27:17 +00002840 O << TAI->getPersonalityPrefix();
2841 Asm->EmitExternalGlobal((const GlobalVariable *)(Personality));
2842 O << TAI->getPersonalitySuffix();
Dale Johannesen4af34942008-01-15 23:24:56 +00002843 if (!TAI->getShortenEHDataOn64Bit()) {
2844 O << "-" << TAI->getPCSymbol();
2845 }
Bill Wendlingd60da492007-09-11 08:27:17 +00002846 Asm->EOL("Personality");
Bill Wendlingcf4bb312007-08-25 00:51:55 +00002847
Jim Laskeybacd3042007-02-21 22:48:45 +00002848 Asm->EmitULEB128Bytes(DW_EH_PE_pcrel);
2849 Asm->EOL("LSDA Encoding (pcrel)");
2850 Asm->EmitULEB128Bytes(DW_EH_PE_pcrel);
2851 Asm->EOL("FDE Encoding (pcrel)");
2852 } else {
2853 Asm->EmitULEB128Bytes(1);
2854 Asm->EOL("Augmentation Size");
2855 Asm->EmitULEB128Bytes(DW_EH_PE_pcrel);
2856 Asm->EOL("FDE Encoding (pcrel)");
2857 }
2858
2859 // Indicate locations of general callee saved registers in frame.
Jim Laskeyb82313f2007-02-01 16:31:34 +00002860 std::vector<MachineMove> Moves;
2861 RI->getInitialFrameState(Moves);
Dale Johannesenb97aec62007-11-13 19:13:01 +00002862 EmitFrameMoves(NULL, 0, Moves, true);
Jim Laskeyb82313f2007-02-01 16:31:34 +00002863
Evan Cheng05548eb2008-02-29 19:36:59 +00002864 Asm->EmitAlignment(2, 0, 0, false);
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00002865 EmitLabel("eh_frame_common_end", Index);
Jim Laskeyb82313f2007-02-01 16:31:34 +00002866
Jim Laskeybacd3042007-02-21 22:48:45 +00002867 Asm->EOL();
Jim Laskeyb82313f2007-02-01 16:31:34 +00002868 }
2869
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00002870 /// EmitEHFrame - Emit function exception frame information.
Jim Laskeyb82313f2007-02-01 16:31:34 +00002871 ///
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00002872 void EmitEHFrame(const FunctionEHFrameInfo &EHFrameInfo) {
Dale Johannesen48ae02f2008-01-16 19:59:28 +00002873 Function::LinkageTypes linkage = EHFrameInfo.function->getLinkage();
2874
Jim Laskeybacd3042007-02-21 22:48:45 +00002875 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
2876
2877 // Externally visible entry into the functions eh frame info.
Dale Johannesen1d4ce2a2007-11-20 23:24:42 +00002878 // If the corresponding function is static, this should not be
2879 // externally visible.
Dale Johannesen48ae02f2008-01-16 19:59:28 +00002880 if (linkage != Function::InternalLinkage) {
Dale Johannesen1d4ce2a2007-11-20 23:24:42 +00002881 if (const char *GlobalEHDirective = TAI->getGlobalEHDirective())
2882 O << GlobalEHDirective << EHFrameInfo.FnName << "\n";
2883 }
2884
Dale Johannesen038129d2008-01-10 02:03:30 +00002885 // If corresponding function is weak definition, this should be too.
Dale Johannesen48ae02f2008-01-16 19:59:28 +00002886 if ((linkage == Function::WeakLinkage ||
2887 linkage == Function::LinkOnceLinkage) &&
Dale Johannesen038129d2008-01-10 02:03:30 +00002888 TAI->getWeakDefDirective())
2889 O << TAI->getWeakDefDirective() << EHFrameInfo.FnName << "\n";
2890
2891 // If there are no calls then you can't unwind. This may mean we can
2892 // omit the EH Frame, but some environments do not handle weak absolute
2893 // symbols.
2894 if (!EHFrameInfo.hasCalls &&
Dale Johannesen48ae02f2008-01-16 19:59:28 +00002895 ((linkage != Function::WeakLinkage &&
2896 linkage != Function::LinkOnceLinkage) ||
Dale Johannesen038129d2008-01-10 02:03:30 +00002897 !TAI->getWeakDefDirective() ||
2898 TAI->getSupportsWeakOmittedEHFrame()))
2899 {
Bill Wendling6e198962007-09-18 01:47:22 +00002900 O << EHFrameInfo.FnName << " = 0\n";
Dale Johannesen48ae02f2008-01-16 19:59:28 +00002901 // This name has no connection to the function, so it might get
2902 // dead-stripped when the function is not, erroneously. Prohibit
2903 // dead-stripping unconditionally.
2904 if (const char *UsedDirective = TAI->getUsedDirective())
2905 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
Jim Laskeybacd3042007-02-21 22:48:45 +00002906 } else {
Bill Wendling6e198962007-09-18 01:47:22 +00002907 O << EHFrameInfo.FnName << ":\n";
Dale Johannesen1d4ce2a2007-11-20 23:24:42 +00002908
Jim Laskeybacd3042007-02-21 22:48:45 +00002909 // EH frame header.
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00002910 EmitDifference("eh_frame_end", EHFrameInfo.Number,
2911 "eh_frame_begin", EHFrameInfo.Number, true);
Jim Laskeybacd3042007-02-21 22:48:45 +00002912 Asm->EOL("Length of Frame Information Entry");
2913
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00002914 EmitLabel("eh_frame_begin", EHFrameInfo.Number);
Anton Korobeynikova6199c82007-03-07 02:47:57 +00002915
Anton Korobeynikov070280e2007-05-23 11:08:31 +00002916 EmitSectionOffset("eh_frame_begin", "eh_frame_common",
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00002917 EHFrameInfo.Number, EHFrameInfo.PersonalityIndex,
Dale Johannesend9ffd4c2008-03-26 23:31:39 +00002918 true, true, false);
Jim Laskeybacd3042007-02-21 22:48:45 +00002919 Asm->EOL("FDE CIE offset");
2920
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00002921 EmitReference("eh_func_begin", EHFrameInfo.Number, true);
Jim Laskeybacd3042007-02-21 22:48:45 +00002922 Asm->EOL("FDE initial location");
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00002923 EmitDifference("eh_func_end", EHFrameInfo.Number,
2924 "eh_func_begin", EHFrameInfo.Number);
Jim Laskeybacd3042007-02-21 22:48:45 +00002925 Asm->EOL("FDE address range");
2926
Jim Laskey3f09fc22007-02-28 18:38:31 +00002927 // If there is a personality and landing pads then point to the language
2928 // specific data area in the exception table.
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00002929 if (EHFrameInfo.PersonalityIndex) {
Dale Johannesen4af34942008-01-15 23:24:56 +00002930 Asm->EmitULEB128Bytes(TAI->getShortenEHDataOn64Bit() ? 8 : 4);
Jim Laskeybacd3042007-02-21 22:48:45 +00002931 Asm->EOL("Augmentation size");
Jim Laskey3f09fc22007-02-28 18:38:31 +00002932
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00002933 if (EHFrameInfo.hasLandingPads) {
2934 EmitReference("exception", EHFrameInfo.Number, true);
Dan Gohman82482942007-09-27 23:12:31 +00002935 } else if (TD->getPointerSize() == 8) {
Jim Laskey3f09fc22007-02-28 18:38:31 +00002936 Asm->EmitInt64((int)0);
2937 } else {
2938 Asm->EmitInt32((int)0);
2939 }
Jim Laskeybacd3042007-02-21 22:48:45 +00002940 Asm->EOL("Language Specific Data Area");
2941 } else {
2942 Asm->EmitULEB128Bytes(0);
2943 Asm->EOL("Augmentation size");
2944 }
2945
2946 // Indicate locations of function specific callee saved registers in
2947 // frame.
Dale Johannesenb97aec62007-11-13 19:13:01 +00002948 EmitFrameMoves("eh_func_begin", EHFrameInfo.Number, EHFrameInfo.Moves, true);
Jim Laskeybacd3042007-02-21 22:48:45 +00002949
Evan Cheng05548eb2008-02-29 19:36:59 +00002950 Asm->EmitAlignment(2, 0, 0, false);
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00002951 EmitLabel("eh_frame_end", EHFrameInfo.Number);
Jim Laskeyb82313f2007-02-01 16:31:34 +00002952
Dale Johannesen48ae02f2008-01-16 19:59:28 +00002953 // If the function is marked used, this table should be also. We cannot
2954 // make the mark unconditional in this case, since retaining the table
2955 // also retains the function in this case, and there is code around
2956 // that depends on unused functions (calling undefined externals) being
2957 // dead-stripped to link correctly. Yes, there really is.
2958 if (MMI->getUsedFunctions().count(EHFrameInfo.function))
2959 if (const char *UsedDirective = TAI->getUsedDirective())
2960 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
2961 }
Jim Laskeybacd3042007-02-21 22:48:45 +00002962 }
Duncan Sands7bf7a442007-05-21 18:50:28 +00002963
Duncan Sands57810cd2007-09-05 11:27:52 +00002964 /// EmitExceptionTable - Emit landing pads and actions.
Duncan Sandsfccf0a22007-07-06 12:46:24 +00002965 ///
2966 /// The general organization of the table is complex, but the basic concepts
2967 /// are easy. First there is a header which describes the location and
2968 /// organization of the three components that follow.
2969 /// 1. The landing pad site information describes the range of code covered
2970 /// by the try. In our case it's an accumulation of the ranges covered
2971 /// by the invokes in the try. There is also a reference to the landing
2972 /// pad that handles the exception once processed. Finally an index into
2973 /// the actions table.
2974 /// 2. The action table, in our case, is composed of pairs of type ids
2975 /// and next action offset. Starting with the action index from the
2976 /// landing pad site, each type Id is checked for a match to the current
2977 /// exception. If it matches then the exception and type id are passed
2978 /// on to the landing pad. Otherwise the next action is looked up. This
2979 /// chain is terminated with a next action of zero. If no type id is
2980 /// found the the frame is unwound and handling continues.
2981 /// 3. Type id table contains references to all the C++ typeinfo for all
2982 /// catches in the function. This tables is reversed indexed base 1.
2983
Duncan Sandsb32edb42007-06-06 15:37:31 +00002984 /// SharedTypeIds - How many leading type ids two landing pads have in common.
2985 static unsigned SharedTypeIds(const LandingPadInfo *L,
2986 const LandingPadInfo *R) {
2987 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
Duncan Sands7bf7a442007-05-21 18:50:28 +00002988 unsigned LSize = LIds.size(), RSize = RIds.size();
Duncan Sandsb32edb42007-06-06 15:37:31 +00002989 unsigned MinSize = LSize < RSize ? LSize : RSize;
2990 unsigned Count = 0;
Duncan Sands7bf7a442007-05-21 18:50:28 +00002991
Duncan Sandsb32edb42007-06-06 15:37:31 +00002992 for (; Count != MinSize; ++Count)
2993 if (LIds[Count] != RIds[Count])
2994 return Count;
Duncan Sands7bf7a442007-05-21 18:50:28 +00002995
Duncan Sandsb32edb42007-06-06 15:37:31 +00002996 return Count;
Duncan Sands7bf7a442007-05-21 18:50:28 +00002997 }
2998
Duncan Sandsb32edb42007-06-06 15:37:31 +00002999 /// PadLT - Order landing pads lexicographically by type id.
Duncan Sands7bf7a442007-05-21 18:50:28 +00003000 static bool PadLT(const LandingPadInfo *L, const LandingPadInfo *R) {
Duncan Sandsb32edb42007-06-06 15:37:31 +00003001 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003002 unsigned LSize = LIds.size(), RSize = RIds.size();
Duncan Sandsb32edb42007-06-06 15:37:31 +00003003 unsigned MinSize = LSize < RSize ? LSize : RSize;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003004
Duncan Sandsb32edb42007-06-06 15:37:31 +00003005 for (unsigned i = 0; i != MinSize; ++i)
Duncan Sands7bf7a442007-05-21 18:50:28 +00003006 if (LIds[i] != RIds[i])
3007 return LIds[i] < RIds[i];
3008
Duncan Sandsb32edb42007-06-06 15:37:31 +00003009 return LSize < RSize;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003010 }
3011
Duncan Sands53c3a332007-05-16 12:12:23 +00003012 struct KeyInfo {
3013 static inline unsigned getEmptyKey() { return -1U; }
3014 static inline unsigned getTombstoneKey() { return -2U; }
3015 static unsigned getHashValue(const unsigned &Key) { return Key; }
Chris Lattner76c1b972007-09-17 18:34:04 +00003016 static bool isEqual(unsigned LHS, unsigned RHS) { return LHS == RHS; }
Duncan Sands53c3a332007-05-16 12:12:23 +00003017 static bool isPod() { return true; }
3018 };
3019
Duncan Sands57810cd2007-09-05 11:27:52 +00003020 /// ActionEntry - Structure describing an entry in the actions table.
Duncan Sandsb32edb42007-06-06 15:37:31 +00003021 struct ActionEntry {
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003022 int ValueForTypeID; // The value to write - may not be equal to the type id.
Duncan Sandsb32edb42007-06-06 15:37:31 +00003023 int NextAction;
3024 struct ActionEntry *Previous;
3025 };
3026
Duncan Sands57810cd2007-09-05 11:27:52 +00003027 /// PadRange - Structure holding a try-range and the associated landing pad.
3028 struct PadRange {
3029 // The index of the landing pad.
3030 unsigned PadIndex;
3031 // The index of the begin and end labels in the landing pad's label lists.
3032 unsigned RangeIndex;
3033 };
3034
3035 typedef DenseMap<unsigned, PadRange, KeyInfo> RangeMapType;
3036
3037 /// CallSiteEntry - Structure describing an entry in the call-site table.
3038 struct CallSiteEntry {
Duncan Sands481dc722007-12-19 07:36:31 +00003039 // The 'try-range' is BeginLabel .. EndLabel.
Duncan Sands57810cd2007-09-05 11:27:52 +00003040 unsigned BeginLabel; // zero indicates the start of the function.
3041 unsigned EndLabel; // zero indicates the end of the function.
Duncan Sands481dc722007-12-19 07:36:31 +00003042 // The landing pad starts at PadLabel.
Duncan Sands57810cd2007-09-05 11:27:52 +00003043 unsigned PadLabel; // zero indicates that there is no landing pad.
3044 unsigned Action;
3045 };
3046
Jim Laskeybacd3042007-02-21 22:48:45 +00003047 void EmitExceptionTable() {
3048 // Map all labels and get rid of any dead landing pads.
3049 MMI->TidyLandingPads();
Duncan Sands7bf7a442007-05-21 18:50:28 +00003050
Jim Laskeybacd3042007-02-21 22:48:45 +00003051 const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
Duncan Sands73ef58a2007-06-02 16:53:42 +00003052 const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
Duncan Sands7bf7a442007-05-21 18:50:28 +00003053 const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
3054 if (PadInfos.empty()) return;
3055
3056 // Sort the landing pads in order of their type ids. This is used to fold
3057 // duplicate actions.
Duncan Sands6cc76082007-06-08 08:59:11 +00003058 SmallVector<const LandingPadInfo *, 64> LandingPads;
Duncan Sands6cc76082007-06-08 08:59:11 +00003059 LandingPads.reserve(PadInfos.size());
Duncan Sands7bf7a442007-05-21 18:50:28 +00003060 for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
Duncan Sands6cc76082007-06-08 08:59:11 +00003061 LandingPads.push_back(&PadInfos[i]);
Duncan Sands7bf7a442007-05-21 18:50:28 +00003062 std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
3063
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003064 // Negative type ids index into FilterIds, positive type ids index into
3065 // TypeInfos. The value written for a positive type id is just the type
3066 // id itself. For a negative type id, however, the value written is the
3067 // (negative) byte offset of the corresponding FilterIds entry. The byte
3068 // offset is usually equal to the type id, because the FilterIds entries
3069 // are written using a variable width encoding which outputs one byte per
3070 // entry as long as the value written is not too large, but can differ.
3071 // This kind of complication does not occur for positive type ids because
3072 // type infos are output using a fixed width encoding.
3073 // FilterOffsets[i] holds the byte offset corresponding to FilterIds[i].
3074 SmallVector<int, 16> FilterOffsets;
3075 FilterOffsets.reserve(FilterIds.size());
3076 int Offset = -1;
3077 for(std::vector<unsigned>::const_iterator I = FilterIds.begin(),
3078 E = FilterIds.end(); I != E; ++I) {
3079 FilterOffsets.push_back(Offset);
Duncan Sandsbb821dd2007-07-12 13:51:39 +00003080 Offset -= Asm->SizeULEB128(*I);
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003081 }
3082
Duncan Sands57810cd2007-09-05 11:27:52 +00003083 // Compute the actions table and gather the first action index for each
3084 // landing pad site.
3085 SmallVector<ActionEntry, 32> Actions;
3086 SmallVector<unsigned, 64> FirstActions;
3087 FirstActions.reserve(LandingPads.size());
Jim Laskeybacd3042007-02-21 22:48:45 +00003088
Duncan Sandsb32edb42007-06-06 15:37:31 +00003089 int FirstAction = 0;
Duncan Sands57810cd2007-09-05 11:27:52 +00003090 unsigned SizeActions = 0;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003091 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
Duncan Sandsb32edb42007-06-06 15:37:31 +00003092 const LandingPadInfo *LP = LandingPads[i];
3093 const std::vector<int> &TypeIds = LP->TypeIds;
3094 const unsigned NumShared = i ? SharedTypeIds(LP, LandingPads[i-1]) : 0;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003095 unsigned SizeSiteActions = 0;
3096
Duncan Sandsb32edb42007-06-06 15:37:31 +00003097 if (NumShared < TypeIds.size()) {
Duncan Sands7bf7a442007-05-21 18:50:28 +00003098 unsigned SizeAction = 0;
Duncan Sandsb32edb42007-06-06 15:37:31 +00003099 ActionEntry *PrevAction = 0;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003100
Duncan Sandsb32edb42007-06-06 15:37:31 +00003101 if (NumShared) {
3102 const unsigned SizePrevIds = LandingPads[i-1]->TypeIds.size();
3103 assert(Actions.size());
3104 PrevAction = &Actions.back();
3105 SizeAction = Asm->SizeSLEB128(PrevAction->NextAction) +
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003106 Asm->SizeSLEB128(PrevAction->ValueForTypeID);
Duncan Sandsb32edb42007-06-06 15:37:31 +00003107 for (unsigned j = NumShared; j != SizePrevIds; ++j) {
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003108 SizeAction -= Asm->SizeSLEB128(PrevAction->ValueForTypeID);
Duncan Sandsb32edb42007-06-06 15:37:31 +00003109 SizeAction += -PrevAction->NextAction;
3110 PrevAction = PrevAction->Previous;
Duncan Sands7bf7a442007-05-21 18:50:28 +00003111 }
Anton Korobeynikoveeb37e02007-05-10 22:34:59 +00003112 }
Duncan Sands7bf7a442007-05-21 18:50:28 +00003113
Duncan Sandsb32edb42007-06-06 15:37:31 +00003114 // Compute the actions.
3115 for (unsigned I = NumShared, M = TypeIds.size(); I != M; ++I) {
3116 int TypeID = TypeIds[I];
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003117 assert(-1-TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
3118 int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
3119 unsigned SizeTypeID = Asm->SizeSLEB128(ValueForTypeID);
Duncan Sandsb32edb42007-06-06 15:37:31 +00003120
3121 int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
3122 SizeAction = SizeTypeID + Asm->SizeSLEB128(NextAction);
3123 SizeSiteActions += SizeAction;
3124
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003125 ActionEntry Action = {ValueForTypeID, NextAction, PrevAction};
Duncan Sandsb32edb42007-06-06 15:37:31 +00003126 Actions.push_back(Action);
3127
3128 PrevAction = &Actions.back();
3129 }
3130
3131 // Record the first action of the landing pad site.
3132 FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
3133 } // else identical - re-use previous FirstAction
3134
3135 FirstActions.push_back(FirstAction);
Duncan Sands7bf7a442007-05-21 18:50:28 +00003136
Anton Korobeynikov29c9caf2007-05-11 08:23:57 +00003137 // Compute this sites contribution to size.
Anton Korobeynikov22d5c372007-05-11 08:47:35 +00003138 SizeActions += SizeSiteActions;
Jim Laskeybacd3042007-02-21 22:48:45 +00003139 }
Duncan Sands57810cd2007-09-05 11:27:52 +00003140
Duncan Sands481dc722007-12-19 07:36:31 +00003141 // Compute the call-site table. The entry for an invoke has a try-range
3142 // containing the call, a non-zero landing pad and an appropriate action.
3143 // The entry for an ordinary call has a try-range containing the call and
3144 // zero for the landing pad and the action. Calls marked 'nounwind' have
3145 // no entry and must not be contained in the try-range of any entry - they
3146 // form gaps in the table. Entries must be ordered by try-range address.
Duncan Sands57810cd2007-09-05 11:27:52 +00003147 SmallVector<CallSiteEntry, 64> CallSites;
3148
3149 RangeMapType PadMap;
Duncan Sands481dc722007-12-19 07:36:31 +00003150 // Invokes and nounwind calls have entries in PadMap (due to being bracketed
3151 // by try-range labels when lowered). Ordinary calls do not, so appropriate
3152 // try-ranges for them need be deduced.
Duncan Sands57810cd2007-09-05 11:27:52 +00003153 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3154 const LandingPadInfo *LandingPad = LandingPads[i];
Duncan Sands481dc722007-12-19 07:36:31 +00003155 for (unsigned j = 0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
Duncan Sands57810cd2007-09-05 11:27:52 +00003156 unsigned BeginLabel = LandingPad->BeginLabels[j];
3157 assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
3158 PadRange P = { i, j };
3159 PadMap[BeginLabel] = P;
3160 }
3161 }
3162
Duncan Sands481dc722007-12-19 07:36:31 +00003163 // The end label of the previous invoke or nounwind try-range.
Duncan Sands57810cd2007-09-05 11:27:52 +00003164 unsigned LastLabel = 0;
Duncan Sands481dc722007-12-19 07:36:31 +00003165
3166 // Whether there is a potentially throwing instruction (currently this means
3167 // an ordinary call) between the end of the previous try-range and now.
3168 bool SawPotentiallyThrowing = false;
3169
3170 // Whether the last callsite entry was for an invoke.
3171 bool PreviousIsInvoke = false;
3172
Duncan Sands481dc722007-12-19 07:36:31 +00003173 // Visit all instructions in order of address.
Duncan Sands57810cd2007-09-05 11:27:52 +00003174 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
3175 I != E; ++I) {
3176 for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
3177 MI != E; ++MI) {
3178 if (MI->getOpcode() != TargetInstrInfo::LABEL) {
Chris Lattner749c6f62008-01-07 07:27:27 +00003179 SawPotentiallyThrowing |= MI->getDesc().isCall();
Duncan Sands57810cd2007-09-05 11:27:52 +00003180 continue;
3181 }
3182
Chris Lattner9e330492007-12-30 20:50:28 +00003183 unsigned BeginLabel = MI->getOperand(0).getImm();
Duncan Sands57810cd2007-09-05 11:27:52 +00003184 assert(BeginLabel && "Invalid label!");
Duncan Sands98865042007-09-05 14:12:46 +00003185
Duncan Sands481dc722007-12-19 07:36:31 +00003186 // End of the previous try-range?
Duncan Sands98865042007-09-05 14:12:46 +00003187 if (BeginLabel == LastLabel)
Duncan Sands481dc722007-12-19 07:36:31 +00003188 SawPotentiallyThrowing = false;
Duncan Sands57810cd2007-09-05 11:27:52 +00003189
Duncan Sands481dc722007-12-19 07:36:31 +00003190 // Beginning of a new try-range?
Duncan Sands57810cd2007-09-05 11:27:52 +00003191 RangeMapType::iterator L = PadMap.find(BeginLabel);
Duncan Sands57810cd2007-09-05 11:27:52 +00003192 if (L == PadMap.end())
Duncan Sands481dc722007-12-19 07:36:31 +00003193 // Nope, it was just some random label.
Duncan Sands57810cd2007-09-05 11:27:52 +00003194 continue;
3195
3196 PadRange P = L->second;
3197 const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
3198
3199 assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
3200 "Inconsistent landing pad map!");
3201
3202 // If some instruction between the previous try-range and this one may
3203 // throw, create a call-site entry with no landing pad for the region
3204 // between the try-ranges.
Duncan Sands481dc722007-12-19 07:36:31 +00003205 if (SawPotentiallyThrowing) {
Duncan Sands57810cd2007-09-05 11:27:52 +00003206 CallSiteEntry Site = {LastLabel, BeginLabel, 0, 0};
3207 CallSites.push_back(Site);
Duncan Sands481dc722007-12-19 07:36:31 +00003208 PreviousIsInvoke = false;
Duncan Sands57810cd2007-09-05 11:27:52 +00003209 }
3210
3211 LastLabel = LandingPad->EndLabels[P.RangeIndex];
Duncan Sands481dc722007-12-19 07:36:31 +00003212 assert(BeginLabel && LastLabel && "Invalid landing pad!");
Duncan Sands57810cd2007-09-05 11:27:52 +00003213
Duncan Sands481dc722007-12-19 07:36:31 +00003214 if (LandingPad->LandingPadLabel) {
3215 // This try-range is for an invoke.
3216 CallSiteEntry Site = {BeginLabel, LastLabel,
3217 LandingPad->LandingPadLabel, FirstActions[P.PadIndex]};
Duncan Sands57810cd2007-09-05 11:27:52 +00003218
Duncan Sands481dc722007-12-19 07:36:31 +00003219 // Try to merge with the previous call-site.
3220 if (PreviousIsInvoke) {
3221 CallSiteEntry &Prev = CallSites[CallSites.size()-1];
3222 if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
3223 // Extend the range of the previous entry.
3224 Prev.EndLabel = Site.EndLabel;
3225 continue;
3226 }
Duncan Sands57810cd2007-09-05 11:27:52 +00003227 }
Duncan Sands57810cd2007-09-05 11:27:52 +00003228
Duncan Sands481dc722007-12-19 07:36:31 +00003229 // Otherwise, create a new call-site.
3230 CallSites.push_back(Site);
3231 PreviousIsInvoke = true;
3232 } else {
3233 // Create a gap.
3234 PreviousIsInvoke = false;
3235 }
Duncan Sands57810cd2007-09-05 11:27:52 +00003236 }
3237 }
3238 // If some instruction between the previous try-range and the end of the
3239 // function may throw, create a call-site entry with no landing pad for the
3240 // region following the try-range.
Duncan Sands481dc722007-12-19 07:36:31 +00003241 if (SawPotentiallyThrowing) {
Duncan Sands57810cd2007-09-05 11:27:52 +00003242 CallSiteEntry Site = {LastLabel, 0, 0, 0};
3243 CallSites.push_back(Site);
3244 }
3245
Jim Laskeybacd3042007-02-21 22:48:45 +00003246 // Final tallies.
Duncan Sands57810cd2007-09-05 11:27:52 +00003247 unsigned SizeSites = CallSites.size() * (sizeof(int32_t) + // Site start.
3248 sizeof(int32_t) + // Site length.
3249 sizeof(int32_t)); // Landing pad.
3250 for (unsigned i = 0, e = CallSites.size(); i < e; ++i)
3251 SizeSites += Asm->SizeULEB128(CallSites[i].Action);
3252
Dan Gohman82482942007-09-27 23:12:31 +00003253 unsigned SizeTypes = TypeInfos.size() * TD->getPointerSize();
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003254
3255 unsigned TypeOffset = sizeof(int8_t) + // Call site format
3256 Asm->SizeULEB128(SizeSites) + // Call-site table length
3257 SizeSites + SizeActions + SizeTypes;
3258
3259 unsigned TotalSize = sizeof(int8_t) + // LPStart format
3260 sizeof(int8_t) + // TType format
3261 Asm->SizeULEB128(TypeOffset) + // TType base offset
3262 TypeOffset;
3263
3264 unsigned SizeAlign = (4 - TotalSize) & 3;
Duncan Sandsc1fe1662007-05-10 18:40:24 +00003265
Jim Laskeybacd3042007-02-21 22:48:45 +00003266 // Begin the exception table.
3267 Asm->SwitchToDataSection(TAI->getDwarfExceptionSection());
3268 O << "GCC_except_table" << SubprogramCount << ":\n";
Evan Cheng05548eb2008-02-29 19:36:59 +00003269 Asm->EmitAlignment(2, 0, 0, false);
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003270 for (unsigned i = 0; i != SizeAlign; ++i) {
3271 Asm->EmitInt8(0);
3272 Asm->EOL("Padding");
3273 }
Jim Laskeybacd3042007-02-21 22:48:45 +00003274 EmitLabel("exception", SubprogramCount);
Duncan Sandsc1fe1662007-05-10 18:40:24 +00003275
Jim Laskeybacd3042007-02-21 22:48:45 +00003276 // Emit the header.
3277 Asm->EmitInt8(DW_EH_PE_omit);
3278 Asm->EOL("LPStart format (DW_EH_PE_omit)");
3279 Asm->EmitInt8(DW_EH_PE_absptr);
3280 Asm->EOL("TType format (DW_EH_PE_absptr)");
3281 Asm->EmitULEB128Bytes(TypeOffset);
3282 Asm->EOL("TType base offset");
3283 Asm->EmitInt8(DW_EH_PE_udata4);
3284 Asm->EOL("Call site format (DW_EH_PE_udata4)");
3285 Asm->EmitULEB128Bytes(SizeSites);
3286 Asm->EOL("Call-site table length");
Duncan Sands53c3a332007-05-16 12:12:23 +00003287
Duncan Sands57810cd2007-09-05 11:27:52 +00003288 // Emit the landing pad site information.
3289 for (unsigned i = 0; i < CallSites.size(); ++i) {
3290 CallSiteEntry &S = CallSites[i];
3291 const char *BeginTag;
3292 unsigned BeginNumber;
Duncan Sands53c3a332007-05-16 12:12:23 +00003293
Duncan Sands57810cd2007-09-05 11:27:52 +00003294 if (!S.BeginLabel) {
3295 BeginTag = "eh_func_begin";
3296 BeginNumber = SubprogramCount;
3297 } else {
3298 BeginTag = "label";
3299 BeginNumber = S.BeginLabel;
Duncan Sands53c3a332007-05-16 12:12:23 +00003300 }
Duncan Sands53c3a332007-05-16 12:12:23 +00003301
Duncan Sands57810cd2007-09-05 11:27:52 +00003302 EmitSectionOffset(BeginTag, "eh_func_begin", BeginNumber, SubprogramCount,
Dale Johannesen4af34942008-01-15 23:24:56 +00003303 TAI->getShortenEHDataOn64Bit(), true);
Duncan Sands57810cd2007-09-05 11:27:52 +00003304 Asm->EOL("Region start");
Duncan Sands53c3a332007-05-16 12:12:23 +00003305
Duncan Sands57810cd2007-09-05 11:27:52 +00003306 if (!S.EndLabel) {
Dale Johannesen4af34942008-01-15 23:24:56 +00003307 EmitDifference("eh_func_end", SubprogramCount, BeginTag, BeginNumber,
3308 TAI->getShortenEHDataOn64Bit());
Duncan Sands57810cd2007-09-05 11:27:52 +00003309 } else {
Dale Johannesen4af34942008-01-15 23:24:56 +00003310 EmitDifference("label", S.EndLabel, BeginTag, BeginNumber,
3311 TAI->getShortenEHDataOn64Bit());
Duncan Sands57810cd2007-09-05 11:27:52 +00003312 }
3313 Asm->EOL("Region length");
Duncan Sands53c3a332007-05-16 12:12:23 +00003314
Duncan Sands57810cd2007-09-05 11:27:52 +00003315 if (!S.PadLabel) {
Dale Johannesen4af34942008-01-15 23:24:56 +00003316 if (TD->getPointerSize() == sizeof(int32_t) || TAI->getShortenEHDataOn64Bit())
Duncan Sands57810cd2007-09-05 11:27:52 +00003317 Asm->EmitInt32(0);
3318 else
3319 Asm->EmitInt64(0);
3320 } else {
3321 EmitSectionOffset("label", "eh_func_begin", S.PadLabel, SubprogramCount,
Dale Johannesen4af34942008-01-15 23:24:56 +00003322 TAI->getShortenEHDataOn64Bit(), true);
Anton Korobeynikoveeb37e02007-05-10 22:34:59 +00003323 }
Duncan Sands57810cd2007-09-05 11:27:52 +00003324 Asm->EOL("Landing pad");
3325
3326 Asm->EmitULEB128Bytes(S.Action);
3327 Asm->EOL("Action");
Jim Laskeybacd3042007-02-21 22:48:45 +00003328 }
Duncan Sands53c3a332007-05-16 12:12:23 +00003329
Jim Laskeybacd3042007-02-21 22:48:45 +00003330 // Emit the actions.
Duncan Sandsb32edb42007-06-06 15:37:31 +00003331 for (unsigned I = 0, N = Actions.size(); I != N; ++I) {
3332 ActionEntry &Action = Actions[I];
Duncan Sands7bf7a442007-05-21 18:50:28 +00003333
Duncan Sandsfccf0a22007-07-06 12:46:24 +00003334 Asm->EmitSLEB128Bytes(Action.ValueForTypeID);
Duncan Sandsb32edb42007-06-06 15:37:31 +00003335 Asm->EOL("TypeInfo index");
3336 Asm->EmitSLEB128Bytes(Action.NextAction);
3337 Asm->EOL("Next action");
Jim Laskeybacd3042007-02-21 22:48:45 +00003338 }
3339
3340 // Emit the type ids.
Jim Laskeybacd3042007-02-21 22:48:45 +00003341 for (unsigned M = TypeInfos.size(); M; --M) {
3342 GlobalVariable *GV = TypeInfos[M - 1];
Anton Korobeynikov9cc54f52007-09-02 22:07:21 +00003343
3344 PrintRelDirective();
Jim Laskeybacd3042007-02-21 22:48:45 +00003345
3346 if (GV)
3347 O << Asm->getGlobalLinkName(GV);
3348 else
3349 O << "0";
Duncan Sands57810cd2007-09-05 11:27:52 +00003350
Jim Laskeybacd3042007-02-21 22:48:45 +00003351 Asm->EOL("TypeInfo");
3352 }
3353
Duncan Sands73ef58a2007-06-02 16:53:42 +00003354 // Emit the filter typeids.
3355 for (unsigned j = 0, M = FilterIds.size(); j < M; ++j) {
3356 unsigned TypeID = FilterIds[j];
Duncan Sandsbb821dd2007-07-12 13:51:39 +00003357 Asm->EmitULEB128Bytes(TypeID);
Duncan Sands73ef58a2007-06-02 16:53:42 +00003358 Asm->EOL("Filter TypeInfo index");
Jim Laskey0102ca82007-03-01 20:26:43 +00003359 }
Duncan Sands57810cd2007-09-05 11:27:52 +00003360
Evan Cheng05548eb2008-02-29 19:36:59 +00003361 Asm->EmitAlignment(2, 0, 0, false);
Jim Laskeyb82313f2007-02-01 16:31:34 +00003362 }
3363
Jim Laskey072200c2007-01-29 18:51:14 +00003364public:
3365 //===--------------------------------------------------------------------===//
3366 // Main entry points.
3367 //
3368 DwarfException(std::ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
Chris Lattner9251f132007-09-24 03:35:37 +00003369 : Dwarf(OS, A, T, "eh")
Jim Laskeybacd3042007-02-21 22:48:45 +00003370 , shouldEmit(false)
Jim Laskey072200c2007-01-29 18:51:14 +00003371 {}
3372
3373 virtual ~DwarfException() {}
3374
3375 /// SetModuleInfo - Set machine module information when it's known that pass
3376 /// manager has created it. Set by the target AsmPrinter.
3377 void SetModuleInfo(MachineModuleInfo *mmi) {
Jim Laskey3f09fc22007-02-28 18:38:31 +00003378 MMI = mmi;
Jim Laskey072200c2007-01-29 18:51:14 +00003379 }
3380
3381 /// BeginModule - Emit all exception information that should come prior to the
3382 /// content.
3383 void BeginModule(Module *M) {
3384 this->M = M;
Jim Laskey072200c2007-01-29 18:51:14 +00003385 }
3386
3387 /// EndModule - Emit all exception information that should come after the
3388 /// content.
3389 void EndModule() {
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003390 if (!shouldEmit) return;
Anton Korobeynikov8c7c1732007-05-13 15:42:26 +00003391
3392 const std::vector<Function *> Personalities = MMI->getPersonalities();
3393 for (unsigned i =0; i < Personalities.size(); ++i)
3394 EmitCommonEHFrame(Personalities[i], i);
Bill Wendlingd60da492007-09-11 08:27:17 +00003395
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003396 for (std::vector<FunctionEHFrameInfo>::iterator I = EHFrames.begin(),
3397 E = EHFrames.end(); I != E; ++I)
3398 EmitEHFrame(*I);
Jim Laskey072200c2007-01-29 18:51:14 +00003399 }
3400
3401 /// BeginFunction - Gather pre-function exception information. Assumes being
3402 /// emitted immediately after the function entry point.
3403 void BeginFunction(MachineFunction *MF) {
3404 this->MF = MF;
3405
Jim Laskey3f09fc22007-02-28 18:38:31 +00003406 if (MMI &&
3407 ExceptionHandling &&
Anton Korobeynikov2a07e2f2007-05-05 09:04:50 +00003408 TAI->doesSupportExceptionHandling()) {
Jim Laskey3f09fc22007-02-28 18:38:31 +00003409 shouldEmit = true;
3410 // Assumes in correct section after the entry point.
3411 EmitLabel("eh_func_begin", ++SubprogramCount);
3412 }
Jim Laskey072200c2007-01-29 18:51:14 +00003413 }
3414
3415 /// EndFunction - Gather and emit post-function exception information.
3416 ///
3417 void EndFunction() {
Jim Laskey3f09fc22007-02-28 18:38:31 +00003418 if (!shouldEmit) return;
Jim Laskeyb82313f2007-02-01 16:31:34 +00003419
3420 EmitLabel("eh_func_end", SubprogramCount);
Jim Laskeybacd3042007-02-21 22:48:45 +00003421 EmitExceptionTable();
Anton Korobeynikov0ff3ca42007-05-12 22:36:25 +00003422
3423 // Save EH frame information
Bill Wendling6e198962007-09-18 01:47:22 +00003424 EHFrames.
3425 push_back(FunctionEHFrameInfo(getAsm()->getCurrentFunctionEHName(MF),
3426 SubprogramCount,
3427 MMI->getPersonalityIndex(),
3428 MF->getFrameInfo()->hasCalls(),
3429 !MMI->getLandingPads().empty(),
Dale Johannesen1d4ce2a2007-11-20 23:24:42 +00003430 MMI->getFrameMoves(),
Dale Johannesen48ae02f2008-01-16 19:59:28 +00003431 MF->getFunction()));
Jim Laskey072200c2007-01-29 18:51:14 +00003432 }
3433};
3434
Jim Laskey0d086af2006-02-27 12:43:29 +00003435} // End of namespace llvm
Jim Laskey063e7652006-01-17 17:31:53 +00003436
3437//===----------------------------------------------------------------------===//
3438
Jim Laskeyd18e2892006-01-20 20:34:06 +00003439/// Emit - Print the abbreviation using the specified Dwarf writer.
3440///
Jim Laskey072200c2007-01-29 18:51:14 +00003441void DIEAbbrev::Emit(const DwarfDebug &DD) const {
Jim Laskeyd18e2892006-01-20 20:34:06 +00003442 // Emit its Dwarf tag type.
Jim Laskey072200c2007-01-29 18:51:14 +00003443 DD.getAsm()->EmitULEB128Bytes(Tag);
3444 DD.getAsm()->EOL(TagString(Tag));
Jim Laskeyd18e2892006-01-20 20:34:06 +00003445
3446 // Emit whether it has children DIEs.
Jim Laskey072200c2007-01-29 18:51:14 +00003447 DD.getAsm()->EmitULEB128Bytes(ChildrenFlag);
3448 DD.getAsm()->EOL(ChildrenString(ChildrenFlag));
Jim Laskeyd18e2892006-01-20 20:34:06 +00003449
3450 // For each attribute description.
Jim Laskey52060a02006-01-24 00:49:18 +00003451 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
Jim Laskeyd18e2892006-01-20 20:34:06 +00003452 const DIEAbbrevData &AttrData = Data[i];
3453
3454 // Emit attribute type.
Jim Laskey072200c2007-01-29 18:51:14 +00003455 DD.getAsm()->EmitULEB128Bytes(AttrData.getAttribute());
3456 DD.getAsm()->EOL(AttributeString(AttrData.getAttribute()));
Jim Laskeyd18e2892006-01-20 20:34:06 +00003457
3458 // Emit form type.
Jim Laskey072200c2007-01-29 18:51:14 +00003459 DD.getAsm()->EmitULEB128Bytes(AttrData.getForm());
3460 DD.getAsm()->EOL(FormEncodingString(AttrData.getForm()));
Jim Laskeyd18e2892006-01-20 20:34:06 +00003461 }
3462
3463 // Mark end of abbreviation.
Jim Laskey072200c2007-01-29 18:51:14 +00003464 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(1)");
3465 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(2)");
Jim Laskeyd18e2892006-01-20 20:34:06 +00003466}
3467
3468#ifndef NDEBUG
Jim Laskeya0f3d172006-09-07 22:06:40 +00003469void DIEAbbrev::print(std::ostream &O) {
3470 O << "Abbreviation @"
3471 << std::hex << (intptr_t)this << std::dec
3472 << " "
3473 << TagString(Tag)
3474 << " "
3475 << ChildrenString(ChildrenFlag)
3476 << "\n";
3477
3478 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3479 O << " "
3480 << AttributeString(Data[i].getAttribute())
Jim Laskeyd18e2892006-01-20 20:34:06 +00003481 << " "
Jim Laskeya0f3d172006-09-07 22:06:40 +00003482 << FormEncodingString(Data[i].getForm())
Jim Laskeyd18e2892006-01-20 20:34:06 +00003483 << "\n";
Jim Laskeyd18e2892006-01-20 20:34:06 +00003484 }
Jim Laskeya0f3d172006-09-07 22:06:40 +00003485}
Bill Wendlinge8156192006-12-07 01:30:32 +00003486void DIEAbbrev::dump() { print(cerr); }
Jim Laskeyd18e2892006-01-20 20:34:06 +00003487#endif
3488
3489//===----------------------------------------------------------------------===//
3490
Jim Laskeyef42a012006-11-02 20:12:39 +00003491#ifndef NDEBUG
3492void DIEValue::dump() {
Bill Wendlinge8156192006-12-07 01:30:32 +00003493 print(cerr);
Jim Laskeyb80af6f2006-03-03 21:00:14 +00003494}
Jim Laskeyef42a012006-11-02 20:12:39 +00003495#endif
3496
3497//===----------------------------------------------------------------------===//
3498
Jim Laskey063e7652006-01-17 17:31:53 +00003499/// EmitValue - Emit integer of appropriate size.
3500///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00003501void DIEInteger::EmitValue(DwarfDebug &DD, unsigned Form) {
Jim Laskey063e7652006-01-17 17:31:53 +00003502 switch (Form) {
Jim Laskey40020172006-01-20 21:02:36 +00003503 case DW_FORM_flag: // Fall thru
Jim Laskeyb8509c52006-03-23 18:07:55 +00003504 case DW_FORM_ref1: // Fall thru
Jim Laskey072200c2007-01-29 18:51:14 +00003505 case DW_FORM_data1: DD.getAsm()->EmitInt8(Integer); break;
Jim Laskeyb8509c52006-03-23 18:07:55 +00003506 case DW_FORM_ref2: // Fall thru
Jim Laskey072200c2007-01-29 18:51:14 +00003507 case DW_FORM_data2: DD.getAsm()->EmitInt16(Integer); break;
Jim Laskeyb8509c52006-03-23 18:07:55 +00003508 case DW_FORM_ref4: // Fall thru
Jim Laskey072200c2007-01-29 18:51:14 +00003509 case DW_FORM_data4: DD.getAsm()->EmitInt32(Integer); break;
Jim Laskeyb8509c52006-03-23 18:07:55 +00003510 case DW_FORM_ref8: // Fall thru
Jim Laskey072200c2007-01-29 18:51:14 +00003511 case DW_FORM_data8: DD.getAsm()->EmitInt64(Integer); break;
3512 case DW_FORM_udata: DD.getAsm()->EmitULEB128Bytes(Integer); break;
3513 case DW_FORM_sdata: DD.getAsm()->EmitSLEB128Bytes(Integer); break;
Jim Laskeyf1cdea12007-01-25 15:12:02 +00003514 default: assert(0 && "DIE Value form not supported yet"); break;
3515 }
3516}
3517
3518/// SizeOf - Determine size of integer value in bytes.
3519///
Jim Laskey072200c2007-01-29 18:51:14 +00003520unsigned DIEInteger::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Jim Laskeyf1cdea12007-01-25 15:12:02 +00003521 switch (Form) {
3522 case DW_FORM_flag: // Fall thru
3523 case DW_FORM_ref1: // Fall thru
3524 case DW_FORM_data1: return sizeof(int8_t);
3525 case DW_FORM_ref2: // Fall thru
3526 case DW_FORM_data2: return sizeof(int16_t);
3527 case DW_FORM_ref4: // Fall thru
3528 case DW_FORM_data4: return sizeof(int32_t);
3529 case DW_FORM_ref8: // Fall thru
3530 case DW_FORM_data8: return sizeof(int64_t);
Jim Laskey072200c2007-01-29 18:51:14 +00003531 case DW_FORM_udata: return DD.getAsm()->SizeULEB128(Integer);
3532 case DW_FORM_sdata: return DD.getAsm()->SizeSLEB128(Integer);
Jim Laskey063e7652006-01-17 17:31:53 +00003533 default: assert(0 && "DIE Value form not supported yet"); break;
3534 }
Jim Laskeyf1cdea12007-01-25 15:12:02 +00003535 return 0;
Jim Laskey063e7652006-01-17 17:31:53 +00003536}
3537
Jim Laskey063e7652006-01-17 17:31:53 +00003538//===----------------------------------------------------------------------===//
3539
3540/// EmitValue - Emit string value.
3541///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00003542void DIEString::EmitValue(DwarfDebug &DD, unsigned Form) {
Jim Laskey072200c2007-01-29 18:51:14 +00003543 DD.getAsm()->EmitString(String);
Jim Laskey063e7652006-01-17 17:31:53 +00003544}
3545
Jim Laskey063e7652006-01-17 17:31:53 +00003546//===----------------------------------------------------------------------===//
3547
3548/// EmitValue - Emit label value.
3549///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00003550void DIEDwarfLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
Dan Gohman9fda5be2007-09-28 16:50:28 +00003551 bool IsSmall = Form == DW_FORM_data4;
3552 DD.EmitReference(Label, false, IsSmall);
Jim Laskey063e7652006-01-17 17:31:53 +00003553}
3554
3555/// SizeOf - Determine size of label value in bytes.
3556///
Jim Laskey072200c2007-01-29 18:51:14 +00003557unsigned DIEDwarfLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Dan Gohman9fda5be2007-09-28 16:50:28 +00003558 if (Form == DW_FORM_data4) return 4;
Dan Gohman82482942007-09-27 23:12:31 +00003559 return DD.getTargetData()->getPointerSize();
Jim Laskey063e7652006-01-17 17:31:53 +00003560}
Jim Laskeyef42a012006-11-02 20:12:39 +00003561
Jim Laskey063e7652006-01-17 17:31:53 +00003562//===----------------------------------------------------------------------===//
3563
Jim Laskeyd18e2892006-01-20 20:34:06 +00003564/// EmitValue - Emit label value.
3565///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00003566void DIEObjectLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
Dan Gohman9fda5be2007-09-28 16:50:28 +00003567 bool IsSmall = Form == DW_FORM_data4;
3568 DD.EmitReference(Label, false, IsSmall);
Jim Laskeyd18e2892006-01-20 20:34:06 +00003569}
3570
3571/// SizeOf - Determine size of label value in bytes.
3572///
Jim Laskey072200c2007-01-29 18:51:14 +00003573unsigned DIEObjectLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Dan Gohman9fda5be2007-09-28 16:50:28 +00003574 if (Form == DW_FORM_data4) return 4;
Dan Gohman82482942007-09-27 23:12:31 +00003575 return DD.getTargetData()->getPointerSize();
Jim Laskeyd18e2892006-01-20 20:34:06 +00003576}
3577
3578//===----------------------------------------------------------------------===//
3579
Jim Laskey063e7652006-01-17 17:31:53 +00003580/// EmitValue - Emit delta value.
3581///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00003582void DIEDelta::EmitValue(DwarfDebug &DD, unsigned Form) {
Jim Laskey2b4e98c2006-12-06 17:43:18 +00003583 bool IsSmall = Form == DW_FORM_data4;
Jim Laskey072200c2007-01-29 18:51:14 +00003584 DD.EmitDifference(LabelHi, LabelLo, IsSmall);
Jim Laskey063e7652006-01-17 17:31:53 +00003585}
3586
3587/// SizeOf - Determine size of delta value in bytes.
3588///
Jim Laskey072200c2007-01-29 18:51:14 +00003589unsigned DIEDelta::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Jim Laskey2b4e98c2006-12-06 17:43:18 +00003590 if (Form == DW_FORM_data4) return 4;
Dan Gohman82482942007-09-27 23:12:31 +00003591 return DD.getTargetData()->getPointerSize();
Jim Laskey063e7652006-01-17 17:31:53 +00003592}
3593
3594//===----------------------------------------------------------------------===//
Jim Laskeyef42a012006-11-02 20:12:39 +00003595
Jim Laskeyb8509c52006-03-23 18:07:55 +00003596/// EmitValue - Emit debug information entry offset.
Jim Laskeyd18e2892006-01-20 20:34:06 +00003597///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00003598void DIEntry::EmitValue(DwarfDebug &DD, unsigned Form) {
Jim Laskey072200c2007-01-29 18:51:14 +00003599 DD.getAsm()->EmitInt32(Entry->getOffset());
Jim Laskeyd18e2892006-01-20 20:34:06 +00003600}
Jim Laskeyd18e2892006-01-20 20:34:06 +00003601
3602//===----------------------------------------------------------------------===//
3603
Jim Laskeyb80af6f2006-03-03 21:00:14 +00003604/// ComputeSize - calculate the size of the block.
3605///
Jim Laskey072200c2007-01-29 18:51:14 +00003606unsigned DIEBlock::ComputeSize(DwarfDebug &DD) {
Jim Laskeyef42a012006-11-02 20:12:39 +00003607 if (!Size) {
3608 const std::vector<DIEAbbrevData> &AbbrevData = Abbrev.getData();
3609
3610 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
Jim Laskey072200c2007-01-29 18:51:14 +00003611 Size += Values[i]->SizeOf(DD, AbbrevData[i].getForm());
Jim Laskeyef42a012006-11-02 20:12:39 +00003612 }
Jim Laskeyb80af6f2006-03-03 21:00:14 +00003613 }
3614 return Size;
3615}
3616
Jim Laskeyb80af6f2006-03-03 21:00:14 +00003617/// EmitValue - Emit block data.
3618///
Anton Korobeynikov6a143592007-03-07 08:25:02 +00003619void DIEBlock::EmitValue(DwarfDebug &DD, unsigned Form) {
Jim Laskeyb80af6f2006-03-03 21:00:14 +00003620 switch (Form) {
Jim Laskey072200c2007-01-29 18:51:14 +00003621 case DW_FORM_block1: DD.getAsm()->EmitInt8(Size); break;
3622 case DW_FORM_block2: DD.getAsm()->EmitInt16(Size); break;
3623 case DW_FORM_block4: DD.getAsm()->EmitInt32(Size); break;
3624 case DW_FORM_block: DD.getAsm()->EmitULEB128Bytes(Size); break;
Jim Laskeyf1cdea12007-01-25 15:12:02 +00003625 default: assert(0 && "Improper form for block"); break;
Jim Laskeyb80af6f2006-03-03 21:00:14 +00003626 }
Jim Laskeyef42a012006-11-02 20:12:39 +00003627
3628 const std::vector<DIEAbbrevData> &AbbrevData = Abbrev.getData();
3629
Jim Laskeyb80af6f2006-03-03 21:00:14 +00003630 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
Jim Laskeybacd3042007-02-21 22:48:45 +00003631 DD.getAsm()->EOL();
Jim Laskey072200c2007-01-29 18:51:14 +00003632 Values[i]->EmitValue(DD, AbbrevData[i].getForm());
Jim Laskeyb80af6f2006-03-03 21:00:14 +00003633 }
3634}
3635
3636/// SizeOf - Determine size of block data in bytes.
3637///
Jim Laskey072200c2007-01-29 18:51:14 +00003638unsigned DIEBlock::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Jim Laskeyb80af6f2006-03-03 21:00:14 +00003639 switch (Form) {
3640 case DW_FORM_block1: return Size + sizeof(int8_t);
3641 case DW_FORM_block2: return Size + sizeof(int16_t);
3642 case DW_FORM_block4: return Size + sizeof(int32_t);
Jim Laskey072200c2007-01-29 18:51:14 +00003643 case DW_FORM_block: return Size + DD.getAsm()->SizeULEB128(Size);
Jim Laskeyb80af6f2006-03-03 21:00:14 +00003644 default: assert(0 && "Improper form for block"); break;
3645 }
3646 return 0;
3647}
3648
Jim Laskeyb80af6f2006-03-03 21:00:14 +00003649//===----------------------------------------------------------------------===//
Jim Laskeyef42a012006-11-02 20:12:39 +00003650/// DIE Implementation
Jim Laskeyd18e2892006-01-20 20:34:06 +00003651
3652DIE::~DIE() {
Jim Laskeyef42a012006-11-02 20:12:39 +00003653 for (unsigned i = 0, N = Children.size(); i < N; ++i)
Jim Laskeyd18e2892006-01-20 20:34:06 +00003654 delete Children[i];
Jim Laskeyd18e2892006-01-20 20:34:06 +00003655}
Jim Laskeyef42a012006-11-02 20:12:39 +00003656
Jim Laskeyb8509c52006-03-23 18:07:55 +00003657/// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
3658///
3659void DIE::AddSiblingOffset() {
3660 DIEInteger *DI = new DIEInteger(0);
3661 Values.insert(Values.begin(), DI);
Jim Laskeya9c83fe2006-10-30 15:59:54 +00003662 Abbrev.AddFirstAttribute(DW_AT_sibling, DW_FORM_ref4);
Jim Laskeyb8509c52006-03-23 18:07:55 +00003663}
3664
Jim Laskeyef42a012006-11-02 20:12:39 +00003665/// Profile - Used to gather unique data for the value folding set.
Jim Laskeyd18e2892006-01-20 20:34:06 +00003666///
Jim Laskeyef42a012006-11-02 20:12:39 +00003667void DIE::Profile(FoldingSetNodeID &ID) {
3668 Abbrev.Profile(ID);
3669
3670 for (unsigned i = 0, N = Children.size(); i < N; ++i)
3671 ID.AddPointer(Children[i]);
3672
3673 for (unsigned j = 0, M = Values.size(); j < M; ++j)
3674 ID.AddPointer(Values[j]);
Jim Laskeyd8f77ba2006-01-27 15:20:54 +00003675}
Jim Laskeyef42a012006-11-02 20:12:39 +00003676
3677#ifndef NDEBUG
3678void DIE::print(std::ostream &O, unsigned IncIndent) {
3679 static unsigned IndentCount = 0;
3680 IndentCount += IncIndent;
3681 const std::string Indent(IndentCount, ' ');
3682 bool isBlock = Abbrev.getTag() == 0;
3683
3684 if (!isBlock) {
3685 O << Indent
3686 << "Die: "
3687 << "0x" << std::hex << (intptr_t)this << std::dec
3688 << ", Offset: " << Offset
3689 << ", Size: " << Size
3690 << "\n";
Jim Laskeyd8f77ba2006-01-27 15:20:54 +00003691
Jim Laskeyef42a012006-11-02 20:12:39 +00003692 O << Indent
3693 << TagString(Abbrev.getTag())
Jim Laskey063e7652006-01-17 17:31:53 +00003694 << " "
Jim Laskeyef42a012006-11-02 20:12:39 +00003695 << ChildrenString(Abbrev.getChildrenFlag());
3696 } else {
3697 O << "Size: " << Size;
Jim Laskey063e7652006-01-17 17:31:53 +00003698 }
3699 O << "\n";
Jim Laskeya7cea6f2006-01-04 13:52:30 +00003700
Jim Laskeyef42a012006-11-02 20:12:39 +00003701 const std::vector<DIEAbbrevData> &Data = Abbrev.getData();
Jim Laskeya7cea6f2006-01-04 13:52:30 +00003702
Jim Laskeyef42a012006-11-02 20:12:39 +00003703 IndentCount += 2;
3704 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3705 O << Indent;
3706 if (!isBlock) {
3707 O << AttributeString(Data[i].getAttribute());
Jim Laskeyd8f77ba2006-01-27 15:20:54 +00003708 } else {
Jim Laskeyef42a012006-11-02 20:12:39 +00003709 O << "Blk[" << i << "]";
Jim Laskeyd8f77ba2006-01-27 15:20:54 +00003710 }
Jim Laskeyef42a012006-11-02 20:12:39 +00003711 O << " "
3712 << FormEncodingString(Data[i].getForm())
3713 << " ";
3714 Values[i]->print(O);
Jim Laskey0d086af2006-02-27 12:43:29 +00003715 O << "\n";
Jim Laskey063e7652006-01-17 17:31:53 +00003716 }
Jim Laskeyef42a012006-11-02 20:12:39 +00003717 IndentCount -= 2;
Jim Laskey063e7652006-01-17 17:31:53 +00003718
Jim Laskeyef42a012006-11-02 20:12:39 +00003719 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
3720 Children[j]->print(O, 4);
Jim Laskey063e7652006-01-17 17:31:53 +00003721 }
Jim Laskey063e7652006-01-17 17:31:53 +00003722
Jim Laskeyef42a012006-11-02 20:12:39 +00003723 if (!isBlock) O << "\n";
3724 IndentCount -= IncIndent;
Jim Laskey19ef4ef2006-01-17 20:41:40 +00003725}
3726
Jim Laskeyef42a012006-11-02 20:12:39 +00003727void DIE::dump() {
Bill Wendlinge8156192006-12-07 01:30:32 +00003728 print(cerr);
Jim Laskey41886992006-04-07 16:34:46 +00003729}
Jim Laskeybd761842006-02-27 17:27:12 +00003730#endif
Jim Laskey65195462006-10-30 13:35:07 +00003731
3732//===----------------------------------------------------------------------===//
3733/// DwarfWriter Implementation
Jim Laskeyef42a012006-11-02 20:12:39 +00003734///
Jim Laskey65195462006-10-30 13:35:07 +00003735
3736DwarfWriter::DwarfWriter(std::ostream &OS, AsmPrinter *A,
3737 const TargetAsmInfo *T) {
Jim Laskey072200c2007-01-29 18:51:14 +00003738 DE = new DwarfException(OS, A, T);
3739 DD = new DwarfDebug(OS, A, T);
Jim Laskey65195462006-10-30 13:35:07 +00003740}
3741
3742DwarfWriter::~DwarfWriter() {
Jim Laskey072200c2007-01-29 18:51:14 +00003743 delete DE;
3744 delete DD;
Jim Laskey65195462006-10-30 13:35:07 +00003745}
3746
Jim Laskey44c3b9f2007-01-26 21:22:28 +00003747/// SetModuleInfo - Set machine module info when it's known that pass manager
3748/// has created it. Set by the target AsmPrinter.
3749void DwarfWriter::SetModuleInfo(MachineModuleInfo *MMI) {
Jim Laskey072200c2007-01-29 18:51:14 +00003750 DD->SetModuleInfo(MMI);
Jim Laskeyb82313f2007-02-01 16:31:34 +00003751 DE->SetModuleInfo(MMI);
Jim Laskey65195462006-10-30 13:35:07 +00003752}
3753
3754/// BeginModule - Emit all Dwarf sections that should come prior to the
3755/// content.
3756void DwarfWriter::BeginModule(Module *M) {
Jim Laskey072200c2007-01-29 18:51:14 +00003757 DE->BeginModule(M);
3758 DD->BeginModule(M);
Jim Laskey65195462006-10-30 13:35:07 +00003759}
3760
3761/// EndModule - Emit all Dwarf sections that should come after the content.
3762///
3763void DwarfWriter::EndModule() {
Jim Laskey072200c2007-01-29 18:51:14 +00003764 DE->EndModule();
3765 DD->EndModule();
Jim Laskey65195462006-10-30 13:35:07 +00003766}
3767
3768/// BeginFunction - Gather pre-function debug information. Assumes being
3769/// emitted immediately after the function entry point.
3770void DwarfWriter::BeginFunction(MachineFunction *MF) {
Jim Laskey072200c2007-01-29 18:51:14 +00003771 DE->BeginFunction(MF);
3772 DD->BeginFunction(MF);
Jim Laskey65195462006-10-30 13:35:07 +00003773}
3774
3775/// EndFunction - Gather and emit post-function debug information.
3776///
3777void DwarfWriter::EndFunction() {
Jim Laskey072200c2007-01-29 18:51:14 +00003778 DD->EndFunction();
Jim Laskeyb82313f2007-02-01 16:31:34 +00003779 DE->EndFunction();
3780
Jim Laskey3f09fc22007-02-28 18:38:31 +00003781 if (MachineModuleInfo *MMI = DD->getMMI() ? DD->getMMI() : DE->getMMI()) {
Jim Laskeyb82313f2007-02-01 16:31:34 +00003782 // Clear function debug information.
3783 MMI->EndFunction();
3784 }
Jim Laskey65195462006-10-30 13:35:07 +00003785}