lib/Target/X86/X86FloatingPoint.cpp

   1 //===-- X86FloatingPoint.cpp - Floating point Reg -> Stack converter ------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the pass which converts floating point instructions from
  11 // virtual 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 // This pass is hampered by the lack of decent CFG manipulation routines for
  16 // machine code.  In particular, this wants to be able to split critical edges
  17 // as necessary, traverse the machine basic block CFG in depth-first order, and
  18 // allow there to be multiple machine basic blocks for each LLVM basicblock
  19 // (needed for critical edge splitting).
  20 //
  21 // In particular, this pass currently barfs on critical edges.  Because of this,
  22 // it requires the instruction selector to insert FP_REG_KILL instructions on
  23 // the exits of any basic block that has critical edges going from it, or which
  24 // branch to a critical basic block.
  25 //
  26 // FIXME: this is not implemented yet.  The stackifier pass only works on local
  27 // basic blocks.
  28 //
  29 //===----------------------------------------------------------------------===//
  30
  31 #define DEBUG_TYPE "x86-codegen"
  32 #include "X86.h"
  33 #include "X86InstrInfo.h"
  34 #include "llvm/CodeGen/MachineFunctionPass.h"
  35 #include "llvm/CodeGen/MachineInstrBuilder.h"
  36 #include "llvm/CodeGen/LiveVariables.h"
  37 #include "llvm/CodeGen/Passes.h"
  38 #include "llvm/Target/TargetInstrInfo.h"
  39 #include "llvm/Target/TargetMachine.h"
  40 #include "llvm/Support/Debug.h"
  41 #include "llvm/Support/Compiler.h"
  42 #include "llvm/ADT/DepthFirstIterator.h"
  43 #include "llvm/ADT/SmallVector.h"
  44 #include "llvm/ADT/Statistic.h"
  45 #include "llvm/ADT/STLExtras.h"
  46 #include <algorithm>
  47 #include <set>
  48 using namespace llvm;
  49
  50 STATISTIC(NumFXCH, "Number of fxch instructions inserted");
  51 STATISTIC(NumFP  , "Number of floating point instructions");
  52
  53 namespace {
  54   struct VISIBILITY_HIDDEN FPS : public MachineFunctionPass {
  55     static char ID;
  56     FPS() : MachineFunctionPass((intptr_t)&ID) {}
  57
  58     virtual bool runOnMachineFunction(MachineFunction &MF);
  59
  60     virtual const char *getPassName() const { return "X86 FP Stackifier"; }
  61
  62     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
  63       AU.addRequired<LiveVariables>();
  64       MachineFunctionPass::getAnalysisUsage(AU);
  65     }
  66   private:
  67     const TargetInstrInfo *TII; // Machine instruction info.
  68     LiveVariables     *LV;      // Live variable info for current function...
  69     MachineBasicBlock *MBB;     // Current basic block
  70     unsigned Stack[8];          // FP<n> Registers in each stack slot...
  71     unsigned RegMap[8];         // Track which stack slot contains each register
  72     unsigned StackTop;          // The current top of the FP stack.
  73
  74     void dumpStack() const {
  75       cerr << "Stack contents:";
  76       for (unsigned i = 0; i != StackTop; ++i) {
  77         cerr << " FP" << Stack[i];
  78         assert(RegMap[Stack[i]] == i && "Stack[] doesn't match RegMap[]!");
  79       }
  80       cerr << "\n";
  81     }
  82   private:
  83     // getSlot - Return the stack slot number a particular register number is
  84     // in...
  85     unsigned getSlot(unsigned RegNo) const {
  86       assert(RegNo < 8 && "Regno out of range!");
  87       return RegMap[RegNo];
  88     }
  89
  90     // getStackEntry - Return the X86::FP<n> register in register ST(i)
  91     unsigned getStackEntry(unsigned STi) const {
  92       assert(STi < StackTop && "Access past stack top!");
  93       return Stack[StackTop-1-STi];
  94     }
  95
  96     // getSTReg - Return the X86::ST(i) register which contains the specified
  97     // FP<RegNo> register
  98     unsigned getSTReg(unsigned RegNo) const {
  99       return StackTop - 1 - getSlot(RegNo) + llvm::X86::ST0;
 100     }
 101
 102     // pushReg - Push the specified FP<n> register onto the stack
 103     void pushReg(unsigned Reg) {
 104       assert(Reg < 8 && "Register number out of range!");
 105       assert(StackTop < 8 && "Stack overflow!");
 106       Stack[StackTop] = Reg;
 107       RegMap[Reg] = StackTop++;
 108     }
 109
 110     bool isAtTop(unsigned RegNo) const { return getSlot(RegNo) == StackTop-1; }
 111     void moveToTop(unsigned RegNo, MachineBasicBlock::iterator &I) {
 112       if (!isAtTop(RegNo)) {
 113         unsigned STReg = getSTReg(RegNo);
 114         unsigned RegOnTop = getStackEntry(0);
 115
 116         // Swap the slots the regs are in
 117         std::swap(RegMap[RegNo], RegMap[RegOnTop]);
 118
 119         // Swap stack slot contents
 120         assert(RegMap[RegOnTop] < StackTop);
 121         std::swap(Stack[RegMap[RegOnTop]], Stack[StackTop-1]);
 122
 123         // Emit an fxch to update the runtime processors version of the state
 124         BuildMI(*MBB, I, TII->get(X86::FXCH)).addReg(STReg);
 125         NumFXCH++;
 126       }
 127     }
 128
 129     void duplicateToTop(unsigned RegNo, unsigned AsReg, MachineInstr *I) {
 130       unsigned STReg = getSTReg(RegNo);
 131       pushReg(AsReg);   // New register on top of stack
 132
 133       BuildMI(*MBB, I, TII->get(X86::FLDrr)).addReg(STReg);
 134     }
 135
 136     // popStackAfter - Pop the current value off of the top of the FP stack
 137     // after the specified instruction.
 138     void popStackAfter(MachineBasicBlock::iterator &I);
 139
 140     // freeStackSlotAfter - Free the specified register from the register stack,
 141     // so that it is no longer in a register.  If the register is currently at
 142     // the top of the stack, we just pop the current instruction, otherwise we
 143     // store the current top-of-stack into the specified slot, then pop the top
 144     // of stack.
 145     void freeStackSlotAfter(MachineBasicBlock::iterator &I, unsigned Reg);
 146
 147     bool processBasicBlock(MachineFunction &MF, MachineBasicBlock &MBB);
 148
 149     void handleZeroArgFP(MachineBasicBlock::iterator &I);
 150     void handleOneArgFP(MachineBasicBlock::iterator &I);
 151     void handleOneArgFPRW(MachineBasicBlock::iterator &I);
 152     void handleTwoArgFP(MachineBasicBlock::iterator &I);
 153     void handleCompareFP(MachineBasicBlock::iterator &I);
 154     void handleCondMovFP(MachineBasicBlock::iterator &I);
 155     void handleSpecialFP(MachineBasicBlock::iterator &I);
 156   };
 157   char FPS::ID = 0;
 158 }
 159
 160 FunctionPass *llvm::createX86FloatingPointStackifierPass() { return new FPS(); }
 161
 162 /// runOnMachineFunction - Loop over all of the basic blocks, transforming FP
 163 /// register references into FP stack references.
 164 ///
 165 bool FPS::runOnMachineFunction(MachineFunction &MF) {
 166   // We only need to run this pass if there are any FP registers used in this
 167   // function.  If it is all integer, there is nothing for us to do!
 168   bool FPIsUsed = false;
 169
 170   assert(X86::FP6 == X86::FP0+6 && "Register enums aren't sorted right!");
 171   for (unsigned i = 0; i <= 6; ++i)
 172     if (MF.isPhysRegUsed(X86::FP0+i)) {
 173       FPIsUsed = true;
 174       break;
 175     }
 176
 177   // Early exit.
 178   if (!FPIsUsed) return false;
 179
 180   TII = MF.getTarget().getInstrInfo();
 181   LV = &getAnalysis<LiveVariables>();
 182   StackTop = 0;
 183
 184   // Process the function in depth first order so that we process at least one
 185   // of the predecessors for every reachable block in the function.
 186   std::set<MachineBasicBlock*> Processed;
 187   MachineBasicBlock *Entry = MF.begin();
 188
 189   bool Changed = false;
 190   for (df_ext_iterator<MachineBasicBlock*, std::set<MachineBasicBlock*> >
 191          I = df_ext_begin(Entry, Processed), E = df_ext_end(Entry, Processed);
 192        I != E; ++I)
 193     Changed |= processBasicBlock(MF, **I);
 194
 195   return Changed;
 196 }
 197
 198 /// processBasicBlock - Loop over all of the instructions in the basic block,
 199 /// transforming FP instructions into their stack form.
 200 ///
 201 bool FPS::processBasicBlock(MachineFunction &MF, MachineBasicBlock &BB) {
 202   bool Changed = false;
 203   MBB = &BB;
 204
 205   for (MachineBasicBlock::iterator I = BB.begin(); I != BB.end(); ++I) {
 206     MachineInstr *MI = I;
 207     unsigned Flags = MI->getInstrDescriptor()->TSFlags;
 208     if ((Flags & X86II::FPTypeMask) == X86II::NotFP)
 209       continue;  // Efficiently ignore non-fp insts!
 210
 211     MachineInstr *PrevMI = 0;
 212     if (I != BB.begin())
 213         PrevMI = prior(I);
 214
 215     ++NumFP;  // Keep track of # of pseudo instrs
 216     DOUT << "\nFPInst:\t" << *MI;
 217
 218     // Get dead variables list now because the MI pointer may be deleted as part
 219     // of processing!
 220     SmallVector<unsigned, 8> DeadRegs;
 221     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 222       const MachineOperand &MO = MI->getOperand(i);
 223       if (MO.isReg() && MO.isDead())
 224         DeadRegs.push_back(MO.getReg());
 225     }
 226
 227     switch (Flags & X86II::FPTypeMask) {
 228     case X86II::ZeroArgFP:  handleZeroArgFP(I); break;
 229     case X86II::OneArgFP:   handleOneArgFP(I);  break;  // fstp ST(0)
 230     case X86II::OneArgFPRW: handleOneArgFPRW(I); break; // ST(0) = fsqrt(ST(0))
 231     case X86II::TwoArgFP:   handleTwoArgFP(I);  break;
 232     case X86II::CompareFP:  handleCompareFP(I); break;
 233     case X86II::CondMovFP:  handleCondMovFP(I); break;
 234     case X86II::SpecialFP:  handleSpecialFP(I); break;
 235     default: assert(0 && "Unknown FP Type!");
 236     }
 237
 238     // Check to see if any of the values defined by this instruction are dead
 239     // after definition.  If so, pop them.
 240     for (unsigned i = 0, e = DeadRegs.size(); i != e; ++i) {
 241       unsigned Reg = DeadRegs[i];
 242       if (Reg >= X86::FP0 && Reg <= X86::FP6) {
 243         DOUT << "Register FP#" << Reg-X86::FP0 << " is dead!\n";
 244         freeStackSlotAfter(I, Reg-X86::FP0);
 245       }
 246     }
 247
 248     // Print out all of the instructions expanded to if -debug
 249     DEBUG(
 250       MachineBasicBlock::iterator PrevI(PrevMI);
 251       if (I == PrevI) {
 252         cerr << "Just deleted pseudo instruction\n";
 253       } else {
 254         MachineBasicBlock::iterator Start = I;
 255         // Rewind to first instruction newly inserted.
 256         while (Start != BB.begin() && prior(Start) != PrevI) --Start;
 257         cerr << "Inserted instructions:\n\t";
 258         Start->print(*cerr.stream(), &MF.getTarget());
 259         while (++Start != next(I));
 260       }
 261       dumpStack();
 262     );
 263
 264     Changed = true;
 265   }
 266
 267   assert(StackTop == 0 && "Stack not empty at end of basic block?");
 268   return Changed;
 269 }
 270
 271 //===----------------------------------------------------------------------===//
 272 // Efficient Lookup Table Support
 273 //===----------------------------------------------------------------------===//
 274
 275 namespace {
 276   struct TableEntry {
 277     unsigned from;
 278     unsigned to;
 279     bool operator<(const TableEntry &TE) const { return from < TE.from; }
 280     friend bool operator<(const TableEntry &TE, unsigned V) {
 281       return TE.from < V;
 282     }
 283     friend bool operator<(unsigned V, const TableEntry &TE) {
 284       return V < TE.from;
 285     }
 286   };
 287 }
 288
 289 static bool TableIsSorted(const TableEntry *Table, unsigned NumEntries) {
 290   for (unsigned i = 0; i != NumEntries-1; ++i)
 291     if (!(Table[i] < Table[i+1])) return false;
 292   return true;
 293 }
 294
 295 static int Lookup(const TableEntry *Table, unsigned N, unsigned Opcode) {
 296   const TableEntry *I = std::lower_bound(Table, Table+N, Opcode);
 297   if (I != Table+N && I->from == Opcode)
 298     return I->to;
 299   return -1;
 300 }
 301
 302 #define ARRAY_SIZE(TABLE)  \
 303    (sizeof(TABLE)/sizeof(TABLE[0]))
 304
 305 #ifdef NDEBUG
 306 #define ASSERT_SORTED(TABLE)
 307 #else
 308 #define ASSERT_SORTED(TABLE)                                              \
 309   { static bool TABLE##Checked = false;                                   \
 310     if (!TABLE##Checked) {                                                \
 311        assert(TableIsSorted(TABLE, ARRAY_SIZE(TABLE)) &&                  \
 312               "All lookup tables must be sorted for efficient access!");  \
 313        TABLE##Checked = true;                                             \
 314     }                                                                     \
 315   }
 316 #endif
 317
 318 //===----------------------------------------------------------------------===//
 319 // Register File -> Register Stack Mapping Methods
 320 //===----------------------------------------------------------------------===//
 321
 322 // OpcodeTable - Sorted map of register instructions to their stack version.
 323 // The first element is an register file pseudo instruction, the second is the
 324 // concrete X86 instruction which uses the register stack.
 325 //
 326 static const TableEntry OpcodeTable[] = {
 327   { X86::FpABS     , X86::FABS     },
 328   { X86::FpADD32m  , X86::FADD32m  },
 329   { X86::FpADD64m  , X86::FADD64m  },
 330   { X86::FpCHS     , X86::FCHS     },
 331   { X86::FpCMOVB   , X86::FCMOVB   },
 332   { X86::FpCMOVBE  , X86::FCMOVBE  },
 333   { X86::FpCMOVE   , X86::FCMOVE   },
 334   { X86::FpCMOVNB  , X86::FCMOVNB  },
 335   { X86::FpCMOVNBE , X86::FCMOVNBE },
 336   { X86::FpCMOVNE  , X86::FCMOVNE  },
 337   { X86::FpCMOVNP  , X86::FCMOVNP  },
 338   { X86::FpCMOVP   , X86::FCMOVP   },
 339   { X86::FpCOS     , X86::FCOS     },
 340   { X86::FpDIV32m  , X86::FDIV32m  },
 341   { X86::FpDIV64m  , X86::FDIV64m  },
 342   { X86::FpDIVR32m , X86::FDIVR32m },
 343   { X86::FpDIVR64m , X86::FDIVR64m },
 344   { X86::FpIADD16m , X86::FIADD16m },
 345   { X86::FpIADD32m , X86::FIADD32m },
 346   { X86::FpIDIV16m , X86::FIDIV16m },
 347   { X86::FpIDIV32m , X86::FIDIV32m },
 348   { X86::FpIDIVR16m, X86::FIDIVR16m},
 349   { X86::FpIDIVR32m, X86::FIDIVR32m},
 350   { X86::FpILD16m  , X86::FILD16m  },
 351   { X86::FpILD32m  , X86::FILD32m  },
 352   { X86::FpILD64m  , X86::FILD64m  },
 353   { X86::FpIMUL16m , X86::FIMUL16m },
 354   { X86::FpIMUL32m , X86::FIMUL32m },
 355   { X86::FpIST16m  , X86::FIST16m  },
 356   { X86::FpIST32m  , X86::FIST32m  },
 357   { X86::FpIST64m  , X86::FISTP64m },
 358   { X86::FpISTT16m , X86::FISTTP16m},
 359   { X86::FpISTT32m , X86::FISTTP32m},
 360   { X86::FpISTT64m , X86::FISTTP64m},
 361   { X86::FpISUB16m , X86::FISUB16m },
 362   { X86::FpISUB32m , X86::FISUB32m },
 363   { X86::FpISUBR16m, X86::FISUBR16m},
 364   { X86::FpISUBR32m, X86::FISUBR32m},
 365   { X86::FpLD0     , X86::FLD0     },
 366   { X86::FpLD1     , X86::FLD1     },
 367   { X86::FpLD32m   , X86::FLD32m   },
 368   { X86::FpLD64m   , X86::FLD64m   },
 369   { X86::FpMUL32m  , X86::FMUL32m  },
 370   { X86::FpMUL64m  , X86::FMUL64m  },
 371   { X86::FpSIN     , X86::FSIN     },
 372   { X86::FpSQRT    , X86::FSQRT    },
 373   { X86::FpST32m   , X86::FST32m   },
 374   { X86::FpST64m   , X86::FST64m   },
 375   { X86::FpSUB32m  , X86::FSUB32m  },
 376   { X86::FpSUB64m  , X86::FSUB64m  },
 377   { X86::FpSUBR32m , X86::FSUBR32m },
 378   { X86::FpSUBR64m , X86::FSUBR64m },
 379   { X86::FpTST     , X86::FTST     },
 380   { X86::FpUCOMIr  , X86::FUCOMIr  },
 381   { X86::FpUCOMr   , X86::FUCOMr   },
 382 };
 383
 384 static unsigned getConcreteOpcode(unsigned Opcode) {
 385   ASSERT_SORTED(OpcodeTable);
 386   int Opc = Lookup(OpcodeTable, ARRAY_SIZE(OpcodeTable), Opcode);
 387   assert(Opc != -1 && "FP Stack instruction not in OpcodeTable!");
 388   return Opc;
 389 }
 390
 391 //===----------------------------------------------------------------------===//
 392 // Helper Methods
 393 //===----------------------------------------------------------------------===//
 394
 395 // PopTable - Sorted map of instructions to their popping version.  The first
 396 // element is an instruction, the second is the version which pops.
 397 //
 398 static const TableEntry PopTable[] = {
 399   { X86::FADDrST0 , X86::FADDPrST0  },
 400
 401   { X86::FDIVRrST0, X86::FDIVRPrST0 },
 402   { X86::FDIVrST0 , X86::FDIVPrST0  },
 403
 404   { X86::FIST16m  , X86::FISTP16m   },
 405   { X86::FIST32m  , X86::FISTP32m   },
 406
 407   { X86::FMULrST0 , X86::FMULPrST0  },
 408
 409   { X86::FST32m   , X86::FSTP32m    },
 410   { X86::FST64m   , X86::FSTP64m    },
 411   { X86::FSTrr    , X86::FSTPrr     },
 412
 413   { X86::FSUBRrST0, X86::FSUBRPrST0 },
 414   { X86::FSUBrST0 , X86::FSUBPrST0  },
 415
 416   { X86::FUCOMIr  , X86::FUCOMIPr   },
 417
 418   { X86::FUCOMPr  , X86::FUCOMPPr   },
 419   { X86::FUCOMr   , X86::FUCOMPr    },
 420 };
 421
 422 /// popStackAfter - Pop the current value off of the top of the FP stack after
 423 /// the specified instruction.  This attempts to be sneaky and combine the pop
 424 /// into the instruction itself if possible.  The iterator is left pointing to
 425 /// the last instruction, be it a new pop instruction inserted, or the old
 426 /// instruction if it was modified in place.
 427 ///
 428 void FPS::popStackAfter(MachineBasicBlock::iterator &I) {
 429   ASSERT_SORTED(PopTable);
 430   assert(StackTop > 0 && "Cannot pop empty stack!");
 431   RegMap[Stack[--StackTop]] = ~0;     // Update state
 432
 433   // Check to see if there is a popping version of this instruction...
 434   int Opcode = Lookup(PopTable, ARRAY_SIZE(PopTable), I->getOpcode());
 435   if (Opcode != -1) {
 436     I->setInstrDescriptor(TII->get(Opcode));
 437     if (Opcode == X86::FUCOMPPr)
 438       I->RemoveOperand(0);
 439   } else {    // Insert an explicit pop
 440     I = BuildMI(*MBB, ++I, TII->get(X86::FSTPrr)).addReg(X86::ST0);
 441   }
 442 }
 443
 444 /// freeStackSlotAfter - Free the specified register from the register stack, so
 445 /// that it is no longer in a register.  If the register is currently at the top
 446 /// of the stack, we just pop the current instruction, otherwise we store the
 447 /// current top-of-stack into the specified slot, then pop the top of stack.
 448 void FPS::freeStackSlotAfter(MachineBasicBlock::iterator &I, unsigned FPRegNo) {
 449   if (getStackEntry(0) == FPRegNo) {  // already at the top of stack? easy.
 450     popStackAfter(I);
 451     return;
 452   }
 453
 454   // Otherwise, store the top of stack into the dead slot, killing the operand
 455   // without having to add in an explicit xchg then pop.
 456   //
 457   unsigned STReg    = getSTReg(FPRegNo);
 458   unsigned OldSlot  = getSlot(FPRegNo);
 459   unsigned TopReg   = Stack[StackTop-1];
 460   Stack[OldSlot]    = TopReg;
 461   RegMap[TopReg]    = OldSlot;
 462   RegMap[FPRegNo]   = ~0;
 463   Stack[--StackTop] = ~0;
 464   I = BuildMI(*MBB, ++I, TII->get(X86::FSTPrr)).addReg(STReg);
 465 }
 466
 467
 468 static unsigned getFPReg(const MachineOperand &MO) {
 469   assert(MO.isRegister() && "Expected an FP register!");
 470   unsigned Reg = MO.getReg();
 471   assert(Reg >= X86::FP0 && Reg <= X86::FP6 && "Expected FP register!");
 472   return Reg - X86::FP0;
 473 }
 474
 475
 476 //===----------------------------------------------------------------------===//
 477 // Instruction transformation implementation
 478 //===----------------------------------------------------------------------===//
 479
 480 /// handleZeroArgFP - ST(0) = fld0    ST(0) = flds <mem>
 481 ///
 482 void FPS::handleZeroArgFP(MachineBasicBlock::iterator &I) {
 483   MachineInstr *MI = I;
 484   unsigned DestReg = getFPReg(MI->getOperand(0));
 485
 486   // Change from the pseudo instruction to the concrete instruction.
 487   MI->RemoveOperand(0);   // Remove the explicit ST(0) operand
 488   MI->setInstrDescriptor(TII->get(getConcreteOpcode(MI->getOpcode())));
 489
 490   // Result gets pushed on the stack.
 491   pushReg(DestReg);
 492 }
 493
 494 /// handleOneArgFP - fst <mem>, ST(0)
 495 ///
 496 void FPS::handleOneArgFP(MachineBasicBlock::iterator &I) {
 497   MachineInstr *MI = I;
 498   unsigned NumOps = MI->getInstrDescriptor()->numOperands;
 499   assert((NumOps == 5 || NumOps == 1) &&
 500          "Can only handle fst* & ftst instructions!");
 501
 502   // Is this the last use of the source register?
 503   unsigned Reg = getFPReg(MI->getOperand(NumOps-1));
 504   bool KillsSrc = LV->KillsRegister(MI, X86::FP0+Reg);
 505
 506   // FISTP64m is strange because there isn't a non-popping versions.
 507   // If we have one _and_ we don't want to pop the operand, duplicate the value
 508   // on the stack instead of moving it.  This ensure that popping the value is
 509   // always ok.
 510   // Ditto FISTTP16m, FISTTP32m, FISTTP64m.
 511   //
 512   if (!KillsSrc &&
 513       (MI->getOpcode() == X86::FpIST64m ||
 514        MI->getOpcode() == X86::FpISTT16m ||
 515        MI->getOpcode() == X86::FpISTT32m ||
 516        MI->getOpcode() == X86::FpISTT64m)) {
 517     duplicateToTop(Reg, 7 /*temp register*/, I);
 518   } else {
 519     moveToTop(Reg, I);            // Move to the top of the stack...
 520   }
 521
 522   // Convert from the pseudo instruction to the concrete instruction.
 523   MI->RemoveOperand(NumOps-1);    // Remove explicit ST(0) operand
 524   MI->setInstrDescriptor(TII->get(getConcreteOpcode(MI->getOpcode())));
 525
 526   if (MI->getOpcode() == X86::FISTP64m ||
 527       MI->getOpcode() == X86::FISTTP16m ||
 528       MI->getOpcode() == X86::FISTTP32m ||
 529       MI->getOpcode() == X86::FISTTP64m) {
 530     assert(StackTop > 0 && "Stack empty??");
 531     --StackTop;
 532   } else if (KillsSrc) { // Last use of operand?
 533     popStackAfter(I);
 534   }
 535 }
 536
 537
 538 /// handleOneArgFPRW: Handle instructions that read from the top of stack and
 539 /// replace the value with a newly computed value.  These instructions may have
 540 /// non-fp operands after their FP operands.
 541 ///
 542 ///  Examples:
 543 ///     R1 = fchs R2
 544 ///     R1 = fadd R2, [mem]
 545 ///
 546 void FPS::handleOneArgFPRW(MachineBasicBlock::iterator &I) {
 547   MachineInstr *MI = I;
 548   unsigned NumOps = MI->getInstrDescriptor()->numOperands;
 549   assert(NumOps >= 2 && "FPRW instructions must have 2 ops!!");
 550
 551   // Is this the last use of the source register?
 552   unsigned Reg = getFPReg(MI->getOperand(1));
 553   bool KillsSrc = LV->KillsRegister(MI, X86::FP0+Reg);
 554
 555   if (KillsSrc) {
 556     // If this is the last use of the source register, just make sure it's on
 557     // the top of the stack.
 558     moveToTop(Reg, I);
 559     assert(StackTop > 0 && "Stack cannot be empty!");
 560     --StackTop;
 561     pushReg(getFPReg(MI->getOperand(0)));
 562   } else {
 563     // If this is not the last use of the source register, _copy_ it to the top
 564     // of the stack.
 565     duplicateToTop(Reg, getFPReg(MI->getOperand(0)), I);
 566   }
 567
 568   // Change from the pseudo instruction to the concrete instruction.
 569   MI->RemoveOperand(1);   // Drop the source operand.
 570   MI->RemoveOperand(0);   // Drop the destination operand.
 571   MI->setInstrDescriptor(TII->get(getConcreteOpcode(MI->getOpcode())));
 572 }
 573
 574
 575 //===----------------------------------------------------------------------===//
 576 // Define tables of various ways to map pseudo instructions
 577 //
 578
 579 // ForwardST0Table - Map: A = B op C  into: ST(0) = ST(0) op ST(i)
 580 static const TableEntry ForwardST0Table[] = {
 581   { X86::FpADD  , X86::FADDST0r },
 582   { X86::FpDIV  , X86::FDIVST0r },
 583   { X86::FpMUL  , X86::FMULST0r },
 584   { X86::FpSUB  , X86::FSUBST0r },
 585 };
 586
 587 // ReverseST0Table - Map: A = B op C  into: ST(0) = ST(i) op ST(0)
 588 static const TableEntry ReverseST0Table[] = {
 589   { X86::FpADD  , X86::FADDST0r  },   // commutative
 590   { X86::FpDIV  , X86::FDIVRST0r },
 591   { X86::FpMUL  , X86::FMULST0r  },   // commutative
 592   { X86::FpSUB  , X86::FSUBRST0r },
 593 };
 594
 595 // ForwardSTiTable - Map: A = B op C  into: ST(i) = ST(0) op ST(i)
 596 static const TableEntry ForwardSTiTable[] = {
 597   { X86::FpADD  , X86::FADDrST0  },   // commutative
 598   { X86::FpDIV  , X86::FDIVRrST0 },
 599   { X86::FpMUL  , X86::FMULrST0  },   // commutative
 600   { X86::FpSUB  , X86::FSUBRrST0 },
 601 };
 602
 603 // ReverseSTiTable - Map: A = B op C  into: ST(i) = ST(i) op ST(0)
 604 static const TableEntry ReverseSTiTable[] = {
 605   { X86::FpADD  , X86::FADDrST0 },
 606   { X86::FpDIV  , X86::FDIVrST0 },
 607   { X86::FpMUL  , X86::FMULrST0 },
 608   { X86::FpSUB  , X86::FSUBrST0 },
 609 };
 610
 611
 612 /// handleTwoArgFP - Handle instructions like FADD and friends which are virtual
 613 /// instructions which need to be simplified and possibly transformed.
 614 ///
 615 /// Result: ST(0) = fsub  ST(0), ST(i)
 616 ///         ST(i) = fsub  ST(0), ST(i)
 617 ///         ST(0) = fsubr ST(0), ST(i)
 618 ///         ST(i) = fsubr ST(0), ST(i)
 619 ///
 620 void FPS::handleTwoArgFP(MachineBasicBlock::iterator &I) {
 621   ASSERT_SORTED(ForwardST0Table); ASSERT_SORTED(ReverseST0Table);
 622   ASSERT_SORTED(ForwardSTiTable); ASSERT_SORTED(ReverseSTiTable);
 623   MachineInstr *MI = I;
 624
 625   unsigned NumOperands = MI->getInstrDescriptor()->numOperands;
 626   assert(NumOperands == 3 && "Illegal TwoArgFP instruction!");
 627   unsigned Dest = getFPReg(MI->getOperand(0));
 628   unsigned Op0 = getFPReg(MI->getOperand(NumOperands-2));
 629   unsigned Op1 = getFPReg(MI->getOperand(NumOperands-1));
 630   bool KillsOp0 = LV->KillsRegister(MI, X86::FP0+Op0);
 631   bool KillsOp1 = LV->KillsRegister(MI, X86::FP0+Op1);
 632
 633   unsigned TOS = getStackEntry(0);
 634
 635   // One of our operands must be on the top of the stack.  If neither is yet, we
 636   // need to move one.
 637   if (Op0 != TOS && Op1 != TOS) {   // No operand at TOS?
 638     // We can choose to move either operand to the top of the stack.  If one of
 639     // the operands is killed by this instruction, we want that one so that we
 640     // can update right on top of the old version.
 641     if (KillsOp0) {
 642       moveToTop(Op0, I);         // Move dead operand to TOS.
 643       TOS = Op0;
 644     } else if (KillsOp1) {
 645       moveToTop(Op1, I);
 646       TOS = Op1;
 647     } else {
 648       // All of the operands are live after this instruction executes, so we
 649       // cannot update on top of any operand.  Because of this, we must
 650       // duplicate one of the stack elements to the top.  It doesn't matter
 651       // which one we pick.
 652       //
 653       duplicateToTop(Op0, Dest, I);
 654       Op0 = TOS = Dest;
 655       KillsOp0 = true;
 656     }
 657   } else if (!KillsOp0 && !KillsOp1) {
 658     // If we DO have one of our operands at the top of the stack, but we don't
 659     // have a dead operand, we must duplicate one of the operands to a new slot
 660     // on the stack.
 661     duplicateToTop(Op0, Dest, I);
 662     Op0 = TOS = Dest;
 663     KillsOp0 = true;
 664   }
 665
 666   // Now we know that one of our operands is on the top of the stack, and at
 667   // least one of our operands is killed by this instruction.
 668   assert((TOS == Op0 || TOS == Op1) && (KillsOp0 || KillsOp1) &&
 669          "Stack conditions not set up right!");
 670
 671   // We decide which form to use based on what is on the top of the stack, and
 672   // which operand is killed by this instruction.
 673   const TableEntry *InstTable;
 674   bool isForward = TOS == Op0;
 675   bool updateST0 = (TOS == Op0 && !KillsOp1) || (TOS == Op1 && !KillsOp0);
 676   if (updateST0) {
 677     if (isForward)
 678       InstTable = ForwardST0Table;
 679     else
 680       InstTable = ReverseST0Table;
 681   } else {
 682     if (isForward)
 683       InstTable = ForwardSTiTable;
 684     else
 685       InstTable = ReverseSTiTable;
 686   }
 687
 688   int Opcode = Lookup(InstTable, ARRAY_SIZE(ForwardST0Table), MI->getOpcode());
 689   assert(Opcode != -1 && "Unknown TwoArgFP pseudo instruction!");
 690
 691   // NotTOS - The register which is not on the top of stack...
 692   unsigned NotTOS = (TOS == Op0) ? Op1 : Op0;
 693
 694   // Replace the old instruction with a new instruction
 695   MBB->remove(I++);
 696   I = BuildMI(*MBB, I, TII->get(Opcode)).addReg(getSTReg(NotTOS));
 697
 698   // If both operands are killed, pop one off of the stack in addition to
 699   // overwriting the other one.
 700   if (KillsOp0 && KillsOp1 && Op0 != Op1) {
 701     assert(!updateST0 && "Should have updated other operand!");
 702     popStackAfter(I);   // Pop the top of stack
 703   }
 704
 705   // Update stack information so that we know the destination register is now on
 706   // the stack.
 707   unsigned UpdatedSlot = getSlot(updateST0 ? TOS : NotTOS);
 708   assert(UpdatedSlot < StackTop && Dest < 7);
 709   Stack[UpdatedSlot]   = Dest;
 710   RegMap[Dest]         = UpdatedSlot;
 711   delete MI;   // Remove the old instruction
 712 }
 713
 714 /// handleCompareFP - Handle FUCOM and FUCOMI instructions, which have two FP
 715 /// register arguments and no explicit destinations.
 716 ///
 717 void FPS::handleCompareFP(MachineBasicBlock::iterator &I) {
 718   ASSERT_SORTED(ForwardST0Table); ASSERT_SORTED(ReverseST0Table);
 719   ASSERT_SORTED(ForwardSTiTable); ASSERT_SORTED(ReverseSTiTable);
 720   MachineInstr *MI = I;
 721
 722   unsigned NumOperands = MI->getInstrDescriptor()->numOperands;
 723   assert(NumOperands == 2 && "Illegal FUCOM* instruction!");
 724   unsigned Op0 = getFPReg(MI->getOperand(NumOperands-2));
 725   unsigned Op1 = getFPReg(MI->getOperand(NumOperands-1));
 726   bool KillsOp0 = LV->KillsRegister(MI, X86::FP0+Op0);
 727   bool KillsOp1 = LV->KillsRegister(MI, X86::FP0+Op1);
 728
 729   // Make sure the first operand is on the top of stack, the other one can be
 730   // anywhere.
 731   moveToTop(Op0, I);
 732
 733   // Change from the pseudo instruction to the concrete instruction.
 734   MI->getOperand(0).setReg(getSTReg(Op1));
 735   MI->RemoveOperand(1);
 736   MI->setInstrDescriptor(TII->get(getConcreteOpcode(MI->getOpcode())));
 737
 738   // If any of the operands are killed by this instruction, free them.
 739   if (KillsOp0) freeStackSlotAfter(I, Op0);
 740   if (KillsOp1 && Op0 != Op1) freeStackSlotAfter(I, Op1);
 741 }
 742
 743 /// handleCondMovFP - Handle two address conditional move instructions.  These
 744 /// instructions move a st(i) register to st(0) iff a condition is true.  These
 745 /// instructions require that the first operand is at the top of the stack, but
 746 /// otherwise don't modify the stack at all.
 747 void FPS::handleCondMovFP(MachineBasicBlock::iterator &I) {
 748   MachineInstr *MI = I;
 749
 750   unsigned Op0 = getFPReg(MI->getOperand(0));
 751   unsigned Op1 = getFPReg(MI->getOperand(2));
 752   bool KillsOp1 = LV->KillsRegister(MI, X86::FP0+Op1);
 753
 754   // The first operand *must* be on the top of the stack.
 755   moveToTop(Op0, I);
 756
 757   // Change the second operand to the stack register that the operand is in.
 758   // Change from the pseudo instruction to the concrete instruction.
 759   MI->RemoveOperand(0);
 760   MI->RemoveOperand(1);
 761   MI->getOperand(0).setReg(getSTReg(Op1));
 762   MI->setInstrDescriptor(TII->get(getConcreteOpcode(MI->getOpcode())));
 763
 764   // If we kill the second operand, make sure to pop it from the stack.
 765   if (Op0 != Op1 && KillsOp1) {
 766     // Get this value off of the register stack.
 767     freeStackSlotAfter(I, Op1);
 768   }
 769 }
 770
 771
 772 /// handleSpecialFP - Handle special instructions which behave unlike other
 773 /// floating point instructions.  This is primarily intended for use by pseudo
 774 /// instructions.
 775 ///
 776 void FPS::handleSpecialFP(MachineBasicBlock::iterator &I) {
 777   MachineInstr *MI = I;
 778   switch (MI->getOpcode()) {
 779   default: assert(0 && "Unknown SpecialFP instruction!");
 780   case X86::FpGETRESULT:  // Appears immediately after a call returning FP type!
 781     assert(StackTop == 0 && "Stack should be empty after a call!");
 782     pushReg(getFPReg(MI->getOperand(0)));
 783     break;
 784   case X86::FpSETRESULT:
 785     assert(StackTop == 1 && "Stack should have one element on it to return!");
 786     --StackTop;   // "Forget" we have something on the top of stack!
 787     break;
 788   case X86::FpMOV: {
 789     unsigned SrcReg = getFPReg(MI->getOperand(1));
 790     unsigned DestReg = getFPReg(MI->getOperand(0));
 791
 792     if (LV->KillsRegister(MI, X86::FP0+SrcReg)) {
 793       // If the input operand is killed, we can just change the owner of the
 794       // incoming stack slot into the result.
 795       unsigned Slot = getSlot(SrcReg);
 796       assert(Slot < 7 && DestReg < 7 && "FpMOV operands invalid!");
 797       Stack[Slot] = DestReg;
 798       RegMap[DestReg] = Slot;
 799
 800     } else {
 801       // For FMOV we just duplicate the specified value to a new stack slot.
 802       // This could be made better, but would require substantial changes.
 803       duplicateToTop(SrcReg, DestReg, I);
 804     }
 805     break;
 806   }
 807   }
 808
 809   I = MBB->erase(I);  // Remove the pseudo instruction
 810   --I;
 811 }