lib/MC/MCStreamer.cpp

   1 //===- lib/MC/MCStreamer.cpp - Streaming Machine Code 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/MCAsmInfo.h"
  11 #include "llvm/MC/MCContext.h"
  12 #include "llvm/MC/MCStreamer.h"
  13 #include "llvm/MC/MCExpr.h"
  14 #include "llvm/MC/MCObjectWriter.h"
  15 #include "llvm/MC/MCSymbol.h"
  16 #include "llvm/Support/ErrorHandling.h"
  17 #include "llvm/Support/raw_ostream.h"
  18 #include "llvm/ADT/SmallString.h"
  19 #include "llvm/ADT/Twine.h"
  20 #include <cstdlib>
  21 using namespace llvm;
  22
  23 MCStreamer::MCStreamer(MCContext &Ctx) : Context(Ctx) {
  24   const MCSection *section = NULL;
  25   SectionStack.push_back(std::make_pair(section, section));
  26 }
  27
  28 MCStreamer::~MCStreamer() {
  29 }
  30
  31 const MCExpr *MCStreamer::BuildSymbolDiff(MCContext &Context,
  32                                           const MCSymbol *A,
  33                                           const MCSymbol *B) {
  34   MCSymbolRefExpr::VariantKind Variant = MCSymbolRefExpr::VK_None;
  35   const MCExpr *ARef =
  36     MCSymbolRefExpr::Create(A, Variant, Context);
  37   const MCExpr *BRef =
  38     MCSymbolRefExpr::Create(B, Variant, Context);
  39   const MCExpr *AddrDelta =
  40     MCBinaryExpr::Create(MCBinaryExpr::Sub, ARef, BRef, Context);
  41   return AddrDelta;
  42 }
  43
  44 const MCExpr *MCStreamer::ForceExpAbs(MCStreamer *Streamer,
  45                                       MCContext &Context, const MCExpr* Expr) {
  46  if (Context.getAsmInfo().hasAggressiveSymbolFolding())
  47    return Expr;
  48
  49  MCSymbol *ABS = Context.CreateTempSymbol();
  50  Streamer->EmitAssignment(ABS, Expr);
  51  return MCSymbolRefExpr::Create(ABS, Context);
  52 }
  53
  54 raw_ostream &MCStreamer::GetCommentOS() {
  55   // By default, discard comments.
  56   return nulls();
  57 }
  58
  59 void MCStreamer::EmitDwarfSetLineAddr(int64_t LineDelta,
  60                                       const MCSymbol *Label, int PointerSize) {
  61   // emit the sequence to set the address
  62   EmitIntValue(dwarf::DW_LNS_extended_op, 1);
  63   EmitULEB128IntValue(PointerSize + 1);
  64   EmitIntValue(dwarf::DW_LNE_set_address, 1);
  65   EmitSymbolValue(Label, PointerSize);
  66
  67   // emit the sequence for the LineDelta (from 1) and a zero address delta.
  68   MCDwarfLineAddr::Emit(this, LineDelta, 0);
  69 }
  70
  71 /// EmitIntValue - Special case of EmitValue that avoids the client having to
  72 /// pass in a MCExpr for constant integers.
  73 void MCStreamer::EmitIntValue(uint64_t Value, unsigned Size,
  74                               unsigned AddrSpace) {
  75   assert(Size <= 8 && "Invalid size");
  76   assert((isUIntN(8 * Size, Value) || isIntN(8 * Size, Value)) &&
  77          "Invalid size");
  78   char buf[8];
  79   // FIXME: Endianness assumption.
  80   for (unsigned i = 0; i != Size; ++i)
  81     buf[i] = uint8_t(Value >> (i * 8));
  82   EmitBytes(StringRef(buf, Size), AddrSpace);
  83 }
  84
  85 /// EmitULEB128Value - Special case of EmitULEB128Value that avoids the
  86 /// client having to pass in a MCExpr for constant integers.
  87 void MCStreamer::EmitULEB128IntValue(uint64_t Value, unsigned AddrSpace) {
  88   SmallString<32> Tmp;
  89   raw_svector_ostream OSE(Tmp);
  90   MCObjectWriter::EncodeULEB128(Value, OSE);
  91   EmitBytes(OSE.str(), AddrSpace);
  92 }
  93
  94 /// EmitSLEB128Value - Special case of EmitSLEB128Value that avoids the
  95 /// client having to pass in a MCExpr for constant integers.
  96 void MCStreamer::EmitSLEB128IntValue(int64_t Value, unsigned AddrSpace) {
  97   SmallString<32> Tmp;
  98   raw_svector_ostream OSE(Tmp);
  99   MCObjectWriter::EncodeSLEB128(Value, OSE);
 100   EmitBytes(OSE.str(), AddrSpace);
 101 }
 102
 103 void MCStreamer::EmitAbsValue(const MCExpr *Value, unsigned Size,
 104                               unsigned AddrSpace) {
 105   if (getContext().getAsmInfo().hasAggressiveSymbolFolding()) {
 106     EmitValue(Value, Size, AddrSpace);
 107     return;
 108   }
 109   MCSymbol *ABS = getContext().CreateTempSymbol();
 110   EmitAssignment(ABS, Value);
 111   EmitSymbolValue(ABS, Size, AddrSpace);
 112 }
 113
 114
 115 void MCStreamer::EmitValue(const MCExpr *Value, unsigned Size,
 116                            unsigned AddrSpace) {
 117   EmitValueImpl(Value, Size, false, AddrSpace);
 118 }
 119
 120 void MCStreamer::EmitPCRelValue(const MCExpr *Value, unsigned Size,
 121                                 unsigned AddrSpace) {
 122   EmitValueImpl(Value, Size, true, AddrSpace);
 123 }
 124
 125 void MCStreamer::EmitSymbolValue(const MCSymbol *Sym, unsigned Size,
 126                                  bool isPCRel, unsigned AddrSpace) {
 127   EmitValueImpl(MCSymbolRefExpr::Create(Sym, getContext()), Size, isPCRel,
 128                 AddrSpace);
 129 }
 130
 131 void MCStreamer::EmitSymbolValue(const MCSymbol *Sym, unsigned Size,
 132                                  unsigned AddrSpace) {
 133   EmitSymbolValue(Sym, Size, false, AddrSpace);
 134 }
 135
 136 void MCStreamer::EmitPCRelSymbolValue(const MCSymbol *Sym, unsigned Size,
 137                                       unsigned AddrSpace) {
 138   EmitSymbolValue(Sym, Size, true, AddrSpace);
 139 }
 140
 141 void MCStreamer::EmitGPRel32Value(const MCExpr *Value) {
 142   report_fatal_error("unsupported directive in streamer");
 143 }
 144
 145 /// EmitFill - Emit NumBytes bytes worth of the value specified by
 146 /// FillValue.  This implements directives such as '.space'.
 147 void MCStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue,
 148                           unsigned AddrSpace) {
 149   const MCExpr *E = MCConstantExpr::Create(FillValue, getContext());
 150   for (uint64_t i = 0, e = NumBytes; i != e; ++i)
 151     EmitValue(E, 1, AddrSpace);
 152 }
 153
 154 bool MCStreamer::EmitDwarfFileDirective(unsigned FileNo,
 155                                         StringRef Filename) {
 156   return getContext().GetDwarfFile(Filename, FileNo) == 0;
 157 }
 158
 159 void MCStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
 160                                        unsigned Column, unsigned Flags,
 161                                        unsigned Isa,
 162                                        unsigned Discriminator,
 163                                        StringRef FileName) {
 164   getContext().setCurrentDwarfLoc(FileNo, Line, Column, Flags, Isa,
 165                                   Discriminator);
 166 }
 167
 168 MCDwarfFrameInfo *MCStreamer::getCurrentFrameInfo() {
 169   if (FrameInfos.empty())
 170     return NULL;
 171   return &FrameInfos.back();
 172 }
 173
 174 void MCStreamer::EnsureValidFrame() {
 175   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 176   if (!CurFrame || CurFrame->End)
 177     report_fatal_error("No open frame");
 178 }
 179
 180 void MCStreamer::EmitEHSymAttributes(const MCSymbol *Symbol,
 181                                      MCSymbol *EHSymbol) {
 182 }
 183
 184 void MCStreamer::EmitLabel(MCSymbol *Symbol) {
 185   assert(!Symbol->isVariable() && "Cannot emit a variable symbol!");
 186   assert(getCurrentSection() && "Cannot emit before setting section!");
 187   Symbol->setSection(*getCurrentSection());
 188
 189   StringRef Prefix = getContext().getAsmInfo().getPrivateGlobalPrefix();
 190   if (!Symbol->getName().startswith(Prefix))
 191     LastNonPrivate = Symbol;
 192 }
 193
 194 void MCStreamer::EmitCFIStartProc() {
 195   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 196   if (CurFrame && !CurFrame->End)
 197     report_fatal_error("Starting a frame before finishing the previous one!");
 198   MCDwarfFrameInfo Frame;
 199   Frame.Begin = getContext().CreateTempSymbol();
 200   Frame.Function = LastNonPrivate;
 201   EmitLabel(Frame.Begin);
 202   FrameInfos.push_back(Frame);
 203 }
 204
 205 void MCStreamer::EmitCFIEndProc() {
 206   EnsureValidFrame();
 207   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 208   CurFrame->End = getContext().CreateTempSymbol();
 209   EmitLabel(CurFrame->End);
 210 }
 211
 212 void MCStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
 213   EnsureValidFrame();
 214   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 215   MCSymbol *Label = getContext().CreateTempSymbol();
 216   EmitLabel(Label);
 217   MachineLocation Dest(MachineLocation::VirtualFP);
 218   MachineLocation Source(Register, -Offset);
 219   MCCFIInstruction Instruction(Label, Dest, Source);
 220   CurFrame->Instructions.push_back(Instruction);
 221 }
 222
 223 void MCStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
 224   EnsureValidFrame();
 225   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 226   MCSymbol *Label = getContext().CreateTempSymbol();
 227   EmitLabel(Label);
 228   MachineLocation Dest(MachineLocation::VirtualFP);
 229   MachineLocation Source(MachineLocation::VirtualFP, -Offset);
 230   MCCFIInstruction Instruction(Label, Dest, Source);
 231   CurFrame->Instructions.push_back(Instruction);
 232 }
 233
 234 void MCStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
 235   EnsureValidFrame();
 236   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 237   MCSymbol *Label = getContext().CreateTempSymbol();
 238   EmitLabel(Label);
 239   MachineLocation Dest(MachineLocation::VirtualFP);
 240   MachineLocation Source(MachineLocation::VirtualFP, Adjustment);
 241   MCCFIInstruction Instruction(MCCFIInstruction::RelMove, Label, Dest, Source);
 242   CurFrame->Instructions.push_back(Instruction);
 243 }
 244
 245 void MCStreamer::EmitCFIDefCfaRegister(int64_t Register) {
 246   EnsureValidFrame();
 247   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 248   MCSymbol *Label = getContext().CreateTempSymbol();
 249   EmitLabel(Label);
 250   MachineLocation Dest(Register);
 251   MachineLocation Source(MachineLocation::VirtualFP);
 252   MCCFIInstruction Instruction(Label, Dest, Source);
 253   CurFrame->Instructions.push_back(Instruction);
 254 }
 255
 256 void MCStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
 257   EnsureValidFrame();
 258   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 259   MCSymbol *Label = getContext().CreateTempSymbol();
 260   EmitLabel(Label);
 261   MachineLocation Dest(Register, Offset);
 262   MachineLocation Source(Register, Offset);
 263   MCCFIInstruction Instruction(Label, Dest, Source);
 264   CurFrame->Instructions.push_back(Instruction);
 265 }
 266
 267 void MCStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
 268   EnsureValidFrame();
 269   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 270   MCSymbol *Label = getContext().CreateTempSymbol();
 271   EmitLabel(Label);
 272   MachineLocation Dest(Register, Offset);
 273   MachineLocation Source(Register, Offset);
 274   MCCFIInstruction Instruction(MCCFIInstruction::RelMove, Label, Dest, Source);
 275   CurFrame->Instructions.push_back(Instruction);
 276 }
 277
 278 void MCStreamer::EmitCFIPersonality(const MCSymbol *Sym,
 279                                     unsigned Encoding) {
 280   EnsureValidFrame();
 281   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 282   CurFrame->Personality = Sym;
 283   CurFrame->PersonalityEncoding = Encoding;
 284 }
 285
 286 void MCStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
 287   EnsureValidFrame();
 288   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 289   CurFrame->Lsda = Sym;
 290   CurFrame->LsdaEncoding = Encoding;
 291 }
 292
 293 void MCStreamer::EmitCFIRememberState() {
 294   EnsureValidFrame();
 295   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 296   MCSymbol *Label = getContext().CreateTempSymbol();
 297   EmitLabel(Label);
 298   MCCFIInstruction Instruction(MCCFIInstruction::Remember, Label);
 299   CurFrame->Instructions.push_back(Instruction);
 300 }
 301
 302 void MCStreamer::EmitCFIRestoreState() {
 303   // FIXME: Error if there is no matching cfi_remember_state.
 304   EnsureValidFrame();
 305   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 306   MCSymbol *Label = getContext().CreateTempSymbol();
 307   EmitLabel(Label);
 308   MCCFIInstruction Instruction(MCCFIInstruction::Restore, Label);
 309   CurFrame->Instructions.push_back(Instruction);
 310 }
 311
 312 void MCStreamer::EmitCFISameValue(int64_t Register) {
 313   EnsureValidFrame();
 314   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 315   MCSymbol *Label = getContext().CreateTempSymbol();
 316   EmitLabel(Label);
 317   MCCFIInstruction Instruction(MCCFIInstruction::SameValue, Label, Register);
 318   CurFrame->Instructions.push_back(Instruction);
 319 }
 320
 321 void MCStreamer::EmitFnStart() {
 322   errs() << "Not implemented yet\n";
 323   abort();
 324 }
 325
 326 void MCStreamer::EmitFnEnd() {
 327   errs() << "Not implemented yet\n";
 328   abort();
 329 }
 330
 331 void MCStreamer::EmitCantUnwind() {
 332   errs() << "Not implemented yet\n";
 333   abort();
 334 }
 335
 336 void MCStreamer::EmitHandlerData() {
 337   errs() << "Not implemented yet\n";
 338   abort();
 339 }
 340
 341 void MCStreamer::EmitPersonality(const MCSymbol *Personality) {
 342   errs() << "Not implemented yet\n";
 343   abort();
 344 }
 345
 346 void MCStreamer::EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset) {
 347   errs() << "Not implemented yet\n";
 348   abort();
 349 }
 350
 351 void MCStreamer::EmitPad(int64_t Offset) {
 352   errs() << "Not implemented yet\n";
 353   abort();
 354 }
 355
 356 void MCStreamer::EmitRegSave(const SmallVectorImpl<unsigned> &RegList, bool) {
 357   errs() << "Not implemented yet\n";
 358   abort();
 359 }
 360
 361 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
 362 /// the specified string in the output .s file.  This capability is
 363 /// indicated by the hasRawTextSupport() predicate.
 364 void MCStreamer::EmitRawText(StringRef String) {
 365   errs() << "EmitRawText called on an MCStreamer that doesn't support it, "
 366   " something must not be fully mc'ized\n";
 367   abort();
 368 }
 369
 370 void MCStreamer::EmitRawText(const Twine &T) {
 371   SmallString<128> Str;
 372   T.toVector(Str);
 373   EmitRawText(Str.str());
 374 }