CFG.h revision 6c52c7850bccb6991470668429a1e1edf01b0873
1fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek//===--- CFG.h - Classes for representing and building CFGs------*- C++ -*-===// 2fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek// 3fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek// The LLVM Compiler Infrastructure 4fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek// 50bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// This file is distributed under the University of Illinois Open Source 60bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// License. See LICENSE.TXT for details. 7fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek// 8fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek//===----------------------------------------------------------------------===// 9fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek// 10fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek// This file defines the CFG and CFGBuilder classes for representing and 11fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek// building Control-Flow Graphs (CFGs) from ASTs. 12fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek// 13fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek//===----------------------------------------------------------------------===// 14fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek 15cd881d534517f09a2fae10445f9b865f49ccc6c8Ted Kremenek#ifndef LLVM_CLANG_CFG_H 16cd881d534517f09a2fae10445f9b865f49ccc6c8Ted Kremenek#define LLVM_CLANG_CFG_H 17cd881d534517f09a2fae10445f9b865f49ccc6c8Ted Kremenek 18852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek#include "llvm/ADT/PointerIntPair.h" 197dba8607e59096014b7139ff20ef00870041d518Ted Kremenek#include "llvm/ADT/GraphTraits.h" 20ce1eb34bbea1e0408f1952776d7d52ccde1bd275Ted Kremenek#include "llvm/Support/Allocator.h" 21852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek#include "llvm/Support/Casting.h" 22ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek#include "clang/Analysis/Support/BumpVector.h" 23079bd72439448b78629a28da6b1f8abe2cdeaf4dMike Stump#include "clang/Basic/SourceLocation.h" 24c1581a0d64b0ee4f822ed2fca4442a111d03569aHartmut Kaiser#include <cassert> 25fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek 26e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattnernamespace llvm { 27e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner class raw_ostream; 28e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner} 29fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremeneknamespace clang { 30b978a441c7d8bf59e7fede938e1f3b672573b443Mike Stump class Decl; 3142a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek class Stmt; 3263f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek class Expr; 3342a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek class CFG; 3442a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek class PrinterHelper; 35e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner class LangOptions; 36e5af3ce53ec58995b09381ba645ab2117a46647bMike Stump class ASTContext; 37e5af3ce53ec58995b09381ba645ab2117a46647bMike Stump 38852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek/// CFGElement - Represents a top-level expression in a basic block. 39852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenekclass CFGElement { 40079bd72439448b78629a28da6b1f8abe2cdeaf4dMike Stump llvm::PointerIntPair<Stmt *, 2> Data; 41852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenekpublic: 42079bd72439448b78629a28da6b1f8abe2cdeaf4dMike Stump enum Type { StartScope, EndScope }; 43852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek explicit CFGElement() {} 44852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek CFGElement(Stmt *S, bool lvalue) : Data(S, lvalue ? 1 : 0) {} 45079bd72439448b78629a28da6b1f8abe2cdeaf4dMike Stump CFGElement(Stmt *S, Type t) : Data(S, t == StartScope ? 2 : 3) {} 46852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek Stmt *getStmt() const { return Data.getPointer(); } 47852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek bool asLValue() const { return Data.getInt() == 1; } 48079bd72439448b78629a28da6b1f8abe2cdeaf4dMike Stump bool asStartScope() const { return Data.getInt() == 2; } 49079bd72439448b78629a28da6b1f8abe2cdeaf4dMike Stump bool asEndScope() const { return Data.getInt() == 3; } 50079bd72439448b78629a28da6b1f8abe2cdeaf4dMike Stump bool asDtor() const { return Data.getInt() == 4; } 51852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek operator Stmt*() const { return getStmt(); } 52079bd72439448b78629a28da6b1f8abe2cdeaf4dMike Stump operator bool() const { return getStmt() != 0; } 53852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek}; 54852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek 55fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// CFGBlock - Represents a single basic block in a source-level CFG. 56fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// It consists of: 57fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// 58fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// (1) A set of statements/expressions (which may contain subexpressions). 59fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// (2) A "terminator" statement (not in the set of statements). 60fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// (3) A list of successors and predecessors. 61fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// 62fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// Terminator: The terminator represents the type of control-flow that occurs 63fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// at the end of the basic block. The terminator is a Stmt* referring to an 64fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// AST node that has control-flow: if-statements, breaks, loops, etc. 65fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// If the control-flow is conditional, the condition expression will appear 66fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// within the set of statements in the block (usually the last statement). 67fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// 68fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// Predecessors: the order in the set of predecessors is arbitrary. 69fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// 70fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// Successors: the order in the set of successors is NOT arbitrary. We 71fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// currently have the following orderings based on the terminator: 72fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// 73fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// Terminator Successor Ordering 74fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// ----------------------------------------------------- 75fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// if Then Block; Else Block 769cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek/// ? operator LHS expression; RHS expression 779cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek/// &&, || expression that uses result of && or ||, RHS 78fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// 79fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenekclass CFGBlock { 806c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek class StatementList { 81852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek typedef BumpVector<CFGElement> ImplTy; 826c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek ImplTy Impl; 836c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek public: 84ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek StatementList(BumpVectorContext &C) : Impl(C, 4) {} 85ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek 866c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek typedef std::reverse_iterator<ImplTy::iterator> iterator; 876c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek typedef std::reverse_iterator<ImplTy::const_iterator> const_iterator; 886c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek typedef ImplTy::iterator reverse_iterator; 896c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek typedef ImplTy::const_iterator const_reverse_iterator; 906c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek 91852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek void push_back(CFGElement e, BumpVectorContext &C) { Impl.push_back(e, C); } 92852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek CFGElement front() const { return Impl.back(); } 93852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek CFGElement back() const { return Impl.front(); } 946c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek 956c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek iterator begin() { return Impl.rbegin(); } 966c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek iterator end() { return Impl.rend(); } 976c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek const_iterator begin() const { return Impl.rbegin(); } 986c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek const_iterator end() const { return Impl.rend(); } 996c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek reverse_iterator rbegin() { return Impl.begin(); } 1006c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek reverse_iterator rend() { return Impl.end(); } 1016c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek const_reverse_iterator rbegin() const { return Impl.begin(); } 1026c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek const_reverse_iterator rend() const { return Impl.end(); } 1036c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek 104852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek CFGElement operator[](size_t i) const { 1056c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek assert(i < Impl.size()); 1066c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek return Impl[Impl.size() - 1 - i]; 1076c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek } 1086c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek 1096c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek size_t size() const { return Impl.size(); } 1106c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek bool empty() const { return Impl.empty(); } 1116c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek }; 1126c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek 113fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek /// Stmts - The set of statements in the basic block. 1146c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek StatementList Stmts; 1159cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek 1169cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek /// Label - An (optional) label that prefixes the executable 1179cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek /// statements in the block. When this variable is non-NULL, it is 1184c45aa1b00b91847acfb082acfaced3ffa294d1dMike Stump /// either an instance of LabelStmt, SwitchCase or CXXCatchStmt. 1193575f84e459033d6427b84b4b795b22c85c4d27dTed Kremenek Stmt *Label; 1201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1219cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek /// Terminator - The terminator for a basic block that 122fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek /// indicates the type of control-flow that occurs between a block 123fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek /// and its successors. 1243575f84e459033d6427b84b4b795b22c85c4d27dTed Kremenek Stmt *Terminator; 1251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1263575f84e459033d6427b84b4b795b22c85c4d27dTed Kremenek /// LoopTarget - Some blocks are used to represent the "loop edge" to 1273575f84e459033d6427b84b4b795b22c85c4d27dTed Kremenek /// the start of a loop from within the loop body. This Stmt* will be 1283575f84e459033d6427b84b4b795b22c85c4d27dTed Kremenek /// refer to the loop statement for such blocks (and be null otherwise). 1291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const Stmt *LoopTarget; 1301eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 131fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek /// BlockID - A numerical ID assigned to a CFGBlock during construction 132fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek /// of the CFG. 133fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek unsigned BlockID; 1341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 135fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek /// Predecessors/Successors - Keep track of the predecessor / successor 136fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek /// CFG blocks. 137ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek typedef BumpVector<CFGBlock*> AdjacentBlocks; 138fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek AdjacentBlocks Preds; 139fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek AdjacentBlocks Succs; 1401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 141fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenekpublic: 142ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek explicit CFGBlock(unsigned blockid, BumpVectorContext &C) 143ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek : Stmts(C), Label(NULL), Terminator(NULL), LoopTarget(NULL), 144ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek BlockID(blockid), Preds(C, 1), Succs(C, 1) {} 1457177dee8aee4b432911c91f1b788963bec0cac9fDaniel Dunbar ~CFGBlock() {} 146fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek 147fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek // Statement iterators 1486c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek typedef StatementList::iterator iterator; 1496c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek typedef StatementList::const_iterator const_iterator; 1506c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek typedef StatementList::reverse_iterator reverse_iterator; 1516c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek typedef StatementList::const_reverse_iterator const_reverse_iterator; 1521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 153852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek CFGElement front() const { return Stmts.front(); } 154852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek CFGElement back() const { return Stmts.back(); } 1551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 156fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek iterator begin() { return Stmts.begin(); } 157fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek iterator end() { return Stmts.end(); } 158fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek const_iterator begin() const { return Stmts.begin(); } 1591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const_iterator end() const { return Stmts.end(); } 160fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek 161fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek reverse_iterator rbegin() { return Stmts.rbegin(); } 162fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek reverse_iterator rend() { return Stmts.rend(); } 163fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek const_reverse_iterator rbegin() const { return Stmts.rbegin(); } 164fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek const_reverse_iterator rend() const { return Stmts.rend(); } 1651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 166fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek unsigned size() const { return Stmts.size(); } 167fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek bool empty() const { return Stmts.empty(); } 168be7a7d6f2e5b86807afd08a568863df973baaa38Ted Kremenek 169852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek CFGElement operator[](size_t i) const { return Stmts[i]; } 1701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 171fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek // CFG iterators 172fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek typedef AdjacentBlocks::iterator pred_iterator; 173fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek typedef AdjacentBlocks::const_iterator const_pred_iterator; 174fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek typedef AdjacentBlocks::reverse_iterator pred_reverse_iterator; 175fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek typedef AdjacentBlocks::const_reverse_iterator const_pred_reverse_iterator; 176fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek 177fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek typedef AdjacentBlocks::iterator succ_iterator; 178fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek typedef AdjacentBlocks::const_iterator const_succ_iterator; 179fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek typedef AdjacentBlocks::reverse_iterator succ_reverse_iterator; 180fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek typedef AdjacentBlocks::const_reverse_iterator const_succ_reverse_iterator; 1811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 182fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek pred_iterator pred_begin() { return Preds.begin(); } 183fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek pred_iterator pred_end() { return Preds.end(); } 184fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek const_pred_iterator pred_begin() const { return Preds.begin(); } 185fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek const_pred_iterator pred_end() const { return Preds.end(); } 1861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 187fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek pred_reverse_iterator pred_rbegin() { return Preds.rbegin(); } 1881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump pred_reverse_iterator pred_rend() { return Preds.rend(); } 189fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek const_pred_reverse_iterator pred_rbegin() const { return Preds.rbegin(); } 190fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek const_pred_reverse_iterator pred_rend() const { return Preds.rend(); } 191fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek 1921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump succ_iterator succ_begin() { return Succs.begin(); } 193fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek succ_iterator succ_end() { return Succs.end(); } 194fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek const_succ_iterator succ_begin() const { return Succs.begin(); } 1951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const_succ_iterator succ_end() const { return Succs.end(); } 1961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 197fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek succ_reverse_iterator succ_rbegin() { return Succs.rbegin(); } 198fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek succ_reverse_iterator succ_rend() { return Succs.rend(); } 199fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek const_succ_reverse_iterator succ_rbegin() const { return Succs.rbegin(); } 200fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek const_succ_reverse_iterator succ_rend() const { return Succs.rend(); } 201fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek 202fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek unsigned succ_size() const { return Succs.size(); } 203fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek bool succ_empty() const { return Succs.empty(); } 204fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek 205fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek unsigned pred_size() const { return Preds.size(); } 206fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek bool pred_empty() const { return Preds.empty(); } 2071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 208ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 209ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek class FilterOptions { 210ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek public: 211ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek FilterOptions() { 212ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek IgnoreDefaultsWithCoveredEnums = 0; 213be39a566a914df8561d7a1e9654708297f0908c1Ted Kremenek } 214ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 215ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek unsigned IgnoreDefaultsWithCoveredEnums : 1; 216ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek }; 217ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 218ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek static bool FilterEdge(const FilterOptions &F, const CFGBlock *Src, 219be39a566a914df8561d7a1e9654708297f0908c1Ted Kremenek const CFGBlock *Dst); 220ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 221ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek template <typename IMPL, bool IsPred> 222ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek class FilteredCFGBlockIterator { 223ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek private: 224ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek IMPL I, E; 225ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek const FilterOptions F; 226ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek const CFGBlock *From; 227ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek public: 228ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek explicit FilteredCFGBlockIterator(const IMPL &i, const IMPL &e, 229be39a566a914df8561d7a1e9654708297f0908c1Ted Kremenek const CFGBlock *from, 230be39a566a914df8561d7a1e9654708297f0908c1Ted Kremenek const FilterOptions &f) 231ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek : I(i), E(e), F(f), From(from) {} 232ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 233ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek bool hasMore() const { return I != E; } 234ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 235ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek FilteredCFGBlockIterator &operator++() { 236ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek do { ++I; } while (hasMore() && Filter(*I)); 237ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek return *this; 238ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek } 239ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 240ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek const CFGBlock *operator*() const { return *I; } 241ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek private: 242ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek bool Filter(const CFGBlock *To) { 243ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek return IsPred ? FilterEdge(F, To, From) : FilterEdge(F, From, To); 244ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek } 245ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek }; 246ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 247ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek typedef FilteredCFGBlockIterator<const_pred_iterator, true> 248ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek filtered_pred_iterator; 249ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 250ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek typedef FilteredCFGBlockIterator<const_succ_iterator, false> 251ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek filtered_succ_iterator; 252ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 253ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek filtered_pred_iterator filtered_pred_start_end(const FilterOptions &f) const { 254ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek return filtered_pred_iterator(pred_begin(), pred_end(), this, f); 255ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek } 256ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 257ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek filtered_succ_iterator filtered_succ_start_end(const FilterOptions &f) const { 258ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek return filtered_succ_iterator(succ_begin(), succ_end(), this, f); 259ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek } 260ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 261fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek // Manipulation of block contents 2621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2639cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek void setTerminator(Stmt* Statement) { Terminator = Statement; } 2649cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek void setLabel(Stmt* Statement) { Label = Statement; } 2653575f84e459033d6427b84b4b795b22c85c4d27dTed Kremenek void setLoopTarget(const Stmt *loopTarget) { LoopTarget = loopTarget; } 2669cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek 2679cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek Stmt* getTerminator() { return Terminator; } 2689cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek const Stmt* getTerminator() const { return Terminator; } 2691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 270390e48b15ad93f85bfd1e33b9992c198fa0db475Ted Kremenek Stmt* getTerminatorCondition(); 2711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 272390e48b15ad93f85bfd1e33b9992c198fa0db475Ted Kremenek const Stmt* getTerminatorCondition() const { 273411cdee0b490f79428c9eb977f25199eb7d21cd8Ted Kremenek return const_cast<CFGBlock*>(this)->getTerminatorCondition(); 274411cdee0b490f79428c9eb977f25199eb7d21cd8Ted Kremenek } 2751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2763575f84e459033d6427b84b4b795b22c85c4d27dTed Kremenek const Stmt *getLoopTarget() const { return LoopTarget; } 2771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2789c2535a35db35b3a821a0d0c36a01a16f52f1ad0Ted Kremenek bool hasBinaryBranchTerminator() const; 2791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2809cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek Stmt* getLabel() { return Label; } 2819cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek const Stmt* getLabel() const { return Label; } 2821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 283fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek unsigned getBlockID() const { return BlockID; } 2841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 285e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner void dump(const CFG *cfg, const LangOptions &LO) const; 286e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner void print(llvm::raw_ostream &OS, const CFG* cfg, const LangOptions &LO) const; 287e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner void printTerminator(llvm::raw_ostream &OS, const LangOptions &LO) const; 288ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek 289ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek void addSuccessor(CFGBlock* Block, BumpVectorContext &C) { 290ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek if (Block) 291ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek Block->Preds.push_back(this, C); 292ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek Succs.push_back(Block, C); 293ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek } 294ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek 295852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek void appendStmt(Stmt* Statement, BumpVectorContext &C, bool asLValue) { 296852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek Stmts.push_back(CFGElement(Statement, asLValue), C); 297079bd72439448b78629a28da6b1f8abe2cdeaf4dMike Stump } 298fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek}; 2991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 300fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek 301fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// CFG - Represents a source-level, intra-procedural CFG that represents the 302fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// control-flow of a Stmt. The Stmt can represent an entire function body, 303fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// or a single expression. A CFG will always contain one empty block that 304fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// represents the Exit point of the CFG. A CFG will also contain a designated 305fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// Entry block. The CFG solely represents control-flow; it consists of 306fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// CFGBlocks which are simply containers of Stmt*'s in the AST the CFG 307fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// was constructed from. 308fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenekclass CFG { 309fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenekpublic: 310a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek //===--------------------------------------------------------------------===// 311a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek // CFG Construction & Manipulation. 312a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek //===--------------------------------------------------------------------===// 313a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek 3146c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek class BuildOptions { 3156c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek public: 3166c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek bool PruneTriviallyFalseEdges:1; 3176c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek bool AddEHEdges:1; 3186c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek bool AddInitializers:1; 3196c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek bool AddImplicitDtors:1; 3206c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek 3216c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek BuildOptions() 3226c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek : PruneTriviallyFalseEdges(true) 3236c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek , AddEHEdges(false) 3246c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek , AddInitializers(false) 3256c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek , AddImplicitDtors(false) {} 3266c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek }; 3276c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek 328a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek /// buildCFG - Builds a CFG from an AST. The responsibility to free the 3291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// constructed CFG belongs to the caller. 330b978a441c7d8bf59e7fede938e1f3b672573b443Mike Stump static CFG* buildCFG(const Decl *D, Stmt* AST, ASTContext *C, 3316c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek BuildOptions BO = BuildOptions()); 3321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 333a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek /// createBlock - Create a new block in the CFG. The CFG owns the block; 334a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek /// the caller should not directly free it. 335a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek CFGBlock* createBlock(); 3361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 337a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek /// setEntry - Set the entry block of the CFG. This is typically used 338a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek /// only during CFG construction. Most CFG clients expect that the 339a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek /// entry block has no predecessors and contains no statements. 340a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek void setEntry(CFGBlock *B) { Entry = B; } 3411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 342e38158de9236dfcded7da56126134e5e3e49cb01Ted Kremenek /// setIndirectGotoBlock - Set the block used for indirect goto jumps. 343e38158de9236dfcded7da56126134e5e3e49cb01Ted Kremenek /// This is typically used only during CFG construction. 344a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek void setIndirectGotoBlock(CFGBlock* B) { IndirectGotoBlock = B; } 3451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 346a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek //===--------------------------------------------------------------------===// 347a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek // Block Iterators 348a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek //===--------------------------------------------------------------------===// 349a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek 350ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek typedef BumpVector<CFGBlock*> CFGBlockListTy; 351a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek typedef CFGBlockListTy::iterator iterator; 352a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek typedef CFGBlockListTy::const_iterator const_iterator; 353a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek typedef std::reverse_iterator<iterator> reverse_iterator; 354a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek typedef std::reverse_iterator<const_iterator> const_reverse_iterator; 355fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek 356ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek CFGBlock& front() { return *Blocks.front(); } 357ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek CFGBlock& back() { return *Blocks.back(); } 3581eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 35919bb356317952445b03ee341c02f6147083c9eeaTed Kremenek iterator begin() { return Blocks.begin(); } 36019bb356317952445b03ee341c02f6147083c9eeaTed Kremenek iterator end() { return Blocks.end(); } 36119bb356317952445b03ee341c02f6147083c9eeaTed Kremenek const_iterator begin() const { return Blocks.begin(); } 3621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const_iterator end() const { return Blocks.end(); } 3631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 36419bb356317952445b03ee341c02f6147083c9eeaTed Kremenek reverse_iterator rbegin() { return Blocks.rbegin(); } 36519bb356317952445b03ee341c02f6147083c9eeaTed Kremenek reverse_iterator rend() { return Blocks.rend(); } 36619bb356317952445b03ee341c02f6147083c9eeaTed Kremenek const_reverse_iterator rbegin() const { return Blocks.rbegin(); } 36719bb356317952445b03ee341c02f6147083c9eeaTed Kremenek const_reverse_iterator rend() const { return Blocks.rend(); } 3681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 36919bb356317952445b03ee341c02f6147083c9eeaTed Kremenek CFGBlock& getEntry() { return *Entry; } 3707dba8607e59096014b7139ff20ef00870041d518Ted Kremenek const CFGBlock& getEntry() const { return *Entry; } 37119bb356317952445b03ee341c02f6147083c9eeaTed Kremenek CFGBlock& getExit() { return *Exit; } 3727dba8607e59096014b7139ff20ef00870041d518Ted Kremenek const CFGBlock& getExit() const { return *Exit; } 3737dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 3747dba8607e59096014b7139ff20ef00870041d518Ted Kremenek CFGBlock* getIndirectGotoBlock() { return IndirectGotoBlock; } 3757dba8607e59096014b7139ff20ef00870041d518Ted Kremenek const CFGBlock* getIndirectGotoBlock() const { return IndirectGotoBlock; } 3761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 377a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek //===--------------------------------------------------------------------===// 378a90b0d1e585d993621a342d0b2874e61941372d5Ted Kremenek // Member templates useful for various batch operations over CFGs. 379a90b0d1e585d993621a342d0b2874e61941372d5Ted Kremenek //===--------------------------------------------------------------------===// 3801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 381a90b0d1e585d993621a342d0b2874e61941372d5Ted Kremenek template <typename CALLBACK> 382a90b0d1e585d993621a342d0b2874e61941372d5Ted Kremenek void VisitBlockStmts(CALLBACK& O) const { 383a90b0d1e585d993621a342d0b2874e61941372d5Ted Kremenek for (const_iterator I=begin(), E=end(); I != E; ++I) 384ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek for (CFGBlock::const_iterator BI=(*I)->begin(), BE=(*I)->end(); 385ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek BI != BE; ++BI) 386a90b0d1e585d993621a342d0b2874e61941372d5Ted Kremenek O(*BI); 3871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 3881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 389a90b0d1e585d993621a342d0b2874e61941372d5Ted Kremenek //===--------------------------------------------------------------------===// 390a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek // CFG Introspection. 391a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek //===--------------------------------------------------------------------===// 392a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek 39363f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek struct BlkExprNumTy { 39463f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek const signed Idx; 39563f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek explicit BlkExprNumTy(signed idx) : Idx(idx) {} 39663f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek explicit BlkExprNumTy() : Idx(-1) {} 39763f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek operator bool() const { return Idx >= 0; } 39863f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek operator unsigned() const { assert(Idx >=0); return (unsigned) Idx; } 39963f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek }; 4001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 40186946745225096243f6969dc745267b78fc211a6Ted Kremenek bool isBlkExpr(const Stmt* S) { return getBlkExprNum(S); } 40286946745225096243f6969dc745267b78fc211a6Ted Kremenek BlkExprNumTy getBlkExprNum(const Stmt* S); 40363f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek unsigned getNumBlkExprs(); 4041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4050c8c5365be0176e8399e97d7da3293c79bc9da24Mike Stump /// getNumBlockIDs - Returns the total number of BlockIDs allocated (which 4060c8c5365be0176e8399e97d7da3293c79bc9da24Mike Stump /// start at 0). 4079438252ad2ecae5338df565ca33c6969e4fbfa41Ted Kremenek unsigned getNumBlockIDs() const { return NumBlockIDs; } 408a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek 409a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek //===--------------------------------------------------------------------===// 410a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek // CFG Debugging: Pretty-Printing and Visualization. 411a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek //===--------------------------------------------------------------------===// 412a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek 413e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner void viewCFG(const LangOptions &LO) const; 414e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner void print(llvm::raw_ostream& OS, const LangOptions &LO) const; 415e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner void dump(const LangOptions &LO) const; 416a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek 417a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek //===--------------------------------------------------------------------===// 418a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek // Internal: constructors and data. 419a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek //===--------------------------------------------------------------------===// 420a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek 4211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump CFG() : Entry(NULL), Exit(NULL), IndirectGotoBlock(NULL), NumBlockIDs(0), 4227177dee8aee4b432911c91f1b788963bec0cac9fDaniel Dunbar BlkExprMap(NULL), Blocks(BlkBVC, 10) {} 4231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 42463f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek ~CFG(); 4251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 426ce1eb34bbea1e0408f1952776d7d52ccde1bd275Ted Kremenek llvm::BumpPtrAllocator& getAllocator() { 427ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek return BlkBVC.getAllocator(); 428ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek } 429ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek 430ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek BumpVectorContext &getBumpVectorContext() { 431ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek return BlkBVC; 432ce1eb34bbea1e0408f1952776d7d52ccde1bd275Ted Kremenek } 4331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 434a36c6540346266f570b2fc7457950dea45d89988Ted Kremenekprivate: 435a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek CFGBlock* Entry; 436a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek CFGBlock* Exit; 437a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek CFGBlock* IndirectGotoBlock; // Special block to contain collective dispatch 438ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek // for indirect gotos 43963f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek unsigned NumBlockIDs; 4401eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 44186d1777a6b7723865c1e67a7aafc797ec0a574ffTed Kremenek // BlkExprMap - An opaque pointer to prevent inclusion of DenseMap.h. 4421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // It represents a map from Expr* to integers to record the set of 44386d1777a6b7723865c1e67a7aafc797ec0a574ffTed Kremenek // block-level expressions and their "statement number" in the CFG. 44463f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek void* BlkExprMap; 445ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek 446ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek BumpVectorContext BlkBVC; 447ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek 448ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek CFGBlockListTy Blocks; 4491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 450fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek}; 451fa2be43dbd6fdc4414e261db69aaf35dfb21a416Ted Kremenek} // end namespace clang 4527dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 4537dba8607e59096014b7139ff20ef00870041d518Ted Kremenek//===----------------------------------------------------------------------===// 4547dba8607e59096014b7139ff20ef00870041d518Ted Kremenek// GraphTraits specializations for CFG basic block graphs (source-level CFGs) 4557dba8607e59096014b7139ff20ef00870041d518Ted Kremenek//===----------------------------------------------------------------------===// 4567dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 4577dba8607e59096014b7139ff20ef00870041d518Ted Kremeneknamespace llvm { 4587dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 459852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek/// Implement simplify_type for CFGElement, so that we can dyn_cast from 460852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek/// CFGElement to a specific Stmt class. 461852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenektemplate <> struct simplify_type<const ::clang::CFGElement> { 462852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek typedef ::clang::Stmt* SimpleType; 463852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static SimpleType getSimplifiedValue(const ::clang::CFGElement &Val) { 464852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek return Val.getStmt(); 465852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek } 466852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek}; 467852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek 468852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenektemplate <> struct simplify_type< ::clang::CFGElement> 469852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek : public simplify_type<const ::clang::CFGElement> {}; 470852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek 4717dba8607e59096014b7139ff20ef00870041d518Ted Kremenek// Traits for: CFGBlock 4727dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 473852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenektemplate <> struct GraphTraits< ::clang::CFGBlock* > { 474852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek typedef ::clang::CFGBlock NodeType; 475852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek typedef ::clang::CFGBlock::succ_iterator ChildIteratorType; 4761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 477852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static NodeType* getEntryNode(::clang::CFGBlock* BB) 4787dba8607e59096014b7139ff20ef00870041d518Ted Kremenek { return BB; } 4797dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 4807dba8607e59096014b7139ff20ef00870041d518Ted Kremenek static inline ChildIteratorType child_begin(NodeType* N) 4817dba8607e59096014b7139ff20ef00870041d518Ted Kremenek { return N->succ_begin(); } 4821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4837dba8607e59096014b7139ff20ef00870041d518Ted Kremenek static inline ChildIteratorType child_end(NodeType* N) 4847dba8607e59096014b7139ff20ef00870041d518Ted Kremenek { return N->succ_end(); } 4857dba8607e59096014b7139ff20ef00870041d518Ted Kremenek}; 4867dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 487852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenektemplate <> struct GraphTraits< const ::clang::CFGBlock* > { 488852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek typedef const ::clang::CFGBlock NodeType; 489852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek typedef ::clang::CFGBlock::const_succ_iterator ChildIteratorType; 4901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4917dba8607e59096014b7139ff20ef00870041d518Ted Kremenek static NodeType* getEntryNode(const clang::CFGBlock* BB) 4927dba8607e59096014b7139ff20ef00870041d518Ted Kremenek { return BB; } 4931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4947dba8607e59096014b7139ff20ef00870041d518Ted Kremenek static inline ChildIteratorType child_begin(NodeType* N) 4957dba8607e59096014b7139ff20ef00870041d518Ted Kremenek { return N->succ_begin(); } 4961eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4977dba8607e59096014b7139ff20ef00870041d518Ted Kremenek static inline ChildIteratorType child_end(NodeType* N) 4987dba8607e59096014b7139ff20ef00870041d518Ted Kremenek { return N->succ_end(); } 4997dba8607e59096014b7139ff20ef00870041d518Ted Kremenek}; 5007dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 501852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenektemplate <> struct GraphTraits<Inverse<const ::clang::CFGBlock*> > { 502852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek typedef const ::clang::CFGBlock NodeType; 503852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek typedef ::clang::CFGBlock::const_pred_iterator ChildIteratorType; 5047dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 505852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static NodeType *getEntryNode(Inverse<const ::clang::CFGBlock*> G) 5067dba8607e59096014b7139ff20ef00870041d518Ted Kremenek { return G.Graph; } 5077dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 5087dba8607e59096014b7139ff20ef00870041d518Ted Kremenek static inline ChildIteratorType child_begin(NodeType* N) 5097dba8607e59096014b7139ff20ef00870041d518Ted Kremenek { return N->pred_begin(); } 5101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 5117dba8607e59096014b7139ff20ef00870041d518Ted Kremenek static inline ChildIteratorType child_end(NodeType* N) 5127dba8607e59096014b7139ff20ef00870041d518Ted Kremenek { return N->pred_end(); } 5137dba8607e59096014b7139ff20ef00870041d518Ted Kremenek}; 5147dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 5157dba8607e59096014b7139ff20ef00870041d518Ted Kremenek// Traits for: CFG 5167dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 517852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenektemplate <> struct GraphTraits< ::clang::CFG* > 518852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek : public GraphTraits< ::clang::CFGBlock* > { 5197dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 520852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek typedef ::clang::CFG::iterator nodes_iterator; 5211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 522852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static NodeType *getEntryNode(::clang::CFG* F) { return &F->getEntry(); } 523852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static nodes_iterator nodes_begin(::clang::CFG* F) { return F->begin(); } 524852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static nodes_iterator nodes_end(::clang::CFG* F) { return F->end(); } 5257dba8607e59096014b7139ff20ef00870041d518Ted Kremenek}; 5267dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 527852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenektemplate <> struct GraphTraits<const ::clang::CFG* > 528852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek : public GraphTraits<const ::clang::CFGBlock* > { 5297dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 530852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek typedef ::clang::CFG::const_iterator nodes_iterator; 5317dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 532852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static NodeType *getEntryNode( const ::clang::CFG* F) { 533852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek return &F->getEntry(); 534852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek } 535852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static nodes_iterator nodes_begin( const ::clang::CFG* F) { 536852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek return F->begin(); 537852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek } 538852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static nodes_iterator nodes_end( const ::clang::CFG* F) { 539852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek return F->end(); 540852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek } 5417dba8607e59096014b7139ff20ef00870041d518Ted Kremenek}; 5427dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 543852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenektemplate <> struct GraphTraits<Inverse<const ::clang::CFG*> > 544852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek : public GraphTraits<Inverse<const ::clang::CFGBlock*> > { 5457dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 546852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek typedef ::clang::CFG::const_iterator nodes_iterator; 5477dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 548852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static NodeType *getEntryNode(const ::clang::CFG* F) { return &F->getExit(); } 549852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static nodes_iterator nodes_begin(const ::clang::CFG* F) { return F->begin();} 550852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static nodes_iterator nodes_end(const ::clang::CFG* F) { return F->end(); } 5517dba8607e59096014b7139ff20ef00870041d518Ted Kremenek}; 5527dba8607e59096014b7139ff20ef00870041d518Ted Kremenek} // end llvm namespace 553cd881d534517f09a2fae10445f9b865f49ccc6c8Ted Kremenek#endif 554