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::XCH_F)).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::LD_Frr)).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::ABS_Fp32     , X86::ABS_F     },
 328   { X86::ABS_Fp64     , X86::ABS_F     },
 329   { X86::ADD_Fp32m    , X86::ADD_F32m  },
 330   { X86::ADD_Fp64m    , X86::ADD_F64m  },
 331   { X86::ADD_Fp64m32  , X86::ADD_F32m  },
 332   { X86::ADD_FpI16m32 , X86::ADD_FI16m },
 333   { X86::ADD_FpI16m64 , X86::ADD_FI16m },
 334   { X86::ADD_FpI32m32 , X86::ADD_FI32m },
 335   { X86::ADD_FpI32m64 , X86::ADD_FI32m },
 336   { X86::CHS_Fp32     , X86::CHS_F     },
 337   { X86::CHS_Fp64     , X86::CHS_F     },
 338   { X86::CMOVBE_Fp32  , X86::CMOVBE_F  },
 339   { X86::CMOVBE_Fp64  , X86::CMOVBE_F  },
 340   { X86::CMOVB_Fp32   , X86::CMOVB_F   },
 341   { X86::CMOVB_Fp64   , X86::CMOVB_F  },
 342   { X86::CMOVE_Fp32   , X86::CMOVE_F  },
 343   { X86::CMOVE_Fp64   , X86::CMOVE_F   },
 344   { X86::CMOVNBE_Fp32 , X86::CMOVNBE_F },
 345   { X86::CMOVNBE_Fp64 , X86::CMOVNBE_F },
 346   { X86::CMOVNB_Fp32  , X86::CMOVNB_F  },
 347   { X86::CMOVNB_Fp64  , X86::CMOVNB_F  },
 348   { X86::CMOVNE_Fp32  , X86::CMOVNE_F  },
 349   { X86::CMOVNE_Fp64  , X86::CMOVNE_F  },
 350   { X86::CMOVNP_Fp32  , X86::CMOVNP_F  },
 351   { X86::CMOVNP_Fp64  , X86::CMOVNP_F  },
 352   { X86::CMOVP_Fp32   , X86::CMOVP_F   },
 353   { X86::CMOVP_Fp64   , X86::CMOVP_F   },
 354   { X86::COS_Fp32     , X86::COS_F     },
 355   { X86::COS_Fp64     , X86::COS_F     },
 356   { X86::DIVR_Fp32m   , X86::DIVR_F32m },
 357   { X86::DIVR_Fp64m   , X86::DIVR_F64m },
 358   { X86::DIVR_Fp64m32 , X86::DIVR_F32m },
 359   { X86::DIVR_FpI16m32, X86::DIVR_FI16m},
 360   { X86::DIVR_FpI16m64, X86::DIVR_FI16m},
 361   { X86::DIVR_FpI32m32, X86::DIVR_FI32m},
 362   { X86::DIVR_FpI32m64, X86::DIVR_FI32m},
 363   { X86::DIV_Fp32m    , X86::DIV_F32m  },
 364   { X86::DIV_Fp64m    , X86::DIV_F64m  },
 365   { X86::DIV_Fp64m32  , X86::DIV_F32m  },
 366   { X86::DIV_FpI16m32 , X86::DIV_FI16m },
 367   { X86::DIV_FpI16m64 , X86::DIV_FI16m },
 368   { X86::DIV_FpI32m32 , X86::DIV_FI32m },
 369   { X86::DIV_FpI32m64 , X86::DIV_FI32m },
 370   { X86::ILD_Fp16m32  , X86::ILD_F16m  },
 371   { X86::ILD_Fp16m64  , X86::ILD_F16m  },
 372   { X86::ILD_Fp32m32  , X86::ILD_F32m  },
 373   { X86::ILD_Fp32m64  , X86::ILD_F32m  },
 374   { X86::ILD_Fp64m32  , X86::ILD_F64m  },
 375   { X86::ILD_Fp64m64  , X86::ILD_F64m  },
 376   { X86::ISTT_Fp16m32 , X86::ISTT_FP16m},
 377   { X86::ISTT_Fp16m64 , X86::ISTT_FP16m},
 378   { X86::ISTT_Fp32m32 , X86::ISTT_FP32m},
 379   { X86::ISTT_Fp32m64 , X86::ISTT_FP32m},
 380   { X86::ISTT_Fp64m32 , X86::ISTT_FP64m},
 381   { X86::ISTT_Fp64m64 , X86::ISTT_FP64m},
 382   { X86::IST_Fp16m32  , X86::IST_F16m  },
 383   { X86::IST_Fp16m64  , X86::IST_F16m  },
 384   { X86::IST_Fp32m32  , X86::IST_F32m  },
 385   { X86::IST_Fp32m64  , X86::IST_F32m  },
 386   { X86::IST_Fp64m32  , X86::IST_FP64m },
 387   { X86::IST_Fp64m64  , X86::IST_FP64m },
 388   { X86::LD_Fp032     , X86::LD_F0     },
 389   { X86::LD_Fp064     , X86::LD_F0     },
 390   { X86::LD_Fp132     , X86::LD_F1     },
 391   { X86::LD_Fp164     , X86::LD_F1     },
 392   { X86::LD_Fp32m     , X86::LD_F32m   },
 393   { X86::LD_Fp64m     , X86::LD_F64m   },
 394   { X86::MUL_Fp32m    , X86::MUL_F32m  },
 395   { X86::MUL_Fp64m    , X86::MUL_F64m  },
 396   { X86::MUL_Fp64m32  , X86::MUL_F32m  },
 397   { X86::MUL_FpI16m32 , X86::MUL_FI16m },
 398   { X86::MUL_FpI16m64 , X86::MUL_FI16m },
 399   { X86::MUL_FpI32m32 , X86::MUL_FI32m },
 400   { X86::MUL_FpI32m64 , X86::MUL_FI32m },
 401   { X86::SIN_Fp32     , X86::SIN_F     },
 402   { X86::SIN_Fp64     , X86::SIN_F     },
 403   { X86::SQRT_Fp32    , X86::SQRT_F    },
 404   { X86::SQRT_Fp64    , X86::SQRT_F    },
 405   { X86::ST_Fp32m     , X86::ST_F32m   },
 406   { X86::ST_Fp64m     , X86::ST_F64m   },
 407   { X86::ST_Fp64m32   , X86::ST_F32m   },
 408   { X86::SUBR_Fp32m   , X86::SUBR_F32m },
 409   { X86::SUBR_Fp64m   , X86::SUBR_F64m },
 410   { X86::SUBR_Fp64m32 , X86::SUBR_F32m },
 411   { X86::SUBR_FpI16m32, X86::SUBR_FI16m},
 412   { X86::SUBR_FpI16m64, X86::SUBR_FI16m},
 413   { X86::SUBR_FpI32m32, X86::SUBR_FI32m},
 414   { X86::SUBR_FpI32m64, X86::SUBR_FI32m},
 415   { X86::SUB_Fp32m    , X86::SUB_F32m  },
 416   { X86::SUB_Fp64m    , X86::SUB_F64m  },
 417   { X86::SUB_Fp64m32  , X86::SUB_F32m  },
 418   { X86::SUB_FpI16m32 , X86::SUB_FI16m },
 419   { X86::SUB_FpI16m64 , X86::SUB_FI16m },
 420   { X86::SUB_FpI32m32 , X86::SUB_FI32m },
 421   { X86::SUB_FpI32m64 , X86::SUB_FI32m },
 422   { X86::TST_Fp32     , X86::TST_F     },
 423   { X86::TST_Fp64     , X86::TST_F     },
 424   { X86::UCOM_FpIr32  , X86::UCOM_FIr  },
 425   { X86::UCOM_FpIr64  , X86::UCOM_FIr  },
 426   { X86::UCOM_Fpr32   , X86::UCOM_Fr   },
 427   { X86::UCOM_Fpr64   , X86::UCOM_Fr   },
 428 };
 429
 430 static unsigned getConcreteOpcode(unsigned Opcode) {
 431   ASSERT_SORTED(OpcodeTable);
 432   int Opc = Lookup(OpcodeTable, ARRAY_SIZE(OpcodeTable), Opcode);
 433   assert(Opc != -1 && "FP Stack instruction not in OpcodeTable!");
 434   return Opc;
 435 }
 436
 437 //===----------------------------------------------------------------------===//
 438 // Helper Methods
 439 //===----------------------------------------------------------------------===//
 440
 441 // PopTable - Sorted map of instructions to their popping version.  The first
 442 // element is an instruction, the second is the version which pops.
 443 //
 444 static const TableEntry PopTable[] = {
 445   { X86::ADD_FrST0 , X86::ADD_FPrST0  },
 446
 447   { X86::DIVR_FrST0, X86::DIVR_FPrST0 },
 448   { X86::DIV_FrST0 , X86::DIV_FPrST0  },
 449
 450   { X86::IST_F16m  , X86::IST_FP16m   },
 451   { X86::IST_F32m  , X86::IST_FP32m   },
 452
 453   { X86::MUL_FrST0 , X86::MUL_FPrST0  },
 454
 455   { X86::ST_F32m   , X86::ST_FP32m    },
 456   { X86::ST_F64m   , X86::ST_FP64m    },
 457   { X86::ST_Frr    , X86::ST_FPrr     },
 458
 459   { X86::SUBR_FrST0, X86::SUBR_FPrST0 },
 460   { X86::SUB_FrST0 , X86::SUB_FPrST0  },
 461
 462   { X86::UCOM_FIr  , X86::UCOM_FIPr   },
 463
 464   { X86::UCOM_FPr  , X86::UCOM_FPPr   },
 465   { X86::UCOM_Fr   , X86::UCOM_FPr    },
 466 };
 467
 468 /// popStackAfter - Pop the current value off of the top of the FP stack after
 469 /// the specified instruction.  This attempts to be sneaky and combine the pop
 470 /// into the instruction itself if possible.  The iterator is left pointing to
 471 /// the last instruction, be it a new pop instruction inserted, or the old
 472 /// instruction if it was modified in place.
 473 ///
 474 void FPS::popStackAfter(MachineBasicBlock::iterator &I) {
 475   ASSERT_SORTED(PopTable);
 476   assert(StackTop > 0 && "Cannot pop empty stack!");
 477   RegMap[Stack[--StackTop]] = ~0;     // Update state
 478
 479   // Check to see if there is a popping version of this instruction...
 480   int Opcode = Lookup(PopTable, ARRAY_SIZE(PopTable), I->getOpcode());
 481   if (Opcode != -1) {
 482     I->setInstrDescriptor(TII->get(Opcode));
 483     if (Opcode == X86::UCOM_FPPr)
 484       I->RemoveOperand(0);
 485   } else {    // Insert an explicit pop
 486     I = BuildMI(*MBB, ++I, TII->get(X86::ST_FPrr)).addReg(X86::ST0);
 487   }
 488 }
 489
 490 /// freeStackSlotAfter - Free the specified register from the register stack, so
 491 /// that it is no longer in a register.  If the register is currently at the top
 492 /// of the stack, we just pop the current instruction, otherwise we store the
 493 /// current top-of-stack into the specified slot, then pop the top of stack.
 494 void FPS::freeStackSlotAfter(MachineBasicBlock::iterator &I, unsigned FPRegNo) {
 495   if (getStackEntry(0) == FPRegNo) {  // already at the top of stack? easy.
 496     popStackAfter(I);
 497     return;
 498   }
 499
 500   // Otherwise, store the top of stack into the dead slot, killing the operand
 501   // without having to add in an explicit xchg then pop.
 502   //
 503   unsigned STReg    = getSTReg(FPRegNo);
 504   unsigned OldSlot  = getSlot(FPRegNo);
 505   unsigned TopReg   = Stack[StackTop-1];
 506   Stack[OldSlot]    = TopReg;
 507   RegMap[TopReg]    = OldSlot;
 508   RegMap[FPRegNo]   = ~0;
 509   Stack[--StackTop] = ~0;
 510   I = BuildMI(*MBB, ++I, TII->get(X86::ST_FPrr)).addReg(STReg);
 511 }
 512
 513
 514 static unsigned getFPReg(const MachineOperand &MO) {
 515   assert(MO.isRegister() && "Expected an FP register!");
 516   unsigned Reg = MO.getReg();
 517   assert(Reg >= X86::FP0 && Reg <= X86::FP6 && "Expected FP register!");
 518   return Reg - X86::FP0;
 519 }
 520
 521
 522 //===----------------------------------------------------------------------===//
 523 // Instruction transformation implementation
 524 //===----------------------------------------------------------------------===//
 525
 526 /// handleZeroArgFP - ST(0) = fld0    ST(0) = flds <mem>
 527 ///
 528 void FPS::handleZeroArgFP(MachineBasicBlock::iterator &I) {
 529   MachineInstr *MI = I;
 530   unsigned DestReg = getFPReg(MI->getOperand(0));
 531
 532   // Change from the pseudo instruction to the concrete instruction.
 533   MI->RemoveOperand(0);   // Remove the explicit ST(0) operand
 534   MI->setInstrDescriptor(TII->get(getConcreteOpcode(MI->getOpcode())));
 535
 536   // Result gets pushed on the stack.
 537   pushReg(DestReg);
 538 }
 539
 540 /// handleOneArgFP - fst <mem>, ST(0)
 541 ///
 542 void FPS::handleOneArgFP(MachineBasicBlock::iterator &I) {
 543   MachineInstr *MI = I;
 544   unsigned NumOps = MI->getInstrDescriptor()->numOperands;
 545   assert((NumOps == 5 || NumOps == 1) &&
 546          "Can only handle fst* & ftst instructions!");
 547
 548   // Is this the last use of the source register?
 549   unsigned Reg = getFPReg(MI->getOperand(NumOps-1));
 550   bool KillsSrc = LV->KillsRegister(MI, X86::FP0+Reg);
 551
 552   // FISTP64m is strange because there isn't a non-popping versions.
 553   // If we have one _and_ we don't want to pop the operand, duplicate the value
 554   // on the stack instead of moving it.  This ensure that popping the value is
 555   // always ok.
 556   // Ditto FISTTP16m, FISTTP32m, FISTTP64m.
 557   //
 558   if (!KillsSrc &&
 559       (MI->getOpcode() == X86::IST_Fp64m32 ||
 560        MI->getOpcode() == X86::ISTT_Fp16m32 ||
 561        MI->getOpcode() == X86::ISTT_Fp32m32 ||
 562        MI->getOpcode() == X86::ISTT_Fp64m32 ||
 563        MI->getOpcode() == X86::IST_Fp64m64 ||
 564        MI->getOpcode() == X86::ISTT_Fp16m64 ||
 565        MI->getOpcode() == X86::ISTT_Fp32m64 ||
 566        MI->getOpcode() == X86::ISTT_Fp64m64)) {
 567     duplicateToTop(Reg, 7 /*temp register*/, I);
 568   } else {
 569     moveToTop(Reg, I);            // Move to the top of the stack...
 570   }
 571
 572   // Convert from the pseudo instruction to the concrete instruction.
 573   MI->RemoveOperand(NumOps-1);    // Remove explicit ST(0) operand
 574   MI->setInstrDescriptor(TII->get(getConcreteOpcode(MI->getOpcode())));
 575
 576   if (MI->getOpcode() == X86::IST_FP64m ||
 577       MI->getOpcode() == X86::ISTT_FP16m ||
 578       MI->getOpcode() == X86::ISTT_FP32m ||
 579       MI->getOpcode() == X86::ISTT_FP64m) {
 580     assert(StackTop > 0 && "Stack empty??");
 581     --StackTop;
 582   } else if (KillsSrc) { // Last use of operand?
 583     popStackAfter(I);
 584   }
 585 }
 586
 587
 588 /// handleOneArgFPRW: Handle instructions that read from the top of stack and
 589 /// replace the value with a newly computed value.  These instructions may have
 590 /// non-fp operands after their FP operands.
 591 ///
 592 ///  Examples:
 593 ///     R1 = fchs R2
 594 ///     R1 = fadd R2, [mem]
 595 ///
 596 void FPS::handleOneArgFPRW(MachineBasicBlock::iterator &I) {
 597   MachineInstr *MI = I;
 598   unsigned NumOps = MI->getInstrDescriptor()->numOperands;
 599   assert(NumOps >= 2 && "FPRW instructions must have 2 ops!!");
 600
 601   // Is this the last use of the source register?
 602   unsigned Reg = getFPReg(MI->getOperand(1));
 603   bool KillsSrc = LV->KillsRegister(MI, X86::FP0+Reg);
 604
 605   if (KillsSrc) {
 606     // If this is the last use of the source register, just make sure it's on
 607     // the top of the stack.
 608     moveToTop(Reg, I);
 609     assert(StackTop > 0 && "Stack cannot be empty!");
 610     --StackTop;
 611     pushReg(getFPReg(MI->getOperand(0)));
 612   } else {
 613     // If this is not the last use of the source register, _copy_ it to the top
 614     // of the stack.
 615     duplicateToTop(Reg, getFPReg(MI->getOperand(0)), I);
 616   }
 617
 618   // Change from the pseudo instruction to the concrete instruction.
 619   MI->RemoveOperand(1);   // Drop the source operand.
 620   MI->RemoveOperand(0);   // Drop the destination operand.
 621   MI->setInstrDescriptor(TII->get(getConcreteOpcode(MI->getOpcode())));
 622 }
 623
 624
 625 //===----------------------------------------------------------------------===//
 626 // Define tables of various ways to map pseudo instructions
 627 //
 628
 629 // ForwardST0Table - Map: A = B op C  into: ST(0) = ST(0) op ST(i)
 630 static const TableEntry ForwardST0Table[] = {
 631   { X86::ADD_Fp32  , X86::ADD_FST0r },
 632   { X86::ADD_Fp64  , X86::ADD_FST0r },
 633   { X86::DIV_Fp32  , X86::DIV_FST0r },
 634   { X86::DIV_Fp64  , X86::DIV_FST0r },
 635   { X86::MUL_Fp32  , X86::MUL_FST0r },
 636   { X86::MUL_Fp64  , X86::MUL_FST0r },
 637   { X86::SUB_Fp32  , X86::SUB_FST0r },
 638   { X86::SUB_Fp64  , X86::SUB_FST0r },
 639 };
 640
 641 // ReverseST0Table - Map: A = B op C  into: ST(0) = ST(i) op ST(0)
 642 static const TableEntry ReverseST0Table[] = {
 643   { X86::ADD_Fp32  , X86::ADD_FST0r  },   // commutative
 644   { X86::ADD_Fp64  , X86::ADD_FST0r  },   // commutative
 645   { X86::DIV_Fp32  , X86::DIVR_FST0r },
 646   { X86::DIV_Fp64  , X86::DIVR_FST0r },
 647   { X86::MUL_Fp32  , X86::MUL_FST0r  },   // commutative
 648   { X86::MUL_Fp64  , X86::MUL_FST0r  },   // commutative
 649   { X86::SUB_Fp32  , X86::SUBR_FST0r },
 650   { X86::SUB_Fp64  , X86::SUBR_FST0r },
 651 };
 652
 653 // ForwardSTiTable - Map: A = B op C  into: ST(i) = ST(0) op ST(i)
 654 static const TableEntry ForwardSTiTable[] = {
 655   { X86::ADD_Fp32  , X86::ADD_FrST0  },   // commutative
 656   { X86::ADD_Fp64  , X86::ADD_FrST0  },   // commutative
 657   { X86::DIV_Fp32  , X86::DIVR_FrST0 },
 658   { X86::DIV_Fp64  , X86::DIVR_FrST0 },
 659   { X86::MUL_Fp32  , X86::MUL_FrST0  },   // commutative
 660   { X86::MUL_Fp64  , X86::MUL_FrST0  },   // commutative
 661   { X86::SUB_Fp32  , X86::SUBR_FrST0 },
 662   { X86::SUB_Fp64  , X86::SUBR_FrST0 },
 663 };
 664
 665 // ReverseSTiTable - Map: A = B op C  into: ST(i) = ST(i) op ST(0)
 666 static const TableEntry ReverseSTiTable[] = {
 667   { X86::ADD_Fp32  , X86::ADD_FrST0 },
 668   { X86::ADD_Fp64  , X86::ADD_FrST0 },
 669   { X86::DIV_Fp32  , X86::DIV_FrST0 },
 670   { X86::DIV_Fp64  , X86::DIV_FrST0 },
 671   { X86::MUL_Fp32  , X86::MUL_FrST0 },
 672   { X86::MUL_Fp64  , X86::MUL_FrST0 },
 673   { X86::SUB_Fp32  , X86::SUB_FrST0 },
 674   { X86::SUB_Fp64  , X86::SUB_FrST0 },
 675 };
 676
 677
 678 /// handleTwoArgFP - Handle instructions like FADD and friends which are virtual
 679 /// instructions which need to be simplified and possibly transformed.
 680 ///
 681 /// Result: ST(0) = fsub  ST(0), ST(i)
 682 ///         ST(i) = fsub  ST(0), ST(i)
 683 ///         ST(0) = fsubr ST(0), ST(i)
 684 ///         ST(i) = fsubr ST(0), ST(i)
 685 ///
 686 void FPS::handleTwoArgFP(MachineBasicBlock::iterator &I) {
 687   ASSERT_SORTED(ForwardST0Table); ASSERT_SORTED(ReverseST0Table);
 688   ASSERT_SORTED(ForwardSTiTable); ASSERT_SORTED(ReverseSTiTable);
 689   MachineInstr *MI = I;
 690
 691   unsigned NumOperands = MI->getInstrDescriptor()->numOperands;
 692   assert(NumOperands == 3 && "Illegal TwoArgFP instruction!");
 693   unsigned Dest = getFPReg(MI->getOperand(0));
 694   unsigned Op0 = getFPReg(MI->getOperand(NumOperands-2));
 695   unsigned Op1 = getFPReg(MI->getOperand(NumOperands-1));
 696   bool KillsOp0 = LV->KillsRegister(MI, X86::FP0+Op0);
 697   bool KillsOp1 = LV->KillsRegister(MI, X86::FP0+Op1);
 698
 699   unsigned TOS = getStackEntry(0);
 700
 701   // One of our operands must be on the top of the stack.  If neither is yet, we
 702   // need to move one.
 703   if (Op0 != TOS && Op1 != TOS) {   // No operand at TOS?
 704     // We can choose to move either operand to the top of the stack.  If one of
 705     // the operands is killed by this instruction, we want that one so that we
 706     // can update right on top of the old version.
 707     if (KillsOp0) {
 708       moveToTop(Op0, I);         // Move dead operand to TOS.
 709       TOS = Op0;
 710     } else if (KillsOp1) {
 711       moveToTop(Op1, I);
 712       TOS = Op1;
 713     } else {
 714       // All of the operands are live after this instruction executes, so we
 715       // cannot update on top of any operand.  Because of this, we must
 716       // duplicate one of the stack elements to the top.  It doesn't matter
 717       // which one we pick.
 718       //
 719       duplicateToTop(Op0, Dest, I);
 720       Op0 = TOS = Dest;
 721       KillsOp0 = true;
 722     }
 723   } else if (!KillsOp0 && !KillsOp1) {
 724     // If we DO have one of our operands at the top of the stack, but we don't
 725     // have a dead operand, we must duplicate one of the operands to a new slot
 726     // on the stack.
 727     duplicateToTop(Op0, Dest, I);
 728     Op0 = TOS = Dest;
 729     KillsOp0 = true;
 730   }
 731
 732   // Now we know that one of our operands is on the top of the stack, and at
 733   // least one of our operands is killed by this instruction.
 734   assert((TOS == Op0 || TOS == Op1) && (KillsOp0 || KillsOp1) &&
 735          "Stack conditions not set up right!");
 736
 737   // We decide which form to use based on what is on the top of the stack, and
 738   // which operand is killed by this instruction.
 739   const TableEntry *InstTable;
 740   bool isForward = TOS == Op0;
 741   bool updateST0 = (TOS == Op0 && !KillsOp1) || (TOS == Op1 && !KillsOp0);
 742   if (updateST0) {
 743     if (isForward)
 744       InstTable = ForwardST0Table;
 745     else
 746       InstTable = ReverseST0Table;
 747   } else {
 748     if (isForward)
 749       InstTable = ForwardSTiTable;
 750     else
 751       InstTable = ReverseSTiTable;
 752   }
 753
 754   int Opcode = Lookup(InstTable, ARRAY_SIZE(ForwardST0Table), MI->getOpcode());
 755   assert(Opcode != -1 && "Unknown TwoArgFP pseudo instruction!");
 756
 757   // NotTOS - The register which is not on the top of stack...
 758   unsigned NotTOS = (TOS == Op0) ? Op1 : Op0;
 759
 760   // Replace the old instruction with a new instruction
 761   MBB->remove(I++);
 762   I = BuildMI(*MBB, I, TII->get(Opcode)).addReg(getSTReg(NotTOS));
 763
 764   // If both operands are killed, pop one off of the stack in addition to
 765   // overwriting the other one.
 766   if (KillsOp0 && KillsOp1 && Op0 != Op1) {
 767     assert(!updateST0 && "Should have updated other operand!");
 768     popStackAfter(I);   // Pop the top of stack
 769   }
 770
 771   // Update stack information so that we know the destination register is now on
 772   // the stack.
 773   unsigned UpdatedSlot = getSlot(updateST0 ? TOS : NotTOS);
 774   assert(UpdatedSlot < StackTop && Dest < 7);
 775   Stack[UpdatedSlot]   = Dest;
 776   RegMap[Dest]         = UpdatedSlot;
 777   delete MI;   // Remove the old instruction
 778 }
 779
 780 /// handleCompareFP - Handle FUCOM and FUCOMI instructions, which have two FP
 781 /// register arguments and no explicit destinations.
 782 ///
 783 void FPS::handleCompareFP(MachineBasicBlock::iterator &I) {
 784   ASSERT_SORTED(ForwardST0Table); ASSERT_SORTED(ReverseST0Table);
 785   ASSERT_SORTED(ForwardSTiTable); ASSERT_SORTED(ReverseSTiTable);
 786   MachineInstr *MI = I;
 787
 788   unsigned NumOperands = MI->getInstrDescriptor()->numOperands;
 789   assert(NumOperands == 2 && "Illegal FUCOM* instruction!");
 790   unsigned Op0 = getFPReg(MI->getOperand(NumOperands-2));
 791   unsigned Op1 = getFPReg(MI->getOperand(NumOperands-1));
 792   bool KillsOp0 = LV->KillsRegister(MI, X86::FP0+Op0);
 793   bool KillsOp1 = LV->KillsRegister(MI, X86::FP0+Op1);
 794
 795   // Make sure the first operand is on the top of stack, the other one can be
 796   // anywhere.
 797   moveToTop(Op0, I);
 798
 799   // Change from the pseudo instruction to the concrete instruction.
 800   MI->getOperand(0).setReg(getSTReg(Op1));
 801   MI->RemoveOperand(1);
 802   MI->setInstrDescriptor(TII->get(getConcreteOpcode(MI->getOpcode())));
 803
 804   // If any of the operands are killed by this instruction, free them.
 805   if (KillsOp0) freeStackSlotAfter(I, Op0);
 806   if (KillsOp1 && Op0 != Op1) freeStackSlotAfter(I, Op1);
 807 }
 808
 809 /// handleCondMovFP - Handle two address conditional move instructions.  These
 810 /// instructions move a st(i) register to st(0) iff a condition is true.  These
 811 /// instructions require that the first operand is at the top of the stack, but
 812 /// otherwise don't modify the stack at all.
 813 void FPS::handleCondMovFP(MachineBasicBlock::iterator &I) {
 814   MachineInstr *MI = I;
 815
 816   unsigned Op0 = getFPReg(MI->getOperand(0));
 817   unsigned Op1 = getFPReg(MI->getOperand(2));
 818   bool KillsOp1 = LV->KillsRegister(MI, X86::FP0+Op1);
 819
 820   // The first operand *must* be on the top of the stack.
 821   moveToTop(Op0, I);
 822
 823   // Change the second operand to the stack register that the operand is in.
 824   // Change from the pseudo instruction to the concrete instruction.
 825   MI->RemoveOperand(0);
 826   MI->RemoveOperand(1);
 827   MI->getOperand(0).setReg(getSTReg(Op1));
 828   MI->setInstrDescriptor(TII->get(getConcreteOpcode(MI->getOpcode())));
 829
 830   // If we kill the second operand, make sure to pop it from the stack.
 831   if (Op0 != Op1 && KillsOp1) {
 832     // Get this value off of the register stack.
 833     freeStackSlotAfter(I, Op1);
 834   }
 835 }
 836
 837
 838 /// handleSpecialFP - Handle special instructions which behave unlike other
 839 /// floating point instructions.  This is primarily intended for use by pseudo
 840 /// instructions.
 841 ///
 842 void FPS::handleSpecialFP(MachineBasicBlock::iterator &I) {
 843   MachineInstr *MI = I;
 844   switch (MI->getOpcode()) {
 845   default: assert(0 && "Unknown SpecialFP instruction!");
 846   case X86::FpGETRESULT32:  // Appears immediately after a call returning FP type!
 847   case X86::FpGETRESULT64:  // Appears immediately after a call returning FP type!
 848     assert(StackTop == 0 && "Stack should be empty after a call!");
 849     pushReg(getFPReg(MI->getOperand(0)));
 850     break;
 851   case X86::FpSETRESULT32:
 852   case X86::FpSETRESULT64:
 853     assert(StackTop == 1 && "Stack should have one element on it to return!");
 854     --StackTop;   // "Forget" we have something on the top of stack!
 855     break;
 856   case X86::MOV_Fp3232:
 857   case X86::MOV_Fp3264:
 858   case X86::MOV_Fp6432:
 859   case X86::MOV_Fp6464: {
 860     unsigned SrcReg = getFPReg(MI->getOperand(1));
 861     unsigned DestReg = getFPReg(MI->getOperand(0));
 862
 863     if (LV->KillsRegister(MI, X86::FP0+SrcReg)) {
 864       // If the input operand is killed, we can just change the owner of the
 865       // incoming stack slot into the result.
 866       unsigned Slot = getSlot(SrcReg);
 867       assert(Slot < 7 && DestReg < 7 && "FpMOV operands invalid!");
 868       Stack[Slot] = DestReg;
 869       RegMap[DestReg] = Slot;
 870
 871     } else {
 872       // For FMOV we just duplicate the specified value to a new stack slot.
 873       // This could be made better, but would require substantial changes.
 874       duplicateToTop(SrcReg, DestReg, I);
 875     }
 876     break;
 877   }
 878   }
 879
 880   I = MBB->erase(I);  // Remove the pseudo instruction
 881   --I;
 882 }