CheckerManager.h revision e1bfb7ae0dd0762c88e1fd94746e973c37f2e04e
1//===--- CheckerManager.h - Static Analyzer Checker Manager -----*- 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// Defines the Static Analyzer Checker Manager. 11// 12//===----------------------------------------------------------------------===// 13 14#ifndef LLVM_CLANG_SA_CORE_CHECKERMANAGER_H 15#define LLVM_CLANG_SA_CORE_CHECKERMANAGER_H 16 17#include "clang/Basic/LangOptions.h" 18#include "llvm/ADT/SmallVector.h" 19#include "llvm/ADT/DenseMap.h" 20#include "llvm/ADT/FoldingSet.h" 21#include <vector> 22 23namespace clang { 24 class Decl; 25 class Stmt; 26 class CallExpr; 27 28namespace ento { 29 class ExprEngine; 30 class AnalysisManager; 31 class BugReporter; 32 class CheckerContext; 33 class ObjCMessage; 34 class SVal; 35 class ExplodedNode; 36 class ExplodedNodeSet; 37 class ExplodedGraph; 38 class GRState; 39 40class GraphExpander { 41public: 42 virtual ~GraphExpander(); 43 virtual void expandGraph(ExplodedNodeSet &Dst, ExplodedNode *Pred) = 0; 44}; 45 46struct VoidCheckerFnParm {}; 47template <typename P1=VoidCheckerFnParm, typename P2=VoidCheckerFnParm, 48 typename P3=VoidCheckerFnParm, typename P4=VoidCheckerFnParm> 49class CheckerFn { 50 typedef void (*Func)(void *, P1, P2, P3, P4); 51 Func Fn; 52public: 53 void *Checker; 54 CheckerFn(void *checker, Func fn) : Fn(fn), Checker(checker) { } 55 void operator()(P1 p1, P2 p2, P3 p3, P4 p4) { Fn(Checker, p1, p2, p3, p4); } 56}; 57 58template <typename P1, typename P2, typename P3> 59class CheckerFn<P1, P2, P3, VoidCheckerFnParm> { 60 typedef void (*Func)(void *, P1, P2, P3); 61 Func Fn; 62public: 63 void *Checker; 64 CheckerFn(void *checker, Func fn) : Fn(fn), Checker(checker) { } 65 void operator()(P1 p1, P2 p2, P3 p3) { Fn(Checker, p1, p2, p3); } 66}; 67 68template <typename P1, typename P2> 69class CheckerFn<P1, P2, VoidCheckerFnParm, VoidCheckerFnParm> { 70 typedef void (*Func)(void *, P1, P2); 71 Func Fn; 72public: 73 void *Checker; 74 CheckerFn(void *checker, Func fn) : Fn(fn), Checker(checker) { } 75 void operator()(P1 p1, P2 p2) { Fn(Checker, p1, p2); } 76}; 77 78template <> 79class CheckerFn<VoidCheckerFnParm, VoidCheckerFnParm, VoidCheckerFnParm, 80 VoidCheckerFnParm> { 81 typedef void (*Func)(void *); 82 Func Fn; 83public: 84 void *Checker; 85 CheckerFn(void *checker, Func fn) : Fn(fn), Checker(checker) { } 86 void operator()() { Fn(Checker); } 87}; 88 89class CheckerManager { 90 const LangOptions LangOpts; 91 92public: 93 CheckerManager(const LangOptions &langOpts) : LangOpts(langOpts) { } 94 ~CheckerManager(); 95 96 const LangOptions &getLangOptions() const { return LangOpts; } 97 98 typedef void *CheckerRef; 99 typedef CheckerFn<> CheckerDtor; 100 101//===----------------------------------------------------------------------===// 102// registerChecker 103//===----------------------------------------------------------------------===// 104 105 /// \brief Used to register checkers. 106 template <typename CHECKER> 107 void registerChecker() { 108 CHECKER *checker = new CHECKER(); 109 CheckerDtors.push_back(CheckerDtor(checker, destruct<CHECKER>)); 110 CHECKER::_register(checker, *this); 111 } 112 113 typedef void (*RegisterToEngFunc)(ExprEngine &Eng); 114 void addCheckerRegisterFunction(RegisterToEngFunc fn) { 115 Funcs.push_back(fn); 116 } 117 118//===----------------------------------------------------------------------===// 119// Functions for running checkers for AST traversing.. 120//===----------------------------------------------------------------------===// 121 122 /// \brief Run checkers handling Decls. 123 void runCheckersOnASTDecl(const Decl *D, AnalysisManager& mgr, 124 BugReporter &BR); 125 126 /// \brief Run checkers handling Decls containing a Stmt body. 127 void runCheckersOnASTBody(const Decl *D, AnalysisManager& mgr, 128 BugReporter &BR); 129 130//===----------------------------------------------------------------------===// 131// Functions for running checkers for path-sensitive checking. 132//===----------------------------------------------------------------------===// 133 134 /// \brief Run checkers for pre-visiting Stmts. 135 void runCheckersForPreStmt(ExplodedNodeSet &Dst, 136 ExplodedNodeSet &Src, 137 const Stmt *S, 138 ExprEngine &Eng) { 139 runCheckersForStmt(/*isPreVisit=*/true, Dst, Src, S, Eng); 140 } 141 142 /// \brief Run checkers for post-visiting Stmts. 143 void runCheckersForPostStmt(ExplodedNodeSet &Dst, 144 ExplodedNodeSet &Src, 145 const Stmt *S, 146 ExprEngine &Eng) { 147 runCheckersForStmt(/*isPreVisit=*/false, Dst, Src, S, Eng); 148 } 149 150 /// \brief Run checkers for visiting Stmts. 151 void runCheckersForStmt(bool isPreVisit, 152 ExplodedNodeSet &Dst, ExplodedNodeSet &Src, 153 const Stmt *S, ExprEngine &Eng); 154 155 /// \brief Run checkers for pre-visiting obj-c messages. 156 void runCheckersForPreObjCMessage(ExplodedNodeSet &Dst, 157 ExplodedNodeSet &Src, 158 const ObjCMessage &msg, 159 ExprEngine &Eng) { 160 runCheckersForObjCMessage(/*isPreVisit=*/true, Dst, Src, msg, Eng); 161 } 162 163 /// \brief Run checkers for post-visiting obj-c messages. 164 void runCheckersForPostObjCMessage(ExplodedNodeSet &Dst, 165 ExplodedNodeSet &Src, 166 const ObjCMessage &msg, 167 ExprEngine &Eng) { 168 runCheckersForObjCMessage(/*isPreVisit=*/false, Dst, Src, msg, Eng); 169 } 170 171 /// \brief Run checkers for visiting obj-c messages. 172 void runCheckersForObjCMessage(bool isPreVisit, 173 ExplodedNodeSet &Dst, ExplodedNodeSet &Src, 174 const ObjCMessage &msg, ExprEngine &Eng); 175 176 /// \brief Run checkers for load/store of a location. 177 void runCheckersForLocation(ExplodedNodeSet &Dst, 178 ExplodedNodeSet &Src, 179 SVal location, bool isLoad, 180 const Stmt *S, 181 const GRState *state, 182 ExprEngine &Eng); 183 184 /// \brief Run checkers for end of analysis. 185 void runCheckersForEndAnalysis(ExplodedGraph &G, BugReporter &BR, 186 ExprEngine &Eng); 187 188 /// \brief Run checkers for evaluating a call. 189 void runCheckersForEvalCall(ExplodedNodeSet &Dst, 190 const ExplodedNodeSet &Src, 191 const CallExpr *CE, ExprEngine &Eng, 192 GraphExpander *defaultEval = 0); 193 194 // FIXME: Temporary until checker running is moved completely into 195 // CheckerManager. 196 void registerCheckersToEngine(ExprEngine &eng); 197 198//===----------------------------------------------------------------------===// 199// Internal registration functions for AST traversing. 200//===----------------------------------------------------------------------===// 201 202 // Functions used by the registration mechanism, checkers should not touch 203 // these directly. 204 205 typedef CheckerFn<const Decl *, AnalysisManager&, BugReporter &> 206 CheckDeclFunc; 207 typedef CheckerFn<const Stmt *, CheckerContext &> CheckStmtFunc; 208 209 typedef bool (*HandlesDeclFunc)(const Decl *D); 210 void _registerForDecl(CheckDeclFunc checkfn, HandlesDeclFunc isForDeclFn); 211 212 void _registerForBody(CheckDeclFunc checkfn); 213 214//===----------------------------------------------------------------------===// 215// Internal registration functions for path-sensitive checking. 216//===----------------------------------------------------------------------===// 217 218 typedef CheckerFn<const ObjCMessage &, CheckerContext &> CheckObjCMessageFunc; 219 typedef CheckerFn<const SVal &/*location*/, bool/*isLoad*/, CheckerContext &> 220 CheckLocationFunc; 221 typedef CheckerFn<ExplodedGraph &, BugReporter &, ExprEngine &> 222 CheckEndAnalysisFunc; 223 224 typedef bool (*HandlesStmtFunc)(const Stmt *D); 225 void _registerForPreStmt(CheckStmtFunc checkfn, 226 HandlesStmtFunc isForStmtFn); 227 void _registerForPostStmt(CheckStmtFunc checkfn, 228 HandlesStmtFunc isForStmtFn); 229 230 void _registerForPreObjCMessage(CheckObjCMessageFunc checkfn); 231 void _registerForPostObjCMessage(CheckObjCMessageFunc checkfn); 232 233 void _registerForLocation(CheckLocationFunc checkfn); 234 235 void _registerForEndAnalysis(CheckEndAnalysisFunc checkfn); 236 237 class EvalCallFunc { 238 typedef bool (*Func)(void *, const CallExpr *, CheckerContext &); 239 Func Fn; 240 public: 241 void *Checker; 242 EvalCallFunc(void *checker, Func fn) : Fn(fn), Checker(checker) { } 243 bool operator()(const CallExpr *CE, CheckerContext &C) { 244 return Fn(Checker, CE, C); 245 } 246 }; 247 248 void _registerForEvalCall(EvalCallFunc checkfn); 249 250//===----------------------------------------------------------------------===// 251// Implementation details. 252//===----------------------------------------------------------------------===// 253 254private: 255 template <typename CHECKER> 256 static void destruct(void *obj) { delete static_cast<CHECKER *>(obj); } 257 258 std::vector<CheckerDtor> CheckerDtors; 259 260 std::vector<RegisterToEngFunc> Funcs; 261 262 struct DeclCheckerInfo { 263 CheckDeclFunc CheckFn; 264 HandlesDeclFunc IsForDeclFn; 265 }; 266 std::vector<DeclCheckerInfo> DeclCheckers; 267 268 std::vector<CheckDeclFunc> BodyCheckers; 269 270 typedef llvm::SmallVector<CheckDeclFunc, 4> CachedDeclCheckers; 271 typedef llvm::DenseMap<unsigned, CachedDeclCheckers> CachedDeclCheckersMapTy; 272 CachedDeclCheckersMapTy CachedDeclCheckersMap; 273 274 struct StmtCheckerInfo { 275 CheckStmtFunc CheckFn; 276 HandlesStmtFunc IsForStmtFn; 277 bool IsPreVisit; 278 }; 279 std::vector<StmtCheckerInfo> StmtCheckers; 280 281 struct CachedStmtCheckersKey { 282 unsigned StmtKind; 283 bool IsPreVisit; 284 285 CachedStmtCheckersKey() : StmtKind(0), IsPreVisit(0) { } 286 CachedStmtCheckersKey(unsigned stmtKind, bool isPreVisit) 287 : StmtKind(stmtKind), IsPreVisit(isPreVisit) { } 288 289 static CachedStmtCheckersKey getSentinel() { 290 return CachedStmtCheckersKey(~0U, 0); 291 } 292 unsigned getHashValue() const { 293 llvm::FoldingSetNodeID ID; 294 ID.AddInteger(StmtKind); 295 ID.AddBoolean(IsPreVisit); 296 return ID.ComputeHash(); 297 } 298 bool operator==(const CachedStmtCheckersKey &RHS) const { 299 return StmtKind == RHS.StmtKind && IsPreVisit == RHS.IsPreVisit; 300 } 301 }; 302 friend struct llvm::DenseMapInfo<CachedStmtCheckersKey>; 303 304 typedef llvm::SmallVector<CheckStmtFunc, 4> CachedStmtCheckers; 305 typedef llvm::DenseMap<CachedStmtCheckersKey, CachedStmtCheckers> 306 CachedStmtCheckersMapTy; 307 CachedStmtCheckersMapTy CachedStmtCheckersMap; 308 309 CachedStmtCheckers *getCachedStmtCheckersFor(const Stmt *S, bool isPreVisit); 310 311 std::vector<CheckObjCMessageFunc> PreObjCMessageCheckers; 312 std::vector<CheckObjCMessageFunc> PostObjCMessageCheckers; 313 314 std::vector<CheckLocationFunc> LocationCheckers; 315 316 std::vector<CheckEndAnalysisFunc> EndAnalysisCheckers; 317 318 std::vector<EvalCallFunc> EvalCallCheckers; 319}; 320 321} // end ento namespace 322 323} // end clang namespace 324 325namespace llvm { 326 /// Define DenseMapInfo so that CachedStmtCheckersKey can be used as key 327 /// in DenseMap and DenseSets. 328 template <> 329 struct DenseMapInfo<clang::ento::CheckerManager::CachedStmtCheckersKey> { 330 static inline clang::ento::CheckerManager::CachedStmtCheckersKey 331 getEmptyKey() { 332 return clang::ento::CheckerManager::CachedStmtCheckersKey(); 333 } 334 static inline clang::ento::CheckerManager::CachedStmtCheckersKey 335 getTombstoneKey() { 336 return clang::ento::CheckerManager::CachedStmtCheckersKey::getSentinel(); 337 } 338 339 static unsigned 340 getHashValue(clang::ento::CheckerManager::CachedStmtCheckersKey S) { 341 return S.getHashValue(); 342 } 343 344 static bool isEqual(clang::ento::CheckerManager::CachedStmtCheckersKey LHS, 345 clang::ento::CheckerManager::CachedStmtCheckersKey RHS) { 346 return LHS == RHS; 347 } 348 }; 349} // end namespace llvm 350 351#endif 352