include/clang/StaticAnalyzer/EntoSA/PathSensitive/Environment.h

   1 //== Environment.h - Map from Stmt* to Locations/Values ---------*- 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 //
  10 //  This file defined the Environment and EnvironmentManager classes.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_CLANG_GR_ENVIRONMENT_H
  15 #define LLVM_CLANG_GR_ENVIRONMENT_H
  16
  17 #include "clang/StaticAnalyzer/PathSensitive/Store.h"
  18 #include "clang/StaticAnalyzer/PathSensitive/SVals.h"
  19 #include "llvm/ADT/ImmutableMap.h"
  20
  21 namespace clang {
  22
  23 class LiveVariables;
  24
  25 namespace ento {
  26
  27 class EnvironmentManager;
  28 class SValBuilder;
  29
  30 /// Environment - An immutable map from Stmts to their current
  31 ///  symbolic values (SVals).
  32 ///
  33 class Environment {
  34 private:
  35   friend class EnvironmentManager;
  36
  37   // Type definitions.
  38   typedef llvm::ImmutableMap<const Stmt*,SVal> BindingsTy;
  39
  40   // Data.
  41   BindingsTy ExprBindings;
  42
  43   Environment(BindingsTy eb)
  44     : ExprBindings(eb) {}
  45
  46   SVal lookupExpr(const Stmt* E) const;
  47
  48 public:
  49   typedef BindingsTy::iterator iterator;
  50   iterator begin() const { return ExprBindings.begin(); }
  51   iterator end() const { return ExprBindings.end(); }
  52
  53
  54   /// GetSVal - Fetches the current binding of the expression in the
  55   ///  Environment.
  56   SVal getSVal(const Stmt* Ex, SValBuilder& svalBuilder) const;
  57
  58   /// Profile - Profile the contents of an Environment object for use
  59   ///  in a FoldingSet.
  60   static void Profile(llvm::FoldingSetNodeID& ID, const Environment* env) {
  61     env->ExprBindings.Profile(ID);
  62   }
  63
  64   /// Profile - Used to profile the contents of this object for inclusion
  65   ///  in a FoldingSet.
  66   void Profile(llvm::FoldingSetNodeID& ID) const {
  67     Profile(ID, this);
  68   }
  69
  70   bool operator==(const Environment& RHS) const {
  71     return ExprBindings == RHS.ExprBindings;
  72   }
  73 };
  74
  75 class EnvironmentManager {
  76 private:
  77   typedef Environment::BindingsTy::Factory FactoryTy;
  78   FactoryTy F;
  79
  80 public:
  81   EnvironmentManager(llvm::BumpPtrAllocator& Allocator) : F(Allocator) {}
  82   ~EnvironmentManager() {}
  83
  84   Environment getInitialEnvironment() {
  85     return Environment(F.getEmptyMap());
  86   }
  87
  88   /// Bind the value 'V' to the statement 'S'.
  89   Environment bindExpr(Environment Env, const Stmt *S, SVal V,
  90                        bool Invalidate);
  91
  92   /// Bind the location 'location' and value 'V' to the statement 'S'.  This
  93   /// is used when simulating loads/stores.
  94   Environment bindExprAndLocation(Environment Env, const Stmt *S, SVal location,
  95                                   SVal V);
  96
  97   Environment RemoveDeadBindings(Environment Env,
  98                                  SymbolReaper &SymReaper, const GRState *ST,
  99                           llvm::SmallVectorImpl<const MemRegion*>& RegionRoots);
 100 };
 101
 102 } // end GR namespace
 103
 104 } // end clang namespace
 105
 106 #endif