1 //===- ScalarEvolutionAliasAnalysis.h - SCEV-based AA -----------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 /// This is the interface for a SCEV-based alias analysis.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_ANALYSIS_SCALAREVOLUTIONALIASANALYSIS_H
15 #define LLVM_ANALYSIS_SCALAREVOLUTIONALIASANALYSIS_H
17 #include "llvm/Analysis/AliasAnalysis.h"
18 #include "llvm/Analysis/ScalarEvolutionExpressions.h"
19 #include "llvm/IR/Function.h"
20 #include "llvm/IR/Module.h"
21 #include "llvm/Pass.h"
25 /// A simple alias analysis implementation that uses ScalarEvolution to answer
27 class SCEVAAResult : public AAResultBase<SCEVAAResult> {
31 explicit SCEVAAResult(ScalarEvolution &SE) : AAResultBase(), SE(SE) {}
32 SCEVAAResult(SCEVAAResult &&Arg) : AAResultBase(std::move(Arg)), SE(Arg.SE) {}
34 AliasResult alias(const MemoryLocation &LocA, const MemoryLocation &LocB);
37 Value *GetBaseValue(const SCEV *S);
40 /// Analysis pass providing a never-invalidated alias analysis result.
41 class SCEVAA : public AnalysisInfoMixin<SCEVAA> {
42 friend AnalysisInfoMixin<SCEVAA>;
43 static AnalysisKey Key;
46 typedef SCEVAAResult Result;
48 SCEVAAResult run(Function &F, FunctionAnalysisManager &AM);
51 /// Legacy wrapper pass to provide the SCEVAAResult object.
52 class SCEVAAWrapperPass : public FunctionPass {
53 std::unique_ptr<SCEVAAResult> Result;
60 SCEVAAResult &getResult() { return *Result; }
61 const SCEVAAResult &getResult() const { return *Result; }
63 bool runOnFunction(Function &F) override;
64 void getAnalysisUsage(AnalysisUsage &AU) const override;
67 /// Creates an instance of \c SCEVAAWrapperPass.
68 FunctionPass *createSCEVAAWrapperPass();