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), EmitEHFrame(true),
  24                                          EmitDebugFrame(false) {
  25   const MCSection *section = NULL;
  26   SectionStack.push_back(std::make_pair(section, section));
  27 }
  28
  29 MCStreamer::~MCStreamer() {
  30 }
  31
  32 const MCExpr *MCStreamer::BuildSymbolDiff(MCContext &Context,
  33                                           const MCSymbol *A,
  34                                           const MCSymbol *B) {
  35   MCSymbolRefExpr::VariantKind Variant = MCSymbolRefExpr::VK_None;
  36   const MCExpr *ARef =
  37     MCSymbolRefExpr::Create(A, Variant, Context);
  38   const MCExpr *BRef =
  39     MCSymbolRefExpr::Create(B, Variant, Context);
  40   const MCExpr *AddrDelta =
  41     MCBinaryExpr::Create(MCBinaryExpr::Sub, ARef, BRef, Context);
  42   return AddrDelta;
  43 }
  44
  45 const MCExpr *MCStreamer::ForceExpAbs(MCStreamer *Streamer,
  46                                       MCContext &Context, const MCExpr* Expr) {
  47  if (Context.getAsmInfo().hasAggressiveSymbolFolding())
  48    return Expr;
  49
  50  MCSymbol *ABS = Context.CreateTempSymbol();
  51  Streamer->EmitAssignment(ABS, Expr);
  52  return MCSymbolRefExpr::Create(ABS, Context);
  53 }
  54
  55 raw_ostream &MCStreamer::GetCommentOS() {
  56   // By default, discard comments.
  57   return nulls();
  58 }
  59
  60 void MCStreamer::EmitDwarfSetLineAddr(int64_t LineDelta,
  61                                       const MCSymbol *Label, int PointerSize) {
  62   // emit the sequence to set the address
  63   EmitIntValue(dwarf::DW_LNS_extended_op, 1);
  64   EmitULEB128IntValue(PointerSize + 1);
  65   EmitIntValue(dwarf::DW_LNE_set_address, 1);
  66   EmitSymbolValue(Label, PointerSize);
  67
  68   // emit the sequence for the LineDelta (from 1) and a zero address delta.
  69   MCDwarfLineAddr::Emit(this, LineDelta, 0);
  70 }
  71
  72 /// EmitIntValue - Special case of EmitValue that avoids the client having to
  73 /// pass in a MCExpr for constant integers.
  74 void MCStreamer::EmitIntValue(uint64_t Value, unsigned Size,
  75                               unsigned AddrSpace) {
  76   assert(Size <= 8 && "Invalid size");
  77   assert((isUIntN(8 * Size, Value) || isIntN(8 * Size, Value)) &&
  78          "Invalid size");
  79   char buf[8];
  80   // FIXME: Endianness assumption.
  81   for (unsigned i = 0; i != Size; ++i)
  82     buf[i] = uint8_t(Value >> (i * 8));
  83   EmitBytes(StringRef(buf, Size), AddrSpace);
  84 }
  85
  86 /// EmitULEB128Value - Special case of EmitULEB128Value that avoids the
  87 /// client having to pass in a MCExpr for constant integers.
  88 void MCStreamer::EmitULEB128IntValue(uint64_t Value, unsigned AddrSpace) {
  89   SmallString<32> Tmp;
  90   raw_svector_ostream OSE(Tmp);
  91   MCObjectWriter::EncodeULEB128(Value, OSE);
  92   EmitBytes(OSE.str(), AddrSpace);
  93 }
  94
  95 /// EmitSLEB128Value - Special case of EmitSLEB128Value that avoids the
  96 /// client having to pass in a MCExpr for constant integers.
  97 void MCStreamer::EmitSLEB128IntValue(int64_t Value, unsigned AddrSpace) {
  98   SmallString<32> Tmp;
  99   raw_svector_ostream OSE(Tmp);
 100   MCObjectWriter::EncodeSLEB128(Value, OSE);
 101   EmitBytes(OSE.str(), AddrSpace);
 102 }
 103
 104 void MCStreamer::EmitAbsValue(const MCExpr *Value, unsigned Size,
 105                               unsigned AddrSpace) {
 106   if (getContext().getAsmInfo().hasAggressiveSymbolFolding()) {
 107     EmitValue(Value, Size, AddrSpace);
 108     return;
 109   }
 110   MCSymbol *ABS = getContext().CreateTempSymbol();
 111   EmitAssignment(ABS, Value);
 112   EmitSymbolValue(ABS, Size, AddrSpace);
 113 }
 114
 115
 116 void MCStreamer::EmitValue(const MCExpr *Value, unsigned Size,
 117                            unsigned AddrSpace) {
 118   EmitValueImpl(Value, Size, AddrSpace);
 119 }
 120
 121 void MCStreamer::EmitSymbolValue(const MCSymbol *Sym, unsigned Size,
 122                                   unsigned AddrSpace) {
 123   EmitValueImpl(MCSymbolRefExpr::Create(Sym, getContext()), Size,
 124                 AddrSpace);
 125 }
 126
 127 void MCStreamer::EmitGPRel32Value(const MCExpr *Value) {
 128   report_fatal_error("unsupported directive in streamer");
 129 }
 130
 131 /// EmitFill - Emit NumBytes bytes worth of the value specified by
 132 /// FillValue.  This implements directives such as '.space'.
 133 void MCStreamer::EmitFill(uint64_t NumBytes, uint8_t FillValue,
 134                           unsigned AddrSpace) {
 135   const MCExpr *E = MCConstantExpr::Create(FillValue, getContext());
 136   for (uint64_t i = 0, e = NumBytes; i != e; ++i)
 137     EmitValue(E, 1, AddrSpace);
 138 }
 139
 140 bool MCStreamer::EmitDwarfFileDirective(unsigned FileNo,
 141                                         StringRef Filename) {
 142   return getContext().GetDwarfFile(Filename, FileNo) == 0;
 143 }
 144
 145 void MCStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
 146                                        unsigned Column, unsigned Flags,
 147                                        unsigned Isa,
 148                                        unsigned Discriminator,
 149                                        StringRef FileName) {
 150   getContext().setCurrentDwarfLoc(FileNo, Line, Column, Flags, Isa,
 151                                   Discriminator);
 152 }
 153
 154 MCDwarfFrameInfo *MCStreamer::getCurrentFrameInfo() {
 155   if (FrameInfos.empty())
 156     return NULL;
 157   return &FrameInfos.back();
 158 }
 159
 160 void MCStreamer::EnsureValidFrame() {
 161   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 162   if (!CurFrame || CurFrame->End)
 163     report_fatal_error("No open frame");
 164 }
 165
 166 void MCStreamer::EmitEHSymAttributes(const MCSymbol *Symbol,
 167                                      MCSymbol *EHSymbol) {
 168 }
 169
 170 void MCStreamer::EmitLabel(MCSymbol *Symbol) {
 171   assert(!Symbol->isVariable() && "Cannot emit a variable symbol!");
 172   assert(getCurrentSection() && "Cannot emit before setting section!");
 173   Symbol->setSection(*getCurrentSection());
 174
 175   StringRef Prefix = getContext().getAsmInfo().getPrivateGlobalPrefix();
 176   if (!Symbol->getName().startswith(Prefix))
 177     LastNonPrivate = Symbol;
 178 }
 179
 180 void MCStreamer::EmitCFISections(bool EH, bool Debug) {
 181   assert(EH || Debug);
 182   EmitEHFrame = EH;
 183   EmitDebugFrame = Debug;
 184 }
 185
 186 void MCStreamer::EmitCFIStartProc() {
 187   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 188   if (CurFrame && !CurFrame->End)
 189     report_fatal_error("Starting a frame before finishing the previous one!");
 190   MCDwarfFrameInfo Frame;
 191   Frame.Begin = getContext().CreateTempSymbol();
 192   Frame.Function = LastNonPrivate;
 193   EmitLabel(Frame.Begin);
 194   FrameInfos.push_back(Frame);
 195 }
 196
 197 void MCStreamer::EmitCFIEndProc() {
 198   EnsureValidFrame();
 199   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 200   CurFrame->End = getContext().CreateTempSymbol();
 201   EmitLabel(CurFrame->End);
 202 }
 203
 204 void MCStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
 205   EnsureValidFrame();
 206   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 207   MCSymbol *Label = getContext().CreateTempSymbol();
 208   EmitLabel(Label);
 209   MachineLocation Dest(MachineLocation::VirtualFP);
 210   MachineLocation Source(Register, -Offset);
 211   MCCFIInstruction Instruction(Label, Dest, Source);
 212   CurFrame->Instructions.push_back(Instruction);
 213 }
 214
 215 void MCStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
 216   EnsureValidFrame();
 217   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 218   MCSymbol *Label = getContext().CreateTempSymbol();
 219   EmitLabel(Label);
 220   MachineLocation Dest(MachineLocation::VirtualFP);
 221   MachineLocation Source(MachineLocation::VirtualFP, -Offset);
 222   MCCFIInstruction Instruction(Label, Dest, Source);
 223   CurFrame->Instructions.push_back(Instruction);
 224 }
 225
 226 void MCStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
 227   EnsureValidFrame();
 228   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 229   MCSymbol *Label = getContext().CreateTempSymbol();
 230   EmitLabel(Label);
 231   MachineLocation Dest(MachineLocation::VirtualFP);
 232   MachineLocation Source(MachineLocation::VirtualFP, Adjustment);
 233   MCCFIInstruction Instruction(MCCFIInstruction::RelMove, Label, Dest, Source);
 234   CurFrame->Instructions.push_back(Instruction);
 235 }
 236
 237 void MCStreamer::EmitCFIDefCfaRegister(int64_t Register) {
 238   EnsureValidFrame();
 239   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 240   MCSymbol *Label = getContext().CreateTempSymbol();
 241   EmitLabel(Label);
 242   MachineLocation Dest(Register);
 243   MachineLocation Source(MachineLocation::VirtualFP);
 244   MCCFIInstruction Instruction(Label, Dest, Source);
 245   CurFrame->Instructions.push_back(Instruction);
 246 }
 247
 248 void MCStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
 249   EnsureValidFrame();
 250   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 251   MCSymbol *Label = getContext().CreateTempSymbol();
 252   EmitLabel(Label);
 253   MachineLocation Dest(Register, Offset);
 254   MachineLocation Source(Register, Offset);
 255   MCCFIInstruction Instruction(Label, Dest, Source);
 256   CurFrame->Instructions.push_back(Instruction);
 257 }
 258
 259 void MCStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
 260   EnsureValidFrame();
 261   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 262   MCSymbol *Label = getContext().CreateTempSymbol();
 263   EmitLabel(Label);
 264   MachineLocation Dest(Register, Offset);
 265   MachineLocation Source(Register, Offset);
 266   MCCFIInstruction Instruction(MCCFIInstruction::RelMove, Label, Dest, Source);
 267   CurFrame->Instructions.push_back(Instruction);
 268 }
 269
 270 void MCStreamer::EmitCFIPersonality(const MCSymbol *Sym,
 271                                     unsigned Encoding) {
 272   EnsureValidFrame();
 273   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 274   CurFrame->Personality = Sym;
 275   CurFrame->PersonalityEncoding = Encoding;
 276 }
 277
 278 void MCStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
 279   EnsureValidFrame();
 280   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 281   CurFrame->Lsda = Sym;
 282   CurFrame->LsdaEncoding = Encoding;
 283 }
 284
 285 void MCStreamer::EmitCFIRememberState() {
 286   EnsureValidFrame();
 287   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 288   MCSymbol *Label = getContext().CreateTempSymbol();
 289   EmitLabel(Label);
 290   MCCFIInstruction Instruction(MCCFIInstruction::Remember, Label);
 291   CurFrame->Instructions.push_back(Instruction);
 292 }
 293
 294 void MCStreamer::EmitCFIRestoreState() {
 295   // FIXME: Error if there is no matching cfi_remember_state.
 296   EnsureValidFrame();
 297   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 298   MCSymbol *Label = getContext().CreateTempSymbol();
 299   EmitLabel(Label);
 300   MCCFIInstruction Instruction(MCCFIInstruction::Restore, Label);
 301   CurFrame->Instructions.push_back(Instruction);
 302 }
 303
 304 void MCStreamer::EmitCFISameValue(int64_t Register) {
 305   EnsureValidFrame();
 306   MCDwarfFrameInfo *CurFrame = getCurrentFrameInfo();
 307   MCSymbol *Label = getContext().CreateTempSymbol();
 308   EmitLabel(Label);
 309   MCCFIInstruction Instruction(MCCFIInstruction::SameValue, Label, Register);
 310   CurFrame->Instructions.push_back(Instruction);
 311 }
 312
 313 void MCStreamer::setCurrentW64UnwindInfo(MCWin64EHUnwindInfo *Frame) {
 314   W64UnwindInfos.push_back(*Frame);
 315   CurrentW64UnwindInfo = &W64UnwindInfos.back();
 316 }
 317
 318 void MCStreamer::EnsureValidW64UnwindInfo() {
 319   MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
 320   if (!CurFrame || CurFrame->End)
 321     report_fatal_error("No open Win64 EH frame function!");
 322 }
 323
 324 void MCStreamer::EmitWin64EHStartProc(MCSymbol *Symbol) {
 325   MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
 326   if (CurFrame && !CurFrame->End)
 327     report_fatal_error("Starting a function before ending the previous one!");
 328   MCWin64EHUnwindInfo Frame;
 329   Frame.Begin = getContext().CreateTempSymbol();
 330   Frame.Function = Symbol;
 331   EmitLabel(Frame.Begin);
 332   setCurrentW64UnwindInfo(&Frame);
 333 }
 334
 335 void MCStreamer::EmitWin64EHEndProc() {
 336   EnsureValidW64UnwindInfo();
 337   MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
 338   if (CurFrame->ChainedParent)
 339     report_fatal_error("Not all chained regions terminated!");
 340   CurFrame->End = getContext().CreateTempSymbol();
 341   EmitLabel(CurFrame->End);
 342 }
 343
 344 void MCStreamer::EmitWin64EHStartChained() {
 345   EnsureValidW64UnwindInfo();
 346   MCWin64EHUnwindInfo Frame;
 347   MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
 348   Frame.Begin = getContext().CreateTempSymbol();
 349   Frame.Function = CurFrame->Function;
 350   Frame.ChainedParent = CurFrame;
 351   EmitLabel(Frame.Begin);
 352   setCurrentW64UnwindInfo(&Frame);
 353 }
 354
 355 void MCStreamer::EmitWin64EHEndChained() {
 356   EnsureValidW64UnwindInfo();
 357   MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
 358   if (!CurFrame->ChainedParent)
 359     report_fatal_error("End of a chained region outside a chained region!");
 360   CurFrame->End = getContext().CreateTempSymbol();
 361   EmitLabel(CurFrame->End);
 362   CurrentW64UnwindInfo = CurFrame->ChainedParent;
 363 }
 364
 365 void MCStreamer::EmitWin64EHHandler(const MCSymbol *Sym, bool Unwind,
 366                                     bool Except) {
 367   EnsureValidW64UnwindInfo();
 368   MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
 369   CurFrame->ExceptionHandler = Sym;
 370   if (Unwind)
 371     CurFrame->UnwindOnly = true;
 372   else if (!Except)
 373     report_fatal_error("Don't know what kind of handler this is!");
 374 }
 375
 376 void MCStreamer::EmitWin64EHHandlerData() {
 377   errs() << "Not implemented yet\n";
 378   abort();
 379 }
 380
 381 void MCStreamer::EmitWin64EHPushReg(unsigned Register) {
 382   EnsureValidW64UnwindInfo();
 383   MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
 384   MCWin64EHInstruction Inst(Win64EH::UOP_PushNonVol, Register);
 385   CurFrame->Instructions.push_back(Inst);
 386 }
 387
 388 void MCStreamer::EmitWin64EHSetFrame(unsigned Register, unsigned Offset) {
 389   EnsureValidW64UnwindInfo();
 390   MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
 391   MCWin64EHInstruction Inst(Win64EH::UOP_SetFPReg, Register, Offset);
 392   CurFrame->Instructions.push_back(Inst);
 393 }
 394
 395 void MCStreamer::EmitWin64EHAllocStack(unsigned Size) {
 396   EnsureValidW64UnwindInfo();
 397   MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
 398   MCWin64EHInstruction Inst(Size);
 399   CurFrame->Instructions.push_back(Inst);
 400 }
 401
 402 void MCStreamer::EmitWin64EHSaveReg(unsigned Register, unsigned Offset) {
 403   EnsureValidW64UnwindInfo();
 404   MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
 405   MCWin64EHInstruction Inst(
 406          Offset > 0xFFFF ? Win64EH::UOP_SaveNonVol : Win64EH::UOP_SaveNonVolBig,
 407                             Register, Offset);
 408   CurFrame->Instructions.push_back(Inst);
 409 }
 410
 411 void MCStreamer::EmitWin64EHSaveXMM(unsigned Register, unsigned Offset) {
 412   EnsureValidW64UnwindInfo();
 413   MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
 414   MCWin64EHInstruction Inst(
 415          Offset > 0xFFFF ? Win64EH::UOP_SaveXMM128 : Win64EH::UOP_SaveXMM128Big,
 416                             Register, Offset);
 417   CurFrame->Instructions.push_back(Inst);
 418 }
 419
 420 void MCStreamer::EmitWin64EHPushFrame(bool Code) {
 421   EnsureValidW64UnwindInfo();
 422   MCWin64EHUnwindInfo *CurFrame = CurrentW64UnwindInfo;
 423   MCWin64EHInstruction Inst(Win64EH::UOP_PushMachFrame, Code);
 424   CurFrame->Instructions.push_back(Inst);
 425 }
 426
 427 void MCStreamer::EmitWin64EHEndProlog() {
 428   errs() << "Not implemented yet\n";
 429   abort();
 430 }
 431
 432 void MCStreamer::EmitFnStart() {
 433   errs() << "Not implemented yet\n";
 434   abort();
 435 }
 436
 437 void MCStreamer::EmitFnEnd() {
 438   errs() << "Not implemented yet\n";
 439   abort();
 440 }
 441
 442 void MCStreamer::EmitCantUnwind() {
 443   errs() << "Not implemented yet\n";
 444   abort();
 445 }
 446
 447 void MCStreamer::EmitHandlerData() {
 448   errs() << "Not implemented yet\n";
 449   abort();
 450 }
 451
 452 void MCStreamer::EmitPersonality(const MCSymbol *Personality) {
 453   errs() << "Not implemented yet\n";
 454   abort();
 455 }
 456
 457 void MCStreamer::EmitSetFP(unsigned FpReg, unsigned SpReg, int64_t Offset) {
 458   errs() << "Not implemented yet\n";
 459   abort();
 460 }
 461
 462 void MCStreamer::EmitPad(int64_t Offset) {
 463   errs() << "Not implemented yet\n";
 464   abort();
 465 }
 466
 467 void MCStreamer::EmitRegSave(const SmallVectorImpl<unsigned> &RegList, bool) {
 468   errs() << "Not implemented yet\n";
 469   abort();
 470 }
 471
 472 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
 473 /// the specified string in the output .s file.  This capability is
 474 /// indicated by the hasRawTextSupport() predicate.
 475 void MCStreamer::EmitRawText(StringRef String) {
 476   errs() << "EmitRawText called on an MCStreamer that doesn't support it, "
 477   " something must not be fully mc'ized\n";
 478   abort();
 479 }
 480
 481 void MCStreamer::EmitRawText(const Twine &T) {
 482   SmallString<128> Str;
 483   T.toVector(Str);
 484   EmitRawText(Str.str());
 485 }
 486
 487 void MCStreamer::EmitFrames(bool usingCFI) {
 488   if (!getNumFrameInfos())
 489     return;
 490
 491   if (EmitEHFrame)
 492     MCDwarfFrameEmitter::Emit(*this, usingCFI, true);
 493
 494   if (EmitDebugFrame)
 495     MCDwarfFrameEmitter::Emit(*this, usingCFI, false);
 496 }