include/llvm/Analysis/LibCallAliasAnalysis.h

   1 //===- LibCallAliasAnalysis.h - Implement AliasAnalysis for libcalls ------===//
   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 //
  10 // This file defines the LibCallAliasAnalysis class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_ANALYSIS_LIBCALLALIASANALYSIS_H
  15 #define LLVM_ANALYSIS_LIBCALLALIASANALYSIS_H
  16
  17 #include "llvm/Analysis/AliasAnalysis.h"
  18 #include "llvm/IR/Module.h"
  19 #include "llvm/Pass.h"
  20
  21 namespace llvm {
  22
  23 class LibCallInfo;
  24 struct LibCallFunctionInfo;
  25
  26 /// Alias analysis driven from LibCallInfo.
  27 struct LibCallAliasAnalysis : public FunctionPass, public AliasAnalysis {
  28   static char ID; // Class identification
  29
  30   LibCallInfo *LCI;
  31
  32   explicit LibCallAliasAnalysis(LibCallInfo *LC = nullptr)
  33       : FunctionPass(ID), LCI(LC) {
  34     initializeLibCallAliasAnalysisPass(*PassRegistry::getPassRegistry());
  35   }
  36   explicit LibCallAliasAnalysis(char &ID, LibCallInfo *LC)
  37       : FunctionPass(ID), LCI(LC) {
  38     initializeLibCallAliasAnalysisPass(*PassRegistry::getPassRegistry());
  39   }
  40   ~LibCallAliasAnalysis() override;
  41
  42   ModRefInfo getModRefInfo(ImmutableCallSite CS,
  43                            const MemoryLocation &Loc) override;
  44
  45   ModRefInfo getModRefInfo(ImmutableCallSite CS1,
  46                            ImmutableCallSite CS2) override {
  47     // TODO: Could compare two direct calls against each other if we cared to.
  48     return AliasAnalysis::getModRefInfo(CS1, CS2);
  49   }
  50
  51   void getAnalysisUsage(AnalysisUsage &AU) const override;
  52
  53   bool runOnFunction(Function &F) override;
  54
  55   /// This method is used when a pass implements an analysis interface through
  56   /// multiple inheritance.
  57   ///
  58   /// If needed, it should override this to adjust the this pointer as needed
  59   /// for the specified pass info.
  60   void *getAdjustedAnalysisPointer(const void *PI) override {
  61     if (PI == &AliasAnalysis::ID)
  62       return (AliasAnalysis *)this;
  63     return this;
  64   }
  65
  66 private:
  67   ModRefInfo AnalyzeLibCallDetails(const LibCallFunctionInfo *FI,
  68                                    ImmutableCallSite CS,
  69                                    const MemoryLocation &Loc);
  70 };
  71
  72 /// Create an alias analysis pass that knows about the semantics of a set of
  73 /// libcalls specified by LCI.
  74 ///
  75 /// The newly constructed pass takes ownership of the pointer that is provided.
  76 FunctionPass *createLibCallAliasAnalysisPass(LibCallInfo *LCI);
  77
  78 } // End of llvm namespace
  79
  80 #endif