[PM/AA] Move the LibCall AA creation routine declaration to that
[oota-llvm.git] / include / llvm / Analysis / LibCallAliasAnalysis.h
index 7944af3b8a5a0765ceb59221fd8dc39db470c22d..6a93b004501542395b6a903350c4900017b656ab 100644 (file)
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef LLVM_ANALYSIS_LIBCALL_AA_H
-#define LLVM_ANALYSIS_LIBCALL_AA_H
+#ifndef LLVM_ANALYSIS_LIBCALLALIASANALYSIS_H
+#define LLVM_ANALYSIS_LIBCALLALIASANALYSIS_H
 
 #include "llvm/Analysis/AliasAnalysis.h"
+#include "llvm/IR/Module.h"
 #include "llvm/Pass.h"
 
 namespace llvm {
-  class LibCallInfo;
-  struct LibCallFunctionInfo;
-  
-  /// LibCallAliasAnalysis - Alias analysis driven from LibCallInfo.
-  struct LibCallAliasAnalysis : public FunctionPass, public AliasAnalysis {
-    static char ID; // Class identification
-    
-    LibCallInfo *LCI;
-    
-    explicit LibCallAliasAnalysis(LibCallInfo *LC = 0)
-      : FunctionPass(&ID), LCI(LC) {
-    }
-    explicit LibCallAliasAnalysis(const void *ID, LibCallInfo *LC)
+
+class LibCallInfo;
+struct LibCallFunctionInfo;
+
+/// LibCallAliasAnalysis - Alias analysis driven from LibCallInfo.
+struct LibCallAliasAnalysis : public FunctionPass, public AliasAnalysis {
+  static char ID; // Class identification
+
+  LibCallInfo *LCI;
+
+  explicit LibCallAliasAnalysis(LibCallInfo *LC = nullptr)
       : FunctionPass(ID), LCI(LC) {
-    }
-    ~LibCallAliasAnalysis();
-    
-    ModRefResult getModRefInfo(CallSite CS, Value *P, unsigned Size);
-    
-    ModRefResult getModRefInfo(CallSite CS1, CallSite CS2) {
-      // TODO: Could compare two direct calls against each other if we cared to.
-      return AliasAnalysis::getModRefInfo(CS1,CS2);
-    }
-    
-    virtual void getAnalysisUsage(AnalysisUsage &AU) const;
-    
-    virtual bool runOnFunction(Function &F) {
-      InitializeAliasAnalysis(this);                 // set up super class
-      return false;
-    }
-    
-    /// hasNoModRefInfoForCalls - We can provide mod/ref information against
-    /// non-escaping allocations.
-    virtual bool hasNoModRefInfoForCalls() const { return false; }
-  private:
-    ModRefResult AnalyzeLibCallDetails(const LibCallFunctionInfo *FI,
-                                       CallSite CS, Value *P, unsigned Size);
-  };
-}  // End of llvm namespace
+    initializeLibCallAliasAnalysisPass(*PassRegistry::getPassRegistry());
+  }
+  explicit LibCallAliasAnalysis(char &ID, LibCallInfo *LC)
+      : FunctionPass(ID), LCI(LC) {
+    initializeLibCallAliasAnalysisPass(*PassRegistry::getPassRegistry());
+  }
+  ~LibCallAliasAnalysis() override;
+
+  ModRefInfo getModRefInfo(ImmutableCallSite CS,
+                           const MemoryLocation &Loc) override;
+
+  ModRefInfo getModRefInfo(ImmutableCallSite CS1,
+                           ImmutableCallSite CS2) override {
+    // TODO: Could compare two direct calls against each other if we cared to.
+    return AliasAnalysis::getModRefInfo(CS1, CS2);
+  }
+
+  void getAnalysisUsage(AnalysisUsage &AU) const override;
+
+  bool runOnFunction(Function &F) override;
+
+  /// getAdjustedAnalysisPointer - This method is used when a pass implements
+  /// an analysis interface through multiple inheritance.  If needed, it
+  /// should override this to adjust the this pointer as needed for the
+  /// specified pass info.
+  void *getAdjustedAnalysisPointer(const void *PI) override {
+    if (PI == &AliasAnalysis::ID)
+      return (AliasAnalysis *)this;
+    return this;
+  }
+
+private:
+  ModRefInfo AnalyzeLibCallDetails(const LibCallFunctionInfo *FI,
+                                   ImmutableCallSite CS,
+                                   const MemoryLocation &Loc);
+};
+
+/// createLibCallAliasAnalysisPass - Create an alias analysis pass that knows
+/// about the semantics of a set of libcalls specified by LCI.  The newly
+/// constructed pass takes ownership of the pointer that is provided.
+///
+FunctionPass *createLibCallAliasAnalysisPass(LibCallInfo *LCI);
+
+} // End of llvm namespace
 
 #endif