[PM/AA] Remove the function names and class names from doxygen comments

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

diff --git a/include/llvm/Analysis/LibCallAliasAnalysis.h b/include/llvm/Analysis/LibCallAliasAnalysis.h
index c9adf3f36ad74507b077735174f47ee503d40cce..5193958ff4c01c82fb79d5b02ef626f95c6a9437 100644 (file)
--- a/include/llvm/Analysis/LibCallAliasAnalysis.h
+++ b/include/llvm/Analysis/LibCallAliasAnalysis.h
@@ -11,61 +11,70 @@
 //
 //===----------------------------------------------------------------------===//
 
-#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)
+
+class LibCallInfo;
+struct LibCallFunctionInfo;
+
+/// 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) {
-    }
-    explicit LibCallAliasAnalysis(char &ID, LibCallInfo *LC)
+    initializeLibCallAliasAnalysisPass(*PassRegistry::getPassRegistry());
+  }
+  explicit LibCallAliasAnalysis(char &ID, LibCallInfo *LC)
       : FunctionPass(ID), LCI(LC) {
-    }
-    ~LibCallAliasAnalysis();
-    
-    ModRefResult getModRefInfo(ImmutableCallSite CS,
-                               const Value *P, unsigned Size);
-    
-    ModRefResult getModRefInfo(ImmutableCallSite CS1,
-                               ImmutableCallSite 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;
-    }
-    
-    /// 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.
-    virtual void *getAdjustedAnalysisPointer(const void *PI) {
-      if (PI == &AliasAnalysis::ID)
-        return (AliasAnalysis*)this;
-      return this;
-    }
-    
-  private:
-    ModRefResult AnalyzeLibCallDetails(const LibCallFunctionInfo *FI,
-                                       ImmutableCallSite CS,
-                                       const Value *P, unsigned Size);
-  };
-}  // End of llvm namespace
+    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;
+
+  /// 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);
+};
+
+/// 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