lib/MC/MCAsmStreamer.cpp

   1 //===- lib/MC/MCAsmStreamer.cpp - Text Assembly Output --------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #include "llvm/MC/MCStreamer.h"
  11 #include "llvm/MC/MCAsmInfo.h"
  12 #include "llvm/MC/MCCodeEmitter.h"
  13 #include "llvm/MC/MCContext.h"
  14 #include "llvm/MC/MCExpr.h"
  15 #include "llvm/MC/MCFixupKindInfo.h"
  16 #include "llvm/MC/MCInst.h"
  17 #include "llvm/MC/MCInstPrinter.h"
  18 #include "llvm/MC/MCSectionMachO.h"
  19 #include "llvm/MC/MCSymbol.h"
  20 #include "llvm/ADT/OwningPtr.h"
  21 #include "llvm/ADT/SmallString.h"
  22 #include "llvm/ADT/Twine.h"
  23 #include "llvm/Support/ErrorHandling.h"
  24 #include "llvm/Support/MathExtras.h"
  25 #include "llvm/Support/Format.h"
  26 #include "llvm/Support/FormattedStream.h"
  27 #include "llvm/Target/TargetAsmBackend.h"
  28 #include "llvm/Target/TargetAsmInfo.h"
  29 #include "llvm/Target/TargetLoweringObjectFile.h"
  30 #include <cctype>
  31 using namespace llvm;
  32
  33 namespace {
  34
  35 class MCAsmStreamer : public MCStreamer {
  36   formatted_raw_ostream &OS;
  37   const MCAsmInfo &MAI;
  38   OwningPtr<MCInstPrinter> InstPrinter;
  39   OwningPtr<MCCodeEmitter> Emitter;
  40   OwningPtr<TargetAsmBackend> AsmBackend;
  41
  42   SmallString<128> CommentToEmit;
  43   raw_svector_ostream CommentStream;
  44
  45   unsigned IsVerboseAsm : 1;
  46   unsigned ShowInst : 1;
  47   unsigned UseLoc : 1;
  48   unsigned UseCFI : 1;
  49
  50   enum EHSymbolFlags { EHGlobal         = 1,
  51                        EHWeakDefinition = 1 << 1,
  52                        EHPrivateExtern  = 1 << 2 };
  53   DenseMap<const MCSymbol*, unsigned> FlagMap;
  54
  55   bool needsSet(const MCExpr *Value);
  56
  57 public:
  58   MCAsmStreamer(MCContext &Context, formatted_raw_ostream &os,
  59                 bool isVerboseAsm, bool useLoc, bool useCFI,
  60                 MCInstPrinter *printer, MCCodeEmitter *emitter,
  61                 TargetAsmBackend *asmbackend,
  62                 bool showInst)
  63     : MCStreamer(Context), OS(os), MAI(Context.getAsmInfo()),
  64       InstPrinter(printer), Emitter(emitter), AsmBackend(asmbackend),
  65       CommentStream(CommentToEmit), IsVerboseAsm(isVerboseAsm),
  66       ShowInst(showInst), UseLoc(useLoc), UseCFI(useCFI) {
  67     if (InstPrinter && IsVerboseAsm)
  68       InstPrinter->setCommentStream(CommentStream);
  69   }
  70   ~MCAsmStreamer() {}
  71
  72   inline void EmitEOL() {
  73     // If we don't have any comments, just emit a \n.
  74     if (!IsVerboseAsm) {
  75       OS << '\n';
  76       return;
  77     }
  78     EmitCommentsAndEOL();
  79   }
  80   void EmitCommentsAndEOL();
  81
  82   /// isVerboseAsm - Return true if this streamer supports verbose assembly at
  83   /// all.
  84   virtual bool isVerboseAsm() const { return IsVerboseAsm; }
  85
  86   /// hasRawTextSupport - We support EmitRawText.
  87   virtual bool hasRawTextSupport() const { return true; }
  88
  89   /// AddComment - Add a comment that can be emitted to the generated .s
  90   /// file if applicable as a QoI issue to make the output of the compiler
  91   /// more readable.  This only affects the MCAsmStreamer, and only when
  92   /// verbose assembly output is enabled.
  93   virtual void AddComment(const Twine &T);
  94
  95   /// AddEncodingComment - Add a comment showing the encoding of an instruction.
  96   virtual void AddEncodingComment(const MCInst &Inst);
  97
  98   /// GetCommentOS - Return a raw_ostream that comments can be written to.
  99   /// Unlike AddComment, you are required to terminate comments with \n if you
 100   /// use this method.
 101   virtual raw_ostream &GetCommentOS() {
 102     if (!IsVerboseAsm)
 103       return nulls();  // Discard comments unless in verbose asm mode.
 104     return CommentStream;
 105   }
 106
 107   /// AddBlankLine - Emit a blank line to a .s file to pretty it up.
 108   virtual void AddBlankLine() {
 109     EmitEOL();
 110   }
 111
 112   /// @name MCStreamer Interface
 113   /// @{
 114
 115   virtual void ChangeSection(const MCSection *Section);
 116
 117   virtual void InitSections() {
 118     // FIXME, this is MachO specific, but the testsuite
 119     // expects this.
 120     SwitchSection(getContext().getMachOSection("__TEXT", "__text",
 121                          MCSectionMachO::S_ATTR_PURE_INSTRUCTIONS,
 122                          0, SectionKind::getText()));
 123   }
 124
 125   virtual void EmitLabel(MCSymbol *Symbol);
 126   virtual void EmitEHSymAttributes(const MCSymbol *Symbol,
 127                                    MCSymbol *EHSymbol);
 128   virtual void EmitAssemblerFlag(MCAssemblerFlag Flag);
 129   virtual void EmitThumbFunc(MCSymbol *Func);
 130
 131   virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value);
 132   virtual void EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol);
 133   virtual void EmitDwarfAdvanceLineAddr(int64_t LineDelta,
 134                                         const MCSymbol *LastLabel,
 135                                         const MCSymbol *Label);
 136   virtual void EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
 137                                          const MCSymbol *Label);
 138
 139   virtual void EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute);
 140
 141   virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue);
 142   virtual void BeginCOFFSymbolDef(const MCSymbol *Symbol);
 143   virtual void EmitCOFFSymbolStorageClass(int StorageClass);
 144   virtual void EmitCOFFSymbolType(int Type);
 145   virtual void EndCOFFSymbolDef();
 146   virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value);
 147   virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
 148                                 unsigned ByteAlignment);
 149
 150   /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
 151   ///
 152   /// @param Symbol - The common symbol to emit.
 153   /// @param Size - The size of the common symbol.
 154   virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size);
 155
 156   virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
 157                             unsigned Size = 0, unsigned ByteAlignment = 0);
 158
 159   virtual void EmitTBSSSymbol (const MCSection *Section, MCSymbol *Symbol,
 160                                uint64_t Size, unsigned ByteAlignment = 0);
 161
 162   virtual void EmitBytes(StringRef Data, unsigned AddrSpace);
 163
 164   virtual void EmitValueImpl(const MCExpr *Value, unsigned Size,
 165                              unsigned AddrSpace);
 166   virtual void EmitIntValue(uint64_t Value, unsigned Size,
 167                             unsigned AddrSpace = 0);
 168
 169   virtual void EmitULEB128Value(const MCExpr *Value);
 170
 171   virtual void EmitSLEB128Value(const MCExpr *Value);
 172
 173   virtual void EmitGPRel32Value(const MCExpr *Value);
 174
 175
 176   virtual void EmitFill(uint64_t NumBytes, uint8_t FillValue,
 177                         unsigned AddrSpace);
 178
 179   virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
 180                                     unsigned ValueSize = 1,
 181                                     unsigned MaxBytesToEmit = 0);
 182
 183   virtual void EmitCodeAlignment(unsigned ByteAlignment,
 184                                  unsigned MaxBytesToEmit = 0);
 185
 186   virtual void EmitValueToOffset(const MCExpr *Offset,
 187                                  unsigned char Value = 0);
 188
 189   virtual void EmitFileDirective(StringRef Filename);
 190   virtual bool EmitDwarfFileDirective(unsigned FileNo, StringRef Filename);
 191   virtual void EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
 192                                      unsigned Column, unsigned Flags,
 193                                      unsigned Isa, unsigned Discriminator,
 194                                      StringRef FileName);
 195
 196   virtual void EmitCFISections(bool EH, bool Debug);
 197   virtual void EmitCFIStartProc();
 198   virtual void EmitCFIEndProc();
 199   virtual void EmitCFIDefCfa(int64_t Register, int64_t Offset);
 200   virtual void EmitCFIDefCfaOffset(int64_t Offset);
 201   virtual void EmitCFIDefCfaRegister(int64_t Register);
 202   virtual void EmitCFIOffset(int64_t Register, int64_t Offset);
 203   virtual void EmitCFIPersonality(const MCSymbol *Sym, unsigned Encoding);
 204   virtual void EmitCFILsda(const MCSymbol *Sym, unsigned Encoding);
 205   virtual void EmitCFIRememberState();
 206   virtual void EmitCFIRestoreState();
 207   virtual void EmitCFISameValue(int64_t Register);
 208   virtual void EmitCFIRelOffset(int64_t Register, int64_t Offset);
 209   virtual void EmitCFIAdjustCfaOffset(int64_t Adjustment);
 210
 211   virtual void EmitFnStart();
 212   virtual void EmitFnEnd();
 213   virtual void EmitCantUnwind();
 214   virtual void EmitPersonality(const MCSymbol *Personality);
 215   virtual void EmitHandlerData();
 216   virtual void EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset = 0);
 217   virtual void EmitPad(int64_t Offset);
 218   virtual void EmitRegSave(const SmallVectorImpl<unsigned> &RegList, bool);
 219
 220
 221   virtual void EmitInstruction(const MCInst &Inst);
 222
 223   /// EmitRawText - If this file is backed by an assembly streamer, this dumps
 224   /// the specified string in the output .s file.  This capability is
 225   /// indicated by the hasRawTextSupport() predicate.
 226   virtual void EmitRawText(StringRef String);
 227
 228   virtual void Finish();
 229
 230   /// @}
 231 };
 232
 233 } // end anonymous namespace.
 234
 235 /// AddComment - Add a comment that can be emitted to the generated .s
 236 /// file if applicable as a QoI issue to make the output of the compiler
 237 /// more readable.  This only affects the MCAsmStreamer, and only when
 238 /// verbose assembly output is enabled.
 239 void MCAsmStreamer::AddComment(const Twine &T) {
 240   if (!IsVerboseAsm) return;
 241
 242   // Make sure that CommentStream is flushed.
 243   CommentStream.flush();
 244
 245   T.toVector(CommentToEmit);
 246   // Each comment goes on its own line.
 247   CommentToEmit.push_back('\n');
 248
 249   // Tell the comment stream that the vector changed underneath it.
 250   CommentStream.resync();
 251 }
 252
 253 void MCAsmStreamer::EmitCommentsAndEOL() {
 254   if (CommentToEmit.empty() && CommentStream.GetNumBytesInBuffer() == 0) {
 255     OS << '\n';
 256     return;
 257   }
 258
 259   CommentStream.flush();
 260   StringRef Comments = CommentToEmit.str();
 261
 262   assert(Comments.back() == '\n' &&
 263          "Comment array not newline terminated");
 264   do {
 265     // Emit a line of comments.
 266     OS.PadToColumn(MAI.getCommentColumn());
 267     size_t Position = Comments.find('\n');
 268     OS << MAI.getCommentString() << ' ' << Comments.substr(0, Position) << '\n';
 269
 270     Comments = Comments.substr(Position+1);
 271   } while (!Comments.empty());
 272
 273   CommentToEmit.clear();
 274   // Tell the comment stream that the vector changed underneath it.
 275   CommentStream.resync();
 276 }
 277
 278 static inline int64_t truncateToSize(int64_t Value, unsigned Bytes) {
 279   assert(Bytes && "Invalid size!");
 280   return Value & ((uint64_t) (int64_t) -1 >> (64 - Bytes * 8));
 281 }
 282
 283 void MCAsmStreamer::ChangeSection(const MCSection *Section) {
 284   assert(Section && "Cannot switch to a null section!");
 285   Section->PrintSwitchToSection(MAI, OS);
 286 }
 287
 288 void MCAsmStreamer::EmitEHSymAttributes(const MCSymbol *Symbol,
 289                                         MCSymbol *EHSymbol) {
 290   if (UseCFI)
 291     return;
 292
 293   unsigned Flags = FlagMap.lookup(Symbol);
 294
 295   if (Flags & EHGlobal)
 296     EmitSymbolAttribute(EHSymbol, MCSA_Global);
 297   if (Flags & EHWeakDefinition)
 298     EmitSymbolAttribute(EHSymbol, MCSA_WeakDefinition);
 299   if (Flags & EHPrivateExtern)
 300     EmitSymbolAttribute(EHSymbol, MCSA_PrivateExtern);
 301 }
 302
 303 void MCAsmStreamer::EmitLabel(MCSymbol *Symbol) {
 304   assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
 305   MCStreamer::EmitLabel(Symbol);
 306
 307   OS << *Symbol << MAI.getLabelSuffix();
 308   EmitEOL();
 309 }
 310
 311 void MCAsmStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
 312   switch (Flag) {
 313   default: assert(0 && "Invalid flag!");
 314   case MCAF_SyntaxUnified:         OS << "\t.syntax unified"; break;
 315   case MCAF_SubsectionsViaSymbols: OS << ".subsections_via_symbols"; break;
 316   case MCAF_Code16:                OS << "\t.code\t16"; break;
 317   case MCAF_Code32:                OS << "\t.code\t32"; break;
 318   }
 319   EmitEOL();
 320 }
 321
 322 void MCAsmStreamer::EmitThumbFunc(MCSymbol *Func) {
 323   // This needs to emit to a temporary string to get properly quoted
 324   // MCSymbols when they have spaces in them.
 325   OS << "\t.thumb_func";
 326   // Only Mach-O hasSubsectionsViaSymbols()
 327   if (MAI.hasSubsectionsViaSymbols())
 328     OS << '\t' << *Func;
 329   EmitEOL();
 330 }
 331
 332 void MCAsmStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
 333   OS << *Symbol << " = " << *Value;
 334   EmitEOL();
 335
 336   // FIXME: Lift context changes into super class.
 337   Symbol->setVariableValue(Value);
 338 }
 339
 340 void MCAsmStreamer::EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) {
 341   OS << ".weakref " << *Alias << ", " << *Symbol;
 342   EmitEOL();
 343 }
 344
 345 void MCAsmStreamer::EmitDwarfAdvanceLineAddr(int64_t LineDelta,
 346                                              const MCSymbol *LastLabel,
 347                                              const MCSymbol *Label) {
 348   EmitDwarfSetLineAddr(LineDelta, Label,
 349                        getContext().getTargetAsmInfo().getPointerSize());
 350 }
 351
 352 void MCAsmStreamer::EmitDwarfAdvanceFrameAddr(const MCSymbol *LastLabel,
 353                                               const MCSymbol *Label) {
 354   EmitIntValue(dwarf::DW_CFA_advance_loc4, 1);
 355   const MCExpr *AddrDelta = BuildSymbolDiff(getContext(), Label, LastLabel);
 356   AddrDelta = ForceExpAbs(this, getContext(), AddrDelta);
 357   EmitValue(AddrDelta, 4);
 358 }
 359
 360
 361 void MCAsmStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
 362                                         MCSymbolAttr Attribute) {
 363   switch (Attribute) {
 364   case MCSA_Invalid: assert(0 && "Invalid symbol attribute");
 365   case MCSA_ELF_TypeFunction:    /// .type _foo, STT_FUNC  # aka @function
 366   case MCSA_ELF_TypeIndFunction: /// .type _foo, STT_GNU_IFUNC
 367   case MCSA_ELF_TypeObject:      /// .type _foo, STT_OBJECT  # aka @object
 368   case MCSA_ELF_TypeTLS:         /// .type _foo, STT_TLS     # aka @tls_object
 369   case MCSA_ELF_TypeCommon:      /// .type _foo, STT_COMMON  # aka @common
 370   case MCSA_ELF_TypeNoType:      /// .type _foo, STT_NOTYPE  # aka @notype
 371   case MCSA_ELF_TypeGnuUniqueObject:  /// .type _foo, @gnu_unique_object
 372     assert(MAI.hasDotTypeDotSizeDirective() && "Symbol Attr not supported");
 373     OS << "\t.type\t" << *Symbol << ','
 374        << ((MAI.getCommentString()[0] != '@') ? '@' : '%');
 375     switch (Attribute) {
 376     default: assert(0 && "Unknown ELF .type");
 377     case MCSA_ELF_TypeFunction:    OS << "function"; break;
 378     case MCSA_ELF_TypeIndFunction: OS << "gnu_indirect_function"; break;
 379     case MCSA_ELF_TypeObject:      OS << "object"; break;
 380     case MCSA_ELF_TypeTLS:         OS << "tls_object"; break;
 381     case MCSA_ELF_TypeCommon:      OS << "common"; break;
 382     case MCSA_ELF_TypeNoType:      OS << "no_type"; break;
 383     case MCSA_ELF_TypeGnuUniqueObject: OS << "gnu_unique_object"; break;
 384     }
 385     EmitEOL();
 386     return;
 387   case MCSA_Global: // .globl/.global
 388     OS << MAI.getGlobalDirective();
 389     FlagMap[Symbol] |= EHGlobal;
 390     break;
 391   case MCSA_Hidden:         OS << "\t.hidden\t";          break;
 392   case MCSA_IndirectSymbol: OS << "\t.indirect_symbol\t"; break;
 393   case MCSA_Internal:       OS << "\t.internal\t";        break;
 394   case MCSA_LazyReference:  OS << "\t.lazy_reference\t";  break;
 395   case MCSA_Local:          OS << "\t.local\t";           break;
 396   case MCSA_NoDeadStrip:    OS << "\t.no_dead_strip\t";   break;
 397   case MCSA_SymbolResolver: OS << "\t.symbol_resolver\t"; break;
 398   case MCSA_PrivateExtern:
 399     OS << "\t.private_extern\t";
 400     FlagMap[Symbol] |= EHPrivateExtern;
 401     break;
 402   case MCSA_Protected:      OS << "\t.protected\t";       break;
 403   case MCSA_Reference:      OS << "\t.reference\t";       break;
 404   case MCSA_Weak:           OS << "\t.weak\t";            break;
 405   case MCSA_WeakDefinition:
 406     OS << "\t.weak_definition\t";
 407     FlagMap[Symbol] |= EHWeakDefinition;
 408     break;
 409       // .weak_reference
 410   case MCSA_WeakReference:  OS << MAI.getWeakRefDirective(); break;
 411   case MCSA_WeakDefAutoPrivate: OS << "\t.weak_def_can_be_hidden\t"; break;
 412   }
 413
 414   OS << *Symbol;
 415   EmitEOL();
 416 }
 417
 418 void MCAsmStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
 419   OS << ".desc" << ' ' << *Symbol << ',' << DescValue;
 420   EmitEOL();
 421 }
 422
 423 void MCAsmStreamer::BeginCOFFSymbolDef(const MCSymbol *Symbol) {
 424   OS << "\t.def\t " << *Symbol << ';';
 425   EmitEOL();
 426 }
 427
 428 void MCAsmStreamer::EmitCOFFSymbolStorageClass (int StorageClass) {
 429   OS << "\t.scl\t" << StorageClass << ';';
 430   EmitEOL();
 431 }
 432
 433 void MCAsmStreamer::EmitCOFFSymbolType (int Type) {
 434   OS << "\t.type\t" << Type << ';';
 435   EmitEOL();
 436 }
 437
 438 void MCAsmStreamer::EndCOFFSymbolDef() {
 439   OS << "\t.endef";
 440   EmitEOL();
 441 }
 442
 443 void MCAsmStreamer::EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
 444   assert(MAI.hasDotTypeDotSizeDirective());
 445   OS << "\t.size\t" << *Symbol << ", " << *Value << '\n';
 446 }
 447
 448 void MCAsmStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
 449                                      unsigned ByteAlignment) {
 450   OS << "\t.comm\t" << *Symbol << ',' << Size;
 451   if (ByteAlignment != 0) {
 452     if (MAI.getCOMMDirectiveAlignmentIsInBytes())
 453       OS << ',' << ByteAlignment;
 454     else
 455       OS << ',' << Log2_32(ByteAlignment);
 456   }
 457   EmitEOL();
 458 }
 459
 460 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
 461 ///
 462 /// @param Symbol - The common symbol to emit.
 463 /// @param Size - The size of the common symbol.
 464 void MCAsmStreamer::EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size) {
 465   assert(MAI.hasLCOMMDirective() && "Doesn't have .lcomm, can't emit it!");
 466   OS << "\t.lcomm\t" << *Symbol << ',' << Size;
 467   EmitEOL();
 468 }
 469
 470 void MCAsmStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
 471                                  unsigned Size, unsigned ByteAlignment) {
 472   // Note: a .zerofill directive does not switch sections.
 473   OS << ".zerofill ";
 474
 475   // This is a mach-o specific directive.
 476   const MCSectionMachO *MOSection = ((const MCSectionMachO*)Section);
 477   OS << MOSection->getSegmentName() << "," << MOSection->getSectionName();
 478
 479   if (Symbol != NULL) {
 480     OS << ',' << *Symbol << ',' << Size;
 481     if (ByteAlignment != 0)
 482       OS << ',' << Log2_32(ByteAlignment);
 483   }
 484   EmitEOL();
 485 }
 486
 487 // .tbss sym, size, align
 488 // This depends that the symbol has already been mangled from the original,
 489 // e.g. _a.
 490 void MCAsmStreamer::EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
 491                                    uint64_t Size, unsigned ByteAlignment) {
 492   assert(Symbol != NULL && "Symbol shouldn't be NULL!");
 493   // Instead of using the Section we'll just use the shortcut.
 494   // This is a mach-o specific directive and section.
 495   OS << ".tbss " << *Symbol << ", " << Size;
 496
 497   // Output align if we have it.  We default to 1 so don't bother printing
 498   // that.
 499   if (ByteAlignment > 1) OS << ", " << Log2_32(ByteAlignment);
 500
 501   EmitEOL();
 502 }
 503
 504 static inline char toOctal(int X) { return (X&7)+'0'; }
 505
 506 static void PrintQuotedString(StringRef Data, raw_ostream &OS) {
 507   OS << '"';
 508
 509   for (unsigned i = 0, e = Data.size(); i != e; ++i) {
 510     unsigned char C = Data[i];
 511     if (C == '"' || C == '\\') {
 512       OS << '\\' << (char)C;
 513       continue;
 514     }
 515
 516     if (isprint((unsigned char)C)) {
 517       OS << (char)C;
 518       continue;
 519     }
 520
 521     switch (C) {
 522       case '\b': OS << "\\b"; break;
 523       case '\f': OS << "\\f"; break;
 524       case '\n': OS << "\\n"; break;
 525       case '\r': OS << "\\r"; break;
 526       case '\t': OS << "\\t"; break;
 527       default:
 528         OS << '\\';
 529         OS << toOctal(C >> 6);
 530         OS << toOctal(C >> 3);
 531         OS << toOctal(C >> 0);
 532         break;
 533     }
 534   }
 535
 536   OS << '"';
 537 }
 538
 539
 540 void MCAsmStreamer::EmitBytes(StringRef Data, unsigned AddrSpace) {
 541   assert(getCurrentSection() && "Cannot emit contents before setting section!");
 542   if (Data.empty()) return;
 543
 544   if (Data.size() == 1) {
 545     OS << MAI.getData8bitsDirective(AddrSpace);
 546     OS << (unsigned)(unsigned char)Data[0];
 547     EmitEOL();
 548     return;
 549   }
 550
 551   // If the data ends with 0 and the target supports .asciz, use it, otherwise
 552   // use .ascii
 553   if (MAI.getAscizDirective() && Data.back() == 0) {
 554     OS << MAI.getAscizDirective();
 555     Data = Data.substr(0, Data.size()-1);
 556   } else {
 557     OS << MAI.getAsciiDirective();
 558   }
 559
 560   OS << ' ';
 561   PrintQuotedString(Data, OS);
 562   EmitEOL();
 563 }
 564
 565 void MCAsmStreamer::EmitIntValue(uint64_t Value, unsigned Size,
 566                                  unsigned AddrSpace) {
 567   EmitValue(MCConstantExpr::Create(Value, getContext()), Size, AddrSpace);
 568 }
 569
 570 void MCAsmStreamer::EmitValueImpl(const MCExpr *Value, unsigned Size,
 571                                   unsigned AddrSpace) {
 572   assert(getCurrentSection() && "Cannot emit contents before setting section!");
 573   const char *Directive = 0;
 574   switch (Size) {
 575   default: break;
 576   case 1: Directive = MAI.getData8bitsDirective(AddrSpace); break;
 577   case 2: Directive = MAI.getData16bitsDirective(AddrSpace); break;
 578   case 4: Directive = MAI.getData32bitsDirective(AddrSpace); break;
 579   case 8:
 580     Directive = MAI.getData64bitsDirective(AddrSpace);
 581     // If the target doesn't support 64-bit data, emit as two 32-bit halves.
 582     if (Directive) break;
 583     int64_t IntValue;
 584     if (!Value->EvaluateAsAbsolute(IntValue))
 585       report_fatal_error("Don't know how to emit this value.");
 586     if (getContext().getTargetAsmInfo().isLittleEndian()) {
 587       EmitIntValue((uint32_t)(IntValue >> 0 ), 4, AddrSpace);
 588       EmitIntValue((uint32_t)(IntValue >> 32), 4, AddrSpace);
 589     } else {
 590       EmitIntValue((uint32_t)(IntValue >> 32), 4, AddrSpace);
 591       EmitIntValue((uint32_t)(IntValue >> 0 ), 4, AddrSpace);
 592     }
 593     return;
 594   }
 595
 596   assert(Directive && "Invalid size for machine code value!");
 597   OS << Directive << *Value;
 598   EmitEOL();
 599 }
 600
 601 void MCAsmStreamer::EmitULEB128Value(const MCExpr *Value) {
 602   int64_t IntValue;
 603   if (Value->EvaluateAsAbsolute(IntValue)) {
 604     EmitULEB128IntValue(IntValue);
 605     return;
 606   }
 607   assert(MAI.hasLEB128() && "Cannot print a .uleb");
 608   OS << ".uleb128 " << *Value;
 609   EmitEOL();
 610 }
 611
 612 void MCAsmStreamer::EmitSLEB128Value(const MCExpr *Value) {
 613   int64_t IntValue;
 614   if (Value->EvaluateAsAbsolute(IntValue)) {
 615     EmitSLEB128IntValue(IntValue);
 616     return;
 617   }
 618   assert(MAI.hasLEB128() && "Cannot print a .sleb");
 619   OS << ".sleb128 " << *Value;
 620   EmitEOL();
 621 }
 622
 623 void MCAsmStreamer::EmitGPRel32Value(const MCExpr *Value) {
 624   assert(MAI.getGPRel32Directive() != 0);
 625   OS << MAI.getGPRel32Directive() << *Value;
 626   EmitEOL();
 627 }
 628
 629
 630 /// EmitFill - Emit NumBytes bytes worth of the value specified by
 631 /// FillValue.  This implements directives such as '.space'.
 632 void MCAsmStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue,
 633                              unsigned AddrSpace) {
 634   if (NumBytes == 0) return;
 635
 636   if (AddrSpace == 0)
 637     if (const char *ZeroDirective = MAI.getZeroDirective()) {
 638       OS << ZeroDirective << NumBytes;
 639       if (FillValue != 0)
 640         OS << ',' << (int)FillValue;
 641       EmitEOL();
 642       return;
 643     }
 644
 645   // Emit a byte at a time.
 646   MCStreamer::EmitFill(NumBytes, FillValue, AddrSpace);
 647 }
 648
 649 void MCAsmStreamer::EmitValueToAlignment(unsigned ByteAlignment, int64_t Value,
 650                                          unsigned ValueSize,
 651                                          unsigned MaxBytesToEmit) {
 652   // Some assemblers don't support non-power of two alignments, so we always
 653   // emit alignments as a power of two if possible.
 654   if (isPowerOf2_32(ByteAlignment)) {
 655     switch (ValueSize) {
 656     default: llvm_unreachable("Invalid size for machine code value!");
 657     case 1: OS << MAI.getAlignDirective(); break;
 658     // FIXME: use MAI for this!
 659     case 2: OS << ".p2alignw "; break;
 660     case 4: OS << ".p2alignl "; break;
 661     case 8: llvm_unreachable("Unsupported alignment size!");
 662     }
 663
 664     if (MAI.getAlignmentIsInBytes())
 665       OS << ByteAlignment;
 666     else
 667       OS << Log2_32(ByteAlignment);
 668
 669     if (Value || MaxBytesToEmit) {
 670       OS << ", 0x";
 671       OS.write_hex(truncateToSize(Value, ValueSize));
 672
 673       if (MaxBytesToEmit)
 674         OS << ", " << MaxBytesToEmit;
 675     }
 676     EmitEOL();
 677     return;
 678   }
 679
 680   // Non-power of two alignment.  This is not widely supported by assemblers.
 681   // FIXME: Parameterize this based on MAI.
 682   switch (ValueSize) {
 683   default: llvm_unreachable("Invalid size for machine code value!");
 684   case 1: OS << ".balign";  break;
 685   case 2: OS << ".balignw"; break;
 686   case 4: OS << ".balignl"; break;
 687   case 8: llvm_unreachable("Unsupported alignment size!");
 688   }
 689
 690   OS << ' ' << ByteAlignment;
 691   OS << ", " << truncateToSize(Value, ValueSize);
 692   if (MaxBytesToEmit)
 693     OS << ", " << MaxBytesToEmit;
 694   EmitEOL();
 695 }
 696
 697 void MCAsmStreamer::EmitCodeAlignment(unsigned ByteAlignment,
 698                                       unsigned MaxBytesToEmit) {
 699   // Emit with a text fill value.
 700   EmitValueToAlignment(ByteAlignment, MAI.getTextAlignFillValue(),
 701                        1, MaxBytesToEmit);
 702 }
 703
 704 void MCAsmStreamer::EmitValueToOffset(const MCExpr *Offset,
 705                                       unsigned char Value) {
 706   // FIXME: Verify that Offset is associated with the current section.
 707   OS << ".org " << *Offset << ", " << (unsigned) Value;
 708   EmitEOL();
 709 }
 710
 711
 712 void MCAsmStreamer::EmitFileDirective(StringRef Filename) {
 713   assert(MAI.hasSingleParameterDotFile());
 714   OS << "\t.file\t";
 715   PrintQuotedString(Filename, OS);
 716   EmitEOL();
 717 }
 718
 719 bool MCAsmStreamer::EmitDwarfFileDirective(unsigned FileNo, StringRef Filename){
 720   if (UseLoc) {
 721     OS << "\t.file\t" << FileNo << ' ';
 722     PrintQuotedString(Filename, OS);
 723     EmitEOL();
 724   }
 725   return this->MCStreamer::EmitDwarfFileDirective(FileNo, Filename);
 726 }
 727
 728 void MCAsmStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
 729                                           unsigned Column, unsigned Flags,
 730                                           unsigned Isa,
 731                                           unsigned Discriminator,
 732                                           StringRef FileName) {
 733   this->MCStreamer::EmitDwarfLocDirective(FileNo, Line, Column, Flags,
 734                                           Isa, Discriminator, FileName);
 735   if (!UseLoc)
 736     return;
 737
 738   OS << "\t.loc\t" << FileNo << " " << Line << " " << Column;
 739   if (Flags & DWARF2_FLAG_BASIC_BLOCK)
 740     OS << " basic_block";
 741   if (Flags & DWARF2_FLAG_PROLOGUE_END)
 742     OS << " prologue_end";
 743   if (Flags & DWARF2_FLAG_EPILOGUE_BEGIN)
 744     OS << " epilogue_begin";
 745
 746   unsigned OldFlags = getContext().getCurrentDwarfLoc().getFlags();
 747   if ((Flags & DWARF2_FLAG_IS_STMT) != (OldFlags & DWARF2_FLAG_IS_STMT)) {
 748     OS << " is_stmt ";
 749
 750     if (Flags & DWARF2_FLAG_IS_STMT)
 751       OS << "1";
 752     else
 753       OS << "0";
 754   }
 755
 756   if (Isa)
 757     OS << "isa " << Isa;
 758   if (Discriminator)
 759     OS << "discriminator " << Discriminator;
 760
 761   if (IsVerboseAsm) {
 762     OS.PadToColumn(MAI.getCommentColumn());
 763     OS << MAI.getCommentString() << ' ' << FileName << ':'
 764        << Line << ':' << Column;
 765   }
 766   EmitEOL();
 767 }
 768
 769 void MCAsmStreamer::EmitCFISections(bool EH, bool Debug) {
 770   MCStreamer::EmitCFISections(EH, Debug);
 771
 772   if (!UseCFI)
 773     return;
 774
 775   OS << "\t.cfi_sections ";
 776   if (EH) {
 777     OS << ".eh_frame";
 778     if (Debug)
 779       OS << ", .debug_frame";
 780   } else if (Debug) {
 781     OS << ".debug_frame";
 782   }
 783
 784   EmitEOL();
 785 }
 786
 787 void MCAsmStreamer::EmitCFIStartProc() {
 788   MCStreamer::EmitCFIStartProc();
 789
 790   if (!UseCFI)
 791     return;
 792
 793   OS << "\t.cfi_startproc";
 794   EmitEOL();
 795 }
 796
 797 void MCAsmStreamer::EmitCFIEndProc() {
 798   MCStreamer::EmitCFIEndProc();
 799
 800   if (!UseCFI)
 801     return;
 802
 803   OS << "\t.cfi_endproc";
 804   EmitEOL();
 805 }
 806
 807 void MCAsmStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
 808   MCStreamer::EmitCFIDefCfa(Register, Offset);
 809
 810   if (!UseCFI)
 811     return;
 812
 813   OS << ".cfi_def_cfa " << Register << ", " << Offset;
 814   EmitEOL();
 815 }
 816
 817 void MCAsmStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
 818   MCStreamer::EmitCFIDefCfaOffset(Offset);
 819
 820   if (!UseCFI)
 821     return;
 822
 823   OS << "\t.cfi_def_cfa_offset " << Offset;
 824   EmitEOL();
 825 }
 826
 827 void MCAsmStreamer::EmitCFIDefCfaRegister(int64_t Register) {
 828   MCStreamer::EmitCFIDefCfaRegister(Register);
 829
 830   if (!UseCFI)
 831     return;
 832
 833   OS << "\t.cfi_def_cfa_register " << Register;
 834   EmitEOL();
 835 }
 836
 837 void MCAsmStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
 838   this->MCStreamer::EmitCFIOffset(Register, Offset);
 839
 840   if (!UseCFI)
 841     return;
 842
 843   OS << "\t.cfi_offset " << Register << ", " << Offset;
 844   EmitEOL();
 845 }
 846
 847 void MCAsmStreamer::EmitCFIPersonality(const MCSymbol *Sym,
 848                                        unsigned Encoding) {
 849   MCStreamer::EmitCFIPersonality(Sym, Encoding);
 850
 851   if (!UseCFI)
 852     return;
 853
 854   OS << "\t.cfi_personality " << Encoding << ", " << *Sym;
 855   EmitEOL();
 856 }
 857
 858 void MCAsmStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
 859   MCStreamer::EmitCFILsda(Sym, Encoding);
 860
 861   if (!UseCFI)
 862     return;
 863
 864   OS << "\t.cfi_lsda " << Encoding << ", " << *Sym;
 865   EmitEOL();
 866 }
 867
 868 void MCAsmStreamer::EmitCFIRememberState() {
 869   MCStreamer::EmitCFIRememberState();
 870
 871   if (!UseCFI)
 872     return;
 873
 874   OS << "\t.cfi_remember_state";
 875   EmitEOL();
 876 }
 877
 878 void MCAsmStreamer::EmitCFIRestoreState() {
 879   MCStreamer::EmitCFIRestoreState();
 880
 881   if (!UseCFI)
 882     return;
 883
 884   OS << "\t.cfi_restore_state";
 885   EmitEOL();
 886 }
 887
 888 void MCAsmStreamer::EmitCFISameValue(int64_t Register) {
 889   MCStreamer::EmitCFISameValue(Register);
 890
 891   if (!UseCFI)
 892     return;
 893
 894   OS << "\t.cfi_same_value " << Register;
 895   EmitEOL();
 896 }
 897
 898 void MCAsmStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
 899   MCStreamer::EmitCFIRelOffset(Register, Offset);
 900
 901   if (!UseCFI)
 902     return;
 903
 904   OS << "\t.cfi_rel_offset " << Register << ", " << Offset;
 905   EmitEOL();
 906 }
 907
 908 void MCAsmStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
 909   MCStreamer::EmitCFIAdjustCfaOffset(Adjustment);
 910
 911   if (!UseCFI)
 912     return;
 913
 914   OS << "\t.cfi_adjust_cfa_offset " << Adjustment;
 915   EmitEOL();
 916 }
 917
 918 void MCAsmStreamer::AddEncodingComment(const MCInst &Inst) {
 919   raw_ostream &OS = GetCommentOS();
 920   SmallString<256> Code;
 921   SmallVector<MCFixup, 4> Fixups;
 922   raw_svector_ostream VecOS(Code);
 923   Emitter->EncodeInstruction(Inst, VecOS, Fixups);
 924   VecOS.flush();
 925
 926   // If we are showing fixups, create symbolic markers in the encoded
 927   // representation. We do this by making a per-bit map to the fixup item index,
 928   // then trying to display it as nicely as possible.
 929   SmallVector<uint8_t, 64> FixupMap;
 930   FixupMap.resize(Code.size() * 8);
 931   for (unsigned i = 0, e = Code.size() * 8; i != e; ++i)
 932     FixupMap[i] = 0;
 933
 934   for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
 935     MCFixup &F = Fixups[i];
 936     const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
 937     for (unsigned j = 0; j != Info.TargetSize; ++j) {
 938       unsigned Index = F.getOffset() * 8 + Info.TargetOffset + j;
 939       assert(Index < Code.size() * 8 && "Invalid offset in fixup!");
 940       FixupMap[Index] = 1 + i;
 941     }
 942   }
 943
 944   // FIXME: Node the fixup comments for Thumb2 are completely bogus since the
 945   // high order halfword of a 32-bit Thumb2 instruction is emitted first.
 946   OS << "encoding: [";
 947   for (unsigned i = 0, e = Code.size(); i != e; ++i) {
 948     if (i)
 949       OS << ',';
 950
 951     // See if all bits are the same map entry.
 952     uint8_t MapEntry = FixupMap[i * 8 + 0];
 953     for (unsigned j = 1; j != 8; ++j) {
 954       if (FixupMap[i * 8 + j] == MapEntry)
 955         continue;
 956
 957       MapEntry = uint8_t(~0U);
 958       break;
 959     }
 960
 961     if (MapEntry != uint8_t(~0U)) {
 962       if (MapEntry == 0) {
 963         OS << format("0x%02x", uint8_t(Code[i]));
 964       } else {
 965         if (Code[i]) {
 966           // FIXME: Some of the 8 bits require fix up.
 967           OS << format("0x%02x", uint8_t(Code[i])) << '\''
 968              << char('A' + MapEntry - 1) << '\'';
 969         } else
 970           OS << char('A' + MapEntry - 1);
 971       }
 972     } else {
 973       // Otherwise, write out in binary.
 974       OS << "0b";
 975       for (unsigned j = 8; j--;) {
 976         unsigned Bit = (Code[i] >> j) & 1;
 977
 978         unsigned FixupBit;
 979         if (getContext().getTargetAsmInfo().isLittleEndian())
 980           FixupBit = i * 8 + j;
 981         else
 982           FixupBit = i * 8 + (7-j);
 983
 984         if (uint8_t MapEntry = FixupMap[FixupBit]) {
 985           assert(Bit == 0 && "Encoder wrote into fixed up bit!");
 986           OS << char('A' + MapEntry - 1);
 987         } else
 988           OS << Bit;
 989       }
 990     }
 991   }
 992   OS << "]\n";
 993
 994   for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
 995     MCFixup &F = Fixups[i];
 996     const MCFixupKindInfo &Info = AsmBackend->getFixupKindInfo(F.getKind());
 997     OS << "  fixup " << char('A' + i) << " - " << "offset: " << F.getOffset()
 998        << ", value: " << *F.getValue() << ", kind: " << Info.Name << "\n";
 999   }
1000 }
1001
1002 void MCAsmStreamer::EmitFnStart() {
1003   OS << "\t.fnstart";
1004   EmitEOL();
1005 }
1006
1007 void MCAsmStreamer::EmitFnEnd() {
1008   OS << "\t.fnend";
1009   EmitEOL();
1010 }
1011
1012 void MCAsmStreamer::EmitCantUnwind() {
1013   OS << "\t.cantunwind";
1014   EmitEOL();
1015 }
1016
1017 void MCAsmStreamer::EmitHandlerData() {
1018   OS << "\t.handlerdata";
1019   EmitEOL();
1020 }
1021
1022 void MCAsmStreamer::EmitPersonality(const MCSymbol *Personality) {
1023   OS << "\t.personality " << Personality->getName();
1024   EmitEOL();
1025 }
1026
1027 void MCAsmStreamer::EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset) {
1028   OS << "\t.setfp\t" << InstPrinter->getRegName(FpReg)
1029      << ", "        << InstPrinter->getRegName(SpReg);
1030   if (Offset)
1031     OS << ", #" << Offset;
1032   EmitEOL();
1033 }
1034
1035 void MCAsmStreamer::EmitPad(int64_t Offset) {
1036   OS << "\t.pad\t#" << Offset;
1037   EmitEOL();
1038 }
1039
1040 void MCAsmStreamer::EmitRegSave(const SmallVectorImpl<unsigned> &RegList,
1041                                 bool isVector) {
1042   assert(RegList.size() && "RegList should not be empty");
1043   if (isVector)
1044     OS << "\t.vsave\t{";
1045   else
1046     OS << "\t.save\t{";
1047
1048   OS << InstPrinter->getRegName(RegList[0]);
1049
1050   for (unsigned i = 1, e = RegList.size(); i != e; ++i)
1051     OS << ", " << InstPrinter->getRegName(RegList[i]);
1052
1053   OS << "}";
1054   EmitEOL();
1055 }
1056
1057 void MCAsmStreamer::EmitInstruction(const MCInst &Inst) {
1058   assert(getCurrentSection() && "Cannot emit contents before setting section!");
1059
1060   // Show the encoding in a comment if we have a code emitter.
1061   if (Emitter)
1062     AddEncodingComment(Inst);
1063
1064   // Show the MCInst if enabled.
1065   if (ShowInst) {
1066     Inst.dump_pretty(GetCommentOS(), &MAI, InstPrinter.get(), "\n ");
1067     GetCommentOS() << "\n";
1068   }
1069
1070   // If we have an AsmPrinter, use that to print, otherwise print the MCInst.
1071   if (InstPrinter)
1072     InstPrinter->printInst(&Inst, OS);
1073   else
1074     Inst.print(OS, &MAI);
1075   EmitEOL();
1076 }
1077
1078 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
1079 /// the specified string in the output .s file.  This capability is
1080 /// indicated by the hasRawTextSupport() predicate.
1081 void MCAsmStreamer::EmitRawText(StringRef String) {
1082   if (!String.empty() && String.back() == '\n')
1083     String = String.substr(0, String.size()-1);
1084   OS << String;
1085   EmitEOL();
1086 }
1087
1088 void MCAsmStreamer::Finish() {
1089   // Dump out the dwarf file & directory tables and line tables.
1090   if (getContext().hasDwarfFiles() && !UseLoc)
1091     MCDwarfFileTable::Emit(this);
1092
1093   if (!UseCFI)
1094     EmitFrames(false);
1095 }
1096
1097 MCStreamer *llvm::createAsmStreamer(MCContext &Context,
1098                                     formatted_raw_ostream &OS,
1099                                     bool isVerboseAsm, bool useLoc,
1100                                     bool useCFI,
1101                                     MCInstPrinter *IP, MCCodeEmitter *CE,
1102                                     TargetAsmBackend *TAB, bool ShowInst) {
1103   return new MCAsmStreamer(Context, OS, isVerboseAsm, useLoc, useCFI,
1104                            IP, CE, TAB, ShowInst);
1105 }