lib/Target/X86/X86FloatingPoint.cpp

   1 //===-- X86FloatingPoint.cpp - Floating point Reg -> Stack converter ------===//
   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 // This file defines the pass which converts floating point instructions from
  11 // pseudo registers into register stack instructions.  This pass uses live
  12 // variable information to indicate where the FPn registers are used and their
  13 // lifetimes.
  14 //
  15 // The x87 hardware tracks liveness of the stack registers, so it is necessary
  16 // to implement exact liveness tracking between basic blocks. The CFG edges are
  17 // partitioned into bundles where the same FP registers must be live in
  18 // identical stack positions. Instructions are inserted at the end of each basic
  19 // block to rearrange the live registers to match the outgoing bundle.
  20 //
  21 // This approach avoids splitting critical edges at the potential cost of more
  22 // live register shuffling instructions when critical edges are present.
  23 //
  24 //===----------------------------------------------------------------------===//
  25
  26 #include "X86.h"
  27 #include "X86InstrInfo.h"
  28 #include "llvm/ADT/BitVector.h"
  29 #include "llvm/ADT/DepthFirstIterator.h"
  30 #include "llvm/ADT/STLExtras.h"
  31 #include "llvm/ADT/SmallPtrSet.h"
  32 #include "llvm/ADT/SmallSet.h"
  33 #include "llvm/ADT/SmallVector.h"
  34 #include "llvm/ADT/Statistic.h"
  35 #include "llvm/CodeGen/EdgeBundles.h"
  36 #include "llvm/CodeGen/MachineFunctionPass.h"
  37 #include "llvm/CodeGen/MachineInstrBuilder.h"
  38 #include "llvm/CodeGen/MachineRegisterInfo.h"
  39 #include "llvm/CodeGen/LivePhysRegs.h"
  40 #include "llvm/CodeGen/Passes.h"
  41 #include "llvm/IR/InlineAsm.h"
  42 #include "llvm/Support/Debug.h"
  43 #include "llvm/Support/ErrorHandling.h"
  44 #include "llvm/Support/raw_ostream.h"
  45 #include "llvm/Target/TargetInstrInfo.h"
  46 #include "llvm/Target/TargetMachine.h"
  47 #include <algorithm>
  48 using namespace llvm;
  49
  50 #define DEBUG_TYPE "x86-codegen"
  51
  52 STATISTIC(NumFXCH, "Number of fxch instructions inserted");
  53 STATISTIC(NumFP  , "Number of floating point instructions");
  54
  55 namespace {
  56   const unsigned ScratchFPReg = 7;
  57
  58   struct FPS : public MachineFunctionPass {
  59     static char ID;
  60     FPS() : MachineFunctionPass(ID) {
  61       initializeEdgeBundlesPass(*PassRegistry::getPassRegistry());
  62       // This is really only to keep valgrind quiet.
  63       // The logic in isLive() is too much for it.
  64       memset(Stack, 0, sizeof(Stack));
  65       memset(RegMap, 0, sizeof(RegMap));
  66     }
  67
  68     void getAnalysisUsage(AnalysisUsage &AU) const override {
  69       AU.setPreservesCFG();
  70       AU.addRequired<EdgeBundles>();
  71       AU.addPreservedID(MachineLoopInfoID);
  72       AU.addPreservedID(MachineDominatorsID);
  73       MachineFunctionPass::getAnalysisUsage(AU);
  74     }
  75
  76     bool runOnMachineFunction(MachineFunction &MF) override;
  77
  78     const char *getPassName() const override { return "X86 FP Stackifier"; }
  79
  80   private:
  81     const TargetInstrInfo *TII; // Machine instruction info.
  82
  83     // Two CFG edges are related if they leave the same block, or enter the same
  84     // block. The transitive closure of an edge under this relation is a
  85     // LiveBundle. It represents a set of CFG edges where the live FP stack
  86     // registers must be allocated identically in the x87 stack.
  87     //
  88     // A LiveBundle is usually all the edges leaving a block, or all the edges
  89     // entering a block, but it can contain more edges if critical edges are
  90     // present.
  91     //
  92     // The set of live FP registers in a LiveBundle is calculated by bundleCFG,
  93     // but the exact mapping of FP registers to stack slots is fixed later.
  94     struct LiveBundle {
  95       // Bit mask of live FP registers. Bit 0 = FP0, bit 1 = FP1, &c.
  96       unsigned Mask;
  97
  98       // Number of pre-assigned live registers in FixStack. This is 0 when the
  99       // stack order has not yet been fixed.
 100       unsigned FixCount;
 101
 102       // Assigned stack order for live-in registers.
 103       // FixStack[i] == getStackEntry(i) for all i < FixCount.
 104       unsigned char FixStack[8];
 105
 106       LiveBundle() : Mask(0), FixCount(0) {}
 107
 108       // Have the live registers been assigned a stack order yet?
 109       bool isFixed() const { return !Mask || FixCount; }
 110     };
 111
 112     // Numbered LiveBundle structs. LiveBundles[0] is used for all CFG edges
 113     // with no live FP registers.
 114     SmallVector<LiveBundle, 8> LiveBundles;
 115
 116     // The edge bundle analysis provides indices into the LiveBundles vector.
 117     EdgeBundles *Bundles;
 118
 119     // Return a bitmask of FP registers in block's live-in list.
 120     static unsigned calcLiveInMask(MachineBasicBlock *MBB) {
 121       unsigned Mask = 0;
 122       for (MachineBasicBlock::livein_iterator I = MBB->livein_begin(),
 123            E = MBB->livein_end(); I != E; ++I) {
 124         unsigned Reg = *I;
 125         if (Reg < X86::FP0 || Reg > X86::FP6)
 126           continue;
 127         Mask |= 1 << (Reg - X86::FP0);
 128       }
 129       return Mask;
 130     }
 131
 132     // Partition all the CFG edges into LiveBundles.
 133     void bundleCFG(MachineFunction &MF);
 134
 135     MachineBasicBlock *MBB;     // Current basic block
 136
 137     // The hardware keeps track of how many FP registers are live, so we have
 138     // to model that exactly. Usually, each live register corresponds to an
 139     // FP<n> register, but when dealing with calls, returns, and inline
 140     // assembly, it is sometimes necessary to have live scratch registers.
 141     unsigned Stack[8];          // FP<n> Registers in each stack slot...
 142     unsigned StackTop;          // The current top of the FP stack.
 143
 144     enum {
 145       NumFPRegs = 8             // Including scratch pseudo-registers.
 146     };
 147
 148     // For each live FP<n> register, point to its Stack[] entry.
 149     // The first entries correspond to FP0-FP6, the rest are scratch registers
 150     // used when we need slightly different live registers than what the
 151     // register allocator thinks.
 152     unsigned RegMap[NumFPRegs];
 153
 154     // Set up our stack model to match the incoming registers to MBB.
 155     void setupBlockStack();
 156
 157     // Shuffle live registers to match the expectations of successor blocks.
 158     void finishBlockStack();
 159
 160 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
 161     void dumpStack() const {
 162       dbgs() << "Stack contents:";
 163       for (unsigned i = 0; i != StackTop; ++i) {
 164         dbgs() << " FP" << Stack[i];
 165         assert(RegMap[Stack[i]] == i && "Stack[] doesn't match RegMap[]!");
 166       }
 167     }
 168 #endif
 169
 170     /// getSlot - Return the stack slot number a particular register number is
 171     /// in.
 172     unsigned getSlot(unsigned RegNo) const {
 173       assert(RegNo < NumFPRegs && "Regno out of range!");
 174       return RegMap[RegNo];
 175     }
 176
 177     /// isLive - Is RegNo currently live in the stack?
 178     bool isLive(unsigned RegNo) const {
 179       unsigned Slot = getSlot(RegNo);
 180       return Slot < StackTop && Stack[Slot] == RegNo;
 181     }
 182
 183     /// getStackEntry - Return the X86::FP<n> register in register ST(i).
 184     unsigned getStackEntry(unsigned STi) const {
 185       if (STi >= StackTop)
 186         report_fatal_error("Access past stack top!");
 187       return Stack[StackTop-1-STi];
 188     }
 189
 190     /// getSTReg - Return the X86::ST(i) register which contains the specified
 191     /// FP<RegNo> register.
 192     unsigned getSTReg(unsigned RegNo) const {
 193       return StackTop - 1 - getSlot(RegNo) + X86::ST0;
 194     }
 195
 196     // pushReg - Push the specified FP<n> register onto the stack.
 197     void pushReg(unsigned Reg) {
 198       assert(Reg < NumFPRegs && "Register number out of range!");
 199       if (StackTop >= 8)
 200         report_fatal_error("Stack overflow!");
 201       Stack[StackTop] = Reg;
 202       RegMap[Reg] = StackTop++;
 203     }
 204
 205     bool isAtTop(unsigned RegNo) const { return getSlot(RegNo) == StackTop-1; }
 206     void moveToTop(unsigned RegNo, MachineBasicBlock::iterator I) {
 207       DebugLoc dl = I == MBB->end() ? DebugLoc() : I->getDebugLoc();
 208       if (isAtTop(RegNo)) return;
 209
 210       unsigned STReg = getSTReg(RegNo);
 211       unsigned RegOnTop = getStackEntry(0);
 212
 213       // Swap the slots the regs are in.
 214       std::swap(RegMap[RegNo], RegMap[RegOnTop]);
 215
 216       // Swap stack slot contents.
 217       if (RegMap[RegOnTop] >= StackTop)
 218         report_fatal_error("Access past stack top!");
 219       std::swap(Stack[RegMap[RegOnTop]], Stack[StackTop-1]);
 220
 221       // Emit an fxch to update the runtime processors version of the state.
 222       BuildMI(*MBB, I, dl, TII->get(X86::XCH_F)).addReg(STReg);
 223       ++NumFXCH;
 224     }
 225
 226     void duplicateToTop(unsigned RegNo, unsigned AsReg, MachineInstr *I) {
 227       DebugLoc dl = I == MBB->end() ? DebugLoc() : I->getDebugLoc();
 228       unsigned STReg = getSTReg(RegNo);
 229       pushReg(AsReg);   // New register on top of stack
 230
 231       BuildMI(*MBB, I, dl, TII->get(X86::LD_Frr)).addReg(STReg);
 232     }
 233
 234     /// popStackAfter - Pop the current value off of the top of the FP stack
 235     /// after the specified instruction.
 236     void popStackAfter(MachineBasicBlock::iterator &I);
 237
 238     /// freeStackSlotAfter - Free the specified register from the register
 239     /// stack, so that it is no longer in a register.  If the register is
 240     /// currently at the top of the stack, we just pop the current instruction,
 241     /// otherwise we store the current top-of-stack into the specified slot,
 242     /// then pop the top of stack.
 243     void freeStackSlotAfter(MachineBasicBlock::iterator &I, unsigned Reg);
 244
 245     /// freeStackSlotBefore - Just the pop, no folding. Return the inserted
 246     /// instruction.
 247     MachineBasicBlock::iterator
 248     freeStackSlotBefore(MachineBasicBlock::iterator I, unsigned FPRegNo);
 249
 250     /// Adjust the live registers to be the set in Mask.
 251     void adjustLiveRegs(unsigned Mask, MachineBasicBlock::iterator I);
 252
 253     /// Shuffle the top FixCount stack entries such that FP reg FixStack[0] is
 254     /// st(0), FP reg FixStack[1] is st(1) etc.
 255     void shuffleStackTop(const unsigned char *FixStack, unsigned FixCount,
 256                          MachineBasicBlock::iterator I);
 257
 258     bool processBasicBlock(MachineFunction &MF, MachineBasicBlock &MBB);
 259
 260     void handleCall(MachineBasicBlock::iterator &I);
 261     void handleZeroArgFP(MachineBasicBlock::iterator &I);
 262     void handleOneArgFP(MachineBasicBlock::iterator &I);
 263     void handleOneArgFPRW(MachineBasicBlock::iterator &I);
 264     void handleTwoArgFP(MachineBasicBlock::iterator &I);
 265     void handleCompareFP(MachineBasicBlock::iterator &I);
 266     void handleCondMovFP(MachineBasicBlock::iterator &I);
 267     void handleSpecialFP(MachineBasicBlock::iterator &I);
 268
 269     // Check if a COPY instruction is using FP registers.
 270     static bool isFPCopy(MachineInstr *MI) {
 271       unsigned DstReg = MI->getOperand(0).getReg();
 272       unsigned SrcReg = MI->getOperand(1).getReg();
 273
 274       return X86::RFP80RegClass.contains(DstReg) ||
 275         X86::RFP80RegClass.contains(SrcReg);
 276     }
 277
 278     void setKillFlags(MachineBasicBlock &MBB) const;
 279   };
 280   char FPS::ID = 0;
 281 }
 282
 283 FunctionPass *llvm::createX86FloatingPointStackifierPass() { return new FPS(); }
 284
 285 /// getFPReg - Return the X86::FPx register number for the specified operand.
 286 /// For example, this returns 3 for X86::FP3.
 287 static unsigned getFPReg(const MachineOperand &MO) {
 288   assert(MO.isReg() && "Expected an FP register!");
 289   unsigned Reg = MO.getReg();
 290   assert(Reg >= X86::FP0 && Reg <= X86::FP6 && "Expected FP register!");
 291   return Reg - X86::FP0;
 292 }
 293
 294 /// runOnMachineFunction - Loop over all of the basic blocks, transforming FP
 295 /// register references into FP stack references.
 296 ///
 297 bool FPS::runOnMachineFunction(MachineFunction &MF) {
 298   // We only need to run this pass if there are any FP registers used in this
 299   // function.  If it is all integer, there is nothing for us to do!
 300   bool FPIsUsed = false;
 301
 302   assert(X86::FP6 == X86::FP0+6 && "Register enums aren't sorted right!");
 303   for (unsigned i = 0; i <= 6; ++i)
 304     if (MF.getRegInfo().isPhysRegUsed(X86::FP0+i)) {
 305       FPIsUsed = true;
 306       break;
 307     }
 308
 309   // Early exit.
 310   if (!FPIsUsed) return false;
 311
 312   Bundles = &getAnalysis<EdgeBundles>();
 313   TII = MF.getTarget().getInstrInfo();
 314
 315   // Prepare cross-MBB liveness.
 316   bundleCFG(MF);
 317
 318   StackTop = 0;
 319
 320   // Process the function in depth first order so that we process at least one
 321   // of the predecessors for every reachable block in the function.
 322   SmallPtrSet<MachineBasicBlock*, 8> Processed;
 323   MachineBasicBlock *Entry = MF.begin();
 324
 325   bool Changed = false;
 326   for (df_ext_iterator<MachineBasicBlock*, SmallPtrSet<MachineBasicBlock*, 8> >
 327          I = df_ext_begin(Entry, Processed), E = df_ext_end(Entry, Processed);
 328        I != E; ++I)
 329     Changed |= processBasicBlock(MF, **I);
 330
 331   // Process any unreachable blocks in arbitrary order now.
 332   if (MF.size() != Processed.size())
 333     for (MachineFunction::iterator BB = MF.begin(), E = MF.end(); BB != E; ++BB)
 334       if (Processed.insert(BB))
 335         Changed |= processBasicBlock(MF, *BB);
 336
 337   LiveBundles.clear();
 338
 339   return Changed;
 340 }
 341
 342 /// bundleCFG - Scan all the basic blocks to determine consistent live-in and
 343 /// live-out sets for the FP registers. Consistent means that the set of
 344 /// registers live-out from a block is identical to the live-in set of all
 345 /// successors. This is not enforced by the normal live-in lists since
 346 /// registers may be implicitly defined, or not used by all successors.
 347 void FPS::bundleCFG(MachineFunction &MF) {
 348   assert(LiveBundles.empty() && "Stale data in LiveBundles");
 349   LiveBundles.resize(Bundles->getNumBundles());
 350
 351   // Gather the actual live-in masks for all MBBs.
 352   for (MachineFunction::iterator I = MF.begin(), E = MF.end(); I != E; ++I) {
 353     MachineBasicBlock *MBB = I;
 354     const unsigned Mask = calcLiveInMask(MBB);
 355     if (!Mask)
 356       continue;
 357     // Update MBB ingoing bundle mask.
 358     LiveBundles[Bundles->getBundle(MBB->getNumber(), false)].Mask |= Mask;
 359   }
 360 }
 361
 362 /// processBasicBlock - Loop over all of the instructions in the basic block,
 363 /// transforming FP instructions into their stack form.
 364 ///
 365 bool FPS::processBasicBlock(MachineFunction &MF, MachineBasicBlock &BB) {
 366   bool Changed = false;
 367   MBB = &BB;
 368
 369   setKillFlags(BB);
 370   setupBlockStack();
 371
 372   for (MachineBasicBlock::iterator I = BB.begin(); I != BB.end(); ++I) {
 373     MachineInstr *MI = I;
 374     uint64_t Flags = MI->getDesc().TSFlags;
 375
 376     unsigned FPInstClass = Flags & X86II::FPTypeMask;
 377     if (MI->isInlineAsm())
 378       FPInstClass = X86II::SpecialFP;
 379
 380     if (MI->isCopy() && isFPCopy(MI))
 381       FPInstClass = X86II::SpecialFP;
 382
 383     if (MI->isImplicitDef() &&
 384         X86::RFP80RegClass.contains(MI->getOperand(0).getReg()))
 385       FPInstClass = X86II::SpecialFP;
 386
 387     if (MI->isCall())
 388       FPInstClass = X86II::SpecialFP;
 389
 390     if (FPInstClass == X86II::NotFP)
 391       continue;  // Efficiently ignore non-fp insts!
 392
 393     MachineInstr *PrevMI = nullptr;
 394     if (I != BB.begin())
 395       PrevMI = std::prev(I);
 396
 397     ++NumFP;  // Keep track of # of pseudo instrs
 398     DEBUG(dbgs() << "\nFPInst:\t" << *MI);
 399
 400     // Get dead variables list now because the MI pointer may be deleted as part
 401     // of processing!
 402     SmallVector<unsigned, 8> DeadRegs;
 403     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 404       const MachineOperand &MO = MI->getOperand(i);
 405       if (MO.isReg() && MO.isDead())
 406         DeadRegs.push_back(MO.getReg());
 407     }
 408
 409     switch (FPInstClass) {
 410     case X86II::ZeroArgFP:  handleZeroArgFP(I); break;
 411     case X86II::OneArgFP:   handleOneArgFP(I);  break;  // fstp ST(0)
 412     case X86II::OneArgFPRW: handleOneArgFPRW(I); break; // ST(0) = fsqrt(ST(0))
 413     case X86II::TwoArgFP:   handleTwoArgFP(I);  break;
 414     case X86II::CompareFP:  handleCompareFP(I); break;
 415     case X86II::CondMovFP:  handleCondMovFP(I); break;
 416     case X86II::SpecialFP:  handleSpecialFP(I); break;
 417     default: llvm_unreachable("Unknown FP Type!");
 418     }
 419
 420     // Check to see if any of the values defined by this instruction are dead
 421     // after definition.  If so, pop them.
 422     for (unsigned i = 0, e = DeadRegs.size(); i != e; ++i) {
 423       unsigned Reg = DeadRegs[i];
 424       // Check if Reg is live on the stack. An inline-asm register operand that
 425       // is in the clobber list and marked dead might not be live on the stack.
 426       if (Reg >= X86::FP0 && Reg <= X86::FP6 && isLive(Reg-X86::FP0)) {
 427         DEBUG(dbgs() << "Register FP#" << Reg-X86::FP0 << " is dead!\n");
 428         freeStackSlotAfter(I, Reg-X86::FP0);
 429       }
 430     }
 431
 432     // Print out all of the instructions expanded to if -debug
 433     DEBUG(
 434       MachineBasicBlock::iterator PrevI(PrevMI);
 435       if (I == PrevI) {
 436         dbgs() << "Just deleted pseudo instruction\n";
 437       } else {
 438         MachineBasicBlock::iterator Start = I;
 439         // Rewind to first instruction newly inserted.
 440         while (Start != BB.begin() && std::prev(Start) != PrevI) --Start;
 441         dbgs() << "Inserted instructions:\n\t";
 442         Start->print(dbgs(), &MF.getTarget());
 443         while (++Start != std::next(I)) {}
 444       }
 445       dumpStack();
 446     );
 447     (void)PrevMI;
 448
 449     Changed = true;
 450   }
 451
 452   finishBlockStack();
 453
 454   return Changed;
 455 }
 456
 457 /// setupBlockStack - Use the live bundles to set up our model of the stack
 458 /// to match predecessors' live out stack.
 459 void FPS::setupBlockStack() {
 460   DEBUG(dbgs() << "\nSetting up live-ins for BB#" << MBB->getNumber()
 461                << " derived from " << MBB->getName() << ".\n");
 462   StackTop = 0;
 463   // Get the live-in bundle for MBB.
 464   const LiveBundle &Bundle =
 465     LiveBundles[Bundles->getBundle(MBB->getNumber(), false)];
 466
 467   if (!Bundle.Mask) {
 468     DEBUG(dbgs() << "Block has no FP live-ins.\n");
 469     return;
 470   }
 471
 472   // Depth-first iteration should ensure that we always have an assigned stack.
 473   assert(Bundle.isFixed() && "Reached block before any predecessors");
 474
 475   // Push the fixed live-in registers.
 476   for (unsigned i = Bundle.FixCount; i > 0; --i) {
 477     MBB->addLiveIn(X86::ST0+i-1);
 478     DEBUG(dbgs() << "Live-in st(" << (i-1) << "): %FP"
 479                  << unsigned(Bundle.FixStack[i-1]) << '\n');
 480     pushReg(Bundle.FixStack[i-1]);
 481   }
 482
 483   // Kill off unwanted live-ins. This can happen with a critical edge.
 484   // FIXME: We could keep these live registers around as zombies. They may need
 485   // to be revived at the end of a short block. It might save a few instrs.
 486   adjustLiveRegs(calcLiveInMask(MBB), MBB->begin());
 487   DEBUG(MBB->dump());
 488 }
 489
 490 /// finishBlockStack - Revive live-outs that are implicitly defined out of
 491 /// MBB. Shuffle live registers to match the expected fixed stack of any
 492 /// predecessors, and ensure that all predecessors are expecting the same
 493 /// stack.
 494 void FPS::finishBlockStack() {
 495   // The RET handling below takes care of return blocks for us.
 496   if (MBB->succ_empty())
 497     return;
 498
 499   DEBUG(dbgs() << "Setting up live-outs for BB#" << MBB->getNumber()
 500                << " derived from " << MBB->getName() << ".\n");
 501
 502   // Get MBB's live-out bundle.
 503   unsigned BundleIdx = Bundles->getBundle(MBB->getNumber(), true);
 504   LiveBundle &Bundle = LiveBundles[BundleIdx];
 505
 506   // We may need to kill and define some registers to match successors.
 507   // FIXME: This can probably be combined with the shuffle below.
 508   MachineBasicBlock::iterator Term = MBB->getFirstTerminator();
 509   adjustLiveRegs(Bundle.Mask, Term);
 510
 511   if (!Bundle.Mask) {
 512     DEBUG(dbgs() << "No live-outs.\n");
 513     return;
 514   }
 515
 516   // Has the stack order been fixed yet?
 517   DEBUG(dbgs() << "LB#" << BundleIdx << ": ");
 518   if (Bundle.isFixed()) {
 519     DEBUG(dbgs() << "Shuffling stack to match.\n");
 520     shuffleStackTop(Bundle.FixStack, Bundle.FixCount, Term);
 521   } else {
 522     // Not fixed yet, we get to choose.
 523     DEBUG(dbgs() << "Fixing stack order now.\n");
 524     Bundle.FixCount = StackTop;
 525     for (unsigned i = 0; i < StackTop; ++i)
 526       Bundle.FixStack[i] = getStackEntry(i);
 527   }
 528 }
 529
 530
 531 //===----------------------------------------------------------------------===//
 532 // Efficient Lookup Table Support
 533 //===----------------------------------------------------------------------===//
 534
 535 namespace {
 536   struct TableEntry {
 537     uint16_t from;
 538     uint16_t to;
 539     bool operator<(const TableEntry &TE) const { return from < TE.from; }
 540     friend bool operator<(const TableEntry &TE, unsigned V) {
 541       return TE.from < V;
 542     }
 543     friend bool LLVM_ATTRIBUTE_UNUSED operator<(unsigned V,
 544                                                 const TableEntry &TE) {
 545       return V < TE.from;
 546     }
 547   };
 548 }
 549
 550 #ifndef NDEBUG
 551 static bool TableIsSorted(const TableEntry *Table, unsigned NumEntries) {
 552   for (unsigned i = 0; i != NumEntries-1; ++i)
 553     if (!(Table[i] < Table[i+1])) return false;
 554   return true;
 555 }
 556 #endif
 557
 558 static int Lookup(const TableEntry *Table, unsigned N, unsigned Opcode) {
 559   const TableEntry *I = std::lower_bound(Table, Table+N, Opcode);
 560   if (I != Table+N && I->from == Opcode)
 561     return I->to;
 562   return -1;
 563 }
 564
 565 #ifdef NDEBUG
 566 #define ASSERT_SORTED(TABLE)
 567 #else
 568 #define ASSERT_SORTED(TABLE)                                              \
 569   { static bool TABLE##Checked = false;                                   \
 570     if (!TABLE##Checked) {                                                \
 571        assert(TableIsSorted(TABLE, array_lengthof(TABLE)) &&              \
 572               "All lookup tables must be sorted for efficient access!");  \
 573        TABLE##Checked = true;                                             \
 574     }                                                                     \
 575   }
 576 #endif
 577
 578 //===----------------------------------------------------------------------===//
 579 // Register File -> Register Stack Mapping Methods
 580 //===----------------------------------------------------------------------===//
 581
 582 // OpcodeTable - Sorted map of register instructions to their stack version.
 583 // The first element is an register file pseudo instruction, the second is the
 584 // concrete X86 instruction which uses the register stack.
 585 //
 586 static const TableEntry OpcodeTable[] = {
 587   { X86::ABS_Fp32     , X86::ABS_F     },
 588   { X86::ABS_Fp64     , X86::ABS_F     },
 589   { X86::ABS_Fp80     , X86::ABS_F     },
 590   { X86::ADD_Fp32m    , X86::ADD_F32m  },
 591   { X86::ADD_Fp64m    , X86::ADD_F64m  },
 592   { X86::ADD_Fp64m32  , X86::ADD_F32m  },
 593   { X86::ADD_Fp80m32  , X86::ADD_F32m  },
 594   { X86::ADD_Fp80m64  , X86::ADD_F64m  },
 595   { X86::ADD_FpI16m32 , X86::ADD_FI16m },
 596   { X86::ADD_FpI16m64 , X86::ADD_FI16m },
 597   { X86::ADD_FpI16m80 , X86::ADD_FI16m },
 598   { X86::ADD_FpI32m32 , X86::ADD_FI32m },
 599   { X86::ADD_FpI32m64 , X86::ADD_FI32m },
 600   { X86::ADD_FpI32m80 , X86::ADD_FI32m },
 601   { X86::CHS_Fp32     , X86::CHS_F     },
 602   { X86::CHS_Fp64     , X86::CHS_F     },
 603   { X86::CHS_Fp80     , X86::CHS_F     },
 604   { X86::CMOVBE_Fp32  , X86::CMOVBE_F  },
 605   { X86::CMOVBE_Fp64  , X86::CMOVBE_F  },
 606   { X86::CMOVBE_Fp80  , X86::CMOVBE_F  },
 607   { X86::CMOVB_Fp32   , X86::CMOVB_F   },
 608   { X86::CMOVB_Fp64   , X86::CMOVB_F  },
 609   { X86::CMOVB_Fp80   , X86::CMOVB_F  },
 610   { X86::CMOVE_Fp32   , X86::CMOVE_F  },
 611   { X86::CMOVE_Fp64   , X86::CMOVE_F   },
 612   { X86::CMOVE_Fp80   , X86::CMOVE_F   },
 613   { X86::CMOVNBE_Fp32 , X86::CMOVNBE_F },
 614   { X86::CMOVNBE_Fp64 , X86::CMOVNBE_F },
 615   { X86::CMOVNBE_Fp80 , X86::CMOVNBE_F },
 616   { X86::CMOVNB_Fp32  , X86::CMOVNB_F  },
 617   { X86::CMOVNB_Fp64  , X86::CMOVNB_F  },
 618   { X86::CMOVNB_Fp80  , X86::CMOVNB_F  },
 619   { X86::CMOVNE_Fp32  , X86::CMOVNE_F  },
 620   { X86::CMOVNE_Fp64  , X86::CMOVNE_F  },
 621   { X86::CMOVNE_Fp80  , X86::CMOVNE_F  },
 622   { X86::CMOVNP_Fp32  , X86::CMOVNP_F  },
 623   { X86::CMOVNP_Fp64  , X86::CMOVNP_F  },
 624   { X86::CMOVNP_Fp80  , X86::CMOVNP_F  },
 625   { X86::CMOVP_Fp32   , X86::CMOVP_F   },
 626   { X86::CMOVP_Fp64   , X86::CMOVP_F   },
 627   { X86::CMOVP_Fp80   , X86::CMOVP_F   },
 628   { X86::COS_Fp32     , X86::COS_F     },
 629   { X86::COS_Fp64     , X86::COS_F     },
 630   { X86::COS_Fp80     , X86::COS_F     },
 631   { X86::DIVR_Fp32m   , X86::DIVR_F32m },
 632   { X86::DIVR_Fp64m   , X86::DIVR_F64m },
 633   { X86::DIVR_Fp64m32 , X86::DIVR_F32m },
 634   { X86::DIVR_Fp80m32 , X86::DIVR_F32m },
 635   { X86::DIVR_Fp80m64 , X86::DIVR_F64m },
 636   { X86::DIVR_FpI16m32, X86::DIVR_FI16m},
 637   { X86::DIVR_FpI16m64, X86::DIVR_FI16m},
 638   { X86::DIVR_FpI16m80, X86::DIVR_FI16m},
 639   { X86::DIVR_FpI32m32, X86::DIVR_FI32m},
 640   { X86::DIVR_FpI32m64, X86::DIVR_FI32m},
 641   { X86::DIVR_FpI32m80, X86::DIVR_FI32m},
 642   { X86::DIV_Fp32m    , X86::DIV_F32m  },
 643   { X86::DIV_Fp64m    , X86::DIV_F64m  },
 644   { X86::DIV_Fp64m32  , X86::DIV_F32m  },
 645   { X86::DIV_Fp80m32  , X86::DIV_F32m  },
 646   { X86::DIV_Fp80m64  , X86::DIV_F64m  },
 647   { X86::DIV_FpI16m32 , X86::DIV_FI16m },
 648   { X86::DIV_FpI16m64 , X86::DIV_FI16m },
 649   { X86::DIV_FpI16m80 , X86::DIV_FI16m },
 650   { X86::DIV_FpI32m32 , X86::DIV_FI32m },
 651   { X86::DIV_FpI32m64 , X86::DIV_FI32m },
 652   { X86::DIV_FpI32m80 , X86::DIV_FI32m },
 653   { X86::ILD_Fp16m32  , X86::ILD_F16m  },
 654   { X86::ILD_Fp16m64  , X86::ILD_F16m  },
 655   { X86::ILD_Fp16m80  , X86::ILD_F16m  },
 656   { X86::ILD_Fp32m32  , X86::ILD_F32m  },
 657   { X86::ILD_Fp32m64  , X86::ILD_F32m  },
 658   { X86::ILD_Fp32m80  , X86::ILD_F32m  },
 659   { X86::ILD_Fp64m32  , X86::ILD_F64m  },
 660   { X86::ILD_Fp64m64  , X86::ILD_F64m  },
 661   { X86::ILD_Fp64m80  , X86::ILD_F64m  },
 662   { X86::ISTT_Fp16m32 , X86::ISTT_FP16m},
 663   { X86::ISTT_Fp16m64 , X86::ISTT_FP16m},
 664   { X86::ISTT_Fp16m80 , X86::ISTT_FP16m},
 665   { X86::ISTT_Fp32m32 , X86::ISTT_FP32m},
 666   { X86::ISTT_Fp32m64 , X86::ISTT_FP32m},
 667   { X86::ISTT_Fp32m80 , X86::ISTT_FP32m},
 668   { X86::ISTT_Fp64m32 , X86::ISTT_FP64m},
 669   { X86::ISTT_Fp64m64 , X86::ISTT_FP64m},
 670   { X86::ISTT_Fp64m80 , X86::ISTT_FP64m},
 671   { X86::IST_Fp16m32  , X86::IST_F16m  },
 672   { X86::IST_Fp16m64  , X86::IST_F16m  },
 673   { X86::IST_Fp16m80  , X86::IST_F16m  },
 674   { X86::IST_Fp32m32  , X86::IST_F32m  },
 675   { X86::IST_Fp32m64  , X86::IST_F32m  },
 676   { X86::IST_Fp32m80  , X86::IST_F32m  },
 677   { X86::IST_Fp64m32  , X86::IST_FP64m },
 678   { X86::IST_Fp64m64  , X86::IST_FP64m },
 679   { X86::IST_Fp64m80  , X86::IST_FP64m },
 680   { X86::LD_Fp032     , X86::LD_F0     },
 681   { X86::LD_Fp064     , X86::LD_F0     },
 682   { X86::LD_Fp080     , X86::LD_F0     },
 683   { X86::LD_Fp132     , X86::LD_F1     },
 684   { X86::LD_Fp164     , X86::LD_F1     },
 685   { X86::LD_Fp180     , X86::LD_F1     },
 686   { X86::LD_Fp32m     , X86::LD_F32m   },
 687   { X86::LD_Fp32m64   , X86::LD_F32m   },
 688   { X86::LD_Fp32m80   , X86::LD_F32m   },
 689   { X86::LD_Fp64m     , X86::LD_F64m   },
 690   { X86::LD_Fp64m80   , X86::LD_F64m   },
 691   { X86::LD_Fp80m     , X86::LD_F80m   },
 692   { X86::MUL_Fp32m    , X86::MUL_F32m  },
 693   { X86::MUL_Fp64m    , X86::MUL_F64m  },
 694   { X86::MUL_Fp64m32  , X86::MUL_F32m  },
 695   { X86::MUL_Fp80m32  , X86::MUL_F32m  },
 696   { X86::MUL_Fp80m64  , X86::MUL_F64m  },
 697   { X86::MUL_FpI16m32 , X86::MUL_FI16m },
 698   { X86::MUL_FpI16m64 , X86::MUL_FI16m },
 699   { X86::MUL_FpI16m80 , X86::MUL_FI16m },
 700   { X86::MUL_FpI32m32 , X86::MUL_FI32m },
 701   { X86::MUL_FpI32m64 , X86::MUL_FI32m },
 702   { X86::MUL_FpI32m80 , X86::MUL_FI32m },
 703   { X86::SIN_Fp32     , X86::SIN_F     },
 704   { X86::SIN_Fp64     , X86::SIN_F     },
 705   { X86::SIN_Fp80     , X86::SIN_F     },
 706   { X86::SQRT_Fp32    , X86::SQRT_F    },
 707   { X86::SQRT_Fp64    , X86::SQRT_F    },
 708   { X86::SQRT_Fp80    , X86::SQRT_F    },
 709   { X86::ST_Fp32m     , X86::ST_F32m   },
 710   { X86::ST_Fp64m     , X86::ST_F64m   },
 711   { X86::ST_Fp64m32   , X86::ST_F32m   },
 712   { X86::ST_Fp80m32   , X86::ST_F32m   },
 713   { X86::ST_Fp80m64   , X86::ST_F64m   },
 714   { X86::ST_FpP80m    , X86::ST_FP80m  },
 715   { X86::SUBR_Fp32m   , X86::SUBR_F32m },
 716   { X86::SUBR_Fp64m   , X86::SUBR_F64m },
 717   { X86::SUBR_Fp64m32 , X86::SUBR_F32m },
 718   { X86::SUBR_Fp80m32 , X86::SUBR_F32m },
 719   { X86::SUBR_Fp80m64 , X86::SUBR_F64m },
 720   { X86::SUBR_FpI16m32, X86::SUBR_FI16m},
 721   { X86::SUBR_FpI16m64, X86::SUBR_FI16m},
 722   { X86::SUBR_FpI16m80, X86::SUBR_FI16m},
 723   { X86::SUBR_FpI32m32, X86::SUBR_FI32m},
 724   { X86::SUBR_FpI32m64, X86::SUBR_FI32m},
 725   { X86::SUBR_FpI32m80, X86::SUBR_FI32m},
 726   { X86::SUB_Fp32m    , X86::SUB_F32m  },
 727   { X86::SUB_Fp64m    , X86::SUB_F64m  },
 728   { X86::SUB_Fp64m32  , X86::SUB_F32m  },
 729   { X86::SUB_Fp80m32  , X86::SUB_F32m  },
 730   { X86::SUB_Fp80m64  , X86::SUB_F64m  },
 731   { X86::SUB_FpI16m32 , X86::SUB_FI16m },
 732   { X86::SUB_FpI16m64 , X86::SUB_FI16m },
 733   { X86::SUB_FpI16m80 , X86::SUB_FI16m },
 734   { X86::SUB_FpI32m32 , X86::SUB_FI32m },
 735   { X86::SUB_FpI32m64 , X86::SUB_FI32m },
 736   { X86::SUB_FpI32m80 , X86::SUB_FI32m },
 737   { X86::TST_Fp32     , X86::TST_F     },
 738   { X86::TST_Fp64     , X86::TST_F     },
 739   { X86::TST_Fp80     , X86::TST_F     },
 740   { X86::UCOM_FpIr32  , X86::UCOM_FIr  },
 741   { X86::UCOM_FpIr64  , X86::UCOM_FIr  },
 742   { X86::UCOM_FpIr80  , X86::UCOM_FIr  },
 743   { X86::UCOM_Fpr32   , X86::UCOM_Fr   },
 744   { X86::UCOM_Fpr64   , X86::UCOM_Fr   },
 745   { X86::UCOM_Fpr80   , X86::UCOM_Fr   },
 746 };
 747
 748 static unsigned getConcreteOpcode(unsigned Opcode) {
 749   ASSERT_SORTED(OpcodeTable);
 750   int Opc = Lookup(OpcodeTable, array_lengthof(OpcodeTable), Opcode);
 751   assert(Opc != -1 && "FP Stack instruction not in OpcodeTable!");
 752   return Opc;
 753 }
 754
 755 //===----------------------------------------------------------------------===//
 756 // Helper Methods
 757 //===----------------------------------------------------------------------===//
 758
 759 // PopTable - Sorted map of instructions to their popping version.  The first
 760 // element is an instruction, the second is the version which pops.
 761 //
 762 static const TableEntry PopTable[] = {
 763   { X86::ADD_FrST0 , X86::ADD_FPrST0  },
 764
 765   { X86::DIVR_FrST0, X86::DIVR_FPrST0 },
 766   { X86::DIV_FrST0 , X86::DIV_FPrST0  },
 767
 768   { X86::IST_F16m  , X86::IST_FP16m   },
 769   { X86::IST_F32m  , X86::IST_FP32m   },
 770
 771   { X86::MUL_FrST0 , X86::MUL_FPrST0  },
 772
 773   { X86::ST_F32m   , X86::ST_FP32m    },
 774   { X86::ST_F64m   , X86::ST_FP64m    },
 775   { X86::ST_Frr    , X86::ST_FPrr     },
 776
 777   { X86::SUBR_FrST0, X86::SUBR_FPrST0 },
 778   { X86::SUB_FrST0 , X86::SUB_FPrST0  },
 779
 780   { X86::UCOM_FIr  , X86::UCOM_FIPr   },
 781
 782   { X86::UCOM_FPr  , X86::UCOM_FPPr   },
 783   { X86::UCOM_Fr   , X86::UCOM_FPr    },
 784 };
 785
 786 /// popStackAfter - Pop the current value off of the top of the FP stack after
 787 /// the specified instruction.  This attempts to be sneaky and combine the pop
 788 /// into the instruction itself if possible.  The iterator is left pointing to
 789 /// the last instruction, be it a new pop instruction inserted, or the old
 790 /// instruction if it was modified in place.
 791 ///
 792 void FPS::popStackAfter(MachineBasicBlock::iterator &I) {
 793   MachineInstr* MI = I;
 794   DebugLoc dl = MI->getDebugLoc();
 795   ASSERT_SORTED(PopTable);
 796   if (StackTop == 0)
 797     report_fatal_error("Cannot pop empty stack!");
 798   RegMap[Stack[--StackTop]] = ~0;     // Update state
 799
 800   // Check to see if there is a popping version of this instruction...
 801   int Opcode = Lookup(PopTable, array_lengthof(PopTable), I->getOpcode());
 802   if (Opcode != -1) {
 803     I->setDesc(TII->get(Opcode));
 804     if (Opcode == X86::UCOM_FPPr)
 805       I->RemoveOperand(0);
 806   } else {    // Insert an explicit pop
 807     I = BuildMI(*MBB, ++I, dl, TII->get(X86::ST_FPrr)).addReg(X86::ST0);
 808   }
 809 }
 810
 811 /// freeStackSlotAfter - Free the specified register from the register stack, so
 812 /// that it is no longer in a register.  If the register is currently at the top
 813 /// of the stack, we just pop the current instruction, otherwise we store the
 814 /// current top-of-stack into the specified slot, then pop the top of stack.
 815 void FPS::freeStackSlotAfter(MachineBasicBlock::iterator &I, unsigned FPRegNo) {
 816   if (getStackEntry(0) == FPRegNo) {  // already at the top of stack? easy.
 817     popStackAfter(I);
 818     return;
 819   }
 820
 821   // Otherwise, store the top of stack into the dead slot, killing the operand
 822   // without having to add in an explicit xchg then pop.
 823   //
 824   I = freeStackSlotBefore(++I, FPRegNo);
 825 }
 826
 827 /// freeStackSlotBefore - Free the specified register without trying any
 828 /// folding.
 829 MachineBasicBlock::iterator
 830 FPS::freeStackSlotBefore(MachineBasicBlock::iterator I, unsigned FPRegNo) {
 831   unsigned STReg    = getSTReg(FPRegNo);
 832   unsigned OldSlot  = getSlot(FPRegNo);
 833   unsigned TopReg   = Stack[StackTop-1];
 834   Stack[OldSlot]    = TopReg;
 835   RegMap[TopReg]    = OldSlot;
 836   RegMap[FPRegNo]   = ~0;
 837   Stack[--StackTop] = ~0;
 838   return BuildMI(*MBB, I, DebugLoc(), TII->get(X86::ST_FPrr)).addReg(STReg);
 839 }
 840
 841 /// adjustLiveRegs - Kill and revive registers such that exactly the FP
 842 /// registers with a bit in Mask are live.
 843 void FPS::adjustLiveRegs(unsigned Mask, MachineBasicBlock::iterator I) {
 844   unsigned Defs = Mask;
 845   unsigned Kills = 0;
 846   for (unsigned i = 0; i < StackTop; ++i) {
 847     unsigned RegNo = Stack[i];
 848     if (!(Defs & (1 << RegNo)))
 849       // This register is live, but we don't want it.
 850       Kills |= (1 << RegNo);
 851     else
 852       // We don't need to imp-def this live register.
 853       Defs &= ~(1 << RegNo);
 854   }
 855   assert((Kills & Defs) == 0 && "Register needs killing and def'ing?");
 856
 857   // Produce implicit-defs for free by using killed registers.
 858   while (Kills && Defs) {
 859     unsigned KReg = countTrailingZeros(Kills);
 860     unsigned DReg = countTrailingZeros(Defs);
 861     DEBUG(dbgs() << "Renaming %FP" << KReg << " as imp %FP" << DReg << "\n");
 862     std::swap(Stack[getSlot(KReg)], Stack[getSlot(DReg)]);
 863     std::swap(RegMap[KReg], RegMap[DReg]);
 864     Kills &= ~(1 << KReg);
 865     Defs &= ~(1 << DReg);
 866   }
 867
 868   // Kill registers by popping.
 869   if (Kills && I != MBB->begin()) {
 870     MachineBasicBlock::iterator I2 = std::prev(I);
 871     while (StackTop) {
 872       unsigned KReg = getStackEntry(0);
 873       if (!(Kills & (1 << KReg)))
 874         break;
 875       DEBUG(dbgs() << "Popping %FP" << KReg << "\n");
 876       popStackAfter(I2);
 877       Kills &= ~(1 << KReg);
 878     }
 879   }
 880
 881   // Manually kill the rest.
 882   while (Kills) {
 883     unsigned KReg = countTrailingZeros(Kills);
 884     DEBUG(dbgs() << "Killing %FP" << KReg << "\n");
 885     freeStackSlotBefore(I, KReg);
 886     Kills &= ~(1 << KReg);
 887   }
 888
 889   // Load zeros for all the imp-defs.
 890   while(Defs) {
 891     unsigned DReg = countTrailingZeros(Defs);
 892     DEBUG(dbgs() << "Defining %FP" << DReg << " as 0\n");
 893     BuildMI(*MBB, I, DebugLoc(), TII->get(X86::LD_F0));
 894     pushReg(DReg);
 895     Defs &= ~(1 << DReg);
 896   }
 897
 898   // Now we should have the correct registers live.
 899   DEBUG(dumpStack());
 900   assert(StackTop == CountPopulation_32(Mask) && "Live count mismatch");
 901 }
 902
 903 /// shuffleStackTop - emit fxch instructions before I to shuffle the top
 904 /// FixCount entries into the order given by FixStack.
 905 /// FIXME: Is there a better algorithm than insertion sort?
 906 void FPS::shuffleStackTop(const unsigned char *FixStack,
 907                           unsigned FixCount,
 908                           MachineBasicBlock::iterator I) {
 909   // Move items into place, starting from the desired stack bottom.
 910   while (FixCount--) {
 911     // Old register at position FixCount.
 912     unsigned OldReg = getStackEntry(FixCount);
 913     // Desired register at position FixCount.
 914     unsigned Reg = FixStack[FixCount];
 915     if (Reg == OldReg)
 916       continue;
 917     // (Reg st0) (OldReg st0) = (Reg OldReg st0)
 918     moveToTop(Reg, I);
 919     if (FixCount > 0)
 920       moveToTop(OldReg, I);
 921   }
 922   DEBUG(dumpStack());
 923 }
 924
 925
 926 //===----------------------------------------------------------------------===//
 927 // Instruction transformation implementation
 928 //===----------------------------------------------------------------------===//
 929
 930 void FPS::handleCall(MachineBasicBlock::iterator &I) {
 931   unsigned STReturns = 0;
 932
 933   for (const auto &MO : I->operands()) {
 934     if (!MO.isReg())
 935       continue;
 936
 937     unsigned R = MO.getReg() - X86::FP0;
 938
 939     if (R < 8) {
 940       assert(MO.isDef() && MO.isImplicit());
 941       STReturns |= 1 << R;
 942     }
 943   }
 944
 945   unsigned N = CountTrailingOnes_32(STReturns);
 946
 947   // FP registers used for function return must be consecutive starting at
 948   // FP0.
 949   assert((STReturns == 0 || isMask_32(STReturns)) && N <= 2);
 950
 951   for (unsigned I = 0; I < N; ++I)
 952     pushReg(N - I - 1);
 953 }
 954
 955 /// handleZeroArgFP - ST(0) = fld0    ST(0) = flds <mem>
 956 ///
 957 void FPS::handleZeroArgFP(MachineBasicBlock::iterator &I) {
 958   MachineInstr *MI = I;
 959   unsigned DestReg = getFPReg(MI->getOperand(0));
 960
 961   // Change from the pseudo instruction to the concrete instruction.
 962   MI->RemoveOperand(0);   // Remove the explicit ST(0) operand
 963   MI->setDesc(TII->get(getConcreteOpcode(MI->getOpcode())));
 964
 965   // Result gets pushed on the stack.
 966   pushReg(DestReg);
 967 }
 968
 969 /// handleOneArgFP - fst <mem>, ST(0)
 970 ///
 971 void FPS::handleOneArgFP(MachineBasicBlock::iterator &I) {
 972   MachineInstr *MI = I;
 973   unsigned NumOps = MI->getDesc().getNumOperands();
 974   assert((NumOps == X86::AddrNumOperands + 1 || NumOps == 1) &&
 975          "Can only handle fst* & ftst instructions!");
 976
 977   // Is this the last use of the source register?
 978   unsigned Reg = getFPReg(MI->getOperand(NumOps-1));
 979   bool KillsSrc = MI->killsRegister(X86::FP0+Reg);
 980
 981   // FISTP64m is strange because there isn't a non-popping versions.
 982   // If we have one _and_ we don't want to pop the operand, duplicate the value
 983   // on the stack instead of moving it.  This ensure that popping the value is
 984   // always ok.
 985   // Ditto FISTTP16m, FISTTP32m, FISTTP64m, ST_FpP80m.
 986   //
 987   if (!KillsSrc &&
 988       (MI->getOpcode() == X86::IST_Fp64m32 ||
 989        MI->getOpcode() == X86::ISTT_Fp16m32 ||
 990        MI->getOpcode() == X86::ISTT_Fp32m32 ||
 991        MI->getOpcode() == X86::ISTT_Fp64m32 ||
 992        MI->getOpcode() == X86::IST_Fp64m64 ||
 993        MI->getOpcode() == X86::ISTT_Fp16m64 ||
 994        MI->getOpcode() == X86::ISTT_Fp32m64 ||
 995        MI->getOpcode() == X86::ISTT_Fp64m64 ||
 996        MI->getOpcode() == X86::IST_Fp64m80 ||
 997        MI->getOpcode() == X86::ISTT_Fp16m80 ||
 998        MI->getOpcode() == X86::ISTT_Fp32m80 ||
 999        MI->getOpcode() == X86::ISTT_Fp64m80 ||
1000        MI->getOpcode() == X86::ST_FpP80m)) {
1001     duplicateToTop(Reg, ScratchFPReg, I);
1002   } else {
1003     moveToTop(Reg, I);            // Move to the top of the stack...
1004   }
1005
1006   // Convert from the pseudo instruction to the concrete instruction.
1007   MI->RemoveOperand(NumOps-1);    // Remove explicit ST(0) operand
1008   MI->setDesc(TII->get(getConcreteOpcode(MI->getOpcode())));
1009
1010   if (MI->getOpcode() == X86::IST_FP64m ||
1011       MI->getOpcode() == X86::ISTT_FP16m ||
1012       MI->getOpcode() == X86::ISTT_FP32m ||
1013       MI->getOpcode() == X86::ISTT_FP64m ||
1014       MI->getOpcode() == X86::ST_FP80m) {
1015     if (StackTop == 0)
1016       report_fatal_error("Stack empty??");
1017     --StackTop;
1018   } else if (KillsSrc) { // Last use of operand?
1019     popStackAfter(I);
1020   }
1021 }
1022
1023
1024 /// handleOneArgFPRW: Handle instructions that read from the top of stack and
1025 /// replace the value with a newly computed value.  These instructions may have
1026 /// non-fp operands after their FP operands.
1027 ///
1028 ///  Examples:
1029 ///     R1 = fchs R2
1030 ///     R1 = fadd R2, [mem]
1031 ///
1032 void FPS::handleOneArgFPRW(MachineBasicBlock::iterator &I) {
1033   MachineInstr *MI = I;
1034 #ifndef NDEBUG
1035   unsigned NumOps = MI->getDesc().getNumOperands();
1036   assert(NumOps >= 2 && "FPRW instructions must have 2 ops!!");
1037 #endif
1038
1039   // Is this the last use of the source register?
1040   unsigned Reg = getFPReg(MI->getOperand(1));
1041   bool KillsSrc = MI->killsRegister(X86::FP0+Reg);
1042
1043   if (KillsSrc) {
1044     // If this is the last use of the source register, just make sure it's on
1045     // the top of the stack.
1046     moveToTop(Reg, I);
1047     if (StackTop == 0)
1048       report_fatal_error("Stack cannot be empty!");
1049     --StackTop;
1050     pushReg(getFPReg(MI->getOperand(0)));
1051   } else {
1052     // If this is not the last use of the source register, _copy_ it to the top
1053     // of the stack.
1054     duplicateToTop(Reg, getFPReg(MI->getOperand(0)), I);
1055   }
1056
1057   // Change from the pseudo instruction to the concrete instruction.
1058   MI->RemoveOperand(1);   // Drop the source operand.
1059   MI->RemoveOperand(0);   // Drop the destination operand.
1060   MI->setDesc(TII->get(getConcreteOpcode(MI->getOpcode())));
1061 }
1062
1063
1064 //===----------------------------------------------------------------------===//
1065 // Define tables of various ways to map pseudo instructions
1066 //
1067
1068 // ForwardST0Table - Map: A = B op C  into: ST(0) = ST(0) op ST(i)
1069 static const TableEntry ForwardST0Table[] = {
1070   { X86::ADD_Fp32  , X86::ADD_FST0r },
1071   { X86::ADD_Fp64  , X86::ADD_FST0r },
1072   { X86::ADD_Fp80  , X86::ADD_FST0r },
1073   { X86::DIV_Fp32  , X86::DIV_FST0r },
1074   { X86::DIV_Fp64  , X86::DIV_FST0r },
1075   { X86::DIV_Fp80  , X86::DIV_FST0r },
1076   { X86::MUL_Fp32  , X86::MUL_FST0r },
1077   { X86::MUL_Fp64  , X86::MUL_FST0r },
1078   { X86::MUL_Fp80  , X86::MUL_FST0r },
1079   { X86::SUB_Fp32  , X86::SUB_FST0r },
1080   { X86::SUB_Fp64  , X86::SUB_FST0r },
1081   { X86::SUB_Fp80  , X86::SUB_FST0r },
1082 };
1083
1084 // ReverseST0Table - Map: A = B op C  into: ST(0) = ST(i) op ST(0)
1085 static const TableEntry ReverseST0Table[] = {
1086   { X86::ADD_Fp32  , X86::ADD_FST0r  },   // commutative
1087   { X86::ADD_Fp64  , X86::ADD_FST0r  },   // commutative
1088   { X86::ADD_Fp80  , X86::ADD_FST0r  },   // commutative
1089   { X86::DIV_Fp32  , X86::DIVR_FST0r },
1090   { X86::DIV_Fp64  , X86::DIVR_FST0r },
1091   { X86::DIV_Fp80  , X86::DIVR_FST0r },
1092   { X86::MUL_Fp32  , X86::MUL_FST0r  },   // commutative
1093   { X86::MUL_Fp64  , X86::MUL_FST0r  },   // commutative
1094   { X86::MUL_Fp80  , X86::MUL_FST0r  },   // commutative
1095   { X86::SUB_Fp32  , X86::SUBR_FST0r },
1096   { X86::SUB_Fp64  , X86::SUBR_FST0r },
1097   { X86::SUB_Fp80  , X86::SUBR_FST0r },
1098 };
1099
1100 // ForwardSTiTable - Map: A = B op C  into: ST(i) = ST(0) op ST(i)
1101 static const TableEntry ForwardSTiTable[] = {
1102   { X86::ADD_Fp32  , X86::ADD_FrST0  },   // commutative
1103   { X86::ADD_Fp64  , X86::ADD_FrST0  },   // commutative
1104   { X86::ADD_Fp80  , X86::ADD_FrST0  },   // commutative
1105   { X86::DIV_Fp32  , X86::DIVR_FrST0 },
1106   { X86::DIV_Fp64  , X86::DIVR_FrST0 },
1107   { X86::DIV_Fp80  , X86::DIVR_FrST0 },
1108   { X86::MUL_Fp32  , X86::MUL_FrST0  },   // commutative
1109   { X86::MUL_Fp64  , X86::MUL_FrST0  },   // commutative
1110   { X86::MUL_Fp80  , X86::MUL_FrST0  },   // commutative
1111   { X86::SUB_Fp32  , X86::SUBR_FrST0 },
1112   { X86::SUB_Fp64  , X86::SUBR_FrST0 },
1113   { X86::SUB_Fp80  , X86::SUBR_FrST0 },
1114 };
1115
1116 // ReverseSTiTable - Map: A = B op C  into: ST(i) = ST(i) op ST(0)
1117 static const TableEntry ReverseSTiTable[] = {
1118   { X86::ADD_Fp32  , X86::ADD_FrST0 },
1119   { X86::ADD_Fp64  , X86::ADD_FrST0 },
1120   { X86::ADD_Fp80  , X86::ADD_FrST0 },
1121   { X86::DIV_Fp32  , X86::DIV_FrST0 },
1122   { X86::DIV_Fp64  , X86::DIV_FrST0 },
1123   { X86::DIV_Fp80  , X86::DIV_FrST0 },
1124   { X86::MUL_Fp32  , X86::MUL_FrST0 },
1125   { X86::MUL_Fp64  , X86::MUL_FrST0 },
1126   { X86::MUL_Fp80  , X86::MUL_FrST0 },
1127   { X86::SUB_Fp32  , X86::SUB_FrST0 },
1128   { X86::SUB_Fp64  , X86::SUB_FrST0 },
1129   { X86::SUB_Fp80  , X86::SUB_FrST0 },
1130 };
1131
1132
1133 /// handleTwoArgFP - Handle instructions like FADD and friends which are virtual
1134 /// instructions which need to be simplified and possibly transformed.
1135 ///
1136 /// Result: ST(0) = fsub  ST(0), ST(i)
1137 ///         ST(i) = fsub  ST(0), ST(i)
1138 ///         ST(0) = fsubr ST(0), ST(i)
1139 ///         ST(i) = fsubr ST(0), ST(i)
1140 ///
1141 void FPS::handleTwoArgFP(MachineBasicBlock::iterator &I) {
1142   ASSERT_SORTED(ForwardST0Table); ASSERT_SORTED(ReverseST0Table);
1143   ASSERT_SORTED(ForwardSTiTable); ASSERT_SORTED(ReverseSTiTable);
1144   MachineInstr *MI = I;
1145
1146   unsigned NumOperands = MI->getDesc().getNumOperands();
1147   assert(NumOperands == 3 && "Illegal TwoArgFP instruction!");
1148   unsigned Dest = getFPReg(MI->getOperand(0));
1149   unsigned Op0 = getFPReg(MI->getOperand(NumOperands-2));
1150   unsigned Op1 = getFPReg(MI->getOperand(NumOperands-1));
1151   bool KillsOp0 = MI->killsRegister(X86::FP0+Op0);
1152   bool KillsOp1 = MI->killsRegister(X86::FP0+Op1);
1153   DebugLoc dl = MI->getDebugLoc();
1154
1155   unsigned TOS = getStackEntry(0);
1156
1157   // One of our operands must be on the top of the stack.  If neither is yet, we
1158   // need to move one.
1159   if (Op0 != TOS && Op1 != TOS) {   // No operand at TOS?
1160     // We can choose to move either operand to the top of the stack.  If one of
1161     // the operands is killed by this instruction, we want that one so that we
1162     // can update right on top of the old version.
1163     if (KillsOp0) {
1164       moveToTop(Op0, I);         // Move dead operand to TOS.
1165       TOS = Op0;
1166     } else if (KillsOp1) {
1167       moveToTop(Op1, I);
1168       TOS = Op1;
1169     } else {
1170       // All of the operands are live after this instruction executes, so we
1171       // cannot update on top of any operand.  Because of this, we must
1172       // duplicate one of the stack elements to the top.  It doesn't matter
1173       // which one we pick.
1174       //
1175       duplicateToTop(Op0, Dest, I);
1176       Op0 = TOS = Dest;
1177       KillsOp0 = true;
1178     }
1179   } else if (!KillsOp0 && !KillsOp1) {
1180     // If we DO have one of our operands at the top of the stack, but we don't
1181     // have a dead operand, we must duplicate one of the operands to a new slot
1182     // on the stack.
1183     duplicateToTop(Op0, Dest, I);
1184     Op0 = TOS = Dest;
1185     KillsOp0 = true;
1186   }
1187
1188   // Now we know that one of our operands is on the top of the stack, and at
1189   // least one of our operands is killed by this instruction.
1190   assert((TOS == Op0 || TOS == Op1) && (KillsOp0 || KillsOp1) &&
1191          "Stack conditions not set up right!");
1192
1193   // We decide which form to use based on what is on the top of the stack, and
1194   // which operand is killed by this instruction.
1195   const TableEntry *InstTable;
1196   bool isForward = TOS == Op0;
1197   bool updateST0 = (TOS == Op0 && !KillsOp1) || (TOS == Op1 && !KillsOp0);
1198   if (updateST0) {
1199     if (isForward)
1200       InstTable = ForwardST0Table;
1201     else
1202       InstTable = ReverseST0Table;
1203   } else {
1204     if (isForward)
1205       InstTable = ForwardSTiTable;
1206     else
1207       InstTable = ReverseSTiTable;
1208   }
1209
1210   int Opcode = Lookup(InstTable, array_lengthof(ForwardST0Table),
1211                       MI->getOpcode());
1212   assert(Opcode != -1 && "Unknown TwoArgFP pseudo instruction!");
1213
1214   // NotTOS - The register which is not on the top of stack...
1215   unsigned NotTOS = (TOS == Op0) ? Op1 : Op0;
1216
1217   // Replace the old instruction with a new instruction
1218   MBB->remove(I++);
1219   I = BuildMI(*MBB, I, dl, TII->get(Opcode)).addReg(getSTReg(NotTOS));
1220
1221   // If both operands are killed, pop one off of the stack in addition to
1222   // overwriting the other one.
1223   if (KillsOp0 && KillsOp1 && Op0 != Op1) {
1224     assert(!updateST0 && "Should have updated other operand!");
1225     popStackAfter(I);   // Pop the top of stack
1226   }
1227
1228   // Update stack information so that we know the destination register is now on
1229   // the stack.
1230   unsigned UpdatedSlot = getSlot(updateST0 ? TOS : NotTOS);
1231   assert(UpdatedSlot < StackTop && Dest < 7);
1232   Stack[UpdatedSlot]   = Dest;
1233   RegMap[Dest]         = UpdatedSlot;
1234   MBB->getParent()->DeleteMachineInstr(MI); // Remove the old instruction
1235 }
1236
1237 /// handleCompareFP - Handle FUCOM and FUCOMI instructions, which have two FP
1238 /// register arguments and no explicit destinations.
1239 ///
1240 void FPS::handleCompareFP(MachineBasicBlock::iterator &I) {
1241   ASSERT_SORTED(ForwardST0Table); ASSERT_SORTED(ReverseST0Table);
1242   ASSERT_SORTED(ForwardSTiTable); ASSERT_SORTED(ReverseSTiTable);
1243   MachineInstr *MI = I;
1244
1245   unsigned NumOperands = MI->getDesc().getNumOperands();
1246   assert(NumOperands == 2 && "Illegal FUCOM* instruction!");
1247   unsigned Op0 = getFPReg(MI->getOperand(NumOperands-2));
1248   unsigned Op1 = getFPReg(MI->getOperand(NumOperands-1));
1249   bool KillsOp0 = MI->killsRegister(X86::FP0+Op0);
1250   bool KillsOp1 = MI->killsRegister(X86::FP0+Op1);
1251
1252   // Make sure the first operand is on the top of stack, the other one can be
1253   // anywhere.
1254   moveToTop(Op0, I);
1255
1256   // Change from the pseudo instruction to the concrete instruction.
1257   MI->getOperand(0).setReg(getSTReg(Op1));
1258   MI->RemoveOperand(1);
1259   MI->setDesc(TII->get(getConcreteOpcode(MI->getOpcode())));
1260
1261   // If any of the operands are killed by this instruction, free them.
1262   if (KillsOp0) freeStackSlotAfter(I, Op0);
1263   if (KillsOp1 && Op0 != Op1) freeStackSlotAfter(I, Op1);
1264 }
1265
1266 /// handleCondMovFP - Handle two address conditional move instructions.  These
1267 /// instructions move a st(i) register to st(0) iff a condition is true.  These
1268 /// instructions require that the first operand is at the top of the stack, but
1269 /// otherwise don't modify the stack at all.
1270 void FPS::handleCondMovFP(MachineBasicBlock::iterator &I) {
1271   MachineInstr *MI = I;
1272
1273   unsigned Op0 = getFPReg(MI->getOperand(0));
1274   unsigned Op1 = getFPReg(MI->getOperand(2));
1275   bool KillsOp1 = MI->killsRegister(X86::FP0+Op1);
1276
1277   // The first operand *must* be on the top of the stack.
1278   moveToTop(Op0, I);
1279
1280   // Change the second operand to the stack register that the operand is in.
1281   // Change from the pseudo instruction to the concrete instruction.
1282   MI->RemoveOperand(0);
1283   MI->RemoveOperand(1);
1284   MI->getOperand(0).setReg(getSTReg(Op1));
1285   MI->setDesc(TII->get(getConcreteOpcode(MI->getOpcode())));
1286
1287   // If we kill the second operand, make sure to pop it from the stack.
1288   if (Op0 != Op1 && KillsOp1) {
1289     // Get this value off of the register stack.
1290     freeStackSlotAfter(I, Op1);
1291   }
1292 }
1293
1294
1295 /// handleSpecialFP - Handle special instructions which behave unlike other
1296 /// floating point instructions.  This is primarily intended for use by pseudo
1297 /// instructions.
1298 ///
1299 void FPS::handleSpecialFP(MachineBasicBlock::iterator &I) {
1300   MachineInstr *MI = I;
1301
1302   if (MI->isCall()) {
1303     handleCall(I);
1304     return;
1305   }
1306
1307   switch (MI->getOpcode()) {
1308   default: llvm_unreachable("Unknown SpecialFP instruction!");
1309   case TargetOpcode::COPY: {
1310     // We handle three kinds of copies: FP <- FP, FP <- ST, and ST <- FP.
1311     const MachineOperand &MO1 = MI->getOperand(1);
1312     const MachineOperand &MO0 = MI->getOperand(0);
1313     bool KillsSrc = MI->killsRegister(MO1.getReg());
1314
1315     // FP <- FP copy.
1316     unsigned DstFP = getFPReg(MO0);
1317     unsigned SrcFP = getFPReg(MO1);
1318     assert(isLive(SrcFP) && "Cannot copy dead register");
1319     if (KillsSrc) {
1320       // If the input operand is killed, we can just change the owner of the
1321       // incoming stack slot into the result.
1322       unsigned Slot = getSlot(SrcFP);
1323       Stack[Slot] = DstFP;
1324       RegMap[DstFP] = Slot;
1325     } else {
1326       // For COPY we just duplicate the specified value to a new stack slot.
1327       // This could be made better, but would require substantial changes.
1328       duplicateToTop(SrcFP, DstFP, I);
1329     }
1330     break;
1331   }
1332
1333   case TargetOpcode::IMPLICIT_DEF: {
1334     // All FP registers must be explicitly defined, so load a 0 instead.
1335     unsigned Reg = MI->getOperand(0).getReg() - X86::FP0;
1336     DEBUG(dbgs() << "Emitting LD_F0 for implicit FP" << Reg << '\n');
1337     BuildMI(*MBB, I, MI->getDebugLoc(), TII->get(X86::LD_F0));
1338     pushReg(Reg);
1339     break;
1340   }
1341
1342   case TargetOpcode::INLINEASM: {
1343     // The inline asm MachineInstr currently only *uses* FP registers for the
1344     // 'f' constraint.  These should be turned into the current ST(x) register
1345     // in the machine instr.
1346     //
1347     // There are special rules for x87 inline assembly. The compiler must know
1348     // exactly how many registers are popped and pushed implicitly by the asm.
1349     // Otherwise it is not possible to restore the stack state after the inline
1350     // asm.
1351     //
1352     // There are 3 kinds of input operands:
1353     //
1354     // 1. Popped inputs. These must appear at the stack top in ST0-STn. A
1355     //    popped input operand must be in a fixed stack slot, and it is either
1356     //    tied to an output operand, or in the clobber list. The MI has ST use
1357     //    and def operands for these inputs.
1358     //
1359     // 2. Fixed inputs. These inputs appear in fixed stack slots, but are
1360     //    preserved by the inline asm. The fixed stack slots must be STn-STm
1361     //    following the popped inputs. A fixed input operand cannot be tied to
1362     //    an output or appear in the clobber list. The MI has ST use operands
1363     //    and no defs for these inputs.
1364     //
1365     // 3. Preserved inputs. These inputs use the "f" constraint which is
1366     //    represented as an FP register. The inline asm won't change these
1367     //    stack slots.
1368     //
1369     // Outputs must be in ST registers, FP outputs are not allowed. Clobbered
1370     // registers do not count as output operands. The inline asm changes the
1371     // stack as if it popped all the popped inputs and then pushed all the
1372     // output operands.
1373
1374     // Scan the assembly for ST registers used, defined and clobbered. We can
1375     // only tell clobbers from defs by looking at the asm descriptor.
1376     unsigned STUses = 0, STDefs = 0, STClobbers = 0, STDeadDefs = 0;
1377     unsigned NumOps = 0;
1378     SmallSet<unsigned, 1> FRegIdx;
1379     unsigned RCID;
1380
1381     for (unsigned i = InlineAsm::MIOp_FirstOperand, e = MI->getNumOperands();
1382          i != e && MI->getOperand(i).isImm(); i += 1 + NumOps) {
1383       unsigned Flags = MI->getOperand(i).getImm();
1384
1385       NumOps = InlineAsm::getNumOperandRegisters(Flags);
1386       if (NumOps != 1)
1387         continue;
1388       const MachineOperand &MO = MI->getOperand(i + 1);
1389       if (!MO.isReg())
1390         continue;
1391       unsigned STReg = MO.getReg() - X86::FP0;
1392       if (STReg >= 8)
1393         continue;
1394
1395       // If the flag has a register class constraint, this must be an operand
1396       // with constraint "f". Record its index and continue.
1397       if (InlineAsm::hasRegClassConstraint(Flags, RCID)) {
1398         FRegIdx.insert(i + 1);
1399         continue;
1400       }
1401
1402       switch (InlineAsm::getKind(Flags)) {
1403       case InlineAsm::Kind_RegUse:
1404         STUses |= (1u << STReg);
1405         break;
1406       case InlineAsm::Kind_RegDef:
1407       case InlineAsm::Kind_RegDefEarlyClobber:
1408         STDefs |= (1u << STReg);
1409         if (MO.isDead())
1410           STDeadDefs |= (1u << STReg);
1411         break;
1412       case InlineAsm::Kind_Clobber:
1413         STClobbers |= (1u << STReg);
1414         break;
1415       default:
1416         break;
1417       }
1418     }
1419
1420     if (STUses && !isMask_32(STUses))
1421       MI->emitError("fixed input regs must be last on the x87 stack");
1422     unsigned NumSTUses = CountTrailingOnes_32(STUses);
1423
1424     // Defs must be contiguous from the stack top. ST0-STn.
1425     if (STDefs && !isMask_32(STDefs)) {
1426       MI->emitError("output regs must be last on the x87 stack");
1427       STDefs = NextPowerOf2(STDefs) - 1;
1428     }
1429     unsigned NumSTDefs = CountTrailingOnes_32(STDefs);
1430
1431     // So must the clobbered stack slots. ST0-STm, m >= n.
1432     if (STClobbers && !isMask_32(STDefs | STClobbers))
1433       MI->emitError("clobbers must be last on the x87 stack");
1434
1435     // Popped inputs are the ones that are also clobbered or defined.
1436     unsigned STPopped = STUses & (STDefs | STClobbers);
1437     if (STPopped && !isMask_32(STPopped))
1438       MI->emitError("implicitly popped regs must be last on the x87 stack");
1439     unsigned NumSTPopped = CountTrailingOnes_32(STPopped);
1440
1441     DEBUG(dbgs() << "Asm uses " << NumSTUses << " fixed regs, pops "
1442                  << NumSTPopped << ", and defines " << NumSTDefs << " regs.\n");
1443
1444 #ifndef NDEBUG
1445     // If any input operand uses constraint "f", all output register
1446     // constraints must be early-clobber defs.
1447     for (unsigned I = 0, E = MI->getNumOperands(); I < E; ++I)
1448       if (FRegIdx.count(I)) {
1449         assert((1 << getFPReg(MI->getOperand(I)) & STDefs) == 0 &&
1450                "Operands with constraint \"f\" cannot overlap with defs");
1451       }
1452 #endif
1453
1454     // Collect all FP registers (register operands with constraints "t", "u",
1455     // and "f") to kill afer the instruction.
1456     unsigned FPKills = ((1u << NumFPRegs) - 1) & ~0xff;
1457     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
1458       MachineOperand &Op = MI->getOperand(i);
1459       if (!Op.isReg() || Op.getReg() < X86::FP0 || Op.getReg() > X86::FP6)
1460         continue;
1461       unsigned FPReg = getFPReg(Op);
1462
1463       // If we kill this operand, make sure to pop it from the stack after the
1464       // asm.  We just remember it for now, and pop them all off at the end in
1465       // a batch.
1466       if (Op.isUse() && Op.isKill())
1467         FPKills |= 1U << FPReg;
1468     }
1469
1470     // Do not include registers that are implicitly popped by defs/clobbers.
1471     FPKills &= ~(STDefs | STClobbers);
1472
1473     // Now we can rearrange the live registers to match what was requested.
1474     unsigned char STUsesArray[8];
1475
1476     for (unsigned I = 0; I < NumSTUses; ++I)
1477       STUsesArray[I] = I;
1478
1479     shuffleStackTop(STUsesArray, NumSTUses, I);
1480     DEBUG({dbgs() << "Before asm: "; dumpStack();});
1481
1482     // With the stack layout fixed, rewrite the FP registers.
1483     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
1484       MachineOperand &Op = MI->getOperand(i);
1485       if (!Op.isReg() || Op.getReg() < X86::FP0 || Op.getReg() > X86::FP6)
1486         continue;
1487
1488       unsigned FPReg = getFPReg(Op);
1489
1490       if (FRegIdx.count(i))
1491         // Operand with constraint "f".
1492         Op.setReg(getSTReg(FPReg));
1493       else
1494         // Operand with a single register class constraint ("t" or "u").
1495         Op.setReg(X86::ST0 + FPReg);
1496     }
1497
1498     // Simulate the inline asm popping its inputs and pushing its outputs.
1499     StackTop -= NumSTPopped;
1500
1501     for (unsigned i = 0; i < NumSTDefs; ++i)
1502       pushReg(NumSTDefs - i - 1);
1503
1504     // If this asm kills any FP registers (is the last use of them) we must
1505     // explicitly emit pop instructions for them.  Do this now after the asm has
1506     // executed so that the ST(x) numbers are not off (which would happen if we
1507     // did this inline with operand rewriting).
1508     //
1509     // Note: this might be a non-optimal pop sequence.  We might be able to do
1510     // better by trying to pop in stack order or something.
1511     while (FPKills) {
1512       unsigned FPReg = countTrailingZeros(FPKills);
1513       if (isLive(FPReg))
1514         freeStackSlotAfter(I, FPReg);
1515       FPKills &= ~(1U << FPReg);
1516     }
1517
1518     // Don't delete the inline asm!
1519     return;
1520   }
1521
1522   case X86::WIN_FTOL_32:
1523   case X86::WIN_FTOL_64: {
1524     // Push the operand into ST0.
1525     MachineOperand &Op = MI->getOperand(0);
1526     assert(Op.isUse() && Op.isReg() &&
1527       Op.getReg() >= X86::FP0 && Op.getReg() <= X86::FP6);
1528     unsigned FPReg = getFPReg(Op);
1529     if (Op.isKill())
1530       moveToTop(FPReg, I);
1531     else
1532       duplicateToTop(FPReg, FPReg, I);
1533
1534     // Emit the call. This will pop the operand.
1535     BuildMI(*MBB, I, MI->getDebugLoc(), TII->get(X86::CALLpcrel32))
1536       .addExternalSymbol("_ftol2")
1537       .addReg(X86::ST0, RegState::ImplicitKill)
1538       .addReg(X86::ECX, RegState::ImplicitDefine)
1539       .addReg(X86::EAX, RegState::Define | RegState::Implicit)
1540       .addReg(X86::EDX, RegState::Define | RegState::Implicit)
1541       .addReg(X86::EFLAGS, RegState::Define | RegState::Implicit);
1542     --StackTop;
1543
1544     break;
1545   }
1546
1547   case X86::RETQ:
1548   case X86::RETL:
1549   case X86::RETIL:
1550   case X86::RETIQ:
1551     // If RET has an FP register use operand, pass the first one in ST(0) and
1552     // the second one in ST(1).
1553
1554     // Find the register operands.
1555     unsigned FirstFPRegOp = ~0U, SecondFPRegOp = ~0U;
1556     unsigned LiveMask = 0;
1557
1558     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
1559       MachineOperand &Op = MI->getOperand(i);
1560       if (!Op.isReg() || Op.getReg() < X86::FP0 || Op.getReg() > X86::FP6)
1561         continue;
1562       // FP Register uses must be kills unless there are two uses of the same
1563       // register, in which case only one will be a kill.
1564       assert(Op.isUse() &&
1565              (Op.isKill() ||                        // Marked kill.
1566               getFPReg(Op) == FirstFPRegOp ||       // Second instance.
1567               MI->killsRegister(Op.getReg())) &&    // Later use is marked kill.
1568              "Ret only defs operands, and values aren't live beyond it");
1569
1570       if (FirstFPRegOp == ~0U)
1571         FirstFPRegOp = getFPReg(Op);
1572       else {
1573         assert(SecondFPRegOp == ~0U && "More than two fp operands!");
1574         SecondFPRegOp = getFPReg(Op);
1575       }
1576       LiveMask |= (1 << getFPReg(Op));
1577
1578       // Remove the operand so that later passes don't see it.
1579       MI->RemoveOperand(i);
1580       --i, --e;
1581     }
1582
1583     // We may have been carrying spurious live-ins, so make sure only the returned
1584     // registers are left live.
1585     adjustLiveRegs(LiveMask, MI);
1586     if (!LiveMask) return;  // Quick check to see if any are possible.
1587
1588     // There are only four possibilities here:
1589     // 1) we are returning a single FP value.  In this case, it has to be in
1590     //    ST(0) already, so just declare success by removing the value from the
1591     //    FP Stack.
1592     if (SecondFPRegOp == ~0U) {
1593       // Assert that the top of stack contains the right FP register.
1594       assert(StackTop == 1 && FirstFPRegOp == getStackEntry(0) &&
1595              "Top of stack not the right register for RET!");
1596
1597       // Ok, everything is good, mark the value as not being on the stack
1598       // anymore so that our assertion about the stack being empty at end of
1599       // block doesn't fire.
1600       StackTop = 0;
1601       return;
1602     }
1603
1604     // Otherwise, we are returning two values:
1605     // 2) If returning the same value for both, we only have one thing in the FP
1606     //    stack.  Consider:  RET FP1, FP1
1607     if (StackTop == 1) {
1608       assert(FirstFPRegOp == SecondFPRegOp && FirstFPRegOp == getStackEntry(0)&&
1609              "Stack misconfiguration for RET!");
1610
1611       // Duplicate the TOS so that we return it twice.  Just pick some other FPx
1612       // register to hold it.
1613       unsigned NewReg = ScratchFPReg;
1614       duplicateToTop(FirstFPRegOp, NewReg, MI);
1615       FirstFPRegOp = NewReg;
1616     }
1617
1618     /// Okay we know we have two different FPx operands now:
1619     assert(StackTop == 2 && "Must have two values live!");
1620
1621     /// 3) If SecondFPRegOp is currently in ST(0) and FirstFPRegOp is currently
1622     ///    in ST(1).  In this case, emit an fxch.
1623     if (getStackEntry(0) == SecondFPRegOp) {
1624       assert(getStackEntry(1) == FirstFPRegOp && "Unknown regs live");
1625       moveToTop(FirstFPRegOp, MI);
1626     }
1627
1628     /// 4) Finally, FirstFPRegOp must be in ST(0) and SecondFPRegOp must be in
1629     /// ST(1).  Just remove both from our understanding of the stack and return.
1630     assert(getStackEntry(0) == FirstFPRegOp && "Unknown regs live");
1631     assert(getStackEntry(1) == SecondFPRegOp && "Unknown regs live");
1632     StackTop = 0;
1633     return;
1634   }
1635
1636   I = MBB->erase(I);  // Remove the pseudo instruction
1637
1638   // We want to leave I pointing to the previous instruction, but what if we
1639   // just erased the first instruction?
1640   if (I == MBB->begin()) {
1641     DEBUG(dbgs() << "Inserting dummy KILL\n");
1642     I = BuildMI(*MBB, I, DebugLoc(), TII->get(TargetOpcode::KILL));
1643   } else
1644     --I;
1645 }
1646
1647 void FPS::setKillFlags(MachineBasicBlock &MBB) const {
1648   const TargetRegisterInfo *TRI = MBB.getParent()->getTarget()
1649     .getRegisterInfo();
1650   LivePhysRegs LPR(TRI);
1651
1652   LPR.addLiveOuts(&MBB);
1653
1654   for (MachineBasicBlock::reverse_iterator I = MBB.rbegin(), E = MBB.rend();
1655        I != E; ++I) {
1656     BitVector Defs(8);
1657     SmallVector<MachineOperand *, 2> Uses;
1658     MachineInstr &MI = *I;
1659
1660     for (auto &MO : I->operands()) {
1661       if (!MO.isReg())
1662         continue;
1663
1664       unsigned Reg = MO.getReg() - X86::FP0;
1665
1666       if (Reg >= 8)
1667         continue;
1668
1669       if (MO.isDef()) {
1670         Defs.set(Reg);
1671         if (!LPR.contains(MO.getReg()))
1672           MO.setIsDead();
1673       } else
1674         Uses.push_back(&MO);
1675     }
1676
1677     for (auto *MO : Uses)
1678       if (Defs.test(getFPReg(*MO)) || !LPR.contains(MO->getReg()))
1679         MO->setIsKill();
1680
1681     LPR.stepBackward(MI);
1682   }
1683 }