1 //== Environment.h - Map from Stmt* to Locations/Values ---------*- 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 file defined the Environment and EnvironmentManager classes.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CLANG_GR_ENVIRONMENT_H
15 #define LLVM_CLANG_GR_ENVIRONMENT_H
17 #include "clang/Analysis/AnalysisContext.h"
18 #include "clang/StaticAnalyzer/Core/PathSensitive/SVals.h"
19 #include "llvm/ADT/ImmutableMap.h"
27 class EnvironmentManager;
30 /// An entry in the environment consists of a Stmt and an LocationContext.
31 /// This allows the environment to manage context-sensitive bindings,
32 /// which is essentially for modeling recursive function analysis, among
34 class EnvironmentEntry : public std::pair<const Stmt*,
35 const StackFrameContext *> {
37 EnvironmentEntry(const Stmt *s, const LocationContext *L)
38 : std::pair<const Stmt*,
39 const StackFrameContext*>(s, L ? L->getCurrentStackFrame():0) {}
41 const Stmt *getStmt() const { return first; }
42 const LocationContext *getLocationContext() const { return second; }
44 /// Profile an EnvironmentEntry for inclusion in a FoldingSet.
45 static void Profile(llvm::FoldingSetNodeID &ID,
46 const EnvironmentEntry &E) {
47 ID.AddPointer(E.getStmt());
48 ID.AddPointer(E.getLocationContext());
51 void Profile(llvm::FoldingSetNodeID &ID) const {
56 /// An immutable map from EnvironemntEntries to SVals.
59 friend class EnvironmentManager;
62 typedef llvm::ImmutableMap<EnvironmentEntry, SVal> BindingsTy;
65 BindingsTy ExprBindings;
67 Environment(BindingsTy eb)
70 SVal lookupExpr(const EnvironmentEntry &E) const;
73 typedef BindingsTy::iterator iterator;
74 iterator begin() const { return ExprBindings.begin(); }
75 iterator end() const { return ExprBindings.end(); }
77 /// Fetches the current binding of the expression in the
79 SVal getSVal(const EnvironmentEntry &E,
80 SValBuilder &svalBuilder,
81 bool useOnlyDirectBindings = false) const;
83 /// Profile - Profile the contents of an Environment object for use
85 static void Profile(llvm::FoldingSetNodeID& ID, const Environment* env) {
86 env->ExprBindings.Profile(ID);
89 /// Profile - Used to profile the contents of this object for inclusion
91 void Profile(llvm::FoldingSetNodeID& ID) const {
95 bool operator==(const Environment& RHS) const {
96 return ExprBindings == RHS.ExprBindings;
99 void print(raw_ostream &Out, const char *NL, const char *Sep) const;
102 void printAux(raw_ostream &Out, bool printLocations,
103 const char *NL, const char *Sep) const;
106 class EnvironmentManager {
108 typedef Environment::BindingsTy::Factory FactoryTy;
112 EnvironmentManager(llvm::BumpPtrAllocator& Allocator) : F(Allocator) {}
113 ~EnvironmentManager() {}
115 Environment getInitialEnvironment() {
116 return Environment(F.getEmptyMap());
119 /// Bind a symbolic value to the given environment entry.
120 Environment bindExpr(Environment Env, const EnvironmentEntry &E, SVal V,
123 /// Bind the location 'location' and value 'V' to the specified
124 /// environment entry.
125 Environment bindExprAndLocation(Environment Env,
126 const EnvironmentEntry &E,
130 Environment removeDeadBindings(Environment Env,
131 SymbolReaper &SymReaper,
132 ProgramStateRef state);
135 } // end GR namespace
137 } // end clang namespace