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