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   OwningPtr<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 << "\t.hidden\t";          break;
 279   case MCSA_IndirectSymbol: OS << "\t.indirect_symbol\t"; break;
 280   case MCSA_Internal:       OS << "\t.internal\t";        break;
 281   case MCSA_LazyReference:  OS << "\t.lazy_reference\t";  break;
 282   case MCSA_Local:          OS << "\t.local\t";           break;
 283   case MCSA_NoDeadStrip:    OS << "\t.no_dead_strip\t";   break;
 284   case MCSA_PrivateExtern:  OS << "\t.private_extern\t";  break;
 285   case MCSA_Protected:      OS << "\t.protected\t";       break;
 286   case MCSA_Reference:      OS << "\t.reference\t";       break;
 287   case MCSA_Weak:           OS << "\t.weak\t";            break;
 288   case MCSA_WeakDefinition: OS << "\t.weak_definition\t"; break;
 289       // .weak_reference
 290   case MCSA_WeakReference:  OS << MAI.getWeakRefDirective(); break;
 291   case MCSA_WeakDefAutoPrivate: OS << "\t.weak_def_can_be_hidden\t"; break;
 292   }
 293
 294   OS << *Symbol;
 295   EmitEOL();
 296 }
 297
 298 void MCAsmStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
 299   OS << ".desc" << ' ' << *Symbol << ',' << DescValue;
 300   EmitEOL();
 301 }
 302
 303 void MCAsmStreamer::BeginCOFFSymbolDef(const MCSymbol *Symbol) {
 304   OS << "\t.def\t " << *Symbol << ';';
 305   EmitEOL();
 306 }
 307
 308 void MCAsmStreamer::EmitCOFFSymbolStorageClass (int StorageClass) {
 309   OS << "\t.scl\t" << StorageClass << ';';
 310   EmitEOL();
 311 }
 312
 313 void MCAsmStreamer::EmitCOFFSymbolType (int Type) {
 314   OS << "\t.type\t" << Type << ';';
 315   EmitEOL();
 316 }
 317
 318 void MCAsmStreamer::EndCOFFSymbolDef() {
 319   OS << "\t.endef";
 320   EmitEOL();
 321 }
 322
 323 void MCAsmStreamer::EmitELFSize(MCSymbol *Symbol, const MCExpr *Value) {
 324   assert(MAI.hasDotTypeDotSizeDirective());
 325   OS << "\t.size\t" << *Symbol << ", " << *Value << '\n';
 326 }
 327
 328 void MCAsmStreamer::EmitCommonSymbol(MCSymbol *Symbol, uint64_t Size,
 329                                      unsigned ByteAlignment) {
 330   OS << "\t.comm\t" << *Symbol << ',' << Size;
 331   if (ByteAlignment != 0) {
 332     if (MAI.getCOMMDirectiveAlignmentIsInBytes())
 333       OS << ',' << ByteAlignment;
 334     else
 335       OS << ',' << Log2_32(ByteAlignment);
 336   }
 337   EmitEOL();
 338 }
 339
 340 /// EmitLocalCommonSymbol - Emit a local common (.lcomm) symbol.
 341 ///
 342 /// @param Symbol - The common symbol to emit.
 343 /// @param Size - The size of the common symbol.
 344 void MCAsmStreamer::EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size) {
 345   assert(MAI.hasLCOMMDirective() && "Doesn't have .lcomm, can't emit it!");
 346   OS << "\t.lcomm\t" << *Symbol << ',' << Size;
 347   EmitEOL();
 348 }
 349
 350 void MCAsmStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
 351                                  unsigned Size, unsigned ByteAlignment) {
 352   // Note: a .zerofill directive does not switch sections.
 353   OS << ".zerofill ";
 354
 355   // This is a mach-o specific directive.
 356   const MCSectionMachO *MOSection = ((const MCSectionMachO*)Section);
 357   OS << MOSection->getSegmentName() << "," << MOSection->getSectionName();
 358
 359   if (Symbol != NULL) {
 360     OS << ',' << *Symbol << ',' << Size;
 361     if (ByteAlignment != 0)
 362       OS << ',' << Log2_32(ByteAlignment);
 363   }
 364   EmitEOL();
 365 }
 366
 367 // .tbss sym, size, align
 368 // This depends that the symbol has already been mangled from the original,
 369 // e.g. _a.
 370 void MCAsmStreamer::EmitTBSSSymbol(const MCSection *Section, MCSymbol *Symbol,
 371                                    uint64_t Size, unsigned ByteAlignment) {
 372   assert(Symbol != NULL && "Symbol shouldn't be NULL!");
 373   // Instead of using the Section we'll just use the shortcut.
 374   // This is a mach-o specific directive and section.
 375   OS << ".tbss " << *Symbol << ", " << Size;
 376
 377   // Output align if we have it.  We default to 1 so don't bother printing
 378   // that.
 379   if (ByteAlignment > 1) OS << ", " << Log2_32(ByteAlignment);
 380
 381   EmitEOL();
 382 }
 383
 384 static inline char toOctal(int X) { return (X&7)+'0'; }
 385
 386 static void PrintQuotedString(StringRef Data, raw_ostream &OS) {
 387   OS << '"';
 388
 389   for (unsigned i = 0, e = Data.size(); i != e; ++i) {
 390     unsigned char C = Data[i];
 391     if (C == '"' || C == '\\') {
 392       OS << '\\' << (char)C;
 393       continue;
 394     }
 395
 396     if (isprint((unsigned char)C)) {
 397       OS << (char)C;
 398       continue;
 399     }
 400
 401     switch (C) {
 402       case '\b': OS << "\\b"; break;
 403       case '\f': OS << "\\f"; break;
 404       case '\n': OS << "\\n"; break;
 405       case '\r': OS << "\\r"; break;
 406       case '\t': OS << "\\t"; break;
 407       default:
 408         OS << '\\';
 409         OS << toOctal(C >> 6);
 410         OS << toOctal(C >> 3);
 411         OS << toOctal(C >> 0);
 412         break;
 413     }
 414   }
 415
 416   OS << '"';
 417 }
 418
 419
 420 void MCAsmStreamer::EmitBytes(StringRef Data, unsigned AddrSpace) {
 421   assert(CurSection && "Cannot emit contents before setting section!");
 422   if (Data.empty()) return;
 423
 424   if (Data.size() == 1) {
 425     OS << MAI.getData8bitsDirective(AddrSpace);
 426     OS << (unsigned)(unsigned char)Data[0];
 427     EmitEOL();
 428     return;
 429   }
 430
 431   // If the data ends with 0 and the target supports .asciz, use it, otherwise
 432   // use .ascii
 433   if (MAI.getAscizDirective() && Data.back() == 0) {
 434     OS << MAI.getAscizDirective();
 435     Data = Data.substr(0, Data.size()-1);
 436   } else {
 437     OS << MAI.getAsciiDirective();
 438   }
 439
 440   OS << ' ';
 441   PrintQuotedString(Data, OS);
 442   EmitEOL();
 443 }
 444
 445 /// EmitIntValue - Special case of EmitValue that avoids the client having
 446 /// to pass in a MCExpr for constant integers.
 447 void MCAsmStreamer::EmitIntValue(uint64_t Value, unsigned Size,
 448                                  unsigned AddrSpace) {
 449   assert(CurSection && "Cannot emit contents before setting section!");
 450   const char *Directive = 0;
 451   switch (Size) {
 452   default: break;
 453   case 1: Directive = MAI.getData8bitsDirective(AddrSpace); break;
 454   case 2: Directive = MAI.getData16bitsDirective(AddrSpace); break;
 455   case 4: Directive = MAI.getData32bitsDirective(AddrSpace); break;
 456   case 8:
 457     Directive = MAI.getData64bitsDirective(AddrSpace);
 458     // If the target doesn't support 64-bit data, emit as two 32-bit halves.
 459     if (Directive) break;
 460     if (isLittleEndian()) {
 461       EmitIntValue((uint32_t)(Value >> 0 ), 4, AddrSpace);
 462       EmitIntValue((uint32_t)(Value >> 32), 4, AddrSpace);
 463     } else {
 464       EmitIntValue((uint32_t)(Value >> 32), 4, AddrSpace);
 465       EmitIntValue((uint32_t)(Value >> 0 ), 4, AddrSpace);
 466     }
 467     return;
 468   }
 469
 470   assert(Directive && "Invalid size for machine code value!");
 471   OS << Directive << truncateToSize(Value, Size);
 472   EmitEOL();
 473 }
 474
 475 void MCAsmStreamer::EmitValue(const MCExpr *Value, unsigned Size,
 476                               unsigned AddrSpace) {
 477   assert(CurSection && "Cannot emit contents before setting section!");
 478   const char *Directive = 0;
 479   switch (Size) {
 480   default: break;
 481   case 1: Directive = MAI.getData8bitsDirective(AddrSpace); break;
 482   case 2: Directive = MAI.getData16bitsDirective(AddrSpace); break;
 483   case 4: Directive = MAI.getData32bitsDirective(AddrSpace); break;
 484   case 8: Directive = MAI.getData64bitsDirective(AddrSpace); break;
 485   }
 486
 487   assert(Directive && "Invalid size for machine code value!");
 488   OS << Directive << *Value;
 489   EmitEOL();
 490 }
 491
 492 void MCAsmStreamer::EmitGPRel32Value(const MCExpr *Value) {
 493   assert(MAI.getGPRel32Directive() != 0);
 494   OS << MAI.getGPRel32Directive() << *Value;
 495   EmitEOL();
 496 }
 497
 498
 499 /// EmitFill - Emit NumBytes bytes worth of the value specified by
 500 /// FillValue.  This implements directives such as '.space'.
 501 void MCAsmStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue,
 502                              unsigned AddrSpace) {
 503   if (NumBytes == 0) return;
 504
 505   if (AddrSpace == 0)
 506     if (const char *ZeroDirective = MAI.getZeroDirective()) {
 507       OS << ZeroDirective << NumBytes;
 508       if (FillValue != 0)
 509         OS << ',' << (int)FillValue;
 510       EmitEOL();
 511       return;
 512     }
 513
 514   // Emit a byte at a time.
 515   MCStreamer::EmitFill(NumBytes, FillValue, AddrSpace);
 516 }
 517
 518 void MCAsmStreamer::EmitValueToAlignment(unsigned ByteAlignment, int64_t Value,
 519                                          unsigned ValueSize,
 520                                          unsigned MaxBytesToEmit) {
 521   // Some assemblers don't support non-power of two alignments, so we always
 522   // emit alignments as a power of two if possible.
 523   if (isPowerOf2_32(ByteAlignment)) {
 524     switch (ValueSize) {
 525     default: llvm_unreachable("Invalid size for machine code value!");
 526     case 1: OS << MAI.getAlignDirective(); break;
 527     // FIXME: use MAI for this!
 528     case 2: OS << ".p2alignw "; break;
 529     case 4: OS << ".p2alignl "; break;
 530     case 8: llvm_unreachable("Unsupported alignment size!");
 531     }
 532
 533     if (MAI.getAlignmentIsInBytes())
 534       OS << ByteAlignment;
 535     else
 536       OS << Log2_32(ByteAlignment);
 537
 538     if (Value || MaxBytesToEmit) {
 539       OS << ", 0x";
 540       OS.write_hex(truncateToSize(Value, ValueSize));
 541
 542       if (MaxBytesToEmit)
 543         OS << ", " << MaxBytesToEmit;
 544     }
 545     EmitEOL();
 546     return;
 547   }
 548
 549   // Non-power of two alignment.  This is not widely supported by assemblers.
 550   // FIXME: Parameterize this based on MAI.
 551   switch (ValueSize) {
 552   default: llvm_unreachable("Invalid size for machine code value!");
 553   case 1: OS << ".balign";  break;
 554   case 2: OS << ".balignw"; break;
 555   case 4: OS << ".balignl"; break;
 556   case 8: llvm_unreachable("Unsupported alignment size!");
 557   }
 558
 559   OS << ' ' << ByteAlignment;
 560   OS << ", " << truncateToSize(Value, ValueSize);
 561   if (MaxBytesToEmit)
 562     OS << ", " << MaxBytesToEmit;
 563   EmitEOL();
 564 }
 565
 566 void MCAsmStreamer::EmitCodeAlignment(unsigned ByteAlignment,
 567                                       unsigned MaxBytesToEmit) {
 568   // Emit with a text fill value.
 569   EmitValueToAlignment(ByteAlignment, MAI.getTextAlignFillValue(),
 570                        1, MaxBytesToEmit);
 571 }
 572
 573 void MCAsmStreamer::EmitValueToOffset(const MCExpr *Offset,
 574                                       unsigned char Value) {
 575   // FIXME: Verify that Offset is associated with the current section.
 576   OS << ".org " << *Offset << ", " << (unsigned) Value;
 577   EmitEOL();
 578 }
 579
 580
 581 void MCAsmStreamer::EmitFileDirective(StringRef Filename) {
 582   assert(MAI.hasSingleParameterDotFile());
 583   OS << "\t.file\t";
 584   PrintQuotedString(Filename, OS);
 585   EmitEOL();
 586 }
 587
 588 void MCAsmStreamer::EmitDwarfFileDirective(unsigned FileNo, StringRef Filename){
 589   OS << "\t.file\t" << FileNo << ' ';
 590   PrintQuotedString(Filename, OS);
 591   EmitEOL();
 592 }
 593
 594 void MCAsmStreamer::AddEncodingComment(const MCInst &Inst) {
 595   raw_ostream &OS = GetCommentOS();
 596   SmallString<256> Code;
 597   SmallVector<MCFixup, 4> Fixups;
 598   raw_svector_ostream VecOS(Code);
 599   Emitter->EncodeInstruction(Inst, VecOS, Fixups);
 600   VecOS.flush();
 601
 602   // If we are showing fixups, create symbolic markers in the encoded
 603   // representation. We do this by making a per-bit map to the fixup item index,
 604   // then trying to display it as nicely as possible.
 605   SmallVector<uint8_t, 64> FixupMap;
 606   FixupMap.resize(Code.size() * 8);
 607   for (unsigned i = 0, e = Code.size() * 8; i != e; ++i)
 608     FixupMap[i] = 0;
 609
 610   for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
 611     MCFixup &F = Fixups[i];
 612     const MCFixupKindInfo &Info = Emitter->getFixupKindInfo(F.getKind());
 613     for (unsigned j = 0; j != Info.TargetSize; ++j) {
 614       unsigned Index = F.getOffset() * 8 + Info.TargetOffset + j;
 615       assert(Index < Code.size() * 8 && "Invalid offset in fixup!");
 616       FixupMap[Index] = 1 + i;
 617     }
 618   }
 619
 620   OS << "encoding: [";
 621   for (unsigned i = 0, e = Code.size(); i != e; ++i) {
 622     if (i)
 623       OS << ',';
 624
 625     // See if all bits are the same map entry.
 626     uint8_t MapEntry = FixupMap[i * 8 + 0];
 627     for (unsigned j = 1; j != 8; ++j) {
 628       if (FixupMap[i * 8 + j] == MapEntry)
 629         continue;
 630
 631       MapEntry = uint8_t(~0U);
 632       break;
 633     }
 634
 635     if (MapEntry != uint8_t(~0U)) {
 636       if (MapEntry == 0) {
 637         OS << format("0x%02x", uint8_t(Code[i]));
 638       } else {
 639         assert(Code[i] == 0 && "Encoder wrote into fixed up bit!");
 640         OS << char('A' + MapEntry - 1);
 641       }
 642     } else {
 643       // Otherwise, write out in binary.
 644       OS << "0b";
 645       for (unsigned j = 8; j--;) {
 646         unsigned Bit = (Code[i] >> j) & 1;
 647         if (uint8_t MapEntry = FixupMap[i * 8 + j]) {
 648           assert(Bit == 0 && "Encoder wrote into fixed up bit!");
 649           OS << char('A' + MapEntry - 1);
 650         } else
 651           OS << Bit;
 652       }
 653     }
 654   }
 655   OS << "]\n";
 656
 657   for (unsigned i = 0, e = Fixups.size(); i != e; ++i) {
 658     MCFixup &F = Fixups[i];
 659     const MCFixupKindInfo &Info = Emitter->getFixupKindInfo(F.getKind());
 660     OS << "  fixup " << char('A' + i) << " - " << "offset: " << F.getOffset()
 661        << ", value: " << *F.getValue() << ", kind: " << Info.Name << "\n";
 662   }
 663 }
 664
 665 void MCAsmStreamer::EmitInstruction(const MCInst &Inst) {
 666   assert(CurSection && "Cannot emit contents before setting section!");
 667
 668   // Show the encoding in a comment if we have a code emitter.
 669   if (Emitter)
 670     AddEncodingComment(Inst);
 671
 672   // Show the MCInst if enabled.
 673   if (ShowInst) {
 674     Inst.dump_pretty(GetCommentOS(), &MAI, InstPrinter.get(), "\n ");
 675     GetCommentOS() << "\n";
 676   }
 677
 678   // If we have an AsmPrinter, use that to print, otherwise print the MCInst.
 679   if (InstPrinter)
 680     InstPrinter->printInst(&Inst, OS);
 681   else
 682     Inst.print(OS, &MAI);
 683   EmitEOL();
 684 }
 685
 686 /// EmitRawText - If this file is backed by a assembly streamer, this dumps
 687 /// the specified string in the output .s file.  This capability is
 688 /// indicated by the hasRawTextSupport() predicate.
 689 void MCAsmStreamer::EmitRawText(StringRef String) {
 690   if (!String.empty() && String.back() == '\n')
 691     String = String.substr(0, String.size()-1);
 692   OS << String;
 693   EmitEOL();
 694 }
 695
 696 void MCAsmStreamer::Finish() {
 697 }
 698
 699 MCStreamer *llvm::createAsmStreamer(MCContext &Context,
 700                                     formatted_raw_ostream &OS,
 701                                     bool isLittleEndian,
 702                                     bool isVerboseAsm, MCInstPrinter *IP,
 703                                     MCCodeEmitter *CE, bool ShowInst) {
 704   return new MCAsmStreamer(Context, OS, isLittleEndian, isVerboseAsm,
 705                            IP, CE, ShowInst);
 706 }