prune #includes, fit in 80 cols.
[oota-llvm.git] / include / llvm / Transforms / Utils / BasicBlockUtils.h
index 0bfb6f750aa97f1adf050454c7f8cfca2e8d8b07..4230cb1dd1ddda213c49159610c555987b0bda18 100644 (file)
@@ -2,8 +2,8 @@
 //
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by the LLVM research group and is distributed under
-// the University of Illinois Open Source License. See LICENSE.TXT for details.
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
@@ -57,18 +57,21 @@ void RemoveSuccessor(TerminatorInst *TI, unsigned SuccNum);
 /// Critical edges are edges from a block with multiple successors to a block
 /// with multiple predecessors.
 ///
-bool isCriticalEdge(const TerminatorInst *TI, unsigned SuccNum);
+bool isCriticalEdge(const TerminatorInst *TI, unsigned SuccNum,
+                    bool AllowIdenticalEdges = false);
 
 /// SplitCriticalEdge - If this edge is a critical edge, insert a new node to
-/// split the critical edge.  This will update DominatorSet, ImmediateDominator,
-/// DominatorTree, and DominatorFrontier information if it is available, thus
-/// calling this pass will not invalidate either of them.  This returns true if
-/// the edge was split, false otherwise.  If MergeIdenticalEdges is true (the
-/// default), *all* edges from TI to the specified successor will be merged into
-/// the same critical edge block.  This is most commonly interesting with switch
-/// instructions, which may have many edges to any one destination.  This
-/// ensures that all edges to that dest go to one block instead of each going to
-/// a different block, but isn't the standard definition of a "critical edge".
+/// split the critical edge.  This will update DominatorTree and
+/// DominatorFrontier information if it is available, thus calling this pass
+/// will not invalidate either of them. This returns true if the edge was split,
+/// false otherwise.  
+///
+/// If MergeIdenticalEdges is true (the default), *all* edges from TI to the 
+/// specified successor will be merged into the same critical edge block.  
+/// This is most commonly interesting with switch instructions, which may 
+/// have many edges to any one destination.  This ensures that all edges to that 
+/// dest go to one block instead of each going to a different block, but isn't 
+/// the standard definition of a "critical edge".
 ///
 bool SplitCriticalEdge(TerminatorInst *TI, unsigned SuccNum, Pass *P = 0,
                        bool MergeIdenticalEdges = false);
@@ -106,6 +109,17 @@ inline bool SplitCriticalEdge(BasicBlock *Src, BasicBlock *Dst, Pass *P = 0,
     ++i;
   }
 }
+
+/// SplitEdge -  Split the edge connecting specified block. Pass P must 
+/// not be NULL. 
+BasicBlock *SplitEdge(BasicBlock *From, BasicBlock *To, Pass *P);
+
+/// SplitBlock - Split the specified block at the specified instruction - every
+/// thing before SplitPt stays in Old and everything starting with SplitPt moves
+/// to a new block.  The two blocks are joined by an unconditional branch and
+/// the loop info is updated.
+///
+BasicBlock *SplitBlock(BasicBlock *Old, Instruction *SplitPt, Pass *P);
 } // End llvm namespace
 
 #endif