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