ExplodedGraph.h revision 5fe4d9deb543a19f557e3d85c5f33867af97cd96
151125a21eafc29c925cac3655b46cfd8ef55f764Ted Kremenek//=-- ExplodedGraph.h - Local, Path-Sens. "Exploded Graph" -*- C++ -*-------==// 24241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek// 34241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek// The LLVM Compiler Infrastructure 44241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek// 54241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek// This file is distributed under the University of Illinois Open Source 64241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek// License. See LICENSE.TXT for details. 74241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek// 84241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek//===----------------------------------------------------------------------===// 94241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek// 1051125a21eafc29c925cac3655b46cfd8ef55f764Ted Kremenek// This file defines the template classes ExplodedNode and ExplodedGraph, 1151125a21eafc29c925cac3655b46cfd8ef55f764Ted Kremenek// which represent a path-sensitive, intra-procedural "exploded graph." 124241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek// 134241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek//===----------------------------------------------------------------------===// 144241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek 154241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek#ifndef LLVM_CLANG_ANALYSIS_EXPLODEDGRAPH 164241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek#define LLVM_CLANG_ANALYSIS_EXPLODEDGRAPH 174241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek 184a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#include "clang/Analysis/ProgramPoint.h" 195032ffe4259e7d436f2eb19e5a29fdae559e7c12Zhongxing Xu#include "clang/Analysis/PathSensitive/AnalysisContext.h" 2063bbe5312cd89ce0ceb684bff68c5baef636e93cTed Kremenek#include "clang/AST/Decl.h" 214241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek#include "llvm/ADT/SmallVector.h" 224241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek#include "llvm/ADT/FoldingSet.h" 23f6f5ef4aaa66b60270e84d1fe1292886369d2f38Ted Kremenek#include "llvm/ADT/SmallPtrSet.h" 244241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek#include "llvm/Support/Allocator.h" 25ede5a4ba111f0590879670b6cb07f4d6d0bd9075Ted Kremenek#include "llvm/ADT/OwningPtr.h" 264a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#include "llvm/ADT/GraphTraits.h" 274a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek#include "llvm/ADT/DepthFirstIterator.h" 2863bbe5312cd89ce0ceb684bff68c5baef636e93cTed Kremenek#include "llvm/Support/Casting.h" 295fe4d9deb543a19f557e3d85c5f33867af97cd96Ted Kremenek#include "clang/Analysis/Support/BumpVector.h" 304241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek 314241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremeneknamespace clang { 324a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek 33c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xuclass GRState; 3411062b118476368fa5b294954713e5df97d8599fTed Kremenekclass CFG; 3511062b118476368fa5b294954713e5df97d8599fTed Kremenekclass ASTContext; 365fe4d9deb543a19f557e3d85c5f33867af97cd96Ted Kremenekclass ExplodedGraph; 3711062b118476368fa5b294954713e5df97d8599fTed Kremenek 38cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 39cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// ExplodedGraph "implementation" classes. These classes are not typed to 40cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// contain a specific kind of state. Typed-specialized versions are defined 41cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek// on top of these classes. 42cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek//===----------------------------------------------------------------------===// 431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 44c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xuclass ExplodedNode : public llvm::FoldingSetNode { 4538b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu friend class ExplodedGraph; 460111f575b968e423dccae439e501225b8314b257Zhongxing Xu friend class GRCoreEngine; 47031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu friend class GRStmtNodeBuilder; 48031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu friend class GRBranchNodeBuilder; 49031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu friend class GRIndirectGotoNodeBuilder; 50031ccc0555a82afc2e8afe29e19dd57ff204e2deZhongxing Xu friend class GRSwitchNodeBuilder; 511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump friend class GREndPathNodeBuilder; 521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 534c4cb527a44037d076da82ad9d12b4e655e64dbbTed Kremenek class NodeGroup { 54b38911f16b4943548db6a3695fc6ae23070b25d2Ted Kremenek enum { Size1 = 0x0, SizeOther = 0x1, AuxFlag = 0x2, Mask = 0x3 }; 554c4cb527a44037d076da82ad9d12b4e655e64dbbTed Kremenek uintptr_t P; 561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 57ee98546b0d5f3439c4a590b0d7d1545af794a0ecTed Kremenek unsigned getKind() const { 58596f0a1e54f610926e8bfded9efa1c639f824dedTed Kremenek return P & 0x1; 59ee98546b0d5f3439c4a590b0d7d1545af794a0ecTed Kremenek } 601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 61ee98546b0d5f3439c4a590b0d7d1545af794a0ecTed Kremenek void* getPtr() const { 62ffe0f43806d4823271c2406c1fccc2373115c36aTed Kremenek assert (!getFlag()); 63b38911f16b4943548db6a3695fc6ae23070b25d2Ted Kremenek return reinterpret_cast<void*>(P & ~Mask); 64ee98546b0d5f3439c4a590b0d7d1545af794a0ecTed Kremenek } 65ee98546b0d5f3439c4a590b0d7d1545af794a0ecTed Kremenek 66c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu ExplodedNode *getNode() const { 67c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu return reinterpret_cast<ExplodedNode*>(getPtr()); 68ee98546b0d5f3439c4a590b0d7d1545af794a0ecTed Kremenek } 691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 704c4cb527a44037d076da82ad9d12b4e655e64dbbTed Kremenek public: 714c4cb527a44037d076da82ad9d12b4e655e64dbbTed Kremenek NodeGroup() : P(0) {} 721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 735fe4d9deb543a19f557e3d85c5f33867af97cd96Ted Kremenek ExplodedNode **begin() const; 741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 755fe4d9deb543a19f557e3d85c5f33867af97cd96Ted Kremenek ExplodedNode **end() const; 761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 775d5480380d7b7c3590a0283ddf239220e514e576Ted Kremenek unsigned size() const; 781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 795fe4d9deb543a19f557e3d85c5f33867af97cd96Ted Kremenek bool empty() const { return (P & ~Mask) == 0; } 801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 815fe4d9deb543a19f557e3d85c5f33867af97cd96Ted Kremenek void addNode(ExplodedNode* N, ExplodedGraph &G); 821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 83b38911f16b4943548db6a3695fc6ae23070b25d2Ted Kremenek void setFlag() { 845fe4d9deb543a19f557e3d85c5f33867af97cd96Ted Kremenek assert(P == 0); 85ffe0f43806d4823271c2406c1fccc2373115c36aTed Kremenek P = AuxFlag; 86f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek } 871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 88b38911f16b4943548db6a3695fc6ae23070b25d2Ted Kremenek bool getFlag() const { 89b38911f16b4943548db6a3695fc6ae23070b25d2Ted Kremenek return P & AuxFlag ? true : false; 90f24af5bc2e01ca8e7396ed997378a77fddfa521eTed Kremenek } 911eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump }; 921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 934a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek /// Location - The program location (within a function body) associated 944a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek /// with this node. 954a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek const ProgramPoint Location; 961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 974323a57627e796dcfdfdb7d47672dc09ed308edaTed Kremenek /// State - The state associated with this node. 98c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu const GRState* State; 991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1004a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek /// Preds - The predecessors of this node. 1014c4cb527a44037d076da82ad9d12b4e655e64dbbTed Kremenek NodeGroup Preds; 1021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1034a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek /// Succs - The successors of this node. 1044c4cb527a44037d076da82ad9d12b4e655e64dbbTed Kremenek NodeGroup Succs; 105c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu 1064a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenekpublic: 107c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu 1081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump explicit ExplodedNode(const ProgramPoint& loc, const GRState* state) 109c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu : Location(loc), State(state) {} 110c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu 1114a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek /// getLocation - Returns the edge associated with the given node. 1120f9063c116b7c3b05d8042b5976463c2dae04861Ted Kremenek ProgramPoint getLocation() const { return Location; } 113c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu 1141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const LocationContext *getLocationContext() const { 1151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return getLocation().getLocationContext(); 11625e695b2d574d919cc1bbddf3a2efe073d449b1cZhongxing Xu } 11725e695b2d574d919cc1bbddf3a2efe073d449b1cZhongxing Xu 1185032ffe4259e7d436f2eb19e5a29fdae559e7c12Zhongxing Xu const Decl &getCodeDecl() const { return *getLocationContext()->getDecl(); } 1195032ffe4259e7d436f2eb19e5a29fdae559e7c12Zhongxing Xu 1205032ffe4259e7d436f2eb19e5a29fdae559e7c12Zhongxing Xu CFG &getCFG() const { return *getLocationContext()->getCFG(); } 1215032ffe4259e7d436f2eb19e5a29fdae559e7c12Zhongxing Xu 122b317f8f5ca8737a5bbad97a3f7566a2dbd2ed61bZhongxing Xu ParentMap &getParentMap() const {return getLocationContext()->getParentMap();} 123b317f8f5ca8737a5bbad97a3f7566a2dbd2ed61bZhongxing Xu 124b317f8f5ca8737a5bbad97a3f7566a2dbd2ed61bZhongxing Xu LiveVariables &getLiveVariables() const { 125b317f8f5ca8737a5bbad97a3f7566a2dbd2ed61bZhongxing Xu return *getLocationContext()->getLiveVariables(); 126c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu } 127c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu 128b317f8f5ca8737a5bbad97a3f7566a2dbd2ed61bZhongxing Xu const GRState* getState() const { return State; } 129b317f8f5ca8737a5bbad97a3f7566a2dbd2ed61bZhongxing Xu 13052c3196a89a26cebcf069dd140c3396b743b8e33Ted Kremenek template <typename T> 13152c3196a89a26cebcf069dd140c3396b743b8e33Ted Kremenek const T* getLocationAs() const { return llvm::dyn_cast<T>(&Location); } 132c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu 1331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump static void Profile(llvm::FoldingSetNodeID &ID, 1345fe4d9deb543a19f557e3d85c5f33867af97cd96Ted Kremenek const ProgramPoint& Loc, const GRState* state) { 1355fe4d9deb543a19f557e3d85c5f33867af97cd96Ted Kremenek ID.Add(Loc); 1365fe4d9deb543a19f557e3d85c5f33867af97cd96Ted Kremenek ID.AddPointer(state); 1375fe4d9deb543a19f557e3d85c5f33867af97cd96Ted Kremenek } 138c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu 139c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu void Profile(llvm::FoldingSetNodeID& ID) const { 140c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu Profile(ID, getLocation(), getState()); 141c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu } 142c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu 1431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// addPredeccessor - Adds a predecessor to the current node, and 144c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu /// in tandem add this node as a successor of the other node. 1455fe4d9deb543a19f557e3d85c5f33867af97cd96Ted Kremenek void addPredecessor(ExplodedNode* V, ExplodedGraph &G); 146c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu 1474a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek unsigned succ_size() const { return Succs.size(); } 1484a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek unsigned pred_size() const { return Preds.size(); } 1494a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek bool succ_empty() const { return Succs.empty(); } 1500e8a3c743b9b3e3039e329a1736122d3b5b5fed9Ted Kremenek bool pred_empty() const { return Preds.empty(); } 1511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 152ffe0f43806d4823271c2406c1fccc2373115c36aTed Kremenek bool isSink() const { return Succs.getFlag(); } 1531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump void markAsSink() { Succs.setFlag(); } 1544a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek 15552c3196a89a26cebcf069dd140c3396b743b8e33Ted Kremenek ExplodedNode* getFirstPred() { 15652c3196a89a26cebcf069dd140c3396b743b8e33Ted Kremenek return pred_empty() ? NULL : *(pred_begin()); 15752c3196a89a26cebcf069dd140c3396b743b8e33Ted Kremenek } 1581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 15952c3196a89a26cebcf069dd140c3396b743b8e33Ted Kremenek const ExplodedNode* getFirstPred() const { 16052c3196a89a26cebcf069dd140c3396b743b8e33Ted Kremenek return const_cast<ExplodedNode*>(this)->getFirstPred(); 16152c3196a89a26cebcf069dd140c3396b743b8e33Ted Kremenek } 1621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1634a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek // Iterators over successor and predecessor vertices. 1644a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek typedef ExplodedNode** succ_iterator; 1653148eb4a75f70f2636075c364d03104223f004d3Ted Kremenek typedef const ExplodedNode* const * const_succ_iterator; 1664a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek typedef ExplodedNode** pred_iterator; 1673148eb4a75f70f2636075c364d03104223f004d3Ted Kremenek typedef const ExplodedNode* const * const_pred_iterator; 1684a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek 169c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu pred_iterator pred_begin() { return Preds.begin(); } 170c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu pred_iterator pred_end() { return Preds.end(); } 1714a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek 1724a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek const_pred_iterator pred_begin() const { 1734a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek return const_cast<ExplodedNode*>(this)->pred_begin(); 1741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 1754a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek const_pred_iterator pred_end() const { 1764a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek return const_cast<ExplodedNode*>(this)->pred_end(); 1774a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek } 1784a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek 179c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu succ_iterator succ_begin() { return Succs.begin(); } 180c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu succ_iterator succ_end() { return Succs.end(); } 1814a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek 1824a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek const_succ_iterator succ_begin() const { 1834a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek return const_cast<ExplodedNode*>(this)->succ_begin(); 1844a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek } 1854a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek const_succ_iterator succ_end() const { 1864a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek return const_cast<ExplodedNode*>(this)->succ_end(); 1874a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek } 188c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu 189c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu // For debugging. 1901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 191c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xupublic: 1921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 193c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu class Auditor { 194c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu public: 195c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu virtual ~Auditor(); 196c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu virtual void AddEdge(ExplodedNode* Src, ExplodedNode* Dst) = 0; 197c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu }; 1981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 199c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu static void SetAuditor(Auditor* A); 200c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu}; 201c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu 20238b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu// FIXME: Is this class necessary? 20338b02b912e1a55c912f603c4369431264d36a381Zhongxing Xuclass InterExplodedGraphMap { 20438b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu llvm::DenseMap<const ExplodedNode*, ExplodedNode*> M; 2051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump friend class ExplodedGraph; 206c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu 20738b02b912e1a55c912f603c4369431264d36a381Zhongxing Xupublic: 20838b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu ExplodedNode* getMappedNode(const ExplodedNode* N) const; 2091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 21038b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu InterExplodedGraphMap() {}; 21138b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu virtual ~InterExplodedGraphMap() {} 2124a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek}; 2134a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek 21438b02b912e1a55c912f603c4369431264d36a381Zhongxing Xuclass ExplodedGraph { 2154241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenekprotected: 2160111f575b968e423dccae439e501225b8314b257Zhongxing Xu friend class GRCoreEngine; 217e96de2dfde487211fb52f9139cdcae64d051a406Zhongxing Xu 2184241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek // Type definitions. 219c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu typedef llvm::SmallVector<ExplodedNode*,2> RootsTy; 220c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu typedef llvm::SmallVector<ExplodedNode*,10> EndNodesTy; 2211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2224241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek /// Roots - The roots of the simulation graph. Usually there will be only 2234241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek /// one, but clients are free to establish multiple subgraphs within a single 2244241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek /// SimulGraph. Moreover, these subgraphs can often merge when paths from 2254241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek /// different roots reach the same state at the same program location. 2264241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek RootsTy Roots; 2274241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek 2284241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek /// EndNodes - The nodes in the simulation graph which have been 2294241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek /// specially marked as the endpoint of an abstract simulation path. 2304241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek EndNodesTy EndNodes; 23138b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu 23238b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu /// Nodes - The nodes in the graph. 23338b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu llvm::FoldingSet<ExplodedNode> Nodes; 23438b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu 2355fe4d9deb543a19f557e3d85c5f33867af97cd96Ted Kremenek /// BVC - Allocator and context for allocating nodes and their predecessor 2365fe4d9deb543a19f557e3d85c5f33867af97cd96Ted Kremenek /// and successor groups. 2375fe4d9deb543a19f557e3d85c5f33867af97cd96Ted Kremenek BumpVectorContext BVC; 2381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 23963bbe5312cd89ce0ceb684bff68c5baef636e93cTed Kremenek /// Ctx - The ASTContext used to "interpret" CodeDecl. 240cb48b9c9c3c95f2650b74530264c288d1f58c73cTed Kremenek ASTContext& Ctx; 2411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 24239b4c6c98d391b25c376782cf92346aa88c96f7eTed Kremenek /// NumNodes - The number of nodes in the graph. 24339b4c6c98d391b25c376782cf92346aa88c96f7eTed Kremenek unsigned NumNodes; 2444241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek 24538b02b912e1a55c912f603c4369431264d36a381Zhongxing Xupublic: 24638b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu /// getNode - Retrieve the node associated with a (Location,State) pair, 24738b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu /// where the 'Location' is a ProgramPoint in the CFG. If no node for 24838b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu /// this pair exists, it is created. IsNew is set to true if 24938b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu /// the node was freshly created. 25038b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu 25138b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu ExplodedNode* getNode(const ProgramPoint& L, const GRState *State, 25238b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu bool* IsNew = 0); 2531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 25438b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu ExplodedGraph* MakeEmptyGraph() const { 255cc0255383f96a557c36923f602819bdb0cdd2761Zhongxing Xu return new ExplodedGraph(Ctx); 25638b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu } 2574a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek 2584241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek /// addRoot - Add an untyped node to the set of roots. 259c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu ExplodedNode* addRoot(ExplodedNode* V) { 260ede5a4ba111f0590879670b6cb07f4d6d0bd9075Ted Kremenek Roots.push_back(V); 261ede5a4ba111f0590879670b6cb07f4d6d0bd9075Ted Kremenek return V; 262ede5a4ba111f0590879670b6cb07f4d6d0bd9075Ted Kremenek } 2634241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek 2644241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek /// addEndOfPath - Add an untyped node to the set of EOP nodes. 265c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu ExplodedNode* addEndOfPath(ExplodedNode* V) { 266ede5a4ba111f0590879670b6cb07f4d6d0bd9075Ted Kremenek EndNodes.push_back(V); 267ede5a4ba111f0590879670b6cb07f4d6d0bd9075Ted Kremenek return V; 268ede5a4ba111f0590879670b6cb07f4d6d0bd9075Ted Kremenek } 26938b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu 270cc0255383f96a557c36923f602819bdb0cdd2761Zhongxing Xu ExplodedGraph(ASTContext& ctx) : Ctx(ctx), NumNodes(0) {} 2714241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek 2725fe4d9deb543a19f557e3d85c5f33867af97cd96Ted Kremenek ~ExplodedGraph() {} 2734a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek 2744241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek unsigned num_roots() const { return Roots.size(); } 2754a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek unsigned num_eops() const { return EndNodes.size(); } 2761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 27739b4c6c98d391b25c376782cf92346aa88c96f7eTed Kremenek bool empty() const { return NumNodes == 0; } 27839b4c6c98d391b25c376782cf92346aa88c96f7eTed Kremenek unsigned size() const { return NumNodes; } 279c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu 2804241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek // Iterators. 28138b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu typedef ExplodedNode NodeTy; 28238b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu typedef llvm::FoldingSet<ExplodedNode> AllNodesTy; 2837ebde953bb050caa69f791fc1de449d435c6a36fTed Kremenek typedef NodeTy** roots_iterator; 28438b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu typedef NodeTy* const * const_roots_iterator; 2857ebde953bb050caa69f791fc1de449d435c6a36fTed Kremenek typedef NodeTy** eop_iterator; 28638b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu typedef NodeTy* const * const_eop_iterator; 28738b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu typedef AllNodesTy::iterator node_iterator; 28838b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu typedef AllNodesTy::const_iterator const_node_iterator; 2891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29038b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu node_iterator nodes_begin() { return Nodes.begin(); } 2917ebde953bb050caa69f791fc1de449d435c6a36fTed Kremenek 29238b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu node_iterator nodes_end() { return Nodes.end(); } 2931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29438b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu const_node_iterator nodes_begin() const { return Nodes.begin(); } 2951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29638b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu const_node_iterator nodes_end() const { return Nodes.end(); } 2971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 29838b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu roots_iterator roots_begin() { return Roots.begin(); } 2991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 30038b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu roots_iterator roots_end() { return Roots.end(); } 3011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 30238b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu const_roots_iterator roots_begin() const { return Roots.begin(); } 3031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const_roots_iterator roots_end() const { return Roots.end(); } 3054241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek 30638b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu eop_iterator eop_begin() { return EndNodes.begin(); } 3071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 30838b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu eop_iterator eop_end() { return EndNodes.end(); } 3091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 31038b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu const_eop_iterator eop_begin() const { return EndNodes.begin(); } 3111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 31238b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu const_eop_iterator eop_end() const { return EndNodes.end(); } 31338b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu 3145fe4d9deb543a19f557e3d85c5f33867af97cd96Ted Kremenek llvm::BumpPtrAllocator & getAllocator() { return BVC.getAllocator(); } 3155fe4d9deb543a19f557e3d85c5f33867af97cd96Ted Kremenek BumpVectorContext &getNodeAllocator() { return BVC; } 31638b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu 317cc0255383f96a557c36923f602819bdb0cdd2761Zhongxing Xu ASTContext& getContext() { return Ctx; } 31838b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu 31938b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu typedef llvm::DenseMap<const ExplodedNode*, ExplodedNode*> NodeMap; 32038b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu 321c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu std::pair<ExplodedGraph*, InterExplodedGraphMap*> 322fe9e543a2a363df7fcaa899367d3b2580b63b27cTed Kremenek Trim(const NodeTy* const* NBeg, const NodeTy* const* NEnd, 32338b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu llvm::DenseMap<const void*, const void*> *InverseMap = 0) const; 324cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 32538b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu ExplodedGraph* TrimInternal(const ExplodedNode* const * NBeg, 32638b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu const ExplodedNode* const * NEnd, 32738b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu InterExplodedGraphMap *M, 32838b02b912e1a55c912f603c4369431264d36a381Zhongxing Xu llvm::DenseMap<const void*, const void*> *InverseMap) const; 3294241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek}; 330cf118d41f7930a18dce97416ef7834a62642f587Ted Kremenek 331f6f5ef4aaa66b60270e84d1fe1292886369d2f38Ted Kremenekclass ExplodedNodeSet { 332c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu typedef llvm::SmallPtrSet<ExplodedNode*,5> ImplTy; 333f6f5ef4aaa66b60270e84d1fe1292886369d2f38Ted Kremenek ImplTy Impl; 3341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 335f6f5ef4aaa66b60270e84d1fe1292886369d2f38Ted Kremenekpublic: 336c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu ExplodedNodeSet(ExplodedNode* N) { 337c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu assert (N && !static_cast<ExplodedNode*>(N)->isSink()); 338f6f5ef4aaa66b60270e84d1fe1292886369d2f38Ted Kremenek Impl.insert(N); 339f6f5ef4aaa66b60270e84d1fe1292886369d2f38Ted Kremenek } 3401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 341f6f5ef4aaa66b60270e84d1fe1292886369d2f38Ted Kremenek ExplodedNodeSet() {} 3421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 343c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu inline void Add(ExplodedNode* N) { 344c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu if (N && !static_cast<ExplodedNode*>(N)->isSink()) Impl.insert(N); 345f6f5ef4aaa66b60270e84d1fe1292886369d2f38Ted Kremenek } 3461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 347cc2c6eb04d882466c7cfbb544c251d7e0ba0f356Ted Kremenek ExplodedNodeSet& operator=(const ExplodedNodeSet &X) { 348cc2c6eb04d882466c7cfbb544c251d7e0ba0f356Ted Kremenek Impl = X.Impl; 349cc2c6eb04d882466c7cfbb544c251d7e0ba0f356Ted Kremenek return *this; 350cc2c6eb04d882466c7cfbb544c251d7e0ba0f356Ted Kremenek } 3511eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 352c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu typedef ImplTy::iterator iterator; 353c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu typedef ImplTy::const_iterator const_iterator; 354f6f5ef4aaa66b60270e84d1fe1292886369d2f38Ted Kremenek 355f6f5ef4aaa66b60270e84d1fe1292886369d2f38Ted Kremenek inline unsigned size() const { return Impl.size(); } 356f6f5ef4aaa66b60270e84d1fe1292886369d2f38Ted Kremenek inline bool empty() const { return Impl.empty(); } 3574bf38da038cebf9396470630c3c39519e41706daTed Kremenek 3584bf38da038cebf9396470630c3c39519e41706daTed Kremenek inline void clear() { Impl.clear(); } 3591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 360f6f5ef4aaa66b60270e84d1fe1292886369d2f38Ted Kremenek inline iterator begin() { return Impl.begin(); } 361f6f5ef4aaa66b60270e84d1fe1292886369d2f38Ted Kremenek inline iterator end() { return Impl.end(); } 3621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 363f6f5ef4aaa66b60270e84d1fe1292886369d2f38Ted Kremenek inline const_iterator begin() const { return Impl.begin(); } 364f6f5ef4aaa66b60270e84d1fe1292886369d2f38Ted Kremenek inline const_iterator end() const { return Impl.end(); } 3651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump}; 3661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3674241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek} // end clang namespace 3684241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek 3694a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek// GraphTraits 3704a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek 3714a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremeneknamespace llvm { 372c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu template<> struct GraphTraits<clang::ExplodedNode*> { 373c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu typedef clang::ExplodedNode NodeType; 374c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu typedef NodeType::succ_iterator ChildIteratorType; 3754a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek typedef llvm::df_iterator<NodeType*> nodes_iterator; 3761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3774a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek static inline NodeType* getEntryNode(NodeType* N) { 3784a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek return N; 3794a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek } 3801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3814a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek static inline ChildIteratorType child_begin(NodeType* N) { 3824a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek return N->succ_begin(); 3834a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek } 3841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3854a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek static inline ChildIteratorType child_end(NodeType* N) { 3864a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek return N->succ_end(); 3874a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek } 3881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3894a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek static inline nodes_iterator nodes_begin(NodeType* N) { 3904a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek return df_begin(N); 3914a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek } 3921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3934a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek static inline nodes_iterator nodes_end(NodeType* N) { 3944a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek return df_end(N); 3954a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek } 3964a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek }; 3971eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 398c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu template<> struct GraphTraits<const clang::ExplodedNode*> { 399c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu typedef const clang::ExplodedNode NodeType; 400c5619d901a68dc27a9e310a6a831f03efebcd950Zhongxing Xu typedef NodeType::const_succ_iterator ChildIteratorType; 4014a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek typedef llvm::df_iterator<NodeType*> nodes_iterator; 4021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4034a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek static inline NodeType* getEntryNode(NodeType* N) { 4044a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek return N; 4054a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek } 4061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4074a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek static inline ChildIteratorType child_begin(NodeType* N) { 4084a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek return N->succ_begin(); 4094a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek } 4101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4114a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek static inline ChildIteratorType child_end(NodeType* N) { 4124a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek return N->succ_end(); 4134a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek } 4141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4154a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek static inline nodes_iterator nodes_begin(NodeType* N) { 4164a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek return df_begin(N); 4174a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek } 4181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4194a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek static inline nodes_iterator nodes_end(NodeType* N) { 4204a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek return df_end(N); 4214a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek } 4224a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek }; 4231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4244a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek} // end llvm namespace 4254a0f5f1646637fcf90eb236b5a46f40e5a5dd739Ted Kremenek 4264241b3d1ad87e9a593bbc6cdf0f49435d5aec235Ted Kremenek#endif 427