90221a15f00971d1911bb43de6a5ed392625fcbc
[oota-llvm.git] / lib / MC / MCDwarf.cpp
1 //===- lib/MC/MCDwarf.cpp - MCDwarf implementation ------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9
10 #include "llvm/MC/MCDwarf.h"
11 #include "llvm/ADT/Hashing.h"
12 #include "llvm/ADT/SmallString.h"
13 #include "llvm/ADT/Twine.h"
14 #include "llvm/Config/config.h"
15 #include "llvm/MC/MCAsmInfo.h"
16 #include "llvm/MC/MCContext.h"
17 #include "llvm/MC/MCExpr.h"
18 #include "llvm/MC/MCObjectFileInfo.h"
19 #include "llvm/MC/MCObjectWriter.h"
20 #include "llvm/MC/MCRegisterInfo.h"
21 #include "llvm/MC/MCStreamer.h"
22 #include "llvm/MC/MCSymbol.h"
23 #include "llvm/Support/Debug.h"
24 #include "llvm/Support/ErrorHandling.h"
25 #include "llvm/Support/LEB128.h"
26 #include "llvm/Support/Path.h"
27 #include "llvm/Support/SourceMgr.h"
28 #include "llvm/Support/raw_ostream.h"
29 using namespace llvm;
30
31 // Given a special op, return the address skip amount (in units of
32 // DWARF2_LINE_MIN_INSN_LENGTH.
33 #define SPECIAL_ADDR(op) (((op) - DWARF2_LINE_OPCODE_BASE)/DWARF2_LINE_RANGE)
34
35 // The maximum address skip amount that can be encoded with a special op.
36 #define MAX_SPECIAL_ADDR_DELTA         SPECIAL_ADDR(255)
37
38 // First special line opcode - leave room for the standard opcodes.
39 // Note: If you want to change this, you'll have to update the
40 // "standard_opcode_lengths" table that is emitted in DwarfFileTable::Emit().
41 #define DWARF2_LINE_OPCODE_BASE         13
42
43 // Minimum line offset in a special line info. opcode.  This value
44 // was chosen to give a reasonable range of values.
45 #define DWARF2_LINE_BASE                -5
46
47 // Range of line offsets in a special line info. opcode.
48 #define DWARF2_LINE_RANGE               14
49
50 // Define the architecture-dependent minimum instruction length (in bytes).
51 // This value should be rather too small than too big.
52 #define DWARF2_LINE_MIN_INSN_LENGTH     1
53
54 // Note: when DWARF2_LINE_MIN_INSN_LENGTH == 1 which is the current setting,
55 // this routine is a nop and will be optimized away.
56 static inline uint64_t ScaleAddrDelta(uint64_t AddrDelta) {
57   if (DWARF2_LINE_MIN_INSN_LENGTH == 1)
58     return AddrDelta;
59   if (AddrDelta % DWARF2_LINE_MIN_INSN_LENGTH != 0) {
60     // TODO: report this error, but really only once.
61     ;
62   }
63   return AddrDelta / DWARF2_LINE_MIN_INSN_LENGTH;
64 }
65
66 //
67 // This is called when an instruction is assembled into the specified section
68 // and if there is information from the last .loc directive that has yet to have
69 // a line entry made for it is made.
70 //
71 void MCLineEntry::Make(MCStreamer *MCOS, const MCSection *Section) {
72   if (!MCOS->getContext().getDwarfLocSeen())
73     return;
74
75   // Create a symbol at in the current section for use in the line entry.
76   MCSymbol *LineSym = MCOS->getContext().CreateTempSymbol();
77   // Set the value of the symbol to use for the MCLineEntry.
78   MCOS->EmitLabel(LineSym);
79
80   // Get the current .loc info saved in the context.
81   const MCDwarfLoc &DwarfLoc = MCOS->getContext().getCurrentDwarfLoc();
82
83   // Create a (local) line entry with the symbol and the current .loc info.
84   MCLineEntry LineEntry(LineSym, DwarfLoc);
85
86   // clear DwarfLocSeen saying the current .loc info is now used.
87   MCOS->getContext().ClearDwarfLocSeen();
88
89   // Get the MCLineSection for this section, if one does not exist for this
90   // section create it.
91   const DenseMap<const MCSection *, MCLineSection *> &MCLineSections =
92     MCOS->getContext().getMCLineSections();
93   MCLineSection *LineSection = MCLineSections.lookup(Section);
94   if (!LineSection) {
95     // Create a new MCLineSection.  This will be deleted after the dwarf line
96     // table is created using it by iterating through the MCLineSections
97     // DenseMap.
98     LineSection = new MCLineSection;
99     // Save a pointer to the new LineSection into the MCLineSections DenseMap.
100     MCOS->getContext().addMCLineSection(Section, LineSection);
101   }
102
103   // Add the line entry to this section's entries.
104   LineSection->addLineEntry(LineEntry,
105                             MCOS->getContext().getDwarfCompileUnitID());
106 }
107
108 //
109 // This helper routine returns an expression of End - Start + IntVal .
110 //
111 static inline const MCExpr *MakeStartMinusEndExpr(const MCStreamer &MCOS,
112                                                   const MCSymbol &Start,
113                                                   const MCSymbol &End,
114                                                   int IntVal) {
115   MCSymbolRefExpr::VariantKind Variant = MCSymbolRefExpr::VK_None;
116   const MCExpr *Res =
117     MCSymbolRefExpr::Create(&End, Variant, MCOS.getContext());
118   const MCExpr *RHS =
119     MCSymbolRefExpr::Create(&Start, Variant, MCOS.getContext());
120   const MCExpr *Res1 =
121     MCBinaryExpr::Create(MCBinaryExpr::Sub, Res, RHS, MCOS.getContext());
122   const MCExpr *Res2 =
123     MCConstantExpr::Create(IntVal, MCOS.getContext());
124   const MCExpr *Res3 =
125     MCBinaryExpr::Create(MCBinaryExpr::Sub, Res1, Res2, MCOS.getContext());
126   return Res3;
127 }
128
129 //
130 // This emits the Dwarf line table for the specified section from the entries
131 // in the LineSection.
132 //
133 static inline void EmitDwarfLineTable(MCStreamer *MCOS,
134                                       const MCSection *Section,
135                                       const MCLineSection *LineSection,
136                                       unsigned CUID) {
137   // This LineSection does not contain any LineEntry for the given Compile Unit.
138   if (!LineSection->containEntriesForID(CUID))
139     return;
140
141   unsigned FileNum = 1;
142   unsigned LastLine = 1;
143   unsigned Column = 0;
144   unsigned Flags = DWARF2_LINE_DEFAULT_IS_STMT ? DWARF2_FLAG_IS_STMT : 0;
145   unsigned Isa = 0;
146   MCSymbol *LastLabel = NULL;
147
148   // Loop through each MCLineEntry and encode the dwarf line number table.
149   for (MCLineSection::const_iterator
150          it = LineSection->getMCLineEntries(CUID).begin(),
151          ie = LineSection->getMCLineEntries(CUID).end(); it != ie; ++it) {
152
153     if (FileNum != it->getFileNum()) {
154       FileNum = it->getFileNum();
155       MCOS->EmitIntValue(dwarf::DW_LNS_set_file, 1);
156       MCOS->EmitULEB128IntValue(FileNum);
157     }
158     if (Column != it->getColumn()) {
159       Column = it->getColumn();
160       MCOS->EmitIntValue(dwarf::DW_LNS_set_column, 1);
161       MCOS->EmitULEB128IntValue(Column);
162     }
163     if (Isa != it->getIsa()) {
164       Isa = it->getIsa();
165       MCOS->EmitIntValue(dwarf::DW_LNS_set_isa, 1);
166       MCOS->EmitULEB128IntValue(Isa);
167     }
168     if ((it->getFlags() ^ Flags) & DWARF2_FLAG_IS_STMT) {
169       Flags = it->getFlags();
170       MCOS->EmitIntValue(dwarf::DW_LNS_negate_stmt, 1);
171     }
172     if (it->getFlags() & DWARF2_FLAG_BASIC_BLOCK)
173       MCOS->EmitIntValue(dwarf::DW_LNS_set_basic_block, 1);
174     if (it->getFlags() & DWARF2_FLAG_PROLOGUE_END)
175       MCOS->EmitIntValue(dwarf::DW_LNS_set_prologue_end, 1);
176     if (it->getFlags() & DWARF2_FLAG_EPILOGUE_BEGIN)
177       MCOS->EmitIntValue(dwarf::DW_LNS_set_epilogue_begin, 1);
178
179     int64_t LineDelta = static_cast<int64_t>(it->getLine()) - LastLine;
180     MCSymbol *Label = it->getLabel();
181
182     // At this point we want to emit/create the sequence to encode the delta in
183     // line numbers and the increment of the address from the previous Label
184     // and the current Label.
185     const MCAsmInfo &asmInfo = MCOS->getContext().getAsmInfo();
186     MCOS->EmitDwarfAdvanceLineAddr(LineDelta, LastLabel, Label,
187                                    asmInfo.getPointerSize());
188
189     LastLine = it->getLine();
190     LastLabel = Label;
191   }
192
193   // Emit a DW_LNE_end_sequence for the end of the section.
194   // Using the pointer Section create a temporary label at the end of the
195   // section and use that and the LastLabel to compute the address delta
196   // and use INT64_MAX as the line delta which is the signal that this is
197   // actually a DW_LNE_end_sequence.
198
199   // Switch to the section to be able to create a symbol at its end.
200   // TODO: keep track of the last subsection so that this symbol appears in the
201   // correct place.
202   MCOS->SwitchSection(Section);
203
204   MCContext &context = MCOS->getContext();
205   // Create a symbol at the end of the section.
206   MCSymbol *SectionEnd = context.CreateTempSymbol();
207   // Set the value of the symbol, as we are at the end of the section.
208   MCOS->EmitLabel(SectionEnd);
209
210   // Switch back the dwarf line section.
211   MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfLineSection());
212
213   const MCAsmInfo &asmInfo = MCOS->getContext().getAsmInfo();
214   MCOS->EmitDwarfAdvanceLineAddr(INT64_MAX, LastLabel, SectionEnd,
215                                  asmInfo.getPointerSize());
216 }
217
218 //
219 // This emits the Dwarf file and the line tables.
220 //
221 const MCSymbol *MCDwarfFileTable::Emit(MCStreamer *MCOS) {
222   MCContext &context = MCOS->getContext();
223   // Switch to the section where the table will be emitted into.
224   MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfLineSection());
225
226   const DenseMap<unsigned, MCSymbol *> &MCLineTableSymbols =
227     MCOS->getContext().getMCLineTableSymbols();
228   // CUID and MCLineTableSymbols are set in DwarfDebug, when DwarfDebug does
229   // not exist, CUID will be 0 and MCLineTableSymbols will be empty.
230   // Handle Compile Unit 0, the line table start symbol is the section symbol.
231   const MCSymbol *LineStartSym = EmitCU(MCOS, 0);
232   // Handle the rest of the Compile Units.
233   for (unsigned Is = 1, Ie = MCLineTableSymbols.size(); Is < Ie; Is++)
234     EmitCU(MCOS, Is);
235
236   // Now delete the MCLineSections that were created in MCLineEntry::Make()
237   // and used to emit the line table.
238   const DenseMap<const MCSection *, MCLineSection *> &MCLineSections =
239     MCOS->getContext().getMCLineSections();
240   for (DenseMap<const MCSection *, MCLineSection *>::const_iterator it =
241        MCLineSections.begin(), ie = MCLineSections.end(); it != ie;
242        ++it)
243     delete it->second;
244
245   return LineStartSym;
246 }
247
248 const MCSymbol *MCDwarfFileTable::EmitCU(MCStreamer *MCOS, unsigned CUID) {
249   MCContext &context = MCOS->getContext();
250
251   // Create a symbol at the beginning of the line table.
252   MCSymbol *LineStartSym = MCOS->getContext().getMCLineTableSymbol(CUID);
253   if (!LineStartSym)
254     LineStartSym = context.CreateTempSymbol();
255   // Set the value of the symbol, as we are at the start of the line table.
256   MCOS->EmitLabel(LineStartSym);
257
258   // Create a symbol for the end of the section (to be set when we get there).
259   MCSymbol *LineEndSym = context.CreateTempSymbol();
260
261   // The first 4 bytes is the total length of the information for this
262   // compilation unit (not including these 4 bytes for the length).
263   MCOS->EmitAbsValue(MakeStartMinusEndExpr(*MCOS, *LineStartSym, *LineEndSym,4),
264                      4);
265
266   // Next 2 bytes is the Version, which is Dwarf 2.
267   MCOS->EmitIntValue(2, 2);
268
269   // Create a symbol for the end of the prologue (to be set when we get there).
270   MCSymbol *ProEndSym = context.CreateTempSymbol(); // Lprologue_end
271
272   // Length of the prologue, is the next 4 bytes.  Which is the start of the
273   // section to the end of the prologue.  Not including the 4 bytes for the
274   // total length, the 2 bytes for the version, and these 4 bytes for the
275   // length of the prologue.
276   MCOS->EmitAbsValue(MakeStartMinusEndExpr(*MCOS, *LineStartSym, *ProEndSym,
277                                            (4 + 2 + 4)), 4, 0);
278
279   // Parameters of the state machine, are next.
280   MCOS->EmitIntValue(DWARF2_LINE_MIN_INSN_LENGTH, 1);
281   MCOS->EmitIntValue(DWARF2_LINE_DEFAULT_IS_STMT, 1);
282   MCOS->EmitIntValue(DWARF2_LINE_BASE, 1);
283   MCOS->EmitIntValue(DWARF2_LINE_RANGE, 1);
284   MCOS->EmitIntValue(DWARF2_LINE_OPCODE_BASE, 1);
285
286   // Standard opcode lengths
287   MCOS->EmitIntValue(0, 1); // length of DW_LNS_copy
288   MCOS->EmitIntValue(1, 1); // length of DW_LNS_advance_pc
289   MCOS->EmitIntValue(1, 1); // length of DW_LNS_advance_line
290   MCOS->EmitIntValue(1, 1); // length of DW_LNS_set_file
291   MCOS->EmitIntValue(1, 1); // length of DW_LNS_set_column
292   MCOS->EmitIntValue(0, 1); // length of DW_LNS_negate_stmt
293   MCOS->EmitIntValue(0, 1); // length of DW_LNS_set_basic_block
294   MCOS->EmitIntValue(0, 1); // length of DW_LNS_const_add_pc
295   MCOS->EmitIntValue(1, 1); // length of DW_LNS_fixed_advance_pc
296   MCOS->EmitIntValue(0, 1); // length of DW_LNS_set_prologue_end
297   MCOS->EmitIntValue(0, 1); // length of DW_LNS_set_epilogue_begin
298   MCOS->EmitIntValue(1, 1); // DW_LNS_set_isa
299
300   // Put out the directory and file tables.
301
302   // First the directory table.
303   const SmallVectorImpl<StringRef> &MCDwarfDirs =
304     context.getMCDwarfDirs(CUID);
305   for (unsigned i = 0; i < MCDwarfDirs.size(); i++) {
306     MCOS->EmitBytes(MCDwarfDirs[i]); // the DirectoryName
307     MCOS->EmitBytes(StringRef("\0", 1)); // the null term. of the string
308   }
309   MCOS->EmitIntValue(0, 1); // Terminate the directory list
310
311   // Second the file table.
312   const SmallVectorImpl<MCDwarfFile *> &MCDwarfFiles =
313     MCOS->getContext().getMCDwarfFiles(CUID);
314   for (unsigned i = 1; i < MCDwarfFiles.size(); i++) {
315     MCOS->EmitBytes(MCDwarfFiles[i]->getName()); // FileName
316     MCOS->EmitBytes(StringRef("\0", 1)); // the null term. of the string
317     // the Directory num
318     MCOS->EmitULEB128IntValue(MCDwarfFiles[i]->getDirIndex());
319     MCOS->EmitIntValue(0, 1); // last modification timestamp (always 0)
320     MCOS->EmitIntValue(0, 1); // filesize (always 0)
321   }
322   MCOS->EmitIntValue(0, 1); // Terminate the file list
323
324   // This is the end of the prologue, so set the value of the symbol at the
325   // end of the prologue (that was used in a previous expression).
326   MCOS->EmitLabel(ProEndSym);
327
328   // Put out the line tables.
329   const DenseMap<const MCSection *, MCLineSection *> &MCLineSections =
330     MCOS->getContext().getMCLineSections();
331   const std::vector<const MCSection *> &MCLineSectionOrder =
332     MCOS->getContext().getMCLineSectionOrder();
333   for (std::vector<const MCSection*>::const_iterator it =
334          MCLineSectionOrder.begin(), ie = MCLineSectionOrder.end(); it != ie;
335        ++it) {
336     const MCSection *Sec = *it;
337     const MCLineSection *Line = MCLineSections.lookup(Sec);
338     EmitDwarfLineTable(MCOS, Sec, Line, CUID);
339   }
340
341   if (MCOS->getContext().getAsmInfo().getLinkerRequiresNonEmptyDwarfLines()
342       && MCLineSectionOrder.begin() == MCLineSectionOrder.end()) {
343     // The darwin9 linker has a bug (see PR8715). For for 32-bit architectures
344     // it requires:
345     // total_length >= prologue_length + 10
346     // We are 4 bytes short, since we have total_length = 51 and
347     // prologue_length = 45
348
349     // The regular end_sequence should be sufficient.
350     MCDwarfLineAddr::Emit(MCOS, INT64_MAX, 0);
351   }
352
353   // This is the end of the section, so set the value of the symbol at the end
354   // of this section (that was used in a previous expression).
355   MCOS->EmitLabel(LineEndSym);
356
357   return LineStartSym;
358 }
359
360 /// Utility function to write the encoding to an object writer.
361 void MCDwarfLineAddr::Write(MCObjectWriter *OW, int64_t LineDelta,
362                             uint64_t AddrDelta) {
363   SmallString<256> Tmp;
364   raw_svector_ostream OS(Tmp);
365   MCDwarfLineAddr::Encode(LineDelta, AddrDelta, OS);
366   OW->WriteBytes(OS.str());
367 }
368
369 /// Utility function to emit the encoding to a streamer.
370 void MCDwarfLineAddr::Emit(MCStreamer *MCOS, int64_t LineDelta,
371                            uint64_t AddrDelta) {
372   SmallString<256> Tmp;
373   raw_svector_ostream OS(Tmp);
374   MCDwarfLineAddr::Encode(LineDelta, AddrDelta, OS);
375   MCOS->EmitBytes(OS.str());
376 }
377
378 /// Utility function to encode a Dwarf pair of LineDelta and AddrDeltas.
379 void MCDwarfLineAddr::Encode(int64_t LineDelta, uint64_t AddrDelta,
380                              raw_ostream &OS) {
381   uint64_t Temp, Opcode;
382   bool NeedCopy = false;
383
384   // Scale the address delta by the minimum instruction length.
385   AddrDelta = ScaleAddrDelta(AddrDelta);
386
387   // A LineDelta of INT64_MAX is a signal that this is actually a
388   // DW_LNE_end_sequence. We cannot use special opcodes here, since we want the
389   // end_sequence to emit the matrix entry.
390   if (LineDelta == INT64_MAX) {
391     if (AddrDelta == MAX_SPECIAL_ADDR_DELTA)
392       OS << char(dwarf::DW_LNS_const_add_pc);
393     else {
394       OS << char(dwarf::DW_LNS_advance_pc);
395       encodeULEB128(AddrDelta, OS);
396     }
397     OS << char(dwarf::DW_LNS_extended_op);
398     OS << char(1);
399     OS << char(dwarf::DW_LNE_end_sequence);
400     return;
401   }
402
403   // Bias the line delta by the base.
404   Temp = LineDelta - DWARF2_LINE_BASE;
405
406   // If the line increment is out of range of a special opcode, we must encode
407   // it with DW_LNS_advance_line.
408   if (Temp >= DWARF2_LINE_RANGE) {
409     OS << char(dwarf::DW_LNS_advance_line);
410     encodeSLEB128(LineDelta, OS);
411
412     LineDelta = 0;
413     Temp = 0 - DWARF2_LINE_BASE;
414     NeedCopy = true;
415   }
416
417   // Use DW_LNS_copy instead of a "line +0, addr +0" special opcode.
418   if (LineDelta == 0 && AddrDelta == 0) {
419     OS << char(dwarf::DW_LNS_copy);
420     return;
421   }
422
423   // Bias the opcode by the special opcode base.
424   Temp += DWARF2_LINE_OPCODE_BASE;
425
426   // Avoid overflow when addr_delta is large.
427   if (AddrDelta < 256 + MAX_SPECIAL_ADDR_DELTA) {
428     // Try using a special opcode.
429     Opcode = Temp + AddrDelta * DWARF2_LINE_RANGE;
430     if (Opcode <= 255) {
431       OS << char(Opcode);
432       return;
433     }
434
435     // Try using DW_LNS_const_add_pc followed by special op.
436     Opcode = Temp + (AddrDelta - MAX_SPECIAL_ADDR_DELTA) * DWARF2_LINE_RANGE;
437     if (Opcode <= 255) {
438       OS << char(dwarf::DW_LNS_const_add_pc);
439       OS << char(Opcode);
440       return;
441     }
442   }
443
444   // Otherwise use DW_LNS_advance_pc.
445   OS << char(dwarf::DW_LNS_advance_pc);
446   encodeULEB128(AddrDelta, OS);
447
448   if (NeedCopy)
449     OS << char(dwarf::DW_LNS_copy);
450   else
451     OS << char(Temp);
452 }
453
454 void MCDwarfFile::print(raw_ostream &OS) const {
455   OS << '"' << getName() << '"';
456 }
457
458 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
459 void MCDwarfFile::dump() const {
460   print(dbgs());
461 }
462 #endif
463
464 // Utility function to write a tuple for .debug_abbrev.
465 static void EmitAbbrev(MCStreamer *MCOS, uint64_t Name, uint64_t Form) {
466   MCOS->EmitULEB128IntValue(Name);
467   MCOS->EmitULEB128IntValue(Form);
468 }
469
470 // When generating dwarf for assembly source files this emits
471 // the data for .debug_abbrev section which contains three DIEs.
472 static void EmitGenDwarfAbbrev(MCStreamer *MCOS) {
473   MCContext &context = MCOS->getContext();
474   MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfAbbrevSection());
475
476   // DW_TAG_compile_unit DIE abbrev (1).
477   MCOS->EmitULEB128IntValue(1);
478   MCOS->EmitULEB128IntValue(dwarf::DW_TAG_compile_unit);
479   MCOS->EmitIntValue(dwarf::DW_CHILDREN_yes, 1);
480   EmitAbbrev(MCOS, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4);
481   EmitAbbrev(MCOS, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr);
482   EmitAbbrev(MCOS, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr);
483   EmitAbbrev(MCOS, dwarf::DW_AT_name, dwarf::DW_FORM_string);
484   EmitAbbrev(MCOS, dwarf::DW_AT_comp_dir, dwarf::DW_FORM_string);
485   StringRef DwarfDebugFlags = context.getDwarfDebugFlags();
486   if (!DwarfDebugFlags.empty())
487     EmitAbbrev(MCOS, dwarf::DW_AT_APPLE_flags, dwarf::DW_FORM_string);
488   EmitAbbrev(MCOS, dwarf::DW_AT_producer, dwarf::DW_FORM_string);
489   EmitAbbrev(MCOS, dwarf::DW_AT_language, dwarf::DW_FORM_data2);
490   EmitAbbrev(MCOS, 0, 0);
491
492   // DW_TAG_label DIE abbrev (2).
493   MCOS->EmitULEB128IntValue(2);
494   MCOS->EmitULEB128IntValue(dwarf::DW_TAG_label);
495   MCOS->EmitIntValue(dwarf::DW_CHILDREN_yes, 1);
496   EmitAbbrev(MCOS, dwarf::DW_AT_name, dwarf::DW_FORM_string);
497   EmitAbbrev(MCOS, dwarf::DW_AT_decl_file, dwarf::DW_FORM_data4);
498   EmitAbbrev(MCOS, dwarf::DW_AT_decl_line, dwarf::DW_FORM_data4);
499   EmitAbbrev(MCOS, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr);
500   EmitAbbrev(MCOS, dwarf::DW_AT_prototyped, dwarf::DW_FORM_flag);
501   EmitAbbrev(MCOS, 0, 0);
502
503   // DW_TAG_unspecified_parameters DIE abbrev (3).
504   MCOS->EmitULEB128IntValue(3);
505   MCOS->EmitULEB128IntValue(dwarf::DW_TAG_unspecified_parameters);
506   MCOS->EmitIntValue(dwarf::DW_CHILDREN_no, 1);
507   EmitAbbrev(MCOS, 0, 0);
508
509   // Terminate the abbreviations for this compilation unit.
510   MCOS->EmitIntValue(0, 1);
511 }
512
513 // When generating dwarf for assembly source files this emits the data for
514 // .debug_aranges section.  Which contains a header and a table of pairs of
515 // PointerSize'ed values for the address and size of section(s) with line table
516 // entries (just the default .text in our case) and a terminating pair of zeros.
517 static void EmitGenDwarfAranges(MCStreamer *MCOS,
518                                 const MCSymbol *InfoSectionSymbol) {
519   MCContext &context = MCOS->getContext();
520
521   // Create a symbol at the end of the section that we are creating the dwarf
522   // debugging info to use later in here as part of the expression to calculate
523   // the size of the section for the table.
524   MCOS->SwitchSection(context.getGenDwarfSection());
525   MCSymbol *SectionEndSym = context.CreateTempSymbol();
526   MCOS->EmitLabel(SectionEndSym);
527   context.setGenDwarfSectionEndSym(SectionEndSym);
528
529   MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfARangesSection());
530
531   // This will be the length of the .debug_aranges section, first account for
532   // the size of each item in the header (see below where we emit these items).
533   int Length = 4 + 2 + 4 + 1 + 1;
534
535   // Figure the padding after the header before the table of address and size
536   // pairs who's values are PointerSize'ed.
537   const MCAsmInfo &asmInfo = context.getAsmInfo();
538   int AddrSize = asmInfo.getPointerSize();
539   int Pad = 2 * AddrSize - (Length & (2 * AddrSize - 1));
540   if (Pad == 2 * AddrSize)
541     Pad = 0;
542   Length += Pad;
543
544   // Add the size of the pair of PointerSize'ed values for the address and size
545   // of the one default .text section we have in the table.
546   Length += 2 * AddrSize;
547   // And the pair of terminating zeros.
548   Length += 2 * AddrSize;
549
550
551   // Emit the header for this section.
552   // The 4 byte length not including the 4 byte value for the length.
553   MCOS->EmitIntValue(Length - 4, 4);
554   // The 2 byte version, which is 2.
555   MCOS->EmitIntValue(2, 2);
556   // The 4 byte offset to the compile unit in the .debug_info from the start
557   // of the .debug_info.
558   if (InfoSectionSymbol)
559     MCOS->EmitSymbolValue(InfoSectionSymbol, 4);
560   else
561     MCOS->EmitIntValue(0, 4);
562   // The 1 byte size of an address.
563   MCOS->EmitIntValue(AddrSize, 1);
564   // The 1 byte size of a segment descriptor, we use a value of zero.
565   MCOS->EmitIntValue(0, 1);
566   // Align the header with the padding if needed, before we put out the table.
567   for(int i = 0; i < Pad; i++)
568     MCOS->EmitIntValue(0, 1);
569
570   // Now emit the table of pairs of PointerSize'ed values for the section(s)
571   // address and size, in our case just the one default .text section.
572   const MCExpr *Addr = MCSymbolRefExpr::Create(
573     context.getGenDwarfSectionStartSym(), MCSymbolRefExpr::VK_None, context);
574   const MCExpr *Size = MakeStartMinusEndExpr(*MCOS,
575     *context.getGenDwarfSectionStartSym(), *SectionEndSym, 0);
576   MCOS->EmitAbsValue(Addr, AddrSize);
577   MCOS->EmitAbsValue(Size, AddrSize);
578
579   // And finally the pair of terminating zeros.
580   MCOS->EmitIntValue(0, AddrSize);
581   MCOS->EmitIntValue(0, AddrSize);
582 }
583
584 // When generating dwarf for assembly source files this emits the data for
585 // .debug_info section which contains three parts.  The header, the compile_unit
586 // DIE and a list of label DIEs.
587 static void EmitGenDwarfInfo(MCStreamer *MCOS,
588                              const MCSymbol *AbbrevSectionSymbol,
589                              const MCSymbol *LineSectionSymbol) {
590   MCContext &context = MCOS->getContext();
591
592   MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfInfoSection());
593
594   // Create a symbol at the start and end of this section used in here for the
595   // expression to calculate the length in the header.
596   MCSymbol *InfoStart = context.CreateTempSymbol();
597   MCOS->EmitLabel(InfoStart);
598   MCSymbol *InfoEnd = context.CreateTempSymbol();
599
600   // First part: the header.
601
602   // The 4 byte total length of the information for this compilation unit, not
603   // including these 4 bytes.
604   const MCExpr *Length = MakeStartMinusEndExpr(*MCOS, *InfoStart, *InfoEnd, 4);
605   MCOS->EmitAbsValue(Length, 4);
606
607   // The 2 byte DWARF version, which is 2.
608   MCOS->EmitIntValue(2, 2);
609
610   // The 4 byte offset to the debug abbrevs from the start of the .debug_abbrev,
611   // it is at the start of that section so this is zero.
612   if (AbbrevSectionSymbol) {
613     MCOS->EmitSymbolValue(AbbrevSectionSymbol, 4);
614   } else {
615     MCOS->EmitIntValue(0, 4);
616   }
617
618   const MCAsmInfo &asmInfo = context.getAsmInfo();
619   int AddrSize = asmInfo.getPointerSize();
620   // The 1 byte size of an address.
621   MCOS->EmitIntValue(AddrSize, 1);
622
623   // Second part: the compile_unit DIE.
624
625   // The DW_TAG_compile_unit DIE abbrev (1).
626   MCOS->EmitULEB128IntValue(1);
627
628   // DW_AT_stmt_list, a 4 byte offset from the start of the .debug_line section,
629   // which is at the start of that section so this is zero.
630   if (LineSectionSymbol) {
631     MCOS->EmitSymbolValue(LineSectionSymbol, 4);
632   } else {
633     MCOS->EmitIntValue(0, 4);
634   }
635
636   // AT_low_pc, the first address of the default .text section.
637   const MCExpr *Start = MCSymbolRefExpr::Create(
638     context.getGenDwarfSectionStartSym(), MCSymbolRefExpr::VK_None, context);
639   MCOS->EmitAbsValue(Start, AddrSize);
640
641   // AT_high_pc, the last address of the default .text section.
642   const MCExpr *End = MCSymbolRefExpr::Create(
643     context.getGenDwarfSectionEndSym(), MCSymbolRefExpr::VK_None, context);
644   MCOS->EmitAbsValue(End, AddrSize);
645
646   // AT_name, the name of the source file.  Reconstruct from the first directory
647   // and file table entries.
648   const SmallVectorImpl<StringRef> &MCDwarfDirs =
649     context.getMCDwarfDirs();
650   if (MCDwarfDirs.size() > 0) {
651     MCOS->EmitBytes(MCDwarfDirs[0]);
652     MCOS->EmitBytes("/");
653   }
654   const SmallVectorImpl<MCDwarfFile *> &MCDwarfFiles =
655     MCOS->getContext().getMCDwarfFiles();
656   MCOS->EmitBytes(MCDwarfFiles[1]->getName());
657   MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
658
659   // AT_comp_dir, the working directory the assembly was done in.
660   MCOS->EmitBytes(context.getCompilationDir());
661   MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
662
663   // AT_APPLE_flags, the command line arguments of the assembler tool.
664   StringRef DwarfDebugFlags = context.getDwarfDebugFlags();
665   if (!DwarfDebugFlags.empty()){
666     MCOS->EmitBytes(DwarfDebugFlags);
667     MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
668   }
669
670   // AT_producer, the version of the assembler tool.
671   StringRef DwarfDebugProducer = context.getDwarfDebugProducer();
672   if (!DwarfDebugProducer.empty()){
673     MCOS->EmitBytes(DwarfDebugProducer);
674   }
675   else {
676     MCOS->EmitBytes(StringRef("llvm-mc (based on LLVM "));
677     MCOS->EmitBytes(StringRef(PACKAGE_VERSION));
678     MCOS->EmitBytes(StringRef(")"));
679   }
680   MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
681
682   // AT_language, a 4 byte value.  We use DW_LANG_Mips_Assembler as the dwarf2
683   // draft has no standard code for assembler.
684   MCOS->EmitIntValue(dwarf::DW_LANG_Mips_Assembler, 2);
685
686   // Third part: the list of label DIEs.
687
688   // Loop on saved info for dwarf labels and create the DIEs for them.
689   const std::vector<const MCGenDwarfLabelEntry *> &Entries =
690     MCOS->getContext().getMCGenDwarfLabelEntries();
691   for (std::vector<const MCGenDwarfLabelEntry *>::const_iterator it =
692        Entries.begin(), ie = Entries.end(); it != ie;
693        ++it) {
694     const MCGenDwarfLabelEntry *Entry = *it;
695
696     // The DW_TAG_label DIE abbrev (2).
697     MCOS->EmitULEB128IntValue(2);
698
699     // AT_name, of the label without any leading underbar.
700     MCOS->EmitBytes(Entry->getName());
701     MCOS->EmitIntValue(0, 1); // NULL byte to terminate the string.
702
703     // AT_decl_file, index into the file table.
704     MCOS->EmitIntValue(Entry->getFileNumber(), 4);
705
706     // AT_decl_line, source line number.
707     MCOS->EmitIntValue(Entry->getLineNumber(), 4);
708
709     // AT_low_pc, start address of the label.
710     const MCExpr *AT_low_pc = MCSymbolRefExpr::Create(Entry->getLabel(),
711                                              MCSymbolRefExpr::VK_None, context);
712     MCOS->EmitAbsValue(AT_low_pc, AddrSize);
713
714     // DW_AT_prototyped, a one byte flag value of 0 saying we have no prototype.
715     MCOS->EmitIntValue(0, 1);
716
717     // The DW_TAG_unspecified_parameters DIE abbrev (3).
718     MCOS->EmitULEB128IntValue(3);
719
720     // Add the NULL DIE terminating the DW_TAG_unspecified_parameters DIE's.
721     MCOS->EmitIntValue(0, 1);
722   }
723   // Deallocate the MCGenDwarfLabelEntry classes that saved away the info
724   // for the dwarf labels.
725   for (std::vector<const MCGenDwarfLabelEntry *>::const_iterator it =
726        Entries.begin(), ie = Entries.end(); it != ie;
727        ++it) {
728     const MCGenDwarfLabelEntry *Entry = *it;
729     delete Entry;
730   }
731
732   // Add the NULL DIE terminating the Compile Unit DIE's.
733   MCOS->EmitIntValue(0, 1);
734
735   // Now set the value of the symbol at the end of the info section.
736   MCOS->EmitLabel(InfoEnd);
737 }
738
739 //
740 // When generating dwarf for assembly source files this emits the Dwarf
741 // sections.
742 //
743 void MCGenDwarfInfo::Emit(MCStreamer *MCOS, const MCSymbol *LineSectionSymbol) {
744   // Create the dwarf sections in this order (.debug_line already created).
745   MCContext &context = MCOS->getContext();
746   const MCAsmInfo &AsmInfo = context.getAsmInfo();
747   bool CreateDwarfSectionSymbols =
748       AsmInfo.doesDwarfUseRelocationsAcrossSections();
749   if (!CreateDwarfSectionSymbols)
750     LineSectionSymbol = NULL;
751   MCSymbol *AbbrevSectionSymbol = NULL;
752   MCSymbol *InfoSectionSymbol = NULL;
753   MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfInfoSection());
754   if (CreateDwarfSectionSymbols) {
755     InfoSectionSymbol = context.CreateTempSymbol();
756     MCOS->EmitLabel(InfoSectionSymbol);
757   }
758   MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfAbbrevSection());
759   if (CreateDwarfSectionSymbols) {
760     AbbrevSectionSymbol = context.CreateTempSymbol();
761     MCOS->EmitLabel(AbbrevSectionSymbol);
762   }
763   MCOS->SwitchSection(context.getObjectFileInfo()->getDwarfARangesSection());
764
765   // If there are no line table entries then do not emit any section contents.
766   if (context.getMCLineSections().empty())
767     return;
768
769   // Output the data for .debug_aranges section.
770   EmitGenDwarfAranges(MCOS, InfoSectionSymbol);
771
772   // Output the data for .debug_abbrev section.
773   EmitGenDwarfAbbrev(MCOS);
774
775   // Output the data for .debug_info section.
776   EmitGenDwarfInfo(MCOS, AbbrevSectionSymbol, LineSectionSymbol);
777 }
778
779 //
780 // When generating dwarf for assembly source files this is called when symbol
781 // for a label is created.  If this symbol is not a temporary and is in the
782 // section that dwarf is being generated for, save the needed info to create
783 // a dwarf label.
784 //
785 void MCGenDwarfLabelEntry::Make(MCSymbol *Symbol, MCStreamer *MCOS,
786                                      SourceMgr &SrcMgr, SMLoc &Loc) {
787   // We won't create dwarf labels for temporary symbols or symbols not in
788   // the default text.
789   if (Symbol->isTemporary())
790     return;
791   MCContext &context = MCOS->getContext();
792   if (context.getGenDwarfSection() != MCOS->getCurrentSection().first)
793     return;
794
795   // The dwarf label's name does not have the symbol name's leading
796   // underbar if any.
797   StringRef Name = Symbol->getName();
798   if (Name.startswith("_"))
799     Name = Name.substr(1, Name.size()-1);
800
801   // Get the dwarf file number to be used for the dwarf label.
802   unsigned FileNumber = context.getGenDwarfFileNumber();
803
804   // Finding the line number is the expensive part which is why we just don't
805   // pass it in as for some symbols we won't create a dwarf label.
806   int CurBuffer = SrcMgr.FindBufferContainingLoc(Loc);
807   unsigned LineNumber = SrcMgr.FindLineNumber(Loc, CurBuffer);
808
809   // We create a temporary symbol for use for the AT_high_pc and AT_low_pc
810   // values so that they don't have things like an ARM thumb bit from the
811   // original symbol. So when used they won't get a low bit set after
812   // relocation.
813   MCSymbol *Label = context.CreateTempSymbol();
814   MCOS->EmitLabel(Label);
815
816   // Create and entry for the info and add it to the other entries.
817   MCGenDwarfLabelEntry *Entry =
818     new MCGenDwarfLabelEntry(Name, FileNumber, LineNumber, Label);
819   MCOS->getContext().addMCGenDwarfLabelEntry(Entry);
820 }
821
822 static int getDataAlignmentFactor(MCStreamer &streamer) {
823   MCContext &context = streamer.getContext();
824   const MCAsmInfo &asmInfo = context.getAsmInfo();
825   int size = asmInfo.getCalleeSaveStackSlotSize();
826   if (asmInfo.isStackGrowthDirectionUp())
827     return size;
828   else
829     return -size;
830 }
831
832 static unsigned getSizeForEncoding(MCStreamer &streamer,
833                                    unsigned symbolEncoding) {
834   MCContext &context = streamer.getContext();
835   unsigned format = symbolEncoding & 0x0f;
836   switch (format) {
837   default: llvm_unreachable("Unknown Encoding");
838   case dwarf::DW_EH_PE_absptr:
839   case dwarf::DW_EH_PE_signed:
840     return context.getAsmInfo().getPointerSize();
841   case dwarf::DW_EH_PE_udata2:
842   case dwarf::DW_EH_PE_sdata2:
843     return 2;
844   case dwarf::DW_EH_PE_udata4:
845   case dwarf::DW_EH_PE_sdata4:
846     return 4;
847   case dwarf::DW_EH_PE_udata8:
848   case dwarf::DW_EH_PE_sdata8:
849     return 8;
850   }
851 }
852
853 static void EmitSymbol(MCStreamer &streamer, const MCSymbol &symbol,
854                        unsigned symbolEncoding, const char *comment = 0) {
855   MCContext &context = streamer.getContext();
856   const MCAsmInfo &asmInfo = context.getAsmInfo();
857   const MCExpr *v = asmInfo.getExprForFDESymbol(&symbol,
858                                                 symbolEncoding,
859                                                 streamer);
860   unsigned size = getSizeForEncoding(streamer, symbolEncoding);
861   if (streamer.isVerboseAsm() && comment) streamer.AddComment(comment);
862   streamer.EmitAbsValue(v, size);
863 }
864
865 static void EmitPersonality(MCStreamer &streamer, const MCSymbol &symbol,
866                             unsigned symbolEncoding) {
867   MCContext &context = streamer.getContext();
868   const MCAsmInfo &asmInfo = context.getAsmInfo();
869   const MCExpr *v = asmInfo.getExprForPersonalitySymbol(&symbol,
870                                                         symbolEncoding,
871                                                         streamer);
872   unsigned size = getSizeForEncoding(streamer, symbolEncoding);
873   streamer.EmitValue(v, size);
874 }
875
876 namespace {
877   class FrameEmitterImpl {
878     int CFAOffset;
879     int CIENum;
880     bool UsingCFI;
881     bool IsEH;
882     const MCSymbol *SectionStart;
883   public:
884     FrameEmitterImpl(bool usingCFI, bool isEH)
885       : CFAOffset(0), CIENum(0), UsingCFI(usingCFI), IsEH(isEH),
886         SectionStart(0) {}
887
888     void setSectionStart(const MCSymbol *Label) { SectionStart = Label; }
889
890     /// EmitCompactUnwind - Emit the unwind information in a compact way. If
891     /// we're successful, return 'true'. Otherwise, return 'false' and it will
892     /// emit the normal CIE and FDE.
893     void EmitCompactUnwind(MCStreamer &streamer,
894                            const MCDwarfFrameInfo &frame);
895
896     const MCSymbol &EmitCIE(MCStreamer &streamer,
897                             const MCSymbol *personality,
898                             unsigned personalityEncoding,
899                             const MCSymbol *lsda,
900                             bool IsSignalFrame,
901                             unsigned lsdaEncoding);
902     MCSymbol *EmitFDE(MCStreamer &streamer,
903                       const MCSymbol &cieStart,
904                       const MCDwarfFrameInfo &frame);
905     void EmitCFIInstructions(MCStreamer &streamer,
906                              const std::vector<MCCFIInstruction> &Instrs,
907                              MCSymbol *BaseLabel);
908     void EmitCFIInstruction(MCStreamer &Streamer,
909                             const MCCFIInstruction &Instr);
910   };
911
912 } // end anonymous namespace
913
914 static void EmitEncodingByte(MCStreamer &Streamer, unsigned Encoding,
915                              StringRef Prefix) {
916   if (Streamer.isVerboseAsm()) {
917     const char *EncStr;
918     switch (Encoding) {
919     default: EncStr = "<unknown encoding>"; break;
920     case dwarf::DW_EH_PE_absptr: EncStr = "absptr"; break;
921     case dwarf::DW_EH_PE_omit:   EncStr = "omit"; break;
922     case dwarf::DW_EH_PE_pcrel:  EncStr = "pcrel"; break;
923     case dwarf::DW_EH_PE_udata4: EncStr = "udata4"; break;
924     case dwarf::DW_EH_PE_udata8: EncStr = "udata8"; break;
925     case dwarf::DW_EH_PE_sdata4: EncStr = "sdata4"; break;
926     case dwarf::DW_EH_PE_sdata8: EncStr = "sdata8"; break;
927     case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_udata4:
928       EncStr = "pcrel udata4";
929       break;
930     case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_sdata4:
931       EncStr = "pcrel sdata4";
932       break;
933     case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_udata8:
934       EncStr = "pcrel udata8";
935       break;
936     case dwarf::DW_EH_PE_pcrel | dwarf::DW_EH_PE_sdata8:
937       EncStr = "screl sdata8";
938       break;
939     case dwarf::DW_EH_PE_indirect |dwarf::DW_EH_PE_pcrel|dwarf::DW_EH_PE_udata4:
940       EncStr = "indirect pcrel udata4";
941       break;
942     case dwarf::DW_EH_PE_indirect |dwarf::DW_EH_PE_pcrel|dwarf::DW_EH_PE_sdata4:
943       EncStr = "indirect pcrel sdata4";
944       break;
945     case dwarf::DW_EH_PE_indirect |dwarf::DW_EH_PE_pcrel|dwarf::DW_EH_PE_udata8:
946       EncStr = "indirect pcrel udata8";
947       break;
948     case dwarf::DW_EH_PE_indirect |dwarf::DW_EH_PE_pcrel|dwarf::DW_EH_PE_sdata8:
949       EncStr = "indirect pcrel sdata8";
950       break;
951     }
952
953     Streamer.AddComment(Twine(Prefix) + " = " + EncStr);
954   }
955
956   Streamer.EmitIntValue(Encoding, 1);
957 }
958
959 void FrameEmitterImpl::EmitCFIInstruction(MCStreamer &Streamer,
960                                           const MCCFIInstruction &Instr) {
961   int dataAlignmentFactor = getDataAlignmentFactor(Streamer);
962   bool VerboseAsm = Streamer.isVerboseAsm();
963
964   switch (Instr.getOperation()) {
965   case MCCFIInstruction::OpRegister: {
966     unsigned Reg1 = Instr.getRegister();
967     unsigned Reg2 = Instr.getRegister2();
968     if (VerboseAsm) {
969       Streamer.AddComment("DW_CFA_register");
970       Streamer.AddComment(Twine("Reg1 ") + Twine(Reg1));
971       Streamer.AddComment(Twine("Reg2 ") + Twine(Reg2));
972     }
973     Streamer.EmitIntValue(dwarf::DW_CFA_register, 1);
974     Streamer.EmitULEB128IntValue(Reg1);
975     Streamer.EmitULEB128IntValue(Reg2);
976     return;
977   }
978   case MCCFIInstruction::OpUndefined: {
979     unsigned Reg = Instr.getRegister();
980     if (VerboseAsm) {
981       Streamer.AddComment("DW_CFA_undefined");
982       Streamer.AddComment(Twine("Reg ") + Twine(Reg));
983     }
984     Streamer.EmitIntValue(dwarf::DW_CFA_undefined, 1);
985     Streamer.EmitULEB128IntValue(Reg);
986     return;
987   }
988   case MCCFIInstruction::OpAdjustCfaOffset:
989   case MCCFIInstruction::OpDefCfaOffset: {
990     const bool IsRelative =
991       Instr.getOperation() == MCCFIInstruction::OpAdjustCfaOffset;
992
993     if (VerboseAsm)
994       Streamer.AddComment("DW_CFA_def_cfa_offset");
995     Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa_offset, 1);
996
997     if (IsRelative)
998       CFAOffset += Instr.getOffset();
999     else
1000       CFAOffset = -Instr.getOffset();
1001
1002     if (VerboseAsm)
1003       Streamer.AddComment(Twine("Offset " + Twine(CFAOffset)));
1004     Streamer.EmitULEB128IntValue(CFAOffset);
1005
1006     return;
1007   }
1008   case MCCFIInstruction::OpDefCfa: {
1009     if (VerboseAsm)
1010       Streamer.AddComment("DW_CFA_def_cfa");
1011     Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa, 1);
1012
1013     if (VerboseAsm)
1014       Streamer.AddComment(Twine("Reg ") + Twine(Instr.getRegister()));
1015     Streamer.EmitULEB128IntValue(Instr.getRegister());
1016
1017     CFAOffset = -Instr.getOffset();
1018
1019     if (VerboseAsm)
1020       Streamer.AddComment(Twine("Offset " + Twine(CFAOffset)));
1021     Streamer.EmitULEB128IntValue(CFAOffset);
1022
1023     return;
1024   }
1025
1026   case MCCFIInstruction::OpDefCfaRegister: {
1027     if (VerboseAsm)
1028       Streamer.AddComment("DW_CFA_def_cfa_register");
1029     Streamer.EmitIntValue(dwarf::DW_CFA_def_cfa_register, 1);
1030
1031     if (VerboseAsm)
1032       Streamer.AddComment(Twine("Reg ") + Twine(Instr.getRegister()));
1033     Streamer.EmitULEB128IntValue(Instr.getRegister());
1034
1035     return;
1036   }
1037
1038   case MCCFIInstruction::OpOffset:
1039   case MCCFIInstruction::OpRelOffset: {
1040     const bool IsRelative =
1041       Instr.getOperation() == MCCFIInstruction::OpRelOffset;
1042
1043     unsigned Reg = Instr.getRegister();
1044     int Offset = Instr.getOffset();
1045     if (IsRelative)
1046       Offset -= CFAOffset;
1047     Offset = Offset / dataAlignmentFactor;
1048
1049     if (Offset < 0) {
1050       if (VerboseAsm) Streamer.AddComment("DW_CFA_offset_extended_sf");
1051       Streamer.EmitIntValue(dwarf::DW_CFA_offset_extended_sf, 1);
1052       if (VerboseAsm) Streamer.AddComment(Twine("Reg ") + Twine(Reg));
1053       Streamer.EmitULEB128IntValue(Reg);
1054       if (VerboseAsm) Streamer.AddComment(Twine("Offset ") + Twine(Offset));
1055       Streamer.EmitSLEB128IntValue(Offset);
1056     } else if (Reg < 64) {
1057       if (VerboseAsm) Streamer.AddComment(Twine("DW_CFA_offset + Reg(") +
1058                                           Twine(Reg) + ")");
1059       Streamer.EmitIntValue(dwarf::DW_CFA_offset + Reg, 1);
1060       if (VerboseAsm) Streamer.AddComment(Twine("Offset ") + Twine(Offset));
1061       Streamer.EmitULEB128IntValue(Offset);
1062     } else {
1063       if (VerboseAsm) Streamer.AddComment("DW_CFA_offset_extended");
1064       Streamer.EmitIntValue(dwarf::DW_CFA_offset_extended, 1);
1065       if (VerboseAsm) Streamer.AddComment(Twine("Reg ") + Twine(Reg));
1066       Streamer.EmitULEB128IntValue(Reg);
1067       if (VerboseAsm) Streamer.AddComment(Twine("Offset ") + Twine(Offset));
1068       Streamer.EmitULEB128IntValue(Offset);
1069     }
1070     return;
1071   }
1072   case MCCFIInstruction::OpRememberState:
1073     if (VerboseAsm) Streamer.AddComment("DW_CFA_remember_state");
1074     Streamer.EmitIntValue(dwarf::DW_CFA_remember_state, 1);
1075     return;
1076   case MCCFIInstruction::OpRestoreState:
1077     if (VerboseAsm) Streamer.AddComment("DW_CFA_restore_state");
1078     Streamer.EmitIntValue(dwarf::DW_CFA_restore_state, 1);
1079     return;
1080   case MCCFIInstruction::OpSameValue: {
1081     unsigned Reg = Instr.getRegister();
1082     if (VerboseAsm) Streamer.AddComment("DW_CFA_same_value");
1083     Streamer.EmitIntValue(dwarf::DW_CFA_same_value, 1);
1084     if (VerboseAsm) Streamer.AddComment(Twine("Reg ") + Twine(Reg));
1085     Streamer.EmitULEB128IntValue(Reg);
1086     return;
1087   }
1088   case MCCFIInstruction::OpRestore: {
1089     unsigned Reg = Instr.getRegister();
1090     if (VerboseAsm) {
1091       Streamer.AddComment("DW_CFA_restore");
1092       Streamer.AddComment(Twine("Reg ") + Twine(Reg));
1093     }
1094     Streamer.EmitIntValue(dwarf::DW_CFA_restore | Reg, 1);
1095     return;
1096   }
1097   case MCCFIInstruction::OpEscape:
1098     if (VerboseAsm) Streamer.AddComment("Escape bytes");
1099     Streamer.EmitBytes(Instr.getValues());
1100     return;
1101   }
1102   llvm_unreachable("Unhandled case in switch");
1103 }
1104
1105 /// EmitFrameMoves - Emit frame instructions to describe the layout of the
1106 /// frame.
1107 void FrameEmitterImpl::EmitCFIInstructions(MCStreamer &streamer,
1108                                     const std::vector<MCCFIInstruction> &Instrs,
1109                                            MCSymbol *BaseLabel) {
1110   for (unsigned i = 0, N = Instrs.size(); i < N; ++i) {
1111     const MCCFIInstruction &Instr = Instrs[i];
1112     MCSymbol *Label = Instr.getLabel();
1113     // Throw out move if the label is invalid.
1114     if (Label && !Label->isDefined()) continue; // Not emitted, in dead code.
1115
1116     // Advance row if new location.
1117     if (BaseLabel && Label) {
1118       MCSymbol *ThisSym = Label;
1119       if (ThisSym != BaseLabel) {
1120         if (streamer.isVerboseAsm()) streamer.AddComment("DW_CFA_advance_loc4");
1121         streamer.EmitDwarfAdvanceFrameAddr(BaseLabel, ThisSym);
1122         BaseLabel = ThisSym;
1123       }
1124     }
1125
1126     EmitCFIInstruction(streamer, Instr);
1127   }
1128 }
1129
1130 /// EmitCompactUnwind - Emit the unwind information in a compact way. If we're
1131 /// successful, return 'true'. Otherwise, return 'false' and it will emit the
1132 /// normal CIE and FDE.
1133 void FrameEmitterImpl::EmitCompactUnwind(MCStreamer &Streamer,
1134                                          const MCDwarfFrameInfo &Frame) {
1135   MCContext &Context = Streamer.getContext();
1136   const MCObjectFileInfo *MOFI = Context.getObjectFileInfo();
1137   bool VerboseAsm = Streamer.isVerboseAsm();
1138
1139   // range-start range-length  compact-unwind-enc personality-func   lsda
1140   //  _foo       LfooEnd-_foo  0x00000023          0                 0
1141   //  _bar       LbarEnd-_bar  0x00000025         __gxx_personality  except_tab1
1142   //
1143   //   .section __LD,__compact_unwind,regular,debug
1144   //
1145   //   # compact unwind for _foo
1146   //   .quad _foo
1147   //   .set L1,LfooEnd-_foo
1148   //   .long L1
1149   //   .long 0x01010001
1150   //   .quad 0
1151   //   .quad 0
1152   //
1153   //   # compact unwind for _bar
1154   //   .quad _bar
1155   //   .set L2,LbarEnd-_bar
1156   //   .long L2
1157   //   .long 0x01020011
1158   //   .quad __gxx_personality
1159   //   .quad except_tab1
1160
1161   uint32_t Encoding = Frame.CompactUnwindEncoding;
1162   if (!Encoding) return;
1163   bool DwarfEHFrameOnly = (Encoding == MOFI->getCompactUnwindDwarfEHFrameOnly());
1164
1165   // The encoding needs to know we have an LSDA.
1166   if (!DwarfEHFrameOnly && Frame.Lsda)
1167     Encoding |= 0x40000000;
1168
1169   // Range Start
1170   unsigned FDEEncoding = MOFI->getFDEEncoding(UsingCFI);
1171   unsigned Size = getSizeForEncoding(Streamer, FDEEncoding);
1172   if (VerboseAsm) Streamer.AddComment("Range Start");
1173   Streamer.EmitSymbolValue(Frame.Function, Size);
1174
1175   // Range Length
1176   const MCExpr *Range = MakeStartMinusEndExpr(Streamer, *Frame.Begin,
1177                                               *Frame.End, 0);
1178   if (VerboseAsm) Streamer.AddComment("Range Length");
1179   Streamer.EmitAbsValue(Range, 4);
1180
1181   // Compact Encoding
1182   Size = getSizeForEncoding(Streamer, dwarf::DW_EH_PE_udata4);
1183   if (VerboseAsm) Streamer.AddComment("Compact Unwind Encoding: 0x" +
1184                                       Twine::utohexstr(Encoding));
1185   Streamer.EmitIntValue(Encoding, Size);
1186
1187   // Personality Function
1188   Size = getSizeForEncoding(Streamer, dwarf::DW_EH_PE_absptr);
1189   if (VerboseAsm) Streamer.AddComment("Personality Function");
1190   if (!DwarfEHFrameOnly && Frame.Personality)
1191     Streamer.EmitSymbolValue(Frame.Personality, Size);
1192   else
1193     Streamer.EmitIntValue(0, Size); // No personality fn
1194
1195   // LSDA
1196   Size = getSizeForEncoding(Streamer, Frame.LsdaEncoding);
1197   if (VerboseAsm) Streamer.AddComment("LSDA");
1198   if (!DwarfEHFrameOnly && Frame.Lsda)
1199     Streamer.EmitSymbolValue(Frame.Lsda, Size);
1200   else
1201     Streamer.EmitIntValue(0, Size); // No LSDA
1202 }
1203
1204 const MCSymbol &FrameEmitterImpl::EmitCIE(MCStreamer &streamer,
1205                                           const MCSymbol *personality,
1206                                           unsigned personalityEncoding,
1207                                           const MCSymbol *lsda,
1208                                           bool IsSignalFrame,
1209                                           unsigned lsdaEncoding) {
1210   MCContext &context = streamer.getContext();
1211   const MCRegisterInfo &MRI = context.getRegisterInfo();
1212   const MCObjectFileInfo *MOFI = context.getObjectFileInfo();
1213   bool verboseAsm = streamer.isVerboseAsm();
1214
1215   MCSymbol *sectionStart;
1216   if (MOFI->isFunctionEHFrameSymbolPrivate() || !IsEH)
1217     sectionStart = context.CreateTempSymbol();
1218   else
1219     sectionStart = context.GetOrCreateSymbol(Twine("EH_frame") + Twine(CIENum));
1220
1221   streamer.EmitLabel(sectionStart);
1222   CIENum++;
1223
1224   MCSymbol *sectionEnd = context.CreateTempSymbol();
1225
1226   // Length
1227   const MCExpr *Length = MakeStartMinusEndExpr(streamer, *sectionStart,
1228                                                *sectionEnd, 4);
1229   if (verboseAsm) streamer.AddComment("CIE Length");
1230   streamer.EmitAbsValue(Length, 4);
1231
1232   // CIE ID
1233   unsigned CIE_ID = IsEH ? 0 : -1;
1234   if (verboseAsm) streamer.AddComment("CIE ID Tag");
1235   streamer.EmitIntValue(CIE_ID, 4);
1236
1237   // Version
1238   if (verboseAsm) streamer.AddComment("DW_CIE_VERSION");
1239   streamer.EmitIntValue(dwarf::DW_CIE_VERSION, 1);
1240
1241   // Augmentation String
1242   SmallString<8> Augmentation;
1243   if (IsEH) {
1244     if (verboseAsm) streamer.AddComment("CIE Augmentation");
1245     Augmentation += "z";
1246     if (personality)
1247       Augmentation += "P";
1248     if (lsda)
1249       Augmentation += "L";
1250     Augmentation += "R";
1251     if (IsSignalFrame)
1252       Augmentation += "S";
1253     streamer.EmitBytes(Augmentation.str());
1254   }
1255   streamer.EmitIntValue(0, 1);
1256
1257   // Code Alignment Factor
1258   if (verboseAsm) streamer.AddComment("CIE Code Alignment Factor");
1259   streamer.EmitULEB128IntValue(1);
1260
1261   // Data Alignment Factor
1262   if (verboseAsm) streamer.AddComment("CIE Data Alignment Factor");
1263   streamer.EmitSLEB128IntValue(getDataAlignmentFactor(streamer));
1264
1265   // Return Address Register
1266   if (verboseAsm) streamer.AddComment("CIE Return Address Column");
1267   streamer.EmitULEB128IntValue(MRI.getDwarfRegNum(MRI.getRARegister(), true));
1268
1269   // Augmentation Data Length (optional)
1270
1271   unsigned augmentationLength = 0;
1272   if (IsEH) {
1273     if (personality) {
1274       // Personality Encoding
1275       augmentationLength += 1;
1276       // Personality
1277       augmentationLength += getSizeForEncoding(streamer, personalityEncoding);
1278     }
1279     if (lsda)
1280       augmentationLength += 1;
1281     // Encoding of the FDE pointers
1282     augmentationLength += 1;
1283
1284     if (verboseAsm) streamer.AddComment("Augmentation Size");
1285     streamer.EmitULEB128IntValue(augmentationLength);
1286
1287     // Augmentation Data (optional)
1288     if (personality) {
1289       // Personality Encoding
1290       EmitEncodingByte(streamer, personalityEncoding,
1291                        "Personality Encoding");
1292       // Personality
1293       if (verboseAsm) streamer.AddComment("Personality");
1294       EmitPersonality(streamer, *personality, personalityEncoding);
1295     }
1296
1297     if (lsda)
1298       EmitEncodingByte(streamer, lsdaEncoding, "LSDA Encoding");
1299
1300     // Encoding of the FDE pointers
1301     EmitEncodingByte(streamer, MOFI->getFDEEncoding(UsingCFI),
1302                      "FDE Encoding");
1303   }
1304
1305   // Initial Instructions
1306
1307   const MCAsmInfo &MAI = context.getAsmInfo();
1308   const std::vector<MCCFIInstruction> &Instructions =
1309       MAI.getInitialFrameState();
1310   EmitCFIInstructions(streamer, Instructions, NULL);
1311
1312   // Padding
1313   streamer.EmitValueToAlignment(IsEH
1314                                 ? 4 : context.getAsmInfo().getPointerSize());
1315
1316   streamer.EmitLabel(sectionEnd);
1317   return *sectionStart;
1318 }
1319
1320 MCSymbol *FrameEmitterImpl::EmitFDE(MCStreamer &streamer,
1321                                     const MCSymbol &cieStart,
1322                                     const MCDwarfFrameInfo &frame) {
1323   MCContext &context = streamer.getContext();
1324   MCSymbol *fdeStart = context.CreateTempSymbol();
1325   MCSymbol *fdeEnd = context.CreateTempSymbol();
1326   const MCObjectFileInfo *MOFI = context.getObjectFileInfo();
1327   bool verboseAsm = streamer.isVerboseAsm();
1328
1329   if (IsEH && frame.Function && !MOFI->isFunctionEHFrameSymbolPrivate()) {
1330     MCSymbol *EHSym =
1331       context.GetOrCreateSymbol(frame.Function->getName() + Twine(".eh"));
1332     streamer.EmitEHSymAttributes(frame.Function, EHSym);
1333     streamer.EmitLabel(EHSym);
1334   }
1335
1336   // Length
1337   const MCExpr *Length = MakeStartMinusEndExpr(streamer, *fdeStart, *fdeEnd, 0);
1338   if (verboseAsm) streamer.AddComment("FDE Length");
1339   streamer.EmitAbsValue(Length, 4);
1340
1341   streamer.EmitLabel(fdeStart);
1342
1343   // CIE Pointer
1344   const MCAsmInfo &asmInfo = context.getAsmInfo();
1345   if (IsEH) {
1346     const MCExpr *offset = MakeStartMinusEndExpr(streamer, cieStart, *fdeStart,
1347                                                  0);
1348     if (verboseAsm) streamer.AddComment("FDE CIE Offset");
1349     streamer.EmitAbsValue(offset, 4);
1350   } else if (!asmInfo.doesDwarfUseRelocationsAcrossSections()) {
1351     const MCExpr *offset = MakeStartMinusEndExpr(streamer, *SectionStart,
1352                                                  cieStart, 0);
1353     streamer.EmitAbsValue(offset, 4);
1354   } else {
1355     streamer.EmitSymbolValue(&cieStart, 4);
1356   }
1357
1358   // PC Begin
1359   unsigned PCEncoding = IsEH ? MOFI->getFDEEncoding(UsingCFI)
1360                              : (unsigned)dwarf::DW_EH_PE_absptr;
1361   unsigned PCSize = getSizeForEncoding(streamer, PCEncoding);
1362   EmitSymbol(streamer, *frame.Begin, PCEncoding, "FDE initial location");
1363
1364   // PC Range
1365   const MCExpr *Range = MakeStartMinusEndExpr(streamer, *frame.Begin,
1366                                               *frame.End, 0);
1367   if (verboseAsm) streamer.AddComment("FDE address range");
1368   streamer.EmitAbsValue(Range, PCSize);
1369
1370   if (IsEH) {
1371     // Augmentation Data Length
1372     unsigned augmentationLength = 0;
1373
1374     if (frame.Lsda)
1375       augmentationLength += getSizeForEncoding(streamer, frame.LsdaEncoding);
1376
1377     if (verboseAsm) streamer.AddComment("Augmentation size");
1378     streamer.EmitULEB128IntValue(augmentationLength);
1379
1380     // Augmentation Data
1381     if (frame.Lsda)
1382       EmitSymbol(streamer, *frame.Lsda, frame.LsdaEncoding,
1383                  "Language Specific Data Area");
1384   }
1385
1386   // Call Frame Instructions
1387   EmitCFIInstructions(streamer, frame.Instructions, frame.Begin);
1388
1389   // Padding
1390   streamer.EmitValueToAlignment(PCSize);
1391
1392   return fdeEnd;
1393 }
1394
1395 namespace {
1396   struct CIEKey {
1397     static const CIEKey getEmptyKey() { return CIEKey(0, 0, -1, false); }
1398     static const CIEKey getTombstoneKey() { return CIEKey(0, -1, 0, false); }
1399
1400     CIEKey(const MCSymbol* Personality_, unsigned PersonalityEncoding_,
1401            unsigned LsdaEncoding_, bool IsSignalFrame_) :
1402       Personality(Personality_), PersonalityEncoding(PersonalityEncoding_),
1403       LsdaEncoding(LsdaEncoding_), IsSignalFrame(IsSignalFrame_) {
1404     }
1405     const MCSymbol* Personality;
1406     unsigned PersonalityEncoding;
1407     unsigned LsdaEncoding;
1408     bool IsSignalFrame;
1409   };
1410 }
1411
1412 namespace llvm {
1413   template <>
1414   struct DenseMapInfo<CIEKey> {
1415     static CIEKey getEmptyKey() {
1416       return CIEKey::getEmptyKey();
1417     }
1418     static CIEKey getTombstoneKey() {
1419       return CIEKey::getTombstoneKey();
1420     }
1421     static unsigned getHashValue(const CIEKey &Key) {
1422       return static_cast<unsigned>(hash_combine(Key.Personality,
1423                                                 Key.PersonalityEncoding,
1424                                                 Key.LsdaEncoding,
1425                                                 Key.IsSignalFrame));
1426     }
1427     static bool isEqual(const CIEKey &LHS,
1428                         const CIEKey &RHS) {
1429       return LHS.Personality == RHS.Personality &&
1430         LHS.PersonalityEncoding == RHS.PersonalityEncoding &&
1431         LHS.LsdaEncoding == RHS.LsdaEncoding &&
1432         LHS.IsSignalFrame == RHS.IsSignalFrame;
1433     }
1434   };
1435 }
1436
1437 void MCDwarfFrameEmitter::Emit(MCStreamer &Streamer,
1438                                bool UsingCFI,
1439                                bool IsEH) {
1440   MCContext &Context = Streamer.getContext();
1441   const MCObjectFileInfo *MOFI = Context.getObjectFileInfo();
1442   FrameEmitterImpl Emitter(UsingCFI, IsEH);
1443   ArrayRef<MCDwarfFrameInfo> FrameArray = Streamer.getFrameInfos();
1444
1445   // Emit the compact unwind info if available.
1446   if (IsEH && MOFI->getCompactUnwindSection()) {
1447     bool SectionEmitted = false;
1448     for (unsigned i = 0, n = FrameArray.size(); i < n; ++i) {
1449       const MCDwarfFrameInfo &Frame = FrameArray[i];
1450       if (Frame.CompactUnwindEncoding == 0) continue;
1451       if (!SectionEmitted) {
1452         Streamer.SwitchSection(MOFI->getCompactUnwindSection());
1453         Streamer.EmitValueToAlignment(Context.getAsmInfo().getPointerSize());
1454         SectionEmitted = true;
1455       }
1456       Emitter.EmitCompactUnwind(Streamer, Frame);
1457     }
1458   }
1459
1460   const MCSection &Section =
1461     IsEH ? *const_cast<MCObjectFileInfo*>(MOFI)->getEHFrameSection() :
1462            *MOFI->getDwarfFrameSection();
1463   Streamer.SwitchSection(&Section);
1464   MCSymbol *SectionStart = Context.CreateTempSymbol();
1465   Streamer.EmitLabel(SectionStart);
1466   Emitter.setSectionStart(SectionStart);
1467
1468   MCSymbol *FDEEnd = NULL;
1469   DenseMap<CIEKey, const MCSymbol*> CIEStarts;
1470
1471   const MCSymbol *DummyDebugKey = NULL;
1472   for (unsigned i = 0, n = FrameArray.size(); i < n; ++i) {
1473     const MCDwarfFrameInfo &Frame = FrameArray[i];
1474     CIEKey Key(Frame.Personality, Frame.PersonalityEncoding,
1475                Frame.LsdaEncoding, Frame.IsSignalFrame);
1476     const MCSymbol *&CIEStart = IsEH ? CIEStarts[Key] : DummyDebugKey;
1477     if (!CIEStart)
1478       CIEStart = &Emitter.EmitCIE(Streamer, Frame.Personality,
1479                                   Frame.PersonalityEncoding, Frame.Lsda,
1480                                   Frame.IsSignalFrame,
1481                                   Frame.LsdaEncoding);
1482
1483     FDEEnd = Emitter.EmitFDE(Streamer, *CIEStart, Frame);
1484
1485     if (i != n - 1)
1486       Streamer.EmitLabel(FDEEnd);
1487   }
1488
1489   Streamer.EmitValueToAlignment(Context.getAsmInfo().getPointerSize());
1490   if (FDEEnd)
1491     Streamer.EmitLabel(FDEEnd);
1492 }
1493
1494 void MCDwarfFrameEmitter::EmitAdvanceLoc(MCStreamer &Streamer,
1495                                          uint64_t AddrDelta) {
1496   SmallString<256> Tmp;
1497   raw_svector_ostream OS(Tmp);
1498   MCDwarfFrameEmitter::EncodeAdvanceLoc(AddrDelta, OS);
1499   Streamer.EmitBytes(OS.str());
1500 }
1501
1502 void MCDwarfFrameEmitter::EncodeAdvanceLoc(uint64_t AddrDelta,
1503                                            raw_ostream &OS) {
1504   // FIXME: Assumes the code alignment factor is 1.
1505   if (AddrDelta == 0) {
1506   } else if (isUIntN(6, AddrDelta)) {
1507     uint8_t Opcode = dwarf::DW_CFA_advance_loc | AddrDelta;
1508     OS << Opcode;
1509   } else if (isUInt<8>(AddrDelta)) {
1510     OS << uint8_t(dwarf::DW_CFA_advance_loc1);
1511     OS << uint8_t(AddrDelta);
1512   } else if (isUInt<16>(AddrDelta)) {
1513     // FIXME: check what is the correct behavior on a big endian machine.
1514     OS << uint8_t(dwarf::DW_CFA_advance_loc2);
1515     OS << uint8_t( AddrDelta       & 0xff);
1516     OS << uint8_t((AddrDelta >> 8) & 0xff);
1517   } else {
1518     // FIXME: check what is the correct behavior on a big endian machine.
1519     assert(isUInt<32>(AddrDelta));
1520     OS << uint8_t(dwarf::DW_CFA_advance_loc4);
1521     OS << uint8_t( AddrDelta        & 0xff);
1522     OS << uint8_t((AddrDelta >> 8)  & 0xff);
1523     OS << uint8_t((AddrDelta >> 16) & 0xff);
1524     OS << uint8_t((AddrDelta >> 24) & 0xff);
1525
1526   }
1527 }