CoreEngine.h revision 5903a373db3d27794c90b25687e0dd6adb0e497d
1d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis//==- CoreEngine.h - Path-Sensitive Dataflow Engine ----------------*- C++ -*-// 21eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump// 3f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek// The LLVM Compiler Infrastructure 4f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek// 5f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek// This file is distributed under the University of Illinois Open Source 6f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek// License. See LICENSE.TXT for details. 7f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek// 8f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek//===----------------------------------------------------------------------===// 9f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek// 10f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek// This file defines a generic engine for intraprocedural, path-sensitive, 118e49dd6e7e73b275a74338a5127a524f0765303cTed Kremenek// dataflow analysis via graph reachability. 12f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek// 13f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek//===----------------------------------------------------------------------===// 14f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek 15d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis#ifndef LLVM_CLANG_GR_COREENGINE 16d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis#define LLVM_CLANG_GR_COREENGINE 17f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek 1899c6ad3f22b865d0f4cce52bc36904403c9ed4c4Ted Kremenek#include "clang/AST/Expr.h" 195eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek#include "clang/Analysis/AnalysisContext.h" 209b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/ExplodedGraph.h" 219b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/WorkList.h" 229b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/BlockCounter.h" 23f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek#include "llvm/ADT/OwningPtr.h" 24f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek 25f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremeneknamespace clang { 260111f575b968e423dccae439e501225b8314b257Zhongxing Xu 27ca804539d908d3a0e8c72a0df5f1f571d29490bbTed Kremenekclass ProgramPointTag; 28ca804539d908d3a0e8c72a0df5f1f571d29490bbTed Kremenek 299ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremeneknamespace ento { 305a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 31a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaksclass NodeBuilder; 32a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks 3324f1a967741ff9f8025ee23be12ba6feacc31f77Ted Kremenek//===----------------------------------------------------------------------===// 34d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis/// CoreEngine - Implements the core logic of the graph-reachability 35922059dec59c7bed235da01aff75ae522a369811Ted Kremenek/// analysis. It traverses the CFG and generates the ExplodedGraph. 36922059dec59c7bed235da01aff75ae522a369811Ted Kremenek/// Program "states" are treated as opaque void pointers. 37d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis/// The template class CoreEngine (which subclasses CoreEngine) 38922059dec59c7bed235da01aff75ae522a369811Ted Kremenek/// provides the matching component to the engine that knows the actual types 39922059dec59c7bed235da01aff75ae522a369811Ted Kremenek/// for states. Note that this engine only dispatches to transfer functions 40922059dec59c7bed235da01aff75ae522a369811Ted Kremenek/// at the statement and block-level. The analyses themselves must implement 41922059dec59c7bed235da01aff75ae522a369811Ted Kremenek/// any transfer function logic and the sub-expression level (if any). 42d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidisclass CoreEngine { 43ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks friend struct NodeBuilderContext; 44f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks friend class NodeBuilder; 45ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks friend class CommonNodeBuilder; 46d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis friend class IndirectGotoNodeBuilder; 47d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis friend class SwitchNodeBuilder; 48e36de1fe51c39d9161915dd3dbef880954af6476Ted Kremenek friend class EndOfFunctionNodeBuilder; 49a7a8a450d908b34fa5f569f2e694ebd4b61aae2fTom Carepublic: 50a7a8a450d908b34fa5f569f2e694ebd4b61aae2fTom Care typedef std::vector<std::pair<BlockEdge, const ExplodedNode*> > 5166750fa464ace9f8c41666c8585ec71a248c1ccaTed Kremenek BlocksExhausted; 52422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek 53422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek typedef std::vector<std::pair<const CFGBlock*, const ExplodedNode*> > 54422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek BlocksAborted; 55422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek 56a7a8a450d908b34fa5f569f2e694ebd4b61aae2fTom Careprivate: 57a7a8a450d908b34fa5f569f2e694ebd4b61aae2fTom Care 58d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis SubEngine& SubEng; 590111f575b968e423dccae439e501225b8314b257Zhongxing Xu 60f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek /// G - The simulation graph. Each node is a (location,state) pair. 616f42b62b6194f53bcbc349f5d17388e1936535d7Dylan Noblesmith OwningPtr<ExplodedGraph> G; 621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 63f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek /// WList - A set of queued nodes that need to be processed by the 64f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek /// worklist algorithm. It is up to the implementation of WList to decide 65f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek /// the order that nodes are processed. 66d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis WorkList* WList; 671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 68d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis /// BCounterFactory - A factory object for created BlockCounter objects. 698e49dd6e7e73b275a74338a5127a524f0765303cTed Kremenek /// These are used to record for key nodes in the ExplodedGraph the 708e49dd6e7e73b275a74338a5127a524f0765303cTed Kremenek /// number of times different CFGBlocks have been visited along a path. 71d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis BlockCounter::Factory BCounterFactory; 72f598087b4adfea164acdd5b53ea2951bde740a2dTed Kremenek 73f598087b4adfea164acdd5b53ea2951bde740a2dTed Kremenek /// The locations where we stopped doing work because we visited a location 74f598087b4adfea164acdd5b53ea2951bde740a2dTed Kremenek /// too many times. 7566750fa464ace9f8c41666c8585ec71a248c1ccaTed Kremenek BlocksExhausted blocksExhausted; 76422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek 77422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek /// The locations where we stopped because the engine aborted analysis, 78422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek /// usually because it could not reason about something. 79422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek BlocksAborted blocksAborted; 801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 813fd5f370a28552976c52e76c3035d79012d78ddaAnna Zaks /// The functions which have been analyzed through inlining. This is owned by 823fd5f370a28552976c52e76c3035d79012d78ddaAnna Zaks /// AnalysisConsumer. It can be null. 833fd5f370a28552976c52e76c3035d79012d78ddaAnna Zaks SetOfDecls *AnalyzedCallees; 843fd5f370a28552976c52e76c3035d79012d78ddaAnna Zaks 8518c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek void generateNode(const ProgramPoint &Loc, 868bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef State, 879c378f705405d37f49795d5e915989de774fe11fTed Kremenek ExplodedNode *Pred); 881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 899c378f705405d37f49795d5e915989de774fe11fTed Kremenek void HandleBlockEdge(const BlockEdge &E, ExplodedNode *Pred); 909c378f705405d37f49795d5e915989de774fe11fTed Kremenek void HandleBlockEntrance(const BlockEntrance &E, ExplodedNode *Pred); 919c378f705405d37f49795d5e915989de774fe11fTed Kremenek void HandleBlockExit(const CFGBlock *B, ExplodedNode *Pred); 929c378f705405d37f49795d5e915989de774fe11fTed Kremenek void HandlePostStmt(const CFGBlock *B, unsigned StmtIdx, ExplodedNode *Pred); 931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 949c378f705405d37f49795d5e915989de774fe11fTed Kremenek void HandleBranch(const Stmt *Cond, const Stmt *Term, const CFGBlock *B, 959c378f705405d37f49795d5e915989de774fe11fTed Kremenek ExplodedNode *Pred); 960111f575b968e423dccae439e501225b8314b257Zhongxing Xu 97f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenekprivate: 98d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis CoreEngine(const CoreEngine&); // Do not implement. 99d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis CoreEngine& operator=(const CoreEngine&); 1001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1014d2ae4a70336dc2aa11389b34946be152bb454c9Anna Zaks ExplodedNode *generateCallExitNode(ExplodedNode *N); 1024d2ae4a70336dc2aa11389b34946be152bb454c9Anna Zaks 103f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenekpublic: 104d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis /// Construct a CoreEngine object to analyze the provided CFG using 1050111f575b968e423dccae439e501225b8314b257Zhongxing Xu /// a DFS exploration of the exploded graph. 1063fd5f370a28552976c52e76c3035d79012d78ddaAnna Zaks CoreEngine(SubEngine& subengine, SetOfDecls *VisitedCallees) 107d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis : SubEng(subengine), G(new ExplodedGraph()), 10855825aa2d88fe82bf3622f195046ae48532d3106Ted Kremenek WList(WorkList::makeBFS()), 1093fd5f370a28552976c52e76c3035d79012d78ddaAnna Zaks BCounterFactory(G->getAllocator()), 1103fd5f370a28552976c52e76c3035d79012d78ddaAnna Zaks AnalyzedCallees(VisitedCallees) {} 1110111f575b968e423dccae439e501225b8314b257Zhongxing Xu 112d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis ~CoreEngine() { 1130111f575b968e423dccae439e501225b8314b257Zhongxing Xu delete WList; 1140111f575b968e423dccae439e501225b8314b257Zhongxing Xu } 1150111f575b968e423dccae439e501225b8314b257Zhongxing Xu 1160111f575b968e423dccae439e501225b8314b257Zhongxing Xu /// getGraph - Returns the exploded graph. 117031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu ExplodedGraph& getGraph() { return *G.get(); } 1181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1190111f575b968e423dccae439e501225b8314b257Zhongxing Xu /// takeGraph - Returns the exploded graph. Ownership of the graph is 120fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner /// transferred to the caller. 121031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu ExplodedGraph* takeGraph() { return G.take(); } 1220111f575b968e423dccae439e501225b8314b257Zhongxing Xu 123f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek /// ExecuteWorkList - Run the worklist algorithm for a maximum number of 124f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek /// steps. Returns true if there is still simulation state on the worklist. 1252ce43c8f43254a9edea53a20dc0e69195bc82ae0Zhongxing Xu bool ExecuteWorkList(const LocationContext *L, unsigned Steps, 1268bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef InitState); 12718c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek void ExecuteWorkListWithInitialState(const LocationContext *L, 12818c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek unsigned Steps, 1298bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef InitState, 1302ce43c8f43254a9edea53a20dc0e69195bc82ae0Zhongxing Xu ExplodedNodeSet &Dst); 131bc42c533e7d3d946704a49e242939dd232f33072Tom Care 1325903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks /// Dispatch the work list item based on the given location information. 1335903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks /// Use Pred parameter as the predecessor state. 1345903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks void dispatchWorkItem(ExplodedNode* Pred, ProgramPoint Loc, 1355903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks const WorkListUnit& WU); 1365903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks 137bc42c533e7d3d946704a49e242939dd232f33072Tom Care // Functions for external checking of whether we have unfinished work 138422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek bool wasBlockAborted() const { return !blocksAborted.empty(); } 139422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek bool wasBlocksExhausted() const { return !blocksExhausted.empty(); } 140422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek bool hasWorkRemaining() const { return wasBlocksExhausted() || 141422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek WList->hasWork() || 142422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek wasBlockAborted(); } 143422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek 144422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek /// Inform the CoreEngine that a basic block was aborted because 145422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek /// it could not be completely analyzed. 146422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek void addAbortedBlock(const ExplodedNode *node, const CFGBlock *block) { 147422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek blocksAborted.push_back(std::make_pair(block, node)); 148422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek } 149422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek 150d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis WorkList *getWorkList() const { return WList; } 151f598087b4adfea164acdd5b53ea2951bde740a2dTed Kremenek 152422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek BlocksExhausted::const_iterator blocks_exhausted_begin() const { 15366750fa464ace9f8c41666c8585ec71a248c1ccaTed Kremenek return blocksExhausted.begin(); 154f598087b4adfea164acdd5b53ea2951bde740a2dTed Kremenek } 155422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek BlocksExhausted::const_iterator blocks_exhausted_end() const { 15666750fa464ace9f8c41666c8585ec71a248c1ccaTed Kremenek return blocksExhausted.end(); 157f598087b4adfea164acdd5b53ea2951bde740a2dTed Kremenek } 158422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek BlocksAborted::const_iterator blocks_aborted_begin() const { 159422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek return blocksAborted.begin(); 160422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek } 161422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek BlocksAborted::const_iterator blocks_aborted_end() const { 162422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek return blocksAborted.end(); 163422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek } 164a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks 165dd7ddf2b2296f95e7591ca3f9791f0eb9a15ee42Anna Zaks /// \brief Enqueue the given set of nodes onto the work list. 1664d2ae4a70336dc2aa11389b34946be152bb454c9Anna Zaks void enqueue(ExplodedNodeSet &Set); 167dd7ddf2b2296f95e7591ca3f9791f0eb9a15ee42Anna Zaks 168dd7ddf2b2296f95e7591ca3f9791f0eb9a15ee42Anna Zaks /// \brief Enqueue nodes that were created as a result of processing 169dd7ddf2b2296f95e7591ca3f9791f0eb9a15ee42Anna Zaks /// a statement onto the work list. 170dd7ddf2b2296f95e7591ca3f9791f0eb9a15ee42Anna Zaks void enqueue(ExplodedNodeSet &Set, const CFGBlock *Block, unsigned Idx); 1714d2ae4a70336dc2aa11389b34946be152bb454c9Anna Zaks 1724d2ae4a70336dc2aa11389b34946be152bb454c9Anna Zaks /// \brief enqueue the nodes corresponding to the end of function onto the 1734d2ae4a70336dc2aa11389b34946be152bb454c9Anna Zaks /// end of path / work list. 1744d2ae4a70336dc2aa11389b34946be152bb454c9Anna Zaks void enqueueEndOfFunction(ExplodedNodeSet &Set); 1755903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks 1765903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks /// \brief Enqueue a single node created as a result of statement processing. 1775903a373db3d27794c90b25687e0dd6adb0e497dAnna Zaks void enqueueStmtNode(ExplodedNode *N, const CFGBlock *Block, unsigned Idx); 178a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks}; 179a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks 180c03a39e16762627b421247b12a2658be630a3300Anna Zaks// TODO: Turn into a calss. 181a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaksstruct NodeBuilderContext { 182a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks CoreEngine &Eng; 183a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks const CFGBlock *Block; 184af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks ExplodedNode *Pred; 185c9003c89c7aead1686aba89c8e3ddcea1f2bec54Anna Zaks NodeBuilderContext(CoreEngine &E, const CFGBlock *B, ExplodedNode *N) 186af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks : Eng(E), Block(B), Pred(N) { assert(B); assert(!N->isSink()); } 187ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks 188c03a39e16762627b421247b12a2658be630a3300Anna Zaks ExplodedNode *getPred() const { return Pred; } 189c03a39e16762627b421247b12a2658be630a3300Anna Zaks 190ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks /// \brief Return the CFGBlock associated with this builder. 191ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks const CFGBlock *getBlock() const { return Block; } 192ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks 193ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks /// \brief Returns the number of times the current basic block has been 194ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks /// visited on the exploded graph path. 195ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks unsigned getCurrentBlockCount() const { 196ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks return Eng.WList->getBlockCounter().getNumVisited( 197af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks Pred->getLocationContext()->getCurrentStackFrame(), 198ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks Block->getBlockID()); 199ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks } 200f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek}; 2011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 202aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// \class NodeBuilder 203aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// \brief This is the simplest builder which generates nodes in the 204aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// ExplodedGraph. 205aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// 206aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// The main benefit of the builder is that it automatically tracks the 207aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// frontier nodes (or destination set). This is the set of nodes which should 208aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// be propagated to the next step / builder. They are the nodes which have been 209aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// added to the builder (either as the input node set or as the newly 210aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// constructed nodes) but did not have any outgoing transitions added. 211f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaksclass NodeBuilder { 21299ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 213a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaksprotected: 214cd656cab3fa3dd4b0c974c6ae1c0e60880b18c22Anna Zaks const NodeBuilderContext &C; 215319a9184d5ca9f77622b45ae15c08f6b9ce01621Anna Zaks 2163152b3cb5b6a2f797d0972c81a5eb3fd69c0d620Anna Zaks /// Specifies if the builder results have been finalized. For example, if it 2173152b3cb5b6a2f797d0972c81a5eb3fd69c0d620Anna Zaks /// is set to false, autotransitions are yet to be generated. 218f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks bool Finalized; 2194e82d3cf6fd4c907265e3fa3aac0a835c35dc759Anna Zaks bool HasGeneratedNodes; 220f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks /// \brief The frontier set - a set of nodes which need to be propagated after 221f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks /// the builder dies. 2221aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks ExplodedNodeSet &Frontier; 22371fdf469a3b6d7d557b0bfba36e8659f4966c565Anna Zaks 2243152b3cb5b6a2f797d0972c81a5eb3fd69c0d620Anna Zaks /// Checkes if the results are ready. 2253152b3cb5b6a2f797d0972c81a5eb3fd69c0d620Anna Zaks virtual bool checkResults() { 226a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks if (!Finalized) 227a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks return false; 228a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks return true; 229a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks } 230f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks 231aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks bool hasNoSinksInFrontier() { 2328ff5c41f2bde7ebbe568b4c15e59f14b8befae66Anna Zaks for (iterator I = Frontier.begin(), E = Frontier.end(); I != E; ++I) { 2338ff5c41f2bde7ebbe568b4c15e59f14b8befae66Anna Zaks if ((*I)->isSink()) 2348ff5c41f2bde7ebbe568b4c15e59f14b8befae66Anna Zaks return false; 2358ff5c41f2bde7ebbe568b4c15e59f14b8befae66Anna Zaks } 2368ff5c41f2bde7ebbe568b4c15e59f14b8befae66Anna Zaks return true; 2378ff5c41f2bde7ebbe568b4c15e59f14b8befae66Anna Zaks } 2388ff5c41f2bde7ebbe568b4c15e59f14b8befae66Anna Zaks 2393152b3cb5b6a2f797d0972c81a5eb3fd69c0d620Anna Zaks /// Allow subclasses to finalize results before result_begin() is executed. 2403152b3cb5b6a2f797d0972c81a5eb3fd69c0d620Anna Zaks virtual void finalizeResults() {} 241f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks 242f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks ExplodedNode *generateNodeImpl(const ProgramPoint &PP, 2438bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef State, 244f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks ExplodedNode *Pred, 245f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks bool MarkAsSink = false); 246f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks 247f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zakspublic: 2481aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks NodeBuilder(ExplodedNode *SrcNode, ExplodedNodeSet &DstSet, 2491aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks const NodeBuilderContext &Ctx, bool F = true) 2501aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks : C(Ctx), Finalized(F), HasGeneratedNodes(false), Frontier(DstSet) { 2518ff5c41f2bde7ebbe568b4c15e59f14b8befae66Anna Zaks Frontier.Add(SrcNode); 252ad62deeb70e97da6bd514dd390ea1ce6af6ad81dAnna Zaks } 253a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks 2541aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks NodeBuilder(const ExplodedNodeSet &SrcSet, ExplodedNodeSet &DstSet, 2551aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks const NodeBuilderContext &Ctx, bool F = true) 2561aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks : C(Ctx), Finalized(F), HasGeneratedNodes(false), Frontier(DstSet) { 2571aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks Frontier.insert(SrcSet); 258aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks assert(hasNoSinksInFrontier()); 259cd656cab3fa3dd4b0c974c6ae1c0e60880b18c22Anna Zaks } 260cd656cab3fa3dd4b0c974c6ae1c0e60880b18c22Anna Zaks 261a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks virtual ~NodeBuilder() {} 262f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks 263f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks /// \brief Generates a node in the ExplodedGraph. 264f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks /// 265f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks /// When a node is marked as sink, the exploration from the node is stopped - 266f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks /// the node becomes the last node on the path. 267f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks ExplodedNode *generateNode(const ProgramPoint &PP, 2688bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef State, 269f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks ExplodedNode *Pred, 270f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks bool MarkAsSink = false) { 271f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks return generateNodeImpl(PP, State, Pred, MarkAsSink); 272f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks } 273f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks 2741aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks const ExplodedNodeSet &getResults() { 2751aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks finalizeResults(); 2761aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks assert(checkResults()); 2771aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks return Frontier; 2781aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks } 2791aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks 2801aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks typedef ExplodedNodeSet::iterator iterator; 281f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks /// \brief Iterators through the results frontier. 2821aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks inline iterator begin() { 283a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks finalizeResults(); 284a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks assert(checkResults()); 2851aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks return Frontier.begin(); 286a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks } 2871aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks inline iterator end() { 288a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks finalizeResults(); 2891aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks return Frontier.end(); 290a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks } 291f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks 2921aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks const NodeBuilderContext &getContext() { return C; } 293aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks bool hasGeneratedNodes() { return HasGeneratedNodes; } 2941aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks 295d231d0130a95336610ab9a42eaeb2cdac19992f3Anna Zaks void takeNodes(const ExplodedNodeSet &S) { 296d231d0130a95336610ab9a42eaeb2cdac19992f3Anna Zaks for (ExplodedNodeSet::iterator I = S.begin(), E = S.end(); I != E; ++I ) 297d231d0130a95336610ab9a42eaeb2cdac19992f3Anna Zaks Frontier.erase(*I); 298d231d0130a95336610ab9a42eaeb2cdac19992f3Anna Zaks } 299aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks void takeNodes(ExplodedNode *N) { Frontier.erase(N); } 300aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks void addNodes(const ExplodedNodeSet &S) { Frontier.insert(S); } 301aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks void addNodes(ExplodedNode *N) { Frontier.Add(N); } 302f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks}; 303f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks 304c03a39e16762627b421247b12a2658be630a3300Anna Zaks/// \class NodeBuilderWithSinks 305c03a39e16762627b421247b12a2658be630a3300Anna Zaks/// \brief This node builder keeps track of the generated sink nodes. 306c03a39e16762627b421247b12a2658be630a3300Anna Zaksclass NodeBuilderWithSinks: public NodeBuilder { 30799ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 308c03a39e16762627b421247b12a2658be630a3300Anna Zaksprotected: 309c03a39e16762627b421247b12a2658be630a3300Anna Zaks SmallVector<ExplodedNode*, 2> sinksGenerated; 310c03a39e16762627b421247b12a2658be630a3300Anna Zaks ProgramPoint &Location; 311c03a39e16762627b421247b12a2658be630a3300Anna Zaks 312c03a39e16762627b421247b12a2658be630a3300Anna Zakspublic: 313c03a39e16762627b421247b12a2658be630a3300Anna Zaks NodeBuilderWithSinks(ExplodedNode *Pred, ExplodedNodeSet &DstSet, 314c03a39e16762627b421247b12a2658be630a3300Anna Zaks const NodeBuilderContext &Ctx, ProgramPoint &L) 315c03a39e16762627b421247b12a2658be630a3300Anna Zaks : NodeBuilder(Pred, DstSet, Ctx), Location(L) {} 3168bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ExplodedNode *generateNode(ProgramStateRef State, 317c03a39e16762627b421247b12a2658be630a3300Anna Zaks ExplodedNode *Pred, 318c03a39e16762627b421247b12a2658be630a3300Anna Zaks const ProgramPointTag *Tag = 0, 319c03a39e16762627b421247b12a2658be630a3300Anna Zaks bool MarkAsSink = false) { 320c03a39e16762627b421247b12a2658be630a3300Anna Zaks ProgramPoint LocalLoc = (Tag ? Location.withTag(Tag): Location); 321c03a39e16762627b421247b12a2658be630a3300Anna Zaks 322c03a39e16762627b421247b12a2658be630a3300Anna Zaks ExplodedNode *N = generateNodeImpl(LocalLoc, State, Pred, MarkAsSink); 323c03a39e16762627b421247b12a2658be630a3300Anna Zaks if (N && N->isSink()) 324c03a39e16762627b421247b12a2658be630a3300Anna Zaks sinksGenerated.push_back(N); 325c03a39e16762627b421247b12a2658be630a3300Anna Zaks return N; 326c03a39e16762627b421247b12a2658be630a3300Anna Zaks } 327c03a39e16762627b421247b12a2658be630a3300Anna Zaks 328c03a39e16762627b421247b12a2658be630a3300Anna Zaks const SmallVectorImpl<ExplodedNode*> &getSinks() const { 329c03a39e16762627b421247b12a2658be630a3300Anna Zaks return sinksGenerated; 330c03a39e16762627b421247b12a2658be630a3300Anna Zaks } 331c03a39e16762627b421247b12a2658be630a3300Anna Zaks}; 332c03a39e16762627b421247b12a2658be630a3300Anna Zaks 333aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// \class StmtNodeBuilder 334aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// \brief This builder class is useful for generating nodes that resulted from 335aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// visiting a statement. The main difference from it's parent NodeBuilder is 336aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// that it creates a statement specific ProgramPoint. 337aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaksclass StmtNodeBuilder: public NodeBuilder { 338ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks NodeBuilder *EnclosingBldr; 3398ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zakspublic: 340aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks 341aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks /// \brief Constructs a StmtNodeBuilder. If the builder is going to process 342aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks /// nodes currently owned by another builder(with larger scope), use 343aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks /// Enclosing builder to transfer ownership. 344aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks StmtNodeBuilder(ExplodedNode *SrcNode, ExplodedNodeSet &DstSet, 345ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks const NodeBuilderContext &Ctx, NodeBuilder *Enclosing = 0) 346ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks : NodeBuilder(SrcNode, DstSet, Ctx), EnclosingBldr(Enclosing) { 347ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks if (EnclosingBldr) 348ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks EnclosingBldr->takeNodes(SrcNode); 349ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks } 3508ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks 351aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks StmtNodeBuilder(ExplodedNodeSet &SrcSet, ExplodedNodeSet &DstSet, 352ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks const NodeBuilderContext &Ctx, NodeBuilder *Enclosing = 0) 353ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks : NodeBuilder(SrcSet, DstSet, Ctx), EnclosingBldr(Enclosing) { 354ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks if (EnclosingBldr) 355ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks for (ExplodedNodeSet::iterator I = SrcSet.begin(), 356ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks E = SrcSet.end(); I != E; ++I ) 357ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks EnclosingBldr->takeNodes(*I); 358ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks } 359ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks 360aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks virtual ~StmtNodeBuilder(); 3616b6152ba96c164a292cc0b8d8b1d4cecbec27a60Anna Zaks 3628ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks ExplodedNode *generateNode(const Stmt *S, 3638ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks ExplodedNode *Pred, 3648bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef St, 3658ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks bool MarkAsSink = false, 3668ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks const ProgramPointTag *tag = 0, 367aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks ProgramPoint::Kind K = ProgramPoint::PostStmtKind){ 3688ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks const ProgramPoint &L = ProgramPoint::getProgramPoint(S, K, 3698ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks Pred->getLocationContext(), tag); 3708ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks return generateNodeImpl(L, St, Pred, MarkAsSink); 3718ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks } 372ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks 373ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks ExplodedNode *generateNode(const ProgramPoint &PP, 374ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks ExplodedNode *Pred, 3758bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef State, 376ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks bool MarkAsSink = false) { 377ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks return generateNodeImpl(PP, State, Pred, MarkAsSink); 378ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks } 3798ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks}; 3808ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks 381cdcc653642d4ac9255c574fabe74a48149e06733Anna Zaks/// \brief BranchNodeBuilder is responsible for constructing the nodes 382cdcc653642d4ac9255c574fabe74a48149e06733Anna Zaks/// corresponding to the two branches of the if statement - true and false. 383a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaksclass BranchNodeBuilder: public NodeBuilder { 38499ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 3859c378f705405d37f49795d5e915989de774fe11fTed Kremenek const CFGBlock *DstT; 3869c378f705405d37f49795d5e915989de774fe11fTed Kremenek const CFGBlock *DstF; 38752a16499df87730c0252b431abdf2b2e32d756a6Ted Kremenek 388520035439d7133064325c4df6378c5a8f2f05539Ted Kremenek bool InFeasibleTrue; 389520035439d7133064325c4df6378c5a8f2f05539Ted Kremenek bool InFeasibleFalse; 3901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3917d7fe6d539b3bdb1701835223cca306c325614a7Ted Kremenekpublic: 3921aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks BranchNodeBuilder(ExplodedNode *SrcNode, ExplodedNodeSet &DstSet, 3931aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks const NodeBuilderContext &C, 394ad62deeb70e97da6bd514dd390ea1ce6af6ad81dAnna Zaks const CFGBlock *dstT, const CFGBlock *dstF) 3951aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks : NodeBuilder(SrcNode, DstSet, C), DstT(dstT), DstF(dstF), 396cdcc653642d4ac9255c574fabe74a48149e06733Anna Zaks InFeasibleTrue(!DstT), InFeasibleFalse(!DstF) { 3972d950b15b2b2b650b102ecf0c6b50b45e0cb6a8aAnna Zaks // The branch node builder does not generate autotransitions. 398cdcc653642d4ac9255c574fabe74a48149e06733Anna Zaks // If there are no successors it means that both branches are infeasible. 399cdcc653642d4ac9255c574fabe74a48149e06733Anna Zaks takeNodes(SrcNode); 400cdcc653642d4ac9255c574fabe74a48149e06733Anna Zaks } 401031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu 4021aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks BranchNodeBuilder(const ExplodedNodeSet &SrcSet, ExplodedNodeSet &DstSet, 4031aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks const NodeBuilderContext &C, 4041aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks const CFGBlock *dstT, const CFGBlock *dstF) 4051aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks : NodeBuilder(SrcSet, DstSet, C), DstT(dstT), DstF(dstF), 406cdcc653642d4ac9255c574fabe74a48149e06733Anna Zaks InFeasibleTrue(!DstT), InFeasibleFalse(!DstF) { 407cdcc653642d4ac9255c574fabe74a48149e06733Anna Zaks takeNodes(SrcSet); 408cdcc653642d4ac9255c574fabe74a48149e06733Anna Zaks } 4098083414ee7cc8f5c807ed6a4e120fb4e0ab50ff8Ted Kremenek 4108bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ExplodedNode *generateNode(ProgramStateRef State, bool branch, 411c9003c89c7aead1686aba89c8e3ddcea1f2bec54Anna Zaks ExplodedNode *Pred); 4121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4139c378f705405d37f49795d5e915989de774fe11fTed Kremenek const CFGBlock *getTargetBlock(bool branch) const { 4148e49dd6e7e73b275a74338a5127a524f0765303cTed Kremenek return branch ? DstT : DstF; 4151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 4161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 41752a16499df87730c0252b431abdf2b2e32d756a6Ted Kremenek void markInfeasible(bool branch) { 418520035439d7133064325c4df6378c5a8f2f05539Ted Kremenek if (branch) 4194e82d3cf6fd4c907265e3fa3aac0a835c35dc759Anna Zaks InFeasibleTrue = true; 420520035439d7133064325c4df6378c5a8f2f05539Ted Kremenek else 4214e82d3cf6fd4c907265e3fa3aac0a835c35dc759Anna Zaks InFeasibleFalse = true; 422520035439d7133064325c4df6378c5a8f2f05539Ted Kremenek } 4231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 424520035439d7133064325c4df6378c5a8f2f05539Ted Kremenek bool isFeasible(bool branch) { 425520035439d7133064325c4df6378c5a8f2f05539Ted Kremenek return branch ? !InFeasibleTrue : !InFeasibleFalse; 42652a16499df87730c0252b431abdf2b2e32d756a6Ted Kremenek } 4277d7fe6d539b3bdb1701835223cca306c325614a7Ted Kremenek}; 428031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu 429d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidisclass IndirectGotoNodeBuilder { 430d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis CoreEngine& Eng; 4319c378f705405d37f49795d5e915989de774fe11fTed Kremenek const CFGBlock *Src; 4329c378f705405d37f49795d5e915989de774fe11fTed Kremenek const CFGBlock &DispatchBlock; 4339c378f705405d37f49795d5e915989de774fe11fTed Kremenek const Expr *E; 4349c378f705405d37f49795d5e915989de774fe11fTed Kremenek ExplodedNode *Pred; 435031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu 436754607e7cff2d902d9af8b771409449fb2f8d2bfTed Kremenekpublic: 4379c378f705405d37f49795d5e915989de774fe11fTed Kremenek IndirectGotoNodeBuilder(ExplodedNode *pred, const CFGBlock *src, 4389c378f705405d37f49795d5e915989de774fe11fTed Kremenek const Expr *e, const CFGBlock *dispatch, CoreEngine* eng) 43903509aea098772644bf4662dc1c88634818ceeccZhongxing Xu : Eng(*eng), Src(src), DispatchBlock(*dispatch), E(e), Pred(pred) {} 440754607e7cff2d902d9af8b771409449fb2f8d2bfTed Kremenek 441031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu class iterator { 44203509aea098772644bf4662dc1c88634818ceeccZhongxing Xu CFGBlock::const_succ_iterator I; 4431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 444d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis friend class IndirectGotoNodeBuilder; 44503509aea098772644bf4662dc1c88634818ceeccZhongxing Xu iterator(CFGBlock::const_succ_iterator i) : I(i) {} 446754607e7cff2d902d9af8b771409449fb2f8d2bfTed Kremenek public: 4471eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4489c378f705405d37f49795d5e915989de774fe11fTed Kremenek iterator &operator++() { ++I; return *this; } 4499c378f705405d37f49795d5e915989de774fe11fTed Kremenek bool operator!=(const iterator &X) const { return I != X.I; } 4501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 451ad8dcf4a9df0e24051dc31bf9e6f3cd138a34298Chris Lattner const LabelDecl *getLabel() const { 452ad8dcf4a9df0e24051dc31bf9e6f3cd138a34298Chris Lattner return llvm::cast<LabelStmt>((*I)->getLabel())->getDecl(); 45324f1a967741ff9f8025ee23be12ba6feacc31f77Ted Kremenek } 4541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 455ad8dcf4a9df0e24051dc31bf9e6f3cd138a34298Chris Lattner const CFGBlock *getBlock() const { 45624f1a967741ff9f8025ee23be12ba6feacc31f77Ted Kremenek return *I; 45724f1a967741ff9f8025ee23be12ba6feacc31f77Ted Kremenek } 458754607e7cff2d902d9af8b771409449fb2f8d2bfTed Kremenek }; 4591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 460031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu iterator begin() { return iterator(DispatchBlock.succ_begin()); } 461031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu iterator end() { return iterator(DispatchBlock.succ_end()); } 4621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 46318c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ExplodedNode *generateNode(const iterator &I, 4648bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef State, 465031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu bool isSink = false); 4661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4679c378f705405d37f49795d5e915989de774fe11fTed Kremenek const Expr *getTarget() const { return E; } 468754607e7cff2d902d9af8b771409449fb2f8d2bfTed Kremenek 4698bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef getState() const { return Pred->State; } 4705eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek 4715eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *getLocationContext() const { 4725eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek return Pred->getLocationContext(); 4735eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek } 474754607e7cff2d902d9af8b771409449fb2f8d2bfTed Kremenek}; 4751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 476d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidisclass SwitchNodeBuilder { 477d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis CoreEngine& Eng; 4789c378f705405d37f49795d5e915989de774fe11fTed Kremenek const CFGBlock *Src; 4799c378f705405d37f49795d5e915989de774fe11fTed Kremenek const Expr *Condition; 4809c378f705405d37f49795d5e915989de774fe11fTed Kremenek ExplodedNode *Pred; 481031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu 482daeb9a7376830d637e02b5bc51faf4750a7bce70Ted Kremenekpublic: 4839c378f705405d37f49795d5e915989de774fe11fTed Kremenek SwitchNodeBuilder(ExplodedNode *pred, const CFGBlock *src, 4849c378f705405d37f49795d5e915989de774fe11fTed Kremenek const Expr *condition, CoreEngine* eng) 485daeb9a7376830d637e02b5bc51faf4750a7bce70Ted Kremenek : Eng(*eng), Src(src), Condition(condition), Pred(pred) {} 4861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 487031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu class iterator { 48803509aea098772644bf4662dc1c88634818ceeccZhongxing Xu CFGBlock::const_succ_reverse_iterator I; 4891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 490d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis friend class SwitchNodeBuilder; 49103509aea098772644bf4662dc1c88634818ceeccZhongxing Xu iterator(CFGBlock::const_succ_reverse_iterator i) : I(i) {} 492031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu 493daeb9a7376830d637e02b5bc51faf4750a7bce70Ted Kremenek public: 4949c378f705405d37f49795d5e915989de774fe11fTed Kremenek iterator &operator++() { ++I; return *this; } 49534feff654c6304e0a59ceb1376989d28dbc956ffTed Kremenek bool operator!=(const iterator &X) const { return I != X.I; } 49634feff654c6304e0a59ceb1376989d28dbc956ffTed Kremenek bool operator==(const iterator &X) const { return I == X.I; } 4971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4989c378f705405d37f49795d5e915989de774fe11fTed Kremenek const CaseStmt *getCase() const { 499daeb9a7376830d637e02b5bc51faf4750a7bce70Ted Kremenek return llvm::cast<CaseStmt>((*I)->getLabel()); 500daeb9a7376830d637e02b5bc51faf4750a7bce70Ted Kremenek } 5011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5029c378f705405d37f49795d5e915989de774fe11fTed Kremenek const CFGBlock *getBlock() const { 503daeb9a7376830d637e02b5bc51faf4750a7bce70Ted Kremenek return *I; 504daeb9a7376830d637e02b5bc51faf4750a7bce70Ted Kremenek } 505daeb9a7376830d637e02b5bc51faf4750a7bce70Ted Kremenek }; 5061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 507031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu iterator begin() { return iterator(Src->succ_rbegin()+1); } 508031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu iterator end() { return iterator(Src->succ_rend()); } 5091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5104d3175c1e5a44251ea97b0c81e80f060629d9c08Ted Kremenek const SwitchStmt *getSwitch() const { 5114d3175c1e5a44251ea97b0c81e80f060629d9c08Ted Kremenek return llvm::cast<SwitchStmt>(Src->getTerminator()); 5124d3175c1e5a44251ea97b0c81e80f060629d9c08Ted Kremenek } 5134d3175c1e5a44251ea97b0c81e80f060629d9c08Ted Kremenek 51418c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ExplodedNode *generateCaseStmtNode(const iterator &I, 5158bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef State); 5161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5178bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ExplodedNode *generateDefaultCaseNode(ProgramStateRef State, 518031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu bool isSink = false); 5191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5209c378f705405d37f49795d5e915989de774fe11fTed Kremenek const Expr *getCondition() const { return Condition; } 521daeb9a7376830d637e02b5bc51faf4750a7bce70Ted Kremenek 5228bef8238181a30e52dea380789a7e2d760eac532Ted Kremenek ProgramStateRef getState() const { return Pred->State; } 5235eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek 5245eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek const LocationContext *getLocationContext() const { 5255eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek return Pred->getLocationContext(); 5265eca482fe895ea57bc82410222e6426c09e63284Ted Kremenek } 527daeb9a7376830d637e02b5bc51faf4750a7bce70Ted Kremenek}; 52811062b118476368fa5b294954713e5df97d8599fTed Kremenek 5293070e13dca5bbefa32acb80ce4a7b217a6220983Ted Kremenek} // end ento namespace 530f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek} // end clang namespace 531f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek 532f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek#endif 533