blob: ce82d9748862945d437f8a76594301295209c8ea [file] [log] [blame]
Jim Laskeye5032892005-12-21 19:48:16 +00001//===-- llvm/CodeGen/DwarfWriter.cpp - Dwarf Framework ----------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file was developed by James M. Laskey and is distributed under the
6// University of Illinois Open Source License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains support for writing dwarf debug info into asm files.
11//
12//===----------------------------------------------------------------------===//
Jim Laskey3ea0e0e2006-01-27 18:32:41 +000013
Jim Laskeyb2efb852006-01-04 22:28:25 +000014#include "llvm/CodeGen/DwarfWriter.h"
Jim Laskeye5032892005-12-21 19:48:16 +000015
Jim Laskey063e7652006-01-17 17:31:53 +000016#include "llvm/ADT/StringExtras.h"
Jim Laskey52060a02006-01-24 00:49:18 +000017#include "llvm/Module.h"
18#include "llvm/Type.h"
Jim Laskeya7cea6f2006-01-04 13:52:30 +000019#include "llvm/CodeGen/AsmPrinter.h"
Jim Laskeyb2efb852006-01-04 22:28:25 +000020#include "llvm/CodeGen/MachineDebugInfo.h"
Jim Laskeyb3e789a2006-01-26 20:21:46 +000021#include "llvm/Support/Dwarf.h"
Jim Laskeya7cea6f2006-01-04 13:52:30 +000022#include "llvm/Support/CommandLine.h"
Jim Laskey52060a02006-01-24 00:49:18 +000023#include "llvm/Support/Mangler.h"
24#include "llvm/Target/TargetMachine.h"
Jim Laskeya7cea6f2006-01-04 13:52:30 +000025
Jim Laskeyb2efb852006-01-04 22:28:25 +000026#include <iostream>
Jim Laskeya7cea6f2006-01-04 13:52:30 +000027
Jim Laskeyb2efb852006-01-04 22:28:25 +000028using namespace llvm;
Jim Laskey9a777a32006-02-27 22:37:23 +000029using namespace llvm::dwarf;
Jim Laskeya7cea6f2006-01-04 13:52:30 +000030
31static cl::opt<bool>
32DwarfVerbose("dwarf-verbose", cl::Hidden,
Jim Laskey063e7652006-01-17 17:31:53 +000033 cl::desc("Add comments to Dwarf directives."));
34
Jim Laskey0d086af2006-02-27 12:43:29 +000035namespace llvm {
36
Jim Laskey063e7652006-01-17 17:31:53 +000037//===----------------------------------------------------------------------===//
Jim Laskey0d086af2006-02-27 12:43:29 +000038// Forward declarations.
39//
40class CompileUnit;
41class DIE;
Jim Laskey063e7652006-01-17 17:31:53 +000042
Jim Laskey0d086af2006-02-27 12:43:29 +000043//===----------------------------------------------------------------------===//
Jim Laskeyf01e5472006-03-03 15:06:57 +000044// CompileUnit - This dwarf writer support class manages information associate
45// with a source file.
Jim Laskeybd761842006-02-27 17:27:12 +000046class CompileUnit {
47private:
48 CompileUnitDesc *Desc; // Compile unit debug descriptor.
49 unsigned ID; // File ID for source.
50 DIE *Die; // Compile unit die.
51 std::map<std::string, DIE *> Globals; // A map of globally visible named
52 // entities for this unit.
53
54public:
55 CompileUnit(CompileUnitDesc *CUD, unsigned I, DIE *D)
56 : Desc(CUD)
57 , ID(I)
58 , Die(D)
59 , Globals()
60 {}
61
62 ~CompileUnit();
63
64 // Accessors.
65 CompileUnitDesc *getDesc() const { return Desc; }
66 unsigned getID() const { return ID; }
67 DIE* getDie() const { return Die; }
68 std::map<std::string, DIE *> &getGlobals() { return Globals; }
69
70 /// hasContent - Return true if this compile unit has something to write out.
71 ///
72 bool hasContent() const;
73
74 /// AddGlobal - Add a new global entity to the compile unit.
75 ///
76 void AddGlobal(const std::string &Name, DIE *Die);
77
78};
79
80//===----------------------------------------------------------------------===//
Jim Laskey0d086af2006-02-27 12:43:29 +000081// DIEAbbrevData - Dwarf abbreviation data, describes the one attribute of a
82// Dwarf abbreviation.
83class DIEAbbrevData {
84private:
85 unsigned Attribute; // Dwarf attribute code.
86 unsigned Form; // Dwarf form code.
87
88public:
89 DIEAbbrevData(unsigned A, unsigned F)
90 : Attribute(A)
91 , Form(F)
92 {}
93
Jim Laskeybd761842006-02-27 17:27:12 +000094 // Accessors.
Jim Laskey0d086af2006-02-27 12:43:29 +000095 unsigned getAttribute() const { return Attribute; }
96 unsigned getForm() const { return Form; }
97
98 /// operator== - Used by DIEAbbrev to locate entry.
99 ///
100 bool operator==(const DIEAbbrevData &DAD) const {
101 return Attribute == DAD.Attribute && Form == DAD.Form;
Jim Laskey063e7652006-01-17 17:31:53 +0000102 }
Jim Laskey063e7652006-01-17 17:31:53 +0000103
Jim Laskey0d086af2006-02-27 12:43:29 +0000104 /// operator!= - Used by DIEAbbrev to locate entry.
105 ///
106 bool operator!=(const DIEAbbrevData &DAD) const {
107 return Attribute != DAD.Attribute || Form != DAD.Form;
Jim Laskey063e7652006-01-17 17:31:53 +0000108 }
Jim Laskey0d086af2006-02-27 12:43:29 +0000109
110 /// operator< - Used by DIEAbbrev to locate entry.
111 ///
112 bool operator<(const DIEAbbrevData &DAD) const {
113 return Attribute < DAD.Attribute ||
114 (Attribute == DAD.Attribute && Form < DAD.Form);
115 }
116};
Jim Laskey063e7652006-01-17 17:31:53 +0000117
Jim Laskey0d086af2006-02-27 12:43:29 +0000118//===----------------------------------------------------------------------===//
119// DIEAbbrev - Dwarf abbreviation, describes the organization of a debug
120// information object.
121class DIEAbbrev {
122private:
123 unsigned Tag; // Dwarf tag code.
124 unsigned ChildrenFlag; // Dwarf children flag.
125 std::vector<DIEAbbrevData> Data; // Raw data bytes for abbreviation.
Jim Laskey063e7652006-01-17 17:31:53 +0000126
Jim Laskey0d086af2006-02-27 12:43:29 +0000127public:
Jim Laskey063e7652006-01-17 17:31:53 +0000128
Jim Laskey0d086af2006-02-27 12:43:29 +0000129 DIEAbbrev(unsigned T, unsigned C)
130 : Tag(T)
131 , ChildrenFlag(C)
132 , Data()
133 {}
134 ~DIEAbbrev() {}
135
Jim Laskeybd761842006-02-27 17:27:12 +0000136 // Accessors.
Jim Laskey0d086af2006-02-27 12:43:29 +0000137 unsigned getTag() const { return Tag; }
138 unsigned getChildrenFlag() const { return ChildrenFlag; }
139 const std::vector<DIEAbbrevData> &getData() const { return Data; }
140 void setChildrenFlag(unsigned CF) { ChildrenFlag = CF; }
Jim Laskey063e7652006-01-17 17:31:53 +0000141
Jim Laskey0d086af2006-02-27 12:43:29 +0000142 /// operator== - Used by UniqueVector to locate entry.
143 ///
144 bool operator==(const DIEAbbrev &DA) const;
Jim Laskey063e7652006-01-17 17:31:53 +0000145
Jim Laskey0d086af2006-02-27 12:43:29 +0000146 /// operator< - Used by UniqueVector to locate entry.
147 ///
148 bool operator<(const DIEAbbrev &DA) const;
Jim Laskey063e7652006-01-17 17:31:53 +0000149
Jim Laskey0d086af2006-02-27 12:43:29 +0000150 /// AddAttribute - Adds another set of attribute information to the
151 /// abbreviation.
152 void AddAttribute(unsigned Attribute, unsigned Form) {
153 Data.push_back(DIEAbbrevData(Attribute, Form));
Jim Laskey063e7652006-01-17 17:31:53 +0000154 }
Jim Laskey0d086af2006-02-27 12:43:29 +0000155
156 /// Emit - Print the abbreviation using the specified Dwarf writer.
157 ///
158 void Emit(const DwarfWriter &DW) const;
159
160#ifndef NDEBUG
161 void print(std::ostream &O);
162 void dump();
163#endif
164};
Jim Laskey063e7652006-01-17 17:31:53 +0000165
Jim Laskey0d086af2006-02-27 12:43:29 +0000166//===----------------------------------------------------------------------===//
167// DIEValue - A debug information entry value.
168//
169class DIEValue {
170public:
171 enum {
172 isInteger,
173 isString,
174 isLabel,
175 isAsIsLabel,
176 isDelta,
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000177 isEntry,
178 isBlock
Jim Laskey0d086af2006-02-27 12:43:29 +0000179 };
180
181 unsigned Type; // Type of the value
182
183 DIEValue(unsigned T) : Type(T) {}
184 virtual ~DIEValue() {}
185
186 // Implement isa/cast/dyncast.
187 static bool classof(const DIEValue *) { return true; }
188
189 /// EmitValue - Emit value via the Dwarf writer.
190 ///
191 virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const = 0;
192
193 /// SizeOf - Return the size of a value in bytes.
194 ///
195 virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const = 0;
196};
Jim Laskey063e7652006-01-17 17:31:53 +0000197
Jim Laskey0d086af2006-02-27 12:43:29 +0000198//===----------------------------------------------------------------------===//
199// DWInteger - An integer value DIE.
200//
201class DIEInteger : public DIEValue {
202private:
203 uint64_t Integer;
204
205public:
206 DIEInteger(uint64_t I) : DIEValue(isInteger), Integer(I) {}
Jim Laskey063e7652006-01-17 17:31:53 +0000207
Jim Laskey0d086af2006-02-27 12:43:29 +0000208 // Implement isa/cast/dyncast.
209 static bool classof(const DIEInteger *) { return true; }
210 static bool classof(const DIEValue *I) { return I->Type == isInteger; }
211
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000212 /// BestForm - Choose the best form for integer.
213 ///
214 unsigned BestForm(bool IsSigned);
215
Jim Laskey0d086af2006-02-27 12:43:29 +0000216 /// EmitValue - Emit integer of appropriate size.
217 ///
218 virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const;
219
220 /// SizeOf - Determine size of integer value in bytes.
221 ///
222 virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const;
223};
Jim Laskey063e7652006-01-17 17:31:53 +0000224
Jim Laskey0d086af2006-02-27 12:43:29 +0000225//===----------------------------------------------------------------------===//
226// DIEString - A string value DIE.
227//
228struct DIEString : public DIEValue {
229 const std::string String;
230
231 DIEString(const std::string &S) : DIEValue(isString), String(S) {}
Jim Laskey063e7652006-01-17 17:31:53 +0000232
Jim Laskey0d086af2006-02-27 12:43:29 +0000233 // Implement isa/cast/dyncast.
234 static bool classof(const DIEString *) { return true; }
235 static bool classof(const DIEValue *S) { return S->Type == isString; }
236
237 /// EmitValue - Emit string value.
238 ///
239 virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const;
240
241 /// SizeOf - Determine size of string value in bytes.
242 ///
243 virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const;
244};
Jim Laskey063e7652006-01-17 17:31:53 +0000245
Jim Laskey0d086af2006-02-27 12:43:29 +0000246//===----------------------------------------------------------------------===//
247// DIEDwarfLabel - A Dwarf internal label expression DIE.
248//
249struct DIEDwarfLabel : public DIEValue {
250 const DWLabel Label;
251
252 DIEDwarfLabel(const DWLabel &L) : DIEValue(isLabel), Label(L) {}
Jim Laskey063e7652006-01-17 17:31:53 +0000253
Jim Laskey0d086af2006-02-27 12:43:29 +0000254 // Implement isa/cast/dyncast.
255 static bool classof(const DIEDwarfLabel *) { return true; }
256 static bool classof(const DIEValue *L) { return L->Type == isLabel; }
257
258 /// EmitValue - Emit label value.
259 ///
260 virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const;
261
262 /// SizeOf - Determine size of label value in bytes.
263 ///
264 virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const;
265};
Jim Laskey063e7652006-01-17 17:31:53 +0000266
Jim Laskey063e7652006-01-17 17:31:53 +0000267
Jim Laskey0d086af2006-02-27 12:43:29 +0000268//===----------------------------------------------------------------------===//
269// DIEObjectLabel - A label to an object in code or data.
270//
271struct DIEObjectLabel : public DIEValue {
272 const std::string Label;
273
274 DIEObjectLabel(const std::string &L) : DIEValue(isAsIsLabel), Label(L) {}
Jim Laskey063e7652006-01-17 17:31:53 +0000275
Jim Laskey0d086af2006-02-27 12:43:29 +0000276 // Implement isa/cast/dyncast.
277 static bool classof(const DIEObjectLabel *) { return true; }
278 static bool classof(const DIEValue *L) { return L->Type == isAsIsLabel; }
279
280 /// EmitValue - Emit label value.
281 ///
282 virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const;
283
284 /// SizeOf - Determine size of label value in bytes.
285 ///
286 virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const;
287};
Jim Laskey063e7652006-01-17 17:31:53 +0000288
Jim Laskey0d086af2006-02-27 12:43:29 +0000289//===----------------------------------------------------------------------===//
290// DIEDelta - A simple label difference DIE.
291//
292struct DIEDelta : public DIEValue {
293 const DWLabel LabelHi;
294 const DWLabel LabelLo;
295
296 DIEDelta(const DWLabel &Hi, const DWLabel &Lo)
297 : DIEValue(isDelta), LabelHi(Hi), LabelLo(Lo) {}
Jim Laskey063e7652006-01-17 17:31:53 +0000298
Jim Laskey0d086af2006-02-27 12:43:29 +0000299 // Implement isa/cast/dyncast.
300 static bool classof(const DIEDelta *) { return true; }
301 static bool classof(const DIEValue *D) { return D->Type == isDelta; }
302
303 /// EmitValue - Emit delta value.
304 ///
305 virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const;
306
307 /// SizeOf - Determine size of delta value in bytes.
308 ///
309 virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const;
310};
Jim Laskey063e7652006-01-17 17:31:53 +0000311
Jim Laskey0d086af2006-02-27 12:43:29 +0000312//===----------------------------------------------------------------------===//
313// DIEntry - A pointer to a debug information entry.
314//
315struct DIEntry : public DIEValue {
316 DIE *Entry;
317
318 DIEntry(DIE *E) : DIEValue(isEntry), Entry(E) {}
319
320 // Implement isa/cast/dyncast.
321 static bool classof(const DIEntry *) { return true; }
322 static bool classof(const DIEValue *E) { return E->Type == isEntry; }
323
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000324 /// EmitValue - Emit die entry offset.
Jim Laskey0d086af2006-02-27 12:43:29 +0000325 ///
326 virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const;
327
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000328 /// SizeOf - Determine size of die entry in bytes.
Jim Laskey0d086af2006-02-27 12:43:29 +0000329 ///
330 virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const;
331};
332
333//===----------------------------------------------------------------------===//
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000334// DIEBlock - A block of values. Primarily used for location expressions.
335//
336struct DIEBlock : public DIEValue {
337 unsigned Size; // Size in bytes excluding size header.
338 std::vector<unsigned> Forms; // Data forms.
339 std::vector<DIEValue *> Values; // Block values.
340
341 DIEBlock()
342 : DIEValue(isBlock)
343 , Size(0)
344 , Forms()
345 , Values()
346 {}
347 ~DIEBlock();
348
349 // Implement isa/cast/dyncast.
350 static bool classof(const DIEBlock *) { return true; }
351 static bool classof(const DIEValue *E) { return E->Type == isBlock; }
352
353 /// ComputeSize - calculate the size of the block.
354 ///
355 unsigned ComputeSize(DwarfWriter &DW);
356
357 /// BestForm - Choose the best form for data.
358 ///
359 unsigned BestForm();
360
361 /// EmitValue - Emit block data.
362 ///
363 virtual void EmitValue(const DwarfWriter &DW, unsigned Form) const;
364
365 /// SizeOf - Determine size of block data in bytes.
366 ///
367 virtual unsigned SizeOf(const DwarfWriter &DW, unsigned Form) const;
368
369 /// AddUInt - Add an unsigned integer value.
370 ///
371 void AddUInt(unsigned Form, uint64_t Integer);
372
373 /// AddSInt - Add an signed integer value.
374 ///
375 void AddSInt(unsigned Form, int64_t Integer);
376
377 /// AddString - Add a std::string value.
378 ///
379 void AddString(unsigned Form, const std::string &String);
380
381 /// AddLabel - Add a Dwarf label value.
382 ///
383 void AddLabel(unsigned Form, const DWLabel &Label);
384
385 /// AddObjectLabel - Add a non-Dwarf label value.
386 ///
387 void AddObjectLabel(unsigned Form, const std::string &Label);
388
389 /// AddDelta - Add a label delta value.
390 ///
391 void AddDelta(unsigned Form, const DWLabel &Hi, const DWLabel &Lo);
392
393 /// AddDIEntry - Add a DIE value.
394 ///
395 void AddDIEntry(unsigned Form, DIE *Entry);
396
397};
398
399//===----------------------------------------------------------------------===//
Jim Laskey0d086af2006-02-27 12:43:29 +0000400// DIE - A structured debug information entry. Has an abbreviation which
401// describes it's organization.
402class DIE {
403private:
404 DIEAbbrev *Abbrev; // Temporary buffer for abbreviation.
405 unsigned AbbrevID; // Decribing abbreviation ID.
406 unsigned Offset; // Offset in debug info section.
407 unsigned Size; // Size of instance + children.
408 std::vector<DIE *> Children; // Children DIEs.
409 std::vector<DIEValue *> Values; // Attributes values.
410
411public:
412 DIE(unsigned Tag);
413 ~DIE();
414
Jim Laskeybd761842006-02-27 17:27:12 +0000415 // Accessors.
Jim Laskey0d086af2006-02-27 12:43:29 +0000416 unsigned getAbbrevID() const { return AbbrevID; }
417 unsigned getOffset() const { return Offset; }
418 unsigned getSize() const { return Size; }
419 const std::vector<DIE *> &getChildren() const { return Children; }
420 const std::vector<DIEValue *> &getValues() const { return Values; }
421 void setOffset(unsigned O) { Offset = O; }
422 void setSize(unsigned S) { Size = S; }
423
424 /// SiblingOffset - Return the offset of the debug information entry's
425 /// sibling.
426 unsigned SiblingOffset() const { return Offset + Size; }
427
428 /// AddUInt - Add an unsigned integer attribute data and value.
429 ///
430 void AddUInt(unsigned Attribute, unsigned Form, uint64_t Integer);
431
432 /// AddSInt - Add an signed integer attribute data and value.
433 ///
434 void AddSInt(unsigned Attribute, unsigned Form, int64_t Integer);
435
436 /// AddString - Add a std::string attribute data and value.
437 ///
438 void AddString(unsigned Attribute, unsigned Form,
439 const std::string &String);
440
441 /// AddLabel - Add a Dwarf label attribute data and value.
442 ///
443 void AddLabel(unsigned Attribute, unsigned Form, const DWLabel &Label);
444
445 /// AddObjectLabel - Add a non-Dwarf label attribute data and value.
446 ///
447 void AddObjectLabel(unsigned Attribute, unsigned Form,
448 const std::string &Label);
449
450 /// AddDelta - Add a label delta attribute data and value.
451 ///
452 void AddDelta(unsigned Attribute, unsigned Form,
453 const DWLabel &Hi, const DWLabel &Lo);
454
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000455 /// AddDIEntry - Add a DIE attribute data and value.
Jim Laskey0d086af2006-02-27 12:43:29 +0000456 ///
457 void AddDIEntry(unsigned Attribute, unsigned Form, DIE *Entry);
458
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000459 /// AddBlock - Add block data.
460 ///
461 void AddBlock(unsigned Attribute, unsigned Form, DIEBlock *Block);
462
Jim Laskey0d086af2006-02-27 12:43:29 +0000463 /// Complete - Indicate that all attributes have been added and
464 /// ready to get an abbreviation ID.
465 ///
466 void Complete(DwarfWriter &DW);
467
468 /// AddChild - Add a child to the DIE.
469 void AddChild(DIE *Child);
470};
471
472} // End of namespace llvm
Jim Laskey063e7652006-01-17 17:31:53 +0000473
474//===----------------------------------------------------------------------===//
475
Jim Laskeybd761842006-02-27 17:27:12 +0000476CompileUnit::~CompileUnit() {
477 delete Die;
478}
479
480/// hasContent - Return true if this compile unit has something to write out.
481///
482bool CompileUnit::hasContent() const {
483 return !Die->getChildren().empty();
484}
485
486/// AddGlobal - Add a new global entity to the compile unit.
487///
488void CompileUnit::AddGlobal(const std::string &Name, DIE *Die) {
489 Globals[Name] = Die;
490}
491
492//===----------------------------------------------------------------------===//
493
Jim Laskeyd18e2892006-01-20 20:34:06 +0000494/// operator== - Used by UniqueVector to locate entry.
495///
496bool DIEAbbrev::operator==(const DIEAbbrev &DA) const {
497 if (Tag != DA.Tag) return false;
498 if (ChildrenFlag != DA.ChildrenFlag) return false;
499 if (Data.size() != DA.Data.size()) return false;
500
Jim Laskey52060a02006-01-24 00:49:18 +0000501 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
Jim Laskey63ae85f2006-01-21 01:13:18 +0000502 if (Data[i] != DA.Data[i]) return false;
Jim Laskeyd18e2892006-01-20 20:34:06 +0000503 }
504
505 return true;
506}
507
508/// operator< - Used by UniqueVector to locate entry.
509///
510bool DIEAbbrev::operator<(const DIEAbbrev &DA) const {
511 if (Tag != DA.Tag) return Tag < DA.Tag;
512 if (ChildrenFlag != DA.ChildrenFlag) return ChildrenFlag < DA.ChildrenFlag;
513 if (Data.size() != DA.Data.size()) return Data.size() < DA.Data.size();
514
Jim Laskey52060a02006-01-24 00:49:18 +0000515 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
Jim Laskey63ae85f2006-01-21 01:13:18 +0000516 if (Data[i] != DA.Data[i]) return Data[i] < DA.Data[i];
Jim Laskeyd18e2892006-01-20 20:34:06 +0000517 }
518
519 return false;
520}
521
522/// Emit - Print the abbreviation using the specified Dwarf writer.
523///
524void DIEAbbrev::Emit(const DwarfWriter &DW) const {
525 // Emit its Dwarf tag type.
526 DW.EmitULEB128Bytes(Tag);
527 DW.EOL(TagString(Tag));
528
529 // Emit whether it has children DIEs.
530 DW.EmitULEB128Bytes(ChildrenFlag);
531 DW.EOL(ChildrenString(ChildrenFlag));
532
533 // For each attribute description.
Jim Laskey52060a02006-01-24 00:49:18 +0000534 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
Jim Laskeyd18e2892006-01-20 20:34:06 +0000535 const DIEAbbrevData &AttrData = Data[i];
536
537 // Emit attribute type.
538 DW.EmitULEB128Bytes(AttrData.getAttribute());
539 DW.EOL(AttributeString(AttrData.getAttribute()));
540
541 // Emit form type.
542 DW.EmitULEB128Bytes(AttrData.getForm());
543 DW.EOL(FormEncodingString(AttrData.getForm()));
544 }
545
546 // Mark end of abbreviation.
547 DW.EmitULEB128Bytes(0); DW.EOL("EOM(1)");
548 DW.EmitULEB128Bytes(0); DW.EOL("EOM(2)");
549}
550
551#ifndef NDEBUG
552 void DIEAbbrev::print(std::ostream &O) {
553 O << "Abbreviation @"
Jeff Cohen05ebc8d2006-01-25 17:18:50 +0000554 << std::hex << (intptr_t)this << std::dec
Jim Laskeyd18e2892006-01-20 20:34:06 +0000555 << " "
556 << TagString(Tag)
557 << " "
558 << ChildrenString(ChildrenFlag)
559 << "\n";
560
Jim Laskey52060a02006-01-24 00:49:18 +0000561 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
Jim Laskeyd18e2892006-01-20 20:34:06 +0000562 O << " "
563 << AttributeString(Data[i].getAttribute())
564 << " "
565 << FormEncodingString(Data[i].getForm())
566 << "\n";
567 }
568 }
569 void DIEAbbrev::dump() { print(std::cerr); }
570#endif
571
572//===----------------------------------------------------------------------===//
573
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000574/// BestForm - Choose the best form for integer.
575///
576unsigned DIEInteger::BestForm(bool IsSigned) {
577 if (IsSigned) {
578 if ((char)Integer == (signed)Integer) return DW_FORM_data1;
579 if ((short)Integer == (signed)Integer) return DW_FORM_data2;
580 if ((int)Integer == (signed)Integer) return DW_FORM_data4;
581 } else {
582 if ((unsigned char)Integer == Integer) return DW_FORM_data1;
583 if ((unsigned short)Integer == Integer) return DW_FORM_data2;
584 if ((unsigned int)Integer == Integer) return DW_FORM_data4;
585 }
586 return DW_FORM_data8;
587}
588
Jim Laskey063e7652006-01-17 17:31:53 +0000589/// EmitValue - Emit integer of appropriate size.
590///
591void DIEInteger::EmitValue(const DwarfWriter &DW, unsigned Form) const {
592 switch (Form) {
Jim Laskey40020172006-01-20 21:02:36 +0000593 case DW_FORM_flag: // Fall thru
Jim Laskeyda427fa2006-01-27 20:31:25 +0000594 case DW_FORM_data1: DW.EmitInt8(Integer); break;
595 case DW_FORM_data2: DW.EmitInt16(Integer); break;
596 case DW_FORM_data4: DW.EmitInt32(Integer); break;
597 case DW_FORM_data8: DW.EmitInt64(Integer); break;
Jim Laskey40020172006-01-20 21:02:36 +0000598 case DW_FORM_udata: DW.EmitULEB128Bytes(Integer); break;
599 case DW_FORM_sdata: DW.EmitSLEB128Bytes(Integer); break;
Jim Laskey063e7652006-01-17 17:31:53 +0000600 default: assert(0 && "DIE Value form not supported yet"); break;
601 }
602}
603
604/// SizeOf - Determine size of integer value in bytes.
605///
606unsigned DIEInteger::SizeOf(const DwarfWriter &DW, unsigned Form) const {
607 switch (Form) {
Jim Laskeyd18e2892006-01-20 20:34:06 +0000608 case DW_FORM_flag: // Fall thru
Jim Laskey063e7652006-01-17 17:31:53 +0000609 case DW_FORM_data1: return sizeof(int8_t);
610 case DW_FORM_data2: return sizeof(int16_t);
611 case DW_FORM_data4: return sizeof(int32_t);
Jim Laskeyd8f77ba2006-01-27 15:20:54 +0000612 case DW_FORM_data8: return sizeof(int64_t);
Jim Laskey40020172006-01-20 21:02:36 +0000613 case DW_FORM_udata: return DW.SizeULEB128(Integer);
614 case DW_FORM_sdata: return DW.SizeSLEB128(Integer);
Jim Laskey063e7652006-01-17 17:31:53 +0000615 default: assert(0 && "DIE Value form not supported yet"); break;
616 }
617 return 0;
618}
619
620//===----------------------------------------------------------------------===//
621
622/// EmitValue - Emit string value.
623///
624void DIEString::EmitValue(const DwarfWriter &DW, unsigned Form) const {
Jim Laskeyd18e2892006-01-20 20:34:06 +0000625 DW.EmitString(String);
Jim Laskey063e7652006-01-17 17:31:53 +0000626}
627
628/// SizeOf - Determine size of string value in bytes.
629///
630unsigned DIEString::SizeOf(const DwarfWriter &DW, unsigned Form) const {
Jim Laskey40020172006-01-20 21:02:36 +0000631 return String.size() + sizeof(char); // sizeof('\0');
Jim Laskey063e7652006-01-17 17:31:53 +0000632}
633
634//===----------------------------------------------------------------------===//
635
636/// EmitValue - Emit label value.
637///
Jim Laskey52060a02006-01-24 00:49:18 +0000638void DIEDwarfLabel::EmitValue(const DwarfWriter &DW, unsigned Form) const {
Jim Laskeyd18e2892006-01-20 20:34:06 +0000639 DW.EmitReference(Label);
Jim Laskey063e7652006-01-17 17:31:53 +0000640}
641
642/// SizeOf - Determine size of label value in bytes.
643///
Jim Laskey52060a02006-01-24 00:49:18 +0000644unsigned DIEDwarfLabel::SizeOf(const DwarfWriter &DW, unsigned Form) const {
Jim Laskey063e7652006-01-17 17:31:53 +0000645 return DW.getAddressSize();
646}
647
648//===----------------------------------------------------------------------===//
649
Jim Laskeyd18e2892006-01-20 20:34:06 +0000650/// EmitValue - Emit label value.
651///
Jim Laskey52060a02006-01-24 00:49:18 +0000652void DIEObjectLabel::EmitValue(const DwarfWriter &DW, unsigned Form) const {
Jim Laskeyd18e2892006-01-20 20:34:06 +0000653 DW.EmitReference(Label);
654}
655
656/// SizeOf - Determine size of label value in bytes.
657///
Jim Laskey52060a02006-01-24 00:49:18 +0000658unsigned DIEObjectLabel::SizeOf(const DwarfWriter &DW, unsigned Form) const {
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000659 return DW.getAddressSize();
Jim Laskeyd18e2892006-01-20 20:34:06 +0000660}
661
662//===----------------------------------------------------------------------===//
663
Jim Laskey063e7652006-01-17 17:31:53 +0000664/// EmitValue - Emit delta value.
665///
666void DIEDelta::EmitValue(const DwarfWriter &DW, unsigned Form) const {
Jim Laskeyd18e2892006-01-20 20:34:06 +0000667 DW.EmitDifference(LabelHi, LabelLo);
Jim Laskey063e7652006-01-17 17:31:53 +0000668}
669
670/// SizeOf - Determine size of delta value in bytes.
671///
672unsigned DIEDelta::SizeOf(const DwarfWriter &DW, unsigned Form) const {
673 return DW.getAddressSize();
674}
675
676//===----------------------------------------------------------------------===//
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000677/// EmitValue - Emit die entry offset.
Jim Laskeyd18e2892006-01-20 20:34:06 +0000678///
679void DIEntry::EmitValue(const DwarfWriter &DW, unsigned Form) const {
Jim Laskeyda427fa2006-01-27 20:31:25 +0000680 DW.EmitInt32(Entry->getOffset());
Jim Laskeyd18e2892006-01-20 20:34:06 +0000681}
682
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000683/// SizeOf - Determine size of die value in bytes.
Jim Laskeyd18e2892006-01-20 20:34:06 +0000684///
685unsigned DIEntry::SizeOf(const DwarfWriter &DW, unsigned Form) const {
686 return sizeof(int32_t);
687}
688
689//===----------------------------------------------------------------------===//
690
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000691DIEBlock::~DIEBlock() {
692 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
693 delete Values[i];
694 }
695}
696
697/// ComputeSize - calculate the size of the block.
698///
699unsigned DIEBlock::ComputeSize(DwarfWriter &DW) {
700 Size = 0;
701 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
702 Size += Values[i]->SizeOf(DW, Forms[i]);
703 }
704 return Size;
705}
706
707/// BestForm - Choose the best form for data.
708///
709unsigned DIEBlock::BestForm() {
710 if ((unsigned char)Size == Size) return DW_FORM_block1;
711 if ((unsigned short)Size == Size) return DW_FORM_block2;
712 if ((unsigned int)Size == Size) return DW_FORM_block4;
713 return DW_FORM_block;
714}
715
716/// EmitValue - Emit block data.
717///
718void DIEBlock::EmitValue(const DwarfWriter &DW, unsigned Form) const {
719 switch (Form) {
720 case DW_FORM_block1: DW.EmitInt8(Size); break;
721 case DW_FORM_block2: DW.EmitInt16(Size); break;
722 case DW_FORM_block4: DW.EmitInt32(Size); break;
723 case DW_FORM_block: DW.EmitULEB128Bytes(Size); break;
724 default: assert(0 && "Improper form for block"); break;
725 }
726 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
727 DW.EOL("");
728 Values[i]->EmitValue(DW, Forms[i]);
729 }
730}
731
732/// SizeOf - Determine size of block data in bytes.
733///
734unsigned DIEBlock::SizeOf(const DwarfWriter &DW, unsigned Form) const {
735 switch (Form) {
736 case DW_FORM_block1: return Size + sizeof(int8_t);
737 case DW_FORM_block2: return Size + sizeof(int16_t);
738 case DW_FORM_block4: return Size + sizeof(int32_t);
739 case DW_FORM_block: return Size + DW.SizeULEB128(Size);
740 default: assert(0 && "Improper form for block"); break;
741 }
742 return 0;
743}
744
745/// AddUInt - Add an unsigned integer value.
746///
747void DIEBlock::AddUInt(unsigned Form, uint64_t Integer) {
748 DIEInteger *DI = new DIEInteger(Integer);
749 Values.push_back(DI);
750 if (Form == 0) Form = DI->BestForm(false);
751 Forms.push_back(Form);
752}
753
754/// AddSInt - Add an signed integer value.
755///
756void DIEBlock::AddSInt(unsigned Form, int64_t Integer) {
757 DIEInteger *DI = new DIEInteger(Integer);
758 Values.push_back(DI);
759 if (Form == 0) Form = DI->BestForm(true);
760 Forms.push_back(Form);
761}
762
763/// AddString - Add a std::string value.
764///
765void DIEBlock::AddString(unsigned Form, const std::string &String) {
766 Values.push_back(new DIEString(String));
767 Forms.push_back(Form);
768}
769
770/// AddLabel - Add a Dwarf label value.
771///
772void DIEBlock::AddLabel(unsigned Form, const DWLabel &Label) {
773 Values.push_back(new DIEDwarfLabel(Label));
774 Forms.push_back(Form);
775}
776
777/// AddObjectLabel - Add a non-Dwarf label value.
778///
779void DIEBlock::AddObjectLabel(unsigned Form, const std::string &Label) {
780 Values.push_back(new DIEObjectLabel(Label));
781 Forms.push_back(Form);
782}
783
784/// AddDelta - Add a label delta value.
785///
786void DIEBlock::AddDelta(unsigned Form, const DWLabel &Hi, const DWLabel &Lo) {
787 Values.push_back(new DIEDelta(Hi, Lo));
788 Forms.push_back(Form);
789}
790
791/// AddDIEntry - Add a DIE value.
792///
793void DIEBlock::AddDIEntry(unsigned Form, DIE *Entry) {
794 Values.push_back(new DIEntry(Entry));
795 Forms.push_back(Form);
796}
797
798//===----------------------------------------------------------------------===//
799
Jim Laskey0420f2a2006-02-22 19:02:11 +0000800DIE::DIE(unsigned Tag)
801: Abbrev(new DIEAbbrev(Tag, DW_CHILDREN_no))
Jim Laskeyd18e2892006-01-20 20:34:06 +0000802, AbbrevID(0)
803, Offset(0)
804, Size(0)
Jim Laskeyd18e2892006-01-20 20:34:06 +0000805, Children()
806, Values()
807{}
808
809DIE::~DIE() {
810 if (Abbrev) delete Abbrev;
811
Jim Laskey52060a02006-01-24 00:49:18 +0000812 for (unsigned i = 0, N = Children.size(); i < N; ++i) {
Jim Laskeyd18e2892006-01-20 20:34:06 +0000813 delete Children[i];
814 }
815
Jim Laskey52060a02006-01-24 00:49:18 +0000816 for (unsigned j = 0, M = Values.size(); j < M; ++j) {
Jim Laskeyd18e2892006-01-20 20:34:06 +0000817 delete Values[j];
818 }
Jim Laskeyd18e2892006-01-20 20:34:06 +0000819}
820
Jim Laskeyd8f77ba2006-01-27 15:20:54 +0000821/// AddUInt - Add an unsigned integer attribute data and value.
Jim Laskeyd18e2892006-01-20 20:34:06 +0000822///
Jim Laskeyd8f77ba2006-01-27 15:20:54 +0000823void DIE::AddUInt(unsigned Attribute, unsigned Form, uint64_t Integer) {
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000824 DIEInteger *DI = new DIEInteger(Integer);
825 Values.push_back(DI);
826 if (!Form) Form = DI->BestForm(false);
Jim Laskeyd8f77ba2006-01-27 15:20:54 +0000827 Abbrev->AddAttribute(Attribute, Form);
Jim Laskeyd8f77ba2006-01-27 15:20:54 +0000828}
829
830/// AddSInt - Add an signed integer attribute data and value.
831///
832void DIE::AddSInt(unsigned Attribute, unsigned Form, int64_t Integer) {
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000833 DIEInteger *DI = new DIEInteger(Integer);
834 Values.push_back(DI);
835 if (!Form) Form = DI->BestForm(true);
Jim Laskeyd18e2892006-01-20 20:34:06 +0000836 Abbrev->AddAttribute(Attribute, Form);
Jim Laskeyd18e2892006-01-20 20:34:06 +0000837}
838
839/// AddString - Add a std::string attribute data and value.
840///
841void DIE::AddString(unsigned Attribute, unsigned Form,
842 const std::string &String) {
Jim Laskeyd18e2892006-01-20 20:34:06 +0000843 Values.push_back(new DIEString(String));
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000844 Abbrev->AddAttribute(Attribute, Form);
Jim Laskeyd18e2892006-01-20 20:34:06 +0000845}
846
847/// AddLabel - Add a Dwarf label attribute data and value.
848///
849void DIE::AddLabel(unsigned Attribute, unsigned Form,
850 const DWLabel &Label) {
Jim Laskey52060a02006-01-24 00:49:18 +0000851 Values.push_back(new DIEDwarfLabel(Label));
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000852 Abbrev->AddAttribute(Attribute, Form);
Jim Laskeyd18e2892006-01-20 20:34:06 +0000853}
854
Jim Laskey52060a02006-01-24 00:49:18 +0000855/// AddObjectLabel - Add an non-Dwarf label attribute data and value.
Jim Laskeyd18e2892006-01-20 20:34:06 +0000856///
Jim Laskey52060a02006-01-24 00:49:18 +0000857void DIE::AddObjectLabel(unsigned Attribute, unsigned Form,
858 const std::string &Label) {
Jim Laskey52060a02006-01-24 00:49:18 +0000859 Values.push_back(new DIEObjectLabel(Label));
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000860 Abbrev->AddAttribute(Attribute, Form);
Jim Laskeyd18e2892006-01-20 20:34:06 +0000861}
862
863/// AddDelta - Add a label delta attribute data and value.
864///
865void DIE::AddDelta(unsigned Attribute, unsigned Form,
866 const DWLabel &Hi, const DWLabel &Lo) {
Jim Laskeyd18e2892006-01-20 20:34:06 +0000867 Values.push_back(new DIEDelta(Hi, Lo));
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000868 Abbrev->AddAttribute(Attribute, Form);
Jim Laskeyd18e2892006-01-20 20:34:06 +0000869}
870
871/// AddDIEntry - Add a DIE attribute data and value.
872///
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000873void DIE::AddDIEntry(unsigned Attribute, unsigned Form, DIE *Entry) {
Jim Laskeyd18e2892006-01-20 20:34:06 +0000874 Values.push_back(new DIEntry(Entry));
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000875 Abbrev->AddAttribute(Attribute, Form);
876}
877
878/// AddBlock - Add block data.
879///
880void DIE::AddBlock(unsigned Attribute, unsigned Form, DIEBlock *Block) {
881 assert(Block->Size && "Block size has not been computed");
882 Values.push_back(Block);
883 if (!Form) Form = Block->BestForm();
884 Abbrev->AddAttribute(Attribute, Form);
Jim Laskeyd18e2892006-01-20 20:34:06 +0000885}
886
887/// Complete - Indicate that all attributes have been added and ready to get an
888/// abbreviation ID.
889void DIE::Complete(DwarfWriter &DW) {
890 AbbrevID = DW.NewAbbreviation(Abbrev);
891 delete Abbrev;
892 Abbrev = NULL;
893}
894
895/// AddChild - Add a child to the DIE.
896///
897void DIE::AddChild(DIE *Child) {
Jim Laskey0420f2a2006-02-22 19:02:11 +0000898 assert(Abbrev && "Adding children without an abbreviation");
899 Abbrev->setChildrenFlag(DW_CHILDREN_yes);
Jim Laskeyd18e2892006-01-20 20:34:06 +0000900 Children.push_back(Child);
901}
902
903//===----------------------------------------------------------------------===//
904
Jim Laskey0420f2a2006-02-22 19:02:11 +0000905/// DWContext
Jim Laskeyd18e2892006-01-20 20:34:06 +0000906
907//===----------------------------------------------------------------------===//
Jim Laskey063e7652006-01-17 17:31:53 +0000908
909/// PrintHex - Print a value as a hexidecimal value.
910///
911void DwarfWriter::PrintHex(int Value) const {
912 O << "0x" << std::hex << Value << std::dec;
913}
914
915/// EOL - Print a newline character to asm stream. If a comment is present
916/// then it will be printed first. Comments should not contain '\n'.
917void DwarfWriter::EOL(const std::string &Comment) const {
Jim Laskeyb80af6f2006-03-03 21:00:14 +0000918 if (DwarfVerbose && !Comment.empty()) {
Jim Laskey063e7652006-01-17 17:31:53 +0000919 O << "\t"
920 << Asm->CommentString
921 << " "
922 << Comment;
923 }
924 O << "\n";
925}
Jim Laskeya7cea6f2006-01-04 13:52:30 +0000926
927/// EmitULEB128Bytes - Emit an assembler byte data directive to compose an
Jim Laskey063e7652006-01-17 17:31:53 +0000928/// unsigned leb128 value.
929void DwarfWriter::EmitULEB128Bytes(unsigned Value) const {
Jim Laskeya7cea6f2006-01-04 13:52:30 +0000930 if (hasLEB128) {
931 O << "\t.uleb128\t"
932 << Value;
933 } else {
Jim Laskeyb2efb852006-01-04 22:28:25 +0000934 O << Asm->Data8bitsDirective;
Jim Laskey063e7652006-01-17 17:31:53 +0000935 PrintULEB128(Value);
Jim Laskeya7cea6f2006-01-04 13:52:30 +0000936 }
Jim Laskeya7cea6f2006-01-04 13:52:30 +0000937}
938
939/// EmitSLEB128Bytes - Emit an assembler byte data directive to compose a
Jim Laskey063e7652006-01-17 17:31:53 +0000940/// signed leb128 value.
941void DwarfWriter::EmitSLEB128Bytes(int Value) const {
Jim Laskeya7cea6f2006-01-04 13:52:30 +0000942 if (hasLEB128) {
943 O << "\t.sleb128\t"
944 << Value;
945 } else {
Jim Laskeyb2efb852006-01-04 22:28:25 +0000946 O << Asm->Data8bitsDirective;
Jim Laskey063e7652006-01-17 17:31:53 +0000947 PrintSLEB128(Value);
Jim Laskeya7cea6f2006-01-04 13:52:30 +0000948 }
Jim Laskeya7cea6f2006-01-04 13:52:30 +0000949}
950
Jim Laskey063e7652006-01-17 17:31:53 +0000951/// PrintULEB128 - Print a series of hexidecimal values (separated by commas)
Jim Laskeyb2efb852006-01-04 22:28:25 +0000952/// representing an unsigned leb128 value.
Jim Laskey063e7652006-01-17 17:31:53 +0000953void DwarfWriter::PrintULEB128(unsigned Value) const {
Jim Laskeyb2efb852006-01-04 22:28:25 +0000954 do {
955 unsigned Byte = Value & 0x7f;
956 Value >>= 7;
957 if (Value) Byte |= 0x80;
Jim Laskey063e7652006-01-17 17:31:53 +0000958 PrintHex(Byte);
Jim Laskeyb2efb852006-01-04 22:28:25 +0000959 if (Value) O << ", ";
960 } while (Value);
961}
962
Jim Laskey063e7652006-01-17 17:31:53 +0000963/// SizeULEB128 - Compute the number of bytes required for an unsigned leb128
964/// value.
965unsigned DwarfWriter::SizeULEB128(unsigned Value) {
966 unsigned Size = 0;
967 do {
968 Value >>= 7;
969 Size += sizeof(int8_t);
970 } while (Value);
971 return Size;
972}
973
974/// PrintSLEB128 - Print a series of hexidecimal values (separated by commas)
Jim Laskeyb2efb852006-01-04 22:28:25 +0000975/// representing a signed leb128 value.
Jim Laskey063e7652006-01-17 17:31:53 +0000976void DwarfWriter::PrintSLEB128(int Value) const {
Jim Laskeyb2efb852006-01-04 22:28:25 +0000977 int Sign = Value >> (8 * sizeof(Value) - 1);
978 bool IsMore;
Jim Laskeya7cea6f2006-01-04 13:52:30 +0000979
Jim Laskeyb2efb852006-01-04 22:28:25 +0000980 do {
981 unsigned Byte = Value & 0x7f;
982 Value >>= 7;
983 IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
984 if (IsMore) Byte |= 0x80;
Jim Laskey063e7652006-01-17 17:31:53 +0000985 PrintHex(Byte);
Jim Laskeyb2efb852006-01-04 22:28:25 +0000986 if (IsMore) O << ", ";
987 } while (IsMore);
988}
989
Jim Laskey063e7652006-01-17 17:31:53 +0000990/// SizeSLEB128 - Compute the number of bytes required for a signed leb128
991/// value.
992unsigned DwarfWriter::SizeSLEB128(int Value) {
993 unsigned Size = 0;
994 int Sign = Value >> (8 * sizeof(Value) - 1);
995 bool IsMore;
996
997 do {
998 unsigned Byte = Value & 0x7f;
999 Value >>= 7;
1000 IsMore = Value != Sign || ((Byte ^ Sign) & 0x40) != 0;
1001 Size += sizeof(int8_t);
1002 } while (IsMore);
1003 return Size;
1004}
1005
Jim Laskeyda427fa2006-01-27 20:31:25 +00001006/// EmitInt8 - Emit a byte directive and value.
Jim Laskeyb2efb852006-01-04 22:28:25 +00001007///
Jim Laskeyda427fa2006-01-27 20:31:25 +00001008void DwarfWriter::EmitInt8(int Value) const {
Jim Laskey063e7652006-01-17 17:31:53 +00001009 O << Asm->Data8bitsDirective;
Jim Laskey0420f2a2006-02-22 19:02:11 +00001010 PrintHex(Value & 0xFF);
Jim Laskey063e7652006-01-17 17:31:53 +00001011}
1012
Jim Laskeyda427fa2006-01-27 20:31:25 +00001013/// EmitInt16 - Emit a short directive and value.
Jim Laskey063e7652006-01-17 17:31:53 +00001014///
Jim Laskeyda427fa2006-01-27 20:31:25 +00001015void DwarfWriter::EmitInt16(int Value) const {
Jim Laskey063e7652006-01-17 17:31:53 +00001016 O << Asm->Data16bitsDirective;
Jim Laskey0420f2a2006-02-22 19:02:11 +00001017 PrintHex(Value & 0xFFFF);
Jim Laskey063e7652006-01-17 17:31:53 +00001018}
1019
Jim Laskeyda427fa2006-01-27 20:31:25 +00001020/// EmitInt32 - Emit a long directive and value.
Jim Laskey063e7652006-01-17 17:31:53 +00001021///
Jim Laskeyda427fa2006-01-27 20:31:25 +00001022void DwarfWriter::EmitInt32(int Value) const {
Jim Laskey063e7652006-01-17 17:31:53 +00001023 O << Asm->Data32bitsDirective;
1024 PrintHex(Value);
1025}
1026
Jim Laskeyda427fa2006-01-27 20:31:25 +00001027/// EmitInt64 - Emit a long long directive and value.
Jim Laskeyd8f77ba2006-01-27 15:20:54 +00001028///
Jim Laskeyda427fa2006-01-27 20:31:25 +00001029void DwarfWriter::EmitInt64(uint64_t Value) const {
Jim Laskeyd8f77ba2006-01-27 15:20:54 +00001030 if (Asm->Data64bitsDirective) {
1031 O << Asm->Data64bitsDirective << "0x" << std::hex << Value << std::dec;
1032 } else {
1033 const TargetData &TD = Asm->TM.getTargetData();
1034
1035 if (TD.isBigEndian()) {
Jim Laskeyda427fa2006-01-27 20:31:25 +00001036 EmitInt32(unsigned(Value >> 32)); O << "\n";
1037 EmitInt32(unsigned(Value));
Jim Laskeyd8f77ba2006-01-27 15:20:54 +00001038 } else {
Jim Laskeyda427fa2006-01-27 20:31:25 +00001039 EmitInt32(unsigned(Value)); O << "\n";
1040 EmitInt32(unsigned(Value >> 32));
Jim Laskeyd8f77ba2006-01-27 15:20:54 +00001041 }
1042 }
1043}
1044
Jim Laskey063e7652006-01-17 17:31:53 +00001045/// EmitString - Emit a string with quotes and a null terminator.
1046/// Special characters are emitted properly. (Eg. '\t')
1047void DwarfWriter::EmitString(const std::string &String) const {
1048 O << Asm->AsciiDirective
1049 << "\"";
Jim Laskey52060a02006-01-24 00:49:18 +00001050 for (unsigned i = 0, N = String.size(); i < N; ++i) {
Jim Laskey063e7652006-01-17 17:31:53 +00001051 unsigned char C = String[i];
1052
1053 if (!isascii(C) || iscntrl(C)) {
1054 switch(C) {
1055 case '\b': O << "\\b"; break;
1056 case '\f': O << "\\f"; break;
1057 case '\n': O << "\\n"; break;
1058 case '\r': O << "\\r"; break;
1059 case '\t': O << "\\t"; break;
1060 default:
1061 O << '\\';
1062 O << char('0' + (C >> 6));
1063 O << char('0' + (C >> 3));
1064 O << char('0' + (C >> 0));
1065 break;
1066 }
1067 } else if (C == '\"') {
1068 O << "\\\"";
1069 } else if (C == '\'') {
1070 O << "\\\'";
1071 } else {
1072 O << C;
1073 }
1074 }
1075 O << "\\0\"";
1076}
1077
1078/// PrintLabelName - Print label name in form used by Dwarf writer.
1079///
1080void DwarfWriter::PrintLabelName(const char *Tag, unsigned Number) const {
Jim Laskeyb2efb852006-01-04 22:28:25 +00001081 O << Asm->PrivateGlobalPrefix
1082 << "debug_"
Jim Laskey0420f2a2006-02-22 19:02:11 +00001083 << Tag;
1084 if (Number) O << Number;
Jim Laskeyb2efb852006-01-04 22:28:25 +00001085}
1086
Jim Laskey063e7652006-01-17 17:31:53 +00001087/// EmitLabel - Emit location label for internal use by Dwarf.
Jim Laskeyb2efb852006-01-04 22:28:25 +00001088///
Jim Laskey063e7652006-01-17 17:31:53 +00001089void DwarfWriter::EmitLabel(const char *Tag, unsigned Number) const {
1090 PrintLabelName(Tag, Number);
Jim Laskeyb2efb852006-01-04 22:28:25 +00001091 O << ":\n";
1092}
1093
Jim Laskeye719a7c2006-01-18 16:54:26 +00001094/// EmitReference - Emit a reference to a label.
Jim Laskey063e7652006-01-17 17:31:53 +00001095///
Jim Laskeye719a7c2006-01-18 16:54:26 +00001096void DwarfWriter::EmitReference(const char *Tag, unsigned Number) const {
Jim Laskey063e7652006-01-17 17:31:53 +00001097 if (AddressSize == 4)
1098 O << Asm->Data32bitsDirective;
1099 else
1100 O << Asm->Data64bitsDirective;
1101
1102 PrintLabelName(Tag, Number);
1103}
Jim Laskey73683212006-01-21 00:59:54 +00001104void DwarfWriter::EmitReference(const std::string &Name) const {
Jim Laskeyd18e2892006-01-20 20:34:06 +00001105 if (AddressSize == 4)
1106 O << Asm->Data32bitsDirective;
1107 else
1108 O << Asm->Data64bitsDirective;
1109
1110 O << Name;
1111}
Jim Laskey063e7652006-01-17 17:31:53 +00001112
1113/// EmitDifference - Emit an label difference as sizeof(pointer) value. Some
1114/// assemblers do not accept absolute expressions with data directives, so there
1115/// is an option (needsSet) to use an intermediary 'set' expression.
Jim Laskeyd18e2892006-01-20 20:34:06 +00001116void DwarfWriter::EmitDifference(const char *TagHi, unsigned NumberHi,
1117 const char *TagLo, unsigned NumberLo) const {
Jim Laskey063e7652006-01-17 17:31:53 +00001118 if (needsSet) {
1119 static unsigned SetCounter = 0;
Jim Laskeyd18e2892006-01-20 20:34:06 +00001120
Jim Laskey063e7652006-01-17 17:31:53 +00001121 O << "\t.set\t";
1122 PrintLabelName("set", SetCounter);
1123 O << ",";
Jim Laskeyd18e2892006-01-20 20:34:06 +00001124 PrintLabelName(TagHi, NumberHi);
Jim Laskey063e7652006-01-17 17:31:53 +00001125 O << "-";
Jim Laskeyd18e2892006-01-20 20:34:06 +00001126 PrintLabelName(TagLo, NumberLo);
Jim Laskey063e7652006-01-17 17:31:53 +00001127 O << "\n";
1128
1129 if (AddressSize == sizeof(int32_t))
1130 O << Asm->Data32bitsDirective;
1131 else
1132 O << Asm->Data64bitsDirective;
1133
1134 PrintLabelName("set", SetCounter);
1135
Jim Laskey52060a02006-01-24 00:49:18 +00001136 ++SetCounter;
Jim Laskey063e7652006-01-17 17:31:53 +00001137 } else {
1138 if (AddressSize == sizeof(int32_t))
1139 O << Asm->Data32bitsDirective;
1140 else
1141 O << Asm->Data64bitsDirective;
1142
Jim Laskeyd18e2892006-01-20 20:34:06 +00001143 PrintLabelName(TagHi, NumberHi);
Jim Laskey063e7652006-01-17 17:31:53 +00001144 O << "-";
Jim Laskeyd18e2892006-01-20 20:34:06 +00001145 PrintLabelName(TagLo, NumberLo);
Jim Laskey063e7652006-01-17 17:31:53 +00001146 }
1147}
1148
Jim Laskeyd18e2892006-01-20 20:34:06 +00001149/// NewAbbreviation - Add the abbreviation to the Abbreviation vector.
Jim Laskey063e7652006-01-17 17:31:53 +00001150///
Jim Laskeyd18e2892006-01-20 20:34:06 +00001151unsigned DwarfWriter::NewAbbreviation(DIEAbbrev *Abbrev) {
1152 return Abbreviations.insert(*Abbrev);
1153}
1154
1155/// NewString - Add a string to the constant pool and returns a label.
1156///
1157DWLabel DwarfWriter::NewString(const std::string &String) {
1158 unsigned StringID = StringPool.insert(String);
1159 return DWLabel("string", StringID);
1160}
1161
Jim Laskey0420f2a2006-02-22 19:02:11 +00001162/// NewBasicType - Creates a new basic type if necessary, then adds to the
1163/// owner.
1164/// FIXME - Should never be needed.
Jim Laskey92ae7402006-03-01 18:20:30 +00001165DIE *DwarfWriter::NewBasicType(DIE *Context, Type *Ty) {
Jim Laskey0420f2a2006-02-22 19:02:11 +00001166 DIE *&Slot = TypeToDieMap[Ty];
1167 if (Slot) return Slot;
1168
1169 const char *Name;
1170 unsigned Size;
1171 unsigned Encoding = 0;
1172
1173 switch (Ty->getTypeID()) {
1174 case Type::UByteTyID:
1175 Name = "unsigned char";
1176 Size = 1;
1177 Encoding = DW_ATE_unsigned_char;
1178 break;
1179 case Type::SByteTyID:
1180 Name = "char";
1181 Size = 1;
1182 Encoding = DW_ATE_signed_char;
1183 break;
1184 case Type::UShortTyID:
1185 Name = "unsigned short";
1186 Size = 2;
1187 Encoding = DW_ATE_unsigned;
1188 break;
1189 case Type::ShortTyID:
1190 Name = "short";
1191 Size = 2;
1192 Encoding = DW_ATE_signed;
1193 break;
1194 case Type::UIntTyID:
1195 Name = "unsigned int";
1196 Size = 4;
1197 Encoding = DW_ATE_unsigned;
1198 break;
1199 case Type::IntTyID:
1200 Name = "int";
1201 Size = 4;
1202 Encoding = DW_ATE_signed;
1203 break;
1204 case Type::ULongTyID:
1205 Name = "unsigned long long";
1206 Size = 7;
1207 Encoding = DW_ATE_unsigned;
1208 break;
1209 case Type::LongTyID:
1210 Name = "long long";
1211 Size = 7;
1212 Encoding = DW_ATE_signed;
1213 break;
1214 case Type::FloatTyID:
1215 Name = "float";
1216 Size = 4;
1217 Encoding = DW_ATE_float;
1218 break;
1219 case Type::DoubleTyID:
1220 Name = "double";
1221 Size = 8;
1222 Encoding = DW_ATE_float;
1223 break;
1224 default:
1225 // FIXME - handle more complex types.
1226 Name = "unknown";
1227 Size = 1;
1228 Encoding = DW_ATE_address;
1229 break;
1230 }
1231
1232 // construct the type DIE.
1233 Slot = new DIE(DW_TAG_base_type);
1234 Slot->AddString(DW_AT_name, DW_FORM_string, Name);
1235 Slot->AddUInt (DW_AT_byte_size, 0, Size);
1236 Slot->AddUInt (DW_AT_encoding, DW_FORM_data1, Encoding);
1237
Jim Laskey92ae7402006-03-01 18:20:30 +00001238 // Add to context.
1239 Context->AddChild(Slot);
Jim Laskey0420f2a2006-02-22 19:02:11 +00001240
1241 return Slot;
1242}
1243
Jim Laskeyf4afdd92006-02-23 16:58:18 +00001244/// NewType - Create a new type DIE.
1245///
Jim Laskey92ae7402006-03-01 18:20:30 +00001246DIE *DwarfWriter::NewType(DIE *Context, TypeDesc *TyDesc) {
Jim Laskey92ae7402006-03-01 18:20:30 +00001247 if (!TyDesc) return NewBasicType(Context, Type::IntTy);
1248
1249 // FIXME - Should handle other contexts that compile units.
Jim Laskey69906002006-02-24 16:46:40 +00001250
Jim Laskeyf4afdd92006-02-23 16:58:18 +00001251 // Check for pre-existence.
1252 DIE *&Slot = DescToDieMap[TyDesc];
1253 if (Slot) return Slot;
1254
1255 // Get core information.
1256 const std::string &Name = TyDesc->getName();
Jim Laskey288fe0f2006-03-01 18:13:05 +00001257 uint64_t Size = TyDesc->getSize() >> 3;
Jim Laskeyf4afdd92006-02-23 16:58:18 +00001258
Jim Laskey434b40b2006-02-23 22:37:30 +00001259 DIE *Ty = NULL;
Jim Laskeyf4afdd92006-02-23 16:58:18 +00001260
Jim Laskey434b40b2006-02-23 22:37:30 +00001261 if (BasicTypeDesc *BasicTy = dyn_cast<BasicTypeDesc>(TyDesc)) {
Jim Laskey69906002006-02-24 16:46:40 +00001262 // Fundamental types like int, float, bool
Jim Laskey434b40b2006-02-23 22:37:30 +00001263 Slot = Ty = new DIE(DW_TAG_base_type);
1264 unsigned Encoding = BasicTy->getEncoding();
1265 Ty->AddUInt (DW_AT_encoding, DW_FORM_data1, Encoding);
Jim Laskey69906002006-02-24 16:46:40 +00001266 } else if (DerivedTypeDesc *DerivedTy = dyn_cast<DerivedTypeDesc>(TyDesc)) {
Jim Laskey69906002006-02-24 16:46:40 +00001267 // Create specific DIE.
Jim Laskey9c4447a2006-03-01 20:39:36 +00001268 Slot = Ty = new DIE(DerivedTy->getTag());
Jim Laskey69906002006-02-24 16:46:40 +00001269
1270 // Map to main type, void will not have a type.
1271 if (TypeDesc *FromTy = DerivedTy->getFromType()) {
Jim Laskey92ae7402006-03-01 18:20:30 +00001272 Ty->AddDIEntry(DW_AT_type, DW_FORM_ref4, NewType(Context, FromTy));
Jim Laskey69906002006-02-24 16:46:40 +00001273 }
Jim Laskeyf8913f12006-03-01 17:53:02 +00001274 } else if (CompositeTypeDesc *CompTy = dyn_cast<CompositeTypeDesc>(TyDesc)) {
Jim Laskeyf8913f12006-03-01 17:53:02 +00001275 // Create specific DIE.
Jim Laskey9c4447a2006-03-01 20:39:36 +00001276 Slot = Ty = new DIE(CompTy->getTag());
Jim Laskeyf8913f12006-03-01 17:53:02 +00001277 std::vector<DebugInfoDesc *> &Elements = CompTy->getElements();
1278
1279 switch (CompTy->getTag()) {
Jim Laskey9c4447a2006-03-01 20:39:36 +00001280 case DW_TAG_array_type: {
Jim Laskeyf8913f12006-03-01 17:53:02 +00001281 // Add element type.
1282 if (TypeDesc *FromTy = CompTy->getFromType()) {
Jim Laskey92ae7402006-03-01 18:20:30 +00001283 Ty->AddDIEntry(DW_AT_type, DW_FORM_ref4, NewType(Context, FromTy));
Jim Laskeyf8913f12006-03-01 17:53:02 +00001284 }
1285 // Don't emit size attribute.
1286 Size = 0;
1287
1288 // Construct an anonymous type for index type.
1289 DIE *IndexTy = new DIE(DW_TAG_base_type);
1290 IndexTy->AddUInt(DW_AT_byte_size, 0, 4);
1291 IndexTy->AddUInt(DW_AT_encoding, DW_FORM_data1, DW_ATE_signed);
1292 // Add to context.
Jim Laskey92ae7402006-03-01 18:20:30 +00001293 Context->AddChild(IndexTy);
Jim Laskeyf8913f12006-03-01 17:53:02 +00001294
1295 // Add subranges to array type.
1296 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1297 SubrangeDesc *SRD = cast<SubrangeDesc>(Elements[i]);
1298 int64_t Lo = SRD->getLo();
1299 int64_t Hi = SRD->getHi();
1300 DIE *Subrange = new DIE(DW_TAG_subrange_type);
1301
1302 // If a range is available.
1303 if (Lo != Hi) {
1304 Subrange->AddDIEntry(DW_AT_type, DW_FORM_ref4, IndexTy);
1305 // Only add low if non-zero.
Jim Laskey6a3eb012006-03-01 23:52:37 +00001306 if (Lo) Subrange->AddSInt(DW_AT_lower_bound, 0, Lo);
1307 Subrange->AddSInt(DW_AT_upper_bound, 0, Hi);
Jim Laskeyf8913f12006-03-01 17:53:02 +00001308 }
1309 Ty->AddChild(Subrange);
1310 }
1311
1312 break;
1313 }
Jim Laskeyf01e5472006-03-03 15:06:57 +00001314 case DW_TAG_structure_type:
Jim Laskey9c4447a2006-03-01 20:39:36 +00001315 case DW_TAG_union_type: {
Jim Laskeyf01e5472006-03-03 15:06:57 +00001316 // FIXME - this is just the basics.
1317 // Add elements to structure type.
1318 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1319 DerivedTypeDesc *MemberDesc = cast<DerivedTypeDesc>(Elements[i]);
Jim Laskeyb80af6f2006-03-03 21:00:14 +00001320
1321 // Extract the basic information.
Jim Laskeyf01e5472006-03-03 15:06:57 +00001322 const std::string &Name = MemberDesc->getName();
1323 unsigned Line = MemberDesc->getLine();
1324 TypeDesc *MemTy = MemberDesc->getFromType();
1325 uint64_t Size = MemberDesc->getSize();
1326 uint64_t Offset = MemberDesc->getOffset();
1327
Jim Laskeyb80af6f2006-03-03 21:00:14 +00001328 // Construct member die.
Jim Laskeyf01e5472006-03-03 15:06:57 +00001329 DIE *Member = new DIE(DW_TAG_member);
Jim Laskeyb80af6f2006-03-03 21:00:14 +00001330
1331 // Add details.
Jim Laskeyf01e5472006-03-03 15:06:57 +00001332 if (!Name.empty()) Member->AddString(DW_AT_name, DW_FORM_string, Name);
1333 if (CompileUnitDesc *File = MemberDesc->getFile()) {
1334 CompileUnit *FileUnit = FindCompileUnit(File);
1335 unsigned FileID = FileUnit->getID();
Jim Laskey20c3ed82006-03-07 15:51:33 +00001336 int Line = MemberDesc->getLine();
Jim Laskeyf01e5472006-03-03 15:06:57 +00001337 Member->AddUInt(DW_AT_decl_file, 0, FileID);
1338 Member->AddUInt(DW_AT_decl_line, 0, Line);
1339 }
Jim Laskeyb80af6f2006-03-03 21:00:14 +00001340
Jim Laskey20c3ed82006-03-07 15:51:33 +00001341 // FIXME - Bitfields not quite right but getting there.
1342 uint64_t ByteSize = Size;
1343 uint64_t ByteOffset = Offset;
1344
Jim Laskeyf01e5472006-03-03 15:06:57 +00001345 if (TypeDesc *FromTy = MemberDesc->getFromType()) {
1346 Member->AddDIEntry(DW_AT_type, DW_FORM_ref4,
1347 NewType(Context, FromTy));
Jim Laskey20c3ed82006-03-07 15:51:33 +00001348 ByteSize = FromTy->getSize();
1349 }
1350
1351 if (ByteSize != Size) {
1352 ByteOffset -= Offset % ByteSize;
1353 Member->AddUInt(DW_AT_byte_size, 0, ByteSize >> 3);
1354 Member->AddUInt(DW_AT_bit_size, 0, Size % ByteSize);
1355 Member->AddUInt(DW_AT_bit_offset, 0, Offset - ByteOffset);
Jim Laskeyf01e5472006-03-03 15:06:57 +00001356 }
Jim Laskeyb80af6f2006-03-03 21:00:14 +00001357
1358 // Add computation for offset.
1359 DIEBlock *Block = new DIEBlock();
1360 Block->AddUInt(DW_FORM_data1, DW_OP_plus_uconst);
Jim Laskey20c3ed82006-03-07 15:51:33 +00001361 Block->AddUInt(DW_FORM_udata, ByteOffset >> 3);
Jim Laskeyb80af6f2006-03-03 21:00:14 +00001362 Block->ComputeSize(*this);
1363 Member->AddBlock(DW_AT_data_member_location, 0, Block);
1364
Jim Laskeyf01e5472006-03-03 15:06:57 +00001365 Ty->AddChild(Member);
1366 }
Jim Laskeyf8913f12006-03-01 17:53:02 +00001367 break;
1368 }
Jim Laskey9c4447a2006-03-01 20:39:36 +00001369 case DW_TAG_enumeration_type: {
Jim Laskey6a3eb012006-03-01 23:52:37 +00001370 // Add enumerators to enumeration type.
1371 for(unsigned i = 0, N = Elements.size(); i < N; ++i) {
1372 EnumeratorDesc *ED = cast<EnumeratorDesc>(Elements[i]);
1373 const std::string &Name = ED->getName();
1374 int64_t Value = ED->getValue();
1375 DIE *Enumerator = new DIE(DW_TAG_enumerator);
1376 Enumerator->AddString(DW_AT_name, DW_FORM_string, Name);
1377 Enumerator->AddSInt(DW_AT_const_value, DW_FORM_sdata, Value);
1378 Ty->AddChild(Enumerator);
1379 }
1380
Jim Laskeyf8913f12006-03-01 17:53:02 +00001381 break;
1382 }
1383 default: break;
1384 }
Jim Laskeyf4afdd92006-02-23 16:58:18 +00001385 }
Jim Laskey434b40b2006-02-23 22:37:30 +00001386
1387 assert(Ty && "Type not supported yet");
Jim Laskeyf4afdd92006-02-23 16:58:18 +00001388
Jim Laskey69906002006-02-24 16:46:40 +00001389 // Add size if non-zero (derived types don't have a size.)
Jim Laskey434b40b2006-02-23 22:37:30 +00001390 if (Size) Ty->AddUInt(DW_AT_byte_size, 0, Size);
Jim Laskey69906002006-02-24 16:46:40 +00001391 // Add name if not anonymous or intermediate type.
Jim Laskey434b40b2006-02-23 22:37:30 +00001392 if (!Name.empty()) Ty->AddString(DW_AT_name, DW_FORM_string, Name);
Jim Laskey69906002006-02-24 16:46:40 +00001393 // Add source line info if present.
1394 if (CompileUnitDesc *File = TyDesc->getFile()) {
Jim Laskeybd761842006-02-27 17:27:12 +00001395 CompileUnit *FileUnit = FindCompileUnit(File);
1396 unsigned FileID = FileUnit->getID();
Jim Laskey69906002006-02-24 16:46:40 +00001397 int Line = TyDesc->getLine();
1398 Ty->AddUInt(DW_AT_decl_file, 0, FileID);
1399 Ty->AddUInt(DW_AT_decl_line, 0, Line);
1400 }
Jim Laskey434b40b2006-02-23 22:37:30 +00001401
Jim Laskeyf4afdd92006-02-23 16:58:18 +00001402 // Add to context owner.
Jim Laskey92ae7402006-03-01 18:20:30 +00001403 Context->AddChild(Ty);
Jim Laskeyf4afdd92006-02-23 16:58:18 +00001404
1405 return Slot;
1406}
1407
Jim Laskeybd761842006-02-27 17:27:12 +00001408/// NewCompileUnit - Create new compile unit and it's die.
Jim Laskey063e7652006-01-17 17:31:53 +00001409///
Jim Laskeybd761842006-02-27 17:27:12 +00001410CompileUnit *DwarfWriter::NewCompileUnit(CompileUnitDesc *UnitDesc,
1411 unsigned ID) {
1412 // Construct debug information entry.
1413 DIE *Die = new DIE(DW_TAG_compile_unit);
1414 Die->AddLabel (DW_AT_stmt_list, DW_FORM_data4, DWLabel("line", 0));
1415 Die->AddLabel (DW_AT_high_pc, DW_FORM_addr, DWLabel("text_end", 0));
1416 Die->AddLabel (DW_AT_low_pc, DW_FORM_addr, DWLabel("text_begin", 0));
1417 Die->AddString(DW_AT_producer, DW_FORM_string, UnitDesc->getProducer());
1418 Die->AddUInt (DW_AT_language, DW_FORM_data1, UnitDesc->getLanguage());
1419 Die->AddString(DW_AT_name, DW_FORM_string, UnitDesc->getFileName());
1420 Die->AddString(DW_AT_comp_dir, DW_FORM_string, UnitDesc->getDirectory());
1421
1422 // Add die to descriptor map.
1423 DescToDieMap[UnitDesc] = Die;
1424
1425 // Construct compile unit.
1426 CompileUnit *Unit = new CompileUnit(UnitDesc, ID, Die);
1427
1428 // Add Unit to compile unit map.
1429 DescToUnitMap[UnitDesc] = Unit;
1430
1431 return Unit;
1432}
Jim Laskey0420f2a2006-02-22 19:02:11 +00001433
Jim Laskeybd761842006-02-27 17:27:12 +00001434/// FindCompileUnit - Get the compile unit for the given descriptor.
1435///
1436CompileUnit *DwarfWriter::FindCompileUnit(CompileUnitDesc *UnitDesc) {
1437 CompileUnit *Unit = DescToUnitMap[UnitDesc];
1438 assert(Unit && "Missing compile unit.");
Jim Laskeyd18e2892006-01-20 20:34:06 +00001439 return Unit;
Jim Laskey063e7652006-01-17 17:31:53 +00001440}
1441
Jim Laskey0420f2a2006-02-22 19:02:11 +00001442/// NewGlobalVariable - Add a new global variable DIE.
1443///
1444DIE *DwarfWriter::NewGlobalVariable(GlobalVariableDesc *GVD) {
1445 // Check for pre-existence.
1446 DIE *&Slot = DescToDieMap[GVD];
1447 if (Slot) return Slot;
1448
1449 // Get the compile unit context.
Jim Laskeybd761842006-02-27 17:27:12 +00001450 CompileUnitDesc *UnitDesc = static_cast<CompileUnitDesc *>(GVD->getContext());
1451 CompileUnit *Unit = FindCompileUnit(UnitDesc);
Jim Laskey0420f2a2006-02-22 19:02:11 +00001452 // Get the global variable itself.
1453 GlobalVariable *GV = GVD->getGlobalVariable();
1454 // Generate the mangled name.
1455 std::string MangledName = Asm->Mang->getValueName(GV);
1456
1457 // Gather the details (simplify add attribute code.)
1458 const std::string &Name = GVD->getName();
Jim Laskeybd761842006-02-27 17:27:12 +00001459 unsigned FileID = Unit->getID();
Jim Laskey0420f2a2006-02-22 19:02:11 +00001460 unsigned Line = GVD->getLine();
1461
Jim Laskeyf4afdd92006-02-23 16:58:18 +00001462 // Get the global's type.
Jim Laskey92ae7402006-03-01 18:20:30 +00001463 DIE *Type = NewType(Unit->getDie(), GVD->getTypeDesc());
Jim Laskeyf4afdd92006-02-23 16:58:18 +00001464
1465 // Create the globale variable DIE.
Jim Laskey0420f2a2006-02-22 19:02:11 +00001466 DIE *VariableDie = new DIE(DW_TAG_variable);
1467 VariableDie->AddString (DW_AT_name, DW_FORM_string, Name);
1468 VariableDie->AddUInt (DW_AT_decl_file, 0, FileID);
1469 VariableDie->AddUInt (DW_AT_decl_line, 0, Line);
1470 VariableDie->AddDIEntry (DW_AT_type, DW_FORM_ref4, Type);
1471 VariableDie->AddUInt (DW_AT_external, DW_FORM_flag, 1);
Jim Laskeyb80af6f2006-03-03 21:00:14 +00001472
1473 DIEBlock *Block = new DIEBlock();
1474 Block->AddUInt(DW_FORM_data1, DW_OP_addr);
1475 Block->AddObjectLabel(DW_FORM_udata, MangledName);
1476 Block->ComputeSize(*this);
1477 VariableDie->AddBlock(DW_AT_location, 0, Block);
Jim Laskey0420f2a2006-02-22 19:02:11 +00001478
1479 // Add to map.
1480 Slot = VariableDie;
1481
1482 // Add to context owner.
Jim Laskeybd761842006-02-27 17:27:12 +00001483 Unit->getDie()->AddChild(VariableDie);
Jim Laskey0420f2a2006-02-22 19:02:11 +00001484
1485 // Expose as global.
Jim Laskeybd761842006-02-27 17:27:12 +00001486 // FIXME - need to check external flag.
1487 Unit->AddGlobal(Name, VariableDie);
Jim Laskey0420f2a2006-02-22 19:02:11 +00001488
1489 return VariableDie;
1490}
1491
1492/// NewSubprogram - Add a new subprogram DIE.
1493///
1494DIE *DwarfWriter::NewSubprogram(SubprogramDesc *SPD) {
1495 // Check for pre-existence.
1496 DIE *&Slot = DescToDieMap[SPD];
1497 if (Slot) return Slot;
1498
1499 // Get the compile unit context.
Jim Laskeybd761842006-02-27 17:27:12 +00001500 CompileUnitDesc *UnitDesc = static_cast<CompileUnitDesc *>(SPD->getContext());
1501 CompileUnit *Unit = FindCompileUnit(UnitDesc);
Jim Laskey0420f2a2006-02-22 19:02:11 +00001502
1503 // Gather the details (simplify add attribute code.)
1504 const std::string &Name = SPD->getName();
Jim Laskeybd761842006-02-27 17:27:12 +00001505 unsigned FileID = Unit->getID();
Jim Laskey0420f2a2006-02-22 19:02:11 +00001506 // FIXME - faking the line for the time being.
1507 unsigned Line = 1;
1508
1509 // FIXME - faking the type for the time being.
Jim Laskey92ae7402006-03-01 18:20:30 +00001510 DIE *Type = NewBasicType(Unit->getDie(), Type::IntTy);
Jim Laskey0420f2a2006-02-22 19:02:11 +00001511
Jim Laskey8a8e9752006-02-27 20:37:42 +00001512 DIE *SubprogramDie = new DIE(DW_TAG_subprogram);
Jim Laskey0420f2a2006-02-22 19:02:11 +00001513 SubprogramDie->AddString (DW_AT_name, DW_FORM_string, Name);
1514 SubprogramDie->AddUInt (DW_AT_decl_file, 0, FileID);
1515 SubprogramDie->AddUInt (DW_AT_decl_line, 0, Line);
1516 SubprogramDie->AddDIEntry (DW_AT_type, DW_FORM_ref4, Type);
1517 SubprogramDie->AddUInt (DW_AT_external, DW_FORM_flag, 1);
1518
1519 // Add to map.
1520 Slot = SubprogramDie;
1521
1522 // Add to context owner.
Jim Laskeybd761842006-02-27 17:27:12 +00001523 Unit->getDie()->AddChild(SubprogramDie);
Jim Laskey0420f2a2006-02-22 19:02:11 +00001524
1525 // Expose as global.
Jim Laskeybd761842006-02-27 17:27:12 +00001526 Unit->AddGlobal(Name, SubprogramDie);
Jim Laskey0420f2a2006-02-22 19:02:11 +00001527
1528 return SubprogramDie;
1529}
1530
Jim Laskey063e7652006-01-17 17:31:53 +00001531/// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
1532/// tools to recognize the object file contains Dwarf information.
Jim Laskeyb2efb852006-01-04 22:28:25 +00001533///
1534void DwarfWriter::EmitInitial() const {
Jim Laskey063e7652006-01-17 17:31:53 +00001535 // Dwarf sections base addresses.
Jim Laskey0420f2a2006-02-22 19:02:11 +00001536 Asm->SwitchSection(DwarfFrameSection, 0);
1537 EmitLabel("section_frame", 0);
Jim Laskeya7cea6f2006-01-04 13:52:30 +00001538 Asm->SwitchSection(DwarfInfoSection, 0);
Jim Laskey0420f2a2006-02-22 19:02:11 +00001539 EmitLabel("section_info", 0);
Jim Laskeya7cea6f2006-01-04 13:52:30 +00001540 EmitLabel("info", 0);
Jim Laskey0420f2a2006-02-22 19:02:11 +00001541 Asm->SwitchSection(DwarfAbbrevSection, 0);
1542 EmitLabel("section_abbrev", 0);
1543 EmitLabel("abbrev", 0);
1544 Asm->SwitchSection(DwarfARangesSection, 0);
1545 EmitLabel("section_aranges", 0);
1546 Asm->SwitchSection(DwarfMacInfoSection, 0);
1547 EmitLabel("section_macinfo", 0);
Jim Laskeya7cea6f2006-01-04 13:52:30 +00001548 Asm->SwitchSection(DwarfLineSection, 0);
Jim Laskey0420f2a2006-02-22 19:02:11 +00001549 EmitLabel("section_line", 0);
Jim Laskeya7cea6f2006-01-04 13:52:30 +00001550 EmitLabel("line", 0);
Jim Laskey0420f2a2006-02-22 19:02:11 +00001551 Asm->SwitchSection(DwarfLocSection, 0);
1552 EmitLabel("section_loc", 0);
1553 Asm->SwitchSection(DwarfPubNamesSection, 0);
1554 EmitLabel("section_pubnames", 0);
1555 Asm->SwitchSection(DwarfStrSection, 0);
1556 EmitLabel("section_str", 0);
1557 Asm->SwitchSection(DwarfRangesSection, 0);
1558 EmitLabel("section_ranges", 0);
1559
Jim Laskey063e7652006-01-17 17:31:53 +00001560 Asm->SwitchSection(TextSection, 0);
1561 EmitLabel("text_begin", 0);
1562 Asm->SwitchSection(DataSection, 0);
1563 EmitLabel("data_begin", 0);
Jim Laskeya7cea6f2006-01-04 13:52:30 +00001564}
1565
Jim Laskey063e7652006-01-17 17:31:53 +00001566/// EmitDIE - Recusively Emits a debug information entry.
1567///
1568void DwarfWriter::EmitDIE(DIE *Die) const {
1569 // Get the abbreviation for this DIE.
1570 unsigned AbbrevID = Die->getAbbrevID();
1571 const DIEAbbrev &Abbrev = Abbreviations[AbbrevID];
Jim Laskey0d086af2006-02-27 12:43:29 +00001572
1573 O << "\n";
Jim Laskey063e7652006-01-17 17:31:53 +00001574
1575 // Emit the code (index) for the abbreviation.
1576 EmitULEB128Bytes(AbbrevID);
1577 EOL(std::string("Abbrev [" +
1578 utostr(AbbrevID) +
Jim Laskey0d086af2006-02-27 12:43:29 +00001579 "] 0x" + utohexstr(Die->getOffset()) +
1580 ":0x" + utohexstr(Die->getSize()) + " " +
1581 TagString(Abbrev.getTag())));
Jim Laskey063e7652006-01-17 17:31:53 +00001582
1583 const std::vector<DIEValue *> &Values = Die->getValues();
Jim Laskeyd18e2892006-01-20 20:34:06 +00001584 const std::vector<DIEAbbrevData> &AbbrevData = Abbrev.getData();
Jim Laskey063e7652006-01-17 17:31:53 +00001585
1586 // Emit the DIE attribute values.
Jim Laskey52060a02006-01-24 00:49:18 +00001587 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
Jim Laskeyd18e2892006-01-20 20:34:06 +00001588 unsigned Attr = AbbrevData[i].getAttribute();
1589 unsigned Form = AbbrevData[i].getForm();
Jim Laskey063e7652006-01-17 17:31:53 +00001590 assert(Form && "Too many attributes for DIE (check abbreviation)");
1591
1592 switch (Attr) {
1593 case DW_AT_sibling: {
Jim Laskeyda427fa2006-01-27 20:31:25 +00001594 EmitInt32(Die->SiblingOffset());
Jim Laskey063e7652006-01-17 17:31:53 +00001595 break;
1596 }
1597 default: {
1598 // Emit an attribute using the defined form.
1599 Values[i]->EmitValue(*this, Form);
1600 break;
1601 }
1602 }
1603
1604 EOL(AttributeString(Attr));
1605 }
1606
1607 // Emit the DIE children if any.
1608 if (Abbrev.getChildrenFlag() == DW_CHILDREN_yes) {
1609 const std::vector<DIE *> &Children = Die->getChildren();
1610
Jim Laskey52060a02006-01-24 00:49:18 +00001611 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
Jim Laskey063e7652006-01-17 17:31:53 +00001612 // FIXME - handle sibling offsets.
1613 // FIXME - handle all DIE types.
1614 EmitDIE(Children[j]);
1615 }
1616
Jim Laskeyda427fa2006-01-27 20:31:25 +00001617 EmitInt8(0); EOL("End Of Children Mark");
Jim Laskey063e7652006-01-17 17:31:53 +00001618 }
1619}
1620
1621/// SizeAndOffsetDie - Compute the size and offset of a DIE.
1622///
Jim Laskey0420f2a2006-02-22 19:02:11 +00001623unsigned DwarfWriter::SizeAndOffsetDie(DIE *Die, unsigned Offset) {
1624 // Record the abbreviation.
1625 Die->Complete(*this);
1626
Jim Laskey063e7652006-01-17 17:31:53 +00001627 // Get the abbreviation for this DIE.
1628 unsigned AbbrevID = Die->getAbbrevID();
1629 const DIEAbbrev &Abbrev = Abbreviations[AbbrevID];
1630
1631 // Set DIE offset
1632 Die->setOffset(Offset);
1633
1634 // Start the size with the size of abbreviation code.
1635 Offset += SizeULEB128(AbbrevID);
1636
1637 const std::vector<DIEValue *> &Values = Die->getValues();
Jim Laskeyd18e2892006-01-20 20:34:06 +00001638 const std::vector<DIEAbbrevData> &AbbrevData = Abbrev.getData();
Jim Laskey063e7652006-01-17 17:31:53 +00001639
1640 // Emit the DIE attribute values.
Jim Laskey52060a02006-01-24 00:49:18 +00001641 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
Jim Laskey063e7652006-01-17 17:31:53 +00001642 // Size attribute value.
Jim Laskeyd18e2892006-01-20 20:34:06 +00001643 Offset += Values[i]->SizeOf(*this, AbbrevData[i].getForm());
Jim Laskey063e7652006-01-17 17:31:53 +00001644 }
1645
1646 // Emit the DIE children if any.
1647 if (Abbrev.getChildrenFlag() == DW_CHILDREN_yes) {
1648 const std::vector<DIE *> &Children = Die->getChildren();
1649
Jim Laskey52060a02006-01-24 00:49:18 +00001650 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
Jim Laskey063e7652006-01-17 17:31:53 +00001651 // FIXME - handle sibling offsets.
1652 // FIXME - handle all DIE types.
1653 Offset = SizeAndOffsetDie(Children[j], Offset);
1654 }
1655
1656 // End of children marker.
1657 Offset += sizeof(int8_t);
1658 }
1659
1660 Die->setSize(Offset - Die->getOffset());
1661 return Offset;
1662}
1663
1664/// SizeAndOffsets - Compute the size and offset of all the DIEs.
1665///
1666void DwarfWriter::SizeAndOffsets() {
Jim Laskey063e7652006-01-17 17:31:53 +00001667
1668 // Process each compile unit.
Jim Laskey52060a02006-01-24 00:49:18 +00001669 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) {
Jim Laskeybd761842006-02-27 17:27:12 +00001670 CompileUnit *Unit = CompileUnits[i];
1671 if (Unit->hasContent()) {
1672 // Compute size of compile unit header
1673 unsigned Offset = sizeof(int32_t) + // Length of Compilation Unit Info
1674 sizeof(int16_t) + // DWARF version number
1675 sizeof(int32_t) + // Offset Into Abbrev. Section
1676 sizeof(int8_t); // Pointer Size (in bytes)
1677
1678 SizeAndOffsetDie(Unit->getDie(), Offset);
1679 }
Jim Laskey063e7652006-01-17 17:31:53 +00001680 }
1681}
1682
1683/// EmitDebugInfo - Emit the debug info section.
1684///
1685void DwarfWriter::EmitDebugInfo() const {
1686 // Start debug info section.
1687 Asm->SwitchSection(DwarfInfoSection, 0);
1688
Jim Laskeybd761842006-02-27 17:27:12 +00001689 // Process each compile unit.
1690 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) {
1691 CompileUnit *Unit = CompileUnits[i];
1692
1693 if (Unit->hasContent()) {
1694 DIE *Die = Unit->getDie();
Jim Laskey0d086af2006-02-27 12:43:29 +00001695 // Emit the compile units header.
Jim Laskeybd761842006-02-27 17:27:12 +00001696 EmitLabel("info_begin", Unit->getID());
Jim Laskey0d086af2006-02-27 12:43:29 +00001697 // Emit size of content not including length itself
Jim Laskeybd761842006-02-27 17:27:12 +00001698 unsigned ContentSize = Die->getSize() +
Jim Laskey0d086af2006-02-27 12:43:29 +00001699 sizeof(int16_t) + // DWARF version number
1700 sizeof(int32_t) + // Offset Into Abbrev. Section
1701 sizeof(int8_t); // Pointer Size (in bytes)
1702
1703 EmitInt32(ContentSize); EOL("Length of Compilation Unit Info");
1704 EmitInt16(DWARF_VERSION); EOL("DWARF version number");
1705 EmitReference("abbrev_begin", 0); EOL("Offset Into Abbrev. Section");
1706 EmitInt8(AddressSize); EOL("Address Size (in bytes)");
1707
Jim Laskeybd761842006-02-27 17:27:12 +00001708 EmitDIE(Die);
1709 EmitLabel("info_end", Unit->getID());
Jim Laskey063e7652006-01-17 17:31:53 +00001710 }
Jim Laskey0d086af2006-02-27 12:43:29 +00001711
1712 O << "\n";
Jim Laskey063e7652006-01-17 17:31:53 +00001713 }
1714}
1715
1716/// EmitAbbreviations - Emit the abbreviation section.
1717///
1718void DwarfWriter::EmitAbbreviations() const {
Jim Laskeyd18e2892006-01-20 20:34:06 +00001719 // Check to see if it is worth the effort.
1720 if (!Abbreviations.empty()) {
1721 // Start the debug abbrev section.
1722 Asm->SwitchSection(DwarfAbbrevSection, 0);
Jim Laskey063e7652006-01-17 17:31:53 +00001723
Jim Laskeyd18e2892006-01-20 20:34:06 +00001724 EmitLabel("abbrev_begin", 0);
Jim Laskey063e7652006-01-17 17:31:53 +00001725
Jim Laskeyd18e2892006-01-20 20:34:06 +00001726 // For each abbrevation.
1727 for (unsigned AbbrevID = 1, NAID = Abbreviations.size();
Jim Laskey52060a02006-01-24 00:49:18 +00001728 AbbrevID <= NAID; ++AbbrevID) {
Jim Laskeyd18e2892006-01-20 20:34:06 +00001729 // Get abbreviation data
1730 const DIEAbbrev &Abbrev = Abbreviations[AbbrevID];
Jim Laskey063e7652006-01-17 17:31:53 +00001731
Jim Laskeyd18e2892006-01-20 20:34:06 +00001732 // Emit the abbrevations code (base 1 index.)
1733 EmitULEB128Bytes(AbbrevID); EOL("Abbreviation Code");
Jim Laskey063e7652006-01-17 17:31:53 +00001734
Jim Laskeyd18e2892006-01-20 20:34:06 +00001735 // Emit the abbreviations data.
1736 Abbrev.Emit(*this);
Jim Laskey0d086af2006-02-27 12:43:29 +00001737
1738 O << "\n";
Jim Laskey063e7652006-01-17 17:31:53 +00001739 }
Jim Laskeyd18e2892006-01-20 20:34:06 +00001740
1741 EmitLabel("abbrev_end", 0);
Jim Laskey0d086af2006-02-27 12:43:29 +00001742
1743 O << "\n";
Jim Laskey063e7652006-01-17 17:31:53 +00001744 }
1745}
1746
1747/// EmitDebugLines - Emit source line information.
1748///
1749void DwarfWriter::EmitDebugLines() const {
1750 // Minimum line delta, thus ranging from -10..(255-10).
1751 const int MinLineDelta = -(DW_LNS_fixed_advance_pc + 1);
1752 // Maximum line delta, thus ranging from -10..(255-10).
1753 const int MaxLineDelta = 255 + MinLineDelta;
1754
1755 // Start the dwarf line section.
1756 Asm->SwitchSection(DwarfLineSection, 0);
1757
1758 // Construct the section header.
1759
1760 EmitDifference("line_end", 0, "line_begin", 0);
1761 EOL("Length of Source Line Info");
1762 EmitLabel("line_begin", 0);
1763
Jim Laskeyda427fa2006-01-27 20:31:25 +00001764 EmitInt16(DWARF_VERSION); EOL("DWARF version number");
Jim Laskey063e7652006-01-17 17:31:53 +00001765
1766 EmitDifference("line_prolog_end", 0, "line_prolog_begin", 0);
1767 EOL("Prolog Length");
1768 EmitLabel("line_prolog_begin", 0);
1769
Jim Laskeyda427fa2006-01-27 20:31:25 +00001770 EmitInt8(1); EOL("Minimum Instruction Length");
Jim Laskey063e7652006-01-17 17:31:53 +00001771
Jim Laskeyda427fa2006-01-27 20:31:25 +00001772 EmitInt8(1); EOL("Default is_stmt_start flag");
Jim Laskey063e7652006-01-17 17:31:53 +00001773
Jim Laskeyda427fa2006-01-27 20:31:25 +00001774 EmitInt8(MinLineDelta); EOL("Line Base Value (Special Opcodes)");
Jim Laskey063e7652006-01-17 17:31:53 +00001775
Jim Laskeyda427fa2006-01-27 20:31:25 +00001776 EmitInt8(MaxLineDelta); EOL("Line Range Value (Special Opcodes)");
Jim Laskey063e7652006-01-17 17:31:53 +00001777
Jim Laskeyda427fa2006-01-27 20:31:25 +00001778 EmitInt8(-MinLineDelta); EOL("Special Opcode Base");
Jim Laskey063e7652006-01-17 17:31:53 +00001779
1780 // Line number standard opcode encodings argument count
Jim Laskeyda427fa2006-01-27 20:31:25 +00001781 EmitInt8(0); EOL("DW_LNS_copy arg count");
1782 EmitInt8(1); EOL("DW_LNS_advance_pc arg count");
1783 EmitInt8(1); EOL("DW_LNS_advance_line arg count");
1784 EmitInt8(1); EOL("DW_LNS_set_file arg count");
1785 EmitInt8(1); EOL("DW_LNS_set_column arg count");
1786 EmitInt8(0); EOL("DW_LNS_negate_stmt arg count");
1787 EmitInt8(0); EOL("DW_LNS_set_basic_block arg count");
1788 EmitInt8(0); EOL("DW_LNS_const_add_pc arg count");
1789 EmitInt8(1); EOL("DW_LNS_fixed_advance_pc arg count");
Jim Laskey063e7652006-01-17 17:31:53 +00001790
1791 const UniqueVector<std::string> &Directories = DebugInfo->getDirectories();
1792 const UniqueVector<SourceFileInfo> &SourceFiles = DebugInfo->getSourceFiles();
1793
1794 // Emit directories.
1795 for (unsigned DirectoryID = 1, NDID = Directories.size();
Jim Laskey52060a02006-01-24 00:49:18 +00001796 DirectoryID <= NDID; ++DirectoryID) {
Jim Laskey063e7652006-01-17 17:31:53 +00001797 EmitString(Directories[DirectoryID]); EOL("Directory");
1798 }
Jim Laskeyda427fa2006-01-27 20:31:25 +00001799 EmitInt8(0); EOL("End of directories");
Jim Laskey063e7652006-01-17 17:31:53 +00001800
1801 // Emit files.
1802 for (unsigned SourceID = 1, NSID = SourceFiles.size();
Jim Laskey52060a02006-01-24 00:49:18 +00001803 SourceID <= NSID; ++SourceID) {
Jim Laskey063e7652006-01-17 17:31:53 +00001804 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
1805 EmitString(SourceFile.getName()); EOL("Source");
1806 EmitULEB128Bytes(SourceFile.getDirectoryID()); EOL("Directory #");
1807 EmitULEB128Bytes(0); EOL("Mod date");
1808 EmitULEB128Bytes(0); EOL("File size");
1809 }
Jim Laskeyda427fa2006-01-27 20:31:25 +00001810 EmitInt8(0); EOL("End of files");
Jim Laskey063e7652006-01-17 17:31:53 +00001811
1812 EmitLabel("line_prolog_end", 0);
1813
1814 // Emit line information
1815 const std::vector<SourceLineInfo *> &LineInfos = DebugInfo->getSourceLines();
1816
1817 // Dwarf assumes we start with first line of first source file.
1818 unsigned Source = 1;
1819 unsigned Line = 1;
1820
1821 // Construct rows of the address, source, line, column matrix.
Jim Laskey52060a02006-01-24 00:49:18 +00001822 for (unsigned i = 0, N = LineInfos.size(); i < N; ++i) {
Jim Laskey063e7652006-01-17 17:31:53 +00001823 SourceLineInfo *LineInfo = LineInfos[i];
Jim Laskey0420f2a2006-02-22 19:02:11 +00001824
1825 if (DwarfVerbose) {
1826 unsigned SourceID = LineInfo->getSourceID();
1827 const SourceFileInfo &SourceFile = SourceFiles[SourceID];
1828 unsigned DirectoryID = SourceFile.getDirectoryID();
1829 O << "\t"
1830 << Asm->CommentString << " "
1831 << Directories[DirectoryID]
1832 << SourceFile.getName() << ":"
1833 << LineInfo->getLine() << "\n";
1834 }
Jim Laskey063e7652006-01-17 17:31:53 +00001835
1836 // Define the line address.
Jim Laskeyda427fa2006-01-27 20:31:25 +00001837 EmitInt8(0); EOL("Extended Op");
1838 EmitInt8(4 + 1); EOL("Op size");
1839 EmitInt8(DW_LNE_set_address); EOL("DW_LNE_set_address");
Jim Laskeye719a7c2006-01-18 16:54:26 +00001840 EmitReference("loc", i + 1); EOL("Location label");
Jim Laskey063e7652006-01-17 17:31:53 +00001841
1842 // If change of source, then switch to the new source.
1843 if (Source != LineInfo->getSourceID()) {
1844 Source = LineInfo->getSourceID();
Jim Laskeyda427fa2006-01-27 20:31:25 +00001845 EmitInt8(DW_LNS_set_file); EOL("DW_LNS_set_file");
Jim Laskeybd761842006-02-27 17:27:12 +00001846 EmitULEB128Bytes(Source); EOL("New Source");
Jim Laskey063e7652006-01-17 17:31:53 +00001847 }
1848
1849 // If change of line.
1850 if (Line != LineInfo->getLine()) {
1851 // Determine offset.
1852 int Offset = LineInfo->getLine() - Line;
1853 int Delta = Offset - MinLineDelta;
1854
1855 // Update line.
1856 Line = LineInfo->getLine();
1857
1858 // If delta is small enough and in range...
1859 if (Delta >= 0 && Delta < (MaxLineDelta - 1)) {
1860 // ... then use fast opcode.
Jim Laskeyda427fa2006-01-27 20:31:25 +00001861 EmitInt8(Delta - MinLineDelta); EOL("Line Delta");
Jim Laskey063e7652006-01-17 17:31:53 +00001862 } else {
1863 // ... otherwise use long hand.
Jim Laskeyda427fa2006-01-27 20:31:25 +00001864 EmitInt8(DW_LNS_advance_line); EOL("DW_LNS_advance_line");
Jim Laskey063e7652006-01-17 17:31:53 +00001865 EmitSLEB128Bytes(Offset); EOL("Line Offset");
Jim Laskeyda427fa2006-01-27 20:31:25 +00001866 EmitInt8(DW_LNS_copy); EOL("DW_LNS_copy");
Jim Laskey063e7652006-01-17 17:31:53 +00001867 }
1868 } else {
1869 // Copy the previous row (different address or source)
Jim Laskeyda427fa2006-01-27 20:31:25 +00001870 EmitInt8(DW_LNS_copy); EOL("DW_LNS_copy");
Jim Laskey063e7652006-01-17 17:31:53 +00001871 }
1872 }
1873
Jim Laskey0420f2a2006-02-22 19:02:11 +00001874 // Define last address.
1875 EmitInt8(0); EOL("Extended Op");
1876 EmitInt8(4 + 1); EOL("Op size");
1877 EmitInt8(DW_LNE_set_address); EOL("DW_LNE_set_address");
1878 EmitReference("text_end", 0); EOL("Location label");
1879
Jim Laskey063e7652006-01-17 17:31:53 +00001880 // Mark end of matrix.
Jim Laskeyda427fa2006-01-27 20:31:25 +00001881 EmitInt8(0); EOL("DW_LNE_end_sequence");
Jim Laskey063e7652006-01-17 17:31:53 +00001882 EmitULEB128Bytes(1); O << "\n";
Jim Laskeyda427fa2006-01-27 20:31:25 +00001883 EmitInt8(1); O << "\n";
Jim Laskey063e7652006-01-17 17:31:53 +00001884
1885 EmitLabel("line_end", 0);
Jim Laskey0d086af2006-02-27 12:43:29 +00001886
1887 O << "\n";
Jim Laskey063e7652006-01-17 17:31:53 +00001888}
Jim Laskey19ef4ef2006-01-17 20:41:40 +00001889
1890/// EmitDebugFrame - Emit visible names into a debug frame section.
1891///
1892void DwarfWriter::EmitDebugFrame() {
Jim Laskeye719a7c2006-01-18 16:54:26 +00001893 // FIXME - Should be per frame
Jim Laskey19ef4ef2006-01-17 20:41:40 +00001894}
1895
1896/// EmitDebugPubNames - Emit visible names into a debug pubnames section.
1897///
1898void DwarfWriter::EmitDebugPubNames() {
Jim Laskeybd761842006-02-27 17:27:12 +00001899 // Start the dwarf pubnames section.
1900 Asm->SwitchSection(DwarfPubNamesSection, 0);
Jim Laskeyd18e2892006-01-20 20:34:06 +00001901
Jim Laskeybd761842006-02-27 17:27:12 +00001902 // Process each compile unit.
1903 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) {
1904 CompileUnit *Unit = CompileUnits[i];
Jim Laskeyd18e2892006-01-20 20:34:06 +00001905
Jim Laskeybd761842006-02-27 17:27:12 +00001906 if (Unit->hasContent()) {
1907 EmitDifference("pubnames_end", Unit->getID(),
1908 "pubnames_begin", Unit->getID());
1909 EOL("Length of Public Names Info");
1910
1911 EmitLabel("pubnames_begin", Unit->getID());
1912
1913 EmitInt16(DWARF_VERSION); EOL("DWARF Version");
1914
1915 EmitReference("info_begin", Unit->getID());
1916 EOL("Offset of Compilation Unit Info");
Jim Laskeyd18e2892006-01-20 20:34:06 +00001917
Jim Laskeybd761842006-02-27 17:27:12 +00001918 EmitDifference("info_end", Unit->getID(), "info_begin", Unit->getID());
1919 EOL("Compilation Unit Length");
1920
1921 std::map<std::string, DIE *> &Globals = Unit->getGlobals();
1922
1923 for (std::map<std::string, DIE *>::iterator GI = Globals.begin(),
1924 GE = Globals.end();
1925 GI != GE; ++GI) {
1926 const std::string &Name = GI->first;
1927 DIE * Entity = GI->second;
1928
1929 EmitInt32(Entity->getOffset()); EOL("DIE offset");
1930 EmitString(Name); EOL("External Name");
1931 }
Jim Laskeyd18e2892006-01-20 20:34:06 +00001932
Jim Laskeybd761842006-02-27 17:27:12 +00001933 EmitInt32(0); EOL("End Mark");
1934 EmitLabel("pubnames_end", Unit->getID());
1935
1936 O << "\n";
Jim Laskeyd18e2892006-01-20 20:34:06 +00001937 }
Jim Laskeyd18e2892006-01-20 20:34:06 +00001938 }
Jim Laskey19ef4ef2006-01-17 20:41:40 +00001939}
1940
1941/// EmitDebugStr - Emit visible names into a debug str section.
1942///
1943void DwarfWriter::EmitDebugStr() {
Jim Laskeyd18e2892006-01-20 20:34:06 +00001944 // Check to see if it is worth the effort.
1945 if (!StringPool.empty()) {
1946 // Start the dwarf str section.
1947 Asm->SwitchSection(DwarfStrSection, 0);
1948
1949 // For each of strings in teh string pool.
1950 for (unsigned StringID = 1, N = StringPool.size();
Jim Laskey52060a02006-01-24 00:49:18 +00001951 StringID <= N; ++StringID) {
Jim Laskeyd18e2892006-01-20 20:34:06 +00001952 // Emit a label for reference from debug information entries.
1953 EmitLabel("string", StringID);
1954 // Emit the string itself.
1955 const std::string &String = StringPool[StringID];
1956 EmitString(String); O << "\n";
1957 }
Jim Laskey0d086af2006-02-27 12:43:29 +00001958
1959 O << "\n";
Jim Laskeyd18e2892006-01-20 20:34:06 +00001960 }
Jim Laskey19ef4ef2006-01-17 20:41:40 +00001961}
1962
1963/// EmitDebugLoc - Emit visible names into a debug loc section.
1964///
1965void DwarfWriter::EmitDebugLoc() {
Jim Laskeye719a7c2006-01-18 16:54:26 +00001966 // Start the dwarf loc section.
1967 Asm->SwitchSection(DwarfLocSection, 0);
Jim Laskey0d086af2006-02-27 12:43:29 +00001968
1969 O << "\n";
Jim Laskey19ef4ef2006-01-17 20:41:40 +00001970}
1971
1972/// EmitDebugARanges - Emit visible names into a debug aranges section.
1973///
1974void DwarfWriter::EmitDebugARanges() {
Jim Laskeye719a7c2006-01-18 16:54:26 +00001975 // Start the dwarf aranges section.
1976 Asm->SwitchSection(DwarfARangesSection, 0);
1977
1978 // FIXME - Mock up
Jim Laskeybd761842006-02-27 17:27:12 +00001979#if 0
1980 // Process each compile unit.
1981 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) {
1982 CompileUnit *Unit = CompileUnits[i];
1983
1984 if (Unit->hasContent()) {
1985 // Don't include size of length
1986 EmitInt32(0x1c); EOL("Length of Address Ranges Info");
1987
1988 EmitInt16(DWARF_VERSION); EOL("Dwarf Version");
1989
1990 EmitReference("info_begin", Unit->getID());
1991 EOL("Offset of Compilation Unit Info");
Jim Laskeye719a7c2006-01-18 16:54:26 +00001992
Jim Laskeybd761842006-02-27 17:27:12 +00001993 EmitInt8(AddressSize); EOL("Size of Address");
Jim Laskeye719a7c2006-01-18 16:54:26 +00001994
Jim Laskeybd761842006-02-27 17:27:12 +00001995 EmitInt8(0); EOL("Size of Segment Descriptor");
Jim Laskeye719a7c2006-01-18 16:54:26 +00001996
Jim Laskeybd761842006-02-27 17:27:12 +00001997 EmitInt16(0); EOL("Pad (1)");
1998 EmitInt16(0); EOL("Pad (2)");
Jim Laskeye719a7c2006-01-18 16:54:26 +00001999
Jim Laskeybd761842006-02-27 17:27:12 +00002000 // Range 1
2001 EmitReference("text_begin", 0); EOL("Address");
2002 EmitDifference("text_end", 0, "text_begin", 0); EOL("Length");
Jim Laskeye719a7c2006-01-18 16:54:26 +00002003
Jim Laskeybd761842006-02-27 17:27:12 +00002004 EmitInt32(0); EOL("EOM (1)");
2005 EmitInt32(0); EOL("EOM (2)");
2006
2007 O << "\n";
2008 }
2009 }
2010#endif
Jim Laskey19ef4ef2006-01-17 20:41:40 +00002011}
2012
2013/// EmitDebugRanges - Emit visible names into a debug ranges section.
2014///
2015void DwarfWriter::EmitDebugRanges() {
Jim Laskeye719a7c2006-01-18 16:54:26 +00002016 // Start the dwarf ranges section.
2017 Asm->SwitchSection(DwarfRangesSection, 0);
Jim Laskey0d086af2006-02-27 12:43:29 +00002018
2019 O << "\n";
Jim Laskey19ef4ef2006-01-17 20:41:40 +00002020}
2021
2022/// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
2023///
2024void DwarfWriter::EmitDebugMacInfo() {
Jim Laskeye719a7c2006-01-18 16:54:26 +00002025 // Start the dwarf macinfo section.
2026 Asm->SwitchSection(DwarfMacInfoSection, 0);
Jim Laskey0d086af2006-02-27 12:43:29 +00002027
2028 O << "\n";
Jim Laskey19ef4ef2006-01-17 20:41:40 +00002029}
Jim Laskey063e7652006-01-17 17:31:53 +00002030
Jim Laskey52060a02006-01-24 00:49:18 +00002031/// ConstructCompileUnitDIEs - Create a compile unit DIE for each source and
2032/// header file.
2033void DwarfWriter::ConstructCompileUnitDIEs() {
Jim Laskey86cbdba2006-02-06 15:33:21 +00002034 const UniqueVector<CompileUnitDesc *> CUW = DebugInfo->getCompileUnits();
Jim Laskey6e87c0e2006-01-26 21:22:49 +00002035
2036 for (unsigned i = 1, N = CUW.size(); i <= N; ++i) {
Jim Laskeybd761842006-02-27 17:27:12 +00002037 CompileUnit *Unit = NewCompileUnit(CUW[i], i);
Jim Laskey52060a02006-01-24 00:49:18 +00002038 CompileUnits.push_back(Unit);
2039 }
2040}
2041
2042/// ConstructGlobalDIEs - Create DIEs for each of the externally visible global
2043/// variables.
2044void DwarfWriter::ConstructGlobalDIEs(Module &M) {
Jim Laskey86cbdba2006-02-06 15:33:21 +00002045 std::vector<GlobalVariableDesc *> GlobalVariables =
Jim Laskey0420f2a2006-02-22 19:02:11 +00002046 DebugInfo->getAnchoredDescriptors<GlobalVariableDesc>(M);
Jim Laskeyb3e789a2006-01-26 20:21:46 +00002047
2048 for (unsigned i = 0, N = GlobalVariables.size(); i < N; ++i) {
Jim Laskey86cbdba2006-02-06 15:33:21 +00002049 GlobalVariableDesc *GVD = GlobalVariables[i];
Jim Laskey0420f2a2006-02-22 19:02:11 +00002050 NewGlobalVariable(GVD);
Jim Laskey52060a02006-01-24 00:49:18 +00002051 }
2052}
2053
Jim Laskey0420f2a2006-02-22 19:02:11 +00002054/// ConstructSubprogramDIEs - Create DIEs for each of the externally visible
2055/// subprograms.
2056void DwarfWriter::ConstructSubprogramDIEs(Module &M) {
2057 std::vector<SubprogramDesc *> Subprograms =
2058 DebugInfo->getAnchoredDescriptors<SubprogramDesc>(M);
2059
2060 for (unsigned i = 0, N = Subprograms.size(); i < N; ++i) {
2061 SubprogramDesc *SPD = Subprograms[i];
2062 NewSubprogram(SPD);
2063 }
2064}
Jim Laskey52060a02006-01-24 00:49:18 +00002065
Jim Laskey063e7652006-01-17 17:31:53 +00002066/// ShouldEmitDwarf - Determine if Dwarf declarations should be made.
Jim Laskeyb2efb852006-01-04 22:28:25 +00002067///
2068bool DwarfWriter::ShouldEmitDwarf() {
2069 // Check if debug info is present.
2070 if (!DebugInfo || !DebugInfo->hasInfo()) return false;
2071
2072 // Make sure initial declarations are made.
2073 if (!didInitial) {
2074 EmitInitial();
2075 didInitial = true;
2076 }
2077
2078 // Okay to emit.
2079 return true;
2080}
2081
Jim Laskey063e7652006-01-17 17:31:53 +00002082//===----------------------------------------------------------------------===//
Jim Laskeyd18e2892006-01-20 20:34:06 +00002083// Main entry points.
Jim Laskey063e7652006-01-17 17:31:53 +00002084//
Jim Laskey52060a02006-01-24 00:49:18 +00002085
2086DwarfWriter::DwarfWriter(std::ostream &OS, AsmPrinter *A)
2087: O(OS)
2088, Asm(A)
2089, DebugInfo(NULL)
2090, didInitial(false)
2091, CompileUnits()
2092, Abbreviations()
Jim Laskey52060a02006-01-24 00:49:18 +00002093, StringPool()
Jim Laskeybd761842006-02-27 17:27:12 +00002094, DescToUnitMap()
Jim Laskey0420f2a2006-02-22 19:02:11 +00002095, DescToDieMap()
2096, TypeToDieMap()
Jim Laskey52060a02006-01-24 00:49:18 +00002097, AddressSize(sizeof(int32_t))
2098, hasLEB128(false)
2099, hasDotLoc(false)
2100, hasDotFile(false)
2101, needsSet(false)
2102, DwarfAbbrevSection(".debug_abbrev")
2103, DwarfInfoSection(".debug_info")
2104, DwarfLineSection(".debug_line")
2105, DwarfFrameSection(".debug_frame")
2106, DwarfPubNamesSection(".debug_pubnames")
2107, DwarfPubTypesSection(".debug_pubtypes")
2108, DwarfStrSection(".debug_str")
2109, DwarfLocSection(".debug_loc")
2110, DwarfARangesSection(".debug_aranges")
2111, DwarfRangesSection(".debug_ranges")
2112, DwarfMacInfoSection(".debug_macinfo")
2113, TextSection(".text")
2114, DataSection(".data")
2115{}
2116DwarfWriter::~DwarfWriter() {
2117 for (unsigned i = 0, N = CompileUnits.size(); i < N; ++i) {
2118 delete CompileUnits[i];
Jim Laskey063e7652006-01-17 17:31:53 +00002119 }
Jim Laskey52060a02006-01-24 00:49:18 +00002120}
Jim Laskey063e7652006-01-17 17:31:53 +00002121
2122/// BeginModule - Emit all Dwarf sections that should come prior to the content.
Jim Laskeyb2efb852006-01-04 22:28:25 +00002123///
Jim Laskey52060a02006-01-24 00:49:18 +00002124void DwarfWriter::BeginModule(Module &M) {
Jim Laskeyb2efb852006-01-04 22:28:25 +00002125 if (!ShouldEmitDwarf()) return;
Jim Laskey063e7652006-01-17 17:31:53 +00002126 EOL("Dwarf Begin Module");
Jim Laskeyb2efb852006-01-04 22:28:25 +00002127}
2128
Jim Laskey063e7652006-01-17 17:31:53 +00002129/// EndModule - Emit all Dwarf sections that should come after the content.
Jim Laskeya7cea6f2006-01-04 13:52:30 +00002130///
Jim Laskey52060a02006-01-24 00:49:18 +00002131void DwarfWriter::EndModule(Module &M) {
Jim Laskeyb2efb852006-01-04 22:28:25 +00002132 if (!ShouldEmitDwarf()) return;
Jim Laskey063e7652006-01-17 17:31:53 +00002133 EOL("Dwarf End Module");
2134
2135 // Standard sections final addresses.
Jim Laskeye719a7c2006-01-18 16:54:26 +00002136 Asm->SwitchSection(TextSection, 0);
Jim Laskey063e7652006-01-17 17:31:53 +00002137 EmitLabel("text_end", 0);
Jim Laskeye719a7c2006-01-18 16:54:26 +00002138 Asm->SwitchSection(DataSection, 0);
Jim Laskey063e7652006-01-17 17:31:53 +00002139 EmitLabel("data_end", 0);
Jim Laskeyd18e2892006-01-20 20:34:06 +00002140
Jim Laskey52060a02006-01-24 00:49:18 +00002141 // Create all the compile unit DIEs.
2142 ConstructCompileUnitDIEs();
2143
2144 // Create DIEs for each of the externally visible global variables.
2145 ConstructGlobalDIEs(M);
Jim Laskey063e7652006-01-17 17:31:53 +00002146
Jim Laskey0420f2a2006-02-22 19:02:11 +00002147 // Create DIEs for each of the externally visible subprograms.
2148 ConstructSubprogramDIEs(M);
2149
Jim Laskey063e7652006-01-17 17:31:53 +00002150 // Compute DIE offsets and sizes.
2151 SizeAndOffsets();
2152
2153 // Emit all the DIEs into a debug info section
2154 EmitDebugInfo();
2155
2156 // Corresponding abbreviations into a abbrev section.
2157 EmitAbbreviations();
2158
2159 // Emit source line correspondence into a debug line section.
2160 EmitDebugLines();
Jim Laskey19ef4ef2006-01-17 20:41:40 +00002161
2162 // Emit info into a debug frame section.
Jim Laskey0d086af2006-02-27 12:43:29 +00002163 // EmitDebugFrame();
Jim Laskey19ef4ef2006-01-17 20:41:40 +00002164
2165 // Emit info into a debug pubnames section.
2166 EmitDebugPubNames();
2167
Jim Laskey19ef4ef2006-01-17 20:41:40 +00002168 // Emit info into a debug str section.
2169 EmitDebugStr();
2170
2171 // Emit info into a debug loc section.
2172 EmitDebugLoc();
2173
2174 // Emit info into a debug aranges section.
2175 EmitDebugARanges();
2176
2177 // Emit info into a debug ranges section.
2178 EmitDebugRanges();
2179
2180 // Emit info into a debug macinfo section.
2181 EmitDebugMacInfo();
Jim Laskeya7cea6f2006-01-04 13:52:30 +00002182}
2183
Jim Laskeye719a7c2006-01-18 16:54:26 +00002184/// BeginFunction - Gather pre-function debug information.
Jim Laskeya7cea6f2006-01-04 13:52:30 +00002185///
Jim Laskey52060a02006-01-24 00:49:18 +00002186void DwarfWriter::BeginFunction(MachineFunction &MF) {
Jim Laskeyb2efb852006-01-04 22:28:25 +00002187 if (!ShouldEmitDwarf()) return;
Jim Laskey063e7652006-01-17 17:31:53 +00002188 EOL("Dwarf Begin Function");
Jim Laskeya7cea6f2006-01-04 13:52:30 +00002189}
2190
Jim Laskeye719a7c2006-01-18 16:54:26 +00002191/// EndFunction - Gather and emit post-function debug information.
Jim Laskeya7cea6f2006-01-04 13:52:30 +00002192///
Jim Laskey52060a02006-01-24 00:49:18 +00002193void DwarfWriter::EndFunction(MachineFunction &MF) {
Jim Laskeyb2efb852006-01-04 22:28:25 +00002194 if (!ShouldEmitDwarf()) return;
Jim Laskey063e7652006-01-17 17:31:53 +00002195 EOL("Dwarf End Function");
Jim Laskeya7cea6f2006-01-04 13:52:30 +00002196}