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);
39 const Stmt *getStmt() const { return first; }
40 const LocationContext *getLocationContext() const { return second; }
42 /// Profile an EnvironmentEntry for inclusion in a FoldingSet.
43 static void Profile(llvm::FoldingSetNodeID &ID,
44 const EnvironmentEntry &E) {
45 ID.AddPointer(E.getStmt());
46 ID.AddPointer(E.getLocationContext());
49 void Profile(llvm::FoldingSetNodeID &ID) const {
54 /// An immutable map from EnvironemntEntries to SVals.
57 friend class EnvironmentManager;
60 typedef llvm::ImmutableMap<EnvironmentEntry, SVal> BindingsTy;
63 BindingsTy ExprBindings;
65 Environment(BindingsTy eb)
68 SVal lookupExpr(const EnvironmentEntry &E) const;
71 typedef BindingsTy::iterator iterator;
72 iterator begin() const { return ExprBindings.begin(); }
73 iterator end() const { return ExprBindings.end(); }
75 /// Fetches the current binding of the expression in the
77 SVal getSVal(const EnvironmentEntry &E, SValBuilder &svalBuilder) const;
79 /// Profile - Profile the contents of an Environment object for use
81 static void Profile(llvm::FoldingSetNodeID& ID, const Environment* env) {
82 env->ExprBindings.Profile(ID);
85 /// Profile - Used to profile the contents of this object for inclusion
87 void Profile(llvm::FoldingSetNodeID& ID) const {
91 bool operator==(const Environment& RHS) const {
92 return ExprBindings == RHS.ExprBindings;
95 void print(raw_ostream &Out, const char *NL, const char *Sep) const;
98 void printAux(raw_ostream &Out, bool printLocations,
99 const char *NL, const char *Sep) const;
102 class EnvironmentManager {
104 typedef Environment::BindingsTy::Factory FactoryTy;
108 EnvironmentManager(llvm::BumpPtrAllocator& Allocator) : F(Allocator) {}
109 ~EnvironmentManager() {}
111 Environment getInitialEnvironment() {
112 return Environment(F.getEmptyMap());
115 /// Bind a symbolic value to the given environment entry.
116 Environment bindExpr(Environment Env, const EnvironmentEntry &E, SVal V,
119 Environment removeDeadBindings(Environment Env,
120 SymbolReaper &SymReaper,
121 ProgramStateRef state);
124 } // end GR namespace
126 } // end clang namespace