lib/MC/MCAsmStreamer.cpp

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