Fix for PR4124. Make TwoAddressFormPass::FindLastUseInMBB return the real last use.
[oota-llvm.git] / lib / CodeGen / IfConversion.cpp
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.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #define DEBUG_TYPE "ifcvt"
15 #include "llvm/Function.h"
16 #include "llvm/CodeGen/Passes.h"
17 #include "llvm/CodeGen/MachineModuleInfo.h"
18 #include "llvm/CodeGen/MachineFunctionPass.h"
19 #include "llvm/Target/TargetInstrInfo.h"
20 #include "llvm/Target/TargetLowering.h"
21 #include "llvm/Target/TargetMachine.h"
22 #include "llvm/Support/CommandLine.h"
23 #include "llvm/Support/Debug.h"
24 #include "llvm/ADT/DepthFirstIterator.h"
25 #include "llvm/ADT/Statistic.h"
26 #include "llvm/ADT/STLExtras.h"
27 using namespace llvm;
28
29 // Hidden options for help debugging.
30 static cl::opt<int> IfCvtFnStart("ifcvt-fn-start", cl::init(-1), cl::Hidden);
31 static cl::opt<int> IfCvtFnStop("ifcvt-fn-stop", cl::init(-1), cl::Hidden);
32 static cl::opt<int> IfCvtLimit("ifcvt-limit", cl::init(-1), cl::Hidden);
33 static cl::opt<bool> DisableSimple("disable-ifcvt-simple", 
34                                    cl::init(false), cl::Hidden);
35 static cl::opt<bool> DisableSimpleF("disable-ifcvt-simple-false", 
36                                     cl::init(false), cl::Hidden);
37 static cl::opt<bool> DisableTriangle("disable-ifcvt-triangle", 
38                                      cl::init(false), cl::Hidden);
39 static cl::opt<bool> DisableTriangleR("disable-ifcvt-triangle-rev", 
40                                       cl::init(false), cl::Hidden);
41 static cl::opt<bool> DisableTriangleF("disable-ifcvt-triangle-false", 
42                                       cl::init(false), cl::Hidden);
43 static cl::opt<bool> DisableTriangleFR("disable-ifcvt-triangle-false-rev", 
44                                        cl::init(false), cl::Hidden);
45 static cl::opt<bool> DisableDiamond("disable-ifcvt-diamond", 
46                                     cl::init(false), cl::Hidden);
47
48 STATISTIC(NumSimple,       "Number of simple if-conversions performed");
49 STATISTIC(NumSimpleFalse,  "Number of simple (F) if-conversions performed");
50 STATISTIC(NumTriangle,     "Number of triangle if-conversions performed");
51 STATISTIC(NumTriangleRev,  "Number of triangle (R) if-conversions performed");
52 STATISTIC(NumTriangleFalse,"Number of triangle (F) if-conversions performed");
53 STATISTIC(NumTriangleFRev, "Number of triangle (F/R) if-conversions performed");
54 STATISTIC(NumDiamonds,     "Number of diamond if-conversions performed");
55 STATISTIC(NumIfConvBBs,    "Number of if-converted blocks");
56 STATISTIC(NumDupBBs,       "Number of duplicated blocks");
57
58 namespace {
59   class VISIBILITY_HIDDEN IfConverter : public MachineFunctionPass {
60     enum IfcvtKind {
61       ICNotClassfied,  // BB data valid, but not classified.
62       ICSimpleFalse,   // Same as ICSimple, but on the false path.
63       ICSimple,        // BB is entry of an one split, no rejoin sub-CFG.
64       ICTriangleFRev,  // Same as ICTriangleFalse, but false path rev condition.
65       ICTriangleRev,   // Same as ICTriangle, but true path rev condition.
66       ICTriangleFalse, // Same as ICTriangle, but on the false path.
67       ICTriangle,      // BB is entry of a triangle sub-CFG.
68       ICDiamond        // BB is entry of a diamond sub-CFG.
69     };
70
71     /// BBInfo - One per MachineBasicBlock, this is used to cache the result
72     /// if-conversion feasibility analysis. This includes results from
73     /// TargetInstrInfo::AnalyzeBranch() (i.e. TBB, FBB, and Cond), and its
74     /// classification, and common tail block of its successors (if it's a
75     /// diamond shape), its size, whether it's predicable, and whether any
76     /// instruction can clobber the 'would-be' predicate.
77     ///
78     /// IsDone          - True if BB is not to be considered for ifcvt.
79     /// IsBeingAnalyzed - True if BB is currently being analyzed.
80     /// IsAnalyzed      - True if BB has been analyzed (info is still valid).
81     /// IsEnqueued      - True if BB has been enqueued to be ifcvt'ed.
82     /// IsBrAnalyzable  - True if AnalyzeBranch() returns false.
83     /// HasFallThrough  - True if BB may fallthrough to the following BB.
84     /// IsUnpredicable  - True if BB is known to be unpredicable.
85     /// ClobbersPred    - True if BB could modify predicates (e.g. has
86     ///                   cmp, call, etc.)
87     /// NonPredSize     - Number of non-predicated instructions.
88     /// BB              - Corresponding MachineBasicBlock.
89     /// TrueBB / FalseBB- See AnalyzeBranch().
90     /// BrCond          - Conditions for end of block conditional branches.
91     /// Predicate       - Predicate used in the BB.
92     struct BBInfo {
93       bool IsDone          : 1;
94       bool IsBeingAnalyzed : 1;
95       bool IsAnalyzed      : 1;
96       bool IsEnqueued      : 1;
97       bool IsBrAnalyzable  : 1;
98       bool HasFallThrough  : 1;
99       bool IsUnpredicable  : 1;
100       bool CannotBeCopied  : 1;
101       bool ClobbersPred    : 1;
102       unsigned NonPredSize;
103       MachineBasicBlock *BB;
104       MachineBasicBlock *TrueBB;
105       MachineBasicBlock *FalseBB;
106       SmallVector<MachineOperand, 4> BrCond;
107       SmallVector<MachineOperand, 4> Predicate;
108       BBInfo() : IsDone(false), IsBeingAnalyzed(false),
109                  IsAnalyzed(false), IsEnqueued(false), IsBrAnalyzable(false),
110                  HasFallThrough(false), IsUnpredicable(false),
111                  CannotBeCopied(false), ClobbersPred(false), NonPredSize(0),
112                  BB(0), TrueBB(0), FalseBB(0) {}
113     };
114
115     /// IfcvtToken - Record information about pending if-conversions to attemp:
116     /// BBI             - Corresponding BBInfo.
117     /// Kind            - Type of block. See IfcvtKind.
118     /// NeedSubsumption - True if the to-be-predicated BB has already been
119     ///                   predicated.
120     /// NumDups      - Number of instructions that would be duplicated due
121     ///                   to this if-conversion. (For diamonds, the number of
122     ///                   identical instructions at the beginnings of both
123     ///                   paths).
124     /// NumDups2     - For diamonds, the number of identical instructions
125     ///                   at the ends of both paths.
126     struct IfcvtToken {
127       BBInfo &BBI;
128       IfcvtKind Kind;
129       bool NeedSubsumption;
130       unsigned NumDups;
131       unsigned NumDups2;
132       IfcvtToken(BBInfo &b, IfcvtKind k, bool s, unsigned d, unsigned d2 = 0)
133         : BBI(b), Kind(k), NeedSubsumption(s), NumDups(d), NumDups2(d2) {}
134     };
135
136     /// Roots - Basic blocks that do not have successors. These are the starting
137     /// points of Graph traversal.
138     std::vector<MachineBasicBlock*> Roots;
139
140     /// BBAnalysis - Results of if-conversion feasibility analysis indexed by
141     /// basic block number.
142     std::vector<BBInfo> BBAnalysis;
143
144     const TargetLowering *TLI;
145     const TargetInstrInfo *TII;
146     bool MadeChange;
147   public:
148     static char ID;
149     IfConverter() : MachineFunctionPass(&ID) {}
150
151     virtual bool runOnMachineFunction(MachineFunction &MF);
152     virtual const char *getPassName() const { return "If Converter"; }
153
154   private:
155     bool ReverseBranchCondition(BBInfo &BBI);
156     bool ValidSimple(BBInfo &TrueBBI, unsigned &Dups) const;
157     bool ValidTriangle(BBInfo &TrueBBI, BBInfo &FalseBBI,
158                        bool FalseBranch, unsigned &Dups) const;
159     bool ValidDiamond(BBInfo &TrueBBI, BBInfo &FalseBBI,
160                       unsigned &Dups1, unsigned &Dups2) const;
161     void ScanInstructions(BBInfo &BBI);
162     BBInfo &AnalyzeBlock(MachineBasicBlock *BB,
163                          std::vector<IfcvtToken*> &Tokens);
164     bool FeasibilityAnalysis(BBInfo &BBI, SmallVectorImpl<MachineOperand> &Cond,
165                              bool isTriangle = false, bool RevBranch = false);
166     bool AnalyzeBlocks(MachineFunction &MF,
167                        std::vector<IfcvtToken*> &Tokens);
168     void InvalidatePreds(MachineBasicBlock *BB);
169     void RemoveExtraEdges(BBInfo &BBI);
170     bool IfConvertSimple(BBInfo &BBI, IfcvtKind Kind);
171     bool IfConvertTriangle(BBInfo &BBI, IfcvtKind Kind);
172     bool IfConvertDiamond(BBInfo &BBI, IfcvtKind Kind,
173                           unsigned NumDups1, unsigned NumDups2);
174     void PredicateBlock(BBInfo &BBI,
175                         MachineBasicBlock::iterator E,
176                         SmallVectorImpl<MachineOperand> &Cond);
177     void CopyAndPredicateBlock(BBInfo &ToBBI, BBInfo &FromBBI,
178                                SmallVectorImpl<MachineOperand> &Cond,
179                                bool IgnoreBr = false);
180     void MergeBlocks(BBInfo &ToBBI, BBInfo &FromBBI);
181
182     bool MeetIfcvtSizeLimit(unsigned Size) const {
183       return Size > 0 && Size <= TLI->getIfCvtBlockSizeLimit();
184     }
185
186     // blockAlwaysFallThrough - Block ends without a terminator.
187     bool blockAlwaysFallThrough(BBInfo &BBI) const {
188       return BBI.IsBrAnalyzable && BBI.TrueBB == NULL;
189     }
190
191     // IfcvtTokenCmp - Used to sort if-conversion candidates.
192     static bool IfcvtTokenCmp(IfcvtToken *C1, IfcvtToken *C2) {
193       int Incr1 = (C1->Kind == ICDiamond)
194         ? -(int)(C1->NumDups + C1->NumDups2) : (int)C1->NumDups;
195       int Incr2 = (C2->Kind == ICDiamond)
196         ? -(int)(C2->NumDups + C2->NumDups2) : (int)C2->NumDups;
197       if (Incr1 > Incr2)
198         return true;
199       else if (Incr1 == Incr2) {
200         // Favors subsumption.
201         if (C1->NeedSubsumption == false && C2->NeedSubsumption == true)
202           return true;
203         else if (C1->NeedSubsumption == C2->NeedSubsumption) {
204           // Favors diamond over triangle, etc.
205           if ((unsigned)C1->Kind < (unsigned)C2->Kind)
206             return true;
207           else if (C1->Kind == C2->Kind)
208             return C1->BBI.BB->getNumber() < C2->BBI.BB->getNumber();
209         }
210       }
211       return false;
212     }
213   };
214
215   char IfConverter::ID = 0;
216 }
217
218 static RegisterPass<IfConverter>
219 X("if-converter", "If Converter");
220
221 FunctionPass *llvm::createIfConverterPass() { return new IfConverter(); }
222
223 bool IfConverter::runOnMachineFunction(MachineFunction &MF) {
224   TLI = MF.getTarget().getTargetLowering();
225   TII = MF.getTarget().getInstrInfo();
226   if (!TII) return false;
227
228   static int FnNum = -1;
229   DOUT << "\nIfcvt: function (" << ++FnNum <<  ") \'"
230        << MF.getFunction()->getName() << "\'";
231
232   if (FnNum < IfCvtFnStart || (IfCvtFnStop != -1 && FnNum > IfCvtFnStop)) {
233     DOUT << " skipped\n";
234     return false;
235   }
236   DOUT << "\n";
237
238   MF.RenumberBlocks();
239   BBAnalysis.resize(MF.getNumBlockIDs());
240
241   // Look for root nodes, i.e. blocks without successors.
242   for (MachineFunction::iterator I = MF.begin(), E = MF.end(); I != E; ++I)
243     if (I->succ_empty())
244       Roots.push_back(I);
245
246   std::vector<IfcvtToken*> Tokens;
247   MadeChange = false;
248   unsigned NumIfCvts = NumSimple + NumSimpleFalse + NumTriangle +
249     NumTriangleRev + NumTriangleFalse + NumTriangleFRev + NumDiamonds;
250   while (IfCvtLimit == -1 || (int)NumIfCvts < IfCvtLimit) {
251     // Do an initial analysis for each basic block and find all the potential
252     // candidates to perform if-conversion.
253     bool Change = AnalyzeBlocks(MF, Tokens);
254     while (!Tokens.empty()) {
255       IfcvtToken *Token = Tokens.back();
256       Tokens.pop_back();
257       BBInfo &BBI = Token->BBI;
258       IfcvtKind Kind = Token->Kind;
259       unsigned NumDups = Token->NumDups;
260       unsigned NumDups2 = Token->NumDups2;
261
262       delete Token;
263
264       // If the block has been evicted out of the queue or it has already been
265       // marked dead (due to it being predicated), then skip it.
266       if (BBI.IsDone)
267         BBI.IsEnqueued = false;
268       if (!BBI.IsEnqueued)
269         continue;
270
271       BBI.IsEnqueued = false;
272
273       bool RetVal = false;
274       switch (Kind) {
275       default: assert(false && "Unexpected!");
276         break;
277       case ICSimple:
278       case ICSimpleFalse: {
279         bool isFalse = Kind == ICSimpleFalse;
280         if ((isFalse && DisableSimpleF) || (!isFalse && DisableSimple)) break;
281         DOUT << "Ifcvt (Simple" << (Kind == ICSimpleFalse ? " false" :"")
282              << "): BB#" << BBI.BB->getNumber() << " ("
283              << ((Kind == ICSimpleFalse)
284                  ? BBI.FalseBB->getNumber()
285                  : BBI.TrueBB->getNumber()) << ") ";
286         RetVal = IfConvertSimple(BBI, Kind);
287         DOUT << (RetVal ? "succeeded!" : "failed!") << "\n";
288         if (RetVal) {
289           if (isFalse) NumSimpleFalse++;
290           else         NumSimple++;
291         }
292        break;
293       }
294       case ICTriangle:
295       case ICTriangleRev:
296       case ICTriangleFalse:
297       case ICTriangleFRev: {
298         bool isFalse = Kind == ICTriangleFalse;
299         bool isRev   = (Kind == ICTriangleRev || Kind == ICTriangleFRev);
300         if (DisableTriangle && !isFalse && !isRev) break;
301         if (DisableTriangleR && !isFalse && isRev) break;
302         if (DisableTriangleF && isFalse && !isRev) break;
303         if (DisableTriangleFR && isFalse && isRev) break;
304         DOUT << "Ifcvt (Triangle";
305         if (isFalse)
306           DOUT << " false";
307         if (isRev)
308           DOUT << " rev";
309         DOUT << "): BB#" << BBI.BB->getNumber() << " (T:"
310              << BBI.TrueBB->getNumber() << ",F:"
311              << BBI.FalseBB->getNumber() << ") ";
312         RetVal = IfConvertTriangle(BBI, Kind);
313         DOUT << (RetVal ? "succeeded!" : "failed!") << "\n";
314         if (RetVal) {
315           if (isFalse) {
316             if (isRev) NumTriangleFRev++;
317             else       NumTriangleFalse++;
318           } else {
319             if (isRev) NumTriangleRev++;
320             else       NumTriangle++;
321           }
322         }
323         break;
324       }
325       case ICDiamond: {
326         if (DisableDiamond) break;
327         DOUT << "Ifcvt (Diamond): BB#" << BBI.BB->getNumber() << " (T:"
328              << BBI.TrueBB->getNumber() << ",F:"
329              << BBI.FalseBB->getNumber() << ") ";
330         RetVal = IfConvertDiamond(BBI, Kind, NumDups, NumDups2);
331         DOUT << (RetVal ? "succeeded!" : "failed!") << "\n";
332         if (RetVal) NumDiamonds++;
333         break;
334       }
335       }
336
337       Change |= RetVal;
338
339       NumIfCvts = NumSimple + NumSimpleFalse + NumTriangle + NumTriangleRev +
340         NumTriangleFalse + NumTriangleFRev + NumDiamonds;
341       if (IfCvtLimit != -1 && (int)NumIfCvts >= IfCvtLimit)
342         break;
343     }
344
345     if (!Change)
346       break;
347     MadeChange |= Change;
348   }
349
350   // Delete tokens in case of early exit.
351   while (!Tokens.empty()) {
352     IfcvtToken *Token = Tokens.back();
353     Tokens.pop_back();
354     delete Token;
355   }
356
357   Tokens.clear();
358   Roots.clear();
359   BBAnalysis.clear();
360
361   return MadeChange;
362 }
363
364 /// findFalseBlock - BB has a fallthrough. Find its 'false' successor given
365 /// its 'true' successor.
366 static MachineBasicBlock *findFalseBlock(MachineBasicBlock *BB,
367                                          MachineBasicBlock *TrueBB) {
368   for (MachineBasicBlock::succ_iterator SI = BB->succ_begin(),
369          E = BB->succ_end(); SI != E; ++SI) {
370     MachineBasicBlock *SuccBB = *SI;
371     if (SuccBB != TrueBB)
372       return SuccBB;
373   }
374   return NULL;
375 }
376
377 /// ReverseBranchCondition - Reverse the condition of the end of the block
378 /// branch. Swap block's 'true' and 'false' successors.
379 bool IfConverter::ReverseBranchCondition(BBInfo &BBI) {
380   if (!TII->ReverseBranchCondition(BBI.BrCond)) {
381     TII->RemoveBranch(*BBI.BB);
382     TII->InsertBranch(*BBI.BB, BBI.FalseBB, BBI.TrueBB, BBI.BrCond);
383     std::swap(BBI.TrueBB, BBI.FalseBB);
384     return true;
385   }
386   return false;
387 }
388
389 /// getNextBlock - Returns the next block in the function blocks ordering. If
390 /// it is the end, returns NULL.
391 static inline MachineBasicBlock *getNextBlock(MachineBasicBlock *BB) {
392   MachineFunction::iterator I = BB;
393   MachineFunction::iterator E = BB->getParent()->end();
394   if (++I == E)
395     return NULL;
396   return I;
397 }
398
399 /// ValidSimple - Returns true if the 'true' block (along with its
400 /// predecessor) forms a valid simple shape for ifcvt. It also returns the
401 /// number of instructions that the ifcvt would need to duplicate if performed
402 /// in Dups.
403 bool IfConverter::ValidSimple(BBInfo &TrueBBI, unsigned &Dups) const {
404   Dups = 0;
405   if (TrueBBI.IsBeingAnalyzed || TrueBBI.IsDone)
406     return false;
407
408   if (TrueBBI.IsBrAnalyzable)
409     return false;
410
411   if (TrueBBI.BB->pred_size() > 1) {
412     if (TrueBBI.CannotBeCopied ||
413         TrueBBI.NonPredSize > TLI->getIfCvtDupBlockSizeLimit())
414       return false;
415     Dups = TrueBBI.NonPredSize;
416   }
417
418   return true;
419 }
420
421 /// ValidTriangle - Returns true if the 'true' and 'false' blocks (along
422 /// with their common predecessor) forms a valid triangle shape for ifcvt.
423 /// If 'FalseBranch' is true, it checks if 'true' block's false branch
424 /// branches to the false branch rather than the other way around. It also
425 /// returns the number of instructions that the ifcvt would need to duplicate
426 /// if performed in 'Dups'.
427 bool IfConverter::ValidTriangle(BBInfo &TrueBBI, BBInfo &FalseBBI,
428                                 bool FalseBranch, unsigned &Dups) const {
429   Dups = 0;
430   if (TrueBBI.IsBeingAnalyzed || TrueBBI.IsDone)
431     return false;
432
433   if (TrueBBI.BB->pred_size() > 1) {
434     if (TrueBBI.CannotBeCopied)
435       return false;
436
437     unsigned Size = TrueBBI.NonPredSize;
438     if (TrueBBI.IsBrAnalyzable) {
439       if (TrueBBI.TrueBB && TrueBBI.BrCond.empty())
440         // Ends with an unconditional branch. It will be removed.
441         --Size;
442       else {
443         MachineBasicBlock *FExit = FalseBranch
444           ? TrueBBI.TrueBB : TrueBBI.FalseBB;
445         if (FExit)
446           // Require a conditional branch
447           ++Size;
448       }
449     }
450     if (Size > TLI->getIfCvtDupBlockSizeLimit())
451       return false;
452     Dups = Size;
453   }
454
455   MachineBasicBlock *TExit = FalseBranch ? TrueBBI.FalseBB : TrueBBI.TrueBB;
456   if (!TExit && blockAlwaysFallThrough(TrueBBI)) {
457     MachineFunction::iterator I = TrueBBI.BB;
458     if (++I == TrueBBI.BB->getParent()->end())
459       return false;
460     TExit = I;
461   }
462   return TExit && TExit == FalseBBI.BB;
463 }
464
465 static
466 MachineBasicBlock::iterator firstNonBranchInst(MachineBasicBlock *BB,
467                                                const TargetInstrInfo *TII) {
468   MachineBasicBlock::iterator I = BB->end();
469   while (I != BB->begin()) {
470     --I;
471     if (!I->getDesc().isBranch())
472       break;
473   }
474   return I;
475 }
476
477 /// ValidDiamond - Returns true if the 'true' and 'false' blocks (along
478 /// with their common predecessor) forms a valid diamond shape for ifcvt.
479 bool IfConverter::ValidDiamond(BBInfo &TrueBBI, BBInfo &FalseBBI,
480                                unsigned &Dups1, unsigned &Dups2) const {
481   Dups1 = Dups2 = 0;
482   if (TrueBBI.IsBeingAnalyzed || TrueBBI.IsDone ||
483       FalseBBI.IsBeingAnalyzed || FalseBBI.IsDone)
484     return false;
485
486   MachineBasicBlock *TT = TrueBBI.TrueBB;
487   MachineBasicBlock *FT = FalseBBI.TrueBB;
488
489   if (!TT && blockAlwaysFallThrough(TrueBBI))
490     TT = getNextBlock(TrueBBI.BB);
491   if (!FT && blockAlwaysFallThrough(FalseBBI))
492     FT = getNextBlock(FalseBBI.BB);
493   if (TT != FT)
494     return false;
495   if (TT == NULL && (TrueBBI.IsBrAnalyzable || FalseBBI.IsBrAnalyzable))
496     return false;
497   if  (TrueBBI.BB->pred_size() > 1 || FalseBBI.BB->pred_size() > 1)
498     return false;
499
500   // FIXME: Allow true block to have an early exit?
501   if (TrueBBI.FalseBB || FalseBBI.FalseBB ||
502       (TrueBBI.ClobbersPred && FalseBBI.ClobbersPred))
503     return false;
504
505   MachineBasicBlock::iterator TI = TrueBBI.BB->begin();
506   MachineBasicBlock::iterator FI = FalseBBI.BB->begin();
507   while (TI != TrueBBI.BB->end() && FI != FalseBBI.BB->end()) {
508     if (!TI->isIdenticalTo(FI))
509       break;
510     ++Dups1;
511     ++TI;
512     ++FI;
513   }
514
515   TI = firstNonBranchInst(TrueBBI.BB, TII);
516   FI = firstNonBranchInst(FalseBBI.BB, TII);
517   while (TI != TrueBBI.BB->begin() && FI != FalseBBI.BB->begin()) {
518     if (!TI->isIdenticalTo(FI))
519       break;
520     ++Dups2;
521     --TI;
522     --FI;
523   }
524
525   return true;
526 }
527
528 /// ScanInstructions - Scan all the instructions in the block to determine if
529 /// the block is predicable. In most cases, that means all the instructions
530 /// in the block are isPredicable(). Also checks if the block contains any
531 /// instruction which can clobber a predicate (e.g. condition code register).
532 /// If so, the block is not predicable unless it's the last instruction.
533 void IfConverter::ScanInstructions(BBInfo &BBI) {
534   if (BBI.IsDone)
535     return;
536
537   bool AlreadyPredicated = BBI.Predicate.size() > 0;
538   // First analyze the end of BB branches.
539   BBI.TrueBB = BBI.FalseBB = NULL;
540   BBI.BrCond.clear();
541   BBI.IsBrAnalyzable =
542     !TII->AnalyzeBranch(*BBI.BB, BBI.TrueBB, BBI.FalseBB, BBI.BrCond);
543   BBI.HasFallThrough = BBI.IsBrAnalyzable && BBI.FalseBB == NULL;
544
545   if (BBI.BrCond.size()) {
546     // No false branch. This BB must end with a conditional branch and a
547     // fallthrough.
548     if (!BBI.FalseBB)
549       BBI.FalseBB = findFalseBlock(BBI.BB, BBI.TrueBB);  
550     assert(BBI.FalseBB && "Expected to find the fallthrough block!");
551   }
552
553   // Then scan all the instructions.
554   BBI.NonPredSize = 0;
555   BBI.ClobbersPred = false;
556   for (MachineBasicBlock::iterator I = BBI.BB->begin(), E = BBI.BB->end();
557        I != E; ++I) {
558     const TargetInstrDesc &TID = I->getDesc();
559     if (TID.isNotDuplicable())
560       BBI.CannotBeCopied = true;
561
562     bool isPredicated = TII->isPredicated(I);
563     bool isCondBr = BBI.IsBrAnalyzable && TID.isConditionalBranch();
564
565     if (!isCondBr) {
566       if (!isPredicated)
567         BBI.NonPredSize++;
568       else if (!AlreadyPredicated) {
569         // FIXME: This instruction is already predicated before the
570         // if-conversion pass. It's probably something like a conditional move.
571         // Mark this block unpredicable for now.
572         BBI.IsUnpredicable = true;
573         return;
574       }
575     }
576
577     if (BBI.ClobbersPred && !isPredicated) {
578       // Predicate modification instruction should end the block (except for
579       // already predicated instructions and end of block branches).
580       if (isCondBr) {
581         // A conditional branch is not predicable, but it may be eliminated.
582         continue;
583       }
584
585       // Predicate may have been modified, the subsequent (currently)
586       // unpredicated instructions cannot be correctly predicated.
587       BBI.IsUnpredicable = true;
588       return;
589     }
590
591     // FIXME: Make use of PredDefs? e.g. ADDC, SUBC sets predicates but are
592     // still potentially predicable.
593     std::vector<MachineOperand> PredDefs;
594     if (TII->DefinesPredicate(I, PredDefs))
595       BBI.ClobbersPred = true;
596
597     if (!TID.isPredicable()) {
598       BBI.IsUnpredicable = true;
599       return;
600     }
601   }
602 }
603
604 /// FeasibilityAnalysis - Determine if the block is a suitable candidate to be
605 /// predicated by the specified predicate.
606 bool IfConverter::FeasibilityAnalysis(BBInfo &BBI,
607                                       SmallVectorImpl<MachineOperand> &Pred,
608                                       bool isTriangle, bool RevBranch) {
609   // If the block is dead or unpredicable, then it cannot be predicated.
610   if (BBI.IsDone || BBI.IsUnpredicable)
611     return false;
612
613   // If it is already predicated, check if its predicate subsumes the new
614   // predicate.
615   if (BBI.Predicate.size() && !TII->SubsumesPredicate(BBI.Predicate, Pred))
616     return false;
617
618   if (BBI.BrCond.size()) {
619     if (!isTriangle)
620       return false;
621
622     // Test predicate subsumption.
623     SmallVector<MachineOperand, 4> RevPred(Pred.begin(), Pred.end());
624     SmallVector<MachineOperand, 4> Cond(BBI.BrCond.begin(), BBI.BrCond.end());
625     if (RevBranch) {
626       if (TII->ReverseBranchCondition(Cond))
627         return false;
628     }
629     if (TII->ReverseBranchCondition(RevPred) ||
630         !TII->SubsumesPredicate(Cond, RevPred))
631       return false;
632   }
633
634   return true;
635 }
636
637 /// AnalyzeBlock - Analyze the structure of the sub-CFG starting from
638 /// the specified block. Record its successors and whether it looks like an
639 /// if-conversion candidate.
640 IfConverter::BBInfo &IfConverter::AnalyzeBlock(MachineBasicBlock *BB,
641                                              std::vector<IfcvtToken*> &Tokens) {
642   BBInfo &BBI = BBAnalysis[BB->getNumber()];
643
644   if (BBI.IsAnalyzed || BBI.IsBeingAnalyzed)
645     return BBI;
646
647   BBI.BB = BB;
648   BBI.IsBeingAnalyzed = true;
649
650   ScanInstructions(BBI);
651
652   // Unanalyzable or ends with fallthrough or unconditional branch.
653   if (!BBI.IsBrAnalyzable || BBI.BrCond.empty()) {
654     BBI.IsBeingAnalyzed = false;
655     BBI.IsAnalyzed = true;
656     return BBI;
657   }
658
659   // Do not ifcvt if either path is a back edge to the entry block.
660   if (BBI.TrueBB == BB || BBI.FalseBB == BB) {
661     BBI.IsBeingAnalyzed = false;
662     BBI.IsAnalyzed = true;
663     return BBI;
664   }
665
666   BBInfo &TrueBBI  = AnalyzeBlock(BBI.TrueBB, Tokens);
667   BBInfo &FalseBBI = AnalyzeBlock(BBI.FalseBB, Tokens);
668
669   if (TrueBBI.IsDone && FalseBBI.IsDone) {
670     BBI.IsBeingAnalyzed = false;
671     BBI.IsAnalyzed = true;
672     return BBI;
673   }
674
675   SmallVector<MachineOperand, 4> RevCond(BBI.BrCond.begin(), BBI.BrCond.end());
676   bool CanRevCond = !TII->ReverseBranchCondition(RevCond);
677
678   unsigned Dups = 0;
679   unsigned Dups2 = 0;
680   bool TNeedSub = TrueBBI.Predicate.size() > 0;
681   bool FNeedSub = FalseBBI.Predicate.size() > 0;
682   bool Enqueued = false;
683   if (CanRevCond && ValidDiamond(TrueBBI, FalseBBI, Dups, Dups2) &&
684       MeetIfcvtSizeLimit(TrueBBI.NonPredSize - (Dups + Dups2)) &&
685       MeetIfcvtSizeLimit(FalseBBI.NonPredSize - (Dups + Dups2)) &&
686       FeasibilityAnalysis(TrueBBI, BBI.BrCond) &&
687       FeasibilityAnalysis(FalseBBI, RevCond)) {
688     // Diamond:
689     //   EBB
690     //   / \_
691     //  |   |
692     // TBB FBB
693     //   \ /
694     //  TailBB
695     // Note TailBB can be empty.
696     Tokens.push_back(new IfcvtToken(BBI, ICDiamond, TNeedSub|FNeedSub, Dups,
697                                     Dups2));
698     Enqueued = true;
699   }
700
701   if (ValidTriangle(TrueBBI, FalseBBI, false, Dups) &&
702       MeetIfcvtSizeLimit(TrueBBI.NonPredSize) &&
703       FeasibilityAnalysis(TrueBBI, BBI.BrCond, true)) {
704     // Triangle:
705     //   EBB
706     //   | \_
707     //   |  |
708     //   | TBB
709     //   |  /
710     //   FBB
711     Tokens.push_back(new IfcvtToken(BBI, ICTriangle, TNeedSub, Dups));
712     Enqueued = true;
713   }
714   
715   if (ValidTriangle(TrueBBI, FalseBBI, true, Dups) &&
716       MeetIfcvtSizeLimit(TrueBBI.NonPredSize) &&
717       FeasibilityAnalysis(TrueBBI, BBI.BrCond, true, true)) {
718     Tokens.push_back(new IfcvtToken(BBI, ICTriangleRev, TNeedSub, Dups));
719     Enqueued = true;
720   }
721
722   if (ValidSimple(TrueBBI, Dups) &&
723       MeetIfcvtSizeLimit(TrueBBI.NonPredSize) &&
724       FeasibilityAnalysis(TrueBBI, BBI.BrCond)) {
725     // Simple (split, no rejoin):
726     //   EBB
727     //   | \_
728     //   |  |
729     //   | TBB---> exit
730     //   |    
731     //   FBB
732     Tokens.push_back(new IfcvtToken(BBI, ICSimple, TNeedSub, Dups));
733     Enqueued = true;
734   }
735
736   if (CanRevCond) {
737     // Try the other path...
738     if (ValidTriangle(FalseBBI, TrueBBI, false, Dups) &&
739         MeetIfcvtSizeLimit(FalseBBI.NonPredSize) &&
740         FeasibilityAnalysis(FalseBBI, RevCond, true)) {
741       Tokens.push_back(new IfcvtToken(BBI, ICTriangleFalse, FNeedSub, Dups));
742       Enqueued = true;
743     }
744
745     if (ValidTriangle(FalseBBI, TrueBBI, true, Dups) &&
746         MeetIfcvtSizeLimit(FalseBBI.NonPredSize) &&
747         FeasibilityAnalysis(FalseBBI, RevCond, true, true)) {
748       Tokens.push_back(new IfcvtToken(BBI, ICTriangleFRev, FNeedSub, Dups));
749       Enqueued = true;
750     }
751
752     if (ValidSimple(FalseBBI, Dups) &&
753         MeetIfcvtSizeLimit(FalseBBI.NonPredSize) &&
754         FeasibilityAnalysis(FalseBBI, RevCond)) {
755       Tokens.push_back(new IfcvtToken(BBI, ICSimpleFalse, FNeedSub, Dups));
756       Enqueued = true;
757     }
758   }
759
760   BBI.IsEnqueued = Enqueued;
761   BBI.IsBeingAnalyzed = false;
762   BBI.IsAnalyzed = true;
763   return BBI;
764 }
765
766 /// AnalyzeBlocks - Analyze all blocks and find entries for all if-conversion
767 /// candidates. It returns true if any CFG restructuring is done to expose more
768 /// if-conversion opportunities.
769 bool IfConverter::AnalyzeBlocks(MachineFunction &MF,
770                                 std::vector<IfcvtToken*> &Tokens) {
771   bool Change = false;
772   std::set<MachineBasicBlock*> Visited;
773   for (unsigned i = 0, e = Roots.size(); i != e; ++i) {
774     for (idf_ext_iterator<MachineBasicBlock*> I=idf_ext_begin(Roots[i],Visited),
775            E = idf_ext_end(Roots[i], Visited); I != E; ++I) {
776       MachineBasicBlock *BB = *I;
777       AnalyzeBlock(BB, Tokens);
778     }
779   }
780
781   // Sort to favor more complex ifcvt scheme.
782   std::stable_sort(Tokens.begin(), Tokens.end(), IfcvtTokenCmp);
783
784   return Change;
785 }
786
787 /// canFallThroughTo - Returns true either if ToBB is the next block after BB or
788 /// that all the intervening blocks are empty (given BB can fall through to its
789 /// next block).
790 static bool canFallThroughTo(MachineBasicBlock *BB, MachineBasicBlock *ToBB) {
791   MachineFunction::iterator I = BB;
792   MachineFunction::iterator TI = ToBB;
793   MachineFunction::iterator E = BB->getParent()->end();
794   while (++I != TI)
795     if (I == E || !I->empty())
796       return false;
797   return true;
798 }
799
800 /// InvalidatePreds - Invalidate predecessor BB info so it would be re-analyzed
801 /// to determine if it can be if-converted. If predecessor is already enqueued,
802 /// dequeue it!
803 void IfConverter::InvalidatePreds(MachineBasicBlock *BB) {
804   for (MachineBasicBlock::pred_iterator PI = BB->pred_begin(),
805          E = BB->pred_end(); PI != E; ++PI) {
806     BBInfo &PBBI = BBAnalysis[(*PI)->getNumber()];
807     if (PBBI.IsDone || PBBI.BB == BB)
808       continue;
809     PBBI.IsAnalyzed = false;
810     PBBI.IsEnqueued = false;
811   }
812 }
813
814 /// InsertUncondBranch - Inserts an unconditional branch from BB to ToBB.
815 ///
816 static void InsertUncondBranch(MachineBasicBlock *BB, MachineBasicBlock *ToBB,
817                                const TargetInstrInfo *TII) {
818   SmallVector<MachineOperand, 0> NoCond;
819   TII->InsertBranch(*BB, ToBB, NULL, NoCond);
820 }
821
822 /// RemoveExtraEdges - Remove true / false edges if either / both are no longer
823 /// successors.
824 void IfConverter::RemoveExtraEdges(BBInfo &BBI) {
825   MachineBasicBlock *TBB = NULL, *FBB = NULL;
826   SmallVector<MachineOperand, 4> Cond;
827   if (!TII->AnalyzeBranch(*BBI.BB, TBB, FBB, Cond))
828     BBI.BB->CorrectExtraCFGEdges(TBB, FBB, !Cond.empty());
829 }
830
831 /// IfConvertSimple - If convert a simple (split, no rejoin) sub-CFG.
832 ///
833 bool IfConverter::IfConvertSimple(BBInfo &BBI, IfcvtKind Kind) {
834   BBInfo &TrueBBI  = BBAnalysis[BBI.TrueBB->getNumber()];
835   BBInfo &FalseBBI = BBAnalysis[BBI.FalseBB->getNumber()];
836   BBInfo *CvtBBI = &TrueBBI;
837   BBInfo *NextBBI = &FalseBBI;
838
839   SmallVector<MachineOperand, 4> Cond(BBI.BrCond.begin(), BBI.BrCond.end());
840   if (Kind == ICSimpleFalse)
841     std::swap(CvtBBI, NextBBI);
842
843   if (CvtBBI->IsDone ||
844       (CvtBBI->CannotBeCopied && CvtBBI->BB->pred_size() > 1)) {
845     // Something has changed. It's no longer safe to predicate this block.
846     BBI.IsAnalyzed = false;
847     CvtBBI->IsAnalyzed = false;
848     return false;
849   }
850
851   if (Kind == ICSimpleFalse)
852     if (TII->ReverseBranchCondition(Cond))
853       assert(false && "Unable to reverse branch condition!");
854
855   if (CvtBBI->BB->pred_size() > 1) {
856     BBI.NonPredSize -= TII->RemoveBranch(*BBI.BB);
857     // Copy instructions in the true block, predicate them, and add them to
858     // the entry block.
859     CopyAndPredicateBlock(BBI, *CvtBBI, Cond);
860   } else {
861     PredicateBlock(*CvtBBI, CvtBBI->BB->end(), Cond);
862
863     // Merge converted block into entry block.
864     BBI.NonPredSize -= TII->RemoveBranch(*BBI.BB);
865     MergeBlocks(BBI, *CvtBBI);
866   }
867
868   bool IterIfcvt = true;
869   if (!canFallThroughTo(BBI.BB, NextBBI->BB)) {
870     InsertUncondBranch(BBI.BB, NextBBI->BB, TII);
871     BBI.HasFallThrough = false;
872     // Now ifcvt'd block will look like this:
873     // BB:
874     // ...
875     // t, f = cmp
876     // if t op
877     // b BBf
878     //
879     // We cannot further ifcvt this block because the unconditional branch
880     // will have to be predicated on the new condition, that will not be
881     // available if cmp executes.
882     IterIfcvt = false;
883   }
884
885   RemoveExtraEdges(BBI);
886
887   // Update block info. BB can be iteratively if-converted.
888   if (!IterIfcvt)
889     BBI.IsDone = true;
890   InvalidatePreds(BBI.BB);
891   CvtBBI->IsDone = true;
892
893   // FIXME: Must maintain LiveIns.
894   return true;
895 }
896
897 /// IfConvertTriangle - If convert a triangle sub-CFG.
898 ///
899 bool IfConverter::IfConvertTriangle(BBInfo &BBI, IfcvtKind Kind) {
900   BBInfo &TrueBBI = BBAnalysis[BBI.TrueBB->getNumber()];
901   BBInfo &FalseBBI = BBAnalysis[BBI.FalseBB->getNumber()];
902   BBInfo *CvtBBI = &TrueBBI;
903   BBInfo *NextBBI = &FalseBBI;
904
905   SmallVector<MachineOperand, 4> Cond(BBI.BrCond.begin(), BBI.BrCond.end());
906   if (Kind == ICTriangleFalse || Kind == ICTriangleFRev)
907     std::swap(CvtBBI, NextBBI);
908
909   if (CvtBBI->IsDone ||
910       (CvtBBI->CannotBeCopied && CvtBBI->BB->pred_size() > 1)) {
911     // Something has changed. It's no longer safe to predicate this block.
912     BBI.IsAnalyzed = false;
913     CvtBBI->IsAnalyzed = false;
914     return false;
915   }
916
917   if (Kind == ICTriangleFalse || Kind == ICTriangleFRev)
918     if (TII->ReverseBranchCondition(Cond))
919       assert(false && "Unable to reverse branch condition!");
920
921   if (Kind == ICTriangleRev || Kind == ICTriangleFRev) {
922     if (ReverseBranchCondition(*CvtBBI)) {
923       // BB has been changed, modify its predecessors (except for this
924       // one) so they don't get ifcvt'ed based on bad intel.
925       for (MachineBasicBlock::pred_iterator PI = CvtBBI->BB->pred_begin(),
926              E = CvtBBI->BB->pred_end(); PI != E; ++PI) {
927         MachineBasicBlock *PBB = *PI;
928         if (PBB == BBI.BB)
929           continue;
930         BBInfo &PBBI = BBAnalysis[PBB->getNumber()];
931         if (PBBI.IsEnqueued) {
932           PBBI.IsAnalyzed = false;
933           PBBI.IsEnqueued = false;
934         }
935       }
936     }
937   }
938
939   bool HasEarlyExit = CvtBBI->FalseBB != NULL;
940   bool DupBB = CvtBBI->BB->pred_size() > 1;
941   if (DupBB) {
942     BBI.NonPredSize -= TII->RemoveBranch(*BBI.BB);
943     // Copy instructions in the true block, predicate them, and add them to
944     // the entry block.
945     CopyAndPredicateBlock(BBI, *CvtBBI, Cond, true);
946   } else {
947     // Predicate the 'true' block after removing its branch.
948     CvtBBI->NonPredSize -= TII->RemoveBranch(*CvtBBI->BB);
949     PredicateBlock(*CvtBBI, CvtBBI->BB->end(), Cond);
950
951     // Now merge the entry of the triangle with the true block.
952     BBI.NonPredSize -= TII->RemoveBranch(*BBI.BB);
953     MergeBlocks(BBI, *CvtBBI);
954   }
955
956   // If 'true' block has a 'false' successor, add an exit branch to it.
957   if (HasEarlyExit) {
958     SmallVector<MachineOperand, 4> RevCond(CvtBBI->BrCond.begin(),
959                                            CvtBBI->BrCond.end());
960     if (TII->ReverseBranchCondition(RevCond))
961       assert(false && "Unable to reverse branch condition!");
962     TII->InsertBranch(*BBI.BB, CvtBBI->FalseBB, NULL, RevCond);
963     BBI.BB->addSuccessor(CvtBBI->FalseBB);
964   }
965
966   // Merge in the 'false' block if the 'false' block has no other
967   // predecessors. Otherwise, add an unconditional branch to 'false'.
968   bool FalseBBDead = false;
969   bool IterIfcvt = true;
970   bool isFallThrough = canFallThroughTo(BBI.BB, NextBBI->BB);
971   if (!isFallThrough) {
972     // Only merge them if the true block does not fallthrough to the false
973     // block. By not merging them, we make it possible to iteratively
974     // ifcvt the blocks.
975     if (!HasEarlyExit &&
976         NextBBI->BB->pred_size() == 1 && !NextBBI->HasFallThrough) {
977       MergeBlocks(BBI, *NextBBI);
978       FalseBBDead = true;
979     } else {
980       InsertUncondBranch(BBI.BB, NextBBI->BB, TII);
981       BBI.HasFallThrough = false;
982     }
983     // Mixed predicated and unpredicated code. This cannot be iteratively
984     // predicated.
985     IterIfcvt = false;
986   }
987
988   RemoveExtraEdges(BBI);
989
990   // Update block info. BB can be iteratively if-converted.
991   if (!IterIfcvt) 
992     BBI.IsDone = true;
993   InvalidatePreds(BBI.BB);
994   CvtBBI->IsDone = true;
995   if (FalseBBDead)
996     NextBBI->IsDone = true;
997
998   // FIXME: Must maintain LiveIns.
999   return true;
1000 }
1001
1002 /// IfConvertDiamond - If convert a diamond sub-CFG.
1003 ///
1004 bool IfConverter::IfConvertDiamond(BBInfo &BBI, IfcvtKind Kind,
1005                                    unsigned NumDups1, unsigned NumDups2) {
1006   BBInfo &TrueBBI  = BBAnalysis[BBI.TrueBB->getNumber()];
1007   BBInfo &FalseBBI = BBAnalysis[BBI.FalseBB->getNumber()];
1008   MachineBasicBlock *TailBB = TrueBBI.TrueBB;
1009   // True block must fall through or end with an unanalyzable terminator.
1010   if (!TailBB) {
1011     if (blockAlwaysFallThrough(TrueBBI))
1012       TailBB = FalseBBI.TrueBB;
1013     assert((TailBB || !TrueBBI.IsBrAnalyzable) && "Unexpected!");
1014   }
1015
1016   if (TrueBBI.IsDone || FalseBBI.IsDone ||
1017       TrueBBI.BB->pred_size() > 1 ||
1018       FalseBBI.BB->pred_size() > 1) {
1019     // Something has changed. It's no longer safe to predicate these blocks.
1020     BBI.IsAnalyzed = false;
1021     TrueBBI.IsAnalyzed = false;
1022     FalseBBI.IsAnalyzed = false;
1023     return false;
1024   }
1025
1026   // Merge the 'true' and 'false' blocks by copying the instructions
1027   // from the 'false' block to the 'true' block. That is, unless the true
1028   // block would clobber the predicate, in that case, do the opposite.
1029   BBInfo *BBI1 = &TrueBBI;
1030   BBInfo *BBI2 = &FalseBBI;
1031   SmallVector<MachineOperand, 4> RevCond(BBI.BrCond.begin(), BBI.BrCond.end());
1032   if (TII->ReverseBranchCondition(RevCond))
1033     assert(false && "Unable to reverse branch condition!");
1034   SmallVector<MachineOperand, 4> *Cond1 = &BBI.BrCond;
1035   SmallVector<MachineOperand, 4> *Cond2 = &RevCond;
1036
1037   // Figure out the more profitable ordering.
1038   bool DoSwap = false;
1039   if (TrueBBI.ClobbersPred && !FalseBBI.ClobbersPred)
1040     DoSwap = true;
1041   else if (TrueBBI.ClobbersPred == FalseBBI.ClobbersPred) {
1042     if (TrueBBI.NonPredSize > FalseBBI.NonPredSize)
1043       DoSwap = true;
1044   }
1045   if (DoSwap) {
1046     std::swap(BBI1, BBI2);
1047     std::swap(Cond1, Cond2);
1048   }
1049
1050   // Remove the conditional branch from entry to the blocks.
1051   BBI.NonPredSize -= TII->RemoveBranch(*BBI.BB);
1052
1053   // Remove the duplicated instructions at the beginnings of both paths.
1054   MachineBasicBlock::iterator DI1 = BBI1->BB->begin();
1055   MachineBasicBlock::iterator DI2 = BBI2->BB->begin();
1056   BBI1->NonPredSize -= NumDups1;
1057   BBI2->NonPredSize -= NumDups1;
1058   while (NumDups1 != 0) {
1059     ++DI1;
1060     ++DI2;
1061     --NumDups1;
1062   }
1063   BBI.BB->splice(BBI.BB->end(), BBI1->BB, BBI1->BB->begin(), DI1);
1064   BBI2->BB->erase(BBI2->BB->begin(), DI2);
1065
1066   // Predicate the 'true' block after removing its branch.
1067   BBI1->NonPredSize -= TII->RemoveBranch(*BBI1->BB);
1068   DI1 = BBI1->BB->end();
1069   for (unsigned i = 0; i != NumDups2; ++i)
1070     --DI1;
1071   BBI1->BB->erase(DI1, BBI1->BB->end());
1072   PredicateBlock(*BBI1, BBI1->BB->end(), *Cond1);
1073
1074   // Predicate the 'false' block.
1075   BBI2->NonPredSize -= TII->RemoveBranch(*BBI2->BB);
1076   DI2 = BBI2->BB->end();
1077   while (NumDups2 != 0) {
1078     --DI2;
1079     --NumDups2;
1080   }
1081   PredicateBlock(*BBI2, DI2, *Cond2);
1082
1083   // Merge the true block into the entry of the diamond.
1084   MergeBlocks(BBI, *BBI1);
1085   MergeBlocks(BBI, *BBI2);
1086
1087   // If the if-converted block falls through or unconditionally branches into
1088   // the tail block, and the tail block does not have other predecessors, then
1089   // fold the tail block in as well. Otherwise, unless it falls through to the
1090   // tail, add a unconditional branch to it.
1091   if (TailBB) {
1092     BBInfo TailBBI = BBAnalysis[TailBB->getNumber()];
1093     if (TailBB->pred_size() == 1 && !TailBBI.HasFallThrough) {
1094       BBI.NonPredSize -= TII->RemoveBranch(*BBI.BB);
1095       MergeBlocks(BBI, TailBBI);
1096       TailBBI.IsDone = true;
1097     } else {
1098       InsertUncondBranch(BBI.BB, TailBB, TII);
1099       BBI.HasFallThrough = false;
1100     }
1101   }
1102
1103   RemoveExtraEdges(BBI);
1104
1105   // Update block info.
1106   BBI.IsDone = TrueBBI.IsDone = FalseBBI.IsDone = true;
1107   InvalidatePreds(BBI.BB);
1108
1109   // FIXME: Must maintain LiveIns.
1110   return true;
1111 }
1112
1113 /// PredicateBlock - Predicate instructions from the start of the block to the
1114 /// specified end with the specified condition.
1115 void IfConverter::PredicateBlock(BBInfo &BBI,
1116                                  MachineBasicBlock::iterator E,
1117                                  SmallVectorImpl<MachineOperand> &Cond) {
1118   for (MachineBasicBlock::iterator I = BBI.BB->begin(); I != E; ++I) {
1119     if (TII->isPredicated(I))
1120       continue;
1121     if (!TII->PredicateInstruction(I, Cond)) {
1122       cerr << "Unable to predicate " << *I << "!\n";
1123       abort();
1124     }
1125   }
1126
1127   std::copy(Cond.begin(), Cond.end(), std::back_inserter(BBI.Predicate));
1128
1129   BBI.IsAnalyzed = false;
1130   BBI.NonPredSize = 0;
1131
1132   NumIfConvBBs++;
1133 }
1134
1135 /// CopyAndPredicateBlock - Copy and predicate instructions from source BB to
1136 /// the destination block. Skip end of block branches if IgnoreBr is true.
1137 void IfConverter::CopyAndPredicateBlock(BBInfo &ToBBI, BBInfo &FromBBI,
1138                                         SmallVectorImpl<MachineOperand> &Cond,
1139                                         bool IgnoreBr) {
1140   MachineFunction &MF = *ToBBI.BB->getParent();
1141
1142   for (MachineBasicBlock::iterator I = FromBBI.BB->begin(),
1143          E = FromBBI.BB->end(); I != E; ++I) {
1144     const TargetInstrDesc &TID = I->getDesc();
1145     bool isPredicated = TII->isPredicated(I);
1146     // Do not copy the end of the block branches.
1147     if (IgnoreBr && !isPredicated && TID.isBranch())
1148       break;
1149
1150     MachineInstr *MI = MF.CloneMachineInstr(I);
1151     ToBBI.BB->insert(ToBBI.BB->end(), MI);
1152     ToBBI.NonPredSize++;
1153
1154     if (!isPredicated)
1155       if (!TII->PredicateInstruction(MI, Cond)) {
1156         cerr << "Unable to predicate " << *MI << "!\n";
1157         abort();
1158       }
1159   }
1160
1161   std::vector<MachineBasicBlock *> Succs(FromBBI.BB->succ_begin(),
1162                                          FromBBI.BB->succ_end());
1163   MachineBasicBlock *NBB = getNextBlock(FromBBI.BB);
1164   MachineBasicBlock *FallThrough = FromBBI.HasFallThrough ? NBB : NULL;
1165
1166   for (unsigned i = 0, e = Succs.size(); i != e; ++i) {
1167     MachineBasicBlock *Succ = Succs[i];
1168     // Fallthrough edge can't be transferred.
1169     if (Succ == FallThrough)
1170       continue;
1171     ToBBI.BB->addSuccessor(Succ);
1172   }
1173
1174   std::copy(FromBBI.Predicate.begin(), FromBBI.Predicate.end(),
1175             std::back_inserter(ToBBI.Predicate));
1176   std::copy(Cond.begin(), Cond.end(), std::back_inserter(ToBBI.Predicate));
1177
1178   ToBBI.ClobbersPred |= FromBBI.ClobbersPred;
1179   ToBBI.IsAnalyzed = false;
1180
1181   NumDupBBs++;
1182 }
1183
1184 /// MergeBlocks - Move all instructions from FromBB to the end of ToBB.
1185 ///
1186 void IfConverter::MergeBlocks(BBInfo &ToBBI, BBInfo &FromBBI) {
1187   ToBBI.BB->splice(ToBBI.BB->end(),
1188                    FromBBI.BB, FromBBI.BB->begin(), FromBBI.BB->end());
1189
1190   // This only works when FromBBI has no predecessors except ToBBI.
1191   assert(FromBBI.BB->pred_size() == 1 &&
1192          *FromBBI.BB->pred_begin() == ToBBI.BB &&
1193          "if-converter not merging block into its unique predecessor");
1194  
1195   std::vector<MachineBasicBlock *> Succs(FromBBI.BB->succ_begin(),
1196                                          FromBBI.BB->succ_end());
1197   MachineBasicBlock *NBB = getNextBlock(FromBBI.BB);
1198   MachineBasicBlock *FallThrough = FromBBI.HasFallThrough ? NBB : NULL;
1199
1200   for (unsigned i = 0, e = Succs.size(); i != e; ++i) {
1201     MachineBasicBlock *Succ = Succs[i];
1202     // Fallthrough edge can't be transferred.
1203     if (Succ == FallThrough)
1204       continue;
1205     FromBBI.BB->removeSuccessor(Succ);
1206     ToBBI.BB->addSuccessor(Succ);
1207   }
1208
1209   // Now FromBBI always falls through to the next block!
1210   if (NBB && !FromBBI.BB->isSuccessor(NBB))
1211     FromBBI.BB->addSuccessor(NBB);
1212
1213   std::copy(FromBBI.Predicate.begin(), FromBBI.Predicate.end(),
1214             std::back_inserter(ToBBI.Predicate));
1215   FromBBI.Predicate.clear();
1216
1217   ToBBI.NonPredSize += FromBBI.NonPredSize;
1218   FromBBI.NonPredSize = 0;
1219
1220   ToBBI.ClobbersPred |= FromBBI.ClobbersPred;
1221   ToBBI.HasFallThrough = FromBBI.HasFallThrough;
1222   ToBBI.IsAnalyzed = false;
1223   FromBBI.IsAnalyzed = false;
1224 }