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/ADT/SmallString.h"
  12 #include "llvm/MC/MCAsmInfo.h"
  13 #include "llvm/MC/MCCodeEmitter.h"
  14 #include "llvm/MC/MCContext.h"
  15 #include "llvm/MC/MCExpr.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/Support/ErrorHandling.h"
  21 #include "llvm/Support/MathExtras.h"
  22 #include "llvm/Support/Format.h"
  23 #include "llvm/Support/raw_ostream.h"
  24 using namespace llvm;
  25
  26 namespace {
  27
  28 class MCAsmStreamer : public MCStreamer {
  29   raw_ostream &OS;
  30   const MCAsmInfo &MAI;
  31   MCInstPrinter *InstPrinter;
  32   MCCodeEmitter *Emitter;
  33 public:
  34   MCAsmStreamer(MCContext &Context, raw_ostream &_OS, const MCAsmInfo &tai,
  35                 MCInstPrinter *_Printer, MCCodeEmitter *_Emitter)
  36     : MCStreamer(Context), OS(_OS), MAI(tai), InstPrinter(_Printer),
  37       Emitter(_Emitter) {}
  38   ~MCAsmStreamer() {}
  39
  40   /// @name MCStreamer Interface
  41   /// @{
  42
  43   virtual void SwitchSection(const MCSection *Section);
  44
  45   virtual void EmitLabel(MCSymbol *Symbol);
  46
  47   virtual void EmitAssemblerFlag(AssemblerFlag Flag);
  48
  49   virtual void EmitAssignment(MCSymbol *Symbol, const MCExpr *Value);
  50
  51   virtual void EmitSymbolAttribute(MCSymbol *Symbol, SymbolAttr Attribute);
  52
  53   virtual void EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue);
  54
  55   virtual void EmitCommonSymbol(MCSymbol *Symbol, unsigned Size,
  56                                 unsigned ByteAlignment);
  57
  58   virtual void EmitZerofill(const MCSection *Section, MCSymbol *Symbol = 0,
  59                             unsigned Size = 0, unsigned ByteAlignment = 0);
  60
  61   virtual void EmitBytes(StringRef Data);
  62
  63   virtual void EmitValue(const MCExpr *Value, unsigned Size);
  64
  65   virtual void EmitValueToAlignment(unsigned ByteAlignment, int64_t Value = 0,
  66                                     unsigned ValueSize = 1,
  67                                     unsigned MaxBytesToEmit = 0);
  68
  69   virtual void EmitValueToOffset(const MCExpr *Offset,
  70                                  unsigned char Value = 0);
  71
  72   virtual void EmitInstruction(const MCInst &Inst);
  73
  74   virtual void Finish();
  75
  76   /// @}
  77 };
  78
  79 } // end anonymous namespace.
  80
  81 static inline int64_t truncateToSize(int64_t Value, unsigned Bytes) {
  82   assert(Bytes && "Invalid size!");
  83   return Value & ((uint64_t) (int64_t) -1 >> (64 - Bytes * 8));
  84 }
  85
  86 static inline const MCExpr *truncateToSize(const MCExpr *Value,
  87                                            unsigned Bytes) {
  88   // FIXME: Do we really need this routine?
  89   return Value;
  90 }
  91
  92 void MCAsmStreamer::SwitchSection(const MCSection *Section) {
  93   assert(Section && "Cannot switch to a null section!");
  94   if (Section != CurSection) {
  95     CurSection = Section;
  96     Section->PrintSwitchToSection(MAI, OS);
  97   }
  98 }
  99
 100 void MCAsmStreamer::EmitLabel(MCSymbol *Symbol) {
 101   assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
 102   assert(CurSection && "Cannot emit before setting section!");
 103
 104   OS << *Symbol << ":\n";
 105   Symbol->setSection(*CurSection);
 106 }
 107
 108 void MCAsmStreamer::EmitAssemblerFlag(AssemblerFlag Flag) {
 109   switch (Flag) {
 110   default: assert(0 && "Invalid flag!");
 111   case SubsectionsViaSymbols: OS << ".subsections_via_symbols"; break;
 112   }
 113   OS << '\n';
 114 }
 115
 116 void MCAsmStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
 117   // Only absolute symbols can be redefined.
 118   assert((Symbol->isUndefined() || Symbol->isAbsolute()) &&
 119          "Cannot define a symbol twice!");
 120
 121   OS << *Symbol << " = ";
 122   Value->print(OS, &MAI);
 123   OS << '\n';
 124
 125   // FIXME: Lift context changes into super class.
 126   // FIXME: Set associated section.
 127   Symbol->setValue(Value);
 128 }
 129
 130 void MCAsmStreamer::EmitSymbolAttribute(MCSymbol *Symbol,
 131                                         SymbolAttr Attribute) {
 132   switch (Attribute) {
 133   case Global:         OS << ".globl";           break;
 134   case Hidden:         OS << ".hidden";          break;
 135   case IndirectSymbol: OS << ".indirect_symbol"; break;
 136   case Internal:       OS << ".internal";        break;
 137   case LazyReference:  OS << ".lazy_reference";  break;
 138   case NoDeadStrip:    OS << ".no_dead_strip";   break;
 139   case PrivateExtern:  OS << ".private_extern";  break;
 140   case Protected:      OS << ".protected";       break;
 141   case Reference:      OS << ".reference";       break;
 142   case Weak:           OS << ".weak";            break;
 143   case WeakDefinition: OS << ".weak_definition"; break;
 144   case WeakReference:  OS << ".weak_reference";  break;
 145   }
 146
 147   OS << ' ' << *Symbol << '\n';
 148 }
 149
 150 void MCAsmStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {
 151   OS << ".desc" << ' ' << *Symbol << ',' << DescValue << '\n';
 152 }
 153
 154 void MCAsmStreamer::EmitCommonSymbol(MCSymbol *Symbol, unsigned Size,
 155                                      unsigned ByteAlignment) {
 156   OS << ".comm " << *Symbol << ',' << Size;
 157   if (ByteAlignment != 0)
 158     OS << ',' << Log2_32(ByteAlignment);
 159   OS << '\n';
 160 }
 161
 162 void MCAsmStreamer::EmitZerofill(const MCSection *Section, MCSymbol *Symbol,
 163                                  unsigned Size, unsigned ByteAlignment) {
 164   // Note: a .zerofill directive does not switch sections.
 165   OS << ".zerofill ";
 166
 167   // This is a mach-o specific directive.
 168   const MCSectionMachO *MOSection = ((const MCSectionMachO*)Section);
 169   OS << MOSection->getSegmentName() << "," << MOSection->getSectionName();
 170
 171   if (Symbol != NULL) {
 172     OS << ',' << *Symbol << ',' << Size;
 173     if (ByteAlignment != 0)
 174       OS << ',' << Log2_32(ByteAlignment);
 175   }
 176   OS << '\n';
 177 }
 178
 179 void MCAsmStreamer::EmitBytes(StringRef Data) {
 180   assert(CurSection && "Cannot emit contents before setting section!");
 181   for (unsigned i = 0, e = Data.size(); i != e; ++i)
 182     OS << ".byte " << (unsigned) (unsigned char) Data[i] << '\n';
 183 }
 184
 185 void MCAsmStreamer::EmitValue(const MCExpr *Value, unsigned Size) {
 186   assert(CurSection && "Cannot emit contents before setting section!");
 187   // Need target hooks to know how to print this.
 188   switch (Size) {
 189   default:
 190     llvm_unreachable("Invalid size for machine code value!");
 191   case 1: OS << ".byte"; break;
 192   case 2: OS << ".short"; break;
 193   case 4: OS << ".long"; break;
 194   case 8: OS << ".quad"; break;
 195   }
 196
 197   OS << ' ';
 198   truncateToSize(Value, Size)->print(OS, &MAI);
 199   OS << '\n';
 200 }
 201
 202 void MCAsmStreamer::EmitValueToAlignment(unsigned ByteAlignment, int64_t Value,
 203                                          unsigned ValueSize,
 204                                          unsigned MaxBytesToEmit) {
 205   // Some assemblers don't support non-power of two alignments, so we always
 206   // emit alignments as a power of two if possible.
 207   if (isPowerOf2_32(ByteAlignment)) {
 208     switch (ValueSize) {
 209     default: llvm_unreachable("Invalid size for machine code value!");
 210     case 1: OS << MAI.getAlignDirective(); break;
 211     // FIXME: use MAI for this!
 212     case 2: OS << ".p2alignw "; break;
 213     case 4: OS << ".p2alignl "; break;
 214     case 8: llvm_unreachable("Unsupported alignment size!");
 215     }
 216
 217     if (MAI.getAlignmentIsInBytes())
 218       OS << ByteAlignment;
 219     else
 220       OS << Log2_32(ByteAlignment);
 221
 222     if (Value || MaxBytesToEmit) {
 223       OS << ", 0x";
 224       OS.write_hex(truncateToSize(Value, ValueSize));
 225
 226       if (MaxBytesToEmit)
 227         OS << ", " << MaxBytesToEmit;
 228     }
 229     OS << '\n';
 230     return;
 231   }
 232
 233   // Non-power of two alignment.  This is not widely supported by assemblers.
 234   // FIXME: Parameterize this based on MAI.
 235   switch (ValueSize) {
 236   default: llvm_unreachable("Invalid size for machine code value!");
 237   case 1: OS << ".balign";  break;
 238   case 2: OS << ".balignw"; break;
 239   case 4: OS << ".balignl"; break;
 240   case 8: llvm_unreachable("Unsupported alignment size!");
 241   }
 242
 243   OS << ' ' << ByteAlignment;
 244   OS << ", " << truncateToSize(Value, ValueSize);
 245   if (MaxBytesToEmit)
 246     OS << ", " << MaxBytesToEmit;
 247   OS << '\n';
 248 }
 249
 250 void MCAsmStreamer::EmitValueToOffset(const MCExpr *Offset,
 251                                       unsigned char Value) {
 252   // FIXME: Verify that Offset is associated with the current section.
 253   OS << ".org ";
 254   Offset->print(OS, &MAI);
 255   OS << ", " << (unsigned) Value << '\n';
 256 }
 257
 258 void MCAsmStreamer::EmitInstruction(const MCInst &Inst) {
 259   assert(CurSection && "Cannot emit contents before setting section!");
 260
 261   // If we have an AsmPrinter, use that to print.
 262   if (InstPrinter) {
 263     InstPrinter->printInst(&Inst);
 264     OS << '\n';
 265
 266     // Show the encoding if we have a code emitter.
 267     if (Emitter) {
 268       SmallString<256> Code;
 269       raw_svector_ostream VecOS(Code);
 270       Emitter->EncodeInstruction(Inst, VecOS);
 271       VecOS.flush();
 272
 273       OS.indent(20);
 274       OS << " # encoding: [";
 275       for (unsigned i = 0, e = Code.size(); i != e; ++i) {
 276         if (i)
 277           OS << ',';
 278         OS << format("%#04x", uint8_t(Code[i]));
 279       }
 280       OS << "]\n";
 281     }
 282
 283     return;
 284   }
 285
 286   // Otherwise fall back to a structural printing for now. Eventually we should
 287   // always have access to the target specific printer.
 288   Inst.print(OS, &MAI);
 289   OS << '\n';
 290 }
 291
 292 void MCAsmStreamer::Finish() {
 293   OS.flush();
 294 }
 295
 296 MCStreamer *llvm::createAsmStreamer(MCContext &Context, raw_ostream &OS,
 297                                     const MCAsmInfo &MAI, MCInstPrinter *IP,
 298                                     MCCodeEmitter *CE) {
 299   return new MCAsmStreamer(Context, OS, MAI, IP, CE);
 300 }