blob: cbe8d7048b04a44fd2565cba430a4330480acdcb [file] [log] [blame]
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001//===-- llvm/CodeGen/DwarfWriter.cpp - Dwarf Framework ----------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner081ce942007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file contains support for writing dwarf info into asm files.
11//
12//===----------------------------------------------------------------------===//
13
14#include "llvm/CodeGen/DwarfWriter.h"
15
16#include "llvm/ADT/DenseMap.h"
17#include "llvm/ADT/FoldingSet.h"
18#include "llvm/ADT/StringExtras.h"
19#include "llvm/ADT/UniqueVector.h"
20#include "llvm/Module.h"
Devang Patelb3907da2009-01-05 23:03:32 +000021#include "llvm/DerivedTypes.h"
Devang Patel2da0cc42009-01-15 23:41:32 +000022#include "llvm/Constants.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000023#include "llvm/CodeGen/AsmPrinter.h"
24#include "llvm/CodeGen/MachineModuleInfo.h"
25#include "llvm/CodeGen/MachineFrameInfo.h"
26#include "llvm/CodeGen/MachineLocation.h"
Devang Patelfc187162009-01-05 17:57:47 +000027#include "llvm/Analysis/DebugInfo.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000028#include "llvm/Support/Debug.h"
29#include "llvm/Support/Dwarf.h"
30#include "llvm/Support/CommandLine.h"
31#include "llvm/Support/DataTypes.h"
32#include "llvm/Support/Mangler.h"
Owen Anderson847b99b2008-08-21 00:14:44 +000033#include "llvm/Support/raw_ostream.h"
Dan Gohman80bbde72007-09-24 21:32:18 +000034#include "llvm/System/Path.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000035#include "llvm/Target/TargetAsmInfo.h"
Dan Gohman1e57df32008-02-10 18:45:23 +000036#include "llvm/Target/TargetRegisterInfo.h"
Dan Gohmanf17a25c2007-07-18 16:29:46 +000037#include "llvm/Target/TargetData.h"
38#include "llvm/Target/TargetFrameInfo.h"
39#include "llvm/Target/TargetInstrInfo.h"
40#include "llvm/Target/TargetMachine.h"
41#include "llvm/Target/TargetOptions.h"
42#include <ostream>
43#include <string>
44using namespace llvm;
45using namespace llvm::dwarf;
46
Devang Patelaa1e8432009-01-08 23:40:34 +000047static RegisterPass<DwarfWriter>
48X("dwarfwriter", "DWARF Information Writer");
49char DwarfWriter::ID = 0;
50
Dan Gohmanf17a25c2007-07-18 16:29:46 +000051namespace llvm {
aslc200b112008-08-16 12:57:46 +000052
Dan Gohmanf17a25c2007-07-18 16:29:46 +000053//===----------------------------------------------------------------------===//
54
55/// Configuration values for initial hash set sizes (log2).
56///
57static const unsigned InitDiesSetSize = 9; // 512
58static const unsigned InitAbbreviationsSetSize = 9; // 512
59static const unsigned InitValuesSetSize = 9; // 512
60
61//===----------------------------------------------------------------------===//
62/// Forward declarations.
63///
64class DIE;
65class DIEValue;
66
67//===----------------------------------------------------------------------===//
Devang Patelb3907da2009-01-05 23:03:32 +000068/// Utility routines.
69///
Devang Patelb28de842009-01-17 08:01:33 +000070/// getGlobalVariablesUsing - Return all of the GlobalVariables which have the
71/// specified value in their initializer somewhere.
Devang Patelb3907da2009-01-05 23:03:32 +000072static void
73getGlobalVariablesUsing(Value *V, std::vector<GlobalVariable*> &Result) {
Devang Patelb28de842009-01-17 08:01:33 +000074 // Scan though value users.
Devang Patelb3907da2009-01-05 23:03:32 +000075 for (Value::use_iterator I = V->use_begin(), E = V->use_end(); I != E; ++I) {
76 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(*I)) {
Devang Patelb28de842009-01-17 08:01:33 +000077 // If the user is a GlobalVariable then add to result.
Devang Patelb3907da2009-01-05 23:03:32 +000078 Result.push_back(GV);
79 } else if (Constant *C = dyn_cast<Constant>(*I)) {
Devang Patelb28de842009-01-17 08:01:33 +000080 // If the user is a constant variable then scan its users.
Devang Patelb3907da2009-01-05 23:03:32 +000081 getGlobalVariablesUsing(C, Result);
82 }
83 }
84}
85
Devang Patelb28de842009-01-17 08:01:33 +000086/// getGlobalVariablesUsing - Return all of the GlobalVariables that use the
87/// named GlobalVariable.
Devang Patelb3907da2009-01-05 23:03:32 +000088static void
89getGlobalVariablesUsing(Module &M, const std::string &RootName,
90 std::vector<GlobalVariable*> &Result) {
91 std::vector<const Type*> FieldTypes;
92 FieldTypes.push_back(Type::Int32Ty);
93 FieldTypes.push_back(Type::Int32Ty);
94
Devang Patelb28de842009-01-17 08:01:33 +000095 // Get the GlobalVariable root.
Devang Patelb3907da2009-01-05 23:03:32 +000096 GlobalVariable *UseRoot = M.getGlobalVariable(RootName,
97 StructType::get(FieldTypes));
98
Devang Patelb28de842009-01-17 08:01:33 +000099 // If present and linkonce then scan for users.
Devang Patelb3907da2009-01-05 23:03:32 +0000100 if (UseRoot && UseRoot->hasLinkOnceLinkage())
101 getGlobalVariablesUsing(UseRoot, Result);
102}
103
Devang Patel2da0cc42009-01-15 23:41:32 +0000104/// getGlobalVariable - Return either a direct or cast Global value.
105///
106static GlobalVariable *getGlobalVariable(Value *V) {
107 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
108 return GV;
109 } else if (ConstantExpr *CE = dyn_cast<ConstantExpr>(V)) {
110 if (CE->getOpcode() == Instruction::BitCast) {
111 return dyn_cast<GlobalVariable>(CE->getOperand(0));
112 } else if (CE->getOpcode() == Instruction::GetElementPtr) {
113 for (unsigned int i=1; i<CE->getNumOperands(); i++) {
114 if (!CE->getOperand(i)->isNullValue())
115 return NULL;
116 }
117 return dyn_cast<GlobalVariable>(CE->getOperand(0));
118 }
119 }
120 return NULL;
121}
122
Devang Patelb3907da2009-01-05 23:03:32 +0000123//===----------------------------------------------------------------------===//
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000124/// DWLabel - Labels are used to track locations in the assembler file.
aslc200b112008-08-16 12:57:46 +0000125/// Labels appear in the form @verbatim <prefix><Tag><Number> @endverbatim,
126/// where the tag is a category of label (Ex. location) and number is a value
Reid Spencer37c7cea2007-08-05 20:06:04 +0000127/// unique in that category.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000128class DWLabel {
129public:
130 /// Tag - Label category tag. Should always be a staticly declared C string.
131 ///
132 const char *Tag;
aslc200b112008-08-16 12:57:46 +0000133
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000134 /// Number - Value to make label unique.
135 ///
136 unsigned Number;
137
138 DWLabel(const char *T, unsigned N) : Tag(T), Number(N) {}
aslc200b112008-08-16 12:57:46 +0000139
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000140 void Profile(FoldingSetNodeID &ID) const {
141 ID.AddString(std::string(Tag));
142 ID.AddInteger(Number);
143 }
aslc200b112008-08-16 12:57:46 +0000144
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000145#ifndef NDEBUG
146 void print(std::ostream *O) const {
147 if (O) print(*O);
148 }
149 void print(std::ostream &O) const {
150 O << "." << Tag;
151 if (Number) O << Number;
152 }
153#endif
154};
155
156//===----------------------------------------------------------------------===//
157/// DIEAbbrevData - Dwarf abbreviation data, describes the one attribute of a
158/// Dwarf abbreviation.
159class DIEAbbrevData {
160private:
161 /// Attribute - Dwarf attribute code.
162 ///
163 unsigned Attribute;
aslc200b112008-08-16 12:57:46 +0000164
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000165 /// Form - Dwarf form code.
aslc200b112008-08-16 12:57:46 +0000166 ///
167 unsigned Form;
168
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000169public:
170 DIEAbbrevData(unsigned A, unsigned F)
171 : Attribute(A)
172 , Form(F)
173 {}
aslc200b112008-08-16 12:57:46 +0000174
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000175 // Accessors.
176 unsigned getAttribute() const { return Attribute; }
177 unsigned getForm() const { return Form; }
178
179 /// Profile - Used to gather unique data for the abbreviation folding set.
180 ///
181 void Profile(FoldingSetNodeID &ID)const {
182 ID.AddInteger(Attribute);
183 ID.AddInteger(Form);
184 }
185};
186
187//===----------------------------------------------------------------------===//
188/// DIEAbbrev - Dwarf abbreviation, describes the organization of a debug
189/// information object.
190class DIEAbbrev : public FoldingSetNode {
191private:
192 /// Tag - Dwarf tag code.
193 ///
194 unsigned Tag;
aslc200b112008-08-16 12:57:46 +0000195
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000196 /// Unique number for node.
197 ///
198 unsigned Number;
199
200 /// ChildrenFlag - Dwarf children flag.
201 ///
202 unsigned ChildrenFlag;
203
204 /// Data - Raw data bytes for abbreviation.
205 ///
Owen Anderson88dd6232008-06-24 21:44:59 +0000206 SmallVector<DIEAbbrevData, 8> Data;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000207
208public:
209
210 DIEAbbrev(unsigned T, unsigned C)
211 : Tag(T)
212 , ChildrenFlag(C)
213 , Data()
214 {}
215 ~DIEAbbrev() {}
aslc200b112008-08-16 12:57:46 +0000216
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000217 // Accessors.
218 unsigned getTag() const { return Tag; }
219 unsigned getNumber() const { return Number; }
220 unsigned getChildrenFlag() const { return ChildrenFlag; }
Owen Anderson88dd6232008-06-24 21:44:59 +0000221 const SmallVector<DIEAbbrevData, 8> &getData() const { return Data; }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000222 void setTag(unsigned T) { Tag = T; }
223 void setChildrenFlag(unsigned CF) { ChildrenFlag = CF; }
224 void setNumber(unsigned N) { Number = N; }
aslc200b112008-08-16 12:57:46 +0000225
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000226 /// AddAttribute - Adds another set of attribute information to the
227 /// abbreviation.
228 void AddAttribute(unsigned Attribute, unsigned Form) {
229 Data.push_back(DIEAbbrevData(Attribute, Form));
230 }
aslc200b112008-08-16 12:57:46 +0000231
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000232 /// AddFirstAttribute - Adds a set of attribute information to the front
233 /// of the abbreviation.
234 void AddFirstAttribute(unsigned Attribute, unsigned Form) {
235 Data.insert(Data.begin(), DIEAbbrevData(Attribute, Form));
236 }
aslc200b112008-08-16 12:57:46 +0000237
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000238 /// Profile - Used to gather unique data for the abbreviation folding set.
239 ///
240 void Profile(FoldingSetNodeID &ID) {
241 ID.AddInteger(Tag);
242 ID.AddInteger(ChildrenFlag);
aslc200b112008-08-16 12:57:46 +0000243
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000244 // For each attribute description.
245 for (unsigned i = 0, N = Data.size(); i < N; ++i)
246 Data[i].Profile(ID);
247 }
aslc200b112008-08-16 12:57:46 +0000248
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000249 /// Emit - Print the abbreviation using the specified Dwarf writer.
250 ///
aslc200b112008-08-16 12:57:46 +0000251 void Emit(const DwarfDebug &DD) const;
252
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000253#ifndef NDEBUG
254 void print(std::ostream *O) {
255 if (O) print(*O);
256 }
257 void print(std::ostream &O);
258 void dump();
259#endif
260};
261
262//===----------------------------------------------------------------------===//
263/// DIE - A structured debug information entry. Has an abbreviation which
264/// describes it's organization.
265class DIE : public FoldingSetNode {
266protected:
267 /// Abbrev - Buffer for constructing abbreviation.
268 ///
269 DIEAbbrev Abbrev;
aslc200b112008-08-16 12:57:46 +0000270
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000271 /// Offset - Offset in debug info section.
272 ///
273 unsigned Offset;
aslc200b112008-08-16 12:57:46 +0000274
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000275 /// Size - Size of instance + children.
276 ///
277 unsigned Size;
aslc200b112008-08-16 12:57:46 +0000278
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000279 /// Children DIEs.
280 ///
281 std::vector<DIE *> Children;
aslc200b112008-08-16 12:57:46 +0000282
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000283 /// Attributes values.
284 ///
Owen Anderson88dd6232008-06-24 21:44:59 +0000285 SmallVector<DIEValue*, 32> Values;
aslc200b112008-08-16 12:57:46 +0000286
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000287public:
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000288 explicit DIE(unsigned Tag)
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000289 : Abbrev(Tag, DW_CHILDREN_no)
290 , Offset(0)
291 , Size(0)
292 , Children()
293 , Values()
294 {}
295 virtual ~DIE();
aslc200b112008-08-16 12:57:46 +0000296
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000297 // Accessors.
298 DIEAbbrev &getAbbrev() { return Abbrev; }
299 unsigned getAbbrevNumber() const {
300 return Abbrev.getNumber();
301 }
302 unsigned getTag() const { return Abbrev.getTag(); }
303 unsigned getOffset() const { return Offset; }
304 unsigned getSize() const { return Size; }
305 const std::vector<DIE *> &getChildren() const { return Children; }
Owen Anderson88dd6232008-06-24 21:44:59 +0000306 SmallVector<DIEValue*, 32> &getValues() { return Values; }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000307 void setTag(unsigned Tag) { Abbrev.setTag(Tag); }
308 void setOffset(unsigned O) { Offset = O; }
309 void setSize(unsigned S) { Size = S; }
aslc200b112008-08-16 12:57:46 +0000310
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000311 /// AddValue - Add a value and attributes to a DIE.
312 ///
313 void AddValue(unsigned Attribute, unsigned Form, DIEValue *Value) {
314 Abbrev.AddAttribute(Attribute, Form);
315 Values.push_back(Value);
316 }
aslc200b112008-08-16 12:57:46 +0000317
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000318 /// SiblingOffset - Return the offset of the debug information entry's
319 /// sibling.
320 unsigned SiblingOffset() const { return Offset + Size; }
aslc200b112008-08-16 12:57:46 +0000321
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000322 /// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
323 ///
324 void AddSiblingOffset();
325
326 /// AddChild - Add a child to the DIE.
327 ///
328 void AddChild(DIE *Child) {
329 Abbrev.setChildrenFlag(DW_CHILDREN_yes);
330 Children.push_back(Child);
331 }
aslc200b112008-08-16 12:57:46 +0000332
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000333 /// Detach - Detaches objects connected to it after copying.
334 ///
335 void Detach() {
336 Children.clear();
337 }
aslc200b112008-08-16 12:57:46 +0000338
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000339 /// Profile - Used to gather unique data for the value folding set.
340 ///
341 void Profile(FoldingSetNodeID &ID) ;
aslc200b112008-08-16 12:57:46 +0000342
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000343#ifndef NDEBUG
344 void print(std::ostream *O, unsigned IncIndent = 0) {
345 if (O) print(*O, IncIndent);
346 }
347 void print(std::ostream &O, unsigned IncIndent = 0);
348 void dump();
349#endif
350};
351
352//===----------------------------------------------------------------------===//
353/// DIEValue - A debug information entry value.
354///
355class DIEValue : public FoldingSetNode {
356public:
357 enum {
358 isInteger,
359 isString,
360 isLabel,
361 isAsIsLabel,
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000362 isSectionOffset,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000363 isDelta,
364 isEntry,
365 isBlock
366 };
aslc200b112008-08-16 12:57:46 +0000367
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000368 /// Type - Type of data stored in the value.
369 ///
370 unsigned Type;
aslc200b112008-08-16 12:57:46 +0000371
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000372 explicit DIEValue(unsigned T)
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000373 : Type(T)
374 {}
375 virtual ~DIEValue() {}
aslc200b112008-08-16 12:57:46 +0000376
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000377 // Accessors
378 unsigned getType() const { return Type; }
aslc200b112008-08-16 12:57:46 +0000379
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000380 // Implement isa/cast/dyncast.
381 static bool classof(const DIEValue *) { return true; }
aslc200b112008-08-16 12:57:46 +0000382
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000383 /// EmitValue - Emit value via the Dwarf writer.
384 ///
385 virtual void EmitValue(DwarfDebug &DD, unsigned Form) = 0;
aslc200b112008-08-16 12:57:46 +0000386
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000387 /// SizeOf - Return the size of a value in bytes.
388 ///
389 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const = 0;
aslc200b112008-08-16 12:57:46 +0000390
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000391 /// Profile - Used to gather unique data for the value folding set.
392 ///
393 virtual void Profile(FoldingSetNodeID &ID) = 0;
aslc200b112008-08-16 12:57:46 +0000394
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000395#ifndef NDEBUG
396 void print(std::ostream *O) {
397 if (O) print(*O);
398 }
399 virtual void print(std::ostream &O) = 0;
400 void dump();
401#endif
402};
403
404//===----------------------------------------------------------------------===//
405/// DWInteger - An integer value DIE.
aslc200b112008-08-16 12:57:46 +0000406///
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000407class DIEInteger : public DIEValue {
408private:
409 uint64_t Integer;
aslc200b112008-08-16 12:57:46 +0000410
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000411public:
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000412 explicit DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000413
414 // Implement isa/cast/dyncast.
415 static bool classof(const DIEInteger *) { return true; }
416 static bool classof(const DIEValue *I) { return I->Type == isInteger; }
aslc200b112008-08-16 12:57:46 +0000417
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000418 /// BestForm - Choose the best form for integer.
419 ///
420 static unsigned BestForm(bool IsSigned, uint64_t Integer) {
421 if (IsSigned) {
422 if ((char)Integer == (signed)Integer) return DW_FORM_data1;
423 if ((short)Integer == (signed)Integer) return DW_FORM_data2;
424 if ((int)Integer == (signed)Integer) return DW_FORM_data4;
425 } else {
426 if ((unsigned char)Integer == Integer) return DW_FORM_data1;
427 if ((unsigned short)Integer == Integer) return DW_FORM_data2;
428 if ((unsigned int)Integer == Integer) return DW_FORM_data4;
429 }
430 return DW_FORM_data8;
431 }
aslc200b112008-08-16 12:57:46 +0000432
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000433 /// EmitValue - Emit integer of appropriate size.
434 ///
435 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000436
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000437 /// SizeOf - Determine size of integer value in bytes.
438 ///
439 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000440
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000441 /// Profile - Used to gather unique data for the value folding set.
442 ///
443 static void Profile(FoldingSetNodeID &ID, unsigned Integer) {
444 ID.AddInteger(isInteger);
445 ID.AddInteger(Integer);
446 }
447 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Integer); }
aslc200b112008-08-16 12:57:46 +0000448
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000449#ifndef NDEBUG
450 virtual void print(std::ostream &O) {
451 O << "Int: " << (int64_t)Integer
452 << " 0x" << std::hex << Integer << std::dec;
453 }
454#endif
455};
456
457//===----------------------------------------------------------------------===//
458/// DIEString - A string value DIE.
aslc200b112008-08-16 12:57:46 +0000459///
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000460class DIEString : public DIEValue {
461public:
462 const std::string String;
aslc200b112008-08-16 12:57:46 +0000463
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000464 explicit DIEString(const std::string &S) : DIEValue(isString), String(S) {}
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000465
466 // Implement isa/cast/dyncast.
467 static bool classof(const DIEString *) { return true; }
468 static bool classof(const DIEValue *S) { return S->Type == isString; }
aslc200b112008-08-16 12:57:46 +0000469
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000470 /// EmitValue - Emit string value.
471 ///
472 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000473
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000474 /// SizeOf - Determine size of string value in bytes.
475 ///
476 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
477 return String.size() + sizeof(char); // sizeof('\0');
478 }
aslc200b112008-08-16 12:57:46 +0000479
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000480 /// Profile - Used to gather unique data for the value folding set.
481 ///
482 static void Profile(FoldingSetNodeID &ID, const std::string &String) {
483 ID.AddInteger(isString);
484 ID.AddString(String);
485 }
486 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, String); }
aslc200b112008-08-16 12:57:46 +0000487
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000488#ifndef NDEBUG
489 virtual void print(std::ostream &O) {
490 O << "Str: \"" << String << "\"";
491 }
492#endif
493};
494
495//===----------------------------------------------------------------------===//
496/// DIEDwarfLabel - A Dwarf internal label expression DIE.
497//
498class DIEDwarfLabel : public DIEValue {
499public:
500
501 const DWLabel Label;
aslc200b112008-08-16 12:57:46 +0000502
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000503 explicit DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {}
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000504
505 // Implement isa/cast/dyncast.
506 static bool classof(const DIEDwarfLabel *) { return true; }
507 static bool classof(const DIEValue *L) { return L->Type == isLabel; }
aslc200b112008-08-16 12:57:46 +0000508
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000509 /// EmitValue - Emit label value.
510 ///
511 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000512
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000513 /// SizeOf - Determine size of label value in bytes.
514 ///
515 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000516
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000517 /// Profile - Used to gather unique data for the value folding set.
518 ///
519 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label) {
520 ID.AddInteger(isLabel);
521 Label.Profile(ID);
522 }
523 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
aslc200b112008-08-16 12:57:46 +0000524
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000525#ifndef NDEBUG
526 virtual void print(std::ostream &O) {
527 O << "Lbl: ";
528 Label.print(O);
529 }
530#endif
531};
532
533
534//===----------------------------------------------------------------------===//
535/// DIEObjectLabel - A label to an object in code or data.
536//
537class DIEObjectLabel : public DIEValue {
538public:
539 const std::string Label;
aslc200b112008-08-16 12:57:46 +0000540
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000541 explicit DIEObjectLabel(const std::string &L)
542 : DIEValue(isAsIsLabel), Label(L) {}
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000543
544 // Implement isa/cast/dyncast.
545 static bool classof(const DIEObjectLabel *) { return true; }
546 static bool classof(const DIEValue *L) { return L->Type == isAsIsLabel; }
aslc200b112008-08-16 12:57:46 +0000547
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000548 /// EmitValue - Emit label value.
549 ///
550 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000551
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000552 /// SizeOf - Determine size of label value in bytes.
553 ///
554 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000555
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000556 /// Profile - Used to gather unique data for the value folding set.
557 ///
558 static void Profile(FoldingSetNodeID &ID, const std::string &Label) {
559 ID.AddInteger(isAsIsLabel);
560 ID.AddString(Label);
561 }
562 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label); }
563
564#ifndef NDEBUG
565 virtual void print(std::ostream &O) {
566 O << "Obj: " << Label;
567 }
568#endif
569};
570
571//===----------------------------------------------------------------------===//
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000572/// DIESectionOffset - A section offset DIE.
573//
574class DIESectionOffset : public DIEValue {
575public:
576 const DWLabel Label;
577 const DWLabel Section;
578 bool IsEH : 1;
579 bool UseSet : 1;
aslc200b112008-08-16 12:57:46 +0000580
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000581 DIESectionOffset(const DWLabel &Lab, const DWLabel &Sec,
582 bool isEH = false, bool useSet = true)
583 : DIEValue(isSectionOffset), Label(Lab), Section(Sec),
584 IsEH(isEH), UseSet(useSet) {}
585
586 // Implement isa/cast/dyncast.
587 static bool classof(const DIESectionOffset *) { return true; }
588 static bool classof(const DIEValue *D) { return D->Type == isSectionOffset; }
aslc200b112008-08-16 12:57:46 +0000589
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000590 /// EmitValue - Emit section offset.
591 ///
592 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000593
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000594 /// SizeOf - Determine size of section offset value in bytes.
595 ///
596 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000597
Argiris Kirtzidis03449652008-06-18 19:27:37 +0000598 /// Profile - Used to gather unique data for the value folding set.
599 ///
600 static void Profile(FoldingSetNodeID &ID, const DWLabel &Label,
601 const DWLabel &Section) {
602 ID.AddInteger(isSectionOffset);
603 Label.Profile(ID);
604 Section.Profile(ID);
605 // IsEH and UseSet are specific to the Label/Section that we will emit
606 // the offset for; so Label/Section are enough for uniqueness.
607 }
608 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, Label, Section); }
609
610#ifndef NDEBUG
611 virtual void print(std::ostream &O) {
612 O << "Off: ";
613 Label.print(O);
614 O << "-";
615 Section.print(O);
616 O << "-" << IsEH << "-" << UseSet;
617 }
618#endif
619};
620
621//===----------------------------------------------------------------------===//
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000622/// DIEDelta - A simple label difference DIE.
aslc200b112008-08-16 12:57:46 +0000623///
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000624class DIEDelta : public DIEValue {
625public:
626 const DWLabel LabelHi;
627 const DWLabel LabelLo;
aslc200b112008-08-16 12:57:46 +0000628
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000629 DIEDelta(const DWLabel &Hi, const DWLabel &Lo)
630 : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
631
632 // Implement isa/cast/dyncast.
633 static bool classof(const DIEDelta *) { return true; }
634 static bool classof(const DIEValue *D) { return D->Type == isDelta; }
aslc200b112008-08-16 12:57:46 +0000635
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000636 /// EmitValue - Emit delta value.
637 ///
638 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000639
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000640 /// SizeOf - Determine size of delta value in bytes.
641 ///
642 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000643
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000644 /// Profile - Used to gather unique data for the value folding set.
645 ///
646 static void Profile(FoldingSetNodeID &ID, const DWLabel &LabelHi,
647 const DWLabel &LabelLo) {
648 ID.AddInteger(isDelta);
649 LabelHi.Profile(ID);
650 LabelLo.Profile(ID);
651 }
652 virtual void Profile(FoldingSetNodeID &ID) { Profile(ID, LabelHi, LabelLo); }
653
654#ifndef NDEBUG
655 virtual void print(std::ostream &O) {
656 O << "Del: ";
657 LabelHi.print(O);
658 O << "-";
659 LabelLo.print(O);
660 }
661#endif
662};
663
664//===----------------------------------------------------------------------===//
665/// DIEntry - A pointer to another debug information entry. An instance of this
666/// class can also be used as a proxy for a debug information entry not yet
667/// defined (ie. types.)
668class DIEntry : public DIEValue {
669public:
670 DIE *Entry;
aslc200b112008-08-16 12:57:46 +0000671
Dan Gohman9ba5d4d2007-08-27 14:50:10 +0000672 explicit DIEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
aslc200b112008-08-16 12:57:46 +0000673
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000674 // Implement isa/cast/dyncast.
675 static bool classof(const DIEntry *) { return true; }
676 static bool classof(const DIEValue *E) { return E->Type == isEntry; }
aslc200b112008-08-16 12:57:46 +0000677
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000678 /// EmitValue - Emit debug information entry offset.
679 ///
680 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000681
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000682 /// SizeOf - Determine size of debug information entry in bytes.
683 ///
684 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const {
685 return sizeof(int32_t);
686 }
aslc200b112008-08-16 12:57:46 +0000687
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000688 /// Profile - Used to gather unique data for the value folding set.
689 ///
690 static void Profile(FoldingSetNodeID &ID, DIE *Entry) {
691 ID.AddInteger(isEntry);
692 ID.AddPointer(Entry);
693 }
694 virtual void Profile(FoldingSetNodeID &ID) {
695 ID.AddInteger(isEntry);
aslc200b112008-08-16 12:57:46 +0000696
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000697 if (Entry) {
698 ID.AddPointer(Entry);
699 } else {
700 ID.AddPointer(this);
701 }
702 }
aslc200b112008-08-16 12:57:46 +0000703
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000704#ifndef NDEBUG
705 virtual void print(std::ostream &O) {
706 O << "Die: 0x" << std::hex << (intptr_t)Entry << std::dec;
707 }
708#endif
709};
710
711//===----------------------------------------------------------------------===//
712/// DIEBlock - A block of values. Primarily used for location expressions.
713//
714class DIEBlock : public DIEValue, public DIE {
715public:
716 unsigned Size; // Size in bytes excluding size header.
aslc200b112008-08-16 12:57:46 +0000717
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000718 DIEBlock()
719 : DIEValue(isBlock)
720 , DIE(0)
721 , Size(0)
722 {}
723 ~DIEBlock() {
724 }
aslc200b112008-08-16 12:57:46 +0000725
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000726 // Implement isa/cast/dyncast.
727 static bool classof(const DIEBlock *) { return true; }
728 static bool classof(const DIEValue *E) { return E->Type == isBlock; }
aslc200b112008-08-16 12:57:46 +0000729
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000730 /// ComputeSize - calculate the size of the block.
731 ///
732 unsigned ComputeSize(DwarfDebug &DD);
aslc200b112008-08-16 12:57:46 +0000733
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000734 /// BestForm - Choose the best form for data.
735 ///
736 unsigned BestForm() const {
737 if ((unsigned char)Size == Size) return DW_FORM_block1;
738 if ((unsigned short)Size == Size) return DW_FORM_block2;
739 if ((unsigned int)Size == Size) return DW_FORM_block4;
740 return DW_FORM_block;
741 }
742
743 /// EmitValue - Emit block data.
744 ///
745 virtual void EmitValue(DwarfDebug &DD, unsigned Form);
aslc200b112008-08-16 12:57:46 +0000746
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000747 /// SizeOf - Determine size of block data in bytes.
748 ///
749 virtual unsigned SizeOf(const DwarfDebug &DD, unsigned Form) const;
aslc200b112008-08-16 12:57:46 +0000750
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000751
752 /// Profile - Used to gather unique data for the value folding set.
753 ///
754 virtual void Profile(FoldingSetNodeID &ID) {
755 ID.AddInteger(isBlock);
756 DIE::Profile(ID);
757 }
aslc200b112008-08-16 12:57:46 +0000758
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000759#ifndef NDEBUG
760 virtual void print(std::ostream &O) {
761 O << "Blk: ";
762 DIE::print(O, 5);
763 }
764#endif
765};
766
767//===----------------------------------------------------------------------===//
768/// CompileUnit - This dwarf writer support class manages information associate
769/// with a source file.
770class CompileUnit {
771private:
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000772 /// ID - File identifier for source.
773 ///
774 unsigned ID;
aslc200b112008-08-16 12:57:46 +0000775
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000776 /// Die - Compile unit debug information entry.
777 ///
778 DIE *Die;
aslc200b112008-08-16 12:57:46 +0000779
Devang Patel42f6bed2009-01-13 23:54:55 +0000780 /// GVToDieMap - Tracks the mapping of unit level debug informaton
781 /// variables to debug information entries.
Devang Patel56b1d132009-01-20 00:58:55 +0000782 std::map<GlobalVariable *, DIE *> GVToDieMap;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000783
Devang Patel42f6bed2009-01-13 23:54:55 +0000784 /// GVToDIEntryMap - Tracks the mapping of unit level debug informaton
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000785 /// descriptors to debug information entries using a DIEntry proxy.
Devang Patel56b1d132009-01-20 00:58:55 +0000786 std::map<GlobalVariable *, DIEntry *> GVToDIEntryMap;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000787
788 /// Globals - A map of globally visible named entities for this unit.
789 ///
790 std::map<std::string, DIE *> Globals;
791
792 /// DiesSet - Used to uniquely define dies within the compile unit.
793 ///
794 FoldingSet<DIE> DiesSet;
aslc200b112008-08-16 12:57:46 +0000795
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000796public:
Devang Patelb3907da2009-01-05 23:03:32 +0000797 CompileUnit(unsigned I, DIE *D)
Devang Patel42f6bed2009-01-13 23:54:55 +0000798 : ID(I), Die(D), GVToDieMap(),
Devang Patel5302e672009-01-17 06:51:37 +0000799 GVToDIEntryMap(), Globals(), DiesSet(InitDiesSetSize)
Devang Patelb3907da2009-01-05 23:03:32 +0000800 {}
801
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000802 ~CompileUnit() {
803 delete Die;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000804 }
aslc200b112008-08-16 12:57:46 +0000805
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000806 // Accessors.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000807 unsigned getID() const { return ID; }
808 DIE* getDie() const { return Die; }
809 std::map<std::string, DIE *> &getGlobals() { return Globals; }
810
811 /// hasContent - Return true if this compile unit has something to write out.
812 ///
813 bool hasContent() const {
814 return !Die->getChildren().empty();
815 }
816
817 /// AddGlobal - Add a new global entity to the compile unit.
818 ///
819 void AddGlobal(const std::string &Name, DIE *Die) {
820 Globals[Name] = Die;
821 }
aslc200b112008-08-16 12:57:46 +0000822
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000823 /// getDieMapSlotFor - Returns the debug information entry map slot for the
Devang Patel42f6bed2009-01-13 23:54:55 +0000824 /// specified debug variable.
Devang Patel4a4cbe72009-01-05 21:47:57 +0000825 DIE *&getDieMapSlotFor(GlobalVariable *GV) {
826 return GVToDieMap[GV];
827 }
aslc200b112008-08-16 12:57:46 +0000828
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000829 /// getDIEntrySlotFor - Returns the debug information entry proxy slot for the
Devang Patel42f6bed2009-01-13 23:54:55 +0000830 /// specified debug variable.
Devang Patel4a4cbe72009-01-05 21:47:57 +0000831 DIEntry *&getDIEntrySlotFor(GlobalVariable *GV) {
832 return GVToDIEntryMap[GV];
833 }
aslc200b112008-08-16 12:57:46 +0000834
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000835 /// AddDie - Adds or interns the DIE to the compile unit.
836 ///
837 DIE *AddDie(DIE &Buffer) {
838 FoldingSetNodeID ID;
839 Buffer.Profile(ID);
840 void *Where;
841 DIE *Die = DiesSet.FindNodeOrInsertPos(ID, Where);
aslc200b112008-08-16 12:57:46 +0000842
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000843 if (!Die) {
844 Die = new DIE(Buffer);
845 DiesSet.InsertNode(Die, Where);
846 this->Die->AddChild(Die);
847 Buffer.Detach();
848 }
aslc200b112008-08-16 12:57:46 +0000849
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000850 return Die;
851 }
852};
853
854//===----------------------------------------------------------------------===//
aslc200b112008-08-16 12:57:46 +0000855/// Dwarf - Emits general Dwarf directives.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000856///
857class Dwarf {
858
859protected:
860
861 //===--------------------------------------------------------------------===//
862 // Core attributes used by the Dwarf writer.
863 //
aslc200b112008-08-16 12:57:46 +0000864
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000865 //
866 /// O - Stream to .s file.
867 ///
Owen Anderson847b99b2008-08-21 00:14:44 +0000868 raw_ostream &O;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000869
870 /// Asm - Target of Dwarf emission.
871 ///
872 AsmPrinter *Asm;
aslc200b112008-08-16 12:57:46 +0000873
Bill Wendlingac9639d2008-07-01 23:34:48 +0000874 /// TAI - Target asm information.
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000875 const TargetAsmInfo *TAI;
aslc200b112008-08-16 12:57:46 +0000876
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000877 /// TD - Target data.
878 const TargetData *TD;
aslc200b112008-08-16 12:57:46 +0000879
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000880 /// RI - Register Information.
Dan Gohman1e57df32008-02-10 18:45:23 +0000881 const TargetRegisterInfo *RI;
aslc200b112008-08-16 12:57:46 +0000882
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000883 /// M - Current module.
884 ///
885 Module *M;
aslc200b112008-08-16 12:57:46 +0000886
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000887 /// MF - Current machine function.
888 ///
889 MachineFunction *MF;
aslc200b112008-08-16 12:57:46 +0000890
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000891 /// MMI - Collected machine module information.
892 ///
893 MachineModuleInfo *MMI;
aslc200b112008-08-16 12:57:46 +0000894
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000895 /// SubprogramCount - The running count of functions being compiled.
896 ///
897 unsigned SubprogramCount;
aslc200b112008-08-16 12:57:46 +0000898
Chris Lattnerb3876c72007-09-24 03:35:37 +0000899 /// Flavor - A unique string indicating what dwarf producer this is, used to
900 /// unique labels.
901 const char * const Flavor;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000902
903 unsigned SetCounter;
Owen Anderson847b99b2008-08-21 00:14:44 +0000904 Dwarf(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T,
Chris Lattnerb3876c72007-09-24 03:35:37 +0000905 const char *flavor)
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000906 : O(OS)
907 , Asm(A)
908 , TAI(T)
909 , TD(Asm->TM.getTargetData())
910 , RI(Asm->TM.getRegisterInfo())
911 , M(NULL)
912 , MF(NULL)
913 , MMI(NULL)
914 , SubprogramCount(0)
Chris Lattnerb3876c72007-09-24 03:35:37 +0000915 , Flavor(flavor)
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000916 , SetCounter(1)
917 {
918 }
919
920public:
921
922 //===--------------------------------------------------------------------===//
923 // Accessors.
924 //
925 AsmPrinter *getAsm() const { return Asm; }
926 MachineModuleInfo *getMMI() const { return MMI; }
927 const TargetAsmInfo *getTargetAsmInfo() const { return TAI; }
Dan Gohmancfb72b22007-09-27 23:12:31 +0000928 const TargetData *getTargetData() const { return TD; }
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000929
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000930 void PrintRelDirective(bool Force32Bit = false, bool isInSection = false)
931 const {
932 if (isInSection && TAI->getDwarfSectionOffsetDirective())
933 O << TAI->getDwarfSectionOffsetDirective();
Dan Gohmancfb72b22007-09-27 23:12:31 +0000934 else if (Force32Bit || TD->getPointerSize() == sizeof(int32_t))
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000935 O << TAI->getData32bitsDirective();
936 else
937 O << TAI->getData64bitsDirective();
938 }
aslc200b112008-08-16 12:57:46 +0000939
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000940 /// PrintLabelName - Print label name in form used by Dwarf writer.
941 ///
942 void PrintLabelName(DWLabel Label) const {
943 PrintLabelName(Label.Tag, Label.Number);
944 }
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000945 void PrintLabelName(const char *Tag, unsigned Number) const {
Anton Korobeynikov5ef86702007-09-02 22:07:21 +0000946 O << TAI->getPrivateGlobalPrefix() << Tag;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000947 if (Number) O << Number;
948 }
aslc200b112008-08-16 12:57:46 +0000949
Chris Lattnerb3876c72007-09-24 03:35:37 +0000950 void PrintLabelName(const char *Tag, unsigned Number,
951 const char *Suffix) const {
952 O << TAI->getPrivateGlobalPrefix() << Tag;
953 if (Number) O << Number;
954 O << Suffix;
955 }
aslc200b112008-08-16 12:57:46 +0000956
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000957 /// EmitLabel - Emit location label for internal use by Dwarf.
958 ///
959 void EmitLabel(DWLabel Label) const {
960 EmitLabel(Label.Tag, Label.Number);
961 }
962 void EmitLabel(const char *Tag, unsigned Number) const {
963 PrintLabelName(Tag, Number);
964 O << ":\n";
965 }
aslc200b112008-08-16 12:57:46 +0000966
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000967 /// EmitReference - Emit a reference to a label.
968 ///
Dan Gohman4fd77742007-09-28 15:43:33 +0000969 void EmitReference(DWLabel Label, bool IsPCRelative = false,
970 bool Force32Bit = false) const {
971 EmitReference(Label.Tag, Label.Number, IsPCRelative, Force32Bit);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000972 }
973 void EmitReference(const char *Tag, unsigned Number,
Dan Gohman4fd77742007-09-28 15:43:33 +0000974 bool IsPCRelative = false, bool Force32Bit = false) const {
975 PrintRelDirective(Force32Bit);
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000976 PrintLabelName(Tag, Number);
aslc200b112008-08-16 12:57:46 +0000977
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000978 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
979 }
Dan Gohman4fd77742007-09-28 15:43:33 +0000980 void EmitReference(const std::string &Name, bool IsPCRelative = false,
981 bool Force32Bit = false) const {
982 PrintRelDirective(Force32Bit);
aslc200b112008-08-16 12:57:46 +0000983
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000984 O << Name;
aslc200b112008-08-16 12:57:46 +0000985
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000986 if (IsPCRelative) O << "-" << TAI->getPCSymbol();
987 }
988
989 /// EmitDifference - Emit the difference between two labels. Some
990 /// assemblers do not behave with absolute expressions with data directives,
991 /// so there is an option (needsSet) to use an intermediary set expression.
992 void EmitDifference(DWLabel LabelHi, DWLabel LabelLo,
993 bool IsSmall = false) {
994 EmitDifference(LabelHi.Tag, LabelHi.Number,
995 LabelLo.Tag, LabelLo.Number,
996 IsSmall);
997 }
998 void EmitDifference(const char *TagHi, unsigned NumberHi,
999 const char *TagLo, unsigned NumberLo,
1000 bool IsSmall = false) {
1001 if (TAI->needsSet()) {
1002 O << "\t.set\t";
Chris Lattnerb3876c72007-09-24 03:35:37 +00001003 PrintLabelName("set", SetCounter, Flavor);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001004 O << ",";
1005 PrintLabelName(TagHi, NumberHi);
1006 O << "-";
1007 PrintLabelName(TagLo, NumberLo);
1008 O << "\n";
Anton Korobeynikov5ef86702007-09-02 22:07:21 +00001009
1010 PrintRelDirective(IsSmall);
Chris Lattnerb3876c72007-09-24 03:35:37 +00001011 PrintLabelName("set", SetCounter, Flavor);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001012 ++SetCounter;
1013 } else {
Anton Korobeynikov5ef86702007-09-02 22:07:21 +00001014 PrintRelDirective(IsSmall);
aslc200b112008-08-16 12:57:46 +00001015
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001016 PrintLabelName(TagHi, NumberHi);
1017 O << "-";
1018 PrintLabelName(TagLo, NumberLo);
1019 }
1020 }
1021
1022 void EmitSectionOffset(const char* Label, const char* Section,
1023 unsigned LabelNumber, unsigned SectionNumber,
Dale Johannesen0ebb2432008-03-26 23:31:39 +00001024 bool IsSmall = false, bool isEH = false,
1025 bool useSet = true) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001026 bool printAbsolute = false;
Dale Johannesen0ebb2432008-03-26 23:31:39 +00001027 if (isEH)
1028 printAbsolute = TAI->isAbsoluteEHSectionOffsets();
1029 else
1030 printAbsolute = TAI->isAbsoluteDebugSectionOffsets();
1031
1032 if (TAI->needsSet() && useSet) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001033 O << "\t.set\t";
Chris Lattnerb3876c72007-09-24 03:35:37 +00001034 PrintLabelName("set", SetCounter, Flavor);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001035 O << ",";
Anton Korobeynikov5ef86702007-09-02 22:07:21 +00001036 PrintLabelName(Label, LabelNumber);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001037
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001038 if (!printAbsolute) {
1039 O << "-";
1040 PrintLabelName(Section, SectionNumber);
aslc200b112008-08-16 12:57:46 +00001041 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001042 O << "\n";
Anton Korobeynikov5ef86702007-09-02 22:07:21 +00001043
1044 PrintRelDirective(IsSmall);
aslc200b112008-08-16 12:57:46 +00001045
Chris Lattnerb3876c72007-09-24 03:35:37 +00001046 PrintLabelName("set", SetCounter, Flavor);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001047 ++SetCounter;
1048 } else {
Anton Korobeynikov5ef86702007-09-02 22:07:21 +00001049 PrintRelDirective(IsSmall, true);
aslc200b112008-08-16 12:57:46 +00001050
Anton Korobeynikov5ef86702007-09-02 22:07:21 +00001051 PrintLabelName(Label, LabelNumber);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001052
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001053 if (!printAbsolute) {
1054 O << "-";
1055 PrintLabelName(Section, SectionNumber);
1056 }
aslc200b112008-08-16 12:57:46 +00001057 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001058 }
aslc200b112008-08-16 12:57:46 +00001059
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001060 /// EmitFrameMoves - Emit frame instructions to describe the layout of the
1061 /// frame.
1062 void EmitFrameMoves(const char *BaseLabel, unsigned BaseLabelID,
Dale Johannesenf5a11532007-11-13 19:13:01 +00001063 const std::vector<MachineMove> &Moves, bool isEH) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001064 int stackGrowth =
1065 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
1066 TargetFrameInfo::StackGrowsUp ?
Dan Gohmancfb72b22007-09-27 23:12:31 +00001067 TD->getPointerSize() : -TD->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001068 bool IsLocal = BaseLabel && strcmp(BaseLabel, "label") == 0;
1069
1070 for (unsigned i = 0, N = Moves.size(); i < N; ++i) {
1071 const MachineMove &Move = Moves[i];
1072 unsigned LabelID = Move.getLabelID();
aslc200b112008-08-16 12:57:46 +00001073
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001074 if (LabelID) {
1075 LabelID = MMI->MappedLabel(LabelID);
aslc200b112008-08-16 12:57:46 +00001076
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001077 // Throw out move if the label is invalid.
1078 if (!LabelID) continue;
1079 }
aslc200b112008-08-16 12:57:46 +00001080
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001081 const MachineLocation &Dst = Move.getDestination();
1082 const MachineLocation &Src = Move.getSource();
aslc200b112008-08-16 12:57:46 +00001083
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001084 // Advance row if new location.
1085 if (BaseLabel && LabelID && (BaseLabelID != LabelID || !IsLocal)) {
1086 Asm->EmitInt8(DW_CFA_advance_loc4);
1087 Asm->EOL("DW_CFA_advance_loc4");
1088 EmitDifference("label", LabelID, BaseLabel, BaseLabelID, true);
1089 Asm->EOL();
aslc200b112008-08-16 12:57:46 +00001090
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001091 BaseLabelID = LabelID;
1092 BaseLabel = "label";
1093 IsLocal = true;
1094 }
aslc200b112008-08-16 12:57:46 +00001095
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001096 // If advancing cfa.
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001097 if (Dst.isReg() && Dst.getReg() == MachineLocation::VirtualFP) {
1098 if (!Src.isReg()) {
1099 if (Src.getReg() == MachineLocation::VirtualFP) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001100 Asm->EmitInt8(DW_CFA_def_cfa_offset);
1101 Asm->EOL("DW_CFA_def_cfa_offset");
1102 } else {
1103 Asm->EmitInt8(DW_CFA_def_cfa);
1104 Asm->EOL("DW_CFA_def_cfa");
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001105 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Src.getReg(), isEH));
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001106 Asm->EOL("Register");
1107 }
aslc200b112008-08-16 12:57:46 +00001108
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001109 int Offset = -Src.getOffset();
aslc200b112008-08-16 12:57:46 +00001110
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001111 Asm->EmitULEB128Bytes(Offset);
1112 Asm->EOL("Offset");
1113 } else {
1114 assert(0 && "Machine move no supported yet.");
1115 }
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001116 } else if (Src.isReg() &&
1117 Src.getReg() == MachineLocation::VirtualFP) {
1118 if (Dst.isReg()) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001119 Asm->EmitInt8(DW_CFA_def_cfa_register);
1120 Asm->EOL("DW_CFA_def_cfa_register");
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001121 Asm->EmitULEB128Bytes(RI->getDwarfRegNum(Dst.getReg(), isEH));
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001122 Asm->EOL("Register");
1123 } else {
1124 assert(0 && "Machine move no supported yet.");
1125 }
1126 } else {
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001127 unsigned Reg = RI->getDwarfRegNum(Src.getReg(), isEH);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001128 int Offset = Dst.getOffset() / stackGrowth;
aslc200b112008-08-16 12:57:46 +00001129
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001130 if (Offset < 0) {
1131 Asm->EmitInt8(DW_CFA_offset_extended_sf);
1132 Asm->EOL("DW_CFA_offset_extended_sf");
1133 Asm->EmitULEB128Bytes(Reg);
1134 Asm->EOL("Reg");
1135 Asm->EmitSLEB128Bytes(Offset);
1136 Asm->EOL("Offset");
1137 } else if (Reg < 64) {
1138 Asm->EmitInt8(DW_CFA_offset + Reg);
Evan Cheng6181e062008-07-09 21:53:02 +00001139 if (VerboseAsm)
1140 Asm->EOL("DW_CFA_offset + Reg (" + utostr(Reg) + ")");
1141 else
1142 Asm->EOL();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001143 Asm->EmitULEB128Bytes(Offset);
1144 Asm->EOL("Offset");
1145 } else {
1146 Asm->EmitInt8(DW_CFA_offset_extended);
1147 Asm->EOL("DW_CFA_offset_extended");
1148 Asm->EmitULEB128Bytes(Reg);
1149 Asm->EOL("Reg");
1150 Asm->EmitULEB128Bytes(Offset);
1151 Asm->EOL("Offset");
1152 }
1153 }
1154 }
1155 }
1156
1157};
1158
1159//===----------------------------------------------------------------------===//
Devang Patel35a078f2009-01-12 22:54:42 +00001160/// SrcLineInfo - This class is used to record source line correspondence.
Devang Patel7dd15a92009-01-08 17:19:22 +00001161///
1162class SrcLineInfo {
1163 unsigned Line; // Source line number.
1164 unsigned Column; // Source column.
1165 unsigned SourceID; // Source ID number.
1166 unsigned LabelID; // Label in code ID number.
1167public:
1168 SrcLineInfo(unsigned L, unsigned C, unsigned S, unsigned I)
1169 : Line(L), Column(C), SourceID(S), LabelID(I) {}
1170
1171 // Accessors
1172 unsigned getLine() const { return Line; }
1173 unsigned getColumn() const { return Column; }
1174 unsigned getSourceID() const { return SourceID; }
1175 unsigned getLabelID() const { return LabelID; }
1176};
1177
1178
1179//===----------------------------------------------------------------------===//
Devang Patel5f244e32009-01-05 22:35:52 +00001180/// SrcFileInfo - This class is used to track source information.
1181///
1182class SrcFileInfo {
1183 unsigned DirectoryID; // Directory ID number.
1184 std::string Name; // File name (not including directory.)
1185public:
1186 SrcFileInfo(unsigned D, const std::string &N) : DirectoryID(D), Name(N) {}
1187
1188 // Accessors
1189 unsigned getDirectoryID() const { return DirectoryID; }
1190 const std::string &getName() const { return Name; }
1191
1192 /// operator== - Used by UniqueVector to locate entry.
1193 ///
Devang Patel42f6bed2009-01-13 23:54:55 +00001194 bool operator==(const SrcFileInfo &SI) const {
Devang Patel5f244e32009-01-05 22:35:52 +00001195 return getDirectoryID() == SI.getDirectoryID() && getName() == SI.getName();
1196 }
1197
1198 /// operator< - Used by UniqueVector to locate entry.
1199 ///
1200 bool operator<(const SrcFileInfo &SI) const {
1201 return getDirectoryID() < SI.getDirectoryID() ||
1202 (getDirectoryID() == SI.getDirectoryID() && getName() < SI.getName());
1203 }
1204};
1205
1206//===----------------------------------------------------------------------===//
Devang Patel4d1709e2009-01-08 02:33:41 +00001207/// DbgVariable - This class is used to track local variable information.
1208///
1209class DbgVariable {
1210private:
Devang Patel7c8a2772009-01-16 19:28:14 +00001211 DIVariable Var; // Variable Descriptor.
Devang Patel4d1709e2009-01-08 02:33:41 +00001212 unsigned FrameIndex; // Variable frame index.
1213
1214public:
Devang Patel7c8a2772009-01-16 19:28:14 +00001215 DbgVariable(DIVariable V, unsigned I) : Var(V), FrameIndex(I) {}
Devang Patel4d1709e2009-01-08 02:33:41 +00001216
1217 // Accessors.
Devang Patel7c8a2772009-01-16 19:28:14 +00001218 DIVariable getVariable() const { return Var; }
Devang Patel4d1709e2009-01-08 02:33:41 +00001219 unsigned getFrameIndex() const { return FrameIndex; }
1220};
1221
1222//===----------------------------------------------------------------------===//
1223/// DbgScope - This class is used to track scope information.
1224///
1225class DbgScope {
1226private:
1227 DbgScope *Parent; // Parent to this scope.
Devang Patel49a3bd92009-01-16 18:01:58 +00001228 DIDescriptor Desc; // Debug info descriptor for scope.
Devang Patel4d1709e2009-01-08 02:33:41 +00001229 // Either subprogram or block.
1230 unsigned StartLabelID; // Label ID of the beginning of scope.
1231 unsigned EndLabelID; // Label ID of the end of scope.
Devang Patel49a3bd92009-01-16 18:01:58 +00001232 SmallVector<DbgScope *, 4> Scopes; // Scopes defined in scope.
Devang Patel63c22f42009-01-10 02:42:49 +00001233 SmallVector<DbgVariable *, 8> Variables;// Variables declared in scope.
Devang Patel4d1709e2009-01-08 02:33:41 +00001234
1235public:
Devang Patel2560d922009-01-15 18:25:17 +00001236 DbgScope(DbgScope *P, DIDescriptor D)
Devang Patel4d1709e2009-01-08 02:33:41 +00001237 : Parent(P), Desc(D), StartLabelID(0), EndLabelID(0), Scopes(), Variables()
1238 {}
Devang Patela4162952009-01-12 18:48:36 +00001239 ~DbgScope() {
1240 for (unsigned i = 0, N = Scopes.size(); i < N; ++i) delete Scopes[i];
1241 for (unsigned j = 0, M = Variables.size(); j < M; ++j) delete Variables[j];
1242 }
Devang Patel4d1709e2009-01-08 02:33:41 +00001243
1244 // Accessors.
Devang Patel49a3bd92009-01-16 18:01:58 +00001245 DbgScope *getParent() const { return Parent; }
1246 DIDescriptor getDesc() const { return Desc; }
Devang Patel4d1709e2009-01-08 02:33:41 +00001247 unsigned getStartLabelID() const { return StartLabelID; }
1248 unsigned getEndLabelID() const { return EndLabelID; }
Devang Patel63c22f42009-01-10 02:42:49 +00001249 SmallVector<DbgScope *, 4> &getScopes() { return Scopes; }
1250 SmallVector<DbgVariable *, 8> &getVariables() { return Variables; }
Devang Patel4d1709e2009-01-08 02:33:41 +00001251 void setStartLabelID(unsigned S) { StartLabelID = S; }
1252 void setEndLabelID(unsigned E) { EndLabelID = E; }
1253
1254 /// AddScope - Add a scope to the scope.
1255 ///
1256 void AddScope(DbgScope *S) { Scopes.push_back(S); }
1257
1258 /// AddVariable - Add a variable to the scope.
1259 ///
1260 void AddVariable(DbgVariable *V) { Variables.push_back(V); }
1261};
1262
1263//===----------------------------------------------------------------------===//
aslc200b112008-08-16 12:57:46 +00001264/// DwarfDebug - Emits Dwarf debug directives.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001265///
1266class DwarfDebug : public Dwarf {
1267
1268private:
1269 //===--------------------------------------------------------------------===//
1270 // Attributes used to construct specific Dwarf sections.
1271 //
aslc200b112008-08-16 12:57:46 +00001272
Devang Patel5302e672009-01-17 06:51:37 +00001273 /// DW_CUs - All the compile units involved in this build. The index
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001274 /// of each entry in this vector corresponds to the sources in MMI.
Devang Patel7dd15a92009-01-08 17:19:22 +00001275 DenseMap<Value *, CompileUnit *> DW_CUs;
aslc200b112008-08-16 12:57:46 +00001276
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001277 /// AbbreviationsSet - Used to uniquely define abbreviations.
1278 ///
1279 FoldingSet<DIEAbbrev> AbbreviationsSet;
1280
1281 /// Abbreviations - A list of all the unique abbreviations in use.
1282 ///
1283 std::vector<DIEAbbrev *> Abbreviations;
aslc200b112008-08-16 12:57:46 +00001284
Devang Patelb28de842009-01-17 08:01:33 +00001285 /// Directories - Uniquing vector for directories.
Devang Patel5f244e32009-01-05 22:35:52 +00001286 UniqueVector<std::string> Directories;
1287
Devang Patelb28de842009-01-17 08:01:33 +00001288 /// SourceFiles - Uniquing vector for source files.
Devang Patel5f244e32009-01-05 22:35:52 +00001289 UniqueVector<SrcFileInfo> SrcFiles;
1290
Devang Patel9b829452009-01-16 21:07:53 +00001291 /// Lines - List of of source line correspondence.
Devang Patel7dd15a92009-01-08 17:19:22 +00001292 std::vector<SrcLineInfo> Lines;
1293
Devang Patel9b829452009-01-16 21:07:53 +00001294 /// ValuesSet - Used to uniquely define values.
1295 ///
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001296 FoldingSet<DIEValue> ValuesSet;
aslc200b112008-08-16 12:57:46 +00001297
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001298 /// Values - A list of all the unique values in use.
1299 ///
1300 std::vector<DIEValue *> Values;
aslc200b112008-08-16 12:57:46 +00001301
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001302 /// StringPool - A UniqueVector of strings used by indirect references.
1303 ///
1304 UniqueVector<std::string> StringPool;
1305
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001306 /// SectionMap - Provides a unique id per text section.
1307 ///
Anton Korobeynikov55b94962008-09-24 22:15:21 +00001308 UniqueVector<const Section*> SectionMap;
aslc200b112008-08-16 12:57:46 +00001309
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001310 /// SectionSourceLines - Tracks line numbers per text section.
1311 ///
Devang Patel35a078f2009-01-12 22:54:42 +00001312 std::vector<std::vector<SrcLineInfo> > SectionSourceLines;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001313
1314 /// didInitial - Flag to indicate if initial emission has been done.
1315 ///
1316 bool didInitial;
aslc200b112008-08-16 12:57:46 +00001317
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001318 /// shouldEmit - Flag to indicate if debug information should be emitted.
1319 ///
1320 bool shouldEmit;
1321
Devang Patel2560d922009-01-15 18:25:17 +00001322 // RootDbgScope - Top level scope for the current function.
Devang Patel4d1709e2009-01-08 02:33:41 +00001323 //
1324 DbgScope *RootDbgScope;
1325
1326 // DbgScopeMap - Tracks the scopes in the current function.
1327 DenseMap<GlobalVariable *, DbgScope *> DbgScopeMap;
1328
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001329 struct FunctionDebugFrameInfo {
1330 unsigned Number;
1331 std::vector<MachineMove> Moves;
1332
1333 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M):
Dan Gohman9ba5d4d2007-08-27 14:50:10 +00001334 Number(Num), Moves(M) { }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001335 };
1336
1337 std::vector<FunctionDebugFrameInfo> DebugFrames;
aslc200b112008-08-16 12:57:46 +00001338
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001339public:
aslc200b112008-08-16 12:57:46 +00001340
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001341 /// ShouldEmitDwarf - Returns true if Dwarf declarations should be made.
1342 ///
1343 bool ShouldEmitDwarf() const { return shouldEmit; }
1344
1345 /// AssignAbbrevNumber - Define a unique number for the abbreviation.
aslc200b112008-08-16 12:57:46 +00001346 ///
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001347 void AssignAbbrevNumber(DIEAbbrev &Abbrev) {
1348 // Profile the node so that we can make it unique.
1349 FoldingSetNodeID ID;
1350 Abbrev.Profile(ID);
aslc200b112008-08-16 12:57:46 +00001351
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001352 // Check the set for priors.
1353 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
aslc200b112008-08-16 12:57:46 +00001354
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001355 // If it's newly added.
1356 if (InSet == &Abbrev) {
aslc200b112008-08-16 12:57:46 +00001357 // Add to abbreviation list.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001358 Abbreviations.push_back(&Abbrev);
1359 // Assign the vector position + 1 as its number.
1360 Abbrev.setNumber(Abbreviations.size());
1361 } else {
1362 // Assign existing abbreviation number.
1363 Abbrev.setNumber(InSet->getNumber());
1364 }
1365 }
1366
1367 /// NewString - Add a string to the constant pool and returns a label.
1368 ///
1369 DWLabel NewString(const std::string &String) {
1370 unsigned StringID = StringPool.insert(String);
1371 return DWLabel("string", StringID);
1372 }
aslc200b112008-08-16 12:57:46 +00001373
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001374 /// NewDIEntry - Creates a new DIEntry to be a proxy for a debug information
1375 /// entry.
1376 DIEntry *NewDIEntry(DIE *Entry = NULL) {
1377 DIEntry *Value;
aslc200b112008-08-16 12:57:46 +00001378
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001379 if (Entry) {
1380 FoldingSetNodeID ID;
1381 DIEntry::Profile(ID, Entry);
1382 void *Where;
1383 Value = static_cast<DIEntry *>(ValuesSet.FindNodeOrInsertPos(ID, Where));
aslc200b112008-08-16 12:57:46 +00001384
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001385 if (Value) return Value;
aslc200b112008-08-16 12:57:46 +00001386
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001387 Value = new DIEntry(Entry);
1388 ValuesSet.InsertNode(Value, Where);
1389 } else {
1390 Value = new DIEntry(Entry);
1391 }
aslc200b112008-08-16 12:57:46 +00001392
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001393 Values.push_back(Value);
1394 return Value;
1395 }
aslc200b112008-08-16 12:57:46 +00001396
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001397 /// SetDIEntry - Set a DIEntry once the debug information entry is defined.
1398 ///
1399 void SetDIEntry(DIEntry *Value, DIE *Entry) {
1400 Value->Entry = Entry;
1401 // Add to values set if not already there. If it is, we merely have a
1402 // duplicate in the values list (no harm.)
1403 ValuesSet.GetOrInsertNode(Value);
1404 }
1405
1406 /// AddUInt - Add an unsigned integer attribute data and value.
1407 ///
1408 void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer) {
1409 if (!Form) Form = DIEInteger::BestForm(false, Integer);
1410
1411 FoldingSetNodeID ID;
1412 DIEInteger::Profile(ID, Integer);
1413 void *Where;
1414 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1415 if (!Value) {
1416 Value = new DIEInteger(Integer);
1417 ValuesSet.InsertNode(Value, Where);
1418 Values.push_back(Value);
1419 }
aslc200b112008-08-16 12:57:46 +00001420
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001421 Die->AddValue(Attribute, Form, Value);
1422 }
aslc200b112008-08-16 12:57:46 +00001423
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001424 /// AddSInt - Add an signed integer attribute data and value.
1425 ///
1426 void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer) {
1427 if (!Form) Form = DIEInteger::BestForm(true, Integer);
1428
1429 FoldingSetNodeID ID;
1430 DIEInteger::Profile(ID, (uint64_t)Integer);
1431 void *Where;
1432 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1433 if (!Value) {
1434 Value = new DIEInteger(Integer);
1435 ValuesSet.InsertNode(Value, Where);
1436 Values.push_back(Value);
1437 }
aslc200b112008-08-16 12:57:46 +00001438
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001439 Die->AddValue(Attribute, Form, Value);
1440 }
aslc200b112008-08-16 12:57:46 +00001441
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001442 /// AddString - Add a std::string attribute data and value.
1443 ///
1444 void AddString(DIE *Die, unsigned Attribute, unsigned Form,
1445 const std::string &String) {
1446 FoldingSetNodeID ID;
1447 DIEString::Profile(ID, String);
1448 void *Where;
1449 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1450 if (!Value) {
1451 Value = new DIEString(String);
1452 ValuesSet.InsertNode(Value, Where);
1453 Values.push_back(Value);
1454 }
aslc200b112008-08-16 12:57:46 +00001455
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001456 Die->AddValue(Attribute, Form, Value);
1457 }
aslc200b112008-08-16 12:57:46 +00001458
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001459 /// AddLabel - Add a Dwarf label attribute data and value.
1460 ///
1461 void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
1462 const DWLabel &Label) {
1463 FoldingSetNodeID ID;
1464 DIEDwarfLabel::Profile(ID, Label);
1465 void *Where;
1466 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1467 if (!Value) {
1468 Value = new DIEDwarfLabel(Label);
1469 ValuesSet.InsertNode(Value, Where);
1470 Values.push_back(Value);
1471 }
aslc200b112008-08-16 12:57:46 +00001472
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001473 Die->AddValue(Attribute, Form, Value);
1474 }
aslc200b112008-08-16 12:57:46 +00001475
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001476 /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
1477 ///
1478 void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
1479 const std::string &Label) {
1480 FoldingSetNodeID ID;
1481 DIEObjectLabel::Profile(ID, Label);
1482 void *Where;
1483 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1484 if (!Value) {
1485 Value = new DIEObjectLabel(Label);
1486 ValuesSet.InsertNode(Value, Where);
1487 Values.push_back(Value);
1488 }
aslc200b112008-08-16 12:57:46 +00001489
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001490 Die->AddValue(Attribute, Form, Value);
1491 }
aslc200b112008-08-16 12:57:46 +00001492
Argiris Kirtzidis03449652008-06-18 19:27:37 +00001493 /// AddSectionOffset - Add a section offset label attribute data and value.
1494 ///
1495 void AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
1496 const DWLabel &Label, const DWLabel &Section,
1497 bool isEH = false, bool useSet = true) {
1498 FoldingSetNodeID ID;
1499 DIESectionOffset::Profile(ID, Label, Section);
1500 void *Where;
1501 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1502 if (!Value) {
1503 Value = new DIESectionOffset(Label, Section, isEH, useSet);
1504 ValuesSet.InsertNode(Value, Where);
1505 Values.push_back(Value);
1506 }
aslc200b112008-08-16 12:57:46 +00001507
Argiris Kirtzidis03449652008-06-18 19:27:37 +00001508 Die->AddValue(Attribute, Form, Value);
1509 }
aslc200b112008-08-16 12:57:46 +00001510
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001511 /// AddDelta - Add a label delta attribute data and value.
1512 ///
1513 void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
1514 const DWLabel &Hi, const DWLabel &Lo) {
1515 FoldingSetNodeID ID;
1516 DIEDelta::Profile(ID, Hi, Lo);
1517 void *Where;
1518 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1519 if (!Value) {
1520 Value = new DIEDelta(Hi, Lo);
1521 ValuesSet.InsertNode(Value, Where);
1522 Values.push_back(Value);
1523 }
aslc200b112008-08-16 12:57:46 +00001524
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001525 Die->AddValue(Attribute, Form, Value);
1526 }
aslc200b112008-08-16 12:57:46 +00001527
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001528 /// AddDIEntry - Add a DIE attribute data and value.
1529 ///
1530 void AddDIEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
1531 Die->AddValue(Attribute, Form, NewDIEntry(Entry));
1532 }
1533
1534 /// AddBlock - Add block data.
1535 ///
1536 void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block) {
1537 Block->ComputeSize(*this);
1538 FoldingSetNodeID ID;
1539 Block->Profile(ID);
1540 void *Where;
1541 DIEValue *Value = ValuesSet.FindNodeOrInsertPos(ID, Where);
1542 if (!Value) {
1543 Value = Block;
1544 ValuesSet.InsertNode(Value, Where);
1545 Values.push_back(Value);
1546 } else {
Chris Lattner3de66892007-09-21 18:25:53 +00001547 // Already exists, reuse the previous one.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001548 delete Block;
Chris Lattner3de66892007-09-21 18:25:53 +00001549 Block = cast<DIEBlock>(Value);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001550 }
aslc200b112008-08-16 12:57:46 +00001551
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001552 Die->AddValue(Attribute, Block->BestForm(), Value);
1553 }
1554
1555private:
1556
1557 /// AddSourceLine - Add location information to specified debug information
1558 /// entry.
Devang Patel7c8a2772009-01-16 19:28:14 +00001559 void AddSourceLine(DIE *Die, const DIVariable *V) {
Devang Patel4d1709e2009-01-08 02:33:41 +00001560 unsigned FileID = 0;
1561 unsigned Line = V->getLineNumber();
Devang Patelb49710a2009-01-20 19:22:03 +00001562 if (V->getVersion() <= LLVMDebugVersion6) {
Devang Patel4d1709e2009-01-08 02:33:41 +00001563 // Version6 or earlier. Use compile unit info to get file id.
1564 CompileUnit *Unit = FindCompileUnit(V->getCompileUnit());
1565 FileID = Unit->getID();
1566 } else {
1567 // Version7 or newer, use filename and directory info from DIVariable
1568 // directly.
1569 unsigned DID = Directories.idFor(V->getDirectory());
1570 FileID = SrcFiles.idFor(SrcFileInfo(DID, V->getFilename()));
1571 }
1572 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1573 AddUInt(Die, DW_AT_decl_line, 0, Line);
1574 }
1575
1576 /// AddSourceLine - Add location information to specified debug information
1577 /// entry.
Devang Patel7c8a2772009-01-16 19:28:14 +00001578 void AddSourceLine(DIE *Die, const DIGlobal *G) {
Devang Patel5f244e32009-01-05 22:35:52 +00001579 unsigned FileID = 0;
1580 unsigned Line = G->getLineNumber();
Devang Patelb49710a2009-01-20 19:22:03 +00001581 if (G->getVersion() < LLVMDebugVersion6) {
Devang Patel5f244e32009-01-05 22:35:52 +00001582 // Version6 or earlier. Use compile unit info to get file id.
1583 CompileUnit *Unit = FindCompileUnit(G->getCompileUnit());
1584 FileID = Unit->getID();
1585 } else {
1586 // Version7 or newer, use filename and directory info from DIGlobal
1587 // directly.
1588 unsigned DID = Directories.idFor(G->getDirectory());
1589 FileID = SrcFiles.idFor(SrcFileInfo(DID, G->getFilename()));
1590 }
1591 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1592 AddUInt(Die, DW_AT_decl_line, 0, Line);
1593 }
1594
Devang Patel7c8a2772009-01-16 19:28:14 +00001595 void AddSourceLine(DIE *Die, const DIType *Ty) {
Devang Patel5f244e32009-01-05 22:35:52 +00001596 unsigned FileID = 0;
Devang Patel7c8a2772009-01-16 19:28:14 +00001597 unsigned Line = Ty->getLineNumber();
Devang Patelb49710a2009-01-20 19:22:03 +00001598 if (Ty->getVersion() <= LLVMDebugVersion6) {
Devang Patel5f244e32009-01-05 22:35:52 +00001599 // Version6 or earlier. Use compile unit info to get file id.
Devang Patel7c8a2772009-01-16 19:28:14 +00001600 CompileUnit *Unit = FindCompileUnit(Ty->getCompileUnit());
Devang Patel5f244e32009-01-05 22:35:52 +00001601 FileID = Unit->getID();
1602 } else {
Devang Patel7c8a2772009-01-16 19:28:14 +00001603 // Version7 or newer, use filename and directory info from DIType
Devang Patel5f244e32009-01-05 22:35:52 +00001604 // directly.
Devang Patel7c8a2772009-01-16 19:28:14 +00001605 unsigned DID = Directories.idFor(Ty->getDirectory());
1606 FileID = SrcFiles.idFor(SrcFileInfo(DID, Ty->getFilename()));
Devang Patel5f244e32009-01-05 22:35:52 +00001607 }
1608 AddUInt(Die, DW_AT_decl_file, 0, FileID);
1609 AddUInt(Die, DW_AT_decl_line, 0, Line);
1610 }
1611
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001612 /// AddAddress - Add an address attribute to a die based on the location
1613 /// provided.
1614 void AddAddress(DIE *Die, unsigned Attribute,
1615 const MachineLocation &Location) {
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001616 unsigned Reg = RI->getDwarfRegNum(Location.getReg(), false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001617 DIEBlock *Block = new DIEBlock();
aslc200b112008-08-16 12:57:46 +00001618
Dan Gohmanb9f4fa72008-10-03 15:45:36 +00001619 if (Location.isReg()) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001620 if (Reg < 32) {
1621 AddUInt(Block, 0, DW_FORM_data1, DW_OP_reg0 + Reg);
1622 } else {
1623 AddUInt(Block, 0, DW_FORM_data1, DW_OP_regx);
1624 AddUInt(Block, 0, DW_FORM_udata, Reg);
1625 }
1626 } else {
1627 if (Reg < 32) {
1628 AddUInt(Block, 0, DW_FORM_data1, DW_OP_breg0 + Reg);
1629 } else {
1630 AddUInt(Block, 0, DW_FORM_data1, DW_OP_bregx);
1631 AddUInt(Block, 0, DW_FORM_udata, Reg);
1632 }
1633 AddUInt(Block, 0, DW_FORM_sdata, Location.getOffset());
1634 }
aslc200b112008-08-16 12:57:46 +00001635
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001636 AddBlock(Die, Attribute, 0, Block);
1637 }
aslc200b112008-08-16 12:57:46 +00001638
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001639 /// AddBasicType - Add a new basic type attribute to the specified entity.
1640 ///
1641 void AddBasicType(DIE *Entity, CompileUnit *Unit,
1642 const std::string &Name,
1643 unsigned Encoding, unsigned Size) {
aslc200b112008-08-16 12:57:46 +00001644
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001645 DIE Buffer(DW_TAG_base_type);
1646 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1647 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, Encoding);
1648 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
Devang Patelf49e13d2009-01-05 17:44:11 +00001649 DIE *BasicTypeDie = Unit->AddDie(Buffer);
1650 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, BasicTypeDie);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001651 }
aslc200b112008-08-16 12:57:46 +00001652
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001653 /// AddPointerType - Add a new pointer type attribute to the specified entity.
1654 ///
1655 void AddPointerType(DIE *Entity, CompileUnit *Unit, const std::string &Name) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001656 DIE Buffer(DW_TAG_pointer_type);
Dan Gohmancfb72b22007-09-27 23:12:31 +00001657 AddUInt(&Buffer, DW_AT_byte_size, 0, TD->getPointerSize());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001658 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
Devang Patelbbca50b2009-01-05 17:45:59 +00001659 DIE *PointerTypeDie = Unit->AddDie(Buffer);
1660 AddDIEntry(Entity, DW_AT_type, DW_FORM_ref4, PointerTypeDie);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001661 }
aslc200b112008-08-16 12:57:46 +00001662
Dan Gohmanf17a25c2007-07-18 16:29:46 +00001663 /// AddType - Add a new type attribute to the specified entity.
Devang Patel4a4cbe72009-01-05 21:47:57 +00001664 void AddType(CompileUnit *DW_Unit, DIE *Entity, DIType Ty) {
1665 if (Ty.isNull()) {
1666 AddBasicType(Entity, DW_Unit, "", DW_ATE_signed, sizeof(int32_t));
1667 return;
1668 }
1669
1670 // Check for pre-existence.
1671 DIEntry *&Slot = DW_Unit->getDIEntrySlotFor(Ty.getGV());
1672 // If it exists then use the existing value.
1673 if (Slot) {
1674 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1675 return;
1676 }
1677
1678 // Set up proxy.
1679 Slot = NewDIEntry();
1680
1681 // Construct type.
1682 DIE Buffer(DW_TAG_base_type);
Devang Patelef4bf3b2009-01-15 19:26:23 +00001683 if (Ty.isBasicType(Ty.getTag()))
1684 ConstructTypeDIE(DW_Unit, Buffer, DIBasicType(Ty.getGV()));
1685 else if (Ty.isDerivedType(Ty.getTag()))
1686 ConstructTypeDIE(DW_Unit, Buffer, DIDerivedType(Ty.getGV()));
1687 else {
1688 assert (Ty.isCompositeType(Ty.getTag()) && "Unknown kind of DIType");
1689 ConstructTypeDIE(DW_Unit, Buffer, DICompositeType(Ty.getGV()));
1690 }
1691
Devang Patel4a4cbe72009-01-05 21:47:57 +00001692 // Add debug information entry to entity and unit.
1693 DIE *Die = DW_Unit->AddDie(Buffer);
1694 SetDIEntry(Slot, Die);
1695 Entity->AddValue(DW_AT_type, DW_FORM_ref4, Slot);
1696 }
1697
Devang Patel46d13752009-01-05 19:07:53 +00001698 /// ConstructTypeDIE - Construct basic type die from DIBasicType.
1699 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
Devang Patelef4bf3b2009-01-15 19:26:23 +00001700 DIBasicType BTy) {
Devang Patelfc187162009-01-05 17:57:47 +00001701
1702 // Get core information.
Devang Patelef4bf3b2009-01-15 19:26:23 +00001703 const std::string &Name = BTy.getName();
Devang Patelfc187162009-01-05 17:57:47 +00001704 Buffer.setTag(DW_TAG_base_type);
Devang Patelef4bf3b2009-01-15 19:26:23 +00001705 AddUInt(&Buffer, DW_AT_encoding, DW_FORM_data1, BTy.getEncoding());
Devang Patelfc187162009-01-05 17:57:47 +00001706 // Add name if not anonymous or intermediate type.
1707 if (!Name.empty())
1708 AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
Devang Patelef4bf3b2009-01-15 19:26:23 +00001709 uint64_t Size = BTy.getSizeInBits() >> 3;
Devang Patelfc187162009-01-05 17:57:47 +00001710 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1711 }
1712
Devang Patel46d13752009-01-05 19:07:53 +00001713 /// ConstructTypeDIE - Construct derived type die from DIDerivedType.
1714 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
Devang Patelef4bf3b2009-01-15 19:26:23 +00001715 DIDerivedType DTy) {
Devang Patelfc187162009-01-05 17:57:47 +00001716
1717 // Get core information.
Devang Patelef4bf3b2009-01-15 19:26:23 +00001718 const std::string &Name = DTy.getName();
1719 uint64_t Size = DTy.getSizeInBits() >> 3;
1720 unsigned Tag = DTy.getTag();
Devang Patelfc187162009-01-05 17:57:47 +00001721 // FIXME - Workaround for templates.
1722 if (Tag == DW_TAG_inheritance) Tag = DW_TAG_reference_type;
1723
1724 Buffer.setTag(Tag);
1725 // Map to main type, void will not have a type.
Devang Patelef4bf3b2009-01-15 19:26:23 +00001726 DIType FromTy = DTy.getTypeDerivedFrom();
Devang Patel4a4cbe72009-01-05 21:47:57 +00001727 AddType(DW_Unit, &Buffer, FromTy);
Devang Patelfc187162009-01-05 17:57:47 +00001728
1729 // Add name if not anonymous or intermediate type.
1730 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1731
1732 // Add size if non-zero (derived types might be zero-sized.)
1733 if (Size)
1734 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1735
1736 // Add source line info if available and TyDesc is not a forward
1737 // declaration.
Devang Patelef4bf3b2009-01-15 19:26:23 +00001738 // FIXME - Enable this. if (!DTy.isForwardDecl())
Devang Patelfc187162009-01-05 17:57:47 +00001739 // FIXME - Enable this. AddSourceLine(&Buffer, *DTy);
1740 }
1741
Devang Patel30c01372009-01-05 19:55:51 +00001742 /// ConstructTypeDIE - Construct type DIE from DICompositeType.
1743 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
Devang Patelef4bf3b2009-01-15 19:26:23 +00001744 DICompositeType CTy) {
Devang Patel30c01372009-01-05 19:55:51 +00001745
Devang Patelb28de842009-01-17 08:01:33 +00001746 // Get core information.
Devang Patelef4bf3b2009-01-15 19:26:23 +00001747 const std::string &Name = CTy.getName();
1748 uint64_t Size = CTy.getSizeInBits() >> 3;
1749 unsigned Tag = CTy.getTag();
Devang Patel30c01372009-01-05 19:55:51 +00001750 switch (Tag) {
1751 case DW_TAG_vector_type:
1752 case DW_TAG_array_type:
Devang Patelef4bf3b2009-01-15 19:26:23 +00001753 ConstructArrayTypeDIE(DW_Unit, Buffer, &CTy);
Devang Patel30c01372009-01-05 19:55:51 +00001754 break;
Devang Patel3798f492009-01-20 18:35:14 +00001755 case DW_TAG_enumeration_type:
1756 {
1757 DIArray Elements = CTy.getTypeArray();
1758 // Add enumerators to enumeration type.
1759 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1760 DIE *ElemDie = NULL;
1761 DIEnumerator Enum(Elements.getElement(i).getGV());
1762 ElemDie = ConstructEnumTypeDIE(DW_Unit, &Enum);
1763 Buffer.AddChild(ElemDie);
1764 }
1765 }
1766 break;
Devang Patel30c01372009-01-05 19:55:51 +00001767 case DW_TAG_subroutine_type:
1768 {
1769 // Add prototype flag.
1770 AddUInt(&Buffer, DW_AT_prototyped, DW_FORM_flag, 1);
Devang Patelef4bf3b2009-01-15 19:26:23 +00001771 DIArray Elements = CTy.getTypeArray();
Devang Patel30c01372009-01-05 19:55:51 +00001772 // Add return type.
Devang Patel4a4cbe72009-01-05 21:47:57 +00001773 DIDescriptor RTy = Elements.getElement(0);
Devang Patelef4bf3b2009-01-15 19:26:23 +00001774 AddType(DW_Unit, &Buffer, DIType(RTy.getGV()));
Devang Patel4a4cbe72009-01-05 21:47:57 +00001775
Devang Patel30c01372009-01-05 19:55:51 +00001776 // Add arguments.
1777 for (unsigned i = 1, N = Elements.getNumElements(); i < N; ++i) {
1778 DIE *Arg = new DIE(DW_TAG_formal_parameter);
Devang Patel4a4cbe72009-01-05 21:47:57 +00001779 DIDescriptor Ty = Elements.getElement(i);
Devang Pateld40a7e52009-01-17 06:57:25 +00001780 AddType(DW_Unit, Arg, DIType(Ty.getGV()));
Devang Patel30c01372009-01-05 19:55:51 +00001781 Buffer.AddChild(Arg);
1782 }
1783 }
1784 break;
1785 case DW_TAG_structure_type:
1786 case DW_TAG_union_type:
1787 {
1788 // Add elements to structure type.
Devang Patelef4bf3b2009-01-15 19:26:23 +00001789 DIArray Elements = CTy.getTypeArray();
Devang Patelcf7acb12009-01-16 00:50:53 +00001790
1791 // A forward struct declared type may not have elements available.
1792 if (Elements.isNull())
1793 break;
1794
Devang Patel30c01372009-01-05 19:55:51 +00001795 // Add elements to structure type.
1796 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
1797 DIDescriptor Element = Elements.getElement(i);
Devang Patelb28de842009-01-17 08:01:33 +00001798 DIE *ElemDie = NULL;
Devang Patelef4bf3b2009-01-15 19:26:23 +00001799 if (Element.getTag() == dwarf::DW_TAG_subprogram)
Devang Patel245446c2009-01-17 08:05:14 +00001800 ElemDie = CreateSubprogramDIE(DW_Unit,
1801 DISubprogram(Element.getGV()));
Devang Patelb28de842009-01-17 08:01:33 +00001802 else if (Element.getTag() == dwarf::DW_TAG_variable) // ???
1803 ElemDie = CreateGlobalVariableDIE(DW_Unit,
1804 DIGlobalVariable(Element.getGV()));
Devang Patelef4bf3b2009-01-15 19:26:23 +00001805 else {
1806 DIDerivedType DT = DIDerivedType(Element.getGV());
Devang Patelb28de842009-01-17 08:01:33 +00001807 assert (DT.isDerivedType(DT.getTag())
Devang Patel245446c2009-01-17 08:05:14 +00001808 && "Unexpected struct element type");
1809 ElemDie = new DIE(DT.getTag());
1810 AddType(DW_Unit, ElemDie, DT);
Devang Patelef4bf3b2009-01-15 19:26:23 +00001811 }
Devang Patel245446c2009-01-17 08:05:14 +00001812 Buffer.AddChild(ElemDie);
Devang Patel30c01372009-01-05 19:55:51 +00001813 }
1814 }
1815 break;
1816 default:
1817 break;
1818 }
1819
1820 // Add name if not anonymous or intermediate type.
1821 if (!Name.empty()) AddString(&Buffer, DW_AT_name, DW_FORM_string, Name);
1822
1823 // Add size if non-zero (derived types might be zero-sized.)
1824 if (Size)
1825 AddUInt(&Buffer, DW_AT_byte_size, 0, Size);
1826 else {
1827 // Add zero size even if it is not a forward declaration.
1828 // FIXME - Enable this.
Devang Patelef4bf3b2009-01-15 19:26:23 +00001829 // if (!CTy.isDefinition())
Devang Patel30c01372009-01-05 19:55:51 +00001830 // AddUInt(&Buffer, DW_AT_declaration, DW_FORM_flag, 1);
1831 // else
1832 // AddUInt(&Buffer, DW_AT_byte_size, 0, 0);
1833 }
1834
1835 // Add source line info if available and TyDesc is not a forward
1836 // declaration.
1837 // FIXME - Enable this.
Devang Patelef4bf3b2009-01-15 19:26:23 +00001838 // if (CTy.isForwardDecl())
Devang Patel30c01372009-01-05 19:55:51 +00001839 // AddSourceLine(&Buffer, *CTy);
1840 }
1841
Devang Patel6fb54132009-01-05 18:33:01 +00001842 // ConstructSubrangeDIE - Construct subrange DIE from DISubrange.
Devang Patelef4bf3b2009-01-15 19:26:23 +00001843 void ConstructSubrangeDIE (DIE &Buffer, DISubrange SR, DIE *IndexTy) {
1844 int64_t L = SR.getLo();
1845 int64_t H = SR.getHi();
Devang Patel6fb54132009-01-05 18:33:01 +00001846 DIE *DW_Subrange = new DIE(DW_TAG_subrange_type);
1847 if (L != H) {
1848 AddDIEntry(DW_Subrange, DW_AT_type, DW_FORM_ref4, IndexTy);
1849 if (L)
Devang Patel245446c2009-01-17 08:05:14 +00001850 AddSInt(DW_Subrange, DW_AT_lower_bound, 0, L);
1851 AddSInt(DW_Subrange, DW_AT_upper_bound, 0, H);
Devang Patel6fb54132009-01-05 18:33:01 +00001852 }
1853 Buffer.AddChild(DW_Subrange);
1854 }
1855
1856 /// ConstructArrayTypeDIE - Construct array type DIE from DICompositeType.
1857 void ConstructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
1858 DICompositeType *CTy) {
1859 Buffer.setTag(DW_TAG_array_type);
1860 if (CTy->getTag() == DW_TAG_vector_type)
1861 AddUInt(&Buffer, DW_AT_GNU_vector, DW_FORM_flag, 1);
1862
1863 DIArray Elements = CTy->getTypeArray();
Devang Patel4a4cbe72009-01-05 21:47:57 +00001864 AddType(DW_Unit, &Buffer, CTy->getTypeDerivedFrom());
Devang Patel6fb54132009-01-05 18:33:01 +00001865
1866 // Construct an anonymous type for index type.
1867 DIE IdxBuffer(DW_TAG_base_type);
1868 AddUInt(&IdxBuffer, DW_AT_byte_size, 0, sizeof(int32_t));
1869 AddUInt(&IdxBuffer, DW_AT_encoding, DW_FORM_data1, DW_ATE_signed);
1870 DIE *IndexTy = DW_Unit->AddDie(IdxBuffer);
1871
1872 // Add subranges to array type.
1873 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
Devang Patel30c01372009-01-05 19:55:51 +00001874 DIDescriptor Element = Elements.getElement(i);
Devang Patelef4bf3b2009-01-15 19:26:23 +00001875 if (Element.getTag() == dwarf::DW_TAG_subrange_type)
1876 ConstructSubrangeDIE(Buffer, DISubrange(Element.getGV()), IndexTy);
Devang Patel6fb54132009-01-05 18:33:01 +00001877 }
1878 }
1879
Devang Patela566e812009-01-05 18:38:38 +00001880 /// ConstructEnumTypeDIE - Construct enum type DIE from
1881 /// DIEnumerator.
Devang Patel3798f492009-01-20 18:35:14 +00001882 DIE *ConstructEnumTypeDIE(CompileUnit *DW_Unit, DIEnumerator *ETy) {
Devang Patela566e812009-01-05 18:38:38 +00001883
1884 DIE *Enumerator = new DIE(DW_TAG_enumerator);
1885 AddString(Enumerator, DW_AT_name, DW_FORM_string, ETy->getName());
1886 int64_t Value = ETy->getEnumValue();
1887 AddSInt(Enumerator, DW_AT_const_value, DW_FORM_sdata, Value);
Devang Patel3798f492009-01-20 18:35:14 +00001888 return Enumerator;
Devang Patela566e812009-01-05 18:38:38 +00001889 }
Devang Patel6fb54132009-01-05 18:33:01 +00001890
Devang Patelb28de842009-01-17 08:01:33 +00001891 /// CreateGlobalVariableDIE - Create new DIE using GV.
1892 DIE *CreateGlobalVariableDIE(CompileUnit *DW_Unit, const DIGlobalVariable &GV)
1893 {
1894 DIE *GVDie = new DIE(DW_TAG_variable);
1895 AddString(GVDie, DW_AT_name, DW_FORM_string, GV.getName());
1896 const std::string &LinkageName = GV.getLinkageName();
Devang Patel526b01d2009-01-05 18:59:44 +00001897 if (!LinkageName.empty())
Devang Patelb28de842009-01-17 08:01:33 +00001898 AddString(GVDie, DW_AT_MIPS_linkage_name, DW_FORM_string, LinkageName);
1899 AddType(DW_Unit, GVDie, GV.getType());
1900 if (!GV.isLocalToUnit())
1901 AddUInt(GVDie, DW_AT_external, DW_FORM_flag, 1);
1902 AddSourceLine(GVDie, &GV);
1903 return GVDie;
Devang Patel526b01d2009-01-05 18:59:44 +00001904 }
1905
Devang Patelb28de842009-01-17 08:01:33 +00001906 /// CreateSubprogramDIE - Create new DIE using SP.
1907 DIE *CreateSubprogramDIE(CompileUnit *DW_Unit,
Devang Patel245446c2009-01-17 08:05:14 +00001908 const DISubprogram &SP,
1909 bool IsConstructor = false) {
Devang Patelb28de842009-01-17 08:01:33 +00001910 DIE *SPDie = new DIE(DW_TAG_subprogram);
1911 AddString(SPDie, DW_AT_name, DW_FORM_string, SP.getName());
Devang Patelef4bf3b2009-01-15 19:26:23 +00001912 const std::string &LinkageName = SP.getLinkageName();
Devang Patel526b01d2009-01-05 18:59:44 +00001913 if (!LinkageName.empty())
Devang Patelb28de842009-01-17 08:01:33 +00001914 AddString(SPDie, DW_AT_MIPS_linkage_name, DW_FORM_string,
Devang Patel245446c2009-01-17 08:05:14 +00001915 LinkageName);
Devang Patelb28de842009-01-17 08:01:33 +00001916 AddSourceLine(SPDie, &SP);
Devang Patel526b01d2009-01-05 18:59:44 +00001917
Devang Patelb28de842009-01-17 08:01:33 +00001918 DICompositeType SPTy = SP.getType();
1919 DIArray Args = SPTy.getTypeArray();
1920
Devang Patel526b01d2009-01-05 18:59:44 +00001921 // Add Return Type.
Devang Patelef4bf3b2009-01-15 19:26:23 +00001922 if (!IsConstructor)
Devang Patelb28de842009-01-17 08:01:33 +00001923 AddType(DW_Unit, SPDie, DIType(Args.getElement(0).getGV()));
1924
Devang Patel526b01d2009-01-05 18:59:44 +00001925 // Add arguments.
Devang Patelb28de842009-01-17 08:01:33 +00001926 if (!Args.isNull())
1927 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
Devang Patel245446c2009-01-17 08:05:14 +00001928 DIE *Arg = new DIE(DW_TAG_formal_parameter);
1929 AddType(DW_Unit, Arg, DIType(Args.getElement(i).getGV()));
1930 AddUInt(Arg, DW_AT_artificial, DW_FORM_flag, 1); // ???
1931 SPDie->AddChild(Arg);
Devang Patelb28de842009-01-17 08:01:33 +00001932 }
1933
Devang Patelef4bf3b2009-01-15 19:26:23 +00001934 if (!SP.isLocalToUnit())
Devang Patelb28de842009-01-17 08:01:33 +00001935 AddUInt(SPDie, DW_AT_external, DW_FORM_flag, 1);
1936 return SPDie;
Devang Patel526b01d2009-01-05 18:59:44 +00001937 }
1938
Devang Patelb28de842009-01-17 08:01:33 +00001939 /// FindCompileUnit - Get the compile unit for the given descriptor.
1940 ///
Devang Patel5f244e32009-01-05 22:35:52 +00001941 CompileUnit *FindCompileUnit(DICompileUnit Unit) {
1942 CompileUnit *DW_Unit = DW_CUs[Unit.getGV()];
1943 assert(DW_Unit && "Missing compile unit.");
1944 return DW_Unit;
1945 }
1946
Devang Patel42f6bed2009-01-13 23:54:55 +00001947 /// NewDbgScopeVariable - Create a new scope variable.
Devang Patel4d1709e2009-01-08 02:33:41 +00001948 ///
1949 DIE *NewDbgScopeVariable(DbgVariable *DV, CompileUnit *Unit) {
1950 // Get the descriptor.
Devang Patel7c8a2772009-01-16 19:28:14 +00001951 const DIVariable &VD = DV->getVariable();
Devang Patel4d1709e2009-01-08 02:33:41 +00001952
1953 // Translate tag to proper Dwarf tag. The result variable is dropped for
1954 // now.
1955 unsigned Tag;
Devang Patel7c8a2772009-01-16 19:28:14 +00001956 switch (VD.getTag()) {
Devang Patel4d1709e2009-01-08 02:33:41 +00001957 case DW_TAG_return_variable: return NULL;
1958 case DW_TAG_arg_variable: Tag = DW_TAG_formal_parameter; break;
1959 case DW_TAG_auto_variable: // fall thru
1960 default: Tag = DW_TAG_variable; break;
1961 }
1962
1963 // Define variable debug information entry.
1964 DIE *VariableDie = new DIE(Tag);
Devang Patel7c8a2772009-01-16 19:28:14 +00001965 AddString(VariableDie, DW_AT_name, DW_FORM_string, VD.getName());
Devang Patel4d1709e2009-01-08 02:33:41 +00001966
1967 // Add source line info if available.
Devang Patel7c8a2772009-01-16 19:28:14 +00001968 AddSourceLine(VariableDie, &VD);
Devang Patel4d1709e2009-01-08 02:33:41 +00001969
1970 // Add variable type.
Devang Patel7c8a2772009-01-16 19:28:14 +00001971 AddType(Unit, VariableDie, VD.getType());
Devang Patel4d1709e2009-01-08 02:33:41 +00001972
1973 // Add variable address.
1974 MachineLocation Location;
1975 Location.set(RI->getFrameRegister(*MF),
1976 RI->getFrameIndexOffset(*MF, DV->getFrameIndex()));
1977 AddAddress(VariableDie, DW_AT_location, Location);
1978
1979 return VariableDie;
1980 }
1981
Devang Patel4d1709e2009-01-08 02:33:41 +00001982 /// getOrCreateScope - Returns the scope associated with the given descriptor.
1983 ///
1984 DbgScope *getOrCreateScope(GlobalVariable *V) {
1985 DbgScope *&Slot = DbgScopeMap[V];
1986 if (!Slot) {
1987 // FIXME - breaks down when the context is an inlined function.
1988 DIDescriptor ParentDesc;
Devang Patel2560d922009-01-15 18:25:17 +00001989 DIDescriptor Desc(V);
1990 if (Desc.getTag() == dwarf::DW_TAG_lexical_block) {
1991 DIBlock Block(V);
1992 ParentDesc = Block.getContext();
Devang Patel4d1709e2009-01-08 02:33:41 +00001993 }
1994 DbgScope *Parent = ParentDesc.isNull() ?
Devang Pateldd49fbb2009-01-10 02:34:18 +00001995 NULL : getOrCreateScope(ParentDesc.getGV());
Devang Patel2560d922009-01-15 18:25:17 +00001996 Slot = new DbgScope(Parent, Desc);
Devang Patel4d1709e2009-01-08 02:33:41 +00001997 if (Parent) {
1998 Parent->AddScope(Slot);
1999 } else if (RootDbgScope) {
2000 // FIXME - Add inlined function scopes to the root so we can delete
2001 // them later. Long term, handle inlined functions properly.
2002 RootDbgScope->AddScope(Slot);
2003 } else {
2004 // First function is top level function.
2005 RootDbgScope = Slot;
2006 }
2007 }
2008 return Slot;
2009 }
2010
2011 /// ConstructDbgScope - Construct the components of a scope.
2012 ///
2013 void ConstructDbgScope(DbgScope *ParentScope,
2014 unsigned ParentStartID, unsigned ParentEndID,
2015 DIE *ParentDie, CompileUnit *Unit) {
2016 // Add variables to scope.
Devang Patel63c22f42009-01-10 02:42:49 +00002017 SmallVector<DbgVariable *, 8> &Variables = ParentScope->getVariables();
Devang Patel4d1709e2009-01-08 02:33:41 +00002018 for (unsigned i = 0, N = Variables.size(); i < N; ++i) {
2019 DIE *VariableDie = NewDbgScopeVariable(Variables[i], Unit);
2020 if (VariableDie) ParentDie->AddChild(VariableDie);
2021 }
2022
2023 // Add nested scopes.
Devang Patel63c22f42009-01-10 02:42:49 +00002024 SmallVector<DbgScope *, 4> &Scopes = ParentScope->getScopes();
Devang Patel4d1709e2009-01-08 02:33:41 +00002025 for (unsigned j = 0, M = Scopes.size(); j < M; ++j) {
2026 // Define the Scope debug information entry.
2027 DbgScope *Scope = Scopes[j];
2028 // FIXME - Ignore inlined functions for the time being.
2029 if (!Scope->getParent()) continue;
2030
Devang Patelb9224922009-01-12 18:41:00 +00002031 unsigned StartID = MMI->MappedLabel(Scope->getStartLabelID());
2032 unsigned EndID = MMI->MappedLabel(Scope->getEndLabelID());
Devang Patel4d1709e2009-01-08 02:33:41 +00002033
2034 // Ignore empty scopes.
2035 if (StartID == EndID && StartID != 0) continue;
2036 if (Scope->getScopes().empty() && Scope->getVariables().empty()) continue;
2037
2038 if (StartID == ParentStartID && EndID == ParentEndID) {
2039 // Just add stuff to the parent scope.
2040 ConstructDbgScope(Scope, ParentStartID, ParentEndID, ParentDie, Unit);
2041 } else {
2042 DIE *ScopeDie = new DIE(DW_TAG_lexical_block);
2043
2044 // Add the scope bounds.
2045 if (StartID) {
2046 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2047 DWLabel("label", StartID));
2048 } else {
2049 AddLabel(ScopeDie, DW_AT_low_pc, DW_FORM_addr,
2050 DWLabel("func_begin", SubprogramCount));
2051 }
2052 if (EndID) {
2053 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2054 DWLabel("label", EndID));
2055 } else {
2056 AddLabel(ScopeDie, DW_AT_high_pc, DW_FORM_addr,
2057 DWLabel("func_end", SubprogramCount));
2058 }
2059
2060 // Add the scope contents.
2061 ConstructDbgScope(Scope, StartID, EndID, ScopeDie, Unit);
2062 ParentDie->AddChild(ScopeDie);
2063 }
2064 }
2065 }
2066
2067 /// ConstructRootDbgScope - Construct the scope for the subprogram.
2068 ///
2069 void ConstructRootDbgScope(DbgScope *RootScope) {
2070 // Exit if there is no root scope.
2071 if (!RootScope) return;
Devang Patel2560d922009-01-15 18:25:17 +00002072 DIDescriptor Desc = RootScope->getDesc();
2073 if (Desc.isNull())
2074 return;
Devang Patel4d1709e2009-01-08 02:33:41 +00002075
2076 // Get the subprogram debug information entry.
Devang Patel2560d922009-01-15 18:25:17 +00002077 DISubprogram SPD(Desc.getGV());
Devang Patel4d1709e2009-01-08 02:33:41 +00002078
2079 // Get the compile unit context.
Devang Patel57ec9ac2009-01-12 22:58:14 +00002080 CompileUnit *Unit = FindCompileUnit(SPD.getCompileUnit());
Devang Patel4d1709e2009-01-08 02:33:41 +00002081
2082 // Get the subprogram die.
Devang Patel57ec9ac2009-01-12 22:58:14 +00002083 DIE *SPDie = Unit->getDieMapSlotFor(SPD.getGV());
Devang Patel4d1709e2009-01-08 02:33:41 +00002084 assert(SPDie && "Missing subprogram descriptor");
2085
2086 // Add the function bounds.
2087 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2088 DWLabel("func_begin", SubprogramCount));
2089 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2090 DWLabel("func_end", SubprogramCount));
2091 MachineLocation Location(RI->getFrameRegister(*MF));
2092 AddAddress(SPDie, DW_AT_frame_base, Location);
2093
2094 ConstructDbgScope(RootScope, 0, 0, SPDie, Unit);
2095 }
2096
2097 /// ConstructDefaultDbgScope - Construct a default scope for the subprogram.
2098 ///
2099 void ConstructDefaultDbgScope(MachineFunction *MF) {
2100 // Find the correct subprogram descriptor.
2101 std::string SPName = "llvm.dbg.subprograms";
2102 std::vector<GlobalVariable*> Result;
2103 getGlobalVariablesUsing(*M, SPName, Result);
2104 for (std::vector<GlobalVariable *>::iterator I = Result.begin(),
2105 E = Result.end(); I != E; ++I) {
2106
Devang Patel7c8a2772009-01-16 19:28:14 +00002107 DISubprogram SPD(*I);
Devang Patel4d1709e2009-01-08 02:33:41 +00002108
Devang Patel7c8a2772009-01-16 19:28:14 +00002109 if (SPD.getName() == MF->getFunction()->getName()) {
Devang Patel4d1709e2009-01-08 02:33:41 +00002110 // Get the compile unit context.
Devang Patel7c8a2772009-01-16 19:28:14 +00002111 CompileUnit *Unit = FindCompileUnit(SPD.getCompileUnit());
Devang Patel4d1709e2009-01-08 02:33:41 +00002112
2113 // Get the subprogram die.
Devang Patel7c8a2772009-01-16 19:28:14 +00002114 DIE *SPDie = Unit->getDieMapSlotFor(SPD.getGV());
Devang Patel4d1709e2009-01-08 02:33:41 +00002115 assert(SPDie && "Missing subprogram descriptor");
2116
2117 // Add the function bounds.
2118 AddLabel(SPDie, DW_AT_low_pc, DW_FORM_addr,
2119 DWLabel("func_begin", SubprogramCount));
2120 AddLabel(SPDie, DW_AT_high_pc, DW_FORM_addr,
2121 DWLabel("func_end", SubprogramCount));
2122
2123 MachineLocation Location(RI->getFrameRegister(*MF));
2124 AddAddress(SPDie, DW_AT_frame_base, Location);
2125 return;
2126 }
2127 }
2128#if 0
2129 // FIXME: This is causing an abort because C++ mangled names are compared
2130 // with their unmangled counterparts. See PR2885. Don't do this assert.
2131 assert(0 && "Couldn't find DIE for machine function!");
2132#endif
2133 }
2134
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002135 /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
2136 /// tools to recognize the object file contains Dwarf information.
2137 void EmitInitial() {
2138 // Check to see if we already emitted intial headers.
2139 if (didInitial) return;
2140 didInitial = true;
aslc200b112008-08-16 12:57:46 +00002141
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002142 // Dwarf sections base addresses.
2143 if (TAI->doesDwarfRequireFrameSection()) {
2144 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2145 EmitLabel("section_debug_frame", 0);
2146 }
2147 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
2148 EmitLabel("section_info", 0);
2149 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
2150 EmitLabel("section_abbrev", 0);
2151 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
2152 EmitLabel("section_aranges", 0);
2153 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
2154 EmitLabel("section_macinfo", 0);
2155 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
2156 EmitLabel("section_line", 0);
2157 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
2158 EmitLabel("section_loc", 0);
2159 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
2160 EmitLabel("section_pubnames", 0);
2161 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
2162 EmitLabel("section_str", 0);
2163 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
2164 EmitLabel("section_ranges", 0);
2165
Anton Korobeynikov55b94962008-09-24 22:15:21 +00002166 Asm->SwitchToSection(TAI->getTextSection());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002167 EmitLabel("text_begin", 0);
Anton Korobeynikovcca60fa2008-09-24 22:16:16 +00002168 Asm->SwitchToSection(TAI->getDataSection());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002169 EmitLabel("data_begin", 0);
2170 }
2171
2172 /// EmitDIE - Recusively Emits a debug information entry.
2173 ///
2174 void EmitDIE(DIE *Die) {
2175 // Get the abbreviation for this DIE.
2176 unsigned AbbrevNumber = Die->getAbbrevNumber();
2177 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
aslc200b112008-08-16 12:57:46 +00002178
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002179 Asm->EOL();
2180
2181 // Emit the code (index) for the abbreviation.
2182 Asm->EmitULEB128Bytes(AbbrevNumber);
Evan Cheng0eeed442008-07-01 23:18:29 +00002183
2184 if (VerboseAsm)
2185 Asm->EOL(std::string("Abbrev [" +
2186 utostr(AbbrevNumber) +
2187 "] 0x" + utohexstr(Die->getOffset()) +
2188 ":0x" + utohexstr(Die->getSize()) + " " +
2189 TagString(Abbrev->getTag())));
2190 else
2191 Asm->EOL();
aslc200b112008-08-16 12:57:46 +00002192
Owen Anderson88dd6232008-06-24 21:44:59 +00002193 SmallVector<DIEValue*, 32> &Values = Die->getValues();
2194 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
aslc200b112008-08-16 12:57:46 +00002195
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002196 // Emit the DIE attribute values.
2197 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2198 unsigned Attr = AbbrevData[i].getAttribute();
2199 unsigned Form = AbbrevData[i].getForm();
2200 assert(Form && "Too many attributes for DIE (check abbreviation)");
aslc200b112008-08-16 12:57:46 +00002201
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002202 switch (Attr) {
2203 case DW_AT_sibling: {
2204 Asm->EmitInt32(Die->SiblingOffset());
2205 break;
2206 }
2207 default: {
2208 // Emit an attribute using the defined form.
2209 Values[i]->EmitValue(*this, Form);
2210 break;
2211 }
2212 }
aslc200b112008-08-16 12:57:46 +00002213
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002214 Asm->EOL(AttributeString(Attr));
2215 }
aslc200b112008-08-16 12:57:46 +00002216
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002217 // Emit the DIE children if any.
2218 if (Abbrev->getChildrenFlag() == DW_CHILDREN_yes) {
2219 const std::vector<DIE *> &Children = Die->getChildren();
aslc200b112008-08-16 12:57:46 +00002220
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002221 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2222 EmitDIE(Children[j]);
2223 }
aslc200b112008-08-16 12:57:46 +00002224
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002225 Asm->EmitInt8(0); Asm->EOL("End Of Children Mark");
2226 }
2227 }
2228
2229 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
2230 ///
2231 unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last) {
2232 // Get the children.
2233 const std::vector<DIE *> &Children = Die->getChildren();
aslc200b112008-08-16 12:57:46 +00002234
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002235 // If not last sibling and has children then add sibling offset attribute.
2236 if (!Last && !Children.empty()) Die->AddSiblingOffset();
2237
2238 // Record the abbreviation.
2239 AssignAbbrevNumber(Die->getAbbrev());
aslc200b112008-08-16 12:57:46 +00002240
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002241 // Get the abbreviation for this DIE.
2242 unsigned AbbrevNumber = Die->getAbbrevNumber();
2243 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
2244
2245 // Set DIE offset
2246 Die->setOffset(Offset);
aslc200b112008-08-16 12:57:46 +00002247
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002248 // Start the size with the size of abbreviation code.
aslc200b112008-08-16 12:57:46 +00002249 Offset += TargetAsmInfo::getULEB128Size(AbbrevNumber);
2250
Owen Anderson88dd6232008-06-24 21:44:59 +00002251 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
2252 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002253
2254 // Size the DIE attribute values.
2255 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2256 // Size attribute value.
2257 Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
2258 }
aslc200b112008-08-16 12:57:46 +00002259
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002260 // Size the DIE children if any.
2261 if (!Children.empty()) {
2262 assert(Abbrev->getChildrenFlag() == DW_CHILDREN_yes &&
2263 "Children flag not set");
aslc200b112008-08-16 12:57:46 +00002264
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002265 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
2266 Offset = SizeAndOffsetDie(Children[j], Offset, (j + 1) == M);
2267 }
aslc200b112008-08-16 12:57:46 +00002268
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002269 // End of children marker.
2270 Offset += sizeof(int8_t);
2271 }
2272
2273 Die->setSize(Offset - Die->getOffset());
2274 return Offset;
2275 }
2276
2277 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
2278 ///
2279 void SizeAndOffsets() {
2280 // Process base compile unit.
Devang Patel6eae2832009-01-12 23:05:55 +00002281 for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
2282 CE = DW_CUs.end(); CI != CE; ++CI) {
2283 CompileUnit *Unit = CI->second;
2284 // Compute size of compile unit header
2285 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
2286 sizeof(int16_t) + // DWARF version number
2287 sizeof(int32_t) + // Offset Into Abbrev. Section
2288 sizeof(int8_t); // Pointer Size (in bytes)
2289 SizeAndOffsetDie(Unit->getDie(), Offset, true);
2290 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002291 }
2292
2293 /// EmitDebugInfo - Emit the debug info section.
2294 ///
2295 void EmitDebugInfo() {
2296 // Start debug info section.
2297 Asm->SwitchToDataSection(TAI->getDwarfInfoSection());
aslc200b112008-08-16 12:57:46 +00002298
Devang Patel6eae2832009-01-12 23:05:55 +00002299 for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
2300 CE = DW_CUs.end(); CI != CE; ++CI) {
2301 CompileUnit *Unit = CI->second;
2302 DIE *Die = Unit->getDie();
2303 // Emit the compile units header.
2304 EmitLabel("info_begin", Unit->getID());
2305 // Emit size of content not including length itself
2306 unsigned ContentSize = Die->getSize() +
2307 sizeof(int16_t) + // DWARF version number
2308 sizeof(int32_t) + // Offset Into Abbrev. Section
2309 sizeof(int8_t) + // Pointer Size (in bytes)
2310 sizeof(int32_t); // FIXME - extra pad for gdb bug.
2311
2312 Asm->EmitInt32(ContentSize); Asm->EOL("Length of Compilation Unit Info");
2313 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
2314 EmitSectionOffset("abbrev_begin", "section_abbrev", 0, 0, true, false);
2315 Asm->EOL("Offset Into Abbrev. Section");
2316 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Address Size (in bytes)");
2317
2318 EmitDIE(Die);
2319 // FIXME - extra padding for gdb bug.
2320 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2321 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2322 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2323 Asm->EmitInt8(0); Asm->EOL("Extra Pad For GDB");
2324 EmitLabel("info_end", Unit->getID());
2325
2326 Asm->EOL();
2327 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002328 }
2329
2330 /// EmitAbbreviations - Emit the abbreviation section.
2331 ///
2332 void EmitAbbreviations() const {
2333 // Check to see if it is worth the effort.
2334 if (!Abbreviations.empty()) {
2335 // Start the debug abbrev section.
2336 Asm->SwitchToDataSection(TAI->getDwarfAbbrevSection());
aslc200b112008-08-16 12:57:46 +00002337
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002338 EmitLabel("abbrev_begin", 0);
aslc200b112008-08-16 12:57:46 +00002339
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002340 // For each abbrevation.
2341 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
2342 // Get abbreviation data
2343 const DIEAbbrev *Abbrev = Abbreviations[i];
aslc200b112008-08-16 12:57:46 +00002344
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002345 // Emit the abbrevations code (base 1 index.)
2346 Asm->EmitULEB128Bytes(Abbrev->getNumber());
2347 Asm->EOL("Abbreviation Code");
aslc200b112008-08-16 12:57:46 +00002348
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002349 // Emit the abbreviations data.
2350 Abbrev->Emit(*this);
aslc200b112008-08-16 12:57:46 +00002351
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002352 Asm->EOL();
2353 }
aslc200b112008-08-16 12:57:46 +00002354
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002355 // Mark end of abbreviations.
2356 Asm->EmitULEB128Bytes(0); Asm->EOL("EOM(3)");
2357
2358 EmitLabel("abbrev_end", 0);
aslc200b112008-08-16 12:57:46 +00002359
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002360 Asm->EOL();
2361 }
2362 }
2363
Bill Wendling1983a2a2008-07-20 00:11:19 +00002364 /// EmitEndOfLineMatrix - Emit the last address of the section and the end of
2365 /// the line matrix.
aslc200b112008-08-16 12:57:46 +00002366 ///
Bill Wendling1983a2a2008-07-20 00:11:19 +00002367 void EmitEndOfLineMatrix(unsigned SectionEnd) {
2368 // Define last address of section.
2369 Asm->EmitInt8(0); Asm->EOL("Extended Op");
2370 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
2371 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2372 EmitReference("section_end", SectionEnd); Asm->EOL("Section end label");
2373
2374 // Mark end of matrix.
2375 Asm->EmitInt8(0); Asm->EOL("DW_LNE_end_sequence");
2376 Asm->EmitULEB128Bytes(1); Asm->EOL();
2377 Asm->EmitInt8(1); Asm->EOL();
2378 }
2379
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002380 /// EmitDebugLines - Emit source line information.
2381 ///
2382 void EmitDebugLines() {
Bill Wendling1983a2a2008-07-20 00:11:19 +00002383 // If the target is using .loc/.file, the assembler will be emitting the
2384 // .debug_line table automatically.
2385 if (TAI->hasDotLocAndDotFile())
Dan Gohmanc55b34a2007-09-24 21:43:52 +00002386 return;
2387
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002388 // Minimum line delta, thus ranging from -10..(255-10).
2389 const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
2390 // Maximum line delta, thus ranging from -10..(255-10).
2391 const int MaxLineDelta = 255 + MinLineDelta;
2392
2393 // Start the dwarf line section.
2394 Asm->SwitchToDataSection(TAI->getDwarfLineSection());
aslc200b112008-08-16 12:57:46 +00002395
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002396 // Construct the section header.
aslc200b112008-08-16 12:57:46 +00002397
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002398 EmitDifference("line_end", 0, "line_begin", 0, true);
2399 Asm->EOL("Length of Source Line Info");
2400 EmitLabel("line_begin", 0);
aslc200b112008-08-16 12:57:46 +00002401
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002402 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF version number");
aslc200b112008-08-16 12:57:46 +00002403
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002404 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0, true);
2405 Asm->EOL("Prolog Length");
2406 EmitLabel("line_prolog_begin", 0);
aslc200b112008-08-16 12:57:46 +00002407
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002408 Asm->EmitInt8(1); Asm->EOL("Minimum Instruction Length");
2409
2410 Asm->EmitInt8(1); Asm->EOL("Default is_stmt_start flag");
2411
2412 Asm->EmitInt8(MinLineDelta); Asm->EOL("Line Base Value (Special Opcodes)");
aslc200b112008-08-16 12:57:46 +00002413
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002414 Asm->EmitInt8(MaxLineDelta); Asm->EOL("Line Range Value (Special Opcodes)");
2415
2416 Asm->EmitInt8(-MinLineDelta); Asm->EOL("Special Opcode Base");
aslc200b112008-08-16 12:57:46 +00002417
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002418 // Line number standard opcode encodings argument count
2419 Asm->EmitInt8(0); Asm->EOL("DW_LNS_copy arg count");
2420 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_pc arg count");
2421 Asm->EmitInt8(1); Asm->EOL("DW_LNS_advance_line arg count");
2422 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_file arg count");
2423 Asm->EmitInt8(1); Asm->EOL("DW_LNS_set_column arg count");
2424 Asm->EmitInt8(0); Asm->EOL("DW_LNS_negate_stmt arg count");
2425 Asm->EmitInt8(0); Asm->EOL("DW_LNS_set_basic_block arg count");
2426 Asm->EmitInt8(0); Asm->EOL("DW_LNS_const_add_pc arg count");
2427 Asm->EmitInt8(1); Asm->EOL("DW_LNS_fixed_advance_pc arg count");
2428
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002429 // Emit directories.
2430 for (unsigned DirectoryID = 1, NDID = Directories.size();
2431 DirectoryID <= NDID; ++DirectoryID) {
2432 Asm->EmitString(Directories[DirectoryID]); Asm->EOL("Directory");
2433 }
2434 Asm->EmitInt8(0); Asm->EOL("End of directories");
aslc200b112008-08-16 12:57:46 +00002435
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002436 // Emit files.
Devang Patel6ccd57e2009-01-13 00:20:51 +00002437 for (unsigned SourceID = 1, NSID = SrcFiles.size();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002438 SourceID <= NSID; ++SourceID) {
Devang Patel6ccd57e2009-01-13 00:20:51 +00002439 const SrcFileInfo &SourceFile = SrcFiles[SourceID];
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002440 Asm->EmitString(SourceFile.getName());
2441 Asm->EOL("Source");
2442 Asm->EmitULEB128Bytes(SourceFile.getDirectoryID());
2443 Asm->EOL("Directory #");
2444 Asm->EmitULEB128Bytes(0);
2445 Asm->EOL("Mod date");
2446 Asm->EmitULEB128Bytes(0);
2447 Asm->EOL("File size");
2448 }
2449 Asm->EmitInt8(0); Asm->EOL("End of files");
aslc200b112008-08-16 12:57:46 +00002450
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002451 EmitLabel("line_prolog_end", 0);
aslc200b112008-08-16 12:57:46 +00002452
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002453 // A sequence for each text section.
Bill Wendling1983a2a2008-07-20 00:11:19 +00002454 unsigned SecSrcLinesSize = SectionSourceLines.size();
2455
2456 for (unsigned j = 0; j < SecSrcLinesSize; ++j) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002457 // Isolate current sections line info.
Devang Patel35a078f2009-01-12 22:54:42 +00002458 const std::vector<SrcLineInfo> &LineInfos = SectionSourceLines[j];
Evan Cheng0eeed442008-07-01 23:18:29 +00002459
Anton Korobeynikov55b94962008-09-24 22:15:21 +00002460 if (VerboseAsm) {
2461 const Section* S = SectionMap[j + 1];
2462 Asm->EOL(std::string("Section ") + S->getName());
2463 } else
Evan Cheng0eeed442008-07-01 23:18:29 +00002464 Asm->EOL();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002465
2466 // Dwarf assumes we start with first line of first source file.
2467 unsigned Source = 1;
2468 unsigned Line = 1;
aslc200b112008-08-16 12:57:46 +00002469
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002470 // Construct rows of the address, source, line, column matrix.
2471 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
Devang Patel35a078f2009-01-12 22:54:42 +00002472 const SrcLineInfo &LineInfo = LineInfos[i];
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002473 unsigned LabelID = MMI->MappedLabel(LineInfo.getLabelID());
2474 if (!LabelID) continue;
aslc200b112008-08-16 12:57:46 +00002475
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002476 unsigned SourceID = LineInfo.getSourceID();
Devang Patel6ccd57e2009-01-13 00:20:51 +00002477 const SrcFileInfo &SourceFile = SrcFiles[SourceID];
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002478 unsigned DirectoryID = SourceFile.getDirectoryID();
Evan Cheng0eeed442008-07-01 23:18:29 +00002479 if (VerboseAsm)
2480 Asm->EOL(Directories[DirectoryID]
2481 + SourceFile.getName()
2482 + ":"
2483 + utostr_32(LineInfo.getLine()));
2484 else
2485 Asm->EOL();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002486
2487 // Define the line address.
2488 Asm->EmitInt8(0); Asm->EOL("Extended Op");
Dan Gohmancfb72b22007-09-27 23:12:31 +00002489 Asm->EmitInt8(TD->getPointerSize() + 1); Asm->EOL("Op size");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002490 Asm->EmitInt8(DW_LNE_set_address); Asm->EOL("DW_LNE_set_address");
2491 EmitReference("label", LabelID); Asm->EOL("Location label");
aslc200b112008-08-16 12:57:46 +00002492
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002493 // If change of source, then switch to the new source.
2494 if (Source != LineInfo.getSourceID()) {
2495 Source = LineInfo.getSourceID();
2496 Asm->EmitInt8(DW_LNS_set_file); Asm->EOL("DW_LNS_set_file");
2497 Asm->EmitULEB128Bytes(Source); Asm->EOL("New Source");
2498 }
aslc200b112008-08-16 12:57:46 +00002499
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002500 // If change of line.
2501 if (Line != LineInfo.getLine()) {
2502 // Determine offset.
2503 int Offset = LineInfo.getLine() - Line;
2504 int Delta = Offset - MinLineDelta;
aslc200b112008-08-16 12:57:46 +00002505
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002506 // Update line.
2507 Line = LineInfo.getLine();
aslc200b112008-08-16 12:57:46 +00002508
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002509 // If delta is small enough and in range...
2510 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
2511 // ... then use fast opcode.
2512 Asm->EmitInt8(Delta - MinLineDelta); Asm->EOL("Line Delta");
2513 } else {
2514 // ... otherwise use long hand.
2515 Asm->EmitInt8(DW_LNS_advance_line); Asm->EOL("DW_LNS_advance_line");
2516 Asm->EmitSLEB128Bytes(Offset); Asm->EOL("Line Offset");
2517 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2518 }
2519 } else {
2520 // Copy the previous row (different address or source)
2521 Asm->EmitInt8(DW_LNS_copy); Asm->EOL("DW_LNS_copy");
2522 }
2523 }
2524
Bill Wendling1983a2a2008-07-20 00:11:19 +00002525 EmitEndOfLineMatrix(j + 1);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002526 }
Bill Wendling1983a2a2008-07-20 00:11:19 +00002527
2528 if (SecSrcLinesSize == 0)
2529 // Because we're emitting a debug_line section, we still need a line
2530 // table. The linker and friends expect it to exist. If there's nothing to
2531 // put into it, emit an empty table.
2532 EmitEndOfLineMatrix(1);
aslc200b112008-08-16 12:57:46 +00002533
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002534 EmitLabel("line_end", 0);
aslc200b112008-08-16 12:57:46 +00002535
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002536 Asm->EOL();
2537 }
aslc200b112008-08-16 12:57:46 +00002538
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002539 /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
2540 ///
2541 void EmitCommonDebugFrame() {
2542 if (!TAI->doesDwarfRequireFrameSection())
2543 return;
2544
2545 int stackGrowth =
2546 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
2547 TargetFrameInfo::StackGrowsUp ?
Dan Gohmancfb72b22007-09-27 23:12:31 +00002548 TD->getPointerSize() : -TD->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002549
2550 // Start the dwarf frame section.
2551 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
2552
2553 EmitLabel("debug_frame_common", 0);
2554 EmitDifference("debug_frame_common_end", 0,
2555 "debug_frame_common_begin", 0, true);
2556 Asm->EOL("Length of Common Information Entry");
2557
2558 EmitLabel("debug_frame_common_begin", 0);
2559 Asm->EmitInt32((int)DW_CIE_ID);
2560 Asm->EOL("CIE Identifier Tag");
2561 Asm->EmitInt8(DW_CIE_VERSION);
2562 Asm->EOL("CIE Version");
2563 Asm->EmitString("");
2564 Asm->EOL("CIE Augmentation");
2565 Asm->EmitULEB128Bytes(1);
2566 Asm->EOL("CIE Code Alignment Factor");
2567 Asm->EmitSLEB128Bytes(stackGrowth);
aslc200b112008-08-16 12:57:46 +00002568 Asm->EOL("CIE Data Alignment Factor");
Dale Johannesenf5a11532007-11-13 19:13:01 +00002569 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), false));
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002570 Asm->EOL("CIE RA Column");
aslc200b112008-08-16 12:57:46 +00002571
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002572 std::vector<MachineMove> Moves;
2573 RI->getInitialFrameState(Moves);
2574
Dale Johannesenf5a11532007-11-13 19:13:01 +00002575 EmitFrameMoves(NULL, 0, Moves, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002576
Evan Cheng7e7d1942008-02-29 19:36:59 +00002577 Asm->EmitAlignment(2, 0, 0, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002578 EmitLabel("debug_frame_common_end", 0);
aslc200b112008-08-16 12:57:46 +00002579
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002580 Asm->EOL();
2581 }
2582
2583 /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
2584 /// section.
2585 void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo) {
2586 if (!TAI->doesDwarfRequireFrameSection())
2587 return;
aslc200b112008-08-16 12:57:46 +00002588
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002589 // Start the dwarf frame section.
2590 Asm->SwitchToDataSection(TAI->getDwarfFrameSection());
aslc200b112008-08-16 12:57:46 +00002591
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002592 EmitDifference("debug_frame_end", DebugFrameInfo.Number,
2593 "debug_frame_begin", DebugFrameInfo.Number, true);
2594 Asm->EOL("Length of Frame Information Entry");
aslc200b112008-08-16 12:57:46 +00002595
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002596 EmitLabel("debug_frame_begin", DebugFrameInfo.Number);
2597
2598 EmitSectionOffset("debug_frame_common", "section_debug_frame",
2599 0, 0, true, false);
2600 Asm->EOL("FDE CIE offset");
2601
2602 EmitReference("func_begin", DebugFrameInfo.Number);
2603 Asm->EOL("FDE initial location");
2604 EmitDifference("func_end", DebugFrameInfo.Number,
2605 "func_begin", DebugFrameInfo.Number);
2606 Asm->EOL("FDE address range");
aslc200b112008-08-16 12:57:46 +00002607
Devang Patelb28de842009-01-17 08:01:33 +00002608 EmitFrameMoves("func_begin", DebugFrameInfo.Number, DebugFrameInfo.Moves,
Devang Patel245446c2009-01-17 08:05:14 +00002609 false);
aslc200b112008-08-16 12:57:46 +00002610
Evan Cheng7e7d1942008-02-29 19:36:59 +00002611 Asm->EmitAlignment(2, 0, 0, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002612 EmitLabel("debug_frame_end", DebugFrameInfo.Number);
2613
2614 Asm->EOL();
2615 }
2616
2617 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
2618 ///
2619 void EmitDebugPubNames() {
2620 // Start the dwarf pubnames section.
2621 Asm->SwitchToDataSection(TAI->getDwarfPubNamesSection());
aslc200b112008-08-16 12:57:46 +00002622
Devang Patel6eae2832009-01-12 23:05:55 +00002623 for (DenseMap<Value *, CompileUnit *>::iterator CI = DW_CUs.begin(),
2624 CE = DW_CUs.end(); CI != CE; ++CI) {
2625 CompileUnit *Unit = CI->second;
aslc200b112008-08-16 12:57:46 +00002626
Devang Patel6eae2832009-01-12 23:05:55 +00002627 EmitDifference("pubnames_end", Unit->getID(),
2628 "pubnames_begin", Unit->getID(), true);
2629 Asm->EOL("Length of Public Names Info");
2630
2631 EmitLabel("pubnames_begin", Unit->getID());
2632
2633 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("DWARF Version");
2634
2635 EmitSectionOffset("info_begin", "section_info",
2636 Unit->getID(), 0, true, false);
2637 Asm->EOL("Offset of Compilation Unit Info");
2638
Devang Patelb28de842009-01-17 08:01:33 +00002639 EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID(),
Devang Patel245446c2009-01-17 08:05:14 +00002640 true);
Devang Patel6eae2832009-01-12 23:05:55 +00002641 Asm->EOL("Compilation Unit Length");
2642
2643 std::map<std::string, DIE *> &Globals = Unit->getGlobals();
2644
2645 for (std::map<std::string, DIE *>::iterator GI = Globals.begin(),
2646 GE = Globals.end();
2647 GI != GE; ++GI) {
2648 const std::string &Name = GI->first;
2649 DIE * Entity = GI->second;
2650
2651 Asm->EmitInt32(Entity->getOffset()); Asm->EOL("DIE offset");
2652 Asm->EmitString(Name); Asm->EOL("External Name");
2653 }
2654
2655 Asm->EmitInt32(0); Asm->EOL("End Mark");
2656 EmitLabel("pubnames_end", Unit->getID());
2657
2658 Asm->EOL();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002659 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002660 }
2661
2662 /// EmitDebugStr - Emit visible names into a debug str section.
2663 ///
2664 void EmitDebugStr() {
2665 // Check to see if it is worth the effort.
2666 if (!StringPool.empty()) {
2667 // Start the dwarf str section.
2668 Asm->SwitchToDataSection(TAI->getDwarfStrSection());
aslc200b112008-08-16 12:57:46 +00002669
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002670 // For each of strings in the string pool.
2671 for (unsigned StringID = 1, N = StringPool.size();
2672 StringID <= N; ++StringID) {
2673 // Emit a label for reference from debug information entries.
2674 EmitLabel("string", StringID);
2675 // Emit the string itself.
2676 const std::string &String = StringPool[StringID];
2677 Asm->EmitString(String); Asm->EOL();
2678 }
aslc200b112008-08-16 12:57:46 +00002679
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002680 Asm->EOL();
2681 }
2682 }
2683
2684 /// EmitDebugLoc - Emit visible names into a debug loc section.
2685 ///
2686 void EmitDebugLoc() {
2687 // Start the dwarf loc section.
2688 Asm->SwitchToDataSection(TAI->getDwarfLocSection());
aslc200b112008-08-16 12:57:46 +00002689
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002690 Asm->EOL();
2691 }
2692
2693 /// EmitDebugARanges - Emit visible names into a debug aranges section.
2694 ///
2695 void EmitDebugARanges() {
2696 // Start the dwarf aranges section.
2697 Asm->SwitchToDataSection(TAI->getDwarfARangesSection());
aslc200b112008-08-16 12:57:46 +00002698
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002699 // FIXME - Mock up
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00002700#if 0
aslc200b112008-08-16 12:57:46 +00002701 CompileUnit *Unit = GetBaseCompileUnit();
2702
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002703 // Don't include size of length
2704 Asm->EmitInt32(0x1c); Asm->EOL("Length of Address Ranges Info");
aslc200b112008-08-16 12:57:46 +00002705
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002706 Asm->EmitInt16(DWARF_VERSION); Asm->EOL("Dwarf Version");
aslc200b112008-08-16 12:57:46 +00002707
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002708 EmitReference("info_begin", Unit->getID());
2709 Asm->EOL("Offset of Compilation Unit Info");
2710
Dan Gohmancfb72b22007-09-27 23:12:31 +00002711 Asm->EmitInt8(TD->getPointerSize()); Asm->EOL("Size of Address");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002712
2713 Asm->EmitInt8(0); Asm->EOL("Size of Segment Descriptor");
2714
2715 Asm->EmitInt16(0); Asm->EOL("Pad (1)");
2716 Asm->EmitInt16(0); Asm->EOL("Pad (2)");
2717
2718 // Range 1
2719 EmitReference("text_begin", 0); Asm->EOL("Address");
2720 EmitDifference("text_end", 0, "text_begin", 0, true); Asm->EOL("Length");
2721
2722 Asm->EmitInt32(0); Asm->EOL("EOM (1)");
2723 Asm->EmitInt32(0); Asm->EOL("EOM (2)");
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00002724#endif
aslc200b112008-08-16 12:57:46 +00002725
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002726 Asm->EOL();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002727 }
2728
2729 /// EmitDebugRanges - Emit visible names into a debug ranges section.
2730 ///
2731 void EmitDebugRanges() {
2732 // Start the dwarf ranges section.
2733 Asm->SwitchToDataSection(TAI->getDwarfRangesSection());
aslc200b112008-08-16 12:57:46 +00002734
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002735 Asm->EOL();
2736 }
2737
2738 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
2739 ///
2740 void EmitDebugMacInfo() {
2741 // Start the dwarf macinfo section.
2742 Asm->SwitchToDataSection(TAI->getDwarfMacInfoSection());
aslc200b112008-08-16 12:57:46 +00002743
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002744 Asm->EOL();
2745 }
2746
Devang Patel289f2362009-01-05 23:11:11 +00002747 /// ConstructCompileUnits - Create a compile unit DIEs.
Devang Patelb3907da2009-01-05 23:03:32 +00002748 void ConstructCompileUnits() {
2749 std::string CUName = "llvm.dbg.compile_units";
2750 std::vector<GlobalVariable*> Result;
2751 getGlobalVariablesUsing(*M, CUName, Result);
2752 for (std::vector<GlobalVariable *>::iterator RI = Result.begin(),
2753 RE = Result.end(); RI != RE; ++RI) {
Devang Patel7c8a2772009-01-16 19:28:14 +00002754 DICompileUnit DIUnit(*RI);
2755 unsigned ID = RecordSource(DIUnit.getDirectory(),
2756 DIUnit.getFilename());
Devang Patelb3907da2009-01-05 23:03:32 +00002757
2758 DIE *Die = new DIE(DW_TAG_compile_unit);
2759 AddSectionOffset(Die, DW_AT_stmt_list, DW_FORM_data4,
2760 DWLabel("section_line", 0), DWLabel("section_line", 0),
2761 false);
Devang Patel7c8a2772009-01-16 19:28:14 +00002762 AddString(Die, DW_AT_producer, DW_FORM_string, DIUnit.getProducer());
2763 AddUInt(Die, DW_AT_language, DW_FORM_data1, DIUnit.getLanguage());
2764 AddString(Die, DW_AT_name, DW_FORM_string, DIUnit.getFilename());
2765 if (!DIUnit.getDirectory().empty())
2766 AddString(Die, DW_AT_comp_dir, DW_FORM_string, DIUnit.getDirectory());
Devang Patelb3907da2009-01-05 23:03:32 +00002767
2768 CompileUnit *Unit = new CompileUnit(ID, Die);
Devang Patel7c8a2772009-01-16 19:28:14 +00002769 DW_CUs[DIUnit.getGV()] = Unit;
Devang Patelb3907da2009-01-05 23:03:32 +00002770 }
2771 }
2772
Devang Patel289f2362009-01-05 23:11:11 +00002773 /// ConstructGlobalVariableDIEs - Create DIEs for each of the externally
2774 /// visible global variables.
2775 void ConstructGlobalVariableDIEs() {
2776 std::string GVName = "llvm.dbg.global_variables";
2777 std::vector<GlobalVariable*> Result;
2778 getGlobalVariablesUsing(*M, GVName, Result);
2779 for (std::vector<GlobalVariable *>::iterator GVI = Result.begin(),
2780 GVE = Result.end(); GVI != GVE; ++GVI) {
Devang Patel7c8a2772009-01-16 19:28:14 +00002781 DIGlobalVariable DI_GV(*GVI);
2782 CompileUnit *DW_Unit = FindCompileUnit(DI_GV.getCompileUnit());
Devang Patel289f2362009-01-05 23:11:11 +00002783
2784 // Check for pre-existence.
Devang Patel7c8a2772009-01-16 19:28:14 +00002785 DIE *&Slot = DW_Unit->getDieMapSlotFor(DI_GV.getGV());
Devang Patel289f2362009-01-05 23:11:11 +00002786 if (Slot) continue;
2787
Devang Patelb28de842009-01-17 08:01:33 +00002788 DIE *VariableDie = CreateGlobalVariableDIE(DW_Unit, DI_GV);
Devang Patel289f2362009-01-05 23:11:11 +00002789
2790 // Add address.
2791 DIEBlock *Block = new DIEBlock();
2792 AddUInt(Block, 0, DW_FORM_data1, DW_OP_addr);
2793 AddObjectLabel(Block, 0, DW_FORM_udata,
Devang Patel2072db82009-01-20 18:55:39 +00002794 Asm->getGlobalLinkName(DI_GV.getGlobal()));
Devang Patel289f2362009-01-05 23:11:11 +00002795 AddBlock(VariableDie, DW_AT_location, 0, Block);
2796
2797 //Add to map.
2798 Slot = VariableDie;
2799
2800 //Add to context owner.
2801 DW_Unit->getDie()->AddChild(VariableDie);
2802
2803 //Expose as global. FIXME - need to check external flag.
Devang Patel7c8a2772009-01-16 19:28:14 +00002804 DW_Unit->AddGlobal(DI_GV.getName(), VariableDie);
Devang Patel289f2362009-01-05 23:11:11 +00002805 }
2806 }
2807
Devang Patele6caf012009-01-05 23:21:35 +00002808 /// ConstructSubprograms - Create DIEs for each of the externally visible
2809 /// subprograms.
2810 void ConstructSubprograms() {
2811
2812 std::string SPName = "llvm.dbg.subprograms";
2813 std::vector<GlobalVariable*> Result;
2814 getGlobalVariablesUsing(*M, SPName, Result);
2815 for (std::vector<GlobalVariable *>::iterator RI = Result.begin(),
2816 RE = Result.end(); RI != RE; ++RI) {
2817
Devang Patel7c8a2772009-01-16 19:28:14 +00002818 DISubprogram SP(*RI);
2819 CompileUnit *Unit = FindCompileUnit(SP.getCompileUnit());
Devang Patele6caf012009-01-05 23:21:35 +00002820
Devang Patelb28de842009-01-17 08:01:33 +00002821 // Check for pre-existence.
Devang Patel7c8a2772009-01-16 19:28:14 +00002822 DIE *&Slot = Unit->getDieMapSlotFor(SP.getGV());
Devang Patele6caf012009-01-05 23:21:35 +00002823 if (Slot) continue;
2824
Devang Patelb28de842009-01-17 08:01:33 +00002825 DIE *SubprogramDie = CreateSubprogramDIE(Unit, SP);
Devang Patele6caf012009-01-05 23:21:35 +00002826
Devang Patele6caf012009-01-05 23:21:35 +00002827 //Add to map.
2828 Slot = SubprogramDie;
2829 //Add to context owner.
2830 Unit->getDie()->AddChild(SubprogramDie);
2831 //Expose as global.
Devang Patel7c8a2772009-01-16 19:28:14 +00002832 Unit->AddGlobal(SP.getName(), SubprogramDie);
Devang Patele6caf012009-01-05 23:21:35 +00002833 }
2834 }
2835
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002836public:
2837 //===--------------------------------------------------------------------===//
2838 // Main entry points.
2839 //
Owen Anderson847b99b2008-08-21 00:14:44 +00002840 DwarfDebug(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
Chris Lattnerb3876c72007-09-24 03:35:37 +00002841 : Dwarf(OS, A, T, "dbg")
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002842 , AbbreviationsSet(InitAbbreviationsSetSize)
2843 , Abbreviations()
2844 , ValuesSet(InitValuesSetSize)
2845 , Values()
2846 , StringPool()
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002847 , SectionMap()
2848 , SectionSourceLines()
2849 , didInitial(false)
2850 , shouldEmit(false)
Devang Patel4d1709e2009-01-08 02:33:41 +00002851 , RootDbgScope(NULL)
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002852 {
2853 }
2854 virtual ~DwarfDebug() {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002855 for (unsigned j = 0, M = Values.size(); j < M; ++j)
2856 delete Values[j];
2857 }
2858
Devang Patel9304b382009-01-06 21:07:30 +00002859 /// SetDebugInfo - Create global DIEs and emit initial debug info sections.
2860 /// This is inovked by the target AsmPrinter.
Devang Patel91d27b02009-01-12 23:09:42 +00002861 void SetDebugInfo(MachineModuleInfo *mmi) {
2862
Devang Patel9304b382009-01-06 21:07:30 +00002863 // Create all the compile unit DIEs.
2864 ConstructCompileUnits();
Devang Patel91d27b02009-01-12 23:09:42 +00002865
2866 if (DW_CUs.empty())
2867 return;
2868
2869 MMI = mmi;
2870 shouldEmit = true;
Devang Patel86cfa402009-01-13 23:02:17 +00002871 MMI->setDebugInfoAvailability(true);
Devang Patel9304b382009-01-06 21:07:30 +00002872
2873 // Create DIEs for each of the externally visible global variables.
2874 ConstructGlobalVariableDIEs();
2875
2876 // Create DIEs for each of the externally visible subprograms.
2877 ConstructSubprograms();
2878
2879 // Prime section data.
2880 SectionMap.insert(TAI->getTextSection());
2881
2882 // Print out .file directives to specify files for .loc directives. These
2883 // are printed out early so that they precede any .loc directives.
2884 if (TAI->hasDotLocAndDotFile()) {
2885 for (unsigned i = 1, e = SrcFiles.size(); i <= e; ++i) {
2886 sys::Path FullPath(Directories[SrcFiles[i].getDirectoryID()]);
2887 bool AppendOk = FullPath.appendComponent(SrcFiles[i].getName());
2888 assert(AppendOk && "Could not append filename to directory!");
2889 AppendOk = false;
2890 Asm->EmitFile(i, FullPath.toString());
2891 Asm->EOL();
2892 }
2893 }
2894
2895 // Emit initial sections
2896 EmitInitial();
2897 }
2898
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002899 /// BeginModule - Emit all Dwarf sections that should come prior to the
2900 /// content.
2901 void BeginModule(Module *M) {
2902 this->M = M;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002903 }
2904
2905 /// EndModule - Emit all Dwarf sections that should come after the content.
2906 ///
2907 void EndModule() {
2908 if (!ShouldEmitDwarf()) return;
aslc200b112008-08-16 12:57:46 +00002909
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002910 // Standard sections final addresses.
Anton Korobeynikov55b94962008-09-24 22:15:21 +00002911 Asm->SwitchToSection(TAI->getTextSection());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002912 EmitLabel("text_end", 0);
Anton Korobeynikovcca60fa2008-09-24 22:16:16 +00002913 Asm->SwitchToSection(TAI->getDataSection());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002914 EmitLabel("data_end", 0);
aslc200b112008-08-16 12:57:46 +00002915
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002916 // End text sections.
2917 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
Anton Korobeynikov55b94962008-09-24 22:15:21 +00002918 Asm->SwitchToSection(SectionMap[i]);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002919 EmitLabel("section_end", i);
2920 }
2921
2922 // Emit common frame information.
2923 EmitCommonDebugFrame();
2924
2925 // Emit function debug frame information
2926 for (std::vector<FunctionDebugFrameInfo>::iterator I = DebugFrames.begin(),
2927 E = DebugFrames.end(); I != E; ++I)
2928 EmitFunctionDebugFrame(*I);
2929
2930 // Compute DIE offsets and sizes.
2931 SizeAndOffsets();
aslc200b112008-08-16 12:57:46 +00002932
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002933 // Emit all the DIEs into a debug info section
2934 EmitDebugInfo();
aslc200b112008-08-16 12:57:46 +00002935
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002936 // Corresponding abbreviations into a abbrev section.
2937 EmitAbbreviations();
aslc200b112008-08-16 12:57:46 +00002938
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002939 // Emit source line correspondence into a debug line section.
2940 EmitDebugLines();
aslc200b112008-08-16 12:57:46 +00002941
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002942 // Emit info into a debug pubnames section.
2943 EmitDebugPubNames();
aslc200b112008-08-16 12:57:46 +00002944
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002945 // Emit info into a debug str section.
2946 EmitDebugStr();
aslc200b112008-08-16 12:57:46 +00002947
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002948 // Emit info into a debug loc section.
2949 EmitDebugLoc();
aslc200b112008-08-16 12:57:46 +00002950
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002951 // Emit info into a debug aranges section.
2952 EmitDebugARanges();
aslc200b112008-08-16 12:57:46 +00002953
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002954 // Emit info into a debug ranges section.
2955 EmitDebugRanges();
aslc200b112008-08-16 12:57:46 +00002956
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002957 // Emit info into a debug macinfo section.
2958 EmitDebugMacInfo();
2959 }
2960
aslc200b112008-08-16 12:57:46 +00002961 /// BeginFunction - Gather pre-function debug information. Assumes being
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002962 /// emitted immediately after the function entry point.
2963 void BeginFunction(MachineFunction *MF) {
2964 this->MF = MF;
aslc200b112008-08-16 12:57:46 +00002965
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002966 if (!ShouldEmitDwarf()) return;
2967
2968 // Begin accumulating function debug information.
2969 MMI->BeginFunction(MF);
aslc200b112008-08-16 12:57:46 +00002970
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002971 // Assumes in correct section after the entry point.
2972 EmitLabel("func_begin", ++SubprogramCount);
Evan Chenga53c40a2008-02-01 09:10:45 +00002973
2974 // Emit label for the implicitly defined dbg.stoppoint at the start of
2975 // the function.
Devang Patel35a078f2009-01-12 22:54:42 +00002976 if (!Lines.empty()) {
2977 const SrcLineInfo &LineInfo = Lines[0];
Andrew Lenharth42f91402008-04-03 17:37:43 +00002978 Asm->printLabel(LineInfo.getLabelID());
2979 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002980 }
aslc200b112008-08-16 12:57:46 +00002981
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002982 /// EndFunction - Gather and emit post-function debug information.
2983 ///
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00002984 void EndFunction(MachineFunction *MF) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002985 if (!ShouldEmitDwarf()) return;
aslc200b112008-08-16 12:57:46 +00002986
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002987 // Define end label for subprogram.
2988 EmitLabel("func_end", SubprogramCount);
aslc200b112008-08-16 12:57:46 +00002989
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002990 // Get function line info.
Devang Patel35a078f2009-01-12 22:54:42 +00002991 if (!Lines.empty()) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002992 // Get section line info.
Anton Korobeynikov55b94962008-09-24 22:15:21 +00002993 unsigned ID = SectionMap.insert(Asm->CurrentSection_);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002994 if (SectionSourceLines.size() < ID) SectionSourceLines.resize(ID);
Devang Patel35a078f2009-01-12 22:54:42 +00002995 std::vector<SrcLineInfo> &SectionLineInfos = SectionSourceLines[ID-1];
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002996 // Append the function info to section info.
2997 SectionLineInfos.insert(SectionLineInfos.end(),
Devang Patel35a078f2009-01-12 22:54:42 +00002998 Lines.begin(), Lines.end());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00002999 }
aslc200b112008-08-16 12:57:46 +00003000
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003001 // Construct scopes for subprogram.
Devang Patel6ccd57e2009-01-13 00:20:51 +00003002 if (RootDbgScope)
3003 ConstructRootDbgScope(RootDbgScope);
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00003004 else
3005 // FIXME: This is wrong. We are essentially getting past a problem with
3006 // debug information not being able to handle unreachable blocks that have
3007 // debug information in them. In particular, those unreachable blocks that
3008 // have "region end" info in them. That situation results in the "root
3009 // scope" not being created. If that's the case, then emit a "default"
3010 // scope, i.e., one that encompasses the whole function. This isn't
3011 // desirable. And a better way of handling this (and all of the debugging
3012 // information) needs to be explored.
Devang Patel6ccd57e2009-01-13 00:20:51 +00003013 ConstructDefaultDbgScope(MF);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003014
3015 DebugFrames.push_back(FunctionDebugFrameInfo(SubprogramCount,
3016 MMI->getFrameMoves()));
Devang Patela4162952009-01-12 18:48:36 +00003017
3018 // Clear debug info
3019 if (RootDbgScope) {
3020 delete RootDbgScope;
3021 DbgScopeMap.clear();
3022 RootDbgScope = NULL;
3023 }
3024 Lines.clear();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003025 }
Devang Patelcb59fd42009-01-12 19:17:34 +00003026
3027public:
3028
Devang Patel2da0cc42009-01-15 23:41:32 +00003029 /// ValidDebugInfo - Return true if V represents valid debug info value.
3030 bool ValidDebugInfo(Value *V) {
Devang Patel4d92dded2009-01-16 01:49:46 +00003031
Devang Patel208098b2009-01-19 23:21:49 +00003032 if (!V)
3033 return false;
3034
Devang Patel4d92dded2009-01-16 01:49:46 +00003035 if (!shouldEmit)
3036 return false;
3037
Devang Patel2da0cc42009-01-15 23:41:32 +00003038 GlobalVariable *GV = getGlobalVariable(V);
3039 if (!GV)
3040 return false;
3041
3042 if (GV->getLinkage() != GlobalValue::InternalLinkage
3043 && GV->getLinkage() != GlobalValue::LinkOnceLinkage)
3044 return false;
3045
3046 DIDescriptor DI(GV);
3047 // Check current version. Allow Version6 for now.
3048 unsigned Version = DI.getVersion();
Devang Patelb49710a2009-01-20 19:22:03 +00003049 if (Version != LLVMDebugVersion && Version != LLVMDebugVersion6)
Devang Patel2da0cc42009-01-15 23:41:32 +00003050 return false;
3051
Devang Patel208098b2009-01-19 23:21:49 +00003052 unsigned Tag = DI.getTag();
3053 switch (Tag) {
3054 case DW_TAG_variable:
3055 assert (DIVariable(GV).Verify() && "Invalid DebugInfo value");
3056 break;
3057 case DW_TAG_compile_unit:
3058 assert (DICompileUnit(GV).Verify() && "Invalid DebugInfo value");
3059 break;
3060 case DW_TAG_subprogram:
3061 assert (DISubprogram(GV).Verify() && "Invalid DebugInfo value");
3062 break;
3063 default:
3064 break;
3065 }
3066
Devang Patel2da0cc42009-01-15 23:41:32 +00003067 return true;
3068 }
3069
Devang Patelcb59fd42009-01-12 19:17:34 +00003070 /// RecordSourceLine - Records location information and associates it with a
3071 /// label. Returns a unique label ID used to generate a label and provide
3072 /// correspondence to the source line list.
3073 unsigned RecordSourceLine(Value *V, unsigned Line, unsigned Col) {
3074 CompileUnit *Unit = DW_CUs[V];
3075 assert (Unit && "Unable to find CompileUnit");
3076 unsigned ID = MMI->NextLabelID();
3077 Lines.push_back(SrcLineInfo(Line, Col, Unit->getID(), ID));
3078 return ID;
3079 }
3080
3081 /// RecordSourceLine - Records location information and associates it with a
3082 /// label. Returns a unique label ID used to generate a label and provide
3083 /// correspondence to the source line list.
3084 unsigned RecordSourceLine(unsigned Line, unsigned Col, unsigned Src) {
3085 unsigned ID = MMI->NextLabelID();
3086 Lines.push_back(SrcLineInfo(Line, Col, Src, ID));
3087 return ID;
3088 }
3089
3090 unsigned getRecordSourceLineCount() {
3091 return Lines.size();
3092 }
3093
3094 /// RecordSource - Register a source file with debug info. Returns an source
3095 /// ID.
3096 unsigned RecordSource(const std::string &Directory,
3097 const std::string &File) {
3098 unsigned DID = Directories.insert(Directory);
3099 return SrcFiles.insert(SrcFileInfo(DID,File));
3100 }
3101
3102 /// RecordRegionStart - Indicate the start of a region.
3103 ///
3104 unsigned RecordRegionStart(GlobalVariable *V) {
3105 DbgScope *Scope = getOrCreateScope(V);
3106 unsigned ID = MMI->NextLabelID();
3107 if (!Scope->getStartLabelID()) Scope->setStartLabelID(ID);
3108 return ID;
3109 }
3110
3111 /// RecordRegionEnd - Indicate the end of a region.
3112 ///
3113 unsigned RecordRegionEnd(GlobalVariable *V) {
3114 DbgScope *Scope = getOrCreateScope(V);
3115 unsigned ID = MMI->NextLabelID();
3116 Scope->setEndLabelID(ID);
3117 return ID;
3118 }
3119
3120 /// RecordVariable - Indicate the declaration of a local variable.
3121 ///
3122 void RecordVariable(GlobalVariable *GV, unsigned FrameIndex) {
Devang Patel2560d922009-01-15 18:25:17 +00003123 DIDescriptor Desc(GV);
3124 DbgScope *Scope = NULL;
3125 if (Desc.getTag() == DW_TAG_variable) {
3126 // GV is a global variable.
3127 DIGlobalVariable DG(GV);
3128 Scope = getOrCreateScope(DG.getContext().getGV());
3129 } else {
3130 // or GV is a local variable.
3131 DIVariable DV(GV);
3132 Scope = getOrCreateScope(DV.getContext().getGV());
3133 }
3134 assert (Scope && "Unable to find variable' scope");
Devang Patel7c8a2772009-01-16 19:28:14 +00003135 DbgVariable *DV = new DbgVariable(DIVariable(GV), FrameIndex);
Devang Patelcb59fd42009-01-12 19:17:34 +00003136 Scope->AddVariable(DV);
3137 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003138};
3139
3140//===----------------------------------------------------------------------===//
aslc200b112008-08-16 12:57:46 +00003141/// DwarfException - Emits Dwarf exception handling directives.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003142///
3143class DwarfException : public Dwarf {
3144
3145private:
3146 struct FunctionEHFrameInfo {
3147 std::string FnName;
3148 unsigned Number;
3149 unsigned PersonalityIndex;
3150 bool hasCalls;
3151 bool hasLandingPads;
3152 std::vector<MachineMove> Moves;
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003153 const Function * function;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003154
3155 FunctionEHFrameInfo(const std::string &FN, unsigned Num, unsigned P,
3156 bool hC, bool hL,
Dale Johannesenfb3ac732007-11-20 23:24:42 +00003157 const std::vector<MachineMove> &M,
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003158 const Function *f):
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003159 FnName(FN), Number(Num), PersonalityIndex(P),
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003160 hasCalls(hC), hasLandingPads(hL), Moves(M), function (f) { }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003161 };
3162
3163 std::vector<FunctionEHFrameInfo> EHFrames;
Dale Johannesen85535762008-04-02 00:25:04 +00003164
3165 /// shouldEmitTable - Per-function flag to indicate if EH tables should
3166 /// be emitted.
3167 bool shouldEmitTable;
3168
3169 /// shouldEmitMoves - Per-function flag to indicate if frame moves info
3170 /// should be emitted.
3171 bool shouldEmitMoves;
3172
3173 /// shouldEmitTableModule - Per-module flag to indicate if EH tables
3174 /// should be emitted.
3175 bool shouldEmitTableModule;
3176
aslc200b112008-08-16 12:57:46 +00003177 /// shouldEmitFrameModule - Per-module flag to indicate if frame moves
Dale Johannesen85535762008-04-02 00:25:04 +00003178 /// should be emitted.
3179 bool shouldEmitMovesModule;
Duncan Sands96144f92008-05-07 19:11:09 +00003180
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003181 /// EmitCommonEHFrame - Emit the common eh unwind frame.
3182 ///
3183 void EmitCommonEHFrame(const Function *Personality, unsigned Index) {
3184 // Size and sign of stack growth.
3185 int stackGrowth =
3186 Asm->TM.getFrameInfo()->getStackGrowthDirection() ==
3187 TargetFrameInfo::StackGrowsUp ?
Dan Gohmancfb72b22007-09-27 23:12:31 +00003188 TD->getPointerSize() : -TD->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003189
3190 // Begin eh frame section.
3191 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
Bill Wendling189bde72008-12-24 08:05:17 +00003192
3193 if (!TAI->doesRequireNonLocalEHFrameLabel())
3194 O << TAI->getEHGlobalPrefix();
3195 O << "EH_frame" << Index << ":\n";
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003196 EmitLabel("section_eh_frame", Index);
3197
3198 // Define base labels.
3199 EmitLabel("eh_frame_common", Index);
Duncan Sands96144f92008-05-07 19:11:09 +00003200
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003201 // Define the eh frame length.
3202 EmitDifference("eh_frame_common_end", Index,
3203 "eh_frame_common_begin", Index, true);
3204 Asm->EOL("Length of Common Information Entry");
3205
3206 // EH frame header.
3207 EmitLabel("eh_frame_common_begin", Index);
3208 Asm->EmitInt32((int)0);
3209 Asm->EOL("CIE Identifier Tag");
3210 Asm->EmitInt8(DW_CIE_VERSION);
3211 Asm->EOL("CIE Version");
Duncan Sands96144f92008-05-07 19:11:09 +00003212
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003213 // The personality presence indicates that language specific information
3214 // will show up in the eh frame.
3215 Asm->EmitString(Personality ? "zPLR" : "zR");
3216 Asm->EOL("CIE Augmentation");
Duncan Sands96144f92008-05-07 19:11:09 +00003217
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003218 // Round out reader.
3219 Asm->EmitULEB128Bytes(1);
3220 Asm->EOL("CIE Code Alignment Factor");
3221 Asm->EmitSLEB128Bytes(stackGrowth);
Duncan Sands96144f92008-05-07 19:11:09 +00003222 Asm->EOL("CIE Data Alignment Factor");
Dale Johannesenf5a11532007-11-13 19:13:01 +00003223 Asm->EmitInt8(RI->getDwarfRegNum(RI->getRARegister(), true));
Duncan Sands96144f92008-05-07 19:11:09 +00003224 Asm->EOL("CIE Return Address Column");
3225
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003226 // If there is a personality, we need to indicate the functions location.
3227 if (Personality) {
3228 Asm->EmitULEB128Bytes(7);
3229 Asm->EOL("Augmentation Size");
Bill Wendling2d369922007-09-11 17:20:55 +00003230
Duncan Sands96144f92008-05-07 19:11:09 +00003231 if (TAI->getNeedsIndirectEncoding()) {
Bill Wendling2d369922007-09-11 17:20:55 +00003232 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4 | DW_EH_PE_indirect);
Duncan Sands96144f92008-05-07 19:11:09 +00003233 Asm->EOL("Personality (pcrel sdata4 indirect)");
3234 } else {
Bill Wendling2d369922007-09-11 17:20:55 +00003235 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
Duncan Sands96144f92008-05-07 19:11:09 +00003236 Asm->EOL("Personality (pcrel sdata4)");
3237 }
Bill Wendling2d369922007-09-11 17:20:55 +00003238
Duncan Sands96144f92008-05-07 19:11:09 +00003239 PrintRelDirective(true);
Bill Wendlingd1bda4f2007-09-11 08:27:17 +00003240 O << TAI->getPersonalityPrefix();
3241 Asm->EmitExternalGlobal((const GlobalVariable *)(Personality));
3242 O << TAI->getPersonalitySuffix();
Duncan Sands4cc39532008-05-08 12:33:11 +00003243 if (strcmp(TAI->getPersonalitySuffix(), "+4@GOTPCREL"))
3244 O << "-" << TAI->getPCSymbol();
Bill Wendlingd1bda4f2007-09-11 08:27:17 +00003245 Asm->EOL("Personality");
Bill Wendling38cb7c92007-08-25 00:51:55 +00003246
Duncan Sands96144f92008-05-07 19:11:09 +00003247 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3248 Asm->EOL("LSDA Encoding (pcrel sdata4)");
Bill Wendling6bd1b792008-12-24 05:25:49 +00003249
Bill Wendlingedc2dbe2009-01-05 22:53:45 +00003250 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3251 Asm->EOL("FDE Encoding (pcrel sdata4)");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003252 } else {
3253 Asm->EmitULEB128Bytes(1);
3254 Asm->EOL("Augmentation Size");
Bill Wendling6bd1b792008-12-24 05:25:49 +00003255
Bill Wendlingedc2dbe2009-01-05 22:53:45 +00003256 Asm->EmitInt8(DW_EH_PE_pcrel | DW_EH_PE_sdata4);
3257 Asm->EOL("FDE Encoding (pcrel sdata4)");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003258 }
3259
3260 // Indicate locations of general callee saved registers in frame.
3261 std::vector<MachineMove> Moves;
3262 RI->getInitialFrameState(Moves);
Dale Johannesenf5a11532007-11-13 19:13:01 +00003263 EmitFrameMoves(NULL, 0, Moves, true);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003264
Dale Johannesen388f20f2008-04-30 00:43:29 +00003265 // On Darwin the linker honors the alignment of eh_frame, which means it
3266 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3267 // you get holes which confuse readers of eh_frame.
aslc200b112008-08-16 12:57:46 +00003268 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
Dale Johannesen837d7ab2008-04-29 22:58:20 +00003269 0, 0, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003270 EmitLabel("eh_frame_common_end", Index);
Duncan Sands96144f92008-05-07 19:11:09 +00003271
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003272 Asm->EOL();
3273 }
Duncan Sands96144f92008-05-07 19:11:09 +00003274
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003275 /// EmitEHFrame - Emit function exception frame information.
3276 ///
3277 void EmitEHFrame(const FunctionEHFrameInfo &EHFrameInfo) {
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003278 Function::LinkageTypes linkage = EHFrameInfo.function->getLinkage();
3279
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003280 Asm->SwitchToTextSection(TAI->getDwarfEHFrameSection());
3281
3282 // Externally visible entry into the functions eh frame info.
Dale Johannesenfb3ac732007-11-20 23:24:42 +00003283 // If the corresponding function is static, this should not be
3284 // externally visible.
Rafael Espindolaa168fc92009-01-15 20:18:42 +00003285 if (linkage != Function::InternalLinkage &&
Devang Patel245446c2009-01-17 08:05:14 +00003286 linkage != Function::PrivateLinkage) {
Dale Johannesenfb3ac732007-11-20 23:24:42 +00003287 if (const char *GlobalEHDirective = TAI->getGlobalEHDirective())
3288 O << GlobalEHDirective << EHFrameInfo.FnName << "\n";
3289 }
3290
Dale Johannesenf09b5992008-01-10 02:03:30 +00003291 // If corresponding function is weak definition, this should be too.
aslc200b112008-08-16 12:57:46 +00003292 if ((linkage == Function::WeakLinkage ||
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003293 linkage == Function::LinkOnceLinkage) &&
Dale Johannesenf09b5992008-01-10 02:03:30 +00003294 TAI->getWeakDefDirective())
3295 O << TAI->getWeakDefDirective() << EHFrameInfo.FnName << "\n";
3296
3297 // If there are no calls then you can't unwind. This may mean we can
3298 // omit the EH Frame, but some environments do not handle weak absolute
aslc200b112008-08-16 12:57:46 +00003299 // symbols.
Dale Johannesenb369e8d2008-04-14 17:54:17 +00003300 // If UnwindTablesMandatory is set we cannot do this optimization; the
Dale Johannesena9b3e482008-04-08 00:10:24 +00003301 // unwind info is to be available for non-EH uses.
Dale Johannesenf09b5992008-01-10 02:03:30 +00003302 if (!EHFrameInfo.hasCalls &&
Dale Johannesenb369e8d2008-04-14 17:54:17 +00003303 !UnwindTablesMandatory &&
aslc200b112008-08-16 12:57:46 +00003304 ((linkage != Function::WeakLinkage &&
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003305 linkage != Function::LinkOnceLinkage) ||
Dale Johannesenf09b5992008-01-10 02:03:30 +00003306 !TAI->getWeakDefDirective() ||
3307 TAI->getSupportsWeakOmittedEHFrame()))
aslc200b112008-08-16 12:57:46 +00003308 {
Bill Wendlingef9211a2007-09-18 01:47:22 +00003309 O << EHFrameInfo.FnName << " = 0\n";
aslc200b112008-08-16 12:57:46 +00003310 // This name has no connection to the function, so it might get
3311 // dead-stripped when the function is not, erroneously. Prohibit
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003312 // dead-stripping unconditionally.
3313 if (const char *UsedDirective = TAI->getUsedDirective())
3314 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003315 } else {
Bill Wendlingef9211a2007-09-18 01:47:22 +00003316 O << EHFrameInfo.FnName << ":\n";
Dale Johannesenfb3ac732007-11-20 23:24:42 +00003317
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003318 // EH frame header.
3319 EmitDifference("eh_frame_end", EHFrameInfo.Number,
3320 "eh_frame_begin", EHFrameInfo.Number, true);
3321 Asm->EOL("Length of Frame Information Entry");
aslc200b112008-08-16 12:57:46 +00003322
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003323 EmitLabel("eh_frame_begin", EHFrameInfo.Number);
3324
Bill Wendling189bde72008-12-24 08:05:17 +00003325 if (TAI->doesRequireNonLocalEHFrameLabel()) {
3326 PrintRelDirective(true, true);
3327 PrintLabelName("eh_frame_begin", EHFrameInfo.Number);
3328
3329 if (!TAI->isAbsoluteEHSectionOffsets())
3330 O << "-EH_frame" << EHFrameInfo.PersonalityIndex;
3331 } else {
3332 EmitSectionOffset("eh_frame_begin", "eh_frame_common",
3333 EHFrameInfo.Number, EHFrameInfo.PersonalityIndex,
3334 true, true, false);
3335 }
3336
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003337 Asm->EOL("FDE CIE offset");
3338
Bill Wendlingdd9127d2009-01-06 19:13:55 +00003339 EmitReference("eh_func_begin", EHFrameInfo.Number, true, true);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003340 Asm->EOL("FDE initial location");
3341 EmitDifference("eh_func_end", EHFrameInfo.Number,
Bill Wendlingdd9127d2009-01-06 19:13:55 +00003342 "eh_func_begin", EHFrameInfo.Number, true);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003343 Asm->EOL("FDE address range");
Duncan Sands96144f92008-05-07 19:11:09 +00003344
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003345 // If there is a personality and landing pads then point to the language
3346 // specific data area in the exception table.
3347 if (EHFrameInfo.PersonalityIndex) {
Duncan Sands96144f92008-05-07 19:11:09 +00003348 Asm->EmitULEB128Bytes(4);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003349 Asm->EOL("Augmentation size");
Duncan Sands96144f92008-05-07 19:11:09 +00003350
3351 if (EHFrameInfo.hasLandingPads)
3352 EmitReference("exception", EHFrameInfo.Number, true, true);
3353 else
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003354 Asm->EmitInt32((int)0);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003355 Asm->EOL("Language Specific Data Area");
3356 } else {
3357 Asm->EmitULEB128Bytes(0);
3358 Asm->EOL("Augmentation size");
3359 }
Duncan Sands96144f92008-05-07 19:11:09 +00003360
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003361 // Indicate locations of function specific callee saved registers in
3362 // frame.
Devang Patelb28de842009-01-17 08:01:33 +00003363 EmitFrameMoves("eh_func_begin", EHFrameInfo.Number, EHFrameInfo.Moves,
Devang Patel245446c2009-01-17 08:05:14 +00003364 true);
aslc200b112008-08-16 12:57:46 +00003365
Dale Johannesen388f20f2008-04-30 00:43:29 +00003366 // On Darwin the linker honors the alignment of eh_frame, which means it
3367 // must be 8-byte on 64-bit targets to match what gcc does. Otherwise
3368 // you get holes which confuse readers of eh_frame.
aslc200b112008-08-16 12:57:46 +00003369 Asm->EmitAlignment(TD->getPointerSize() == sizeof(int32_t) ? 2 : 3,
Dale Johannesen837d7ab2008-04-29 22:58:20 +00003370 0, 0, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003371 EmitLabel("eh_frame_end", EHFrameInfo.Number);
aslc200b112008-08-16 12:57:46 +00003372
3373 // If the function is marked used, this table should be also. We cannot
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003374 // make the mark unconditional in this case, since retaining the table
aslc200b112008-08-16 12:57:46 +00003375 // also retains the function in this case, and there is code around
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003376 // that depends on unused functions (calling undefined externals) being
3377 // dead-stripped to link correctly. Yes, there really is.
3378 if (MMI->getUsedFunctions().count(EHFrameInfo.function))
3379 if (const char *UsedDirective = TAI->getUsedDirective())
3380 O << UsedDirective << EHFrameInfo.FnName << "\n\n";
3381 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003382 }
3383
Duncan Sands241a0c92007-09-05 11:27:52 +00003384 /// EmitExceptionTable - Emit landing pads and actions.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003385 ///
3386 /// The general organization of the table is complex, but the basic concepts
3387 /// are easy. First there is a header which describes the location and
3388 /// organization of the three components that follow.
3389 /// 1. The landing pad site information describes the range of code covered
3390 /// by the try. In our case it's an accumulation of the ranges covered
3391 /// by the invokes in the try. There is also a reference to the landing
3392 /// pad that handles the exception once processed. Finally an index into
3393 /// the actions table.
3394 /// 2. The action table, in our case, is composed of pairs of type ids
3395 /// and next action offset. Starting with the action index from the
3396 /// landing pad site, each type Id is checked for a match to the current
3397 /// exception. If it matches then the exception and type id are passed
3398 /// on to the landing pad. Otherwise the next action is looked up. This
3399 /// chain is terminated with a next action of zero. If no type id is
3400 /// found the the frame is unwound and handling continues.
3401 /// 3. Type id table contains references to all the C++ typeinfo for all
3402 /// catches in the function. This tables is reversed indexed base 1.
3403
3404 /// SharedTypeIds - How many leading type ids two landing pads have in common.
3405 static unsigned SharedTypeIds(const LandingPadInfo *L,
3406 const LandingPadInfo *R) {
3407 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3408 unsigned LSize = LIds.size(), RSize = RIds.size();
3409 unsigned MinSize = LSize < RSize ? LSize : RSize;
3410 unsigned Count = 0;
3411
3412 for (; Count != MinSize; ++Count)
3413 if (LIds[Count] != RIds[Count])
3414 return Count;
3415
3416 return Count;
3417 }
3418
3419 /// PadLT - Order landing pads lexicographically by type id.
3420 static bool PadLT(const LandingPadInfo *L, const LandingPadInfo *R) {
3421 const std::vector<int> &LIds = L->TypeIds, &RIds = R->TypeIds;
3422 unsigned LSize = LIds.size(), RSize = RIds.size();
3423 unsigned MinSize = LSize < RSize ? LSize : RSize;
3424
3425 for (unsigned i = 0; i != MinSize; ++i)
3426 if (LIds[i] != RIds[i])
3427 return LIds[i] < RIds[i];
3428
3429 return LSize < RSize;
3430 }
3431
3432 struct KeyInfo {
3433 static inline unsigned getEmptyKey() { return -1U; }
3434 static inline unsigned getTombstoneKey() { return -2U; }
3435 static unsigned getHashValue(const unsigned &Key) { return Key; }
Chris Lattner92eea072007-09-17 18:34:04 +00003436 static bool isEqual(unsigned LHS, unsigned RHS) { return LHS == RHS; }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003437 static bool isPod() { return true; }
3438 };
3439
Duncan Sands241a0c92007-09-05 11:27:52 +00003440 /// ActionEntry - Structure describing an entry in the actions table.
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003441 struct ActionEntry {
3442 int ValueForTypeID; // The value to write - may not be equal to the type id.
3443 int NextAction;
3444 struct ActionEntry *Previous;
3445 };
3446
Duncan Sands241a0c92007-09-05 11:27:52 +00003447 /// PadRange - Structure holding a try-range and the associated landing pad.
3448 struct PadRange {
3449 // The index of the landing pad.
3450 unsigned PadIndex;
3451 // The index of the begin and end labels in the landing pad's label lists.
3452 unsigned RangeIndex;
3453 };
3454
3455 typedef DenseMap<unsigned, PadRange, KeyInfo> RangeMapType;
3456
3457 /// CallSiteEntry - Structure describing an entry in the call-site table.
3458 struct CallSiteEntry {
Duncan Sands4ff179f2007-12-19 07:36:31 +00003459 // The 'try-range' is BeginLabel .. EndLabel.
Duncan Sands241a0c92007-09-05 11:27:52 +00003460 unsigned BeginLabel; // zero indicates the start of the function.
3461 unsigned EndLabel; // zero indicates the end of the function.
Duncan Sands4ff179f2007-12-19 07:36:31 +00003462 // The landing pad starts at PadLabel.
Duncan Sands241a0c92007-09-05 11:27:52 +00003463 unsigned PadLabel; // zero indicates that there is no landing pad.
3464 unsigned Action;
3465 };
3466
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003467 void EmitExceptionTable() {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003468 const std::vector<GlobalVariable *> &TypeInfos = MMI->getTypeInfos();
3469 const std::vector<unsigned> &FilterIds = MMI->getFilterIds();
3470 const std::vector<LandingPadInfo> &PadInfos = MMI->getLandingPads();
3471 if (PadInfos.empty()) return;
3472
3473 // Sort the landing pads in order of their type ids. This is used to fold
3474 // duplicate actions.
3475 SmallVector<const LandingPadInfo *, 64> LandingPads;
3476 LandingPads.reserve(PadInfos.size());
3477 for (unsigned i = 0, N = PadInfos.size(); i != N; ++i)
3478 LandingPads.push_back(&PadInfos[i]);
3479 std::sort(LandingPads.begin(), LandingPads.end(), PadLT);
3480
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003481 // Negative type ids index into FilterIds, positive type ids index into
3482 // TypeInfos. The value written for a positive type id is just the type
3483 // id itself. For a negative type id, however, the value written is the
3484 // (negative) byte offset of the corresponding FilterIds entry. The byte
3485 // offset is usually equal to the type id, because the FilterIds entries
3486 // are written using a variable width encoding which outputs one byte per
3487 // entry as long as the value written is not too large, but can differ.
3488 // This kind of complication does not occur for positive type ids because
3489 // type infos are output using a fixed width encoding.
3490 // FilterOffsets[i] holds the byte offset corresponding to FilterIds[i].
3491 SmallVector<int, 16> FilterOffsets;
3492 FilterOffsets.reserve(FilterIds.size());
3493 int Offset = -1;
3494 for(std::vector<unsigned>::const_iterator I = FilterIds.begin(),
3495 E = FilterIds.end(); I != E; ++I) {
3496 FilterOffsets.push_back(Offset);
aslc200b112008-08-16 12:57:46 +00003497 Offset -= TargetAsmInfo::getULEB128Size(*I);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003498 }
3499
Duncan Sands241a0c92007-09-05 11:27:52 +00003500 // Compute the actions table and gather the first action index for each
3501 // landing pad site.
3502 SmallVector<ActionEntry, 32> Actions;
3503 SmallVector<unsigned, 64> FirstActions;
3504 FirstActions.reserve(LandingPads.size());
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003505
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003506 int FirstAction = 0;
Duncan Sands241a0c92007-09-05 11:27:52 +00003507 unsigned SizeActions = 0;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003508 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3509 const LandingPadInfo *LP = LandingPads[i];
3510 const std::vector<int> &TypeIds = LP->TypeIds;
3511 const unsigned NumShared = i ? SharedTypeIds(LP, LandingPads[i-1]) : 0;
3512 unsigned SizeSiteActions = 0;
3513
3514 if (NumShared < TypeIds.size()) {
3515 unsigned SizeAction = 0;
3516 ActionEntry *PrevAction = 0;
3517
3518 if (NumShared) {
3519 const unsigned SizePrevIds = LandingPads[i-1]->TypeIds.size();
3520 assert(Actions.size());
3521 PrevAction = &Actions.back();
aslc200b112008-08-16 12:57:46 +00003522 SizeAction = TargetAsmInfo::getSLEB128Size(PrevAction->NextAction) +
3523 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003524 for (unsigned j = NumShared; j != SizePrevIds; ++j) {
aslc200b112008-08-16 12:57:46 +00003525 SizeAction -=
3526 TargetAsmInfo::getSLEB128Size(PrevAction->ValueForTypeID);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003527 SizeAction += -PrevAction->NextAction;
3528 PrevAction = PrevAction->Previous;
3529 }
3530 }
3531
3532 // Compute the actions.
3533 for (unsigned I = NumShared, M = TypeIds.size(); I != M; ++I) {
3534 int TypeID = TypeIds[I];
3535 assert(-1-TypeID < (int)FilterOffsets.size() && "Unknown filter id!");
3536 int ValueForTypeID = TypeID < 0 ? FilterOffsets[-1 - TypeID] : TypeID;
aslc200b112008-08-16 12:57:46 +00003537 unsigned SizeTypeID = TargetAsmInfo::getSLEB128Size(ValueForTypeID);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003538
3539 int NextAction = SizeAction ? -(SizeAction + SizeTypeID) : 0;
aslc200b112008-08-16 12:57:46 +00003540 SizeAction = SizeTypeID + TargetAsmInfo::getSLEB128Size(NextAction);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003541 SizeSiteActions += SizeAction;
3542
3543 ActionEntry Action = {ValueForTypeID, NextAction, PrevAction};
3544 Actions.push_back(Action);
3545
3546 PrevAction = &Actions.back();
3547 }
3548
3549 // Record the first action of the landing pad site.
3550 FirstAction = SizeActions + SizeSiteActions - SizeAction + 1;
3551 } // else identical - re-use previous FirstAction
3552
3553 FirstActions.push_back(FirstAction);
3554
3555 // Compute this sites contribution to size.
3556 SizeActions += SizeSiteActions;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003557 }
Duncan Sands241a0c92007-09-05 11:27:52 +00003558
Duncan Sands4ff179f2007-12-19 07:36:31 +00003559 // Compute the call-site table. The entry for an invoke has a try-range
3560 // containing the call, a non-zero landing pad and an appropriate action.
3561 // The entry for an ordinary call has a try-range containing the call and
3562 // zero for the landing pad and the action. Calls marked 'nounwind' have
3563 // no entry and must not be contained in the try-range of any entry - they
3564 // form gaps in the table. Entries must be ordered by try-range address.
Duncan Sands241a0c92007-09-05 11:27:52 +00003565 SmallVector<CallSiteEntry, 64> CallSites;
3566
3567 RangeMapType PadMap;
Duncan Sands4ff179f2007-12-19 07:36:31 +00003568 // Invokes and nounwind calls have entries in PadMap (due to being bracketed
3569 // by try-range labels when lowered). Ordinary calls do not, so appropriate
3570 // try-ranges for them need be deduced.
Duncan Sands241a0c92007-09-05 11:27:52 +00003571 for (unsigned i = 0, N = LandingPads.size(); i != N; ++i) {
3572 const LandingPadInfo *LandingPad = LandingPads[i];
Duncan Sands4ff179f2007-12-19 07:36:31 +00003573 for (unsigned j = 0, E = LandingPad->BeginLabels.size(); j != E; ++j) {
Duncan Sands241a0c92007-09-05 11:27:52 +00003574 unsigned BeginLabel = LandingPad->BeginLabels[j];
3575 assert(!PadMap.count(BeginLabel) && "Duplicate landing pad labels!");
3576 PadRange P = { i, j };
3577 PadMap[BeginLabel] = P;
3578 }
3579 }
3580
Duncan Sands4ff179f2007-12-19 07:36:31 +00003581 // The end label of the previous invoke or nounwind try-range.
Duncan Sands241a0c92007-09-05 11:27:52 +00003582 unsigned LastLabel = 0;
Duncan Sands4ff179f2007-12-19 07:36:31 +00003583
3584 // Whether there is a potentially throwing instruction (currently this means
3585 // an ordinary call) between the end of the previous try-range and now.
3586 bool SawPotentiallyThrowing = false;
3587
3588 // Whether the last callsite entry was for an invoke.
3589 bool PreviousIsInvoke = false;
3590
Duncan Sands4ff179f2007-12-19 07:36:31 +00003591 // Visit all instructions in order of address.
Duncan Sands241a0c92007-09-05 11:27:52 +00003592 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
3593 I != E; ++I) {
3594 for (MachineBasicBlock::const_iterator MI = I->begin(), E = I->end();
3595 MI != E; ++MI) {
Dan Gohmanfa607c92008-07-01 00:05:16 +00003596 if (!MI->isLabel()) {
Chris Lattner5b930372008-01-07 07:27:27 +00003597 SawPotentiallyThrowing |= MI->getDesc().isCall();
Duncan Sands241a0c92007-09-05 11:27:52 +00003598 continue;
3599 }
3600
Chris Lattnerda4cff12007-12-30 20:50:28 +00003601 unsigned BeginLabel = MI->getOperand(0).getImm();
Duncan Sands241a0c92007-09-05 11:27:52 +00003602 assert(BeginLabel && "Invalid label!");
Duncan Sands89372f62007-09-05 14:12:46 +00003603
Duncan Sands4ff179f2007-12-19 07:36:31 +00003604 // End of the previous try-range?
Duncan Sands89372f62007-09-05 14:12:46 +00003605 if (BeginLabel == LastLabel)
Duncan Sands4ff179f2007-12-19 07:36:31 +00003606 SawPotentiallyThrowing = false;
Duncan Sands241a0c92007-09-05 11:27:52 +00003607
Duncan Sands4ff179f2007-12-19 07:36:31 +00003608 // Beginning of a new try-range?
Duncan Sands241a0c92007-09-05 11:27:52 +00003609 RangeMapType::iterator L = PadMap.find(BeginLabel);
Duncan Sands241a0c92007-09-05 11:27:52 +00003610 if (L == PadMap.end())
Duncan Sands4ff179f2007-12-19 07:36:31 +00003611 // Nope, it was just some random label.
Duncan Sands241a0c92007-09-05 11:27:52 +00003612 continue;
3613
3614 PadRange P = L->second;
3615 const LandingPadInfo *LandingPad = LandingPads[P.PadIndex];
3616
3617 assert(BeginLabel == LandingPad->BeginLabels[P.RangeIndex] &&
3618 "Inconsistent landing pad map!");
3619
3620 // If some instruction between the previous try-range and this one may
3621 // throw, create a call-site entry with no landing pad for the region
3622 // between the try-ranges.
Duncan Sands4ff179f2007-12-19 07:36:31 +00003623 if (SawPotentiallyThrowing) {
Duncan Sands241a0c92007-09-05 11:27:52 +00003624 CallSiteEntry Site = {LastLabel, BeginLabel, 0, 0};
3625 CallSites.push_back(Site);
Duncan Sands4ff179f2007-12-19 07:36:31 +00003626 PreviousIsInvoke = false;
Duncan Sands241a0c92007-09-05 11:27:52 +00003627 }
3628
3629 LastLabel = LandingPad->EndLabels[P.RangeIndex];
Duncan Sands4ff179f2007-12-19 07:36:31 +00003630 assert(BeginLabel && LastLabel && "Invalid landing pad!");
Duncan Sands241a0c92007-09-05 11:27:52 +00003631
Duncan Sands4ff179f2007-12-19 07:36:31 +00003632 if (LandingPad->LandingPadLabel) {
3633 // This try-range is for an invoke.
3634 CallSiteEntry Site = {BeginLabel, LastLabel,
3635 LandingPad->LandingPadLabel, FirstActions[P.PadIndex]};
Duncan Sands241a0c92007-09-05 11:27:52 +00003636
Duncan Sands4ff179f2007-12-19 07:36:31 +00003637 // Try to merge with the previous call-site.
3638 if (PreviousIsInvoke) {
Dan Gohman3d436002008-06-21 22:00:54 +00003639 CallSiteEntry &Prev = CallSites.back();
Duncan Sands4ff179f2007-12-19 07:36:31 +00003640 if (Site.PadLabel == Prev.PadLabel && Site.Action == Prev.Action) {
3641 // Extend the range of the previous entry.
3642 Prev.EndLabel = Site.EndLabel;
3643 continue;
3644 }
Duncan Sands241a0c92007-09-05 11:27:52 +00003645 }
Duncan Sands241a0c92007-09-05 11:27:52 +00003646
Duncan Sands4ff179f2007-12-19 07:36:31 +00003647 // Otherwise, create a new call-site.
3648 CallSites.push_back(Site);
3649 PreviousIsInvoke = true;
3650 } else {
3651 // Create a gap.
3652 PreviousIsInvoke = false;
3653 }
Duncan Sands241a0c92007-09-05 11:27:52 +00003654 }
3655 }
3656 // If some instruction between the previous try-range and the end of the
3657 // function may throw, create a call-site entry with no landing pad for the
3658 // region following the try-range.
Duncan Sands4ff179f2007-12-19 07:36:31 +00003659 if (SawPotentiallyThrowing) {
Duncan Sands241a0c92007-09-05 11:27:52 +00003660 CallSiteEntry Site = {LastLabel, 0, 0, 0};
3661 CallSites.push_back(Site);
3662 }
3663
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003664 // Final tallies.
Duncan Sands96144f92008-05-07 19:11:09 +00003665
3666 // Call sites.
3667 const unsigned SiteStartSize = sizeof(int32_t); // DW_EH_PE_udata4
3668 const unsigned SiteLengthSize = sizeof(int32_t); // DW_EH_PE_udata4
3669 const unsigned LandingPadSize = sizeof(int32_t); // DW_EH_PE_udata4
3670 unsigned SizeSites = CallSites.size() * (SiteStartSize +
3671 SiteLengthSize +
3672 LandingPadSize);
Duncan Sands241a0c92007-09-05 11:27:52 +00003673 for (unsigned i = 0, e = CallSites.size(); i < e; ++i)
aslc200b112008-08-16 12:57:46 +00003674 SizeSites += TargetAsmInfo::getULEB128Size(CallSites[i].Action);
Duncan Sands241a0c92007-09-05 11:27:52 +00003675
Duncan Sands96144f92008-05-07 19:11:09 +00003676 // Type infos.
3677 const unsigned TypeInfoSize = TD->getPointerSize(); // DW_EH_PE_absptr
3678 unsigned SizeTypes = TypeInfos.size() * TypeInfoSize;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003679
3680 unsigned TypeOffset = sizeof(int8_t) + // Call site format
aslc200b112008-08-16 12:57:46 +00003681 TargetAsmInfo::getULEB128Size(SizeSites) + // Call-site table length
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003682 SizeSites + SizeActions + SizeTypes;
3683
3684 unsigned TotalSize = sizeof(int8_t) + // LPStart format
3685 sizeof(int8_t) + // TType format
aslc200b112008-08-16 12:57:46 +00003686 TargetAsmInfo::getULEB128Size(TypeOffset) + // TType base offset
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003687 TypeOffset;
3688
3689 unsigned SizeAlign = (4 - TotalSize) & 3;
3690
3691 // Begin the exception table.
3692 Asm->SwitchToDataSection(TAI->getDwarfExceptionSection());
Evan Cheng7e7d1942008-02-29 19:36:59 +00003693 Asm->EmitAlignment(2, 0, 0, false);
Dale Johannesen841e4982008-10-08 21:50:21 +00003694 O << "GCC_except_table" << SubprogramCount << ":\n";
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003695 for (unsigned i = 0; i != SizeAlign; ++i) {
3696 Asm->EmitInt8(0);
3697 Asm->EOL("Padding");
3698 }
3699 EmitLabel("exception", SubprogramCount);
3700
3701 // Emit the header.
3702 Asm->EmitInt8(DW_EH_PE_omit);
3703 Asm->EOL("LPStart format (DW_EH_PE_omit)");
3704 Asm->EmitInt8(DW_EH_PE_absptr);
3705 Asm->EOL("TType format (DW_EH_PE_absptr)");
3706 Asm->EmitULEB128Bytes(TypeOffset);
3707 Asm->EOL("TType base offset");
3708 Asm->EmitInt8(DW_EH_PE_udata4);
3709 Asm->EOL("Call site format (DW_EH_PE_udata4)");
3710 Asm->EmitULEB128Bytes(SizeSites);
3711 Asm->EOL("Call-site table length");
3712
Duncan Sands241a0c92007-09-05 11:27:52 +00003713 // Emit the landing pad site information.
3714 for (unsigned i = 0; i < CallSites.size(); ++i) {
3715 CallSiteEntry &S = CallSites[i];
3716 const char *BeginTag;
3717 unsigned BeginNumber;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003718
Duncan Sands241a0c92007-09-05 11:27:52 +00003719 if (!S.BeginLabel) {
3720 BeginTag = "eh_func_begin";
3721 BeginNumber = SubprogramCount;
3722 } else {
3723 BeginTag = "label";
3724 BeginNumber = S.BeginLabel;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003725 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003726
Duncan Sands241a0c92007-09-05 11:27:52 +00003727 EmitSectionOffset(BeginTag, "eh_func_begin", BeginNumber, SubprogramCount,
Duncan Sands96144f92008-05-07 19:11:09 +00003728 true, true);
Duncan Sands241a0c92007-09-05 11:27:52 +00003729 Asm->EOL("Region start");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003730
Duncan Sands241a0c92007-09-05 11:27:52 +00003731 if (!S.EndLabel) {
Dale Johannesen4670be42008-01-15 23:24:56 +00003732 EmitDifference("eh_func_end", SubprogramCount, BeginTag, BeginNumber,
Duncan Sands96144f92008-05-07 19:11:09 +00003733 true);
Duncan Sands241a0c92007-09-05 11:27:52 +00003734 } else {
Duncan Sands96144f92008-05-07 19:11:09 +00003735 EmitDifference("label", S.EndLabel, BeginTag, BeginNumber, true);
Duncan Sands241a0c92007-09-05 11:27:52 +00003736 }
3737 Asm->EOL("Region length");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003738
Duncan Sands96144f92008-05-07 19:11:09 +00003739 if (!S.PadLabel)
3740 Asm->EmitInt32(0);
3741 else
Duncan Sands241a0c92007-09-05 11:27:52 +00003742 EmitSectionOffset("label", "eh_func_begin", S.PadLabel, SubprogramCount,
Duncan Sands96144f92008-05-07 19:11:09 +00003743 true, true);
Duncan Sands241a0c92007-09-05 11:27:52 +00003744 Asm->EOL("Landing pad");
3745
3746 Asm->EmitULEB128Bytes(S.Action);
3747 Asm->EOL("Action");
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003748 }
3749
3750 // Emit the actions.
3751 for (unsigned I = 0, N = Actions.size(); I != N; ++I) {
3752 ActionEntry &Action = Actions[I];
3753
3754 Asm->EmitSLEB128Bytes(Action.ValueForTypeID);
3755 Asm->EOL("TypeInfo index");
3756 Asm->EmitSLEB128Bytes(Action.NextAction);
3757 Asm->EOL("Next action");
3758 }
3759
3760 // Emit the type ids.
3761 for (unsigned M = TypeInfos.size(); M; --M) {
3762 GlobalVariable *GV = TypeInfos[M - 1];
Anton Korobeynikov5ef86702007-09-02 22:07:21 +00003763
3764 PrintRelDirective();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003765
3766 if (GV)
3767 O << Asm->getGlobalLinkName(GV);
3768 else
3769 O << "0";
Duncan Sands241a0c92007-09-05 11:27:52 +00003770
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003771 Asm->EOL("TypeInfo");
3772 }
3773
3774 // Emit the filter typeids.
3775 for (unsigned j = 0, M = FilterIds.size(); j < M; ++j) {
3776 unsigned TypeID = FilterIds[j];
3777 Asm->EmitULEB128Bytes(TypeID);
3778 Asm->EOL("Filter TypeInfo index");
3779 }
Duncan Sands241a0c92007-09-05 11:27:52 +00003780
Evan Cheng7e7d1942008-02-29 19:36:59 +00003781 Asm->EmitAlignment(2, 0, 0, false);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003782 }
3783
3784public:
3785 //===--------------------------------------------------------------------===//
3786 // Main entry points.
3787 //
Owen Anderson847b99b2008-08-21 00:14:44 +00003788 DwarfException(raw_ostream &OS, AsmPrinter *A, const TargetAsmInfo *T)
Chris Lattnerb3876c72007-09-24 03:35:37 +00003789 : Dwarf(OS, A, T, "eh")
Dale Johannesen85535762008-04-02 00:25:04 +00003790 , shouldEmitTable(false)
3791 , shouldEmitMoves(false)
3792 , shouldEmitTableModule(false)
3793 , shouldEmitMovesModule(false)
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003794 {}
aslc200b112008-08-16 12:57:46 +00003795
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003796 virtual ~DwarfException() {}
3797
3798 /// SetModuleInfo - Set machine module information when it's known that pass
3799 /// manager has created it. Set by the target AsmPrinter.
3800 void SetModuleInfo(MachineModuleInfo *mmi) {
3801 MMI = mmi;
3802 }
3803
3804 /// BeginModule - Emit all exception information that should come prior to the
3805 /// content.
3806 void BeginModule(Module *M) {
3807 this->M = M;
3808 }
3809
3810 /// EndModule - Emit all exception information that should come after the
3811 /// content.
3812 void EndModule() {
Dale Johannesen85535762008-04-02 00:25:04 +00003813 if (shouldEmitMovesModule || shouldEmitTableModule) {
3814 const std::vector<Function *> Personalities = MMI->getPersonalities();
3815 for (unsigned i =0; i < Personalities.size(); ++i)
3816 EmitCommonEHFrame(Personalities[i], i);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003817
Dale Johannesen85535762008-04-02 00:25:04 +00003818 for (std::vector<FunctionEHFrameInfo>::iterator I = EHFrames.begin(),
3819 E = EHFrames.end(); I != E; ++I)
3820 EmitEHFrame(*I);
3821 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003822 }
3823
aslc200b112008-08-16 12:57:46 +00003824 /// BeginFunction - Gather pre-function exception information. Assumes being
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003825 /// emitted immediately after the function entry point.
3826 void BeginFunction(MachineFunction *MF) {
3827 this->MF = MF;
Dale Johannesen85535762008-04-02 00:25:04 +00003828 shouldEmitTable = shouldEmitMoves = false;
Dale Johannesen62f0a6d2008-04-02 17:04:45 +00003829 if (MMI && TAI->doesSupportExceptionHandling()) {
Dale Johannesen85535762008-04-02 00:25:04 +00003830
3831 // Map all labels and get rid of any dead landing pads.
3832 MMI->TidyLandingPads();
3833 // If any landing pads survive, we need an EH table.
3834 if (MMI->getLandingPads().size())
3835 shouldEmitTable = true;
3836
3837 // See if we need frame move info.
Duncan Sandscbc28b12008-07-04 09:55:48 +00003838 if (!MF->getFunction()->doesNotThrow() || UnwindTablesMandatory)
Dale Johannesen85535762008-04-02 00:25:04 +00003839 shouldEmitMoves = true;
3840
3841 if (shouldEmitMoves || shouldEmitTable)
3842 // Assumes in correct section after the entry point.
3843 EmitLabel("eh_func_begin", ++SubprogramCount);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003844 }
Dale Johannesen85535762008-04-02 00:25:04 +00003845 shouldEmitTableModule |= shouldEmitTable;
3846 shouldEmitMovesModule |= shouldEmitMoves;
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003847 }
3848
3849 /// EndFunction - Gather and emit post-function exception information.
3850 ///
3851 void EndFunction() {
Dale Johannesen85535762008-04-02 00:25:04 +00003852 if (shouldEmitMoves || shouldEmitTable) {
3853 EmitLabel("eh_func_end", SubprogramCount);
3854 EmitExceptionTable();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003855
Dale Johannesen85535762008-04-02 00:25:04 +00003856 // Save EH frame information
3857 EHFrames.
3858 push_back(FunctionEHFrameInfo(getAsm()->getCurrentFunctionEHName(MF),
Bill Wendlingef9211a2007-09-18 01:47:22 +00003859 SubprogramCount,
3860 MMI->getPersonalityIndex(),
3861 MF->getFrameInfo()->hasCalls(),
3862 !MMI->getLandingPads().empty(),
Dale Johannesenfb3ac732007-11-20 23:24:42 +00003863 MMI->getFrameMoves(),
Dale Johannesen3dadeb32008-01-16 19:59:28 +00003864 MF->getFunction()));
Dale Johannesen85535762008-04-02 00:25:04 +00003865 }
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003866 }
3867};
3868
3869} // End of namespace llvm
3870
3871//===----------------------------------------------------------------------===//
3872
3873/// Emit - Print the abbreviation using the specified Dwarf writer.
3874///
3875void DIEAbbrev::Emit(const DwarfDebug &DD) const {
3876 // Emit its Dwarf tag type.
3877 DD.getAsm()->EmitULEB128Bytes(Tag);
3878 DD.getAsm()->EOL(TagString(Tag));
aslc200b112008-08-16 12:57:46 +00003879
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003880 // Emit whether it has children DIEs.
3881 DD.getAsm()->EmitULEB128Bytes(ChildrenFlag);
3882 DD.getAsm()->EOL(ChildrenString(ChildrenFlag));
aslc200b112008-08-16 12:57:46 +00003883
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003884 // For each attribute description.
3885 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3886 const DIEAbbrevData &AttrData = Data[i];
aslc200b112008-08-16 12:57:46 +00003887
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003888 // Emit attribute type.
3889 DD.getAsm()->EmitULEB128Bytes(AttrData.getAttribute());
3890 DD.getAsm()->EOL(AttributeString(AttrData.getAttribute()));
aslc200b112008-08-16 12:57:46 +00003891
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003892 // Emit form type.
3893 DD.getAsm()->EmitULEB128Bytes(AttrData.getForm());
3894 DD.getAsm()->EOL(FormEncodingString(AttrData.getForm()));
3895 }
3896
3897 // Mark end of abbreviation.
3898 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(1)");
3899 DD.getAsm()->EmitULEB128Bytes(0); DD.getAsm()->EOL("EOM(2)");
3900}
3901
3902#ifndef NDEBUG
3903void DIEAbbrev::print(std::ostream &O) {
3904 O << "Abbreviation @"
3905 << std::hex << (intptr_t)this << std::dec
3906 << " "
3907 << TagString(Tag)
3908 << " "
3909 << ChildrenString(ChildrenFlag)
3910 << "\n";
aslc200b112008-08-16 12:57:46 +00003911
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003912 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
3913 O << " "
3914 << AttributeString(Data[i].getAttribute())
3915 << " "
3916 << FormEncodingString(Data[i].getForm())
3917 << "\n";
3918 }
3919}
3920void DIEAbbrev::dump() { print(cerr); }
3921#endif
3922
3923//===----------------------------------------------------------------------===//
3924
3925#ifndef NDEBUG
3926void DIEValue::dump() {
3927 print(cerr);
3928}
3929#endif
3930
3931//===----------------------------------------------------------------------===//
3932
3933/// EmitValue - Emit integer of appropriate size.
3934///
3935void DIEInteger::EmitValue(DwarfDebug &DD, unsigned Form) {
3936 switch (Form) {
3937 case DW_FORM_flag: // Fall thru
3938 case DW_FORM_ref1: // Fall thru
3939 case DW_FORM_data1: DD.getAsm()->EmitInt8(Integer); break;
3940 case DW_FORM_ref2: // Fall thru
3941 case DW_FORM_data2: DD.getAsm()->EmitInt16(Integer); break;
3942 case DW_FORM_ref4: // Fall thru
3943 case DW_FORM_data4: DD.getAsm()->EmitInt32(Integer); break;
3944 case DW_FORM_ref8: // Fall thru
3945 case DW_FORM_data8: DD.getAsm()->EmitInt64(Integer); break;
3946 case DW_FORM_udata: DD.getAsm()->EmitULEB128Bytes(Integer); break;
3947 case DW_FORM_sdata: DD.getAsm()->EmitSLEB128Bytes(Integer); break;
3948 default: assert(0 && "DIE Value form not supported yet"); break;
3949 }
3950}
3951
3952/// SizeOf - Determine size of integer value in bytes.
3953///
3954unsigned DIEInteger::SizeOf(const DwarfDebug &DD, unsigned Form) const {
3955 switch (Form) {
3956 case DW_FORM_flag: // Fall thru
3957 case DW_FORM_ref1: // Fall thru
3958 case DW_FORM_data1: return sizeof(int8_t);
3959 case DW_FORM_ref2: // Fall thru
3960 case DW_FORM_data2: return sizeof(int16_t);
3961 case DW_FORM_ref4: // Fall thru
3962 case DW_FORM_data4: return sizeof(int32_t);
3963 case DW_FORM_ref8: // Fall thru
3964 case DW_FORM_data8: return sizeof(int64_t);
aslc200b112008-08-16 12:57:46 +00003965 case DW_FORM_udata: return TargetAsmInfo::getULEB128Size(Integer);
3966 case DW_FORM_sdata: return TargetAsmInfo::getSLEB128Size(Integer);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003967 default: assert(0 && "DIE Value form not supported yet"); break;
3968 }
3969 return 0;
3970}
3971
3972//===----------------------------------------------------------------------===//
3973
3974/// EmitValue - Emit string value.
3975///
3976void DIEString::EmitValue(DwarfDebug &DD, unsigned Form) {
3977 DD.getAsm()->EmitString(String);
3978}
3979
3980//===----------------------------------------------------------------------===//
3981
3982/// EmitValue - Emit label value.
3983///
3984void DIEDwarfLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
Dan Gohman597b4842007-09-28 16:50:28 +00003985 bool IsSmall = Form == DW_FORM_data4;
3986 DD.EmitReference(Label, false, IsSmall);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003987}
3988
3989/// SizeOf - Determine size of label value in bytes.
3990///
3991unsigned DIEDwarfLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Dan Gohman597b4842007-09-28 16:50:28 +00003992 if (Form == DW_FORM_data4) return 4;
Dan Gohmancfb72b22007-09-27 23:12:31 +00003993 return DD.getTargetData()->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00003994}
3995
3996//===----------------------------------------------------------------------===//
3997
3998/// EmitValue - Emit label value.
3999///
4000void DIEObjectLabel::EmitValue(DwarfDebug &DD, unsigned Form) {
Dan Gohman597b4842007-09-28 16:50:28 +00004001 bool IsSmall = Form == DW_FORM_data4;
4002 DD.EmitReference(Label, false, IsSmall);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004003}
4004
4005/// SizeOf - Determine size of label value in bytes.
4006///
4007unsigned DIEObjectLabel::SizeOf(const DwarfDebug &DD, unsigned Form) const {
Dan Gohman597b4842007-09-28 16:50:28 +00004008 if (Form == DW_FORM_data4) return 4;
Dan Gohmancfb72b22007-09-27 23:12:31 +00004009 return DD.getTargetData()->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004010}
aslc200b112008-08-16 12:57:46 +00004011
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004012//===----------------------------------------------------------------------===//
4013
4014/// EmitValue - Emit delta value.
4015///
Argiris Kirtzidis03449652008-06-18 19:27:37 +00004016void DIESectionOffset::EmitValue(DwarfDebug &DD, unsigned Form) {
4017 bool IsSmall = Form == DW_FORM_data4;
4018 DD.EmitSectionOffset(Label.Tag, Section.Tag,
4019 Label.Number, Section.Number, IsSmall, IsEH, UseSet);
4020}
4021
4022/// SizeOf - Determine size of delta value in bytes.
4023///
4024unsigned DIESectionOffset::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4025 if (Form == DW_FORM_data4) return 4;
4026 return DD.getTargetData()->getPointerSize();
4027}
aslc200b112008-08-16 12:57:46 +00004028
Argiris Kirtzidis03449652008-06-18 19:27:37 +00004029//===----------------------------------------------------------------------===//
4030
4031/// EmitValue - Emit delta value.
4032///
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004033void DIEDelta::EmitValue(DwarfDebug &DD, unsigned Form) {
4034 bool IsSmall = Form == DW_FORM_data4;
4035 DD.EmitDifference(LabelHi, LabelLo, IsSmall);
4036}
4037
4038/// SizeOf - Determine size of delta value in bytes.
4039///
4040unsigned DIEDelta::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4041 if (Form == DW_FORM_data4) return 4;
Dan Gohmancfb72b22007-09-27 23:12:31 +00004042 return DD.getTargetData()->getPointerSize();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004043}
4044
4045//===----------------------------------------------------------------------===//
4046
4047/// EmitValue - Emit debug information entry offset.
4048///
4049void DIEntry::EmitValue(DwarfDebug &DD, unsigned Form) {
4050 DD.getAsm()->EmitInt32(Entry->getOffset());
4051}
aslc200b112008-08-16 12:57:46 +00004052
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004053//===----------------------------------------------------------------------===//
4054
4055/// ComputeSize - calculate the size of the block.
4056///
4057unsigned DIEBlock::ComputeSize(DwarfDebug &DD) {
4058 if (!Size) {
Owen Anderson88dd6232008-06-24 21:44:59 +00004059 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
aslc200b112008-08-16 12:57:46 +00004060
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004061 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4062 Size += Values[i]->SizeOf(DD, AbbrevData[i].getForm());
4063 }
4064 }
4065 return Size;
4066}
4067
4068/// EmitValue - Emit block data.
4069///
4070void DIEBlock::EmitValue(DwarfDebug &DD, unsigned Form) {
4071 switch (Form) {
4072 case DW_FORM_block1: DD.getAsm()->EmitInt8(Size); break;
4073 case DW_FORM_block2: DD.getAsm()->EmitInt16(Size); break;
4074 case DW_FORM_block4: DD.getAsm()->EmitInt32(Size); break;
4075 case DW_FORM_block: DD.getAsm()->EmitULEB128Bytes(Size); break;
4076 default: assert(0 && "Improper form for block"); break;
4077 }
aslc200b112008-08-16 12:57:46 +00004078
Owen Anderson88dd6232008-06-24 21:44:59 +00004079 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004080
4081 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
4082 DD.getAsm()->EOL();
4083 Values[i]->EmitValue(DD, AbbrevData[i].getForm());
4084 }
4085}
4086
4087/// SizeOf - Determine size of block data in bytes.
4088///
4089unsigned DIEBlock::SizeOf(const DwarfDebug &DD, unsigned Form) const {
4090 switch (Form) {
4091 case DW_FORM_block1: return Size + sizeof(int8_t);
4092 case DW_FORM_block2: return Size + sizeof(int16_t);
4093 case DW_FORM_block4: return Size + sizeof(int32_t);
aslc200b112008-08-16 12:57:46 +00004094 case DW_FORM_block: return Size + TargetAsmInfo::getULEB128Size(Size);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004095 default: assert(0 && "Improper form for block"); break;
4096 }
4097 return 0;
4098}
4099
4100//===----------------------------------------------------------------------===//
4101/// DIE Implementation
4102
4103DIE::~DIE() {
4104 for (unsigned i = 0, N = Children.size(); i < N; ++i)
4105 delete Children[i];
4106}
aslc200b112008-08-16 12:57:46 +00004107
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004108/// AddSiblingOffset - Add a sibling offset field to the front of the DIE.
4109///
4110void DIE::AddSiblingOffset() {
4111 DIEInteger *DI = new DIEInteger(0);
4112 Values.insert(Values.begin(), DI);
4113 Abbrev.AddFirstAttribute(DW_AT_sibling, DW_FORM_ref4);
4114}
4115
4116/// Profile - Used to gather unique data for the value folding set.
4117///
4118void DIE::Profile(FoldingSetNodeID &ID) {
4119 Abbrev.Profile(ID);
aslc200b112008-08-16 12:57:46 +00004120
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004121 for (unsigned i = 0, N = Children.size(); i < N; ++i)
4122 ID.AddPointer(Children[i]);
4123
4124 for (unsigned j = 0, M = Values.size(); j < M; ++j)
4125 ID.AddPointer(Values[j]);
4126}
4127
4128#ifndef NDEBUG
4129void DIE::print(std::ostream &O, unsigned IncIndent) {
4130 static unsigned IndentCount = 0;
4131 IndentCount += IncIndent;
4132 const std::string Indent(IndentCount, ' ');
4133 bool isBlock = Abbrev.getTag() == 0;
aslc200b112008-08-16 12:57:46 +00004134
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004135 if (!isBlock) {
4136 O << Indent
4137 << "Die: "
4138 << "0x" << std::hex << (intptr_t)this << std::dec
4139 << ", Offset: " << Offset
4140 << ", Size: " << Size
aslc200b112008-08-16 12:57:46 +00004141 << "\n";
4142
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004143 O << Indent
4144 << TagString(Abbrev.getTag())
4145 << " "
4146 << ChildrenString(Abbrev.getChildrenFlag());
4147 } else {
4148 O << "Size: " << Size;
4149 }
4150 O << "\n";
4151
Owen Anderson88dd6232008-06-24 21:44:59 +00004152 const SmallVector<DIEAbbrevData, 8> &Data = Abbrev.getData();
aslc200b112008-08-16 12:57:46 +00004153
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004154 IndentCount += 2;
4155 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
4156 O << Indent;
Bill Wendlingdc7b5a52008-07-22 00:28:47 +00004157
4158 if (!isBlock)
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004159 O << AttributeString(Data[i].getAttribute());
Bill Wendlingdc7b5a52008-07-22 00:28:47 +00004160 else
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004161 O << "Blk[" << i << "]";
Bill Wendlingdc7b5a52008-07-22 00:28:47 +00004162
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004163 O << " "
4164 << FormEncodingString(Data[i].getForm())
4165 << " ";
4166 Values[i]->print(O);
4167 O << "\n";
4168 }
4169 IndentCount -= 2;
4170
4171 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
4172 Children[j]->print(O, 4);
4173 }
aslc200b112008-08-16 12:57:46 +00004174
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004175 if (!isBlock) O << "\n";
4176 IndentCount -= IncIndent;
4177}
4178
4179void DIE::dump() {
4180 print(cerr);
4181}
4182#endif
4183
4184//===----------------------------------------------------------------------===//
4185/// DwarfWriter Implementation
4186///
4187
Devang Patelaa1e8432009-01-08 23:40:34 +00004188DwarfWriter::DwarfWriter() : ImmutablePass(&ID), DD(NULL), DE(NULL) {
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004189}
4190
4191DwarfWriter::~DwarfWriter() {
4192 delete DE;
4193 delete DD;
4194}
4195
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004196/// BeginModule - Emit all Dwarf sections that should come prior to the
4197/// content.
Devang Patelaa1e8432009-01-08 23:40:34 +00004198void DwarfWriter::BeginModule(Module *M,
4199 MachineModuleInfo *MMI,
4200 raw_ostream &OS, AsmPrinter *A,
4201 const TargetAsmInfo *T) {
4202 DE = new DwarfException(OS, A, T);
4203 DD = new DwarfDebug(OS, A, T);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004204 DE->BeginModule(M);
4205 DD->BeginModule(M);
Devang Patel6ccd57e2009-01-13 00:20:51 +00004206 DD->SetDebugInfo(MMI);
Devang Patelaa1e8432009-01-08 23:40:34 +00004207 DE->SetModuleInfo(MMI);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004208}
4209
4210/// EndModule - Emit all Dwarf sections that should come after the content.
4211///
4212void DwarfWriter::EndModule() {
4213 DE->EndModule();
4214 DD->EndModule();
4215}
4216
aslc200b112008-08-16 12:57:46 +00004217/// BeginFunction - Gather pre-function debug information. Assumes being
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004218/// emitted immediately after the function entry point.
4219void DwarfWriter::BeginFunction(MachineFunction *MF) {
4220 DE->BeginFunction(MF);
4221 DD->BeginFunction(MF);
4222}
4223
4224/// EndFunction - Gather and emit post-function debug information.
4225///
Bill Wendlingb22ae7d2008-09-26 00:28:12 +00004226void DwarfWriter::EndFunction(MachineFunction *MF) {
4227 DD->EndFunction(MF);
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004228 DE->EndFunction();
aslc200b112008-08-16 12:57:46 +00004229
Bill Wendling5b4796a2008-07-22 00:53:37 +00004230 if (MachineModuleInfo *MMI = DD->getMMI() ? DD->getMMI() : DE->getMMI())
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004231 // Clear function debug information.
4232 MMI->EndFunction();
Dan Gohmanf17a25c2007-07-18 16:29:46 +00004233}
Devang Patelcb59fd42009-01-12 19:17:34 +00004234
Devang Patel2da0cc42009-01-15 23:41:32 +00004235/// ValidDebugInfo - Return true if V represents valid debug info value.
4236bool DwarfWriter::ValidDebugInfo(Value *V) {
Devang Patel943af622009-01-16 02:15:14 +00004237 return DD && DD->ValidDebugInfo(V);
Devang Patel2da0cc42009-01-15 23:41:32 +00004238}
4239
Devang Patelcb59fd42009-01-12 19:17:34 +00004240/// RecordSourceLine - Records location information and associates it with a
4241/// label. Returns a unique label ID used to generate a label and provide
4242/// correspondence to the source line list.
4243unsigned DwarfWriter::RecordSourceLine(unsigned Line, unsigned Col,
4244 unsigned Src) {
4245 return DD->RecordSourceLine(Line, Col, Src);
4246}
4247
4248/// RecordSource - Register a source file with debug info. Returns an source
4249/// ID.
4250unsigned DwarfWriter::RecordSource(const std::string &Dir,
4251 const std::string &File) {
4252 return DD->RecordSource(Dir, File);
4253}
4254
4255/// RecordRegionStart - Indicate the start of a region.
4256unsigned DwarfWriter::RecordRegionStart(GlobalVariable *V) {
4257 return DD->RecordRegionStart(V);
4258}
4259
4260/// RecordRegionEnd - Indicate the end of a region.
4261unsigned DwarfWriter::RecordRegionEnd(GlobalVariable *V) {
4262 return DD->RecordRegionEnd(V);
4263}
4264
4265/// getRecordSourceLineCount - Count source lines.
4266unsigned DwarfWriter::getRecordSourceLineCount() {
4267 return DD->getRecordSourceLineCount();
4268}
Devang Patel70190872009-01-13 21:25:00 +00004269
Devang Patelfe359e72009-01-13 21:44:10 +00004270/// RecordVariable - Indicate the declaration of a local variable.
4271///
4272void DwarfWriter::RecordVariable(GlobalVariable *GV, unsigned FrameIndex) {
4273 DD->RecordVariable(GV, FrameIndex);
4274}
Devang Patel42f6bed2009-01-13 23:54:55 +00004275