CFG.h revision 8cc488fefb2fb04bc8d5398da29f0182f97934cf
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" 22b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek#include "llvm/ADT/OwningPtr.h" 23b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek#include "llvm/ADT/DenseMap.h" 2474fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek#include "llvm/ADT/BitVector.h" 2574fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek#include "clang/AST/Stmt.h" 26ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek#include "clang/Analysis/Support/BumpVector.h" 27079bd72439448b78629a28da6b1f8abe2cdeaf4dMike Stump#include "clang/Basic/SourceLocation.h" 28c1581a0d64b0ee4f822ed2fca4442a111d03569aHartmut Kaiser#include <cassert> 29403ba3522d1b1c97ae5fad81c1a2c4b3a754e1c1Nick Lewycky#include <iterator> 30fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek 31e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattnernamespace llvm { 32e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner class raw_ostream; 33e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner} 342a4cd498ff9b2b126de3e370b768ab307c221ab8Marcin Swiderski 35fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremeneknamespace clang { 363c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek class CXXDestructorDecl; 37b978a441c7d8bf59e7fede938e1f3b672573b443Mike Stump class Decl; 3842a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek class Stmt; 3963f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek class Expr; 407c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski class FieldDecl; 411cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski class VarDecl; 42cbb67480094b3bcb5b715acd827cbad55e2a204cSean Hunt class CXXCtorInitializer; 437c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski class CXXBaseSpecifier; 448599e7677e067fd01d3b2ee4c0875747d367fd8eMarcin Swiderski class CXXBindTemporaryExpr; 4542a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek class CFG; 4642a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek class PrinterHelper; 47e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner class LangOptions; 48e5af3ce53ec58995b09381ba645ab2117a46647bMike Stump class ASTContext; 49e5af3ce53ec58995b09381ba645ab2117a46647bMike Stump 50852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek/// CFGElement - Represents a top-level expression in a basic block. 51852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenekclass CFGElement { 52852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenekpublic: 53b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu enum Kind { 54b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu // main kind 553c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek Invalid, 56b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu Statement, 57b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu Initializer, 58b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu // dtor kind 59b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu AutomaticObjectDtor, 60b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu BaseDtor, 61b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu MemberDtor, 62b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu TemporaryDtor, 633c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek DTOR_BEGIN = AutomaticObjectDtor, 643c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek DTOR_END = TemporaryDtor 65b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu }; 66b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu 67b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xuprotected: 683c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek // The int bits are used to mark the kind. 69b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu llvm::PointerIntPair<void *, 2> Data1; 70b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu llvm::PointerIntPair<void *, 2> Data2; 71b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu 723c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek CFGElement(Kind kind, const void *Ptr1, const void *Ptr2 = 0) 733c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek : Data1(const_cast<void*>(Ptr1), ((unsigned) kind) & 0x3), 743c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek Data2(const_cast<void*>(Ptr2), (((unsigned) kind) >> 2) & 0x3) {} 751cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski 76b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xupublic: 77b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu CFGElement() {} 78b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu 793c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek Kind getKind() const { 803c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek unsigned x = Data2.getInt(); 813c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek x <<= 2; 823c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek x |= Data1.getInt(); 833c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek return (Kind) x; 84b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu } 853c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek 863c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek bool isValid() const { return getKind() != Invalid; } 87b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu 88b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu operator bool() const { return isValid(); } 893c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek 903c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek template<class ElemTy> const ElemTy *getAs() const { 91b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu if (llvm::isa<ElemTy>(this)) 923c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek return static_cast<const ElemTy*>(this); 933c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek return 0; 94b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu } 95b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu 96b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu static bool classof(const CFGElement *E) { return true; } 97b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu}; 98b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu 99b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xuclass CFGStmt : public CFGElement { 100b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xupublic: 1013c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek CFGStmt(Stmt *S) : CFGElement(Statement, S) {} 102b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu 103b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu Stmt *getStmt() const { return static_cast<Stmt *>(Data1.getPointer()); } 104b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu 105b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu static bool classof(const CFGElement *E) { 106892697dd2287caf7c29aaaa82909b0e90b8b63feTed Kremenek return E->getKind() == Statement; 107b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu } 108b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu}; 109b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu 1101cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski/// CFGInitializer - Represents C++ base or member initializer from 1111cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski/// constructor's initialization list. 112b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xuclass CFGInitializer : public CFGElement { 113b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xupublic: 1143c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek CFGInitializer(CXXCtorInitializer *initializer) 1153c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek : CFGElement(Initializer, initializer) {} 1161cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski 117cbb67480094b3bcb5b715acd827cbad55e2a204cSean Hunt CXXCtorInitializer* getInitializer() const { 118cbb67480094b3bcb5b715acd827cbad55e2a204cSean Hunt return static_cast<CXXCtorInitializer*>(Data1.getPointer()); 1191cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski } 1201cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski 121b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu static bool classof(const CFGElement *E) { 122b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu return E->getKind() == Initializer; 123b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu } 124b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu}; 125b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu 12653de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski/// CFGImplicitDtor - Represents C++ object destructor implicitly generated 1271cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski/// by compiler on various occasions. 128b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xuclass CFGImplicitDtor : public CFGElement { 1291cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderskiprotected: 1303c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek CFGImplicitDtor(Kind kind, const void *data1, const void *data2 = 0) 1313c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek : CFGElement(kind, data1, data2) { 1323c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek assert(kind >= DTOR_BEGIN && kind <= DTOR_END); 1333c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek } 1341cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski 135b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xupublic: 136c5aff4497e5bfd7523e00b87560c1a5aa65136ccTed Kremenek const CXXDestructorDecl *getDestructorDecl(ASTContext &astContext) const; 137c5aff4497e5bfd7523e00b87560c1a5aa65136ccTed Kremenek bool isNoReturn(ASTContext &astContext) const; 1381cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski 139b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu static bool classof(const CFGElement *E) { 1403c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek Kind kind = E->getKind(); 1413c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek return kind >= DTOR_BEGIN && kind <= DTOR_END; 142b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu } 143b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu}; 144b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu 1457c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski/// CFGAutomaticObjDtor - Represents C++ object destructor implicitly generated 1461cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski/// for automatic object or temporary bound to const reference at the point 1471cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski/// of leaving its local scope. 148b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xuclass CFGAutomaticObjDtor: public CFGImplicitDtor { 149b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xupublic: 1503c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek CFGAutomaticObjDtor(const VarDecl *var, const Stmt *stmt) 1513c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek : CFGImplicitDtor(AutomaticObjectDtor, var, stmt) {} 1521cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski 1533c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek const VarDecl *getVarDecl() const { 1541cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski return static_cast<VarDecl*>(Data1.getPointer()); 1551cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski } 1561cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski 1571cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski // Get statement end of which triggered the destructor call. 1583c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek const Stmt *getTriggerStmt() const { 1591cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski return static_cast<Stmt*>(Data2.getPointer()); 1601cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski } 1611cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski 1623c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek static bool classof(const CFGElement *elem) { 1633c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek return elem->getKind() == AutomaticObjectDtor; 164b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu } 165b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu}; 166b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu 1677c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski/// CFGBaseDtor - Represents C++ object destructor implicitly generated for 1687c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski/// base object in destructor. 169b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xuclass CFGBaseDtor : public CFGImplicitDtor { 170b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xupublic: 1713c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek CFGBaseDtor(const CXXBaseSpecifier *base) 1723c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek : CFGImplicitDtor(BaseDtor, base) {} 1737c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski 1747c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski const CXXBaseSpecifier *getBaseSpecifier() const { 1757c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski return static_cast<const CXXBaseSpecifier*>(Data1.getPointer()); 1767c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski } 1777c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski 178b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu static bool classof(const CFGElement *E) { 1793c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek return E->getKind() == BaseDtor; 180b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu } 181b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu}; 182b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu 1837c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski/// CFGMemberDtor - Represents C++ object destructor implicitly generated for 1847c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski/// member object in destructor. 185b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xuclass CFGMemberDtor : public CFGImplicitDtor { 186b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xupublic: 1873c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek CFGMemberDtor(const FieldDecl *field) 1883c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek : CFGImplicitDtor(MemberDtor, field, 0) {} 1897c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski 1903c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek const FieldDecl *getFieldDecl() const { 1913c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek return static_cast<const FieldDecl*>(Data1.getPointer()); 1927c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski } 1937c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski 194b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu static bool classof(const CFGElement *E) { 1953c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek return E->getKind() == MemberDtor; 196b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu } 197b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu}; 198b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu 1998599e7677e067fd01d3b2ee4c0875747d367fd8eMarcin Swiderski/// CFGTemporaryDtor - Represents C++ object destructor implicitly generated 2008599e7677e067fd01d3b2ee4c0875747d367fd8eMarcin Swiderski/// at the end of full expression for temporary object. 201b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xuclass CFGTemporaryDtor : public CFGImplicitDtor { 202b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xupublic: 2033c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek CFGTemporaryDtor(CXXBindTemporaryExpr *expr) 2043c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek : CFGImplicitDtor(TemporaryDtor, expr, 0) {} 2058599e7677e067fd01d3b2ee4c0875747d367fd8eMarcin Swiderski 2063c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek const CXXBindTemporaryExpr *getBindTemporaryExpr() const { 2073c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek return static_cast<const CXXBindTemporaryExpr *>(Data1.getPointer()); 2088599e7677e067fd01d3b2ee4c0875747d367fd8eMarcin Swiderski } 2098599e7677e067fd01d3b2ee4c0875747d367fd8eMarcin Swiderski 210b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu static bool classof(const CFGElement *E) { 2113c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek return E->getKind() == TemporaryDtor; 212b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu } 213852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek}; 214852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek 2154ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski/// CFGTerminator - Represents CFGBlock terminator statement. 2164ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski/// 2174ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski/// TemporaryDtorsBranch bit is set to true if the terminator marks a branch 2184ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski/// in control flow of destructors of temporaries. In this case terminator 2194ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski/// statement is the same statement that branches control flow in evaluation 2204ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski/// of matching full expression. 2214ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderskiclass CFGTerminator { 2224ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski llvm::PointerIntPair<Stmt *, 1> Data; 2234ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderskipublic: 2244ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski CFGTerminator() {} 2254ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski CFGTerminator(Stmt *S, bool TemporaryDtorsBranch = false) 2264ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski : Data(S, TemporaryDtorsBranch) {} 2274ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski 2284ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski Stmt *getStmt() { return Data.getPointer(); } 2294ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski const Stmt *getStmt() const { return Data.getPointer(); } 2304ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski 2314ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski bool isTemporaryDtorsBranch() const { return Data.getInt(); } 2324ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski 2334ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski operator Stmt *() { return getStmt(); } 2344ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski operator const Stmt *() const { return getStmt(); } 2354ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski 2364ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski Stmt *operator->() { return getStmt(); } 2374ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski const Stmt *operator->() const { return getStmt(); } 2384ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski 2394ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski Stmt &operator*() { return *getStmt(); } 2404ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski const Stmt &operator*() const { return *getStmt(); } 2414ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski 2424ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski operator bool() const { return getStmt(); } 2434ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski}; 2444ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski 245fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// CFGBlock - Represents a single basic block in a source-level CFG. 246fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// It consists of: 247fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// 248fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// (1) A set of statements/expressions (which may contain subexpressions). 249fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// (2) A "terminator" statement (not in the set of statements). 250fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// (3) A list of successors and predecessors. 251fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// 252fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// Terminator: The terminator represents the type of control-flow that occurs 253fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// at the end of the basic block. The terminator is a Stmt* referring to an 254fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// AST node that has control-flow: if-statements, breaks, loops, etc. 255fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// If the control-flow is conditional, the condition expression will appear 256fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// within the set of statements in the block (usually the last statement). 257fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// 258fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// Predecessors: the order in the set of predecessors is arbitrary. 259fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// 260fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// Successors: the order in the set of successors is NOT arbitrary. We 261fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// currently have the following orderings based on the terminator: 262fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// 263fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// Terminator Successor Ordering 264fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// ----------------------------------------------------- 265fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// if Then Block; Else Block 2669cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek/// ? operator LHS expression; RHS expression 2679cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek/// &&, || expression that uses result of && or ||, RHS 268fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// 2693cda937d4c015ff6070f1117024621a452cfadddTed Kremenek/// But note that any of that may be NULL in case of optimized-out edges. 2703cda937d4c015ff6070f1117024621a452cfadddTed Kremenek/// 271fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenekclass CFGBlock { 272b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu class ElementList { 273852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek typedef BumpVector<CFGElement> ImplTy; 2746c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek ImplTy Impl; 2756c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek public: 276b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu ElementList(BumpVectorContext &C) : Impl(C, 4) {} 277ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek 2786c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek typedef std::reverse_iterator<ImplTy::iterator> iterator; 2796c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek typedef std::reverse_iterator<ImplTy::const_iterator> const_iterator; 2806c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek typedef ImplTy::iterator reverse_iterator; 2816c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek typedef ImplTy::const_iterator const_reverse_iterator; 2826c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek 283852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek void push_back(CFGElement e, BumpVectorContext &C) { Impl.push_back(e, C); } 28453de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski reverse_iterator insert(reverse_iterator I, size_t Cnt, CFGElement E, 28553de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski BumpVectorContext& C) { 28653de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski return Impl.insert(I, Cnt, E, C); 28753de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski } 28853de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski 289852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek CFGElement front() const { return Impl.back(); } 290852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek CFGElement back() const { return Impl.front(); } 2916c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek 2926c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek iterator begin() { return Impl.rbegin(); } 2936c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek iterator end() { return Impl.rend(); } 2946c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek const_iterator begin() const { return Impl.rbegin(); } 2956c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek const_iterator end() const { return Impl.rend(); } 2966c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek reverse_iterator rbegin() { return Impl.begin(); } 2976c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek reverse_iterator rend() { return Impl.end(); } 2986c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek const_reverse_iterator rbegin() const { return Impl.begin(); } 2996c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek const_reverse_iterator rend() const { return Impl.end(); } 3006c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek 301852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek CFGElement operator[](size_t i) const { 3026c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek assert(i < Impl.size()); 3036c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek return Impl[Impl.size() - 1 - i]; 3046c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek } 3056c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek 3066c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek size_t size() const { return Impl.size(); } 3076c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek bool empty() const { return Impl.empty(); } 3086c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek }; 3096c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek 310fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek /// Stmts - The set of statements in the basic block. 311b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu ElementList Elements; 3129cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek 3139cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek /// Label - An (optional) label that prefixes the executable 3149cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek /// statements in the block. When this variable is non-NULL, it is 3154c45aa1b00b91847acfb082acfaced3ffa294d1dMike Stump /// either an instance of LabelStmt, SwitchCase or CXXCatchStmt. 3163575f84e459033d6427b84b4b795b22c85c4d27dTed Kremenek Stmt *Label; 3171eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3189cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek /// Terminator - The terminator for a basic block that 319fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek /// indicates the type of control-flow that occurs between a block 320fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek /// and its successors. 3214ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski CFGTerminator Terminator; 3221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3233575f84e459033d6427b84b4b795b22c85c4d27dTed Kremenek /// LoopTarget - Some blocks are used to represent the "loop edge" to 3243575f84e459033d6427b84b4b795b22c85c4d27dTed Kremenek /// the start of a loop from within the loop body. This Stmt* will be 3253575f84e459033d6427b84b4b795b22c85c4d27dTed Kremenek /// refer to the loop statement for such blocks (and be null otherwise). 3261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const Stmt *LoopTarget; 3271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 328fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek /// BlockID - A numerical ID assigned to a CFGBlock during construction 329fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek /// of the CFG. 330fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek unsigned BlockID; 3311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 332fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek /// Predecessors/Successors - Keep track of the predecessor / successor 333fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek /// CFG blocks. 334ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek typedef BumpVector<CFGBlock*> AdjacentBlocks; 335fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek AdjacentBlocks Preds; 336fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek AdjacentBlocks Succs; 3371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 338fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenekpublic: 339ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek explicit CFGBlock(unsigned blockid, BumpVectorContext &C) 340b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu : Elements(C), Label(NULL), Terminator(NULL), LoopTarget(NULL), 341ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek BlockID(blockid), Preds(C, 1), Succs(C, 1) {} 3427177dee8aee4b432911c91f1b788963bec0cac9fDaniel Dunbar ~CFGBlock() {} 343fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek 344fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek // Statement iterators 345b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu typedef ElementList::iterator iterator; 346b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu typedef ElementList::const_iterator const_iterator; 347b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu typedef ElementList::reverse_iterator reverse_iterator; 348b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu typedef ElementList::const_reverse_iterator const_reverse_iterator; 3491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 350b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu CFGElement front() const { return Elements.front(); } 351b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu CFGElement back() const { return Elements.back(); } 3521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 353b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu iterator begin() { return Elements.begin(); } 354b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu iterator end() { return Elements.end(); } 355b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu const_iterator begin() const { return Elements.begin(); } 356b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu const_iterator end() const { return Elements.end(); } 357fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek 358b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu reverse_iterator rbegin() { return Elements.rbegin(); } 359b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu reverse_iterator rend() { return Elements.rend(); } 360b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu const_reverse_iterator rbegin() const { return Elements.rbegin(); } 361b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu const_reverse_iterator rend() const { return Elements.rend(); } 3621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 363b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu unsigned size() const { return Elements.size(); } 364b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu bool empty() const { return Elements.empty(); } 365be7a7d6f2e5b86807afd08a568863df973baaa38Ted Kremenek 366b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu CFGElement operator[](size_t i) const { return Elements[i]; } 3671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 368fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek // CFG iterators 369fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek typedef AdjacentBlocks::iterator pred_iterator; 370fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek typedef AdjacentBlocks::const_iterator const_pred_iterator; 371fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek typedef AdjacentBlocks::reverse_iterator pred_reverse_iterator; 372fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek typedef AdjacentBlocks::const_reverse_iterator const_pred_reverse_iterator; 373fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek 374fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek typedef AdjacentBlocks::iterator succ_iterator; 375fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek typedef AdjacentBlocks::const_iterator const_succ_iterator; 376fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek typedef AdjacentBlocks::reverse_iterator succ_reverse_iterator; 377fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek typedef AdjacentBlocks::const_reverse_iterator const_succ_reverse_iterator; 3781eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 379fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek pred_iterator pred_begin() { return Preds.begin(); } 380fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek pred_iterator pred_end() { return Preds.end(); } 381fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek const_pred_iterator pred_begin() const { return Preds.begin(); } 382fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek const_pred_iterator pred_end() const { return Preds.end(); } 3831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 384fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek pred_reverse_iterator pred_rbegin() { return Preds.rbegin(); } 3851eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump pred_reverse_iterator pred_rend() { return Preds.rend(); } 386fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek const_pred_reverse_iterator pred_rbegin() const { return Preds.rbegin(); } 387fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek const_pred_reverse_iterator pred_rend() const { return Preds.rend(); } 388fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek 3891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump succ_iterator succ_begin() { return Succs.begin(); } 390fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek succ_iterator succ_end() { return Succs.end(); } 391fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek const_succ_iterator succ_begin() const { return Succs.begin(); } 3921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const_succ_iterator succ_end() const { return Succs.end(); } 3931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 394fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek succ_reverse_iterator succ_rbegin() { return Succs.rbegin(); } 395fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek succ_reverse_iterator succ_rend() { return Succs.rend(); } 396fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek const_succ_reverse_iterator succ_rbegin() const { return Succs.rbegin(); } 397fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek const_succ_reverse_iterator succ_rend() const { return Succs.rend(); } 398fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek 399fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek unsigned succ_size() const { return Succs.size(); } 400fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek bool succ_empty() const { return Succs.empty(); } 401fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek 402fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek unsigned pred_size() const { return Preds.size(); } 403fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek bool pred_empty() const { return Preds.empty(); } 4041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 405ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 406ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek class FilterOptions { 407ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek public: 408ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek FilterOptions() { 409ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek IgnoreDefaultsWithCoveredEnums = 0; 410be39a566a914df8561d7a1e9654708297f0908c1Ted Kremenek } 411ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 412ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek unsigned IgnoreDefaultsWithCoveredEnums : 1; 413ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek }; 414ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 415ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek static bool FilterEdge(const FilterOptions &F, const CFGBlock *Src, 416be39a566a914df8561d7a1e9654708297f0908c1Ted Kremenek const CFGBlock *Dst); 417ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 418ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek template <typename IMPL, bool IsPred> 419ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek class FilteredCFGBlockIterator { 420ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek private: 421ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek IMPL I, E; 422ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek const FilterOptions F; 423ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek const CFGBlock *From; 424ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek public: 425ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek explicit FilteredCFGBlockIterator(const IMPL &i, const IMPL &e, 426be39a566a914df8561d7a1e9654708297f0908c1Ted Kremenek const CFGBlock *from, 427be39a566a914df8561d7a1e9654708297f0908c1Ted Kremenek const FilterOptions &f) 428ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek : I(i), E(e), F(f), From(from) {} 429ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 430ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek bool hasMore() const { return I != E; } 431ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 432ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek FilteredCFGBlockIterator &operator++() { 433ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek do { ++I; } while (hasMore() && Filter(*I)); 434ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek return *this; 435ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek } 436ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 437ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek const CFGBlock *operator*() const { return *I; } 438ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek private: 439ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek bool Filter(const CFGBlock *To) { 440ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek return IsPred ? FilterEdge(F, To, From) : FilterEdge(F, From, To); 441ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek } 442ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek }; 443ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 444ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek typedef FilteredCFGBlockIterator<const_pred_iterator, true> 445ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek filtered_pred_iterator; 446ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 447ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek typedef FilteredCFGBlockIterator<const_succ_iterator, false> 448ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek filtered_succ_iterator; 449ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 450ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek filtered_pred_iterator filtered_pred_start_end(const FilterOptions &f) const { 451ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek return filtered_pred_iterator(pred_begin(), pred_end(), this, f); 452ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek } 453ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 454ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek filtered_succ_iterator filtered_succ_start_end(const FilterOptions &f) const { 455ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek return filtered_succ_iterator(succ_begin(), succ_end(), this, f); 456ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek } 457ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek 458fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek // Manipulation of block contents 4591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4609cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek void setTerminator(Stmt* Statement) { Terminator = Statement; } 4619cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek void setLabel(Stmt* Statement) { Label = Statement; } 4623575f84e459033d6427b84b4b795b22c85c4d27dTed Kremenek void setLoopTarget(const Stmt *loopTarget) { LoopTarget = loopTarget; } 4639cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek 4644ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski CFGTerminator getTerminator() { return Terminator; } 4654ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski const CFGTerminator getTerminator() const { return Terminator; } 4661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 467390e48b15ad93f85bfd1e33b9992c198fa0db475Ted Kremenek Stmt* getTerminatorCondition(); 4681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 469390e48b15ad93f85bfd1e33b9992c198fa0db475Ted Kremenek const Stmt* getTerminatorCondition() const { 470411cdee0b490f79428c9eb977f25199eb7d21cd8Ted Kremenek return const_cast<CFGBlock*>(this)->getTerminatorCondition(); 471411cdee0b490f79428c9eb977f25199eb7d21cd8Ted Kremenek } 4721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4733575f84e459033d6427b84b4b795b22c85c4d27dTed Kremenek const Stmt *getLoopTarget() const { return LoopTarget; } 4741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4759cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek Stmt* getLabel() { return Label; } 4769cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek const Stmt* getLabel() const { return Label; } 4771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 478fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek unsigned getBlockID() const { return BlockID; } 4791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 480e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner void dump(const CFG *cfg, const LangOptions &LO) const; 4818cc488fefb2fb04bc8d5398da29f0182f97934cfChris Lattner void print(raw_ostream &OS, const CFG* cfg, const LangOptions &LO) const; 4828cc488fefb2fb04bc8d5398da29f0182f97934cfChris Lattner void printTerminator(raw_ostream &OS, const LangOptions &LO) const; 483ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek 484ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek void addSuccessor(CFGBlock* Block, BumpVectorContext &C) { 485ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek if (Block) 486ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek Block->Preds.push_back(this, C); 487ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek Succs.push_back(Block, C); 488ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek } 489ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek 490892697dd2287caf7c29aaaa82909b0e90b8b63feTed Kremenek void appendStmt(Stmt* statement, BumpVectorContext &C) { 491892697dd2287caf7c29aaaa82909b0e90b8b63feTed Kremenek Elements.push_back(CFGStmt(statement), C); 492079bd72439448b78629a28da6b1f8abe2cdeaf4dMike Stump } 49382bc3fd823d85ee3ef9a641c0975b6ad25f55047Marcin Swiderski 494cbb67480094b3bcb5b715acd827cbad55e2a204cSean Hunt void appendInitializer(CXXCtorInitializer *initializer, 495892697dd2287caf7c29aaaa82909b0e90b8b63feTed Kremenek BumpVectorContext& C) { 496892697dd2287caf7c29aaaa82909b0e90b8b63feTed Kremenek Elements.push_back(CFGInitializer(initializer), C); 49782bc3fd823d85ee3ef9a641c0975b6ad25f55047Marcin Swiderski } 49882bc3fd823d85ee3ef9a641c0975b6ad25f55047Marcin Swiderski 4997c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski void appendBaseDtor(const CXXBaseSpecifier *BS, BumpVectorContext &C) { 5007c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski Elements.push_back(CFGBaseDtor(BS), C); 5017c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski } 5027c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski 5037c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski void appendMemberDtor(FieldDecl *FD, BumpVectorContext &C) { 5047c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski Elements.push_back(CFGMemberDtor(FD), C); 5057c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski } 5068599e7677e067fd01d3b2ee4c0875747d367fd8eMarcin Swiderski 5078599e7677e067fd01d3b2ee4c0875747d367fd8eMarcin Swiderski void appendTemporaryDtor(CXXBindTemporaryExpr *E, BumpVectorContext &C) { 5088599e7677e067fd01d3b2ee4c0875747d367fd8eMarcin Swiderski Elements.push_back(CFGTemporaryDtor(E), C); 5098599e7677e067fd01d3b2ee4c0875747d367fd8eMarcin Swiderski } 5107c625d8ffc20b92fff9e1690cd2484fcb6498183Marcin Swiderski 51153de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski // Destructors must be inserted in reversed order. So insertion is in two 51253de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski // steps. First we prepare space for some number of elements, then we insert 51353de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski // the elements beginning at the last position in prepared space. 51453de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski iterator beginAutomaticObjDtorsInsert(iterator I, size_t Cnt, 51553de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski BumpVectorContext& C) { 51653de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski return iterator(Elements.insert(I.base(), Cnt, CFGElement(), C)); 51753de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski } 51853de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski iterator insertAutomaticObjDtor(iterator I, VarDecl* VD, Stmt* S) { 51953de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski *I = CFGAutomaticObjDtor(VD, S); 52053de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski return ++I; 52153de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski } 522fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek}; 5231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 524fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// CFG - Represents a source-level, intra-procedural CFG that represents the 525fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// control-flow of a Stmt. The Stmt can represent an entire function body, 526fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// or a single expression. A CFG will always contain one empty block that 527fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// represents the Exit point of the CFG. A CFG will also contain a designated 528fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// Entry block. The CFG solely represents control-flow; it consists of 529fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// CFGBlocks which are simply containers of Stmt*'s in the AST the CFG 530fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// was constructed from. 531fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenekclass CFG { 532fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenekpublic: 533a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek //===--------------------------------------------------------------------===// 534a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek // CFG Construction & Manipulation. 535a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek //===--------------------------------------------------------------------===// 536a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek 5376c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek class BuildOptions { 53874fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek llvm::BitVector alwaysAddMask; 5396c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek public: 5400d28d360b5559abda755e50b855ba5e59727d9cdTed Kremenek typedef llvm::DenseMap<const Stmt *, const CFGBlock*> ForcedBlkExprs; 541b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek ForcedBlkExprs **forcedBlkExprs; 542b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek 5436c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek bool PruneTriviallyFalseEdges:1; 5446c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek bool AddEHEdges:1; 5456c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek bool AddInitializers:1; 5466c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek bool AddImplicitDtors:1; 54774fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek 54874fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek bool alwaysAdd(const Stmt *stmt) const { 54974fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek return alwaysAddMask[stmt->getStmtClass()]; 55074fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek } 55174fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek 55274fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek void setAlwaysAdd(Stmt::StmtClass stmtClass) { 55374fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek alwaysAddMask[stmtClass] = true; 55474fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek } 5556c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek 5566c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek BuildOptions() 55774fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek : alwaysAddMask(Stmt::lastStmtConstant, false) 55874fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek ,forcedBlkExprs(0), PruneTriviallyFalseEdges(true) 55974fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek ,AddEHEdges(false) 56074fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek ,AddInitializers(false) 56174fb1a493cf5d2dd0fb51a4eadf74e85e10a3457Ted Kremenek ,AddImplicitDtors(false) {} 5626c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek }; 5636c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek 564a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek /// buildCFG - Builds a CFG from an AST. The responsibility to free the 5651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump /// constructed CFG belongs to the caller. 566b978a441c7d8bf59e7fede938e1f3b672573b443Mike Stump static CFG* buildCFG(const Decl *D, Stmt* AST, ASTContext *C, 567b8ad5ee345fa1fdd1fa9253f2d01f69becc88a04Ted Kremenek const BuildOptions &BO); 5681eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 569a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek /// createBlock - Create a new block in the CFG. The CFG owns the block; 570a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek /// the caller should not directly free it. 571a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek CFGBlock* createBlock(); 5721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 573a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek /// setEntry - Set the entry block of the CFG. This is typically used 574a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek /// only during CFG construction. Most CFG clients expect that the 575a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek /// entry block has no predecessors and contains no statements. 576a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek void setEntry(CFGBlock *B) { Entry = B; } 5771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 578e38158de9236dfcded7da56126134e5e3e49cb01Ted Kremenek /// setIndirectGotoBlock - Set the block used for indirect goto jumps. 579e38158de9236dfcded7da56126134e5e3e49cb01Ted Kremenek /// This is typically used only during CFG construction. 580a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek void setIndirectGotoBlock(CFGBlock* B) { IndirectGotoBlock = B; } 5811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 582a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek //===--------------------------------------------------------------------===// 583a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek // Block Iterators 584a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek //===--------------------------------------------------------------------===// 585a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek 586ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek typedef BumpVector<CFGBlock*> CFGBlockListTy; 587a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek typedef CFGBlockListTy::iterator iterator; 588a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek typedef CFGBlockListTy::const_iterator const_iterator; 589a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek typedef std::reverse_iterator<iterator> reverse_iterator; 590a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek typedef std::reverse_iterator<const_iterator> const_reverse_iterator; 591fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek 592ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek CFGBlock& front() { return *Blocks.front(); } 593ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek CFGBlock& back() { return *Blocks.back(); } 5941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 59519bb356317952445b03ee341c02f6147083c9eeaTed Kremenek iterator begin() { return Blocks.begin(); } 59619bb356317952445b03ee341c02f6147083c9eeaTed Kremenek iterator end() { return Blocks.end(); } 59719bb356317952445b03ee341c02f6147083c9eeaTed Kremenek const_iterator begin() const { return Blocks.begin(); } 5981eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump const_iterator end() const { return Blocks.end(); } 5991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 60019bb356317952445b03ee341c02f6147083c9eeaTed Kremenek reverse_iterator rbegin() { return Blocks.rbegin(); } 60119bb356317952445b03ee341c02f6147083c9eeaTed Kremenek reverse_iterator rend() { return Blocks.rend(); } 60219bb356317952445b03ee341c02f6147083c9eeaTed Kremenek const_reverse_iterator rbegin() const { return Blocks.rbegin(); } 60319bb356317952445b03ee341c02f6147083c9eeaTed Kremenek const_reverse_iterator rend() const { return Blocks.rend(); } 6041eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 60519bb356317952445b03ee341c02f6147083c9eeaTed Kremenek CFGBlock& getEntry() { return *Entry; } 6067dba8607e59096014b7139ff20ef00870041d518Ted Kremenek const CFGBlock& getEntry() const { return *Entry; } 60719bb356317952445b03ee341c02f6147083c9eeaTed Kremenek CFGBlock& getExit() { return *Exit; } 6087dba8607e59096014b7139ff20ef00870041d518Ted Kremenek const CFGBlock& getExit() const { return *Exit; } 6097dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 6107dba8607e59096014b7139ff20ef00870041d518Ted Kremenek CFGBlock* getIndirectGotoBlock() { return IndirectGotoBlock; } 6117dba8607e59096014b7139ff20ef00870041d518Ted Kremenek const CFGBlock* getIndirectGotoBlock() const { return IndirectGotoBlock; } 6121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 613a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek //===--------------------------------------------------------------------===// 614a90b0d1e585d993621a342d0b2874e61941372d5Ted Kremenek // Member templates useful for various batch operations over CFGs. 615a90b0d1e585d993621a342d0b2874e61941372d5Ted Kremenek //===--------------------------------------------------------------------===// 6161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 617a90b0d1e585d993621a342d0b2874e61941372d5Ted Kremenek template <typename CALLBACK> 618a90b0d1e585d993621a342d0b2874e61941372d5Ted Kremenek void VisitBlockStmts(CALLBACK& O) const { 619a90b0d1e585d993621a342d0b2874e61941372d5Ted Kremenek for (const_iterator I=begin(), E=end(); I != E; ++I) 620ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek for (CFGBlock::const_iterator BI=(*I)->begin(), BE=(*I)->end(); 621b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu BI != BE; ++BI) { 6223c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek if (const CFGStmt *stmt = BI->getAs<CFGStmt>()) 6233c0349e87cdbd7316d06d2411d86ee1086e717a5Ted Kremenek O(stmt->getStmt()); 624b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu } 6251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump } 6261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 627a90b0d1e585d993621a342d0b2874e61941372d5Ted Kremenek //===--------------------------------------------------------------------===// 628a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek // CFG Introspection. 629a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek //===--------------------------------------------------------------------===// 630a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek 63163f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek struct BlkExprNumTy { 63263f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek const signed Idx; 63363f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek explicit BlkExprNumTy(signed idx) : Idx(idx) {} 63463f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek explicit BlkExprNumTy() : Idx(-1) {} 63563f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek operator bool() const { return Idx >= 0; } 63663f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek operator unsigned() const { assert(Idx >=0); return (unsigned) Idx; } 63763f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek }; 6381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 639200fbc877d50da9e53b9aa272b70ca3538ce3a66Ted Kremenek bool isBlkExpr(const Stmt* S) { return getBlkExprNum(S); } 640200fbc877d50da9e53b9aa272b70ca3538ce3a66Ted Kremenek bool isBlkExpr(const Stmt *S) const { 641200fbc877d50da9e53b9aa272b70ca3538ce3a66Ted Kremenek return const_cast<CFG*>(this)->isBlkExpr(S); 642200fbc877d50da9e53b9aa272b70ca3538ce3a66Ted Kremenek } 64386946745225096243f6969dc745267b78fc211a6Ted Kremenek BlkExprNumTy getBlkExprNum(const Stmt* S); 64463f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek unsigned getNumBlkExprs(); 6451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 6460c8c5365be0176e8399e97d7da3293c79bc9da24Mike Stump /// getNumBlockIDs - Returns the total number of BlockIDs allocated (which 6470c8c5365be0176e8399e97d7da3293c79bc9da24Mike Stump /// start at 0). 6489438252ad2ecae5338df565ca33c6969e4fbfa41Ted Kremenek unsigned getNumBlockIDs() const { return NumBlockIDs; } 649a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek 650a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek //===--------------------------------------------------------------------===// 651a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek // CFG Debugging: Pretty-Printing and Visualization. 652a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek //===--------------------------------------------------------------------===// 653a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek 654e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner void viewCFG(const LangOptions &LO) const; 6558cc488fefb2fb04bc8d5398da29f0182f97934cfChris Lattner void print(raw_ostream& OS, const LangOptions &LO) const; 656e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner void dump(const LangOptions &LO) const; 657a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek 658a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek //===--------------------------------------------------------------------===// 659a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek // Internal: constructors and data. 660a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek //===--------------------------------------------------------------------===// 661a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek 6621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump CFG() : Entry(NULL), Exit(NULL), IndirectGotoBlock(NULL), NumBlockIDs(0), 6637177dee8aee4b432911c91f1b788963bec0cac9fDaniel Dunbar BlkExprMap(NULL), Blocks(BlkBVC, 10) {} 6641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 66563f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek ~CFG(); 6661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 667ce1eb34bbea1e0408f1952776d7d52ccde1bd275Ted Kremenek llvm::BumpPtrAllocator& getAllocator() { 668ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek return BlkBVC.getAllocator(); 669ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek } 670ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek 671ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek BumpVectorContext &getBumpVectorContext() { 672ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek return BlkBVC; 673ce1eb34bbea1e0408f1952776d7d52ccde1bd275Ted Kremenek } 6741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 675a36c6540346266f570b2fc7457950dea45d89988Ted Kremenekprivate: 676a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek CFGBlock* Entry; 677a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek CFGBlock* Exit; 678a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek CFGBlock* IndirectGotoBlock; // Special block to contain collective dispatch 679ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek // for indirect gotos 68063f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek unsigned NumBlockIDs; 6811eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 68286d1777a6b7723865c1e67a7aafc797ec0a574ffTed Kremenek // BlkExprMap - An opaque pointer to prevent inclusion of DenseMap.h. 6831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // It represents a map from Expr* to integers to record the set of 68486d1777a6b7723865c1e67a7aafc797ec0a574ffTed Kremenek // block-level expressions and their "statement number" in the CFG. 68563f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek void* BlkExprMap; 686ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek 687ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek BumpVectorContext BlkBVC; 688ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek 689ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek CFGBlockListTy Blocks; 6901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 691fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek}; 692fa2be43dbd6fdc4414e261db69aaf35dfb21a416Ted Kremenek} // end namespace clang 6937dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 6947dba8607e59096014b7139ff20ef00870041d518Ted Kremenek//===----------------------------------------------------------------------===// 6957dba8607e59096014b7139ff20ef00870041d518Ted Kremenek// GraphTraits specializations for CFG basic block graphs (source-level CFGs) 6967dba8607e59096014b7139ff20ef00870041d518Ted Kremenek//===----------------------------------------------------------------------===// 6977dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 6987dba8607e59096014b7139ff20ef00870041d518Ted Kremeneknamespace llvm { 6997dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 7004ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski/// Implement simplify_type for CFGTerminator, so that we can dyn_cast from 7014ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski/// CFGTerminator to a specific Stmt class. 7024ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderskitemplate <> struct simplify_type<const ::clang::CFGTerminator> { 7034ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski typedef const ::clang::Stmt *SimpleType; 7044ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski static SimpleType getSimplifiedValue(const ::clang::CFGTerminator &Val) { 7054ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski return Val.getStmt(); 7064ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski } 7074ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski}; 7084ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski 7094ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderskitemplate <> struct simplify_type< ::clang::CFGTerminator> { 7104ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski typedef ::clang::Stmt *SimpleType; 7114ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski static SimpleType getSimplifiedValue(const ::clang::CFGTerminator &Val) { 7124ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski return const_cast<SimpleType>(Val.getStmt()); 7134ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski } 7144ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski}; 7154ba72a0b28135209c435630682febe1f854ccfa6Marcin Swiderski 7167dba8607e59096014b7139ff20ef00870041d518Ted Kremenek// Traits for: CFGBlock 7177dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 718852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenektemplate <> struct GraphTraits< ::clang::CFGBlock* > { 719852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek typedef ::clang::CFGBlock NodeType; 720852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek typedef ::clang::CFGBlock::succ_iterator ChildIteratorType; 7211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 722852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static NodeType* getEntryNode(::clang::CFGBlock* BB) 7237dba8607e59096014b7139ff20ef00870041d518Ted Kremenek { return BB; } 7247dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 7257dba8607e59096014b7139ff20ef00870041d518Ted Kremenek static inline ChildIteratorType child_begin(NodeType* N) 7267dba8607e59096014b7139ff20ef00870041d518Ted Kremenek { return N->succ_begin(); } 7271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7287dba8607e59096014b7139ff20ef00870041d518Ted Kremenek static inline ChildIteratorType child_end(NodeType* N) 7297dba8607e59096014b7139ff20ef00870041d518Ted Kremenek { return N->succ_end(); } 7307dba8607e59096014b7139ff20ef00870041d518Ted Kremenek}; 7317dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 732852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenektemplate <> struct GraphTraits< const ::clang::CFGBlock* > { 733852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek typedef const ::clang::CFGBlock NodeType; 734852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek typedef ::clang::CFGBlock::const_succ_iterator ChildIteratorType; 7351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7367dba8607e59096014b7139ff20ef00870041d518Ted Kremenek static NodeType* getEntryNode(const clang::CFGBlock* BB) 7377dba8607e59096014b7139ff20ef00870041d518Ted Kremenek { return BB; } 7381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7397dba8607e59096014b7139ff20ef00870041d518Ted Kremenek static inline ChildIteratorType child_begin(NodeType* N) 7407dba8607e59096014b7139ff20ef00870041d518Ted Kremenek { return N->succ_begin(); } 7411eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7427dba8607e59096014b7139ff20ef00870041d518Ted Kremenek static inline ChildIteratorType child_end(NodeType* N) 7437dba8607e59096014b7139ff20ef00870041d518Ted Kremenek { return N->succ_end(); } 7447dba8607e59096014b7139ff20ef00870041d518Ted Kremenek}; 7457dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 746852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenektemplate <> struct GraphTraits<Inverse<const ::clang::CFGBlock*> > { 747852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek typedef const ::clang::CFGBlock NodeType; 748852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek typedef ::clang::CFGBlock::const_pred_iterator ChildIteratorType; 7497dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 750852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static NodeType *getEntryNode(Inverse<const ::clang::CFGBlock*> G) 7517dba8607e59096014b7139ff20ef00870041d518Ted Kremenek { return G.Graph; } 7527dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 7537dba8607e59096014b7139ff20ef00870041d518Ted Kremenek static inline ChildIteratorType child_begin(NodeType* N) 7547dba8607e59096014b7139ff20ef00870041d518Ted Kremenek { return N->pred_begin(); } 7551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 7567dba8607e59096014b7139ff20ef00870041d518Ted Kremenek static inline ChildIteratorType child_end(NodeType* N) 7577dba8607e59096014b7139ff20ef00870041d518Ted Kremenek { return N->pred_end(); } 7587dba8607e59096014b7139ff20ef00870041d518Ted Kremenek}; 7597dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 7607dba8607e59096014b7139ff20ef00870041d518Ted Kremenek// Traits for: CFG 7617dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 762852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenektemplate <> struct GraphTraits< ::clang::CFG* > 763852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek : public GraphTraits< ::clang::CFGBlock* > { 7647dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 765852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek typedef ::clang::CFG::iterator nodes_iterator; 7661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 767852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static NodeType *getEntryNode(::clang::CFG* F) { return &F->getEntry(); } 768852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static nodes_iterator nodes_begin(::clang::CFG* F) { return F->begin(); } 769852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static nodes_iterator nodes_end(::clang::CFG* F) { return F->end(); } 7707dba8607e59096014b7139ff20ef00870041d518Ted Kremenek}; 7717dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 772852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenektemplate <> struct GraphTraits<const ::clang::CFG* > 773852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek : public GraphTraits<const ::clang::CFGBlock* > { 7747dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 775852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek typedef ::clang::CFG::const_iterator nodes_iterator; 7767dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 777852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static NodeType *getEntryNode( const ::clang::CFG* F) { 778852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek return &F->getEntry(); 779852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek } 780852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static nodes_iterator nodes_begin( const ::clang::CFG* F) { 781852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek return F->begin(); 782852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek } 783852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static nodes_iterator nodes_end( const ::clang::CFG* F) { 784852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek return F->end(); 785852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek } 7867dba8607e59096014b7139ff20ef00870041d518Ted Kremenek}; 7877dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 788852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenektemplate <> struct GraphTraits<Inverse<const ::clang::CFG*> > 789852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek : public GraphTraits<Inverse<const ::clang::CFGBlock*> > { 7907dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 791852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek typedef ::clang::CFG::const_iterator nodes_iterator; 7927dba8607e59096014b7139ff20ef00870041d518Ted Kremenek 793852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static NodeType *getEntryNode(const ::clang::CFG* F) { return &F->getExit(); } 794852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static nodes_iterator nodes_begin(const ::clang::CFG* F) { return F->begin();} 795852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek static nodes_iterator nodes_end(const ::clang::CFG* F) { return F->end(); } 7967dba8607e59096014b7139ff20ef00870041d518Ted Kremenek}; 7977dba8607e59096014b7139ff20ef00870041d518Ted Kremenek} // end llvm namespace 798cd881d534517f09a2fae10445f9b865f49ccc6c8Ted Kremenek#endif 799