CheckerManager.cpp 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744
  1. //===--- CheckerManager.cpp - Static Analyzer Checker Manager -------------===//
  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. #include "clang/StaticAnalyzer/Core/CheckerManager.h"
  14. #include "clang/AST/DeclBase.h"
  15. #include "clang/Analysis/ProgramPoint.h"
  16. #include "clang/StaticAnalyzer/Core/Checker.h"
  17. #include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h"
  18. #include "clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h"
  19. using namespace clang;
  20. using namespace ento;
  21. bool CheckerManager::hasPathSensitiveCheckers() const {
  22. return !StmtCheckers.empty() ||
  23. !PreObjCMessageCheckers.empty() ||
  24. !PostObjCMessageCheckers.empty() ||
  25. !PreCallCheckers.empty() ||
  26. !PostCallCheckers.empty() ||
  27. !LocationCheckers.empty() ||
  28. !BindCheckers.empty() ||
  29. !EndAnalysisCheckers.empty() ||
  30. !EndFunctionCheckers.empty() ||
  31. !BranchConditionCheckers.empty() ||
  32. !LiveSymbolsCheckers.empty() ||
  33. !DeadSymbolsCheckers.empty() ||
  34. !RegionChangesCheckers.empty() ||
  35. !EvalAssumeCheckers.empty() ||
  36. !EvalCallCheckers.empty();
  37. }
  38. void CheckerManager::finishedCheckerRegistration() {
  39. #ifndef NDEBUG
  40. // Make sure that for every event that has listeners, there is at least
  41. // one dispatcher registered for it.
  42. for (llvm::DenseMap<EventTag, EventInfo>::iterator
  43. I = Events.begin(), E = Events.end(); I != E; ++I)
  44. assert(I->second.HasDispatcher && "No dispatcher registered for an event");
  45. #endif
  46. }
  47. //===----------------------------------------------------------------------===//
  48. // Functions for running checkers for AST traversing..
  49. //===----------------------------------------------------------------------===//
  50. void CheckerManager::runCheckersOnASTDecl(const Decl *D, AnalysisManager& mgr,
  51. BugReporter &BR) {
  52. assert(D);
  53. unsigned DeclKind = D->getKind();
  54. CachedDeclCheckers *checkers = nullptr;
  55. CachedDeclCheckersMapTy::iterator CCI = CachedDeclCheckersMap.find(DeclKind);
  56. if (CCI != CachedDeclCheckersMap.end()) {
  57. checkers = &(CCI->second);
  58. } else {
  59. // Find the checkers that should run for this Decl and cache them.
  60. checkers = &CachedDeclCheckersMap[DeclKind];
  61. for (unsigned i = 0, e = DeclCheckers.size(); i != e; ++i) {
  62. DeclCheckerInfo &info = DeclCheckers[i];
  63. if (info.IsForDeclFn(D))
  64. checkers->push_back(info.CheckFn);
  65. }
  66. }
  67. assert(checkers);
  68. for (CachedDeclCheckers::iterator
  69. I = checkers->begin(), E = checkers->end(); I != E; ++I)
  70. (*I)(D, mgr, BR);
  71. }
  72. void CheckerManager::runCheckersOnASTBody(const Decl *D, AnalysisManager& mgr,
  73. BugReporter &BR) {
  74. assert(D && D->hasBody());
  75. for (unsigned i = 0, e = BodyCheckers.size(); i != e; ++i)
  76. BodyCheckers[i](D, mgr, BR);
  77. }
  78. //===----------------------------------------------------------------------===//
  79. // Functions for running checkers for path-sensitive checking.
  80. //===----------------------------------------------------------------------===//
  81. template <typename CHECK_CTX>
  82. static void expandGraphWithCheckers(CHECK_CTX checkCtx,
  83. ExplodedNodeSet &Dst,
  84. const ExplodedNodeSet &Src) {
  85. const NodeBuilderContext &BldrCtx = checkCtx.Eng.getBuilderContext();
  86. if (Src.empty())
  87. return;
  88. typename CHECK_CTX::CheckersTy::const_iterator
  89. I = checkCtx.checkers_begin(), E = checkCtx.checkers_end();
  90. if (I == E) {
  91. Dst.insert(Src);
  92. return;
  93. }
  94. ExplodedNodeSet Tmp1, Tmp2;
  95. const ExplodedNodeSet *PrevSet = &Src;
  96. for (; I != E; ++I) {
  97. ExplodedNodeSet *CurrSet = nullptr;
  98. if (I+1 == E)
  99. CurrSet = &Dst;
  100. else {
  101. CurrSet = (PrevSet == &Tmp1) ? &Tmp2 : &Tmp1;
  102. CurrSet->clear();
  103. }
  104. NodeBuilder B(*PrevSet, *CurrSet, BldrCtx);
  105. for (ExplodedNodeSet::iterator NI = PrevSet->begin(), NE = PrevSet->end();
  106. NI != NE; ++NI) {
  107. checkCtx.runChecker(*I, B, *NI);
  108. }
  109. // If all the produced transitions are sinks, stop.
  110. if (CurrSet->empty())
  111. return;
  112. // Update which NodeSet is the current one.
  113. PrevSet = CurrSet;
  114. }
  115. }
  116. namespace {
  117. struct CheckStmtContext {
  118. typedef SmallVectorImpl<CheckerManager::CheckStmtFunc> CheckersTy;
  119. bool IsPreVisit;
  120. const CheckersTy &Checkers;
  121. const Stmt *S;
  122. ExprEngine &Eng;
  123. bool WasInlined;
  124. CheckersTy::const_iterator checkers_begin() { return Checkers.begin(); }
  125. CheckersTy::const_iterator checkers_end() { return Checkers.end(); }
  126. CheckStmtContext(bool isPreVisit, const CheckersTy &checkers,
  127. const Stmt *s, ExprEngine &eng, bool wasInlined = false)
  128. : IsPreVisit(isPreVisit), Checkers(checkers), S(s), Eng(eng),
  129. WasInlined(wasInlined) {}
  130. void runChecker(CheckerManager::CheckStmtFunc checkFn,
  131. NodeBuilder &Bldr, ExplodedNode *Pred) {
  132. // FIXME: Remove respondsToCallback from CheckerContext;
  133. ProgramPoint::Kind K = IsPreVisit ? ProgramPoint::PreStmtKind :
  134. ProgramPoint::PostStmtKind;
  135. const ProgramPoint &L = ProgramPoint::getProgramPoint(S, K,
  136. Pred->getLocationContext(), checkFn.Checker);
  137. CheckerContext C(Bldr, Eng, Pred, L, WasInlined);
  138. checkFn(S, C);
  139. }
  140. };
  141. }
  142. /// \brief Run checkers for visiting Stmts.
  143. void CheckerManager::runCheckersForStmt(bool isPreVisit,
  144. ExplodedNodeSet &Dst,
  145. const ExplodedNodeSet &Src,
  146. const Stmt *S,
  147. ExprEngine &Eng,
  148. bool WasInlined) {
  149. CheckStmtContext C(isPreVisit, getCachedStmtCheckersFor(S, isPreVisit),
  150. S, Eng, WasInlined);
  151. expandGraphWithCheckers(C, Dst, Src);
  152. }
  153. namespace {
  154. struct CheckObjCMessageContext {
  155. typedef std::vector<CheckerManager::CheckObjCMessageFunc> CheckersTy;
  156. ObjCMessageVisitKind Kind;
  157. bool WasInlined;
  158. const CheckersTy &Checkers;
  159. const ObjCMethodCall &Msg;
  160. ExprEngine &Eng;
  161. CheckersTy::const_iterator checkers_begin() { return Checkers.begin(); }
  162. CheckersTy::const_iterator checkers_end() { return Checkers.end(); }
  163. CheckObjCMessageContext(ObjCMessageVisitKind visitKind,
  164. const CheckersTy &checkers,
  165. const ObjCMethodCall &msg, ExprEngine &eng,
  166. bool wasInlined)
  167. : Kind(visitKind), WasInlined(wasInlined), Checkers(checkers),
  168. Msg(msg), Eng(eng) { }
  169. void runChecker(CheckerManager::CheckObjCMessageFunc checkFn,
  170. NodeBuilder &Bldr, ExplodedNode *Pred) {
  171. bool IsPreVisit;
  172. switch (Kind) {
  173. case ObjCMessageVisitKind::Pre:
  174. IsPreVisit = true;
  175. break;
  176. case ObjCMessageVisitKind::MessageNil:
  177. case ObjCMessageVisitKind::Post:
  178. IsPreVisit = false;
  179. break;
  180. }
  181. const ProgramPoint &L = Msg.getProgramPoint(IsPreVisit,checkFn.Checker);
  182. CheckerContext C(Bldr, Eng, Pred, L, WasInlined);
  183. checkFn(*Msg.cloneWithState<ObjCMethodCall>(Pred->getState()), C);
  184. }
  185. };
  186. }
  187. /// \brief Run checkers for visiting obj-c messages.
  188. void CheckerManager::runCheckersForObjCMessage(ObjCMessageVisitKind visitKind,
  189. ExplodedNodeSet &Dst,
  190. const ExplodedNodeSet &Src,
  191. const ObjCMethodCall &msg,
  192. ExprEngine &Eng,
  193. bool WasInlined) {
  194. auto &checkers = getObjCMessageCheckers(visitKind);
  195. CheckObjCMessageContext C(visitKind, checkers, msg, Eng, WasInlined);
  196. expandGraphWithCheckers(C, Dst, Src);
  197. }
  198. const std::vector<CheckerManager::CheckObjCMessageFunc> &
  199. CheckerManager::getObjCMessageCheckers(ObjCMessageVisitKind Kind) {
  200. switch (Kind) {
  201. case ObjCMessageVisitKind::Pre:
  202. return PreObjCMessageCheckers;
  203. break;
  204. case ObjCMessageVisitKind::Post:
  205. return PostObjCMessageCheckers;
  206. case ObjCMessageVisitKind::MessageNil:
  207. return ObjCMessageNilCheckers;
  208. }
  209. }
  210. namespace {
  211. // FIXME: This has all the same signatures as CheckObjCMessageContext.
  212. // Is there a way we can merge the two?
  213. struct CheckCallContext {
  214. typedef std::vector<CheckerManager::CheckCallFunc> CheckersTy;
  215. bool IsPreVisit, WasInlined;
  216. const CheckersTy &Checkers;
  217. const CallEvent &Call;
  218. ExprEngine &Eng;
  219. CheckersTy::const_iterator checkers_begin() { return Checkers.begin(); }
  220. CheckersTy::const_iterator checkers_end() { return Checkers.end(); }
  221. CheckCallContext(bool isPreVisit, const CheckersTy &checkers,
  222. const CallEvent &call, ExprEngine &eng,
  223. bool wasInlined)
  224. : IsPreVisit(isPreVisit), WasInlined(wasInlined), Checkers(checkers),
  225. Call(call), Eng(eng) { }
  226. void runChecker(CheckerManager::CheckCallFunc checkFn,
  227. NodeBuilder &Bldr, ExplodedNode *Pred) {
  228. const ProgramPoint &L = Call.getProgramPoint(IsPreVisit,checkFn.Checker);
  229. CheckerContext C(Bldr, Eng, Pred, L, WasInlined);
  230. checkFn(*Call.cloneWithState(Pred->getState()), C);
  231. }
  232. };
  233. }
  234. /// \brief Run checkers for visiting an abstract call event.
  235. void CheckerManager::runCheckersForCallEvent(bool isPreVisit,
  236. ExplodedNodeSet &Dst,
  237. const ExplodedNodeSet &Src,
  238. const CallEvent &Call,
  239. ExprEngine &Eng,
  240. bool WasInlined) {
  241. CheckCallContext C(isPreVisit,
  242. isPreVisit ? PreCallCheckers
  243. : PostCallCheckers,
  244. Call, Eng, WasInlined);
  245. expandGraphWithCheckers(C, Dst, Src);
  246. }
  247. namespace {
  248. struct CheckLocationContext {
  249. typedef std::vector<CheckerManager::CheckLocationFunc> CheckersTy;
  250. const CheckersTy &Checkers;
  251. SVal Loc;
  252. bool IsLoad;
  253. const Stmt *NodeEx; /* Will become a CFGStmt */
  254. const Stmt *BoundEx;
  255. ExprEngine &Eng;
  256. CheckersTy::const_iterator checkers_begin() { return Checkers.begin(); }
  257. CheckersTy::const_iterator checkers_end() { return Checkers.end(); }
  258. CheckLocationContext(const CheckersTy &checkers,
  259. SVal loc, bool isLoad, const Stmt *NodeEx,
  260. const Stmt *BoundEx,
  261. ExprEngine &eng)
  262. : Checkers(checkers), Loc(loc), IsLoad(isLoad), NodeEx(NodeEx),
  263. BoundEx(BoundEx), Eng(eng) {}
  264. void runChecker(CheckerManager::CheckLocationFunc checkFn,
  265. NodeBuilder &Bldr, ExplodedNode *Pred) {
  266. ProgramPoint::Kind K = IsLoad ? ProgramPoint::PreLoadKind :
  267. ProgramPoint::PreStoreKind;
  268. const ProgramPoint &L =
  269. ProgramPoint::getProgramPoint(NodeEx, K,
  270. Pred->getLocationContext(),
  271. checkFn.Checker);
  272. CheckerContext C(Bldr, Eng, Pred, L);
  273. checkFn(Loc, IsLoad, BoundEx, C);
  274. }
  275. };
  276. }
  277. /// \brief Run checkers for load/store of a location.
  278. void CheckerManager::runCheckersForLocation(ExplodedNodeSet &Dst,
  279. const ExplodedNodeSet &Src,
  280. SVal location, bool isLoad,
  281. const Stmt *NodeEx,
  282. const Stmt *BoundEx,
  283. ExprEngine &Eng) {
  284. CheckLocationContext C(LocationCheckers, location, isLoad, NodeEx,
  285. BoundEx, Eng);
  286. expandGraphWithCheckers(C, Dst, Src);
  287. }
  288. namespace {
  289. struct CheckBindContext {
  290. typedef std::vector<CheckerManager::CheckBindFunc> CheckersTy;
  291. const CheckersTy &Checkers;
  292. SVal Loc;
  293. SVal Val;
  294. const Stmt *S;
  295. ExprEngine &Eng;
  296. const ProgramPoint &PP;
  297. CheckersTy::const_iterator checkers_begin() { return Checkers.begin(); }
  298. CheckersTy::const_iterator checkers_end() { return Checkers.end(); }
  299. CheckBindContext(const CheckersTy &checkers,
  300. SVal loc, SVal val, const Stmt *s, ExprEngine &eng,
  301. const ProgramPoint &pp)
  302. : Checkers(checkers), Loc(loc), Val(val), S(s), Eng(eng), PP(pp) {}
  303. void runChecker(CheckerManager::CheckBindFunc checkFn,
  304. NodeBuilder &Bldr, ExplodedNode *Pred) {
  305. const ProgramPoint &L = PP.withTag(checkFn.Checker);
  306. CheckerContext C(Bldr, Eng, Pred, L);
  307. checkFn(Loc, Val, S, C);
  308. }
  309. };
  310. }
  311. /// \brief Run checkers for binding of a value to a location.
  312. void CheckerManager::runCheckersForBind(ExplodedNodeSet &Dst,
  313. const ExplodedNodeSet &Src,
  314. SVal location, SVal val,
  315. const Stmt *S, ExprEngine &Eng,
  316. const ProgramPoint &PP) {
  317. CheckBindContext C(BindCheckers, location, val, S, Eng, PP);
  318. expandGraphWithCheckers(C, Dst, Src);
  319. }
  320. void CheckerManager::runCheckersForEndAnalysis(ExplodedGraph &G,
  321. BugReporter &BR,
  322. ExprEngine &Eng) {
  323. for (unsigned i = 0, e = EndAnalysisCheckers.size(); i != e; ++i)
  324. EndAnalysisCheckers[i](G, BR, Eng);
  325. }
  326. /// \brief Run checkers for end of path.
  327. // Note, We do not chain the checker output (like in expandGraphWithCheckers)
  328. // for this callback since end of path nodes are expected to be final.
  329. void CheckerManager::runCheckersForEndFunction(NodeBuilderContext &BC,
  330. ExplodedNodeSet &Dst,
  331. ExplodedNode *Pred,
  332. ExprEngine &Eng) {
  333. // We define the builder outside of the loop bacause if at least one checkers
  334. // creates a sucsessor for Pred, we do not need to generate an
  335. // autotransition for it.
  336. NodeBuilder Bldr(Pred, Dst, BC);
  337. for (unsigned i = 0, e = EndFunctionCheckers.size(); i != e; ++i) {
  338. CheckEndFunctionFunc checkFn = EndFunctionCheckers[i];
  339. const ProgramPoint &L = BlockEntrance(BC.Block,
  340. Pred->getLocationContext(),
  341. checkFn.Checker);
  342. CheckerContext C(Bldr, Eng, Pred, L);
  343. checkFn(C);
  344. }
  345. }
  346. namespace {
  347. struct CheckBranchConditionContext {
  348. typedef std::vector<CheckerManager::CheckBranchConditionFunc> CheckersTy;
  349. const CheckersTy &Checkers;
  350. const Stmt *Condition;
  351. ExprEngine &Eng;
  352. CheckersTy::const_iterator checkers_begin() { return Checkers.begin(); }
  353. CheckersTy::const_iterator checkers_end() { return Checkers.end(); }
  354. CheckBranchConditionContext(const CheckersTy &checkers,
  355. const Stmt *Cond, ExprEngine &eng)
  356. : Checkers(checkers), Condition(Cond), Eng(eng) {}
  357. void runChecker(CheckerManager::CheckBranchConditionFunc checkFn,
  358. NodeBuilder &Bldr, ExplodedNode *Pred) {
  359. ProgramPoint L = PostCondition(Condition, Pred->getLocationContext(),
  360. checkFn.Checker);
  361. CheckerContext C(Bldr, Eng, Pred, L);
  362. checkFn(Condition, C);
  363. }
  364. };
  365. }
  366. /// \brief Run checkers for branch condition.
  367. void CheckerManager::runCheckersForBranchCondition(const Stmt *Condition,
  368. ExplodedNodeSet &Dst,
  369. ExplodedNode *Pred,
  370. ExprEngine &Eng) {
  371. ExplodedNodeSet Src;
  372. Src.insert(Pred);
  373. CheckBranchConditionContext C(BranchConditionCheckers, Condition, Eng);
  374. expandGraphWithCheckers(C, Dst, Src);
  375. }
  376. /// \brief Run checkers for live symbols.
  377. void CheckerManager::runCheckersForLiveSymbols(ProgramStateRef state,
  378. SymbolReaper &SymReaper) {
  379. for (unsigned i = 0, e = LiveSymbolsCheckers.size(); i != e; ++i)
  380. LiveSymbolsCheckers[i](state, SymReaper);
  381. }
  382. namespace {
  383. struct CheckDeadSymbolsContext {
  384. typedef std::vector<CheckerManager::CheckDeadSymbolsFunc> CheckersTy;
  385. const CheckersTy &Checkers;
  386. SymbolReaper &SR;
  387. const Stmt *S;
  388. ExprEngine &Eng;
  389. ProgramPoint::Kind ProgarmPointKind;
  390. CheckersTy::const_iterator checkers_begin() { return Checkers.begin(); }
  391. CheckersTy::const_iterator checkers_end() { return Checkers.end(); }
  392. CheckDeadSymbolsContext(const CheckersTy &checkers, SymbolReaper &sr,
  393. const Stmt *s, ExprEngine &eng,
  394. ProgramPoint::Kind K)
  395. : Checkers(checkers), SR(sr), S(s), Eng(eng), ProgarmPointKind(K) { }
  396. void runChecker(CheckerManager::CheckDeadSymbolsFunc checkFn,
  397. NodeBuilder &Bldr, ExplodedNode *Pred) {
  398. const ProgramPoint &L = ProgramPoint::getProgramPoint(S, ProgarmPointKind,
  399. Pred->getLocationContext(), checkFn.Checker);
  400. CheckerContext C(Bldr, Eng, Pred, L);
  401. // Note, do not pass the statement to the checkers without letting them
  402. // differentiate if we ran remove dead bindings before or after the
  403. // statement.
  404. checkFn(SR, C);
  405. }
  406. };
  407. }
  408. /// \brief Run checkers for dead symbols.
  409. void CheckerManager::runCheckersForDeadSymbols(ExplodedNodeSet &Dst,
  410. const ExplodedNodeSet &Src,
  411. SymbolReaper &SymReaper,
  412. const Stmt *S,
  413. ExprEngine &Eng,
  414. ProgramPoint::Kind K) {
  415. CheckDeadSymbolsContext C(DeadSymbolsCheckers, SymReaper, S, Eng, K);
  416. expandGraphWithCheckers(C, Dst, Src);
  417. }
  418. /// \brief True if at least one checker wants to check region changes.
  419. bool CheckerManager::wantsRegionChangeUpdate(ProgramStateRef state) {
  420. for (unsigned i = 0, e = RegionChangesCheckers.size(); i != e; ++i)
  421. if (RegionChangesCheckers[i].WantUpdateFn(state))
  422. return true;
  423. return false;
  424. }
  425. /// \brief Run checkers for region changes.
  426. ProgramStateRef
  427. CheckerManager::runCheckersForRegionChanges(ProgramStateRef state,
  428. const InvalidatedSymbols *invalidated,
  429. ArrayRef<const MemRegion *> ExplicitRegions,
  430. ArrayRef<const MemRegion *> Regions,
  431. const CallEvent *Call) {
  432. for (unsigned i = 0, e = RegionChangesCheckers.size(); i != e; ++i) {
  433. // If any checker declares the state infeasible (or if it starts that way),
  434. // bail out.
  435. if (!state)
  436. return nullptr;
  437. state = RegionChangesCheckers[i].CheckFn(state, invalidated,
  438. ExplicitRegions, Regions, Call);
  439. }
  440. return state;
  441. }
  442. /// \brief Run checkers to process symbol escape event.
  443. ProgramStateRef
  444. CheckerManager::runCheckersForPointerEscape(ProgramStateRef State,
  445. const InvalidatedSymbols &Escaped,
  446. const CallEvent *Call,
  447. PointerEscapeKind Kind,
  448. RegionAndSymbolInvalidationTraits *ETraits) {
  449. assert((Call != nullptr ||
  450. (Kind != PSK_DirectEscapeOnCall &&
  451. Kind != PSK_IndirectEscapeOnCall)) &&
  452. "Call must not be NULL when escaping on call");
  453. for (unsigned i = 0, e = PointerEscapeCheckers.size(); i != e; ++i) {
  454. // If any checker declares the state infeasible (or if it starts that
  455. // way), bail out.
  456. if (!State)
  457. return nullptr;
  458. State = PointerEscapeCheckers[i](State, Escaped, Call, Kind, ETraits);
  459. }
  460. return State;
  461. }
  462. /// \brief Run checkers for handling assumptions on symbolic values.
  463. ProgramStateRef
  464. CheckerManager::runCheckersForEvalAssume(ProgramStateRef state,
  465. SVal Cond, bool Assumption) {
  466. for (unsigned i = 0, e = EvalAssumeCheckers.size(); i != e; ++i) {
  467. // If any checker declares the state infeasible (or if it starts that way),
  468. // bail out.
  469. if (!state)
  470. return nullptr;
  471. state = EvalAssumeCheckers[i](state, Cond, Assumption);
  472. }
  473. return state;
  474. }
  475. /// \brief Run checkers for evaluating a call.
  476. /// Only one checker will evaluate the call.
  477. void CheckerManager::runCheckersForEvalCall(ExplodedNodeSet &Dst,
  478. const ExplodedNodeSet &Src,
  479. const CallEvent &Call,
  480. ExprEngine &Eng) {
  481. const CallExpr *CE = cast<CallExpr>(Call.getOriginExpr());
  482. for (ExplodedNodeSet::iterator
  483. NI = Src.begin(), NE = Src.end(); NI != NE; ++NI) {
  484. ExplodedNode *Pred = *NI;
  485. bool anyEvaluated = false;
  486. ExplodedNodeSet checkDst;
  487. NodeBuilder B(Pred, checkDst, Eng.getBuilderContext());
  488. // Check if any of the EvalCall callbacks can evaluate the call.
  489. for (std::vector<EvalCallFunc>::iterator
  490. EI = EvalCallCheckers.begin(), EE = EvalCallCheckers.end();
  491. EI != EE; ++EI) {
  492. ProgramPoint::Kind K = ProgramPoint::PostStmtKind;
  493. const ProgramPoint &L = ProgramPoint::getProgramPoint(CE, K,
  494. Pred->getLocationContext(), EI->Checker);
  495. bool evaluated = false;
  496. { // CheckerContext generates transitions(populates checkDest) on
  497. // destruction, so introduce the scope to make sure it gets properly
  498. // populated.
  499. CheckerContext C(B, Eng, Pred, L);
  500. evaluated = (*EI)(CE, C);
  501. }
  502. assert(!(evaluated && anyEvaluated)
  503. && "There are more than one checkers evaluating the call");
  504. if (evaluated) {
  505. anyEvaluated = true;
  506. Dst.insert(checkDst);
  507. #ifdef NDEBUG
  508. break; // on release don't check that no other checker also evals.
  509. #endif
  510. }
  511. }
  512. // If none of the checkers evaluated the call, ask ExprEngine to handle it.
  513. if (!anyEvaluated) {
  514. NodeBuilder B(Pred, Dst, Eng.getBuilderContext());
  515. Eng.defaultEvalCall(B, Pred, Call);
  516. }
  517. }
  518. }
  519. /// \brief Run checkers for the entire Translation Unit.
  520. void CheckerManager::runCheckersOnEndOfTranslationUnit(
  521. const TranslationUnitDecl *TU,
  522. AnalysisManager &mgr,
  523. BugReporter &BR) {
  524. for (unsigned i = 0, e = EndOfTranslationUnitCheckers.size(); i != e; ++i)
  525. EndOfTranslationUnitCheckers[i](TU, mgr, BR);
  526. }
  527. void CheckerManager::runCheckersForPrintState(raw_ostream &Out,
  528. ProgramStateRef State,
  529. const char *NL, const char *Sep) {
  530. for (llvm::DenseMap<CheckerTag, CheckerRef>::iterator
  531. I = CheckerTags.begin(), E = CheckerTags.end(); I != E; ++I)
  532. I->second->printState(Out, State, NL, Sep);
  533. }
  534. //===----------------------------------------------------------------------===//
  535. // Internal registration functions for AST traversing.
  536. //===----------------------------------------------------------------------===//
  537. void CheckerManager::_registerForDecl(CheckDeclFunc checkfn,
  538. HandlesDeclFunc isForDeclFn) {
  539. DeclCheckerInfo info = { checkfn, isForDeclFn };
  540. DeclCheckers.push_back(info);
  541. }
  542. void CheckerManager::_registerForBody(CheckDeclFunc checkfn) {
  543. BodyCheckers.push_back(checkfn);
  544. }
  545. //===----------------------------------------------------------------------===//
  546. // Internal registration functions for path-sensitive checking.
  547. //===----------------------------------------------------------------------===//
  548. void CheckerManager::_registerForPreStmt(CheckStmtFunc checkfn,
  549. HandlesStmtFunc isForStmtFn) {
  550. StmtCheckerInfo info = { checkfn, isForStmtFn, /*IsPreVisit*/true };
  551. StmtCheckers.push_back(info);
  552. }
  553. void CheckerManager::_registerForPostStmt(CheckStmtFunc checkfn,
  554. HandlesStmtFunc isForStmtFn) {
  555. StmtCheckerInfo info = { checkfn, isForStmtFn, /*IsPreVisit*/false };
  556. StmtCheckers.push_back(info);
  557. }
  558. void CheckerManager::_registerForPreObjCMessage(CheckObjCMessageFunc checkfn) {
  559. PreObjCMessageCheckers.push_back(checkfn);
  560. }
  561. void CheckerManager::_registerForObjCMessageNil(CheckObjCMessageFunc checkfn) {
  562. ObjCMessageNilCheckers.push_back(checkfn);
  563. }
  564. void CheckerManager::_registerForPostObjCMessage(CheckObjCMessageFunc checkfn) {
  565. PostObjCMessageCheckers.push_back(checkfn);
  566. }
  567. void CheckerManager::_registerForPreCall(CheckCallFunc checkfn) {
  568. PreCallCheckers.push_back(checkfn);
  569. }
  570. void CheckerManager::_registerForPostCall(CheckCallFunc checkfn) {
  571. PostCallCheckers.push_back(checkfn);
  572. }
  573. void CheckerManager::_registerForLocation(CheckLocationFunc checkfn) {
  574. LocationCheckers.push_back(checkfn);
  575. }
  576. void CheckerManager::_registerForBind(CheckBindFunc checkfn) {
  577. BindCheckers.push_back(checkfn);
  578. }
  579. void CheckerManager::_registerForEndAnalysis(CheckEndAnalysisFunc checkfn) {
  580. EndAnalysisCheckers.push_back(checkfn);
  581. }
  582. void CheckerManager::_registerForEndFunction(CheckEndFunctionFunc checkfn) {
  583. EndFunctionCheckers.push_back(checkfn);
  584. }
  585. void CheckerManager::_registerForBranchCondition(
  586. CheckBranchConditionFunc checkfn) {
  587. BranchConditionCheckers.push_back(checkfn);
  588. }
  589. void CheckerManager::_registerForLiveSymbols(CheckLiveSymbolsFunc checkfn) {
  590. LiveSymbolsCheckers.push_back(checkfn);
  591. }
  592. void CheckerManager::_registerForDeadSymbols(CheckDeadSymbolsFunc checkfn) {
  593. DeadSymbolsCheckers.push_back(checkfn);
  594. }
  595. void CheckerManager::_registerForRegionChanges(CheckRegionChangesFunc checkfn,
  596. WantsRegionChangeUpdateFunc wantUpdateFn) {
  597. RegionChangesCheckerInfo info = {checkfn, wantUpdateFn};
  598. RegionChangesCheckers.push_back(info);
  599. }
  600. void CheckerManager::_registerForPointerEscape(CheckPointerEscapeFunc checkfn){
  601. PointerEscapeCheckers.push_back(checkfn);
  602. }
  603. void CheckerManager::_registerForConstPointerEscape(
  604. CheckPointerEscapeFunc checkfn) {
  605. PointerEscapeCheckers.push_back(checkfn);
  606. }
  607. void CheckerManager::_registerForEvalAssume(EvalAssumeFunc checkfn) {
  608. EvalAssumeCheckers.push_back(checkfn);
  609. }
  610. void CheckerManager::_registerForEvalCall(EvalCallFunc checkfn) {
  611. EvalCallCheckers.push_back(checkfn);
  612. }
  613. void CheckerManager::_registerForEndOfTranslationUnit(
  614. CheckEndOfTranslationUnit checkfn) {
  615. EndOfTranslationUnitCheckers.push_back(checkfn);
  616. }
  617. //===----------------------------------------------------------------------===//
  618. // Implementation details.
  619. //===----------------------------------------------------------------------===//
  620. const CheckerManager::CachedStmtCheckers &
  621. CheckerManager::getCachedStmtCheckersFor(const Stmt *S, bool isPreVisit) {
  622. assert(S);
  623. unsigned Key = (S->getStmtClass() << 1) | unsigned(isPreVisit);
  624. CachedStmtCheckersMapTy::iterator CCI = CachedStmtCheckersMap.find(Key);
  625. if (CCI != CachedStmtCheckersMap.end())
  626. return CCI->second;
  627. // Find the checkers that should run for this Stmt and cache them.
  628. CachedStmtCheckers &Checkers = CachedStmtCheckersMap[Key];
  629. for (unsigned i = 0, e = StmtCheckers.size(); i != e; ++i) {
  630. StmtCheckerInfo &Info = StmtCheckers[i];
  631. if (Info.IsPreVisit == isPreVisit && Info.IsForStmtFn(S))
  632. Checkers.push_back(Info.CheckFn);
  633. }
  634. return Checkers;
  635. }
  636. CheckerManager::~CheckerManager() {
  637. for (unsigned i = 0, e = CheckerDtors.size(); i != e; ++i)
  638. CheckerDtors[i]();
  639. }