b8da7f1615c969a0375ce0a0362a093ed638f925
[lldb.git] / llvm / lib / MC / MCAsmStreamer.cpp
1 //===- lib/MC/MCAsmStreamer.cpp - Text Assembly Output ----------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8
9 #include "llvm/ADT/Optional.h"
10 #include "llvm/ADT/STLExtras.h"
11 #include "llvm/ADT/SmallString.h"
12 #include "llvm/ADT/StringExtras.h"
13 #include "llvm/ADT/Twine.h"
14 #include "llvm/DebugInfo/CodeView/SymbolRecord.h"
15 #include "llvm/MC/MCAsmBackend.h"
16 #include "llvm/MC/MCAsmInfo.h"
17 #include "llvm/MC/MCAssembler.h"
18 #include "llvm/MC/MCCodeEmitter.h"
19 #include "llvm/MC/MCCodeView.h"
20 #include "llvm/MC/MCContext.h"
21 #include "llvm/MC/MCExpr.h"
22 #include "llvm/MC/MCFixupKindInfo.h"
23 #include "llvm/MC/MCInst.h"
24 #include "llvm/MC/MCInstPrinter.h"
25 #include "llvm/MC/MCObjectFileInfo.h"
26 #include "llvm/MC/MCObjectWriter.h"
27 #include "llvm/MC/MCRegister.h"
28 #include "llvm/MC/MCRegisterInfo.h"
29 #include "llvm/MC/MCSectionMachO.h"
30 #include "llvm/MC/MCStreamer.h"
31 #include "llvm/MC/MCSymbolXCOFF.h"
32 #include "llvm/Support/ErrorHandling.h"
33 #include "llvm/Support/Format.h"
34 #include "llvm/Support/FormattedStream.h"
35 #include "llvm/Support/LEB128.h"
36 #include "llvm/Support/MathExtras.h"
37 #include "llvm/Support/Path.h"
38 #include "llvm/Support/TargetRegistry.h"
39 #include <cctype>
40
41 using namespace llvm;
42
43 namespace {
44
45 class MCAsmStreamer final : public MCStreamer {
46   std::unique_ptr<formatted_raw_ostream> OSOwner;
47   formatted_raw_ostream &OS;
48   const MCAsmInfo *MAI;
49   std::unique_ptr<MCInstPrinter> InstPrinter;
50   std::unique_ptr<MCAssembler> Assembler;
51
52   SmallString<128> ExplicitCommentToEmit;
53   SmallString<128> CommentToEmit;
54   raw_svector_ostream CommentStream;
55   raw_null_ostream NullStream;
56
57   unsigned IsVerboseAsm : 1;
58   unsigned ShowInst : 1;
59   unsigned UseDwarfDirectory : 1;
60
61   void EmitRegisterName(int64_t Register);
62   void emitCFIStartProcImpl(MCDwarfFrameInfo &Frame) override;
63   void emitCFIEndProcImpl(MCDwarfFrameInfo &Frame) override;
64
65 public:
66   MCAsmStreamer(MCContext &Context, std::unique_ptr<formatted_raw_ostream> os,
67                 bool isVerboseAsm, bool useDwarfDirectory,
68                 MCInstPrinter *printer, std::unique_ptr<MCCodeEmitter> emitter,
69                 std::unique_ptr<MCAsmBackend> asmbackend, bool showInst)
70       : MCStreamer(Context), OSOwner(std::move(os)), OS(*OSOwner),
71         MAI(Context.getAsmInfo()), InstPrinter(printer),
72         Assembler(std::make_unique<MCAssembler>(
73             Context, std::move(asmbackend), std::move(emitter),
74             (asmbackend) ? asmbackend->createObjectWriter(NullStream)
75                          : nullptr)),
76         CommentStream(CommentToEmit), IsVerboseAsm(isVerboseAsm),
77         ShowInst(showInst), UseDwarfDirectory(useDwarfDirectory) {
78     assert(InstPrinter);
79     if (IsVerboseAsm)
80         InstPrinter->setCommentStream(CommentStream);
81     if (Assembler->getBackendPtr())
82       setAllowAutoPadding(Assembler->getBackend().allowAutoPadding());
83
84     Context.setUseNamesOnTempLabels(true);
85   }
86
87   MCAssembler &getAssembler() { return *Assembler; }
88   MCAssembler *getAssemblerPtr() override { return nullptr; }
89
90   inline void EmitEOL() {
91     // Dump Explicit Comments here.
92     emitExplicitComments();
93     // If we don't have any comments, just emit a \n.
94     if (!IsVerboseAsm) {
95       OS << '\n';
96       return;
97     }
98     EmitCommentsAndEOL();
99   }
100
101   void emitSyntaxDirective() override;
102
103   void EmitCommentsAndEOL();
104
105   /// Return true if this streamer supports verbose assembly at all.
106   bool isVerboseAsm() const override { return IsVerboseAsm; }
107
108   /// Do we support EmitRawText?
109   bool hasRawTextSupport() const override { return true; }
110
111   /// Add a comment that can be emitted to the generated .s file to make the
112   /// output of the compiler more readable. This only affects the MCAsmStreamer
113   /// and only when verbose assembly output is enabled.
114   void AddComment(const Twine &T, bool EOL = true) override;
115
116   /// Add a comment showing the encoding of an instruction.
117   void AddEncodingComment(const MCInst &Inst, const MCSubtargetInfo &);
118
119   /// Return a raw_ostream that comments can be written to.
120   /// Unlike AddComment, you are required to terminate comments with \n if you
121   /// use this method.
122   raw_ostream &GetCommentOS() override {
123     if (!IsVerboseAsm)
124       return nulls();  // Discard comments unless in verbose asm mode.
125     return CommentStream;
126   }
127
128   void emitRawComment(const Twine &T, bool TabPrefix = true) override;
129
130   void addExplicitComment(const Twine &T) override;
131   void emitExplicitComments() override;
132
133   /// Emit a blank line to a .s file to pretty it up.
134   void AddBlankLine() override {
135     EmitEOL();
136   }
137
138   /// @name MCStreamer Interface
139   /// @{
140
141   void changeSection(MCSection *Section, const MCExpr *Subsection) override;
142
143   void emitELFSymverDirective(StringRef AliasName,
144                               const MCSymbol *Aliasee) override;
145
146   void emitLOHDirective(MCLOHType Kind, const MCLOHArgs &Args) override;
147   void emitLabel(MCSymbol *Symbol, SMLoc Loc = SMLoc()) override;
148
149   void emitAssemblerFlag(MCAssemblerFlag Flag) override;
150   void emitLinkerOptions(ArrayRef<std::string> Options) override;
151   void emitDataRegion(MCDataRegionType Kind) override;
152   void emitVersionMin(MCVersionMinType Kind, unsigned Major, unsigned Minor,
153                       unsigned Update, VersionTuple SDKVersion) override;
154   void emitBuildVersion(unsigned Platform, unsigned Major, unsigned Minor,
155                         unsigned Update, VersionTuple SDKVersion) override;
156   void emitThumbFunc(MCSymbol *Func) override;
157
158   void emitAssignment(MCSymbol *Symbol, const MCExpr *Value) override;
159   void emitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) override;
160   bool emitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute) override;
161
162   void emitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) override;
163   void BeginCOFFSymbolDef(const MCSymbol *Symbol) override;
164   void EmitCOFFSymbolStorageClass(int StorageClass) override;
165   void EmitCOFFSymbolType(int Type) override;
166   void EndCOFFSymbolDef() override;
167   void EmitCOFFSafeSEH(MCSymbol const *Symbol) override;
168   void EmitCOFFSymbolIndex(MCSymbol const *Symbol) override;
169   void EmitCOFFSectionIndex(MCSymbol const *Symbol) override;
170   void EmitCOFFSecRel32(MCSymbol const *Symbol, uint64_t Offset) override;
171   void EmitCOFFImgRel32(MCSymbol const *Symbol, int64_t Offset) override;
172   void emitXCOFFLocalCommonSymbol(MCSymbol *LabelSym, uint64_t Size,
173                                   MCSymbol *CsectSym,
174                                   unsigned ByteAlign) override;
175   void emitXCOFFSymbolLinkageWithVisibility(MCSymbol *Symbol,
176                                             MCSymbolAttr Linakge,
177                                             MCSymbolAttr Visibility) override;
178   void emitXCOFFRenameDirective(const MCSymbol *Name,
179                                 StringRef Rename) override;
180
181   void emitELFSize(MCSymbol *Symbol, const MCExpr *Value) override;
182   void emitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
183                         unsigned ByteAlignment) override;
184
185   /// Emit a local common (.lcomm) symbol.
186   ///
187   /// @param Symbol - The common symbol to emit.
188   /// @param Size - The size of the common symbol.
189   /// @param ByteAlignment - The alignment of the common symbol in bytes.
190   void emitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
191                              unsigned ByteAlignment) override;
192
193   void emitZerofill(MCSection *Section, MCSymbol *Symbol = nullptr,
194                     uint64_t Size = 0, unsigned ByteAlignment = 0,
195                     SMLoc Loc = SMLoc()) override;
196
197   void emitTBSSSymbol(MCSection *Section, MCSymbol *Symbol, uint64_t Size,
198                       unsigned ByteAlignment = 0) override;
199
200   void emitBinaryData(StringRef Data) override;
201
202   void emitBytes(StringRef Data) override;
203
204   void emitValueImpl(const MCExpr *Value, unsigned Size,
205                      SMLoc Loc = SMLoc()) override;
206   void emitIntValue(uint64_t Value, unsigned Size) override;
207   void emitIntValueInHex(uint64_t Value, unsigned Size) override;
208   void emitIntValueInHexWithPadding(uint64_t Value, unsigned Size) override;
209
210   void emitULEB128Value(const MCExpr *Value) override;
211
212   void emitSLEB128Value(const MCExpr *Value) override;
213
214   void emitDTPRel32Value(const MCExpr *Value) override;
215   void emitDTPRel64Value(const MCExpr *Value) override;
216   void emitTPRel32Value(const MCExpr *Value) override;
217   void emitTPRel64Value(const MCExpr *Value) override;
218
219   void emitGPRel64Value(const MCExpr *Value) override;
220
221   void emitGPRel32Value(const MCExpr *Value) override;
222
223   void emitFill(const MCExpr &NumBytes, uint64_t FillValue,
224                 SMLoc Loc = SMLoc()) override;
225
226   void emitFill(const MCExpr &NumValues, int64_t Size, int64_t Expr,
227                 SMLoc Loc = SMLoc()) override;
228
229   void emitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
230                             unsigned ValueSize = 1,
231                             unsigned MaxBytesToEmit = 0) override;
232
233   void emitCodeAlignment(unsigned ByteAlignment,
234                          unsigned MaxBytesToEmit = 0) override;
235
236   void emitValueToOffset(const MCExpr *Offset,
237                          unsigned char Value,
238                          SMLoc Loc) override;
239
240   void emitFileDirective(StringRef Filename) override;
241   Expected<unsigned> tryEmitDwarfFileDirective(unsigned FileNo,
242                                                StringRef Directory,
243                                                StringRef Filename,
244                                                Optional<MD5::MD5Result> Checksum = None,
245                                                Optional<StringRef> Source = None,
246                                                unsigned CUID = 0) override;
247   void emitDwarfFile0Directive(StringRef Directory, StringRef Filename,
248                                Optional<MD5::MD5Result> Checksum,
249                                Optional<StringRef> Source,
250                                unsigned CUID = 0) override;
251   void emitDwarfLocDirective(unsigned FileNo, unsigned Line, unsigned Column,
252                              unsigned Flags, unsigned Isa,
253                              unsigned Discriminator,
254                              StringRef FileName) override;
255   MCSymbol *getDwarfLineTableSymbol(unsigned CUID) override;
256
257   bool EmitCVFileDirective(unsigned FileNo, StringRef Filename,
258                            ArrayRef<uint8_t> Checksum,
259                            unsigned ChecksumKind) override;
260   bool EmitCVFuncIdDirective(unsigned FuncId) override;
261   bool EmitCVInlineSiteIdDirective(unsigned FunctionId, unsigned IAFunc,
262                                    unsigned IAFile, unsigned IALine,
263                                    unsigned IACol, SMLoc Loc) override;
264   void emitCVLocDirective(unsigned FunctionId, unsigned FileNo, unsigned Line,
265                           unsigned Column, bool PrologueEnd, bool IsStmt,
266                           StringRef FileName, SMLoc Loc) override;
267   void emitCVLinetableDirective(unsigned FunctionId, const MCSymbol *FnStart,
268                                 const MCSymbol *FnEnd) override;
269   void emitCVInlineLinetableDirective(unsigned PrimaryFunctionId,
270                                       unsigned SourceFileId,
271                                       unsigned SourceLineNum,
272                                       const MCSymbol *FnStartSym,
273                                       const MCSymbol *FnEndSym) override;
274
275   void PrintCVDefRangePrefix(
276       ArrayRef<std::pair<const MCSymbol *, const MCSymbol *>> Ranges);
277
278   void emitCVDefRangeDirective(
279       ArrayRef<std::pair<const MCSymbol *, const MCSymbol *>> Ranges,
280       codeview::DefRangeRegisterRelHeader DRHdr) override;
281
282   void emitCVDefRangeDirective(
283       ArrayRef<std::pair<const MCSymbol *, const MCSymbol *>> Ranges,
284       codeview::DefRangeSubfieldRegisterHeader DRHdr) override;
285
286   void emitCVDefRangeDirective(
287       ArrayRef<std::pair<const MCSymbol *, const MCSymbol *>> Ranges,
288       codeview::DefRangeRegisterHeader DRHdr) override;
289
290   void emitCVDefRangeDirective(
291       ArrayRef<std::pair<const MCSymbol *, const MCSymbol *>> Ranges,
292       codeview::DefRangeFramePointerRelHeader DRHdr) override;
293
294   void emitCVStringTableDirective() override;
295   void emitCVFileChecksumsDirective() override;
296   void emitCVFileChecksumOffsetDirective(unsigned FileNo) override;
297   void EmitCVFPOData(const MCSymbol *ProcSym, SMLoc L) override;
298
299   void emitIdent(StringRef IdentString) override;
300   void emitCFIBKeyFrame() override;
301   void emitCFISections(bool EH, bool Debug) override;
302   void emitCFIDefCfa(int64_t Register, int64_t Offset) override;
303   void emitCFIDefCfaOffset(int64_t Offset) override;
304   void emitCFIDefCfaRegister(int64_t Register) override;
305   void emitCFIOffset(int64_t Register, int64_t Offset) override;
306   void emitCFIPersonality(const MCSymbol *Sym, unsigned Encoding) override;
307   void emitCFILsda(const MCSymbol *Sym, unsigned Encoding) override;
308   void emitCFIRememberState() override;
309   void emitCFIRestoreState() override;
310   void emitCFIRestore(int64_t Register) override;
311   void emitCFISameValue(int64_t Register) override;
312   void emitCFIRelOffset(int64_t Register, int64_t Offset) override;
313   void emitCFIAdjustCfaOffset(int64_t Adjustment) override;
314   void emitCFIEscape(StringRef Values) override;
315   void emitCFIGnuArgsSize(int64_t Size) override;
316   void emitCFISignalFrame() override;
317   void emitCFIUndefined(int64_t Register) override;
318   void emitCFIRegister(int64_t Register1, int64_t Register2) override;
319   void emitCFIWindowSave() override;
320   void emitCFINegateRAState() override;
321   void emitCFIReturnColumn(int64_t Register) override;
322
323   void EmitWinCFIStartProc(const MCSymbol *Symbol, SMLoc Loc) override;
324   void EmitWinCFIEndProc(SMLoc Loc) override;
325   void EmitWinCFIFuncletOrFuncEnd(SMLoc Loc) override;
326   void EmitWinCFIStartChained(SMLoc Loc) override;
327   void EmitWinCFIEndChained(SMLoc Loc) override;
328   void EmitWinCFIPushReg(MCRegister Register, SMLoc Loc) override;
329   void EmitWinCFISetFrame(MCRegister Register, unsigned Offset,
330                           SMLoc Loc) override;
331   void EmitWinCFIAllocStack(unsigned Size, SMLoc Loc) override;
332   void EmitWinCFISaveReg(MCRegister Register, unsigned Offset,
333                          SMLoc Loc) override;
334   void EmitWinCFISaveXMM(MCRegister Register, unsigned Offset,
335                          SMLoc Loc) override;
336   void EmitWinCFIPushFrame(bool Code, SMLoc Loc) override;
337   void EmitWinCFIEndProlog(SMLoc Loc) override;
338
339   void EmitWinEHHandler(const MCSymbol *Sym, bool Unwind, bool Except,
340                         SMLoc Loc) override;
341   void EmitWinEHHandlerData(SMLoc Loc) override;
342
343   void emitCGProfileEntry(const MCSymbolRefExpr *From,
344                           const MCSymbolRefExpr *To, uint64_t Count) override;
345
346   void emitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI) override;
347
348   void emitBundleAlignMode(unsigned AlignPow2) override;
349   void emitBundleLock(bool AlignToEnd) override;
350   void emitBundleUnlock() override;
351
352   Optional<std::pair<bool, std::string>>
353   emitRelocDirective(const MCExpr &Offset, StringRef Name, const MCExpr *Expr,
354                      SMLoc Loc, const MCSubtargetInfo &STI) override;
355
356   void emitAddrsig() override;
357   void emitAddrsigSym(const MCSymbol *Sym) override;
358
359   /// If this file is backed by an assembly streamer, this dumps the specified
360   /// string in the output .s file. This capability is indicated by the
361   /// hasRawTextSupport() predicate.
362   void emitRawTextImpl(StringRef String) override;
363
364   void finishImpl() override;
365 };
366
367 } // end anonymous namespace.
368
369 void MCAsmStreamer::AddComment(const Twine &T, bool EOL) {
370   if (!IsVerboseAsm) return;
371
372   T.toVector(CommentToEmit);
373
374   if (EOL)
375     CommentToEmit.push_back('\n'); // Place comment in a new line.
376 }
377
378 void MCAsmStreamer::EmitCommentsAndEOL() {
379   if (CommentToEmit.empty() && CommentStream.GetNumBytesInBuffer() == 0) {
380     OS << '\n';
381     return;
382   }
383
384   StringRef Comments = CommentToEmit;
385
386   assert(Comments.back() == '\n' &&
387          "Comment array not newline terminated");
388   do {
389     // Emit a line of comments.
390     OS.PadToColumn(MAI->getCommentColumn());
391     size_t Position = Comments.find('\n');
392     OS << MAI->getCommentString() << ' ' << Comments.substr(0, Position) <<'\n';
393
394     Comments = Comments.substr(Position+1);
395   } while (!Comments.empty());
396
397   CommentToEmit.clear();
398 }
399
400 static inline int64_t truncateToSize(int64_t Value, unsigned Bytes) {
401   assert(Bytes > 0 && Bytes <= 8 && "Invalid size!");
402   return Value & ((uint64_t) (int64_t) -1 >> (64 - Bytes * 8));
403 }
404
405 void MCAsmStreamer::emitRawComment(const Twine &T, bool TabPrefix) {
406   if (TabPrefix)
407     OS << '\t';
408   OS << MAI->getCommentString() << T;
409   EmitEOL();
410 }
411
412 void MCAsmStreamer::addExplicitComment(const Twine &T) {
413   StringRef c = T.getSingleStringRef();
414   if (c.equals(StringRef(MAI->getSeparatorString())))
415     return;
416   if (c.startswith(StringRef("//"))) {
417     ExplicitCommentToEmit.append("\t");
418     ExplicitCommentToEmit.append(MAI->getCommentString());
419     // drop //
420     ExplicitCommentToEmit.append(c.slice(2, c.size()).str());
421   } else if (c.startswith(StringRef("/*"))) {
422     size_t p = 2, len = c.size() - 2;
423     // emit each line in comment as separate newline.
424     do {
425       size_t newp = std::min(len, c.find_first_of("\r\n", p));
426       ExplicitCommentToEmit.append("\t");
427       ExplicitCommentToEmit.append(MAI->getCommentString());
428       ExplicitCommentToEmit.append(c.slice(p, newp).str());
429       // If we have another line in this comment add line
430       if (newp < len)
431         ExplicitCommentToEmit.append("\n");
432       p = newp + 1;
433     } while (p < len);
434   } else if (c.startswith(StringRef(MAI->getCommentString()))) {
435     ExplicitCommentToEmit.append("\t");
436     ExplicitCommentToEmit.append(c.str());
437   } else if (c.front() == '#') {
438
439     ExplicitCommentToEmit.append("\t");
440     ExplicitCommentToEmit.append(MAI->getCommentString());
441     ExplicitCommentToEmit.append(c.slice(1, c.size()).str());
442   } else
443     assert(false && "Unexpected Assembly Comment");
444   // full line comments immediately output
445   if (c.back() == '\n')
446     emitExplicitComments();
447 }
448
449 void MCAsmStreamer::emitExplicitComments() {
450   StringRef Comments = ExplicitCommentToEmit;
451   if (!Comments.empty())
452     OS << Comments;
453   ExplicitCommentToEmit.clear();
454 }
455
456 void MCAsmStreamer::changeSection(MCSection *Section,
457                                   const MCExpr *Subsection) {
458   assert(Section && "Cannot switch to a null section!");
459   if (MCTargetStreamer *TS = getTargetStreamer()) {
460     TS->changeSection(getCurrentSectionOnly(), Section, Subsection, OS);
461   } else {
462     Section->PrintSwitchToSection(
463         *MAI, getContext().getObjectFileInfo()->getTargetTriple(), OS,
464         Subsection);
465   }
466 }
467
468 void MCAsmStreamer::emitELFSymverDirective(StringRef AliasName,
469                                            const MCSymbol *Aliasee) {
470   OS << ".symver ";
471   Aliasee->print(OS, MAI);
472   OS << ", " << AliasName;
473   EmitEOL();
474 }
475
476 void MCAsmStreamer::emitLabel(MCSymbol *Symbol, SMLoc Loc) {
477   MCStreamer::emitLabel(Symbol, Loc);
478
479   Symbol->print(OS, MAI);
480   OS << MAI->getLabelSuffix();
481
482   EmitEOL();
483 }
484
485 void MCAsmStreamer::emitLOHDirective(MCLOHType Kind, const MCLOHArgs &Args) {
486   StringRef str = MCLOHIdToName(Kind);
487
488 #ifndef NDEBUG
489   int NbArgs = MCLOHIdToNbArgs(Kind);
490   assert(NbArgs != -1 && ((size_t)NbArgs) == Args.size() && "Malformed LOH!");
491   assert(str != "" && "Invalid LOH name");
492 #endif
493
494   OS << "\t" << MCLOHDirectiveName() << " " << str << "\t";
495   bool IsFirst = true;
496   for (const MCSymbol *Arg : Args) {
497     if (!IsFirst)
498       OS << ", ";
499     IsFirst = false;
500     Arg->print(OS, MAI);
501   }
502   EmitEOL();
503 }
504
505 void MCAsmStreamer::emitAssemblerFlag(MCAssemblerFlag Flag) {
506   switch (Flag) {
507   case MCAF_SyntaxUnified:         OS << "\t.syntax unified"; break;
508   case MCAF_SubsectionsViaSymbols: OS << ".subsections_via_symbols"; break;
509   case MCAF_Code16:                OS << '\t'<< MAI->getCode16Directive();break;
510   case MCAF_Code32:                OS << '\t'<< MAI->getCode32Directive();break;
511   case MCAF_Code64:                OS << '\t'<< MAI->getCode64Directive();break;
512   }
513   EmitEOL();
514 }
515
516 void MCAsmStreamer::emitLinkerOptions(ArrayRef<std::string> Options) {
517   assert(!Options.empty() && "At least one option is required!");
518   OS << "\t.linker_option \"" << Options[0] << '"';
519   for (ArrayRef<std::string>::iterator it = Options.begin() + 1,
520          ie = Options.end(); it != ie; ++it) {
521     OS << ", " << '"' << *it << '"';
522   }
523   EmitEOL();
524 }
525
526 void MCAsmStreamer::emitDataRegion(MCDataRegionType Kind) {
527   if (!MAI->doesSupportDataRegionDirectives())
528     return;
529   switch (Kind) {
530   case MCDR_DataRegion:            OS << "\t.data_region"; break;
531   case MCDR_DataRegionJT8:         OS << "\t.data_region jt8"; break;
532   case MCDR_DataRegionJT16:        OS << "\t.data_region jt16"; break;
533   case MCDR_DataRegionJT32:        OS << "\t.data_region jt32"; break;
534   case MCDR_DataRegionEnd:         OS << "\t.end_data_region"; break;
535   }
536   EmitEOL();
537 }
538
539 static const char *getVersionMinDirective(MCVersionMinType Type) {
540   switch (Type) {
541   case MCVM_WatchOSVersionMin: return ".watchos_version_min";
542   case MCVM_TvOSVersionMin:    return ".tvos_version_min";
543   case MCVM_IOSVersionMin:     return ".ios_version_min";
544   case MCVM_OSXVersionMin:     return ".macosx_version_min";
545   }
546   llvm_unreachable("Invalid MC version min type");
547 }
548
549 static void EmitSDKVersionSuffix(raw_ostream &OS,
550                                  const VersionTuple &SDKVersion) {
551   if (SDKVersion.empty())
552     return;
553   OS << '\t' << "sdk_version " << SDKVersion.getMajor();
554   if (auto Minor = SDKVersion.getMinor()) {
555     OS << ", " << *Minor;
556     if (auto Subminor = SDKVersion.getSubminor()) {
557       OS << ", " << *Subminor;
558     }
559   }
560 }
561
562 void MCAsmStreamer::emitVersionMin(MCVersionMinType Type, unsigned Major,
563                                    unsigned Minor, unsigned Update,
564                                    VersionTuple SDKVersion) {
565   OS << '\t' << getVersionMinDirective(Type) << ' ' << Major << ", " << Minor;
566   if (Update)
567     OS << ", " << Update;
568   EmitSDKVersionSuffix(OS, SDKVersion);
569   EmitEOL();
570 }
571
572 static const char *getPlatformName(MachO::PlatformType Type) {
573   switch (Type) {
574   case MachO::PLATFORM_MACOS:            return "macos";
575   case MachO::PLATFORM_IOS:              return "ios";
576   case MachO::PLATFORM_TVOS:             return "tvos";
577   case MachO::PLATFORM_WATCHOS:          return "watchos";
578   case MachO::PLATFORM_BRIDGEOS:         return "bridgeos";
579   case MachO::PLATFORM_MACCATALYST:      return "macCatalyst";
580   case MachO::PLATFORM_IOSSIMULATOR:     return "iossimulator";
581   case MachO::PLATFORM_TVOSSIMULATOR:    return "tvossimulator";
582   case MachO::PLATFORM_WATCHOSSIMULATOR: return "watchossimulator";
583   }
584   llvm_unreachable("Invalid Mach-O platform type");
585 }
586
587 void MCAsmStreamer::emitBuildVersion(unsigned Platform, unsigned Major,
588                                      unsigned Minor, unsigned Update,
589                                      VersionTuple SDKVersion) {
590   const char *PlatformName = getPlatformName((MachO::PlatformType)Platform);
591   OS << "\t.build_version " << PlatformName << ", " << Major << ", " << Minor;
592   if (Update)
593     OS << ", " << Update;
594   EmitSDKVersionSuffix(OS, SDKVersion);
595   EmitEOL();
596 }
597
598 void MCAsmStreamer::emitThumbFunc(MCSymbol *Func) {
599   // This needs to emit to a temporary string to get properly quoted
600   // MCSymbols when they have spaces in them.
601   OS << "\t.thumb_func";
602   // Only Mach-O hasSubsectionsViaSymbols()
603   if (MAI->hasSubsectionsViaSymbols()) {
604     OS << '\t';
605     Func->print(OS, MAI);
606   }
607   EmitEOL();
608 }
609
610 void MCAsmStreamer::emitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
611   // Do not emit a .set on inlined target assignments.
612   bool EmitSet = true;
613   if (auto *E = dyn_cast<MCTargetExpr>(Value))
614     if (E->inlineAssignedExpr())
615       EmitSet = false;
616   if (EmitSet) {
617     OS << ".set ";
618     Symbol->print(OS, MAI);
619     OS << ", ";
620     Value->print(OS, MAI);
621
622     EmitEOL();
623   }
624
625   MCStreamer::emitAssignment(Symbol, Value);
626 }
627
628 void MCAsmStreamer::emitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) {
629   OS << ".weakref ";
630   Alias->print(OS, MAI);
631   OS << ", ";
632   Symbol->print(OS, MAI);
633   EmitEOL();
634 }
635
636 bool MCAsmStreamer::emitSymbolAttribute(MCSymbol *Symbol,
637                                         MCSymbolAttr Attribute) {
638   switch (Attribute) {
639   case MCSA_Invalid: llvm_unreachable("Invalid symbol attribute");
640   case MCSA_ELF_TypeFunction:    /// .type _foo, STT_FUNC  # aka @function
641   case MCSA_ELF_TypeIndFunction: /// .type _foo, STT_GNU_IFUNC
642   case MCSA_ELF_TypeObject:      /// .type _foo, STT_OBJECT  # aka @object
643   case MCSA_ELF_TypeTLS:         /// .type _foo, STT_TLS     # aka @tls_object
644   case MCSA_ELF_TypeCommon:      /// .type _foo, STT_COMMON  # aka @common
645   case MCSA_ELF_TypeNoType:      /// .type _foo, STT_NOTYPE  # aka @notype
646   case MCSA_ELF_TypeGnuUniqueObject:  /// .type _foo, @gnu_unique_object
647     if (!MAI->hasDotTypeDotSizeDirective())
648       return false; // Symbol attribute not supported
649     OS << "\t.type\t";
650     Symbol->print(OS, MAI);
651     OS << ',' << ((MAI->getCommentString()[0] != '@') ? '@' : '%');
652     switch (Attribute) {
653     default: return false;
654     case MCSA_ELF_TypeFunction:    OS << "function"; break;
655     case MCSA_ELF_TypeIndFunction: OS << "gnu_indirect_function"; break;
656     case MCSA_ELF_TypeObject:      OS << "object"; break;
657     case MCSA_ELF_TypeTLS:         OS << "tls_object"; break;
658     case MCSA_ELF_TypeCommon:      OS << "common"; break;
659     case MCSA_ELF_TypeNoType:      OS << "notype"; break;
660     case MCSA_ELF_TypeGnuUniqueObject: OS << "gnu_unique_object"; break;
661     }
662     EmitEOL();
663     return true;
664   case MCSA_Global: // .globl/.global
665     OS << MAI->getGlobalDirective();
666     break;
667   case MCSA_LGlobal:        OS << "\t.lglobl\t";          break;
668   case MCSA_Hidden:         OS << "\t.hidden\t";          break;
669   case MCSA_IndirectSymbol: OS << "\t.indirect_symbol\t"; break;
670   case MCSA_Internal:       OS << "\t.internal\t";        break;
671   case MCSA_LazyReference:  OS << "\t.lazy_reference\t";  break;
672   case MCSA_Local:          OS << "\t.local\t";           break;
673   case MCSA_NoDeadStrip:
674     if (!MAI->hasNoDeadStrip())
675       return false;
676     OS << "\t.no_dead_strip\t";
677     break;
678   case MCSA_SymbolResolver: OS << "\t.symbol_resolver\t"; break;
679   case MCSA_AltEntry:       OS << "\t.alt_entry\t";       break;
680   case MCSA_PrivateExtern:
681     OS << "\t.private_extern\t";
682     break;
683   case MCSA_Protected:      OS << "\t.protected\t";       break;
684   case MCSA_Reference:      OS << "\t.reference\t";       break;
685   case MCSA_Extern:
686     OS << "\t.extern\t";
687     break;
688   case MCSA_Weak:           OS << MAI->getWeakDirective(); break;
689   case MCSA_WeakDefinition:
690     OS << "\t.weak_definition\t";
691     break;
692       // .weak_reference
693   case MCSA_WeakReference:  OS << MAI->getWeakRefDirective(); break;
694   case MCSA_WeakDefAutoPrivate: OS << "\t.weak_def_can_be_hidden\t"; break;
695   case MCSA_Cold:
696     // Assemblers currently do not support a .cold directive.
697     return false;
698   }
699
700   Symbol->print(OS, MAI);
701   EmitEOL();
702
703   return true;
704 }
705
706 void MCAsmStreamer::emitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
707   OS << ".desc" << ' ';
708   Symbol->print(OS, MAI);
709   OS << ',' << DescValue;
710   EmitEOL();
711 }
712
713 void MCAsmStreamer::emitSyntaxDirective() {
714   if (MAI->getAssemblerDialect() == 1) {
715     OS << "\t.intel_syntax noprefix";
716     EmitEOL();
717   }
718   // FIXME: Currently emit unprefix'ed registers.
719   // The intel_syntax directive has one optional argument
720   // with may have a value of prefix or noprefix.
721 }
722
723 void MCAsmStreamer::BeginCOFFSymbolDef(const MCSymbol *Symbol) {
724   OS << "\t.def\t ";
725   Symbol->print(OS, MAI);
726   OS << ';';
727   EmitEOL();
728 }
729
730 void MCAsmStreamer::EmitCOFFSymbolStorageClass (int StorageClass) {
731   OS << "\t.scl\t" << StorageClass << ';';
732   EmitEOL();
733 }
734
735 void MCAsmStreamer::EmitCOFFSymbolType (int Type) {
736   OS << "\t.type\t" << Type << ';';
737   EmitEOL();
738 }
739
740 void MCAsmStreamer::EndCOFFSymbolDef() {
741   OS << "\t.endef";
742   EmitEOL();
743 }
744
745 void MCAsmStreamer::EmitCOFFSafeSEH(MCSymbol const *Symbol) {
746   OS << "\t.safeseh\t";
747   Symbol->print(OS, MAI);
748   EmitEOL();
749 }
750
751 void MCAsmStreamer::EmitCOFFSymbolIndex(MCSymbol const *Symbol) {
752   OS << "\t.symidx\t";
753   Symbol->print(OS, MAI);
754   EmitEOL();
755 }
756
757 void MCAsmStreamer::EmitCOFFSectionIndex(MCSymbol const *Symbol) {
758   OS << "\t.secidx\t";
759   Symbol->print(OS, MAI);
760   EmitEOL();
761 }
762
763 void MCAsmStreamer::EmitCOFFSecRel32(MCSymbol const *Symbol, uint64_t Offset) {
764   OS << "\t.secrel32\t";
765   Symbol->print(OS, MAI);
766   if (Offset != 0)
767     OS << '+' << Offset;
768   EmitEOL();
769 }
770
771 void MCAsmStreamer::EmitCOFFImgRel32(MCSymbol const *Symbol, int64_t Offset) {
772   OS << "\t.rva\t";
773   Symbol->print(OS, MAI);
774   if (Offset > 0)
775     OS << '+' << Offset;
776   else if (Offset < 0)
777     OS << '-' << -Offset;
778   EmitEOL();
779 }
780
781 // We need an XCOFF-specific version of this directive as the AIX syntax
782 // requires a QualName argument identifying the csect name and storage mapping
783 // class to appear before the alignment if we are specifying it.
784 void MCAsmStreamer::emitXCOFFLocalCommonSymbol(MCSymbol *LabelSym,
785                                                uint64_t Size,
786                                                MCSymbol *CsectSym,
787                                                unsigned ByteAlignment) {
788   assert(MAI->getLCOMMDirectiveAlignmentType() == LCOMM::Log2Alignment &&
789          "We only support writing log base-2 alignment format with XCOFF.");
790   assert(isPowerOf2_32(ByteAlignment) && "Alignment must be a power of 2.");
791
792   OS << "\t.lcomm\t";
793   LabelSym->print(OS, MAI);
794   OS << ',' << Size << ',';
795   CsectSym->print(OS, MAI);
796   OS << ',' << Log2_32(ByteAlignment);
797
798   EmitEOL();
799 }
800
801 void MCAsmStreamer::emitXCOFFSymbolLinkageWithVisibility(
802     MCSymbol *Symbol, MCSymbolAttr Linkage, MCSymbolAttr Visibility) {
803
804   switch (Linkage) {
805   case MCSA_Global:
806     OS << MAI->getGlobalDirective();
807     break;
808   case MCSA_Weak:
809     OS << MAI->getWeakDirective();
810     break;
811   case MCSA_Extern:
812     OS << "\t.extern\t";
813     break;
814   case MCSA_LGlobal:
815     OS << "\t.lglobl\t";
816     break;
817   default:
818     report_fatal_error("unhandled linkage type");
819   }
820
821   Symbol->print(OS, MAI);
822
823   switch (Visibility) {
824   case MCSA_Invalid:
825     // Nothing to do.
826     break;
827   case MCSA_Hidden:
828     OS << ",hidden";
829     break;
830   case MCSA_Protected:
831     OS << ",protected";
832     break;
833   default:
834     report_fatal_error("unexpected value for Visibility type");
835   }
836   EmitEOL();
837
838   // Print symbol's rename (original name contains invalid character(s)) if
839   // there is one.
840   if (cast<MCSymbolXCOFF>(Symbol)->hasRename())
841     emitXCOFFRenameDirective(Symbol,
842                              cast<MCSymbolXCOFF>(Symbol)->getSymbolTableName());
843 }
844
845 void MCAsmStreamer::emitXCOFFRenameDirective(const MCSymbol *Name,
846                                              StringRef Rename) {
847   OS << "\t.rename\t";
848   Name->print(OS, MAI);
849   const char DQ = '"';
850   OS << ',' << DQ;
851   for (char C : Rename) {
852     // To escape a double quote character, the character should be doubled.
853     if (C == DQ)
854       OS << DQ;
855     OS << C;
856   }
857   OS << DQ;
858   EmitEOL();
859 }
860
861 void MCAsmStreamer::emitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
862   assert(MAI->hasDotTypeDotSizeDirective());
863   OS << "\t.size\t";
864   Symbol->print(OS, MAI);
865   OS << ", ";
866   Value->print(OS, MAI);
867   EmitEOL();
868 }
869
870 void MCAsmStreamer::emitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
871                                      unsigned ByteAlignment) {
872   OS << "\t.comm\t";
873   Symbol->print(OS, MAI);
874   OS << ',' << Size;
875
876   if (ByteAlignment != 0) {
877     if (MAI->getCOMMDirectiveAlignmentIsInBytes())
878       OS << ',' << ByteAlignment;
879     else
880       OS << ',' << Log2_32(ByteAlignment);
881   }
882   EmitEOL();
883
884   // Print symbol's rename (original name contains invalid character(s)) if
885   // there is one.
886   MCSymbolXCOFF *XSym = dyn_cast<MCSymbolXCOFF>(Symbol);
887   if (XSym && XSym->hasRename())
888     emitXCOFFRenameDirective(XSym, XSym->getSymbolTableName());
889
890 }
891
892 void MCAsmStreamer::emitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
893                                           unsigned ByteAlign) {
894   OS << "\t.lcomm\t";
895   Symbol->print(OS, MAI);
896   OS << ',' << Size;
897
898   if (ByteAlign > 1) {
899     switch (MAI->getLCOMMDirectiveAlignmentType()) {
900     case LCOMM::NoAlignment:
901       llvm_unreachable("alignment not supported on .lcomm!");
902     case LCOMM::ByteAlignment:
903       OS << ',' << ByteAlign;
904       break;
905     case LCOMM::Log2Alignment:
906       assert(isPowerOf2_32(ByteAlign) && "alignment must be a power of 2");
907       OS << ',' << Log2_32(ByteAlign);
908       break;
909     }
910   }
911   EmitEOL();
912 }
913
914 void MCAsmStreamer::emitZerofill(MCSection *Section, MCSymbol *Symbol,
915                                  uint64_t Size, unsigned ByteAlignment,
916                                  SMLoc Loc) {
917   if (Symbol)
918     AssignFragment(Symbol, &Section->getDummyFragment());
919
920   // Note: a .zerofill directive does not switch sections.
921   OS << ".zerofill ";
922
923   assert(Section->getVariant() == MCSection::SV_MachO &&
924          ".zerofill is a Mach-O specific directive");
925   // This is a mach-o specific directive.
926
927   const MCSectionMachO *MOSection = ((const MCSectionMachO*)Section);
928   OS << MOSection->getSegmentName() << "," << MOSection->getName();
929
930   if (Symbol) {
931     OS << ',';
932     Symbol->print(OS, MAI);
933     OS << ',' << Size;
934     if (ByteAlignment != 0)
935       OS << ',' << Log2_32(ByteAlignment);
936   }
937   EmitEOL();
938 }
939
940 // .tbss sym, size, align
941 // This depends that the symbol has already been mangled from the original,
942 // e.g. _a.
943 void MCAsmStreamer::emitTBSSSymbol(MCSection *Section, MCSymbol *Symbol,
944                                    uint64_t Size, unsigned ByteAlignment) {
945   AssignFragment(Symbol, &Section->getDummyFragment());
946
947   assert(Symbol && "Symbol shouldn't be NULL!");
948   // Instead of using the Section we'll just use the shortcut.
949
950   assert(Section->getVariant() == MCSection::SV_MachO &&
951          ".zerofill is a Mach-O specific directive");
952   // This is a mach-o specific directive and section.
953
954   OS << ".tbss ";
955   Symbol->print(OS, MAI);
956   OS << ", " << Size;
957
958   // Output align if we have it.  We default to 1 so don't bother printing
959   // that.
960   if (ByteAlignment > 1) OS << ", " << Log2_32(ByteAlignment);
961
962   EmitEOL();
963 }
964
965 static inline char toOctal(int X) { return (X&7)+'0'; }
966
967 static void PrintQuotedString(StringRef Data, raw_ostream &OS) {
968   OS << '"';
969
970   for (unsigned i = 0, e = Data.size(); i != e; ++i) {
971     unsigned char C = Data[i];
972     if (C == '"' || C == '\\') {
973       OS << '\\' << (char)C;
974       continue;
975     }
976
977     if (isPrint((unsigned char)C)) {
978       OS << (char)C;
979       continue;
980     }
981
982     switch (C) {
983       case '\b': OS << "\\b"; break;
984       case '\f': OS << "\\f"; break;
985       case '\n': OS << "\\n"; break;
986       case '\r': OS << "\\r"; break;
987       case '\t': OS << "\\t"; break;
988       default:
989         OS << '\\';
990         OS << toOctal(C >> 6);
991         OS << toOctal(C >> 3);
992         OS << toOctal(C >> 0);
993         break;
994     }
995   }
996
997   OS << '"';
998 }
999
1000 void MCAsmStreamer::emitBytes(StringRef Data) {
1001   assert(getCurrentSectionOnly() &&
1002          "Cannot emit contents before setting section!");
1003   if (Data.empty()) return;
1004
1005   // If only single byte is provided or no ascii or asciz directives is
1006   // supported, emit as vector of 8bits data.
1007   if (Data.size() == 1 ||
1008       !(MAI->getAscizDirective() || MAI->getAsciiDirective())) {
1009     if (MCTargetStreamer *TS = getTargetStreamer()) {
1010       TS->emitRawBytes(Data);
1011     } else {
1012       const char *Directive = MAI->getData8bitsDirective();
1013       for (const unsigned char C : Data.bytes()) {
1014         OS << Directive << (unsigned)C;
1015         EmitEOL();
1016       }
1017     }
1018     return;
1019   }
1020
1021   // If the data ends with 0 and the target supports .asciz, use it, otherwise
1022   // use .ascii
1023   if (MAI->getAscizDirective() && Data.back() == 0) {
1024     OS << MAI->getAscizDirective();
1025     Data = Data.substr(0, Data.size()-1);
1026   } else {
1027     OS << MAI->getAsciiDirective();
1028   }
1029
1030   PrintQuotedString(Data, OS);
1031   EmitEOL();
1032 }
1033
1034 void MCAsmStreamer::emitBinaryData(StringRef Data) {
1035   // This is binary data. Print it in a grid of hex bytes for readability.
1036   const size_t Cols = 4;
1037   for (size_t I = 0, EI = alignTo(Data.size(), Cols); I < EI; I += Cols) {
1038     size_t J = I, EJ = std::min(I + Cols, Data.size());
1039     assert(EJ > 0);
1040     OS << MAI->getData8bitsDirective();
1041     for (; J < EJ - 1; ++J)
1042       OS << format("0x%02x", uint8_t(Data[J])) << ", ";
1043     OS << format("0x%02x", uint8_t(Data[J]));
1044     EmitEOL();
1045   }
1046 }
1047
1048 void MCAsmStreamer::emitIntValue(uint64_t Value, unsigned Size) {
1049   emitValue(MCConstantExpr::create(Value, getContext()), Size);
1050 }
1051
1052 void MCAsmStreamer::emitIntValueInHex(uint64_t Value, unsigned Size) {
1053   emitValue(MCConstantExpr::create(Value, getContext(), true), Size);
1054 }
1055
1056 void MCAsmStreamer::emitIntValueInHexWithPadding(uint64_t Value,
1057                                                  unsigned Size) {
1058   emitValue(MCConstantExpr::create(Value, getContext(), true, Size), Size);
1059 }
1060
1061 void MCAsmStreamer::emitValueImpl(const MCExpr *Value, unsigned Size,
1062                                   SMLoc Loc) {
1063   assert(Size <= 8 && "Invalid size");
1064   assert(getCurrentSectionOnly() &&
1065          "Cannot emit contents before setting section!");
1066   const char *Directive = nullptr;
1067   switch (Size) {
1068   default: break;
1069   case 1: Directive = MAI->getData8bitsDirective();  break;
1070   case 2: Directive = MAI->getData16bitsDirective(); break;
1071   case 4: Directive = MAI->getData32bitsDirective(); break;
1072   case 8: Directive = MAI->getData64bitsDirective(); break;
1073   }
1074
1075   if (!Directive) {
1076     int64_t IntValue;
1077     if (!Value->evaluateAsAbsolute(IntValue))
1078       report_fatal_error("Don't know how to emit this value.");
1079
1080     // We couldn't handle the requested integer size so we fallback by breaking
1081     // the request down into several, smaller, integers.
1082     // Since sizes greater or equal to "Size" are invalid, we use the greatest
1083     // power of 2 that is less than "Size" as our largest piece of granularity.
1084     bool IsLittleEndian = MAI->isLittleEndian();
1085     for (unsigned Emitted = 0; Emitted != Size;) {
1086       unsigned Remaining = Size - Emitted;
1087       // The size of our partial emission must be a power of two less than
1088       // Size.
1089       unsigned EmissionSize = PowerOf2Floor(std::min(Remaining, Size - 1));
1090       // Calculate the byte offset of our partial emission taking into account
1091       // the endianness of the target.
1092       unsigned ByteOffset =
1093           IsLittleEndian ? Emitted : (Remaining - EmissionSize);
1094       uint64_t ValueToEmit = IntValue >> (ByteOffset * 8);
1095       // We truncate our partial emission to fit within the bounds of the
1096       // emission domain.  This produces nicer output and silences potential
1097       // truncation warnings when round tripping through another assembler.
1098       uint64_t Shift = 64 - EmissionSize * 8;
1099       assert(Shift < static_cast<uint64_t>(
1100                          std::numeric_limits<unsigned long long>::digits) &&
1101              "undefined behavior");
1102       ValueToEmit &= ~0ULL >> Shift;
1103       emitIntValue(ValueToEmit, EmissionSize);
1104       Emitted += EmissionSize;
1105     }
1106     return;
1107   }
1108
1109   assert(Directive && "Invalid size for machine code value!");
1110   OS << Directive;
1111   if (MCTargetStreamer *TS = getTargetStreamer()) {
1112     TS->emitValue(Value);
1113   } else {
1114     Value->print(OS, MAI);
1115     EmitEOL();
1116   }
1117 }
1118
1119 void MCAsmStreamer::emitULEB128Value(const MCExpr *Value) {
1120   int64_t IntValue;
1121   if (Value->evaluateAsAbsolute(IntValue)) {
1122     emitULEB128IntValue(IntValue);
1123     return;
1124   }
1125   OS << "\t.uleb128 ";
1126   Value->print(OS, MAI);
1127   EmitEOL();
1128 }
1129
1130 void MCAsmStreamer::emitSLEB128Value(const MCExpr *Value) {
1131   int64_t IntValue;
1132   if (Value->evaluateAsAbsolute(IntValue)) {
1133     emitSLEB128IntValue(IntValue);
1134     return;
1135   }
1136   OS << "\t.sleb128 ";
1137   Value->print(OS, MAI);
1138   EmitEOL();
1139 }
1140
1141 void MCAsmStreamer::emitDTPRel64Value(const MCExpr *Value) {
1142   assert(MAI->getDTPRel64Directive() != nullptr);
1143   OS << MAI->getDTPRel64Directive();
1144   Value->print(OS, MAI);
1145   EmitEOL();
1146 }
1147
1148 void MCAsmStreamer::emitDTPRel32Value(const MCExpr *Value) {
1149   assert(MAI->getDTPRel32Directive() != nullptr);
1150   OS << MAI->getDTPRel32Directive();
1151   Value->print(OS, MAI);
1152   EmitEOL();
1153 }
1154
1155 void MCAsmStreamer::emitTPRel64Value(const MCExpr *Value) {
1156   assert(MAI->getTPRel64Directive() != nullptr);
1157   OS << MAI->getTPRel64Directive();
1158   Value->print(OS, MAI);
1159   EmitEOL();
1160 }
1161
1162 void MCAsmStreamer::emitTPRel32Value(const MCExpr *Value) {
1163   assert(MAI->getTPRel32Directive() != nullptr);
1164   OS << MAI->getTPRel32Directive();
1165   Value->print(OS, MAI);
1166   EmitEOL();
1167 }
1168
1169 void MCAsmStreamer::emitGPRel64Value(const MCExpr *Value) {
1170   assert(MAI->getGPRel64Directive() != nullptr);
1171   OS << MAI->getGPRel64Directive();
1172   Value->print(OS, MAI);
1173   EmitEOL();
1174 }
1175
1176 void MCAsmStreamer::emitGPRel32Value(const MCExpr *Value) {
1177   assert(MAI->getGPRel32Directive() != nullptr);
1178   OS << MAI->getGPRel32Directive();
1179   Value->print(OS, MAI);
1180   EmitEOL();
1181 }
1182
1183 void MCAsmStreamer::emitFill(const MCExpr &NumBytes, uint64_t FillValue,
1184                              SMLoc Loc) {
1185   int64_t IntNumBytes;
1186   const bool IsAbsolute = NumBytes.evaluateAsAbsolute(IntNumBytes);
1187   if (IsAbsolute && IntNumBytes == 0)
1188     return;
1189
1190   if (const char *ZeroDirective = MAI->getZeroDirective()) {
1191     if (MAI->doesZeroDirectiveSupportNonZeroValue() || FillValue == 0) {
1192       // FIXME: Emit location directives
1193       OS << ZeroDirective;
1194       NumBytes.print(OS, MAI);
1195       if (FillValue != 0)
1196         OS << ',' << (int)FillValue;
1197       EmitEOL();
1198     } else {
1199       if (!IsAbsolute)
1200         report_fatal_error(
1201             "Cannot emit non-absolute expression lengths of fill.");
1202       for (int i = 0; i < IntNumBytes; ++i) {
1203         OS << MAI->getData8bitsDirective() << (int)FillValue;
1204         EmitEOL();
1205       }
1206     }
1207     return;
1208   }
1209
1210   MCStreamer::emitFill(NumBytes, FillValue);
1211 }
1212
1213 void MCAsmStreamer::emitFill(const MCExpr &NumValues, int64_t Size,
1214                              int64_t Expr, SMLoc Loc) {
1215   // FIXME: Emit location directives
1216   OS << "\t.fill\t";
1217   NumValues.print(OS, MAI);
1218   OS << ", " << Size << ", 0x";
1219   OS.write_hex(truncateToSize(Expr, 4));
1220   EmitEOL();
1221 }
1222
1223 void MCAsmStreamer::emitValueToAlignment(unsigned ByteAlignment, int64_t Value,
1224                                          unsigned ValueSize,
1225                                          unsigned MaxBytesToEmit) {
1226   if (MAI->useDotAlignForAlignment()) {
1227     if (!isPowerOf2_32(ByteAlignment))
1228       report_fatal_error("Only power-of-two alignments are supported "
1229                          "with .align.");
1230     OS << "\t.align\t";
1231     OS << Log2_32(ByteAlignment);
1232     EmitEOL();
1233     return;
1234   }
1235
1236   // Some assemblers don't support non-power of two alignments, so we always
1237   // emit alignments as a power of two if possible.
1238   if (isPowerOf2_32(ByteAlignment)) {
1239     switch (ValueSize) {
1240     default:
1241       llvm_unreachable("Invalid size for machine code value!");
1242     case 1:
1243       OS << "\t.p2align\t";
1244       break;
1245     case 2:
1246       OS << ".p2alignw ";
1247       break;
1248     case 4:
1249       OS << ".p2alignl ";
1250       break;
1251     case 8:
1252       llvm_unreachable("Unsupported alignment size!");
1253     }
1254
1255     OS << Log2_32(ByteAlignment);
1256
1257     if (Value || MaxBytesToEmit) {
1258       OS << ", 0x";
1259       OS.write_hex(truncateToSize(Value, ValueSize));
1260
1261       if (MaxBytesToEmit)
1262         OS << ", " << MaxBytesToEmit;
1263     }
1264     EmitEOL();
1265     return;
1266   }
1267
1268   // Non-power of two alignment.  This is not widely supported by assemblers.
1269   // FIXME: Parameterize this based on MAI.
1270   switch (ValueSize) {
1271   default: llvm_unreachable("Invalid size for machine code value!");
1272   case 1: OS << ".balign";  break;
1273   case 2: OS << ".balignw"; break;
1274   case 4: OS << ".balignl"; break;
1275   case 8: llvm_unreachable("Unsupported alignment size!");
1276   }
1277
1278   OS << ' ' << ByteAlignment;
1279   OS << ", " << truncateToSize(Value, ValueSize);
1280   if (MaxBytesToEmit)
1281     OS << ", " << MaxBytesToEmit;
1282   EmitEOL();
1283 }
1284
1285 void MCAsmStreamer::emitCodeAlignment(unsigned ByteAlignment,
1286                                       unsigned MaxBytesToEmit) {
1287   // Emit with a text fill value.
1288   emitValueToAlignment(ByteAlignment, MAI->getTextAlignFillValue(),
1289                        1, MaxBytesToEmit);
1290 }
1291
1292 void MCAsmStreamer::emitValueToOffset(const MCExpr *Offset,
1293                                       unsigned char Value,
1294                                       SMLoc Loc) {
1295   // FIXME: Verify that Offset is associated with the current section.
1296   OS << ".org ";
1297   Offset->print(OS, MAI);
1298   OS << ", " << (unsigned)Value;
1299   EmitEOL();
1300 }
1301
1302 void MCAsmStreamer::emitFileDirective(StringRef Filename) {
1303   assert(MAI->hasSingleParameterDotFile());
1304   OS << "\t.file\t";
1305   PrintQuotedString(Filename, OS);
1306   EmitEOL();
1307 }
1308
1309 static void printDwarfFileDirective(unsigned FileNo, StringRef Directory,
1310                                     StringRef Filename,
1311                                     Optional<MD5::MD5Result> Checksum,
1312                                     Optional<StringRef> Source,
1313                                     bool UseDwarfDirectory,
1314                                     raw_svector_ostream &OS) {
1315   SmallString<128> FullPathName;
1316
1317   if (!UseDwarfDirectory && !Directory.empty()) {
1318     if (sys::path::is_absolute(Filename))
1319       Directory = "";
1320     else {
1321       FullPathName = Directory;
1322       sys::path::append(FullPathName, Filename);
1323       Directory = "";
1324       Filename = FullPathName;
1325     }
1326   }
1327
1328   OS << "\t.file\t" << FileNo << ' ';
1329   if (!Directory.empty()) {
1330     PrintQuotedString(Directory, OS);
1331     OS << ' ';
1332   }
1333   PrintQuotedString(Filename, OS);
1334   if (Checksum)
1335     OS << " md5 0x" << Checksum->digest();
1336   if (Source) {
1337     OS << " source ";
1338     PrintQuotedString(*Source, OS);
1339   }
1340 }
1341
1342 Expected<unsigned> MCAsmStreamer::tryEmitDwarfFileDirective(
1343     unsigned FileNo, StringRef Directory, StringRef Filename,
1344     Optional<MD5::MD5Result> Checksum, Optional<StringRef> Source, unsigned CUID) {
1345   assert(CUID == 0 && "multiple CUs not supported by MCAsmStreamer");
1346
1347   MCDwarfLineTable &Table = getContext().getMCDwarfLineTable(CUID);
1348   unsigned NumFiles = Table.getMCDwarfFiles().size();
1349   Expected<unsigned> FileNoOrErr =
1350       Table.tryGetFile(Directory, Filename, Checksum, Source,
1351                        getContext().getDwarfVersion(), FileNo);
1352   if (!FileNoOrErr)
1353     return FileNoOrErr.takeError();
1354   FileNo = FileNoOrErr.get();
1355   if (NumFiles == Table.getMCDwarfFiles().size())
1356     return FileNo;
1357
1358   SmallString<128> Str;
1359   raw_svector_ostream OS1(Str);
1360   printDwarfFileDirective(FileNo, Directory, Filename, Checksum, Source,
1361                           UseDwarfDirectory, OS1);
1362
1363   if (MCTargetStreamer *TS = getTargetStreamer())
1364     TS->emitDwarfFileDirective(OS1.str());
1365   else
1366     emitRawText(OS1.str());
1367
1368   return FileNo;
1369 }
1370
1371 void MCAsmStreamer::emitDwarfFile0Directive(StringRef Directory,
1372                                             StringRef Filename,
1373                                             Optional<MD5::MD5Result> Checksum,
1374                                             Optional<StringRef> Source,
1375                                             unsigned CUID) {
1376   assert(CUID == 0);
1377   // .file 0 is new for DWARF v5.
1378   if (getContext().getDwarfVersion() < 5)
1379     return;
1380   // Inform MCDwarf about the root file.
1381   getContext().setMCLineTableRootFile(CUID, Directory, Filename, Checksum,
1382                                       Source);
1383
1384   SmallString<128> Str;
1385   raw_svector_ostream OS1(Str);
1386   printDwarfFileDirective(0, Directory, Filename, Checksum, Source,
1387                           UseDwarfDirectory, OS1);
1388
1389   if (MCTargetStreamer *TS = getTargetStreamer())
1390     TS->emitDwarfFileDirective(OS1.str());
1391   else
1392     emitRawText(OS1.str());
1393 }
1394
1395 void MCAsmStreamer::emitDwarfLocDirective(unsigned FileNo, unsigned Line,
1396                                           unsigned Column, unsigned Flags,
1397                                           unsigned Isa, unsigned Discriminator,
1398                                           StringRef FileName) {
1399   OS << "\t.loc\t" << FileNo << " " << Line << " " << Column;
1400   if (MAI->supportsExtendedDwarfLocDirective()) {
1401     if (Flags & DWARF2_FLAG_BASIC_BLOCK)
1402       OS << " basic_block";
1403     if (Flags & DWARF2_FLAG_PROLOGUE_END)
1404       OS << " prologue_end";
1405     if (Flags & DWARF2_FLAG_EPILOGUE_BEGIN)
1406       OS << " epilogue_begin";
1407
1408     unsigned OldFlags = getContext().getCurrentDwarfLoc().getFlags();
1409     if ((Flags & DWARF2_FLAG_IS_STMT) != (OldFlags & DWARF2_FLAG_IS_STMT)) {
1410       OS << " is_stmt ";
1411
1412       if (Flags & DWARF2_FLAG_IS_STMT)
1413         OS << "1";
1414       else
1415         OS << "0";
1416     }
1417
1418     if (Isa)
1419       OS << " isa " << Isa;
1420     if (Discriminator)
1421       OS << " discriminator " << Discriminator;
1422   }
1423
1424   if (IsVerboseAsm) {
1425     OS.PadToColumn(MAI->getCommentColumn());
1426     OS << MAI->getCommentString() << ' ' << FileName << ':'
1427        << Line << ':' << Column;
1428   }
1429   EmitEOL();
1430   this->MCStreamer::emitDwarfLocDirective(FileNo, Line, Column, Flags, Isa,
1431                                           Discriminator, FileName);
1432 }
1433
1434 MCSymbol *MCAsmStreamer::getDwarfLineTableSymbol(unsigned CUID) {
1435   // Always use the zeroth line table, since asm syntax only supports one line
1436   // table for now.
1437   return MCStreamer::getDwarfLineTableSymbol(0);
1438 }
1439
1440 bool MCAsmStreamer::EmitCVFileDirective(unsigned FileNo, StringRef Filename,
1441                                         ArrayRef<uint8_t> Checksum,
1442                                         unsigned ChecksumKind) {
1443   if (!getContext().getCVContext().addFile(*this, FileNo, Filename, Checksum,
1444                                            ChecksumKind))
1445     return false;
1446
1447   OS << "\t.cv_file\t" << FileNo << ' ';
1448   PrintQuotedString(Filename, OS);
1449
1450   if (!ChecksumKind) {
1451     EmitEOL();
1452     return true;
1453   }
1454
1455   OS << ' ';
1456   PrintQuotedString(toHex(Checksum), OS);
1457   OS << ' ' << ChecksumKind;
1458
1459   EmitEOL();
1460   return true;
1461 }
1462
1463 bool MCAsmStreamer::EmitCVFuncIdDirective(unsigned FuncId) {
1464   OS << "\t.cv_func_id " << FuncId << '\n';
1465   return MCStreamer::EmitCVFuncIdDirective(FuncId);
1466 }
1467
1468 bool MCAsmStreamer::EmitCVInlineSiteIdDirective(unsigned FunctionId,
1469                                                 unsigned IAFunc,
1470                                                 unsigned IAFile,
1471                                                 unsigned IALine, unsigned IACol,
1472                                                 SMLoc Loc) {
1473   OS << "\t.cv_inline_site_id " << FunctionId << " within " << IAFunc
1474      << " inlined_at " << IAFile << ' ' << IALine << ' ' << IACol << '\n';
1475   return MCStreamer::EmitCVInlineSiteIdDirective(FunctionId, IAFunc, IAFile,
1476                                                  IALine, IACol, Loc);
1477 }
1478
1479 void MCAsmStreamer::emitCVLocDirective(unsigned FunctionId, unsigned FileNo,
1480                                        unsigned Line, unsigned Column,
1481                                        bool PrologueEnd, bool IsStmt,
1482                                        StringRef FileName, SMLoc Loc) {
1483   // Validate the directive.
1484   if (!checkCVLocSection(FunctionId, FileNo, Loc))
1485     return;
1486
1487   OS << "\t.cv_loc\t" << FunctionId << " " << FileNo << " " << Line << " "
1488      << Column;
1489   if (PrologueEnd)
1490     OS << " prologue_end";
1491
1492   if (IsStmt)
1493     OS << " is_stmt 1";
1494
1495   if (IsVerboseAsm) {
1496     OS.PadToColumn(MAI->getCommentColumn());
1497     OS << MAI->getCommentString() << ' ' << FileName << ':' << Line << ':'
1498        << Column;
1499   }
1500   EmitEOL();
1501 }
1502
1503 void MCAsmStreamer::emitCVLinetableDirective(unsigned FunctionId,
1504                                              const MCSymbol *FnStart,
1505                                              const MCSymbol *FnEnd) {
1506   OS << "\t.cv_linetable\t" << FunctionId << ", ";
1507   FnStart->print(OS, MAI);
1508   OS << ", ";
1509   FnEnd->print(OS, MAI);
1510   EmitEOL();
1511   this->MCStreamer::emitCVLinetableDirective(FunctionId, FnStart, FnEnd);
1512 }
1513
1514 void MCAsmStreamer::emitCVInlineLinetableDirective(unsigned PrimaryFunctionId,
1515                                                    unsigned SourceFileId,
1516                                                    unsigned SourceLineNum,
1517                                                    const MCSymbol *FnStartSym,
1518                                                    const MCSymbol *FnEndSym) {
1519   OS << "\t.cv_inline_linetable\t" << PrimaryFunctionId << ' ' << SourceFileId
1520      << ' ' << SourceLineNum << ' ';
1521   FnStartSym->print(OS, MAI);
1522   OS << ' ';
1523   FnEndSym->print(OS, MAI);
1524   EmitEOL();
1525   this->MCStreamer::emitCVInlineLinetableDirective(
1526       PrimaryFunctionId, SourceFileId, SourceLineNum, FnStartSym, FnEndSym);
1527 }
1528
1529 void MCAsmStreamer::PrintCVDefRangePrefix(
1530     ArrayRef<std::pair<const MCSymbol *, const MCSymbol *>> Ranges) {
1531   OS << "\t.cv_def_range\t";
1532   for (std::pair<const MCSymbol *, const MCSymbol *> Range : Ranges) {
1533     OS << ' ';
1534     Range.first->print(OS, MAI);
1535     OS << ' ';
1536     Range.second->print(OS, MAI);
1537   }
1538 }
1539
1540 void MCAsmStreamer::emitCVDefRangeDirective(
1541     ArrayRef<std::pair<const MCSymbol *, const MCSymbol *>> Ranges,
1542     codeview::DefRangeRegisterRelHeader DRHdr) {
1543   PrintCVDefRangePrefix(Ranges);
1544   OS << ", reg_rel, ";
1545   OS << DRHdr.Register << ", " << DRHdr.Flags << ", "
1546      << DRHdr.BasePointerOffset;
1547   EmitEOL();
1548 }
1549
1550 void MCAsmStreamer::emitCVDefRangeDirective(
1551     ArrayRef<std::pair<const MCSymbol *, const MCSymbol *>> Ranges,
1552     codeview::DefRangeSubfieldRegisterHeader DRHdr) {
1553   PrintCVDefRangePrefix(Ranges);
1554   OS << ", subfield_reg, ";
1555   OS << DRHdr.Register << ", " << DRHdr.OffsetInParent;
1556   EmitEOL();
1557 }
1558
1559 void MCAsmStreamer::emitCVDefRangeDirective(
1560     ArrayRef<std::pair<const MCSymbol *, const MCSymbol *>> Ranges,
1561     codeview::DefRangeRegisterHeader DRHdr) {
1562   PrintCVDefRangePrefix(Ranges);
1563   OS << ", reg, ";
1564   OS << DRHdr.Register;
1565   EmitEOL();
1566 }
1567
1568 void MCAsmStreamer::emitCVDefRangeDirective(
1569     ArrayRef<std::pair<const MCSymbol *, const MCSymbol *>> Ranges,
1570     codeview::DefRangeFramePointerRelHeader DRHdr) {
1571   PrintCVDefRangePrefix(Ranges);
1572   OS << ", frame_ptr_rel, ";
1573   OS << DRHdr.Offset;
1574   EmitEOL();
1575 }
1576
1577 void MCAsmStreamer::emitCVStringTableDirective() {
1578   OS << "\t.cv_stringtable";
1579   EmitEOL();
1580 }
1581
1582 void MCAsmStreamer::emitCVFileChecksumsDirective() {
1583   OS << "\t.cv_filechecksums";
1584   EmitEOL();
1585 }
1586
1587 void MCAsmStreamer::emitCVFileChecksumOffsetDirective(unsigned FileNo) {
1588   OS << "\t.cv_filechecksumoffset\t" << FileNo;
1589   EmitEOL();
1590 }
1591
1592 void MCAsmStreamer::EmitCVFPOData(const MCSymbol *ProcSym, SMLoc L) {
1593   OS << "\t.cv_fpo_data\t";
1594   ProcSym->print(OS, MAI);
1595   EmitEOL();
1596 }
1597
1598 void MCAsmStreamer::emitIdent(StringRef IdentString) {
1599   assert(MAI->hasIdentDirective() && ".ident directive not supported");
1600   OS << "\t.ident\t";
1601   PrintQuotedString(IdentString, OS);
1602   EmitEOL();
1603 }
1604
1605 void MCAsmStreamer::emitCFISections(bool EH, bool Debug) {
1606   MCStreamer::emitCFISections(EH, Debug);
1607   OS << "\t.cfi_sections ";
1608   if (EH) {
1609     OS << ".eh_frame";
1610     if (Debug)
1611       OS << ", .debug_frame";
1612   } else if (Debug) {
1613     OS << ".debug_frame";
1614   }
1615
1616   EmitEOL();
1617 }
1618
1619 void MCAsmStreamer::emitCFIStartProcImpl(MCDwarfFrameInfo &Frame) {
1620   OS << "\t.cfi_startproc";
1621   if (Frame.IsSimple)
1622     OS << " simple";
1623   EmitEOL();
1624 }
1625
1626 void MCAsmStreamer::emitCFIEndProcImpl(MCDwarfFrameInfo &Frame) {
1627   MCStreamer::emitCFIEndProcImpl(Frame);
1628   OS << "\t.cfi_endproc";
1629   EmitEOL();
1630 }
1631
1632 void MCAsmStreamer::EmitRegisterName(int64_t Register) {
1633   if (!MAI->useDwarfRegNumForCFI()) {
1634     // User .cfi_* directives can use arbitrary DWARF register numbers, not
1635     // just ones that map to LLVM register numbers and have known names.
1636     // Fall back to using the original number directly if no name is known.
1637     const MCRegisterInfo *MRI = getContext().getRegisterInfo();
1638     if (Optional<unsigned> LLVMRegister = MRI->getLLVMRegNum(Register, true)) {
1639       InstPrinter->printRegName(OS, *LLVMRegister);
1640       return;
1641     }
1642   }
1643   OS << Register;
1644 }
1645
1646 void MCAsmStreamer::emitCFIDefCfa(int64_t Register, int64_t Offset) {
1647   MCStreamer::emitCFIDefCfa(Register, Offset);
1648   OS << "\t.cfi_def_cfa ";
1649   EmitRegisterName(Register);
1650   OS << ", " << Offset;
1651   EmitEOL();
1652 }
1653
1654 void MCAsmStreamer::emitCFIDefCfaOffset(int64_t Offset) {
1655   MCStreamer::emitCFIDefCfaOffset(Offset);
1656   OS << "\t.cfi_def_cfa_offset " << Offset;
1657   EmitEOL();
1658 }
1659
1660 static void PrintCFIEscape(llvm::formatted_raw_ostream &OS, StringRef Values) {
1661   OS << "\t.cfi_escape ";
1662   if (!Values.empty()) {
1663     size_t e = Values.size() - 1;
1664     for (size_t i = 0; i < e; ++i)
1665       OS << format("0x%02x", uint8_t(Values[i])) << ", ";
1666     OS << format("0x%02x", uint8_t(Values[e]));
1667   }
1668 }
1669
1670 void MCAsmStreamer::emitCFIEscape(StringRef Values) {
1671   MCStreamer::emitCFIEscape(Values);
1672   PrintCFIEscape(OS, Values);
1673   EmitEOL();
1674 }
1675
1676 void MCAsmStreamer::emitCFIGnuArgsSize(int64_t Size) {
1677   MCStreamer::emitCFIGnuArgsSize(Size);
1678
1679   uint8_t Buffer[16] = { dwarf::DW_CFA_GNU_args_size };
1680   unsigned Len = encodeULEB128(Size, Buffer + 1) + 1;
1681
1682   PrintCFIEscape(OS, StringRef((const char *)&Buffer[0], Len));
1683   EmitEOL();
1684 }
1685
1686 void MCAsmStreamer::emitCFIDefCfaRegister(int64_t Register) {
1687   MCStreamer::emitCFIDefCfaRegister(Register);
1688   OS << "\t.cfi_def_cfa_register ";
1689   EmitRegisterName(Register);
1690   EmitEOL();
1691 }
1692
1693 void MCAsmStreamer::emitCFIOffset(int64_t Register, int64_t Offset) {
1694   this->MCStreamer::emitCFIOffset(Register, Offset);
1695   OS << "\t.cfi_offset ";
1696   EmitRegisterName(Register);
1697   OS << ", " << Offset;
1698   EmitEOL();
1699 }
1700
1701 void MCAsmStreamer::emitCFIPersonality(const MCSymbol *Sym,
1702                                        unsigned Encoding) {
1703   MCStreamer::emitCFIPersonality(Sym, Encoding);
1704   OS << "\t.cfi_personality " << Encoding << ", ";
1705   Sym->print(OS, MAI);
1706   EmitEOL();
1707 }
1708
1709 void MCAsmStreamer::emitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
1710   MCStreamer::emitCFILsda(Sym, Encoding);
1711   OS << "\t.cfi_lsda " << Encoding << ", ";
1712   Sym->print(OS, MAI);
1713   EmitEOL();
1714 }
1715
1716 void MCAsmStreamer::emitCFIRememberState() {
1717   MCStreamer::emitCFIRememberState();
1718   OS << "\t.cfi_remember_state";
1719   EmitEOL();
1720 }
1721
1722 void MCAsmStreamer::emitCFIRestoreState() {
1723   MCStreamer::emitCFIRestoreState();
1724   OS << "\t.cfi_restore_state";
1725   EmitEOL();
1726 }
1727
1728 void MCAsmStreamer::emitCFIRestore(int64_t Register) {
1729   MCStreamer::emitCFIRestore(Register);
1730   OS << "\t.cfi_restore ";
1731   EmitRegisterName(Register);
1732   EmitEOL();
1733 }
1734
1735 void MCAsmStreamer::emitCFISameValue(int64_t Register) {
1736   MCStreamer::emitCFISameValue(Register);
1737   OS << "\t.cfi_same_value ";
1738   EmitRegisterName(Register);
1739   EmitEOL();
1740 }
1741
1742 void MCAsmStreamer::emitCFIRelOffset(int64_t Register, int64_t Offset) {
1743   MCStreamer::emitCFIRelOffset(Register, Offset);
1744   OS << "\t.cfi_rel_offset ";
1745   EmitRegisterName(Register);
1746   OS << ", " << Offset;
1747   EmitEOL();
1748 }
1749
1750 void MCAsmStreamer::emitCFIAdjustCfaOffset(int64_t Adjustment) {
1751   MCStreamer::emitCFIAdjustCfaOffset(Adjustment);
1752   OS << "\t.cfi_adjust_cfa_offset " << Adjustment;
1753   EmitEOL();
1754 }
1755
1756 void MCAsmStreamer::emitCFISignalFrame() {
1757   MCStreamer::emitCFISignalFrame();
1758   OS << "\t.cfi_signal_frame";
1759   EmitEOL();
1760 }
1761
1762 void MCAsmStreamer::emitCFIUndefined(int64_t Register) {
1763   MCStreamer::emitCFIUndefined(Register);
1764   OS << "\t.cfi_undefined ";
1765   EmitRegisterName(Register);
1766   EmitEOL();
1767 }
1768
1769 void MCAsmStreamer::emitCFIRegister(int64_t Register1, int64_t Register2) {
1770   MCStreamer::emitCFIRegister(Register1, Register2);
1771   OS << "\t.cfi_register ";
1772   EmitRegisterName(Register1);
1773   OS << ", ";
1774   EmitRegisterName(Register2);
1775   EmitEOL();
1776 }
1777
1778 void MCAsmStreamer::emitCFIWindowSave() {
1779   MCStreamer::emitCFIWindowSave();
1780   OS << "\t.cfi_window_save";
1781   EmitEOL();
1782 }
1783
1784 void MCAsmStreamer::emitCFINegateRAState() {
1785   MCStreamer::emitCFINegateRAState();
1786   OS << "\t.cfi_negate_ra_state";
1787   EmitEOL();
1788 }
1789
1790 void MCAsmStreamer::emitCFIReturnColumn(int64_t Register) {
1791   MCStreamer::emitCFIReturnColumn(Register);
1792   OS << "\t.cfi_return_column ";
1793   EmitRegisterName(Register);
1794   EmitEOL();
1795 }
1796
1797 void MCAsmStreamer::emitCFIBKeyFrame() {
1798   MCStreamer::emitCFIBKeyFrame();
1799   OS << "\t.cfi_b_key_frame";
1800   EmitEOL();
1801 }
1802
1803 void MCAsmStreamer::EmitWinCFIStartProc(const MCSymbol *Symbol, SMLoc Loc) {
1804   MCStreamer::EmitWinCFIStartProc(Symbol, Loc);
1805
1806   OS << ".seh_proc ";
1807   Symbol->print(OS, MAI);
1808   EmitEOL();
1809 }
1810
1811 void MCAsmStreamer::EmitWinCFIEndProc(SMLoc Loc) {
1812   MCStreamer::EmitWinCFIEndProc(Loc);
1813
1814   OS << "\t.seh_endproc";
1815   EmitEOL();
1816 }
1817
1818 // TODO: Implement
1819 void MCAsmStreamer::EmitWinCFIFuncletOrFuncEnd(SMLoc Loc) {
1820 }
1821
1822 void MCAsmStreamer::EmitWinCFIStartChained(SMLoc Loc) {
1823   MCStreamer::EmitWinCFIStartChained(Loc);
1824
1825   OS << "\t.seh_startchained";
1826   EmitEOL();
1827 }
1828
1829 void MCAsmStreamer::EmitWinCFIEndChained(SMLoc Loc) {
1830   MCStreamer::EmitWinCFIEndChained(Loc);
1831
1832   OS << "\t.seh_endchained";
1833   EmitEOL();
1834 }
1835
1836 void MCAsmStreamer::EmitWinEHHandler(const MCSymbol *Sym, bool Unwind,
1837                                      bool Except, SMLoc Loc) {
1838   MCStreamer::EmitWinEHHandler(Sym, Unwind, Except, Loc);
1839
1840   OS << "\t.seh_handler ";
1841   Sym->print(OS, MAI);
1842   if (Unwind)
1843     OS << ", @unwind";
1844   if (Except)
1845     OS << ", @except";
1846   EmitEOL();
1847 }
1848
1849 void MCAsmStreamer::EmitWinEHHandlerData(SMLoc Loc) {
1850   MCStreamer::EmitWinEHHandlerData(Loc);
1851
1852   // Switch sections. Don't call SwitchSection directly, because that will
1853   // cause the section switch to be visible in the emitted assembly.
1854   // We only do this so the section switch that terminates the handler
1855   // data block is visible.
1856   WinEH::FrameInfo *CurFrame = getCurrentWinFrameInfo();
1857
1858   // Do nothing if no frame is open. MCStreamer should've already reported an
1859   // error.
1860   if (!CurFrame)
1861     return;
1862
1863   MCSection *TextSec = &CurFrame->Function->getSection();
1864   MCSection *XData = getAssociatedXDataSection(TextSec);
1865   SwitchSectionNoChange(XData);
1866
1867   OS << "\t.seh_handlerdata";
1868   EmitEOL();
1869 }
1870
1871 void MCAsmStreamer::EmitWinCFIPushReg(MCRegister Register, SMLoc Loc) {
1872   MCStreamer::EmitWinCFIPushReg(Register, Loc);
1873
1874   OS << "\t.seh_pushreg ";
1875   InstPrinter->printRegName(OS, Register);
1876   EmitEOL();
1877 }
1878
1879 void MCAsmStreamer::EmitWinCFISetFrame(MCRegister Register, unsigned Offset,
1880                                        SMLoc Loc) {
1881   MCStreamer::EmitWinCFISetFrame(Register, Offset, Loc);
1882
1883   OS << "\t.seh_setframe ";
1884   InstPrinter->printRegName(OS, Register);
1885   OS << ", " << Offset;
1886   EmitEOL();
1887 }
1888
1889 void MCAsmStreamer::EmitWinCFIAllocStack(unsigned Size, SMLoc Loc) {
1890   MCStreamer::EmitWinCFIAllocStack(Size, Loc);
1891
1892   OS << "\t.seh_stackalloc " << Size;
1893   EmitEOL();
1894 }
1895
1896 void MCAsmStreamer::EmitWinCFISaveReg(MCRegister Register, unsigned Offset,
1897                                       SMLoc Loc) {
1898   MCStreamer::EmitWinCFISaveReg(Register, Offset, Loc);
1899
1900   OS << "\t.seh_savereg ";
1901   InstPrinter->printRegName(OS, Register);
1902   OS << ", " << Offset;
1903   EmitEOL();
1904 }
1905
1906 void MCAsmStreamer::EmitWinCFISaveXMM(MCRegister Register, unsigned Offset,
1907                                       SMLoc Loc) {
1908   MCStreamer::EmitWinCFISaveXMM(Register, Offset, Loc);
1909
1910   OS << "\t.seh_savexmm ";
1911   InstPrinter->printRegName(OS, Register);
1912   OS << ", " << Offset;
1913   EmitEOL();
1914 }
1915
1916 void MCAsmStreamer::EmitWinCFIPushFrame(bool Code, SMLoc Loc) {
1917   MCStreamer::EmitWinCFIPushFrame(Code, Loc);
1918
1919   OS << "\t.seh_pushframe";
1920   if (Code)
1921     OS << " @code";
1922   EmitEOL();
1923 }
1924
1925 void MCAsmStreamer::EmitWinCFIEndProlog(SMLoc Loc) {
1926   MCStreamer::EmitWinCFIEndProlog(Loc);
1927
1928   OS << "\t.seh_endprologue";
1929   EmitEOL();
1930 }
1931
1932 void MCAsmStreamer::emitCGProfileEntry(const MCSymbolRefExpr *From,
1933                                        const MCSymbolRefExpr *To,
1934                                        uint64_t Count) {
1935   OS << "\t.cg_profile ";
1936   From->getSymbol().print(OS, MAI);
1937   OS << ", ";
1938   To->getSymbol().print(OS, MAI);
1939   OS << ", " << Count;
1940   EmitEOL();
1941 }
1942
1943 void MCAsmStreamer::AddEncodingComment(const MCInst &Inst,
1944                                        const MCSubtargetInfo &STI) {
1945   raw_ostream &OS = GetCommentOS();
1946   SmallString<256> Code;
1947   SmallVector<MCFixup, 4> Fixups;
1948   raw_svector_ostream VecOS(Code);
1949
1950   // If we have no code emitter, don't emit code.
1951   if (!getAssembler().getEmitterPtr())
1952     return;
1953
1954   getAssembler().getEmitter().encodeInstruction(Inst, VecOS, Fixups, STI);
1955
1956   // If we are showing fixups, create symbolic markers in the encoded
1957   // representation. We do this by making a per-bit map to the fixup item index,
1958   // then trying to display it as nicely as possible.
1959   SmallVector<uint8_t, 64> FixupMap;
1960   FixupMap.resize(Code.size() * 8);
1961   for (unsigned i = 0, e = Code.size() * 8; i != e; ++i)
1962     FixupMap[i] = 0;
1963
1964   for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
1965     MCFixup &F = Fixups[i];
1966     const MCFixupKindInfo &Info =
1967         getAssembler().getBackend().getFixupKindInfo(F.getKind());
1968     for (unsigned j = 0; j != Info.TargetSize; ++j) {
1969       unsigned Index = F.getOffset() * 8 + Info.TargetOffset + j;
1970       assert(Index < Code.size() * 8 && "Invalid offset in fixup!");
1971       FixupMap[Index] = 1 + i;
1972     }
1973   }
1974
1975   // FIXME: Note the fixup comments for Thumb2 are completely bogus since the
1976   // high order halfword of a 32-bit Thumb2 instruction is emitted first.
1977   OS << "encoding: [";
1978   for (unsigned i = 0, e = Code.size(); i != e; ++i) {
1979     if (i)
1980       OS << ',';
1981
1982     // See if all bits are the same map entry.
1983     uint8_t MapEntry = FixupMap[i * 8 + 0];
1984     for (unsigned j = 1; j != 8; ++j) {
1985       if (FixupMap[i * 8 + j] == MapEntry)
1986         continue;
1987
1988       MapEntry = uint8_t(~0U);
1989       break;
1990     }
1991
1992     if (MapEntry != uint8_t(~0U)) {
1993       if (MapEntry == 0) {
1994         OS << format("0x%02x", uint8_t(Code[i]));
1995       } else {
1996         if (Code[i]) {
1997           // FIXME: Some of the 8 bits require fix up.
1998           OS << format("0x%02x", uint8_t(Code[i])) << '\''
1999              << char('A' + MapEntry - 1) << '\'';
2000         } else
2001           OS << char('A' + MapEntry - 1);
2002       }
2003     } else {
2004       // Otherwise, write out in binary.
2005       OS << "0b";
2006       for (unsigned j = 8; j--;) {
2007         unsigned Bit = (Code[i] >> j) & 1;
2008
2009         unsigned FixupBit;
2010         if (MAI->isLittleEndian())
2011           FixupBit = i * 8 + j;
2012         else
2013           FixupBit = i * 8 + (7-j);
2014
2015         if (uint8_t MapEntry = FixupMap[FixupBit]) {
2016           assert(Bit == 0 && "Encoder wrote into fixed up bit!");
2017           OS << char('A' + MapEntry - 1);
2018         } else
2019           OS << Bit;
2020       }
2021     }
2022   }
2023   OS << "]\n";
2024
2025   for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
2026     MCFixup &F = Fixups[i];
2027     const MCFixupKindInfo &Info =
2028         getAssembler().getBackend().getFixupKindInfo(F.getKind());
2029     OS << "  fixup " << char('A' + i) << " - " << "offset: " << F.getOffset()
2030        << ", value: " << *F.getValue() << ", kind: " << Info.Name << "\n";
2031   }
2032 }
2033
2034 void MCAsmStreamer::emitInstruction(const MCInst &Inst,
2035                                     const MCSubtargetInfo &STI) {
2036   assert(getCurrentSectionOnly() &&
2037          "Cannot emit contents before setting section!");
2038
2039   // Show the encoding in a comment if we have a code emitter.
2040   AddEncodingComment(Inst, STI);
2041
2042   // Show the MCInst if enabled.
2043   if (ShowInst) {
2044     Inst.dump_pretty(GetCommentOS(), InstPrinter.get(), "\n ");
2045     GetCommentOS() << "\n";
2046   }
2047
2048   if(getTargetStreamer())
2049     getTargetStreamer()->prettyPrintAsm(*InstPrinter, 0, Inst, STI, OS);
2050   else
2051     InstPrinter->printInst(&Inst, 0, "", STI, OS);
2052
2053   StringRef Comments = CommentToEmit;
2054   if (Comments.size() && Comments.back() != '\n')
2055     GetCommentOS() << "\n";
2056
2057   EmitEOL();
2058 }
2059
2060 void MCAsmStreamer::emitBundleAlignMode(unsigned AlignPow2) {
2061   OS << "\t.bundle_align_mode " << AlignPow2;
2062   EmitEOL();
2063 }
2064
2065 void MCAsmStreamer::emitBundleLock(bool AlignToEnd) {
2066   OS << "\t.bundle_lock";
2067   if (AlignToEnd)
2068     OS << " align_to_end";
2069   EmitEOL();
2070 }
2071
2072 void MCAsmStreamer::emitBundleUnlock() {
2073   OS << "\t.bundle_unlock";
2074   EmitEOL();
2075 }
2076
2077 Optional<std::pair<bool, std::string>>
2078 MCAsmStreamer::emitRelocDirective(const MCExpr &Offset, StringRef Name,
2079                                   const MCExpr *Expr, SMLoc,
2080                                   const MCSubtargetInfo &STI) {
2081   OS << "\t.reloc ";
2082   Offset.print(OS, MAI);
2083   OS << ", " << Name;
2084   if (Expr) {
2085     OS << ", ";
2086     Expr->print(OS, MAI);
2087   }
2088   EmitEOL();
2089   return None;
2090 }
2091
2092 void MCAsmStreamer::emitAddrsig() {
2093   OS << "\t.addrsig";
2094   EmitEOL();
2095 }
2096
2097 void MCAsmStreamer::emitAddrsigSym(const MCSymbol *Sym) {
2098   OS << "\t.addrsig_sym ";
2099   Sym->print(OS, MAI);
2100   EmitEOL();
2101 }
2102
2103 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
2104 /// the specified string in the output .s file.  This capability is
2105 /// indicated by the hasRawTextSupport() predicate.
2106 void MCAsmStreamer::emitRawTextImpl(StringRef String) {
2107   if (!String.empty() && String.back() == '\n')
2108     String = String.substr(0, String.size()-1);
2109   OS << String;
2110   EmitEOL();
2111 }
2112
2113 void MCAsmStreamer::finishImpl() {
2114   // If we are generating dwarf for assembly source files dump out the sections.
2115   if (getContext().getGenDwarfForAssembly())
2116     MCGenDwarfInfo::Emit(this);
2117
2118   // Emit the label for the line table, if requested - since the rest of the
2119   // line table will be defined by .loc/.file directives, and not emitted
2120   // directly, the label is the only work required here.
2121   const auto &Tables = getContext().getMCDwarfLineTables();
2122   if (!Tables.empty()) {
2123     assert(Tables.size() == 1 && "asm output only supports one line table");
2124     if (auto *Label = Tables.begin()->second.getLabel()) {
2125       SwitchSection(getContext().getObjectFileInfo()->getDwarfLineSection());
2126       emitLabel(Label);
2127     }
2128   }
2129 }
2130
2131 MCStreamer *llvm::createAsmStreamer(MCContext &Context,
2132                                     std::unique_ptr<formatted_raw_ostream> OS,
2133                                     bool isVerboseAsm, bool useDwarfDirectory,
2134                                     MCInstPrinter *IP,
2135                                     std::unique_ptr<MCCodeEmitter> &&CE,
2136                                     std::unique_ptr<MCAsmBackend> &&MAB,
2137                                     bool ShowInst) {
2138   return new MCAsmStreamer(Context, std::move(OS), isVerboseAsm,
2139                            useDwarfDirectory, IP, std::move(CE), std::move(MAB),
2140                            ShowInst);
2141 }