blob: e4ed0f86b918afd5de796a39ee184af6c369a506 [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//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00006//
7//===----------------------------------------------------------------------===//
8//
9// This file defines the CFG and CFGBuilder classes for representing and
10// building Control-Flow Graphs (CFGs) from ASTs.
11//
12//===----------------------------------------------------------------------===//
13
Ted Kremenek6796fbd2009-07-16 18:13:04 +000014#include "clang/Analysis/CFG.h"
Benjamin Kramer1ea8e092012-07-04 17:04:04 +000015#include "clang/AST/ASTContext.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000016#include "clang/AST/Attr.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000017#include "clang/AST/Decl.h"
18#include "clang/AST/DeclBase.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000019#include "clang/AST/DeclCXX.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000020#include "clang/AST/DeclGroup.h"
21#include "clang/AST/Expr.h"
22#include "clang/AST/ExprCXX.h"
23#include "clang/AST/OperationKinds.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000024#include "clang/AST/PrettyPrinter.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000025#include "clang/AST/Stmt.h"
26#include "clang/AST/StmtCXX.h"
27#include "clang/AST/StmtObjC.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000028#include "clang/AST/StmtVisitor.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000029#include "clang/AST/Type.h"
Artem Dergachev40684812018-02-27 20:03:35 +000030#include "clang/Analysis/ConstructionContext.h"
Csaba Dabisdea605e2019-05-29 18:29:31 +000031#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"
Csaba Dabisdea605e2019-05-29 18:29:31 +000034#include "clang/Basic/JsonSupport.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000035#include "clang/Basic/LLVM.h"
36#include "clang/Basic/LangOptions.h"
37#include "clang/Basic/SourceLocation.h"
38#include "clang/Basic/Specifiers.h"
39#include "llvm/ADT/APInt.h"
40#include "llvm/ADT/APSInt.h"
41#include "llvm/ADT/ArrayRef.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000042#include "llvm/ADT/DenseMap.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000043#include "llvm/ADT/Optional.h"
44#include "llvm/ADT/STLExtras.h"
45#include "llvm/ADT/SetVector.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000046#include "llvm/ADT/SmallPtrSet.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000047#include "llvm/ADT/SmallVector.h"
Benjamin Kramer89b422c2009-08-23 12:08:50 +000048#include "llvm/Support/Allocator.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000049#include "llvm/Support/Casting.h"
50#include "llvm/Support/Compiler.h"
51#include "llvm/Support/DOTGraphTraits.h"
52#include "llvm/Support/ErrorHandling.h"
Benjamin Kramer89b422c2009-08-23 12:08:50 +000053#include "llvm/Support/Format.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000054#include "llvm/Support/GraphWriter.h"
55#include "llvm/Support/SaveAndRestore.h"
Eugene Zelenko38c70522017-12-07 21:55:09 +000056#include "llvm/Support/raw_ostream.h"
57#include <cassert>
58#include <memory>
59#include <string>
60#include <tuple>
61#include <utility>
62#include <vector>
Ted Kremeneke5ccf9a2008-01-11 00:40:29 +000063
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +000064using namespace clang;
65
Ted Kremenek5ef32db2011-08-12 23:37:29 +000066static SourceLocation GetEndLoc(Decl *D) {
67 if (VarDecl *VD = dyn_cast<VarDecl>(D))
68 if (Expr *Ex = VD->getInit())
Ted Kremenek8889bb32008-08-06 23:20:50 +000069 return Ex->getSourceRange().getEnd();
Mike Stump31feda52009-07-17 01:31:16 +000070 return D->getLocation();
Ted Kremenek8889bb32008-08-06 23:20:50 +000071}
Ted Kremenekdc03bd02010-08-02 23:46:59 +000072
George Burgess IVced56e62015-10-01 18:47:52 +000073/// Helper for tryNormalizeBinaryOperator. Attempts to extract an IntegerLiteral
74/// or EnumConstantDecl from the given Expr. If it fails, returns nullptr.
Eugene Zelenko38c70522017-12-07 21:55:09 +000075static const Expr *tryTransformToIntOrEnumConstant(const Expr *E) {
George Burgess IVced56e62015-10-01 18:47:52 +000076 E = E->IgnoreParens();
77 if (isa<IntegerLiteral>(E))
78 return E;
79 if (auto *DR = dyn_cast<DeclRefExpr>(E->IgnoreParenImpCasts()))
80 return isa<EnumConstantDecl>(DR->getDecl()) ? DR : nullptr;
81 return nullptr;
82}
83
84/// Tries to interpret a binary operator into `Decl Op Expr` form, if Expr is
85/// an integer literal or an enum constant.
86///
87/// If this fails, at least one of the returned DeclRefExpr or Expr will be
88/// null.
89static std::tuple<const DeclRefExpr *, BinaryOperatorKind, const Expr *>
90tryNormalizeBinaryOperator(const BinaryOperator *B) {
91 BinaryOperatorKind Op = B->getOpcode();
92
93 const Expr *MaybeDecl = B->getLHS();
94 const Expr *Constant = tryTransformToIntOrEnumConstant(B->getRHS());
95 // Expr looked like `0 == Foo` instead of `Foo == 0`
96 if (Constant == nullptr) {
97 // Flip the operator
98 if (Op == BO_GT)
99 Op = BO_LT;
100 else if (Op == BO_GE)
101 Op = BO_LE;
102 else if (Op == BO_LT)
103 Op = BO_GT;
104 else if (Op == BO_LE)
105 Op = BO_GE;
106
107 MaybeDecl = B->getRHS();
108 Constant = tryTransformToIntOrEnumConstant(B->getLHS());
109 }
110
111 auto *D = dyn_cast<DeclRefExpr>(MaybeDecl->IgnoreParenImpCasts());
112 return std::make_tuple(D, Op, Constant);
113}
114
115/// For an expression `x == Foo && x == Bar`, this determines whether the
116/// `Foo` and `Bar` are either of the same enumeration type, or both integer
117/// literals.
118///
119/// It's an error to pass this arguments that are not either IntegerLiterals
120/// or DeclRefExprs (that have decls of type EnumConstantDecl)
121static bool areExprTypesCompatible(const Expr *E1, const Expr *E2) {
122 // User intent isn't clear if they're mixing int literals with enum
123 // constants.
124 if (isa<IntegerLiteral>(E1) != isa<IntegerLiteral>(E2))
125 return false;
126
127 // Integer literal comparisons, regardless of literal type, are acceptable.
128 if (isa<IntegerLiteral>(E1))
129 return true;
130
131 // IntegerLiterals are handled above and only EnumConstantDecls are expected
132 // beyond this point
133 assert(isa<DeclRefExpr>(E1) && isa<DeclRefExpr>(E2));
134 auto *Decl1 = cast<DeclRefExpr>(E1)->getDecl();
135 auto *Decl2 = cast<DeclRefExpr>(E2)->getDecl();
136
137 assert(isa<EnumConstantDecl>(Decl1) && isa<EnumConstantDecl>(Decl2));
138 const DeclContext *DC1 = Decl1->getDeclContext();
139 const DeclContext *DC2 = Decl2->getDeclContext();
140
141 assert(isa<EnumDecl>(DC1) && isa<EnumDecl>(DC2));
142 return DC1 == DC2;
143}
144
Eugene Zelenko38c70522017-12-07 21:55:09 +0000145namespace {
146
Ted Kremenek7c58d352011-03-10 01:14:11 +0000147class CFGBuilder;
Fangrui Song6907ce22018-07-30 19:24:48 +0000148
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000149/// The CFG builder uses a recursive algorithm to build the CFG. When
150/// we process an expression, sometimes we know that we must add the
151/// subexpressions as block-level expressions. For example:
152///
153/// exp1 || exp2
154///
155/// When processing the '||' expression, we know that exp1 and exp2
156/// need to be added as block-level expressions, even though they
157/// might not normally need to be. AddStmtChoice records this
158/// contextual information. If AddStmtChoice is 'NotAlwaysAdd', then
159/// the builder has an option not to add a subexpression as a
160/// block-level expression.
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000161class AddStmtChoice {
162public:
Ted Kremenek8219b822010-12-16 07:46:53 +0000163 enum Kind { NotAlwaysAdd = 0, AlwaysAdd = 1 };
Ted Kremenek5d2bb1b2010-03-02 21:43:54 +0000164
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000165 AddStmtChoice(Kind a_kind = NotAlwaysAdd) : kind(a_kind) {}
Ted Kremenek5d2bb1b2010-03-02 21:43:54 +0000166
Ted Kremenek7c58d352011-03-10 01:14:11 +0000167 bool alwaysAdd(CFGBuilder &builder,
168 const Stmt *stmt) const;
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000169
170 /// Return a copy of this object, except with the 'always-add' bit
171 /// set as specified.
172 AddStmtChoice withAlwaysAdd(bool alwaysAdd) const {
Ted Kremenek7c58d352011-03-10 01:14:11 +0000173 return AddStmtChoice(alwaysAdd ? AlwaysAdd : NotAlwaysAdd);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000174 }
175
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000176private:
Zhanyong Wanb5d11c12010-11-24 03:28:53 +0000177 Kind kind;
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000178};
Mike Stump31feda52009-07-17 01:31:16 +0000179
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000180/// LocalScope - Node in tree of local scopes created for C++ implicit
181/// destructor calls generation. It contains list of automatic variables
182/// declared in the scope and link to position in previous scope this scope
183/// began in.
184///
185/// The process of creating local scopes is as follows:
186/// - Init CFGBuilder::ScopePos with invalid position (equivalent for null),
187/// - Before processing statements in scope (e.g. CompoundStmt) create
188/// LocalScope object using CFGBuilder::ScopePos as link to previous scope
189/// and set CFGBuilder::ScopePos to the end of new scope,
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000190/// - On every occurrence of VarDecl increase CFGBuilder::ScopePos if it points
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000191/// at this VarDecl,
192/// - For every normal (without jump) end of scope add to CFGBlock destructors
193/// for objects in the current scope,
194/// - For every jump add to CFGBlock destructors for objects
195/// between CFGBuilder::ScopePos and local scope position saved for jump
196/// target. Thanks to C++ restrictions on goto jumps we can be sure that
197/// jump target position will be on the path to root from CFGBuilder::ScopePos
198/// (adding any variable that doesn't need constructor to be called to
199/// LocalScope can break this assumption),
200///
201class LocalScope {
202public:
Eugene Zelenko38c70522017-12-07 21:55:09 +0000203 friend class const_iterator;
204
205 using AutomaticVarsTy = BumpVector<VarDecl *>;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000206
207 /// const_iterator - Iterates local scope backwards and jumps to previous
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000208 /// scope on reaching the beginning of currently iterated scope.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000209 class const_iterator {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000210 const LocalScope* Scope = nullptr;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000211
212 /// VarIter is guaranteed to be greater then 0 for every valid iterator.
213 /// Invalid iterator (with null Scope) has VarIter equal to 0.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000214 unsigned VarIter = 0;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000215
216 public:
217 /// Create invalid iterator. Dereferencing invalid iterator is not allowed.
218 /// Incrementing invalid iterator is allowed and will result in invalid
219 /// iterator.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000220 const_iterator() = default;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000221
222 /// Create valid iterator. In case when S.Prev is an invalid iterator and
223 /// I is equal to 0, this will create invalid iterator.
224 const_iterator(const LocalScope& S, unsigned I)
225 : Scope(&S), VarIter(I) {
226 // Iterator to "end" of scope is not allowed. Handle it by going up
227 // in scopes tree possibly up to invalid iterator in the root.
228 if (VarIter == 0 && Scope)
229 *this = Scope->Prev;
230 }
231
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000232 VarDecl *const* operator->() const {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000233 assert(Scope && "Dereferencing invalid iterator is not allowed");
234 assert(VarIter != 0 && "Iterator has invalid value of VarIter member");
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000235 return &Scope->Vars[VarIter - 1];
236 }
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000237
238 const VarDecl *getFirstVarInScope() const {
239 assert(Scope && "Dereferencing invalid iterator is not allowed");
240 assert(VarIter != 0 && "Iterator has invalid value of VarIter member");
241 return Scope->Vars[0];
242 }
243
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000244 VarDecl *operator*() const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000245 return *this->operator->();
246 }
247
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000248 const_iterator &operator++() {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000249 if (!Scope)
250 return *this;
251
Eugene Zelenko38c70522017-12-07 21:55:09 +0000252 assert(VarIter != 0 && "Iterator has invalid value of VarIter member");
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000253 --VarIter;
254 if (VarIter == 0)
255 *this = Scope->Prev;
256 return *this;
257 }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000258 const_iterator operator++(int) {
259 const_iterator P = *this;
260 ++*this;
261 return P;
262 }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000263
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000264 bool operator==(const const_iterator &rhs) const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000265 return Scope == rhs.Scope && VarIter == rhs.VarIter;
266 }
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000267 bool operator!=(const const_iterator &rhs) const {
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000268 return !(*this == rhs);
269 }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000270
Aaron Ballman67347662015-02-15 22:00:28 +0000271 explicit operator bool() const {
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000272 return *this != const_iterator();
273 }
274
275 int distance(const_iterator L);
Matthias Gehre351c2182017-07-12 07:04:19 +0000276 const_iterator shared_parent(const_iterator L);
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000277 bool pointsToFirstDeclaredVar() { return VarIter == 1; }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000278 };
279
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000280private:
Ted Kremenekc7bfdcd2011-02-15 02:47:45 +0000281 BumpVectorContext ctx;
Fangrui Song6907ce22018-07-30 19:24:48 +0000282
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000283 /// Automatic variables in order of declaration.
284 AutomaticVarsTy Vars;
Eugene Zelenko38c70522017-12-07 21:55:09 +0000285
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000286 /// Iterator to variable in previous scope that was declared just before
287 /// begin of this scope.
288 const_iterator Prev;
289
290public:
291 /// Constructs empty scope linked to previous scope in specified place.
David Blaikiec1334cc2015-08-13 22:12:21 +0000292 LocalScope(BumpVectorContext ctx, const_iterator P)
293 : ctx(std::move(ctx)), Vars(this->ctx, 4), Prev(P) {}
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000294
295 /// Begin of scope in direction of CFG building (backwards).
296 const_iterator begin() const { return const_iterator(*this, Vars.size()); }
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000297
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000298 void addVar(VarDecl *VD) {
Ted Kremenekc7bfdcd2011-02-15 02:47:45 +0000299 Vars.push_back(VD, ctx);
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000300 }
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000301};
302
Eugene Zelenko38c70522017-12-07 21:55:09 +0000303} // namespace
304
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000305/// distance - Calculates distance from this to L. L must be reachable from this
306/// (with use of ++ operator). Cost of calculating the distance is linear w.r.t.
307/// number of scopes between this and L.
308int LocalScope::const_iterator::distance(LocalScope::const_iterator L) {
309 int D = 0;
310 const_iterator F = *this;
311 while (F.Scope != L.Scope) {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000312 assert(F != const_iterator() &&
313 "L iterator is not reachable from F iterator.");
Marcin Swiderskie9862ce2010-09-30 22:42:32 +0000314 D += F.VarIter;
315 F = F.Scope->Prev;
316 }
317 D += F.VarIter - L.VarIter;
318 return D;
319}
320
Matthias Gehre351c2182017-07-12 07:04:19 +0000321/// Calculates the closest parent of this iterator
322/// that is in a scope reachable through the parents of L.
323/// I.e. when using 'goto' from this to L, the lifetime of all variables
324/// between this and shared_parent(L) end.
325LocalScope::const_iterator
326LocalScope::const_iterator::shared_parent(LocalScope::const_iterator L) {
327 llvm::SmallPtrSet<const LocalScope *, 4> ScopesOfL;
328 while (true) {
329 ScopesOfL.insert(L.Scope);
330 if (L == const_iterator())
331 break;
332 L = L.Scope->Prev;
333 }
334
335 const_iterator F = *this;
336 while (true) {
337 if (ScopesOfL.count(F.Scope))
338 return F;
339 assert(F != const_iterator() &&
340 "L iterator is not reachable from F iterator.");
341 F = F.Scope->Prev;
342 }
343}
344
Eugene Zelenko38c70522017-12-07 21:55:09 +0000345namespace {
346
Jonathan Roelofs99bdd982015-05-19 18:51:56 +0000347/// Structure for specifying position in CFG during its build process. It
348/// consists of CFGBlock that specifies position in CFG and
349/// LocalScope::const_iterator that specifies position in LocalScope graph.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000350struct BlockScopePosPair {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000351 CFGBlock *block = nullptr;
352 LocalScope::const_iterator scopePosition;
353
354 BlockScopePosPair() = default;
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000355 BlockScopePosPair(CFGBlock *b, LocalScope::const_iterator scopePos)
Ted Kremenekef81e9e2011-01-07 19:37:16 +0000356 : block(b), scopePosition(scopePos) {}
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000357};
358
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000359/// TryResult - a class representing a variant over the values
360/// 'true', 'false', or 'unknown'. This is returned by tryEvaluateBool,
361/// and is used by the CFGBuilder to decide if a branch condition
362/// can be decided up front during CFG construction.
363class TryResult {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000364 int X = -1;
365
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000366public:
Eugene Zelenko38c70522017-12-07 21:55:09 +0000367 TryResult() = default;
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000368 TryResult(bool b) : X(b ? 1 : 0) {}
Fangrui Song6907ce22018-07-30 19:24:48 +0000369
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000370 bool isTrue() const { return X == 1; }
371 bool isFalse() const { return X == 0; }
372 bool isKnown() const { return X >= 0; }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000373
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000374 void negate() {
375 assert(isKnown());
376 X ^= 0x1;
377 }
378};
379
Eugene Zelenko38c70522017-12-07 21:55:09 +0000380} // namespace
381
382static TryResult bothKnownTrue(TryResult R1, TryResult R2) {
Manuel Klimekdeb02622014-08-08 07:37:13 +0000383 if (!R1.isKnown() || !R2.isKnown())
384 return TryResult();
385 return TryResult(R1.isTrue() && R2.isTrue());
386}
387
Eugene Zelenko38c70522017-12-07 21:55:09 +0000388namespace {
389
Ted Kremenek8ae67872013-02-05 22:00:19 +0000390class reverse_children {
391 llvm::SmallVector<Stmt *, 12> childrenBuf;
Eugene Zelenko38c70522017-12-07 21:55:09 +0000392 ArrayRef<Stmt *> children;
393
Ted Kremenek8ae67872013-02-05 22:00:19 +0000394public:
395 reverse_children(Stmt *S);
396
Eugene Zelenko38c70522017-12-07 21:55:09 +0000397 using iterator = ArrayRef<Stmt *>::reverse_iterator;
398
Ted Kremenek8ae67872013-02-05 22:00:19 +0000399 iterator begin() const { return children.rbegin(); }
400 iterator end() const { return children.rend(); }
401};
402
Eugene Zelenko38c70522017-12-07 21:55:09 +0000403} // namespace
Ted Kremenek8ae67872013-02-05 22:00:19 +0000404
405reverse_children::reverse_children(Stmt *S) {
406 if (CallExpr *CE = dyn_cast<CallExpr>(S)) {
407 children = CE->getRawSubExprs();
408 return;
409 }
410 switch (S->getStmtClass()) {
Ted Kremenek7d86b9c2013-02-05 22:03:14 +0000411 // Note: Fill in this switch with more cases we want to optimize.
Ted Kremenek8ae67872013-02-05 22:00:19 +0000412 case Stmt::InitListExprClass: {
413 InitListExpr *IE = cast<InitListExpr>(S);
414 children = llvm::makeArrayRef(reinterpret_cast<Stmt**>(IE->getInits()),
415 IE->getNumInits());
416 return;
417 }
418 default:
419 break;
420 }
421
422 // Default case for all other statements.
Benjamin Kramer642f1732015-07-02 21:03:14 +0000423 for (Stmt *SubStmt : S->children())
424 childrenBuf.push_back(SubStmt);
Ted Kremenek8ae67872013-02-05 22:00:19 +0000425
426 // This needs to be done *after* childrenBuf has been populated.
427 children = childrenBuf;
428}
429
Eugene Zelenko38c70522017-12-07 21:55:09 +0000430namespace {
431
Ted Kremenekbe9b33b2008-08-04 22:51:42 +0000432/// CFGBuilder - This class implements CFG construction from an AST.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +0000433/// The builder is stateful: an instance of the builder should be used to only
434/// construct a single CFG.
435///
436/// Example usage:
437///
438/// CFGBuilder builder;
Jonathan Roelofsab046c52015-07-27 16:05:36 +0000439/// std::unique_ptr<CFG> cfg = builder.buildCFG(decl, stmt1);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +0000440///
Mike Stump31feda52009-07-17 01:31:16 +0000441/// CFG construction is done via a recursive walk of an AST. We actually parse
442/// the AST in reverse order so that the successor of a basic block is
443/// constructed prior to its predecessor. This allows us to nicely capture
444/// implicit fall-throughs without extra basic blocks.
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +0000445class CFGBuilder {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000446 using JumpTarget = BlockScopePosPair;
447 using JumpSource = BlockScopePosPair;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000448
Mike Stump0d76d072009-07-20 23:24:15 +0000449 ASTContext *Context;
Ahmed Charlesb8984322014-03-07 20:03:18 +0000450 std::unique_ptr<CFG> cfg;
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000451
Eugene Zelenko38c70522017-12-07 21:55:09 +0000452 // Current block.
453 CFGBlock *Block = nullptr;
454
455 // Block after the current block.
456 CFGBlock *Succ = nullptr;
457
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000458 JumpTarget ContinueJumpTarget;
459 JumpTarget BreakJumpTarget;
Nico Weber699670e2017-08-23 15:33:16 +0000460 JumpTarget SEHLeaveJumpTarget;
Eugene Zelenko38c70522017-12-07 21:55:09 +0000461 CFGBlock *SwitchTerminatedBlock = nullptr;
462 CFGBlock *DefaultCaseBlock = nullptr;
Nico Weber699670e2017-08-23 15:33:16 +0000463
464 // This can point either to a try or a __try block. The frontend forbids
465 // mixing both kinds in one function, so having one for both is enough.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000466 CFGBlock *TryTerminatedBlock = nullptr;
Manuel Klimekb5616c92014-08-07 10:42:17 +0000467
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +0000468 // Current position in local scope.
469 LocalScope::const_iterator ScopePos;
470
471 // LabelMap records the mapping from Label expressions to their jump targets.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000472 using LabelMapTy = llvm::DenseMap<LabelDecl *, JumpTarget>;
Ted Kremenek8a632182007-08-21 23:26:17 +0000473 LabelMapTy LabelMap;
Mike Stump31feda52009-07-17 01:31:16 +0000474
475 // A list of blocks that end with a "goto" that must be backpatched to their
476 // resolved targets upon completion of CFG construction.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000477 using BackpatchBlocksTy = std::vector<JumpSource>;
Ted Kremenek8a632182007-08-21 23:26:17 +0000478 BackpatchBlocksTy BackpatchBlocks;
Mike Stump31feda52009-07-17 01:31:16 +0000479
Ted Kremenekeda180e22007-08-28 19:26:49 +0000480 // A list of labels whose address has been taken (for indirect gotos).
Eugene Zelenko38c70522017-12-07 21:55:09 +0000481 using LabelSetTy = llvm::SmallSetVector<LabelDecl *, 8>;
Ted Kremenekeda180e22007-08-28 19:26:49 +0000482 LabelSetTy AddressTakenLabels;
Mike Stump31feda52009-07-17 01:31:16 +0000483
Artem Dergachev41ffb302018-02-08 22:58:15 +0000484 // Information about the currently visited C++ object construction site.
485 // This is set in the construction trigger and read when the constructor
Artem Dergachev1527dec2018-03-12 23:12:40 +0000486 // or a function that returns an object by value is being visited.
487 llvm::DenseMap<Expr *, const ConstructionContextLayer *>
Artem Dergachev5e2f6ba2018-02-23 22:49:25 +0000488 ConstructionContextMap;
Artem Dergachev41ffb302018-02-08 22:58:15 +0000489
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000490 using DeclsWithEndedScopeSetTy = llvm::SmallSetVector<VarDecl *, 16>;
491 DeclsWithEndedScopeSetTy DeclsWithEndedScope;
492
Eugene Zelenko38c70522017-12-07 21:55:09 +0000493 bool badCFG = false;
Ted Kremenekf9d82902011-03-10 01:14:05 +0000494 const CFG::BuildOptions &BuildOpts;
Fangrui Song6907ce22018-07-30 19:24:48 +0000495
Ted Kremenekeff9a7f2011-03-01 23:12:55 +0000496 // State to track for building switch statements.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000497 bool switchExclusivelyCovered = false;
498 Expr::EvalResult *switchCond = nullptr;
Fangrui Song6907ce22018-07-30 19:24:48 +0000499
Eugene Zelenko38c70522017-12-07 21:55:09 +0000500 CFG::BuildOptions::ForcedBlkExprs::value_type *cachedEntry = nullptr;
501 const Stmt *lastLookup = nullptr;
Zhongxing Xud38fb842010-09-16 03:28:18 +0000502
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000503 // Caches boolean evaluations of expressions to avoid multiple re-evaluations
504 // during construction of branches for chained logical operators.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000505 using CachedBoolEvalsTy = llvm::DenseMap<Expr *, TryResult>;
NAKAMURA Takumie9ca55e2012-03-25 06:30:37 +0000506 CachedBoolEvalsTy CachedBoolEvals;
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +0000507
Mike Stump31feda52009-07-17 01:31:16 +0000508public:
Ted Kremenekf9d82902011-03-10 01:14:05 +0000509 explicit CFGBuilder(ASTContext *astContext,
Nico Weber699670e2017-08-23 15:33:16 +0000510 const CFG::BuildOptions &buildOpts)
511 : Context(astContext), cfg(new CFG()), // crew a new CFG
Artem Dergachev5e2f6ba2018-02-23 22:49:25 +0000512 ConstructionContextMap(), BuildOpts(buildOpts) {}
513
Mike Stump31feda52009-07-17 01:31:16 +0000514
Ted Kremenek9aae5132007-08-23 21:42:29 +0000515 // buildCFG - Used by external clients to construct the CFG.
David Blaikiee90195c2014-08-29 18:53:26 +0000516 std::unique_ptr<CFG> buildCFG(const Decl *D, Stmt *Statement);
Mike Stump31feda52009-07-17 01:31:16 +0000517
Ted Kremeneka099c592011-03-10 03:50:34 +0000518 bool alwaysAdd(const Stmt *stmt);
Fangrui Song6907ce22018-07-30 19:24:48 +0000519
Ted Kremenek93668002009-07-17 22:18:43 +0000520private:
521 // Visitors to walk an AST and construct the CFG.
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000522 CFGBlock *VisitAddrLabelExpr(AddrLabelExpr *A, AddStmtChoice asc);
523 CFGBlock *VisitBinaryOperator(BinaryOperator *B, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000524 CFGBlock *VisitBreakStmt(BreakStmt *B);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000525 CFGBlock *VisitCallExpr(CallExpr *C, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000526 CFGBlock *VisitCaseStmt(CaseStmt *C);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000527 CFGBlock *VisitChooseExpr(ChooseExpr *C, AddStmtChoice asc);
Artem Dergachevead98ea2019-08-28 18:44:42 +0000528 CFGBlock *VisitCompoundStmt(CompoundStmt *C, bool ExternallyDestructed);
John McCallc07a0c72011-02-17 10:25:35 +0000529 CFGBlock *VisitConditionalOperator(AbstractConditionalOperator *C,
530 AddStmtChoice asc);
Ted Kremenek21822592009-07-17 18:20:32 +0000531 CFGBlock *VisitContinueStmt(ContinueStmt *C);
Ted Kremenek6f400242012-07-14 05:04:01 +0000532 CFGBlock *VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
533 AddStmtChoice asc);
534 CFGBlock *VisitCXXCatchStmt(CXXCatchStmt *S);
535 CFGBlock *VisitCXXConstructExpr(CXXConstructExpr *C, AddStmtChoice asc);
Jordan Rosec9176072014-01-13 17:59:19 +0000536 CFGBlock *VisitCXXNewExpr(CXXNewExpr *DE, AddStmtChoice asc);
Jordan Rosed2f40792013-09-03 17:00:57 +0000537 CFGBlock *VisitCXXDeleteExpr(CXXDeleteExpr *DE, AddStmtChoice asc);
Ted Kremenek6f400242012-07-14 05:04:01 +0000538 CFGBlock *VisitCXXForRangeStmt(CXXForRangeStmt *S);
539 CFGBlock *VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
540 AddStmtChoice asc);
541 CFGBlock *VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
542 AddStmtChoice asc);
543 CFGBlock *VisitCXXThrowExpr(CXXThrowExpr *T);
544 CFGBlock *VisitCXXTryStmt(CXXTryStmt *S);
Ted Kremenek93668002009-07-17 22:18:43 +0000545 CFGBlock *VisitDeclStmt(DeclStmt *DS);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000546 CFGBlock *VisitDeclSubExpr(DeclStmt *DS);
Ted Kremenek21822592009-07-17 18:20:32 +0000547 CFGBlock *VisitDefaultStmt(DefaultStmt *D);
548 CFGBlock *VisitDoStmt(DoStmt *D);
Artem Dergachevead98ea2019-08-28 18:44:42 +0000549 CFGBlock *VisitExprWithCleanups(ExprWithCleanups *E,
550 AddStmtChoice asc, bool ExternallyDestructed);
Ted Kremenek21822592009-07-17 18:20:32 +0000551 CFGBlock *VisitForStmt(ForStmt *F);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000552 CFGBlock *VisitGotoStmt(GotoStmt *G);
Jennifer Yub8fee672019-06-03 15:57:25 +0000553 CFGBlock *VisitGCCAsmStmt(GCCAsmStmt *G, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000554 CFGBlock *VisitIfStmt(IfStmt *I);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +0000555 CFGBlock *VisitImplicitCastExpr(ImplicitCastExpr *E, AddStmtChoice asc);
Bill Wendling8003edc2018-11-09 00:41:36 +0000556 CFGBlock *VisitConstantExpr(ConstantExpr *E, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000557 CFGBlock *VisitIndirectGotoStmt(IndirectGotoStmt *I);
558 CFGBlock *VisitLabelStmt(LabelStmt *L);
Devin Coughlinb6029b72015-11-25 22:35:37 +0000559 CFGBlock *VisitBlockExpr(BlockExpr *E, AddStmtChoice asc);
Ted Kremenek6f400242012-07-14 05:04:01 +0000560 CFGBlock *VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc);
Ted Kremeneka16436f2012-07-14 05:04:06 +0000561 CFGBlock *VisitLogicalOperator(BinaryOperator *B);
Ted Kremenekb50e7162012-07-14 05:04:10 +0000562 std::pair<CFGBlock *, CFGBlock *> VisitLogicalOperator(BinaryOperator *B,
563 Stmt *Term,
564 CFGBlock *TrueBlock,
565 CFGBlock *FalseBlock);
Artem Dergachevf43ac4c2018-02-24 02:00:30 +0000566 CFGBlock *VisitMaterializeTemporaryExpr(MaterializeTemporaryExpr *MTE,
567 AddStmtChoice asc);
Ted Kremenek5868ec62010-04-11 17:02:10 +0000568 CFGBlock *VisitMemberExpr(MemberExpr *M, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000569 CFGBlock *VisitObjCAtCatchStmt(ObjCAtCatchStmt *S);
570 CFGBlock *VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S);
571 CFGBlock *VisitObjCAtThrowStmt(ObjCAtThrowStmt *S);
572 CFGBlock *VisitObjCAtTryStmt(ObjCAtTryStmt *S);
Ted Kremenek6f400242012-07-14 05:04:01 +0000573 CFGBlock *VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S);
Ted Kremenek93668002009-07-17 22:18:43 +0000574 CFGBlock *VisitObjCForCollectionStmt(ObjCForCollectionStmt *S);
Artem Dergachevbd880fe2018-07-31 19:39:37 +0000575 CFGBlock *VisitObjCMessageExpr(ObjCMessageExpr *E, AddStmtChoice asc);
John McCallfe96e0b2011-11-06 09:01:30 +0000576 CFGBlock *VisitPseudoObjectExpr(PseudoObjectExpr *E);
Brian Gesiaka87ecf62018-11-03 22:35:17 +0000577 CFGBlock *VisitReturnStmt(Stmt *S);
Nico Weber699670e2017-08-23 15:33:16 +0000578 CFGBlock *VisitSEHExceptStmt(SEHExceptStmt *S);
579 CFGBlock *VisitSEHFinallyStmt(SEHFinallyStmt *S);
580 CFGBlock *VisitSEHLeaveStmt(SEHLeaveStmt *S);
581 CFGBlock *VisitSEHTryStmt(SEHTryStmt *S);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000582 CFGBlock *VisitStmtExpr(StmtExpr *S, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000583 CFGBlock *VisitSwitchStmt(SwitchStmt *S);
Ted Kremenek6f400242012-07-14 05:04:01 +0000584 CFGBlock *VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
585 AddStmtChoice asc);
Zhanyong Wan6dace612010-11-22 08:45:56 +0000586 CFGBlock *VisitUnaryOperator(UnaryOperator *U, AddStmtChoice asc);
Ted Kremenek93668002009-07-17 22:18:43 +0000587 CFGBlock *VisitWhileStmt(WhileStmt *W);
Mike Stump48871a22009-07-17 01:04:31 +0000588
Artem Dergachevead98ea2019-08-28 18:44:42 +0000589 CFGBlock *Visit(Stmt *S, AddStmtChoice asc = AddStmtChoice::NotAlwaysAdd,
590 bool ExternallyDestructed = false);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000591 CFGBlock *VisitStmt(Stmt *S, AddStmtChoice asc);
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000592 CFGBlock *VisitChildren(Stmt *S);
Ted Kremeneke2499842012-04-12 20:03:44 +0000593 CFGBlock *VisitNoRecurse(Expr *E, AddStmtChoice asc);
Alexey Bataevc2c21ef2019-07-11 14:54:17 +0000594 CFGBlock *VisitOMPExecutableDirective(OMPExecutableDirective *D,
595 AddStmtChoice asc);
Mike Stump48871a22009-07-17 01:04:31 +0000596
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000597 void maybeAddScopeBeginForVarDecl(CFGBlock *B, const VarDecl *VD,
598 const Stmt *S) {
599 if (ScopePos && (VD == ScopePos.getFirstVarInScope()))
600 appendScopeBegin(B, VD, S);
601 }
602
Manuel Klimekb5616c92014-08-07 10:42:17 +0000603 /// When creating the CFG for temporary destructors, we want to mirror the
604 /// branch structure of the corresponding constructor calls.
605 /// Thus, while visiting a statement for temporary destructors, we keep a
606 /// context to keep track of the following information:
607 /// - whether a subexpression is executed unconditionally
608 /// - if a subexpression is executed conditionally, the first
609 /// CXXBindTemporaryExpr we encounter in that subexpression (which
610 /// corresponds to the last temporary destructor we have to call for this
611 /// subexpression) and the CFG block at that point (which will become the
612 /// successor block when inserting the decision point).
613 ///
614 /// That way, we can build the branch structure for temporary destructors as
615 /// follows:
616 /// 1. If a subexpression is executed unconditionally, we add the temporary
617 /// destructor calls to the current block.
618 /// 2. If a subexpression is executed conditionally, when we encounter a
619 /// CXXBindTemporaryExpr:
620 /// a) If it is the first temporary destructor call in the subexpression,
621 /// we remember the CXXBindTemporaryExpr and the current block in the
622 /// TempDtorContext; we start a new block, and insert the temporary
623 /// destructor call.
624 /// b) Otherwise, add the temporary destructor call to the current block.
625 /// 3. When we finished visiting a conditionally executed subexpression,
626 /// and we found at least one temporary constructor during the visitation
627 /// (2.a has executed), we insert a decision block that uses the
628 /// CXXBindTemporaryExpr as terminator, and branches to the current block
629 /// if the CXXBindTemporaryExpr was marked executed, and otherwise
630 /// branches to the stored successor.
631 struct TempDtorContext {
Eugene Zelenko38c70522017-12-07 21:55:09 +0000632 TempDtorContext() = default;
Manuel Klimekdeb02622014-08-08 07:37:13 +0000633 TempDtorContext(TryResult KnownExecuted)
Eugene Zelenko38c70522017-12-07 21:55:09 +0000634 : IsConditional(true), KnownExecuted(KnownExecuted) {}
Manuel Klimekb5616c92014-08-07 10:42:17 +0000635
636 /// Returns whether we need to start a new branch for a temporary destructor
Eric Christopher2c4555a2015-06-19 01:52:53 +0000637 /// call. This is the case when the temporary destructor is
Manuel Klimekb5616c92014-08-07 10:42:17 +0000638 /// conditionally executed, and it is the first one we encounter while
639 /// visiting a subexpression - other temporary destructors at the same level
640 /// will be added to the same block and are executed under the same
641 /// condition.
642 bool needsTempDtorBranch() const {
643 return IsConditional && !TerminatorExpr;
644 }
645
646 /// Remember the successor S of a temporary destructor decision branch for
647 /// the corresponding CXXBindTemporaryExpr E.
648 void setDecisionPoint(CFGBlock *S, CXXBindTemporaryExpr *E) {
649 Succ = S;
650 TerminatorExpr = E;
651 }
652
Eugene Zelenko38c70522017-12-07 21:55:09 +0000653 const bool IsConditional = false;
654 const TryResult KnownExecuted = true;
655 CFGBlock *Succ = nullptr;
656 CXXBindTemporaryExpr *TerminatorExpr = nullptr;
Manuel Klimekb5616c92014-08-07 10:42:17 +0000657 };
658
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000659 // Visitors to walk an AST and generate destructors of temporaries in
660 // full expression.
Artem Dergachevead98ea2019-08-28 18:44:42 +0000661 CFGBlock *VisitForTemporaryDtors(Stmt *E, bool ExternallyDestructed,
Manuel Klimekb5616c92014-08-07 10:42:17 +0000662 TempDtorContext &Context);
Artem Dergachevead98ea2019-08-28 18:44:42 +0000663 CFGBlock *VisitChildrenForTemporaryDtors(Stmt *E, bool ExternallyDestructed,
664 TempDtorContext &Context);
Manuel Klimekb5616c92014-08-07 10:42:17 +0000665 CFGBlock *VisitBinaryOperatorForTemporaryDtors(BinaryOperator *E,
Artem Dergachevead98ea2019-08-28 18:44:42 +0000666 bool ExternallyDestructed,
Manuel Klimekb5616c92014-08-07 10:42:17 +0000667 TempDtorContext &Context);
668 CFGBlock *VisitCXXBindTemporaryExprForTemporaryDtors(
Artem Dergachevead98ea2019-08-28 18:44:42 +0000669 CXXBindTemporaryExpr *E, bool ExternallyDestructed, TempDtorContext &Context);
Manuel Klimekb5616c92014-08-07 10:42:17 +0000670 CFGBlock *VisitConditionalOperatorForTemporaryDtors(
Artem Dergachevead98ea2019-08-28 18:44:42 +0000671 AbstractConditionalOperator *E, bool ExternallyDestructed,
Manuel Klimekb5616c92014-08-07 10:42:17 +0000672 TempDtorContext &Context);
673 void InsertTempDtorDecisionBlock(const TempDtorContext &Context,
674 CFGBlock *FalseSucc = nullptr);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000675
Ted Kremenek6065ef62008-04-28 18:00:46 +0000676 // NYS == Not Yet Supported
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000677 CFGBlock *NYS() {
Ted Kremenekb64d1832008-03-13 03:04:22 +0000678 badCFG = true;
679 return Block;
680 }
Mike Stump31feda52009-07-17 01:31:16 +0000681
Artem Dergachev40684812018-02-27 20:03:35 +0000682 // Remember to apply the construction context based on the current \p Layer
683 // when constructing the CFG element for \p CE.
684 void consumeConstructionContext(const ConstructionContextLayer *Layer,
Artem Dergachev1527dec2018-03-12 23:12:40 +0000685 Expr *E);
Artem Dergachevc1b07bd2018-02-23 23:38:41 +0000686
Artem Dergachev40684812018-02-27 20:03:35 +0000687 // Scan \p Child statement to find constructors in it, while keeping in mind
688 // that its parent statement is providing a partial construction context
689 // described by \p Layer. If a constructor is found, it would be assigned
690 // the context based on the layer. If an additional construction context layer
691 // is found, the function recurses into that.
692 void findConstructionContexts(const ConstructionContextLayer *Layer,
Artem Dergachev783a4572018-02-23 22:20:39 +0000693 Stmt *Child);
Artem Dergachev40684812018-02-27 20:03:35 +0000694
Artem Dergachevbd880fe2018-07-31 19:39:37 +0000695 // Scan all arguments of a call expression for a construction context.
696 // These sorts of call expressions don't have a common superclass,
697 // hence strict duck-typing.
698 template <typename CallLikeExpr,
699 typename = typename std::enable_if<
700 std::is_same<CallLikeExpr, CallExpr>::value ||
701 std::is_same<CallLikeExpr, CXXConstructExpr>::value ||
702 std::is_same<CallLikeExpr, ObjCMessageExpr>::value>>
703 void findConstructionContextsForArguments(CallLikeExpr *E) {
Artem Dergacheva657a322018-07-31 20:45:53 +0000704 for (unsigned i = 0, e = E->getNumArgs(); i != e; ++i) {
705 Expr *Arg = E->getArg(i);
Artem Dergachevbd880fe2018-07-31 19:39:37 +0000706 if (Arg->getType()->getAsCXXRecordDecl() && !Arg->isGLValue())
707 findConstructionContexts(
Artem Dergachev1f8cb3a2018-07-31 21:12:42 +0000708 ConstructionContextLayer::create(cfg->getBumpVectorContext(),
709 ConstructionContextItem(E, i)),
Artem Dergachevbd880fe2018-07-31 19:39:37 +0000710 Arg);
Artem Dergacheva657a322018-07-31 20:45:53 +0000711 }
Artem Dergachevbd880fe2018-07-31 19:39:37 +0000712 }
713
Artem Dergachev41ffb302018-02-08 22:58:15 +0000714 // Unset the construction context after consuming it. This is done immediately
Artem Dergachev1527dec2018-03-12 23:12:40 +0000715 // after adding the CFGConstructor or CFGCXXRecordTypedCall element, so
716 // there's no need to do this manually in every Visit... function.
717 void cleanupConstructionContext(Expr *E);
Artem Dergachev41ffb302018-02-08 22:58:15 +0000718
Ted Kremenek93668002009-07-17 22:18:43 +0000719 void autoCreateBlock() { if (!Block) Block = createBlock(); }
720 CFGBlock *createBlock(bool add_successor = true);
Chandler Carrutha70991b2011-09-13 09:13:49 +0000721 CFGBlock *createNoReturnBlock();
Zhongxing Xu33dfc072010-09-06 07:32:31 +0000722
Zhongxing Xuea9fcff2010-06-03 06:43:23 +0000723 CFGBlock *addStmt(Stmt *S) {
724 return Visit(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek4cad5fc2009-12-16 03:18:58 +0000725 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000726
Alexis Hunt1d792652011-01-08 20:30:50 +0000727 CFGBlock *addInitializer(CXXCtorInitializer *I);
Peter Szecsi999a25f2017-08-19 11:19:16 +0000728 void addLoopExit(const Stmt *LoopStmt);
Zhongxing Xu6d372f72010-10-01 03:22:39 +0000729 void addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000730 LocalScope::const_iterator E, Stmt *S);
Matthias Gehre351c2182017-07-12 07:04:19 +0000731 void addLifetimeEnds(LocalScope::const_iterator B,
732 LocalScope::const_iterator E, Stmt *S);
733 void addAutomaticObjHandling(LocalScope::const_iterator B,
734 LocalScope::const_iterator E, Stmt *S);
Marcin Swiderski20b88732010-10-05 05:37:00 +0000735 void addImplicitDtorsForDestructor(const CXXDestructorDecl *DD);
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000736 void addScopesEnd(LocalScope::const_iterator B, LocalScope::const_iterator E,
737 Stmt *S);
738
739 void getDeclsWithEndedScope(LocalScope::const_iterator B,
740 LocalScope::const_iterator E, Stmt *S);
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000741
Marcin Swiderski5e415732010-09-30 23:05:00 +0000742 // Local scopes creation.
743 LocalScope* createOrReuseLocalScope(LocalScope* Scope);
744
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000745 void addLocalScopeForStmt(Stmt *S);
Craig Topper25542942014-05-20 04:30:07 +0000746 LocalScope* addLocalScopeForDeclStmt(DeclStmt *DS,
747 LocalScope* Scope = nullptr);
748 LocalScope* addLocalScopeForVarDecl(VarDecl *VD, LocalScope* Scope = nullptr);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000749
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000750 void addLocalScopeAndDtors(Stmt *S);
Marcin Swiderski5e415732010-09-30 23:05:00 +0000751
Artem Dergacheve1f30622018-07-31 19:46:14 +0000752 const ConstructionContext *retrieveAndCleanupConstructionContext(Expr *E) {
753 if (!BuildOpts.AddRichCXXConstructors)
754 return nullptr;
755
756 const ConstructionContextLayer *Layer = ConstructionContextMap.lookup(E);
757 if (!Layer)
758 return nullptr;
759
760 cleanupConstructionContext(E);
761 return ConstructionContext::createFromLayers(cfg->getBumpVectorContext(),
762 Layer);
763 }
764
Marcin Swiderski5e415732010-09-30 23:05:00 +0000765 // Interface to CFGBlock - adding CFGElements.
Eugene Zelenko38c70522017-12-07 21:55:09 +0000766
Ted Kremenek37881932011-04-04 23:29:12 +0000767 void appendStmt(CFGBlock *B, const Stmt *S) {
Ted Kremenek8b46c002011-07-19 14:18:43 +0000768 if (alwaysAdd(S) && cachedEntry)
Ted Kremeneka099c592011-03-10 03:50:34 +0000769 cachedEntry->second = B;
Ted Kremeneka099c592011-03-10 03:50:34 +0000770
Jordy Rose17347372011-06-10 08:49:37 +0000771 // All block-level expressions should have already been IgnoreParens()ed.
772 assert(!isa<Expr>(S) || cast<Expr>(S)->IgnoreParens() == S);
Ted Kremenek37881932011-04-04 23:29:12 +0000773 B->appendStmt(const_cast<Stmt*>(S), cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000774 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000775
Artem Dergachev41ffb302018-02-08 22:58:15 +0000776 void appendConstructor(CFGBlock *B, CXXConstructExpr *CE) {
Artem Dergacheve1f30622018-07-31 19:46:14 +0000777 if (const ConstructionContext *CC =
778 retrieveAndCleanupConstructionContext(CE)) {
779 B->appendConstructor(CE, CC, cfg->getBumpVectorContext());
780 return;
Artem Dergachev41ffb302018-02-08 22:58:15 +0000781 }
782
783 // No valid construction context found. Fall back to statement.
784 B->appendStmt(CE, cfg->getBumpVectorContext());
785 }
786
Artem Dergachev1527dec2018-03-12 23:12:40 +0000787 void appendCall(CFGBlock *B, CallExpr *CE) {
Richard Trieuf4a0e9a2018-03-15 00:09:26 +0000788 if (alwaysAdd(CE) && cachedEntry)
789 cachedEntry->second = B;
790
Artem Dergacheve1f30622018-07-31 19:46:14 +0000791 if (const ConstructionContext *CC =
792 retrieveAndCleanupConstructionContext(CE)) {
793 B->appendCXXRecordTypedCall(CE, CC, cfg->getBumpVectorContext());
794 return;
Artem Dergachev1527dec2018-03-12 23:12:40 +0000795 }
796
797 // No valid construction context found. Fall back to statement.
798 B->appendStmt(CE, cfg->getBumpVectorContext());
799 }
800
Alexis Hunt1d792652011-01-08 20:30:50 +0000801 void appendInitializer(CFGBlock *B, CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +0000802 B->appendInitializer(I, cfg->getBumpVectorContext());
803 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000804
Jordan Rosec9176072014-01-13 17:59:19 +0000805 void appendNewAllocator(CFGBlock *B, CXXNewExpr *NE) {
806 B->appendNewAllocator(NE, cfg->getBumpVectorContext());
807 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000808
Marcin Swiderski20b88732010-10-05 05:37:00 +0000809 void appendBaseDtor(CFGBlock *B, const CXXBaseSpecifier *BS) {
810 B->appendBaseDtor(BS, cfg->getBumpVectorContext());
811 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000812
Marcin Swiderski20b88732010-10-05 05:37:00 +0000813 void appendMemberDtor(CFGBlock *B, FieldDecl *FD) {
814 B->appendMemberDtor(FD, cfg->getBumpVectorContext());
815 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000816
Artem Dergacheve1f30622018-07-31 19:46:14 +0000817 void appendObjCMessage(CFGBlock *B, ObjCMessageExpr *ME) {
818 if (alwaysAdd(ME) && cachedEntry)
819 cachedEntry->second = B;
820
821 if (const ConstructionContext *CC =
822 retrieveAndCleanupConstructionContext(ME)) {
823 B->appendCXXRecordTypedCall(ME, CC, cfg->getBumpVectorContext());
824 return;
825 }
826
827 B->appendStmt(const_cast<ObjCMessageExpr *>(ME),
828 cfg->getBumpVectorContext());
829 }
830
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +0000831 void appendTemporaryDtor(CFGBlock *B, CXXBindTemporaryExpr *E) {
832 B->appendTemporaryDtor(E, cfg->getBumpVectorContext());
833 }
Eugene Zelenko38c70522017-12-07 21:55:09 +0000834
Chandler Carruthad747252011-09-13 06:09:01 +0000835 void appendAutomaticObjDtor(CFGBlock *B, VarDecl *VD, Stmt *S) {
836 B->appendAutomaticObjDtor(VD, S, cfg->getBumpVectorContext());
837 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +0000838
Matthias Gehre351c2182017-07-12 07:04:19 +0000839 void appendLifetimeEnds(CFGBlock *B, VarDecl *VD, Stmt *S) {
840 B->appendLifetimeEnds(VD, S, cfg->getBumpVectorContext());
841 }
842
Peter Szecsi999a25f2017-08-19 11:19:16 +0000843 void appendLoopExit(CFGBlock *B, const Stmt *LoopStmt) {
844 B->appendLoopExit(LoopStmt, cfg->getBumpVectorContext());
845 }
846
Jordan Rosed2f40792013-09-03 17:00:57 +0000847 void appendDeleteDtor(CFGBlock *B, CXXRecordDecl *RD, CXXDeleteExpr *DE) {
848 B->appendDeleteDtor(RD, DE, cfg->getBumpVectorContext());
849 }
850
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000851 void prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +0000852 LocalScope::const_iterator B, LocalScope::const_iterator E);
853
Matthias Gehre351c2182017-07-12 07:04:19 +0000854 void prependAutomaticObjLifetimeWithTerminator(CFGBlock *Blk,
855 LocalScope::const_iterator B,
856 LocalScope::const_iterator E);
857
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000858 const VarDecl *
859 prependAutomaticObjScopeEndWithTerminator(CFGBlock *Blk,
860 LocalScope::const_iterator B,
861 LocalScope::const_iterator E);
862
Ted Kremenek4b6fee62014-02-27 00:24:00 +0000863 void addSuccessor(CFGBlock *B, CFGBlock *S, bool IsReachable = true) {
864 B->addSuccessor(CFGBlock::AdjacentBlock(S, IsReachable),
865 cfg->getBumpVectorContext());
866 }
867
868 /// Add a reachable successor to a block, with the alternate variant that is
869 /// unreachable.
870 void addSuccessor(CFGBlock *B, CFGBlock *ReachableBlock, CFGBlock *AltBlock) {
871 B->addSuccessor(CFGBlock::AdjacentBlock(ReachableBlock, AltBlock),
872 cfg->getBumpVectorContext());
Ted Kremenek289ae4f2009-10-12 20:55:07 +0000873 }
Mike Stump11289f42009-09-09 15:08:12 +0000874
Maxim Ostapenkodebca452018-03-12 12:26:15 +0000875 void appendScopeBegin(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
876 if (BuildOpts.AddScopes)
877 B->appendScopeBegin(VD, S, cfg->getBumpVectorContext());
878 }
879
880 void prependScopeBegin(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
881 if (BuildOpts.AddScopes)
882 B->prependScopeBegin(VD, S, cfg->getBumpVectorContext());
883 }
884
885 void appendScopeEnd(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
886 if (BuildOpts.AddScopes)
887 B->appendScopeEnd(VD, S, cfg->getBumpVectorContext());
888 }
889
890 void prependScopeEnd(CFGBlock *B, const VarDecl *VD, const Stmt *S) {
891 if (BuildOpts.AddScopes)
892 B->prependScopeEnd(VD, S, cfg->getBumpVectorContext());
893 }
894
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000895 /// Find a relational comparison with an expression evaluating to a
Richard Trieuf935b562014-04-05 05:17:01 +0000896 /// boolean and a constant other than 0 and 1.
897 /// e.g. if ((x < y) == 10)
898 TryResult checkIncorrectRelationalOperator(const BinaryOperator *B) {
899 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
900 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
901
902 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
903 const Expr *BoolExpr = RHSExpr;
904 bool IntFirst = true;
905 if (!IntLiteral) {
906 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
907 BoolExpr = LHSExpr;
908 IntFirst = false;
909 }
910
911 if (!IntLiteral || !BoolExpr->isKnownToHaveBooleanValue())
912 return TryResult();
913
914 llvm::APInt IntValue = IntLiteral->getValue();
915 if ((IntValue == 1) || (IntValue == 0))
916 return TryResult();
917
918 bool IntLarger = IntLiteral->getType()->isUnsignedIntegerType() ||
919 !IntValue.isNegative();
920
921 BinaryOperatorKind Bok = B->getOpcode();
922 if (Bok == BO_GT || Bok == BO_GE) {
923 // Always true for 10 > bool and bool > -1
924 // Always false for -1 > bool and bool > 10
925 return TryResult(IntFirst == IntLarger);
926 } else {
927 // Always true for -1 < bool and bool < 10
928 // Always false for 10 < bool and bool < -1
929 return TryResult(IntFirst != IntLarger);
930 }
931 }
932
Jordan Rose7afd71e2014-05-20 17:31:11 +0000933 /// Find an incorrect equality comparison. Either with an expression
934 /// evaluating to a boolean and a constant other than 0 and 1.
935 /// e.g. if (!x == 10) or a bitwise and/or operation that always evaluates to
936 /// true/false e.q. (x & 8) == 4.
Richard Trieuf935b562014-04-05 05:17:01 +0000937 TryResult checkIncorrectEqualityOperator(const BinaryOperator *B) {
938 const Expr *LHSExpr = B->getLHS()->IgnoreParens();
939 const Expr *RHSExpr = B->getRHS()->IgnoreParens();
940
941 const IntegerLiteral *IntLiteral = dyn_cast<IntegerLiteral>(LHSExpr);
942 const Expr *BoolExpr = RHSExpr;
943
944 if (!IntLiteral) {
945 IntLiteral = dyn_cast<IntegerLiteral>(RHSExpr);
946 BoolExpr = LHSExpr;
947 }
948
Jordan Rose7afd71e2014-05-20 17:31:11 +0000949 if (!IntLiteral)
Richard Trieuf935b562014-04-05 05:17:01 +0000950 return TryResult();
951
Jordan Rose7afd71e2014-05-20 17:31:11 +0000952 const BinaryOperator *BitOp = dyn_cast<BinaryOperator>(BoolExpr);
953 if (BitOp && (BitOp->getOpcode() == BO_And ||
954 BitOp->getOpcode() == BO_Or)) {
955 const Expr *LHSExpr2 = BitOp->getLHS()->IgnoreParens();
956 const Expr *RHSExpr2 = BitOp->getRHS()->IgnoreParens();
957
958 const IntegerLiteral *IntLiteral2 = dyn_cast<IntegerLiteral>(LHSExpr2);
959
960 if (!IntLiteral2)
961 IntLiteral2 = dyn_cast<IntegerLiteral>(RHSExpr2);
962
963 if (!IntLiteral2)
964 return TryResult();
965
966 llvm::APInt L1 = IntLiteral->getValue();
967 llvm::APInt L2 = IntLiteral2->getValue();
968 if ((BitOp->getOpcode() == BO_And && (L2 & L1) != L1) ||
969 (BitOp->getOpcode() == BO_Or && (L2 | L1) != L1)) {
970 if (BuildOpts.Observer)
971 BuildOpts.Observer->compareBitwiseEquality(B,
972 B->getOpcode() != BO_EQ);
973 TryResult(B->getOpcode() != BO_EQ);
974 }
975 } else if (BoolExpr->isKnownToHaveBooleanValue()) {
976 llvm::APInt IntValue = IntLiteral->getValue();
977 if ((IntValue == 1) || (IntValue == 0)) {
978 return TryResult();
979 }
980 return TryResult(B->getOpcode() != BO_EQ);
Richard Trieuf935b562014-04-05 05:17:01 +0000981 }
982
Jordan Rose7afd71e2014-05-20 17:31:11 +0000983 return TryResult();
Richard Trieuf935b562014-04-05 05:17:01 +0000984 }
985
986 TryResult analyzeLogicOperatorCondition(BinaryOperatorKind Relation,
987 const llvm::APSInt &Value1,
988 const llvm::APSInt &Value2) {
989 assert(Value1.isSigned() == Value2.isSigned());
990 switch (Relation) {
991 default:
992 return TryResult();
993 case BO_EQ:
994 return TryResult(Value1 == Value2);
995 case BO_NE:
996 return TryResult(Value1 != Value2);
997 case BO_LT:
998 return TryResult(Value1 < Value2);
999 case BO_LE:
1000 return TryResult(Value1 <= Value2);
1001 case BO_GT:
1002 return TryResult(Value1 > Value2);
1003 case BO_GE:
1004 return TryResult(Value1 >= Value2);
1005 }
1006 }
1007
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001008 /// Find a pair of comparison expressions with or without parentheses
Richard Trieuf935b562014-04-05 05:17:01 +00001009 /// with a shared variable and constants and a logical operator between them
1010 /// that always evaluates to either true or false.
1011 /// e.g. if (x != 3 || x != 4)
1012 TryResult checkIncorrectLogicOperator(const BinaryOperator *B) {
1013 assert(B->isLogicalOp());
1014 const BinaryOperator *LHS =
1015 dyn_cast<BinaryOperator>(B->getLHS()->IgnoreParens());
1016 const BinaryOperator *RHS =
1017 dyn_cast<BinaryOperator>(B->getRHS()->IgnoreParens());
1018 if (!LHS || !RHS)
Eugene Zelenko38c70522017-12-07 21:55:09 +00001019 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001020
1021 if (!LHS->isComparisonOp() || !RHS->isComparisonOp())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001022 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001023
George Burgess IVced56e62015-10-01 18:47:52 +00001024 const DeclRefExpr *Decl1;
1025 const Expr *Expr1;
1026 BinaryOperatorKind BO1;
1027 std::tie(Decl1, BO1, Expr1) = tryNormalizeBinaryOperator(LHS);
Richard Trieuf935b562014-04-05 05:17:01 +00001028
George Burgess IVced56e62015-10-01 18:47:52 +00001029 if (!Decl1 || !Expr1)
Eugene Zelenko38c70522017-12-07 21:55:09 +00001030 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001031
George Burgess IVced56e62015-10-01 18:47:52 +00001032 const DeclRefExpr *Decl2;
1033 const Expr *Expr2;
1034 BinaryOperatorKind BO2;
1035 std::tie(Decl2, BO2, Expr2) = tryNormalizeBinaryOperator(RHS);
Richard Trieuf935b562014-04-05 05:17:01 +00001036
George Burgess IVced56e62015-10-01 18:47:52 +00001037 if (!Decl2 || !Expr2)
Eugene Zelenko38c70522017-12-07 21:55:09 +00001038 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001039
1040 // Check that it is the same variable on both sides.
1041 if (Decl1->getDecl() != Decl2->getDecl())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001042 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001043
George Burgess IVced56e62015-10-01 18:47:52 +00001044 // Make sure the user's intent is clear (e.g. they're comparing against two
1045 // int literals, or two things from the same enum)
1046 if (!areExprTypesCompatible(Expr1, Expr2))
Eugene Zelenko38c70522017-12-07 21:55:09 +00001047 return {};
George Burgess IVced56e62015-10-01 18:47:52 +00001048
Fangrui Song407659a2018-11-30 23:41:18 +00001049 Expr::EvalResult L1Result, L2Result;
1050 if (!Expr1->EvaluateAsInt(L1Result, *Context) ||
1051 !Expr2->EvaluateAsInt(L2Result, *Context))
Fangrui Songf5d33352018-11-30 21:26:09 +00001052 return {};
Hans Wennborg48ee4ad2018-11-28 14:04:12 +00001053
Fangrui Song407659a2018-11-30 23:41:18 +00001054 llvm::APSInt L1 = L1Result.Val.getInt();
1055 llvm::APSInt L2 = L2Result.Val.getInt();
1056
Richard Trieuf935b562014-04-05 05:17:01 +00001057 // Can't compare signed with unsigned or with different bit width.
1058 if (L1.isSigned() != L2.isSigned() || L1.getBitWidth() != L2.getBitWidth())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001059 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001060
1061 // Values that will be used to determine if result of logical
1062 // operator is always true/false
1063 const llvm::APSInt Values[] = {
1064 // Value less than both Value1 and Value2
1065 llvm::APSInt::getMinValue(L1.getBitWidth(), L1.isUnsigned()),
1066 // L1
1067 L1,
1068 // Value between Value1 and Value2
1069 ((L1 < L2) ? L1 : L2) + llvm::APSInt(llvm::APInt(L1.getBitWidth(), 1),
1070 L1.isUnsigned()),
1071 // L2
1072 L2,
1073 // Value greater than both Value1 and Value2
1074 llvm::APSInt::getMaxValue(L1.getBitWidth(), L1.isUnsigned()),
1075 };
1076
1077 // Check whether expression is always true/false by evaluating the following
1078 // * variable x is less than the smallest literal.
1079 // * variable x is equal to the smallest literal.
1080 // * Variable x is between smallest and largest literal.
1081 // * Variable x is equal to the largest literal.
1082 // * Variable x is greater than largest literal.
1083 bool AlwaysTrue = true, AlwaysFalse = true;
Benjamin Kramer2e018ef2016-05-27 13:36:58 +00001084 for (const llvm::APSInt &Value : Values) {
Richard Trieuf935b562014-04-05 05:17:01 +00001085 TryResult Res1, Res2;
1086 Res1 = analyzeLogicOperatorCondition(BO1, Value, L1);
1087 Res2 = analyzeLogicOperatorCondition(BO2, Value, L2);
1088
1089 if (!Res1.isKnown() || !Res2.isKnown())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001090 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001091
1092 if (B->getOpcode() == BO_LAnd) {
1093 AlwaysTrue &= (Res1.isTrue() && Res2.isTrue());
1094 AlwaysFalse &= !(Res1.isTrue() && Res2.isTrue());
1095 } else {
1096 AlwaysTrue &= (Res1.isTrue() || Res2.isTrue());
1097 AlwaysFalse &= !(Res1.isTrue() || Res2.isTrue());
1098 }
1099 }
1100
1101 if (AlwaysTrue || AlwaysFalse) {
1102 if (BuildOpts.Observer)
1103 BuildOpts.Observer->compareAlwaysTrue(B, AlwaysTrue);
1104 return TryResult(AlwaysTrue);
1105 }
Eugene Zelenko38c70522017-12-07 21:55:09 +00001106 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001107 }
1108
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00001109 /// Try and evaluate an expression to an integer constant.
1110 bool tryEvaluate(Expr *S, Expr::EvalResult &outResult) {
1111 if (!BuildOpts.PruneTriviallyFalseEdges)
1112 return false;
Fangrui Song6907ce22018-07-30 19:24:48 +00001113 return !S->isTypeDependent() &&
Ted Kremenek352a7082011-04-04 20:30:58 +00001114 !S->isValueDependent() &&
Richard Smith7b553f12011-10-29 00:50:52 +00001115 S->EvaluateAsRValue(outResult, *Context);
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00001116 }
Mike Stump11289f42009-09-09 15:08:12 +00001117
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001118 /// tryEvaluateBool - Try and evaluate the Stmt and return 0 or 1
Mike Stump773582d2009-07-23 23:25:26 +00001119 /// if we can evaluate to a known value, otherwise return -1.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001120 TryResult tryEvaluateBool(Expr *S) {
Richard Smithfaa32a92011-10-14 20:22:00 +00001121 if (!BuildOpts.PruneTriviallyFalseEdges ||
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001122 S->isTypeDependent() || S->isValueDependent())
Eugene Zelenko38c70522017-12-07 21:55:09 +00001123 return {};
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001124
1125 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(S)) {
1126 if (Bop->isLogicalOp()) {
1127 // Check the cache first.
NAKAMURA Takumie9ca55e2012-03-25 06:30:37 +00001128 CachedBoolEvalsTy::iterator I = CachedBoolEvals.find(S);
1129 if (I != CachedBoolEvals.end())
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001130 return I->second; // already in map;
NAKAMURA Takumif0434b02012-03-25 06:30:32 +00001131
1132 // Retrieve result at first, or the map might be updated.
1133 TryResult Result = evaluateAsBooleanConditionNoCache(S);
1134 CachedBoolEvals[S] = Result; // update or insert
1135 return Result;
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001136 }
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001137 else {
1138 switch (Bop->getOpcode()) {
1139 default: break;
1140 // For 'x & 0' and 'x * 0', we can determine that
1141 // the value is always false.
1142 case BO_Mul:
1143 case BO_And: {
1144 // If either operand is zero, we know the value
1145 // must be false.
Fangrui Song407659a2018-11-30 23:41:18 +00001146 Expr::EvalResult LHSResult;
1147 if (Bop->getLHS()->EvaluateAsInt(LHSResult, *Context)) {
1148 llvm::APSInt IntVal = LHSResult.Val.getInt();
David Blaikie7a3cbb22015-03-09 02:02:07 +00001149 if (!IntVal.getBoolValue()) {
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001150 return TryResult(false);
1151 }
1152 }
Fangrui Song407659a2018-11-30 23:41:18 +00001153 Expr::EvalResult RHSResult;
1154 if (Bop->getRHS()->EvaluateAsInt(RHSResult, *Context)) {
1155 llvm::APSInt IntVal = RHSResult.Val.getInt();
David Blaikie7a3cbb22015-03-09 02:02:07 +00001156 if (!IntVal.getBoolValue()) {
Ted Kremenek64fea5f2012-08-24 07:42:09 +00001157 return TryResult(false);
1158 }
1159 }
1160 }
1161 break;
1162 }
1163 }
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001164 }
1165
1166 return evaluateAsBooleanConditionNoCache(S);
1167 }
1168
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001169 /// Evaluate as boolean \param E without using the cache.
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001170 TryResult evaluateAsBooleanConditionNoCache(Expr *E) {
1171 if (BinaryOperator *Bop = dyn_cast<BinaryOperator>(E)) {
1172 if (Bop->isLogicalOp()) {
1173 TryResult LHS = tryEvaluateBool(Bop->getLHS());
1174 if (LHS.isKnown()) {
1175 // We were able to evaluate the LHS, see if we can get away with not
1176 // evaluating the RHS: 0 && X -> 0, 1 || X -> 1
1177 if (LHS.isTrue() == (Bop->getOpcode() == BO_LOr))
1178 return LHS.isTrue();
1179
1180 TryResult RHS = tryEvaluateBool(Bop->getRHS());
1181 if (RHS.isKnown()) {
1182 if (Bop->getOpcode() == BO_LOr)
1183 return LHS.isTrue() || RHS.isTrue();
1184 else
1185 return LHS.isTrue() && RHS.isTrue();
1186 }
1187 } else {
1188 TryResult RHS = tryEvaluateBool(Bop->getRHS());
1189 if (RHS.isKnown()) {
1190 // We can't evaluate the LHS; however, sometimes the result
1191 // is determined by the RHS: X && 0 -> 0, X || 1 -> 1.
1192 if (RHS.isTrue() == (Bop->getOpcode() == BO_LOr))
1193 return RHS.isTrue();
Richard Trieuf935b562014-04-05 05:17:01 +00001194 } else {
1195 TryResult BopRes = checkIncorrectLogicOperator(Bop);
1196 if (BopRes.isKnown())
1197 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001198 }
1199 }
1200
Eugene Zelenko38c70522017-12-07 21:55:09 +00001201 return {};
Richard Trieuf935b562014-04-05 05:17:01 +00001202 } else if (Bop->isEqualityOp()) {
1203 TryResult BopRes = checkIncorrectEqualityOperator(Bop);
1204 if (BopRes.isKnown())
1205 return BopRes.isTrue();
1206 } else if (Bop->isRelationalOp()) {
1207 TryResult BopRes = checkIncorrectRelationalOperator(Bop);
1208 if (BopRes.isKnown())
1209 return BopRes.isTrue();
Argyrios Kyrtzidis5f172a32012-03-23 00:59:17 +00001210 }
1211 }
1212
1213 bool Result;
1214 if (E->EvaluateAsBooleanCondition(Result, *Context))
1215 return Result;
1216
Eugene Zelenko38c70522017-12-07 21:55:09 +00001217 return {};
Mike Stump773582d2009-07-23 23:25:26 +00001218 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001219
1220 bool hasTrivialDestructor(VarDecl *VD);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00001221};
Mike Stump31feda52009-07-17 01:31:16 +00001222
Eugene Zelenko38c70522017-12-07 21:55:09 +00001223} // namespace
1224
Ted Kremeneka099c592011-03-10 03:50:34 +00001225inline bool AddStmtChoice::alwaysAdd(CFGBuilder &builder,
1226 const Stmt *stmt) const {
1227 return builder.alwaysAdd(stmt) || kind == AlwaysAdd;
1228}
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001229
Ted Kremeneka099c592011-03-10 03:50:34 +00001230bool CFGBuilder::alwaysAdd(const Stmt *stmt) {
Ted Kremenek8b46c002011-07-19 14:18:43 +00001231 bool shouldAdd = BuildOpts.alwaysAdd(stmt);
Fangrui Song6907ce22018-07-30 19:24:48 +00001232
Ted Kremeneka099c592011-03-10 03:50:34 +00001233 if (!BuildOpts.forcedBlkExprs)
Ted Kremenek8b46c002011-07-19 14:18:43 +00001234 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001235
Fangrui Song6907ce22018-07-30 19:24:48 +00001236 if (lastLookup == stmt) {
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001237 if (cachedEntry) {
1238 assert(cachedEntry->first == stmt);
1239 return true;
1240 }
Ted Kremenek8b46c002011-07-19 14:18:43 +00001241 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001242 }
Fangrui Song6907ce22018-07-30 19:24:48 +00001243
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001244 lastLookup = stmt;
1245
1246 // Perform the lookup!
Ted Kremeneka099c592011-03-10 03:50:34 +00001247 CFG::BuildOptions::ForcedBlkExprs *fb = *BuildOpts.forcedBlkExprs;
1248
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001249 if (!fb) {
1250 // No need to update 'cachedEntry', since it will always be null.
Craig Topper25542942014-05-20 04:30:07 +00001251 assert(!cachedEntry);
Ted Kremenek8b46c002011-07-19 14:18:43 +00001252 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001253 }
Ted Kremeneka099c592011-03-10 03:50:34 +00001254
1255 CFG::BuildOptions::ForcedBlkExprs::iterator itr = fb->find(stmt);
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001256 if (itr == fb->end()) {
Craig Topper25542942014-05-20 04:30:07 +00001257 cachedEntry = nullptr;
Ted Kremenek8b46c002011-07-19 14:18:43 +00001258 return shouldAdd;
Ted Kremenekdcc4c382011-03-23 21:33:21 +00001259 }
1260
Ted Kremeneka099c592011-03-10 03:50:34 +00001261 cachedEntry = &*itr;
1262 return true;
Ted Kremenek7c58d352011-03-10 01:14:11 +00001263}
Fangrui Song6907ce22018-07-30 19:24:48 +00001264
Douglas Gregor4619e432008-12-05 23:32:09 +00001265// FIXME: Add support for dependent-sized array types in C++?
1266// Does it even make sense to build a CFG for an uninstantiated template?
John McCall424cec92011-01-19 06:33:43 +00001267static const VariableArrayType *FindVA(const Type *t) {
1268 while (const ArrayType *vt = dyn_cast<ArrayType>(t)) {
1269 if (const VariableArrayType *vat = dyn_cast<VariableArrayType>(vt))
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001270 if (vat->getSizeExpr())
1271 return vat;
Mike Stump31feda52009-07-17 01:31:16 +00001272
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001273 t = vt->getElementType().getTypePtr();
1274 }
Mike Stump31feda52009-07-17 01:31:16 +00001275
Craig Topper25542942014-05-20 04:30:07 +00001276 return nullptr;
Ted Kremenekd86d39c2008-09-26 22:58:57 +00001277}
Mike Stump31feda52009-07-17 01:31:16 +00001278
Artem Dergachev40684812018-02-27 20:03:35 +00001279void CFGBuilder::consumeConstructionContext(
Artem Dergachev1527dec2018-03-12 23:12:40 +00001280 const ConstructionContextLayer *Layer, Expr *E) {
Artem Dergacheve1f30622018-07-31 19:46:14 +00001281 assert((isa<CXXConstructExpr>(E) || isa<CallExpr>(E) ||
1282 isa<ObjCMessageExpr>(E)) && "Expression cannot construct an object!");
Artem Dergachev40684812018-02-27 20:03:35 +00001283 if (const ConstructionContextLayer *PreviouslyStoredLayer =
Artem Dergachev1527dec2018-03-12 23:12:40 +00001284 ConstructionContextMap.lookup(E)) {
George Burgess IVa47e1b72018-03-06 07:45:11 +00001285 (void)PreviouslyStoredLayer;
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001286 // We might have visited this child when we were finding construction
1287 // contexts within its parents.
Artem Dergachev40684812018-02-27 20:03:35 +00001288 assert(PreviouslyStoredLayer->isStrictlyMoreSpecificThan(Layer) &&
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001289 "Already within a different construction context!");
1290 } else {
Artem Dergachev1527dec2018-03-12 23:12:40 +00001291 ConstructionContextMap[E] = Layer;
Artem Dergachevc1b07bd2018-02-23 23:38:41 +00001292 }
1293}
1294
Artem Dergachev783a4572018-02-23 22:20:39 +00001295void CFGBuilder::findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001296 const ConstructionContextLayer *Layer, Stmt *Child) {
Artem Dergachev41ffb302018-02-08 22:58:15 +00001297 if (!BuildOpts.AddRichCXXConstructors)
1298 return;
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001299
Artem Dergachev41ffb302018-02-08 22:58:15 +00001300 if (!Child)
1301 return;
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001302
Artem Dergachev1f8cb3a2018-07-31 21:12:42 +00001303 auto withExtraLayer = [this, Layer](const ConstructionContextItem &Item) {
1304 return ConstructionContextLayer::create(cfg->getBumpVectorContext(), Item,
1305 Layer);
Artem Dergachevff267df2018-06-28 00:04:54 +00001306 };
1307
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001308 switch(Child->getStmtClass()) {
1309 case Stmt::CXXConstructExprClass:
1310 case Stmt::CXXTemporaryObjectExprClass: {
Artem Dergachevff267df2018-06-28 00:04:54 +00001311 // Support pre-C++17 copy elision AST.
1312 auto *CE = cast<CXXConstructExpr>(Child);
1313 if (BuildOpts.MarkElidedCXXConstructors && CE->isElidable()) {
Artem Dergachevff267df2018-06-28 00:04:54 +00001314 findConstructionContexts(withExtraLayer(CE), CE->getArg(0));
1315 }
1316
1317 consumeConstructionContext(Layer, CE);
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001318 break;
1319 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00001320 // FIXME: This, like the main visit, doesn't support CUDAKernelCallExpr.
1321 // FIXME: An isa<> would look much better but this whole switch is a
1322 // workaround for an internal compiler error in MSVC 2015 (see r326021).
1323 case Stmt::CallExprClass:
1324 case Stmt::CXXMemberCallExprClass:
1325 case Stmt::CXXOperatorCallExprClass:
Artem Dergacheve1f30622018-07-31 19:46:14 +00001326 case Stmt::UserDefinedLiteralClass:
1327 case Stmt::ObjCMessageExprClass: {
1328 auto *E = cast<Expr>(Child);
1329 if (CFGCXXRecordTypedCall::isCXXRecordTypedCall(E))
1330 consumeConstructionContext(Layer, E);
Artem Dergachev1527dec2018-03-12 23:12:40 +00001331 break;
1332 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001333 case Stmt::ExprWithCleanupsClass: {
1334 auto *Cleanups = cast<ExprWithCleanups>(Child);
Artem Dergachev40684812018-02-27 20:03:35 +00001335 findConstructionContexts(Layer, Cleanups->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001336 break;
1337 }
1338 case Stmt::CXXFunctionalCastExprClass: {
1339 auto *Cast = cast<CXXFunctionalCastExpr>(Child);
Artem Dergachev40684812018-02-27 20:03:35 +00001340 findConstructionContexts(Layer, Cast->getSubExpr());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001341 break;
1342 }
1343 case Stmt::ImplicitCastExprClass: {
1344 auto *Cast = cast<ImplicitCastExpr>(Child);
Artem Dergachev317291e2018-03-22 21:37:39 +00001345 // Should we support other implicit cast kinds?
Artem Dergachev13f96642018-03-09 01:39:59 +00001346 switch (Cast->getCastKind()) {
1347 case CK_NoOp:
1348 case CK_ConstructorConversion:
Artem Dergachev66030522018-03-01 01:09:24 +00001349 findConstructionContexts(Layer, Cast->getSubExpr());
Reid Kleckner4dc0b1a2018-11-01 19:54:45 +00001350 break;
Artem Dergachev13f96642018-03-09 01:39:59 +00001351 default:
1352 break;
1353 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001354 break;
1355 }
1356 case Stmt::CXXBindTemporaryExprClass: {
1357 auto *BTE = cast<CXXBindTemporaryExpr>(Child);
Artem Dergachevff267df2018-06-28 00:04:54 +00001358 findConstructionContexts(withExtraLayer(BTE), BTE->getSubExpr());
1359 break;
1360 }
1361 case Stmt::MaterializeTemporaryExprClass: {
1362 // Normally we don't want to search in MaterializeTemporaryExpr because
1363 // it indicates the beginning of a temporary object construction context,
1364 // so it shouldn't be found in the middle. However, if it is the beginning
1365 // of an elidable copy or move construction context, we need to include it.
Artem Dergachev1f8cb3a2018-07-31 21:12:42 +00001366 if (Layer->getItem().getKind() ==
1367 ConstructionContextItem::ElidableConstructorKind) {
1368 auto *MTE = cast<MaterializeTemporaryExpr>(Child);
1369 findConstructionContexts(withExtraLayer(MTE), MTE->GetTemporaryExpr());
Artem Dergachevff267df2018-06-28 00:04:54 +00001370 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001371 break;
1372 }
1373 case Stmt::ConditionalOperatorClass: {
1374 auto *CO = cast<ConditionalOperator>(Child);
Artem Dergachev1f8cb3a2018-07-31 21:12:42 +00001375 if (Layer->getItem().getKind() !=
1376 ConstructionContextItem::MaterializationKind) {
Artem Dergachev9d3a7d82018-03-30 19:21:18 +00001377 // If the object returned by the conditional operator is not going to be a
1378 // temporary object that needs to be immediately materialized, then
1379 // it must be C++17 with its mandatory copy elision. Do not yet promise
1380 // to support this case.
1381 assert(!CO->getType()->getAsCXXRecordDecl() || CO->isGLValue() ||
1382 Context->getLangOpts().CPlusPlus17);
1383 break;
1384 }
Artem Dergachev40684812018-02-27 20:03:35 +00001385 findConstructionContexts(Layer, CO->getLHS());
1386 findConstructionContexts(Layer, CO->getRHS());
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001387 break;
1388 }
Artem Dergachevaa403152019-03-21 00:15:07 +00001389 case Stmt::InitListExprClass: {
1390 auto *ILE = cast<InitListExpr>(Child);
1391 if (ILE->isTransparent()) {
1392 findConstructionContexts(Layer, ILE->getInit(0));
1393 break;
1394 }
1395 // TODO: Handle other cases. For now, fail to find construction contexts.
1396 break;
1397 }
Artem Dergachev1c6ed3a2018-02-24 03:54:22 +00001398 default:
1399 break;
Artem Dergachev41ffb302018-02-08 22:58:15 +00001400 }
1401}
1402
Artem Dergachev1527dec2018-03-12 23:12:40 +00001403void CFGBuilder::cleanupConstructionContext(Expr *E) {
Artem Dergachev783a4572018-02-23 22:20:39 +00001404 assert(BuildOpts.AddRichCXXConstructors &&
1405 "We should not be managing construction contexts!");
Artem Dergachev1527dec2018-03-12 23:12:40 +00001406 assert(ConstructionContextMap.count(E) &&
Artem Dergachev41ffb302018-02-08 22:58:15 +00001407 "Cannot exit construction context without the context!");
Artem Dergachev1527dec2018-03-12 23:12:40 +00001408 ConstructionContextMap.erase(E);
Artem Dergachev41ffb302018-02-08 22:58:15 +00001409}
1410
1411
Mike Stump31feda52009-07-17 01:31:16 +00001412/// BuildCFG - Constructs a CFG from an AST (a Stmt*). The AST can represent an
1413/// arbitrary statement. Examples include a single expression or a function
1414/// body (compound statement). The ownership of the returned CFG is
1415/// transferred to the caller. If CFG construction fails, this method returns
1416/// NULL.
David Blaikiee90195c2014-08-29 18:53:26 +00001417std::unique_ptr<CFG> CFGBuilder::buildCFG(const Decl *D, Stmt *Statement) {
Ted Kremenek8aed4902009-10-20 23:46:25 +00001418 assert(cfg.get());
Ted Kremenek93668002009-07-17 22:18:43 +00001419 if (!Statement)
Craig Topper25542942014-05-20 04:30:07 +00001420 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00001421
Mike Stump31feda52009-07-17 01:31:16 +00001422 // Create an empty block that will serve as the exit block for the CFG. Since
1423 // this is the first block added to the CFG, it will be implicitly registered
1424 // as the exit block.
Ted Kremenek81e14852007-08-27 19:46:09 +00001425 Succ = createBlock();
Ted Kremenek289ae4f2009-10-12 20:55:07 +00001426 assert(Succ == &cfg->getExit());
Craig Topper25542942014-05-20 04:30:07 +00001427 Block = nullptr; // the EXIT block is empty. Create all other blocks lazily.
Mike Stump31feda52009-07-17 01:31:16 +00001428
Matthias Gehre351c2182017-07-12 07:04:19 +00001429 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1430 "AddImplicitDtors and AddLifetime cannot be used at the same time");
1431
Marcin Swiderski20b88732010-10-05 05:37:00 +00001432 if (BuildOpts.AddImplicitDtors)
1433 if (const CXXDestructorDecl *DD = dyn_cast_or_null<CXXDestructorDecl>(D))
1434 addImplicitDtorsForDestructor(DD);
1435
Ted Kremenek9aae5132007-08-23 21:42:29 +00001436 // Visit the statements and create the CFG.
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001437 CFGBlock *B = addStmt(Statement);
1438
1439 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001440 return nullptr;
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001441
Artem Dergachev192a7472019-05-24 23:37:08 +00001442 // For C++ constructor add initializers to CFG. Constructors of virtual bases
1443 // are ignored unless the object is of the most derived class.
1444 // class VBase { VBase() = default; VBase(int) {} };
1445 // class A : virtual public VBase { A() : VBase(0) {} };
1446 // class B : public A {};
1447 // B b; // Constructor calls in order: VBase(), A(), B().
1448 // // VBase(0) is ignored because A isn't the most derived class.
1449 // This may result in the virtual base(s) being already initialized at this
1450 // point, in which case we should jump right onto non-virtual bases and
1451 // fields. To handle this, make a CFG branch. We only need to add one such
1452 // branch per constructor, since the Standard states that all virtual bases
1453 // shall be initialized before non-virtual bases and direct data members.
1454 if (const auto *CD = dyn_cast_or_null<CXXConstructorDecl>(D)) {
1455 CFGBlock *VBaseSucc = nullptr;
Pete Cooper57d3f142015-07-30 17:22:52 +00001456 for (auto *I : llvm::reverse(CD->inits())) {
Artem Dergachev192a7472019-05-24 23:37:08 +00001457 if (BuildOpts.AddVirtualBaseBranches && !VBaseSucc &&
1458 I->isBaseInitializer() && I->isBaseVirtual()) {
1459 // We've reached the first virtual base init while iterating in reverse
1460 // order. Make a new block for virtual base initializers so that we
1461 // could skip them.
1462 VBaseSucc = Succ = B ? B : &cfg->getExit();
1463 Block = createBlock();
1464 }
Pete Cooper57d3f142015-07-30 17:22:52 +00001465 B = addInitializer(I);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001466 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00001467 return nullptr;
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001468 }
Artem Dergachev192a7472019-05-24 23:37:08 +00001469 if (VBaseSucc) {
1470 // Make a branch block for potentially skipping virtual base initializers.
1471 Succ = VBaseSucc;
1472 B = createBlock();
1473 B->setTerminator(
1474 CFGTerminator(nullptr, CFGTerminator::VirtualBaseBranch));
1475 addSuccessor(B, Block, true);
1476 }
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001477 }
1478
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001479 if (B)
1480 Succ = B;
Mike Stump6bf1c082010-01-21 02:21:40 +00001481
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001482 // Backpatch the gotos whose label -> block mappings we didn't know when we
1483 // encountered them.
1484 for (BackpatchBlocksTy::iterator I = BackpatchBlocks.begin(),
1485 E = BackpatchBlocks.end(); I != E; ++I ) {
Mike Stump31feda52009-07-17 01:31:16 +00001486
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001487 CFGBlock *B = I->block;
Jennifer Yub8fee672019-06-03 15:57:25 +00001488 if (auto *G = dyn_cast<GotoStmt>(B->getTerminator())) {
1489 LabelMapTy::iterator LI = LabelMap.find(G->getLabel());
1490 // If there is no target for the goto, then we are looking at an
1491 // incomplete AST. Handle this by not registering a successor.
1492 if (LI == LabelMap.end())
1493 continue;
1494 JumpTarget JT = LI->second;
1495 prependAutomaticObjLifetimeWithTerminator(B, I->scopePosition,
1496 JT.scopePosition);
1497 prependAutomaticObjDtorsWithTerminator(B, I->scopePosition,
1498 JT.scopePosition);
1499 const VarDecl *VD = prependAutomaticObjScopeEndWithTerminator(
1500 B, I->scopePosition, JT.scopePosition);
1501 appendScopeBegin(JT.block, VD, G);
1502 addSuccessor(B, JT.block);
1503 };
1504 if (auto *G = dyn_cast<GCCAsmStmt>(B->getTerminator())) {
1505 CFGBlock *Successor = (I+1)->block;
1506 for (auto *L : G->labels()) {
1507 LabelMapTy::iterator LI = LabelMap.find(L->getLabel());
1508 // If there is no target for the goto, then we are looking at an
1509 // incomplete AST. Handle this by not registering a successor.
1510 if (LI == LabelMap.end())
1511 continue;
1512 JumpTarget JT = LI->second;
1513 // Successor has been added, so skip it.
1514 if (JT.block == Successor)
1515 continue;
1516 addSuccessor(B, JT.block);
1517 }
1518 I++;
1519 }
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001520 }
1521
1522 // Add successors to the Indirect Goto Dispatch block (if we have one).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001523 if (CFGBlock *B = cfg->getIndirectGotoBlock())
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001524 for (LabelSetTy::iterator I = AddressTakenLabels.begin(),
1525 E = AddressTakenLabels.end(); I != E; ++I ) {
Zhongxing Xub1e10aa2010-09-06 07:04:06 +00001526 // Lookup the target block.
1527 LabelMapTy::iterator LI = LabelMap.find(*I);
1528
1529 // If there is no target block that contains label, then we are looking
1530 // at an incomplete AST. Handle this by not registering a successor.
Ted Kremenek9aae5132007-08-23 21:42:29 +00001531 if (LI == LabelMap.end()) continue;
Fangrui Song6907ce22018-07-30 19:24:48 +00001532
Ted Kremenekef81e9e2011-01-07 19:37:16 +00001533 addSuccessor(B, LI->second.block);
Ted Kremenekeda180e22007-08-28 19:26:49 +00001534 }
Mike Stump31feda52009-07-17 01:31:16 +00001535
Mike Stump31feda52009-07-17 01:31:16 +00001536 // Create an empty entry block that has no predecessors.
Ted Kremenek5c50fd12007-09-26 21:23:31 +00001537 cfg->setEntry(createBlock());
Mike Stump31feda52009-07-17 01:31:16 +00001538
Artem Dergachev783a4572018-02-23 22:20:39 +00001539 if (BuildOpts.AddRichCXXConstructors)
1540 assert(ConstructionContextMap.empty() &&
1541 "Not all construction contexts were cleaned up!");
1542
David Blaikiee90195c2014-08-29 18:53:26 +00001543 return std::move(cfg);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001544}
Mike Stump31feda52009-07-17 01:31:16 +00001545
Ted Kremenek9aae5132007-08-23 21:42:29 +00001546/// createBlock - Used to lazily create blocks that are connected
1547/// to the current (global) succcessor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001548CFGBlock *CFGBuilder::createBlock(bool add_successor) {
1549 CFGBlock *B = cfg->createBlock();
Ted Kremenek93668002009-07-17 22:18:43 +00001550 if (add_successor && Succ)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00001551 addSuccessor(B, Succ);
Ted Kremenek9aae5132007-08-23 21:42:29 +00001552 return B;
1553}
Mike Stump31feda52009-07-17 01:31:16 +00001554
Chandler Carrutha70991b2011-09-13 09:13:49 +00001555/// createNoReturnBlock - Used to create a block is a 'noreturn' point in the
1556/// CFG. It is *not* connected to the current (global) successor, and instead
1557/// directly tied to the exit block in order to be reachable.
1558CFGBlock *CFGBuilder::createNoReturnBlock() {
1559 CFGBlock *B = createBlock(false);
Chandler Carruth75d78232011-09-13 09:53:55 +00001560 B->setHasNoReturnElement();
Ted Kremenekf3539192014-02-27 00:24:05 +00001561 addSuccessor(B, &cfg->getExit(), Succ);
Chandler Carrutha70991b2011-09-13 09:13:49 +00001562 return B;
1563}
1564
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001565/// addInitializer - Add C++ base or member initializer element to CFG.
Alexis Hunt1d792652011-01-08 20:30:50 +00001566CFGBlock *CFGBuilder::addInitializer(CXXCtorInitializer *I) {
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001567 if (!BuildOpts.AddInitializers)
1568 return Block;
1569
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001570 bool HasTemporaries = false;
1571
1572 // Destructors of temporaries in initialization expression should be called
1573 // after initialization finishes.
1574 Expr *Init = I->getInit();
1575 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00001576 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001577
Jordan Rose6d671cc2012-09-05 22:55:23 +00001578 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001579 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00001580 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00001581 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
Artem Dergachevead98ea2019-08-28 18:44:42 +00001582 /*ExternallyDestructed=*/false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001583 }
1584 }
1585
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001586 autoCreateBlock();
1587 appendInitializer(Block, I);
1588
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001589 if (Init) {
Artem Dergachev783a4572018-02-23 22:20:39 +00001590 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00001591 ConstructionContextLayer::create(cfg->getBumpVectorContext(), I),
Artem Dergachev783a4572018-02-23 22:20:39 +00001592 Init);
Artem Dergachev5a281bb2018-02-10 02:18:04 +00001593
Ted Kremenek8219b822010-12-16 07:46:53 +00001594 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001595 // For expression with temporaries go directly to subexpression to omit
1596 // generating destructors for the second time.
Ted Kremenek8219b822010-12-16 07:46:53 +00001597 return Visit(cast<ExprWithCleanups>(Init)->getSubExpr());
1598 }
Enrico Pertosofaed8012015-06-03 10:12:40 +00001599 if (BuildOpts.AddCXXDefaultInitExprInCtors) {
1600 if (CXXDefaultInitExpr *Default = dyn_cast<CXXDefaultInitExpr>(Init)) {
1601 // In general, appending the expression wrapped by a CXXDefaultInitExpr
1602 // may cause the same Expr to appear more than once in the CFG. Doing it
1603 // here is safe because there's only one initializer per field.
1604 autoCreateBlock();
1605 appendStmt(Block, Default);
1606 if (Stmt *Child = Default->getExpr())
1607 if (CFGBlock *R = Visit(Child))
1608 Block = R;
1609 return Block;
1610 }
1611 }
Ted Kremenek8219b822010-12-16 07:46:53 +00001612 return Visit(Init);
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001613 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00001614
Marcin Swiderski87b1bb62010-10-04 03:38:22 +00001615 return Block;
1616}
1617
Fangrui Song6907ce22018-07-30 19:24:48 +00001618/// Retrieve the type of the temporary object whose lifetime was
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001619/// extended by a local reference with the given initializer.
Artem Dergacheva25809f2018-06-04 18:56:25 +00001620static QualType getReferenceInitTemporaryType(const Expr *Init,
Richard Smithb8c0f552016-12-09 18:49:13 +00001621 bool *FoundMTE = nullptr) {
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001622 while (true) {
1623 // Skip parentheses.
1624 Init = Init->IgnoreParens();
Artem Dergacheva25809f2018-06-04 18:56:25 +00001625
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001626 // Skip through cleanups.
1627 if (const ExprWithCleanups *EWC = dyn_cast<ExprWithCleanups>(Init)) {
1628 Init = EWC->getSubExpr();
1629 continue;
1630 }
Artem Dergacheva25809f2018-06-04 18:56:25 +00001631
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001632 // Skip through the temporary-materialization expression.
1633 if (const MaterializeTemporaryExpr *MTE
1634 = dyn_cast<MaterializeTemporaryExpr>(Init)) {
1635 Init = MTE->GetTemporaryExpr();
Richard Smithb8c0f552016-12-09 18:49:13 +00001636 if (FoundMTE)
1637 *FoundMTE = true;
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001638 continue;
1639 }
Artem Dergacheva25809f2018-06-04 18:56:25 +00001640
1641 // Skip sub-object accesses into rvalues.
1642 SmallVector<const Expr *, 2> CommaLHSs;
1643 SmallVector<SubobjectAdjustment, 2> Adjustments;
1644 const Expr *SkippedInit =
1645 Init->skipRValueSubobjectAdjustments(CommaLHSs, Adjustments);
1646 if (SkippedInit != Init) {
1647 Init = SkippedInit;
1648 continue;
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001649 }
Artem Dergacheva25809f2018-06-04 18:56:25 +00001650
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001651 break;
1652 }
1653
1654 return Init->getType();
1655}
Matthias Gehre351c2182017-07-12 07:04:19 +00001656
Peter Szecsi999a25f2017-08-19 11:19:16 +00001657// TODO: Support adding LoopExit element to the CFG in case where the loop is
1658// ended by ReturnStmt, GotoStmt or ThrowExpr.
1659void CFGBuilder::addLoopExit(const Stmt *LoopStmt){
1660 if(!BuildOpts.AddLoopExit)
1661 return;
1662 autoCreateBlock();
1663 appendLoopExit(Block, LoopStmt);
1664}
1665
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001666void CFGBuilder::getDeclsWithEndedScope(LocalScope::const_iterator B,
1667 LocalScope::const_iterator E, Stmt *S) {
1668 if (!BuildOpts.AddScopes)
1669 return;
1670
1671 if (B == E)
1672 return;
1673
1674 // To go from B to E, one first goes up the scopes from B to P
1675 // then sideways in one scope from P to P' and then down
1676 // the scopes from P' to E.
1677 // The lifetime of all objects between B and P end.
1678 LocalScope::const_iterator P = B.shared_parent(E);
1679 int Dist = B.distance(P);
1680 if (Dist <= 0)
1681 return;
1682
1683 for (LocalScope::const_iterator I = B; I != P; ++I)
1684 if (I.pointsToFirstDeclaredVar())
1685 DeclsWithEndedScope.insert(*I);
1686}
1687
Matthias Gehre351c2182017-07-12 07:04:19 +00001688void CFGBuilder::addAutomaticObjHandling(LocalScope::const_iterator B,
1689 LocalScope::const_iterator E,
1690 Stmt *S) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001691 getDeclsWithEndedScope(B, E, S);
1692 if (BuildOpts.AddScopes)
1693 addScopesEnd(B, E, S);
Matthias Gehre351c2182017-07-12 07:04:19 +00001694 if (BuildOpts.AddImplicitDtors)
1695 addAutomaticObjDtors(B, E, S);
1696 if (BuildOpts.AddLifetime)
1697 addLifetimeEnds(B, E, S);
1698}
1699
1700/// Add to current block automatic objects that leave the scope.
1701void CFGBuilder::addLifetimeEnds(LocalScope::const_iterator B,
1702 LocalScope::const_iterator E, Stmt *S) {
1703 if (!BuildOpts.AddLifetime)
1704 return;
1705
1706 if (B == E)
1707 return;
1708
1709 // To go from B to E, one first goes up the scopes from B to P
1710 // then sideways in one scope from P to P' and then down
1711 // the scopes from P' to E.
1712 // The lifetime of all objects between B and P end.
1713 LocalScope::const_iterator P = B.shared_parent(E);
1714 int dist = B.distance(P);
1715 if (dist <= 0)
1716 return;
1717
1718 // We need to perform the scope leaving in reverse order
1719 SmallVector<VarDecl *, 10> DeclsTrivial;
1720 SmallVector<VarDecl *, 10> DeclsNonTrivial;
1721 DeclsTrivial.reserve(dist);
1722 DeclsNonTrivial.reserve(dist);
1723
1724 for (LocalScope::const_iterator I = B; I != P; ++I)
1725 if (hasTrivialDestructor(*I))
1726 DeclsTrivial.push_back(*I);
1727 else
1728 DeclsNonTrivial.push_back(*I);
1729
1730 autoCreateBlock();
1731 // object with trivial destructor end their lifetime last (when storage
1732 // duration ends)
1733 for (SmallVectorImpl<VarDecl *>::reverse_iterator I = DeclsTrivial.rbegin(),
1734 E = DeclsTrivial.rend();
1735 I != E; ++I)
1736 appendLifetimeEnds(Block, *I, S);
1737
1738 for (SmallVectorImpl<VarDecl *>::reverse_iterator
1739 I = DeclsNonTrivial.rbegin(),
1740 E = DeclsNonTrivial.rend();
1741 I != E; ++I)
1742 appendLifetimeEnds(Block, *I, S);
1743}
1744
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001745/// Add to current block markers for ending scopes.
1746void CFGBuilder::addScopesEnd(LocalScope::const_iterator B,
1747 LocalScope::const_iterator E, Stmt *S) {
1748 // If implicit destructors are enabled, we'll add scope ends in
1749 // addAutomaticObjDtors.
1750 if (BuildOpts.AddImplicitDtors)
1751 return;
1752
1753 autoCreateBlock();
1754
1755 for (auto I = DeclsWithEndedScope.rbegin(), E = DeclsWithEndedScope.rend();
1756 I != E; ++I)
1757 appendScopeEnd(Block, *I, S);
1758
1759 return;
1760}
1761
Marcin Swiderski5e415732010-09-30 23:05:00 +00001762/// addAutomaticObjDtors - Add to current block automatic objects destructors
1763/// for objects in range of local scope positions. Use S as trigger statement
1764/// for destructors.
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001765void CFGBuilder::addAutomaticObjDtors(LocalScope::const_iterator B,
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001766 LocalScope::const_iterator E, Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001767 if (!BuildOpts.AddImplicitDtors)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001768 return;
1769
Marcin Swiderski5e415732010-09-30 23:05:00 +00001770 if (B == E)
Zhongxing Xu6d372f72010-10-01 03:22:39 +00001771 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001772
Chandler Carruthad747252011-09-13 06:09:01 +00001773 // We need to append the destructors in reverse order, but any one of them
1774 // may be a no-return destructor which changes the CFG. As a result, buffer
1775 // this sequence up and replay them in reverse order when appending onto the
1776 // CFGBlock(s).
1777 SmallVector<VarDecl*, 10> Decls;
1778 Decls.reserve(B.distance(E));
1779 for (LocalScope::const_iterator I = B; I != E; ++I)
1780 Decls.push_back(*I);
1781
1782 for (SmallVectorImpl<VarDecl*>::reverse_iterator I = Decls.rbegin(),
1783 E = Decls.rend();
1784 I != E; ++I) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001785 if (hasTrivialDestructor(*I)) {
1786 // If AddScopes is enabled and *I is a first variable in a scope, add a
1787 // ScopeEnd marker in a Block.
1788 if (BuildOpts.AddScopes && DeclsWithEndedScope.count(*I)) {
1789 autoCreateBlock();
1790 appendScopeEnd(Block, *I, S);
1791 }
1792 continue;
1793 }
Chandler Carruthad747252011-09-13 06:09:01 +00001794 // If this destructor is marked as a no-return destructor, we need to
1795 // create a new block for the destructor which does not have as a successor
1796 // anything built thus far: control won't flow out of this block.
Ted Kremenek3d617732012-07-18 04:57:57 +00001797 QualType Ty = (*I)->getType();
1798 if (Ty->isReferenceType()) {
Artem Dergacheva25809f2018-06-04 18:56:25 +00001799 Ty = getReferenceInitTemporaryType((*I)->getInit());
Douglas Gregor6c8f07f2011-11-15 15:29:30 +00001800 }
Ted Kremenek3d617732012-07-18 04:57:57 +00001801 Ty = Context->getBaseElementType(Ty);
1802
Richard Trieu95a192a2015-05-28 00:14:02 +00001803 if (Ty->getAsCXXRecordDecl()->isAnyDestructorNoReturn())
Chandler Carrutha70991b2011-09-13 09:13:49 +00001804 Block = createNoReturnBlock();
1805 else
Chandler Carruthad747252011-09-13 06:09:01 +00001806 autoCreateBlock();
Chandler Carruthad747252011-09-13 06:09:01 +00001807
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001808 // Add ScopeEnd just after automatic obj destructor.
1809 if (BuildOpts.AddScopes && DeclsWithEndedScope.count(*I))
1810 appendScopeEnd(Block, *I, S);
Chandler Carruthad747252011-09-13 06:09:01 +00001811 appendAutomaticObjDtor(Block, *I, S);
1812 }
Marcin Swiderski5e415732010-09-30 23:05:00 +00001813}
1814
Marcin Swiderski20b88732010-10-05 05:37:00 +00001815/// addImplicitDtorsForDestructor - Add implicit destructors generated for
1816/// base and member objects in destructor.
1817void CFGBuilder::addImplicitDtorsForDestructor(const CXXDestructorDecl *DD) {
Eugene Zelenko38c70522017-12-07 21:55:09 +00001818 assert(BuildOpts.AddImplicitDtors &&
1819 "Can be called only when dtors should be added");
Marcin Swiderski20b88732010-10-05 05:37:00 +00001820 const CXXRecordDecl *RD = DD->getParent();
1821
1822 // At the end destroy virtual base objects.
Aaron Ballman445a9392014-03-13 16:15:17 +00001823 for (const auto &VI : RD->vbases()) {
Artem Dergachev192a7472019-05-24 23:37:08 +00001824 // TODO: Add a VirtualBaseBranch to see if the most derived class
1825 // (which is different from the current class) is responsible for
1826 // destroying them.
Aaron Ballman445a9392014-03-13 16:15:17 +00001827 const CXXRecordDecl *CD = VI.getType()->getAsCXXRecordDecl();
Marcin Swiderski20b88732010-10-05 05:37:00 +00001828 if (!CD->hasTrivialDestructor()) {
1829 autoCreateBlock();
Aaron Ballman445a9392014-03-13 16:15:17 +00001830 appendBaseDtor(Block, &VI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001831 }
1832 }
1833
1834 // Before virtual bases destroy direct base objects.
Aaron Ballman574705e2014-03-13 15:41:46 +00001835 for (const auto &BI : RD->bases()) {
1836 if (!BI.isVirtual()) {
1837 const CXXRecordDecl *CD = BI.getType()->getAsCXXRecordDecl();
David Blaikie0f2ae782012-01-24 04:51:48 +00001838 if (!CD->hasTrivialDestructor()) {
1839 autoCreateBlock();
Aaron Ballman574705e2014-03-13 15:41:46 +00001840 appendBaseDtor(Block, &BI);
David Blaikie0f2ae782012-01-24 04:51:48 +00001841 }
1842 }
Marcin Swiderski20b88732010-10-05 05:37:00 +00001843 }
1844
1845 // First destroy member objects.
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001846 for (auto *FI : RD->fields()) {
Marcin Swiderski01769902010-10-25 07:05:54 +00001847 // Check for constant size array. Set type to array element type.
1848 QualType QT = FI->getType();
1849 if (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1850 if (AT->getSize() == 0)
1851 continue;
1852 QT = AT->getElementType();
1853 }
1854
1855 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
Marcin Swiderski20b88732010-10-05 05:37:00 +00001856 if (!CD->hasTrivialDestructor()) {
1857 autoCreateBlock();
Aaron Ballmane8a8bae2014-03-08 20:12:42 +00001858 appendMemberDtor(Block, FI);
Marcin Swiderski20b88732010-10-05 05:37:00 +00001859 }
1860 }
1861}
1862
Marcin Swiderski5e415732010-09-30 23:05:00 +00001863/// createOrReuseLocalScope - If Scope is NULL create new LocalScope. Either
1864/// way return valid LocalScope object.
1865LocalScope* CFGBuilder::createOrReuseLocalScope(LocalScope* Scope) {
David Blaikiec1334cc2015-08-13 22:12:21 +00001866 if (Scope)
1867 return Scope;
1868 llvm::BumpPtrAllocator &alloc = cfg->getAllocator();
1869 return new (alloc.Allocate<LocalScope>())
1870 LocalScope(BumpVectorContext(alloc), ScopePos);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001871}
1872
1873/// addLocalScopeForStmt - Add LocalScope to local scopes tree for statement
Fangrui Song6907ce22018-07-30 19:24:48 +00001874/// that should create implicit scope (e.g. if/else substatements).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001875void CFGBuilder::addLocalScopeForStmt(Stmt *S) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001876 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1877 !BuildOpts.AddScopes)
Zhongxing Xu81714f22010-10-01 03:00:16 +00001878 return;
1879
Craig Topper25542942014-05-20 04:30:07 +00001880 LocalScope *Scope = nullptr;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001881
1882 // For compound statement we will be creating explicit scope.
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001883 if (CompoundStmt *CS = dyn_cast<CompoundStmt>(S)) {
Aaron Ballmanc7e4e212014-03-17 14:19:37 +00001884 for (auto *BI : CS->body()) {
1885 Stmt *SI = BI->stripLabelLikeStatements();
Chris Lattnerc8e630e2011-02-17 07:39:24 +00001886 if (DeclStmt *DS = dyn_cast<DeclStmt>(SI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001887 Scope = addLocalScopeForDeclStmt(DS, Scope);
1888 }
Zhongxing Xu81714f22010-10-01 03:00:16 +00001889 return;
Marcin Swiderski5e415732010-09-30 23:05:00 +00001890 }
1891
1892 // For any other statement scope will be implicit and as such will be
1893 // interesting only for DeclStmt.
Chandler Carrutha626d642011-09-10 00:02:34 +00001894 if (DeclStmt *DS = dyn_cast<DeclStmt>(S->stripLabelLikeStatements()))
Zhongxing Xu307701e2010-10-01 03:09:09 +00001895 addLocalScopeForDeclStmt(DS);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001896}
1897
1898/// addLocalScopeForDeclStmt - Add LocalScope for declaration statement. Will
1899/// reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001900LocalScope* CFGBuilder::addLocalScopeForDeclStmt(DeclStmt *DS,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001901 LocalScope* Scope) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001902 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1903 !BuildOpts.AddScopes)
Marcin Swiderski5e415732010-09-30 23:05:00 +00001904 return Scope;
1905
Aaron Ballman535bbcc2014-03-14 17:01:24 +00001906 for (auto *DI : DS->decls())
1907 if (VarDecl *VD = dyn_cast<VarDecl>(DI))
Marcin Swiderski5e415732010-09-30 23:05:00 +00001908 Scope = addLocalScopeForVarDecl(VD, Scope);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001909 return Scope;
1910}
1911
Matthias Gehre351c2182017-07-12 07:04:19 +00001912bool CFGBuilder::hasTrivialDestructor(VarDecl *VD) {
1913 // Check for const references bound to temporary. Set type to pointee.
1914 QualType QT = VD->getType();
Artem Dergacheva25809f2018-06-04 18:56:25 +00001915 if (QT->isReferenceType()) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001916 // Attempt to determine whether this declaration lifetime-extends a
1917 // temporary.
1918 //
1919 // FIXME: This is incorrect. Non-reference declarations can lifetime-extend
1920 // temporaries, and a single declaration can extend multiple temporaries.
1921 // We should look at the storage duration on each nested
1922 // MaterializeTemporaryExpr instead.
1923
1924 const Expr *Init = VD->getInit();
Artem Dergacheva25809f2018-06-04 18:56:25 +00001925 if (!Init) {
1926 // Probably an exception catch-by-reference variable.
1927 // FIXME: It doesn't really mean that the object has a trivial destructor.
1928 // Also are there other cases?
Matthias Gehre351c2182017-07-12 07:04:19 +00001929 return true;
Artem Dergacheva25809f2018-06-04 18:56:25 +00001930 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001931
Artem Dergacheva25809f2018-06-04 18:56:25 +00001932 // Lifetime-extending a temporary?
Matthias Gehre351c2182017-07-12 07:04:19 +00001933 bool FoundMTE = false;
Artem Dergacheva25809f2018-06-04 18:56:25 +00001934 QT = getReferenceInitTemporaryType(Init, &FoundMTE);
Matthias Gehre351c2182017-07-12 07:04:19 +00001935 if (!FoundMTE)
1936 return true;
1937 }
1938
1939 // Check for constant size array. Set type to array element type.
1940 while (const ConstantArrayType *AT = Context->getAsConstantArrayType(QT)) {
1941 if (AT->getSize() == 0)
1942 return true;
1943 QT = AT->getElementType();
1944 }
1945
1946 // Check if type is a C++ class with non-trivial destructor.
1947 if (const CXXRecordDecl *CD = QT->getAsCXXRecordDecl())
1948 return !CD->hasDefinition() || CD->hasTrivialDestructor();
1949 return true;
1950}
1951
Marcin Swiderski5e415732010-09-30 23:05:00 +00001952/// addLocalScopeForVarDecl - Add LocalScope for variable declaration. It will
1953/// create add scope for automatic objects and temporary objects bound to
1954/// const reference. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001955LocalScope* CFGBuilder::addLocalScopeForVarDecl(VarDecl *VD,
Zhongxing Xu307701e2010-10-01 03:09:09 +00001956 LocalScope* Scope) {
Matthias Gehre351c2182017-07-12 07:04:19 +00001957 assert(!(BuildOpts.AddImplicitDtors && BuildOpts.AddLifetime) &&
1958 "AddImplicitDtors and AddLifetime cannot be used at the same time");
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001959 if (!BuildOpts.AddImplicitDtors && !BuildOpts.AddLifetime &&
1960 !BuildOpts.AddScopes)
Marcin Swiderski5e415732010-09-30 23:05:00 +00001961 return Scope;
1962
1963 // Check if variable is local.
1964 switch (VD->getStorageClass()) {
1965 case SC_None:
1966 case SC_Auto:
1967 case SC_Register:
1968 break;
1969 default: return Scope;
1970 }
1971
Matthias Gehre351c2182017-07-12 07:04:19 +00001972 if (BuildOpts.AddImplicitDtors) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00001973 if (!hasTrivialDestructor(VD) || BuildOpts.AddScopes) {
Zhongxing Xu614e17d2010-10-05 08:38:06 +00001974 // Add the variable to scope
1975 Scope = createOrReuseLocalScope(Scope);
1976 Scope->addVar(VD);
1977 ScopePos = Scope->begin();
1978 }
Matthias Gehre351c2182017-07-12 07:04:19 +00001979 return Scope;
1980 }
1981
1982 assert(BuildOpts.AddLifetime);
1983 // Add the variable to scope
1984 Scope = createOrReuseLocalScope(Scope);
1985 Scope->addVar(VD);
1986 ScopePos = Scope->begin();
Marcin Swiderski5e415732010-09-30 23:05:00 +00001987 return Scope;
1988}
1989
1990/// addLocalScopeAndDtors - For given statement add local scope for it and
1991/// add destructors that will cleanup the scope. Will reuse Scope if not NULL.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001992void CFGBuilder::addLocalScopeAndDtors(Stmt *S) {
Marcin Swiderski5e415732010-09-30 23:05:00 +00001993 LocalScope::const_iterator scopeBeginPos = ScopePos;
Zhongxing Xu81714f22010-10-01 03:00:16 +00001994 addLocalScopeForStmt(S);
Matthias Gehre351c2182017-07-12 07:04:19 +00001995 addAutomaticObjHandling(ScopePos, scopeBeginPos, S);
Marcin Swiderski5e415732010-09-30 23:05:00 +00001996}
1997
Marcin Swiderski321a7072010-09-30 22:54:37 +00001998/// prependAutomaticObjDtorsWithTerminator - Prepend destructor CFGElements for
1999/// variables with automatic storage duration to CFGBlock's elements vector.
2000/// Elements will be prepended to physical beginning of the vector which
2001/// happens to be logical end. Use blocks terminator as statement that specifies
2002/// destructors call site.
Chandler Carruthad747252011-09-13 06:09:01 +00002003/// FIXME: This mechanism for adding automatic destructors doesn't handle
2004/// no-return destructors properly.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002005void CFGBuilder::prependAutomaticObjDtorsWithTerminator(CFGBlock *Blk,
Marcin Swiderski321a7072010-09-30 22:54:37 +00002006 LocalScope::const_iterator B, LocalScope::const_iterator E) {
Matthias Gehre351c2182017-07-12 07:04:19 +00002007 if (!BuildOpts.AddImplicitDtors)
2008 return;
Chandler Carruthad747252011-09-13 06:09:01 +00002009 BumpVectorContext &C = cfg->getBumpVectorContext();
2010 CFGBlock::iterator InsertPos
2011 = Blk->beginAutomaticObjDtorsInsert(Blk->end(), B.distance(E), C);
2012 for (LocalScope::const_iterator I = B; I != E; ++I)
2013 InsertPos = Blk->insertAutomaticObjDtor(InsertPos, *I,
Artem Dergachev4e530322019-05-24 01:34:22 +00002014 Blk->getTerminatorStmt());
Marcin Swiderski321a7072010-09-30 22:54:37 +00002015}
2016
Matthias Gehre351c2182017-07-12 07:04:19 +00002017/// prependAutomaticObjLifetimeWithTerminator - Prepend lifetime CFGElements for
2018/// variables with automatic storage duration to CFGBlock's elements vector.
2019/// Elements will be prepended to physical beginning of the vector which
2020/// happens to be logical end. Use blocks terminator as statement that specifies
2021/// where lifetime ends.
2022void CFGBuilder::prependAutomaticObjLifetimeWithTerminator(
2023 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) {
2024 if (!BuildOpts.AddLifetime)
2025 return;
2026 BumpVectorContext &C = cfg->getBumpVectorContext();
2027 CFGBlock::iterator InsertPos =
2028 Blk->beginLifetimeEndsInsert(Blk->end(), B.distance(E), C);
Artem Dergachev4e530322019-05-24 01:34:22 +00002029 for (LocalScope::const_iterator I = B; I != E; ++I) {
2030 InsertPos =
2031 Blk->insertLifetimeEnds(InsertPos, *I, Blk->getTerminatorStmt());
2032 }
Matthias Gehre351c2182017-07-12 07:04:19 +00002033}
Eugene Zelenko38c70522017-12-07 21:55:09 +00002034
Maxim Ostapenkodebca452018-03-12 12:26:15 +00002035/// prependAutomaticObjScopeEndWithTerminator - Prepend scope end CFGElements for
2036/// variables with automatic storage duration to CFGBlock's elements vector.
2037/// Elements will be prepended to physical beginning of the vector which
2038/// happens to be logical end. Use blocks terminator as statement that specifies
2039/// where scope ends.
2040const VarDecl *
2041CFGBuilder::prependAutomaticObjScopeEndWithTerminator(
2042 CFGBlock *Blk, LocalScope::const_iterator B, LocalScope::const_iterator E) {
2043 if (!BuildOpts.AddScopes)
2044 return nullptr;
2045 BumpVectorContext &C = cfg->getBumpVectorContext();
2046 CFGBlock::iterator InsertPos =
2047 Blk->beginScopeEndInsert(Blk->end(), 1, C);
2048 LocalScope::const_iterator PlaceToInsert = B;
2049 for (LocalScope::const_iterator I = B; I != E; ++I)
2050 PlaceToInsert = I;
Artem Dergachev4e530322019-05-24 01:34:22 +00002051 Blk->insertScopeEnd(InsertPos, *PlaceToInsert, Blk->getTerminatorStmt());
Maxim Ostapenkodebca452018-03-12 12:26:15 +00002052 return *PlaceToInsert;
2053}
2054
Ted Kremenek93668002009-07-17 22:18:43 +00002055/// Visit - Walk the subtree of a statement and add extra
Mike Stump31feda52009-07-17 01:31:16 +00002056/// blocks for ternary operators, &&, and ||. We also process "," and
2057/// DeclStmts (which may contain nested control-flow).
Artem Dergachevead98ea2019-08-28 18:44:42 +00002058CFGBlock *CFGBuilder::Visit(Stmt * S, AddStmtChoice asc,
2059 bool ExternallyDestructed) {
Ted Kremenekbc1416d2010-04-30 22:25:53 +00002060 if (!S) {
2061 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00002062 return nullptr;
Ted Kremenekbc1416d2010-04-30 22:25:53 +00002063 }
Jordy Rose17347372011-06-10 08:49:37 +00002064
2065 if (Expr *E = dyn_cast<Expr>(S))
2066 S = E->IgnoreParens();
2067
Alexey Bataevc2c21ef2019-07-11 14:54:17 +00002068 if (Context->getLangOpts().OpenMP)
2069 if (auto *D = dyn_cast<OMPExecutableDirective>(S))
2070 return VisitOMPExecutableDirective(D, asc);
2071
Ted Kremenek93668002009-07-17 22:18:43 +00002072 switch (S->getStmtClass()) {
2073 default:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002074 return VisitStmt(S, asc);
Ted Kremenek93668002009-07-17 22:18:43 +00002075
2076 case Stmt::AddrLabelExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002077 return VisitAddrLabelExpr(cast<AddrLabelExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002078
John McCallc07a0c72011-02-17 10:25:35 +00002079 case Stmt::BinaryConditionalOperatorClass:
2080 return VisitConditionalOperator(cast<BinaryConditionalOperator>(S), asc);
2081
Ted Kremenek93668002009-07-17 22:18:43 +00002082 case Stmt::BinaryOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002083 return VisitBinaryOperator(cast<BinaryOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002084
Ted Kremenek93668002009-07-17 22:18:43 +00002085 case Stmt::BlockExprClass:
Devin Coughlinb6029b72015-11-25 22:35:37 +00002086 return VisitBlockExpr(cast<BlockExpr>(S), asc);
Ted Kremenek93668002009-07-17 22:18:43 +00002087
Ted Kremenek93668002009-07-17 22:18:43 +00002088 case Stmt::BreakStmtClass:
2089 return VisitBreakStmt(cast<BreakStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002090
Ted Kremenek93668002009-07-17 22:18:43 +00002091 case Stmt::CallExprClass:
Ted Kremenek128d04d2010-08-31 18:47:34 +00002092 case Stmt::CXXOperatorCallExprClass:
John McCallc67067f2011-05-11 07:19:11 +00002093 case Stmt::CXXMemberCallExprClass:
Richard Smithc67fdd42012-03-07 08:35:16 +00002094 case Stmt::UserDefinedLiteralClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002095 return VisitCallExpr(cast<CallExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002096
Ted Kremenek93668002009-07-17 22:18:43 +00002097 case Stmt::CaseStmtClass:
2098 return VisitCaseStmt(cast<CaseStmt>(S));
2099
2100 case Stmt::ChooseExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002101 return VisitChooseExpr(cast<ChooseExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002102
Ted Kremenek93668002009-07-17 22:18:43 +00002103 case Stmt::CompoundStmtClass:
Artem Dergachevead98ea2019-08-28 18:44:42 +00002104 return VisitCompoundStmt(cast<CompoundStmt>(S), ExternallyDestructed);
Mike Stump11289f42009-09-09 15:08:12 +00002105
Ted Kremenek93668002009-07-17 22:18:43 +00002106 case Stmt::ConditionalOperatorClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002107 return VisitConditionalOperator(cast<ConditionalOperator>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002108
Ted Kremenek93668002009-07-17 22:18:43 +00002109 case Stmt::ContinueStmtClass:
2110 return VisitContinueStmt(cast<ContinueStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002111
Ted Kremenekb27378c2010-01-19 20:40:33 +00002112 case Stmt::CXXCatchStmtClass:
2113 return VisitCXXCatchStmt(cast<CXXCatchStmt>(S));
2114
John McCall5d413782010-12-06 08:20:24 +00002115 case Stmt::ExprWithCleanupsClass:
Artem Dergachevead98ea2019-08-28 18:44:42 +00002116 return VisitExprWithCleanups(cast<ExprWithCleanups>(S),
2117 asc, ExternallyDestructed);
Ted Kremenek82bfc862010-08-28 00:19:02 +00002118
Jordan Rosee5d53932012-08-23 18:10:53 +00002119 case Stmt::CXXDefaultArgExprClass:
Richard Smith852c9db2013-04-20 22:23:05 +00002120 case Stmt::CXXDefaultInitExprClass:
Jordan Rosee5d53932012-08-23 18:10:53 +00002121 // FIXME: The expression inside a CXXDefaultArgExpr is owned by the
2122 // called function's declaration, not by the caller. If we simply add
2123 // this expression to the CFG, we could end up with the same Expr
2124 // appearing multiple times.
2125 // PR13385 / <rdar://problem/12156507>
Richard Smith852c9db2013-04-20 22:23:05 +00002126 //
2127 // It's likewise possible for multiple CXXDefaultInitExprs for the same
2128 // expression to be used in the same function (through aggregate
2129 // initialization).
Jordan Rosee5d53932012-08-23 18:10:53 +00002130 return VisitStmt(S, asc);
2131
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002132 case Stmt::CXXBindTemporaryExprClass:
2133 return VisitCXXBindTemporaryExpr(cast<CXXBindTemporaryExpr>(S), asc);
2134
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00002135 case Stmt::CXXConstructExprClass:
2136 return VisitCXXConstructExpr(cast<CXXConstructExpr>(S), asc);
2137
Jordan Rosec9176072014-01-13 17:59:19 +00002138 case Stmt::CXXNewExprClass:
2139 return VisitCXXNewExpr(cast<CXXNewExpr>(S), asc);
2140
Jordan Rosed2f40792013-09-03 17:00:57 +00002141 case Stmt::CXXDeleteExprClass:
2142 return VisitCXXDeleteExpr(cast<CXXDeleteExpr>(S), asc);
2143
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002144 case Stmt::CXXFunctionalCastExprClass:
2145 return VisitCXXFunctionalCastExpr(cast<CXXFunctionalCastExpr>(S), asc);
2146
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00002147 case Stmt::CXXTemporaryObjectExprClass:
2148 return VisitCXXTemporaryObjectExpr(cast<CXXTemporaryObjectExpr>(S), asc);
2149
Ted Kremenekb27378c2010-01-19 20:40:33 +00002150 case Stmt::CXXThrowExprClass:
2151 return VisitCXXThrowExpr(cast<CXXThrowExpr>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002152
Ted Kremenekb27378c2010-01-19 20:40:33 +00002153 case Stmt::CXXTryStmtClass:
2154 return VisitCXXTryStmt(cast<CXXTryStmt>(S));
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002155
Richard Smith02e85f32011-04-14 22:09:26 +00002156 case Stmt::CXXForRangeStmtClass:
2157 return VisitCXXForRangeStmt(cast<CXXForRangeStmt>(S));
2158
Ted Kremenek93668002009-07-17 22:18:43 +00002159 case Stmt::DeclStmtClass:
2160 return VisitDeclStmt(cast<DeclStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002161
Ted Kremenek93668002009-07-17 22:18:43 +00002162 case Stmt::DefaultStmtClass:
2163 return VisitDefaultStmt(cast<DefaultStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002164
Ted Kremenek93668002009-07-17 22:18:43 +00002165 case Stmt::DoStmtClass:
2166 return VisitDoStmt(cast<DoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002167
Ted Kremenek93668002009-07-17 22:18:43 +00002168 case Stmt::ForStmtClass:
2169 return VisitForStmt(cast<ForStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002170
Ted Kremenek93668002009-07-17 22:18:43 +00002171 case Stmt::GotoStmtClass:
2172 return VisitGotoStmt(cast<GotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002173
Jennifer Yub8fee672019-06-03 15:57:25 +00002174 case Stmt::GCCAsmStmtClass:
2175 return VisitGCCAsmStmt(cast<GCCAsmStmt>(S), asc);
2176
Ted Kremenek93668002009-07-17 22:18:43 +00002177 case Stmt::IfStmtClass:
2178 return VisitIfStmt(cast<IfStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002179
Ted Kremenek8219b822010-12-16 07:46:53 +00002180 case Stmt::ImplicitCastExprClass:
2181 return VisitImplicitCastExpr(cast<ImplicitCastExpr>(S), asc);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00002182
Bill Wendling8003edc2018-11-09 00:41:36 +00002183 case Stmt::ConstantExprClass:
2184 return VisitConstantExpr(cast<ConstantExpr>(S), asc);
2185
Ted Kremenek93668002009-07-17 22:18:43 +00002186 case Stmt::IndirectGotoStmtClass:
2187 return VisitIndirectGotoStmt(cast<IndirectGotoStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002188
Ted Kremenek93668002009-07-17 22:18:43 +00002189 case Stmt::LabelStmtClass:
2190 return VisitLabelStmt(cast<LabelStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002191
Ted Kremenekda76a942012-04-12 20:34:52 +00002192 case Stmt::LambdaExprClass:
2193 return VisitLambdaExpr(cast<LambdaExpr>(S), asc);
2194
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00002195 case Stmt::MaterializeTemporaryExprClass:
2196 return VisitMaterializeTemporaryExpr(cast<MaterializeTemporaryExpr>(S),
2197 asc);
2198
Ted Kremenek5868ec62010-04-11 17:02:10 +00002199 case Stmt::MemberExprClass:
2200 return VisitMemberExpr(cast<MemberExpr>(S), asc);
2201
Ted Kremenek04268232011-11-05 00:10:15 +00002202 case Stmt::NullStmtClass:
2203 return Block;
2204
Ted Kremenek93668002009-07-17 22:18:43 +00002205 case Stmt::ObjCAtCatchStmtClass:
Mike Stump11289f42009-09-09 15:08:12 +00002206 return VisitObjCAtCatchStmt(cast<ObjCAtCatchStmt>(S));
2207
Ted Kremenek5022f1d2012-03-06 23:40:47 +00002208 case Stmt::ObjCAutoreleasePoolStmtClass:
2209 return VisitObjCAutoreleasePoolStmt(cast<ObjCAutoreleasePoolStmt>(S));
2210
Ted Kremenek93668002009-07-17 22:18:43 +00002211 case Stmt::ObjCAtSynchronizedStmtClass:
2212 return VisitObjCAtSynchronizedStmt(cast<ObjCAtSynchronizedStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002213
Ted Kremenek93668002009-07-17 22:18:43 +00002214 case Stmt::ObjCAtThrowStmtClass:
2215 return VisitObjCAtThrowStmt(cast<ObjCAtThrowStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002216
Ted Kremenek93668002009-07-17 22:18:43 +00002217 case Stmt::ObjCAtTryStmtClass:
2218 return VisitObjCAtTryStmt(cast<ObjCAtTryStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002219
Ted Kremenek93668002009-07-17 22:18:43 +00002220 case Stmt::ObjCForCollectionStmtClass:
2221 return VisitObjCForCollectionStmt(cast<ObjCForCollectionStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002222
Artem Dergachevbd880fe2018-07-31 19:39:37 +00002223 case Stmt::ObjCMessageExprClass:
2224 return VisitObjCMessageExpr(cast<ObjCMessageExpr>(S), asc);
2225
Ted Kremenek04268232011-11-05 00:10:15 +00002226 case Stmt::OpaqueValueExprClass:
Ted Kremenek93668002009-07-17 22:18:43 +00002227 return Block;
Mike Stump11289f42009-09-09 15:08:12 +00002228
John McCallfe96e0b2011-11-06 09:01:30 +00002229 case Stmt::PseudoObjectExprClass:
2230 return VisitPseudoObjectExpr(cast<PseudoObjectExpr>(S));
2231
Ted Kremenek93668002009-07-17 22:18:43 +00002232 case Stmt::ReturnStmtClass:
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002233 case Stmt::CoreturnStmtClass:
2234 return VisitReturnStmt(S);
Mike Stump11289f42009-09-09 15:08:12 +00002235
Nico Weber699670e2017-08-23 15:33:16 +00002236 case Stmt::SEHExceptStmtClass:
2237 return VisitSEHExceptStmt(cast<SEHExceptStmt>(S));
2238
2239 case Stmt::SEHFinallyStmtClass:
2240 return VisitSEHFinallyStmt(cast<SEHFinallyStmt>(S));
2241
2242 case Stmt::SEHLeaveStmtClass:
2243 return VisitSEHLeaveStmt(cast<SEHLeaveStmt>(S));
2244
2245 case Stmt::SEHTryStmtClass:
2246 return VisitSEHTryStmt(cast<SEHTryStmt>(S));
2247
Peter Collingbournee190dee2011-03-11 19:24:49 +00002248 case Stmt::UnaryExprOrTypeTraitExprClass:
2249 return VisitUnaryExprOrTypeTraitExpr(cast<UnaryExprOrTypeTraitExpr>(S),
2250 asc);
Mike Stump11289f42009-09-09 15:08:12 +00002251
Ted Kremenek93668002009-07-17 22:18:43 +00002252 case Stmt::StmtExprClass:
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002253 return VisitStmtExpr(cast<StmtExpr>(S), asc);
Mike Stump11289f42009-09-09 15:08:12 +00002254
Ted Kremenek93668002009-07-17 22:18:43 +00002255 case Stmt::SwitchStmtClass:
2256 return VisitSwitchStmt(cast<SwitchStmt>(S));
Mike Stump11289f42009-09-09 15:08:12 +00002257
Zhanyong Wan6dace612010-11-22 08:45:56 +00002258 case Stmt::UnaryOperatorClass:
2259 return VisitUnaryOperator(cast<UnaryOperator>(S), asc);
2260
Ted Kremenek93668002009-07-17 22:18:43 +00002261 case Stmt::WhileStmtClass:
2262 return VisitWhileStmt(cast<WhileStmt>(S));
2263 }
2264}
Mike Stump11289f42009-09-09 15:08:12 +00002265
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002266CFGBlock *CFGBuilder::VisitStmt(Stmt *S, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002267 if (asc.alwaysAdd(*this, S)) {
Ted Kremenek93668002009-07-17 22:18:43 +00002268 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002269 appendStmt(Block, S);
Mike Stump31feda52009-07-17 01:31:16 +00002270 }
Mike Stump11289f42009-09-09 15:08:12 +00002271
Ted Kremenek93668002009-07-17 22:18:43 +00002272 return VisitChildren(S);
Ted Kremenek9e248872007-08-27 21:27:44 +00002273}
Mike Stump31feda52009-07-17 01:31:16 +00002274
Ted Kremenek93668002009-07-17 22:18:43 +00002275/// VisitChildren - Visit the children of a Stmt.
Ted Kremenek8ae67872013-02-05 22:00:19 +00002276CFGBlock *CFGBuilder::VisitChildren(Stmt *S) {
2277 CFGBlock *B = Block;
Ted Kremenek828f6312011-02-21 22:11:26 +00002278
Ted Kremenek8ae67872013-02-05 22:00:19 +00002279 // Visit the children in their reverse order so that they appear in
2280 // left-to-right (natural) order in the CFG.
2281 reverse_children RChildren(S);
2282 for (reverse_children::iterator I = RChildren.begin(), E = RChildren.end();
2283 I != E; ++I) {
2284 if (Stmt *Child = *I)
2285 if (CFGBlock *R = Visit(Child))
2286 B = R;
2287 }
2288 return B;
Ted Kremenek9e248872007-08-27 21:27:44 +00002289}
Mike Stump11289f42009-09-09 15:08:12 +00002290
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002291CFGBlock *CFGBuilder::VisitAddrLabelExpr(AddrLabelExpr *A,
2292 AddStmtChoice asc) {
Ted Kremenek93668002009-07-17 22:18:43 +00002293 AddressTakenLabels.insert(A->getLabel());
Ted Kremenek9e248872007-08-27 21:27:44 +00002294
Ted Kremenek7c58d352011-03-10 01:14:11 +00002295 if (asc.alwaysAdd(*this, A)) {
Ted Kremenek93668002009-07-17 22:18:43 +00002296 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002297 appendStmt(Block, A);
Ted Kremenek93668002009-07-17 22:18:43 +00002298 }
Ted Kremenek81e14852007-08-27 19:46:09 +00002299
Ted Kremenek9aae5132007-08-23 21:42:29 +00002300 return Block;
2301}
Mike Stump11289f42009-09-09 15:08:12 +00002302
Zhanyong Wan6dace612010-11-22 08:45:56 +00002303CFGBlock *CFGBuilder::VisitUnaryOperator(UnaryOperator *U,
Ted Kremenek8219b822010-12-16 07:46:53 +00002304 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002305 if (asc.alwaysAdd(*this, U)) {
Zhanyong Wan6dace612010-11-22 08:45:56 +00002306 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002307 appendStmt(Block, U);
Zhanyong Wan6dace612010-11-22 08:45:56 +00002308 }
2309
Ted Kremenek8219b822010-12-16 07:46:53 +00002310 return Visit(U->getSubExpr(), AddStmtChoice());
Zhanyong Wan6dace612010-11-22 08:45:56 +00002311}
2312
Ted Kremeneka16436f2012-07-14 05:04:06 +00002313CFGBlock *CFGBuilder::VisitLogicalOperator(BinaryOperator *B) {
2314 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
2315 appendStmt(ConfluenceBlock, B);
Mike Stump11289f42009-09-09 15:08:12 +00002316
Ted Kremeneka16436f2012-07-14 05:04:06 +00002317 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002318 return nullptr;
Ted Kremeneka16436f2012-07-14 05:04:06 +00002319
Craig Topper25542942014-05-20 04:30:07 +00002320 return VisitLogicalOperator(B, nullptr, ConfluenceBlock,
2321 ConfluenceBlock).first;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002322}
2323
2324std::pair<CFGBlock*, CFGBlock*>
2325CFGBuilder::VisitLogicalOperator(BinaryOperator *B,
2326 Stmt *Term,
2327 CFGBlock *TrueBlock,
2328 CFGBlock *FalseBlock) {
Ted Kremenekb50e7162012-07-14 05:04:10 +00002329 // Introspect the RHS. If it is a nested logical operation, we recursively
2330 // build the CFG using this function. Otherwise, resort to default
2331 // CFG construction behavior.
2332 Expr *RHS = B->getRHS()->IgnoreParens();
2333 CFGBlock *RHSBlock, *ExitBlock;
2334
2335 do {
2336 if (BinaryOperator *B_RHS = dyn_cast<BinaryOperator>(RHS))
2337 if (B_RHS->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00002338 std::tie(RHSBlock, ExitBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00002339 VisitLogicalOperator(B_RHS, Term, TrueBlock, FalseBlock);
2340 break;
2341 }
2342
2343 // The RHS is not a nested logical operation. Don't push the terminator
2344 // down further, but instead visit RHS and construct the respective
2345 // pieces of the CFG, and link up the RHSBlock with the terminator
2346 // we have been provided.
2347 ExitBlock = RHSBlock = createBlock(false);
2348
Richard Trieu6a6af522017-01-04 00:46:30 +00002349 // Even though KnownVal is only used in the else branch of the next
2350 // conditional, tryEvaluateBool performs additional checking on the
2351 // Expr, so it should be called unconditionally.
2352 TryResult KnownVal = tryEvaluateBool(RHS);
2353 if (!KnownVal.isKnown())
2354 KnownVal = tryEvaluateBool(B);
2355
Ted Kremenekb50e7162012-07-14 05:04:10 +00002356 if (!Term) {
2357 assert(TrueBlock == FalseBlock);
2358 addSuccessor(RHSBlock, TrueBlock);
2359 }
2360 else {
2361 RHSBlock->setTerminator(Term);
Ted Kremenek782f0032014-03-07 02:25:53 +00002362 addSuccessor(RHSBlock, TrueBlock, !KnownVal.isFalse());
2363 addSuccessor(RHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremenekb50e7162012-07-14 05:04:10 +00002364 }
2365
2366 Block = RHSBlock;
2367 RHSBlock = addStmt(RHS);
2368 }
2369 while (false);
2370
2371 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002372 return std::make_pair(nullptr, nullptr);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002373
2374 // Generate the blocks for evaluating the LHS.
2375 Expr *LHS = B->getLHS()->IgnoreParens();
2376
2377 if (BinaryOperator *B_LHS = dyn_cast<BinaryOperator>(LHS))
2378 if (B_LHS->isLogicalOp()) {
2379 if (B->getOpcode() == BO_LOr)
2380 FalseBlock = RHSBlock;
2381 else
2382 TrueBlock = RHSBlock;
2383
2384 // For the LHS, treat 'B' as the terminator that we want to sink
2385 // into the nested branch. The RHS always gets the top-most
2386 // terminator.
2387 return VisitLogicalOperator(B_LHS, B, TrueBlock, FalseBlock);
2388 }
2389
2390 // Create the block evaluating the LHS.
2391 // This contains the '&&' or '||' as the terminator.
Ted Kremeneka16436f2012-07-14 05:04:06 +00002392 CFGBlock *LHSBlock = createBlock(false);
2393 LHSBlock->setTerminator(B);
2394
Ted Kremeneka16436f2012-07-14 05:04:06 +00002395 Block = LHSBlock;
Ted Kremenekb50e7162012-07-14 05:04:10 +00002396 CFGBlock *EntryLHSBlock = addStmt(LHS);
2397
2398 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002399 return std::make_pair(nullptr, nullptr);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002400
2401 // See if this is a known constant.
Ted Kremenekb50e7162012-07-14 05:04:10 +00002402 TryResult KnownVal = tryEvaluateBool(LHS);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002403
2404 // Now link the LHSBlock with RHSBlock.
2405 if (B->getOpcode() == BO_LOr) {
Ted Kremenek782f0032014-03-07 02:25:53 +00002406 addSuccessor(LHSBlock, TrueBlock, !KnownVal.isFalse());
2407 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002408 } else {
2409 assert(B->getOpcode() == BO_LAnd);
Ted Kremenek782f0032014-03-07 02:25:53 +00002410 addSuccessor(LHSBlock, RHSBlock, !KnownVal.isFalse());
2411 addSuccessor(LHSBlock, FalseBlock, !KnownVal.isTrue());
Ted Kremeneka16436f2012-07-14 05:04:06 +00002412 }
2413
Ted Kremenekb50e7162012-07-14 05:04:10 +00002414 return std::make_pair(EntryLHSBlock, ExitBlock);
Ted Kremeneka16436f2012-07-14 05:04:06 +00002415}
2416
2417CFGBlock *CFGBuilder::VisitBinaryOperator(BinaryOperator *B,
2418 AddStmtChoice asc) {
2419 // && or ||
2420 if (B->isLogicalOp())
2421 return VisitLogicalOperator(B);
2422
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002423 if (B->getOpcode() == BO_Comma) { // ,
Ted Kremenekfe9b7682009-07-17 22:57:50 +00002424 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002425 appendStmt(Block, B);
Ted Kremenek93668002009-07-17 22:18:43 +00002426 addStmt(B->getRHS());
2427 return addStmt(B->getLHS());
2428 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00002429
2430 if (B->isAssignmentOp()) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002431 if (asc.alwaysAdd(*this, B)) {
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002432 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002433 appendStmt(Block, B);
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002434 }
Ted Kremenek8219b822010-12-16 07:46:53 +00002435 Visit(B->getLHS());
Marcin Swiderski77232492010-10-24 08:21:40 +00002436 return Visit(B->getRHS());
Zhongxing Xu41cdf582010-06-03 06:23:18 +00002437 }
Mike Stump11289f42009-09-09 15:08:12 +00002438
Ted Kremenek7c58d352011-03-10 01:14:11 +00002439 if (asc.alwaysAdd(*this, B)) {
Marcin Swiderski77232492010-10-24 08:21:40 +00002440 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002441 appendStmt(Block, B);
Marcin Swiderski77232492010-10-24 08:21:40 +00002442 }
2443
Zhongxing Xud95ccd52010-10-27 03:23:10 +00002444 CFGBlock *RBlock = Visit(B->getRHS());
2445 CFGBlock *LBlock = Visit(B->getLHS());
2446 // If visiting RHS causes us to finish 'Block', e.g. the RHS is a StmtExpr
2447 // containing a DoStmt, and the LHS doesn't create a new block, then we should
2448 // return RBlock. Otherwise we'll incorrectly return NULL.
2449 return (LBlock ? LBlock : RBlock);
Ted Kremenek93668002009-07-17 22:18:43 +00002450}
2451
Ted Kremeneke2499842012-04-12 20:03:44 +00002452CFGBlock *CFGBuilder::VisitNoRecurse(Expr *E, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00002453 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek470bfa42009-11-25 01:34:30 +00002454 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002455 appendStmt(Block, E);
Ted Kremenek470bfa42009-11-25 01:34:30 +00002456 }
2457 return Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002458}
2459
Ted Kremenek93668002009-07-17 22:18:43 +00002460CFGBlock *CFGBuilder::VisitBreakStmt(BreakStmt *B) {
2461 // "break" is a control-flow statement. Thus we stop processing the current
2462 // block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002463 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002464 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002465
Ted Kremenek93668002009-07-17 22:18:43 +00002466 // Now create a new block that ends with the break statement.
2467 Block = createBlock(false);
2468 Block->setTerminator(B);
Mike Stump11289f42009-09-09 15:08:12 +00002469
Ted Kremenek93668002009-07-17 22:18:43 +00002470 // If there is no target for the break, then we are looking at an incomplete
2471 // AST. This means that the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002472 if (BreakJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00002473 addAutomaticObjHandling(ScopePos, BreakJumpTarget.scopePosition, B);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00002474 addSuccessor(Block, BreakJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00002475 } else
Ted Kremenek93668002009-07-17 22:18:43 +00002476 badCFG = true;
Mike Stump11289f42009-09-09 15:08:12 +00002477
Ted Kremenek9aae5132007-08-23 21:42:29 +00002478 return Block;
2479}
Mike Stump11289f42009-09-09 15:08:12 +00002480
Sebastian Redl31ad7542011-03-13 17:09:40 +00002481static bool CanThrow(Expr *E, ASTContext &Ctx) {
Mike Stump04c68512010-01-21 15:20:48 +00002482 QualType Ty = E->getType();
Artem Dergachev3517d102019-08-28 21:19:58 +00002483 if (Ty->isFunctionPointerType() || Ty->isBlockPointerType())
2484 Ty = Ty->getPointeeType();
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002485
Mike Stump04c68512010-01-21 15:20:48 +00002486 const FunctionType *FT = Ty->getAs<FunctionType>();
2487 if (FT) {
2488 if (const FunctionProtoType *Proto = dyn_cast<FunctionProtoType>(FT))
Richard Smithd3b5c9082012-07-27 04:22:15 +00002489 if (!isUnresolvedExceptionSpec(Proto->getExceptionSpecType()) &&
Richard Smitheaf11ad2018-05-03 03:58:32 +00002490 Proto->isNothrow())
Mike Stump04c68512010-01-21 15:20:48 +00002491 return false;
2492 }
2493 return true;
2494}
2495
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002496CFGBlock *CFGBuilder::VisitCallExpr(CallExpr *C, AddStmtChoice asc) {
John McCallc67067f2011-05-11 07:19:11 +00002497 // Compute the callee type.
2498 QualType calleeType = C->getCallee()->getType();
2499 if (calleeType == Context->BoundMemberTy) {
2500 QualType boundType = Expr::findBoundMemberType(C->getCallee());
2501
2502 // We should only get a null bound type if processing a dependent
2503 // CFG. Recover by assuming nothing.
2504 if (!boundType.isNull()) calleeType = boundType;
Ted Kremenek93668002009-07-17 22:18:43 +00002505 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002506
John McCallc67067f2011-05-11 07:19:11 +00002507 // If this is a call to a no-return function, this stops the block here.
2508 bool NoReturn = getFunctionExtInfo(*calleeType).getNoReturn();
2509
Mike Stump04c68512010-01-21 15:20:48 +00002510 bool AddEHEdge = false;
Mike Stump92244b02010-01-19 22:00:14 +00002511
2512 // Languages without exceptions are assumed to not throw.
David Blaikiebbafb8a2012-03-11 07:00:24 +00002513 if (Context->getLangOpts().Exceptions) {
Ted Kremeneke97b1eb2010-09-14 23:41:16 +00002514 if (BuildOpts.AddEHEdges)
Mike Stump04c68512010-01-21 15:20:48 +00002515 AddEHEdge = true;
Mike Stump92244b02010-01-19 22:00:14 +00002516 }
2517
Jordan Rose5374c072013-08-19 16:27:28 +00002518 // If this is a call to a builtin function, it might not actually evaluate
2519 // its arguments. Don't add them to the CFG if this is the case.
2520 bool OmitArguments = false;
2521
Mike Stump92244b02010-01-19 22:00:14 +00002522 if (FunctionDecl *FD = C->getDirectCallee()) {
Artem Dergachev594b5412018-08-29 21:50:52 +00002523 // TODO: Support construction contexts for variadic function arguments.
2524 // These are a bit problematic and not very useful because passing
2525 // C++ objects as C-style variadic arguments doesn't work in general
2526 // (see [expr.call]).
2527 if (!FD->isVariadic())
2528 findConstructionContextsForArguments(C);
2529
Nico Weber758fbac2018-02-13 21:31:47 +00002530 if (FD->isNoReturn() || C->isBuiltinAssumeFalse(*Context))
Mike Stump8c5d7992009-07-25 21:26:53 +00002531 NoReturn = true;
Mike Stump92244b02010-01-19 22:00:14 +00002532 if (FD->hasAttr<NoThrowAttr>())
Mike Stump04c68512010-01-21 15:20:48 +00002533 AddEHEdge = false;
Erik Pilkington9c3b5882019-01-30 20:34:53 +00002534 if (FD->getBuiltinID() == Builtin::BI__builtin_object_size ||
2535 FD->getBuiltinID() == Builtin::BI__builtin_dynamic_object_size)
Jordan Rose5374c072013-08-19 16:27:28 +00002536 OmitArguments = true;
Mike Stump92244b02010-01-19 22:00:14 +00002537 }
Mike Stump8c5d7992009-07-25 21:26:53 +00002538
Sebastian Redl31ad7542011-03-13 17:09:40 +00002539 if (!CanThrow(C->getCallee(), *Context))
Mike Stump04c68512010-01-21 15:20:48 +00002540 AddEHEdge = false;
2541
Jordan Rose5374c072013-08-19 16:27:28 +00002542 if (OmitArguments) {
2543 assert(!NoReturn && "noreturn calls with unevaluated args not implemented");
2544 assert(!AddEHEdge && "EH calls with unevaluated args not implemented");
2545 autoCreateBlock();
2546 appendStmt(Block, C);
2547 return Visit(C->getCallee());
2548 }
2549
2550 if (!NoReturn && !AddEHEdge) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00002551 autoCreateBlock();
2552 appendCall(Block, C);
2553
2554 return VisitChildren(C);
Jordan Rose5374c072013-08-19 16:27:28 +00002555 }
Mike Stump11289f42009-09-09 15:08:12 +00002556
Mike Stump92244b02010-01-19 22:00:14 +00002557 if (Block) {
2558 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002559 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002560 return nullptr;
Mike Stump92244b02010-01-19 22:00:14 +00002561 }
Mike Stump11289f42009-09-09 15:08:12 +00002562
Chandler Carrutha70991b2011-09-13 09:13:49 +00002563 if (NoReturn)
2564 Block = createNoReturnBlock();
2565 else
2566 Block = createBlock();
2567
Artem Dergachev1527dec2018-03-12 23:12:40 +00002568 appendCall(Block, C);
Mike Stump8c5d7992009-07-25 21:26:53 +00002569
Mike Stump04c68512010-01-21 15:20:48 +00002570 if (AddEHEdge) {
Mike Stump92244b02010-01-19 22:00:14 +00002571 // Add exceptional edges.
2572 if (TryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002573 addSuccessor(Block, TryTerminatedBlock);
Mike Stump92244b02010-01-19 22:00:14 +00002574 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002575 addSuccessor(Block, &cfg->getExit());
Mike Stump92244b02010-01-19 22:00:14 +00002576 }
Mike Stump11289f42009-09-09 15:08:12 +00002577
Mike Stump8c5d7992009-07-25 21:26:53 +00002578 return VisitChildren(C);
Ted Kremenek93668002009-07-17 22:18:43 +00002579}
Ted Kremenek9aae5132007-08-23 21:42:29 +00002580
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002581CFGBlock *CFGBuilder::VisitChooseExpr(ChooseExpr *C,
2582 AddStmtChoice asc) {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002583 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002584 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002585 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002586 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002587
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002588 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek21822592009-07-17 18:20:32 +00002589 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002590 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002591 CFGBlock *LHSBlock = Visit(C->getLHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002592 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002593 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002594
Ted Kremenek21822592009-07-17 18:20:32 +00002595 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002596 Block = nullptr;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002597 CFGBlock *RHSBlock = Visit(C->getRHS(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002598 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002599 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002600
Ted Kremenek21822592009-07-17 18:20:32 +00002601 Block = createBlock(false);
Mike Stump773582d2009-07-23 23:25:26 +00002602 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002603 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Craig Topper25542942014-05-20 04:30:07 +00002604 addSuccessor(Block, KnownVal.isFalse() ? nullptr : LHSBlock);
2605 addSuccessor(Block, KnownVal.isTrue() ? nullptr : RHSBlock);
Ted Kremenek21822592009-07-17 18:20:32 +00002606 Block->setTerminator(C);
Mike Stump11289f42009-09-09 15:08:12 +00002607 return addStmt(C->getCond());
Ted Kremenek21822592009-07-17 18:20:32 +00002608}
Mike Stump11289f42009-09-09 15:08:12 +00002609
Artem Dergachevead98ea2019-08-28 18:44:42 +00002610CFGBlock *CFGBuilder::VisitCompoundStmt(CompoundStmt *C, bool ExternallyDestructed) {
Matthias Gehre09a134e2015-11-14 00:36:50 +00002611 LocalScope::const_iterator scopeBeginPos = ScopePos;
Matthias Gehre351c2182017-07-12 07:04:19 +00002612 addLocalScopeForStmt(C);
2613
Matthias Gehre09a134e2015-11-14 00:36:50 +00002614 if (!C->body_empty() && !isa<ReturnStmt>(*C->body_rbegin())) {
Richard Smitha547eb22016-07-14 00:11:03 +00002615 // If the body ends with a ReturnStmt, the dtors will be added in
2616 // VisitReturnStmt.
Matthias Gehre351c2182017-07-12 07:04:19 +00002617 addAutomaticObjHandling(ScopePos, scopeBeginPos, C);
Matthias Gehre09a134e2015-11-14 00:36:50 +00002618 }
2619
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002620 CFGBlock *LastBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00002621
2622 for (CompoundStmt::reverse_body_iterator I=C->body_rbegin(), E=C->body_rend();
2623 I != E; ++I ) {
Ted Kremenek4f2ab5a2010-08-17 21:00:06 +00002624 // If we hit a segment of code just containing ';' (NullStmts), we can
2625 // get a null block back. In such cases, just use the LastBlock
Artem Dergachevead98ea2019-08-28 18:44:42 +00002626 CFGBlock *newBlock = Visit(*I, AddStmtChoice::AlwaysAdd,
2627 ExternallyDestructed);
2628
2629 if (newBlock)
Ted Kremenek4f2ab5a2010-08-17 21:00:06 +00002630 LastBlock = newBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002631
Ted Kremenekce499c22009-08-27 23:16:26 +00002632 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002633 return nullptr;
Artem Dergachevead98ea2019-08-28 18:44:42 +00002634
2635 ExternallyDestructed = false;
Mike Stump11289f42009-09-09 15:08:12 +00002636 }
Mike Stump92244b02010-01-19 22:00:14 +00002637
Ted Kremenek93668002009-07-17 22:18:43 +00002638 return LastBlock;
2639}
Mike Stump11289f42009-09-09 15:08:12 +00002640
John McCallc07a0c72011-02-17 10:25:35 +00002641CFGBlock *CFGBuilder::VisitConditionalOperator(AbstractConditionalOperator *C,
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00002642 AddStmtChoice asc) {
John McCallc07a0c72011-02-17 10:25:35 +00002643 const BinaryConditionalOperator *BCO = dyn_cast<BinaryConditionalOperator>(C);
Craig Topper25542942014-05-20 04:30:07 +00002644 const OpaqueValueExpr *opaqueValue = (BCO ? BCO->getOpaqueValue() : nullptr);
John McCallc07a0c72011-02-17 10:25:35 +00002645
Ted Kremenek51d40b02009-07-17 18:15:54 +00002646 // Create the confluence block that will "merge" the results of the ternary
2647 // expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002648 CFGBlock *ConfluenceBlock = Block ? Block : createBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00002649 appendStmt(ConfluenceBlock, C);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002650 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002651 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002652
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00002653 AddStmtChoice alwaysAdd = asc.withAlwaysAdd(true);
Ted Kremenek5868ec62010-04-11 17:02:10 +00002654
Ted Kremenek51d40b02009-07-17 18:15:54 +00002655 // Create a block for the LHS expression if there is an LHS expression. A
2656 // GCC extension allows LHS to be NULL, causing the condition to be the
2657 // value that is returned instead.
2658 // e.g: x ?: y is shorthand for: x ? x : y;
2659 Succ = ConfluenceBlock;
Craig Topper25542942014-05-20 04:30:07 +00002660 Block = nullptr;
2661 CFGBlock *LHSBlock = nullptr;
John McCallc07a0c72011-02-17 10:25:35 +00002662 const Expr *trueExpr = C->getTrueExpr();
2663 if (trueExpr != opaqueValue) {
2664 LHSBlock = Visit(C->getTrueExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002665 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002666 return nullptr;
2667 Block = nullptr;
Ted Kremenek51d40b02009-07-17 18:15:54 +00002668 }
Ted Kremenekd8138012011-02-24 03:09:15 +00002669 else
2670 LHSBlock = ConfluenceBlock;
Mike Stump11289f42009-09-09 15:08:12 +00002671
Ted Kremenek51d40b02009-07-17 18:15:54 +00002672 // Create the block for the RHS expression.
2673 Succ = ConfluenceBlock;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002674 CFGBlock *RHSBlock = Visit(C->getFalseExpr(), alwaysAdd);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002675 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002676 return nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002677
Richard Smithf676e452012-07-24 21:02:14 +00002678 // If the condition is a logical '&&' or '||', build a more accurate CFG.
2679 if (BinaryOperator *Cond =
2680 dyn_cast<BinaryOperator>(C->getCond()->IgnoreParens()))
2681 if (Cond->isLogicalOp())
2682 return VisitLogicalOperator(Cond, C, LHSBlock, RHSBlock).first;
2683
Ted Kremenek51d40b02009-07-17 18:15:54 +00002684 // Create the block that will contain the condition.
2685 Block = createBlock(false);
Mike Stump11289f42009-09-09 15:08:12 +00002686
Mike Stump773582d2009-07-23 23:25:26 +00002687 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002688 const TryResult& KnownVal = tryEvaluateBool(C->getCond());
Ted Kremenek5a095272014-03-04 21:53:26 +00002689 addSuccessor(Block, LHSBlock, !KnownVal.isFalse());
2690 addSuccessor(Block, RHSBlock, !KnownVal.isTrue());
Ted Kremenek51d40b02009-07-17 18:15:54 +00002691 Block->setTerminator(C);
John McCallc07a0c72011-02-17 10:25:35 +00002692 Expr *condExpr = C->getCond();
John McCall68cc3352011-02-19 03:13:26 +00002693
Ted Kremenekd8138012011-02-24 03:09:15 +00002694 if (opaqueValue) {
2695 // Run the condition expression if it's not trivially expressed in
2696 // terms of the opaque value (or if there is no opaque value).
2697 if (condExpr != opaqueValue)
2698 addStmt(condExpr);
John McCall68cc3352011-02-19 03:13:26 +00002699
Ted Kremenekd8138012011-02-24 03:09:15 +00002700 // Before that, run the common subexpression if there was one.
2701 // At least one of this or the above will be run.
2702 return addStmt(BCO->getCommon());
2703 }
Fangrui Song6907ce22018-07-30 19:24:48 +00002704
Ted Kremenekd8138012011-02-24 03:09:15 +00002705 return addStmt(condExpr);
Ted Kremenek51d40b02009-07-17 18:15:54 +00002706}
2707
Ted Kremenek93668002009-07-17 22:18:43 +00002708CFGBlock *CFGBuilder::VisitDeclStmt(DeclStmt *DS) {
Ted Kremenek6878c362011-05-10 18:42:15 +00002709 // Check if the Decl is for an __label__. If so, elide it from the
2710 // CFG entirely.
2711 if (isa<LabelDecl>(*DS->decl_begin()))
2712 return Block;
Fangrui Song6907ce22018-07-30 19:24:48 +00002713
Ted Kremenek3a601142011-05-24 20:41:31 +00002714 // This case also handles static_asserts.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002715 if (DS->isSingleDecl())
2716 return VisitDeclSubExpr(DS);
Mike Stump11289f42009-09-09 15:08:12 +00002717
Craig Topper25542942014-05-20 04:30:07 +00002718 CFGBlock *B = nullptr;
Mike Stump11289f42009-09-09 15:08:12 +00002719
Jordan Rose8c6c8a92012-07-20 18:50:48 +00002720 // Build an individual DeclStmt for each decl.
2721 for (DeclStmt::reverse_decl_iterator I = DS->decl_rbegin(),
2722 E = DS->decl_rend();
2723 I != E; ++I) {
Mike Stump11289f42009-09-09 15:08:12 +00002724
Ted Kremenek93668002009-07-17 22:18:43 +00002725 // Allocate the DeclStmt using the BumpPtrAllocator. It will get
2726 // automatically freed with the CFG.
2727 DeclGroupRef DG(*I);
2728 Decl *D = *I;
George Karpenkovc1ac8082018-10-02 21:19:01 +00002729 DeclStmt *DSNew = new (Context) DeclStmt(DG, D->getLocation(), GetEndLoc(D));
Jordan Rosecf10ea82013-06-06 21:53:45 +00002730 cfg->addSyntheticDeclStmt(DSNew, DS);
Mike Stump11289f42009-09-09 15:08:12 +00002731
Ted Kremenek93668002009-07-17 22:18:43 +00002732 // Append the fake DeclStmt to block.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002733 B = VisitDeclSubExpr(DSNew);
Ted Kremenek93668002009-07-17 22:18:43 +00002734 }
Mike Stump11289f42009-09-09 15:08:12 +00002735
2736 return B;
Ted Kremenek93668002009-07-17 22:18:43 +00002737}
Mike Stump11289f42009-09-09 15:08:12 +00002738
Ted Kremenek93668002009-07-17 22:18:43 +00002739/// VisitDeclSubExpr - Utility method to add block-level expressions for
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002740/// DeclStmts and initializers in them.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002741CFGBlock *CFGBuilder::VisitDeclSubExpr(DeclStmt *DS) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002742 assert(DS->isSingleDecl() && "Can handle single declarations only.");
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002743 VarDecl *VD = dyn_cast<VarDecl>(DS->getSingleDecl());
Mike Stump11289f42009-09-09 15:08:12 +00002744
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002745 if (!VD) {
Jordan Rose5250b872013-06-03 22:59:41 +00002746 // Of everything that can be declared in a DeclStmt, only VarDecls impact
2747 // runtime semantics.
Ted Kremenek93668002009-07-17 22:18:43 +00002748 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002749 }
Mike Stump11289f42009-09-09 15:08:12 +00002750
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002751 bool HasTemporaries = false;
2752
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002753 // Guard static initializers under a branch.
Craig Topper25542942014-05-20 04:30:07 +00002754 CFGBlock *blockAfterStaticInit = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002755
2756 if (BuildOpts.AddStaticInitBranches && VD->isStaticLocal()) {
2757 // For static variables, we need to create a branch to track
2758 // whether or not they are initialized.
2759 if (Block) {
2760 Succ = Block;
Craig Topper25542942014-05-20 04:30:07 +00002761 Block = nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002762 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002763 return nullptr;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002764 }
2765 blockAfterStaticInit = Succ;
2766 }
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002767
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002768 // Destructors of temporaries in initialization expression should be called
2769 // after initialization finishes.
Ted Kremenek93668002009-07-17 22:18:43 +00002770 Expr *Init = VD->getInit();
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002771 if (Init) {
John McCall5d413782010-12-06 08:20:24 +00002772 HasTemporaries = isa<ExprWithCleanups>(Init);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002773
Jordan Rose6d671cc2012-09-05 22:55:23 +00002774 if (BuildOpts.AddTemporaryDtors && HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002775 // Generate destructors for temporaries in initialization expression.
Manuel Klimekdeb02622014-08-08 07:37:13 +00002776 TempDtorContext Context;
Manuel Klimekb5616c92014-08-07 10:42:17 +00002777 VisitForTemporaryDtors(cast<ExprWithCleanups>(Init)->getSubExpr(),
Artem Dergachevead98ea2019-08-28 18:44:42 +00002778 /*ExternallyDestructed=*/true, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002779 }
2780 }
2781
2782 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00002783 appendStmt(Block, DS);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002784
Artem Dergachev783a4572018-02-23 22:20:39 +00002785 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00002786 ConstructionContextLayer::create(cfg->getBumpVectorContext(), DS),
Artem Dergachev783a4572018-02-23 22:20:39 +00002787 Init);
Artem Dergachev5fc10332018-02-10 01:55:23 +00002788
Ted Kremenek213d0532012-03-22 05:57:43 +00002789 // Keep track of the last non-null block, as 'Block' can be nulled out
2790 // if the initializer expression is something like a 'while' in a
2791 // statement-expression.
2792 CFGBlock *LastBlock = Block;
Mike Stump11289f42009-09-09 15:08:12 +00002793
Ted Kremenek93668002009-07-17 22:18:43 +00002794 if (Init) {
Ted Kremenek213d0532012-03-22 05:57:43 +00002795 if (HasTemporaries) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00002796 // For expression with temporaries go directly to subexpression to omit
2797 // generating destructors for the second time.
Ted Kremenek213d0532012-03-22 05:57:43 +00002798 ExprWithCleanups *EC = cast<ExprWithCleanups>(Init);
2799 if (CFGBlock *newBlock = Visit(EC->getSubExpr()))
2800 LastBlock = newBlock;
2801 }
2802 else {
2803 if (CFGBlock *newBlock = Visit(Init))
2804 LastBlock = newBlock;
2805 }
Ted Kremenek93668002009-07-17 22:18:43 +00002806 }
Mike Stump11289f42009-09-09 15:08:12 +00002807
Ted Kremenek93668002009-07-17 22:18:43 +00002808 // If the type of VD is a VLA, then we must process its size expressions.
John McCall424cec92011-01-19 06:33:43 +00002809 for (const VariableArrayType* VA = FindVA(VD->getType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00002810 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr())) {
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002811 if (CFGBlock *newBlock = addStmt(VA->getSizeExpr()))
2812 LastBlock = newBlock;
2813 }
Mike Stump11289f42009-09-09 15:08:12 +00002814
Maxim Ostapenkodebca452018-03-12 12:26:15 +00002815 maybeAddScopeBeginForVarDecl(Block, VD, DS);
2816
Marcin Swiderski667ffec2010-10-01 00:23:17 +00002817 // Remove variable from local scope.
2818 if (ScopePos && VD == *ScopePos)
2819 ++ScopePos;
2820
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002821 CFGBlock *B = LastBlock;
Ted Kremenekf82d5782013-03-29 00:42:56 +00002822 if (blockAfterStaticInit) {
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002823 Succ = B;
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002824 Block = createBlock(false);
2825 Block->setTerminator(DS);
Ted Kremenekf82d5782013-03-29 00:42:56 +00002826 addSuccessor(Block, blockAfterStaticInit);
Ted Kremenek338c3aa2013-03-29 00:09:28 +00002827 addSuccessor(Block, B);
2828 B = Block;
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00002829 }
2830
2831 return B;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002832}
2833
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002834CFGBlock *CFGBuilder::VisitIfStmt(IfStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00002835 // We may see an if statement in the middle of a basic block, or it may be the
2836 // first statement we are processing. In either case, we create a new basic
2837 // block. First, we create the blocks for the then...else statements, and
2838 // then we create the block containing the if statement. If we were in the
Ted Kremenek0868eea2009-09-24 18:45:41 +00002839 // middle of a block, we stop processing that block. That block is then the
2840 // implicit successor for the "then" and "else" clauses.
Mike Stump31feda52009-07-17 01:31:16 +00002841
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002842 // Save local scope position because in case of condition variable ScopePos
2843 // won't be restored when traversing AST.
2844 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
2845
Richard Smitha547eb22016-07-14 00:11:03 +00002846 // Create local scope for C++17 if init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00002847 if (Stmt *Init = I->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00002848 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00002849
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002850 // Create local scope for possible condition variable.
2851 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00002852 if (VarDecl *VD = I->getConditionVariable())
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002853 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00002854
Matthias Gehre351c2182017-07-12 07:04:19 +00002855 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), I);
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002856
Chris Lattner57540c52011-04-15 05:22:18 +00002857 // The block we were processing is now finished. Make it the successor
Mike Stump31feda52009-07-17 01:31:16 +00002858 // block.
2859 if (Block) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002860 Succ = Block;
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002861 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002862 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002863 }
Mike Stump31feda52009-07-17 01:31:16 +00002864
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002865 // Process the false branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002866 CFGBlock *ElseBlock = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00002867
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002868 if (Stmt *Else = I->getElse()) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00002869 SaveAndRestore<CFGBlock*> sv(Succ);
Mike Stump31feda52009-07-17 01:31:16 +00002870
Ted Kremenek9aae5132007-08-23 21:42:29 +00002871 // NULL out Block so that the recursive call to Visit will
Mike Stump31feda52009-07-17 01:31:16 +00002872 // create a new basic block.
Craig Topper25542942014-05-20 04:30:07 +00002873 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002874
2875 // If branch is not a compound statement create implicit scope
2876 // and add destructors.
2877 if (!isa<CompoundStmt>(Else))
2878 addLocalScopeAndDtors(Else);
2879
Ted Kremenek93668002009-07-17 22:18:43 +00002880 ElseBlock = addStmt(Else);
Mike Stump31feda52009-07-17 01:31:16 +00002881
Ted Kremenekbbad8ce2007-08-30 18:13:31 +00002882 if (!ElseBlock) // Can occur when the Else body has all NullStmts.
2883 ElseBlock = sv.get();
Ted Kremenek55957a82009-05-02 00:13:27 +00002884 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002885 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002886 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00002887 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002888 }
Mike Stump31feda52009-07-17 01:31:16 +00002889
Ted Kremenek0bcdc982009-07-17 18:04:55 +00002890 // Process the true branch.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002891 CFGBlock *ThenBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002892 {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00002893 Stmt *Then = I->getThen();
Ted Kremenek1362b8b2010-01-19 20:46:35 +00002894 assert(Then);
Ted Kremenek9aae5132007-08-23 21:42:29 +00002895 SaveAndRestore<CFGBlock*> sv(Succ);
Craig Topper25542942014-05-20 04:30:07 +00002896 Block = nullptr;
Marcin Swiderskif883ade2010-10-01 00:52:17 +00002897
2898 // If branch is not a compound statement create implicit scope
2899 // and add destructors.
2900 if (!isa<CompoundStmt>(Then))
2901 addLocalScopeAndDtors(Then);
2902
Ted Kremenek93668002009-07-17 22:18:43 +00002903 ThenBlock = addStmt(Then);
Mike Stump31feda52009-07-17 01:31:16 +00002904
Ted Kremenek1b379512009-04-01 03:52:47 +00002905 if (!ThenBlock) {
2906 // We can reach here if the "then" body has all NullStmts.
2907 // Create an empty block so we can distinguish between true and false
2908 // branches in path-sensitive analyses.
2909 ThenBlock = createBlock(false);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00002910 addSuccessor(ThenBlock, sv.get());
Mike Stump31feda52009-07-17 01:31:16 +00002911 } else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00002912 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00002913 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00002914 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00002915 }
2916
Ted Kremenekb50e7162012-07-14 05:04:10 +00002917 // Specially handle "if (expr1 || ...)" and "if (expr1 && ...)" by
2918 // having these handle the actual control-flow jump. Note that
2919 // if we introduce a condition variable, e.g. "if (int x = exp1 || exp2)"
2920 // we resort to the old control-flow behavior. This special handling
2921 // removes infeasible paths from the control-flow graph by having the
2922 // control-flow transfer of '&&' or '||' go directly into the then/else
2923 // blocks directly.
Richard Smith509bbd12017-01-13 22:16:41 +00002924 BinaryOperator *Cond =
2925 I->getConditionVariable()
2926 ? nullptr
2927 : dyn_cast<BinaryOperator>(I->getCond()->IgnoreParens());
2928 CFGBlock *LastBlock;
2929 if (Cond && Cond->isLogicalOp())
2930 LastBlock = VisitLogicalOperator(Cond, I, ThenBlock, ElseBlock).first;
2931 else {
2932 // Now create a new block containing the if statement.
2933 Block = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00002934
Richard Smith509bbd12017-01-13 22:16:41 +00002935 // Set the terminator of the new block to the If statement.
2936 Block->setTerminator(I);
Mike Stump31feda52009-07-17 01:31:16 +00002937
Richard Smith509bbd12017-01-13 22:16:41 +00002938 // See if this is a known constant.
2939 const TryResult &KnownVal = tryEvaluateBool(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002940
Richard Smith509bbd12017-01-13 22:16:41 +00002941 // Add the successors. If we know that specific branches are
2942 // unreachable, inform addSuccessor() of that knowledge.
Rui Ueyama49a3ad22019-07-16 04:46:31 +00002943 addSuccessor(Block, ThenBlock, /* IsReachable = */ !KnownVal.isFalse());
2944 addSuccessor(Block, ElseBlock, /* IsReachable = */ !KnownVal.isTrue());
Mike Stump773582d2009-07-23 23:25:26 +00002945
Richard Smith509bbd12017-01-13 22:16:41 +00002946 // Add the condition as the last statement in the new block. This may
2947 // create new blocks as the condition may contain control-flow. Any newly
2948 // created blocks will be pointed to be "Block".
2949 LastBlock = addStmt(I->getCond());
Mike Stump31feda52009-07-17 01:31:16 +00002950
Richard Smith509bbd12017-01-13 22:16:41 +00002951 // If the IfStmt contains a condition variable, add it and its
2952 // initializer to the CFG.
2953 if (const DeclStmt* DS = I->getConditionVariableDeclStmt()) {
2954 autoCreateBlock();
2955 LastBlock = addStmt(const_cast<DeclStmt *>(DS));
2956 }
Ted Kremeneka7bcbde2009-12-23 04:49:01 +00002957 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00002958
Richard Smitha547eb22016-07-14 00:11:03 +00002959 // Finally, if the IfStmt contains a C++17 init-stmt, add it to the CFG.
2960 if (Stmt *Init = I->getInit()) {
2961 autoCreateBlock();
2962 LastBlock = addStmt(Init);
2963 }
2964
Ted Kremeneke6ee6712012-11-13 00:12:13 +00002965 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00002966}
Mike Stump31feda52009-07-17 01:31:16 +00002967
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002968CFGBlock *CFGBuilder::VisitReturnStmt(Stmt *S) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00002969 // If we were in the middle of a block we stop processing that block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00002970 //
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002971 // NOTE: If a "return" or "co_return" appears in the middle of a block, this
2972 // means that the code afterwards is DEAD (unreachable). We still keep
2973 // a basic block for that code; a simple "mark-and-sweep" from the entry
2974 // block will be able to report such dead blocks.
2975 assert(isa<ReturnStmt>(S) || isa<CoreturnStmt>(S));
Ted Kremenek9aae5132007-08-23 21:42:29 +00002976
2977 // Create the new block.
2978 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00002979
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002980 addAutomaticObjHandling(ScopePos, LocalScope::const_iterator(), S);
Pavel Labath921e7652013-09-06 08:12:48 +00002981
Brian Gesiaka87ecf62018-11-03 22:35:17 +00002982 if (auto *R = dyn_cast<ReturnStmt>(S))
2983 findConstructionContexts(
2984 ConstructionContextLayer::create(cfg->getBumpVectorContext(), R),
2985 R->getRetValue());
Artem Dergachev9ac2e112018-02-12 22:36:36 +00002986
Pavel Labath921e7652013-09-06 08:12:48 +00002987 // If the one of the destructors does not return, we already have the Exit
2988 // block as a successor.
2989 if (!Block->hasNoReturnElement())
2990 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00002991
Artem Dergachevead98ea2019-08-28 18:44:42 +00002992 // Add the return statement to the block.
2993 appendStmt(Block, S);
2994
2995 // Visit children
2996 if (ReturnStmt *RS = dyn_cast<ReturnStmt>(S)) {
2997 Expr *O = RS->getRetValue();
2998 if (O)
2999 Visit(O, AddStmtChoice::AlwaysAdd, /*ExternallyDestructed=*/true);
3000 return Block;
3001 } else { // co_return
3002 return VisitChildren(S);
3003 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00003004}
3005
Nico Weber699670e2017-08-23 15:33:16 +00003006CFGBlock *CFGBuilder::VisitSEHExceptStmt(SEHExceptStmt *ES) {
3007 // SEHExceptStmt are treated like labels, so they are the first statement in a
3008 // block.
3009
3010 // Save local scope position because in case of exception variable ScopePos
3011 // won't be restored when traversing AST.
3012 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3013
3014 addStmt(ES->getBlock());
3015 CFGBlock *SEHExceptBlock = Block;
3016 if (!SEHExceptBlock)
3017 SEHExceptBlock = createBlock();
3018
3019 appendStmt(SEHExceptBlock, ES);
3020
3021 // Also add the SEHExceptBlock as a label, like with regular labels.
3022 SEHExceptBlock->setLabel(ES);
3023
3024 // Bail out if the CFG is bad.
3025 if (badCFG)
3026 return nullptr;
3027
3028 // We set Block to NULL to allow lazy creation of a new block (if necessary).
3029 Block = nullptr;
3030
3031 return SEHExceptBlock;
3032}
3033
3034CFGBlock *CFGBuilder::VisitSEHFinallyStmt(SEHFinallyStmt *FS) {
Artem Dergachevead98ea2019-08-28 18:44:42 +00003035 return VisitCompoundStmt(FS->getBlock(), /*ExternallyDestructed=*/false);
Nico Weber699670e2017-08-23 15:33:16 +00003036}
3037
3038CFGBlock *CFGBuilder::VisitSEHLeaveStmt(SEHLeaveStmt *LS) {
3039 // "__leave" is a control-flow statement. Thus we stop processing the current
3040 // block.
3041 if (badCFG)
3042 return nullptr;
3043
3044 // Now create a new block that ends with the __leave statement.
3045 Block = createBlock(false);
3046 Block->setTerminator(LS);
3047
3048 // If there is no target for the __leave, then we are looking at an incomplete
3049 // AST. This means that the CFG cannot be constructed.
3050 if (SEHLeaveJumpTarget.block) {
3051 addAutomaticObjHandling(ScopePos, SEHLeaveJumpTarget.scopePosition, LS);
3052 addSuccessor(Block, SEHLeaveJumpTarget.block);
3053 } else
3054 badCFG = true;
3055
3056 return Block;
3057}
3058
3059CFGBlock *CFGBuilder::VisitSEHTryStmt(SEHTryStmt *Terminator) {
3060 // "__try"/"__except"/"__finally" is a control-flow statement. Thus we stop
3061 // processing the current block.
3062 CFGBlock *SEHTrySuccessor = nullptr;
3063
3064 if (Block) {
3065 if (badCFG)
3066 return nullptr;
3067 SEHTrySuccessor = Block;
3068 } else SEHTrySuccessor = Succ;
3069
3070 // FIXME: Implement __finally support.
3071 if (Terminator->getFinallyHandler())
3072 return NYS();
3073
3074 CFGBlock *PrevSEHTryTerminatedBlock = TryTerminatedBlock;
3075
3076 // Create a new block that will contain the __try statement.
3077 CFGBlock *NewTryTerminatedBlock = createBlock(false);
3078
3079 // Add the terminator in the __try block.
3080 NewTryTerminatedBlock->setTerminator(Terminator);
3081
3082 if (SEHExceptStmt *Except = Terminator->getExceptHandler()) {
3083 // The code after the try is the implicit successor if there's an __except.
3084 Succ = SEHTrySuccessor;
3085 Block = nullptr;
3086 CFGBlock *ExceptBlock = VisitSEHExceptStmt(Except);
3087 if (!ExceptBlock)
3088 return nullptr;
3089 // Add this block to the list of successors for the block with the try
3090 // statement.
3091 addSuccessor(NewTryTerminatedBlock, ExceptBlock);
3092 }
3093 if (PrevSEHTryTerminatedBlock)
3094 addSuccessor(NewTryTerminatedBlock, PrevSEHTryTerminatedBlock);
3095 else
3096 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
3097
3098 // The code after the try is the implicit successor.
3099 Succ = SEHTrySuccessor;
3100
3101 // Save the current "__try" context.
3102 SaveAndRestore<CFGBlock *> save_try(TryTerminatedBlock,
3103 NewTryTerminatedBlock);
3104 cfg->addTryDispatchBlock(TryTerminatedBlock);
3105
3106 // Save the current value for the __leave target.
3107 // All __leaves should go to the code following the __try
3108 // (FIXME: or if the __try has a __finally, to the __finally.)
3109 SaveAndRestore<JumpTarget> save_break(SEHLeaveJumpTarget);
3110 SEHLeaveJumpTarget = JumpTarget(SEHTrySuccessor, ScopePos);
3111
3112 assert(Terminator->getTryBlock() && "__try must contain a non-NULL body");
3113 Block = nullptr;
3114 return addStmt(Terminator->getTryBlock());
3115}
3116
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003117CFGBlock *CFGBuilder::VisitLabelStmt(LabelStmt *L) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003118 // Get the block of the labeled statement. Add it to our map.
Ted Kremenek93668002009-07-17 22:18:43 +00003119 addStmt(L->getSubStmt());
Chris Lattnerc8e630e2011-02-17 07:39:24 +00003120 CFGBlock *LabelBlock = Block;
Mike Stump31feda52009-07-17 01:31:16 +00003121
Ted Kremenek93668002009-07-17 22:18:43 +00003122 if (!LabelBlock) // This can happen when the body is empty, i.e.
3123 LabelBlock = createBlock(); // scopes that only contains NullStmts.
Mike Stump31feda52009-07-17 01:31:16 +00003124
Chris Lattnerc8e630e2011-02-17 07:39:24 +00003125 assert(LabelMap.find(L->getDecl()) == LabelMap.end() &&
3126 "label already in map");
3127 LabelMap[L->getDecl()] = JumpTarget(LabelBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003128
3129 // Labels partition blocks, so this is the end of the basic block we were
3130 // processing (L is the block's label). Because this is label (and we have
3131 // already processed the substatement) there is no extra control-flow to worry
3132 // about.
Ted Kremenek71eca012007-08-29 23:20:49 +00003133 LabelBlock->setLabel(L);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003134 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003135 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003136
3137 // We set Block to NULL to allow lazy creation of a new block (if necessary);
Craig Topper25542942014-05-20 04:30:07 +00003138 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003139
Ted Kremenek9aae5132007-08-23 21:42:29 +00003140 // This block is now the implicit successor of other blocks.
3141 Succ = LabelBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003142
Ted Kremenek9aae5132007-08-23 21:42:29 +00003143 return LabelBlock;
3144}
3145
Devin Coughlinb6029b72015-11-25 22:35:37 +00003146CFGBlock *CFGBuilder::VisitBlockExpr(BlockExpr *E, AddStmtChoice asc) {
3147 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
3148 for (const BlockDecl::Capture &CI : E->getBlockDecl()->captures()) {
3149 if (Expr *CopyExpr = CI.getCopyExpr()) {
3150 CFGBlock *Tmp = Visit(CopyExpr);
3151 if (Tmp)
3152 LastBlock = Tmp;
3153 }
3154 }
3155 return LastBlock;
3156}
3157
Ted Kremenekda76a942012-04-12 20:34:52 +00003158CFGBlock *CFGBuilder::VisitLambdaExpr(LambdaExpr *E, AddStmtChoice asc) {
3159 CFGBlock *LastBlock = VisitNoRecurse(E, asc);
3160 for (LambdaExpr::capture_init_iterator it = E->capture_init_begin(),
3161 et = E->capture_init_end(); it != et; ++it) {
3162 if (Expr *Init = *it) {
3163 CFGBlock *Tmp = Visit(Init);
Craig Topper25542942014-05-20 04:30:07 +00003164 if (Tmp)
Ted Kremenekda76a942012-04-12 20:34:52 +00003165 LastBlock = Tmp;
3166 }
3167 }
3168 return LastBlock;
3169}
Fangrui Song6907ce22018-07-30 19:24:48 +00003170
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003171CFGBlock *CFGBuilder::VisitGotoStmt(GotoStmt *G) {
Mike Stump31feda52009-07-17 01:31:16 +00003172 // Goto is a control-flow statement. Thus we stop processing the current
3173 // block and create a new one.
Ted Kremenek93668002009-07-17 22:18:43 +00003174
Ted Kremenek9aae5132007-08-23 21:42:29 +00003175 Block = createBlock(false);
3176 Block->setTerminator(G);
Mike Stump31feda52009-07-17 01:31:16 +00003177
3178 // If we already know the mapping to the label block add the successor now.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003179 LabelMapTy::iterator I = LabelMap.find(G->getLabel());
Mike Stump31feda52009-07-17 01:31:16 +00003180
Ted Kremenek9aae5132007-08-23 21:42:29 +00003181 if (I == LabelMap.end())
3182 // We will need to backpatch this block later.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003183 BackpatchBlocks.push_back(JumpSource(Block, ScopePos));
3184 else {
3185 JumpTarget JT = I->second;
Matthias Gehre351c2182017-07-12 07:04:19 +00003186 addAutomaticObjHandling(ScopePos, JT.scopePosition, G);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003187 addSuccessor(Block, JT.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003188 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00003189
Mike Stump31feda52009-07-17 01:31:16 +00003190 return Block;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003191}
3192
Jennifer Yub8fee672019-06-03 15:57:25 +00003193CFGBlock *CFGBuilder::VisitGCCAsmStmt(GCCAsmStmt *G, AddStmtChoice asc) {
3194 // Goto is a control-flow statement. Thus we stop processing the current
3195 // block and create a new one.
3196
3197 if (!G->isAsmGoto())
3198 return VisitStmt(G, asc);
3199
3200 if (Block) {
3201 Succ = Block;
3202 if (badCFG)
3203 return nullptr;
3204 }
3205 Block = createBlock();
3206 Block->setTerminator(G);
3207 // We will backpatch this block later for all the labels.
3208 BackpatchBlocks.push_back(JumpSource(Block, ScopePos));
3209 // Save "Succ" in BackpatchBlocks. In the backpatch processing, "Succ" is
3210 // used to avoid adding "Succ" again.
3211 BackpatchBlocks.push_back(JumpSource(Succ, ScopePos));
3212 return Block;
3213}
3214
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003215CFGBlock *CFGBuilder::VisitForStmt(ForStmt *F) {
Craig Topper25542942014-05-20 04:30:07 +00003216 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003217
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003218 // Save local scope position because in case of condition variable ScopePos
3219 // won't be restored when traversing AST.
3220 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3221
3222 // Create local scope for init statement and possible condition variable.
3223 // Add destructor for init statement and condition variable.
3224 // Store scope position for continue statement.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003225 if (Stmt *Init = F->getInit())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003226 addLocalScopeForStmt(Init);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003227 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
3228
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003229 if (VarDecl *VD = F->getConditionVariable())
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003230 addLocalScopeForVarDecl(VD);
3231 LocalScope::const_iterator ContinueScopePos = ScopePos;
3232
Matthias Gehre351c2182017-07-12 07:04:19 +00003233 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), F);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003234
Peter Szecsi999a25f2017-08-19 11:19:16 +00003235 addLoopExit(F);
3236
Mike Stump014b3ea2009-07-21 01:12:51 +00003237 // "for" is a control-flow statement. Thus we stop processing the current
3238 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003239 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003240 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003241 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003242 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003243 } else
3244 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003245
Ted Kremenek304a9532010-05-21 20:30:15 +00003246 // Save the current value for the break targets.
3247 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003248 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003249 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Ted Kremenek304a9532010-05-21 20:30:15 +00003250
Craig Topper25542942014-05-20 04:30:07 +00003251 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00003252
Ted Kremenek9aae5132007-08-23 21:42:29 +00003253 // Now create the loop body.
3254 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003255 assert(F->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003256
Ted Kremenekb50e7162012-07-14 05:04:10 +00003257 // Save the current values for Block, Succ, continue and break targets.
3258 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3259 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003260
Ted Kremenekb50e7162012-07-14 05:04:10 +00003261 // Create an empty block to represent the transition block for looping back
3262 // to the head of the loop. If we have increment code, it will
3263 // go in this block as well.
3264 Block = Succ = TransitionBlock = createBlock(false);
3265 TransitionBlock->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00003266
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003267 if (Stmt *I = F->getInc()) {
Mike Stump31feda52009-07-17 01:31:16 +00003268 // Generate increment code in its own basic block. This is the target of
3269 // continue statements.
Ted Kremenek93668002009-07-17 22:18:43 +00003270 Succ = addStmt(I);
Ted Kremenekb0746ca2008-09-04 21:48:47 +00003271 }
Mike Stump31feda52009-07-17 01:31:16 +00003272
Ted Kremenek902393b2009-04-28 00:51:56 +00003273 // Finish up the increment (or empty) block if it hasn't been already.
3274 if (Block) {
3275 assert(Block == Succ);
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003276 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003277 return nullptr;
3278 Block = nullptr;
Ted Kremenek902393b2009-04-28 00:51:56 +00003279 }
Mike Stump31feda52009-07-17 01:31:16 +00003280
Ted Kremenekb50e7162012-07-14 05:04:10 +00003281 // The starting block for the loop increment is the block that should
3282 // represent the 'loop target' for looping back to the start of the loop.
3283 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
3284 ContinueJumpTarget.block->setLoopTarget(F);
Mike Stump31feda52009-07-17 01:31:16 +00003285
Ted Kremenekb50e7162012-07-14 05:04:10 +00003286 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00003287 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, F);
Ted Kremenek902393b2009-04-28 00:51:56 +00003288
Marcin Swiderski6d5ee0c2010-10-01 01:38:14 +00003289 // If body is not a compound statement create implicit scope
3290 // and add destructors.
3291 if (!isa<CompoundStmt>(F->getBody()))
3292 addLocalScopeAndDtors(F->getBody());
3293
Mike Stump31feda52009-07-17 01:31:16 +00003294 // Now populate the body block, and in the process create new blocks as we
3295 // walk the body of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003296 BodyBlock = addStmt(F->getBody());
Ted Kremeneke9610502007-08-30 18:39:40 +00003297
Ted Kremenekb50e7162012-07-14 05:04:10 +00003298 if (!BodyBlock) {
3299 // In the case of "for (...;...;...);" we can have a null BodyBlock.
3300 // Use the continue jump target as the proxy for the body.
3301 BodyBlock = ContinueJumpTarget.block;
3302 }
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003303 else if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003304 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003305 }
Fangrui Song6907ce22018-07-30 19:24:48 +00003306
Ted Kremenekb50e7162012-07-14 05:04:10 +00003307 // Because of short-circuit evaluation, the condition of the loop can span
3308 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3309 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00003310 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003311
Ted Kremenekb50e7162012-07-14 05:04:10 +00003312 do {
3313 Expr *C = F->getCond();
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003314 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003315
3316 // Specially handle logical operators, which have a slightly
3317 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00003318 if (BinaryOperator *Cond =
Craig Topper25542942014-05-20 04:30:07 +00003319 dyn_cast_or_null<BinaryOperator>(C ? C->IgnoreParens() : nullptr))
Ted Kremenekb50e7162012-07-14 05:04:10 +00003320 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00003321 std::tie(EntryConditionBlock, ExitConditionBlock) =
Ted Kremenekb50e7162012-07-14 05:04:10 +00003322 VisitLogicalOperator(Cond, F, BodyBlock, LoopSuccessor);
3323 break;
3324 }
3325
3326 // The default case when not handling logical operators.
3327 EntryConditionBlock = ExitConditionBlock = createBlock(false);
3328 ExitConditionBlock->setTerminator(F);
3329
3330 // See if this is a known constant.
3331 TryResult KnownVal(true);
3332
3333 if (C) {
3334 // Now add the actual condition to the condition block.
3335 // Because the condition itself may contain control-flow, new blocks may
3336 // be created. Thus we update "Succ" after adding the condition.
3337 Block = ExitConditionBlock;
3338 EntryConditionBlock = addStmt(C);
3339
3340 // If this block contains a condition variable, add both the condition
3341 // variable and initializer to the CFG.
3342 if (VarDecl *VD = F->getConditionVariable()) {
3343 if (Expr *Init = VD->getInit()) {
3344 autoCreateBlock();
Artem Dergachevab9b78b2018-04-19 23:30:15 +00003345 const DeclStmt *DS = F->getConditionVariableDeclStmt();
3346 assert(DS->isSingleDecl());
3347 findConstructionContexts(
Artem Dergachev1f8cb3a2018-07-31 21:12:42 +00003348 ConstructionContextLayer::create(cfg->getBumpVectorContext(), DS),
Artem Dergachevab9b78b2018-04-19 23:30:15 +00003349 Init);
3350 appendStmt(Block, DS);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003351 EntryConditionBlock = addStmt(Init);
3352 assert(Block == EntryConditionBlock);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003353 maybeAddScopeBeginForVarDecl(EntryConditionBlock, VD, C);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003354 }
3355 }
3356
3357 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003358 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003359
3360 KnownVal = tryEvaluateBool(C);
3361 }
3362
3363 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003364 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003365 // Link up the condition block with the code that follows the loop. (the
3366 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003367 addSuccessor(ExitConditionBlock,
3368 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003369 } while (false);
3370
3371 // Link up the loop-back block to the entry condition block.
3372 addSuccessor(TransitionBlock, EntryConditionBlock);
Fangrui Song6907ce22018-07-30 19:24:48 +00003373
Ted Kremenekb50e7162012-07-14 05:04:10 +00003374 // The condition block is the implicit successor for any code above the loop.
3375 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003376
Ted Kremenek9aae5132007-08-23 21:42:29 +00003377 // If the loop contains initialization, create a new block for those
Mike Stump31feda52009-07-17 01:31:16 +00003378 // statements. This block can also contain statements that precede the loop.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003379 if (Stmt *I = F->getInit()) {
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003380 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3381 ScopePos = LoopBeginScopePos;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003382 Block = createBlock();
Ted Kremenek81e14852007-08-27 19:46:09 +00003383 return addStmt(I);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003384 }
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003385
3386 // There is no loop initialization. We are thus basically a while loop.
3387 // NULL out Block to force lazy block construction.
Craig Topper25542942014-05-20 04:30:07 +00003388 Block = nullptr;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00003389 Succ = EntryConditionBlock;
3390 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003391}
3392
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00003393CFGBlock *
3394CFGBuilder::VisitMaterializeTemporaryExpr(MaterializeTemporaryExpr *MTE,
3395 AddStmtChoice asc) {
3396 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00003397 ConstructionContextLayer::create(cfg->getBumpVectorContext(), MTE),
Artem Dergachevf43ac4c2018-02-24 02:00:30 +00003398 MTE->getTemporary());
3399
3400 return VisitStmt(MTE, asc);
3401}
3402
Ted Kremenek5868ec62010-04-11 17:02:10 +00003403CFGBlock *CFGBuilder::VisitMemberExpr(MemberExpr *M, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003404 if (asc.alwaysAdd(*this, M)) {
Ted Kremenek5868ec62010-04-11 17:02:10 +00003405 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003406 appendStmt(Block, M);
Ted Kremenek5868ec62010-04-11 17:02:10 +00003407 }
Ted Kremenek8219b822010-12-16 07:46:53 +00003408 return Visit(M->getBase());
Ted Kremenek5868ec62010-04-11 17:02:10 +00003409}
3410
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003411CFGBlock *CFGBuilder::VisitObjCForCollectionStmt(ObjCForCollectionStmt *S) {
Ted Kremenek9d56e642008-11-11 17:10:00 +00003412 // Objective-C fast enumeration 'for' statements:
3413 // http://developer.apple.com/documentation/Cocoa/Conceptual/ObjectiveC
3414 //
3415 // for ( Type newVariable in collection_expression ) { statements }
3416 //
3417 // becomes:
3418 //
3419 // prologue:
3420 // 1. collection_expression
3421 // T. jump to loop_entry
3422 // loop_entry:
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003423 // 1. side-effects of element expression
Ted Kremenek9d56e642008-11-11 17:10:00 +00003424 // 1. ObjCForCollectionStmt [performs binding to newVariable]
3425 // T. ObjCForCollectionStmt TB, FB [jumps to TB if newVariable != nil]
3426 // TB:
3427 // statements
3428 // T. jump to loop_entry
3429 // FB:
3430 // what comes after
3431 //
3432 // and
3433 //
3434 // Type existingItem;
3435 // for ( existingItem in expression ) { statements }
3436 //
3437 // becomes:
3438 //
Mike Stump31feda52009-07-17 01:31:16 +00003439 // the same with newVariable replaced with existingItem; the binding works
3440 // the same except that for one ObjCForCollectionStmt::getElement() returns
3441 // a DeclStmt and the other returns a DeclRefExpr.
Mike Stump31feda52009-07-17 01:31:16 +00003442
Craig Topper25542942014-05-20 04:30:07 +00003443 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003444
Ted Kremenek9d56e642008-11-11 17:10:00 +00003445 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003446 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003447 return nullptr;
Ted Kremenek9d56e642008-11-11 17:10:00 +00003448 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003449 Block = nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00003450 } else
3451 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003452
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003453 // Build the condition blocks.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003454 CFGBlock *ExitConditionBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003455
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003456 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003457 ExitConditionBlock->setTerminator(S);
3458
3459 // The last statement in the block should be the ObjCForCollectionStmt, which
3460 // performs the actual binding to 'element' and determines if there are any
3461 // more items in the collection.
Ted Kremenek8219b822010-12-16 07:46:53 +00003462 appendStmt(ExitConditionBlock, S);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003463 Block = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003464
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003465 // Walk the 'element' expression to see if there are any side-effects. We
Chris Lattner57540c52011-04-15 05:22:18 +00003466 // generate new blocks as necessary. We DON'T add the statement by default to
Mike Stump31feda52009-07-17 01:31:16 +00003467 // the CFG unless it contains control-flow.
Ted Kremenekc14efa72011-08-17 21:04:19 +00003468 CFGBlock *EntryConditionBlock = Visit(S->getElement(),
3469 AddStmtChoice::NotAlwaysAdd);
Mike Stump31feda52009-07-17 01:31:16 +00003470 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003471 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003472 return nullptr;
3473 Block = nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003474 }
Mike Stump31feda52009-07-17 01:31:16 +00003475
3476 // The condition block is the implicit successor for the loop body as well as
3477 // any code above the loop.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003478 Succ = EntryConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003479
Ted Kremenek9d56e642008-11-11 17:10:00 +00003480 // Now create the true branch.
Mike Stump31feda52009-07-17 01:31:16 +00003481 {
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003482 // Save the current values for Succ, continue and break targets.
Anna Zaks56b49752013-06-22 00:23:20 +00003483 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003484 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Anna Zaks56b49752013-06-22 00:23:20 +00003485 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003486
Anna Zaks56b49752013-06-22 00:23:20 +00003487 // Add an intermediate block between the BodyBlock and the
3488 // EntryConditionBlock to represent the "loop back" transition, for looping
3489 // back to the head of the loop.
Craig Topper25542942014-05-20 04:30:07 +00003490 CFGBlock *LoopBackBlock = nullptr;
Anna Zaks56b49752013-06-22 00:23:20 +00003491 Succ = LoopBackBlock = createBlock();
3492 LoopBackBlock->setLoopTarget(S);
Fangrui Song6907ce22018-07-30 19:24:48 +00003493
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003494 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Anna Zaks56b49752013-06-22 00:23:20 +00003495 ContinueJumpTarget = JumpTarget(Succ, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003496
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003497 CFGBlock *BodyBlock = addStmt(S->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003498
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003499 if (!BodyBlock)
Anna Zaks56b49752013-06-22 00:23:20 +00003500 BodyBlock = ContinueJumpTarget.block; // can happen for "for (X in Y) ;"
Ted Kremenek55957a82009-05-02 00:13:27 +00003501 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003502 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003503 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003504 }
Mike Stump31feda52009-07-17 01:31:16 +00003505
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003506 // This new body block is a successor to our "exit" condition block.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003507 addSuccessor(ExitConditionBlock, BodyBlock);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003508 }
Mike Stump31feda52009-07-17 01:31:16 +00003509
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003510 // Link up the condition block with the code that follows the loop.
3511 // (the false branch).
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003512 addSuccessor(ExitConditionBlock, LoopSuccessor);
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003513
Ted Kremenek9d56e642008-11-11 17:10:00 +00003514 // Now create a prologue block to contain the collection expression.
Ted Kremenek5cf87ff2008-11-14 01:57:41 +00003515 Block = createBlock();
Ted Kremenek9d56e642008-11-11 17:10:00 +00003516 return addStmt(S->getCollection());
Mike Stump31feda52009-07-17 01:31:16 +00003517}
3518
Ted Kremenek5022f1d2012-03-06 23:40:47 +00003519CFGBlock *CFGBuilder::VisitObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S) {
3520 // Inline the body.
3521 return addStmt(S->getSubStmt());
3522 // TODO: consider adding cleanups for the end of @autoreleasepool scope.
3523}
3524
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003525CFGBlock *CFGBuilder::VisitObjCAtSynchronizedStmt(ObjCAtSynchronizedStmt *S) {
Ted Kremenek49805452009-05-02 01:49:13 +00003526 // FIXME: Add locking 'primitives' to CFG for @synchronized.
Mike Stump31feda52009-07-17 01:31:16 +00003527
Ted Kremenek49805452009-05-02 01:49:13 +00003528 // Inline the body.
Ted Kremenek93668002009-07-17 22:18:43 +00003529 CFGBlock *SyncBlock = addStmt(S->getSynchBody());
Mike Stump31feda52009-07-17 01:31:16 +00003530
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003531 // The sync body starts its own basic block. This makes it a little easier
3532 // for diagnostic clients.
3533 if (SyncBlock) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003534 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003535 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003536
Craig Topper25542942014-05-20 04:30:07 +00003537 Block = nullptr;
Ted Kremenekecc31c92010-05-13 16:38:08 +00003538 Succ = SyncBlock;
Ted Kremenekb3c657b2009-05-05 23:11:51 +00003539 }
Mike Stump31feda52009-07-17 01:31:16 +00003540
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003541 // Add the @synchronized to the CFG.
3542 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00003543 appendStmt(Block, S);
Ted Kremeneked12f1b2010-09-10 03:05:33 +00003544
Ted Kremenek49805452009-05-02 01:49:13 +00003545 // Inline the sync expression.
Ted Kremenek93668002009-07-17 22:18:43 +00003546 return addStmt(S->getSynchExpr());
Ted Kremenek49805452009-05-02 01:49:13 +00003547}
Mike Stump31feda52009-07-17 01:31:16 +00003548
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003549CFGBlock *CFGBuilder::VisitObjCAtTryStmt(ObjCAtTryStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003550 // FIXME
Ted Kremenek89be6522009-04-07 04:26:02 +00003551 return NYS();
Ted Kremenek89cc8ea2009-03-30 22:29:21 +00003552}
Ted Kremenek9d56e642008-11-11 17:10:00 +00003553
John McCallfe96e0b2011-11-06 09:01:30 +00003554CFGBlock *CFGBuilder::VisitPseudoObjectExpr(PseudoObjectExpr *E) {
3555 autoCreateBlock();
3556
3557 // Add the PseudoObject as the last thing.
3558 appendStmt(Block, E);
3559
Fangrui Song6907ce22018-07-30 19:24:48 +00003560 CFGBlock *lastBlock = Block;
John McCallfe96e0b2011-11-06 09:01:30 +00003561
3562 // Before that, evaluate all of the semantics in order. In
3563 // CFG-land, that means appending them in reverse order.
3564 for (unsigned i = E->getNumSemanticExprs(); i != 0; ) {
3565 Expr *Semantic = E->getSemanticExpr(--i);
3566
3567 // If the semantic is an opaque value, we're being asked to bind
3568 // it to its source expression.
3569 if (OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(Semantic))
3570 Semantic = OVE->getSourceExpr();
3571
3572 if (CFGBlock *B = Visit(Semantic))
3573 lastBlock = B;
3574 }
3575
3576 return lastBlock;
3577}
3578
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003579CFGBlock *CFGBuilder::VisitWhileStmt(WhileStmt *W) {
Craig Topper25542942014-05-20 04:30:07 +00003580 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003581
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003582 // Save local scope position because in case of condition variable ScopePos
3583 // won't be restored when traversing AST.
3584 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3585
3586 // Create local scope for possible condition variable.
3587 // Store scope position for continue statement.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003588 LocalScope::const_iterator LoopBeginScopePos = ScopePos;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003589 if (VarDecl *VD = W->getConditionVariable()) {
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003590 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00003591 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003592 }
Peter Szecsi999a25f2017-08-19 11:19:16 +00003593 addLoopExit(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003594
Mike Stump014b3ea2009-07-21 01:12:51 +00003595 // "while" is a control-flow statement. Thus we stop processing the current
3596 // block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003597 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003598 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003599 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003600 LoopSuccessor = Block;
Craig Topper25542942014-05-20 04:30:07 +00003601 Block = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003602 } else {
Ted Kremenek93668002009-07-17 22:18:43 +00003603 LoopSuccessor = Succ;
Ted Kremenek81e14852007-08-27 19:46:09 +00003604 }
Mike Stump31feda52009-07-17 01:31:16 +00003605
Craig Topper25542942014-05-20 04:30:07 +00003606 CFGBlock *BodyBlock = nullptr, *TransitionBlock = nullptr;
Mike Stump773582d2009-07-23 23:25:26 +00003607
Ted Kremenek9aae5132007-08-23 21:42:29 +00003608 // Process the loop body.
3609 {
Ted Kremenek49936f72009-04-28 03:09:44 +00003610 assert(W->getBody());
Ted Kremenek9aae5132007-08-23 21:42:29 +00003611
Ted Kremenekb50e7162012-07-14 05:04:10 +00003612 // Save the current values for Block, Succ, continue and break targets.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003613 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3614 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
Ted Kremenekb50e7162012-07-14 05:04:10 +00003615 save_break(BreakJumpTarget);
Ted Kremenek49936f72009-04-28 03:09:44 +00003616
Mike Stump31feda52009-07-17 01:31:16 +00003617 // Create an empty block to represent the transition block for looping back
3618 // to the head of the loop.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003619 Succ = TransitionBlock = createBlock(false);
3620 TransitionBlock->setLoopTarget(W);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003621 ContinueJumpTarget = JumpTarget(Succ, LoopBeginScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003622
Ted Kremenek9aae5132007-08-23 21:42:29 +00003623 // All breaks should go to the code following the loop.
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003624 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003625
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003626 // Loop body should end with destructor of Condition variable (if any).
Matthias Gehre351c2182017-07-12 07:04:19 +00003627 addAutomaticObjHandling(ScopePos, LoopBeginScopePos, W);
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003628
3629 // If body is not a compound statement create implicit scope
3630 // and add destructors.
3631 if (!isa<CompoundStmt>(W->getBody()))
3632 addLocalScopeAndDtors(W->getBody());
3633
Ted Kremenek9aae5132007-08-23 21:42:29 +00003634 // Create the body. The returned block is the entry to the loop body.
Ted Kremenekb50e7162012-07-14 05:04:10 +00003635 BodyBlock = addStmt(W->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003636
Ted Kremeneke9610502007-08-30 18:39:40 +00003637 if (!BodyBlock)
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003638 BodyBlock = ContinueJumpTarget.block; // can happen for "while(...) ;"
Ted Kremenekb50e7162012-07-14 05:04:10 +00003639 else if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003640 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003641 }
3642
3643 // Because of short-circuit evaluation, the condition of the loop can span
3644 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3645 // evaluate the condition.
Craig Topper25542942014-05-20 04:30:07 +00003646 CFGBlock *EntryConditionBlock = nullptr, *ExitConditionBlock = nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003647
3648 do {
3649 Expr *C = W->getCond();
3650
3651 // Specially handle logical operators, which have a slightly
3652 // more optimal CFG representation.
Richard Smithf676e452012-07-24 21:02:14 +00003653 if (BinaryOperator *Cond = dyn_cast<BinaryOperator>(C->IgnoreParens()))
Ted Kremenekb50e7162012-07-14 05:04:10 +00003654 if (Cond->isLogicalOp()) {
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00003655 std::tie(EntryConditionBlock, ExitConditionBlock) =
3656 VisitLogicalOperator(Cond, W, BodyBlock, LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003657 break;
3658 }
3659
3660 // The default case when not handling logical operators.
Ted Kremenek451c4d52012-10-12 22:56:26 +00003661 ExitConditionBlock = createBlock(false);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003662 ExitConditionBlock->setTerminator(W);
3663
3664 // Now add the actual condition to the condition block.
3665 // Because the condition itself may contain control-flow, new blocks may
3666 // be created. Thus we update "Succ" after adding the condition.
3667 Block = ExitConditionBlock;
3668 Block = EntryConditionBlock = addStmt(C);
3669
3670 // If this block contains a condition variable, add both the condition
3671 // variable and initializer to the CFG.
3672 if (VarDecl *VD = W->getConditionVariable()) {
3673 if (Expr *Init = VD->getInit()) {
3674 autoCreateBlock();
Artem Dergachevab9b78b2018-04-19 23:30:15 +00003675 const DeclStmt *DS = W->getConditionVariableDeclStmt();
3676 assert(DS->isSingleDecl());
3677 findConstructionContexts(
3678 ConstructionContextLayer::create(cfg->getBumpVectorContext(),
3679 const_cast<DeclStmt *>(DS)),
3680 Init);
3681 appendStmt(Block, DS);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003682 EntryConditionBlock = addStmt(Init);
3683 assert(Block == EntryConditionBlock);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00003684 maybeAddScopeBeginForVarDecl(EntryConditionBlock, VD, C);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003685 }
Ted Kremenek55957a82009-05-02 00:13:27 +00003686 }
Mike Stump31feda52009-07-17 01:31:16 +00003687
Ted Kremenekb50e7162012-07-14 05:04:10 +00003688 if (Block && badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003689 return nullptr;
Ted Kremenekb50e7162012-07-14 05:04:10 +00003690
3691 // See if this is a known constant.
3692 const TryResult& KnownVal = tryEvaluateBool(C);
3693
Ted Kremenek30754282009-07-24 04:47:11 +00003694 // Add the loop body entry as a successor to the condition.
Craig Topper25542942014-05-20 04:30:07 +00003695 addSuccessor(ExitConditionBlock, KnownVal.isFalse() ? nullptr : BodyBlock);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003696 // Link up the condition block with the code that follows the loop. (the
3697 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00003698 addSuccessor(ExitConditionBlock,
3699 KnownVal.isTrue() ? nullptr : LoopSuccessor);
Ted Kremenekb50e7162012-07-14 05:04:10 +00003700 } while(false);
3701
3702 // Link up the loop-back block to the entry condition block.
3703 addSuccessor(TransitionBlock, EntryConditionBlock);
Mike Stump31feda52009-07-17 01:31:16 +00003704
3705 // There can be no more statements in the condition block since we loop back
3706 // to this block. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003707 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003708
Ted Kremenek1ce53c42009-12-24 01:34:10 +00003709 // Return the condition block, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003710 Succ = EntryConditionBlock;
Ted Kremenek81e14852007-08-27 19:46:09 +00003711 return EntryConditionBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003712}
Mike Stump11289f42009-09-09 15:08:12 +00003713
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003714CFGBlock *CFGBuilder::VisitObjCAtCatchStmt(ObjCAtCatchStmt *S) {
Ted Kremenek93668002009-07-17 22:18:43 +00003715 // FIXME: For now we pretend that @catch and the code it contains does not
3716 // exit.
3717 return Block;
3718}
Mike Stump31feda52009-07-17 01:31:16 +00003719
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003720CFGBlock *CFGBuilder::VisitObjCAtThrowStmt(ObjCAtThrowStmt *S) {
Ted Kremenek93041ba2008-12-09 20:20:09 +00003721 // FIXME: This isn't complete. We basically treat @throw like a return
3722 // statement.
Mike Stump31feda52009-07-17 01:31:16 +00003723
Ted Kremenek0868eea2009-09-24 18:45:41 +00003724 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003725 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003726 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003727
Ted Kremenek93041ba2008-12-09 20:20:09 +00003728 // Create the new block.
3729 Block = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003730
Ted Kremenek93041ba2008-12-09 20:20:09 +00003731 // The Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003732 addSuccessor(Block, &cfg->getExit());
Mike Stump31feda52009-07-17 01:31:16 +00003733
3734 // Add the statement to the block. This may create new blocks if S contains
3735 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003736 return VisitStmt(S, AddStmtChoice::AlwaysAdd);
Ted Kremenek93041ba2008-12-09 20:20:09 +00003737}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003738
Artem Dergachevbd880fe2018-07-31 19:39:37 +00003739CFGBlock *CFGBuilder::VisitObjCMessageExpr(ObjCMessageExpr *ME,
3740 AddStmtChoice asc) {
3741 findConstructionContextsForArguments(ME);
3742
3743 autoCreateBlock();
Artem Dergacheve1f30622018-07-31 19:46:14 +00003744 appendObjCMessage(Block, ME);
Artem Dergachevbd880fe2018-07-31 19:39:37 +00003745
3746 return VisitChildren(ME);
3747}
3748
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003749CFGBlock *CFGBuilder::VisitCXXThrowExpr(CXXThrowExpr *T) {
Ted Kremenek0868eea2009-09-24 18:45:41 +00003750 // If we were in the middle of a block we stop processing that block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003751 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003752 return nullptr;
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003753
3754 // Create the new block.
3755 Block = createBlock(false);
3756
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003757 if (TryTerminatedBlock)
3758 // The current try statement is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003759 addSuccessor(Block, TryTerminatedBlock);
Ted Kremenekdc03bd02010-08-02 23:46:59 +00003760 else
Mike Stumpbbf5ba62010-01-19 02:20:09 +00003761 // otherwise the Exit block is the only successor.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003762 addSuccessor(Block, &cfg->getExit());
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003763
3764 // Add the statement to the block. This may create new blocks if S contains
3765 // control-flow (short-circuit operations).
Ted Kremenek4cad5fc2009-12-16 03:18:58 +00003766 return VisitStmt(T, AddStmtChoice::AlwaysAdd);
Mike Stump8dd1b6b2009-07-22 22:56:04 +00003767}
3768
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003769CFGBlock *CFGBuilder::VisitDoStmt(DoStmt *D) {
Craig Topper25542942014-05-20 04:30:07 +00003770 CFGBlock *LoopSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003771
Peter Szecsi999a25f2017-08-19 11:19:16 +00003772 addLoopExit(D);
3773
Mike Stump8d50b6a2009-07-21 01:27:50 +00003774 // "do...while" is a control-flow statement. Thus we stop processing the
3775 // current block.
Ted Kremenek9aae5132007-08-23 21:42:29 +00003776 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003777 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003778 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003779 LoopSuccessor = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00003780 } else
3781 LoopSuccessor = Succ;
Mike Stump31feda52009-07-17 01:31:16 +00003782
3783 // Because of short-circuit evaluation, the condition of the loop can span
3784 // multiple basic blocks. Thus we need the "Entry" and "Exit" blocks that
3785 // evaluate the condition.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003786 CFGBlock *ExitConditionBlock = createBlock(false);
3787 CFGBlock *EntryConditionBlock = ExitConditionBlock;
Mike Stump31feda52009-07-17 01:31:16 +00003788
Ted Kremenek81e14852007-08-27 19:46:09 +00003789 // Set the terminator for the "exit" condition block.
Mike Stump31feda52009-07-17 01:31:16 +00003790 ExitConditionBlock->setTerminator(D);
3791
3792 // Now add the actual condition to the condition block. Because the condition
3793 // itself may contain control-flow, new blocks may be created.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003794 if (Stmt *C = D->getCond()) {
Ted Kremenek81e14852007-08-27 19:46:09 +00003795 Block = ExitConditionBlock;
3796 EntryConditionBlock = addStmt(C);
Ted Kremenek55957a82009-05-02 00:13:27 +00003797 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003798 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003799 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003800 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003801 }
Mike Stump31feda52009-07-17 01:31:16 +00003802
Ted Kremeneka1523a32008-02-27 07:20:00 +00003803 // The condition block is the implicit successor for the loop body.
Ted Kremenek81e14852007-08-27 19:46:09 +00003804 Succ = EntryConditionBlock;
3805
Mike Stump773582d2009-07-23 23:25:26 +00003806 // See if this is a known constant.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003807 const TryResult &KnownVal = tryEvaluateBool(D->getCond());
Mike Stump773582d2009-07-23 23:25:26 +00003808
Ted Kremenek9aae5132007-08-23 21:42:29 +00003809 // Process the loop body.
Craig Topper25542942014-05-20 04:30:07 +00003810 CFGBlock *BodyBlock = nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003811 {
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003812 assert(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003813
Ted Kremenek9aae5132007-08-23 21:42:29 +00003814 // Save the current values for Block, Succ, and continue and break targets
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003815 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
3816 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget),
3817 save_break(BreakJumpTarget);
Mike Stump31feda52009-07-17 01:31:16 +00003818
Ted Kremenek9aae5132007-08-23 21:42:29 +00003819 // All continues within this loop should go to the condition block
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003820 ContinueJumpTarget = JumpTarget(EntryConditionBlock, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003821
Ted Kremenek9aae5132007-08-23 21:42:29 +00003822 // All breaks should go to the code following the loop.
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003823 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003824
Ted Kremenek9aae5132007-08-23 21:42:29 +00003825 // NULL out Block to force lazy instantiation of blocks for the body.
Craig Topper25542942014-05-20 04:30:07 +00003826 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003827
Marcin Swiderski1f4e15c2010-10-01 01:14:17 +00003828 // If body is not a compound statement create implicit scope
3829 // and add destructors.
3830 if (!isa<CompoundStmt>(D->getBody()))
3831 addLocalScopeAndDtors(D->getBody());
3832
Ted Kremenek9aae5132007-08-23 21:42:29 +00003833 // Create the body. The returned block is the entry to the loop body.
Ted Kremenek93668002009-07-17 22:18:43 +00003834 BodyBlock = addStmt(D->getBody());
Mike Stump31feda52009-07-17 01:31:16 +00003835
Ted Kremeneke9610502007-08-30 18:39:40 +00003836 if (!BodyBlock)
Ted Kremenek39321aa2008-02-27 00:28:17 +00003837 BodyBlock = EntryConditionBlock; // can happen for "do ; while(...)"
Ted Kremenek55957a82009-05-02 00:13:27 +00003838 else if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003839 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003840 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003841 }
Mike Stump31feda52009-07-17 01:31:16 +00003842
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003843 // Add an intermediate block between the BodyBlock and the
3844 // ExitConditionBlock to represent the "loop back" transition. Create an
3845 // empty block to represent the transition block for looping back to the
3846 // head of the loop.
3847 // FIXME: Can we do this more efficiently without adding another block?
3848 Block = nullptr;
3849 Succ = BodyBlock;
3850 CFGBlock *LoopBackBlock = createBlock();
3851 LoopBackBlock->setLoopTarget(D);
Mike Stump31feda52009-07-17 01:31:16 +00003852
Daniel Marjamaki042a3c52016-10-03 08:28:51 +00003853 if (!KnownVal.isFalse())
Ted Kremenek110974d2010-08-17 20:59:56 +00003854 // Add the loop body entry as a successor to the condition.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00003855 addSuccessor(ExitConditionBlock, LoopBackBlock);
Ted Kremenek110974d2010-08-17 20:59:56 +00003856 else
Craig Topper25542942014-05-20 04:30:07 +00003857 addSuccessor(ExitConditionBlock, nullptr);
Ted Kremenek9aae5132007-08-23 21:42:29 +00003858 }
Mike Stump31feda52009-07-17 01:31:16 +00003859
Ted Kremenek30754282009-07-24 04:47:11 +00003860 // Link up the condition block with the code that follows the loop.
3861 // (the false branch).
Craig Topper25542942014-05-20 04:30:07 +00003862 addSuccessor(ExitConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00003863
3864 // There can be no more statements in the body block(s) since we loop back to
3865 // the body. NULL out Block to force lazy creation of another block.
Craig Topper25542942014-05-20 04:30:07 +00003866 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003867
Ted Kremenek9aae5132007-08-23 21:42:29 +00003868 // Return the loop body, which is the dominating block for the loop.
Ted Kremeneka1523a32008-02-27 07:20:00 +00003869 Succ = BodyBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003870 return BodyBlock;
3871}
3872
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003873CFGBlock *CFGBuilder::VisitContinueStmt(ContinueStmt *C) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00003874 // "continue" is a control-flow statement. Thus we stop processing the
3875 // current block.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003876 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003877 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003878
Ted Kremenek9aae5132007-08-23 21:42:29 +00003879 // Now create a new block that ends with the continue statement.
3880 Block = createBlock(false);
3881 Block->setTerminator(C);
Mike Stump31feda52009-07-17 01:31:16 +00003882
Ted Kremenek9aae5132007-08-23 21:42:29 +00003883 // If there is no target for the continue, then we are looking at an
Ted Kremenek882cf062009-04-07 18:53:24 +00003884 // incomplete AST. This means the CFG cannot be constructed.
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003885 if (ContinueJumpTarget.block) {
Matthias Gehre351c2182017-07-12 07:04:19 +00003886 addAutomaticObjHandling(ScopePos, ContinueJumpTarget.scopePosition, C);
Ted Kremenekef81e9e2011-01-07 19:37:16 +00003887 addSuccessor(Block, ContinueJumpTarget.block);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003888 } else
Ted Kremenek882cf062009-04-07 18:53:24 +00003889 badCFG = true;
Mike Stump31feda52009-07-17 01:31:16 +00003890
Ted Kremenek9aae5132007-08-23 21:42:29 +00003891 return Block;
3892}
Mike Stump11289f42009-09-09 15:08:12 +00003893
Peter Collingbournee190dee2011-03-11 19:24:49 +00003894CFGBlock *CFGBuilder::VisitUnaryExprOrTypeTraitExpr(UnaryExprOrTypeTraitExpr *E,
3895 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003896 if (asc.alwaysAdd(*this, E)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003897 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003898 appendStmt(Block, E);
Ted Kremenek0747de62009-07-18 00:47:21 +00003899 }
Mike Stump11289f42009-09-09 15:08:12 +00003900
Ted Kremenek93668002009-07-17 22:18:43 +00003901 // VLA types have expressions that must be evaluated.
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003902 CFGBlock *lastBlock = Block;
Fangrui Song6907ce22018-07-30 19:24:48 +00003903
Ted Kremenek93668002009-07-17 22:18:43 +00003904 if (E->isArgumentType()) {
John McCall424cec92011-01-19 06:33:43 +00003905 for (const VariableArrayType *VA =FindVA(E->getArgumentType().getTypePtr());
Craig Topper25542942014-05-20 04:30:07 +00003906 VA != nullptr; VA = FindVA(VA->getElementType().getTypePtr()))
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003907 lastBlock = addStmt(VA->getSizeExpr());
Ted Kremenek84a1ca52011-08-06 00:30:00 +00003908 }
Ted Kremenek9eb0b7d2011-04-14 01:50:50 +00003909 return lastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003910}
Mike Stump11289f42009-09-09 15:08:12 +00003911
Ted Kremenek93668002009-07-17 22:18:43 +00003912/// VisitStmtExpr - Utility method to handle (nested) statement
3913/// expressions (a GCC extension).
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003914CFGBlock *CFGBuilder::VisitStmtExpr(StmtExpr *SE, AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00003915 if (asc.alwaysAdd(*this, SE)) {
Ted Kremenek0747de62009-07-18 00:47:21 +00003916 autoCreateBlock();
Ted Kremenek8219b822010-12-16 07:46:53 +00003917 appendStmt(Block, SE);
Ted Kremenek0747de62009-07-18 00:47:21 +00003918 }
Artem Dergachevead98ea2019-08-28 18:44:42 +00003919 return VisitCompoundStmt(SE->getSubStmt(), /*ExternallyDestructed=*/true);
Ted Kremenek93668002009-07-17 22:18:43 +00003920}
Ted Kremenek9aae5132007-08-23 21:42:29 +00003921
Ted Kremenek5ef32db2011-08-12 23:37:29 +00003922CFGBlock *CFGBuilder::VisitSwitchStmt(SwitchStmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00003923 // "switch" is a control-flow statement. Thus we stop processing the current
3924 // block.
Craig Topper25542942014-05-20 04:30:07 +00003925 CFGBlock *SwitchSuccessor = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00003926
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003927 // Save local scope position because in case of condition variable ScopePos
3928 // won't be restored when traversing AST.
3929 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
3930
Richard Smitha547eb22016-07-14 00:11:03 +00003931 // Create local scope for C++17 switch init-stmt if one exists.
Richard Smith509bbd12017-01-13 22:16:41 +00003932 if (Stmt *Init = Terminator->getInit())
Richard Smitha547eb22016-07-14 00:11:03 +00003933 addLocalScopeForStmt(Init);
Richard Smitha547eb22016-07-14 00:11:03 +00003934
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003935 // Create local scope for possible condition variable.
3936 // Store scope position. Add implicit destructor.
Richard Smith509bbd12017-01-13 22:16:41 +00003937 if (VarDecl *VD = Terminator->getConditionVariable())
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003938 addLocalScopeForVarDecl(VD);
Richard Smith509bbd12017-01-13 22:16:41 +00003939
Matthias Gehre351c2182017-07-12 07:04:19 +00003940 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), Terminator);
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003941
Ted Kremenek9aae5132007-08-23 21:42:29 +00003942 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003943 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003944 return nullptr;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003945 SwitchSuccessor = Block;
Mike Stump31feda52009-07-17 01:31:16 +00003946 } else SwitchSuccessor = Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00003947
3948 // Save the current "switch" context.
3949 SaveAndRestore<CFGBlock*> save_switch(SwitchTerminatedBlock),
Ted Kremenek654c78f2008-02-13 22:05:39 +00003950 save_default(DefaultCaseBlock);
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003951 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
Ted Kremenek654c78f2008-02-13 22:05:39 +00003952
Mike Stump31feda52009-07-17 01:31:16 +00003953 // Set the "default" case to be the block after the switch statement. If the
3954 // switch statement contains a "default:", this value will be overwritten with
3955 // the block for that code.
Ted Kremenek654c78f2008-02-13 22:05:39 +00003956 DefaultCaseBlock = SwitchSuccessor;
Mike Stump31feda52009-07-17 01:31:16 +00003957
Ted Kremenek9aae5132007-08-23 21:42:29 +00003958 // Create a new block that will contain the switch statement.
3959 SwitchTerminatedBlock = createBlock(false);
Mike Stump31feda52009-07-17 01:31:16 +00003960
Ted Kremenek9aae5132007-08-23 21:42:29 +00003961 // Now process the switch body. The code after the switch is the implicit
3962 // successor.
3963 Succ = SwitchSuccessor;
Marcin Swiderski8b99b8a2010-09-25 11:05:21 +00003964 BreakJumpTarget = JumpTarget(SwitchSuccessor, ScopePos);
Mike Stump31feda52009-07-17 01:31:16 +00003965
3966 // When visiting the body, the case statements should automatically get linked
3967 // up to the switch. We also don't keep a pointer to the body, since all
3968 // control-flow from the switch goes to case/default statements.
Ted Kremenek1362b8b2010-01-19 20:46:35 +00003969 assert(Terminator->getBody() && "switch must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00003970 Block = nullptr;
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003971
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003972 // For pruning unreachable case statements, save the current state
3973 // for tracking the condition value.
3974 SaveAndRestore<bool> save_switchExclusivelyCovered(switchExclusivelyCovered,
3975 false);
Ted Kremenekbe528712011-03-04 01:03:41 +00003976
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00003977 // Determine if the switch condition can be explicitly evaluated.
3978 assert(Terminator->getCond() && "switch condition must be non-NULL");
Ted Kremenekbe528712011-03-04 01:03:41 +00003979 Expr::EvalResult result;
Ted Kremenek53e65382011-03-13 03:48:04 +00003980 bool b = tryEvaluate(Terminator->getCond(), result);
3981 SaveAndRestore<Expr::EvalResult*> save_switchCond(switchCond,
Craig Topper25542942014-05-20 04:30:07 +00003982 b ? &result : nullptr);
Ted Kremenekbe528712011-03-04 01:03:41 +00003983
Marcin Swiderskie407a3b2010-10-01 01:24:41 +00003984 // If body is not a compound statement create implicit scope
3985 // and add destructors.
3986 if (!isa<CompoundStmt>(Terminator->getBody()))
3987 addLocalScopeAndDtors(Terminator->getBody());
3988
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003989 addStmt(Terminator->getBody());
Ted Kremenek55957a82009-05-02 00:13:27 +00003990 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00003991 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00003992 return nullptr;
Ted Kremenek55957a82009-05-02 00:13:27 +00003993 }
Ted Kremenek81e14852007-08-27 19:46:09 +00003994
Mike Stump31feda52009-07-17 01:31:16 +00003995 // If we have no "default:" case, the default transition is to the code
Ted Kremenek35c70f62011-03-16 04:32:01 +00003996 // following the switch body. Moreover, take into account if all the
3997 // cases of a switch are covered (e.g., switching on an enum value).
David Majnemerf69ce862013-06-04 17:38:44 +00003998 //
3999 // Note: We add a successor to a switch that is considered covered yet has no
4000 // case statements if the enumeration has no enumerators.
4001 bool SwitchAlwaysHasSuccessor = false;
4002 SwitchAlwaysHasSuccessor |= switchExclusivelyCovered;
4003 SwitchAlwaysHasSuccessor |= Terminator->isAllEnumCasesCovered() &&
4004 Terminator->getSwitchCaseList();
Ted Kremenek9238c5c2014-02-27 21:56:44 +00004005 addSuccessor(SwitchTerminatedBlock, DefaultCaseBlock,
4006 !SwitchAlwaysHasSuccessor);
Mike Stump31feda52009-07-17 01:31:16 +00004007
Ted Kremenek81e14852007-08-27 19:46:09 +00004008 // Add the terminator and condition in the switch block.
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004009 SwitchTerminatedBlock->setTerminator(Terminator);
Ted Kremenek9aae5132007-08-23 21:42:29 +00004010 Block = SwitchTerminatedBlock;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004011 CFGBlock *LastBlock = addStmt(Terminator->getCond());
Ted Kremenekdc03bd02010-08-02 23:46:59 +00004012
Richard Smitha547eb22016-07-14 00:11:03 +00004013 // If the SwitchStmt contains a condition variable, add both the
Ted Kremenek8b5dc122009-12-24 00:39:26 +00004014 // SwitchStmt and the condition variable initialization to the CFG.
4015 if (VarDecl *VD = Terminator->getConditionVariable()) {
4016 if (Expr *Init = VD->getInit()) {
4017 autoCreateBlock();
Ted Kremenek37881932011-04-04 23:29:12 +00004018 appendStmt(Block, Terminator->getConditionVariableDeclStmt());
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004019 LastBlock = addStmt(Init);
Maxim Ostapenkodebca452018-03-12 12:26:15 +00004020 maybeAddScopeBeginForVarDecl(LastBlock, VD, Init);
Ted Kremenek8b5dc122009-12-24 00:39:26 +00004021 }
4022 }
Ted Kremenekdc03bd02010-08-02 23:46:59 +00004023
Richard Smitha547eb22016-07-14 00:11:03 +00004024 // Finally, if the SwitchStmt contains a C++17 init-stmt, add it to the CFG.
4025 if (Stmt *Init = Terminator->getInit()) {
4026 autoCreateBlock();
4027 LastBlock = addStmt(Init);
4028 }
4029
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004030 return LastBlock;
Ted Kremenek9aae5132007-08-23 21:42:29 +00004031}
Fangrui Song6907ce22018-07-30 19:24:48 +00004032
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004033static bool shouldAddCase(bool &switchExclusivelyCovered,
Ted Kremenek53e65382011-03-13 03:48:04 +00004034 const Expr::EvalResult *switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004035 const CaseStmt *CS,
4036 ASTContext &Ctx) {
Ted Kremenek53e65382011-03-13 03:48:04 +00004037 if (!switchCond)
4038 return true;
4039
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004040 bool addCase = false;
Ted Kremenekbe528712011-03-04 01:03:41 +00004041
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004042 if (!switchExclusivelyCovered) {
Ted Kremenek53e65382011-03-13 03:48:04 +00004043 if (switchCond->Val.isInt()) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004044 // Evaluate the LHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00004045 const llvm::APSInt &lhsInt = CS->getLHS()->EvaluateKnownConstInt(Ctx);
Ted Kremenek53e65382011-03-13 03:48:04 +00004046 const llvm::APSInt &condInt = switchCond->Val.getInt();
Fangrui Song6907ce22018-07-30 19:24:48 +00004047
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004048 if (condInt == lhsInt) {
4049 addCase = true;
4050 switchExclusivelyCovered = true;
4051 }
Devin Coughlineb538ab2015-09-22 20:31:19 +00004052 else if (condInt > lhsInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004053 if (const Expr *RHS = CS->getRHS()) {
4054 // Evaluate the RHS of the case value.
Richard Smithfaa32a92011-10-14 20:22:00 +00004055 const llvm::APSInt &V2 = RHS->EvaluateKnownConstInt(Ctx);
Devin Coughlineb538ab2015-09-22 20:31:19 +00004056 if (V2 >= condInt) {
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004057 addCase = true;
4058 switchExclusivelyCovered = true;
4059 }
4060 }
4061 }
4062 }
4063 else
4064 addCase = true;
4065 }
Fangrui Song6907ce22018-07-30 19:24:48 +00004066 return addCase;
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004067}
Ted Kremenek9aae5132007-08-23 21:42:29 +00004068
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004069CFGBlock *CFGBuilder::VisitCaseStmt(CaseStmt *CS) {
Mike Stump31feda52009-07-17 01:31:16 +00004070 // CaseStmts are essentially labels, so they are the first statement in a
4071 // block.
Craig Topper25542942014-05-20 04:30:07 +00004072 CFGBlock *TopBlock = nullptr, *LastBlock = nullptr;
Ted Kremenekbe528712011-03-04 01:03:41 +00004073
Ted Kremenek60fa6572010-08-04 23:54:30 +00004074 if (Stmt *Sub = CS->getSubStmt()) {
4075 // For deeply nested chains of CaseStmts, instead of doing a recursion
4076 // (which can blow out the stack), manually unroll and create blocks
4077 // along the way.
4078 while (isa<CaseStmt>(Sub)) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004079 CFGBlock *currentBlock = createBlock(false);
4080 currentBlock->setLabel(CS);
Ted Kremenek55e91e82007-08-30 18:48:11 +00004081
Ted Kremenek60fa6572010-08-04 23:54:30 +00004082 if (TopBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004083 addSuccessor(LastBlock, currentBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00004084 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004085 TopBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00004086
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004087 addSuccessor(SwitchTerminatedBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00004088 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004089 CS, *Context)
Craig Topper25542942014-05-20 04:30:07 +00004090 ? currentBlock : nullptr);
Ted Kremenek60fa6572010-08-04 23:54:30 +00004091
Ted Kremenekeff9a7f2011-03-01 23:12:55 +00004092 LastBlock = currentBlock;
Ted Kremenek60fa6572010-08-04 23:54:30 +00004093 CS = cast<CaseStmt>(Sub);
4094 Sub = CS->getSubStmt();
4095 }
4096
4097 addStmt(Sub);
4098 }
Mike Stump11289f42009-09-09 15:08:12 +00004099
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004100 CFGBlock *CaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00004101 if (!CaseBlock)
4102 CaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00004103
4104 // Cases statements partition blocks, so this is the top of the basic block we
4105 // were processing (the "case XXX:" is the label).
Ted Kremenek93668002009-07-17 22:18:43 +00004106 CaseBlock->setLabel(CS);
4107
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004108 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004109 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004110
4111 // Add this block to the list of successors for the block with the switch
4112 // statement.
Ted Kremenek93668002009-07-17 22:18:43 +00004113 assert(SwitchTerminatedBlock);
Ted Kremenek9238c5c2014-02-27 21:56:44 +00004114 addSuccessor(SwitchTerminatedBlock, CaseBlock,
Ted Kremenek53e65382011-03-13 03:48:04 +00004115 shouldAddCase(switchExclusivelyCovered, switchCond,
Ted Kremenek9238c5c2014-02-27 21:56:44 +00004116 CS, *Context));
Mike Stump31feda52009-07-17 01:31:16 +00004117
Ted Kremenek9aae5132007-08-23 21:42:29 +00004118 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00004119 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004120
Ted Kremenek60fa6572010-08-04 23:54:30 +00004121 if (TopBlock) {
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004122 addSuccessor(LastBlock, CaseBlock);
Ted Kremenek60fa6572010-08-04 23:54:30 +00004123 Succ = TopBlock;
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004124 } else {
Ted Kremenek60fa6572010-08-04 23:54:30 +00004125 // This block is now the implicit successor of other blocks.
4126 Succ = CaseBlock;
4127 }
Mike Stump31feda52009-07-17 01:31:16 +00004128
Ted Kremenek60fa6572010-08-04 23:54:30 +00004129 return Succ;
Ted Kremenek9aae5132007-08-23 21:42:29 +00004130}
Mike Stump31feda52009-07-17 01:31:16 +00004131
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004132CFGBlock *CFGBuilder::VisitDefaultStmt(DefaultStmt *Terminator) {
Ted Kremenek93668002009-07-17 22:18:43 +00004133 if (Terminator->getSubStmt())
4134 addStmt(Terminator->getSubStmt());
Mike Stump11289f42009-09-09 15:08:12 +00004135
Ted Kremenek654c78f2008-02-13 22:05:39 +00004136 DefaultCaseBlock = Block;
Ted Kremenek93668002009-07-17 22:18:43 +00004137
4138 if (!DefaultCaseBlock)
4139 DefaultCaseBlock = createBlock();
Mike Stump31feda52009-07-17 01:31:16 +00004140
4141 // Default statements partition blocks, so this is the top of the basic block
4142 // we were processing (the "default:" is the label).
Ted Kremenekc1f9a282008-04-16 21:10:48 +00004143 DefaultCaseBlock->setLabel(Terminator);
Mike Stump11289f42009-09-09 15:08:12 +00004144
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004145 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004146 return nullptr;
Ted Kremenek654c78f2008-02-13 22:05:39 +00004147
Mike Stump31feda52009-07-17 01:31:16 +00004148 // Unlike case statements, we don't add the default block to the successors
4149 // for the switch statement immediately. This is done when we finish
4150 // processing the switch statement. This allows for the default case
4151 // (including a fall-through to the code after the switch statement) to always
4152 // be the last successor of a switch-terminated block.
4153
Ted Kremenek654c78f2008-02-13 22:05:39 +00004154 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00004155 Block = nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00004156
Ted Kremenek654c78f2008-02-13 22:05:39 +00004157 // This block is now the implicit successor of other blocks.
4158 Succ = DefaultCaseBlock;
Mike Stump31feda52009-07-17 01:31:16 +00004159
4160 return DefaultCaseBlock;
Ted Kremenek9682be12008-02-13 21:46:34 +00004161}
Ted Kremenek9aae5132007-08-23 21:42:29 +00004162
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004163CFGBlock *CFGBuilder::VisitCXXTryStmt(CXXTryStmt *Terminator) {
4164 // "try"/"catch" is a control-flow statement. Thus we stop processing the
4165 // current block.
Craig Topper25542942014-05-20 04:30:07 +00004166 CFGBlock *TrySuccessor = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004167
4168 if (Block) {
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004169 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004170 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004171 TrySuccessor = Block;
4172 } else TrySuccessor = Succ;
4173
Mike Stump0bdba6c2010-01-20 01:15:34 +00004174 CFGBlock *PrevTryTerminatedBlock = TryTerminatedBlock;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004175
4176 // Create a new block that will contain the try statement.
Mike Stump845384a2010-01-20 01:30:58 +00004177 CFGBlock *NewTryTerminatedBlock = createBlock(false);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004178 // Add the terminator in the try block.
Mike Stump845384a2010-01-20 01:30:58 +00004179 NewTryTerminatedBlock->setTerminator(Terminator);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004180
Mike Stump0bdba6c2010-01-20 01:15:34 +00004181 bool HasCatchAll = false;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004182 for (unsigned h = 0; h <Terminator->getNumHandlers(); ++h) {
4183 // The code after the try is the implicit successor.
4184 Succ = TrySuccessor;
4185 CXXCatchStmt *CS = Terminator->getHandler(h);
Craig Topper25542942014-05-20 04:30:07 +00004186 if (CS->getExceptionDecl() == nullptr) {
Mike Stump0bdba6c2010-01-20 01:15:34 +00004187 HasCatchAll = true;
4188 }
Craig Topper25542942014-05-20 04:30:07 +00004189 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004190 CFGBlock *CatchBlock = VisitCXXCatchStmt(CS);
Craig Topper25542942014-05-20 04:30:07 +00004191 if (!CatchBlock)
4192 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004193 // Add this block to the list of successors for the block with the try
4194 // statement.
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004195 addSuccessor(NewTryTerminatedBlock, CatchBlock);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004196 }
Mike Stump0bdba6c2010-01-20 01:15:34 +00004197 if (!HasCatchAll) {
4198 if (PrevTryTerminatedBlock)
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004199 addSuccessor(NewTryTerminatedBlock, PrevTryTerminatedBlock);
Mike Stump0bdba6c2010-01-20 01:15:34 +00004200 else
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004201 addSuccessor(NewTryTerminatedBlock, &cfg->getExit());
Mike Stump0bdba6c2010-01-20 01:15:34 +00004202 }
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004203
4204 // The code after the try is the implicit successor.
4205 Succ = TrySuccessor;
4206
Mike Stump845384a2010-01-20 01:30:58 +00004207 // Save the current "try" context.
Ted Kremenek6b9964d2011-08-23 23:05:07 +00004208 SaveAndRestore<CFGBlock*> save_try(TryTerminatedBlock, NewTryTerminatedBlock);
4209 cfg->addTryDispatchBlock(TryTerminatedBlock);
Mike Stump845384a2010-01-20 01:30:58 +00004210
Ted Kremenek1362b8b2010-01-19 20:46:35 +00004211 assert(Terminator->getTryBlock() && "try must contain a non-NULL body");
Craig Topper25542942014-05-20 04:30:07 +00004212 Block = nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004213 return addStmt(Terminator->getTryBlock());
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004214}
4215
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004216CFGBlock *CFGBuilder::VisitCXXCatchStmt(CXXCatchStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004217 // CXXCatchStmt are treated like labels, so they are the first statement in a
4218 // block.
4219
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004220 // Save local scope position because in case of exception variable ScopePos
4221 // won't be restored when traversing AST.
4222 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
4223
4224 // Create local scope for possible exception variable.
4225 // Store scope position. Add implicit destructor.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004226 if (VarDecl *VD = CS->getExceptionDecl()) {
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004227 LocalScope::const_iterator BeginScopePos = ScopePos;
4228 addLocalScopeForVarDecl(VD);
Matthias Gehre351c2182017-07-12 07:04:19 +00004229 addAutomaticObjHandling(ScopePos, BeginScopePos, CS);
Marcin Swiderski3546b1a2010-10-01 01:46:52 +00004230 }
4231
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004232 if (CS->getHandlerBlock())
4233 addStmt(CS->getHandlerBlock());
4234
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004235 CFGBlock *CatchBlock = Block;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004236 if (!CatchBlock)
4237 CatchBlock = createBlock();
Fangrui Song6907ce22018-07-30 19:24:48 +00004238
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004239 // CXXCatchStmt is more than just a label. They have semantic meaning
4240 // as well, as they implicitly "initialize" the catch variable. Add
4241 // it to the CFG as a CFGElement so that the control-flow of these
4242 // semantics gets captured.
4243 appendStmt(CatchBlock, CS);
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004244
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004245 // Also add the CXXCatchStmt as a label, to mirror handling of regular
4246 // labels.
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004247 CatchBlock->setLabel(CS);
4248
Ted Kremenek8fdb59f2012-03-10 01:34:17 +00004249 // Bail out if the CFG is bad.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004250 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004251 return nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004252
4253 // We set Block to NULL to allow lazy creation of a new block (if necessary)
Craig Topper25542942014-05-20 04:30:07 +00004254 Block = nullptr;
Mike Stumpbbf5ba62010-01-19 02:20:09 +00004255
4256 return CatchBlock;
4257}
4258
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004259CFGBlock *CFGBuilder::VisitCXXForRangeStmt(CXXForRangeStmt *S) {
Richard Smith02e85f32011-04-14 22:09:26 +00004260 // C++0x for-range statements are specified as [stmt.ranged]:
4261 //
4262 // {
4263 // auto && __range = range-init;
4264 // for ( auto __begin = begin-expr,
4265 // __end = end-expr;
4266 // __begin != __end;
4267 // ++__begin ) {
4268 // for-range-declaration = *__begin;
4269 // statement
4270 // }
4271 // }
4272
4273 // Save local scope position before the addition of the implicit variables.
4274 SaveAndRestore<LocalScope::const_iterator> save_scope_pos(ScopePos);
4275
4276 // Create local scopes and destructors for range, begin and end variables.
4277 if (Stmt *Range = S->getRangeStmt())
4278 addLocalScopeForStmt(Range);
Richard Smith01694c32016-03-20 10:33:40 +00004279 if (Stmt *Begin = S->getBeginStmt())
4280 addLocalScopeForStmt(Begin);
4281 if (Stmt *End = S->getEndStmt())
4282 addLocalScopeForStmt(End);
Matthias Gehre351c2182017-07-12 07:04:19 +00004283 addAutomaticObjHandling(ScopePos, save_scope_pos.get(), S);
Richard Smith02e85f32011-04-14 22:09:26 +00004284
4285 LocalScope::const_iterator ContinueScopePos = ScopePos;
4286
4287 // "for" is a control-flow statement. Thus we stop processing the current
4288 // block.
Craig Topper25542942014-05-20 04:30:07 +00004289 CFGBlock *LoopSuccessor = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004290 if (Block) {
4291 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004292 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004293 LoopSuccessor = Block;
4294 } else
4295 LoopSuccessor = Succ;
4296
4297 // Save the current value for the break targets.
4298 // All breaks should go to the code following the loop.
4299 SaveAndRestore<JumpTarget> save_break(BreakJumpTarget);
4300 BreakJumpTarget = JumpTarget(LoopSuccessor, ScopePos);
4301
4302 // The block for the __begin != __end expression.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004303 CFGBlock *ConditionBlock = createBlock(false);
Richard Smith02e85f32011-04-14 22:09:26 +00004304 ConditionBlock->setTerminator(S);
4305
4306 // Now add the actual condition to the condition block.
4307 if (Expr *C = S->getCond()) {
4308 Block = ConditionBlock;
4309 CFGBlock *BeginConditionBlock = addStmt(C);
4310 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004311 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004312 assert(BeginConditionBlock == ConditionBlock &&
4313 "condition block in for-range was unexpectedly complex");
4314 (void)BeginConditionBlock;
4315 }
4316
4317 // The condition block is the implicit successor for the loop body as well as
4318 // any code above the loop.
4319 Succ = ConditionBlock;
4320
4321 // See if this is a known constant.
4322 TryResult KnownVal(true);
4323
4324 if (S->getCond())
4325 KnownVal = tryEvaluateBool(S->getCond());
4326
4327 // Now create the loop body.
4328 {
4329 assert(S->getBody());
4330
4331 // Save the current values for Block, Succ, and continue targets.
4332 SaveAndRestore<CFGBlock*> save_Block(Block), save_Succ(Succ);
4333 SaveAndRestore<JumpTarget> save_continue(ContinueJumpTarget);
4334
4335 // Generate increment code in its own basic block. This is the target of
4336 // continue statements.
Craig Topper25542942014-05-20 04:30:07 +00004337 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004338 Succ = addStmt(S->getInc());
Alexander Kornienkoff2046a2016-07-08 10:50:51 +00004339 if (badCFG)
4340 return nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004341 ContinueJumpTarget = JumpTarget(Succ, ContinueScopePos);
4342
4343 // The starting block for the loop increment is the block that should
4344 // represent the 'loop target' for looping back to the start of the loop.
4345 ContinueJumpTarget.block->setLoopTarget(S);
4346
4347 // Finish up the increment block and prepare to start the loop body.
4348 assert(Block);
4349 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004350 return nullptr;
4351 Block = nullptr;
Richard Smith02e85f32011-04-14 22:09:26 +00004352
4353 // Add implicit scope and dtors for loop variable.
4354 addLocalScopeAndDtors(S->getLoopVarStmt());
4355
4356 // Populate a new block to contain the loop body and loop variable.
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004357 addStmt(S->getBody());
Richard Smith02e85f32011-04-14 22:09:26 +00004358 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004359 return nullptr;
Ted Kremeneke6ee6712012-11-13 00:12:13 +00004360 CFGBlock *LoopVarStmtBlock = addStmt(S->getLoopVarStmt());
Richard Smith02e85f32011-04-14 22:09:26 +00004361 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004362 return nullptr;
4363
Richard Smith02e85f32011-04-14 22:09:26 +00004364 // This new body block is a successor to our condition block.
Craig Topper25542942014-05-20 04:30:07 +00004365 addSuccessor(ConditionBlock,
4366 KnownVal.isFalse() ? nullptr : LoopVarStmtBlock);
Richard Smith02e85f32011-04-14 22:09:26 +00004367 }
4368
4369 // Link up the condition block with the code that follows the loop (the
4370 // false branch).
Craig Topper25542942014-05-20 04:30:07 +00004371 addSuccessor(ConditionBlock, KnownVal.isTrue() ? nullptr : LoopSuccessor);
Richard Smith02e85f32011-04-14 22:09:26 +00004372
4373 // Add the initialization statements.
4374 Block = createBlock();
Richard Smith01694c32016-03-20 10:33:40 +00004375 addStmt(S->getBeginStmt());
4376 addStmt(S->getEndStmt());
Richard Smith8baa5002018-09-28 18:44:09 +00004377 CFGBlock *Head = addStmt(S->getRangeStmt());
4378 if (S->getInit())
4379 Head = addStmt(S->getInit());
4380 return Head;
Richard Smith02e85f32011-04-14 22:09:26 +00004381}
4382
John McCall5d413782010-12-06 08:20:24 +00004383CFGBlock *CFGBuilder::VisitExprWithCleanups(ExprWithCleanups *E,
Artem Dergachevead98ea2019-08-28 18:44:42 +00004384 AddStmtChoice asc, bool ExternallyDestructed) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004385 if (BuildOpts.AddTemporaryDtors) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004386 // If adding implicit destructors visit the full expression for adding
4387 // destructors of temporaries.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004388 TempDtorContext Context;
Artem Dergachevead98ea2019-08-28 18:44:42 +00004389 VisitForTemporaryDtors(E->getSubExpr(), ExternallyDestructed, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004390
4391 // Full expression has to be added as CFGStmt so it will be sequenced
4392 // before destructors of it's temporaries.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004393 asc = asc.withAlwaysAdd(true);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004394 }
4395 return Visit(E->getSubExpr(), asc);
4396}
4397
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004398CFGBlock *CFGBuilder::VisitCXXBindTemporaryExpr(CXXBindTemporaryExpr *E,
4399 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004400 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004401 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004402 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004403
Artem Dergachev783a4572018-02-23 22:20:39 +00004404 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00004405 ConstructionContextLayer::create(cfg->getBumpVectorContext(), E),
Artem Dergachev783a4572018-02-23 22:20:39 +00004406 E->getSubExpr());
Artem Dergachev1f68d9d2018-02-15 03:13:36 +00004407
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004408 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004409 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004410 }
4411 return Visit(E->getSubExpr(), asc);
4412}
4413
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004414CFGBlock *CFGBuilder::VisitCXXConstructExpr(CXXConstructExpr *C,
4415 AddStmtChoice asc) {
Artem Dergachevbd880fe2018-07-31 19:39:37 +00004416 // If the constructor takes objects as arguments by value, we need to properly
4417 // construct these objects. Construction contexts we find here aren't for the
4418 // constructor C, they're for its arguments only.
4419 findConstructionContextsForArguments(C);
4420
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004421 autoCreateBlock();
Artem Dergachev41ffb302018-02-08 22:58:15 +00004422 appendConstructor(Block, C);
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004423
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004424 return VisitChildren(C);
4425}
4426
Jordan Rosec9176072014-01-13 17:59:19 +00004427CFGBlock *CFGBuilder::VisitCXXNewExpr(CXXNewExpr *NE,
4428 AddStmtChoice asc) {
Jordan Rosec9176072014-01-13 17:59:19 +00004429 autoCreateBlock();
4430 appendStmt(Block, NE);
Jordan Rose6f5f7192014-01-14 17:29:12 +00004431
Artem Dergachev783a4572018-02-23 22:20:39 +00004432 findConstructionContexts(
Artem Dergachev40684812018-02-27 20:03:35 +00004433 ConstructionContextLayer::create(cfg->getBumpVectorContext(), NE),
Artem Dergachev783a4572018-02-23 22:20:39 +00004434 const_cast<CXXConstructExpr *>(NE->getConstructExpr()));
Artem Dergachev41ffb302018-02-08 22:58:15 +00004435
Jordan Rosec9176072014-01-13 17:59:19 +00004436 if (NE->getInitializer())
Jordan Rose6f5f7192014-01-14 17:29:12 +00004437 Block = Visit(NE->getInitializer());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004438
Jordan Rosec9176072014-01-13 17:59:19 +00004439 if (BuildOpts.AddCXXNewAllocator)
4440 appendNewAllocator(Block, NE);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004441
Richard Smithb9fb1212019-05-06 03:47:15 +00004442 if (NE->isArray() && *NE->getArraySize())
4443 Block = Visit(*NE->getArraySize());
Artem Dergachev41ffb302018-02-08 22:58:15 +00004444
Jordan Rosec9176072014-01-13 17:59:19 +00004445 for (CXXNewExpr::arg_iterator I = NE->placement_arg_begin(),
4446 E = NE->placement_arg_end(); I != E; ++I)
Jordan Rose6f5f7192014-01-14 17:29:12 +00004447 Block = Visit(*I);
Artem Dergachev41ffb302018-02-08 22:58:15 +00004448
Jordan Rosec9176072014-01-13 17:59:19 +00004449 return Block;
4450}
Jordan Rosed2f40792013-09-03 17:00:57 +00004451
4452CFGBlock *CFGBuilder::VisitCXXDeleteExpr(CXXDeleteExpr *DE,
4453 AddStmtChoice asc) {
4454 autoCreateBlock();
4455 appendStmt(Block, DE);
4456 QualType DTy = DE->getDestroyedType();
Martin Bohmef44cde82016-12-05 11:33:19 +00004457 if (!DTy.isNull()) {
4458 DTy = DTy.getNonReferenceType();
4459 CXXRecordDecl *RD = Context->getBaseElementType(DTy)->getAsCXXRecordDecl();
4460 if (RD) {
4461 if (RD->isCompleteDefinition() && !RD->hasTrivialDestructor())
4462 appendDeleteDtor(Block, RD, DE);
4463 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004464 }
4465
4466 return VisitChildren(DE);
4467}
4468
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004469CFGBlock *CFGBuilder::VisitCXXFunctionalCastExpr(CXXFunctionalCastExpr *E,
4470 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004471 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004472 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004473 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004474 // We do not want to propagate the AlwaysAdd property.
Zhanyong Wanb5d11c12010-11-24 03:28:53 +00004475 asc = asc.withAlwaysAdd(false);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004476 }
4477 return Visit(E->getSubExpr(), asc);
4478}
4479
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004480CFGBlock *CFGBuilder::VisitCXXTemporaryObjectExpr(CXXTemporaryObjectExpr *C,
4481 AddStmtChoice asc) {
Artem Dergachevc531d542018-08-14 21:10:46 +00004482 // If the constructor takes objects as arguments by value, we need to properly
4483 // construct these objects. Construction contexts we find here aren't for the
4484 // constructor C, they're for its arguments only.
4485 findConstructionContextsForArguments(C);
4486
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004487 autoCreateBlock();
Artem Dergachev1f68d9d2018-02-15 03:13:36 +00004488 appendConstructor(Block, C);
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00004489 return VisitChildren(C);
4490}
4491
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004492CFGBlock *CFGBuilder::VisitImplicitCastExpr(ImplicitCastExpr *E,
4493 AddStmtChoice asc) {
Ted Kremenek7c58d352011-03-10 01:14:11 +00004494 if (asc.alwaysAdd(*this, E)) {
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004495 autoCreateBlock();
Ted Kremenek2866bab2011-03-10 01:14:08 +00004496 appendStmt(Block, E);
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004497 }
Ted Kremenek8219b822010-12-16 07:46:53 +00004498 return Visit(E->getSubExpr(), AddStmtChoice());
Zhongxing Xue1dbeb22010-11-01 13:04:58 +00004499}
4500
Bill Wendling8003edc2018-11-09 00:41:36 +00004501CFGBlock *CFGBuilder::VisitConstantExpr(ConstantExpr *E, AddStmtChoice asc) {
4502 return Visit(E->getSubExpr(), AddStmtChoice());
4503}
4504
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004505CFGBlock *CFGBuilder::VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Mike Stump31feda52009-07-17 01:31:16 +00004506 // Lazily create the indirect-goto dispatch block if there isn't one already.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004507 CFGBlock *IBlock = cfg->getIndirectGotoBlock();
Mike Stump31feda52009-07-17 01:31:16 +00004508
Ted Kremenekeda180e22007-08-28 19:26:49 +00004509 if (!IBlock) {
4510 IBlock = createBlock(false);
4511 cfg->setIndirectGotoBlock(IBlock);
4512 }
Mike Stump31feda52009-07-17 01:31:16 +00004513
Ted Kremenekeda180e22007-08-28 19:26:49 +00004514 // IndirectGoto is a control-flow statement. Thus we stop processing the
4515 // current block and create a new one.
Zhongxing Xu33dfc072010-09-06 07:32:31 +00004516 if (badCFG)
Craig Topper25542942014-05-20 04:30:07 +00004517 return nullptr;
Ted Kremenek93668002009-07-17 22:18:43 +00004518
Ted Kremenekeda180e22007-08-28 19:26:49 +00004519 Block = createBlock(false);
4520 Block->setTerminator(I);
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00004521 addSuccessor(Block, IBlock);
Ted Kremenekeda180e22007-08-28 19:26:49 +00004522 return addStmt(I->getTarget());
4523}
4524
Artem Dergachevead98ea2019-08-28 18:44:42 +00004525CFGBlock *CFGBuilder::VisitForTemporaryDtors(Stmt *E, bool ExternallyDestructed,
Manuel Klimekb5616c92014-08-07 10:42:17 +00004526 TempDtorContext &Context) {
Jordan Rose6d671cc2012-09-05 22:55:23 +00004527 assert(BuildOpts.AddImplicitDtors && BuildOpts.AddTemporaryDtors);
4528
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004529tryAgain:
4530 if (!E) {
4531 badCFG = true;
Craig Topper25542942014-05-20 04:30:07 +00004532 return nullptr;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004533 }
4534 switch (E->getStmtClass()) {
4535 default:
Artem Dergachevead98ea2019-08-28 18:44:42 +00004536 return VisitChildrenForTemporaryDtors(E, false, Context);
4537
4538 case Stmt::InitListExprClass:
4539 return VisitChildrenForTemporaryDtors(E, ExternallyDestructed, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004540
4541 case Stmt::BinaryOperatorClass:
Manuel Klimekb5616c92014-08-07 10:42:17 +00004542 return VisitBinaryOperatorForTemporaryDtors(cast<BinaryOperator>(E),
Artem Dergachevead98ea2019-08-28 18:44:42 +00004543 ExternallyDestructed,
Manuel Klimekb5616c92014-08-07 10:42:17 +00004544 Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004545
4546 case Stmt::CXXBindTemporaryExprClass:
4547 return VisitCXXBindTemporaryExprForTemporaryDtors(
Artem Dergachevead98ea2019-08-28 18:44:42 +00004548 cast<CXXBindTemporaryExpr>(E), ExternallyDestructed, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004549
John McCallc07a0c72011-02-17 10:25:35 +00004550 case Stmt::BinaryConditionalOperatorClass:
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004551 case Stmt::ConditionalOperatorClass:
4552 return VisitConditionalOperatorForTemporaryDtors(
Artem Dergachevead98ea2019-08-28 18:44:42 +00004553 cast<AbstractConditionalOperator>(E), ExternallyDestructed, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004554
4555 case Stmt::ImplicitCastExprClass:
Artem Dergachevead98ea2019-08-28 18:44:42 +00004556 // For implicit cast we want ExternallyDestructed to be passed further.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004557 E = cast<CastExpr>(E)->getSubExpr();
4558 goto tryAgain;
4559
Manuel Klimekb0042c42014-07-30 08:34:42 +00004560 case Stmt::CXXFunctionalCastExprClass:
Artem Dergachevead98ea2019-08-28 18:44:42 +00004561 // For functional cast we want ExternallyDestructed to be passed further.
Manuel Klimekb0042c42014-07-30 08:34:42 +00004562 E = cast<CXXFunctionalCastExpr>(E)->getSubExpr();
4563 goto tryAgain;
4564
Bill Wendling8003edc2018-11-09 00:41:36 +00004565 case Stmt::ConstantExprClass:
4566 E = cast<ConstantExpr>(E)->getSubExpr();
4567 goto tryAgain;
4568
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004569 case Stmt::ParenExprClass:
4570 E = cast<ParenExpr>(E)->getSubExpr();
4571 goto tryAgain;
Richard Smith4137af22014-07-27 05:12:49 +00004572
Manuel Klimekb0042c42014-07-30 08:34:42 +00004573 case Stmt::MaterializeTemporaryExprClass: {
4574 const MaterializeTemporaryExpr* MTE = cast<MaterializeTemporaryExpr>(E);
Artem Dergachevead98ea2019-08-28 18:44:42 +00004575 ExternallyDestructed = (MTE->getStorageDuration() != SD_FullExpression);
Manuel Klimekb0042c42014-07-30 08:34:42 +00004576 SmallVector<const Expr *, 2> CommaLHSs;
4577 SmallVector<SubobjectAdjustment, 2> Adjustments;
4578 // Find the expression whose lifetime needs to be extended.
4579 E = const_cast<Expr *>(
4580 cast<MaterializeTemporaryExpr>(E)
4581 ->GetTemporaryExpr()
4582 ->skipRValueSubobjectAdjustments(CommaLHSs, Adjustments));
4583 // Visit the skipped comma operator left-hand sides for other temporaries.
4584 for (const Expr *CommaLHS : CommaLHSs) {
4585 VisitForTemporaryDtors(const_cast<Expr *>(CommaLHS),
Artem Dergachevead98ea2019-08-28 18:44:42 +00004586 /*ExternallyDestructed=*/false, Context);
Manuel Klimekb0042c42014-07-30 08:34:42 +00004587 }
Douglas Gregorfe314812011-06-21 17:03:29 +00004588 goto tryAgain;
Manuel Klimekb0042c42014-07-30 08:34:42 +00004589 }
Richard Smith4137af22014-07-27 05:12:49 +00004590
4591 case Stmt::BlockExprClass:
4592 // Don't recurse into blocks; their subexpressions don't get evaluated
4593 // here.
4594 return Block;
4595
4596 case Stmt::LambdaExprClass: {
4597 // For lambda expressions, only recurse into the capture initializers,
4598 // and not the body.
4599 auto *LE = cast<LambdaExpr>(E);
4600 CFGBlock *B = Block;
4601 for (Expr *Init : LE->capture_inits()) {
Richard Smith7ed5fb22018-07-27 17:13:18 +00004602 if (Init) {
4603 if (CFGBlock *R = VisitForTemporaryDtors(
Artem Dergachevead98ea2019-08-28 18:44:42 +00004604 Init, /*ExternallyDestructed=*/true, Context))
Richard Smith7ed5fb22018-07-27 17:13:18 +00004605 B = R;
4606 }
Richard Smith4137af22014-07-27 05:12:49 +00004607 }
4608 return B;
4609 }
4610
Artem Dergachevead98ea2019-08-28 18:44:42 +00004611 case Stmt::StmtExprClass:
4612 // Don't recurse into statement expressions; any cleanups inside them
4613 // will be wrapped in their own ExprWithCleanups.
4614 return Block;
4615
Richard Smith4137af22014-07-27 05:12:49 +00004616 case Stmt::CXXDefaultArgExprClass:
4617 E = cast<CXXDefaultArgExpr>(E)->getExpr();
4618 goto tryAgain;
4619
4620 case Stmt::CXXDefaultInitExprClass:
4621 E = cast<CXXDefaultInitExpr>(E)->getExpr();
4622 goto tryAgain;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004623 }
4624}
4625
Manuel Klimekb5616c92014-08-07 10:42:17 +00004626CFGBlock *CFGBuilder::VisitChildrenForTemporaryDtors(Stmt *E,
Artem Dergachevead98ea2019-08-28 18:44:42 +00004627 bool ExternallyDestructed,
Manuel Klimekb5616c92014-08-07 10:42:17 +00004628 TempDtorContext &Context) {
4629 if (isa<LambdaExpr>(E)) {
4630 // Do not visit the children of lambdas; they have their own CFGs.
4631 return Block;
4632 }
4633
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004634 // When visiting children for destructors we want to visit them in reverse
Ted Kremenek8ae67872013-02-05 22:00:19 +00004635 // order that they will appear in the CFG. Because the CFG is built
4636 // bottom-up, this means we visit them in their natural order, which
4637 // reverses them in the CFG.
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004638 CFGBlock *B = Block;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004639 for (Stmt *Child : E->children())
4640 if (Child)
Artem Dergachevead98ea2019-08-28 18:44:42 +00004641 if (CFGBlock *R = VisitForTemporaryDtors(Child, ExternallyDestructed, Context))
Ted Kremenek8ae67872013-02-05 22:00:19 +00004642 B = R;
Benjamin Kramer642f1732015-07-02 21:03:14 +00004643
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004644 return B;
4645}
4646
Manuel Klimekb5616c92014-08-07 10:42:17 +00004647CFGBlock *CFGBuilder::VisitBinaryOperatorForTemporaryDtors(
Artem Dergachevead98ea2019-08-28 18:44:42 +00004648 BinaryOperator *E, bool ExternallyDestructed, TempDtorContext &Context) {
4649 if (E->isCommaOp()) {
4650 // For comma operator LHS expression is visited
4651 // before RHS expression. For destructors visit them in reverse order.
4652 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), ExternallyDestructed, Context);
4653 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
4654 return LHSBlock ? LHSBlock : RHSBlock;
4655 }
4656
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004657 if (E->isLogicalOp()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004658 VisitForTemporaryDtors(E->getLHS(), false, Context);
Manuel Klimekedf925b92014-08-07 18:44:19 +00004659 TryResult RHSExecuted = tryEvaluateBool(E->getLHS());
4660 if (RHSExecuted.isKnown() && E->getOpcode() == BO_LOr)
4661 RHSExecuted.negate();
Manuel Klimek7c030132014-08-07 16:05:51 +00004662
Manuel Klimekedf925b92014-08-07 18:44:19 +00004663 // We do not know at CFG-construction time whether the right-hand-side was
4664 // executed, thus we add a branch node that depends on the temporary
4665 // constructor call.
Manuel Klimekdeb02622014-08-08 07:37:13 +00004666 TempDtorContext RHSContext(
4667 bothKnownTrue(Context.KnownExecuted, RHSExecuted));
Manuel Klimekedf925b92014-08-07 18:44:19 +00004668 VisitForTemporaryDtors(E->getRHS(), false, RHSContext);
Manuel Klimekdeb02622014-08-08 07:37:13 +00004669 InsertTempDtorDecisionBlock(RHSContext);
Manuel Klimek7c030132014-08-07 16:05:51 +00004670
Manuel Klimekb5616c92014-08-07 10:42:17 +00004671 return Block;
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004672 }
4673
Zhanyong Wan59f09c72010-11-22 19:32:14 +00004674 if (E->isAssignmentOp()) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004675 // For assignment operator (=) LHS expression is visited
4676 // before RHS expression. For destructors visit them in reverse order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004677 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
4678 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004679 return LHSBlock ? LHSBlock : RHSBlock;
4680 }
4681
4682 // For any other binary operator RHS expression is visited before
4683 // LHS expression (order of children). For destructors visit them in reverse
4684 // order.
Manuel Klimekb5616c92014-08-07 10:42:17 +00004685 CFGBlock *LHSBlock = VisitForTemporaryDtors(E->getLHS(), false, Context);
4686 CFGBlock *RHSBlock = VisitForTemporaryDtors(E->getRHS(), false, Context);
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004687 return RHSBlock ? RHSBlock : LHSBlock;
4688}
4689
4690CFGBlock *CFGBuilder::VisitCXXBindTemporaryExprForTemporaryDtors(
Artem Dergachevead98ea2019-08-28 18:44:42 +00004691 CXXBindTemporaryExpr *E, bool ExternallyDestructed, TempDtorContext &Context) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004692 // First add destructors for temporaries in subexpression.
Artem Dergachevead98ea2019-08-28 18:44:42 +00004693 // Because VisitCXXBindTemporaryExpr calls setDestructed:
4694 CFGBlock *B = VisitForTemporaryDtors(E->getSubExpr(), true, Context);
4695 if (!ExternallyDestructed) {
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004696 // If lifetime of temporary is not prolonged (by assigning to constant
4697 // reference) add destructor for it.
Chandler Carruthad747252011-09-13 06:09:01 +00004698
Chandler Carruthad747252011-09-13 06:09:01 +00004699 const CXXDestructorDecl *Dtor = E->getTemporary()->getDestructor();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004700
Richard Trieu95a192a2015-05-28 00:14:02 +00004701 if (Dtor->getParent()->isAnyDestructorNoReturn()) {
Manuel Klimekb5616c92014-08-07 10:42:17 +00004702 // If the destructor is marked as a no-return destructor, we need to
4703 // create a new block for the destructor which does not have as a
4704 // successor anything built thus far. Control won't flow out of this
4705 // block.
4706 if (B) Succ = B;
Chandler Carrutha70991b2011-09-13 09:13:49 +00004707 Block = createNoReturnBlock();
Manuel Klimekb5616c92014-08-07 10:42:17 +00004708 } else if (Context.needsTempDtorBranch()) {
4709 // If we need to introduce a branch, we add a new block that we will hook
4710 // up to a decision block later.
4711 if (B) Succ = B;
4712 Block = createBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004713 } else {
Chandler Carruthad747252011-09-13 06:09:01 +00004714 autoCreateBlock();
Ted Kremenekff909f92014-03-08 02:22:25 +00004715 }
Manuel Klimekb5616c92014-08-07 10:42:17 +00004716 if (Context.needsTempDtorBranch()) {
4717 Context.setDecisionPoint(Succ, E);
4718 }
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004719 appendTemporaryDtor(Block, E);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004720
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004721 B = Block;
4722 }
4723 return B;
4724}
4725
Manuel Klimekb5616c92014-08-07 10:42:17 +00004726void CFGBuilder::InsertTempDtorDecisionBlock(const TempDtorContext &Context,
4727 CFGBlock *FalseSucc) {
4728 if (!Context.TerminatorExpr) {
4729 // If no temporary was found, we do not need to insert a decision point.
4730 return;
4731 }
4732 assert(Context.TerminatorExpr);
4733 CFGBlock *Decision = createBlock(false);
Artem Dergachev4e530322019-05-24 01:34:22 +00004734 Decision->setTerminator(CFGTerminator(Context.TerminatorExpr,
4735 CFGTerminator::TemporaryDtorsBranch));
Manuel Klimekdeb02622014-08-08 07:37:13 +00004736 addSuccessor(Decision, Block, !Context.KnownExecuted.isFalse());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004737 addSuccessor(Decision, FalseSucc ? FalseSucc : Context.Succ,
Manuel Klimekdeb02622014-08-08 07:37:13 +00004738 !Context.KnownExecuted.isTrue());
Manuel Klimekb5616c92014-08-07 10:42:17 +00004739 Block = Decision;
4740}
4741
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004742CFGBlock *CFGBuilder::VisitConditionalOperatorForTemporaryDtors(
Artem Dergachevead98ea2019-08-28 18:44:42 +00004743 AbstractConditionalOperator *E, bool ExternallyDestructed,
Manuel Klimekb5616c92014-08-07 10:42:17 +00004744 TempDtorContext &Context) {
4745 VisitForTemporaryDtors(E->getCond(), false, Context);
4746 CFGBlock *ConditionBlock = Block;
4747 CFGBlock *ConditionSucc = Succ;
Manuel Klimek0ce91082014-08-07 14:25:43 +00004748 TryResult ConditionVal = tryEvaluateBool(E->getCond());
Manuel Klimekedf925b92014-08-07 18:44:19 +00004749 TryResult NegatedVal = ConditionVal;
4750 if (NegatedVal.isKnown()) NegatedVal.negate();
Manuel Klimekcadc6032014-08-07 17:02:21 +00004751
Manuel Klimekdeb02622014-08-08 07:37:13 +00004752 TempDtorContext TrueContext(
4753 bothKnownTrue(Context.KnownExecuted, ConditionVal));
Artem Dergachevead98ea2019-08-28 18:44:42 +00004754 VisitForTemporaryDtors(E->getTrueExpr(), ExternallyDestructed, TrueContext);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004755 CFGBlock *TrueBlock = Block;
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004756
Manuel Klimekb5616c92014-08-07 10:42:17 +00004757 Block = ConditionBlock;
4758 Succ = ConditionSucc;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004759 TempDtorContext FalseContext(
4760 bothKnownTrue(Context.KnownExecuted, NegatedVal));
Artem Dergachevead98ea2019-08-28 18:44:42 +00004761 VisitForTemporaryDtors(E->getFalseExpr(), ExternallyDestructed, FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004762
Manuel Klimekb5616c92014-08-07 10:42:17 +00004763 if (TrueContext.TerminatorExpr && FalseContext.TerminatorExpr) {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004764 InsertTempDtorDecisionBlock(FalseContext, TrueBlock);
Manuel Klimekb5616c92014-08-07 10:42:17 +00004765 } else if (TrueContext.TerminatorExpr) {
4766 Block = TrueBlock;
Manuel Klimekdeb02622014-08-08 07:37:13 +00004767 InsertTempDtorDecisionBlock(TrueContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004768 } else {
Manuel Klimekdeb02622014-08-08 07:37:13 +00004769 InsertTempDtorDecisionBlock(FalseContext);
Rui Ueyamaa89f9c82014-08-06 22:01:54 +00004770 }
Marcin Swiderski3ab17ad2010-11-03 06:19:35 +00004771 return Block;
4772}
4773
Alexey Bataevc2c21ef2019-07-11 14:54:17 +00004774CFGBlock *CFGBuilder::VisitOMPExecutableDirective(OMPExecutableDirective *D,
4775 AddStmtChoice asc) {
4776 if (asc.alwaysAdd(*this, D)) {
4777 autoCreateBlock();
4778 appendStmt(Block, D);
4779 }
4780
4781 // Iterate over all used expression in clauses.
4782 CFGBlock *B = Block;
4783
4784 // Reverse the elements to process them in natural order. Iterators are not
4785 // bidirectional, so we need to create temp vector.
Alexey Bataev655cb4a2019-07-16 14:51:46 +00004786 SmallVector<Stmt *, 8> Used(
4787 OMPExecutableDirective::used_clauses_children(D->clauses()));
4788 for (Stmt *S : llvm::reverse(Used)) {
Alexey Bataevc2c21ef2019-07-11 14:54:17 +00004789 assert(S && "Expected non-null used-in-clause child.");
4790 if (CFGBlock *R = Visit(S))
4791 B = R;
4792 }
4793 // Visit associated structured block if any.
4794 if (!D->isStandaloneDirective())
4795 if (Stmt *S = D->getStructuredBlock()) {
4796 if (!isa<CompoundStmt>(S))
4797 addLocalScopeAndDtors(S);
4798 if (CFGBlock *R = addStmt(S))
4799 B = R;
4800 }
4801
4802 return B;
4803}
4804
Mike Stump31feda52009-07-17 01:31:16 +00004805/// createBlock - Constructs and adds a new CFGBlock to the CFG. The block has
4806/// no successors or predecessors. If this is the first block created in the
4807/// CFG, it is automatically set to be the Entry and Exit of the CFG.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00004808CFGBlock *CFG::createBlock() {
Ted Kremenek889073f2007-08-23 16:51:22 +00004809 bool first_block = begin() == end();
4810
4811 // Create the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004812 CFGBlock *Mem = getAllocator().Allocate<CFGBlock>();
Anna Zaks02a1fc12011-12-05 21:33:11 +00004813 new (Mem) CFGBlock(NumBlockIDs++, BlkBVC, this);
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004814 Blocks.push_back(Mem, BlkBVC);
Ted Kremenek889073f2007-08-23 16:51:22 +00004815
4816 // If this is the first block, set it as the Entry and Exit.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004817 if (first_block)
4818 Entry = Exit = &back();
Ted Kremenek889073f2007-08-23 16:51:22 +00004819
4820 // Return the block.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00004821 return &back();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00004822}
4823
David Blaikiee90195c2014-08-29 18:53:26 +00004824/// buildCFG - Constructs a CFG from an AST.
4825std::unique_ptr<CFG> CFG::buildCFG(const Decl *D, Stmt *Statement,
4826 ASTContext *C, const BuildOptions &BO) {
Ted Kremenekf9d82902011-03-10 01:14:05 +00004827 CFGBuilder Builder(C, BO);
4828 return Builder.buildCFG(D, Statement);
Ted Kremenek889073f2007-08-23 16:51:22 +00004829}
4830
Artem Dergachevab7747b2019-04-30 03:01:02 +00004831bool CFG::isLinear() const {
4832 // Quick path: if we only have the ENTRY block, the EXIT block, and some code
4833 // in between, then we have no room for control flow.
4834 if (size() <= 3)
4835 return true;
4836
4837 // Traverse the CFG until we find a branch.
4838 // TODO: While this should still be very fast,
4839 // maybe we should cache the answer.
4840 llvm::SmallPtrSet<const CFGBlock *, 4> Visited;
4841 const CFGBlock *B = Entry;
4842 while (B != Exit) {
4843 auto IteratorAndFlag = Visited.insert(B);
4844 if (!IteratorAndFlag.second) {
4845 // We looped back to a block that we've already visited. Not linear.
4846 return false;
4847 }
4848
4849 // Iterate over reachable successors.
4850 const CFGBlock *FirstReachableB = nullptr;
4851 for (const CFGBlock::AdjacentBlock &AB : B->succs()) {
4852 if (!AB.isReachable())
4853 continue;
4854
4855 if (FirstReachableB == nullptr) {
4856 FirstReachableB = &*AB;
4857 } else {
4858 // We've encountered a branch. It's not a linear CFG.
4859 return false;
4860 }
4861 }
4862
4863 if (!FirstReachableB) {
4864 // We reached a dead end. EXIT is unreachable. This is linear enough.
4865 return true;
4866 }
4867
4868 // There's only one way to move forward. Proceed.
4869 B = FirstReachableB;
4870 }
4871
4872 // We reached EXIT and found no branches.
4873 return true;
4874}
4875
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004876const CXXDestructorDecl *
4877CFGImplicitDtor::getDestructorDecl(ASTContext &astContext) const {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004878 switch (getKind()) {
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004879 case CFGElement::Initializer:
Jordan Rosec9176072014-01-13 17:59:19 +00004880 case CFGElement::NewAllocator:
Peter Szecsi999a25f2017-08-19 11:19:16 +00004881 case CFGElement::LoopExit:
Matthias Gehre351c2182017-07-12 07:04:19 +00004882 case CFGElement::LifetimeEnds:
Artem Dergachev41ffb302018-02-08 22:58:15 +00004883 case CFGElement::Statement:
4884 case CFGElement::Constructor:
Artem Dergachev1527dec2018-03-12 23:12:40 +00004885 case CFGElement::CXXRecordTypedCall:
Maxim Ostapenkodebca452018-03-12 12:26:15 +00004886 case CFGElement::ScopeBegin:
4887 case CFGElement::ScopeEnd:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004888 llvm_unreachable("getDestructorDecl should only be used with "
4889 "ImplicitDtors");
4890 case CFGElement::AutomaticObjectDtor: {
David Blaikie2a01f5d2013-02-21 20:58:29 +00004891 const VarDecl *var = castAs<CFGAutomaticObjDtor>().getVarDecl();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004892 QualType ty = var->getType();
Devin Coughlin6eb1ca72016-08-02 21:07:23 +00004893
4894 // FIXME: See CFGBuilder::addLocalScopeForVarDecl.
4895 //
4896 // Lifetime-extending constructs are handled here. This works for a single
4897 // temporary in an initializer expression.
4898 if (ty->isReferenceType()) {
4899 if (const Expr *Init = var->getInit()) {
Artem Dergacheva25809f2018-06-04 18:56:25 +00004900 ty = getReferenceInitTemporaryType(Init);
Devin Coughlin6eb1ca72016-08-02 21:07:23 +00004901 }
4902 }
4903
Ted Kremeneke7d78882012-03-19 23:48:41 +00004904 while (const ArrayType *arrayType = astContext.getAsArrayType(ty)) {
Ted Kremenek8cfe2072011-03-03 01:21:32 +00004905 ty = arrayType->getElementType();
4906 }
Artem Dergachev3517d102019-08-28 21:19:58 +00004907
4908 // The situation when the type of the lifetime-extending reference
4909 // does not correspond to the type of the object is supposed
4910 // to be handled by now. In particular, 'ty' is now the unwrapped
4911 // record type.
4912 const CXXRecordDecl *classDecl = ty->getAsCXXRecordDecl();
4913 assert(classDecl);
Fangrui Song6907ce22018-07-30 19:24:48 +00004914 return classDecl->getDestructor();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004915 }
Jordan Rosed2f40792013-09-03 17:00:57 +00004916 case CFGElement::DeleteDtor: {
4917 const CXXDeleteExpr *DE = castAs<CFGDeleteDtor>().getDeleteExpr();
4918 QualType DTy = DE->getDestroyedType();
4919 DTy = DTy.getNonReferenceType();
4920 const CXXRecordDecl *classDecl =
4921 astContext.getBaseElementType(DTy)->getAsCXXRecordDecl();
4922 return classDecl->getDestructor();
4923 }
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004924 case CFGElement::TemporaryDtor: {
4925 const CXXBindTemporaryExpr *bindExpr =
David Blaikie2a01f5d2013-02-21 20:58:29 +00004926 castAs<CFGTemporaryDtor>().getBindTemporaryExpr();
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004927 const CXXTemporary *temp = bindExpr->getTemporary();
4928 return temp->getDestructor();
4929 }
4930 case CFGElement::BaseDtor:
4931 case CFGElement::MemberDtor:
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004932 // Not yet supported.
Craig Topper25542942014-05-20 04:30:07 +00004933 return nullptr;
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004934 }
Ted Kremenek1676a042011-03-03 01:01:03 +00004935 llvm_unreachable("getKind() returned bogus value");
Ted Kremeneke06a55c2011-03-02 20:32:29 +00004936}
4937
Ted Kremenekf2d4372b2007-10-01 19:33:33 +00004938//===----------------------------------------------------------------------===//
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004939// CFGBlock operations.
Ted Kremenekb0371852010-09-09 00:06:04 +00004940//===----------------------------------------------------------------------===//
4941
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004942CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, bool IsReachable)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004943 : ReachableBlock(IsReachable ? B : nullptr),
4944 UnreachableBlock(!IsReachable ? B : nullptr,
4945 B && IsReachable ? AB_Normal : AB_Unreachable) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004946
4947CFGBlock::AdjacentBlock::AdjacentBlock(CFGBlock *B, CFGBlock *AlternateBlock)
Eugene Zelenko38c70522017-12-07 21:55:09 +00004948 : ReachableBlock(B),
4949 UnreachableBlock(B == AlternateBlock ? nullptr : AlternateBlock,
4950 B == AlternateBlock ? AB_Alternate : AB_Normal) {}
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004951
4952void CFGBlock::addSuccessor(AdjacentBlock Succ,
4953 BumpVectorContext &C) {
4954 if (CFGBlock *B = Succ.getReachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004955 B->Preds.push_back(AdjacentBlock(this, Succ.isReachable()), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004956
4957 if (CFGBlock *UnreachableB = Succ.getPossiblyUnreachableBlock())
David Blaikie9afd5da2014-03-04 23:39:18 +00004958 UnreachableB->Preds.push_back(AdjacentBlock(this, false), C);
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004959
4960 Succs.push_back(Succ, C);
4961}
4962
Ted Kremenekb0371852010-09-09 00:06:04 +00004963bool CFGBlock::FilterEdge(const CFGBlock::FilterOptions &F,
Ted Kremenekf146cd12010-09-09 02:57:48 +00004964 const CFGBlock *From, const CFGBlock *To) {
Ted Kremenek4b6fee62014-02-27 00:24:00 +00004965 if (F.IgnoreNullPredecessors && !From)
4966 return true;
4967
4968 if (To && From && F.IgnoreDefaultsWithCoveredEnums) {
Ted Kremenekb0371852010-09-09 00:06:04 +00004969 // If the 'To' has no label or is labeled but the label isn't a
4970 // CaseStmt then filter this edge.
4971 if (const SwitchStmt *S =
Artem Dergachev4e530322019-05-24 01:34:22 +00004972 dyn_cast_or_null<SwitchStmt>(From->getTerminatorStmt())) {
Ted Kremenekb0371852010-09-09 00:06:04 +00004973 if (S->isAllEnumCasesCovered()) {
Ted Kremenek89794742011-03-07 22:04:39 +00004974 const Stmt *L = To->getLabel();
4975 if (!L || !isa<CaseStmt>(L))
4976 return true;
Ted Kremenekb0371852010-09-09 00:06:04 +00004977 }
4978 }
4979 }
4980
4981 return false;
4982}
4983
4984//===----------------------------------------------------------------------===//
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00004985// CFG pretty printing
4986//===----------------------------------------------------------------------===//
4987
Ted Kremenek7e776b12007-08-22 18:22:34 +00004988namespace {
4989
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00004990class StmtPrinterHelper : public PrinterHelper {
Eugene Zelenko38c70522017-12-07 21:55:09 +00004991 using StmtMapTy = llvm::DenseMap<const Stmt *, std::pair<unsigned, unsigned>>;
4992 using DeclMapTy = llvm::DenseMap<const Decl *, std::pair<unsigned, unsigned>>;
4993
Ted Kremenek04f3cee2007-08-31 21:30:12 +00004994 StmtMapTy StmtMap;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00004995 DeclMapTy DeclMap;
Eugene Zelenko38c70522017-12-07 21:55:09 +00004996 signed currentBlock = 0;
4997 unsigned currStmt = 0;
Chris Lattnerc61089a2009-06-30 01:26:17 +00004998 const LangOptions &LangOpts;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00004999
Eugene Zelenko38c70522017-12-07 21:55:09 +00005000public:
Chris Lattnerc61089a2009-06-30 01:26:17 +00005001 StmtPrinterHelper(const CFG* cfg, const LangOptions &LO)
Eugene Zelenko38c70522017-12-07 21:55:09 +00005002 : LangOpts(LO) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005003 for (CFG::const_iterator I = cfg->begin(), E = cfg->end(); I != E; ++I ) {
5004 unsigned j = 1;
Ted Kremenek289ae4f2009-10-12 20:55:07 +00005005 for (CFGBlock::const_iterator BI = (*I)->begin(), BEnd = (*I)->end() ;
Fangrui Song6907ce22018-07-30 19:24:48 +00005006 BI != BEnd; ++BI, ++j ) {
David Blaikie00be69a2013-02-23 00:29:34 +00005007 if (Optional<CFGStmt> SE = BI->getAs<CFGStmt>()) {
5008 const Stmt *stmt= SE->getStmt();
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005009 std::pair<unsigned, unsigned> P((*I)->getBlockID(), j);
Ted Kremenek96a7a592011-03-01 03:15:10 +00005010 StmtMap[stmt] = P;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005011
Ted Kremenek96a7a592011-03-01 03:15:10 +00005012 switch (stmt->getStmtClass()) {
5013 case Stmt::DeclStmtClass:
Artem Dergachev41ffb302018-02-08 22:58:15 +00005014 DeclMap[cast<DeclStmt>(stmt)->getSingleDecl()] = P;
5015 break;
Ted Kremenek96a7a592011-03-01 03:15:10 +00005016 case Stmt::IfStmtClass: {
5017 const VarDecl *var = cast<IfStmt>(stmt)->getConditionVariable();
5018 if (var)
5019 DeclMap[var] = P;
5020 break;
5021 }
5022 case Stmt::ForStmtClass: {
5023 const VarDecl *var = cast<ForStmt>(stmt)->getConditionVariable();
5024 if (var)
5025 DeclMap[var] = P;
5026 break;
5027 }
5028 case Stmt::WhileStmtClass: {
5029 const VarDecl *var =
5030 cast<WhileStmt>(stmt)->getConditionVariable();
5031 if (var)
5032 DeclMap[var] = P;
5033 break;
5034 }
5035 case Stmt::SwitchStmtClass: {
5036 const VarDecl *var =
5037 cast<SwitchStmt>(stmt)->getConditionVariable();
5038 if (var)
5039 DeclMap[var] = P;
5040 break;
5041 }
5042 case Stmt::CXXCatchStmtClass: {
5043 const VarDecl *var =
5044 cast<CXXCatchStmt>(stmt)->getExceptionDecl();
5045 if (var)
5046 DeclMap[var] = P;
5047 break;
5048 }
5049 default:
5050 break;
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005051 }
5052 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005053 }
Zhongxing Xu2cd7a782010-09-16 01:25:47 +00005054 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005055 }
Mike Stump31feda52009-07-17 01:31:16 +00005056
Eugene Zelenko38c70522017-12-07 21:55:09 +00005057 ~StmtPrinterHelper() override = default;
Mike Stump31feda52009-07-17 01:31:16 +00005058
Chris Lattnerc61089a2009-06-30 01:26:17 +00005059 const LangOptions &getLangOpts() const { return LangOpts; }
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00005060 void setBlockID(signed i) { currentBlock = i; }
Ted Kremenekd94854a2012-08-22 06:26:15 +00005061 void setStmtID(unsigned i) { currStmt = i; }
Mike Stump31feda52009-07-17 01:31:16 +00005062
Craig Topperb45acb82014-03-14 06:02:07 +00005063 bool handledStmt(Stmt *S, raw_ostream &OS) override {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005064 StmtMapTy::iterator I = StmtMap.find(S);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005065
5066 if (I == StmtMap.end())
5067 return false;
Mike Stump31feda52009-07-17 01:31:16 +00005068
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00005069 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00005070 && I->second.second == currStmt) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005071 return false;
Ted Kremenek60983dc2010-01-19 20:52:05 +00005072 }
Mike Stump31feda52009-07-17 01:31:16 +00005073
Ted Kremenek60983dc2010-01-19 20:52:05 +00005074 OS << "[B" << I->second.first << "." << I->second.second << "]";
Ted Kremenekf8b50e92007-08-31 22:26:13 +00005075 return true;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005076 }
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005077
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005078 bool handleDecl(const Decl *D, raw_ostream &OS) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005079 DeclMapTy::iterator I = DeclMap.find(D);
5080
5081 if (I == DeclMap.end())
5082 return false;
5083
Ted Kremenek3a9a2a52010-12-17 04:44:39 +00005084 if (currentBlock >= 0 && I->second.first == (unsigned) currentBlock
Ted Kremenekd94854a2012-08-22 06:26:15 +00005085 && I->second.second == currStmt) {
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005086 return false;
5087 }
5088
5089 OS << "[B" << I->second.first << "." << I->second.second << "]";
5090 return true;
5091 }
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005092};
5093
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +00005094class CFGBlockTerminatorPrint
Eugene Zelenko38c70522017-12-07 21:55:09 +00005095 : public StmtVisitor<CFGBlockTerminatorPrint,void> {
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005096 raw_ostream &OS;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005097 StmtPrinterHelper* Helper;
Douglas Gregor7de59662009-05-29 20:38:28 +00005098 PrintingPolicy Policy;
Eugene Zelenko38c70522017-12-07 21:55:09 +00005099
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005100public:
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005101 CFGBlockTerminatorPrint(raw_ostream &os, StmtPrinterHelper* helper,
Chris Lattnerc61089a2009-06-30 01:26:17 +00005102 const PrintingPolicy &Policy)
Eugene Zelenko38c70522017-12-07 21:55:09 +00005103 : OS(os), Helper(helper), Policy(Policy) {
Ted Kremenek5d0fb1e2013-12-11 23:44:05 +00005104 this->Policy.IncludeNewlines = false;
5105 }
Mike Stump31feda52009-07-17 01:31:16 +00005106
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005107 void VisitIfStmt(IfStmt *I) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00005108 OS << "if ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00005109 if (Stmt *C = I->getCond())
5110 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00005111 }
Mike Stump31feda52009-07-17 01:31:16 +00005112
Ted Kremenek9aae5132007-08-23 21:42:29 +00005113 // Default case.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005114 void VisitStmt(Stmt *Terminator) {
Mike Stump31feda52009-07-17 01:31:16 +00005115 Terminator->printPretty(OS, Helper, Policy);
5116 }
5117
Ted Kremenek0dd8fee2013-03-28 18:43:15 +00005118 void VisitDeclStmt(DeclStmt *DS) {
5119 VarDecl *VD = cast<VarDecl>(DS->getSingleDecl());
5120 OS << "static init " << VD->getName();
5121 }
5122
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005123 void VisitForStmt(ForStmt *F) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00005124 OS << "for (" ;
Ted Kremenek60983dc2010-01-19 20:52:05 +00005125 if (F->getInit())
5126 OS << "...";
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00005127 OS << "; ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005128 if (Stmt *C = F->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00005129 C->printPretty(OS, Helper, Policy);
Ted Kremenekfc7aafc2007-08-30 21:28:02 +00005130 OS << "; ";
Ted Kremenek60983dc2010-01-19 20:52:05 +00005131 if (F->getInc())
5132 OS << "...";
Ted Kremenek15647632008-01-30 23:02:42 +00005133 OS << ")";
Ted Kremenek9aae5132007-08-23 21:42:29 +00005134 }
Mike Stump31feda52009-07-17 01:31:16 +00005135
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005136 void VisitWhileStmt(WhileStmt *W) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00005137 OS << "while " ;
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005138 if (Stmt *C = W->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00005139 C->printPretty(OS, Helper, Policy);
Ted Kremenek9aae5132007-08-23 21:42:29 +00005140 }
Mike Stump31feda52009-07-17 01:31:16 +00005141
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005142 void VisitDoStmt(DoStmt *D) {
Ted Kremenek9aae5132007-08-23 21:42:29 +00005143 OS << "do ... while ";
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005144 if (Stmt *C = D->getCond())
Ted Kremenek60983dc2010-01-19 20:52:05 +00005145 C->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00005146 }
Mike Stump31feda52009-07-17 01:31:16 +00005147
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005148 void VisitSwitchStmt(SwitchStmt *Terminator) {
Ted Kremenek9e248872007-08-27 21:27:44 +00005149 OS << "switch ";
Douglas Gregor7de59662009-05-29 20:38:28 +00005150 Terminator->getCond()->printPretty(OS, Helper, Policy);
Ted Kremenek9e248872007-08-27 21:27:44 +00005151 }
Mike Stump31feda52009-07-17 01:31:16 +00005152
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005153 void VisitCXXTryStmt(CXXTryStmt *CS) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005154 OS << "try ...";
5155 }
5156
Nico Weber699670e2017-08-23 15:33:16 +00005157 void VisitSEHTryStmt(SEHTryStmt *CS) {
5158 OS << "__try ...";
5159 }
5160
John McCallc07a0c72011-02-17 10:25:35 +00005161 void VisitAbstractConditionalOperator(AbstractConditionalOperator* C) {
Richard Trieuddd01ce2014-06-09 22:53:25 +00005162 if (Stmt *Cond = C->getCond())
5163 Cond->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00005164 OS << " ? ... : ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00005165 }
Mike Stump31feda52009-07-17 01:31:16 +00005166
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005167 void VisitChooseExpr(ChooseExpr *C) {
Ted Kremenek391f94a2007-08-31 22:29:13 +00005168 OS << "__builtin_choose_expr( ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00005169 if (Stmt *Cond = C->getCond())
5170 Cond->printPretty(OS, Helper, Policy);
Ted Kremenek15647632008-01-30 23:02:42 +00005171 OS << " )";
Ted Kremenek391f94a2007-08-31 22:29:13 +00005172 }
Mike Stump31feda52009-07-17 01:31:16 +00005173
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005174 void VisitIndirectGotoStmt(IndirectGotoStmt *I) {
Ted Kremenekf8b50e92007-08-31 22:26:13 +00005175 OS << "goto *";
Richard Trieuddd01ce2014-06-09 22:53:25 +00005176 if (Stmt *T = I->getTarget())
5177 T->printPretty(OS, Helper, Policy);
Ted Kremenekf8b50e92007-08-31 22:26:13 +00005178 }
Mike Stump31feda52009-07-17 01:31:16 +00005179
Ted Kremenek7f7dd762007-08-31 21:49:40 +00005180 void VisitBinaryOperator(BinaryOperator* B) {
5181 if (!B->isLogicalOp()) {
5182 VisitExpr(B);
5183 return;
5184 }
Mike Stump31feda52009-07-17 01:31:16 +00005185
Richard Trieuddd01ce2014-06-09 22:53:25 +00005186 if (B->getLHS())
5187 B->getLHS()->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00005188
Ted Kremenek7f7dd762007-08-31 21:49:40 +00005189 switch (B->getOpcode()) {
John McCalle3027922010-08-25 11:45:40 +00005190 case BO_LOr:
Ted Kremenek15647632008-01-30 23:02:42 +00005191 OS << " || ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00005192 return;
John McCalle3027922010-08-25 11:45:40 +00005193 case BO_LAnd:
Ted Kremenek15647632008-01-30 23:02:42 +00005194 OS << " && ...";
Ted Kremenek7f7dd762007-08-31 21:49:40 +00005195 return;
5196 default:
David Blaikie83d382b2011-09-23 05:06:16 +00005197 llvm_unreachable("Invalid logical operator.");
Mike Stump31feda52009-07-17 01:31:16 +00005198 }
Ted Kremenek7f7dd762007-08-31 21:49:40 +00005199 }
Mike Stump31feda52009-07-17 01:31:16 +00005200
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005201 void VisitExpr(Expr *E) {
Douglas Gregor7de59662009-05-29 20:38:28 +00005202 E->printPretty(OS, Helper, Policy);
Mike Stump31feda52009-07-17 01:31:16 +00005203 }
Ted Kremenekfcc14172014-03-08 02:22:29 +00005204
5205public:
5206 void print(CFGTerminator T) {
Artem Dergachev4e530322019-05-24 01:34:22 +00005207 switch (T.getKind()) {
5208 case CFGTerminator::StmtBranch:
5209 Visit(T.getStmt());
5210 break;
5211 case CFGTerminator::TemporaryDtorsBranch:
Ted Kremenekfcc14172014-03-08 02:22:29 +00005212 OS << "(Temp Dtor) ";
Artem Dergachev4e530322019-05-24 01:34:22 +00005213 Visit(T.getStmt());
5214 break;
Artem Dergachev192a7472019-05-24 23:37:08 +00005215 case CFGTerminator::VirtualBaseBranch:
5216 OS << "(See if most derived ctor has already initialized vbases)";
5217 break;
Artem Dergachev4e530322019-05-24 01:34:22 +00005218 }
Ted Kremenekfcc14172014-03-08 02:22:29 +00005219 }
Ted Kremenek9aae5132007-08-23 21:42:29 +00005220};
Eugene Zelenko38c70522017-12-07 21:55:09 +00005221
5222} // namespace
Chris Lattnerc61089a2009-06-30 01:26:17 +00005223
Artem Dergachev5a281bb2018-02-10 02:18:04 +00005224static void print_initializer(raw_ostream &OS, StmtPrinterHelper &Helper,
5225 const CXXCtorInitializer *I) {
5226 if (I->isBaseInitializer())
5227 OS << I->getBaseClass()->getAsCXXRecordDecl()->getName();
5228 else if (I->isDelegatingInitializer())
5229 OS << I->getTypeSourceInfo()->getType()->getAsCXXRecordDecl()->getName();
5230 else
5231 OS << I->getAnyMember()->getName();
5232 OS << "(";
5233 if (Expr *IE = I->getInit())
5234 IE->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
5235 OS << ")";
5236
5237 if (I->isBaseInitializer())
5238 OS << " (Base initializer)";
5239 else if (I->isDelegatingInitializer())
5240 OS << " (Delegating initializer)";
5241 else
5242 OS << " (Member initializer)";
5243}
5244
Artem Dergachev1527dec2018-03-12 23:12:40 +00005245static void print_construction_context(raw_ostream &OS,
5246 StmtPrinterHelper &Helper,
5247 const ConstructionContext *CC) {
Artem Dergachevff267df2018-06-28 00:04:54 +00005248 SmallVector<const Stmt *, 3> Stmts;
Artem Dergachev1527dec2018-03-12 23:12:40 +00005249 switch (CC->getKind()) {
Artem Dergachev922455f2018-03-22 22:02:38 +00005250 case ConstructionContext::SimpleConstructorInitializerKind: {
Artem Dergachev1527dec2018-03-12 23:12:40 +00005251 OS << ", ";
Artem Dergachev922455f2018-03-22 22:02:38 +00005252 const auto *SICC = cast<SimpleConstructorInitializerConstructionContext>(CC);
5253 print_initializer(OS, Helper, SICC->getCXXCtorInitializer());
Artem Dergacheva657a322018-07-31 20:45:53 +00005254 return;
Artem Dergachev922455f2018-03-22 22:02:38 +00005255 }
5256 case ConstructionContext::CXX17ElidedCopyConstructorInitializerKind: {
5257 OS << ", ";
5258 const auto *CICC =
5259 cast<CXX17ElidedCopyConstructorInitializerConstructionContext>(CC);
5260 print_initializer(OS, Helper, CICC->getCXXCtorInitializer());
Artem Dergachevff267df2018-06-28 00:04:54 +00005261 Stmts.push_back(CICC->getCXXBindTemporaryExpr());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005262 break;
5263 }
5264 case ConstructionContext::SimpleVariableKind: {
Artem Dergachev317291e2018-03-22 21:37:39 +00005265 const auto *SDSCC = cast<SimpleVariableConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005266 Stmts.push_back(SDSCC->getDeclStmt());
Artem Dergachev317291e2018-03-22 21:37:39 +00005267 break;
5268 }
5269 case ConstructionContext::CXX17ElidedCopyVariableKind: {
5270 const auto *CDSCC = cast<CXX17ElidedCopyVariableConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005271 Stmts.push_back(CDSCC->getDeclStmt());
5272 Stmts.push_back(CDSCC->getCXXBindTemporaryExpr());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005273 break;
5274 }
5275 case ConstructionContext::NewAllocatedObjectKind: {
5276 const auto *NECC = cast<NewAllocatedObjectConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005277 Stmts.push_back(NECC->getCXXNewExpr());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005278 break;
5279 }
Artem Dergachev317291e2018-03-22 21:37:39 +00005280 case ConstructionContext::SimpleReturnedValueKind: {
5281 const auto *RSCC = cast<SimpleReturnedValueConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005282 Stmts.push_back(RSCC->getReturnStmt());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005283 break;
5284 }
Artem Dergachev317291e2018-03-22 21:37:39 +00005285 case ConstructionContext::CXX17ElidedCopyReturnedValueKind: {
5286 const auto *RSCC =
5287 cast<CXX17ElidedCopyReturnedValueConstructionContext>(CC);
Artem Dergachevff267df2018-06-28 00:04:54 +00005288 Stmts.push_back(RSCC->getReturnStmt());
5289 Stmts.push_back(RSCC->getCXXBindTemporaryExpr());
Artem Dergachev317291e2018-03-22 21:37:39 +00005290 break;
5291 }
Artem Dergachevff267df2018-06-28 00:04:54 +00005292 case ConstructionContext::SimpleTemporaryObjectKind: {
5293 const auto *TOCC = cast<SimpleTemporaryObjectConstructionContext>(CC);
5294 Stmts.push_back(TOCC->getCXXBindTemporaryExpr());
5295 Stmts.push_back(TOCC->getMaterializedTemporaryExpr());
5296 break;
5297 }
5298 case ConstructionContext::ElidedTemporaryObjectKind: {
5299 const auto *TOCC = cast<ElidedTemporaryObjectConstructionContext>(CC);
5300 Stmts.push_back(TOCC->getCXXBindTemporaryExpr());
5301 Stmts.push_back(TOCC->getMaterializedTemporaryExpr());
5302 Stmts.push_back(TOCC->getConstructorAfterElision());
Artem Dergachev1527dec2018-03-12 23:12:40 +00005303 break;
5304 }
Artem Dergacheva657a322018-07-31 20:45:53 +00005305 case ConstructionContext::ArgumentKind: {
5306 const auto *ACC = cast<ArgumentConstructionContext>(CC);
5307 if (const Stmt *BTE = ACC->getCXXBindTemporaryExpr()) {
5308 OS << ", ";
5309 Helper.handledStmt(const_cast<Stmt *>(BTE), OS);
5310 }
5311 OS << ", ";
5312 Helper.handledStmt(const_cast<Expr *>(ACC->getCallLikeExpr()), OS);
5313 OS << "+" << ACC->getIndex();
5314 return;
5315 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00005316 }
Artem Dergachevff267df2018-06-28 00:04:54 +00005317 for (auto I: Stmts)
5318 if (I) {
5319 OS << ", ";
5320 Helper.handledStmt(const_cast<Stmt *>(I), OS);
5321 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00005322}
5323
Aaron Ballmanff924b02013-11-18 20:11:50 +00005324static void print_elem(raw_ostream &OS, StmtPrinterHelper &Helper,
Mike Stump92244b02010-01-19 22:00:14 +00005325 const CFGElement &E) {
David Blaikie00be69a2013-02-23 00:29:34 +00005326 if (Optional<CFGStmt> CS = E.getAs<CFGStmt>()) {
5327 const Stmt *S = CS->getStmt();
Richard Trieuddd01ce2014-06-09 22:53:25 +00005328 assert(S != nullptr && "Expecting non-null Stmt");
5329
Aaron Ballmanff924b02013-11-18 20:11:50 +00005330 // special printing for statement-expressions.
5331 if (const StmtExpr *SE = dyn_cast<StmtExpr>(S)) {
5332 const CompoundStmt *Sub = SE->getSubStmt();
Mike Stump31feda52009-07-17 01:31:16 +00005333
Benjamin Kramer5733e352015-07-18 17:09:36 +00005334 auto Children = Sub->children();
5335 if (Children.begin() != Children.end()) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00005336 OS << "({ ... ; ";
5337 Helper.handledStmt(*SE->getSubStmt()->body_rbegin(),OS);
5338 OS << " })\n";
5339 return;
Ted Kremenekf8b50e92007-08-31 22:26:13 +00005340 }
5341 }
Aaron Ballmanff924b02013-11-18 20:11:50 +00005342 // special printing for comma expressions.
5343 if (const BinaryOperator* B = dyn_cast<BinaryOperator>(S)) {
5344 if (B->getOpcode() == BO_Comma) {
5345 OS << "... , ";
5346 Helper.handledStmt(B->getRHS(),OS);
5347 OS << '\n';
5348 return;
5349 }
5350 }
5351 S->printPretty(OS, &Helper, PrintingPolicy(Helper.getLangOpts()));
Mike Stump31feda52009-07-17 01:31:16 +00005352
Artem Dergachev1527dec2018-03-12 23:12:40 +00005353 if (auto VTC = E.getAs<CFGCXXRecordTypedCall>()) {
5354 if (isa<CXXOperatorCallExpr>(S))
5355 OS << " (OperatorCall)";
5356 OS << " (CXXRecordTypedCall";
5357 print_construction_context(OS, Helper, VTC->getConstructionContext());
5358 OS << ")";
5359 } else if (isa<CXXOperatorCallExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00005360 OS << " (OperatorCall)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005361 } else if (isa<CXXBindTemporaryExpr>(S)) {
Zhanyong Wan59f09c72010-11-22 19:32:14 +00005362 OS << " (BindTemporary)";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005363 } else if (const CXXConstructExpr *CCE = dyn_cast<CXXConstructExpr>(S)) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00005364 OS << " (CXXConstructExpr";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005365 if (Optional<CFGConstructor> CE = E.getAs<CFGConstructor>()) {
Artem Dergachev1527dec2018-03-12 23:12:40 +00005366 print_construction_context(OS, Helper, CE->getConstructionContext());
Artem Dergachev41ffb302018-02-08 22:58:15 +00005367 }
Artem Dergachev1527dec2018-03-12 23:12:40 +00005368 OS << ", " << CCE->getType().getAsString() << ")";
Artem Dergachev41ffb302018-02-08 22:58:15 +00005369 } else if (const CastExpr *CE = dyn_cast<CastExpr>(S)) {
Ted Kremenek0ffba932011-12-21 19:32:38 +00005370 OS << " (" << CE->getStmtClassName() << ", "
5371 << CE->getCastKindName()
5372 << ", " << CE->getType().getAsString()
5373 << ")";
5374 }
Mike Stump31feda52009-07-17 01:31:16 +00005375
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005376 // Expressions need a newline.
5377 if (isa<Expr>(S))
5378 OS << '\n';
David Blaikie00be69a2013-02-23 00:29:34 +00005379 } else if (Optional<CFGInitializer> IE = E.getAs<CFGInitializer>()) {
Artem Dergachev5a281bb2018-02-10 02:18:04 +00005380 print_initializer(OS, Helper, IE->getInitializer());
5381 OS << '\n';
David Blaikie00be69a2013-02-23 00:29:34 +00005382 } else if (Optional<CFGAutomaticObjDtor> DE =
5383 E.getAs<CFGAutomaticObjDtor>()) {
5384 const VarDecl *VD = DE->getVarDecl();
Aaron Ballmanff924b02013-11-18 20:11:50 +00005385 Helper.handleDecl(VD, OS);
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005386
Artem Dergacheva25809f2018-06-04 18:56:25 +00005387 QualType T = VD->getType();
5388 if (T->isReferenceType())
5389 T = getReferenceInitTemporaryType(VD->getInit(), nullptr);
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005390
Artem Dergachevead98ea2019-08-28 18:44:42 +00005391 OS << ".~";
5392 T.getUnqualifiedType().print(OS, PrintingPolicy(Helper.getLangOpts()));
5393 OS << "() (Implicit destructor)\n";
Matthias Gehre351c2182017-07-12 07:04:19 +00005394 } else if (Optional<CFGLifetimeEnds> DE = E.getAs<CFGLifetimeEnds>()) {
5395 const VarDecl *VD = DE->getVarDecl();
5396 Helper.handleDecl(VD, OS);
5397
5398 OS << " (Lifetime ends)\n";
Peter Szecsi999a25f2017-08-19 11:19:16 +00005399 } else if (Optional<CFGLoopExit> LE = E.getAs<CFGLoopExit>()) {
5400 const Stmt *LoopStmt = LE->getLoopStmt();
5401 OS << LoopStmt->getStmtClassName() << " (LoopExit)\n";
Maxim Ostapenkodebca452018-03-12 12:26:15 +00005402 } else if (Optional<CFGScopeBegin> SB = E.getAs<CFGScopeBegin>()) {
5403 OS << "CFGScopeBegin(";
5404 if (const VarDecl *VD = SB->getVarDecl())
5405 OS << VD->getQualifiedNameAsString();
5406 OS << ")\n";
5407 } else if (Optional<CFGScopeEnd> SE = E.getAs<CFGScopeEnd>()) {
5408 OS << "CFGScopeEnd(";
5409 if (const VarDecl *VD = SE->getVarDecl())
5410 OS << VD->getQualifiedNameAsString();
5411 OS << ")\n";
Jordan Rosec9176072014-01-13 17:59:19 +00005412 } else if (Optional<CFGNewAllocator> NE = E.getAs<CFGNewAllocator>()) {
5413 OS << "CFGNewAllocator(";
5414 if (const CXXNewExpr *AllocExpr = NE->getAllocatorExpr())
5415 AllocExpr->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
5416 OS << ")\n";
Jordan Rosed2f40792013-09-03 17:00:57 +00005417 } else if (Optional<CFGDeleteDtor> DE = E.getAs<CFGDeleteDtor>()) {
5418 const CXXRecordDecl *RD = DE->getCXXRecordDecl();
5419 if (!RD)
5420 return;
5421 CXXDeleteExpr *DelExpr =
5422 const_cast<CXXDeleteExpr*>(DE->getDeleteExpr());
Aaron Ballmanff924b02013-11-18 20:11:50 +00005423 Helper.handledStmt(cast<Stmt>(DelExpr->getArgument()), OS);
Jordan Rosed2f40792013-09-03 17:00:57 +00005424 OS << "->~" << RD->getName().str() << "()";
5425 OS << " (Implicit destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005426 } else if (Optional<CFGBaseDtor> BE = E.getAs<CFGBaseDtor>()) {
5427 const CXXBaseSpecifier *BS = BE->getBaseSpecifier();
Marcin Swiderski20b88732010-10-05 05:37:00 +00005428 OS << "~" << BS->getType()->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00005429 OS << " (Base object destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005430 } else if (Optional<CFGMemberDtor> ME = E.getAs<CFGMemberDtor>()) {
5431 const FieldDecl *FD = ME->getFieldDecl();
Richard Smithf676e452012-07-24 21:02:14 +00005432 const Type *T = FD->getType()->getBaseElementTypeUnsafe();
Marcin Swiderski20b88732010-10-05 05:37:00 +00005433 OS << "this->" << FD->getName();
Marcin Swiderski01769902010-10-25 07:05:54 +00005434 OS << ".~" << T->getAsCXXRecordDecl()->getName() << "()";
Zhongxing Xu614e17d2010-10-05 08:38:06 +00005435 OS << " (Member object destructor)\n";
David Blaikie00be69a2013-02-23 00:29:34 +00005436 } else if (Optional<CFGTemporaryDtor> TE = E.getAs<CFGTemporaryDtor>()) {
5437 const CXXBindTemporaryExpr *BT = TE->getBindTemporaryExpr();
Pavel Labathd527cf82013-09-02 09:09:15 +00005438 OS << "~";
Aaron Ballmanff924b02013-11-18 20:11:50 +00005439 BT->getType().print(OS, PrintingPolicy(Helper.getLangOpts()));
Pavel Labathd527cf82013-09-02 09:09:15 +00005440 OS << "() (Temporary object destructor)\n";
Marcin Swiderskic0ca7312010-09-21 05:58:15 +00005441 }
Zhongxing Xu0b51d4d2010-11-01 06:46:05 +00005442}
Mike Stump31feda52009-07-17 01:31:16 +00005443
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005444static void print_block(raw_ostream &OS, const CFG* cfg,
5445 const CFGBlock &B,
Aaron Ballmanff924b02013-11-18 20:11:50 +00005446 StmtPrinterHelper &Helper, bool print_edges,
Ted Kremenek72be32a2011-12-22 23:33:52 +00005447 bool ShowColors) {
Aaron Ballmanff924b02013-11-18 20:11:50 +00005448 Helper.setBlockID(B.getBlockID());
Mike Stump31feda52009-07-17 01:31:16 +00005449
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005450 // Print the header.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005451 if (ShowColors)
5452 OS.changeColor(raw_ostream::YELLOW, true);
Fangrui Song6907ce22018-07-30 19:24:48 +00005453
Ted Kremenek72be32a2011-12-22 23:33:52 +00005454 OS << "\n [B" << B.getBlockID();
Mike Stump31feda52009-07-17 01:31:16 +00005455
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005456 if (&B == &cfg->getEntry())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005457 OS << " (ENTRY)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005458 else if (&B == &cfg->getExit())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005459 OS << " (EXIT)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005460 else if (&B == cfg->getIndirectGotoBlock())
Ted Kremenek72be32a2011-12-22 23:33:52 +00005461 OS << " (INDIRECT GOTO DISPATCH)]\n";
Jordan Rose398fb002014-04-01 16:39:33 +00005462 else if (B.hasNoReturnElement())
5463 OS << " (NORETURN)]\n";
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005464 else
Ted Kremenek72be32a2011-12-22 23:33:52 +00005465 OS << "]\n";
Fangrui Song6907ce22018-07-30 19:24:48 +00005466
Ted Kremenek72be32a2011-12-22 23:33:52 +00005467 if (ShowColors)
5468 OS.resetColor();
Mike Stump31feda52009-07-17 01:31:16 +00005469
Ted Kremenek71eca012007-08-29 23:20:49 +00005470 // Print the label of this block.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005471 if (Stmt *Label = const_cast<Stmt*>(B.getLabel())) {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005472 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005473 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00005474
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005475 if (LabelStmt *L = dyn_cast<LabelStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00005476 OS << L->getName();
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005477 else if (CaseStmt *C = dyn_cast<CaseStmt>(Label)) {
Ted Kremenek71eca012007-08-29 23:20:49 +00005478 OS << "case ";
Richard Trieuddd01ce2014-06-09 22:53:25 +00005479 if (C->getLHS())
5480 C->getLHS()->printPretty(OS, &Helper,
5481 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00005482 if (C->getRHS()) {
5483 OS << " ... ";
Aaron Ballmanff924b02013-11-18 20:11:50 +00005484 C->getRHS()->printPretty(OS, &Helper,
5485 PrintingPolicy(Helper.getLangOpts()));
Ted Kremenek71eca012007-08-29 23:20:49 +00005486 }
Mike Stump92244b02010-01-19 22:00:14 +00005487 } else if (isa<DefaultStmt>(Label))
Ted Kremenek71eca012007-08-29 23:20:49 +00005488 OS << "default";
Mike Stump92244b02010-01-19 22:00:14 +00005489 else if (CXXCatchStmt *CS = dyn_cast<CXXCatchStmt>(Label)) {
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005490 OS << "catch (";
Mike Stump0bdba6c2010-01-20 01:15:34 +00005491 if (CS->getExceptionDecl())
Aaron Ballmanff924b02013-11-18 20:11:50 +00005492 CS->getExceptionDecl()->print(OS, PrintingPolicy(Helper.getLangOpts()),
Mike Stump0bdba6c2010-01-20 01:15:34 +00005493 0);
5494 else
5495 OS << "...";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005496 OS << ")";
Nico Weber699670e2017-08-23 15:33:16 +00005497 } else if (SEHExceptStmt *ES = dyn_cast<SEHExceptStmt>(Label)) {
5498 OS << "__except (";
5499 ES->getFilterExpr()->printPretty(OS, &Helper,
5500 PrintingPolicy(Helper.getLangOpts()), 0);
5501 OS << ")";
Mike Stumpbbf5ba62010-01-19 02:20:09 +00005502 } else
David Blaikie83d382b2011-09-23 05:06:16 +00005503 llvm_unreachable("Invalid label statement in CFGBlock.");
Mike Stump31feda52009-07-17 01:31:16 +00005504
Ted Kremenek71eca012007-08-29 23:20:49 +00005505 OS << ":\n";
5506 }
Mike Stump31feda52009-07-17 01:31:16 +00005507
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005508 // Iterate through the statements in the block and print them.
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005509 unsigned j = 1;
Mike Stump31feda52009-07-17 01:31:16 +00005510
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005511 for (CFGBlock::const_iterator I = B.begin(), E = B.end() ;
5512 I != E ; ++I, ++j ) {
Ted Kremenek71eca012007-08-29 23:20:49 +00005513 // Print the statement # in the basic block and the statement itself.
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005514 if (print_edges)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005515 OS << " ";
Mike Stump31feda52009-07-17 01:31:16 +00005516
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005517 OS << llvm::format("%3d", j) << ": ";
Mike Stump31feda52009-07-17 01:31:16 +00005518
Aaron Ballmanff924b02013-11-18 20:11:50 +00005519 Helper.setStmtID(j);
Mike Stump31feda52009-07-17 01:31:16 +00005520
Ted Kremenek72be32a2011-12-22 23:33:52 +00005521 print_elem(OS, Helper, *I);
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005522 }
Mike Stump31feda52009-07-17 01:31:16 +00005523
Ted Kremenek71eca012007-08-29 23:20:49 +00005524 // Print the terminator of this block.
Artem Dergachev4e530322019-05-24 01:34:22 +00005525 if (B.getTerminator().isValid()) {
Ted Kremenek72be32a2011-12-22 23:33:52 +00005526 if (ShowColors)
5527 OS.changeColor(raw_ostream::GREEN);
Mike Stump31feda52009-07-17 01:31:16 +00005528
Ted Kremenek72be32a2011-12-22 23:33:52 +00005529 OS << " T: ";
Mike Stump31feda52009-07-17 01:31:16 +00005530
Aaron Ballmanff924b02013-11-18 20:11:50 +00005531 Helper.setBlockID(-1);
Mike Stump31feda52009-07-17 01:31:16 +00005532
Aaron Ballmanff924b02013-11-18 20:11:50 +00005533 PrintingPolicy PP(Helper.getLangOpts());
5534 CFGBlockTerminatorPrint TPrinter(OS, &Helper, PP);
Ted Kremenekfcc14172014-03-08 02:22:29 +00005535 TPrinter.print(B.getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00005536 OS << '\n';
Fangrui Song6907ce22018-07-30 19:24:48 +00005537
Ted Kremenek72be32a2011-12-22 23:33:52 +00005538 if (ShowColors)
5539 OS.resetColor();
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005540 }
Mike Stump31feda52009-07-17 01:31:16 +00005541
Ted Kremenek71eca012007-08-29 23:20:49 +00005542 if (print_edges) {
5543 // Print the predecessors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005544 if (!B.pred_empty()) {
Rui Ueyama4d41c332019-08-02 07:22:34 +00005545 const raw_ostream::Colors Color = raw_ostream::BLUE;
Ted Kremenek72be32a2011-12-22 23:33:52 +00005546 if (ShowColors)
5547 OS.changeColor(Color);
5548 OS << " Preds " ;
5549 if (ShowColors)
5550 OS.resetColor();
5551 OS << '(' << B.pred_size() << "):";
5552 unsigned i = 0;
Ted Kremenek71eca012007-08-29 23:20:49 +00005553
Ted Kremenek72be32a2011-12-22 23:33:52 +00005554 if (ShowColors)
5555 OS.changeColor(Color);
Fangrui Song6907ce22018-07-30 19:24:48 +00005556
Ted Kremenek72be32a2011-12-22 23:33:52 +00005557 for (CFGBlock::const_pred_iterator I = B.pred_begin(), E = B.pred_end();
5558 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00005559 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005560 OS << "\n ";
Mike Stump31feda52009-07-17 01:31:16 +00005561
Ted Kremenek4b6fee62014-02-27 00:24:00 +00005562 CFGBlock *B = *I;
5563 bool Reachable = true;
5564 if (!B) {
5565 Reachable = false;
5566 B = I->getPossiblyUnreachableBlock();
5567 }
5568
5569 OS << " B" << B->getBlockID();
5570 if (!Reachable)
5571 OS << "(Unreachable)";
Ted Kremenek72be32a2011-12-22 23:33:52 +00005572 }
Fangrui Song6907ce22018-07-30 19:24:48 +00005573
Ted Kremenek72be32a2011-12-22 23:33:52 +00005574 if (ShowColors)
5575 OS.resetColor();
5576
5577 OS << '\n';
Ted Kremenek71eca012007-08-29 23:20:49 +00005578 }
Mike Stump31feda52009-07-17 01:31:16 +00005579
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005580 // Print the successors of this block.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005581 if (!B.succ_empty()) {
Rui Ueyama4d41c332019-08-02 07:22:34 +00005582 const raw_ostream::Colors Color = raw_ostream::MAGENTA;
Ted Kremenek72be32a2011-12-22 23:33:52 +00005583 if (ShowColors)
5584 OS.changeColor(Color);
5585 OS << " Succs ";
5586 if (ShowColors)
5587 OS.resetColor();
5588 OS << '(' << B.succ_size() << "):";
5589 unsigned i = 0;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005590
Ted Kremenek72be32a2011-12-22 23:33:52 +00005591 if (ShowColors)
5592 OS.changeColor(Color);
Mike Stump31feda52009-07-17 01:31:16 +00005593
Ted Kremenek72be32a2011-12-22 23:33:52 +00005594 for (CFGBlock::const_succ_iterator I = B.succ_begin(), E = B.succ_end();
5595 I != E; ++I, ++i) {
Will Dietzdf9a2bb2013-01-07 09:51:17 +00005596 if (i % 10 == 8)
Ted Kremenek72be32a2011-12-22 23:33:52 +00005597 OS << "\n ";
5598
Ted Kremenek9238c5c2014-02-27 21:56:44 +00005599 CFGBlock *B = *I;
5600
5601 bool Reachable = true;
5602 if (!B) {
5603 Reachable = false;
5604 B = I->getPossiblyUnreachableBlock();
5605 }
5606
5607 if (B) {
5608 OS << " B" << B->getBlockID();
5609 if (!Reachable)
5610 OS << "(Unreachable)";
5611 }
5612 else {
5613 OS << " NULL";
5614 }
Ted Kremenek72be32a2011-12-22 23:33:52 +00005615 }
Ted Kremenek9238c5c2014-02-27 21:56:44 +00005616
Ted Kremenek72be32a2011-12-22 23:33:52 +00005617 if (ShowColors)
5618 OS.resetColor();
5619 OS << '\n';
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005620 }
Ted Kremenek4aa1e8b2007-08-21 21:42:03 +00005621 }
Mike Stump31feda52009-07-17 01:31:16 +00005622}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005623
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005624/// dump - A simple pretty printer of a CFG that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005625void CFG::dump(const LangOptions &LO, bool ShowColors) const {
5626 print(llvm::errs(), LO, ShowColors);
5627}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005628
5629/// print - A simple pretty printer of a CFG that outputs to an ostream.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005630void CFG::print(raw_ostream &OS, const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00005631 StmtPrinterHelper Helper(this, LO);
Mike Stump31feda52009-07-17 01:31:16 +00005632
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005633 // Print the entry block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00005634 print_block(OS, this, getEntry(), Helper, true, ShowColors);
Mike Stump31feda52009-07-17 01:31:16 +00005635
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005636 // Iterate through the CFGBlocks and print them one by one.
5637 for (const_iterator I = Blocks.begin(), E = Blocks.end() ; I != E ; ++I) {
5638 // Skip the entry block, because we already printed it.
Ted Kremenek289ae4f2009-10-12 20:55:07 +00005639 if (&(**I) == &getEntry() || &(**I) == &getExit())
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005640 continue;
Mike Stump31feda52009-07-17 01:31:16 +00005641
Aaron Ballmanff924b02013-11-18 20:11:50 +00005642 print_block(OS, this, **I, Helper, true, ShowColors);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005643 }
Mike Stump31feda52009-07-17 01:31:16 +00005644
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005645 // Print the exit block.
Aaron Ballmanff924b02013-11-18 20:11:50 +00005646 print_block(OS, this, getExit(), Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00005647 OS << '\n';
Ted Kremeneke03879b2008-11-24 20:50:24 +00005648 OS.flush();
Mike Stump31feda52009-07-17 01:31:16 +00005649}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005650
Kristof Umann92541e32019-08-14 17:05:55 +00005651size_t CFGBlock::getIndexInCFG() const {
5652 return llvm::find(*getParent(), this) - getParent()->begin();
5653}
5654
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005655/// dump - A simply pretty printer of a CFGBlock that outputs to stderr.
Ted Kremenek72be32a2011-12-22 23:33:52 +00005656void CFGBlock::dump(const CFG* cfg, const LangOptions &LO,
5657 bool ShowColors) const {
5658 print(llvm::errs(), cfg, LO, ShowColors);
Chris Lattnerc61089a2009-06-30 01:26:17 +00005659}
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005660
Yaron Kerencdae9412016-01-29 19:38:18 +00005661LLVM_DUMP_METHOD void CFGBlock::dump() const {
Anna Zaksa6fea132014-06-13 23:47:38 +00005662 dump(getParent(), LangOptions(), false);
5663}
5664
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005665/// print - A simple pretty printer of a CFGBlock that outputs to an ostream.
5666/// Generally this will only be called from CFG::print.
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005667void CFGBlock::print(raw_ostream &OS, const CFG* cfg,
Ted Kremenek72be32a2011-12-22 23:33:52 +00005668 const LangOptions &LO, bool ShowColors) const {
Chris Lattnerc61089a2009-06-30 01:26:17 +00005669 StmtPrinterHelper Helper(cfg, LO);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005670 print_block(OS, cfg, *this, Helper, true, ShowColors);
Ted Kremenek72be32a2011-12-22 23:33:52 +00005671 OS << '\n';
Ted Kremenek889073f2007-08-23 16:51:22 +00005672}
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005673
Ted Kremenek15647632008-01-30 23:02:42 +00005674/// printTerminator - A simple pretty printer of the terminator of a CFGBlock.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005675void CFGBlock::printTerminator(raw_ostream &OS,
Mike Stump31feda52009-07-17 01:31:16 +00005676 const LangOptions &LO) const {
Craig Topper25542942014-05-20 04:30:07 +00005677 CFGBlockTerminatorPrint TPrinter(OS, nullptr, PrintingPolicy(LO));
Ted Kremenekfcc14172014-03-08 02:22:29 +00005678 TPrinter.print(getTerminator());
Ted Kremenek15647632008-01-30 23:02:42 +00005679}
5680
Csaba Dabisdea605e2019-05-29 18:29:31 +00005681/// printTerminatorJson - Pretty-prints the terminator in JSON format.
5682void CFGBlock::printTerminatorJson(raw_ostream &Out, const LangOptions &LO,
5683 bool AddQuotes) const {
5684 std::string Buf;
5685 llvm::raw_string_ostream TempOut(Buf);
5686
5687 printTerminator(TempOut, LO);
5688
5689 Out << JsonFormat(TempOut.str(), AddQuotes);
5690}
5691
Kristof Umanndd53bdb2019-08-14 12:20:08 +00005692// Returns true if by simply looking at the block, we can be sure that it
5693// results in a sink during analysis. This is useful to know when the analysis
5694// was interrupted, and we try to figure out if it would sink eventually.
5695// There may be many more reasons why a sink would appear during analysis
5696// (eg. checkers may generate sinks arbitrarily), but here we only consider
5697// sinks that would be obvious by looking at the CFG.
5698static bool isImmediateSinkBlock(const CFGBlock *Blk) {
5699 if (Blk->hasNoReturnElement())
5700 return true;
5701
5702 // FIXME: Throw-expressions are currently generating sinks during analysis:
5703 // they're not supported yet, and also often used for actually terminating
5704 // the program. So we should treat them as sinks in this analysis as well,
5705 // at least for now, but once we have better support for exceptions,
5706 // we'd need to carefully handle the case when the throw is being
5707 // immediately caught.
5708 if (std::any_of(Blk->begin(), Blk->end(), [](const CFGElement &Elm) {
5709 if (Optional<CFGStmt> StmtElm = Elm.getAs<CFGStmt>())
5710 if (isa<CXXThrowExpr>(StmtElm->getStmt()))
5711 return true;
5712 return false;
5713 }))
5714 return true;
5715
5716 return false;
5717}
5718
5719bool CFGBlock::isInevitablySinking() const {
5720 const CFG &Cfg = *getParent();
5721
5722 const CFGBlock *StartBlk = this;
5723 if (isImmediateSinkBlock(StartBlk))
5724 return true;
5725
5726 llvm::SmallVector<const CFGBlock *, 32> DFSWorkList;
5727 llvm::SmallPtrSet<const CFGBlock *, 32> Visited;
5728
5729 DFSWorkList.push_back(StartBlk);
5730 while (!DFSWorkList.empty()) {
5731 const CFGBlock *Blk = DFSWorkList.back();
5732 DFSWorkList.pop_back();
5733 Visited.insert(Blk);
5734
5735 // If at least one path reaches the CFG exit, it means that control is
5736 // returned to the caller. For now, say that we are not sure what
5737 // happens next. If necessary, this can be improved to analyze
5738 // the parent StackFrameContext's call site in a similar manner.
5739 if (Blk == &Cfg.getExit())
5740 return false;
5741
5742 for (const auto &Succ : Blk->succs()) {
5743 if (const CFGBlock *SuccBlk = Succ.getReachableBlock()) {
5744 if (!isImmediateSinkBlock(SuccBlk) && !Visited.count(SuccBlk)) {
5745 // If the block has reachable child blocks that aren't no-return,
5746 // add them to the worklist.
5747 DFSWorkList.push_back(SuccBlk);
5748 }
5749 }
5750 }
5751 }
5752
5753 // Nothing reached the exit. It can only mean one thing: there's no return.
5754 return true;
5755}
5756
Kristof Umannd5c9d9b2019-07-05 09:52:00 +00005757const Expr *CFGBlock::getLastCondition() const {
5758 // If the terminator is a temporary dtor or a virtual base, etc, we can't
5759 // retrieve a meaningful condition, bail out.
5760 if (Terminator.getKind() != CFGTerminator::StmtBranch)
5761 return nullptr;
5762
5763 // Also, if this method was called on a block that doesn't have 2 successors,
5764 // this block doesn't have retrievable condition.
5765 if (succ_size() < 2)
5766 return nullptr;
5767
5768 auto StmtElem = rbegin()->getAs<CFGStmt>();
5769 if (!StmtElem)
5770 return nullptr;
5771
5772 const Stmt *Cond = StmtElem->getStmt();
5773 if (isa<ObjCForCollectionStmt>(Cond))
5774 return nullptr;
5775
5776 // Only ObjCForCollectionStmt is known not to be a non-Expr terminator, hence
5777 // the cast<>.
5778 return cast<Expr>(Cond)->IgnoreParens();
5779}
5780
Kristof Umann9854d772019-07-03 13:03:33 +00005781Stmt *CFGBlock::getTerminatorCondition(bool StripParens) {
5782 Stmt *Terminator = getTerminatorStmt();
5783 if (!Terminator)
Craig Topper25542942014-05-20 04:30:07 +00005784 return nullptr;
Mike Stump31feda52009-07-17 01:31:16 +00005785
Kristof Umann9854d772019-07-03 13:03:33 +00005786 Expr *E = nullptr;
5787
5788 switch (Terminator->getStmtClass()) {
5789 default:
5790 break;
5791
5792 case Stmt::CXXForRangeStmtClass:
5793 E = cast<CXXForRangeStmt>(Terminator)->getCond();
5794 break;
5795
5796 case Stmt::ForStmtClass:
5797 E = cast<ForStmt>(Terminator)->getCond();
5798 break;
5799
5800 case Stmt::WhileStmtClass:
5801 E = cast<WhileStmt>(Terminator)->getCond();
5802 break;
5803
5804 case Stmt::DoStmtClass:
5805 E = cast<DoStmt>(Terminator)->getCond();
5806 break;
5807
5808 case Stmt::IfStmtClass:
5809 E = cast<IfStmt>(Terminator)->getCond();
5810 break;
5811
5812 case Stmt::ChooseExprClass:
5813 E = cast<ChooseExpr>(Terminator)->getCond();
5814 break;
5815
5816 case Stmt::IndirectGotoStmtClass:
5817 E = cast<IndirectGotoStmt>(Terminator)->getTarget();
5818 break;
5819
5820 case Stmt::SwitchStmtClass:
5821 E = cast<SwitchStmt>(Terminator)->getCond();
5822 break;
5823
5824 case Stmt::BinaryConditionalOperatorClass:
5825 E = cast<BinaryConditionalOperator>(Terminator)->getCond();
5826 break;
5827
5828 case Stmt::ConditionalOperatorClass:
5829 E = cast<ConditionalOperator>(Terminator)->getCond();
5830 break;
5831
5832 case Stmt::BinaryOperatorClass: // '&&' and '||'
5833 E = cast<BinaryOperator>(Terminator)->getLHS();
5834 break;
5835
5836 case Stmt::ObjCForCollectionStmtClass:
5837 return Terminator;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005838 }
Mike Stump31feda52009-07-17 01:31:16 +00005839
Kristof Umann9854d772019-07-03 13:03:33 +00005840 if (!StripParens)
5841 return E;
5842
5843 return E ? E->IgnoreParens() : nullptr;
Ted Kremenekc1f9a282008-04-16 21:10:48 +00005844}
5845
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005846//===----------------------------------------------------------------------===//
5847// CFG Graphviz Visualization
5848//===----------------------------------------------------------------------===//
5849
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005850#ifndef NDEBUG
Mike Stump31feda52009-07-17 01:31:16 +00005851static StmtPrinterHelper* GraphHelper;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005852#endif
5853
Chris Lattnerc61089a2009-06-30 01:26:17 +00005854void CFG::viewCFG(const LangOptions &LO) const {
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005855#ifndef NDEBUG
Chris Lattnerc61089a2009-06-30 01:26:17 +00005856 StmtPrinterHelper H(this, LO);
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005857 GraphHelper = &H;
5858 llvm::ViewGraph(this,"CFG");
Craig Topper25542942014-05-20 04:30:07 +00005859 GraphHelper = nullptr;
Ted Kremenek04f3cee2007-08-31 21:30:12 +00005860#endif
5861}
5862
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005863namespace llvm {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005864
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005865template<>
5866struct DOTGraphTraits<const CFG*> : public DefaultDOTGraphTraits {
Eugene Zelenko38c70522017-12-07 21:55:09 +00005867 DOTGraphTraits(bool isSimple = false) : DefaultDOTGraphTraits(isSimple) {}
Tobias Grosser9fc223a2009-11-30 14:16:05 +00005868
Ted Kremenek5ef32db2011-08-12 23:37:29 +00005869 static std::string getNodeLabel(const CFGBlock *Node, const CFG* Graph) {
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005870#ifndef NDEBUG
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005871 std::string OutSStr;
5872 llvm::raw_string_ostream Out(OutSStr);
Aaron Ballmanff924b02013-11-18 20:11:50 +00005873 print_block(Out,Graph, *Node, *GraphHelper, false, false);
Ted Kremenek2d470fc2008-09-13 05:16:45 +00005874 std::string& OutStr = Out.str();
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005875
5876 if (OutStr[0] == '\n') OutStr.erase(OutStr.begin());
5877
5878 // Process string output to make it nicer...
5879 for (unsigned i = 0; i != OutStr.length(); ++i)
5880 if (OutStr[i] == '\n') { // Left justify
5881 OutStr[i] = '\\';
5882 OutStr.insert(OutStr.begin()+i+1, 'l');
5883 }
Mike Stump31feda52009-07-17 01:31:16 +00005884
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005885 return OutStr;
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005886#else
Eugene Zelenko38c70522017-12-07 21:55:09 +00005887 return {};
Hartmut Kaiser04bd2ef2007-09-16 00:28:28 +00005888#endif
Ted Kremenek4e5f99d2007-08-29 21:56:09 +00005889 }
5890};
Eugene Zelenko38c70522017-12-07 21:55:09 +00005891
5892} // namespace llvm