include/llvm/Transforms/Utils/BasicBlockUtils.h

   1 //===-- Transform/Utils/BasicBlockUtils.h - BasicBlock Utils ----*- C++ -*-===//
   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 family of functions perform manipulations on basic blocks, and
  11 // instructions contained within basic blocks.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_TRANSFORMS_UTILS_BASICBLOCK_H
  16 #define LLVM_TRANSFORMS_UTILS_BASICBLOCK_H
  17
  18 // FIXME: Move to this file: BasicBlock::removePredecessor, BB::splitBasicBlock
  19
  20 #include "llvm/BasicBlock.h"
  21 #include "llvm/Support/CFG.h"
  22
  23 namespace llvm {
  24
  25 class Instruction;
  26 class Pass;
  27 class AliasAnalysis;
  28
  29 /// DeleteDeadBlock - Delete the specified block, which must have no
  30 /// predecessors.
  31 void DeleteDeadBlock(BasicBlock *BB);
  32
  33
  34 /// FoldSingleEntryPHINodes - We know that BB has one predecessor.  If there are
  35 /// any single-entry PHI nodes in it, fold them away.  This handles the case
  36 /// when all entries to the PHI nodes in a block are guaranteed equal, such as
  37 /// when the block has exactly one predecessor.
  38 void FoldSingleEntryPHINodes(BasicBlock *BB);
  39
  40
  41 /// MergeBlockIntoPredecessor - Attempts to merge a block into its predecessor,
  42 /// if possible.  The return value indicates success or failure.
  43 bool MergeBlockIntoPredecessor(BasicBlock* BB, Pass* P = 0);
  44
  45 // ReplaceInstWithValue - Replace all uses of an instruction (specified by BI)
  46 // with a value, then remove and delete the original instruction.
  47 //
  48 void ReplaceInstWithValue(BasicBlock::InstListType &BIL,
  49                           BasicBlock::iterator &BI, Value *V);
  50
  51 // ReplaceInstWithInst - Replace the instruction specified by BI with the
  52 // instruction specified by I.  The original instruction is deleted and BI is
  53 // updated to point to the new instruction.
  54 //
  55 void ReplaceInstWithInst(BasicBlock::InstListType &BIL,
  56                          BasicBlock::iterator &BI, Instruction *I);
  57
  58 // ReplaceInstWithInst - Replace the instruction specified by From with the
  59 // instruction specified by To.
  60 //
  61 void ReplaceInstWithInst(Instruction *From, Instruction *To);
  62
  63 /// FindAvailableLoadedValue - Scan the ScanBB block backwards (starting at the
  64 /// instruction before ScanFrom) checking to see if we have the value at the
  65 /// memory address *Ptr locally available within a small number of instructions.
  66 /// If the value is available, return it.
  67 ///
  68 /// If not, return the iterator for the last validated instruction that the
  69 /// value would be live through.  If we scanned the entire block and didn't find
  70 /// something that invalidates *Ptr or provides it, ScanFrom would be left at
  71 /// begin() and this returns null.  ScanFrom could also be left
  72 ///
  73 /// MaxInstsToScan specifies the maximum instructions to scan in the block.  If
  74 /// it is set to 0, it will scan the whole block. You can also optionally
  75 /// specify an alias analysis implementation, which makes this more precise.
  76 Value *FindAvailableLoadedValue(Value *Ptr, BasicBlock *ScanBB,
  77                                 BasicBlock::iterator &ScanFrom,
  78                                 unsigned MaxInstsToScan = 6,
  79                                 AliasAnalysis *AA = 0);
  80
  81
  82
  83 // RemoveSuccessor - Change the specified terminator instruction such that its
  84 // successor #SuccNum no longer exists.  Because this reduces the outgoing
  85 // degree of the current basic block, the actual terminator instruction itself
  86 // may have to be changed.  In the case where the last successor of the block is
  87 // deleted, a return instruction is inserted in its place which can cause a
  88 // suprising change in program behavior if it is not expected.
  89 //
  90 void RemoveSuccessor(TerminatorInst *TI, unsigned SuccNum);
  91
  92 /// isCriticalEdge - Return true if the specified edge is a critical edge.
  93 /// Critical edges are edges from a block with multiple successors to a block
  94 /// with multiple predecessors.
  95 ///
  96 bool isCriticalEdge(const TerminatorInst *TI, unsigned SuccNum,
  97                     bool AllowIdenticalEdges = false);
  98
  99 /// SplitCriticalEdge - If this edge is a critical edge, insert a new node to
 100 /// split the critical edge.  This will update DominatorTree and
 101 /// DominatorFrontier information if it is available, thus calling this pass
 102 /// will not invalidate either of them. This returns true if the edge was split,
 103 /// false otherwise.
 104 ///
 105 /// If MergeIdenticalEdges is true (not the default), *all* edges from TI to the
 106 /// specified successor will be merged into the same critical edge block.
 107 /// This is most commonly interesting with switch instructions, which may
 108 /// have many edges to any one destination.  This ensures that all edges to that
 109 /// dest go to one block instead of each going to a different block, but isn't
 110 /// the standard definition of a "critical edge".
 111 ///
 112 bool SplitCriticalEdge(TerminatorInst *TI, unsigned SuccNum, Pass *P = 0,
 113                        bool MergeIdenticalEdges = false);
 114
 115 inline bool SplitCriticalEdge(BasicBlock *BB, succ_iterator SI, Pass *P = 0) {
 116   return SplitCriticalEdge(BB->getTerminator(), SI.getSuccessorIndex(), P);
 117 }
 118
 119 /// SplitCriticalEdge - If the edge from *PI to BB is not critical, return
 120 /// false.  Otherwise, split all edges between the two blocks and return true.
 121 /// This updates all of the same analyses as the other SplitCriticalEdge
 122 /// function.  If P is specified, it updates the analyses
 123 /// described above.
 124 inline bool SplitCriticalEdge(BasicBlock *Succ, pred_iterator PI, Pass *P = 0) {
 125   bool MadeChange = false;
 126   TerminatorInst *TI = (*PI)->getTerminator();
 127   for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i)
 128     if (TI->getSuccessor(i) == Succ)
 129       MadeChange |= SplitCriticalEdge(TI, i, P);
 130   return MadeChange;
 131 }
 132
 133 /// SplitCriticalEdge - If an edge from Src to Dst is critical, split the edge
 134 /// and return true, otherwise return false.  This method requires that there be
 135 /// an edge between the two blocks.  If P is specified, it updates the analyses
 136 /// described above.
 137 inline bool SplitCriticalEdge(BasicBlock *Src, BasicBlock *Dst, Pass *P = 0,
 138                               bool MergeIdenticalEdges = false) {
 139   TerminatorInst *TI = Src->getTerminator();
 140   unsigned i = 0;
 141   while (1) {
 142     assert(i != TI->getNumSuccessors() && "Edge doesn't exist!");
 143     if (TI->getSuccessor(i) == Dst)
 144       return SplitCriticalEdge(TI, i, P, MergeIdenticalEdges);
 145     ++i;
 146   }
 147 }
 148
 149 /// SplitEdge -  Split the edge connecting specified block. Pass P must
 150 /// not be NULL.
 151 BasicBlock *SplitEdge(BasicBlock *From, BasicBlock *To, Pass *P);
 152
 153 /// SplitBlock - Split the specified block at the specified instruction - every
 154 /// thing before SplitPt stays in Old and everything starting with SplitPt moves
 155 /// to a new block.  The two blocks are joined by an unconditional branch and
 156 /// the loop info is updated.
 157 ///
 158 BasicBlock *SplitBlock(BasicBlock *Old, Instruction *SplitPt, Pass *P);
 159
 160 /// SplitBlockPredecessors - This method transforms BB by introducing a new
 161 /// basic block into the function, and moving some of the predecessors of BB to
 162 /// be predecessors of the new block.  The new predecessors are indicated by the
 163 /// Preds array, which has NumPreds elements in it.  The new block is given a
 164 /// suffix of 'Suffix'.  This function returns the new block.
 165 ///
 166 /// This currently updates the LLVM IR, AliasAnalysis, DominatorTree and
 167 /// DominanceFrontier, but no other analyses.
 168 BasicBlock *SplitBlockPredecessors(BasicBlock *BB, BasicBlock *const *Preds,
 169                                    unsigned NumPreds, const char *Suffix,
 170                                    Pass *P = 0);
 171
 172 } // End llvm namespace
 173
 174 #endif