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/MCInst.h"
  16 #include "llvm/MC/MCInstPrinter.h"
  17 #include "llvm/MC/MCSectionMachO.h"
  18 #include "llvm/MC/MCSymbol.h"
  19 #include "llvm/ADT/OwningPtr.h"
  20 #include "llvm/ADT/SmallString.h"
  21 #include "llvm/ADT/Twine.h"
  22 #include "llvm/Support/ErrorHandling.h"
  23 #include "llvm/Support/MathExtras.h"
  24 #include "llvm/Support/Format.h"
  25 #include "llvm/Support/FormattedStream.h"
  26 using namespace llvm;
  27
  28 namespace {
  29
  30 class MCAsmStreamer : public MCStreamer {
  31   formatted_raw_ostream &OS;
  32   const MCAsmInfo &MAI;
  33   OwningPtr<MCInstPrinter> InstPrinter;
  34   MCCodeEmitter *Emitter;
  35
  36   SmallString<128> CommentToEmit;
  37   raw_svector_ostream CommentStream;
  38
  39   unsigned IsLittleEndian : 1;
  40   unsigned IsVerboseAsm : 1;
  41   unsigned ShowInst : 1;
  42
  43 public:
  44   MCAsmStreamer(MCContext &Context, formatted_raw_ostream &os,
  45                 bool isLittleEndian, bool isVerboseAsm, MCInstPrinter *printer,
  46                 MCCodeEmitter *emitter, bool showInst)
  47     : MCStreamer(Context), OS(os), MAI(Context.getAsmInfo()),
  48       InstPrinter(printer), Emitter(emitter), CommentStream(CommentToEmit),
  49       IsLittleEndian(isLittleEndian), IsVerboseAsm(isVerboseAsm),
  50       ShowInst(showInst) {
  51     if (InstPrinter && IsVerboseAsm)
  52       InstPrinter->setCommentStream(CommentStream);
  53   }
  54   ~MCAsmStreamer() {}
  55
  56   bool isLittleEndian() const { return IsLittleEndian; }
  57
  58   inline void EmitEOL() {
  59     // If we don't have any comments, just emit a \n.
  60     if (!IsVerboseAsm) {
  61       OS << '\n';
  62       return;
  63     }
  64     EmitCommentsAndEOL();
  65   }
  66   void EmitCommentsAndEOL();
  67
  68   /// isVerboseAsm - Return true if this streamer supports verbose assembly at
  69   /// all.
  70   virtual bool isVerboseAsm() const { return IsVerboseAsm; }
  71
  72   /// hasRawTextSupport - We support EmitRawText.
  73   virtual bool hasRawTextSupport() const { return true; }
  74
  75   /// AddComment - Add a comment that can be emitted to the generated .s
  76   /// file if applicable as a QoI issue to make the output of the compiler
  77   /// more readable.  This only affects the MCAsmStreamer, and only when
  78   /// verbose assembly output is enabled.
  79   virtual void AddComment(const Twine &T);
  80
  81   /// AddEncodingComment - Add a comment showing the encoding of an instruction.
  82   virtual void AddEncodingComment(const MCInst &Inst);
  83
  84   /// GetCommentOS - Return a raw_ostream that comments can be written to.
  85   /// Unlike AddComment, you are required to terminate comments with \n if you
  86   /// use this method.
  87   virtual raw_ostream &GetCommentOS() {
  88     if (!IsVerboseAsm)
  89       return nulls();  // Discard comments unless in verbose asm mode.
  90     return CommentStream;
  91   }
  92
  93   /// AddBlankLine - Emit a blank line to a .s file to pretty it up.
  94   virtual void AddBlankLine() {
  95     EmitEOL();
  96   }
  97
  98   /// @name MCStreamer Interface
  99   /// @{
 100
 101   virtual void SwitchSection(const MCSection *Section);
 102
 103   virtual void EmitLabel(MCSymbol *Symbol);
 104
 105   virtual void EmitAssemblerFlag(MCAssemblerFlag Flag);
 106
 107   virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value);
 108
 109   virtual void EmitSymbolAttribute(MCSymbol *Symbol, MCSymbolAttr Attribute);
 110
 111   virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue);
 112   virtual void BeginCOFFSymbolDef(const MCSymbol *Symbol);
 113   virtual void EmitCOFFSymbolStorageClass(int StorageClass);
 114   virtual void EmitCOFFSymbolType(int Type);
 115   virtual void EndCOFFSymbolDef();
 116   virtual void EmitELFSize(MCSymbol *Symbol, const MCExpr *Value);
 117   virtual void EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
 118                                 unsigned ByteAlignment);
 119
 120   /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
 121   ///
 122   /// @param Symbol - The common symbol to emit.
 123   /// @param Size - The size of the common symbol.
 124   virtual void EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size);
 125
 126   virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
 127                             unsigned Size = 0, unsigned ByteAlignment = 0);
 128
 129   virtual void EmitTBSSSymbol (const MCSection *Section, MCSymbol *Symbol,
 130                                uint64_t Size, unsigned ByteAlignment = 0);
 131
 132   virtual void EmitBytes(StringRef Data, unsigned AddrSpace);
 133
 134   virtual void EmitValue(const MCExpr *Value, unsigned Size,unsigned AddrSpace);
 135   virtual void EmitIntValue(uint64_t Value, unsigned Size, unsigned AddrSpace);
 136   virtual void EmitGPRel32Value(const MCExpr *Value);
 137
 138
 139   virtual void EmitFill(uint64_t NumBytes, uint8_t FillValue,
 140                         unsigned AddrSpace);
 141
 142   virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
 143                                     unsigned ValueSize = 1,
 144                                     unsigned MaxBytesToEmit = 0);
 145
 146   virtual void EmitCodeAlignment(unsigned ByteAlignment,
 147                                  unsigned MaxBytesToEmit = 0);
 148
 149   virtual void EmitValueToOffset(const MCExpr *Offset,
 150                                  unsigned char Value = 0);
 151
 152   virtual void EmitFileDirective(StringRef Filename);
 153   virtual void EmitDwarfFileDirective(unsigned FileNo, StringRef Filename);
 154
 155   virtual void EmitInstruction(const MCInst &Inst);
 156
 157   /// EmitRawText - If this file is backed by a assembly streamer, this dumps
 158   /// the specified string in the output .s file.  This capability is
 159   /// indicated by the hasRawTextSupport() predicate.
 160   virtual void EmitRawText(StringRef String);
 161
 162   virtual void Finish();
 163
 164   /// @}
 165 };
 166
 167 } // end anonymous namespace.
 168
 169 /// AddComment - Add a comment that can be emitted to the generated .s
 170 /// file if applicable as a QoI issue to make the output of the compiler
 171 /// more readable.  This only affects the MCAsmStreamer, and only when
 172 /// verbose assembly output is enabled.
 173 void MCAsmStreamer::AddComment(const Twine &T) {
 174   if (!IsVerboseAsm) return;
 175
 176   // Make sure that CommentStream is flushed.
 177   CommentStream.flush();
 178
 179   T.toVector(CommentToEmit);
 180   // Each comment goes on its own line.
 181   CommentToEmit.push_back('\n');
 182
 183   // Tell the comment stream that the vector changed underneath it.
 184   CommentStream.resync();
 185 }
 186
 187 void MCAsmStreamer::EmitCommentsAndEOL() {
 188   if (CommentToEmit.empty() && CommentStream.GetNumBytesInBuffer() == 0) {
 189     OS << '\n';
 190     return;
 191   }
 192
 193   CommentStream.flush();
 194   StringRef Comments = CommentToEmit.str();
 195
 196   assert(Comments.back() == '\n' &&
 197          "Comment array not newline terminated");
 198   do {
 199     // Emit a line of comments.
 200     OS.PadToColumn(MAI.getCommentColumn());
 201     size_t Position = Comments.find('\n');
 202     OS << MAI.getCommentString() << ' ' << Comments.substr(0, Position) << '\n';
 203
 204     Comments = Comments.substr(Position+1);
 205   } while (!Comments.empty());
 206
 207   CommentToEmit.clear();
 208   // Tell the comment stream that the vector changed underneath it.
 209   CommentStream.resync();
 210 }
 211
 212 static inline int64_t truncateToSize(int64_t Value, unsigned Bytes) {
 213   assert(Bytes && "Invalid size!");
 214   return Value & ((uint64_t) (int64_t) -1 >> (64 - Bytes * 8));
 215 }
 216
 217 void MCAsmStreamer::SwitchSection(const MCSection *Section) {
 218   assert(Section && "Cannot switch to a null section!");
 219   if (Section != CurSection) {
 220     CurSection = Section;
 221     Section->PrintSwitchToSection(MAI, OS);
 222   }
 223 }
 224
 225 void MCAsmStreamer::EmitLabel(MCSymbol *Symbol) {
 226   assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
 227   assert(!Symbol->isVariable() && "Cannot emit a variable symbol!");
 228   assert(CurSection && "Cannot emit before setting section!");
 229
 230   OS << *Symbol << ":";
 231   EmitEOL();
 232   Symbol->setSection(*CurSection);
 233 }
 234
 235 void MCAsmStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {
 236   switch (Flag) {
 237   default: assert(0 && "Invalid flag!");
 238   case MCAF_SubsectionsViaSymbols: OS << ".subsections_via_symbols"; break;
 239   }
 240   EmitEOL();
 241 }
 242
 243 void MCAsmStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
 244   OS << *Symbol << " = " << *Value;
 245   EmitEOL();
 246
 247   // FIXME: Lift context changes into super class.
 248   Symbol->setVariableValue(Value);
 249 }
 250
 251 void MCAsmStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
 252                                         MCSymbolAttr Attribute) {
 253   switch (Attribute) {
 254   case MCSA_Invalid: assert(0 && "Invalid symbol attribute");
 255   case MCSA_ELF_TypeFunction:    /// .type _foo, STT_FUNC  # aka @function
 256   case MCSA_ELF_TypeIndFunction: /// .type _foo, STT_GNU_IFUNC
 257   case MCSA_ELF_TypeObject:      /// .type _foo, STT_OBJECT  # aka @object
 258   case MCSA_ELF_TypeTLS:         /// .type _foo, STT_TLS     # aka @tls_object
 259   case MCSA_ELF_TypeCommon:      /// .type _foo, STT_COMMON  # aka @common
 260   case MCSA_ELF_TypeNoType:      /// .type _foo, STT_NOTYPE  # aka @notype
 261     assert(MAI.hasDotTypeDotSizeDirective() && "Symbol Attr not supported");
 262     OS << "\t.type\t" << *Symbol << ','
 263        << ((MAI.getCommentString()[0] != '@') ? '@' : '%');
 264     switch (Attribute) {
 265     default: assert(0 && "Unknown ELF .type");
 266     case MCSA_ELF_TypeFunction:    OS << "function"; break;
 267     case MCSA_ELF_TypeIndFunction: OS << "gnu_indirect_function"; break;
 268     case MCSA_ELF_TypeObject:      OS << "object"; break;
 269     case MCSA_ELF_TypeTLS:         OS << "tls_object"; break;
 270     case MCSA_ELF_TypeCommon:      OS << "common"; break;
 271     case MCSA_ELF_TypeNoType:      OS << "no_type"; break;
 272     }
 273     EmitEOL();
 274     return;
 275   case MCSA_Global: // .globl/.global
 276     OS << MAI.getGlobalDirective();
 277     break;
 278   case MCSA_Hidden:         OS << ".hidden ";          break;
 279   case MCSA_IndirectSymbol: OS << ".indirect_symbol "; break;
 280   case MCSA_Internal:       OS << ".internal ";        break;
 281   case MCSA_LazyReference:  OS << ".lazy_reference ";  break;
 282   case MCSA_Local:          OS << ".local ";           break;
 283   case MCSA_NoDeadStrip:    OS << ".no_dead_strip ";   break;
 284   case MCSA_PrivateExtern:  OS << ".private_extern ";  break;
 285   case MCSA_Protected:      OS << ".protected ";       break;
 286   case MCSA_Reference:      OS << ".reference ";       break;
 287   case MCSA_Weak:           OS << ".weak ";            break;
 288   case MCSA_WeakDefinition: OS << ".weak_definition "; break;
 289       // .weak_reference
 290   case MCSA_WeakReference:  OS << MAI.getWeakRefDirective(); break;
 291   }
 292
 293   OS << *Symbol;
 294   EmitEOL();
 295 }
 296
 297 void MCAsmStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
 298   OS << ".desc" << ' ' << *Symbol << ',' << DescValue;
 299   EmitEOL();
 300 }
 301
 302 void MCAsmStreamer::BeginCOFFSymbolDef(const MCSymbol *Symbol) {
 303   OS << "\t.def\t " << *Symbol << ';';
 304   EmitEOL();
 305 }
 306
 307 void MCAsmStreamer::EmitCOFFSymbolStorageClass (int StorageClass) {
 308   OS << "\t.scl\t" << StorageClass << ';';
 309   EmitEOL();
 310 }
 311
 312 void MCAsmStreamer::EmitCOFFSymbolType (int Type) {
 313   OS << "\t.type\t" << Type << ';';
 314   EmitEOL();
 315 }
 316
 317 void MCAsmStreamer::EndCOFFSymbolDef() {
 318   OS << "\t.endef";
 319   EmitEOL();
 320 }
 321
 322 void MCAsmStreamer::EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
 323   assert(MAI.hasDotTypeDotSizeDirective());
 324   OS << "\t.size\t" << *Symbol << ", " << *Value << '\n';
 325 }
 326
 327 void MCAsmStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
 328                                      unsigned ByteAlignment) {
 329   OS << "\t.comm\t" << *Symbol << ',' << Size;
 330   if (ByteAlignment != 0) {
 331     if (MAI.getCOMMDirectiveAlignmentIsInBytes())
 332       OS << ',' << ByteAlignment;
 333     else
 334       OS << ',' << Log2_32(ByteAlignment);
 335   }
 336   EmitEOL();
 337 }
 338
 339 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
 340 ///
 341 /// @param Symbol - The common symbol to emit.
 342 /// @param Size - The size of the common symbol.
 343 void MCAsmStreamer::EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size) {
 344   assert(MAI.hasLCOMMDirective() && "Doesn't have .lcomm, can't emit it!");
 345   OS << "\t.lcomm\t" << *Symbol << ',' << Size;
 346   EmitEOL();
 347 }
 348
 349 void MCAsmStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
 350                                  unsigned Size, unsigned ByteAlignment) {
 351   // Note: a .zerofill directive does not switch sections.
 352   OS << ".zerofill ";
 353
 354   // This is a mach-o specific directive.
 355   const MCSectionMachO *MOSection = ((const MCSectionMachO*)Section);
 356   OS << MOSection->getSegmentName() << "," << MOSection->getSectionName();
 357
 358   if (Symbol != NULL) {
 359     OS << ',' << *Symbol << ',' << Size;
 360     if (ByteAlignment != 0)
 361       OS << ',' << Log2_32(ByteAlignment);
 362   }
 363   EmitEOL();
 364 }
 365
 366 // .tbss sym, size, align
 367 // This depends that the symbol has already been mangled from the original,
 368 // e.g. _a.
 369 void MCAsmStreamer::EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
 370                                    uint64_t Size, unsigned ByteAlignment) {
 371   assert(Symbol != NULL && "Symbol shouldn't be NULL!");
 372   // Instead of using the Section we'll just use the shortcut.
 373   // This is a mach-o specific directive and section.
 374   OS << ".tbss " << *Symbol << ", " << Size;
 375
 376   // Output align if we have it.  We default to 1 so don't bother printing
 377   // that.
 378   if (ByteAlignment > 1) OS << ", " << Log2_32(ByteAlignment);
 379
 380   EmitEOL();
 381 }
 382
 383 static inline char toOctal(int X) { return (X&7)+'0'; }
 384
 385 static void PrintQuotedString(StringRef Data, raw_ostream &OS) {
 386   OS << '"';
 387
 388   for (unsigned i = 0, e = Data.size(); i != e; ++i) {
 389     unsigned char C = Data[i];
 390     if (C == '"' || C == '\\') {
 391       OS << '\\' << (char)C;
 392       continue;
 393     }
 394
 395     if (isprint((unsigned char)C)) {
 396       OS << (char)C;
 397       continue;
 398     }
 399
 400     switch (C) {
 401       case '\b': OS << "\\b"; break;
 402       case '\f': OS << "\\f"; break;
 403       case '\n': OS << "\\n"; break;
 404       case '\r': OS << "\\r"; break;
 405       case '\t': OS << "\\t"; break;
 406       default:
 407         OS << '\\';
 408         OS << toOctal(C >> 6);
 409         OS << toOctal(C >> 3);
 410         OS << toOctal(C >> 0);
 411         break;
 412     }
 413   }
 414
 415   OS << '"';
 416 }
 417
 418
 419 void MCAsmStreamer::EmitBytes(StringRef Data, unsigned AddrSpace) {
 420   assert(CurSection && "Cannot emit contents before setting section!");
 421   if (Data.empty()) return;
 422
 423   if (Data.size() == 1) {
 424     OS << MAI.getData8bitsDirective(AddrSpace);
 425     OS << (unsigned)(unsigned char)Data[0];
 426     EmitEOL();
 427     return;
 428   }
 429
 430   // If the data ends with 0 and the target supports .asciz, use it, otherwise
 431   // use .ascii
 432   if (MAI.getAscizDirective() && Data.back() == 0) {
 433     OS << MAI.getAscizDirective();
 434     Data = Data.substr(0, Data.size()-1);
 435   } else {
 436     OS << MAI.getAsciiDirective();
 437   }
 438
 439   OS << ' ';
 440   PrintQuotedString(Data, OS);
 441   EmitEOL();
 442 }
 443
 444 /// EmitIntValue - Special case of EmitValue that avoids the client having
 445 /// to pass in a MCExpr for constant integers.
 446 void MCAsmStreamer::EmitIntValue(uint64_t Value, unsigned Size,
 447                                  unsigned AddrSpace) {
 448   assert(CurSection && "Cannot emit contents before setting section!");
 449   const char *Directive = 0;
 450   switch (Size) {
 451   default: break;
 452   case 1: Directive = MAI.getData8bitsDirective(AddrSpace); break;
 453   case 2: Directive = MAI.getData16bitsDirective(AddrSpace); break;
 454   case 4: Directive = MAI.getData32bitsDirective(AddrSpace); break;
 455   case 8:
 456     Directive = MAI.getData64bitsDirective(AddrSpace);
 457     // If the target doesn't support 64-bit data, emit as two 32-bit halves.
 458     if (Directive) break;
 459     if (isLittleEndian()) {
 460       EmitIntValue((uint32_t)(Value >> 0 ), 4, AddrSpace);
 461       EmitIntValue((uint32_t)(Value >> 32), 4, AddrSpace);
 462     } else {
 463       EmitIntValue((uint32_t)(Value >> 32), 4, AddrSpace);
 464       EmitIntValue((uint32_t)(Value >> 0 ), 4, AddrSpace);
 465     }
 466     return;
 467   }
 468
 469   assert(Directive && "Invalid size for machine code value!");
 470   OS << Directive << truncateToSize(Value, Size);
 471   EmitEOL();
 472 }
 473
 474 void MCAsmStreamer::EmitValue(const MCExpr *Value, unsigned Size,
 475                               unsigned AddrSpace) {
 476   assert(CurSection && "Cannot emit contents before setting section!");
 477   const char *Directive = 0;
 478   switch (Size) {
 479   default: break;
 480   case 1: Directive = MAI.getData8bitsDirective(AddrSpace); break;
 481   case 2: Directive = MAI.getData16bitsDirective(AddrSpace); break;
 482   case 4: Directive = MAI.getData32bitsDirective(AddrSpace); break;
 483   case 8: Directive = MAI.getData64bitsDirective(AddrSpace); break;
 484   }
 485
 486   assert(Directive && "Invalid size for machine code value!");
 487   OS << Directive << *Value;
 488   EmitEOL();
 489 }
 490
 491 void MCAsmStreamer::EmitGPRel32Value(const MCExpr *Value) {
 492   assert(MAI.getGPRel32Directive() != 0);
 493   OS << MAI.getGPRel32Directive() << *Value;
 494   EmitEOL();
 495 }
 496
 497
 498 /// EmitFill - Emit NumBytes bytes worth of the value specified by
 499 /// FillValue.  This implements directives such as '.space'.
 500 void MCAsmStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue,
 501                              unsigned AddrSpace) {
 502   if (NumBytes == 0) return;
 503
 504   if (AddrSpace == 0)
 505     if (const char *ZeroDirective = MAI.getZeroDirective()) {
 506       OS << ZeroDirective << NumBytes;
 507       if (FillValue != 0)
 508         OS << ',' << (int)FillValue;
 509       EmitEOL();
 510       return;
 511     }
 512
 513   // Emit a byte at a time.
 514   MCStreamer::EmitFill(NumBytes, FillValue, AddrSpace);
 515 }
 516
 517 void MCAsmStreamer::EmitValueToAlignment(unsigned ByteAlignment, int64_t Value,
 518                                          unsigned ValueSize,
 519                                          unsigned MaxBytesToEmit) {
 520   // Some assemblers don't support non-power of two alignments, so we always
 521   // emit alignments as a power of two if possible.
 522   if (isPowerOf2_32(ByteAlignment)) {
 523     switch (ValueSize) {
 524     default: llvm_unreachable("Invalid size for machine code value!");
 525     case 1: OS << MAI.getAlignDirective(); break;
 526     // FIXME: use MAI for this!
 527     case 2: OS << ".p2alignw "; break;
 528     case 4: OS << ".p2alignl "; break;
 529     case 8: llvm_unreachable("Unsupported alignment size!");
 530     }
 531
 532     if (MAI.getAlignmentIsInBytes())
 533       OS << ByteAlignment;
 534     else
 535       OS << Log2_32(ByteAlignment);
 536
 537     if (Value || MaxBytesToEmit) {
 538       OS << ", 0x";
 539       OS.write_hex(truncateToSize(Value, ValueSize));
 540
 541       if (MaxBytesToEmit)
 542         OS << ", " << MaxBytesToEmit;
 543     }
 544     EmitEOL();
 545     return;
 546   }
 547
 548   // Non-power of two alignment.  This is not widely supported by assemblers.
 549   // FIXME: Parameterize this based on MAI.
 550   switch (ValueSize) {
 551   default: llvm_unreachable("Invalid size for machine code value!");
 552   case 1: OS << ".balign";  break;
 553   case 2: OS << ".balignw"; break;
 554   case 4: OS << ".balignl"; break;
 555   case 8: llvm_unreachable("Unsupported alignment size!");
 556   }
 557
 558   OS << ' ' << ByteAlignment;
 559   OS << ", " << truncateToSize(Value, ValueSize);
 560   if (MaxBytesToEmit)
 561     OS << ", " << MaxBytesToEmit;
 562   EmitEOL();
 563 }
 564
 565 void MCAsmStreamer::EmitCodeAlignment(unsigned ByteAlignment,
 566                                       unsigned MaxBytesToEmit) {
 567   // Emit with a text fill value.
 568   EmitValueToAlignment(ByteAlignment, MAI.getTextAlignFillValue(),
 569                        1, MaxBytesToEmit);
 570 }
 571
 572 void MCAsmStreamer::EmitValueToOffset(const MCExpr *Offset,
 573                                       unsigned char Value) {
 574   // FIXME: Verify that Offset is associated with the current section.
 575   OS << ".org " << *Offset << ", " << (unsigned) Value;
 576   EmitEOL();
 577 }
 578
 579
 580 void MCAsmStreamer::EmitFileDirective(StringRef Filename) {
 581   assert(MAI.hasSingleParameterDotFile());
 582   OS << "\t.file\t";
 583   PrintQuotedString(Filename, OS);
 584   EmitEOL();
 585 }
 586
 587 void MCAsmStreamer::EmitDwarfFileDirective(unsigned FileNo, StringRef Filename){
 588   OS << "\t.file\t" << FileNo << ' ';
 589   PrintQuotedString(Filename, OS);
 590   EmitEOL();
 591 }
 592
 593 void MCAsmStreamer::AddEncodingComment(const MCInst &Inst) {
 594   raw_ostream &OS = GetCommentOS();
 595   SmallString<256> Code;
 596   SmallVector<MCFixup, 4> Fixups;
 597   raw_svector_ostream VecOS(Code);
 598   Emitter->EncodeInstruction(Inst, VecOS, Fixups);
 599   VecOS.flush();
 600
 601   // If we are showing fixups, create symbolic markers in the encoded
 602   // representation. We do this by making a per-bit map to the fixup item index,
 603   // then trying to display it as nicely as possible.
 604   SmallVector<uint8_t, 64> FixupMap;
 605   FixupMap.resize(Code.size() * 8);
 606   for (unsigned i = 0, e = Code.size() * 8; i != e; ++i)
 607     FixupMap[i] = 0;
 608
 609   for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
 610     MCFixup &F = Fixups[i];
 611     const MCFixupKindInfo &Info = Emitter->getFixupKindInfo(F.getKind());
 612     for (unsigned j = 0; j != Info.TargetSize; ++j) {
 613       unsigned Index = F.getOffset() * 8 + Info.TargetOffset + j;
 614       assert(Index < Code.size() * 8 && "Invalid offset in fixup!");
 615       FixupMap[Index] = 1 + i;
 616     }
 617   }
 618
 619   OS << "encoding: [";
 620   for (unsigned i = 0, e = Code.size(); i != e; ++i) {
 621     if (i)
 622       OS << ',';
 623
 624     // See if all bits are the same map entry.
 625     uint8_t MapEntry = FixupMap[i * 8 + 0];
 626     for (unsigned j = 1; j != 8; ++j) {
 627       if (FixupMap[i * 8 + j] == MapEntry)
 628         continue;
 629
 630       MapEntry = uint8_t(~0U);
 631       break;
 632     }
 633
 634     if (MapEntry != uint8_t(~0U)) {
 635       if (MapEntry == 0) {
 636         OS << format("0x%02x", uint8_t(Code[i]));
 637       } else {
 638         assert(Code[i] == 0 && "Encoder wrote into fixed up bit!");
 639         OS << char('A' + MapEntry - 1);
 640       }
 641     } else {
 642       // Otherwise, write out in binary.
 643       OS << "0b";
 644       for (unsigned j = 8; j--;) {
 645         unsigned Bit = (Code[i] >> j) & 1;
 646         if (uint8_t MapEntry = FixupMap[i * 8 + j]) {
 647           assert(Bit == 0 && "Encoder wrote into fixed up bit!");
 648           OS << char('A' + MapEntry - 1);
 649         } else
 650           OS << Bit;
 651       }
 652     }
 653   }
 654   OS << "]\n";
 655
 656   for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
 657     MCFixup &F = Fixups[i];
 658     const MCFixupKindInfo &Info = Emitter->getFixupKindInfo(F.getKind());
 659     OS << "  fixup " << char('A' + i) << " - " << "offset: " << F.getOffset()
 660        << ", value: " << *F.getValue() << ", kind: " << Info.Name << "\n";
 661   }
 662 }
 663
 664 void MCAsmStreamer::EmitInstruction(const MCInst &Inst) {
 665   assert(CurSection && "Cannot emit contents before setting section!");
 666
 667   // Show the encoding in a comment if we have a code emitter.
 668   if (Emitter)
 669     AddEncodingComment(Inst);
 670
 671   // Show the MCInst if enabled.
 672   if (ShowInst) {
 673     Inst.dump_pretty(GetCommentOS(), &MAI, InstPrinter.get(), "\n ");
 674     GetCommentOS() << "\n";
 675   }
 676
 677   // If we have an AsmPrinter, use that to print, otherwise print the MCInst.
 678   if (InstPrinter)
 679     InstPrinter->printInst(&Inst, OS);
 680   else
 681     Inst.print(OS, &MAI);
 682   EmitEOL();
 683 }
 684
 685 /// EmitRawText - If this file is backed by a assembly streamer, this dumps
 686 /// the specified string in the output .s file.  This capability is
 687 /// indicated by the hasRawTextSupport() predicate.
 688 void MCAsmStreamer::EmitRawText(StringRef String) {
 689   if (!String.empty() && String.back() == '\n')
 690     String = String.substr(0, String.size()-1);
 691   OS << String;
 692   EmitEOL();
 693 }
 694
 695 void MCAsmStreamer::Finish() {
 696 }
 697
 698 MCStreamer *llvm::createAsmStreamer(MCContext &Context,
 699                                     formatted_raw_ostream &OS,
 700                                     bool isLittleEndian,
 701                                     bool isVerboseAsm, MCInstPrinter *IP,
 702                                     MCCodeEmitter *CE, bool ShowInst) {
 703   return new MCAsmStreamer(Context, OS, isLittleEndian, isVerboseAsm,
 704                            IP, CE, ShowInst);
 705 }