CheckerContext.h revision 8ff5c41f2bde7ebbe568b4c15e59f14b8befae66
16bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis//== CheckerContext.h - Context info for path-sensitive checkers--*- C++ -*--=// 26bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis// 36bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis// The LLVM Compiler Infrastructure 46bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis// 56bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis// This file is distributed under the University of Illinois Open Source 66bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis// License. See LICENSE.TXT for details. 76bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis// 86bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis//===----------------------------------------------------------------------===// 96bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis// 106bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis// This file defines CheckerContext that provides contextual info for 116bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis// path-sensitive checkers. 126bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis// 136bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis//===----------------------------------------------------------------------===// 146bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 156bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis#ifndef LLVM_CLANG_SA_CORE_PATHSENSITIVE_CHECKERCONTEXT 166bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis#define LLVM_CLANG_SA_CORE_PATHSENSITIVE_CHECKERCONTEXT 176bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 186bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis#include "clang/Analysis/Support/SaveAndRestore.h" 196bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis#include "clang/StaticAnalyzer/Core/PathSensitive/ExprEngine.h" 206bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 216bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidisnamespace clang { 226bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 236bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidisnamespace ento { 246bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 256bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidisclass CheckerContext { 266bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis ExprEngine &Eng; 276bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis ExplodedNode *Pred; 283f5e8d87dbf449d8b39fe96068415428594d370eAnna Zaks const ProgramPoint Location; 2918c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek const ProgramState *ST; 303152b3cb5b6a2f797d0972c81a5eb3fd69c0d620Anna Zaks NodeBuilder &NB; 316bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidispublic: 326bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis bool *respondsToCallback; 336bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidispublic: 348ff5c41f2bde7ebbe568b4c15e59f14b8befae66Anna Zaks CheckerContext(NodeBuilder &builder, 3518c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ExprEngine &eng, 3618c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ExplodedNode *pred, 373f5e8d87dbf449d8b39fe96068415428594d370eAnna Zaks const ProgramPoint &loc, 386bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis bool *respondsToCB = 0, 3918c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek const ProgramState *st = 0) 408ff5c41f2bde7ebbe568b4c15e59f14b8befae66Anna Zaks : Eng(eng), 4118c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek Pred(pred), 423f5e8d87dbf449d8b39fe96068415428594d370eAnna Zaks Location(loc), 4318c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ST(st), 443152b3cb5b6a2f797d0972c81a5eb3fd69c0d620Anna Zaks NB(builder), 45f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks respondsToCallback(respondsToCB) { 46f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks assert(!(ST && ST != Pred->getState())); 47f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks } 486bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 496bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis ~CheckerContext(); 506bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 516bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis ExprEngine &getEngine() { 526bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis return Eng; 536bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 546bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 556bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis AnalysisManager &getAnalysisManager() { 566bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis return Eng.getAnalysisManager(); 576bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 586bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 596bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis ConstraintManager &getConstraintManager() { 606bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis return Eng.getConstraintManager(); 616bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 626bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 636bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis StoreManager &getStoreManager() { 646bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis return Eng.getStoreManager(); 656bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 666bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 676bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis ExplodedNode *&getPredecessor() { return Pred; } 6818c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek const ProgramState *getState() { return ST ? ST : Pred->getState(); } 696bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 705d0ea6d62e076c776ddad028c4eb615783be1323Anna Zaks /// \brief Returns the number of times the current block has been visited 715d0ea6d62e076c776ddad028c4eb615783be1323Anna Zaks /// along the analyzed path. 728c90aadce33152b03e3d1d5c7e9c468c7b939c96Anna Zaks unsigned getCurrentBlockCount() {return NB.getCurrentBlockCount();} 735d0ea6d62e076c776ddad028c4eb615783be1323Anna Zaks 746bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis ASTContext &getASTContext() { 756bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis return Eng.getContext(); 766bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 776bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 786bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis BugReporter &getBugReporter() { 796bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis return Eng.getBugReporter(); 806bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 816bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 826bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis SourceManager &getSourceManager() { 836bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis return getBugReporter().getSourceManager(); 846bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 856bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 866bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis SValBuilder &getSValBuilder() { 876bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis return Eng.getSValBuilder(); 886bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 896bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 903f10e32b15e54f507aed90cb72d73c7acaa500bbAnna Zaks SymbolManager &getSymbolManager() { 913f10e32b15e54f507aed90cb72d73c7acaa500bbAnna Zaks return getSValBuilder().getSymbolManager(); 923f10e32b15e54f507aed90cb72d73c7acaa500bbAnna Zaks } 933f10e32b15e54f507aed90cb72d73c7acaa500bbAnna Zaks 9417a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose bool isObjCGCEnabled() { 9517a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose return Eng.isObjCGCEnabled(); 9617a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose } 9717a38e2636a8b1ce473fc6504c4b16cb09db29f4Jordy Rose 988ba721428af297e540fb40b176eeeea0ee010c1fAnna Zaks /// \brief Generate a default checker node (containing checker tag but no 998ba721428af297e540fb40b176eeeea0ee010c1fAnna Zaks /// checker state changes). 1006bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis ExplodedNode *generateNode(bool autoTransition = true) { 10150f3cade2a87bda005ae08d42b51c5b960b07779Anna Zaks return generateNode(getState(), autoTransition); 1026bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 1036bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 1048ba721428af297e540fb40b176eeeea0ee010c1fAnna Zaks /// \brief Generate a new checker node with the given predecessor. 1058ba721428af297e540fb40b176eeeea0ee010c1fAnna Zaks /// Allows checkers to generate a chain of nodes. 10618c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ExplodedNode *generateNode(const ProgramState *state, 10718c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ExplodedNode *pred, 108cbb7add8d7e3f868a6695a601e45fc13257bd9f5Anna Zaks const ProgramPointTag *tag = 0, 109f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks bool autoTransition = true, 110f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks bool isSink = false) { 111f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks ExplodedNode *N = generateNodeImpl(state, isSink, pred, tag); 1126bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis return N; 1136bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 1146bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 1158ba721428af297e540fb40b176eeeea0ee010c1fAnna Zaks /// \brief Generate a new checker node. 11618c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ExplodedNode *generateNode(const ProgramState *state, 11718c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek bool autoTransition = true, 118ca804539d908d3a0e8c72a0df5f1f571d29490bbTed Kremenek const ProgramPointTag *tag = 0) { 11950f3cade2a87bda005ae08d42b51c5b960b07779Anna Zaks ExplodedNode *N = generateNodeImpl(state, false, 0, tag); 1206bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis return N; 1216bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 1226bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 1238ba721428af297e540fb40b176eeeea0ee010c1fAnna Zaks /// \brief Generate a sink node. Generating sink stops exploration of the 1248ba721428af297e540fb40b176eeeea0ee010c1fAnna Zaks /// given path. 12518c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ExplodedNode *generateSink(const ProgramState *state = 0) { 12650f3cade2a87bda005ae08d42b51c5b960b07779Anna Zaks return generateNodeImpl(state ? state : getState(), true); 1276bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 1286bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 12918c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek void addTransition(const ProgramState *state, 13018c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek const ProgramPointTag *tag = 0) { 1316bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis assert(state); 1326bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis // If the 'state' is not new, we need to check if the cached state 'ST' 1336bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis // is new. 134f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks if (state != getState()) 1356bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis generateNode(state, true, tag); 1366bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 1376bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 1386bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis void EmitReport(BugReport *R) { 1396bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis Eng.getBugReporter().EmitReport(R); 1406bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 1416bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 1421d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek AnalysisDeclContext *getCurrentAnalysisDeclContext() const { 1431d26f48dc2eea1c07431ca1519d7034a21b9bcffTed Kremenek return Pred->getLocationContext()->getAnalysisDeclContext(); 1446bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 1456bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 1466bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidisprivate: 14750f3cade2a87bda005ae08d42b51c5b960b07779Anna Zaks ExplodedNode *generateNodeImpl(const ProgramState *state, 14818c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek bool markAsSink, 14950f3cade2a87bda005ae08d42b51c5b960b07779Anna Zaks ExplodedNode *pred = 0, 15050f3cade2a87bda005ae08d42b51c5b960b07779Anna Zaks const ProgramPointTag *tag = 0) { 151f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks ExplodedNode *node = NB.generateNode(tag ? Location.withTag(tag) : Location, 1523f5e8d87dbf449d8b39fe96068415428594d370eAnna Zaks state, 153f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks pred ? pred : Pred, markAsSink); 1546bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis return node; 1556bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis } 1566bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis}; 1576bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 1586bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis} // end GR namespace 1596bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 1606bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis} // end clang namespace 1616bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis 1626bcb48dc67e417e0ecce803f28d13bbea2ee0243Argyrios Kyrtzidis#endif 163