contrib/llvm/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/MCStreamer.h"
  11 #include "llvm/ADT/SmallString.h"
  12 #include "llvm/ADT/StringRef.h"
  13 #include "llvm/ADT/Twine.h"
  14 #include "llvm/BinaryFormat/COFF.h"
  15 #include "llvm/MC/MCAsmBackend.h"
  16 #include "llvm/MC/MCAsmInfo.h"
  17 #include "llvm/MC/MCCodeView.h"
  18 #include "llvm/MC/MCContext.h"
  19 #include "llvm/MC/MCDwarf.h"
  20 #include "llvm/MC/MCExpr.h"
  21 #include "llvm/MC/MCInst.h"
  22 #include "llvm/MC/MCInstPrinter.h"
  23 #include "llvm/MC/MCObjectFileInfo.h"
  24 #include "llvm/MC/MCSection.h"
  25 #include "llvm/MC/MCSectionCOFF.h"
  26 #include "llvm/MC/MCSymbol.h"
  27 #include "llvm/MC/MCWin64EH.h"
  28 #include "llvm/MC/MCWinEH.h"
  29 #include "llvm/Support/Casting.h"
  30 #include "llvm/Support/ErrorHandling.h"
  31 #include "llvm/Support/LEB128.h"
  32 #include "llvm/Support/MathExtras.h"
  33 #include "llvm/Support/raw_ostream.h"
  34 #include <cassert>
  35 #include <cstdint>
  36 #include <cstdlib>
  37 #include <utility>
  38
  39 using namespace llvm;
  40
  41 MCTargetStreamer::MCTargetStreamer(MCStreamer &S) : Streamer(S) {
  42   S.setTargetStreamer(this);
  43 }
  44
  45 // Pin the vtables to this file.
  46 MCTargetStreamer::~MCTargetStreamer() = default;
  47
  48 void MCTargetStreamer::emitLabel(MCSymbol *Symbol) {}
  49
  50 void MCTargetStreamer::finish() {}
  51
  52 void MCTargetStreamer::changeSection(const MCSection *CurSection,
  53                                      MCSection *Section,
  54                                      const MCExpr *Subsection,
  55                                      raw_ostream &OS) {
  56   Section->PrintSwitchToSection(
  57       *Streamer.getContext().getAsmInfo(),
  58       Streamer.getContext().getObjectFileInfo()->getTargetTriple(), OS,
  59       Subsection);
  60 }
  61
  62 void MCTargetStreamer::emitDwarfFileDirective(StringRef Directive) {
  63   Streamer.EmitRawText(Directive);
  64 }
  65
  66 void MCTargetStreamer::emitValue(const MCExpr *Value) {
  67   SmallString<128> Str;
  68   raw_svector_ostream OS(Str);
  69
  70   Value->print(OS, Streamer.getContext().getAsmInfo());
  71   Streamer.EmitRawText(OS.str());
  72 }
  73
  74 void MCTargetStreamer::emitAssignment(MCSymbol *Symbol, const MCExpr *Value) {}
  75
  76 MCStreamer::MCStreamer(MCContext &Ctx)
  77     : Context(Ctx), CurrentWinFrameInfo(nullptr) {
  78   SectionStack.push_back(std::pair<MCSectionSubPair, MCSectionSubPair>());
  79 }
  80
  81 MCStreamer::~MCStreamer() {}
  82
  83 void MCStreamer::reset() {
  84   DwarfFrameInfos.clear();
  85   CurrentWinFrameInfo = nullptr;
  86   WinFrameInfos.clear();
  87   SymbolOrdering.clear();
  88   SectionStack.clear();
  89   SectionStack.push_back(std::pair<MCSectionSubPair, MCSectionSubPair>());
  90 }
  91
  92 raw_ostream &MCStreamer::GetCommentOS() {
  93   // By default, discard comments.
  94   return nulls();
  95 }
  96
  97 void MCStreamer::emitRawComment(const Twine &T, bool TabPrefix) {}
  98
  99 void MCStreamer::addExplicitComment(const Twine &T) {}
 100 void MCStreamer::emitExplicitComments() {}
 101
 102 void MCStreamer::generateCompactUnwindEncodings(MCAsmBackend *MAB) {
 103   for (auto &FI : DwarfFrameInfos)
 104     FI.CompactUnwindEncoding =
 105         (MAB ? MAB->generateCompactUnwindEncoding(FI.Instructions) : 0);
 106 }
 107
 108 /// EmitIntValue - Special case of EmitValue that avoids the client having to
 109 /// pass in a MCExpr for constant integers.
 110 void MCStreamer::EmitIntValue(uint64_t Value, unsigned Size) {
 111   assert(1 <= Size && Size <= 8 && "Invalid size");
 112   assert((isUIntN(8 * Size, Value) || isIntN(8 * Size, Value)) &&
 113          "Invalid size");
 114   char buf[8];
 115   const bool isLittleEndian = Context.getAsmInfo()->isLittleEndian();
 116   for (unsigned i = 0; i != Size; ++i) {
 117     unsigned index = isLittleEndian ? i : (Size - i - 1);
 118     buf[i] = uint8_t(Value >> (index * 8));
 119   }
 120   EmitBytes(StringRef(buf, Size));
 121 }
 122
 123 /// EmitULEB128Value - Special case of EmitULEB128Value that avoids the
 124 /// client having to pass in a MCExpr for constant integers.
 125 void MCStreamer::EmitPaddedULEB128IntValue(uint64_t Value, unsigned PadTo) {
 126   SmallString<128> Tmp;
 127   raw_svector_ostream OSE(Tmp);
 128   encodeULEB128(Value, OSE, PadTo);
 129   EmitBytes(OSE.str());
 130 }
 131
 132 void MCStreamer::EmitULEB128IntValue(uint64_t Value) {
 133   EmitPaddedULEB128IntValue(Value, 0);
 134 }
 135
 136 /// EmitSLEB128Value - Special case of EmitSLEB128Value that avoids the
 137 /// client having to pass in a MCExpr for constant integers.
 138 void MCStreamer::EmitSLEB128IntValue(int64_t Value) {
 139   SmallString<128> Tmp;
 140   raw_svector_ostream OSE(Tmp);
 141   encodeSLEB128(Value, OSE);
 142   EmitBytes(OSE.str());
 143 }
 144
 145 void MCStreamer::EmitValue(const MCExpr *Value, unsigned Size, SMLoc Loc) {
 146   EmitValueImpl(Value, Size, Loc);
 147 }
 148
 149 void MCStreamer::EmitSymbolValue(const MCSymbol *Sym, unsigned Size,
 150                                  bool IsSectionRelative) {
 151   assert((!IsSectionRelative || Size == 4) &&
 152          "SectionRelative value requires 4-bytes");
 153
 154   if (!IsSectionRelative)
 155     EmitValueImpl(MCSymbolRefExpr::create(Sym, getContext()), Size);
 156   else
 157     EmitCOFFSecRel32(Sym, /*Offset=*/0);
 158 }
 159
 160 void MCStreamer::EmitDTPRel64Value(const MCExpr *Value) {
 161   report_fatal_error("unsupported directive in streamer");
 162 }
 163
 164 void MCStreamer::EmitDTPRel32Value(const MCExpr *Value) {
 165   report_fatal_error("unsupported directive in streamer");
 166 }
 167
 168 void MCStreamer::EmitTPRel64Value(const MCExpr *Value) {
 169   report_fatal_error("unsupported directive in streamer");
 170 }
 171
 172 void MCStreamer::EmitTPRel32Value(const MCExpr *Value) {
 173   report_fatal_error("unsupported directive in streamer");
 174 }
 175
 176 void MCStreamer::EmitGPRel64Value(const MCExpr *Value) {
 177   report_fatal_error("unsupported directive in streamer");
 178 }
 179
 180 void MCStreamer::EmitGPRel32Value(const MCExpr *Value) {
 181   report_fatal_error("unsupported directive in streamer");
 182 }
 183
 184 /// Emit NumBytes bytes worth of the value specified by FillValue.
 185 /// This implements directives such as '.space'.
 186 void MCStreamer::emitFill(uint64_t NumBytes, uint8_t FillValue) {
 187   emitFill(*MCConstantExpr::create(NumBytes, getContext()), FillValue);
 188 }
 189
 190 void MCStreamer::emitFill(uint64_t NumValues, int64_t Size, int64_t Expr) {
 191   int64_t NonZeroSize = Size > 4 ? 4 : Size;
 192   Expr &= ~0ULL >> (64 - NonZeroSize * 8);
 193   for (uint64_t i = 0, e = NumValues; i != e; ++i) {
 194     EmitIntValue(Expr, NonZeroSize);
 195     if (NonZeroSize < Size)
 196       EmitIntValue(0, Size - NonZeroSize);
 197   }
 198 }
 199
 200 /// The implementation in this class just redirects to emitFill.
 201 void MCStreamer::EmitZeros(uint64_t NumBytes) {
 202   emitFill(NumBytes, 0);
 203 }
 204
 205 unsigned MCStreamer::EmitDwarfFileDirective(unsigned FileNo,
 206                                             StringRef Directory,
 207                                             StringRef Filename, unsigned CUID) {
 208   return getContext().getDwarfFile(Directory, Filename, FileNo, CUID);
 209 }
 210
 211 void MCStreamer::EmitDwarfLocDirective(unsigned FileNo, unsigned Line,
 212                                        unsigned Column, unsigned Flags,
 213                                        unsigned Isa,
 214                                        unsigned Discriminator,
 215                                        StringRef FileName) {
 216   getContext().setCurrentDwarfLoc(FileNo, Line, Column, Flags, Isa,
 217                                   Discriminator);
 218 }
 219
 220 MCSymbol *MCStreamer::getDwarfLineTableSymbol(unsigned CUID) {
 221   MCDwarfLineTable &Table = getContext().getMCDwarfLineTable(CUID);
 222   if (!Table.getLabel()) {
 223     StringRef Prefix = Context.getAsmInfo()->getPrivateGlobalPrefix();
 224     Table.setLabel(
 225         Context.getOrCreateSymbol(Prefix + "line_table_start" + Twine(CUID)));
 226   }
 227   return Table.getLabel();
 228 }
 229
 230 bool MCStreamer::hasUnfinishedDwarfFrameInfo() {
 231   return !DwarfFrameInfos.empty() && !DwarfFrameInfos.back().End;
 232 }
 233
 234 MCDwarfFrameInfo *MCStreamer::getCurrentDwarfFrameInfo() {
 235   if (!hasUnfinishedDwarfFrameInfo()) {
 236     getContext().reportError(SMLoc(), "this directive must appear between "
 237                                       ".cfi_startproc and .cfi_endproc "
 238                                       "directives");
 239     return nullptr;
 240   }
 241   return &DwarfFrameInfos.back();
 242 }
 243
 244 bool MCStreamer::EmitCVFileDirective(unsigned FileNo, StringRef Filename,
 245                                      ArrayRef<uint8_t> Checksum,
 246                                      unsigned ChecksumKind) {
 247   return getContext().getCVContext().addFile(*this, FileNo, Filename, Checksum,
 248                                              ChecksumKind);
 249 }
 250
 251 bool MCStreamer::EmitCVFuncIdDirective(unsigned FunctionId) {
 252   return getContext().getCVContext().recordFunctionId(FunctionId);
 253 }
 254
 255 bool MCStreamer::EmitCVInlineSiteIdDirective(unsigned FunctionId,
 256                                              unsigned IAFunc, unsigned IAFile,
 257                                              unsigned IALine, unsigned IACol,
 258                                              SMLoc Loc) {
 259   if (getContext().getCVContext().getCVFunctionInfo(IAFunc) == nullptr) {
 260     getContext().reportError(Loc, "parent function id not introduced by "
 261                                   ".cv_func_id or .cv_inline_site_id");
 262     return true;
 263   }
 264
 265   return getContext().getCVContext().recordInlinedCallSiteId(
 266       FunctionId, IAFunc, IAFile, IALine, IACol);
 267 }
 268
 269 void MCStreamer::EmitCVLocDirective(unsigned FunctionId, unsigned FileNo,
 270                                     unsigned Line, unsigned Column,
 271                                     bool PrologueEnd, bool IsStmt,
 272                                     StringRef FileName, SMLoc Loc) {
 273   CodeViewContext &CVC = getContext().getCVContext();
 274   MCCVFunctionInfo *FI = CVC.getCVFunctionInfo(FunctionId);
 275   if (!FI)
 276     return getContext().reportError(
 277         Loc, "function id not introduced by .cv_func_id or .cv_inline_site_id");
 278
 279   // Track the section
 280   if (FI->Section == nullptr)
 281     FI->Section = getCurrentSectionOnly();
 282   else if (FI->Section != getCurrentSectionOnly())
 283     return getContext().reportError(
 284         Loc,
 285         "all .cv_loc directives for a function must be in the same section");
 286
 287   CVC.setCurrentCVLoc(FunctionId, FileNo, Line, Column, PrologueEnd, IsStmt);
 288 }
 289
 290 void MCStreamer::EmitCVLinetableDirective(unsigned FunctionId,
 291                                           const MCSymbol *Begin,
 292                                           const MCSymbol *End) {}
 293
 294 void MCStreamer::EmitCVInlineLinetableDirective(unsigned PrimaryFunctionId,
 295                                                 unsigned SourceFileId,
 296                                                 unsigned SourceLineNum,
 297                                                 const MCSymbol *FnStartSym,
 298                                                 const MCSymbol *FnEndSym) {}
 299
 300 void MCStreamer::EmitCVDefRangeDirective(
 301     ArrayRef<std::pair<const MCSymbol *, const MCSymbol *>> Ranges,
 302     StringRef FixedSizePortion) {}
 303
 304 void MCStreamer::EmitEHSymAttributes(const MCSymbol *Symbol,
 305                                      MCSymbol *EHSymbol) {
 306 }
 307
 308 void MCStreamer::InitSections(bool NoExecStack) {
 309   SwitchSection(getContext().getObjectFileInfo()->getTextSection());
 310 }
 311
 312 void MCStreamer::AssignFragment(MCSymbol *Symbol, MCFragment *Fragment) {
 313   assert(Fragment);
 314   Symbol->setFragment(Fragment);
 315
 316   // As we emit symbols into a section, track the order so that they can
 317   // be sorted upon later. Zero is reserved to mean 'unemitted'.
 318   SymbolOrdering[Symbol] = 1 + SymbolOrdering.size();
 319 }
 320
 321 void MCStreamer::EmitLabel(MCSymbol *Symbol, SMLoc Loc) {
 322   Symbol->redefineIfPossible();
 323
 324   if (!Symbol->isUndefined() || Symbol->isVariable())
 325     return getContext().reportError(Loc, "invalid symbol redefinition");
 326
 327   assert(!Symbol->isVariable() && "Cannot emit a variable symbol!");
 328   assert(getCurrentSectionOnly() && "Cannot emit before setting section!");
 329   assert(!Symbol->getFragment() && "Unexpected fragment on symbol data!");
 330   assert(Symbol->isUndefined() && "Cannot define a symbol twice!");
 331
 332   Symbol->setFragment(&getCurrentSectionOnly()->getDummyFragment());
 333
 334   MCTargetStreamer *TS = getTargetStreamer();
 335   if (TS)
 336     TS->emitLabel(Symbol);
 337 }
 338
 339 void MCStreamer::EmitCFISections(bool EH, bool Debug) {
 340   assert(EH || Debug);
 341 }
 342
 343 void MCStreamer::EmitCFIStartProc(bool IsSimple) {
 344   if (hasUnfinishedDwarfFrameInfo())
 345     getContext().reportError(
 346         SMLoc(), "starting new .cfi frame before finishing the previous one");
 347
 348   MCDwarfFrameInfo Frame;
 349   Frame.IsSimple = IsSimple;
 350   EmitCFIStartProcImpl(Frame);
 351
 352   const MCAsmInfo* MAI = Context.getAsmInfo();
 353   if (MAI) {
 354     for (const MCCFIInstruction& Inst : MAI->getInitialFrameState()) {
 355       if (Inst.getOperation() == MCCFIInstruction::OpDefCfa ||
 356           Inst.getOperation() == MCCFIInstruction::OpDefCfaRegister) {
 357         Frame.CurrentCfaRegister = Inst.getRegister();
 358       }
 359     }
 360   }
 361
 362   DwarfFrameInfos.push_back(Frame);
 363 }
 364
 365 void MCStreamer::EmitCFIStartProcImpl(MCDwarfFrameInfo &Frame) {
 366 }
 367
 368 void MCStreamer::EmitCFIEndProc() {
 369   MCDwarfFrameInfo *CurFrame = getCurrentDwarfFrameInfo();
 370   if (!CurFrame)
 371     return;
 372   EmitCFIEndProcImpl(*CurFrame);
 373 }
 374
 375 void MCStreamer::EmitCFIEndProcImpl(MCDwarfFrameInfo &Frame) {
 376   // Put a dummy non-null value in Frame.End to mark that this frame has been
 377   // closed.
 378   Frame.End = (MCSymbol *)1;
 379 }
 380
 381 MCSymbol *MCStreamer::EmitCFILabel() {
 382   // Return a dummy non-null value so that label fields appear filled in when
 383   // generating textual assembly.
 384   return (MCSymbol *)1;
 385 }
 386
 387 void MCStreamer::EmitCFIDefCfa(int64_t Register, int64_t Offset) {
 388   MCSymbol *Label = EmitCFILabel();
 389   MCCFIInstruction Instruction =
 390     MCCFIInstruction::createDefCfa(Label, Register, Offset);
 391   MCDwarfFrameInfo *CurFrame = getCurrentDwarfFrameInfo();
 392   if (!CurFrame)
 393     return;
 394   CurFrame->Instructions.push_back(Instruction);
 395   CurFrame->CurrentCfaRegister = static_cast<unsigned>(Register);
 396 }
 397
 398 void MCStreamer::EmitCFIDefCfaOffset(int64_t Offset) {
 399   MCSymbol *Label = EmitCFILabel();
 400   MCCFIInstruction Instruction =
 401     MCCFIInstruction::createDefCfaOffset(Label, Offset);
 402   MCDwarfFrameInfo *CurFrame = getCurrentDwarfFrameInfo();
 403   if (!CurFrame)
 404     return;
 405   CurFrame->Instructions.push_back(Instruction);
 406 }
 407
 408 void MCStreamer::EmitCFIAdjustCfaOffset(int64_t Adjustment) {
 409   MCSymbol *Label = EmitCFILabel();
 410   MCCFIInstruction Instruction =
 411     MCCFIInstruction::createAdjustCfaOffset(Label, Adjustment);
 412   MCDwarfFrameInfo *CurFrame = getCurrentDwarfFrameInfo();
 413   if (!CurFrame)
 414     return;
 415   CurFrame->Instructions.push_back(Instruction);
 416 }
 417
 418 void MCStreamer::EmitCFIDefCfaRegister(int64_t Register) {
 419   MCSymbol *Label = EmitCFILabel();
 420   MCCFIInstruction Instruction =
 421     MCCFIInstruction::createDefCfaRegister(Label, Register);
 422   MCDwarfFrameInfo *CurFrame = getCurrentDwarfFrameInfo();
 423   if (!CurFrame)
 424     return;
 425   CurFrame->Instructions.push_back(Instruction);
 426   CurFrame->CurrentCfaRegister = static_cast<unsigned>(Register);
 427 }
 428
 429 void MCStreamer::EmitCFIOffset(int64_t Register, int64_t Offset) {
 430   MCSymbol *Label = EmitCFILabel();
 431   MCCFIInstruction Instruction =
 432     MCCFIInstruction::createOffset(Label, Register, Offset);
 433   MCDwarfFrameInfo *CurFrame = getCurrentDwarfFrameInfo();
 434   if (!CurFrame)
 435     return;
 436   CurFrame->Instructions.push_back(Instruction);
 437 }
 438
 439 void MCStreamer::EmitCFIRelOffset(int64_t Register, int64_t Offset) {
 440   MCSymbol *Label = EmitCFILabel();
 441   MCCFIInstruction Instruction =
 442     MCCFIInstruction::createRelOffset(Label, Register, Offset);
 443   MCDwarfFrameInfo *CurFrame = getCurrentDwarfFrameInfo();
 444   if (!CurFrame)
 445     return;
 446   CurFrame->Instructions.push_back(Instruction);
 447 }
 448
 449 void MCStreamer::EmitCFIPersonality(const MCSymbol *Sym,
 450                                     unsigned Encoding) {
 451   MCDwarfFrameInfo *CurFrame = getCurrentDwarfFrameInfo();
 452   if (!CurFrame)
 453     return;
 454   CurFrame->Personality = Sym;
 455   CurFrame->PersonalityEncoding = Encoding;
 456 }
 457
 458 void MCStreamer::EmitCFILsda(const MCSymbol *Sym, unsigned Encoding) {
 459   MCDwarfFrameInfo *CurFrame = getCurrentDwarfFrameInfo();
 460   if (!CurFrame)
 461     return;
 462   CurFrame->Lsda = Sym;
 463   CurFrame->LsdaEncoding = Encoding;
 464 }
 465
 466 void MCStreamer::EmitCFIRememberState() {
 467   MCSymbol *Label = EmitCFILabel();
 468   MCCFIInstruction Instruction = MCCFIInstruction::createRememberState(Label);
 469   MCDwarfFrameInfo *CurFrame = getCurrentDwarfFrameInfo();
 470   if (!CurFrame)
 471     return;
 472   CurFrame->Instructions.push_back(Instruction);
 473 }
 474
 475 void MCStreamer::EmitCFIRestoreState() {
 476   // FIXME: Error if there is no matching cfi_remember_state.
 477   MCSymbol *Label = EmitCFILabel();
 478   MCCFIInstruction Instruction = MCCFIInstruction::createRestoreState(Label);
 479   MCDwarfFrameInfo *CurFrame = getCurrentDwarfFrameInfo();
 480   if (!CurFrame)
 481     return;
 482   CurFrame->Instructions.push_back(Instruction);
 483 }
 484
 485 void MCStreamer::EmitCFISameValue(int64_t Register) {
 486   MCSymbol *Label = EmitCFILabel();
 487   MCCFIInstruction Instruction =
 488     MCCFIInstruction::createSameValue(Label, Register);
 489   MCDwarfFrameInfo *CurFrame = getCurrentDwarfFrameInfo();
 490   if (!CurFrame)
 491     return;
 492   CurFrame->Instructions.push_back(Instruction);
 493 }
 494
 495 void MCStreamer::EmitCFIRestore(int64_t Register) {
 496   MCSymbol *Label = EmitCFILabel();
 497   MCCFIInstruction Instruction =
 498     MCCFIInstruction::createRestore(Label, Register);
 499   MCDwarfFrameInfo *CurFrame = getCurrentDwarfFrameInfo();
 500   if (!CurFrame)
 501     return;
 502   CurFrame->Instructions.push_back(Instruction);
 503 }
 504
 505 void MCStreamer::EmitCFIEscape(StringRef Values) {
 506   MCSymbol *Label = EmitCFILabel();
 507   MCCFIInstruction Instruction = MCCFIInstruction::createEscape(Label, Values);
 508   MCDwarfFrameInfo *CurFrame = getCurrentDwarfFrameInfo();
 509   if (!CurFrame)
 510     return;
 511   CurFrame->Instructions.push_back(Instruction);
 512 }
 513
 514 void MCStreamer::EmitCFIGnuArgsSize(int64_t Size) {
 515   MCSymbol *Label = EmitCFILabel();
 516   MCCFIInstruction Instruction =
 517     MCCFIInstruction::createGnuArgsSize(Label, Size);
 518   MCDwarfFrameInfo *CurFrame = getCurrentDwarfFrameInfo();
 519   if (!CurFrame)
 520     return;
 521   CurFrame->Instructions.push_back(Instruction);
 522 }
 523
 524 void MCStreamer::EmitCFISignalFrame() {
 525   MCDwarfFrameInfo *CurFrame = getCurrentDwarfFrameInfo();
 526   if (!CurFrame)
 527     return;
 528   CurFrame->IsSignalFrame = true;
 529 }
 530
 531 void MCStreamer::EmitCFIUndefined(int64_t Register) {
 532   MCSymbol *Label = EmitCFILabel();
 533   MCCFIInstruction Instruction =
 534     MCCFIInstruction::createUndefined(Label, Register);
 535   MCDwarfFrameInfo *CurFrame = getCurrentDwarfFrameInfo();
 536   if (!CurFrame)
 537     return;
 538   CurFrame->Instructions.push_back(Instruction);
 539 }
 540
 541 void MCStreamer::EmitCFIRegister(int64_t Register1, int64_t Register2) {
 542   MCSymbol *Label = EmitCFILabel();
 543   MCCFIInstruction Instruction =
 544     MCCFIInstruction::createRegister(Label, Register1, Register2);
 545   MCDwarfFrameInfo *CurFrame = getCurrentDwarfFrameInfo();
 546   if (!CurFrame)
 547     return;
 548   CurFrame->Instructions.push_back(Instruction);
 549 }
 550
 551 void MCStreamer::EmitCFIWindowSave() {
 552   MCSymbol *Label = EmitCFILabel();
 553   MCCFIInstruction Instruction =
 554     MCCFIInstruction::createWindowSave(Label);
 555   MCDwarfFrameInfo *CurFrame = getCurrentDwarfFrameInfo();
 556   if (!CurFrame)
 557     return;
 558   CurFrame->Instructions.push_back(Instruction);
 559 }
 560
 561 void MCStreamer::EmitCFIReturnColumn(int64_t Register) {
 562   MCDwarfFrameInfo *CurFrame = getCurrentDwarfFrameInfo();
 563   if (!CurFrame)
 564     return;
 565   CurFrame->RAReg = Register;
 566 }
 567
 568 WinEH::FrameInfo *MCStreamer::EnsureValidWinFrameInfo(SMLoc Loc) {
 569   const MCAsmInfo *MAI = Context.getAsmInfo();
 570   if (!MAI->usesWindowsCFI()) {
 571     getContext().reportError(
 572         Loc, ".seh_* directives are not supported on this target");
 573     return nullptr;
 574   }
 575   if (!CurrentWinFrameInfo || CurrentWinFrameInfo->End) {
 576     getContext().reportError(
 577         Loc, ".seh_ directive must appear within an active frame");
 578     return nullptr;
 579   }
 580   return CurrentWinFrameInfo;
 581 }
 582
 583 void MCStreamer::EmitWinCFIStartProc(const MCSymbol *Symbol, SMLoc Loc) {
 584   const MCAsmInfo *MAI = Context.getAsmInfo();
 585   if (!MAI->usesWindowsCFI())
 586     return getContext().reportError(
 587         Loc, ".seh_* directives are not supported on this target");
 588   if (CurrentWinFrameInfo && !CurrentWinFrameInfo->End)
 589     getContext().reportError(
 590         Loc, "Starting a function before ending the previous one!");
 591
 592   MCSymbol *StartProc = EmitCFILabel();
 593
 594   WinFrameInfos.emplace_back(
 595       llvm::make_unique<WinEH::FrameInfo>(Symbol, StartProc));
 596   CurrentWinFrameInfo = WinFrameInfos.back().get();
 597   CurrentWinFrameInfo->TextSection = getCurrentSectionOnly();
 598 }
 599
 600 void MCStreamer::EmitWinCFIEndProc(SMLoc Loc) {
 601   WinEH::FrameInfo *CurFrame = EnsureValidWinFrameInfo(Loc);
 602   if (!CurFrame)
 603     return;
 604   if (CurFrame->ChainedParent)
 605     getContext().reportError(Loc, "Not all chained regions terminated!");
 606
 607   MCSymbol *Label = EmitCFILabel();
 608   CurFrame->End = Label;
 609 }
 610
 611 void MCStreamer::EmitWinCFIStartChained(SMLoc Loc) {
 612   WinEH::FrameInfo *CurFrame = EnsureValidWinFrameInfo(Loc);
 613   if (!CurFrame)
 614     return;
 615
 616   MCSymbol *StartProc = EmitCFILabel();
 617
 618   WinFrameInfos.emplace_back(llvm::make_unique<WinEH::FrameInfo>(
 619       CurFrame->Function, StartProc, CurFrame));
 620   CurrentWinFrameInfo = WinFrameInfos.back().get();
 621   CurrentWinFrameInfo->TextSection = getCurrentSectionOnly();
 622 }
 623
 624 void MCStreamer::EmitWinCFIEndChained(SMLoc Loc) {
 625   WinEH::FrameInfo *CurFrame = EnsureValidWinFrameInfo(Loc);
 626   if (!CurFrame)
 627     return;
 628   if (!CurFrame->ChainedParent)
 629     return getContext().reportError(
 630         Loc, "End of a chained region outside a chained region!");
 631
 632   MCSymbol *Label = EmitCFILabel();
 633
 634   CurFrame->End = Label;
 635   CurrentWinFrameInfo = const_cast<WinEH::FrameInfo *>(CurFrame->ChainedParent);
 636 }
 637
 638 void MCStreamer::EmitWinEHHandler(const MCSymbol *Sym, bool Unwind, bool Except,
 639                                   SMLoc Loc) {
 640   WinEH::FrameInfo *CurFrame = EnsureValidWinFrameInfo(Loc);
 641   if (!CurFrame)
 642     return;
 643   if (CurFrame->ChainedParent)
 644     return getContext().reportError(
 645         Loc, "Chained unwind areas can't have handlers!");
 646   CurFrame->ExceptionHandler = Sym;
 647   if (!Except && !Unwind)
 648     getContext().reportError(Loc, "Don't know what kind of handler this is!");
 649   if (Unwind)
 650     CurFrame->HandlesUnwind = true;
 651   if (Except)
 652     CurFrame->HandlesExceptions = true;
 653 }
 654
 655 void MCStreamer::EmitWinEHHandlerData(SMLoc Loc) {
 656   WinEH::FrameInfo *CurFrame = EnsureValidWinFrameInfo(Loc);
 657   if (!CurFrame)
 658     return;
 659   if (CurFrame->ChainedParent)
 660     getContext().reportError(Loc, "Chained unwind areas can't have handlers!");
 661 }
 662
 663 static MCSection *getWinCFISection(MCContext &Context, unsigned *NextWinCFIID,
 664                                    MCSection *MainCFISec,
 665                                    const MCSection *TextSec) {
 666   // If this is the main .text section, use the main unwind info section.
 667   if (TextSec == Context.getObjectFileInfo()->getTextSection())
 668     return MainCFISec;
 669
 670   const auto *TextSecCOFF = cast<MCSectionCOFF>(TextSec);
 671   unsigned UniqueID = TextSecCOFF->getOrAssignWinCFISectionID(NextWinCFIID);
 672
 673   // If this section is COMDAT, this unwind section should be COMDAT associative
 674   // with its group.
 675   const MCSymbol *KeySym = nullptr;
 676   if (TextSecCOFF->getCharacteristics() & COFF::IMAGE_SCN_LNK_COMDAT)
 677     KeySym = TextSecCOFF->getCOMDATSymbol();
 678
 679   return Context.getAssociativeCOFFSection(cast<MCSectionCOFF>(MainCFISec),
 680                                            KeySym, UniqueID);
 681 }
 682
 683 MCSection *MCStreamer::getAssociatedPDataSection(const MCSection *TextSec) {
 684   return getWinCFISection(getContext(), &NextWinCFIID,
 685                           getContext().getObjectFileInfo()->getPDataSection(),
 686                           TextSec);
 687 }
 688
 689 MCSection *MCStreamer::getAssociatedXDataSection(const MCSection *TextSec) {
 690   return getWinCFISection(getContext(), &NextWinCFIID,
 691                           getContext().getObjectFileInfo()->getXDataSection(),
 692                           TextSec);
 693 }
 694
 695 void MCStreamer::EmitSyntaxDirective() {}
 696
 697 void MCStreamer::EmitWinCFIPushReg(unsigned Register, SMLoc Loc) {
 698   WinEH::FrameInfo *CurFrame = EnsureValidWinFrameInfo(Loc);
 699   if (!CurFrame)
 700     return;
 701
 702   MCSymbol *Label = EmitCFILabel();
 703
 704   WinEH::Instruction Inst = Win64EH::Instruction::PushNonVol(Label, Register);
 705   CurFrame->Instructions.push_back(Inst);
 706 }
 707
 708 void MCStreamer::EmitWinCFISetFrame(unsigned Register, unsigned Offset,
 709                                     SMLoc Loc) {
 710   WinEH::FrameInfo *CurFrame = EnsureValidWinFrameInfo(Loc);
 711   if (!CurFrame)
 712     return;
 713   if (CurFrame->LastFrameInst >= 0)
 714     return getContext().reportError(
 715         Loc, "frame register and offset can be set at most once");
 716   if (Offset & 0x0F)
 717     return getContext().reportError(Loc, "offset is not a multiple of 16");
 718   if (Offset > 240)
 719     return getContext().reportError(
 720         Loc, "frame offset must be less than or equal to 240");
 721
 722   MCSymbol *Label = EmitCFILabel();
 723
 724   WinEH::Instruction Inst =
 725       Win64EH::Instruction::SetFPReg(Label, Register, Offset);
 726   CurFrame->LastFrameInst = CurFrame->Instructions.size();
 727   CurFrame->Instructions.push_back(Inst);
 728 }
 729
 730 void MCStreamer::EmitWinCFIAllocStack(unsigned Size, SMLoc Loc) {
 731   WinEH::FrameInfo *CurFrame = EnsureValidWinFrameInfo(Loc);
 732   if (!CurFrame)
 733     return;
 734   if (Size == 0)
 735     return getContext().reportError(Loc,
 736                                     "stack allocation size must be non-zero");
 737   if (Size & 7)
 738     return getContext().reportError(
 739         Loc, "stack allocation size is not a multiple of 8");
 740
 741   MCSymbol *Label = EmitCFILabel();
 742
 743   WinEH::Instruction Inst = Win64EH::Instruction::Alloc(Label, Size);
 744   CurFrame->Instructions.push_back(Inst);
 745 }
 746
 747 void MCStreamer::EmitWinCFISaveReg(unsigned Register, unsigned Offset,
 748                                    SMLoc Loc) {
 749   WinEH::FrameInfo *CurFrame = EnsureValidWinFrameInfo(Loc);
 750   if (!CurFrame)
 751     return;
 752
 753   if (Offset & 7)
 754     return getContext().reportError(
 755         Loc, "register save offset is not 8 byte aligned");
 756
 757   MCSymbol *Label = EmitCFILabel();
 758
 759   WinEH::Instruction Inst =
 760       Win64EH::Instruction::SaveNonVol(Label, Register, Offset);
 761   CurFrame->Instructions.push_back(Inst);
 762 }
 763
 764 void MCStreamer::EmitWinCFISaveXMM(unsigned Register, unsigned Offset,
 765                                    SMLoc Loc) {
 766   WinEH::FrameInfo *CurFrame = EnsureValidWinFrameInfo(Loc);
 767   if (!CurFrame)
 768     return;
 769   if (Offset & 0x0F)
 770     return getContext().reportError(Loc, "offset is not a multiple of 16");
 771
 772   MCSymbol *Label = EmitCFILabel();
 773
 774   WinEH::Instruction Inst =
 775       Win64EH::Instruction::SaveXMM(Label, Register, Offset);
 776   CurFrame->Instructions.push_back(Inst);
 777 }
 778
 779 void MCStreamer::EmitWinCFIPushFrame(bool Code, SMLoc Loc) {
 780   WinEH::FrameInfo *CurFrame = EnsureValidWinFrameInfo(Loc);
 781   if (!CurFrame)
 782     return;
 783   if (!CurFrame->Instructions.empty())
 784     return getContext().reportError(
 785         Loc, "If present, PushMachFrame must be the first UOP");
 786
 787   MCSymbol *Label = EmitCFILabel();
 788
 789   WinEH::Instruction Inst = Win64EH::Instruction::PushMachFrame(Label, Code);
 790   CurFrame->Instructions.push_back(Inst);
 791 }
 792
 793 void MCStreamer::EmitWinCFIEndProlog(SMLoc Loc) {
 794   WinEH::FrameInfo *CurFrame = EnsureValidWinFrameInfo(Loc);
 795   if (!CurFrame)
 796     return;
 797
 798   MCSymbol *Label = EmitCFILabel();
 799
 800   CurFrame->PrologEnd = Label;
 801 }
 802
 803 void MCStreamer::EmitCOFFSafeSEH(MCSymbol const *Symbol) {
 804 }
 805
 806 void MCStreamer::EmitCOFFSectionIndex(MCSymbol const *Symbol) {
 807 }
 808
 809 void MCStreamer::EmitCOFFSecRel32(MCSymbol const *Symbol, uint64_t Offset) {}
 810
 811 /// EmitRawText - If this file is backed by an assembly streamer, this dumps
 812 /// the specified string in the output .s file.  This capability is
 813 /// indicated by the hasRawTextSupport() predicate.
 814 void MCStreamer::EmitRawTextImpl(StringRef String) {
 815   errs() << "EmitRawText called on an MCStreamer that doesn't support it, "
 816   " something must not be fully mc'ized\n";
 817   abort();
 818 }
 819
 820 void MCStreamer::EmitRawText(const Twine &T) {
 821   SmallString<128> Str;
 822   EmitRawTextImpl(T.toStringRef(Str));
 823 }
 824
 825 void MCStreamer::EmitWindowsUnwindTables() {
 826 }
 827
 828 void MCStreamer::Finish() {
 829   if (!DwarfFrameInfos.empty() && !DwarfFrameInfos.back().End)
 830     getContext().reportError(SMLoc(), "Unfinished frame!");
 831   if (!WinFrameInfos.empty() && !WinFrameInfos.back()->End)
 832     getContext().reportError(SMLoc(), "Unfinished frame!");
 833
 834   MCTargetStreamer *TS = getTargetStreamer();
 835   if (TS)
 836     TS->finish();
 837
 838   FinishImpl();
 839 }
 840
 841 void MCStreamer::EmitAssignment(MCSymbol *Symbol, const MCExpr *Value) {
 842   visitUsedExpr(*Value);
 843   Symbol->setVariableValue(Value);
 844
 845   MCTargetStreamer *TS = getTargetStreamer();
 846   if (TS)
 847     TS->emitAssignment(Symbol, Value);
 848 }
 849
 850 void MCTargetStreamer::prettyPrintAsm(MCInstPrinter &InstPrinter, raw_ostream &OS,
 851                               const MCInst &Inst, const MCSubtargetInfo &STI) {
 852   InstPrinter.printInst(&Inst, OS, "", STI);
 853 }
 854
 855 void MCStreamer::visitUsedSymbol(const MCSymbol &Sym) {
 856 }
 857
 858 void MCStreamer::visitUsedExpr(const MCExpr &Expr) {
 859   switch (Expr.getKind()) {
 860   case MCExpr::Target:
 861     cast<MCTargetExpr>(Expr).visitUsedExpr(*this);
 862     break;
 863
 864   case MCExpr::Constant:
 865     break;
 866
 867   case MCExpr::Binary: {
 868     const MCBinaryExpr &BE = cast<MCBinaryExpr>(Expr);
 869     visitUsedExpr(*BE.getLHS());
 870     visitUsedExpr(*BE.getRHS());
 871     break;
 872   }
 873
 874   case MCExpr::SymbolRef:
 875     visitUsedSymbol(cast<MCSymbolRefExpr>(Expr).getSymbol());
 876     break;
 877
 878   case MCExpr::Unary:
 879     visitUsedExpr(*cast<MCUnaryExpr>(Expr).getSubExpr());
 880     break;
 881   }
 882 }
 883
 884 void MCStreamer::EmitInstruction(const MCInst &Inst, const MCSubtargetInfo &STI,
 885                                  bool) {
 886   // Scan for values.
 887   for (unsigned i = Inst.getNumOperands(); i--;)
 888     if (Inst.getOperand(i).isExpr())
 889       visitUsedExpr(*Inst.getOperand(i).getExpr());
 890 }
 891
 892 void MCStreamer::emitAbsoluteSymbolDiff(const MCSymbol *Hi, const MCSymbol *Lo,
 893                                         unsigned Size) {
 894   // Get the Hi-Lo expression.
 895   const MCExpr *Diff =
 896       MCBinaryExpr::createSub(MCSymbolRefExpr::create(Hi, Context),
 897                               MCSymbolRefExpr::create(Lo, Context), Context);
 898
 899   const MCAsmInfo *MAI = Context.getAsmInfo();
 900   if (!MAI->doesSetDirectiveSuppressReloc()) {
 901     EmitValue(Diff, Size);
 902     return;
 903   }
 904
 905   // Otherwise, emit with .set (aka assignment).
 906   MCSymbol *SetLabel = Context.createTempSymbol("set", true);
 907   EmitAssignment(SetLabel, Diff);
 908   EmitSymbolValue(SetLabel, Size);
 909 }
 910
 911 void MCStreamer::EmitAssemblerFlag(MCAssemblerFlag Flag) {}
 912 void MCStreamer::EmitThumbFunc(MCSymbol *Func) {}
 913 void MCStreamer::EmitSymbolDesc(MCSymbol *Symbol, unsigned DescValue) {}
 914 void MCStreamer::BeginCOFFSymbolDef(const MCSymbol *Symbol) {
 915   llvm_unreachable("this directive only supported on COFF targets");
 916 }
 917 void MCStreamer::EndCOFFSymbolDef() {
 918   llvm_unreachable("this directive only supported on COFF targets");
 919 }
 920 void MCStreamer::EmitFileDirective(StringRef Filename) {}
 921 void MCStreamer::EmitCOFFSymbolStorageClass(int StorageClass) {
 922   llvm_unreachable("this directive only supported on COFF targets");
 923 }
 924 void MCStreamer::EmitCOFFSymbolType(int Type) {
 925   llvm_unreachable("this directive only supported on COFF targets");
 926 }
 927 void MCStreamer::emitELFSize(MCSymbol *Symbol, const MCExpr *Value) {}
 928 void MCStreamer::emitELFSymverDirective(StringRef AliasName,
 929                                         const MCSymbol *Aliasee) {}
 930 void MCStreamer::EmitLocalCommonSymbol(MCSymbol *Symbol, uint64_t Size,
 931                                        unsigned ByteAlignment) {}
 932 void MCStreamer::EmitTBSSSymbol(MCSection *Section, MCSymbol *Symbol,
 933                                 uint64_t Size, unsigned ByteAlignment) {}
 934 void MCStreamer::ChangeSection(MCSection *, const MCExpr *) {}
 935 void MCStreamer::EmitWeakReference(MCSymbol *Alias, const MCSymbol *Symbol) {}
 936 void MCStreamer::EmitBytes(StringRef Data) {}
 937 void MCStreamer::EmitBinaryData(StringRef Data) { EmitBytes(Data); }
 938 void MCStreamer::EmitValueImpl(const MCExpr *Value, unsigned Size, SMLoc Loc) {
 939   visitUsedExpr(*Value);
 940 }
 941 void MCStreamer::EmitULEB128Value(const MCExpr *Value) {}
 942 void MCStreamer::EmitSLEB128Value(const MCExpr *Value) {}
 943 void MCStreamer::emitFill(const MCExpr &NumBytes, uint64_t Value, SMLoc Loc) {}
 944 void MCStreamer::emitFill(const MCExpr &NumValues, int64_t Size, int64_t Expr,
 945                           SMLoc Loc) {}
 946 void MCStreamer::EmitValueToAlignment(unsigned ByteAlignment, int64_t Value,
 947                                       unsigned ValueSize,
 948                                       unsigned MaxBytesToEmit) {}
 949 void MCStreamer::EmitCodeAlignment(unsigned ByteAlignment,
 950                                    unsigned MaxBytesToEmit) {}
 951 void MCStreamer::emitValueToOffset(const MCExpr *Offset, unsigned char Value,
 952                                    SMLoc Loc) {}
 953 void MCStreamer::EmitBundleAlignMode(unsigned AlignPow2) {}
 954 void MCStreamer::EmitBundleLock(bool AlignToEnd) {}
 955 void MCStreamer::FinishImpl() {}
 956 void MCStreamer::EmitBundleUnlock() {}
 957
 958 void MCStreamer::SwitchSection(MCSection *Section, const MCExpr *Subsection) {
 959   assert(Section && "Cannot switch to a null section!");
 960   MCSectionSubPair curSection = SectionStack.back().first;
 961   SectionStack.back().second = curSection;
 962   if (MCSectionSubPair(Section, Subsection) != curSection) {
 963     ChangeSection(Section, Subsection);
 964     SectionStack.back().first = MCSectionSubPair(Section, Subsection);
 965     assert(!Section->hasEnded() && "Section already ended");
 966     MCSymbol *Sym = Section->getBeginSymbol();
 967     if (Sym && !Sym->isInSection())
 968       EmitLabel(Sym);
 969   }
 970 }
 971
 972 MCSymbol *MCStreamer::endSection(MCSection *Section) {
 973   // TODO: keep track of the last subsection so that this symbol appears in the
 974   // correct place.
 975   MCSymbol *Sym = Section->getEndSymbol(Context);
 976   if (Sym->isInSection())
 977     return Sym;
 978
 979   SwitchSection(Section);
 980   EmitLabel(Sym);
 981   return Sym;
 982 }
 983
 984 void MCStreamer::EmitVersionForTarget(const Triple &Target) {
 985   if (!Target.isOSBinFormatMachO() || !Target.isOSDarwin())
 986     return;
 987   // Do we even know the version?
 988   if (Target.getOSMajorVersion() == 0)
 989     return;
 990
 991   unsigned Major;
 992   unsigned Minor;
 993   unsigned Update;
 994   MCVersionMinType VersionType;
 995   if (Target.isWatchOS()) {
 996     VersionType = MCVM_WatchOSVersionMin;
 997     Target.getWatchOSVersion(Major, Minor, Update);
 998   } else if (Target.isTvOS()) {
 999     VersionType = MCVM_TvOSVersionMin;
1000     Target.getiOSVersion(Major, Minor, Update);
1001   } else if (Target.isMacOSX()) {
1002     VersionType = MCVM_OSXVersionMin;
1003     if (!Target.getMacOSXVersion(Major, Minor, Update))
1004       Major = 0;
1005   } else {
1006     VersionType = MCVM_IOSVersionMin;
1007     Target.getiOSVersion(Major, Minor, Update);
1008   }
1009   if (Major != 0)
1010     EmitVersionMin(VersionType, Major, Minor, Update);
1011 }