a6c4e282a2d83682c47fb7730fae27c7ffa41ca6
[oota-llvm.git] / lib / MC / MCAsmStreamer.cpp
1 //===- lib/MC/MCAsmStreamer.cpp - Text Assembly Output --------------------===//
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/MCStreamer.h"
11 #include "llvm/ADT/STLExtras.h"
12 #include "llvm/ADT/SmallString.h"
13 #include "llvm/ADT/StringExtras.h"
14 #include "llvm/ADT/Twine.h"
15 #include "llvm/MC/MCAsmBackend.h"
16 #include "llvm/MC/MCAsmInfo.h"
17 #include "llvm/MC/MCCodeEmitter.h"
18 #include "llvm/MC/MCContext.h"
19 #include "llvm/MC/MCExpr.h"
20 #include "llvm/MC/MCFixupKindInfo.h"
21 #include "llvm/MC/MCInst.h"
22 #include "llvm/MC/MCInstPrinter.h"
23 #include "llvm/MC/MCObjectFileInfo.h"
24 #include "llvm/MC/MCRegisterInfo.h"
25 #include "llvm/MC/MCSectionCOFF.h"
26 #include "llvm/MC/MCSectionMachO.h"
27 #include "llvm/MC/MCSymbolELF.h"
28 #include "llvm/Support/CommandLine.h"
29 #include "llvm/Support/ErrorHandling.h"
30 #include "llvm/Support/Format.h"
31 #include "llvm/Support/FormattedStream.h"
32 #include "llvm/Support/LEB128.h"
33 #include "llvm/Support/MathExtras.h"
34 #include "llvm/Support/Path.h"
35 #include <cctype>
36 using namespace llvm;
37
38 namespace {
39
40 class MCAsmStreamer final : public MCStreamer {
41   std::unique_ptr<formatted_raw_ostream> OSOwner;
42   formatted_raw_ostream &OS;
43   const MCAsmInfo *MAI;
44   std::unique_ptr<MCInstPrinter> InstPrinter;
45   std::unique_ptr<MCCodeEmitter> Emitter;
46   std::unique_ptr<MCAsmBackend> AsmBackend;
47
48   SmallString<128> CommentToEmit;
49   raw_svector_ostream CommentStream;
50
51   unsigned IsVerboseAsm : 1;
52   unsigned ShowInst : 1;
53   unsigned UseDwarfDirectory : 1;
54
55   void EmitRegisterName(int64_t Register);
56   void EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame) override;
57   void EmitCFIEndProcImpl(MCDwarfFrameInfo &Frame) override;
58
59 public:
60   MCAsmStreamer(MCContext &Context, std::unique_ptr<formatted_raw_ostream> os,
61                 bool isVerboseAsm, bool useDwarfDirectory,
62                 MCInstPrinter *printer, MCCodeEmitter *emitter,
63                 MCAsmBackend *asmbackend, bool showInst)
64       : MCStreamer(Context), OSOwner(std::move(os)), OS(*OSOwner),
65         MAI(Context.getAsmInfo()), InstPrinter(printer), Emitter(emitter),
66         AsmBackend(asmbackend), CommentStream(CommentToEmit),
67         IsVerboseAsm(isVerboseAsm), ShowInst(showInst),
68         UseDwarfDirectory(useDwarfDirectory) {
69     assert(InstPrinter);
70     if (IsVerboseAsm)
71         InstPrinter->setCommentStream(CommentStream);
72   }
73
74   inline void EmitEOL() {
75     // If we don't have any comments, just emit a \n.
76     if (!IsVerboseAsm) {
77       OS << '\n';
78       return;
79     }
80     EmitCommentsAndEOL();
81   }
82
83   void EmitSyntaxDirective() override;
84
85   void EmitCommentsAndEOL();
86
87   /// isVerboseAsm - Return true if this streamer supports verbose assembly at
88   /// all.
89   bool isVerboseAsm() const override { return IsVerboseAsm; }
90
91   /// hasRawTextSupport - We support EmitRawText.
92   bool hasRawTextSupport() const override { return true; }
93
94   /// AddComment - Add a comment that can be emitted to the generated .s
95   /// file if applicable as a QoI issue to make the output of the compiler
96   /// more readable.  This only affects the MCAsmStreamer, and only when
97   /// verbose assembly output is enabled.
98   void AddComment(const Twine &T) override;
99
100   /// AddEncodingComment - Add a comment showing the encoding of an instruction.
101   void AddEncodingComment(const MCInst &Inst, const MCSubtargetInfo &);
102
103   /// GetCommentOS - Return a raw_ostream that comments can be written to.
104   /// Unlike AddComment, you are required to terminate comments with \n if you
105   /// use this method.
106   raw_ostream &GetCommentOS() override {
107     if (!IsVerboseAsm)
108       return nulls();  // Discard comments unless in verbose asm mode.
109     return CommentStream;
110   }
111
112   void emitRawComment(const Twine &T, bool TabPrefix = true) override;
113
114   /// AddBlankLine - Emit a blank line to a .s file to pretty it up.
115   void AddBlankLine() override {
116     EmitEOL();
117   }
118
119   /// @name MCStreamer Interface
120   /// @{
121
122   void ChangeSection(MCSection *Section, const MCExpr *Subsection) override;
123
124   void EmitLOHDirective(MCLOHType Kind, const MCLOHArgs &Args) override;
125   void EmitLabel(MCSymbol *Symbol) override;
126
127   void EmitAssemblerFlag(MCAssemblerFlag Flag) override;
128   void EmitLinkerOptions(ArrayRef<std::string> Options) override;
129   void EmitDataRegion(MCDataRegionType Kind) override;
130   void EmitVersionMin(MCVersionMinType Kind, unsigned Major, unsigned Minor,
131                       unsigned Update) override;
132   void EmitThumbFunc(MCSymbol *Func) override;
133
134   void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) override;
135   void EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) override;
136   bool EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute) override;
137
138   void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) override;
139   void BeginCOFFSymbolDef(const MCSymbol *Symbol) override;
140   void EmitCOFFSymbolStorageClass(int StorageClass) override;
141   void EmitCOFFSymbolType(int Type) override;
142   void EndCOFFSymbolDef() override;
143   void EmitCOFFSafeSEH(MCSymbol const *Symbol) override;
144   void EmitCOFFSectionIndex(MCSymbol const *Symbol) override;
145   void EmitCOFFSecRel32(MCSymbol const *Symbol) override;
146   void emitELFSize(MCSymbolELF *Symbol, const MCExpr *Value) override;
147   void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
148                         unsigned ByteAlignment) override;
149
150   /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
151   ///
152   /// @param Symbol - The common symbol to emit.
153   /// @param Size - The size of the common symbol.
154   /// @param ByteAlignment - The alignment of the common symbol in bytes.
155   void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
156                              unsigned ByteAlignment) override;
157
158   void EmitZerofill(MCSection *Section, MCSymbol *Symbol = nullptr,
159                     uint64_t Size = 0, unsigned ByteAlignment = 0) override;
160
161   void EmitTBSSSymbol(MCSection *Section, MCSymbol *Symbol, uint64_t Size,
162                       unsigned ByteAlignment = 0) override;
163
164   void EmitBytes(StringRef Data) override;
165
166   void EmitValueImpl(const MCExpr *Value, unsigned Size,
167                      SMLoc Loc = SMLoc()) override;
168   void EmitIntValue(uint64_t Value, unsigned Size) override;
169
170   void EmitULEB128Value(const MCExpr *Value) override;
171
172   void EmitSLEB128Value(const MCExpr *Value) override;
173
174   void EmitGPRel64Value(const MCExpr *Value) override;
175
176   void EmitGPRel32Value(const MCExpr *Value) override;
177
178
179   void EmitFill(uint64_t NumBytes, uint8_t FillValue) override;
180
181   void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
182                             unsigned ValueSize = 1,
183                             unsigned MaxBytesToEmit = 0) override;
184
185   void EmitCodeAlignment(unsigned ByteAlignment,
186                          unsigned MaxBytesToEmit = 0) override;
187
188   bool EmitValueToOffset(const MCExpr *Offset,
189                          unsigned char Value = 0) override;
190
191   void EmitFileDirective(StringRef Filename) override;
192   unsigned EmitDwarfFileDirective(unsigned FileNo, StringRef Directory,
193                                   StringRef Filename,
194                                   unsigned CUID = 0) override;
195   void EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
196                              unsigned Column, unsigned Flags,
197                              unsigned Isa, unsigned Discriminator,
198                              StringRef FileName) override;
199   MCSymbol *getDwarfLineTableSymbol(unsigned CUID) override;
200
201   void EmitIdent(StringRef IdentString) override;
202   void EmitCFISections(bool EH, bool Debug) override;
203   void EmitCFIDefCfa(int64_t Register, int64_t Offset) override;
204   void EmitCFIDefCfaOffset(int64_t Offset) override;
205   void EmitCFIDefCfaRegister(int64_t Register) override;
206   void EmitCFIOffset(int64_t Register, int64_t Offset) override;
207   void EmitCFIPersonality(const MCSymbol *Sym, unsigned Encoding) override;
208   void EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) override;
209   void EmitCFIRememberState() override;
210   void EmitCFIRestoreState() override;
211   void EmitCFISameValue(int64_t Register) override;
212   void EmitCFIRelOffset(int64_t Register, int64_t Offset) override;
213   void EmitCFIAdjustCfaOffset(int64_t Adjustment) override;
214   void EmitCFIEscape(StringRef Values) override;
215   void EmitCFIGnuArgsSize(int64_t Size) override;
216   void EmitCFISignalFrame() override;
217   void EmitCFIUndefined(int64_t Register) override;
218   void EmitCFIRegister(int64_t Register1, int64_t Register2) override;
219   void EmitCFIWindowSave() override;
220
221   void EmitWinCFIStartProc(const MCSymbol *Symbol) override;
222   void EmitWinCFIEndProc() override;
223   void EmitWinCFIStartChained() override;
224   void EmitWinCFIEndChained() override;
225   void EmitWinCFIPushReg(unsigned Register) override;
226   void EmitWinCFISetFrame(unsigned Register, unsigned Offset) override;
227   void EmitWinCFIAllocStack(unsigned Size) override;
228   void EmitWinCFISaveReg(unsigned Register, unsigned Offset) override;
229   void EmitWinCFISaveXMM(unsigned Register, unsigned Offset) override;
230   void EmitWinCFIPushFrame(bool Code) override;
231   void EmitWinCFIEndProlog() override;
232
233   void EmitWinEHHandler(const MCSymbol *Sym, bool Unwind, bool Except) override;
234   void EmitWinEHHandlerData() override;
235
236   void EmitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI) override;
237
238   void EmitBundleAlignMode(unsigned AlignPow2) override;
239   void EmitBundleLock(bool AlignToEnd) override;
240   void EmitBundleUnlock() override;
241
242   /// EmitRawText - If this file is backed by an assembly streamer, this dumps
243   /// the specified string in the output .s file.  This capability is
244   /// indicated by the hasRawTextSupport() predicate.
245   void EmitRawTextImpl(StringRef String) override;
246
247   void FinishImpl() override;
248 };
249
250 } // end anonymous namespace.
251
252 /// AddComment - Add a comment that can be emitted to the generated .s
253 /// file if applicable as a QoI issue to make the output of the compiler
254 /// more readable.  This only affects the MCAsmStreamer, and only when
255 /// verbose assembly output is enabled.
256 void MCAsmStreamer::AddComment(const Twine &T) {
257   if (!IsVerboseAsm) return;
258
259   T.toVector(CommentToEmit);
260   // Each comment goes on its own line.
261   CommentToEmit.push_back('\n');
262 }
263
264 void MCAsmStreamer::EmitCommentsAndEOL() {
265   if (CommentToEmit.empty() && CommentStream.GetNumBytesInBuffer() == 0) {
266     OS << '\n';
267     return;
268   }
269
270   StringRef Comments = CommentToEmit;
271
272   assert(Comments.back() == '\n' &&
273          "Comment array not newline terminated");
274   do {
275     // Emit a line of comments.
276     OS.PadToColumn(MAI->getCommentColumn());
277     size_t Position = Comments.find('\n');
278     OS << MAI->getCommentString() << ' ' << Comments.substr(0, Position) <<'\n';
279
280     Comments = Comments.substr(Position+1);
281   } while (!Comments.empty());
282
283   CommentToEmit.clear();
284 }
285
286 static inline int64_t truncateToSize(int64_t Value, unsigned Bytes) {
287   assert(Bytes && "Invalid size!");
288   return Value & ((uint64_t) (int64_t) -1 >> (64 - Bytes * 8));
289 }
290
291 void MCAsmStreamer::emitRawComment(const Twine &T, bool TabPrefix) {
292   if (TabPrefix)
293     OS << '\t';
294   OS << MAI->getCommentString() << T;
295   EmitEOL();
296 }
297
298 void MCAsmStreamer::ChangeSection(MCSection *Section,
299                                   const MCExpr *Subsection) {
300   assert(Section && "Cannot switch to a null section!");
301   Section->PrintSwitchToSection(*MAI, OS, Subsection);
302 }
303
304 void MCAsmStreamer::EmitLabel(MCSymbol *Symbol) {
305   assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
306   MCStreamer::EmitLabel(Symbol);
307
308   Symbol->print(OS, MAI);
309   OS << MAI->getLabelSuffix();
310
311   EmitEOL();
312 }
313
314 void MCAsmStreamer::EmitLOHDirective(MCLOHType Kind, const MCLOHArgs &Args) {
315   StringRef str = MCLOHIdToName(Kind);
316
317 #ifndef NDEBUG
318   int NbArgs = MCLOHIdToNbArgs(Kind);
319   assert(NbArgs != -1 && ((size_t)NbArgs) == Args.size() && "Malformed LOH!");
320   assert(str != "" && "Invalid LOH name");
321 #endif
322
323   OS << "\t" << MCLOHDirectiveName() << " " << str << "\t";
324   bool IsFirst = true;
325   for (MCLOHArgs::const_iterator It = Args.begin(), EndIt = Args.end();
326        It != EndIt; ++It) {
327     if (!IsFirst)
328       OS << ", ";
329     IsFirst = false;
330     (*It)->print(OS, MAI);
331   }
332   EmitEOL();
333 }
334
335 void MCAsmStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
336   switch (Flag) {
337   case MCAF_SyntaxUnified:         OS << "\t.syntax unified"; break;
338   case MCAF_SubsectionsViaSymbols: OS << ".subsections_via_symbols"; break;
339   case MCAF_Code16:                OS << '\t'<< MAI->getCode16Directive();break;
340   case MCAF_Code32:                OS << '\t'<< MAI->getCode32Directive();break;
341   case MCAF_Code64:                OS << '\t'<< MAI->getCode64Directive();break;
342   }
343   EmitEOL();
344 }
345
346 void MCAsmStreamer::EmitLinkerOptions(ArrayRef<std::string> Options) {
347   assert(!Options.empty() && "At least one option is required!");
348   OS << "\t.linker_option \"" << Options[0] << '"';
349   for (ArrayRef<std::string>::iterator it = Options.begin() + 1,
350          ie = Options.end(); it != ie; ++it) {
351     OS << ", " << '"' << *it << '"';
352   }
353   OS << "\n";
354 }
355
356 void MCAsmStreamer::EmitDataRegion(MCDataRegionType Kind) {
357   if (!MAI->doesSupportDataRegionDirectives())
358     return;
359   switch (Kind) {
360   case MCDR_DataRegion:            OS << "\t.data_region"; break;
361   case MCDR_DataRegionJT8:         OS << "\t.data_region jt8"; break;
362   case MCDR_DataRegionJT16:        OS << "\t.data_region jt16"; break;
363   case MCDR_DataRegionJT32:        OS << "\t.data_region jt32"; break;
364   case MCDR_DataRegionEnd:         OS << "\t.end_data_region"; break;
365   }
366   EmitEOL();
367 }
368
369 void MCAsmStreamer::EmitVersionMin(MCVersionMinType Kind, unsigned Major,
370                                    unsigned Minor, unsigned Update) {
371   switch (Kind) {
372   case MCVM_IOSVersionMin:        OS << "\t.ios_version_min"; break;
373   case MCVM_OSXVersionMin:        OS << "\t.macosx_version_min"; break;
374   }
375   OS << " " << Major << ", " << Minor;
376   if (Update)
377     OS << ", " << Update;
378   EmitEOL();
379 }
380
381 void MCAsmStreamer::EmitThumbFunc(MCSymbol *Func) {
382   // This needs to emit to a temporary string to get properly quoted
383   // MCSymbols when they have spaces in them.
384   OS << "\t.thumb_func";
385   // Only Mach-O hasSubsectionsViaSymbols()
386   if (MAI->hasSubsectionsViaSymbols()) {
387     OS << '\t';
388     Func->print(OS, MAI);
389   }
390   EmitEOL();
391 }
392
393 void MCAsmStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
394   Symbol->print(OS, MAI);
395   OS << " = ";
396   Value->print(OS, MAI);
397
398   EmitEOL();
399
400   MCStreamer::EmitAssignment(Symbol, Value);
401 }
402
403 void MCAsmStreamer::EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) {
404   OS << ".weakref ";
405   Alias->print(OS, MAI);
406   OS << ", ";
407   Symbol->print(OS, MAI);
408   EmitEOL();
409 }
410
411 bool MCAsmStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
412                                         MCSymbolAttr Attribute) {
413   switch (Attribute) {
414   case MCSA_Invalid: llvm_unreachable("Invalid symbol attribute");
415   case MCSA_ELF_TypeFunction:    /// .type _foo, STT_FUNC  # aka @function
416   case MCSA_ELF_TypeIndFunction: /// .type _foo, STT_GNU_IFUNC
417   case MCSA_ELF_TypeObject:      /// .type _foo, STT_OBJECT  # aka @object
418   case MCSA_ELF_TypeTLS:         /// .type _foo, STT_TLS     # aka @tls_object
419   case MCSA_ELF_TypeCommon:      /// .type _foo, STT_COMMON  # aka @common
420   case MCSA_ELF_TypeNoType:      /// .type _foo, STT_NOTYPE  # aka @notype
421   case MCSA_ELF_TypeGnuUniqueObject:  /// .type _foo, @gnu_unique_object
422     if (!MAI->hasDotTypeDotSizeDirective())
423       return false; // Symbol attribute not supported
424     OS << "\t.type\t";
425     Symbol->print(OS, MAI);
426     OS << ',' << ((MAI->getCommentString()[0] != '@') ? '@' : '%');
427     switch (Attribute) {
428     default: return false;
429     case MCSA_ELF_TypeFunction:    OS << "function"; break;
430     case MCSA_ELF_TypeIndFunction: OS << "gnu_indirect_function"; break;
431     case MCSA_ELF_TypeObject:      OS << "object"; break;
432     case MCSA_ELF_TypeTLS:         OS << "tls_object"; break;
433     case MCSA_ELF_TypeCommon:      OS << "common"; break;
434     case MCSA_ELF_TypeNoType:      OS << "no_type"; break;
435     case MCSA_ELF_TypeGnuUniqueObject: OS << "gnu_unique_object"; break;
436     }
437     EmitEOL();
438     return true;
439   case MCSA_Global: // .globl/.global
440     OS << MAI->getGlobalDirective();
441     break;
442   case MCSA_Hidden:         OS << "\t.hidden\t";          break;
443   case MCSA_IndirectSymbol: OS << "\t.indirect_symbol\t"; break;
444   case MCSA_Internal:       OS << "\t.internal\t";        break;
445   case MCSA_LazyReference:  OS << "\t.lazy_reference\t";  break;
446   case MCSA_Local:          OS << "\t.local\t";           break;
447   case MCSA_NoDeadStrip:
448     if (!MAI->hasNoDeadStrip())
449       return false;
450     OS << "\t.no_dead_strip\t";
451     break;
452   case MCSA_SymbolResolver: OS << "\t.symbol_resolver\t"; break;
453   case MCSA_PrivateExtern:
454     OS << "\t.private_extern\t";
455     break;
456   case MCSA_Protected:      OS << "\t.protected\t";       break;
457   case MCSA_Reference:      OS << "\t.reference\t";       break;
458   case MCSA_Weak:           OS << MAI->getWeakDirective(); break;
459   case MCSA_WeakDefinition:
460     OS << "\t.weak_definition\t";
461     break;
462       // .weak_reference
463   case MCSA_WeakReference:  OS << MAI->getWeakRefDirective(); break;
464   case MCSA_WeakDefAutoPrivate: OS << "\t.weak_def_can_be_hidden\t"; break;
465   }
466
467   Symbol->print(OS, MAI);
468   EmitEOL();
469
470   return true;
471 }
472
473 void MCAsmStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
474   OS << ".desc" << ' ';
475   Symbol->print(OS, MAI);
476   OS << ',' << DescValue;
477   EmitEOL();
478 }
479
480 void MCAsmStreamer::EmitSyntaxDirective() {
481   if (MAI->getAssemblerDialect() == 1)
482     OS << "\t.intel_syntax noprefix\n";
483   // FIXME: Currently emit unprefix'ed registers.
484   // The intel_syntax directive has one optional argument 
485   // with may have a value of prefix or noprefix.
486 }
487
488 void MCAsmStreamer::BeginCOFFSymbolDef(const MCSymbol *Symbol) {
489   OS << "\t.def\t ";
490   Symbol->print(OS, MAI);
491   OS << ';';
492   EmitEOL();
493 }
494
495 void MCAsmStreamer::EmitCOFFSymbolStorageClass (int StorageClass) {
496   OS << "\t.scl\t" << StorageClass << ';';
497   EmitEOL();
498 }
499
500 void MCAsmStreamer::EmitCOFFSymbolType (int Type) {
501   OS << "\t.type\t" << Type << ';';
502   EmitEOL();
503 }
504
505 void MCAsmStreamer::EndCOFFSymbolDef() {
506   OS << "\t.endef";
507   EmitEOL();
508 }
509
510 void MCAsmStreamer::EmitCOFFSafeSEH(MCSymbol const *Symbol) {
511   OS << "\t.safeseh\t";
512   Symbol->print(OS, MAI);
513   EmitEOL();
514 }
515
516 void MCAsmStreamer::EmitCOFFSectionIndex(MCSymbol const *Symbol) {
517   OS << "\t.secidx\t";
518   Symbol->print(OS, MAI);
519   EmitEOL();
520 }
521
522 void MCAsmStreamer::EmitCOFFSecRel32(MCSymbol const *Symbol) {
523   OS << "\t.secrel32\t";
524   Symbol->print(OS, MAI);
525   EmitEOL();
526 }
527
528 void MCAsmStreamer::emitELFSize(MCSymbolELF *Symbol, const MCExpr *Value) {
529   assert(MAI->hasDotTypeDotSizeDirective());
530   OS << "\t.size\t";
531   Symbol->print(OS, MAI);
532   OS << ", ";
533   Value->print(OS, MAI);
534   OS << '\n';
535 }
536
537 void MCAsmStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
538                                      unsigned ByteAlignment) {
539   OS << "\t.comm\t";
540   Symbol->print(OS, MAI);
541   OS << ',' << Size;
542
543   if (ByteAlignment != 0) {
544     if (MAI->getCOMMDirectiveAlignmentIsInBytes())
545       OS << ',' << ByteAlignment;
546     else
547       OS << ',' << Log2_32(ByteAlignment);
548   }
549   EmitEOL();
550 }
551
552 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
553 ///
554 /// @param Symbol - The common symbol to emit.
555 /// @param Size - The size of the common symbol.
556 void MCAsmStreamer::EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
557                                           unsigned ByteAlign) {
558   OS << "\t.lcomm\t";
559   Symbol->print(OS, MAI);
560   OS << ',' << Size;
561
562   if (ByteAlign > 1) {
563     switch (MAI->getLCOMMDirectiveAlignmentType()) {
564     case LCOMM::NoAlignment:
565       llvm_unreachable("alignment not supported on .lcomm!");
566     case LCOMM::ByteAlignment:
567       OS << ',' << ByteAlign;
568       break;
569     case LCOMM::Log2Alignment:
570       assert(isPowerOf2_32(ByteAlign) && "alignment must be a power of 2");
571       OS << ',' << Log2_32(ByteAlign);
572       break;
573     }
574   }
575   EmitEOL();
576 }
577
578 void MCAsmStreamer::EmitZerofill(MCSection *Section, MCSymbol *Symbol,
579                                  uint64_t Size, unsigned ByteAlignment) {
580   if (Symbol)
581     AssignFragment(Symbol, &Section->getDummyFragment());
582
583   // Note: a .zerofill directive does not switch sections.
584   OS << ".zerofill ";
585
586   // This is a mach-o specific directive.
587   const MCSectionMachO *MOSection = ((const MCSectionMachO*)Section);
588   OS << MOSection->getSegmentName() << "," << MOSection->getSectionName();
589
590   if (Symbol) {
591     OS << ',';
592     Symbol->print(OS, MAI);
593     OS << ',' << Size;
594     if (ByteAlignment != 0)
595       OS << ',' << Log2_32(ByteAlignment);
596   }
597   EmitEOL();
598 }
599
600 // .tbss sym, size, align
601 // This depends that the symbol has already been mangled from the original,
602 // e.g. _a.
603 void MCAsmStreamer::EmitTBSSSymbol(MCSection *Section, MCSymbol *Symbol,
604                                    uint64_t Size, unsigned ByteAlignment) {
605   AssignFragment(Symbol, &Section->getDummyFragment());
606
607   assert(Symbol && "Symbol shouldn't be NULL!");
608   // Instead of using the Section we'll just use the shortcut.
609   // This is a mach-o specific directive and section.
610   OS << ".tbss ";
611   Symbol->print(OS, MAI);
612   OS << ", " << Size;
613
614   // Output align if we have it.  We default to 1 so don't bother printing
615   // that.
616   if (ByteAlignment > 1) OS << ", " << Log2_32(ByteAlignment);
617
618   EmitEOL();
619 }
620
621 static inline char toOctal(int X) { return (X&7)+'0'; }
622
623 static void PrintQuotedString(StringRef Data, raw_ostream &OS) {
624   OS << '"';
625
626   for (unsigned i = 0, e = Data.size(); i != e; ++i) {
627     unsigned char C = Data[i];
628     if (C == '"' || C == '\\') {
629       OS << '\\' << (char)C;
630       continue;
631     }
632
633     if (isprint((unsigned char)C)) {
634       OS << (char)C;
635       continue;
636     }
637
638     switch (C) {
639       case '\b': OS << "\\b"; break;
640       case '\f': OS << "\\f"; break;
641       case '\n': OS << "\\n"; break;
642       case '\r': OS << "\\r"; break;
643       case '\t': OS << "\\t"; break;
644       default:
645         OS << '\\';
646         OS << toOctal(C >> 6);
647         OS << toOctal(C >> 3);
648         OS << toOctal(C >> 0);
649         break;
650     }
651   }
652
653   OS << '"';
654 }
655
656
657 void MCAsmStreamer::EmitBytes(StringRef Data) {
658   assert(getCurrentSection().first &&
659          "Cannot emit contents before setting section!");
660   if (Data.empty()) return;
661
662   if (Data.size() == 1) {
663     OS << MAI->getData8bitsDirective();
664     OS << (unsigned)(unsigned char)Data[0];
665     EmitEOL();
666     return;
667   }
668
669   // If the data ends with 0 and the target supports .asciz, use it, otherwise
670   // use .ascii
671   if (MAI->getAscizDirective() && Data.back() == 0) {
672     OS << MAI->getAscizDirective();
673     Data = Data.substr(0, Data.size()-1);
674   } else {
675     OS << MAI->getAsciiDirective();
676   }
677
678   PrintQuotedString(Data, OS);
679   EmitEOL();
680 }
681
682 void MCAsmStreamer::EmitIntValue(uint64_t Value, unsigned Size) {
683   EmitValue(MCConstantExpr::create(Value, getContext()), Size);
684 }
685
686 void MCAsmStreamer::EmitValueImpl(const MCExpr *Value, unsigned Size,
687                                   SMLoc Loc) {
688   assert(Size <= 8 && "Invalid size");
689   assert(getCurrentSection().first &&
690          "Cannot emit contents before setting section!");
691   const char *Directive = nullptr;
692   switch (Size) {
693   default: break;
694   case 1: Directive = MAI->getData8bitsDirective();  break;
695   case 2: Directive = MAI->getData16bitsDirective(); break;
696   case 4: Directive = MAI->getData32bitsDirective(); break;
697   case 8: Directive = MAI->getData64bitsDirective(); break;
698   }
699
700   if (!Directive) {
701     int64_t IntValue;
702     if (!Value->evaluateAsAbsolute(IntValue))
703       report_fatal_error("Don't know how to emit this value.");
704
705     // We couldn't handle the requested integer size so we fallback by breaking
706     // the request down into several, smaller, integers.  Since sizes greater
707     // than eight are invalid and size equivalent to eight should have been
708     // handled earlier, we use four bytes as our largest piece of granularity.
709     bool IsLittleEndian = MAI->isLittleEndian();
710     for (unsigned Emitted = 0; Emitted != Size;) {
711       unsigned Remaining = Size - Emitted;
712       // The size of our partial emission must be a power of two less than
713       // eight.
714       unsigned EmissionSize = PowerOf2Floor(Remaining);
715       if (EmissionSize > 4)
716         EmissionSize = 4;
717       // Calculate the byte offset of our partial emission taking into account
718       // the endianness of the target.
719       unsigned ByteOffset =
720           IsLittleEndian ? Emitted : (Remaining - EmissionSize);
721       uint64_t ValueToEmit = IntValue >> (ByteOffset * 8);
722       // We truncate our partial emission to fit within the bounds of the
723       // emission domain.  This produces nicer output and silences potential
724       // truncation warnings when round tripping through another assembler.
725       uint64_t Shift = 64 - EmissionSize * 8;
726       assert(Shift < static_cast<uint64_t>(
727                          std::numeric_limits<unsigned long long>::digits) &&
728              "undefined behavior");
729       ValueToEmit &= ~0ULL >> Shift;
730       EmitIntValue(ValueToEmit, EmissionSize);
731       Emitted += EmissionSize;
732     }
733     return;
734   }
735
736   assert(Directive && "Invalid size for machine code value!");
737   OS << Directive;
738   Value->print(OS, MAI);
739   EmitEOL();
740 }
741
742 void MCAsmStreamer::EmitULEB128Value(const MCExpr *Value) {
743   int64_t IntValue;
744   if (Value->evaluateAsAbsolute(IntValue)) {
745     EmitULEB128IntValue(IntValue);
746     return;
747   }
748   OS << ".uleb128 ";
749   Value->print(OS, MAI);
750   EmitEOL();
751 }
752
753 void MCAsmStreamer::EmitSLEB128Value(const MCExpr *Value) {
754   int64_t IntValue;
755   if (Value->evaluateAsAbsolute(IntValue)) {
756     EmitSLEB128IntValue(IntValue);
757     return;
758   }
759   OS << ".sleb128 ";
760   Value->print(OS, MAI);
761   EmitEOL();
762 }
763
764 void MCAsmStreamer::EmitGPRel64Value(const MCExpr *Value) {
765   assert(MAI->getGPRel64Directive() != nullptr);
766   OS << MAI->getGPRel64Directive();
767   Value->print(OS, MAI);
768   EmitEOL();
769 }
770
771 void MCAsmStreamer::EmitGPRel32Value(const MCExpr *Value) {
772   assert(MAI->getGPRel32Directive() != nullptr);
773   OS << MAI->getGPRel32Directive();
774   Value->print(OS, MAI);
775   EmitEOL();
776 }
777
778
779 /// EmitFill - Emit NumBytes bytes worth of the value specified by
780 /// FillValue.  This implements directives such as '.space'.
781 void MCAsmStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue) {
782   if (NumBytes == 0) return;
783
784   if (const char *ZeroDirective = MAI->getZeroDirective()) {
785     OS << ZeroDirective << NumBytes;
786     if (FillValue != 0)
787       OS << ',' << (int)FillValue;
788     EmitEOL();
789     return;
790   }
791
792   // Emit a byte at a time.
793   MCStreamer::EmitFill(NumBytes, FillValue);
794 }
795
796 void MCAsmStreamer::EmitValueToAlignment(unsigned ByteAlignment, int64_t Value,
797                                          unsigned ValueSize,
798                                          unsigned MaxBytesToEmit) {
799   // Some assemblers don't support non-power of two alignments, so we always
800   // emit alignments as a power of two if possible.
801   if (isPowerOf2_32(ByteAlignment)) {
802     switch (ValueSize) {
803     default:
804       llvm_unreachable("Invalid size for machine code value!");
805     case 1:
806       OS << "\t.align\t";
807       break;
808     case 2:
809       OS << ".p2alignw ";
810       break;
811     case 4:
812       OS << ".p2alignl ";
813       break;
814     case 8:
815       llvm_unreachable("Unsupported alignment size!");
816     }
817
818     if (MAI->getAlignmentIsInBytes())
819       OS << ByteAlignment;
820     else
821       OS << Log2_32(ByteAlignment);
822
823     if (Value || MaxBytesToEmit) {
824       OS << ", 0x";
825       OS.write_hex(truncateToSize(Value, ValueSize));
826
827       if (MaxBytesToEmit)
828         OS << ", " << MaxBytesToEmit;
829     }
830     EmitEOL();
831     return;
832   }
833
834   // Non-power of two alignment.  This is not widely supported by assemblers.
835   // FIXME: Parameterize this based on MAI.
836   switch (ValueSize) {
837   default: llvm_unreachable("Invalid size for machine code value!");
838   case 1: OS << ".balign";  break;
839   case 2: OS << ".balignw"; break;
840   case 4: OS << ".balignl"; break;
841   case 8: llvm_unreachable("Unsupported alignment size!");
842   }
843
844   OS << ' ' << ByteAlignment;
845   OS << ", " << truncateToSize(Value, ValueSize);
846   if (MaxBytesToEmit)
847     OS << ", " << MaxBytesToEmit;
848   EmitEOL();
849 }
850
851 void MCAsmStreamer::EmitCodeAlignment(unsigned ByteAlignment,
852                                       unsigned MaxBytesToEmit) {
853   // Emit with a text fill value.
854   EmitValueToAlignment(ByteAlignment, MAI->getTextAlignFillValue(),
855                        1, MaxBytesToEmit);
856 }
857
858 bool MCAsmStreamer::EmitValueToOffset(const MCExpr *Offset,
859                                       unsigned char Value) {
860   // FIXME: Verify that Offset is associated with the current section.
861   OS << ".org ";
862   Offset->print(OS, MAI);
863   OS << ", " << (unsigned)Value;
864   EmitEOL();
865   return false;
866 }
867
868
869 void MCAsmStreamer::EmitFileDirective(StringRef Filename) {
870   assert(MAI->hasSingleParameterDotFile());
871   OS << "\t.file\t";
872   PrintQuotedString(Filename, OS);
873   EmitEOL();
874 }
875
876 unsigned MCAsmStreamer::EmitDwarfFileDirective(unsigned FileNo,
877                                                StringRef Directory,
878                                                StringRef Filename,
879                                                unsigned CUID) {
880   assert(CUID == 0);
881
882   MCDwarfLineTable &Table = getContext().getMCDwarfLineTable(CUID);
883   unsigned NumFiles = Table.getMCDwarfFiles().size();
884   FileNo = Table.getFile(Directory, Filename, FileNo);
885   if (FileNo == 0)
886     return 0;
887   if (NumFiles == Table.getMCDwarfFiles().size())
888     return FileNo;
889
890   SmallString<128> FullPathName;
891
892   if (!UseDwarfDirectory && !Directory.empty()) {
893     if (sys::path::is_absolute(Filename))
894       Directory = "";
895     else {
896       FullPathName = Directory;
897       sys::path::append(FullPathName, Filename);
898       Directory = "";
899       Filename = FullPathName;
900     }
901   }
902
903   OS << "\t.file\t" << FileNo << ' ';
904   if (!Directory.empty()) {
905     PrintQuotedString(Directory, OS);
906     OS << ' ';
907   }
908   PrintQuotedString(Filename, OS);
909   EmitEOL();
910
911   return FileNo;
912 }
913
914 void MCAsmStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
915                                           unsigned Column, unsigned Flags,
916                                           unsigned Isa,
917                                           unsigned Discriminator,
918                                           StringRef FileName) {
919   OS << "\t.loc\t" << FileNo << " " << Line << " " << Column;
920   if (Flags & DWARF2_FLAG_BASIC_BLOCK)
921     OS << " basic_block";
922   if (Flags & DWARF2_FLAG_PROLOGUE_END)
923     OS << " prologue_end";
924   if (Flags & DWARF2_FLAG_EPILOGUE_BEGIN)
925     OS << " epilogue_begin";
926
927   unsigned OldFlags = getContext().getCurrentDwarfLoc().getFlags();
928   if ((Flags & DWARF2_FLAG_IS_STMT) != (OldFlags & DWARF2_FLAG_IS_STMT)) {
929     OS << " is_stmt ";
930
931     if (Flags & DWARF2_FLAG_IS_STMT)
932       OS << "1";
933     else
934       OS << "0";
935   }
936
937   if (Isa)
938     OS << " isa " << Isa;
939   if (Discriminator)
940     OS << " discriminator " << Discriminator;
941
942   if (IsVerboseAsm) {
943     OS.PadToColumn(MAI->getCommentColumn());
944     OS << MAI->getCommentString() << ' ' << FileName << ':'
945        << Line << ':' << Column;
946   }
947   EmitEOL();
948   this->MCStreamer::EmitDwarfLocDirective(FileNo, Line, Column, Flags,
949                                           Isa, Discriminator, FileName);
950 }
951
952 MCSymbol *MCAsmStreamer::getDwarfLineTableSymbol(unsigned CUID) {
953   // Always use the zeroth line table, since asm syntax only supports one line
954   // table for now.
955   return MCStreamer::getDwarfLineTableSymbol(0);
956 }
957
958 void MCAsmStreamer::EmitIdent(StringRef IdentString) {
959   assert(MAI->hasIdentDirective() && ".ident directive not supported");
960   OS << "\t.ident\t";
961   PrintQuotedString(IdentString, OS);
962   EmitEOL();
963 }
964
965 void MCAsmStreamer::EmitCFISections(bool EH, bool Debug) {
966   MCStreamer::EmitCFISections(EH, Debug);
967   OS << "\t.cfi_sections ";
968   if (EH) {
969     OS << ".eh_frame";
970     if (Debug)
971       OS << ", .debug_frame";
972   } else if (Debug) {
973     OS << ".debug_frame";
974   }
975
976   EmitEOL();
977 }
978
979 void MCAsmStreamer::EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame) {
980   OS << "\t.cfi_startproc";
981   if (Frame.IsSimple)
982     OS << " simple";
983   EmitEOL();
984 }
985
986 void MCAsmStreamer::EmitCFIEndProcImpl(MCDwarfFrameInfo &Frame) {
987   MCStreamer::EmitCFIEndProcImpl(Frame);
988   OS << "\t.cfi_endproc";
989   EmitEOL();
990 }
991
992 void MCAsmStreamer::EmitRegisterName(int64_t Register) {
993   if (!MAI->useDwarfRegNumForCFI()) {
994     const MCRegisterInfo *MRI = getContext().getRegisterInfo();
995     unsigned LLVMRegister = MRI->getLLVMRegNum(Register, true);
996     InstPrinter->printRegName(OS, LLVMRegister);
997   } else {
998     OS << Register;
999   }
1000 }
1001
1002 void MCAsmStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
1003   MCStreamer::EmitCFIDefCfa(Register, Offset);
1004   OS << "\t.cfi_def_cfa ";
1005   EmitRegisterName(Register);
1006   OS << ", " << Offset;
1007   EmitEOL();
1008 }
1009
1010 void MCAsmStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
1011   MCStreamer::EmitCFIDefCfaOffset(Offset);
1012   OS << "\t.cfi_def_cfa_offset " << Offset;
1013   EmitEOL();
1014 }
1015
1016 static void PrintCFIEscape(llvm::formatted_raw_ostream &OS, StringRef Values) {
1017   OS << "\t.cfi_escape ";
1018   if (!Values.empty()) {
1019     size_t e = Values.size() - 1;
1020     for (size_t i = 0; i < e; ++i)
1021       OS << format("0x%02x", uint8_t(Values[i])) << ", ";
1022     OS << format("0x%02x", uint8_t(Values[e]));
1023   }
1024 }
1025
1026 void MCAsmStreamer::EmitCFIEscape(StringRef Values) {
1027   MCStreamer::EmitCFIEscape(Values);
1028   PrintCFIEscape(OS, Values);
1029   EmitEOL();
1030 }
1031
1032 void MCAsmStreamer::EmitCFIGnuArgsSize(int64_t Size) {
1033   MCStreamer::EmitCFIGnuArgsSize(Size);
1034   
1035   uint8_t Buffer[16] = { dwarf::DW_CFA_GNU_args_size };
1036   unsigned Len = encodeULEB128(Size, Buffer + 1) + 1;
1037   
1038   PrintCFIEscape(OS, StringRef((const char *)&Buffer[0], Len));
1039   EmitEOL();
1040 }
1041
1042 void MCAsmStreamer::EmitCFIDefCfaRegister(int64_t Register) {
1043   MCStreamer::EmitCFIDefCfaRegister(Register);
1044   OS << "\t.cfi_def_cfa_register ";
1045   EmitRegisterName(Register);
1046   EmitEOL();
1047 }
1048
1049 void MCAsmStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
1050   this->MCStreamer::EmitCFIOffset(Register, Offset);
1051   OS << "\t.cfi_offset ";
1052   EmitRegisterName(Register);
1053   OS << ", " << Offset;
1054   EmitEOL();
1055 }
1056
1057 void MCAsmStreamer::EmitCFIPersonality(const MCSymbol *Sym,
1058                                        unsigned Encoding) {
1059   MCStreamer::EmitCFIPersonality(Sym, Encoding);
1060   OS << "\t.cfi_personality " << Encoding << ", ";
1061   Sym->print(OS, MAI);
1062   EmitEOL();
1063 }
1064
1065 void MCAsmStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
1066   MCStreamer::EmitCFILsda(Sym, Encoding);
1067   OS << "\t.cfi_lsda " << Encoding << ", ";
1068   Sym->print(OS, MAI);
1069   EmitEOL();
1070 }
1071
1072 void MCAsmStreamer::EmitCFIRememberState() {
1073   MCStreamer::EmitCFIRememberState();
1074   OS << "\t.cfi_remember_state";
1075   EmitEOL();
1076 }
1077
1078 void MCAsmStreamer::EmitCFIRestoreState() {
1079   MCStreamer::EmitCFIRestoreState();
1080   OS << "\t.cfi_restore_state";
1081   EmitEOL();
1082 }
1083
1084 void MCAsmStreamer::EmitCFISameValue(int64_t Register) {
1085   MCStreamer::EmitCFISameValue(Register);
1086   OS << "\t.cfi_same_value ";
1087   EmitRegisterName(Register);
1088   EmitEOL();
1089 }
1090
1091 void MCAsmStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
1092   MCStreamer::EmitCFIRelOffset(Register, Offset);
1093   OS << "\t.cfi_rel_offset ";
1094   EmitRegisterName(Register);
1095   OS << ", " << Offset;
1096   EmitEOL();
1097 }
1098
1099 void MCAsmStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
1100   MCStreamer::EmitCFIAdjustCfaOffset(Adjustment);
1101   OS << "\t.cfi_adjust_cfa_offset " << Adjustment;
1102   EmitEOL();
1103 }
1104
1105 void MCAsmStreamer::EmitCFISignalFrame() {
1106   MCStreamer::EmitCFISignalFrame();
1107   OS << "\t.cfi_signal_frame";
1108   EmitEOL();
1109 }
1110
1111 void MCAsmStreamer::EmitCFIUndefined(int64_t Register) {
1112   MCStreamer::EmitCFIUndefined(Register);
1113   OS << "\t.cfi_undefined " << Register;
1114   EmitEOL();
1115 }
1116
1117 void MCAsmStreamer::EmitCFIRegister(int64_t Register1, int64_t Register2) {
1118   MCStreamer::EmitCFIRegister(Register1, Register2);
1119   OS << "\t.cfi_register " << Register1 << ", " << Register2;
1120   EmitEOL();
1121 }
1122
1123 void MCAsmStreamer::EmitCFIWindowSave() {
1124   MCStreamer::EmitCFIWindowSave();
1125   OS << "\t.cfi_window_save";
1126   EmitEOL();
1127 }
1128
1129 void MCAsmStreamer::EmitWinCFIStartProc(const MCSymbol *Symbol) {
1130   MCStreamer::EmitWinCFIStartProc(Symbol);
1131
1132   OS << ".seh_proc ";
1133   Symbol->print(OS, MAI);
1134   EmitEOL();
1135 }
1136
1137 void MCAsmStreamer::EmitWinCFIEndProc() {
1138   MCStreamer::EmitWinCFIEndProc();
1139
1140   OS << "\t.seh_endproc";
1141   EmitEOL();
1142 }
1143
1144 void MCAsmStreamer::EmitWinCFIStartChained() {
1145   MCStreamer::EmitWinCFIStartChained();
1146
1147   OS << "\t.seh_startchained";
1148   EmitEOL();
1149 }
1150
1151 void MCAsmStreamer::EmitWinCFIEndChained() {
1152   MCStreamer::EmitWinCFIEndChained();
1153
1154   OS << "\t.seh_endchained";
1155   EmitEOL();
1156 }
1157
1158 void MCAsmStreamer::EmitWinEHHandler(const MCSymbol *Sym, bool Unwind,
1159                                       bool Except) {
1160   MCStreamer::EmitWinEHHandler(Sym, Unwind, Except);
1161
1162   OS << "\t.seh_handler ";
1163   Sym->print(OS, MAI);
1164   if (Unwind)
1165     OS << ", @unwind";
1166   if (Except)
1167     OS << ", @except";
1168   EmitEOL();
1169 }
1170
1171 void MCAsmStreamer::EmitWinEHHandlerData() {
1172   MCStreamer::EmitWinEHHandlerData();
1173
1174   // Switch sections. Don't call SwitchSection directly, because that will
1175   // cause the section switch to be visible in the emitted assembly.
1176   // We only do this so the section switch that terminates the handler
1177   // data block is visible.
1178   WinEH::FrameInfo *CurFrame = getCurrentWinFrameInfo();
1179   MCSection *XData =
1180       WinEH::UnwindEmitter::getXDataSection(CurFrame->Function, getContext());
1181   SwitchSectionNoChange(XData);
1182
1183   OS << "\t.seh_handlerdata";
1184   EmitEOL();
1185 }
1186
1187 void MCAsmStreamer::EmitWinCFIPushReg(unsigned Register) {
1188   MCStreamer::EmitWinCFIPushReg(Register);
1189
1190   OS << "\t.seh_pushreg " << Register;
1191   EmitEOL();
1192 }
1193
1194 void MCAsmStreamer::EmitWinCFISetFrame(unsigned Register, unsigned Offset) {
1195   MCStreamer::EmitWinCFISetFrame(Register, Offset);
1196
1197   OS << "\t.seh_setframe " << Register << ", " << Offset;
1198   EmitEOL();
1199 }
1200
1201 void MCAsmStreamer::EmitWinCFIAllocStack(unsigned Size) {
1202   MCStreamer::EmitWinCFIAllocStack(Size);
1203
1204   OS << "\t.seh_stackalloc " << Size;
1205   EmitEOL();
1206 }
1207
1208 void MCAsmStreamer::EmitWinCFISaveReg(unsigned Register, unsigned Offset) {
1209   MCStreamer::EmitWinCFISaveReg(Register, Offset);
1210
1211   OS << "\t.seh_savereg " << Register << ", " << Offset;
1212   EmitEOL();
1213 }
1214
1215 void MCAsmStreamer::EmitWinCFISaveXMM(unsigned Register, unsigned Offset) {
1216   MCStreamer::EmitWinCFISaveXMM(Register, Offset);
1217
1218   OS << "\t.seh_savexmm " << Register << ", " << Offset;
1219   EmitEOL();
1220 }
1221
1222 void MCAsmStreamer::EmitWinCFIPushFrame(bool Code) {
1223   MCStreamer::EmitWinCFIPushFrame(Code);
1224
1225   OS << "\t.seh_pushframe";
1226   if (Code)
1227     OS << " @code";
1228   EmitEOL();
1229 }
1230
1231 void MCAsmStreamer::EmitWinCFIEndProlog(void) {
1232   MCStreamer::EmitWinCFIEndProlog();
1233
1234   OS << "\t.seh_endprologue";
1235   EmitEOL();
1236 }
1237
1238 void MCAsmStreamer::AddEncodingComment(const MCInst &Inst,
1239                                        const MCSubtargetInfo &STI) {
1240   raw_ostream &OS = GetCommentOS();
1241   SmallString<256> Code;
1242   SmallVector<MCFixup, 4> Fixups;
1243   raw_svector_ostream VecOS(Code);
1244   Emitter->encodeInstruction(Inst, VecOS, Fixups, STI);
1245
1246   // If we are showing fixups, create symbolic markers in the encoded
1247   // representation. We do this by making a per-bit map to the fixup item index,
1248   // then trying to display it as nicely as possible.
1249   SmallVector<uint8_t, 64> FixupMap;
1250   FixupMap.resize(Code.size() * 8);
1251   for (unsigned i = 0, e = Code.size() * 8; i != e; ++i)
1252     FixupMap[i] = 0;
1253
1254   for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
1255     MCFixup &F = Fixups[i];
1256     const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
1257     for (unsigned j = 0; j != Info.TargetSize; ++j) {
1258       unsigned Index = F.getOffset() * 8 + Info.TargetOffset + j;
1259       assert(Index < Code.size() * 8 && "Invalid offset in fixup!");
1260       FixupMap[Index] = 1 + i;
1261     }
1262   }
1263
1264   // FIXME: Note the fixup comments for Thumb2 are completely bogus since the
1265   // high order halfword of a 32-bit Thumb2 instruction is emitted first.
1266   OS << "encoding: [";
1267   for (unsigned i = 0, e = Code.size(); i != e; ++i) {
1268     if (i)
1269       OS << ',';
1270
1271     // See if all bits are the same map entry.
1272     uint8_t MapEntry = FixupMap[i * 8 + 0];
1273     for (unsigned j = 1; j != 8; ++j) {
1274       if (FixupMap[i * 8 + j] == MapEntry)
1275         continue;
1276
1277       MapEntry = uint8_t(~0U);
1278       break;
1279     }
1280
1281     if (MapEntry != uint8_t(~0U)) {
1282       if (MapEntry == 0) {
1283         OS << format("0x%02x", uint8_t(Code[i]));
1284       } else {
1285         if (Code[i]) {
1286           // FIXME: Some of the 8 bits require fix up.
1287           OS << format("0x%02x", uint8_t(Code[i])) << '\''
1288              << char('A' + MapEntry - 1) << '\'';
1289         } else
1290           OS << char('A' + MapEntry - 1);
1291       }
1292     } else {
1293       // Otherwise, write out in binary.
1294       OS << "0b";
1295       for (unsigned j = 8; j--;) {
1296         unsigned Bit = (Code[i] >> j) & 1;
1297
1298         unsigned FixupBit;
1299         if (MAI->isLittleEndian())
1300           FixupBit = i * 8 + j;
1301         else
1302           FixupBit = i * 8 + (7-j);
1303
1304         if (uint8_t MapEntry = FixupMap[FixupBit]) {
1305           assert(Bit == 0 && "Encoder wrote into fixed up bit!");
1306           OS << char('A' + MapEntry - 1);
1307         } else
1308           OS << Bit;
1309       }
1310     }
1311   }
1312   OS << "]\n";
1313
1314   for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
1315     MCFixup &F = Fixups[i];
1316     const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
1317     OS << "  fixup " << char('A' + i) << " - " << "offset: " << F.getOffset()
1318        << ", value: " << *F.getValue() << ", kind: " << Info.Name << "\n";
1319   }
1320 }
1321
1322 void MCAsmStreamer::EmitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI) {
1323   assert(getCurrentSection().first &&
1324          "Cannot emit contents before setting section!");
1325
1326   // Show the encoding in a comment if we have a code emitter.
1327   if (Emitter)
1328     AddEncodingComment(Inst, STI);
1329
1330   // Show the MCInst if enabled.
1331   if (ShowInst) {
1332     Inst.dump_pretty(GetCommentOS(), InstPrinter.get(), "\n ");
1333     GetCommentOS() << "\n";
1334   }
1335
1336   if(getTargetStreamer())
1337     getTargetStreamer()->prettyPrintAsm(*InstPrinter, OS, Inst, STI);
1338   else
1339     InstPrinter->printInst(&Inst, OS, "", STI);
1340
1341   EmitEOL();
1342 }
1343
1344 void MCAsmStreamer::EmitBundleAlignMode(unsigned AlignPow2) {
1345   OS << "\t.bundle_align_mode " << AlignPow2;
1346   EmitEOL();
1347 }
1348
1349 void MCAsmStreamer::EmitBundleLock(bool AlignToEnd) {
1350   OS << "\t.bundle_lock";
1351   if (AlignToEnd)
1352     OS << " align_to_end";
1353   EmitEOL();
1354 }
1355
1356 void MCAsmStreamer::EmitBundleUnlock() {
1357   OS << "\t.bundle_unlock";
1358   EmitEOL();
1359 }
1360
1361 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
1362 /// the specified string in the output .s file.  This capability is
1363 /// indicated by the hasRawTextSupport() predicate.
1364 void MCAsmStreamer::EmitRawTextImpl(StringRef String) {
1365   if (!String.empty() && String.back() == '\n')
1366     String = String.substr(0, String.size()-1);
1367   OS << String;
1368   EmitEOL();
1369 }
1370
1371 void MCAsmStreamer::FinishImpl() {
1372   // If we are generating dwarf for assembly source files dump out the sections.
1373   if (getContext().getGenDwarfForAssembly())
1374     MCGenDwarfInfo::Emit(this);
1375
1376   // Emit the label for the line table, if requested - since the rest of the
1377   // line table will be defined by .loc/.file directives, and not emitted
1378   // directly, the label is the only work required here.
1379   auto &Tables = getContext().getMCDwarfLineTables();
1380   if (!Tables.empty()) {
1381     assert(Tables.size() == 1 && "asm output only supports one line table");
1382     if (auto *Label = Tables.begin()->second.getLabel()) {
1383       SwitchSection(getContext().getObjectFileInfo()->getDwarfLineSection());
1384       EmitLabel(Label);
1385     }
1386   }
1387 }
1388
1389 MCStreamer *llvm::createAsmStreamer(MCContext &Context,
1390                                     std::unique_ptr<formatted_raw_ostream> OS,
1391                                     bool isVerboseAsm, bool useDwarfDirectory,
1392                                     MCInstPrinter *IP, MCCodeEmitter *CE,
1393                                     MCAsmBackend *MAB, bool ShowInst) {
1394   return new MCAsmStreamer(Context, std::move(OS), isVerboseAsm,
1395                            useDwarfDirectory, IP, CE, MAB, ShowInst);
1396 }