Enable machine sinking critical edge splitting. e.g.
[oota-llvm.git] / lib / CodeGen / MachineSink.cpp
1 //===-- MachineSink.cpp - Sinking for machine instructions ----------------===//
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 pass moves instructions into successor blocks when possible, so that
11 // they aren't executed on paths where their results aren't needed.
12 //
13 // This pass is not intended to be a replacement or a complete alternative
14 // for an LLVM-IR-level sinking pass. It is only designed to sink simple
15 // constructs that are not exposed before lowering and instruction selection.
16 //
17 //===----------------------------------------------------------------------===//
18
19 #define DEBUG_TYPE "machine-sink"
20 #include "llvm/CodeGen/Passes.h"
21 #include "llvm/CodeGen/MachineRegisterInfo.h"
22 #include "llvm/CodeGen/MachineDominators.h"
23 #include "llvm/CodeGen/MachineLoopInfo.h"
24 #include "llvm/Analysis/AliasAnalysis.h"
25 #include "llvm/Target/TargetRegisterInfo.h"
26 #include "llvm/Target/TargetInstrInfo.h"
27 #include "llvm/Target/TargetMachine.h"
28 #include "llvm/ADT/SmallSet.h"
29 #include "llvm/ADT/Statistic.h"
30 #include "llvm/Support/CommandLine.h"
31 #include "llvm/Support/Debug.h"
32 #include "llvm/Support/raw_ostream.h"
33 using namespace llvm;
34
35 static cl::opt<bool> 
36 SplitEdges("machine-sink-split",
37            cl::desc("Split critical edges during machine sinking"),
38            cl::init(true), cl::Hidden);
39
40 STATISTIC(NumSunk,      "Number of machine instructions sunk");
41 STATISTIC(NumSplit,     "Number of critical edges split");
42 STATISTIC(NumCoalesces, "Number of copies coalesced");
43
44 namespace {
45   class MachineSinking : public MachineFunctionPass {
46     const TargetInstrInfo *TII;
47     const TargetRegisterInfo *TRI;
48     MachineRegisterInfo  *MRI;  // Machine register information
49     MachineDominatorTree *DT;   // Machine dominator tree
50     MachineLoopInfo *LI;
51     AliasAnalysis *AA;
52     BitVector AllocatableSet;   // Which physregs are allocatable?
53
54     // Remember which edges have been considered for breaking.
55     SmallSet<std::pair<MachineBasicBlock*,MachineBasicBlock*>, 8>
56     CEBCandidates;
57
58   public:
59     static char ID; // Pass identification
60     MachineSinking() : MachineFunctionPass(ID) {}
61
62     virtual bool runOnMachineFunction(MachineFunction &MF);
63
64     virtual void getAnalysisUsage(AnalysisUsage &AU) const {
65       AU.setPreservesCFG();
66       MachineFunctionPass::getAnalysisUsage(AU);
67       AU.addRequired<AliasAnalysis>();
68       AU.addRequired<MachineDominatorTree>();
69       AU.addRequired<MachineLoopInfo>();
70       AU.addPreserved<MachineDominatorTree>();
71       AU.addPreserved<MachineLoopInfo>();
72     }
73
74     virtual void releaseMemory() {
75       CEBCandidates.clear();
76     }
77
78   private:
79     bool ProcessBlock(MachineBasicBlock &MBB);
80     bool isWorthBreakingCriticalEdge(MachineInstr *MI,
81                                      MachineBasicBlock *From,
82                                      MachineBasicBlock *To);
83     MachineBasicBlock *SplitCriticalEdge(MachineInstr *MI,
84                                          MachineBasicBlock *From,
85                                          MachineBasicBlock *To,
86                                          bool BreakPHIEdge);
87     bool SinkInstruction(MachineInstr *MI, bool &SawStore);
88     bool AllUsesDominatedByBlock(unsigned Reg, MachineBasicBlock *MBB,
89                                  MachineBasicBlock *DefMBB,
90                                  bool &BreakPHIEdge, bool &LocalUse) const;
91     bool PerformTrivialForwardCoalescing(MachineInstr *MI,
92                                          MachineBasicBlock *MBB);
93   };
94 } // end anonymous namespace
95
96 char MachineSinking::ID = 0;
97 INITIALIZE_PASS(MachineSinking, "machine-sink",
98                 "Machine code sinking", false, false);
99
100 FunctionPass *llvm::createMachineSinkingPass() { return new MachineSinking(); }
101
102 bool MachineSinking::PerformTrivialForwardCoalescing(MachineInstr *MI,
103                                                      MachineBasicBlock *MBB) {
104   if (!MI->isCopy())
105     return false;
106
107   unsigned SrcReg = MI->getOperand(1).getReg();
108   unsigned DstReg = MI->getOperand(0).getReg();
109   if (!TargetRegisterInfo::isVirtualRegister(SrcReg) ||
110       !TargetRegisterInfo::isVirtualRegister(DstReg) ||
111       !MRI->hasOneNonDBGUse(SrcReg))
112     return false;
113
114   const TargetRegisterClass *SRC = MRI->getRegClass(SrcReg);
115   const TargetRegisterClass *DRC = MRI->getRegClass(DstReg);
116   if (SRC != DRC)
117     return false;
118
119   MachineInstr *DefMI = MRI->getVRegDef(SrcReg);
120   if (DefMI->isCopyLike())
121     return false;
122   DEBUG(dbgs() << "Coalescing: " << *DefMI);
123   DEBUG(dbgs() << "*** to: " << *MI);
124   MRI->replaceRegWith(DstReg, SrcReg);
125   MI->eraseFromParent();
126   ++NumCoalesces;
127   return true;
128 }
129
130 /// AllUsesDominatedByBlock - Return true if all uses of the specified register
131 /// occur in blocks dominated by the specified block. If any use is in the
132 /// definition block, then return false since it is never legal to move def
133 /// after uses.
134 bool
135 MachineSinking::AllUsesDominatedByBlock(unsigned Reg,
136                                         MachineBasicBlock *MBB,
137                                         MachineBasicBlock *DefMBB,
138                                         bool &BreakPHIEdge,
139                                         bool &LocalUse) const {
140   assert(TargetRegisterInfo::isVirtualRegister(Reg) &&
141          "Only makes sense for vregs");
142
143   if (MRI->use_nodbg_empty(Reg))
144     return true;
145
146   // Ignoring debug uses is necessary so debug info doesn't affect the code.
147   // This may leave a referencing dbg_value in the original block, before
148   // the definition of the vreg.  Dwarf generator handles this although the
149   // user might not get the right info at runtime.
150
151   // BreakPHIEdge is true if all the uses are in the successor MBB being sunken
152   // into and they are all PHI nodes. In this case, machine-sink must break
153   // the critical edge first. e.g.
154   //
155   // BB#1: derived from LLVM BB %bb4.preheader
156   //   Predecessors according to CFG: BB#0
157   //     ...
158   //     %reg16385<def> = DEC64_32r %reg16437, %EFLAGS<imp-def,dead>
159   //     ...
160   //     JE_4 <BB#37>, %EFLAGS<imp-use>
161   //   Successors according to CFG: BB#37 BB#2
162   //
163   // BB#2: derived from LLVM BB %bb.nph
164   //   Predecessors according to CFG: BB#0 BB#1
165   //     %reg16386<def> = PHI %reg16434, <BB#0>, %reg16385, <BB#1>
166   BreakPHIEdge = true;
167   for (MachineRegisterInfo::use_nodbg_iterator
168          I = MRI->use_nodbg_begin(Reg), E = MRI->use_nodbg_end();
169        I != E; ++I) {
170     MachineInstr *UseInst = &*I;
171     MachineBasicBlock *UseBlock = UseInst->getParent();
172     if (!(UseBlock == MBB && UseInst->isPHI() &&
173           UseInst->getOperand(I.getOperandNo()+1).getMBB() == DefMBB)) {
174       BreakPHIEdge = false;
175       break;
176     }
177   }
178   if (BreakPHIEdge)
179     return true;
180
181   for (MachineRegisterInfo::use_nodbg_iterator
182          I = MRI->use_nodbg_begin(Reg), E = MRI->use_nodbg_end();
183        I != E; ++I) {
184     // Determine the block of the use.
185     MachineInstr *UseInst = &*I;
186     MachineBasicBlock *UseBlock = UseInst->getParent();
187     if (UseInst->isPHI()) {
188       // PHI nodes use the operand in the predecessor block, not the block with
189       // the PHI.
190       UseBlock = UseInst->getOperand(I.getOperandNo()+1).getMBB();
191     } else if (UseBlock == DefMBB) {
192       LocalUse = true;
193       return false;
194     }
195
196     // Check that it dominates.
197     if (!DT->dominates(MBB, UseBlock))
198       return false;
199   }
200
201   return true;
202 }
203
204 bool MachineSinking::runOnMachineFunction(MachineFunction &MF) {
205   DEBUG(dbgs() << "******** Machine Sinking ********\n");
206
207   const TargetMachine &TM = MF.getTarget();
208   TII = TM.getInstrInfo();
209   TRI = TM.getRegisterInfo();
210   MRI = &MF.getRegInfo();
211   DT = &getAnalysis<MachineDominatorTree>();
212   LI = &getAnalysis<MachineLoopInfo>();
213   AA = &getAnalysis<AliasAnalysis>();
214   AllocatableSet = TRI->getAllocatableSet(MF);
215
216   bool EverMadeChange = false;
217
218   while (1) {
219     bool MadeChange = false;
220
221     // Process all basic blocks.
222     CEBCandidates.clear();
223     for (MachineFunction::iterator I = MF.begin(), E = MF.end();
224          I != E; ++I)
225       MadeChange |= ProcessBlock(*I);
226
227     // If this iteration over the code changed anything, keep iterating.
228     if (!MadeChange) break;
229     EverMadeChange = true;
230   }
231   return EverMadeChange;
232 }
233
234 bool MachineSinking::ProcessBlock(MachineBasicBlock &MBB) {
235   // Can't sink anything out of a block that has less than two successors.
236   if (MBB.succ_size() <= 1 || MBB.empty()) return false;
237
238   // Don't bother sinking code out of unreachable blocks. In addition to being
239   // unprofitable, it can also lead to infinite looping, because in an
240   // unreachable loop there may be nowhere to stop.
241   if (!DT->isReachableFromEntry(&MBB)) return false;
242
243   bool MadeChange = false;
244
245   // Walk the basic block bottom-up.  Remember if we saw a store.
246   MachineBasicBlock::iterator I = MBB.end();
247   --I;
248   bool ProcessedBegin, SawStore = false;
249   do {
250     MachineInstr *MI = I;  // The instruction to sink.
251
252     // Predecrement I (if it's not begin) so that it isn't invalidated by
253     // sinking.
254     ProcessedBegin = I == MBB.begin();
255     if (!ProcessedBegin)
256       --I;
257
258     if (MI->isDebugValue())
259       continue;
260
261     if (PerformTrivialForwardCoalescing(MI, &MBB))
262       continue;
263
264     if (SinkInstruction(MI, SawStore))
265       ++NumSunk, MadeChange = true;
266
267     // If we just processed the first instruction in the block, we're done.
268   } while (!ProcessedBegin);
269
270   return MadeChange;
271 }
272
273 bool MachineSinking::isWorthBreakingCriticalEdge(MachineInstr *MI,
274                                                  MachineBasicBlock *From,
275                                                  MachineBasicBlock *To) {
276   // FIXME: Need much better heuristics.
277
278   // If the pass has already considered breaking this edge (during this pass
279   // through the function), then let's go ahead and break it. This means
280   // sinking multiple "cheap" instructions into the same block.
281   if (!CEBCandidates.insert(std::make_pair(From, To)))
282     return true;
283
284   if (!(MI->isCopyLike() || MI->getDesc().isAsCheapAsAMove()))
285     return true;
286
287   // MI is cheap, we probably don't want to break the critical edge for it.
288   // However, if this would allow some definitions of its source operands
289   // to be sunk then it's probably worth it.
290   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
291     const MachineOperand &MO = MI->getOperand(i);
292     if (!MO.isReg()) continue;
293     unsigned Reg = MO.getReg();
294     if (Reg == 0 || !TargetRegisterInfo::isPhysicalRegister(Reg))
295       continue;
296     if (MRI->hasOneNonDBGUse(Reg))
297       return true;
298   }
299
300   return false;
301 }
302
303 MachineBasicBlock *MachineSinking::SplitCriticalEdge(MachineInstr *MI,
304                                                      MachineBasicBlock *FromBB,
305                                                      MachineBasicBlock *ToBB,
306                                                      bool BreakPHIEdge) {
307   if (!isWorthBreakingCriticalEdge(MI, FromBB, ToBB))
308     return 0;
309
310   // Avoid breaking back edge. From == To means backedge for single BB loop.
311   if (!SplitEdges || FromBB == ToBB)
312     return 0;
313
314   // Check for backedges of more "complex" loops.
315   if (LI->getLoopFor(FromBB) == LI->getLoopFor(ToBB) &&
316       LI->isLoopHeader(ToBB))
317     return 0;
318
319   // It's not always legal to break critical edges and sink the computation
320   // to the edge.
321   //
322   // BB#1:
323   // v1024
324   // Beq BB#3
325   // <fallthrough>
326   // BB#2:
327   // ... no uses of v1024
328   // <fallthrough>
329   // BB#3:
330   // ...
331   //       = v1024
332   //
333   // If BB#1 -> BB#3 edge is broken and computation of v1024 is inserted:
334   //
335   // BB#1:
336   // ...
337   // Bne BB#2
338   // BB#4:
339   // v1024 =
340   // B BB#3
341   // BB#2:
342   // ... no uses of v1024
343   // <fallthrough>
344   // BB#3:
345   // ...
346   //       = v1024
347   //
348   // This is incorrect since v1024 is not computed along the BB#1->BB#2->BB#3
349   // flow. We need to ensure the new basic block where the computation is
350   // sunk to dominates all the uses.
351   // It's only legal to break critical edge and sink the computation to the
352   // new block if all the predecessors of "To", except for "From", are
353   // not dominated by "From". Given SSA property, this means these
354   // predecessors are dominated by "To".
355   //
356   // There is no need to do this check if all the uses are PHI nodes. PHI
357   // sources are only defined on the specific predecessor edges.
358   if (!BreakPHIEdge) {
359     for (MachineBasicBlock::pred_iterator PI = ToBB->pred_begin(),
360            E = ToBB->pred_end(); PI != E; ++PI) {
361       if (*PI == FromBB)
362         continue;
363       if (!DT->dominates(ToBB, *PI))
364         return 0;
365     }
366   }
367
368   return FromBB->SplitCriticalEdge(ToBB, this);
369 }
370
371 /// SinkInstruction - Determine whether it is safe to sink the specified machine
372 /// instruction out of its current block into a successor.
373 bool MachineSinking::SinkInstruction(MachineInstr *MI, bool &SawStore) {
374   // Check if it's safe to move the instruction.
375   if (!MI->isSafeToMove(TII, AA, SawStore))
376     return false;
377
378   // FIXME: This should include support for sinking instructions within the
379   // block they are currently in to shorten the live ranges.  We often get
380   // instructions sunk into the top of a large block, but it would be better to
381   // also sink them down before their first use in the block.  This xform has to
382   // be careful not to *increase* register pressure though, e.g. sinking
383   // "x = y + z" down if it kills y and z would increase the live ranges of y
384   // and z and only shrink the live range of x.
385
386   // Loop over all the operands of the specified instruction.  If there is
387   // anything we can't handle, bail out.
388   MachineBasicBlock *ParentBlock = MI->getParent();
389
390   // SuccToSinkTo - This is the successor to sink this instruction to, once we
391   // decide.
392   MachineBasicBlock *SuccToSinkTo = 0;
393
394   bool BreakPHIEdge = false;
395   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
396     const MachineOperand &MO = MI->getOperand(i);
397     if (!MO.isReg()) continue;  // Ignore non-register operands.
398
399     unsigned Reg = MO.getReg();
400     if (Reg == 0) continue;
401
402     if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
403       if (MO.isUse()) {
404         // If the physreg has no defs anywhere, it's just an ambient register
405         // and we can freely move its uses. Alternatively, if it's allocatable,
406         // it could get allocated to something with a def during allocation.
407         if (!MRI->def_empty(Reg))
408           return false;
409
410         if (AllocatableSet.test(Reg))
411           return false;
412
413         // Check for a def among the register's aliases too.
414         for (const unsigned *Alias = TRI->getAliasSet(Reg); *Alias; ++Alias) {
415           unsigned AliasReg = *Alias;
416           if (!MRI->def_empty(AliasReg))
417             return false;
418
419           if (AllocatableSet.test(AliasReg))
420             return false;
421         }
422       } else if (!MO.isDead()) {
423         // A def that isn't dead. We can't move it.
424         return false;
425       }
426     } else {
427       // Virtual register uses are always safe to sink.
428       if (MO.isUse()) continue;
429
430       // If it's not safe to move defs of the register class, then abort.
431       if (!TII->isSafeToMoveRegClassDefs(MRI->getRegClass(Reg)))
432         return false;
433
434       // FIXME: This picks a successor to sink into based on having one
435       // successor that dominates all the uses.  However, there are cases where
436       // sinking can happen but where the sink point isn't a successor.  For
437       // example:
438       //
439       //   x = computation
440       //   if () {} else {}
441       //   use x
442       //
443       // the instruction could be sunk over the whole diamond for the
444       // if/then/else (or loop, etc), allowing it to be sunk into other blocks
445       // after that.
446
447       // Virtual register defs can only be sunk if all their uses are in blocks
448       // dominated by one of the successors.
449       if (SuccToSinkTo) {
450         // If a previous operand picked a block to sink to, then this operand
451         // must be sinkable to the same block.
452         bool LocalUse = false;
453         if (!AllUsesDominatedByBlock(Reg, SuccToSinkTo, ParentBlock,
454                                      BreakPHIEdge, LocalUse))
455           return false;
456
457         continue;
458       }
459
460       // Otherwise, we should look at all the successors and decide which one
461       // we should sink to.
462       for (MachineBasicBlock::succ_iterator SI = ParentBlock->succ_begin(),
463            E = ParentBlock->succ_end(); SI != E; ++SI) {
464         bool LocalUse = false;
465         if (AllUsesDominatedByBlock(Reg, *SI, ParentBlock,
466                                     BreakPHIEdge, LocalUse)) {
467           SuccToSinkTo = *SI;
468           break;
469         }
470         if (LocalUse)
471           // Def is used locally, it's never safe to move this def.
472           return false;
473       }
474
475       // If we couldn't find a block to sink to, ignore this instruction.
476       if (SuccToSinkTo == 0)
477         return false;
478     }
479   }
480
481   // If there are no outputs, it must have side-effects.
482   if (SuccToSinkTo == 0)
483     return false;
484
485   // It's not safe to sink instructions to EH landing pad. Control flow into
486   // landing pad is implicitly defined.
487   if (SuccToSinkTo->isLandingPad())
488     return false;
489
490   // It is not possible to sink an instruction into its own block.  This can
491   // happen with loops.
492   if (MI->getParent() == SuccToSinkTo)
493     return false;
494
495   // If the instruction to move defines a dead physical register which is live
496   // when leaving the basic block, don't move it because it could turn into a
497   // "zombie" define of that preg. E.g., EFLAGS. (<rdar://problem/8030636>)
498   for (unsigned I = 0, E = MI->getNumOperands(); I != E; ++I) {
499     const MachineOperand &MO = MI->getOperand(I);
500     if (!MO.isReg()) continue;
501     unsigned Reg = MO.getReg();
502     if (Reg == 0 || !TargetRegisterInfo::isPhysicalRegister(Reg)) continue;
503     if (SuccToSinkTo->isLiveIn(Reg))
504       return false;
505   }
506
507   DEBUG(dbgs() << "Sink instr " << *MI << "\tinto block " << *SuccToSinkTo);
508
509   // If the block has multiple predecessors, this would introduce computation on
510   // a path that it doesn't already exist.  We could split the critical edge,
511   // but for now we just punt.
512   if (SuccToSinkTo->pred_size() > 1) {
513     // We cannot sink a load across a critical edge - there may be stores in
514     // other code paths.
515     bool TryBreak = false;
516     bool store = true;
517     if (!MI->isSafeToMove(TII, AA, store)) {
518       DEBUG(dbgs() << " *** NOTE: Won't sink load along critical edge.\n");
519       TryBreak = true;
520     }
521
522     // We don't want to sink across a critical edge if we don't dominate the
523     // successor. We could be introducing calculations to new code paths.
524     if (!TryBreak && !DT->dominates(ParentBlock, SuccToSinkTo)) {
525       DEBUG(dbgs() << " *** NOTE: Critical edge found\n");
526       TryBreak = true;
527     }
528
529     // Don't sink instructions into a loop.
530     if (!TryBreak && LI->isLoopHeader(SuccToSinkTo)) {
531       DEBUG(dbgs() << " *** NOTE: Loop header found\n");
532       TryBreak = true;
533     }
534
535     // Otherwise we are OK with sinking along a critical edge.
536     if (!TryBreak)
537       DEBUG(dbgs() << "Sinking along critical edge.\n");
538     else {
539       MachineBasicBlock *NewSucc =
540         SplitCriticalEdge(MI, ParentBlock, SuccToSinkTo, BreakPHIEdge);
541       if (!NewSucc) {
542         DEBUG(dbgs() << " *** PUNTING: Not legal or profitable to "
543                         "break critical edge\n");
544         return false;
545       } else {
546         DEBUG(dbgs() << " *** Splitting critical edge:"
547               " BB#" << ParentBlock->getNumber()
548               << " -- BB#" << NewSucc->getNumber()
549               << " -- BB#" << SuccToSinkTo->getNumber() << '\n');
550         SuccToSinkTo = NewSucc;
551         ++NumSplit;
552         BreakPHIEdge = false;
553       }
554     }
555   }
556
557   if (BreakPHIEdge) {
558     // BreakPHIEdge is true if all the uses are in the successor MBB being
559     // sunken into and they are all PHI nodes. In this case, machine-sink must
560     // break the critical edge first.
561     MachineBasicBlock *NewSucc = SplitCriticalEdge(MI, ParentBlock,
562                                                    SuccToSinkTo, BreakPHIEdge);
563     if (!NewSucc) {
564       DEBUG(dbgs() << " *** PUNTING: Not legal or profitable to "
565             "break critical edge\n");
566       return false;
567     }
568
569     DEBUG(dbgs() << " *** Splitting critical edge:"
570           " BB#" << ParentBlock->getNumber()
571           << " -- BB#" << NewSucc->getNumber()
572           << " -- BB#" << SuccToSinkTo->getNumber() << '\n');
573     SuccToSinkTo = NewSucc;
574     ++NumSplit;
575   }
576
577   // Determine where to insert into. Skip phi nodes.
578   MachineBasicBlock::iterator InsertPos = SuccToSinkTo->begin();
579   while (InsertPos != SuccToSinkTo->end() && InsertPos->isPHI())
580     ++InsertPos;
581
582   // Move the instruction.
583   SuccToSinkTo->splice(InsertPos, ParentBlock, MI,
584                        ++MachineBasicBlock::iterator(MI));
585
586   // Conservatively, clear any kill flags, since it's possible that they are no
587   // longer correct.
588   MI->clearKillInfo();
589
590   return true;
591 }