R600: Non vector only instruction can be scheduled on trans unit
[oota-llvm.git] / lib / Target / R600 / R600Packetizer.cpp
1 //===----- R600Packetizer.cpp - VLIW packetizer ---------------------------===//
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 /// \file
11 /// This pass implements instructions packetization for R600. It unsets isLast
12 /// bit of instructions inside a bundle and substitutes src register with
13 /// PreviousVector when applicable.
14 //
15 //===----------------------------------------------------------------------===//
16
17 #define DEBUG_TYPE "packets"
18 #include "llvm/Support/Debug.h"
19 #include "AMDGPU.h"
20 #include "R600InstrInfo.h"
21 #include "llvm/CodeGen/DFAPacketizer.h"
22 #include "llvm/CodeGen/MachineDominators.h"
23 #include "llvm/CodeGen/MachineFunctionPass.h"
24 #include "llvm/CodeGen/MachineLoopInfo.h"
25 #include "llvm/CodeGen/Passes.h"
26 #include "llvm/CodeGen/ScheduleDAG.h"
27 #include "llvm/Support/raw_ostream.h"
28
29 using namespace llvm;
30
31 namespace {
32
33 class R600Packetizer : public MachineFunctionPass {
34
35 public:
36   static char ID;
37   R600Packetizer(const TargetMachine &TM) : MachineFunctionPass(ID) {}
38
39   void getAnalysisUsage(AnalysisUsage &AU) const {
40     AU.setPreservesCFG();
41     AU.addRequired<MachineDominatorTree>();
42     AU.addPreserved<MachineDominatorTree>();
43     AU.addRequired<MachineLoopInfo>();
44     AU.addPreserved<MachineLoopInfo>();
45     MachineFunctionPass::getAnalysisUsage(AU);
46   }
47
48   const char *getPassName() const {
49     return "R600 Packetizer";
50   }
51
52   bool runOnMachineFunction(MachineFunction &Fn);
53 };
54 char R600Packetizer::ID = 0;
55
56 class R600PacketizerList : public VLIWPacketizerList {
57
58 private:
59   const R600InstrInfo *TII;
60   const R600RegisterInfo &TRI;
61   bool VLIW5;
62   bool ConsideredInstUsesAlreadyWrittenVectorElement;
63
64   unsigned getSlot(const MachineInstr *MI) const {
65     return TRI.getHWRegChan(MI->getOperand(0).getReg());
66   }
67
68   /// \returns register to PV chan mapping for bundle/single instructions that
69   /// immediatly precedes I.
70   DenseMap<unsigned, unsigned> getPreviousVector(MachineBasicBlock::iterator I)
71       const {
72     DenseMap<unsigned, unsigned> Result;
73     I--;
74     if (!TII->isALUInstr(I->getOpcode()) && !I->isBundle())
75       return Result;
76     MachineBasicBlock::instr_iterator BI = I.getInstrIterator();
77     if (I->isBundle())
78       BI++;
79     int LastDstChan = -1;
80     do {
81       bool isTrans = false;
82       int BISlot = getSlot(BI);
83       if (LastDstChan >= BISlot)
84         isTrans = true;
85       LastDstChan = BISlot;
86       if (TII->isPredicated(BI))
87         continue;
88       int OperandIdx = TII->getOperandIdx(BI->getOpcode(), AMDGPU::OpName::write);
89       if (OperandIdx > -1 && BI->getOperand(OperandIdx).getImm() == 0)
90         continue;
91       int DstIdx = TII->getOperandIdx(BI->getOpcode(), AMDGPU::OpName::dst);
92       if (DstIdx == -1) {
93         continue;
94       }
95       unsigned Dst = BI->getOperand(DstIdx).getReg();
96       if (isTrans || TII->isTransOnly(BI)) {
97         Result[Dst] = AMDGPU::PS;
98         continue;
99       }
100       if (BI->getOpcode() == AMDGPU::DOT4_r600 ||
101           BI->getOpcode() == AMDGPU::DOT4_eg) {
102         Result[Dst] = AMDGPU::PV_X;
103         continue;
104       }
105       if (Dst == AMDGPU::OQAP) {
106         continue;
107       }
108       unsigned PVReg = 0;
109       switch (TRI.getHWRegChan(Dst)) {
110       case 0:
111         PVReg = AMDGPU::PV_X;
112         break;
113       case 1:
114         PVReg = AMDGPU::PV_Y;
115         break;
116       case 2:
117         PVReg = AMDGPU::PV_Z;
118         break;
119       case 3:
120         PVReg = AMDGPU::PV_W;
121         break;
122       default:
123         llvm_unreachable("Invalid Chan");
124       }
125       Result[Dst] = PVReg;
126     } while ((++BI)->isBundledWithPred());
127     return Result;
128   }
129
130   void substitutePV(MachineInstr *MI, const DenseMap<unsigned, unsigned> &PVs)
131       const {
132     unsigned Ops[] = {
133       AMDGPU::OpName::src0,
134       AMDGPU::OpName::src1,
135       AMDGPU::OpName::src2
136     };
137     for (unsigned i = 0; i < 3; i++) {
138       int OperandIdx = TII->getOperandIdx(MI->getOpcode(), Ops[i]);
139       if (OperandIdx < 0)
140         continue;
141       unsigned Src = MI->getOperand(OperandIdx).getReg();
142       const DenseMap<unsigned, unsigned>::const_iterator It = PVs.find(Src);
143       if (It != PVs.end())
144         MI->getOperand(OperandIdx).setReg(It->second);
145     }
146   }
147 public:
148   // Ctor.
149   R600PacketizerList(MachineFunction &MF, MachineLoopInfo &MLI,
150                         MachineDominatorTree &MDT)
151   : VLIWPacketizerList(MF, MLI, MDT, true),
152     TII (static_cast<const R600InstrInfo *>(MF.getTarget().getInstrInfo())),
153     TRI(TII->getRegisterInfo()) {
154     VLIW5 = !MF.getTarget().getSubtarget<AMDGPUSubtarget>().hasCaymanISA();
155   }
156
157   // initPacketizerState - initialize some internal flags.
158   void initPacketizerState() {
159     ConsideredInstUsesAlreadyWrittenVectorElement = false;
160   }
161
162   // ignorePseudoInstruction - Ignore bundling of pseudo instructions.
163   bool ignorePseudoInstruction(MachineInstr *MI, MachineBasicBlock *MBB) {
164     return false;
165   }
166
167   // isSoloInstruction - return true if instruction MI can not be packetized
168   // with any other instruction, which means that MI itself is a packet.
169   bool isSoloInstruction(MachineInstr *MI) {
170     if (TII->isVector(*MI))
171       return true;
172     if (!TII->isALUInstr(MI->getOpcode()))
173       return true;
174     if (MI->getOpcode() == AMDGPU::GROUP_BARRIER)
175       return true;
176     // XXX: This can be removed once the packetizer properly handles all the
177     // LDS instruction group restrictions.
178     if (TII->isLDSInstr(MI->getOpcode()))
179       return true;
180     return false;
181   }
182
183   // isLegalToPacketizeTogether - Is it legal to packetize SUI and SUJ
184   // together.
185   bool isLegalToPacketizeTogether(SUnit *SUI, SUnit *SUJ) {
186     MachineInstr *MII = SUI->getInstr(), *MIJ = SUJ->getInstr();
187     if (getSlot(MII) == getSlot(MIJ))
188       ConsideredInstUsesAlreadyWrittenVectorElement = true;
189     // Does MII and MIJ share the same pred_sel ?
190     int OpI = TII->getOperandIdx(MII->getOpcode(), AMDGPU::OpName::pred_sel),
191         OpJ = TII->getOperandIdx(MIJ->getOpcode(), AMDGPU::OpName::pred_sel);
192     unsigned PredI = (OpI > -1)?MII->getOperand(OpI).getReg():0,
193         PredJ = (OpJ > -1)?MIJ->getOperand(OpJ).getReg():0;
194     if (PredI != PredJ)
195       return false;
196     if (SUJ->isSucc(SUI)) {
197       for (unsigned i = 0, e = SUJ->Succs.size(); i < e; ++i) {
198         const SDep &Dep = SUJ->Succs[i];
199         if (Dep.getSUnit() != SUI)
200           continue;
201         if (Dep.getKind() == SDep::Anti)
202           continue;
203         if (Dep.getKind() == SDep::Output)
204           if (MII->getOperand(0).getReg() != MIJ->getOperand(0).getReg())
205             continue;
206         return false;
207       }
208     }
209     return true;
210   }
211
212   // isLegalToPruneDependencies - Is it legal to prune dependece between SUI
213   // and SUJ.
214   bool isLegalToPruneDependencies(SUnit *SUI, SUnit *SUJ) {return false;}
215
216   void setIsLastBit(MachineInstr *MI, unsigned Bit) const {
217     unsigned LastOp = TII->getOperandIdx(MI->getOpcode(), AMDGPU::OpName::last);
218     MI->getOperand(LastOp).setImm(Bit);
219   }
220
221   bool isBundlableWithCurrentPMI(MachineInstr *MI,
222                                  const DenseMap<unsigned, unsigned> &PV,
223                                  std::vector<R600InstrInfo::BankSwizzle> &BS,
224                                  bool &isTransSlot) {
225     isTransSlot = TII->isTransOnly(MI);
226     assert (!isTransSlot || VLIW5);
227
228     // Is the dst reg sequence legal ?
229     if (!isTransSlot && !CurrentPacketMIs.empty()) {
230       if (getSlot(MI) <= getSlot(CurrentPacketMIs.back())) {
231         if (ConsideredInstUsesAlreadyWrittenVectorElement  &&
232             !TII->isVectorOnly(MI) && VLIW5) {
233           isTransSlot = true;
234           DEBUG(dbgs() << "Considering as Trans Inst :"; MI->dump(););
235         }
236         else
237           return false;
238       }
239     }
240
241     // Are the Constants limitations met ?
242     CurrentPacketMIs.push_back(MI);
243     if (!TII->fitsConstReadLimitations(CurrentPacketMIs)) {
244       DEBUG(
245         dbgs() << "Couldn't pack :\n";
246         MI->dump();
247         dbgs() << "with the following packets :\n";
248         for (unsigned i = 0, e = CurrentPacketMIs.size() - 1; i < e; i++) {
249           CurrentPacketMIs[i]->dump();
250           dbgs() << "\n";
251         }
252         dbgs() << "because of Consts read limitations\n";
253       );
254       CurrentPacketMIs.pop_back();
255       return false;
256     }
257
258     // Is there a BankSwizzle set that meet Read Port limitations ?
259     if (!TII->fitsReadPortLimitations(CurrentPacketMIs,
260             PV, BS, isTransSlot)) {
261       DEBUG(
262         dbgs() << "Couldn't pack :\n";
263         MI->dump();
264         dbgs() << "with the following packets :\n";
265         for (unsigned i = 0, e = CurrentPacketMIs.size() - 1; i < e; i++) {
266           CurrentPacketMIs[i]->dump();
267           dbgs() << "\n";
268         }
269         dbgs() << "because of Read port limitations\n";
270       );
271       CurrentPacketMIs.pop_back();
272       return false;
273     }
274
275     CurrentPacketMIs.pop_back();
276     return true;
277   }
278
279   MachineBasicBlock::iterator addToPacket(MachineInstr *MI) {
280     MachineBasicBlock::iterator FirstInBundle =
281         CurrentPacketMIs.empty() ? MI : CurrentPacketMIs.front();
282     const DenseMap<unsigned, unsigned> &PV =
283         getPreviousVector(FirstInBundle);
284     std::vector<R600InstrInfo::BankSwizzle> BS;
285     bool isTransSlot;
286
287     if (isBundlableWithCurrentPMI(MI, PV, BS, isTransSlot)) {
288       for (unsigned i = 0, e = CurrentPacketMIs.size(); i < e; i++) {
289         MachineInstr *MI = CurrentPacketMIs[i];
290         unsigned Op = TII->getOperandIdx(MI->getOpcode(),
291             AMDGPU::OpName::bank_swizzle);
292         MI->getOperand(Op).setImm(BS[i]);
293       }
294       unsigned Op = TII->getOperandIdx(MI->getOpcode(),
295           AMDGPU::OpName::bank_swizzle);
296       MI->getOperand(Op).setImm(BS.back());
297       if (!CurrentPacketMIs.empty())
298         setIsLastBit(CurrentPacketMIs.back(), 0);
299       substitutePV(MI, PV);
300       MachineBasicBlock::iterator It = VLIWPacketizerList::addToPacket(MI);
301       if (isTransSlot) {
302         endPacket(llvm::next(It)->getParent(), llvm::next(It));
303       }
304       return It;
305     }
306     endPacket(MI->getParent(), MI);
307     if (TII->isTransOnly(MI))
308       return MI;
309     return VLIWPacketizerList::addToPacket(MI);
310   }
311 };
312
313 bool R600Packetizer::runOnMachineFunction(MachineFunction &Fn) {
314   const TargetInstrInfo *TII = Fn.getTarget().getInstrInfo();
315   MachineLoopInfo &MLI = getAnalysis<MachineLoopInfo>();
316   MachineDominatorTree &MDT = getAnalysis<MachineDominatorTree>();
317
318   // Instantiate the packetizer.
319   R600PacketizerList Packetizer(Fn, MLI, MDT);
320
321   // DFA state table should not be empty.
322   assert(Packetizer.getResourceTracker() && "Empty DFA table!");
323
324   //
325   // Loop over all basic blocks and remove KILL pseudo-instructions
326   // These instructions confuse the dependence analysis. Consider:
327   // D0 = ...   (Insn 0)
328   // R0 = KILL R0, D0 (Insn 1)
329   // R0 = ... (Insn 2)
330   // Here, Insn 1 will result in the dependence graph not emitting an output
331   // dependence between Insn 0 and Insn 2. This can lead to incorrect
332   // packetization
333   //
334   for (MachineFunction::iterator MBB = Fn.begin(), MBBe = Fn.end();
335        MBB != MBBe; ++MBB) {
336     MachineBasicBlock::iterator End = MBB->end();
337     MachineBasicBlock::iterator MI = MBB->begin();
338     while (MI != End) {
339       if (MI->isKill() ||
340           (MI->getOpcode() == AMDGPU::CF_ALU && !MI->getOperand(8).getImm())) {
341         MachineBasicBlock::iterator DeleteMI = MI;
342         ++MI;
343         MBB->erase(DeleteMI);
344         End = MBB->end();
345         continue;
346       }
347       ++MI;
348     }
349   }
350
351   // Loop over all of the basic blocks.
352   for (MachineFunction::iterator MBB = Fn.begin(), MBBe = Fn.end();
353        MBB != MBBe; ++MBB) {
354     // Find scheduling regions and schedule / packetize each region.
355     unsigned RemainingCount = MBB->size();
356     for(MachineBasicBlock::iterator RegionEnd = MBB->end();
357         RegionEnd != MBB->begin();) {
358       // The next region starts above the previous region. Look backward in the
359       // instruction stream until we find the nearest boundary.
360       MachineBasicBlock::iterator I = RegionEnd;
361       for(;I != MBB->begin(); --I, --RemainingCount) {
362         if (TII->isSchedulingBoundary(llvm::prior(I), MBB, Fn))
363           break;
364       }
365       I = MBB->begin();
366
367       // Skip empty scheduling regions.
368       if (I == RegionEnd) {
369         RegionEnd = llvm::prior(RegionEnd);
370         --RemainingCount;
371         continue;
372       }
373       // Skip regions with one instruction.
374       if (I == llvm::prior(RegionEnd)) {
375         RegionEnd = llvm::prior(RegionEnd);
376         continue;
377       }
378
379       Packetizer.PacketizeMIs(MBB, I, RegionEnd);
380       RegionEnd = I;
381     }
382   }
383
384   return true;
385
386 }
387
388 } // end anonymous namespace
389
390 llvm::FunctionPass *llvm::createR600Packetizer(TargetMachine &tm) {
391   return new R600Packetizer(tm);
392 }