update PPC 940 hazard rec. to function in postRA mode
[oota-llvm.git] / lib / Target / PowerPC / PPCHazardRecognizers.cpp
1 //===-- PPCHazardRecognizers.cpp - PowerPC Hazard Recognizer Impls --------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements hazard recognizers for scheduling on PowerPC processors.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #define DEBUG_TYPE "pre-RA-sched"
15 #include "PPCHazardRecognizers.h"
16 #include "PPC.h"
17 #include "PPCInstrInfo.h"
18 #include "llvm/CodeGen/ScheduleDAG.h"
19 #include "llvm/Support/Debug.h"
20 #include "llvm/Support/ErrorHandling.h"
21 #include "llvm/Support/raw_ostream.h"
22 using namespace llvm;
23
24 //===----------------------------------------------------------------------===//
25 // PowerPC 440 Hazard Recognizer
26 void PPCHazardRecognizer440::EmitInstruction(SUnit *SU) {
27   const MCInstrDesc *MCID = DAG->getInstrDesc(SU);
28   if (!MCID) {
29     // This is a PPC pseudo-instruction.
30     // FIXME: Should something else be done?
31     return;
32   }
33
34   ScoreboardHazardRecognizer::EmitInstruction(SU);
35 }
36
37 //===----------------------------------------------------------------------===//
38 // PowerPC 970 Hazard Recognizer
39 //
40 // This models the dispatch group formation of the PPC970 processor.  Dispatch
41 // groups are bundles of up to five instructions that can contain various mixes
42 // of instructions.  The PPC970 can dispatch a peak of 4 non-branch and one
43 // branch instruction per-cycle.
44 //
45 // There are a number of restrictions to dispatch group formation: some
46 // instructions can only be issued in the first slot of a dispatch group, & some
47 // instructions fill an entire dispatch group.  Additionally, only branches can
48 // issue in the 5th (last) slot.
49 //
50 // Finally, there are a number of "structural" hazards on the PPC970.  These
51 // conditions cause large performance penalties due to misprediction, recovery,
52 // and replay logic that has to happen.  These cases include setting a CTR and
53 // branching through it in the same dispatch group, and storing to an address,
54 // then loading from the same address within a dispatch group.  To avoid these
55 // conditions, we insert no-op instructions when appropriate.
56 //
57 // FIXME: This is missing some significant cases:
58 //   1. Modeling of microcoded instructions.
59 //   2. Handling of serialized operations.
60 //   3. Handling of the esoteric cases in "Resource-based Instruction Grouping".
61 //
62
63 PPCHazardRecognizer970::PPCHazardRecognizer970(const TargetInstrInfo &tii)
64   : TII(tii) {
65   EndDispatchGroup();
66 }
67
68 void PPCHazardRecognizer970::EndDispatchGroup() {
69   DEBUG(errs() << "=== Start of dispatch group\n");
70   NumIssued = 0;
71
72   // Structural hazard info.
73   HasCTRSet = false;
74   NumStores = 0;
75 }
76
77
78 PPCII::PPC970_Unit
79 PPCHazardRecognizer970::GetInstrType(unsigned Opcode,
80                                      bool &isFirst, bool &isSingle,
81                                      bool &isCracked,
82                                      bool &isLoad, bool &isStore) {
83   const MCInstrDesc &MCID = TII.get(Opcode);
84
85   isLoad  = MCID.mayLoad();
86   isStore = MCID.mayStore();
87
88   uint64_t TSFlags = MCID.TSFlags;
89
90   isFirst   = TSFlags & PPCII::PPC970_First;
91   isSingle  = TSFlags & PPCII::PPC970_Single;
92   isCracked = TSFlags & PPCII::PPC970_Cracked;
93   return (PPCII::PPC970_Unit)(TSFlags & PPCII::PPC970_Mask);
94 }
95
96 /// isLoadOfStoredAddress - If we have a load from the previously stored pointer
97 /// as indicated by StorePtr1/StorePtr2/StoreSize, return true.
98 bool PPCHazardRecognizer970::
99 isLoadOfStoredAddress(uint64_t LoadSize, int64_t LoadOffset,
100   const Value *LoadValue) const {
101   for (unsigned i = 0, e = NumStores; i != e; ++i) {
102     // Handle exact and commuted addresses.
103     if (LoadValue == StoreValue[i] && LoadOffset == StoreOffset[i])
104       return true;
105
106     // Okay, we don't have an exact match, if this is an indexed offset, see if
107     // we have overlap (which happens during fp->int conversion for example).
108     if (StoreValue[i] == LoadValue) {
109       // Okay the base pointers match, so we have [c1+r] vs [c2+r].  Check
110       // to see if the load and store actually overlap.
111       if (StoreOffset[i] < LoadOffset) {
112         if (int64_t(StoreOffset[i]+StoreSize[i]) > LoadOffset) return true;
113       } else {
114         if (int64_t(LoadOffset+LoadSize) > StoreOffset[i]) return true;
115       }
116     }
117   }
118   return false;
119 }
120
121 /// getHazardType - We return hazard for any non-branch instruction that would
122 /// terminate the dispatch group.  We turn NoopHazard for any
123 /// instructions that wouldn't terminate the dispatch group that would cause a
124 /// pipeline flush.
125 ScheduleHazardRecognizer::HazardType PPCHazardRecognizer970::
126 getHazardType(SUnit *SU, int Stalls) {
127   assert(Stalls == 0 && "PPC hazards don't support scoreboard lookahead");
128
129   MachineInstr *MI = SU->getInstr();
130
131   if (MI->isDebugValue())
132     return NoHazard;
133
134   unsigned Opcode = MI->getOpcode();
135
136   bool isFirst, isSingle, isCracked, isLoad, isStore;
137   PPCII::PPC970_Unit InstrType =
138     GetInstrType(Opcode, isFirst, isSingle, isCracked,
139                  isLoad, isStore);
140   if (InstrType == PPCII::PPC970_Pseudo) return NoHazard;
141
142   // We can only issue a PPC970_First/PPC970_Single instruction (such as
143   // crand/mtspr/etc) if this is the first cycle of the dispatch group.
144   if (NumIssued != 0 && (isFirst || isSingle))
145     return Hazard;
146
147   // If this instruction is cracked into two ops by the decoder, we know that
148   // it is not a branch and that it cannot issue if 3 other instructions are
149   // already in the dispatch group.
150   if (isCracked && NumIssued > 2)
151     return Hazard;
152
153   switch (InstrType) {
154   default: llvm_unreachable("Unknown instruction type!");
155   case PPCII::PPC970_FXU:
156   case PPCII::PPC970_LSU:
157   case PPCII::PPC970_FPU:
158   case PPCII::PPC970_VALU:
159   case PPCII::PPC970_VPERM:
160     // We can only issue a branch as the last instruction in a group.
161     if (NumIssued == 4) return Hazard;
162     break;
163   case PPCII::PPC970_CRU:
164     // We can only issue a CR instruction in the first two slots.
165     if (NumIssued >= 2) return Hazard;
166     break;
167   case PPCII::PPC970_BRU:
168     break;
169   }
170
171   // Do not allow MTCTR and BCTRL to be in the same dispatch group.
172   if (HasCTRSet && (Opcode == PPC::BCTRL_Darwin || Opcode == PPC::BCTRL_SVR4))
173     return NoopHazard;
174
175   // If this is a load following a store, make sure it's not to the same or
176   // overlapping address.
177   if (isLoad && NumStores && !MI->memoperands_empty()) {
178     MachineMemOperand *MO = *MI->memoperands_begin();
179     if (isLoadOfStoredAddress(MO->getSize(),
180                               MO->getOffset(), MO->getValue()))
181       return NoopHazard;
182   }
183
184   return NoHazard;
185 }
186
187 void PPCHazardRecognizer970::EmitInstruction(SUnit *SU) {
188   MachineInstr *MI = SU->getInstr();
189
190   if (MI->isDebugValue())
191     return;
192
193   unsigned Opcode = MI->getOpcode();
194
195   bool isFirst, isSingle, isCracked, isLoad, isStore;
196   PPCII::PPC970_Unit InstrType =
197     GetInstrType(Opcode, isFirst, isSingle, isCracked,
198                  isLoad, isStore);
199   if (InstrType == PPCII::PPC970_Pseudo) return;
200
201   // Update structural hazard information.
202   if (Opcode == PPC::MTCTR || Opcode == PPC::MTCTR8) HasCTRSet = true;
203
204   // Track the address stored to.
205   if (isStore && NumStores < 4 && !MI->memoperands_empty()) {
206     MachineMemOperand *MO = *MI->memoperands_begin();
207     StoreSize[NumStores] = MO->getSize();
208     StoreOffset[NumStores] = MO->getOffset();
209     StoreValue[NumStores] = MO->getValue();
210     ++NumStores;
211   }
212
213   if (InstrType == PPCII::PPC970_BRU || isSingle)
214     NumIssued = 4;  // Terminate a d-group.
215   ++NumIssued;
216
217   // If this instruction is cracked into two ops by the decoder, remember that
218   // we issued two pieces.
219   if (isCracked)
220     ++NumIssued;
221
222   if (NumIssued == 5)
223     EndDispatchGroup();
224 }
225
226 void PPCHazardRecognizer970::AdvanceCycle() {
227   assert(NumIssued < 5 && "Illegal dispatch group!");
228   ++NumIssued;
229   if (NumIssued == 5)
230     EndDispatchGroup();
231 }
232
233 void PPCHazardRecognizer970::Reset() {
234   EndDispatchGroup();
235 }
236