Reformat partially.

[oota-llvm.git] / include / llvm / Analysis / PHITransAddr.h

diff --git a/include/llvm/Analysis/PHITransAddr.h b/include/llvm/Analysis/PHITransAddr.h
index e19fb1c13f6d7fb02664da1db1218f3140bfecac..f0f34f3a51f59243037de6908576860363a32659 100644 (file)
--- a/include/llvm/Analysis/PHITransAddr.h
+++ b/include/llvm/Analysis/PHITransAddr.h
@@ -14,13 +14,15 @@
 #ifndef LLVM_ANALYSIS_PHITRANSADDR_H
 #define LLVM_ANALYSIS_PHITRANSADDR_H
 
-#include "llvm/Instruction.h"
 #include "llvm/ADT/SmallVector.h"
+#include "llvm/IR/Instruction.h"
 
 namespace llvm {
+  class AssumptionCache;
   class DominatorTree;
-  class TargetData;
-  
+  class DataLayout;
+  class TargetLibraryInfo;
+
 /// PHITransAddr - An address value which tracks and handles phi translation.
 /// As we walk "up" the CFG through predecessors, we need to ensure that the
 /// address we're tracking is kept up to date.  For example, if we're analyzing
@@ -34,16 +36,29 @@ namespace llvm {
 class PHITransAddr {
   /// Addr - The actual address we're analyzing.
   Value *Addr;
-  
+
+  /// The DataLayout we are playing with.
+  const DataLayout &DL;
+
+  /// TLI - The target library info if known, otherwise null.
+  const TargetLibraryInfo *TLI;
+
+  /// A cache of @llvm.assume calls used by SimplifyInstruction.
+  AssumptionCache *AC;
+
   /// InstInputs - The inputs for our symbolic address.
   SmallVector<Instruction*, 4> InstInputs;
+
 public:
-  PHITransAddr(Value *addr) : Addr(addr) {
+  PHITransAddr(Value *addr, const DataLayout &DL, AssumptionCache *AC)
+      : Addr(addr), DL(DL), TLI(nullptr), AC(AC) {
     // If the address is an instruction, the whole thing is considered an input.
     if (Instruction *I = dyn_cast<Instruction>(Addr))
       InstInputs.push_back(I);
   }
-  
+
+  Value *getAddr() const { return Addr; }
+
   /// NeedsPHITranslationFromBlock - Return true if moving from the specified
   /// BasicBlock to its predecessors requires PHI translation.
   bool NeedsPHITranslationFromBlock(BasicBlock *BB) const {
@@ -54,36 +69,57 @@ public:
         return true;
     return false;
   }
-  
-  /// IsPHITranslatable - If this needs PHI translation, return true if we have
-  /// some hope of doing it.  This should be used as a filter to avoid calling
-  /// GetPHITranslatedValue in hopeless situations.
-  bool IsPHITranslatable() const;
-  
-  /// GetPHITranslatedValue - Given a computation that satisfied the
-  /// isPHITranslatable predicate, see if we can translate the computation into
-  /// the specified predecessor block.  If so, return that value, otherwise
-  /// return null.
-  Value *GetPHITranslatedValue(Value *InVal, BasicBlock *CurBB,
-                               BasicBlock *Pred, const TargetData *TD) const;
-  
-  /// GetAvailablePHITranslatePointer - Return the value computed by
-  /// PHITranslatePointer if it dominates PredBB, otherwise return null.
-  Value *GetAvailablePHITranslatedValue(Value *V,
-                                        BasicBlock *CurBB, BasicBlock *PredBB,
-                                        const TargetData *TD,
-                                        const DominatorTree &DT) const;
-  
-  /// InsertPHITranslatedPointer - Insert a computation of the PHI translated
+
+  /// IsPotentiallyPHITranslatable - If this needs PHI translation, return true
+  /// if we have some hope of doing it.  This should be used as a filter to
+  /// avoid calling PHITranslateValue in hopeless situations.
+  bool IsPotentiallyPHITranslatable() const;
+
+  /// PHITranslateValue - PHI translate the current address up the CFG from
+  /// CurBB to Pred, updating our state to reflect any needed changes.  If
+  /// 'MustDominate' is true, the translated value must dominate
+  /// PredBB.  This returns true on failure and sets Addr to null.
+  bool PHITranslateValue(BasicBlock *CurBB, BasicBlock *PredBB,
+                         const DominatorTree *DT, bool MustDominate);
+
+  /// PHITranslateWithInsertion - PHI translate this value into the specified
+  /// predecessor block, inserting a computation of the value if it is
+  /// unavailable.
+  ///
+  /// All newly created instructions are added to the NewInsts list.  This
+  /// returns null on failure.
+  ///
+  Value *PHITranslateWithInsertion(BasicBlock *CurBB, BasicBlock *PredBB,
+                                   const DominatorTree &DT,
+                                   SmallVectorImpl<Instruction *> &NewInsts);
+
+  void dump() const;
+
+  /// Verify - Check internal consistency of this data structure.  If the
+  /// structure is valid, it returns true.  If invalid, it prints errors and
+  /// returns false.
+  bool Verify() const;
+
+private:
+  Value *PHITranslateSubExpr(Value *V, BasicBlock *CurBB, BasicBlock *PredBB,
+                             const DominatorTree *DT);
+
+  /// InsertPHITranslatedSubExpr - Insert a computation of the PHI translated
   /// version of 'V' for the edge PredBB->CurBB into the end of the PredBB
   /// block.  All newly created instructions are added to the NewInsts list.
   /// This returns null on failure.
   ///
-  Value *InsertPHITranslatedPointer(Value *InVal, BasicBlock *CurBB,
-                                    BasicBlock *PredBB, const TargetData *TD,
-                                    const DominatorTree &DT,
-                                 SmallVectorImpl<Instruction*> &NewInsts) const;
-    
+  Value *InsertPHITranslatedSubExpr(Value *InVal, BasicBlock *CurBB,
+                                    BasicBlock *PredBB, const DominatorTree &DT,
+                                    SmallVectorImpl<Instruction *> &NewInsts);
+
+  /// AddAsInput - If the specified value is an instruction, add it as an input.
+  Value *AddAsInput(Value *V) {
+    // If V is an instruction, it is now an input.
+    if (Instruction *VI = dyn_cast<Instruction>(V))
+      InstInputs.push_back(VI);
+    return V;
+  }
 };
 
 } // end namespace llvm