[MachO] Add skeletal support for DriverKit platform
[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   case MachO::PLATFORM_DRIVERKIT:        return "driverkit";
584   }
585   llvm_unreachable("Invalid Mach-O platform type");
586 }
587
588 void MCAsmStreamer::emitBuildVersion(unsigned Platform, unsigned Major,
589                                      unsigned Minor, unsigned Update,
590                                      VersionTuple SDKVersion) {
591   const char *PlatformName = getPlatformName((MachO::PlatformType)Platform);
592   OS << "\t.build_version " << PlatformName << ", " << Major << ", " << Minor;
593   if (Update)
594     OS << ", " << Update;
595   EmitSDKVersionSuffix(OS, SDKVersion);
596   EmitEOL();
597 }
598
599 void MCAsmStreamer::emitThumbFunc(MCSymbol *Func) {
600   // This needs to emit to a temporary string to get properly quoted
601   // MCSymbols when they have spaces in them.
602   OS << "\t.thumb_func";
603   // Only Mach-O hasSubsectionsViaSymbols()
604   if (MAI->hasSubsectionsViaSymbols()) {
605     OS << '\t';
606     Func->print(OS, MAI);
607   }
608   EmitEOL();
609 }
610
611 void MCAsmStreamer::emitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
612   // Do not emit a .set on inlined target assignments.
613   bool EmitSet = true;
614   if (auto *E = dyn_cast<MCTargetExpr>(Value))
615     if (E->inlineAssignedExpr())
616       EmitSet = false;
617   if (EmitSet) {
618     OS << ".set ";
619     Symbol->print(OS, MAI);
620     OS << ", ";
621     Value->print(OS, MAI);
622
623     EmitEOL();
624   }
625
626   MCStreamer::emitAssignment(Symbol, Value);
627 }
628
629 void MCAsmStreamer::emitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) {
630   OS << ".weakref ";
631   Alias->print(OS, MAI);
632   OS << ", ";
633   Symbol->print(OS, MAI);
634   EmitEOL();
635 }
636
637 bool MCAsmStreamer::emitSymbolAttribute(MCSymbol *Symbol,
638                                         MCSymbolAttr Attribute) {
639   switch (Attribute) {
640   case MCSA_Invalid: llvm_unreachable("Invalid symbol attribute");
641   case MCSA_ELF_TypeFunction:    /// .type _foo, STT_FUNC  # aka @function
642   case MCSA_ELF_TypeIndFunction: /// .type _foo, STT_GNU_IFUNC
643   case MCSA_ELF_TypeObject:      /// .type _foo, STT_OBJECT  # aka @object
644   case MCSA_ELF_TypeTLS:         /// .type _foo, STT_TLS     # aka @tls_object
645   case MCSA_ELF_TypeCommon:      /// .type _foo, STT_COMMON  # aka @common
646   case MCSA_ELF_TypeNoType:      /// .type _foo, STT_NOTYPE  # aka @notype
647   case MCSA_ELF_TypeGnuUniqueObject:  /// .type _foo, @gnu_unique_object
648     if (!MAI->hasDotTypeDotSizeDirective())
649       return false; // Symbol attribute not supported
650     OS << "\t.type\t";
651     Symbol->print(OS, MAI);
652     OS << ',' << ((MAI->getCommentString()[0] != '@') ? '@' : '%');
653     switch (Attribute) {
654     default: return false;
655     case MCSA_ELF_TypeFunction:    OS << "function"; break;
656     case MCSA_ELF_TypeIndFunction: OS << "gnu_indirect_function"; break;
657     case MCSA_ELF_TypeObject:      OS << "object"; break;
658     case MCSA_ELF_TypeTLS:         OS << "tls_object"; break;
659     case MCSA_ELF_TypeCommon:      OS << "common"; break;
660     case MCSA_ELF_TypeNoType:      OS << "notype"; break;
661     case MCSA_ELF_TypeGnuUniqueObject: OS << "gnu_unique_object"; break;
662     }
663     EmitEOL();
664     return true;
665   case MCSA_Global: // .globl/.global
666     OS << MAI->getGlobalDirective();
667     break;
668   case MCSA_LGlobal:        OS << "\t.lglobl\t";          break;
669   case MCSA_Hidden:         OS << "\t.hidden\t";          break;
670   case MCSA_IndirectSymbol: OS << "\t.indirect_symbol\t"; break;
671   case MCSA_Internal:       OS << "\t.internal\t";        break;
672   case MCSA_LazyReference:  OS << "\t.lazy_reference\t";  break;
673   case MCSA_Local:          OS << "\t.local\t";           break;
674   case MCSA_NoDeadStrip:
675     if (!MAI->hasNoDeadStrip())
676       return false;
677     OS << "\t.no_dead_strip\t";
678     break;
679   case MCSA_SymbolResolver: OS << "\t.symbol_resolver\t"; break;
680   case MCSA_AltEntry:       OS << "\t.alt_entry\t";       break;
681   case MCSA_PrivateExtern:
682     OS << "\t.private_extern\t";
683     break;
684   case MCSA_Protected:      OS << "\t.protected\t";       break;
685   case MCSA_Reference:      OS << "\t.reference\t";       break;
686   case MCSA_Extern:
687     OS << "\t.extern\t";
688     break;
689   case MCSA_Weak:           OS << MAI->getWeakDirective(); break;
690   case MCSA_WeakDefinition:
691     OS << "\t.weak_definition\t";
692     break;
693       // .weak_reference
694   case MCSA_WeakReference:  OS << MAI->getWeakRefDirective(); break;
695   case MCSA_WeakDefAutoPrivate: OS << "\t.weak_def_can_be_hidden\t"; break;
696   case MCSA_Cold:
697     // Assemblers currently do not support a .cold directive.
698     return false;
699   }
700
701   Symbol->print(OS, MAI);
702   EmitEOL();
703
704   return true;
705 }
706
707 void MCAsmStreamer::emitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
708   OS << ".desc" << ' ';
709   Symbol->print(OS, MAI);
710   OS << ',' << DescValue;
711   EmitEOL();
712 }
713
714 void MCAsmStreamer::emitSyntaxDirective() {
715   if (MAI->getAssemblerDialect() == 1) {
716     OS << "\t.intel_syntax noprefix";
717     EmitEOL();
718   }
719   // FIXME: Currently emit unprefix'ed registers.
720   // The intel_syntax directive has one optional argument
721   // with may have a value of prefix or noprefix.
722 }
723
724 void MCAsmStreamer::BeginCOFFSymbolDef(const MCSymbol *Symbol) {
725   OS << "\t.def\t ";
726   Symbol->print(OS, MAI);
727   OS << ';';
728   EmitEOL();
729 }
730
731 void MCAsmStreamer::EmitCOFFSymbolStorageClass (int StorageClass) {
732   OS << "\t.scl\t" << StorageClass << ';';
733   EmitEOL();
734 }
735
736 void MCAsmStreamer::EmitCOFFSymbolType (int Type) {
737   OS << "\t.type\t" << Type << ';';
738   EmitEOL();
739 }
740
741 void MCAsmStreamer::EndCOFFSymbolDef() {
742   OS << "\t.endef";
743   EmitEOL();
744 }
745
746 void MCAsmStreamer::EmitCOFFSafeSEH(MCSymbol const *Symbol) {
747   OS << "\t.safeseh\t";
748   Symbol->print(OS, MAI);
749   EmitEOL();
750 }
751
752 void MCAsmStreamer::EmitCOFFSymbolIndex(MCSymbol const *Symbol) {
753   OS << "\t.symidx\t";
754   Symbol->print(OS, MAI);
755   EmitEOL();
756 }
757
758 void MCAsmStreamer::EmitCOFFSectionIndex(MCSymbol const *Symbol) {
759   OS << "\t.secidx\t";
760   Symbol->print(OS, MAI);
761   EmitEOL();
762 }
763
764 void MCAsmStreamer::EmitCOFFSecRel32(MCSymbol const *Symbol, uint64_t Offset) {
765   OS << "\t.secrel32\t";
766   Symbol->print(OS, MAI);
767   if (Offset != 0)
768     OS << '+' << Offset;
769   EmitEOL();
770 }
771
772 void MCAsmStreamer::EmitCOFFImgRel32(MCSymbol const *Symbol, int64_t Offset) {
773   OS << "\t.rva\t";
774   Symbol->print(OS, MAI);
775   if (Offset > 0)
776     OS << '+' << Offset;
777   else if (Offset < 0)
778     OS << '-' << -Offset;
779   EmitEOL();
780 }
781
782 // We need an XCOFF-specific version of this directive as the AIX syntax
783 // requires a QualName argument identifying the csect name and storage mapping
784 // class to appear before the alignment if we are specifying it.
785 void MCAsmStreamer::emitXCOFFLocalCommonSymbol(MCSymbol *LabelSym,
786                                                uint64_t Size,
787                                                MCSymbol *CsectSym,
788                                                unsigned ByteAlignment) {
789   assert(MAI->getLCOMMDirectiveAlignmentType() == LCOMM::Log2Alignment &&
790          "We only support writing log base-2 alignment format with XCOFF.");
791   assert(isPowerOf2_32(ByteAlignment) && "Alignment must be a power of 2.");
792
793   OS << "\t.lcomm\t";
794   LabelSym->print(OS, MAI);
795   OS << ',' << Size << ',';
796   CsectSym->print(OS, MAI);
797   OS << ',' << Log2_32(ByteAlignment);
798
799   EmitEOL();
800 }
801
802 void MCAsmStreamer::emitXCOFFSymbolLinkageWithVisibility(
803     MCSymbol *Symbol, MCSymbolAttr Linkage, MCSymbolAttr Visibility) {
804
805   switch (Linkage) {
806   case MCSA_Global:
807     OS << MAI->getGlobalDirective();
808     break;
809   case MCSA_Weak:
810     OS << MAI->getWeakDirective();
811     break;
812   case MCSA_Extern:
813     OS << "\t.extern\t";
814     break;
815   case MCSA_LGlobal:
816     OS << "\t.lglobl\t";
817     break;
818   default:
819     report_fatal_error("unhandled linkage type");
820   }
821
822   Symbol->print(OS, MAI);
823
824   switch (Visibility) {
825   case MCSA_Invalid:
826     // Nothing to do.
827     break;
828   case MCSA_Hidden:
829     OS << ",hidden";
830     break;
831   case MCSA_Protected:
832     OS << ",protected";
833     break;
834   default:
835     report_fatal_error("unexpected value for Visibility type");
836   }
837   EmitEOL();
838
839   // Print symbol's rename (original name contains invalid character(s)) if
840   // there is one.
841   if (cast<MCSymbolXCOFF>(Symbol)->hasRename())
842     emitXCOFFRenameDirective(Symbol,
843                              cast<MCSymbolXCOFF>(Symbol)->getSymbolTableName());
844 }
845
846 void MCAsmStreamer::emitXCOFFRenameDirective(const MCSymbol *Name,
847                                              StringRef Rename) {
848   OS << "\t.rename\t";
849   Name->print(OS, MAI);
850   const char DQ = '"';
851   OS << ',' << DQ;
852   for (char C : Rename) {
853     // To escape a double quote character, the character should be doubled.
854     if (C == DQ)
855       OS << DQ;
856     OS << C;
857   }
858   OS << DQ;
859   EmitEOL();
860 }
861
862 void MCAsmStreamer::emitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
863   assert(MAI->hasDotTypeDotSizeDirective());
864   OS << "\t.size\t";
865   Symbol->print(OS, MAI);
866   OS << ", ";
867   Value->print(OS, MAI);
868   EmitEOL();
869 }
870
871 void MCAsmStreamer::emitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
872                                      unsigned ByteAlignment) {
873   OS << "\t.comm\t";
874   Symbol->print(OS, MAI);
875   OS << ',' << Size;
876
877   if (ByteAlignment != 0) {
878     if (MAI->getCOMMDirectiveAlignmentIsInBytes())
879       OS << ',' << ByteAlignment;
880     else
881       OS << ',' << Log2_32(ByteAlignment);
882   }
883   EmitEOL();
884
885   // Print symbol's rename (original name contains invalid character(s)) if
886   // there is one.
887   MCSymbolXCOFF *XSym = dyn_cast<MCSymbolXCOFF>(Symbol);
888   if (XSym && XSym->hasRename())
889     emitXCOFFRenameDirective(XSym, XSym->getSymbolTableName());
890
891 }
892
893 void MCAsmStreamer::emitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
894                                           unsigned ByteAlign) {
895   OS << "\t.lcomm\t";
896   Symbol->print(OS, MAI);
897   OS << ',' << Size;
898
899   if (ByteAlign > 1) {
900     switch (MAI->getLCOMMDirectiveAlignmentType()) {
901     case LCOMM::NoAlignment:
902       llvm_unreachable("alignment not supported on .lcomm!");
903     case LCOMM::ByteAlignment:
904       OS << ',' << ByteAlign;
905       break;
906     case LCOMM::Log2Alignment:
907       assert(isPowerOf2_32(ByteAlign) && "alignment must be a power of 2");
908       OS << ',' << Log2_32(ByteAlign);
909       break;
910     }
911   }
912   EmitEOL();
913 }
914
915 void MCAsmStreamer::emitZerofill(MCSection *Section, MCSymbol *Symbol,
916                                  uint64_t Size, unsigned ByteAlignment,
917                                  SMLoc Loc) {
918   if (Symbol)
919     AssignFragment(Symbol, &Section->getDummyFragment());
920
921   // Note: a .zerofill directive does not switch sections.
922   OS << ".zerofill ";
923
924   assert(Section->getVariant() == MCSection::SV_MachO &&
925          ".zerofill is a Mach-O specific directive");
926   // This is a mach-o specific directive.
927
928   const MCSectionMachO *MOSection = ((const MCSectionMachO*)Section);
929   OS << MOSection->getSegmentName() << "," << MOSection->getName();
930
931   if (Symbol) {
932     OS << ',';
933     Symbol->print(OS, MAI);
934     OS << ',' << Size;
935     if (ByteAlignment != 0)
936       OS << ',' << Log2_32(ByteAlignment);
937   }
938   EmitEOL();
939 }
940
941 // .tbss sym, size, align
942 // This depends that the symbol has already been mangled from the original,
943 // e.g. _a.
944 void MCAsmStreamer::emitTBSSSymbol(MCSection *Section, MCSymbol *Symbol,
945                                    uint64_t Size, unsigned ByteAlignment) {
946   AssignFragment(Symbol, &Section->getDummyFragment());
947
948   assert(Symbol && "Symbol shouldn't be NULL!");
949   // Instead of using the Section we'll just use the shortcut.
950
951   assert(Section->getVariant() == MCSection::SV_MachO &&
952          ".zerofill is a Mach-O specific directive");
953   // This is a mach-o specific directive and section.
954
955   OS << ".tbss ";
956   Symbol->print(OS, MAI);
957   OS << ", " << Size;
958
959   // Output align if we have it.  We default to 1 so don't bother printing
960   // that.
961   if (ByteAlignment > 1) OS << ", " << Log2_32(ByteAlignment);
962
963   EmitEOL();
964 }
965
966 static inline char toOctal(int X) { return (X&7)+'0'; }
967
968 static void PrintQuotedString(StringRef Data, raw_ostream &OS) {
969   OS << '"';
970
971   for (unsigned i = 0, e = Data.size(); i != e; ++i) {
972     unsigned char C = Data[i];
973     if (C == '"' || C == '\\') {
974       OS << '\\' << (char)C;
975       continue;
976     }
977
978     if (isPrint((unsigned char)C)) {
979       OS << (char)C;
980       continue;
981     }
982
983     switch (C) {
984       case '\b': OS << "\\b"; break;
985       case '\f': OS << "\\f"; break;
986       case '\n': OS << "\\n"; break;
987       case '\r': OS << "\\r"; break;
988       case '\t': OS << "\\t"; break;
989       default:
990         OS << '\\';
991         OS << toOctal(C >> 6);
992         OS << toOctal(C >> 3);
993         OS << toOctal(C >> 0);
994         break;
995     }
996   }
997
998   OS << '"';
999 }
1000
1001 void MCAsmStreamer::emitBytes(StringRef Data) {
1002   assert(getCurrentSectionOnly() &&
1003          "Cannot emit contents before setting section!");
1004   if (Data.empty()) return;
1005
1006   // If only single byte is provided or no ascii or asciz directives is
1007   // supported, emit as vector of 8bits data.
1008   if (Data.size() == 1 ||
1009       !(MAI->getAscizDirective() || MAI->getAsciiDirective())) {
1010     if (MCTargetStreamer *TS = getTargetStreamer()) {
1011       TS->emitRawBytes(Data);
1012     } else {
1013       const char *Directive = MAI->getData8bitsDirective();
1014       for (const unsigned char C : Data.bytes()) {
1015         OS << Directive << (unsigned)C;
1016         EmitEOL();
1017       }
1018     }
1019     return;
1020   }
1021
1022   // If the data ends with 0 and the target supports .asciz, use it, otherwise
1023   // use .ascii
1024   if (MAI->getAscizDirective() && Data.back() == 0) {
1025     OS << MAI->getAscizDirective();
1026     Data = Data.substr(0, Data.size()-1);
1027   } else {
1028     OS << MAI->getAsciiDirective();
1029   }
1030
1031   PrintQuotedString(Data, OS);
1032   EmitEOL();
1033 }
1034
1035 void MCAsmStreamer::emitBinaryData(StringRef Data) {
1036   // This is binary data. Print it in a grid of hex bytes for readability.
1037   const size_t Cols = 4;
1038   for (size_t I = 0, EI = alignTo(Data.size(), Cols); I < EI; I += Cols) {
1039     size_t J = I, EJ = std::min(I + Cols, Data.size());
1040     assert(EJ > 0);
1041     OS << MAI->getData8bitsDirective();
1042     for (; J < EJ - 1; ++J)
1043       OS << format("0x%02x", uint8_t(Data[J])) << ", ";
1044     OS << format("0x%02x", uint8_t(Data[J]));
1045     EmitEOL();
1046   }
1047 }
1048
1049 void MCAsmStreamer::emitIntValue(uint64_t Value, unsigned Size) {
1050   emitValue(MCConstantExpr::create(Value, getContext()), Size);
1051 }
1052
1053 void MCAsmStreamer::emitIntValueInHex(uint64_t Value, unsigned Size) {
1054   emitValue(MCConstantExpr::create(Value, getContext(), true), Size);
1055 }
1056
1057 void MCAsmStreamer::emitIntValueInHexWithPadding(uint64_t Value,
1058                                                  unsigned Size) {
1059   emitValue(MCConstantExpr::create(Value, getContext(), true, Size), Size);
1060 }
1061
1062 void MCAsmStreamer::emitValueImpl(const MCExpr *Value, unsigned Size,
1063                                   SMLoc Loc) {
1064   assert(Size <= 8 && "Invalid size");
1065   assert(getCurrentSectionOnly() &&
1066          "Cannot emit contents before setting section!");
1067   const char *Directive = nullptr;
1068   switch (Size) {
1069   default: break;
1070   case 1: Directive = MAI->getData8bitsDirective();  break;
1071   case 2: Directive = MAI->getData16bitsDirective(); break;
1072   case 4: Directive = MAI->getData32bitsDirective(); break;
1073   case 8: Directive = MAI->getData64bitsDirective(); break;
1074   }
1075
1076   if (!Directive) {
1077     int64_t IntValue;
1078     if (!Value->evaluateAsAbsolute(IntValue))
1079       report_fatal_error("Don't know how to emit this value.");
1080
1081     // We couldn't handle the requested integer size so we fallback by breaking
1082     // the request down into several, smaller, integers.
1083     // Since sizes greater or equal to "Size" are invalid, we use the greatest
1084     // power of 2 that is less than "Size" as our largest piece of granularity.
1085     bool IsLittleEndian = MAI->isLittleEndian();
1086     for (unsigned Emitted = 0; Emitted != Size;) {
1087       unsigned Remaining = Size - Emitted;
1088       // The size of our partial emission must be a power of two less than
1089       // Size.
1090       unsigned EmissionSize = PowerOf2Floor(std::min(Remaining, Size - 1));
1091       // Calculate the byte offset of our partial emission taking into account
1092       // the endianness of the target.
1093       unsigned ByteOffset =
1094           IsLittleEndian ? Emitted : (Remaining - EmissionSize);
1095       uint64_t ValueToEmit = IntValue >> (ByteOffset * 8);
1096       // We truncate our partial emission to fit within the bounds of the
1097       // emission domain.  This produces nicer output and silences potential
1098       // truncation warnings when round tripping through another assembler.
1099       uint64_t Shift = 64 - EmissionSize * 8;
1100       assert(Shift < static_cast<uint64_t>(
1101                          std::numeric_limits<unsigned long long>::digits) &&
1102              "undefined behavior");
1103       ValueToEmit &= ~0ULL >> Shift;
1104       emitIntValue(ValueToEmit, EmissionSize);
1105       Emitted += EmissionSize;
1106     }
1107     return;
1108   }
1109
1110   assert(Directive && "Invalid size for machine code value!");
1111   OS << Directive;
1112   if (MCTargetStreamer *TS = getTargetStreamer()) {
1113     TS->emitValue(Value);
1114   } else {
1115     Value->print(OS, MAI);
1116     EmitEOL();
1117   }
1118 }
1119
1120 void MCAsmStreamer::emitULEB128Value(const MCExpr *Value) {
1121   int64_t IntValue;
1122   if (Value->evaluateAsAbsolute(IntValue)) {
1123     emitULEB128IntValue(IntValue);
1124     return;
1125   }
1126   OS << "\t.uleb128 ";
1127   Value->print(OS, MAI);
1128   EmitEOL();
1129 }
1130
1131 void MCAsmStreamer::emitSLEB128Value(const MCExpr *Value) {
1132   int64_t IntValue;
1133   if (Value->evaluateAsAbsolute(IntValue)) {
1134     emitSLEB128IntValue(IntValue);
1135     return;
1136   }
1137   OS << "\t.sleb128 ";
1138   Value->print(OS, MAI);
1139   EmitEOL();
1140 }
1141
1142 void MCAsmStreamer::emitDTPRel64Value(const MCExpr *Value) {
1143   assert(MAI->getDTPRel64Directive() != nullptr);
1144   OS << MAI->getDTPRel64Directive();
1145   Value->print(OS, MAI);
1146   EmitEOL();
1147 }
1148
1149 void MCAsmStreamer::emitDTPRel32Value(const MCExpr *Value) {
1150   assert(MAI->getDTPRel32Directive() != nullptr);
1151   OS << MAI->getDTPRel32Directive();
1152   Value->print(OS, MAI);
1153   EmitEOL();
1154 }
1155
1156 void MCAsmStreamer::emitTPRel64Value(const MCExpr *Value) {
1157   assert(MAI->getTPRel64Directive() != nullptr);
1158   OS << MAI->getTPRel64Directive();
1159   Value->print(OS, MAI);
1160   EmitEOL();
1161 }
1162
1163 void MCAsmStreamer::emitTPRel32Value(const MCExpr *Value) {
1164   assert(MAI->getTPRel32Directive() != nullptr);
1165   OS << MAI->getTPRel32Directive();
1166   Value->print(OS, MAI);
1167   EmitEOL();
1168 }
1169
1170 void MCAsmStreamer::emitGPRel64Value(const MCExpr *Value) {
1171   assert(MAI->getGPRel64Directive() != nullptr);
1172   OS << MAI->getGPRel64Directive();
1173   Value->print(OS, MAI);
1174   EmitEOL();
1175 }
1176
1177 void MCAsmStreamer::emitGPRel32Value(const MCExpr *Value) {
1178   assert(MAI->getGPRel32Directive() != nullptr);
1179   OS << MAI->getGPRel32Directive();
1180   Value->print(OS, MAI);
1181   EmitEOL();
1182 }
1183
1184 void MCAsmStreamer::emitFill(const MCExpr &NumBytes, uint64_t FillValue,
1185                              SMLoc Loc) {
1186   int64_t IntNumBytes;
1187   const bool IsAbsolute = NumBytes.evaluateAsAbsolute(IntNumBytes);
1188   if (IsAbsolute && IntNumBytes == 0)
1189     return;
1190
1191   if (const char *ZeroDirective = MAI->getZeroDirective()) {
1192     if (MAI->doesZeroDirectiveSupportNonZeroValue() || FillValue == 0) {
1193       // FIXME: Emit location directives
1194       OS << ZeroDirective;
1195       NumBytes.print(OS, MAI);
1196       if (FillValue != 0)
1197         OS << ',' << (int)FillValue;
1198       EmitEOL();
1199     } else {
1200       if (!IsAbsolute)
1201         report_fatal_error(
1202             "Cannot emit non-absolute expression lengths of fill.");
1203       for (int i = 0; i < IntNumBytes; ++i) {
1204         OS << MAI->getData8bitsDirective() << (int)FillValue;
1205         EmitEOL();
1206       }
1207     }
1208     return;
1209   }
1210
1211   MCStreamer::emitFill(NumBytes, FillValue);
1212 }
1213
1214 void MCAsmStreamer::emitFill(const MCExpr &NumValues, int64_t Size,
1215                              int64_t Expr, SMLoc Loc) {
1216   // FIXME: Emit location directives
1217   OS << "\t.fill\t";
1218   NumValues.print(OS, MAI);
1219   OS << ", " << Size << ", 0x";
1220   OS.write_hex(truncateToSize(Expr, 4));
1221   EmitEOL();
1222 }
1223
1224 void MCAsmStreamer::emitValueToAlignment(unsigned ByteAlignment, int64_t Value,
1225                                          unsigned ValueSize,
1226                                          unsigned MaxBytesToEmit) {
1227   if (MAI->useDotAlignForAlignment()) {
1228     if (!isPowerOf2_32(ByteAlignment))
1229       report_fatal_error("Only power-of-two alignments are supported "
1230                          "with .align.");
1231     OS << "\t.align\t";
1232     OS << Log2_32(ByteAlignment);
1233     EmitEOL();
1234     return;
1235   }
1236
1237   // Some assemblers don't support non-power of two alignments, so we always
1238   // emit alignments as a power of two if possible.
1239   if (isPowerOf2_32(ByteAlignment)) {
1240     switch (ValueSize) {
1241     default:
1242       llvm_unreachable("Invalid size for machine code value!");
1243     case 1:
1244       OS << "\t.p2align\t";
1245       break;
1246     case 2:
1247       OS << ".p2alignw ";
1248       break;
1249     case 4:
1250       OS << ".p2alignl ";
1251       break;
1252     case 8:
1253       llvm_unreachable("Unsupported alignment size!");
1254     }
1255
1256     OS << Log2_32(ByteAlignment);
1257
1258     if (Value || MaxBytesToEmit) {
1259       OS << ", 0x";
1260       OS.write_hex(truncateToSize(Value, ValueSize));
1261
1262       if (MaxBytesToEmit)
1263         OS << ", " << MaxBytesToEmit;
1264     }
1265     EmitEOL();
1266     return;
1267   }
1268
1269   // Non-power of two alignment.  This is not widely supported by assemblers.
1270   // FIXME: Parameterize this based on MAI.
1271   switch (ValueSize) {
1272   default: llvm_unreachable("Invalid size for machine code value!");
1273   case 1: OS << ".balign";  break;
1274   case 2: OS << ".balignw"; break;
1275   case 4: OS << ".balignl"; break;
1276   case 8: llvm_unreachable("Unsupported alignment size!");
1277   }
1278
1279   OS << ' ' << ByteAlignment;
1280   OS << ", " << truncateToSize(Value, ValueSize);
1281   if (MaxBytesToEmit)
1282     OS << ", " << MaxBytesToEmit;
1283   EmitEOL();
1284 }
1285
1286 void MCAsmStreamer::emitCodeAlignment(unsigned ByteAlignment,
1287                                       unsigned MaxBytesToEmit) {
1288   // Emit with a text fill value.
1289   emitValueToAlignment(ByteAlignment, MAI->getTextAlignFillValue(),
1290                        1, MaxBytesToEmit);
1291 }
1292
1293 void MCAsmStreamer::emitValueToOffset(const MCExpr *Offset,
1294                                       unsigned char Value,
1295                                       SMLoc Loc) {
1296   // FIXME: Verify that Offset is associated with the current section.
1297   OS << ".org ";
1298   Offset->print(OS, MAI);
1299   OS << ", " << (unsigned)Value;
1300   EmitEOL();
1301 }
1302
1303 void MCAsmStreamer::emitFileDirective(StringRef Filename) {
1304   assert(MAI->hasSingleParameterDotFile());
1305   OS << "\t.file\t";
1306   PrintQuotedString(Filename, OS);
1307   EmitEOL();
1308 }
1309
1310 static void printDwarfFileDirective(unsigned FileNo, StringRef Directory,
1311                                     StringRef Filename,
1312                                     Optional<MD5::MD5Result> Checksum,
1313                                     Optional<StringRef> Source,
1314                                     bool UseDwarfDirectory,
1315                                     raw_svector_ostream &OS) {
1316   SmallString<128> FullPathName;
1317
1318   if (!UseDwarfDirectory && !Directory.empty()) {
1319     if (sys::path::is_absolute(Filename))
1320       Directory = "";
1321     else {
1322       FullPathName = Directory;
1323       sys::path::append(FullPathName, Filename);
1324       Directory = "";
1325       Filename = FullPathName;
1326     }
1327   }
1328
1329   OS << "\t.file\t" << FileNo << ' ';
1330   if (!Directory.empty()) {
1331     PrintQuotedString(Directory, OS);
1332     OS << ' ';
1333   }
1334   PrintQuotedString(Filename, OS);
1335   if (Checksum)
1336     OS << " md5 0x" << Checksum->digest();
1337   if (Source) {
1338     OS << " source ";
1339     PrintQuotedString(*Source, OS);
1340   }
1341 }
1342
1343 Expected<unsigned> MCAsmStreamer::tryEmitDwarfFileDirective(
1344     unsigned FileNo, StringRef Directory, StringRef Filename,
1345     Optional<MD5::MD5Result> Checksum, Optional<StringRef> Source, unsigned CUID) {
1346   assert(CUID == 0 && "multiple CUs not supported by MCAsmStreamer");
1347
1348   MCDwarfLineTable &Table = getContext().getMCDwarfLineTable(CUID);
1349   unsigned NumFiles = Table.getMCDwarfFiles().size();
1350   Expected<unsigned> FileNoOrErr =
1351       Table.tryGetFile(Directory, Filename, Checksum, Source,
1352                        getContext().getDwarfVersion(), FileNo);
1353   if (!FileNoOrErr)
1354     return FileNoOrErr.takeError();
1355   FileNo = FileNoOrErr.get();
1356   if (NumFiles == Table.getMCDwarfFiles().size())
1357     return FileNo;
1358
1359   SmallString<128> Str;
1360   raw_svector_ostream OS1(Str);
1361   printDwarfFileDirective(FileNo, Directory, Filename, Checksum, Source,
1362                           UseDwarfDirectory, OS1);
1363
1364   if (MCTargetStreamer *TS = getTargetStreamer())
1365     TS->emitDwarfFileDirective(OS1.str());
1366   else
1367     emitRawText(OS1.str());
1368
1369   return FileNo;
1370 }
1371
1372 void MCAsmStreamer::emitDwarfFile0Directive(StringRef Directory,
1373                                             StringRef Filename,
1374                                             Optional<MD5::MD5Result> Checksum,
1375                                             Optional<StringRef> Source,
1376                                             unsigned CUID) {
1377   assert(CUID == 0);
1378   // .file 0 is new for DWARF v5.
1379   if (getContext().getDwarfVersion() < 5)
1380     return;
1381   // Inform MCDwarf about the root file.
1382   getContext().setMCLineTableRootFile(CUID, Directory, Filename, Checksum,
1383                                       Source);
1384
1385   SmallString<128> Str;
1386   raw_svector_ostream OS1(Str);
1387   printDwarfFileDirective(0, Directory, Filename, Checksum, Source,
1388                           UseDwarfDirectory, OS1);
1389
1390   if (MCTargetStreamer *TS = getTargetStreamer())
1391     TS->emitDwarfFileDirective(OS1.str());
1392   else
1393     emitRawText(OS1.str());
1394 }
1395
1396 void MCAsmStreamer::emitDwarfLocDirective(unsigned FileNo, unsigned Line,
1397                                           unsigned Column, unsigned Flags,
1398                                           unsigned Isa, unsigned Discriminator,
1399                                           StringRef FileName) {
1400   OS << "\t.loc\t" << FileNo << " " << Line << " " << Column;
1401   if (MAI->supportsExtendedDwarfLocDirective()) {
1402     if (Flags & DWARF2_FLAG_BASIC_BLOCK)
1403       OS << " basic_block";
1404     if (Flags & DWARF2_FLAG_PROLOGUE_END)
1405       OS << " prologue_end";
1406     if (Flags & DWARF2_FLAG_EPILOGUE_BEGIN)
1407       OS << " epilogue_begin";
1408
1409     unsigned OldFlags = getContext().getCurrentDwarfLoc().getFlags();
1410     if ((Flags & DWARF2_FLAG_IS_STMT) != (OldFlags & DWARF2_FLAG_IS_STMT)) {
1411       OS << " is_stmt ";
1412
1413       if (Flags & DWARF2_FLAG_IS_STMT)
1414         OS << "1";
1415       else
1416         OS << "0";
1417     }
1418
1419     if (Isa)
1420       OS << " isa " << Isa;
1421     if (Discriminator)
1422       OS << " discriminator " << Discriminator;
1423   }
1424
1425   if (IsVerboseAsm) {
1426     OS.PadToColumn(MAI->getCommentColumn());
1427     OS << MAI->getCommentString() << ' ' << FileName << ':'
1428        << Line << ':' << Column;
1429   }
1430   EmitEOL();
1431   this->MCStreamer::emitDwarfLocDirective(FileNo, Line, Column, Flags, Isa,
1432                                           Discriminator, FileName);
1433 }
1434
1435 MCSymbol *MCAsmStreamer::getDwarfLineTableSymbol(unsigned CUID) {
1436   // Always use the zeroth line table, since asm syntax only supports one line
1437   // table for now.
1438   return MCStreamer::getDwarfLineTableSymbol(0);
1439 }
1440
1441 bool MCAsmStreamer::EmitCVFileDirective(unsigned FileNo, StringRef Filename,
1442                                         ArrayRef<uint8_t> Checksum,
1443                                         unsigned ChecksumKind) {
1444   if (!getContext().getCVContext().addFile(*this, FileNo, Filename, Checksum,
1445                                            ChecksumKind))
1446     return false;
1447
1448   OS << "\t.cv_file\t" << FileNo << ' ';
1449   PrintQuotedString(Filename, OS);
1450
1451   if (!ChecksumKind) {
1452     EmitEOL();
1453     return true;
1454   }
1455
1456   OS << ' ';
1457   PrintQuotedString(toHex(Checksum), OS);
1458   OS << ' ' << ChecksumKind;
1459
1460   EmitEOL();
1461   return true;
1462 }
1463
1464 bool MCAsmStreamer::EmitCVFuncIdDirective(unsigned FuncId) {
1465   OS << "\t.cv_func_id " << FuncId << '\n';
1466   return MCStreamer::EmitCVFuncIdDirective(FuncId);
1467 }
1468
1469 bool MCAsmStreamer::EmitCVInlineSiteIdDirective(unsigned FunctionId,
1470                                                 unsigned IAFunc,
1471                                                 unsigned IAFile,
1472                                                 unsigned IALine, unsigned IACol,
1473                                                 SMLoc Loc) {
1474   OS << "\t.cv_inline_site_id " << FunctionId << " within " << IAFunc
1475      << " inlined_at " << IAFile << ' ' << IALine << ' ' << IACol << '\n';
1476   return MCStreamer::EmitCVInlineSiteIdDirective(FunctionId, IAFunc, IAFile,
1477                                                  IALine, IACol, Loc);
1478 }
1479
1480 void MCAsmStreamer::emitCVLocDirective(unsigned FunctionId, unsigned FileNo,
1481                                        unsigned Line, unsigned Column,
1482                                        bool PrologueEnd, bool IsStmt,
1483                                        StringRef FileName, SMLoc Loc) {
1484   // Validate the directive.
1485   if (!checkCVLocSection(FunctionId, FileNo, Loc))
1486     return;
1487
1488   OS << "\t.cv_loc\t" << FunctionId << " " << FileNo << " " << Line << " "
1489      << Column;
1490   if (PrologueEnd)
1491     OS << " prologue_end";
1492
1493   if (IsStmt)
1494     OS << " is_stmt 1";
1495
1496   if (IsVerboseAsm) {
1497     OS.PadToColumn(MAI->getCommentColumn());
1498     OS << MAI->getCommentString() << ' ' << FileName << ':' << Line << ':'
1499        << Column;
1500   }
1501   EmitEOL();
1502 }
1503
1504 void MCAsmStreamer::emitCVLinetableDirective(unsigned FunctionId,
1505                                              const MCSymbol *FnStart,
1506                                              const MCSymbol *FnEnd) {
1507   OS << "\t.cv_linetable\t" << FunctionId << ", ";
1508   FnStart->print(OS, MAI);
1509   OS << ", ";
1510   FnEnd->print(OS, MAI);
1511   EmitEOL();
1512   this->MCStreamer::emitCVLinetableDirective(FunctionId, FnStart, FnEnd);
1513 }
1514
1515 void MCAsmStreamer::emitCVInlineLinetableDirective(unsigned PrimaryFunctionId,
1516                                                    unsigned SourceFileId,
1517                                                    unsigned SourceLineNum,
1518                                                    const MCSymbol *FnStartSym,
1519                                                    const MCSymbol *FnEndSym) {
1520   OS << "\t.cv_inline_linetable\t" << PrimaryFunctionId << ' ' << SourceFileId
1521      << ' ' << SourceLineNum << ' ';
1522   FnStartSym->print(OS, MAI);
1523   OS << ' ';
1524   FnEndSym->print(OS, MAI);
1525   EmitEOL();
1526   this->MCStreamer::emitCVInlineLinetableDirective(
1527       PrimaryFunctionId, SourceFileId, SourceLineNum, FnStartSym, FnEndSym);
1528 }
1529
1530 void MCAsmStreamer::PrintCVDefRangePrefix(
1531     ArrayRef<std::pair<const MCSymbol *, const MCSymbol *>> Ranges) {
1532   OS << "\t.cv_def_range\t";
1533   for (std::pair<const MCSymbol *, const MCSymbol *> Range : Ranges) {
1534     OS << ' ';
1535     Range.first->print(OS, MAI);
1536     OS << ' ';
1537     Range.second->print(OS, MAI);
1538   }
1539 }
1540
1541 void MCAsmStreamer::emitCVDefRangeDirective(
1542     ArrayRef<std::pair<const MCSymbol *, const MCSymbol *>> Ranges,
1543     codeview::DefRangeRegisterRelHeader DRHdr) {
1544   PrintCVDefRangePrefix(Ranges);
1545   OS << ", reg_rel, ";
1546   OS << DRHdr.Register << ", " << DRHdr.Flags << ", "
1547      << DRHdr.BasePointerOffset;
1548   EmitEOL();
1549 }
1550
1551 void MCAsmStreamer::emitCVDefRangeDirective(
1552     ArrayRef<std::pair<const MCSymbol *, const MCSymbol *>> Ranges,
1553     codeview::DefRangeSubfieldRegisterHeader DRHdr) {
1554   PrintCVDefRangePrefix(Ranges);
1555   OS << ", subfield_reg, ";
1556   OS << DRHdr.Register << ", " << DRHdr.OffsetInParent;
1557   EmitEOL();
1558 }
1559
1560 void MCAsmStreamer::emitCVDefRangeDirective(
1561     ArrayRef<std::pair<const MCSymbol *, const MCSymbol *>> Ranges,
1562     codeview::DefRangeRegisterHeader DRHdr) {
1563   PrintCVDefRangePrefix(Ranges);
1564   OS << ", reg, ";
1565   OS << DRHdr.Register;
1566   EmitEOL();
1567 }
1568
1569 void MCAsmStreamer::emitCVDefRangeDirective(
1570     ArrayRef<std::pair<const MCSymbol *, const MCSymbol *>> Ranges,
1571     codeview::DefRangeFramePointerRelHeader DRHdr) {
1572   PrintCVDefRangePrefix(Ranges);
1573   OS << ", frame_ptr_rel, ";
1574   OS << DRHdr.Offset;
1575   EmitEOL();
1576 }
1577
1578 void MCAsmStreamer::emitCVStringTableDirective() {
1579   OS << "\t.cv_stringtable";
1580   EmitEOL();
1581 }
1582
1583 void MCAsmStreamer::emitCVFileChecksumsDirective() {
1584   OS << "\t.cv_filechecksums";
1585   EmitEOL();
1586 }
1587
1588 void MCAsmStreamer::emitCVFileChecksumOffsetDirective(unsigned FileNo) {
1589   OS << "\t.cv_filechecksumoffset\t" << FileNo;
1590   EmitEOL();
1591 }
1592
1593 void MCAsmStreamer::EmitCVFPOData(const MCSymbol *ProcSym, SMLoc L) {
1594   OS << "\t.cv_fpo_data\t";
1595   ProcSym->print(OS, MAI);
1596   EmitEOL();
1597 }
1598
1599 void MCAsmStreamer::emitIdent(StringRef IdentString) {
1600   assert(MAI->hasIdentDirective() && ".ident directive not supported");
1601   OS << "\t.ident\t";
1602   PrintQuotedString(IdentString, OS);
1603   EmitEOL();
1604 }
1605
1606 void MCAsmStreamer::emitCFISections(bool EH, bool Debug) {
1607   MCStreamer::emitCFISections(EH, Debug);
1608   OS << "\t.cfi_sections ";
1609   if (EH) {
1610     OS << ".eh_frame";
1611     if (Debug)
1612       OS << ", .debug_frame";
1613   } else if (Debug) {
1614     OS << ".debug_frame";
1615   }
1616
1617   EmitEOL();
1618 }
1619
1620 void MCAsmStreamer::emitCFIStartProcImpl(MCDwarfFrameInfo &Frame) {
1621   OS << "\t.cfi_startproc";
1622   if (Frame.IsSimple)
1623     OS << " simple";
1624   EmitEOL();
1625 }
1626
1627 void MCAsmStreamer::emitCFIEndProcImpl(MCDwarfFrameInfo &Frame) {
1628   MCStreamer::emitCFIEndProcImpl(Frame);
1629   OS << "\t.cfi_endproc";
1630   EmitEOL();
1631 }
1632
1633 void MCAsmStreamer::EmitRegisterName(int64_t Register) {
1634   if (!MAI->useDwarfRegNumForCFI()) {
1635     // User .cfi_* directives can use arbitrary DWARF register numbers, not
1636     // just ones that map to LLVM register numbers and have known names.
1637     // Fall back to using the original number directly if no name is known.
1638     const MCRegisterInfo *MRI = getContext().getRegisterInfo();
1639     if (Optional<unsigned> LLVMRegister = MRI->getLLVMRegNum(Register, true)) {
1640       InstPrinter->printRegName(OS, *LLVMRegister);
1641       return;
1642     }
1643   }
1644   OS << Register;
1645 }
1646
1647 void MCAsmStreamer::emitCFIDefCfa(int64_t Register, int64_t Offset) {
1648   MCStreamer::emitCFIDefCfa(Register, Offset);
1649   OS << "\t.cfi_def_cfa ";
1650   EmitRegisterName(Register);
1651   OS << ", " << Offset;
1652   EmitEOL();
1653 }
1654
1655 void MCAsmStreamer::emitCFIDefCfaOffset(int64_t Offset) {
1656   MCStreamer::emitCFIDefCfaOffset(Offset);
1657   OS << "\t.cfi_def_cfa_offset " << Offset;
1658   EmitEOL();
1659 }
1660
1661 static void PrintCFIEscape(llvm::formatted_raw_ostream &OS, StringRef Values) {
1662   OS << "\t.cfi_escape ";
1663   if (!Values.empty()) {
1664     size_t e = Values.size() - 1;
1665     for (size_t i = 0; i < e; ++i)
1666       OS << format("0x%02x", uint8_t(Values[i])) << ", ";
1667     OS << format("0x%02x", uint8_t(Values[e]));
1668   }
1669 }
1670
1671 void MCAsmStreamer::emitCFIEscape(StringRef Values) {
1672   MCStreamer::emitCFIEscape(Values);
1673   PrintCFIEscape(OS, Values);
1674   EmitEOL();
1675 }
1676
1677 void MCAsmStreamer::emitCFIGnuArgsSize(int64_t Size) {
1678   MCStreamer::emitCFIGnuArgsSize(Size);
1679
1680   uint8_t Buffer[16] = { dwarf::DW_CFA_GNU_args_size };
1681   unsigned Len = encodeULEB128(Size, Buffer + 1) + 1;
1682
1683   PrintCFIEscape(OS, StringRef((const char *)&Buffer[0], Len));
1684   EmitEOL();
1685 }
1686
1687 void MCAsmStreamer::emitCFIDefCfaRegister(int64_t Register) {
1688   MCStreamer::emitCFIDefCfaRegister(Register);
1689   OS << "\t.cfi_def_cfa_register ";
1690   EmitRegisterName(Register);
1691   EmitEOL();
1692 }
1693
1694 void MCAsmStreamer::emitCFIOffset(int64_t Register, int64_t Offset) {
1695   this->MCStreamer::emitCFIOffset(Register, Offset);
1696   OS << "\t.cfi_offset ";
1697   EmitRegisterName(Register);
1698   OS << ", " << Offset;
1699   EmitEOL();
1700 }
1701
1702 void MCAsmStreamer::emitCFIPersonality(const MCSymbol *Sym,
1703                                        unsigned Encoding) {
1704   MCStreamer::emitCFIPersonality(Sym, Encoding);
1705   OS << "\t.cfi_personality " << Encoding << ", ";
1706   Sym->print(OS, MAI);
1707   EmitEOL();
1708 }
1709
1710 void MCAsmStreamer::emitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
1711   MCStreamer::emitCFILsda(Sym, Encoding);
1712   OS << "\t.cfi_lsda " << Encoding << ", ";
1713   Sym->print(OS, MAI);
1714   EmitEOL();
1715 }
1716
1717 void MCAsmStreamer::emitCFIRememberState() {
1718   MCStreamer::emitCFIRememberState();
1719   OS << "\t.cfi_remember_state";
1720   EmitEOL();
1721 }
1722
1723 void MCAsmStreamer::emitCFIRestoreState() {
1724   MCStreamer::emitCFIRestoreState();
1725   OS << "\t.cfi_restore_state";
1726   EmitEOL();
1727 }
1728
1729 void MCAsmStreamer::emitCFIRestore(int64_t Register) {
1730   MCStreamer::emitCFIRestore(Register);
1731   OS << "\t.cfi_restore ";
1732   EmitRegisterName(Register);
1733   EmitEOL();
1734 }
1735
1736 void MCAsmStreamer::emitCFISameValue(int64_t Register) {
1737   MCStreamer::emitCFISameValue(Register);
1738   OS << "\t.cfi_same_value ";
1739   EmitRegisterName(Register);
1740   EmitEOL();
1741 }
1742
1743 void MCAsmStreamer::emitCFIRelOffset(int64_t Register, int64_t Offset) {
1744   MCStreamer::emitCFIRelOffset(Register, Offset);
1745   OS << "\t.cfi_rel_offset ";
1746   EmitRegisterName(Register);
1747   OS << ", " << Offset;
1748   EmitEOL();
1749 }
1750
1751 void MCAsmStreamer::emitCFIAdjustCfaOffset(int64_t Adjustment) {
1752   MCStreamer::emitCFIAdjustCfaOffset(Adjustment);
1753   OS << "\t.cfi_adjust_cfa_offset " << Adjustment;
1754   EmitEOL();
1755 }
1756
1757 void MCAsmStreamer::emitCFISignalFrame() {
1758   MCStreamer::emitCFISignalFrame();
1759   OS << "\t.cfi_signal_frame";
1760   EmitEOL();
1761 }
1762
1763 void MCAsmStreamer::emitCFIUndefined(int64_t Register) {
1764   MCStreamer::emitCFIUndefined(Register);
1765   OS << "\t.cfi_undefined ";
1766   EmitRegisterName(Register);
1767   EmitEOL();
1768 }
1769
1770 void MCAsmStreamer::emitCFIRegister(int64_t Register1, int64_t Register2) {
1771   MCStreamer::emitCFIRegister(Register1, Register2);
1772   OS << "\t.cfi_register ";
1773   EmitRegisterName(Register1);
1774   OS << ", ";
1775   EmitRegisterName(Register2);
1776   EmitEOL();
1777 }
1778
1779 void MCAsmStreamer::emitCFIWindowSave() {
1780   MCStreamer::emitCFIWindowSave();
1781   OS << "\t.cfi_window_save";
1782   EmitEOL();
1783 }
1784
1785 void MCAsmStreamer::emitCFINegateRAState() {
1786   MCStreamer::emitCFINegateRAState();
1787   OS << "\t.cfi_negate_ra_state";
1788   EmitEOL();
1789 }
1790
1791 void MCAsmStreamer::emitCFIReturnColumn(int64_t Register) {
1792   MCStreamer::emitCFIReturnColumn(Register);
1793   OS << "\t.cfi_return_column ";
1794   EmitRegisterName(Register);
1795   EmitEOL();
1796 }
1797
1798 void MCAsmStreamer::emitCFIBKeyFrame() {
1799   MCStreamer::emitCFIBKeyFrame();
1800   OS << "\t.cfi_b_key_frame";
1801   EmitEOL();
1802 }
1803
1804 void MCAsmStreamer::EmitWinCFIStartProc(const MCSymbol *Symbol, SMLoc Loc) {
1805   MCStreamer::EmitWinCFIStartProc(Symbol, Loc);
1806
1807   OS << ".seh_proc ";
1808   Symbol->print(OS, MAI);
1809   EmitEOL();
1810 }
1811
1812 void MCAsmStreamer::EmitWinCFIEndProc(SMLoc Loc) {
1813   MCStreamer::EmitWinCFIEndProc(Loc);
1814
1815   OS << "\t.seh_endproc";
1816   EmitEOL();
1817 }
1818
1819 // TODO: Implement
1820 void MCAsmStreamer::EmitWinCFIFuncletOrFuncEnd(SMLoc Loc) {
1821 }
1822
1823 void MCAsmStreamer::EmitWinCFIStartChained(SMLoc Loc) {
1824   MCStreamer::EmitWinCFIStartChained(Loc);
1825
1826   OS << "\t.seh_startchained";
1827   EmitEOL();
1828 }
1829
1830 void MCAsmStreamer::EmitWinCFIEndChained(SMLoc Loc) {
1831   MCStreamer::EmitWinCFIEndChained(Loc);
1832
1833   OS << "\t.seh_endchained";
1834   EmitEOL();
1835 }
1836
1837 void MCAsmStreamer::EmitWinEHHandler(const MCSymbol *Sym, bool Unwind,
1838                                      bool Except, SMLoc Loc) {
1839   MCStreamer::EmitWinEHHandler(Sym, Unwind, Except, Loc);
1840
1841   OS << "\t.seh_handler ";
1842   Sym->print(OS, MAI);
1843   if (Unwind)
1844     OS << ", @unwind";
1845   if (Except)
1846     OS << ", @except";
1847   EmitEOL();
1848 }
1849
1850 void MCAsmStreamer::EmitWinEHHandlerData(SMLoc Loc) {
1851   MCStreamer::EmitWinEHHandlerData(Loc);
1852
1853   // Switch sections. Don't call SwitchSection directly, because that will
1854   // cause the section switch to be visible in the emitted assembly.
1855   // We only do this so the section switch that terminates the handler
1856   // data block is visible.
1857   WinEH::FrameInfo *CurFrame = getCurrentWinFrameInfo();
1858
1859   // Do nothing if no frame is open. MCStreamer should've already reported an
1860   // error.
1861   if (!CurFrame)
1862     return;
1863
1864   MCSection *TextSec = &CurFrame->Function->getSection();
1865   MCSection *XData = getAssociatedXDataSection(TextSec);
1866   SwitchSectionNoChange(XData);
1867
1868   OS << "\t.seh_handlerdata";
1869   EmitEOL();
1870 }
1871
1872 void MCAsmStreamer::EmitWinCFIPushReg(MCRegister Register, SMLoc Loc) {
1873   MCStreamer::EmitWinCFIPushReg(Register, Loc);
1874
1875   OS << "\t.seh_pushreg ";
1876   InstPrinter->printRegName(OS, Register);
1877   EmitEOL();
1878 }
1879
1880 void MCAsmStreamer::EmitWinCFISetFrame(MCRegister Register, unsigned Offset,
1881                                        SMLoc Loc) {
1882   MCStreamer::EmitWinCFISetFrame(Register, Offset, Loc);
1883
1884   OS << "\t.seh_setframe ";
1885   InstPrinter->printRegName(OS, Register);
1886   OS << ", " << Offset;
1887   EmitEOL();
1888 }
1889
1890 void MCAsmStreamer::EmitWinCFIAllocStack(unsigned Size, SMLoc Loc) {
1891   MCStreamer::EmitWinCFIAllocStack(Size, Loc);
1892
1893   OS << "\t.seh_stackalloc " << Size;
1894   EmitEOL();
1895 }
1896
1897 void MCAsmStreamer::EmitWinCFISaveReg(MCRegister Register, unsigned Offset,
1898                                       SMLoc Loc) {
1899   MCStreamer::EmitWinCFISaveReg(Register, Offset, Loc);
1900
1901   OS << "\t.seh_savereg ";
1902   InstPrinter->printRegName(OS, Register);
1903   OS << ", " << Offset;
1904   EmitEOL();
1905 }
1906
1907 void MCAsmStreamer::EmitWinCFISaveXMM(MCRegister Register, unsigned Offset,
1908                                       SMLoc Loc) {
1909   MCStreamer::EmitWinCFISaveXMM(Register, Offset, Loc);
1910
1911   OS << "\t.seh_savexmm ";
1912   InstPrinter->printRegName(OS, Register);
1913   OS << ", " << Offset;
1914   EmitEOL();
1915 }
1916
1917 void MCAsmStreamer::EmitWinCFIPushFrame(bool Code, SMLoc Loc) {
1918   MCStreamer::EmitWinCFIPushFrame(Code, Loc);
1919
1920   OS << "\t.seh_pushframe";
1921   if (Code)
1922     OS << " @code";
1923   EmitEOL();
1924 }
1925
1926 void MCAsmStreamer::EmitWinCFIEndProlog(SMLoc Loc) {
1927   MCStreamer::EmitWinCFIEndProlog(Loc);
1928
1929   OS << "\t.seh_endprologue";
1930   EmitEOL();
1931 }
1932
1933 void MCAsmStreamer::emitCGProfileEntry(const MCSymbolRefExpr *From,
1934                                        const MCSymbolRefExpr *To,
1935                                        uint64_t Count) {
1936   OS << "\t.cg_profile ";
1937   From->getSymbol().print(OS, MAI);
1938   OS << ", ";
1939   To->getSymbol().print(OS, MAI);
1940   OS << ", " << Count;
1941   EmitEOL();
1942 }
1943
1944 void MCAsmStreamer::AddEncodingComment(const MCInst &Inst,
1945                                        const MCSubtargetInfo &STI) {
1946   raw_ostream &OS = GetCommentOS();
1947   SmallString<256> Code;
1948   SmallVector<MCFixup, 4> Fixups;
1949   raw_svector_ostream VecOS(Code);
1950
1951   // If we have no code emitter, don't emit code.
1952   if (!getAssembler().getEmitterPtr())
1953     return;
1954
1955   getAssembler().getEmitter().encodeInstruction(Inst, VecOS, Fixups, STI);
1956
1957   // If we are showing fixups, create symbolic markers in the encoded
1958   // representation. We do this by making a per-bit map to the fixup item index,
1959   // then trying to display it as nicely as possible.
1960   SmallVector<uint8_t, 64> FixupMap;
1961   FixupMap.resize(Code.size() * 8);
1962   for (unsigned i = 0, e = Code.size() * 8; i != e; ++i)
1963     FixupMap[i] = 0;
1964
1965   for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
1966     MCFixup &F = Fixups[i];
1967     const MCFixupKindInfo &Info =
1968         getAssembler().getBackend().getFixupKindInfo(F.getKind());
1969     for (unsigned j = 0; j != Info.TargetSize; ++j) {
1970       unsigned Index = F.getOffset() * 8 + Info.TargetOffset + j;
1971       assert(Index < Code.size() * 8 && "Invalid offset in fixup!");
1972       FixupMap[Index] = 1 + i;
1973     }
1974   }
1975
1976   // FIXME: Note the fixup comments for Thumb2 are completely bogus since the
1977   // high order halfword of a 32-bit Thumb2 instruction is emitted first.
1978   OS << "encoding: [";
1979   for (unsigned i = 0, e = Code.size(); i != e; ++i) {
1980     if (i)
1981       OS << ',';
1982
1983     // See if all bits are the same map entry.
1984     uint8_t MapEntry = FixupMap[i * 8 + 0];
1985     for (unsigned j = 1; j != 8; ++j) {
1986       if (FixupMap[i * 8 + j] == MapEntry)
1987         continue;
1988
1989       MapEntry = uint8_t(~0U);
1990       break;
1991     }
1992
1993     if (MapEntry != uint8_t(~0U)) {
1994       if (MapEntry == 0) {
1995         OS << format("0x%02x", uint8_t(Code[i]));
1996       } else {
1997         if (Code[i]) {
1998           // FIXME: Some of the 8 bits require fix up.
1999           OS << format("0x%02x", uint8_t(Code[i])) << '\''
2000              << char('A' + MapEntry - 1) << '\'';
2001         } else
2002           OS << char('A' + MapEntry - 1);
2003       }
2004     } else {
2005       // Otherwise, write out in binary.
2006       OS << "0b";
2007       for (unsigned j = 8; j--;) {
2008         unsigned Bit = (Code[i] >> j) & 1;
2009
2010         unsigned FixupBit;
2011         if (MAI->isLittleEndian())
2012           FixupBit = i * 8 + j;
2013         else
2014           FixupBit = i * 8 + (7-j);
2015
2016         if (uint8_t MapEntry = FixupMap[FixupBit]) {
2017           assert(Bit == 0 && "Encoder wrote into fixed up bit!");
2018           OS << char('A' + MapEntry - 1);
2019         } else
2020           OS << Bit;
2021       }
2022     }
2023   }
2024   OS << "]\n";
2025
2026   for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
2027     MCFixup &F = Fixups[i];
2028     const MCFixupKindInfo &Info =
2029         getAssembler().getBackend().getFixupKindInfo(F.getKind());
2030     OS << "  fixup " << char('A' + i) << " - " << "offset: " << F.getOffset()
2031        << ", value: " << *F.getValue() << ", kind: " << Info.Name << "\n";
2032   }
2033 }
2034
2035 void MCAsmStreamer::emitInstruction(const MCInst &Inst,
2036                                     const MCSubtargetInfo &STI) {
2037   assert(getCurrentSectionOnly() &&
2038          "Cannot emit contents before setting section!");
2039
2040   // Show the encoding in a comment if we have a code emitter.
2041   AddEncodingComment(Inst, STI);
2042
2043   // Show the MCInst if enabled.
2044   if (ShowInst) {
2045     Inst.dump_pretty(GetCommentOS(), InstPrinter.get(), "\n ");
2046     GetCommentOS() << "\n";
2047   }
2048
2049   if(getTargetStreamer())
2050     getTargetStreamer()->prettyPrintAsm(*InstPrinter, 0, Inst, STI, OS);
2051   else
2052     InstPrinter->printInst(&Inst, 0, "", STI, OS);
2053
2054   StringRef Comments = CommentToEmit;
2055   if (Comments.size() && Comments.back() != '\n')
2056     GetCommentOS() << "\n";
2057
2058   EmitEOL();
2059 }
2060
2061 void MCAsmStreamer::emitBundleAlignMode(unsigned AlignPow2) {
2062   OS << "\t.bundle_align_mode " << AlignPow2;
2063   EmitEOL();
2064 }
2065
2066 void MCAsmStreamer::emitBundleLock(bool AlignToEnd) {
2067   OS << "\t.bundle_lock";
2068   if (AlignToEnd)
2069     OS << " align_to_end";
2070   EmitEOL();
2071 }
2072
2073 void MCAsmStreamer::emitBundleUnlock() {
2074   OS << "\t.bundle_unlock";
2075   EmitEOL();
2076 }
2077
2078 Optional<std::pair<bool, std::string>>
2079 MCAsmStreamer::emitRelocDirective(const MCExpr &Offset, StringRef Name,
2080                                   const MCExpr *Expr, SMLoc,
2081                                   const MCSubtargetInfo &STI) {
2082   OS << "\t.reloc ";
2083   Offset.print(OS, MAI);
2084   OS << ", " << Name;
2085   if (Expr) {
2086     OS << ", ";
2087     Expr->print(OS, MAI);
2088   }
2089   EmitEOL();
2090   return None;
2091 }
2092
2093 void MCAsmStreamer::emitAddrsig() {
2094   OS << "\t.addrsig";
2095   EmitEOL();
2096 }
2097
2098 void MCAsmStreamer::emitAddrsigSym(const MCSymbol *Sym) {
2099   OS << "\t.addrsig_sym ";
2100   Sym->print(OS, MAI);
2101   EmitEOL();
2102 }
2103
2104 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
2105 /// the specified string in the output .s file.  This capability is
2106 /// indicated by the hasRawTextSupport() predicate.
2107 void MCAsmStreamer::emitRawTextImpl(StringRef String) {
2108   if (!String.empty() && String.back() == '\n')
2109     String = String.substr(0, String.size()-1);
2110   OS << String;
2111   EmitEOL();
2112 }
2113
2114 void MCAsmStreamer::finishImpl() {
2115   // If we are generating dwarf for assembly source files dump out the sections.
2116   if (getContext().getGenDwarfForAssembly())
2117     MCGenDwarfInfo::Emit(this);
2118
2119   // Emit the label for the line table, if requested - since the rest of the
2120   // line table will be defined by .loc/.file directives, and not emitted
2121   // directly, the label is the only work required here.
2122   const auto &Tables = getContext().getMCDwarfLineTables();
2123   if (!Tables.empty()) {
2124     assert(Tables.size() == 1 && "asm output only supports one line table");
2125     if (auto *Label = Tables.begin()->second.getLabel()) {
2126       SwitchSection(getContext().getObjectFileInfo()->getDwarfLineSection());
2127       emitLabel(Label);
2128     }
2129   }
2130 }
2131
2132 MCStreamer *llvm::createAsmStreamer(MCContext &Context,
2133                                     std::unique_ptr<formatted_raw_ostream> OS,
2134                                     bool isVerboseAsm, bool useDwarfDirectory,
2135                                     MCInstPrinter *IP,
2136                                     std::unique_ptr<MCCodeEmitter> &&CE,
2137                                     std::unique_ptr<MCAsmBackend> &&MAB,
2138                                     bool ShowInst) {
2139   return new MCAsmStreamer(Context, std::move(OS), isVerboseAsm,
2140                            useDwarfDirectory, IP, std::move(CE), std::move(MAB),
2141                            ShowInst);
2142 }