blob: 9d11fcdbc7857ae65a83462c55bed6818eb4af19 [file] [log] [blame]
Eugene Zelenko38c70522017-12-07 21:55:09 +00001//===- CFG.cpp - Classes for representing and building CFGs ---------------===//
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00007//
8//===----------------------------------------------------------------------===//
9//
10// This file defines the CFG and CFGBuilder classes for representing and
11// building Control-Flow Graphs (CFGs) from ASTs.
12//
13//===----------------------------------------------------------------------===//
14
Ted Kremenek6796fbd2009-07-16 18:13:04 +000015#include "clang/Analysis/CFG.h"
Benjamin Kramer1ea8e092012-07-04 17:04:04 +000016#include "clang/AST/ASTContext.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000017#include "clang/AST/Attr.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000018#include "clang/AST/Decl.h"
19#include "clang/AST/DeclBase.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000020#include "clang/AST/DeclCXX.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000021#include "clang/AST/DeclGroup.h"
22#include "clang/AST/Expr.h"
23#include "clang/AST/ExprCXX.h"
24#include "clang/AST/OperationKinds.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000025#include "clang/AST/PrettyPrinter.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000026#include "clang/AST/Stmt.h"
27#include "clang/AST/StmtCXX.h"
28#include "clang/AST/StmtObjC.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000029#include "clang/AST/StmtVisitor.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000030#include "clang/AST/Type.h"
31#include "clang/Analysis/Support/BumpVector.h"
Artem Dergachev40684812018-02-27 20:03:35 +000032#include "clang/Analysis/ConstructionContext.h"
Jordan Rose5374c072013-08-19 16:27:28 +000033#include "clang/Basic/Builtins.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000034#include "clang/Basic/ExceptionSpecificationType.h"
35#include "clang/Basic/LLVM.h"
36#include "clang/Basic/LangOptions.h"
37#include "clang/Basic/SourceLocation.h"
38#include "clang/Basic/Specifiers.h"
39#include "llvm/ADT/APInt.h"
40#include "llvm/ADT/APSInt.h"
41#include "llvm/ADT/ArrayRef.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000042#include "llvm/ADT/DenseMap.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000043#include "llvm/ADT/Optional.h"
44#include "llvm/ADT/STLExtras.h"
45#include "llvm/ADT/SetVector.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000046#include "llvm/ADT/SmallPtrSet.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000047#include "llvm/ADT/SmallVector.h"
Benjamin Kramer89b422c2009-08-23 12:08:50 +000048#include "llvm/Support/Allocator.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000049#include "llvm/Support/Casting.h"
50#include "llvm/Support/Compiler.h"
51#include "llvm/Support/DOTGraphTraits.h"
52#include "llvm/Support/ErrorHandling.h"
Benjamin Kramer89b422c2009-08-23 12:08:50 +000053#include "llvm/Support/Format.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000054#include "llvm/Support/GraphWriter.h"
55#include "llvm/Support/SaveAndRestore.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000056#include "llvm/Support/raw_ostream.h"
57#include <cassert>
58#include <memory>
59#include <string>
60#include <tuple>
61#include <utility>
62#include <vector>
Ted Kremeneke5ccf9a2008-01-11 00:40:29 +000063
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +000064using namespace clang;
65
Ted Kremenek5ef32db2011-08-12 23:37:29 +000066static SourceLocation GetEndLoc(Decl *D) {
67 if (VarDecl *VD = dyn_cast<VarDecl>(D))
68 if (Expr *Ex = VD->getInit())
Ted Kremenek8889bb32008-08-06 23:20:50 +000069 return Ex->getSourceRange().getEnd();
Mike Stump31feda52009-07-17 01:31:16 +000070 return D->getLocation();
Ted Kremenek8889bb32008-08-06 23:20:50 +000071}
Ted Kremenekdc03bd02010-08-02 23:46:59 +000072
George Burgess IVced56e62015-10-01 18:47:52 +000073/// Helper for tryNormalizeBinaryOperator. Attempts to extract an IntegerLiteral
74/// or EnumConstantDecl from the given Expr. If it fails, returns nullptr.
Eugene Zelenko38c70522017-12-07 21:55:09 +000075static const Expr *tryTransformToIntOrEnumConstant(const Expr *E) {
George Burgess IVced56e62015-10-01 18:47:52 +000076 E = E->IgnoreParens();
77 if (isa<IntegerLiteral>(E))
78 return E;
79 if (auto *DR = dyn_cast<DeclRefExpr>(E->IgnoreParenImpCasts()))
80 return isa<EnumConstantDecl>(DR->getDecl()) ? DR : nullptr;
81 return nullptr;
82}
83
84/// Tries to interpret a binary operator into `Decl Op Expr` form, if Expr is
85/// an integer literal or an enum constant.
86///
87/// If this fails, at least one of the returned DeclRefExpr or Expr will be
88/// null.
89static std::tuple<const DeclRefExpr *, BinaryOperatorKind, const Expr *>
90tryNormalizeBinaryOperator(const BinaryOperator *B) {
91 BinaryOperatorKind Op = B->getOpcode();
92
93 const Expr *MaybeDecl = B->getLHS();
94 const Expr *Constant = tryTransformToIntOrEnumConstant(B->getRHS());
95 // Expr looked like `0 == Foo` instead of `Foo == 0`
96 if (Constant == nullptr) {
97 // Flip the operator
98 if (Op == BO_GT)
99 Op = BO_LT;
100 else if (Op == BO_GE)
101 Op = BO_LE;
102 else if (Op == BO_LT)
103 Op = BO_GT;
104 else if (Op == BO_LE)
105 Op = BO_GE;
106
107 MaybeDecl = B->getRHS();
108 Constant = tryTransformToIntOrEnumConstant(B->getLHS());
109 }
110
111 auto *D = dyn_cast<DeclRefExpr>(MaybeDecl->IgnoreParenImpCasts());
112 return std::make_tuple(D, Op, Constant);
113}
114
115/// For an expression `x == Foo && x == Bar`, this determines whether the
116/// `Foo` and `Bar` are either of the same enumeration type, or both integer
117/// literals.
118///
119/// It's an error to pass this arguments that are not either IntegerLiterals
120/// or DeclRefExprs (that have decls of type EnumConstantDecl)
121static bool areExprTypesCompatible(const Expr *E1, const Expr *E2) {
122 // User intent isn't clear if they're mixing int literals with enum
123 // constants.
124 if (isa<IntegerLiteral>(E1) != isa<IntegerLiteral>(E2))
125 return false;
126
127 // Integer literal comparisons, regardless of literal type, are acceptable.
128 if (isa<IntegerLiteral>(E1))
129 return true;
130
131 // IntegerLiterals are handled above and only EnumConstantDecls are expected
132 // beyond this point
133 assert(isa<DeclRefExpr>(E1) && isa<DeclRefExpr>(E2));
134 auto *Decl1 = cast<DeclRefExpr>(E1)->getDecl();
135 auto *Decl2 = cast<DeclRefExpr>(E2)->getDecl();
136
137 assert(isa<EnumConstantDecl>(Decl1) && isa<EnumConstantDecl>(Decl2));
138 const DeclContext *DC1 = Decl1->getDeclContext();
139 const DeclContext *DC2 = Decl2->getDeclContext();
140
141 assert(isa<EnumDecl>(DC1) && isa<EnumDecl>(DC2));
142 return DC1 == DC2;
143}
144
Eugene Zelenko38c70522017-12-07 21:55:09 +0000145namespace {
146
Ted Kremenek7c58d352011-03-10 01:14:11 +0000147class CFGBuilder;
148
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000149/// The CFG builder uses a recursive algorithm to build the CFG. When
150/// we process an expression, sometimes we know that we must add the
151/// subexpressions as block-level expressions. For example:
152///
153/// exp1 || exp2
154///
155/// When processing the '||' expression, we know that exp1 and exp2
156/// need to be added as block-level expressions, even though they
157/// might not normally need to be. AddStmtChoice records this
158/// contextual information. If AddStmtChoice is 'NotAlwaysAdd', then
159/// the builder has an option not to add a subexpression as a
160/// block-level expression.
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000161class AddStmtChoice {
162public:
Ted Kremenek8219b822010-12-16 07:46:53 +0000163 enum Kind { NotAlwaysAdd = 0, AlwaysAdd = 1 };
Ted Kremenek5d2bb1b2010-03-02 21:43:54 +0000164
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000165 AddStmtChoice(Kind a_kind = NotAlwaysAdd) : kind(a_kind) {}
Ted Kremenek5d2bb1b2010-03-02 21:43:54 +0000166
Ted Kremenek7c58d352011-03-10 01:14:11 +0000167 bool alwaysAdd(CFGBuilder &builder,
168 const Stmt *stmt) const;
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000169
170 /// Return a copy of this object, except with the 'always-add' bit
171 /// set as specified.
172 AddStmtChoice withAlwaysAdd(bool alwaysAdd) const {
Ted Kremenek7c58d352011-03-10 01:14:11 +0000173 return AddStmtChoice(alwaysAdd ? AlwaysAdd : NotAlwaysAdd);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000174 }
175
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000176private:
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000177 Kind kind;
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000178};
Mike Stump31feda52009-07-17 01:31:16 +0000179
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000180/// LocalScope - Node in tree of local scopes created for C++ implicit
181/// destructor calls generation. It contains list of automatic variables
182/// declared in the scope and link to position in previous scope this scope
183/// began in.
184///
185/// The process of creating local scopes is as follows:
186/// - Init CFGBuilder::ScopePos with invalid position (equivalent for null),
187/// - Before processing statements in scope (e.g. CompoundStmt) create
188/// LocalScope object using CFGBuilder::ScopePos as link to previous scope
189/// and set CFGBuilder::ScopePos to the end of new scope,
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000190/// - On every occurrence of VarDecl increase CFGBuilder::ScopePos if it points
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000191/// at this VarDecl,
192/// - For every normal (without jump) end of scope add to CFGBlock destructors
193/// for objects in the current scope,
194/// - For every jump add to CFGBlock destructors for objects
195/// between CFGBuilder::ScopePos and local scope position saved for jump
196/// target. Thanks to C++ restrictions on goto jumps we can be sure that
197/// jump target position will be on the path to root from CFGBuilder::ScopePos
198/// (adding any variable that doesn't need constructor to be called to
199/// LocalScope can break this assumption),
200///
201class LocalScope {
202public:
Eugene Zelenko38c70522017-12-07 21:55:09 +0000203 friend class const_iterator;
204
205 using AutomaticVarsTy = BumpVector<VarDecl *>;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000206
207 /// const_iterator - Iterates local scope backwards and jumps to previous
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000208 /// scope on reaching the beginning of currently iterated scope.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000209 class const_iterator {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000210 const LocalScope* Scope = nullptr;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000211
212 /// VarIter is guaranteed to be greater then 0 for every valid iterator.
213 /// Invalid iterator (with null Scope) has VarIter equal to 0.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000214 unsigned VarIter = 0;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000215
216 public:
217 /// Create invalid iterator. Dereferencing invalid iterator is not allowed.
218 /// Incrementing invalid iterator is allowed and will result in invalid
219 /// iterator.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000220 const_iterator() = default;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000221
222 /// Create valid iterator. In case when S.Prev is an invalid iterator and
223 /// I is equal to 0, this will create invalid iterator.
224 const_iterator(const LocalScope& S, unsigned I)
225 : Scope(&S), VarIter(I) {
226 // Iterator to "end" of scope is not allowed. Handle it by going up
227 // in scopes tree possibly up to invalid iterator in the root.
228 if (VarIter == 0 && Scope)
229 *this = Scope->Prev;
230 }
231
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000232 VarDecl *const* operator->() const {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000233 assert(Scope && "Dereferencing invalid iterator is not allowed");
234 assert(VarIter != 0 && "Iterator has invalid value of VarIter member");
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000235 return &Scope->Vars[VarIter - 1];
236 }
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000237 VarDecl *operator*() const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000238 return *this->operator->();
239 }
240
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000241 const_iterator &operator++() {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000242 if (!Scope)
243 return *this;
244
Eugene Zelenko38c70522017-12-07 21:55:09 +0000245 assert(VarIter != 0 && "Iterator has invalid value of VarIter member");
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000246 --VarIter;
247 if (VarIter == 0)
248 *this = Scope->Prev;
249 return *this;
250 }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000251 const_iterator operator++(int) {
252 const_iterator P = *this;
253 ++*this;
254 return P;
255 }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000256
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000257 bool operator==(const const_iterator &rhs) const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000258 return Scope == rhs.Scope && VarIter == rhs.VarIter;
259 }
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000260 bool operator!=(const const_iterator &rhs) const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000261 return !(*this == rhs);
262 }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000263
Aaron Ballman67347662015-02-15 22:00:28 +0000264 explicit operator bool() const {
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000265 return *this != const_iterator();
266 }
267
268 int distance(const_iterator L);
Matthias Gehre351c2182017-07-12 07:04:19 +0000269 const_iterator shared_parent(const_iterator L);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000270 };
271
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000272private:
Ted Kremenekc7bfdcd2011-02-15 02:47:45 +0000273 BumpVectorContext ctx;
274
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000275 /// Automatic variables in order of declaration.
276 AutomaticVarsTy Vars;
Eugene Zelenko38c70522017-12-07 21:55:09 +0000277
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000278 /// Iterator to variable in previous scope that was declared just before
279 /// begin of this scope.
280 const_iterator Prev;
281
282public:
283 /// Constructs empty scope linked to previous scope in specified place.
David Blaikiec1334cc2015-08-13 22:12:21 +0000284 LocalScope(BumpVectorContext ctx, const_iterator P)
285 : ctx(std::move(ctx)), Vars(this->ctx, 4), Prev(P) {}
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000286
287 /// Begin of scope in direction of CFG building (backwards).
288 const_iterator begin() const { return const_iterator(*this, Vars.size()); }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000289
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000290 void addVar(VarDecl *VD) {
Ted Kremenekc7bfdcd2011-02-15 02:47:45 +0000291 Vars.push_back(VD, ctx);
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000292 }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000293};
294
Eugene Zelenko38c70522017-12-07 21:55:09 +0000295} // namespace
296
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000297/// distance - Calculates distance from this to L. L must be reachable from this
298/// (with use of ++ operator). Cost of calculating the distance is linear w.r.t.
299/// number of scopes between this and L.
300int LocalScope::const_iterator::distance(LocalScope::const_iterator L) {
301 int D = 0;
302 const_iterator F = *this;
303 while (F.Scope != L.Scope) {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000304 assert(F != const_iterator() &&
305 "L iterator is not reachable from F iterator.");
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000306 D += F.VarIter;
307 F = F.Scope->Prev;
308 }
309 D += F.VarIter - L.VarIter;
310 return D;
311}
312
Matthias Gehre351c2182017-07-12 07:04:19 +0000313/// Calculates the closest parent of this iterator
314/// that is in a scope reachable through the parents of L.
315/// I.e. when using 'goto' from this to L, the lifetime of all variables
316/// between this and shared_parent(L) end.
317LocalScope::const_iterator
318LocalScope::const_iterator::shared_parent(LocalScope::const_iterator L) {
319 llvm::SmallPtrSet<const LocalScope *, 4> ScopesOfL;
320 while (true) {
321 ScopesOfL.insert(L.Scope);
322 if (L == const_iterator())
323 break;
324 L = L.Scope->Prev;
325 }
326
327 const_iterator F = *this;
328 while (true) {
329 if (ScopesOfL.count(F.Scope))
330 return F;
331 assert(F != const_iterator() &&
332 "L iterator is not reachable from F iterator.");
333 F = F.Scope->Prev;
334 }
335}
336
Eugene Zelenko38c70522017-12-07 21:55:09 +0000337namespace {
338
Jonathan Roelofs99bdd982015-05-19 18:51:56 +0000339/// Structure for specifying position in CFG during its build process. It
340/// consists of CFGBlock that specifies position in CFG and
341/// LocalScope::const_iterator that specifies position in LocalScope graph.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000342struct BlockScopePosPair {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000343 CFGBlock *block = nullptr;
344 LocalScope::const_iterator scopePosition;
345
346 BlockScopePosPair() = default;
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000347 BlockScopePosPair(CFGBlock *b, LocalScope::const_iterator scopePos)
Ted Kremenekef81e9e2011-01-07 19:37:16 +0000348 : block(b), scopePosition(scopePos) {}
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000349};
350
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000351/// TryResult - a class representing a variant over the values
352/// 'true', 'false', or 'unknown'. This is returned by tryEvaluateBool,
353/// and is used by the CFGBuilder to decide if a branch condition
354/// can be decided up front during CFG construction.
355class TryResult {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000356 int X = -1;
357
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000358public:
Eugene Zelenko38c70522017-12-07 21:55:09 +0000359 TryResult() = default;
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000360 TryResult(bool b) : X(b ? 1 : 0) {}
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000361
362 bool isTrue() const { return X == 1; }
363 bool isFalse() const { return X == 0; }
364 bool isKnown() const { return X >= 0; }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000365
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000366 void negate() {
367 assert(isKnown());
368 X ^= 0x1;
369 }
370};
371
Eugene Zelenko38c70522017-12-07 21:55:09 +0000372} // namespace
373
374static TryResult bothKnownTrue(TryResult R1, TryResult R2) {
Manuel Klimekdeb02622014-08-08 07:37:13 +0000375 if (!R1.isKnown() || !R2.isKnown())
376 return TryResult();
377 return TryResult(R1.isTrue() && R2.isTrue());
378}
379
Eugene Zelenko38c70522017-12-07 21:55:09 +0000380namespace {
381
Ted Kremenek8ae67872013-02-05 22:00:19 +0000382class reverse_children {
383 llvm::SmallVector<Stmt *, 12> childrenBuf;
Eugene Zelenko38c70522017-12-07 21:55:09 +0000384 ArrayRef<Stmt *> children;
385
Ted Kremenek8ae67872013-02-05 22:00:19 +0000386public:
387 reverse_children(Stmt *S);
388
Eugene Zelenko38c70522017-12-07 21:55:09 +0000389 using iterator = ArrayRef<Stmt *>::reverse_iterator;
390
Ted Kremenek8ae67872013-02-05 22:00:19 +0000391 iterator begin() const { return children.rbegin(); }
392 iterator end() const { return children.rend(); }
393};
394
Eugene Zelenko38c70522017-12-07 21:55:09 +0000395} // namespace
Ted Kremenek8ae67872013-02-05 22:00:19 +0000396
397reverse_children::reverse_children(Stmt *S) {
398 if (CallExpr *CE = dyn_cast<CallExpr>(S)) {
399 children = CE->getRawSubExprs();
400 return;
401 }
402 switch (S->getStmtClass()) {
Ted Kremenek7d86b9c2013-02-05 22:03:14 +0000403 // Note: Fill in this switch with more cases we want to optimize.
Ted Kremenek8ae67872013-02-05 22:00:19 +0000404 case Stmt::InitListExprClass: {
405 InitListExpr *IE = cast<InitListExpr>(S);
406 children = llvm::makeArrayRef(reinterpret_cast<Stmt**>(IE->getInits()),
407 IE->getNumInits());
408 return;
409 }
410 default:
411 break;
412 }
413
414 // Default case for all other statements.
Benjamin Kramer642f1732015-07-02 21:03:14 +0000415 for (Stmt *SubStmt : S->children())
416 childrenBuf.push_back(SubStmt);
Ted Kremenek8ae67872013-02-05 22:00:19 +0000417
418 // This needs to be done *after* childrenBuf has been populated.
419 children = childrenBuf;
420}
421
Eugene Zelenko38c70522017-12-07 21:55:09 +0000422namespace {
423
Ted Kremenekbe9b33b2008-08-04 22:51:42 +0000424/// CFGBuilder - This class implements CFG construction from an AST.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +0000425/// The builder is stateful: an instance of the builder should be used to only
426/// construct a single CFG.
427///
428/// Example usage:
429///
430/// CFGBuilder builder;
Jonathan Roelofsab046c52015-07-27 16:05:36 +0000431/// std::unique_ptr<CFG> cfg = builder.buildCFG(decl, stmt1);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +0000432///
Mike Stump31feda52009-07-17 01:31:16 +0000433/// CFG construction is done via a recursive walk of an AST. We actually parse
434/// the AST in reverse order so that the successor of a basic block is
435/// constructed prior to its predecessor. This allows us to nicely capture
436/// implicit fall-throughs without extra basic blocks.
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +0000437class CFGBuilder {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000438 using JumpTarget = BlockScopePosPair;
439 using JumpSource = BlockScopePosPair;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000440
Mike Stump0d76d072009-07-20 23:24:15 +0000441 ASTContext *Context;
Ahmed Charlesb8984322014-03-07 20:03:18 +0000442 std::unique_ptr<CFG> cfg;
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000443
Eugene Zelenko38c70522017-12-07 21:55:09 +0000444 // Current block.
445 CFGBlock *Block = nullptr;
446
447 // Block after the current block.
448 CFGBlock *Succ = nullptr;
449
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000450 JumpTarget ContinueJumpTarget;
451 JumpTarget BreakJumpTarget;
Nico Weber699670e2017-08-23 15:33:16 +0000452 JumpTarget SEHLeaveJumpTarget;
Eugene Zelenko38c70522017-12-07 21:55:09 +0000453 CFGBlock *SwitchTerminatedBlock = nullptr;
454 CFGBlock *DefaultCaseBlock = nullptr;
Nico Weber699670e2017-08-23 15:33:16 +0000455
456 // This can point either to a try or a __try block. The frontend forbids
457 // mixing both kinds in one function, so having one for both is enough.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000458 CFGBlock *TryTerminatedBlock = nullptr;
Manuel Klimekb5616c92014-08-07 10:42:17 +0000459
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000460 // Current position in local scope.
461 LocalScope::const_iterator ScopePos;
462
463 // LabelMap records the mapping from Label expressions to their jump targets.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000464 using LabelMapTy = llvm::DenseMap<LabelDecl *, JumpTarget>;
Ted Kremenek8a632182007-08-21 23:26:17 +0000465 LabelMapTy LabelMap;
Mike Stump31feda52009-07-17 01:31:16 +0000466
467 // A list of blocks that end with a "goto" that must be backpatched to their
468 // resolved targets upon completion of CFG construction.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000469 using BackpatchBlocksTy = std::vector<JumpSource>;
Ted Kremenek8a632182007-08-21 23:26:17 +0000470 BackpatchBlocksTy BackpatchBlocks;
Mike Stump31feda52009-07-17 01:31:16 +0000471
Ted Kremenekeda180e22007-08-28 19:26:49 +0000472 // A list of labels whose address has been taken (for indirect gotos).
Eugene Zelenko38c70522017-12-07 21:55:09 +0000473 using LabelSetTy = llvm::SmallSetVector<LabelDecl *, 8>;
Ted Kremenekeda180e22007-08-28 19:26:49 +0000474 LabelSetTy AddressTakenLabels;
Mike Stump31feda52009-07-17 01:31:16 +0000475
Artem Dergachev41ffb302018-02-08 22:58:15 +0000476 // Information about the currently visited C++ object construction site.
477 // This is set in the construction trigger and read when the constructor
478 // itself is being visited.
Artem Dergachev40684812018-02-27 20:03:35 +0000479 llvm::DenseMap<CXXConstructExpr *, const ConstructionContextLayer *>
Artem Dergachev5e2f6ba2018-02-23 22:49:25 +0000480 ConstructionContextMap;
Artem Dergachev41ffb302018-02-08 22:58:15 +0000481
Eugene Zelenko38c70522017-12-07 21:55:09 +0000482 bool badCFG = false;
Ted Kremenekf9d82902011-03-10 01:14:05 +0000483 const CFG::BuildOptions &BuildOpts;
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000484
485 // State to track for building switch statements.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000486 bool switchExclusivelyCovered = false;
487 Expr::EvalResult *switchCond = nullptr;
Ted Kremeneka099c592011-03-10 03:50:34 +0000488
Eugene Zelenko38c70522017-12-07 21:55:09 +0000489 CFG::BuildOptions::ForcedBlkExprs::value_type *cachedEntry = nullptr;
490 const Stmt *lastLookup = nullptr;
Zhongxing Xud38fb842010-09-16 03:28:18 +0000491
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000492 // Caches boolean evaluations of expressions to avoid multiple re-evaluations
493 // during construction of branches for chained logical operators.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000494 using CachedBoolEvalsTy = llvm::DenseMap<Expr *, TryResult>;
NAKAMURA Takumie9ca55e2012-03-25 06:30:37 +0000495 CachedBoolEvalsTy CachedBoolEvals;
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000496
Mike Stump31feda52009-07-17 01:31:16 +0000497public:
Ted Kremenekf9d82902011-03-10 01:14:05 +0000498 explicit CFGBuilder(ASTContext *astContext,
Nico Weber699670e2017-08-23 15:33:16 +0000499 const CFG::BuildOptions &buildOpts)
500 : Context(astContext), cfg(new CFG()), // crew a new CFG
Artem Dergachev5e2f6ba2018-02-23 22:49:25 +0000501 ConstructionContextMap(), BuildOpts(buildOpts) {}
502
Mike Stump31feda52009-07-17 01:31:16 +0000503
Ted Kremenek9aae5132007-08-23 21:42:29 +0000504 // buildCFG - Used by external clients to construct the CFG.
David Blaikiee90195c2014-08-29 18:53:26 +0000505 std::unique_ptr<CFG> buildCFG(const Decl *D, Stmt *Statement);
Mike Stump31feda52009-07-17 01:31:16 +0000506
Ted Kremeneka099c592011-03-10 03:50:34 +0000507 bool alwaysAdd(const Stmt *stmt);
508
Ted Kremenek93668002009-07-17 22:18:43 +0000509private:
510 // Visitors to walk an AST and construct the CFG.
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000511 CFGBlock *VisitAddrLabelExpr(AddrLabelExpr *A, AddStmtChoice asc);
512 CFGBlock *VisitBinaryOperator(BinaryOperator *B, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000513 CFGBlock *VisitBreakStmt(BreakStmt *B);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000514 CFGBlock *VisitCallExpr(CallExpr *C, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000515 CFGBlock *VisitCaseStmt(CaseStmt *C);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000516 CFGBlock *VisitChooseExpr(ChooseExpr *C, AddStmtChoice asc);
Ted Kremenek21822592009-07-17 18:20:32 +0000517 CFGBlock *VisitCompoundStmt(CompoundStmt *C);
John McCallc07a0c72011-02-17 10:25:35 +0000518 CFGBlock *VisitConditionalOperator(AbstractConditionalOperator *C,
519 AddStmtChoice asc);
Ted Kremenek21822592009-07-17 18:20:32 +0000520 CFGBlock *VisitContinueStmt(ContinueStmt *C);
Ted Kremenek6f400242012-07-14 05:04:01 +0000521 CFGBlock *VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
522 AddStmtChoice asc);
523 CFGBlock *VisitCXXCatchStmt(CXXCatchStmt *S);
524 CFGBlock *VisitCXXConstructExpr(CXXConstructExpr *C, AddStmtChoice asc);
Jordan Rosec9176072014-01-13 17:59:19 +0000525 CFGBlock *VisitCXXNewExpr(CXXNewExpr *DE, AddStmtChoice asc);
Jordan Rosed2f40792013-09-03 17:00:57 +0000526 CFGBlock *VisitCXXDeleteExpr(CXXDeleteExpr *DE, AddStmtChoice asc);
Ted Kremenek6f400242012-07-14 05:04:01 +0000527 CFGBlock *VisitCXXForRangeStmt(CXXForRangeStmt *S);
528 CFGBlock *VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
529 AddStmtChoice asc);
530 CFGBlock *VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
531 AddStmtChoice asc);
532 CFGBlock *VisitCXXThrowExpr(CXXThrowExpr *T);
533 CFGBlock *VisitCXXTryStmt(CXXTryStmt *S);
Ted Kremenek93668002009-07-17 22:18:43 +0000534 CFGBlock *VisitDeclStmt(DeclStmt *DS);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000535 CFGBlock *VisitDeclSubExpr(DeclStmt *DS);
Ted Kremenek21822592009-07-17 18:20:32 +0000536 CFGBlock *VisitDefaultStmt(DefaultStmt *D);
537 CFGBlock *VisitDoStmt(DoStmt *D);
Ted Kremenek6f400242012-07-14 05:04:01 +0000538 CFGBlock *VisitExprWithCleanups(ExprWithCleanups *E, AddStmtChoice asc);
Ted Kremenek21822592009-07-17 18:20:32 +0000539 CFGBlock *VisitForStmt(ForStmt *F);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000540 CFGBlock *VisitGotoStmt(GotoStmt *G);
Ted Kremenek93668002009-07-17 22:18:43 +0000541 CFGBlock *VisitIfStmt(IfStmt *I);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +0000542 CFGBlock *VisitImplicitCastExpr(ImplicitCastExpr *E, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000543 CFGBlock *VisitIndirectGotoStmt(IndirectGotoStmt *I);
544 CFGBlock *VisitLabelStmt(LabelStmt *L);
Devin Coughlinb6029b72015-11-25 22:35:37 +0000545 CFGBlock *VisitBlockExpr(BlockExpr *E, AddStmtChoice asc);
Ted Kremenek6f400242012-07-14 05:04:01 +0000546 CFGBlock *VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc);
Ted Kremeneka16436f2012-07-14 05:04:06 +0000547 CFGBlock *VisitLogicalOperator(BinaryOperator *B);
Ted Kremenekb50e7162012-07-14 05:04:10 +0000548 std::pair<CFGBlock *, CFGBlock *> VisitLogicalOperator(BinaryOperator *B,
549 Stmt *Term,
550 CFGBlock *TrueBlock,
551 CFGBlock *FalseBlock);
Artem Dergachevf43ac4c2018-02-24 02:00:30 +0000552 CFGBlock *VisitMaterializeTemporaryExpr(MaterializeTemporaryExpr *MTE,
553 AddStmtChoice asc);
Ted Kremenek5868ec62010-04-11 17:02:10 +0000554 CFGBlock *VisitMemberExpr(MemberExpr *M, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000555 CFGBlock *VisitObjCAtCatchStmt(ObjCAtCatchStmt *S);
556 CFGBlock *VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S);
557 CFGBlock *VisitObjCAtThrowStmt(ObjCAtThrowStmt *S);
558 CFGBlock *VisitObjCAtTryStmt(ObjCAtTryStmt *S);
Ted Kremenek6f400242012-07-14 05:04:01 +0000559 CFGBlock *VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S);
Ted Kremenek93668002009-07-17 22:18:43 +0000560 CFGBlock *VisitObjCForCollectionStmt(ObjCForCollectionStmt *S);
John McCallfe96e0b2011-11-06 09:01:30 +0000561 CFGBlock *VisitPseudoObjectExpr(PseudoObjectExpr *E);
Ted Kremenek6f400242012-07-14 05:04:01 +0000562 CFGBlock *VisitReturnStmt(ReturnStmt *R);
Nico Weber699670e2017-08-23 15:33:16 +0000563 CFGBlock *VisitSEHExceptStmt(SEHExceptStmt *S);
564 CFGBlock *VisitSEHFinallyStmt(SEHFinallyStmt *S);
565 CFGBlock *VisitSEHLeaveStmt(SEHLeaveStmt *S);
566 CFGBlock *VisitSEHTryStmt(SEHTryStmt *S);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000567 CFGBlock *VisitStmtExpr(StmtExpr *S, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000568 CFGBlock *VisitSwitchStmt(SwitchStmt *S);
Ted Kremenek6f400242012-07-14 05:04:01 +0000569 CFGBlock *VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
570 AddStmtChoice asc);
Zhanyong Wan6dace612010-11-22 08:45:56 +0000571 CFGBlock *VisitUnaryOperator(UnaryOperator *U, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000572 CFGBlock *VisitWhileStmt(WhileStmt *W);
Mike Stump48871a22009-07-17 01:04:31 +0000573
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000574 CFGBlock *Visit(Stmt *S, AddStmtChoice asc = AddStmtChoice::NotAlwaysAdd);
575 CFGBlock *VisitStmt(Stmt *S, AddStmtChoice asc);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000576 CFGBlock *VisitChildren(Stmt *S);
Ted Kremeneke2499842012-04-12 20:03:44 +0000577 CFGBlock *VisitNoRecurse(Expr *E, AddStmtChoice asc);
Mike Stump48871a22009-07-17 01:04:31 +0000578
Manuel Klimekb5616c92014-08-07 10:42:17 +0000579 /// When creating the CFG for temporary destructors, we want to mirror the
580 /// branch structure of the corresponding constructor calls.
581 /// Thus, while visiting a statement for temporary destructors, we keep a
582 /// context to keep track of the following information:
583 /// - whether a subexpression is executed unconditionally
584 /// - if a subexpression is executed conditionally, the first
585 /// CXXBindTemporaryExpr we encounter in that subexpression (which
586 /// corresponds to the last temporary destructor we have to call for this
587 /// subexpression) and the CFG block at that point (which will become the
588 /// successor block when inserting the decision point).
589 ///
590 /// That way, we can build the branch structure for temporary destructors as
591 /// follows:
592 /// 1. If a subexpression is executed unconditionally, we add the temporary
593 /// destructor calls to the current block.
594 /// 2. If a subexpression is executed conditionally, when we encounter a
595 /// CXXBindTemporaryExpr:
596 /// a) If it is the first temporary destructor call in the subexpression,
597 /// we remember the CXXBindTemporaryExpr and the current block in the
598 /// TempDtorContext; we start a new block, and insert the temporary
599 /// destructor call.
600 /// b) Otherwise, add the temporary destructor call to the current block.
601 /// 3. When we finished visiting a conditionally executed subexpression,
602 /// and we found at least one temporary constructor during the visitation
603 /// (2.a has executed), we insert a decision block that uses the
604 /// CXXBindTemporaryExpr as terminator, and branches to the current block
605 /// if the CXXBindTemporaryExpr was marked executed, and otherwise
606 /// branches to the stored successor.
607 struct TempDtorContext {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000608 TempDtorContext() = default;
Manuel Klimekdeb02622014-08-08 07:37:13 +0000609 TempDtorContext(TryResult KnownExecuted)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000610 : IsConditional(true), KnownExecuted(KnownExecuted) {}
Manuel Klimekb5616c92014-08-07 10:42:17 +0000611
612 /// Returns whether we need to start a new branch for a temporary destructor
Eric Christopher2c4555a2015-06-19 01:52:53 +0000613 /// call. This is the case when the temporary destructor is
Manuel Klimekb5616c92014-08-07 10:42:17 +0000614 /// conditionally executed, and it is the first one we encounter while
615 /// visiting a subexpression - other temporary destructors at the same level
616 /// will be added to the same block and are executed under the same
617 /// condition.
618 bool needsTempDtorBranch() const {
619 return IsConditional && !TerminatorExpr;
620 }
621
622 /// Remember the successor S of a temporary destructor decision branch for
623 /// the corresponding CXXBindTemporaryExpr E.
624 void setDecisionPoint(CFGBlock *S, CXXBindTemporaryExpr *E) {
625 Succ = S;
626 TerminatorExpr = E;
627 }
628
Eugene Zelenko38c70522017-12-07 21:55:09 +0000629 const bool IsConditional = false;
630 const TryResult KnownExecuted = true;
631 CFGBlock *Succ = nullptr;
632 CXXBindTemporaryExpr *TerminatorExpr = nullptr;
Manuel Klimekb5616c92014-08-07 10:42:17 +0000633 };
634
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000635 // Visitors to walk an AST and generate destructors of temporaries in
636 // full expression.
Manuel Klimekb5616c92014-08-07 10:42:17 +0000637 CFGBlock *VisitForTemporaryDtors(Stmt *E, bool BindToTemporary,
638 TempDtorContext &Context);
639 CFGBlock *VisitChildrenForTemporaryDtors(Stmt *E, TempDtorContext &Context);
640 CFGBlock *VisitBinaryOperatorForTemporaryDtors(BinaryOperator *E,
641 TempDtorContext &Context);
642 CFGBlock *VisitCXXBindTemporaryExprForTemporaryDtors(
643 CXXBindTemporaryExpr *E, bool BindToTemporary, TempDtorContext &Context);
644 CFGBlock *VisitConditionalOperatorForTemporaryDtors(
645 AbstractConditionalOperator *E, bool BindToTemporary,
646 TempDtorContext &Context);
647 void InsertTempDtorDecisionBlock(const TempDtorContext &Context,
648 CFGBlock *FalseSucc = nullptr);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000649
Ted Kremenek6065ef62008-04-28 18:00:46 +0000650 // NYS == Not Yet Supported
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000651 CFGBlock *NYS() {
Ted Kremenekb64d1832008-03-13 03:04:22 +0000652 badCFG = true;
653 return Block;
654 }
Mike Stump31feda52009-07-17 01:31:16 +0000655
Artem Dergachev40684812018-02-27 20:03:35 +0000656 // Remember to apply the construction context based on the current \p Layer
657 // when constructing the CFG element for \p CE.
658 void consumeConstructionContext(const ConstructionContextLayer *Layer,
Artem Dergachevc1b07bd2018-02-23 23:38:41 +0000659 CXXConstructExpr *CE);
660
Artem Dergachev40684812018-02-27 20:03:35 +0000661 // Scan \p Child statement to find constructors in it, while keeping in mind
662 // that its parent statement is providing a partial construction context
663 // described by \p Layer. If a constructor is found, it would be assigned
664 // the context based on the layer. If an additional construction context layer
665 // is found, the function recurses into that.
666 void findConstructionContexts(const ConstructionContextLayer *Layer,
Artem Dergachev783a4572018-02-23 22:20:39 +0000667 Stmt *Child);
Artem Dergachev40684812018-02-27 20:03:35 +0000668
Artem Dergachev41ffb302018-02-08 22:58:15 +0000669 // Unset the construction context after consuming it. This is done immediately
670 // after adding the CFGConstructor element, so there's no need to
671 // do this manually in every Visit... function.
Artem Dergachev783a4572018-02-23 22:20:39 +0000672 void cleanupConstructionContext(CXXConstructExpr *CE);
Artem Dergachev41ffb302018-02-08 22:58:15 +0000673
Ted Kremenek93668002009-07-17 22:18:43 +0000674 void autoCreateBlock() { if (!Block) Block = createBlock(); }
675 CFGBlock *createBlock(bool add_successor = true);
Chandler Carrutha70991b2011-09-13 09:13:49 +0000676 CFGBlock *createNoReturnBlock();
Zhongxing Xu33dfc072010-09-06 07:32:31 +0000677
Zhongxing Xuea9fcff2010-06-03 06:43:23 +0000678 CFGBlock *addStmt(Stmt *S) {
679 return Visit(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000680 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000681
Alexis Hunt1d792652011-01-08 20:30:50 +0000682 CFGBlock *addInitializer(CXXCtorInitializer *I);
Peter Szecsi999a25f2017-08-19 11:19:16 +0000683 void addLoopExit(const Stmt *LoopStmt);
Zhongxing Xu6d372f72010-10-01 03:22:39 +0000684 void addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000685 LocalScope::const_iterator E, Stmt *S);
Matthias Gehre351c2182017-07-12 07:04:19 +0000686 void addLifetimeEnds(LocalScope::const_iterator B,
687 LocalScope::const_iterator E, Stmt *S);
688 void addAutomaticObjHandling(LocalScope::const_iterator B,
689 LocalScope::const_iterator E, Stmt *S);
Marcin Swiderski20b88732010-10-05 05:37:00 +0000690 void addImplicitDtorsForDestructor(const CXXDestructorDecl *DD);
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000691
Marcin Swiderski5e415732010-09-30 23:05:00 +0000692 // Local scopes creation.
693 LocalScope* createOrReuseLocalScope(LocalScope* Scope);
694
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000695 void addLocalScopeForStmt(Stmt *S);
Craig Topper25542942014-05-20 04:30:07 +0000696 LocalScope* addLocalScopeForDeclStmt(DeclStmt *DS,
697 LocalScope* Scope = nullptr);
698 LocalScope* addLocalScopeForVarDecl(VarDecl *VD, LocalScope* Scope = nullptr);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000699
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000700 void addLocalScopeAndDtors(Stmt *S);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000701
702 // Interface to CFGBlock - adding CFGElements.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000703
Ted Kremenek37881932011-04-04 23:29:12 +0000704 void appendStmt(CFGBlock *B, const Stmt *S) {
Ted Kremenek8b46c002011-07-19 14:18:43 +0000705 if (alwaysAdd(S) && cachedEntry)
Ted Kremeneka099c592011-03-10 03:50:34 +0000706 cachedEntry->second = B;
Ted Kremeneka099c592011-03-10 03:50:34 +0000707
Jordy Rose17347372011-06-10 08:49:37 +0000708 // All block-level expressions should have already been IgnoreParens()ed.
709 assert(!isa<Expr>(S) || cast<Expr>(S)->IgnoreParens() == S);
Ted Kremenek37881932011-04-04 23:29:12 +0000710 B->appendStmt(const_cast<Stmt*>(S), cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000711 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000712
Artem Dergachev41ffb302018-02-08 22:58:15 +0000713 void appendConstructor(CFGBlock *B, CXXConstructExpr *CE) {
714 if (BuildOpts.AddRichCXXConstructors) {
Artem Dergachev40684812018-02-27 20:03:35 +0000715 if (const ConstructionContextLayer *Layer =
716 ConstructionContextMap.lookup(CE)) {
717 const ConstructionContext *CC =
718 ConstructionContext::createFromLayers(cfg->getBumpVectorContext(),
719 Layer);
Artem Dergachev783a4572018-02-23 22:20:39 +0000720 B->appendConstructor(CE, CC, cfg->getBumpVectorContext());
721 cleanupConstructionContext(CE);
Artem Dergachev41ffb302018-02-08 22:58:15 +0000722 return;
723 }
724 }
725
726 // No valid construction context found. Fall back to statement.
727 B->appendStmt(CE, cfg->getBumpVectorContext());
728 }
729
Alexis Hunt1d792652011-01-08 20:30:50 +0000730 void appendInitializer(CFGBlock *B, CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +0000731 B->appendInitializer(I, cfg->getBumpVectorContext());
732 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000733
Jordan Rosec9176072014-01-13 17:59:19 +0000734 void appendNewAllocator(CFGBlock *B, CXXNewExpr *NE) {
735 B->appendNewAllocator(NE, cfg->getBumpVectorContext());
736 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000737
Marcin Swiderski20b88732010-10-05 05:37:00 +0000738 void appendBaseDtor(CFGBlock *B, const CXXBaseSpecifier *BS) {
739 B->appendBaseDtor(BS, cfg->getBumpVectorContext());
740 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000741
Marcin Swiderski20b88732010-10-05 05:37:00 +0000742 void appendMemberDtor(CFGBlock *B, FieldDecl *FD) {
743 B->appendMemberDtor(FD, cfg->getBumpVectorContext());
744 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000745
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000746 void appendTemporaryDtor(CFGBlock *B, CXXBindTemporaryExpr *E) {
747 B->appendTemporaryDtor(E, cfg->getBumpVectorContext());
748 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000749
Chandler Carruthad747252011-09-13 06:09:01 +0000750 void appendAutomaticObjDtor(CFGBlock *B, VarDecl *VD, Stmt *S) {
751 B->appendAutomaticObjDtor(VD, S, cfg->getBumpVectorContext());
752 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000753
Matthias Gehre351c2182017-07-12 07:04:19 +0000754 void appendLifetimeEnds(CFGBlock *B, VarDecl *VD, Stmt *S) {
755 B->appendLifetimeEnds(VD, S, cfg->getBumpVectorContext());
756 }
757
Peter Szecsi999a25f2017-08-19 11:19:16 +0000758 void appendLoopExit(CFGBlock *B, const Stmt *LoopStmt) {
759 B->appendLoopExit(LoopStmt, cfg->getBumpVectorContext());
760 }
761
Jordan Rosed2f40792013-09-03 17:00:57 +0000762 void appendDeleteDtor(CFGBlock *B, CXXRecordDecl *RD, CXXDeleteExpr *DE) {
763 B->appendDeleteDtor(RD, DE, cfg->getBumpVectorContext());
764 }
765
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000766 void prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +0000767 LocalScope::const_iterator B, LocalScope::const_iterator E);
768
Matthias Gehre351c2182017-07-12 07:04:19 +0000769 void prependAutomaticObjLifetimeWithTerminator(CFGBlock *Blk,
770 LocalScope::const_iterator B,
771 LocalScope::const_iterator E);
772
Ted Kremenek4b6fee62014-02-27 00:24:00 +0000773 void addSuccessor(CFGBlock *B, CFGBlock *S, bool IsReachable = true) {
774 B->addSuccessor(CFGBlock::AdjacentBlock(S, IsReachable),
775 cfg->getBumpVectorContext());
776 }
777
778 /// Add a reachable successor to a block, with the alternate variant that is
779 /// unreachable.
780 void addSuccessor(CFGBlock *B, CFGBlock *ReachableBlock, CFGBlock *AltBlock) {
781 B->addSuccessor(CFGBlock::AdjacentBlock(ReachableBlock, AltBlock),
782 cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000783 }
Mike Stump11289f42009-09-09 15:08:12 +0000784
Richard Trieuf935b562014-04-05 05:17:01 +0000785 /// \brief Find a relational comparison with an expression evaluating to a
786 /// boolean and a constant other than 0 and 1.
787 /// e.g. if ((x < y) == 10)
788 TryResult checkIncorrectRelationalOperator(const BinaryOperator *B) {
789 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
790 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
791
792 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
793 const Expr *BoolExpr = RHSExpr;
794 bool IntFirst = true;
795 if (!IntLiteral) {
796 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
797 BoolExpr = LHSExpr;
798 IntFirst = false;
799 }
800
801 if (!IntLiteral || !BoolExpr->isKnownToHaveBooleanValue())
802 return TryResult();
803
804 llvm::APInt IntValue = IntLiteral->getValue();
805 if ((IntValue == 1) || (IntValue == 0))
806 return TryResult();
807
808 bool IntLarger = IntLiteral->getType()->isUnsignedIntegerType() ||
809 !IntValue.isNegative();
810
811 BinaryOperatorKind Bok = B->getOpcode();
812 if (Bok == BO_GT || Bok == BO_GE) {
813 // Always true for 10 > bool and bool > -1
814 // Always false for -1 > bool and bool > 10
815 return TryResult(IntFirst == IntLarger);
816 } else {
817 // Always true for -1 < bool and bool < 10
818 // Always false for 10 < bool and bool < -1
819 return TryResult(IntFirst != IntLarger);
820 }
821 }
822
Jordan Rose7afd71e2014-05-20 17:31:11 +0000823 /// Find an incorrect equality comparison. Either with an expression
824 /// evaluating to a boolean and a constant other than 0 and 1.
825 /// e.g. if (!x == 10) or a bitwise and/or operation that always evaluates to
826 /// true/false e.q. (x & 8) == 4.
Richard Trieuf935b562014-04-05 05:17:01 +0000827 TryResult checkIncorrectEqualityOperator(const BinaryOperator *B) {
828 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
829 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
830
831 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
832 const Expr *BoolExpr = RHSExpr;
833
834 if (!IntLiteral) {
835 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
836 BoolExpr = LHSExpr;
837 }
838
Jordan Rose7afd71e2014-05-20 17:31:11 +0000839 if (!IntLiteral)
Richard Trieuf935b562014-04-05 05:17:01 +0000840 return TryResult();
841
Jordan Rose7afd71e2014-05-20 17:31:11 +0000842 const BinaryOperator *BitOp = dyn_cast<BinaryOperator>(BoolExpr);
843 if (BitOp && (BitOp->getOpcode() == BO_And ||
844 BitOp->getOpcode() == BO_Or)) {
845 const Expr *LHSExpr2 = BitOp->getLHS()->IgnoreParens();
846 const Expr *RHSExpr2 = BitOp->getRHS()->IgnoreParens();
847
848 const IntegerLiteral *IntLiteral2 = dyn_cast<IntegerLiteral>(LHSExpr2);
849
850 if (!IntLiteral2)
851 IntLiteral2 = dyn_cast<IntegerLiteral>(RHSExpr2);
852
853 if (!IntLiteral2)
854 return TryResult();
855
856 llvm::APInt L1 = IntLiteral->getValue();
857 llvm::APInt L2 = IntLiteral2->getValue();
858 if ((BitOp->getOpcode() == BO_And && (L2 & L1) != L1) ||
859 (BitOp->getOpcode() == BO_Or && (L2 | L1) != L1)) {
860 if (BuildOpts.Observer)
861 BuildOpts.Observer->compareBitwiseEquality(B,
862 B->getOpcode() != BO_EQ);
863 TryResult(B->getOpcode() != BO_EQ);
864 }
865 } else if (BoolExpr->isKnownToHaveBooleanValue()) {
866 llvm::APInt IntValue = IntLiteral->getValue();
867 if ((IntValue == 1) || (IntValue == 0)) {
868 return TryResult();
869 }
870 return TryResult(B->getOpcode() != BO_EQ);
Richard Trieuf935b562014-04-05 05:17:01 +0000871 }
872
Jordan Rose7afd71e2014-05-20 17:31:11 +0000873 return TryResult();
Richard Trieuf935b562014-04-05 05:17:01 +0000874 }
875
876 TryResult analyzeLogicOperatorCondition(BinaryOperatorKind Relation,
877 const llvm::APSInt &Value1,
878 const llvm::APSInt &Value2) {
879 assert(Value1.isSigned() == Value2.isSigned());
880 switch (Relation) {
881 default:
882 return TryResult();
883 case BO_EQ:
884 return TryResult(Value1 == Value2);
885 case BO_NE:
886 return TryResult(Value1 != Value2);
887 case BO_LT:
888 return TryResult(Value1 < Value2);
889 case BO_LE:
890 return TryResult(Value1 <= Value2);
891 case BO_GT:
892 return TryResult(Value1 > Value2);
893 case BO_GE:
894 return TryResult(Value1 >= Value2);
895 }
896 }
897
898 /// \brief Find a pair of comparison expressions with or without parentheses
899 /// with a shared variable and constants and a logical operator between them
900 /// that always evaluates to either true or false.
901 /// e.g. if (x != 3 || x != 4)
902 TryResult checkIncorrectLogicOperator(const BinaryOperator *B) {
903 assert(B->isLogicalOp());
904 const BinaryOperator *LHS =
905 dyn_cast<BinaryOperator>(B->getLHS()->IgnoreParens());
906 const BinaryOperator *RHS =
907 dyn_cast<BinaryOperator>(B->getRHS()->IgnoreParens());
908 if (!LHS || !RHS)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000909 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000910
911 if (!LHS->isComparisonOp() || !RHS->isComparisonOp())
Eugene Zelenko38c70522017-12-07 21:55:09 +0000912 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000913
George Burgess IVced56e62015-10-01 18:47:52 +0000914 const DeclRefExpr *Decl1;
915 const Expr *Expr1;
916 BinaryOperatorKind BO1;
917 std::tie(Decl1, BO1, Expr1) = tryNormalizeBinaryOperator(LHS);
Richard Trieuf935b562014-04-05 05:17:01 +0000918
George Burgess IVced56e62015-10-01 18:47:52 +0000919 if (!Decl1 || !Expr1)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000920 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000921
George Burgess IVced56e62015-10-01 18:47:52 +0000922 const DeclRefExpr *Decl2;
923 const Expr *Expr2;
924 BinaryOperatorKind BO2;
925 std::tie(Decl2, BO2, Expr2) = tryNormalizeBinaryOperator(RHS);
Richard Trieuf935b562014-04-05 05:17:01 +0000926
George Burgess IVced56e62015-10-01 18:47:52 +0000927 if (!Decl2 || !Expr2)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000928 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000929
930 // Check that it is the same variable on both sides.
931 if (Decl1->getDecl() != Decl2->getDecl())
Eugene Zelenko38c70522017-12-07 21:55:09 +0000932 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000933
George Burgess IVced56e62015-10-01 18:47:52 +0000934 // Make sure the user's intent is clear (e.g. they're comparing against two
935 // int literals, or two things from the same enum)
936 if (!areExprTypesCompatible(Expr1, Expr2))
Eugene Zelenko38c70522017-12-07 21:55:09 +0000937 return {};
George Burgess IVced56e62015-10-01 18:47:52 +0000938
Richard Trieuf935b562014-04-05 05:17:01 +0000939 llvm::APSInt L1, L2;
940
George Burgess IVced56e62015-10-01 18:47:52 +0000941 if (!Expr1->EvaluateAsInt(L1, *Context) ||
942 !Expr2->EvaluateAsInt(L2, *Context))
Eugene Zelenko38c70522017-12-07 21:55:09 +0000943 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000944
945 // Can't compare signed with unsigned or with different bit width.
946 if (L1.isSigned() != L2.isSigned() || L1.getBitWidth() != L2.getBitWidth())
Eugene Zelenko38c70522017-12-07 21:55:09 +0000947 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000948
949 // Values that will be used to determine if result of logical
950 // operator is always true/false
951 const llvm::APSInt Values[] = {
952 // Value less than both Value1 and Value2
953 llvm::APSInt::getMinValue(L1.getBitWidth(), L1.isUnsigned()),
954 // L1
955 L1,
956 // Value between Value1 and Value2
957 ((L1 < L2) ? L1 : L2) + llvm::APSInt(llvm::APInt(L1.getBitWidth(), 1),
958 L1.isUnsigned()),
959 // L2
960 L2,
961 // Value greater than both Value1 and Value2
962 llvm::APSInt::getMaxValue(L1.getBitWidth(), L1.isUnsigned()),
963 };
964
965 // Check whether expression is always true/false by evaluating the following
966 // * variable x is less than the smallest literal.
967 // * variable x is equal to the smallest literal.
968 // * Variable x is between smallest and largest literal.
969 // * Variable x is equal to the largest literal.
970 // * Variable x is greater than largest literal.
971 bool AlwaysTrue = true, AlwaysFalse = true;
Benjamin Kramer2e018ef2016-05-27 13:36:58 +0000972 for (const llvm::APSInt &Value : Values) {
Richard Trieuf935b562014-04-05 05:17:01 +0000973 TryResult Res1, Res2;
974 Res1 = analyzeLogicOperatorCondition(BO1, Value, L1);
975 Res2 = analyzeLogicOperatorCondition(BO2, Value, L2);
976
977 if (!Res1.isKnown() || !Res2.isKnown())
Eugene Zelenko38c70522017-12-07 21:55:09 +0000978 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000979
980 if (B->getOpcode() == BO_LAnd) {
981 AlwaysTrue &= (Res1.isTrue() && Res2.isTrue());
982 AlwaysFalse &= !(Res1.isTrue() && Res2.isTrue());
983 } else {
984 AlwaysTrue &= (Res1.isTrue() || Res2.isTrue());
985 AlwaysFalse &= !(Res1.isTrue() || Res2.isTrue());
986 }
987 }
988
989 if (AlwaysTrue || AlwaysFalse) {
990 if (BuildOpts.Observer)
991 BuildOpts.Observer->compareAlwaysTrue(B, AlwaysTrue);
992 return TryResult(AlwaysTrue);
993 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000994 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000995 }
996
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000997 /// Try and evaluate an expression to an integer constant.
998 bool tryEvaluate(Expr *S, Expr::EvalResult &outResult) {
999 if (!BuildOpts.PruneTriviallyFalseEdges)
1000 return false;
1001 return !S->isTypeDependent() &&
Ted Kremenek352a7082011-04-04 20:30:58 +00001002 !S->isValueDependent() &&
Richard Smith7b553f12011-10-29 00:50:52 +00001003 S->EvaluateAsRValue(outResult, *Context);
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00001004 }
Mike Stump11289f42009-09-09 15:08:12 +00001005
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001006 /// tryEvaluateBool - Try and evaluate the Stmt and return 0 or 1
Mike Stump773582d2009-07-23 23:25:26 +00001007 /// if we can evaluate to a known value, otherwise return -1.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001008 TryResult tryEvaluateBool(Expr *S) {
Richard Smithfaa32a92011-10-14 20:22:00 +00001009 if (!BuildOpts.PruneTriviallyFalseEdges ||
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001010 S->isTypeDependent() || S->isValueDependent())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001011 return {};
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001012
1013 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(S)) {
1014 if (Bop->isLogicalOp()) {
1015 // Check the cache first.
NAKAMURA Takumie9ca55e2012-03-25 06:30:37 +00001016 CachedBoolEvalsTy::iterator I = CachedBoolEvals.find(S);
1017 if (I != CachedBoolEvals.end())
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001018 return I->second; // already in map;
NAKAMURA Takumif0434b02012-03-25 06:30:32 +00001019
1020 // Retrieve result at first, or the map might be updated.
1021 TryResult Result = evaluateAsBooleanConditionNoCache(S);
1022 CachedBoolEvals[S] = Result; // update or insert
1023 return Result;
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001024 }
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001025 else {
1026 switch (Bop->getOpcode()) {
1027 default: break;
1028 // For 'x & 0' and 'x * 0', we can determine that
1029 // the value is always false.
1030 case BO_Mul:
1031 case BO_And: {
1032 // If either operand is zero, we know the value
1033 // must be false.
1034 llvm::APSInt IntVal;
1035 if (Bop->getLHS()->EvaluateAsInt(IntVal, *Context)) {
David Blaikie7a3cbb22015-03-09 02:02:07 +00001036 if (!IntVal.getBoolValue()) {
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001037 return TryResult(false);
1038 }
1039 }
1040 if (Bop->getRHS()->EvaluateAsInt(IntVal, *Context)) {
David Blaikie7a3cbb22015-03-09 02:02:07 +00001041 if (!IntVal.getBoolValue()) {
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001042 return TryResult(false);
1043 }
1044 }
1045 }
1046 break;
1047 }
1048 }
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001049 }
1050
1051 return evaluateAsBooleanConditionNoCache(S);
1052 }
1053
1054 /// \brief Evaluate as boolean \param E without using the cache.
1055 TryResult evaluateAsBooleanConditionNoCache(Expr *E) {
1056 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(E)) {
1057 if (Bop->isLogicalOp()) {
1058 TryResult LHS = tryEvaluateBool(Bop->getLHS());
1059 if (LHS.isKnown()) {
1060 // We were able to evaluate the LHS, see if we can get away with not
1061 // evaluating the RHS: 0 && X -> 0, 1 || X -> 1
1062 if (LHS.isTrue() == (Bop->getOpcode() == BO_LOr))
1063 return LHS.isTrue();
1064
1065 TryResult RHS = tryEvaluateBool(Bop->getRHS());
1066 if (RHS.isKnown()) {
1067 if (Bop->getOpcode() == BO_LOr)
1068 return LHS.isTrue() || RHS.isTrue();
1069 else
1070 return LHS.isTrue() && RHS.isTrue();
1071 }
1072 } else {
1073 TryResult RHS = tryEvaluateBool(Bop->getRHS());
1074 if (RHS.isKnown()) {
1075 // We can't evaluate the LHS; however, sometimes the result
1076 // is determined by the RHS: X && 0 -> 0, X || 1 -> 1.
1077 if (RHS.isTrue() == (Bop->getOpcode() == BO_LOr))
1078 return RHS.isTrue();
Richard Trieuf935b562014-04-05 05:17:01 +00001079 } else {
1080 TryResult BopRes = checkIncorrectLogicOperator(Bop);
1081 if (BopRes.isKnown())
1082 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001083 }
1084 }
1085
Eugene Zelenko38c70522017-12-07 21:55:09 +00001086 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001087 } else if (Bop->isEqualityOp()) {
1088 TryResult BopRes = checkIncorrectEqualityOperator(Bop);
1089 if (BopRes.isKnown())
1090 return BopRes.isTrue();
1091 } else if (Bop->isRelationalOp()) {
1092 TryResult BopRes = checkIncorrectRelationalOperator(Bop);
1093 if (BopRes.isKnown())
1094 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001095 }
1096 }
1097
1098 bool Result;
1099 if (E->EvaluateAsBooleanCondition(Result, *Context))
1100 return Result;
1101
Eugene Zelenko38c70522017-12-07 21:55:09 +00001102 return {};
Mike Stump773582d2009-07-23 23:25:26 +00001103 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001104
1105 bool hasTrivialDestructor(VarDecl *VD);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00001106};
Mike Stump31feda52009-07-17 01:31:16 +00001107
Eugene Zelenko38c70522017-12-07 21:55:09 +00001108} // namespace
1109
Ted Kremeneka099c592011-03-10 03:50:34 +00001110inline bool AddStmtChoice::alwaysAdd(CFGBuilder &builder,
1111 const Stmt *stmt) const {
1112 return builder.alwaysAdd(stmt) || kind == AlwaysAdd;
1113}
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001114
Ted Kremeneka099c592011-03-10 03:50:34 +00001115bool CFGBuilder::alwaysAdd(const Stmt *stmt) {
Ted Kremenek8b46c002011-07-19 14:18:43 +00001116 bool shouldAdd = BuildOpts.alwaysAdd(stmt);
1117
Ted Kremeneka099c592011-03-10 03:50:34 +00001118 if (!BuildOpts.forcedBlkExprs)
Ted Kremenek8b46c002011-07-19 14:18:43 +00001119 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001120
1121 if (lastLookup == stmt) {
1122 if (cachedEntry) {
1123 assert(cachedEntry->first == stmt);
1124 return true;
1125 }
Ted Kremenek8b46c002011-07-19 14:18:43 +00001126 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001127 }
Ted Kremeneka099c592011-03-10 03:50:34 +00001128
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001129 lastLookup = stmt;
1130
1131 // Perform the lookup!
Ted Kremeneka099c592011-03-10 03:50:34 +00001132 CFG::BuildOptions::ForcedBlkExprs *fb = *BuildOpts.forcedBlkExprs;
1133
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001134 if (!fb) {
1135 // No need to update 'cachedEntry', since it will always be null.
Craig Topper25542942014-05-20 04:30:07 +00001136 assert(!cachedEntry);
Ted Kremenek8b46c002011-07-19 14:18:43 +00001137 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001138 }
Ted Kremeneka099c592011-03-10 03:50:34 +00001139
1140 CFG::BuildOptions::ForcedBlkExprs::iterator itr = fb->find(stmt);
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001141 if (itr == fb->end()) {
Craig Topper25542942014-05-20 04:30:07 +00001142 cachedEntry = nullptr;
Ted Kremenek8b46c002011-07-19 14:18:43 +00001143 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001144 }
1145
Ted Kremeneka099c592011-03-10 03:50:34 +00001146 cachedEntry = &*itr;
1147 return true;
Ted Kremenek7c58d352011-03-10 01:14:11 +00001148}
1149
Douglas Gregor4619e432008-12-05 23:32:09 +00001150// FIXME: Add support for dependent-sized array types in C++?
1151// Does it even make sense to build a CFG for an uninstantiated template?
John McCall424cec92011-01-19 06:33:43 +00001152static const VariableArrayType *FindVA(const Type *t) {
1153 while (const ArrayType *vt = dyn_cast<ArrayType>(t)) {
1154 if (const VariableArrayType *vat = dyn_cast<VariableArrayType>(vt))
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001155 if (vat->getSizeExpr())
1156 return vat;
Mike Stump31feda52009-07-17 01:31:16 +00001157
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001158 t = vt->getElementType().getTypePtr();
1159 }
Mike Stump31feda52009-07-17 01:31:16 +00001160
Craig Topper25542942014-05-20 04:30:07 +00001161 return nullptr;
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001162}
Mike Stump31feda52009-07-17 01:31:16 +00001163
Artem Dergachev40684812018-02-27 20:03:35 +00001164void CFGBuilder::consumeConstructionContext(
1165 const ConstructionContextLayer *Layer, CXXConstructExpr *CE) {
1166 if (const ConstructionContextLayer *PreviouslyStoredLayer =
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001167 ConstructionContextMap.lookup(CE)) {
George Burgess IVa47e1b72018-03-06 07:45:11 +00001168 (void)PreviouslyStoredLayer;
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001169 // We might have visited this child when we were finding construction
1170 // contexts within its parents.
Artem Dergachev40684812018-02-27 20:03:35 +00001171 assert(PreviouslyStoredLayer->isStrictlyMoreSpecificThan(Layer) &&
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001172 "Already within a different construction context!");
1173 } else {
Artem Dergachev40684812018-02-27 20:03:35 +00001174 ConstructionContextMap[CE] = Layer;
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001175 }
1176}
1177
Artem Dergachev783a4572018-02-23 22:20:39 +00001178void CFGBuilder::findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001179 const ConstructionContextLayer *Layer, Stmt *Child) {
Artem Dergachev41ffb302018-02-08 22:58:15 +00001180 if (!BuildOpts.AddRichCXXConstructors)
1181 return;
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001182
Artem Dergachev41ffb302018-02-08 22:58:15 +00001183 if (!Child)
1184 return;
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001185
1186 switch(Child->getStmtClass()) {
1187 case Stmt::CXXConstructExprClass:
1188 case Stmt::CXXTemporaryObjectExprClass: {
Artem Dergachev40684812018-02-27 20:03:35 +00001189 consumeConstructionContext(Layer, cast<CXXConstructExpr>(Child));
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001190 break;
1191 }
1192 case Stmt::ExprWithCleanupsClass: {
1193 auto *Cleanups = cast<ExprWithCleanups>(Child);
Artem Dergachev40684812018-02-27 20:03:35 +00001194 findConstructionContexts(Layer, Cleanups->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001195 break;
1196 }
1197 case Stmt::CXXFunctionalCastExprClass: {
1198 auto *Cast = cast<CXXFunctionalCastExpr>(Child);
Artem Dergachev40684812018-02-27 20:03:35 +00001199 findConstructionContexts(Layer, Cast->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001200 break;
1201 }
1202 case Stmt::ImplicitCastExprClass: {
1203 auto *Cast = cast<ImplicitCastExpr>(Child);
Artem Dergachev66030522018-03-01 01:09:24 +00001204 // TODO: We need to support CK_ConstructorConversion, maybe other kinds?
Artem Dergachev13f96642018-03-09 01:39:59 +00001205 switch (Cast->getCastKind()) {
1206 case CK_NoOp:
1207 case CK_ConstructorConversion:
Artem Dergachev66030522018-03-01 01:09:24 +00001208 findConstructionContexts(Layer, Cast->getSubExpr());
Artem Dergachev13f96642018-03-09 01:39:59 +00001209 default:
1210 break;
1211 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001212 break;
1213 }
1214 case Stmt::CXXBindTemporaryExprClass: {
1215 auto *BTE = cast<CXXBindTemporaryExpr>(Child);
Artem Dergachev783a4572018-02-23 22:20:39 +00001216 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001217 ConstructionContextLayer::create(cfg->getBumpVectorContext(),
1218 BTE, Layer),
Artem Dergachev783a4572018-02-23 22:20:39 +00001219 BTE->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001220 break;
1221 }
1222 case Stmt::ConditionalOperatorClass: {
1223 auto *CO = cast<ConditionalOperator>(Child);
Artem Dergachev40684812018-02-27 20:03:35 +00001224 findConstructionContexts(Layer, CO->getLHS());
1225 findConstructionContexts(Layer, CO->getRHS());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001226 break;
1227 }
1228 default:
1229 break;
Artem Dergachev41ffb302018-02-08 22:58:15 +00001230 }
1231}
1232
Artem Dergachev783a4572018-02-23 22:20:39 +00001233void CFGBuilder::cleanupConstructionContext(CXXConstructExpr *CE) {
1234 assert(BuildOpts.AddRichCXXConstructors &&
1235 "We should not be managing construction contexts!");
1236 assert(ConstructionContextMap.count(CE) &&
Artem Dergachev41ffb302018-02-08 22:58:15 +00001237 "Cannot exit construction context without the context!");
Artem Dergachev783a4572018-02-23 22:20:39 +00001238 ConstructionContextMap.erase(CE);
Artem Dergachev41ffb302018-02-08 22:58:15 +00001239}
1240
1241
Mike Stump31feda52009-07-17 01:31:16 +00001242/// BuildCFG - Constructs a CFG from an AST (a Stmt*). The AST can represent an
1243/// arbitrary statement. Examples include a single expression or a function
1244/// body (compound statement). The ownership of the returned CFG is
1245/// transferred to the caller. If CFG construction fails, this method returns
1246/// NULL.
David Blaikiee90195c2014-08-29 18:53:26 +00001247std::unique_ptr<CFG> CFGBuilder::buildCFG(const Decl *D, Stmt *Statement) {
Ted Kremenek8aed4902009-10-20 23:46:25 +00001248 assert(cfg.get());
Ted Kremenek93668002009-07-17 22:18:43 +00001249 if (!Statement)
Craig Topper25542942014-05-20 04:30:07 +00001250 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001251
Mike Stump31feda52009-07-17 01:31:16 +00001252 // Create an empty block that will serve as the exit block for the CFG. Since
1253 // this is the first block added to the CFG, it will be implicitly registered
1254 // as the exit block.
Ted Kremenek81e14852007-08-27 19:46:09 +00001255 Succ = createBlock();
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001256 assert(Succ == &cfg->getExit());
Craig Topper25542942014-05-20 04:30:07 +00001257 Block = nullptr; // the EXIT block is empty. Create all other blocks lazily.
Mike Stump31feda52009-07-17 01:31:16 +00001258
Matthias Gehre351c2182017-07-12 07:04:19 +00001259 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1260 "AddImplicitDtors and AddLifetime cannot be used at the same time");
1261
Marcin Swiderski20b88732010-10-05 05:37:00 +00001262 if (BuildOpts.AddImplicitDtors)
1263 if (const CXXDestructorDecl *DD = dyn_cast_or_null<CXXDestructorDecl>(D))
1264 addImplicitDtorsForDestructor(DD);
1265
Ted Kremenek9aae5132007-08-23 21:42:29 +00001266 // Visit the statements and create the CFG.
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001267 CFGBlock *B = addStmt(Statement);
1268
1269 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001270 return nullptr;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001271
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001272 // For C++ constructor add initializers to CFG.
1273 if (const CXXConstructorDecl *CD = dyn_cast_or_null<CXXConstructorDecl>(D)) {
Pete Cooper57d3f142015-07-30 17:22:52 +00001274 for (auto *I : llvm::reverse(CD->inits())) {
1275 B = addInitializer(I);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001276 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001277 return nullptr;
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001278 }
1279 }
1280
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001281 if (B)
1282 Succ = B;
Mike Stump6bf1c082010-01-21 02:21:40 +00001283
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001284 // Backpatch the gotos whose label -> block mappings we didn't know when we
1285 // encountered them.
1286 for (BackpatchBlocksTy::iterator I = BackpatchBlocks.begin(),
1287 E = BackpatchBlocks.end(); I != E; ++I ) {
Mike Stump31feda52009-07-17 01:31:16 +00001288
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001289 CFGBlock *B = I->block;
Rafael Espindola210de572013-03-27 15:37:54 +00001290 const GotoStmt *G = cast<GotoStmt>(B->getTerminator());
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001291 LabelMapTy::iterator LI = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00001292
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001293 // If there is no target for the goto, then we are looking at an
1294 // incomplete AST. Handle this by not registering a successor.
1295 if (LI == LabelMap.end()) continue;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001296
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001297 JumpTarget JT = LI->second;
Matthias Gehre351c2182017-07-12 07:04:19 +00001298 prependAutomaticObjLifetimeWithTerminator(B, I->scopePosition,
1299 JT.scopePosition);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001300 prependAutomaticObjDtorsWithTerminator(B, I->scopePosition,
1301 JT.scopePosition);
1302 addSuccessor(B, JT.block);
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001303 }
1304
1305 // Add successors to the Indirect Goto Dispatch block (if we have one).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001306 if (CFGBlock *B = cfg->getIndirectGotoBlock())
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001307 for (LabelSetTy::iterator I = AddressTakenLabels.begin(),
1308 E = AddressTakenLabels.end(); I != E; ++I ) {
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001309 // Lookup the target block.
1310 LabelMapTy::iterator LI = LabelMap.find(*I);
1311
1312 // If there is no target block that contains label, then we are looking
1313 // at an incomplete AST. Handle this by not registering a successor.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001314 if (LI == LabelMap.end()) continue;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001315
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001316 addSuccessor(B, LI->second.block);
Ted Kremenekeda180e22007-08-28 19:26:49 +00001317 }
Mike Stump31feda52009-07-17 01:31:16 +00001318
Mike Stump31feda52009-07-17 01:31:16 +00001319 // Create an empty entry block that has no predecessors.
Ted Kremenek5c50fd12007-09-26 21:23:31 +00001320 cfg->setEntry(createBlock());
Mike Stump31feda52009-07-17 01:31:16 +00001321
Artem Dergachev783a4572018-02-23 22:20:39 +00001322 if (BuildOpts.AddRichCXXConstructors)
1323 assert(ConstructionContextMap.empty() &&
1324 "Not all construction contexts were cleaned up!");
1325
David Blaikiee90195c2014-08-29 18:53:26 +00001326 return std::move(cfg);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001327}
Mike Stump31feda52009-07-17 01:31:16 +00001328
Ted Kremenek9aae5132007-08-23 21:42:29 +00001329/// createBlock - Used to lazily create blocks that are connected
1330/// to the current (global) succcessor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001331CFGBlock *CFGBuilder::createBlock(bool add_successor) {
1332 CFGBlock *B = cfg->createBlock();
Ted Kremenek93668002009-07-17 22:18:43 +00001333 if (add_successor && Succ)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001334 addSuccessor(B, Succ);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001335 return B;
1336}
Mike Stump31feda52009-07-17 01:31:16 +00001337
Chandler Carrutha70991b2011-09-13 09:13:49 +00001338/// createNoReturnBlock - Used to create a block is a 'noreturn' point in the
1339/// CFG. It is *not* connected to the current (global) successor, and instead
1340/// directly tied to the exit block in order to be reachable.
1341CFGBlock *CFGBuilder::createNoReturnBlock() {
1342 CFGBlock *B = createBlock(false);
Chandler Carruth75d78232011-09-13 09:53:55 +00001343 B->setHasNoReturnElement();
Ted Kremenekf3539192014-02-27 00:24:05 +00001344 addSuccessor(B, &cfg->getExit(), Succ);
Chandler Carrutha70991b2011-09-13 09:13:49 +00001345 return B;
1346}
1347
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001348/// addInitializer - Add C++ base or member initializer element to CFG.
Alexis Hunt1d792652011-01-08 20:30:50 +00001349CFGBlock *CFGBuilder::addInitializer(CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001350 if (!BuildOpts.AddInitializers)
1351 return Block;
1352
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001353 bool HasTemporaries = false;
1354
1355 // Destructors of temporaries in initialization expression should be called
1356 // after initialization finishes.
1357 Expr *Init = I->getInit();
1358 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00001359 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001360
Jordan Rose6d671cc2012-09-05 22:55:23 +00001361 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001362 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00001363 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00001364 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
1365 /*BindToTemporary=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001366 }
1367 }
1368
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001369 autoCreateBlock();
1370 appendInitializer(Block, I);
1371
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001372 if (Init) {
Artem Dergachev783a4572018-02-23 22:20:39 +00001373 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001374 ConstructionContextLayer::create(cfg->getBumpVectorContext(), I),
Artem Dergachev783a4572018-02-23 22:20:39 +00001375 Init);
Artem Dergachev5a281bb2018-02-10 02:18:04 +00001376
Ted Kremenek8219b822010-12-16 07:46:53 +00001377 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001378 // For expression with temporaries go directly to subexpression to omit
1379 // generating destructors for the second time.
Ted Kremenek8219b822010-12-16 07:46:53 +00001380 return Visit(cast<ExprWithCleanups>(Init)->getSubExpr());
1381 }
Enrico Pertosofaed8012015-06-03 10:12:40 +00001382 if (BuildOpts.AddCXXDefaultInitExprInCtors) {
1383 if (CXXDefaultInitExpr *Default = dyn_cast<CXXDefaultInitExpr>(Init)) {
1384 // In general, appending the expression wrapped by a CXXDefaultInitExpr
1385 // may cause the same Expr to appear more than once in the CFG. Doing it
1386 // here is safe because there's only one initializer per field.
1387 autoCreateBlock();
1388 appendStmt(Block, Default);
1389 if (Stmt *Child = Default->getExpr())
1390 if (CFGBlock *R = Visit(Child))
1391 Block = R;
1392 return Block;
1393 }
1394 }
Ted Kremenek8219b822010-12-16 07:46:53 +00001395 return Visit(Init);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001396 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001397
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001398 return Block;
1399}
1400
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001401/// \brief Retrieve the type of the temporary object whose lifetime was
1402/// extended by a local reference with the given initializer.
1403static QualType getReferenceInitTemporaryType(ASTContext &Context,
Richard Smithb8c0f552016-12-09 18:49:13 +00001404 const Expr *Init,
1405 bool *FoundMTE = nullptr) {
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001406 while (true) {
1407 // Skip parentheses.
1408 Init = Init->IgnoreParens();
1409
1410 // Skip through cleanups.
1411 if (const ExprWithCleanups *EWC = dyn_cast<ExprWithCleanups>(Init)) {
1412 Init = EWC->getSubExpr();
1413 continue;
1414 }
1415
1416 // Skip through the temporary-materialization expression.
1417 if (const MaterializeTemporaryExpr *MTE
1418 = dyn_cast<MaterializeTemporaryExpr>(Init)) {
1419 Init = MTE->GetTemporaryExpr();
Richard Smithb8c0f552016-12-09 18:49:13 +00001420 if (FoundMTE)
1421 *FoundMTE = true;
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001422 continue;
1423 }
1424
1425 // Skip derived-to-base and no-op casts.
1426 if (const CastExpr *CE = dyn_cast<CastExpr>(Init)) {
1427 if ((CE->getCastKind() == CK_DerivedToBase ||
1428 CE->getCastKind() == CK_UncheckedDerivedToBase ||
1429 CE->getCastKind() == CK_NoOp) &&
1430 Init->getType()->isRecordType()) {
1431 Init = CE->getSubExpr();
1432 continue;
1433 }
1434 }
1435
1436 // Skip member accesses into rvalues.
1437 if (const MemberExpr *ME = dyn_cast<MemberExpr>(Init)) {
1438 if (!ME->isArrow() && ME->getBase()->isRValue()) {
1439 Init = ME->getBase();
1440 continue;
1441 }
1442 }
1443
1444 break;
1445 }
1446
1447 return Init->getType();
1448}
Matthias Gehre351c2182017-07-12 07:04:19 +00001449
Peter Szecsi999a25f2017-08-19 11:19:16 +00001450// TODO: Support adding LoopExit element to the CFG in case where the loop is
1451// ended by ReturnStmt, GotoStmt or ThrowExpr.
1452void CFGBuilder::addLoopExit(const Stmt *LoopStmt){
1453 if(!BuildOpts.AddLoopExit)
1454 return;
1455 autoCreateBlock();
1456 appendLoopExit(Block, LoopStmt);
1457}
1458
Matthias Gehre351c2182017-07-12 07:04:19 +00001459void CFGBuilder::addAutomaticObjHandling(LocalScope::const_iterator B,
1460 LocalScope::const_iterator E,
1461 Stmt *S) {
1462 if (BuildOpts.AddImplicitDtors)
1463 addAutomaticObjDtors(B, E, S);
1464 if (BuildOpts.AddLifetime)
1465 addLifetimeEnds(B, E, S);
1466}
1467
1468/// Add to current block automatic objects that leave the scope.
1469void CFGBuilder::addLifetimeEnds(LocalScope::const_iterator B,
1470 LocalScope::const_iterator E, Stmt *S) {
1471 if (!BuildOpts.AddLifetime)
1472 return;
1473
1474 if (B == E)
1475 return;
1476
1477 // To go from B to E, one first goes up the scopes from B to P
1478 // then sideways in one scope from P to P' and then down
1479 // the scopes from P' to E.
1480 // The lifetime of all objects between B and P end.
1481 LocalScope::const_iterator P = B.shared_parent(E);
1482 int dist = B.distance(P);
1483 if (dist <= 0)
1484 return;
1485
1486 // We need to perform the scope leaving in reverse order
1487 SmallVector<VarDecl *, 10> DeclsTrivial;
1488 SmallVector<VarDecl *, 10> DeclsNonTrivial;
1489 DeclsTrivial.reserve(dist);
1490 DeclsNonTrivial.reserve(dist);
1491
1492 for (LocalScope::const_iterator I = B; I != P; ++I)
1493 if (hasTrivialDestructor(*I))
1494 DeclsTrivial.push_back(*I);
1495 else
1496 DeclsNonTrivial.push_back(*I);
1497
1498 autoCreateBlock();
1499 // object with trivial destructor end their lifetime last (when storage
1500 // duration ends)
1501 for (SmallVectorImpl<VarDecl *>::reverse_iterator I = DeclsTrivial.rbegin(),
1502 E = DeclsTrivial.rend();
1503 I != E; ++I)
1504 appendLifetimeEnds(Block, *I, S);
1505
1506 for (SmallVectorImpl<VarDecl *>::reverse_iterator
1507 I = DeclsNonTrivial.rbegin(),
1508 E = DeclsNonTrivial.rend();
1509 I != E; ++I)
1510 appendLifetimeEnds(Block, *I, S);
1511}
1512
Marcin Swiderski5e415732010-09-30 23:05:00 +00001513/// addAutomaticObjDtors - Add to current block automatic objects destructors
1514/// for objects in range of local scope positions. Use S as trigger statement
1515/// for destructors.
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001516void CFGBuilder::addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001517 LocalScope::const_iterator E, Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001518 if (!BuildOpts.AddImplicitDtors)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001519 return;
1520
Marcin Swiderski5e415732010-09-30 23:05:00 +00001521 if (B == E)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001522 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001523
Chandler Carruthad747252011-09-13 06:09:01 +00001524 // We need to append the destructors in reverse order, but any one of them
1525 // may be a no-return destructor which changes the CFG. As a result, buffer
1526 // this sequence up and replay them in reverse order when appending onto the
1527 // CFGBlock(s).
1528 SmallVector<VarDecl*, 10> Decls;
1529 Decls.reserve(B.distance(E));
1530 for (LocalScope::const_iterator I = B; I != E; ++I)
1531 Decls.push_back(*I);
1532
1533 for (SmallVectorImpl<VarDecl*>::reverse_iterator I = Decls.rbegin(),
1534 E = Decls.rend();
1535 I != E; ++I) {
1536 // If this destructor is marked as a no-return destructor, we need to
1537 // create a new block for the destructor which does not have as a successor
1538 // anything built thus far: control won't flow out of this block.
Ted Kremenek3d617732012-07-18 04:57:57 +00001539 QualType Ty = (*I)->getType();
1540 if (Ty->isReferenceType()) {
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001541 Ty = getReferenceInitTemporaryType(*Context, (*I)->getInit());
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001542 }
Ted Kremenek3d617732012-07-18 04:57:57 +00001543 Ty = Context->getBaseElementType(Ty);
1544
Richard Trieu95a192a2015-05-28 00:14:02 +00001545 if (Ty->getAsCXXRecordDecl()->isAnyDestructorNoReturn())
Chandler Carrutha70991b2011-09-13 09:13:49 +00001546 Block = createNoReturnBlock();
1547 else
Chandler Carruthad747252011-09-13 06:09:01 +00001548 autoCreateBlock();
Chandler Carruthad747252011-09-13 06:09:01 +00001549
1550 appendAutomaticObjDtor(Block, *I, S);
1551 }
Marcin Swiderski5e415732010-09-30 23:05:00 +00001552}
1553
Marcin Swiderski20b88732010-10-05 05:37:00 +00001554/// addImplicitDtorsForDestructor - Add implicit destructors generated for
1555/// base and member objects in destructor.
1556void CFGBuilder::addImplicitDtorsForDestructor(const CXXDestructorDecl *DD) {
Eugene Zelenko38c70522017-12-07 21:55:09 +00001557 assert(BuildOpts.AddImplicitDtors &&
1558 "Can be called only when dtors should be added");
Marcin Swiderski20b88732010-10-05 05:37:00 +00001559 const CXXRecordDecl *RD = DD->getParent();
1560
1561 // At the end destroy virtual base objects.
Aaron Ballman445a9392014-03-13 16:15:17 +00001562 for (const auto &VI : RD->vbases()) {
1563 const CXXRecordDecl *CD = VI.getType()->getAsCXXRecordDecl();
Marcin Swiderski20b88732010-10-05 05:37:00 +00001564 if (!CD->hasTrivialDestructor()) {
1565 autoCreateBlock();
Aaron Ballman445a9392014-03-13 16:15:17 +00001566 appendBaseDtor(Block, &VI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001567 }
1568 }
1569
1570 // Before virtual bases destroy direct base objects.
Aaron Ballman574705e2014-03-13 15:41:46 +00001571 for (const auto &BI : RD->bases()) {
1572 if (!BI.isVirtual()) {
1573 const CXXRecordDecl *CD = BI.getType()->getAsCXXRecordDecl();
David Blaikie0f2ae782012-01-24 04:51:48 +00001574 if (!CD->hasTrivialDestructor()) {
1575 autoCreateBlock();
Aaron Ballman574705e2014-03-13 15:41:46 +00001576 appendBaseDtor(Block, &BI);
David Blaikie0f2ae782012-01-24 04:51:48 +00001577 }
1578 }
Marcin Swiderski20b88732010-10-05 05:37:00 +00001579 }
1580
1581 // First destroy member objects.
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001582 for (auto *FI : RD->fields()) {
Marcin Swiderski01769902010-10-25 07:05:54 +00001583 // Check for constant size array. Set type to array element type.
1584 QualType QT = FI->getType();
1585 if (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1586 if (AT->getSize() == 0)
1587 continue;
1588 QT = AT->getElementType();
1589 }
1590
1591 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
Marcin Swiderski20b88732010-10-05 05:37:00 +00001592 if (!CD->hasTrivialDestructor()) {
1593 autoCreateBlock();
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001594 appendMemberDtor(Block, FI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001595 }
1596 }
1597}
1598
Marcin Swiderski5e415732010-09-30 23:05:00 +00001599/// createOrReuseLocalScope - If Scope is NULL create new LocalScope. Either
1600/// way return valid LocalScope object.
1601LocalScope* CFGBuilder::createOrReuseLocalScope(LocalScope* Scope) {
David Blaikiec1334cc2015-08-13 22:12:21 +00001602 if (Scope)
1603 return Scope;
1604 llvm::BumpPtrAllocator &alloc = cfg->getAllocator();
1605 return new (alloc.Allocate<LocalScope>())
1606 LocalScope(BumpVectorContext(alloc), ScopePos);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001607}
1608
1609/// addLocalScopeForStmt - Add LocalScope to local scopes tree for statement
Zhongxing Xu81714f22010-10-01 03:00:16 +00001610/// that should create implicit scope (e.g. if/else substatements).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001611void CFGBuilder::addLocalScopeForStmt(Stmt *S) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001612 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime)
Zhongxing Xu81714f22010-10-01 03:00:16 +00001613 return;
1614
Craig Topper25542942014-05-20 04:30:07 +00001615 LocalScope *Scope = nullptr;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001616
1617 // For compound statement we will be creating explicit scope.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001618 if (CompoundStmt *CS = dyn_cast<CompoundStmt>(S)) {
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001619 for (auto *BI : CS->body()) {
1620 Stmt *SI = BI->stripLabelLikeStatements();
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001621 if (DeclStmt *DS = dyn_cast<DeclStmt>(SI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001622 Scope = addLocalScopeForDeclStmt(DS, Scope);
1623 }
Zhongxing Xu81714f22010-10-01 03:00:16 +00001624 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001625 }
1626
1627 // For any other statement scope will be implicit and as such will be
1628 // interesting only for DeclStmt.
Chandler Carrutha626d642011-09-10 00:02:34 +00001629 if (DeclStmt *DS = dyn_cast<DeclStmt>(S->stripLabelLikeStatements()))
Zhongxing Xu307701e2010-10-01 03:09:09 +00001630 addLocalScopeForDeclStmt(DS);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001631}
1632
1633/// addLocalScopeForDeclStmt - Add LocalScope for declaration statement. Will
1634/// reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001635LocalScope* CFGBuilder::addLocalScopeForDeclStmt(DeclStmt *DS,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001636 LocalScope* Scope) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001637 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime)
Marcin Swiderski5e415732010-09-30 23:05:00 +00001638 return Scope;
1639
Aaron Ballman535bbcc2014-03-14 17:01:24 +00001640 for (auto *DI : DS->decls())
1641 if (VarDecl *VD = dyn_cast<VarDecl>(DI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001642 Scope = addLocalScopeForVarDecl(VD, Scope);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001643 return Scope;
1644}
1645
Matthias Gehre351c2182017-07-12 07:04:19 +00001646bool CFGBuilder::hasTrivialDestructor(VarDecl *VD) {
1647 // Check for const references bound to temporary. Set type to pointee.
1648 QualType QT = VD->getType();
1649 if (QT.getTypePtr()->isReferenceType()) {
1650 // Attempt to determine whether this declaration lifetime-extends a
1651 // temporary.
1652 //
1653 // FIXME: This is incorrect. Non-reference declarations can lifetime-extend
1654 // temporaries, and a single declaration can extend multiple temporaries.
1655 // We should look at the storage duration on each nested
1656 // MaterializeTemporaryExpr instead.
1657
1658 const Expr *Init = VD->getInit();
1659 if (!Init)
1660 return true;
1661
1662 // Lifetime-extending a temporary.
1663 bool FoundMTE = false;
1664 QT = getReferenceInitTemporaryType(*Context, Init, &FoundMTE);
1665 if (!FoundMTE)
1666 return true;
1667 }
1668
1669 // Check for constant size array. Set type to array element type.
1670 while (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1671 if (AT->getSize() == 0)
1672 return true;
1673 QT = AT->getElementType();
1674 }
1675
1676 // Check if type is a C++ class with non-trivial destructor.
1677 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
1678 return !CD->hasDefinition() || CD->hasTrivialDestructor();
1679 return true;
1680}
1681
Marcin Swiderski5e415732010-09-30 23:05:00 +00001682/// addLocalScopeForVarDecl - Add LocalScope for variable declaration. It will
1683/// create add scope for automatic objects and temporary objects bound to
1684/// const reference. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001685LocalScope* CFGBuilder::addLocalScopeForVarDecl(VarDecl *VD,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001686 LocalScope* Scope) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001687 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1688 "AddImplicitDtors and AddLifetime cannot be used at the same time");
1689 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime)
Marcin Swiderski5e415732010-09-30 23:05:00 +00001690 return Scope;
1691
1692 // Check if variable is local.
1693 switch (VD->getStorageClass()) {
1694 case SC_None:
1695 case SC_Auto:
1696 case SC_Register:
1697 break;
1698 default: return Scope;
1699 }
1700
Matthias Gehre351c2182017-07-12 07:04:19 +00001701 if (BuildOpts.AddImplicitDtors) {
1702 if (!hasTrivialDestructor(VD)) {
Zhongxing Xu614e17d2010-10-05 08:38:06 +00001703 // Add the variable to scope
1704 Scope = createOrReuseLocalScope(Scope);
1705 Scope->addVar(VD);
1706 ScopePos = Scope->begin();
1707 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001708 return Scope;
1709 }
1710
1711 assert(BuildOpts.AddLifetime);
1712 // Add the variable to scope
1713 Scope = createOrReuseLocalScope(Scope);
1714 Scope->addVar(VD);
1715 ScopePos = Scope->begin();
Marcin Swiderski5e415732010-09-30 23:05:00 +00001716 return Scope;
1717}
1718
1719/// addLocalScopeAndDtors - For given statement add local scope for it and
1720/// add destructors that will cleanup the scope. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001721void CFGBuilder::addLocalScopeAndDtors(Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001722 LocalScope::const_iterator scopeBeginPos = ScopePos;
Zhongxing Xu81714f22010-10-01 03:00:16 +00001723 addLocalScopeForStmt(S);
Matthias Gehre351c2182017-07-12 07:04:19 +00001724 addAutomaticObjHandling(ScopePos, scopeBeginPos, S);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001725}
1726
Marcin Swiderski321a7072010-09-30 22:54:37 +00001727/// prependAutomaticObjDtorsWithTerminator - Prepend destructor CFGElements for
1728/// variables with automatic storage duration to CFGBlock's elements vector.
1729/// Elements will be prepended to physical beginning of the vector which
1730/// happens to be logical end. Use blocks terminator as statement that specifies
1731/// destructors call site.
Chandler Carruthad747252011-09-13 06:09:01 +00001732/// FIXME: This mechanism for adding automatic destructors doesn't handle
1733/// no-return destructors properly.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001734void CFGBuilder::prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +00001735 LocalScope::const_iterator B, LocalScope::const_iterator E) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001736 if (!BuildOpts.AddImplicitDtors)
1737 return;
Chandler Carruthad747252011-09-13 06:09:01 +00001738 BumpVectorContext &C = cfg->getBumpVectorContext();
1739 CFGBlock::iterator InsertPos
1740 = Blk->beginAutomaticObjDtorsInsert(Blk->end(), B.distance(E), C);
1741 for (LocalScope::const_iterator I = B; I != E; ++I)
1742 InsertPos = Blk->insertAutomaticObjDtor(InsertPos, *I,
1743 Blk->getTerminator());
Marcin Swiderski321a7072010-09-30 22:54:37 +00001744}
1745
Matthias Gehre351c2182017-07-12 07:04:19 +00001746/// prependAutomaticObjLifetimeWithTerminator - Prepend lifetime CFGElements for
1747/// variables with automatic storage duration to CFGBlock's elements vector.
1748/// Elements will be prepended to physical beginning of the vector which
1749/// happens to be logical end. Use blocks terminator as statement that specifies
1750/// where lifetime ends.
1751void CFGBuilder::prependAutomaticObjLifetimeWithTerminator(
1752 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) {
1753 if (!BuildOpts.AddLifetime)
1754 return;
1755 BumpVectorContext &C = cfg->getBumpVectorContext();
1756 CFGBlock::iterator InsertPos =
1757 Blk->beginLifetimeEndsInsert(Blk->end(), B.distance(E), C);
1758 for (LocalScope::const_iterator I = B; I != E; ++I)
1759 InsertPos = Blk->insertLifetimeEnds(InsertPos, *I, Blk->getTerminator());
1760}
Eugene Zelenko38c70522017-12-07 21:55:09 +00001761
Ted Kremenek93668002009-07-17 22:18:43 +00001762/// Visit - Walk the subtree of a statement and add extra
Mike Stump31feda52009-07-17 01:31:16 +00001763/// blocks for ternary operators, &&, and ||. We also process "," and
1764/// DeclStmts (which may contain nested control-flow).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001765CFGBlock *CFGBuilder::Visit(Stmt * S, AddStmtChoice asc) {
Ted Kremenekbc1416d2010-04-30 22:25:53 +00001766 if (!S) {
1767 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00001768 return nullptr;
Ted Kremenekbc1416d2010-04-30 22:25:53 +00001769 }
Jordy Rose17347372011-06-10 08:49:37 +00001770
1771 if (Expr *E = dyn_cast<Expr>(S))
1772 S = E->IgnoreParens();
1773
Ted Kremenek93668002009-07-17 22:18:43 +00001774 switch (S->getStmtClass()) {
1775 default:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001776 return VisitStmt(S, asc);
Ted Kremenek93668002009-07-17 22:18:43 +00001777
1778 case Stmt::AddrLabelExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001779 return VisitAddrLabelExpr(cast<AddrLabelExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001780
John McCallc07a0c72011-02-17 10:25:35 +00001781 case Stmt::BinaryConditionalOperatorClass:
1782 return VisitConditionalOperator(cast<BinaryConditionalOperator>(S), asc);
1783
Ted Kremenek93668002009-07-17 22:18:43 +00001784 case Stmt::BinaryOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001785 return VisitBinaryOperator(cast<BinaryOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001786
Ted Kremenek93668002009-07-17 22:18:43 +00001787 case Stmt::BlockExprClass:
Devin Coughlinb6029b72015-11-25 22:35:37 +00001788 return VisitBlockExpr(cast<BlockExpr>(S), asc);
Ted Kremenek93668002009-07-17 22:18:43 +00001789
Ted Kremenek93668002009-07-17 22:18:43 +00001790 case Stmt::BreakStmtClass:
1791 return VisitBreakStmt(cast<BreakStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001792
Ted Kremenek93668002009-07-17 22:18:43 +00001793 case Stmt::CallExprClass:
Ted Kremenek128d04d2010-08-31 18:47:34 +00001794 case Stmt::CXXOperatorCallExprClass:
John McCallc67067f2011-05-11 07:19:11 +00001795 case Stmt::CXXMemberCallExprClass:
Richard Smithc67fdd42012-03-07 08:35:16 +00001796 case Stmt::UserDefinedLiteralClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001797 return VisitCallExpr(cast<CallExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001798
Ted Kremenek93668002009-07-17 22:18:43 +00001799 case Stmt::CaseStmtClass:
1800 return VisitCaseStmt(cast<CaseStmt>(S));
1801
1802 case Stmt::ChooseExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001803 return VisitChooseExpr(cast<ChooseExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001804
Ted Kremenek93668002009-07-17 22:18:43 +00001805 case Stmt::CompoundStmtClass:
1806 return VisitCompoundStmt(cast<CompoundStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001807
Ted Kremenek93668002009-07-17 22:18:43 +00001808 case Stmt::ConditionalOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001809 return VisitConditionalOperator(cast<ConditionalOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001810
Ted Kremenek93668002009-07-17 22:18:43 +00001811 case Stmt::ContinueStmtClass:
1812 return VisitContinueStmt(cast<ContinueStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001813
Ted Kremenekb27378c2010-01-19 20:40:33 +00001814 case Stmt::CXXCatchStmtClass:
1815 return VisitCXXCatchStmt(cast<CXXCatchStmt>(S));
1816
John McCall5d413782010-12-06 08:20:24 +00001817 case Stmt::ExprWithCleanupsClass:
1818 return VisitExprWithCleanups(cast<ExprWithCleanups>(S), asc);
Ted Kremenek82bfc862010-08-28 00:19:02 +00001819
Jordan Rosee5d53932012-08-23 18:10:53 +00001820 case Stmt::CXXDefaultArgExprClass:
Richard Smith852c9db2013-04-20 22:23:05 +00001821 case Stmt::CXXDefaultInitExprClass:
Jordan Rosee5d53932012-08-23 18:10:53 +00001822 // FIXME: The expression inside a CXXDefaultArgExpr is owned by the
1823 // called function's declaration, not by the caller. If we simply add
1824 // this expression to the CFG, we could end up with the same Expr
1825 // appearing multiple times.
1826 // PR13385 / <rdar://problem/12156507>
Richard Smith852c9db2013-04-20 22:23:05 +00001827 //
1828 // It's likewise possible for multiple CXXDefaultInitExprs for the same
1829 // expression to be used in the same function (through aggregate
1830 // initialization).
Jordan Rosee5d53932012-08-23 18:10:53 +00001831 return VisitStmt(S, asc);
1832
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00001833 case Stmt::CXXBindTemporaryExprClass:
1834 return VisitCXXBindTemporaryExpr(cast<CXXBindTemporaryExpr>(S), asc);
1835
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00001836 case Stmt::CXXConstructExprClass:
1837 return VisitCXXConstructExpr(cast<CXXConstructExpr>(S), asc);
1838
Jordan Rosec9176072014-01-13 17:59:19 +00001839 case Stmt::CXXNewExprClass:
1840 return VisitCXXNewExpr(cast<CXXNewExpr>(S), asc);
1841
Jordan Rosed2f40792013-09-03 17:00:57 +00001842 case Stmt::CXXDeleteExprClass:
1843 return VisitCXXDeleteExpr(cast<CXXDeleteExpr>(S), asc);
1844
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00001845 case Stmt::CXXFunctionalCastExprClass:
1846 return VisitCXXFunctionalCastExpr(cast<CXXFunctionalCastExpr>(S), asc);
1847
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00001848 case Stmt::CXXTemporaryObjectExprClass:
1849 return VisitCXXTemporaryObjectExpr(cast<CXXTemporaryObjectExpr>(S), asc);
1850
Ted Kremenekb27378c2010-01-19 20:40:33 +00001851 case Stmt::CXXThrowExprClass:
1852 return VisitCXXThrowExpr(cast<CXXThrowExpr>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00001853
Ted Kremenekb27378c2010-01-19 20:40:33 +00001854 case Stmt::CXXTryStmtClass:
1855 return VisitCXXTryStmt(cast<CXXTryStmt>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00001856
Richard Smith02e85f32011-04-14 22:09:26 +00001857 case Stmt::CXXForRangeStmtClass:
1858 return VisitCXXForRangeStmt(cast<CXXForRangeStmt>(S));
1859
Ted Kremenek93668002009-07-17 22:18:43 +00001860 case Stmt::DeclStmtClass:
1861 return VisitDeclStmt(cast<DeclStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001862
Ted Kremenek93668002009-07-17 22:18:43 +00001863 case Stmt::DefaultStmtClass:
1864 return VisitDefaultStmt(cast<DefaultStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001865
Ted Kremenek93668002009-07-17 22:18:43 +00001866 case Stmt::DoStmtClass:
1867 return VisitDoStmt(cast<DoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001868
Ted Kremenek93668002009-07-17 22:18:43 +00001869 case Stmt::ForStmtClass:
1870 return VisitForStmt(cast<ForStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001871
Ted Kremenek93668002009-07-17 22:18:43 +00001872 case Stmt::GotoStmtClass:
1873 return VisitGotoStmt(cast<GotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001874
Ted Kremenek93668002009-07-17 22:18:43 +00001875 case Stmt::IfStmtClass:
1876 return VisitIfStmt(cast<IfStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001877
Ted Kremenek8219b822010-12-16 07:46:53 +00001878 case Stmt::ImplicitCastExprClass:
1879 return VisitImplicitCastExpr(cast<ImplicitCastExpr>(S), asc);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00001880
Ted Kremenek93668002009-07-17 22:18:43 +00001881 case Stmt::IndirectGotoStmtClass:
1882 return VisitIndirectGotoStmt(cast<IndirectGotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001883
Ted Kremenek93668002009-07-17 22:18:43 +00001884 case Stmt::LabelStmtClass:
1885 return VisitLabelStmt(cast<LabelStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001886
Ted Kremenekda76a942012-04-12 20:34:52 +00001887 case Stmt::LambdaExprClass:
1888 return VisitLambdaExpr(cast<LambdaExpr>(S), asc);
1889
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00001890 case Stmt::MaterializeTemporaryExprClass:
1891 return VisitMaterializeTemporaryExpr(cast<MaterializeTemporaryExpr>(S),
1892 asc);
1893
Ted Kremenek5868ec62010-04-11 17:02:10 +00001894 case Stmt::MemberExprClass:
1895 return VisitMemberExpr(cast<MemberExpr>(S), asc);
1896
Ted Kremenek04268232011-11-05 00:10:15 +00001897 case Stmt::NullStmtClass:
1898 return Block;
1899
Ted Kremenek93668002009-07-17 22:18:43 +00001900 case Stmt::ObjCAtCatchStmtClass:
Mike Stump11289f42009-09-09 15:08:12 +00001901 return VisitObjCAtCatchStmt(cast<ObjCAtCatchStmt>(S));
1902
Ted Kremenek5022f1d2012-03-06 23:40:47 +00001903 case Stmt::ObjCAutoreleasePoolStmtClass:
1904 return VisitObjCAutoreleasePoolStmt(cast<ObjCAutoreleasePoolStmt>(S));
1905
Ted Kremenek93668002009-07-17 22:18:43 +00001906 case Stmt::ObjCAtSynchronizedStmtClass:
1907 return VisitObjCAtSynchronizedStmt(cast<ObjCAtSynchronizedStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001908
Ted Kremenek93668002009-07-17 22:18:43 +00001909 case Stmt::ObjCAtThrowStmtClass:
1910 return VisitObjCAtThrowStmt(cast<ObjCAtThrowStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001911
Ted Kremenek93668002009-07-17 22:18:43 +00001912 case Stmt::ObjCAtTryStmtClass:
1913 return VisitObjCAtTryStmt(cast<ObjCAtTryStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001914
Ted Kremenek93668002009-07-17 22:18:43 +00001915 case Stmt::ObjCForCollectionStmtClass:
1916 return VisitObjCForCollectionStmt(cast<ObjCForCollectionStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001917
Ted Kremenek04268232011-11-05 00:10:15 +00001918 case Stmt::OpaqueValueExprClass:
Ted Kremenek93668002009-07-17 22:18:43 +00001919 return Block;
Mike Stump11289f42009-09-09 15:08:12 +00001920
John McCallfe96e0b2011-11-06 09:01:30 +00001921 case Stmt::PseudoObjectExprClass:
1922 return VisitPseudoObjectExpr(cast<PseudoObjectExpr>(S));
1923
Ted Kremenek93668002009-07-17 22:18:43 +00001924 case Stmt::ReturnStmtClass:
1925 return VisitReturnStmt(cast<ReturnStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001926
Nico Weber699670e2017-08-23 15:33:16 +00001927 case Stmt::SEHExceptStmtClass:
1928 return VisitSEHExceptStmt(cast<SEHExceptStmt>(S));
1929
1930 case Stmt::SEHFinallyStmtClass:
1931 return VisitSEHFinallyStmt(cast<SEHFinallyStmt>(S));
1932
1933 case Stmt::SEHLeaveStmtClass:
1934 return VisitSEHLeaveStmt(cast<SEHLeaveStmt>(S));
1935
1936 case Stmt::SEHTryStmtClass:
1937 return VisitSEHTryStmt(cast<SEHTryStmt>(S));
1938
Peter Collingbournee190dee2011-03-11 19:24:49 +00001939 case Stmt::UnaryExprOrTypeTraitExprClass:
1940 return VisitUnaryExprOrTypeTraitExpr(cast<UnaryExprOrTypeTraitExpr>(S),
1941 asc);
Mike Stump11289f42009-09-09 15:08:12 +00001942
Ted Kremenek93668002009-07-17 22:18:43 +00001943 case Stmt::StmtExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001944 return VisitStmtExpr(cast<StmtExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001945
Ted Kremenek93668002009-07-17 22:18:43 +00001946 case Stmt::SwitchStmtClass:
1947 return VisitSwitchStmt(cast<SwitchStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001948
Zhanyong Wan6dace612010-11-22 08:45:56 +00001949 case Stmt::UnaryOperatorClass:
1950 return VisitUnaryOperator(cast<UnaryOperator>(S), asc);
1951
Ted Kremenek93668002009-07-17 22:18:43 +00001952 case Stmt::WhileStmtClass:
1953 return VisitWhileStmt(cast<WhileStmt>(S));
1954 }
1955}
Mike Stump11289f42009-09-09 15:08:12 +00001956
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001957CFGBlock *CFGBuilder::VisitStmt(Stmt *S, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00001958 if (asc.alwaysAdd(*this, S)) {
Ted Kremenek93668002009-07-17 22:18:43 +00001959 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001960 appendStmt(Block, S);
Mike Stump31feda52009-07-17 01:31:16 +00001961 }
Mike Stump11289f42009-09-09 15:08:12 +00001962
Ted Kremenek93668002009-07-17 22:18:43 +00001963 return VisitChildren(S);
Ted Kremenek9e248872007-08-27 21:27:44 +00001964}
Mike Stump31feda52009-07-17 01:31:16 +00001965
Ted Kremenek93668002009-07-17 22:18:43 +00001966/// VisitChildren - Visit the children of a Stmt.
Ted Kremenek8ae67872013-02-05 22:00:19 +00001967CFGBlock *CFGBuilder::VisitChildren(Stmt *S) {
1968 CFGBlock *B = Block;
Ted Kremenek828f6312011-02-21 22:11:26 +00001969
Ted Kremenek8ae67872013-02-05 22:00:19 +00001970 // Visit the children in their reverse order so that they appear in
1971 // left-to-right (natural) order in the CFG.
1972 reverse_children RChildren(S);
1973 for (reverse_children::iterator I = RChildren.begin(), E = RChildren.end();
1974 I != E; ++I) {
1975 if (Stmt *Child = *I)
1976 if (CFGBlock *R = Visit(Child))
1977 B = R;
1978 }
1979 return B;
Ted Kremenek9e248872007-08-27 21:27:44 +00001980}
Mike Stump11289f42009-09-09 15:08:12 +00001981
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001982CFGBlock *CFGBuilder::VisitAddrLabelExpr(AddrLabelExpr *A,
1983 AddStmtChoice asc) {
Ted Kremenek93668002009-07-17 22:18:43 +00001984 AddressTakenLabels.insert(A->getLabel());
Ted Kremenek9e248872007-08-27 21:27:44 +00001985
Ted Kremenek7c58d352011-03-10 01:14:11 +00001986 if (asc.alwaysAdd(*this, A)) {
Ted Kremenek93668002009-07-17 22:18:43 +00001987 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001988 appendStmt(Block, A);
Ted Kremenek93668002009-07-17 22:18:43 +00001989 }
Ted Kremenek81e14852007-08-27 19:46:09 +00001990
Ted Kremenek9aae5132007-08-23 21:42:29 +00001991 return Block;
1992}
Mike Stump11289f42009-09-09 15:08:12 +00001993
Zhanyong Wan6dace612010-11-22 08:45:56 +00001994CFGBlock *CFGBuilder::VisitUnaryOperator(UnaryOperator *U,
Ted Kremenek8219b822010-12-16 07:46:53 +00001995 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00001996 if (asc.alwaysAdd(*this, U)) {
Zhanyong Wan6dace612010-11-22 08:45:56 +00001997 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001998 appendStmt(Block, U);
Zhanyong Wan6dace612010-11-22 08:45:56 +00001999 }
2000
Ted Kremenek8219b822010-12-16 07:46:53 +00002001 return Visit(U->getSubExpr(), AddStmtChoice());
Zhanyong Wan6dace612010-11-22 08:45:56 +00002002}
2003
Ted Kremeneka16436f2012-07-14 05:04:06 +00002004CFGBlock *CFGBuilder::VisitLogicalOperator(BinaryOperator *B) {
2005 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
2006 appendStmt(ConfluenceBlock, B);
Mike Stump11289f42009-09-09 15:08:12 +00002007
Ted Kremeneka16436f2012-07-14 05:04:06 +00002008 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002009 return nullptr;
Ted Kremeneka16436f2012-07-14 05:04:06 +00002010
Craig Topper25542942014-05-20 04:30:07 +00002011 return VisitLogicalOperator(B, nullptr, ConfluenceBlock,
2012 ConfluenceBlock).first;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002013}
2014
2015std::pair<CFGBlock*, CFGBlock*>
2016CFGBuilder::VisitLogicalOperator(BinaryOperator *B,
2017 Stmt *Term,
2018 CFGBlock *TrueBlock,
2019 CFGBlock *FalseBlock) {
Ted Kremenekb50e7162012-07-14 05:04:10 +00002020 // Introspect the RHS. If it is a nested logical operation, we recursively
2021 // build the CFG using this function. Otherwise, resort to default
2022 // CFG construction behavior.
2023 Expr *RHS = B->getRHS()->IgnoreParens();
2024 CFGBlock *RHSBlock, *ExitBlock;
2025
2026 do {
2027 if (BinaryOperator *B_RHS = dyn_cast<BinaryOperator>(RHS))
2028 if (B_RHS->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00002029 std::tie(RHSBlock, ExitBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00002030 VisitLogicalOperator(B_RHS, Term, TrueBlock, FalseBlock);
2031 break;
2032 }
2033
2034 // The RHS is not a nested logical operation. Don't push the terminator
2035 // down further, but instead visit RHS and construct the respective
2036 // pieces of the CFG, and link up the RHSBlock with the terminator
2037 // we have been provided.
2038 ExitBlock = RHSBlock = createBlock(false);
2039
Richard Trieu6a6af522017-01-04 00:46:30 +00002040 // Even though KnownVal is only used in the else branch of the next
2041 // conditional, tryEvaluateBool performs additional checking on the
2042 // Expr, so it should be called unconditionally.
2043 TryResult KnownVal = tryEvaluateBool(RHS);
2044 if (!KnownVal.isKnown())
2045 KnownVal = tryEvaluateBool(B);
2046
Ted Kremenekb50e7162012-07-14 05:04:10 +00002047 if (!Term) {
2048 assert(TrueBlock == FalseBlock);
2049 addSuccessor(RHSBlock, TrueBlock);
2050 }
2051 else {
2052 RHSBlock->setTerminator(Term);
Ted Kremenek782f0032014-03-07 02:25:53 +00002053 addSuccessor(RHSBlock, TrueBlock, !KnownVal.isFalse());
2054 addSuccessor(RHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremenekb50e7162012-07-14 05:04:10 +00002055 }
2056
2057 Block = RHSBlock;
2058 RHSBlock = addStmt(RHS);
2059 }
2060 while (false);
2061
2062 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002063 return std::make_pair(nullptr, nullptr);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002064
2065 // Generate the blocks for evaluating the LHS.
2066 Expr *LHS = B->getLHS()->IgnoreParens();
2067
2068 if (BinaryOperator *B_LHS = dyn_cast<BinaryOperator>(LHS))
2069 if (B_LHS->isLogicalOp()) {
2070 if (B->getOpcode() == BO_LOr)
2071 FalseBlock = RHSBlock;
2072 else
2073 TrueBlock = RHSBlock;
2074
2075 // For the LHS, treat 'B' as the terminator that we want to sink
2076 // into the nested branch. The RHS always gets the top-most
2077 // terminator.
2078 return VisitLogicalOperator(B_LHS, B, TrueBlock, FalseBlock);
2079 }
2080
2081 // Create the block evaluating the LHS.
2082 // This contains the '&&' or '||' as the terminator.
Ted Kremeneka16436f2012-07-14 05:04:06 +00002083 CFGBlock *LHSBlock = createBlock(false);
2084 LHSBlock->setTerminator(B);
2085
Ted Kremeneka16436f2012-07-14 05:04:06 +00002086 Block = LHSBlock;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002087 CFGBlock *EntryLHSBlock = addStmt(LHS);
2088
2089 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002090 return std::make_pair(nullptr, nullptr);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002091
2092 // See if this is a known constant.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002093 TryResult KnownVal = tryEvaluateBool(LHS);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002094
2095 // Now link the LHSBlock with RHSBlock.
2096 if (B->getOpcode() == BO_LOr) {
Ted Kremenek782f0032014-03-07 02:25:53 +00002097 addSuccessor(LHSBlock, TrueBlock, !KnownVal.isFalse());
2098 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002099 } else {
2100 assert(B->getOpcode() == BO_LAnd);
Ted Kremenek782f0032014-03-07 02:25:53 +00002101 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isFalse());
2102 addSuccessor(LHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002103 }
2104
Ted Kremenekb50e7162012-07-14 05:04:10 +00002105 return std::make_pair(EntryLHSBlock, ExitBlock);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002106}
2107
2108CFGBlock *CFGBuilder::VisitBinaryOperator(BinaryOperator *B,
2109 AddStmtChoice asc) {
2110 // && or ||
2111 if (B->isLogicalOp())
2112 return VisitLogicalOperator(B);
2113
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002114 if (B->getOpcode() == BO_Comma) { // ,
Ted Kremenekfe9b7682009-07-17 22:57:50 +00002115 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002116 appendStmt(Block, B);
Ted Kremenek93668002009-07-17 22:18:43 +00002117 addStmt(B->getRHS());
2118 return addStmt(B->getLHS());
2119 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002120
2121 if (B->isAssignmentOp()) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002122 if (asc.alwaysAdd(*this, B)) {
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002123 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002124 appendStmt(Block, B);
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002125 }
Ted Kremenek8219b822010-12-16 07:46:53 +00002126 Visit(B->getLHS());
Marcin Swiderski77232492010-10-24 08:21:40 +00002127 return Visit(B->getRHS());
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002128 }
Mike Stump11289f42009-09-09 15:08:12 +00002129
Ted Kremenek7c58d352011-03-10 01:14:11 +00002130 if (asc.alwaysAdd(*this, B)) {
Marcin Swiderski77232492010-10-24 08:21:40 +00002131 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002132 appendStmt(Block, B);
Marcin Swiderski77232492010-10-24 08:21:40 +00002133 }
2134
Zhongxing Xud95ccd52010-10-27 03:23:10 +00002135 CFGBlock *RBlock = Visit(B->getRHS());
2136 CFGBlock *LBlock = Visit(B->getLHS());
2137 // If visiting RHS causes us to finish 'Block', e.g. the RHS is a StmtExpr
2138 // containing a DoStmt, and the LHS doesn't create a new block, then we should
2139 // return RBlock. Otherwise we'll incorrectly return NULL.
2140 return (LBlock ? LBlock : RBlock);
Ted Kremenek93668002009-07-17 22:18:43 +00002141}
2142
Ted Kremeneke2499842012-04-12 20:03:44 +00002143CFGBlock *CFGBuilder::VisitNoRecurse(Expr *E, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002144 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek470bfa42009-11-25 01:34:30 +00002145 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002146 appendStmt(Block, E);
Ted Kremenek470bfa42009-11-25 01:34:30 +00002147 }
2148 return Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002149}
2150
Ted Kremenek93668002009-07-17 22:18:43 +00002151CFGBlock *CFGBuilder::VisitBreakStmt(BreakStmt *B) {
2152 // "break" is a control-flow statement. Thus we stop processing the current
2153 // block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002154 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002155 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002156
Ted Kremenek93668002009-07-17 22:18:43 +00002157 // Now create a new block that ends with the break statement.
2158 Block = createBlock(false);
2159 Block->setTerminator(B);
Mike Stump11289f42009-09-09 15:08:12 +00002160
Ted Kremenek93668002009-07-17 22:18:43 +00002161 // If there is no target for the break, then we are looking at an incomplete
2162 // AST. This means that the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002163 if (BreakJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00002164 addAutomaticObjHandling(ScopePos, BreakJumpTarget.scopePosition, B);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002165 addSuccessor(Block, BreakJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002166 } else
Ted Kremenek93668002009-07-17 22:18:43 +00002167 badCFG = true;
Mike Stump11289f42009-09-09 15:08:12 +00002168
Ted Kremenek9aae5132007-08-23 21:42:29 +00002169 return Block;
2170}
Mike Stump11289f42009-09-09 15:08:12 +00002171
Sebastian Redl31ad7542011-03-13 17:09:40 +00002172static bool CanThrow(Expr *E, ASTContext &Ctx) {
Mike Stump04c68512010-01-21 15:20:48 +00002173 QualType Ty = E->getType();
2174 if (Ty->isFunctionPointerType())
2175 Ty = Ty->getAs<PointerType>()->getPointeeType();
2176 else if (Ty->isBlockPointerType())
2177 Ty = Ty->getAs<BlockPointerType>()->getPointeeType();
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002178
Mike Stump04c68512010-01-21 15:20:48 +00002179 const FunctionType *FT = Ty->getAs<FunctionType>();
2180 if (FT) {
2181 if (const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(FT))
Richard Smithd3b5c9082012-07-27 04:22:15 +00002182 if (!isUnresolvedExceptionSpec(Proto->getExceptionSpecType()) &&
Richard Smithf623c962012-04-17 00:58:00 +00002183 Proto->isNothrow(Ctx))
Mike Stump04c68512010-01-21 15:20:48 +00002184 return false;
2185 }
2186 return true;
2187}
2188
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002189CFGBlock *CFGBuilder::VisitCallExpr(CallExpr *C, AddStmtChoice asc) {
John McCallc67067f2011-05-11 07:19:11 +00002190 // Compute the callee type.
2191 QualType calleeType = C->getCallee()->getType();
2192 if (calleeType == Context->BoundMemberTy) {
2193 QualType boundType = Expr::findBoundMemberType(C->getCallee());
2194
2195 // We should only get a null bound type if processing a dependent
2196 // CFG. Recover by assuming nothing.
2197 if (!boundType.isNull()) calleeType = boundType;
Ted Kremenek93668002009-07-17 22:18:43 +00002198 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002199
John McCallc67067f2011-05-11 07:19:11 +00002200 // If this is a call to a no-return function, this stops the block here.
2201 bool NoReturn = getFunctionExtInfo(*calleeType).getNoReturn();
2202
Mike Stump04c68512010-01-21 15:20:48 +00002203 bool AddEHEdge = false;
Mike Stump92244b02010-01-19 22:00:14 +00002204
2205 // Languages without exceptions are assumed to not throw.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002206 if (Context->getLangOpts().Exceptions) {
Ted Kremeneke97b1eb2010-09-14 23:41:16 +00002207 if (BuildOpts.AddEHEdges)
Mike Stump04c68512010-01-21 15:20:48 +00002208 AddEHEdge = true;
Mike Stump92244b02010-01-19 22:00:14 +00002209 }
2210
Jordan Rose5374c072013-08-19 16:27:28 +00002211 // If this is a call to a builtin function, it might not actually evaluate
2212 // its arguments. Don't add them to the CFG if this is the case.
2213 bool OmitArguments = false;
2214
Mike Stump92244b02010-01-19 22:00:14 +00002215 if (FunctionDecl *FD = C->getDirectCallee()) {
Nico Weber758fbac2018-02-13 21:31:47 +00002216 if (FD->isNoReturn() || C->isBuiltinAssumeFalse(*Context))
Mike Stump8c5d7992009-07-25 21:26:53 +00002217 NoReturn = true;
Mike Stump92244b02010-01-19 22:00:14 +00002218 if (FD->hasAttr<NoThrowAttr>())
Mike Stump04c68512010-01-21 15:20:48 +00002219 AddEHEdge = false;
Jordan Rose5374c072013-08-19 16:27:28 +00002220 if (FD->getBuiltinID() == Builtin::BI__builtin_object_size)
2221 OmitArguments = true;
Mike Stump92244b02010-01-19 22:00:14 +00002222 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002223
Sebastian Redl31ad7542011-03-13 17:09:40 +00002224 if (!CanThrow(C->getCallee(), *Context))
Mike Stump04c68512010-01-21 15:20:48 +00002225 AddEHEdge = false;
2226
Jordan Rose5374c072013-08-19 16:27:28 +00002227 if (OmitArguments) {
2228 assert(!NoReturn && "noreturn calls with unevaluated args not implemented");
2229 assert(!AddEHEdge && "EH calls with unevaluated args not implemented");
2230 autoCreateBlock();
2231 appendStmt(Block, C);
2232 return Visit(C->getCallee());
2233 }
2234
2235 if (!NoReturn && !AddEHEdge) {
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002236 return VisitStmt(C, asc.withAlwaysAdd(true));
Jordan Rose5374c072013-08-19 16:27:28 +00002237 }
Mike Stump11289f42009-09-09 15:08:12 +00002238
Mike Stump92244b02010-01-19 22:00:14 +00002239 if (Block) {
2240 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002241 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002242 return nullptr;
Mike Stump92244b02010-01-19 22:00:14 +00002243 }
Mike Stump11289f42009-09-09 15:08:12 +00002244
Chandler Carrutha70991b2011-09-13 09:13:49 +00002245 if (NoReturn)
2246 Block = createNoReturnBlock();
2247 else
2248 Block = createBlock();
2249
Ted Kremenek2866bab2011-03-10 01:14:08 +00002250 appendStmt(Block, C);
Mike Stump8c5d7992009-07-25 21:26:53 +00002251
Mike Stump04c68512010-01-21 15:20:48 +00002252 if (AddEHEdge) {
Mike Stump92244b02010-01-19 22:00:14 +00002253 // Add exceptional edges.
2254 if (TryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002255 addSuccessor(Block, TryTerminatedBlock);
Mike Stump92244b02010-01-19 22:00:14 +00002256 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002257 addSuccessor(Block, &cfg->getExit());
Mike Stump92244b02010-01-19 22:00:14 +00002258 }
Mike Stump11289f42009-09-09 15:08:12 +00002259
Mike Stump8c5d7992009-07-25 21:26:53 +00002260 return VisitChildren(C);
Ted Kremenek93668002009-07-17 22:18:43 +00002261}
Ted Kremenek9aae5132007-08-23 21:42:29 +00002262
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002263CFGBlock *CFGBuilder::VisitChooseExpr(ChooseExpr *C,
2264 AddStmtChoice asc) {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002265 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002266 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002267 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002268 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002269
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002270 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek21822592009-07-17 18:20:32 +00002271 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002272 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002273 CFGBlock *LHSBlock = Visit(C->getLHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002274 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002275 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002276
Ted Kremenek21822592009-07-17 18:20:32 +00002277 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002278 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002279 CFGBlock *RHSBlock = Visit(C->getRHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002280 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002281 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002282
Ted Kremenek21822592009-07-17 18:20:32 +00002283 Block = createBlock(false);
Mike Stump773582d2009-07-23 23:25:26 +00002284 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002285 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Craig Topper25542942014-05-20 04:30:07 +00002286 addSuccessor(Block, KnownVal.isFalse() ? nullptr : LHSBlock);
2287 addSuccessor(Block, KnownVal.isTrue() ? nullptr : RHSBlock);
Ted Kremenek21822592009-07-17 18:20:32 +00002288 Block->setTerminator(C);
Mike Stump11289f42009-09-09 15:08:12 +00002289 return addStmt(C->getCond());
Ted Kremenek21822592009-07-17 18:20:32 +00002290}
Mike Stump11289f42009-09-09 15:08:12 +00002291
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002292CFGBlock *CFGBuilder::VisitCompoundStmt(CompoundStmt *C) {
Matthias Gehre09a134e2015-11-14 00:36:50 +00002293 LocalScope::const_iterator scopeBeginPos = ScopePos;
Matthias Gehre351c2182017-07-12 07:04:19 +00002294 addLocalScopeForStmt(C);
2295
Matthias Gehre09a134e2015-11-14 00:36:50 +00002296 if (!C->body_empty() && !isa<ReturnStmt>(*C->body_rbegin())) {
Richard Smitha547eb22016-07-14 00:11:03 +00002297 // If the body ends with a ReturnStmt, the dtors will be added in
2298 // VisitReturnStmt.
Matthias Gehre351c2182017-07-12 07:04:19 +00002299 addAutomaticObjHandling(ScopePos, scopeBeginPos, C);
Matthias Gehre09a134e2015-11-14 00:36:50 +00002300 }
2301
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002302 CFGBlock *LastBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002303
2304 for (CompoundStmt::reverse_body_iterator I=C->body_rbegin(), E=C->body_rend();
2305 I != E; ++I ) {
Ted Kremenek4f2ab5a2010-08-17 21:00:06 +00002306 // If we hit a segment of code just containing ';' (NullStmts), we can
2307 // get a null block back. In such cases, just use the LastBlock
2308 if (CFGBlock *newBlock = addStmt(*I))
2309 LastBlock = newBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002310
Ted Kremenekce499c22009-08-27 23:16:26 +00002311 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002312 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002313 }
Mike Stump92244b02010-01-19 22:00:14 +00002314
Ted Kremenek93668002009-07-17 22:18:43 +00002315 return LastBlock;
2316}
Mike Stump11289f42009-09-09 15:08:12 +00002317
John McCallc07a0c72011-02-17 10:25:35 +00002318CFGBlock *CFGBuilder::VisitConditionalOperator(AbstractConditionalOperator *C,
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002319 AddStmtChoice asc) {
John McCallc07a0c72011-02-17 10:25:35 +00002320 const BinaryConditionalOperator *BCO = dyn_cast<BinaryConditionalOperator>(C);
Craig Topper25542942014-05-20 04:30:07 +00002321 const OpaqueValueExpr *opaqueValue = (BCO ? BCO->getOpaqueValue() : nullptr);
John McCallc07a0c72011-02-17 10:25:35 +00002322
Ted Kremenek51d40b02009-07-17 18:15:54 +00002323 // Create the confluence block that will "merge" the results of the ternary
2324 // expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002325 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002326 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002327 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002328 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002329
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002330 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek5868ec62010-04-11 17:02:10 +00002331
Ted Kremenek51d40b02009-07-17 18:15:54 +00002332 // Create a block for the LHS expression if there is an LHS expression. A
2333 // GCC extension allows LHS to be NULL, causing the condition to be the
2334 // value that is returned instead.
2335 // e.g: x ?: y is shorthand for: x ? x : y;
2336 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002337 Block = nullptr;
2338 CFGBlock *LHSBlock = nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00002339 const Expr *trueExpr = C->getTrueExpr();
2340 if (trueExpr != opaqueValue) {
2341 LHSBlock = Visit(C->getTrueExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002342 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002343 return nullptr;
2344 Block = nullptr;
Ted Kremenek51d40b02009-07-17 18:15:54 +00002345 }
Ted Kremenekd8138012011-02-24 03:09:15 +00002346 else
2347 LHSBlock = ConfluenceBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002348
Ted Kremenek51d40b02009-07-17 18:15:54 +00002349 // Create the block for the RHS expression.
2350 Succ = ConfluenceBlock;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002351 CFGBlock *RHSBlock = Visit(C->getFalseExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002352 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002353 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002354
Richard Smithf676e452012-07-24 21:02:14 +00002355 // If the condition is a logical '&&' or '||', build a more accurate CFG.
2356 if (BinaryOperator *Cond =
2357 dyn_cast<BinaryOperator>(C->getCond()->IgnoreParens()))
2358 if (Cond->isLogicalOp())
2359 return VisitLogicalOperator(Cond, C, LHSBlock, RHSBlock).first;
2360
Ted Kremenek51d40b02009-07-17 18:15:54 +00002361 // Create the block that will contain the condition.
2362 Block = createBlock(false);
Mike Stump11289f42009-09-09 15:08:12 +00002363
Mike Stump773582d2009-07-23 23:25:26 +00002364 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002365 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Ted Kremenek5a095272014-03-04 21:53:26 +00002366 addSuccessor(Block, LHSBlock, !KnownVal.isFalse());
2367 addSuccessor(Block, RHSBlock, !KnownVal.isTrue());
Ted Kremenek51d40b02009-07-17 18:15:54 +00002368 Block->setTerminator(C);
John McCallc07a0c72011-02-17 10:25:35 +00002369 Expr *condExpr = C->getCond();
John McCall68cc3352011-02-19 03:13:26 +00002370
Ted Kremenekd8138012011-02-24 03:09:15 +00002371 if (opaqueValue) {
2372 // Run the condition expression if it's not trivially expressed in
2373 // terms of the opaque value (or if there is no opaque value).
2374 if (condExpr != opaqueValue)
2375 addStmt(condExpr);
John McCall68cc3352011-02-19 03:13:26 +00002376
Ted Kremenekd8138012011-02-24 03:09:15 +00002377 // Before that, run the common subexpression if there was one.
2378 // At least one of this or the above will be run.
2379 return addStmt(BCO->getCommon());
2380 }
2381
2382 return addStmt(condExpr);
Ted Kremenek51d40b02009-07-17 18:15:54 +00002383}
2384
Ted Kremenek93668002009-07-17 22:18:43 +00002385CFGBlock *CFGBuilder::VisitDeclStmt(DeclStmt *DS) {
Ted Kremenek6878c362011-05-10 18:42:15 +00002386 // Check if the Decl is for an __label__. If so, elide it from the
2387 // CFG entirely.
2388 if (isa<LabelDecl>(*DS->decl_begin()))
2389 return Block;
2390
Ted Kremenek3a601142011-05-24 20:41:31 +00002391 // This case also handles static_asserts.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002392 if (DS->isSingleDecl())
2393 return VisitDeclSubExpr(DS);
Mike Stump11289f42009-09-09 15:08:12 +00002394
Craig Topper25542942014-05-20 04:30:07 +00002395 CFGBlock *B = nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002396
Jordan Rose8c6c8a92012-07-20 18:50:48 +00002397 // Build an individual DeclStmt for each decl.
2398 for (DeclStmt::reverse_decl_iterator I = DS->decl_rbegin(),
2399 E = DS->decl_rend();
2400 I != E; ++I) {
Ted Kremenek93668002009-07-17 22:18:43 +00002401 // Get the alignment of the new DeclStmt, padding out to >=8 bytes.
Benjamin Kramerc3f89252016-10-20 14:27:22 +00002402 unsigned A = alignof(DeclStmt) < 8 ? 8 : alignof(DeclStmt);
Mike Stump11289f42009-09-09 15:08:12 +00002403
Ted Kremenek93668002009-07-17 22:18:43 +00002404 // Allocate the DeclStmt using the BumpPtrAllocator. It will get
2405 // automatically freed with the CFG.
2406 DeclGroupRef DG(*I);
2407 Decl *D = *I;
Mike Stump11289f42009-09-09 15:08:12 +00002408 void *Mem = cfg->getAllocator().Allocate(sizeof(DeclStmt), A);
Ted Kremenek93668002009-07-17 22:18:43 +00002409 DeclStmt *DSNew = new (Mem) DeclStmt(DG, D->getLocation(), GetEndLoc(D));
Jordan Rosecf10ea82013-06-06 21:53:45 +00002410 cfg->addSyntheticDeclStmt(DSNew, DS);
Mike Stump11289f42009-09-09 15:08:12 +00002411
Ted Kremenek93668002009-07-17 22:18:43 +00002412 // Append the fake DeclStmt to block.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002413 B = VisitDeclSubExpr(DSNew);
Ted Kremenek93668002009-07-17 22:18:43 +00002414 }
Mike Stump11289f42009-09-09 15:08:12 +00002415
2416 return B;
Ted Kremenek93668002009-07-17 22:18:43 +00002417}
Mike Stump11289f42009-09-09 15:08:12 +00002418
Ted Kremenek93668002009-07-17 22:18:43 +00002419/// VisitDeclSubExpr - Utility method to add block-level expressions for
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002420/// DeclStmts and initializers in them.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002421CFGBlock *CFGBuilder::VisitDeclSubExpr(DeclStmt *DS) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002422 assert(DS->isSingleDecl() && "Can handle single declarations only.");
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002423 VarDecl *VD = dyn_cast<VarDecl>(DS->getSingleDecl());
Mike Stump11289f42009-09-09 15:08:12 +00002424
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002425 if (!VD) {
Jordan Rose5250b872013-06-03 22:59:41 +00002426 // Of everything that can be declared in a DeclStmt, only VarDecls impact
2427 // runtime semantics.
Ted Kremenek93668002009-07-17 22:18:43 +00002428 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002429 }
Mike Stump11289f42009-09-09 15:08:12 +00002430
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002431 bool HasTemporaries = false;
2432
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002433 // Guard static initializers under a branch.
Craig Topper25542942014-05-20 04:30:07 +00002434 CFGBlock *blockAfterStaticInit = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002435
2436 if (BuildOpts.AddStaticInitBranches && VD->isStaticLocal()) {
2437 // For static variables, we need to create a branch to track
2438 // whether or not they are initialized.
2439 if (Block) {
2440 Succ = Block;
Craig Topper25542942014-05-20 04:30:07 +00002441 Block = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002442 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002443 return nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002444 }
2445 blockAfterStaticInit = Succ;
2446 }
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002447
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002448 // Destructors of temporaries in initialization expression should be called
2449 // after initialization finishes.
Ted Kremenek93668002009-07-17 22:18:43 +00002450 Expr *Init = VD->getInit();
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002451 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00002452 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002453
Jordan Rose6d671cc2012-09-05 22:55:23 +00002454 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002455 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00002456 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00002457 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
2458 /*BindToTemporary=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002459 }
2460 }
2461
2462 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00002463 appendStmt(Block, DS);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002464
Artem Dergachev783a4572018-02-23 22:20:39 +00002465 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00002466 ConstructionContextLayer::create(cfg->getBumpVectorContext(), DS),
Artem Dergachev783a4572018-02-23 22:20:39 +00002467 Init);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002468
Ted Kremenek213d0532012-03-22 05:57:43 +00002469 // Keep track of the last non-null block, as 'Block' can be nulled out
2470 // if the initializer expression is something like a 'while' in a
2471 // statement-expression.
2472 CFGBlock *LastBlock = Block;
Mike Stump11289f42009-09-09 15:08:12 +00002473
Ted Kremenek93668002009-07-17 22:18:43 +00002474 if (Init) {
Ted Kremenek213d0532012-03-22 05:57:43 +00002475 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002476 // For expression with temporaries go directly to subexpression to omit
2477 // generating destructors for the second time.
Ted Kremenek213d0532012-03-22 05:57:43 +00002478 ExprWithCleanups *EC = cast<ExprWithCleanups>(Init);
2479 if (CFGBlock *newBlock = Visit(EC->getSubExpr()))
2480 LastBlock = newBlock;
2481 }
2482 else {
2483 if (CFGBlock *newBlock = Visit(Init))
2484 LastBlock = newBlock;
2485 }
Ted Kremenek93668002009-07-17 22:18:43 +00002486 }
Mike Stump11289f42009-09-09 15:08:12 +00002487
Ted Kremenek93668002009-07-17 22:18:43 +00002488 // If the type of VD is a VLA, then we must process its size expressions.
John McCall424cec92011-01-19 06:33:43 +00002489 for (const VariableArrayType* VA = FindVA(VD->getType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00002490 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr())) {
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002491 if (CFGBlock *newBlock = addStmt(VA->getSizeExpr()))
2492 LastBlock = newBlock;
2493 }
Mike Stump11289f42009-09-09 15:08:12 +00002494
Marcin Swiderski667ffec2010-10-01 00:23:17 +00002495 // Remove variable from local scope.
2496 if (ScopePos && VD == *ScopePos)
2497 ++ScopePos;
2498
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002499 CFGBlock *B = LastBlock;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002500 if (blockAfterStaticInit) {
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002501 Succ = B;
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002502 Block = createBlock(false);
2503 Block->setTerminator(DS);
Ted Kremenekf82d5782013-03-29 00:42:56 +00002504 addSuccessor(Block, blockAfterStaticInit);
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002505 addSuccessor(Block, B);
2506 B = Block;
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002507 }
2508
2509 return B;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002510}
2511
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002512CFGBlock *CFGBuilder::VisitIfStmt(IfStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00002513 // We may see an if statement in the middle of a basic block, or it may be the
2514 // first statement we are processing. In either case, we create a new basic
2515 // block. First, we create the blocks for the then...else statements, and
2516 // then we create the block containing the if statement. If we were in the
Ted Kremenek0868eea2009-09-24 18:45:41 +00002517 // middle of a block, we stop processing that block. That block is then the
2518 // implicit successor for the "then" and "else" clauses.
Mike Stump31feda52009-07-17 01:31:16 +00002519
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002520 // Save local scope position because in case of condition variable ScopePos
2521 // won't be restored when traversing AST.
2522 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2523
Richard Smitha547eb22016-07-14 00:11:03 +00002524 // Create local scope for C++17 if init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00002525 if (Stmt *Init = I->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00002526 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00002527
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002528 // Create local scope for possible condition variable.
2529 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00002530 if (VarDecl *VD = I->getConditionVariable())
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002531 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00002532
Matthias Gehre351c2182017-07-12 07:04:19 +00002533 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), I);
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002534
Chris Lattner57540c52011-04-15 05:22:18 +00002535 // The block we were processing is now finished. Make it the successor
Mike Stump31feda52009-07-17 01:31:16 +00002536 // block.
2537 if (Block) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002538 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002539 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002540 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002541 }
Mike Stump31feda52009-07-17 01:31:16 +00002542
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002543 // Process the false branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002544 CFGBlock *ElseBlock = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002545
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002546 if (Stmt *Else = I->getElse()) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002547 SaveAndRestore<CFGBlock*> sv(Succ);
Mike Stump31feda52009-07-17 01:31:16 +00002548
Ted Kremenek9aae5132007-08-23 21:42:29 +00002549 // NULL out Block so that the recursive call to Visit will
Mike Stump31feda52009-07-17 01:31:16 +00002550 // create a new basic block.
Craig Topper25542942014-05-20 04:30:07 +00002551 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002552
2553 // If branch is not a compound statement create implicit scope
2554 // and add destructors.
2555 if (!isa<CompoundStmt>(Else))
2556 addLocalScopeAndDtors(Else);
2557
Ted Kremenek93668002009-07-17 22:18:43 +00002558 ElseBlock = addStmt(Else);
Mike Stump31feda52009-07-17 01:31:16 +00002559
Ted Kremenekbbad8ce2007-08-30 18:13:31 +00002560 if (!ElseBlock) // Can occur when the Else body has all NullStmts.
2561 ElseBlock = sv.get();
Ted Kremenek55957a82009-05-02 00:13:27 +00002562 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002563 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002564 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002565 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002566 }
Mike Stump31feda52009-07-17 01:31:16 +00002567
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002568 // Process the true branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002569 CFGBlock *ThenBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002570 {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002571 Stmt *Then = I->getThen();
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002572 assert(Then);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002573 SaveAndRestore<CFGBlock*> sv(Succ);
Craig Topper25542942014-05-20 04:30:07 +00002574 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002575
2576 // If branch is not a compound statement create implicit scope
2577 // and add destructors.
2578 if (!isa<CompoundStmt>(Then))
2579 addLocalScopeAndDtors(Then);
2580
Ted Kremenek93668002009-07-17 22:18:43 +00002581 ThenBlock = addStmt(Then);
Mike Stump31feda52009-07-17 01:31:16 +00002582
Ted Kremenek1b379512009-04-01 03:52:47 +00002583 if (!ThenBlock) {
2584 // We can reach here if the "then" body has all NullStmts.
2585 // Create an empty block so we can distinguish between true and false
2586 // branches in path-sensitive analyses.
2587 ThenBlock = createBlock(false);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002588 addSuccessor(ThenBlock, sv.get());
Mike Stump31feda52009-07-17 01:31:16 +00002589 } else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002590 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002591 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002592 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002593 }
2594
Ted Kremenekb50e7162012-07-14 05:04:10 +00002595 // Specially handle "if (expr1 || ...)" and "if (expr1 && ...)" by
2596 // having these handle the actual control-flow jump. Note that
2597 // if we introduce a condition variable, e.g. "if (int x = exp1 || exp2)"
2598 // we resort to the old control-flow behavior. This special handling
2599 // removes infeasible paths from the control-flow graph by having the
2600 // control-flow transfer of '&&' or '||' go directly into the then/else
2601 // blocks directly.
Richard Smith509bbd12017-01-13 22:16:41 +00002602 BinaryOperator *Cond =
2603 I->getConditionVariable()
2604 ? nullptr
2605 : dyn_cast<BinaryOperator>(I->getCond()->IgnoreParens());
2606 CFGBlock *LastBlock;
2607 if (Cond && Cond->isLogicalOp())
2608 LastBlock = VisitLogicalOperator(Cond, I, ThenBlock, ElseBlock).first;
2609 else {
2610 // Now create a new block containing the if statement.
2611 Block = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002612
Richard Smith509bbd12017-01-13 22:16:41 +00002613 // Set the terminator of the new block to the If statement.
2614 Block->setTerminator(I);
Mike Stump31feda52009-07-17 01:31:16 +00002615
Richard Smith509bbd12017-01-13 22:16:41 +00002616 // See if this is a known constant.
2617 const TryResult &KnownVal = tryEvaluateBool(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002618
Richard Smith509bbd12017-01-13 22:16:41 +00002619 // Add the successors. If we know that specific branches are
2620 // unreachable, inform addSuccessor() of that knowledge.
2621 addSuccessor(Block, ThenBlock, /* isReachable = */ !KnownVal.isFalse());
2622 addSuccessor(Block, ElseBlock, /* isReachable = */ !KnownVal.isTrue());
Mike Stump773582d2009-07-23 23:25:26 +00002623
Richard Smith509bbd12017-01-13 22:16:41 +00002624 // Add the condition as the last statement in the new block. This may
2625 // create new blocks as the condition may contain control-flow. Any newly
2626 // created blocks will be pointed to be "Block".
2627 LastBlock = addStmt(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002628
Richard Smith509bbd12017-01-13 22:16:41 +00002629 // If the IfStmt contains a condition variable, add it and its
2630 // initializer to the CFG.
2631 if (const DeclStmt* DS = I->getConditionVariableDeclStmt()) {
2632 autoCreateBlock();
2633 LastBlock = addStmt(const_cast<DeclStmt *>(DS));
2634 }
Ted Kremeneka7bcbde2009-12-23 04:49:01 +00002635 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002636
Richard Smitha547eb22016-07-14 00:11:03 +00002637 // Finally, if the IfStmt contains a C++17 init-stmt, add it to the CFG.
2638 if (Stmt *Init = I->getInit()) {
2639 autoCreateBlock();
2640 LastBlock = addStmt(Init);
2641 }
2642
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002643 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002644}
Mike Stump31feda52009-07-17 01:31:16 +00002645
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002646CFGBlock *CFGBuilder::VisitReturnStmt(ReturnStmt *R) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00002647 // If we were in the middle of a block we stop processing that block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002648 //
Mike Stump31feda52009-07-17 01:31:16 +00002649 // NOTE: If a "return" appears in the middle of a block, this means that the
2650 // code afterwards is DEAD (unreachable). We still keep a basic block
2651 // for that code; a simple "mark-and-sweep" from the entry block will be
2652 // able to report such dead blocks.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002653
2654 // Create the new block.
2655 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002656
Matthias Gehre351c2182017-07-12 07:04:19 +00002657 addAutomaticObjHandling(ScopePos, LocalScope::const_iterator(), R);
Pavel Labath921e7652013-09-06 08:12:48 +00002658
Artem Dergachev783a4572018-02-23 22:20:39 +00002659 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00002660 ConstructionContextLayer::create(cfg->getBumpVectorContext(), R),
Artem Dergachev783a4572018-02-23 22:20:39 +00002661 R->getRetValue());
Artem Dergachev9ac2e112018-02-12 22:36:36 +00002662
Pavel Labath921e7652013-09-06 08:12:48 +00002663 // If the one of the destructors does not return, we already have the Exit
2664 // block as a successor.
2665 if (!Block->hasNoReturnElement())
2666 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00002667
2668 // Add the return statement to the block. This may create new blocks if R
2669 // contains control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002670 return VisitStmt(R, AddStmtChoice::AlwaysAdd);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002671}
2672
Nico Weber699670e2017-08-23 15:33:16 +00002673CFGBlock *CFGBuilder::VisitSEHExceptStmt(SEHExceptStmt *ES) {
2674 // SEHExceptStmt are treated like labels, so they are the first statement in a
2675 // block.
2676
2677 // Save local scope position because in case of exception variable ScopePos
2678 // won't be restored when traversing AST.
2679 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2680
2681 addStmt(ES->getBlock());
2682 CFGBlock *SEHExceptBlock = Block;
2683 if (!SEHExceptBlock)
2684 SEHExceptBlock = createBlock();
2685
2686 appendStmt(SEHExceptBlock, ES);
2687
2688 // Also add the SEHExceptBlock as a label, like with regular labels.
2689 SEHExceptBlock->setLabel(ES);
2690
2691 // Bail out if the CFG is bad.
2692 if (badCFG)
2693 return nullptr;
2694
2695 // We set Block to NULL to allow lazy creation of a new block (if necessary).
2696 Block = nullptr;
2697
2698 return SEHExceptBlock;
2699}
2700
2701CFGBlock *CFGBuilder::VisitSEHFinallyStmt(SEHFinallyStmt *FS) {
2702 return VisitCompoundStmt(FS->getBlock());
2703}
2704
2705CFGBlock *CFGBuilder::VisitSEHLeaveStmt(SEHLeaveStmt *LS) {
2706 // "__leave" is a control-flow statement. Thus we stop processing the current
2707 // block.
2708 if (badCFG)
2709 return nullptr;
2710
2711 // Now create a new block that ends with the __leave statement.
2712 Block = createBlock(false);
2713 Block->setTerminator(LS);
2714
2715 // If there is no target for the __leave, then we are looking at an incomplete
2716 // AST. This means that the CFG cannot be constructed.
2717 if (SEHLeaveJumpTarget.block) {
2718 addAutomaticObjHandling(ScopePos, SEHLeaveJumpTarget.scopePosition, LS);
2719 addSuccessor(Block, SEHLeaveJumpTarget.block);
2720 } else
2721 badCFG = true;
2722
2723 return Block;
2724}
2725
2726CFGBlock *CFGBuilder::VisitSEHTryStmt(SEHTryStmt *Terminator) {
2727 // "__try"/"__except"/"__finally" is a control-flow statement. Thus we stop
2728 // processing the current block.
2729 CFGBlock *SEHTrySuccessor = nullptr;
2730
2731 if (Block) {
2732 if (badCFG)
2733 return nullptr;
2734 SEHTrySuccessor = Block;
2735 } else SEHTrySuccessor = Succ;
2736
2737 // FIXME: Implement __finally support.
2738 if (Terminator->getFinallyHandler())
2739 return NYS();
2740
2741 CFGBlock *PrevSEHTryTerminatedBlock = TryTerminatedBlock;
2742
2743 // Create a new block that will contain the __try statement.
2744 CFGBlock *NewTryTerminatedBlock = createBlock(false);
2745
2746 // Add the terminator in the __try block.
2747 NewTryTerminatedBlock->setTerminator(Terminator);
2748
2749 if (SEHExceptStmt *Except = Terminator->getExceptHandler()) {
2750 // The code after the try is the implicit successor if there's an __except.
2751 Succ = SEHTrySuccessor;
2752 Block = nullptr;
2753 CFGBlock *ExceptBlock = VisitSEHExceptStmt(Except);
2754 if (!ExceptBlock)
2755 return nullptr;
2756 // Add this block to the list of successors for the block with the try
2757 // statement.
2758 addSuccessor(NewTryTerminatedBlock, ExceptBlock);
2759 }
2760 if (PrevSEHTryTerminatedBlock)
2761 addSuccessor(NewTryTerminatedBlock, PrevSEHTryTerminatedBlock);
2762 else
2763 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
2764
2765 // The code after the try is the implicit successor.
2766 Succ = SEHTrySuccessor;
2767
2768 // Save the current "__try" context.
2769 SaveAndRestore<CFGBlock *> save_try(TryTerminatedBlock,
2770 NewTryTerminatedBlock);
2771 cfg->addTryDispatchBlock(TryTerminatedBlock);
2772
2773 // Save the current value for the __leave target.
2774 // All __leaves should go to the code following the __try
2775 // (FIXME: or if the __try has a __finally, to the __finally.)
2776 SaveAndRestore<JumpTarget> save_break(SEHLeaveJumpTarget);
2777 SEHLeaveJumpTarget = JumpTarget(SEHTrySuccessor, ScopePos);
2778
2779 assert(Terminator->getTryBlock() && "__try must contain a non-NULL body");
2780 Block = nullptr;
2781 return addStmt(Terminator->getTryBlock());
2782}
2783
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002784CFGBlock *CFGBuilder::VisitLabelStmt(LabelStmt *L) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002785 // Get the block of the labeled statement. Add it to our map.
Ted Kremenek93668002009-07-17 22:18:43 +00002786 addStmt(L->getSubStmt());
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002787 CFGBlock *LabelBlock = Block;
Mike Stump31feda52009-07-17 01:31:16 +00002788
Ted Kremenek93668002009-07-17 22:18:43 +00002789 if (!LabelBlock) // This can happen when the body is empty, i.e.
2790 LabelBlock = createBlock(); // scopes that only contains NullStmts.
Mike Stump31feda52009-07-17 01:31:16 +00002791
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002792 assert(LabelMap.find(L->getDecl()) == LabelMap.end() &&
2793 "label already in map");
2794 LabelMap[L->getDecl()] = JumpTarget(LabelBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002795
2796 // Labels partition blocks, so this is the end of the basic block we were
2797 // processing (L is the block's label). Because this is label (and we have
2798 // already processed the substatement) there is no extra control-flow to worry
2799 // about.
Ted Kremenek71eca012007-08-29 23:20:49 +00002800 LabelBlock->setLabel(L);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002801 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002802 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002803
2804 // We set Block to NULL to allow lazy creation of a new block (if necessary);
Craig Topper25542942014-05-20 04:30:07 +00002805 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002806
Ted Kremenek9aae5132007-08-23 21:42:29 +00002807 // This block is now the implicit successor of other blocks.
2808 Succ = LabelBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002809
Ted Kremenek9aae5132007-08-23 21:42:29 +00002810 return LabelBlock;
2811}
2812
Devin Coughlinb6029b72015-11-25 22:35:37 +00002813CFGBlock *CFGBuilder::VisitBlockExpr(BlockExpr *E, AddStmtChoice asc) {
2814 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
2815 for (const BlockDecl::Capture &CI : E->getBlockDecl()->captures()) {
2816 if (Expr *CopyExpr = CI.getCopyExpr()) {
2817 CFGBlock *Tmp = Visit(CopyExpr);
2818 if (Tmp)
2819 LastBlock = Tmp;
2820 }
2821 }
2822 return LastBlock;
2823}
2824
Ted Kremenekda76a942012-04-12 20:34:52 +00002825CFGBlock *CFGBuilder::VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc) {
2826 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
2827 for (LambdaExpr::capture_init_iterator it = E->capture_init_begin(),
2828 et = E->capture_init_end(); it != et; ++it) {
2829 if (Expr *Init = *it) {
2830 CFGBlock *Tmp = Visit(Init);
Craig Topper25542942014-05-20 04:30:07 +00002831 if (Tmp)
Ted Kremenekda76a942012-04-12 20:34:52 +00002832 LastBlock = Tmp;
2833 }
2834 }
2835 return LastBlock;
2836}
2837
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002838CFGBlock *CFGBuilder::VisitGotoStmt(GotoStmt *G) {
Mike Stump31feda52009-07-17 01:31:16 +00002839 // Goto is a control-flow statement. Thus we stop processing the current
2840 // block and create a new one.
Ted Kremenek93668002009-07-17 22:18:43 +00002841
Ted Kremenek9aae5132007-08-23 21:42:29 +00002842 Block = createBlock(false);
2843 Block->setTerminator(G);
Mike Stump31feda52009-07-17 01:31:16 +00002844
2845 // If we already know the mapping to the label block add the successor now.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002846 LabelMapTy::iterator I = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00002847
Ted Kremenek9aae5132007-08-23 21:42:29 +00002848 if (I == LabelMap.end())
2849 // We will need to backpatch this block later.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002850 BackpatchBlocks.push_back(JumpSource(Block, ScopePos));
2851 else {
2852 JumpTarget JT = I->second;
Matthias Gehre351c2182017-07-12 07:04:19 +00002853 addAutomaticObjHandling(ScopePos, JT.scopePosition, G);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002854 addSuccessor(Block, JT.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002855 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002856
Mike Stump31feda52009-07-17 01:31:16 +00002857 return Block;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002858}
2859
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002860CFGBlock *CFGBuilder::VisitForStmt(ForStmt *F) {
Craig Topper25542942014-05-20 04:30:07 +00002861 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002862
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002863 // Save local scope position because in case of condition variable ScopePos
2864 // won't be restored when traversing AST.
2865 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2866
2867 // Create local scope for init statement and possible condition variable.
2868 // Add destructor for init statement and condition variable.
2869 // Store scope position for continue statement.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002870 if (Stmt *Init = F->getInit())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002871 addLocalScopeForStmt(Init);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002872 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
2873
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002874 if (VarDecl *VD = F->getConditionVariable())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002875 addLocalScopeForVarDecl(VD);
2876 LocalScope::const_iterator ContinueScopePos = ScopePos;
2877
Matthias Gehre351c2182017-07-12 07:04:19 +00002878 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), F);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002879
Peter Szecsi999a25f2017-08-19 11:19:16 +00002880 addLoopExit(F);
2881
Mike Stump014b3ea2009-07-21 01:12:51 +00002882 // "for" is a control-flow statement. Thus we stop processing the current
2883 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002884 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002885 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002886 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002887 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002888 } else
2889 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002890
Ted Kremenek304a9532010-05-21 20:30:15 +00002891 // Save the current value for the break targets.
2892 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002893 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002894 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Ted Kremenek304a9532010-05-21 20:30:15 +00002895
Craig Topper25542942014-05-20 04:30:07 +00002896 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00002897
Ted Kremenek9aae5132007-08-23 21:42:29 +00002898 // Now create the loop body.
2899 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002900 assert(F->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00002901
Ted Kremenekb50e7162012-07-14 05:04:10 +00002902 // Save the current values for Block, Succ, continue and break targets.
2903 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
2904 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00002905
Ted Kremenekb50e7162012-07-14 05:04:10 +00002906 // Create an empty block to represent the transition block for looping back
2907 // to the head of the loop. If we have increment code, it will
2908 // go in this block as well.
2909 Block = Succ = TransitionBlock = createBlock(false);
2910 TransitionBlock->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00002911
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002912 if (Stmt *I = F->getInc()) {
Mike Stump31feda52009-07-17 01:31:16 +00002913 // Generate increment code in its own basic block. This is the target of
2914 // continue statements.
Ted Kremenek93668002009-07-17 22:18:43 +00002915 Succ = addStmt(I);
Ted Kremenekb0746ca2008-09-04 21:48:47 +00002916 }
Mike Stump31feda52009-07-17 01:31:16 +00002917
Ted Kremenek902393b2009-04-28 00:51:56 +00002918 // Finish up the increment (or empty) block if it hasn't been already.
2919 if (Block) {
2920 assert(Block == Succ);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002921 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002922 return nullptr;
2923 Block = nullptr;
Ted Kremenek902393b2009-04-28 00:51:56 +00002924 }
Mike Stump31feda52009-07-17 01:31:16 +00002925
Ted Kremenekb50e7162012-07-14 05:04:10 +00002926 // The starting block for the loop increment is the block that should
2927 // represent the 'loop target' for looping back to the start of the loop.
2928 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
2929 ContinueJumpTarget.block->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00002930
Ted Kremenekb50e7162012-07-14 05:04:10 +00002931 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00002932 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, F);
Ted Kremenek902393b2009-04-28 00:51:56 +00002933
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002934 // If body is not a compound statement create implicit scope
2935 // and add destructors.
2936 if (!isa<CompoundStmt>(F->getBody()))
2937 addLocalScopeAndDtors(F->getBody());
2938
Mike Stump31feda52009-07-17 01:31:16 +00002939 // Now populate the body block, and in the process create new blocks as we
2940 // walk the body of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002941 BodyBlock = addStmt(F->getBody());
Ted Kremeneke9610502007-08-30 18:39:40 +00002942
Ted Kremenekb50e7162012-07-14 05:04:10 +00002943 if (!BodyBlock) {
2944 // In the case of "for (...;...;...);" we can have a null BodyBlock.
2945 // Use the continue jump target as the proxy for the body.
2946 BodyBlock = ContinueJumpTarget.block;
2947 }
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002948 else if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002949 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002950 }
Ted Kremenekb50e7162012-07-14 05:04:10 +00002951
2952 // Because of short-circuit evaluation, the condition of the loop can span
2953 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
2954 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00002955 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002956
Ted Kremenekb50e7162012-07-14 05:04:10 +00002957 do {
2958 Expr *C = F->getCond();
2959
2960 // Specially handle logical operators, which have a slightly
2961 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00002962 if (BinaryOperator *Cond =
Craig Topper25542942014-05-20 04:30:07 +00002963 dyn_cast_or_null<BinaryOperator>(C ? C->IgnoreParens() : nullptr))
Ted Kremenekb50e7162012-07-14 05:04:10 +00002964 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00002965 std::tie(EntryConditionBlock, ExitConditionBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00002966 VisitLogicalOperator(Cond, F, BodyBlock, LoopSuccessor);
2967 break;
2968 }
2969
2970 // The default case when not handling logical operators.
2971 EntryConditionBlock = ExitConditionBlock = createBlock(false);
2972 ExitConditionBlock->setTerminator(F);
2973
2974 // See if this is a known constant.
2975 TryResult KnownVal(true);
2976
2977 if (C) {
2978 // Now add the actual condition to the condition block.
2979 // Because the condition itself may contain control-flow, new blocks may
2980 // be created. Thus we update "Succ" after adding the condition.
2981 Block = ExitConditionBlock;
2982 EntryConditionBlock = addStmt(C);
2983
2984 // If this block contains a condition variable, add both the condition
2985 // variable and initializer to the CFG.
2986 if (VarDecl *VD = F->getConditionVariable()) {
2987 if (Expr *Init = VD->getInit()) {
2988 autoCreateBlock();
2989 appendStmt(Block, F->getConditionVariableDeclStmt());
2990 EntryConditionBlock = addStmt(Init);
2991 assert(Block == EntryConditionBlock);
2992 }
2993 }
2994
2995 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002996 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002997
2998 KnownVal = tryEvaluateBool(C);
2999 }
3000
3001 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003002 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003003 // Link up the condition block with the code that follows the loop. (the
3004 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003005 addSuccessor(ExitConditionBlock,
3006 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003007 } while (false);
3008
3009 // Link up the loop-back block to the entry condition block.
3010 addSuccessor(TransitionBlock, EntryConditionBlock);
3011
3012 // The condition block is the implicit successor for any code above the loop.
3013 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003014
Ted Kremenek9aae5132007-08-23 21:42:29 +00003015 // If the loop contains initialization, create a new block for those
Mike Stump31feda52009-07-17 01:31:16 +00003016 // statements. This block can also contain statements that precede the loop.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003017 if (Stmt *I = F->getInit()) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003018 Block = createBlock();
Ted Kremenek81e14852007-08-27 19:46:09 +00003019 return addStmt(I);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003020 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003021
3022 // There is no loop initialization. We are thus basically a while loop.
3023 // NULL out Block to force lazy block construction.
Craig Topper25542942014-05-20 04:30:07 +00003024 Block = nullptr;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003025 Succ = EntryConditionBlock;
3026 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003027}
3028
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00003029CFGBlock *
3030CFGBuilder::VisitMaterializeTemporaryExpr(MaterializeTemporaryExpr *MTE,
3031 AddStmtChoice asc) {
3032 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00003033 ConstructionContextLayer::create(cfg->getBumpVectorContext(), MTE),
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00003034 MTE->getTemporary());
3035
3036 return VisitStmt(MTE, asc);
3037}
3038
Ted Kremenek5868ec62010-04-11 17:02:10 +00003039CFGBlock *CFGBuilder::VisitMemberExpr(MemberExpr *M, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003040 if (asc.alwaysAdd(*this, M)) {
Ted Kremenek5868ec62010-04-11 17:02:10 +00003041 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003042 appendStmt(Block, M);
Ted Kremenek5868ec62010-04-11 17:02:10 +00003043 }
Ted Kremenek8219b822010-12-16 07:46:53 +00003044 return Visit(M->getBase());
Ted Kremenek5868ec62010-04-11 17:02:10 +00003045}
3046
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003047CFGBlock *CFGBuilder::VisitObjCForCollectionStmt(ObjCForCollectionStmt *S) {
Ted Kremenek9d56e642008-11-11 17:10:00 +00003048 // Objective-C fast enumeration 'for' statements:
3049 // http://developer.apple.com/documentation/Cocoa/Conceptual/ObjectiveC
3050 //
3051 // for ( Type newVariable in collection_expression ) { statements }
3052 //
3053 // becomes:
3054 //
3055 // prologue:
3056 // 1. collection_expression
3057 // T. jump to loop_entry
3058 // loop_entry:
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003059 // 1. side-effects of element expression
Ted Kremenek9d56e642008-11-11 17:10:00 +00003060 // 1. ObjCForCollectionStmt [performs binding to newVariable]
3061 // T. ObjCForCollectionStmt TB, FB [jumps to TB if newVariable != nil]
3062 // TB:
3063 // statements
3064 // T. jump to loop_entry
3065 // FB:
3066 // what comes after
3067 //
3068 // and
3069 //
3070 // Type existingItem;
3071 // for ( existingItem in expression ) { statements }
3072 //
3073 // becomes:
3074 //
Mike Stump31feda52009-07-17 01:31:16 +00003075 // the same with newVariable replaced with existingItem; the binding works
3076 // the same except that for one ObjCForCollectionStmt::getElement() returns
3077 // a DeclStmt and the other returns a DeclRefExpr.
Mike Stump31feda52009-07-17 01:31:16 +00003078
Craig Topper25542942014-05-20 04:30:07 +00003079 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003080
Ted Kremenek9d56e642008-11-11 17:10:00 +00003081 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003082 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003083 return nullptr;
Ted Kremenek9d56e642008-11-11 17:10:00 +00003084 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003085 Block = nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00003086 } else
3087 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003088
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003089 // Build the condition blocks.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003090 CFGBlock *ExitConditionBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003091
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003092 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003093 ExitConditionBlock->setTerminator(S);
3094
3095 // The last statement in the block should be the ObjCForCollectionStmt, which
3096 // performs the actual binding to 'element' and determines if there are any
3097 // more items in the collection.
Ted Kremenek8219b822010-12-16 07:46:53 +00003098 appendStmt(ExitConditionBlock, S);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003099 Block = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003100
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003101 // Walk the 'element' expression to see if there are any side-effects. We
Chris Lattner57540c52011-04-15 05:22:18 +00003102 // generate new blocks as necessary. We DON'T add the statement by default to
Mike Stump31feda52009-07-17 01:31:16 +00003103 // the CFG unless it contains control-flow.
Ted Kremenekc14efa72011-08-17 21:04:19 +00003104 CFGBlock *EntryConditionBlock = Visit(S->getElement(),
3105 AddStmtChoice::NotAlwaysAdd);
Mike Stump31feda52009-07-17 01:31:16 +00003106 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003107 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003108 return nullptr;
3109 Block = nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003110 }
Mike Stump31feda52009-07-17 01:31:16 +00003111
3112 // The condition block is the implicit successor for the loop body as well as
3113 // any code above the loop.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003114 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003115
Ted Kremenek9d56e642008-11-11 17:10:00 +00003116 // Now create the true branch.
Mike Stump31feda52009-07-17 01:31:16 +00003117 {
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003118 // Save the current values for Succ, continue and break targets.
Anna Zaks56b49752013-06-22 00:23:20 +00003119 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003120 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Anna Zaks56b49752013-06-22 00:23:20 +00003121 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003122
Anna Zaks56b49752013-06-22 00:23:20 +00003123 // Add an intermediate block between the BodyBlock and the
3124 // EntryConditionBlock to represent the "loop back" transition, for looping
3125 // back to the head of the loop.
Craig Topper25542942014-05-20 04:30:07 +00003126 CFGBlock *LoopBackBlock = nullptr;
Anna Zaks56b49752013-06-22 00:23:20 +00003127 Succ = LoopBackBlock = createBlock();
3128 LoopBackBlock->setLoopTarget(S);
3129
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003130 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Anna Zaks56b49752013-06-22 00:23:20 +00003131 ContinueJumpTarget = JumpTarget(Succ, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003132
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003133 CFGBlock *BodyBlock = addStmt(S->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003134
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003135 if (!BodyBlock)
Anna Zaks56b49752013-06-22 00:23:20 +00003136 BodyBlock = ContinueJumpTarget.block; // can happen for "for (X in Y) ;"
Ted Kremenek55957a82009-05-02 00:13:27 +00003137 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003138 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003139 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003140 }
Mike Stump31feda52009-07-17 01:31:16 +00003141
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003142 // This new body block is a successor to our "exit" condition block.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003143 addSuccessor(ExitConditionBlock, BodyBlock);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003144 }
Mike Stump31feda52009-07-17 01:31:16 +00003145
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003146 // Link up the condition block with the code that follows the loop.
3147 // (the false branch).
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003148 addSuccessor(ExitConditionBlock, LoopSuccessor);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003149
Ted Kremenek9d56e642008-11-11 17:10:00 +00003150 // Now create a prologue block to contain the collection expression.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003151 Block = createBlock();
Ted Kremenek9d56e642008-11-11 17:10:00 +00003152 return addStmt(S->getCollection());
Mike Stump31feda52009-07-17 01:31:16 +00003153}
3154
Ted Kremenek5022f1d2012-03-06 23:40:47 +00003155CFGBlock *CFGBuilder::VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S) {
3156 // Inline the body.
3157 return addStmt(S->getSubStmt());
3158 // TODO: consider adding cleanups for the end of @autoreleasepool scope.
3159}
3160
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003161CFGBlock *CFGBuilder::VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S) {
Ted Kremenek49805452009-05-02 01:49:13 +00003162 // FIXME: Add locking 'primitives' to CFG for @synchronized.
Mike Stump31feda52009-07-17 01:31:16 +00003163
Ted Kremenek49805452009-05-02 01:49:13 +00003164 // Inline the body.
Ted Kremenek93668002009-07-17 22:18:43 +00003165 CFGBlock *SyncBlock = addStmt(S->getSynchBody());
Mike Stump31feda52009-07-17 01:31:16 +00003166
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003167 // The sync body starts its own basic block. This makes it a little easier
3168 // for diagnostic clients.
3169 if (SyncBlock) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003170 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003171 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003172
Craig Topper25542942014-05-20 04:30:07 +00003173 Block = nullptr;
Ted Kremenekecc31c92010-05-13 16:38:08 +00003174 Succ = SyncBlock;
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003175 }
Mike Stump31feda52009-07-17 01:31:16 +00003176
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003177 // Add the @synchronized to the CFG.
3178 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003179 appendStmt(Block, S);
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003180
Ted Kremenek49805452009-05-02 01:49:13 +00003181 // Inline the sync expression.
Ted Kremenek93668002009-07-17 22:18:43 +00003182 return addStmt(S->getSynchExpr());
Ted Kremenek49805452009-05-02 01:49:13 +00003183}
Mike Stump31feda52009-07-17 01:31:16 +00003184
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003185CFGBlock *CFGBuilder::VisitObjCAtTryStmt(ObjCAtTryStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003186 // FIXME
Ted Kremenek89be6522009-04-07 04:26:02 +00003187 return NYS();
Ted Kremenek89cc8ea2009-03-30 22:29:21 +00003188}
Ted Kremenek9d56e642008-11-11 17:10:00 +00003189
John McCallfe96e0b2011-11-06 09:01:30 +00003190CFGBlock *CFGBuilder::VisitPseudoObjectExpr(PseudoObjectExpr *E) {
3191 autoCreateBlock();
3192
3193 // Add the PseudoObject as the last thing.
3194 appendStmt(Block, E);
3195
3196 CFGBlock *lastBlock = Block;
3197
3198 // Before that, evaluate all of the semantics in order. In
3199 // CFG-land, that means appending them in reverse order.
3200 for (unsigned i = E->getNumSemanticExprs(); i != 0; ) {
3201 Expr *Semantic = E->getSemanticExpr(--i);
3202
3203 // If the semantic is an opaque value, we're being asked to bind
3204 // it to its source expression.
3205 if (OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(Semantic))
3206 Semantic = OVE->getSourceExpr();
3207
3208 if (CFGBlock *B = Visit(Semantic))
3209 lastBlock = B;
3210 }
3211
3212 return lastBlock;
3213}
3214
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003215CFGBlock *CFGBuilder::VisitWhileStmt(WhileStmt *W) {
Craig Topper25542942014-05-20 04:30:07 +00003216 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003217
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003218 // Save local scope position because in case of condition variable ScopePos
3219 // won't be restored when traversing AST.
3220 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3221
3222 // Create local scope for possible condition variable.
3223 // Store scope position for continue statement.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003224 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003225 if (VarDecl *VD = W->getConditionVariable()) {
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003226 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00003227 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003228 }
Peter Szecsi999a25f2017-08-19 11:19:16 +00003229 addLoopExit(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003230
Mike Stump014b3ea2009-07-21 01:12:51 +00003231 // "while" is a control-flow statement. Thus we stop processing the current
3232 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003233 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003234 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003235 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003236 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003237 Block = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003238 } else {
Ted Kremenek93668002009-07-17 22:18:43 +00003239 LoopSuccessor = Succ;
Ted Kremenek81e14852007-08-27 19:46:09 +00003240 }
Mike Stump31feda52009-07-17 01:31:16 +00003241
Craig Topper25542942014-05-20 04:30:07 +00003242 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00003243
Ted Kremenek9aae5132007-08-23 21:42:29 +00003244 // Process the loop body.
3245 {
Ted Kremenek49936f72009-04-28 03:09:44 +00003246 assert(W->getBody());
Ted Kremenek9aae5132007-08-23 21:42:29 +00003247
Ted Kremenekb50e7162012-07-14 05:04:10 +00003248 // Save the current values for Block, Succ, continue and break targets.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003249 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3250 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Ted Kremenekb50e7162012-07-14 05:04:10 +00003251 save_break(BreakJumpTarget);
Ted Kremenek49936f72009-04-28 03:09:44 +00003252
Mike Stump31feda52009-07-17 01:31:16 +00003253 // Create an empty block to represent the transition block for looping back
3254 // to the head of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003255 Succ = TransitionBlock = createBlock(false);
3256 TransitionBlock->setLoopTarget(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003257 ContinueJumpTarget = JumpTarget(Succ, LoopBeginScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003258
Ted Kremenek9aae5132007-08-23 21:42:29 +00003259 // All breaks should go to the code following the loop.
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003260 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003261
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003262 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00003263 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003264
3265 // If body is not a compound statement create implicit scope
3266 // and add destructors.
3267 if (!isa<CompoundStmt>(W->getBody()))
3268 addLocalScopeAndDtors(W->getBody());
3269
Ted Kremenek9aae5132007-08-23 21:42:29 +00003270 // Create the body. The returned block is the entry to the loop body.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003271 BodyBlock = addStmt(W->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003272
Ted Kremeneke9610502007-08-30 18:39:40 +00003273 if (!BodyBlock)
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003274 BodyBlock = ContinueJumpTarget.block; // can happen for "while(...) ;"
Ted Kremenekb50e7162012-07-14 05:04:10 +00003275 else if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003276 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003277 }
3278
3279 // Because of short-circuit evaluation, the condition of the loop can span
3280 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3281 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00003282 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003283
3284 do {
3285 Expr *C = W->getCond();
3286
3287 // Specially handle logical operators, which have a slightly
3288 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00003289 if (BinaryOperator *Cond = dyn_cast<BinaryOperator>(C->IgnoreParens()))
Ted Kremenekb50e7162012-07-14 05:04:10 +00003290 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00003291 std::tie(EntryConditionBlock, ExitConditionBlock) =
3292 VisitLogicalOperator(Cond, W, BodyBlock, LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003293 break;
3294 }
3295
3296 // The default case when not handling logical operators.
Ted Kremenek451c4d52012-10-12 22:56:26 +00003297 ExitConditionBlock = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003298 ExitConditionBlock->setTerminator(W);
3299
3300 // Now add the actual condition to the condition block.
3301 // Because the condition itself may contain control-flow, new blocks may
3302 // be created. Thus we update "Succ" after adding the condition.
3303 Block = ExitConditionBlock;
3304 Block = EntryConditionBlock = addStmt(C);
3305
3306 // If this block contains a condition variable, add both the condition
3307 // variable and initializer to the CFG.
3308 if (VarDecl *VD = W->getConditionVariable()) {
3309 if (Expr *Init = VD->getInit()) {
3310 autoCreateBlock();
3311 appendStmt(Block, W->getConditionVariableDeclStmt());
3312 EntryConditionBlock = addStmt(Init);
3313 assert(Block == EntryConditionBlock);
3314 }
Ted Kremenek55957a82009-05-02 00:13:27 +00003315 }
Mike Stump31feda52009-07-17 01:31:16 +00003316
Ted Kremenekb50e7162012-07-14 05:04:10 +00003317 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003318 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003319
3320 // See if this is a known constant.
3321 const TryResult& KnownVal = tryEvaluateBool(C);
3322
Ted Kremenek30754282009-07-24 04:47:11 +00003323 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003324 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003325 // Link up the condition block with the code that follows the loop. (the
3326 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003327 addSuccessor(ExitConditionBlock,
3328 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003329 } while(false);
3330
3331 // Link up the loop-back block to the entry condition block.
3332 addSuccessor(TransitionBlock, EntryConditionBlock);
Mike Stump31feda52009-07-17 01:31:16 +00003333
3334 // There can be no more statements in the condition block since we loop back
3335 // to this block. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003336 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003337
Ted Kremenek1ce53c42009-12-24 01:34:10 +00003338 // Return the condition block, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003339 Succ = EntryConditionBlock;
Ted Kremenek81e14852007-08-27 19:46:09 +00003340 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003341}
Mike Stump11289f42009-09-09 15:08:12 +00003342
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003343CFGBlock *CFGBuilder::VisitObjCAtCatchStmt(ObjCAtCatchStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003344 // FIXME: For now we pretend that @catch and the code it contains does not
3345 // exit.
3346 return Block;
3347}
Mike Stump31feda52009-07-17 01:31:16 +00003348
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003349CFGBlock *CFGBuilder::VisitObjCAtThrowStmt(ObjCAtThrowStmt *S) {
Ted Kremenek93041ba2008-12-09 20:20:09 +00003350 // FIXME: This isn't complete. We basically treat @throw like a return
3351 // statement.
Mike Stump31feda52009-07-17 01:31:16 +00003352
Ted Kremenek0868eea2009-09-24 18:45:41 +00003353 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003354 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003355 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003356
Ted Kremenek93041ba2008-12-09 20:20:09 +00003357 // Create the new block.
3358 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003359
Ted Kremenek93041ba2008-12-09 20:20:09 +00003360 // The Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003361 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00003362
3363 // Add the statement to the block. This may create new blocks if S contains
3364 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003365 return VisitStmt(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek93041ba2008-12-09 20:20:09 +00003366}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003367
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003368CFGBlock *CFGBuilder::VisitCXXThrowExpr(CXXThrowExpr *T) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00003369 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003370 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003371 return nullptr;
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003372
3373 // Create the new block.
3374 Block = createBlock(false);
3375
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003376 if (TryTerminatedBlock)
3377 // The current try statement is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003378 addSuccessor(Block, TryTerminatedBlock);
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003379 else
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003380 // otherwise the Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003381 addSuccessor(Block, &cfg->getExit());
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003382
3383 // Add the statement to the block. This may create new blocks if S contains
3384 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003385 return VisitStmt(T, AddStmtChoice::AlwaysAdd);
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003386}
3387
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003388CFGBlock *CFGBuilder::VisitDoStmt(DoStmt *D) {
Craig Topper25542942014-05-20 04:30:07 +00003389 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003390
Peter Szecsi999a25f2017-08-19 11:19:16 +00003391 addLoopExit(D);
3392
Mike Stump8d50b6a2009-07-21 01:27:50 +00003393 // "do...while" is a control-flow statement. Thus we stop processing the
3394 // current block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003395 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003396 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003397 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003398 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003399 } else
3400 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003401
3402 // Because of short-circuit evaluation, the condition of the loop can span
3403 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3404 // evaluate the condition.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003405 CFGBlock *ExitConditionBlock = createBlock(false);
3406 CFGBlock *EntryConditionBlock = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003407
Ted Kremenek81e14852007-08-27 19:46:09 +00003408 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003409 ExitConditionBlock->setTerminator(D);
3410
3411 // Now add the actual condition to the condition block. Because the condition
3412 // itself may contain control-flow, new blocks may be created.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003413 if (Stmt *C = D->getCond()) {
Ted Kremenek81e14852007-08-27 19:46:09 +00003414 Block = ExitConditionBlock;
3415 EntryConditionBlock = addStmt(C);
Ted Kremenek55957a82009-05-02 00:13:27 +00003416 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003417 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003418 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003419 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003420 }
Mike Stump31feda52009-07-17 01:31:16 +00003421
Ted Kremeneka1523a32008-02-27 07:20:00 +00003422 // The condition block is the implicit successor for the loop body.
Ted Kremenek81e14852007-08-27 19:46:09 +00003423 Succ = EntryConditionBlock;
3424
Mike Stump773582d2009-07-23 23:25:26 +00003425 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003426 const TryResult &KnownVal = tryEvaluateBool(D->getCond());
Mike Stump773582d2009-07-23 23:25:26 +00003427
Ted Kremenek9aae5132007-08-23 21:42:29 +00003428 // Process the loop body.
Craig Topper25542942014-05-20 04:30:07 +00003429 CFGBlock *BodyBlock = nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003430 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003431 assert(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003432
Ted Kremenek9aae5132007-08-23 21:42:29 +00003433 // Save the current values for Block, Succ, and continue and break targets
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003434 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3435 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
3436 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003437
Ted Kremenek9aae5132007-08-23 21:42:29 +00003438 // All continues within this loop should go to the condition block
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003439 ContinueJumpTarget = JumpTarget(EntryConditionBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003440
Ted Kremenek9aae5132007-08-23 21:42:29 +00003441 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003442 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003443
Ted Kremenek9aae5132007-08-23 21:42:29 +00003444 // NULL out Block to force lazy instantiation of blocks for the body.
Craig Topper25542942014-05-20 04:30:07 +00003445 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003446
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003447 // If body is not a compound statement create implicit scope
3448 // and add destructors.
3449 if (!isa<CompoundStmt>(D->getBody()))
3450 addLocalScopeAndDtors(D->getBody());
3451
Ted Kremenek9aae5132007-08-23 21:42:29 +00003452 // Create the body. The returned block is the entry to the loop body.
Ted Kremenek93668002009-07-17 22:18:43 +00003453 BodyBlock = addStmt(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003454
Ted Kremeneke9610502007-08-30 18:39:40 +00003455 if (!BodyBlock)
Ted Kremenek39321aa2008-02-27 00:28:17 +00003456 BodyBlock = EntryConditionBlock; // can happen for "do ; while(...)"
Ted Kremenek55957a82009-05-02 00:13:27 +00003457 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003458 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003459 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003460 }
Mike Stump31feda52009-07-17 01:31:16 +00003461
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003462 // Add an intermediate block between the BodyBlock and the
3463 // ExitConditionBlock to represent the "loop back" transition. Create an
3464 // empty block to represent the transition block for looping back to the
3465 // head of the loop.
3466 // FIXME: Can we do this more efficiently without adding another block?
3467 Block = nullptr;
3468 Succ = BodyBlock;
3469 CFGBlock *LoopBackBlock = createBlock();
3470 LoopBackBlock->setLoopTarget(D);
Mike Stump31feda52009-07-17 01:31:16 +00003471
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003472 if (!KnownVal.isFalse())
Ted Kremenek110974d2010-08-17 20:59:56 +00003473 // Add the loop body entry as a successor to the condition.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003474 addSuccessor(ExitConditionBlock, LoopBackBlock);
Ted Kremenek110974d2010-08-17 20:59:56 +00003475 else
Craig Topper25542942014-05-20 04:30:07 +00003476 addSuccessor(ExitConditionBlock, nullptr);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003477 }
Mike Stump31feda52009-07-17 01:31:16 +00003478
Ted Kremenek30754282009-07-24 04:47:11 +00003479 // Link up the condition block with the code that follows the loop.
3480 // (the false branch).
Craig Topper25542942014-05-20 04:30:07 +00003481 addSuccessor(ExitConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003482
3483 // There can be no more statements in the body block(s) since we loop back to
3484 // the body. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003485 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003486
Ted Kremenek9aae5132007-08-23 21:42:29 +00003487 // Return the loop body, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003488 Succ = BodyBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003489 return BodyBlock;
3490}
3491
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003492CFGBlock *CFGBuilder::VisitContinueStmt(ContinueStmt *C) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003493 // "continue" is a control-flow statement. Thus we stop processing the
3494 // current block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003495 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003496 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003497
Ted Kremenek9aae5132007-08-23 21:42:29 +00003498 // Now create a new block that ends with the continue statement.
3499 Block = createBlock(false);
3500 Block->setTerminator(C);
Mike Stump31feda52009-07-17 01:31:16 +00003501
Ted Kremenek9aae5132007-08-23 21:42:29 +00003502 // If there is no target for the continue, then we are looking at an
Ted Kremenek882cf062009-04-07 18:53:24 +00003503 // incomplete AST. This means the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003504 if (ContinueJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00003505 addAutomaticObjHandling(ScopePos, ContinueJumpTarget.scopePosition, C);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003506 addSuccessor(Block, ContinueJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003507 } else
Ted Kremenek882cf062009-04-07 18:53:24 +00003508 badCFG = true;
Mike Stump31feda52009-07-17 01:31:16 +00003509
Ted Kremenek9aae5132007-08-23 21:42:29 +00003510 return Block;
3511}
Mike Stump11289f42009-09-09 15:08:12 +00003512
Peter Collingbournee190dee2011-03-11 19:24:49 +00003513CFGBlock *CFGBuilder::VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
3514 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003515 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003516 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003517 appendStmt(Block, E);
Ted Kremenek0747de62009-07-18 00:47:21 +00003518 }
Mike Stump11289f42009-09-09 15:08:12 +00003519
Ted Kremenek93668002009-07-17 22:18:43 +00003520 // VLA types have expressions that must be evaluated.
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003521 CFGBlock *lastBlock = Block;
3522
Ted Kremenek93668002009-07-17 22:18:43 +00003523 if (E->isArgumentType()) {
John McCall424cec92011-01-19 06:33:43 +00003524 for (const VariableArrayType *VA =FindVA(E->getArgumentType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00003525 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr()))
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003526 lastBlock = addStmt(VA->getSizeExpr());
Ted Kremenek84a1ca52011-08-06 00:30:00 +00003527 }
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003528 return lastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003529}
Mike Stump11289f42009-09-09 15:08:12 +00003530
Ted Kremenek93668002009-07-17 22:18:43 +00003531/// VisitStmtExpr - Utility method to handle (nested) statement
3532/// expressions (a GCC extension).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003533CFGBlock *CFGBuilder::VisitStmtExpr(StmtExpr *SE, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003534 if (asc.alwaysAdd(*this, SE)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003535 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003536 appendStmt(Block, SE);
Ted Kremenek0747de62009-07-18 00:47:21 +00003537 }
Ted Kremenek93668002009-07-17 22:18:43 +00003538 return VisitCompoundStmt(SE->getSubStmt());
3539}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003540
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003541CFGBlock *CFGBuilder::VisitSwitchStmt(SwitchStmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00003542 // "switch" is a control-flow statement. Thus we stop processing the current
3543 // block.
Craig Topper25542942014-05-20 04:30:07 +00003544 CFGBlock *SwitchSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003545
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003546 // Save local scope position because in case of condition variable ScopePos
3547 // won't be restored when traversing AST.
3548 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3549
Richard Smitha547eb22016-07-14 00:11:03 +00003550 // Create local scope for C++17 switch init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00003551 if (Stmt *Init = Terminator->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00003552 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00003553
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003554 // Create local scope for possible condition variable.
3555 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00003556 if (VarDecl *VD = Terminator->getConditionVariable())
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003557 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00003558
Matthias Gehre351c2182017-07-12 07:04:19 +00003559 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), Terminator);
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003560
Ted Kremenek9aae5132007-08-23 21:42:29 +00003561 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003562 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003563 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003564 SwitchSuccessor = Block;
Mike Stump31feda52009-07-17 01:31:16 +00003565 } else SwitchSuccessor = Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003566
3567 // Save the current "switch" context.
3568 SaveAndRestore<CFGBlock*> save_switch(SwitchTerminatedBlock),
Ted Kremenek654c78f2008-02-13 22:05:39 +00003569 save_default(DefaultCaseBlock);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003570 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Ted Kremenek654c78f2008-02-13 22:05:39 +00003571
Mike Stump31feda52009-07-17 01:31:16 +00003572 // Set the "default" case to be the block after the switch statement. If the
3573 // switch statement contains a "default:", this value will be overwritten with
3574 // the block for that code.
Ted Kremenek654c78f2008-02-13 22:05:39 +00003575 DefaultCaseBlock = SwitchSuccessor;
Mike Stump31feda52009-07-17 01:31:16 +00003576
Ted Kremenek9aae5132007-08-23 21:42:29 +00003577 // Create a new block that will contain the switch statement.
3578 SwitchTerminatedBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003579
Ted Kremenek9aae5132007-08-23 21:42:29 +00003580 // Now process the switch body. The code after the switch is the implicit
3581 // successor.
3582 Succ = SwitchSuccessor;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003583 BreakJumpTarget = JumpTarget(SwitchSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003584
3585 // When visiting the body, the case statements should automatically get linked
3586 // up to the switch. We also don't keep a pointer to the body, since all
3587 // control-flow from the switch goes to case/default statements.
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003588 assert(Terminator->getBody() && "switch must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00003589 Block = nullptr;
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003590
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003591 // For pruning unreachable case statements, save the current state
3592 // for tracking the condition value.
3593 SaveAndRestore<bool> save_switchExclusivelyCovered(switchExclusivelyCovered,
3594 false);
Ted Kremenekbe528712011-03-04 01:03:41 +00003595
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003596 // Determine if the switch condition can be explicitly evaluated.
3597 assert(Terminator->getCond() && "switch condition must be non-NULL");
Ted Kremenekbe528712011-03-04 01:03:41 +00003598 Expr::EvalResult result;
Ted Kremenek53e65382011-03-13 03:48:04 +00003599 bool b = tryEvaluate(Terminator->getCond(), result);
3600 SaveAndRestore<Expr::EvalResult*> save_switchCond(switchCond,
Craig Topper25542942014-05-20 04:30:07 +00003601 b ? &result : nullptr);
Ted Kremenekbe528712011-03-04 01:03:41 +00003602
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003603 // If body is not a compound statement create implicit scope
3604 // and add destructors.
3605 if (!isa<CompoundStmt>(Terminator->getBody()))
3606 addLocalScopeAndDtors(Terminator->getBody());
3607
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003608 addStmt(Terminator->getBody());
Ted Kremenek55957a82009-05-02 00:13:27 +00003609 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003610 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003611 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003612 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003613
Mike Stump31feda52009-07-17 01:31:16 +00003614 // If we have no "default:" case, the default transition is to the code
Ted Kremenek35c70f62011-03-16 04:32:01 +00003615 // following the switch body. Moreover, take into account if all the
3616 // cases of a switch are covered (e.g., switching on an enum value).
David Majnemerf69ce862013-06-04 17:38:44 +00003617 //
3618 // Note: We add a successor to a switch that is considered covered yet has no
3619 // case statements if the enumeration has no enumerators.
3620 bool SwitchAlwaysHasSuccessor = false;
3621 SwitchAlwaysHasSuccessor |= switchExclusivelyCovered;
3622 SwitchAlwaysHasSuccessor |= Terminator->isAllEnumCasesCovered() &&
3623 Terminator->getSwitchCaseList();
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003624 addSuccessor(SwitchTerminatedBlock, DefaultCaseBlock,
3625 !SwitchAlwaysHasSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003626
Ted Kremenek81e14852007-08-27 19:46:09 +00003627 // Add the terminator and condition in the switch block.
Ted Kremenekc1f9a282008-04-16 21:10:48 +00003628 SwitchTerminatedBlock->setTerminator(Terminator);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003629 Block = SwitchTerminatedBlock;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003630 CFGBlock *LastBlock = addStmt(Terminator->getCond());
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003631
Richard Smitha547eb22016-07-14 00:11:03 +00003632 // If the SwitchStmt contains a condition variable, add both the
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003633 // SwitchStmt and the condition variable initialization to the CFG.
3634 if (VarDecl *VD = Terminator->getConditionVariable()) {
3635 if (Expr *Init = VD->getInit()) {
3636 autoCreateBlock();
Ted Kremenek37881932011-04-04 23:29:12 +00003637 appendStmt(Block, Terminator->getConditionVariableDeclStmt());
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003638 LastBlock = addStmt(Init);
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003639 }
3640 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003641
Richard Smitha547eb22016-07-14 00:11:03 +00003642 // Finally, if the SwitchStmt contains a C++17 init-stmt, add it to the CFG.
3643 if (Stmt *Init = Terminator->getInit()) {
3644 autoCreateBlock();
3645 LastBlock = addStmt(Init);
3646 }
3647
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003648 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003649}
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003650
3651static bool shouldAddCase(bool &switchExclusivelyCovered,
Ted Kremenek53e65382011-03-13 03:48:04 +00003652 const Expr::EvalResult *switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003653 const CaseStmt *CS,
3654 ASTContext &Ctx) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003655 if (!switchCond)
3656 return true;
3657
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003658 bool addCase = false;
Ted Kremenekbe528712011-03-04 01:03:41 +00003659
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003660 if (!switchExclusivelyCovered) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003661 if (switchCond->Val.isInt()) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003662 // Evaluate the LHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003663 const llvm::APSInt &lhsInt = CS->getLHS()->EvaluateKnownConstInt(Ctx);
Ted Kremenek53e65382011-03-13 03:48:04 +00003664 const llvm::APSInt &condInt = switchCond->Val.getInt();
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003665
3666 if (condInt == lhsInt) {
3667 addCase = true;
3668 switchExclusivelyCovered = true;
3669 }
Devin Coughlineb538ab2015-09-22 20:31:19 +00003670 else if (condInt > lhsInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003671 if (const Expr *RHS = CS->getRHS()) {
3672 // Evaluate the RHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003673 const llvm::APSInt &V2 = RHS->EvaluateKnownConstInt(Ctx);
Devin Coughlineb538ab2015-09-22 20:31:19 +00003674 if (V2 >= condInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003675 addCase = true;
3676 switchExclusivelyCovered = true;
3677 }
3678 }
3679 }
3680 }
3681 else
3682 addCase = true;
3683 }
3684 return addCase;
3685}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003686
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003687CFGBlock *CFGBuilder::VisitCaseStmt(CaseStmt *CS) {
Mike Stump31feda52009-07-17 01:31:16 +00003688 // CaseStmts are essentially labels, so they are the first statement in a
3689 // block.
Craig Topper25542942014-05-20 04:30:07 +00003690 CFGBlock *TopBlock = nullptr, *LastBlock = nullptr;
Ted Kremenekbe528712011-03-04 01:03:41 +00003691
Ted Kremenek60fa6572010-08-04 23:54:30 +00003692 if (Stmt *Sub = CS->getSubStmt()) {
3693 // For deeply nested chains of CaseStmts, instead of doing a recursion
3694 // (which can blow out the stack), manually unroll and create blocks
3695 // along the way.
3696 while (isa<CaseStmt>(Sub)) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003697 CFGBlock *currentBlock = createBlock(false);
3698 currentBlock->setLabel(CS);
Ted Kremenek55e91e82007-08-30 18:48:11 +00003699
Ted Kremenek60fa6572010-08-04 23:54:30 +00003700 if (TopBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003701 addSuccessor(LastBlock, currentBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003702 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003703 TopBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003704
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003705 addSuccessor(SwitchTerminatedBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00003706 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003707 CS, *Context)
Craig Topper25542942014-05-20 04:30:07 +00003708 ? currentBlock : nullptr);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003709
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003710 LastBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003711 CS = cast<CaseStmt>(Sub);
3712 Sub = CS->getSubStmt();
3713 }
3714
3715 addStmt(Sub);
3716 }
Mike Stump11289f42009-09-09 15:08:12 +00003717
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003718 CFGBlock *CaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003719 if (!CaseBlock)
3720 CaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003721
3722 // Cases statements partition blocks, so this is the top of the basic block we
3723 // were processing (the "case XXX:" is the label).
Ted Kremenek93668002009-07-17 22:18:43 +00003724 CaseBlock->setLabel(CS);
3725
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003726 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003727 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003728
3729 // Add this block to the list of successors for the block with the switch
3730 // statement.
Ted Kremenek93668002009-07-17 22:18:43 +00003731 assert(SwitchTerminatedBlock);
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003732 addSuccessor(SwitchTerminatedBlock, CaseBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00003733 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003734 CS, *Context));
Mike Stump31feda52009-07-17 01:31:16 +00003735
Ted Kremenek9aae5132007-08-23 21:42:29 +00003736 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003737 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003738
Ted Kremenek60fa6572010-08-04 23:54:30 +00003739 if (TopBlock) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003740 addSuccessor(LastBlock, CaseBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003741 Succ = TopBlock;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003742 } else {
Ted Kremenek60fa6572010-08-04 23:54:30 +00003743 // This block is now the implicit successor of other blocks.
3744 Succ = CaseBlock;
3745 }
Mike Stump31feda52009-07-17 01:31:16 +00003746
Ted Kremenek60fa6572010-08-04 23:54:30 +00003747 return Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003748}
Mike Stump31feda52009-07-17 01:31:16 +00003749
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003750CFGBlock *CFGBuilder::VisitDefaultStmt(DefaultStmt *Terminator) {
Ted Kremenek93668002009-07-17 22:18:43 +00003751 if (Terminator->getSubStmt())
3752 addStmt(Terminator->getSubStmt());
Mike Stump11289f42009-09-09 15:08:12 +00003753
Ted Kremenek654c78f2008-02-13 22:05:39 +00003754 DefaultCaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003755
3756 if (!DefaultCaseBlock)
3757 DefaultCaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003758
3759 // Default statements partition blocks, so this is the top of the basic block
3760 // we were processing (the "default:" is the label).
Ted Kremenekc1f9a282008-04-16 21:10:48 +00003761 DefaultCaseBlock->setLabel(Terminator);
Mike Stump11289f42009-09-09 15:08:12 +00003762
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003763 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003764 return nullptr;
Ted Kremenek654c78f2008-02-13 22:05:39 +00003765
Mike Stump31feda52009-07-17 01:31:16 +00003766 // Unlike case statements, we don't add the default block to the successors
3767 // for the switch statement immediately. This is done when we finish
3768 // processing the switch statement. This allows for the default case
3769 // (including a fall-through to the code after the switch statement) to always
3770 // be the last successor of a switch-terminated block.
3771
Ted Kremenek654c78f2008-02-13 22:05:39 +00003772 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003773 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003774
Ted Kremenek654c78f2008-02-13 22:05:39 +00003775 // This block is now the implicit successor of other blocks.
3776 Succ = DefaultCaseBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003777
3778 return DefaultCaseBlock;
Ted Kremenek9682be12008-02-13 21:46:34 +00003779}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003780
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003781CFGBlock *CFGBuilder::VisitCXXTryStmt(CXXTryStmt *Terminator) {
3782 // "try"/"catch" is a control-flow statement. Thus we stop processing the
3783 // current block.
Craig Topper25542942014-05-20 04:30:07 +00003784 CFGBlock *TrySuccessor = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003785
3786 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003787 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003788 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003789 TrySuccessor = Block;
3790 } else TrySuccessor = Succ;
3791
Mike Stump0bdba6c2010-01-20 01:15:34 +00003792 CFGBlock *PrevTryTerminatedBlock = TryTerminatedBlock;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003793
3794 // Create a new block that will contain the try statement.
Mike Stump845384a2010-01-20 01:30:58 +00003795 CFGBlock *NewTryTerminatedBlock = createBlock(false);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003796 // Add the terminator in the try block.
Mike Stump845384a2010-01-20 01:30:58 +00003797 NewTryTerminatedBlock->setTerminator(Terminator);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003798
Mike Stump0bdba6c2010-01-20 01:15:34 +00003799 bool HasCatchAll = false;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003800 for (unsigned h = 0; h <Terminator->getNumHandlers(); ++h) {
3801 // The code after the try is the implicit successor.
3802 Succ = TrySuccessor;
3803 CXXCatchStmt *CS = Terminator->getHandler(h);
Craig Topper25542942014-05-20 04:30:07 +00003804 if (CS->getExceptionDecl() == nullptr) {
Mike Stump0bdba6c2010-01-20 01:15:34 +00003805 HasCatchAll = true;
3806 }
Craig Topper25542942014-05-20 04:30:07 +00003807 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003808 CFGBlock *CatchBlock = VisitCXXCatchStmt(CS);
Craig Topper25542942014-05-20 04:30:07 +00003809 if (!CatchBlock)
3810 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003811 // Add this block to the list of successors for the block with the try
3812 // statement.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003813 addSuccessor(NewTryTerminatedBlock, CatchBlock);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003814 }
Mike Stump0bdba6c2010-01-20 01:15:34 +00003815 if (!HasCatchAll) {
3816 if (PrevTryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003817 addSuccessor(NewTryTerminatedBlock, PrevTryTerminatedBlock);
Mike Stump0bdba6c2010-01-20 01:15:34 +00003818 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003819 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
Mike Stump0bdba6c2010-01-20 01:15:34 +00003820 }
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003821
3822 // The code after the try is the implicit successor.
3823 Succ = TrySuccessor;
3824
Mike Stump845384a2010-01-20 01:30:58 +00003825 // Save the current "try" context.
Ted Kremenek6b9964d2011-08-23 23:05:07 +00003826 SaveAndRestore<CFGBlock*> save_try(TryTerminatedBlock, NewTryTerminatedBlock);
3827 cfg->addTryDispatchBlock(TryTerminatedBlock);
Mike Stump845384a2010-01-20 01:30:58 +00003828
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003829 assert(Terminator->getTryBlock() && "try must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00003830 Block = nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003831 return addStmt(Terminator->getTryBlock());
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003832}
3833
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003834CFGBlock *CFGBuilder::VisitCXXCatchStmt(CXXCatchStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003835 // CXXCatchStmt are treated like labels, so they are the first statement in a
3836 // block.
3837
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00003838 // Save local scope position because in case of exception variable ScopePos
3839 // won't be restored when traversing AST.
3840 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3841
3842 // Create local scope for possible exception variable.
3843 // Store scope position. Add implicit destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003844 if (VarDecl *VD = CS->getExceptionDecl()) {
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00003845 LocalScope::const_iterator BeginScopePos = ScopePos;
3846 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00003847 addAutomaticObjHandling(ScopePos, BeginScopePos, CS);
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00003848 }
3849
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003850 if (CS->getHandlerBlock())
3851 addStmt(CS->getHandlerBlock());
3852
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003853 CFGBlock *CatchBlock = Block;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003854 if (!CatchBlock)
3855 CatchBlock = createBlock();
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00003856
3857 // CXXCatchStmt is more than just a label. They have semantic meaning
3858 // as well, as they implicitly "initialize" the catch variable. Add
3859 // it to the CFG as a CFGElement so that the control-flow of these
3860 // semantics gets captured.
3861 appendStmt(CatchBlock, CS);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003862
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00003863 // Also add the CXXCatchStmt as a label, to mirror handling of regular
3864 // labels.
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003865 CatchBlock->setLabel(CS);
3866
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00003867 // Bail out if the CFG is bad.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003868 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003869 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003870
3871 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003872 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003873
3874 return CatchBlock;
3875}
3876
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003877CFGBlock *CFGBuilder::VisitCXXForRangeStmt(CXXForRangeStmt *S) {
Richard Smith02e85f32011-04-14 22:09:26 +00003878 // C++0x for-range statements are specified as [stmt.ranged]:
3879 //
3880 // {
3881 // auto && __range = range-init;
3882 // for ( auto __begin = begin-expr,
3883 // __end = end-expr;
3884 // __begin != __end;
3885 // ++__begin ) {
3886 // for-range-declaration = *__begin;
3887 // statement
3888 // }
3889 // }
3890
3891 // Save local scope position before the addition of the implicit variables.
3892 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3893
3894 // Create local scopes and destructors for range, begin and end variables.
3895 if (Stmt *Range = S->getRangeStmt())
3896 addLocalScopeForStmt(Range);
Richard Smith01694c32016-03-20 10:33:40 +00003897 if (Stmt *Begin = S->getBeginStmt())
3898 addLocalScopeForStmt(Begin);
3899 if (Stmt *End = S->getEndStmt())
3900 addLocalScopeForStmt(End);
Matthias Gehre351c2182017-07-12 07:04:19 +00003901 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), S);
Richard Smith02e85f32011-04-14 22:09:26 +00003902
3903 LocalScope::const_iterator ContinueScopePos = ScopePos;
3904
3905 // "for" is a control-flow statement. Thus we stop processing the current
3906 // block.
Craig Topper25542942014-05-20 04:30:07 +00003907 CFGBlock *LoopSuccessor = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003908 if (Block) {
3909 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003910 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003911 LoopSuccessor = Block;
3912 } else
3913 LoopSuccessor = Succ;
3914
3915 // Save the current value for the break targets.
3916 // All breaks should go to the code following the loop.
3917 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
3918 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
3919
3920 // The block for the __begin != __end expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003921 CFGBlock *ConditionBlock = createBlock(false);
Richard Smith02e85f32011-04-14 22:09:26 +00003922 ConditionBlock->setTerminator(S);
3923
3924 // Now add the actual condition to the condition block.
3925 if (Expr *C = S->getCond()) {
3926 Block = ConditionBlock;
3927 CFGBlock *BeginConditionBlock = addStmt(C);
3928 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003929 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003930 assert(BeginConditionBlock == ConditionBlock &&
3931 "condition block in for-range was unexpectedly complex");
3932 (void)BeginConditionBlock;
3933 }
3934
3935 // The condition block is the implicit successor for the loop body as well as
3936 // any code above the loop.
3937 Succ = ConditionBlock;
3938
3939 // See if this is a known constant.
3940 TryResult KnownVal(true);
3941
3942 if (S->getCond())
3943 KnownVal = tryEvaluateBool(S->getCond());
3944
3945 // Now create the loop body.
3946 {
3947 assert(S->getBody());
3948
3949 // Save the current values for Block, Succ, and continue targets.
3950 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3951 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
3952
3953 // Generate increment code in its own basic block. This is the target of
3954 // continue statements.
Craig Topper25542942014-05-20 04:30:07 +00003955 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003956 Succ = addStmt(S->getInc());
Alexander Kornienkoff2046a2016-07-08 10:50:51 +00003957 if (badCFG)
3958 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003959 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
3960
3961 // The starting block for the loop increment is the block that should
3962 // represent the 'loop target' for looping back to the start of the loop.
3963 ContinueJumpTarget.block->setLoopTarget(S);
3964
3965 // Finish up the increment block and prepare to start the loop body.
3966 assert(Block);
3967 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003968 return nullptr;
3969 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003970
3971 // Add implicit scope and dtors for loop variable.
3972 addLocalScopeAndDtors(S->getLoopVarStmt());
3973
3974 // Populate a new block to contain the loop body and loop variable.
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003975 addStmt(S->getBody());
Richard Smith02e85f32011-04-14 22:09:26 +00003976 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003977 return nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003978 CFGBlock *LoopVarStmtBlock = addStmt(S->getLoopVarStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00003979 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003980 return nullptr;
3981
Richard Smith02e85f32011-04-14 22:09:26 +00003982 // This new body block is a successor to our condition block.
Craig Topper25542942014-05-20 04:30:07 +00003983 addSuccessor(ConditionBlock,
3984 KnownVal.isFalse() ? nullptr : LoopVarStmtBlock);
Richard Smith02e85f32011-04-14 22:09:26 +00003985 }
3986
3987 // Link up the condition block with the code that follows the loop (the
3988 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003989 addSuccessor(ConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Richard Smith02e85f32011-04-14 22:09:26 +00003990
3991 // Add the initialization statements.
3992 Block = createBlock();
Richard Smith01694c32016-03-20 10:33:40 +00003993 addStmt(S->getBeginStmt());
3994 addStmt(S->getEndStmt());
Richard Smith0c502d22011-04-18 15:49:25 +00003995 return addStmt(S->getRangeStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00003996}
3997
John McCall5d413782010-12-06 08:20:24 +00003998CFGBlock *CFGBuilder::VisitExprWithCleanups(ExprWithCleanups *E,
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003999 AddStmtChoice asc) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004000 if (BuildOpts.AddTemporaryDtors) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004001 // If adding implicit destructors visit the full expression for adding
4002 // destructors of temporaries.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004003 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00004004 VisitForTemporaryDtors(E->getSubExpr(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004005
4006 // Full expression has to be added as CFGStmt so it will be sequenced
4007 // before destructors of it's temporaries.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004008 asc = asc.withAlwaysAdd(true);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004009 }
4010 return Visit(E->getSubExpr(), asc);
4011}
4012
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004013CFGBlock *CFGBuilder::VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
4014 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004015 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004016 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004017 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004018
Artem Dergachev783a4572018-02-23 22:20:39 +00004019 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00004020 ConstructionContextLayer::create(cfg->getBumpVectorContext(), E),
Artem Dergachev783a4572018-02-23 22:20:39 +00004021 E->getSubExpr());
Artem Dergachev1f68d9d2018-02-15 03:13:36 +00004022
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004023 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004024 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004025 }
4026 return Visit(E->getSubExpr(), asc);
4027}
4028
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004029CFGBlock *CFGBuilder::VisitCXXConstructExpr(CXXConstructExpr *C,
4030 AddStmtChoice asc) {
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004031 autoCreateBlock();
Artem Dergachev41ffb302018-02-08 22:58:15 +00004032 appendConstructor(Block, C);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004033
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004034 return VisitChildren(C);
4035}
4036
Jordan Rosec9176072014-01-13 17:59:19 +00004037CFGBlock *CFGBuilder::VisitCXXNewExpr(CXXNewExpr *NE,
4038 AddStmtChoice asc) {
Jordan Rosec9176072014-01-13 17:59:19 +00004039 autoCreateBlock();
4040 appendStmt(Block, NE);
Jordan Rose6f5f7192014-01-14 17:29:12 +00004041
Artem Dergachev783a4572018-02-23 22:20:39 +00004042 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00004043 ConstructionContextLayer::create(cfg->getBumpVectorContext(), NE),
Artem Dergachev783a4572018-02-23 22:20:39 +00004044 const_cast<CXXConstructExpr *>(NE->getConstructExpr()));
Artem Dergachev41ffb302018-02-08 22:58:15 +00004045
Jordan Rosec9176072014-01-13 17:59:19 +00004046 if (NE->getInitializer())
Jordan Rose6f5f7192014-01-14 17:29:12 +00004047 Block = Visit(NE->getInitializer());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004048
Jordan Rosec9176072014-01-13 17:59:19 +00004049 if (BuildOpts.AddCXXNewAllocator)
4050 appendNewAllocator(Block, NE);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004051
Jordan Rosec9176072014-01-13 17:59:19 +00004052 if (NE->isArray())
Jordan Rose6f5f7192014-01-14 17:29:12 +00004053 Block = Visit(NE->getArraySize());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004054
Jordan Rosec9176072014-01-13 17:59:19 +00004055 for (CXXNewExpr::arg_iterator I = NE->placement_arg_begin(),
4056 E = NE->placement_arg_end(); I != E; ++I)
Jordan Rose6f5f7192014-01-14 17:29:12 +00004057 Block = Visit(*I);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004058
Jordan Rosec9176072014-01-13 17:59:19 +00004059 return Block;
4060}
Jordan Rosed2f40792013-09-03 17:00:57 +00004061
4062CFGBlock *CFGBuilder::VisitCXXDeleteExpr(CXXDeleteExpr *DE,
4063 AddStmtChoice asc) {
4064 autoCreateBlock();
4065 appendStmt(Block, DE);
4066 QualType DTy = DE->getDestroyedType();
Martin Bohmef44cde82016-12-05 11:33:19 +00004067 if (!DTy.isNull()) {
4068 DTy = DTy.getNonReferenceType();
4069 CXXRecordDecl *RD = Context->getBaseElementType(DTy)->getAsCXXRecordDecl();
4070 if (RD) {
4071 if (RD->isCompleteDefinition() && !RD->hasTrivialDestructor())
4072 appendDeleteDtor(Block, RD, DE);
4073 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004074 }
4075
4076 return VisitChildren(DE);
4077}
4078
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004079CFGBlock *CFGBuilder::VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
4080 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004081 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004082 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004083 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004084 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004085 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004086 }
4087 return Visit(E->getSubExpr(), asc);
4088}
4089
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004090CFGBlock *CFGBuilder::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
4091 AddStmtChoice asc) {
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004092 autoCreateBlock();
Artem Dergachev1f68d9d2018-02-15 03:13:36 +00004093 appendConstructor(Block, C);
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004094 return VisitChildren(C);
4095}
4096
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004097CFGBlock *CFGBuilder::VisitImplicitCastExpr(ImplicitCastExpr *E,
4098 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004099 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004100 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004101 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004102 }
Ted Kremenek8219b822010-12-16 07:46:53 +00004103 return Visit(E->getSubExpr(), AddStmtChoice());
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004104}
4105
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004106CFGBlock *CFGBuilder::VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00004107 // Lazily create the indirect-goto dispatch block if there isn't one already.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004108 CFGBlock *IBlock = cfg->getIndirectGotoBlock();
Mike Stump31feda52009-07-17 01:31:16 +00004109
Ted Kremenekeda180e22007-08-28 19:26:49 +00004110 if (!IBlock) {
4111 IBlock = createBlock(false);
4112 cfg->setIndirectGotoBlock(IBlock);
4113 }
Mike Stump31feda52009-07-17 01:31:16 +00004114
Ted Kremenekeda180e22007-08-28 19:26:49 +00004115 // IndirectGoto is a control-flow statement. Thus we stop processing the
4116 // current block and create a new one.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004117 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004118 return nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00004119
Ted Kremenekeda180e22007-08-28 19:26:49 +00004120 Block = createBlock(false);
4121 Block->setTerminator(I);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004122 addSuccessor(Block, IBlock);
Ted Kremenekeda180e22007-08-28 19:26:49 +00004123 return addStmt(I->getTarget());
4124}
4125
Manuel Klimekb5616c92014-08-07 10:42:17 +00004126CFGBlock *CFGBuilder::VisitForTemporaryDtors(Stmt *E, bool BindToTemporary,
4127 TempDtorContext &Context) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004128 assert(BuildOpts.AddImplicitDtors && BuildOpts.AddTemporaryDtors);
4129
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004130tryAgain:
4131 if (!E) {
4132 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00004133 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004134 }
4135 switch (E->getStmtClass()) {
4136 default:
Manuel Klimekb5616c92014-08-07 10:42:17 +00004137 return VisitChildrenForTemporaryDtors(E, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004138
4139 case Stmt::BinaryOperatorClass:
Manuel Klimekb5616c92014-08-07 10:42:17 +00004140 return VisitBinaryOperatorForTemporaryDtors(cast<BinaryOperator>(E),
4141 Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004142
4143 case Stmt::CXXBindTemporaryExprClass:
4144 return VisitCXXBindTemporaryExprForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004145 cast<CXXBindTemporaryExpr>(E), BindToTemporary, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004146
John McCallc07a0c72011-02-17 10:25:35 +00004147 case Stmt::BinaryConditionalOperatorClass:
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004148 case Stmt::ConditionalOperatorClass:
4149 return VisitConditionalOperatorForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004150 cast<AbstractConditionalOperator>(E), BindToTemporary, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004151
4152 case Stmt::ImplicitCastExprClass:
4153 // For implicit cast we want BindToTemporary to be passed further.
4154 E = cast<CastExpr>(E)->getSubExpr();
4155 goto tryAgain;
4156
Manuel Klimekb0042c42014-07-30 08:34:42 +00004157 case Stmt::CXXFunctionalCastExprClass:
4158 // For functional cast we want BindToTemporary to be passed further.
4159 E = cast<CXXFunctionalCastExpr>(E)->getSubExpr();
4160 goto tryAgain;
4161
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004162 case Stmt::ParenExprClass:
4163 E = cast<ParenExpr>(E)->getSubExpr();
4164 goto tryAgain;
Richard Smith4137af22014-07-27 05:12:49 +00004165
Manuel Klimekb0042c42014-07-30 08:34:42 +00004166 case Stmt::MaterializeTemporaryExprClass: {
4167 const MaterializeTemporaryExpr* MTE = cast<MaterializeTemporaryExpr>(E);
4168 BindToTemporary = (MTE->getStorageDuration() != SD_FullExpression);
4169 SmallVector<const Expr *, 2> CommaLHSs;
4170 SmallVector<SubobjectAdjustment, 2> Adjustments;
4171 // Find the expression whose lifetime needs to be extended.
4172 E = const_cast<Expr *>(
4173 cast<MaterializeTemporaryExpr>(E)
4174 ->GetTemporaryExpr()
4175 ->skipRValueSubobjectAdjustments(CommaLHSs, Adjustments));
4176 // Visit the skipped comma operator left-hand sides for other temporaries.
4177 for (const Expr *CommaLHS : CommaLHSs) {
4178 VisitForTemporaryDtors(const_cast<Expr *>(CommaLHS),
Manuel Klimekb5616c92014-08-07 10:42:17 +00004179 /*BindToTemporary=*/false, Context);
Manuel Klimekb0042c42014-07-30 08:34:42 +00004180 }
Douglas Gregorfe314812011-06-21 17:03:29 +00004181 goto tryAgain;
Manuel Klimekb0042c42014-07-30 08:34:42 +00004182 }
Richard Smith4137af22014-07-27 05:12:49 +00004183
4184 case Stmt::BlockExprClass:
4185 // Don't recurse into blocks; their subexpressions don't get evaluated
4186 // here.
4187 return Block;
4188
4189 case Stmt::LambdaExprClass: {
4190 // For lambda expressions, only recurse into the capture initializers,
4191 // and not the body.
4192 auto *LE = cast<LambdaExpr>(E);
4193 CFGBlock *B = Block;
4194 for (Expr *Init : LE->capture_inits()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004195 if (CFGBlock *R = VisitForTemporaryDtors(
4196 Init, /*BindToTemporary=*/false, Context))
Richard Smith4137af22014-07-27 05:12:49 +00004197 B = R;
4198 }
4199 return B;
4200 }
4201
4202 case Stmt::CXXDefaultArgExprClass:
4203 E = cast<CXXDefaultArgExpr>(E)->getExpr();
4204 goto tryAgain;
4205
4206 case Stmt::CXXDefaultInitExprClass:
4207 E = cast<CXXDefaultInitExpr>(E)->getExpr();
4208 goto tryAgain;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004209 }
4210}
4211
Manuel Klimekb5616c92014-08-07 10:42:17 +00004212CFGBlock *CFGBuilder::VisitChildrenForTemporaryDtors(Stmt *E,
4213 TempDtorContext &Context) {
4214 if (isa<LambdaExpr>(E)) {
4215 // Do not visit the children of lambdas; they have their own CFGs.
4216 return Block;
4217 }
4218
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004219 // When visiting children for destructors we want to visit them in reverse
Ted Kremenek8ae67872013-02-05 22:00:19 +00004220 // order that they will appear in the CFG. Because the CFG is built
4221 // bottom-up, this means we visit them in their natural order, which
4222 // reverses them in the CFG.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004223 CFGBlock *B = Block;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004224 for (Stmt *Child : E->children())
4225 if (Child)
Manuel Klimekb5616c92014-08-07 10:42:17 +00004226 if (CFGBlock *R = VisitForTemporaryDtors(Child, false, Context))
Ted Kremenek8ae67872013-02-05 22:00:19 +00004227 B = R;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004228
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004229 return B;
4230}
4231
Manuel Klimekb5616c92014-08-07 10:42:17 +00004232CFGBlock *CFGBuilder::VisitBinaryOperatorForTemporaryDtors(
4233 BinaryOperator *E, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004234 if (E->isLogicalOp()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004235 VisitForTemporaryDtors(E->getLHS(), false, Context);
Manuel Klimekedf925b92014-08-07 18:44:19 +00004236 TryResult RHSExecuted = tryEvaluateBool(E->getLHS());
4237 if (RHSExecuted.isKnown() && E->getOpcode() == BO_LOr)
4238 RHSExecuted.negate();
Manuel Klimek7c030132014-08-07 16:05:51 +00004239
Manuel Klimekedf925b92014-08-07 18:44:19 +00004240 // We do not know at CFG-construction time whether the right-hand-side was
4241 // executed, thus we add a branch node that depends on the temporary
4242 // constructor call.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004243 TempDtorContext RHSContext(
4244 bothKnownTrue(Context.KnownExecuted, RHSExecuted));
Manuel Klimekedf925b92014-08-07 18:44:19 +00004245 VisitForTemporaryDtors(E->getRHS(), false, RHSContext);
Manuel Klimekdeb02622014-08-08 07:37:13 +00004246 InsertTempDtorDecisionBlock(RHSContext);
Manuel Klimek7c030132014-08-07 16:05:51 +00004247
Manuel Klimekb5616c92014-08-07 10:42:17 +00004248 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004249 }
4250
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004251 if (E->isAssignmentOp()) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004252 // For assignment operator (=) LHS expression is visited
4253 // before RHS expression. For destructors visit them in reverse order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004254 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
4255 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004256 return LHSBlock ? LHSBlock : RHSBlock;
4257 }
4258
4259 // For any other binary operator RHS expression is visited before
4260 // LHS expression (order of children). For destructors visit them in reverse
4261 // order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004262 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
4263 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004264 return RHSBlock ? RHSBlock : LHSBlock;
4265}
4266
4267CFGBlock *CFGBuilder::VisitCXXBindTemporaryExprForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004268 CXXBindTemporaryExpr *E, bool BindToTemporary, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004269 // First add destructors for temporaries in subexpression.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004270 CFGBlock *B = VisitForTemporaryDtors(E->getSubExpr(), false, Context);
Zhongxing Xufee455f2010-11-14 15:23:50 +00004271 if (!BindToTemporary) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004272 // If lifetime of temporary is not prolonged (by assigning to constant
4273 // reference) add destructor for it.
Chandler Carruthad747252011-09-13 06:09:01 +00004274
Chandler Carruthad747252011-09-13 06:09:01 +00004275 const CXXDestructorDecl *Dtor = E->getTemporary()->getDestructor();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004276
Richard Trieu95a192a2015-05-28 00:14:02 +00004277 if (Dtor->getParent()->isAnyDestructorNoReturn()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004278 // If the destructor is marked as a no-return destructor, we need to
4279 // create a new block for the destructor which does not have as a
4280 // successor anything built thus far. Control won't flow out of this
4281 // block.
4282 if (B) Succ = B;
Chandler Carrutha70991b2011-09-13 09:13:49 +00004283 Block = createNoReturnBlock();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004284 } else if (Context.needsTempDtorBranch()) {
4285 // If we need to introduce a branch, we add a new block that we will hook
4286 // up to a decision block later.
4287 if (B) Succ = B;
4288 Block = createBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004289 } else {
Chandler Carruthad747252011-09-13 06:09:01 +00004290 autoCreateBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004291 }
Manuel Klimekb5616c92014-08-07 10:42:17 +00004292 if (Context.needsTempDtorBranch()) {
4293 Context.setDecisionPoint(Succ, E);
4294 }
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004295 appendTemporaryDtor(Block, E);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004296
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004297 B = Block;
4298 }
4299 return B;
4300}
4301
Manuel Klimekb5616c92014-08-07 10:42:17 +00004302void CFGBuilder::InsertTempDtorDecisionBlock(const TempDtorContext &Context,
4303 CFGBlock *FalseSucc) {
4304 if (!Context.TerminatorExpr) {
4305 // If no temporary was found, we do not need to insert a decision point.
4306 return;
4307 }
4308 assert(Context.TerminatorExpr);
4309 CFGBlock *Decision = createBlock(false);
4310 Decision->setTerminator(CFGTerminator(Context.TerminatorExpr, true));
Manuel Klimekdeb02622014-08-08 07:37:13 +00004311 addSuccessor(Decision, Block, !Context.KnownExecuted.isFalse());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004312 addSuccessor(Decision, FalseSucc ? FalseSucc : Context.Succ,
Manuel Klimekdeb02622014-08-08 07:37:13 +00004313 !Context.KnownExecuted.isTrue());
Manuel Klimekb5616c92014-08-07 10:42:17 +00004314 Block = Decision;
4315}
4316
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004317CFGBlock *CFGBuilder::VisitConditionalOperatorForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004318 AbstractConditionalOperator *E, bool BindToTemporary,
4319 TempDtorContext &Context) {
4320 VisitForTemporaryDtors(E->getCond(), false, Context);
4321 CFGBlock *ConditionBlock = Block;
4322 CFGBlock *ConditionSucc = Succ;
Manuel Klimek0ce91082014-08-07 14:25:43 +00004323 TryResult ConditionVal = tryEvaluateBool(E->getCond());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004324 TryResult NegatedVal = ConditionVal;
4325 if (NegatedVal.isKnown()) NegatedVal.negate();
Manuel Klimekcadc6032014-08-07 17:02:21 +00004326
Manuel Klimekdeb02622014-08-08 07:37:13 +00004327 TempDtorContext TrueContext(
4328 bothKnownTrue(Context.KnownExecuted, ConditionVal));
Manuel Klimekcadc6032014-08-07 17:02:21 +00004329 VisitForTemporaryDtors(E->getTrueExpr(), BindToTemporary, TrueContext);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004330 CFGBlock *TrueBlock = Block;
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004331
Manuel Klimekb5616c92014-08-07 10:42:17 +00004332 Block = ConditionBlock;
4333 Succ = ConditionSucc;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004334 TempDtorContext FalseContext(
4335 bothKnownTrue(Context.KnownExecuted, NegatedVal));
Manuel Klimekcadc6032014-08-07 17:02:21 +00004336 VisitForTemporaryDtors(E->getFalseExpr(), BindToTemporary, FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004337
Manuel Klimekb5616c92014-08-07 10:42:17 +00004338 if (TrueContext.TerminatorExpr && FalseContext.TerminatorExpr) {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004339 InsertTempDtorDecisionBlock(FalseContext, TrueBlock);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004340 } else if (TrueContext.TerminatorExpr) {
4341 Block = TrueBlock;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004342 InsertTempDtorDecisionBlock(TrueContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004343 } else {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004344 InsertTempDtorDecisionBlock(FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004345 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004346 return Block;
4347}
4348
Mike Stump31feda52009-07-17 01:31:16 +00004349/// createBlock - Constructs and adds a new CFGBlock to the CFG. The block has
4350/// no successors or predecessors. If this is the first block created in the
4351/// CFG, it is automatically set to be the Entry and Exit of the CFG.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004352CFGBlock *CFG::createBlock() {
Ted Kremenek889073f2007-08-23 16:51:22 +00004353 bool first_block = begin() == end();
4354
4355 // Create the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004356 CFGBlock *Mem = getAllocator().Allocate<CFGBlock>();
Anna Zaks02a1fc12011-12-05 21:33:11 +00004357 new (Mem) CFGBlock(NumBlockIDs++, BlkBVC, this);
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004358 Blocks.push_back(Mem, BlkBVC);
Ted Kremenek889073f2007-08-23 16:51:22 +00004359
4360 // If this is the first block, set it as the Entry and Exit.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004361 if (first_block)
4362 Entry = Exit = &back();
Ted Kremenek889073f2007-08-23 16:51:22 +00004363
4364 // Return the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004365 return &back();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004366}
4367
David Blaikiee90195c2014-08-29 18:53:26 +00004368/// buildCFG - Constructs a CFG from an AST.
4369std::unique_ptr<CFG> CFG::buildCFG(const Decl *D, Stmt *Statement,
4370 ASTContext *C, const BuildOptions &BO) {
Ted Kremenekf9d82902011-03-10 01:14:05 +00004371 CFGBuilder Builder(C, BO);
4372 return Builder.buildCFG(D, Statement);
Ted Kremenek889073f2007-08-23 16:51:22 +00004373}
4374
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004375const CXXDestructorDecl *
4376CFGImplicitDtor::getDestructorDecl(ASTContext &astContext) const {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004377 switch (getKind()) {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004378 case CFGElement::Initializer:
Jordan Rosec9176072014-01-13 17:59:19 +00004379 case CFGElement::NewAllocator:
Peter Szecsi999a25f2017-08-19 11:19:16 +00004380 case CFGElement::LoopExit:
Matthias Gehre351c2182017-07-12 07:04:19 +00004381 case CFGElement::LifetimeEnds:
Artem Dergachev41ffb302018-02-08 22:58:15 +00004382 case CFGElement::Statement:
4383 case CFGElement::Constructor:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004384 llvm_unreachable("getDestructorDecl should only be used with "
4385 "ImplicitDtors");
4386 case CFGElement::AutomaticObjectDtor: {
David Blaikie2a01f5d2013-02-21 20:58:29 +00004387 const VarDecl *var = castAs<CFGAutomaticObjDtor>().getVarDecl();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004388 QualType ty = var->getType();
Devin Coughlin6eb1ca72016-08-02 21:07:23 +00004389
4390 // FIXME: See CFGBuilder::addLocalScopeForVarDecl.
4391 //
4392 // Lifetime-extending constructs are handled here. This works for a single
4393 // temporary in an initializer expression.
4394 if (ty->isReferenceType()) {
4395 if (const Expr *Init = var->getInit()) {
4396 ty = getReferenceInitTemporaryType(astContext, Init);
4397 }
4398 }
4399
Ted Kremeneke7d78882012-03-19 23:48:41 +00004400 while (const ArrayType *arrayType = astContext.getAsArrayType(ty)) {
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004401 ty = arrayType->getElementType();
4402 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004403 const RecordType *recordType = ty->getAs<RecordType>();
4404 const CXXRecordDecl *classDecl =
Ted Kremenek1676a042011-03-03 01:01:03 +00004405 cast<CXXRecordDecl>(recordType->getDecl());
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004406 return classDecl->getDestructor();
4407 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004408 case CFGElement::DeleteDtor: {
4409 const CXXDeleteExpr *DE = castAs<CFGDeleteDtor>().getDeleteExpr();
4410 QualType DTy = DE->getDestroyedType();
4411 DTy = DTy.getNonReferenceType();
4412 const CXXRecordDecl *classDecl =
4413 astContext.getBaseElementType(DTy)->getAsCXXRecordDecl();
4414 return classDecl->getDestructor();
4415 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004416 case CFGElement::TemporaryDtor: {
4417 const CXXBindTemporaryExpr *bindExpr =
David Blaikie2a01f5d2013-02-21 20:58:29 +00004418 castAs<CFGTemporaryDtor>().getBindTemporaryExpr();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004419 const CXXTemporary *temp = bindExpr->getTemporary();
4420 return temp->getDestructor();
4421 }
4422 case CFGElement::BaseDtor:
4423 case CFGElement::MemberDtor:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004424 // Not yet supported.
Craig Topper25542942014-05-20 04:30:07 +00004425 return nullptr;
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004426 }
Ted Kremenek1676a042011-03-03 01:01:03 +00004427 llvm_unreachable("getKind() returned bogus value");
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004428}
4429
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004430bool CFGImplicitDtor::isNoReturn(ASTContext &astContext) const {
Richard Smith10876ef2013-01-17 01:30:42 +00004431 if (const CXXDestructorDecl *DD = getDestructorDecl(astContext))
4432 return DD->isNoReturn();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004433 return false;
Ted Kremenek96a7a592011-03-01 03:15:10 +00004434}
4435
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00004436//===----------------------------------------------------------------------===//
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004437// CFGBlock operations.
Ted Kremenekb0371852010-09-09 00:06:04 +00004438//===----------------------------------------------------------------------===//
4439
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004440CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, bool IsReachable)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004441 : ReachableBlock(IsReachable ? B : nullptr),
4442 UnreachableBlock(!IsReachable ? B : nullptr,
4443 B && IsReachable ? AB_Normal : AB_Unreachable) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004444
4445CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, CFGBlock *AlternateBlock)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004446 : ReachableBlock(B),
4447 UnreachableBlock(B == AlternateBlock ? nullptr : AlternateBlock,
4448 B == AlternateBlock ? AB_Alternate : AB_Normal) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004449
4450void CFGBlock::addSuccessor(AdjacentBlock Succ,
4451 BumpVectorContext &C) {
4452 if (CFGBlock *B = Succ.getReachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004453 B->Preds.push_back(AdjacentBlock(this, Succ.isReachable()), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004454
4455 if (CFGBlock *UnreachableB = Succ.getPossiblyUnreachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004456 UnreachableB->Preds.push_back(AdjacentBlock(this, false), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004457
4458 Succs.push_back(Succ, C);
4459}
4460
Ted Kremenekb0371852010-09-09 00:06:04 +00004461bool CFGBlock::FilterEdge(const CFGBlock::FilterOptions &F,
Ted Kremenekf146cd12010-09-09 02:57:48 +00004462 const CFGBlock *From, const CFGBlock *To) {
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004463 if (F.IgnoreNullPredecessors && !From)
4464 return true;
4465
4466 if (To && From && F.IgnoreDefaultsWithCoveredEnums) {
Ted Kremenekb0371852010-09-09 00:06:04 +00004467 // If the 'To' has no label or is labeled but the label isn't a
4468 // CaseStmt then filter this edge.
4469 if (const SwitchStmt *S =
Ted Kremenek89794742011-03-07 22:04:39 +00004470 dyn_cast_or_null<SwitchStmt>(From->getTerminator().getStmt())) {
Ted Kremenekb0371852010-09-09 00:06:04 +00004471 if (S->isAllEnumCasesCovered()) {
Ted Kremenek89794742011-03-07 22:04:39 +00004472 const Stmt *L = To->getLabel();
4473 if (!L || !isa<CaseStmt>(L))
4474 return true;
Ted Kremenekb0371852010-09-09 00:06:04 +00004475 }
4476 }
4477 }
4478
4479 return false;
4480}
4481
4482//===----------------------------------------------------------------------===//
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004483// CFG pretty printing
4484//===----------------------------------------------------------------------===//
4485
Ted Kremenek7e776b12007-08-22 18:22:34 +00004486namespace {
4487
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00004488class StmtPrinterHelper : public PrinterHelper {
Eugene Zelenko38c70522017-12-07 21:55:09 +00004489 using StmtMapTy = llvm::DenseMap<const Stmt *, std::pair<unsigned, unsigned>>;
4490 using DeclMapTy = llvm::DenseMap<const Decl *, std::pair<unsigned, unsigned>>;
4491
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004492 StmtMapTy StmtMap;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004493 DeclMapTy DeclMap;
Eugene Zelenko38c70522017-12-07 21:55:09 +00004494 signed currentBlock = 0;
4495 unsigned currStmt = 0;
Chris Lattnerc61089a2009-06-30 01:26:17 +00004496 const LangOptions &LangOpts;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004497
Eugene Zelenko38c70522017-12-07 21:55:09 +00004498public:
Chris Lattnerc61089a2009-06-30 01:26:17 +00004499 StmtPrinterHelper(const CFG* cfg, const LangOptions &LO)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004500 : LangOpts(LO) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004501 for (CFG::const_iterator I = cfg->begin(), E = cfg->end(); I != E; ++I ) {
4502 unsigned j = 1;
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004503 for (CFGBlock::const_iterator BI = (*I)->begin(), BEnd = (*I)->end() ;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004504 BI != BEnd; ++BI, ++j ) {
David Blaikie00be69a2013-02-23 00:29:34 +00004505 if (Optional<CFGStmt> SE = BI->getAs<CFGStmt>()) {
4506 const Stmt *stmt= SE->getStmt();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004507 std::pair<unsigned, unsigned> P((*I)->getBlockID(), j);
Ted Kremenek96a7a592011-03-01 03:15:10 +00004508 StmtMap[stmt] = P;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004509
Ted Kremenek96a7a592011-03-01 03:15:10 +00004510 switch (stmt->getStmtClass()) {
4511 case Stmt::DeclStmtClass:
Artem Dergachev41ffb302018-02-08 22:58:15 +00004512 DeclMap[cast<DeclStmt>(stmt)->getSingleDecl()] = P;
4513 break;
Ted Kremenek96a7a592011-03-01 03:15:10 +00004514 case Stmt::IfStmtClass: {
4515 const VarDecl *var = cast<IfStmt>(stmt)->getConditionVariable();
4516 if (var)
4517 DeclMap[var] = P;
4518 break;
4519 }
4520 case Stmt::ForStmtClass: {
4521 const VarDecl *var = cast<ForStmt>(stmt)->getConditionVariable();
4522 if (var)
4523 DeclMap[var] = P;
4524 break;
4525 }
4526 case Stmt::WhileStmtClass: {
4527 const VarDecl *var =
4528 cast<WhileStmt>(stmt)->getConditionVariable();
4529 if (var)
4530 DeclMap[var] = P;
4531 break;
4532 }
4533 case Stmt::SwitchStmtClass: {
4534 const VarDecl *var =
4535 cast<SwitchStmt>(stmt)->getConditionVariable();
4536 if (var)
4537 DeclMap[var] = P;
4538 break;
4539 }
4540 case Stmt::CXXCatchStmtClass: {
4541 const VarDecl *var =
4542 cast<CXXCatchStmt>(stmt)->getExceptionDecl();
4543 if (var)
4544 DeclMap[var] = P;
4545 break;
4546 }
4547 default:
4548 break;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004549 }
4550 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004551 }
Zhongxing Xu2cd7a782010-09-16 01:25:47 +00004552 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004553 }
Mike Stump31feda52009-07-17 01:31:16 +00004554
Eugene Zelenko38c70522017-12-07 21:55:09 +00004555 ~StmtPrinterHelper() override = default;
Mike Stump31feda52009-07-17 01:31:16 +00004556
Chris Lattnerc61089a2009-06-30 01:26:17 +00004557 const LangOptions &getLangOpts() const { return LangOpts; }
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004558 void setBlockID(signed i) { currentBlock = i; }
Ted Kremenekd94854a2012-08-22 06:26:15 +00004559 void setStmtID(unsigned i) { currStmt = i; }
Mike Stump31feda52009-07-17 01:31:16 +00004560
Craig Topperb45acb82014-03-14 06:02:07 +00004561 bool handledStmt(Stmt *S, raw_ostream &OS) override {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004562 StmtMapTy::iterator I = StmtMap.find(S);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004563
4564 if (I == StmtMap.end())
4565 return false;
Mike Stump31feda52009-07-17 01:31:16 +00004566
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004567 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00004568 && I->second.second == currStmt) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004569 return false;
Ted Kremenek60983dc2010-01-19 20:52:05 +00004570 }
Mike Stump31feda52009-07-17 01:31:16 +00004571
Ted Kremenek60983dc2010-01-19 20:52:05 +00004572 OS << "[B" << I->second.first << "." << I->second.second << "]";
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004573 return true;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004574 }
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004575
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004576 bool handleDecl(const Decl *D, raw_ostream &OS) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004577 DeclMapTy::iterator I = DeclMap.find(D);
4578
4579 if (I == DeclMap.end())
4580 return false;
4581
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004582 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00004583 && I->second.second == currStmt) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004584 return false;
4585 }
4586
4587 OS << "[B" << I->second.first << "." << I->second.second << "]";
4588 return true;
4589 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004590};
4591
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00004592class CFGBlockTerminatorPrint
Eugene Zelenko38c70522017-12-07 21:55:09 +00004593 : public StmtVisitor<CFGBlockTerminatorPrint,void> {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004594 raw_ostream &OS;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004595 StmtPrinterHelper* Helper;
Douglas Gregor7de59662009-05-29 20:38:28 +00004596 PrintingPolicy Policy;
Eugene Zelenko38c70522017-12-07 21:55:09 +00004597
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004598public:
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004599 CFGBlockTerminatorPrint(raw_ostream &os, StmtPrinterHelper* helper,
Chris Lattnerc61089a2009-06-30 01:26:17 +00004600 const PrintingPolicy &Policy)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004601 : OS(os), Helper(helper), Policy(Policy) {
Ted Kremenek5d0fb1e2013-12-11 23:44:05 +00004602 this->Policy.IncludeNewlines = false;
4603 }
Mike Stump31feda52009-07-17 01:31:16 +00004604
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004605 void VisitIfStmt(IfStmt *I) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004606 OS << "if ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004607 if (Stmt *C = I->getCond())
4608 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00004609 }
Mike Stump31feda52009-07-17 01:31:16 +00004610
Ted Kremenek9aae5132007-08-23 21:42:29 +00004611 // Default case.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004612 void VisitStmt(Stmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00004613 Terminator->printPretty(OS, Helper, Policy);
4614 }
4615
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00004616 void VisitDeclStmt(DeclStmt *DS) {
4617 VarDecl *VD = cast<VarDecl>(DS->getSingleDecl());
4618 OS << "static init " << VD->getName();
4619 }
4620
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004621 void VisitForStmt(ForStmt *F) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004622 OS << "for (" ;
Ted Kremenek60983dc2010-01-19 20:52:05 +00004623 if (F->getInit())
4624 OS << "...";
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00004625 OS << "; ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004626 if (Stmt *C = F->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004627 C->printPretty(OS, Helper, Policy);
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00004628 OS << "; ";
Ted Kremenek60983dc2010-01-19 20:52:05 +00004629 if (F->getInc())
4630 OS << "...";
Ted Kremenek15647632008-01-30 23:02:42 +00004631 OS << ")";
Ted Kremenek9aae5132007-08-23 21:42:29 +00004632 }
Mike Stump31feda52009-07-17 01:31:16 +00004633
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004634 void VisitWhileStmt(WhileStmt *W) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004635 OS << "while " ;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004636 if (Stmt *C = W->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004637 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00004638 }
Mike Stump31feda52009-07-17 01:31:16 +00004639
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004640 void VisitDoStmt(DoStmt *D) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004641 OS << "do ... while ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004642 if (Stmt *C = D->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004643 C->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00004644 }
Mike Stump31feda52009-07-17 01:31:16 +00004645
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004646 void VisitSwitchStmt(SwitchStmt *Terminator) {
Ted Kremenek9e248872007-08-27 21:27:44 +00004647 OS << "switch ";
Douglas Gregor7de59662009-05-29 20:38:28 +00004648 Terminator->getCond()->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00004649 }
Mike Stump31feda52009-07-17 01:31:16 +00004650
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004651 void VisitCXXTryStmt(CXXTryStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004652 OS << "try ...";
4653 }
4654
Nico Weber699670e2017-08-23 15:33:16 +00004655 void VisitSEHTryStmt(SEHTryStmt *CS) {
4656 OS << "__try ...";
4657 }
4658
John McCallc07a0c72011-02-17 10:25:35 +00004659 void VisitAbstractConditionalOperator(AbstractConditionalOperator* C) {
Richard Trieuddd01ce2014-06-09 22:53:25 +00004660 if (Stmt *Cond = C->getCond())
4661 Cond->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004662 OS << " ? ... : ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004663 }
Mike Stump31feda52009-07-17 01:31:16 +00004664
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004665 void VisitChooseExpr(ChooseExpr *C) {
Ted Kremenek391f94a2007-08-31 22:29:13 +00004666 OS << "__builtin_choose_expr( ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004667 if (Stmt *Cond = C->getCond())
4668 Cond->printPretty(OS, Helper, Policy);
Ted Kremenek15647632008-01-30 23:02:42 +00004669 OS << " )";
Ted Kremenek391f94a2007-08-31 22:29:13 +00004670 }
Mike Stump31feda52009-07-17 01:31:16 +00004671
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004672 void VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004673 OS << "goto *";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004674 if (Stmt *T = I->getTarget())
4675 T->printPretty(OS, Helper, Policy);
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004676 }
Mike Stump31feda52009-07-17 01:31:16 +00004677
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004678 void VisitBinaryOperator(BinaryOperator* B) {
4679 if (!B->isLogicalOp()) {
4680 VisitExpr(B);
4681 return;
4682 }
Mike Stump31feda52009-07-17 01:31:16 +00004683
Richard Trieuddd01ce2014-06-09 22:53:25 +00004684 if (B->getLHS())
4685 B->getLHS()->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004686
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004687 switch (B->getOpcode()) {
John McCalle3027922010-08-25 11:45:40 +00004688 case BO_LOr:
Ted Kremenek15647632008-01-30 23:02:42 +00004689 OS << " || ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004690 return;
John McCalle3027922010-08-25 11:45:40 +00004691 case BO_LAnd:
Ted Kremenek15647632008-01-30 23:02:42 +00004692 OS << " && ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004693 return;
4694 default:
David Blaikie83d382b2011-09-23 05:06:16 +00004695 llvm_unreachable("Invalid logical operator.");
Mike Stump31feda52009-07-17 01:31:16 +00004696 }
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004697 }
Mike Stump31feda52009-07-17 01:31:16 +00004698
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004699 void VisitExpr(Expr *E) {
Douglas Gregor7de59662009-05-29 20:38:28 +00004700 E->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004701 }
Ted Kremenekfcc14172014-03-08 02:22:29 +00004702
4703public:
4704 void print(CFGTerminator T) {
4705 if (T.isTemporaryDtorsBranch())
4706 OS << "(Temp Dtor) ";
4707 Visit(T.getStmt());
4708 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00004709};
Eugene Zelenko38c70522017-12-07 21:55:09 +00004710
4711} // namespace
Chris Lattnerc61089a2009-06-30 01:26:17 +00004712
Artem Dergachev5a281bb2018-02-10 02:18:04 +00004713static void print_initializer(raw_ostream &OS, StmtPrinterHelper &Helper,
4714 const CXXCtorInitializer *I) {
4715 if (I->isBaseInitializer())
4716 OS << I->getBaseClass()->getAsCXXRecordDecl()->getName();
4717 else if (I->isDelegatingInitializer())
4718 OS << I->getTypeSourceInfo()->getType()->getAsCXXRecordDecl()->getName();
4719 else
4720 OS << I->getAnyMember()->getName();
4721 OS << "(";
4722 if (Expr *IE = I->getInit())
4723 IE->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
4724 OS << ")";
4725
4726 if (I->isBaseInitializer())
4727 OS << " (Base initializer)";
4728 else if (I->isDelegatingInitializer())
4729 OS << " (Delegating initializer)";
4730 else
4731 OS << " (Member initializer)";
4732}
4733
Aaron Ballmanff924b02013-11-18 20:11:50 +00004734static void print_elem(raw_ostream &OS, StmtPrinterHelper &Helper,
Mike Stump92244b02010-01-19 22:00:14 +00004735 const CFGElement &E) {
David Blaikie00be69a2013-02-23 00:29:34 +00004736 if (Optional<CFGStmt> CS = E.getAs<CFGStmt>()) {
4737 const Stmt *S = CS->getStmt();
Richard Trieuddd01ce2014-06-09 22:53:25 +00004738 assert(S != nullptr && "Expecting non-null Stmt");
4739
Aaron Ballmanff924b02013-11-18 20:11:50 +00004740 // special printing for statement-expressions.
4741 if (const StmtExpr *SE = dyn_cast<StmtExpr>(S)) {
4742 const CompoundStmt *Sub = SE->getSubStmt();
Mike Stump31feda52009-07-17 01:31:16 +00004743
Benjamin Kramer5733e352015-07-18 17:09:36 +00004744 auto Children = Sub->children();
4745 if (Children.begin() != Children.end()) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00004746 OS << "({ ... ; ";
4747 Helper.handledStmt(*SE->getSubStmt()->body_rbegin(),OS);
4748 OS << " })\n";
4749 return;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004750 }
4751 }
Aaron Ballmanff924b02013-11-18 20:11:50 +00004752 // special printing for comma expressions.
4753 if (const BinaryOperator* B = dyn_cast<BinaryOperator>(S)) {
4754 if (B->getOpcode() == BO_Comma) {
4755 OS << "... , ";
4756 Helper.handledStmt(B->getRHS(),OS);
4757 OS << '\n';
4758 return;
4759 }
4760 }
4761 S->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
Mike Stump31feda52009-07-17 01:31:16 +00004762
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004763 if (isa<CXXOperatorCallExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004764 OS << " (OperatorCall)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00004765 } else if (isa<CXXBindTemporaryExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004766 OS << " (BindTemporary)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00004767 } else if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(S)) {
4768 OS << " (CXXConstructExpr, ";
4769 if (Optional<CFGConstructor> CE = E.getAs<CFGConstructor>()) {
Artem Dergachev40684812018-02-27 20:03:35 +00004770 const ConstructionContext *CC = CE->getConstructionContext();
4771 const Stmt *S1 = nullptr, *S2 = nullptr;
4772 switch (CC->getKind()) {
4773 case ConstructionContext::ConstructorInitializerKind: {
4774 const auto *ICC = cast<ConstructorInitializerConstructionContext>(CC);
4775 print_initializer(OS, Helper, ICC->getCXXCtorInitializer());
4776 OS << ", ";
4777 break;
4778 }
4779 case ConstructionContext::SimpleVariableKind: {
4780 const auto *DSCC = cast<SimpleVariableConstructionContext>(CC);
4781 S1 = DSCC->getDeclStmt();
4782 break;
4783 }
4784 case ConstructionContext::NewAllocatedObjectKind: {
4785 const auto *NECC = cast<NewAllocatedObjectConstructionContext>(CC);
4786 S1 = NECC->getCXXNewExpr();
4787 break;
4788 }
4789 case ConstructionContext::ReturnedValueKind: {
4790 const auto *RSCC = cast<ReturnedValueConstructionContext>(CC);
4791 S1 = RSCC->getReturnStmt();
4792 break;
4793 }
4794 case ConstructionContext::TemporaryObjectKind: {
4795 const auto *TOCC = cast<TemporaryObjectConstructionContext>(CC);
4796 S1 = TOCC->getCXXBindTemporaryExpr();
4797 S2 = TOCC->getMaterializedTemporaryExpr();
4798 break;
4799 }
4800 }
4801 if (S1) {
4802 Helper.handledStmt(const_cast<Stmt *>(S1), OS);
4803 OS << ", ";
4804 }
4805 if (S2) {
4806 Helper.handledStmt(const_cast<Stmt *>(S2), OS);
4807 OS << ", ";
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00004808 }
Artem Dergachev41ffb302018-02-08 22:58:15 +00004809 }
4810 OS << CCE->getType().getAsString() << ")";
4811 } else if (const CastExpr *CE = dyn_cast<CastExpr>(S)) {
Ted Kremenek0ffba932011-12-21 19:32:38 +00004812 OS << " (" << CE->getStmtClassName() << ", "
4813 << CE->getCastKindName()
4814 << ", " << CE->getType().getAsString()
4815 << ")";
4816 }
Mike Stump31feda52009-07-17 01:31:16 +00004817
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004818 // Expressions need a newline.
4819 if (isa<Expr>(S))
4820 OS << '\n';
David Blaikie00be69a2013-02-23 00:29:34 +00004821 } else if (Optional<CFGInitializer> IE = E.getAs<CFGInitializer>()) {
Artem Dergachev5a281bb2018-02-10 02:18:04 +00004822 print_initializer(OS, Helper, IE->getInitializer());
4823 OS << '\n';
David Blaikie00be69a2013-02-23 00:29:34 +00004824 } else if (Optional<CFGAutomaticObjDtor> DE =
4825 E.getAs<CFGAutomaticObjDtor>()) {
4826 const VarDecl *VD = DE->getVarDecl();
Aaron Ballmanff924b02013-11-18 20:11:50 +00004827 Helper.handleDecl(VD, OS);
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004828
Marcin Swiderski52e4bc12010-10-25 07:00:40 +00004829 const Type* T = VD->getType().getTypePtr();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004830 if (const ReferenceType* RT = T->getAs<ReferenceType>())
4831 T = RT->getPointeeType().getTypePtr();
Richard Smithf676e452012-07-24 21:02:14 +00004832 T = T->getBaseElementTypeUnsafe();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004833
4834 OS << ".~" << T->getAsCXXRecordDecl()->getName().str() << "()";
4835 OS << " (Implicit destructor)\n";
Matthias Gehre351c2182017-07-12 07:04:19 +00004836 } else if (Optional<CFGLifetimeEnds> DE = E.getAs<CFGLifetimeEnds>()) {
4837 const VarDecl *VD = DE->getVarDecl();
4838 Helper.handleDecl(VD, OS);
4839
4840 OS << " (Lifetime ends)\n";
Peter Szecsi999a25f2017-08-19 11:19:16 +00004841 } else if (Optional<CFGLoopExit> LE = E.getAs<CFGLoopExit>()) {
4842 const Stmt *LoopStmt = LE->getLoopStmt();
4843 OS << LoopStmt->getStmtClassName() << " (LoopExit)\n";
Jordan Rosec9176072014-01-13 17:59:19 +00004844 } else if (Optional<CFGNewAllocator> NE = E.getAs<CFGNewAllocator>()) {
4845 OS << "CFGNewAllocator(";
4846 if (const CXXNewExpr *AllocExpr = NE->getAllocatorExpr())
4847 AllocExpr->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
4848 OS << ")\n";
Jordan Rosed2f40792013-09-03 17:00:57 +00004849 } else if (Optional<CFGDeleteDtor> DE = E.getAs<CFGDeleteDtor>()) {
4850 const CXXRecordDecl *RD = DE->getCXXRecordDecl();
4851 if (!RD)
4852 return;
4853 CXXDeleteExpr *DelExpr =
4854 const_cast<CXXDeleteExpr*>(DE->getDeleteExpr());
Aaron Ballmanff924b02013-11-18 20:11:50 +00004855 Helper.handledStmt(cast<Stmt>(DelExpr->getArgument()), OS);
Jordan Rosed2f40792013-09-03 17:00:57 +00004856 OS << "->~" << RD->getName().str() << "()";
4857 OS << " (Implicit destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00004858 } else if (Optional<CFGBaseDtor> BE = E.getAs<CFGBaseDtor>()) {
4859 const CXXBaseSpecifier *BS = BE->getBaseSpecifier();
Marcin Swiderski20b88732010-10-05 05:37:00 +00004860 OS << "~" << BS->getType()->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00004861 OS << " (Base object destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00004862 } else if (Optional<CFGMemberDtor> ME = E.getAs<CFGMemberDtor>()) {
4863 const FieldDecl *FD = ME->getFieldDecl();
Richard Smithf676e452012-07-24 21:02:14 +00004864 const Type *T = FD->getType()->getBaseElementTypeUnsafe();
Marcin Swiderski20b88732010-10-05 05:37:00 +00004865 OS << "this->" << FD->getName();
Marcin Swiderski01769902010-10-25 07:05:54 +00004866 OS << ".~" << T->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00004867 OS << " (Member object destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00004868 } else if (Optional<CFGTemporaryDtor> TE = E.getAs<CFGTemporaryDtor>()) {
4869 const CXXBindTemporaryExpr *BT = TE->getBindTemporaryExpr();
Pavel Labathd527cf82013-09-02 09:09:15 +00004870 OS << "~";
Aaron Ballmanff924b02013-11-18 20:11:50 +00004871 BT->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
Pavel Labathd527cf82013-09-02 09:09:15 +00004872 OS << "() (Temporary object destructor)\n";
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004873 }
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004874}
Mike Stump31feda52009-07-17 01:31:16 +00004875
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004876static void print_block(raw_ostream &OS, const CFG* cfg,
4877 const CFGBlock &B,
Aaron Ballmanff924b02013-11-18 20:11:50 +00004878 StmtPrinterHelper &Helper, bool print_edges,
Ted Kremenek72be32a2011-12-22 23:33:52 +00004879 bool ShowColors) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00004880 Helper.setBlockID(B.getBlockID());
Mike Stump31feda52009-07-17 01:31:16 +00004881
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004882 // Print the header.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004883 if (ShowColors)
4884 OS.changeColor(raw_ostream::YELLOW, true);
4885
4886 OS << "\n [B" << B.getBlockID();
Mike Stump31feda52009-07-17 01:31:16 +00004887
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004888 if (&B == &cfg->getEntry())
Ted Kremenek72be32a2011-12-22 23:33:52 +00004889 OS << " (ENTRY)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004890 else if (&B == &cfg->getExit())
Ted Kremenek72be32a2011-12-22 23:33:52 +00004891 OS << " (EXIT)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004892 else if (&B == cfg->getIndirectGotoBlock())
Ted Kremenek72be32a2011-12-22 23:33:52 +00004893 OS << " (INDIRECT GOTO DISPATCH)]\n";
Jordan Rose398fb002014-04-01 16:39:33 +00004894 else if (B.hasNoReturnElement())
4895 OS << " (NORETURN)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004896 else
Ted Kremenek72be32a2011-12-22 23:33:52 +00004897 OS << "]\n";
4898
4899 if (ShowColors)
4900 OS.resetColor();
Mike Stump31feda52009-07-17 01:31:16 +00004901
Ted Kremenek71eca012007-08-29 23:20:49 +00004902 // Print the label of this block.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004903 if (Stmt *Label = const_cast<Stmt*>(B.getLabel())) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004904 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00004905 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00004906
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004907 if (LabelStmt *L = dyn_cast<LabelStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00004908 OS << L->getName();
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004909 else if (CaseStmt *C = dyn_cast<CaseStmt>(Label)) {
Ted Kremenek71eca012007-08-29 23:20:49 +00004910 OS << "case ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004911 if (C->getLHS())
4912 C->getLHS()->printPretty(OS, &Helper,
4913 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00004914 if (C->getRHS()) {
4915 OS << " ... ";
Aaron Ballmanff924b02013-11-18 20:11:50 +00004916 C->getRHS()->printPretty(OS, &Helper,
4917 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00004918 }
Mike Stump92244b02010-01-19 22:00:14 +00004919 } else if (isa<DefaultStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00004920 OS << "default";
Mike Stump92244b02010-01-19 22:00:14 +00004921 else if (CXXCatchStmt *CS = dyn_cast<CXXCatchStmt>(Label)) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004922 OS << "catch (";
Mike Stump0bdba6c2010-01-20 01:15:34 +00004923 if (CS->getExceptionDecl())
Aaron Ballmanff924b02013-11-18 20:11:50 +00004924 CS->getExceptionDecl()->print(OS, PrintingPolicy(Helper.getLangOpts()),
Mike Stump0bdba6c2010-01-20 01:15:34 +00004925 0);
4926 else
4927 OS << "...";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004928 OS << ")";
Nico Weber699670e2017-08-23 15:33:16 +00004929 } else if (SEHExceptStmt *ES = dyn_cast<SEHExceptStmt>(Label)) {
4930 OS << "__except (";
4931 ES->getFilterExpr()->printPretty(OS, &Helper,
4932 PrintingPolicy(Helper.getLangOpts()), 0);
4933 OS << ")";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004934 } else
David Blaikie83d382b2011-09-23 05:06:16 +00004935 llvm_unreachable("Invalid label statement in CFGBlock.");
Mike Stump31feda52009-07-17 01:31:16 +00004936
Ted Kremenek71eca012007-08-29 23:20:49 +00004937 OS << ":\n";
4938 }
Mike Stump31feda52009-07-17 01:31:16 +00004939
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004940 // Iterate through the statements in the block and print them.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004941 unsigned j = 1;
Mike Stump31feda52009-07-17 01:31:16 +00004942
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004943 for (CFGBlock::const_iterator I = B.begin(), E = B.end() ;
4944 I != E ; ++I, ++j ) {
Ted Kremenek71eca012007-08-29 23:20:49 +00004945 // Print the statement # in the basic block and the statement itself.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004946 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00004947 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00004948
Ted Kremenek2d470fc2008-09-13 05:16:45 +00004949 OS << llvm::format("%3d", j) << ": ";
Mike Stump31feda52009-07-17 01:31:16 +00004950
Aaron Ballmanff924b02013-11-18 20:11:50 +00004951 Helper.setStmtID(j);
Mike Stump31feda52009-07-17 01:31:16 +00004952
Ted Kremenek72be32a2011-12-22 23:33:52 +00004953 print_elem(OS, Helper, *I);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004954 }
Mike Stump31feda52009-07-17 01:31:16 +00004955
Ted Kremenek71eca012007-08-29 23:20:49 +00004956 // Print the terminator of this block.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004957 if (B.getTerminator()) {
Ted Kremenek72be32a2011-12-22 23:33:52 +00004958 if (ShowColors)
4959 OS.changeColor(raw_ostream::GREEN);
Mike Stump31feda52009-07-17 01:31:16 +00004960
Ted Kremenek72be32a2011-12-22 23:33:52 +00004961 OS << " T: ";
Mike Stump31feda52009-07-17 01:31:16 +00004962
Aaron Ballmanff924b02013-11-18 20:11:50 +00004963 Helper.setBlockID(-1);
Mike Stump31feda52009-07-17 01:31:16 +00004964
Aaron Ballmanff924b02013-11-18 20:11:50 +00004965 PrintingPolicy PP(Helper.getLangOpts());
4966 CFGBlockTerminatorPrint TPrinter(OS, &Helper, PP);
Ted Kremenekfcc14172014-03-08 02:22:29 +00004967 TPrinter.print(B.getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00004968 OS << '\n';
Ted Kremenek72be32a2011-12-22 23:33:52 +00004969
4970 if (ShowColors)
4971 OS.resetColor();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004972 }
Mike Stump31feda52009-07-17 01:31:16 +00004973
Ted Kremenek71eca012007-08-29 23:20:49 +00004974 if (print_edges) {
4975 // Print the predecessors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004976 if (!B.pred_empty()) {
4977 const raw_ostream::Colors Color = raw_ostream::BLUE;
4978 if (ShowColors)
4979 OS.changeColor(Color);
4980 OS << " Preds " ;
4981 if (ShowColors)
4982 OS.resetColor();
4983 OS << '(' << B.pred_size() << "):";
4984 unsigned i = 0;
Ted Kremenek71eca012007-08-29 23:20:49 +00004985
Ted Kremenek72be32a2011-12-22 23:33:52 +00004986 if (ShowColors)
4987 OS.changeColor(Color);
4988
4989 for (CFGBlock::const_pred_iterator I = B.pred_begin(), E = B.pred_end();
4990 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00004991 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00004992 OS << "\n ";
Mike Stump31feda52009-07-17 01:31:16 +00004993
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004994 CFGBlock *B = *I;
4995 bool Reachable = true;
4996 if (!B) {
4997 Reachable = false;
4998 B = I->getPossiblyUnreachableBlock();
4999 }
5000
5001 OS << " B" << B->getBlockID();
5002 if (!Reachable)
5003 OS << "(Unreachable)";
Ted Kremenek72be32a2011-12-22 23:33:52 +00005004 }
5005
5006 if (ShowColors)
5007 OS.resetColor();
5008
5009 OS << '\n';
Ted Kremenek71eca012007-08-29 23:20:49 +00005010 }
Mike Stump31feda52009-07-17 01:31:16 +00005011
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005012 // Print the successors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005013 if (!B.succ_empty()) {
5014 const raw_ostream::Colors Color = raw_ostream::MAGENTA;
5015 if (ShowColors)
5016 OS.changeColor(Color);
5017 OS << " Succs ";
5018 if (ShowColors)
5019 OS.resetColor();
5020 OS << '(' << B.succ_size() << "):";
5021 unsigned i = 0;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005022
Ted Kremenek72be32a2011-12-22 23:33:52 +00005023 if (ShowColors)
5024 OS.changeColor(Color);
Mike Stump31feda52009-07-17 01:31:16 +00005025
Ted Kremenek72be32a2011-12-22 23:33:52 +00005026 for (CFGBlock::const_succ_iterator I = B.succ_begin(), E = B.succ_end();
5027 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00005028 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005029 OS << "\n ";
5030
Ted Kremenek9238c5c2014-02-27 21:56:44 +00005031 CFGBlock *B = *I;
5032
5033 bool Reachable = true;
5034 if (!B) {
5035 Reachable = false;
5036 B = I->getPossiblyUnreachableBlock();
5037 }
5038
5039 if (B) {
5040 OS << " B" << B->getBlockID();
5041 if (!Reachable)
5042 OS << "(Unreachable)";
5043 }
5044 else {
5045 OS << " NULL";
5046 }
Ted Kremenek72be32a2011-12-22 23:33:52 +00005047 }
Ted Kremenek9238c5c2014-02-27 21:56:44 +00005048
Ted Kremenek72be32a2011-12-22 23:33:52 +00005049 if (ShowColors)
5050 OS.resetColor();
5051 OS << '\n';
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005052 }
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005053 }
Mike Stump31feda52009-07-17 01:31:16 +00005054}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005055
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005056/// dump - A simple pretty printer of a CFG that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005057void CFG::dump(const LangOptions &LO, bool ShowColors) const {
5058 print(llvm::errs(), LO, ShowColors);
5059}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005060
5061/// print - A simple pretty printer of a CFG that outputs to an ostream.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005062void CFG::print(raw_ostream &OS, const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00005063 StmtPrinterHelper Helper(this, LO);
Mike Stump31feda52009-07-17 01:31:16 +00005064
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005065 // Print the entry block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00005066 print_block(OS, this, getEntry(), Helper, true, ShowColors);
Mike Stump31feda52009-07-17 01:31:16 +00005067
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005068 // Iterate through the CFGBlocks and print them one by one.
5069 for (const_iterator I = Blocks.begin(), E = Blocks.end() ; I != E ; ++I) {
5070 // Skip the entry block, because we already printed it.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00005071 if (&(**I) == &getEntry() || &(**I) == &getExit())
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005072 continue;
Mike Stump31feda52009-07-17 01:31:16 +00005073
Aaron Ballmanff924b02013-11-18 20:11:50 +00005074 print_block(OS, this, **I, Helper, true, ShowColors);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005075 }
Mike Stump31feda52009-07-17 01:31:16 +00005076
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005077 // Print the exit block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00005078 print_block(OS, this, getExit(), Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00005079 OS << '\n';
Ted Kremeneke03879b2008-11-24 20:50:24 +00005080 OS.flush();
Mike Stump31feda52009-07-17 01:31:16 +00005081}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005082
5083/// dump - A simply pretty printer of a CFGBlock that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005084void CFGBlock::dump(const CFG* cfg, const LangOptions &LO,
5085 bool ShowColors) const {
5086 print(llvm::errs(), cfg, LO, ShowColors);
Chris Lattnerc61089a2009-06-30 01:26:17 +00005087}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005088
Yaron Kerencdae9412016-01-29 19:38:18 +00005089LLVM_DUMP_METHOD void CFGBlock::dump() const {
Anna Zaksa6fea132014-06-13 23:47:38 +00005090 dump(getParent(), LangOptions(), false);
5091}
5092
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005093/// print - A simple pretty printer of a CFGBlock that outputs to an ostream.
5094/// Generally this will only be called from CFG::print.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005095void CFGBlock::print(raw_ostream &OS, const CFG* cfg,
Ted Kremenek72be32a2011-12-22 23:33:52 +00005096 const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00005097 StmtPrinterHelper Helper(cfg, LO);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005098 print_block(OS, cfg, *this, Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00005099 OS << '\n';
Ted Kremenek889073f2007-08-23 16:51:22 +00005100}
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005101
Ted Kremenek15647632008-01-30 23:02:42 +00005102/// printTerminator - A simple pretty printer of the terminator of a CFGBlock.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005103void CFGBlock::printTerminator(raw_ostream &OS,
Mike Stump31feda52009-07-17 01:31:16 +00005104 const LangOptions &LO) const {
Craig Topper25542942014-05-20 04:30:07 +00005105 CFGBlockTerminatorPrint TPrinter(OS, nullptr, PrintingPolicy(LO));
Ted Kremenekfcc14172014-03-08 02:22:29 +00005106 TPrinter.print(getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00005107}
5108
Ted Kremenekec3bbf42014-03-29 00:35:20 +00005109Stmt *CFGBlock::getTerminatorCondition(bool StripParens) {
Marcin Swiderskia7d84a72010-10-29 05:21:47 +00005110 Stmt *Terminator = this->Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005111 if (!Terminator)
Craig Topper25542942014-05-20 04:30:07 +00005112 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00005113
Craig Topper25542942014-05-20 04:30:07 +00005114 Expr *E = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00005115
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005116 switch (Terminator->getStmtClass()) {
5117 default:
5118 break;
Mike Stump31feda52009-07-17 01:31:16 +00005119
Jordan Rosecf10ea82013-06-06 21:53:45 +00005120 case Stmt::CXXForRangeStmtClass:
5121 E = cast<CXXForRangeStmt>(Terminator)->getCond();
5122 break;
5123
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005124 case Stmt::ForStmtClass:
5125 E = cast<ForStmt>(Terminator)->getCond();
5126 break;
Mike Stump31feda52009-07-17 01:31:16 +00005127
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005128 case Stmt::WhileStmtClass:
5129 E = cast<WhileStmt>(Terminator)->getCond();
5130 break;
Mike Stump31feda52009-07-17 01:31:16 +00005131
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005132 case Stmt::DoStmtClass:
5133 E = cast<DoStmt>(Terminator)->getCond();
5134 break;
Mike Stump31feda52009-07-17 01:31:16 +00005135
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005136 case Stmt::IfStmtClass:
5137 E = cast<IfStmt>(Terminator)->getCond();
5138 break;
Mike Stump31feda52009-07-17 01:31:16 +00005139
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005140 case Stmt::ChooseExprClass:
5141 E = cast<ChooseExpr>(Terminator)->getCond();
5142 break;
Mike Stump31feda52009-07-17 01:31:16 +00005143
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005144 case Stmt::IndirectGotoStmtClass:
5145 E = cast<IndirectGotoStmt>(Terminator)->getTarget();
5146 break;
Mike Stump31feda52009-07-17 01:31:16 +00005147
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005148 case Stmt::SwitchStmtClass:
5149 E = cast<SwitchStmt>(Terminator)->getCond();
5150 break;
Mike Stump31feda52009-07-17 01:31:16 +00005151
John McCallc07a0c72011-02-17 10:25:35 +00005152 case Stmt::BinaryConditionalOperatorClass:
5153 E = cast<BinaryConditionalOperator>(Terminator)->getCond();
5154 break;
5155
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005156 case Stmt::ConditionalOperatorClass:
5157 E = cast<ConditionalOperator>(Terminator)->getCond();
5158 break;
Mike Stump31feda52009-07-17 01:31:16 +00005159
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005160 case Stmt::BinaryOperatorClass: // '&&' and '||'
5161 E = cast<BinaryOperator>(Terminator)->getLHS();
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00005162 break;
Mike Stump31feda52009-07-17 01:31:16 +00005163
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00005164 case Stmt::ObjCForCollectionStmtClass:
Mike Stump31feda52009-07-17 01:31:16 +00005165 return Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005166 }
Mike Stump31feda52009-07-17 01:31:16 +00005167
Ted Kremenekec3bbf42014-03-29 00:35:20 +00005168 if (!StripParens)
5169 return E;
5170
Craig Topper25542942014-05-20 04:30:07 +00005171 return E ? E->IgnoreParens() : nullptr;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005172}
5173
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005174//===----------------------------------------------------------------------===//
5175// CFG Graphviz Visualization
5176//===----------------------------------------------------------------------===//
5177
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005178#ifndef NDEBUG
Mike Stump31feda52009-07-17 01:31:16 +00005179static StmtPrinterHelper* GraphHelper;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005180#endif
5181
Chris Lattnerc61089a2009-06-30 01:26:17 +00005182void CFG::viewCFG(const LangOptions &LO) const {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005183#ifndef NDEBUG
Chris Lattnerc61089a2009-06-30 01:26:17 +00005184 StmtPrinterHelper H(this, LO);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005185 GraphHelper = &H;
5186 llvm::ViewGraph(this,"CFG");
Craig Topper25542942014-05-20 04:30:07 +00005187 GraphHelper = nullptr;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005188#endif
5189}
5190
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005191namespace llvm {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005192
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005193template<>
5194struct DOTGraphTraits<const CFG*> : public DefaultDOTGraphTraits {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005195 DOTGraphTraits(bool isSimple = false) : DefaultDOTGraphTraits(isSimple) {}
Tobias Grosser9fc223a2009-11-30 14:16:05 +00005196
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005197 static std::string getNodeLabel(const CFGBlock *Node, const CFG* Graph) {
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005198#ifndef NDEBUG
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005199 std::string OutSStr;
5200 llvm::raw_string_ostream Out(OutSStr);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005201 print_block(Out,Graph, *Node, *GraphHelper, false, false);
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005202 std::string& OutStr = Out.str();
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005203
5204 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
5205
5206 // Process string output to make it nicer...
5207 for (unsigned i = 0; i != OutStr.length(); ++i)
5208 if (OutStr[i] == '\n') { // Left justify
5209 OutStr[i] = '\\';
5210 OutStr.insert(OutStr.begin()+i+1, 'l');
5211 }
Mike Stump31feda52009-07-17 01:31:16 +00005212
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005213 return OutStr;
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005214#else
Eugene Zelenko38c70522017-12-07 21:55:09 +00005215 return {};
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005216#endif
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005217 }
5218};
Eugene Zelenko38c70522017-12-07 21:55:09 +00005219
5220} // namespace llvm