include/llvm/Analysis/MemoryDependenceAnalysis.h

   1 //===- llvm/Analysis/MemoryDependenceAnalysis.h - Memory Deps  --*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the Owen Anderson and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines an analysis that determines, for a given memory operation,
  11 // what preceding memory operations it depends on.  It builds on alias analysis
  12 // information, and tries to provide a lazy, caching interface to a common kind
  13 // of alias information query.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef LLVM_ANALYSIS_MEMORY_DEPENDENCE_H
  18 #define LLVM_ANALYSIS_MEMORY_DEPENDENCE_H
  19
  20 #include "llvm/Pass.h"
  21 #include "llvm/Support/CallSite.h"
  22 #include "llvm/ADT/DenseMap.h"
  23 #include "llvm/ADT/SmallPtrSet.h"
  24 #include "llvm/Support/Compiler.h"
  25
  26 namespace llvm {
  27
  28 class Function;
  29 class FunctionPass;
  30 class Instruction;
  31
  32 class MemoryDependenceAnalysis : public FunctionPass {
  33   private:
  34     // A map from instructions to their dependency, with a boolean
  35     // flags for whether this mapping is confirmed or not
  36     typedef DenseMap<Instruction*, std::pair<Instruction*, bool> >
  37             depMapType;
  38     depMapType depGraphLocal;
  39
  40     // A map from instructions to their non-local dependencies.
  41     typedef DenseMap<Instruction*, DenseMap<BasicBlock*, Value*> >
  42             nonLocalDepMapType;
  43     nonLocalDepMapType depGraphNonLocal;
  44
  45     // A reverse mapping form dependencies to the dependees.  This is
  46     // used when removing instructions to keep the cache coherent.
  47     typedef DenseMap<Value*, SmallPtrSet<Instruction*, 4> >
  48             reverseDepMapType;
  49     reverseDepMapType reverseDep;
  50
  51     // A reverse mapping form dependencies to the non-local dependees.
  52     reverseDepMapType reverseDepNonLocal;
  53
  54   public:
  55     // Special marker indicating that the query has no dependency
  56     // in the specified block.
  57     static Instruction* const NonLocal;
  58
  59     // Special marker indicating that the query has no dependency at all
  60     static Instruction* const None;
  61
  62
  63     // Special marker indicating a dirty cache entry
  64     static Instruction* const Dirty;
  65
  66     static char ID; // Class identification, replacement for typeinfo
  67     MemoryDependenceAnalysis() : FunctionPass((intptr_t)&ID) {}
  68
  69     /// Pass Implementation stuff.  This doesn't do any analysis.
  70     ///
  71     bool runOnFunction(Function &) {return false; }
  72
  73     /// Clean up memory in between runs
  74     void releaseMemory() {
  75       depGraphLocal.clear();
  76       depGraphNonLocal.clear();
  77       reverseDep.clear();
  78       reverseDepNonLocal.clear();
  79     }
  80
  81     /// getAnalysisUsage - Does not modify anything.  It uses Value Numbering
  82     /// and Alias Analysis.
  83     ///
  84     virtual void getAnalysisUsage(AnalysisUsage &AU) const;
  85
  86     /// getDependency - Return the instruction on which a memory operation
  87     /// depends, starting with start.
  88     Instruction* getDependency(Instruction* query, Instruction* start = 0,
  89                                BasicBlock* block = 0);
  90
  91     /// getNonLocalDependency - Fills the passed-in map with the non-local
  92     /// dependencies of the queries.  The map will contain NonLocal for
  93     /// blocks between the query and its dependencies.
  94     void getNonLocalDependency(Instruction* query,
  95                                DenseMap<BasicBlock*, Value*>& resp);
  96
  97     /// removeInstruction - Remove an instruction from the dependence analysis,
  98     /// updating the dependence of instructions that previously depended on it.
  99     void removeInstruction(Instruction* rem);
 100
 101   private:
 102     Instruction* getCallSiteDependency(CallSite C, Instruction* start,
 103                                        BasicBlock* block);
 104     void nonLocalHelper(Instruction* query, BasicBlock* block,
 105                         DenseMap<BasicBlock*, Value*>& resp);
 106   };
 107
 108 } // End llvm namespace
 109
 110 #endif