lib/MC/MCAsmStreamer.cpp

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