blob: cec5a652b94aeb3f885529bad98376b23104c863 [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"
Jordan Rose5374c072013-08-19 16:27:28 +000032#include "clang/Basic/Builtins.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000033#include "clang/Basic/ExceptionSpecificationType.h"
34#include "clang/Basic/LLVM.h"
35#include "clang/Basic/LangOptions.h"
36#include "clang/Basic/SourceLocation.h"
37#include "clang/Basic/Specifiers.h"
38#include "llvm/ADT/APInt.h"
39#include "llvm/ADT/APSInt.h"
40#include "llvm/ADT/ArrayRef.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000041#include "llvm/ADT/DenseMap.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000042#include "llvm/ADT/Optional.h"
43#include "llvm/ADT/STLExtras.h"
44#include "llvm/ADT/SetVector.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000045#include "llvm/ADT/SmallPtrSet.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000046#include "llvm/ADT/SmallVector.h"
Benjamin Kramer89b422c2009-08-23 12:08:50 +000047#include "llvm/Support/Allocator.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000048#include "llvm/Support/Casting.h"
49#include "llvm/Support/Compiler.h"
50#include "llvm/Support/DOTGraphTraits.h"
51#include "llvm/Support/ErrorHandling.h"
Benjamin Kramer89b422c2009-08-23 12:08:50 +000052#include "llvm/Support/Format.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000053#include "llvm/Support/GraphWriter.h"
54#include "llvm/Support/SaveAndRestore.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000055#include "llvm/Support/raw_ostream.h"
56#include <cassert>
57#include <memory>
58#include <string>
59#include <tuple>
60#include <utility>
61#include <vector>
Ted Kremeneke5ccf9a2008-01-11 00:40:29 +000062
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +000063using namespace clang;
64
Ted Kremenek5ef32db2011-08-12 23:37:29 +000065static SourceLocation GetEndLoc(Decl *D) {
66 if (VarDecl *VD = dyn_cast<VarDecl>(D))
67 if (Expr *Ex = VD->getInit())
Ted Kremenek8889bb32008-08-06 23:20:50 +000068 return Ex->getSourceRange().getEnd();
Mike Stump31feda52009-07-17 01:31:16 +000069 return D->getLocation();
Ted Kremenek8889bb32008-08-06 23:20:50 +000070}
Ted Kremenekdc03bd02010-08-02 23:46:59 +000071
George Burgess IVced56e62015-10-01 18:47:52 +000072/// Helper for tryNormalizeBinaryOperator. Attempts to extract an IntegerLiteral
73/// or EnumConstantDecl from the given Expr. If it fails, returns nullptr.
Eugene Zelenko38c70522017-12-07 21:55:09 +000074static const Expr *tryTransformToIntOrEnumConstant(const Expr *E) {
George Burgess IVced56e62015-10-01 18:47:52 +000075 E = E->IgnoreParens();
76 if (isa<IntegerLiteral>(E))
77 return E;
78 if (auto *DR = dyn_cast<DeclRefExpr>(E->IgnoreParenImpCasts()))
79 return isa<EnumConstantDecl>(DR->getDecl()) ? DR : nullptr;
80 return nullptr;
81}
82
83/// Tries to interpret a binary operator into `Decl Op Expr` form, if Expr is
84/// an integer literal or an enum constant.
85///
86/// If this fails, at least one of the returned DeclRefExpr or Expr will be
87/// null.
88static std::tuple<const DeclRefExpr *, BinaryOperatorKind, const Expr *>
89tryNormalizeBinaryOperator(const BinaryOperator *B) {
90 BinaryOperatorKind Op = B->getOpcode();
91
92 const Expr *MaybeDecl = B->getLHS();
93 const Expr *Constant = tryTransformToIntOrEnumConstant(B->getRHS());
94 // Expr looked like `0 == Foo` instead of `Foo == 0`
95 if (Constant == nullptr) {
96 // Flip the operator
97 if (Op == BO_GT)
98 Op = BO_LT;
99 else if (Op == BO_GE)
100 Op = BO_LE;
101 else if (Op == BO_LT)
102 Op = BO_GT;
103 else if (Op == BO_LE)
104 Op = BO_GE;
105
106 MaybeDecl = B->getRHS();
107 Constant = tryTransformToIntOrEnumConstant(B->getLHS());
108 }
109
110 auto *D = dyn_cast<DeclRefExpr>(MaybeDecl->IgnoreParenImpCasts());
111 return std::make_tuple(D, Op, Constant);
112}
113
114/// For an expression `x == Foo && x == Bar`, this determines whether the
115/// `Foo` and `Bar` are either of the same enumeration type, or both integer
116/// literals.
117///
118/// It's an error to pass this arguments that are not either IntegerLiterals
119/// or DeclRefExprs (that have decls of type EnumConstantDecl)
120static bool areExprTypesCompatible(const Expr *E1, const Expr *E2) {
121 // User intent isn't clear if they're mixing int literals with enum
122 // constants.
123 if (isa<IntegerLiteral>(E1) != isa<IntegerLiteral>(E2))
124 return false;
125
126 // Integer literal comparisons, regardless of literal type, are acceptable.
127 if (isa<IntegerLiteral>(E1))
128 return true;
129
130 // IntegerLiterals are handled above and only EnumConstantDecls are expected
131 // beyond this point
132 assert(isa<DeclRefExpr>(E1) && isa<DeclRefExpr>(E2));
133 auto *Decl1 = cast<DeclRefExpr>(E1)->getDecl();
134 auto *Decl2 = cast<DeclRefExpr>(E2)->getDecl();
135
136 assert(isa<EnumConstantDecl>(Decl1) && isa<EnumConstantDecl>(Decl2));
137 const DeclContext *DC1 = Decl1->getDeclContext();
138 const DeclContext *DC2 = Decl2->getDeclContext();
139
140 assert(isa<EnumDecl>(DC1) && isa<EnumDecl>(DC2));
141 return DC1 == DC2;
142}
143
Eugene Zelenko38c70522017-12-07 21:55:09 +0000144namespace {
145
Ted Kremenek7c58d352011-03-10 01:14:11 +0000146class CFGBuilder;
147
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000148/// The CFG builder uses a recursive algorithm to build the CFG. When
149/// we process an expression, sometimes we know that we must add the
150/// subexpressions as block-level expressions. For example:
151///
152/// exp1 || exp2
153///
154/// When processing the '||' expression, we know that exp1 and exp2
155/// need to be added as block-level expressions, even though they
156/// might not normally need to be. AddStmtChoice records this
157/// contextual information. If AddStmtChoice is 'NotAlwaysAdd', then
158/// the builder has an option not to add a subexpression as a
159/// block-level expression.
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000160class AddStmtChoice {
161public:
Ted Kremenek8219b822010-12-16 07:46:53 +0000162 enum Kind { NotAlwaysAdd = 0, AlwaysAdd = 1 };
Ted Kremenek5d2bb1b2010-03-02 21:43:54 +0000163
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000164 AddStmtChoice(Kind a_kind = NotAlwaysAdd) : kind(a_kind) {}
Ted Kremenek5d2bb1b2010-03-02 21:43:54 +0000165
Ted Kremenek7c58d352011-03-10 01:14:11 +0000166 bool alwaysAdd(CFGBuilder &builder,
167 const Stmt *stmt) const;
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000168
169 /// Return a copy of this object, except with the 'always-add' bit
170 /// set as specified.
171 AddStmtChoice withAlwaysAdd(bool alwaysAdd) const {
Ted Kremenek7c58d352011-03-10 01:14:11 +0000172 return AddStmtChoice(alwaysAdd ? AlwaysAdd : NotAlwaysAdd);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000173 }
174
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000175private:
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000176 Kind kind;
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000177};
Mike Stump31feda52009-07-17 01:31:16 +0000178
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000179/// LocalScope - Node in tree of local scopes created for C++ implicit
180/// destructor calls generation. It contains list of automatic variables
181/// declared in the scope and link to position in previous scope this scope
182/// began in.
183///
184/// The process of creating local scopes is as follows:
185/// - Init CFGBuilder::ScopePos with invalid position (equivalent for null),
186/// - Before processing statements in scope (e.g. CompoundStmt) create
187/// LocalScope object using CFGBuilder::ScopePos as link to previous scope
188/// and set CFGBuilder::ScopePos to the end of new scope,
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000189/// - On every occurrence of VarDecl increase CFGBuilder::ScopePos if it points
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000190/// at this VarDecl,
191/// - For every normal (without jump) end of scope add to CFGBlock destructors
192/// for objects in the current scope,
193/// - For every jump add to CFGBlock destructors for objects
194/// between CFGBuilder::ScopePos and local scope position saved for jump
195/// target. Thanks to C++ restrictions on goto jumps we can be sure that
196/// jump target position will be on the path to root from CFGBuilder::ScopePos
197/// (adding any variable that doesn't need constructor to be called to
198/// LocalScope can break this assumption),
199///
200class LocalScope {
201public:
Eugene Zelenko38c70522017-12-07 21:55:09 +0000202 friend class const_iterator;
203
204 using AutomaticVarsTy = BumpVector<VarDecl *>;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000205
206 /// const_iterator - Iterates local scope backwards and jumps to previous
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000207 /// scope on reaching the beginning of currently iterated scope.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000208 class const_iterator {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000209 const LocalScope* Scope = nullptr;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000210
211 /// VarIter is guaranteed to be greater then 0 for every valid iterator.
212 /// Invalid iterator (with null Scope) has VarIter equal to 0.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000213 unsigned VarIter = 0;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000214
215 public:
216 /// Create invalid iterator. Dereferencing invalid iterator is not allowed.
217 /// Incrementing invalid iterator is allowed and will result in invalid
218 /// iterator.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000219 const_iterator() = default;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000220
221 /// Create valid iterator. In case when S.Prev is an invalid iterator and
222 /// I is equal to 0, this will create invalid iterator.
223 const_iterator(const LocalScope& S, unsigned I)
224 : Scope(&S), VarIter(I) {
225 // Iterator to "end" of scope is not allowed. Handle it by going up
226 // in scopes tree possibly up to invalid iterator in the root.
227 if (VarIter == 0 && Scope)
228 *this = Scope->Prev;
229 }
230
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000231 VarDecl *const* operator->() const {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000232 assert(Scope && "Dereferencing invalid iterator is not allowed");
233 assert(VarIter != 0 && "Iterator has invalid value of VarIter member");
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000234 return &Scope->Vars[VarIter - 1];
235 }
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000236 VarDecl *operator*() const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000237 return *this->operator->();
238 }
239
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000240 const_iterator &operator++() {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000241 if (!Scope)
242 return *this;
243
Eugene Zelenko38c70522017-12-07 21:55:09 +0000244 assert(VarIter != 0 && "Iterator has invalid value of VarIter member");
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000245 --VarIter;
246 if (VarIter == 0)
247 *this = Scope->Prev;
248 return *this;
249 }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000250 const_iterator operator++(int) {
251 const_iterator P = *this;
252 ++*this;
253 return P;
254 }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000255
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000256 bool operator==(const const_iterator &rhs) const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000257 return Scope == rhs.Scope && VarIter == rhs.VarIter;
258 }
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000259 bool operator!=(const const_iterator &rhs) const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000260 return !(*this == rhs);
261 }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000262
Aaron Ballman67347662015-02-15 22:00:28 +0000263 explicit operator bool() const {
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000264 return *this != const_iterator();
265 }
266
267 int distance(const_iterator L);
Matthias Gehre351c2182017-07-12 07:04:19 +0000268 const_iterator shared_parent(const_iterator L);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000269 };
270
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000271private:
Ted Kremenekc7bfdcd2011-02-15 02:47:45 +0000272 BumpVectorContext ctx;
273
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000274 /// Automatic variables in order of declaration.
275 AutomaticVarsTy Vars;
Eugene Zelenko38c70522017-12-07 21:55:09 +0000276
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000277 /// Iterator to variable in previous scope that was declared just before
278 /// begin of this scope.
279 const_iterator Prev;
280
281public:
282 /// Constructs empty scope linked to previous scope in specified place.
David Blaikiec1334cc2015-08-13 22:12:21 +0000283 LocalScope(BumpVectorContext ctx, const_iterator P)
284 : ctx(std::move(ctx)), Vars(this->ctx, 4), Prev(P) {}
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000285
286 /// Begin of scope in direction of CFG building (backwards).
287 const_iterator begin() const { return const_iterator(*this, Vars.size()); }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000288
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000289 void addVar(VarDecl *VD) {
Ted Kremenekc7bfdcd2011-02-15 02:47:45 +0000290 Vars.push_back(VD, ctx);
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000291 }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000292};
293
Eugene Zelenko38c70522017-12-07 21:55:09 +0000294} // namespace
295
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000296/// distance - Calculates distance from this to L. L must be reachable from this
297/// (with use of ++ operator). Cost of calculating the distance is linear w.r.t.
298/// number of scopes between this and L.
299int LocalScope::const_iterator::distance(LocalScope::const_iterator L) {
300 int D = 0;
301 const_iterator F = *this;
302 while (F.Scope != L.Scope) {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000303 assert(F != const_iterator() &&
304 "L iterator is not reachable from F iterator.");
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000305 D += F.VarIter;
306 F = F.Scope->Prev;
307 }
308 D += F.VarIter - L.VarIter;
309 return D;
310}
311
Matthias Gehre351c2182017-07-12 07:04:19 +0000312/// Calculates the closest parent of this iterator
313/// that is in a scope reachable through the parents of L.
314/// I.e. when using 'goto' from this to L, the lifetime of all variables
315/// between this and shared_parent(L) end.
316LocalScope::const_iterator
317LocalScope::const_iterator::shared_parent(LocalScope::const_iterator L) {
318 llvm::SmallPtrSet<const LocalScope *, 4> ScopesOfL;
319 while (true) {
320 ScopesOfL.insert(L.Scope);
321 if (L == const_iterator())
322 break;
323 L = L.Scope->Prev;
324 }
325
326 const_iterator F = *this;
327 while (true) {
328 if (ScopesOfL.count(F.Scope))
329 return F;
330 assert(F != const_iterator() &&
331 "L iterator is not reachable from F iterator.");
332 F = F.Scope->Prev;
333 }
334}
335
Eugene Zelenko38c70522017-12-07 21:55:09 +0000336namespace {
337
Jonathan Roelofs99bdd982015-05-19 18:51:56 +0000338/// Structure for specifying position in CFG during its build process. It
339/// consists of CFGBlock that specifies position in CFG and
340/// LocalScope::const_iterator that specifies position in LocalScope graph.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000341struct BlockScopePosPair {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000342 CFGBlock *block = nullptr;
343 LocalScope::const_iterator scopePosition;
344
345 BlockScopePosPair() = default;
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000346 BlockScopePosPair(CFGBlock *b, LocalScope::const_iterator scopePos)
Ted Kremenekef81e9e2011-01-07 19:37:16 +0000347 : block(b), scopePosition(scopePos) {}
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000348};
349
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000350/// TryResult - a class representing a variant over the values
351/// 'true', 'false', or 'unknown'. This is returned by tryEvaluateBool,
352/// and is used by the CFGBuilder to decide if a branch condition
353/// can be decided up front during CFG construction.
354class TryResult {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000355 int X = -1;
356
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000357public:
Eugene Zelenko38c70522017-12-07 21:55:09 +0000358 TryResult() = default;
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000359 TryResult(bool b) : X(b ? 1 : 0) {}
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000360
361 bool isTrue() const { return X == 1; }
362 bool isFalse() const { return X == 0; }
363 bool isKnown() const { return X >= 0; }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000364
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000365 void negate() {
366 assert(isKnown());
367 X ^= 0x1;
368 }
369};
370
Eugene Zelenko38c70522017-12-07 21:55:09 +0000371} // namespace
372
373static TryResult bothKnownTrue(TryResult R1, TryResult R2) {
Manuel Klimekdeb02622014-08-08 07:37:13 +0000374 if (!R1.isKnown() || !R2.isKnown())
375 return TryResult();
376 return TryResult(R1.isTrue() && R2.isTrue());
377}
378
Eugene Zelenko38c70522017-12-07 21:55:09 +0000379namespace {
380
Ted Kremenek8ae67872013-02-05 22:00:19 +0000381class reverse_children {
382 llvm::SmallVector<Stmt *, 12> childrenBuf;
Eugene Zelenko38c70522017-12-07 21:55:09 +0000383 ArrayRef<Stmt *> children;
384
Ted Kremenek8ae67872013-02-05 22:00:19 +0000385public:
386 reverse_children(Stmt *S);
387
Eugene Zelenko38c70522017-12-07 21:55:09 +0000388 using iterator = ArrayRef<Stmt *>::reverse_iterator;
389
Ted Kremenek8ae67872013-02-05 22:00:19 +0000390 iterator begin() const { return children.rbegin(); }
391 iterator end() const { return children.rend(); }
392};
393
Eugene Zelenko38c70522017-12-07 21:55:09 +0000394} // namespace
Ted Kremenek8ae67872013-02-05 22:00:19 +0000395
396reverse_children::reverse_children(Stmt *S) {
397 if (CallExpr *CE = dyn_cast<CallExpr>(S)) {
398 children = CE->getRawSubExprs();
399 return;
400 }
401 switch (S->getStmtClass()) {
Ted Kremenek7d86b9c2013-02-05 22:03:14 +0000402 // Note: Fill in this switch with more cases we want to optimize.
Ted Kremenek8ae67872013-02-05 22:00:19 +0000403 case Stmt::InitListExprClass: {
404 InitListExpr *IE = cast<InitListExpr>(S);
405 children = llvm::makeArrayRef(reinterpret_cast<Stmt**>(IE->getInits()),
406 IE->getNumInits());
407 return;
408 }
409 default:
410 break;
411 }
412
413 // Default case for all other statements.
Benjamin Kramer642f1732015-07-02 21:03:14 +0000414 for (Stmt *SubStmt : S->children())
415 childrenBuf.push_back(SubStmt);
Ted Kremenek8ae67872013-02-05 22:00:19 +0000416
417 // This needs to be done *after* childrenBuf has been populated.
418 children = childrenBuf;
419}
420
Eugene Zelenko38c70522017-12-07 21:55:09 +0000421namespace {
422
Ted Kremenekbe9b33b2008-08-04 22:51:42 +0000423/// CFGBuilder - This class implements CFG construction from an AST.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +0000424/// The builder is stateful: an instance of the builder should be used to only
425/// construct a single CFG.
426///
427/// Example usage:
428///
429/// CFGBuilder builder;
Jonathan Roelofsab046c52015-07-27 16:05:36 +0000430/// std::unique_ptr<CFG> cfg = builder.buildCFG(decl, stmt1);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +0000431///
Mike Stump31feda52009-07-17 01:31:16 +0000432/// CFG construction is done via a recursive walk of an AST. We actually parse
433/// the AST in reverse order so that the successor of a basic block is
434/// constructed prior to its predecessor. This allows us to nicely capture
435/// implicit fall-throughs without extra basic blocks.
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +0000436class CFGBuilder {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000437 using JumpTarget = BlockScopePosPair;
438 using JumpSource = BlockScopePosPair;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000439
Mike Stump0d76d072009-07-20 23:24:15 +0000440 ASTContext *Context;
Ahmed Charlesb8984322014-03-07 20:03:18 +0000441 std::unique_ptr<CFG> cfg;
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000442
Eugene Zelenko38c70522017-12-07 21:55:09 +0000443 // Current block.
444 CFGBlock *Block = nullptr;
445
446 // Block after the current block.
447 CFGBlock *Succ = nullptr;
448
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000449 JumpTarget ContinueJumpTarget;
450 JumpTarget BreakJumpTarget;
Nico Weber699670e2017-08-23 15:33:16 +0000451 JumpTarget SEHLeaveJumpTarget;
Eugene Zelenko38c70522017-12-07 21:55:09 +0000452 CFGBlock *SwitchTerminatedBlock = nullptr;
453 CFGBlock *DefaultCaseBlock = nullptr;
Nico Weber699670e2017-08-23 15:33:16 +0000454
455 // This can point either to a try or a __try block. The frontend forbids
456 // mixing both kinds in one function, so having one for both is enough.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000457 CFGBlock *TryTerminatedBlock = nullptr;
Manuel Klimekb5616c92014-08-07 10:42:17 +0000458
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000459 // Current position in local scope.
460 LocalScope::const_iterator ScopePos;
461
462 // LabelMap records the mapping from Label expressions to their jump targets.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000463 using LabelMapTy = llvm::DenseMap<LabelDecl *, JumpTarget>;
Ted Kremenek8a632182007-08-21 23:26:17 +0000464 LabelMapTy LabelMap;
Mike Stump31feda52009-07-17 01:31:16 +0000465
466 // A list of blocks that end with a "goto" that must be backpatched to their
467 // resolved targets upon completion of CFG construction.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000468 using BackpatchBlocksTy = std::vector<JumpSource>;
Ted Kremenek8a632182007-08-21 23:26:17 +0000469 BackpatchBlocksTy BackpatchBlocks;
Mike Stump31feda52009-07-17 01:31:16 +0000470
Ted Kremenekeda180e22007-08-28 19:26:49 +0000471 // A list of labels whose address has been taken (for indirect gotos).
Eugene Zelenko38c70522017-12-07 21:55:09 +0000472 using LabelSetTy = llvm::SmallSetVector<LabelDecl *, 8>;
Ted Kremenekeda180e22007-08-28 19:26:49 +0000473 LabelSetTy AddressTakenLabels;
Mike Stump31feda52009-07-17 01:31:16 +0000474
Artem Dergachev41ffb302018-02-08 22:58:15 +0000475 // Information about the currently visited C++ object construction site.
476 // This is set in the construction trigger and read when the constructor
477 // itself is being visited.
478 ConstructionContext CurrentConstructionContext = {};
479
Eugene Zelenko38c70522017-12-07 21:55:09 +0000480 bool badCFG = false;
Ted Kremenekf9d82902011-03-10 01:14:05 +0000481 const CFG::BuildOptions &BuildOpts;
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000482
483 // State to track for building switch statements.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000484 bool switchExclusivelyCovered = false;
485 Expr::EvalResult *switchCond = nullptr;
Ted Kremeneka099c592011-03-10 03:50:34 +0000486
Eugene Zelenko38c70522017-12-07 21:55:09 +0000487 CFG::BuildOptions::ForcedBlkExprs::value_type *cachedEntry = nullptr;
488 const Stmt *lastLookup = nullptr;
Zhongxing Xud38fb842010-09-16 03:28:18 +0000489
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000490 // Caches boolean evaluations of expressions to avoid multiple re-evaluations
491 // during construction of branches for chained logical operators.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000492 using CachedBoolEvalsTy = llvm::DenseMap<Expr *, TryResult>;
NAKAMURA Takumie9ca55e2012-03-25 06:30:37 +0000493 CachedBoolEvalsTy CachedBoolEvals;
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000494
Mike Stump31feda52009-07-17 01:31:16 +0000495public:
Ted Kremenekf9d82902011-03-10 01:14:05 +0000496 explicit CFGBuilder(ASTContext *astContext,
Nico Weber699670e2017-08-23 15:33:16 +0000497 const CFG::BuildOptions &buildOpts)
498 : Context(astContext), cfg(new CFG()), // crew a new CFG
Eugene Zelenko38c70522017-12-07 21:55:09 +0000499 BuildOpts(buildOpts) {}
Mike Stump31feda52009-07-17 01:31:16 +0000500
Ted Kremenek9aae5132007-08-23 21:42:29 +0000501 // buildCFG - Used by external clients to construct the CFG.
David Blaikiee90195c2014-08-29 18:53:26 +0000502 std::unique_ptr<CFG> buildCFG(const Decl *D, Stmt *Statement);
Mike Stump31feda52009-07-17 01:31:16 +0000503
Ted Kremeneka099c592011-03-10 03:50:34 +0000504 bool alwaysAdd(const Stmt *stmt);
505
Ted Kremenek93668002009-07-17 22:18:43 +0000506private:
507 // Visitors to walk an AST and construct the CFG.
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000508 CFGBlock *VisitAddrLabelExpr(AddrLabelExpr *A, AddStmtChoice asc);
509 CFGBlock *VisitBinaryOperator(BinaryOperator *B, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000510 CFGBlock *VisitBreakStmt(BreakStmt *B);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000511 CFGBlock *VisitCallExpr(CallExpr *C, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000512 CFGBlock *VisitCaseStmt(CaseStmt *C);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000513 CFGBlock *VisitChooseExpr(ChooseExpr *C, AddStmtChoice asc);
Ted Kremenek21822592009-07-17 18:20:32 +0000514 CFGBlock *VisitCompoundStmt(CompoundStmt *C);
John McCallc07a0c72011-02-17 10:25:35 +0000515 CFGBlock *VisitConditionalOperator(AbstractConditionalOperator *C,
516 AddStmtChoice asc);
Ted Kremenek21822592009-07-17 18:20:32 +0000517 CFGBlock *VisitContinueStmt(ContinueStmt *C);
Ted Kremenek6f400242012-07-14 05:04:01 +0000518 CFGBlock *VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
519 AddStmtChoice asc);
520 CFGBlock *VisitCXXCatchStmt(CXXCatchStmt *S);
521 CFGBlock *VisitCXXConstructExpr(CXXConstructExpr *C, AddStmtChoice asc);
Jordan Rosec9176072014-01-13 17:59:19 +0000522 CFGBlock *VisitCXXNewExpr(CXXNewExpr *DE, AddStmtChoice asc);
Jordan Rosed2f40792013-09-03 17:00:57 +0000523 CFGBlock *VisitCXXDeleteExpr(CXXDeleteExpr *DE, AddStmtChoice asc);
Ted Kremenek6f400242012-07-14 05:04:01 +0000524 CFGBlock *VisitCXXForRangeStmt(CXXForRangeStmt *S);
525 CFGBlock *VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
526 AddStmtChoice asc);
527 CFGBlock *VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
528 AddStmtChoice asc);
529 CFGBlock *VisitCXXThrowExpr(CXXThrowExpr *T);
530 CFGBlock *VisitCXXTryStmt(CXXTryStmt *S);
Ted Kremenek93668002009-07-17 22:18:43 +0000531 CFGBlock *VisitDeclStmt(DeclStmt *DS);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000532 CFGBlock *VisitDeclSubExpr(DeclStmt *DS);
Ted Kremenek21822592009-07-17 18:20:32 +0000533 CFGBlock *VisitDefaultStmt(DefaultStmt *D);
534 CFGBlock *VisitDoStmt(DoStmt *D);
Ted Kremenek6f400242012-07-14 05:04:01 +0000535 CFGBlock *VisitExprWithCleanups(ExprWithCleanups *E, AddStmtChoice asc);
Ted Kremenek21822592009-07-17 18:20:32 +0000536 CFGBlock *VisitForStmt(ForStmt *F);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000537 CFGBlock *VisitGotoStmt(GotoStmt *G);
Ted Kremenek93668002009-07-17 22:18:43 +0000538 CFGBlock *VisitIfStmt(IfStmt *I);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +0000539 CFGBlock *VisitImplicitCastExpr(ImplicitCastExpr *E, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000540 CFGBlock *VisitIndirectGotoStmt(IndirectGotoStmt *I);
541 CFGBlock *VisitLabelStmt(LabelStmt *L);
Devin Coughlinb6029b72015-11-25 22:35:37 +0000542 CFGBlock *VisitBlockExpr(BlockExpr *E, AddStmtChoice asc);
Ted Kremenek6f400242012-07-14 05:04:01 +0000543 CFGBlock *VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc);
Ted Kremeneka16436f2012-07-14 05:04:06 +0000544 CFGBlock *VisitLogicalOperator(BinaryOperator *B);
Ted Kremenekb50e7162012-07-14 05:04:10 +0000545 std::pair<CFGBlock *, CFGBlock *> VisitLogicalOperator(BinaryOperator *B,
546 Stmt *Term,
547 CFGBlock *TrueBlock,
548 CFGBlock *FalseBlock);
Ted Kremenek5868ec62010-04-11 17:02:10 +0000549 CFGBlock *VisitMemberExpr(MemberExpr *M, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000550 CFGBlock *VisitObjCAtCatchStmt(ObjCAtCatchStmt *S);
551 CFGBlock *VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S);
552 CFGBlock *VisitObjCAtThrowStmt(ObjCAtThrowStmt *S);
553 CFGBlock *VisitObjCAtTryStmt(ObjCAtTryStmt *S);
Ted Kremenek6f400242012-07-14 05:04:01 +0000554 CFGBlock *VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S);
Ted Kremenek93668002009-07-17 22:18:43 +0000555 CFGBlock *VisitObjCForCollectionStmt(ObjCForCollectionStmt *S);
John McCallfe96e0b2011-11-06 09:01:30 +0000556 CFGBlock *VisitPseudoObjectExpr(PseudoObjectExpr *E);
Ted Kremenek6f400242012-07-14 05:04:01 +0000557 CFGBlock *VisitReturnStmt(ReturnStmt *R);
Nico Weber699670e2017-08-23 15:33:16 +0000558 CFGBlock *VisitSEHExceptStmt(SEHExceptStmt *S);
559 CFGBlock *VisitSEHFinallyStmt(SEHFinallyStmt *S);
560 CFGBlock *VisitSEHLeaveStmt(SEHLeaveStmt *S);
561 CFGBlock *VisitSEHTryStmt(SEHTryStmt *S);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000562 CFGBlock *VisitStmtExpr(StmtExpr *S, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000563 CFGBlock *VisitSwitchStmt(SwitchStmt *S);
Ted Kremenek6f400242012-07-14 05:04:01 +0000564 CFGBlock *VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
565 AddStmtChoice asc);
Zhanyong Wan6dace612010-11-22 08:45:56 +0000566 CFGBlock *VisitUnaryOperator(UnaryOperator *U, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000567 CFGBlock *VisitWhileStmt(WhileStmt *W);
Mike Stump48871a22009-07-17 01:04:31 +0000568
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000569 CFGBlock *Visit(Stmt *S, AddStmtChoice asc = AddStmtChoice::NotAlwaysAdd);
570 CFGBlock *VisitStmt(Stmt *S, AddStmtChoice asc);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000571 CFGBlock *VisitChildren(Stmt *S);
Ted Kremeneke2499842012-04-12 20:03:44 +0000572 CFGBlock *VisitNoRecurse(Expr *E, AddStmtChoice asc);
Mike Stump48871a22009-07-17 01:04:31 +0000573
Manuel Klimekb5616c92014-08-07 10:42:17 +0000574 /// When creating the CFG for temporary destructors, we want to mirror the
575 /// branch structure of the corresponding constructor calls.
576 /// Thus, while visiting a statement for temporary destructors, we keep a
577 /// context to keep track of the following information:
578 /// - whether a subexpression is executed unconditionally
579 /// - if a subexpression is executed conditionally, the first
580 /// CXXBindTemporaryExpr we encounter in that subexpression (which
581 /// corresponds to the last temporary destructor we have to call for this
582 /// subexpression) and the CFG block at that point (which will become the
583 /// successor block when inserting the decision point).
584 ///
585 /// That way, we can build the branch structure for temporary destructors as
586 /// follows:
587 /// 1. If a subexpression is executed unconditionally, we add the temporary
588 /// destructor calls to the current block.
589 /// 2. If a subexpression is executed conditionally, when we encounter a
590 /// CXXBindTemporaryExpr:
591 /// a) If it is the first temporary destructor call in the subexpression,
592 /// we remember the CXXBindTemporaryExpr and the current block in the
593 /// TempDtorContext; we start a new block, and insert the temporary
594 /// destructor call.
595 /// b) Otherwise, add the temporary destructor call to the current block.
596 /// 3. When we finished visiting a conditionally executed subexpression,
597 /// and we found at least one temporary constructor during the visitation
598 /// (2.a has executed), we insert a decision block that uses the
599 /// CXXBindTemporaryExpr as terminator, and branches to the current block
600 /// if the CXXBindTemporaryExpr was marked executed, and otherwise
601 /// branches to the stored successor.
602 struct TempDtorContext {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000603 TempDtorContext() = default;
Manuel Klimekdeb02622014-08-08 07:37:13 +0000604 TempDtorContext(TryResult KnownExecuted)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000605 : IsConditional(true), KnownExecuted(KnownExecuted) {}
Manuel Klimekb5616c92014-08-07 10:42:17 +0000606
607 /// Returns whether we need to start a new branch for a temporary destructor
Eric Christopher2c4555a2015-06-19 01:52:53 +0000608 /// call. This is the case when the temporary destructor is
Manuel Klimekb5616c92014-08-07 10:42:17 +0000609 /// conditionally executed, and it is the first one we encounter while
610 /// visiting a subexpression - other temporary destructors at the same level
611 /// will be added to the same block and are executed under the same
612 /// condition.
613 bool needsTempDtorBranch() const {
614 return IsConditional && !TerminatorExpr;
615 }
616
617 /// Remember the successor S of a temporary destructor decision branch for
618 /// the corresponding CXXBindTemporaryExpr E.
619 void setDecisionPoint(CFGBlock *S, CXXBindTemporaryExpr *E) {
620 Succ = S;
621 TerminatorExpr = E;
622 }
623
Eugene Zelenko38c70522017-12-07 21:55:09 +0000624 const bool IsConditional = false;
625 const TryResult KnownExecuted = true;
626 CFGBlock *Succ = nullptr;
627 CXXBindTemporaryExpr *TerminatorExpr = nullptr;
Manuel Klimekb5616c92014-08-07 10:42:17 +0000628 };
629
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000630 // Visitors to walk an AST and generate destructors of temporaries in
631 // full expression.
Manuel Klimekb5616c92014-08-07 10:42:17 +0000632 CFGBlock *VisitForTemporaryDtors(Stmt *E, bool BindToTemporary,
633 TempDtorContext &Context);
634 CFGBlock *VisitChildrenForTemporaryDtors(Stmt *E, TempDtorContext &Context);
635 CFGBlock *VisitBinaryOperatorForTemporaryDtors(BinaryOperator *E,
636 TempDtorContext &Context);
637 CFGBlock *VisitCXXBindTemporaryExprForTemporaryDtors(
638 CXXBindTemporaryExpr *E, bool BindToTemporary, TempDtorContext &Context);
639 CFGBlock *VisitConditionalOperatorForTemporaryDtors(
640 AbstractConditionalOperator *E, bool BindToTemporary,
641 TempDtorContext &Context);
642 void InsertTempDtorDecisionBlock(const TempDtorContext &Context,
643 CFGBlock *FalseSucc = nullptr);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000644
Ted Kremenek6065ef62008-04-28 18:00:46 +0000645 // NYS == Not Yet Supported
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000646 CFGBlock *NYS() {
Ted Kremenekb64d1832008-03-13 03:04:22 +0000647 badCFG = true;
648 return Block;
649 }
Mike Stump31feda52009-07-17 01:31:16 +0000650
Artem Dergachev41ffb302018-02-08 22:58:15 +0000651 // Scan the child statement \p Child to find the constructor that might
652 // have been directly triggered by the current node, \p Trigger. If such
653 // constructor has been found, set current construction context to point
654 // to the trigger statement. The construction context will be unset once
655 // it is consumed when the CFG building procedure processes the
656 // construct-expression and adds the respective CFGConstructor element.
Artem Dergachev5a281bb2018-02-10 02:18:04 +0000657 void EnterConstructionContextIfNecessary(
658 ConstructionContext::TriggerTy Trigger, Stmt *Child);
Artem Dergachev41ffb302018-02-08 22:58:15 +0000659 // Unset the construction context after consuming it. This is done immediately
660 // after adding the CFGConstructor element, so there's no need to
661 // do this manually in every Visit... function.
662 void ExitConstructionContext();
663
Ted Kremenek93668002009-07-17 22:18:43 +0000664 void autoCreateBlock() { if (!Block) Block = createBlock(); }
665 CFGBlock *createBlock(bool add_successor = true);
Chandler Carrutha70991b2011-09-13 09:13:49 +0000666 CFGBlock *createNoReturnBlock();
Zhongxing Xu33dfc072010-09-06 07:32:31 +0000667
Zhongxing Xuea9fcff2010-06-03 06:43:23 +0000668 CFGBlock *addStmt(Stmt *S) {
669 return Visit(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000670 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000671
Alexis Hunt1d792652011-01-08 20:30:50 +0000672 CFGBlock *addInitializer(CXXCtorInitializer *I);
Peter Szecsi999a25f2017-08-19 11:19:16 +0000673 void addLoopExit(const Stmt *LoopStmt);
Zhongxing Xu6d372f72010-10-01 03:22:39 +0000674 void addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000675 LocalScope::const_iterator E, Stmt *S);
Matthias Gehre351c2182017-07-12 07:04:19 +0000676 void addLifetimeEnds(LocalScope::const_iterator B,
677 LocalScope::const_iterator E, Stmt *S);
678 void addAutomaticObjHandling(LocalScope::const_iterator B,
679 LocalScope::const_iterator E, Stmt *S);
Marcin Swiderski20b88732010-10-05 05:37:00 +0000680 void addImplicitDtorsForDestructor(const CXXDestructorDecl *DD);
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000681
Marcin Swiderski5e415732010-09-30 23:05:00 +0000682 // Local scopes creation.
683 LocalScope* createOrReuseLocalScope(LocalScope* Scope);
684
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000685 void addLocalScopeForStmt(Stmt *S);
Craig Topper25542942014-05-20 04:30:07 +0000686 LocalScope* addLocalScopeForDeclStmt(DeclStmt *DS,
687 LocalScope* Scope = nullptr);
688 LocalScope* addLocalScopeForVarDecl(VarDecl *VD, LocalScope* Scope = nullptr);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000689
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000690 void addLocalScopeAndDtors(Stmt *S);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000691
692 // Interface to CFGBlock - adding CFGElements.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000693
Ted Kremenek37881932011-04-04 23:29:12 +0000694 void appendStmt(CFGBlock *B, const Stmt *S) {
Ted Kremenek8b46c002011-07-19 14:18:43 +0000695 if (alwaysAdd(S) && cachedEntry)
Ted Kremeneka099c592011-03-10 03:50:34 +0000696 cachedEntry->second = B;
Ted Kremeneka099c592011-03-10 03:50:34 +0000697
Jordy Rose17347372011-06-10 08:49:37 +0000698 // All block-level expressions should have already been IgnoreParens()ed.
699 assert(!isa<Expr>(S) || cast<Expr>(S)->IgnoreParens() == S);
Ted Kremenek37881932011-04-04 23:29:12 +0000700 B->appendStmt(const_cast<Stmt*>(S), cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000701 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000702
Artem Dergachev41ffb302018-02-08 22:58:15 +0000703 void appendConstructor(CFGBlock *B, CXXConstructExpr *CE) {
704 if (BuildOpts.AddRichCXXConstructors) {
705 if (!CurrentConstructionContext.isNull()) {
706 B->appendConstructor(CE, CurrentConstructionContext,
707 cfg->getBumpVectorContext());
708 ExitConstructionContext();
709 return;
710 }
711 }
712
713 // No valid construction context found. Fall back to statement.
714 B->appendStmt(CE, cfg->getBumpVectorContext());
715 }
716
Alexis Hunt1d792652011-01-08 20:30:50 +0000717 void appendInitializer(CFGBlock *B, CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +0000718 B->appendInitializer(I, cfg->getBumpVectorContext());
719 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000720
Jordan Rosec9176072014-01-13 17:59:19 +0000721 void appendNewAllocator(CFGBlock *B, CXXNewExpr *NE) {
722 B->appendNewAllocator(NE, cfg->getBumpVectorContext());
723 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000724
Marcin Swiderski20b88732010-10-05 05:37:00 +0000725 void appendBaseDtor(CFGBlock *B, const CXXBaseSpecifier *BS) {
726 B->appendBaseDtor(BS, cfg->getBumpVectorContext());
727 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000728
Marcin Swiderski20b88732010-10-05 05:37:00 +0000729 void appendMemberDtor(CFGBlock *B, FieldDecl *FD) {
730 B->appendMemberDtor(FD, cfg->getBumpVectorContext());
731 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000732
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000733 void appendTemporaryDtor(CFGBlock *B, CXXBindTemporaryExpr *E) {
734 B->appendTemporaryDtor(E, cfg->getBumpVectorContext());
735 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000736
Chandler Carruthad747252011-09-13 06:09:01 +0000737 void appendAutomaticObjDtor(CFGBlock *B, VarDecl *VD, Stmt *S) {
738 B->appendAutomaticObjDtor(VD, S, cfg->getBumpVectorContext());
739 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000740
Matthias Gehre351c2182017-07-12 07:04:19 +0000741 void appendLifetimeEnds(CFGBlock *B, VarDecl *VD, Stmt *S) {
742 B->appendLifetimeEnds(VD, S, cfg->getBumpVectorContext());
743 }
744
Peter Szecsi999a25f2017-08-19 11:19:16 +0000745 void appendLoopExit(CFGBlock *B, const Stmt *LoopStmt) {
746 B->appendLoopExit(LoopStmt, cfg->getBumpVectorContext());
747 }
748
Jordan Rosed2f40792013-09-03 17:00:57 +0000749 void appendDeleteDtor(CFGBlock *B, CXXRecordDecl *RD, CXXDeleteExpr *DE) {
750 B->appendDeleteDtor(RD, DE, cfg->getBumpVectorContext());
751 }
752
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000753 void prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +0000754 LocalScope::const_iterator B, LocalScope::const_iterator E);
755
Matthias Gehre351c2182017-07-12 07:04:19 +0000756 void prependAutomaticObjLifetimeWithTerminator(CFGBlock *Blk,
757 LocalScope::const_iterator B,
758 LocalScope::const_iterator E);
759
Ted Kremenek4b6fee62014-02-27 00:24:00 +0000760 void addSuccessor(CFGBlock *B, CFGBlock *S, bool IsReachable = true) {
761 B->addSuccessor(CFGBlock::AdjacentBlock(S, IsReachable),
762 cfg->getBumpVectorContext());
763 }
764
765 /// Add a reachable successor to a block, with the alternate variant that is
766 /// unreachable.
767 void addSuccessor(CFGBlock *B, CFGBlock *ReachableBlock, CFGBlock *AltBlock) {
768 B->addSuccessor(CFGBlock::AdjacentBlock(ReachableBlock, AltBlock),
769 cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000770 }
Mike Stump11289f42009-09-09 15:08:12 +0000771
Richard Trieuf935b562014-04-05 05:17:01 +0000772 /// \brief Find a relational comparison with an expression evaluating to a
773 /// boolean and a constant other than 0 and 1.
774 /// e.g. if ((x < y) == 10)
775 TryResult checkIncorrectRelationalOperator(const BinaryOperator *B) {
776 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
777 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
778
779 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
780 const Expr *BoolExpr = RHSExpr;
781 bool IntFirst = true;
782 if (!IntLiteral) {
783 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
784 BoolExpr = LHSExpr;
785 IntFirst = false;
786 }
787
788 if (!IntLiteral || !BoolExpr->isKnownToHaveBooleanValue())
789 return TryResult();
790
791 llvm::APInt IntValue = IntLiteral->getValue();
792 if ((IntValue == 1) || (IntValue == 0))
793 return TryResult();
794
795 bool IntLarger = IntLiteral->getType()->isUnsignedIntegerType() ||
796 !IntValue.isNegative();
797
798 BinaryOperatorKind Bok = B->getOpcode();
799 if (Bok == BO_GT || Bok == BO_GE) {
800 // Always true for 10 > bool and bool > -1
801 // Always false for -1 > bool and bool > 10
802 return TryResult(IntFirst == IntLarger);
803 } else {
804 // Always true for -1 < bool and bool < 10
805 // Always false for 10 < bool and bool < -1
806 return TryResult(IntFirst != IntLarger);
807 }
808 }
809
Jordan Rose7afd71e2014-05-20 17:31:11 +0000810 /// Find an incorrect equality comparison. Either with an expression
811 /// evaluating to a boolean and a constant other than 0 and 1.
812 /// e.g. if (!x == 10) or a bitwise and/or operation that always evaluates to
813 /// true/false e.q. (x & 8) == 4.
Richard Trieuf935b562014-04-05 05:17:01 +0000814 TryResult checkIncorrectEqualityOperator(const BinaryOperator *B) {
815 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
816 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
817
818 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
819 const Expr *BoolExpr = RHSExpr;
820
821 if (!IntLiteral) {
822 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
823 BoolExpr = LHSExpr;
824 }
825
Jordan Rose7afd71e2014-05-20 17:31:11 +0000826 if (!IntLiteral)
Richard Trieuf935b562014-04-05 05:17:01 +0000827 return TryResult();
828
Jordan Rose7afd71e2014-05-20 17:31:11 +0000829 const BinaryOperator *BitOp = dyn_cast<BinaryOperator>(BoolExpr);
830 if (BitOp && (BitOp->getOpcode() == BO_And ||
831 BitOp->getOpcode() == BO_Or)) {
832 const Expr *LHSExpr2 = BitOp->getLHS()->IgnoreParens();
833 const Expr *RHSExpr2 = BitOp->getRHS()->IgnoreParens();
834
835 const IntegerLiteral *IntLiteral2 = dyn_cast<IntegerLiteral>(LHSExpr2);
836
837 if (!IntLiteral2)
838 IntLiteral2 = dyn_cast<IntegerLiteral>(RHSExpr2);
839
840 if (!IntLiteral2)
841 return TryResult();
842
843 llvm::APInt L1 = IntLiteral->getValue();
844 llvm::APInt L2 = IntLiteral2->getValue();
845 if ((BitOp->getOpcode() == BO_And && (L2 & L1) != L1) ||
846 (BitOp->getOpcode() == BO_Or && (L2 | L1) != L1)) {
847 if (BuildOpts.Observer)
848 BuildOpts.Observer->compareBitwiseEquality(B,
849 B->getOpcode() != BO_EQ);
850 TryResult(B->getOpcode() != BO_EQ);
851 }
852 } else if (BoolExpr->isKnownToHaveBooleanValue()) {
853 llvm::APInt IntValue = IntLiteral->getValue();
854 if ((IntValue == 1) || (IntValue == 0)) {
855 return TryResult();
856 }
857 return TryResult(B->getOpcode() != BO_EQ);
Richard Trieuf935b562014-04-05 05:17:01 +0000858 }
859
Jordan Rose7afd71e2014-05-20 17:31:11 +0000860 return TryResult();
Richard Trieuf935b562014-04-05 05:17:01 +0000861 }
862
863 TryResult analyzeLogicOperatorCondition(BinaryOperatorKind Relation,
864 const llvm::APSInt &Value1,
865 const llvm::APSInt &Value2) {
866 assert(Value1.isSigned() == Value2.isSigned());
867 switch (Relation) {
868 default:
869 return TryResult();
870 case BO_EQ:
871 return TryResult(Value1 == Value2);
872 case BO_NE:
873 return TryResult(Value1 != Value2);
874 case BO_LT:
875 return TryResult(Value1 < Value2);
876 case BO_LE:
877 return TryResult(Value1 <= Value2);
878 case BO_GT:
879 return TryResult(Value1 > Value2);
880 case BO_GE:
881 return TryResult(Value1 >= Value2);
882 }
883 }
884
885 /// \brief Find a pair of comparison expressions with or without parentheses
886 /// with a shared variable and constants and a logical operator between them
887 /// that always evaluates to either true or false.
888 /// e.g. if (x != 3 || x != 4)
889 TryResult checkIncorrectLogicOperator(const BinaryOperator *B) {
890 assert(B->isLogicalOp());
891 const BinaryOperator *LHS =
892 dyn_cast<BinaryOperator>(B->getLHS()->IgnoreParens());
893 const BinaryOperator *RHS =
894 dyn_cast<BinaryOperator>(B->getRHS()->IgnoreParens());
895 if (!LHS || !RHS)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000896 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000897
898 if (!LHS->isComparisonOp() || !RHS->isComparisonOp())
Eugene Zelenko38c70522017-12-07 21:55:09 +0000899 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000900
George Burgess IVced56e62015-10-01 18:47:52 +0000901 const DeclRefExpr *Decl1;
902 const Expr *Expr1;
903 BinaryOperatorKind BO1;
904 std::tie(Decl1, BO1, Expr1) = tryNormalizeBinaryOperator(LHS);
Richard Trieuf935b562014-04-05 05:17:01 +0000905
George Burgess IVced56e62015-10-01 18:47:52 +0000906 if (!Decl1 || !Expr1)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000907 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000908
George Burgess IVced56e62015-10-01 18:47:52 +0000909 const DeclRefExpr *Decl2;
910 const Expr *Expr2;
911 BinaryOperatorKind BO2;
912 std::tie(Decl2, BO2, Expr2) = tryNormalizeBinaryOperator(RHS);
Richard Trieuf935b562014-04-05 05:17:01 +0000913
George Burgess IVced56e62015-10-01 18:47:52 +0000914 if (!Decl2 || !Expr2)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000915 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000916
917 // Check that it is the same variable on both sides.
918 if (Decl1->getDecl() != Decl2->getDecl())
Eugene Zelenko38c70522017-12-07 21:55:09 +0000919 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000920
George Burgess IVced56e62015-10-01 18:47:52 +0000921 // Make sure the user's intent is clear (e.g. they're comparing against two
922 // int literals, or two things from the same enum)
923 if (!areExprTypesCompatible(Expr1, Expr2))
Eugene Zelenko38c70522017-12-07 21:55:09 +0000924 return {};
George Burgess IVced56e62015-10-01 18:47:52 +0000925
Richard Trieuf935b562014-04-05 05:17:01 +0000926 llvm::APSInt L1, L2;
927
George Burgess IVced56e62015-10-01 18:47:52 +0000928 if (!Expr1->EvaluateAsInt(L1, *Context) ||
929 !Expr2->EvaluateAsInt(L2, *Context))
Eugene Zelenko38c70522017-12-07 21:55:09 +0000930 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000931
932 // Can't compare signed with unsigned or with different bit width.
933 if (L1.isSigned() != L2.isSigned() || L1.getBitWidth() != L2.getBitWidth())
Eugene Zelenko38c70522017-12-07 21:55:09 +0000934 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000935
936 // Values that will be used to determine if result of logical
937 // operator is always true/false
938 const llvm::APSInt Values[] = {
939 // Value less than both Value1 and Value2
940 llvm::APSInt::getMinValue(L1.getBitWidth(), L1.isUnsigned()),
941 // L1
942 L1,
943 // Value between Value1 and Value2
944 ((L1 < L2) ? L1 : L2) + llvm::APSInt(llvm::APInt(L1.getBitWidth(), 1),
945 L1.isUnsigned()),
946 // L2
947 L2,
948 // Value greater than both Value1 and Value2
949 llvm::APSInt::getMaxValue(L1.getBitWidth(), L1.isUnsigned()),
950 };
951
952 // Check whether expression is always true/false by evaluating the following
953 // * variable x is less than the smallest literal.
954 // * variable x is equal to the smallest literal.
955 // * Variable x is between smallest and largest literal.
956 // * Variable x is equal to the largest literal.
957 // * Variable x is greater than largest literal.
958 bool AlwaysTrue = true, AlwaysFalse = true;
Benjamin Kramer2e018ef2016-05-27 13:36:58 +0000959 for (const llvm::APSInt &Value : Values) {
Richard Trieuf935b562014-04-05 05:17:01 +0000960 TryResult Res1, Res2;
961 Res1 = analyzeLogicOperatorCondition(BO1, Value, L1);
962 Res2 = analyzeLogicOperatorCondition(BO2, Value, L2);
963
964 if (!Res1.isKnown() || !Res2.isKnown())
Eugene Zelenko38c70522017-12-07 21:55:09 +0000965 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000966
967 if (B->getOpcode() == BO_LAnd) {
968 AlwaysTrue &= (Res1.isTrue() && Res2.isTrue());
969 AlwaysFalse &= !(Res1.isTrue() && Res2.isTrue());
970 } else {
971 AlwaysTrue &= (Res1.isTrue() || Res2.isTrue());
972 AlwaysFalse &= !(Res1.isTrue() || Res2.isTrue());
973 }
974 }
975
976 if (AlwaysTrue || AlwaysFalse) {
977 if (BuildOpts.Observer)
978 BuildOpts.Observer->compareAlwaysTrue(B, AlwaysTrue);
979 return TryResult(AlwaysTrue);
980 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000981 return {};
Richard Trieuf935b562014-04-05 05:17:01 +0000982 }
983
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000984 /// Try and evaluate an expression to an integer constant.
985 bool tryEvaluate(Expr *S, Expr::EvalResult &outResult) {
986 if (!BuildOpts.PruneTriviallyFalseEdges)
987 return false;
988 return !S->isTypeDependent() &&
Ted Kremenek352a7082011-04-04 20:30:58 +0000989 !S->isValueDependent() &&
Richard Smith7b553f12011-10-29 00:50:52 +0000990 S->EvaluateAsRValue(outResult, *Context);
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000991 }
Mike Stump11289f42009-09-09 15:08:12 +0000992
Ted Kremenek3a9a2a52010-12-17 04:44:39 +0000993 /// tryEvaluateBool - Try and evaluate the Stmt and return 0 or 1
Mike Stump773582d2009-07-23 23:25:26 +0000994 /// if we can evaluate to a known value, otherwise return -1.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +0000995 TryResult tryEvaluateBool(Expr *S) {
Richard Smithfaa32a92011-10-14 20:22:00 +0000996 if (!BuildOpts.PruneTriviallyFalseEdges ||
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000997 S->isTypeDependent() || S->isValueDependent())
Eugene Zelenko38c70522017-12-07 21:55:09 +0000998 return {};
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000999
1000 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(S)) {
1001 if (Bop->isLogicalOp()) {
1002 // Check the cache first.
NAKAMURA Takumie9ca55e2012-03-25 06:30:37 +00001003 CachedBoolEvalsTy::iterator I = CachedBoolEvals.find(S);
1004 if (I != CachedBoolEvals.end())
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001005 return I->second; // already in map;
NAKAMURA Takumif0434b02012-03-25 06:30:32 +00001006
1007 // Retrieve result at first, or the map might be updated.
1008 TryResult Result = evaluateAsBooleanConditionNoCache(S);
1009 CachedBoolEvals[S] = Result; // update or insert
1010 return Result;
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001011 }
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001012 else {
1013 switch (Bop->getOpcode()) {
1014 default: break;
1015 // For 'x & 0' and 'x * 0', we can determine that
1016 // the value is always false.
1017 case BO_Mul:
1018 case BO_And: {
1019 // If either operand is zero, we know the value
1020 // must be false.
1021 llvm::APSInt IntVal;
1022 if (Bop->getLHS()->EvaluateAsInt(IntVal, *Context)) {
David Blaikie7a3cbb22015-03-09 02:02:07 +00001023 if (!IntVal.getBoolValue()) {
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001024 return TryResult(false);
1025 }
1026 }
1027 if (Bop->getRHS()->EvaluateAsInt(IntVal, *Context)) {
David Blaikie7a3cbb22015-03-09 02:02:07 +00001028 if (!IntVal.getBoolValue()) {
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001029 return TryResult(false);
1030 }
1031 }
1032 }
1033 break;
1034 }
1035 }
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001036 }
1037
1038 return evaluateAsBooleanConditionNoCache(S);
1039 }
1040
1041 /// \brief Evaluate as boolean \param E without using the cache.
1042 TryResult evaluateAsBooleanConditionNoCache(Expr *E) {
1043 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(E)) {
1044 if (Bop->isLogicalOp()) {
1045 TryResult LHS = tryEvaluateBool(Bop->getLHS());
1046 if (LHS.isKnown()) {
1047 // We were able to evaluate the LHS, see if we can get away with not
1048 // evaluating the RHS: 0 && X -> 0, 1 || X -> 1
1049 if (LHS.isTrue() == (Bop->getOpcode() == BO_LOr))
1050 return LHS.isTrue();
1051
1052 TryResult RHS = tryEvaluateBool(Bop->getRHS());
1053 if (RHS.isKnown()) {
1054 if (Bop->getOpcode() == BO_LOr)
1055 return LHS.isTrue() || RHS.isTrue();
1056 else
1057 return LHS.isTrue() && RHS.isTrue();
1058 }
1059 } else {
1060 TryResult RHS = tryEvaluateBool(Bop->getRHS());
1061 if (RHS.isKnown()) {
1062 // We can't evaluate the LHS; however, sometimes the result
1063 // is determined by the RHS: X && 0 -> 0, X || 1 -> 1.
1064 if (RHS.isTrue() == (Bop->getOpcode() == BO_LOr))
1065 return RHS.isTrue();
Richard Trieuf935b562014-04-05 05:17:01 +00001066 } else {
1067 TryResult BopRes = checkIncorrectLogicOperator(Bop);
1068 if (BopRes.isKnown())
1069 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001070 }
1071 }
1072
Eugene Zelenko38c70522017-12-07 21:55:09 +00001073 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001074 } else if (Bop->isEqualityOp()) {
1075 TryResult BopRes = checkIncorrectEqualityOperator(Bop);
1076 if (BopRes.isKnown())
1077 return BopRes.isTrue();
1078 } else if (Bop->isRelationalOp()) {
1079 TryResult BopRes = checkIncorrectRelationalOperator(Bop);
1080 if (BopRes.isKnown())
1081 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001082 }
1083 }
1084
1085 bool Result;
1086 if (E->EvaluateAsBooleanCondition(Result, *Context))
1087 return Result;
1088
Eugene Zelenko38c70522017-12-07 21:55:09 +00001089 return {};
Mike Stump773582d2009-07-23 23:25:26 +00001090 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001091
1092 bool hasTrivialDestructor(VarDecl *VD);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00001093};
Mike Stump31feda52009-07-17 01:31:16 +00001094
Eugene Zelenko38c70522017-12-07 21:55:09 +00001095} // namespace
1096
Ted Kremeneka099c592011-03-10 03:50:34 +00001097inline bool AddStmtChoice::alwaysAdd(CFGBuilder &builder,
1098 const Stmt *stmt) const {
1099 return builder.alwaysAdd(stmt) || kind == AlwaysAdd;
1100}
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001101
Ted Kremeneka099c592011-03-10 03:50:34 +00001102bool CFGBuilder::alwaysAdd(const Stmt *stmt) {
Ted Kremenek8b46c002011-07-19 14:18:43 +00001103 bool shouldAdd = BuildOpts.alwaysAdd(stmt);
1104
Ted Kremeneka099c592011-03-10 03:50:34 +00001105 if (!BuildOpts.forcedBlkExprs)
Ted Kremenek8b46c002011-07-19 14:18:43 +00001106 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001107
1108 if (lastLookup == stmt) {
1109 if (cachedEntry) {
1110 assert(cachedEntry->first == stmt);
1111 return true;
1112 }
Ted Kremenek8b46c002011-07-19 14:18:43 +00001113 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001114 }
Ted Kremeneka099c592011-03-10 03:50:34 +00001115
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001116 lastLookup = stmt;
1117
1118 // Perform the lookup!
Ted Kremeneka099c592011-03-10 03:50:34 +00001119 CFG::BuildOptions::ForcedBlkExprs *fb = *BuildOpts.forcedBlkExprs;
1120
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001121 if (!fb) {
1122 // No need to update 'cachedEntry', since it will always be null.
Craig Topper25542942014-05-20 04:30:07 +00001123 assert(!cachedEntry);
Ted Kremenek8b46c002011-07-19 14:18:43 +00001124 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001125 }
Ted Kremeneka099c592011-03-10 03:50:34 +00001126
1127 CFG::BuildOptions::ForcedBlkExprs::iterator itr = fb->find(stmt);
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001128 if (itr == fb->end()) {
Craig Topper25542942014-05-20 04:30:07 +00001129 cachedEntry = nullptr;
Ted Kremenek8b46c002011-07-19 14:18:43 +00001130 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001131 }
1132
Ted Kremeneka099c592011-03-10 03:50:34 +00001133 cachedEntry = &*itr;
1134 return true;
Ted Kremenek7c58d352011-03-10 01:14:11 +00001135}
1136
Douglas Gregor4619e432008-12-05 23:32:09 +00001137// FIXME: Add support for dependent-sized array types in C++?
1138// Does it even make sense to build a CFG for an uninstantiated template?
John McCall424cec92011-01-19 06:33:43 +00001139static const VariableArrayType *FindVA(const Type *t) {
1140 while (const ArrayType *vt = dyn_cast<ArrayType>(t)) {
1141 if (const VariableArrayType *vat = dyn_cast<VariableArrayType>(vt))
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001142 if (vat->getSizeExpr())
1143 return vat;
Mike Stump31feda52009-07-17 01:31:16 +00001144
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001145 t = vt->getElementType().getTypePtr();
1146 }
Mike Stump31feda52009-07-17 01:31:16 +00001147
Craig Topper25542942014-05-20 04:30:07 +00001148 return nullptr;
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001149}
Mike Stump31feda52009-07-17 01:31:16 +00001150
Artem Dergachev5a281bb2018-02-10 02:18:04 +00001151void CFGBuilder::EnterConstructionContextIfNecessary(
1152 ConstructionContext::TriggerTy Trigger, Stmt *Child) {
Artem Dergachev41ffb302018-02-08 22:58:15 +00001153 if (!BuildOpts.AddRichCXXConstructors)
1154 return;
1155 if (!Child)
1156 return;
Artem Dergachev675d6f42018-02-09 01:43:26 +00001157 if (isa<CXXConstructExpr>(Child)) {
Artem Dergachev41ffb302018-02-08 22:58:15 +00001158 assert(CurrentConstructionContext.isNull() &&
1159 "Already within a construction context!");
1160 CurrentConstructionContext = ConstructionContext(Trigger);
Artem Dergachev08225bb2018-02-10 02:46:14 +00001161 } else if (auto *Cleanups = dyn_cast<ExprWithCleanups>(Child)) {
1162 EnterConstructionContextIfNecessary(Trigger, Cleanups->getSubExpr());
Artem Dergachev41ffb302018-02-08 22:58:15 +00001163 }
1164}
1165
1166void CFGBuilder::ExitConstructionContext() {
1167 assert(!CurrentConstructionContext.isNull() &&
1168 "Cannot exit construction context without the context!");
1169 CurrentConstructionContext = ConstructionContext();
1170}
1171
1172
Mike Stump31feda52009-07-17 01:31:16 +00001173/// BuildCFG - Constructs a CFG from an AST (a Stmt*). The AST can represent an
1174/// arbitrary statement. Examples include a single expression or a function
1175/// body (compound statement). The ownership of the returned CFG is
1176/// transferred to the caller. If CFG construction fails, this method returns
1177/// NULL.
David Blaikiee90195c2014-08-29 18:53:26 +00001178std::unique_ptr<CFG> CFGBuilder::buildCFG(const Decl *D, Stmt *Statement) {
Ted Kremenek8aed4902009-10-20 23:46:25 +00001179 assert(cfg.get());
Ted Kremenek93668002009-07-17 22:18:43 +00001180 if (!Statement)
Craig Topper25542942014-05-20 04:30:07 +00001181 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001182
Mike Stump31feda52009-07-17 01:31:16 +00001183 // Create an empty block that will serve as the exit block for the CFG. Since
1184 // this is the first block added to the CFG, it will be implicitly registered
1185 // as the exit block.
Ted Kremenek81e14852007-08-27 19:46:09 +00001186 Succ = createBlock();
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001187 assert(Succ == &cfg->getExit());
Craig Topper25542942014-05-20 04:30:07 +00001188 Block = nullptr; // the EXIT block is empty. Create all other blocks lazily.
Mike Stump31feda52009-07-17 01:31:16 +00001189
Matthias Gehre351c2182017-07-12 07:04:19 +00001190 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1191 "AddImplicitDtors and AddLifetime cannot be used at the same time");
1192
Marcin Swiderski20b88732010-10-05 05:37:00 +00001193 if (BuildOpts.AddImplicitDtors)
1194 if (const CXXDestructorDecl *DD = dyn_cast_or_null<CXXDestructorDecl>(D))
1195 addImplicitDtorsForDestructor(DD);
1196
Ted Kremenek9aae5132007-08-23 21:42:29 +00001197 // Visit the statements and create the CFG.
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001198 CFGBlock *B = addStmt(Statement);
1199
1200 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001201 return nullptr;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001202
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001203 // For C++ constructor add initializers to CFG.
1204 if (const CXXConstructorDecl *CD = dyn_cast_or_null<CXXConstructorDecl>(D)) {
Pete Cooper57d3f142015-07-30 17:22:52 +00001205 for (auto *I : llvm::reverse(CD->inits())) {
1206 B = addInitializer(I);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001207 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001208 return nullptr;
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001209 }
1210 }
1211
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001212 if (B)
1213 Succ = B;
Mike Stump6bf1c082010-01-21 02:21:40 +00001214
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001215 // Backpatch the gotos whose label -> block mappings we didn't know when we
1216 // encountered them.
1217 for (BackpatchBlocksTy::iterator I = BackpatchBlocks.begin(),
1218 E = BackpatchBlocks.end(); I != E; ++I ) {
Mike Stump31feda52009-07-17 01:31:16 +00001219
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001220 CFGBlock *B = I->block;
Rafael Espindola210de572013-03-27 15:37:54 +00001221 const GotoStmt *G = cast<GotoStmt>(B->getTerminator());
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001222 LabelMapTy::iterator LI = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00001223
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001224 // If there is no target for the goto, then we are looking at an
1225 // incomplete AST. Handle this by not registering a successor.
1226 if (LI == LabelMap.end()) continue;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001227
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00001228 JumpTarget JT = LI->second;
Matthias Gehre351c2182017-07-12 07:04:19 +00001229 prependAutomaticObjLifetimeWithTerminator(B, I->scopePosition,
1230 JT.scopePosition);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001231 prependAutomaticObjDtorsWithTerminator(B, I->scopePosition,
1232 JT.scopePosition);
1233 addSuccessor(B, JT.block);
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001234 }
1235
1236 // Add successors to the Indirect Goto Dispatch block (if we have one).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001237 if (CFGBlock *B = cfg->getIndirectGotoBlock())
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001238 for (LabelSetTy::iterator I = AddressTakenLabels.begin(),
1239 E = AddressTakenLabels.end(); I != E; ++I ) {
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001240 // Lookup the target block.
1241 LabelMapTy::iterator LI = LabelMap.find(*I);
1242
1243 // If there is no target block that contains label, then we are looking
1244 // at an incomplete AST. Handle this by not registering a successor.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001245 if (LI == LabelMap.end()) continue;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001246
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001247 addSuccessor(B, LI->second.block);
Ted Kremenekeda180e22007-08-28 19:26:49 +00001248 }
Mike Stump31feda52009-07-17 01:31:16 +00001249
Mike Stump31feda52009-07-17 01:31:16 +00001250 // Create an empty entry block that has no predecessors.
Ted Kremenek5c50fd12007-09-26 21:23:31 +00001251 cfg->setEntry(createBlock());
Mike Stump31feda52009-07-17 01:31:16 +00001252
David Blaikiee90195c2014-08-29 18:53:26 +00001253 return std::move(cfg);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001254}
Mike Stump31feda52009-07-17 01:31:16 +00001255
Ted Kremenek9aae5132007-08-23 21:42:29 +00001256/// createBlock - Used to lazily create blocks that are connected
1257/// to the current (global) succcessor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001258CFGBlock *CFGBuilder::createBlock(bool add_successor) {
1259 CFGBlock *B = cfg->createBlock();
Ted Kremenek93668002009-07-17 22:18:43 +00001260 if (add_successor && Succ)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001261 addSuccessor(B, Succ);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001262 return B;
1263}
Mike Stump31feda52009-07-17 01:31:16 +00001264
Chandler Carrutha70991b2011-09-13 09:13:49 +00001265/// createNoReturnBlock - Used to create a block is a 'noreturn' point in the
1266/// CFG. It is *not* connected to the current (global) successor, and instead
1267/// directly tied to the exit block in order to be reachable.
1268CFGBlock *CFGBuilder::createNoReturnBlock() {
1269 CFGBlock *B = createBlock(false);
Chandler Carruth75d78232011-09-13 09:53:55 +00001270 B->setHasNoReturnElement();
Ted Kremenekf3539192014-02-27 00:24:05 +00001271 addSuccessor(B, &cfg->getExit(), Succ);
Chandler Carrutha70991b2011-09-13 09:13:49 +00001272 return B;
1273}
1274
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001275/// addInitializer - Add C++ base or member initializer element to CFG.
Alexis Hunt1d792652011-01-08 20:30:50 +00001276CFGBlock *CFGBuilder::addInitializer(CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001277 if (!BuildOpts.AddInitializers)
1278 return Block;
1279
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001280 bool HasTemporaries = false;
1281
1282 // Destructors of temporaries in initialization expression should be called
1283 // after initialization finishes.
1284 Expr *Init = I->getInit();
1285 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00001286 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001287
Jordan Rose6d671cc2012-09-05 22:55:23 +00001288 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001289 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00001290 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00001291 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
1292 /*BindToTemporary=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001293 }
1294 }
1295
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001296 autoCreateBlock();
1297 appendInitializer(Block, I);
1298
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001299 if (Init) {
Artem Dergachev5a281bb2018-02-10 02:18:04 +00001300 EnterConstructionContextIfNecessary(I, Init);
1301
Ted Kremenek8219b822010-12-16 07:46:53 +00001302 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001303 // For expression with temporaries go directly to subexpression to omit
1304 // generating destructors for the second time.
Ted Kremenek8219b822010-12-16 07:46:53 +00001305 return Visit(cast<ExprWithCleanups>(Init)->getSubExpr());
1306 }
Enrico Pertosofaed8012015-06-03 10:12:40 +00001307 if (BuildOpts.AddCXXDefaultInitExprInCtors) {
1308 if (CXXDefaultInitExpr *Default = dyn_cast<CXXDefaultInitExpr>(Init)) {
1309 // In general, appending the expression wrapped by a CXXDefaultInitExpr
1310 // may cause the same Expr to appear more than once in the CFG. Doing it
1311 // here is safe because there's only one initializer per field.
1312 autoCreateBlock();
1313 appendStmt(Block, Default);
1314 if (Stmt *Child = Default->getExpr())
1315 if (CFGBlock *R = Visit(Child))
1316 Block = R;
1317 return Block;
1318 }
1319 }
Ted Kremenek8219b822010-12-16 07:46:53 +00001320 return Visit(Init);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001321 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001322
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001323 return Block;
1324}
1325
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001326/// \brief Retrieve the type of the temporary object whose lifetime was
1327/// extended by a local reference with the given initializer.
1328static QualType getReferenceInitTemporaryType(ASTContext &Context,
Richard Smithb8c0f552016-12-09 18:49:13 +00001329 const Expr *Init,
1330 bool *FoundMTE = nullptr) {
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001331 while (true) {
1332 // Skip parentheses.
1333 Init = Init->IgnoreParens();
1334
1335 // Skip through cleanups.
1336 if (const ExprWithCleanups *EWC = dyn_cast<ExprWithCleanups>(Init)) {
1337 Init = EWC->getSubExpr();
1338 continue;
1339 }
1340
1341 // Skip through the temporary-materialization expression.
1342 if (const MaterializeTemporaryExpr *MTE
1343 = dyn_cast<MaterializeTemporaryExpr>(Init)) {
1344 Init = MTE->GetTemporaryExpr();
Richard Smithb8c0f552016-12-09 18:49:13 +00001345 if (FoundMTE)
1346 *FoundMTE = true;
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001347 continue;
1348 }
1349
1350 // Skip derived-to-base and no-op casts.
1351 if (const CastExpr *CE = dyn_cast<CastExpr>(Init)) {
1352 if ((CE->getCastKind() == CK_DerivedToBase ||
1353 CE->getCastKind() == CK_UncheckedDerivedToBase ||
1354 CE->getCastKind() == CK_NoOp) &&
1355 Init->getType()->isRecordType()) {
1356 Init = CE->getSubExpr();
1357 continue;
1358 }
1359 }
1360
1361 // Skip member accesses into rvalues.
1362 if (const MemberExpr *ME = dyn_cast<MemberExpr>(Init)) {
1363 if (!ME->isArrow() && ME->getBase()->isRValue()) {
1364 Init = ME->getBase();
1365 continue;
1366 }
1367 }
1368
1369 break;
1370 }
1371
1372 return Init->getType();
1373}
Matthias Gehre351c2182017-07-12 07:04:19 +00001374
Peter Szecsi999a25f2017-08-19 11:19:16 +00001375// TODO: Support adding LoopExit element to the CFG in case where the loop is
1376// ended by ReturnStmt, GotoStmt or ThrowExpr.
1377void CFGBuilder::addLoopExit(const Stmt *LoopStmt){
1378 if(!BuildOpts.AddLoopExit)
1379 return;
1380 autoCreateBlock();
1381 appendLoopExit(Block, LoopStmt);
1382}
1383
Matthias Gehre351c2182017-07-12 07:04:19 +00001384void CFGBuilder::addAutomaticObjHandling(LocalScope::const_iterator B,
1385 LocalScope::const_iterator E,
1386 Stmt *S) {
1387 if (BuildOpts.AddImplicitDtors)
1388 addAutomaticObjDtors(B, E, S);
1389 if (BuildOpts.AddLifetime)
1390 addLifetimeEnds(B, E, S);
1391}
1392
1393/// Add to current block automatic objects that leave the scope.
1394void CFGBuilder::addLifetimeEnds(LocalScope::const_iterator B,
1395 LocalScope::const_iterator E, Stmt *S) {
1396 if (!BuildOpts.AddLifetime)
1397 return;
1398
1399 if (B == E)
1400 return;
1401
1402 // To go from B to E, one first goes up the scopes from B to P
1403 // then sideways in one scope from P to P' and then down
1404 // the scopes from P' to E.
1405 // The lifetime of all objects between B and P end.
1406 LocalScope::const_iterator P = B.shared_parent(E);
1407 int dist = B.distance(P);
1408 if (dist <= 0)
1409 return;
1410
1411 // We need to perform the scope leaving in reverse order
1412 SmallVector<VarDecl *, 10> DeclsTrivial;
1413 SmallVector<VarDecl *, 10> DeclsNonTrivial;
1414 DeclsTrivial.reserve(dist);
1415 DeclsNonTrivial.reserve(dist);
1416
1417 for (LocalScope::const_iterator I = B; I != P; ++I)
1418 if (hasTrivialDestructor(*I))
1419 DeclsTrivial.push_back(*I);
1420 else
1421 DeclsNonTrivial.push_back(*I);
1422
1423 autoCreateBlock();
1424 // object with trivial destructor end their lifetime last (when storage
1425 // duration ends)
1426 for (SmallVectorImpl<VarDecl *>::reverse_iterator I = DeclsTrivial.rbegin(),
1427 E = DeclsTrivial.rend();
1428 I != E; ++I)
1429 appendLifetimeEnds(Block, *I, S);
1430
1431 for (SmallVectorImpl<VarDecl *>::reverse_iterator
1432 I = DeclsNonTrivial.rbegin(),
1433 E = DeclsNonTrivial.rend();
1434 I != E; ++I)
1435 appendLifetimeEnds(Block, *I, S);
1436}
1437
Marcin Swiderski5e415732010-09-30 23:05:00 +00001438/// addAutomaticObjDtors - Add to current block automatic objects destructors
1439/// for objects in range of local scope positions. Use S as trigger statement
1440/// for destructors.
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001441void CFGBuilder::addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001442 LocalScope::const_iterator E, Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001443 if (!BuildOpts.AddImplicitDtors)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001444 return;
1445
Marcin Swiderski5e415732010-09-30 23:05:00 +00001446 if (B == E)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001447 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001448
Chandler Carruthad747252011-09-13 06:09:01 +00001449 // We need to append the destructors in reverse order, but any one of them
1450 // may be a no-return destructor which changes the CFG. As a result, buffer
1451 // this sequence up and replay them in reverse order when appending onto the
1452 // CFGBlock(s).
1453 SmallVector<VarDecl*, 10> Decls;
1454 Decls.reserve(B.distance(E));
1455 for (LocalScope::const_iterator I = B; I != E; ++I)
1456 Decls.push_back(*I);
1457
1458 for (SmallVectorImpl<VarDecl*>::reverse_iterator I = Decls.rbegin(),
1459 E = Decls.rend();
1460 I != E; ++I) {
1461 // If this destructor is marked as a no-return destructor, we need to
1462 // create a new block for the destructor which does not have as a successor
1463 // anything built thus far: control won't flow out of this block.
Ted Kremenek3d617732012-07-18 04:57:57 +00001464 QualType Ty = (*I)->getType();
1465 if (Ty->isReferenceType()) {
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001466 Ty = getReferenceInitTemporaryType(*Context, (*I)->getInit());
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001467 }
Ted Kremenek3d617732012-07-18 04:57:57 +00001468 Ty = Context->getBaseElementType(Ty);
1469
Richard Trieu95a192a2015-05-28 00:14:02 +00001470 if (Ty->getAsCXXRecordDecl()->isAnyDestructorNoReturn())
Chandler Carrutha70991b2011-09-13 09:13:49 +00001471 Block = createNoReturnBlock();
1472 else
Chandler Carruthad747252011-09-13 06:09:01 +00001473 autoCreateBlock();
Chandler Carruthad747252011-09-13 06:09:01 +00001474
1475 appendAutomaticObjDtor(Block, *I, S);
1476 }
Marcin Swiderski5e415732010-09-30 23:05:00 +00001477}
1478
Marcin Swiderski20b88732010-10-05 05:37:00 +00001479/// addImplicitDtorsForDestructor - Add implicit destructors generated for
1480/// base and member objects in destructor.
1481void CFGBuilder::addImplicitDtorsForDestructor(const CXXDestructorDecl *DD) {
Eugene Zelenko38c70522017-12-07 21:55:09 +00001482 assert(BuildOpts.AddImplicitDtors &&
1483 "Can be called only when dtors should be added");
Marcin Swiderski20b88732010-10-05 05:37:00 +00001484 const CXXRecordDecl *RD = DD->getParent();
1485
1486 // At the end destroy virtual base objects.
Aaron Ballman445a9392014-03-13 16:15:17 +00001487 for (const auto &VI : RD->vbases()) {
1488 const CXXRecordDecl *CD = VI.getType()->getAsCXXRecordDecl();
Marcin Swiderski20b88732010-10-05 05:37:00 +00001489 if (!CD->hasTrivialDestructor()) {
1490 autoCreateBlock();
Aaron Ballman445a9392014-03-13 16:15:17 +00001491 appendBaseDtor(Block, &VI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001492 }
1493 }
1494
1495 // Before virtual bases destroy direct base objects.
Aaron Ballman574705e2014-03-13 15:41:46 +00001496 for (const auto &BI : RD->bases()) {
1497 if (!BI.isVirtual()) {
1498 const CXXRecordDecl *CD = BI.getType()->getAsCXXRecordDecl();
David Blaikie0f2ae782012-01-24 04:51:48 +00001499 if (!CD->hasTrivialDestructor()) {
1500 autoCreateBlock();
Aaron Ballman574705e2014-03-13 15:41:46 +00001501 appendBaseDtor(Block, &BI);
David Blaikie0f2ae782012-01-24 04:51:48 +00001502 }
1503 }
Marcin Swiderski20b88732010-10-05 05:37:00 +00001504 }
1505
1506 // First destroy member objects.
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001507 for (auto *FI : RD->fields()) {
Marcin Swiderski01769902010-10-25 07:05:54 +00001508 // Check for constant size array. Set type to array element type.
1509 QualType QT = FI->getType();
1510 if (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1511 if (AT->getSize() == 0)
1512 continue;
1513 QT = AT->getElementType();
1514 }
1515
1516 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
Marcin Swiderski20b88732010-10-05 05:37:00 +00001517 if (!CD->hasTrivialDestructor()) {
1518 autoCreateBlock();
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001519 appendMemberDtor(Block, FI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001520 }
1521 }
1522}
1523
Marcin Swiderski5e415732010-09-30 23:05:00 +00001524/// createOrReuseLocalScope - If Scope is NULL create new LocalScope. Either
1525/// way return valid LocalScope object.
1526LocalScope* CFGBuilder::createOrReuseLocalScope(LocalScope* Scope) {
David Blaikiec1334cc2015-08-13 22:12:21 +00001527 if (Scope)
1528 return Scope;
1529 llvm::BumpPtrAllocator &alloc = cfg->getAllocator();
1530 return new (alloc.Allocate<LocalScope>())
1531 LocalScope(BumpVectorContext(alloc), ScopePos);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001532}
1533
1534/// addLocalScopeForStmt - Add LocalScope to local scopes tree for statement
Zhongxing Xu81714f22010-10-01 03:00:16 +00001535/// that should create implicit scope (e.g. if/else substatements).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001536void CFGBuilder::addLocalScopeForStmt(Stmt *S) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001537 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime)
Zhongxing Xu81714f22010-10-01 03:00:16 +00001538 return;
1539
Craig Topper25542942014-05-20 04:30:07 +00001540 LocalScope *Scope = nullptr;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001541
1542 // For compound statement we will be creating explicit scope.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001543 if (CompoundStmt *CS = dyn_cast<CompoundStmt>(S)) {
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001544 for (auto *BI : CS->body()) {
1545 Stmt *SI = BI->stripLabelLikeStatements();
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001546 if (DeclStmt *DS = dyn_cast<DeclStmt>(SI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001547 Scope = addLocalScopeForDeclStmt(DS, Scope);
1548 }
Zhongxing Xu81714f22010-10-01 03:00:16 +00001549 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001550 }
1551
1552 // For any other statement scope will be implicit and as such will be
1553 // interesting only for DeclStmt.
Chandler Carrutha626d642011-09-10 00:02:34 +00001554 if (DeclStmt *DS = dyn_cast<DeclStmt>(S->stripLabelLikeStatements()))
Zhongxing Xu307701e2010-10-01 03:09:09 +00001555 addLocalScopeForDeclStmt(DS);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001556}
1557
1558/// addLocalScopeForDeclStmt - Add LocalScope for declaration statement. Will
1559/// reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001560LocalScope* CFGBuilder::addLocalScopeForDeclStmt(DeclStmt *DS,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001561 LocalScope* Scope) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001562 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime)
Marcin Swiderski5e415732010-09-30 23:05:00 +00001563 return Scope;
1564
Aaron Ballman535bbcc2014-03-14 17:01:24 +00001565 for (auto *DI : DS->decls())
1566 if (VarDecl *VD = dyn_cast<VarDecl>(DI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001567 Scope = addLocalScopeForVarDecl(VD, Scope);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001568 return Scope;
1569}
1570
Matthias Gehre351c2182017-07-12 07:04:19 +00001571bool CFGBuilder::hasTrivialDestructor(VarDecl *VD) {
1572 // Check for const references bound to temporary. Set type to pointee.
1573 QualType QT = VD->getType();
1574 if (QT.getTypePtr()->isReferenceType()) {
1575 // Attempt to determine whether this declaration lifetime-extends a
1576 // temporary.
1577 //
1578 // FIXME: This is incorrect. Non-reference declarations can lifetime-extend
1579 // temporaries, and a single declaration can extend multiple temporaries.
1580 // We should look at the storage duration on each nested
1581 // MaterializeTemporaryExpr instead.
1582
1583 const Expr *Init = VD->getInit();
1584 if (!Init)
1585 return true;
1586
1587 // Lifetime-extending a temporary.
1588 bool FoundMTE = false;
1589 QT = getReferenceInitTemporaryType(*Context, Init, &FoundMTE);
1590 if (!FoundMTE)
1591 return true;
1592 }
1593
1594 // Check for constant size array. Set type to array element type.
1595 while (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1596 if (AT->getSize() == 0)
1597 return true;
1598 QT = AT->getElementType();
1599 }
1600
1601 // Check if type is a C++ class with non-trivial destructor.
1602 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
1603 return !CD->hasDefinition() || CD->hasTrivialDestructor();
1604 return true;
1605}
1606
Marcin Swiderski5e415732010-09-30 23:05:00 +00001607/// addLocalScopeForVarDecl - Add LocalScope for variable declaration. It will
1608/// create add scope for automatic objects and temporary objects bound to
1609/// const reference. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001610LocalScope* CFGBuilder::addLocalScopeForVarDecl(VarDecl *VD,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001611 LocalScope* Scope) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001612 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1613 "AddImplicitDtors and AddLifetime cannot be used at the same time");
1614 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime)
Marcin Swiderski5e415732010-09-30 23:05:00 +00001615 return Scope;
1616
1617 // Check if variable is local.
1618 switch (VD->getStorageClass()) {
1619 case SC_None:
1620 case SC_Auto:
1621 case SC_Register:
1622 break;
1623 default: return Scope;
1624 }
1625
Matthias Gehre351c2182017-07-12 07:04:19 +00001626 if (BuildOpts.AddImplicitDtors) {
1627 if (!hasTrivialDestructor(VD)) {
Zhongxing Xu614e17d2010-10-05 08:38:06 +00001628 // Add the variable to scope
1629 Scope = createOrReuseLocalScope(Scope);
1630 Scope->addVar(VD);
1631 ScopePos = Scope->begin();
1632 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001633 return Scope;
1634 }
1635
1636 assert(BuildOpts.AddLifetime);
1637 // Add the variable to scope
1638 Scope = createOrReuseLocalScope(Scope);
1639 Scope->addVar(VD);
1640 ScopePos = Scope->begin();
Marcin Swiderski5e415732010-09-30 23:05:00 +00001641 return Scope;
1642}
1643
1644/// addLocalScopeAndDtors - For given statement add local scope for it and
1645/// add destructors that will cleanup the scope. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001646void CFGBuilder::addLocalScopeAndDtors(Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001647 LocalScope::const_iterator scopeBeginPos = ScopePos;
Zhongxing Xu81714f22010-10-01 03:00:16 +00001648 addLocalScopeForStmt(S);
Matthias Gehre351c2182017-07-12 07:04:19 +00001649 addAutomaticObjHandling(ScopePos, scopeBeginPos, S);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001650}
1651
Marcin Swiderski321a7072010-09-30 22:54:37 +00001652/// prependAutomaticObjDtorsWithTerminator - Prepend destructor CFGElements for
1653/// variables with automatic storage duration to CFGBlock's elements vector.
1654/// Elements will be prepended to physical beginning of the vector which
1655/// happens to be logical end. Use blocks terminator as statement that specifies
1656/// destructors call site.
Chandler Carruthad747252011-09-13 06:09:01 +00001657/// FIXME: This mechanism for adding automatic destructors doesn't handle
1658/// no-return destructors properly.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001659void CFGBuilder::prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +00001660 LocalScope::const_iterator B, LocalScope::const_iterator E) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001661 if (!BuildOpts.AddImplicitDtors)
1662 return;
Chandler Carruthad747252011-09-13 06:09:01 +00001663 BumpVectorContext &C = cfg->getBumpVectorContext();
1664 CFGBlock::iterator InsertPos
1665 = Blk->beginAutomaticObjDtorsInsert(Blk->end(), B.distance(E), C);
1666 for (LocalScope::const_iterator I = B; I != E; ++I)
1667 InsertPos = Blk->insertAutomaticObjDtor(InsertPos, *I,
1668 Blk->getTerminator());
Marcin Swiderski321a7072010-09-30 22:54:37 +00001669}
1670
Matthias Gehre351c2182017-07-12 07:04:19 +00001671/// prependAutomaticObjLifetimeWithTerminator - Prepend lifetime CFGElements for
1672/// variables with automatic storage duration to CFGBlock's elements vector.
1673/// Elements will be prepended to physical beginning of the vector which
1674/// happens to be logical end. Use blocks terminator as statement that specifies
1675/// where lifetime ends.
1676void CFGBuilder::prependAutomaticObjLifetimeWithTerminator(
1677 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) {
1678 if (!BuildOpts.AddLifetime)
1679 return;
1680 BumpVectorContext &C = cfg->getBumpVectorContext();
1681 CFGBlock::iterator InsertPos =
1682 Blk->beginLifetimeEndsInsert(Blk->end(), B.distance(E), C);
1683 for (LocalScope::const_iterator I = B; I != E; ++I)
1684 InsertPos = Blk->insertLifetimeEnds(InsertPos, *I, Blk->getTerminator());
1685}
Eugene Zelenko38c70522017-12-07 21:55:09 +00001686
Ted Kremenek93668002009-07-17 22:18:43 +00001687/// Visit - Walk the subtree of a statement and add extra
Mike Stump31feda52009-07-17 01:31:16 +00001688/// blocks for ternary operators, &&, and ||. We also process "," and
1689/// DeclStmts (which may contain nested control-flow).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001690CFGBlock *CFGBuilder::Visit(Stmt * S, AddStmtChoice asc) {
Ted Kremenekbc1416d2010-04-30 22:25:53 +00001691 if (!S) {
1692 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00001693 return nullptr;
Ted Kremenekbc1416d2010-04-30 22:25:53 +00001694 }
Jordy Rose17347372011-06-10 08:49:37 +00001695
1696 if (Expr *E = dyn_cast<Expr>(S))
1697 S = E->IgnoreParens();
1698
Ted Kremenek93668002009-07-17 22:18:43 +00001699 switch (S->getStmtClass()) {
1700 default:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001701 return VisitStmt(S, asc);
Ted Kremenek93668002009-07-17 22:18:43 +00001702
1703 case Stmt::AddrLabelExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001704 return VisitAddrLabelExpr(cast<AddrLabelExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001705
John McCallc07a0c72011-02-17 10:25:35 +00001706 case Stmt::BinaryConditionalOperatorClass:
1707 return VisitConditionalOperator(cast<BinaryConditionalOperator>(S), asc);
1708
Ted Kremenek93668002009-07-17 22:18:43 +00001709 case Stmt::BinaryOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001710 return VisitBinaryOperator(cast<BinaryOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001711
Ted Kremenek93668002009-07-17 22:18:43 +00001712 case Stmt::BlockExprClass:
Devin Coughlinb6029b72015-11-25 22:35:37 +00001713 return VisitBlockExpr(cast<BlockExpr>(S), asc);
Ted Kremenek93668002009-07-17 22:18:43 +00001714
Ted Kremenek93668002009-07-17 22:18:43 +00001715 case Stmt::BreakStmtClass:
1716 return VisitBreakStmt(cast<BreakStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001717
Ted Kremenek93668002009-07-17 22:18:43 +00001718 case Stmt::CallExprClass:
Ted Kremenek128d04d2010-08-31 18:47:34 +00001719 case Stmt::CXXOperatorCallExprClass:
John McCallc67067f2011-05-11 07:19:11 +00001720 case Stmt::CXXMemberCallExprClass:
Richard Smithc67fdd42012-03-07 08:35:16 +00001721 case Stmt::UserDefinedLiteralClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001722 return VisitCallExpr(cast<CallExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001723
Ted Kremenek93668002009-07-17 22:18:43 +00001724 case Stmt::CaseStmtClass:
1725 return VisitCaseStmt(cast<CaseStmt>(S));
1726
1727 case Stmt::ChooseExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001728 return VisitChooseExpr(cast<ChooseExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001729
Ted Kremenek93668002009-07-17 22:18:43 +00001730 case Stmt::CompoundStmtClass:
1731 return VisitCompoundStmt(cast<CompoundStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001732
Ted Kremenek93668002009-07-17 22:18:43 +00001733 case Stmt::ConditionalOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001734 return VisitConditionalOperator(cast<ConditionalOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001735
Ted Kremenek93668002009-07-17 22:18:43 +00001736 case Stmt::ContinueStmtClass:
1737 return VisitContinueStmt(cast<ContinueStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001738
Ted Kremenekb27378c2010-01-19 20:40:33 +00001739 case Stmt::CXXCatchStmtClass:
1740 return VisitCXXCatchStmt(cast<CXXCatchStmt>(S));
1741
John McCall5d413782010-12-06 08:20:24 +00001742 case Stmt::ExprWithCleanupsClass:
1743 return VisitExprWithCleanups(cast<ExprWithCleanups>(S), asc);
Ted Kremenek82bfc862010-08-28 00:19:02 +00001744
Jordan Rosee5d53932012-08-23 18:10:53 +00001745 case Stmt::CXXDefaultArgExprClass:
Richard Smith852c9db2013-04-20 22:23:05 +00001746 case Stmt::CXXDefaultInitExprClass:
Jordan Rosee5d53932012-08-23 18:10:53 +00001747 // FIXME: The expression inside a CXXDefaultArgExpr is owned by the
1748 // called function's declaration, not by the caller. If we simply add
1749 // this expression to the CFG, we could end up with the same Expr
1750 // appearing multiple times.
1751 // PR13385 / <rdar://problem/12156507>
Richard Smith852c9db2013-04-20 22:23:05 +00001752 //
1753 // It's likewise possible for multiple CXXDefaultInitExprs for the same
1754 // expression to be used in the same function (through aggregate
1755 // initialization).
Jordan Rosee5d53932012-08-23 18:10:53 +00001756 return VisitStmt(S, asc);
1757
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00001758 case Stmt::CXXBindTemporaryExprClass:
1759 return VisitCXXBindTemporaryExpr(cast<CXXBindTemporaryExpr>(S), asc);
1760
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00001761 case Stmt::CXXConstructExprClass:
1762 return VisitCXXConstructExpr(cast<CXXConstructExpr>(S), asc);
1763
Jordan Rosec9176072014-01-13 17:59:19 +00001764 case Stmt::CXXNewExprClass:
1765 return VisitCXXNewExpr(cast<CXXNewExpr>(S), asc);
1766
Jordan Rosed2f40792013-09-03 17:00:57 +00001767 case Stmt::CXXDeleteExprClass:
1768 return VisitCXXDeleteExpr(cast<CXXDeleteExpr>(S), asc);
1769
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00001770 case Stmt::CXXFunctionalCastExprClass:
1771 return VisitCXXFunctionalCastExpr(cast<CXXFunctionalCastExpr>(S), asc);
1772
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00001773 case Stmt::CXXTemporaryObjectExprClass:
1774 return VisitCXXTemporaryObjectExpr(cast<CXXTemporaryObjectExpr>(S), asc);
1775
Ted Kremenekb27378c2010-01-19 20:40:33 +00001776 case Stmt::CXXThrowExprClass:
1777 return VisitCXXThrowExpr(cast<CXXThrowExpr>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00001778
Ted Kremenekb27378c2010-01-19 20:40:33 +00001779 case Stmt::CXXTryStmtClass:
1780 return VisitCXXTryStmt(cast<CXXTryStmt>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00001781
Richard Smith02e85f32011-04-14 22:09:26 +00001782 case Stmt::CXXForRangeStmtClass:
1783 return VisitCXXForRangeStmt(cast<CXXForRangeStmt>(S));
1784
Ted Kremenek93668002009-07-17 22:18:43 +00001785 case Stmt::DeclStmtClass:
1786 return VisitDeclStmt(cast<DeclStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001787
Ted Kremenek93668002009-07-17 22:18:43 +00001788 case Stmt::DefaultStmtClass:
1789 return VisitDefaultStmt(cast<DefaultStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001790
Ted Kremenek93668002009-07-17 22:18:43 +00001791 case Stmt::DoStmtClass:
1792 return VisitDoStmt(cast<DoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001793
Ted Kremenek93668002009-07-17 22:18:43 +00001794 case Stmt::ForStmtClass:
1795 return VisitForStmt(cast<ForStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001796
Ted Kremenek93668002009-07-17 22:18:43 +00001797 case Stmt::GotoStmtClass:
1798 return VisitGotoStmt(cast<GotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001799
Ted Kremenek93668002009-07-17 22:18:43 +00001800 case Stmt::IfStmtClass:
1801 return VisitIfStmt(cast<IfStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001802
Ted Kremenek8219b822010-12-16 07:46:53 +00001803 case Stmt::ImplicitCastExprClass:
1804 return VisitImplicitCastExpr(cast<ImplicitCastExpr>(S), asc);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00001805
Ted Kremenek93668002009-07-17 22:18:43 +00001806 case Stmt::IndirectGotoStmtClass:
1807 return VisitIndirectGotoStmt(cast<IndirectGotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001808
Ted Kremenek93668002009-07-17 22:18:43 +00001809 case Stmt::LabelStmtClass:
1810 return VisitLabelStmt(cast<LabelStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001811
Ted Kremenekda76a942012-04-12 20:34:52 +00001812 case Stmt::LambdaExprClass:
1813 return VisitLambdaExpr(cast<LambdaExpr>(S), asc);
1814
Ted Kremenek5868ec62010-04-11 17:02:10 +00001815 case Stmt::MemberExprClass:
1816 return VisitMemberExpr(cast<MemberExpr>(S), asc);
1817
Ted Kremenek04268232011-11-05 00:10:15 +00001818 case Stmt::NullStmtClass:
1819 return Block;
1820
Ted Kremenek93668002009-07-17 22:18:43 +00001821 case Stmt::ObjCAtCatchStmtClass:
Mike Stump11289f42009-09-09 15:08:12 +00001822 return VisitObjCAtCatchStmt(cast<ObjCAtCatchStmt>(S));
1823
Ted Kremenek5022f1d2012-03-06 23:40:47 +00001824 case Stmt::ObjCAutoreleasePoolStmtClass:
1825 return VisitObjCAutoreleasePoolStmt(cast<ObjCAutoreleasePoolStmt>(S));
1826
Ted Kremenek93668002009-07-17 22:18:43 +00001827 case Stmt::ObjCAtSynchronizedStmtClass:
1828 return VisitObjCAtSynchronizedStmt(cast<ObjCAtSynchronizedStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001829
Ted Kremenek93668002009-07-17 22:18:43 +00001830 case Stmt::ObjCAtThrowStmtClass:
1831 return VisitObjCAtThrowStmt(cast<ObjCAtThrowStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001832
Ted Kremenek93668002009-07-17 22:18:43 +00001833 case Stmt::ObjCAtTryStmtClass:
1834 return VisitObjCAtTryStmt(cast<ObjCAtTryStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001835
Ted Kremenek93668002009-07-17 22:18:43 +00001836 case Stmt::ObjCForCollectionStmtClass:
1837 return VisitObjCForCollectionStmt(cast<ObjCForCollectionStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001838
Ted Kremenek04268232011-11-05 00:10:15 +00001839 case Stmt::OpaqueValueExprClass:
Ted Kremenek93668002009-07-17 22:18:43 +00001840 return Block;
Mike Stump11289f42009-09-09 15:08:12 +00001841
John McCallfe96e0b2011-11-06 09:01:30 +00001842 case Stmt::PseudoObjectExprClass:
1843 return VisitPseudoObjectExpr(cast<PseudoObjectExpr>(S));
1844
Ted Kremenek93668002009-07-17 22:18:43 +00001845 case Stmt::ReturnStmtClass:
1846 return VisitReturnStmt(cast<ReturnStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001847
Nico Weber699670e2017-08-23 15:33:16 +00001848 case Stmt::SEHExceptStmtClass:
1849 return VisitSEHExceptStmt(cast<SEHExceptStmt>(S));
1850
1851 case Stmt::SEHFinallyStmtClass:
1852 return VisitSEHFinallyStmt(cast<SEHFinallyStmt>(S));
1853
1854 case Stmt::SEHLeaveStmtClass:
1855 return VisitSEHLeaveStmt(cast<SEHLeaveStmt>(S));
1856
1857 case Stmt::SEHTryStmtClass:
1858 return VisitSEHTryStmt(cast<SEHTryStmt>(S));
1859
Peter Collingbournee190dee2011-03-11 19:24:49 +00001860 case Stmt::UnaryExprOrTypeTraitExprClass:
1861 return VisitUnaryExprOrTypeTraitExpr(cast<UnaryExprOrTypeTraitExpr>(S),
1862 asc);
Mike Stump11289f42009-09-09 15:08:12 +00001863
Ted Kremenek93668002009-07-17 22:18:43 +00001864 case Stmt::StmtExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001865 return VisitStmtExpr(cast<StmtExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00001866
Ted Kremenek93668002009-07-17 22:18:43 +00001867 case Stmt::SwitchStmtClass:
1868 return VisitSwitchStmt(cast<SwitchStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00001869
Zhanyong Wan6dace612010-11-22 08:45:56 +00001870 case Stmt::UnaryOperatorClass:
1871 return VisitUnaryOperator(cast<UnaryOperator>(S), asc);
1872
Ted Kremenek93668002009-07-17 22:18:43 +00001873 case Stmt::WhileStmtClass:
1874 return VisitWhileStmt(cast<WhileStmt>(S));
1875 }
1876}
Mike Stump11289f42009-09-09 15:08:12 +00001877
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001878CFGBlock *CFGBuilder::VisitStmt(Stmt *S, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00001879 if (asc.alwaysAdd(*this, S)) {
Ted Kremenek93668002009-07-17 22:18:43 +00001880 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001881 appendStmt(Block, S);
Mike Stump31feda52009-07-17 01:31:16 +00001882 }
Mike Stump11289f42009-09-09 15:08:12 +00001883
Ted Kremenek93668002009-07-17 22:18:43 +00001884 return VisitChildren(S);
Ted Kremenek9e248872007-08-27 21:27:44 +00001885}
Mike Stump31feda52009-07-17 01:31:16 +00001886
Ted Kremenek93668002009-07-17 22:18:43 +00001887/// VisitChildren - Visit the children of a Stmt.
Ted Kremenek8ae67872013-02-05 22:00:19 +00001888CFGBlock *CFGBuilder::VisitChildren(Stmt *S) {
1889 CFGBlock *B = Block;
Ted Kremenek828f6312011-02-21 22:11:26 +00001890
Ted Kremenek8ae67872013-02-05 22:00:19 +00001891 // Visit the children in their reverse order so that they appear in
1892 // left-to-right (natural) order in the CFG.
1893 reverse_children RChildren(S);
1894 for (reverse_children::iterator I = RChildren.begin(), E = RChildren.end();
1895 I != E; ++I) {
1896 if (Stmt *Child = *I)
1897 if (CFGBlock *R = Visit(Child))
1898 B = R;
1899 }
1900 return B;
Ted Kremenek9e248872007-08-27 21:27:44 +00001901}
Mike Stump11289f42009-09-09 15:08:12 +00001902
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00001903CFGBlock *CFGBuilder::VisitAddrLabelExpr(AddrLabelExpr *A,
1904 AddStmtChoice asc) {
Ted Kremenek93668002009-07-17 22:18:43 +00001905 AddressTakenLabels.insert(A->getLabel());
Ted Kremenek9e248872007-08-27 21:27:44 +00001906
Ted Kremenek7c58d352011-03-10 01:14:11 +00001907 if (asc.alwaysAdd(*this, A)) {
Ted Kremenek93668002009-07-17 22:18:43 +00001908 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001909 appendStmt(Block, A);
Ted Kremenek93668002009-07-17 22:18:43 +00001910 }
Ted Kremenek81e14852007-08-27 19:46:09 +00001911
Ted Kremenek9aae5132007-08-23 21:42:29 +00001912 return Block;
1913}
Mike Stump11289f42009-09-09 15:08:12 +00001914
Zhanyong Wan6dace612010-11-22 08:45:56 +00001915CFGBlock *CFGBuilder::VisitUnaryOperator(UnaryOperator *U,
Ted Kremenek8219b822010-12-16 07:46:53 +00001916 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00001917 if (asc.alwaysAdd(*this, U)) {
Zhanyong Wan6dace612010-11-22 08:45:56 +00001918 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00001919 appendStmt(Block, U);
Zhanyong Wan6dace612010-11-22 08:45:56 +00001920 }
1921
Ted Kremenek8219b822010-12-16 07:46:53 +00001922 return Visit(U->getSubExpr(), AddStmtChoice());
Zhanyong Wan6dace612010-11-22 08:45:56 +00001923}
1924
Ted Kremeneka16436f2012-07-14 05:04:06 +00001925CFGBlock *CFGBuilder::VisitLogicalOperator(BinaryOperator *B) {
1926 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
1927 appendStmt(ConfluenceBlock, B);
Mike Stump11289f42009-09-09 15:08:12 +00001928
Ted Kremeneka16436f2012-07-14 05:04:06 +00001929 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001930 return nullptr;
Ted Kremeneka16436f2012-07-14 05:04:06 +00001931
Craig Topper25542942014-05-20 04:30:07 +00001932 return VisitLogicalOperator(B, nullptr, ConfluenceBlock,
1933 ConfluenceBlock).first;
Ted Kremenekb50e7162012-07-14 05:04:10 +00001934}
1935
1936std::pair<CFGBlock*, CFGBlock*>
1937CFGBuilder::VisitLogicalOperator(BinaryOperator *B,
1938 Stmt *Term,
1939 CFGBlock *TrueBlock,
1940 CFGBlock *FalseBlock) {
Ted Kremenekb50e7162012-07-14 05:04:10 +00001941 // Introspect the RHS. If it is a nested logical operation, we recursively
1942 // build the CFG using this function. Otherwise, resort to default
1943 // CFG construction behavior.
1944 Expr *RHS = B->getRHS()->IgnoreParens();
1945 CFGBlock *RHSBlock, *ExitBlock;
1946
1947 do {
1948 if (BinaryOperator *B_RHS = dyn_cast<BinaryOperator>(RHS))
1949 if (B_RHS->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001950 std::tie(RHSBlock, ExitBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00001951 VisitLogicalOperator(B_RHS, Term, TrueBlock, FalseBlock);
1952 break;
1953 }
1954
1955 // The RHS is not a nested logical operation. Don't push the terminator
1956 // down further, but instead visit RHS and construct the respective
1957 // pieces of the CFG, and link up the RHSBlock with the terminator
1958 // we have been provided.
1959 ExitBlock = RHSBlock = createBlock(false);
1960
Richard Trieu6a6af522017-01-04 00:46:30 +00001961 // Even though KnownVal is only used in the else branch of the next
1962 // conditional, tryEvaluateBool performs additional checking on the
1963 // Expr, so it should be called unconditionally.
1964 TryResult KnownVal = tryEvaluateBool(RHS);
1965 if (!KnownVal.isKnown())
1966 KnownVal = tryEvaluateBool(B);
1967
Ted Kremenekb50e7162012-07-14 05:04:10 +00001968 if (!Term) {
1969 assert(TrueBlock == FalseBlock);
1970 addSuccessor(RHSBlock, TrueBlock);
1971 }
1972 else {
1973 RHSBlock->setTerminator(Term);
Ted Kremenek782f0032014-03-07 02:25:53 +00001974 addSuccessor(RHSBlock, TrueBlock, !KnownVal.isFalse());
1975 addSuccessor(RHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremenekb50e7162012-07-14 05:04:10 +00001976 }
1977
1978 Block = RHSBlock;
1979 RHSBlock = addStmt(RHS);
1980 }
1981 while (false);
1982
1983 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001984 return std::make_pair(nullptr, nullptr);
Ted Kremenekb50e7162012-07-14 05:04:10 +00001985
1986 // Generate the blocks for evaluating the LHS.
1987 Expr *LHS = B->getLHS()->IgnoreParens();
1988
1989 if (BinaryOperator *B_LHS = dyn_cast<BinaryOperator>(LHS))
1990 if (B_LHS->isLogicalOp()) {
1991 if (B->getOpcode() == BO_LOr)
1992 FalseBlock = RHSBlock;
1993 else
1994 TrueBlock = RHSBlock;
1995
1996 // For the LHS, treat 'B' as the terminator that we want to sink
1997 // into the nested branch. The RHS always gets the top-most
1998 // terminator.
1999 return VisitLogicalOperator(B_LHS, B, TrueBlock, FalseBlock);
2000 }
2001
2002 // Create the block evaluating the LHS.
2003 // This contains the '&&' or '||' as the terminator.
Ted Kremeneka16436f2012-07-14 05:04:06 +00002004 CFGBlock *LHSBlock = createBlock(false);
2005 LHSBlock->setTerminator(B);
2006
Ted Kremeneka16436f2012-07-14 05:04:06 +00002007 Block = LHSBlock;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002008 CFGBlock *EntryLHSBlock = addStmt(LHS);
2009
2010 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002011 return std::make_pair(nullptr, nullptr);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002012
2013 // See if this is a known constant.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002014 TryResult KnownVal = tryEvaluateBool(LHS);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002015
2016 // Now link the LHSBlock with RHSBlock.
2017 if (B->getOpcode() == BO_LOr) {
Ted Kremenek782f0032014-03-07 02:25:53 +00002018 addSuccessor(LHSBlock, TrueBlock, !KnownVal.isFalse());
2019 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002020 } else {
2021 assert(B->getOpcode() == BO_LAnd);
Ted Kremenek782f0032014-03-07 02:25:53 +00002022 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isFalse());
2023 addSuccessor(LHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002024 }
2025
Ted Kremenekb50e7162012-07-14 05:04:10 +00002026 return std::make_pair(EntryLHSBlock, ExitBlock);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002027}
2028
2029CFGBlock *CFGBuilder::VisitBinaryOperator(BinaryOperator *B,
2030 AddStmtChoice asc) {
2031 // && or ||
2032 if (B->isLogicalOp())
2033 return VisitLogicalOperator(B);
2034
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002035 if (B->getOpcode() == BO_Comma) { // ,
Ted Kremenekfe9b7682009-07-17 22:57:50 +00002036 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002037 appendStmt(Block, B);
Ted Kremenek93668002009-07-17 22:18:43 +00002038 addStmt(B->getRHS());
2039 return addStmt(B->getLHS());
2040 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002041
2042 if (B->isAssignmentOp()) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002043 if (asc.alwaysAdd(*this, B)) {
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002044 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002045 appendStmt(Block, B);
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002046 }
Ted Kremenek8219b822010-12-16 07:46:53 +00002047 Visit(B->getLHS());
Marcin Swiderski77232492010-10-24 08:21:40 +00002048 return Visit(B->getRHS());
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002049 }
Mike Stump11289f42009-09-09 15:08:12 +00002050
Ted Kremenek7c58d352011-03-10 01:14:11 +00002051 if (asc.alwaysAdd(*this, B)) {
Marcin Swiderski77232492010-10-24 08:21:40 +00002052 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002053 appendStmt(Block, B);
Marcin Swiderski77232492010-10-24 08:21:40 +00002054 }
2055
Zhongxing Xud95ccd52010-10-27 03:23:10 +00002056 CFGBlock *RBlock = Visit(B->getRHS());
2057 CFGBlock *LBlock = Visit(B->getLHS());
2058 // If visiting RHS causes us to finish 'Block', e.g. the RHS is a StmtExpr
2059 // containing a DoStmt, and the LHS doesn't create a new block, then we should
2060 // return RBlock. Otherwise we'll incorrectly return NULL.
2061 return (LBlock ? LBlock : RBlock);
Ted Kremenek93668002009-07-17 22:18:43 +00002062}
2063
Ted Kremeneke2499842012-04-12 20:03:44 +00002064CFGBlock *CFGBuilder::VisitNoRecurse(Expr *E, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002065 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek470bfa42009-11-25 01:34:30 +00002066 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002067 appendStmt(Block, E);
Ted Kremenek470bfa42009-11-25 01:34:30 +00002068 }
2069 return Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002070}
2071
Ted Kremenek93668002009-07-17 22:18:43 +00002072CFGBlock *CFGBuilder::VisitBreakStmt(BreakStmt *B) {
2073 // "break" is a control-flow statement. Thus we stop processing the current
2074 // block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002075 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002076 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002077
Ted Kremenek93668002009-07-17 22:18:43 +00002078 // Now create a new block that ends with the break statement.
2079 Block = createBlock(false);
2080 Block->setTerminator(B);
Mike Stump11289f42009-09-09 15:08:12 +00002081
Ted Kremenek93668002009-07-17 22:18:43 +00002082 // If there is no target for the break, then we are looking at an incomplete
2083 // AST. This means that the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002084 if (BreakJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00002085 addAutomaticObjHandling(ScopePos, BreakJumpTarget.scopePosition, B);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002086 addSuccessor(Block, BreakJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002087 } else
Ted Kremenek93668002009-07-17 22:18:43 +00002088 badCFG = true;
Mike Stump11289f42009-09-09 15:08:12 +00002089
Ted Kremenek9aae5132007-08-23 21:42:29 +00002090 return Block;
2091}
Mike Stump11289f42009-09-09 15:08:12 +00002092
Sebastian Redl31ad7542011-03-13 17:09:40 +00002093static bool CanThrow(Expr *E, ASTContext &Ctx) {
Mike Stump04c68512010-01-21 15:20:48 +00002094 QualType Ty = E->getType();
2095 if (Ty->isFunctionPointerType())
2096 Ty = Ty->getAs<PointerType>()->getPointeeType();
2097 else if (Ty->isBlockPointerType())
2098 Ty = Ty->getAs<BlockPointerType>()->getPointeeType();
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002099
Mike Stump04c68512010-01-21 15:20:48 +00002100 const FunctionType *FT = Ty->getAs<FunctionType>();
2101 if (FT) {
2102 if (const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(FT))
Richard Smithd3b5c9082012-07-27 04:22:15 +00002103 if (!isUnresolvedExceptionSpec(Proto->getExceptionSpecType()) &&
Richard Smithf623c962012-04-17 00:58:00 +00002104 Proto->isNothrow(Ctx))
Mike Stump04c68512010-01-21 15:20:48 +00002105 return false;
2106 }
2107 return true;
2108}
2109
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002110CFGBlock *CFGBuilder::VisitCallExpr(CallExpr *C, AddStmtChoice asc) {
John McCallc67067f2011-05-11 07:19:11 +00002111 // Compute the callee type.
2112 QualType calleeType = C->getCallee()->getType();
2113 if (calleeType == Context->BoundMemberTy) {
2114 QualType boundType = Expr::findBoundMemberType(C->getCallee());
2115
2116 // We should only get a null bound type if processing a dependent
2117 // CFG. Recover by assuming nothing.
2118 if (!boundType.isNull()) calleeType = boundType;
Ted Kremenek93668002009-07-17 22:18:43 +00002119 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002120
John McCallc67067f2011-05-11 07:19:11 +00002121 // If this is a call to a no-return function, this stops the block here.
2122 bool NoReturn = getFunctionExtInfo(*calleeType).getNoReturn();
2123
Mike Stump04c68512010-01-21 15:20:48 +00002124 bool AddEHEdge = false;
Mike Stump92244b02010-01-19 22:00:14 +00002125
2126 // Languages without exceptions are assumed to not throw.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002127 if (Context->getLangOpts().Exceptions) {
Ted Kremeneke97b1eb2010-09-14 23:41:16 +00002128 if (BuildOpts.AddEHEdges)
Mike Stump04c68512010-01-21 15:20:48 +00002129 AddEHEdge = true;
Mike Stump92244b02010-01-19 22:00:14 +00002130 }
2131
Jordan Rose5374c072013-08-19 16:27:28 +00002132 // If this is a call to a builtin function, it might not actually evaluate
2133 // its arguments. Don't add them to the CFG if this is the case.
2134 bool OmitArguments = false;
2135
Mike Stump92244b02010-01-19 22:00:14 +00002136 if (FunctionDecl *FD = C->getDirectCallee()) {
Richard Smith10876ef2013-01-17 01:30:42 +00002137 if (FD->isNoReturn())
Mike Stump8c5d7992009-07-25 21:26:53 +00002138 NoReturn = true;
Mike Stump92244b02010-01-19 22:00:14 +00002139 if (FD->hasAttr<NoThrowAttr>())
Mike Stump04c68512010-01-21 15:20:48 +00002140 AddEHEdge = false;
Jordan Rose5374c072013-08-19 16:27:28 +00002141 if (FD->getBuiltinID() == Builtin::BI__builtin_object_size)
2142 OmitArguments = true;
Mike Stump92244b02010-01-19 22:00:14 +00002143 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002144
Sebastian Redl31ad7542011-03-13 17:09:40 +00002145 if (!CanThrow(C->getCallee(), *Context))
Mike Stump04c68512010-01-21 15:20:48 +00002146 AddEHEdge = false;
2147
Jordan Rose5374c072013-08-19 16:27:28 +00002148 if (OmitArguments) {
2149 assert(!NoReturn && "noreturn calls with unevaluated args not implemented");
2150 assert(!AddEHEdge && "EH calls with unevaluated args not implemented");
2151 autoCreateBlock();
2152 appendStmt(Block, C);
2153 return Visit(C->getCallee());
2154 }
2155
2156 if (!NoReturn && !AddEHEdge) {
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002157 return VisitStmt(C, asc.withAlwaysAdd(true));
Jordan Rose5374c072013-08-19 16:27:28 +00002158 }
Mike Stump11289f42009-09-09 15:08:12 +00002159
Mike Stump92244b02010-01-19 22:00:14 +00002160 if (Block) {
2161 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002162 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002163 return nullptr;
Mike Stump92244b02010-01-19 22:00:14 +00002164 }
Mike Stump11289f42009-09-09 15:08:12 +00002165
Chandler Carrutha70991b2011-09-13 09:13:49 +00002166 if (NoReturn)
2167 Block = createNoReturnBlock();
2168 else
2169 Block = createBlock();
2170
Ted Kremenek2866bab2011-03-10 01:14:08 +00002171 appendStmt(Block, C);
Mike Stump8c5d7992009-07-25 21:26:53 +00002172
Mike Stump04c68512010-01-21 15:20:48 +00002173 if (AddEHEdge) {
Mike Stump92244b02010-01-19 22:00:14 +00002174 // Add exceptional edges.
2175 if (TryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002176 addSuccessor(Block, TryTerminatedBlock);
Mike Stump92244b02010-01-19 22:00:14 +00002177 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002178 addSuccessor(Block, &cfg->getExit());
Mike Stump92244b02010-01-19 22:00:14 +00002179 }
Mike Stump11289f42009-09-09 15:08:12 +00002180
Mike Stump8c5d7992009-07-25 21:26:53 +00002181 return VisitChildren(C);
Ted Kremenek93668002009-07-17 22:18:43 +00002182}
Ted Kremenek9aae5132007-08-23 21:42:29 +00002183
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002184CFGBlock *CFGBuilder::VisitChooseExpr(ChooseExpr *C,
2185 AddStmtChoice asc) {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002186 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002187 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002188 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002189 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002190
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002191 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek21822592009-07-17 18:20:32 +00002192 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002193 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002194 CFGBlock *LHSBlock = Visit(C->getLHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002195 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002196 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002197
Ted Kremenek21822592009-07-17 18:20:32 +00002198 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002199 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002200 CFGBlock *RHSBlock = Visit(C->getRHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002201 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002202 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002203
Ted Kremenek21822592009-07-17 18:20:32 +00002204 Block = createBlock(false);
Mike Stump773582d2009-07-23 23:25:26 +00002205 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002206 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Craig Topper25542942014-05-20 04:30:07 +00002207 addSuccessor(Block, KnownVal.isFalse() ? nullptr : LHSBlock);
2208 addSuccessor(Block, KnownVal.isTrue() ? nullptr : RHSBlock);
Ted Kremenek21822592009-07-17 18:20:32 +00002209 Block->setTerminator(C);
Mike Stump11289f42009-09-09 15:08:12 +00002210 return addStmt(C->getCond());
Ted Kremenek21822592009-07-17 18:20:32 +00002211}
Mike Stump11289f42009-09-09 15:08:12 +00002212
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002213CFGBlock *CFGBuilder::VisitCompoundStmt(CompoundStmt *C) {
Matthias Gehre09a134e2015-11-14 00:36:50 +00002214 LocalScope::const_iterator scopeBeginPos = ScopePos;
Matthias Gehre351c2182017-07-12 07:04:19 +00002215 addLocalScopeForStmt(C);
2216
Matthias Gehre09a134e2015-11-14 00:36:50 +00002217 if (!C->body_empty() && !isa<ReturnStmt>(*C->body_rbegin())) {
Richard Smitha547eb22016-07-14 00:11:03 +00002218 // If the body ends with a ReturnStmt, the dtors will be added in
2219 // VisitReturnStmt.
Matthias Gehre351c2182017-07-12 07:04:19 +00002220 addAutomaticObjHandling(ScopePos, scopeBeginPos, C);
Matthias Gehre09a134e2015-11-14 00:36:50 +00002221 }
2222
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002223 CFGBlock *LastBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002224
2225 for (CompoundStmt::reverse_body_iterator I=C->body_rbegin(), E=C->body_rend();
2226 I != E; ++I ) {
Ted Kremenek4f2ab5a2010-08-17 21:00:06 +00002227 // If we hit a segment of code just containing ';' (NullStmts), we can
2228 // get a null block back. In such cases, just use the LastBlock
2229 if (CFGBlock *newBlock = addStmt(*I))
2230 LastBlock = newBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002231
Ted Kremenekce499c22009-08-27 23:16:26 +00002232 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002233 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002234 }
Mike Stump92244b02010-01-19 22:00:14 +00002235
Ted Kremenek93668002009-07-17 22:18:43 +00002236 return LastBlock;
2237}
Mike Stump11289f42009-09-09 15:08:12 +00002238
John McCallc07a0c72011-02-17 10:25:35 +00002239CFGBlock *CFGBuilder::VisitConditionalOperator(AbstractConditionalOperator *C,
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002240 AddStmtChoice asc) {
John McCallc07a0c72011-02-17 10:25:35 +00002241 const BinaryConditionalOperator *BCO = dyn_cast<BinaryConditionalOperator>(C);
Craig Topper25542942014-05-20 04:30:07 +00002242 const OpaqueValueExpr *opaqueValue = (BCO ? BCO->getOpaqueValue() : nullptr);
John McCallc07a0c72011-02-17 10:25:35 +00002243
Ted Kremenek51d40b02009-07-17 18:15:54 +00002244 // Create the confluence block that will "merge" the results of the ternary
2245 // expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002246 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002247 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002248 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002249 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002250
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002251 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek5868ec62010-04-11 17:02:10 +00002252
Ted Kremenek51d40b02009-07-17 18:15:54 +00002253 // Create a block for the LHS expression if there is an LHS expression. A
2254 // GCC extension allows LHS to be NULL, causing the condition to be the
2255 // value that is returned instead.
2256 // e.g: x ?: y is shorthand for: x ? x : y;
2257 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002258 Block = nullptr;
2259 CFGBlock *LHSBlock = nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00002260 const Expr *trueExpr = C->getTrueExpr();
2261 if (trueExpr != opaqueValue) {
2262 LHSBlock = Visit(C->getTrueExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002263 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002264 return nullptr;
2265 Block = nullptr;
Ted Kremenek51d40b02009-07-17 18:15:54 +00002266 }
Ted Kremenekd8138012011-02-24 03:09:15 +00002267 else
2268 LHSBlock = ConfluenceBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002269
Ted Kremenek51d40b02009-07-17 18:15:54 +00002270 // Create the block for the RHS expression.
2271 Succ = ConfluenceBlock;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002272 CFGBlock *RHSBlock = Visit(C->getFalseExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002273 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002274 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002275
Richard Smithf676e452012-07-24 21:02:14 +00002276 // If the condition is a logical '&&' or '||', build a more accurate CFG.
2277 if (BinaryOperator *Cond =
2278 dyn_cast<BinaryOperator>(C->getCond()->IgnoreParens()))
2279 if (Cond->isLogicalOp())
2280 return VisitLogicalOperator(Cond, C, LHSBlock, RHSBlock).first;
2281
Ted Kremenek51d40b02009-07-17 18:15:54 +00002282 // Create the block that will contain the condition.
2283 Block = createBlock(false);
Mike Stump11289f42009-09-09 15:08:12 +00002284
Mike Stump773582d2009-07-23 23:25:26 +00002285 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002286 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Ted Kremenek5a095272014-03-04 21:53:26 +00002287 addSuccessor(Block, LHSBlock, !KnownVal.isFalse());
2288 addSuccessor(Block, RHSBlock, !KnownVal.isTrue());
Ted Kremenek51d40b02009-07-17 18:15:54 +00002289 Block->setTerminator(C);
John McCallc07a0c72011-02-17 10:25:35 +00002290 Expr *condExpr = C->getCond();
John McCall68cc3352011-02-19 03:13:26 +00002291
Ted Kremenekd8138012011-02-24 03:09:15 +00002292 if (opaqueValue) {
2293 // Run the condition expression if it's not trivially expressed in
2294 // terms of the opaque value (or if there is no opaque value).
2295 if (condExpr != opaqueValue)
2296 addStmt(condExpr);
John McCall68cc3352011-02-19 03:13:26 +00002297
Ted Kremenekd8138012011-02-24 03:09:15 +00002298 // Before that, run the common subexpression if there was one.
2299 // At least one of this or the above will be run.
2300 return addStmt(BCO->getCommon());
2301 }
2302
2303 return addStmt(condExpr);
Ted Kremenek51d40b02009-07-17 18:15:54 +00002304}
2305
Ted Kremenek93668002009-07-17 22:18:43 +00002306CFGBlock *CFGBuilder::VisitDeclStmt(DeclStmt *DS) {
Ted Kremenek6878c362011-05-10 18:42:15 +00002307 // Check if the Decl is for an __label__. If so, elide it from the
2308 // CFG entirely.
2309 if (isa<LabelDecl>(*DS->decl_begin()))
2310 return Block;
2311
Ted Kremenek3a601142011-05-24 20:41:31 +00002312 // This case also handles static_asserts.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002313 if (DS->isSingleDecl())
2314 return VisitDeclSubExpr(DS);
Mike Stump11289f42009-09-09 15:08:12 +00002315
Craig Topper25542942014-05-20 04:30:07 +00002316 CFGBlock *B = nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002317
Jordan Rose8c6c8a92012-07-20 18:50:48 +00002318 // Build an individual DeclStmt for each decl.
2319 for (DeclStmt::reverse_decl_iterator I = DS->decl_rbegin(),
2320 E = DS->decl_rend();
2321 I != E; ++I) {
Ted Kremenek93668002009-07-17 22:18:43 +00002322 // Get the alignment of the new DeclStmt, padding out to >=8 bytes.
Benjamin Kramerc3f89252016-10-20 14:27:22 +00002323 unsigned A = alignof(DeclStmt) < 8 ? 8 : alignof(DeclStmt);
Mike Stump11289f42009-09-09 15:08:12 +00002324
Ted Kremenek93668002009-07-17 22:18:43 +00002325 // Allocate the DeclStmt using the BumpPtrAllocator. It will get
2326 // automatically freed with the CFG.
2327 DeclGroupRef DG(*I);
2328 Decl *D = *I;
Mike Stump11289f42009-09-09 15:08:12 +00002329 void *Mem = cfg->getAllocator().Allocate(sizeof(DeclStmt), A);
Ted Kremenek93668002009-07-17 22:18:43 +00002330 DeclStmt *DSNew = new (Mem) DeclStmt(DG, D->getLocation(), GetEndLoc(D));
Jordan Rosecf10ea82013-06-06 21:53:45 +00002331 cfg->addSyntheticDeclStmt(DSNew, DS);
Mike Stump11289f42009-09-09 15:08:12 +00002332
Ted Kremenek93668002009-07-17 22:18:43 +00002333 // Append the fake DeclStmt to block.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002334 B = VisitDeclSubExpr(DSNew);
Ted Kremenek93668002009-07-17 22:18:43 +00002335 }
Mike Stump11289f42009-09-09 15:08:12 +00002336
2337 return B;
Ted Kremenek93668002009-07-17 22:18:43 +00002338}
Mike Stump11289f42009-09-09 15:08:12 +00002339
Ted Kremenek93668002009-07-17 22:18:43 +00002340/// VisitDeclSubExpr - Utility method to add block-level expressions for
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002341/// DeclStmts and initializers in them.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002342CFGBlock *CFGBuilder::VisitDeclSubExpr(DeclStmt *DS) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002343 assert(DS->isSingleDecl() && "Can handle single declarations only.");
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002344 VarDecl *VD = dyn_cast<VarDecl>(DS->getSingleDecl());
Mike Stump11289f42009-09-09 15:08:12 +00002345
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002346 if (!VD) {
Jordan Rose5250b872013-06-03 22:59:41 +00002347 // Of everything that can be declared in a DeclStmt, only VarDecls impact
2348 // runtime semantics.
Ted Kremenek93668002009-07-17 22:18:43 +00002349 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002350 }
Mike Stump11289f42009-09-09 15:08:12 +00002351
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002352 bool HasTemporaries = false;
2353
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002354 // Guard static initializers under a branch.
Craig Topper25542942014-05-20 04:30:07 +00002355 CFGBlock *blockAfterStaticInit = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002356
2357 if (BuildOpts.AddStaticInitBranches && VD->isStaticLocal()) {
2358 // For static variables, we need to create a branch to track
2359 // whether or not they are initialized.
2360 if (Block) {
2361 Succ = Block;
Craig Topper25542942014-05-20 04:30:07 +00002362 Block = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002363 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002364 return nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002365 }
2366 blockAfterStaticInit = Succ;
2367 }
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002368
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002369 // Destructors of temporaries in initialization expression should be called
2370 // after initialization finishes.
Ted Kremenek93668002009-07-17 22:18:43 +00002371 Expr *Init = VD->getInit();
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002372 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00002373 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002374
Jordan Rose6d671cc2012-09-05 22:55:23 +00002375 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002376 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00002377 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00002378 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
2379 /*BindToTemporary=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002380 }
2381 }
2382
2383 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00002384 appendStmt(Block, DS);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002385
2386 EnterConstructionContextIfNecessary(DS, Init);
2387
Ted Kremenek213d0532012-03-22 05:57:43 +00002388 // Keep track of the last non-null block, as 'Block' can be nulled out
2389 // if the initializer expression is something like a 'while' in a
2390 // statement-expression.
2391 CFGBlock *LastBlock = Block;
Mike Stump11289f42009-09-09 15:08:12 +00002392
Ted Kremenek93668002009-07-17 22:18:43 +00002393 if (Init) {
Ted Kremenek213d0532012-03-22 05:57:43 +00002394 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002395 // For expression with temporaries go directly to subexpression to omit
2396 // generating destructors for the second time.
Ted Kremenek213d0532012-03-22 05:57:43 +00002397 ExprWithCleanups *EC = cast<ExprWithCleanups>(Init);
2398 if (CFGBlock *newBlock = Visit(EC->getSubExpr()))
2399 LastBlock = newBlock;
2400 }
2401 else {
2402 if (CFGBlock *newBlock = Visit(Init))
2403 LastBlock = newBlock;
2404 }
Ted Kremenek93668002009-07-17 22:18:43 +00002405 }
Mike Stump11289f42009-09-09 15:08:12 +00002406
Ted Kremenek93668002009-07-17 22:18:43 +00002407 // If the type of VD is a VLA, then we must process its size expressions.
John McCall424cec92011-01-19 06:33:43 +00002408 for (const VariableArrayType* VA = FindVA(VD->getType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00002409 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr())) {
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002410 if (CFGBlock *newBlock = addStmt(VA->getSizeExpr()))
2411 LastBlock = newBlock;
2412 }
Mike Stump11289f42009-09-09 15:08:12 +00002413
Marcin Swiderski667ffec2010-10-01 00:23:17 +00002414 // Remove variable from local scope.
2415 if (ScopePos && VD == *ScopePos)
2416 ++ScopePos;
2417
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002418 CFGBlock *B = LastBlock;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002419 if (blockAfterStaticInit) {
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002420 Succ = B;
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002421 Block = createBlock(false);
2422 Block->setTerminator(DS);
Ted Kremenekf82d5782013-03-29 00:42:56 +00002423 addSuccessor(Block, blockAfterStaticInit);
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002424 addSuccessor(Block, B);
2425 B = Block;
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002426 }
2427
2428 return B;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002429}
2430
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002431CFGBlock *CFGBuilder::VisitIfStmt(IfStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00002432 // We may see an if statement in the middle of a basic block, or it may be the
2433 // first statement we are processing. In either case, we create a new basic
2434 // block. First, we create the blocks for the then...else statements, and
2435 // then we create the block containing the if statement. If we were in the
Ted Kremenek0868eea2009-09-24 18:45:41 +00002436 // middle of a block, we stop processing that block. That block is then the
2437 // implicit successor for the "then" and "else" clauses.
Mike Stump31feda52009-07-17 01:31:16 +00002438
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002439 // Save local scope position because in case of condition variable ScopePos
2440 // won't be restored when traversing AST.
2441 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2442
Richard Smitha547eb22016-07-14 00:11:03 +00002443 // Create local scope for C++17 if init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00002444 if (Stmt *Init = I->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00002445 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00002446
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002447 // Create local scope for possible condition variable.
2448 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00002449 if (VarDecl *VD = I->getConditionVariable())
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002450 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00002451
Matthias Gehre351c2182017-07-12 07:04:19 +00002452 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), I);
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002453
Chris Lattner57540c52011-04-15 05:22:18 +00002454 // The block we were processing is now finished. Make it the successor
Mike Stump31feda52009-07-17 01:31:16 +00002455 // block.
2456 if (Block) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002457 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002458 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002459 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002460 }
Mike Stump31feda52009-07-17 01:31:16 +00002461
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002462 // Process the false branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002463 CFGBlock *ElseBlock = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002464
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002465 if (Stmt *Else = I->getElse()) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002466 SaveAndRestore<CFGBlock*> sv(Succ);
Mike Stump31feda52009-07-17 01:31:16 +00002467
Ted Kremenek9aae5132007-08-23 21:42:29 +00002468 // NULL out Block so that the recursive call to Visit will
Mike Stump31feda52009-07-17 01:31:16 +00002469 // create a new basic block.
Craig Topper25542942014-05-20 04:30:07 +00002470 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002471
2472 // If branch is not a compound statement create implicit scope
2473 // and add destructors.
2474 if (!isa<CompoundStmt>(Else))
2475 addLocalScopeAndDtors(Else);
2476
Ted Kremenek93668002009-07-17 22:18:43 +00002477 ElseBlock = addStmt(Else);
Mike Stump31feda52009-07-17 01:31:16 +00002478
Ted Kremenekbbad8ce2007-08-30 18:13:31 +00002479 if (!ElseBlock) // Can occur when the Else body has all NullStmts.
2480 ElseBlock = sv.get();
Ted Kremenek55957a82009-05-02 00:13:27 +00002481 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002482 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002483 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002484 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002485 }
Mike Stump31feda52009-07-17 01:31:16 +00002486
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002487 // Process the true branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002488 CFGBlock *ThenBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002489 {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002490 Stmt *Then = I->getThen();
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002491 assert(Then);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002492 SaveAndRestore<CFGBlock*> sv(Succ);
Craig Topper25542942014-05-20 04:30:07 +00002493 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002494
2495 // If branch is not a compound statement create implicit scope
2496 // and add destructors.
2497 if (!isa<CompoundStmt>(Then))
2498 addLocalScopeAndDtors(Then);
2499
Ted Kremenek93668002009-07-17 22:18:43 +00002500 ThenBlock = addStmt(Then);
Mike Stump31feda52009-07-17 01:31:16 +00002501
Ted Kremenek1b379512009-04-01 03:52:47 +00002502 if (!ThenBlock) {
2503 // We can reach here if the "then" body has all NullStmts.
2504 // Create an empty block so we can distinguish between true and false
2505 // branches in path-sensitive analyses.
2506 ThenBlock = createBlock(false);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002507 addSuccessor(ThenBlock, sv.get());
Mike Stump31feda52009-07-17 01:31:16 +00002508 } else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002509 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002510 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002511 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002512 }
2513
Ted Kremenekb50e7162012-07-14 05:04:10 +00002514 // Specially handle "if (expr1 || ...)" and "if (expr1 && ...)" by
2515 // having these handle the actual control-flow jump. Note that
2516 // if we introduce a condition variable, e.g. "if (int x = exp1 || exp2)"
2517 // we resort to the old control-flow behavior. This special handling
2518 // removes infeasible paths from the control-flow graph by having the
2519 // control-flow transfer of '&&' or '||' go directly into the then/else
2520 // blocks directly.
Richard Smith509bbd12017-01-13 22:16:41 +00002521 BinaryOperator *Cond =
2522 I->getConditionVariable()
2523 ? nullptr
2524 : dyn_cast<BinaryOperator>(I->getCond()->IgnoreParens());
2525 CFGBlock *LastBlock;
2526 if (Cond && Cond->isLogicalOp())
2527 LastBlock = VisitLogicalOperator(Cond, I, ThenBlock, ElseBlock).first;
2528 else {
2529 // Now create a new block containing the if statement.
2530 Block = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002531
Richard Smith509bbd12017-01-13 22:16:41 +00002532 // Set the terminator of the new block to the If statement.
2533 Block->setTerminator(I);
Mike Stump31feda52009-07-17 01:31:16 +00002534
Richard Smith509bbd12017-01-13 22:16:41 +00002535 // See if this is a known constant.
2536 const TryResult &KnownVal = tryEvaluateBool(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002537
Richard Smith509bbd12017-01-13 22:16:41 +00002538 // Add the successors. If we know that specific branches are
2539 // unreachable, inform addSuccessor() of that knowledge.
2540 addSuccessor(Block, ThenBlock, /* isReachable = */ !KnownVal.isFalse());
2541 addSuccessor(Block, ElseBlock, /* isReachable = */ !KnownVal.isTrue());
Mike Stump773582d2009-07-23 23:25:26 +00002542
Richard Smith509bbd12017-01-13 22:16:41 +00002543 // Add the condition as the last statement in the new block. This may
2544 // create new blocks as the condition may contain control-flow. Any newly
2545 // created blocks will be pointed to be "Block".
2546 LastBlock = addStmt(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002547
Richard Smith509bbd12017-01-13 22:16:41 +00002548 // If the IfStmt contains a condition variable, add it and its
2549 // initializer to the CFG.
2550 if (const DeclStmt* DS = I->getConditionVariableDeclStmt()) {
2551 autoCreateBlock();
2552 LastBlock = addStmt(const_cast<DeclStmt *>(DS));
2553 }
Ted Kremeneka7bcbde2009-12-23 04:49:01 +00002554 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002555
Richard Smitha547eb22016-07-14 00:11:03 +00002556 // Finally, if the IfStmt contains a C++17 init-stmt, add it to the CFG.
2557 if (Stmt *Init = I->getInit()) {
2558 autoCreateBlock();
2559 LastBlock = addStmt(Init);
2560 }
2561
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002562 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002563}
Mike Stump31feda52009-07-17 01:31:16 +00002564
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002565CFGBlock *CFGBuilder::VisitReturnStmt(ReturnStmt *R) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00002566 // If we were in the middle of a block we stop processing that block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002567 //
Mike Stump31feda52009-07-17 01:31:16 +00002568 // NOTE: If a "return" appears in the middle of a block, this means that the
2569 // code afterwards is DEAD (unreachable). We still keep a basic block
2570 // for that code; a simple "mark-and-sweep" from the entry block will be
2571 // able to report such dead blocks.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002572
2573 // Create the new block.
2574 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002575
Matthias Gehre351c2182017-07-12 07:04:19 +00002576 addAutomaticObjHandling(ScopePos, LocalScope::const_iterator(), R);
Pavel Labath921e7652013-09-06 08:12:48 +00002577
Artem Dergachev9ac2e112018-02-12 22:36:36 +00002578 EnterConstructionContextIfNecessary(R, R->getRetValue());
2579
Pavel Labath921e7652013-09-06 08:12:48 +00002580 // If the one of the destructors does not return, we already have the Exit
2581 // block as a successor.
2582 if (!Block->hasNoReturnElement())
2583 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00002584
2585 // Add the return statement to the block. This may create new blocks if R
2586 // contains control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002587 return VisitStmt(R, AddStmtChoice::AlwaysAdd);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002588}
2589
Nico Weber699670e2017-08-23 15:33:16 +00002590CFGBlock *CFGBuilder::VisitSEHExceptStmt(SEHExceptStmt *ES) {
2591 // SEHExceptStmt are treated like labels, so they are the first statement in a
2592 // block.
2593
2594 // Save local scope position because in case of exception variable ScopePos
2595 // won't be restored when traversing AST.
2596 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2597
2598 addStmt(ES->getBlock());
2599 CFGBlock *SEHExceptBlock = Block;
2600 if (!SEHExceptBlock)
2601 SEHExceptBlock = createBlock();
2602
2603 appendStmt(SEHExceptBlock, ES);
2604
2605 // Also add the SEHExceptBlock as a label, like with regular labels.
2606 SEHExceptBlock->setLabel(ES);
2607
2608 // Bail out if the CFG is bad.
2609 if (badCFG)
2610 return nullptr;
2611
2612 // We set Block to NULL to allow lazy creation of a new block (if necessary).
2613 Block = nullptr;
2614
2615 return SEHExceptBlock;
2616}
2617
2618CFGBlock *CFGBuilder::VisitSEHFinallyStmt(SEHFinallyStmt *FS) {
2619 return VisitCompoundStmt(FS->getBlock());
2620}
2621
2622CFGBlock *CFGBuilder::VisitSEHLeaveStmt(SEHLeaveStmt *LS) {
2623 // "__leave" is a control-flow statement. Thus we stop processing the current
2624 // block.
2625 if (badCFG)
2626 return nullptr;
2627
2628 // Now create a new block that ends with the __leave statement.
2629 Block = createBlock(false);
2630 Block->setTerminator(LS);
2631
2632 // If there is no target for the __leave, then we are looking at an incomplete
2633 // AST. This means that the CFG cannot be constructed.
2634 if (SEHLeaveJumpTarget.block) {
2635 addAutomaticObjHandling(ScopePos, SEHLeaveJumpTarget.scopePosition, LS);
2636 addSuccessor(Block, SEHLeaveJumpTarget.block);
2637 } else
2638 badCFG = true;
2639
2640 return Block;
2641}
2642
2643CFGBlock *CFGBuilder::VisitSEHTryStmt(SEHTryStmt *Terminator) {
2644 // "__try"/"__except"/"__finally" is a control-flow statement. Thus we stop
2645 // processing the current block.
2646 CFGBlock *SEHTrySuccessor = nullptr;
2647
2648 if (Block) {
2649 if (badCFG)
2650 return nullptr;
2651 SEHTrySuccessor = Block;
2652 } else SEHTrySuccessor = Succ;
2653
2654 // FIXME: Implement __finally support.
2655 if (Terminator->getFinallyHandler())
2656 return NYS();
2657
2658 CFGBlock *PrevSEHTryTerminatedBlock = TryTerminatedBlock;
2659
2660 // Create a new block that will contain the __try statement.
2661 CFGBlock *NewTryTerminatedBlock = createBlock(false);
2662
2663 // Add the terminator in the __try block.
2664 NewTryTerminatedBlock->setTerminator(Terminator);
2665
2666 if (SEHExceptStmt *Except = Terminator->getExceptHandler()) {
2667 // The code after the try is the implicit successor if there's an __except.
2668 Succ = SEHTrySuccessor;
2669 Block = nullptr;
2670 CFGBlock *ExceptBlock = VisitSEHExceptStmt(Except);
2671 if (!ExceptBlock)
2672 return nullptr;
2673 // Add this block to the list of successors for the block with the try
2674 // statement.
2675 addSuccessor(NewTryTerminatedBlock, ExceptBlock);
2676 }
2677 if (PrevSEHTryTerminatedBlock)
2678 addSuccessor(NewTryTerminatedBlock, PrevSEHTryTerminatedBlock);
2679 else
2680 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
2681
2682 // The code after the try is the implicit successor.
2683 Succ = SEHTrySuccessor;
2684
2685 // Save the current "__try" context.
2686 SaveAndRestore<CFGBlock *> save_try(TryTerminatedBlock,
2687 NewTryTerminatedBlock);
2688 cfg->addTryDispatchBlock(TryTerminatedBlock);
2689
2690 // Save the current value for the __leave target.
2691 // All __leaves should go to the code following the __try
2692 // (FIXME: or if the __try has a __finally, to the __finally.)
2693 SaveAndRestore<JumpTarget> save_break(SEHLeaveJumpTarget);
2694 SEHLeaveJumpTarget = JumpTarget(SEHTrySuccessor, ScopePos);
2695
2696 assert(Terminator->getTryBlock() && "__try must contain a non-NULL body");
2697 Block = nullptr;
2698 return addStmt(Terminator->getTryBlock());
2699}
2700
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002701CFGBlock *CFGBuilder::VisitLabelStmt(LabelStmt *L) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002702 // Get the block of the labeled statement. Add it to our map.
Ted Kremenek93668002009-07-17 22:18:43 +00002703 addStmt(L->getSubStmt());
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002704 CFGBlock *LabelBlock = Block;
Mike Stump31feda52009-07-17 01:31:16 +00002705
Ted Kremenek93668002009-07-17 22:18:43 +00002706 if (!LabelBlock) // This can happen when the body is empty, i.e.
2707 LabelBlock = createBlock(); // scopes that only contains NullStmts.
Mike Stump31feda52009-07-17 01:31:16 +00002708
Chris Lattnerc8e630e2011-02-17 07:39:24 +00002709 assert(LabelMap.find(L->getDecl()) == LabelMap.end() &&
2710 "label already in map");
2711 LabelMap[L->getDecl()] = JumpTarget(LabelBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00002712
2713 // Labels partition blocks, so this is the end of the basic block we were
2714 // processing (L is the block's label). Because this is label (and we have
2715 // already processed the substatement) there is no extra control-flow to worry
2716 // about.
Ted Kremenek71eca012007-08-29 23:20:49 +00002717 LabelBlock->setLabel(L);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002718 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002719 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002720
2721 // We set Block to NULL to allow lazy creation of a new block (if necessary);
Craig Topper25542942014-05-20 04:30:07 +00002722 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002723
Ted Kremenek9aae5132007-08-23 21:42:29 +00002724 // This block is now the implicit successor of other blocks.
2725 Succ = LabelBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002726
Ted Kremenek9aae5132007-08-23 21:42:29 +00002727 return LabelBlock;
2728}
2729
Devin Coughlinb6029b72015-11-25 22:35:37 +00002730CFGBlock *CFGBuilder::VisitBlockExpr(BlockExpr *E, AddStmtChoice asc) {
2731 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
2732 for (const BlockDecl::Capture &CI : E->getBlockDecl()->captures()) {
2733 if (Expr *CopyExpr = CI.getCopyExpr()) {
2734 CFGBlock *Tmp = Visit(CopyExpr);
2735 if (Tmp)
2736 LastBlock = Tmp;
2737 }
2738 }
2739 return LastBlock;
2740}
2741
Ted Kremenekda76a942012-04-12 20:34:52 +00002742CFGBlock *CFGBuilder::VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc) {
2743 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
2744 for (LambdaExpr::capture_init_iterator it = E->capture_init_begin(),
2745 et = E->capture_init_end(); it != et; ++it) {
2746 if (Expr *Init = *it) {
2747 CFGBlock *Tmp = Visit(Init);
Craig Topper25542942014-05-20 04:30:07 +00002748 if (Tmp)
Ted Kremenekda76a942012-04-12 20:34:52 +00002749 LastBlock = Tmp;
2750 }
2751 }
2752 return LastBlock;
2753}
2754
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002755CFGBlock *CFGBuilder::VisitGotoStmt(GotoStmt *G) {
Mike Stump31feda52009-07-17 01:31:16 +00002756 // Goto is a control-flow statement. Thus we stop processing the current
2757 // block and create a new one.
Ted Kremenek93668002009-07-17 22:18:43 +00002758
Ted Kremenek9aae5132007-08-23 21:42:29 +00002759 Block = createBlock(false);
2760 Block->setTerminator(G);
Mike Stump31feda52009-07-17 01:31:16 +00002761
2762 // If we already know the mapping to the label block add the successor now.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002763 LabelMapTy::iterator I = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00002764
Ted Kremenek9aae5132007-08-23 21:42:29 +00002765 if (I == LabelMap.end())
2766 // We will need to backpatch this block later.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002767 BackpatchBlocks.push_back(JumpSource(Block, ScopePos));
2768 else {
2769 JumpTarget JT = I->second;
Matthias Gehre351c2182017-07-12 07:04:19 +00002770 addAutomaticObjHandling(ScopePos, JT.scopePosition, G);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002771 addSuccessor(Block, JT.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002772 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002773
Mike Stump31feda52009-07-17 01:31:16 +00002774 return Block;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002775}
2776
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002777CFGBlock *CFGBuilder::VisitForStmt(ForStmt *F) {
Craig Topper25542942014-05-20 04:30:07 +00002778 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002779
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002780 // Save local scope position because in case of condition variable ScopePos
2781 // won't be restored when traversing AST.
2782 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2783
2784 // Create local scope for init statement and possible condition variable.
2785 // Add destructor for init statement and condition variable.
2786 // Store scope position for continue statement.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002787 if (Stmt *Init = F->getInit())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002788 addLocalScopeForStmt(Init);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002789 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
2790
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002791 if (VarDecl *VD = F->getConditionVariable())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002792 addLocalScopeForVarDecl(VD);
2793 LocalScope::const_iterator ContinueScopePos = ScopePos;
2794
Matthias Gehre351c2182017-07-12 07:04:19 +00002795 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), F);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002796
Peter Szecsi999a25f2017-08-19 11:19:16 +00002797 addLoopExit(F);
2798
Mike Stump014b3ea2009-07-21 01:12:51 +00002799 // "for" is a control-flow statement. Thus we stop processing the current
2800 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002801 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002802 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002803 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002804 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002805 } else
2806 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002807
Ted Kremenek304a9532010-05-21 20:30:15 +00002808 // Save the current value for the break targets.
2809 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002810 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002811 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Ted Kremenek304a9532010-05-21 20:30:15 +00002812
Craig Topper25542942014-05-20 04:30:07 +00002813 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00002814
Ted Kremenek9aae5132007-08-23 21:42:29 +00002815 // Now create the loop body.
2816 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002817 assert(F->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00002818
Ted Kremenekb50e7162012-07-14 05:04:10 +00002819 // Save the current values for Block, Succ, continue and break targets.
2820 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
2821 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00002822
Ted Kremenekb50e7162012-07-14 05:04:10 +00002823 // Create an empty block to represent the transition block for looping back
2824 // to the head of the loop. If we have increment code, it will
2825 // go in this block as well.
2826 Block = Succ = TransitionBlock = createBlock(false);
2827 TransitionBlock->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00002828
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002829 if (Stmt *I = F->getInc()) {
Mike Stump31feda52009-07-17 01:31:16 +00002830 // Generate increment code in its own basic block. This is the target of
2831 // continue statements.
Ted Kremenek93668002009-07-17 22:18:43 +00002832 Succ = addStmt(I);
Ted Kremenekb0746ca2008-09-04 21:48:47 +00002833 }
Mike Stump31feda52009-07-17 01:31:16 +00002834
Ted Kremenek902393b2009-04-28 00:51:56 +00002835 // Finish up the increment (or empty) block if it hasn't been already.
2836 if (Block) {
2837 assert(Block == Succ);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002838 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002839 return nullptr;
2840 Block = nullptr;
Ted Kremenek902393b2009-04-28 00:51:56 +00002841 }
Mike Stump31feda52009-07-17 01:31:16 +00002842
Ted Kremenekb50e7162012-07-14 05:04:10 +00002843 // The starting block for the loop increment is the block that should
2844 // represent the 'loop target' for looping back to the start of the loop.
2845 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
2846 ContinueJumpTarget.block->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00002847
Ted Kremenekb50e7162012-07-14 05:04:10 +00002848 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00002849 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, F);
Ted Kremenek902393b2009-04-28 00:51:56 +00002850
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00002851 // If body is not a compound statement create implicit scope
2852 // and add destructors.
2853 if (!isa<CompoundStmt>(F->getBody()))
2854 addLocalScopeAndDtors(F->getBody());
2855
Mike Stump31feda52009-07-17 01:31:16 +00002856 // Now populate the body block, and in the process create new blocks as we
2857 // walk the body of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002858 BodyBlock = addStmt(F->getBody());
Ted Kremeneke9610502007-08-30 18:39:40 +00002859
Ted Kremenekb50e7162012-07-14 05:04:10 +00002860 if (!BodyBlock) {
2861 // In the case of "for (...;...;...);" we can have a null BodyBlock.
2862 // Use the continue jump target as the proxy for the body.
2863 BodyBlock = ContinueJumpTarget.block;
2864 }
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002865 else if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002866 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002867 }
Ted Kremenekb50e7162012-07-14 05:04:10 +00002868
2869 // Because of short-circuit evaluation, the condition of the loop can span
2870 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
2871 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00002872 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002873
Ted Kremenekb50e7162012-07-14 05:04:10 +00002874 do {
2875 Expr *C = F->getCond();
2876
2877 // Specially handle logical operators, which have a slightly
2878 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00002879 if (BinaryOperator *Cond =
Craig Topper25542942014-05-20 04:30:07 +00002880 dyn_cast_or_null<BinaryOperator>(C ? C->IgnoreParens() : nullptr))
Ted Kremenekb50e7162012-07-14 05:04:10 +00002881 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00002882 std::tie(EntryConditionBlock, ExitConditionBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00002883 VisitLogicalOperator(Cond, F, BodyBlock, LoopSuccessor);
2884 break;
2885 }
2886
2887 // The default case when not handling logical operators.
2888 EntryConditionBlock = ExitConditionBlock = createBlock(false);
2889 ExitConditionBlock->setTerminator(F);
2890
2891 // See if this is a known constant.
2892 TryResult KnownVal(true);
2893
2894 if (C) {
2895 // Now add the actual condition to the condition block.
2896 // Because the condition itself may contain control-flow, new blocks may
2897 // be created. Thus we update "Succ" after adding the condition.
2898 Block = ExitConditionBlock;
2899 EntryConditionBlock = addStmt(C);
2900
2901 // If this block contains a condition variable, add both the condition
2902 // variable and initializer to the CFG.
2903 if (VarDecl *VD = F->getConditionVariable()) {
2904 if (Expr *Init = VD->getInit()) {
2905 autoCreateBlock();
2906 appendStmt(Block, F->getConditionVariableDeclStmt());
2907 EntryConditionBlock = addStmt(Init);
2908 assert(Block == EntryConditionBlock);
2909 }
2910 }
2911
2912 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002913 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002914
2915 KnownVal = tryEvaluateBool(C);
2916 }
2917
2918 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00002919 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002920 // Link up the condition block with the code that follows the loop. (the
2921 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00002922 addSuccessor(ExitConditionBlock,
2923 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002924 } while (false);
2925
2926 // Link up the loop-back block to the entry condition block.
2927 addSuccessor(TransitionBlock, EntryConditionBlock);
2928
2929 // The condition block is the implicit successor for any code above the loop.
2930 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00002931
Ted Kremenek9aae5132007-08-23 21:42:29 +00002932 // If the loop contains initialization, create a new block for those
Mike Stump31feda52009-07-17 01:31:16 +00002933 // statements. This block can also contain statements that precede the loop.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002934 if (Stmt *I = F->getInit()) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002935 Block = createBlock();
Ted Kremenek81e14852007-08-27 19:46:09 +00002936 return addStmt(I);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002937 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002938
2939 // There is no loop initialization. We are thus basically a while loop.
2940 // NULL out Block to force lazy block construction.
Craig Topper25542942014-05-20 04:30:07 +00002941 Block = nullptr;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002942 Succ = EntryConditionBlock;
2943 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002944}
2945
Ted Kremenek5868ec62010-04-11 17:02:10 +00002946CFGBlock *CFGBuilder::VisitMemberExpr(MemberExpr *M, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002947 if (asc.alwaysAdd(*this, M)) {
Ted Kremenek5868ec62010-04-11 17:02:10 +00002948 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002949 appendStmt(Block, M);
Ted Kremenek5868ec62010-04-11 17:02:10 +00002950 }
Ted Kremenek8219b822010-12-16 07:46:53 +00002951 return Visit(M->getBase());
Ted Kremenek5868ec62010-04-11 17:02:10 +00002952}
2953
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002954CFGBlock *CFGBuilder::VisitObjCForCollectionStmt(ObjCForCollectionStmt *S) {
Ted Kremenek9d56e642008-11-11 17:10:00 +00002955 // Objective-C fast enumeration 'for' statements:
2956 // http://developer.apple.com/documentation/Cocoa/Conceptual/ObjectiveC
2957 //
2958 // for ( Type newVariable in collection_expression ) { statements }
2959 //
2960 // becomes:
2961 //
2962 // prologue:
2963 // 1. collection_expression
2964 // T. jump to loop_entry
2965 // loop_entry:
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002966 // 1. side-effects of element expression
Ted Kremenek9d56e642008-11-11 17:10:00 +00002967 // 1. ObjCForCollectionStmt [performs binding to newVariable]
2968 // T. ObjCForCollectionStmt TB, FB [jumps to TB if newVariable != nil]
2969 // TB:
2970 // statements
2971 // T. jump to loop_entry
2972 // FB:
2973 // what comes after
2974 //
2975 // and
2976 //
2977 // Type existingItem;
2978 // for ( existingItem in expression ) { statements }
2979 //
2980 // becomes:
2981 //
Mike Stump31feda52009-07-17 01:31:16 +00002982 // the same with newVariable replaced with existingItem; the binding works
2983 // the same except that for one ObjCForCollectionStmt::getElement() returns
2984 // a DeclStmt and the other returns a DeclRefExpr.
Mike Stump31feda52009-07-17 01:31:16 +00002985
Craig Topper25542942014-05-20 04:30:07 +00002986 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002987
Ted Kremenek9d56e642008-11-11 17:10:00 +00002988 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002989 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002990 return nullptr;
Ted Kremenek9d56e642008-11-11 17:10:00 +00002991 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00002992 Block = nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00002993 } else
2994 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002995
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002996 // Build the condition blocks.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002997 CFGBlock *ExitConditionBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002998
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00002999 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003000 ExitConditionBlock->setTerminator(S);
3001
3002 // The last statement in the block should be the ObjCForCollectionStmt, which
3003 // performs the actual binding to 'element' and determines if there are any
3004 // more items in the collection.
Ted Kremenek8219b822010-12-16 07:46:53 +00003005 appendStmt(ExitConditionBlock, S);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003006 Block = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003007
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003008 // Walk the 'element' expression to see if there are any side-effects. We
Chris Lattner57540c52011-04-15 05:22:18 +00003009 // generate new blocks as necessary. We DON'T add the statement by default to
Mike Stump31feda52009-07-17 01:31:16 +00003010 // the CFG unless it contains control-flow.
Ted Kremenekc14efa72011-08-17 21:04:19 +00003011 CFGBlock *EntryConditionBlock = Visit(S->getElement(),
3012 AddStmtChoice::NotAlwaysAdd);
Mike Stump31feda52009-07-17 01:31:16 +00003013 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003014 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003015 return nullptr;
3016 Block = nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003017 }
Mike Stump31feda52009-07-17 01:31:16 +00003018
3019 // The condition block is the implicit successor for the loop body as well as
3020 // any code above the loop.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003021 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003022
Ted Kremenek9d56e642008-11-11 17:10:00 +00003023 // Now create the true branch.
Mike Stump31feda52009-07-17 01:31:16 +00003024 {
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003025 // Save the current values for Succ, continue and break targets.
Anna Zaks56b49752013-06-22 00:23:20 +00003026 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003027 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Anna Zaks56b49752013-06-22 00:23:20 +00003028 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003029
Anna Zaks56b49752013-06-22 00:23:20 +00003030 // Add an intermediate block between the BodyBlock and the
3031 // EntryConditionBlock to represent the "loop back" transition, for looping
3032 // back to the head of the loop.
Craig Topper25542942014-05-20 04:30:07 +00003033 CFGBlock *LoopBackBlock = nullptr;
Anna Zaks56b49752013-06-22 00:23:20 +00003034 Succ = LoopBackBlock = createBlock();
3035 LoopBackBlock->setLoopTarget(S);
3036
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003037 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Anna Zaks56b49752013-06-22 00:23:20 +00003038 ContinueJumpTarget = JumpTarget(Succ, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003039
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003040 CFGBlock *BodyBlock = addStmt(S->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003041
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003042 if (!BodyBlock)
Anna Zaks56b49752013-06-22 00:23:20 +00003043 BodyBlock = ContinueJumpTarget.block; // can happen for "for (X in Y) ;"
Ted Kremenek55957a82009-05-02 00:13:27 +00003044 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003045 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003046 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003047 }
Mike Stump31feda52009-07-17 01:31:16 +00003048
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003049 // This new body block is a successor to our "exit" condition block.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003050 addSuccessor(ExitConditionBlock, BodyBlock);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003051 }
Mike Stump31feda52009-07-17 01:31:16 +00003052
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003053 // Link up the condition block with the code that follows the loop.
3054 // (the false branch).
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003055 addSuccessor(ExitConditionBlock, LoopSuccessor);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003056
Ted Kremenek9d56e642008-11-11 17:10:00 +00003057 // Now create a prologue block to contain the collection expression.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003058 Block = createBlock();
Ted Kremenek9d56e642008-11-11 17:10:00 +00003059 return addStmt(S->getCollection());
Mike Stump31feda52009-07-17 01:31:16 +00003060}
3061
Ted Kremenek5022f1d2012-03-06 23:40:47 +00003062CFGBlock *CFGBuilder::VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S) {
3063 // Inline the body.
3064 return addStmt(S->getSubStmt());
3065 // TODO: consider adding cleanups for the end of @autoreleasepool scope.
3066}
3067
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003068CFGBlock *CFGBuilder::VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S) {
Ted Kremenek49805452009-05-02 01:49:13 +00003069 // FIXME: Add locking 'primitives' to CFG for @synchronized.
Mike Stump31feda52009-07-17 01:31:16 +00003070
Ted Kremenek49805452009-05-02 01:49:13 +00003071 // Inline the body.
Ted Kremenek93668002009-07-17 22:18:43 +00003072 CFGBlock *SyncBlock = addStmt(S->getSynchBody());
Mike Stump31feda52009-07-17 01:31:16 +00003073
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003074 // The sync body starts its own basic block. This makes it a little easier
3075 // for diagnostic clients.
3076 if (SyncBlock) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003077 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003078 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003079
Craig Topper25542942014-05-20 04:30:07 +00003080 Block = nullptr;
Ted Kremenekecc31c92010-05-13 16:38:08 +00003081 Succ = SyncBlock;
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003082 }
Mike Stump31feda52009-07-17 01:31:16 +00003083
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003084 // Add the @synchronized to the CFG.
3085 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003086 appendStmt(Block, S);
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003087
Ted Kremenek49805452009-05-02 01:49:13 +00003088 // Inline the sync expression.
Ted Kremenek93668002009-07-17 22:18:43 +00003089 return addStmt(S->getSynchExpr());
Ted Kremenek49805452009-05-02 01:49:13 +00003090}
Mike Stump31feda52009-07-17 01:31:16 +00003091
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003092CFGBlock *CFGBuilder::VisitObjCAtTryStmt(ObjCAtTryStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003093 // FIXME
Ted Kremenek89be6522009-04-07 04:26:02 +00003094 return NYS();
Ted Kremenek89cc8ea2009-03-30 22:29:21 +00003095}
Ted Kremenek9d56e642008-11-11 17:10:00 +00003096
John McCallfe96e0b2011-11-06 09:01:30 +00003097CFGBlock *CFGBuilder::VisitPseudoObjectExpr(PseudoObjectExpr *E) {
3098 autoCreateBlock();
3099
3100 // Add the PseudoObject as the last thing.
3101 appendStmt(Block, E);
3102
3103 CFGBlock *lastBlock = Block;
3104
3105 // Before that, evaluate all of the semantics in order. In
3106 // CFG-land, that means appending them in reverse order.
3107 for (unsigned i = E->getNumSemanticExprs(); i != 0; ) {
3108 Expr *Semantic = E->getSemanticExpr(--i);
3109
3110 // If the semantic is an opaque value, we're being asked to bind
3111 // it to its source expression.
3112 if (OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(Semantic))
3113 Semantic = OVE->getSourceExpr();
3114
3115 if (CFGBlock *B = Visit(Semantic))
3116 lastBlock = B;
3117 }
3118
3119 return lastBlock;
3120}
3121
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003122CFGBlock *CFGBuilder::VisitWhileStmt(WhileStmt *W) {
Craig Topper25542942014-05-20 04:30:07 +00003123 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003124
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003125 // Save local scope position because in case of condition variable ScopePos
3126 // won't be restored when traversing AST.
3127 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3128
3129 // Create local scope for possible condition variable.
3130 // Store scope position for continue statement.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003131 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003132 if (VarDecl *VD = W->getConditionVariable()) {
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003133 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00003134 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003135 }
Peter Szecsi999a25f2017-08-19 11:19:16 +00003136 addLoopExit(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003137
Mike Stump014b3ea2009-07-21 01:12:51 +00003138 // "while" is a control-flow statement. Thus we stop processing the current
3139 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003140 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003141 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003142 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003143 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003144 Block = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003145 } else {
Ted Kremenek93668002009-07-17 22:18:43 +00003146 LoopSuccessor = Succ;
Ted Kremenek81e14852007-08-27 19:46:09 +00003147 }
Mike Stump31feda52009-07-17 01:31:16 +00003148
Craig Topper25542942014-05-20 04:30:07 +00003149 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00003150
Ted Kremenek9aae5132007-08-23 21:42:29 +00003151 // Process the loop body.
3152 {
Ted Kremenek49936f72009-04-28 03:09:44 +00003153 assert(W->getBody());
Ted Kremenek9aae5132007-08-23 21:42:29 +00003154
Ted Kremenekb50e7162012-07-14 05:04:10 +00003155 // Save the current values for Block, Succ, continue and break targets.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003156 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3157 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Ted Kremenekb50e7162012-07-14 05:04:10 +00003158 save_break(BreakJumpTarget);
Ted Kremenek49936f72009-04-28 03:09:44 +00003159
Mike Stump31feda52009-07-17 01:31:16 +00003160 // Create an empty block to represent the transition block for looping back
3161 // to the head of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003162 Succ = TransitionBlock = createBlock(false);
3163 TransitionBlock->setLoopTarget(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003164 ContinueJumpTarget = JumpTarget(Succ, LoopBeginScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003165
Ted Kremenek9aae5132007-08-23 21:42:29 +00003166 // All breaks should go to the code following the loop.
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003167 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003168
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003169 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00003170 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003171
3172 // If body is not a compound statement create implicit scope
3173 // and add destructors.
3174 if (!isa<CompoundStmt>(W->getBody()))
3175 addLocalScopeAndDtors(W->getBody());
3176
Ted Kremenek9aae5132007-08-23 21:42:29 +00003177 // Create the body. The returned block is the entry to the loop body.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003178 BodyBlock = addStmt(W->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003179
Ted Kremeneke9610502007-08-30 18:39:40 +00003180 if (!BodyBlock)
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003181 BodyBlock = ContinueJumpTarget.block; // can happen for "while(...) ;"
Ted Kremenekb50e7162012-07-14 05:04:10 +00003182 else if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003183 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003184 }
3185
3186 // Because of short-circuit evaluation, the condition of the loop can span
3187 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3188 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00003189 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003190
3191 do {
3192 Expr *C = W->getCond();
3193
3194 // Specially handle logical operators, which have a slightly
3195 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00003196 if (BinaryOperator *Cond = dyn_cast<BinaryOperator>(C->IgnoreParens()))
Ted Kremenekb50e7162012-07-14 05:04:10 +00003197 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00003198 std::tie(EntryConditionBlock, ExitConditionBlock) =
3199 VisitLogicalOperator(Cond, W, BodyBlock, LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003200 break;
3201 }
3202
3203 // The default case when not handling logical operators.
Ted Kremenek451c4d52012-10-12 22:56:26 +00003204 ExitConditionBlock = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003205 ExitConditionBlock->setTerminator(W);
3206
3207 // Now add the actual condition to the condition block.
3208 // Because the condition itself may contain control-flow, new blocks may
3209 // be created. Thus we update "Succ" after adding the condition.
3210 Block = ExitConditionBlock;
3211 Block = EntryConditionBlock = addStmt(C);
3212
3213 // If this block contains a condition variable, add both the condition
3214 // variable and initializer to the CFG.
3215 if (VarDecl *VD = W->getConditionVariable()) {
3216 if (Expr *Init = VD->getInit()) {
3217 autoCreateBlock();
3218 appendStmt(Block, W->getConditionVariableDeclStmt());
3219 EntryConditionBlock = addStmt(Init);
3220 assert(Block == EntryConditionBlock);
3221 }
Ted Kremenek55957a82009-05-02 00:13:27 +00003222 }
Mike Stump31feda52009-07-17 01:31:16 +00003223
Ted Kremenekb50e7162012-07-14 05:04:10 +00003224 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003225 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003226
3227 // See if this is a known constant.
3228 const TryResult& KnownVal = tryEvaluateBool(C);
3229
Ted Kremenek30754282009-07-24 04:47:11 +00003230 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003231 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003232 // Link up the condition block with the code that follows the loop. (the
3233 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003234 addSuccessor(ExitConditionBlock,
3235 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003236 } while(false);
3237
3238 // Link up the loop-back block to the entry condition block.
3239 addSuccessor(TransitionBlock, EntryConditionBlock);
Mike Stump31feda52009-07-17 01:31:16 +00003240
3241 // There can be no more statements in the condition block since we loop back
3242 // to this block. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003243 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003244
Ted Kremenek1ce53c42009-12-24 01:34:10 +00003245 // Return the condition block, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003246 Succ = EntryConditionBlock;
Ted Kremenek81e14852007-08-27 19:46:09 +00003247 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003248}
Mike Stump11289f42009-09-09 15:08:12 +00003249
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003250CFGBlock *CFGBuilder::VisitObjCAtCatchStmt(ObjCAtCatchStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003251 // FIXME: For now we pretend that @catch and the code it contains does not
3252 // exit.
3253 return Block;
3254}
Mike Stump31feda52009-07-17 01:31:16 +00003255
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003256CFGBlock *CFGBuilder::VisitObjCAtThrowStmt(ObjCAtThrowStmt *S) {
Ted Kremenek93041ba2008-12-09 20:20:09 +00003257 // FIXME: This isn't complete. We basically treat @throw like a return
3258 // statement.
Mike Stump31feda52009-07-17 01:31:16 +00003259
Ted Kremenek0868eea2009-09-24 18:45:41 +00003260 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003261 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003262 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003263
Ted Kremenek93041ba2008-12-09 20:20:09 +00003264 // Create the new block.
3265 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003266
Ted Kremenek93041ba2008-12-09 20:20:09 +00003267 // The Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003268 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00003269
3270 // Add the statement to the block. This may create new blocks if S contains
3271 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003272 return VisitStmt(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek93041ba2008-12-09 20:20:09 +00003273}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003274
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003275CFGBlock *CFGBuilder::VisitCXXThrowExpr(CXXThrowExpr *T) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00003276 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003277 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003278 return nullptr;
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003279
3280 // Create the new block.
3281 Block = createBlock(false);
3282
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003283 if (TryTerminatedBlock)
3284 // The current try statement is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003285 addSuccessor(Block, TryTerminatedBlock);
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003286 else
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003287 // otherwise the Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003288 addSuccessor(Block, &cfg->getExit());
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003289
3290 // Add the statement to the block. This may create new blocks if S contains
3291 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003292 return VisitStmt(T, AddStmtChoice::AlwaysAdd);
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003293}
3294
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003295CFGBlock *CFGBuilder::VisitDoStmt(DoStmt *D) {
Craig Topper25542942014-05-20 04:30:07 +00003296 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003297
Peter Szecsi999a25f2017-08-19 11:19:16 +00003298 addLoopExit(D);
3299
Mike Stump8d50b6a2009-07-21 01:27:50 +00003300 // "do...while" is a control-flow statement. Thus we stop processing the
3301 // current block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003302 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003303 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003304 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003305 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003306 } else
3307 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003308
3309 // Because of short-circuit evaluation, the condition of the loop can span
3310 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3311 // evaluate the condition.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003312 CFGBlock *ExitConditionBlock = createBlock(false);
3313 CFGBlock *EntryConditionBlock = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003314
Ted Kremenek81e14852007-08-27 19:46:09 +00003315 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003316 ExitConditionBlock->setTerminator(D);
3317
3318 // Now add the actual condition to the condition block. Because the condition
3319 // itself may contain control-flow, new blocks may be created.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003320 if (Stmt *C = D->getCond()) {
Ted Kremenek81e14852007-08-27 19:46:09 +00003321 Block = ExitConditionBlock;
3322 EntryConditionBlock = addStmt(C);
Ted Kremenek55957a82009-05-02 00:13:27 +00003323 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003324 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003325 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003326 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003327 }
Mike Stump31feda52009-07-17 01:31:16 +00003328
Ted Kremeneka1523a32008-02-27 07:20:00 +00003329 // The condition block is the implicit successor for the loop body.
Ted Kremenek81e14852007-08-27 19:46:09 +00003330 Succ = EntryConditionBlock;
3331
Mike Stump773582d2009-07-23 23:25:26 +00003332 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003333 const TryResult &KnownVal = tryEvaluateBool(D->getCond());
Mike Stump773582d2009-07-23 23:25:26 +00003334
Ted Kremenek9aae5132007-08-23 21:42:29 +00003335 // Process the loop body.
Craig Topper25542942014-05-20 04:30:07 +00003336 CFGBlock *BodyBlock = nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003337 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003338 assert(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003339
Ted Kremenek9aae5132007-08-23 21:42:29 +00003340 // Save the current values for Block, Succ, and continue and break targets
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003341 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3342 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
3343 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003344
Ted Kremenek9aae5132007-08-23 21:42:29 +00003345 // All continues within this loop should go to the condition block
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003346 ContinueJumpTarget = JumpTarget(EntryConditionBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003347
Ted Kremenek9aae5132007-08-23 21:42:29 +00003348 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003349 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003350
Ted Kremenek9aae5132007-08-23 21:42:29 +00003351 // NULL out Block to force lazy instantiation of blocks for the body.
Craig Topper25542942014-05-20 04:30:07 +00003352 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003353
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003354 // If body is not a compound statement create implicit scope
3355 // and add destructors.
3356 if (!isa<CompoundStmt>(D->getBody()))
3357 addLocalScopeAndDtors(D->getBody());
3358
Ted Kremenek9aae5132007-08-23 21:42:29 +00003359 // Create the body. The returned block is the entry to the loop body.
Ted Kremenek93668002009-07-17 22:18:43 +00003360 BodyBlock = addStmt(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003361
Ted Kremeneke9610502007-08-30 18:39:40 +00003362 if (!BodyBlock)
Ted Kremenek39321aa2008-02-27 00:28:17 +00003363 BodyBlock = EntryConditionBlock; // can happen for "do ; while(...)"
Ted Kremenek55957a82009-05-02 00:13:27 +00003364 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003365 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003366 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003367 }
Mike Stump31feda52009-07-17 01:31:16 +00003368
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003369 // Add an intermediate block between the BodyBlock and the
3370 // ExitConditionBlock to represent the "loop back" transition. Create an
3371 // empty block to represent the transition block for looping back to the
3372 // head of the loop.
3373 // FIXME: Can we do this more efficiently without adding another block?
3374 Block = nullptr;
3375 Succ = BodyBlock;
3376 CFGBlock *LoopBackBlock = createBlock();
3377 LoopBackBlock->setLoopTarget(D);
Mike Stump31feda52009-07-17 01:31:16 +00003378
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003379 if (!KnownVal.isFalse())
Ted Kremenek110974d2010-08-17 20:59:56 +00003380 // Add the loop body entry as a successor to the condition.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003381 addSuccessor(ExitConditionBlock, LoopBackBlock);
Ted Kremenek110974d2010-08-17 20:59:56 +00003382 else
Craig Topper25542942014-05-20 04:30:07 +00003383 addSuccessor(ExitConditionBlock, nullptr);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003384 }
Mike Stump31feda52009-07-17 01:31:16 +00003385
Ted Kremenek30754282009-07-24 04:47:11 +00003386 // Link up the condition block with the code that follows the loop.
3387 // (the false branch).
Craig Topper25542942014-05-20 04:30:07 +00003388 addSuccessor(ExitConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003389
3390 // There can be no more statements in the body block(s) since we loop back to
3391 // the body. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003392 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003393
Ted Kremenek9aae5132007-08-23 21:42:29 +00003394 // Return the loop body, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003395 Succ = BodyBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003396 return BodyBlock;
3397}
3398
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003399CFGBlock *CFGBuilder::VisitContinueStmt(ContinueStmt *C) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003400 // "continue" is a control-flow statement. Thus we stop processing the
3401 // current block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003402 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003403 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003404
Ted Kremenek9aae5132007-08-23 21:42:29 +00003405 // Now create a new block that ends with the continue statement.
3406 Block = createBlock(false);
3407 Block->setTerminator(C);
Mike Stump31feda52009-07-17 01:31:16 +00003408
Ted Kremenek9aae5132007-08-23 21:42:29 +00003409 // If there is no target for the continue, then we are looking at an
Ted Kremenek882cf062009-04-07 18:53:24 +00003410 // incomplete AST. This means the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003411 if (ContinueJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00003412 addAutomaticObjHandling(ScopePos, ContinueJumpTarget.scopePosition, C);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003413 addSuccessor(Block, ContinueJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003414 } else
Ted Kremenek882cf062009-04-07 18:53:24 +00003415 badCFG = true;
Mike Stump31feda52009-07-17 01:31:16 +00003416
Ted Kremenek9aae5132007-08-23 21:42:29 +00003417 return Block;
3418}
Mike Stump11289f42009-09-09 15:08:12 +00003419
Peter Collingbournee190dee2011-03-11 19:24:49 +00003420CFGBlock *CFGBuilder::VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
3421 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003422 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003423 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003424 appendStmt(Block, E);
Ted Kremenek0747de62009-07-18 00:47:21 +00003425 }
Mike Stump11289f42009-09-09 15:08:12 +00003426
Ted Kremenek93668002009-07-17 22:18:43 +00003427 // VLA types have expressions that must be evaluated.
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003428 CFGBlock *lastBlock = Block;
3429
Ted Kremenek93668002009-07-17 22:18:43 +00003430 if (E->isArgumentType()) {
John McCall424cec92011-01-19 06:33:43 +00003431 for (const VariableArrayType *VA =FindVA(E->getArgumentType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00003432 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr()))
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003433 lastBlock = addStmt(VA->getSizeExpr());
Ted Kremenek84a1ca52011-08-06 00:30:00 +00003434 }
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003435 return lastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003436}
Mike Stump11289f42009-09-09 15:08:12 +00003437
Ted Kremenek93668002009-07-17 22:18:43 +00003438/// VisitStmtExpr - Utility method to handle (nested) statement
3439/// expressions (a GCC extension).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003440CFGBlock *CFGBuilder::VisitStmtExpr(StmtExpr *SE, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003441 if (asc.alwaysAdd(*this, SE)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003442 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003443 appendStmt(Block, SE);
Ted Kremenek0747de62009-07-18 00:47:21 +00003444 }
Ted Kremenek93668002009-07-17 22:18:43 +00003445 return VisitCompoundStmt(SE->getSubStmt());
3446}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003447
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003448CFGBlock *CFGBuilder::VisitSwitchStmt(SwitchStmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00003449 // "switch" is a control-flow statement. Thus we stop processing the current
3450 // block.
Craig Topper25542942014-05-20 04:30:07 +00003451 CFGBlock *SwitchSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003452
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003453 // Save local scope position because in case of condition variable ScopePos
3454 // won't be restored when traversing AST.
3455 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3456
Richard Smitha547eb22016-07-14 00:11:03 +00003457 // Create local scope for C++17 switch init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00003458 if (Stmt *Init = Terminator->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00003459 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00003460
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003461 // Create local scope for possible condition variable.
3462 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00003463 if (VarDecl *VD = Terminator->getConditionVariable())
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003464 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00003465
Matthias Gehre351c2182017-07-12 07:04:19 +00003466 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), Terminator);
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003467
Ted Kremenek9aae5132007-08-23 21:42:29 +00003468 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003469 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003470 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003471 SwitchSuccessor = Block;
Mike Stump31feda52009-07-17 01:31:16 +00003472 } else SwitchSuccessor = Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003473
3474 // Save the current "switch" context.
3475 SaveAndRestore<CFGBlock*> save_switch(SwitchTerminatedBlock),
Ted Kremenek654c78f2008-02-13 22:05:39 +00003476 save_default(DefaultCaseBlock);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003477 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Ted Kremenek654c78f2008-02-13 22:05:39 +00003478
Mike Stump31feda52009-07-17 01:31:16 +00003479 // Set the "default" case to be the block after the switch statement. If the
3480 // switch statement contains a "default:", this value will be overwritten with
3481 // the block for that code.
Ted Kremenek654c78f2008-02-13 22:05:39 +00003482 DefaultCaseBlock = SwitchSuccessor;
Mike Stump31feda52009-07-17 01:31:16 +00003483
Ted Kremenek9aae5132007-08-23 21:42:29 +00003484 // Create a new block that will contain the switch statement.
3485 SwitchTerminatedBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003486
Ted Kremenek9aae5132007-08-23 21:42:29 +00003487 // Now process the switch body. The code after the switch is the implicit
3488 // successor.
3489 Succ = SwitchSuccessor;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003490 BreakJumpTarget = JumpTarget(SwitchSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003491
3492 // When visiting the body, the case statements should automatically get linked
3493 // up to the switch. We also don't keep a pointer to the body, since all
3494 // control-flow from the switch goes to case/default statements.
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003495 assert(Terminator->getBody() && "switch must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00003496 Block = nullptr;
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003497
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003498 // For pruning unreachable case statements, save the current state
3499 // for tracking the condition value.
3500 SaveAndRestore<bool> save_switchExclusivelyCovered(switchExclusivelyCovered,
3501 false);
Ted Kremenekbe528712011-03-04 01:03:41 +00003502
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003503 // Determine if the switch condition can be explicitly evaluated.
3504 assert(Terminator->getCond() && "switch condition must be non-NULL");
Ted Kremenekbe528712011-03-04 01:03:41 +00003505 Expr::EvalResult result;
Ted Kremenek53e65382011-03-13 03:48:04 +00003506 bool b = tryEvaluate(Terminator->getCond(), result);
3507 SaveAndRestore<Expr::EvalResult*> save_switchCond(switchCond,
Craig Topper25542942014-05-20 04:30:07 +00003508 b ? &result : nullptr);
Ted Kremenekbe528712011-03-04 01:03:41 +00003509
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003510 // If body is not a compound statement create implicit scope
3511 // and add destructors.
3512 if (!isa<CompoundStmt>(Terminator->getBody()))
3513 addLocalScopeAndDtors(Terminator->getBody());
3514
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003515 addStmt(Terminator->getBody());
Ted Kremenek55957a82009-05-02 00:13:27 +00003516 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003517 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003518 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003519 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003520
Mike Stump31feda52009-07-17 01:31:16 +00003521 // If we have no "default:" case, the default transition is to the code
Ted Kremenek35c70f62011-03-16 04:32:01 +00003522 // following the switch body. Moreover, take into account if all the
3523 // cases of a switch are covered (e.g., switching on an enum value).
David Majnemerf69ce862013-06-04 17:38:44 +00003524 //
3525 // Note: We add a successor to a switch that is considered covered yet has no
3526 // case statements if the enumeration has no enumerators.
3527 bool SwitchAlwaysHasSuccessor = false;
3528 SwitchAlwaysHasSuccessor |= switchExclusivelyCovered;
3529 SwitchAlwaysHasSuccessor |= Terminator->isAllEnumCasesCovered() &&
3530 Terminator->getSwitchCaseList();
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003531 addSuccessor(SwitchTerminatedBlock, DefaultCaseBlock,
3532 !SwitchAlwaysHasSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003533
Ted Kremenek81e14852007-08-27 19:46:09 +00003534 // Add the terminator and condition in the switch block.
Ted Kremenekc1f9a282008-04-16 21:10:48 +00003535 SwitchTerminatedBlock->setTerminator(Terminator);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003536 Block = SwitchTerminatedBlock;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003537 CFGBlock *LastBlock = addStmt(Terminator->getCond());
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003538
Richard Smitha547eb22016-07-14 00:11:03 +00003539 // If the SwitchStmt contains a condition variable, add both the
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003540 // SwitchStmt and the condition variable initialization to the CFG.
3541 if (VarDecl *VD = Terminator->getConditionVariable()) {
3542 if (Expr *Init = VD->getInit()) {
3543 autoCreateBlock();
Ted Kremenek37881932011-04-04 23:29:12 +00003544 appendStmt(Block, Terminator->getConditionVariableDeclStmt());
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003545 LastBlock = addStmt(Init);
Ted Kremenek8b5dc122009-12-24 00:39:26 +00003546 }
3547 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003548
Richard Smitha547eb22016-07-14 00:11:03 +00003549 // Finally, if the SwitchStmt contains a C++17 init-stmt, add it to the CFG.
3550 if (Stmt *Init = Terminator->getInit()) {
3551 autoCreateBlock();
3552 LastBlock = addStmt(Init);
3553 }
3554
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003555 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003556}
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003557
3558static bool shouldAddCase(bool &switchExclusivelyCovered,
Ted Kremenek53e65382011-03-13 03:48:04 +00003559 const Expr::EvalResult *switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003560 const CaseStmt *CS,
3561 ASTContext &Ctx) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003562 if (!switchCond)
3563 return true;
3564
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003565 bool addCase = false;
Ted Kremenekbe528712011-03-04 01:03:41 +00003566
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003567 if (!switchExclusivelyCovered) {
Ted Kremenek53e65382011-03-13 03:48:04 +00003568 if (switchCond->Val.isInt()) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003569 // Evaluate the LHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003570 const llvm::APSInt &lhsInt = CS->getLHS()->EvaluateKnownConstInt(Ctx);
Ted Kremenek53e65382011-03-13 03:48:04 +00003571 const llvm::APSInt &condInt = switchCond->Val.getInt();
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003572
3573 if (condInt == lhsInt) {
3574 addCase = true;
3575 switchExclusivelyCovered = true;
3576 }
Devin Coughlineb538ab2015-09-22 20:31:19 +00003577 else if (condInt > lhsInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003578 if (const Expr *RHS = CS->getRHS()) {
3579 // Evaluate the RHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00003580 const llvm::APSInt &V2 = RHS->EvaluateKnownConstInt(Ctx);
Devin Coughlineb538ab2015-09-22 20:31:19 +00003581 if (V2 >= condInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003582 addCase = true;
3583 switchExclusivelyCovered = true;
3584 }
3585 }
3586 }
3587 }
3588 else
3589 addCase = true;
3590 }
3591 return addCase;
3592}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003593
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003594CFGBlock *CFGBuilder::VisitCaseStmt(CaseStmt *CS) {
Mike Stump31feda52009-07-17 01:31:16 +00003595 // CaseStmts are essentially labels, so they are the first statement in a
3596 // block.
Craig Topper25542942014-05-20 04:30:07 +00003597 CFGBlock *TopBlock = nullptr, *LastBlock = nullptr;
Ted Kremenekbe528712011-03-04 01:03:41 +00003598
Ted Kremenek60fa6572010-08-04 23:54:30 +00003599 if (Stmt *Sub = CS->getSubStmt()) {
3600 // For deeply nested chains of CaseStmts, instead of doing a recursion
3601 // (which can blow out the stack), manually unroll and create blocks
3602 // along the way.
3603 while (isa<CaseStmt>(Sub)) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003604 CFGBlock *currentBlock = createBlock(false);
3605 currentBlock->setLabel(CS);
Ted Kremenek55e91e82007-08-30 18:48:11 +00003606
Ted Kremenek60fa6572010-08-04 23:54:30 +00003607 if (TopBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003608 addSuccessor(LastBlock, currentBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003609 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003610 TopBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003611
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003612 addSuccessor(SwitchTerminatedBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00003613 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003614 CS, *Context)
Craig Topper25542942014-05-20 04:30:07 +00003615 ? currentBlock : nullptr);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003616
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003617 LastBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00003618 CS = cast<CaseStmt>(Sub);
3619 Sub = CS->getSubStmt();
3620 }
3621
3622 addStmt(Sub);
3623 }
Mike Stump11289f42009-09-09 15:08:12 +00003624
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003625 CFGBlock *CaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003626 if (!CaseBlock)
3627 CaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003628
3629 // Cases statements partition blocks, so this is the top of the basic block we
3630 // were processing (the "case XXX:" is the label).
Ted Kremenek93668002009-07-17 22:18:43 +00003631 CaseBlock->setLabel(CS);
3632
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003633 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003634 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003635
3636 // Add this block to the list of successors for the block with the switch
3637 // statement.
Ted Kremenek93668002009-07-17 22:18:43 +00003638 assert(SwitchTerminatedBlock);
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003639 addSuccessor(SwitchTerminatedBlock, CaseBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00003640 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenek9238c5c2014-02-27 21:56:44 +00003641 CS, *Context));
Mike Stump31feda52009-07-17 01:31:16 +00003642
Ted Kremenek9aae5132007-08-23 21:42:29 +00003643 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003644 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003645
Ted Kremenek60fa6572010-08-04 23:54:30 +00003646 if (TopBlock) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003647 addSuccessor(LastBlock, CaseBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00003648 Succ = TopBlock;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003649 } else {
Ted Kremenek60fa6572010-08-04 23:54:30 +00003650 // This block is now the implicit successor of other blocks.
3651 Succ = CaseBlock;
3652 }
Mike Stump31feda52009-07-17 01:31:16 +00003653
Ted Kremenek60fa6572010-08-04 23:54:30 +00003654 return Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003655}
Mike Stump31feda52009-07-17 01:31:16 +00003656
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003657CFGBlock *CFGBuilder::VisitDefaultStmt(DefaultStmt *Terminator) {
Ted Kremenek93668002009-07-17 22:18:43 +00003658 if (Terminator->getSubStmt())
3659 addStmt(Terminator->getSubStmt());
Mike Stump11289f42009-09-09 15:08:12 +00003660
Ted Kremenek654c78f2008-02-13 22:05:39 +00003661 DefaultCaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003662
3663 if (!DefaultCaseBlock)
3664 DefaultCaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00003665
3666 // Default statements partition blocks, so this is the top of the basic block
3667 // we were processing (the "default:" is the label).
Ted Kremenekc1f9a282008-04-16 21:10:48 +00003668 DefaultCaseBlock->setLabel(Terminator);
Mike Stump11289f42009-09-09 15:08:12 +00003669
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003670 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003671 return nullptr;
Ted Kremenek654c78f2008-02-13 22:05:39 +00003672
Mike Stump31feda52009-07-17 01:31:16 +00003673 // Unlike case statements, we don't add the default block to the successors
3674 // for the switch statement immediately. This is done when we finish
3675 // processing the switch statement. This allows for the default case
3676 // (including a fall-through to the code after the switch statement) to always
3677 // be the last successor of a switch-terminated block.
3678
Ted Kremenek654c78f2008-02-13 22:05:39 +00003679 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003680 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003681
Ted Kremenek654c78f2008-02-13 22:05:39 +00003682 // This block is now the implicit successor of other blocks.
3683 Succ = DefaultCaseBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003684
3685 return DefaultCaseBlock;
Ted Kremenek9682be12008-02-13 21:46:34 +00003686}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003687
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003688CFGBlock *CFGBuilder::VisitCXXTryStmt(CXXTryStmt *Terminator) {
3689 // "try"/"catch" is a control-flow statement. Thus we stop processing the
3690 // current block.
Craig Topper25542942014-05-20 04:30:07 +00003691 CFGBlock *TrySuccessor = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003692
3693 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003694 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003695 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003696 TrySuccessor = Block;
3697 } else TrySuccessor = Succ;
3698
Mike Stump0bdba6c2010-01-20 01:15:34 +00003699 CFGBlock *PrevTryTerminatedBlock = TryTerminatedBlock;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003700
3701 // Create a new block that will contain the try statement.
Mike Stump845384a2010-01-20 01:30:58 +00003702 CFGBlock *NewTryTerminatedBlock = createBlock(false);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003703 // Add the terminator in the try block.
Mike Stump845384a2010-01-20 01:30:58 +00003704 NewTryTerminatedBlock->setTerminator(Terminator);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003705
Mike Stump0bdba6c2010-01-20 01:15:34 +00003706 bool HasCatchAll = false;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003707 for (unsigned h = 0; h <Terminator->getNumHandlers(); ++h) {
3708 // The code after the try is the implicit successor.
3709 Succ = TrySuccessor;
3710 CXXCatchStmt *CS = Terminator->getHandler(h);
Craig Topper25542942014-05-20 04:30:07 +00003711 if (CS->getExceptionDecl() == nullptr) {
Mike Stump0bdba6c2010-01-20 01:15:34 +00003712 HasCatchAll = true;
3713 }
Craig Topper25542942014-05-20 04:30:07 +00003714 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003715 CFGBlock *CatchBlock = VisitCXXCatchStmt(CS);
Craig Topper25542942014-05-20 04:30:07 +00003716 if (!CatchBlock)
3717 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003718 // Add this block to the list of successors for the block with the try
3719 // statement.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003720 addSuccessor(NewTryTerminatedBlock, CatchBlock);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003721 }
Mike Stump0bdba6c2010-01-20 01:15:34 +00003722 if (!HasCatchAll) {
3723 if (PrevTryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003724 addSuccessor(NewTryTerminatedBlock, PrevTryTerminatedBlock);
Mike Stump0bdba6c2010-01-20 01:15:34 +00003725 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003726 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
Mike Stump0bdba6c2010-01-20 01:15:34 +00003727 }
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003728
3729 // The code after the try is the implicit successor.
3730 Succ = TrySuccessor;
3731
Mike Stump845384a2010-01-20 01:30:58 +00003732 // Save the current "try" context.
Ted Kremenek6b9964d2011-08-23 23:05:07 +00003733 SaveAndRestore<CFGBlock*> save_try(TryTerminatedBlock, NewTryTerminatedBlock);
3734 cfg->addTryDispatchBlock(TryTerminatedBlock);
Mike Stump845384a2010-01-20 01:30:58 +00003735
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003736 assert(Terminator->getTryBlock() && "try must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00003737 Block = nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003738 return addStmt(Terminator->getTryBlock());
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003739}
3740
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003741CFGBlock *CFGBuilder::VisitCXXCatchStmt(CXXCatchStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003742 // CXXCatchStmt are treated like labels, so they are the first statement in a
3743 // block.
3744
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00003745 // Save local scope position because in case of exception variable ScopePos
3746 // won't be restored when traversing AST.
3747 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3748
3749 // Create local scope for possible exception variable.
3750 // Store scope position. Add implicit destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003751 if (VarDecl *VD = CS->getExceptionDecl()) {
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00003752 LocalScope::const_iterator BeginScopePos = ScopePos;
3753 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00003754 addAutomaticObjHandling(ScopePos, BeginScopePos, CS);
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00003755 }
3756
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003757 if (CS->getHandlerBlock())
3758 addStmt(CS->getHandlerBlock());
3759
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003760 CFGBlock *CatchBlock = Block;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003761 if (!CatchBlock)
3762 CatchBlock = createBlock();
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00003763
3764 // CXXCatchStmt is more than just a label. They have semantic meaning
3765 // as well, as they implicitly "initialize" the catch variable. Add
3766 // it to the CFG as a CFGElement so that the control-flow of these
3767 // semantics gets captured.
3768 appendStmt(CatchBlock, CS);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003769
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00003770 // Also add the CXXCatchStmt as a label, to mirror handling of regular
3771 // labels.
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003772 CatchBlock->setLabel(CS);
3773
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00003774 // Bail out if the CFG is bad.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003775 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003776 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003777
3778 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00003779 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003780
3781 return CatchBlock;
3782}
3783
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003784CFGBlock *CFGBuilder::VisitCXXForRangeStmt(CXXForRangeStmt *S) {
Richard Smith02e85f32011-04-14 22:09:26 +00003785 // C++0x for-range statements are specified as [stmt.ranged]:
3786 //
3787 // {
3788 // auto && __range = range-init;
3789 // for ( auto __begin = begin-expr,
3790 // __end = end-expr;
3791 // __begin != __end;
3792 // ++__begin ) {
3793 // for-range-declaration = *__begin;
3794 // statement
3795 // }
3796 // }
3797
3798 // Save local scope position before the addition of the implicit variables.
3799 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3800
3801 // Create local scopes and destructors for range, begin and end variables.
3802 if (Stmt *Range = S->getRangeStmt())
3803 addLocalScopeForStmt(Range);
Richard Smith01694c32016-03-20 10:33:40 +00003804 if (Stmt *Begin = S->getBeginStmt())
3805 addLocalScopeForStmt(Begin);
3806 if (Stmt *End = S->getEndStmt())
3807 addLocalScopeForStmt(End);
Matthias Gehre351c2182017-07-12 07:04:19 +00003808 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), S);
Richard Smith02e85f32011-04-14 22:09:26 +00003809
3810 LocalScope::const_iterator ContinueScopePos = ScopePos;
3811
3812 // "for" is a control-flow statement. Thus we stop processing the current
3813 // block.
Craig Topper25542942014-05-20 04:30:07 +00003814 CFGBlock *LoopSuccessor = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003815 if (Block) {
3816 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003817 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003818 LoopSuccessor = Block;
3819 } else
3820 LoopSuccessor = Succ;
3821
3822 // Save the current value for the break targets.
3823 // All breaks should go to the code following the loop.
3824 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
3825 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
3826
3827 // The block for the __begin != __end expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003828 CFGBlock *ConditionBlock = createBlock(false);
Richard Smith02e85f32011-04-14 22:09:26 +00003829 ConditionBlock->setTerminator(S);
3830
3831 // Now add the actual condition to the condition block.
3832 if (Expr *C = S->getCond()) {
3833 Block = ConditionBlock;
3834 CFGBlock *BeginConditionBlock = addStmt(C);
3835 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003836 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003837 assert(BeginConditionBlock == ConditionBlock &&
3838 "condition block in for-range was unexpectedly complex");
3839 (void)BeginConditionBlock;
3840 }
3841
3842 // The condition block is the implicit successor for the loop body as well as
3843 // any code above the loop.
3844 Succ = ConditionBlock;
3845
3846 // See if this is a known constant.
3847 TryResult KnownVal(true);
3848
3849 if (S->getCond())
3850 KnownVal = tryEvaluateBool(S->getCond());
3851
3852 // Now create the loop body.
3853 {
3854 assert(S->getBody());
3855
3856 // Save the current values for Block, Succ, and continue targets.
3857 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3858 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
3859
3860 // Generate increment code in its own basic block. This is the target of
3861 // continue statements.
Craig Topper25542942014-05-20 04:30:07 +00003862 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003863 Succ = addStmt(S->getInc());
Alexander Kornienkoff2046a2016-07-08 10:50:51 +00003864 if (badCFG)
3865 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003866 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
3867
3868 // The starting block for the loop increment is the block that should
3869 // represent the 'loop target' for looping back to the start of the loop.
3870 ContinueJumpTarget.block->setLoopTarget(S);
3871
3872 // Finish up the increment block and prepare to start the loop body.
3873 assert(Block);
3874 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003875 return nullptr;
3876 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00003877
3878 // Add implicit scope and dtors for loop variable.
3879 addLocalScopeAndDtors(S->getLoopVarStmt());
3880
3881 // Populate a new block to contain the loop body and loop variable.
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003882 addStmt(S->getBody());
Richard Smith02e85f32011-04-14 22:09:26 +00003883 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003884 return nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00003885 CFGBlock *LoopVarStmtBlock = addStmt(S->getLoopVarStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00003886 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003887 return nullptr;
3888
Richard Smith02e85f32011-04-14 22:09:26 +00003889 // This new body block is a successor to our condition block.
Craig Topper25542942014-05-20 04:30:07 +00003890 addSuccessor(ConditionBlock,
3891 KnownVal.isFalse() ? nullptr : LoopVarStmtBlock);
Richard Smith02e85f32011-04-14 22:09:26 +00003892 }
3893
3894 // Link up the condition block with the code that follows the loop (the
3895 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003896 addSuccessor(ConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Richard Smith02e85f32011-04-14 22:09:26 +00003897
3898 // Add the initialization statements.
3899 Block = createBlock();
Richard Smith01694c32016-03-20 10:33:40 +00003900 addStmt(S->getBeginStmt());
3901 addStmt(S->getEndStmt());
Richard Smith0c502d22011-04-18 15:49:25 +00003902 return addStmt(S->getRangeStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00003903}
3904
John McCall5d413782010-12-06 08:20:24 +00003905CFGBlock *CFGBuilder::VisitExprWithCleanups(ExprWithCleanups *E,
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003906 AddStmtChoice asc) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00003907 if (BuildOpts.AddTemporaryDtors) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003908 // If adding implicit destructors visit the full expression for adding
3909 // destructors of temporaries.
Manuel Klimekdeb02622014-08-08 07:37:13 +00003910 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00003911 VisitForTemporaryDtors(E->getSubExpr(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003912
3913 // Full expression has to be added as CFGStmt so it will be sequenced
3914 // before destructors of it's temporaries.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00003915 asc = asc.withAlwaysAdd(true);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00003916 }
3917 return Visit(E->getSubExpr(), asc);
3918}
3919
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003920CFGBlock *CFGBuilder::VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
3921 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003922 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003923 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003924 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003925
3926 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00003927 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003928 }
3929 return Visit(E->getSubExpr(), asc);
3930}
3931
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003932CFGBlock *CFGBuilder::VisitCXXConstructExpr(CXXConstructExpr *C,
3933 AddStmtChoice asc) {
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003934 autoCreateBlock();
Artem Dergachev41ffb302018-02-08 22:58:15 +00003935 appendConstructor(Block, C);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00003936
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003937 return VisitChildren(C);
3938}
3939
Jordan Rosec9176072014-01-13 17:59:19 +00003940CFGBlock *CFGBuilder::VisitCXXNewExpr(CXXNewExpr *NE,
3941 AddStmtChoice asc) {
Jordan Rosec9176072014-01-13 17:59:19 +00003942 autoCreateBlock();
3943 appendStmt(Block, NE);
Jordan Rose6f5f7192014-01-14 17:29:12 +00003944
Artem Dergachev41ffb302018-02-08 22:58:15 +00003945 EnterConstructionContextIfNecessary(
3946 NE, const_cast<CXXConstructExpr *>(NE->getConstructExpr()));
3947
Jordan Rosec9176072014-01-13 17:59:19 +00003948 if (NE->getInitializer())
Jordan Rose6f5f7192014-01-14 17:29:12 +00003949 Block = Visit(NE->getInitializer());
Artem Dergachev41ffb302018-02-08 22:58:15 +00003950
Jordan Rosec9176072014-01-13 17:59:19 +00003951 if (BuildOpts.AddCXXNewAllocator)
3952 appendNewAllocator(Block, NE);
Artem Dergachev41ffb302018-02-08 22:58:15 +00003953
Jordan Rosec9176072014-01-13 17:59:19 +00003954 if (NE->isArray())
Jordan Rose6f5f7192014-01-14 17:29:12 +00003955 Block = Visit(NE->getArraySize());
Artem Dergachev41ffb302018-02-08 22:58:15 +00003956
Jordan Rosec9176072014-01-13 17:59:19 +00003957 for (CXXNewExpr::arg_iterator I = NE->placement_arg_begin(),
3958 E = NE->placement_arg_end(); I != E; ++I)
Jordan Rose6f5f7192014-01-14 17:29:12 +00003959 Block = Visit(*I);
Artem Dergachev41ffb302018-02-08 22:58:15 +00003960
Jordan Rosec9176072014-01-13 17:59:19 +00003961 return Block;
3962}
Jordan Rosed2f40792013-09-03 17:00:57 +00003963
3964CFGBlock *CFGBuilder::VisitCXXDeleteExpr(CXXDeleteExpr *DE,
3965 AddStmtChoice asc) {
3966 autoCreateBlock();
3967 appendStmt(Block, DE);
3968 QualType DTy = DE->getDestroyedType();
Martin Bohmef44cde82016-12-05 11:33:19 +00003969 if (!DTy.isNull()) {
3970 DTy = DTy.getNonReferenceType();
3971 CXXRecordDecl *RD = Context->getBaseElementType(DTy)->getAsCXXRecordDecl();
3972 if (RD) {
3973 if (RD->isCompleteDefinition() && !RD->hasTrivialDestructor())
3974 appendDeleteDtor(Block, RD, DE);
3975 }
Jordan Rosed2f40792013-09-03 17:00:57 +00003976 }
3977
3978 return VisitChildren(DE);
3979}
3980
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003981CFGBlock *CFGBuilder::VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
3982 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003983 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003984 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003985 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003986 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00003987 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003988 }
3989 return Visit(E->getSubExpr(), asc);
3990}
3991
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003992CFGBlock *CFGBuilder::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
3993 AddStmtChoice asc) {
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003994 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003995 appendStmt(Block, C);
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00003996 return VisitChildren(C);
3997}
3998
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00003999CFGBlock *CFGBuilder::VisitImplicitCastExpr(ImplicitCastExpr *E,
4000 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004001 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004002 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004003 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004004 }
Ted Kremenek8219b822010-12-16 07:46:53 +00004005 return Visit(E->getSubExpr(), AddStmtChoice());
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004006}
4007
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004008CFGBlock *CFGBuilder::VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00004009 // Lazily create the indirect-goto dispatch block if there isn't one already.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004010 CFGBlock *IBlock = cfg->getIndirectGotoBlock();
Mike Stump31feda52009-07-17 01:31:16 +00004011
Ted Kremenekeda180e22007-08-28 19:26:49 +00004012 if (!IBlock) {
4013 IBlock = createBlock(false);
4014 cfg->setIndirectGotoBlock(IBlock);
4015 }
Mike Stump31feda52009-07-17 01:31:16 +00004016
Ted Kremenekeda180e22007-08-28 19:26:49 +00004017 // IndirectGoto is a control-flow statement. Thus we stop processing the
4018 // current block and create a new one.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004019 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004020 return nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00004021
Ted Kremenekeda180e22007-08-28 19:26:49 +00004022 Block = createBlock(false);
4023 Block->setTerminator(I);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004024 addSuccessor(Block, IBlock);
Ted Kremenekeda180e22007-08-28 19:26:49 +00004025 return addStmt(I->getTarget());
4026}
4027
Manuel Klimekb5616c92014-08-07 10:42:17 +00004028CFGBlock *CFGBuilder::VisitForTemporaryDtors(Stmt *E, bool BindToTemporary,
4029 TempDtorContext &Context) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004030 assert(BuildOpts.AddImplicitDtors && BuildOpts.AddTemporaryDtors);
4031
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004032tryAgain:
4033 if (!E) {
4034 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00004035 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004036 }
4037 switch (E->getStmtClass()) {
4038 default:
Manuel Klimekb5616c92014-08-07 10:42:17 +00004039 return VisitChildrenForTemporaryDtors(E, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004040
4041 case Stmt::BinaryOperatorClass:
Manuel Klimekb5616c92014-08-07 10:42:17 +00004042 return VisitBinaryOperatorForTemporaryDtors(cast<BinaryOperator>(E),
4043 Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004044
4045 case Stmt::CXXBindTemporaryExprClass:
4046 return VisitCXXBindTemporaryExprForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004047 cast<CXXBindTemporaryExpr>(E), BindToTemporary, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004048
John McCallc07a0c72011-02-17 10:25:35 +00004049 case Stmt::BinaryConditionalOperatorClass:
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004050 case Stmt::ConditionalOperatorClass:
4051 return VisitConditionalOperatorForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004052 cast<AbstractConditionalOperator>(E), BindToTemporary, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004053
4054 case Stmt::ImplicitCastExprClass:
4055 // For implicit cast we want BindToTemporary to be passed further.
4056 E = cast<CastExpr>(E)->getSubExpr();
4057 goto tryAgain;
4058
Manuel Klimekb0042c42014-07-30 08:34:42 +00004059 case Stmt::CXXFunctionalCastExprClass:
4060 // For functional cast we want BindToTemporary to be passed further.
4061 E = cast<CXXFunctionalCastExpr>(E)->getSubExpr();
4062 goto tryAgain;
4063
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004064 case Stmt::ParenExprClass:
4065 E = cast<ParenExpr>(E)->getSubExpr();
4066 goto tryAgain;
Richard Smith4137af22014-07-27 05:12:49 +00004067
Manuel Klimekb0042c42014-07-30 08:34:42 +00004068 case Stmt::MaterializeTemporaryExprClass: {
4069 const MaterializeTemporaryExpr* MTE = cast<MaterializeTemporaryExpr>(E);
4070 BindToTemporary = (MTE->getStorageDuration() != SD_FullExpression);
4071 SmallVector<const Expr *, 2> CommaLHSs;
4072 SmallVector<SubobjectAdjustment, 2> Adjustments;
4073 // Find the expression whose lifetime needs to be extended.
4074 E = const_cast<Expr *>(
4075 cast<MaterializeTemporaryExpr>(E)
4076 ->GetTemporaryExpr()
4077 ->skipRValueSubobjectAdjustments(CommaLHSs, Adjustments));
4078 // Visit the skipped comma operator left-hand sides for other temporaries.
4079 for (const Expr *CommaLHS : CommaLHSs) {
4080 VisitForTemporaryDtors(const_cast<Expr *>(CommaLHS),
Manuel Klimekb5616c92014-08-07 10:42:17 +00004081 /*BindToTemporary=*/false, Context);
Manuel Klimekb0042c42014-07-30 08:34:42 +00004082 }
Douglas Gregorfe314812011-06-21 17:03:29 +00004083 goto tryAgain;
Manuel Klimekb0042c42014-07-30 08:34:42 +00004084 }
Richard Smith4137af22014-07-27 05:12:49 +00004085
4086 case Stmt::BlockExprClass:
4087 // Don't recurse into blocks; their subexpressions don't get evaluated
4088 // here.
4089 return Block;
4090
4091 case Stmt::LambdaExprClass: {
4092 // For lambda expressions, only recurse into the capture initializers,
4093 // and not the body.
4094 auto *LE = cast<LambdaExpr>(E);
4095 CFGBlock *B = Block;
4096 for (Expr *Init : LE->capture_inits()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004097 if (CFGBlock *R = VisitForTemporaryDtors(
4098 Init, /*BindToTemporary=*/false, Context))
Richard Smith4137af22014-07-27 05:12:49 +00004099 B = R;
4100 }
4101 return B;
4102 }
4103
4104 case Stmt::CXXDefaultArgExprClass:
4105 E = cast<CXXDefaultArgExpr>(E)->getExpr();
4106 goto tryAgain;
4107
4108 case Stmt::CXXDefaultInitExprClass:
4109 E = cast<CXXDefaultInitExpr>(E)->getExpr();
4110 goto tryAgain;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004111 }
4112}
4113
Manuel Klimekb5616c92014-08-07 10:42:17 +00004114CFGBlock *CFGBuilder::VisitChildrenForTemporaryDtors(Stmt *E,
4115 TempDtorContext &Context) {
4116 if (isa<LambdaExpr>(E)) {
4117 // Do not visit the children of lambdas; they have their own CFGs.
4118 return Block;
4119 }
4120
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004121 // When visiting children for destructors we want to visit them in reverse
Ted Kremenek8ae67872013-02-05 22:00:19 +00004122 // order that they will appear in the CFG. Because the CFG is built
4123 // bottom-up, this means we visit them in their natural order, which
4124 // reverses them in the CFG.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004125 CFGBlock *B = Block;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004126 for (Stmt *Child : E->children())
4127 if (Child)
Manuel Klimekb5616c92014-08-07 10:42:17 +00004128 if (CFGBlock *R = VisitForTemporaryDtors(Child, false, Context))
Ted Kremenek8ae67872013-02-05 22:00:19 +00004129 B = R;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004130
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004131 return B;
4132}
4133
Manuel Klimekb5616c92014-08-07 10:42:17 +00004134CFGBlock *CFGBuilder::VisitBinaryOperatorForTemporaryDtors(
4135 BinaryOperator *E, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004136 if (E->isLogicalOp()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004137 VisitForTemporaryDtors(E->getLHS(), false, Context);
Manuel Klimekedf925b92014-08-07 18:44:19 +00004138 TryResult RHSExecuted = tryEvaluateBool(E->getLHS());
4139 if (RHSExecuted.isKnown() && E->getOpcode() == BO_LOr)
4140 RHSExecuted.negate();
Manuel Klimek7c030132014-08-07 16:05:51 +00004141
Manuel Klimekedf925b92014-08-07 18:44:19 +00004142 // We do not know at CFG-construction time whether the right-hand-side was
4143 // executed, thus we add a branch node that depends on the temporary
4144 // constructor call.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004145 TempDtorContext RHSContext(
4146 bothKnownTrue(Context.KnownExecuted, RHSExecuted));
Manuel Klimekedf925b92014-08-07 18:44:19 +00004147 VisitForTemporaryDtors(E->getRHS(), false, RHSContext);
Manuel Klimekdeb02622014-08-08 07:37:13 +00004148 InsertTempDtorDecisionBlock(RHSContext);
Manuel Klimek7c030132014-08-07 16:05:51 +00004149
Manuel Klimekb5616c92014-08-07 10:42:17 +00004150 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004151 }
4152
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004153 if (E->isAssignmentOp()) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004154 // For assignment operator (=) LHS expression is visited
4155 // before RHS expression. For destructors visit them in reverse order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004156 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
4157 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004158 return LHSBlock ? LHSBlock : RHSBlock;
4159 }
4160
4161 // For any other binary operator RHS expression is visited before
4162 // LHS expression (order of children). For destructors visit them in reverse
4163 // order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004164 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
4165 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004166 return RHSBlock ? RHSBlock : LHSBlock;
4167}
4168
4169CFGBlock *CFGBuilder::VisitCXXBindTemporaryExprForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004170 CXXBindTemporaryExpr *E, bool BindToTemporary, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004171 // First add destructors for temporaries in subexpression.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004172 CFGBlock *B = VisitForTemporaryDtors(E->getSubExpr(), false, Context);
Zhongxing Xufee455f2010-11-14 15:23:50 +00004173 if (!BindToTemporary) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004174 // If lifetime of temporary is not prolonged (by assigning to constant
4175 // reference) add destructor for it.
Chandler Carruthad747252011-09-13 06:09:01 +00004176
Chandler Carruthad747252011-09-13 06:09:01 +00004177 const CXXDestructorDecl *Dtor = E->getTemporary()->getDestructor();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004178
Richard Trieu95a192a2015-05-28 00:14:02 +00004179 if (Dtor->getParent()->isAnyDestructorNoReturn()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004180 // If the destructor is marked as a no-return destructor, we need to
4181 // create a new block for the destructor which does not have as a
4182 // successor anything built thus far. Control won't flow out of this
4183 // block.
4184 if (B) Succ = B;
Chandler Carrutha70991b2011-09-13 09:13:49 +00004185 Block = createNoReturnBlock();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004186 } else if (Context.needsTempDtorBranch()) {
4187 // If we need to introduce a branch, we add a new block that we will hook
4188 // up to a decision block later.
4189 if (B) Succ = B;
4190 Block = createBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004191 } else {
Chandler Carruthad747252011-09-13 06:09:01 +00004192 autoCreateBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004193 }
Manuel Klimekb5616c92014-08-07 10:42:17 +00004194 if (Context.needsTempDtorBranch()) {
4195 Context.setDecisionPoint(Succ, E);
4196 }
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004197 appendTemporaryDtor(Block, E);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004198
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004199 B = Block;
4200 }
4201 return B;
4202}
4203
Manuel Klimekb5616c92014-08-07 10:42:17 +00004204void CFGBuilder::InsertTempDtorDecisionBlock(const TempDtorContext &Context,
4205 CFGBlock *FalseSucc) {
4206 if (!Context.TerminatorExpr) {
4207 // If no temporary was found, we do not need to insert a decision point.
4208 return;
4209 }
4210 assert(Context.TerminatorExpr);
4211 CFGBlock *Decision = createBlock(false);
4212 Decision->setTerminator(CFGTerminator(Context.TerminatorExpr, true));
Manuel Klimekdeb02622014-08-08 07:37:13 +00004213 addSuccessor(Decision, Block, !Context.KnownExecuted.isFalse());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004214 addSuccessor(Decision, FalseSucc ? FalseSucc : Context.Succ,
Manuel Klimekdeb02622014-08-08 07:37:13 +00004215 !Context.KnownExecuted.isTrue());
Manuel Klimekb5616c92014-08-07 10:42:17 +00004216 Block = Decision;
4217}
4218
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004219CFGBlock *CFGBuilder::VisitConditionalOperatorForTemporaryDtors(
Manuel Klimekb5616c92014-08-07 10:42:17 +00004220 AbstractConditionalOperator *E, bool BindToTemporary,
4221 TempDtorContext &Context) {
4222 VisitForTemporaryDtors(E->getCond(), false, Context);
4223 CFGBlock *ConditionBlock = Block;
4224 CFGBlock *ConditionSucc = Succ;
Manuel Klimek0ce91082014-08-07 14:25:43 +00004225 TryResult ConditionVal = tryEvaluateBool(E->getCond());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004226 TryResult NegatedVal = ConditionVal;
4227 if (NegatedVal.isKnown()) NegatedVal.negate();
Manuel Klimekcadc6032014-08-07 17:02:21 +00004228
Manuel Klimekdeb02622014-08-08 07:37:13 +00004229 TempDtorContext TrueContext(
4230 bothKnownTrue(Context.KnownExecuted, ConditionVal));
Manuel Klimekcadc6032014-08-07 17:02:21 +00004231 VisitForTemporaryDtors(E->getTrueExpr(), BindToTemporary, TrueContext);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004232 CFGBlock *TrueBlock = Block;
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004233
Manuel Klimekb5616c92014-08-07 10:42:17 +00004234 Block = ConditionBlock;
4235 Succ = ConditionSucc;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004236 TempDtorContext FalseContext(
4237 bothKnownTrue(Context.KnownExecuted, NegatedVal));
Manuel Klimekcadc6032014-08-07 17:02:21 +00004238 VisitForTemporaryDtors(E->getFalseExpr(), BindToTemporary, FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004239
Manuel Klimekb5616c92014-08-07 10:42:17 +00004240 if (TrueContext.TerminatorExpr && FalseContext.TerminatorExpr) {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004241 InsertTempDtorDecisionBlock(FalseContext, TrueBlock);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004242 } else if (TrueContext.TerminatorExpr) {
4243 Block = TrueBlock;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004244 InsertTempDtorDecisionBlock(TrueContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004245 } else {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004246 InsertTempDtorDecisionBlock(FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004247 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004248 return Block;
4249}
4250
Mike Stump31feda52009-07-17 01:31:16 +00004251/// createBlock - Constructs and adds a new CFGBlock to the CFG. The block has
4252/// no successors or predecessors. If this is the first block created in the
4253/// CFG, it is automatically set to be the Entry and Exit of the CFG.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004254CFGBlock *CFG::createBlock() {
Ted Kremenek889073f2007-08-23 16:51:22 +00004255 bool first_block = begin() == end();
4256
4257 // Create the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004258 CFGBlock *Mem = getAllocator().Allocate<CFGBlock>();
Anna Zaks02a1fc12011-12-05 21:33:11 +00004259 new (Mem) CFGBlock(NumBlockIDs++, BlkBVC, this);
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004260 Blocks.push_back(Mem, BlkBVC);
Ted Kremenek889073f2007-08-23 16:51:22 +00004261
4262 // If this is the first block, set it as the Entry and Exit.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004263 if (first_block)
4264 Entry = Exit = &back();
Ted Kremenek889073f2007-08-23 16:51:22 +00004265
4266 // Return the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004267 return &back();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004268}
4269
David Blaikiee90195c2014-08-29 18:53:26 +00004270/// buildCFG - Constructs a CFG from an AST.
4271std::unique_ptr<CFG> CFG::buildCFG(const Decl *D, Stmt *Statement,
4272 ASTContext *C, const BuildOptions &BO) {
Ted Kremenekf9d82902011-03-10 01:14:05 +00004273 CFGBuilder Builder(C, BO);
4274 return Builder.buildCFG(D, Statement);
Ted Kremenek889073f2007-08-23 16:51:22 +00004275}
4276
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004277const CXXDestructorDecl *
4278CFGImplicitDtor::getDestructorDecl(ASTContext &astContext) const {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004279 switch (getKind()) {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004280 case CFGElement::Initializer:
Jordan Rosec9176072014-01-13 17:59:19 +00004281 case CFGElement::NewAllocator:
Peter Szecsi999a25f2017-08-19 11:19:16 +00004282 case CFGElement::LoopExit:
Matthias Gehre351c2182017-07-12 07:04:19 +00004283 case CFGElement::LifetimeEnds:
Artem Dergachev41ffb302018-02-08 22:58:15 +00004284 case CFGElement::Statement:
4285 case CFGElement::Constructor:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004286 llvm_unreachable("getDestructorDecl should only be used with "
4287 "ImplicitDtors");
4288 case CFGElement::AutomaticObjectDtor: {
David Blaikie2a01f5d2013-02-21 20:58:29 +00004289 const VarDecl *var = castAs<CFGAutomaticObjDtor>().getVarDecl();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004290 QualType ty = var->getType();
Devin Coughlin6eb1ca72016-08-02 21:07:23 +00004291
4292 // FIXME: See CFGBuilder::addLocalScopeForVarDecl.
4293 //
4294 // Lifetime-extending constructs are handled here. This works for a single
4295 // temporary in an initializer expression.
4296 if (ty->isReferenceType()) {
4297 if (const Expr *Init = var->getInit()) {
4298 ty = getReferenceInitTemporaryType(astContext, Init);
4299 }
4300 }
4301
Ted Kremeneke7d78882012-03-19 23:48:41 +00004302 while (const ArrayType *arrayType = astContext.getAsArrayType(ty)) {
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004303 ty = arrayType->getElementType();
4304 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004305 const RecordType *recordType = ty->getAs<RecordType>();
4306 const CXXRecordDecl *classDecl =
Ted Kremenek1676a042011-03-03 01:01:03 +00004307 cast<CXXRecordDecl>(recordType->getDecl());
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004308 return classDecl->getDestructor();
4309 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004310 case CFGElement::DeleteDtor: {
4311 const CXXDeleteExpr *DE = castAs<CFGDeleteDtor>().getDeleteExpr();
4312 QualType DTy = DE->getDestroyedType();
4313 DTy = DTy.getNonReferenceType();
4314 const CXXRecordDecl *classDecl =
4315 astContext.getBaseElementType(DTy)->getAsCXXRecordDecl();
4316 return classDecl->getDestructor();
4317 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004318 case CFGElement::TemporaryDtor: {
4319 const CXXBindTemporaryExpr *bindExpr =
David Blaikie2a01f5d2013-02-21 20:58:29 +00004320 castAs<CFGTemporaryDtor>().getBindTemporaryExpr();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004321 const CXXTemporary *temp = bindExpr->getTemporary();
4322 return temp->getDestructor();
4323 }
4324 case CFGElement::BaseDtor:
4325 case CFGElement::MemberDtor:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004326 // Not yet supported.
Craig Topper25542942014-05-20 04:30:07 +00004327 return nullptr;
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004328 }
Ted Kremenek1676a042011-03-03 01:01:03 +00004329 llvm_unreachable("getKind() returned bogus value");
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004330}
4331
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004332bool CFGImplicitDtor::isNoReturn(ASTContext &astContext) const {
Richard Smith10876ef2013-01-17 01:30:42 +00004333 if (const CXXDestructorDecl *DD = getDestructorDecl(astContext))
4334 return DD->isNoReturn();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004335 return false;
Ted Kremenek96a7a592011-03-01 03:15:10 +00004336}
4337
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00004338//===----------------------------------------------------------------------===//
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004339// CFGBlock operations.
Ted Kremenekb0371852010-09-09 00:06:04 +00004340//===----------------------------------------------------------------------===//
4341
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004342CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, bool IsReachable)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004343 : ReachableBlock(IsReachable ? B : nullptr),
4344 UnreachableBlock(!IsReachable ? B : nullptr,
4345 B && IsReachable ? AB_Normal : AB_Unreachable) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004346
4347CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, CFGBlock *AlternateBlock)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004348 : ReachableBlock(B),
4349 UnreachableBlock(B == AlternateBlock ? nullptr : AlternateBlock,
4350 B == AlternateBlock ? AB_Alternate : AB_Normal) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004351
4352void CFGBlock::addSuccessor(AdjacentBlock Succ,
4353 BumpVectorContext &C) {
4354 if (CFGBlock *B = Succ.getReachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004355 B->Preds.push_back(AdjacentBlock(this, Succ.isReachable()), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004356
4357 if (CFGBlock *UnreachableB = Succ.getPossiblyUnreachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004358 UnreachableB->Preds.push_back(AdjacentBlock(this, false), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004359
4360 Succs.push_back(Succ, C);
4361}
4362
Ted Kremenekb0371852010-09-09 00:06:04 +00004363bool CFGBlock::FilterEdge(const CFGBlock::FilterOptions &F,
Ted Kremenekf146cd12010-09-09 02:57:48 +00004364 const CFGBlock *From, const CFGBlock *To) {
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004365 if (F.IgnoreNullPredecessors && !From)
4366 return true;
4367
4368 if (To && From && F.IgnoreDefaultsWithCoveredEnums) {
Ted Kremenekb0371852010-09-09 00:06:04 +00004369 // If the 'To' has no label or is labeled but the label isn't a
4370 // CaseStmt then filter this edge.
4371 if (const SwitchStmt *S =
Ted Kremenek89794742011-03-07 22:04:39 +00004372 dyn_cast_or_null<SwitchStmt>(From->getTerminator().getStmt())) {
Ted Kremenekb0371852010-09-09 00:06:04 +00004373 if (S->isAllEnumCasesCovered()) {
Ted Kremenek89794742011-03-07 22:04:39 +00004374 const Stmt *L = To->getLabel();
4375 if (!L || !isa<CaseStmt>(L))
4376 return true;
Ted Kremenekb0371852010-09-09 00:06:04 +00004377 }
4378 }
4379 }
4380
4381 return false;
4382}
4383
4384//===----------------------------------------------------------------------===//
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004385// CFG pretty printing
4386//===----------------------------------------------------------------------===//
4387
Ted Kremenek7e776b12007-08-22 18:22:34 +00004388namespace {
4389
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00004390class StmtPrinterHelper : public PrinterHelper {
Eugene Zelenko38c70522017-12-07 21:55:09 +00004391 using StmtMapTy = llvm::DenseMap<const Stmt *, std::pair<unsigned, unsigned>>;
4392 using DeclMapTy = llvm::DenseMap<const Decl *, std::pair<unsigned, unsigned>>;
4393
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004394 StmtMapTy StmtMap;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004395 DeclMapTy DeclMap;
Eugene Zelenko38c70522017-12-07 21:55:09 +00004396 signed currentBlock = 0;
4397 unsigned currStmt = 0;
Chris Lattnerc61089a2009-06-30 01:26:17 +00004398 const LangOptions &LangOpts;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004399
Eugene Zelenko38c70522017-12-07 21:55:09 +00004400public:
Chris Lattnerc61089a2009-06-30 01:26:17 +00004401 StmtPrinterHelper(const CFG* cfg, const LangOptions &LO)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004402 : LangOpts(LO) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004403 for (CFG::const_iterator I = cfg->begin(), E = cfg->end(); I != E; ++I ) {
4404 unsigned j = 1;
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004405 for (CFGBlock::const_iterator BI = (*I)->begin(), BEnd = (*I)->end() ;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004406 BI != BEnd; ++BI, ++j ) {
David Blaikie00be69a2013-02-23 00:29:34 +00004407 if (Optional<CFGStmt> SE = BI->getAs<CFGStmt>()) {
4408 const Stmt *stmt= SE->getStmt();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004409 std::pair<unsigned, unsigned> P((*I)->getBlockID(), j);
Ted Kremenek96a7a592011-03-01 03:15:10 +00004410 StmtMap[stmt] = P;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004411
Ted Kremenek96a7a592011-03-01 03:15:10 +00004412 switch (stmt->getStmtClass()) {
4413 case Stmt::DeclStmtClass:
Artem Dergachev41ffb302018-02-08 22:58:15 +00004414 DeclMap[cast<DeclStmt>(stmt)->getSingleDecl()] = P;
4415 break;
Ted Kremenek96a7a592011-03-01 03:15:10 +00004416 case Stmt::IfStmtClass: {
4417 const VarDecl *var = cast<IfStmt>(stmt)->getConditionVariable();
4418 if (var)
4419 DeclMap[var] = P;
4420 break;
4421 }
4422 case Stmt::ForStmtClass: {
4423 const VarDecl *var = cast<ForStmt>(stmt)->getConditionVariable();
4424 if (var)
4425 DeclMap[var] = P;
4426 break;
4427 }
4428 case Stmt::WhileStmtClass: {
4429 const VarDecl *var =
4430 cast<WhileStmt>(stmt)->getConditionVariable();
4431 if (var)
4432 DeclMap[var] = P;
4433 break;
4434 }
4435 case Stmt::SwitchStmtClass: {
4436 const VarDecl *var =
4437 cast<SwitchStmt>(stmt)->getConditionVariable();
4438 if (var)
4439 DeclMap[var] = P;
4440 break;
4441 }
4442 case Stmt::CXXCatchStmtClass: {
4443 const VarDecl *var =
4444 cast<CXXCatchStmt>(stmt)->getExceptionDecl();
4445 if (var)
4446 DeclMap[var] = P;
4447 break;
4448 }
4449 default:
4450 break;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004451 }
4452 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004453 }
Zhongxing Xu2cd7a782010-09-16 01:25:47 +00004454 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004455 }
Mike Stump31feda52009-07-17 01:31:16 +00004456
Eugene Zelenko38c70522017-12-07 21:55:09 +00004457 ~StmtPrinterHelper() override = default;
Mike Stump31feda52009-07-17 01:31:16 +00004458
Chris Lattnerc61089a2009-06-30 01:26:17 +00004459 const LangOptions &getLangOpts() const { return LangOpts; }
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004460 void setBlockID(signed i) { currentBlock = i; }
Ted Kremenekd94854a2012-08-22 06:26:15 +00004461 void setStmtID(unsigned i) { currStmt = i; }
Mike Stump31feda52009-07-17 01:31:16 +00004462
Craig Topperb45acb82014-03-14 06:02:07 +00004463 bool handledStmt(Stmt *S, raw_ostream &OS) override {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004464 StmtMapTy::iterator I = StmtMap.find(S);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004465
4466 if (I == StmtMap.end())
4467 return false;
Mike Stump31feda52009-07-17 01:31:16 +00004468
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004469 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00004470 && I->second.second == currStmt) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004471 return false;
Ted Kremenek60983dc2010-01-19 20:52:05 +00004472 }
Mike Stump31feda52009-07-17 01:31:16 +00004473
Ted Kremenek60983dc2010-01-19 20:52:05 +00004474 OS << "[B" << I->second.first << "." << I->second.second << "]";
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004475 return true;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004476 }
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004477
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004478 bool handleDecl(const Decl *D, raw_ostream &OS) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004479 DeclMapTy::iterator I = DeclMap.find(D);
4480
4481 if (I == DeclMap.end())
4482 return false;
4483
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004484 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00004485 && I->second.second == currStmt) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004486 return false;
4487 }
4488
4489 OS << "[B" << I->second.first << "." << I->second.second << "]";
4490 return true;
4491 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004492};
4493
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00004494class CFGBlockTerminatorPrint
Eugene Zelenko38c70522017-12-07 21:55:09 +00004495 : public StmtVisitor<CFGBlockTerminatorPrint,void> {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004496 raw_ostream &OS;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004497 StmtPrinterHelper* Helper;
Douglas Gregor7de59662009-05-29 20:38:28 +00004498 PrintingPolicy Policy;
Eugene Zelenko38c70522017-12-07 21:55:09 +00004499
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004500public:
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004501 CFGBlockTerminatorPrint(raw_ostream &os, StmtPrinterHelper* helper,
Chris Lattnerc61089a2009-06-30 01:26:17 +00004502 const PrintingPolicy &Policy)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004503 : OS(os), Helper(helper), Policy(Policy) {
Ted Kremenek5d0fb1e2013-12-11 23:44:05 +00004504 this->Policy.IncludeNewlines = false;
4505 }
Mike Stump31feda52009-07-17 01:31:16 +00004506
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004507 void VisitIfStmt(IfStmt *I) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004508 OS << "if ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004509 if (Stmt *C = I->getCond())
4510 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00004511 }
Mike Stump31feda52009-07-17 01:31:16 +00004512
Ted Kremenek9aae5132007-08-23 21:42:29 +00004513 // Default case.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004514 void VisitStmt(Stmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00004515 Terminator->printPretty(OS, Helper, Policy);
4516 }
4517
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00004518 void VisitDeclStmt(DeclStmt *DS) {
4519 VarDecl *VD = cast<VarDecl>(DS->getSingleDecl());
4520 OS << "static init " << VD->getName();
4521 }
4522
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004523 void VisitForStmt(ForStmt *F) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004524 OS << "for (" ;
Ted Kremenek60983dc2010-01-19 20:52:05 +00004525 if (F->getInit())
4526 OS << "...";
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00004527 OS << "; ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004528 if (Stmt *C = F->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004529 C->printPretty(OS, Helper, Policy);
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00004530 OS << "; ";
Ted Kremenek60983dc2010-01-19 20:52:05 +00004531 if (F->getInc())
4532 OS << "...";
Ted Kremenek15647632008-01-30 23:02:42 +00004533 OS << ")";
Ted Kremenek9aae5132007-08-23 21:42:29 +00004534 }
Mike Stump31feda52009-07-17 01:31:16 +00004535
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004536 void VisitWhileStmt(WhileStmt *W) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004537 OS << "while " ;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004538 if (Stmt *C = W->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004539 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00004540 }
Mike Stump31feda52009-07-17 01:31:16 +00004541
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004542 void VisitDoStmt(DoStmt *D) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00004543 OS << "do ... while ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004544 if (Stmt *C = D->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00004545 C->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00004546 }
Mike Stump31feda52009-07-17 01:31:16 +00004547
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004548 void VisitSwitchStmt(SwitchStmt *Terminator) {
Ted Kremenek9e248872007-08-27 21:27:44 +00004549 OS << "switch ";
Douglas Gregor7de59662009-05-29 20:38:28 +00004550 Terminator->getCond()->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00004551 }
Mike Stump31feda52009-07-17 01:31:16 +00004552
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004553 void VisitCXXTryStmt(CXXTryStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004554 OS << "try ...";
4555 }
4556
Nico Weber699670e2017-08-23 15:33:16 +00004557 void VisitSEHTryStmt(SEHTryStmt *CS) {
4558 OS << "__try ...";
4559 }
4560
John McCallc07a0c72011-02-17 10:25:35 +00004561 void VisitAbstractConditionalOperator(AbstractConditionalOperator* C) {
Richard Trieuddd01ce2014-06-09 22:53:25 +00004562 if (Stmt *Cond = C->getCond())
4563 Cond->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004564 OS << " ? ... : ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004565 }
Mike Stump31feda52009-07-17 01:31:16 +00004566
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004567 void VisitChooseExpr(ChooseExpr *C) {
Ted Kremenek391f94a2007-08-31 22:29:13 +00004568 OS << "__builtin_choose_expr( ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004569 if (Stmt *Cond = C->getCond())
4570 Cond->printPretty(OS, Helper, Policy);
Ted Kremenek15647632008-01-30 23:02:42 +00004571 OS << " )";
Ted Kremenek391f94a2007-08-31 22:29:13 +00004572 }
Mike Stump31feda52009-07-17 01:31:16 +00004573
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004574 void VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004575 OS << "goto *";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004576 if (Stmt *T = I->getTarget())
4577 T->printPretty(OS, Helper, Policy);
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004578 }
Mike Stump31feda52009-07-17 01:31:16 +00004579
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004580 void VisitBinaryOperator(BinaryOperator* B) {
4581 if (!B->isLogicalOp()) {
4582 VisitExpr(B);
4583 return;
4584 }
Mike Stump31feda52009-07-17 01:31:16 +00004585
Richard Trieuddd01ce2014-06-09 22:53:25 +00004586 if (B->getLHS())
4587 B->getLHS()->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004588
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004589 switch (B->getOpcode()) {
John McCalle3027922010-08-25 11:45:40 +00004590 case BO_LOr:
Ted Kremenek15647632008-01-30 23:02:42 +00004591 OS << " || ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004592 return;
John McCalle3027922010-08-25 11:45:40 +00004593 case BO_LAnd:
Ted Kremenek15647632008-01-30 23:02:42 +00004594 OS << " && ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004595 return;
4596 default:
David Blaikie83d382b2011-09-23 05:06:16 +00004597 llvm_unreachable("Invalid logical operator.");
Mike Stump31feda52009-07-17 01:31:16 +00004598 }
Ted Kremenek7f7dd762007-08-31 21:49:40 +00004599 }
Mike Stump31feda52009-07-17 01:31:16 +00004600
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004601 void VisitExpr(Expr *E) {
Douglas Gregor7de59662009-05-29 20:38:28 +00004602 E->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00004603 }
Ted Kremenekfcc14172014-03-08 02:22:29 +00004604
4605public:
4606 void print(CFGTerminator T) {
4607 if (T.isTemporaryDtorsBranch())
4608 OS << "(Temp Dtor) ";
4609 Visit(T.getStmt());
4610 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00004611};
Eugene Zelenko38c70522017-12-07 21:55:09 +00004612
4613} // namespace
Chris Lattnerc61089a2009-06-30 01:26:17 +00004614
Artem Dergachev5a281bb2018-02-10 02:18:04 +00004615static void print_initializer(raw_ostream &OS, StmtPrinterHelper &Helper,
4616 const CXXCtorInitializer *I) {
4617 if (I->isBaseInitializer())
4618 OS << I->getBaseClass()->getAsCXXRecordDecl()->getName();
4619 else if (I->isDelegatingInitializer())
4620 OS << I->getTypeSourceInfo()->getType()->getAsCXXRecordDecl()->getName();
4621 else
4622 OS << I->getAnyMember()->getName();
4623 OS << "(";
4624 if (Expr *IE = I->getInit())
4625 IE->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
4626 OS << ")";
4627
4628 if (I->isBaseInitializer())
4629 OS << " (Base initializer)";
4630 else if (I->isDelegatingInitializer())
4631 OS << " (Delegating initializer)";
4632 else
4633 OS << " (Member initializer)";
4634}
4635
Aaron Ballmanff924b02013-11-18 20:11:50 +00004636static void print_elem(raw_ostream &OS, StmtPrinterHelper &Helper,
Mike Stump92244b02010-01-19 22:00:14 +00004637 const CFGElement &E) {
David Blaikie00be69a2013-02-23 00:29:34 +00004638 if (Optional<CFGStmt> CS = E.getAs<CFGStmt>()) {
4639 const Stmt *S = CS->getStmt();
Richard Trieuddd01ce2014-06-09 22:53:25 +00004640 assert(S != nullptr && "Expecting non-null Stmt");
4641
Aaron Ballmanff924b02013-11-18 20:11:50 +00004642 // special printing for statement-expressions.
4643 if (const StmtExpr *SE = dyn_cast<StmtExpr>(S)) {
4644 const CompoundStmt *Sub = SE->getSubStmt();
Mike Stump31feda52009-07-17 01:31:16 +00004645
Benjamin Kramer5733e352015-07-18 17:09:36 +00004646 auto Children = Sub->children();
4647 if (Children.begin() != Children.end()) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00004648 OS << "({ ... ; ";
4649 Helper.handledStmt(*SE->getSubStmt()->body_rbegin(),OS);
4650 OS << " })\n";
4651 return;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004652 }
4653 }
Aaron Ballmanff924b02013-11-18 20:11:50 +00004654 // special printing for comma expressions.
4655 if (const BinaryOperator* B = dyn_cast<BinaryOperator>(S)) {
4656 if (B->getOpcode() == BO_Comma) {
4657 OS << "... , ";
4658 Helper.handledStmt(B->getRHS(),OS);
4659 OS << '\n';
4660 return;
4661 }
4662 }
4663 S->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
Mike Stump31feda52009-07-17 01:31:16 +00004664
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004665 if (isa<CXXOperatorCallExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004666 OS << " (OperatorCall)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00004667 } else if (isa<CXXBindTemporaryExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004668 OS << " (BindTemporary)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00004669 } else if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(S)) {
4670 OS << " (CXXConstructExpr, ";
4671 if (Optional<CFGConstructor> CE = E.getAs<CFGConstructor>()) {
4672 if (const Stmt *S = CE->getTriggerStmt())
4673 Helper.handledStmt((const_cast<Stmt *>(S)), OS);
Artem Dergachev5a281bb2018-02-10 02:18:04 +00004674 else if (const CXXCtorInitializer *I = CE->getTriggerInit())
4675 print_initializer(OS, Helper, I);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004676 else
4677 llvm_unreachable("Unexpected trigger kind!");
4678 OS << ", ";
4679 }
4680 OS << CCE->getType().getAsString() << ")";
4681 } else if (const CastExpr *CE = dyn_cast<CastExpr>(S)) {
Ted Kremenek0ffba932011-12-21 19:32:38 +00004682 OS << " (" << CE->getStmtClassName() << ", "
4683 << CE->getCastKindName()
4684 << ", " << CE->getType().getAsString()
4685 << ")";
4686 }
Mike Stump31feda52009-07-17 01:31:16 +00004687
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004688 // Expressions need a newline.
4689 if (isa<Expr>(S))
4690 OS << '\n';
David Blaikie00be69a2013-02-23 00:29:34 +00004691 } else if (Optional<CFGInitializer> IE = E.getAs<CFGInitializer>()) {
Artem Dergachev5a281bb2018-02-10 02:18:04 +00004692 print_initializer(OS, Helper, IE->getInitializer());
4693 OS << '\n';
David Blaikie00be69a2013-02-23 00:29:34 +00004694 } else if (Optional<CFGAutomaticObjDtor> DE =
4695 E.getAs<CFGAutomaticObjDtor>()) {
4696 const VarDecl *VD = DE->getVarDecl();
Aaron Ballmanff924b02013-11-18 20:11:50 +00004697 Helper.handleDecl(VD, OS);
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004698
Marcin Swiderski52e4bc12010-10-25 07:00:40 +00004699 const Type* T = VD->getType().getTypePtr();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004700 if (const ReferenceType* RT = T->getAs<ReferenceType>())
4701 T = RT->getPointeeType().getTypePtr();
Richard Smithf676e452012-07-24 21:02:14 +00004702 T = T->getBaseElementTypeUnsafe();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004703
4704 OS << ".~" << T->getAsCXXRecordDecl()->getName().str() << "()";
4705 OS << " (Implicit destructor)\n";
Matthias Gehre351c2182017-07-12 07:04:19 +00004706 } else if (Optional<CFGLifetimeEnds> DE = E.getAs<CFGLifetimeEnds>()) {
4707 const VarDecl *VD = DE->getVarDecl();
4708 Helper.handleDecl(VD, OS);
4709
4710 OS << " (Lifetime ends)\n";
Peter Szecsi999a25f2017-08-19 11:19:16 +00004711 } else if (Optional<CFGLoopExit> LE = E.getAs<CFGLoopExit>()) {
4712 const Stmt *LoopStmt = LE->getLoopStmt();
4713 OS << LoopStmt->getStmtClassName() << " (LoopExit)\n";
Jordan Rosec9176072014-01-13 17:59:19 +00004714 } else if (Optional<CFGNewAllocator> NE = E.getAs<CFGNewAllocator>()) {
4715 OS << "CFGNewAllocator(";
4716 if (const CXXNewExpr *AllocExpr = NE->getAllocatorExpr())
4717 AllocExpr->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
4718 OS << ")\n";
Jordan Rosed2f40792013-09-03 17:00:57 +00004719 } else if (Optional<CFGDeleteDtor> DE = E.getAs<CFGDeleteDtor>()) {
4720 const CXXRecordDecl *RD = DE->getCXXRecordDecl();
4721 if (!RD)
4722 return;
4723 CXXDeleteExpr *DelExpr =
4724 const_cast<CXXDeleteExpr*>(DE->getDeleteExpr());
Aaron Ballmanff924b02013-11-18 20:11:50 +00004725 Helper.handledStmt(cast<Stmt>(DelExpr->getArgument()), OS);
Jordan Rosed2f40792013-09-03 17:00:57 +00004726 OS << "->~" << RD->getName().str() << "()";
4727 OS << " (Implicit destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00004728 } else if (Optional<CFGBaseDtor> BE = E.getAs<CFGBaseDtor>()) {
4729 const CXXBaseSpecifier *BS = BE->getBaseSpecifier();
Marcin Swiderski20b88732010-10-05 05:37:00 +00004730 OS << "~" << BS->getType()->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00004731 OS << " (Base object destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00004732 } else if (Optional<CFGMemberDtor> ME = E.getAs<CFGMemberDtor>()) {
4733 const FieldDecl *FD = ME->getFieldDecl();
Richard Smithf676e452012-07-24 21:02:14 +00004734 const Type *T = FD->getType()->getBaseElementTypeUnsafe();
Marcin Swiderski20b88732010-10-05 05:37:00 +00004735 OS << "this->" << FD->getName();
Marcin Swiderski01769902010-10-25 07:05:54 +00004736 OS << ".~" << T->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00004737 OS << " (Member object destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00004738 } else if (Optional<CFGTemporaryDtor> TE = E.getAs<CFGTemporaryDtor>()) {
4739 const CXXBindTemporaryExpr *BT = TE->getBindTemporaryExpr();
Pavel Labathd527cf82013-09-02 09:09:15 +00004740 OS << "~";
Aaron Ballmanff924b02013-11-18 20:11:50 +00004741 BT->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
Pavel Labathd527cf82013-09-02 09:09:15 +00004742 OS << "() (Temporary object destructor)\n";
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004743 }
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004744}
Mike Stump31feda52009-07-17 01:31:16 +00004745
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004746static void print_block(raw_ostream &OS, const CFG* cfg,
4747 const CFGBlock &B,
Aaron Ballmanff924b02013-11-18 20:11:50 +00004748 StmtPrinterHelper &Helper, bool print_edges,
Ted Kremenek72be32a2011-12-22 23:33:52 +00004749 bool ShowColors) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00004750 Helper.setBlockID(B.getBlockID());
Mike Stump31feda52009-07-17 01:31:16 +00004751
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004752 // Print the header.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004753 if (ShowColors)
4754 OS.changeColor(raw_ostream::YELLOW, true);
4755
4756 OS << "\n [B" << B.getBlockID();
Mike Stump31feda52009-07-17 01:31:16 +00004757
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004758 if (&B == &cfg->getEntry())
Ted Kremenek72be32a2011-12-22 23:33:52 +00004759 OS << " (ENTRY)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004760 else if (&B == &cfg->getExit())
Ted Kremenek72be32a2011-12-22 23:33:52 +00004761 OS << " (EXIT)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004762 else if (&B == cfg->getIndirectGotoBlock())
Ted Kremenek72be32a2011-12-22 23:33:52 +00004763 OS << " (INDIRECT GOTO DISPATCH)]\n";
Jordan Rose398fb002014-04-01 16:39:33 +00004764 else if (B.hasNoReturnElement())
4765 OS << " (NORETURN)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004766 else
Ted Kremenek72be32a2011-12-22 23:33:52 +00004767 OS << "]\n";
4768
4769 if (ShowColors)
4770 OS.resetColor();
Mike Stump31feda52009-07-17 01:31:16 +00004771
Ted Kremenek71eca012007-08-29 23:20:49 +00004772 // Print the label of this block.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004773 if (Stmt *Label = const_cast<Stmt*>(B.getLabel())) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004774 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00004775 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00004776
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004777 if (LabelStmt *L = dyn_cast<LabelStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00004778 OS << L->getName();
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004779 else if (CaseStmt *C = dyn_cast<CaseStmt>(Label)) {
Ted Kremenek71eca012007-08-29 23:20:49 +00004780 OS << "case ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00004781 if (C->getLHS())
4782 C->getLHS()->printPretty(OS, &Helper,
4783 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00004784 if (C->getRHS()) {
4785 OS << " ... ";
Aaron Ballmanff924b02013-11-18 20:11:50 +00004786 C->getRHS()->printPretty(OS, &Helper,
4787 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00004788 }
Mike Stump92244b02010-01-19 22:00:14 +00004789 } else if (isa<DefaultStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00004790 OS << "default";
Mike Stump92244b02010-01-19 22:00:14 +00004791 else if (CXXCatchStmt *CS = dyn_cast<CXXCatchStmt>(Label)) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004792 OS << "catch (";
Mike Stump0bdba6c2010-01-20 01:15:34 +00004793 if (CS->getExceptionDecl())
Aaron Ballmanff924b02013-11-18 20:11:50 +00004794 CS->getExceptionDecl()->print(OS, PrintingPolicy(Helper.getLangOpts()),
Mike Stump0bdba6c2010-01-20 01:15:34 +00004795 0);
4796 else
4797 OS << "...";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004798 OS << ")";
Nico Weber699670e2017-08-23 15:33:16 +00004799 } else if (SEHExceptStmt *ES = dyn_cast<SEHExceptStmt>(Label)) {
4800 OS << "__except (";
4801 ES->getFilterExpr()->printPretty(OS, &Helper,
4802 PrintingPolicy(Helper.getLangOpts()), 0);
4803 OS << ")";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004804 } else
David Blaikie83d382b2011-09-23 05:06:16 +00004805 llvm_unreachable("Invalid label statement in CFGBlock.");
Mike Stump31feda52009-07-17 01:31:16 +00004806
Ted Kremenek71eca012007-08-29 23:20:49 +00004807 OS << ":\n";
4808 }
Mike Stump31feda52009-07-17 01:31:16 +00004809
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004810 // Iterate through the statements in the block and print them.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004811 unsigned j = 1;
Mike Stump31feda52009-07-17 01:31:16 +00004812
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004813 for (CFGBlock::const_iterator I = B.begin(), E = B.end() ;
4814 I != E ; ++I, ++j ) {
Ted Kremenek71eca012007-08-29 23:20:49 +00004815 // Print the statement # in the basic block and the statement itself.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004816 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00004817 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00004818
Ted Kremenek2d470fc2008-09-13 05:16:45 +00004819 OS << llvm::format("%3d", j) << ": ";
Mike Stump31feda52009-07-17 01:31:16 +00004820
Aaron Ballmanff924b02013-11-18 20:11:50 +00004821 Helper.setStmtID(j);
Mike Stump31feda52009-07-17 01:31:16 +00004822
Ted Kremenek72be32a2011-12-22 23:33:52 +00004823 print_elem(OS, Helper, *I);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004824 }
Mike Stump31feda52009-07-17 01:31:16 +00004825
Ted Kremenek71eca012007-08-29 23:20:49 +00004826 // Print the terminator of this block.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004827 if (B.getTerminator()) {
Ted Kremenek72be32a2011-12-22 23:33:52 +00004828 if (ShowColors)
4829 OS.changeColor(raw_ostream::GREEN);
Mike Stump31feda52009-07-17 01:31:16 +00004830
Ted Kremenek72be32a2011-12-22 23:33:52 +00004831 OS << " T: ";
Mike Stump31feda52009-07-17 01:31:16 +00004832
Aaron Ballmanff924b02013-11-18 20:11:50 +00004833 Helper.setBlockID(-1);
Mike Stump31feda52009-07-17 01:31:16 +00004834
Aaron Ballmanff924b02013-11-18 20:11:50 +00004835 PrintingPolicy PP(Helper.getLangOpts());
4836 CFGBlockTerminatorPrint TPrinter(OS, &Helper, PP);
Ted Kremenekfcc14172014-03-08 02:22:29 +00004837 TPrinter.print(B.getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00004838 OS << '\n';
Ted Kremenek72be32a2011-12-22 23:33:52 +00004839
4840 if (ShowColors)
4841 OS.resetColor();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004842 }
Mike Stump31feda52009-07-17 01:31:16 +00004843
Ted Kremenek71eca012007-08-29 23:20:49 +00004844 if (print_edges) {
4845 // Print the predecessors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004846 if (!B.pred_empty()) {
4847 const raw_ostream::Colors Color = raw_ostream::BLUE;
4848 if (ShowColors)
4849 OS.changeColor(Color);
4850 OS << " Preds " ;
4851 if (ShowColors)
4852 OS.resetColor();
4853 OS << '(' << B.pred_size() << "):";
4854 unsigned i = 0;
Ted Kremenek71eca012007-08-29 23:20:49 +00004855
Ted Kremenek72be32a2011-12-22 23:33:52 +00004856 if (ShowColors)
4857 OS.changeColor(Color);
4858
4859 for (CFGBlock::const_pred_iterator I = B.pred_begin(), E = B.pred_end();
4860 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00004861 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00004862 OS << "\n ";
Mike Stump31feda52009-07-17 01:31:16 +00004863
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004864 CFGBlock *B = *I;
4865 bool Reachable = true;
4866 if (!B) {
4867 Reachable = false;
4868 B = I->getPossiblyUnreachableBlock();
4869 }
4870
4871 OS << " B" << B->getBlockID();
4872 if (!Reachable)
4873 OS << "(Unreachable)";
Ted Kremenek72be32a2011-12-22 23:33:52 +00004874 }
4875
4876 if (ShowColors)
4877 OS.resetColor();
4878
4879 OS << '\n';
Ted Kremenek71eca012007-08-29 23:20:49 +00004880 }
Mike Stump31feda52009-07-17 01:31:16 +00004881
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004882 // Print the successors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004883 if (!B.succ_empty()) {
4884 const raw_ostream::Colors Color = raw_ostream::MAGENTA;
4885 if (ShowColors)
4886 OS.changeColor(Color);
4887 OS << " Succs ";
4888 if (ShowColors)
4889 OS.resetColor();
4890 OS << '(' << B.succ_size() << "):";
4891 unsigned i = 0;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004892
Ted Kremenek72be32a2011-12-22 23:33:52 +00004893 if (ShowColors)
4894 OS.changeColor(Color);
Mike Stump31feda52009-07-17 01:31:16 +00004895
Ted Kremenek72be32a2011-12-22 23:33:52 +00004896 for (CFGBlock::const_succ_iterator I = B.succ_begin(), E = B.succ_end();
4897 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00004898 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00004899 OS << "\n ";
4900
Ted Kremenek9238c5c2014-02-27 21:56:44 +00004901 CFGBlock *B = *I;
4902
4903 bool Reachable = true;
4904 if (!B) {
4905 Reachable = false;
4906 B = I->getPossiblyUnreachableBlock();
4907 }
4908
4909 if (B) {
4910 OS << " B" << B->getBlockID();
4911 if (!Reachable)
4912 OS << "(Unreachable)";
4913 }
4914 else {
4915 OS << " NULL";
4916 }
Ted Kremenek72be32a2011-12-22 23:33:52 +00004917 }
Ted Kremenek9238c5c2014-02-27 21:56:44 +00004918
Ted Kremenek72be32a2011-12-22 23:33:52 +00004919 if (ShowColors)
4920 OS.resetColor();
4921 OS << '\n';
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004922 }
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004923 }
Mike Stump31feda52009-07-17 01:31:16 +00004924}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004925
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004926/// dump - A simple pretty printer of a CFG that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004927void CFG::dump(const LangOptions &LO, bool ShowColors) const {
4928 print(llvm::errs(), LO, ShowColors);
4929}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004930
4931/// print - A simple pretty printer of a CFG that outputs to an ostream.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004932void CFG::print(raw_ostream &OS, const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00004933 StmtPrinterHelper Helper(this, LO);
Mike Stump31feda52009-07-17 01:31:16 +00004934
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004935 // Print the entry block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00004936 print_block(OS, this, getEntry(), Helper, true, ShowColors);
Mike Stump31feda52009-07-17 01:31:16 +00004937
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004938 // Iterate through the CFGBlocks and print them one by one.
4939 for (const_iterator I = Blocks.begin(), E = Blocks.end() ; I != E ; ++I) {
4940 // Skip the entry block, because we already printed it.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004941 if (&(**I) == &getEntry() || &(**I) == &getExit())
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004942 continue;
Mike Stump31feda52009-07-17 01:31:16 +00004943
Aaron Ballmanff924b02013-11-18 20:11:50 +00004944 print_block(OS, this, **I, Helper, true, ShowColors);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004945 }
Mike Stump31feda52009-07-17 01:31:16 +00004946
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004947 // Print the exit block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00004948 print_block(OS, this, getExit(), Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00004949 OS << '\n';
Ted Kremeneke03879b2008-11-24 20:50:24 +00004950 OS.flush();
Mike Stump31feda52009-07-17 01:31:16 +00004951}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004952
4953/// dump - A simply pretty printer of a CFGBlock that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00004954void CFGBlock::dump(const CFG* cfg, const LangOptions &LO,
4955 bool ShowColors) const {
4956 print(llvm::errs(), cfg, LO, ShowColors);
Chris Lattnerc61089a2009-06-30 01:26:17 +00004957}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004958
Yaron Kerencdae9412016-01-29 19:38:18 +00004959LLVM_DUMP_METHOD void CFGBlock::dump() const {
Anna Zaksa6fea132014-06-13 23:47:38 +00004960 dump(getParent(), LangOptions(), false);
4961}
4962
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004963/// print - A simple pretty printer of a CFGBlock that outputs to an ostream.
4964/// Generally this will only be called from CFG::print.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004965void CFGBlock::print(raw_ostream &OS, const CFG* cfg,
Ted Kremenek72be32a2011-12-22 23:33:52 +00004966 const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00004967 StmtPrinterHelper Helper(cfg, LO);
Aaron Ballmanff924b02013-11-18 20:11:50 +00004968 print_block(OS, cfg, *this, Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00004969 OS << '\n';
Ted Kremenek889073f2007-08-23 16:51:22 +00004970}
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004971
Ted Kremenek15647632008-01-30 23:02:42 +00004972/// printTerminator - A simple pretty printer of the terminator of a CFGBlock.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004973void CFGBlock::printTerminator(raw_ostream &OS,
Mike Stump31feda52009-07-17 01:31:16 +00004974 const LangOptions &LO) const {
Craig Topper25542942014-05-20 04:30:07 +00004975 CFGBlockTerminatorPrint TPrinter(OS, nullptr, PrintingPolicy(LO));
Ted Kremenekfcc14172014-03-08 02:22:29 +00004976 TPrinter.print(getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00004977}
4978
Ted Kremenekec3bbf42014-03-29 00:35:20 +00004979Stmt *CFGBlock::getTerminatorCondition(bool StripParens) {
Marcin Swiderskia7d84a72010-10-29 05:21:47 +00004980 Stmt *Terminator = this->Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004981 if (!Terminator)
Craig Topper25542942014-05-20 04:30:07 +00004982 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004983
Craig Topper25542942014-05-20 04:30:07 +00004984 Expr *E = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004985
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004986 switch (Terminator->getStmtClass()) {
4987 default:
4988 break;
Mike Stump31feda52009-07-17 01:31:16 +00004989
Jordan Rosecf10ea82013-06-06 21:53:45 +00004990 case Stmt::CXXForRangeStmtClass:
4991 E = cast<CXXForRangeStmt>(Terminator)->getCond();
4992 break;
4993
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004994 case Stmt::ForStmtClass:
4995 E = cast<ForStmt>(Terminator)->getCond();
4996 break;
Mike Stump31feda52009-07-17 01:31:16 +00004997
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004998 case Stmt::WhileStmtClass:
4999 E = cast<WhileStmt>(Terminator)->getCond();
5000 break;
Mike Stump31feda52009-07-17 01:31:16 +00005001
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005002 case Stmt::DoStmtClass:
5003 E = cast<DoStmt>(Terminator)->getCond();
5004 break;
Mike Stump31feda52009-07-17 01:31:16 +00005005
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005006 case Stmt::IfStmtClass:
5007 E = cast<IfStmt>(Terminator)->getCond();
5008 break;
Mike Stump31feda52009-07-17 01:31:16 +00005009
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005010 case Stmt::ChooseExprClass:
5011 E = cast<ChooseExpr>(Terminator)->getCond();
5012 break;
Mike Stump31feda52009-07-17 01:31:16 +00005013
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005014 case Stmt::IndirectGotoStmtClass:
5015 E = cast<IndirectGotoStmt>(Terminator)->getTarget();
5016 break;
Mike Stump31feda52009-07-17 01:31:16 +00005017
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005018 case Stmt::SwitchStmtClass:
5019 E = cast<SwitchStmt>(Terminator)->getCond();
5020 break;
Mike Stump31feda52009-07-17 01:31:16 +00005021
John McCallc07a0c72011-02-17 10:25:35 +00005022 case Stmt::BinaryConditionalOperatorClass:
5023 E = cast<BinaryConditionalOperator>(Terminator)->getCond();
5024 break;
5025
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005026 case Stmt::ConditionalOperatorClass:
5027 E = cast<ConditionalOperator>(Terminator)->getCond();
5028 break;
Mike Stump31feda52009-07-17 01:31:16 +00005029
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005030 case Stmt::BinaryOperatorClass: // '&&' and '||'
5031 E = cast<BinaryOperator>(Terminator)->getLHS();
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00005032 break;
Mike Stump31feda52009-07-17 01:31:16 +00005033
Ted Kremenek6d8b46e2008-11-12 21:11:49 +00005034 case Stmt::ObjCForCollectionStmtClass:
Mike Stump31feda52009-07-17 01:31:16 +00005035 return Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005036 }
Mike Stump31feda52009-07-17 01:31:16 +00005037
Ted Kremenekec3bbf42014-03-29 00:35:20 +00005038 if (!StripParens)
5039 return E;
5040
Craig Topper25542942014-05-20 04:30:07 +00005041 return E ? E->IgnoreParens() : nullptr;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005042}
5043
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005044//===----------------------------------------------------------------------===//
5045// CFG Graphviz Visualization
5046//===----------------------------------------------------------------------===//
5047
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005048#ifndef NDEBUG
Mike Stump31feda52009-07-17 01:31:16 +00005049static StmtPrinterHelper* GraphHelper;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005050#endif
5051
Chris Lattnerc61089a2009-06-30 01:26:17 +00005052void CFG::viewCFG(const LangOptions &LO) const {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005053#ifndef NDEBUG
Chris Lattnerc61089a2009-06-30 01:26:17 +00005054 StmtPrinterHelper H(this, LO);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005055 GraphHelper = &H;
5056 llvm::ViewGraph(this,"CFG");
Craig Topper25542942014-05-20 04:30:07 +00005057 GraphHelper = nullptr;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005058#endif
5059}
5060
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005061namespace llvm {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005062
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005063template<>
5064struct DOTGraphTraits<const CFG*> : public DefaultDOTGraphTraits {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005065 DOTGraphTraits(bool isSimple = false) : DefaultDOTGraphTraits(isSimple) {}
Tobias Grosser9fc223a2009-11-30 14:16:05 +00005066
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005067 static std::string getNodeLabel(const CFGBlock *Node, const CFG* Graph) {
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005068#ifndef NDEBUG
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005069 std::string OutSStr;
5070 llvm::raw_string_ostream Out(OutSStr);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005071 print_block(Out,Graph, *Node, *GraphHelper, false, false);
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005072 std::string& OutStr = Out.str();
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005073
5074 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
5075
5076 // Process string output to make it nicer...
5077 for (unsigned i = 0; i != OutStr.length(); ++i)
5078 if (OutStr[i] == '\n') { // Left justify
5079 OutStr[i] = '\\';
5080 OutStr.insert(OutStr.begin()+i+1, 'l');
5081 }
Mike Stump31feda52009-07-17 01:31:16 +00005082
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005083 return OutStr;
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005084#else
Eugene Zelenko38c70522017-12-07 21:55:09 +00005085 return {};
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005086#endif
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005087 }
5088};
Eugene Zelenko38c70522017-12-07 21:55:09 +00005089
5090} // namespace llvm