CoreEngine.h revision 99ba9e3bd70671f3441fb974895f226a83ce0e66
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" 199b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/ExplodedGraph.h" 209b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/WorkList.h" 219b663716449b618ba0390b1dbebc54fa8e971124Ted Kremenek#include "clang/StaticAnalyzer/Core/PathSensitive/BlockCounter.h" 22f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek#include "llvm/ADT/OwningPtr.h" 23f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek 24f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremeneknamespace clang { 250111f575b968e423dccae439e501225b8314b257Zhongxing Xu 26ca804539d908d3a0e8c72a0df5f1f571d29490bbTed Kremenekclass ProgramPointTag; 27ca804539d908d3a0e8c72a0df5f1f571d29490bbTed Kremenek 289ef6537a894c33003359b1f9b9676e9178e028b7Ted Kremeneknamespace ento { 295a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 30a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaksclass NodeBuilder; 31a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks 3224f1a967741ff9f8025ee23be12ba6feacc31f77Ted Kremenek//===----------------------------------------------------------------------===// 33d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis/// CoreEngine - Implements the core logic of the graph-reachability 34922059dec59c7bed235da01aff75ae522a369811Ted Kremenek/// analysis. It traverses the CFG and generates the ExplodedGraph. 35922059dec59c7bed235da01aff75ae522a369811Ted Kremenek/// Program "states" are treated as opaque void pointers. 36d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis/// The template class CoreEngine (which subclasses CoreEngine) 37922059dec59c7bed235da01aff75ae522a369811Ted Kremenek/// provides the matching component to the engine that knows the actual types 38922059dec59c7bed235da01aff75ae522a369811Ted Kremenek/// for states. Note that this engine only dispatches to transfer functions 39922059dec59c7bed235da01aff75ae522a369811Ted Kremenek/// at the statement and block-level. The analyses themselves must implement 40922059dec59c7bed235da01aff75ae522a369811Ted Kremenek/// any transfer function logic and the sub-expression level (if any). 41d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidisclass CoreEngine { 42ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks friend struct NodeBuilderContext; 43f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks friend class NodeBuilder; 44ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks friend class CommonNodeBuilder; 45d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis friend class IndirectGotoNodeBuilder; 46d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis friend class SwitchNodeBuilder; 47e36de1fe51c39d9161915dd3dbef880954af6476Ted Kremenek friend class EndOfFunctionNodeBuilder; 48d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis friend class CallEnterNodeBuilder; 49d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis friend class CallExitNodeBuilder; 500111f575b968e423dccae439e501225b8314b257Zhongxing Xu 51a7a8a450d908b34fa5f569f2e694ebd4b61aae2fTom Carepublic: 52a7a8a450d908b34fa5f569f2e694ebd4b61aae2fTom Care typedef std::vector<std::pair<BlockEdge, const ExplodedNode*> > 5366750fa464ace9f8c41666c8585ec71a248c1ccaTed Kremenek BlocksExhausted; 54422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek 55422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek typedef std::vector<std::pair<const CFGBlock*, const ExplodedNode*> > 56422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek BlocksAborted; 57422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek 58a7a8a450d908b34fa5f569f2e694ebd4b61aae2fTom Careprivate: 59a7a8a450d908b34fa5f569f2e694ebd4b61aae2fTom Care 60d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis SubEngine& SubEng; 610111f575b968e423dccae439e501225b8314b257Zhongxing Xu 62f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek /// G - The simulation graph. Each node is a (location,state) pair. 6338b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu llvm::OwningPtr<ExplodedGraph> G; 641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 65f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek /// WList - A set of queued nodes that need to be processed by the 66f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek /// worklist algorithm. It is up to the implementation of WList to decide 67f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek /// the order that nodes are processed. 68d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis WorkList* WList; 691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 70d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis /// BCounterFactory - A factory object for created BlockCounter objects. 718e49dd6e7e73b275a74338a5127a524f0765303cTed Kremenek /// These are used to record for key nodes in the ExplodedGraph the 728e49dd6e7e73b275a74338a5127a524f0765303cTed Kremenek /// number of times different CFGBlocks have been visited along a path. 73d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis BlockCounter::Factory BCounterFactory; 74f598087b4adfea164acdd5b53ea2951bde740a2dTed Kremenek 75f598087b4adfea164acdd5b53ea2951bde740a2dTed Kremenek /// The locations where we stopped doing work because we visited a location 76f598087b4adfea164acdd5b53ea2951bde740a2dTed Kremenek /// too many times. 7766750fa464ace9f8c41666c8585ec71a248c1ccaTed Kremenek BlocksExhausted blocksExhausted; 78422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek 79422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek /// The locations where we stopped because the engine aborted analysis, 80422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek /// usually because it could not reason about something. 81422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek BlocksAborted blocksAborted; 821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8318c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek void generateNode(const ProgramPoint &Loc, 8418c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek const ProgramState *State, 859c378f705405d37f49795d5e915989de774fe11fTed Kremenek ExplodedNode *Pred); 861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 879c378f705405d37f49795d5e915989de774fe11fTed Kremenek void HandleBlockEdge(const BlockEdge &E, ExplodedNode *Pred); 889c378f705405d37f49795d5e915989de774fe11fTed Kremenek void HandleBlockEntrance(const BlockEntrance &E, ExplodedNode *Pred); 899c378f705405d37f49795d5e915989de774fe11fTed Kremenek void HandleBlockExit(const CFGBlock *B, ExplodedNode *Pred); 909c378f705405d37f49795d5e915989de774fe11fTed Kremenek void HandlePostStmt(const CFGBlock *B, unsigned StmtIdx, ExplodedNode *Pred); 911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 929c378f705405d37f49795d5e915989de774fe11fTed Kremenek void HandleBranch(const Stmt *Cond, const Stmt *Term, const CFGBlock *B, 939c378f705405d37f49795d5e915989de774fe11fTed Kremenek ExplodedNode *Pred); 94102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor void HandleCallEnter(const CallEnter &L, const CFGBlock *Block, 95102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor unsigned Index, ExplodedNode *Pred); 96102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor void HandleCallExit(const CallExit &L, ExplodedNode *Pred); 970111f575b968e423dccae439e501225b8314b257Zhongxing Xu 98f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenekprivate: 99d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis CoreEngine(const CoreEngine&); // Do not implement. 100d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis CoreEngine& operator=(const CoreEngine&); 1011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 102dd7ddf2b2296f95e7591ca3f9791f0eb9a15ee42Anna Zaks void enqueueStmtNode(ExplodedNode *N, 103dd7ddf2b2296f95e7591ca3f9791f0eb9a15ee42Anna Zaks const CFGBlock *Block, unsigned Idx); 104dd7ddf2b2296f95e7591ca3f9791f0eb9a15ee42Anna Zaks 1054d2ae4a70336dc2aa11389b34946be152bb454c9Anna Zaks ExplodedNode *generateCallExitNode(ExplodedNode *N); 1064d2ae4a70336dc2aa11389b34946be152bb454c9Anna Zaks 107f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenekpublic: 108d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis /// Construct a CoreEngine object to analyze the provided CFG using 1090111f575b968e423dccae439e501225b8314b257Zhongxing Xu /// a DFS exploration of the exploded graph. 110d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis CoreEngine(SubEngine& subengine) 111d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis : SubEng(subengine), G(new ExplodedGraph()), 11255825aa2d88fe82bf3622f195046ae48532d3106Ted Kremenek WList(WorkList::makeBFS()), 113f598087b4adfea164acdd5b53ea2951bde740a2dTed Kremenek BCounterFactory(G->getAllocator()) {} 1140111f575b968e423dccae439e501225b8314b257Zhongxing Xu 115d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis /// Construct a CoreEngine object to analyze the provided CFG and to 1160111f575b968e423dccae439e501225b8314b257Zhongxing Xu /// use the provided worklist object to execute the worklist algorithm. 117d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis /// The CoreEngine object assumes ownership of 'wlist'. 118d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis CoreEngine(WorkList* wlist, SubEngine& subengine) 119d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis : SubEng(subengine), G(new ExplodedGraph()), WList(wlist), 120f598087b4adfea164acdd5b53ea2951bde740a2dTed Kremenek BCounterFactory(G->getAllocator()) {} 1210111f575b968e423dccae439e501225b8314b257Zhongxing Xu 122d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis ~CoreEngine() { 1230111f575b968e423dccae439e501225b8314b257Zhongxing Xu delete WList; 1240111f575b968e423dccae439e501225b8314b257Zhongxing Xu } 1250111f575b968e423dccae439e501225b8314b257Zhongxing Xu 1260111f575b968e423dccae439e501225b8314b257Zhongxing Xu /// getGraph - Returns the exploded graph. 127031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu ExplodedGraph& getGraph() { return *G.get(); } 1281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1290111f575b968e423dccae439e501225b8314b257Zhongxing Xu /// takeGraph - Returns the exploded graph. Ownership of the graph is 130fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner /// transferred to the caller. 131031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu ExplodedGraph* takeGraph() { return G.take(); } 1320111f575b968e423dccae439e501225b8314b257Zhongxing Xu 133f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek /// ExecuteWorkList - Run the worklist algorithm for a maximum number of 134f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek /// steps. Returns true if there is still simulation state on the worklist. 1352ce43c8f43254a9edea53a20dc0e69195bc82ae0Zhongxing Xu bool ExecuteWorkList(const LocationContext *L, unsigned Steps, 13618c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek const ProgramState *InitState); 13718c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek void ExecuteWorkListWithInitialState(const LocationContext *L, 13818c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek unsigned Steps, 13918c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek const ProgramState *InitState, 1402ce43c8f43254a9edea53a20dc0e69195bc82ae0Zhongxing Xu ExplodedNodeSet &Dst); 141bc42c533e7d3d946704a49e242939dd232f33072Tom Care 142bc42c533e7d3d946704a49e242939dd232f33072Tom Care // Functions for external checking of whether we have unfinished work 143422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek bool wasBlockAborted() const { return !blocksAborted.empty(); } 144422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek bool wasBlocksExhausted() const { return !blocksExhausted.empty(); } 145422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek bool hasWorkRemaining() const { return wasBlocksExhausted() || 146422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek WList->hasWork() || 147422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek wasBlockAborted(); } 148422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek 149422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek /// Inform the CoreEngine that a basic block was aborted because 150422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek /// it could not be completely analyzed. 151422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek void addAbortedBlock(const ExplodedNode *node, const CFGBlock *block) { 152422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek blocksAborted.push_back(std::make_pair(block, node)); 153422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek } 154422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek 155d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis WorkList *getWorkList() const { return WList; } 156f598087b4adfea164acdd5b53ea2951bde740a2dTed Kremenek 157422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek BlocksExhausted::const_iterator blocks_exhausted_begin() const { 15866750fa464ace9f8c41666c8585ec71a248c1ccaTed Kremenek return blocksExhausted.begin(); 159f598087b4adfea164acdd5b53ea2951bde740a2dTed Kremenek } 160422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek BlocksExhausted::const_iterator blocks_exhausted_end() const { 16166750fa464ace9f8c41666c8585ec71a248c1ccaTed Kremenek return blocksExhausted.end(); 162f598087b4adfea164acdd5b53ea2951bde740a2dTed Kremenek } 163422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek BlocksAborted::const_iterator blocks_aborted_begin() const { 164422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek return blocksAborted.begin(); 165422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek } 166422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek BlocksAborted::const_iterator blocks_aborted_end() const { 167422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek return blocksAborted.end(); 168422ab7a49a9a4252dbc6350e49d7a5708337b9c7Ted Kremenek } 169a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks 170dd7ddf2b2296f95e7591ca3f9791f0eb9a15ee42Anna Zaks /// \brief Enqueue the given set of nodes onto the work list. 1714d2ae4a70336dc2aa11389b34946be152bb454c9Anna Zaks void enqueue(ExplodedNodeSet &Set); 172dd7ddf2b2296f95e7591ca3f9791f0eb9a15ee42Anna Zaks 173dd7ddf2b2296f95e7591ca3f9791f0eb9a15ee42Anna Zaks /// \brief Enqueue nodes that were created as a result of processing 174dd7ddf2b2296f95e7591ca3f9791f0eb9a15ee42Anna Zaks /// a statement onto the work list. 175dd7ddf2b2296f95e7591ca3f9791f0eb9a15ee42Anna Zaks void enqueue(ExplodedNodeSet &Set, const CFGBlock *Block, unsigned Idx); 1764d2ae4a70336dc2aa11389b34946be152bb454c9Anna Zaks 1774d2ae4a70336dc2aa11389b34946be152bb454c9Anna Zaks /// \brief enqueue the nodes corresponding to the end of function onto the 1784d2ae4a70336dc2aa11389b34946be152bb454c9Anna Zaks /// end of path / work list. 1794d2ae4a70336dc2aa11389b34946be152bb454c9Anna Zaks void enqueueEndOfFunction(ExplodedNodeSet &Set); 180a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks}; 181a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks 182c03a39e16762627b421247b12a2658be630a3300Anna Zaks// TODO: Turn into a calss. 183a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaksstruct NodeBuilderContext { 184a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks CoreEngine &Eng; 185a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks const CFGBlock *Block; 186af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks ExplodedNode *Pred; 187c9003c89c7aead1686aba89c8e3ddcea1f2bec54Anna Zaks NodeBuilderContext(CoreEngine &E, const CFGBlock *B, ExplodedNode *N) 188af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks : Eng(E), Block(B), Pred(N) { assert(B); assert(!N->isSink()); } 189ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks 190c03a39e16762627b421247b12a2658be630a3300Anna Zaks ExplodedNode *getPred() const { return Pred; } 191c03a39e16762627b421247b12a2658be630a3300Anna Zaks 192ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks /// \brief Return the CFGBlock associated with this builder. 193ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks const CFGBlock *getBlock() const { return Block; } 194ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks 195ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks /// \brief Returns the number of times the current basic block has been 196ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks /// visited on the exploded graph path. 197ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks unsigned getCurrentBlockCount() const { 198ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks return Eng.WList->getBlockCounter().getNumVisited( 199af498a28797c075c48d7e943df5f5a8e78ed8eb0Anna Zaks Pred->getLocationContext()->getCurrentStackFrame(), 200ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks Block->getBlockID()); 201ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks } 202f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek}; 2031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 204aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// \class NodeBuilder 205aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// \brief This is the simplest builder which generates nodes in the 206aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// ExplodedGraph. 207aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// 208aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// The main benefit of the builder is that it automatically tracks the 209aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// frontier nodes (or destination set). This is the set of nodes which should 210aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// be propagated to the next step / builder. They are the nodes which have been 211aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// added to the builder (either as the input node set or as the newly 212aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// constructed nodes) but did not have any outgoing transitions added. 213f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaksclass NodeBuilder { 21499ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 215a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaksprotected: 216cd656cab3fa3dd4b0c974c6ae1c0e60880b18c22Anna Zaks const NodeBuilderContext &C; 217319a9184d5ca9f77622b45ae15c08f6b9ce01621Anna Zaks 2183152b3cb5b6a2f797d0972c81a5eb3fd69c0d620Anna Zaks /// Specifies if the builder results have been finalized. For example, if it 2193152b3cb5b6a2f797d0972c81a5eb3fd69c0d620Anna Zaks /// is set to false, autotransitions are yet to be generated. 220f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks bool Finalized; 2214e82d3cf6fd4c907265e3fa3aac0a835c35dc759Anna Zaks bool HasGeneratedNodes; 222f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks /// \brief The frontier set - a set of nodes which need to be propagated after 223f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks /// the builder dies. 2241aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks ExplodedNodeSet &Frontier; 22571fdf469a3b6d7d557b0bfba36e8659f4966c565Anna Zaks 2263152b3cb5b6a2f797d0972c81a5eb3fd69c0d620Anna Zaks /// Checkes if the results are ready. 2273152b3cb5b6a2f797d0972c81a5eb3fd69c0d620Anna Zaks virtual bool checkResults() { 228a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks if (!Finalized) 229a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks return false; 230a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks return true; 231a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks } 232f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks 233aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks bool hasNoSinksInFrontier() { 2348ff5c41f2bde7ebbe568b4c15e59f14b8befae66Anna Zaks for (iterator I = Frontier.begin(), E = Frontier.end(); I != E; ++I) { 2358ff5c41f2bde7ebbe568b4c15e59f14b8befae66Anna Zaks if ((*I)->isSink()) 2368ff5c41f2bde7ebbe568b4c15e59f14b8befae66Anna Zaks return false; 2378ff5c41f2bde7ebbe568b4c15e59f14b8befae66Anna Zaks } 2388ff5c41f2bde7ebbe568b4c15e59f14b8befae66Anna Zaks return true; 2398ff5c41f2bde7ebbe568b4c15e59f14b8befae66Anna Zaks } 2408ff5c41f2bde7ebbe568b4c15e59f14b8befae66Anna Zaks 2413152b3cb5b6a2f797d0972c81a5eb3fd69c0d620Anna Zaks /// Allow subclasses to finalize results before result_begin() is executed. 2423152b3cb5b6a2f797d0972c81a5eb3fd69c0d620Anna Zaks virtual void finalizeResults() {} 243f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks 244f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks ExplodedNode *generateNodeImpl(const ProgramPoint &PP, 245f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks const ProgramState *State, 246f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks ExplodedNode *Pred, 247f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks bool MarkAsSink = false); 248f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks 249f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zakspublic: 2501aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks NodeBuilder(ExplodedNode *SrcNode, ExplodedNodeSet &DstSet, 2511aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks const NodeBuilderContext &Ctx, bool F = true) 2521aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks : C(Ctx), Finalized(F), HasGeneratedNodes(false), Frontier(DstSet) { 2538ff5c41f2bde7ebbe568b4c15e59f14b8befae66Anna Zaks Frontier.Add(SrcNode); 254ad62deeb70e97da6bd514dd390ea1ce6af6ad81dAnna Zaks } 255a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks 2561aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks NodeBuilder(const ExplodedNodeSet &SrcSet, ExplodedNodeSet &DstSet, 2571aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks const NodeBuilderContext &Ctx, bool F = true) 2581aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks : C(Ctx), Finalized(F), HasGeneratedNodes(false), Frontier(DstSet) { 2591aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks Frontier.insert(SrcSet); 260aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks assert(hasNoSinksInFrontier()); 261cd656cab3fa3dd4b0c974c6ae1c0e60880b18c22Anna Zaks } 262cd656cab3fa3dd4b0c974c6ae1c0e60880b18c22Anna Zaks 263a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks virtual ~NodeBuilder() {} 264f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks 265f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks /// \brief Generates a node in the ExplodedGraph. 266f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks /// 267f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks /// When a node is marked as sink, the exploration from the node is stopped - 268f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks /// the node becomes the last node on the path. 269f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks ExplodedNode *generateNode(const ProgramPoint &PP, 270f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks const ProgramState *State, 271f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks ExplodedNode *Pred, 272f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks bool MarkAsSink = false) { 273f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks return generateNodeImpl(PP, State, Pred, MarkAsSink); 274f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks } 275f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks 2761aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks const ExplodedNodeSet &getResults() { 2771aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks finalizeResults(); 2781aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks assert(checkResults()); 2791aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks return Frontier; 2801aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks } 2811aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks 2821aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks typedef ExplodedNodeSet::iterator iterator; 283f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks /// \brief Iterators through the results frontier. 2841aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks inline iterator begin() { 285a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks finalizeResults(); 286a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks assert(checkResults()); 2871aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks return Frontier.begin(); 288a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks } 2891aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks inline iterator end() { 290a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks finalizeResults(); 2911aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks return Frontier.end(); 292a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks } 293f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks 2941aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks const NodeBuilderContext &getContext() { return C; } 295aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks bool hasGeneratedNodes() { return HasGeneratedNodes; } 2961aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks 297d231d0130a95336610ab9a42eaeb2cdac19992f3Anna Zaks void takeNodes(const ExplodedNodeSet &S) { 298d231d0130a95336610ab9a42eaeb2cdac19992f3Anna Zaks for (ExplodedNodeSet::iterator I = S.begin(), E = S.end(); I != E; ++I ) 299d231d0130a95336610ab9a42eaeb2cdac19992f3Anna Zaks Frontier.erase(*I); 300d231d0130a95336610ab9a42eaeb2cdac19992f3Anna Zaks } 301aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks void takeNodes(ExplodedNode *N) { Frontier.erase(N); } 302aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks void addNodes(const ExplodedNodeSet &S) { Frontier.insert(S); } 303aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks void addNodes(ExplodedNode *N) { Frontier.Add(N); } 304f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks}; 305f05aac8472d8ed081a361a218fd14d59ddc91b85Anna Zaks 306c03a39e16762627b421247b12a2658be630a3300Anna Zaks/// \class NodeBuilderWithSinks 307c03a39e16762627b421247b12a2658be630a3300Anna Zaks/// \brief This node builder keeps track of the generated sink nodes. 308c03a39e16762627b421247b12a2658be630a3300Anna Zaksclass NodeBuilderWithSinks: public NodeBuilder { 30999ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 310c03a39e16762627b421247b12a2658be630a3300Anna Zaksprotected: 311c03a39e16762627b421247b12a2658be630a3300Anna Zaks SmallVector<ExplodedNode*, 2> sinksGenerated; 312c03a39e16762627b421247b12a2658be630a3300Anna Zaks ProgramPoint &Location; 313c03a39e16762627b421247b12a2658be630a3300Anna Zaks 314c03a39e16762627b421247b12a2658be630a3300Anna Zakspublic: 315c03a39e16762627b421247b12a2658be630a3300Anna Zaks NodeBuilderWithSinks(ExplodedNode *Pred, ExplodedNodeSet &DstSet, 316c03a39e16762627b421247b12a2658be630a3300Anna Zaks const NodeBuilderContext &Ctx, ProgramPoint &L) 317c03a39e16762627b421247b12a2658be630a3300Anna Zaks : NodeBuilder(Pred, DstSet, Ctx), Location(L) {} 318c03a39e16762627b421247b12a2658be630a3300Anna Zaks ExplodedNode *generateNode(const ProgramState *State, 319c03a39e16762627b421247b12a2658be630a3300Anna Zaks ExplodedNode *Pred, 320c03a39e16762627b421247b12a2658be630a3300Anna Zaks const ProgramPointTag *Tag = 0, 321c03a39e16762627b421247b12a2658be630a3300Anna Zaks bool MarkAsSink = false) { 322c03a39e16762627b421247b12a2658be630a3300Anna Zaks ProgramPoint LocalLoc = (Tag ? Location.withTag(Tag): Location); 323c03a39e16762627b421247b12a2658be630a3300Anna Zaks 324c03a39e16762627b421247b12a2658be630a3300Anna Zaks ExplodedNode *N = generateNodeImpl(LocalLoc, State, Pred, MarkAsSink); 325c03a39e16762627b421247b12a2658be630a3300Anna Zaks if (N && N->isSink()) 326c03a39e16762627b421247b12a2658be630a3300Anna Zaks sinksGenerated.push_back(N); 327c03a39e16762627b421247b12a2658be630a3300Anna Zaks return N; 328c03a39e16762627b421247b12a2658be630a3300Anna Zaks } 329c03a39e16762627b421247b12a2658be630a3300Anna Zaks 330c03a39e16762627b421247b12a2658be630a3300Anna Zaks const SmallVectorImpl<ExplodedNode*> &getSinks() const { 331c03a39e16762627b421247b12a2658be630a3300Anna Zaks return sinksGenerated; 332c03a39e16762627b421247b12a2658be630a3300Anna Zaks } 333c03a39e16762627b421247b12a2658be630a3300Anna Zaks}; 334c03a39e16762627b421247b12a2658be630a3300Anna Zaks 335aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// \class StmtNodeBuilder 336aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// \brief This builder class is useful for generating nodes that resulted from 337aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// visiting a statement. The main difference from it's parent NodeBuilder is 338aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks/// that it creates a statement specific ProgramPoint. 339aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaksclass StmtNodeBuilder: public NodeBuilder { 340ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks NodeBuilder *EnclosingBldr; 3418ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zakspublic: 342aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks 343aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks /// \brief Constructs a StmtNodeBuilder. If the builder is going to process 344aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks /// nodes currently owned by another builder(with larger scope), use 345aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks /// Enclosing builder to transfer ownership. 346aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks StmtNodeBuilder(ExplodedNode *SrcNode, ExplodedNodeSet &DstSet, 347ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks const NodeBuilderContext &Ctx, NodeBuilder *Enclosing = 0) 348ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks : NodeBuilder(SrcNode, DstSet, Ctx), EnclosingBldr(Enclosing) { 349ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks if (EnclosingBldr) 350ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks EnclosingBldr->takeNodes(SrcNode); 351ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks } 3528ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks 353aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks StmtNodeBuilder(ExplodedNodeSet &SrcSet, ExplodedNodeSet &DstSet, 354ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks const NodeBuilderContext &Ctx, NodeBuilder *Enclosing = 0) 355ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks : NodeBuilder(SrcSet, DstSet, Ctx), EnclosingBldr(Enclosing) { 356ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks if (EnclosingBldr) 357ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks for (ExplodedNodeSet::iterator I = SrcSet.begin(), 358ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks E = SrcSet.end(); I != E; ++I ) 359ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks EnclosingBldr->takeNodes(*I); 360ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks } 361ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks 362aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks virtual ~StmtNodeBuilder(); 3636b6152ba96c164a292cc0b8d8b1d4cecbec27a60Anna Zaks 3648ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks ExplodedNode *generateNode(const Stmt *S, 3658ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks ExplodedNode *Pred, 3668ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks const ProgramState *St, 3678ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks bool MarkAsSink = false, 3688ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks const ProgramPointTag *tag = 0, 369aa0aeb1cbe117db68d35700cb3a34aace0f99b99Anna Zaks ProgramPoint::Kind K = ProgramPoint::PostStmtKind){ 3708ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks const ProgramPoint &L = ProgramPoint::getProgramPoint(S, K, 3718ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks Pred->getLocationContext(), tag); 3728ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks return generateNodeImpl(L, St, Pred, MarkAsSink); 3738ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks } 374ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks 375ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks ExplodedNode *generateNode(const ProgramPoint &PP, 376ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks ExplodedNode *Pred, 377ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks const ProgramState *State, 378ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks bool MarkAsSink = false) { 379ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks return generateNodeImpl(PP, State, Pred, MarkAsSink); 380ebae6d0209e1ec3d5ea14f9e63bd0d740218ed14Anna Zaks } 3818ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks}; 3828ad8c546372fe602708cb7ceeaf0ebbb866735c6Anna Zaks 383cdcc653642d4ac9255c574fabe74a48149e06733Anna Zaks/// \brief BranchNodeBuilder is responsible for constructing the nodes 384cdcc653642d4ac9255c574fabe74a48149e06733Anna Zaks/// corresponding to the two branches of the if statement - true and false. 385a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaksclass BranchNodeBuilder: public NodeBuilder { 38699ba9e3bd70671f3441fb974895f226a83ce0e66David Blaikie virtual void anchor(); 3879c378f705405d37f49795d5e915989de774fe11fTed Kremenek const CFGBlock *DstT; 3889c378f705405d37f49795d5e915989de774fe11fTed Kremenek const CFGBlock *DstF; 38952a16499df87730c0252b431abdf2b2e32d756a6Ted Kremenek 390520035439d7133064325c4df6378c5a8f2f05539Ted Kremenek bool InFeasibleTrue; 391520035439d7133064325c4df6378c5a8f2f05539Ted Kremenek bool InFeasibleFalse; 3921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3937d7fe6d539b3bdb1701835223cca306c325614a7Ted Kremenekpublic: 3941aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks BranchNodeBuilder(ExplodedNode *SrcNode, ExplodedNodeSet &DstSet, 3951aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks const NodeBuilderContext &C, 396ad62deeb70e97da6bd514dd390ea1ce6af6ad81dAnna Zaks const CFGBlock *dstT, const CFGBlock *dstF) 3971aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks : NodeBuilder(SrcNode, DstSet, C), DstT(dstT), DstF(dstF), 398cdcc653642d4ac9255c574fabe74a48149e06733Anna Zaks InFeasibleTrue(!DstT), InFeasibleFalse(!DstF) { 3992d950b15b2b2b650b102ecf0c6b50b45e0cb6a8aAnna Zaks // The branch node builder does not generate autotransitions. 400cdcc653642d4ac9255c574fabe74a48149e06733Anna Zaks // If there are no successors it means that both branches are infeasible. 401cdcc653642d4ac9255c574fabe74a48149e06733Anna Zaks takeNodes(SrcNode); 402cdcc653642d4ac9255c574fabe74a48149e06733Anna Zaks } 403031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu 4041aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks BranchNodeBuilder(const ExplodedNodeSet &SrcSet, ExplodedNodeSet &DstSet, 4051aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks const NodeBuilderContext &C, 4061aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks const CFGBlock *dstT, const CFGBlock *dstF) 4071aae01a8308d2f8e31adab3f4d7ac35543aac680Anna Zaks : NodeBuilder(SrcSet, DstSet, C), DstT(dstT), DstF(dstF), 408cdcc653642d4ac9255c574fabe74a48149e06733Anna Zaks InFeasibleTrue(!DstT), InFeasibleFalse(!DstF) { 409cdcc653642d4ac9255c574fabe74a48149e06733Anna Zaks takeNodes(SrcSet); 410cdcc653642d4ac9255c574fabe74a48149e06733Anna Zaks } 4118083414ee7cc8f5c807ed6a4e120fb4e0ab50ff8Ted Kremenek 412a19f4af7a94835ce4693bfe12d6270754e79eb56Anna Zaks ExplodedNode *generateNode(const ProgramState *State, bool branch, 413c9003c89c7aead1686aba89c8e3ddcea1f2bec54Anna Zaks ExplodedNode *Pred); 4141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4159c378f705405d37f49795d5e915989de774fe11fTed Kremenek const CFGBlock *getTargetBlock(bool branch) const { 4168e49dd6e7e73b275a74338a5127a524f0765303cTed Kremenek return branch ? DstT : DstF; 4171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 4181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 41952a16499df87730c0252b431abdf2b2e32d756a6Ted Kremenek void markInfeasible(bool branch) { 420520035439d7133064325c4df6378c5a8f2f05539Ted Kremenek if (branch) 4214e82d3cf6fd4c907265e3fa3aac0a835c35dc759Anna Zaks InFeasibleTrue = true; 422520035439d7133064325c4df6378c5a8f2f05539Ted Kremenek else 4234e82d3cf6fd4c907265e3fa3aac0a835c35dc759Anna Zaks InFeasibleFalse = true; 424520035439d7133064325c4df6378c5a8f2f05539Ted Kremenek } 4251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 426520035439d7133064325c4df6378c5a8f2f05539Ted Kremenek bool isFeasible(bool branch) { 427520035439d7133064325c4df6378c5a8f2f05539Ted Kremenek return branch ? !InFeasibleTrue : !InFeasibleFalse; 42852a16499df87730c0252b431abdf2b2e32d756a6Ted Kremenek } 4297d7fe6d539b3bdb1701835223cca306c325614a7Ted Kremenek}; 430031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu 431d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidisclass IndirectGotoNodeBuilder { 432d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis CoreEngine& Eng; 4339c378f705405d37f49795d5e915989de774fe11fTed Kremenek const CFGBlock *Src; 4349c378f705405d37f49795d5e915989de774fe11fTed Kremenek const CFGBlock &DispatchBlock; 4359c378f705405d37f49795d5e915989de774fe11fTed Kremenek const Expr *E; 4369c378f705405d37f49795d5e915989de774fe11fTed Kremenek ExplodedNode *Pred; 437031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu 438754607e7cff2d902d9af8b771409449fb2f8d2bfTed Kremenekpublic: 4399c378f705405d37f49795d5e915989de774fe11fTed Kremenek IndirectGotoNodeBuilder(ExplodedNode *pred, const CFGBlock *src, 4409c378f705405d37f49795d5e915989de774fe11fTed Kremenek const Expr *e, const CFGBlock *dispatch, CoreEngine* eng) 44103509aea098772644bf4662dc1c88634818ceeccZhongxing Xu : Eng(*eng), Src(src), DispatchBlock(*dispatch), E(e), Pred(pred) {} 442754607e7cff2d902d9af8b771409449fb2f8d2bfTed Kremenek 443031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu class iterator { 44403509aea098772644bf4662dc1c88634818ceeccZhongxing Xu CFGBlock::const_succ_iterator I; 4451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 446d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis friend class IndirectGotoNodeBuilder; 44703509aea098772644bf4662dc1c88634818ceeccZhongxing Xu iterator(CFGBlock::const_succ_iterator i) : I(i) {} 448754607e7cff2d902d9af8b771409449fb2f8d2bfTed Kremenek public: 4491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4509c378f705405d37f49795d5e915989de774fe11fTed Kremenek iterator &operator++() { ++I; return *this; } 4519c378f705405d37f49795d5e915989de774fe11fTed Kremenek bool operator!=(const iterator &X) const { return I != X.I; } 4521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 453ad8dcf4a9df0e24051dc31bf9e6f3cd138a34298Chris Lattner const LabelDecl *getLabel() const { 454ad8dcf4a9df0e24051dc31bf9e6f3cd138a34298Chris Lattner return llvm::cast<LabelStmt>((*I)->getLabel())->getDecl(); 45524f1a967741ff9f8025ee23be12ba6feacc31f77Ted Kremenek } 4561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 457ad8dcf4a9df0e24051dc31bf9e6f3cd138a34298Chris Lattner const CFGBlock *getBlock() const { 45824f1a967741ff9f8025ee23be12ba6feacc31f77Ted Kremenek return *I; 45924f1a967741ff9f8025ee23be12ba6feacc31f77Ted Kremenek } 460754607e7cff2d902d9af8b771409449fb2f8d2bfTed Kremenek }; 4611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 462031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu iterator begin() { return iterator(DispatchBlock.succ_begin()); } 463031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu iterator end() { return iterator(DispatchBlock.succ_end()); } 4641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 46518c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ExplodedNode *generateNode(const iterator &I, 46618c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek const ProgramState *State, 467031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu bool isSink = false); 4681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4699c378f705405d37f49795d5e915989de774fe11fTed Kremenek const Expr *getTarget() const { return E; } 470754607e7cff2d902d9af8b771409449fb2f8d2bfTed Kremenek 47118c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek const ProgramState *getState() const { return Pred->State; } 472754607e7cff2d902d9af8b771409449fb2f8d2bfTed Kremenek}; 4731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 474d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidisclass SwitchNodeBuilder { 475d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis CoreEngine& Eng; 4769c378f705405d37f49795d5e915989de774fe11fTed Kremenek const CFGBlock *Src; 4779c378f705405d37f49795d5e915989de774fe11fTed Kremenek const Expr *Condition; 4789c378f705405d37f49795d5e915989de774fe11fTed Kremenek ExplodedNode *Pred; 479031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu 480daeb9a7376830d637e02b5bc51faf4750a7bce70Ted Kremenekpublic: 4819c378f705405d37f49795d5e915989de774fe11fTed Kremenek SwitchNodeBuilder(ExplodedNode *pred, const CFGBlock *src, 4829c378f705405d37f49795d5e915989de774fe11fTed Kremenek const Expr *condition, CoreEngine* eng) 483daeb9a7376830d637e02b5bc51faf4750a7bce70Ted Kremenek : Eng(*eng), Src(src), Condition(condition), Pred(pred) {} 4841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 485031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu class iterator { 48603509aea098772644bf4662dc1c88634818ceeccZhongxing Xu CFGBlock::const_succ_reverse_iterator I; 4871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 488d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis friend class SwitchNodeBuilder; 48903509aea098772644bf4662dc1c88634818ceeccZhongxing Xu iterator(CFGBlock::const_succ_reverse_iterator i) : I(i) {} 490031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu 491daeb9a7376830d637e02b5bc51faf4750a7bce70Ted Kremenek public: 4929c378f705405d37f49795d5e915989de774fe11fTed Kremenek iterator &operator++() { ++I; return *this; } 49334feff654c6304e0a59ceb1376989d28dbc956ffTed Kremenek bool operator!=(const iterator &X) const { return I != X.I; } 49434feff654c6304e0a59ceb1376989d28dbc956ffTed Kremenek bool operator==(const iterator &X) const { return I == X.I; } 4951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4969c378f705405d37f49795d5e915989de774fe11fTed Kremenek const CaseStmt *getCase() const { 497daeb9a7376830d637e02b5bc51faf4750a7bce70Ted Kremenek return llvm::cast<CaseStmt>((*I)->getLabel()); 498daeb9a7376830d637e02b5bc51faf4750a7bce70Ted Kremenek } 4991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5009c378f705405d37f49795d5e915989de774fe11fTed Kremenek const CFGBlock *getBlock() const { 501daeb9a7376830d637e02b5bc51faf4750a7bce70Ted Kremenek return *I; 502daeb9a7376830d637e02b5bc51faf4750a7bce70Ted Kremenek } 503daeb9a7376830d637e02b5bc51faf4750a7bce70Ted Kremenek }; 5041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 505031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu iterator begin() { return iterator(Src->succ_rbegin()+1); } 506031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu iterator end() { return iterator(Src->succ_rend()); } 5071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5084d3175c1e5a44251ea97b0c81e80f060629d9c08Ted Kremenek const SwitchStmt *getSwitch() const { 5094d3175c1e5a44251ea97b0c81e80f060629d9c08Ted Kremenek return llvm::cast<SwitchStmt>(Src->getTerminator()); 5104d3175c1e5a44251ea97b0c81e80f060629d9c08Ted Kremenek } 5114d3175c1e5a44251ea97b0c81e80f060629d9c08Ted Kremenek 51218c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ExplodedNode *generateCaseStmtNode(const iterator &I, 51318c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek const ProgramState *State); 5141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 51518c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek ExplodedNode *generateDefaultCaseNode(const ProgramState *State, 516031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu bool isSink = false); 5171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5189c378f705405d37f49795d5e915989de774fe11fTed Kremenek const Expr *getCondition() const { return Condition; } 519daeb9a7376830d637e02b5bc51faf4750a7bce70Ted Kremenek 52018c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek const ProgramState *getState() const { return Pred->State; } 521daeb9a7376830d637e02b5bc51faf4750a7bce70Ted Kremenek}; 52211062b118476368fa5b294954713e5df97d8599fTed Kremenek 523d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidisclass CallEnterNodeBuilder { 524d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis CoreEngine &Eng; 525102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor 526102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor const ExplodedNode *Pred; 527102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor 52819b78d9e3dbbc27bbcbdd8c3017a00fe88849ecdZhongxing Xu // The call site. For implicit automatic object dtor, this is the trigger 52919b78d9e3dbbc27bbcbdd8c3017a00fe88849ecdZhongxing Xu // statement. 530102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor const Stmt *CE; 531102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor 53219b78d9e3dbbc27bbcbdd8c3017a00fe88849ecdZhongxing Xu // The context of the callee. 53319b78d9e3dbbc27bbcbdd8c3017a00fe88849ecdZhongxing Xu const StackFrameContext *CalleeCtx; 534102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor 535102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor // The parent block of the CallExpr. 536102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor const CFGBlock *Block; 537102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor 538102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor // The CFGBlock index of the CallExpr. 539102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor unsigned Index; 540102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor 541102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregorpublic: 542d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis CallEnterNodeBuilder(CoreEngine &eng, const ExplodedNode *pred, 54319b78d9e3dbbc27bbcbdd8c3017a00fe88849ecdZhongxing Xu const Stmt *s, const StackFrameContext *callee, 544102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor const CFGBlock *blk, unsigned idx) 545c6238d2786cfd961b94580b3d3675a1b3ff0721cZhongxing Xu : Eng(eng), Pred(pred), CE(s), CalleeCtx(callee), Block(blk), Index(idx) {} 546102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor 54718c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek const ProgramState *getState() const { return Pred->getState(); } 548102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor 549102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor const LocationContext *getLocationContext() const { 550102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor return Pred->getLocationContext(); 551102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor } 552102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor 553102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor const Stmt *getCallExpr() const { return CE; } 554102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor 55519b78d9e3dbbc27bbcbdd8c3017a00fe88849ecdZhongxing Xu const StackFrameContext *getCalleeContext() const { return CalleeCtx; } 556102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor 557102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor const CFGBlock *getBlock() const { return Block; } 558102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor 559102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor unsigned getIndex() const { return Index; } 560102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor 56118c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek void generateNode(const ProgramState *state); 562102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor}; 563102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor 564d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidisclass CallExitNodeBuilder { 565d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis CoreEngine &Eng; 566102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor const ExplodedNode *Pred; 567102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor 568102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregorpublic: 569d2592a34a059e7cbb2b11dc53649ac4912422909Argyrios Kyrtzidis CallExitNodeBuilder(CoreEngine &eng, const ExplodedNode *pred) 570102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor : Eng(eng), Pred(pred) {} 571102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor 572102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor const ExplodedNode *getPredecessor() const { return Pred; } 573102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor 57418c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek const ProgramState *getState() const { return Pred->getState(); } 575102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor 57618c66fdc3c4008d335885695fe36fb5353c5f672Ted Kremenek void generateNode(const ProgramState *state); 577102acd5369bbb17c0d6ab868af376671acff7a93Douglas Gregor}; 5785a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 5795a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis} // end GR namespace 5805a4f98ff943e6a501b0fe47ade007c9bbf96cb88Argyrios Kyrtzidis 581f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek} // end clang namespace 582f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek 583f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek#endif 584