Allow the FP stackifier to completely ignore functions that do not use FP at
[oota-llvm.git] / 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 "fp"
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/ADT/DepthFirstIterator.h"
42 #include "llvm/ADT/Statistic.h"
43 #include "llvm/ADT/STLExtras.h"
44 #include <algorithm>
45 #include <set>
46 using namespace llvm;
47
48 namespace {
49   Statistic<> NumFXCH("x86-codegen", "Number of fxch instructions inserted");
50   Statistic<> NumFP  ("x86-codegen", "Number of floating point instructions");
51
52   struct FPS : public MachineFunctionPass {
53     virtual bool runOnMachineFunction(MachineFunction &MF);
54
55     virtual const char *getPassName() const { return "X86 FP Stackifier"; }
56
57     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
58       AU.addRequired<LiveVariables>();
59       MachineFunctionPass::getAnalysisUsage(AU);
60     }
61   private:
62     LiveVariables     *LV;    // Live variable info for current function...
63     MachineBasicBlock *MBB;   // Current basic block
64     unsigned Stack[8];        // FP<n> Registers in each stack slot...
65     unsigned RegMap[8];       // Track which stack slot contains each register
66     unsigned StackTop;        // The current top of the FP stack.
67
68     void dumpStack() const {
69       std::cerr << "Stack contents:";
70       for (unsigned i = 0; i != StackTop; ++i) {
71         std::cerr << " FP" << Stack[i];
72         assert(RegMap[Stack[i]] == i && "Stack[] doesn't match RegMap[]!"); 
73       }
74       std::cerr << "\n";
75     }
76   private:
77     // getSlot - Return the stack slot number a particular register number is
78     // in...
79     unsigned getSlot(unsigned RegNo) const {
80       assert(RegNo < 8 && "Regno out of range!");
81       return RegMap[RegNo];
82     }
83
84     // getStackEntry - Return the X86::FP<n> register in register ST(i)
85     unsigned getStackEntry(unsigned STi) const {
86       assert(STi < StackTop && "Access past stack top!");
87       return Stack[StackTop-1-STi];
88     }
89
90     // getSTReg - Return the X86::ST(i) register which contains the specified
91     // FP<RegNo> register
92     unsigned getSTReg(unsigned RegNo) const {
93       return StackTop - 1 - getSlot(RegNo) + llvm::X86::ST0;
94     }
95
96     // pushReg - Push the specified FP<n> register onto the stack
97     void pushReg(unsigned Reg) {
98       assert(Reg < 8 && "Register number out of range!");
99       assert(StackTop < 8 && "Stack overflow!");
100       Stack[StackTop] = Reg;
101       RegMap[Reg] = StackTop++;
102     }
103
104     bool isAtTop(unsigned RegNo) const { return getSlot(RegNo) == StackTop-1; }
105     void moveToTop(unsigned RegNo, MachineBasicBlock::iterator &I) {
106       if (!isAtTop(RegNo)) {
107         unsigned Slot = getSlot(RegNo);
108         unsigned STReg = getSTReg(RegNo);
109         unsigned RegOnTop = getStackEntry(0);
110
111         // Swap the slots the regs are in
112         std::swap(RegMap[RegNo], RegMap[RegOnTop]);
113
114         // Swap stack slot contents
115         assert(RegMap[RegOnTop] < StackTop);
116         std::swap(Stack[RegMap[RegOnTop]], Stack[StackTop-1]);
117
118         // Emit an fxch to update the runtime processors version of the state
119         BuildMI(*MBB, I, X86::FXCH, 1).addReg(STReg);
120         NumFXCH++;
121       }
122     }
123
124     void duplicateToTop(unsigned RegNo, unsigned AsReg, MachineInstr *I) {
125       unsigned STReg = getSTReg(RegNo);
126       pushReg(AsReg);   // New register on top of stack
127
128       BuildMI(*MBB, I, X86::FLDrr, 1).addReg(STReg);
129     }
130
131     // popStackAfter - Pop the current value off of the top of the FP stack
132     // after the specified instruction.
133     void popStackAfter(MachineBasicBlock::iterator &I);
134
135     // freeStackSlotAfter - Free the specified register from the register stack,
136     // so that it is no longer in a register.  If the register is currently at
137     // the top of the stack, we just pop the current instruction, otherwise we
138     // store the current top-of-stack into the specified slot, then pop the top
139     // of stack.
140     void freeStackSlotAfter(MachineBasicBlock::iterator &I, unsigned Reg);
141
142     bool processBasicBlock(MachineFunction &MF, MachineBasicBlock &MBB);
143
144     void handleZeroArgFP(MachineBasicBlock::iterator &I);
145     void handleOneArgFP(MachineBasicBlock::iterator &I);
146     void handleOneArgFPRW(MachineBasicBlock::iterator &I);
147     void handleTwoArgFP(MachineBasicBlock::iterator &I);
148     void handleCompareFP(MachineBasicBlock::iterator &I);
149     void handleCondMovFP(MachineBasicBlock::iterator &I);
150     void handleSpecialFP(MachineBasicBlock::iterator &I);
151   };
152 }
153
154 FunctionPass *llvm::createX86FloatingPointStackifierPass() { return new FPS(); }
155
156 /// runOnMachineFunction - Loop over all of the basic blocks, transforming FP
157 /// register references into FP stack references.
158 ///
159 bool FPS::runOnMachineFunction(MachineFunction &MF) {
160   // We only need to run this pass if there are any FP registers used in this
161   // function.  If it is all integer, there is nothing for us to do!
162   const bool *PhysRegsUsed = MF.getUsedPhysregs();
163   bool FPIsUsed = false;
164
165   assert(X86::FP6 == X86::FP0+6 && "Register enums aren't sorted right!");
166   for (unsigned i = 0; i <= 6; ++i)
167     if (PhysRegsUsed[X86::FP0+i]) {
168       FPIsUsed = true;
169       break;
170     }
171
172   // Early exit.
173   if (!FPIsUsed) return false;
174
175   LV = &getAnalysis<LiveVariables>();
176   StackTop = 0;
177
178   // Process the function in depth first order so that we process at least one
179   // of the predecessors for every reachable block in the function.
180   std::set<MachineBasicBlock*> Processed;
181   MachineBasicBlock *Entry = MF.begin();
182
183   bool Changed = false;
184   for (df_ext_iterator<MachineBasicBlock*, std::set<MachineBasicBlock*> >
185          I = df_ext_begin(Entry, Processed), E = df_ext_end(Entry, Processed);
186        I != E; ++I)
187     Changed |= processBasicBlock(MF, **I);
188
189   return Changed;
190 }
191
192 /// processBasicBlock - Loop over all of the instructions in the basic block,
193 /// transforming FP instructions into their stack form.
194 ///
195 bool FPS::processBasicBlock(MachineFunction &MF, MachineBasicBlock &BB) {
196   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
197   bool Changed = false;
198   MBB = &BB;
199   
200   for (MachineBasicBlock::iterator I = BB.begin(); I != BB.end(); ++I) {
201     MachineInstr *MI = I;
202     unsigned Flags = TII.get(MI->getOpcode()).TSFlags;
203     if ((Flags & X86II::FPTypeMask) == X86II::NotFP)
204       continue;  // Efficiently ignore non-fp insts!
205
206     MachineInstr *PrevMI = 0;
207     if (I != BB.begin())
208         PrevMI = prior(I);
209
210     ++NumFP;  // Keep track of # of pseudo instrs
211     DEBUG(std::cerr << "\nFPInst:\t";
212           MI->print(std::cerr, &(MF.getTarget())));
213
214     // Get dead variables list now because the MI pointer may be deleted as part
215     // of processing!
216     LiveVariables::killed_iterator IB = LV->dead_begin(MI);
217     LiveVariables::killed_iterator IE = LV->dead_end(MI);
218
219     DEBUG(const MRegisterInfo *MRI = MF.getTarget().getRegisterInfo();
220           LiveVariables::killed_iterator I = LV->killed_begin(MI);
221           LiveVariables::killed_iterator E = LV->killed_end(MI);
222           if (I != E) {
223             std::cerr << "Killed Operands:";
224             for (; I != E; ++I)
225               std::cerr << " %" << MRI->getName(I->second);
226             std::cerr << "\n";
227           });
228
229     switch (Flags & X86II::FPTypeMask) {
230     case X86II::ZeroArgFP:  handleZeroArgFP(I); break;
231     case X86II::OneArgFP:   handleOneArgFP(I);  break;  // fstp ST(0)
232     case X86II::OneArgFPRW: handleOneArgFPRW(I); break; // ST(0) = fsqrt(ST(0))
233     case X86II::TwoArgFP:   handleTwoArgFP(I); break;
234     case X86II::CompareFP:  handleCompareFP(I); break;
235     case X86II::CondMovFP:  handleCondMovFP(I); break;
236     case X86II::SpecialFP:  handleSpecialFP(I); break;
237     default: assert(0 && "Unknown FP Type!");
238     }
239
240     // Check to see if any of the values defined by this instruction are dead
241     // after definition.  If so, pop them.
242     for (; IB != IE; ++IB) {
243       unsigned Reg = IB->second;
244       if (Reg >= X86::FP0 && Reg <= X86::FP6) {
245         DEBUG(std::cerr << "Register FP#" << Reg-X86::FP0 << " is dead!\n");
246         freeStackSlotAfter(I, Reg-X86::FP0);
247       }
248     }
249     
250     // Print out all of the instructions expanded to if -debug
251     DEBUG(
252       MachineBasicBlock::iterator PrevI(PrevMI);
253       if (I == PrevI) {
254         std::cerr << "Just deleted pseudo instruction\n";
255       } else {
256         MachineBasicBlock::iterator Start = I;
257         // Rewind to first instruction newly inserted.
258         while (Start != BB.begin() && prior(Start) != PrevI) --Start;
259         std::cerr << "Inserted instructions:\n\t";
260         Start->print(std::cerr, &MF.getTarget());
261         while (++Start != next(I));
262       }
263       dumpStack();
264     );
265
266     Changed = true;
267   }
268
269   assert(StackTop == 0 && "Stack not empty at end of basic block?");
270   return Changed;
271 }
272
273 //===----------------------------------------------------------------------===//
274 // Efficient Lookup Table Support
275 //===----------------------------------------------------------------------===//
276
277 namespace {
278   struct TableEntry {
279     unsigned from;
280     unsigned to;
281     bool operator<(const TableEntry &TE) const { return from < TE.from; }
282     bool operator<(unsigned V) const { return from < V; }
283   };
284 }
285
286 static bool TableIsSorted(const TableEntry *Table, unsigned NumEntries) {
287   for (unsigned i = 0; i != NumEntries-1; ++i)
288     if (!(Table[i] < Table[i+1])) return false;
289   return true;
290 }
291
292 static int Lookup(const TableEntry *Table, unsigned N, unsigned Opcode) {
293   const TableEntry *I = std::lower_bound(Table, Table+N, Opcode);
294   if (I != Table+N && I->from == Opcode)
295     return I->to;
296   return -1;
297 }
298
299 #define ARRAY_SIZE(TABLE)  \
300    (sizeof(TABLE)/sizeof(TABLE[0]))
301
302 #ifdef NDEBUG
303 #define ASSERT_SORTED(TABLE)
304 #else
305 #define ASSERT_SORTED(TABLE)                                              \
306   { static bool TABLE##Checked = false;                                   \
307     if (!TABLE##Checked)                                                  \
308        assert(TableIsSorted(TABLE, ARRAY_SIZE(TABLE)) &&                  \
309               "All lookup tables must be sorted for efficient access!");  \
310   }
311 #endif
312
313
314 //===----------------------------------------------------------------------===//
315 // Helper Methods
316 //===----------------------------------------------------------------------===//
317
318 // PopTable - Sorted map of instructions to their popping version.  The first
319 // element is an instruction, the second is the version which pops.
320 //
321 static const TableEntry PopTable[] = {
322   { X86::FADDrST0 , X86::FADDPrST0  },
323
324   { X86::FDIVRrST0, X86::FDIVRPrST0 },
325   { X86::FDIVrST0 , X86::FDIVPrST0  },
326
327   { X86::FIST16m  , X86::FISTP16m   },
328   { X86::FIST32m  , X86::FISTP32m   },
329
330   { X86::FMULrST0 , X86::FMULPrST0  },
331
332   { X86::FST32m   , X86::FSTP32m    },
333   { X86::FST64m   , X86::FSTP64m    },
334   { X86::FSTrr    , X86::FSTPrr     },
335
336   { X86::FSUBRrST0, X86::FSUBRPrST0 },
337   { X86::FSUBrST0 , X86::FSUBPrST0  },
338
339   { X86::FUCOMIr  , X86::FUCOMIPr   },
340
341   { X86::FUCOMPr  , X86::FUCOMPPr   },
342   { X86::FUCOMr   , X86::FUCOMPr    },
343 };
344
345 /// popStackAfter - Pop the current value off of the top of the FP stack after
346 /// the specified instruction.  This attempts to be sneaky and combine the pop
347 /// into the instruction itself if possible.  The iterator is left pointing to
348 /// the last instruction, be it a new pop instruction inserted, or the old
349 /// instruction if it was modified in place.
350 ///
351 void FPS::popStackAfter(MachineBasicBlock::iterator &I) {
352   ASSERT_SORTED(PopTable);
353   assert(StackTop > 0 && "Cannot pop empty stack!");
354   RegMap[Stack[--StackTop]] = ~0;     // Update state
355
356   // Check to see if there is a popping version of this instruction...
357   int Opcode = Lookup(PopTable, ARRAY_SIZE(PopTable), I->getOpcode());
358   if (Opcode != -1) {
359     I->setOpcode(Opcode);
360     if (Opcode == X86::FUCOMPPr)
361       I->RemoveOperand(0);
362
363   } else {    // Insert an explicit pop
364     I = BuildMI(*MBB, ++I, X86::FSTPrr, 1).addReg(X86::ST0);
365   }
366 }
367
368 /// freeStackSlotAfter - Free the specified register from the register stack, so
369 /// that it is no longer in a register.  If the register is currently at the top
370 /// of the stack, we just pop the current instruction, otherwise we store the
371 /// current top-of-stack into the specified slot, then pop the top of stack.
372 void FPS::freeStackSlotAfter(MachineBasicBlock::iterator &I, unsigned FPRegNo) {
373   if (getStackEntry(0) == FPRegNo) {  // already at the top of stack? easy.
374     popStackAfter(I);
375     return;
376   }
377
378   // Otherwise, store the top of stack into the dead slot, killing the operand
379   // without having to add in an explicit xchg then pop.
380   //
381   unsigned STReg    = getSTReg(FPRegNo);
382   unsigned OldSlot  = getSlot(FPRegNo);
383   unsigned TopReg   = Stack[StackTop-1];
384   Stack[OldSlot]    = TopReg;
385   RegMap[TopReg]    = OldSlot;
386   RegMap[FPRegNo]   = ~0;
387   Stack[--StackTop] = ~0;
388   I = BuildMI(*MBB, ++I, X86::FSTPrr, 1).addReg(STReg);
389 }
390
391
392 static unsigned getFPReg(const MachineOperand &MO) {
393   assert(MO.isRegister() && "Expected an FP register!");
394   unsigned Reg = MO.getReg();
395   assert(Reg >= X86::FP0 && Reg <= X86::FP6 && "Expected FP register!");
396   return Reg - X86::FP0;
397 }
398
399
400 //===----------------------------------------------------------------------===//
401 // Instruction transformation implementation
402 //===----------------------------------------------------------------------===//
403
404 /// handleZeroArgFP - ST(0) = fld0    ST(0) = flds <mem>
405 ///
406 void FPS::handleZeroArgFP(MachineBasicBlock::iterator &I) {
407   MachineInstr *MI = I;
408   unsigned DestReg = getFPReg(MI->getOperand(0));
409   MI->RemoveOperand(0);   // Remove the explicit ST(0) operand
410
411   // Result gets pushed on the stack...
412   pushReg(DestReg);
413 }
414
415 /// handleOneArgFP - fst <mem>, ST(0)
416 ///
417 void FPS::handleOneArgFP(MachineBasicBlock::iterator &I) {
418   MachineInstr *MI = I;
419   assert((MI->getNumOperands() == 5 || MI->getNumOperands() == 1) &&
420          "Can only handle fst* & ftst instructions!");
421
422   // Is this the last use of the source register?
423   unsigned Reg = getFPReg(MI->getOperand(MI->getNumOperands()-1));
424   bool KillsSrc = false;
425   for (LiveVariables::killed_iterator KI = LV->killed_begin(MI),
426          E = LV->killed_end(MI); KI != E; ++KI)
427     KillsSrc |= KI->second == X86::FP0+Reg;
428
429   // FSTP80r and FISTP64r are strange because there are no non-popping versions.
430   // If we have one _and_ we don't want to pop the operand, duplicate the value
431   // on the stack instead of moving it.  This ensure that popping the value is
432   // always ok.
433   //
434   if ((MI->getOpcode() == X86::FSTP80m ||
435        MI->getOpcode() == X86::FISTP64m) && !KillsSrc) {
436     duplicateToTop(Reg, 7 /*temp register*/, I);
437   } else {
438     moveToTop(Reg, I);            // Move to the top of the stack...
439   }
440   MI->RemoveOperand(MI->getNumOperands()-1);    // Remove explicit ST(0) operand
441   
442   if (MI->getOpcode() == X86::FSTP80m || MI->getOpcode() == X86::FISTP64m) {
443     assert(StackTop > 0 && "Stack empty??");
444     --StackTop;
445   } else if (KillsSrc) { // Last use of operand?
446     popStackAfter(I);
447   }
448 }
449
450
451 /// handleOneArgFPRW: Handle instructions that read from the top of stack and
452 /// replace the value with a newly computed value.  These instructions may have
453 /// non-fp operands after their FP operands.
454 ///
455 ///  Examples:
456 ///     R1 = fchs R2
457 ///     R1 = fadd R2, [mem]
458 ///
459 void FPS::handleOneArgFPRW(MachineBasicBlock::iterator &I) {
460   MachineInstr *MI = I;
461   assert(MI->getNumOperands() >= 2 && "FPRW instructions must have 2 ops!!");
462
463   // Is this the last use of the source register?
464   unsigned Reg = getFPReg(MI->getOperand(1));
465   bool KillsSrc = false;
466   for (LiveVariables::killed_iterator KI = LV->killed_begin(MI),
467          E = LV->killed_end(MI); KI != E; ++KI)
468     KillsSrc |= KI->second == X86::FP0+Reg;
469
470   if (KillsSrc) {
471     // If this is the last use of the source register, just make sure it's on
472     // the top of the stack.
473     moveToTop(Reg, I);
474     assert(StackTop > 0 && "Stack cannot be empty!");
475     --StackTop;
476     pushReg(getFPReg(MI->getOperand(0)));
477   } else {
478     // If this is not the last use of the source register, _copy_ it to the top
479     // of the stack.
480     duplicateToTop(Reg, getFPReg(MI->getOperand(0)), I);
481   }
482
483   MI->RemoveOperand(1);   // Drop the source operand.
484   MI->RemoveOperand(0);   // Drop the destination operand.
485 }
486
487
488 //===----------------------------------------------------------------------===//
489 // Define tables of various ways to map pseudo instructions
490 //
491
492 // ForwardST0Table - Map: A = B op C  into: ST(0) = ST(0) op ST(i)
493 static const TableEntry ForwardST0Table[] = {
494   { X86::FpADD  , X86::FADDST0r },
495   { X86::FpDIV  , X86::FDIVST0r },
496   { X86::FpMUL  , X86::FMULST0r },
497   { X86::FpSUB  , X86::FSUBST0r },
498 };
499
500 // ReverseST0Table - Map: A = B op C  into: ST(0) = ST(i) op ST(0)
501 static const TableEntry ReverseST0Table[] = {
502   { X86::FpADD  , X86::FADDST0r  },   // commutative
503   { X86::FpDIV  , X86::FDIVRST0r },
504   { X86::FpMUL  , X86::FMULST0r  },   // commutative
505   { X86::FpSUB  , X86::FSUBRST0r },
506 };
507
508 // ForwardSTiTable - Map: A = B op C  into: ST(i) = ST(0) op ST(i)
509 static const TableEntry ForwardSTiTable[] = {
510   { X86::FpADD  , X86::FADDrST0  },   // commutative
511   { X86::FpDIV  , X86::FDIVRrST0 },
512   { X86::FpMUL  , X86::FMULrST0  },   // commutative
513   { X86::FpSUB  , X86::FSUBRrST0 },
514 };
515
516 // ReverseSTiTable - Map: A = B op C  into: ST(i) = ST(i) op ST(0)
517 static const TableEntry ReverseSTiTable[] = {
518   { X86::FpADD  , X86::FADDrST0 },
519   { X86::FpDIV  , X86::FDIVrST0 },
520   { X86::FpMUL  , X86::FMULrST0 },
521   { X86::FpSUB  , X86::FSUBrST0 },
522 };
523
524
525 /// handleTwoArgFP - Handle instructions like FADD and friends which are virtual
526 /// instructions which need to be simplified and possibly transformed.
527 ///
528 /// Result: ST(0) = fsub  ST(0), ST(i)
529 ///         ST(i) = fsub  ST(0), ST(i)
530 ///         ST(0) = fsubr ST(0), ST(i)
531 ///         ST(i) = fsubr ST(0), ST(i)
532 /// 
533 void FPS::handleTwoArgFP(MachineBasicBlock::iterator &I) {
534   ASSERT_SORTED(ForwardST0Table); ASSERT_SORTED(ReverseST0Table);
535   ASSERT_SORTED(ForwardSTiTable); ASSERT_SORTED(ReverseSTiTable);
536   MachineInstr *MI = I;
537
538   unsigned NumOperands = MI->getNumOperands();
539   assert(NumOperands == 3 && "Illegal TwoArgFP instruction!");
540   unsigned Dest = getFPReg(MI->getOperand(0));
541   unsigned Op0 = getFPReg(MI->getOperand(NumOperands-2));
542   unsigned Op1 = getFPReg(MI->getOperand(NumOperands-1));
543   bool KillsOp0 = false, KillsOp1 = false;
544
545   for (LiveVariables::killed_iterator KI = LV->killed_begin(MI),
546          E = LV->killed_end(MI); KI != E; ++KI) {
547     KillsOp0 |= (KI->second == X86::FP0+Op0);
548     KillsOp1 |= (KI->second == X86::FP0+Op1);
549   }
550
551   unsigned TOS = getStackEntry(0);
552
553   // One of our operands must be on the top of the stack.  If neither is yet, we
554   // need to move one.
555   if (Op0 != TOS && Op1 != TOS) {   // No operand at TOS?
556     // We can choose to move either operand to the top of the stack.  If one of
557     // the operands is killed by this instruction, we want that one so that we
558     // can update right on top of the old version.
559     if (KillsOp0) {
560       moveToTop(Op0, I);         // Move dead operand to TOS.
561       TOS = Op0;
562     } else if (KillsOp1) {
563       moveToTop(Op1, I);
564       TOS = Op1;
565     } else {
566       // All of the operands are live after this instruction executes, so we
567       // cannot update on top of any operand.  Because of this, we must
568       // duplicate one of the stack elements to the top.  It doesn't matter
569       // which one we pick.
570       //
571       duplicateToTop(Op0, Dest, I);
572       Op0 = TOS = Dest;
573       KillsOp0 = true;
574     }
575   } else if (!KillsOp0 && !KillsOp1) {
576     // If we DO have one of our operands at the top of the stack, but we don't
577     // have a dead operand, we must duplicate one of the operands to a new slot
578     // on the stack.
579     duplicateToTop(Op0, Dest, I);
580     Op0 = TOS = Dest;
581     KillsOp0 = true;
582   }
583
584   // Now we know that one of our operands is on the top of the stack, and at
585   // least one of our operands is killed by this instruction.
586   assert((TOS == Op0 || TOS == Op1) && (KillsOp0 || KillsOp1) && 
587          "Stack conditions not set up right!");
588
589   // We decide which form to use based on what is on the top of the stack, and
590   // which operand is killed by this instruction.
591   const TableEntry *InstTable;
592   bool isForward = TOS == Op0;
593   bool updateST0 = (TOS == Op0 && !KillsOp1) || (TOS == Op1 && !KillsOp0);
594   if (updateST0) {
595     if (isForward)
596       InstTable = ForwardST0Table;
597     else
598       InstTable = ReverseST0Table;
599   } else {
600     if (isForward)
601       InstTable = ForwardSTiTable;
602     else
603       InstTable = ReverseSTiTable;
604   }
605   
606   int Opcode = Lookup(InstTable, ARRAY_SIZE(ForwardST0Table), MI->getOpcode());
607   assert(Opcode != -1 && "Unknown TwoArgFP pseudo instruction!");
608
609   // NotTOS - The register which is not on the top of stack...
610   unsigned NotTOS = (TOS == Op0) ? Op1 : Op0;
611
612   // Replace the old instruction with a new instruction
613   MBB->remove(I++);
614   I = BuildMI(*MBB, I, Opcode, 1).addReg(getSTReg(NotTOS));
615
616   // If both operands are killed, pop one off of the stack in addition to
617   // overwriting the other one.
618   if (KillsOp0 && KillsOp1 && Op0 != Op1) {
619     assert(!updateST0 && "Should have updated other operand!");
620     popStackAfter(I);   // Pop the top of stack
621   }
622
623   // Update stack information so that we know the destination register is now on
624   // the stack.
625   unsigned UpdatedSlot = getSlot(updateST0 ? TOS : NotTOS);
626   assert(UpdatedSlot < StackTop && Dest < 7);
627   Stack[UpdatedSlot]   = Dest;
628   RegMap[Dest]         = UpdatedSlot;
629   delete MI;   // Remove the old instruction
630 }
631
632 /// handleCompareFP - Handle FUCOM and FUCOMI instructions, which have two FP
633 /// register arguments and no explicit destinations.
634 /// 
635 void FPS::handleCompareFP(MachineBasicBlock::iterator &I) {
636   ASSERT_SORTED(ForwardST0Table); ASSERT_SORTED(ReverseST0Table);
637   ASSERT_SORTED(ForwardSTiTable); ASSERT_SORTED(ReverseSTiTable);
638   MachineInstr *MI = I;
639
640   unsigned NumOperands = MI->getNumOperands();
641   assert(NumOperands == 2 && "Illegal FUCOM* instruction!");
642   unsigned Op0 = getFPReg(MI->getOperand(NumOperands-2));
643   unsigned Op1 = getFPReg(MI->getOperand(NumOperands-1));
644   bool KillsOp0 = false, KillsOp1 = false;
645
646   for (LiveVariables::killed_iterator KI = LV->killed_begin(MI),
647          E = LV->killed_end(MI); KI != E; ++KI) {
648     KillsOp0 |= (KI->second == X86::FP0+Op0);
649     KillsOp1 |= (KI->second == X86::FP0+Op1);
650   }
651
652   // Make sure the first operand is on the top of stack, the other one can be
653   // anywhere.
654   moveToTop(Op0, I);
655
656   MI->getOperand(0).setReg(getSTReg(Op1));
657   MI->RemoveOperand(1);
658
659   // If any of the operands are killed by this instruction, free them.
660   if (KillsOp0) freeStackSlotAfter(I, Op0);
661   if (KillsOp1 && Op0 != Op1) freeStackSlotAfter(I, Op1);
662 }
663
664 /// handleCondMovFP - Handle two address conditional move instructions.  These
665 /// instructions move a st(i) register to st(0) iff a condition is true.  These
666 /// instructions require that the first operand is at the top of the stack, but
667 /// otherwise don't modify the stack at all.
668 void FPS::handleCondMovFP(MachineBasicBlock::iterator &I) {
669   MachineInstr *MI = I;
670
671   unsigned Op0 = getFPReg(MI->getOperand(0));
672   unsigned Op1 = getFPReg(MI->getOperand(1));
673
674   // The first operand *must* be on the top of the stack.
675   moveToTop(Op0, I);
676
677   // Change the second operand to the stack register that the operand is in.
678   MI->RemoveOperand(0);
679   MI->getOperand(0).setReg(getSTReg(Op1));
680
681   // If we kill the second operand, make sure to pop it from the stack.
682   if (Op0 != Op1) 
683     for (LiveVariables::killed_iterator KI = LV->killed_begin(MI),
684            E = LV->killed_end(MI); KI != E; ++KI)
685       if (KI->second == X86::FP0+Op1) {
686         // Get this value off of the register stack.
687         freeStackSlotAfter(I, Op1);
688         break;
689       }
690 }
691
692
693 /// handleSpecialFP - Handle special instructions which behave unlike other
694 /// floating point instructions.  This is primarily intended for use by pseudo
695 /// instructions.
696 ///
697 void FPS::handleSpecialFP(MachineBasicBlock::iterator &I) {
698   MachineInstr *MI = I;
699   switch (MI->getOpcode()) {
700   default: assert(0 && "Unknown SpecialFP instruction!");
701   case X86::FpGETRESULT:  // Appears immediately after a call returning FP type!
702     assert(StackTop == 0 && "Stack should be empty after a call!");
703     pushReg(getFPReg(MI->getOperand(0)));
704     break;
705   case X86::FpSETRESULT:
706     assert(StackTop == 1 && "Stack should have one element on it to return!");
707     --StackTop;   // "Forget" we have something on the top of stack!
708     break;
709   case X86::FpMOV: {
710     unsigned SrcReg = getFPReg(MI->getOperand(1));
711     unsigned DestReg = getFPReg(MI->getOperand(0));
712     bool KillsSrc = false;
713     for (LiveVariables::killed_iterator KI = LV->killed_begin(MI),
714            E = LV->killed_end(MI); KI != E; ++KI)
715       KillsSrc |= KI->second == X86::FP0+SrcReg;
716
717     if (KillsSrc) {
718       // If the input operand is killed, we can just change the owner of the
719       // incoming stack slot into the result.
720       unsigned Slot = getSlot(SrcReg);
721       assert(Slot < 7 && DestReg < 7 && "FpMOV operands invalid!");
722       Stack[Slot] = DestReg;
723       RegMap[DestReg] = Slot;
724
725     } else {
726       // For FMOV we just duplicate the specified value to a new stack slot.
727       // This could be made better, but would require substantial changes.
728       duplicateToTop(SrcReg, DestReg, I);
729     }
730     break;
731   }
732   }
733
734   I = MBB->erase(I);  // Remove the pseudo instruction
735   --I;
736 }