Don't analyze block if it's not considered for ifcvt anymore.
[llvm/stm8.git] / lib / CodeGen / IfConversion.cpp
blob8cf68d660250dd481268246694e95889e1869bbb
1 //===-- IfConversion.cpp - Machine code if conversion pass. ---------------===//
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 the machine instruction level if-conversion pass.
12 //===----------------------------------------------------------------------===//
14 #define DEBUG_TYPE "ifcvt"
15 #include "BranchFolding.h"
16 #include "llvm/Function.h"
17 #include "llvm/CodeGen/Passes.h"
18 #include "llvm/CodeGen/MachineModuleInfo.h"
19 #include "llvm/CodeGen/MachineFunctionPass.h"
20 #include "llvm/CodeGen/MachineLoopInfo.h"
21 #include "llvm/MC/MCInstrItineraries.h"
22 #include "llvm/Target/TargetInstrInfo.h"
23 #include "llvm/Target/TargetLowering.h"
24 #include "llvm/Target/TargetMachine.h"
25 #include "llvm/Target/TargetRegisterInfo.h"
26 #include "llvm/Support/CommandLine.h"
27 #include "llvm/Support/Debug.h"
28 #include "llvm/Support/ErrorHandling.h"
29 #include "llvm/Support/raw_ostream.h"
30 #include "llvm/ADT/SmallSet.h"
31 #include "llvm/ADT/Statistic.h"
32 #include "llvm/ADT/STLExtras.h"
33 using namespace llvm;
35 // Hidden options for help debugging.
36 static cl::opt<int> IfCvtFnStart("ifcvt-fn-start", cl::init(-1), cl::Hidden);
37 static cl::opt<int> IfCvtFnStop("ifcvt-fn-stop", cl::init(-1), cl::Hidden);
38 static cl::opt<int> IfCvtLimit("ifcvt-limit", cl::init(-1), cl::Hidden);
39 static cl::opt<bool> DisableSimple("disable-ifcvt-simple",
40 cl::init(false), cl::Hidden);
41 static cl::opt<bool> DisableSimpleF("disable-ifcvt-simple-false",
42 cl::init(false), cl::Hidden);
43 static cl::opt<bool> DisableTriangle("disable-ifcvt-triangle",
44 cl::init(false), cl::Hidden);
45 static cl::opt<bool> DisableTriangleR("disable-ifcvt-triangle-rev",
46 cl::init(false), cl::Hidden);
47 static cl::opt<bool> DisableTriangleF("disable-ifcvt-triangle-false",
48 cl::init(false), cl::Hidden);
49 static cl::opt<bool> DisableTriangleFR("disable-ifcvt-triangle-false-rev",
50 cl::init(false), cl::Hidden);
51 static cl::opt<bool> DisableDiamond("disable-ifcvt-diamond",
52 cl::init(false), cl::Hidden);
53 static cl::opt<bool> IfCvtBranchFold("ifcvt-branch-fold",
54 cl::init(true), cl::Hidden);
56 STATISTIC(NumSimple, "Number of simple if-conversions performed");
57 STATISTIC(NumSimpleFalse, "Number of simple (F) if-conversions performed");
58 STATISTIC(NumTriangle, "Number of triangle if-conversions performed");
59 STATISTIC(NumTriangleRev, "Number of triangle (R) if-conversions performed");
60 STATISTIC(NumTriangleFalse,"Number of triangle (F) if-conversions performed");
61 STATISTIC(NumTriangleFRev, "Number of triangle (F/R) if-conversions performed");
62 STATISTIC(NumDiamonds, "Number of diamond if-conversions performed");
63 STATISTIC(NumIfConvBBs, "Number of if-converted blocks");
64 STATISTIC(NumDupBBs, "Number of duplicated blocks");
66 namespace {
67 class IfConverter : public MachineFunctionPass {
68 enum IfcvtKind {
69 ICNotClassfied, // BB data valid, but not classified.
70 ICSimpleFalse, // Same as ICSimple, but on the false path.
71 ICSimple, // BB is entry of an one split, no rejoin sub-CFG.
72 ICTriangleFRev, // Same as ICTriangleFalse, but false path rev condition.
73 ICTriangleRev, // Same as ICTriangle, but true path rev condition.
74 ICTriangleFalse, // Same as ICTriangle, but on the false path.
75 ICTriangle, // BB is entry of a triangle sub-CFG.
76 ICDiamond // BB is entry of a diamond sub-CFG.
79 /// BBInfo - One per MachineBasicBlock, this is used to cache the result
80 /// if-conversion feasibility analysis. This includes results from
81 /// TargetInstrInfo::AnalyzeBranch() (i.e. TBB, FBB, and Cond), and its
82 /// classification, and common tail block of its successors (if it's a
83 /// diamond shape), its size, whether it's predicable, and whether any
84 /// instruction can clobber the 'would-be' predicate.
85 ///
86 /// IsDone - True if BB is not to be considered for ifcvt.
87 /// IsBeingAnalyzed - True if BB is currently being analyzed.
88 /// IsAnalyzed - True if BB has been analyzed (info is still valid).
89 /// IsEnqueued - True if BB has been enqueued to be ifcvt'ed.
90 /// IsBrAnalyzable - True if AnalyzeBranch() returns false.
91 /// HasFallThrough - True if BB may fallthrough to the following BB.
92 /// IsUnpredicable - True if BB is known to be unpredicable.
93 /// ClobbersPred - True if BB could modify predicates (e.g. has
94 /// cmp, call, etc.)
95 /// NonPredSize - Number of non-predicated instructions.
96 /// ExtraCost - Extra cost for multi-cycle instructions.
97 /// ExtraCost2 - Some instructions are slower when predicated
98 /// BB - Corresponding MachineBasicBlock.
99 /// TrueBB / FalseBB- See AnalyzeBranch().
100 /// BrCond - Conditions for end of block conditional branches.
101 /// Predicate - Predicate used in the BB.
102 struct BBInfo {
103 bool IsDone : 1;
104 bool IsBeingAnalyzed : 1;
105 bool IsAnalyzed : 1;
106 bool IsEnqueued : 1;
107 bool IsBrAnalyzable : 1;
108 bool HasFallThrough : 1;
109 bool IsUnpredicable : 1;
110 bool CannotBeCopied : 1;
111 bool ClobbersPred : 1;
112 unsigned NonPredSize;
113 unsigned ExtraCost;
114 unsigned ExtraCost2;
115 MachineBasicBlock *BB;
116 MachineBasicBlock *TrueBB;
117 MachineBasicBlock *FalseBB;
118 SmallVector<MachineOperand, 4> BrCond;
119 SmallVector<MachineOperand, 4> Predicate;
120 BBInfo() : IsDone(false), IsBeingAnalyzed(false),
121 IsAnalyzed(false), IsEnqueued(false), IsBrAnalyzable(false),
122 HasFallThrough(false), IsUnpredicable(false),
123 CannotBeCopied(false), ClobbersPred(false), NonPredSize(0),
124 ExtraCost(0), ExtraCost2(0), BB(0), TrueBB(0), FalseBB(0) {}
127 /// IfcvtToken - Record information about pending if-conversions to attempt:
128 /// BBI - Corresponding BBInfo.
129 /// Kind - Type of block. See IfcvtKind.
130 /// NeedSubsumption - True if the to-be-predicated BB has already been
131 /// predicated.
132 /// NumDups - Number of instructions that would be duplicated due
133 /// to this if-conversion. (For diamonds, the number of
134 /// identical instructions at the beginnings of both
135 /// paths).
136 /// NumDups2 - For diamonds, the number of identical instructions
137 /// at the ends of both paths.
138 struct IfcvtToken {
139 BBInfo &BBI;
140 IfcvtKind Kind;
141 bool NeedSubsumption;
142 unsigned NumDups;
143 unsigned NumDups2;
144 IfcvtToken(BBInfo &b, IfcvtKind k, bool s, unsigned d, unsigned d2 = 0)
145 : BBI(b), Kind(k), NeedSubsumption(s), NumDups(d), NumDups2(d2) {}
148 /// BBAnalysis - Results of if-conversion feasibility analysis indexed by
149 /// basic block number.
150 std::vector<BBInfo> BBAnalysis;
152 const TargetLowering *TLI;
153 const TargetInstrInfo *TII;
154 const TargetRegisterInfo *TRI;
155 const InstrItineraryData *InstrItins;
156 const MachineLoopInfo *MLI;
157 bool MadeChange;
158 int FnNum;
159 public:
160 static char ID;
161 IfConverter() : MachineFunctionPass(ID), FnNum(-1) {
162 initializeIfConverterPass(*PassRegistry::getPassRegistry());
165 virtual void getAnalysisUsage(AnalysisUsage &AU) const {
166 AU.addRequired<MachineLoopInfo>();
167 MachineFunctionPass::getAnalysisUsage(AU);
170 virtual bool runOnMachineFunction(MachineFunction &MF);
171 virtual const char *getPassName() const { return "If Converter"; }
173 private:
174 bool ReverseBranchCondition(BBInfo &BBI);
175 bool ValidSimple(BBInfo &TrueBBI, unsigned &Dups,
176 float Prediction, float Confidence) const;
177 bool ValidTriangle(BBInfo &TrueBBI, BBInfo &FalseBBI,
178 bool FalseBranch, unsigned &Dups,
179 float Prediction, float Confidence) const;
180 bool ValidDiamond(BBInfo &TrueBBI, BBInfo &FalseBBI,
181 unsigned &Dups1, unsigned &Dups2) const;
182 void ScanInstructions(BBInfo &BBI);
183 BBInfo &AnalyzeBlock(MachineBasicBlock *BB,
184 std::vector<IfcvtToken*> &Tokens);
185 bool FeasibilityAnalysis(BBInfo &BBI, SmallVectorImpl<MachineOperand> &Cond,
186 bool isTriangle = false, bool RevBranch = false);
187 void AnalyzeBlocks(MachineFunction &MF, std::vector<IfcvtToken*> &Tokens);
188 void InvalidatePreds(MachineBasicBlock *BB);
189 void RemoveExtraEdges(BBInfo &BBI);
190 bool IfConvertSimple(BBInfo &BBI, IfcvtKind Kind);
191 bool IfConvertTriangle(BBInfo &BBI, IfcvtKind Kind);
192 bool IfConvertDiamond(BBInfo &BBI, IfcvtKind Kind,
193 unsigned NumDups1, unsigned NumDups2);
194 void PredicateBlock(BBInfo &BBI,
195 MachineBasicBlock::iterator E,
196 SmallVectorImpl<MachineOperand> &Cond,
197 SmallSet<unsigned, 4> &Redefs);
198 void CopyAndPredicateBlock(BBInfo &ToBBI, BBInfo &FromBBI,
199 SmallVectorImpl<MachineOperand> &Cond,
200 SmallSet<unsigned, 4> &Redefs,
201 bool IgnoreBr = false);
202 void MergeBlocks(BBInfo &ToBBI, BBInfo &FromBBI, bool AddEdges = true);
204 bool MeetIfcvtSizeLimit(MachineBasicBlock &BB,
205 unsigned Cycle, unsigned Extra,
206 float Prediction, float Confidence) const {
207 return Cycle > 0 && TII->isProfitableToIfCvt(BB, Cycle, Extra,
208 Prediction, Confidence);
211 bool MeetIfcvtSizeLimit(MachineBasicBlock &TBB,
212 unsigned TCycle, unsigned TExtra,
213 MachineBasicBlock &FBB,
214 unsigned FCycle, unsigned FExtra,
215 float Prediction, float Confidence) const {
216 return TCycle > 0 && FCycle > 0 &&
217 TII->isProfitableToIfCvt(TBB, TCycle, TExtra, FBB, FCycle, FExtra,
218 Prediction, Confidence);
221 // blockAlwaysFallThrough - Block ends without a terminator.
222 bool blockAlwaysFallThrough(BBInfo &BBI) const {
223 return BBI.IsBrAnalyzable && BBI.TrueBB == NULL;
226 // IfcvtTokenCmp - Used to sort if-conversion candidates.
227 static bool IfcvtTokenCmp(IfcvtToken *C1, IfcvtToken *C2) {
228 int Incr1 = (C1->Kind == ICDiamond)
229 ? -(int)(C1->NumDups + C1->NumDups2) : (int)C1->NumDups;
230 int Incr2 = (C2->Kind == ICDiamond)
231 ? -(int)(C2->NumDups + C2->NumDups2) : (int)C2->NumDups;
232 if (Incr1 > Incr2)
233 return true;
234 else if (Incr1 == Incr2) {
235 // Favors subsumption.
236 if (C1->NeedSubsumption == false && C2->NeedSubsumption == true)
237 return true;
238 else if (C1->NeedSubsumption == C2->NeedSubsumption) {
239 // Favors diamond over triangle, etc.
240 if ((unsigned)C1->Kind < (unsigned)C2->Kind)
241 return true;
242 else if (C1->Kind == C2->Kind)
243 return C1->BBI.BB->getNumber() < C2->BBI.BB->getNumber();
246 return false;
250 char IfConverter::ID = 0;
253 INITIALIZE_PASS_BEGIN(IfConverter, "if-converter", "If Converter", false, false)
254 INITIALIZE_PASS_DEPENDENCY(MachineLoopInfo)
255 INITIALIZE_PASS_END(IfConverter, "if-converter", "If Converter", false, false)
257 FunctionPass *llvm::createIfConverterPass() { return new IfConverter(); }
259 bool IfConverter::runOnMachineFunction(MachineFunction &MF) {
260 TLI = MF.getTarget().getTargetLowering();
261 TII = MF.getTarget().getInstrInfo();
262 TRI = MF.getTarget().getRegisterInfo();
263 MLI = &getAnalysis<MachineLoopInfo>();
264 InstrItins = MF.getTarget().getInstrItineraryData();
265 if (!TII) return false;
267 // Tail merge tend to expose more if-conversion opportunities.
268 BranchFolder BF(true, false);
269 bool BFChange = BF.OptimizeFunction(MF, TII,
270 MF.getTarget().getRegisterInfo(),
271 getAnalysisIfAvailable<MachineModuleInfo>());
273 DEBUG(dbgs() << "\nIfcvt: function (" << ++FnNum << ") \'"
274 << MF.getFunction()->getName() << "\'");
276 if (FnNum < IfCvtFnStart || (IfCvtFnStop != -1 && FnNum > IfCvtFnStop)) {
277 DEBUG(dbgs() << " skipped\n");
278 return false;
280 DEBUG(dbgs() << "\n");
282 MF.RenumberBlocks();
283 BBAnalysis.resize(MF.getNumBlockIDs());
285 std::vector<IfcvtToken*> Tokens;
286 MadeChange = false;
287 unsigned NumIfCvts = NumSimple + NumSimpleFalse + NumTriangle +
288 NumTriangleRev + NumTriangleFalse + NumTriangleFRev + NumDiamonds;
289 while (IfCvtLimit == -1 || (int)NumIfCvts < IfCvtLimit) {
290 // Do an initial analysis for each basic block and find all the potential
291 // candidates to perform if-conversion.
292 bool Change = false;
293 AnalyzeBlocks(MF, Tokens);
294 while (!Tokens.empty()) {
295 IfcvtToken *Token = Tokens.back();
296 Tokens.pop_back();
297 BBInfo &BBI = Token->BBI;
298 IfcvtKind Kind = Token->Kind;
299 unsigned NumDups = Token->NumDups;
300 unsigned NumDups2 = Token->NumDups2;
302 delete Token;
304 // If the block has been evicted out of the queue or it has already been
305 // marked dead (due to it being predicated), then skip it.
306 if (BBI.IsDone)
307 BBI.IsEnqueued = false;
308 if (!BBI.IsEnqueued)
309 continue;
311 BBI.IsEnqueued = false;
313 bool RetVal = false;
314 switch (Kind) {
315 default: assert(false && "Unexpected!");
316 break;
317 case ICSimple:
318 case ICSimpleFalse: {
319 bool isFalse = Kind == ICSimpleFalse;
320 if ((isFalse && DisableSimpleF) || (!isFalse && DisableSimple)) break;
321 DEBUG(dbgs() << "Ifcvt (Simple" << (Kind == ICSimpleFalse ?
322 " false" : "")
323 << "): BB#" << BBI.BB->getNumber() << " ("
324 << ((Kind == ICSimpleFalse)
325 ? BBI.FalseBB->getNumber()
326 : BBI.TrueBB->getNumber()) << ") ");
327 RetVal = IfConvertSimple(BBI, Kind);
328 DEBUG(dbgs() << (RetVal ? "succeeded!" : "failed!") << "\n");
329 if (RetVal) {
330 if (isFalse) ++NumSimpleFalse;
331 else ++NumSimple;
333 break;
335 case ICTriangle:
336 case ICTriangleRev:
337 case ICTriangleFalse:
338 case ICTriangleFRev: {
339 bool isFalse = Kind == ICTriangleFalse;
340 bool isRev = (Kind == ICTriangleRev || Kind == ICTriangleFRev);
341 if (DisableTriangle && !isFalse && !isRev) break;
342 if (DisableTriangleR && !isFalse && isRev) break;
343 if (DisableTriangleF && isFalse && !isRev) break;
344 if (DisableTriangleFR && isFalse && isRev) break;
345 DEBUG(dbgs() << "Ifcvt (Triangle");
346 if (isFalse)
347 DEBUG(dbgs() << " false");
348 if (isRev)
349 DEBUG(dbgs() << " rev");
350 DEBUG(dbgs() << "): BB#" << BBI.BB->getNumber() << " (T:"
351 << BBI.TrueBB->getNumber() << ",F:"
352 << BBI.FalseBB->getNumber() << ") ");
353 RetVal = IfConvertTriangle(BBI, Kind);
354 DEBUG(dbgs() << (RetVal ? "succeeded!" : "failed!") << "\n");
355 if (RetVal) {
356 if (isFalse) {
357 if (isRev) ++NumTriangleFRev;
358 else ++NumTriangleFalse;
359 } else {
360 if (isRev) ++NumTriangleRev;
361 else ++NumTriangle;
364 break;
366 case ICDiamond: {
367 if (DisableDiamond) break;
368 DEBUG(dbgs() << "Ifcvt (Diamond): BB#" << BBI.BB->getNumber() << " (T:"
369 << BBI.TrueBB->getNumber() << ",F:"
370 << BBI.FalseBB->getNumber() << ") ");
371 RetVal = IfConvertDiamond(BBI, Kind, NumDups, NumDups2);
372 DEBUG(dbgs() << (RetVal ? "succeeded!" : "failed!") << "\n");
373 if (RetVal) ++NumDiamonds;
374 break;
378 Change |= RetVal;
380 NumIfCvts = NumSimple + NumSimpleFalse + NumTriangle + NumTriangleRev +
381 NumTriangleFalse + NumTriangleFRev + NumDiamonds;
382 if (IfCvtLimit != -1 && (int)NumIfCvts >= IfCvtLimit)
383 break;
386 if (!Change)
387 break;
388 MadeChange |= Change;
391 // Delete tokens in case of early exit.
392 while (!Tokens.empty()) {
393 IfcvtToken *Token = Tokens.back();
394 Tokens.pop_back();
395 delete Token;
398 Tokens.clear();
399 BBAnalysis.clear();
401 if (MadeChange && IfCvtBranchFold) {
402 BranchFolder BF(false, false);
403 BF.OptimizeFunction(MF, TII,
404 MF.getTarget().getRegisterInfo(),
405 getAnalysisIfAvailable<MachineModuleInfo>());
408 MadeChange |= BFChange;
409 return MadeChange;
412 /// findFalseBlock - BB has a fallthrough. Find its 'false' successor given
413 /// its 'true' successor.
414 static MachineBasicBlock *findFalseBlock(MachineBasicBlock *BB,
415 MachineBasicBlock *TrueBB) {
416 for (MachineBasicBlock::succ_iterator SI = BB->succ_begin(),
417 E = BB->succ_end(); SI != E; ++SI) {
418 MachineBasicBlock *SuccBB = *SI;
419 if (SuccBB != TrueBB)
420 return SuccBB;
422 return NULL;
425 /// ReverseBranchCondition - Reverse the condition of the end of the block
426 /// branch. Swap block's 'true' and 'false' successors.
427 bool IfConverter::ReverseBranchCondition(BBInfo &BBI) {
428 DebugLoc dl; // FIXME: this is nowhere
429 if (!TII->ReverseBranchCondition(BBI.BrCond)) {
430 TII->RemoveBranch(*BBI.BB);
431 TII->InsertBranch(*BBI.BB, BBI.FalseBB, BBI.TrueBB, BBI.BrCond, dl);
432 std::swap(BBI.TrueBB, BBI.FalseBB);
433 return true;
435 return false;
438 /// getNextBlock - Returns the next block in the function blocks ordering. If
439 /// it is the end, returns NULL.
440 static inline MachineBasicBlock *getNextBlock(MachineBasicBlock *BB) {
441 MachineFunction::iterator I = BB;
442 MachineFunction::iterator E = BB->getParent()->end();
443 if (++I == E)
444 return NULL;
445 return I;
448 /// ValidSimple - Returns true if the 'true' block (along with its
449 /// predecessor) forms a valid simple shape for ifcvt. It also returns the
450 /// number of instructions that the ifcvt would need to duplicate if performed
451 /// in Dups.
452 bool IfConverter::ValidSimple(BBInfo &TrueBBI, unsigned &Dups,
453 float Prediction, float Confidence) const {
454 Dups = 0;
455 if (TrueBBI.IsBeingAnalyzed || TrueBBI.IsDone)
456 return false;
458 if (TrueBBI.IsBrAnalyzable)
459 return false;
461 if (TrueBBI.BB->pred_size() > 1) {
462 if (TrueBBI.CannotBeCopied ||
463 !TII->isProfitableToDupForIfCvt(*TrueBBI.BB, TrueBBI.NonPredSize,
464 Prediction, Confidence))
465 return false;
466 Dups = TrueBBI.NonPredSize;
469 return true;
472 /// ValidTriangle - Returns true if the 'true' and 'false' blocks (along
473 /// with their common predecessor) forms a valid triangle shape for ifcvt.
474 /// If 'FalseBranch' is true, it checks if 'true' block's false branch
475 /// branches to the 'false' block rather than the other way around. It also
476 /// returns the number of instructions that the ifcvt would need to duplicate
477 /// if performed in 'Dups'.
478 bool IfConverter::ValidTriangle(BBInfo &TrueBBI, BBInfo &FalseBBI,
479 bool FalseBranch, unsigned &Dups,
480 float Prediction, float Confidence) const {
481 Dups = 0;
482 if (TrueBBI.IsBeingAnalyzed || TrueBBI.IsDone)
483 return false;
485 if (TrueBBI.BB->pred_size() > 1) {
486 if (TrueBBI.CannotBeCopied)
487 return false;
489 unsigned Size = TrueBBI.NonPredSize;
490 if (TrueBBI.IsBrAnalyzable) {
491 if (TrueBBI.TrueBB && TrueBBI.BrCond.empty())
492 // Ends with an unconditional branch. It will be removed.
493 --Size;
494 else {
495 MachineBasicBlock *FExit = FalseBranch
496 ? TrueBBI.TrueBB : TrueBBI.FalseBB;
497 if (FExit)
498 // Require a conditional branch
499 ++Size;
502 if (!TII->isProfitableToDupForIfCvt(*TrueBBI.BB, Size,
503 Prediction, Confidence))
504 return false;
505 Dups = Size;
508 MachineBasicBlock *TExit = FalseBranch ? TrueBBI.FalseBB : TrueBBI.TrueBB;
509 if (!TExit && blockAlwaysFallThrough(TrueBBI)) {
510 MachineFunction::iterator I = TrueBBI.BB;
511 if (++I == TrueBBI.BB->getParent()->end())
512 return false;
513 TExit = I;
515 return TExit && TExit == FalseBBI.BB;
518 /// ValidDiamond - Returns true if the 'true' and 'false' blocks (along
519 /// with their common predecessor) forms a valid diamond shape for ifcvt.
520 bool IfConverter::ValidDiamond(BBInfo &TrueBBI, BBInfo &FalseBBI,
521 unsigned &Dups1, unsigned &Dups2) const {
522 Dups1 = Dups2 = 0;
523 if (TrueBBI.IsBeingAnalyzed || TrueBBI.IsDone ||
524 FalseBBI.IsBeingAnalyzed || FalseBBI.IsDone)
525 return false;
527 MachineBasicBlock *TT = TrueBBI.TrueBB;
528 MachineBasicBlock *FT = FalseBBI.TrueBB;
530 if (!TT && blockAlwaysFallThrough(TrueBBI))
531 TT = getNextBlock(TrueBBI.BB);
532 if (!FT && blockAlwaysFallThrough(FalseBBI))
533 FT = getNextBlock(FalseBBI.BB);
534 if (TT != FT)
535 return false;
536 if (TT == NULL && (TrueBBI.IsBrAnalyzable || FalseBBI.IsBrAnalyzable))
537 return false;
538 if (TrueBBI.BB->pred_size() > 1 || FalseBBI.BB->pred_size() > 1)
539 return false;
541 // FIXME: Allow true block to have an early exit?
542 if (TrueBBI.FalseBB || FalseBBI.FalseBB ||
543 (TrueBBI.ClobbersPred && FalseBBI.ClobbersPred))
544 return false;
546 // Count duplicate instructions at the beginning of the true and false blocks.
547 MachineBasicBlock::iterator TIB = TrueBBI.BB->begin();
548 MachineBasicBlock::iterator FIB = FalseBBI.BB->begin();
549 MachineBasicBlock::iterator TIE = TrueBBI.BB->end();
550 MachineBasicBlock::iterator FIE = FalseBBI.BB->end();
551 while (TIB != TIE && FIB != FIE) {
552 // Skip dbg_value instructions. These do not count.
553 if (TIB->isDebugValue()) {
554 while (TIB != TIE && TIB->isDebugValue())
555 ++TIB;
556 if (TIB == TIE)
557 break;
559 if (FIB->isDebugValue()) {
560 while (FIB != FIE && FIB->isDebugValue())
561 ++FIB;
562 if (FIB == FIE)
563 break;
565 if (!TIB->isIdenticalTo(FIB))
566 break;
567 ++Dups1;
568 ++TIB;
569 ++FIB;
572 // Now, in preparation for counting duplicate instructions at the ends of the
573 // blocks, move the end iterators up past any branch instructions.
574 while (TIE != TIB) {
575 --TIE;
576 if (!TIE->getDesc().isBranch())
577 break;
579 while (FIE != FIB) {
580 --FIE;
581 if (!FIE->getDesc().isBranch())
582 break;
585 // If Dups1 includes all of a block, then don't count duplicate
586 // instructions at the end of the blocks.
587 if (TIB == TIE || FIB == FIE)
588 return true;
590 // Count duplicate instructions at the ends of the blocks.
591 while (TIE != TIB && FIE != FIB) {
592 // Skip dbg_value instructions. These do not count.
593 if (TIE->isDebugValue()) {
594 while (TIE != TIB && TIE->isDebugValue())
595 --TIE;
596 if (TIE == TIB)
597 break;
599 if (FIE->isDebugValue()) {
600 while (FIE != FIB && FIE->isDebugValue())
601 --FIE;
602 if (FIE == FIB)
603 break;
605 if (!TIE->isIdenticalTo(FIE))
606 break;
607 ++Dups2;
608 --TIE;
609 --FIE;
612 return true;
615 /// ScanInstructions - Scan all the instructions in the block to determine if
616 /// the block is predicable. In most cases, that means all the instructions
617 /// in the block are isPredicable(). Also checks if the block contains any
618 /// instruction which can clobber a predicate (e.g. condition code register).
619 /// If so, the block is not predicable unless it's the last instruction.
620 void IfConverter::ScanInstructions(BBInfo &BBI) {
621 if (BBI.IsDone)
622 return;
624 bool AlreadyPredicated = BBI.Predicate.size() > 0;
625 // First analyze the end of BB branches.
626 BBI.TrueBB = BBI.FalseBB = NULL;
627 BBI.BrCond.clear();
628 BBI.IsBrAnalyzable =
629 !TII->AnalyzeBranch(*BBI.BB, BBI.TrueBB, BBI.FalseBB, BBI.BrCond);
630 BBI.HasFallThrough = BBI.IsBrAnalyzable && BBI.FalseBB == NULL;
632 if (BBI.BrCond.size()) {
633 // No false branch. This BB must end with a conditional branch and a
634 // fallthrough.
635 if (!BBI.FalseBB)
636 BBI.FalseBB = findFalseBlock(BBI.BB, BBI.TrueBB);
637 if (!BBI.FalseBB) {
638 // Malformed bcc? True and false blocks are the same?
639 BBI.IsUnpredicable = true;
640 return;
644 // Then scan all the instructions.
645 BBI.NonPredSize = 0;
646 BBI.ExtraCost = 0;
647 BBI.ExtraCost2 = 0;
648 BBI.ClobbersPred = false;
649 for (MachineBasicBlock::iterator I = BBI.BB->begin(), E = BBI.BB->end();
650 I != E; ++I) {
651 if (I->isDebugValue())
652 continue;
654 const MCInstrDesc &MCID = I->getDesc();
655 if (MCID.isNotDuplicable())
656 BBI.CannotBeCopied = true;
658 bool isPredicated = TII->isPredicated(I);
659 bool isCondBr = BBI.IsBrAnalyzable && MCID.isConditionalBranch();
661 if (!isCondBr) {
662 if (!isPredicated) {
663 BBI.NonPredSize++;
664 unsigned ExtraPredCost = 0;
665 unsigned NumCycles = TII->getInstrLatency(InstrItins, &*I,
666 &ExtraPredCost);
667 if (NumCycles > 1)
668 BBI.ExtraCost += NumCycles-1;
669 BBI.ExtraCost2 += ExtraPredCost;
670 } else if (!AlreadyPredicated) {
671 // FIXME: This instruction is already predicated before the
672 // if-conversion pass. It's probably something like a conditional move.
673 // Mark this block unpredicable for now.
674 BBI.IsUnpredicable = true;
675 return;
679 if (BBI.ClobbersPred && !isPredicated) {
680 // Predicate modification instruction should end the block (except for
681 // already predicated instructions and end of block branches).
682 if (isCondBr) {
683 // A conditional branch is not predicable, but it may be eliminated.
684 continue;
687 // Predicate may have been modified, the subsequent (currently)
688 // unpredicated instructions cannot be correctly predicated.
689 BBI.IsUnpredicable = true;
690 return;
693 // FIXME: Make use of PredDefs? e.g. ADDC, SUBC sets predicates but are
694 // still potentially predicable.
695 std::vector<MachineOperand> PredDefs;
696 if (TII->DefinesPredicate(I, PredDefs))
697 BBI.ClobbersPred = true;
699 if (!TII->isPredicable(I)) {
700 BBI.IsUnpredicable = true;
701 return;
706 /// FeasibilityAnalysis - Determine if the block is a suitable candidate to be
707 /// predicated by the specified predicate.
708 bool IfConverter::FeasibilityAnalysis(BBInfo &BBI,
709 SmallVectorImpl<MachineOperand> &Pred,
710 bool isTriangle, bool RevBranch) {
711 // If the block is dead or unpredicable, then it cannot be predicated.
712 if (BBI.IsDone || BBI.IsUnpredicable)
713 return false;
715 // If it is already predicated, check if its predicate subsumes the new
716 // predicate.
717 if (BBI.Predicate.size() && !TII->SubsumesPredicate(BBI.Predicate, Pred))
718 return false;
720 if (BBI.BrCond.size()) {
721 if (!isTriangle)
722 return false;
724 // Test predicate subsumption.
725 SmallVector<MachineOperand, 4> RevPred(Pred.begin(), Pred.end());
726 SmallVector<MachineOperand, 4> Cond(BBI.BrCond.begin(), BBI.BrCond.end());
727 if (RevBranch) {
728 if (TII->ReverseBranchCondition(Cond))
729 return false;
731 if (TII->ReverseBranchCondition(RevPred) ||
732 !TII->SubsumesPredicate(Cond, RevPred))
733 return false;
736 return true;
739 /// AnalyzeBlock - Analyze the structure of the sub-CFG starting from
740 /// the specified block. Record its successors and whether it looks like an
741 /// if-conversion candidate.
742 IfConverter::BBInfo &IfConverter::AnalyzeBlock(MachineBasicBlock *BB,
743 std::vector<IfcvtToken*> &Tokens) {
744 BBInfo &BBI = BBAnalysis[BB->getNumber()];
746 if (BBI.IsAnalyzed || BBI.IsBeingAnalyzed)
747 return BBI;
749 BBI.BB = BB;
750 BBI.IsBeingAnalyzed = true;
752 ScanInstructions(BBI);
754 // Unanalyzable or ends with fallthrough or unconditional branch, or if is not
755 // considered for ifcvt anymore.
756 if (!BBI.IsBrAnalyzable || BBI.BrCond.empty() || BBI.IsDone) {
757 BBI.IsBeingAnalyzed = false;
758 BBI.IsAnalyzed = true;
759 return BBI;
762 // Do not ifcvt if either path is a back edge to the entry block.
763 if (BBI.TrueBB == BB || BBI.FalseBB == BB) {
764 BBI.IsBeingAnalyzed = false;
765 BBI.IsAnalyzed = true;
766 return BBI;
769 // Do not ifcvt if true and false fallthrough blocks are the same.
770 if (!BBI.FalseBB) {
771 BBI.IsBeingAnalyzed = false;
772 BBI.IsAnalyzed = true;
773 return BBI;
776 BBInfo &TrueBBI = AnalyzeBlock(BBI.TrueBB, Tokens);
777 BBInfo &FalseBBI = AnalyzeBlock(BBI.FalseBB, Tokens);
779 if (TrueBBI.IsDone && FalseBBI.IsDone) {
780 BBI.IsBeingAnalyzed = false;
781 BBI.IsAnalyzed = true;
782 return BBI;
785 SmallVector<MachineOperand, 4> RevCond(BBI.BrCond.begin(), BBI.BrCond.end());
786 bool CanRevCond = !TII->ReverseBranchCondition(RevCond);
788 unsigned Dups = 0;
789 unsigned Dups2 = 0;
790 bool TNeedSub = TrueBBI.Predicate.size() > 0;
791 bool FNeedSub = FalseBBI.Predicate.size() > 0;
792 bool Enqueued = false;
794 // Try to predict the branch, using loop info to guide us.
795 // General heuristics are:
796 // - backedge -> 90% taken
797 // - early exit -> 20% taken
798 // - branch predictor confidence -> 90%
799 float Prediction = 0.5f;
800 float Confidence = 0.9f;
801 MachineLoop *Loop = MLI->getLoopFor(BB);
802 if (Loop) {
803 if (TrueBBI.BB == Loop->getHeader())
804 Prediction = 0.9f;
805 else if (FalseBBI.BB == Loop->getHeader())
806 Prediction = 0.1f;
808 MachineLoop *TrueLoop = MLI->getLoopFor(TrueBBI.BB);
809 MachineLoop *FalseLoop = MLI->getLoopFor(FalseBBI.BB);
810 if (!TrueLoop || TrueLoop->getParentLoop() == Loop)
811 Prediction = 0.2f;
812 else if (!FalseLoop || FalseLoop->getParentLoop() == Loop)
813 Prediction = 0.8f;
816 if (CanRevCond && ValidDiamond(TrueBBI, FalseBBI, Dups, Dups2) &&
817 MeetIfcvtSizeLimit(*TrueBBI.BB, (TrueBBI.NonPredSize - (Dups + Dups2) +
818 TrueBBI.ExtraCost), TrueBBI.ExtraCost2,
819 *FalseBBI.BB, (FalseBBI.NonPredSize - (Dups + Dups2) +
820 FalseBBI.ExtraCost),FalseBBI.ExtraCost2,
821 Prediction, Confidence) &&
822 FeasibilityAnalysis(TrueBBI, BBI.BrCond) &&
823 FeasibilityAnalysis(FalseBBI, RevCond)) {
824 // Diamond:
825 // EBB
826 // / \_
827 // | |
828 // TBB FBB
829 // \ /
830 // TailBB
831 // Note TailBB can be empty.
832 Tokens.push_back(new IfcvtToken(BBI, ICDiamond, TNeedSub|FNeedSub, Dups,
833 Dups2));
834 Enqueued = true;
837 if (ValidTriangle(TrueBBI, FalseBBI, false, Dups, Prediction, Confidence) &&
838 MeetIfcvtSizeLimit(*TrueBBI.BB, TrueBBI.NonPredSize + TrueBBI.ExtraCost,
839 TrueBBI.ExtraCost2, Prediction, Confidence) &&
840 FeasibilityAnalysis(TrueBBI, BBI.BrCond, true)) {
841 // Triangle:
842 // EBB
843 // | \_
844 // | |
845 // | TBB
846 // | /
847 // FBB
848 Tokens.push_back(new IfcvtToken(BBI, ICTriangle, TNeedSub, Dups));
849 Enqueued = true;
852 if (ValidTriangle(TrueBBI, FalseBBI, true, Dups, Prediction, Confidence) &&
853 MeetIfcvtSizeLimit(*TrueBBI.BB, TrueBBI.NonPredSize + TrueBBI.ExtraCost,
854 TrueBBI.ExtraCost2, Prediction, Confidence) &&
855 FeasibilityAnalysis(TrueBBI, BBI.BrCond, true, true)) {
856 Tokens.push_back(new IfcvtToken(BBI, ICTriangleRev, TNeedSub, Dups));
857 Enqueued = true;
860 if (ValidSimple(TrueBBI, Dups, Prediction, Confidence) &&
861 MeetIfcvtSizeLimit(*TrueBBI.BB, TrueBBI.NonPredSize + TrueBBI.ExtraCost,
862 TrueBBI.ExtraCost2, Prediction, Confidence) &&
863 FeasibilityAnalysis(TrueBBI, BBI.BrCond)) {
864 // Simple (split, no rejoin):
865 // EBB
866 // | \_
867 // | |
868 // | TBB---> exit
869 // |
870 // FBB
871 Tokens.push_back(new IfcvtToken(BBI, ICSimple, TNeedSub, Dups));
872 Enqueued = true;
875 if (CanRevCond) {
876 // Try the other path...
877 if (ValidTriangle(FalseBBI, TrueBBI, false, Dups,
878 1.0-Prediction, Confidence) &&
879 MeetIfcvtSizeLimit(*FalseBBI.BB,
880 FalseBBI.NonPredSize + FalseBBI.ExtraCost,
881 FalseBBI.ExtraCost2, 1.0-Prediction, Confidence) &&
882 FeasibilityAnalysis(FalseBBI, RevCond, true)) {
883 Tokens.push_back(new IfcvtToken(BBI, ICTriangleFalse, FNeedSub, Dups));
884 Enqueued = true;
887 if (ValidTriangle(FalseBBI, TrueBBI, true, Dups,
888 1.0-Prediction, Confidence) &&
889 MeetIfcvtSizeLimit(*FalseBBI.BB,
890 FalseBBI.NonPredSize + FalseBBI.ExtraCost,
891 FalseBBI.ExtraCost2, 1.0-Prediction, Confidence) &&
892 FeasibilityAnalysis(FalseBBI, RevCond, true, true)) {
893 Tokens.push_back(new IfcvtToken(BBI, ICTriangleFRev, FNeedSub, Dups));
894 Enqueued = true;
897 if (ValidSimple(FalseBBI, Dups, 1.0-Prediction, Confidence) &&
898 MeetIfcvtSizeLimit(*FalseBBI.BB,
899 FalseBBI.NonPredSize + FalseBBI.ExtraCost,
900 FalseBBI.ExtraCost2, 1.0-Prediction, Confidence) &&
901 FeasibilityAnalysis(FalseBBI, RevCond)) {
902 Tokens.push_back(new IfcvtToken(BBI, ICSimpleFalse, FNeedSub, Dups));
903 Enqueued = true;
907 BBI.IsEnqueued = Enqueued;
908 BBI.IsBeingAnalyzed = false;
909 BBI.IsAnalyzed = true;
910 return BBI;
913 /// AnalyzeBlocks - Analyze all blocks and find entries for all if-conversion
914 /// candidates.
915 void IfConverter::AnalyzeBlocks(MachineFunction &MF,
916 std::vector<IfcvtToken*> &Tokens) {
917 for (MachineFunction::iterator I = MF.begin(), E = MF.end(); I != E; ++I) {
918 MachineBasicBlock *BB = I;
919 AnalyzeBlock(BB, Tokens);
922 // Sort to favor more complex ifcvt scheme.
923 std::stable_sort(Tokens.begin(), Tokens.end(), IfcvtTokenCmp);
926 /// canFallThroughTo - Returns true either if ToBB is the next block after BB or
927 /// that all the intervening blocks are empty (given BB can fall through to its
928 /// next block).
929 static bool canFallThroughTo(MachineBasicBlock *BB, MachineBasicBlock *ToBB) {
930 MachineFunction::iterator PI = BB;
931 MachineFunction::iterator I = llvm::next(PI);
932 MachineFunction::iterator TI = ToBB;
933 MachineFunction::iterator E = BB->getParent()->end();
934 while (I != TI) {
935 // Check isSuccessor to avoid case where the next block is empty, but
936 // it's not a successor.
937 if (I == E || !I->empty() || !PI->isSuccessor(I))
938 return false;
939 PI = I++;
941 return true;
944 /// InvalidatePreds - Invalidate predecessor BB info so it would be re-analyzed
945 /// to determine if it can be if-converted. If predecessor is already enqueued,
946 /// dequeue it!
947 void IfConverter::InvalidatePreds(MachineBasicBlock *BB) {
948 for (MachineBasicBlock::pred_iterator PI = BB->pred_begin(),
949 E = BB->pred_end(); PI != E; ++PI) {
950 BBInfo &PBBI = BBAnalysis[(*PI)->getNumber()];
951 if (PBBI.IsDone || PBBI.BB == BB)
952 continue;
953 PBBI.IsAnalyzed = false;
954 PBBI.IsEnqueued = false;
958 /// InsertUncondBranch - Inserts an unconditional branch from BB to ToBB.
960 static void InsertUncondBranch(MachineBasicBlock *BB, MachineBasicBlock *ToBB,
961 const TargetInstrInfo *TII) {
962 DebugLoc dl; // FIXME: this is nowhere
963 SmallVector<MachineOperand, 0> NoCond;
964 TII->InsertBranch(*BB, ToBB, NULL, NoCond, dl);
967 /// RemoveExtraEdges - Remove true / false edges if either / both are no longer
968 /// successors.
969 void IfConverter::RemoveExtraEdges(BBInfo &BBI) {
970 MachineBasicBlock *TBB = NULL, *FBB = NULL;
971 SmallVector<MachineOperand, 4> Cond;
972 if (!TII->AnalyzeBranch(*BBI.BB, TBB, FBB, Cond))
973 BBI.BB->CorrectExtraCFGEdges(TBB, FBB, !Cond.empty());
976 /// InitPredRedefs / UpdatePredRedefs - Defs by predicated instructions are
977 /// modeled as read + write (sort like two-address instructions). These
978 /// routines track register liveness and add implicit uses to if-converted
979 /// instructions to conform to the model.
980 static void InitPredRedefs(MachineBasicBlock *BB, SmallSet<unsigned,4> &Redefs,
981 const TargetRegisterInfo *TRI) {
982 for (MachineBasicBlock::livein_iterator I = BB->livein_begin(),
983 E = BB->livein_end(); I != E; ++I) {
984 unsigned Reg = *I;
985 Redefs.insert(Reg);
986 for (const unsigned *Subreg = TRI->getSubRegisters(Reg);
987 *Subreg; ++Subreg)
988 Redefs.insert(*Subreg);
992 static void UpdatePredRedefs(MachineInstr *MI, SmallSet<unsigned,4> &Redefs,
993 const TargetRegisterInfo *TRI,
994 bool AddImpUse = false) {
995 SmallVector<unsigned, 4> Defs;
996 for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
997 const MachineOperand &MO = MI->getOperand(i);
998 if (!MO.isReg())
999 continue;
1000 unsigned Reg = MO.getReg();
1001 if (!Reg)
1002 continue;
1003 if (MO.isDef())
1004 Defs.push_back(Reg);
1005 else if (MO.isKill()) {
1006 Redefs.erase(Reg);
1007 for (const unsigned *SR = TRI->getSubRegisters(Reg); *SR; ++SR)
1008 Redefs.erase(*SR);
1011 for (unsigned i = 0, e = Defs.size(); i != e; ++i) {
1012 unsigned Reg = Defs[i];
1013 if (Redefs.count(Reg)) {
1014 if (AddImpUse)
1015 // Treat predicated update as read + write.
1016 MI->addOperand(MachineOperand::CreateReg(Reg, false/*IsDef*/,
1017 true/*IsImp*/,false/*IsKill*/));
1018 } else {
1019 Redefs.insert(Reg);
1020 for (const unsigned *SR = TRI->getSubRegisters(Reg); *SR; ++SR)
1021 Redefs.insert(*SR);
1026 static void UpdatePredRedefs(MachineBasicBlock::iterator I,
1027 MachineBasicBlock::iterator E,
1028 SmallSet<unsigned,4> &Redefs,
1029 const TargetRegisterInfo *TRI) {
1030 while (I != E) {
1031 UpdatePredRedefs(I, Redefs, TRI);
1032 ++I;
1036 /// IfConvertSimple - If convert a simple (split, no rejoin) sub-CFG.
1038 bool IfConverter::IfConvertSimple(BBInfo &BBI, IfcvtKind Kind) {
1039 BBInfo &TrueBBI = BBAnalysis[BBI.TrueBB->getNumber()];
1040 BBInfo &FalseBBI = BBAnalysis[BBI.FalseBB->getNumber()];
1041 BBInfo *CvtBBI = &TrueBBI;
1042 BBInfo *NextBBI = &FalseBBI;
1044 SmallVector<MachineOperand, 4> Cond(BBI.BrCond.begin(), BBI.BrCond.end());
1045 if (Kind == ICSimpleFalse)
1046 std::swap(CvtBBI, NextBBI);
1048 if (CvtBBI->IsDone ||
1049 (CvtBBI->CannotBeCopied && CvtBBI->BB->pred_size() > 1)) {
1050 // Something has changed. It's no longer safe to predicate this block.
1051 BBI.IsAnalyzed = false;
1052 CvtBBI->IsAnalyzed = false;
1053 return false;
1056 if (Kind == ICSimpleFalse)
1057 if (TII->ReverseBranchCondition(Cond))
1058 assert(false && "Unable to reverse branch condition!");
1060 // Initialize liveins to the first BB. These are potentiall redefined by
1061 // predicated instructions.
1062 SmallSet<unsigned, 4> Redefs;
1063 InitPredRedefs(CvtBBI->BB, Redefs, TRI);
1064 InitPredRedefs(NextBBI->BB, Redefs, TRI);
1066 if (CvtBBI->BB->pred_size() > 1) {
1067 BBI.NonPredSize -= TII->RemoveBranch(*BBI.BB);
1068 // Copy instructions in the true block, predicate them, and add them to
1069 // the entry block.
1070 CopyAndPredicateBlock(BBI, *CvtBBI, Cond, Redefs);
1071 } else {
1072 PredicateBlock(*CvtBBI, CvtBBI->BB->end(), Cond, Redefs);
1074 // Merge converted block into entry block.
1075 BBI.NonPredSize -= TII->RemoveBranch(*BBI.BB);
1076 MergeBlocks(BBI, *CvtBBI);
1079 bool IterIfcvt = true;
1080 if (!canFallThroughTo(BBI.BB, NextBBI->BB)) {
1081 InsertUncondBranch(BBI.BB, NextBBI->BB, TII);
1082 BBI.HasFallThrough = false;
1083 // Now ifcvt'd block will look like this:
1084 // BB:
1085 // ...
1086 // t, f = cmp
1087 // if t op
1088 // b BBf
1090 // We cannot further ifcvt this block because the unconditional branch
1091 // will have to be predicated on the new condition, that will not be
1092 // available if cmp executes.
1093 IterIfcvt = false;
1096 RemoveExtraEdges(BBI);
1098 // Update block info. BB can be iteratively if-converted.
1099 if (!IterIfcvt)
1100 BBI.IsDone = true;
1101 InvalidatePreds(BBI.BB);
1102 CvtBBI->IsDone = true;
1104 // FIXME: Must maintain LiveIns.
1105 return true;
1108 /// IfConvertTriangle - If convert a triangle sub-CFG.
1110 bool IfConverter::IfConvertTriangle(BBInfo &BBI, IfcvtKind Kind) {
1111 BBInfo &TrueBBI = BBAnalysis[BBI.TrueBB->getNumber()];
1112 BBInfo &FalseBBI = BBAnalysis[BBI.FalseBB->getNumber()];
1113 BBInfo *CvtBBI = &TrueBBI;
1114 BBInfo *NextBBI = &FalseBBI;
1115 DebugLoc dl; // FIXME: this is nowhere
1117 SmallVector<MachineOperand, 4> Cond(BBI.BrCond.begin(), BBI.BrCond.end());
1118 if (Kind == ICTriangleFalse || Kind == ICTriangleFRev)
1119 std::swap(CvtBBI, NextBBI);
1121 if (CvtBBI->IsDone ||
1122 (CvtBBI->CannotBeCopied && CvtBBI->BB->pred_size() > 1)) {
1123 // Something has changed. It's no longer safe to predicate this block.
1124 BBI.IsAnalyzed = false;
1125 CvtBBI->IsAnalyzed = false;
1126 return false;
1129 if (Kind == ICTriangleFalse || Kind == ICTriangleFRev)
1130 if (TII->ReverseBranchCondition(Cond))
1131 assert(false && "Unable to reverse branch condition!");
1133 if (Kind == ICTriangleRev || Kind == ICTriangleFRev) {
1134 if (ReverseBranchCondition(*CvtBBI)) {
1135 // BB has been changed, modify its predecessors (except for this
1136 // one) so they don't get ifcvt'ed based on bad intel.
1137 for (MachineBasicBlock::pred_iterator PI = CvtBBI->BB->pred_begin(),
1138 E = CvtBBI->BB->pred_end(); PI != E; ++PI) {
1139 MachineBasicBlock *PBB = *PI;
1140 if (PBB == BBI.BB)
1141 continue;
1142 BBInfo &PBBI = BBAnalysis[PBB->getNumber()];
1143 if (PBBI.IsEnqueued) {
1144 PBBI.IsAnalyzed = false;
1145 PBBI.IsEnqueued = false;
1151 // Initialize liveins to the first BB. These are potentially redefined by
1152 // predicated instructions.
1153 SmallSet<unsigned, 4> Redefs;
1154 InitPredRedefs(CvtBBI->BB, Redefs, TRI);
1155 InitPredRedefs(NextBBI->BB, Redefs, TRI);
1157 bool HasEarlyExit = CvtBBI->FalseBB != NULL;
1158 if (CvtBBI->BB->pred_size() > 1) {
1159 BBI.NonPredSize -= TII->RemoveBranch(*BBI.BB);
1160 // Copy instructions in the true block, predicate them, and add them to
1161 // the entry block.
1162 CopyAndPredicateBlock(BBI, *CvtBBI, Cond, Redefs, true);
1163 } else {
1164 // Predicate the 'true' block after removing its branch.
1165 CvtBBI->NonPredSize -= TII->RemoveBranch(*CvtBBI->BB);
1166 PredicateBlock(*CvtBBI, CvtBBI->BB->end(), Cond, Redefs);
1168 // Now merge the entry of the triangle with the true block.
1169 BBI.NonPredSize -= TII->RemoveBranch(*BBI.BB);
1170 MergeBlocks(BBI, *CvtBBI, false);
1173 // If 'true' block has a 'false' successor, add an exit branch to it.
1174 if (HasEarlyExit) {
1175 SmallVector<MachineOperand, 4> RevCond(CvtBBI->BrCond.begin(),
1176 CvtBBI->BrCond.end());
1177 if (TII->ReverseBranchCondition(RevCond))
1178 assert(false && "Unable to reverse branch condition!");
1179 TII->InsertBranch(*BBI.BB, CvtBBI->FalseBB, NULL, RevCond, dl);
1180 BBI.BB->addSuccessor(CvtBBI->FalseBB);
1183 // Merge in the 'false' block if the 'false' block has no other
1184 // predecessors. Otherwise, add an unconditional branch to 'false'.
1185 bool FalseBBDead = false;
1186 bool IterIfcvt = true;
1187 bool isFallThrough = canFallThroughTo(BBI.BB, NextBBI->BB);
1188 if (!isFallThrough) {
1189 // Only merge them if the true block does not fallthrough to the false
1190 // block. By not merging them, we make it possible to iteratively
1191 // ifcvt the blocks.
1192 if (!HasEarlyExit &&
1193 NextBBI->BB->pred_size() == 1 && !NextBBI->HasFallThrough) {
1194 MergeBlocks(BBI, *NextBBI);
1195 FalseBBDead = true;
1196 } else {
1197 InsertUncondBranch(BBI.BB, NextBBI->BB, TII);
1198 BBI.HasFallThrough = false;
1200 // Mixed predicated and unpredicated code. This cannot be iteratively
1201 // predicated.
1202 IterIfcvt = false;
1205 RemoveExtraEdges(BBI);
1207 // Update block info. BB can be iteratively if-converted.
1208 if (!IterIfcvt)
1209 BBI.IsDone = true;
1210 InvalidatePreds(BBI.BB);
1211 CvtBBI->IsDone = true;
1212 if (FalseBBDead)
1213 NextBBI->IsDone = true;
1215 // FIXME: Must maintain LiveIns.
1216 return true;
1219 /// IfConvertDiamond - If convert a diamond sub-CFG.
1221 bool IfConverter::IfConvertDiamond(BBInfo &BBI, IfcvtKind Kind,
1222 unsigned NumDups1, unsigned NumDups2) {
1223 BBInfo &TrueBBI = BBAnalysis[BBI.TrueBB->getNumber()];
1224 BBInfo &FalseBBI = BBAnalysis[BBI.FalseBB->getNumber()];
1225 MachineBasicBlock *TailBB = TrueBBI.TrueBB;
1226 // True block must fall through or end with an unanalyzable terminator.
1227 if (!TailBB) {
1228 if (blockAlwaysFallThrough(TrueBBI))
1229 TailBB = FalseBBI.TrueBB;
1230 assert((TailBB || !TrueBBI.IsBrAnalyzable) && "Unexpected!");
1233 if (TrueBBI.IsDone || FalseBBI.IsDone ||
1234 TrueBBI.BB->pred_size() > 1 ||
1235 FalseBBI.BB->pred_size() > 1) {
1236 // Something has changed. It's no longer safe to predicate these blocks.
1237 BBI.IsAnalyzed = false;
1238 TrueBBI.IsAnalyzed = false;
1239 FalseBBI.IsAnalyzed = false;
1240 return false;
1243 // Put the predicated instructions from the 'true' block before the
1244 // instructions from the 'false' block, unless the true block would clobber
1245 // the predicate, in which case, do the opposite.
1246 BBInfo *BBI1 = &TrueBBI;
1247 BBInfo *BBI2 = &FalseBBI;
1248 SmallVector<MachineOperand, 4> RevCond(BBI.BrCond.begin(), BBI.BrCond.end());
1249 if (TII->ReverseBranchCondition(RevCond))
1250 assert(false && "Unable to reverse branch condition!");
1251 SmallVector<MachineOperand, 4> *Cond1 = &BBI.BrCond;
1252 SmallVector<MachineOperand, 4> *Cond2 = &RevCond;
1254 // Figure out the more profitable ordering.
1255 bool DoSwap = false;
1256 if (TrueBBI.ClobbersPred && !FalseBBI.ClobbersPred)
1257 DoSwap = true;
1258 else if (TrueBBI.ClobbersPred == FalseBBI.ClobbersPred) {
1259 if (TrueBBI.NonPredSize > FalseBBI.NonPredSize)
1260 DoSwap = true;
1262 if (DoSwap) {
1263 std::swap(BBI1, BBI2);
1264 std::swap(Cond1, Cond2);
1267 // Remove the conditional branch from entry to the blocks.
1268 BBI.NonPredSize -= TII->RemoveBranch(*BBI.BB);
1270 // Initialize liveins to the first BB. These are potentially redefined by
1271 // predicated instructions.
1272 SmallSet<unsigned, 4> Redefs;
1273 InitPredRedefs(BBI1->BB, Redefs, TRI);
1275 // Remove the duplicated instructions at the beginnings of both paths.
1276 MachineBasicBlock::iterator DI1 = BBI1->BB->begin();
1277 MachineBasicBlock::iterator DI2 = BBI2->BB->begin();
1278 MachineBasicBlock::iterator DIE1 = BBI1->BB->end();
1279 MachineBasicBlock::iterator DIE2 = BBI2->BB->end();
1280 // Skip dbg_value instructions
1281 while (DI1 != DIE1 && DI1->isDebugValue())
1282 ++DI1;
1283 while (DI2 != DIE2 && DI2->isDebugValue())
1284 ++DI2;
1285 BBI1->NonPredSize -= NumDups1;
1286 BBI2->NonPredSize -= NumDups1;
1288 // Skip past the dups on each side separately since there may be
1289 // differing dbg_value entries.
1290 for (unsigned i = 0; i < NumDups1; ++DI1) {
1291 if (!DI1->isDebugValue())
1292 ++i;
1294 while (NumDups1 != 0) {
1295 ++DI2;
1296 if (!DI2->isDebugValue())
1297 --NumDups1;
1300 UpdatePredRedefs(BBI1->BB->begin(), DI1, Redefs, TRI);
1301 BBI.BB->splice(BBI.BB->end(), BBI1->BB, BBI1->BB->begin(), DI1);
1302 BBI2->BB->erase(BBI2->BB->begin(), DI2);
1304 // Predicate the 'true' block after removing its branch.
1305 BBI1->NonPredSize -= TII->RemoveBranch(*BBI1->BB);
1306 DI1 = BBI1->BB->end();
1307 for (unsigned i = 0; i != NumDups2; ) {
1308 // NumDups2 only counted non-dbg_value instructions, so this won't
1309 // run off the head of the list.
1310 assert (DI1 != BBI1->BB->begin());
1311 --DI1;
1312 // skip dbg_value instructions
1313 if (!DI1->isDebugValue())
1314 ++i;
1316 BBI1->BB->erase(DI1, BBI1->BB->end());
1317 PredicateBlock(*BBI1, BBI1->BB->end(), *Cond1, Redefs);
1319 // Predicate the 'false' block.
1320 BBI2->NonPredSize -= TII->RemoveBranch(*BBI2->BB);
1321 DI2 = BBI2->BB->end();
1322 while (NumDups2 != 0) {
1323 // NumDups2 only counted non-dbg_value instructions, so this won't
1324 // run off the head of the list.
1325 assert (DI2 != BBI2->BB->begin());
1326 --DI2;
1327 // skip dbg_value instructions
1328 if (!DI2->isDebugValue())
1329 --NumDups2;
1331 PredicateBlock(*BBI2, DI2, *Cond2, Redefs);
1333 // Merge the true block into the entry of the diamond.
1334 MergeBlocks(BBI, *BBI1, TailBB == 0);
1335 MergeBlocks(BBI, *BBI2, TailBB == 0);
1337 // If the if-converted block falls through or unconditionally branches into
1338 // the tail block, and the tail block does not have other predecessors, then
1339 // fold the tail block in as well. Otherwise, unless it falls through to the
1340 // tail, add a unconditional branch to it.
1341 if (TailBB) {
1342 BBInfo TailBBI = BBAnalysis[TailBB->getNumber()];
1343 bool CanMergeTail = !TailBBI.HasFallThrough;
1344 // There may still be a fall-through edge from BBI1 or BBI2 to TailBB;
1345 // check if there are any other predecessors besides those.
1346 unsigned NumPreds = TailBB->pred_size();
1347 if (NumPreds > 1)
1348 CanMergeTail = false;
1349 else if (NumPreds == 1 && CanMergeTail) {
1350 MachineBasicBlock::pred_iterator PI = TailBB->pred_begin();
1351 if (*PI != BBI1->BB && *PI != BBI2->BB)
1352 CanMergeTail = false;
1354 if (CanMergeTail) {
1355 MergeBlocks(BBI, TailBBI);
1356 TailBBI.IsDone = true;
1357 } else {
1358 BBI.BB->addSuccessor(TailBB);
1359 InsertUncondBranch(BBI.BB, TailBB, TII);
1360 BBI.HasFallThrough = false;
1364 // RemoveExtraEdges won't work if the block has an unanalyzable branch,
1365 // which can happen here if TailBB is unanalyzable and is merged, so
1366 // explicitly remove BBI1 and BBI2 as successors.
1367 BBI.BB->removeSuccessor(BBI1->BB);
1368 BBI.BB->removeSuccessor(BBI2->BB);
1369 RemoveExtraEdges(BBI);
1371 // Update block info.
1372 BBI.IsDone = TrueBBI.IsDone = FalseBBI.IsDone = true;
1373 InvalidatePreds(BBI.BB);
1375 // FIXME: Must maintain LiveIns.
1376 return true;
1379 /// PredicateBlock - Predicate instructions from the start of the block to the
1380 /// specified end with the specified condition.
1381 void IfConverter::PredicateBlock(BBInfo &BBI,
1382 MachineBasicBlock::iterator E,
1383 SmallVectorImpl<MachineOperand> &Cond,
1384 SmallSet<unsigned, 4> &Redefs) {
1385 for (MachineBasicBlock::iterator I = BBI.BB->begin(); I != E; ++I) {
1386 if (I->isDebugValue() || TII->isPredicated(I))
1387 continue;
1388 if (!TII->PredicateInstruction(I, Cond)) {
1389 #ifndef NDEBUG
1390 dbgs() << "Unable to predicate " << *I << "!\n";
1391 #endif
1392 llvm_unreachable(0);
1395 // If the predicated instruction now redefines a register as the result of
1396 // if-conversion, add an implicit kill.
1397 UpdatePredRedefs(I, Redefs, TRI, true);
1400 std::copy(Cond.begin(), Cond.end(), std::back_inserter(BBI.Predicate));
1402 BBI.IsAnalyzed = false;
1403 BBI.NonPredSize = 0;
1405 ++NumIfConvBBs;
1408 /// CopyAndPredicateBlock - Copy and predicate instructions from source BB to
1409 /// the destination block. Skip end of block branches if IgnoreBr is true.
1410 void IfConverter::CopyAndPredicateBlock(BBInfo &ToBBI, BBInfo &FromBBI,
1411 SmallVectorImpl<MachineOperand> &Cond,
1412 SmallSet<unsigned, 4> &Redefs,
1413 bool IgnoreBr) {
1414 MachineFunction &MF = *ToBBI.BB->getParent();
1416 for (MachineBasicBlock::iterator I = FromBBI.BB->begin(),
1417 E = FromBBI.BB->end(); I != E; ++I) {
1418 const MCInstrDesc &MCID = I->getDesc();
1419 // Do not copy the end of the block branches.
1420 if (IgnoreBr && MCID.isBranch())
1421 break;
1423 MachineInstr *MI = MF.CloneMachineInstr(I);
1424 ToBBI.BB->insert(ToBBI.BB->end(), MI);
1425 ToBBI.NonPredSize++;
1426 unsigned ExtraPredCost = 0;
1427 unsigned NumCycles = TII->getInstrLatency(InstrItins, &*I, &ExtraPredCost);
1428 if (NumCycles > 1)
1429 ToBBI.ExtraCost += NumCycles-1;
1430 ToBBI.ExtraCost2 += ExtraPredCost;
1432 if (!TII->isPredicated(I) && !MI->isDebugValue()) {
1433 if (!TII->PredicateInstruction(MI, Cond)) {
1434 #ifndef NDEBUG
1435 dbgs() << "Unable to predicate " << *I << "!\n";
1436 #endif
1437 llvm_unreachable(0);
1441 // If the predicated instruction now redefines a register as the result of
1442 // if-conversion, add an implicit kill.
1443 UpdatePredRedefs(MI, Redefs, TRI, true);
1446 if (!IgnoreBr) {
1447 std::vector<MachineBasicBlock *> Succs(FromBBI.BB->succ_begin(),
1448 FromBBI.BB->succ_end());
1449 MachineBasicBlock *NBB = getNextBlock(FromBBI.BB);
1450 MachineBasicBlock *FallThrough = FromBBI.HasFallThrough ? NBB : NULL;
1452 for (unsigned i = 0, e = Succs.size(); i != e; ++i) {
1453 MachineBasicBlock *Succ = Succs[i];
1454 // Fallthrough edge can't be transferred.
1455 if (Succ == FallThrough)
1456 continue;
1457 ToBBI.BB->addSuccessor(Succ);
1461 std::copy(FromBBI.Predicate.begin(), FromBBI.Predicate.end(),
1462 std::back_inserter(ToBBI.Predicate));
1463 std::copy(Cond.begin(), Cond.end(), std::back_inserter(ToBBI.Predicate));
1465 ToBBI.ClobbersPred |= FromBBI.ClobbersPred;
1466 ToBBI.IsAnalyzed = false;
1468 ++NumDupBBs;
1471 /// MergeBlocks - Move all instructions from FromBB to the end of ToBB.
1472 /// This will leave FromBB as an empty block, so remove all of its
1473 /// successor edges except for the fall-through edge. If AddEdges is true,
1474 /// i.e., when FromBBI's branch is being moved, add those successor edges to
1475 /// ToBBI.
1476 void IfConverter::MergeBlocks(BBInfo &ToBBI, BBInfo &FromBBI, bool AddEdges) {
1477 ToBBI.BB->splice(ToBBI.BB->end(),
1478 FromBBI.BB, FromBBI.BB->begin(), FromBBI.BB->end());
1480 std::vector<MachineBasicBlock *> Succs(FromBBI.BB->succ_begin(),
1481 FromBBI.BB->succ_end());
1482 MachineBasicBlock *NBB = getNextBlock(FromBBI.BB);
1483 MachineBasicBlock *FallThrough = FromBBI.HasFallThrough ? NBB : NULL;
1485 for (unsigned i = 0, e = Succs.size(); i != e; ++i) {
1486 MachineBasicBlock *Succ = Succs[i];
1487 // Fallthrough edge can't be transferred.
1488 if (Succ == FallThrough)
1489 continue;
1490 FromBBI.BB->removeSuccessor(Succ);
1491 if (AddEdges)
1492 ToBBI.BB->addSuccessor(Succ);
1495 // Now FromBBI always falls through to the next block!
1496 if (NBB && !FromBBI.BB->isSuccessor(NBB))
1497 FromBBI.BB->addSuccessor(NBB);
1499 std::copy(FromBBI.Predicate.begin(), FromBBI.Predicate.end(),
1500 std::back_inserter(ToBBI.Predicate));
1501 FromBBI.Predicate.clear();
1503 ToBBI.NonPredSize += FromBBI.NonPredSize;
1504 ToBBI.ExtraCost += FromBBI.ExtraCost;
1505 ToBBI.ExtraCost2 += FromBBI.ExtraCost2;
1506 FromBBI.NonPredSize = 0;
1507 FromBBI.ExtraCost = 0;
1508 FromBBI.ExtraCost2 = 0;
1510 ToBBI.ClobbersPred |= FromBBI.ClobbersPred;
1511 ToBBI.HasFallThrough = FromBBI.HasFallThrough;
1512 ToBBI.IsAnalyzed = false;
1513 FromBBI.IsAnalyzed = false;