include/llvm/Analysis/ScalarEvolutionAliasAnalysis.h

   1 //===- ScalarEvolutionAliasAnalysis.h - SCEV-based AA -----------*- 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 /// \file
  10 /// This is the interface for a SCEV-based alias analysis.
  11 ///
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_ANALYSIS_SCALAREVOLUTIONALIASANALYSIS_H
  15 #define LLVM_ANALYSIS_SCALAREVOLUTIONALIASANALYSIS_H
  16
  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"
  22
  23 namespace llvm {
  24
  25 /// A simple alias analysis implementation that uses ScalarEvolution to answer
  26 /// queries.
  27 class SCEVAAResult : public AAResultBase<SCEVAAResult> {
  28   ScalarEvolution &SE;
  29
  30 public:
  31   explicit SCEVAAResult(const TargetLibraryInfo &TLI, ScalarEvolution &SE)
  32       : AAResultBase(TLI), SE(SE) {}
  33   SCEVAAResult(SCEVAAResult &&Arg) : AAResultBase(std::move(Arg)), SE(Arg.SE) {}
  34
  35   AliasResult alias(const MemoryLocation &LocA, const MemoryLocation &LocB);
  36
  37 private:
  38   Value *GetBaseValue(const SCEV *S);
  39 };
  40
  41 /// Analysis pass providing a never-invalidated alias analysis result.
  42 class SCEVAA {
  43 public:
  44   typedef SCEVAAResult Result;
  45
  46   /// \brief Opaque, unique identifier for this analysis pass.
  47   static void *ID() { return (void *)&PassID; }
  48
  49   SCEVAAResult run(Function &F, AnalysisManager<Function> *AM);
  50
  51   /// \brief Provide access to a name for this pass for debugging purposes.
  52   static StringRef name() { return "SCEVAA"; }
  53
  54 private:
  55   static char PassID;
  56 };
  57
  58 /// Legacy wrapper pass to provide the SCEVAAResult object.
  59 class SCEVAAWrapperPass : public FunctionPass {
  60   std::unique_ptr<SCEVAAResult> Result;
  61
  62 public:
  63   static char ID;
  64
  65   SCEVAAWrapperPass();
  66
  67   SCEVAAResult &getResult() { return *Result; }
  68   const SCEVAAResult &getResult() const { return *Result; }
  69
  70   bool runOnFunction(Function &F) override;
  71   void getAnalysisUsage(AnalysisUsage &AU) const override;
  72 };
  73
  74 /// Creates an instance of \c SCEVAAWrapperPass.
  75 FunctionPass *createSCEVAAWrapperPass();
  76
  77 }
  78
  79 #endif