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 *> {
36 friend class EnvironmentManager;
37 EnvironmentEntry makeLocation() const;
40 EnvironmentEntry(const Stmt *s, const LocationContext *L);
42 const Stmt *getStmt() const { return first; }
43 const LocationContext *getLocationContext() const { return second; }
45 /// Profile an EnvironmentEntry for inclusion in a FoldingSet.
46 static void Profile(llvm::FoldingSetNodeID &ID,
47 const EnvironmentEntry &E) {
48 ID.AddPointer(E.getStmt());
49 ID.AddPointer(E.getLocationContext());
52 void Profile(llvm::FoldingSetNodeID &ID) const {
57 /// An immutable map from EnvironemntEntries to SVals.
60 friend class EnvironmentManager;
63 typedef llvm::ImmutableMap<EnvironmentEntry, SVal> BindingsTy;
66 BindingsTy ExprBindings;
68 Environment(BindingsTy eb)
71 SVal lookupExpr(const EnvironmentEntry &E) const;
74 typedef BindingsTy::iterator iterator;
75 iterator begin() const { return ExprBindings.begin(); }
76 iterator end() const { return ExprBindings.end(); }
78 /// Fetches the current binding of the expression in the
80 SVal getSVal(const EnvironmentEntry &E, SValBuilder &svalBuilder) const;
82 /// Profile - Profile the contents of an Environment object for use
84 static void Profile(llvm::FoldingSetNodeID& ID, const Environment* env) {
85 env->ExprBindings.Profile(ID);
88 /// Profile - Used to profile the contents of this object for inclusion
90 void Profile(llvm::FoldingSetNodeID& ID) const {
94 bool operator==(const Environment& RHS) const {
95 return ExprBindings == RHS.ExprBindings;
98 void print(raw_ostream &Out, const char *NL, const char *Sep) const;
101 void printAux(raw_ostream &Out, bool printLocations,
102 const char *NL, const char *Sep) const;
105 class EnvironmentManager {
107 typedef Environment::BindingsTy::Factory FactoryTy;
111 EnvironmentManager(llvm::BumpPtrAllocator& Allocator) : F(Allocator) {}
112 ~EnvironmentManager() {}
114 Environment getInitialEnvironment() {
115 return Environment(F.getEmptyMap());
118 /// Bind a symbolic value to the given environment entry.
119 Environment bindExpr(Environment Env, const EnvironmentEntry &E, SVal V,
122 /// Bind the location 'location' and value 'V' to the specified
123 /// environment entry.
124 Environment bindExprAndLocation(Environment Env,
125 const EnvironmentEntry &E,
129 Environment removeDeadBindings(Environment Env,
130 SymbolReaper &SymReaper,
131 ProgramStateRef state);
134 } // end GR namespace
136 } // end clang namespace