CFG.h revision 53de134e7b4686eed40bc031438d8a4560a2cda4
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}
292a4cd498ff9b2b126de3e370b768ab307c221ab8Marcin Swiderski
30fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremeneknamespace clang {
31b978a441c7d8bf59e7fede938e1f3b672573b443Mike Stump  class Decl;
3242a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek  class Stmt;
3363f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek  class Expr;
341cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski  class VarDecl;
351cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski  class CXXBaseOrMemberInitializer;
3642a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek  class CFG;
3742a509f6a4f71bb805cc4abbb26722a34dffdddeTed Kremenek  class PrinterHelper;
38e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner  class LangOptions;
39e5af3ce53ec58995b09381ba645ab2117a46647bMike Stump  class ASTContext;
40e5af3ce53ec58995b09381ba645ab2117a46647bMike Stump
41852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek/// CFGElement - Represents a top-level expression in a basic block.
42852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenekclass CFGElement {
43852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenekpublic:
44b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  enum Kind {
45b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    // main kind
46b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    Statement,
47b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    StatementAsLValue,
48b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    Initializer,
49b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    Dtor,
50b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    // dtor kind
51b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    AutomaticObjectDtor,
52b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    BaseDtor,
53b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    MemberDtor,
54b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    TemporaryDtor,
55b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    DTOR_BEGIN = AutomaticObjectDtor
56b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  };
57b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu
58b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xuprotected:
59b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  // The int bits are used to mark the main kind.
60b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  llvm::PointerIntPair<void *, 2> Data1;
61b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  // The int bits are used to mark the dtor kind.
62b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  llvm::PointerIntPair<void *, 2> Data2;
63b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu
641cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski  CFGElement(void *Ptr, unsigned Int) : Data1(Ptr, Int) {}
651cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski  CFGElement(void *Ptr1, unsigned Int1, void *Ptr2, unsigned Int2)
661cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski      : Data1(Ptr1, Int1), Data2(Ptr2, Int2) {}
671cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski
68b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xupublic:
69b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  CFGElement() {}
70b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu
71b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  Kind getKind() const { return static_cast<Kind>(Data1.getInt()); }
72b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu
73b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  Kind getDtorKind() const {
74b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    assert(getKind() == Dtor);
75b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    return static_cast<Kind>(Data2.getInt() + DTOR_BEGIN);
76b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  }
77b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu
78b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  bool isValid() const { return Data1.getPointer(); }
79b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu
80b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  operator bool() const { return isValid(); }
81b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu
82b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  template<class ElemTy> ElemTy getAs() const {
83b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    if (llvm::isa<ElemTy>(this))
84b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu      return *static_cast<const ElemTy*>(this);
85b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    return ElemTy();
86b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  }
87b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu
88b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  static bool classof(const CFGElement *E) { return true; }
89b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu};
90b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu
91b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xuclass CFGStmt : public CFGElement {
92b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xupublic:
93b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  CFGStmt() {}
94b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  CFGStmt(Stmt *S, bool asLValue) : CFGElement(S, asLValue) {}
95b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu
96b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  Stmt *getStmt() const { return static_cast<Stmt *>(Data1.getPointer()); }
97b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu
98852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  operator Stmt*() const { return getStmt(); }
99b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu
100b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  bool asLValue() const {
101b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    return static_cast<Kind>(Data1.getInt()) == StatementAsLValue;
102b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  }
103b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu
104b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  static bool classof(const CFGElement *E) {
105b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    return E->getKind() == Statement || E->getKind() == StatementAsLValue;
106b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  }
107b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu};
108b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu
1091cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski/// CFGInitializer - Represents C++ base or member initializer from
1101cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski/// constructor's initialization list.
111b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xuclass CFGInitializer : public CFGElement {
112b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xupublic:
1131cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski  CFGInitializer() {}
1141cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski  CFGInitializer(CXXBaseOrMemberInitializer* I)
1151cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski      : CFGElement(I, Initializer) {}
1161cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski
1171cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski  CXXBaseOrMemberInitializer* getInitializer() const {
1181cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski    return static_cast<CXXBaseOrMemberInitializer*>(Data1.getPointer());
1191cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski  }
1201cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski  operator CXXBaseOrMemberInitializer*() const { return getInitializer(); }
1211cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski
122b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  static bool classof(const CFGElement *E) {
123b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    return E->getKind() == Initializer;
124b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  }
125b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu};
126b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu
12753de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski/// CFGImplicitDtor - Represents C++ object destructor implicitly generated
1281cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski/// by compiler on various occasions.
129b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xuclass CFGImplicitDtor : public CFGElement {
1301cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderskiprotected:
1311cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski  CFGImplicitDtor(unsigned K, void* P, void* S)
1321cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski      : CFGElement(P, Dtor, S, K - DTOR_BEGIN) {}
1331cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski
134b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xupublic:
1351cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski  CFGImplicitDtor() {}
1361cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski
137b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  static bool classof(const CFGElement *E) {
138b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    return E->getKind() == Dtor;
139b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  }
140b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu};
141b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu
1421cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski/// CFGAutomaticObjDtor - Represents C++ object destructor implicit generated
1431cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski/// for automatic object or temporary bound to const reference at the point
1441cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski/// of leaving its local scope.
145b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xuclass CFGAutomaticObjDtor: public CFGImplicitDtor {
146b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xupublic:
1471cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski  CFGAutomaticObjDtor() {}
1481cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski  CFGAutomaticObjDtor(VarDecl* VD, Stmt* S)
1491cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski      : CFGImplicitDtor(AutomaticObjectDtor, VD, S) {}
1501cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski
1511cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski  VarDecl* getVarDecl() const {
1521cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski    return static_cast<VarDecl*>(Data1.getPointer());
1531cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski  }
1541cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski
1551cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski  // Get statement end of which triggered the destructor call.
1561cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski  Stmt* getTriggerStmt() const {
1571cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski    return static_cast<Stmt*>(Data2.getPointer());
1581cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski  }
1591cff132e48e0ccc253c34e5a2fb12718bd4e7d2eMarcin Swiderski
160b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  static bool classof(const CFGElement *E) {
161b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    return E->getKind() == Dtor && E->getDtorKind() == AutomaticObjectDtor;
162b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  }
163b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu};
164b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu
165b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xuclass CFGBaseDtor : public CFGImplicitDtor {
166b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xupublic:
167b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  static bool classof(const CFGElement *E) {
168b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    return E->getKind() == Dtor && E->getDtorKind() == BaseDtor;
169b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  }
170b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu};
171b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu
172b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xuclass CFGMemberDtor : public CFGImplicitDtor {
173b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xupublic:
174b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  static bool classof(const CFGElement *E) {
175b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    return E->getKind() == Dtor && E->getDtorKind() == MemberDtor;
176b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  }
177b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu
178b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu};
179b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu
180b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xuclass CFGTemporaryDtor : public CFGImplicitDtor {
181b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xupublic:
182b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  static bool classof(const CFGElement *E) {
183b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    return E->getKind() == Dtor && E->getDtorKind() == TemporaryDtor;
184b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  }
185852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek};
186852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek
187fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// CFGBlock - Represents a single basic block in a source-level CFG.
188fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek///  It consists of:
189fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek///
190fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek///  (1) A set of statements/expressions (which may contain subexpressions).
191fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek///  (2) A "terminator" statement (not in the set of statements).
192fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek///  (3) A list of successors and predecessors.
193fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek///
194fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// Terminator: The terminator represents the type of control-flow that occurs
195fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// at the end of the basic block.  The terminator is a Stmt* referring to an
196fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// AST node that has control-flow: if-statements, breaks, loops, etc.
197fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// If the control-flow is conditional, the condition expression will appear
198fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// within the set of statements in the block (usually the last statement).
199fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek///
200fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// Predecessors: the order in the set of predecessors is arbitrary.
201fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek///
202fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// Successors: the order in the set of successors is NOT arbitrary.  We
203fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek///  currently have the following orderings based on the terminator:
204fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek///
205fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek///     Terminator       Successor Ordering
206fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek///  -----------------------------------------------------
207fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek///       if            Then Block;  Else Block
2089cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek///     ? operator      LHS expression;  RHS expression
2099cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek///     &&, ||          expression that uses result of && or ||, RHS
210fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek///
211fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenekclass CFGBlock {
212b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  class ElementList {
213852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek    typedef BumpVector<CFGElement> ImplTy;
2146c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek    ImplTy Impl;
2156c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek  public:
216b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    ElementList(BumpVectorContext &C) : Impl(C, 4) {}
217ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek
2186c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek    typedef std::reverse_iterator<ImplTy::iterator>       iterator;
2196c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek    typedef std::reverse_iterator<ImplTy::const_iterator> const_iterator;
2206c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek    typedef ImplTy::iterator                              reverse_iterator;
2216c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek    typedef ImplTy::const_iterator                        const_reverse_iterator;
2226c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek
223852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek    void push_back(CFGElement e, BumpVectorContext &C) { Impl.push_back(e, C); }
22453de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski    reverse_iterator insert(reverse_iterator I, size_t Cnt, CFGElement E,
22553de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski        BumpVectorContext& C) {
22653de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski      return Impl.insert(I, Cnt, E, C);
22753de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski    }
22853de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski
229852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek    CFGElement front() const { return Impl.back(); }
230852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek    CFGElement back() const { return Impl.front(); }
2316c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek
2326c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek    iterator begin() { return Impl.rbegin(); }
2336c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek    iterator end() { return Impl.rend(); }
2346c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek    const_iterator begin() const { return Impl.rbegin(); }
2356c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek    const_iterator end() const { return Impl.rend(); }
2366c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek    reverse_iterator rbegin() { return Impl.begin(); }
2376c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek    reverse_iterator rend() { return Impl.end(); }
2386c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek    const_reverse_iterator rbegin() const { return Impl.begin(); }
2396c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek    const_reverse_iterator rend() const { return Impl.end(); }
2406c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek
241852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek   CFGElement operator[](size_t i) const  {
2426c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek     assert(i < Impl.size());
2436c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek     return Impl[Impl.size() - 1 - i];
2446c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek   }
2456c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek
2466c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek    size_t size() const { return Impl.size(); }
2476c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek    bool empty() const { return Impl.empty(); }
2486c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek  };
2496c2497248bc4f7fd8e5fb0a206d20abbf0e16645Ted Kremenek
250fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  /// Stmts - The set of statements in the basic block.
251b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  ElementList Elements;
2529cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek
2539cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek  /// Label - An (optional) label that prefixes the executable
2549cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek  ///  statements in the block.  When this variable is non-NULL, it is
2554c45aa1b00b91847acfb082acfaced3ffa294d1dMike Stump  ///  either an instance of LabelStmt, SwitchCase or CXXCatchStmt.
2563575f84e459033d6427b84b4b795b22c85c4d27dTed Kremenek  Stmt *Label;
2571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
2589cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek  /// Terminator - The terminator for a basic block that
259fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  ///  indicates the type of control-flow that occurs between a block
260fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  ///  and its successors.
2613575f84e459033d6427b84b4b795b22c85c4d27dTed Kremenek  Stmt *Terminator;
2621eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
2633575f84e459033d6427b84b4b795b22c85c4d27dTed Kremenek  /// LoopTarget - Some blocks are used to represent the "loop edge" to
2643575f84e459033d6427b84b4b795b22c85c4d27dTed Kremenek  ///  the start of a loop from within the loop body.  This Stmt* will be
2653575f84e459033d6427b84b4b795b22c85c4d27dTed Kremenek  ///  refer to the loop statement for such blocks (and be null otherwise).
2661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump  const Stmt *LoopTarget;
2671eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
268fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  /// BlockID - A numerical ID assigned to a CFGBlock during construction
269fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  ///   of the CFG.
270fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  unsigned BlockID;
2711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
272fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  /// Predecessors/Successors - Keep track of the predecessor / successor
273fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  /// CFG blocks.
274ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek  typedef BumpVector<CFGBlock*> AdjacentBlocks;
275fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  AdjacentBlocks Preds;
276fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  AdjacentBlocks Succs;
2771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
278fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenekpublic:
279ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek  explicit CFGBlock(unsigned blockid, BumpVectorContext &C)
280b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    : Elements(C), Label(NULL), Terminator(NULL), LoopTarget(NULL),
281ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek      BlockID(blockid), Preds(C, 1), Succs(C, 1) {}
2827177dee8aee4b432911c91f1b788963bec0cac9fDaniel Dunbar  ~CFGBlock() {}
283fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek
284fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  // Statement iterators
285b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  typedef ElementList::iterator                      iterator;
286b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  typedef ElementList::const_iterator                const_iterator;
287b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  typedef ElementList::reverse_iterator              reverse_iterator;
288b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  typedef ElementList::const_reverse_iterator        const_reverse_iterator;
2891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
290b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  CFGElement                 front()       const { return Elements.front();   }
291b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  CFGElement                 back()        const { return Elements.back();    }
2921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
293b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  iterator                   begin()             { return Elements.begin();   }
294b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  iterator                   end()               { return Elements.end();     }
295b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  const_iterator             begin()       const { return Elements.begin();   }
296b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  const_iterator             end()         const { return Elements.end();     }
297fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek
298b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  reverse_iterator           rbegin()            { return Elements.rbegin();  }
299b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  reverse_iterator           rend()              { return Elements.rend();    }
300b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  const_reverse_iterator     rbegin()      const { return Elements.rbegin();  }
301b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  const_reverse_iterator     rend()        const { return Elements.rend();    }
3021eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
303b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  unsigned                   size()        const { return Elements.size();    }
304b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  bool                       empty()       const { return Elements.empty();   }
305be7a7d6f2e5b86807afd08a568863df973baaa38Ted Kremenek
306b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu  CFGElement operator[](size_t i) const  { return Elements[i]; }
3071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
308fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  // CFG iterators
309fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  typedef AdjacentBlocks::iterator                              pred_iterator;
310fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  typedef AdjacentBlocks::const_iterator                  const_pred_iterator;
311fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  typedef AdjacentBlocks::reverse_iterator              pred_reverse_iterator;
312fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  typedef AdjacentBlocks::const_reverse_iterator  const_pred_reverse_iterator;
313fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek
314fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  typedef AdjacentBlocks::iterator                              succ_iterator;
315fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  typedef AdjacentBlocks::const_iterator                  const_succ_iterator;
316fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  typedef AdjacentBlocks::reverse_iterator              succ_reverse_iterator;
317fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  typedef AdjacentBlocks::const_reverse_iterator  const_succ_reverse_iterator;
3181eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
319fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  pred_iterator                pred_begin()        { return Preds.begin();   }
320fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  pred_iterator                pred_end()          { return Preds.end();     }
321fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  const_pred_iterator          pred_begin()  const { return Preds.begin();   }
322fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  const_pred_iterator          pred_end()    const { return Preds.end();     }
3231eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
324fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  pred_reverse_iterator        pred_rbegin()       { return Preds.rbegin();  }
3251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump  pred_reverse_iterator        pred_rend()         { return Preds.rend();    }
326fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  const_pred_reverse_iterator  pred_rbegin() const { return Preds.rbegin();  }
327fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  const_pred_reverse_iterator  pred_rend()   const { return Preds.rend();    }
328fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek
3291eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump  succ_iterator                succ_begin()        { return Succs.begin();   }
330fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  succ_iterator                succ_end()          { return Succs.end();     }
331fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  const_succ_iterator          succ_begin()  const { return Succs.begin();   }
3321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump  const_succ_iterator          succ_end()    const { return Succs.end();     }
3331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
334fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  succ_reverse_iterator        succ_rbegin()       { return Succs.rbegin();  }
335fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  succ_reverse_iterator        succ_rend()         { return Succs.rend();    }
336fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  const_succ_reverse_iterator  succ_rbegin() const { return Succs.rbegin();  }
337fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  const_succ_reverse_iterator  succ_rend()   const { return Succs.rend();    }
338fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek
339fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  unsigned                     succ_size()   const { return Succs.size();    }
340fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  bool                         succ_empty()  const { return Succs.empty();   }
341fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek
342fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  unsigned                     pred_size()   const { return Preds.size();    }
343fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  bool                         pred_empty()  const { return Preds.empty();   }
3441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
345ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek
346ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek  class FilterOptions {
347ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek  public:
348ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek    FilterOptions() {
349ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek      IgnoreDefaultsWithCoveredEnums = 0;
350be39a566a914df8561d7a1e9654708297f0908c1Ted Kremenek    }
351ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek
352ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek    unsigned IgnoreDefaultsWithCoveredEnums : 1;
353ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek  };
354ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek
355ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek  static bool FilterEdge(const FilterOptions &F, const CFGBlock *Src,
356be39a566a914df8561d7a1e9654708297f0908c1Ted Kremenek       const CFGBlock *Dst);
357ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek
358ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek  template <typename IMPL, bool IsPred>
359ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek  class FilteredCFGBlockIterator {
360ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek  private:
361ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek    IMPL I, E;
362ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek    const FilterOptions F;
363ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek    const CFGBlock *From;
364ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek   public:
365ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek    explicit FilteredCFGBlockIterator(const IMPL &i, const IMPL &e,
366be39a566a914df8561d7a1e9654708297f0908c1Ted Kremenek              const CFGBlock *from,
367be39a566a914df8561d7a1e9654708297f0908c1Ted Kremenek              const FilterOptions &f)
368ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek      : I(i), E(e), F(f), From(from) {}
369ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek
370ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek    bool hasMore() const { return I != E; }
371ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek
372ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek    FilteredCFGBlockIterator &operator++() {
373ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek      do { ++I; } while (hasMore() && Filter(*I));
374ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek      return *this;
375ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek    }
376ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek
377ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek    const CFGBlock *operator*() const { return *I; }
378ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek  private:
379ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek    bool Filter(const CFGBlock *To) {
380ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek      return IsPred ? FilterEdge(F, To, From) : FilterEdge(F, From, To);
381ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek    }
382ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek  };
383ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek
384ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek  typedef FilteredCFGBlockIterator<const_pred_iterator, true>
385ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek          filtered_pred_iterator;
386ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek
387ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek  typedef FilteredCFGBlockIterator<const_succ_iterator, false>
388ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek          filtered_succ_iterator;
389ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek
390ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek  filtered_pred_iterator filtered_pred_start_end(const FilterOptions &f) const {
391ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek    return filtered_pred_iterator(pred_begin(), pred_end(), this, f);
392ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek  }
393ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek
394ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek  filtered_succ_iterator filtered_succ_start_end(const FilterOptions &f) const {
395ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek    return filtered_succ_iterator(succ_begin(), succ_end(), this, f);
396ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek  }
397ee7f84d509c6382491673883598eb9ed2d3a6a8bTed Kremenek
398fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  // Manipulation of block contents
3991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
4009cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek  void setTerminator(Stmt* Statement) { Terminator = Statement; }
4019cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek  void setLabel(Stmt* Statement) { Label = Statement; }
4023575f84e459033d6427b84b4b795b22c85c4d27dTed Kremenek  void setLoopTarget(const Stmt *loopTarget) { LoopTarget = loopTarget; }
4039cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek
4049cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek  Stmt* getTerminator() { return Terminator; }
4059cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek  const Stmt* getTerminator() const { return Terminator; }
4061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
407390e48b15ad93f85bfd1e33b9992c198fa0db475Ted Kremenek  Stmt* getTerminatorCondition();
4081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
409390e48b15ad93f85bfd1e33b9992c198fa0db475Ted Kremenek  const Stmt* getTerminatorCondition() const {
410411cdee0b490f79428c9eb977f25199eb7d21cd8Ted Kremenek    return const_cast<CFGBlock*>(this)->getTerminatorCondition();
411411cdee0b490f79428c9eb977f25199eb7d21cd8Ted Kremenek  }
4121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
4133575f84e459033d6427b84b4b795b22c85c4d27dTed Kremenek  const Stmt *getLoopTarget() const { return LoopTarget; }
4141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
4159c2535a35db35b3a821a0d0c36a01a16f52f1ad0Ted Kremenek  bool hasBinaryBranchTerminator() const;
4161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
4179cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek  Stmt* getLabel() { return Label; }
4189cffe7366ea3beb33c2d58f43a8c3a04c1873e11Ted Kremenek  const Stmt* getLabel() const { return Label; }
4191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
420fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek  unsigned getBlockID() const { return BlockID; }
4211eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
422e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner  void dump(const CFG *cfg, const LangOptions &LO) const;
423e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner  void print(llvm::raw_ostream &OS, const CFG* cfg, const LangOptions &LO) const;
424e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner  void printTerminator(llvm::raw_ostream &OS, const LangOptions &LO) const;
425ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek
426ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek  void addSuccessor(CFGBlock* Block, BumpVectorContext &C) {
427ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek    if (Block)
428ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek      Block->Preds.push_back(this, C);
429ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek    Succs.push_back(Block, C);
430ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek  }
431ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek
432852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  void appendStmt(Stmt* Statement, BumpVectorContext &C, bool asLValue) {
433b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu    Elements.push_back(CFGStmt(Statement, asLValue), C);
434079bd72439448b78629a28da6b1f8abe2cdeaf4dMike Stump  }
43553de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski
43653de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski  // Destructors must be inserted in reversed order. So insertion is in two
43753de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski  // steps. First we prepare space for some number of elements, then we insert
43853de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski  // the elements beginning at the last position in prepared space.
43953de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski  iterator beginAutomaticObjDtorsInsert(iterator I, size_t Cnt,
44053de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski      BumpVectorContext& C) {
44153de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski    return iterator(Elements.insert(I.base(), Cnt, CFGElement(), C));
44253de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski  }
44353de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski  iterator insertAutomaticObjDtor(iterator I, VarDecl* VD, Stmt* S) {
44453de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski    *I = CFGAutomaticObjDtor(VD, S);
44553de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski    return ++I;
44653de134e7b4686eed40bc031438d8a4560a2cda4Marcin Swiderski  }
447fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek};
4481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
449fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek/// CFG - Represents a source-level, intra-procedural CFG that represents the
450fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek///  control-flow of a Stmt.  The Stmt can represent an entire function body,
451fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek///  or a single expression.  A CFG will always contain one empty block that
452fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek///  represents the Exit point of the CFG.  A CFG will also contain a designated
453fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek///  Entry block.  The CFG solely represents control-flow; it consists of
454fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek///  CFGBlocks which are simply containers of Stmt*'s in the AST the CFG
455fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek///  was constructed from.
456fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenekclass CFG {
457fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenekpublic:
458a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  //===--------------------------------------------------------------------===//
459a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  // CFG Construction & Manipulation.
460a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  //===--------------------------------------------------------------------===//
461a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek
4626c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek  class BuildOptions {
4636c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek  public:
4646c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek    bool PruneTriviallyFalseEdges:1;
4656c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek    bool AddEHEdges:1;
4666c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek    bool AddInitializers:1;
4676c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek    bool AddImplicitDtors:1;
4686c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek
4696c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek    BuildOptions()
4706c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek        : PruneTriviallyFalseEdges(true)
4716c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek        , AddEHEdges(false)
4726c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek        , AddInitializers(false)
4736c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek        , AddImplicitDtors(false) {}
4746c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek  };
4756c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek
476a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  /// buildCFG - Builds a CFG from an AST.  The responsibility to free the
4771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump  ///   constructed CFG belongs to the caller.
478b978a441c7d8bf59e7fede938e1f3b672573b443Mike Stump  static CFG* buildCFG(const Decl *D, Stmt* AST, ASTContext *C,
4796c52c7850bccb6991470668429a1e1edf01b0873Ted Kremenek      BuildOptions BO = BuildOptions());
4801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
481a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  /// createBlock - Create a new block in the CFG.  The CFG owns the block;
482a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  ///  the caller should not directly free it.
483a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  CFGBlock* createBlock();
4841eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
485a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  /// setEntry - Set the entry block of the CFG.  This is typically used
486a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  ///  only during CFG construction.  Most CFG clients expect that the
487a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  ///  entry block has no predecessors and contains no statements.
488a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  void setEntry(CFGBlock *B) { Entry = B; }
4891eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
490e38158de9236dfcded7da56126134e5e3e49cb01Ted Kremenek  /// setIndirectGotoBlock - Set the block used for indirect goto jumps.
491e38158de9236dfcded7da56126134e5e3e49cb01Ted Kremenek  ///  This is typically used only during CFG construction.
492a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  void setIndirectGotoBlock(CFGBlock* B) { IndirectGotoBlock = B; }
4931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
494a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  //===--------------------------------------------------------------------===//
495a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  // Block Iterators
496a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  //===--------------------------------------------------------------------===//
497a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek
498ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek  typedef BumpVector<CFGBlock*>                    CFGBlockListTy;
499a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  typedef CFGBlockListTy::iterator                 iterator;
500a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  typedef CFGBlockListTy::const_iterator           const_iterator;
501a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  typedef std::reverse_iterator<iterator>          reverse_iterator;
502a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  typedef std::reverse_iterator<const_iterator>    const_reverse_iterator;
503fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek
504ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek  CFGBlock&                 front()                { return *Blocks.front(); }
505ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek  CFGBlock&                 back()                 { return *Blocks.back(); }
5061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
50719bb356317952445b03ee341c02f6147083c9eeaTed Kremenek  iterator                  begin()                { return Blocks.begin(); }
50819bb356317952445b03ee341c02f6147083c9eeaTed Kremenek  iterator                  end()                  { return Blocks.end(); }
50919bb356317952445b03ee341c02f6147083c9eeaTed Kremenek  const_iterator            begin()       const    { return Blocks.begin(); }
5101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump  const_iterator            end()         const    { return Blocks.end(); }
5111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
51219bb356317952445b03ee341c02f6147083c9eeaTed Kremenek  reverse_iterator          rbegin()               { return Blocks.rbegin(); }
51319bb356317952445b03ee341c02f6147083c9eeaTed Kremenek  reverse_iterator          rend()                 { return Blocks.rend(); }
51419bb356317952445b03ee341c02f6147083c9eeaTed Kremenek  const_reverse_iterator    rbegin()      const    { return Blocks.rbegin(); }
51519bb356317952445b03ee341c02f6147083c9eeaTed Kremenek  const_reverse_iterator    rend()        const    { return Blocks.rend(); }
5161eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
51719bb356317952445b03ee341c02f6147083c9eeaTed Kremenek  CFGBlock&                 getEntry()             { return *Entry; }
5187dba8607e59096014b7139ff20ef00870041d518Ted Kremenek  const CFGBlock&           getEntry()    const    { return *Entry; }
51919bb356317952445b03ee341c02f6147083c9eeaTed Kremenek  CFGBlock&                 getExit()              { return *Exit; }
5207dba8607e59096014b7139ff20ef00870041d518Ted Kremenek  const CFGBlock&           getExit()     const    { return *Exit; }
5217dba8607e59096014b7139ff20ef00870041d518Ted Kremenek
5227dba8607e59096014b7139ff20ef00870041d518Ted Kremenek  CFGBlock*        getIndirectGotoBlock() { return IndirectGotoBlock; }
5237dba8607e59096014b7139ff20ef00870041d518Ted Kremenek  const CFGBlock*  getIndirectGotoBlock() const { return IndirectGotoBlock; }
5241eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
525a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  //===--------------------------------------------------------------------===//
526a90b0d1e585d993621a342d0b2874e61941372d5Ted Kremenek  // Member templates useful for various batch operations over CFGs.
527a90b0d1e585d993621a342d0b2874e61941372d5Ted Kremenek  //===--------------------------------------------------------------------===//
5281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
529a90b0d1e585d993621a342d0b2874e61941372d5Ted Kremenek  template <typename CALLBACK>
530a90b0d1e585d993621a342d0b2874e61941372d5Ted Kremenek  void VisitBlockStmts(CALLBACK& O) const {
531a90b0d1e585d993621a342d0b2874e61941372d5Ted Kremenek    for (const_iterator I=begin(), E=end(); I != E; ++I)
532ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek      for (CFGBlock::const_iterator BI=(*I)->begin(), BE=(*I)->end();
533b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu           BI != BE; ++BI) {
534b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu        if (CFGStmt S = BI->getAs<CFGStmt>())
535b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu          O(S);
536b36cd3e1757fb4fcd9509f35558c847b04bef35fZhongxing Xu      }
5371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump  }
5381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
539a90b0d1e585d993621a342d0b2874e61941372d5Ted Kremenek  //===--------------------------------------------------------------------===//
540a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  // CFG Introspection.
541a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  //===--------------------------------------------------------------------===//
542a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek
54363f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek  struct   BlkExprNumTy {
54463f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek    const signed Idx;
54563f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek    explicit BlkExprNumTy(signed idx) : Idx(idx) {}
54663f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek    explicit BlkExprNumTy() : Idx(-1) {}
54763f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek    operator bool() const { return Idx >= 0; }
54863f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek    operator unsigned() const { assert(Idx >=0); return (unsigned) Idx; }
54963f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek  };
5501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
55186946745225096243f6969dc745267b78fc211a6Ted Kremenek  bool          isBlkExpr(const Stmt* S) { return getBlkExprNum(S); }
55286946745225096243f6969dc745267b78fc211a6Ted Kremenek  BlkExprNumTy  getBlkExprNum(const Stmt* S);
55363f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek  unsigned      getNumBlkExprs();
5541eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
5550c8c5365be0176e8399e97d7da3293c79bc9da24Mike Stump  /// getNumBlockIDs - Returns the total number of BlockIDs allocated (which
5560c8c5365be0176e8399e97d7da3293c79bc9da24Mike Stump  /// start at 0).
5579438252ad2ecae5338df565ca33c6969e4fbfa41Ted Kremenek  unsigned getNumBlockIDs() const { return NumBlockIDs; }
558a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek
559a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  //===--------------------------------------------------------------------===//
560a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  // CFG Debugging: Pretty-Printing and Visualization.
561a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  //===--------------------------------------------------------------------===//
562a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek
563e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner  void viewCFG(const LangOptions &LO) const;
564e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner  void print(llvm::raw_ostream& OS, const LangOptions &LO) const;
565e4f2142d00fa5fdb580c4e2413da91882d955381Chris Lattner  void dump(const LangOptions &LO) const;
566a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek
567a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  //===--------------------------------------------------------------------===//
568a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  // Internal: constructors and data.
569a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  //===--------------------------------------------------------------------===//
570a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek
5711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump  CFG() : Entry(NULL), Exit(NULL), IndirectGotoBlock(NULL), NumBlockIDs(0),
5727177dee8aee4b432911c91f1b788963bec0cac9fDaniel Dunbar          BlkExprMap(NULL), Blocks(BlkBVC, 10) {}
5731eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
57463f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek  ~CFG();
5751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
576ce1eb34bbea1e0408f1952776d7d52ccde1bd275Ted Kremenek  llvm::BumpPtrAllocator& getAllocator() {
577ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek    return BlkBVC.getAllocator();
578ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek  }
579ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek
580ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek  BumpVectorContext &getBumpVectorContext() {
581ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek    return BlkBVC;
582ce1eb34bbea1e0408f1952776d7d52ccde1bd275Ted Kremenek  }
5831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
584a36c6540346266f570b2fc7457950dea45d89988Ted Kremenekprivate:
585a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  CFGBlock* Entry;
586a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  CFGBlock* Exit;
587a36c6540346266f570b2fc7457950dea45d89988Ted Kremenek  CFGBlock* IndirectGotoBlock;  // Special block to contain collective dispatch
588ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek                                // for indirect gotos
58963f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek  unsigned  NumBlockIDs;
5901eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
59186d1777a6b7723865c1e67a7aafc797ec0a574ffTed Kremenek  // BlkExprMap - An opaque pointer to prevent inclusion of DenseMap.h.
5921eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump  //  It represents a map from Expr* to integers to record the set of
59386d1777a6b7723865c1e67a7aafc797ec0a574ffTed Kremenek  //  block-level expressions and their "statement number" in the CFG.
59463f5887f316fb52d243fcbb3631c039de6c4b993Ted Kremenek  void*     BlkExprMap;
595ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek
596ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek  BumpVectorContext BlkBVC;
597ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek
598ee82d9bdc5025b82de8ce2a4ad4685e0a8b79da9Ted Kremenek  CFGBlockListTy Blocks;
5991eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
600fddd51853f8ccaa1df2476376e6fd74d2f315c73Ted Kremenek};
601fa2be43dbd6fdc4414e261db69aaf35dfb21a416Ted Kremenek} // end namespace clang
6027dba8607e59096014b7139ff20ef00870041d518Ted Kremenek
6037dba8607e59096014b7139ff20ef00870041d518Ted Kremenek//===----------------------------------------------------------------------===//
6047dba8607e59096014b7139ff20ef00870041d518Ted Kremenek// GraphTraits specializations for CFG basic block graphs (source-level CFGs)
6057dba8607e59096014b7139ff20ef00870041d518Ted Kremenek//===----------------------------------------------------------------------===//
6067dba8607e59096014b7139ff20ef00870041d518Ted Kremenek
6077dba8607e59096014b7139ff20ef00870041d518Ted Kremeneknamespace llvm {
6087dba8607e59096014b7139ff20ef00870041d518Ted Kremenek
6097dba8607e59096014b7139ff20ef00870041d518Ted Kremenek// Traits for: CFGBlock
6107dba8607e59096014b7139ff20ef00870041d518Ted Kremenek
611852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenektemplate <> struct GraphTraits< ::clang::CFGBlock* > {
612852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  typedef ::clang::CFGBlock NodeType;
613852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  typedef ::clang::CFGBlock::succ_iterator ChildIteratorType;
6141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
615852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  static NodeType* getEntryNode(::clang::CFGBlock* BB)
6167dba8607e59096014b7139ff20ef00870041d518Ted Kremenek  { return BB; }
6177dba8607e59096014b7139ff20ef00870041d518Ted Kremenek
6187dba8607e59096014b7139ff20ef00870041d518Ted Kremenek  static inline ChildIteratorType child_begin(NodeType* N)
6197dba8607e59096014b7139ff20ef00870041d518Ted Kremenek  { return N->succ_begin(); }
6201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
6217dba8607e59096014b7139ff20ef00870041d518Ted Kremenek  static inline ChildIteratorType child_end(NodeType* N)
6227dba8607e59096014b7139ff20ef00870041d518Ted Kremenek  { return N->succ_end(); }
6237dba8607e59096014b7139ff20ef00870041d518Ted Kremenek};
6247dba8607e59096014b7139ff20ef00870041d518Ted Kremenek
625852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenektemplate <> struct GraphTraits< const ::clang::CFGBlock* > {
626852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  typedef const ::clang::CFGBlock NodeType;
627852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  typedef ::clang::CFGBlock::const_succ_iterator ChildIteratorType;
6281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
6297dba8607e59096014b7139ff20ef00870041d518Ted Kremenek  static NodeType* getEntryNode(const clang::CFGBlock* BB)
6307dba8607e59096014b7139ff20ef00870041d518Ted Kremenek  { return BB; }
6311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
6327dba8607e59096014b7139ff20ef00870041d518Ted Kremenek  static inline ChildIteratorType child_begin(NodeType* N)
6337dba8607e59096014b7139ff20ef00870041d518Ted Kremenek  { return N->succ_begin(); }
6341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
6357dba8607e59096014b7139ff20ef00870041d518Ted Kremenek  static inline ChildIteratorType child_end(NodeType* N)
6367dba8607e59096014b7139ff20ef00870041d518Ted Kremenek  { return N->succ_end(); }
6377dba8607e59096014b7139ff20ef00870041d518Ted Kremenek};
6387dba8607e59096014b7139ff20ef00870041d518Ted Kremenek
639852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenektemplate <> struct GraphTraits<Inverse<const ::clang::CFGBlock*> > {
640852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  typedef const ::clang::CFGBlock NodeType;
641852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  typedef ::clang::CFGBlock::const_pred_iterator ChildIteratorType;
6427dba8607e59096014b7139ff20ef00870041d518Ted Kremenek
643852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  static NodeType *getEntryNode(Inverse<const ::clang::CFGBlock*> G)
6447dba8607e59096014b7139ff20ef00870041d518Ted Kremenek  { return G.Graph; }
6457dba8607e59096014b7139ff20ef00870041d518Ted Kremenek
6467dba8607e59096014b7139ff20ef00870041d518Ted Kremenek  static inline ChildIteratorType child_begin(NodeType* N)
6477dba8607e59096014b7139ff20ef00870041d518Ted Kremenek  { return N->pred_begin(); }
6481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
6497dba8607e59096014b7139ff20ef00870041d518Ted Kremenek  static inline ChildIteratorType child_end(NodeType* N)
6507dba8607e59096014b7139ff20ef00870041d518Ted Kremenek  { return N->pred_end(); }
6517dba8607e59096014b7139ff20ef00870041d518Ted Kremenek};
6527dba8607e59096014b7139ff20ef00870041d518Ted Kremenek
6537dba8607e59096014b7139ff20ef00870041d518Ted Kremenek// Traits for: CFG
6547dba8607e59096014b7139ff20ef00870041d518Ted Kremenek
655852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenektemplate <> struct GraphTraits< ::clang::CFG* >
656852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek    : public GraphTraits< ::clang::CFGBlock* >  {
6577dba8607e59096014b7139ff20ef00870041d518Ted Kremenek
658852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  typedef ::clang::CFG::iterator nodes_iterator;
6591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
660852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  static NodeType *getEntryNode(::clang::CFG* F) { return &F->getEntry(); }
661852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  static nodes_iterator nodes_begin(::clang::CFG* F) { return F->begin(); }
662852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  static nodes_iterator nodes_end(::clang::CFG* F) { return F->end(); }
6637dba8607e59096014b7139ff20ef00870041d518Ted Kremenek};
6647dba8607e59096014b7139ff20ef00870041d518Ted Kremenek
665852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenektemplate <> struct GraphTraits<const ::clang::CFG* >
666852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek    : public GraphTraits<const ::clang::CFGBlock* >  {
6677dba8607e59096014b7139ff20ef00870041d518Ted Kremenek
668852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  typedef ::clang::CFG::const_iterator nodes_iterator;
6697dba8607e59096014b7139ff20ef00870041d518Ted Kremenek
670852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  static NodeType *getEntryNode( const ::clang::CFG* F) {
671852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek    return &F->getEntry();
672852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  }
673852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  static nodes_iterator nodes_begin( const ::clang::CFG* F) {
674852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek    return F->begin();
675852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  }
676852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  static nodes_iterator nodes_end( const ::clang::CFG* F) {
677852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek    return F->end();
678852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  }
6797dba8607e59096014b7139ff20ef00870041d518Ted Kremenek};
6807dba8607e59096014b7139ff20ef00870041d518Ted Kremenek
681852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenektemplate <> struct GraphTraits<Inverse<const ::clang::CFG*> >
682852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  : public GraphTraits<Inverse<const ::clang::CFGBlock*> > {
6837dba8607e59096014b7139ff20ef00870041d518Ted Kremenek
684852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  typedef ::clang::CFG::const_iterator nodes_iterator;
6857dba8607e59096014b7139ff20ef00870041d518Ted Kremenek
686852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  static NodeType *getEntryNode(const ::clang::CFG* F) { return &F->getExit(); }
687852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  static nodes_iterator nodes_begin(const ::clang::CFG* F) { return F->begin();}
688852274d4257134906995cb252fb3dfd2d71deae8Ted Kremenek  static nodes_iterator nodes_end(const ::clang::CFG* F) { return F->end(); }
6897dba8607e59096014b7139ff20ef00870041d518Ted Kremenek};
6907dba8607e59096014b7139ff20ef00870041d518Ted Kremenek} // end llvm namespace
691cd881d534517f09a2fae10445f9b865f49ccc6c8Ted Kremenek#endif
692