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