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