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